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