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