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