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