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 "lib/util/server_id.h"
25 #include "locking/share_mode_lock.h"
26 #include "smbd/smbd.h"
27 #include "smbd/globals.h"
29 #include "locking/leases_db.h"
30 #include "../librpc/gen_ndr/ndr_open_files.h"
33 * helper function used by the kernel oplock backends to post the break message
35 void break_kernel_oplock(struct messaging_context
*msg_ctx
, files_struct
*fsp
)
37 uint8_t msg
[MSG_SMB_KERNEL_BREAK_SIZE
];
39 /* Put the kernel break info into the message. */
40 push_file_id_24((char *)msg
, &fsp
->file_id
);
41 SIVAL(msg
, 24, fh_get_gen_id(fsp
->fh
));
43 /* Don't need to be root here as we're only ever
44 sending to ourselves. */
46 messaging_send_buf(msg_ctx
, messaging_server_id(msg_ctx
),
48 msg
, MSG_SMB_KERNEL_BREAK_SIZE
);
51 /****************************************************************************
52 Attempt to set an oplock on a file. Succeeds if kernel oplocks are
53 disabled (just sets flags).
54 ****************************************************************************/
56 NTSTATUS
set_file_oplock(files_struct
*fsp
)
58 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
59 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
60 bool use_kernel
= lp_kernel_oplocks(SNUM(fsp
->conn
)) &&
62 struct file_id_buf buf
;
64 if (fsp
->oplock_type
== LEVEL_II_OPLOCK
&& use_kernel
) {
65 DEBUG(10, ("Refusing level2 oplock, kernel oplocks "
66 "don't support them\n"));
67 return NT_STATUS_NOT_SUPPORTED
;
70 if ((fsp
->oplock_type
!= NO_OPLOCK
) &&
72 !koplocks
->ops
->set_oplock(koplocks
, fsp
, fsp
->oplock_type
))
74 return map_nt_error_from_unix(errno
);
77 fsp
->sent_oplock_break
= NO_BREAK_SENT
;
78 if (fsp
->oplock_type
== LEVEL_II_OPLOCK
) {
79 sconn
->oplocks
.level_II_open
++;
80 } else if (EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
81 sconn
->oplocks
.exclusive_open
++;
84 DBG_INFO("granted oplock on file %s, %s/%"PRIu64
", "
85 "tv_sec = %x, tv_usec = %x\n",
87 file_id_str_buf(fsp
->file_id
, &buf
),
88 fh_get_gen_id(fsp
->fh
),
89 (int)fsp
->open_time
.tv_sec
,
90 (int)fsp
->open_time
.tv_usec
);
95 static void release_fsp_kernel_oplock(files_struct
*fsp
)
97 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
98 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
101 if (koplocks
== NULL
) {
104 use_kernel
= lp_kernel_oplocks(SNUM(fsp
->conn
));
108 if (fsp
->oplock_type
== NO_OPLOCK
) {
111 if (fsp
->oplock_type
== LEASE_OPLOCK
) {
113 * For leases we don't touch kernel oplocks at all
118 koplocks
->ops
->release_oplock(koplocks
, fsp
, NO_OPLOCK
);
121 /****************************************************************************
122 Attempt to release an oplock on a file. Decrements oplock count.
123 ****************************************************************************/
125 static void release_file_oplock(files_struct
*fsp
)
127 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
129 release_fsp_kernel_oplock(fsp
);
131 if (fsp
->oplock_type
== LEVEL_II_OPLOCK
) {
132 sconn
->oplocks
.level_II_open
--;
133 } else if (EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
134 sconn
->oplocks
.exclusive_open
--;
137 SMB_ASSERT(sconn
->oplocks
.exclusive_open
>=0);
138 SMB_ASSERT(sconn
->oplocks
.level_II_open
>=0);
140 fsp
->oplock_type
= NO_OPLOCK
;
141 fsp
->sent_oplock_break
= NO_BREAK_SENT
;
143 TALLOC_FREE(fsp
->oplock_timeout
);
146 /****************************************************************************
147 Attempt to downgrade an oplock on a file. Doesn't decrement oplock count.
148 ****************************************************************************/
150 static void downgrade_file_oplock(files_struct
*fsp
)
152 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
153 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
154 bool use_kernel
= lp_kernel_oplocks(SNUM(fsp
->conn
)) &&
157 if (!EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
)) {
158 DEBUG(0, ("trying to downgrade an already-downgraded oplock!\n"));
163 koplocks
->ops
->release_oplock(koplocks
, fsp
, LEVEL_II_OPLOCK
);
165 fsp
->oplock_type
= LEVEL_II_OPLOCK
;
166 sconn
->oplocks
.exclusive_open
--;
167 sconn
->oplocks
.level_II_open
++;
168 fsp
->sent_oplock_break
= NO_BREAK_SENT
;
170 TALLOC_FREE(fsp
->oplock_timeout
);
173 uint32_t get_lease_type(struct share_mode_entry
*e
, struct file_id id
)
175 struct GUID_txt_buf guid_strbuf
;
176 struct file_id_buf file_id_strbuf
;
178 uint32_t current_state
;
180 if (e
->op_type
!= LEASE_OPLOCK
) {
181 return map_oplock_to_lease_type(e
->op_type
);
184 status
= leases_db_get(&e
->client_guid
,
189 NULL
, /* breaking_to_requested */
190 NULL
, /* breaking_to_required */
191 NULL
, /* lease_version */
193 if (NT_STATUS_IS_OK(status
)) {
194 return current_state
;
197 if (share_entry_stale_pid(e
)) {
200 DBG_ERR("leases_db_get for client_guid [%s] "
201 "lease_key [%"PRIu64
"/%"PRIu64
"] "
202 "file_id [%s] failed: %s\n",
203 GUID_buf_string(&e
->client_guid
, &guid_strbuf
),
204 e
->lease_key
.data
[0],
205 e
->lease_key
.data
[1],
206 file_id_str_buf(id
, &file_id_strbuf
),
208 smb_panic("leases_db_get() failed");
211 /****************************************************************************
212 Remove a file oplock. Copes with level II and exclusive.
213 Locks then unlocks the share mode lock. Client can decide to go directly
214 to none even if a "break-to-level II" was sent.
215 ****************************************************************************/
217 bool remove_oplock(files_struct
*fsp
)
220 struct share_mode_lock
*lck
;
222 DBG_DEBUG("remove_oplock called for %s\n", fsp_str_dbg(fsp
));
224 /* Remove the oplock flag from the sharemode. */
225 lck
= get_existing_share_mode_lock(talloc_tos(), fsp
->file_id
);
227 DBG_ERR("failed to lock share entry for "
228 "file %s\n", fsp_str_dbg(fsp
));
232 ret
= remove_share_oplock(lck
, fsp
);
234 struct file_id_buf buf
;
236 DBG_ERR("failed to remove share oplock for "
238 fsp_str_dbg(fsp
), fsp_fnum_dbg(fsp
),
239 file_id_str_buf(fsp
->file_id
, &buf
));
241 release_file_oplock(fsp
);
248 * Deal with a reply when a break-to-level II was sent.
250 bool downgrade_oplock(files_struct
*fsp
)
253 struct share_mode_lock
*lck
;
255 DEBUG(10, ("downgrade_oplock called for %s\n",
258 lck
= get_existing_share_mode_lock(talloc_tos(), fsp
->file_id
);
260 DEBUG(0,("downgrade_oplock: failed to lock share entry for "
261 "file %s\n", fsp_str_dbg(fsp
)));
264 ret
= downgrade_share_oplock(lck
, fsp
);
266 struct file_id_buf idbuf
;
267 DBG_ERR("failed to downgrade share oplock "
268 "for file %s, %s, file_id %s\n",
271 file_id_str_buf(fsp
->file_id
, &idbuf
));
273 downgrade_file_oplock(fsp
);
279 static void lease_timeout_handler(struct tevent_context
*ctx
,
280 struct tevent_timer
*te
,
284 struct fsp_lease
*lease
=
285 talloc_get_type_abort(private_data
,
287 struct files_struct
*fsp
;
288 struct share_mode_lock
*lck
;
289 uint16_t old_epoch
= lease
->lease
.lease_epoch
;
291 fsp
= file_find_one_fsp_from_lease_key(lease
->sconn
,
292 &lease
->lease
.lease_key
);
295 TALLOC_FREE(lease
->timeout
);
300 * Paranoia check: There can only be one fsp_lease per lease
303 SMB_ASSERT(fsp
->lease
== lease
);
305 lck
= get_existing_share_mode_lock(
306 talloc_tos(), fsp
->file_id
);
309 TALLOC_FREE(lease
->timeout
);
313 fsp_lease_update(fsp
);
315 if (lease
->lease
.lease_epoch
!= old_epoch
) {
317 * If the epoch changed we need to wait for
318 * the next timeout to happen.
320 DEBUG(10, ("lease break timeout race (epoch) for file %s - ignoring\n",
326 if (!(lease
->lease
.lease_flags
& SMB2_LEASE_FLAG_BREAK_IN_PROGRESS
)) {
328 * If the epoch changed we need to wait for
329 * the next timeout to happen.
331 DEBUG(10, ("lease break timeout race (flags) for file %s - ignoring\n",
337 DEBUG(1, ("lease break timed out for file %s -- replying anyway\n",
339 (void)downgrade_lease(lease
->sconn
->client
,
342 &lease
->lease
.lease_key
,
348 bool fsp_lease_update(struct files_struct
*fsp
)
350 const struct GUID
*client_guid
= fsp_client_guid(fsp
);
351 struct fsp_lease
*lease
= fsp
->lease
;
352 uint32_t current_state
;
354 uint16_t lease_version
, epoch
;
357 status
= leases_db_get(client_guid
,
358 &lease
->lease
.lease_key
,
362 NULL
, /* breaking_to_requested */
363 NULL
, /* breaking_to_required */
366 if (!NT_STATUS_IS_OK(status
)) {
367 DBG_WARNING("Could not find lease entry: %s\n",
369 TALLOC_FREE(lease
->timeout
);
370 lease
->lease
.lease_state
= SMB2_LEASE_NONE
;
371 lease
->lease
.lease_epoch
+= 1;
372 lease
->lease
.lease_flags
= 0;
376 DEBUG(10,("%s: refresh lease state\n", __func__
));
378 /* Ensure we're in sync with current lease state. */
379 if (lease
->lease
.lease_epoch
!= epoch
) {
380 DEBUG(10,("%s: cancel outdated timeout\n", __func__
));
381 TALLOC_FREE(lease
->timeout
);
383 lease
->lease
.lease_epoch
= epoch
;
384 lease
->lease
.lease_state
= current_state
;
387 lease
->lease
.lease_flags
|= SMB2_LEASE_FLAG_BREAK_IN_PROGRESS
;
389 if (lease
->timeout
== NULL
) {
390 struct timeval t
= timeval_current_ofs(OPLOCK_BREAK_TIMEOUT
, 0);
392 DEBUG(10,("%s: setup timeout handler\n", __func__
));
394 lease
->timeout
= tevent_add_timer(lease
->sconn
->ev_ctx
,
396 lease_timeout_handler
,
398 if (lease
->timeout
== NULL
) {
399 DEBUG(0, ("%s: Could not add lease timeout handler\n",
404 lease
->lease
.lease_flags
&= ~SMB2_LEASE_FLAG_BREAK_IN_PROGRESS
;
405 TALLOC_FREE(lease
->timeout
);
411 struct downgrade_lease_additional_state
{
412 struct tevent_immediate
*im
;
413 struct smbXsrv_client
*client
;
414 uint32_t break_flags
;
415 struct smb2_lease_key lease_key
;
421 static void downgrade_lease_additional_trigger(struct tevent_context
*ev
,
422 struct tevent_immediate
*im
,
425 struct downgrade_lease_additional_state
*state
=
426 talloc_get_type_abort(private_data
,
427 struct downgrade_lease_additional_state
);
430 status
= smbd_smb2_send_lease_break(state
->client
,
436 if (!NT_STATUS_IS_OK(status
)) {
437 smbd_server_disconnect_client(state
->client
,
443 struct fsps_lease_update_state
{
444 const struct file_id
*id
;
445 const struct smb2_lease_key
*key
;
448 static struct files_struct
*fsps_lease_update_fn(
449 struct files_struct
*fsp
, void *private_data
)
451 struct fsps_lease_update_state
*state
=
452 (struct fsps_lease_update_state
*)private_data
;
454 if (fsp
->oplock_type
!= LEASE_OPLOCK
) {
457 if (!smb2_lease_key_equal(&fsp
->lease
->lease
.lease_key
, state
->key
)) {
460 if (!file_id_equal(&fsp
->file_id
, state
->id
)) {
464 fsp_lease_update(fsp
);
469 static void fsps_lease_update(struct smbd_server_connection
*sconn
,
470 const struct file_id
*id
,
471 const struct smb2_lease_key
*key
)
473 struct fsps_lease_update_state state
= { .id
= id
, .key
= key
};
474 files_forall(sconn
, fsps_lease_update_fn
, &state
);
477 NTSTATUS
downgrade_lease(struct smbXsrv_client
*client
,
478 uint32_t num_file_ids
,
479 const struct file_id
*ids
,
480 const struct smb2_lease_key
*key
,
481 uint32_t lease_state
)
483 struct smbd_server_connection
*sconn
= client
->sconn
;
484 const struct GUID
*client_guid
= NULL
;
485 struct share_mode_lock
*lck
;
486 const struct file_id id
= ids
[0];
487 uint32_t current_state
, breaking_to_requested
, breaking_to_required
;
489 uint16_t lease_version
, epoch
;
492 struct file_id_buf idbuf
;
494 DBG_DEBUG("Downgrading %s to %"PRIu32
"\n",
495 file_id_str_buf(id
, &idbuf
),
498 lck
= get_existing_share_mode_lock(talloc_tos(), id
);
500 return NT_STATUS_OBJECT_NAME_NOT_FOUND
;
503 client_guid
= &sconn
->client
->global
->client_guid
;
505 status
= leases_db_get(client_guid
,
510 &breaking_to_requested
,
511 &breaking_to_required
,
514 if (!NT_STATUS_IS_OK(status
)) {
515 DBG_WARNING("leases_db_get returned %s\n",
522 DBG_WARNING("Attempt to break from %"PRIu32
" to %"PRIu32
" - "
523 "but we're not in breaking state\n",
524 current_state
, lease_state
);
526 return NT_STATUS_UNSUCCESSFUL
;
530 * Can't upgrade anything: breaking_to_requested (and current_state)
531 * must be a strict bitwise superset of new_lease_state
533 if ((lease_state
& breaking_to_requested
) != lease_state
) {
534 DBG_WARNING("Attempt to upgrade from %"PRIu32
" to %"PRIu32
" "
535 "- expected %"PRIu32
"\n",
536 current_state
, lease_state
,
537 breaking_to_requested
);
539 return NT_STATUS_REQUEST_NOT_ACCEPTED
;
542 if (current_state
!= lease_state
) {
543 current_state
= lease_state
;
546 status
= NT_STATUS_OK
;
548 if ((lease_state
& ~breaking_to_required
) != 0) {
549 struct downgrade_lease_additional_state
*state
;
551 DBG_INFO("lease state %"PRIu32
" not fully broken from "
552 "%"PRIu32
" to %"PRIu32
"\n",
555 breaking_to_required
);
557 breaking_to_requested
= breaking_to_required
;
559 if (current_state
& (SMB2_LEASE_WRITE
|SMB2_LEASE_HANDLE
)) {
561 * Here we break in steps, as windows does
562 * see the breaking3 and v2_breaking3 tests.
564 breaking_to_requested
|= SMB2_LEASE_READ
;
567 state
= talloc_zero(client
,
568 struct downgrade_lease_additional_state
);
571 return NT_STATUS_NO_MEMORY
;
574 state
->im
= tevent_create_immediate(state
);
575 if (state
->im
== NULL
) {
578 return NT_STATUS_NO_MEMORY
;
581 state
->client
= client
;
582 state
->lease_key
= *key
;
583 state
->break_from
= current_state
;
584 state
->break_to
= breaking_to_requested
;
585 if (lease_version
> 1) {
586 state
->new_epoch
= epoch
;
589 if (current_state
& (SMB2_LEASE_WRITE
|SMB2_LEASE_HANDLE
)) {
591 SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED
;
594 * This is an async break without
595 * SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED
597 * we need to store NONE state in the
601 breaking_to_requested
= 0;
602 breaking_to_required
= 0;
608 set_status
= leases_db_set(
609 &sconn
->client
->global
->client_guid
,
613 breaking_to_requested
,
614 breaking_to_required
,
618 if (!NT_STATUS_IS_OK(set_status
)) {
619 DBG_DEBUG("leases_db_set failed: %s\n",
620 nt_errstr(set_status
));
626 tevent_schedule_immediate(state
->im
,
628 downgrade_lease_additional_trigger
,
631 status
= NT_STATUS_OPLOCK_BREAK_IN_PROGRESS
;
633 DBG_DEBUG("breaking from %"PRIu32
" to %"PRIu32
" - "
634 "expected %"PRIu32
"\n",
637 breaking_to_requested
);
639 breaking_to_requested
= 0;
640 breaking_to_required
= 0;
647 set_status
= leases_db_set(
652 breaking_to_requested
,
653 breaking_to_required
,
657 if (!NT_STATUS_IS_OK(set_status
)) {
658 DBG_DEBUG("leases_db_set failed: %s\n",
659 nt_errstr(set_status
));
665 DBG_DEBUG("Downgrading %s to %"PRIu32
" => %s\n",
666 file_id_str_buf(id
, &idbuf
),
670 share_mode_wakeup_waiters(id
);
672 fsps_lease_update(sconn
, &id
, key
);
676 DBG_DEBUG("Downgrading %s to %"PRIu32
" => %s\n",
677 file_id_str_buf(id
, &idbuf
),
682 * Dynamic share case. Ensure other opens are copies.
683 * This will only be breaking to NONE.
686 for (i
= 1; i
< num_file_ids
; i
++) {
687 lck
= get_existing_share_mode_lock(talloc_tos(), ids
[i
]);
689 return NT_STATUS_OBJECT_NAME_NOT_FOUND
;
692 fsps_lease_update(sconn
, &ids
[i
], key
);
694 DBG_DEBUG("Downgrading %s to %"PRIu32
" => %s\n",
695 file_id_str_buf(ids
[i
], &idbuf
),
705 #define SMB1_BREAK_MESSAGE_LENGTH (smb_size + 8*2)
707 /****************************************************************************
708 Function to do the waiting before sending a local break.
709 ****************************************************************************/
711 static void wait_before_sending_break(void)
713 long wait_time
= (long)lp_oplock_break_wait_time();
716 smb_msleep(wait_time
);
720 /****************************************************************************
721 Ensure that we have a valid oplock.
722 ****************************************************************************/
724 static files_struct
*initial_break_processing(
725 struct smbd_server_connection
*sconn
, struct file_id id
,
726 unsigned long file_id
)
728 files_struct
*fsp
= NULL
;
729 struct file_id_buf idbuf
;
731 DBG_NOTICE("called for %s/%u\n"
732 "Current oplocks_open (exclusive = %d, levelII = %d)\n",
733 file_id_str_buf(id
, &idbuf
),
735 sconn
->oplocks
.exclusive_open
,
736 sconn
->oplocks
.level_II_open
);
739 * We need to search the file open table for the
740 * entry containing this dev and inode, and ensure
741 * we have an oplock on it.
744 fsp
= file_find_dif(sconn
, id
, file_id
);
747 /* The file could have been closed in the meantime - return success. */
748 DBG_NOTICE("cannot find open file "
749 "with file_id %s gen_id = %lu, allowing break to "
751 file_id_str_buf(id
, &idbuf
),
756 /* Ensure we have an oplock on the file */
759 * There is a potential race condition in that an oplock could
760 * have been broken due to another udp request, and yet there are
761 * still oplock break messages being sent in the udp message
762 * queue for this file. So return true if we don't have an oplock,
763 * as we may have just freed it.
766 if(fsp
->oplock_type
== NO_OPLOCK
) {
767 DBG_NOTICE("file %s (file_id = %s gen_id = %"PRIu64
") "
769 "Allowing break to succeed regardless.\n",
771 file_id_str_buf(id
, &idbuf
),
772 fh_get_gen_id(fsp
->fh
));
779 static void oplock_timeout_handler(struct tevent_context
*ctx
,
780 struct tevent_timer
*te
,
784 files_struct
*fsp
= (files_struct
*)private_data
;
786 SMB_ASSERT(fsp
->sent_oplock_break
!= NO_BREAK_SENT
);
788 /* Remove the timed event handler. */
789 TALLOC_FREE(fsp
->oplock_timeout
);
790 DEBUG(0, ("Oplock break failed for file %s -- replying anyway\n",
795 /*******************************************************************
796 Add a timeout handler waiting for the client reply.
797 *******************************************************************/
799 static void add_oplock_timeout_handler(files_struct
*fsp
)
801 if (fsp
->oplock_timeout
!= NULL
) {
802 DEBUG(0, ("Logic problem -- have an oplock event hanging "
806 fsp
->oplock_timeout
=
807 tevent_add_timer(fsp
->conn
->sconn
->ev_ctx
, fsp
,
808 timeval_current_ofs(OPLOCK_BREAK_TIMEOUT
, 0),
809 oplock_timeout_handler
, fsp
);
811 if (fsp
->oplock_timeout
== NULL
) {
812 DEBUG(0, ("Could not add oplock timeout handler\n"));
816 /*******************************************************************
817 This handles the generic oplock break message from another smbd.
818 *******************************************************************/
820 static void process_oplock_break_message(struct messaging_context
*msg_ctx
,
823 struct server_id src
,
826 struct oplock_break_message
*msg
= NULL
;
827 enum ndr_err_code ndr_err
;
830 struct smbd_server_connection
*sconn
=
831 talloc_get_type_abort(private_data
,
832 struct smbd_server_connection
);
833 struct server_id self
= messaging_server_id(sconn
->msg_ctx
);
834 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
837 bool break_needed
= true;
839 msg
= talloc(talloc_tos(), struct oplock_break_message
);
841 DBG_WARNING("talloc failed\n");
845 ndr_err
= ndr_pull_struct_blob_all(
849 (ndr_pull_flags_fn_t
)ndr_pull_oplock_break_message
);
850 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err
)) {
851 DBG_DEBUG("ndr_pull_oplock_break_message failed: %s\n",
852 ndr_errstr(ndr_err
));
856 if (DEBUGLEVEL
>= 10) {
857 struct server_id_buf buf
;
858 DBG_DEBUG("Got break message from %s\n",
859 server_id_str_buf(src
, &buf
));
860 NDR_PRINT_DEBUG(oplock_break_message
, msg
);
863 break_to
= msg
->break_to
;
864 fsp
= initial_break_processing(sconn
, msg
->id
, msg
->share_file_id
);
869 /* We hit a race here. Break messages are sent, and before we
870 * get to process this message, we have closed the file. */
871 DEBUG(3, ("Did not find fsp\n"));
875 break_from
= fsp_lease_type(fsp
);
877 if (fsp
->oplock_type
!= LEASE_OPLOCK
) {
878 if (fsp
->sent_oplock_break
!= NO_BREAK_SENT
) {
880 * Nothing to do anymore
882 DEBUG(10, ("fsp->sent_oplock_break = %d\n",
883 fsp
->sent_oplock_break
));
888 if (!(global_client_caps
& CAP_LEVEL_II_OPLOCKS
)) {
889 DEBUG(10, ("client_caps without level2 oplocks\n"));
890 break_to
&= ~SMB2_LEASE_READ
;
893 use_kernel
= lp_kernel_oplocks(SNUM(fsp
->conn
)) &&
896 DEBUG(10, ("Kernel oplocks don't allow level2\n"));
897 break_to
&= ~SMB2_LEASE_READ
;
900 if (!lp_level2_oplocks(SNUM(fsp
->conn
))) {
901 DEBUG(10, ("no level2 oplocks by config\n"));
902 break_to
&= ~SMB2_LEASE_READ
;
905 if (fsp
->oplock_type
== LEASE_OPLOCK
) {
906 const struct GUID
*client_guid
= fsp_client_guid(fsp
);
907 struct share_mode_lock
*lck
;
908 uint32_t current_state
;
909 uint32_t breaking_to_requested
, breaking_to_required
;
911 uint16_t lease_version
, epoch
;
914 lck
= get_existing_share_mode_lock(
915 talloc_tos(), fsp
->file_id
);
918 * We hit a race here. Break messages are sent, and
919 * before we get to process this message, we have closed
922 DEBUG(3, ("Did not find share_mode\n"));
926 status
= leases_db_get(client_guid
,
927 &fsp
->lease
->lease
.lease_key
,
931 &breaking_to_requested
,
932 &breaking_to_required
,
935 if (!NT_STATUS_IS_OK(status
)) {
936 DBG_WARNING("leases_db_get returned %s\n",
942 break_from
= current_state
;
943 break_to
&= current_state
;
946 break_to
&= breaking_to_required
;
947 if (breaking_to_required
!= break_to
) {
949 * Note we don't increment the epoch
950 * here, which might be a bug in
953 breaking_to_required
= break_to
;
955 break_needed
= false;
956 } else if (current_state
== break_to
) {
957 break_needed
= false;
958 } else if (current_state
== SMB2_LEASE_READ
) {
959 current_state
= SMB2_LEASE_NONE
;
960 /* Need to increment the epoch */
964 breaking_to_required
= break_to
;
965 breaking_to_requested
= break_to
;
966 /* Need to increment the epoch */
973 set_status
= leases_db_set(
975 &fsp
->lease
->lease
.lease_key
,
978 breaking_to_requested
,
979 breaking_to_required
,
983 if (!NT_STATUS_IS_OK(set_status
)) {
984 DBG_DEBUG("leases_db_set failed: %s\n",
985 nt_errstr(set_status
));
990 /* Ensure we're in sync with current lease state. */
991 fsp_lease_update(fsp
);
997 DEBUG(10,("%s: skip break\n", __func__
));
1001 if (break_from
== SMB2_LEASE_NONE
) {
1002 struct file_id_buf idbuf
;
1003 DBG_NOTICE("Already downgraded oplock to none on %s: %s\n",
1004 file_id_str_buf(fsp
->file_id
, &idbuf
),
1009 DEBUG(10, ("break_from=%u, break_to=%u\n",
1010 (unsigned)break_from
, (unsigned)break_to
));
1012 if (break_from
== break_to
) {
1013 struct file_id_buf idbuf
;
1014 DBG_NOTICE("Already downgraded oplock to %u on %s: %s\n",
1016 file_id_str_buf(fsp
->file_id
, &idbuf
),
1021 /* Need to wait before sending a break
1022 message if we sent ourselves this message. */
1023 if (server_id_equal(&self
, &src
)) {
1024 wait_before_sending_break();
1027 #if defined(WITH_SMB1SERVER)
1028 if (sconn
->using_smb2
) {
1030 send_break_message_smb2(fsp
, break_from
, break_to
);
1031 #if defined(WITH_SMB1SERVER)
1033 send_break_message_smb1(fsp
, (break_to
& SMB2_LEASE_READ
) ?
1034 OPLOCKLEVEL_II
: OPLOCKLEVEL_NONE
);
1038 if ((break_from
== SMB2_LEASE_READ
) &&
1039 (break_to
== SMB2_LEASE_NONE
)) {
1041 * This is an async break without a reply and thus no timeout
1043 * leases are handled above.
1045 if (fsp
->oplock_type
!= LEASE_OPLOCK
) {
1050 if (fsp
->oplock_type
== LEASE_OPLOCK
) {
1054 fsp
->sent_oplock_break
= (break_to
& SMB2_LEASE_READ
) ?
1055 LEVEL_II_BREAK_SENT
:BREAK_TO_NONE_SENT
;
1057 add_oplock_timeout_handler(fsp
);
1060 /*******************************************************************
1061 This handles the kernel oplock break message.
1062 *******************************************************************/
1064 static void process_kernel_oplock_break(struct messaging_context
*msg_ctx
,
1067 struct server_id src
,
1071 struct file_id_buf idbuf
;
1072 unsigned long file_id
;
1074 struct smbd_server_connection
*sconn
=
1075 talloc_get_type_abort(private_data
,
1076 struct smbd_server_connection
);
1077 struct server_id_buf tmp
;
1079 if (data
->data
== NULL
) {
1080 DEBUG(0, ("Got NULL buffer\n"));
1084 if (data
->length
!= MSG_SMB_KERNEL_BREAK_SIZE
) {
1085 DEBUG(0, ("Got invalid msg len %d\n", (int)data
->length
));
1089 /* Pull the data from the message. */
1090 pull_file_id_24((char *)data
->data
, &id
);
1091 file_id
= (unsigned long)IVAL(data
->data
, 24);
1093 DBG_DEBUG("Got kernel oplock break message from pid %s: %s/%u\n",
1094 server_id_str_buf(src
, &tmp
),
1095 file_id_str_buf(id
, &idbuf
),
1096 (unsigned int)file_id
);
1098 fsp
= initial_break_processing(sconn
, id
, file_id
);
1101 DEBUG(3, ("Got a kernel oplock break message for a file "
1102 "I don't know about\n"));
1106 if (fsp
->sent_oplock_break
!= NO_BREAK_SENT
) {
1107 /* This is ok, kernel oplocks come in completely async */
1108 DEBUG(3, ("Got a kernel oplock request while waiting for a "
1113 #if defined(WITH_SMB1SERVER)
1114 if (sconn
->using_smb2
) {
1116 send_break_message_smb2(fsp
, 0, OPLOCKLEVEL_NONE
);
1117 #if defined(WITH_SMB1SERVER)
1119 send_break_message_smb1(fsp
, OPLOCKLEVEL_NONE
);
1123 fsp
->sent_oplock_break
= BREAK_TO_NONE_SENT
;
1125 add_oplock_timeout_handler(fsp
);
1128 static void send_break_to_none(struct messaging_context
*msg_ctx
,
1129 const struct file_id
*id
,
1130 const struct share_mode_entry
*e
)
1133 status
= send_break_message(msg_ctx
, id
, e
, OPLOCK_NONE
);
1134 if (!NT_STATUS_IS_OK(status
)) {
1135 DBG_DEBUG("send_break_message failed: %s\n",
1139 struct break_to_none_state
{
1140 struct smbd_server_connection
*sconn
;
1142 struct smb2_lease_key lease_key
;
1143 struct GUID client_guid
;
1147 static bool do_break_lease_to_none(struct share_mode_entry
*e
,
1150 struct break_to_none_state
*state
= private_data
;
1151 uint32_t current_state
= 0;
1155 DBG_DEBUG("lease_key=%"PRIu64
"/%"PRIu64
"\n",
1156 e
->lease_key
.data
[0],
1157 e
->lease_key
.data
[1]);
1159 status
= leases_db_get(&e
->client_guid
,
1163 NULL
, /* breaking */
1164 NULL
, /* breaking_to_requested */
1165 NULL
, /* breaking_to_required */
1166 NULL
, /* lease_version */
1168 if (!NT_STATUS_IS_OK(status
)) {
1169 DBG_WARNING("leases_db_get failed: %s\n",
1174 if ((current_state
& SMB2_LEASE_READ
) == 0) {
1178 our_own
= smb2_lease_equal(&state
->client_guid
,
1183 DEBUG(10, ("Don't break our own lease\n"));
1187 DBG_DEBUG("Breaking %"PRIu64
"/%"PRIu64
" to none\n",
1188 e
->lease_key
.data
[0],
1189 e
->lease_key
.data
[1]);
1191 send_break_to_none(state
->sconn
->msg_ctx
, &state
->id
, e
);
1193 state
->num_broken
+= 1;
1198 static bool do_break_oplock_to_none(struct share_mode_entry
*e
,
1202 struct break_to_none_state
*state
= private_data
;
1204 if (e
->op_type
== LEASE_OPLOCK
) {
1206 * Already being taken care of
1212 * As there could have been multiple writes waiting at the
1213 * lock_share_entry gate we may not be the first to
1214 * enter. Hence the state of the op_types in the share mode
1215 * entries may be partly NO_OPLOCK and partly LEVEL_II
1216 * oplock. It will do no harm to re-send break messages to
1217 * those smbd's that are still waiting their turn to remove
1218 * their LEVEL_II state, and also no harm to ignore existing
1219 * NO_OPLOCK states. JRA.
1222 DBG_DEBUG("e->op_type == %d\n", e
->op_type
);
1224 if (e
->op_type
== NO_OPLOCK
) {
1229 SMB_ASSERT(!EXCLUSIVE_OPLOCK_TYPE(e
->op_type
));
1231 send_break_to_none(state
->sconn
->msg_ctx
, &state
->id
, e
);
1232 state
->num_broken
+= 1;
1237 /****************************************************************************
1238 This function is called on any file modification or lock request. If a file
1239 is level 2 oplocked then it must tell all other level 2 holders to break to
1241 ****************************************************************************/
1243 static void contend_level2_oplocks_begin_default(files_struct
*fsp
,
1244 enum level2_contention_type type
)
1246 struct break_to_none_state state
= {
1247 .sconn
= fsp
->conn
->sconn
, .id
= fsp
->file_id
,
1249 struct share_mode_lock
*lck
= NULL
;
1250 bool ok
, has_read_lease
;
1253 * If this file is level II oplocked then we need
1254 * to grab the shared memory lock and inform all
1255 * other files with a level II lock that they need
1256 * to flush their read caches. We keep the lock over
1257 * the shared memory area whilst doing this.
1260 if (fsp_lease_type_is_exclusive(fsp
)) {
1262 * There can't be any level2 oplocks, we're alone.
1267 has_read_lease
= file_has_read_lease(fsp
);
1268 if (!has_read_lease
) {
1269 DEBUG(10, ("No read oplocks around\n"));
1273 if (fsp
->oplock_type
== LEASE_OPLOCK
) {
1274 state
.client_guid
= *fsp_client_guid(fsp
);
1275 state
.lease_key
= fsp
->lease
->lease
.lease_key
;
1276 DEBUG(10, ("Breaking through lease key %"PRIu64
"/%"PRIu64
"\n",
1277 state
.lease_key
.data
[0],
1278 state
.lease_key
.data
[1]));
1281 lck
= get_existing_share_mode_lock(talloc_tos(), fsp
->file_id
);
1283 struct file_id_buf idbuf
;
1284 DBG_WARNING("failed to lock share mode entry for file %s.\n",
1285 file_id_str_buf(state
.id
, &idbuf
));
1290 * Walk leases and oplocks separately: We have to send one break per
1291 * lease. If we have multiple share_mode_entry having a common lease,
1292 * we would break the lease twice if we don't walk the leases list
1296 ok
= share_mode_forall_leases(lck
, do_break_lease_to_none
, &state
);
1298 DBG_WARNING("share_mode_forall_leases failed\n");
1301 ok
= share_mode_forall_entries(lck
, do_break_oplock_to_none
, &state
);
1303 DBG_WARNING("share_mode_forall_entries failed\n");
1306 if (state
.num_broken
== 0) {
1308 * Lazy update here. It might be that the read lease
1309 * has gone in the meantime.
1311 uint32_t acc
, sh
, ls
;
1312 share_mode_flags_get(lck
, &acc
, &sh
, &ls
);
1313 ls
&= ~SHARE_MODE_LEASE_READ
;
1314 share_mode_flags_set(lck
, acc
, sh
, ls
, NULL
);
1320 void smbd_contend_level2_oplocks_begin(files_struct
*fsp
,
1321 enum level2_contention_type type
)
1323 contend_level2_oplocks_begin_default(fsp
, type
);
1326 void smbd_contend_level2_oplocks_end(files_struct
*fsp
,
1327 enum level2_contention_type type
)
1332 /****************************************************************************
1333 Linearize a share mode entry struct to an internal oplock break message.
1334 ****************************************************************************/
1336 void share_mode_entry_to_message(char *msg
, const struct file_id
*id
,
1337 const struct share_mode_entry
*e
)
1339 SIVAL(msg
,OP_BREAK_MSG_PID_OFFSET
,(uint32_t)e
->pid
.pid
);
1340 SBVAL(msg
,OP_BREAK_MSG_MID_OFFSET
,e
->op_mid
);
1341 SSVAL(msg
,OP_BREAK_MSG_OP_TYPE_OFFSET
,e
->op_type
);
1342 SIVAL(msg
,OP_BREAK_MSG_ACCESS_MASK_OFFSET
,e
->access_mask
);
1343 SIVAL(msg
,OP_BREAK_MSG_SHARE_ACCESS_OFFSET
,e
->share_access
);
1344 SIVAL(msg
,OP_BREAK_MSG_PRIV_OFFSET
,e
->private_options
);
1345 SIVAL(msg
,OP_BREAK_MSG_TIME_SEC_OFFSET
,(uint32_t)e
->time
.tv_sec
);
1346 SIVAL(msg
,OP_BREAK_MSG_TIME_USEC_OFFSET
,(uint32_t)e
->time
.tv_usec
);
1348 * "id" used to be part of share_mode_entry, thus the strange
1349 * place to put this. Feel free to move somewhere else :-)
1351 push_file_id_24(msg
+OP_BREAK_MSG_DEV_OFFSET
, id
);
1352 SIVAL(msg
,OP_BREAK_MSG_FILE_ID_OFFSET
,e
->share_file_id
);
1353 SIVAL(msg
,OP_BREAK_MSG_UID_OFFSET
,e
->uid
);
1354 SSVAL(msg
,OP_BREAK_MSG_FLAGS_OFFSET
,e
->flags
);
1355 SIVAL(msg
,OP_BREAK_MSG_NAME_HASH_OFFSET
,e
->name_hash
);
1356 SIVAL(msg
,OP_BREAK_MSG_VNN_OFFSET
,e
->pid
.vnn
);
1359 /****************************************************************************
1360 De-linearize an internal oplock break message to a share mode entry struct.
1361 ****************************************************************************/
1363 void message_to_share_mode_entry(struct file_id
*id
,
1364 struct share_mode_entry
*e
,
1367 e
->pid
.pid
= (pid_t
)IVAL(msg
,OP_BREAK_MSG_PID_OFFSET
);
1368 e
->op_mid
= BVAL(msg
,OP_BREAK_MSG_MID_OFFSET
);
1369 e
->op_type
= SVAL(msg
,OP_BREAK_MSG_OP_TYPE_OFFSET
);
1370 e
->access_mask
= IVAL(msg
,OP_BREAK_MSG_ACCESS_MASK_OFFSET
);
1371 e
->share_access
= IVAL(msg
,OP_BREAK_MSG_SHARE_ACCESS_OFFSET
);
1372 e
->private_options
= IVAL(msg
,OP_BREAK_MSG_PRIV_OFFSET
);
1373 e
->time
.tv_sec
= (time_t)IVAL(msg
,OP_BREAK_MSG_TIME_SEC_OFFSET
);
1374 e
->time
.tv_usec
= (int)IVAL(msg
,OP_BREAK_MSG_TIME_USEC_OFFSET
);
1376 * "id" used to be part of share_mode_entry, thus the strange
1377 * place to put this. Feel free to move somewhere else :-)
1379 pull_file_id_24(msg
+OP_BREAK_MSG_DEV_OFFSET
, id
);
1380 e
->share_file_id
= (unsigned long)IVAL(msg
,OP_BREAK_MSG_FILE_ID_OFFSET
);
1381 e
->uid
= (uint32_t)IVAL(msg
,OP_BREAK_MSG_UID_OFFSET
);
1382 e
->flags
= (uint16_t)SVAL(msg
,OP_BREAK_MSG_FLAGS_OFFSET
);
1383 e
->name_hash
= IVAL(msg
,OP_BREAK_MSG_NAME_HASH_OFFSET
);
1384 e
->pid
.vnn
= IVAL(msg
,OP_BREAK_MSG_VNN_OFFSET
);
1387 /****************************************************************************
1388 Setup oplocks for this process.
1389 ****************************************************************************/
1391 bool init_oplocks(struct smbd_server_connection
*sconn
)
1393 DEBUG(3,("init_oplocks: initializing messages.\n"));
1395 messaging_register(sconn
->msg_ctx
, sconn
, MSG_SMB_BREAK_REQUEST
,
1396 process_oplock_break_message
);
1397 messaging_register(sconn
->msg_ctx
, sconn
, MSG_SMB_KERNEL_BREAK
,
1398 process_kernel_oplock_break
);
1402 void init_kernel_oplocks(struct smbd_server_connection
*sconn
)
1404 struct kernel_oplocks
*koplocks
= sconn
->oplocks
.kernel_ops
;
1406 /* only initialize once */
1407 if (koplocks
== NULL
) {
1408 #ifdef HAVE_KERNEL_OPLOCKS_LINUX
1409 koplocks
= linux_init_kernel_oplocks(sconn
);
1411 sconn
->oplocks
.kernel_ops
= koplocks
;