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/globals.h"
23 #define VALID_FNUM(fnum) (((fnum) >= 0) && ((fnum) < real_max_open_files))
25 #define FILE_HANDLE_OFFSET 0x1000
27 /****************************************************************************
28 Return a unique number identifying this fsp over the life of this pid.
29 ****************************************************************************/
31 static unsigned long get_gen_count(void)
33 if ((++file_gen_counter) == 0)
34 return ++file_gen_counter;
35 return file_gen_counter;
38 /****************************************************************************
39 Find first available file slot.
40 ****************************************************************************/
42 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
43 files_struct **result)
49 /* we want to give out file handles differently on each new
50 connection because of a common bug in MS clients where they try to
51 reuse a file descriptor from an earlier smb connection. This code
52 increases the chance that the errant client will get an error rather
53 than causing corruption */
54 if (first_file == 0) {
55 first_file = (sys_getpid() ^ (int)time(NULL)) % real_max_open_files;
58 /* TODO: Port the id-tree implementation from Samba4 */
60 i = bitmap_find(file_bmap, first_file);
62 DEBUG(0,("ERROR! Out of file structures\n"));
63 /* TODO: We have to unconditionally return a DOS error here,
64 * W2k3 even returns ERRDOS/ERRnofids for ntcreate&x with
65 * NTSTATUS negotiated */
66 return NT_STATUS_TOO_MANY_OPENED_FILES;
70 * Make a child of the connection_struct as an fsp can't exist
71 * independent of a connection.
73 fsp = talloc_zero(conn, struct files_struct);
75 return NT_STATUS_NO_MEMORY;
79 * This can't be a child of fsp because the file_handle can be ref'd
80 * when doing a dos/fcb open, which will then share the file_handle
81 * across multiple fsps.
83 fsp->fh = talloc_zero(conn, struct fd_handle);
86 return NT_STATUS_NO_MEMORY;
89 fsp->fh->ref_count = 1;
93 fsp->fh->gen_id = get_gen_count();
94 GetTimeOfDay(&fsp->open_time);
96 first_file = (i+1) % real_max_open_files;
98 bitmap_set(file_bmap, i);
101 fsp->fnum = i + FILE_HANDLE_OFFSET;
102 SMB_ASSERT(fsp->fnum < 65536);
105 * Create an smb_filename with "" for the base_name. There are very
106 * few NULL checks, so make sure it's initialized with something. to
107 * be safe until an audit can be done.
109 status = create_synthetic_smb_fname(fsp, "", NULL, NULL,
111 if (!NT_STATUS_IS_OK(status)) {
113 TALLOC_FREE(fsp->fh);
116 DLIST_ADD(conn->sconn->files, fsp);
118 DEBUG(5,("allocated file structure %d, fnum = %d (%d used)\n",
119 i, fsp->fnum, files_used));
122 req->chain_fsp = fsp;
125 /* A new fsp invalidates the positive and
126 negative fsp_fi_cache as the new fsp is pushed
127 at the start of the list and we search from
128 a cache hit to the *end* of the list. */
130 ZERO_STRUCT(fsp_fi_cache);
132 conn->num_files_open++;
138 /****************************************************************************
139 Close all open files for a connection.
140 ****************************************************************************/
142 void file_close_conn(connection_struct *conn)
144 files_struct *fsp, *next;
146 for (fsp=conn->sconn->files; fsp; fsp=next) {
148 if (fsp->conn == conn) {
149 close_file(NULL, fsp, SHUTDOWN_CLOSE);
154 /****************************************************************************
155 Close all open files for a pid and a vuid.
156 ****************************************************************************/
158 void file_close_pid(struct smbd_server_connection *sconn, uint16 smbpid,
161 files_struct *fsp, *next;
163 for (fsp=sconn->files;fsp;fsp=next) {
165 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
166 close_file(NULL, fsp, SHUTDOWN_CLOSE);
171 /****************************************************************************
172 Initialise file structures.
173 ****************************************************************************/
177 int request_max_open_files = lp_max_open_files();
181 * Set the max_open files to be the requested
182 * max plus a fudgefactor to allow for the extra
183 * fd's we need such as log files etc...
185 real_lim = set_maxfiles(request_max_open_files + MAX_OPEN_FUDGEFACTOR);
187 real_max_open_files = real_lim - MAX_OPEN_FUDGEFACTOR;
189 if (real_max_open_files + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES > 65536)
190 real_max_open_files = 65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
192 if(real_max_open_files != request_max_open_files) {
193 DEBUG(1, ("file_init: Information only: requested %d "
194 "open files, %d are available.\n",
195 request_max_open_files, real_max_open_files));
198 SMB_ASSERT(real_max_open_files > 100);
200 file_bmap = bitmap_talloc(talloc_autofree_context(),
201 real_max_open_files);
204 exit_server("out of memory in file_init");
208 /****************************************************************************
209 Close files open by a specified vuid.
210 ****************************************************************************/
212 void file_close_user(struct smbd_server_connection *sconn, int vuid)
214 files_struct *fsp, *next;
216 for (fsp=sconn->files; fsp; fsp=next) {
218 if (fsp->vuid == vuid) {
219 close_file(NULL, fsp, SHUTDOWN_CLOSE);
225 * Walk the files table until "fn" returns non-NULL
228 struct files_struct *files_forall(
229 struct smbd_server_connection *sconn,
230 struct files_struct *(*fn)(struct files_struct *fsp,
234 struct files_struct *fsp, *next;
236 for (fsp = sconn->files; fsp; fsp = next) {
237 struct files_struct *ret;
239 ret = fn(fsp, private_data);
247 /****************************************************************************
248 Find a fsp given a file descriptor.
249 ****************************************************************************/
251 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd)
256 for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
257 if (fsp->fh->fd == fd) {
259 DLIST_PROMOTE(sconn->files, fsp);
268 /****************************************************************************
269 Find a fsp given a device, inode and file_id.
270 ****************************************************************************/
272 files_struct *file_find_dif(struct smbd_server_connection *sconn,
273 struct file_id id, unsigned long gen_id)
278 for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
279 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
280 if (file_id_equal(&fsp->file_id, &id) &&
281 fsp->fh->gen_id == gen_id ) {
283 DLIST_PROMOTE(sconn->files, fsp);
285 /* Paranoia check. */
286 if ((fsp->fh->fd == -1) &&
287 (fsp->oplock_type != NO_OPLOCK) &&
288 (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK)) {
289 DEBUG(0,("file_find_dif: file %s file_id = "
290 "%s, gen = %u oplock_type = %u is a "
291 "stat open with oplock type !\n",
293 file_id_string_tos(&fsp->file_id),
294 (unsigned int)fsp->fh->gen_id,
295 (unsigned int)fsp->oplock_type ));
296 smb_panic("file_find_dif");
305 /****************************************************************************
306 Find the first fsp given a device and inode.
307 We use a singleton cache here to speed up searching from getfilepathinfo
309 ****************************************************************************/
311 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
316 if (file_id_equal(&fsp_fi_cache.id, &id)) {
317 /* Positive or negative cache hit. */
318 return fsp_fi_cache.fsp;
321 fsp_fi_cache.id = id;
323 for (fsp=sconn->files;fsp;fsp=fsp->next) {
324 if (file_id_equal(&fsp->file_id, &id)) {
325 /* Setup positive cache. */
326 fsp_fi_cache.fsp = fsp;
331 /* Setup negative cache. */
332 fsp_fi_cache.fsp = NULL;
336 /****************************************************************************
337 Find the next fsp having the same device and inode.
338 ****************************************************************************/
340 files_struct *file_find_di_next(files_struct *start_fsp)
344 for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
345 if (file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
353 /****************************************************************************
354 Find any fsp open with a pathname below that of an already open path.
355 ****************************************************************************/
357 bool file_find_subpath(files_struct *dir_fsp)
361 char *d_fullname = NULL;
363 d_fullname = talloc_asprintf(talloc_tos(), "%s/%s",
364 dir_fsp->conn->connectpath,
365 dir_fsp->fsp_name->base_name);
371 dlen = strlen(d_fullname);
373 for (fsp=dir_fsp->conn->sconn->files; fsp; fsp=fsp->next) {
376 if (fsp == dir_fsp) {
380 d1_fullname = talloc_asprintf(talloc_tos(),
382 fsp->conn->connectpath,
383 fsp->fsp_name->base_name);
386 * If the open file has a path that is a longer
387 * component, then it's a subpath.
389 if (strnequal(d_fullname, d1_fullname, dlen) &&
390 (d1_fullname[dlen] == '/')) {
391 TALLOC_FREE(d1_fullname);
392 TALLOC_FREE(d_fullname);
395 TALLOC_FREE(d1_fullname);
398 TALLOC_FREE(d_fullname);
402 /****************************************************************************
403 Sync open files on a connection.
404 ****************************************************************************/
406 void file_sync_all(connection_struct *conn)
408 files_struct *fsp, *next;
410 for (fsp=conn->sconn->files; fsp; fsp=next) {
412 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
413 sync_file(conn, fsp, True /* write through */);
418 /****************************************************************************
420 ****************************************************************************/
422 void file_free(struct smb_request *req, files_struct *fsp)
424 DLIST_REMOVE(fsp->conn->sconn->files, fsp);
426 TALLOC_FREE(fsp->fake_file_handle);
428 if (fsp->fh->ref_count == 1) {
429 TALLOC_FREE(fsp->fh);
431 fsp->fh->ref_count--;
435 if (fsp->is_directory) {
436 notify_remove_onelevel(fsp->conn->notify_ctx,
439 notify_remove(fsp->conn->notify_ctx, fsp);
440 TALLOC_FREE(fsp->notify);
443 /* Ensure this event will never fire. */
444 TALLOC_FREE(fsp->oplock_timeout);
446 /* Ensure this event will never fire. */
447 TALLOC_FREE(fsp->update_write_time_event);
449 bitmap_clear(file_bmap, fsp->fnum - FILE_HANDLE_OFFSET);
452 DEBUG(5,("freed files structure %d (%d used)\n",
453 fsp->fnum, files_used));
455 fsp->conn->num_files_open--;
457 if ((req != NULL) && (fsp == req->chain_fsp)) {
458 req->chain_fsp = NULL;
462 * Clear all possible chained fsp
463 * pointers in the SMB2 request queue.
465 if (req != NULL && req->smb2req) {
466 remove_smb2_chained_fsp(fsp);
469 /* Closing a file can invalidate the positive cache. */
470 if (fsp == fsp_fi_cache.fsp) {
471 ZERO_STRUCT(fsp_fi_cache);
474 /* Drop all remaining extensions. */
475 while (fsp->vfs_extension) {
476 vfs_remove_fsp_extension(fsp->vfs_extension->owner, fsp);
479 /* this is paranoia, just in case someone tries to reuse the
483 /* fsp->fsp_name is a talloc child and is free'd automatically. */
487 /****************************************************************************
488 Get an fsp from a 16 bit fnum.
489 ****************************************************************************/
491 static struct files_struct *file_fnum(struct smbd_server_connection *sconn,
497 for (fsp=sconn->files; fsp; fsp=fsp->next, count++) {
498 if (fsp->fnum == fnum) {
500 DLIST_PROMOTE(sconn->files, fsp);
508 /****************************************************************************
509 Get an fsp from a packet given a 16 bit fnum.
510 ****************************************************************************/
512 files_struct *file_fsp(struct smb_request *req, uint16 fid)
518 * We should never get here. req==NULL could in theory
519 * only happen from internal opens with a non-zero
520 * root_dir_fid. Internal opens just don't do that, at
521 * least they are not supposed to do so. And if they
522 * start to do so, they better fake up a smb_request
523 * from which we get the right smbd_server_conn. While
524 * this should never happen, let's return NULL here.
529 if (req->chain_fsp != NULL) {
530 return req->chain_fsp;
533 fsp = file_fnum(req->sconn, fid);
535 req->chain_fsp = fsp;
540 /****************************************************************************
541 Duplicate the file handle part for a DOS or FCB open.
542 ****************************************************************************/
544 NTSTATUS dup_file_fsp(struct smb_request *req, files_struct *from,
545 uint32 access_mask, uint32 share_access,
546 uint32 create_options, files_struct *to)
553 to->file_id = from->file_id;
554 to->initial_allocation_size = from->initial_allocation_size;
555 to->mode = from->mode;
556 to->file_pid = from->file_pid;
557 to->vuid = from->vuid;
558 to->open_time = from->open_time;
559 to->access_mask = access_mask;
560 to->share_access = share_access;
561 to->oplock_type = from->oplock_type;
562 to->can_lock = from->can_lock;
563 to->can_read = (access_mask & (FILE_READ_DATA)) ? True : False;
564 if (!CAN_WRITE(from->conn)) {
565 to->can_write = False;
567 to->can_write = (access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) ? True : False;
569 to->modified = from->modified;
570 to->is_directory = from->is_directory;
571 to->aio_write_behind = from->aio_write_behind;
573 if (from->print_file) {
574 to->print_file = talloc(to, struct print_file_data);
575 if (!to->print_file) return NT_STATUS_NO_MEMORY;
576 to->print_file->rap_jobid = from->print_file->rap_jobid;
578 to->print_file = NULL;
581 return fsp_set_smb_fname(to, from->fsp_name);
585 * The only way that the fsp->fsp_name field should ever be set.
587 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
588 const struct smb_filename *smb_fname_in)
591 struct smb_filename *smb_fname_new;
593 status = copy_smb_filename(fsp, smb_fname_in, &smb_fname_new);
594 if (!NT_STATUS_IS_OK(status)) {
598 TALLOC_FREE(fsp->fsp_name);
599 fsp->fsp_name = smb_fname_new;