smbd: Remove "file_sync_all" function
[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/smbd.h"
22 #include "smbd/globals.h"
23 #include "libcli/security/security.h"
24 #include "util_tdb.h"
25 #include "lib/util/bitmap.h"
26
27 #define FILE_HANDLE_OFFSET 0x1000
28
29 /**
30  * create new fsp to be used for file_new or a durable handle reconnect
31  */
32 NTSTATUS fsp_new(struct connection_struct *conn, TALLOC_CTX *mem_ctx,
33                  files_struct **result)
34 {
35         NTSTATUS status = NT_STATUS_NO_MEMORY;
36         files_struct *fsp = NULL;
37         struct smbd_server_connection *sconn = conn->sconn;
38
39         fsp = talloc_zero(mem_ctx, struct files_struct);
40         if (fsp == NULL) {
41                 goto fail;
42         }
43
44         /*
45          * This can't be a child of fsp because the file_handle can be ref'd
46          * when doing a dos/fcb open, which will then share the file_handle
47          * across multiple fsps.
48          */
49         fsp->fh = talloc_zero(mem_ctx, struct fd_handle);
50         if (fsp->fh == NULL) {
51                 goto fail;
52         }
53
54         fsp->fh->ref_count = 1;
55         fsp->fh->fd = -1;
56
57         fsp->fnum = FNUM_FIELD_INVALID;
58         fsp->conn = conn;
59
60         DLIST_ADD(sconn->files, fsp);
61         sconn->num_files += 1;
62
63         conn->num_files_open++;
64
65         *result = fsp;
66         return NT_STATUS_OK;
67
68 fail:
69         if (fsp != NULL) {
70                 TALLOC_FREE(fsp->fh);
71         }
72         TALLOC_FREE(fsp);
73
74         return status;
75 }
76
77 /****************************************************************************
78  Find first available file slot.
79 ****************************************************************************/
80
81 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
82                   files_struct **result)
83 {
84         struct smbd_server_connection *sconn = conn->sconn;
85         files_struct *fsp;
86         NTSTATUS status;
87
88         status = fsp_new(conn, conn, &fsp);
89         if (!NT_STATUS_IS_OK(status)) {
90                 return status;
91         }
92
93         GetTimeOfDay(&fsp->open_time);
94
95         if (req) {
96                 struct smbXsrv_connection *xconn = req->xconn;
97                 struct smbXsrv_open *op = NULL;
98                 NTTIME now = timeval_to_nttime(&fsp->open_time);
99
100                 status = smbXsrv_open_create(xconn,
101                                              conn->session_info,
102                                              now, &op);
103                 if (!NT_STATUS_IS_OK(status)) {
104                         file_free(NULL, fsp);
105                         return status;
106                 }
107                 fsp->op = op;
108                 op->compat = fsp;
109                 fsp->fnum = op->local_id;
110                 fsp->fh->gen_id = smbXsrv_open_hash(op);
111         } else {
112                 DEBUG(10, ("%s: req==NULL, INTERNAL_OPEN_ONLY, smbXsrv_open "
113                            "allocated\n", __func__));
114         }
115
116         /*
117          * Create an smb_filename with "" for the base_name.  There are very
118          * few NULL checks, so make sure it's initialized with something. to
119          * be safe until an audit can be done.
120          */
121         fsp->fsp_name = synthetic_smb_fname(fsp, "", NULL, NULL, 0);
122         if (fsp->fsp_name == NULL) {
123                 file_free(NULL, fsp);
124                 return NT_STATUS_NO_MEMORY;
125         }
126
127         DEBUG(5,("allocated file structure %s (%u used)\n",
128                  fsp_fnum_dbg(fsp), (unsigned int)sconn->num_files));
129
130         if (req != NULL) {
131                 fsp->mid = req->mid;
132                 req->chain_fsp = fsp;
133         }
134
135         /* A new fsp invalidates the positive and
136           negative fsp_fi_cache as the new fsp is pushed
137           at the start of the list and we search from
138           a cache hit to the *end* of the list. */
139
140         ZERO_STRUCT(sconn->fsp_fi_cache);
141
142         *result = fsp;
143         return NT_STATUS_OK;
144 }
145
146 /****************************************************************************
147  Close all open files for a connection.
148 ****************************************************************************/
149
150 void file_close_conn(connection_struct *conn)
151 {
152         files_struct *fsp, *next;
153
154         for (fsp=conn->sconn->files; fsp; fsp=next) {
155                 next = fsp->next;
156                 if (fsp->conn != conn) {
157                         continue;
158                 }
159                 if (fsp->op != NULL && fsp->op->global->durable) {
160                         /*
161                          * A tree disconnect closes a durable handle
162                          */
163                         fsp->op->global->durable = false;
164                 }
165                 close_file(NULL, fsp, SHUTDOWN_CLOSE);
166         }
167 }
168
169 /****************************************************************************
170  Close all open files for a pid and a vuid.
171 ****************************************************************************/
172
173 void file_close_pid(struct smbd_server_connection *sconn, uint16_t smbpid,
174                     uint64_t vuid)
175 {
176         files_struct *fsp, *next;
177
178         for (fsp=sconn->files;fsp;fsp=next) {
179                 next = fsp->next;
180                 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
181                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
182                 }
183         }
184 }
185
186 /****************************************************************************
187  Initialise file structures.
188 ****************************************************************************/
189
190 static int files_max_open_fds;
191
192 bool file_init_global(void)
193 {
194         int request_max = lp_max_open_files();
195         int real_lim;
196         int real_max;
197
198         if (files_max_open_fds != 0) {
199                 return true;
200         }
201
202         /*
203          * Set the max_open files to be the requested
204          * max plus a fudgefactor to allow for the extra
205          * fd's we need such as log files etc...
206          */
207         real_lim = set_maxfiles(request_max + MAX_OPEN_FUDGEFACTOR);
208
209         real_max = real_lim - MAX_OPEN_FUDGEFACTOR;
210
211         if (real_max + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES > 65536) {
212                 real_max = 65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
213         }
214
215         if (real_max != request_max) {
216                 DEBUG(1, ("file_init_global: Information only: requested %d "
217                           "open files, %d are available.\n",
218                           request_max, real_max));
219         }
220
221         SMB_ASSERT(real_max > 100);
222
223         files_max_open_fds = real_max;
224         return true;
225 }
226
227 bool file_init(struct smbd_server_connection *sconn)
228 {
229         bool ok;
230
231         ok = file_init_global();
232         if (!ok) {
233                 return false;
234         }
235
236         sconn->real_max_open_files = files_max_open_fds;
237
238         return true;
239 }
240
241 /****************************************************************************
242  Close files open by a specified vuid.
243 ****************************************************************************/
244
245 void file_close_user(struct smbd_server_connection *sconn, uint64_t vuid)
246 {
247         files_struct *fsp, *next;
248
249         for (fsp=sconn->files; fsp; fsp=next) {
250                 next=fsp->next;
251                 if (fsp->vuid == vuid) {
252                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
253                 }
254         }
255 }
256
257 /*
258  * Walk the files table until "fn" returns non-NULL
259  */
260
261 struct files_struct *files_forall(
262         struct smbd_server_connection *sconn,
263         struct files_struct *(*fn)(struct files_struct *fsp,
264                                    void *private_data),
265         void *private_data)
266 {
267         struct files_struct *fsp, *next;
268
269         for (fsp = sconn->files; fsp; fsp = next) {
270                 struct files_struct *ret;
271                 next = fsp->next;
272                 ret = fn(fsp, private_data);
273                 if (ret != NULL) {
274                         return ret;
275                 }
276         }
277         return NULL;
278 }
279
280 /****************************************************************************
281  Find a fsp given a file descriptor.
282 ****************************************************************************/
283
284 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd)
285 {
286         int count=0;
287         files_struct *fsp;
288
289         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
290                 if (fsp->fh->fd == fd) {
291                         if (count > 10) {
292                                 DLIST_PROMOTE(sconn->files, fsp);
293                         }
294                         return fsp;
295                 }
296         }
297
298         return NULL;
299 }
300
301 /****************************************************************************
302  Find a fsp given a device, inode and file_id.
303 ****************************************************************************/
304
305 files_struct *file_find_dif(struct smbd_server_connection *sconn,
306                             struct file_id id, unsigned long gen_id)
307 {
308         int count=0;
309         files_struct *fsp;
310
311         if (gen_id == 0) {
312                 return NULL;
313         }
314
315         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
316                 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
317                 if (file_id_equal(&fsp->file_id, &id) &&
318                     fsp->fh->gen_id == gen_id ) {
319                         if (count > 10) {
320                                 DLIST_PROMOTE(sconn->files, fsp);
321                         }
322                         /* Paranoia check. */
323                         if ((fsp->fh->fd == -1) &&
324                             (fsp->oplock_type != NO_OPLOCK &&
325                              fsp->oplock_type != LEASE_OPLOCK)) {
326                                 DEBUG(0,("file_find_dif: file %s file_id = "
327                                          "%s, gen = %u oplock_type = %u is a "
328                                          "stat open with oplock type !\n",
329                                          fsp_str_dbg(fsp),
330                                          file_id_string_tos(&fsp->file_id),
331                                          (unsigned int)fsp->fh->gen_id,
332                                          (unsigned int)fsp->oplock_type ));
333                                 smb_panic("file_find_dif");
334                         }
335                         return fsp;
336                 }
337         }
338
339         return NULL;
340 }
341
342 /****************************************************************************
343  Find the first fsp given a device and inode.
344  We use a singleton cache here to speed up searching from getfilepathinfo
345  calls.
346 ****************************************************************************/
347
348 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
349                                  struct file_id id)
350 {
351         files_struct *fsp;
352
353         if (file_id_equal(&sconn->fsp_fi_cache.id, &id)) {
354                 /* Positive or negative cache hit. */
355                 return sconn->fsp_fi_cache.fsp;
356         }
357
358         sconn->fsp_fi_cache.id = id;
359
360         for (fsp=sconn->files;fsp;fsp=fsp->next) {
361                 if (file_id_equal(&fsp->file_id, &id)) {
362                         /* Setup positive cache. */
363                         sconn->fsp_fi_cache.fsp = fsp;
364                         return fsp;
365                 }
366         }
367
368         /* Setup negative cache. */
369         sconn->fsp_fi_cache.fsp = NULL;
370         return NULL;
371 }
372
373 /****************************************************************************
374  Find the next fsp having the same device and inode.
375 ****************************************************************************/
376
377 files_struct *file_find_di_next(files_struct *start_fsp)
378 {
379         files_struct *fsp;
380
381         for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
382                 if (file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
383                         return fsp;
384                 }
385         }
386
387         return NULL;
388 }
389
390 struct files_struct *file_find_one_fsp_from_lease_key(
391         struct smbd_server_connection *sconn,
392         const struct smb2_lease_key *lease_key)
393 {
394         struct files_struct *fsp;
395
396         for (fsp = sconn->files; fsp; fsp=fsp->next) {
397                 if ((fsp->lease != NULL) &&
398                     (fsp->lease->lease.lease_key.data[0] ==
399                      lease_key->data[0]) &&
400                     (fsp->lease->lease.lease_key.data[1] ==
401                      lease_key->data[1])) {
402                         return fsp;
403                 }
404         }
405         return NULL;
406 }
407
408 /****************************************************************************
409  Find any fsp open with a pathname below that of an already open path.
410 ****************************************************************************/
411
412 bool file_find_subpath(files_struct *dir_fsp)
413 {
414         files_struct *fsp;
415         size_t dlen;
416         char *d_fullname = NULL;
417
418         d_fullname = talloc_asprintf(talloc_tos(), "%s/%s",
419                                      dir_fsp->conn->connectpath,
420                                      dir_fsp->fsp_name->base_name);
421
422         if (!d_fullname) {
423                 return false;
424         }
425
426         dlen = strlen(d_fullname);
427
428         for (fsp=dir_fsp->conn->sconn->files; fsp; fsp=fsp->next) {
429                 char *d1_fullname;
430
431                 if (fsp == dir_fsp) {
432                         continue;
433                 }
434
435                 d1_fullname = talloc_asprintf(talloc_tos(),
436                                         "%s/%s",
437                                         fsp->conn->connectpath,
438                                         fsp->fsp_name->base_name);
439
440                 /*
441                  * If the open file has a path that is a longer
442                  * component, then it's a subpath.
443                  */
444                 if (strnequal(d_fullname, d1_fullname, dlen) &&
445                                 (d1_fullname[dlen] == '/')) {
446                         TALLOC_FREE(d1_fullname);
447                         TALLOC_FREE(d_fullname);
448                         return true;
449                 }
450                 TALLOC_FREE(d1_fullname);
451         }
452
453         TALLOC_FREE(d_fullname);
454         return false;
455 }
456
457 /****************************************************************************
458  Free up a fsp.
459 ****************************************************************************/
460
461 void fsp_free(files_struct *fsp)
462 {
463         struct smbd_server_connection *sconn = fsp->conn->sconn;
464
465         if (fsp == sconn->fsp_fi_cache.fsp) {
466                 ZERO_STRUCT(sconn->fsp_fi_cache);
467         }
468
469         DLIST_REMOVE(sconn->files, fsp);
470         SMB_ASSERT(sconn->num_files > 0);
471         sconn->num_files--;
472
473         TALLOC_FREE(fsp->fake_file_handle);
474
475         if (fsp->fh->ref_count == 1) {
476                 TALLOC_FREE(fsp->fh);
477         } else {
478                 fsp->fh->ref_count--;
479         }
480
481         if (fsp->lease != NULL) {
482                 if (fsp->lease->ref_count == 1) {
483                         TALLOC_FREE(fsp->lease);
484                 } else {
485                         fsp->lease->ref_count--;
486                 }
487         }
488
489         fsp->conn->num_files_open--;
490
491         /* this is paranoia, just in case someone tries to reuse the
492            information */
493         ZERO_STRUCTP(fsp);
494
495         /* fsp->fsp_name is a talloc child and is free'd automatically. */
496         TALLOC_FREE(fsp);
497 }
498
499 void file_free(struct smb_request *req, files_struct *fsp)
500 {
501         struct smbd_server_connection *sconn = fsp->conn->sconn;
502         uint64_t fnum = fsp->fnum;
503
504         if (fsp->notify) {
505                 size_t len = fsp_fullbasepath(fsp, NULL, 0);
506                 char fullpath[len+1];
507
508                 fsp_fullbasepath(fsp, fullpath, sizeof(fullpath));
509
510                 /*
511                  * Avoid /. at the end of the path name. notify can't
512                  * deal with it.
513                  */
514                 if (len > 1 && fullpath[len-1] == '.' &&
515                     fullpath[len-2] == '/') {
516                         fullpath[len-2] = '\0';
517                 }
518
519                 notify_remove(fsp->conn->sconn->notify_ctx, fsp, fullpath);
520                 TALLOC_FREE(fsp->notify);
521         }
522
523         /* Ensure this event will never fire. */
524         TALLOC_FREE(fsp->update_write_time_event);
525
526         if (fsp->op != NULL) {
527                 fsp->op->compat = NULL;
528         }
529         TALLOC_FREE(fsp->op);
530
531         if ((req != NULL) && (fsp == req->chain_fsp)) {
532                 req->chain_fsp = NULL;
533         }
534
535         /*
536          * Clear all possible chained fsp
537          * pointers in the SMB2 request queue.
538          */
539         remove_smb2_chained_fsp(fsp);
540
541         /* Drop all remaining extensions. */
542         vfs_remove_all_fsp_extensions(fsp);
543
544         fsp_free(fsp);
545
546         DEBUG(5,("freed files structure %llu (%u used)\n",
547                  (unsigned long long)fnum, (unsigned int)sconn->num_files));
548 }
549
550 /****************************************************************************
551  Get an fsp from a packet given a 16 bit fnum.
552 ****************************************************************************/
553
554 files_struct *file_fsp(struct smb_request *req, uint16_t fid)
555 {
556         struct smbXsrv_open *op;
557         NTSTATUS status;
558         NTTIME now = 0;
559         files_struct *fsp;
560
561         if (req == NULL) {
562                 /*
563                  * We should never get here. req==NULL could in theory
564                  * only happen from internal opens with a non-zero
565                  * root_dir_fid. Internal opens just don't do that, at
566                  * least they are not supposed to do so. And if they
567                  * start to do so, they better fake up a smb_request
568                  * from which we get the right smbd_server_conn. While
569                  * this should never happen, let's return NULL here.
570                  */
571                 return NULL;
572         }
573
574         if (req->chain_fsp != NULL) {
575                 if (req->chain_fsp->deferred_close) {
576                         return NULL;
577                 }
578                 return req->chain_fsp;
579         }
580
581         if (req->xconn == NULL) {
582                 return NULL;
583         }
584
585         now = timeval_to_nttime(&req->request_time);
586
587         status = smb1srv_open_lookup(req->xconn,
588                                      fid, now, &op);
589         if (!NT_STATUS_IS_OK(status)) {
590                 return NULL;
591         }
592
593         fsp = op->compat;
594         if (fsp == NULL) {
595                 return NULL;
596         }
597
598         if (fsp->deferred_close) {
599                 return NULL;
600         }
601
602         req->chain_fsp = fsp;
603         return fsp;
604 }
605
606 struct files_struct *file_fsp_get(struct smbd_smb2_request *smb2req,
607                                   uint64_t persistent_id,
608                                   uint64_t volatile_id)
609 {
610         struct smbXsrv_open *op;
611         NTSTATUS status;
612         NTTIME now = 0;
613         struct files_struct *fsp;
614
615         now = timeval_to_nttime(&smb2req->request_time);
616
617         status = smb2srv_open_lookup(smb2req->xconn,
618                                      persistent_id, volatile_id,
619                                      now, &op);
620         if (!NT_STATUS_IS_OK(status)) {
621                 return NULL;
622         }
623
624         fsp = op->compat;
625         if (fsp == NULL) {
626                 return NULL;
627         }
628
629         if (smb2req->tcon == NULL) {
630                 return NULL;
631         }
632
633         if (smb2req->tcon->compat != fsp->conn) {
634                 return NULL;
635         }
636
637         if (smb2req->session == NULL) {
638                 return NULL;
639         }
640
641         if (smb2req->session->compat == NULL) {
642                 return NULL;
643         }
644
645         if (smb2req->session->compat->vuid != fsp->vuid) {
646                 return NULL;
647         }
648
649         if (fsp->deferred_close) {
650                 return NULL;
651         }
652
653         return fsp;
654 }
655
656 struct files_struct *file_fsp_smb2(struct smbd_smb2_request *smb2req,
657                                    uint64_t persistent_id,
658                                    uint64_t volatile_id)
659 {
660         struct files_struct *fsp;
661
662         if (smb2req->compat_chain_fsp != NULL) {
663                 if (smb2req->compat_chain_fsp->deferred_close) {
664                         return NULL;
665                 }
666                 return smb2req->compat_chain_fsp;
667         }
668
669         fsp = file_fsp_get(smb2req, persistent_id, volatile_id);
670         if (fsp == NULL) {
671                 return NULL;
672         }
673
674         smb2req->compat_chain_fsp = fsp;
675         return fsp;
676 }
677
678 /****************************************************************************
679  Duplicate the file handle part for a DOS or FCB open.
680 ****************************************************************************/
681
682 NTSTATUS dup_file_fsp(struct smb_request *req, files_struct *from,
683                       uint32_t access_mask, uint32_t share_access,
684                       uint32_t create_options, files_struct *to)
685 {
686         /* this can never happen for print files */
687         SMB_ASSERT(from->print_file == NULL);
688
689         TALLOC_FREE(to->fh);
690
691         to->fh = from->fh;
692         to->fh->ref_count++;
693
694         to->file_id = from->file_id;
695         to->initial_allocation_size = from->initial_allocation_size;
696         to->file_pid = from->file_pid;
697         to->vuid = from->vuid;
698         to->open_time = from->open_time;
699         to->access_mask = access_mask;
700         to->share_access = share_access;
701         to->oplock_type = from->oplock_type;
702         to->can_lock = from->can_lock;
703         to->can_read = ((access_mask & FILE_READ_DATA) != 0);
704         to->can_write =
705                 CAN_WRITE(from->conn) &&
706                 ((access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) != 0);
707         to->modified = from->modified;
708         to->is_directory = from->is_directory;
709         to->aio_write_behind = from->aio_write_behind;
710
711         return fsp_set_smb_fname(to, from->fsp_name);
712 }
713
714 /**
715  * Return a jenkins hash of a pathname on a connection.
716  */
717
718 NTSTATUS file_name_hash(connection_struct *conn,
719                         const char *name, uint32_t *p_name_hash)
720 {
721         char tmpbuf[PATH_MAX];
722         char *fullpath, *to_free;
723         ssize_t len;
724         TDB_DATA key;
725
726         /* Set the hash of the full pathname. */
727
728         len = full_path_tos(conn->connectpath, name, tmpbuf, sizeof(tmpbuf),
729                             &fullpath, &to_free);
730         if (len == -1) {
731                 return NT_STATUS_NO_MEMORY;
732         }
733         key = (TDB_DATA) { .dptr = (uint8_t *)fullpath, .dsize = len+1 };
734         *p_name_hash = tdb_jenkins_hash(&key);
735
736         DEBUG(10,("file_name_hash: %s hash 0x%x\n",
737                   fullpath,
738                 (unsigned int)*p_name_hash ));
739
740         TALLOC_FREE(to_free);
741         return NT_STATUS_OK;
742 }
743
744 /**
745  * The only way that the fsp->fsp_name field should ever be set.
746  */
747 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
748                            const struct smb_filename *smb_fname_in)
749 {
750         struct smb_filename *smb_fname_new;
751
752         smb_fname_new = cp_smb_filename(fsp, smb_fname_in);
753         if (smb_fname_new == NULL) {
754                 return NT_STATUS_NO_MEMORY;
755         }
756
757         TALLOC_FREE(fsp->fsp_name);
758         fsp->fsp_name = smb_fname_new;
759
760         return file_name_hash(fsp->conn,
761                         smb_fname_str_dbg(fsp->fsp_name),
762                         &fsp->name_hash);
763 }
764
765 const struct GUID *fsp_client_guid(const files_struct *fsp)
766 {
767         return &fsp->conn->sconn->client->connections->smb2.client.guid;
768 }
769
770 size_t fsp_fullbasepath(struct files_struct *fsp, char *buf, size_t buflen)
771 {
772         int len;
773
774         len = snprintf(buf, buflen, "%s/%s", fsp->conn->connectpath,
775                        fsp->fsp_name->base_name);
776         SMB_ASSERT(len>0);
777
778         return len;
779 }