source3/include/vfs.h

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