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