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