s3: Remove some remaining files.c globals to sconn
[kai/samba-autobuild/.git] / source3 / smbd / files.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Files[] structure handling
4    Copyright (C) Andrew Tridgell 1998
5
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.
10
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.
15
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/>.
18 */
19
20 #include "includes.h"
21 #include "smbd/globals.h"
22
23 #define VALID_FNUM(fnum)   (((fnum) >= 0) && ((fnum) < real_max_open_files))
24
25 #define FILE_HANDLE_OFFSET 0x1000
26
27 /****************************************************************************
28  Return a unique number identifying this fsp over the life of this pid.
29 ****************************************************************************/
30
31 static unsigned long get_gen_count(struct smbd_server_connection *sconn)
32 {
33         sconn->file_gen_counter += 1;
34         if (sconn->file_gen_counter == 0) {
35                 sconn->file_gen_counter += 1;
36         }
37         return sconn->file_gen_counter;
38 }
39
40 /****************************************************************************
41  Find first available file slot.
42 ****************************************************************************/
43
44 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
45                   files_struct **result)
46 {
47         struct smbd_server_connection *sconn = conn->sconn;
48         int i;
49         files_struct *fsp;
50         NTSTATUS status;
51
52         /* we want to give out file handles differently on each new
53            connection because of a common bug in MS clients where they try to
54            reuse a file descriptor from an earlier smb connection. This code
55            increases the chance that the errant client will get an error rather
56            than causing corruption */
57         if (sconn->first_file == 0) {
58                 sconn->first_file = (sys_getpid() ^ (int)time(NULL));
59                 sconn->first_file %= sconn->real_max_open_files;
60         }
61
62         /* TODO: Port the id-tree implementation from Samba4 */
63
64         i = bitmap_find(sconn->file_bmap, sconn->first_file);
65         if (i == -1) {
66                 DEBUG(0,("ERROR! Out of file structures\n"));
67                 /* TODO: We have to unconditionally return a DOS error here,
68                  * W2k3 even returns ERRDOS/ERRnofids for ntcreate&x with
69                  * NTSTATUS negotiated */
70                 return NT_STATUS_TOO_MANY_OPENED_FILES;
71         }
72
73         /*
74          * Make a child of the connection_struct as an fsp can't exist
75          * independent of a connection.
76          */
77         fsp = talloc_zero(conn, struct files_struct);
78         if (!fsp) {
79                 return NT_STATUS_NO_MEMORY;
80         }
81
82         /*
83          * This can't be a child of fsp because the file_handle can be ref'd
84          * when doing a dos/fcb open, which will then share the file_handle
85          * across multiple fsps.
86          */
87         fsp->fh = talloc_zero(conn, struct fd_handle);
88         if (!fsp->fh) {
89                 TALLOC_FREE(fsp);
90                 return NT_STATUS_NO_MEMORY;
91         }
92
93         fsp->fh->ref_count = 1;
94         fsp->fh->fd = -1;
95
96         fsp->conn = conn;
97         fsp->fh->gen_id = get_gen_count(sconn);
98         GetTimeOfDay(&fsp->open_time);
99
100         sconn->first_file = (i+1) % (sconn->real_max_open_files);
101
102         bitmap_set(sconn->file_bmap, i);
103         sconn->files_used += 1;
104
105         fsp->fnum = i + FILE_HANDLE_OFFSET;
106         SMB_ASSERT(fsp->fnum < 65536);
107
108         /*
109          * Create an smb_filename with "" for the base_name.  There are very
110          * few NULL checks, so make sure it's initialized with something. to
111          * be safe until an audit can be done.
112          */
113         status = create_synthetic_smb_fname(fsp, "", NULL, NULL,
114                                             &fsp->fsp_name);
115         if (!NT_STATUS_IS_OK(status)) {
116                 TALLOC_FREE(fsp);
117                 TALLOC_FREE(fsp->fh);
118         }
119
120         DLIST_ADD(sconn->files, fsp);
121
122         DEBUG(5,("allocated file structure %d, fnum = %d (%d used)\n",
123                  i, fsp->fnum, sconn->files_used));
124
125         if (req != NULL) {
126                 req->chain_fsp = fsp;
127         }
128
129         /* A new fsp invalidates the positive and
130           negative fsp_fi_cache as the new fsp is pushed
131           at the start of the list and we search from
132           a cache hit to the *end* of the list. */
133
134         ZERO_STRUCT(sconn->fsp_fi_cache);
135
136         conn->num_files_open++;
137
138         *result = fsp;
139         return NT_STATUS_OK;
140 }
141
142 /****************************************************************************
143  Close all open files for a connection.
144 ****************************************************************************/
145
146 void file_close_conn(connection_struct *conn)
147 {
148         files_struct *fsp, *next;
149
150         for (fsp=conn->sconn->files; fsp; fsp=next) {
151                 next = fsp->next;
152                 if (fsp->conn == conn) {
153                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
154                 }
155         }
156 }
157
158 /****************************************************************************
159  Close all open files for a pid and a vuid.
160 ****************************************************************************/
161
162 void file_close_pid(struct smbd_server_connection *sconn, uint16 smbpid,
163                     int vuid)
164 {
165         files_struct *fsp, *next;
166
167         for (fsp=sconn->files;fsp;fsp=next) {
168                 next = fsp->next;
169                 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
170                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
171                 }
172         }
173 }
174
175 /****************************************************************************
176  Initialise file structures.
177 ****************************************************************************/
178
179 bool file_init(struct smbd_server_connection *sconn)
180 {
181         int request_max_open_files = lp_max_open_files();
182         int real_lim;
183
184         /*
185          * Set the max_open files to be the requested
186          * max plus a fudgefactor to allow for the extra
187          * fd's we need such as log files etc...
188          */
189         real_lim = set_maxfiles(request_max_open_files + MAX_OPEN_FUDGEFACTOR);
190
191         sconn->real_max_open_files = real_lim - MAX_OPEN_FUDGEFACTOR;
192
193         if (sconn->real_max_open_files + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES
194             > 65536)
195                 sconn->real_max_open_files =
196                         65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
197
198         if(sconn->real_max_open_files != request_max_open_files) {
199                 DEBUG(1, ("file_init: Information only: requested %d "
200                           "open files, %d are available.\n",
201                           request_max_open_files, sconn->real_max_open_files));
202         }
203
204         SMB_ASSERT(sconn->real_max_open_files > 100);
205
206         sconn->file_bmap = bitmap_talloc(sconn, sconn->real_max_open_files);
207
208         if (!sconn->file_bmap) {
209                 return false;
210         }
211         return true;
212 }
213
214 /****************************************************************************
215  Close files open by a specified vuid.
216 ****************************************************************************/
217
218 void file_close_user(struct smbd_server_connection *sconn, int vuid)
219 {
220         files_struct *fsp, *next;
221
222         for (fsp=sconn->files; fsp; fsp=next) {
223                 next=fsp->next;
224                 if (fsp->vuid == vuid) {
225                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
226                 }
227         }
228 }
229
230 /*
231  * Walk the files table until "fn" returns non-NULL
232  */
233
234 struct files_struct *files_forall(
235         struct smbd_server_connection *sconn,
236         struct files_struct *(*fn)(struct files_struct *fsp,
237                                    void *private_data),
238         void *private_data)
239 {
240         struct files_struct *fsp, *next;
241
242         for (fsp = sconn->files; fsp; fsp = next) {
243                 struct files_struct *ret;
244                 next = fsp->next;
245                 ret = fn(fsp, private_data);
246                 if (ret != NULL) {
247                         return ret;
248                 }
249         }
250         return NULL;
251 }
252
253 /****************************************************************************
254  Find a fsp given a file descriptor.
255 ****************************************************************************/
256
257 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd)
258 {
259         int count=0;
260         files_struct *fsp;
261
262         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
263                 if (fsp->fh->fd == fd) {
264                         if (count > 10) {
265                                 DLIST_PROMOTE(sconn->files, fsp);
266                         }
267                         return fsp;
268                 }
269         }
270
271         return NULL;
272 }
273
274 /****************************************************************************
275  Find a fsp given a device, inode and file_id.
276 ****************************************************************************/
277
278 files_struct *file_find_dif(struct smbd_server_connection *sconn,
279                             struct file_id id, unsigned long gen_id)
280 {
281         int count=0;
282         files_struct *fsp;
283
284         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
285                 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
286                 if (file_id_equal(&fsp->file_id, &id) &&
287                     fsp->fh->gen_id == gen_id ) {
288                         if (count > 10) {
289                                 DLIST_PROMOTE(sconn->files, fsp);
290                         }
291                         /* Paranoia check. */
292                         if ((fsp->fh->fd == -1) &&
293                             (fsp->oplock_type != NO_OPLOCK) &&
294                             (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK)) {
295                                 DEBUG(0,("file_find_dif: file %s file_id = "
296                                          "%s, gen = %u oplock_type = %u is a "
297                                          "stat open with oplock type !\n",
298                                          fsp_str_dbg(fsp),
299                                          file_id_string_tos(&fsp->file_id),
300                                          (unsigned int)fsp->fh->gen_id,
301                                          (unsigned int)fsp->oplock_type ));
302                                 smb_panic("file_find_dif");
303                         }
304                         return fsp;
305                 }
306         }
307
308         return NULL;
309 }
310
311 /****************************************************************************
312  Find the first fsp given a device and inode.
313  We use a singleton cache here to speed up searching from getfilepathinfo
314  calls.
315 ****************************************************************************/
316
317 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
318                                  struct file_id id)
319 {
320         files_struct *fsp;
321
322         if (file_id_equal(&sconn->fsp_fi_cache.id, &id)) {
323                 /* Positive or negative cache hit. */
324                 return sconn->fsp_fi_cache.fsp;
325         }
326
327         sconn->fsp_fi_cache.id = id;
328
329         for (fsp=sconn->files;fsp;fsp=fsp->next) {
330                 if (file_id_equal(&fsp->file_id, &id)) {
331                         /* Setup positive cache. */
332                         sconn->fsp_fi_cache.fsp = fsp;
333                         return fsp;
334                 }
335         }
336
337         /* Setup negative cache. */
338         sconn->fsp_fi_cache.fsp = NULL;
339         return NULL;
340 }
341
342 /****************************************************************************
343  Find the next fsp having the same device and inode.
344 ****************************************************************************/
345
346 files_struct *file_find_di_next(files_struct *start_fsp)
347 {
348         files_struct *fsp;
349
350         for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
351                 if (file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
352                         return fsp;
353                 }
354         }
355
356         return NULL;
357 }
358
359 /****************************************************************************
360  Find any fsp open with a pathname below that of an already open path.
361 ****************************************************************************/
362
363 bool file_find_subpath(files_struct *dir_fsp)
364 {
365         files_struct *fsp;
366         size_t dlen;
367         char *d_fullname = NULL;
368
369         d_fullname = talloc_asprintf(talloc_tos(), "%s/%s",
370                                      dir_fsp->conn->connectpath,
371                                      dir_fsp->fsp_name->base_name);
372
373         if (!d_fullname) {
374                 return false;
375         }
376
377         dlen = strlen(d_fullname);
378
379         for (fsp=dir_fsp->conn->sconn->files; fsp; fsp=fsp->next) {
380                 char *d1_fullname;
381
382                 if (fsp == dir_fsp) {
383                         continue;
384                 }
385
386                 d1_fullname = talloc_asprintf(talloc_tos(),
387                                         "%s/%s",
388                                         fsp->conn->connectpath,
389                                         fsp->fsp_name->base_name);
390
391                 /*
392                  * If the open file has a path that is a longer
393                  * component, then it's a subpath.
394                  */
395                 if (strnequal(d_fullname, d1_fullname, dlen) &&
396                                 (d1_fullname[dlen] == '/')) {
397                         TALLOC_FREE(d1_fullname);
398                         TALLOC_FREE(d_fullname);
399                         return true;
400                 }
401                 TALLOC_FREE(d1_fullname);
402         }
403
404         TALLOC_FREE(d_fullname);
405         return false;
406 }
407
408 /****************************************************************************
409  Sync open files on a connection.
410 ****************************************************************************/
411
412 void file_sync_all(connection_struct *conn)
413 {
414         files_struct *fsp, *next;
415
416         for (fsp=conn->sconn->files; fsp; fsp=next) {
417                 next=fsp->next;
418                 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
419                         sync_file(conn, fsp, True /* write through */);
420                 }
421         }
422 }
423
424 /****************************************************************************
425  Free up a fsp.
426 ****************************************************************************/
427
428 void file_free(struct smb_request *req, files_struct *fsp)
429 {
430         struct smbd_server_connection *sconn = fsp->conn->sconn;
431
432         DLIST_REMOVE(sconn->files, fsp);
433
434         TALLOC_FREE(fsp->fake_file_handle);
435
436         if (fsp->fh->ref_count == 1) {
437                 TALLOC_FREE(fsp->fh);
438         } else {
439                 fsp->fh->ref_count--;
440         }
441
442         if (fsp->notify) {
443                 if (fsp->is_directory) {
444                         notify_remove_onelevel(fsp->conn->notify_ctx,
445                                                &fsp->file_id, fsp);
446                 }
447                 notify_remove(fsp->conn->notify_ctx, fsp);
448                 TALLOC_FREE(fsp->notify);
449         }
450
451         /* Ensure this event will never fire. */
452         TALLOC_FREE(fsp->oplock_timeout);
453
454         /* Ensure this event will never fire. */
455         TALLOC_FREE(fsp->update_write_time_event);
456
457         bitmap_clear(sconn->file_bmap, fsp->fnum - FILE_HANDLE_OFFSET);
458         sconn->files_used--;
459
460         DEBUG(5,("freed files structure %d (%d used)\n",
461                  fsp->fnum, sconn->files_used));
462
463         fsp->conn->num_files_open--;
464
465         if ((req != NULL) && (fsp == req->chain_fsp)) {
466                 req->chain_fsp = NULL;
467         }
468
469         /*
470          * Clear all possible chained fsp
471          * pointers in the SMB2 request queue.
472          */
473         if (req != NULL && req->smb2req) {
474                 remove_smb2_chained_fsp(fsp);
475         }
476
477         /* Closing a file can invalidate the positive cache. */
478         if (fsp == sconn->fsp_fi_cache.fsp) {
479                 ZERO_STRUCT(sconn->fsp_fi_cache);
480         }
481
482         /* Drop all remaining extensions. */
483         while (fsp->vfs_extension) {
484                 vfs_remove_fsp_extension(fsp->vfs_extension->owner, fsp);
485         }
486
487         /* this is paranoia, just in case someone tries to reuse the
488            information */
489         ZERO_STRUCTP(fsp);
490
491         /* fsp->fsp_name is a talloc child and is free'd automatically. */
492         TALLOC_FREE(fsp);
493 }
494
495 /****************************************************************************
496  Get an fsp from a 16 bit fnum.
497 ****************************************************************************/
498
499 static struct files_struct *file_fnum(struct smbd_server_connection *sconn,
500                                       uint16 fnum)
501 {
502         files_struct *fsp;
503         int count=0;
504
505         for (fsp=sconn->files; fsp; fsp=fsp->next, count++) {
506                 if (fsp->fnum == fnum) {
507                         if (count > 10) {
508                                 DLIST_PROMOTE(sconn->files, fsp);
509                         }
510                         return fsp;
511                 }
512         }
513         return NULL;
514 }
515
516 /****************************************************************************
517  Get an fsp from a packet given a 16 bit fnum.
518 ****************************************************************************/
519
520 files_struct *file_fsp(struct smb_request *req, uint16 fid)
521 {
522         files_struct *fsp;
523
524         if (req == NULL) {
525                 /*
526                  * We should never get here. req==NULL could in theory
527                  * only happen from internal opens with a non-zero
528                  * root_dir_fid. Internal opens just don't do that, at
529                  * least they are not supposed to do so. And if they
530                  * start to do so, they better fake up a smb_request
531                  * from which we get the right smbd_server_conn. While
532                  * this should never happen, let's return NULL here.
533                  */
534                 return NULL;
535         }
536
537         if (req->chain_fsp != NULL) {
538                 return req->chain_fsp;
539         }
540
541         fsp = file_fnum(req->sconn, fid);
542         if (fsp != NULL) {
543                 req->chain_fsp = fsp;
544         }
545         return fsp;
546 }
547
548 /****************************************************************************
549  Duplicate the file handle part for a DOS or FCB open.
550 ****************************************************************************/
551
552 NTSTATUS dup_file_fsp(struct smb_request *req, files_struct *from,
553                       uint32 access_mask, uint32 share_access,
554                       uint32 create_options, files_struct *to)
555 {
556         TALLOC_FREE(to->fh);
557
558         to->fh = from->fh;
559         to->fh->ref_count++;
560
561         to->file_id = from->file_id;
562         to->initial_allocation_size = from->initial_allocation_size;
563         to->mode = from->mode;
564         to->file_pid = from->file_pid;
565         to->vuid = from->vuid;
566         to->open_time = from->open_time;
567         to->access_mask = access_mask;
568         to->share_access = share_access;
569         to->oplock_type = from->oplock_type;
570         to->can_lock = from->can_lock;
571         to->can_read = (access_mask & (FILE_READ_DATA)) ? True : False;
572         if (!CAN_WRITE(from->conn)) {
573                 to->can_write = False;
574         } else {
575                 to->can_write = (access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) ? True : False;
576         }
577         to->modified = from->modified;
578         to->is_directory = from->is_directory;
579         to->aio_write_behind = from->aio_write_behind;
580
581         if (from->print_file) {
582                 to->print_file = talloc(to, struct print_file_data);
583                 if (!to->print_file) return NT_STATUS_NO_MEMORY;
584                 to->print_file->rap_jobid = from->print_file->rap_jobid;
585         } else {
586                 to->print_file = NULL;
587         }
588
589         return fsp_set_smb_fname(to, from->fsp_name);
590 }
591
592 /**
593  * The only way that the fsp->fsp_name field should ever be set.
594  */
595 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
596                            const struct smb_filename *smb_fname_in)
597 {
598         NTSTATUS status;
599         struct smb_filename *smb_fname_new;
600
601         status = copy_smb_filename(fsp, smb_fname_in, &smb_fname_new);
602         if (!NT_STATUS_IS_OK(status)) {
603                 return status;
604         }
605
606         TALLOC_FREE(fsp->fsp_name);
607         fsp->fsp_name = smb_fname_new;
608
609         return NT_STATUS_OK;
610 }