2 Unix SMB/CIFS implementation.
3 Blocking Locking functions
4 Copyright (C) Jeremy Allison 1998-2003
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #define DBGC_CLASS DBGC_LOCKING
24 /****************************************************************************
25 This is the structure to queue to implement blocking locks.
26 notify. It consists of the requesting SMB and the expiry time.
27 *****************************************************************************/
29 typedef struct blocking_lock_record {
30 struct blocking_lock_record *next;
31 struct blocking_lock_record *prev;
33 struct timeval expire_time;
38 uint32_t blocking_pid; /* PID that blocks us. */
39 enum brl_flavour lock_flav;
40 enum brl_type lock_type;
41 struct smb_request *req;
42 } blocking_lock_record;
44 /* dlink list we store pending lock records on. */
45 static blocking_lock_record *blocking_lock_queue;
47 /* dlink list we move cancelled lock records onto. */
48 static blocking_lock_record *blocking_lock_cancelled_queue;
50 /* The event that makes us process our blocking lock queue */
51 static struct timed_event *brl_timeout;
53 /****************************************************************************
54 Determine if this is a secondary element of a chained SMB.
55 **************************************************************************/
57 static bool in_chained_smb(void)
59 return (chain_size != 0);
62 static void received_unlock_msg(struct messaging_context *msg,
65 struct server_id server_id,
67 static void process_blocking_lock_queue(void);
69 static void brl_timeout_fn(struct event_context *event_ctx,
70 struct timed_event *te,
74 SMB_ASSERT(brl_timeout == te);
75 TALLOC_FREE(brl_timeout);
77 change_to_root_user(); /* TODO: Possibly run all timed events as
80 process_blocking_lock_queue();
83 /****************************************************************************
84 After a change to blocking_lock_queue, recalculate the timed_event for the
86 ****************************************************************************/
88 static bool recalc_brl_timeout(void)
90 blocking_lock_record *brl;
91 struct timeval next_timeout;
93 TALLOC_FREE(brl_timeout);
95 next_timeout = timeval_zero();
97 for (brl = blocking_lock_queue; brl; brl = brl->next) {
98 if (timeval_is_zero(&brl->expire_time)) {
100 * If we're blocked on pid 0xFFFFFFFF this is
101 * a POSIX lock, so calculate a timeout of
102 * 10 seconds into the future.
104 if (brl->blocking_pid == 0xFFFFFFFF) {
105 struct timeval psx_to = timeval_current_ofs(10, 0);
106 next_timeout = timeval_min(&next_timeout, &psx_to);
112 if (timeval_is_zero(&next_timeout)) {
113 next_timeout = brl->expire_time;
116 next_timeout = timeval_min(&next_timeout,
121 if (timeval_is_zero(&next_timeout)) {
125 if (!(brl_timeout = event_add_timed(smbd_event_context(), NULL,
127 brl_timeout_fn, NULL))) {
135 /****************************************************************************
136 Function to push a blocking lock request onto the lock queue.
137 ****************************************************************************/
139 bool push_blocking_lock_request( struct byte_range_lock *br_lck,
140 struct smb_request *req,
145 enum brl_type lock_type,
146 enum brl_flavour lock_flav,
149 uint32_t blocking_pid)
151 static bool set_lock_msg;
152 blocking_lock_record *blr;
155 if(in_chained_smb() ) {
156 DEBUG(0,("push_blocking_lock_request: cannot queue a chained request (currently).\n"));
161 * Now queue an entry on the blocking lock queue. We setup
162 * the expiration time here.
165 blr = talloc(NULL, struct blocking_lock_record);
167 DEBUG(0,("push_blocking_lock_request: Malloc fail !\n" ));
175 if (lock_timeout == -1) {
176 blr->expire_time.tv_sec = 0;
177 blr->expire_time.tv_usec = 0; /* Never expire. */
179 blr->expire_time = timeval_current_ofs(lock_timeout/1000,
180 (lock_timeout % 1000) * 1000);
182 blr->lock_num = lock_num;
183 blr->lock_pid = lock_pid;
184 blr->blocking_pid = blocking_pid;
185 blr->lock_flav = lock_flav;
186 blr->lock_type = lock_type;
187 blr->offset = offset;
190 /* Add a pending lock record for this. */
191 status = brl_lock(smbd_messaging_context(), br_lck,
196 lock_type == READ_LOCK ? PENDING_READ_LOCK : PENDING_WRITE_LOCK,
198 lock_timeout ? True : False, /* blocking_lock. */
201 if (!NT_STATUS_IS_OK(status)) {
202 DEBUG(0,("push_blocking_lock_request: failed to add PENDING_LOCK record.\n"));
203 DLIST_REMOVE(blocking_lock_queue, blr);
208 blr->req = talloc_move(blr, &req);
210 DLIST_ADD_END(blocking_lock_queue, blr, blocking_lock_record *);
211 recalc_brl_timeout();
213 /* Ensure we'll receive messages when this is unlocked. */
215 messaging_register(smbd_messaging_context(), NULL,
216 MSG_SMB_UNLOCK, received_unlock_msg);
220 DEBUG(3,("push_blocking_lock_request: lock request blocked with "
221 "expiry time (%u sec. %u usec) (+%d msec) for fnum = %d, name = %s\n",
222 (unsigned int)blr->expire_time.tv_sec,
223 (unsigned int)blr->expire_time.tv_usec, lock_timeout,
224 blr->fsp->fnum, blr->fsp->fsp_name ));
226 /* Push the MID of this packet on the signing queue. */
227 srv_defer_sign_response(blr->req->mid);
232 /****************************************************************************
233 Return a lockingX success SMB.
234 *****************************************************************************/
236 static void reply_lockingX_success(blocking_lock_record *blr)
238 reply_outbuf(blr->req, 2, 0);
241 * As this message is a lockingX call we must handle
242 * any following chained message correctly.
243 * This is normally handled in construct_reply(),
244 * but as that calls switch_message, we can't use
245 * that here and must set up the chain info manually.
248 chain_reply(blr->req);
250 if (!srv_send_smb(smbd_server_fd(), (char *)blr->req->outbuf,
251 IS_CONN_ENCRYPTED(blr->fsp->conn))) {
252 exit_server_cleanly("send_blocking_reply: srv_send_smb failed.");
255 TALLOC_FREE(blr->req->outbuf);
258 /****************************************************************************
259 Return a generic lock fail error blocking call.
260 *****************************************************************************/
262 static void generic_blocking_lock_error(blocking_lock_record *blr, NTSTATUS status)
264 /* whenever a timeout is given w2k maps LOCK_NOT_GRANTED to
265 FILE_LOCK_CONFLICT! (tridge) */
266 if (NT_STATUS_EQUAL(status, NT_STATUS_LOCK_NOT_GRANTED)) {
267 status = NT_STATUS_FILE_LOCK_CONFLICT;
270 if (NT_STATUS_EQUAL(status, NT_STATUS_FILE_LOCK_CONFLICT)) {
271 /* Store the last lock error. */
272 files_struct *fsp = blr->fsp;
275 fsp->last_lock_failure.context.smbpid = blr->lock_pid;
276 fsp->last_lock_failure.context.tid = fsp->conn->cnum;
277 fsp->last_lock_failure.context.pid = procid_self();
278 fsp->last_lock_failure.start = blr->offset;
279 fsp->last_lock_failure.size = blr->count;
280 fsp->last_lock_failure.fnum = fsp->fnum;
281 fsp->last_lock_failure.lock_type = READ_LOCK; /* Don't care. */
282 fsp->last_lock_failure.lock_flav = blr->lock_flav;
286 reply_nterror(blr->req, status);
287 if (!srv_send_smb(smbd_server_fd(), (char *)blr->req->outbuf,
288 blr->req->encrypted)) {
289 exit_server_cleanly("generic_blocking_lock_error: srv_send_smb failed.");
291 TALLOC_FREE(blr->req->outbuf);
294 /****************************************************************************
295 Return a lock fail error for a lockingX call. Undo all the locks we have
297 *****************************************************************************/
299 static void reply_lockingX_error(blocking_lock_record *blr, NTSTATUS status)
301 files_struct *fsp = blr->fsp;
302 uint16 num_ulocks = SVAL(blr->req->vwv+6, 0);
303 uint64_t count = (uint64_t)0, offset = (uint64_t) 0;
305 unsigned char locktype = CVAL(blr->req->vwv+3, 0);
306 bool large_file_format = (locktype & LOCKING_ANDX_LARGE_FILES);
310 data = (uint8_t *)blr->req->buf
311 + ((large_file_format ? 20 : 10)*num_ulocks);
314 * Data now points at the beginning of the list
315 * of smb_lkrng structs.
319 * Ensure we don't do a remove on the lock that just failed,
320 * as under POSIX rules, if we have a lock already there, we
321 * will delete it (and we shouldn't) .....
324 for(i = blr->lock_num - 1; i >= 0; i--) {
327 lock_pid = get_lock_pid( data, i, large_file_format);
328 count = get_lock_count( data, i, large_file_format);
329 offset = get_lock_offset( data, i, large_file_format, &err);
332 * We know err cannot be set as if it was the lock
333 * request would never have been queued. JRA.
336 do_unlock(smbd_messaging_context(),
344 generic_blocking_lock_error(blr, status);
347 /****************************************************************************
348 Return a lock fail error.
349 *****************************************************************************/
351 static void blocking_lock_reply_error(blocking_lock_record *blr, NTSTATUS status)
353 switch(blr->req->cmd) {
355 reply_lockingX_error(blr, status);
359 reply_nterror(blr->req, status);
362 * construct_reply_common has done us the favor to pre-fill
363 * the command field with SMBtranss2 which is wrong :-)
365 SCVAL(blr->req->outbuf,smb_com,SMBtrans2);
367 if (!srv_send_smb(smbd_server_fd(),
368 (char *)blr->req->outbuf,
369 IS_CONN_ENCRYPTED(blr->fsp->conn))) {
370 exit_server_cleanly("blocking_lock_reply_error: "
371 "srv_send_smb failed.");
373 TALLOC_FREE(blr->req->outbuf);
376 DEBUG(0,("blocking_lock_reply_error: PANIC - unknown type on blocking lock queue - exiting.!\n"));
377 exit_server("PANIC - unknown type on blocking lock queue");
381 /****************************************************************************
382 Attempt to finish off getting all pending blocking locks for a lockingX call.
383 Returns True if we want to be removed from the list.
384 *****************************************************************************/
386 static bool process_lockingX(blocking_lock_record *blr)
388 unsigned char locktype = CVAL(blr->req->vwv+3, 0);
389 files_struct *fsp = blr->fsp;
390 uint16 num_ulocks = SVAL(blr->req->vwv+6, 0);
391 uint16 num_locks = SVAL(blr->req->vwv+7, 0);
392 uint64_t count = (uint64_t)0, offset = (uint64_t)0;
394 bool large_file_format = (locktype & LOCKING_ANDX_LARGE_FILES);
396 NTSTATUS status = NT_STATUS_OK;
398 data = (uint8_t *)blr->req->buf
399 + ((large_file_format ? 20 : 10)*num_ulocks);
402 * Data now points at the beginning of the list
403 * of smb_lkrng structs.
406 for(; blr->lock_num < num_locks; blr->lock_num++) {
407 struct byte_range_lock *br_lck = NULL;
410 lock_pid = get_lock_pid( data, blr->lock_num, large_file_format);
411 count = get_lock_count( data, blr->lock_num, large_file_format);
412 offset = get_lock_offset( data, blr->lock_num, large_file_format, &err);
415 * We know err cannot be set as if it was the lock
416 * request would never have been queued. JRA.
419 br_lck = do_lock(smbd_messaging_context(),
424 ((locktype & LOCKING_ANDX_SHARED_LOCK) ?
425 READ_LOCK : WRITE_LOCK),
433 if (NT_STATUS_IS_ERR(status)) {
438 if(blr->lock_num == num_locks) {
440 * Success - we got all the locks.
443 DEBUG(3,("process_lockingX file = %s, fnum=%d type=%d num_locks=%d\n",
444 fsp->fsp_name, fsp->fnum, (unsigned int)locktype, num_locks) );
446 reply_lockingX_success(blr);
450 if (!NT_STATUS_EQUAL(status,NT_STATUS_LOCK_NOT_GRANTED) &&
451 !NT_STATUS_EQUAL(status,NT_STATUS_FILE_LOCK_CONFLICT)) {
453 * We have other than a "can't get lock"
454 * error. Free any locks we had and return an error.
455 * Return True so we get dequeued.
457 blocking_lock_reply_error(blr, status);
462 * Still can't get all the locks - keep waiting.
465 DEBUG(10,("process_lockingX: only got %d locks of %d needed for file %s, fnum = %d. \
467 blr->lock_num, num_locks, fsp->fsp_name, fsp->fnum));
472 /****************************************************************************
473 Attempt to get the posix lock request from a SMBtrans2 call.
474 Returns True if we want to be removed from the list.
475 *****************************************************************************/
477 static bool process_trans2(blocking_lock_record *blr)
481 struct byte_range_lock *br_lck = do_lock(smbd_messaging_context(),
493 if (!NT_STATUS_IS_OK(status)) {
494 if (ERROR_WAS_LOCK_DENIED(status)) {
495 /* Still can't get the lock, just keep waiting. */
499 * We have other than a "can't get lock"
500 * error. Send an error and return True so we get dequeued.
502 blocking_lock_reply_error(blr, status);
506 /* We finally got the lock, return success. */
509 /* Fake up max_data_bytes here - we know it fits. */
510 send_trans2_replies(blr->fsp->conn, blr->req, params, 2, NULL, 0, 0xffff);
515 /****************************************************************************
516 Process a blocking lock SMB.
517 Returns True if we want to be removed from the list.
518 *****************************************************************************/
520 static bool blocking_lock_record_process(blocking_lock_record *blr)
522 switch(blr->req->cmd) {
524 return process_lockingX(blr);
527 return process_trans2(blr);
529 DEBUG(0,("blocking_lock_record_process: PANIC - unknown type on blocking lock queue - exiting.!\n"));
530 exit_server("PANIC - unknown type on blocking lock queue");
532 return False; /* Keep compiler happy. */
535 /****************************************************************************
536 Cancel entries by fnum from the blocking lock pending queue.
537 *****************************************************************************/
539 void cancel_pending_lock_requests_by_fid(files_struct *fsp, struct byte_range_lock *br_lck)
541 blocking_lock_record *blr, *next = NULL;
543 for(blr = blocking_lock_queue; blr; blr = next) {
544 unsigned char locktype = 0;
547 if (blr->fsp->fnum != fsp->fnum) {
551 if (blr->req->cmd == SMBlockingX) {
552 locktype = CVAL(blr->req->vwv+3, 0);
555 DEBUG(10, ("remove_pending_lock_requests_by_fid - removing "
556 "request type %d for file %s fnum = %d\n",
557 blr->req->cmd, fsp->fsp_name, fsp->fnum));
559 brl_lock_cancel(br_lck,
566 blocking_lock_cancel(fsp,
572 NT_STATUS_RANGE_NOT_LOCKED);
574 /* We're closing the file fsp here, so ensure
575 * we don't have a dangling pointer. */
580 /****************************************************************************
581 Delete entries by mid from the blocking lock pending queue. Always send reply.
582 *****************************************************************************/
584 void remove_pending_lock_requests_by_mid(int mid)
586 blocking_lock_record *blr, *next = NULL;
588 for(blr = blocking_lock_queue; blr; blr = next) {
590 struct byte_range_lock *br_lck;
594 if (blr->req->mid != mid) {
599 br_lck = brl_get_locks(talloc_tos(), fsp);
602 DEBUG(10, ("remove_pending_lock_requests_by_mid - "
603 "removing request type %d for file %s fnum "
604 "= %d\n", blr->req->cmd, fsp->fsp_name,
607 brl_lock_cancel(br_lck,
616 blocking_lock_reply_error(blr,NT_STATUS_FILE_LOCK_CONFLICT);
617 DLIST_REMOVE(blocking_lock_queue, blr);
622 /****************************************************************************
623 Is this mid a blocking lock request on the queue ?
624 *****************************************************************************/
626 bool blocking_lock_was_deferred(int mid)
628 blocking_lock_record *blr, *next = NULL;
630 for(blr = blocking_lock_queue; blr; blr = next) {
632 if(blr->req->mid == mid) {
639 /****************************************************************************
640 Set a flag as an unlock request affects one of our pending locks.
641 *****************************************************************************/
643 static void received_unlock_msg(struct messaging_context *msg,
646 struct server_id server_id,
649 DEBUG(10,("received_unlock_msg\n"));
650 process_blocking_lock_queue();
653 /****************************************************************************
654 Process the blocking lock queue. Note that this is only called as root.
655 *****************************************************************************/
657 static void process_blocking_lock_queue(void)
659 struct timeval tv_curr = timeval_current();
660 blocking_lock_record *blr, *next = NULL;
661 bool recalc_timeout = False;
664 * Go through the queue and see if we can get any of the locks.
667 for (blr = blocking_lock_queue; blr; blr = next) {
672 * Go through the remaining locks and try and obtain them.
673 * The call returns True if all locks were obtained successfully
674 * and False if we still need to wait.
677 if(blocking_lock_record_process(blr)) {
678 struct byte_range_lock *br_lck = brl_get_locks(
679 talloc_tos(), blr->fsp);
682 brl_lock_cancel(br_lck,
691 DLIST_REMOVE(blocking_lock_queue, blr);
693 recalc_timeout = True;
698 * We couldn't get the locks for this record on the list.
699 * If the time has expired, return a lock error.
702 if (!timeval_is_zero(&blr->expire_time) && timeval_compare(&blr->expire_time, &tv_curr) <= 0) {
703 struct byte_range_lock *br_lck = brl_get_locks(
704 talloc_tos(), blr->fsp);
707 * Lock expired - throw away all previously
708 * obtained locks and return lock error.
712 DEBUG(5,("process_blocking_lock_queue: "
713 "pending lock fnum = %d for file %s "
714 "timed out.\n", blr->fsp->fnum,
715 blr->fsp->fsp_name ));
717 brl_lock_cancel(br_lck,
726 blocking_lock_reply_error(blr,NT_STATUS_FILE_LOCK_CONFLICT);
727 DLIST_REMOVE(blocking_lock_queue, blr);
729 recalc_timeout = True;
733 if (recalc_timeout) {
734 recalc_brl_timeout();
738 /****************************************************************************
739 Handle a cancel message. Lock already moved onto the cancel queue.
740 *****************************************************************************/
742 #define MSG_BLOCKING_LOCK_CANCEL_SIZE (sizeof(blocking_lock_record *) + sizeof(NTSTATUS))
744 static void process_blocking_lock_cancel_message(struct messaging_context *ctx,
747 struct server_id server_id,
751 const char *msg = (const char *)data->data;
752 blocking_lock_record *blr;
754 if (data->data == NULL) {
755 smb_panic("process_blocking_lock_cancel_message: null msg");
758 if (data->length != MSG_BLOCKING_LOCK_CANCEL_SIZE) {
759 DEBUG(0, ("process_blocking_lock_cancel_message: "
760 "Got invalid msg len %d\n", (int)data->length));
761 smb_panic("process_blocking_lock_cancel_message: bad msg");
764 memcpy(&blr, msg, sizeof(blr));
765 memcpy(&err, &msg[sizeof(blr)], sizeof(NTSTATUS));
767 DEBUG(10,("process_blocking_lock_cancel_message: returning error %s\n",
770 blocking_lock_reply_error(blr, err);
771 DLIST_REMOVE(blocking_lock_cancelled_queue, blr);
775 /****************************************************************************
776 Send ourselves a blocking lock cancelled message. Handled asynchronously above.
777 *****************************************************************************/
779 bool blocking_lock_cancel(files_struct *fsp,
783 enum brl_flavour lock_flav,
784 unsigned char locktype,
787 static bool initialized;
788 char msg[MSG_BLOCKING_LOCK_CANCEL_SIZE];
789 blocking_lock_record *blr;
792 /* Register our message. */
793 messaging_register(smbd_messaging_context(), NULL,
794 MSG_SMB_BLOCKING_LOCK_CANCEL,
795 process_blocking_lock_cancel_message);
800 for (blr = blocking_lock_queue; blr; blr = blr->next) {
801 if (fsp == blr->fsp &&
802 lock_pid == blr->lock_pid &&
803 offset == blr->offset &&
804 count == blr->count &&
805 lock_flav == blr->lock_flav) {
814 /* Check the flags are right. */
815 if (blr->req->cmd == SMBlockingX &&
816 (locktype & LOCKING_ANDX_LARGE_FILES) !=
817 (CVAL(blr->req->vwv+3, 0) & LOCKING_ANDX_LARGE_FILES)) {
821 /* Move to cancelled queue. */
822 DLIST_REMOVE(blocking_lock_queue, blr);
823 DLIST_ADD(blocking_lock_cancelled_queue, blr);
825 /* Create the message. */
826 memcpy(msg, &blr, sizeof(blr));
827 memcpy(&msg[sizeof(blr)], &err, sizeof(NTSTATUS));
829 messaging_send_buf(smbd_messaging_context(), procid_self(),
830 MSG_SMB_BLOCKING_LOCK_CANCEL,
831 (uint8 *)&msg, sizeof(msg));