2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 1998 - 2001
6 Copyright (C) Volker Lendecke 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #define DBGC_CLASS DBGC_LOCKING
24 #include "smbd/smbd.h"
25 #include "smbd/globals.h"
27 #include "../librpc/gen_ndr/open_files.h"
30 * helper function used by the kernel oplock backends to post the break message
32 void break_kernel_oplock(struct messaging_context
*msg_ctx
, files_struct
*fsp
)
34 uint8_t msg
[MSG_SMB_KERNEL_BREAK_SIZE
];
36 /* Put the kernel break info into the message. */
37 push_file_id_24((char *)msg
, &fsp
->file_id
);
38 SIVAL(msg
,24,fsp
->fh
->gen_id
);
40 /* Don't need to be root here as we're only ever
41 sending to ourselves. */
43 messaging_send_buf(msg_ctx
, messaging_server_id(msg_ctx
),
45 msg
, MSG_SMB_KERNEL_BREAK_SIZE
);
48 /****************************************************************************
49 Attempt to set an oplock on a file. Succeeds if kernel oplocks are
50 disabled (just sets flags) and no byte-range locks in the file. Returns True
52 ****************************************************************************/
54 NTSTATUS
set_file_oplock(files_struct
*fsp
, int oplock_type
)
56 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
57 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
58 bool use_kernel
= lp_kernel_oplocks(SNUM(fsp
->conn
)) && koplocks
;
60 if (fsp
->oplock_type
== LEVEL_II_OPLOCK
) {
62 !(koplocks
->flags
& KOPLOCKS_LEVEL2_SUPPORTED
)) {
63 DEBUG(10, ("Refusing level2 oplock, kernel oplocks "
64 "don't support them\n"));
65 return NT_STATUS_NOT_SUPPORTED
;
69 if ((fsp
->oplock_type
!= NO_OPLOCK
) &&
70 (fsp
->oplock_type
!= FAKE_LEVEL_II_OPLOCK
) &&
72 !koplocks
->ops
->set_oplock(koplocks
, fsp
, oplock_type
))
74 return map_nt_error_from_unix(errno
);
77 fsp
->oplock_type
= oplock_type
;
78 fsp
->sent_oplock_break
= NO_BREAK_SENT
;
79 if (oplock_type
== LEVEL_II_OPLOCK
) {
80 sconn
->oplocks
.level_II_open
++;
81 } else if (EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
82 sconn
->oplocks
.exclusive_open
++;
85 DEBUG(5,("set_file_oplock: granted oplock on file %s, %s/%lu, "
86 "tv_sec = %x, tv_usec = %x\n",
87 fsp_str_dbg(fsp
), file_id_string_tos(&fsp
->file_id
),
88 fsp
->fh
->gen_id
, (int)fsp
->open_time
.tv_sec
,
89 (int)fsp
->open_time
.tv_usec
));
94 /****************************************************************************
95 Attempt to release an oplock on a file. Decrements oplock count.
96 ****************************************************************************/
98 void release_file_oplock(files_struct
*fsp
)
100 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
101 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
103 if ((fsp
->oplock_type
!= NO_OPLOCK
) &&
104 (fsp
->oplock_type
!= FAKE_LEVEL_II_OPLOCK
) &&
106 koplocks
->ops
->release_oplock(koplocks
, fsp
, NO_OPLOCK
);
109 if (fsp
->oplock_type
== LEVEL_II_OPLOCK
) {
110 sconn
->oplocks
.level_II_open
--;
111 } else if (EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
112 sconn
->oplocks
.exclusive_open
--;
115 SMB_ASSERT(sconn
->oplocks
.exclusive_open
>=0);
116 SMB_ASSERT(sconn
->oplocks
.level_II_open
>=0);
118 if (EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
119 /* This doesn't matter for close. */
120 fsp
->oplock_type
= FAKE_LEVEL_II_OPLOCK
;
122 fsp
->oplock_type
= NO_OPLOCK
;
124 fsp
->sent_oplock_break
= NO_BREAK_SENT
;
126 flush_write_cache(fsp
, OPLOCK_RELEASE_FLUSH
);
127 delete_write_cache(fsp
);
129 TALLOC_FREE(fsp
->oplock_timeout
);
132 /****************************************************************************
133 Attempt to downgrade an oplock on a file. Doesn't decrement oplock count.
134 ****************************************************************************/
136 static void downgrade_file_oplock(files_struct
*fsp
)
138 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
139 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
141 if (!EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
142 DEBUG(0, ("trying to downgrade an already-downgraded oplock!\n"));
147 koplocks
->ops
->release_oplock(koplocks
, fsp
, LEVEL_II_OPLOCK
);
149 fsp
->oplock_type
= LEVEL_II_OPLOCK
;
150 sconn
->oplocks
.exclusive_open
--;
151 sconn
->oplocks
.level_II_open
++;
152 fsp
->sent_oplock_break
= NO_BREAK_SENT
;
155 /****************************************************************************
156 Remove a file oplock. Copes with level II and exclusive.
157 Locks then unlocks the share mode lock. Client can decide to go directly
158 to none even if a "break-to-level II" was sent.
159 ****************************************************************************/
161 bool remove_oplock(files_struct
*fsp
)
164 struct share_mode_lock
*lck
;
166 /* Remove the oplock flag from the sharemode. */
167 lck
= get_existing_share_mode_lock(talloc_tos(), fsp
->file_id
);
169 DEBUG(0,("remove_oplock: failed to lock share entry for "
170 "file %s\n", fsp_str_dbg(fsp
)));
173 ret
= remove_share_oplock(lck
, fsp
);
175 DEBUG(0,("remove_oplock: failed to remove share oplock for "
177 fsp_str_dbg(fsp
), fsp_fnum_dbg(fsp
),
178 file_id_string_tos(&fsp
->file_id
)));
180 release_file_oplock(fsp
);
186 * Deal with a reply when a break-to-level II was sent.
188 bool downgrade_oplock(files_struct
*fsp
)
191 struct share_mode_lock
*lck
;
193 lck
= get_existing_share_mode_lock(talloc_tos(), fsp
->file_id
);
195 DEBUG(0,("downgrade_oplock: failed to lock share entry for "
196 "file %s\n", fsp_str_dbg(fsp
)));
199 ret
= downgrade_share_oplock(lck
, fsp
);
201 DEBUG(0,("downgrade_oplock: failed to downgrade share oplock "
202 "for file %s, %s, file_id %s\n",
203 fsp_str_dbg(fsp
), fsp_fnum_dbg(fsp
),
204 file_id_string_tos(&fsp
->file_id
)));
207 downgrade_file_oplock(fsp
);
213 * Some kernel oplock implementations handle the notification themselves.
215 bool should_notify_deferred_opens(struct smbd_server_connection
*sconn
)
217 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
219 (koplocks
->flags
& KOPLOCKS_DEFERRED_OPEN_NOTIFICATION
));
222 /****************************************************************************
223 Set up an oplock break message.
224 ****************************************************************************/
226 static char *new_break_message_smb1(TALLOC_CTX
*mem_ctx
,
227 files_struct
*fsp
, int cmd
)
229 char *result
= talloc_array(mem_ctx
, char, smb_size
+ 8*2 + 0);
231 if (result
== NULL
) {
232 DEBUG(0, ("talloc failed\n"));
236 memset(result
,'\0',smb_size
);
237 srv_set_message(result
,8,0,true);
238 SCVAL(result
,smb_com
,SMBlockingX
);
239 SSVAL(result
,smb_tid
,fsp
->conn
->cnum
);
240 SSVAL(result
,smb_pid
,0xFFFF);
241 SSVAL(result
,smb_uid
,0);
242 SSVAL(result
,smb_mid
,0xFFFF);
243 SCVAL(result
,smb_vwv0
,0xFF);
244 SSVAL(result
,smb_vwv2
,fsp
->fnum
);
245 SCVAL(result
,smb_vwv3
,LOCKING_ANDX_OPLOCK_RELEASE
);
246 SCVAL(result
,smb_vwv3
+1,cmd
);
250 /****************************************************************************
251 Function to do the waiting before sending a local break.
252 ****************************************************************************/
254 static void wait_before_sending_break(void)
256 long wait_time
= (long)lp_oplock_break_wait_time();
259 smb_msleep(wait_time
);
263 /****************************************************************************
264 Ensure that we have a valid oplock.
265 ****************************************************************************/
267 static files_struct
*initial_break_processing(
268 struct smbd_server_connection
*sconn
, struct file_id id
,
269 unsigned long file_id
)
271 files_struct
*fsp
= NULL
;
273 if( DEBUGLVL( 3 ) ) {
274 dbgtext( "initial_break_processing: called for %s/%u\n",
275 file_id_string_tos(&id
), (int)file_id
);
276 dbgtext( "Current oplocks_open (exclusive = %d, levelII = %d)\n",
277 sconn
->oplocks
.exclusive_open
,
278 sconn
->oplocks
.level_II_open
);
282 * We need to search the file open table for the
283 * entry containing this dev and inode, and ensure
284 * we have an oplock on it.
287 fsp
= file_find_dif(sconn
, id
, file_id
);
290 /* The file could have been closed in the meantime - return success. */
291 if( DEBUGLVL( 3 ) ) {
292 dbgtext( "initial_break_processing: cannot find open file with " );
293 dbgtext( "file_id %s gen_id = %lu, ", file_id_string_tos(&id
), file_id
);
294 dbgtext( "allowing break to succeed.\n" );
299 /* Ensure we have an oplock on the file */
302 * There is a potential race condition in that an oplock could
303 * have been broken due to another udp request, and yet there are
304 * still oplock break messages being sent in the udp message
305 * queue for this file. So return true if we don't have an oplock,
306 * as we may have just freed it.
309 if(fsp
->oplock_type
== NO_OPLOCK
) {
310 if( DEBUGLVL( 3 ) ) {
311 dbgtext( "initial_break_processing: file %s ",
313 dbgtext( "(file_id = %s gen_id = %lu) has no oplock.\n",
314 file_id_string_tos(&id
), fsp
->fh
->gen_id
);
315 dbgtext( "Allowing break to succeed regardless.\n" );
323 static void oplock_timeout_handler(struct tevent_context
*ctx
,
324 struct tevent_timer
*te
,
328 files_struct
*fsp
= (files_struct
*)private_data
;
330 /* Remove the timed event handler. */
331 TALLOC_FREE(fsp
->oplock_timeout
);
332 DEBUG(0, ("Oplock break failed for file %s -- replying anyway\n",
335 reply_to_oplock_break_requests(fsp
);
338 /*******************************************************************
339 Add a timeout handler waiting for the client reply.
340 *******************************************************************/
342 static void add_oplock_timeout_handler(files_struct
*fsp
)
344 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
345 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
348 * If kernel oplocks already notifies smbds when an oplock break times
352 (koplocks
->flags
& KOPLOCKS_TIMEOUT_NOTIFICATION
)) {
356 if (fsp
->oplock_timeout
!= NULL
) {
357 DEBUG(0, ("Logic problem -- have an oplock event hanging "
361 fsp
->oplock_timeout
=
362 tevent_add_timer(fsp
->conn
->sconn
->ev_ctx
, fsp
,
363 timeval_current_ofs(OPLOCK_BREAK_TIMEOUT
, 0),
364 oplock_timeout_handler
, fsp
);
366 if (fsp
->oplock_timeout
== NULL
) {
367 DEBUG(0, ("Could not add oplock timeout handler\n"));
371 static void send_break_message_smb1(files_struct
*fsp
, int level
)
373 char *break_msg
= new_break_message_smb1(talloc_tos(),
376 if (break_msg
== NULL
) {
377 exit_server("Could not talloc break_msg\n");
381 if (!srv_send_smb(fsp
->conn
->sconn
,
383 IS_CONN_ENCRYPTED(fsp
->conn
),
385 exit_server_cleanly("send_break_message_smb1: "
386 "srv_send_smb failed.");
389 TALLOC_FREE(break_msg
);
392 void break_level2_to_none_async(files_struct
*fsp
)
394 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
396 if (fsp
->oplock_type
== NO_OPLOCK
) {
397 /* We already got a "break to none" message and we've handled
398 * it. just ignore. */
399 DEBUG(3, ("process_oplock_async_level2_break_message: already "
400 "broken to none, ignoring.\n"));
404 if (fsp
->oplock_type
== FAKE_LEVEL_II_OPLOCK
) {
405 /* Don't tell the client, just downgrade. */
406 DEBUG(3, ("process_oplock_async_level2_break_message: "
407 "downgrading fake level 2 oplock.\n"));
412 /* Ensure we're really at level2 state. */
413 SMB_ASSERT(fsp
->oplock_type
== LEVEL_II_OPLOCK
);
415 DEBUG(10,("process_oplock_async_level2_break_message: sending break "
416 "to none message for %s, file %s\n", fsp_fnum_dbg(fsp
),
419 /* Now send a break to none message to our client. */
420 if (sconn
->using_smb2
) {
421 send_break_message_smb2(fsp
, OPLOCKLEVEL_NONE
);
423 send_break_message_smb1(fsp
, OPLOCKLEVEL_NONE
);
426 /* Async level2 request, don't send a reply, just remove the oplock. */
430 /*******************************************************************
431 This handles the case of a write triggering a break to none
432 message on a level2 oplock.
433 When we get this message we may be in any of three states :
434 NO_OPLOCK, LEVEL_II, FAKE_LEVEL2. We only send a message to
435 the client for LEVEL2.
436 *******************************************************************/
438 static void process_oplock_async_level2_break_message(struct messaging_context
*msg_ctx
,
441 struct server_id src
,
444 struct share_mode_entry msg
;
446 struct smbd_server_connection
*sconn
=
447 talloc_get_type_abort(private_data
,
448 struct smbd_server_connection
);
450 if (data
->data
== NULL
) {
451 DEBUG(0, ("Got NULL buffer\n"));
455 if (data
->length
!= MSG_SMB_SHARE_MODE_ENTRY_SIZE
) {
456 DEBUG(0, ("Got invalid msg len %d\n", (int)data
->length
));
460 /* De-linearize incoming message. */
461 message_to_share_mode_entry(&msg
, (char *)data
->data
);
463 DEBUG(10, ("Got oplock async level 2 break message from pid %s: "
464 "%s/%llu\n", server_id_str(talloc_tos(), &src
),
465 file_id_string_tos(&msg
.id
),
466 (unsigned long long)msg
.share_file_id
));
468 fsp
= initial_break_processing(sconn
, msg
.id
, msg
.share_file_id
);
471 /* We hit a race here. Break messages are sent, and before we
472 * get to process this message, we have closed the file.
473 * No need to reply as this is an async message. */
474 DEBUG(3, ("process_oplock_async_level2_break_message: Did not find fsp, ignoring\n"));
478 break_level2_to_none_async(fsp
);
481 /*******************************************************************
482 This handles the generic oplock break message from another smbd.
483 *******************************************************************/
485 static void process_oplock_break_message(struct messaging_context
*msg_ctx
,
488 struct server_id src
,
491 struct share_mode_entry msg
;
493 bool break_to_level2
= False
;
495 struct smbd_server_connection
*sconn
=
496 talloc_get_type_abort(private_data
,
497 struct smbd_server_connection
);
498 struct server_id self
= messaging_server_id(sconn
->msg_ctx
);
499 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
501 if (data
->data
== NULL
) {
502 DEBUG(0, ("Got NULL buffer\n"));
506 if (data
->length
!= MSG_SMB_SHARE_MODE_ENTRY_SIZE
) {
507 DEBUG(0, ("Got invalid msg len %d\n", (int)data
->length
));
511 /* De-linearize incoming message. */
512 message_to_share_mode_entry(&msg
, (char *)data
->data
);
514 DEBUG(10, ("Got oplock break message from pid %s: %s/%llu\n",
515 server_id_str(talloc_tos(), &src
),
516 file_id_string_tos(&msg
.id
),
517 (unsigned long long)msg
.share_file_id
));
519 fsp
= initial_break_processing(sconn
, msg
.id
, msg
.share_file_id
);
522 /* We hit a race here. Break messages are sent, and before we
523 * get to process this message, we have closed the file. */
524 DEBUG(3, ("Did not find fsp\n"));
528 if (fsp
->sent_oplock_break
!= NO_BREAK_SENT
) {
529 /* Remember we have to inform the requesting PID when the
532 ADD_TO_ARRAY(NULL
, struct share_mode_entry
, msg
,
533 &fsp
->pending_break_messages
,
534 &fsp
->num_pending_break_messages
);
538 if (EXCLUSIVE_OPLOCK_TYPE(msg
.op_type
) &&
539 !EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
540 DEBUG(3, ("Already downgraded oplock on %s: %s\n",
541 file_id_string_tos(&fsp
->file_id
),
546 use_kernel
= lp_kernel_oplocks(SNUM(fsp
->conn
)) && koplocks
;
548 if ((global_client_caps
& CAP_LEVEL_II_OPLOCKS
) &&
549 !(msg
.op_type
& FORCE_OPLOCK_BREAK_TO_NONE
) &&
550 !(use_kernel
&& !(koplocks
->flags
& KOPLOCKS_LEVEL2_SUPPORTED
)) &&
551 lp_level2_oplocks(SNUM(fsp
->conn
))) {
552 break_to_level2
= True
;
555 /* Need to wait before sending a break
556 message if we sent ourselves this message. */
557 if (serverid_equal(&self
, &src
)) {
558 wait_before_sending_break();
561 if (sconn
->using_smb2
) {
562 send_break_message_smb2(fsp
, break_to_level2
?
563 OPLOCKLEVEL_II
: OPLOCKLEVEL_NONE
);
565 send_break_message_smb1(fsp
, break_to_level2
?
566 OPLOCKLEVEL_II
: OPLOCKLEVEL_NONE
);
569 fsp
->sent_oplock_break
= break_to_level2
? LEVEL_II_BREAK_SENT
:BREAK_TO_NONE_SENT
;
572 ADD_TO_ARRAY(NULL
, struct share_mode_entry
, msg
,
573 &fsp
->pending_break_messages
,
574 &fsp
->num_pending_break_messages
);
576 add_oplock_timeout_handler(fsp
);
579 /*******************************************************************
580 This handles the kernel oplock break message.
581 *******************************************************************/
583 static void process_kernel_oplock_break(struct messaging_context
*msg_ctx
,
586 struct server_id src
,
590 unsigned long file_id
;
592 struct smbd_server_connection
*sconn
=
593 talloc_get_type_abort(private_data
,
594 struct smbd_server_connection
);
596 if (data
->data
== NULL
) {
597 DEBUG(0, ("Got NULL buffer\n"));
601 if (data
->length
!= MSG_SMB_KERNEL_BREAK_SIZE
) {
602 DEBUG(0, ("Got invalid msg len %d\n", (int)data
->length
));
606 /* Pull the data from the message. */
607 pull_file_id_24((char *)data
->data
, &id
);
608 file_id
= (unsigned long)IVAL(data
->data
, 24);
610 DEBUG(10, ("Got kernel oplock break message from pid %s: %s/%u\n",
611 server_id_str(talloc_tos(), &src
), file_id_string_tos(&id
),
612 (unsigned int)file_id
));
614 fsp
= initial_break_processing(sconn
, id
, file_id
);
617 DEBUG(3, ("Got a kernel oplock break message for a file "
618 "I don't know about\n"));
622 if (fsp
->sent_oplock_break
!= NO_BREAK_SENT
) {
623 /* This is ok, kernel oplocks come in completely async */
624 DEBUG(3, ("Got a kernel oplock request while waiting for a "
629 if (sconn
->using_smb2
) {
630 send_break_message_smb2(fsp
, OPLOCKLEVEL_NONE
);
632 send_break_message_smb1(fsp
, OPLOCKLEVEL_NONE
);
635 fsp
->sent_oplock_break
= BREAK_TO_NONE_SENT
;
637 add_oplock_timeout_handler(fsp
);
640 void reply_to_oplock_break_requests(files_struct
*fsp
)
642 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
643 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
646 * If kernel oplocks already notifies smbds when oplocks are
647 * broken/removed, just return.
650 (koplocks
->flags
& KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION
)) {
654 SAFE_FREE(fsp
->pending_break_messages
);
655 fsp
->num_pending_break_messages
= 0;
656 TALLOC_FREE(fsp
->oplock_timeout
);
660 static void process_open_retry_message(struct messaging_context
*msg_ctx
,
663 struct server_id src
,
666 struct share_mode_entry msg
;
667 struct smbd_server_connection
*sconn
=
668 talloc_get_type_abort(private_data
,
669 struct smbd_server_connection
);
671 if (data
->data
== NULL
) {
672 DEBUG(0, ("Got NULL buffer\n"));
676 if (data
->length
!= MSG_SMB_SHARE_MODE_ENTRY_SIZE
) {
677 DEBUG(0, ("Got invalid msg len %d\n", (int)data
->length
));
681 /* De-linearize incoming message. */
682 message_to_share_mode_entry(&msg
, (char *)data
->data
);
684 DEBUG(10, ("Got open retry msg from pid %s: %s mid %llu\n",
685 server_id_str(talloc_tos(), &src
), file_id_string_tos(&msg
.id
),
686 (unsigned long long)msg
.op_mid
));
688 schedule_deferred_open_message_smb(sconn
, msg
.op_mid
);
691 struct break_to_none_state
{
692 struct smbd_server_connection
*sconn
;
695 static void do_break_to_none(struct tevent_req
*req
);
697 /****************************************************************************
698 This function is called on any file modification or lock request. If a file
699 is level 2 oplocked then it must tell all other level 2 holders to break to
701 ****************************************************************************/
703 static void contend_level2_oplocks_begin_default(files_struct
*fsp
,
704 enum level2_contention_type type
)
706 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
707 struct tevent_req
*req
;
708 struct break_to_none_state
*state
;
711 * If this file is level II oplocked then we need
712 * to grab the shared memory lock and inform all
713 * other files with a level II lock that they need
714 * to flush their read caches. We keep the lock over
715 * the shared memory area whilst doing this.
718 if (!LEVEL_II_OPLOCK_TYPE(fsp
->oplock_type
))
722 * When we get here we might have a brlock entry locked. Also
723 * locking the share mode entry would violate the locking
724 * order. Breaking level2 oplocks to none is asynchronous
725 * anyway, so we postpone this into an immediate timed event.
728 state
= talloc(sconn
, struct break_to_none_state
);
730 DEBUG(1, ("talloc failed\n"));
733 state
->sconn
= sconn
;
734 state
->id
= fsp
->file_id
;
736 req
= tevent_wakeup_send(state
, sconn
->ev_ctx
, timeval_set(0, 0));
738 DEBUG(1, ("tevent_wakeup_send failed\n"));
742 tevent_req_set_callback(req
, do_break_to_none
, state
);
746 static void do_break_to_none(struct tevent_req
*req
)
748 struct break_to_none_state
*state
= tevent_req_callback_data(
749 req
, struct break_to_none_state
);
750 struct server_id self
= messaging_server_id(state
->sconn
->msg_ctx
);
753 struct share_mode_lock
*lck
;
755 ret
= tevent_wakeup_recv(req
);
758 DEBUG(1, ("tevent_wakeup_recv failed\n"));
761 lck
= get_existing_share_mode_lock(talloc_tos(), state
->id
);
763 DEBUG(1, ("release_level_2_oplocks_on_change: failed to lock "
764 "share mode entry for file %s.\n",
765 file_id_string_tos(&state
->id
)));
769 DEBUG(10,("release_level_2_oplocks_on_change: num_share_modes = %d\n",
770 lck
->data
->num_share_modes
));
772 for(i
= 0; i
< lck
->data
->num_share_modes
; i
++) {
773 struct share_mode_entry
*share_entry
= &lck
->data
->share_modes
[i
];
774 char msg
[MSG_SMB_SHARE_MODE_ENTRY_SIZE
];
776 if (!is_valid_share_mode_entry(share_entry
)) {
781 * As there could have been multiple writes waiting at the
782 * lock_share_entry gate we may not be the first to
783 * enter. Hence the state of the op_types in the share mode
784 * entries may be partly NO_OPLOCK and partly LEVEL_II or FAKE_LEVEL_II
785 * oplock. It will do no harm to re-send break messages to
786 * those smbd's that are still waiting their turn to remove
787 * their LEVEL_II state, and also no harm to ignore existing
788 * NO_OPLOCK states. JRA.
791 DEBUG(10,("release_level_2_oplocks_on_change: "
792 "share_entry[%i]->op_type == %d\n",
793 i
, share_entry
->op_type
));
795 if (share_entry
->op_type
== NO_OPLOCK
) {
800 if (EXCLUSIVE_OPLOCK_TYPE(share_entry
->op_type
)) {
801 DEBUG(0,("release_level_2_oplocks_on_change: PANIC. "
802 "share mode entry %d is an exlusive "
808 share_mode_entry_to_message(msg
, share_entry
);
811 * Deal with a race condition when breaking level2
812 * oplocks. Don't send all the messages and release
813 * the lock, this allows someone else to come in and
814 * get a level2 lock before any of the messages are
815 * processed, and thus miss getting a break message.
816 * Ensure at least one entry (the one we're breaking)
817 * is processed immediately under the lock and becomes
818 * set as NO_OPLOCK to stop any waiter getting a level2.
822 if (serverid_equal(&self
, &share_entry
->pid
)) {
823 struct files_struct
*cur_fsp
=
824 initial_break_processing(state
->sconn
,
826 share_entry
->share_file_id
);
827 wait_before_sending_break();
828 if (cur_fsp
!= NULL
) {
829 break_level2_to_none_async(cur_fsp
);
831 DEBUG(3, ("release_level_2_oplocks_on_change: "
832 "Did not find fsp, ignoring\n"));
835 messaging_send_buf(state
->sconn
->msg_ctx
,
837 MSG_SMB_ASYNC_LEVEL2_BREAK
,
839 MSG_SMB_SHARE_MODE_ENTRY_SIZE
);
843 /* We let the message receivers handle removing the oplock state
844 in the share mode lock db. */
852 void smbd_contend_level2_oplocks_begin(files_struct
*fsp
,
853 enum level2_contention_type type
)
855 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
856 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
858 if (koplocks
&& koplocks
->ops
->contend_level2_oplocks_begin
) {
859 koplocks
->ops
->contend_level2_oplocks_begin(fsp
, type
);
863 contend_level2_oplocks_begin_default(fsp
, type
);
866 void smbd_contend_level2_oplocks_end(files_struct
*fsp
,
867 enum level2_contention_type type
)
869 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
870 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
872 /* Only kernel oplocks implement this so far */
873 if (koplocks
&& koplocks
->ops
->contend_level2_oplocks_end
) {
874 koplocks
->ops
->contend_level2_oplocks_end(fsp
, type
);
878 /****************************************************************************
879 Linearize a share mode entry struct to an internal oplock break message.
880 ****************************************************************************/
882 void share_mode_entry_to_message(char *msg
, const struct share_mode_entry
*e
)
884 SIVAL(msg
,OP_BREAK_MSG_PID_OFFSET
,(uint32
)e
->pid
.pid
);
885 SBVAL(msg
,OP_BREAK_MSG_MID_OFFSET
,e
->op_mid
);
886 SSVAL(msg
,OP_BREAK_MSG_OP_TYPE_OFFSET
,e
->op_type
);
887 SIVAL(msg
,OP_BREAK_MSG_ACCESS_MASK_OFFSET
,e
->access_mask
);
888 SIVAL(msg
,OP_BREAK_MSG_SHARE_ACCESS_OFFSET
,e
->share_access
);
889 SIVAL(msg
,OP_BREAK_MSG_PRIV_OFFSET
,e
->private_options
);
890 SIVAL(msg
,OP_BREAK_MSG_TIME_SEC_OFFSET
,(uint32_t)e
->time
.tv_sec
);
891 SIVAL(msg
,OP_BREAK_MSG_TIME_USEC_OFFSET
,(uint32_t)e
->time
.tv_usec
);
892 push_file_id_24(msg
+OP_BREAK_MSG_DEV_OFFSET
, &e
->id
);
893 SIVAL(msg
,OP_BREAK_MSG_FILE_ID_OFFSET
,e
->share_file_id
);
894 SIVAL(msg
,OP_BREAK_MSG_UID_OFFSET
,e
->uid
);
895 SSVAL(msg
,OP_BREAK_MSG_FLAGS_OFFSET
,e
->flags
);
896 SIVAL(msg
,OP_BREAK_MSG_NAME_HASH_OFFSET
,e
->name_hash
);
897 SIVAL(msg
,OP_BREAK_MSG_VNN_OFFSET
,e
->pid
.vnn
);
900 /****************************************************************************
901 De-linearize an internal oplock break message to a share mode entry struct.
902 ****************************************************************************/
904 void message_to_share_mode_entry(struct share_mode_entry
*e
, char *msg
)
906 e
->pid
.pid
= (pid_t
)IVAL(msg
,OP_BREAK_MSG_PID_OFFSET
);
907 e
->op_mid
= BVAL(msg
,OP_BREAK_MSG_MID_OFFSET
);
908 e
->op_type
= SVAL(msg
,OP_BREAK_MSG_OP_TYPE_OFFSET
);
909 e
->access_mask
= IVAL(msg
,OP_BREAK_MSG_ACCESS_MASK_OFFSET
);
910 e
->share_access
= IVAL(msg
,OP_BREAK_MSG_SHARE_ACCESS_OFFSET
);
911 e
->private_options
= IVAL(msg
,OP_BREAK_MSG_PRIV_OFFSET
);
912 e
->time
.tv_sec
= (time_t)IVAL(msg
,OP_BREAK_MSG_TIME_SEC_OFFSET
);
913 e
->time
.tv_usec
= (int)IVAL(msg
,OP_BREAK_MSG_TIME_USEC_OFFSET
);
914 pull_file_id_24(msg
+OP_BREAK_MSG_DEV_OFFSET
, &e
->id
);
915 e
->share_file_id
= (unsigned long)IVAL(msg
,OP_BREAK_MSG_FILE_ID_OFFSET
);
916 e
->uid
= (uint32
)IVAL(msg
,OP_BREAK_MSG_UID_OFFSET
);
917 e
->flags
= (uint16
)SVAL(msg
,OP_BREAK_MSG_FLAGS_OFFSET
);
918 e
->name_hash
= IVAL(msg
,OP_BREAK_MSG_NAME_HASH_OFFSET
);
919 e
->pid
.vnn
= IVAL(msg
,OP_BREAK_MSG_VNN_OFFSET
);
922 /****************************************************************************
923 Setup oplocks for this process.
924 ****************************************************************************/
926 bool init_oplocks(struct smbd_server_connection
*sconn
)
928 DEBUG(3,("init_oplocks: initializing messages.\n"));
930 messaging_register(sconn
->msg_ctx
, sconn
, MSG_SMB_BREAK_REQUEST
,
931 process_oplock_break_message
);
932 messaging_register(sconn
->msg_ctx
, sconn
, MSG_SMB_ASYNC_LEVEL2_BREAK
,
933 process_oplock_async_level2_break_message
);
934 messaging_register(sconn
->msg_ctx
, sconn
, MSG_SMB_KERNEL_BREAK
,
935 process_kernel_oplock_break
);
937 messaging_register(sconn
->msg_ctx
, sconn
, MSG_SMB_OPEN_RETRY
,
938 process_open_retry_message
);
944 void init_kernel_oplocks(struct smbd_server_connection
*sconn
)
946 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
948 /* only initialize once */
949 if (koplocks
== NULL
) {
950 #if HAVE_KERNEL_OPLOCKS_IRIX
951 koplocks
= irix_init_kernel_oplocks(sconn
);
952 #elif HAVE_KERNEL_OPLOCKS_LINUX
953 koplocks
= linux_init_kernel_oplocks(sconn
);
955 sconn
->oplocks
.kernel_ops
= koplocks
;