source3/include/vfs.h

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