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;
35 /* a fsp to use to save when breaking an oplock. */
36 static files_struct *oplock_save_chain_fsp = NULL;
38 static int files_used;
40 /* A singleton cache to speed up searching by dev/inode. */
41 static struct fsp_singleton_cache {
47 /****************************************************************************
48 Return a unique number identifying this fsp over the life of this pid.
49 ****************************************************************************/
51 static unsigned long get_gen_count(void)
53 static unsigned long file_gen_counter;
55 if ((++file_gen_counter) == 0)
56 return ++file_gen_counter;
57 return file_gen_counter;
60 /****************************************************************************
61 Find first available file slot.
62 ****************************************************************************/
64 files_struct *file_new(connection_struct *conn)
67 static int first_file;
70 /* we want to give out file handles differently on each new
71 connection because of a common bug in MS clients where they try to
72 reuse a file descriptor from an earlier smb connection. This code
73 increases the chance that the errant client will get an error rather
74 than causing corruption */
75 if (first_file == 0) {
76 first_file = (sys_getpid() ^ (int)time(NULL)) % real_max_open_files;
79 /* TODO: Port the id-tree implementation from Samba4 */
81 i = bitmap_find(file_bmap, first_file);
83 DEBUG(0,("ERROR! Out of file structures\n"));
84 /* TODO: We have to unconditionally return a DOS error here,
85 * W2k3 even returns ERRDOS/ERRnofids for ntcreate&x with
86 * NTSTATUS negotiated */
87 set_saved_ntstatus(NT_STATUS_TOO_MANY_OPENED_FILES);
91 fsp = SMB_MALLOC_P(files_struct);
93 set_saved_ntstatus(NT_STATUS_NO_MEMORY);
99 fsp->fh = SMB_MALLOC_P(struct fd_handle);
102 set_saved_ntstatus(NT_STATUS_NO_MEMORY);
106 ZERO_STRUCTP(fsp->fh);
108 fsp->fh->ref_count = 1;
112 fsp->fh->file_id = get_gen_count();
113 GetTimeOfDay(&fsp->open_time);
115 first_file = (i+1) % real_max_open_files;
117 bitmap_set(file_bmap, i);
120 fsp->fnum = i + FILE_HANDLE_OFFSET;
121 SMB_ASSERT(fsp->fnum < 65536);
123 string_set(&fsp->fsp_name,"");
125 DLIST_ADD(Files, fsp);
127 DEBUG(5,("allocated file structure %d, fnum = %d (%d used)\n",
128 i, fsp->fnum, files_used));
132 /* A new fsp invalidates a negative fsp_fi_cache. */
133 if (fsp_fi_cache.fsp == NULL) {
134 ZERO_STRUCT(fsp_fi_cache);
140 /****************************************************************************
141 Close all open files for a connection.
142 ****************************************************************************/
144 void file_close_conn(connection_struct *conn)
146 files_struct *fsp, *next;
148 for (fsp=Files;fsp;fsp=next) {
150 if (fsp->conn == conn) {
151 close_file(fsp,SHUTDOWN_CLOSE);
156 /****************************************************************************
157 Close all open files for a pid and a vuid.
158 ****************************************************************************/
160 void file_close_pid(uint16 smbpid, int vuid)
162 files_struct *fsp, *next;
164 for (fsp=Files;fsp;fsp=next) {
166 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
167 close_file(fsp,SHUTDOWN_CLOSE);
172 /****************************************************************************
173 Initialise file structures.
174 ****************************************************************************/
176 #define MAX_OPEN_FUDGEFACTOR 20
180 int request_max_open_files = lp_max_open_files();
184 * Set the max_open files to be the requested
185 * max plus a fudgefactor to allow for the extra
186 * fd's we need such as log files etc...
188 real_lim = set_maxfiles(request_max_open_files + MAX_OPEN_FUDGEFACTOR);
190 real_max_open_files = real_lim - MAX_OPEN_FUDGEFACTOR;
192 if (real_max_open_files + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES > 65536)
193 real_max_open_files = 65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
195 if(real_max_open_files != request_max_open_files) {
196 DEBUG(1,("file_init: Information only: requested %d \
197 open files, %d are available.\n", request_max_open_files, real_max_open_files));
200 SMB_ASSERT(real_max_open_files > 100);
202 file_bmap = bitmap_allocate(real_max_open_files);
205 exit_server("out of memory in file_init");
209 * Ensure that pipe_handle_oppset is set correctly.
211 set_pipe_handle_offset(real_max_open_files);
214 /****************************************************************************
215 Close files open by a specified vuid.
216 ****************************************************************************/
218 void file_close_user(int vuid)
220 files_struct *fsp, *next;
222 for (fsp=Files;fsp;fsp=next) {
224 if (fsp->vuid == vuid) {
225 close_file(fsp,SHUTDOWN_CLOSE);
230 /****************************************************************************
231 Debug to enumerate all open files in the smbd.
232 ****************************************************************************/
234 void file_dump_open_table(void)
239 for (fsp=Files;fsp;fsp=fsp->next,count++) {
240 DEBUG(10,("Files[%d], fnum = %d, name %s, fd = %d, fileid = %lu, dev = %x, inode = %.0f\n",
241 count, fsp->fnum, fsp->fsp_name, fsp->fh->fd, (unsigned long)fsp->fh->file_id,
242 (unsigned int)fsp->dev, (double)fsp->inode ));
246 /****************************************************************************
247 Find a fsp given a file descriptor.
248 ****************************************************************************/
250 files_struct *file_find_fd(int fd)
255 for (fsp=Files;fsp;fsp=fsp->next,count++) {
256 if (fsp->fh->fd == fd) {
258 DLIST_PROMOTE(Files, fsp);
267 /****************************************************************************
268 Find a fsp given a device, inode and file_id.
269 ****************************************************************************/
271 files_struct *file_find_dif(SMB_DEV_T dev, SMB_INO_T inode, unsigned long file_id)
276 for (fsp=Files;fsp;fsp=fsp->next,count++) {
277 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
278 if (fsp->dev == dev &&
279 fsp->inode == inode &&
280 fsp->fh->file_id == file_id ) {
282 DLIST_PROMOTE(Files, fsp);
284 /* Paranoia check. */
285 if ((fsp->fh->fd == -1) &&
286 (fsp->oplock_type != NO_OPLOCK) &&
287 (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK)) {
288 DEBUG(0,("file_find_dif: file %s dev = %x, inode = %.0f, file_id = %u \
289 oplock_type = %u is a stat open with oplock type !\n", fsp->fsp_name, (unsigned int)fsp->dev,
290 (double)fsp->inode, (unsigned int)fsp->fh->file_id,
291 (unsigned int)fsp->oplock_type ));
292 smb_panic("file_find_dif\n");
301 /****************************************************************************
302 Check if an fsp still exists.
303 ****************************************************************************/
305 files_struct *file_find_fsp(files_struct *orig_fsp)
309 for (fsp=Files;fsp;fsp=fsp->next) {
317 /****************************************************************************
318 Find the first fsp given a device and inode.
319 We use a singleton cache here to speed up searching from getfilepathinfo
321 ****************************************************************************/
323 files_struct *file_find_di_first(SMB_DEV_T dev, SMB_INO_T inode)
327 if (fsp_fi_cache.dev == dev && fsp_fi_cache.inode == inode) {
328 /* Positive or negative cache hit. */
329 return fsp_fi_cache.fsp;
332 fsp_fi_cache.dev = dev;
333 fsp_fi_cache.inode = inode;
335 for (fsp=Files;fsp;fsp=fsp->next) {
336 if ( fsp->fh->fd != -1 &&
338 fsp->inode == inode ) {
339 /* Setup positive cache. */
340 fsp_fi_cache.fsp = fsp;
345 /* Setup negative cache. */
346 fsp_fi_cache.fsp = NULL;
350 /****************************************************************************
351 Find the next fsp having the same device and inode.
352 ****************************************************************************/
354 files_struct *file_find_di_next(files_struct *start_fsp)
358 for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
359 if ( fsp->fh->fd != -1 &&
360 fsp->dev == start_fsp->dev &&
361 fsp->inode == start_fsp->inode )
368 /****************************************************************************
369 Find a fsp that is open for printing.
370 ****************************************************************************/
372 files_struct *file_find_print(void)
376 for (fsp=Files;fsp;fsp=fsp->next) {
377 if (fsp->print_file) {
385 /****************************************************************************
386 Set a pending modtime across all files with a given dev/ino pair.
387 Record the owner of that modtime.
388 ****************************************************************************/
390 void fsp_set_pending_modtime(files_struct *tfsp, time_t pmod)
394 if (null_mtime(pmod)) {
398 for (fsp = Files;fsp;fsp=fsp->next) {
399 if ( fsp->fh->fd != -1 &&
400 fsp->dev == tfsp->dev &&
401 fsp->inode == tfsp->inode ) {
402 fsp->pending_modtime = pmod;
403 fsp->pending_modtime_owner = False;
407 tfsp->pending_modtime_owner = True;
410 /****************************************************************************
411 Sync open files on a connection.
412 ****************************************************************************/
414 void file_sync_all(connection_struct *conn)
416 files_struct *fsp, *next;
418 for (fsp=Files;fsp;fsp=next) {
420 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
421 sync_file(conn, fsp, True /* write through */);
426 /****************************************************************************
428 ****************************************************************************/
430 void file_free(files_struct *fsp)
432 DLIST_REMOVE(Files, fsp);
434 string_free(&fsp->fsp_name);
436 if (fsp->fake_file_handle) {
437 destroy_fake_file_handle(&fsp->fake_file_handle);
440 if (fsp->fh->ref_count == 1) {
443 fsp->fh->ref_count--;
446 bitmap_clear(file_bmap, fsp->fnum - FILE_HANDLE_OFFSET);
449 DEBUG(5,("freed files structure %d (%d used)\n",
450 fsp->fnum, files_used));
452 /* this is paranoia, just in case someone tries to reuse the
456 if (fsp == chain_fsp) {
460 /* Closing a file can invalidate the positive cache. */
461 if (fsp == fsp_fi_cache.fsp) {
462 ZERO_STRUCT(fsp_fi_cache);
468 /****************************************************************************
469 Get a fsp from a packet given the offset of a 16 bit fnum.
470 ****************************************************************************/
472 files_struct *file_fsp(char *buf, int where)
482 fnum = SVAL(buf, where);
484 for (fsp=Files;fsp;fsp=fsp->next, count++) {
485 if (fsp->fnum == fnum) {
488 DLIST_PROMOTE(Files, fsp);
496 /****************************************************************************
497 Reset the chained fsp - done at the start of a packet reply.
498 ****************************************************************************/
500 void file_chain_reset(void)
505 /****************************************************************************
506 Save the chained fsp - done when about to do an oplock break.
507 ****************************************************************************/
509 void file_chain_save(void)
511 oplock_save_chain_fsp = chain_fsp;
514 /****************************************************************************
515 Restore the chained fsp - done after an oplock break.
516 ****************************************************************************/
518 void file_chain_restore(void)
520 chain_fsp = oplock_save_chain_fsp;
523 /****************************************************************************
524 Duplicate the file handle part for a DOS or FCB open.
525 ****************************************************************************/
527 files_struct *dup_file_fsp(files_struct *fsp,
530 uint32 create_options)
532 files_struct *dup_fsp = file_new(fsp->conn);
538 SAFE_FREE(dup_fsp->fh);
540 dup_fsp->fh = fsp->fh;
541 dup_fsp->fh->ref_count++;
543 dup_fsp->dev = fsp->dev;
544 dup_fsp->inode = fsp->inode;
545 dup_fsp->initial_allocation_size = fsp->initial_allocation_size;
546 dup_fsp->mode = fsp->mode;
547 dup_fsp->file_pid = fsp->file_pid;
548 dup_fsp->vuid = fsp->vuid;
549 dup_fsp->open_time = fsp->open_time;
550 dup_fsp->access_mask = access_mask;
551 dup_fsp->share_access = share_access;
552 dup_fsp->pending_modtime_owner = fsp->pending_modtime_owner;
553 dup_fsp->pending_modtime = fsp->pending_modtime;
554 dup_fsp->last_write_time = fsp->last_write_time;
555 dup_fsp->oplock_type = fsp->oplock_type;
556 dup_fsp->can_lock = fsp->can_lock;
557 dup_fsp->can_read = (access_mask & (FILE_READ_DATA)) ? True : False;
558 if (!CAN_WRITE(fsp->conn)) {
559 dup_fsp->can_write = False;
561 dup_fsp->can_write = (access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) ? True : False;
563 dup_fsp->print_file = fsp->print_file;
564 dup_fsp->modified = fsp->modified;
565 dup_fsp->is_directory = fsp->is_directory;
566 dup_fsp->is_stat = fsp->is_stat;
567 dup_fsp->aio_write_behind = fsp->aio_write_behind;
568 string_set(&dup_fsp->fsp_name,fsp->fsp_name);