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