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