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