An oplock break reply from the client causes the sequence number to be
[jra/samba/.git] / source3 / include / vfs.h
1 /* 
2    Unix SMB/CIFS implementation.
3    VFS structures and parameters
4    Copyright (C) Jeremy Allison                         1999-2003
5    Copyright (C) Tim Potter                             1999
6    Copyright (C) Alexander Bokovoy                      2002
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 2 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, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22
23    This work was sponsored by Optifacio Software Services, Inc.
24 */
25
26 #ifndef _VFS_H
27 #define _VFS_H
28
29 /* Avoid conflict with an AIX include file */
30
31 #ifdef vfs_ops
32 #undef vfs_ops
33 #endif
34
35 /*
36  * As we're now (thanks Andrew ! :-) using file_structs and connection
37  * structs in the vfs - then anyone writing a vfs must include includes.h...
38  */
39
40 /*
41  * This next constant specifies the version number of the VFS interface
42  * this smbd will load. Increment this if *ANY* changes are made to the
43  * vfs_ops below. JRA.
44  */
45
46 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
47 /* Changed to version 3 for POSIX acl extensions. JRA. */
48 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
49 /* Changed to version 5 for sendfile addition. JRA. */
50 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
51 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
52 /* Changed to version 8 includes EA calls. JRA. */
53
54 #define SMB_VFS_INTERFACE_VERSION 8
55
56
57 /* to bug old modules witch are trying to compile with the old functions */
58 #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 };
59 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
60   __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
61 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
62   __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
63
64 /*
65     All intercepted VFS operations must be declared as static functions inside module source
66     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
67     example VFS modules for more details.
68 */
69
70 /* VFS operations structure */
71
72 struct vfs_handle_struct;
73 struct connection_struct;
74 struct files_struct;
75 struct security_descriptor_info;
76
77 /*
78     Available VFS operations. These values must be in sync with vfs_ops struct
79     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops). 
80     In particular, if new operations are added to vfs_ops, appropriate constants
81     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
82 */
83
84 typedef enum _vfs_op_type {
85         SMB_VFS_OP_NOOP = -1,
86         
87         /* Disk operations */
88
89         SMB_VFS_OP_CONNECT = 0,
90         SMB_VFS_OP_DISCONNECT,
91         SMB_VFS_OP_DISK_FREE,
92         SMB_VFS_OP_GET_QUOTA,
93         SMB_VFS_OP_SET_QUOTA,
94
95         /* Directory operations */
96
97         SMB_VFS_OP_OPENDIR,
98         SMB_VFS_OP_READDIR,
99         SMB_VFS_OP_MKDIR,
100         SMB_VFS_OP_RMDIR,
101         SMB_VFS_OP_CLOSEDIR,
102
103         /* File operations */
104
105         SMB_VFS_OP_OPEN,
106         SMB_VFS_OP_CLOSE,
107         SMB_VFS_OP_READ,
108         SMB_VFS_OP_WRITE,
109         SMB_VFS_OP_LSEEK,
110         SMB_VFS_OP_SENDFILE,
111         SMB_VFS_OP_RENAME,
112         SMB_VFS_OP_FSYNC,
113         SMB_VFS_OP_STAT,
114         SMB_VFS_OP_FSTAT,
115         SMB_VFS_OP_LSTAT,
116         SMB_VFS_OP_UNLINK,
117         SMB_VFS_OP_CHMOD,
118         SMB_VFS_OP_FCHMOD,
119         SMB_VFS_OP_CHOWN,
120         SMB_VFS_OP_FCHOWN,
121         SMB_VFS_OP_CHDIR,
122         SMB_VFS_OP_GETWD,
123         SMB_VFS_OP_UTIME,
124         SMB_VFS_OP_FTRUNCATE,
125         SMB_VFS_OP_LOCK,
126         SMB_VFS_OP_SYMLINK,
127         SMB_VFS_OP_READLINK,
128         SMB_VFS_OP_LINK,
129         SMB_VFS_OP_MKNOD,
130         SMB_VFS_OP_REALPATH,
131
132         /* NT ACL operations. */
133
134         SMB_VFS_OP_FGET_NT_ACL,
135         SMB_VFS_OP_GET_NT_ACL,
136         SMB_VFS_OP_FSET_NT_ACL,
137         SMB_VFS_OP_SET_NT_ACL,
138
139         /* POSIX ACL operations. */
140
141         SMB_VFS_OP_CHMOD_ACL,
142         SMB_VFS_OP_FCHMOD_ACL,
143
144         SMB_VFS_OP_SYS_ACL_GET_ENTRY,
145         SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
146         SMB_VFS_OP_SYS_ACL_GET_PERMSET,
147         SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
148         SMB_VFS_OP_SYS_ACL_GET_FILE,
149         SMB_VFS_OP_SYS_ACL_GET_FD,
150         SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
151         SMB_VFS_OP_SYS_ACL_ADD_PERM,
152         SMB_VFS_OP_SYS_ACL_TO_TEXT,
153         SMB_VFS_OP_SYS_ACL_INIT,
154         SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
155         SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
156         SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
157         SMB_VFS_OP_SYS_ACL_SET_PERMSET,
158         SMB_VFS_OP_SYS_ACL_VALID,
159         SMB_VFS_OP_SYS_ACL_SET_FILE,
160         SMB_VFS_OP_SYS_ACL_SET_FD,
161         SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
162         SMB_VFS_OP_SYS_ACL_GET_PERM,
163         SMB_VFS_OP_SYS_ACL_FREE_TEXT,
164         SMB_VFS_OP_SYS_ACL_FREE_ACL,
165         SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
166         
167         /* EA operations. */
168         SMB_VFS_OP_GETXATTR,
169         SMB_VFS_OP_LGETXATTR,
170         SMB_VFS_OP_FGETXATTR,
171         SMB_VFS_OP_LISTXATTR,
172         SMB_VFS_OP_LLISTXATTR,
173         SMB_VFS_OP_FLISTXATTR,
174         SMB_VFS_OP_REMOVEXATTR,
175         SMB_VFS_OP_LREMOVEXATTR,
176         SMB_VFS_OP_FREMOVEXATTR,
177         SMB_VFS_OP_SETXATTR,
178         SMB_VFS_OP_LSETXATTR,
179         SMB_VFS_OP_FSETXATTR,
180
181         /* This should always be last enum value */
182         
183         SMB_VFS_OP_LAST
184 } vfs_op_type;
185
186 /*
187     Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
188 */
189 struct vfs_ops {
190         struct vfs_fn_pointers {
191                 /* Disk operations */
192                 
193                 int (*connect)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *service, const char *user);
194                 void (*disconnect)(struct vfs_handle_struct *handle, struct connection_struct *conn);
195                 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, BOOL small_query, SMB_BIG_UINT *bsize, 
196                         SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
197                 int (*get_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
198                 int (*set_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
199                 
200                 /* Directory operations */
201                 
202                 DIR *(*opendir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname);
203                 struct dirent *(*readdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
204                 int (*mkdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
205                 int (*rmdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
206                 int (*closedir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dir);
207                 
208                 /* File operations */
209                 
210                 int (*open)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, int flags, mode_t mode);
211                 int (*close)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
212                 ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
213                 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
214                 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
215                 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);
216                 int (*rename)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *old, const char *new);
217                 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
218                 int (*stat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, SMB_STRUCT_STAT *sbuf);
219                 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
220                 int (*lstat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf);
221                 int (*unlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
222                 int (*chmod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
223                 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
224                 int (*chown)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, uid_t uid, gid_t gid);
225                 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
226                 int (*chdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
227                 char *(*getwd)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *buf);
228                 int (*utime)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, struct utimbuf *times);
229                 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
230                 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);
231                 int (*symlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
232                 int (*readlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *buf, size_t bufsiz);
233                 int (*link)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
234                 int (*mknod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode, SMB_DEV_T dev);
235                 char *(*realpath)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *resolved_path);
236                 
237                 /* NT ACL operations. */
238                 
239                 size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd,  uint32 security_info, struct security_descriptor_info **ppdesc);
240                 size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name,  uint32 security_info, struct security_descriptor_info **ppdesc);
241                 BOOL (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor_info *psd);
242                 BOOL (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor_info *psd);
243                 
244                 /* POSIX ACL operations. */
245                 
246                 int (*chmod_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, mode_t mode);
247                 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
248                 
249                 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
250                 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
251                 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
252                 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d);
253                 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path_p, SMB_ACL_TYPE_T type);
254                 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
255                 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset);
256                 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
257                 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, ssize_t *plen);
258                 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, struct connection_struct *conn, int count);
259                 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
260                 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
261                 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, void *qual);
262                 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
263                 int (*sys_acl_valid)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl );
264                 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
265                 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
266                 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
267                 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
268                 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *text);
269                 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T posix_acl);
270                 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, void *qualifier, SMB_ACL_TAG_T tagtype);
271
272                 /* EA operations. */
273                 ssize_t (*getxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
274                 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
275                 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
276                 ssize_t (*listxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
277                 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
278                 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
279                 int (*removexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
280                 int (*lremovexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
281                 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
282                 int (*setxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
283                 int (*lsetxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
284                 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
285
286         } ops;
287
288         struct vfs_handles_pointers {
289                 /* Disk operations */
290
291                 struct vfs_handle_struct *connect;
292                 struct vfs_handle_struct *disconnect;
293                 struct vfs_handle_struct *disk_free;
294                 struct vfs_handle_struct *get_quota;
295                 struct vfs_handle_struct *set_quota;
296
297                 /* Directory operations */
298
299                 struct vfs_handle_struct *opendir;
300                 struct vfs_handle_struct *readdir;
301                 struct vfs_handle_struct *mkdir;
302                 struct vfs_handle_struct *rmdir;
303                 struct vfs_handle_struct *closedir;
304
305                 /* File operations */
306
307                 struct vfs_handle_struct *open;
308                 struct vfs_handle_struct *close;
309                 struct vfs_handle_struct *read;
310                 struct vfs_handle_struct *write;
311                 struct vfs_handle_struct *lseek;
312                 struct vfs_handle_struct *sendfile;
313                 struct vfs_handle_struct *rename;
314                 struct vfs_handle_struct *fsync;
315                 struct vfs_handle_struct *stat;
316                 struct vfs_handle_struct *fstat;
317                 struct vfs_handle_struct *lstat;
318                 struct vfs_handle_struct *unlink;
319                 struct vfs_handle_struct *chmod;
320                 struct vfs_handle_struct *fchmod;
321                 struct vfs_handle_struct *chown;
322                 struct vfs_handle_struct *fchown;
323                 struct vfs_handle_struct *chdir;
324                 struct vfs_handle_struct *getwd;
325                 struct vfs_handle_struct *utime;
326                 struct vfs_handle_struct *ftruncate;
327                 struct vfs_handle_struct *lock;
328                 struct vfs_handle_struct *symlink;
329                 struct vfs_handle_struct *readlink;
330                 struct vfs_handle_struct *link;
331                 struct vfs_handle_struct *mknod;
332                 struct vfs_handle_struct *realpath;
333
334                 /* NT ACL operations. */
335
336                 struct vfs_handle_struct *fget_nt_acl;
337                 struct vfs_handle_struct *get_nt_acl;
338                 struct vfs_handle_struct *fset_nt_acl;
339                 struct vfs_handle_struct *set_nt_acl;
340
341                 /* POSIX ACL operations. */
342
343                 struct vfs_handle_struct *chmod_acl;
344                 struct vfs_handle_struct *fchmod_acl;
345
346                 struct vfs_handle_struct *sys_acl_get_entry;
347                 struct vfs_handle_struct *sys_acl_get_tag_type;
348                 struct vfs_handle_struct *sys_acl_get_permset;
349                 struct vfs_handle_struct *sys_acl_get_qualifier;
350                 struct vfs_handle_struct *sys_acl_get_file;
351                 struct vfs_handle_struct *sys_acl_get_fd;
352                 struct vfs_handle_struct *sys_acl_clear_perms;
353                 struct vfs_handle_struct *sys_acl_add_perm;
354                 struct vfs_handle_struct *sys_acl_to_text;
355                 struct vfs_handle_struct *sys_acl_init;
356                 struct vfs_handle_struct *sys_acl_create_entry;
357                 struct vfs_handle_struct *sys_acl_set_tag_type;
358                 struct vfs_handle_struct *sys_acl_set_qualifier;
359                 struct vfs_handle_struct *sys_acl_set_permset;
360                 struct vfs_handle_struct *sys_acl_valid;
361                 struct vfs_handle_struct *sys_acl_set_file;
362                 struct vfs_handle_struct *sys_acl_set_fd;
363                 struct vfs_handle_struct *sys_acl_delete_def_file;
364                 struct vfs_handle_struct *sys_acl_get_perm;
365                 struct vfs_handle_struct *sys_acl_free_text;
366                 struct vfs_handle_struct *sys_acl_free_acl;
367                 struct vfs_handle_struct *sys_acl_free_qualifier;
368
369                 /* EA operations. */
370                 struct vfs_handle_struct *getxattr;
371                 struct vfs_handle_struct *lgetxattr;
372                 struct vfs_handle_struct *fgetxattr;
373                 struct vfs_handle_struct *listxattr;
374                 struct vfs_handle_struct *llistxattr;
375                 struct vfs_handle_struct *flistxattr;
376                 struct vfs_handle_struct *removexattr;
377                 struct vfs_handle_struct *lremovexattr;
378                 struct vfs_handle_struct *fremovexattr;
379                 struct vfs_handle_struct *setxattr;
380                 struct vfs_handle_struct *lsetxattr;
381                 struct vfs_handle_struct *fsetxattr;
382         } handles;
383 };
384
385 /*
386     Possible VFS operation layers (per-operation)
387     
388     These values are used by VFS subsystem when building vfs_ops for connection
389     from multiple VFS modules. Internally, Samba differentiates only opaque and
390     transparent layers at this process. Other types are used for providing better
391     diagnosing facilities.
392     
393     Most modules will provide transparent layers. Opaque layer is for modules
394     which implement actual file system calls (like DB-based VFS). For example,
395     default POSIX VFS which is built in into Samba is an opaque VFS module.
396     
397     Other layer types (audit, splitter, scanner) were designed to provide different 
398     degree of transparency and for diagnosing VFS module behaviour.
399     
400     Each module can implement several layers at the same time provided that only
401     one layer is used per each operation.
402     
403 */
404
405 typedef enum _vfs_op_layer {
406         SMB_VFS_LAYER_NOOP = -1,        /* - For using in VFS module to indicate end of array */
407                                         /*   of operations description */
408         SMB_VFS_LAYER_OPAQUE = 0,       /* - Final level, does not call anything beyond itself */
409         SMB_VFS_LAYER_TRANSPARENT,      /* - Normal operation, calls underlying layer after */
410                                         /*   possibly changing passed data */
411         SMB_VFS_LAYER_LOGGER,           /* - Logs data, calls underlying layer, logging may not */
412                                         /*   use Samba VFS */
413         SMB_VFS_LAYER_SPLITTER,         /* - Splits operation, calls underlying layer _and_ own facility, */
414                                         /*   then combines result */
415         SMB_VFS_LAYER_SCANNER           /* - Checks data and possibly initiates additional */
416                                         /*   file activity like logging to files _inside_ samba VFS */
417 } vfs_op_layer;
418
419 /*
420     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
421     which describes all operations this module is willing to intercept. 
422     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
423     using this information.
424 */
425
426 typedef struct _vfs_op_tuple {
427         void* op;
428         vfs_op_type type;
429         vfs_op_layer layer;
430 } vfs_op_tuple;
431
432
433 typedef struct vfs_handle_struct {
434         struct vfs_handle_struct  *next, *prev;
435         const char *param;
436         struct vfs_ops vfs_next;
437         struct connection_struct *conn;
438         void *data;
439         void (*free_data)(void **data);
440 } vfs_handle_struct;
441
442
443 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
444         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
445                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
446                 ret; \
447         } \
448 }
449
450 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
451         if (!(handle)) { \
452                 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
453                 ret; \
454         } else { \
455                 if ((handle)->free_data) { \
456                         (handle)->free_data(&(handle)->data); \
457                 } \
458                 (handle)->data = (void *)datap; \
459                 (handle)->free_data = free_fn; \
460         } \
461 }
462
463 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
464         if ((handle) && (handle)->free_data) { \
465                 (handle)->free_data(&(handle)->data); \
466         } \
467 }
468
469 /* Check whether module-specific data handle was already allocated or not */
470 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
471
472 #define SMB_VFS_OP(x) ((void *) x)
473
474
475 #include "vfs_macros.h"
476
477 #endif /* _VFS_H */