9b72f6932893b234f84fb4ce53f784716bfb0678
[jra/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    
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
22    This work was sponsored by Optifacio Software Services, Inc.
23 */
24
25 #ifndef _VFS_H
26 #define _VFS_H
27
28 /* Avoid conflict with an AIX include file */
29
30 #ifdef vfs_ops
31 #undef vfs_ops
32 #endif
33
34 /*
35  * As we're now (thanks Andrew ! :-) using file_structs and connection
36  * structs in the vfs - then anyone writing a vfs must include includes.h...
37  */
38
39 /*
40  * This next constant specifies the version number of the VFS interface
41  * this smbd will load. Increment this if *ANY* changes are made to the
42  * vfs_ops below. JRA.
43  *
44  * If you change anything here, please also update modules/vfs_full_audit.c.
45  * VL.
46  */
47
48 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
49 /* Changed to version 3 for POSIX acl extensions. JRA. */
50 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
51 /* Changed to version 5 for sendfile addition. JRA. */
52 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
53 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
54 /* Changed to version 8 includes EA calls. JRA. */
55 /* Changed to version 9 to include the get_shadow_data call. --metze */
56 /* Changed to version 10 to include pread/pwrite calls. */
57 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
58 /* Changed to version 12 to add mask and attributes to opendir(). JRA 
59    Also include aio calls. JRA. */
60 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
61 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
62 /* Changed to version 15 as we added the statvfs call. JRA */
63 /* Changed to version 16 as we added the getlock call. JRA */
64 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
65 /* Changed to version 18 to add fsp parameter to the open call -- jpeach 
66    Also include kernel_flock call - jmcd */
67 /* Changed to version 19, kernel change notify has been merged 
68    Also included linux setlease call - jmcd */
69 /* Changed to version 20, use ntimes call instead of utime (greater
70  * timestamp resolition. JRA. */
71 /* Changed to version21 to add chflags operation -- jpeach */
72 /* Changed to version22 to add lchown operation -- jra */
73 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
74 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
75 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
76 /* Leave at 22 - not yet released. Added recvfile. */
77 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
78 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
79  * files_struct. - obnox.*/
80 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
81 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
106 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
107 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
108 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
109 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
110    open handle. JRA. */
111
112 #define SMB_VFS_INTERFACE_VERSION 23
113
114
115 /* to bug old modules which are trying to compile with the old functions */
116 #define vfs_init __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore(void) { __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore };
117 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
118   __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
119 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
120   __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
121
122 /*
123     All intercepted VFS operations must be declared as static functions inside module source
124     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
125     example VFS modules for more details.
126 */
127
128 /* VFS operations structure */
129
130 struct vfs_handle_struct;
131 struct connection_struct;
132 struct files_struct;
133 struct security_descriptor;
134 struct vfs_statvfs_struct;
135
136 /*
137     Available VFS operations. These values must be in sync with vfs_ops struct
138     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops). 
139     In particular, if new operations are added to vfs_ops, appropriate constants
140     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
141 */
142
143 typedef enum _vfs_op_type {
144         SMB_VFS_OP_NOOP = -1,
145         
146         /* Disk operations */
147
148         SMB_VFS_OP_CONNECT = 0,
149         SMB_VFS_OP_DISCONNECT,
150         SMB_VFS_OP_DISK_FREE,
151         SMB_VFS_OP_GET_QUOTA,
152         SMB_VFS_OP_SET_QUOTA,
153         SMB_VFS_OP_GET_SHADOW_COPY_DATA,
154         SMB_VFS_OP_STATVFS,
155         SMB_VFS_OP_FS_CAPABILITIES,
156
157         /* Directory operations */
158
159         SMB_VFS_OP_OPENDIR,
160         SMB_VFS_OP_READDIR,
161         SMB_VFS_OP_SEEKDIR,
162         SMB_VFS_OP_TELLDIR,
163         SMB_VFS_OP_REWINDDIR,
164         SMB_VFS_OP_MKDIR,
165         SMB_VFS_OP_RMDIR,
166         SMB_VFS_OP_CLOSEDIR,
167
168         /* File operations */
169
170         SMB_VFS_OP_OPEN,
171         SMB_VFS_OP_CLOSE,
172         SMB_VFS_OP_READ,
173         SMB_VFS_OP_PREAD,
174         SMB_VFS_OP_WRITE,
175         SMB_VFS_OP_PWRITE,
176         SMB_VFS_OP_LSEEK,
177         SMB_VFS_OP_SENDFILE,
178         SMB_VFS_OP_RECVFILE,
179         SMB_VFS_OP_RENAME,
180         SMB_VFS_OP_FSYNC,
181         SMB_VFS_OP_STAT,
182         SMB_VFS_OP_FSTAT,
183         SMB_VFS_OP_LSTAT,
184         SMB_VFS_OP_UNLINK,
185         SMB_VFS_OP_CHMOD,
186         SMB_VFS_OP_FCHMOD,
187         SMB_VFS_OP_CHOWN,
188         SMB_VFS_OP_FCHOWN,
189         SMB_VFS_OP_LCHOWN,
190         SMB_VFS_OP_CHDIR,
191         SMB_VFS_OP_GETWD,
192         SMB_VFS_OP_NTIMES,
193         SMB_VFS_OP_FTRUNCATE,
194         SMB_VFS_OP_LOCK,
195         SMB_VFS_OP_KERNEL_FLOCK,
196         SMB_VFS_OP_LINUX_SETLEASE,
197         SMB_VFS_OP_GETLOCK,
198         SMB_VFS_OP_SYMLINK,
199         SMB_VFS_OP_READLINK,
200         SMB_VFS_OP_LINK,
201         SMB_VFS_OP_MKNOD,
202         SMB_VFS_OP_REALPATH,
203         SMB_VFS_OP_NOTIFY_WATCH,
204         SMB_VFS_OP_CHFLAGS,
205         SMB_VFS_OP_FILE_ID_CREATE,
206         SMB_VFS_OP_STREAMINFO,
207
208         /* NT ACL operations. */
209
210         SMB_VFS_OP_FGET_NT_ACL,
211         SMB_VFS_OP_GET_NT_ACL,
212         SMB_VFS_OP_FSET_NT_ACL,
213
214         /* POSIX ACL operations. */
215
216         SMB_VFS_OP_CHMOD_ACL,
217         SMB_VFS_OP_FCHMOD_ACL,
218
219         SMB_VFS_OP_SYS_ACL_GET_ENTRY,
220         SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
221         SMB_VFS_OP_SYS_ACL_GET_PERMSET,
222         SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
223         SMB_VFS_OP_SYS_ACL_GET_FILE,
224         SMB_VFS_OP_SYS_ACL_GET_FD,
225         SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
226         SMB_VFS_OP_SYS_ACL_ADD_PERM,
227         SMB_VFS_OP_SYS_ACL_TO_TEXT,
228         SMB_VFS_OP_SYS_ACL_INIT,
229         SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
230         SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
231         SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
232         SMB_VFS_OP_SYS_ACL_SET_PERMSET,
233         SMB_VFS_OP_SYS_ACL_VALID,
234         SMB_VFS_OP_SYS_ACL_SET_FILE,
235         SMB_VFS_OP_SYS_ACL_SET_FD,
236         SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
237         SMB_VFS_OP_SYS_ACL_GET_PERM,
238         SMB_VFS_OP_SYS_ACL_FREE_TEXT,
239         SMB_VFS_OP_SYS_ACL_FREE_ACL,
240         SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
241         
242         /* EA operations. */
243         SMB_VFS_OP_GETXATTR,
244         SMB_VFS_OP_LGETXATTR,
245         SMB_VFS_OP_FGETXATTR,
246         SMB_VFS_OP_LISTXATTR,
247         SMB_VFS_OP_LLISTXATTR,
248         SMB_VFS_OP_FLISTXATTR,
249         SMB_VFS_OP_REMOVEXATTR,
250         SMB_VFS_OP_LREMOVEXATTR,
251         SMB_VFS_OP_FREMOVEXATTR,
252         SMB_VFS_OP_SETXATTR,
253         SMB_VFS_OP_LSETXATTR,
254         SMB_VFS_OP_FSETXATTR,
255
256         /* aio operations */
257         SMB_VFS_OP_AIO_READ,
258         SMB_VFS_OP_AIO_WRITE,
259         SMB_VFS_OP_AIO_RETURN,
260         SMB_VFS_OP_AIO_CANCEL,
261         SMB_VFS_OP_AIO_ERROR,
262         SMB_VFS_OP_AIO_FSYNC,
263         SMB_VFS_OP_AIO_SUSPEND,
264         SMB_VFS_OP_AIO_FORCE,
265
266         /* offline operations */
267         SMB_VFS_OP_IS_OFFLINE,
268         SMB_VFS_OP_SET_OFFLINE,
269
270         /* This should always be last enum value */
271
272         SMB_VFS_OP_LAST
273 } vfs_op_type;
274
275 /*
276     Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
277 */
278 struct vfs_ops {
279         struct vfs_fn_pointers {
280                 /* Disk operations */
281
282                 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
283                 void (*disconnect)(struct vfs_handle_struct *handle);
284                 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, SMB_BIG_UINT *bsize,
285                         SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
286                 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
287                 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
288                 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
289                 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
290                 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle);
291
292                 /* Directory operations */
293
294                 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
295                 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
296                 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
297                 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
298                 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
299                 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
300                 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
301                 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
302
303                 /* File operations */
304
305                 int (*open)(struct vfs_handle_struct *handle, const char *fname, files_struct *fsp, int flags, mode_t mode);
306                 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
307                 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
308                 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
309                 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
310                 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
311                 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
312                 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
313                 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
314                 int (*rename)(struct vfs_handle_struct *handle, const char *oldname, const char *newname);
315                 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
316                 int (*stat)(struct vfs_handle_struct *handle, const char *fname, SMB_STRUCT_STAT *sbuf);
317                 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
318                 int (*lstat)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
319                 int (*unlink)(struct vfs_handle_struct *handle, const char *path);
320                 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
321                 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
322                 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
323                 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
324                 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
325                 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
326                 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
327                 int (*ntimes)(struct vfs_handle_struct *handle, const char *path, const struct timespec ts[2]);
328                 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
329                 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
330                 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, uint32 share_mode);
331                 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
332                 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
333                 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
334                 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
335                 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
336                 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
337                 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
338                 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
339                                          struct sys_notify_context *ctx,
340                                          struct notify_entry *e,
341                                          void (*callback)(struct sys_notify_context *ctx, 
342                                                           void *private_data,
343                                                           struct notify_event *ev),
344                                          void *private_data, void *handle_p);
345                 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
346                 struct file_id (*file_id_create)(struct vfs_handle_struct *handle, SMB_DEV_T dev, SMB_INO_T inode);
347
348                 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
349                                        struct files_struct *fsp,
350                                        const char *fname,
351                                        TALLOC_CTX *mem_ctx,
352                                        unsigned int *num_streams,
353                                        struct stream_struct **streams);
354
355                 /* NT ACL operations. */
356
357                 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
358                                         struct files_struct *fsp,
359                                         uint32 security_info,
360                                         struct security_descriptor **ppdesc);
361                 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
362                                        const char *name,
363                                        uint32 security_info,
364                                        struct security_descriptor **ppdesc);
365                 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
366                                         struct files_struct *fsp,
367                                         uint32 security_info_sent,
368                                         struct security_descriptor *psd);
369
370                 /* POSIX ACL operations. */
371
372                 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
373                 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
374
375                 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
376                 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
377                 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
378                 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
379                 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
380                 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
381                 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
382                 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
383                 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
384                 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
385                 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
386                 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
387                 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
388                 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
389                 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
390                 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
391                 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
392                 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
393                 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
394                 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
395                 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
396                 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
397
398                 /* EA operations. */
399                 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
400                 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
401                 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
402                 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
403                 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
404                 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
405                 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
406                 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
407                 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
408                 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
409                 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
410                 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
411
412                 /* aio operations */
413                 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
414                 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
415                 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
416                 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
417                 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
418                 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
419                 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
420                 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
421
422                 /* offline operations */
423                 bool (*is_offline)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
424                 int (*set_offline)(struct vfs_handle_struct *handle, const char *path);
425         } ops;
426
427         struct vfs_handles_pointers {
428                 /* Disk operations */
429
430                 struct vfs_handle_struct *connect_hnd;
431                 struct vfs_handle_struct *disconnect;
432                 struct vfs_handle_struct *disk_free;
433                 struct vfs_handle_struct *get_quota;
434                 struct vfs_handle_struct *set_quota;
435                 struct vfs_handle_struct *get_shadow_copy_data;
436                 struct vfs_handle_struct *statvfs;
437                 struct vfs_handle_struct *fs_capabilities;
438
439                 /* Directory operations */
440
441                 struct vfs_handle_struct *opendir;
442                 struct vfs_handle_struct *readdir;
443                 struct vfs_handle_struct *seekdir;
444                 struct vfs_handle_struct *telldir;
445                 struct vfs_handle_struct *rewind_dir;
446                 struct vfs_handle_struct *mkdir;
447                 struct vfs_handle_struct *rmdir;
448                 struct vfs_handle_struct *closedir;
449
450                 /* File operations */
451
452                 struct vfs_handle_struct *open;
453                 struct vfs_handle_struct *close_hnd;
454                 struct vfs_handle_struct *vfs_read;
455                 struct vfs_handle_struct *pread;
456                 struct vfs_handle_struct *write;
457                 struct vfs_handle_struct *pwrite;
458                 struct vfs_handle_struct *lseek;
459                 struct vfs_handle_struct *sendfile;
460                 struct vfs_handle_struct *recvfile;
461                 struct vfs_handle_struct *rename;
462                 struct vfs_handle_struct *fsync;
463                 struct vfs_handle_struct *stat;
464                 struct vfs_handle_struct *fstat;
465                 struct vfs_handle_struct *lstat;
466                 struct vfs_handle_struct *unlink;
467                 struct vfs_handle_struct *chmod;
468                 struct vfs_handle_struct *fchmod;
469                 struct vfs_handle_struct *chown;
470                 struct vfs_handle_struct *fchown;
471                 struct vfs_handle_struct *lchown;
472                 struct vfs_handle_struct *chdir;
473                 struct vfs_handle_struct *getwd;
474                 struct vfs_handle_struct *ntimes;
475                 struct vfs_handle_struct *ftruncate;
476                 struct vfs_handle_struct *lock;
477                 struct vfs_handle_struct *kernel_flock;
478                 struct vfs_handle_struct *linux_setlease;
479                 struct vfs_handle_struct *getlock;
480                 struct vfs_handle_struct *symlink;
481                 struct vfs_handle_struct *vfs_readlink;
482                 struct vfs_handle_struct *link;
483                 struct vfs_handle_struct *mknod;
484                 struct vfs_handle_struct *realpath;
485                 struct vfs_handle_struct *notify_watch;
486                 struct vfs_handle_struct *chflags;
487                 struct vfs_handle_struct *file_id_create;
488                 struct vfs_handle_struct *streaminfo;
489
490                 /* NT ACL operations. */
491
492                 struct vfs_handle_struct *fget_nt_acl;
493                 struct vfs_handle_struct *get_nt_acl;
494                 struct vfs_handle_struct *fset_nt_acl;
495
496                 /* POSIX ACL operations. */
497
498                 struct vfs_handle_struct *chmod_acl;
499                 struct vfs_handle_struct *fchmod_acl;
500
501                 struct vfs_handle_struct *sys_acl_get_entry;
502                 struct vfs_handle_struct *sys_acl_get_tag_type;
503                 struct vfs_handle_struct *sys_acl_get_permset;
504                 struct vfs_handle_struct *sys_acl_get_qualifier;
505                 struct vfs_handle_struct *sys_acl_get_file;
506                 struct vfs_handle_struct *sys_acl_get_fd;
507                 struct vfs_handle_struct *sys_acl_clear_perms;
508                 struct vfs_handle_struct *sys_acl_add_perm;
509                 struct vfs_handle_struct *sys_acl_to_text;
510                 struct vfs_handle_struct *sys_acl_init;
511                 struct vfs_handle_struct *sys_acl_create_entry;
512                 struct vfs_handle_struct *sys_acl_set_tag_type;
513                 struct vfs_handle_struct *sys_acl_set_qualifier;
514                 struct vfs_handle_struct *sys_acl_set_permset;
515                 struct vfs_handle_struct *sys_acl_valid;
516                 struct vfs_handle_struct *sys_acl_set_file;
517                 struct vfs_handle_struct *sys_acl_set_fd;
518                 struct vfs_handle_struct *sys_acl_delete_def_file;
519                 struct vfs_handle_struct *sys_acl_get_perm;
520                 struct vfs_handle_struct *sys_acl_free_text;
521                 struct vfs_handle_struct *sys_acl_free_acl;
522                 struct vfs_handle_struct *sys_acl_free_qualifier;
523
524                 /* EA operations. */
525                 struct vfs_handle_struct *getxattr;
526                 struct vfs_handle_struct *lgetxattr;
527                 struct vfs_handle_struct *fgetxattr;
528                 struct vfs_handle_struct *listxattr;
529                 struct vfs_handle_struct *llistxattr;
530                 struct vfs_handle_struct *flistxattr;
531                 struct vfs_handle_struct *removexattr;
532                 struct vfs_handle_struct *lremovexattr;
533                 struct vfs_handle_struct *fremovexattr;
534                 struct vfs_handle_struct *setxattr;
535                 struct vfs_handle_struct *lsetxattr;
536                 struct vfs_handle_struct *fsetxattr;
537
538                 /* aio operations */
539                 struct vfs_handle_struct *aio_read;
540                 struct vfs_handle_struct *aio_write;
541                 struct vfs_handle_struct *aio_return;
542                 struct vfs_handle_struct *aio_cancel;
543                 struct vfs_handle_struct *aio_error;
544                 struct vfs_handle_struct *aio_fsync;
545                 struct vfs_handle_struct *aio_suspend;
546                 struct vfs_handle_struct *aio_force;
547
548                 /* offline operations */
549                 struct vfs_handle_struct *is_offline;
550                 struct vfs_handle_struct *set_offline;
551         } handles;
552 };
553
554 /*
555     Possible VFS operation layers (per-operation)
556
557     These values are used by VFS subsystem when building vfs_ops for connection
558     from multiple VFS modules. Internally, Samba differentiates only opaque and
559     transparent layers at this process. Other types are used for providing better
560     diagnosing facilities.
561
562     Most modules will provide transparent layers. Opaque layer is for modules
563     which implement actual file system calls (like DB-based VFS). For example,
564     default POSIX VFS which is built in into Samba is an opaque VFS module.
565
566     Other layer types (audit, splitter, scanner) were designed to provide different 
567     degree of transparency and for diagnosing VFS module behaviour.
568
569     Each module can implement several layers at the same time provided that only
570     one layer is used per each operation.
571
572 */
573
574 typedef enum _vfs_op_layer {
575         SMB_VFS_LAYER_NOOP = -1,        /* - For using in VFS module to indicate end of array */
576                                         /*   of operations description */
577         SMB_VFS_LAYER_OPAQUE = 0,       /* - Final level, does not call anything beyond itself */
578         SMB_VFS_LAYER_TRANSPARENT,      /* - Normal operation, calls underlying layer after */
579                                         /*   possibly changing passed data */
580         SMB_VFS_LAYER_LOGGER,           /* - Logs data, calls underlying layer, logging may not */
581                                         /*   use Samba VFS */
582         SMB_VFS_LAYER_SPLITTER,         /* - Splits operation, calls underlying layer _and_ own facility, */
583                                         /*   then combines result */
584         SMB_VFS_LAYER_SCANNER           /* - Checks data and possibly initiates additional */
585                                         /*   file activity like logging to files _inside_ samba VFS */
586 } vfs_op_layer;
587
588 /*
589     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
590     which describes all operations this module is willing to intercept.
591     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
592     using this information.
593 */
594
595 typedef struct vfs_op_tuple {
596         void* op;
597         vfs_op_type type;
598         vfs_op_layer layer;
599 } vfs_op_tuple;
600
601
602 typedef struct vfs_handle_struct {
603         struct vfs_handle_struct  *next, *prev;
604         const char *param;
605         struct vfs_ops vfs_next;
606         struct connection_struct *conn;
607         void *data;
608         void (*free_data)(void **data);
609 } vfs_handle_struct;
610
611
612 typedef struct vfs_statvfs_struct {
613         /* For undefined recommended transfer size return -1 in that field */
614         uint32 OptimalTransferSize;  /* bsize on some os, iosize on other os */
615         uint32 BlockSize;
616
617         /*
618          The next three fields are in terms of the block size.
619          (above). If block size is unknown, 4096 would be a
620          reasonable block size for a server to report.
621          Note that returning the blocks/blocksavail removes need
622          to make a second call (to QFSInfo level 0x103 to get this info.
623          UserBlockAvail is typically less than or equal to BlocksAvail,
624          if no distinction is made return the same value in each.
625         */
626
627         SMB_BIG_UINT TotalBlocks;
628         SMB_BIG_UINT BlocksAvail;       /* bfree */
629         SMB_BIG_UINT UserBlocksAvail;   /* bavail */
630
631         /* For undefined Node fields or FSID return -1 */
632         SMB_BIG_UINT TotalFileNodes;
633         SMB_BIG_UINT FreeFileNodes;
634         SMB_BIG_UINT FsIdentifier;   /* fsid */
635         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
636         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
637
638         int FsCapabilities;
639 } vfs_statvfs_struct;
640
641 /* Add a new FSP extension of the given type. Returns a pointer to the
642  * extenstion data.
643  */
644 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type) \
645     vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type))
646
647 /* Return a pointer to the existing FSP extension data. */
648 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
649     vfs_fetch_fsp_extension(handle, (fsp))
650
651 /* Return the talloc context associated with an FSP extension. */
652 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
653     vfs_memctx_fsp_extension(handle, (fsp))
654
655 /* Remove and destroy an FSP extension. */
656 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
657     vfs_remove_fsp_extension((handle), (fsp))
658
659 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
660         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
661                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
662                 ret; \
663         } \
664 }
665
666 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
667         if (!(handle)) { \
668                 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
669                 ret; \
670         } else { \
671                 if ((handle)->free_data) { \
672                         (handle)->free_data(&(handle)->data); \
673                 } \
674                 (handle)->data = (void *)datap; \
675                 (handle)->free_data = free_fn; \
676         } \
677 }
678
679 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
680         if ((handle) && (handle)->free_data) { \
681                 (handle)->free_data(&(handle)->data); \
682         } \
683 }
684
685 /* Check whether module-specific data handle was already allocated or not */
686 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
687
688 #define SMB_VFS_OP(x) ((void *) x)
689
690 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
691
692 #include "vfs_macros.h"
693
694 #endif /* _VFS_H */