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