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/>.
22 static int real_max_open_files;
24 #define VALID_FNUM(fnum) (((fnum) >= 0) && ((fnum) < real_max_open_files))
26 #define FILE_HANDLE_OFFSET 0x1000
28 static struct bitmap *file_bmap;
30 static files_struct *Files;
32 static int files_used;
34 /* A singleton cache to speed up searching by dev/inode. */
35 static struct fsp_singleton_cache {
40 /****************************************************************************
41 Return a unique number identifying this fsp over the life of this pid.
42 ****************************************************************************/
44 static unsigned long get_gen_count(void)
46 static unsigned long file_gen_counter;
48 if ((++file_gen_counter) == 0)
49 return ++file_gen_counter;
50 return file_gen_counter;
53 /****************************************************************************
54 Find first available file slot.
55 ****************************************************************************/
57 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
58 files_struct **result)
61 static int first_file;
64 /* we want to give out file handles differently on each new
65 connection because of a common bug in MS clients where they try to
66 reuse a file descriptor from an earlier smb connection. This code
67 increases the chance that the errant client will get an error rather
68 than causing corruption */
69 if (first_file == 0) {
70 first_file = (sys_getpid() ^ (int)time(NULL)) % real_max_open_files;
73 /* TODO: Port the id-tree implementation from Samba4 */
75 i = bitmap_find(file_bmap, first_file);
77 DEBUG(0,("ERROR! Out of file structures\n"));
78 /* TODO: We have to unconditionally return a DOS error here,
79 * W2k3 even returns ERRDOS/ERRnofids for ntcreate&x with
80 * NTSTATUS negotiated */
81 return NT_STATUS_TOO_MANY_OPENED_FILES;
84 fsp = SMB_MALLOC_P(files_struct);
86 return NT_STATUS_NO_MEMORY;
91 fsp->fh = SMB_MALLOC_P(struct fd_handle);
94 return NT_STATUS_NO_MEMORY;
97 ZERO_STRUCTP(fsp->fh);
99 fsp->fh->ref_count = 1;
103 fsp->fh->gen_id = get_gen_count();
104 GetTimeOfDay(&fsp->open_time);
106 first_file = (i+1) % real_max_open_files;
108 bitmap_set(file_bmap, i);
111 fsp->fnum = i + FILE_HANDLE_OFFSET;
112 SMB_ASSERT(fsp->fnum < 65536);
114 string_set(&fsp->fsp_name,"");
116 DLIST_ADD(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);
136 /****************************************************************************
137 Close all open files for a connection.
138 ****************************************************************************/
140 void file_close_conn(connection_struct *conn)
142 files_struct *fsp, *next;
144 for (fsp=Files;fsp;fsp=next) {
146 if (fsp->conn == conn) {
147 close_file(NULL, fsp, SHUTDOWN_CLOSE);
152 /****************************************************************************
153 Close all open files for a pid and a vuid.
154 ****************************************************************************/
156 void file_close_pid(uint16 smbpid, int vuid)
158 files_struct *fsp, *next;
160 for (fsp=Files;fsp;fsp=next) {
162 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
163 close_file(NULL, fsp, SHUTDOWN_CLOSE);
168 /****************************************************************************
169 Initialise file structures.
170 ****************************************************************************/
172 #define MAX_OPEN_FUDGEFACTOR 20
176 int request_max_open_files = lp_max_open_files();
180 * Set the max_open files to be the requested
181 * max plus a fudgefactor to allow for the extra
182 * fd's we need such as log files etc...
184 real_lim = set_maxfiles(request_max_open_files + MAX_OPEN_FUDGEFACTOR);
186 real_max_open_files = real_lim - MAX_OPEN_FUDGEFACTOR;
188 if (real_max_open_files + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES > 65536)
189 real_max_open_files = 65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
191 if(real_max_open_files != request_max_open_files) {
192 DEBUG(1,("file_init: Information only: requested %d \
193 open files, %d are available.\n", request_max_open_files, real_max_open_files));
196 SMB_ASSERT(real_max_open_files > 100);
198 file_bmap = bitmap_allocate(real_max_open_files);
201 exit_server("out of memory in file_init");
205 * Ensure that pipe_handle_oppset is set correctly.
207 set_pipe_handle_offset(real_max_open_files);
210 /****************************************************************************
211 Close files open by a specified vuid.
212 ****************************************************************************/
214 void file_close_user(int vuid)
216 files_struct *fsp, *next;
218 for (fsp=Files;fsp;fsp=next) {
220 if (fsp->vuid == vuid) {
221 close_file(NULL, fsp, SHUTDOWN_CLOSE);
226 /****************************************************************************
227 Debug to enumerate all open files in the smbd.
228 ****************************************************************************/
230 void file_dump_open_table(void)
235 for (fsp=Files;fsp;fsp=fsp->next,count++) {
236 DEBUG(10,("Files[%d], fnum = %d, name %s, fd = %d, gen = %lu, fileid=%s\n",
237 count, fsp->fnum, fsp->fsp_name, fsp->fh->fd, (unsigned long)fsp->fh->gen_id,
238 file_id_string_tos(&fsp->file_id)));
242 /****************************************************************************
243 Find a fsp given a file descriptor.
244 ****************************************************************************/
246 files_struct *file_find_fd(int fd)
251 for (fsp=Files;fsp;fsp=fsp->next,count++) {
252 if (fsp->fh->fd == fd) {
254 DLIST_PROMOTE(Files, fsp);
263 /****************************************************************************
264 Find a fsp given a device, inode and file_id.
265 ****************************************************************************/
267 files_struct *file_find_dif(struct file_id id, unsigned long gen_id)
272 for (fsp=Files;fsp;fsp=fsp->next,count++) {
273 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
274 if (file_id_equal(&fsp->file_id, &id) &&
275 fsp->fh->gen_id == gen_id ) {
277 DLIST_PROMOTE(Files, fsp);
279 /* Paranoia check. */
280 if ((fsp->fh->fd == -1) &&
281 (fsp->oplock_type != NO_OPLOCK) &&
282 (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK)) {
283 DEBUG(0,("file_find_dif: file %s file_id = %s, gen = %u \
284 oplock_type = %u is a stat open with oplock type !\n", fsp->fsp_name,
285 file_id_string_tos(&fsp->file_id),
286 (unsigned int)fsp->fh->gen_id,
287 (unsigned int)fsp->oplock_type ));
288 smb_panic("file_find_dif");
297 /****************************************************************************
298 Check if an fsp still exists.
299 ****************************************************************************/
301 files_struct *file_find_fsp(files_struct *orig_fsp)
305 for (fsp=Files;fsp;fsp=fsp->next) {
313 /****************************************************************************
314 Find the first fsp given a device and inode.
315 We use a singleton cache here to speed up searching from getfilepathinfo
317 ****************************************************************************/
319 files_struct *file_find_di_first(struct file_id id)
323 if (file_id_equal(&fsp_fi_cache.id, &id)) {
324 /* Positive or negative cache hit. */
325 return fsp_fi_cache.fsp;
328 fsp_fi_cache.id = id;
330 for (fsp=Files;fsp;fsp=fsp->next) {
331 if (file_id_equal(&fsp->file_id, &id)) {
332 /* Setup positive cache. */
333 fsp_fi_cache.fsp = fsp;
338 /* Setup negative cache. */
339 fsp_fi_cache.fsp = NULL;
343 /****************************************************************************
344 Find the next fsp having the same device and inode.
345 ****************************************************************************/
347 files_struct *file_find_di_next(files_struct *start_fsp)
351 for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
352 if (file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
360 /****************************************************************************
361 Find a fsp that is open for printing.
362 ****************************************************************************/
364 files_struct *file_find_print(void)
368 for (fsp=Files;fsp;fsp=fsp->next) {
369 if (fsp->print_file) {
377 /****************************************************************************
378 Sync open files on a connection.
379 ****************************************************************************/
381 void file_sync_all(connection_struct *conn)
383 files_struct *fsp, *next;
385 for (fsp=Files;fsp;fsp=next) {
387 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
388 sync_file(conn, fsp, True /* write through */);
393 /****************************************************************************
395 ****************************************************************************/
397 void file_free(struct smb_request *req, files_struct *fsp)
399 DLIST_REMOVE(Files, fsp);
401 string_free(&fsp->fsp_name);
403 TALLOC_FREE(fsp->fake_file_handle);
405 if (fsp->fh->ref_count == 1) {
408 fsp->fh->ref_count--;
412 notify_remove(fsp->conn->notify_ctx, fsp);
413 TALLOC_FREE(fsp->notify);
416 /* Ensure this event will never fire. */
417 TALLOC_FREE(fsp->oplock_timeout);
419 /* Ensure this event will never fire. */
420 TALLOC_FREE(fsp->update_write_time_event);
422 bitmap_clear(file_bmap, fsp->fnum - FILE_HANDLE_OFFSET);
425 DEBUG(5,("freed files structure %d (%d used)\n",
426 fsp->fnum, files_used));
428 /* this is paranoia, just in case someone tries to reuse the
432 if ((req != NULL) && (fsp == req->chain_fsp)) {
433 req->chain_fsp = NULL;
436 /* Closing a file can invalidate the positive cache. */
437 if (fsp == fsp_fi_cache.fsp) {
438 ZERO_STRUCT(fsp_fi_cache);
441 /* Drop all remaining extensions. */
442 while (fsp->vfs_extension) {
443 vfs_remove_fsp_extension(fsp->vfs_extension->owner, fsp);
449 /****************************************************************************
450 Get an fsp from a 16 bit fnum.
451 ****************************************************************************/
453 files_struct *file_fnum(uint16 fnum)
458 for (fsp=Files;fsp;fsp=fsp->next, count++) {
459 if (fsp->fnum == fnum) {
461 DLIST_PROMOTE(Files, fsp);
469 /****************************************************************************
470 Get an fsp from a packet given the offset of a 16 bit fnum.
471 ****************************************************************************/
473 files_struct *file_fsp(struct smb_request *req, uint16 fid)
477 if ((req != NULL) && (req->chain_fsp != NULL)) {
478 return req->chain_fsp;
481 fsp = file_fnum(fid);
482 if ((fsp != NULL) && (req != NULL)) {
483 req->chain_fsp = fsp;
488 /****************************************************************************
489 Duplicate the file handle part for a DOS or FCB open.
490 ****************************************************************************/
492 NTSTATUS dup_file_fsp(struct smb_request *req, files_struct *fsp,
493 uint32 access_mask, uint32 share_access,
494 uint32 create_options, files_struct **result)
497 files_struct *dup_fsp;
499 status = file_new(NULL, fsp->conn, &dup_fsp);
501 if (!NT_STATUS_IS_OK(status)) {
505 SAFE_FREE(dup_fsp->fh);
507 dup_fsp->fh = fsp->fh;
508 dup_fsp->fh->ref_count++;
510 dup_fsp->file_id = fsp->file_id;
511 dup_fsp->initial_allocation_size = fsp->initial_allocation_size;
512 dup_fsp->mode = fsp->mode;
513 dup_fsp->file_pid = fsp->file_pid;
514 dup_fsp->vuid = fsp->vuid;
515 dup_fsp->open_time = fsp->open_time;
516 dup_fsp->access_mask = access_mask;
517 dup_fsp->share_access = share_access;
518 dup_fsp->oplock_type = fsp->oplock_type;
519 dup_fsp->can_lock = fsp->can_lock;
520 dup_fsp->can_read = (access_mask & (FILE_READ_DATA)) ? True : False;
521 if (!CAN_WRITE(fsp->conn)) {
522 dup_fsp->can_write = False;
524 dup_fsp->can_write = (access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) ? True : False;
526 dup_fsp->print_file = fsp->print_file;
527 dup_fsp->modified = fsp->modified;
528 dup_fsp->is_directory = fsp->is_directory;
529 dup_fsp->aio_write_behind = fsp->aio_write_behind;
530 string_set(&dup_fsp->fsp_name,fsp->fsp_name);