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