source/include/vfs.h

   1 /*
   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
   8
   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.
  13
  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.
  18
  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/>.
  21
  22    This work was sponsored by Optifacio Software Services, Inc.
  23 */
  24
  25 #ifndef _VFS_H
  26 #define _VFS_H
  27
  28 /* Avoid conflict with an AIX include file */
  29
  30 #ifdef vfs_ops
  31 #undef vfs_ops
  32 #endif
  33
  34 /*
  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...
  37  */
  38
  39 /*
  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
  42  * vfs_ops below. JRA.
  43  *
  44  * If you change anything here, please also update modules/vfs_full_audit.c.
  45  * VL.
  46  */
  47
  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 #define SMB_VFS_INTERFACE_VERSION 22
  77
  78
  79 /* to bug old modules which are trying to compile with the old functions */
  80 #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 };
  81 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
  82   __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
  83 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
  84   __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
  85
  86 /*
  87     All intercepted VFS operations must be declared as static functions inside module source
  88     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
  89     example VFS modules for more details.
  90 */
  91
  92 /* VFS operations structure */
  93
  94 struct vfs_handle_struct;
  95 struct connection_struct;
  96 struct files_struct;
  97 struct security_descriptor;
  98 struct vfs_statvfs_struct;
  99
 100 /*
 101     Available VFS operations. These values must be in sync with vfs_ops struct
 102     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
 103     In particular, if new operations are added to vfs_ops, appropriate constants
 104     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
 105 */
 106
 107 typedef enum _vfs_op_type {
 108         SMB_VFS_OP_NOOP = -1,
 109
 110         /* Disk operations */
 111
 112         SMB_VFS_OP_CONNECT = 0,
 113         SMB_VFS_OP_DISCONNECT,
 114         SMB_VFS_OP_DISK_FREE,
 115         SMB_VFS_OP_GET_QUOTA,
 116         SMB_VFS_OP_SET_QUOTA,
 117         SMB_VFS_OP_GET_SHADOW_COPY_DATA,
 118         SMB_VFS_OP_STATVFS,
 119
 120         /* Directory operations */
 121
 122         SMB_VFS_OP_OPENDIR,
 123         SMB_VFS_OP_READDIR,
 124         SMB_VFS_OP_SEEKDIR,
 125         SMB_VFS_OP_TELLDIR,
 126         SMB_VFS_OP_REWINDDIR,
 127         SMB_VFS_OP_MKDIR,
 128         SMB_VFS_OP_RMDIR,
 129         SMB_VFS_OP_CLOSEDIR,
 130
 131         /* File operations */
 132
 133         SMB_VFS_OP_OPEN,
 134         SMB_VFS_OP_CLOSE,
 135         SMB_VFS_OP_READ,
 136         SMB_VFS_OP_PREAD,
 137         SMB_VFS_OP_WRITE,
 138         SMB_VFS_OP_PWRITE,
 139         SMB_VFS_OP_LSEEK,
 140         SMB_VFS_OP_SENDFILE,
 141         SMB_VFS_OP_RENAME,
 142         SMB_VFS_OP_FSYNC,
 143         SMB_VFS_OP_STAT,
 144         SMB_VFS_OP_FSTAT,
 145         SMB_VFS_OP_LSTAT,
 146         SMB_VFS_OP_UNLINK,
 147         SMB_VFS_OP_CHMOD,
 148         SMB_VFS_OP_FCHMOD,
 149         SMB_VFS_OP_CHOWN,
 150         SMB_VFS_OP_FCHOWN,
 151         SMB_VFS_OP_LCHOWN,
 152         SMB_VFS_OP_CHDIR,
 153         SMB_VFS_OP_GETWD,
 154         SMB_VFS_OP_NTIMES,
 155         SMB_VFS_OP_FTRUNCATE,
 156         SMB_VFS_OP_LOCK,
 157         SMB_VFS_OP_KERNEL_FLOCK,
 158         SMB_VFS_OP_LINUX_SETLEASE,
 159         SMB_VFS_OP_GETLOCK,
 160         SMB_VFS_OP_SYMLINK,
 161         SMB_VFS_OP_READLINK,
 162         SMB_VFS_OP_LINK,
 163         SMB_VFS_OP_MKNOD,
 164         SMB_VFS_OP_REALPATH,
 165         SMB_VFS_OP_NOTIFY_WATCH,
 166         SMB_VFS_OP_CHFLAGS,
 167         SMB_VFS_OP_FILE_ID_CREATE,
 168
 169         /* NT ACL operations. */
 170
 171         SMB_VFS_OP_FGET_NT_ACL,
 172         SMB_VFS_OP_GET_NT_ACL,
 173         SMB_VFS_OP_FSET_NT_ACL,
 174         SMB_VFS_OP_SET_NT_ACL,
 175
 176         /* POSIX ACL operations. */
 177
 178         SMB_VFS_OP_CHMOD_ACL,
 179         SMB_VFS_OP_FCHMOD_ACL,
 180
 181         SMB_VFS_OP_SYS_ACL_GET_ENTRY,
 182         SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
 183         SMB_VFS_OP_SYS_ACL_GET_PERMSET,
 184         SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
 185         SMB_VFS_OP_SYS_ACL_GET_FILE,
 186         SMB_VFS_OP_SYS_ACL_GET_FD,
 187         SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
 188         SMB_VFS_OP_SYS_ACL_ADD_PERM,
 189         SMB_VFS_OP_SYS_ACL_TO_TEXT,
 190         SMB_VFS_OP_SYS_ACL_INIT,
 191         SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
 192         SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
 193         SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
 194         SMB_VFS_OP_SYS_ACL_SET_PERMSET,
 195         SMB_VFS_OP_SYS_ACL_VALID,
 196         SMB_VFS_OP_SYS_ACL_SET_FILE,
 197         SMB_VFS_OP_SYS_ACL_SET_FD,
 198         SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
 199         SMB_VFS_OP_SYS_ACL_GET_PERM,
 200         SMB_VFS_OP_SYS_ACL_FREE_TEXT,
 201         SMB_VFS_OP_SYS_ACL_FREE_ACL,
 202         SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
 203
 204         /* EA operations. */
 205         SMB_VFS_OP_GETXATTR,
 206         SMB_VFS_OP_LGETXATTR,
 207         SMB_VFS_OP_FGETXATTR,
 208         SMB_VFS_OP_LISTXATTR,
 209         SMB_VFS_OP_LLISTXATTR,
 210         SMB_VFS_OP_FLISTXATTR,
 211         SMB_VFS_OP_REMOVEXATTR,
 212         SMB_VFS_OP_LREMOVEXATTR,
 213         SMB_VFS_OP_FREMOVEXATTR,
 214         SMB_VFS_OP_SETXATTR,
 215         SMB_VFS_OP_LSETXATTR,
 216         SMB_VFS_OP_FSETXATTR,
 217
 218         /* aio operations */
 219         SMB_VFS_OP_AIO_READ,
 220         SMB_VFS_OP_AIO_WRITE,
 221         SMB_VFS_OP_AIO_RETURN,
 222         SMB_VFS_OP_AIO_CANCEL,
 223         SMB_VFS_OP_AIO_ERROR,
 224         SMB_VFS_OP_AIO_FSYNC,
 225         SMB_VFS_OP_AIO_SUSPEND,
 226
 227         /* This should always be last enum value */
 228
 229         SMB_VFS_OP_LAST
 230 } vfs_op_type;
 231
 232 /*
 233     Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
 234 */
 235 struct vfs_ops {
 236         struct vfs_fn_pointers {
 237                 /* Disk operations */
 238
 239                 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
 240                 void (*disconnect)(struct vfs_handle_struct *handle);
 241                 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, SMB_BIG_UINT *bsize,
 242                         SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
 243                 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 244                 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 245                 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
 246                 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
 247
 248                 /* Directory operations */
 249
 250                 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
 251                 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
 252                 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
 253                 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
 254                 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
 255                 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
 256                 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
 257                 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
 258
 259                 /* File operations */
 260
 261                 int (*open)(struct vfs_handle_struct *handle, const char *fname, files_struct *fsp, int flags, mode_t mode);
 262                 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
 263                 ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
 264                 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
 265                 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
 266                 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
 267                 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
 268                 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);
 269                 int (*rename)(struct vfs_handle_struct *handle, const char *oldname, const char *newname);
 270                 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
 271                 int (*stat)(struct vfs_handle_struct *handle, const char *fname, SMB_STRUCT_STAT *sbuf);
 272                 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
 273                 int (*lstat)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
 274                 int (*unlink)(struct vfs_handle_struct *handle, const char *path);
 275                 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
 276                 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
 277                 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
 278                 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
 279                 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
 280                 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
 281                 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
 282                 int (*ntimes)(struct vfs_handle_struct *handle, const char *path, const struct timespec ts[2]);
 283                 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
 284                 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);
 285                 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 share_mode);
 286                 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, int leasetype);
 287                 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);
 288                 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
 289                 int (*readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
 290                 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
 291                 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
 292                 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
 293                 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
 294                                          struct sys_notify_context *ctx,
 295                                          struct notify_entry *e,
 296                                          void (*callback)(struct sys_notify_context *ctx,
 297                                                           void *private_data,
 298                                                           struct notify_event *ev),
 299                                          void *private_data, void *handle_p);
 300                 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
 301                 struct file_id (*file_id_create)(struct vfs_handle_struct *handle, SMB_DEV_T dev, SMB_INO_T inode);
 302
 303                 /* NT ACL operations. */
 304
 305                 size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd,  uint32 security_info, struct security_descriptor **ppdesc);
 306                 size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name,  uint32 security_info, struct security_descriptor **ppdesc);
 307                 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor *psd);
 308                 NTSTATUS (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor *psd);
 309
 310                 /* POSIX ACL operations. */
 311
 312                 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
 313                 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
 314
 315                 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
 316                 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
 317                 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
 318                 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
 319                 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
 320                 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
 321                 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
 322                 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
 323                 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
 324                 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
 325                 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
 326                 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
 327                 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
 328                 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
 329                 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
 330                 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
 331                 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
 332                 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
 333                 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
 334                 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
 335                 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
 336                 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
 337
 338                 /* EA operations. */
 339                 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
 340                 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
 341                 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
 342                 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
 343                 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
 344                 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
 345                 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
 346                 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
 347                 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
 348                 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
 349                 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
 350                 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
 351
 352                 /* aio operations */
 353                 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 354                 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 355                 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 356                 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_AIOCB *aiocb);
 357                 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 358                 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
 359                 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
 360
 361         } ops;
 362
 363         struct vfs_handles_pointers {
 364                 /* Disk operations */
 365
 366                 struct vfs_handle_struct *connect_hnd;
 367                 struct vfs_handle_struct *disconnect;
 368                 struct vfs_handle_struct *disk_free;
 369                 struct vfs_handle_struct *get_quota;
 370                 struct vfs_handle_struct *set_quota;
 371                 struct vfs_handle_struct *get_shadow_copy_data;
 372                 struct vfs_handle_struct *statvfs;
 373
 374                 /* Directory operations */
 375
 376                 struct vfs_handle_struct *opendir;
 377                 struct vfs_handle_struct *readdir;
 378                 struct vfs_handle_struct *seekdir;
 379                 struct vfs_handle_struct *telldir;
 380                 struct vfs_handle_struct *rewind_dir;
 381                 struct vfs_handle_struct *mkdir;
 382                 struct vfs_handle_struct *rmdir;
 383                 struct vfs_handle_struct *closedir;
 384
 385                 /* File operations */
 386
 387                 struct vfs_handle_struct *open;
 388                 struct vfs_handle_struct *close_hnd;
 389                 struct vfs_handle_struct *read;
 390                 struct vfs_handle_struct *pread;
 391                 struct vfs_handle_struct *write;
 392                 struct vfs_handle_struct *pwrite;
 393                 struct vfs_handle_struct *lseek;
 394                 struct vfs_handle_struct *sendfile;
 395                 struct vfs_handle_struct *rename;
 396                 struct vfs_handle_struct *fsync;
 397                 struct vfs_handle_struct *stat;
 398                 struct vfs_handle_struct *fstat;
 399                 struct vfs_handle_struct *lstat;
 400                 struct vfs_handle_struct *unlink;
 401                 struct vfs_handle_struct *chmod;
 402                 struct vfs_handle_struct *fchmod;
 403                 struct vfs_handle_struct *chown;
 404                 struct vfs_handle_struct *fchown;
 405                 struct vfs_handle_struct *lchown;
 406                 struct vfs_handle_struct *chdir;
 407                 struct vfs_handle_struct *getwd;
 408                 struct vfs_handle_struct *ntimes;
 409                 struct vfs_handle_struct *ftruncate;
 410                 struct vfs_handle_struct *lock;
 411                 struct vfs_handle_struct *kernel_flock;
 412                 struct vfs_handle_struct *linux_setlease;
 413                 struct vfs_handle_struct *getlock;
 414                 struct vfs_handle_struct *symlink;
 415                 struct vfs_handle_struct *readlink;
 416                 struct vfs_handle_struct *link;
 417                 struct vfs_handle_struct *mknod;
 418                 struct vfs_handle_struct *realpath;
 419                 struct vfs_handle_struct *notify_watch;
 420                 struct vfs_handle_struct *chflags;
 421                 struct vfs_handle_struct *file_id_create;
 422
 423                 /* NT ACL operations. */
 424
 425                 struct vfs_handle_struct *fget_nt_acl;
 426                 struct vfs_handle_struct *get_nt_acl;
 427                 struct vfs_handle_struct *fset_nt_acl;
 428                 struct vfs_handle_struct *set_nt_acl;
 429
 430                 /* POSIX ACL operations. */
 431
 432                 struct vfs_handle_struct *chmod_acl;
 433                 struct vfs_handle_struct *fchmod_acl;
 434
 435                 struct vfs_handle_struct *sys_acl_get_entry;
 436                 struct vfs_handle_struct *sys_acl_get_tag_type;
 437                 struct vfs_handle_struct *sys_acl_get_permset;
 438                 struct vfs_handle_struct *sys_acl_get_qualifier;
 439                 struct vfs_handle_struct *sys_acl_get_file;
 440                 struct vfs_handle_struct *sys_acl_get_fd;
 441                 struct vfs_handle_struct *sys_acl_clear_perms;
 442                 struct vfs_handle_struct *sys_acl_add_perm;
 443                 struct vfs_handle_struct *sys_acl_to_text;
 444                 struct vfs_handle_struct *sys_acl_init;
 445                 struct vfs_handle_struct *sys_acl_create_entry;
 446                 struct vfs_handle_struct *sys_acl_set_tag_type;
 447                 struct vfs_handle_struct *sys_acl_set_qualifier;
 448                 struct vfs_handle_struct *sys_acl_set_permset;
 449                 struct vfs_handle_struct *sys_acl_valid;
 450                 struct vfs_handle_struct *sys_acl_set_file;
 451                 struct vfs_handle_struct *sys_acl_set_fd;
 452                 struct vfs_handle_struct *sys_acl_delete_def_file;
 453                 struct vfs_handle_struct *sys_acl_get_perm;
 454                 struct vfs_handle_struct *sys_acl_free_text;
 455                 struct vfs_handle_struct *sys_acl_free_acl;
 456                 struct vfs_handle_struct *sys_acl_free_qualifier;
 457
 458                 /* EA operations. */
 459                 struct vfs_handle_struct *getxattr;
 460                 struct vfs_handle_struct *lgetxattr;
 461                 struct vfs_handle_struct *fgetxattr;
 462                 struct vfs_handle_struct *listxattr;
 463                 struct vfs_handle_struct *llistxattr;
 464                 struct vfs_handle_struct *flistxattr;
 465                 struct vfs_handle_struct *removexattr;
 466                 struct vfs_handle_struct *lremovexattr;
 467                 struct vfs_handle_struct *fremovexattr;
 468                 struct vfs_handle_struct *setxattr;
 469                 struct vfs_handle_struct *lsetxattr;
 470                 struct vfs_handle_struct *fsetxattr;
 471
 472                 /* aio operations */
 473                 struct vfs_handle_struct *aio_read;
 474                 struct vfs_handle_struct *aio_write;
 475                 struct vfs_handle_struct *aio_return;
 476                 struct vfs_handle_struct *aio_cancel;
 477                 struct vfs_handle_struct *aio_error;
 478                 struct vfs_handle_struct *aio_fsync;
 479                 struct vfs_handle_struct *aio_suspend;
 480         } handles;
 481 };
 482
 483 /*
 484     Possible VFS operation layers (per-operation)
 485
 486     These values are used by VFS subsystem when building vfs_ops for connection
 487     from multiple VFS modules. Internally, Samba differentiates only opaque and
 488     transparent layers at this process. Other types are used for providing better
 489     diagnosing facilities.
 490
 491     Most modules will provide transparent layers. Opaque layer is for modules
 492     which implement actual file system calls (like DB-based VFS). For example,
 493     default POSIX VFS which is built in into Samba is an opaque VFS module.
 494
 495     Other layer types (audit, splitter, scanner) were designed to provide different
 496     degree of transparency and for diagnosing VFS module behaviour.
 497
 498     Each module can implement several layers at the same time provided that only
 499     one layer is used per each operation.
 500
 501 */
 502
 503 typedef enum _vfs_op_layer {
 504         SMB_VFS_LAYER_NOOP = -1,        /* - For using in VFS module to indicate end of array */
 505                                         /*   of operations description */
 506         SMB_VFS_LAYER_OPAQUE = 0,       /* - Final level, does not call anything beyond itself */
 507         SMB_VFS_LAYER_TRANSPARENT,      /* - Normal operation, calls underlying layer after */
 508                                         /*   possibly changing passed data */
 509         SMB_VFS_LAYER_LOGGER,           /* - Logs data, calls underlying layer, logging may not */
 510                                         /*   use Samba VFS */
 511         SMB_VFS_LAYER_SPLITTER,         /* - Splits operation, calls underlying layer _and_ own facility, */
 512                                         /*   then combines result */
 513         SMB_VFS_LAYER_SCANNER           /* - Checks data and possibly initiates additional */
 514                                         /*   file activity like logging to files _inside_ samba VFS */
 515 } vfs_op_layer;
 516
 517 /*
 518     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
 519     which describes all operations this module is willing to intercept.
 520     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
 521     using this information.
 522 */
 523
 524 typedef struct vfs_op_tuple {
 525         void* op;
 526         vfs_op_type type;
 527         vfs_op_layer layer;
 528 } vfs_op_tuple;
 529
 530
 531 typedef struct vfs_handle_struct {
 532         struct vfs_handle_struct  *next, *prev;
 533         const char *param;
 534         struct vfs_ops vfs_next;
 535         struct connection_struct *conn;
 536         void *data;
 537         void (*free_data)(void **data);
 538 } vfs_handle_struct;
 539
 540
 541 typedef struct vfs_statvfs_struct {
 542         /* For undefined recommended transfer size return -1 in that field */
 543         uint32 OptimalTransferSize;  /* bsize on some os, iosize on other os */
 544         uint32 BlockSize;
 545
 546         /*
 547          The next three fields are in terms of the block size.
 548          (above). If block size is unknown, 4096 would be a
 549          reasonable block size for a server to report.
 550          Note that returning the blocks/blocksavail removes need
 551          to make a second call (to QFSInfo level 0x103 to get this info.
 552          UserBlockAvail is typically less than or equal to BlocksAvail,
 553          if no distinction is made return the same value in each.
 554         */
 555
 556         SMB_BIG_UINT TotalBlocks;
 557         SMB_BIG_UINT BlocksAvail;       /* bfree */
 558         SMB_BIG_UINT UserBlocksAvail;   /* bavail */
 559
 560         /* For undefined Node fields or FSID return -1 */
 561         SMB_BIG_UINT TotalFileNodes;
 562         SMB_BIG_UINT FreeFileNodes;
 563         SMB_BIG_UINT FsIdentifier;   /* fsid */
 564         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
 565         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
 566 } vfs_statvfs_struct;
 567
 568 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type) \
 569     vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type))
 570
 571 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
 572     vfs_fetch_fsp_extension(handle, (fsp))
 573
 574 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
 575     vfs_remove_fsp_extension((handle), (fsp))
 576
 577 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
 578         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
 579                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
 580                 ret; \
 581         } \
 582 }
 583
 584 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
 585         if (!(handle)) { \
 586                 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
 587                 ret; \
 588         } else { \
 589                 if ((handle)->free_data) { \
 590                         (handle)->free_data(&(handle)->data); \
 591                 } \
 592                 (handle)->data = (void *)datap; \
 593                 (handle)->free_data = free_fn; \
 594         } \
 595 }
 596
 597 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
 598         if ((handle) && (handle)->free_data) { \
 599                 (handle)->free_data(&(handle)->data); \
 600         } \
 601 }
 602
 603 /* Check whether module-specific data handle was already allocated or not */
 604 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
 605
 606 #define SMB_VFS_OP(x) ((void *) x)
 607
 608 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
 609
 610 #include "vfs_macros.h"
 611
 612 #endif /* _VFS_H */