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