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