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