2 Unix SMB/CIFS implementation.
4 Copyright (C) Jeremy Allison 1992-2006
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 2 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, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 POSIX locking support. Jeremy Allison (jeremy@valinux.com), Apr. 2000.
28 #define DBGC_CLASS DBGC_LOCKING
31 * The pending close database handle.
34 static TDB_CONTEXT *posix_pending_close_tdb;
36 /****************************************************************************
37 First - the functions that deal with the underlying system locks - these
38 functions are used no matter if we're mapping CIFS Windows locks or CIFS
39 POSIX locks onto POSIX.
40 ****************************************************************************/
42 /****************************************************************************
43 Utility function to map a lock type correctly depending on the open
45 ****************************************************************************/
47 static int map_posix_lock_type( files_struct *fsp, enum brl_type lock_type)
49 if((lock_type == WRITE_LOCK) && !fsp->can_write) {
51 * Many UNIX's cannot get a write lock on a file opened read-only.
52 * Win32 locking semantics allow this.
53 * Do the best we can and attempt a read-only lock.
55 DEBUG(10,("map_posix_lock_type: Downgrading write lock to read due to read-only file.\n"));
60 * This return should be the most normal, as we attempt
61 * to always open files read/write.
64 return (lock_type == READ_LOCK) ? F_RDLCK : F_WRLCK;
67 /****************************************************************************
69 ****************************************************************************/
71 static const char *posix_lock_type_name(int lock_type)
73 return (lock_type == F_RDLCK) ? "READ" : "WRITE";
76 /****************************************************************************
77 Check to see if the given unsigned lock range is within the possible POSIX
78 range. Modifies the given args to be in range if possible, just returns
80 ****************************************************************************/
82 static BOOL posix_lock_in_range(SMB_OFF_T *offset_out, SMB_OFF_T *count_out,
83 SMB_BIG_UINT u_offset, SMB_BIG_UINT u_count)
85 SMB_OFF_T offset = (SMB_OFF_T)u_offset;
86 SMB_OFF_T count = (SMB_OFF_T)u_count;
89 * For the type of system we are, attempt to
90 * find the maximum positive lock offset as an SMB_OFF_T.
93 #if defined(MAX_POSITIVE_LOCK_OFFSET) /* Some systems have arbitrary limits. */
95 SMB_OFF_T max_positive_lock_offset = (MAX_POSITIVE_LOCK_OFFSET);
97 #elif defined(LARGE_SMB_OFF_T) && !defined(HAVE_BROKEN_FCNTL64_LOCKS)
100 * In this case SMB_OFF_T is 64 bits,
101 * and the underlying system can handle 64 bit signed locks.
104 SMB_OFF_T mask2 = ((SMB_OFF_T)0x4) << (SMB_OFF_T_BITS-4);
105 SMB_OFF_T mask = (mask2<<1);
106 SMB_OFF_T max_positive_lock_offset = ~mask;
108 #else /* !LARGE_SMB_OFF_T || HAVE_BROKEN_FCNTL64_LOCKS */
111 * In this case either SMB_OFF_T is 32 bits,
112 * or the underlying system cannot handle 64 bit signed locks.
113 * All offsets & counts must be 2^31 or less.
116 SMB_OFF_T max_positive_lock_offset = 0x7FFFFFFF;
118 #endif /* !LARGE_SMB_OFF_T || HAVE_BROKEN_FCNTL64_LOCKS */
121 * POSIX locks of length zero mean lock to end-of-file.
122 * Win32 locks of length zero are point probes. Ignore
123 * any Win32 locks of length zero. JRA.
126 if (count == (SMB_OFF_T)0) {
127 DEBUG(10,("posix_lock_in_range: count = 0, ignoring.\n"));
132 * If the given offset was > max_positive_lock_offset then we cannot map this at all
136 if (u_offset & ~((SMB_BIG_UINT)max_positive_lock_offset)) {
137 DEBUG(10,("posix_lock_in_range: (offset = %.0f) offset > %.0f and we cannot handle this. Ignoring lock.\n",
138 (double)u_offset, (double)((SMB_BIG_UINT)max_positive_lock_offset) ));
143 * We must truncate the count to less than max_positive_lock_offset.
146 if (u_count & ~((SMB_BIG_UINT)max_positive_lock_offset)) {
147 count = max_positive_lock_offset;
151 * Truncate count to end at max lock offset.
154 if (offset + count < 0 || offset + count > max_positive_lock_offset) {
155 count = max_positive_lock_offset - offset;
159 * If we ate all the count, ignore this lock.
163 DEBUG(10,("posix_lock_in_range: Count = 0. Ignoring lock u_offset = %.0f, u_count = %.0f\n",
164 (double)u_offset, (double)u_count ));
169 * The mapping was successful.
172 DEBUG(10,("posix_lock_in_range: offset_out = %.0f, count_out = %.0f\n",
173 (double)offset, (double)count ));
175 *offset_out = offset;
181 /****************************************************************************
182 Actual function that does POSIX locks. Copes with 64 -> 32 bit cruft and
183 broken NFS implementations.
184 ****************************************************************************/
186 static BOOL posix_fcntl_lock(files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type)
190 DEBUG(8,("posix_fcntl_lock %d %d %.0f %.0f %d\n",fsp->fh->fd,op,(double)offset,(double)count,type));
192 ret = SMB_VFS_LOCK(fsp,fsp->fh->fd,op,offset,count,type);
194 if (!ret && ((errno == EFBIG) || (errno == ENOLCK) || (errno == EINVAL))) {
196 DEBUG(0,("posix_fcntl_lock: WARNING: lock request at offset %.0f, length %.0f returned\n",
197 (double)offset,(double)count));
198 DEBUG(0,("an %s error. This can happen when using 64 bit lock offsets\n", strerror(errno)));
199 DEBUG(0,("on 32 bit NFS mounted file systems.\n"));
202 * If the offset is > 0x7FFFFFFF then this will cause problems on
203 * 32 bit NFS mounted filesystems. Just ignore it.
206 if (offset & ~((SMB_OFF_T)0x7fffffff)) {
207 DEBUG(0,("Offset greater than 31 bits. Returning success.\n"));
211 if (count & ~((SMB_OFF_T)0x7fffffff)) {
212 /* 32 bit NFS file system, retry with smaller offset */
213 DEBUG(0,("Count greater than 31 bits - retrying with 31 bit truncated length.\n"));
216 ret = SMB_VFS_LOCK(fsp,fsp->fh->fd,op,offset,count,type);
220 DEBUG(8,("posix_fcntl_lock: Lock call %s\n", ret ? "successful" : "failed"));
224 /****************************************************************************
225 Actual function that gets POSIX locks. Copes with 64 -> 32 bit cruft and
226 broken NFS implementations.
227 ****************************************************************************/
229 static BOOL posix_fcntl_getlock(files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype)
234 DEBUG(8,("posix_fcntl_getlock %d %.0f %.0f %d\n",
235 fsp->fh->fd,(double)*poffset,(double)*pcount,*ptype));
237 ret = SMB_VFS_GETLOCK(fsp,fsp->fh->fd,poffset,pcount,ptype,&pid);
239 if (!ret && ((errno == EFBIG) || (errno == ENOLCK) || (errno == EINVAL))) {
241 DEBUG(0,("posix_fcntl_getlock: WARNING: lock request at offset %.0f, length %.0f returned\n",
242 (double)*poffset,(double)*pcount));
243 DEBUG(0,("an %s error. This can happen when using 64 bit lock offsets\n", strerror(errno)));
244 DEBUG(0,("on 32 bit NFS mounted file systems.\n"));
247 * If the offset is > 0x7FFFFFFF then this will cause problems on
248 * 32 bit NFS mounted filesystems. Just ignore it.
251 if (*poffset & ~((SMB_OFF_T)0x7fffffff)) {
252 DEBUG(0,("Offset greater than 31 bits. Returning success.\n"));
256 if (*pcount & ~((SMB_OFF_T)0x7fffffff)) {
257 /* 32 bit NFS file system, retry with smaller offset */
258 DEBUG(0,("Count greater than 31 bits - retrying with 31 bit truncated length.\n"));
260 *pcount &= 0x7fffffff;
261 ret = SMB_VFS_GETLOCK(fsp,fsp->fh->fd,poffset,pcount,ptype,&pid);
265 DEBUG(8,("posix_fcntl_getlock: Lock query call %s\n", ret ? "successful" : "failed"));
269 /****************************************************************************
270 POSIX function to see if a file region is locked. Returns True if the
271 region is locked, False otherwise.
272 ****************************************************************************/
274 BOOL is_posix_locked(files_struct *fsp,
275 SMB_BIG_UINT *pu_offset,
276 SMB_BIG_UINT *pu_count,
277 enum brl_type *plock_type,
278 enum brl_flavour lock_flav)
282 int posix_lock_type = map_posix_lock_type(fsp,*plock_type);
284 DEBUG(10,("is_posix_locked: File %s, offset = %.0f, count = %.0f, type = %s\n",
285 fsp->fsp_name, (double)*pu_offset, (double)*pu_count, posix_lock_type_name(*plock_type) ));
288 * If the requested lock won't fit in the POSIX range, we will
289 * never set it, so presume it is not locked.
292 if(!posix_lock_in_range(&offset, &count, *pu_offset, *pu_count)) {
296 if (!posix_fcntl_getlock(fsp,&offset,&count,&posix_lock_type)) {
300 if (posix_lock_type == F_UNLCK) {
304 if (lock_flav == POSIX_LOCK) {
305 /* Only POSIX lock queries need to know the details. */
306 *pu_offset = (SMB_BIG_UINT)offset;
307 *pu_count = (SMB_BIG_UINT)count;
308 *plock_type = (posix_lock_type == F_RDLCK) ? READ_LOCK : WRITE_LOCK;
313 /****************************************************************************
314 Next - the functions that deal with in memory database storing representations
315 of either Windows CIFS locks or POSIX CIFS locks.
316 ****************************************************************************/
318 /* The key used in the in-memory POSIX databases. */
320 struct lock_ref_count_key {
331 /*******************************************************************
332 Form a static locking key for a dev/inode pair for the fd array.
333 ******************************************************************/
335 static TDB_DATA fd_array_key(SMB_DEV_T dev, SMB_INO_T inode)
337 static struct fd_key key;
340 memset(&key, '\0', sizeof(key));
343 kbuf.dptr = (char *)&key;
344 kbuf.dsize = sizeof(key);
348 /*******************************************************************
349 Form a static locking key for a dev/inode pair for the lock ref count
350 ******************************************************************/
352 static TDB_DATA locking_ref_count_key(SMB_DEV_T dev, SMB_INO_T inode)
354 static struct lock_ref_count_key key;
357 memset(&key, '\0', sizeof(key));
361 kbuf.dptr = (char *)&key;
362 kbuf.dsize = sizeof(key);
366 /*******************************************************************
367 Convenience function to get an fd_array key from an fsp.
368 ******************************************************************/
370 static TDB_DATA fd_array_key_fsp(files_struct *fsp)
372 return fd_array_key(fsp->dev, fsp->inode);
375 /*******************************************************************
376 Convenience function to get a lock ref count key from an fsp.
377 ******************************************************************/
379 static TDB_DATA locking_ref_count_key_fsp(files_struct *fsp)
381 return locking_ref_count_key(fsp->dev, fsp->inode);
384 /*******************************************************************
385 Create the in-memory POSIX lock databases.
386 ********************************************************************/
388 BOOL posix_locking_init(int read_only)
390 if (posix_pending_close_tdb) {
394 if (!posix_pending_close_tdb) {
395 posix_pending_close_tdb = tdb_open_log(NULL, 0, TDB_INTERNAL,
396 read_only?O_RDONLY:(O_RDWR|O_CREAT), 0644);
398 if (!posix_pending_close_tdb) {
399 DEBUG(0,("Failed to open POSIX pending close database.\n"));
406 /*******************************************************************
407 Delete the in-memory POSIX lock databases.
408 ********************************************************************/
410 BOOL posix_locking_end(void)
412 if (posix_pending_close_tdb && tdb_close(posix_pending_close_tdb) != 0) {
418 /****************************************************************************
419 Next - the functions that deal with storing fd's that have outstanding
420 POSIX locks when closed.
421 ****************************************************************************/
423 /****************************************************************************
424 The records in posix_pending_close_tdb are composed of an array of ints
425 keyed by dev/ino pair.
426 The first int is a reference count of the number of outstanding locks on
427 all open fd's on this dev/ino pair. Any subsequent ints are the fd's that
428 were open on this dev/ino pair that should have been closed, but can't as
429 the lock ref count is non zero.
430 ****************************************************************************/
432 /****************************************************************************
433 Keep a reference count of the number of Windows locks open on this dev/ino
434 pair. Creates entry if it doesn't exist.
435 ****************************************************************************/
437 static void increment_windows_lock_ref_count(files_struct *fsp)
439 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
443 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
444 if (dbuf.dptr == NULL) {
445 dbuf.dptr = (char *)SMB_MALLOC_P(int);
447 smb_panic("increment_windows_lock_ref_count: malloc fail.\n");
449 memset(dbuf.dptr, '\0', sizeof(int));
450 dbuf.dsize = sizeof(int);
453 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
455 memcpy(dbuf.dptr, &lock_ref_count, sizeof(int));
457 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
458 smb_panic("increment_windows_lock_ref_count: tdb_store_fail.\n");
460 SAFE_FREE(dbuf.dptr);
462 DEBUG(10,("increment_windows_lock_ref_count for file now %s = %d\n",
463 fsp->fsp_name, lock_ref_count ));
466 static void decrement_windows_lock_ref_count(files_struct *fsp)
468 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
472 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
474 smb_panic("decrement_windows_lock_ref_count: logic error.\n");
477 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
479 memcpy(dbuf.dptr, &lock_ref_count, sizeof(int));
481 if (lock_ref_count < 0) {
482 smb_panic("decrement_windows_lock_ref_count: lock_count logic error.\n");
485 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
486 smb_panic("decrement_windows_lock_ref_count: tdb_store_fail.\n");
488 SAFE_FREE(dbuf.dptr);
490 DEBUG(10,("decrement_windows_lock_ref_count for file now %s = %d\n",
491 fsp->fsp_name, lock_ref_count ));
494 /****************************************************************************
495 Bulk delete - subtract as many locks as we've just deleted.
496 ****************************************************************************/
498 void reduce_windows_lock_ref_count(files_struct *fsp, unsigned int dcount)
500 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
504 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
509 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
510 lock_ref_count -= dcount;
512 if (lock_ref_count < 0) {
513 smb_panic("reduce_windows_lock_ref_count: lock_count logic error.\n");
515 memcpy(dbuf.dptr, &lock_ref_count, sizeof(int));
517 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
518 smb_panic("reduce_windows_lock_ref_count: tdb_store_fail.\n");
520 SAFE_FREE(dbuf.dptr);
522 DEBUG(10,("reduce_windows_lock_ref_count for file now %s = %d\n",
523 fsp->fsp_name, lock_ref_count ));
526 /****************************************************************************
527 Fetch the lock ref count.
528 ****************************************************************************/
530 static int get_windows_lock_ref_count(files_struct *fsp)
532 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
536 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
540 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
542 SAFE_FREE(dbuf.dptr);
544 DEBUG(10,("get_windows_lock_count for file %s = %d\n",
545 fsp->fsp_name, lock_ref_count ));
546 return lock_ref_count;
549 /****************************************************************************
550 Delete a lock_ref_count entry.
551 ****************************************************************************/
553 static void delete_windows_lock_ref_count(files_struct *fsp)
555 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
557 /* Not a bug if it doesn't exist - no locks were ever granted. */
558 tdb_delete(posix_pending_close_tdb, kbuf);
559 DEBUG(10,("delete_windows_lock_ref_count for file %s\n", fsp->fsp_name));
562 /****************************************************************************
563 Add an fd to the pending close tdb.
564 ****************************************************************************/
566 static void add_fd_to_close_entry(files_struct *fsp)
568 TDB_DATA kbuf = fd_array_key_fsp(fsp);
574 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
576 dbuf.dptr = (char *)SMB_REALLOC(dbuf.dptr, dbuf.dsize + sizeof(int));
578 smb_panic("add_fd_to_close_entry: Realloc fail !\n");
581 memcpy(dbuf.dptr + dbuf.dsize, &fsp->fh->fd, sizeof(int));
582 dbuf.dsize += sizeof(int);
584 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
585 smb_panic("add_fd_to_close_entry: tdb_store_fail.\n");
588 DEBUG(10,("add_fd_to_close_entry: added fd %d file %s\n",
589 fsp->fh->fd, fsp->fsp_name ));
591 SAFE_FREE(dbuf.dptr);
594 /****************************************************************************
595 Remove all fd entries for a specific dev/inode pair from the tdb.
596 ****************************************************************************/
598 static void delete_close_entries(files_struct *fsp)
600 TDB_DATA kbuf = fd_array_key_fsp(fsp);
602 if (tdb_delete(posix_pending_close_tdb, kbuf) == -1) {
603 smb_panic("delete_close_entries: tdb_delete fail !\n");
607 /****************************************************************************
608 Get the array of POSIX pending close records for an open fsp. Caller must
609 free. Returns number of entries.
610 ****************************************************************************/
612 static size_t get_posix_pending_close_entries(files_struct *fsp, int **entries)
614 TDB_DATA kbuf = fd_array_key_fsp(fsp);
621 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
627 *entries = (int *)dbuf.dptr;
628 count = (size_t)(dbuf.dsize / sizeof(int));
633 /****************************************************************************
634 Deal with pending closes needed by POSIX locking support.
635 Note that posix_locking_close_file() is expected to have been called
636 to delete all locks on this fsp before this function is called.
637 ****************************************************************************/
639 int fd_close_posix(struct connection_struct *conn, files_struct *fsp)
643 int *fd_array = NULL;
646 if (!lp_locking(SNUM(fsp->conn)) || !lp_posix_locking(SNUM(conn))) {
648 * No locking or POSIX to worry about or we want POSIX semantics
649 * which will lose all locks on all fd's open on this dev/inode,
652 ret = SMB_VFS_CLOSE(fsp,fsp->fh->fd);
657 if (get_windows_lock_ref_count(fsp)) {
660 * There are outstanding locks on this dev/inode pair on other fds.
661 * Add our fd to the pending close tdb and set fsp->fh->fd to -1.
664 add_fd_to_close_entry(fsp);
670 * No outstanding locks. Get the pending close fd's
671 * from the tdb and close them all.
674 count = get_posix_pending_close_entries(fsp, &fd_array);
677 DEBUG(10,("fd_close_posix: doing close on %u fd's.\n", (unsigned int)count ));
679 for(i = 0; i < count; i++) {
680 if (SMB_VFS_CLOSE(fsp,fd_array[i]) == -1) {
686 * Delete all fd's stored in the tdb
687 * for this dev/inode pair.
690 delete_close_entries(fsp);
695 /* Don't need a lock ref count on this dev/ino anymore. */
696 delete_windows_lock_ref_count(fsp);
699 * Finally close the fd associated with this fsp.
702 ret = SMB_VFS_CLOSE(fsp,fsp->fh->fd);
704 if (saved_errno != 0) {
714 /****************************************************************************
715 Next - the functions that deal with the mapping CIFS Windows locks onto
716 the underlying system POSIX locks.
717 ****************************************************************************/
720 * Structure used when splitting a lock range
721 * into a POSIX lock range. Doubly linked list.
725 struct lock_list *next;
726 struct lock_list *prev;
731 /****************************************************************************
732 Create a list of lock ranges that don't overlap a given range. Used in calculating
733 POSIX locks and unlocks. This is a difficult function that requires ASCII art to
735 ****************************************************************************/
737 static struct lock_list *posix_lock_list(TALLOC_CTX *ctx,
738 struct lock_list *lhead,
739 const struct lock_context *lock_ctx, /* Lock context lhead belongs to. */
741 const struct lock_struct *plocks,
747 * Check the current lock list on this dev/inode pair.
748 * Quit if the list is deleted.
751 DEBUG(10,("posix_lock_list: curr: start=%.0f,size=%.0f\n",
752 (double)lhead->start, (double)lhead->size ));
754 for (i=0; i<num_locks && lhead; i++) {
755 const struct lock_struct *lock = &plocks[i];
756 struct lock_list *l_curr;
758 /* Ignore all but read/write locks. */
759 if (lock->lock_type != READ_LOCK && lock->lock_type != WRITE_LOCK) {
763 /* Ignore locks not owned by this process. */
764 if (!procid_equal(&lock->context.pid, &lock_ctx->pid)) {
769 * Walk the lock list, checking for overlaps. Note that
770 * the lock list can expand within this loop if the current
771 * range being examined needs to be split.
774 for (l_curr = lhead; l_curr;) {
776 DEBUG(10,("posix_lock_list: lock: fnum=%d: start=%.0f,size=%.0f:type=%s", lock->fnum,
777 (double)lock->start, (double)lock->size, posix_lock_type_name(lock->lock_type) ));
779 if ( (l_curr->start >= (lock->start + lock->size)) ||
780 (lock->start >= (l_curr->start + l_curr->size))) {
782 /* No overlap with existing lock - leave this range alone. */
783 /*********************************************
794 **********************************************/
796 DEBUG(10,(" no overlap case.\n" ));
798 l_curr = l_curr->next;
800 } else if ( (l_curr->start >= lock->start) &&
801 (l_curr->start + l_curr->size <= lock->start + lock->size) ) {
804 * This range is completely overlapped by this existing lock range
805 * and thus should have no effect. Delete it from the list.
807 /*********************************************
811 +---------------------------+
813 +---------------------------+
814 **********************************************/
815 /* Save the next pointer */
816 struct lock_list *ul_next = l_curr->next;
818 DEBUG(10,(" delete case.\n" ));
820 DLIST_REMOVE(lhead, l_curr);
822 break; /* No more list... */
827 } else if ( (l_curr->start >= lock->start) &&
828 (l_curr->start < lock->start + lock->size) &&
829 (l_curr->start + l_curr->size > lock->start + lock->size) ) {
832 * This range overlaps the existing lock range at the high end.
833 * Truncate by moving start to existing range end and reducing size.
835 /*********************************************
846 **********************************************/
848 l_curr->size = (l_curr->start + l_curr->size) - (lock->start + lock->size);
849 l_curr->start = lock->start + lock->size;
851 DEBUG(10,(" truncate high case: start=%.0f,size=%.0f\n",
852 (double)l_curr->start, (double)l_curr->size ));
854 l_curr = l_curr->next;
856 } else if ( (l_curr->start < lock->start) &&
857 (l_curr->start + l_curr->size > lock->start) &&
858 (l_curr->start + l_curr->size <= lock->start + lock->size) ) {
861 * This range overlaps the existing lock range at the low end.
862 * Truncate by reducing size.
864 /*********************************************
875 **********************************************/
877 l_curr->size = lock->start - l_curr->start;
879 DEBUG(10,(" truncate low case: start=%.0f,size=%.0f\n",
880 (double)l_curr->start, (double)l_curr->size ));
882 l_curr = l_curr->next;
884 } else if ( (l_curr->start < lock->start) &&
885 (l_curr->start + l_curr->size > lock->start + lock->size) ) {
887 * Worst case scenario. Range completely overlaps an existing
888 * lock range. Split the request into two, push the new (upper) request
889 * into the dlink list, and continue with the entry after l_new (as we
890 * know that l_new will not overlap with this lock).
892 /*********************************************
893 +---------------------------+
895 +---------------------------+
900 +-------+ +---------+
902 +-------+ +---------+
903 **********************************************/
904 struct lock_list *l_new = TALLOC_P(ctx, struct lock_list);
907 DEBUG(0,("posix_lock_list: talloc fail.\n"));
908 return NULL; /* The talloc_destroy takes care of cleanup. */
912 l_new->start = lock->start + lock->size;
913 l_new->size = l_curr->start + l_curr->size - l_new->start;
915 /* Truncate the l_curr. */
916 l_curr->size = lock->start - l_curr->start;
918 DEBUG(10,(" split case: curr: start=%.0f,size=%.0f \
919 new: start=%.0f,size=%.0f\n", (double)l_curr->start, (double)l_curr->size,
920 (double)l_new->start, (double)l_new->size ));
923 * Add into the dlink list after the l_curr point - NOT at lhead.
924 * Note we can't use DLINK_ADD here as this inserts at the head of the given list.
927 l_new->prev = l_curr;
928 l_new->next = l_curr->next;
929 l_curr->next = l_new;
931 /* And move after the link we added. */
932 l_curr = l_new->next;
937 * This logic case should never happen. Ensure this is the
938 * case by forcing an abort.... Remove in production.
942 slprintf(msg, sizeof(msg)-1, "logic flaw in cases: l_curr: start = %.0f, size = %.0f : \
943 lock: start = %.0f, size = %.0f\n", (double)l_curr->start, (double)l_curr->size, (double)lock->start, (double)lock->size );
947 } /* end for ( l_curr = lhead; l_curr;) */
948 } /* end for (i=0; i<num_locks && ul_head; i++) */
953 /****************************************************************************
954 POSIX function to acquire a lock. Returns True if the
955 lock could be granted, False if not.
956 ****************************************************************************/
958 BOOL set_posix_lock_windows_flavour(files_struct *fsp,
959 SMB_BIG_UINT u_offset,
960 SMB_BIG_UINT u_count,
961 enum brl_type lock_type,
962 const struct lock_context *lock_ctx,
963 const struct lock_struct *plocks,
969 int posix_lock_type = map_posix_lock_type(fsp,lock_type);
972 TALLOC_CTX *l_ctx = NULL;
973 struct lock_list *llist = NULL;
974 struct lock_list *ll = NULL;
976 DEBUG(5,("set_posix_lock_windows_flavour: File %s, offset = %.0f, count = %.0f, type = %s\n",
977 fsp->fsp_name, (double)u_offset, (double)u_count, posix_lock_type_name(lock_type) ));
980 * If the requested lock won't fit in the POSIX range, we will
981 * pretend it was successful.
984 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
985 increment_windows_lock_ref_count(fsp);
990 * Windows is very strange. It allows read locks to be overlayed
991 * (even over a write lock), but leaves the write lock in force until the first
992 * unlock. It also reference counts the locks. This means the following sequence :
995 * ------------------------------------------------------------------------
996 * WRITE LOCK : start = 2, len = 10
997 * READ LOCK: start =0, len = 10 - FAIL
998 * READ LOCK : start = 0, len = 14
999 * READ LOCK: start =0, len = 10 - FAIL
1000 * UNLOCK : start = 2, len = 10
1001 * READ LOCK: start =0, len = 10 - OK
1003 * Under POSIX, the same sequence in steps 1 and 2 would not be reference counted, but
1004 * would leave a single read lock over the 0-14 region.
1007 if ((l_ctx = talloc_init("set_posix_lock")) == NULL) {
1008 DEBUG(0,("set_posix_lock_windows_flavour: unable to init talloc context.\n"));
1012 if ((ll = TALLOC_P(l_ctx, struct lock_list)) == NULL) {
1013 DEBUG(0,("set_posix_lock_windows_flavour: unable to talloc unlock list.\n"));
1014 talloc_destroy(l_ctx);
1019 * Create the initial list entry containing the
1020 * lock we want to add.
1027 DLIST_ADD(llist, ll);
1030 * The following call calculates if there are any
1031 * overlapping locks held by this process on
1032 * fd's open on the same file and splits this list
1033 * into a list of lock ranges that do not overlap with existing
1037 llist = posix_lock_list(l_ctx,
1039 lock_ctx, /* Lock context llist belongs to. */
1045 * Add the POSIX locks on the list of ranges returned.
1046 * As the lock is supposed to be added atomically, we need to
1047 * back out all the locks if any one of these calls fail.
1050 for (lock_count = 0, ll = llist; ll; ll = ll->next, lock_count++) {
1054 DEBUG(5,("set_posix_lock_windows_flavour: Real lock: Type = %s: offset = %.0f, count = %.0f\n",
1055 posix_lock_type_name(posix_lock_type), (double)offset, (double)count ));
1057 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,posix_lock_type)) {
1059 DEBUG(5,("set_posix_lock_windows_flavour: Lock fail !: Type = %s: offset = %.0f, count = %.0f. Errno = %s\n",
1060 posix_lock_type_name(posix_lock_type), (double)offset, (double)count, strerror(errno) ));
1069 * Back out all the POSIX locks we have on fail.
1072 for (ll = llist; lock_count; ll = ll->next, lock_count--) {
1076 DEBUG(5,("set_posix_lock_windows_flavour: Backing out locks: Type = %s: offset = %.0f, count = %.0f\n",
1077 posix_lock_type_name(posix_lock_type), (double)offset, (double)count ));
1079 posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_UNLCK);
1082 /* Remember the number of Windows locks we have on this dev/ino pair. */
1083 increment_windows_lock_ref_count(fsp);
1086 talloc_destroy(l_ctx);
1090 /****************************************************************************
1091 POSIX function to release a lock. Returns True if the
1092 lock could be released, False if not.
1093 ****************************************************************************/
1095 BOOL release_posix_lock_windows_flavour(files_struct *fsp,
1096 SMB_BIG_UINT u_offset,
1097 SMB_BIG_UINT u_count,
1098 enum brl_type deleted_lock_type,
1099 const struct lock_context *lock_ctx,
1100 const struct lock_struct *plocks,
1106 TALLOC_CTX *ul_ctx = NULL;
1107 struct lock_list *ulist = NULL;
1108 struct lock_list *ul = NULL;
1110 DEBUG(5,("release_posix_lock_windows_flavour: File %s, offset = %.0f, count = %.0f\n",
1111 fsp->fsp_name, (double)u_offset, (double)u_count ));
1113 /* Remember the number of Windows locks we have on this dev/ino pair. */
1114 decrement_windows_lock_ref_count(fsp);
1117 * If the requested lock won't fit in the POSIX range, we will
1118 * pretend it was successful.
1121 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
1125 if ((ul_ctx = talloc_init("release_posix_lock")) == NULL) {
1126 DEBUG(0,("release_posix_lock_windows_flavour: unable to init talloc context.\n"));
1130 if ((ul = TALLOC_P(ul_ctx, struct lock_list)) == NULL) {
1131 DEBUG(0,("release_posix_lock_windows_flavour: unable to talloc unlock list.\n"));
1132 talloc_destroy(ul_ctx);
1137 * Create the initial list entry containing the
1138 * lock we want to remove.
1145 DLIST_ADD(ulist, ul);
1148 * The following call calculates if there are any
1149 * overlapping locks held by this process on
1150 * fd's open on the same file and creates a
1151 * list of unlock ranges that will allow
1152 * POSIX lock ranges to remain on the file whilst the
1153 * unlocks are performed.
1156 ulist = posix_lock_list(ul_ctx,
1158 lock_ctx, /* Lock context ulist belongs to. */
1164 * If there were any overlapped entries (list is > 1 or size or start have changed),
1165 * and the lock_type we just deleted from
1166 * the upper layer tdb was a write lock, then before doing the unlock we need to downgrade
1167 * the POSIX lock to a read lock. This allows any overlapping read locks
1168 * to be atomically maintained.
1171 if (deleted_lock_type == WRITE_LOCK &&
1172 (!ulist || ulist->next != NULL || ulist->start != offset || ulist->size != count)) {
1174 DEBUG(5,("release_posix_lock_windows_flavour: downgrading lock to READ: offset = %.0f, count = %.0f\n",
1175 (double)offset, (double)count ));
1177 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_RDLCK)) {
1178 DEBUG(0,("release_posix_lock_windows_flavour: downgrade of lock failed with error %s !\n", strerror(errno) ));
1179 talloc_destroy(ul_ctx);
1185 * Release the POSIX locks on the list of ranges returned.
1188 for(; ulist; ulist = ulist->next) {
1189 offset = ulist->start;
1190 count = ulist->size;
1192 DEBUG(5,("release_posix_lock_windows_flavour: Real unlock: offset = %.0f, count = %.0f\n",
1193 (double)offset, (double)count ));
1195 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_UNLCK)) {
1200 talloc_destroy(ul_ctx);
1204 /****************************************************************************
1205 Next - the functions that deal with mapping CIFS POSIX locks onto
1206 the underlying system POSIX locks.
1207 ****************************************************************************/
1209 /****************************************************************************
1210 POSIX function to acquire a lock. Returns True if the
1211 lock could be granted, False if not.
1212 As POSIX locks don't stack or conflict (they just overwrite)
1213 we can map the requested lock directly onto a system one. We
1214 know it doesn't conflict with locks on other contexts as the
1215 upper layer would have refused it.
1216 ****************************************************************************/
1218 BOOL set_posix_lock_posix_flavour(files_struct *fsp,
1219 SMB_BIG_UINT u_offset,
1220 SMB_BIG_UINT u_count,
1221 enum brl_type lock_type,
1226 int posix_lock_type = map_posix_lock_type(fsp,lock_type);
1228 DEBUG(5,("set_posix_lock_posix_flavour: File %s, offset = %.0f, count = %.0f, type = %s\n",
1229 fsp->fsp_name, (double)u_offset, (double)u_count, posix_lock_type_name(lock_type) ));
1232 * If the requested lock won't fit in the POSIX range, we will
1233 * pretend it was successful.
1236 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
1240 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,posix_lock_type)) {
1242 DEBUG(5,("set_posix_lock_posix_flavour: Lock fail !: Type = %s: offset = %.0f, count = %.0f. Errno = %s\n",
1243 posix_lock_type_name(posix_lock_type), (double)offset, (double)count, strerror(errno) ));
1249 /****************************************************************************
1250 POSIX function to release a lock. Returns True if the
1251 lock could be released, False if not.
1252 We are given a complete lock state from the upper layer which is what the lock
1253 state should be after the unlock has already been done, so what
1254 we do is punch out holes in the unlock range where locks owned by this process
1255 have a different lock context.
1256 ****************************************************************************/
1258 BOOL release_posix_lock_posix_flavour(files_struct *fsp,
1259 SMB_BIG_UINT u_offset,
1260 SMB_BIG_UINT u_count,
1261 const struct lock_context *lock_ctx,
1262 const struct lock_struct *plocks,
1268 TALLOC_CTX *ul_ctx = NULL;
1269 struct lock_list *ulist = NULL;
1270 struct lock_list *ul = NULL;
1272 DEBUG(5,("release_posix_lock_posix_flavour: File %s, offset = %.0f, count = %.0f\n",
1273 fsp->fsp_name, (double)u_offset, (double)u_count ));
1276 * If the requested lock won't fit in the POSIX range, we will
1277 * pretend it was successful.
1280 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
1284 if ((ul_ctx = talloc_init("release_posix_lock")) == NULL) {
1285 DEBUG(0,("release_posix_lock_windows_flavour: unable to init talloc context.\n"));
1289 if ((ul = TALLOC_P(ul_ctx, struct lock_list)) == NULL) {
1290 DEBUG(0,("release_posix_lock_windows_flavour: unable to talloc unlock list.\n"));
1291 talloc_destroy(ul_ctx);
1296 * Create the initial list entry containing the
1297 * lock we want to remove.
1304 DLIST_ADD(ulist, ul);
1307 * Walk the given array creating a linked list
1308 * of unlock requests.
1311 ulist = posix_lock_list(ul_ctx,
1313 lock_ctx, /* Lock context ulist belongs to. */
1319 * Release the POSIX locks on the list of ranges returned.
1322 for(; ulist; ulist = ulist->next) {
1323 offset = ulist->start;
1324 count = ulist->size;
1326 DEBUG(5,("release_posix_lock_posix_flavour: Real unlock: offset = %.0f, count = %.0f\n",
1327 (double)offset, (double)count ));
1329 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_UNLCK)) {
1334 talloc_destroy(ul_ctx);