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