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