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 #define SMB_VFS_INTERFACE_VERSION 22
81 /* to bug old modules which are trying to compile with the old functions */
82 #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 };
83 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
84 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
85 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
86 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
89 All intercepted VFS operations must be declared as static functions inside module source
90 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
91 example VFS modules for more details.
94 /* VFS operations structure */
96 struct vfs_handle_struct;
97 struct connection_struct;
99 struct security_descriptor;
100 struct vfs_statvfs_struct;
103 Available VFS operations. These values must be in sync with vfs_ops struct
104 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
105 In particular, if new operations are added to vfs_ops, appropriate constants
106 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
109 typedef enum _vfs_op_type {
110 SMB_VFS_OP_NOOP = -1,
112 /* Disk operations */
114 SMB_VFS_OP_CONNECT = 0,
115 SMB_VFS_OP_DISCONNECT,
116 SMB_VFS_OP_DISK_FREE,
117 SMB_VFS_OP_GET_QUOTA,
118 SMB_VFS_OP_SET_QUOTA,
119 SMB_VFS_OP_GET_SHADOW_COPY_DATA,
122 /* Directory operations */
128 SMB_VFS_OP_REWINDDIR,
133 /* File operations */
158 SMB_VFS_OP_FTRUNCATE,
160 SMB_VFS_OP_KERNEL_FLOCK,
161 SMB_VFS_OP_LINUX_SETLEASE,
168 SMB_VFS_OP_NOTIFY_WATCH,
170 SMB_VFS_OP_FILE_ID_CREATE,
172 /* NT ACL operations. */
174 SMB_VFS_OP_FGET_NT_ACL,
175 SMB_VFS_OP_GET_NT_ACL,
176 SMB_VFS_OP_FSET_NT_ACL,
177 SMB_VFS_OP_SET_NT_ACL,
179 /* POSIX ACL operations. */
181 SMB_VFS_OP_CHMOD_ACL,
182 SMB_VFS_OP_FCHMOD_ACL,
184 SMB_VFS_OP_SYS_ACL_GET_ENTRY,
185 SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
186 SMB_VFS_OP_SYS_ACL_GET_PERMSET,
187 SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
188 SMB_VFS_OP_SYS_ACL_GET_FILE,
189 SMB_VFS_OP_SYS_ACL_GET_FD,
190 SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
191 SMB_VFS_OP_SYS_ACL_ADD_PERM,
192 SMB_VFS_OP_SYS_ACL_TO_TEXT,
193 SMB_VFS_OP_SYS_ACL_INIT,
194 SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
195 SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
196 SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
197 SMB_VFS_OP_SYS_ACL_SET_PERMSET,
198 SMB_VFS_OP_SYS_ACL_VALID,
199 SMB_VFS_OP_SYS_ACL_SET_FILE,
200 SMB_VFS_OP_SYS_ACL_SET_FD,
201 SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
202 SMB_VFS_OP_SYS_ACL_GET_PERM,
203 SMB_VFS_OP_SYS_ACL_FREE_TEXT,
204 SMB_VFS_OP_SYS_ACL_FREE_ACL,
205 SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
209 SMB_VFS_OP_LGETXATTR,
210 SMB_VFS_OP_FGETXATTR,
211 SMB_VFS_OP_LISTXATTR,
212 SMB_VFS_OP_LLISTXATTR,
213 SMB_VFS_OP_FLISTXATTR,
214 SMB_VFS_OP_REMOVEXATTR,
215 SMB_VFS_OP_LREMOVEXATTR,
216 SMB_VFS_OP_FREMOVEXATTR,
218 SMB_VFS_OP_LSETXATTR,
219 SMB_VFS_OP_FSETXATTR,
223 SMB_VFS_OP_AIO_WRITE,
224 SMB_VFS_OP_AIO_RETURN,
225 SMB_VFS_OP_AIO_CANCEL,
226 SMB_VFS_OP_AIO_ERROR,
227 SMB_VFS_OP_AIO_FSYNC,
228 SMB_VFS_OP_AIO_SUSPEND,
230 /* This should always be last enum value */
236 Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
239 struct vfs_fn_pointers {
240 /* Disk operations */
242 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
243 void (*disconnect)(struct vfs_handle_struct *handle);
244 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, SMB_BIG_UINT *bsize,
245 SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
246 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
247 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
248 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
249 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
251 /* Directory operations */
253 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
254 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
255 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
256 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
257 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
258 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
259 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
260 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
262 /* File operations */
264 int (*open)(struct vfs_handle_struct *handle, const char *fname, files_struct *fsp, int flags, mode_t mode);
265 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
266 ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
267 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
268 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
269 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
270 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
271 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);
272 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *fsp, int tofd, SMB_OFF_T offset, size_t count);
273 int (*rename)(struct vfs_handle_struct *handle, const char *oldname, const char *newname);
274 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
275 int (*stat)(struct vfs_handle_struct *handle, const char *fname, SMB_STRUCT_STAT *sbuf);
276 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
277 int (*lstat)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
278 int (*unlink)(struct vfs_handle_struct *handle, const char *path);
279 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
280 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
281 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
282 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
283 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
284 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
285 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
286 int (*ntimes)(struct vfs_handle_struct *handle, const char *path, const struct timespec ts[2]);
287 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
288 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);
289 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 share_mode);
290 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, int leasetype);
291 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);
292 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
293 int (*readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
294 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
295 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
296 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
297 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
298 struct sys_notify_context *ctx,
299 struct notify_entry *e,
300 void (*callback)(struct sys_notify_context *ctx,
302 struct notify_event *ev),
303 void *private_data, void *handle_p);
304 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
305 struct file_id (*file_id_create)(struct vfs_handle_struct *handle, SMB_DEV_T dev, SMB_INO_T inode);
307 /* NT ACL operations. */
309 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
310 struct files_struct *fsp, int fd,
311 uint32 security_info,
312 struct security_descriptor **ppdesc);
313 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
314 struct files_struct *fsp,
316 uint32 security_info,
317 struct security_descriptor **ppdesc);
318 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor *psd);
319 NTSTATUS (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor *psd);
321 /* POSIX ACL operations. */
323 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
324 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
326 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
327 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
328 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
329 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
330 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
331 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
332 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
333 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
334 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
335 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
336 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
337 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
338 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
339 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
340 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
341 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
342 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
343 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
344 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
345 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
346 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
347 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
350 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
351 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
352 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
353 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
354 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
355 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
356 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
357 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
358 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
359 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
360 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
361 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
364 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
365 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
366 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
367 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_AIOCB *aiocb);
368 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
369 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
370 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
374 struct vfs_handles_pointers {
375 /* Disk operations */
377 struct vfs_handle_struct *connect_hnd;
378 struct vfs_handle_struct *disconnect;
379 struct vfs_handle_struct *disk_free;
380 struct vfs_handle_struct *get_quota;
381 struct vfs_handle_struct *set_quota;
382 struct vfs_handle_struct *get_shadow_copy_data;
383 struct vfs_handle_struct *statvfs;
385 /* Directory operations */
387 struct vfs_handle_struct *opendir;
388 struct vfs_handle_struct *readdir;
389 struct vfs_handle_struct *seekdir;
390 struct vfs_handle_struct *telldir;
391 struct vfs_handle_struct *rewind_dir;
392 struct vfs_handle_struct *mkdir;
393 struct vfs_handle_struct *rmdir;
394 struct vfs_handle_struct *closedir;
396 /* File operations */
398 struct vfs_handle_struct *open;
399 struct vfs_handle_struct *close_hnd;
400 struct vfs_handle_struct *read;
401 struct vfs_handle_struct *pread;
402 struct vfs_handle_struct *write;
403 struct vfs_handle_struct *pwrite;
404 struct vfs_handle_struct *lseek;
405 struct vfs_handle_struct *sendfile;
406 struct vfs_handle_struct *recvfile;
407 struct vfs_handle_struct *rename;
408 struct vfs_handle_struct *fsync;
409 struct vfs_handle_struct *stat;
410 struct vfs_handle_struct *fstat;
411 struct vfs_handle_struct *lstat;
412 struct vfs_handle_struct *unlink;
413 struct vfs_handle_struct *chmod;
414 struct vfs_handle_struct *fchmod;
415 struct vfs_handle_struct *chown;
416 struct vfs_handle_struct *fchown;
417 struct vfs_handle_struct *lchown;
418 struct vfs_handle_struct *chdir;
419 struct vfs_handle_struct *getwd;
420 struct vfs_handle_struct *ntimes;
421 struct vfs_handle_struct *ftruncate;
422 struct vfs_handle_struct *lock;
423 struct vfs_handle_struct *kernel_flock;
424 struct vfs_handle_struct *linux_setlease;
425 struct vfs_handle_struct *getlock;
426 struct vfs_handle_struct *symlink;
427 struct vfs_handle_struct *readlink;
428 struct vfs_handle_struct *link;
429 struct vfs_handle_struct *mknod;
430 struct vfs_handle_struct *realpath;
431 struct vfs_handle_struct *notify_watch;
432 struct vfs_handle_struct *chflags;
433 struct vfs_handle_struct *file_id_create;
435 /* NT ACL operations. */
437 struct vfs_handle_struct *fget_nt_acl;
438 struct vfs_handle_struct *get_nt_acl;
439 struct vfs_handle_struct *fset_nt_acl;
440 struct vfs_handle_struct *set_nt_acl;
442 /* POSIX ACL operations. */
444 struct vfs_handle_struct *chmod_acl;
445 struct vfs_handle_struct *fchmod_acl;
447 struct vfs_handle_struct *sys_acl_get_entry;
448 struct vfs_handle_struct *sys_acl_get_tag_type;
449 struct vfs_handle_struct *sys_acl_get_permset;
450 struct vfs_handle_struct *sys_acl_get_qualifier;
451 struct vfs_handle_struct *sys_acl_get_file;
452 struct vfs_handle_struct *sys_acl_get_fd;
453 struct vfs_handle_struct *sys_acl_clear_perms;
454 struct vfs_handle_struct *sys_acl_add_perm;
455 struct vfs_handle_struct *sys_acl_to_text;
456 struct vfs_handle_struct *sys_acl_init;
457 struct vfs_handle_struct *sys_acl_create_entry;
458 struct vfs_handle_struct *sys_acl_set_tag_type;
459 struct vfs_handle_struct *sys_acl_set_qualifier;
460 struct vfs_handle_struct *sys_acl_set_permset;
461 struct vfs_handle_struct *sys_acl_valid;
462 struct vfs_handle_struct *sys_acl_set_file;
463 struct vfs_handle_struct *sys_acl_set_fd;
464 struct vfs_handle_struct *sys_acl_delete_def_file;
465 struct vfs_handle_struct *sys_acl_get_perm;
466 struct vfs_handle_struct *sys_acl_free_text;
467 struct vfs_handle_struct *sys_acl_free_acl;
468 struct vfs_handle_struct *sys_acl_free_qualifier;
471 struct vfs_handle_struct *getxattr;
472 struct vfs_handle_struct *lgetxattr;
473 struct vfs_handle_struct *fgetxattr;
474 struct vfs_handle_struct *listxattr;
475 struct vfs_handle_struct *llistxattr;
476 struct vfs_handle_struct *flistxattr;
477 struct vfs_handle_struct *removexattr;
478 struct vfs_handle_struct *lremovexattr;
479 struct vfs_handle_struct *fremovexattr;
480 struct vfs_handle_struct *setxattr;
481 struct vfs_handle_struct *lsetxattr;
482 struct vfs_handle_struct *fsetxattr;
485 struct vfs_handle_struct *aio_read;
486 struct vfs_handle_struct *aio_write;
487 struct vfs_handle_struct *aio_return;
488 struct vfs_handle_struct *aio_cancel;
489 struct vfs_handle_struct *aio_error;
490 struct vfs_handle_struct *aio_fsync;
491 struct vfs_handle_struct *aio_suspend;
496 Possible VFS operation layers (per-operation)
498 These values are used by VFS subsystem when building vfs_ops for connection
499 from multiple VFS modules. Internally, Samba differentiates only opaque and
500 transparent layers at this process. Other types are used for providing better
501 diagnosing facilities.
503 Most modules will provide transparent layers. Opaque layer is for modules
504 which implement actual file system calls (like DB-based VFS). For example,
505 default POSIX VFS which is built in into Samba is an opaque VFS module.
507 Other layer types (audit, splitter, scanner) were designed to provide different
508 degree of transparency and for diagnosing VFS module behaviour.
510 Each module can implement several layers at the same time provided that only
511 one layer is used per each operation.
515 typedef enum _vfs_op_layer {
516 SMB_VFS_LAYER_NOOP = -1, /* - For using in VFS module to indicate end of array */
517 /* of operations description */
518 SMB_VFS_LAYER_OPAQUE = 0, /* - Final level, does not call anything beyond itself */
519 SMB_VFS_LAYER_TRANSPARENT, /* - Normal operation, calls underlying layer after */
520 /* possibly changing passed data */
521 SMB_VFS_LAYER_LOGGER, /* - Logs data, calls underlying layer, logging may not */
523 SMB_VFS_LAYER_SPLITTER, /* - Splits operation, calls underlying layer _and_ own facility, */
524 /* then combines result */
525 SMB_VFS_LAYER_SCANNER /* - Checks data and possibly initiates additional */
526 /* file activity like logging to files _inside_ samba VFS */
530 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
531 which describes all operations this module is willing to intercept.
532 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
533 using this information.
536 typedef struct vfs_op_tuple {
543 typedef struct vfs_handle_struct {
544 struct vfs_handle_struct *next, *prev;
546 struct vfs_ops vfs_next;
547 struct connection_struct *conn;
549 void (*free_data)(void **data);
553 typedef struct vfs_statvfs_struct {
554 /* For undefined recommended transfer size return -1 in that field */
555 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
559 The next three fields are in terms of the block size.
560 (above). If block size is unknown, 4096 would be a
561 reasonable block size for a server to report.
562 Note that returning the blocks/blocksavail removes need
563 to make a second call (to QFSInfo level 0x103 to get this info.
564 UserBlockAvail is typically less than or equal to BlocksAvail,
565 if no distinction is made return the same value in each.
568 SMB_BIG_UINT TotalBlocks;
569 SMB_BIG_UINT BlocksAvail; /* bfree */
570 SMB_BIG_UINT UserBlocksAvail; /* bavail */
572 /* For undefined Node fields or FSID return -1 */
573 SMB_BIG_UINT TotalFileNodes;
574 SMB_BIG_UINT FreeFileNodes;
575 SMB_BIG_UINT FsIdentifier; /* fsid */
576 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
577 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
578 } vfs_statvfs_struct;
580 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type) \
581 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type))
583 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
584 vfs_fetch_fsp_extension(handle, (fsp))
586 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
587 vfs_remove_fsp_extension((handle), (fsp))
589 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
590 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
591 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
596 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
598 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
601 if ((handle)->free_data) { \
602 (handle)->free_data(&(handle)->data); \
604 (handle)->data = (void *)datap; \
605 (handle)->free_data = free_fn; \
609 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
610 if ((handle) && (handle)->free_data) { \
611 (handle)->free_data(&(handle)->data); \
615 /* Check whether module-specific data handle was already allocated or not */
616 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
618 #define SMB_VFS_OP(x) ((void *) x)
620 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
622 #include "vfs_macros.h"