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