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 NTSTATUS
file_new(connection_struct
*conn
, files_struct
**result
)
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 return NT_STATUS_TOO_MANY_OPENED_FILES
;
88 fsp
= SMB_MALLOC_P(files_struct
);
90 return NT_STATUS_NO_MEMORY
;
95 fsp
->fh
= SMB_MALLOC_P(struct fd_handle
);
98 return NT_STATUS_NO_MEMORY
;
101 ZERO_STRUCTP(fsp
->fh
);
103 fsp
->fh
->ref_count
= 1;
107 fsp
->fh
->file_id
= get_gen_count();
108 GetTimeOfDay(&fsp
->open_time
);
110 first_file
= (i
+1) % real_max_open_files
;
112 bitmap_set(file_bmap
, i
);
115 fsp
->fnum
= i
+ FILE_HANDLE_OFFSET
;
116 SMB_ASSERT(fsp
->fnum
< 65536);
118 string_set(&fsp
->fsp_name
,"");
120 DLIST_ADD(Files
, fsp
);
122 DEBUG(5,("allocated file structure %d, fnum = %d (%d used)\n",
123 i
, fsp
->fnum
, files_used
));
127 /* A new fsp invalidates a negative fsp_fi_cache. */
128 if (fsp_fi_cache
.fsp
== NULL
) {
129 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(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(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(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, fileid = %lu, dev = %x, inode = %.0f\n",
237 count
, fsp
->fnum
, fsp
->fsp_name
, fsp
->fh
->fd
, (unsigned long)fsp
->fh
->file_id
,
238 (unsigned int)fsp
->dev
, (double)fsp
->inode
));
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(SMB_DEV_T dev
, SMB_INO_T inode
, unsigned long file_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 (fsp
->dev
== dev
&&
275 fsp
->inode
== inode
&&
276 fsp
->fh
->file_id
== file_id
) {
278 DLIST_PROMOTE(Files
, fsp
);
280 /* Paranoia check. */
281 if ((fsp
->fh
->fd
== -1) &&
282 (fsp
->oplock_type
!= NO_OPLOCK
) &&
283 (fsp
->oplock_type
!= FAKE_LEVEL_II_OPLOCK
)) {
284 DEBUG(0,("file_find_dif: file %s dev = %x, inode = %.0f, file_id = %u \
285 oplock_type = %u is a stat open with oplock type !\n", fsp
->fsp_name
, (unsigned int)fsp
->dev
,
286 (double)fsp
->inode
, (unsigned int)fsp
->fh
->file_id
,
287 (unsigned int)fsp
->oplock_type
));
288 smb_panic("file_find_dif\n");
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(SMB_DEV_T dev
, SMB_INO_T inode
)
323 if (fsp_fi_cache
.dev
== dev
&& fsp_fi_cache
.inode
== inode
) {
324 /* Positive or negative cache hit. */
325 return fsp_fi_cache
.fsp
;
328 fsp_fi_cache
.dev
= dev
;
329 fsp_fi_cache
.inode
= inode
;
331 for (fsp
=Files
;fsp
;fsp
=fsp
->next
) {
332 if ( fsp
->fh
->fd
!= -1 &&
334 fsp
->inode
== inode
) {
335 /* Setup positive cache. */
336 fsp_fi_cache
.fsp
= fsp
;
341 /* Setup negative cache. */
342 fsp_fi_cache
.fsp
= NULL
;
346 /****************************************************************************
347 Find the next fsp having the same device and inode.
348 ****************************************************************************/
350 files_struct
*file_find_di_next(files_struct
*start_fsp
)
354 for (fsp
= start_fsp
->next
;fsp
;fsp
=fsp
->next
) {
355 if ( fsp
->fh
->fd
!= -1 &&
356 fsp
->dev
== start_fsp
->dev
&&
357 fsp
->inode
== start_fsp
->inode
)
364 /****************************************************************************
365 Find a fsp that is open for printing.
366 ****************************************************************************/
368 files_struct
*file_find_print(void)
372 for (fsp
=Files
;fsp
;fsp
=fsp
->next
) {
373 if (fsp
->print_file
) {
381 /****************************************************************************
382 Set a pending modtime across all files with a given dev/ino pair.
383 Record the owner of that modtime.
384 ****************************************************************************/
386 void fsp_set_pending_modtime(files_struct
*tfsp
, const struct timespec mod
)
390 if (null_timespec(mod
)) {
394 for (fsp
= Files
;fsp
;fsp
=fsp
->next
) {
395 if ( fsp
->fh
->fd
!= -1 &&
396 fsp
->dev
== tfsp
->dev
&&
397 fsp
->inode
== tfsp
->inode
) {
398 fsp
->pending_modtime
= mod
;
399 fsp
->pending_modtime_owner
= False
;
403 tfsp
->pending_modtime_owner
= True
;
406 /****************************************************************************
407 Sync open files on a connection.
408 ****************************************************************************/
410 void file_sync_all(connection_struct
*conn
)
412 files_struct
*fsp
, *next
;
414 for (fsp
=Files
;fsp
;fsp
=next
) {
416 if ((conn
== fsp
->conn
) && (fsp
->fh
->fd
!= -1)) {
417 sync_file(conn
, fsp
, True
/* write through */);
422 /****************************************************************************
424 ****************************************************************************/
426 void file_free(files_struct
*fsp
)
428 DLIST_REMOVE(Files
, fsp
);
430 string_free(&fsp
->fsp_name
);
432 if (fsp
->fake_file_handle
) {
433 destroy_fake_file_handle(&fsp
->fake_file_handle
);
436 if (fsp
->fh
->ref_count
== 1) {
439 fsp
->fh
->ref_count
--;
443 notify_remove(fsp
->conn
->notify_ctx
, fsp
);
444 TALLOC_FREE(fsp
->notify
);
447 bitmap_clear(file_bmap
, fsp
->fnum
- FILE_HANDLE_OFFSET
);
450 DEBUG(5,("freed files structure %d (%d used)\n",
451 fsp
->fnum
, files_used
));
453 /* this is paranoia, just in case someone tries to reuse the
457 if (fsp
== chain_fsp
) {
461 /* Closing a file can invalidate the positive cache. */
462 if (fsp
== fsp_fi_cache
.fsp
) {
463 ZERO_STRUCT(fsp_fi_cache
);
469 /****************************************************************************
470 Get an fsp from a 16 bit fnum.
471 ****************************************************************************/
473 files_struct
*file_fnum(uint16 fnum
)
478 for (fsp
=Files
;fsp
;fsp
=fsp
->next
, count
++) {
479 if (fsp
->fnum
== fnum
) {
481 DLIST_PROMOTE(Files
, fsp
);
489 /****************************************************************************
490 Get an fsp from a packet given the offset of a 16 bit fnum.
491 ****************************************************************************/
493 files_struct
*file_fsp(char *buf
, int where
)
505 fsp
= file_fnum(SVAL(buf
, where
));
512 /****************************************************************************
513 Reset the chained fsp - done at the start of a packet reply.
514 ****************************************************************************/
516 void file_chain_reset(void)
521 /****************************************************************************
522 Duplicate the file handle part for a DOS or FCB open.
523 ****************************************************************************/
525 NTSTATUS
dup_file_fsp(files_struct
*fsp
,
528 uint32 create_options
,
529 files_struct
**result
)
532 files_struct
*dup_fsp
;
534 status
= file_new(fsp
->conn
, &dup_fsp
);
536 if (!NT_STATUS_IS_OK(status
)) {
540 SAFE_FREE(dup_fsp
->fh
);
542 dup_fsp
->fh
= fsp
->fh
;
543 dup_fsp
->fh
->ref_count
++;
545 dup_fsp
->dev
= fsp
->dev
;
546 dup_fsp
->inode
= fsp
->inode
;
547 dup_fsp
->initial_allocation_size
= fsp
->initial_allocation_size
;
548 dup_fsp
->mode
= fsp
->mode
;
549 dup_fsp
->file_pid
= fsp
->file_pid
;
550 dup_fsp
->vuid
= fsp
->vuid
;
551 dup_fsp
->open_time
= fsp
->open_time
;
552 dup_fsp
->access_mask
= access_mask
;
553 dup_fsp
->share_access
= share_access
;
554 dup_fsp
->pending_modtime_owner
= fsp
->pending_modtime_owner
;
555 dup_fsp
->pending_modtime
= fsp
->pending_modtime
;
556 dup_fsp
->last_write_time
= fsp
->last_write_time
;
557 dup_fsp
->oplock_type
= fsp
->oplock_type
;
558 dup_fsp
->can_lock
= fsp
->can_lock
;
559 dup_fsp
->can_read
= (access_mask
& (FILE_READ_DATA
)) ? True
: False
;
560 if (!CAN_WRITE(fsp
->conn
)) {
561 dup_fsp
->can_write
= False
;
563 dup_fsp
->can_write
= (access_mask
& (FILE_WRITE_DATA
| FILE_APPEND_DATA
)) ? True
: False
;
565 dup_fsp
->print_file
= fsp
->print_file
;
566 dup_fsp
->modified
= fsp
->modified
;
567 dup_fsp
->is_directory
= fsp
->is_directory
;
568 dup_fsp
->is_stat
= fsp
->is_stat
;
569 string_set(&dup_fsp
->fsp_name
,fsp
->fsp_name
);