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
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 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 #define SMB_VFS_INTERFACE_VERSION 20
75 /* to bug old modules which are trying to compile with the old functions */
76 #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 };
77 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
78 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
79 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
80 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
83 All intercepted VFS operations must be declared as static functions inside module source
84 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
85 example VFS modules for more details.
88 /* VFS operations structure */
90 struct vfs_handle_struct;
91 struct connection_struct;
93 struct security_descriptor;
94 struct vfs_statvfs_struct;
97 Available VFS operations. These values must be in sync with vfs_ops struct
98 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
99 In particular, if new operations are added to vfs_ops, appropriate constants
100 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
103 typedef enum _vfs_op_type {
104 SMB_VFS_OP_NOOP = -1,
106 /* Disk operations */
108 SMB_VFS_OP_CONNECT = 0,
109 SMB_VFS_OP_DISCONNECT,
110 SMB_VFS_OP_DISK_FREE,
111 SMB_VFS_OP_GET_QUOTA,
112 SMB_VFS_OP_SET_QUOTA,
113 SMB_VFS_OP_GET_SHADOW_COPY_DATA,
116 /* Directory operations */
122 SMB_VFS_OP_REWINDDIR,
127 /* File operations */
150 SMB_VFS_OP_FTRUNCATE,
152 SMB_VFS_OP_KERNEL_FLOCK,
153 SMB_VFS_OP_LINUX_SETLEASE,
160 SMB_VFS_OP_NOTIFY_WATCH,
162 /* NT ACL operations. */
164 SMB_VFS_OP_FGET_NT_ACL,
165 SMB_VFS_OP_GET_NT_ACL,
166 SMB_VFS_OP_FSET_NT_ACL,
167 SMB_VFS_OP_SET_NT_ACL,
169 /* POSIX ACL operations. */
171 SMB_VFS_OP_CHMOD_ACL,
172 SMB_VFS_OP_FCHMOD_ACL,
174 SMB_VFS_OP_SYS_ACL_GET_ENTRY,
175 SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
176 SMB_VFS_OP_SYS_ACL_GET_PERMSET,
177 SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
178 SMB_VFS_OP_SYS_ACL_GET_FILE,
179 SMB_VFS_OP_SYS_ACL_GET_FD,
180 SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
181 SMB_VFS_OP_SYS_ACL_ADD_PERM,
182 SMB_VFS_OP_SYS_ACL_TO_TEXT,
183 SMB_VFS_OP_SYS_ACL_INIT,
184 SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
185 SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
186 SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
187 SMB_VFS_OP_SYS_ACL_SET_PERMSET,
188 SMB_VFS_OP_SYS_ACL_VALID,
189 SMB_VFS_OP_SYS_ACL_SET_FILE,
190 SMB_VFS_OP_SYS_ACL_SET_FD,
191 SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
192 SMB_VFS_OP_SYS_ACL_GET_PERM,
193 SMB_VFS_OP_SYS_ACL_FREE_TEXT,
194 SMB_VFS_OP_SYS_ACL_FREE_ACL,
195 SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
199 SMB_VFS_OP_LGETXATTR,
200 SMB_VFS_OP_FGETXATTR,
201 SMB_VFS_OP_LISTXATTR,
202 SMB_VFS_OP_LLISTXATTR,
203 SMB_VFS_OP_FLISTXATTR,
204 SMB_VFS_OP_REMOVEXATTR,
205 SMB_VFS_OP_LREMOVEXATTR,
206 SMB_VFS_OP_FREMOVEXATTR,
208 SMB_VFS_OP_LSETXATTR,
209 SMB_VFS_OP_FSETXATTR,
213 SMB_VFS_OP_AIO_WRITE,
214 SMB_VFS_OP_AIO_RETURN,
215 SMB_VFS_OP_AIO_CANCEL,
216 SMB_VFS_OP_AIO_ERROR,
217 SMB_VFS_OP_AIO_FSYNC,
218 SMB_VFS_OP_AIO_SUSPEND,
220 /* This should always be last enum value */
226 Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
229 struct vfs_fn_pointers {
230 /* Disk operations */
232 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
233 void (*disconnect)(struct vfs_handle_struct *handle);
234 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, const char *path, BOOL small_query, SMB_BIG_UINT *bsize,
235 SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
236 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
237 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
238 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, BOOL labels);
239 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
241 /* Directory operations */
243 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
244 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
245 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
246 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
247 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
248 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
249 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
250 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
252 /* File operations */
254 int (*open)(struct vfs_handle_struct *handle, const char *fname, files_struct *fsp, int flags, mode_t mode);
255 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
256 ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
257 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
258 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
259 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
260 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
261 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);
262 int (*rename)(struct vfs_handle_struct *handle, const char *oldname, const char *newname);
263 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
264 int (*stat)(struct vfs_handle_struct *handle, const char *fname, SMB_STRUCT_STAT *sbuf);
265 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
266 int (*lstat)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
267 int (*unlink)(struct vfs_handle_struct *handle, const char *path);
268 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
269 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
270 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
271 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
272 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
273 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
274 int (*ntimes)(struct vfs_handle_struct *handle, const char *path, const struct timespec ts[2]);
275 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
276 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);
277 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 share_mode);
278 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, int leasetype);
279 BOOL (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
280 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
281 int (*readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
282 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
283 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
284 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
285 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
286 struct sys_notify_context *ctx,
287 struct notify_entry *e,
288 void (*callback)(struct sys_notify_context *ctx,
290 struct notify_event *ev),
291 void *private_data, void *handle_p);
293 /* NT ACL operations. */
295 size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info, struct security_descriptor **ppdesc);
296 size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info, struct security_descriptor **ppdesc);
297 BOOL (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor *psd);
298 BOOL (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor *psd);
300 /* POSIX ACL operations. */
302 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
303 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
305 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
306 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
307 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
308 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
309 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
310 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
311 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
312 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
313 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
314 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
315 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
316 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
317 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
318 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
319 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
320 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
321 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
322 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
323 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
324 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
325 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
326 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
329 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
330 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
331 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
332 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
333 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
334 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
335 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
336 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
337 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
338 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
339 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
340 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
343 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
344 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
345 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
346 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_AIOCB *aiocb);
347 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
348 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
349 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
353 struct vfs_handles_pointers {
354 /* Disk operations */
356 struct vfs_handle_struct *connect_hnd;
357 struct vfs_handle_struct *disconnect;
358 struct vfs_handle_struct *disk_free;
359 struct vfs_handle_struct *get_quota;
360 struct vfs_handle_struct *set_quota;
361 struct vfs_handle_struct *get_shadow_copy_data;
362 struct vfs_handle_struct *statvfs;
364 /* Directory operations */
366 struct vfs_handle_struct *opendir;
367 struct vfs_handle_struct *readdir;
368 struct vfs_handle_struct *seekdir;
369 struct vfs_handle_struct *telldir;
370 struct vfs_handle_struct *rewind_dir;
371 struct vfs_handle_struct *mkdir;
372 struct vfs_handle_struct *rmdir;
373 struct vfs_handle_struct *closedir;
375 /* File operations */
377 struct vfs_handle_struct *open;
378 struct vfs_handle_struct *close_hnd;
379 struct vfs_handle_struct *read;
380 struct vfs_handle_struct *pread;
381 struct vfs_handle_struct *write;
382 struct vfs_handle_struct *pwrite;
383 struct vfs_handle_struct *lseek;
384 struct vfs_handle_struct *sendfile;
385 struct vfs_handle_struct *rename;
386 struct vfs_handle_struct *fsync;
387 struct vfs_handle_struct *stat;
388 struct vfs_handle_struct *fstat;
389 struct vfs_handle_struct *lstat;
390 struct vfs_handle_struct *unlink;
391 struct vfs_handle_struct *chmod;
392 struct vfs_handle_struct *fchmod;
393 struct vfs_handle_struct *chown;
394 struct vfs_handle_struct *fchown;
395 struct vfs_handle_struct *chdir;
396 struct vfs_handle_struct *getwd;
397 struct vfs_handle_struct *ntimes;
398 struct vfs_handle_struct *ftruncate;
399 struct vfs_handle_struct *lock;
400 struct vfs_handle_struct *kernel_flock;
401 struct vfs_handle_struct *linux_setlease;
402 struct vfs_handle_struct *getlock;
403 struct vfs_handle_struct *symlink;
404 struct vfs_handle_struct *readlink;
405 struct vfs_handle_struct *link;
406 struct vfs_handle_struct *mknod;
407 struct vfs_handle_struct *realpath;
408 struct vfs_handle_struct *notify_watch;
410 /* NT ACL operations. */
412 struct vfs_handle_struct *fget_nt_acl;
413 struct vfs_handle_struct *get_nt_acl;
414 struct vfs_handle_struct *fset_nt_acl;
415 struct vfs_handle_struct *set_nt_acl;
417 /* POSIX ACL operations. */
419 struct vfs_handle_struct *chmod_acl;
420 struct vfs_handle_struct *fchmod_acl;
422 struct vfs_handle_struct *sys_acl_get_entry;
423 struct vfs_handle_struct *sys_acl_get_tag_type;
424 struct vfs_handle_struct *sys_acl_get_permset;
425 struct vfs_handle_struct *sys_acl_get_qualifier;
426 struct vfs_handle_struct *sys_acl_get_file;
427 struct vfs_handle_struct *sys_acl_get_fd;
428 struct vfs_handle_struct *sys_acl_clear_perms;
429 struct vfs_handle_struct *sys_acl_add_perm;
430 struct vfs_handle_struct *sys_acl_to_text;
431 struct vfs_handle_struct *sys_acl_init;
432 struct vfs_handle_struct *sys_acl_create_entry;
433 struct vfs_handle_struct *sys_acl_set_tag_type;
434 struct vfs_handle_struct *sys_acl_set_qualifier;
435 struct vfs_handle_struct *sys_acl_set_permset;
436 struct vfs_handle_struct *sys_acl_valid;
437 struct vfs_handle_struct *sys_acl_set_file;
438 struct vfs_handle_struct *sys_acl_set_fd;
439 struct vfs_handle_struct *sys_acl_delete_def_file;
440 struct vfs_handle_struct *sys_acl_get_perm;
441 struct vfs_handle_struct *sys_acl_free_text;
442 struct vfs_handle_struct *sys_acl_free_acl;
443 struct vfs_handle_struct *sys_acl_free_qualifier;
446 struct vfs_handle_struct *getxattr;
447 struct vfs_handle_struct *lgetxattr;
448 struct vfs_handle_struct *fgetxattr;
449 struct vfs_handle_struct *listxattr;
450 struct vfs_handle_struct *llistxattr;
451 struct vfs_handle_struct *flistxattr;
452 struct vfs_handle_struct *removexattr;
453 struct vfs_handle_struct *lremovexattr;
454 struct vfs_handle_struct *fremovexattr;
455 struct vfs_handle_struct *setxattr;
456 struct vfs_handle_struct *lsetxattr;
457 struct vfs_handle_struct *fsetxattr;
460 struct vfs_handle_struct *aio_read;
461 struct vfs_handle_struct *aio_write;
462 struct vfs_handle_struct *aio_return;
463 struct vfs_handle_struct *aio_cancel;
464 struct vfs_handle_struct *aio_error;
465 struct vfs_handle_struct *aio_fsync;
466 struct vfs_handle_struct *aio_suspend;
471 Possible VFS operation layers (per-operation)
473 These values are used by VFS subsystem when building vfs_ops for connection
474 from multiple VFS modules. Internally, Samba differentiates only opaque and
475 transparent layers at this process. Other types are used for providing better
476 diagnosing facilities.
478 Most modules will provide transparent layers. Opaque layer is for modules
479 which implement actual file system calls (like DB-based VFS). For example,
480 default POSIX VFS which is built in into Samba is an opaque VFS module.
482 Other layer types (audit, splitter, scanner) were designed to provide different
483 degree of transparency and for diagnosing VFS module behaviour.
485 Each module can implement several layers at the same time provided that only
486 one layer is used per each operation.
490 typedef enum _vfs_op_layer {
491 SMB_VFS_LAYER_NOOP = -1, /* - For using in VFS module to indicate end of array */
492 /* of operations description */
493 SMB_VFS_LAYER_OPAQUE = 0, /* - Final level, does not call anything beyond itself */
494 SMB_VFS_LAYER_TRANSPARENT, /* - Normal operation, calls underlying layer after */
495 /* possibly changing passed data */
496 SMB_VFS_LAYER_LOGGER, /* - Logs data, calls underlying layer, logging may not */
498 SMB_VFS_LAYER_SPLITTER, /* - Splits operation, calls underlying layer _and_ own facility, */
499 /* then combines result */
500 SMB_VFS_LAYER_SCANNER /* - Checks data and possibly initiates additional */
501 /* file activity like logging to files _inside_ samba VFS */
505 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
506 which describes all operations this module is willing to intercept.
507 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
508 using this information.
511 typedef struct vfs_op_tuple {
518 typedef struct vfs_handle_struct {
519 struct vfs_handle_struct *next, *prev;
521 struct vfs_ops vfs_next;
522 struct connection_struct *conn;
524 void (*free_data)(void **data);
528 typedef struct vfs_statvfs_struct {
529 /* For undefined recommended transfer size return -1 in that field */
530 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
534 The next three fields are in terms of the block size.
535 (above). If block size is unknown, 4096 would be a
536 reasonable block size for a server to report.
537 Note that returning the blocks/blocksavail removes need
538 to make a second call (to QFSInfo level 0x103 to get this info.
539 UserBlockAvail is typically less than or equal to BlocksAvail,
540 if no distinction is made return the same value in each.
543 SMB_BIG_UINT TotalBlocks;
544 SMB_BIG_UINT BlocksAvail; /* bfree */
545 SMB_BIG_UINT UserBlocksAvail; /* bavail */
547 /* For undefined Node fields or FSID return -1 */
548 SMB_BIG_UINT TotalFileNodes;
549 SMB_BIG_UINT FreeFileNodes;
550 SMB_BIG_UINT FsIdentifier; /* fsid */
551 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
552 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
553 } vfs_statvfs_struct;
555 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type) \
556 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type))
558 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
559 vfs_fetch_fsp_extension(handle, (fsp))
561 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
562 vfs_remove_fsp_extension((handle), (fsp))
564 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
565 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
566 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
571 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
573 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
576 if ((handle)->free_data) { \
577 (handle)->free_data(&(handle)->data); \
579 (handle)->data = (void *)datap; \
580 (handle)->free_data = free_fn; \
584 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
585 if ((handle) && (handle)->free_data) { \
586 (handle)->free_data(&(handle)->data); \
590 /* Check whether module-specific data handle was already allocated or not */
591 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
593 #define SMB_VFS_OP(x) ((void *) x)
595 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
597 #include "vfs_macros.h"