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