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