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