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
7 Copyright (C) Stefan (metze) Metzmacher 2003
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
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.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 This work was sponsored by Optifacio Software Services, Inc.
29 /* Avoid conflict with an AIX include file */
36 * As we're now (thanks Andrew ! :-) using file_structs and connection
37 * structs in the vfs - then anyone writing a vfs must include includes.h...
41 * This next constant specifies the version number of the VFS interface
42 * this smbd will load. Increment this if *ANY* changes are made to the
45 * If you change anything here, please also update modules/vfs_full_audit.c.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 #define SMB_VFS_INTERFACE_VERSION 12
64 /* to bug old modules which are trying to compile with the old functions */
65 #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 };
66 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
67 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
68 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
69 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
72 All intercepted VFS operations must be declared as static functions inside module source
73 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
74 example VFS modules for more details.
77 /* VFS operations structure */
79 struct vfs_handle_struct;
80 struct connection_struct;
82 struct security_descriptor_info;
85 Available VFS operations. These values must be in sync with vfs_ops struct
86 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
87 In particular, if new operations are added to vfs_ops, appropriate constants
88 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
91 typedef enum _vfs_op_type {
96 SMB_VFS_OP_CONNECT = 0,
97 SMB_VFS_OP_DISCONNECT,
100 SMB_VFS_OP_SET_QUOTA,
101 SMB_VFS_OP_GET_SHADOW_COPY_DATA,
104 /* Directory operations */
110 SMB_VFS_OP_REWINDDIR,
115 /* File operations */
138 SMB_VFS_OP_FTRUNCATE,
146 /* NT ACL operations. */
148 SMB_VFS_OP_FGET_NT_ACL,
149 SMB_VFS_OP_GET_NT_ACL,
150 SMB_VFS_OP_FSET_NT_ACL,
151 SMB_VFS_OP_SET_NT_ACL,
153 /* POSIX ACL operations. */
155 SMB_VFS_OP_CHMOD_ACL,
156 SMB_VFS_OP_FCHMOD_ACL,
158 SMB_VFS_OP_SYS_ACL_GET_ENTRY,
159 SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
160 SMB_VFS_OP_SYS_ACL_GET_PERMSET,
161 SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
162 SMB_VFS_OP_SYS_ACL_GET_FILE,
163 SMB_VFS_OP_SYS_ACL_GET_FD,
164 SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
165 SMB_VFS_OP_SYS_ACL_ADD_PERM,
166 SMB_VFS_OP_SYS_ACL_TO_TEXT,
167 SMB_VFS_OP_SYS_ACL_INIT,
168 SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
169 SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
170 SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
171 SMB_VFS_OP_SYS_ACL_SET_PERMSET,
172 SMB_VFS_OP_SYS_ACL_VALID,
173 SMB_VFS_OP_SYS_ACL_SET_FILE,
174 SMB_VFS_OP_SYS_ACL_SET_FD,
175 SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
176 SMB_VFS_OP_SYS_ACL_GET_PERM,
177 SMB_VFS_OP_SYS_ACL_FREE_TEXT,
178 SMB_VFS_OP_SYS_ACL_FREE_ACL,
179 SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
183 SMB_VFS_OP_LGETXATTR,
184 SMB_VFS_OP_FGETXATTR,
185 SMB_VFS_OP_LISTXATTR,
186 SMB_VFS_OP_LLISTXATTR,
187 SMB_VFS_OP_FLISTXATTR,
188 SMB_VFS_OP_REMOVEXATTR,
189 SMB_VFS_OP_LREMOVEXATTR,
190 SMB_VFS_OP_FREMOVEXATTR,
192 SMB_VFS_OP_LSETXATTR,
193 SMB_VFS_OP_FSETXATTR,
197 SMB_VFS_OP_AIO_WRITE,
198 SMB_VFS_OP_AIO_RETURN,
199 SMB_VFS_OP_AIO_CANCEL,
200 SMB_VFS_OP_AIO_ERROR,
201 SMB_VFS_OP_AIO_FSYNC,
202 SMB_VFS_OP_AIO_SUSPEND,
204 /* This should always be last enum value */
210 Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
213 struct vfs_fn_pointers {
214 /* Disk operations */
216 int (*connect)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *service, const char *user);
217 void (*disconnect)(struct vfs_handle_struct *handle, struct connection_struct *conn);
218 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, BOOL small_query, SMB_BIG_UINT *bsize,
219 SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
220 int (*get_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
221 int (*set_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
222 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, BOOL labels);
224 /* Directory operations */
226 DIR *(*opendir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, const char *mask, uint32 attributes);
227 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
228 void (*seekdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp, long offset);
229 long (*telldir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
230 void (*rewind_dir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
231 int (*mkdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
232 int (*rmdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
233 int (*closedir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dir);
235 /* File operations */
237 int (*open)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, int flags, mode_t mode);
238 int (*close)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
239 ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
240 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
241 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
242 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
243 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
244 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);
245 int (*rename)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldname, const char *newname);
246 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
247 int (*stat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, SMB_STRUCT_STAT *sbuf);
248 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
249 int (*lstat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf);
250 int (*unlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
251 int (*chmod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
252 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
253 int (*chown)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, uid_t uid, gid_t gid);
254 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
255 int (*chdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
256 char *(*getwd)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *buf);
257 int (*utime)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, struct utimbuf *times);
258 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
259 BOOL (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
260 int (*symlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
261 int (*readlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *buf, size_t bufsiz);
262 int (*link)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
263 int (*mknod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode, SMB_DEV_T dev);
264 char *(*realpath)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *resolved_path);
266 /* NT ACL operations. */
268 size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info, struct security_descriptor_info **ppdesc);
269 size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info, struct security_descriptor_info **ppdesc);
270 BOOL (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor_info *psd);
271 BOOL (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor_info *psd);
273 /* POSIX ACL operations. */
275 int (*chmod_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, mode_t mode);
276 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
278 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
279 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
280 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
281 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d);
282 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path_p, SMB_ACL_TYPE_T type);
283 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
284 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset);
285 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
286 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, ssize_t *plen);
287 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, struct connection_struct *conn, int count);
288 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
289 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
290 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, void *qual);
291 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
292 int (*sys_acl_valid)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl );
293 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
294 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
295 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
296 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
297 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *text);
298 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T posix_acl);
299 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, void *qualifier, SMB_ACL_TAG_T tagtype);
302 ssize_t (*getxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
303 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
304 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
305 ssize_t (*listxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
306 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
307 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
308 int (*removexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
309 int (*lremovexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
310 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
311 int (*setxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
312 int (*lsetxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
313 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
316 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
317 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
318 ssize_t (*aio_return)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
319 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_AIOCB *aiocb);
320 int (*aio_error)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
321 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
322 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
326 struct vfs_handles_pointers {
327 /* Disk operations */
329 struct vfs_handle_struct *connect;
330 struct vfs_handle_struct *disconnect;
331 struct vfs_handle_struct *disk_free;
332 struct vfs_handle_struct *get_quota;
333 struct vfs_handle_struct *set_quota;
334 struct vfs_handle_struct *get_shadow_copy_data;
336 /* Directory operations */
338 struct vfs_handle_struct *opendir;
339 struct vfs_handle_struct *readdir;
340 struct vfs_handle_struct *seekdir;
341 struct vfs_handle_struct *telldir;
342 struct vfs_handle_struct *rewind_dir;
343 struct vfs_handle_struct *mkdir;
344 struct vfs_handle_struct *rmdir;
345 struct vfs_handle_struct *closedir;
347 /* File operations */
349 struct vfs_handle_struct *open;
350 struct vfs_handle_struct *close;
351 struct vfs_handle_struct *read;
352 struct vfs_handle_struct *pread;
353 struct vfs_handle_struct *write;
354 struct vfs_handle_struct *pwrite;
355 struct vfs_handle_struct *lseek;
356 struct vfs_handle_struct *sendfile;
357 struct vfs_handle_struct *rename;
358 struct vfs_handle_struct *fsync;
359 struct vfs_handle_struct *stat;
360 struct vfs_handle_struct *fstat;
361 struct vfs_handle_struct *lstat;
362 struct vfs_handle_struct *unlink;
363 struct vfs_handle_struct *chmod;
364 struct vfs_handle_struct *fchmod;
365 struct vfs_handle_struct *chown;
366 struct vfs_handle_struct *fchown;
367 struct vfs_handle_struct *chdir;
368 struct vfs_handle_struct *getwd;
369 struct vfs_handle_struct *utime;
370 struct vfs_handle_struct *ftruncate;
371 struct vfs_handle_struct *lock;
372 struct vfs_handle_struct *symlink;
373 struct vfs_handle_struct *readlink;
374 struct vfs_handle_struct *link;
375 struct vfs_handle_struct *mknod;
376 struct vfs_handle_struct *realpath;
378 /* NT ACL operations. */
380 struct vfs_handle_struct *fget_nt_acl;
381 struct vfs_handle_struct *get_nt_acl;
382 struct vfs_handle_struct *fset_nt_acl;
383 struct vfs_handle_struct *set_nt_acl;
385 /* POSIX ACL operations. */
387 struct vfs_handle_struct *chmod_acl;
388 struct vfs_handle_struct *fchmod_acl;
390 struct vfs_handle_struct *sys_acl_get_entry;
391 struct vfs_handle_struct *sys_acl_get_tag_type;
392 struct vfs_handle_struct *sys_acl_get_permset;
393 struct vfs_handle_struct *sys_acl_get_qualifier;
394 struct vfs_handle_struct *sys_acl_get_file;
395 struct vfs_handle_struct *sys_acl_get_fd;
396 struct vfs_handle_struct *sys_acl_clear_perms;
397 struct vfs_handle_struct *sys_acl_add_perm;
398 struct vfs_handle_struct *sys_acl_to_text;
399 struct vfs_handle_struct *sys_acl_init;
400 struct vfs_handle_struct *sys_acl_create_entry;
401 struct vfs_handle_struct *sys_acl_set_tag_type;
402 struct vfs_handle_struct *sys_acl_set_qualifier;
403 struct vfs_handle_struct *sys_acl_set_permset;
404 struct vfs_handle_struct *sys_acl_valid;
405 struct vfs_handle_struct *sys_acl_set_file;
406 struct vfs_handle_struct *sys_acl_set_fd;
407 struct vfs_handle_struct *sys_acl_delete_def_file;
408 struct vfs_handle_struct *sys_acl_get_perm;
409 struct vfs_handle_struct *sys_acl_free_text;
410 struct vfs_handle_struct *sys_acl_free_acl;
411 struct vfs_handle_struct *sys_acl_free_qualifier;
414 struct vfs_handle_struct *getxattr;
415 struct vfs_handle_struct *lgetxattr;
416 struct vfs_handle_struct *fgetxattr;
417 struct vfs_handle_struct *listxattr;
418 struct vfs_handle_struct *llistxattr;
419 struct vfs_handle_struct *flistxattr;
420 struct vfs_handle_struct *removexattr;
421 struct vfs_handle_struct *lremovexattr;
422 struct vfs_handle_struct *fremovexattr;
423 struct vfs_handle_struct *setxattr;
424 struct vfs_handle_struct *lsetxattr;
425 struct vfs_handle_struct *fsetxattr;
428 struct vfs_handle_struct *aio_read;
429 struct vfs_handle_struct *aio_write;
430 struct vfs_handle_struct *aio_return;
431 struct vfs_handle_struct *aio_cancel;
432 struct vfs_handle_struct *aio_error;
433 struct vfs_handle_struct *aio_fsync;
434 struct vfs_handle_struct *aio_suspend;
439 Possible VFS operation layers (per-operation)
441 These values are used by VFS subsystem when building vfs_ops for connection
442 from multiple VFS modules. Internally, Samba differentiates only opaque and
443 transparent layers at this process. Other types are used for providing better
444 diagnosing facilities.
446 Most modules will provide transparent layers. Opaque layer is for modules
447 which implement actual file system calls (like DB-based VFS). For example,
448 default POSIX VFS which is built in into Samba is an opaque VFS module.
450 Other layer types (audit, splitter, scanner) were designed to provide different
451 degree of transparency and for diagnosing VFS module behaviour.
453 Each module can implement several layers at the same time provided that only
454 one layer is used per each operation.
458 typedef enum _vfs_op_layer {
459 SMB_VFS_LAYER_NOOP = -1, /* - For using in VFS module to indicate end of array */
460 /* of operations description */
461 SMB_VFS_LAYER_OPAQUE = 0, /* - Final level, does not call anything beyond itself */
462 SMB_VFS_LAYER_TRANSPARENT, /* - Normal operation, calls underlying layer after */
463 /* possibly changing passed data */
464 SMB_VFS_LAYER_LOGGER, /* - Logs data, calls underlying layer, logging may not */
466 SMB_VFS_LAYER_SPLITTER, /* - Splits operation, calls underlying layer _and_ own facility, */
467 /* then combines result */
468 SMB_VFS_LAYER_SCANNER /* - Checks data and possibly initiates additional */
469 /* file activity like logging to files _inside_ samba VFS */
473 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
474 which describes all operations this module is willing to intercept.
475 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
476 using this information.
479 typedef struct _vfs_op_tuple {
486 typedef struct vfs_handle_struct {
487 struct vfs_handle_struct *next, *prev;
489 struct vfs_ops vfs_next;
490 struct connection_struct *conn;
492 void (*free_data)(void **data);
496 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
497 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
498 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
503 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
505 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
508 if ((handle)->free_data) { \
509 (handle)->free_data(&(handle)->data); \
511 (handle)->data = (void *)datap; \
512 (handle)->free_data = free_fn; \
516 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
517 if ((handle) && (handle)->free_data) { \
518 (handle)->free_data(&(handle)->data); \
522 /* Check whether module-specific data handle was already allocated or not */
523 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
525 #define SMB_VFS_OP(x) ((void *) x)
528 #include "vfs_macros.h"