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 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
  50 /* Changed to version 3 for POSIX acl extensions. JRA. */
  51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
  52 /* Changed to version 5 for sendfile addition. JRA. */
  53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
  54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
  55 /* Changed to version 8 includes EA calls. JRA. */
  56 /* Changed to version 9 to include the get_shadow_data call. --metze */
  57 /* Changed to version 10 to include pread/pwrite calls. */
  58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
  59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
  60    Also include aio calls. JRA. */
  61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
  62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
  63 /* Changed to version 15 as we added the statvfs call. JRA */
  64 /* Changed to version 16 as we added the getlock call. JRA */
  65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
  66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
  67    Also include kernel_flock call - jmcd */
  68 /* Changed to version 19, kernel change notify has been merged
  69    Also included linux setlease call - jmcd */
  70 /* Changed to version 20, use ntimes call instead of utime (greater
  71  * timestamp resolition. JRA. */
  72 /* Changed to version21 to add chflags operation -- jpeach */
  73 /* Changed to version22 to add lchown operation -- jra */
  74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
  75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
  76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
  77 /* Leave at 22 - not yet released. Added recvfile. */
  78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
  79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
  80  * files_struct. - obnox.*/
  81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
  82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
  83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
  84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
  85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
  86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
  87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
  88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
  89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
  90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
  91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
  92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
  93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
  94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
  95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
  96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
  97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
  98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
  99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
 100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
 101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
 102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
 103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
 104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
 105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
 106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
 107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
 108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
 109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
 110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
 111    open handle. JRA. */
 112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
 113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
 114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
 115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
 116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
 117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
 118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
 119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
 120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
 121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
 122                            SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
 123                            SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES.  */
 124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
 125  *                         return to fs_capabilities call. JRA. */
 126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
 127                  UNIX names to Windows supported names -- asrinivasan. */
 128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
 129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
 130                  malloc'ed path. JRA. */
 131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
 132                 where it belongs. JRA. */
 133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
 134                 to split out the two possible uses. JRA. */
 135 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
 136 /* Leave at 28 - not yet released. Rename open function to open_fn. - gd */
 137 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
 138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
 139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
 140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
 141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
 142 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
 143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
 144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
 145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
 146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
 147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
 148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
 149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
 150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
 151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
 152                 connection_struct a pointer. */
 153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
 154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
 155 /* Leave at 31 - not yet released. Remove the unused
 156                 fsp->pending_break_messages array */
 157 /* Leave at 31 - not yet released. add SMB_VFS_[GET/SET]_COMPRESSION() */
 158
 159 /* Bump to version 32 - Samba 4.2 will ship with that. */
 160 /* Version 32 - Add "lease" to CREATE_FILE operation */
 161 /* Version 32 - Add "lease" to struct files_struct */
 162 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
 163 /* Version 32 - Add in and out create context blobs to create_file */
 164 /* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
 165 /* Bump to version 33 - Samba 4.3 will ship with that. */
 166 /* Version 33 - change fallocate mode flags param from enum->uint32_t */
 167 /* Version 33 - Add snapshot create/delete calls */
 168 /* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
 169 /* Version 33 - Remove notify_watch_fn */
 170 /* Bump to version 34 - Samba 4.4 will ship with that */
 171 /* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
 172 /* Version 34 - Added bool posix_pathnames to struct smb_request */
 173 /* Bump to version 35 - Samba 4.5 will ship with that */
 174 /* Version 35 - Change get_nt_acl_fn from const char *, to
 175                 const struct smb_filename * */
 176 /* Version 35 - Change mkdir from const char *, to
 177                 const struct smb_filename * */
 178 /* Version 35 - Change rmdir from const char *, to
 179                 const struct smb_filename * */
 180 /* Version 35 - Change opendir from const char *, to
 181                 const struct smb_filename * */
 182 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
 183 /* Version 35 - Change chmod from const char *, to
 184                 const struct smb_filename * */
 185 /* Version 35 - Change chmod_acl from const char *, to
 186                 const struct smb_filename * */
 187 /* Version 35 - Change chown from const char *, to
 188                 const struct smb_filename * */
 189 /* Version 35 - Change lchown from const char *, to
 190                 const struct smb_filename * */
 191 /* Version 35 - Change streaminfo from const char *, to
 192                 const struct smb_filename * */
 193 /* Version 35 - Add uint32_t flags to struct smb_filename */
 194 /* Version 35 - Add get/set/fget/fset dos attribute functions. */
 195 /* Version 35 - Add bool use_ofd_locks to struct files_struct */
 196 /* Bump to version 36 - Samba 4.6 will ship with that */
 197 /* Version 36 - Remove is_offline and set_offline */
 198 /* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
 199 /* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
 200 /* Version 37 - Change sys_acl_delete_def_file from const char *
 201                 to const struct smb_filename * */
 202 /* Version 37 - Change sys_acl_get_file from const char *
 203                 to const struct smb_filename * */
 204 /* Version 37 - Change sys_acl_blob_get_file from const char *
 205                 to const struct smb_filename * */
 206 /* Version 37 - Change sys_acl_set_file from const char *
 207                 to const struct smb_filename * */
 208 /* Version 37 - Change listxattr from const char *
 209                 to const struct smb_filename * */
 210 /* Version 37 - Change removexattr from const char *
 211                 to const struct smb_filename * */
 212 /* Version 37 - Change setxattr from const char *
 213                 to const struct smb_filename * */
 214 /* Version 37 - Change getxattr from const char *
 215                 to const struct smb_filename * */
 216 /* Version 37 - Change mknod from const char * to const struct smb_filename * */
 217 /* Version 37 - Change chflags from const char *
 218                 to const struct smb_filename * */
 219 /* Version 37 - Change disk_free from const char *
 220                 to const struct smb_filename * */
 221 /* Version 37 - Change get_quota from const char *
 222                 to const struct smb_filename * */
 223 /* Version 37 - Change link from const char *
 224                 to const struct smb_filename * */
 225 /* Version 37 - Change statvfs from const char *
 226                 to const struct smb_filename * */
 227 /* Version 37 - Change readlink from const char *
 228                 to const struct smb_filename * */
 229 /* Version 37 - Change symlink from const char *
 230                 to const struct smb_filename * */
 231 /* Version 37 - Change chdir from const char *
 232                 to const struct smb_filename * */
 233 /* Version 37 - Change getwd from char *
 234                 to const struct smb_filename * */
 235 /* Version 37 - Change conn->cwd from char *
 236                 to struct smb_filename * */
 237 /* Version 37 - Change realpath from char *
 238                 to struct smb_filename * */
 239 /* Version 37 - Change connectpath from char *
 240                 to struct smb_filename * */
 241 /* Version 37 - Add SMB_VFS_OFFLOAD_READ_SEND/RECV */
 242 /* Version 37 - Rename SMB_VFS_COPY_CHUNK_SEND/RECV to
 243                 SMB_VFS_OFFLOAD_READ_SEND/RECV */
 244 /* Version 37 - Remove SMB_VFS_STRICT_UNLOCK */
 245 /* Version 37 - Rename SMB_VFS_STRICT_LOCK to
 246                 SMB_VFS_STRICT_LOCK_CHECK */
 247 /* Version 38 - Remove SMB_VFS_INIT_SEARCH_OP */
 248 /* Bump to version 39, Samba 4.9 will ship with that */
 249 /* Version 39 - Remove SMB_VFS_FSYNC
 250                 Only implement async versions. */
 251 /* Version 39 - Remove SMB_VFS_READ
 252                 All users are now pread or async versions. */
 253 /* Version 39 - Remove SMB_VFS_WRITE
 254                 All users are now pwrite or async versions. */
 255 /* Version 39 - Remove SMB_VFS_CHMOD_ACL - no longer used. */
 256 /* Version 39 - Remove SMB_VFS_FCHMOD_ACL - no longer used. */
 257 /* Version 39 - Remove struct dfree_cached_info pointer from
 258                 connection struct */
 259 /* Bump to version 40, Samba 4.10 will ship with that */
 260 /* Version 40 - Introduce smb_vfs_ev_glue infrastructure. */
 261
 262 #define SMB_VFS_INTERFACE_VERSION 40
 263
 264 /*
 265     All intercepted VFS operations must be declared as static functions inside module source
 266     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
 267     example VFS modules for more details.
 268 */
 269
 270 /* VFS operations structure */
 271
 272 struct vfs_handle_struct;
 273 struct connection_struct;
 274 struct files_struct;
 275 struct security_descriptor;
 276 struct vfs_statvfs_struct;
 277 struct smb_request;
 278 struct ea_list;
 279 struct smb_file_time;
 280 struct blocking_lock_record;
 281 struct smb_filename;
 282 struct dfs_GetDFSReferral;
 283 struct tevent_context;
 284 struct pthreadpool_tevent;
 285 struct smb_vfs_ev_glue;
 286
 287 typedef union unid_t {
 288         uid_t uid;
 289         gid_t gid;
 290 } unid_t;
 291
 292 struct fd_handle {
 293         size_t ref_count;
 294         int fd;
 295         uint64_t position_information;
 296         off_t pos;
 297         uint32_t private_options;       /* NT Create options, but we only look at
 298                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
 299                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
 300                                  * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
 301                                  * for print files *only*, where
 302                                  * DELETE_ON_CLOSE is not stored in the share
 303                                  * mode database.
 304                                  */
 305         unsigned long gen_id;
 306 };
 307
 308 struct fsp_lease {
 309         size_t ref_count;
 310         struct smbd_server_connection *sconn;
 311         struct tevent_timer *timeout;
 312         struct smb2_lease lease;
 313 };
 314
 315 typedef struct files_struct {
 316         struct files_struct *next, *prev;
 317         uint64_t fnum;
 318         struct smbXsrv_open *op;
 319         struct connection_struct *conn;
 320         struct fd_handle *fh;
 321         unsigned int num_smb_operations;
 322         struct file_id file_id;
 323         uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
 324         uint16_t file_pid;
 325         uint64_t vuid; /* SMB2 compat */
 326         struct write_cache *wcp;
 327         struct timeval open_time;
 328         uint32_t access_mask;           /* NTCreateX access bits (FILE_READ_DATA etc.) */
 329         uint32_t share_access;          /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 330
 331         bool kernel_share_modes_taken;
 332
 333         bool update_write_time_triggered;
 334         struct tevent_timer *update_write_time_event;
 335         bool update_write_time_on_close;
 336         struct timespec close_write_time;
 337         bool write_time_forced;
 338
 339         int oplock_type;
 340         struct fsp_lease *lease;
 341         int sent_oplock_break;
 342         struct tevent_timer *oplock_timeout;
 343         struct lock_struct last_lock_failure;
 344         int current_lock_count; /* Count the number of outstanding locks and pending locks. */
 345
 346         bool can_lock;
 347         bool can_read;
 348         bool can_write;
 349         bool modified;
 350         bool is_directory;
 351         bool aio_write_behind;
 352         bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
 353         bool delete_on_close;
 354         uint64_t posix_flags;
 355         bool is_sparse;
 356         bool backup_intent; /* Handle was successfully opened with backup intent
 357                                 and opener has privilege to do so. */
 358         bool use_ofd_locks; /* Are we using open file description locks ? */
 359         struct smb_filename *fsp_name;
 360         uint32_t name_hash;             /* Jenkins hash of full pathname. */
 361         uint64_t mid;                   /* Mid of the operation that created us. */
 362
 363         struct vfs_fsp_data *vfs_extension;
 364         struct fake_file_handle *fake_file_handle;
 365
 366         struct notify_change_buf *notify;
 367
 368         struct files_struct *base_fsp; /* placeholder for delete on close */
 369
 370         /*
 371          * Read-only cached brlock record, thrown away when the
 372          * brlock.tdb seqnum changes. This avoids fetching data from
 373          * the brlock.tdb on every read/write call.
 374          */
 375         int brlock_seqnum;
 376         struct byte_range_lock *brlock_rec;
 377
 378         struct dptr_struct *dptr;
 379
 380         /* if not NULL, means this is a print file */
 381         struct print_file_data *print_file;
 382
 383         unsigned num_aio_requests;
 384         struct tevent_req **aio_requests;
 385
 386         /*
 387          * If a close request comes in while we still have aio_requests
 388          * around, we need to hold back the close. When all aio_requests are
 389          * done, the aio completion routines need tevent_wait_done() on
 390          * this. A bit ugly, but before we have close_file() fully async
 391          * possibly the simplest approach. Thanks, Jeremy for the idea.
 392          */
 393         struct tevent_req *deferred_close;
 394 } files_struct;
 395
 396 #define FSP_POSIX_FLAGS_OPEN            0x01
 397 #define FSP_POSIX_FLAGS_RENAME          0x02
 398 #define FSP_POSIX_FLAGS_PATHNAMES       0x04
 399
 400 #define FSP_POSIX_FLAGS_ALL                     \
 401         (FSP_POSIX_FLAGS_OPEN |                 \
 402          FSP_POSIX_FLAGS_PATHNAMES |            \
 403          FSP_POSIX_FLAGS_RENAME)
 404
 405 struct vuid_cache_entry {
 406         struct auth_session_info *session_info;
 407         struct smb_vfs_ev_glue *user_vfs_evg;
 408         uint64_t vuid; /* SMB2 compat */
 409         bool read_only;
 410         uint32_t share_access;
 411 };
 412
 413 struct vuid_cache {
 414         unsigned int next_entry;
 415         struct vuid_cache_entry array[VUID_CACHE_SIZE];
 416 };
 417
 418 typedef struct {
 419         char *name;
 420         bool is_wild;
 421 } name_compare_entry;
 422
 423 struct share_params {
 424         int service;
 425 };
 426
 427 typedef struct connection_struct {
 428         struct connection_struct *next, *prev;
 429         struct smbd_server_connection *sconn; /* can be NULL */
 430         struct smbXsrv_tcon *tcon; /* can be NULL */
 431         uint32_t cnum; /* an index passed over the wire */
 432         struct share_params *params;
 433         bool force_user;
 434         struct vuid_cache *vuid_cache;
 435         bool printer;
 436         bool ipc;
 437         bool read_only; /* Attributes for the current user of the share. */
 438         uint32_t share_access;
 439         /* Does this filesystem honor
 440            sub second timestamps on files
 441            and directories when setting time ? */
 442         enum timestamp_set_resolution ts_res;
 443         char *connectpath;
 444         char *origpath;
 445         struct smb_filename *cwd_fname; /* Working directory. */
 446         bool tcon_done;
 447
 448         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
 449
 450         /*
 451          * This represents the user information on this connection. Depending
 452          * on the vuid using this tid, this might change per SMB request.
 453          */
 454         struct auth_session_info *session_info;
 455         struct tevent_context *user_ev_ctx;
 456         struct smb_vfs_ev_glue *user_vfs_evg;
 457
 458         /*
 459          * If the "force group" parameter is set, this is the primary gid that
 460          * may be used in the users token, depending on the vuid using this tid.
 461          */
 462         gid_t force_group_gid;
 463
 464         uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
 465
 466         time_t lastused;
 467         time_t lastused_count;
 468         int num_files_open;
 469         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
 470         int encrypt_level;
 471         bool encrypted_tid;
 472
 473         /* Semantics requested by the client or forced by the server config. */
 474         bool case_sensitive;
 475         bool case_preserve;
 476         bool short_case_preserve;
 477
 478         /* Semantics provided by the underlying filesystem. */
 479         int fs_capabilities;
 480         /* Device number of the directory of the share mount.
 481            Used to ensure unique FileIndex returns. */
 482         SMB_DEV_T base_share_dev;
 483
 484         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
 485         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
 486         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
 487         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
 488         struct trans_state *pending_trans;
 489
 490         struct rpc_pipe_client *spoolss_pipe;
 491
 492 } connection_struct;
 493
 494 struct smbd_smb2_request;
 495 struct privilege_paths;
 496
 497 struct smb_request {
 498         uint8_t cmd;
 499         uint16_t flags2;
 500         uint16_t smbpid;
 501         uint64_t mid; /* For compatibility with SMB2. */
 502         uint32_t seqnum;
 503         uint64_t vuid; /* For compatibility with SMB2. */
 504         uint32_t tid;
 505         uint8_t  wct;
 506         const uint16_t *vwv;
 507         uint16_t buflen;
 508         const uint8_t *buf;
 509         const uint8_t *inbuf;
 510
 511         /*
 512          * Async handling in the main smb processing loop is directed by
 513          * outbuf: reply_xxx routines indicate sync behaviour by putting their
 514          * reply into "outbuf". If they leave it as NULL, they take care of it
 515          * themselves, possibly later.
 516          *
 517          * If async handling is wanted, the reply_xxx routine must make sure
 518          * that it talloc_move()s the smb_req somewhere else.
 519          */
 520         uint8_t *outbuf;
 521
 522         size_t unread_bytes;
 523         bool encrypted;
 524         /* the tevent_context (wrapper) the request operates on */
 525         struct tevent_context *ev_ctx;
 526         connection_struct *conn;
 527         struct smbd_server_connection *sconn;
 528         struct smbXsrv_connection *xconn;
 529         struct smb_perfcount_data pcd;
 530
 531         /*
 532          * Chained request handling
 533          */
 534         struct files_struct *chain_fsp;
 535
 536         /*
 537          * state information for async smb handling
 538          */
 539         void *async_priv;
 540
 541         /*
 542          * Back pointer to smb2 request.
 543          */
 544         struct smbd_smb2_request *smb2req;
 545
 546         /*
 547          * Pathnames used if request done
 548          * under privilege.
 549          */
 550         struct privilege_paths *priv_paths;
 551
 552         /*
 553          * Request list for chained requests, we're part of it.
 554          */
 555         struct smb_request **chain;
 556
 557         struct timeval request_time;
 558
 559         bool posix_pathnames;
 560 };
 561
 562 /*
 563  * Info about an alternate data stream
 564  */
 565
 566 struct stream_struct {
 567         off_t size;
 568         off_t alloc_size;
 569         char *name;
 570 };
 571
 572 /* time info */
 573 struct smb_file_time {
 574         struct timespec mtime;
 575         struct timespec atime;
 576         struct timespec ctime;
 577         struct timespec create_time;
 578 };
 579
 580 /*
 581  * smb_filename
 582  */
 583 struct smb_filename {
 584         char *base_name;
 585         char *stream_name;
 586         char *original_lcomp;
 587         uint32_t flags;
 588         SMB_STRUCT_STAT st;
 589 };
 590
 591 /*
 592  * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
 593  * to keep the numeric values consistent.
 594  */
 595
 596 #define SMB_FILENAME_POSIX_PATH         FSP_POSIX_FLAGS_PATHNAMES
 597
 598 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
 599                                 handle = handle->next; \
 600                          }
 601
 602 enum vfs_translate_direction {
 603         vfs_translate_to_unix = 0,
 604         vfs_translate_to_windows
 605 };
 606
 607 enum vfs_fallocate_flags {
 608         VFS_FALLOCATE_FL_KEEP_SIZE              = 0x0001,
 609         VFS_FALLOCATE_FL_PUNCH_HOLE             = 0x0002,
 610 };
 611
 612 struct vfs_aio_state {
 613         int error;
 614         uint64_t duration;
 615 };
 616
 617 /*
 618     Available VFS operations. These values must be in sync with vfs_ops struct
 619     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
 620     In particular, if new operations are added to vfs_ops, appropriate constants
 621     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
 622 */
 623 struct shadow_copy_data;
 624
 625 struct vfs_fn_pointers {
 626         /* Disk operations */
 627
 628         int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
 629         void (*disconnect_fn)(struct vfs_handle_struct *handle);
 630         uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
 631                                 const struct smb_filename *smb_fname,
 632                                 uint64_t *bsize,
 633                                 uint64_t *dfree,
 634                                 uint64_t *dsize);
 635         int (*get_quota_fn)(struct vfs_handle_struct *handle,
 636                                 const struct smb_filename *smb_fname,
 637                                 enum SMB_QUOTA_TYPE qtype,
 638                                 unid_t id,
 639                                 SMB_DISK_QUOTA *qt);
 640         int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 641         int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
 642         int (*statvfs_fn)(struct vfs_handle_struct *handle,
 643                                 const struct smb_filename *smb_fname,
 644                                 struct vfs_statvfs_struct *statbuf);
 645         uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
 646
 647         /*
 648          * Note: that "struct dfs_GetDFSReferral *r"
 649          * needs to be a valid TALLOC_CTX
 650          */
 651         NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
 652                                          struct dfs_GetDFSReferral *r);
 653
 654         /* Directory operations */
 655
 656         DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
 657                                         const struct smb_filename *smb_fname,
 658                                         const char *mask,
 659                                         uint32_t attributes);
 660         DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
 661         struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
 662                                          DIR *dirp,
 663                                          SMB_STRUCT_STAT *sbuf);
 664         void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
 665         long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 666         void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 667         int (*mkdir_fn)(struct vfs_handle_struct *handle,
 668                         const struct smb_filename *smb_fname,
 669                         mode_t mode);
 670         int (*rmdir_fn)(struct vfs_handle_struct *handle,
 671                         const struct smb_filename *smb_fname);
 672         int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
 673
 674         /* File operations */
 675
 676         int (*open_fn)(struct vfs_handle_struct *handle,
 677                        struct smb_filename *smb_fname, files_struct *fsp,
 678                        int flags, mode_t mode);
 679         NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
 680                                    struct smb_request *req,
 681                                    uint16_t root_dir_fid,
 682                                    struct smb_filename *smb_fname,
 683                                    uint32_t access_mask,
 684                                    uint32_t share_access,
 685                                    uint32_t create_disposition,
 686                                    uint32_t create_options,
 687                                    uint32_t file_attributes,
 688                                    uint32_t oplock_request,
 689                                    struct smb2_lease *lease,
 690                                    uint64_t allocation_size,
 691                                    uint32_t private_flags,
 692                                    struct security_descriptor *sd,
 693                                    struct ea_list *ea_list,
 694                                    files_struct **result,
 695                                    int *pinfo,
 696                                    const struct smb2_create_blobs *in_context_blobs,
 697                                    struct smb2_create_blobs *out_context_blobs);
 698         int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 699         ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
 700         struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
 701                                             TALLOC_CTX *mem_ctx,
 702                                             struct tevent_context *ev,
 703                                             struct files_struct *fsp,
 704                                             void *data,
 705                                             size_t n, off_t offset);
 706         ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 707         ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
 708         struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
 709                                              TALLOC_CTX *mem_ctx,
 710                                              struct tevent_context *ev,
 711                                              struct files_struct *fsp,
 712                                              const void *data,
 713                                              size_t n, off_t offset);
 714         ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 715         off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
 716         ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
 717         ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
 718         int (*rename_fn)(struct vfs_handle_struct *handle,
 719                          const struct smb_filename *smb_fname_src,
 720                          const struct smb_filename *smb_fname_dst);
 721         struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
 722                                             TALLOC_CTX *mem_ctx,
 723                                             struct tevent_context *ev,
 724                                             struct files_struct *fsp);
 725         int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 726         int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
 727         int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
 728         int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
 729         uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
 730         int (*unlink_fn)(struct vfs_handle_struct *handle,
 731                          const struct smb_filename *smb_fname);
 732         int (*chmod_fn)(struct vfs_handle_struct *handle,
 733                         const struct smb_filename *smb_fname,
 734                         mode_t mode);
 735         int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 736         int (*chown_fn)(struct vfs_handle_struct *handle,
 737                         const struct smb_filename *smb_fname,
 738                         uid_t uid,
 739                         gid_t gid);
 740         int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
 741         int (*lchown_fn)(struct vfs_handle_struct *handle,
 742                         const struct smb_filename *smb_fname,
 743                         uid_t uid,
 744                         gid_t gid);
 745         int (*chdir_fn)(struct vfs_handle_struct *handle,
 746                          const struct smb_filename *smb_fname);
 747         struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
 748                                 TALLOC_CTX *mem_ctx);
 749         int (*ntimes_fn)(struct vfs_handle_struct *handle,
 750                          const struct smb_filename *smb_fname,
 751                          struct smb_file_time *ft);
 752         int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
 753         int (*fallocate_fn)(struct vfs_handle_struct *handle,
 754                             struct files_struct *fsp,
 755                             uint32_t mode,
 756                             off_t offset,
 757                             off_t len);
 758         bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
 759         int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 760                                uint32_t share_mode, uint32_t access_mask);
 761         int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
 762         bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
 763         int (*symlink_fn)(struct vfs_handle_struct *handle,
 764                                 const char *link_contents,
 765                                 const struct smb_filename *new_smb_fname);
 766         int (*readlink_fn)(struct vfs_handle_struct *handle,
 767                                 const struct smb_filename *smb_fname,
 768                                 char *buf,
 769                                 size_t bufsiz);
 770         int (*link_fn)(struct vfs_handle_struct *handle,
 771                                 const struct smb_filename *old_smb_fname,
 772                                 const struct smb_filename *new_smb_fname);
 773         int (*mknod_fn)(struct vfs_handle_struct *handle,
 774                                 const struct smb_filename *smb_fname,
 775                                 mode_t mode,
 776                                 SMB_DEV_T dev);
 777         struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
 778                                 TALLOC_CTX *ctx,
 779                                 const struct smb_filename *smb_fname);
 780         int (*chflags_fn)(struct vfs_handle_struct *handle,
 781                                 const struct smb_filename *smb_fname,
 782                                 unsigned int flags);
 783         struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
 784                                             const SMB_STRUCT_STAT *sbuf);
 785         struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
 786                                                    struct tevent_context *ev,
 787                                                    struct vfs_handle_struct *handle,
 788                                                    struct files_struct *fsp,
 789                                                    uint32_t fsctl,
 790                                                    uint32_t ttl,
 791                                                    off_t offset,
 792                                                    size_t to_copy);
 793         NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
 794                                          struct vfs_handle_struct *handle,
 795                                          TALLOC_CTX *mem_ctx,
 796                                          DATA_BLOB *token_blob);
 797         struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
 798                                                     TALLOC_CTX *mem_ctx,
 799                                                     struct tevent_context *ev,
 800                                                     uint32_t fsctl,
 801                                                     DATA_BLOB *token,
 802                                                     off_t transfer_offset,
 803                                                     struct files_struct *dest_fsp,
 804                                                     off_t dest_off,
 805                                                     off_t to_copy);
 806         NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
 807                                           struct tevent_req *req,
 808                                           off_t *copied);
 809         NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
 810                                        TALLOC_CTX *mem_ctx,
 811                                        struct files_struct *fsp,
 812                                        struct smb_filename *smb_fname,
 813                                        uint16_t *_compression_fmt);
 814         NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
 815                                        TALLOC_CTX *mem_ctx,
 816                                        struct files_struct *fsp,
 817                                        uint16_t compression_fmt);
 818         NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
 819                                        TALLOC_CTX *mem_ctx,
 820                                        const char *service_path,
 821                                        char **base_volume);
 822         NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
 823                                    TALLOC_CTX *mem_ctx,
 824                                    const char *base_volume,
 825                                    time_t *tstamp,
 826                                    bool rw,
 827                                    char **base_path,
 828                                    char **snap_path);
 829         NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
 830                                    TALLOC_CTX *mem_ctx,
 831                                    char *base_path,
 832                                    char *snap_path);
 833
 834         NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
 835                                   struct files_struct *fsp,
 836                                   const struct smb_filename *smb_fname,
 837                                   TALLOC_CTX *mem_ctx,
 838                                   unsigned int *num_streams,
 839                                   struct stream_struct **streams);
 840
 841         int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
 842                                     const char *path,
 843                                     const char *name,
 844                                     TALLOC_CTX *mem_ctx,
 845                                     char **found_name);
 846
 847         const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
 848                                       const struct smb_filename *smb_fname);
 849
 850         NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
 851                                         struct byte_range_lock *br_lck,
 852                                         struct lock_struct *plock,
 853                                         bool blocking_lock);
 854
 855         bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
 856                                       struct messaging_context *msg_ctx,
 857                                       struct byte_range_lock *br_lck,
 858                                       const struct lock_struct *plock);
 859
 860         bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
 861                                       struct byte_range_lock *br_lck,
 862                                       struct lock_struct *plock);
 863
 864         bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
 865                                      struct files_struct *fsp,
 866                                      struct lock_struct *plock);
 867
 868         NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
 869                                       const char *name,
 870                                       enum vfs_translate_direction direction,
 871                                       TALLOC_CTX *mem_ctx,
 872                                       char **mapped_name);
 873
 874         NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
 875                              struct files_struct *fsp,
 876                              TALLOC_CTX *ctx,
 877                              uint32_t function,
 878                              uint16_t req_flags,
 879                              const uint8_t *_in_data,
 880                              uint32_t in_len,
 881                              uint8_t **_out_data,
 882                              uint32_t max_out_len,
 883                              uint32_t *out_len);
 884
 885         NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
 886                                           struct smb_filename *smb_fname,
 887                                           uint32_t *dosmode);
 888
 889         NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
 890                                            struct files_struct *fsp,
 891                                            uint32_t *dosmode);
 892
 893         NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
 894                                           const struct smb_filename *smb_fname,
 895                                           uint32_t dosmode);
 896
 897         NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
 898                                            struct files_struct *fsp,
 899                                            uint32_t dosmode);
 900
 901         /* NT ACL operations. */
 902
 903         NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
 904                                    struct files_struct *fsp,
 905                                    uint32_t security_info,
 906                                    TALLOC_CTX *mem_ctx,
 907                                    struct security_descriptor **ppdesc);
 908         NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
 909                                   const struct smb_filename *smb_fname,
 910                                   uint32_t security_info,
 911                                    TALLOC_CTX *mem_ctx,
 912                                   struct security_descriptor **ppdesc);
 913         NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
 914                                    struct files_struct *fsp,
 915                                    uint32_t security_info_sent,
 916                                    const struct security_descriptor *psd);
 917
 918         NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
 919                                   struct smb_filename *file,
 920                                   struct security_acl *sacl,
 921                                   uint32_t access_requested,
 922                                   uint32_t access_denied);
 923
 924         /* POSIX ACL operations. */
 925
 926         SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
 927                                          const struct smb_filename *smb_fname,
 928                                          SMB_ACL_TYPE_T type,
 929                                          TALLOC_CTX *mem_ctx);
 930         SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
 931                                        struct files_struct *fsp,
 932                                        TALLOC_CTX *mem_ctx);
 933         int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
 934                                         const struct smb_filename *smb_fname,
 935                                         TALLOC_CTX *mem_ctx,
 936                                         char **blob_description,
 937                                         DATA_BLOB *blob);
 938         int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 939                                       TALLOC_CTX *mem_ctx, char **blob_description,
 940                                       DATA_BLOB *blob);
 941         int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
 942                                         const struct smb_filename *smb_fname,
 943                                         SMB_ACL_TYPE_T acltype,
 944                                         SMB_ACL_T theacl);
 945         int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
 946         int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
 947                                         const struct smb_filename *smb_fname);
 948
 949         /* EA operations. */
 950         ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
 951                                         const struct smb_filename *smb_fname,
 952                                         const char *name,
 953                                         void *value,
 954                                         size_t size);
 955         ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
 956         ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
 957                                         const struct smb_filename *smb_fname,
 958                                         char *list,
 959                                         size_t size);
 960         ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
 961         int (*removexattr_fn)(struct vfs_handle_struct *handle,
 962                                         const struct smb_filename *smb_fname,
 963                                         const char *name);
 964         int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
 965         int (*setxattr_fn)(struct vfs_handle_struct *handle,
 966                                         const struct smb_filename *smb_fname,
 967                                         const char *name,
 968                                         const void *value,
 969                                         size_t size,
 970                                         int flags);
 971         int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
 972
 973         /* aio operations */
 974         bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 975
 976         /* durable handle operations */
 977         NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
 978                                       struct files_struct *fsp,
 979                                       TALLOC_CTX *mem_ctx,
 980                                       DATA_BLOB *cookie);
 981         NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
 982                                           struct files_struct *fsp,
 983                                           const DATA_BLOB old_cookie,
 984                                           TALLOC_CTX *mem_ctx,
 985                                           DATA_BLOB *new_cookie);
 986         NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
 987                                          struct smb_request *smb1req,
 988                                          struct smbXsrv_open *op,
 989                                          const DATA_BLOB old_cookie,
 990                                          TALLOC_CTX *mem_ctx,
 991                                          struct files_struct **fsp,
 992                                          DATA_BLOB *new_cookie);
 993
 994         NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
 995                                     const struct smb_filename *fname,
 996                                     TALLOC_CTX *mem_ctx,
 997                                     struct readdir_attr_data **attr_data);
 998 };
 999
1000 /*
1001     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1002     which describes all operations this module is willing to intercept.
1003     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1004     using this information.
1005 */
1006
1007 typedef struct vfs_handle_struct {
1008         struct vfs_handle_struct  *next, *prev;
1009         const char *param;
1010         struct connection_struct *conn;
1011         const struct vfs_fn_pointers *fns;
1012         void *data;
1013         void (*free_data)(void **data);
1014 } vfs_handle_struct;
1015
1016
1017 typedef struct vfs_statvfs_struct {
1018         /* For undefined recommended transfer size return -1 in that field */
1019         uint32_t OptimalTransferSize;  /* bsize on some os, iosize on other os */
1020         uint32_t BlockSize;
1021
1022         /*
1023          The next three fields are in terms of the block size.
1024          (above). If block size is unknown, 4096 would be a
1025          reasonable block size for a server to report.
1026          Note that returning the blocks/blocksavail removes need
1027          to make a second call (to QFSInfo level 0x103 to get this info.
1028          UserBlockAvail is typically less than or equal to BlocksAvail,
1029          if no distinction is made return the same value in each.
1030         */
1031
1032         uint64_t TotalBlocks;
1033         uint64_t BlocksAvail;       /* bfree */
1034         uint64_t UserBlocksAvail;   /* bavail */
1035
1036         /* For undefined Node fields or FSID return -1 */
1037         uint64_t TotalFileNodes;
1038         uint64_t FreeFileNodes;
1039         uint64_t FsIdentifier;   /* fsid */
1040         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1041         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
1042
1043         int FsCapabilities;
1044 } vfs_statvfs_struct;
1045
1046 /* Add a new FSP extension of the given type. Returns a pointer to the
1047  * extenstion data.
1048  */
1049 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn)            \
1050     (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1051
1052 /* Return a pointer to the existing FSP extension data. */
1053 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1054     vfs_fetch_fsp_extension(handle, (fsp))
1055
1056 /* Return the talloc context associated with an FSP extension. */
1057 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1058     vfs_memctx_fsp_extension(handle, (fsp))
1059
1060 /* Remove and destroy an FSP extension. */
1061 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1062     vfs_remove_fsp_extension((handle), (fsp))
1063
1064 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1065         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1066                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1067                 ret; \
1068         } \
1069 }
1070
1071 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1072         if (!(handle)) { \
1073                 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1074                 ret; \
1075         } else { \
1076                 if ((handle)->free_data) { \
1077                         (handle)->free_data(&(handle)->data); \
1078                 } \
1079                 (handle)->data = (void *)datap; \
1080                 (handle)->free_data = free_fn; \
1081         } \
1082 }
1083
1084 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1085         if ((handle) && (handle)->free_data) { \
1086                 (handle)->free_data(&(handle)->data); \
1087         } \
1088 }
1089
1090 /* Check whether module-specific data handle was already allocated or not */
1091 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
1092
1093 #define SMB_VFS_OP(x) ((void *) x)
1094
1095 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1096
1097 #include "vfs_macros.h"
1098
1099 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1100                          const char *service, const char *user);
1101 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1102 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1103                                 const struct smb_filename *smb_filename,
1104                                 uint64_t *bsize,
1105                                 uint64_t *dfree,
1106                                 uint64_t *dsize);
1107 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1108                                 const struct smb_filename *smb_filename,
1109                                 enum SMB_QUOTA_TYPE qtype,
1110                                 unid_t id,
1111                                 SMB_DISK_QUOTA *qt);
1112 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1113                            enum SMB_QUOTA_TYPE qtype, unid_t id,
1114                            SMB_DISK_QUOTA *qt);
1115 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1116                                       struct files_struct *fsp,
1117                                       struct shadow_copy_data *shadow_copy_data,
1118                                       bool labels);
1119 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1120                         const struct smb_filename *smb_fname,
1121                         struct vfs_statvfs_struct *statbuf);
1122 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1123                                       enum timestamp_set_resolution *p_ts_res);
1124 /*
1125  * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1126  */
1127 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1128                                         struct dfs_GetDFSReferral *r);
1129 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1130                         const struct smb_filename *smb_fname,
1131                         const char *mask,
1132                         uint32_t attributes);
1133 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1134                                         struct files_struct *fsp,
1135                                         const char *mask,
1136                                         uint32_t attributes);
1137 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1138                                         DIR *dirp,
1139                                         SMB_STRUCT_STAT *sbuf);
1140 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1141                           DIR *dirp, long offset);
1142 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1143                           DIR *dirp);
1144 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1145                              DIR *dirp);
1146 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1147                         const struct smb_filename *smb_fname,
1148                         mode_t mode);
1149 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1150                         const struct smb_filename *smb_fname);
1151 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1152                           DIR *dir);
1153 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1154                       struct smb_filename *smb_fname, struct files_struct *fsp,
1155                       int flags, mode_t mode);
1156 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1157                                   struct smb_request *req,
1158                                   uint16_t root_dir_fid,
1159                                   struct smb_filename *smb_fname,
1160                                   uint32_t access_mask,
1161                                   uint32_t share_access,
1162                                   uint32_t create_disposition,
1163                                   uint32_t create_options,
1164                                   uint32_t file_attributes,
1165                                   uint32_t oplock_request,
1166                                   struct smb2_lease *lease,
1167                                   uint64_t allocation_size,
1168                                   uint32_t private_flags,
1169                                   struct security_descriptor *sd,
1170                                   struct ea_list *ea_list,
1171                                   files_struct **result,
1172                                   int *pinfo,
1173                                   const struct smb2_create_blobs *in_context_blobs,
1174                                   struct smb2_create_blobs *out_context_blobs);
1175 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1176                        struct files_struct *fsp);
1177 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1178                            struct files_struct *fsp, void *data, size_t n,
1179                            off_t offset);
1180 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1181                                            TALLOC_CTX *mem_ctx,
1182                                            struct tevent_context *ev,
1183                                            struct files_struct *fsp,
1184                                            void *data,
1185                                            size_t n, off_t offset);
1186 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1187
1188 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1189                             struct files_struct *fsp, const void *data,
1190                             size_t n, off_t offset);
1191 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1192                                             TALLOC_CTX *mem_ctx,
1193                                             struct tevent_context *ev,
1194                                             struct files_struct *fsp,
1195                                             const void *data,
1196                                             size_t n, off_t offset);
1197 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1198
1199 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1200                              struct files_struct *fsp, off_t offset,
1201                              int whence);
1202 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1203                               files_struct *fromfsp, const DATA_BLOB *header,
1204                               off_t offset, size_t count);
1205 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1206                               files_struct *tofsp, off_t offset,
1207                               size_t count);
1208 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1209                         const struct smb_filename *smb_fname_src,
1210                         const struct smb_filename *smb_fname_dst);
1211
1212 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1213                                            TALLOC_CTX *mem_ctx,
1214                                            struct tevent_context *ev,
1215                                            struct files_struct *fsp);
1216 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1217
1218 int smb_vfs_fsync_sync(files_struct *fsp);
1219 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1220                       struct smb_filename *smb_fname);
1221 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1222                        struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1223 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1224                        struct smb_filename *smb_filename);
1225 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1226                                      struct files_struct *fsp,
1227                                      const SMB_STRUCT_STAT *sbuf);
1228 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1229                         const struct smb_filename *smb_fname);
1230 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1231                         const struct smb_filename *smb_fname,
1232                         mode_t mode);
1233 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1234                         struct files_struct *fsp, mode_t mode);
1235 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1236                         const struct smb_filename *smb_fname,
1237                         uid_t uid,
1238                         gid_t gid);
1239 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1240                         struct files_struct *fsp, uid_t uid, gid_t gid);
1241 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1242                         const struct smb_filename *smb_fname,
1243                         uid_t uid,
1244                         gid_t gid);
1245 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1246                         const struct smb_filename *smb_fname);
1247 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1248                                 TALLOC_CTX *ctx);
1249 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1250                         const struct smb_filename *smb_fname,
1251                         struct smb_file_time *ft);
1252 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1253                            struct files_struct *fsp, off_t offset);
1254 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1255                            struct files_struct *fsp,
1256                            uint32_t mode,
1257                            off_t offset,
1258                            off_t len);
1259 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1260                        struct files_struct *fsp, int op, off_t offset,
1261                        off_t count, int type);
1262 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1263                               struct files_struct *fsp, uint32_t share_mode,
1264                               uint32_t access_mask);
1265 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1266                                 struct files_struct *fsp, int leasetype);
1267 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1268                           struct files_struct *fsp, off_t *poffset,
1269                           off_t *pcount, int *ptype, pid_t *ppid);
1270 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1271                         const char *link_contents,
1272                         const struct smb_filename *new_smb_fname);
1273 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1274                         const struct smb_filename *smb_fname,
1275                         char *buf,
1276                         size_t bufsiz);
1277 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1278                         const struct smb_filename *old_smb_fname,
1279                         const struct smb_filename *new_smb_fname);
1280 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1281                         const struct smb_filename *smb_fname,
1282                         mode_t mode,
1283                         SMB_DEV_T dev);
1284 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1285                         TALLOC_CTX *ctx,
1286                         const struct smb_filename *smb_fname);
1287 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1288                         const struct smb_filename *smb_fname,
1289                         unsigned int flags);
1290 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1291                                            const SMB_STRUCT_STAT *sbuf);
1292 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1293                                  struct files_struct *fsp,
1294                                  const struct smb_filename *smb_fname,
1295                                  TALLOC_CTX *mem_ctx,
1296                                  unsigned int *num_streams,
1297                                  struct stream_struct **streams);
1298 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1299                                    const char *path, const char *name,
1300                                    TALLOC_CTX *mem_ctx, char **found_name);
1301 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1302                                      const struct smb_filename *smb_fname);
1303 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1304                                        struct byte_range_lock *br_lck,
1305                                        struct lock_struct *plock,
1306                                        bool blocking_lock);
1307 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1308                                      struct messaging_context *msg_ctx,
1309                                      struct byte_range_lock *br_lck,
1310                                      const struct lock_struct *plock);
1311 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1312                                      struct byte_range_lock *br_lck,
1313                                      struct lock_struct *plock);
1314 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1315                                     struct files_struct *fsp,
1316                                     struct lock_struct *plock);
1317 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1318                                      const char *name,
1319                                      enum vfs_translate_direction direction,
1320                                      TALLOC_CTX *mem_ctx,
1321                                      char **mapped_name);
1322 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1323                             struct files_struct *fsp,
1324                             TALLOC_CTX *ctx,
1325                             uint32_t function,
1326                             uint16_t req_flags,
1327                             const uint8_t *_in_data,
1328                             uint32_t in_len,
1329                             uint8_t **_out_data,
1330                             uint32_t max_out_len,
1331                             uint32_t *out_len);
1332 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1333                                          struct smb_filename *smb_fname,
1334                                          uint32_t *dosmode);
1335 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1336                                           struct files_struct *fsp,
1337                                           uint32_t *dosmode);
1338 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1339                                          const struct smb_filename *smb_fname,
1340                                          uint32_t dosmode);
1341 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1342                                           struct files_struct *fsp,
1343                                           uint32_t dosmode);
1344 struct tevent_req *smb_vfs_call_offload_read_send(
1345         TALLOC_CTX *mem_ctx,
1346         struct tevent_context *ev,
1347         struct vfs_handle_struct *handle,
1348         struct files_struct *fsp,
1349         uint32_t fsctl,
1350         uint32_t ttl,
1351         off_t offset,
1352         size_t to_copy);
1353 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1354                                         struct vfs_handle_struct *handle,
1355                                         TALLOC_CTX *mem_ctx,
1356                                         DATA_BLOB *token_blob);
1357 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1358                                                    TALLOC_CTX *mem_ctx,
1359                                                    struct tevent_context *ev,
1360                                                    uint32_t fsctl,
1361                                                    DATA_BLOB *token,
1362                                                    off_t transfer_offset,
1363                                                    struct files_struct *dest_fsp,
1364                                                    off_t dest_off,
1365                                                    off_t num);
1366 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1367                                          struct tevent_req *req,
1368                                          off_t *copied);
1369 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1370                                       TALLOC_CTX *mem_ctx,
1371                                       struct files_struct *fsp,
1372                                       struct smb_filename *smb_fname,
1373                                       uint16_t *_compression_fmt);
1374 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1375                                       TALLOC_CTX *mem_ctx,
1376                                       struct files_struct *fsp,
1377                                       uint16_t compression_fmt);
1378 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1379                                       TALLOC_CTX *mem_ctx,
1380                                       const char *service_path,
1381                                       char **base_volume);
1382 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1383                                   TALLOC_CTX *mem_ctx,
1384                                   const char *base_volume,
1385                                   time_t *tstamp,
1386                                   bool rw,
1387                                   char **base_path,
1388                                   char **snap_path);
1389 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1390                                   TALLOC_CTX *mem_ctx,
1391                                   char *base_path,
1392                                   char *snap_path);
1393 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1394                                   struct files_struct *fsp,
1395                                   uint32_t security_info,
1396                                   TALLOC_CTX *mem_ctx,
1397                                   struct security_descriptor **ppdesc);
1398 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1399                                  const struct smb_filename *smb_fname,
1400                                  uint32_t security_info,
1401                                  TALLOC_CTX *mem_ctx,
1402                                  struct security_descriptor **ppdesc);
1403 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1404                                   struct files_struct *fsp,
1405                                   uint32_t security_info_sent,
1406                                   const struct security_descriptor *psd);
1407 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1408                                  struct smb_filename *file,
1409                                  struct security_acl *sacl,
1410                                  uint32_t access_requested,
1411                                  uint32_t access_denied);
1412 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1413                                 const struct smb_filename *file,
1414                                 mode_t mode);
1415 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1416                                         const struct smb_filename *smb_fname,
1417                                         SMB_ACL_TYPE_T type,
1418                                         TALLOC_CTX *mem_ctx);
1419 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1420                                       struct files_struct *fsp,
1421                                       TALLOC_CTX *mem_ctx);
1422 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1423                                        const struct smb_filename *smb_fname,
1424                                        TALLOC_CTX *mem_ctx,
1425                                        char **blob_description,
1426                                        DATA_BLOB *blob);
1427 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1428                                      struct files_struct *fsp,
1429                                      TALLOC_CTX *mem_ctx,
1430                                      char **blob_description,
1431                                      DATA_BLOB *blob);
1432 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1433                                 const struct smb_filename *smb_fname,
1434                                 SMB_ACL_TYPE_T acltype,
1435                                 SMB_ACL_T theacl);
1436 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1437                                 struct files_struct *fsp, SMB_ACL_T theacl);
1438 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1439                                 const struct smb_filename *smb_fname);
1440 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1441                                 const struct smb_filename *smb_fname,
1442                                 const char *name,
1443                                 void *value,
1444                                 size_t size);
1445 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1446                                struct files_struct *fsp, const char *name,
1447                                void *value, size_t size);
1448 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1449                                 const struct smb_filename *smb_fname,
1450                                 char *list,
1451                                 size_t size);
1452 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1453                                 struct files_struct *fsp, char *list,
1454                                 size_t size);
1455 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1456                                 const struct smb_filename *smb_fname,
1457                                 const char *name);
1458 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1459                               struct files_struct *fsp, const char *name);
1460 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1461                                 const struct smb_filename *smb_fname,
1462                                 const char *name,
1463                                 const void *value,
1464                                 size_t size,
1465                                 int flags);
1466 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1467                            const char *name, const void *value, size_t size,
1468                            int flags);
1469 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1470                            struct files_struct *fsp, const char *name,
1471                            const void *value, size_t size, int flags);
1472 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1473                             struct files_struct *fsp);
1474 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1475                                      struct files_struct *fsp,
1476                                      TALLOC_CTX *mem_ctx,
1477                                      DATA_BLOB *cookie);
1478 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1479                                          struct files_struct *fsp,
1480                                          const DATA_BLOB old_cookie,
1481                                          TALLOC_CTX *mem_ctx,
1482                                          DATA_BLOB *new_cookie);
1483 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1484                                         struct smb_request *smb1req,
1485                                         struct smbXsrv_open *op,
1486                                         const DATA_BLOB old_cookie,
1487                                         TALLOC_CTX *mem_ctx,
1488                                         struct files_struct **fsp,
1489                                         DATA_BLOB *new_cookie);
1490 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1491                                    const struct smb_filename *fname,
1492                                    TALLOC_CTX *mem_ctx,
1493                                    struct readdir_attr_data **attr_data);
1494
1495 NTSTATUS smb_register_vfs(int version, const char *name,
1496                           const struct vfs_fn_pointers *fns);
1497 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1498                                    files_struct *fsp, size_t ext_size,
1499                                    void (*destroy_fn)(void *p_data));
1500 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1501 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1502 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1503 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1504
1505 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1506                             const char *module);
1507
1508 /*
1509  * Notice the "Design of the smb_vfs_ev_glue infrastructure"
1510  * comment in source3/smbd/vfs.c!
1511  *
1512  * This explains smb_vfs_ev_glue infrastructure in detail.
1513  */
1514 struct tevent_context *smb_vfs_ev_glue_ev_ctx(const struct smb_vfs_ev_glue *evg);
1515 struct pthreadpool_tevent *smb_vfs_ev_glue_tp_fd_safe(const struct smb_vfs_ev_glue *evg);
1516 struct pthreadpool_tevent *smb_vfs_ev_glue_tp_path_safe(const struct smb_vfs_ev_glue *evg);
1517 struct pthreadpool_tevent *smb_vfs_ev_glue_tp_chdir_safe(const struct smb_vfs_ev_glue *evg);
1518 const struct smb_vfs_ev_glue *smb_vfs_ev_glue_get_root_glue(const struct smb_vfs_ev_glue *evg);
1519 struct smb_vfs_ev_glue *smb_vfs_ev_glue_create(TALLOC_CTX *mem_ctx,
1520                                 struct tevent_context *user_ev,
1521                                 struct pthreadpool_tevent *user_tp_fd_safe,
1522                                 struct pthreadpool_tevent *user_tp_path_safe,
1523                                 struct pthreadpool_tevent *user_tp_chdir_safe,
1524                                 struct tevent_context *root_ev,
1525                                 struct pthreadpool_tevent *root_tp_fd_safe,
1526                                 struct pthreadpool_tevent *root_tp_path_safe,
1527                                 struct pthreadpool_tevent *root_tp_chdir_safe);
1528 struct smb_vfs_ev_glue *smb_vfs_ev_glue_create_switch(
1529                         TALLOC_CTX *mem_ctx,
1530                         const struct smb_vfs_ev_glue *return_evg,
1531                         const struct smb_vfs_ev_glue *run_evg);
1532
1533 #endif /* _VFS_H */