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