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 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.
23 static int real_max_open_files;
25 #define VALID_FNUM(fnum) (((fnum) >= 0) && ((fnum) < real_max_open_files))
27 #define FILE_HANDLE_OFFSET 0x1000
29 static struct bitmap *file_bmap;
31 static files_struct *Files;
33 /* a fsp to use when chaining */
34 static files_struct *chain_fsp = NULL;
36 static int files_used;
38 /* A singleton cache to speed up searching by dev/inode. */
39 static struct fsp_singleton_cache {
44 /****************************************************************************
45 Return a unique number identifying this fsp over the life of this pid.
46 ****************************************************************************/
48 static unsigned long get_gen_count(void)
50 static unsigned long file_gen_counter;
52 if ((++file_gen_counter) == 0)
53 return ++file_gen_counter;
54 return file_gen_counter;
57 /****************************************************************************
58 Find first available file slot.
59 ****************************************************************************/
61 NTSTATUS file_new(connection_struct *conn, files_struct **result)
64 static int first_file;
67 /* we want to give out file handles differently on each new
68 connection because of a common bug in MS clients where they try to
69 reuse a file descriptor from an earlier smb connection. This code
70 increases the chance that the errant client will get an error rather
71 than causing corruption */
72 if (first_file == 0) {
73 first_file = (sys_getpid() ^ (int)time(NULL)) % real_max_open_files;
76 /* TODO: Port the id-tree implementation from Samba4 */
78 i = bitmap_find(file_bmap, first_file);
80 DEBUG(0,("ERROR! Out of file structures\n"));
81 /* TODO: We have to unconditionally return a DOS error here,
82 * W2k3 even returns ERRDOS/ERRnofids for ntcreate&x with
83 * NTSTATUS negotiated */
84 return NT_STATUS_TOO_MANY_OPENED_FILES;
87 fsp = SMB_MALLOC_P(files_struct);
89 return NT_STATUS_NO_MEMORY;
94 fsp->fh = SMB_MALLOC_P(struct fd_handle);
97 return NT_STATUS_NO_MEMORY;
100 ZERO_STRUCTP(fsp->fh);
102 fsp->fh->ref_count = 1;
106 fsp->fh->gen_id = get_gen_count();
107 GetTimeOfDay(&fsp->open_time);
109 first_file = (i+1) % real_max_open_files;
111 bitmap_set(file_bmap, i);
114 fsp->fnum = i + FILE_HANDLE_OFFSET;
115 SMB_ASSERT(fsp->fnum < 65536);
117 string_set(&fsp->fsp_name,"");
119 DLIST_ADD(Files, fsp);
121 DEBUG(5,("allocated file structure %d, fnum = %d (%d used)\n",
122 i, fsp->fnum, files_used));
126 /* A new fsp invalidates a negative fsp_fi_cache. */
127 if (fsp_fi_cache.fsp == NULL) {
128 ZERO_STRUCT(fsp_fi_cache);
135 /****************************************************************************
136 Close all open files for a connection.
137 ****************************************************************************/
139 void file_close_conn(connection_struct *conn)
141 files_struct *fsp, *next;
143 for (fsp=Files;fsp;fsp=next) {
145 if (fsp->conn == conn) {
146 close_file(fsp,SHUTDOWN_CLOSE);
151 /****************************************************************************
152 Close all open files for a pid and a vuid.
153 ****************************************************************************/
155 void file_close_pid(uint16 smbpid, int vuid)
157 files_struct *fsp, *next;
159 for (fsp=Files;fsp;fsp=next) {
161 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
162 close_file(fsp,SHUTDOWN_CLOSE);
167 /****************************************************************************
168 Initialise file structures.
169 ****************************************************************************/
171 #define MAX_OPEN_FUDGEFACTOR 20
175 int request_max_open_files = lp_max_open_files();
179 * Set the max_open files to be the requested
180 * max plus a fudgefactor to allow for the extra
181 * fd's we need such as log files etc...
183 real_lim = set_maxfiles(request_max_open_files + MAX_OPEN_FUDGEFACTOR);
185 real_max_open_files = real_lim - MAX_OPEN_FUDGEFACTOR;
187 if (real_max_open_files + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES > 65536)
188 real_max_open_files = 65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
190 if(real_max_open_files != request_max_open_files) {
191 DEBUG(1,("file_init: Information only: requested %d \
192 open files, %d are available.\n", request_max_open_files, real_max_open_files));
195 SMB_ASSERT(real_max_open_files > 100);
197 file_bmap = bitmap_allocate(real_max_open_files);
200 exit_server("out of memory in file_init");
204 * Ensure that pipe_handle_oppset is set correctly.
206 set_pipe_handle_offset(real_max_open_files);
209 /****************************************************************************
210 Close files open by a specified vuid.
211 ****************************************************************************/
213 void file_close_user(int vuid)
215 files_struct *fsp, *next;
217 for (fsp=Files;fsp;fsp=next) {
219 if (fsp->vuid == vuid) {
220 close_file(fsp,SHUTDOWN_CLOSE);
225 /****************************************************************************
226 Debug to enumerate all open files in the smbd.
227 ****************************************************************************/
229 void file_dump_open_table(void)
234 for (fsp=Files;fsp;fsp=fsp->next,count++) {
235 DEBUG(10,("Files[%d], fnum = %d, name %s, fd = %d, gen = %lu, fileid=%s\n",
236 count, fsp->fnum, fsp->fsp_name, fsp->fh->fd, (unsigned long)fsp->fh->gen_id,
237 file_id_static_string(&fsp->file_id)));
241 /****************************************************************************
242 Find a fsp given a file descriptor.
243 ****************************************************************************/
245 files_struct *file_find_fd(int fd)
250 for (fsp=Files;fsp;fsp=fsp->next,count++) {
251 if (fsp->fh->fd == fd) {
253 DLIST_PROMOTE(Files, fsp);
262 /****************************************************************************
263 Find a fsp given a device, inode and file_id.
264 ****************************************************************************/
266 files_struct *file_find_dif(struct file_id id, unsigned long gen_id)
271 for (fsp=Files;fsp;fsp=fsp->next,count++) {
272 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
273 if (file_id_equal(&fsp->file_id, &id) &&
274 fsp->fh->gen_id == gen_id ) {
276 DLIST_PROMOTE(Files, fsp);
278 /* Paranoia check. */
279 if ((fsp->fh->fd == -1) &&
280 (fsp->oplock_type != NO_OPLOCK) &&
281 (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK)) {
282 DEBUG(0,("file_find_dif: file %s file_id = %s, gen = %u \
283 oplock_type = %u is a stat open with oplock type !\n", fsp->fsp_name,
284 file_id_static_string(&fsp->file_id),
285 (unsigned int)fsp->fh->gen_id,
286 (unsigned int)fsp->oplock_type ));
287 smb_panic("file_find_dif");
296 /****************************************************************************
297 Check if an fsp still exists.
298 ****************************************************************************/
300 files_struct *file_find_fsp(files_struct *orig_fsp)
304 for (fsp=Files;fsp;fsp=fsp->next) {
312 /****************************************************************************
313 Find the first fsp given a device and inode.
314 We use a singleton cache here to speed up searching from getfilepathinfo
316 ****************************************************************************/
318 files_struct *file_find_di_first(struct file_id id)
322 if (file_id_equal(&fsp_fi_cache.id, &id)) {
323 /* Positive or negative cache hit. */
324 return fsp_fi_cache.fsp;
327 fsp_fi_cache.id = id;
329 for (fsp=Files;fsp;fsp=fsp->next) {
330 if ( fsp->fh->fd != -1 &&
331 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 ( fsp->fh->fd != -1 &&
353 file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
361 /****************************************************************************
362 Find a fsp that is open for printing.
363 ****************************************************************************/
365 files_struct *file_find_print(void)
369 for (fsp=Files;fsp;fsp=fsp->next) {
370 if (fsp->print_file) {
378 /****************************************************************************
379 Set a pending modtime across all files with a given dev/ino pair.
380 Record the owner of that modtime.
381 ****************************************************************************/
383 void fsp_set_pending_modtime(files_struct *tfsp, const struct timespec mod)
387 if (null_timespec(mod)) {
391 for (fsp = Files;fsp;fsp=fsp->next) {
392 if ( fsp->fh->fd != -1 && file_id_equal(&fsp->file_id, &tfsp->file_id)) {
393 fsp->pending_modtime = mod;
394 fsp->pending_modtime_owner = False;
398 tfsp->pending_modtime_owner = True;
401 /****************************************************************************
402 Sync open files on a connection.
403 ****************************************************************************/
405 void file_sync_all(connection_struct *conn)
407 files_struct *fsp, *next;
409 for (fsp=Files;fsp;fsp=next) {
411 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
412 sync_file(conn, fsp, True /* write through */);
417 /****************************************************************************
419 ****************************************************************************/
421 void file_free(files_struct *fsp)
423 DLIST_REMOVE(Files, fsp);
425 string_free(&fsp->fsp_name);
427 if (fsp->fake_file_handle) {
428 destroy_fake_file_handle(&fsp->fake_file_handle);
431 if (fsp->fh->ref_count == 1) {
434 fsp->fh->ref_count--;
438 notify_remove(fsp->conn->notify_ctx, fsp);
439 TALLOC_FREE(fsp->notify);
442 bitmap_clear(file_bmap, fsp->fnum - FILE_HANDLE_OFFSET);
445 DEBUG(5,("freed files structure %d (%d used)\n",
446 fsp->fnum, files_used));
448 /* this is paranoia, just in case someone tries to reuse the
452 if (fsp == chain_fsp) {
456 /* Closing a file can invalidate the positive cache. */
457 if (fsp == fsp_fi_cache.fsp) {
458 ZERO_STRUCT(fsp_fi_cache);
464 /****************************************************************************
465 Get an fsp from a 16 bit fnum.
466 ****************************************************************************/
468 files_struct *file_fnum(uint16 fnum)
473 for (fsp=Files;fsp;fsp=fsp->next, count++) {
474 if (fsp->fnum == fnum) {
476 DLIST_PROMOTE(Files, fsp);
484 /****************************************************************************
485 Get an fsp from a packet given the offset of a 16 bit fnum.
486 ****************************************************************************/
488 files_struct *file_fsp(char *buf, int where)
500 fsp = file_fnum(SVAL(buf, where));
507 /****************************************************************************
508 Reset the chained fsp - done at the start of a packet reply.
509 ****************************************************************************/
511 void file_chain_reset(void)
516 /****************************************************************************
517 Duplicate the file handle part for a DOS or FCB open.
518 ****************************************************************************/
520 NTSTATUS dup_file_fsp(files_struct *fsp,
523 uint32 create_options,
524 files_struct **result)
527 files_struct *dup_fsp;
529 status = file_new(fsp->conn, &dup_fsp);
531 if (!NT_STATUS_IS_OK(status)) {
535 SAFE_FREE(dup_fsp->fh);
537 dup_fsp->fh = fsp->fh;
538 dup_fsp->fh->ref_count++;
540 dup_fsp->file_id = fsp->file_id;
541 dup_fsp->initial_allocation_size = fsp->initial_allocation_size;
542 dup_fsp->mode = fsp->mode;
543 dup_fsp->file_pid = fsp->file_pid;
544 dup_fsp->vuid = fsp->vuid;
545 dup_fsp->open_time = fsp->open_time;
546 dup_fsp->access_mask = access_mask;
547 dup_fsp->share_access = share_access;
548 dup_fsp->pending_modtime_owner = fsp->pending_modtime_owner;
549 dup_fsp->pending_modtime = fsp->pending_modtime;
550 dup_fsp->last_write_time = fsp->last_write_time;
551 dup_fsp->oplock_type = fsp->oplock_type;
552 dup_fsp->can_lock = fsp->can_lock;
553 dup_fsp->can_read = (access_mask & (FILE_READ_DATA)) ? True : False;
554 if (!CAN_WRITE(fsp->conn)) {
555 dup_fsp->can_write = False;
557 dup_fsp->can_write = (access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) ? True : False;
559 dup_fsp->print_file = fsp->print_file;
560 dup_fsp->modified = fsp->modified;
561 dup_fsp->is_directory = fsp->is_directory;
562 dup_fsp->is_stat = fsp->is_stat;
563 string_set(&dup_fsp->fsp_name,fsp->fsp_name);