2 Unix SMB/CIFS implementation.
3 Files[] structure handling
4 Copyright (C) Andrew Tridgell 1998
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "smbd/smbd.h"
22 #include "smbd/globals.h"
23 #include "libcli/security/security.h"
25 #include <ccan/hash/hash.h>
26 #include "lib/util/bitmap.h"
28 #define VALID_FNUM(fnum) (((fnum) >= 0) && ((fnum) < real_max_open_files))
30 #define FILE_HANDLE_OFFSET 0x1000
32 /****************************************************************************
33 Return a unique number identifying this fsp over the life of this pid.
34 ****************************************************************************/
36 static unsigned long get_gen_count(struct smbd_server_connection
*sconn
)
38 sconn
->file_gen_counter
+= 1;
39 if (sconn
->file_gen_counter
== 0) {
40 sconn
->file_gen_counter
+= 1;
42 return sconn
->file_gen_counter
;
45 /****************************************************************************
46 Find first available file slot.
47 ****************************************************************************/
49 NTSTATUS
file_new(struct smb_request
*req
, connection_struct
*conn
,
50 files_struct
**result
)
52 struct smbd_server_connection
*sconn
= conn
->sconn
;
57 /* we want to give out file handles differently on each new
58 connection because of a common bug in MS clients where they try to
59 reuse a file descriptor from an earlier smb connection. This code
60 increases the chance that the errant client will get an error rather
61 than causing corruption */
62 if (sconn
->first_file
== 0) {
63 sconn
->first_file
= (sys_getpid() ^ (int)time(NULL
));
64 sconn
->first_file
%= sconn
->real_max_open_files
;
67 /* TODO: Port the id-tree implementation from Samba4 */
69 i
= bitmap_find(sconn
->file_bmap
, sconn
->first_file
);
71 DEBUG(0,("ERROR! Out of file structures\n"));
72 /* TODO: We have to unconditionally return a DOS error here,
73 * W2k3 even returns ERRDOS/ERRnofids for ntcreate&x with
74 * NTSTATUS negotiated */
75 return NT_STATUS_TOO_MANY_OPENED_FILES
;
79 * Make a child of the connection_struct as an fsp can't exist
80 * independent of a connection.
82 fsp
= talloc_zero(conn
, struct files_struct
);
84 return NT_STATUS_NO_MEMORY
;
88 * This can't be a child of fsp because the file_handle can be ref'd
89 * when doing a dos/fcb open, which will then share the file_handle
90 * across multiple fsps.
92 fsp
->fh
= talloc_zero(conn
, struct fd_handle
);
95 return NT_STATUS_NO_MEMORY
;
98 fsp
->fh
->ref_count
= 1;
102 fsp
->fh
->gen_id
= get_gen_count(sconn
);
103 GetTimeOfDay(&fsp
->open_time
);
105 sconn
->first_file
= (i
+1) % (sconn
->real_max_open_files
);
107 bitmap_set(sconn
->file_bmap
, i
);
108 sconn
->files_used
+= 1;
110 fsp
->fnum
= i
+ FILE_HANDLE_OFFSET
;
111 SMB_ASSERT(fsp
->fnum
< 65536);
114 * Create an smb_filename with "" for the base_name. There are very
115 * few NULL checks, so make sure it's initialized with something. to
116 * be safe until an audit can be done.
118 status
= create_synthetic_smb_fname(fsp
, "", NULL
, NULL
,
120 if (!NT_STATUS_IS_OK(status
)) {
122 TALLOC_FREE(fsp
->fh
);
125 DLIST_ADD(sconn
->files
, fsp
);
127 DEBUG(5,("allocated file structure %d, fnum = %d (%d used)\n",
128 i
, fsp
->fnum
, sconn
->files_used
));
131 req
->chain_fsp
= fsp
;
134 /* A new fsp invalidates the positive and
135 negative fsp_fi_cache as the new fsp is pushed
136 at the start of the list and we search from
137 a cache hit to the *end* of the list. */
139 ZERO_STRUCT(sconn
->fsp_fi_cache
);
141 conn
->num_files_open
++;
147 /****************************************************************************
148 Close all open files for a connection.
149 ****************************************************************************/
151 void file_close_conn(connection_struct
*conn
)
153 files_struct
*fsp
, *next
;
155 for (fsp
=conn
->sconn
->files
; fsp
; fsp
=next
) {
157 if (fsp
->conn
== conn
) {
158 close_file(NULL
, fsp
, SHUTDOWN_CLOSE
);
163 /****************************************************************************
164 Close all open files for a pid and a vuid.
165 ****************************************************************************/
167 void file_close_pid(struct smbd_server_connection
*sconn
, uint16 smbpid
,
170 files_struct
*fsp
, *next
;
172 for (fsp
=sconn
->files
;fsp
;fsp
=next
) {
174 if ((fsp
->file_pid
== smbpid
) && (fsp
->vuid
== vuid
)) {
175 close_file(NULL
, fsp
, SHUTDOWN_CLOSE
);
180 /****************************************************************************
181 Initialise file structures.
182 ****************************************************************************/
184 bool file_init(struct smbd_server_connection
*sconn
)
186 int request_max_open_files
= lp_max_open_files();
190 * Set the max_open files to be the requested
191 * max plus a fudgefactor to allow for the extra
192 * fd's we need such as log files etc...
194 real_lim
= set_maxfiles(request_max_open_files
+ MAX_OPEN_FUDGEFACTOR
);
196 sconn
->real_max_open_files
= real_lim
- MAX_OPEN_FUDGEFACTOR
;
198 if (sconn
->real_max_open_files
+ FILE_HANDLE_OFFSET
+ MAX_OPEN_PIPES
200 sconn
->real_max_open_files
=
201 65536 - FILE_HANDLE_OFFSET
- MAX_OPEN_PIPES
;
203 if(sconn
->real_max_open_files
!= request_max_open_files
) {
204 DEBUG(1, ("file_init: Information only: requested %d "
205 "open files, %d are available.\n",
206 request_max_open_files
, sconn
->real_max_open_files
));
209 SMB_ASSERT(sconn
->real_max_open_files
> 100);
211 sconn
->file_bmap
= bitmap_talloc(sconn
, sconn
->real_max_open_files
);
213 if (!sconn
->file_bmap
) {
219 /****************************************************************************
220 Close files open by a specified vuid.
221 ****************************************************************************/
223 void file_close_user(struct smbd_server_connection
*sconn
, int vuid
)
225 files_struct
*fsp
, *next
;
227 for (fsp
=sconn
->files
; fsp
; fsp
=next
) {
229 if (fsp
->vuid
== vuid
) {
230 close_file(NULL
, fsp
, SHUTDOWN_CLOSE
);
236 * Walk the files table until "fn" returns non-NULL
239 struct files_struct
*files_forall(
240 struct smbd_server_connection
*sconn
,
241 struct files_struct
*(*fn
)(struct files_struct
*fsp
,
245 struct files_struct
*fsp
, *next
;
247 for (fsp
= sconn
->files
; fsp
; fsp
= next
) {
248 struct files_struct
*ret
;
250 ret
= fn(fsp
, private_data
);
258 /****************************************************************************
259 Find a fsp given a file descriptor.
260 ****************************************************************************/
262 files_struct
*file_find_fd(struct smbd_server_connection
*sconn
, int fd
)
267 for (fsp
=sconn
->files
; fsp
; fsp
=fsp
->next
,count
++) {
268 if (fsp
->fh
->fd
== fd
) {
270 DLIST_PROMOTE(sconn
->files
, fsp
);
279 /****************************************************************************
280 Find a fsp given a device, inode and file_id.
281 ****************************************************************************/
283 files_struct
*file_find_dif(struct smbd_server_connection
*sconn
,
284 struct file_id id
, unsigned long gen_id
)
289 for (fsp
=sconn
->files
; fsp
; fsp
=fsp
->next
,count
++) {
290 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
291 if (file_id_equal(&fsp
->file_id
, &id
) &&
292 fsp
->fh
->gen_id
== gen_id
) {
294 DLIST_PROMOTE(sconn
->files
, fsp
);
296 /* Paranoia check. */
297 if ((fsp
->fh
->fd
== -1) &&
298 (fsp
->oplock_type
!= NO_OPLOCK
) &&
299 (fsp
->oplock_type
!= FAKE_LEVEL_II_OPLOCK
)) {
300 DEBUG(0,("file_find_dif: file %s file_id = "
301 "%s, gen = %u oplock_type = %u is a "
302 "stat open with oplock type !\n",
304 file_id_string_tos(&fsp
->file_id
),
305 (unsigned int)fsp
->fh
->gen_id
,
306 (unsigned int)fsp
->oplock_type
));
307 smb_panic("file_find_dif");
316 /****************************************************************************
317 Find the first fsp given a device and inode.
318 We use a singleton cache here to speed up searching from getfilepathinfo
320 ****************************************************************************/
322 files_struct
*file_find_di_first(struct smbd_server_connection
*sconn
,
327 if (file_id_equal(&sconn
->fsp_fi_cache
.id
, &id
)) {
328 /* Positive or negative cache hit. */
329 return sconn
->fsp_fi_cache
.fsp
;
332 sconn
->fsp_fi_cache
.id
= id
;
334 for (fsp
=sconn
->files
;fsp
;fsp
=fsp
->next
) {
335 if (file_id_equal(&fsp
->file_id
, &id
)) {
336 /* Setup positive cache. */
337 sconn
->fsp_fi_cache
.fsp
= fsp
;
342 /* Setup negative cache. */
343 sconn
->fsp_fi_cache
.fsp
= NULL
;
347 /****************************************************************************
348 Find the next fsp having the same device and inode.
349 ****************************************************************************/
351 files_struct
*file_find_di_next(files_struct
*start_fsp
)
355 for (fsp
= start_fsp
->next
;fsp
;fsp
=fsp
->next
) {
356 if (file_id_equal(&fsp
->file_id
, &start_fsp
->file_id
)) {
364 /****************************************************************************
365 Find any fsp open with a pathname below that of an already open path.
366 ****************************************************************************/
368 bool file_find_subpath(files_struct
*dir_fsp
)
372 char *d_fullname
= NULL
;
374 d_fullname
= talloc_asprintf(talloc_tos(), "%s/%s",
375 dir_fsp
->conn
->connectpath
,
376 dir_fsp
->fsp_name
->base_name
);
382 dlen
= strlen(d_fullname
);
384 for (fsp
=dir_fsp
->conn
->sconn
->files
; fsp
; fsp
=fsp
->next
) {
387 if (fsp
== dir_fsp
) {
391 d1_fullname
= talloc_asprintf(talloc_tos(),
393 fsp
->conn
->connectpath
,
394 fsp
->fsp_name
->base_name
);
397 * If the open file has a path that is a longer
398 * component, then it's a subpath.
400 if (strnequal(d_fullname
, d1_fullname
, dlen
) &&
401 (d1_fullname
[dlen
] == '/')) {
402 TALLOC_FREE(d1_fullname
);
403 TALLOC_FREE(d_fullname
);
406 TALLOC_FREE(d1_fullname
);
409 TALLOC_FREE(d_fullname
);
413 /****************************************************************************
414 Sync open files on a connection.
415 ****************************************************************************/
417 void file_sync_all(connection_struct
*conn
)
419 files_struct
*fsp
, *next
;
421 for (fsp
=conn
->sconn
->files
; fsp
; fsp
=next
) {
423 if ((conn
== fsp
->conn
) && (fsp
->fh
->fd
!= -1)) {
424 sync_file(conn
, fsp
, True
/* write through */);
429 /****************************************************************************
431 ****************************************************************************/
433 void file_free(struct smb_request
*req
, files_struct
*fsp
)
435 struct smbd_server_connection
*sconn
= fsp
->conn
->sconn
;
437 DLIST_REMOVE(sconn
->files
, fsp
);
439 TALLOC_FREE(fsp
->fake_file_handle
);
441 if (fsp
->fh
->ref_count
== 1) {
442 TALLOC_FREE(fsp
->fh
);
444 fsp
->fh
->ref_count
--;
448 if (fsp
->is_directory
) {
449 notify_remove_onelevel(fsp
->conn
->notify_ctx
,
452 notify_remove(fsp
->conn
->notify_ctx
, fsp
);
453 TALLOC_FREE(fsp
->notify
);
456 /* Ensure this event will never fire. */
457 TALLOC_FREE(fsp
->oplock_timeout
);
459 /* Ensure this event will never fire. */
460 TALLOC_FREE(fsp
->update_write_time_event
);
462 bitmap_clear(sconn
->file_bmap
, fsp
->fnum
- FILE_HANDLE_OFFSET
);
465 DEBUG(5,("freed files structure %d (%d used)\n",
466 fsp
->fnum
, sconn
->files_used
));
468 fsp
->conn
->num_files_open
--;
470 if ((req
!= NULL
) && (fsp
== req
->chain_fsp
)) {
471 req
->chain_fsp
= NULL
;
475 * Clear all possible chained fsp
476 * pointers in the SMB2 request queue.
478 if (req
!= NULL
&& req
->smb2req
) {
479 remove_smb2_chained_fsp(fsp
);
482 /* Closing a file can invalidate the positive cache. */
483 if (fsp
== sconn
->fsp_fi_cache
.fsp
) {
484 ZERO_STRUCT(sconn
->fsp_fi_cache
);
487 /* Drop all remaining extensions. */
488 while (fsp
->vfs_extension
) {
489 vfs_remove_fsp_extension(fsp
->vfs_extension
->owner
, fsp
);
492 /* this is paranoia, just in case someone tries to reuse the
496 /* fsp->fsp_name is a talloc child and is free'd automatically. */
500 /****************************************************************************
501 Get an fsp from a 16 bit fnum.
502 ****************************************************************************/
504 static struct files_struct
*file_fnum(struct smbd_server_connection
*sconn
,
510 for (fsp
=sconn
->files
; fsp
; fsp
=fsp
->next
, count
++) {
511 if (fsp
->fnum
== fnum
) {
513 DLIST_PROMOTE(sconn
->files
, fsp
);
521 /****************************************************************************
522 Get an fsp from a packet given a 16 bit fnum.
523 ****************************************************************************/
525 files_struct
*file_fsp(struct smb_request
*req
, uint16 fid
)
531 * We should never get here. req==NULL could in theory
532 * only happen from internal opens with a non-zero
533 * root_dir_fid. Internal opens just don't do that, at
534 * least they are not supposed to do so. And if they
535 * start to do so, they better fake up a smb_request
536 * from which we get the right smbd_server_conn. While
537 * this should never happen, let's return NULL here.
542 if (req
->chain_fsp
!= NULL
) {
543 return req
->chain_fsp
;
546 fsp
= file_fnum(req
->sconn
, fid
);
548 req
->chain_fsp
= fsp
;
553 /****************************************************************************
554 Duplicate the file handle part for a DOS or FCB open.
555 ****************************************************************************/
557 NTSTATUS
dup_file_fsp(struct smb_request
*req
, files_struct
*from
,
558 uint32 access_mask
, uint32 share_access
,
559 uint32 create_options
, files_struct
*to
)
566 to
->file_id
= from
->file_id
;
567 to
->initial_allocation_size
= from
->initial_allocation_size
;
568 to
->file_pid
= from
->file_pid
;
569 to
->vuid
= from
->vuid
;
570 to
->open_time
= from
->open_time
;
571 to
->access_mask
= access_mask
;
572 to
->share_access
= share_access
;
573 to
->oplock_type
= from
->oplock_type
;
574 to
->can_lock
= from
->can_lock
;
575 to
->can_read
= (access_mask
& (FILE_READ_DATA
)) ? True
: False
;
576 if (!CAN_WRITE(from
->conn
)) {
577 to
->can_write
= False
;
579 to
->can_write
= (access_mask
& (FILE_WRITE_DATA
| FILE_APPEND_DATA
)) ? True
: False
;
581 to
->modified
= from
->modified
;
582 to
->is_directory
= from
->is_directory
;
583 to
->aio_write_behind
= from
->aio_write_behind
;
585 if (from
->print_file
) {
586 to
->print_file
= talloc(to
, struct print_file_data
);
587 if (!to
->print_file
) return NT_STATUS_NO_MEMORY
;
588 to
->print_file
->rap_jobid
= from
->print_file
->rap_jobid
;
590 to
->print_file
= NULL
;
593 return fsp_set_smb_fname(to
, from
->fsp_name
);
597 * Return a jenkins hash of a pathname on a connection.
600 NTSTATUS
file_name_hash(connection_struct
*conn
,
601 const char *name
, uint32_t *p_name_hash
)
603 char *fullpath
= NULL
;
605 /* Set the hash of the full pathname. */
606 fullpath
= talloc_asprintf(talloc_tos(),
611 return NT_STATUS_NO_MEMORY
;
613 *p_name_hash
= hash(fullpath
, strlen(fullpath
) + 1, 0);
615 DEBUG(10,("file_name_hash: %s hash 0x%x\n",
617 (unsigned int)*p_name_hash
));
619 TALLOC_FREE(fullpath
);
624 * The only way that the fsp->fsp_name field should ever be set.
626 NTSTATUS
fsp_set_smb_fname(struct files_struct
*fsp
,
627 const struct smb_filename
*smb_fname_in
)
630 struct smb_filename
*smb_fname_new
;
632 status
= copy_smb_filename(fsp
, smb_fname_in
, &smb_fname_new
);
633 if (!NT_STATUS_IS_OK(status
)) {
637 TALLOC_FREE(fsp
->fsp_name
);
638 fsp
->fsp_name
= smb_fname_new
;
640 return file_name_hash(fsp
->conn
,
641 smb_fname_str_dbg(fsp
->fsp_name
),