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