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