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    Copyright (C) Volker Lendecke                        2009
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22
  23    This work was sponsored by Optifacio Software Services, Inc.
  24 */
  25
  26 #ifndef _VFS_H
  27 #define _VFS_H
  28
  29 /* Avoid conflict with an AIX include file */
  30
  31 #ifdef vfs_ops
  32 #undef vfs_ops
  33 #endif
  34
  35 /*
  36  * As we're now (thanks Andrew ! :-) using file_structs and connection
  37  * structs in the vfs - then anyone writing a vfs must include includes.h...
  38  */
  39
  40 /*
  41  * This next constant specifies the version number of the VFS interface
  42  * this smbd will load. Increment this if *ANY* changes are made to the
  43  * vfs_ops below. JRA.
  44  *
  45  * If you change anything here, please also update modules/vfs_full_audit.c.
  46  * VL.
  47  */
  48
  49 /*
  50  * Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA.
  51  * Changed to version 3 for POSIX acl extensions. JRA.
  52  * Changed to version 4 for cascaded VFS interface. Alexander Bokovoy.
  53  * Changed to version 5 for sendfile addition. JRA.
  54  * Changed to version 6 for the new module system, fixed cascading and quota functions. --metze
  55  * Changed to version 7 to include the get_nt_acl info parameter. JRA.
  56  * Changed to version 8 includes EA calls. JRA.
  57  * Changed to version 9 to include the get_shadow_data call. --metze
  58  * Changed to version 10 to include pread pwrite calls.
  59  * Changed to version 11 to include seekdir telldir rewinddir calls. JRA
  60  * Changed to version 12 to add mask and attributes to opendir(). JRA
  61  * Also include aio calls. JRA.
  62  * Changed to version 13 as the internal structure of files_struct has changed. JRA
  63  * Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA
  64  * Changed to version 15 as we added the statvfs call. JRA
  65  * Changed to version 16 as we added the getlock call. JRA
  66  * Changed to version 17 as we removed redundant connection_struct parameters. --jpeach
  67  * Changed to version 18 to add fsp parameter to the open call -- jpeach
  68  * Also include kernel_flock call - jmcd
  69  * Changed to version 19, kernel change notify has been merged
  70  * Also included linux setlease call - jmcd
  71  * Changed to version 20, use ntimes call instead of utime (greater
  72  * timestamp resolition. JRA.
  73  * Changed to version21 to add chflags operation -- jpeach
  74  * Changed to version22 to add lchown operation -- jra
  75  * Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra.
  76  * Leave at 22 - not yet released. Add file_id_create operation. --metze
  77  * Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra.
  78  * Leave at 22 - not yet released. Added recvfile.
  79  * Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl
  80  * Leave at 22 - not yet released. Change get_nt_acl to *not* take a
  81  * files_struct. - obnox.
  82  * Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox
  83  * Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox
  84  * Leave at 22 - not yet released. Remove parameter fd from pread. - obnox
  85  * Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox
  86  * Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox
  87  * Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox
  88  * Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox
  89  * Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox
  90  * Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox
  91  * Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox
  92  * Leave at 22 - not yet released. Remove parameter fd from lock. - obnox
  93  * Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox
  94  * Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox
  95  * Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox
  96  * Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox
  97  * Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox
  98  * Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox
  99  * Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox
 100  * Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox
 101  * Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox
 102  * Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox
 103  * Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox
 104  * Leave at 22 - not yet released. Remove parameter fd from read. - obnox
 105  * Leave at 22 - not yet released. Remove parameter fd from write. - obnox
 106  * Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox
 107  * Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox
 108  * Leave at 22 - not yet released. Additional change: add operations for offline files -- ab
 109  * Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl
 110  * Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox
 111  * Changed to version 23 - remove set_nt_acl call. This can only be done via an
 112  *                         open handle. JRA.
 113  * Changed to version 24 - make security descriptor const in fset_nt_acl. JRA.
 114  * Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t.
 115  * Leave at 25 - not yet released. Add create_file call. -- tprouty.
 116  * Leave at 25 - not yet released. Add create time to ntimes. -- tstecher.
 117  * Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty.
 118  * Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann
 119  * Leave at 25 - not yet released. Add init_search_op call. - sdann
 120  * Leave at 25 - not yet released. Add locking calls. -- zkirsch.
 121  * Leave at 25 - not yet released. Add strict locking calls. -- drichards.
 122  * Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
 123  *                         SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
 124  *                         SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES.
 125  * Changed to version 27 - not yet released. Added enum timestamp_set_resolution
 126  *                         return to fs_capabilities call. JRA.
 127  * Leave at 27 - not yet released. Add translate_name VFS call to convert
 128  *               UNIX names to Windows supported names -- asrinivasan.
 129  * Changed to version 28 - Add private_flags uint32_t to CREATE call.
 130  * Leave at 28 - not yet released. Change realpath to assume NULL and return a
 131  *               malloc'ed path. JRA.
 132  * Leave at 28 - not yet released. Move posix_fallocate into the VFS
 133  *              where it belongs. JRA.
 134  * Leave at 28 - not yet released. Rename posix_fallocate to fallocate
 135  *              to split out the two possible uses. JRA.
 136  * Leave at 28 - not yet released. Add fdopendir. JRA.
 137  * Leave at 28 - not yet released. Rename open function to open_fn. - gd
 138  * Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA.
 139  * Bump to version 29 - Samba 3.6.0 will ship with interface version 28.
 140  * Leave at 29 - not yet releases. Add fsctl. Richard Sharpe
 141  * Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze
 142  * Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet
 143  * Leave at 29 - not yet released. move to plain off_t - abartlet
 144  * Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet
 145  * Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA
 146  * Leave at 29 - not yet released. Add durable handle functions - metze obnox
 147  * Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd
 148  * Bump to version 30 - Samba 4.0.0 will ship with interface version 30
 149  * Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls.
 150  * Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type
 151  * Bump to version 31 - Samba 4.1.0 will ship with interface version 31
 152  * Leave at 31 - not yet released. Make struct vuid_cache_entry in
 153  *               connection_struct a pointer.
 154  * Leave at 31 - not yet released. Add share_access to vuid_cache_entry.
 155  * Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK()
 156  * Leave at 31 - not yet released. Remove the unused
 157  *               fsp->pending_break_messages array
 158  * Leave at 31 - not yet released. add SMB_VFS_[GET SET]_COMPRESSION()
 159  *
 160  * Bump to version 32 - Samba 4.2 will ship with that.
 161  * Version 32 - Add "lease" to CREATE_FILE operation
 162  * Version 32 - Add "lease" to struct files_struct
 163  * Version 32 - Add SMB_VFS_READDIR_ATTR()
 164  * Version 32 - Add in and out create context blobs to create_file
 165  * Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter
 166  * Bump to version 33 - Samba 4.3 will ship with that.
 167  * Version 33 - change fallocate mode flags param from enum->uint32_t
 168  * Version 33 - Add snapshot create delete calls
 169  * Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp
 170  * Version 33 - Remove notify_watch_fn
 171  * Bump to version 34 - Samba 4.4 will ship with that
 172  * Version 34 - Remove bool posix_open, add uint64_t posix_flags
 173  * Version 34 - Added bool posix_pathnames to struct smb_request
 174  * Bump to version 35 - Samba 4.5 will ship with that
 175  * Version 35 - Change get_nt_acl_fn from const char *, to
 176  *              const struct smb_filename *
 177  * Version 35 - Change mkdir from const char *, to
 178  *              const struct smb_filename *
 179  * Version 35 - Change rmdir from const char *, to
 180  *              const struct smb_filename *
 181  * Version 35 - Change opendir from const char *, to
 182  *              const struct smb_filename *
 183  * Version 35 - Wrap aio async functions args in a struct vfs_aio_state
 184  * Version 35 - Change chmod from const char *, to
 185  *              const struct smb_filename *
 186  * Version 35 - Change chmod_acl from const char *, to
 187  *              const struct smb_filename *
 188  * Version 35 - Change chown from const char *, to
 189  *              const struct smb_filename *
 190  * Version 35 - Change lchown from const char *, to
 191  *              const struct smb_filename *
 192  * Version 35 - Change streaminfo from const char *, to
 193  *              const struct smb_filename *
 194  * Version 35 - Add uint32_t flags to struct smb_filename
 195  * Version 35 - Add get set fget fset dos attribute functions.
 196  * Version 35 - Add bool use_ofd_locks to struct files_struct
 197  * Bump to version 36 - Samba 4.6 will ship with that
 198  * Version 36 - Remove is_offline and set_offline
 199  * Version 37 - Module init functions now take a TALLOC_CTX * parameter.
 200  * Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE
 201  * Version 37 - Change sys_acl_delete_def_file from const char *
 202  *              to const struct smb_filename *
 203  * Version 37 - Change sys_acl_get_file from const char *
 204  *              to const struct smb_filename *
 205  * Version 37 - Change sys_acl_blob_get_file from const char *
 206  *              to const struct smb_filename *
 207  * Version 37 - Change sys_acl_set_file from const char *
 208  *              to const struct smb_filename *
 209  * Version 37 - Change listxattr from const char *
 210  *              to const struct smb_filename *
 211  * Version 37 - Change removexattr from const char *
 212  *              to const struct smb_filename *
 213  * Version 37 - Change setxattr from const char *
 214  *              to const struct smb_filename *
 215  * Version 37 - Change getxattr from const char *
 216  *              to const struct smb_filename *
 217  * Version 37 - Change mknod from const char * to const struct smb_filename *
 218  * Version 37 - Change chflags from const char *
 219  *              to const struct smb_filename *
 220  * Version 37 - Change disk_free from const char *
 221  *              to const struct smb_filename *
 222  * Version 37 - Change get_quota from const char *
 223  *              to const struct smb_filename *
 224  * Version 37 - Change link from const char *
 225  *              to const struct smb_filename *
 226  * Version 37 - Change statvfs from const char *
 227  *              to const struct smb_filename *
 228  * Version 37 - Change readlink from const char *
 229  *              to const struct smb_filename *
 230  * Version 37 - Change symlink from const char *
 231  *              to const struct smb_filename *
 232  * Version 37 - Change chdir from const char *
 233  *              to const struct smb_filename *
 234  * Version 37 - Change getwd from char *
 235  *              to const struct smb_filename *
 236  * Version 37 - Change conn->cwd from char *
 237  *              to struct smb_filename *
 238  * Version 37 - Change realpath from char *
 239  *              to struct smb_filename *
 240  * Version 37 - Change connectpath from char *
 241  *              to struct smb_filename *
 242  * Version 37 - Add SMB_VFS_OFFLOAD_READ_SEND RECV
 243  * Version 37 - Rename SMB_VFS_COPY_CHUNK_SEND RECV to
 244  *              SMB_VFS_OFFLOAD_READ_SEND RECV
 245  * Version 37 - Remove SMB_VFS_STRICT_UNLOCK
 246  * Version 37 - Rename SMB_VFS_STRICT_LOCK to
 247  *              SMB_VFS_STRICT_LOCK_CHECK
 248  * Version 38 - Remove SMB_VFS_INIT_SEARCH_OP
 249  * Bump to version 39, Samba 4.9 will ship with that
 250  * Version 39 - Remove SMB_VFS_FSYNC
 251  *              Only implement async versions.
 252  * Version 39 - Remove SMB_VFS_READ
 253  *              All users are now pread or async versions.
 254  * Version 39 - Remove SMB_VFS_WRITE
 255  *              All users are now pwrite or async versions.
 256  * Version 39 - Remove SMB_VFS_CHMOD_ACL - no longer used.
 257  * Version 39 - Remove SMB_VFS_FCHMOD_ACL - no longer used.
 258  * Version 39 - Remove struct dfree_cached_info pointer from
 259  *              connection struct
 260  * Bump to version 40, Samba 4.10 will ship with that
 261  * Version 40 - Add SMB_VFS_GETXATTRAT_SEND RECV
 262  * Version 40 - Add SMB_VFS_GET_DOS_ATTRIBUTES_SEND RECV
 263  * Bump to version 41, Samba 4.11 will ship with that
 264  * Version 41 - Remove SMB_VFS_BRL_CANCEL_WINDOWS
 265  * Version 41 - Remove unused st_ex_mask from struct stat_ex
 266  * Version 41 - convert struct stat_ex.st_ex_calculated_birthtime to flags
 267  * Version 41 - add st_ex_itime to struct stat_ex
 268  * Version 41 - add st_ex_file_id to struct stat_ex
 269  * Version 41 - add SMB_VFS_FS_FILE_ID
 270  * Version 41 - Remove "blocking_lock" parameter from
 271  *              SMB_VFS_BRL_LOCK_WINDOWS
 272  * Version 41 - Remove "msg_ctx" parameter from SMB_VFS_BRL_UNLOCK_WINDOWS
 273  * Bump to version 42, Samba 4.12 will ship with that
 274  * Version 42 - Remove share_access member from struct files_struct
 275  * Version 42 - Make "lease" a const* in create_file_fn
 276  * Version 42 - Move SMB_VFS_RENAME -> SMB_VFS_RENAMEAT
 277  * Version 42 - Move SMB_VFS_LINK -> SMB_VFS_LINKAT.
 278  * Version 42 - Move SMB_VFS_MKNOD -> SMB_VFS_MKDNODAT.
 279  * Version 42 - Move SMB_VFS_READLINK -> SMB_VFS_READLINKAT.
 280  * Version 42 - Move SMB_VFS_SYMLINK -> SMB_VFS_SYMLINKAT.
 281  * Version 42 - Move SMB_VFS_MKDIR -> SMB_VFS_MKDIRAT.
 282  * Version 42 - Move change_to_user() -> change_to_user_and_service()
 283  * Version 42 - Move change_to_user_by_fsp() -> change_to_user_and_service_by_fsp()
 284  * Version 42 - Move [un]become_user*() -> [un]become_user_without_service*()
 285  * Version 42 - Move SMB_VFS_UNLINK -> SMB_VFS_UNLINKAT.
 286  * Version 42 - Add SMB_VFS_FCNTL
 287  * Version 42 - Remove SMB_VFS_RMDIR.
 288  *              Use SMB_VFS_UNLINKAT(.., AT_REMOVEDIR) instead.
 289  * Version 42 - Remove SMB_VFS_CHOWN
 290  * Version 42 - Remove struct write_cache *wcp from files_struct
 291  * Version 42 - SMB_VFS_NTIMES() receives null times based on UTIMES_OMIT
 292  * Version 42 - Add SMB_VFS_CREATE_DFS_PATHAT()
 293  * Version 42 - Add SMB_VFS_READ_DFS_PATHAT()
 294  * Change to Version 43 - will ship with 4.13.
 295  * Version 43 - Remove deferred_close from struct files_struct
 296  * Version 43 - Remove SMB_VFS_OPENDIR()
 297  * Version 43 - Remove original_lcomp from struct smb_filename
 298  * Version 43 - files_struct flags:
 299  *              bool kernel_share_modes_taken
 300  *              bool update_write_time_triggered
 301  *              bool update_write_time_on_close
 302  *              bool write_time_forced
 303  *              bool can_lock
 304  *              bool can_read
 305  *              bool can_write
 306  *              bool modified
 307  *              bool is_directory
 308  *              bool aio_write_behind
 309  *              bool initial_delete_on_close
 310  *              bool delete_on_close
 311  *              bool is_sparse
 312  *              bool backup_intent
 313  *              bool use_ofd_locks
 314  *              bool closing
 315  *              bool lock_failure_seen
 316  *              changed to bitfields.
 317  * Version 43 - convert SMB_VFS_GET_REAL_FILENAME() arg path
 318  *              to be a struct smb_filename
 319  * Version 43 - convert link_contents arg of SMB_VFS_SYMLINKAT()
 320  *              to struct smb_filename
 321  * Version 43 - Move SMB_VFS_GET_NT_ACL() -> SMB_VFS_GET_NT_ACL_AT().
 322  * Version 43 - Remove root_dir_fid from SMB_VFS_CREATE_FILE().
 323  * Version 43 - Add dirfsp to struct files_struct
 324  * Version 43 - Add dirfsp args to SMB_VFS_CREATE_FILE()
 325  * Version 43 - Add SMB_VFS_OPENAT()
 326  * Version 43 - Remove SMB_VFS_OPEN()
 327  * Version 43 - SMB_VFS_READ_DFS_PATHAT() should take a non-const name.
 328                 There's no easy way to return stat info for a DFS link
 329                 otherwise.
 330  * Change to Version 44 - will ship with 4.14.
 331  * Version 44 - Remove dirfsp arg from struct files_struct
 332  * Version 44 - Remove dirfsp arg to SMB_VFS_CREATE_FILE()
 333  * Version 44 - Make dirfsp arg to SMB_VFS_READLINKAT() const
 334  * Version 44 - Add a flag 'encryption_required' to files_struct that that
 335  *              prevents that encrypted connections can be downgraded.
 336  * Version 44 - Add a flag 'is_pathref' to struct files_struct.
 337  * Version 44 - Add 'is_fsa' flag to struct files_struct.
 338  * Version 44 - Add 'have_proc_fds' flag to struct connection_struct.
 339  * Version 44 - Add 'have_proc_fds' flag to struct files_struct.
 340  * Version 44 - Add dirfsp arg to SMB_VFS_READDIR()
 341  * Version 44 - Replace SMB_VFS_GET_COMPRESSION() with SMB_VFS_FGET_COMPRESSION()
 342  * Version 44 - Add type argument to SMB_VFS_SYS_ACL_SET_FD()
 343  * Version 44 - Remove SMB_VFS_SYS_ACL_SET_FILE()
 344  * Change to Version 45 - will ship with 4.15
 345  * Version 45 - Remove SMB_VFS_LISTXATTR
 346  * Version 45 - Remove SMB_VFS_SETXATTR
 347  * Version 45 - Remove SMB_VFS_REMOVEXATTR
 348  * Version 45 - Remove SMB_VFS_GET_DOS_ATTRIBUTES()
 349  * Version 45 - Remove SMB_VFS_CHMOD
 350  * Version 45 - Add SMB_VFS_FNTIMES
 351  * Version 45 - Remove SMB_VFS_NTIMES
 352  * Version 45 - ADD SMB_VFS_FSTREAMINFO
 353  * Version 45 - Add SMB_VFS_FREADDIR_ATTR
 354  * Version 45 - Remove SMB_VFS_READDIR_ATTR
 355  * Version 45 - Add SMB_VFS_SYS_ACL_DELETE_DEF_FD
 356  * Version 45 - Remove SMB_VFS_SYS_ACL_DELETE_DEF_FILE
 357  * Version 45 - Add SMB_VFS_PARENT_PATHNAME
 358  * Version 45 - Remove SMB_VFS_GET_NT_ACL_AT
 359  * Version 45 - Remove SYS_ACL_GET_FILE
 360  * Version 45 - Remove SYS_ACL_BLOB_GET_FILE
 361  * Version 45 - Add SMB_VFS_FCHFLAGS
 362  * Version 45 - Remove SMB_VFS_GETXATTR
 363  * Change to Version 46 - will ship with 4.16
 364  * Version 46 - Rename SMB_VFS_KERNEL_FLOCK to SMB_VFS_FILESYSTEM_SHAREMODE
 365  * Version 46 - Add flags and xferlen args to SMB_VFS_OFFLOAD_READ_RECV
 366  * Change to Version 47 - will ship with 4.17
 367  * Version 47 - Add SMB_VFS_FSTATAT
 368  * Version 47 - Change SMB_VFS_GET_REAL_FILENAME to return NTSTATUS
 369  * Version 47 - remove st_ex_itime from struct stat_ex
 370  * Version 47 - remove (unused) struct lock_struct last_lock_failure
 371                 from files_struct.
 372  * Version 47 - Add SMB_VFS_GET_REAL_FILENAME_AT
 373  * Version 47 - Replace SMB_VFS_GET_REAL_FILENAME with SMB_VFS_GET_REAL_FILENAME_AT
 374  * Version 47 - Re-add dirfsp to CREATE_FILE
 375  * Version 47 - Add fsp flag fstat_before_close
 376  * Version 47 - Change SMB_VFS_OPENAT() to match the Linux openat2 prototype, add vfs_open_how
 377  * Version 47 - Add VFS_OPEN_HOW_RESOLVE_NO_SYMLINKS for SMB_VFS_OPENAT()
 378  * Change to Version 48 - will ship with 4.18
 379  * Version 48 - Add cached_dos_attributes to struct stat_ex
 380  * Version 48 - Add dirfsp to connectpath_fn()
 381  * Change to Version 49 - will ship with 4.19
 382  * Version 49 - remove seekdir and telldir
 383  * Version 49 - remove "sbuf" argument from readdir_fn()
 384  */
 385
 386 #define SMB_VFS_INTERFACE_VERSION 49
 387
 388 /*
 389     All intercepted VFS operations must be declared as static functions inside module source
 390     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
 391     example VFS modules for more details.
 392 */
 393
 394 /* VFS operations structure */
 395
 396 struct vfs_handle_struct;
 397 struct connection_struct;
 398 struct files_struct;
 399 struct security_descriptor;
 400 struct vfs_statvfs_struct;
 401 struct smb_request;
 402 struct ea_list;
 403 struct smb_file_time;
 404 struct smb_filename;
 405 struct dfs_GetDFSReferral;
 406
 407 typedef union unid_t {
 408         uid_t uid;
 409         gid_t gid;
 410 } unid_t;
 411
 412 struct fd_handle;
 413
 414 struct fsp_lease {
 415         size_t ref_count;
 416         struct smbd_server_connection *sconn;
 417         struct tevent_timer *timeout;
 418         struct smb2_lease lease;
 419 };
 420
 421 typedef struct files_struct {
 422         struct files_struct *next, *prev;
 423         uint64_t fnum;
 424         struct smbXsrv_open *op;
 425         struct connection_struct *conn;
 426         struct fd_handle *fh;
 427         unsigned int num_smb_operations;
 428         struct file_id file_id;
 429         uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
 430         uint16_t file_pid;
 431         uint64_t vuid; /* SMB2 compat */
 432         struct timeval open_time;
 433         uint32_t access_mask;           /* NTCreateX access bits (FILE_READ_DATA etc.) */
 434         struct {
 435                 bool is_pathref : 1; /* See below */
 436                 bool is_fsa : 1;     /* See below */
 437                 bool have_proc_fds : 1;
 438                 bool kernel_share_modes_taken : 1;
 439                 bool update_write_time_triggered : 1;
 440                 bool update_write_time_on_close : 1;
 441                 bool write_time_forced : 1;
 442                 bool can_lock : 1;
 443                 bool can_read : 1;
 444                 bool can_write : 1;
 445                 bool modified : 1;
 446                 bool is_directory : 1;
 447                 bool is_dirfsp : 1;
 448                 bool aio_write_behind : 1;
 449                 bool initial_delete_on_close : 1;
 450                 bool delete_on_close : 1;
 451                 bool is_sparse : 1;
 452                 bool backup_intent : 1;
 453                 bool use_ofd_locks : 1;
 454                 bool closing : 1;
 455                 bool lock_failure_seen : 1;
 456                 bool encryption_required : 1;
 457                 bool fstat_before_close : 1;
 458         } fsp_flags;
 459
 460         struct tevent_timer *update_write_time_event;
 461         struct timespec close_write_time;
 462
 463         int oplock_type;
 464
 465         /*
 466          * Cache of our lease_type, stored as "current_state" in
 467          * leases.tdb
 468          */
 469         int leases_db_seqnum;
 470         uint32_t lease_type;
 471
 472         struct fsp_lease *lease;
 473         int sent_oplock_break;
 474         struct tevent_timer *oplock_timeout;
 475         int current_lock_count; /* Count the number of outstanding locks and pending locks. */
 476
 477         uint64_t posix_flags;
 478         struct smb_filename *fsp_name;
 479         uint32_t name_hash;             /* Jenkins hash of full pathname. */
 480         uint64_t mid;                   /* Mid of the operation that created us. */
 481
 482         struct vfs_fsp_data *vfs_extension;
 483         struct fake_file_handle *fake_file_handle;
 484
 485         struct notify_change_buf *notify;
 486
 487         struct files_struct *base_fsp; /* placeholder for delete on close */
 488         struct files_struct *stream_fsp; /* backlink from base_fsp */
 489
 490         /*
 491          * Cache of share_mode_data->flags
 492          */
 493         int share_mode_flags_seqnum;
 494         uint16_t share_mode_flags;
 495
 496         /*
 497          * Read-only cached brlock record, thrown away when the
 498          * brlock.tdb seqnum changes. This avoids fetching data from
 499          * the brlock.tdb on every read/write call.
 500          */
 501         int brlock_seqnum;
 502         struct byte_range_lock *brlock_rec;
 503
 504         struct dptr_struct *dptr;
 505
 506         /* if not NULL, means this is a print file */
 507         struct print_file_data *print_file;
 508
 509         /*
 510          * Optimize the aio_requests array for high performance: Never
 511          * shrink it, maintain num_aio_requests separately
 512          */
 513         unsigned num_aio_requests;
 514         struct tevent_req **aio_requests;
 515
 516         /*
 517          * Requests waiting for smb1 byte range locks. They are
 518          * generated by smbd_smb1_do_locks_send and are required here,
 519          * because lock cancel operations index through reply_lockingX
 520          * not based on mid but on the lock type and range.
 521          */
 522         struct tevent_req **blocked_smb1_lock_reqs;
 523
 524         /*
 525          * SMB1 remembers lock failures and delays repeated blocking
 526          * lock attempts on the same offset.
 527          */
 528         uint64_t lock_failure_offset;
 529 } files_struct;
 530
 531 /*
 532  * The fsp flags "is_pathref" and "is_fsa"
 533  * =======================================
 534  *
 535  * Summary
 536  * -------
 537  *
 538  * The flag "is_pathref" is a property of the low-level VFS-layer file
 539  * handle. If "is_pathref" is true, only a subset of VFS calls are allowed
 540  * on the handle and on systems that support it, the low-level fd is open
 541  * with O_PATH. If "is_pathref" is false, the low-level fd is a "normal"
 542  * file descriptor that can be used with all VFS calls.
 543  *
 544  * The flag "is_fsa" is a property of the FSA layer in Samba. The term FSA
 545  * layer refers to the parts of smbd that implement Windows NTFS semantics
 546  * on-top of a POSIX filesystem. If "is_fsa" is true, the fsp was
 547  * processed by the SMB_VFS_CREATE_FILE() VFS call, otherwise the fsp was
 548  * created by openat_pathref_fsp() which only connected the low-level
 549  * handle by calling into VFS SMB_VFS_OPENAT(), but the whole FSA layer
 550  * logic is skipped.
 551  *
 552  * Note that only three possible combinations of "is_pathref" and "is_fsa"
 553  * are possible:
 554  *
 555  * | is_fsa \ is_pathref | + | - |
 556  * |---------------------+---+---|
 557  * | +                   | + | + |
 558  * | -                   | + | - |
 559  *
 560  * So a fsp can't be a full low-level fd (is_pathref=false) and not be
 561  * processed by the FSA layer.
 562  *
 563  * Details
 564  * -------
 565  *
 566  * On Linux the O_PATH flag to open() can be used to open a filehandle on
 567  * a file or directory with interesting properties:
 568  *
 569  * - the file-handle indicates a location in the filesystem tree,
 570  * - no permission checks are done by the kernel and
 571  * - only operations that act purely at the file descriptor level are
 572  *   allowed.
 573  *
 574  * The file itself is not opened, and other file operations (e.g.,
 575  * read(2), write(2), fchmod(2), fchown(2), fgetxattr(2), ioctl(2),
 576  * mmap(2)) fail with the error EBADF.
 577  *
 578  * The following subset of operations that is relevant to Samba is allowed:
 579  *
 580  * - close(2),
 581  * - fchdir(2), if the file descriptor refers to a directory,
 582  * - fstat(2),
 583  * - fstatfs(2) and
 584  * - passing the file descriptor as the dirfd argument of openat() and the
 585  *   other "*at()" system calls. This includes linkat(2) with
 586  *   AT_EMPTY_PATH (or via procfs using AT_SYMLINK_FOLLOW) even if the
 587  *   file is not a directory.
 588  *
 589  * Opening a file or directory with the O_PATH flag requires no
 590  * permissions on the object itself (but does require execute permission
 591  * on the directories in the path prefix). By contrast, obtaining a
 592  * reference to a filesystem object by opening it with the O_RDONLY flag
 593  * requires that the caller have read permission on the object, even when
 594  * the subsequent operation (e.g., fchdir(2), fstat(2)) does not require
 595  * read permission on the object. [1]
 596  *
 597  * If for example Samba receives an SMB request to open a file requesting
 598  * SEC_FILE_READ_ATTRIBUTE access rights because the client wants to read
 599  * the file's metadata from the handle, Samba will have to call POSIX
 600  * open() with at least O_RDONLY access rights.
 601  *
 602  * Usecase for O_PATH in Samba
 603  * ---------------------------
 604  *
 605  * By leveraging this Linux specific flags we can avoid permission
 606  * mismatches as described above. Additionally O_PATH allows basing all
 607  * filesystem accesses done by the fileserver on handle based syscalls by
 608  * opening all client pathnames with O_PATH and consistently using for
 609  * example fstat() instead of stat() throughout the codebase.
 610  *
 611  * Subsequently we will refer to Samba file-handles (fsp's) opened with
 612  * O_PATH "path referencing fsp's" or "pathref" fsp's for short.
 613  *
 614  * Currently Samba bases the decision whether to call POSIX open() on a
 615  * client pathname or whether to leave the low-level handle at -1, what we
 616  * call a stat-open, in the function open_file() and it is based on the
 617  * client requested SMB access mask.
 618  *
 619  * The set of rights that trigger an open() include READ_CONTROL_ACCESS,
 620  * resulting in a call to open() with at least O_RDONLY. If the filesystem
 621  * supports NT style ACLs natively (like GPFS or ZFS), the filesystem may
 622  * grant the user requested right READ_CONTROL_ACCESS, but it may not
 623  * grant READ_DATA (O_RDONLY), resulting in a permission denied error.
 624  *
 625  * Historically the set of access rights that triggered opening a file was:
 626  *
 627  *   FILE_READ_DATA
 628  *   FILE_WRITE_DATA
 629  *   FILE_APPEND_DATA
 630  *   FILE_EXECUTE
 631  *   WRITE_DAC_ACCESS
 632  *   WRITE_OWNER_ACCESS
 633  *   SEC_FLAG_SYSTEM_SECURITY
 634  *   READ_CONTROL_ACCESS
 635  *
 636  * By using O_PATH this can be trimmed down to
 637  *
 638  *   FILE_READ_DATA
 639  *   FILE_WRITE_DATA
 640  *   FILE_APPEND_DATA
 641  *   FILE_EXECUTE
 642  *
 643  * Fallback on systems without O_PATH support
 644  * ------------------------------------------
 645  *
 646  * A fallback is needed that allows opening a file-handle with the same
 647  * higher level semantics even if the system doesn't support O_PATH. This
 648  * is implemented by impersonating the root user for the open()
 649  * syscall. To avoid bypassing restrictive permissions on intermediate
 650  * directories components of a path, the root user is only impersonated
 651  * after changing directory to the parent directory of the client
 652  * requested pathname.
 653  *
 654  * In order to avoid privilege escalation security issues with these root
 655  * opened file-handles we must carefully control their usage throughout
 656  * the codebase. Therefore we
 657  *
 658  * - tag the pathref fsp's with the flag "is_pathref" and
 659  *
 660  * - control access to the file-handle by making the structure private and only
 661  *   allowing access with accessor functions.
 662  *
 663  * Two functions are used to fetch the low-level system file-handle from an fsp
 664  *
 665  * - fsp_get_io_fd(fsp): enforces fsp is NOT a pathref file-handle and
 666  *
 667  * - fsp_get_pathref_fd(fsp): allows fsp to be either a pathref file-handle or a
 668  *   traditional POSIX file-handle opened with O_RDONLY or any other POSIX open
 669  *   flag.
 670  *
 671  * The general guideline when to use which function is:
 672  *
 673  * - if you do something like fstat(fd), use fsp_get_pathref_fd(fsp),
 674  * - if you do something like *at(dirfd, ...), use fsp_get_pathref_fd(fsp),
 675  * - if you want to print the fd for example in DEBUG messages, use
 676  *   fsp_get_pathref_fd(fsp),
 677  * - if you want to call close(fd), use fsp_get_pathref_fd(fsp),
 678  * - if you're doing a logical comparison of fd values, use
 679  *   fsp_get_pathref_fd().
 680  *
 681  * In any other case use fsp_get_io_fd().
 682  */
 683
 684 #define FSP_POSIX_FLAGS_OPEN            0x01
 685 #define FSP_POSIX_FLAGS_RENAME          0x02
 686 #define FSP_POSIX_FLAGS_PATHNAMES       0x04
 687
 688 #define FSP_POSIX_FLAGS_ALL                     \
 689         (FSP_POSIX_FLAGS_OPEN |                 \
 690          FSP_POSIX_FLAGS_PATHNAMES |            \
 691          FSP_POSIX_FLAGS_RENAME)
 692
 693 struct vuid_cache_entry {
 694         struct auth_session_info *session_info;
 695         uint64_t vuid; /* SMB2 compat */
 696         bool read_only;
 697         uint32_t share_access;
 698 };
 699
 700 struct vuid_cache {
 701         unsigned int next_entry;
 702         struct vuid_cache_entry array[VUID_CACHE_SIZE];
 703 };
 704
 705 typedef struct {
 706         char *name;
 707         bool is_wild;
 708 } name_compare_entry;
 709
 710 struct share_params {
 711         int service;
 712 };
 713
 714 typedef struct connection_struct {
 715         struct connection_struct *next, *prev;
 716         struct smbd_server_connection *sconn; /* can be NULL */
 717         struct smbXsrv_tcon *tcon; /* can be NULL */
 718         uint32_t cnum; /* an index passed over the wire */
 719         struct share_params *params;
 720         bool force_user;
 721         struct vuid_cache *vuid_cache;
 722         bool printer;
 723         bool ipc;
 724         bool read_only; /* Attributes for the current user of the share. */
 725         bool have_proc_fds;
 726         uint64_t open_how_resolve; /* supported vfs_open_how.resolve features */
 727         uint32_t share_access;
 728         /* Does this filesystem honor
 729            sub second timestamps on files
 730            and directories when setting time ? */
 731         enum timestamp_set_resolution ts_res;
 732         char *connectpath;
 733         struct files_struct *cwd_fsp; /* Working directory. */
 734         bool tcon_done;
 735
 736         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
 737
 738         /*
 739          * This represents the user information on this connection. Depending
 740          * on the vuid using this tid, this might change per SMB request.
 741          */
 742         struct auth_session_info *session_info;
 743
 744         /*
 745          * If the "force group" parameter is set, this is the primary gid that
 746          * may be used in the users token, depending on the vuid using this tid.
 747          */
 748         gid_t force_group_gid;
 749
 750         uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
 751
 752         time_t lastused;
 753         time_t lastused_count;
 754         int num_files_open;
 755         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
 756         int encrypt_level;
 757         bool encrypted_tid;
 758
 759         /* Semantics requested by the client or forced by the server config. */
 760         bool case_sensitive;
 761         bool case_preserve;
 762         bool short_case_preserve;
 763
 764         /* Semantics provided by the underlying filesystem. */
 765         int fs_capabilities;
 766         /* Device number of the directory of the share mount.
 767            Used to ensure unique FileIndex returns. */
 768         SMB_DEV_T base_share_dev;
 769
 770         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
 771         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
 772         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
 773         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
 774         struct trans_state *pending_trans;
 775
 776         struct rpc_pipe_client *spoolss_pipe;
 777
 778 } connection_struct;
 779
 780 struct smbd_smb2_request;
 781 struct referral;
 782
 783 struct smb_request {
 784         uint8_t cmd;
 785         uint16_t flags2;
 786         uint16_t smbpid;
 787         uint64_t mid; /* For compatibility with SMB2. */
 788         uint32_t seqnum;
 789         uint64_t vuid; /* For compatibility with SMB2. */
 790         uint32_t tid;
 791         uint8_t  wct;
 792         const uint16_t *vwv;
 793         uint16_t buflen;
 794         const uint8_t *buf;
 795         const uint8_t *inbuf;
 796
 797         /*
 798          * Async handling in the main smb processing loop is directed by
 799          * outbuf: reply_xxx routines indicate sync behaviour by putting their
 800          * reply into "outbuf". If they leave it as NULL, they take care of it
 801          * themselves, possibly later.
 802          *
 803          * If async handling is wanted, the reply_xxx routine must make sure
 804          * that it talloc_move()s the smb_req somewhere else.
 805          */
 806         uint8_t *outbuf;
 807
 808         size_t unread_bytes;
 809         bool encrypted;
 810         connection_struct *conn;
 811         struct smbd_server_connection *sconn;
 812         struct smbXsrv_connection *xconn;
 813
 814         /*
 815          * Pointer to session, can be NULL,
 816          * eg during negprot and session setup.
 817          */
 818         struct smbXsrv_session *session;
 819
 820         /*
 821          * Chained request handling
 822          */
 823         struct files_struct *chain_fsp;
 824
 825         /*
 826          * state information for async smb handling
 827          */
 828         void *async_priv;
 829
 830         /*
 831          * Back pointer to smb2 request.
 832          */
 833         struct smbd_smb2_request *smb2req;
 834
 835         /*
 836          * Request list for chained requests, we're part of it.
 837          */
 838         struct smb_request **chain;
 839
 840         struct timeval request_time;
 841
 842         bool posix_pathnames;
 843 };
 844
 845 /*
 846  * Info about an alternate data stream
 847  */
 848
 849 struct stream_struct {
 850         off_t size;
 851         off_t alloc_size;
 852         char *name;
 853 };
 854
 855 /* time info */
 856 struct smb_file_time {
 857         struct timespec mtime;
 858         struct timespec atime;
 859         struct timespec ctime;
 860         struct timespec create_time;
 861 };
 862
 863 /*
 864  * smb_filename
 865  */
 866 struct smb_filename {
 867         char *base_name;
 868         char *stream_name;
 869         uint32_t flags;
 870         SMB_STRUCT_STAT st;
 871         NTTIME twrp;
 872
 873         /*
 874          * Internal file handle, O_PATH based if available,
 875          * otherwise O_RDONLY as root.
 876          */
 877         struct files_struct *fsp;
 878
 879         /*
 880          * Link between the struct smb_filename and the above
 881          * fsp. fsp_link is a talloc child of the fsp. Ensures a possible
 882          * talloc_free(fsp) resets the smb_fname->fsp pointer to NULL in
 883          * the is fsp_link talloc destructor.
 884          */
 885         struct fsp_smb_fname_link *fsp_link;
 886 };
 887
 888 /*
 889  * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
 890  * to keep the numeric values consistent.
 891  */
 892
 893 #define SMB_FILENAME_POSIX_PATH         FSP_POSIX_FLAGS_PATHNAMES
 894
 895 enum vfs_translate_direction {
 896         vfs_translate_to_unix = 0,
 897         vfs_translate_to_windows
 898 };
 899
 900 enum vfs_fallocate_flags {
 901         VFS_FALLOCATE_FL_KEEP_SIZE              = 0x0001,
 902         VFS_FALLOCATE_FL_PUNCH_HOLE             = 0x0002,
 903 };
 904
 905 struct vfs_aio_state {
 906         int error;
 907         uint64_t duration;
 908 };
 909
 910 #define VFS_OPEN_HOW_RESOLVE_NO_SYMLINKS 1
 911 #define VFS_OPEN_HOW_WITH_BACKUP_INTENT 2
 912
 913 struct vfs_open_how {
 914         int flags;
 915         mode_t mode;
 916         uint64_t resolve;
 917 };
 918
 919 /*
 920     Available VFS operations. These values must be in sync with vfs_ops struct
 921     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
 922     In particular, if new operations are added to vfs_ops, appropriate constants
 923     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
 924 */
 925 struct shadow_copy_data;
 926
 927 struct vfs_fn_pointers {
 928         /* Disk operations */
 929
 930         int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
 931         void (*disconnect_fn)(struct vfs_handle_struct *handle);
 932         uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
 933                                 const struct smb_filename *smb_fname,
 934                                 uint64_t *bsize,
 935                                 uint64_t *dfree,
 936                                 uint64_t *dsize);
 937         int (*get_quota_fn)(struct vfs_handle_struct *handle,
 938                                 const struct smb_filename *smb_fname,
 939                                 enum SMB_QUOTA_TYPE qtype,
 940                                 unid_t id,
 941                                 SMB_DISK_QUOTA *qt);
 942         int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 943         int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
 944         int (*statvfs_fn)(struct vfs_handle_struct *handle,
 945                                 const struct smb_filename *smb_fname,
 946                                 struct vfs_statvfs_struct *statbuf);
 947         uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
 948
 949         /*
 950          * Note: that "struct dfs_GetDFSReferral *r"
 951          * needs to be a valid TALLOC_CTX
 952          */
 953         NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
 954                                          struct dfs_GetDFSReferral *r);
 955         NTSTATUS (*create_dfs_pathat_fn)(struct vfs_handle_struct *handle,
 956                                 struct files_struct *dirfsp,
 957                                 const struct smb_filename *smb_fname,
 958                                 const struct referral *reflist,
 959                                 size_t referral_count);
 960         NTSTATUS (*read_dfs_pathat_fn)(struct vfs_handle_struct *handle,
 961                                 TALLOC_CTX *mem_ctx,
 962                                 struct files_struct *dirfsp,
 963                                 struct smb_filename *smb_fname,
 964                                 struct referral **ppreflist,
 965                                 size_t *preferral_count);
 966
 967         /* Directory operations */
 968
 969         DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
 970         struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
 971                                      struct files_struct *dirfsp,
 972                                      DIR *dirp);
 973         void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 974         int (*mkdirat_fn)(struct vfs_handle_struct *handle,
 975                         struct files_struct *dirfsp,
 976                         const struct smb_filename *smb_fname,
 977                         mode_t mode);
 978         int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
 979
 980         /* File operations */
 981
 982         int (*openat_fn)(struct vfs_handle_struct *handle,
 983                          const struct files_struct *dirfsp,
 984                          const struct smb_filename *smb_fname,
 985                          struct files_struct *fsp,
 986                          const struct vfs_open_how *how);
 987         NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
 988                                    struct smb_request *req,
 989                                    struct files_struct *dirfsp,
 990                                    struct smb_filename *smb_fname,
 991                                    uint32_t access_mask,
 992                                    uint32_t share_access,
 993                                    uint32_t create_disposition,
 994                                    uint32_t create_options,
 995                                    uint32_t file_attributes,
 996                                    uint32_t oplock_request,
 997                                    const struct smb2_lease *lease,
 998                                    uint64_t allocation_size,
 999                                    uint32_t private_flags,
1000                                    struct security_descriptor *sd,
1001                                    struct ea_list *ea_list,
1002                                    files_struct **result,
1003                                    int *pinfo,
1004                                    const struct smb2_create_blobs *in_context_blobs,
1005                                    struct smb2_create_blobs *out_context_blobs);
1006         int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
1007         ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
1008         struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
1009                                             TALLOC_CTX *mem_ctx,
1010                                             struct tevent_context *ev,
1011                                             struct files_struct *fsp,
1012                                             void *data,
1013                                             size_t n, off_t offset);
1014         ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
1015         ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
1016         struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
1017                                              TALLOC_CTX *mem_ctx,
1018                                              struct tevent_context *ev,
1019                                              struct files_struct *fsp,
1020                                              const void *data,
1021                                              size_t n, off_t offset);
1022         ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
1023         off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
1024         ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
1025         ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
1026         int (*renameat_fn)(struct vfs_handle_struct *handle,
1027                          struct files_struct *srcdir_fsp,
1028                          const struct smb_filename *smb_fname_src,
1029                          struct files_struct *dstdir_fsp,
1030                          const struct smb_filename *smb_fname_dst);
1031         struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
1032                                             TALLOC_CTX *mem_ctx,
1033                                             struct tevent_context *ev,
1034                                             struct files_struct *fsp);
1035         int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
1036         int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
1037         int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1038         int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
1039         int (*fstatat_fn)(
1040                 struct vfs_handle_struct *handle,
1041                 const struct files_struct *dirfsp,
1042                 const struct smb_filename *smb_fname,
1043                 SMB_STRUCT_STAT *sbuf,
1044                 int flags);
1045         uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
1046         int (*unlinkat_fn)(struct vfs_handle_struct *handle,
1047                         struct files_struct *srcdir_fsp,
1048                         const struct smb_filename *smb_fname,
1049                         int flags);
1050         int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
1051         int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
1052         int (*lchown_fn)(struct vfs_handle_struct *handle,
1053                         const struct smb_filename *smb_fname,
1054                         uid_t uid,
1055                         gid_t gid);
1056         int (*chdir_fn)(struct vfs_handle_struct *handle,
1057                          const struct smb_filename *smb_fname);
1058         struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
1059                                 TALLOC_CTX *mem_ctx);
1060         int (*fntimes_fn)(struct vfs_handle_struct *handle,
1061                           struct files_struct *fsp,
1062                           struct smb_file_time *ft);
1063         int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
1064         int (*fallocate_fn)(struct vfs_handle_struct *handle,
1065                             struct files_struct *fsp,
1066                             uint32_t mode,
1067                             off_t offset,
1068                             off_t len);
1069         bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
1070         int (*filesystem_sharemode_fn)(struct vfs_handle_struct *handle,
1071                                        struct files_struct *fsp,
1072                                        uint32_t share_access, uint32_t
1073                                        access_mask);
1074         int (*fcntl_fn)(struct vfs_handle_struct *handle,
1075                         struct files_struct *fsp, int cmd, va_list cmd_arg);
1076         int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
1077         bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
1078         int (*symlinkat_fn)(struct vfs_handle_struct *handle,
1079                                 const struct smb_filename *link_contents,
1080                                 struct files_struct *dirfsp,
1081                                 const struct smb_filename *new_smb_fname);
1082         int (*readlinkat_fn)(struct vfs_handle_struct *handle,
1083                                 const struct files_struct *dirfsp,
1084                                 const struct smb_filename *smb_fname,
1085                                 char *buf,
1086                                 size_t bufsiz);
1087         int (*linkat_fn)(struct vfs_handle_struct *handle,
1088                                 struct files_struct *srcfsp,
1089                                 const struct smb_filename *old_smb_fname,
1090                                 struct files_struct *dstfsp,
1091                                 const struct smb_filename *new_smb_fname,
1092                                 int flags);
1093         int (*mknodat_fn)(struct vfs_handle_struct *handle,
1094                                 struct files_struct *dirfsp,
1095                                 const struct smb_filename *smb_fname,
1096                                 mode_t mode,
1097                                 SMB_DEV_T dev);
1098         struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
1099                                 TALLOC_CTX *ctx,
1100                                 const struct smb_filename *smb_fname);
1101         int (*fchflags_fn)(struct vfs_handle_struct *handle,
1102                                 struct files_struct *fsp,
1103                                 unsigned int flags);
1104         struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
1105                                             const SMB_STRUCT_STAT *sbuf);
1106         uint64_t (*fs_file_id_fn)(struct vfs_handle_struct *handle,
1107                                   const SMB_STRUCT_STAT *sbuf);
1108         struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
1109                                                    struct tevent_context *ev,
1110                                                    struct vfs_handle_struct *handle,
1111                                                    struct files_struct *fsp,
1112                                                    uint32_t fsctl,
1113                                                    uint32_t ttl,
1114                                                    off_t offset,
1115                                                    size_t to_copy);
1116         NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
1117                                          struct vfs_handle_struct *handle,
1118                                          TALLOC_CTX *mem_ctx,
1119                                          uint32_t *flags,
1120                                          uint64_t *xferlen,
1121                                          DATA_BLOB *token_blob);
1122         struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
1123                                                     TALLOC_CTX *mem_ctx,
1124                                                     struct tevent_context *ev,
1125                                                     uint32_t fsctl,
1126                                                     DATA_BLOB *token,
1127                                                     off_t transfer_offset,
1128                                                     struct files_struct *dest_fsp,
1129                                                     off_t dest_off,
1130                                                     off_t to_copy);
1131         NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
1132                                           struct tevent_req *req,
1133                                           off_t *copied);
1134         NTSTATUS (*fget_compression_fn)(struct vfs_handle_struct *handle,
1135                                        TALLOC_CTX *mem_ctx,
1136                                        struct files_struct *fsp,
1137                                        uint16_t *_compression_fmt);
1138         NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
1139                                        TALLOC_CTX *mem_ctx,
1140                                        struct files_struct *fsp,
1141                                        uint16_t compression_fmt);
1142         NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
1143                                        TALLOC_CTX *mem_ctx,
1144                                        const char *service_path,
1145                                        char **base_volume);
1146         NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
1147                                    TALLOC_CTX *mem_ctx,
1148                                    const char *base_volume,
1149                                    time_t *tstamp,
1150                                    bool rw,
1151                                    char **base_path,
1152                                    char **snap_path);
1153         NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
1154                                    TALLOC_CTX *mem_ctx,
1155                                    char *base_path,
1156                                    char *snap_path);
1157
1158         NTSTATUS (*fstreaminfo_fn)(struct vfs_handle_struct *handle,
1159                                    struct files_struct *fsp,
1160                                    TALLOC_CTX *mem_ctx,
1161                                    unsigned int *num_streams,
1162                                    struct stream_struct **streams);
1163
1164         NTSTATUS (*get_real_filename_at_fn)(struct vfs_handle_struct *handle,
1165                                             struct files_struct *dirfsp,
1166                                             const char *name,
1167                                             TALLOC_CTX *mem_ctx,
1168                                             char **found_name);
1169
1170         const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
1171                                       const struct files_struct *dirfsp,
1172                                       const struct smb_filename *smb_fname);
1173
1174         NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
1175                                         struct byte_range_lock *br_lck,
1176                                         struct lock_struct *plock);
1177
1178         bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
1179                                       struct byte_range_lock *br_lck,
1180                                       const struct lock_struct *plock);
1181
1182         bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
1183                                      struct files_struct *fsp,
1184                                      struct lock_struct *plock);
1185
1186         NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
1187                                       const char *name,
1188                                       enum vfs_translate_direction direction,
1189                                       TALLOC_CTX *mem_ctx,
1190                                       char **mapped_name);
1191
1192         NTSTATUS (*parent_pathname_fn)(struct vfs_handle_struct *handle,
1193                                        TALLOC_CTX *mem_ctx,
1194                                        const struct smb_filename *smb_fname_in,
1195                                        struct smb_filename **parent_dir_out,
1196                                        struct smb_filename **atname_out);
1197
1198         NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
1199                              struct files_struct *fsp,
1200                              TALLOC_CTX *ctx,
1201                              uint32_t function,
1202                              uint16_t req_flags,
1203                              const uint8_t *_in_data,
1204                              uint32_t in_len,
1205                              uint8_t **_out_data,
1206                              uint32_t max_out_len,
1207                              uint32_t *out_len);
1208
1209         NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
1210                                            struct files_struct *fsp,
1211                                            uint32_t *dosmode);
1212
1213         NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *handle,
1214                                            struct files_struct *fsp,
1215                                            uint32_t dosmode);
1216
1217         struct tevent_req *(*get_dos_attributes_send_fn)(
1218                                 TALLOC_CTX *mem_ctx,
1219                                 struct tevent_context *ev,
1220                                 struct vfs_handle_struct *handle,
1221                                 files_struct *dir_fsp,
1222                                 struct smb_filename *smb_fname);
1223
1224         NTSTATUS (*get_dos_attributes_recv_fn)(
1225                                 struct tevent_req *req,
1226                                 struct vfs_aio_state *aio_state,
1227                                 uint32_t *dosmode);
1228
1229         /* NT ACL operations. */
1230
1231         NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
1232                                    struct files_struct *fsp,
1233                                    uint32_t security_info,
1234                                    TALLOC_CTX *mem_ctx,
1235                                    struct security_descriptor **ppdesc);
1236         NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
1237                                    struct files_struct *fsp,
1238                                    uint32_t security_info_sent,
1239                                    const struct security_descriptor *psd);
1240
1241         NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
1242                                   struct smb_filename *file,
1243                                   struct security_acl *sacl,
1244                                   uint32_t access_requested,
1245                                   uint32_t access_denied);
1246
1247         /* POSIX ACL operations. */
1248
1249         SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
1250                                        struct files_struct *fsp,
1251                                        SMB_ACL_TYPE_T type,
1252                                        TALLOC_CTX *mem_ctx);
1253         int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
1254                                       TALLOC_CTX *mem_ctx, char **blob_description,
1255                                       DATA_BLOB *blob);
1256         int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle,
1257                                  struct files_struct *fsp,
1258                                  SMB_ACL_TYPE_T type,
1259                                  SMB_ACL_T theacl);
1260         int (*sys_acl_delete_def_fd_fn)(struct vfs_handle_struct *handle,
1261                                         struct files_struct *fsp);
1262
1263         /* EA operations. */
1264         struct tevent_req *(*getxattrat_send_fn)(
1265                                 TALLOC_CTX *mem_ctx,
1266                                 struct tevent_context *ev,
1267                                 struct vfs_handle_struct *handle,
1268                                 files_struct *dir_fsp,
1269                                 const struct smb_filename *smb_fname,
1270                                 const char *xattr_name,
1271                                 size_t alloc_hint);
1272         ssize_t (*getxattrat_recv_fn)(struct tevent_req *req,
1273                                       struct vfs_aio_state *aio_state,
1274                                       TALLOC_CTX *mem_ctx,
1275                                       uint8_t **xattr_value);
1276         ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
1277         ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
1278         int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
1279         int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
1280
1281         /* aio operations */
1282         bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
1283
1284         /* durable handle operations */
1285         NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
1286                                       struct files_struct *fsp,
1287                                       TALLOC_CTX *mem_ctx,
1288                                       DATA_BLOB *cookie);
1289         NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
1290                                           struct files_struct *fsp,
1291                                           const DATA_BLOB old_cookie,
1292                                           TALLOC_CTX *mem_ctx,
1293                                           DATA_BLOB *new_cookie);
1294         NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
1295                                          struct smb_request *smb1req,
1296                                          struct smbXsrv_open *op,
1297                                          const DATA_BLOB old_cookie,
1298                                          TALLOC_CTX *mem_ctx,
1299                                          struct files_struct **fsp,
1300                                          DATA_BLOB *new_cookie);
1301
1302         NTSTATUS (*freaddir_attr_fn)(struct vfs_handle_struct *handle,
1303                                      struct files_struct *fsp,
1304                                      TALLOC_CTX *mem_ctx,
1305                                      struct readdir_attr_data **attr_data);
1306 };
1307
1308 /*
1309     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1310     which describes all operations this module is willing to intercept.
1311     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1312     using this information.
1313 */
1314
1315 typedef struct vfs_handle_struct {
1316         struct vfs_handle_struct  *next, *prev;
1317         const char *param;
1318         struct connection_struct *conn;
1319         const struct vfs_fn_pointers *fns;
1320         void *data;
1321         void (*free_data)(void **data);
1322 } vfs_handle_struct;
1323
1324
1325 struct vfs_statvfs_struct {
1326         /* For undefined recommended transfer size return -1 in that field */
1327         uint32_t OptimalTransferSize;  /* bsize on some os, iosize on other os */
1328         uint32_t BlockSize;
1329
1330         /*
1331          The next three fields are in terms of the block size.
1332          (above). If block size is unknown, 4096 would be a
1333          reasonable block size for a server to report.
1334          Note that returning the blocks/blocksavail removes need
1335          to make a second call (to QFSInfo level 0x103 to get this info.
1336          UserBlockAvail is typically less than or equal to BlocksAvail,
1337          if no distinction is made return the same value in each.
1338         */
1339
1340         uint64_t TotalBlocks;
1341         uint64_t BlocksAvail;       /* bfree */
1342         uint64_t UserBlocksAvail;   /* bavail */
1343
1344         /* For undefined Node fields or FSID return -1 */
1345         uint64_t TotalFileNodes;
1346         uint64_t FreeFileNodes;
1347         uint64_t FsIdentifier;   /* fsid */
1348         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1349         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
1350
1351         int FsCapabilities;
1352 };
1353
1354 /* Add a new FSP extension of the given type. Returns a pointer to the
1355  * extension data.
1356  */
1357 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn)            \
1358     (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1359
1360 /* Return a pointer to the existing FSP extension data. */
1361 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1362     vfs_fetch_fsp_extension(handle, (fsp))
1363
1364 /* Return the talloc context associated with an FSP extension. */
1365 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1366     vfs_memctx_fsp_extension(handle, (fsp))
1367
1368 /* Remove and destroy an FSP extension. */
1369 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1370     vfs_remove_fsp_extension((handle), (fsp))
1371
1372 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1373         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1374                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1375                 ret; \
1376         } \
1377 }
1378
1379 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1380         if (!(handle)) { \
1381                 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1382                 ret; \
1383         } else { \
1384                 if ((handle)->free_data) { \
1385                         (handle)->free_data(&(handle)->data); \
1386                 } \
1387                 (handle)->data = (void *)datap; \
1388                 (handle)->free_data = free_fn; \
1389         } \
1390 }
1391
1392 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1393         if ((handle) && (handle)->free_data) { \
1394                 (handle)->free_data(&(handle)->data); \
1395         } \
1396 }
1397
1398 /* Check whether module-specific data handle was already allocated or not */
1399 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
1400
1401 #define SMB_VFS_OP(x) ((void *) x)
1402
1403 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1404
1405 #include "vfs_macros.h"
1406
1407 struct smb_vfs_deny_state {
1408         struct smb_vfs_deny_state *parent;
1409         const char *location;
1410 };
1411
1412 void smb_vfs_assert_allowed(void);
1413
1414 void _smb_vfs_deny_push(struct smb_vfs_deny_state *state, const char *location);
1415 #define smb_vfs_deny_push(__state) _smb_vfs_deny_push(__state, __location__);
1416 void _smb_vfs_deny_pop(struct smb_vfs_deny_state *state, const char *location);
1417 #define smb_vfs_deny_pop(__state) _smb_vfs_deny_pop(__state, __location__);
1418
1419 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1420                          const char *service, const char *user);
1421 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1422 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1423                                 const struct smb_filename *smb_filename,
1424                                 uint64_t *bsize,
1425                                 uint64_t *dfree,
1426                                 uint64_t *dsize);
1427 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1428                                 const struct smb_filename *smb_filename,
1429                                 enum SMB_QUOTA_TYPE qtype,
1430                                 unid_t id,
1431                                 SMB_DISK_QUOTA *qt);
1432 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1433                            enum SMB_QUOTA_TYPE qtype, unid_t id,
1434                            SMB_DISK_QUOTA *qt);
1435 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1436                                       struct files_struct *fsp,
1437                                       struct shadow_copy_data *shadow_copy_data,
1438                                       bool labels);
1439 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1440                         const struct smb_filename *smb_fname,
1441                         struct vfs_statvfs_struct *statbuf);
1442 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1443                                       enum timestamp_set_resolution *p_ts_res);
1444 /*
1445  * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1446  */
1447 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1448                                         struct dfs_GetDFSReferral *r);
1449 NTSTATUS smb_vfs_call_create_dfs_pathat(struct vfs_handle_struct *handle,
1450                                 struct files_struct *dirfsp,
1451                                 const struct smb_filename *smb_fname,
1452                                 const struct referral *reflist,
1453                                 size_t referral_count);
1454 NTSTATUS smb_vfs_call_read_dfs_pathat(struct vfs_handle_struct *handle,
1455                                 TALLOC_CTX *mem_ctx,
1456                                 struct files_struct *dirfsp,
1457                                 struct smb_filename *smb_fname,
1458                                 struct referral **ppreflist,
1459                                 size_t *preferral_count);
1460 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1461                                         struct files_struct *fsp,
1462                                         const char *mask,
1463                                         uint32_t attributes);
1464 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1465                                     struct files_struct *dirfsp,
1466                                     DIR *dirp);
1467 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1468                              DIR *dirp);
1469 int smb_vfs_call_mkdirat(struct vfs_handle_struct *handle,
1470                         struct files_struct *dirfsp,
1471                         const struct smb_filename *smb_fname,
1472                         mode_t mode);
1473 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1474                           DIR *dir);
1475 int smb_vfs_call_openat(struct vfs_handle_struct *handle,
1476                         const struct files_struct *dirfsp,
1477                         const struct smb_filename *smb_fname,
1478                         struct files_struct *fsp,
1479                         const struct vfs_open_how *how);
1480 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1481                                   struct smb_request *req,
1482                                   struct files_struct *dirfsp,
1483                                   struct smb_filename *smb_fname,
1484                                   uint32_t access_mask,
1485                                   uint32_t share_access,
1486                                   uint32_t create_disposition,
1487                                   uint32_t create_options,
1488                                   uint32_t file_attributes,
1489                                   uint32_t oplock_request,
1490                                   const struct smb2_lease *lease,
1491                                   uint64_t allocation_size,
1492                                   uint32_t private_flags,
1493                                   struct security_descriptor *sd,
1494                                   struct ea_list *ea_list,
1495                                   files_struct **result,
1496                                   int *pinfo,
1497                                   const struct smb2_create_blobs *in_context_blobs,
1498                                   struct smb2_create_blobs *out_context_blobs);
1499 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1500                        struct files_struct *fsp);
1501 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1502                            struct files_struct *fsp, void *data, size_t n,
1503                            off_t offset);
1504 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1505                                            TALLOC_CTX *mem_ctx,
1506                                            struct tevent_context *ev,
1507                                            struct files_struct *fsp,
1508                                            void *data,
1509                                            size_t n, off_t offset);
1510 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1511
1512 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1513                             struct files_struct *fsp, const void *data,
1514                             size_t n, off_t offset);
1515 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1516                                             TALLOC_CTX *mem_ctx,
1517                                             struct tevent_context *ev,
1518                                             struct files_struct *fsp,
1519                                             const void *data,
1520                                             size_t n, off_t offset);
1521 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1522
1523 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1524                              struct files_struct *fsp, off_t offset,
1525                              int whence);
1526 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1527                               files_struct *fromfsp, const DATA_BLOB *header,
1528                               off_t offset, size_t count);
1529 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1530                               files_struct *tofsp, off_t offset,
1531                               size_t count);
1532 int smb_vfs_call_renameat(struct vfs_handle_struct *handle,
1533                         struct files_struct *srcfsp,
1534                         const struct smb_filename *smb_fname_src,
1535                         struct files_struct *dstfsp,
1536                         const struct smb_filename *smb_fname_dst);
1537
1538 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1539                                            TALLOC_CTX *mem_ctx,
1540                                            struct tevent_context *ev,
1541                                            struct files_struct *fsp);
1542 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1543
1544 int smb_vfs_fsync_sync(files_struct *fsp);
1545 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1546                       struct smb_filename *smb_fname);
1547 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1548                        struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1549 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1550                        struct smb_filename *smb_filename);
1551 int smb_vfs_call_fstatat(
1552         struct vfs_handle_struct *handle,
1553         const struct files_struct *dirfsp,
1554         const struct smb_filename *smb_fname,
1555         SMB_STRUCT_STAT *sbuf,
1556         int flags);
1557 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1558                                      struct files_struct *fsp,
1559                                      const SMB_STRUCT_STAT *sbuf);
1560 int smb_vfs_call_unlinkat(struct vfs_handle_struct *handle,
1561                         struct files_struct *dirfsp,
1562                         const struct smb_filename *smb_fname,
1563                         int flags);
1564 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1565                         struct files_struct *fsp, mode_t mode);
1566 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1567                         struct files_struct *fsp, uid_t uid, gid_t gid);
1568 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1569                         const struct smb_filename *smb_fname,
1570                         uid_t uid,
1571                         gid_t gid);
1572 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1573                         const struct smb_filename *smb_fname);
1574 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1575                                 TALLOC_CTX *ctx);
1576 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1577                         const struct smb_filename *smb_fname,
1578                         struct smb_file_time *ft);
1579 int smb_vfs_call_fntimes(struct vfs_handle_struct *handle,
1580                          struct files_struct *fsp,
1581                          struct smb_file_time *ft);
1582 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1583                            struct files_struct *fsp, off_t offset);
1584 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1585                            struct files_struct *fsp,
1586                            uint32_t mode,
1587                            off_t offset,
1588                            off_t len);
1589 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1590                        struct files_struct *fsp, int op, off_t offset,
1591                        off_t count, int type);
1592 int smb_vfs_call_filesystem_sharemode(struct vfs_handle_struct *handle,
1593                                       struct files_struct *fsp,
1594                                       uint32_t share_access,
1595                                       uint32_t access_mask);
1596 int smb_vfs_call_fcntl(struct vfs_handle_struct *handle,
1597                        struct files_struct *fsp, int cmd, ...);
1598 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1599                                 struct files_struct *fsp, int leasetype);
1600 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1601                           struct files_struct *fsp, off_t *poffset,
1602                           off_t *pcount, int *ptype, pid_t *ppid);
1603 int smb_vfs_call_symlinkat(struct vfs_handle_struct *handle,
1604                         const struct smb_filename *link_contents,
1605                         struct files_struct *dirfsp,
1606                         const struct smb_filename *new_smb_fname);
1607 int smb_vfs_call_readlinkat(struct vfs_handle_struct *handle,
1608                         const struct files_struct *dirfsp,
1609                         const struct smb_filename *smb_fname,
1610                         char *buf,
1611                         size_t bufsiz);
1612 int smb_vfs_call_linkat(struct vfs_handle_struct *handle,
1613                         struct files_struct *srcfsp,
1614                         const struct smb_filename *old_smb_fname,
1615                         struct files_struct *dstfsp,
1616                         const struct smb_filename *new_smb_fname,
1617                         int flags);
1618 int smb_vfs_call_mknodat(struct vfs_handle_struct *handle,
1619                         struct files_struct *dirfsp,
1620                         const struct smb_filename *smb_fname,
1621                         mode_t mode,
1622                         SMB_DEV_T dev);
1623 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1624                         TALLOC_CTX *ctx,
1625                         const struct smb_filename *smb_fname);
1626 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1627                         const struct smb_filename *smb_fname,
1628                         unsigned int flags);
1629 int smb_vfs_call_fchflags(struct vfs_handle_struct *handle,
1630                         struct files_struct *fsp,
1631                         unsigned int flags);
1632 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1633                                            const SMB_STRUCT_STAT *sbuf);
1634 uint64_t smb_vfs_call_fs_file_id(struct vfs_handle_struct *handle,
1635                                  const SMB_STRUCT_STAT *sbuf);
1636 NTSTATUS smb_vfs_call_fstreaminfo(struct vfs_handle_struct *handle,
1637                                   struct files_struct *fsp,
1638                                   TALLOC_CTX *mem_ctx,
1639                                   unsigned int *num_streams,
1640                                   struct stream_struct **streams);
1641 NTSTATUS smb_vfs_call_get_real_filename_at(struct vfs_handle_struct *handle,
1642                                            struct files_struct *dirfsp,
1643                                            const char *name,
1644                                            TALLOC_CTX *mem_ctx,
1645                                            char **found_name);
1646 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1647                                  const struct files_struct *dirfsp,
1648                                  const struct smb_filename *smb_fname);
1649 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1650                                        struct byte_range_lock *br_lck,
1651                                        struct lock_struct *plock);
1652 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1653                                      struct byte_range_lock *br_lck,
1654                                      const struct lock_struct *plock);
1655 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1656                                     struct files_struct *fsp,
1657                                     struct lock_struct *plock);
1658 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1659                                      const char *name,
1660                                      enum vfs_translate_direction direction,
1661                                      TALLOC_CTX *mem_ctx,
1662                                      char **mapped_name);
1663 NTSTATUS smb_vfs_call_parent_pathname(struct vfs_handle_struct *handle,
1664                                       TALLOC_CTX *mem_ctx,
1665                                       const struct smb_filename *smb_fname_in,
1666                                       struct smb_filename **parent_dir_out,
1667                                       struct smb_filename **atname_out);
1668 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1669                             struct files_struct *fsp,
1670                             TALLOC_CTX *ctx,
1671                             uint32_t function,
1672                             uint16_t req_flags,
1673                             const uint8_t *_in_data,
1674                             uint32_t in_len,
1675                             uint8_t **_out_data,
1676                             uint32_t max_out_len,
1677                             uint32_t *out_len);
1678 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1679                                           struct files_struct *fsp,
1680                                           uint32_t *dosmode);
1681 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1682                                           struct files_struct *fsp,
1683                                           uint32_t dosmode);
1684 struct tevent_req *smb_vfs_call_get_dos_attributes_send(
1685                         TALLOC_CTX *mem_ctx,
1686                         struct tevent_context *ev,
1687                         struct vfs_handle_struct *handle,
1688                         files_struct *dir_fsp,
1689                         struct smb_filename *smb_fname);
1690 NTSTATUS smb_vfs_call_get_dos_attributes_recv(
1691                         struct tevent_req *req,
1692                         struct vfs_aio_state *aio_state,
1693                         uint32_t *dosmode);
1694 struct tevent_req *smb_vfs_call_offload_read_send(
1695         TALLOC_CTX *mem_ctx,
1696         struct tevent_context *ev,
1697         struct vfs_handle_struct *handle,
1698         struct files_struct *fsp,
1699         uint32_t fsctl,
1700         uint32_t ttl,
1701         off_t offset,
1702         size_t to_copy);
1703 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1704                                         struct vfs_handle_struct *handle,
1705                                         TALLOC_CTX *mem_ctx,
1706                                         uint32_t *flags,
1707                                         uint64_t *xferlen,
1708                                         DATA_BLOB *token_blob);
1709 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1710                                                    TALLOC_CTX *mem_ctx,
1711                                                    struct tevent_context *ev,
1712                                                    uint32_t fsctl,
1713                                                    DATA_BLOB *token,
1714                                                    off_t transfer_offset,
1715                                                    struct files_struct *dest_fsp,
1716                                                    off_t dest_off,
1717                                                    off_t num);
1718 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1719                                          struct tevent_req *req,
1720                                          off_t *copied);
1721 NTSTATUS smb_vfs_call_fget_compression(struct vfs_handle_struct *handle,
1722                                       TALLOC_CTX *mem_ctx,
1723                                       struct files_struct *fsp,
1724                                       uint16_t *_compression_fmt);
1725 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1726                                       TALLOC_CTX *mem_ctx,
1727                                       struct files_struct *fsp,
1728                                       uint16_t compression_fmt);
1729 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1730                                       TALLOC_CTX *mem_ctx,
1731                                       const char *service_path,
1732                                       char **base_volume);
1733 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1734                                   TALLOC_CTX *mem_ctx,
1735                                   const char *base_volume,
1736                                   time_t *tstamp,
1737                                   bool rw,
1738                                   char **base_path,
1739                                   char **snap_path);
1740 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1741                                   TALLOC_CTX *mem_ctx,
1742                                   char *base_path,
1743                                   char *snap_path);
1744 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1745                                   struct files_struct *fsp,
1746                                   uint32_t security_info,
1747                                   TALLOC_CTX *mem_ctx,
1748                                   struct security_descriptor **ppdesc);
1749 NTSTATUS smb_vfs_call_get_nt_acl_at(struct vfs_handle_struct *handle,
1750                                 struct files_struct *dirfsp,
1751                                 const struct smb_filename *smb_fname,
1752                                 uint32_t security_info,
1753                                 TALLOC_CTX *mem_ctx,
1754                                 struct security_descriptor **ppdesc);
1755 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1756                                   struct files_struct *fsp,
1757                                   uint32_t security_info_sent,
1758                                   const struct security_descriptor *psd);
1759 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1760                                  struct smb_filename *file,
1761                                  struct security_acl *sacl,
1762                                  uint32_t access_requested,
1763                                  uint32_t access_denied);
1764 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1765                                 const struct smb_filename *file,
1766                                 mode_t mode);
1767 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1768                                       struct files_struct *fsp,
1769                                       SMB_ACL_TYPE_T type,
1770                                       TALLOC_CTX *mem_ctx);
1771 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1772                                      struct files_struct *fsp,
1773                                      TALLOC_CTX *mem_ctx,
1774                                      char **blob_description,
1775                                      DATA_BLOB *blob);
1776 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1777                                 struct files_struct *fsp,
1778                                 SMB_ACL_TYPE_T type,
1779                                 SMB_ACL_T theacl);
1780 int smb_vfs_call_sys_acl_delete_def_fd(struct vfs_handle_struct *handle,
1781                                 struct files_struct *fsp);
1782 struct tevent_req *smb_vfs_call_getxattrat_send(
1783                         TALLOC_CTX *mem_ctx,
1784                         struct tevent_context *ev,
1785                         struct vfs_handle_struct *handle,
1786                         files_struct *dir_fsp,
1787                         const struct smb_filename *smb_fname,
1788                         const char *xattr_name,
1789                         size_t alloc_hint);
1790 ssize_t smb_vfs_call_getxattrat_recv(struct tevent_req *req,
1791                                      struct vfs_aio_state *aio_state,
1792                                      TALLOC_CTX *mem_ctx,
1793                                      uint8_t **xattr_value);
1794 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1795                                struct files_struct *fsp, const char *name,
1796                                void *value, size_t size);
1797 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1798                                 struct files_struct *fsp, char *list,
1799                                 size_t size);
1800 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1801                               struct files_struct *fsp, const char *name);
1802 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1803                            const char *name, const void *value, size_t size,
1804                            int flags);
1805 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1806                            struct files_struct *fsp, const char *name,
1807                            const void *value, size_t size, int flags);
1808 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1809                             struct files_struct *fsp);
1810 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1811                                      struct files_struct *fsp,
1812                                      TALLOC_CTX *mem_ctx,
1813                                      DATA_BLOB *cookie);
1814 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1815                                          struct files_struct *fsp,
1816                                          const DATA_BLOB old_cookie,
1817                                          TALLOC_CTX *mem_ctx,
1818                                          DATA_BLOB *new_cookie);
1819 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1820                                         struct smb_request *smb1req,
1821                                         struct smbXsrv_open *op,
1822                                         const DATA_BLOB old_cookie,
1823                                         TALLOC_CTX *mem_ctx,
1824                                         struct files_struct **fsp,
1825                                         DATA_BLOB *new_cookie);
1826 NTSTATUS smb_vfs_call_freaddir_attr(struct vfs_handle_struct *handle,
1827                                     struct files_struct *fsp,
1828                                     TALLOC_CTX *mem_ctx,
1829                                     struct readdir_attr_data **attr_data);
1830
1831 NTSTATUS smb_register_vfs(int version, const char *name,
1832                           const struct vfs_fn_pointers *fns);
1833 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1834                                    files_struct *fsp, size_t ext_size,
1835                                    void (*destroy_fn)(void *p_data));
1836 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1837 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1838 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle,
1839                                const struct files_struct *fsp);
1840 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, const struct files_struct *fsp);
1841
1842 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1843                             const char *module);
1844
1845 /*
1846  * Helper functions from source3/modules/vfs_not_implemented.c
1847  */
1848 int vfs_not_implemented_connect(
1849                         vfs_handle_struct *handle,
1850                         const char *service,
1851                         const char *user);
1852 void vfs_not_implemented_disconnect(vfs_handle_struct *handle);
1853 uint64_t vfs_not_implemented_disk_free(vfs_handle_struct *handle,
1854                                 const struct smb_filename *smb_fname,
1855                                 uint64_t *bsize,
1856                                 uint64_t *dfree,
1857                                 uint64_t *dsize);
1858 int vfs_not_implemented_get_quota(vfs_handle_struct *handle,
1859                                 const struct smb_filename *smb_fname,
1860                                 enum SMB_QUOTA_TYPE qtype,
1861                                 unid_t id,
1862                                 SMB_DISK_QUOTA *dq);
1863 int vfs_not_implemented_set_quota(vfs_handle_struct *handle,
1864                                   enum SMB_QUOTA_TYPE qtype,
1865                                   unid_t id, SMB_DISK_QUOTA *dq);
1866 int vfs_not_implemented_get_shadow_copy_data(vfs_handle_struct *handle,
1867                                 files_struct *fsp,
1868                                 struct shadow_copy_data *shadow_copy_data,
1869                                 bool labels);
1870 int vfs_not_implemented_statvfs(struct vfs_handle_struct *handle,
1871                                 const struct smb_filename *smb_fname,
1872                                 struct vfs_statvfs_struct *statbuf);
1873 uint32_t vfs_not_implemented_fs_capabilities(struct vfs_handle_struct *handle,
1874                                 enum timestamp_set_resolution *p_ts_res);
1875 NTSTATUS vfs_not_implemented_get_dfs_referrals(struct vfs_handle_struct *handle,
1876                                                struct dfs_GetDFSReferral *r);
1877 NTSTATUS vfs_not_implemented_create_dfs_pathat(struct vfs_handle_struct *handle,
1878                                 struct files_struct *dirfsp,
1879                                 const struct smb_filename *smb_fname,
1880                                 const struct referral *reflist,
1881                                 size_t referral_count);
1882 NTSTATUS vfs_not_implemented_read_dfs_pathat(struct vfs_handle_struct *handle,
1883                                 TALLOC_CTX *mem_ctx,
1884                                 struct files_struct *dirfsp,
1885                                 struct smb_filename *smb_fname,
1886                                 struct referral **ppreflist,
1887                                 size_t *preferral_count);
1888 NTSTATUS vfs_not_implemented_snap_check_path(struct vfs_handle_struct *handle,
1889                                 TALLOC_CTX *mem_ctx,
1890                                 const char *service_path,
1891                                 char **base_volume);
1892 NTSTATUS vfs_not_implemented_snap_create(struct vfs_handle_struct *handle,
1893                                          TALLOC_CTX *mem_ctx,
1894                                          const char *base_volume,
1895                                          time_t *tstamp,
1896                                          bool rw,
1897                                          char **base_path,
1898                                          char **snap_path);
1899 NTSTATUS vfs_not_implemented_snap_delete(struct vfs_handle_struct *handle,
1900                                          TALLOC_CTX *mem_ctx,
1901                                          char *base_path,
1902                                          char *snap_path);
1903 DIR *vfs_not_implemented_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
1904                                    const char *mask, uint32_t attr);
1905 struct dirent *vfs_not_implemented_readdir(vfs_handle_struct *handle,
1906                                            struct files_struct *dirfsp,
1907                                            DIR *dirp);
1908 void vfs_not_implemented_rewind_dir(vfs_handle_struct *handle, DIR *dirp);
1909 int vfs_not_implemented_mkdirat(vfs_handle_struct *handle,
1910                 struct files_struct *dirfsp,
1911                 const struct smb_filename *smb_fname,
1912                 mode_t mode);
1913 int vfs_not_implemented_closedir(vfs_handle_struct *handle, DIR *dir);
1914 int vfs_not_implemented_open(vfs_handle_struct *handle,
1915                              struct smb_filename *smb_fname,
1916                              files_struct *fsp, int flags, mode_t mode);
1917 int vfs_not_implemented_openat(vfs_handle_struct *handle,
1918                                const struct files_struct *dirfsp,
1919                                const struct smb_filename *smb_fname,
1920                                struct files_struct *fsp,
1921                                const struct vfs_open_how *how);
1922 NTSTATUS vfs_not_implemented_create_file(struct vfs_handle_struct *handle,
1923                                 struct smb_request *req,
1924                                 struct files_struct *dirfsp,
1925                                 struct smb_filename *smb_fname,
1926                                 uint32_t access_mask,
1927                                 uint32_t share_access,
1928                                 uint32_t create_disposition,
1929                                 uint32_t create_options,
1930                                 uint32_t file_attributes,
1931                                 uint32_t oplock_request,
1932                                 const struct smb2_lease *lease,
1933                                 uint64_t allocation_size,
1934                                 uint32_t private_flags,
1935                                 struct security_descriptor *sd,
1936                                 struct ea_list *ea_list,
1937                                 files_struct **result, int *pinfo,
1938                                 const struct smb2_create_blobs *in_context_blobs,
1939                                 struct smb2_create_blobs *out_context_blobs);
1940 int vfs_not_implemented_close_fn(vfs_handle_struct *handle, files_struct *fsp);
1941 ssize_t vfs_not_implemented_pread(vfs_handle_struct *handle, files_struct *fsp,
1942                                   void *data, size_t n, off_t offset);
1943 struct tevent_req *vfs_not_implemented_pread_send(struct vfs_handle_struct *handle,
1944                                                   TALLOC_CTX *mem_ctx,
1945                                                   struct tevent_context *ev,
1946                                                   struct files_struct *fsp,
1947                                                   void *data, size_t n, off_t offset);
1948 ssize_t vfs_not_implemented_pread_recv(struct tevent_req *req,
1949                                        struct vfs_aio_state *vfs_aio_state);
1950 ssize_t vfs_not_implemented_pwrite(vfs_handle_struct *handle, files_struct *fsp,
1951                                    const void *data, size_t n, off_t offset);
1952 struct tevent_req *vfs_not_implemented_pwrite_send(struct vfs_handle_struct *handle,
1953                                                    TALLOC_CTX *mem_ctx,
1954                                                    struct tevent_context *ev,
1955                                                    struct files_struct *fsp,
1956                                                    const void *data,
1957                                                    size_t n, off_t offset);
1958 ssize_t vfs_not_implemented_pwrite_recv(struct tevent_req *req,
1959                                 struct vfs_aio_state *vfs_aio_state);
1960 off_t vfs_not_implemented_lseek(vfs_handle_struct *handle, files_struct *fsp,
1961                         off_t offset, int whence);
1962 ssize_t vfs_not_implemented_sendfile(vfs_handle_struct *handle, int tofd,
1963                                      files_struct *fromfsp, const DATA_BLOB *hdr,
1964                                      off_t offset, size_t n);
1965 ssize_t vfs_not_implemented_recvfile(vfs_handle_struct *handle, int fromfd,
1966                                      files_struct *tofsp, off_t offset, size_t n);
1967 int vfs_not_implemented_renameat(vfs_handle_struct *handle,
1968                                files_struct *srcfsp,
1969                                const struct smb_filename *smb_fname_src,
1970                                files_struct *dstfsp,
1971                                const struct smb_filename *smb_fname_dst);
1972 struct tevent_req *vfs_not_implemented_fsync_send(struct vfs_handle_struct *handle,
1973                                                   TALLOC_CTX *mem_ctx,
1974                                                   struct tevent_context *ev,
1975                                                   struct files_struct *fsp);
1976 int vfs_not_implemented_fsync_recv(struct tevent_req *req,
1977                                    struct vfs_aio_state *vfs_aio_state);
1978 int vfs_not_implemented_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname);
1979 int vfs_not_implemented_fstat(vfs_handle_struct *handle, files_struct *fsp,
1980                         SMB_STRUCT_STAT *sbuf);
1981 int vfs_not_implemented_lstat(vfs_handle_struct *handle,
1982                               struct smb_filename *smb_fname);
1983 int vfs_not_implemented_fstatat(
1984         struct vfs_handle_struct *handle,
1985         const struct files_struct *dirfsp,
1986         const struct smb_filename *smb_fname,
1987         SMB_STRUCT_STAT *sbuf,
1988         int flags);
1989 uint64_t vfs_not_implemented_get_alloc_size(struct vfs_handle_struct *handle,
1990                                             struct files_struct *fsp,
1991                                             const SMB_STRUCT_STAT *sbuf);
1992 int vfs_not_implemented_unlinkat(vfs_handle_struct *handle,
1993                                 struct files_struct *dirfsp,
1994                                 const struct smb_filename *smb_fname,
1995                                 int flags);
1996 int vfs_not_implemented_fchmod(vfs_handle_struct *handle, files_struct *fsp,
1997                                mode_t mode);
1998 int vfs_not_implemented_fchown(vfs_handle_struct *handle, files_struct *fsp,
1999                                uid_t uid, gid_t gid);
2000 int vfs_not_implemented_lchown(vfs_handle_struct *handle,
2001                                const struct smb_filename *smb_fname,
2002                                uid_t uid,
2003                                gid_t gid);
2004 int vfs_not_implemented_chdir(vfs_handle_struct *handle,
2005                               const struct smb_filename *smb_fname);
2006 struct smb_filename *vfs_not_implemented_getwd(vfs_handle_struct *handle,
2007                                                TALLOC_CTX *ctx);
2008 int vfs_not_implemented_ntimes(vfs_handle_struct *handle,
2009                                const struct smb_filename *smb_fname,
2010                                struct smb_file_time *ft);
2011 int vfs_not_implemented_fntimes(vfs_handle_struct *handle,
2012                                 files_struct *fsp,
2013                                 struct smb_file_time *ft);
2014 int vfs_not_implemented_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
2015                                   off_t offset);
2016 int vfs_not_implemented_fallocate(vfs_handle_struct *handle, files_struct *fsp,
2017                                   uint32_t mode, off_t offset, off_t len);
2018 bool vfs_not_implemented_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
2019                               off_t offset, off_t count, int type);
2020 int vfs_not_implemented_filesystem_sharemode(struct vfs_handle_struct *handle,
2021                                              struct files_struct *fsp,
2022                                              uint32_t share_access,
2023                                              uint32_t access_mask);
2024 int vfs_not_implemented_fcntl(struct vfs_handle_struct *handle,
2025                               struct files_struct *fsp, int cmd, va_list cmd_arg);
2026 int vfs_not_implemented_linux_setlease(struct vfs_handle_struct *handle,
2027                                        struct files_struct *fsp, int leasetype);
2028 bool vfs_not_implemented_getlock(vfs_handle_struct *handle, files_struct *fsp,
2029                                  off_t *poffset, off_t *pcount, int *ptype,
2030                                  pid_t *ppid);
2031 int vfs_not_implemented_symlinkat(vfs_handle_struct *handle,
2032                                 const struct smb_filename *link_contents,
2033                                 struct files_struct *dirfsp,
2034                                 const struct smb_filename *new_smb_fname);
2035 int vfs_not_implemented_vfs_readlinkat(vfs_handle_struct *handle,
2036                         const struct files_struct *dirfsp,
2037                         const struct smb_filename *smb_fname,
2038                         char *buf,
2039                         size_t bufsiz);
2040 int vfs_not_implemented_linkat(vfs_handle_struct *handle,
2041                         struct files_struct *srcfsp,
2042                         const struct smb_filename *old_smb_fname,
2043                         struct files_struct *dstfsp,
2044                         const struct smb_filename *new_smb_fname,
2045                         int flags);
2046 int vfs_not_implemented_mknodat(vfs_handle_struct *handle,
2047                         struct files_struct *dirfsp,
2048                         const struct smb_filename *smb_fname,
2049                         mode_t mode,
2050                         SMB_DEV_T dev);
2051 struct smb_filename *vfs_not_implemented_realpath(vfs_handle_struct *handle,
2052                                                   TALLOC_CTX *ctx,
2053                                                   const struct smb_filename *smb_fname);
2054 int vfs_not_implemented_chflags(vfs_handle_struct *handle,
2055                                 const struct smb_filename *smb_fname,
2056                                 uint flags);
2057 int vfs_not_implemented_fchflags(vfs_handle_struct *handle,
2058                                 struct files_struct *fst,
2059                                 uint flags);
2060 struct file_id vfs_not_implemented_file_id_create(vfs_handle_struct *handle,
2061                                                   const SMB_STRUCT_STAT *sbuf);
2062 uint64_t vfs_not_implemented_fs_file_id(vfs_handle_struct *handle,
2063                                         const SMB_STRUCT_STAT *sbuf);
2064 struct tevent_req *vfs_not_implemented_offload_read_send(
2065                         TALLOC_CTX *mem_ctx,
2066                         struct tevent_context *ev,
2067                         struct vfs_handle_struct *handle,
2068                         struct files_struct *fsp,
2069                         uint32_t fsctl,
2070                         uint32_t ttl,
2071                         off_t offset,
2072                         size_t to_copy);
2073 NTSTATUS vfs_not_implemented_offload_read_recv(struct tevent_req *req,
2074                                        struct vfs_handle_struct *handle,
2075                                        TALLOC_CTX *mem_ctx,
2076                                        uint32_t *flags,
2077                                        uint64_t *xferlen,
2078                                        DATA_BLOB *_token_blob);
2079 struct tevent_req *vfs_not_implemented_offload_write_send(
2080                         struct vfs_handle_struct *handle,
2081                         TALLOC_CTX *mem_ctx,
2082                         struct tevent_context *ev,
2083                         uint32_t fsctl,
2084                         DATA_BLOB *token,
2085                         off_t transfer_offset,
2086                         struct files_struct *dest_fsp,
2087                         off_t dest_off,
2088                         off_t num);
2089 NTSTATUS vfs_not_implemented_offload_write_recv(struct vfs_handle_struct *handle,
2090                                                 struct tevent_req *req,
2091                                                 off_t *copied);
2092 NTSTATUS vfs_not_implemented_fget_compression(struct vfs_handle_struct *handle,
2093                                              TALLOC_CTX *mem_ctx,
2094                                              struct files_struct *fsp,
2095                                              uint16_t *_compression_fmt);
2096 NTSTATUS vfs_not_implemented_set_compression(struct vfs_handle_struct *handle,
2097                                              TALLOC_CTX *mem_ctx,
2098                                              struct files_struct *fsp,
2099                                              uint16_t compression_fmt);
2100 NTSTATUS vfs_not_implemented_fstreaminfo(struct vfs_handle_struct *handle,
2101                                          struct files_struct *fsp,
2102                                          TALLOC_CTX *mem_ctx,
2103                                          unsigned int *num_streams,
2104                                          struct stream_struct **streams);
2105 NTSTATUS vfs_not_implemented_get_real_filename(
2106         struct vfs_handle_struct *handle,
2107         const struct smb_filename *path,
2108         const char *name,
2109         TALLOC_CTX *mem_ctx,
2110         char **found_name);
2111 NTSTATUS vfs_not_implemented_get_real_filename_at(
2112         struct vfs_handle_struct *handle,
2113         struct files_struct *dirfsp,
2114         const char *name,
2115         TALLOC_CTX *mem_ctx,
2116         char **found_name);
2117 const char *vfs_not_implemented_connectpath(
2118         struct vfs_handle_struct *handle,
2119         const struct files_struct *dirfsp,
2120         const struct smb_filename *smb_fname);
2121 NTSTATUS vfs_not_implemented_brl_lock_windows(struct vfs_handle_struct *handle,
2122                                               struct byte_range_lock *br_lck,
2123                                               struct lock_struct *plock);
2124 bool vfs_not_implemented_brl_unlock_windows(struct vfs_handle_struct *handle,
2125                                             struct byte_range_lock *br_lck,
2126                                             const struct lock_struct *plock);
2127 bool vfs_not_implemented_strict_lock_check(struct vfs_handle_struct *handle,
2128                                            struct files_struct *fsp,
2129                                            struct lock_struct *plock);
2130 NTSTATUS vfs_not_implemented_translate_name(struct vfs_handle_struct *handle,
2131                                             const char *mapped_name,
2132                                             enum vfs_translate_direction direction,
2133                                             TALLOC_CTX *mem_ctx, char **pmapped_name);
2134 NTSTATUS vfs_not_implemented_parent_pathname(struct vfs_handle_struct *handle,
2135                                              TALLOC_CTX *mem_ctx,
2136                                              const struct smb_filename *smb_fname_in,
2137                                              struct smb_filename **parent_dir_out,
2138                                              struct smb_filename **atname_out);
2139 NTSTATUS vfs_not_implemented_fsctl(struct vfs_handle_struct *handle,
2140                                    struct files_struct *fsp,
2141                                    TALLOC_CTX *ctx,
2142                                    uint32_t function,
2143                                    uint16_t req_flags,  /* Needed for UNICODE ... */
2144                                    const uint8_t *_in_data,
2145                                    uint32_t in_len,
2146                                    uint8_t **_out_data,
2147                                    uint32_t max_out_len, uint32_t *out_len);
2148 NTSTATUS vfs_not_implemented_freaddir_attr(struct vfs_handle_struct *handle,
2149                                            struct files_struct *dirfsp,
2150                                            TALLOC_CTX *mem_ctx,
2151                                            struct readdir_attr_data **pattr_data);
2152 struct tevent_req *vfs_not_implemented_get_dos_attributes_send(
2153                         TALLOC_CTX *mem_ctx,
2154                         struct tevent_context *ev,
2155                         struct vfs_handle_struct *handle,
2156                         files_struct *dir_fsp,
2157                         struct smb_filename *smb_fname);
2158 NTSTATUS vfs_not_implemented_get_dos_attributes_recv(
2159                         struct tevent_req *req,
2160                         struct vfs_aio_state *aio_state,
2161                         uint32_t *dosmode);
2162 NTSTATUS vfs_not_implemented_fget_dos_attributes(struct vfs_handle_struct *handle,
2163                                                  struct files_struct *fsp,
2164                                                  uint32_t *dosmode);
2165 NTSTATUS vfs_not_implemented_set_dos_attributes(struct vfs_handle_struct *handle,
2166                                                 const struct smb_filename *smb_fname,
2167                                                 uint32_t dosmode);
2168 NTSTATUS vfs_not_implemented_fset_dos_attributes(struct vfs_handle_struct *handle,
2169                                                  struct files_struct *fsp,
2170                                                  uint32_t dosmode);
2171 NTSTATUS vfs_not_implemented_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
2172                                          uint32_t security_info,
2173                                          TALLOC_CTX *mem_ctx,
2174                                          struct security_descriptor **ppdesc);
2175 NTSTATUS vfs_not_implemented_get_nt_acl_at(vfs_handle_struct *handle,
2176                         struct files_struct *dirfsp,
2177                         const struct smb_filename *smb_fname,
2178                         uint32_t security_info,
2179                         TALLOC_CTX *mem_ctx,
2180                         struct security_descriptor **ppdesc);
2181 NTSTATUS vfs_not_implemented_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
2182                                          uint32_t security_info_sent,
2183                                          const struct security_descriptor *psd);
2184 SMB_ACL_T vfs_not_implemented_sys_acl_get_fd(vfs_handle_struct *handle,
2185                                              files_struct *fsp,
2186                                              SMB_ACL_TYPE_T type,
2187                                              TALLOC_CTX *mem_ctx);
2188 int vfs_not_implemented_sys_acl_blob_get_fd(vfs_handle_struct *handle,
2189                                 files_struct *fsp, TALLOC_CTX *mem_ctx,
2190                                 char **blob_description, DATA_BLOB *blob);
2191 int vfs_not_implemented_sys_acl_set_fd(vfs_handle_struct *handle,
2192                                        struct files_struct *fsp,
2193                                        SMB_ACL_TYPE_T type,
2194                                        SMB_ACL_T theacl);
2195 int vfs_not_implemented_sys_acl_delete_def_fd(vfs_handle_struct *handle,
2196                                         files_struct *fsp);
2197 struct tevent_req *vfs_not_implemented_getxattrat_send(
2198                         TALLOC_CTX *mem_ctx,
2199                         struct tevent_context *ev,
2200                         struct vfs_handle_struct *handle,
2201                         files_struct *dir_fsp,
2202                         const struct smb_filename *smb_fname,
2203                         const char *xattr_name,
2204                         size_t alloc_hint);
2205 ssize_t vfs_not_implemented_getxattrat_recv(struct tevent_req *req,
2206                                     struct vfs_aio_state *aio_state,
2207                                     TALLOC_CTX *mem_ctx,
2208                                     uint8_t **xattr_value);
2209 ssize_t vfs_not_implemented_fgetxattr(vfs_handle_struct *handle,
2210                               struct files_struct *fsp, const char *name,
2211                               void *value, size_t size);
2212 ssize_t vfs_not_implemented_listxattr(vfs_handle_struct *handle,
2213                                       const struct smb_filename *smb_fname,
2214                                       char *list,
2215                                       size_t size);
2216 ssize_t vfs_not_implemented_flistxattr(vfs_handle_struct *handle,
2217                                        struct files_struct *fsp, char *list,
2218                                        size_t size);
2219 int vfs_not_implemented_fremovexattr(vfs_handle_struct *handle,
2220                                      struct files_struct *fsp, const char *name);
2221 int vfs_not_implemented_setxattr(vfs_handle_struct *handle,
2222                                  const struct smb_filename *smb_fname,
2223                                  const char *name,
2224                                  const void *value,
2225                                  size_t size,
2226                                  int flags);
2227 int vfs_not_implemented_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
2228                                   const char *name, const void *value, size_t size,
2229                                   int flags);
2230 bool vfs_not_implemented_aio_force(struct vfs_handle_struct *handle,
2231                                    struct files_struct *fsp);
2232 NTSTATUS vfs_not_implemented_audit_file(struct vfs_handle_struct *handle,
2233                                         struct smb_filename *file,
2234                                         struct security_acl *sacl,
2235                                         uint32_t access_requested,
2236                                         uint32_t access_denied);
2237 NTSTATUS vfs_not_implemented_durable_cookie(struct vfs_handle_struct *handle,
2238                                             struct files_struct *fsp,
2239                                             TALLOC_CTX *mem_ctx,
2240                                             DATA_BLOB *cookie);
2241 NTSTATUS vfs_not_implemented_durable_disconnect(struct vfs_handle_struct *handle,
2242                                                 struct files_struct *fsp,
2243                                                 const DATA_BLOB old_cookie,
2244                                                 TALLOC_CTX *mem_ctx,
2245                                                 DATA_BLOB *new_cookie);
2246 NTSTATUS vfs_not_implemented_durable_reconnect(struct vfs_handle_struct *handle,
2247                                                struct smb_request *smb1req,
2248                                                struct smbXsrv_open *op,
2249                                                const DATA_BLOB old_cookie,
2250                                                TALLOC_CTX *mem_ctx,
2251                                                struct files_struct **fsp,
2252                                                DATA_BLOB *new_cookie);
2253 #endif /* _VFS_H */