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 3 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, see <http://www.gnu.org/licenses/>.
22 This work was sponsored by Optifacio Software Services, Inc.
28 /* Avoid conflict with an AIX include file */
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...
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
44 * If you change anything here, please also update modules/vfs_full_audit.c.
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
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. */
116 #define SMB_VFS_INTERFACE_VERSION 25
119 /* to bug old modules which are trying to compile with the old functions */
120 #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 };
121 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
122 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
123 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
124 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
127 All intercepted VFS operations must be declared as static functions inside module source
128 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
129 example VFS modules for more details.
132 /* VFS operations structure */
134 struct vfs_handle_struct;
135 struct connection_struct;
137 struct security_descriptor;
138 struct vfs_statvfs_struct;
141 struct smb_file_time;
144 Available VFS operations. These values must be in sync with vfs_ops struct
145 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
146 In particular, if new operations are added to vfs_ops, appropriate constants
147 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
150 typedef enum _vfs_op_type {
151 SMB_VFS_OP_NOOP = -1,
153 /* Disk operations */
155 SMB_VFS_OP_CONNECT = 0,
156 SMB_VFS_OP_DISCONNECT,
157 SMB_VFS_OP_DISK_FREE,
158 SMB_VFS_OP_GET_QUOTA,
159 SMB_VFS_OP_SET_QUOTA,
160 SMB_VFS_OP_GET_SHADOW_COPY_DATA,
162 SMB_VFS_OP_FS_CAPABILITIES,
164 /* Directory operations */
170 SMB_VFS_OP_REWINDDIR,
175 /* File operations */
178 SMB_VFS_OP_CREATE_FILE,
201 SMB_VFS_OP_FTRUNCATE,
203 SMB_VFS_OP_KERNEL_FLOCK,
204 SMB_VFS_OP_LINUX_SETLEASE,
211 SMB_VFS_OP_NOTIFY_WATCH,
213 SMB_VFS_OP_FILE_ID_CREATE,
214 SMB_VFS_OP_STREAMINFO,
215 SMB_VFS_OP_GET_REAL_FILENAME,
217 /* NT ACL operations. */
219 SMB_VFS_OP_FGET_NT_ACL,
220 SMB_VFS_OP_GET_NT_ACL,
221 SMB_VFS_OP_FSET_NT_ACL,
223 /* POSIX ACL operations. */
225 SMB_VFS_OP_CHMOD_ACL,
226 SMB_VFS_OP_FCHMOD_ACL,
228 SMB_VFS_OP_SYS_ACL_GET_ENTRY,
229 SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
230 SMB_VFS_OP_SYS_ACL_GET_PERMSET,
231 SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
232 SMB_VFS_OP_SYS_ACL_GET_FILE,
233 SMB_VFS_OP_SYS_ACL_GET_FD,
234 SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
235 SMB_VFS_OP_SYS_ACL_ADD_PERM,
236 SMB_VFS_OP_SYS_ACL_TO_TEXT,
237 SMB_VFS_OP_SYS_ACL_INIT,
238 SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
239 SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
240 SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
241 SMB_VFS_OP_SYS_ACL_SET_PERMSET,
242 SMB_VFS_OP_SYS_ACL_VALID,
243 SMB_VFS_OP_SYS_ACL_SET_FILE,
244 SMB_VFS_OP_SYS_ACL_SET_FD,
245 SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
246 SMB_VFS_OP_SYS_ACL_GET_PERM,
247 SMB_VFS_OP_SYS_ACL_FREE_TEXT,
248 SMB_VFS_OP_SYS_ACL_FREE_ACL,
249 SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
253 SMB_VFS_OP_LGETXATTR,
254 SMB_VFS_OP_FGETXATTR,
255 SMB_VFS_OP_LISTXATTR,
256 SMB_VFS_OP_LLISTXATTR,
257 SMB_VFS_OP_FLISTXATTR,
258 SMB_VFS_OP_REMOVEXATTR,
259 SMB_VFS_OP_LREMOVEXATTR,
260 SMB_VFS_OP_FREMOVEXATTR,
262 SMB_VFS_OP_LSETXATTR,
263 SMB_VFS_OP_FSETXATTR,
267 SMB_VFS_OP_AIO_WRITE,
268 SMB_VFS_OP_AIO_RETURN,
269 SMB_VFS_OP_AIO_CANCEL,
270 SMB_VFS_OP_AIO_ERROR,
271 SMB_VFS_OP_AIO_FSYNC,
272 SMB_VFS_OP_AIO_SUSPEND,
273 SMB_VFS_OP_AIO_FORCE,
275 /* offline operations */
276 SMB_VFS_OP_IS_OFFLINE,
277 SMB_VFS_OP_SET_OFFLINE,
279 /* This should always be last enum value */
285 Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
288 struct vfs_fn_pointers {
289 /* Disk operations */
291 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
292 void (*disconnect)(struct vfs_handle_struct *handle);
293 uint64_t (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
294 uint64_t *dfree, uint64_t *dsize);
295 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
296 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
297 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
298 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
299 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle);
301 /* Directory operations */
303 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
304 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
305 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
306 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
307 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
308 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
309 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
310 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
312 /* File operations */
314 int (*open)(struct vfs_handle_struct *handle, const char *fname, files_struct *fsp, int flags, mode_t mode);
315 NTSTATUS (*create_file)(struct vfs_handle_struct *handle,
316 struct smb_request *req,
317 uint16_t root_dir_fid,
319 uint32_t create_file_flags,
320 uint32_t access_mask,
321 uint32_t share_access,
322 uint32_t create_disposition,
323 uint32_t create_options,
324 uint32_t file_attributes,
325 uint32_t oplock_request,
326 uint64_t allocation_size,
327 struct security_descriptor *sd,
328 struct ea_list *ea_list,
329 files_struct **result,
331 SMB_STRUCT_STAT *psbuf);
332 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
333 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
334 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
335 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
336 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
337 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
338 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
339 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
340 int (*rename)(struct vfs_handle_struct *handle, const char *oldname, const char *newname);
341 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
342 int (*stat)(struct vfs_handle_struct *handle, const char *fname, SMB_STRUCT_STAT *sbuf);
343 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
344 int (*lstat)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
345 int (*unlink)(struct vfs_handle_struct *handle, const char *path);
346 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
347 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
348 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
349 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
350 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
351 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
352 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
353 int (*ntimes)(struct vfs_handle_struct *handle, const char *path, struct smb_file_time *ft);
354 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
355 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
356 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, uint32 share_mode);
357 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
358 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
359 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
360 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
361 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
362 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
363 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
364 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
365 struct sys_notify_context *ctx,
366 struct notify_entry *e,
367 void (*callback)(struct sys_notify_context *ctx,
369 struct notify_event *ev),
370 void *private_data, void *handle_p);
371 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
372 struct file_id (*file_id_create)(struct vfs_handle_struct *handle, SMB_DEV_T dev, SMB_INO_T inode);
374 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
375 struct files_struct *fsp,
378 unsigned int *num_streams,
379 struct stream_struct **streams);
381 int (*get_real_filename)(struct vfs_handle_struct *handle,
387 /* NT ACL operations. */
389 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
390 struct files_struct *fsp,
391 uint32 security_info,
392 struct security_descriptor **ppdesc);
393 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
395 uint32 security_info,
396 struct security_descriptor **ppdesc);
397 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
398 struct files_struct *fsp,
399 uint32 security_info_sent,
400 const struct security_descriptor *psd);
402 /* POSIX ACL operations. */
404 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
405 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
407 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
408 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
409 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
410 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
411 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
412 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
413 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
414 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
415 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
416 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
417 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
418 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
419 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
420 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
421 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
422 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
423 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
424 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
425 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
426 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
427 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
428 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
431 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
432 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
433 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
434 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
435 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
436 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
437 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
438 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
439 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
440 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
441 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
442 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
445 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
446 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
447 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
448 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
449 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
450 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
451 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
452 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
454 /* offline operations */
455 bool (*is_offline)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
456 int (*set_offline)(struct vfs_handle_struct *handle, const char *path);
459 struct vfs_handles_pointers {
460 /* Disk operations */
462 struct vfs_handle_struct *connect_hnd;
463 struct vfs_handle_struct *disconnect;
464 struct vfs_handle_struct *disk_free;
465 struct vfs_handle_struct *get_quota;
466 struct vfs_handle_struct *set_quota;
467 struct vfs_handle_struct *get_shadow_copy_data;
468 struct vfs_handle_struct *statvfs;
469 struct vfs_handle_struct *fs_capabilities;
471 /* Directory operations */
473 struct vfs_handle_struct *opendir;
474 struct vfs_handle_struct *readdir;
475 struct vfs_handle_struct *seekdir;
476 struct vfs_handle_struct *telldir;
477 struct vfs_handle_struct *rewind_dir;
478 struct vfs_handle_struct *mkdir;
479 struct vfs_handle_struct *rmdir;
480 struct vfs_handle_struct *closedir;
482 /* File operations */
484 struct vfs_handle_struct *open;
485 struct vfs_handle_struct *create_file;
486 struct vfs_handle_struct *close_hnd;
487 struct vfs_handle_struct *vfs_read;
488 struct vfs_handle_struct *pread;
489 struct vfs_handle_struct *write;
490 struct vfs_handle_struct *pwrite;
491 struct vfs_handle_struct *lseek;
492 struct vfs_handle_struct *sendfile;
493 struct vfs_handle_struct *recvfile;
494 struct vfs_handle_struct *rename;
495 struct vfs_handle_struct *fsync;
496 struct vfs_handle_struct *stat;
497 struct vfs_handle_struct *fstat;
498 struct vfs_handle_struct *lstat;
499 struct vfs_handle_struct *unlink;
500 struct vfs_handle_struct *chmod;
501 struct vfs_handle_struct *fchmod;
502 struct vfs_handle_struct *chown;
503 struct vfs_handle_struct *fchown;
504 struct vfs_handle_struct *lchown;
505 struct vfs_handle_struct *chdir;
506 struct vfs_handle_struct *getwd;
507 struct vfs_handle_struct *ntimes;
508 struct vfs_handle_struct *ftruncate;
509 struct vfs_handle_struct *lock;
510 struct vfs_handle_struct *kernel_flock;
511 struct vfs_handle_struct *linux_setlease;
512 struct vfs_handle_struct *getlock;
513 struct vfs_handle_struct *symlink;
514 struct vfs_handle_struct *vfs_readlink;
515 struct vfs_handle_struct *link;
516 struct vfs_handle_struct *mknod;
517 struct vfs_handle_struct *realpath;
518 struct vfs_handle_struct *notify_watch;
519 struct vfs_handle_struct *chflags;
520 struct vfs_handle_struct *file_id_create;
521 struct vfs_handle_struct *streaminfo;
522 struct vfs_handle_struct *get_real_filename;
524 /* NT ACL operations. */
526 struct vfs_handle_struct *fget_nt_acl;
527 struct vfs_handle_struct *get_nt_acl;
528 struct vfs_handle_struct *fset_nt_acl;
530 /* POSIX ACL operations. */
532 struct vfs_handle_struct *chmod_acl;
533 struct vfs_handle_struct *fchmod_acl;
535 struct vfs_handle_struct *sys_acl_get_entry;
536 struct vfs_handle_struct *sys_acl_get_tag_type;
537 struct vfs_handle_struct *sys_acl_get_permset;
538 struct vfs_handle_struct *sys_acl_get_qualifier;
539 struct vfs_handle_struct *sys_acl_get_file;
540 struct vfs_handle_struct *sys_acl_get_fd;
541 struct vfs_handle_struct *sys_acl_clear_perms;
542 struct vfs_handle_struct *sys_acl_add_perm;
543 struct vfs_handle_struct *sys_acl_to_text;
544 struct vfs_handle_struct *sys_acl_init;
545 struct vfs_handle_struct *sys_acl_create_entry;
546 struct vfs_handle_struct *sys_acl_set_tag_type;
547 struct vfs_handle_struct *sys_acl_set_qualifier;
548 struct vfs_handle_struct *sys_acl_set_permset;
549 struct vfs_handle_struct *sys_acl_valid;
550 struct vfs_handle_struct *sys_acl_set_file;
551 struct vfs_handle_struct *sys_acl_set_fd;
552 struct vfs_handle_struct *sys_acl_delete_def_file;
553 struct vfs_handle_struct *sys_acl_get_perm;
554 struct vfs_handle_struct *sys_acl_free_text;
555 struct vfs_handle_struct *sys_acl_free_acl;
556 struct vfs_handle_struct *sys_acl_free_qualifier;
559 struct vfs_handle_struct *getxattr;
560 struct vfs_handle_struct *lgetxattr;
561 struct vfs_handle_struct *fgetxattr;
562 struct vfs_handle_struct *listxattr;
563 struct vfs_handle_struct *llistxattr;
564 struct vfs_handle_struct *flistxattr;
565 struct vfs_handle_struct *removexattr;
566 struct vfs_handle_struct *lremovexattr;
567 struct vfs_handle_struct *fremovexattr;
568 struct vfs_handle_struct *setxattr;
569 struct vfs_handle_struct *lsetxattr;
570 struct vfs_handle_struct *fsetxattr;
573 struct vfs_handle_struct *aio_read;
574 struct vfs_handle_struct *aio_write;
575 struct vfs_handle_struct *aio_return;
576 struct vfs_handle_struct *aio_cancel;
577 struct vfs_handle_struct *aio_error;
578 struct vfs_handle_struct *aio_fsync;
579 struct vfs_handle_struct *aio_suspend;
580 struct vfs_handle_struct *aio_force;
582 /* offline operations */
583 struct vfs_handle_struct *is_offline;
584 struct vfs_handle_struct *set_offline;
589 Possible VFS operation layers (per-operation)
591 These values are used by VFS subsystem when building vfs_ops for connection
592 from multiple VFS modules. Internally, Samba differentiates only opaque and
593 transparent layers at this process. Other types are used for providing better
594 diagnosing facilities.
596 Most modules will provide transparent layers. Opaque layer is for modules
597 which implement actual file system calls (like DB-based VFS). For example,
598 default POSIX VFS which is built in into Samba is an opaque VFS module.
600 Other layer types (audit, splitter, scanner) were designed to provide different
601 degree of transparency and for diagnosing VFS module behaviour.
603 Each module can implement several layers at the same time provided that only
604 one layer is used per each operation.
608 typedef enum _vfs_op_layer {
609 SMB_VFS_LAYER_NOOP = -1, /* - For using in VFS module to indicate end of array */
610 /* of operations description */
611 SMB_VFS_LAYER_OPAQUE = 0, /* - Final level, does not call anything beyond itself */
612 SMB_VFS_LAYER_TRANSPARENT, /* - Normal operation, calls underlying layer after */
613 /* possibly changing passed data */
614 SMB_VFS_LAYER_LOGGER, /* - Logs data, calls underlying layer, logging may not */
616 SMB_VFS_LAYER_SPLITTER, /* - Splits operation, calls underlying layer _and_ own facility, */
617 /* then combines result */
618 SMB_VFS_LAYER_SCANNER /* - Checks data and possibly initiates additional */
619 /* file activity like logging to files _inside_ samba VFS */
623 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
624 which describes all operations this module is willing to intercept.
625 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
626 using this information.
629 typedef struct vfs_op_tuple {
636 typedef struct vfs_handle_struct {
637 struct vfs_handle_struct *next, *prev;
639 struct vfs_ops vfs_next;
640 struct connection_struct *conn;
642 void (*free_data)(void **data);
646 typedef struct vfs_statvfs_struct {
647 /* For undefined recommended transfer size return -1 in that field */
648 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
652 The next three fields are in terms of the block size.
653 (above). If block size is unknown, 4096 would be a
654 reasonable block size for a server to report.
655 Note that returning the blocks/blocksavail removes need
656 to make a second call (to QFSInfo level 0x103 to get this info.
657 UserBlockAvail is typically less than or equal to BlocksAvail,
658 if no distinction is made return the same value in each.
661 uint64_t TotalBlocks;
662 uint64_t BlocksAvail; /* bfree */
663 uint64_t UserBlocksAvail; /* bavail */
665 /* For undefined Node fields or FSID return -1 */
666 uint64_t TotalFileNodes;
667 uint64_t FreeFileNodes;
668 uint64_t FsIdentifier; /* fsid */
669 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
670 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
673 } vfs_statvfs_struct;
675 /* Add a new FSP extension of the given type. Returns a pointer to the
678 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type) \
679 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type))
681 /* Return a pointer to the existing FSP extension data. */
682 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
683 vfs_fetch_fsp_extension(handle, (fsp))
685 /* Return the talloc context associated with an FSP extension. */
686 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
687 vfs_memctx_fsp_extension(handle, (fsp))
689 /* Remove and destroy an FSP extension. */
690 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
691 vfs_remove_fsp_extension((handle), (fsp))
693 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
694 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
695 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
700 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
702 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
705 if ((handle)->free_data) { \
706 (handle)->free_data(&(handle)->data); \
708 (handle)->data = (void *)datap; \
709 (handle)->free_data = free_fn; \
713 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
714 if ((handle) && (handle)->free_data) { \
715 (handle)->free_data(&(handle)->data); \
719 /* Check whether module-specific data handle was already allocated or not */
720 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
722 #define SMB_VFS_OP(x) ((void *) x)
724 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
726 #include "vfs_macros.h"