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