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 DEBUGADD(0,("an %s error. This can happen when using 64 bit lock offsets\n", strerror(errno)));
199 DEBUGADD(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 DEBUGADD(0,("an %s error. This can happen when using 64 bit lock offsets\n", strerror(errno)));
244 DEBUGADD(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 {
325 /*******************************************************************
326 Form a static locking key for a dev/inode pair for the fd array.
327 ******************************************************************/
329 static TDB_DATA fd_array_key(struct file_id id)
331 static struct file_id key;
334 kbuf.dptr = (uint8 *)&key;
335 kbuf.dsize = sizeof(key);
339 /*******************************************************************
340 Form a static locking key for a dev/inode pair for the lock ref count
341 ******************************************************************/
343 static TDB_DATA locking_ref_count_key(struct file_id id)
345 static struct lock_ref_count_key key;
348 memset(&key, '\0', sizeof(key));
351 kbuf.dptr = (uint8 *)&key;
352 kbuf.dsize = sizeof(key);
356 /*******************************************************************
357 Convenience function to get an fd_array key from an fsp.
358 ******************************************************************/
360 static TDB_DATA fd_array_key_fsp(files_struct *fsp)
362 return fd_array_key(fsp->file_id);
365 /*******************************************************************
366 Convenience function to get a lock ref count key from an fsp.
367 ******************************************************************/
369 static TDB_DATA locking_ref_count_key_fsp(files_struct *fsp)
371 return locking_ref_count_key(fsp->file_id);
374 /*******************************************************************
375 Create the in-memory POSIX lock databases.
376 ********************************************************************/
378 BOOL posix_locking_init(int read_only)
380 if (posix_pending_close_tdb) {
384 if (!posix_pending_close_tdb) {
385 posix_pending_close_tdb = tdb_open_log(NULL, 0, TDB_INTERNAL,
386 read_only?O_RDONLY:(O_RDWR|O_CREAT), 0644);
388 if (!posix_pending_close_tdb) {
389 DEBUG(0,("Failed to open POSIX pending close database.\n"));
396 /*******************************************************************
397 Delete the in-memory POSIX lock databases.
398 ********************************************************************/
400 BOOL posix_locking_end(void)
402 if (posix_pending_close_tdb && tdb_close(posix_pending_close_tdb) != 0) {
408 /****************************************************************************
409 Next - the functions that deal with storing fd's that have outstanding
410 POSIX locks when closed.
411 ****************************************************************************/
413 /****************************************************************************
414 The records in posix_pending_close_tdb are composed of an array of ints
415 keyed by dev/ino pair.
416 The first int is a reference count of the number of outstanding locks on
417 all open fd's on this dev/ino pair. Any subsequent ints are the fd's that
418 were open on this dev/ino pair that should have been closed, but can't as
419 the lock ref count is non zero.
420 ****************************************************************************/
422 /****************************************************************************
423 Keep a reference count of the number of Windows locks open on this dev/ino
424 pair. Creates entry if it doesn't exist.
425 ****************************************************************************/
427 static void increment_windows_lock_ref_count(files_struct *fsp)
429 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
433 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
434 if (dbuf.dptr == NULL) {
435 dbuf.dptr = (uint8 *)SMB_MALLOC_P(int);
437 smb_panic("increment_windows_lock_ref_count: malloc fail.\n");
439 memset(dbuf.dptr, '\0', sizeof(int));
440 dbuf.dsize = sizeof(int);
443 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
445 memcpy(dbuf.dptr, &lock_ref_count, sizeof(int));
447 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
448 smb_panic("increment_windows_lock_ref_count: tdb_store_fail.\n");
450 SAFE_FREE(dbuf.dptr);
452 DEBUG(10,("increment_windows_lock_ref_count for file now %s = %d\n",
453 fsp->fsp_name, lock_ref_count ));
456 static void decrement_windows_lock_ref_count(files_struct *fsp)
458 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
462 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
464 smb_panic("decrement_windows_lock_ref_count: logic error.\n");
467 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
469 memcpy(dbuf.dptr, &lock_ref_count, sizeof(int));
471 if (lock_ref_count < 0) {
472 smb_panic("decrement_windows_lock_ref_count: lock_count logic error.\n");
475 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
476 smb_panic("decrement_windows_lock_ref_count: tdb_store_fail.\n");
478 SAFE_FREE(dbuf.dptr);
480 DEBUG(10,("decrement_windows_lock_ref_count for file now %s = %d\n",
481 fsp->fsp_name, lock_ref_count ));
484 /****************************************************************************
485 Bulk delete - subtract as many locks as we've just deleted.
486 ****************************************************************************/
488 void reduce_windows_lock_ref_count(files_struct *fsp, unsigned int dcount)
490 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
494 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
499 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
500 lock_ref_count -= dcount;
502 if (lock_ref_count < 0) {
503 smb_panic("reduce_windows_lock_ref_count: lock_count logic error.\n");
505 memcpy(dbuf.dptr, &lock_ref_count, sizeof(int));
507 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
508 smb_panic("reduce_windows_lock_ref_count: tdb_store_fail.\n");
510 SAFE_FREE(dbuf.dptr);
512 DEBUG(10,("reduce_windows_lock_ref_count for file now %s = %d\n",
513 fsp->fsp_name, lock_ref_count ));
516 /****************************************************************************
517 Fetch the lock ref count.
518 ****************************************************************************/
520 static int get_windows_lock_ref_count(files_struct *fsp)
522 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
526 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
530 memcpy(&lock_ref_count, dbuf.dptr, sizeof(int));
532 SAFE_FREE(dbuf.dptr);
534 DEBUG(10,("get_windows_lock_count for file %s = %d\n",
535 fsp->fsp_name, lock_ref_count ));
536 return lock_ref_count;
539 /****************************************************************************
540 Delete a lock_ref_count entry.
541 ****************************************************************************/
543 static void delete_windows_lock_ref_count(files_struct *fsp)
545 TDB_DATA kbuf = locking_ref_count_key_fsp(fsp);
547 /* Not a bug if it doesn't exist - no locks were ever granted. */
548 tdb_delete(posix_pending_close_tdb, kbuf);
549 DEBUG(10,("delete_windows_lock_ref_count for file %s\n", fsp->fsp_name));
552 /****************************************************************************
553 Add an fd to the pending close tdb.
554 ****************************************************************************/
556 static void add_fd_to_close_entry(files_struct *fsp)
558 TDB_DATA kbuf = fd_array_key_fsp(fsp);
564 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
566 dbuf.dptr = (uint8 *)SMB_REALLOC(dbuf.dptr, dbuf.dsize + sizeof(int));
568 smb_panic("add_fd_to_close_entry: Realloc fail !\n");
571 memcpy(dbuf.dptr + dbuf.dsize, &fsp->fh->fd, sizeof(int));
572 dbuf.dsize += sizeof(int);
574 if (tdb_store(posix_pending_close_tdb, kbuf, dbuf, TDB_REPLACE) == -1) {
575 smb_panic("add_fd_to_close_entry: tdb_store_fail.\n");
578 DEBUG(10,("add_fd_to_close_entry: added fd %d file %s\n",
579 fsp->fh->fd, fsp->fsp_name ));
581 SAFE_FREE(dbuf.dptr);
584 /****************************************************************************
585 Remove all fd entries for a specific dev/inode pair from the tdb.
586 ****************************************************************************/
588 static void delete_close_entries(files_struct *fsp)
590 TDB_DATA kbuf = fd_array_key_fsp(fsp);
592 if (tdb_delete(posix_pending_close_tdb, kbuf) == -1) {
593 smb_panic("delete_close_entries: tdb_delete fail !\n");
597 /****************************************************************************
598 Get the array of POSIX pending close records for an open fsp. Caller must
599 free. Returns number of entries.
600 ****************************************************************************/
602 static size_t get_posix_pending_close_entries(files_struct *fsp, int **entries)
604 TDB_DATA kbuf = fd_array_key_fsp(fsp);
611 dbuf = tdb_fetch(posix_pending_close_tdb, kbuf);
617 *entries = (int *)dbuf.dptr;
618 count = (size_t)(dbuf.dsize / sizeof(int));
623 /****************************************************************************
624 Deal with pending closes needed by POSIX locking support.
625 Note that posix_locking_close_file() is expected to have been called
626 to delete all locks on this fsp before this function is called.
627 ****************************************************************************/
629 NTSTATUS fd_close_posix(struct connection_struct *conn, files_struct *fsp)
633 int *fd_array = NULL;
636 if (!lp_locking(fsp->conn->params) || !lp_posix_locking(conn->params)) {
638 * No locking or POSIX to worry about or we want POSIX semantics
639 * which will lose all locks on all fd's open on this dev/inode,
642 ret = SMB_VFS_CLOSE(fsp,fsp->fh->fd);
644 return map_nt_error_from_unix(errno);
647 if (get_windows_lock_ref_count(fsp)) {
650 * There are outstanding locks on this dev/inode pair on other fds.
651 * Add our fd to the pending close tdb and set fsp->fh->fd to -1.
654 add_fd_to_close_entry(fsp);
660 * No outstanding locks. Get the pending close fd's
661 * from the tdb and close them all.
664 count = get_posix_pending_close_entries(fsp, &fd_array);
667 DEBUG(10,("fd_close_posix: doing close on %u fd's.\n", (unsigned int)count ));
669 for(i = 0; i < count; i++) {
670 if (SMB_VFS_CLOSE(fsp,fd_array[i]) == -1) {
676 * Delete all fd's stored in the tdb
677 * for this dev/inode pair.
680 delete_close_entries(fsp);
685 /* Don't need a lock ref count on this dev/ino anymore. */
686 delete_windows_lock_ref_count(fsp);
689 * Finally close the fd associated with this fsp.
692 ret = SMB_VFS_CLOSE(fsp,fsp->fh->fd);
694 if (ret == 0 && saved_errno != 0) {
702 return map_nt_error_from_unix(errno);
708 /****************************************************************************
709 Next - the functions that deal with the mapping CIFS Windows locks onto
710 the underlying system POSIX locks.
711 ****************************************************************************/
714 * Structure used when splitting a lock range
715 * into a POSIX lock range. Doubly linked list.
719 struct lock_list *next;
720 struct lock_list *prev;
725 /****************************************************************************
726 Create a list of lock ranges that don't overlap a given range. Used in calculating
727 POSIX locks and unlocks. This is a difficult function that requires ASCII art to
729 ****************************************************************************/
731 static struct lock_list *posix_lock_list(TALLOC_CTX *ctx,
732 struct lock_list *lhead,
733 const struct lock_context *lock_ctx, /* Lock context lhead belongs to. */
735 const struct lock_struct *plocks,
741 * Check the current lock list on this dev/inode pair.
742 * Quit if the list is deleted.
745 DEBUG(10,("posix_lock_list: curr: start=%.0f,size=%.0f\n",
746 (double)lhead->start, (double)lhead->size ));
748 for (i=0; i<num_locks && lhead; i++) {
749 const struct lock_struct *lock = &plocks[i];
750 struct lock_list *l_curr;
752 /* Ignore all but read/write locks. */
753 if (lock->lock_type != READ_LOCK && lock->lock_type != WRITE_LOCK) {
757 /* Ignore locks not owned by this process. */
758 if (!procid_equal(&lock->context.pid, &lock_ctx->pid)) {
763 * Walk the lock list, checking for overlaps. Note that
764 * the lock list can expand within this loop if the current
765 * range being examined needs to be split.
768 for (l_curr = lhead; l_curr;) {
770 DEBUG(10,("posix_lock_list: lock: fnum=%d: start=%.0f,size=%.0f:type=%s", lock->fnum,
771 (double)lock->start, (double)lock->size, posix_lock_type_name(lock->lock_type) ));
773 if ( (l_curr->start >= (lock->start + lock->size)) ||
774 (lock->start >= (l_curr->start + l_curr->size))) {
776 /* No overlap with existing lock - leave this range alone. */
777 /*********************************************
788 **********************************************/
790 DEBUG(10,(" no overlap case.\n" ));
792 l_curr = l_curr->next;
794 } else if ( (l_curr->start >= lock->start) &&
795 (l_curr->start + l_curr->size <= lock->start + lock->size) ) {
798 * This range is completely overlapped by this existing lock range
799 * and thus should have no effect. Delete it from the list.
801 /*********************************************
805 +---------------------------+
807 +---------------------------+
808 **********************************************/
809 /* Save the next pointer */
810 struct lock_list *ul_next = l_curr->next;
812 DEBUG(10,(" delete case.\n" ));
814 DLIST_REMOVE(lhead, l_curr);
816 break; /* No more list... */
821 } else if ( (l_curr->start >= lock->start) &&
822 (l_curr->start < lock->start + lock->size) &&
823 (l_curr->start + l_curr->size > lock->start + lock->size) ) {
826 * This range overlaps the existing lock range at the high end.
827 * Truncate by moving start to existing range end and reducing size.
829 /*********************************************
840 **********************************************/
842 l_curr->size = (l_curr->start + l_curr->size) - (lock->start + lock->size);
843 l_curr->start = lock->start + lock->size;
845 DEBUG(10,(" truncate high case: start=%.0f,size=%.0f\n",
846 (double)l_curr->start, (double)l_curr->size ));
848 l_curr = l_curr->next;
850 } else if ( (l_curr->start < lock->start) &&
851 (l_curr->start + l_curr->size > lock->start) &&
852 (l_curr->start + l_curr->size <= lock->start + lock->size) ) {
855 * This range overlaps the existing lock range at the low end.
856 * Truncate by reducing size.
858 /*********************************************
869 **********************************************/
871 l_curr->size = lock->start - l_curr->start;
873 DEBUG(10,(" truncate low case: start=%.0f,size=%.0f\n",
874 (double)l_curr->start, (double)l_curr->size ));
876 l_curr = l_curr->next;
878 } else if ( (l_curr->start < lock->start) &&
879 (l_curr->start + l_curr->size > lock->start + lock->size) ) {
881 * Worst case scenario. Range completely overlaps an existing
882 * lock range. Split the request into two, push the new (upper) request
883 * into the dlink list, and continue with the entry after l_new (as we
884 * know that l_new will not overlap with this lock).
886 /*********************************************
887 +---------------------------+
889 +---------------------------+
894 +-------+ +---------+
896 +-------+ +---------+
897 **********************************************/
898 struct lock_list *l_new = TALLOC_P(ctx, struct lock_list);
901 DEBUG(0,("posix_lock_list: talloc fail.\n"));
902 return NULL; /* The talloc_destroy takes care of cleanup. */
906 l_new->start = lock->start + lock->size;
907 l_new->size = l_curr->start + l_curr->size - l_new->start;
909 /* Truncate the l_curr. */
910 l_curr->size = lock->start - l_curr->start;
912 DEBUG(10,(" split case: curr: start=%.0f,size=%.0f \
913 new: start=%.0f,size=%.0f\n", (double)l_curr->start, (double)l_curr->size,
914 (double)l_new->start, (double)l_new->size ));
917 * Add into the dlink list after the l_curr point - NOT at lhead.
918 * Note we can't use DLINK_ADD here as this inserts at the head of the given list.
921 l_new->prev = l_curr;
922 l_new->next = l_curr->next;
923 l_curr->next = l_new;
925 /* And move after the link we added. */
926 l_curr = l_new->next;
931 * This logic case should never happen. Ensure this is the
932 * case by forcing an abort.... Remove in production.
936 slprintf(msg, sizeof(msg)-1, "logic flaw in cases: l_curr: start = %.0f, size = %.0f : \
937 lock: start = %.0f, size = %.0f\n", (double)l_curr->start, (double)l_curr->size, (double)lock->start, (double)lock->size );
941 } /* end for ( l_curr = lhead; l_curr;) */
942 } /* end for (i=0; i<num_locks && ul_head; i++) */
947 /****************************************************************************
948 POSIX function to acquire a lock. Returns True if the
949 lock could be granted, False if not.
950 ****************************************************************************/
952 BOOL set_posix_lock_windows_flavour(files_struct *fsp,
953 SMB_BIG_UINT u_offset,
954 SMB_BIG_UINT u_count,
955 enum brl_type lock_type,
956 const struct lock_context *lock_ctx,
957 const struct lock_struct *plocks,
963 int posix_lock_type = map_posix_lock_type(fsp,lock_type);
966 TALLOC_CTX *l_ctx = NULL;
967 struct lock_list *llist = NULL;
968 struct lock_list *ll = NULL;
970 DEBUG(5,("set_posix_lock_windows_flavour: File %s, offset = %.0f, count = %.0f, type = %s\n",
971 fsp->fsp_name, (double)u_offset, (double)u_count, posix_lock_type_name(lock_type) ));
974 * If the requested lock won't fit in the POSIX range, we will
975 * pretend it was successful.
978 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
979 increment_windows_lock_ref_count(fsp);
984 * Windows is very strange. It allows read locks to be overlayed
985 * (even over a write lock), but leaves the write lock in force until the first
986 * unlock. It also reference counts the locks. This means the following sequence :
989 * ------------------------------------------------------------------------
990 * WRITE LOCK : start = 2, len = 10
991 * READ LOCK: start =0, len = 10 - FAIL
992 * READ LOCK : start = 0, len = 14
993 * READ LOCK: start =0, len = 10 - FAIL
994 * UNLOCK : start = 2, len = 10
995 * READ LOCK: start =0, len = 10 - OK
997 * Under POSIX, the same sequence in steps 1 and 2 would not be reference counted, but
998 * would leave a single read lock over the 0-14 region.
1001 if ((l_ctx = talloc_init("set_posix_lock")) == NULL) {
1002 DEBUG(0,("set_posix_lock_windows_flavour: unable to init talloc context.\n"));
1006 if ((ll = TALLOC_P(l_ctx, struct lock_list)) == NULL) {
1007 DEBUG(0,("set_posix_lock_windows_flavour: unable to talloc unlock list.\n"));
1008 talloc_destroy(l_ctx);
1013 * Create the initial list entry containing the
1014 * lock we want to add.
1021 DLIST_ADD(llist, ll);
1024 * The following call calculates if there are any
1025 * overlapping locks held by this process on
1026 * fd's open on the same file and splits this list
1027 * into a list of lock ranges that do not overlap with existing
1031 llist = posix_lock_list(l_ctx,
1033 lock_ctx, /* Lock context llist belongs to. */
1039 * Add the POSIX locks on the list of ranges returned.
1040 * As the lock is supposed to be added atomically, we need to
1041 * back out all the locks if any one of these calls fail.
1044 for (lock_count = 0, ll = llist; ll; ll = ll->next, lock_count++) {
1048 DEBUG(5,("set_posix_lock_windows_flavour: Real lock: Type = %s: offset = %.0f, count = %.0f\n",
1049 posix_lock_type_name(posix_lock_type), (double)offset, (double)count ));
1051 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,posix_lock_type)) {
1053 DEBUG(5,("set_posix_lock_windows_flavour: Lock fail !: Type = %s: offset = %.0f, count = %.0f. Errno = %s\n",
1054 posix_lock_type_name(posix_lock_type), (double)offset, (double)count, strerror(errno) ));
1063 * Back out all the POSIX locks we have on fail.
1066 for (ll = llist; lock_count; ll = ll->next, lock_count--) {
1070 DEBUG(5,("set_posix_lock_windows_flavour: Backing out locks: Type = %s: offset = %.0f, count = %.0f\n",
1071 posix_lock_type_name(posix_lock_type), (double)offset, (double)count ));
1073 posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_UNLCK);
1076 /* Remember the number of Windows locks we have on this dev/ino pair. */
1077 increment_windows_lock_ref_count(fsp);
1080 talloc_destroy(l_ctx);
1084 /****************************************************************************
1085 POSIX function to release a lock. Returns True if the
1086 lock could be released, False if not.
1087 ****************************************************************************/
1089 BOOL release_posix_lock_windows_flavour(files_struct *fsp,
1090 SMB_BIG_UINT u_offset,
1091 SMB_BIG_UINT u_count,
1092 enum brl_type deleted_lock_type,
1093 const struct lock_context *lock_ctx,
1094 const struct lock_struct *plocks,
1100 TALLOC_CTX *ul_ctx = NULL;
1101 struct lock_list *ulist = NULL;
1102 struct lock_list *ul = NULL;
1104 DEBUG(5,("release_posix_lock_windows_flavour: File %s, offset = %.0f, count = %.0f\n",
1105 fsp->fsp_name, (double)u_offset, (double)u_count ));
1107 /* Remember the number of Windows locks we have on this dev/ino pair. */
1108 decrement_windows_lock_ref_count(fsp);
1111 * If the requested lock won't fit in the POSIX range, we will
1112 * pretend it was successful.
1115 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
1119 if ((ul_ctx = talloc_init("release_posix_lock")) == NULL) {
1120 DEBUG(0,("release_posix_lock_windows_flavour: unable to init talloc context.\n"));
1124 if ((ul = TALLOC_P(ul_ctx, struct lock_list)) == NULL) {
1125 DEBUG(0,("release_posix_lock_windows_flavour: unable to talloc unlock list.\n"));
1126 talloc_destroy(ul_ctx);
1131 * Create the initial list entry containing the
1132 * lock we want to remove.
1139 DLIST_ADD(ulist, ul);
1142 * The following call calculates if there are any
1143 * overlapping locks held by this process on
1144 * fd's open on the same file and creates a
1145 * list of unlock ranges that will allow
1146 * POSIX lock ranges to remain on the file whilst the
1147 * unlocks are performed.
1150 ulist = posix_lock_list(ul_ctx,
1152 lock_ctx, /* Lock context ulist belongs to. */
1158 * If there were any overlapped entries (list is > 1 or size or start have changed),
1159 * and the lock_type we just deleted from
1160 * the upper layer tdb was a write lock, then before doing the unlock we need to downgrade
1161 * the POSIX lock to a read lock. This allows any overlapping read locks
1162 * to be atomically maintained.
1165 if (deleted_lock_type == WRITE_LOCK &&
1166 (!ulist || ulist->next != NULL || ulist->start != offset || ulist->size != count)) {
1168 DEBUG(5,("release_posix_lock_windows_flavour: downgrading lock to READ: offset = %.0f, count = %.0f\n",
1169 (double)offset, (double)count ));
1171 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_RDLCK)) {
1172 DEBUG(0,("release_posix_lock_windows_flavour: downgrade of lock failed with error %s !\n", strerror(errno) ));
1173 talloc_destroy(ul_ctx);
1179 * Release the POSIX locks on the list of ranges returned.
1182 for(; ulist; ulist = ulist->next) {
1183 offset = ulist->start;
1184 count = ulist->size;
1186 DEBUG(5,("release_posix_lock_windows_flavour: Real unlock: offset = %.0f, count = %.0f\n",
1187 (double)offset, (double)count ));
1189 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_UNLCK)) {
1194 talloc_destroy(ul_ctx);
1198 /****************************************************************************
1199 Next - the functions that deal with mapping CIFS POSIX locks onto
1200 the underlying system POSIX locks.
1201 ****************************************************************************/
1203 /****************************************************************************
1204 POSIX function to acquire a lock. Returns True if the
1205 lock could be granted, False if not.
1206 As POSIX locks don't stack or conflict (they just overwrite)
1207 we can map the requested lock directly onto a system one. We
1208 know it doesn't conflict with locks on other contexts as the
1209 upper layer would have refused it.
1210 ****************************************************************************/
1212 BOOL set_posix_lock_posix_flavour(files_struct *fsp,
1213 SMB_BIG_UINT u_offset,
1214 SMB_BIG_UINT u_count,
1215 enum brl_type lock_type,
1220 int posix_lock_type = map_posix_lock_type(fsp,lock_type);
1222 DEBUG(5,("set_posix_lock_posix_flavour: File %s, offset = %.0f, count = %.0f, type = %s\n",
1223 fsp->fsp_name, (double)u_offset, (double)u_count, posix_lock_type_name(lock_type) ));
1226 * If the requested lock won't fit in the POSIX range, we will
1227 * pretend it was successful.
1230 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
1234 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,posix_lock_type)) {
1236 DEBUG(5,("set_posix_lock_posix_flavour: Lock fail !: Type = %s: offset = %.0f, count = %.0f. Errno = %s\n",
1237 posix_lock_type_name(posix_lock_type), (double)offset, (double)count, strerror(errno) ));
1243 /****************************************************************************
1244 POSIX function to release a lock. Returns True if the
1245 lock could be released, False if not.
1246 We are given a complete lock state from the upper layer which is what the lock
1247 state should be after the unlock has already been done, so what
1248 we do is punch out holes in the unlock range where locks owned by this process
1249 have a different lock context.
1250 ****************************************************************************/
1252 BOOL release_posix_lock_posix_flavour(files_struct *fsp,
1253 SMB_BIG_UINT u_offset,
1254 SMB_BIG_UINT u_count,
1255 const struct lock_context *lock_ctx,
1256 const struct lock_struct *plocks,
1262 TALLOC_CTX *ul_ctx = NULL;
1263 struct lock_list *ulist = NULL;
1264 struct lock_list *ul = NULL;
1266 DEBUG(5,("release_posix_lock_posix_flavour: File %s, offset = %.0f, count = %.0f\n",
1267 fsp->fsp_name, (double)u_offset, (double)u_count ));
1270 * If the requested lock won't fit in the POSIX range, we will
1271 * pretend it was successful.
1274 if(!posix_lock_in_range(&offset, &count, u_offset, u_count)) {
1278 if ((ul_ctx = talloc_init("release_posix_lock")) == NULL) {
1279 DEBUG(0,("release_posix_lock_windows_flavour: unable to init talloc context.\n"));
1283 if ((ul = TALLOC_P(ul_ctx, struct lock_list)) == NULL) {
1284 DEBUG(0,("release_posix_lock_windows_flavour: unable to talloc unlock list.\n"));
1285 talloc_destroy(ul_ctx);
1290 * Create the initial list entry containing the
1291 * lock we want to remove.
1298 DLIST_ADD(ulist, ul);
1301 * Walk the given array creating a linked list
1302 * of unlock requests.
1305 ulist = posix_lock_list(ul_ctx,
1307 lock_ctx, /* Lock context ulist belongs to. */
1313 * Release the POSIX locks on the list of ranges returned.
1316 for(; ulist; ulist = ulist->next) {
1317 offset = ulist->start;
1318 count = ulist->size;
1320 DEBUG(5,("release_posix_lock_posix_flavour: Real unlock: offset = %.0f, count = %.0f\n",
1321 (double)offset, (double)count ));
1323 if (!posix_fcntl_lock(fsp,SMB_F_SETLK,offset,count,F_UNLCK)) {
1328 talloc_destroy(ul_ctx);