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