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
{
45 /****************************************************************************
46 Return a unique number identifying this fsp over the life of this pid.
47 ****************************************************************************/
49 static unsigned long get_gen_count(void)
51 static unsigned long file_gen_counter
;
53 if ((++file_gen_counter
) == 0)
54 return ++file_gen_counter
;
55 return file_gen_counter
;
58 /****************************************************************************
59 Find first available file slot.
60 ****************************************************************************/
62 files_struct
*file_new(connection_struct
*conn
)
65 static int first_file
;
68 /* we want to give out file handles differently on each new
69 connection because of a common bug in MS clients where they try to
70 reuse a file descriptor from an earlier smb connection. This code
71 increases the chance that the errant client will get an error rather
72 than causing corruption */
73 if (first_file
== 0) {
74 first_file
= (sys_getpid() ^ (int)time(NULL
)) % real_max_open_files
;
77 /* TODO: Port the id-tree implementation from Samba4 */
79 i
= bitmap_find(file_bmap
, first_file
);
81 DEBUG(0,("ERROR! Out of file structures\n"));
82 /* TODO: We have to unconditionally return a DOS error here,
83 * W2k3 even returns ERRDOS/ERRnofids for ntcreate&x with
84 * NTSTATUS negotiated */
85 set_saved_ntstatus(NT_STATUS_TOO_MANY_OPENED_FILES
);
89 fsp
= SMB_MALLOC_P(files_struct
);
91 set_saved_ntstatus(NT_STATUS_NO_MEMORY
);
97 fsp
->fh
= SMB_MALLOC_P(struct fd_handle
);
100 set_saved_ntstatus(NT_STATUS_NO_MEMORY
);
104 ZERO_STRUCTP(fsp
->fh
);
106 fsp
->fh
->ref_count
= 1;
110 fsp
->fh
->file_id
= get_gen_count();
111 GetTimeOfDay(&fsp
->open_time
);
113 first_file
= (i
+1) % real_max_open_files
;
115 bitmap_set(file_bmap
, i
);
118 fsp
->fnum
= i
+ FILE_HANDLE_OFFSET
;
119 SMB_ASSERT(fsp
->fnum
< 65536);
121 string_set(&fsp
->fsp_name
,"");
123 DLIST_ADD(Files
, fsp
);
125 DEBUG(5,("allocated file structure %d, fnum = %d (%d used)\n",
126 i
, fsp
->fnum
, files_used
));
130 /* A new fsp invalidates a negative fsp_fi_cache. */
131 if (fsp_fi_cache
.fsp
== NULL
) {
132 ZERO_STRUCT(fsp_fi_cache
);
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
=Files
;fsp
;fsp
=next
) {
148 if (fsp
->conn
== conn
) {
149 close_file(fsp
,SHUTDOWN_CLOSE
);
154 /****************************************************************************
155 Close all open files for a pid and a vuid.
156 ****************************************************************************/
158 void file_close_pid(uint16 smbpid
, int vuid
)
160 files_struct
*fsp
, *next
;
162 for (fsp
=Files
;fsp
;fsp
=next
) {
164 if ((fsp
->file_pid
== smbpid
) && (fsp
->vuid
== vuid
)) {
165 close_file(fsp
,SHUTDOWN_CLOSE
);
170 /****************************************************************************
171 Initialise file structures.
172 ****************************************************************************/
174 #define MAX_OPEN_FUDGEFACTOR 20
178 int request_max_open_files
= lp_max_open_files();
182 * Set the max_open files to be the requested
183 * max plus a fudgefactor to allow for the extra
184 * fd's we need such as log files etc...
186 real_lim
= set_maxfiles(request_max_open_files
+ MAX_OPEN_FUDGEFACTOR
);
188 real_max_open_files
= real_lim
- MAX_OPEN_FUDGEFACTOR
;
190 if (real_max_open_files
+ FILE_HANDLE_OFFSET
+ MAX_OPEN_PIPES
> 65536)
191 real_max_open_files
= 65536 - FILE_HANDLE_OFFSET
- MAX_OPEN_PIPES
;
193 if(real_max_open_files
!= request_max_open_files
) {
194 DEBUG(1,("file_init: Information only: requested %d \
195 open files, %d are available.\n", request_max_open_files
, real_max_open_files
));
198 SMB_ASSERT(real_max_open_files
> 100);
200 file_bmap
= bitmap_allocate(real_max_open_files
);
203 exit_server("out of memory in file_init");
207 * Ensure that pipe_handle_oppset is set correctly.
209 set_pipe_handle_offset(real_max_open_files
);
212 /****************************************************************************
213 Close files open by a specified vuid.
214 ****************************************************************************/
216 void file_close_user(int vuid
)
218 files_struct
*fsp
, *next
;
220 for (fsp
=Files
;fsp
;fsp
=next
) {
222 if (fsp
->vuid
== vuid
) {
223 close_file(fsp
,SHUTDOWN_CLOSE
);
228 /****************************************************************************
229 Debug to enumerate all open files in the smbd.
230 ****************************************************************************/
232 void file_dump_open_table(void)
237 for (fsp
=Files
;fsp
;fsp
=fsp
->next
,count
++) {
238 DEBUG(10,("Files[%d], fnum = %d, name %s, fd = %d, fileid = %lu, dev = %x, inode = %.0f\n",
239 count
, fsp
->fnum
, fsp
->fsp_name
, fsp
->fh
->fd
, (unsigned long)fsp
->fh
->file_id
,
240 (unsigned int)fsp
->dev
, (double)fsp
->inode
));
244 /****************************************************************************
245 Find a fsp given a file descriptor.
246 ****************************************************************************/
248 files_struct
*file_find_fd(int fd
)
253 for (fsp
=Files
;fsp
;fsp
=fsp
->next
,count
++) {
254 if (fsp
->fh
->fd
== fd
) {
256 DLIST_PROMOTE(Files
, fsp
);
265 /****************************************************************************
266 Find a fsp given a device, inode and file_id.
267 ****************************************************************************/
269 files_struct
*file_find_dif(SMB_DEV_T dev
, SMB_INO_T inode
, unsigned long file_id
)
274 for (fsp
=Files
;fsp
;fsp
=fsp
->next
,count
++) {
275 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
276 if (fsp
->dev
== dev
&&
277 fsp
->inode
== inode
&&
278 fsp
->fh
->file_id
== file_id
) {
280 DLIST_PROMOTE(Files
, fsp
);
282 /* Paranoia check. */
283 if ((fsp
->fh
->fd
== -1) &&
284 (fsp
->oplock_type
!= NO_OPLOCK
) &&
285 (fsp
->oplock_type
!= FAKE_LEVEL_II_OPLOCK
)) {
286 DEBUG(0,("file_find_dif: file %s dev = %x, inode = %.0f, file_id = %u \
287 oplock_type = %u is a stat open with oplock type !\n", fsp
->fsp_name
, (unsigned int)fsp
->dev
,
288 (double)fsp
->inode
, (unsigned int)fsp
->fh
->file_id
,
289 (unsigned int)fsp
->oplock_type
));
290 smb_panic("file_find_dif\n");
299 /****************************************************************************
300 Check if an fsp still exists.
301 ****************************************************************************/
303 files_struct
*file_find_fsp(files_struct
*orig_fsp
)
307 for (fsp
=Files
;fsp
;fsp
=fsp
->next
) {
315 /****************************************************************************
316 Find the first fsp given a device and inode.
317 We use a singleton cache here to speed up searching from getfilepathinfo
319 ****************************************************************************/
321 files_struct
*file_find_di_first(SMB_DEV_T dev
, SMB_INO_T inode
)
325 if (fsp_fi_cache
.dev
== dev
&& fsp_fi_cache
.inode
== inode
) {
326 /* Positive or negative cache hit. */
327 return fsp_fi_cache
.fsp
;
330 fsp_fi_cache
.dev
= dev
;
331 fsp_fi_cache
.inode
= inode
;
333 for (fsp
=Files
;fsp
;fsp
=fsp
->next
) {
334 if ( fsp
->fh
->fd
!= -1 &&
336 fsp
->inode
== inode
) {
337 /* Setup positive cache. */
338 fsp_fi_cache
.fsp
= fsp
;
343 /* Setup negative cache. */
344 fsp_fi_cache
.fsp
= NULL
;
348 /****************************************************************************
349 Find the next fsp having the same device and inode.
350 ****************************************************************************/
352 files_struct
*file_find_di_next(files_struct
*start_fsp
)
356 for (fsp
= start_fsp
->next
;fsp
;fsp
=fsp
->next
) {
357 if ( fsp
->fh
->fd
!= -1 &&
358 fsp
->dev
== start_fsp
->dev
&&
359 fsp
->inode
== start_fsp
->inode
)
366 /****************************************************************************
367 Find a fsp that is open for printing.
368 ****************************************************************************/
370 files_struct
*file_find_print(void)
374 for (fsp
=Files
;fsp
;fsp
=fsp
->next
) {
375 if (fsp
->print_file
) {
383 /****************************************************************************
384 Set a pending modtime across all files with a given dev/ino pair.
385 Record the owner of that modtime.
386 ****************************************************************************/
388 void fsp_set_pending_modtime(files_struct
*tfsp
, time_t pmod
)
392 if (null_mtime(pmod
)) {
396 for (fsp
= Files
;fsp
;fsp
=fsp
->next
) {
397 if ( fsp
->fh
->fd
!= -1 &&
398 fsp
->dev
== tfsp
->dev
&&
399 fsp
->inode
== tfsp
->inode
) {
400 fsp
->pending_modtime
= pmod
;
401 fsp
->pending_modtime_owner
= False
;
405 tfsp
->pending_modtime_owner
= True
;
408 /****************************************************************************
409 Sync open files on a connection.
410 ****************************************************************************/
412 void file_sync_all(connection_struct
*conn
)
414 files_struct
*fsp
, *next
;
416 for (fsp
=Files
;fsp
;fsp
=next
) {
418 if ((conn
== fsp
->conn
) && (fsp
->fh
->fd
!= -1)) {
419 sync_file(conn
, fsp
, True
/* write through */);
424 /****************************************************************************
426 ****************************************************************************/
428 void file_free(files_struct
*fsp
)
430 DLIST_REMOVE(Files
, fsp
);
432 string_free(&fsp
->fsp_name
);
434 if (fsp
->fake_file_handle
) {
435 destroy_fake_file_handle(&fsp
->fake_file_handle
);
438 if (fsp
->fh
->ref_count
== 1) {
441 fsp
->fh
->ref_count
--;
444 bitmap_clear(file_bmap
, fsp
->fnum
- FILE_HANDLE_OFFSET
);
447 DEBUG(5,("freed files structure %d (%d used)\n",
448 fsp
->fnum
, files_used
));
450 /* this is paranoia, just in case someone tries to reuse the
454 if (fsp
== chain_fsp
) {
458 /* Closing a file can invalidate the positive cache. */
459 if (fsp
== fsp_fi_cache
.fsp
) {
460 ZERO_STRUCT(fsp_fi_cache
);
466 /****************************************************************************
467 Get a fsp from a packet given the offset of a 16 bit fnum.
468 ****************************************************************************/
470 files_struct
*file_fsp(char *buf
, int where
)
480 fnum
= SVAL(buf
, where
);
482 for (fsp
=Files
;fsp
;fsp
=fsp
->next
, count
++) {
483 if (fsp
->fnum
== fnum
) {
486 DLIST_PROMOTE(Files
, fsp
);
494 /****************************************************************************
495 Reset the chained fsp - done at the start of a packet reply.
496 ****************************************************************************/
498 void file_chain_reset(void)
503 /****************************************************************************
504 Duplicate the file handle part for a DOS or FCB open.
505 ****************************************************************************/
507 files_struct
*dup_file_fsp(files_struct
*fsp
,
510 uint32 create_options
)
512 files_struct
*dup_fsp
= file_new(fsp
->conn
);
518 SAFE_FREE(dup_fsp
->fh
);
520 dup_fsp
->fh
= fsp
->fh
;
521 dup_fsp
->fh
->ref_count
++;
523 dup_fsp
->dev
= fsp
->dev
;
524 dup_fsp
->inode
= fsp
->inode
;
525 dup_fsp
->initial_allocation_size
= fsp
->initial_allocation_size
;
526 dup_fsp
->mode
= fsp
->mode
;
527 dup_fsp
->file_pid
= fsp
->file_pid
;
528 dup_fsp
->vuid
= fsp
->vuid
;
529 dup_fsp
->open_time
= fsp
->open_time
;
530 dup_fsp
->access_mask
= access_mask
;
531 dup_fsp
->share_access
= share_access
;
532 dup_fsp
->pending_modtime_owner
= fsp
->pending_modtime_owner
;
533 dup_fsp
->pending_modtime
= fsp
->pending_modtime
;
534 dup_fsp
->last_write_time
= fsp
->last_write_time
;
535 dup_fsp
->oplock_type
= fsp
->oplock_type
;
536 dup_fsp
->can_lock
= fsp
->can_lock
;
537 dup_fsp
->can_read
= (access_mask
& (FILE_READ_DATA
)) ? True
: False
;
538 if (!CAN_WRITE(fsp
->conn
)) {
539 dup_fsp
->can_write
= False
;
541 dup_fsp
->can_write
= (access_mask
& (FILE_WRITE_DATA
| FILE_APPEND_DATA
)) ? True
: False
;
543 dup_fsp
->print_file
= fsp
->print_file
;
544 dup_fsp
->modified
= fsp
->modified
;
545 dup_fsp
->is_directory
= fsp
->is_directory
;
546 dup_fsp
->is_stat
= fsp
->is_stat
;
547 dup_fsp
->aio_write_behind
= fsp
->aio_write_behind
;
548 string_set(&dup_fsp
->fsp_name
,fsp
->fsp_name
);