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