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