source/include/vfs.h

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