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