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