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