2 Unix SMB/CIFS implementation.
3 byte range locking code
4 Updated to handle range splits/merges.
6 Copyright (C) Andrew Tridgell 1992-2000
7 Copyright (C) Jeremy Allison 1992-2000
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /* This module implements a tdb based byte range locking service,
24 replacing the fcntl() based byte range locking previously
25 used. This allows us to provide the same semantics as NT */
28 #include "system/filesys.h"
29 #include "locking/proto.h"
30 #include "smbd/globals.h"
31 #include "dbwrap/dbwrap.h"
32 #include "dbwrap/dbwrap_open.h"
38 #define DBGC_CLASS DBGC_LOCKING
42 /* The open brlock.tdb database. */
44 static struct db_context
*brlock_db
;
46 struct byte_range_lock
{
47 struct files_struct
*fsp
;
48 unsigned int num_locks
;
50 bool have_read_oplocks
;
51 struct lock_struct
*lock_data
;
52 struct db_record
*record
;
55 /****************************************************************************
56 Debug info at level 10 for lock struct.
57 ****************************************************************************/
59 static void print_lock_struct(unsigned int i
, const struct lock_struct
*pls
)
61 DEBUG(10,("[%u]: smblctx = %llu, tid = %u, pid = %s, ",
63 (unsigned long long)pls
->context
.smblctx
,
64 (unsigned int)pls
->context
.tid
,
65 server_id_str(talloc_tos(), &pls
->context
.pid
) ));
67 DEBUG(10, ("start = %ju, size = %ju, fnum = %ju, %s %s\n",
68 (uintmax_t)pls
->start
,
71 lock_type_name(pls
->lock_type
),
72 lock_flav_name(pls
->lock_flav
)));
75 unsigned int brl_num_locks(const struct byte_range_lock
*brl
)
77 return brl
->num_locks
;
80 struct files_struct
*brl_fsp(struct byte_range_lock
*brl
)
85 bool brl_have_read_oplocks(const struct byte_range_lock
*brl
)
87 return brl
->have_read_oplocks
;
90 void brl_set_have_read_oplocks(struct byte_range_lock
*brl
,
91 bool have_read_oplocks
)
93 DEBUG(10, ("Setting have_read_oplocks to %s\n",
94 have_read_oplocks
? "true" : "false"));
95 SMB_ASSERT(brl
->record
!= NULL
); /* otherwise we're readonly */
96 brl
->have_read_oplocks
= have_read_oplocks
;
100 /****************************************************************************
101 See if two locking contexts are equal.
102 ****************************************************************************/
104 static bool brl_same_context(const struct lock_context
*ctx1
,
105 const struct lock_context
*ctx2
)
107 return (serverid_equal(&ctx1
->pid
, &ctx2
->pid
) &&
108 (ctx1
->smblctx
== ctx2
->smblctx
) &&
109 (ctx1
->tid
== ctx2
->tid
));
112 /****************************************************************************
113 See if lck1 and lck2 overlap.
114 ****************************************************************************/
116 static bool brl_overlap(const struct lock_struct
*lck1
,
117 const struct lock_struct
*lck2
)
119 /* XXX Remove for Win7 compatibility. */
120 /* this extra check is not redundant - it copes with locks
121 that go beyond the end of 64 bit file space */
122 if (lck1
->size
!= 0 &&
123 lck1
->start
== lck2
->start
&&
124 lck1
->size
== lck2
->size
) {
128 if (lck1
->start
>= (lck2
->start
+lck2
->size
) ||
129 lck2
->start
>= (lck1
->start
+lck1
->size
)) {
135 /****************************************************************************
136 See if lock2 can be added when lock1 is in place.
137 ****************************************************************************/
139 static bool brl_conflict(const struct lock_struct
*lck1
,
140 const struct lock_struct
*lck2
)
142 /* Ignore PENDING locks. */
143 if (IS_PENDING_LOCK(lck1
->lock_type
) || IS_PENDING_LOCK(lck2
->lock_type
))
146 /* Read locks never conflict. */
147 if (lck1
->lock_type
== READ_LOCK
&& lck2
->lock_type
== READ_LOCK
) {
151 /* A READ lock can stack on top of a WRITE lock if they have the same
153 if (lck1
->lock_type
== WRITE_LOCK
&& lck2
->lock_type
== READ_LOCK
&&
154 brl_same_context(&lck1
->context
, &lck2
->context
) &&
155 lck1
->fnum
== lck2
->fnum
) {
159 return brl_overlap(lck1
, lck2
);
162 /****************************************************************************
163 See if lock2 can be added when lock1 is in place - when both locks are POSIX
164 flavour. POSIX locks ignore fnum - they only care about dev/ino which we
166 ****************************************************************************/
168 static bool brl_conflict_posix(const struct lock_struct
*lck1
,
169 const struct lock_struct
*lck2
)
171 #if defined(DEVELOPER)
172 SMB_ASSERT(lck1
->lock_flav
== POSIX_LOCK
);
173 SMB_ASSERT(lck2
->lock_flav
== POSIX_LOCK
);
176 /* Ignore PENDING locks. */
177 if (IS_PENDING_LOCK(lck1
->lock_type
) || IS_PENDING_LOCK(lck2
->lock_type
))
180 /* Read locks never conflict. */
181 if (lck1
->lock_type
== READ_LOCK
&& lck2
->lock_type
== READ_LOCK
) {
185 /* Locks on the same context don't conflict. Ignore fnum. */
186 if (brl_same_context(&lck1
->context
, &lck2
->context
)) {
190 /* One is read, the other write, or the context is different,
192 return brl_overlap(lck1
, lck2
);
196 static bool brl_conflict1(const struct lock_struct
*lck1
,
197 const struct lock_struct
*lck2
)
199 if (IS_PENDING_LOCK(lck1
->lock_type
) || IS_PENDING_LOCK(lck2
->lock_type
))
202 if (lck1
->lock_type
== READ_LOCK
&& lck2
->lock_type
== READ_LOCK
) {
206 if (brl_same_context(&lck1
->context
, &lck2
->context
) &&
207 lck2
->lock_type
== READ_LOCK
&& lck1
->fnum
== lck2
->fnum
) {
211 if (lck2
->start
== 0 && lck2
->size
== 0 && lck1
->size
!= 0) {
215 if (lck1
->start
>= (lck2
->start
+ lck2
->size
) ||
216 lck2
->start
>= (lck1
->start
+ lck1
->size
)) {
224 /****************************************************************************
225 Check to see if this lock conflicts, but ignore our own locks on the
226 same fnum only. This is the read/write lock check code path.
227 This is never used in the POSIX lock case.
228 ****************************************************************************/
230 static bool brl_conflict_other(const struct lock_struct
*lock
, const struct lock_struct
*lck2
)
232 if (IS_PENDING_LOCK(lock
->lock_type
) || IS_PENDING_LOCK(lck2
->lock_type
))
235 if (lock
->lock_type
== READ_LOCK
&& lck2
->lock_type
== READ_LOCK
)
238 /* POSIX flavour locks never conflict here - this is only called
239 in the read/write path. */
241 if (lock
->lock_flav
== POSIX_LOCK
&& lck2
->lock_flav
== POSIX_LOCK
)
245 * Incoming WRITE locks conflict with existing READ locks even
246 * if the context is the same. JRA. See LOCKTEST7 in smbtorture.
249 if (!(lck2
->lock_type
== WRITE_LOCK
&& lock
->lock_type
== READ_LOCK
)) {
250 if (brl_same_context(&lock
->context
, &lck2
->context
) &&
251 lock
->fnum
== lck2
->fnum
)
255 return brl_overlap(lock
, lck2
);
258 /****************************************************************************
259 Check if an unlock overlaps a pending lock.
260 ****************************************************************************/
262 static bool brl_pending_overlap(const struct lock_struct
*lock
, const struct lock_struct
*pend_lock
)
264 if ((lock
->start
<= pend_lock
->start
) && (lock
->start
+ lock
->size
> pend_lock
->start
))
266 if ((lock
->start
>= pend_lock
->start
) && (lock
->start
< pend_lock
->start
+ pend_lock
->size
))
271 /****************************************************************************
272 Amazingly enough, w2k3 "remembers" whether the last lock failure on a fnum
273 is the same as this one and changes its error code. I wonder if any
274 app depends on this ?
275 ****************************************************************************/
277 static NTSTATUS
brl_lock_failed(files_struct
*fsp
,
278 const struct lock_struct
*lock
,
281 if (lock
->start
>= 0xEF000000 && (lock
->start
>> 63) == 0) {
282 /* amazing the little things you learn with a test
283 suite. Locks beyond this offset (as a 64 bit
284 number!) always generate the conflict error code,
285 unless the top bit is set */
286 if (!blocking_lock
) {
287 fsp
->last_lock_failure
= *lock
;
289 return NT_STATUS_FILE_LOCK_CONFLICT
;
292 if (serverid_equal(&lock
->context
.pid
, &fsp
->last_lock_failure
.context
.pid
) &&
293 lock
->context
.tid
== fsp
->last_lock_failure
.context
.tid
&&
294 lock
->fnum
== fsp
->last_lock_failure
.fnum
&&
295 lock
->start
== fsp
->last_lock_failure
.start
) {
296 return NT_STATUS_FILE_LOCK_CONFLICT
;
299 if (!blocking_lock
) {
300 fsp
->last_lock_failure
= *lock
;
302 return NT_STATUS_LOCK_NOT_GRANTED
;
305 /****************************************************************************
306 Open up the brlock.tdb database.
307 ****************************************************************************/
309 void brl_init(bool read_only
)
317 tdb_flags
= TDB_DEFAULT
|TDB_VOLATILE
|TDB_CLEAR_IF_FIRST
|TDB_INCOMPATIBLE_HASH
;
319 if (!lp_clustering()) {
321 * We can't use the SEQNUM trick to cache brlock
322 * entries in the clustering case because ctdb seqnum
323 * propagation has a delay.
325 tdb_flags
|= TDB_SEQNUM
;
328 brlock_db
= db_open(NULL
, lock_path("brlock.tdb"),
329 SMB_OPEN_DATABASE_TDB_HASH_SIZE
, tdb_flags
,
330 read_only
?O_RDONLY
:(O_RDWR
|O_CREAT
), 0644,
331 DBWRAP_LOCK_ORDER_2
, DBWRAP_FLAG_NONE
);
333 DEBUG(0,("Failed to open byte range locking database %s\n",
334 lock_path("brlock.tdb")));
339 /****************************************************************************
340 Close down the brlock.tdb database.
341 ****************************************************************************/
343 void brl_shutdown(void)
345 TALLOC_FREE(brlock_db
);
349 /****************************************************************************
350 Compare two locks for sorting.
351 ****************************************************************************/
353 static int lock_compare(const struct lock_struct
*lck1
,
354 const struct lock_struct
*lck2
)
356 if (lck1
->start
!= lck2
->start
) {
357 return (lck1
->start
- lck2
->start
);
359 if (lck2
->size
!= lck1
->size
) {
360 return ((int)lck1
->size
- (int)lck2
->size
);
366 /****************************************************************************
367 Lock a range of bytes - Windows lock semantics.
368 ****************************************************************************/
370 NTSTATUS
brl_lock_windows_default(struct byte_range_lock
*br_lck
,
371 struct lock_struct
*plock
, bool blocking_lock
)
374 files_struct
*fsp
= br_lck
->fsp
;
375 struct lock_struct
*locks
= br_lck
->lock_data
;
378 SMB_ASSERT(plock
->lock_type
!= UNLOCK_LOCK
);
380 if ((plock
->start
+ plock
->size
- 1 < plock
->start
) &&
382 return NT_STATUS_INVALID_LOCK_RANGE
;
385 for (i
=0; i
< br_lck
->num_locks
; i
++) {
386 /* Do any Windows or POSIX locks conflict ? */
387 if (brl_conflict(&locks
[i
], plock
)) {
388 /* Remember who blocked us. */
389 plock
->context
.smblctx
= locks
[i
].context
.smblctx
;
390 return brl_lock_failed(fsp
,plock
,blocking_lock
);
393 if (plock
->start
== 0 && plock
->size
== 0 &&
394 locks
[i
].size
== 0) {
400 if (!IS_PENDING_LOCK(plock
->lock_type
)) {
401 contend_level2_oplocks_begin(fsp
, LEVEL2_CONTEND_WINDOWS_BRL
);
404 /* We can get the Windows lock, now see if it needs to
405 be mapped into a lower level POSIX one, and if so can
408 if (!IS_PENDING_LOCK(plock
->lock_type
) && lp_posix_locking(fsp
->conn
->params
)) {
410 if (!set_posix_lock_windows_flavour(fsp
,
419 /* We don't know who blocked us. */
420 plock
->context
.smblctx
= 0xFFFFFFFFFFFFFFFFLL
;
422 if (errno_ret
== EACCES
|| errno_ret
== EAGAIN
) {
423 status
= NT_STATUS_FILE_LOCK_CONFLICT
;
426 status
= map_nt_error_from_unix(errno
);
432 /* no conflicts - add it to the list of locks */
433 locks
= talloc_realloc(br_lck
, locks
, struct lock_struct
,
434 (br_lck
->num_locks
+ 1));
436 status
= NT_STATUS_NO_MEMORY
;
440 memcpy(&locks
[br_lck
->num_locks
], plock
, sizeof(struct lock_struct
));
441 br_lck
->num_locks
+= 1;
442 br_lck
->lock_data
= locks
;
443 br_lck
->modified
= True
;
447 if (!IS_PENDING_LOCK(plock
->lock_type
)) {
448 contend_level2_oplocks_end(fsp
, LEVEL2_CONTEND_WINDOWS_BRL
);
453 /****************************************************************************
454 Cope with POSIX range splits and merges.
455 ****************************************************************************/
457 static unsigned int brlock_posix_split_merge(struct lock_struct
*lck_arr
, /* Output array. */
458 struct lock_struct
*ex
, /* existing lock. */
459 struct lock_struct
*plock
) /* proposed lock. */
461 bool lock_types_differ
= (ex
->lock_type
!= plock
->lock_type
);
463 /* We can't merge non-conflicting locks on different context - ignore fnum. */
465 if (!brl_same_context(&ex
->context
, &plock
->context
)) {
467 memcpy(&lck_arr
[0], ex
, sizeof(struct lock_struct
));
471 /* We now know we have the same context. */
473 /* Did we overlap ? */
475 /*********************************************
486 **********************************************/
488 if ( (ex
->start
> (plock
->start
+ plock
->size
)) ||
489 (plock
->start
> (ex
->start
+ ex
->size
))) {
491 /* No overlap with this lock - copy existing. */
493 memcpy(&lck_arr
[0], ex
, sizeof(struct lock_struct
));
497 /*********************************************
498 +---------------------------+
500 +---------------------------+
501 +---------------------------+
502 | plock | -> replace with plock.
503 +---------------------------+
508 +---------------------------+
509 | plock | -> replace with plock.
510 +---------------------------+
512 **********************************************/
514 if ( (ex
->start
>= plock
->start
) &&
515 (ex
->start
+ ex
->size
<= plock
->start
+ plock
->size
) ) {
517 /* Replace - discard existing lock. */
522 /*********************************************
532 +---------------+-------+
533 | plock | ex | - different lock types.
534 +---------------+-------+
536 +-----------------------+
537 | plock | - same lock type.
538 +-----------------------+
539 **********************************************/
541 if (plock
->start
+ plock
->size
== ex
->start
) {
543 /* If the lock types are the same, we merge, if different, we
544 add the remainder of the old lock. */
546 if (lock_types_differ
) {
548 memcpy(&lck_arr
[0], ex
, sizeof(struct lock_struct
));
551 /* Merge - adjust incoming lock as we may have more
552 * merging to come. */
553 plock
->size
+= ex
->size
;
558 /*********************************************
567 +-------+---------------+
568 | ex | plock | - different lock types
569 +-------+---------------+
572 +-----------------------+
573 | plock | - same lock type.
574 +-----------------------+
576 **********************************************/
578 if (ex
->start
+ ex
->size
== plock
->start
) {
580 /* If the lock types are the same, we merge, if different, we
581 add the existing lock. */
583 if (lock_types_differ
) {
584 memcpy(&lck_arr
[0], ex
, sizeof(struct lock_struct
));
587 /* Merge - adjust incoming lock as we may have more
588 * merging to come. */
589 plock
->start
= ex
->start
;
590 plock
->size
+= ex
->size
;
595 /*********************************************
597 +-----------------------+
599 +-----------------------+
612 +---------------+-------+
613 | plock | ex | - different lock types.
614 +---------------+-------+
616 +-----------------------+
617 | plock | - same lock type.
618 +-----------------------+
619 **********************************************/
621 if ( (ex
->start
>= plock
->start
) &&
622 (ex
->start
<= plock
->start
+ plock
->size
) &&
623 (ex
->start
+ ex
->size
> plock
->start
+ plock
->size
) ) {
625 /* If the lock types are the same, we merge, if different, we
626 add the remainder of the old lock. */
628 if (lock_types_differ
) {
629 /* Add remaining existing. */
630 memcpy(&lck_arr
[0], ex
, sizeof(struct lock_struct
));
631 /* Adjust existing start and size. */
632 lck_arr
[0].start
= plock
->start
+ plock
->size
;
633 lck_arr
[0].size
= (ex
->start
+ ex
->size
) - (plock
->start
+ plock
->size
);
636 /* Merge - adjust incoming lock as we may have more
637 * merging to come. */
638 plock
->size
+= (ex
->start
+ ex
->size
) - (plock
->start
+ plock
->size
);
643 /*********************************************
645 +-----------------------+
647 +-----------------------+
660 +-------+---------------+
661 | ex | plock | - different lock types
662 +-------+---------------+
665 +-----------------------+
666 | plock | - same lock type.
667 +-----------------------+
669 **********************************************/
671 if ( (ex
->start
< plock
->start
) &&
672 (ex
->start
+ ex
->size
>= plock
->start
) &&
673 (ex
->start
+ ex
->size
<= plock
->start
+ plock
->size
) ) {
675 /* If the lock types are the same, we merge, if different, we
676 add the truncated old lock. */
678 if (lock_types_differ
) {
679 memcpy(&lck_arr
[0], ex
, sizeof(struct lock_struct
));
680 /* Adjust existing size. */
681 lck_arr
[0].size
= plock
->start
- ex
->start
;
684 /* Merge - adjust incoming lock as we may have more
685 * merging to come. MUST ADJUST plock SIZE FIRST ! */
686 plock
->size
+= (plock
->start
- ex
->start
);
687 plock
->start
= ex
->start
;
692 /*********************************************
694 +---------------------------+
696 +---------------------------+
701 +-------+---------+---------+
702 | ex | plock | ex | - different lock types.
703 +-------+---------+---------+
705 +---------------------------+
706 | plock | - same lock type.
707 +---------------------------+
708 **********************************************/
710 if ( (ex
->start
< plock
->start
) && (ex
->start
+ ex
->size
> plock
->start
+ plock
->size
) ) {
712 if (lock_types_differ
) {
714 /* We have to split ex into two locks here. */
716 memcpy(&lck_arr
[0], ex
, sizeof(struct lock_struct
));
717 memcpy(&lck_arr
[1], ex
, sizeof(struct lock_struct
));
719 /* Adjust first existing size. */
720 lck_arr
[0].size
= plock
->start
- ex
->start
;
722 /* Adjust second existing start and size. */
723 lck_arr
[1].start
= plock
->start
+ plock
->size
;
724 lck_arr
[1].size
= (ex
->start
+ ex
->size
) - (plock
->start
+ plock
->size
);
727 /* Just eat the existing locks, merge them into plock. */
728 plock
->start
= ex
->start
;
729 plock
->size
= ex
->size
;
734 /* Never get here. */
735 smb_panic("brlock_posix_split_merge");
738 /* Keep some compilers happy. */
742 /****************************************************************************
743 Lock a range of bytes - POSIX lock semantics.
744 We must cope with range splits and merges.
745 ****************************************************************************/
747 static NTSTATUS
brl_lock_posix(struct messaging_context
*msg_ctx
,
748 struct byte_range_lock
*br_lck
,
749 struct lock_struct
*plock
)
751 unsigned int i
, count
, posix_count
;
752 struct lock_struct
*locks
= br_lck
->lock_data
;
753 struct lock_struct
*tp
;
754 bool signal_pending_read
= False
;
755 bool break_oplocks
= false;
758 /* No zero-zero locks for POSIX. */
759 if (plock
->start
== 0 && plock
->size
== 0) {
760 return NT_STATUS_INVALID_PARAMETER
;
763 /* Don't allow 64-bit lock wrap. */
764 if (plock
->start
+ plock
->size
- 1 < plock
->start
) {
765 return NT_STATUS_INVALID_PARAMETER
;
768 /* The worst case scenario here is we have to split an
769 existing POSIX lock range into two, and add our lock,
770 so we need at most 2 more entries. */
772 tp
= talloc_array(br_lck
, struct lock_struct
, br_lck
->num_locks
+ 2);
774 return NT_STATUS_NO_MEMORY
;
777 count
= posix_count
= 0;
779 for (i
=0; i
< br_lck
->num_locks
; i
++) {
780 struct lock_struct
*curr_lock
= &locks
[i
];
782 /* If we have a pending read lock, a lock downgrade should
783 trigger a lock re-evaluation. */
784 if (curr_lock
->lock_type
== PENDING_READ_LOCK
&&
785 brl_pending_overlap(plock
, curr_lock
)) {
786 signal_pending_read
= True
;
789 if (curr_lock
->lock_flav
== WINDOWS_LOCK
) {
790 /* Do any Windows flavour locks conflict ? */
791 if (brl_conflict(curr_lock
, plock
)) {
792 /* No games with error messages. */
794 /* Remember who blocked us. */
795 plock
->context
.smblctx
= curr_lock
->context
.smblctx
;
796 return NT_STATUS_FILE_LOCK_CONFLICT
;
798 /* Just copy the Windows lock into the new array. */
799 memcpy(&tp
[count
], curr_lock
, sizeof(struct lock_struct
));
802 unsigned int tmp_count
= 0;
804 /* POSIX conflict semantics are different. */
805 if (brl_conflict_posix(curr_lock
, plock
)) {
806 /* Can't block ourselves with POSIX locks. */
807 /* No games with error messages. */
809 /* Remember who blocked us. */
810 plock
->context
.smblctx
= curr_lock
->context
.smblctx
;
811 return NT_STATUS_FILE_LOCK_CONFLICT
;
814 /* Work out overlaps. */
815 tmp_count
+= brlock_posix_split_merge(&tp
[count
], curr_lock
, plock
);
816 posix_count
+= tmp_count
;
822 * Break oplocks while we hold a brl. Since lock() and unlock() calls
823 * are not symetric with POSIX semantics, we cannot guarantee our
824 * contend_level2_oplocks_begin/end calls will be acquired and
825 * released one-for-one as with Windows semantics. Therefore we only
826 * call contend_level2_oplocks_begin if this is the first POSIX brl on
829 break_oplocks
= (!IS_PENDING_LOCK(plock
->lock_type
) &&
832 contend_level2_oplocks_begin(br_lck
->fsp
,
833 LEVEL2_CONTEND_POSIX_BRL
);
836 /* Try and add the lock in order, sorted by lock start. */
837 for (i
=0; i
< count
; i
++) {
838 struct lock_struct
*curr_lock
= &tp
[i
];
840 if (curr_lock
->start
<= plock
->start
) {
846 memmove(&tp
[i
+1], &tp
[i
],
847 (count
- i
)*sizeof(struct lock_struct
));
849 memcpy(&tp
[i
], plock
, sizeof(struct lock_struct
));
852 /* We can get the POSIX lock, now see if it needs to
853 be mapped into a lower level POSIX one, and if so can
856 if (!IS_PENDING_LOCK(plock
->lock_type
) && lp_posix_locking(br_lck
->fsp
->conn
->params
)) {
859 /* The lower layer just needs to attempt to
860 get the system POSIX lock. We've weeded out
861 any conflicts above. */
863 if (!set_posix_lock_posix_flavour(br_lck
->fsp
,
869 /* We don't know who blocked us. */
870 plock
->context
.smblctx
= 0xFFFFFFFFFFFFFFFFLL
;
872 if (errno_ret
== EACCES
|| errno_ret
== EAGAIN
) {
874 status
= NT_STATUS_FILE_LOCK_CONFLICT
;
878 status
= map_nt_error_from_unix(errno
);
884 /* If we didn't use all the allocated size,
885 * Realloc so we don't leak entries per lock call. */
886 if (count
< br_lck
->num_locks
+ 2) {
887 tp
= talloc_realloc(br_lck
, tp
, struct lock_struct
, count
);
889 status
= NT_STATUS_NO_MEMORY
;
894 br_lck
->num_locks
= count
;
895 TALLOC_FREE(br_lck
->lock_data
);
896 br_lck
->lock_data
= tp
;
898 br_lck
->modified
= True
;
900 /* A successful downgrade from write to read lock can trigger a lock
901 re-evalutation where waiting readers can now proceed. */
903 if (signal_pending_read
) {
904 /* Send unlock messages to any pending read waiters that overlap. */
905 for (i
=0; i
< br_lck
->num_locks
; i
++) {
906 struct lock_struct
*pend_lock
= &locks
[i
];
908 /* Ignore non-pending locks. */
909 if (!IS_PENDING_LOCK(pend_lock
->lock_type
)) {
913 if (pend_lock
->lock_type
== PENDING_READ_LOCK
&&
914 brl_pending_overlap(plock
, pend_lock
)) {
915 DEBUG(10,("brl_lock_posix: sending unlock message to pid %s\n",
916 procid_str_static(&pend_lock
->context
.pid
)));
918 messaging_send(msg_ctx
, pend_lock
->context
.pid
,
919 MSG_SMB_UNLOCK
, &data_blob_null
);
927 contend_level2_oplocks_end(br_lck
->fsp
,
928 LEVEL2_CONTEND_POSIX_BRL
);
933 NTSTATUS
smb_vfs_call_brl_lock_windows(struct vfs_handle_struct
*handle
,
934 struct byte_range_lock
*br_lck
,
935 struct lock_struct
*plock
,
938 VFS_FIND(brl_lock_windows
);
939 return handle
->fns
->brl_lock_windows_fn(handle
, br_lck
, plock
,
943 /****************************************************************************
944 Lock a range of bytes.
945 ****************************************************************************/
947 NTSTATUS
brl_lock(struct messaging_context
*msg_ctx
,
948 struct byte_range_lock
*br_lck
,
950 struct server_id pid
,
953 enum brl_type lock_type
,
954 enum brl_flavour lock_flav
,
959 struct lock_struct lock
;
962 if (start
== 0 && size
== 0) {
963 DEBUG(0,("client sent 0/0 lock - please report this\n"));
967 lock
= (struct lock_struct
) {
968 .context
.smblctx
= smblctx
,
970 .context
.tid
= br_lck
->fsp
->conn
->cnum
,
973 .fnum
= br_lck
->fsp
->fnum
,
974 .lock_type
= lock_type
,
975 .lock_flav
= lock_flav
978 if (lock_flav
== WINDOWS_LOCK
) {
979 ret
= SMB_VFS_BRL_LOCK_WINDOWS(br_lck
->fsp
->conn
, br_lck
,
980 &lock
, blocking_lock
);
982 ret
= brl_lock_posix(msg_ctx
, br_lck
, &lock
);
986 /* sort the lock list */
987 TYPESAFE_QSORT(br_lck
->lock_data
, (size_t)br_lck
->num_locks
, lock_compare
);
990 /* If we're returning an error, return who blocked us. */
991 if (!NT_STATUS_IS_OK(ret
) && psmblctx
) {
992 *psmblctx
= lock
.context
.smblctx
;
997 static void brl_delete_lock_struct(struct lock_struct
*locks
,
1001 if (del_idx
>= num_locks
) {
1004 memmove(&locks
[del_idx
], &locks
[del_idx
+1],
1005 sizeof(*locks
) * (num_locks
- del_idx
- 1));
1008 /****************************************************************************
1009 Unlock a range of bytes - Windows semantics.
1010 ****************************************************************************/
1012 bool brl_unlock_windows_default(struct messaging_context
*msg_ctx
,
1013 struct byte_range_lock
*br_lck
,
1014 const struct lock_struct
*plock
)
1017 struct lock_struct
*locks
= br_lck
->lock_data
;
1018 enum brl_type deleted_lock_type
= READ_LOCK
; /* shut the compiler up.... */
1020 SMB_ASSERT(plock
->lock_type
== UNLOCK_LOCK
);
1023 /* Delete write locks by preference... The lock list
1024 is sorted in the zero zero case. */
1026 for (i
= 0; i
< br_lck
->num_locks
; i
++) {
1027 struct lock_struct
*lock
= &locks
[i
];
1029 if (lock
->lock_type
== WRITE_LOCK
&&
1030 brl_same_context(&lock
->context
, &plock
->context
) &&
1031 lock
->fnum
== plock
->fnum
&&
1032 lock
->lock_flav
== WINDOWS_LOCK
&&
1033 lock
->start
== plock
->start
&&
1034 lock
->size
== plock
->size
) {
1036 /* found it - delete it */
1037 deleted_lock_type
= lock
->lock_type
;
1042 if (i
!= br_lck
->num_locks
) {
1043 /* We found it - don't search again. */
1044 goto unlock_continue
;
1048 for (i
= 0; i
< br_lck
->num_locks
; i
++) {
1049 struct lock_struct
*lock
= &locks
[i
];
1051 if (IS_PENDING_LOCK(lock
->lock_type
)) {
1055 /* Only remove our own locks that match in start, size, and flavour. */
1056 if (brl_same_context(&lock
->context
, &plock
->context
) &&
1057 lock
->fnum
== plock
->fnum
&&
1058 lock
->lock_flav
== WINDOWS_LOCK
&&
1059 lock
->start
== plock
->start
&&
1060 lock
->size
== plock
->size
) {
1061 deleted_lock_type
= lock
->lock_type
;
1066 if (i
== br_lck
->num_locks
) {
1067 /* we didn't find it */
1075 brl_delete_lock_struct(locks
, br_lck
->num_locks
, i
);
1076 br_lck
->num_locks
-= 1;
1077 br_lck
->modified
= True
;
1079 /* Unlock the underlying POSIX regions. */
1080 if(lp_posix_locking(br_lck
->fsp
->conn
->params
)) {
1081 release_posix_lock_windows_flavour(br_lck
->fsp
,
1090 /* Send unlock messages to any pending waiters that overlap. */
1091 for (j
=0; j
< br_lck
->num_locks
; j
++) {
1092 struct lock_struct
*pend_lock
= &locks
[j
];
1094 /* Ignore non-pending locks. */
1095 if (!IS_PENDING_LOCK(pend_lock
->lock_type
)) {
1099 /* We could send specific lock info here... */
1100 if (brl_pending_overlap(plock
, pend_lock
)) {
1101 DEBUG(10,("brl_unlock: sending unlock message to pid %s\n",
1102 procid_str_static(&pend_lock
->context
.pid
)));
1104 messaging_send(msg_ctx
, pend_lock
->context
.pid
,
1105 MSG_SMB_UNLOCK
, &data_blob_null
);
1109 contend_level2_oplocks_end(br_lck
->fsp
, LEVEL2_CONTEND_WINDOWS_BRL
);
1113 /****************************************************************************
1114 Unlock a range of bytes - POSIX semantics.
1115 ****************************************************************************/
1117 static bool brl_unlock_posix(struct messaging_context
*msg_ctx
,
1118 struct byte_range_lock
*br_lck
,
1119 struct lock_struct
*plock
)
1121 unsigned int i
, j
, count
;
1122 struct lock_struct
*tp
;
1123 struct lock_struct
*locks
= br_lck
->lock_data
;
1124 bool overlap_found
= False
;
1126 /* No zero-zero locks for POSIX. */
1127 if (plock
->start
== 0 && plock
->size
== 0) {
1131 /* Don't allow 64-bit lock wrap. */
1132 if (plock
->start
+ plock
->size
< plock
->start
||
1133 plock
->start
+ plock
->size
< plock
->size
) {
1134 DEBUG(10,("brl_unlock_posix: lock wrap\n"));
1138 /* The worst case scenario here is we have to split an
1139 existing POSIX lock range into two, so we need at most
1142 tp
= talloc_array(br_lck
, struct lock_struct
, br_lck
->num_locks
+ 1);
1144 DEBUG(10,("brl_unlock_posix: malloc fail\n"));
1149 for (i
= 0; i
< br_lck
->num_locks
; i
++) {
1150 struct lock_struct
*lock
= &locks
[i
];
1151 unsigned int tmp_count
;
1153 /* Only remove our own locks - ignore fnum. */
1154 if (IS_PENDING_LOCK(lock
->lock_type
) ||
1155 !brl_same_context(&lock
->context
, &plock
->context
)) {
1156 memcpy(&tp
[count
], lock
, sizeof(struct lock_struct
));
1161 if (lock
->lock_flav
== WINDOWS_LOCK
) {
1162 /* Do any Windows flavour locks conflict ? */
1163 if (brl_conflict(lock
, plock
)) {
1167 /* Just copy the Windows lock into the new array. */
1168 memcpy(&tp
[count
], lock
, sizeof(struct lock_struct
));
1173 /* Work out overlaps. */
1174 tmp_count
= brlock_posix_split_merge(&tp
[count
], lock
, plock
);
1176 if (tmp_count
== 0) {
1177 /* plock overlapped the existing lock completely,
1178 or replaced it. Don't copy the existing lock. */
1179 overlap_found
= true;
1180 } else if (tmp_count
== 1) {
1181 /* Either no overlap, (simple copy of existing lock) or
1182 * an overlap of an existing lock. */
1183 /* If the lock changed size, we had an overlap. */
1184 if (tp
[count
].size
!= lock
->size
) {
1185 overlap_found
= true;
1188 } else if (tmp_count
== 2) {
1189 /* We split a lock range in two. */
1190 overlap_found
= true;
1193 /* Optimisation... */
1194 /* We know we're finished here as we can't overlap any
1195 more POSIX locks. Copy the rest of the lock array. */
1197 if (i
< br_lck
->num_locks
- 1) {
1198 memcpy(&tp
[count
], &locks
[i
+1],
1199 sizeof(*locks
)*((br_lck
->num_locks
-1) - i
));
1200 count
+= ((br_lck
->num_locks
-1) - i
);
1207 if (!overlap_found
) {
1208 /* Just ignore - no change. */
1210 DEBUG(10,("brl_unlock_posix: No overlap - unlocked.\n"));
1214 /* Unlock any POSIX regions. */
1215 if(lp_posix_locking(br_lck
->fsp
->conn
->params
)) {
1216 release_posix_lock_posix_flavour(br_lck
->fsp
,
1224 /* Realloc so we don't leak entries per unlock call. */
1226 tp
= talloc_realloc(br_lck
, tp
, struct lock_struct
, count
);
1228 DEBUG(10,("brl_unlock_posix: realloc fail\n"));
1232 /* We deleted the last lock. */
1237 contend_level2_oplocks_end(br_lck
->fsp
,
1238 LEVEL2_CONTEND_POSIX_BRL
);
1240 br_lck
->num_locks
= count
;
1241 TALLOC_FREE(br_lck
->lock_data
);
1243 br_lck
->lock_data
= tp
;
1244 br_lck
->modified
= True
;
1246 /* Send unlock messages to any pending waiters that overlap. */
1248 for (j
=0; j
< br_lck
->num_locks
; j
++) {
1249 struct lock_struct
*pend_lock
= &locks
[j
];
1251 /* Ignore non-pending locks. */
1252 if (!IS_PENDING_LOCK(pend_lock
->lock_type
)) {
1256 /* We could send specific lock info here... */
1257 if (brl_pending_overlap(plock
, pend_lock
)) {
1258 DEBUG(10,("brl_unlock: sending unlock message to pid %s\n",
1259 procid_str_static(&pend_lock
->context
.pid
)));
1261 messaging_send(msg_ctx
, pend_lock
->context
.pid
,
1262 MSG_SMB_UNLOCK
, &data_blob_null
);
1269 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct
*handle
,
1270 struct messaging_context
*msg_ctx
,
1271 struct byte_range_lock
*br_lck
,
1272 const struct lock_struct
*plock
)
1274 VFS_FIND(brl_unlock_windows
);
1275 return handle
->fns
->brl_unlock_windows_fn(handle
, msg_ctx
, br_lck
,
1279 /****************************************************************************
1280 Unlock a range of bytes.
1281 ****************************************************************************/
1283 bool brl_unlock(struct messaging_context
*msg_ctx
,
1284 struct byte_range_lock
*br_lck
,
1286 struct server_id pid
,
1289 enum brl_flavour lock_flav
)
1291 struct lock_struct lock
;
1293 lock
.context
.smblctx
= smblctx
;
1294 lock
.context
.pid
= pid
;
1295 lock
.context
.tid
= br_lck
->fsp
->conn
->cnum
;
1298 lock
.fnum
= br_lck
->fsp
->fnum
;
1299 lock
.lock_type
= UNLOCK_LOCK
;
1300 lock
.lock_flav
= lock_flav
;
1302 if (lock_flav
== WINDOWS_LOCK
) {
1303 return SMB_VFS_BRL_UNLOCK_WINDOWS(br_lck
->fsp
->conn
, msg_ctx
,
1306 return brl_unlock_posix(msg_ctx
, br_lck
, &lock
);
1310 /****************************************************************************
1311 Test if we could add a lock if we wanted to.
1312 Returns True if the region required is currently unlocked, False if locked.
1313 ****************************************************************************/
1315 bool brl_locktest(struct byte_range_lock
*br_lck
,
1317 struct server_id pid
,
1320 enum brl_type lock_type
,
1321 enum brl_flavour lock_flav
)
1325 struct lock_struct lock
;
1326 const struct lock_struct
*locks
= br_lck
->lock_data
;
1327 files_struct
*fsp
= br_lck
->fsp
;
1329 lock
.context
.smblctx
= smblctx
;
1330 lock
.context
.pid
= pid
;
1331 lock
.context
.tid
= br_lck
->fsp
->conn
->cnum
;
1334 lock
.fnum
= fsp
->fnum
;
1335 lock
.lock_type
= lock_type
;
1336 lock
.lock_flav
= lock_flav
;
1338 /* Make sure existing locks don't conflict */
1339 for (i
=0; i
< br_lck
->num_locks
; i
++) {
1341 * Our own locks don't conflict.
1343 if (brl_conflict_other(&locks
[i
], &lock
)) {
1349 * There is no lock held by an SMB daemon, check to
1350 * see if there is a POSIX lock from a UNIX or NFS process.
1351 * This only conflicts with Windows locks, not POSIX locks.
1354 if(lp_posix_locking(fsp
->conn
->params
) && (lock_flav
== WINDOWS_LOCK
)) {
1355 ret
= is_posix_locked(fsp
, &start
, &size
, &lock_type
, WINDOWS_LOCK
);
1357 DEBUG(10, ("brl_locktest: posix start=%ju len=%ju %s for %s "
1358 "file %s\n", (uintmax_t)start
, (uintmax_t)size
,
1359 ret
? "locked" : "unlocked",
1360 fsp_fnum_dbg(fsp
), fsp_str_dbg(fsp
)));
1362 /* We need to return the inverse of is_posix_locked. */
1366 /* no conflicts - we could have added it */
1370 /****************************************************************************
1371 Query for existing locks.
1372 ****************************************************************************/
1374 NTSTATUS
brl_lockquery(struct byte_range_lock
*br_lck
,
1376 struct server_id pid
,
1379 enum brl_type
*plock_type
,
1380 enum brl_flavour lock_flav
)
1383 struct lock_struct lock
;
1384 const struct lock_struct
*locks
= br_lck
->lock_data
;
1385 files_struct
*fsp
= br_lck
->fsp
;
1387 lock
.context
.smblctx
= *psmblctx
;
1388 lock
.context
.pid
= pid
;
1389 lock
.context
.tid
= br_lck
->fsp
->conn
->cnum
;
1390 lock
.start
= *pstart
;
1392 lock
.fnum
= fsp
->fnum
;
1393 lock
.lock_type
= *plock_type
;
1394 lock
.lock_flav
= lock_flav
;
1396 /* Make sure existing locks don't conflict */
1397 for (i
=0; i
< br_lck
->num_locks
; i
++) {
1398 const struct lock_struct
*exlock
= &locks
[i
];
1399 bool conflict
= False
;
1401 if (exlock
->lock_flav
== WINDOWS_LOCK
) {
1402 conflict
= brl_conflict(exlock
, &lock
);
1404 conflict
= brl_conflict_posix(exlock
, &lock
);
1408 *psmblctx
= exlock
->context
.smblctx
;
1409 *pstart
= exlock
->start
;
1410 *psize
= exlock
->size
;
1411 *plock_type
= exlock
->lock_type
;
1412 return NT_STATUS_LOCK_NOT_GRANTED
;
1417 * There is no lock held by an SMB daemon, check to
1418 * see if there is a POSIX lock from a UNIX or NFS process.
1421 if(lp_posix_locking(fsp
->conn
->params
)) {
1422 bool ret
= is_posix_locked(fsp
, pstart
, psize
, plock_type
, POSIX_LOCK
);
1424 DEBUG(10, ("brl_lockquery: posix start=%ju len=%ju %s for %s "
1425 "file %s\n", (uintmax_t)*pstart
,
1426 (uintmax_t)*psize
, ret
? "locked" : "unlocked",
1427 fsp_fnum_dbg(fsp
), fsp_str_dbg(fsp
)));
1430 /* Hmmm. No clue what to set smblctx to - use -1. */
1431 *psmblctx
= 0xFFFFFFFFFFFFFFFFLL
;
1432 return NT_STATUS_LOCK_NOT_GRANTED
;
1436 return NT_STATUS_OK
;
1440 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct
*handle
,
1441 struct byte_range_lock
*br_lck
,
1442 struct lock_struct
*plock
)
1444 VFS_FIND(brl_cancel_windows
);
1445 return handle
->fns
->brl_cancel_windows_fn(handle
, br_lck
, plock
);
1448 /****************************************************************************
1449 Remove a particular pending lock.
1450 ****************************************************************************/
1451 bool brl_lock_cancel(struct byte_range_lock
*br_lck
,
1453 struct server_id pid
,
1456 enum brl_flavour lock_flav
)
1459 struct lock_struct lock
;
1461 lock
.context
.smblctx
= smblctx
;
1462 lock
.context
.pid
= pid
;
1463 lock
.context
.tid
= br_lck
->fsp
->conn
->cnum
;
1466 lock
.fnum
= br_lck
->fsp
->fnum
;
1467 lock
.lock_flav
= lock_flav
;
1468 /* lock.lock_type doesn't matter */
1470 if (lock_flav
== WINDOWS_LOCK
) {
1471 ret
= SMB_VFS_BRL_CANCEL_WINDOWS(br_lck
->fsp
->conn
, br_lck
,
1474 ret
= brl_lock_cancel_default(br_lck
, &lock
);
1480 bool brl_lock_cancel_default(struct byte_range_lock
*br_lck
,
1481 struct lock_struct
*plock
)
1484 struct lock_struct
*locks
= br_lck
->lock_data
;
1488 for (i
= 0; i
< br_lck
->num_locks
; i
++) {
1489 struct lock_struct
*lock
= &locks
[i
];
1491 /* For pending locks we *always* care about the fnum. */
1492 if (brl_same_context(&lock
->context
, &plock
->context
) &&
1493 lock
->fnum
== plock
->fnum
&&
1494 IS_PENDING_LOCK(lock
->lock_type
) &&
1495 lock
->lock_flav
== plock
->lock_flav
&&
1496 lock
->start
== plock
->start
&&
1497 lock
->size
== plock
->size
) {
1502 if (i
== br_lck
->num_locks
) {
1503 /* Didn't find it. */
1507 brl_delete_lock_struct(locks
, br_lck
->num_locks
, i
);
1508 br_lck
->num_locks
-= 1;
1509 br_lck
->modified
= True
;
1513 /****************************************************************************
1514 Remove any locks associated with a open file.
1515 We return True if this process owns any other Windows locks on this
1516 fd and so we should not immediately close the fd.
1517 ****************************************************************************/
1519 void brl_close_fnum(struct messaging_context
*msg_ctx
,
1520 struct byte_range_lock
*br_lck
)
1522 files_struct
*fsp
= br_lck
->fsp
;
1523 uint32_t tid
= fsp
->conn
->cnum
;
1524 uint64_t fnum
= fsp
->fnum
;
1526 struct lock_struct
*locks
= br_lck
->lock_data
;
1527 struct server_id pid
= messaging_server_id(fsp
->conn
->sconn
->msg_ctx
);
1528 struct lock_struct
*locks_copy
;
1529 unsigned int num_locks_copy
;
1531 /* Copy the current lock array. */
1532 if (br_lck
->num_locks
) {
1533 locks_copy
= (struct lock_struct
*)talloc_memdup(br_lck
, locks
, br_lck
->num_locks
* sizeof(struct lock_struct
));
1535 smb_panic("brl_close_fnum: talloc failed");
1541 num_locks_copy
= br_lck
->num_locks
;
1543 for (i
=0; i
< num_locks_copy
; i
++) {
1544 struct lock_struct
*lock
= &locks_copy
[i
];
1546 if (lock
->context
.tid
== tid
&& serverid_equal(&lock
->context
.pid
, &pid
) &&
1547 (lock
->fnum
== fnum
)) {
1550 lock
->context
.smblctx
,
1559 bool brl_mark_disconnected(struct files_struct
*fsp
)
1561 uint32_t tid
= fsp
->conn
->cnum
;
1563 uint64_t fnum
= fsp
->fnum
;
1565 struct server_id self
= messaging_server_id(fsp
->conn
->sconn
->msg_ctx
);
1566 struct byte_range_lock
*br_lck
= NULL
;
1568 if (fsp
->op
== NULL
) {
1572 smblctx
= fsp
->op
->global
->open_persistent_id
;
1574 if (!fsp
->op
->global
->durable
) {
1578 if (fsp
->current_lock_count
== 0) {
1582 br_lck
= brl_get_locks(talloc_tos(), fsp
);
1583 if (br_lck
== NULL
) {
1587 for (i
=0; i
< br_lck
->num_locks
; i
++) {
1588 struct lock_struct
*lock
= &br_lck
->lock_data
[i
];
1591 * as this is a durable handle, we only expect locks
1592 * of the current file handle!
1595 if (lock
->context
.smblctx
!= smblctx
) {
1596 TALLOC_FREE(br_lck
);
1600 if (lock
->context
.tid
!= tid
) {
1601 TALLOC_FREE(br_lck
);
1605 if (!serverid_equal(&lock
->context
.pid
, &self
)) {
1606 TALLOC_FREE(br_lck
);
1610 if (lock
->fnum
!= fnum
) {
1611 TALLOC_FREE(br_lck
);
1615 server_id_set_disconnected(&lock
->context
.pid
);
1616 lock
->context
.tid
= TID_FIELD_INVALID
;
1617 lock
->fnum
= FNUM_FIELD_INVALID
;
1620 br_lck
->modified
= true;
1621 TALLOC_FREE(br_lck
);
1625 bool brl_reconnect_disconnected(struct files_struct
*fsp
)
1627 uint32_t tid
= fsp
->conn
->cnum
;
1629 uint64_t fnum
= fsp
->fnum
;
1631 struct server_id self
= messaging_server_id(fsp
->conn
->sconn
->msg_ctx
);
1632 struct byte_range_lock
*br_lck
= NULL
;
1634 if (fsp
->op
== NULL
) {
1638 smblctx
= fsp
->op
->global
->open_persistent_id
;
1640 if (!fsp
->op
->global
->durable
) {
1645 * When reconnecting, we do not want to validate the brlock entries
1646 * and thereby remove our own (disconnected) entries but reactivate
1649 fsp
->lockdb_clean
= true;
1651 br_lck
= brl_get_locks(talloc_tos(), fsp
);
1652 if (br_lck
== NULL
) {
1656 if (br_lck
->num_locks
== 0) {
1657 TALLOC_FREE(br_lck
);
1661 for (i
=0; i
< br_lck
->num_locks
; i
++) {
1662 struct lock_struct
*lock
= &br_lck
->lock_data
[i
];
1665 * as this is a durable handle we only expect locks
1666 * of the current file handle!
1669 if (lock
->context
.smblctx
!= smblctx
) {
1670 TALLOC_FREE(br_lck
);
1674 if (lock
->context
.tid
!= TID_FIELD_INVALID
) {
1675 TALLOC_FREE(br_lck
);
1679 if (!server_id_is_disconnected(&lock
->context
.pid
)) {
1680 TALLOC_FREE(br_lck
);
1684 if (lock
->fnum
!= FNUM_FIELD_INVALID
) {
1685 TALLOC_FREE(br_lck
);
1689 lock
->context
.pid
= self
;
1690 lock
->context
.tid
= tid
;
1694 fsp
->current_lock_count
= br_lck
->num_locks
;
1695 br_lck
->modified
= true;
1696 TALLOC_FREE(br_lck
);
1700 /****************************************************************************
1701 Ensure this set of lock entries is valid.
1702 ****************************************************************************/
1703 static bool validate_lock_entries(unsigned int *pnum_entries
, struct lock_struct
**pplocks
,
1704 bool keep_disconnected
)
1707 struct lock_struct
*locks
= *pplocks
;
1708 unsigned int num_entries
= *pnum_entries
;
1710 struct server_id
*ids
;
1713 if (num_entries
== 0) {
1717 frame
= talloc_stackframe();
1719 ids
= talloc_array(frame
, struct server_id
, num_entries
);
1721 DEBUG(0, ("validate_lock_entries: "
1722 "talloc_array(struct server_id, %u) failed\n",
1728 exists
= talloc_array(frame
, bool, num_entries
);
1729 if (exists
== NULL
) {
1730 DEBUG(0, ("validate_lock_entries: "
1731 "talloc_array(bool, %u) failed\n",
1737 for (i
= 0; i
< num_entries
; i
++) {
1738 ids
[i
] = locks
[i
].context
.pid
;
1741 if (!serverids_exist(ids
, num_entries
, exists
)) {
1742 DEBUG(3, ("validate_lock_entries: serverids_exists failed\n"));
1749 while (i
< num_entries
) {
1755 if (keep_disconnected
&&
1756 server_id_is_disconnected(&ids
[i
]))
1762 /* This process no longer exists */
1764 brl_delete_lock_struct(locks
, num_entries
, i
);
1769 *pnum_entries
= num_entries
;
1774 struct brl_forall_cb
{
1775 void (*fn
)(struct file_id id
, struct server_id pid
,
1776 enum brl_type lock_type
,
1777 enum brl_flavour lock_flav
,
1778 br_off start
, br_off size
,
1779 void *private_data
);
1783 /****************************************************************************
1784 Traverse the whole database with this function, calling traverse_callback
1786 ****************************************************************************/
1788 static int brl_traverse_fn(struct db_record
*rec
, void *state
)
1790 struct brl_forall_cb
*cb
= (struct brl_forall_cb
*)state
;
1791 struct lock_struct
*locks
;
1792 struct file_id
*key
;
1794 unsigned int num_locks
= 0;
1795 unsigned int orig_num_locks
= 0;
1799 dbkey
= dbwrap_record_get_key(rec
);
1800 value
= dbwrap_record_get_value(rec
);
1802 /* In a traverse function we must make a copy of
1803 dbuf before modifying it. */
1805 locks
= (struct lock_struct
*)talloc_memdup(
1806 talloc_tos(), value
.dptr
, value
.dsize
);
1808 return -1; /* Terminate traversal. */
1811 key
= (struct file_id
*)dbkey
.dptr
;
1812 orig_num_locks
= num_locks
= value
.dsize
/sizeof(*locks
);
1814 /* Ensure the lock db is clean of entries from invalid processes. */
1816 if (!validate_lock_entries(&num_locks
, &locks
, true)) {
1818 return -1; /* Terminate traversal */
1821 if (orig_num_locks
!= num_locks
) {
1824 data
.dptr
= (uint8_t *)locks
;
1825 data
.dsize
= num_locks
*sizeof(struct lock_struct
);
1826 dbwrap_record_store(rec
, data
, TDB_REPLACE
);
1828 dbwrap_record_delete(rec
);
1833 for ( i
=0; i
<num_locks
; i
++) {
1835 locks
[i
].context
.pid
,
1848 /*******************************************************************
1849 Call the specified function on each lock in the database.
1850 ********************************************************************/
1852 int brl_forall(void (*fn
)(struct file_id id
, struct server_id pid
,
1853 enum brl_type lock_type
,
1854 enum brl_flavour lock_flav
,
1855 br_off start
, br_off size
,
1856 void *private_data
),
1859 struct brl_forall_cb cb
;
1867 cb
.private_data
= private_data
;
1868 status
= dbwrap_traverse(brlock_db
, brl_traverse_fn
, &cb
, &count
);
1870 if (!NT_STATUS_IS_OK(status
)) {
1877 /*******************************************************************
1878 Store a potentially modified set of byte range lock data back into
1881 ********************************************************************/
1883 static void byte_range_lock_flush(struct byte_range_lock
*br_lck
)
1886 if (!br_lck
->modified
) {
1887 DEBUG(10, ("br_lck not modified\n"));
1891 data_len
= br_lck
->num_locks
* sizeof(struct lock_struct
);
1893 if (br_lck
->have_read_oplocks
) {
1897 DEBUG(10, ("data_len=%d\n", (int)data_len
));
1899 if (data_len
== 0) {
1900 /* No locks - delete this entry. */
1901 NTSTATUS status
= dbwrap_record_delete(br_lck
->record
);
1902 if (!NT_STATUS_IS_OK(status
)) {
1903 DEBUG(0, ("delete_rec returned %s\n",
1904 nt_errstr(status
)));
1905 smb_panic("Could not delete byte range lock entry");
1911 data
.dsize
= data_len
;
1912 data
.dptr
= talloc_array(talloc_tos(), uint8_t, data_len
);
1913 SMB_ASSERT(data
.dptr
!= NULL
);
1915 memcpy(data
.dptr
, br_lck
->lock_data
,
1916 br_lck
->num_locks
* sizeof(struct lock_struct
));
1918 if (br_lck
->have_read_oplocks
) {
1919 data
.dptr
[data_len
-1] = 1;
1922 status
= dbwrap_record_store(br_lck
->record
, data
, TDB_REPLACE
);
1923 TALLOC_FREE(data
.dptr
);
1924 if (!NT_STATUS_IS_OK(status
)) {
1925 DEBUG(0, ("store returned %s\n", nt_errstr(status
)));
1926 smb_panic("Could not store byte range mode entry");
1930 DEBUG(10, ("seqnum=%d\n", dbwrap_get_seqnum(brlock_db
)));
1933 br_lck
->modified
= false;
1934 TALLOC_FREE(br_lck
->record
);
1937 static int byte_range_lock_destructor(struct byte_range_lock
*br_lck
)
1939 byte_range_lock_flush(br_lck
);
1943 /*******************************************************************
1944 Fetch a set of byte range lock data from the database.
1945 Leave the record locked.
1946 TALLOC_FREE(brl) will release the lock in the destructor.
1947 ********************************************************************/
1949 struct byte_range_lock
*brl_get_locks(TALLOC_CTX
*mem_ctx
, files_struct
*fsp
)
1952 struct byte_range_lock
*br_lck
= talloc(mem_ctx
, struct byte_range_lock
);
1954 if (br_lck
== NULL
) {
1959 br_lck
->num_locks
= 0;
1960 br_lck
->have_read_oplocks
= false;
1961 br_lck
->modified
= False
;
1963 key
.dptr
= (uint8
*)&fsp
->file_id
;
1964 key
.dsize
= sizeof(struct file_id
);
1966 br_lck
->record
= dbwrap_fetch_locked(brlock_db
, br_lck
, key
);
1968 if (br_lck
->record
== NULL
) {
1969 DEBUG(3, ("Could not lock byte range lock entry\n"));
1970 TALLOC_FREE(br_lck
);
1974 data
= dbwrap_record_get_value(br_lck
->record
);
1976 br_lck
->lock_data
= NULL
;
1978 talloc_set_destructor(br_lck
, byte_range_lock_destructor
);
1980 br_lck
->num_locks
= data
.dsize
/ sizeof(struct lock_struct
);
1982 if (br_lck
->num_locks
!= 0) {
1983 br_lck
->lock_data
= talloc_array(
1984 br_lck
, struct lock_struct
, br_lck
->num_locks
);
1985 if (br_lck
->lock_data
== NULL
) {
1986 DEBUG(0, ("malloc failed\n"));
1987 TALLOC_FREE(br_lck
);
1991 memcpy(br_lck
->lock_data
, data
.dptr
,
1992 talloc_get_size(br_lck
->lock_data
));
1995 DEBUG(10, ("data.dsize=%d\n", (int)data
.dsize
));
1997 if ((data
.dsize
% sizeof(struct lock_struct
)) == 1) {
1998 br_lck
->have_read_oplocks
= (data
.dptr
[data
.dsize
-1] == 1);
2001 if (!fsp
->lockdb_clean
) {
2002 int orig_num_locks
= br_lck
->num_locks
;
2005 * This is the first time we access the byte range lock
2006 * record with this fsp. Go through and ensure all entries
2007 * are valid - remove any that don't.
2008 * This makes the lockdb self cleaning at low cost.
2010 * Note: Disconnected entries belong to disconnected
2011 * durable handles. So at this point, we have a new
2012 * handle on the file and the disconnected durable has
2013 * already been closed (we are not a durable reconnect).
2014 * So we need to clean the disconnected brl entry.
2017 if (!validate_lock_entries(&br_lck
->num_locks
,
2018 &br_lck
->lock_data
, false)) {
2019 TALLOC_FREE(br_lck
);
2023 /* Ensure invalid locks are cleaned up in the destructor. */
2024 if (orig_num_locks
!= br_lck
->num_locks
) {
2025 br_lck
->modified
= True
;
2028 /* Mark the lockdb as "clean" as seen from this open file. */
2029 fsp
->lockdb_clean
= True
;
2032 if (DEBUGLEVEL
>= 10) {
2034 struct lock_struct
*locks
= br_lck
->lock_data
;
2035 DEBUG(10,("brl_get_locks_internal: %u current locks on file_id %s\n",
2037 file_id_string_tos(&fsp
->file_id
)));
2038 for( i
= 0; i
< br_lck
->num_locks
; i
++) {
2039 print_lock_struct(i
, &locks
[i
]);
2046 struct brl_get_locks_readonly_state
{
2047 TALLOC_CTX
*mem_ctx
;
2048 struct byte_range_lock
**br_lock
;
2051 static void brl_get_locks_readonly_parser(TDB_DATA key
, TDB_DATA data
,
2054 struct brl_get_locks_readonly_state
*state
=
2055 (struct brl_get_locks_readonly_state
*)private_data
;
2056 struct byte_range_lock
*br_lock
;
2058 br_lock
= talloc_pooled_object(
2059 state
->mem_ctx
, struct byte_range_lock
, 1, data
.dsize
);
2060 if (br_lock
== NULL
) {
2061 *state
->br_lock
= NULL
;
2064 br_lock
->lock_data
= (struct lock_struct
*)talloc_memdup(
2065 br_lock
, data
.dptr
, data
.dsize
);
2066 br_lock
->num_locks
= data
.dsize
/ sizeof(struct lock_struct
);
2068 if ((data
.dsize
% sizeof(struct lock_struct
)) == 1) {
2069 br_lock
->have_read_oplocks
= (data
.dptr
[data
.dsize
-1] == 1);
2071 br_lock
->have_read_oplocks
= false;
2074 DEBUG(10, ("Got %d bytes, have_read_oplocks: %s\n", (int)data
.dsize
,
2075 br_lock
->have_read_oplocks
? "true" : "false"));
2077 *state
->br_lock
= br_lock
;
2080 struct byte_range_lock
*brl_get_locks_readonly(files_struct
*fsp
)
2082 struct byte_range_lock
*br_lock
= NULL
;
2083 struct byte_range_lock
*rw
= NULL
;
2085 DEBUG(10, ("seqnum=%d, fsp->brlock_seqnum=%d\n",
2086 dbwrap_get_seqnum(brlock_db
), fsp
->brlock_seqnum
));
2088 if ((fsp
->brlock_rec
!= NULL
)
2089 && (dbwrap_get_seqnum(brlock_db
) == fsp
->brlock_seqnum
)) {
2091 * We have cached the brlock_rec and the database did not
2094 return fsp
->brlock_rec
;
2097 if (!fsp
->lockdb_clean
) {
2099 * Fetch the record in R/W mode to give validate_lock_entries
2100 * a chance to kick in once.
2102 rw
= brl_get_locks(talloc_tos(), fsp
);
2106 fsp
->lockdb_clean
= true;
2110 size_t lock_data_size
;
2113 * Make a copy of the already retrieved and sanitized rw record
2115 lock_data_size
= rw
->num_locks
* sizeof(struct lock_struct
);
2116 br_lock
= talloc_pooled_object(
2117 fsp
, struct byte_range_lock
, 1, lock_data_size
);
2118 if (br_lock
== NULL
) {
2121 br_lock
->have_read_oplocks
= rw
->have_read_oplocks
;
2122 br_lock
->num_locks
= rw
->num_locks
;
2123 br_lock
->lock_data
= (struct lock_struct
*)talloc_memdup(
2124 br_lock
, rw
->lock_data
, lock_data_size
);
2126 struct brl_get_locks_readonly_state state
;
2130 * Parse the record fresh from the database
2133 state
.mem_ctx
= fsp
;
2134 state
.br_lock
= &br_lock
;
2136 status
= dbwrap_parse_record(
2138 make_tdb_data((uint8_t *)&fsp
->file_id
,
2139 sizeof(fsp
->file_id
)),
2140 brl_get_locks_readonly_parser
, &state
);
2142 if (NT_STATUS_EQUAL(status
,NT_STATUS_NOT_FOUND
)) {
2144 * No locks on this file. Return an empty br_lock.
2146 br_lock
= talloc(fsp
, struct byte_range_lock
);
2147 if (br_lock
== NULL
) {
2151 br_lock
->have_read_oplocks
= false;
2152 br_lock
->num_locks
= 0;
2153 br_lock
->lock_data
= NULL
;
2155 } else if (!NT_STATUS_IS_OK(status
)) {
2156 DEBUG(3, ("Could not parse byte range lock record: "
2157 "%s\n", nt_errstr(status
)));
2160 if (br_lock
== NULL
) {
2166 br_lock
->modified
= false;
2167 br_lock
->record
= NULL
;
2169 if (lp_clustering()) {
2171 * In the cluster case we can't cache the brlock struct
2172 * because dbwrap_get_seqnum does not work reliably over
2173 * ctdb. Thus we have to throw away the brlock struct soon.
2175 talloc_steal(talloc_tos(), br_lock
);
2178 * Cache the brlock struct, invalidated when the dbwrap_seqnum
2179 * changes. See beginning of this routine.
2181 TALLOC_FREE(fsp
->brlock_rec
);
2182 fsp
->brlock_rec
= br_lock
;
2183 fsp
->brlock_seqnum
= dbwrap_get_seqnum(brlock_db
);
2191 struct brl_revalidate_state
{
2194 struct server_id
*pids
;
2198 * Collect PIDs of all processes with pending entries
2201 static void brl_revalidate_collect(struct file_id id
, struct server_id pid
,
2202 enum brl_type lock_type
,
2203 enum brl_flavour lock_flav
,
2204 br_off start
, br_off size
,
2207 struct brl_revalidate_state
*state
=
2208 (struct brl_revalidate_state
*)private_data
;
2210 if (!IS_PENDING_LOCK(lock_type
)) {
2214 add_to_large_array(state
, sizeof(pid
), (void *)&pid
,
2215 &state
->pids
, &state
->num_pids
,
2216 &state
->array_size
);
2220 * qsort callback to sort the processes
2223 static int compare_procids(const void *p1
, const void *p2
)
2225 const struct server_id
*i1
= (const struct server_id
*)p1
;
2226 const struct server_id
*i2
= (const struct server_id
*)p2
;
2228 if (i1
->pid
< i2
->pid
) return -1;
2229 if (i1
->pid
> i2
->pid
) return 1;
2234 * Send a MSG_SMB_UNLOCK message to all processes with pending byte range
2235 * locks so that they retry. Mainly used in the cluster code after a node has
2238 * Done in two steps to avoid double-sends: First we collect all entries in an
2239 * array, then qsort that array and only send to non-dupes.
2242 void brl_revalidate(struct messaging_context
*msg_ctx
,
2245 struct server_id server_id
,
2248 struct brl_revalidate_state
*state
;
2250 struct server_id last_pid
;
2252 if (!(state
= talloc_zero(NULL
, struct brl_revalidate_state
))) {
2253 DEBUG(0, ("talloc failed\n"));
2257 brl_forall(brl_revalidate_collect
, state
);
2259 if (state
->array_size
== -1) {
2260 DEBUG(0, ("talloc failed\n"));
2264 if (state
->num_pids
== 0) {
2268 TYPESAFE_QSORT(state
->pids
, state
->num_pids
, compare_procids
);
2270 ZERO_STRUCT(last_pid
);
2272 for (i
=0; i
<state
->num_pids
; i
++) {
2273 if (serverid_equal(&last_pid
, &state
->pids
[i
])) {
2275 * We've seen that one already
2280 messaging_send(msg_ctx
, state
->pids
[i
], MSG_SMB_UNLOCK
,
2282 last_pid
= state
->pids
[i
];
2290 bool brl_cleanup_disconnected(struct file_id fid
, uint64_t open_persistent_id
)
2293 TALLOC_CTX
*frame
= talloc_stackframe();
2295 struct db_record
*rec
;
2296 struct lock_struct
*lock
;
2300 key
= make_tdb_data((void*)&fid
, sizeof(fid
));
2302 rec
= dbwrap_fetch_locked(brlock_db
, frame
, key
);
2304 DEBUG(5, ("brl_cleanup_disconnected: failed to fetch record "
2305 "for file %s\n", file_id_string(frame
, &fid
)));
2309 val
= dbwrap_record_get_value(rec
);
2310 lock
= (struct lock_struct
*)val
.dptr
;
2311 num
= val
.dsize
/ sizeof(struct lock_struct
);
2313 DEBUG(10, ("brl_cleanup_disconnected: no byte range locks for "
2314 "file %s\n", file_id_string(frame
, &fid
)));
2319 for (n
=0; n
<num
; n
++) {
2320 struct lock_context
*ctx
= &lock
[n
].context
;
2322 if (!server_id_is_disconnected(&ctx
->pid
)) {
2323 DEBUG(5, ("brl_cleanup_disconnected: byte range lock "
2324 "%s used by server %s, do not cleanup\n",
2325 file_id_string(frame
, &fid
),
2326 server_id_str(frame
, &ctx
->pid
)));
2330 if (ctx
->smblctx
!= open_persistent_id
) {
2331 DEBUG(5, ("brl_cleanup_disconnected: byte range lock "
2332 "%s expected smblctx %llu but found %llu"
2333 ", do not cleanup\n",
2334 file_id_string(frame
, &fid
),
2335 (unsigned long long)open_persistent_id
,
2336 (unsigned long long)ctx
->smblctx
));
2341 status
= dbwrap_record_delete(rec
);
2342 if (!NT_STATUS_IS_OK(status
)) {
2343 DEBUG(5, ("brl_cleanup_disconnected: failed to delete record "
2344 "for file %s from %s, open %llu: %s\n",
2345 file_id_string(frame
, &fid
), dbwrap_name(brlock_db
),
2346 (unsigned long long)open_persistent_id
,
2347 nt_errstr(status
)));
2351 DEBUG(10, ("brl_cleanup_disconnected: "
2352 "file %s cleaned up %u entries from open %llu\n",
2353 file_id_string(frame
, &fid
), num
,
2354 (unsigned long long)open_persistent_id
));