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