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