2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-2000
5 Copyright (C) Jeremy Allison 1992-2006
6 Copyright (C) Volker Lendecke 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 12 aug 96: Erik.Devriendt@te6.siemens.be
24 added support for shared memory implementation of share mode locking
26 May 1997. Jeremy Allison (jallison@whistle.com). Modified share mode
27 locking to deal with multiple share modes per open file.
29 September 1997. Jeremy Allison (jallison@whistle.com). Added oplock
32 rewrtten completely to use new tdb code. Tridge, Dec '99
34 Added POSIX locking support. Jeremy Allison (jeremy@valinux.com), Apr. 2000.
35 Added Unix Extensions POSIX locking support. Jeremy Allison Mar 2006.
41 #define DBGC_CLASS DBGC_LOCKING
43 #define NO_LOCKING_COUNT (-1)
45 /* the locking database handle */
46 static struct db_context
*lock_db
;
48 /****************************************************************************
50 ****************************************************************************/
52 const char *lock_type_name(enum brl_type lock_type
)
59 case PENDING_READ_LOCK
:
60 return "PENDING_READ";
61 case PENDING_WRITE_LOCK
:
62 return "PENDING_WRITE";
68 const char *lock_flav_name(enum brl_flavour lock_flav
)
70 return (lock_flav
== WINDOWS_LOCK
) ? "WINDOWS_LOCK" : "POSIX_LOCK";
73 /****************************************************************************
74 Utility function called to see if a file region is locked.
75 Called in the read/write codepath.
76 ****************************************************************************/
78 bool is_locked(files_struct
*fsp
,
82 enum brl_type lock_type
)
84 int strict_locking
= lp_strict_locking(fsp
->conn
->params
);
85 enum brl_flavour lock_flav
= lp_posix_cifsu_locktype(fsp
);
92 if (!lp_locking(fsp
->conn
->params
) || !strict_locking
) {
96 if (strict_locking
== Auto
) {
97 if (EXCLUSIVE_OPLOCK_TYPE(fsp
->oplock_type
) && (lock_type
== READ_LOCK
|| lock_type
== WRITE_LOCK
)) {
98 DEBUG(10,("is_locked: optimisation - exclusive oplock on file %s\n", fsp
->fsp_name
));
100 } else if ((fsp
->oplock_type
== LEVEL_II_OPLOCK
) &&
101 (lock_type
== READ_LOCK
)) {
102 DEBUG(10,("is_locked: optimisation - level II oplock on file %s\n", fsp
->fsp_name
));
105 struct byte_range_lock
*br_lck
= brl_get_locks_readonly(NULL
, fsp
);
109 ret
= !brl_locktest(br_lck
,
119 struct byte_range_lock
*br_lck
= brl_get_locks_readonly(NULL
, fsp
);
123 ret
= !brl_locktest(br_lck
,
133 DEBUG(10,("is_locked: flavour = %s brl start=%.0f len=%.0f %s for fnum %d file %s\n",
134 lock_flav_name(lock_flav
),
135 (double)offset
, (double)count
, ret
? "locked" : "unlocked",
136 fsp
->fnum
, fsp
->fsp_name
));
141 /****************************************************************************
142 Find out if a lock could be granted - return who is blocking us if we can't.
143 ****************************************************************************/
145 NTSTATUS
query_lock(files_struct
*fsp
,
147 SMB_BIG_UINT
*pcount
,
148 SMB_BIG_UINT
*poffset
,
149 enum brl_type
*plock_type
,
150 enum brl_flavour lock_flav
)
152 struct byte_range_lock
*br_lck
= NULL
;
153 NTSTATUS status
= NT_STATUS_LOCK_NOT_GRANTED
;
155 if (!fsp
->can_lock
) {
156 return fsp
->is_directory
? NT_STATUS_INVALID_DEVICE_REQUEST
: NT_STATUS_INVALID_HANDLE
;
159 if (!lp_locking(fsp
->conn
->params
)) {
163 br_lck
= brl_get_locks_readonly(NULL
, fsp
);
165 return NT_STATUS_NO_MEMORY
;
168 status
= brl_lockquery(br_lck
,
180 /****************************************************************************
181 Utility function called by locking requests.
182 ****************************************************************************/
184 struct byte_range_lock
*do_lock(struct messaging_context
*msg_ctx
,
189 enum brl_type lock_type
,
190 enum brl_flavour lock_flav
,
195 struct byte_range_lock
*br_lck
= NULL
;
197 if (!fsp
->can_lock
) {
198 *perr
= fsp
->is_directory
? NT_STATUS_INVALID_DEVICE_REQUEST
: NT_STATUS_INVALID_HANDLE
;
202 if (!lp_locking(fsp
->conn
->params
)) {
203 *perr
= NT_STATUS_OK
;
207 /* NOTE! 0 byte long ranges ARE allowed and should be stored */
209 DEBUG(10,("do_lock: lock flavour %s lock type %s start=%.0f len=%.0f requested for fnum %d file %s\n",
210 lock_flav_name(lock_flav
), lock_type_name(lock_type
),
211 (double)offset
, (double)count
, fsp
->fnum
, fsp
->fsp_name
));
213 br_lck
= brl_get_locks(NULL
, fsp
);
215 *perr
= NT_STATUS_NO_MEMORY
;
219 *perr
= brl_lock(msg_ctx
,
230 if (lock_flav
== WINDOWS_LOCK
&&
231 fsp
->current_lock_count
!= NO_LOCKING_COUNT
) {
232 /* blocking ie. pending, locks also count here,
233 * as this is an efficiency counter to avoid checking
234 * the lock db. on close. JRA. */
236 fsp
->current_lock_count
++;
238 /* Notice that this has had a POSIX lock request.
239 * We can't count locks after this so forget them.
241 fsp
->current_lock_count
= NO_LOCKING_COUNT
;
247 /****************************************************************************
248 Utility function called by unlocking requests.
249 ****************************************************************************/
251 NTSTATUS
do_unlock(struct messaging_context
*msg_ctx
,
256 enum brl_flavour lock_flav
)
259 struct byte_range_lock
*br_lck
= NULL
;
261 if (!fsp
->can_lock
) {
262 return fsp
->is_directory
? NT_STATUS_INVALID_DEVICE_REQUEST
: NT_STATUS_INVALID_HANDLE
;
265 if (!lp_locking(fsp
->conn
->params
)) {
269 DEBUG(10,("do_unlock: unlock start=%.0f len=%.0f requested for fnum %d file %s\n",
270 (double)offset
, (double)count
, fsp
->fnum
, fsp
->fsp_name
));
272 br_lck
= brl_get_locks(NULL
, fsp
);
274 return NT_STATUS_NO_MEMORY
;
277 ok
= brl_unlock(msg_ctx
,
288 DEBUG(10,("do_unlock: returning ERRlock.\n" ));
289 return NT_STATUS_RANGE_NOT_LOCKED
;
292 if (lock_flav
== WINDOWS_LOCK
&&
293 fsp
->current_lock_count
!= NO_LOCKING_COUNT
) {
294 SMB_ASSERT(fsp
->current_lock_count
> 0);
295 fsp
->current_lock_count
--;
301 /****************************************************************************
302 Cancel any pending blocked locks.
303 ****************************************************************************/
305 NTSTATUS
do_lock_cancel(files_struct
*fsp
,
309 enum brl_flavour lock_flav
)
312 struct byte_range_lock
*br_lck
= NULL
;
314 if (!fsp
->can_lock
) {
315 return fsp
->is_directory
?
316 NT_STATUS_INVALID_DEVICE_REQUEST
: NT_STATUS_INVALID_HANDLE
;
319 if (!lp_locking(fsp
->conn
->params
)) {
320 return NT_STATUS_DOS(ERRDOS
, ERRcancelviolation
);
323 DEBUG(10,("do_lock_cancel: cancel start=%.0f len=%.0f requested for fnum %d file %s\n",
324 (double)offset
, (double)count
, fsp
->fnum
, fsp
->fsp_name
));
326 br_lck
= brl_get_locks(NULL
, fsp
);
328 return NT_STATUS_NO_MEMORY
;
331 ok
= brl_lock_cancel(br_lck
,
341 DEBUG(10,("do_lock_cancel: returning ERRcancelviolation.\n" ));
342 return NT_STATUS_DOS(ERRDOS
, ERRcancelviolation
);
345 if (lock_flav
== WINDOWS_LOCK
&&
346 fsp
->current_lock_count
!= NO_LOCKING_COUNT
) {
347 SMB_ASSERT(fsp
->current_lock_count
> 0);
348 fsp
->current_lock_count
--;
354 /****************************************************************************
355 Remove any locks on this fd. Called from file_close().
356 ****************************************************************************/
358 void locking_close_file(struct messaging_context
*msg_ctx
,
361 struct byte_range_lock
*br_lck
;
363 if (!lp_locking(fsp
->conn
->params
)) {
367 /* If we have not outstanding locks or pending
368 * locks then we don't need to look in the lock db.
371 if (fsp
->current_lock_count
== 0) {
375 br_lck
= brl_get_locks(NULL
,fsp
);
378 cancel_pending_lock_requests_by_fid(fsp
, br_lck
);
379 brl_close_fnum(msg_ctx
, br_lck
);
384 /****************************************************************************
385 Initialise the locking functions.
386 ****************************************************************************/
388 static bool locking_init_internal(bool read_only
)
395 lock_db
= db_open(NULL
, lock_path("locking.tdb"), 0,
398 |(read_only
?0x0:TDB_CLEAR_IF_FIRST
),
399 read_only
?O_RDONLY
:O_RDWR
|O_CREAT
, 0644);
402 DEBUG(0,("ERROR: Failed to initialise locking database\n"));
406 if (!posix_locking_init(read_only
))
412 bool locking_init(void)
414 return locking_init_internal(false);
417 bool locking_init_readonly(void)
419 return locking_init_internal(true);
422 /*******************************************************************
423 Deinitialize the share_mode management.
424 ******************************************************************/
426 bool locking_end(void)
429 TALLOC_FREE(lock_db
);
433 /*******************************************************************
434 Form a static locking key for a dev/inode pair.
435 ******************************************************************/
437 static TDB_DATA
locking_key(const struct file_id
*id
, struct file_id
*tmp
)
440 return make_tdb_data((const uint8_t *)tmp
, sizeof(*tmp
));
443 /*******************************************************************
444 Print out a share mode.
445 ********************************************************************/
447 char *share_mode_str(TALLOC_CTX
*ctx
, int num
, struct share_mode_entry
*e
)
449 return talloc_asprintf(ctx
, "share_mode_entry[%d]: %s "
450 "pid = %s, share_access = 0x%x, private_options = 0x%x, "
451 "access_mask = 0x%x, mid = 0x%x, type= 0x%x, gen_id = %lu, "
452 "uid = %u, flags = %u, file_id %s",
454 e
->op_type
== UNUSED_SHARE_MODE_ENTRY
? "UNUSED" : "",
455 procid_str_static(&e
->pid
),
456 e
->share_access
, e
->private_options
,
457 e
->access_mask
, e
->op_mid
, e
->op_type
, e
->share_file_id
,
458 (unsigned int)e
->uid
, (unsigned int)e
->flags
,
459 file_id_string_tos(&e
->id
));
462 /*******************************************************************
463 Print out a share mode table.
464 ********************************************************************/
466 static void print_share_mode_table(struct locking_data
*data
)
468 int num_share_modes
= data
->u
.s
.num_share_mode_entries
;
469 struct share_mode_entry
*shares
=
470 (struct share_mode_entry
*)(data
+ 1);
473 for (i
= 0; i
< num_share_modes
; i
++) {
474 struct share_mode_entry entry
;
478 * We need to memcpy the entry here due to alignment
479 * restrictions that are not met when directly accessing
483 memcpy(&entry
, &shares
[i
], sizeof(struct share_mode_entry
));
484 str
= share_mode_str(talloc_tos(), i
, &entry
);
486 DEBUG(10,("print_share_mode_table: %s\n", str
? str
: ""));
491 /*******************************************************************
492 Get all share mode entries for a dev/inode pair.
493 ********************************************************************/
495 static bool parse_share_modes(TDB_DATA dbuf
, struct share_mode_lock
*lck
)
497 struct locking_data
*data
;
500 if (dbuf
.dsize
< sizeof(struct locking_data
)) {
501 smb_panic("parse_share_modes: buffer too short");
504 data
= (struct locking_data
*)dbuf
.dptr
;
506 lck
->delete_on_close
= data
->u
.s
.delete_on_close
;
507 lck
->num_share_modes
= data
->u
.s
.num_share_mode_entries
;
509 DEBUG(10, ("parse_share_modes: delete_on_close: %d, "
510 "num_share_modes: %d\n",
511 lck
->delete_on_close
,
512 lck
->num_share_modes
));
514 if ((lck
->num_share_modes
< 0) || (lck
->num_share_modes
> 1000000)) {
515 DEBUG(0, ("invalid number of share modes: %d\n",
516 lck
->num_share_modes
));
517 smb_panic("parse_share_modes: invalid number of share modes");
520 lck
->share_modes
= NULL
;
522 if (lck
->num_share_modes
!= 0) {
524 if (dbuf
.dsize
< (sizeof(struct locking_data
) +
525 (lck
->num_share_modes
*
526 sizeof(struct share_mode_entry
)))) {
527 smb_panic("parse_share_modes: buffer too short");
530 lck
->share_modes
= (struct share_mode_entry
*)
531 TALLOC_MEMDUP(lck
, dbuf
.dptr
+sizeof(*data
),
532 lck
->num_share_modes
*
533 sizeof(struct share_mode_entry
));
535 if (lck
->share_modes
== NULL
) {
536 smb_panic("parse_share_modes: talloc failed");
540 /* Get any delete token. */
541 if (data
->u
.s
.delete_token_size
) {
542 uint8
*p
= dbuf
.dptr
+ sizeof(*data
) +
543 (lck
->num_share_modes
*
544 sizeof(struct share_mode_entry
));
546 if ((data
->u
.s
.delete_token_size
< sizeof(uid_t
) + sizeof(gid_t
)) ||
547 ((data
->u
.s
.delete_token_size
- sizeof(uid_t
)) % sizeof(gid_t
)) != 0) {
548 DEBUG(0, ("parse_share_modes: invalid token size %d\n",
549 data
->u
.s
.delete_token_size
));
550 smb_panic("parse_share_modes: invalid token size");
553 lck
->delete_token
= TALLOC_P(lck
, UNIX_USER_TOKEN
);
554 if (!lck
->delete_token
) {
555 smb_panic("parse_share_modes: talloc failed");
558 /* Copy out the uid and gid. */
559 memcpy(&lck
->delete_token
->uid
, p
, sizeof(uid_t
));
561 memcpy(&lck
->delete_token
->gid
, p
, sizeof(gid_t
));
564 /* Any supplementary groups ? */
565 lck
->delete_token
->ngroups
= (data
->u
.s
.delete_token_size
> (sizeof(uid_t
) + sizeof(gid_t
))) ?
566 ((data
->u
.s
.delete_token_size
-
567 (sizeof(uid_t
) + sizeof(gid_t
)))/sizeof(gid_t
)) : 0;
569 if (lck
->delete_token
->ngroups
) {
570 /* Make this a talloc child of lck->delete_token. */
571 lck
->delete_token
->groups
= TALLOC_ARRAY(lck
->delete_token
, gid_t
,
572 lck
->delete_token
->ngroups
);
573 if (!lck
->delete_token
) {
574 smb_panic("parse_share_modes: talloc failed");
577 for (i
= 0; i
< lck
->delete_token
->ngroups
; i
++) {
578 memcpy(&lck
->delete_token
->groups
[i
], p
, sizeof(gid_t
));
584 lck
->delete_token
= NULL
;
587 /* Save off the associated service path and filename. */
588 lck
->servicepath
= talloc_strdup(lck
, (const char *)dbuf
.dptr
+ sizeof(*data
) +
589 (lck
->num_share_modes
*
590 sizeof(struct share_mode_entry
)) +
591 data
->u
.s
.delete_token_size
);
592 if (lck
->servicepath
== NULL
) {
593 smb_panic("parse_share_modes: talloc_strdup failed");
596 lck
->filename
= talloc_strdup(lck
, (const char *)dbuf
.dptr
+ sizeof(*data
) +
597 (lck
->num_share_modes
*
598 sizeof(struct share_mode_entry
)) +
599 data
->u
.s
.delete_token_size
+
600 strlen(lck
->servicepath
) + 1 );
601 if (lck
->filename
== NULL
) {
602 smb_panic("parse_share_modes: talloc_strdup failed");
606 * Ensure that each entry has a real process attached.
609 for (i
= 0; i
< lck
->num_share_modes
; i
++) {
610 struct share_mode_entry
*entry_p
= &lck
->share_modes
[i
];
612 if (DEBUGLEVEL
>= 10) {
613 str
= share_mode_str(NULL
, i
, entry_p
);
615 DEBUG(10,("parse_share_modes: %s\n",
617 if (!process_exists(entry_p
->pid
)) {
618 DEBUG(10,("parse_share_modes: deleted %s\n",
620 entry_p
->op_type
= UNUSED_SHARE_MODE_ENTRY
;
621 lck
->modified
= True
;
629 static TDB_DATA
unparse_share_modes(struct share_mode_lock
*lck
)
634 struct locking_data
*data
;
637 uint32 delete_token_size
;
642 for (i
=0; i
<lck
->num_share_modes
; i
++) {
643 if (!is_unused_share_mode_entry(&lck
->share_modes
[i
])) {
648 if (num_valid
== 0) {
652 sp_len
= strlen(lck
->servicepath
);
653 delete_token_size
= (lck
->delete_token
?
654 (sizeof(uid_t
) + sizeof(gid_t
) + (lck
->delete_token
->ngroups
*sizeof(gid_t
))) : 0);
656 result
.dsize
= sizeof(*data
) +
657 lck
->num_share_modes
* sizeof(struct share_mode_entry
) +
660 strlen(lck
->filename
) + 1;
661 result
.dptr
= TALLOC_ARRAY(lck
, uint8
, result
.dsize
);
663 if (result
.dptr
== NULL
) {
664 smb_panic("talloc failed");
667 data
= (struct locking_data
*)result
.dptr
;
669 data
->u
.s
.num_share_mode_entries
= lck
->num_share_modes
;
670 data
->u
.s
.delete_on_close
= lck
->delete_on_close
;
671 data
->u
.s
.delete_token_size
= delete_token_size
;
672 DEBUG(10, ("unparse_share_modes: del: %d, tok = %u, num: %d\n",
673 data
->u
.s
.delete_on_close
,
674 (unsigned int)data
->u
.s
.delete_token_size
,
675 data
->u
.s
.num_share_mode_entries
));
676 memcpy(result
.dptr
+ sizeof(*data
), lck
->share_modes
,
677 sizeof(struct share_mode_entry
)*lck
->num_share_modes
);
678 offset
= sizeof(*data
) +
679 sizeof(struct share_mode_entry
)*lck
->num_share_modes
;
681 /* Store any delete on close token. */
682 if (lck
->delete_token
) {
683 uint8
*p
= result
.dptr
+ offset
;
685 memcpy(p
, &lck
->delete_token
->uid
, sizeof(uid_t
));
688 memcpy(p
, &lck
->delete_token
->gid
, sizeof(gid_t
));
691 for (i
= 0; i
< lck
->delete_token
->ngroups
; i
++) {
692 memcpy(p
, &lck
->delete_token
->groups
[i
], sizeof(gid_t
));
695 offset
= p
- result
.dptr
;
698 safe_strcpy((char *)result
.dptr
+ offset
, lck
->servicepath
,
699 result
.dsize
- offset
- 1);
700 offset
+= sp_len
+ 1;
701 safe_strcpy((char *)result
.dptr
+ offset
, lck
->filename
,
702 result
.dsize
- offset
- 1);
704 if (DEBUGLEVEL
>= 10) {
705 print_share_mode_table(data
);
711 static int share_mode_lock_destructor(struct share_mode_lock
*lck
)
716 if (!lck
->modified
) {
720 data
= unparse_share_modes(lck
);
722 if (data
.dptr
== NULL
) {
724 /* There has been an entry before, delete it */
726 status
= lck
->record
->delete_rec(lck
->record
);
727 if (!NT_STATUS_IS_OK(status
)) {
728 DEBUG(0, ("delete_rec returned %s\n",
730 smb_panic("could not delete share entry");
736 status
= lck
->record
->store(lck
->record
, data
, TDB_REPLACE
);
737 if (!NT_STATUS_IS_OK(status
)) {
738 DEBUG(0, ("store returned %s\n", nt_errstr(status
)));
739 smb_panic("could not store share mode entry");
747 static bool fill_share_mode_lock(struct share_mode_lock
*lck
,
749 const char *servicepath
,
751 TDB_DATA share_mode_data
)
753 /* Ensure we set every field here as the destructor must be
754 valid even if parse_share_modes fails. */
756 lck
->servicepath
= NULL
;
757 lck
->filename
= NULL
;
759 lck
->num_share_modes
= 0;
760 lck
->share_modes
= NULL
;
761 lck
->delete_token
= NULL
;
762 lck
->delete_on_close
= False
;
764 lck
->modified
= False
;
766 lck
->fresh
= (share_mode_data
.dptr
== NULL
);
769 if (fname
== NULL
|| servicepath
== NULL
) {
772 lck
->filename
= talloc_strdup(lck
, fname
);
773 lck
->servicepath
= talloc_strdup(lck
, servicepath
);
774 if (lck
->filename
== NULL
|| lck
->servicepath
== NULL
) {
775 DEBUG(0, ("talloc failed\n"));
779 if (!parse_share_modes(share_mode_data
, lck
)) {
780 DEBUG(0, ("Could not parse share modes\n"));
788 struct share_mode_lock
*get_share_mode_lock(TALLOC_CTX
*mem_ctx
,
789 const struct file_id id
,
790 const char *servicepath
,
793 struct share_mode_lock
*lck
;
795 TDB_DATA key
= locking_key(&id
, &tmp
);
797 if (!(lck
= TALLOC_P(mem_ctx
, struct share_mode_lock
))) {
798 DEBUG(0, ("talloc failed\n"));
802 if (!(lck
->record
= lock_db
->fetch_locked(lock_db
, lck
, key
))) {
803 DEBUG(3, ("Could not lock share entry\n"));
808 if (!fill_share_mode_lock(lck
, id
, servicepath
, fname
,
809 lck
->record
->value
)) {
810 DEBUG(3, ("fill_share_mode_lock failed\n"));
815 talloc_set_destructor(lck
, share_mode_lock_destructor
);
820 struct share_mode_lock
*fetch_share_mode_unlocked(TALLOC_CTX
*mem_ctx
,
821 const struct file_id id
,
822 const char *servicepath
,
825 struct share_mode_lock
*lck
;
827 TDB_DATA key
= locking_key(&id
, &tmp
);
830 if (!(lck
= TALLOC_P(mem_ctx
, struct share_mode_lock
))) {
831 DEBUG(0, ("talloc failed\n"));
835 if (lock_db
->fetch(lock_db
, lck
, key
, &data
) == -1) {
836 DEBUG(3, ("Could not fetch share entry\n"));
841 if (!fill_share_mode_lock(lck
, id
, servicepath
, fname
, data
)) {
842 DEBUG(3, ("fill_share_mode_lock failed\n"));
847 TALLOC_FREE(data
.dptr
);
852 /*******************************************************************
853 Sets the service name and filename for rename.
854 At this point we emit "file renamed" messages to all
855 process id's that have this file open.
856 Based on an initial code idea from SATOH Fumiyasu <fumiya@samba.gr.jp>
857 ********************************************************************/
859 bool rename_share_filename(struct messaging_context
*msg_ctx
,
860 struct share_mode_lock
*lck
,
861 const char *servicepath
,
870 DEBUG(10, ("rename_share_filename: servicepath %s newname %s\n",
871 servicepath
, newname
));
874 * rename_internal_fsp() and rename_internals() add './' to
875 * head of newname if newname does not contain a '/'.
877 while (newname
[0] && newname
[1] && newname
[0] == '.' && newname
[1] == '/') {
881 lck
->servicepath
= talloc_strdup(lck
, servicepath
);
882 lck
->filename
= talloc_strdup(lck
, newname
);
883 if (lck
->filename
== NULL
|| lck
->servicepath
== NULL
) {
884 DEBUG(0, ("rename_share_filename: talloc failed\n"));
887 lck
->modified
= True
;
889 sp_len
= strlen(lck
->servicepath
);
890 fn_len
= strlen(lck
->filename
);
892 msg_len
= MSG_FILE_RENAMED_MIN_SIZE
+ sp_len
+ 1 + fn_len
+ 1;
894 /* Set up the name changed message. */
895 frm
= TALLOC_ARRAY(lck
, char, msg_len
);
900 push_file_id_16(frm
, &lck
->id
);
902 DEBUG(10,("rename_share_filename: msg_len = %u\n", (unsigned int)msg_len
));
904 safe_strcpy(&frm
[16], lck
->servicepath
, sp_len
);
905 safe_strcpy(&frm
[16 + sp_len
+ 1], lck
->filename
, fn_len
);
907 /* Send the messages. */
908 for (i
=0; i
<lck
->num_share_modes
; i
++) {
909 struct share_mode_entry
*se
= &lck
->share_modes
[i
];
910 if (!is_valid_share_mode_entry(se
)) {
913 /* But not to ourselves... */
914 if (procid_is_me(&se
->pid
)) {
918 DEBUG(10,("rename_share_filename: sending rename message to pid %s "
919 "file_id %s sharepath %s newname %s\n",
920 procid_str_static(&se
->pid
),
921 file_id_string_tos(&lck
->id
),
922 lck
->servicepath
, lck
->filename
));
924 messaging_send_buf(msg_ctx
, se
->pid
, MSG_SMB_FILE_RENAME
,
925 (uint8
*)frm
, msg_len
);
931 bool get_delete_on_close_flag(struct file_id id
)
934 struct share_mode_lock
*lck
;
936 if (!(lck
= fetch_share_mode_unlocked(NULL
, id
, NULL
, NULL
))) {
939 result
= lck
->delete_on_close
;
944 bool is_valid_share_mode_entry(const struct share_mode_entry
*e
)
948 if (e
->op_type
== UNUSED_SHARE_MODE_ENTRY
) {
949 /* cope with dead entries from the process not
950 existing. These should not be considered valid,
951 otherwise we end up doing zero timeout sharing
956 num_props
+= ((e
->op_type
== NO_OPLOCK
) ? 1 : 0);
957 num_props
+= (EXCLUSIVE_OPLOCK_TYPE(e
->op_type
) ? 1 : 0);
958 num_props
+= (LEVEL_II_OPLOCK_TYPE(e
->op_type
) ? 1 : 0);
960 SMB_ASSERT(num_props
<= 1);
961 return (num_props
!= 0);
964 bool is_deferred_open_entry(const struct share_mode_entry
*e
)
966 return (e
->op_type
== DEFERRED_OPEN_ENTRY
);
969 bool is_unused_share_mode_entry(const struct share_mode_entry
*e
)
971 return (e
->op_type
== UNUSED_SHARE_MODE_ENTRY
);
974 /*******************************************************************
975 Fill a share mode entry.
976 ********************************************************************/
978 static void fill_share_mode_entry(struct share_mode_entry
*e
,
980 uid_t uid
, uint16 mid
, uint16 op_type
)
983 e
->pid
= procid_self();
984 e
->share_access
= fsp
->share_access
;
985 e
->private_options
= fsp
->fh
->private_options
;
986 e
->access_mask
= fsp
->access_mask
;
988 e
->op_type
= op_type
;
989 e
->time
.tv_sec
= fsp
->open_time
.tv_sec
;
990 e
->time
.tv_usec
= fsp
->open_time
.tv_usec
;
991 e
->id
= fsp
->file_id
;
992 e
->share_file_id
= fsp
->fh
->gen_id
;
993 e
->uid
= (uint32
)uid
;
994 e
->flags
= fsp
->posix_open
? SHARE_MODE_FLAG_POSIX_OPEN
: 0;
997 static void fill_deferred_open_entry(struct share_mode_entry
*e
,
998 const struct timeval request_time
,
999 struct file_id id
, uint16 mid
)
1002 e
->pid
= procid_self();
1004 e
->op_type
= DEFERRED_OPEN_ENTRY
;
1005 e
->time
.tv_sec
= request_time
.tv_sec
;
1006 e
->time
.tv_usec
= request_time
.tv_usec
;
1008 e
->uid
= (uint32
)-1;
1012 static void add_share_mode_entry(struct share_mode_lock
*lck
,
1013 const struct share_mode_entry
*entry
)
1017 for (i
=0; i
<lck
->num_share_modes
; i
++) {
1018 struct share_mode_entry
*e
= &lck
->share_modes
[i
];
1019 if (is_unused_share_mode_entry(e
)) {
1025 if (i
== lck
->num_share_modes
) {
1026 /* No unused entry found */
1027 ADD_TO_ARRAY(lck
, struct share_mode_entry
, *entry
,
1028 &lck
->share_modes
, &lck
->num_share_modes
);
1030 lck
->modified
= True
;
1033 void set_share_mode(struct share_mode_lock
*lck
, files_struct
*fsp
,
1034 uid_t uid
, uint16 mid
, uint16 op_type
, bool initial_delete_on_close_allowed
)
1036 struct share_mode_entry entry
;
1037 fill_share_mode_entry(&entry
, fsp
, uid
, mid
, op_type
);
1038 if (initial_delete_on_close_allowed
) {
1039 entry
.flags
|= SHARE_MODE_ALLOW_INITIAL_DELETE_ON_CLOSE
;
1041 add_share_mode_entry(lck
, &entry
);
1044 void add_deferred_open(struct share_mode_lock
*lck
, uint16 mid
,
1045 struct timeval request_time
,
1048 struct share_mode_entry entry
;
1049 fill_deferred_open_entry(&entry
, request_time
, id
, mid
);
1050 add_share_mode_entry(lck
, &entry
);
1053 /*******************************************************************
1054 Check if two share mode entries are identical, ignoring oplock
1055 and mid info and desired_access. (Removed paranoia test - it's
1056 not automatically a logic error if they are identical. JRA.)
1057 ********************************************************************/
1059 static bool share_modes_identical(struct share_mode_entry
*e1
,
1060 struct share_mode_entry
*e2
)
1062 /* We used to check for e1->share_access == e2->share_access here
1063 as well as the other fields but 2 different DOS or FCB opens
1064 sharing the same share mode entry may validly differ in
1065 fsp->share_access field. */
1067 return (procid_equal(&e1
->pid
, &e2
->pid
) &&
1068 file_id_equal(&e1
->id
, &e2
->id
) &&
1069 e1
->share_file_id
== e2
->share_file_id
);
1072 static bool deferred_open_identical(struct share_mode_entry
*e1
,
1073 struct share_mode_entry
*e2
)
1075 return (procid_equal(&e1
->pid
, &e2
->pid
) &&
1076 (e1
->op_mid
== e2
->op_mid
) &&
1077 file_id_equal(&e1
->id
, &e2
->id
));
1080 static struct share_mode_entry
*find_share_mode_entry(struct share_mode_lock
*lck
,
1081 struct share_mode_entry
*entry
)
1085 for (i
=0; i
<lck
->num_share_modes
; i
++) {
1086 struct share_mode_entry
*e
= &lck
->share_modes
[i
];
1087 if (is_valid_share_mode_entry(entry
) &&
1088 is_valid_share_mode_entry(e
) &&
1089 share_modes_identical(e
, entry
)) {
1092 if (is_deferred_open_entry(entry
) &&
1093 is_deferred_open_entry(e
) &&
1094 deferred_open_identical(e
, entry
)) {
1101 /*******************************************************************
1102 Del the share mode of a file for this process. Return the number of
1104 ********************************************************************/
1106 bool del_share_mode(struct share_mode_lock
*lck
, files_struct
*fsp
)
1108 struct share_mode_entry entry
, *e
;
1110 /* Don't care about the pid owner being correct here - just a search. */
1111 fill_share_mode_entry(&entry
, fsp
, (uid_t
)-1, 0, NO_OPLOCK
);
1113 e
= find_share_mode_entry(lck
, &entry
);
1118 e
->op_type
= UNUSED_SHARE_MODE_ENTRY
;
1119 lck
->modified
= True
;
1123 void del_deferred_open_entry(struct share_mode_lock
*lck
, uint16 mid
)
1125 struct share_mode_entry entry
, *e
;
1127 fill_deferred_open_entry(&entry
, timeval_zero(),
1130 e
= find_share_mode_entry(lck
, &entry
);
1135 e
->op_type
= UNUSED_SHARE_MODE_ENTRY
;
1136 lck
->modified
= True
;
1139 /*******************************************************************
1140 Remove an oplock mid and mode entry from a share mode.
1141 ********************************************************************/
1143 bool remove_share_oplock(struct share_mode_lock
*lck
, files_struct
*fsp
)
1145 struct share_mode_entry entry
, *e
;
1147 /* Don't care about the pid owner being correct here - just a search. */
1148 fill_share_mode_entry(&entry
, fsp
, (uid_t
)-1, 0, NO_OPLOCK
);
1150 e
= find_share_mode_entry(lck
, &entry
);
1156 e
->op_type
= NO_OPLOCK
;
1157 lck
->modified
= True
;
1161 /*******************************************************************
1162 Downgrade a oplock type from exclusive to level II.
1163 ********************************************************************/
1165 bool downgrade_share_oplock(struct share_mode_lock
*lck
, files_struct
*fsp
)
1167 struct share_mode_entry entry
, *e
;
1169 /* Don't care about the pid owner being correct here - just a search. */
1170 fill_share_mode_entry(&entry
, fsp
, (uid_t
)-1, 0, NO_OPLOCK
);
1172 e
= find_share_mode_entry(lck
, &entry
);
1177 e
->op_type
= LEVEL_II_OPLOCK
;
1178 lck
->modified
= True
;
1182 /****************************************************************************
1183 Deal with the internal needs of setting the delete on close flag. Note that
1184 as the tdb locking is recursive, it is safe to call this from within
1185 open_file_ntcreate. JRA.
1186 ****************************************************************************/
1188 NTSTATUS
can_set_delete_on_close(files_struct
*fsp
, bool delete_on_close
,
1191 if (!delete_on_close
) {
1192 return NT_STATUS_OK
;
1196 * Only allow delete on close for writable files.
1199 if ((dosmode
& aRONLY
) &&
1200 !lp_delete_readonly(SNUM(fsp
->conn
))) {
1201 DEBUG(10,("can_set_delete_on_close: file %s delete on close "
1202 "flag set but file attribute is readonly.\n",
1204 return NT_STATUS_CANNOT_DELETE
;
1208 * Only allow delete on close for writable shares.
1211 if (!CAN_WRITE(fsp
->conn
)) {
1212 DEBUG(10,("can_set_delete_on_close: file %s delete on "
1213 "close flag set but write access denied on share.\n",
1215 return NT_STATUS_ACCESS_DENIED
;
1219 * Only allow delete on close for files/directories opened with delete
1223 if (!(fsp
->access_mask
& DELETE_ACCESS
)) {
1224 DEBUG(10,("can_set_delete_on_close: file %s delete on "
1225 "close flag set but delete access denied.\n",
1227 return NT_STATUS_ACCESS_DENIED
;
1230 /* Don't allow delete on close for non-empty directories. */
1231 if (fsp
->is_directory
) {
1232 return can_delete_directory(fsp
->conn
, fsp
->fsp_name
);
1235 return NT_STATUS_OK
;
1238 /****************************************************************************
1239 Do we have an open file handle that created this entry ?
1240 ****************************************************************************/
1242 bool can_set_initial_delete_on_close(const struct share_mode_lock
*lck
)
1246 for (i
=0; i
<lck
->num_share_modes
; i
++) {
1247 if (lck
->share_modes
[i
].flags
& SHARE_MODE_ALLOW_INITIAL_DELETE_ON_CLOSE
) {
1254 /*************************************************************************
1255 Return a talloced copy of a UNIX_USER_TOKEN. NULL on fail.
1256 (Should this be in locking.c.... ?).
1257 *************************************************************************/
1259 static UNIX_USER_TOKEN
*copy_unix_token(TALLOC_CTX
*ctx
, UNIX_USER_TOKEN
*tok
)
1261 UNIX_USER_TOKEN
*cpy
;
1267 cpy
= TALLOC_P(ctx
, UNIX_USER_TOKEN
);
1272 cpy
->uid
= tok
->uid
;
1273 cpy
->gid
= tok
->gid
;
1274 cpy
->ngroups
= tok
->ngroups
;
1276 /* Make this a talloc child of cpy. */
1277 cpy
->groups
= TALLOC_ARRAY(cpy
, gid_t
, tok
->ngroups
);
1281 memcpy(cpy
->groups
, tok
->groups
, tok
->ngroups
* sizeof(gid_t
));
1286 /****************************************************************************
1287 Replace the delete on close token.
1288 ****************************************************************************/
1290 void set_delete_on_close_token(struct share_mode_lock
*lck
, UNIX_USER_TOKEN
*tok
)
1292 /* Ensure there's no token. */
1293 if (lck
->delete_token
) {
1294 TALLOC_FREE(lck
->delete_token
); /* Also deletes groups... */
1295 lck
->delete_token
= NULL
;
1298 /* Copy the new token (can be NULL). */
1299 lck
->delete_token
= copy_unix_token(lck
, tok
);
1300 lck
->modified
= True
;
1303 /****************************************************************************
1304 Sets the delete on close flag over all share modes on this file.
1305 Modify the share mode entry for all files open
1306 on this device and inode to tell other smbds we have
1307 changed the delete on close flag. This will be noticed
1308 in the close code, the last closer will delete the file
1310 This makes a copy of any UNIX_USER_TOKEN into the
1311 lck entry. This function is used when the lock is already granted.
1312 ****************************************************************************/
1314 void set_delete_on_close_lck(struct share_mode_lock
*lck
, bool delete_on_close
, UNIX_USER_TOKEN
*tok
)
1316 if (lck
->delete_on_close
!= delete_on_close
) {
1317 set_delete_on_close_token(lck
, tok
);
1318 lck
->delete_on_close
= delete_on_close
;
1319 if (delete_on_close
) {
1320 SMB_ASSERT(lck
->delete_token
!= NULL
);
1322 lck
->modified
= True
;
1326 bool set_delete_on_close(files_struct
*fsp
, bool delete_on_close
, UNIX_USER_TOKEN
*tok
)
1328 struct share_mode_lock
*lck
;
1330 DEBUG(10,("set_delete_on_close: %s delete on close flag for "
1331 "fnum = %d, file %s\n",
1332 delete_on_close
? "Adding" : "Removing", fsp
->fnum
,
1339 lck
= get_share_mode_lock(NULL
, fsp
->file_id
, NULL
, NULL
);
1344 set_delete_on_close_lck(lck
, delete_on_close
, tok
);
1346 if (fsp
->is_directory
) {
1347 send_stat_cache_delete_message(fsp
->fsp_name
);
1354 /****************************************************************************
1355 Sets the allow initial delete on close flag for this share mode.
1356 ****************************************************************************/
1358 bool set_allow_initial_delete_on_close(struct share_mode_lock
*lck
, files_struct
*fsp
, bool delete_on_close
)
1360 struct share_mode_entry entry
, *e
;
1362 /* Don't care about the pid owner being correct here - just a search. */
1363 fill_share_mode_entry(&entry
, fsp
, (uid_t
)-1, 0, NO_OPLOCK
);
1365 e
= find_share_mode_entry(lck
, &entry
);
1370 if (delete_on_close
) {
1371 e
->flags
|= SHARE_MODE_ALLOW_INITIAL_DELETE_ON_CLOSE
;
1373 e
->flags
&= ~SHARE_MODE_ALLOW_INITIAL_DELETE_ON_CLOSE
;
1375 lck
->modified
= True
;
1379 struct forall_state
{
1380 void (*fn
)(const struct share_mode_entry
*entry
,
1381 const char *sharepath
,
1383 void *private_data
);
1387 static int traverse_fn(struct db_record
*rec
, void *_state
)
1389 struct forall_state
*state
= (struct forall_state
*)_state
;
1390 struct locking_data
*data
;
1391 struct share_mode_entry
*shares
;
1392 const char *sharepath
;
1396 /* Ensure this is a locking_key record. */
1397 if (rec
->key
.dsize
!= sizeof(struct file_id
))
1400 data
= (struct locking_data
*)rec
->value
.dptr
;
1401 shares
= (struct share_mode_entry
*)(rec
->value
.dptr
+ sizeof(*data
));
1402 sharepath
= (const char *)rec
->value
.dptr
+ sizeof(*data
) +
1403 data
->u
.s
.num_share_mode_entries
*sizeof(*shares
) +
1404 data
->u
.s
.delete_token_size
;
1405 fname
= (const char *)rec
->value
.dptr
+ sizeof(*data
) +
1406 data
->u
.s
.num_share_mode_entries
*sizeof(*shares
) +
1407 data
->u
.s
.delete_token_size
+
1408 strlen(sharepath
) + 1;
1410 for (i
=0;i
<data
->u
.s
.num_share_mode_entries
;i
++) {
1411 state
->fn(&shares
[i
], sharepath
, fname
,
1412 state
->private_data
);
1417 /*******************************************************************
1418 Call the specified function on each entry under management by the
1420 ********************************************************************/
1422 int share_mode_forall(void (*fn
)(const struct share_mode_entry
*, const char *,
1423 const char *, void *),
1426 struct forall_state state
;
1428 if (lock_db
== NULL
)
1432 state
.private_data
= private_data
;
1434 return lock_db
->traverse_read(lock_db
, traverse_fn
, (void *)&state
);