s3: VFS: Change SMB_VFS_SYS_ACL_BLOB_GET_FILE to use const struct smb_filename *...
[kai/samba-autobuild/.git] / source3 / include / vfs.h
1 /* 
2    Unix SMB/CIFS implementation.
3    VFS structures and parameters
4    Copyright (C) Jeremy Allison                         1999-2005
5    Copyright (C) Tim Potter                             1999
6    Copyright (C) Alexander Bokovoy                      2002-2005
7    Copyright (C) Stefan (metze) Metzmacher              2003
8    Copyright (C) Volker Lendecke                        2009
9
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23    This work was sponsored by Optifacio Software Services, Inc.
24 */
25
26 #ifndef _VFS_H
27 #define _VFS_H
28
29 /* Avoid conflict with an AIX include file */
30
31 #ifdef vfs_ops
32 #undef vfs_ops
33 #endif
34
35 /*
36  * As we're now (thanks Andrew ! :-) using file_structs and connection
37  * structs in the vfs - then anyone writing a vfs must include includes.h...
38  */
39
40 /*
41  * This next constant specifies the version number of the VFS interface
42  * this smbd will load. Increment this if *ANY* changes are made to the
43  * vfs_ops below. JRA.
44  *
45  * If you change anything here, please also update modules/vfs_full_audit.c.
46  * VL.
47  */
48
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA 
60    Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach 
67    Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged 
69    Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71  * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80  * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
111    open handle. JRA. */
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122                            SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123                            SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES.  */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125  *                         return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127                  UNIX names to Windows supported names -- asrinivasan. */
128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
130                  malloc'ed path. JRA. */
131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
132                 where it belongs. JRA. */
133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
134                 to split out the two possible uses. JRA. */
135 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
136 /* Leave at 28 - not yet released. Rename open function to open_fn. - gd */
137 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
142 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
152                 connection_struct a pointer. */
153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
155 /* Leave at 31 - not yet released. Remove the unused
156                 fsp->pending_break_messages array */
157 /* Leave at 31 - not yet released. add SMB_VFS_[GET/SET]_COMPRESSION() */
158
159 /* Bump to version 32 - Samba 4.2 will ship with that. */
160 /* Version 32 - Add "lease" to CREATE_FILE operation */
161 /* Version 32 - Add "lease" to struct files_struct */
162 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
163 /* Version 32 - Add in and out create context blobs to create_file */
164 /* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
165 /* Bump to version 33 - Samba 4.3 will ship with that. */
166 /* Version 33 - change fallocate mode flags param from enum->uint32_t */
167 /* Version 33 - Add snapshot create/delete calls */
168 /* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
169 /* Version 33 - Remove notify_watch_fn */
170 /* Bump to version 34 - Samba 4.4 will ship with that */
171 /* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
172 /* Version 34 - Added bool posix_pathnames to struct smb_request */
173 /* Bump to version 35 - Samba 4.5 will ship with that */
174 /* Version 35 - Change get_nt_acl_fn from const char *, to
175                 const struct smb_filename * */
176 /* Version 35 - Change mkdir from const char *, to
177                 const struct smb_filename * */
178 /* Version 35 - Change rmdir from const char *, to
179                 const struct smb_filename * */
180 /* Version 35 - Change opendir from const char *, to
181                 const struct smb_filename * */
182 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
183 /* Version 35 - Change chmod from const char *, to
184                 const struct smb_filename * */
185 /* Version 35 - Change chmod_acl from const char *, to
186                 const struct smb_filename * */
187 /* Version 35 - Change chown from const char *, to
188                 const struct smb_filename * */
189 /* Version 35 - Change lchown from const char *, to
190                 const struct smb_filename * */
191 /* Version 35 - Change streaminfo from const char *, to
192                 const struct smb_filename * */
193 /* Version 35 - Add uint32_t flags to struct smb_filename */
194 /* Version 35 - Add get/set/fget/fset dos attribute functions. */
195 /* Version 35 - Add bool use_ofd_locks to struct files_struct */
196 /* Bump to version 36 - Samba 4.6 will ship with that */
197 /* Version 36 - Remove is_offline and set_offline */
198 /* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
199 /* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
200 /* Version 37 - Change sys_acl_delete_def_file from const char *
201                 to const struct smb_filename * */
202 /* Version 37 - Change sys_acl_get_file from const char *
203                 to const struct smb_filename * */
204 /* Version 37 - Change sys_acl_blob_get_file from const char *
205                 to const struct smb_filename * */
206
207 #define SMB_VFS_INTERFACE_VERSION 37
208
209 /*
210     All intercepted VFS operations must be declared as static functions inside module source
211     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
212     example VFS modules for more details.
213 */
214
215 /* VFS operations structure */
216
217 struct vfs_handle_struct;
218 struct connection_struct;
219 struct files_struct;
220 struct security_descriptor;
221 struct vfs_statvfs_struct;
222 struct smb_request;
223 struct ea_list;
224 struct smb_file_time;
225 struct blocking_lock_record;
226 struct smb_filename;
227 struct dfs_GetDFSReferral;
228
229 typedef union unid_t {
230         uid_t uid;
231         gid_t gid;
232 } unid_t;
233
234 struct fd_handle {
235         size_t ref_count;
236         int fd;
237         uint64_t position_information;
238         off_t pos;
239         uint32_t private_options;       /* NT Create options, but we only look at
240                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
241                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
242                                  * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
243                                  * for print files *only*, where
244                                  * DELETE_ON_CLOSE is not stored in the share
245                                  * mode database.
246                                  */
247         unsigned long gen_id;
248 };
249
250 struct fsp_lease {
251         size_t ref_count;
252         struct smbd_server_connection *sconn;
253         struct tevent_timer *timeout;
254         struct smb2_lease lease;
255 };
256
257 typedef struct files_struct {
258         struct files_struct *next, *prev;
259         uint64_t fnum;
260         struct smbXsrv_open *op;
261         struct connection_struct *conn;
262         struct fd_handle *fh;
263         unsigned int num_smb_operations;
264         struct file_id file_id;
265         uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
266         uint16_t file_pid;
267         uint64_t vuid; /* SMB2 compat */
268         struct write_cache *wcp;
269         struct timeval open_time;
270         uint32_t access_mask;           /* NTCreateX access bits (FILE_READ_DATA etc.) */
271         uint32_t share_access;          /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
272
273         bool kernel_share_modes_taken;
274
275         bool update_write_time_triggered;
276         struct tevent_timer *update_write_time_event;
277         bool update_write_time_on_close;
278         struct timespec close_write_time;
279         bool write_time_forced;
280
281         int oplock_type;
282         struct fsp_lease *lease;
283         int sent_oplock_break;
284         struct tevent_timer *oplock_timeout;
285         struct lock_struct last_lock_failure;
286         int current_lock_count; /* Count the number of outstanding locks and pending locks. */
287
288         bool can_lock;
289         bool can_read;
290         bool can_write;
291         bool modified;
292         bool is_directory;
293         bool aio_write_behind;
294         bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
295         bool delete_on_close;
296         uint64_t posix_flags;
297         bool is_sparse;
298         bool backup_intent; /* Handle was successfully opened with backup intent
299                                 and opener has privilege to do so. */
300         bool aapl_copyfile_supported;
301         bool use_ofd_locks; /* Are we using open file description locks ? */
302         struct smb_filename *fsp_name;
303         uint32_t name_hash;             /* Jenkins hash of full pathname. */
304         uint64_t mid;                   /* Mid of the operation that created us. */
305
306         struct vfs_fsp_data *vfs_extension;
307         struct fake_file_handle *fake_file_handle;
308
309         struct notify_change_buf *notify;
310
311         struct files_struct *base_fsp; /* placeholder for delete on close */
312
313         /*
314          * Read-only cached brlock record, thrown away when the
315          * brlock.tdb seqnum changes. This avoids fetching data from
316          * the brlock.tdb on every read/write call.
317          */
318         int brlock_seqnum;
319         struct byte_range_lock *brlock_rec;
320
321         struct dptr_struct *dptr;
322
323         /* if not NULL, means this is a print file */
324         struct print_file_data *print_file;
325
326         unsigned num_aio_requests;
327         struct tevent_req **aio_requests;
328
329         /*
330          * If a close request comes in while we still have aio_requests
331          * around, we need to hold back the close. When all aio_requests are
332          * done, the aio completion routines need tevent_wait_done() on
333          * this. A bit ugly, but before we have close_file() fully async
334          * possibly the simplest approach. Thanks, Jeremy for the idea.
335          */
336         struct tevent_req *deferred_close;
337 } files_struct;
338
339 #define FSP_POSIX_FLAGS_OPEN            0x01
340 #define FSP_POSIX_FLAGS_RENAME          0x02
341 #define FSP_POSIX_FLAGS_PATHNAMES       0x04
342
343 #define FSP_POSIX_FLAGS_ALL                     \
344         (FSP_POSIX_FLAGS_OPEN |                 \
345          FSP_POSIX_FLAGS_PATHNAMES |            \
346          FSP_POSIX_FLAGS_RENAME)
347
348 struct vuid_cache_entry {
349         struct auth_session_info *session_info;
350         uint64_t vuid; /* SMB2 compat */
351         bool read_only;
352         uint32_t share_access;
353 };
354
355 struct vuid_cache {
356         unsigned int next_entry;
357         struct vuid_cache_entry array[VUID_CACHE_SIZE];
358 };
359
360 typedef struct {
361         char *name;
362         bool is_wild;
363 } name_compare_entry;
364
365 struct dfree_cached_info {
366         time_t last_dfree_time;
367         uint64_t dfree_ret;
368         uint64_t bsize;
369         uint64_t dfree;
370         uint64_t dsize;
371 };
372
373 struct share_params {
374         int service;
375 };
376
377 typedef struct connection_struct {
378         struct connection_struct *next, *prev;
379         struct smbd_server_connection *sconn; /* can be NULL */
380         struct smbXsrv_tcon *tcon; /* can be NULL */
381         uint32_t cnum; /* an index passed over the wire */
382         struct share_params *params;
383         bool force_user;
384         struct vuid_cache *vuid_cache;
385         bool printer;
386         bool ipc;
387         bool read_only; /* Attributes for the current user of the share. */
388         uint32_t share_access;
389         /* Does this filesystem honor
390            sub second timestamps on files
391            and directories when setting time ? */
392         enum timestamp_set_resolution ts_res;
393         char *connectpath;
394         char *origpath;
395         char *cwd; /* Working directory. */
396
397         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
398
399         /*
400          * This represents the user information on this connection. Depending
401          * on the vuid using this tid, this might change per SMB request.
402          */
403         struct auth_session_info *session_info;
404
405         /*
406          * If the "force group" parameter is set, this is the primary gid that
407          * may be used in the users token, depending on the vuid using this tid.
408          */
409         gid_t force_group_gid;
410
411         uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
412
413         time_t lastused;
414         time_t lastused_count;
415         int num_files_open;
416         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
417         int encrypt_level;
418         bool encrypted_tid;
419
420         /* Semantics requested by the client or forced by the server config. */
421         bool case_sensitive;
422         bool case_preserve;
423         bool short_case_preserve;
424
425         /* Semantics provided by the underlying filesystem. */
426         int fs_capabilities;
427         /* Device number of the directory of the share mount.
428            Used to ensure unique FileIndex returns. */
429         SMB_DEV_T base_share_dev;
430
431         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
432         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
433         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */       
434         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */       
435         struct dfree_cached_info *dfree_info;
436         struct trans_state *pending_trans;
437
438         struct rpc_pipe_client *spoolss_pipe;
439
440 } connection_struct;
441
442 struct smbd_smb2_request;
443 struct privilege_paths;
444
445 struct smb_request {
446         uint8_t cmd;
447         uint16_t flags2;
448         uint16_t smbpid;
449         uint64_t mid; /* For compatibility with SMB2. */
450         uint32_t seqnum;
451         uint64_t vuid; /* For compatibility with SMB2. */
452         uint32_t tid;
453         uint8_t  wct;
454         const uint16_t *vwv;
455         uint16_t buflen;
456         const uint8_t *buf;
457         const uint8_t *inbuf;
458
459         /*
460          * Async handling in the main smb processing loop is directed by
461          * outbuf: reply_xxx routines indicate sync behaviour by putting their
462          * reply into "outbuf". If they leave it as NULL, they take care of it
463          * themselves, possibly later.
464          *
465          * If async handling is wanted, the reply_xxx routine must make sure
466          * that it talloc_move()s the smb_req somewhere else.
467          */
468         uint8_t *outbuf;
469
470         size_t unread_bytes;
471         bool encrypted;
472         connection_struct *conn;
473         struct smbd_server_connection *sconn;
474         struct smbXsrv_connection *xconn;
475         struct smb_perfcount_data pcd;
476
477         /*
478          * Chained request handling
479          */
480         struct files_struct *chain_fsp;
481
482         /*
483          * state information for async smb handling
484          */
485         void *async_priv;
486
487         /*
488          * Back pointer to smb2 request.
489          */
490         struct smbd_smb2_request *smb2req;
491
492         /*
493          * Pathnames used if request done
494          * under privilege.
495          */
496         struct privilege_paths *priv_paths;
497
498         /*
499          * Request list for chained requests, we're part of it.
500          */
501         struct smb_request **chain;
502
503         struct timeval request_time;
504
505         bool posix_pathnames;
506 };
507
508 /*
509  * Info about an alternate data stream
510  */
511
512 struct stream_struct {
513         off_t size;
514         off_t alloc_size;
515         char *name;
516 };
517
518 /* time info */
519 struct smb_file_time {
520         struct timespec mtime;
521         struct timespec atime;
522         struct timespec ctime;
523         struct timespec create_time;
524 };
525
526 /*
527  * smb_filename
528  */
529 struct smb_filename {
530         char *base_name;
531         char *stream_name;
532         char *original_lcomp;
533         uint32_t flags;
534         SMB_STRUCT_STAT st;
535 };
536
537 /*
538  * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
539  * to keep the numeric values consistent.
540  */
541
542 #define SMB_FILENAME_POSIX_PATH         FSP_POSIX_FLAGS_PATHNAMES
543
544 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
545                                 handle = handle->next; \
546                          }
547
548 enum vfs_translate_direction {
549         vfs_translate_to_unix = 0,
550         vfs_translate_to_windows
551 };
552
553 enum vfs_fallocate_flags {
554         VFS_FALLOCATE_FL_KEEP_SIZE              = 0x0001,
555         VFS_FALLOCATE_FL_PUNCH_HOLE             = 0x0002,
556 };
557
558 /*
559  * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
560  *                                be handled as a COW clone, AKA reflink.
561  * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
562  */
563 enum vfs_copy_chunk_flags {
564         VFS_COPY_CHUNK_FL_MUST_CLONE            = 0x0001,
565         VFS_COPY_CHUNK_FL_IGNORE_LOCKS          = 0x0002,
566
567         VFS_COPY_CHUNK_FL_MASK_ALL              =
568                                         (VFS_COPY_CHUNK_FL_MUST_CLONE
569                                          | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
570 };
571
572 struct vfs_aio_state {
573         int error;
574         uint64_t duration;
575 };
576
577 /*
578     Available VFS operations. These values must be in sync with vfs_ops struct
579     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
580     In particular, if new operations are added to vfs_ops, appropriate constants
581     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
582 */
583 struct shadow_copy_data;
584
585 struct vfs_fn_pointers {
586         /* Disk operations */
587
588         int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
589         void (*disconnect_fn)(struct vfs_handle_struct *handle);
590         uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
591                               uint64_t *dfree, uint64_t *dsize);
592         int (*get_quota_fn)(struct vfs_handle_struct *handle, const char *path,
593                             enum SMB_QUOTA_TYPE qtype, unid_t id,
594                             SMB_DISK_QUOTA *qt);
595         int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
596         int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
597         int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
598         uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
599
600         /*
601          * Note: that "struct dfs_GetDFSReferral *r"
602          * needs to be a valid TALLOC_CTX
603          */
604         NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
605                                          struct dfs_GetDFSReferral *r);
606
607         /* Directory operations */
608
609         DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
610                                         const struct smb_filename *smb_fname,
611                                         const char *mask,
612                                         uint32_t attributes);
613         DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
614         struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
615                                          DIR *dirp,
616                                          SMB_STRUCT_STAT *sbuf);
617         void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
618         long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
619         void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
620         int (*mkdir_fn)(struct vfs_handle_struct *handle,
621                         const struct smb_filename *smb_fname,
622                         mode_t mode);
623         int (*rmdir_fn)(struct vfs_handle_struct *handle,
624                         const struct smb_filename *smb_fname);
625         int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
626         void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
627
628         /* File operations */
629
630         int (*open_fn)(struct vfs_handle_struct *handle,
631                        struct smb_filename *smb_fname, files_struct *fsp,
632                        int flags, mode_t mode);
633         NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
634                                    struct smb_request *req,
635                                    uint16_t root_dir_fid,
636                                    struct smb_filename *smb_fname,
637                                    uint32_t access_mask,
638                                    uint32_t share_access,
639                                    uint32_t create_disposition,
640                                    uint32_t create_options,
641                                    uint32_t file_attributes,
642                                    uint32_t oplock_request,
643                                    struct smb2_lease *lease,
644                                    uint64_t allocation_size,
645                                    uint32_t private_flags,
646                                    struct security_descriptor *sd,
647                                    struct ea_list *ea_list,
648                                    files_struct **result,
649                                    int *pinfo,
650                                    const struct smb2_create_blobs *in_context_blobs,
651                                    struct smb2_create_blobs *out_context_blobs);
652         int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
653         ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
654         ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
655         struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
656                                             TALLOC_CTX *mem_ctx,
657                                             struct tevent_context *ev,
658                                             struct files_struct *fsp,
659                                             void *data,
660                                             size_t n, off_t offset);
661         ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
662         ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
663         ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
664         struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
665                                              TALLOC_CTX *mem_ctx,
666                                              struct tevent_context *ev,
667                                              struct files_struct *fsp,
668                                              const void *data,
669                                              size_t n, off_t offset);
670         ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
671         off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
672         ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
673         ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
674         int (*rename_fn)(struct vfs_handle_struct *handle,
675                          const struct smb_filename *smb_fname_src,
676                          const struct smb_filename *smb_fname_dst);
677         int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
678         struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
679                                             TALLOC_CTX *mem_ctx,
680                                             struct tevent_context *ev,
681                                             struct files_struct *fsp);
682         int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
683         int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
684         int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
685         int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
686         uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
687         int (*unlink_fn)(struct vfs_handle_struct *handle,
688                          const struct smb_filename *smb_fname);
689         int (*chmod_fn)(struct vfs_handle_struct *handle,
690                         const struct smb_filename *smb_fname,
691                         mode_t mode);
692         int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
693         int (*chown_fn)(struct vfs_handle_struct *handle,
694                         const struct smb_filename *smb_fname,
695                         uid_t uid,
696                         gid_t gid);
697         int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
698         int (*lchown_fn)(struct vfs_handle_struct *handle,
699                         const struct smb_filename *smb_fname,
700                         uid_t uid,
701                         gid_t gid);
702         int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
703         char *(*getwd_fn)(struct vfs_handle_struct *handle);
704         int (*ntimes_fn)(struct vfs_handle_struct *handle,
705                          const struct smb_filename *smb_fname,
706                          struct smb_file_time *ft);
707         int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
708         int (*fallocate_fn)(struct vfs_handle_struct *handle,
709                             struct files_struct *fsp,
710                             uint32_t mode,
711                             off_t offset,
712                             off_t len);
713         bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
714         int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
715                                uint32_t share_mode, uint32_t access_mask);
716         int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
717         bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
718         int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
719         int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
720         int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
721         int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
722         char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
723         int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
724         struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
725                                             const SMB_STRUCT_STAT *sbuf);
726         struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
727                                                  TALLOC_CTX *mem_ctx,
728                                                  struct tevent_context *ev,
729                                                  struct files_struct *src_fsp,
730                                                  off_t src_off,
731                                                  struct files_struct *dest_fsp,
732                                                  off_t dest_off,
733                                                  off_t to_copy,
734                                                  uint32_t flags);
735         NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
736                                        struct tevent_req *req,
737                                        off_t *copied);
738         NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
739                                        TALLOC_CTX *mem_ctx,
740                                        struct files_struct *fsp,
741                                        struct smb_filename *smb_fname,
742                                        uint16_t *_compression_fmt);
743         NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
744                                        TALLOC_CTX *mem_ctx,
745                                        struct files_struct *fsp,
746                                        uint16_t compression_fmt);
747         NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
748                                        TALLOC_CTX *mem_ctx,
749                                        const char *service_path,
750                                        char **base_volume);
751         NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
752                                    TALLOC_CTX *mem_ctx,
753                                    const char *base_volume,
754                                    time_t *tstamp,
755                                    bool rw,
756                                    char **base_path,
757                                    char **snap_path);
758         NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
759                                    TALLOC_CTX *mem_ctx,
760                                    char *base_path,
761                                    char *snap_path);
762
763         NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
764                                   struct files_struct *fsp,
765                                   const struct smb_filename *smb_fname,
766                                   TALLOC_CTX *mem_ctx,
767                                   unsigned int *num_streams,
768                                   struct stream_struct **streams);
769
770         int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
771                                     const char *path,
772                                     const char *name,
773                                     TALLOC_CTX *mem_ctx,
774                                     char **found_name);
775
776         const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
777                                       const char *filename);
778
779         NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
780                                         struct byte_range_lock *br_lck,
781                                         struct lock_struct *plock,
782                                         bool blocking_lock);
783
784         bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
785                                       struct messaging_context *msg_ctx,
786                                       struct byte_range_lock *br_lck,
787                                       const struct lock_struct *plock);
788
789         bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
790                                       struct byte_range_lock *br_lck,
791                                       struct lock_struct *plock);
792
793         bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
794                                struct files_struct *fsp,
795                                struct lock_struct *plock);
796
797         void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
798                                  struct files_struct *fsp,
799                                  struct lock_struct *plock);
800
801         NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
802                                       const char *name,
803                                       enum vfs_translate_direction direction,
804                                       TALLOC_CTX *mem_ctx,
805                                       char **mapped_name);
806
807         NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
808                              struct files_struct *fsp,
809                              TALLOC_CTX *ctx,
810                              uint32_t function,
811                              uint16_t req_flags,
812                              const uint8_t *_in_data,
813                              uint32_t in_len,
814                              uint8_t **_out_data,
815                              uint32_t max_out_len,
816                              uint32_t *out_len); 
817
818         NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
819                                           struct smb_filename *smb_fname,
820                                           uint32_t *dosmode);
821
822         NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
823                                            struct files_struct *fsp,
824                                            uint32_t *dosmode);
825
826         NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
827                                           const struct smb_filename *smb_fname,
828                                           uint32_t dosmode);
829
830         NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
831                                            struct files_struct *fsp,
832                                            uint32_t dosmode);
833
834         /* NT ACL operations. */
835
836         NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
837                                    struct files_struct *fsp,
838                                    uint32_t security_info,
839                                    TALLOC_CTX *mem_ctx,
840                                    struct security_descriptor **ppdesc);
841         NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
842                                   const struct smb_filename *smb_fname,
843                                   uint32_t security_info,
844                                    TALLOC_CTX *mem_ctx,
845                                   struct security_descriptor **ppdesc);
846         NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
847                                    struct files_struct *fsp,
848                                    uint32_t security_info_sent,
849                                    const struct security_descriptor *psd);
850
851         NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
852                                   struct smb_filename *file,
853                                   struct security_acl *sacl,
854                                   uint32_t access_requested,
855                                   uint32_t access_denied);
856
857         /* POSIX ACL operations. */
858
859         int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
860                                         const struct smb_filename *smb_fname,
861                                         mode_t mode);
862         int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
863
864         SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
865                                          const struct smb_filename *smb_fname,
866                                          SMB_ACL_TYPE_T type,
867                                          TALLOC_CTX *mem_ctx);
868         SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
869                                        struct files_struct *fsp,
870                                        TALLOC_CTX *mem_ctx);
871         int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
872                                         const struct smb_filename *smb_fname,
873                                         TALLOC_CTX *mem_ctx,
874                                         char **blob_description,
875                                         DATA_BLOB *blob);
876         int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
877                                       TALLOC_CTX *mem_ctx, char **blob_description,
878                                       DATA_BLOB *blob);
879         int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
880         int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
881         int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
882                                         const struct smb_filename *smb_fname);
883
884         /* EA operations. */
885         ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
886         ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
887         ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
888         ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
889         int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
890         int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
891         int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
892         int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
893
894         /* aio operations */
895         bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
896
897         /* durable handle operations */
898         NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
899                                       struct files_struct *fsp,
900                                       TALLOC_CTX *mem_ctx,
901                                       DATA_BLOB *cookie);
902         NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
903                                           struct files_struct *fsp,
904                                           const DATA_BLOB old_cookie,
905                                           TALLOC_CTX *mem_ctx,
906                                           DATA_BLOB *new_cookie);
907         NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
908                                          struct smb_request *smb1req,
909                                          struct smbXsrv_open *op,
910                                          const DATA_BLOB old_cookie,
911                                          TALLOC_CTX *mem_ctx,
912                                          struct files_struct **fsp,
913                                          DATA_BLOB *new_cookie);
914
915         NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
916                                     const struct smb_filename *fname,
917                                     TALLOC_CTX *mem_ctx,
918                                     struct readdir_attr_data **attr_data);
919 };
920
921 /*
922     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
923     which describes all operations this module is willing to intercept.
924     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
925     using this information.
926 */
927
928 typedef struct vfs_handle_struct {
929         struct vfs_handle_struct  *next, *prev;
930         const char *param;
931         struct connection_struct *conn;
932         const struct vfs_fn_pointers *fns;
933         void *data;
934         void (*free_data)(void **data);
935 } vfs_handle_struct;
936
937
938 typedef struct vfs_statvfs_struct {
939         /* For undefined recommended transfer size return -1 in that field */
940         uint32_t OptimalTransferSize;  /* bsize on some os, iosize on other os */
941         uint32_t BlockSize;
942
943         /*
944          The next three fields are in terms of the block size.
945          (above). If block size is unknown, 4096 would be a
946          reasonable block size for a server to report.
947          Note that returning the blocks/blocksavail removes need
948          to make a second call (to QFSInfo level 0x103 to get this info.
949          UserBlockAvail is typically less than or equal to BlocksAvail,
950          if no distinction is made return the same value in each.
951         */
952
953         uint64_t TotalBlocks;
954         uint64_t BlocksAvail;       /* bfree */
955         uint64_t UserBlocksAvail;   /* bavail */
956
957         /* For undefined Node fields or FSID return -1 */
958         uint64_t TotalFileNodes;
959         uint64_t FreeFileNodes;
960         uint64_t FsIdentifier;   /* fsid */
961         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
962         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
963
964         int FsCapabilities;
965 } vfs_statvfs_struct;
966
967 /* Add a new FSP extension of the given type. Returns a pointer to the
968  * extenstion data.
969  */
970 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn)            \
971     vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
972
973 /* Return a pointer to the existing FSP extension data. */
974 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
975     vfs_fetch_fsp_extension(handle, (fsp))
976
977 /* Return the talloc context associated with an FSP extension. */
978 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
979     vfs_memctx_fsp_extension(handle, (fsp))
980
981 /* Remove and destroy an FSP extension. */
982 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
983     vfs_remove_fsp_extension((handle), (fsp))
984
985 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
986         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
987                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
988                 ret; \
989         } \
990 }
991
992 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
993         if (!(handle)) { \
994                 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
995                 ret; \
996         } else { \
997                 if ((handle)->free_data) { \
998                         (handle)->free_data(&(handle)->data); \
999                 } \
1000                 (handle)->data = (void *)datap; \
1001                 (handle)->free_data = free_fn; \
1002         } \
1003 }
1004
1005 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1006         if ((handle) && (handle)->free_data) { \
1007                 (handle)->free_data(&(handle)->data); \
1008         } \
1009 }
1010
1011 /* Check whether module-specific data handle was already allocated or not */
1012 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
1013
1014 #define SMB_VFS_OP(x) ((void *) x)
1015
1016 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1017
1018 #include "vfs_macros.h"
1019
1020 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1021                          const char *service, const char *user);
1022 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1023 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1024                                 const char *path, uint64_t *bsize,
1025                                 uint64_t *dfree, uint64_t *dsize);
1026 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle, const char *path,
1027                            enum SMB_QUOTA_TYPE qtype, unid_t id,
1028                            SMB_DISK_QUOTA *qt);
1029 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1030                            enum SMB_QUOTA_TYPE qtype, unid_t id,
1031                            SMB_DISK_QUOTA *qt);
1032 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1033                                       struct files_struct *fsp,
1034                                       struct shadow_copy_data *shadow_copy_data,
1035                                       bool labels);
1036 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
1037                          struct vfs_statvfs_struct *statbuf);
1038 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1039                                       enum timestamp_set_resolution *p_ts_res);
1040 /*
1041  * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1042  */
1043 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1044                                         struct dfs_GetDFSReferral *r);
1045 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1046                         const struct smb_filename *smb_fname,
1047                         const char *mask,
1048                         uint32_t attributes);
1049 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1050                                         struct files_struct *fsp,
1051                                         const char *mask,
1052                                         uint32_t attributes);
1053 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1054                                         DIR *dirp,
1055                                         SMB_STRUCT_STAT *sbuf);
1056 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1057                           DIR *dirp, long offset);
1058 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1059                           DIR *dirp);
1060 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1061                              DIR *dirp);
1062 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1063                         const struct smb_filename *smb_fname,
1064                         mode_t mode);
1065 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1066                         const struct smb_filename *smb_fname);
1067 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1068                           DIR *dir);
1069 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1070                                  DIR *dirp);
1071 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1072                       struct smb_filename *smb_fname, struct files_struct *fsp,
1073                       int flags, mode_t mode);
1074 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1075                                   struct smb_request *req,
1076                                   uint16_t root_dir_fid,
1077                                   struct smb_filename *smb_fname,
1078                                   uint32_t access_mask,
1079                                   uint32_t share_access,
1080                                   uint32_t create_disposition,
1081                                   uint32_t create_options,
1082                                   uint32_t file_attributes,
1083                                   uint32_t oplock_request,
1084                                   struct smb2_lease *lease,
1085                                   uint64_t allocation_size,
1086                                   uint32_t private_flags,
1087                                   struct security_descriptor *sd,
1088                                   struct ea_list *ea_list,
1089                                   files_struct **result,
1090                                   int *pinfo,
1091                                   const struct smb2_create_blobs *in_context_blobs,
1092                                   struct smb2_create_blobs *out_context_blobs);
1093 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1094                        struct files_struct *fsp);
1095 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1096                           struct files_struct *fsp, void *data, size_t n);
1097 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1098                            struct files_struct *fsp, void *data, size_t n,
1099                            off_t offset);
1100 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1101                                            TALLOC_CTX *mem_ctx,
1102                                            struct tevent_context *ev,
1103                                            struct files_struct *fsp,
1104                                            void *data,
1105                                            size_t n, off_t offset);
1106 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1107
1108 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1109                            struct files_struct *fsp, const void *data,
1110                            size_t n);
1111 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1112                             struct files_struct *fsp, const void *data,
1113                             size_t n, off_t offset);
1114 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1115                                             TALLOC_CTX *mem_ctx,
1116                                             struct tevent_context *ev,
1117                                             struct files_struct *fsp,
1118                                             const void *data,
1119                                             size_t n, off_t offset);
1120 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1121
1122 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1123                              struct files_struct *fsp, off_t offset,
1124                              int whence);
1125 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1126                               files_struct *fromfsp, const DATA_BLOB *header,
1127                               off_t offset, size_t count);
1128 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1129                               files_struct *tofsp, off_t offset,
1130                               size_t count);
1131 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1132                         const struct smb_filename *smb_fname_src,
1133                         const struct smb_filename *smb_fname_dst);
1134 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1135                        struct files_struct *fsp);
1136
1137 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1138                                            TALLOC_CTX *mem_ctx,
1139                                            struct tevent_context *ev,
1140                                            struct files_struct *fsp);
1141 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1142
1143 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1144                       struct smb_filename *smb_fname);
1145 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1146                        struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1147 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1148                        struct smb_filename *smb_filename);
1149 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1150                                      struct files_struct *fsp,
1151                                      const SMB_STRUCT_STAT *sbuf);
1152 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1153                         const struct smb_filename *smb_fname);
1154 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1155                         const struct smb_filename *smb_fname,
1156                         mode_t mode);
1157 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1158                         struct files_struct *fsp, mode_t mode);
1159 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1160                         const struct smb_filename *smb_fname,
1161                         uid_t uid,
1162                         gid_t gid);
1163 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1164                         struct files_struct *fsp, uid_t uid, gid_t gid);
1165 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1166                         const struct smb_filename *smb_fname,
1167                         uid_t uid,
1168                         gid_t gid);
1169 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1170 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1171 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1172                         const struct smb_filename *smb_fname,
1173                         struct smb_file_time *ft);
1174 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1175                            struct files_struct *fsp, off_t offset);
1176 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1177                            struct files_struct *fsp,
1178                            uint32_t mode,
1179                            off_t offset,
1180                            off_t len);
1181 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1182                        struct files_struct *fsp, int op, off_t offset,
1183                        off_t count, int type);
1184 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1185                               struct files_struct *fsp, uint32_t share_mode,
1186                               uint32_t access_mask);
1187 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1188                                 struct files_struct *fsp, int leasetype);
1189 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1190                           struct files_struct *fsp, off_t *poffset,
1191                           off_t *pcount, int *ptype, pid_t *ppid);
1192 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1193                          const char *newpath);
1194 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1195                           const char *path, char *buf, size_t bufsiz);
1196 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1197                       const char *newpath);
1198 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1199                        mode_t mode, SMB_DEV_T dev);
1200 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1201 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1202                          unsigned int flags);
1203 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1204                                            const SMB_STRUCT_STAT *sbuf);
1205 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1206                                  struct files_struct *fsp,
1207                                  const struct smb_filename *smb_fname,
1208                                  TALLOC_CTX *mem_ctx,
1209                                  unsigned int *num_streams,
1210                                  struct stream_struct **streams);
1211 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1212                                    const char *path, const char *name,
1213                                    TALLOC_CTX *mem_ctx, char **found_name);
1214 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1215                                      const char *filename);
1216 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1217                                        struct byte_range_lock *br_lck,
1218                                        struct lock_struct *plock,
1219                                        bool blocking_lock);
1220 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1221                                      struct messaging_context *msg_ctx,
1222                                      struct byte_range_lock *br_lck,
1223                                      const struct lock_struct *plock);
1224 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1225                                      struct byte_range_lock *br_lck,
1226                                      struct lock_struct *plock);
1227 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1228                               struct files_struct *fsp,
1229                               struct lock_struct *plock);
1230 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1231                                 struct files_struct *fsp,
1232                                 struct lock_struct *plock);
1233 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1234                                      const char *name,
1235                                      enum vfs_translate_direction direction,
1236                                      TALLOC_CTX *mem_ctx,
1237                                      char **mapped_name);
1238 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1239                             struct files_struct *fsp,
1240                             TALLOC_CTX *ctx,
1241                             uint32_t function,
1242                             uint16_t req_flags,
1243                             const uint8_t *_in_data,
1244                             uint32_t in_len,
1245                             uint8_t **_out_data,
1246                             uint32_t max_out_len,
1247                             uint32_t *out_len);
1248 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1249                                          struct smb_filename *smb_fname,
1250                                          uint32_t *dosmode);
1251 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1252                                           struct files_struct *fsp,
1253                                           uint32_t *dosmode);
1254 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1255                                          const struct smb_filename *smb_fname,
1256                                          uint32_t dosmode);
1257 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1258                                           struct files_struct *fsp,
1259                                           uint32_t dosmode);
1260 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1261                                                 TALLOC_CTX *mem_ctx,
1262                                                 struct tevent_context *ev,
1263                                                 struct files_struct *src_fsp,
1264                                                 off_t src_off,
1265                                                 struct files_struct *dest_fsp,
1266                                                 off_t dest_off,
1267                                                 off_t num,
1268                                                 uint32_t flags);
1269 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1270                                       struct tevent_req *req,
1271                                       off_t *copied);
1272 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1273                                       TALLOC_CTX *mem_ctx,
1274                                       struct files_struct *fsp,
1275                                       struct smb_filename *smb_fname,
1276                                       uint16_t *_compression_fmt);
1277 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1278                                       TALLOC_CTX *mem_ctx,
1279                                       struct files_struct *fsp,
1280                                       uint16_t compression_fmt);
1281 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1282                                       TALLOC_CTX *mem_ctx,
1283                                       const char *service_path,
1284                                       char **base_volume);
1285 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1286                                   TALLOC_CTX *mem_ctx,
1287                                   const char *base_volume,
1288                                   time_t *tstamp,
1289                                   bool rw,
1290                                   char **base_path,
1291                                   char **snap_path);
1292 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1293                                   TALLOC_CTX *mem_ctx,
1294                                   char *base_path,
1295                                   char *snap_path);
1296 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1297                                   struct files_struct *fsp,
1298                                   uint32_t security_info,
1299                                   TALLOC_CTX *mem_ctx,
1300                                   struct security_descriptor **ppdesc);
1301 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1302                                  const struct smb_filename *smb_fname,
1303                                  uint32_t security_info,
1304                                  TALLOC_CTX *mem_ctx,
1305                                  struct security_descriptor **ppdesc);
1306 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1307                                   struct files_struct *fsp,
1308                                   uint32_t security_info_sent,
1309                                   const struct security_descriptor *psd);
1310 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1311                                  struct smb_filename *file,
1312                                  struct security_acl *sacl,
1313                                  uint32_t access_requested,
1314                                  uint32_t access_denied);
1315 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1316                                 const struct smb_filename *file,
1317                                 mode_t mode);
1318 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1319                             struct files_struct *fsp, mode_t mode);
1320 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1321                                         const struct smb_filename *smb_fname,
1322                                         SMB_ACL_TYPE_T type,
1323                                         TALLOC_CTX *mem_ctx);
1324 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1325                                       struct files_struct *fsp,
1326                                       TALLOC_CTX *mem_ctx);
1327 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1328                                        const struct smb_filename *smb_fname,
1329                                        TALLOC_CTX *mem_ctx,
1330                                        char **blob_description,
1331                                        DATA_BLOB *blob);
1332 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1333                                      struct files_struct *fsp,  
1334                                      TALLOC_CTX *mem_ctx,
1335                                      char **blob_description,
1336                                      DATA_BLOB *blob);
1337 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1338                                   const char *name, SMB_ACL_TYPE_T acltype,
1339                                   SMB_ACL_T theacl);
1340 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1341                                 struct files_struct *fsp, SMB_ACL_T theacl);
1342 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1343                                 const struct smb_filename *smb_fname);
1344 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1345                               const char *path, const char *name, void *value,
1346                               size_t size);
1347 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1348                                struct files_struct *fsp, const char *name,
1349                                void *value, size_t size);
1350 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1351                                const char *path, char *list, size_t size);
1352 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1353                                 const char *path, char *list, size_t size);
1354 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1355                                 struct files_struct *fsp, char *list,
1356                                 size_t size);
1357 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1358                              const char *path, const char *name);
1359 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1360                               struct files_struct *fsp, const char *name);
1361 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
1362                           const char *name, const void *value, size_t size,
1363                           int flags);
1364 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1365                            const char *name, const void *value, size_t size,
1366                            int flags);
1367 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1368                            struct files_struct *fsp, const char *name,
1369                            const void *value, size_t size, int flags);
1370 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1371                             struct files_struct *fsp);
1372 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1373                              const struct smb_filename *fname,
1374                              SMB_STRUCT_STAT *sbuf);
1375 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1376                              const struct smb_filename *fname);
1377 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1378                                      struct files_struct *fsp,
1379                                      TALLOC_CTX *mem_ctx,
1380                                      DATA_BLOB *cookie);
1381 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1382                                          struct files_struct *fsp,
1383                                          const DATA_BLOB old_cookie,
1384                                          TALLOC_CTX *mem_ctx,
1385                                          DATA_BLOB *new_cookie);
1386 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1387                                         struct smb_request *smb1req,
1388                                         struct smbXsrv_open *op,
1389                                         const DATA_BLOB old_cookie,
1390                                         TALLOC_CTX *mem_ctx,
1391                                         struct files_struct **fsp,
1392                                         DATA_BLOB *new_cookie);
1393 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1394                                    const struct smb_filename *fname,
1395                                    TALLOC_CTX *mem_ctx,
1396                                    struct readdir_attr_data **attr_data);
1397
1398 NTSTATUS smb_register_vfs(int version, const char *name,
1399                           const struct vfs_fn_pointers *fns);
1400 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1401                                    files_struct *fsp, size_t ext_size,
1402                                    void (*destroy_fn)(void *p_data));
1403 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1404 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1405 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1406 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1407
1408 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1409                             const char *module);
1410
1411 #endif /* _VFS_H */