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 tevent_context *user_ev_ctx;
 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
 457         /*
 458          * If the "force group" parameter is set, this is the primary gid that
 459          * may be used in the users token, depending on the vuid using this tid.
 460          */
 461         gid_t force_group_gid;
 462
 463         uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
 464
 465         time_t lastused;
 466         time_t lastused_count;
 467         int num_files_open;
 468         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
 469         int encrypt_level;
 470         bool encrypted_tid;
 471
 472         /* Semantics requested by the client or forced by the server config. */
 473         bool case_sensitive;
 474         bool case_preserve;
 475         bool short_case_preserve;
 476
 477         /* Semantics provided by the underlying filesystem. */
 478         int fs_capabilities;
 479         /* Device number of the directory of the share mount.
 480            Used to ensure unique FileIndex returns. */
 481         SMB_DEV_T base_share_dev;
 482
 483         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
 484         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
 485         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
 486         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
 487         struct trans_state *pending_trans;
 488
 489         struct rpc_pipe_client *spoolss_pipe;
 490
 491 } connection_struct;
 492
 493 struct smbd_smb2_request;
 494 struct privilege_paths;
 495
 496 struct smb_request {
 497         uint8_t cmd;
 498         uint16_t flags2;
 499         uint16_t smbpid;
 500         uint64_t mid; /* For compatibility with SMB2. */
 501         uint32_t seqnum;
 502         uint64_t vuid; /* For compatibility with SMB2. */
 503         uint32_t tid;
 504         uint8_t  wct;
 505         const uint16_t *vwv;
 506         uint16_t buflen;
 507         const uint8_t *buf;
 508         const uint8_t *inbuf;
 509
 510         /*
 511          * Async handling in the main smb processing loop is directed by
 512          * outbuf: reply_xxx routines indicate sync behaviour by putting their
 513          * reply into "outbuf". If they leave it as NULL, they take care of it
 514          * themselves, possibly later.
 515          *
 516          * If async handling is wanted, the reply_xxx routine must make sure
 517          * that it talloc_move()s the smb_req somewhere else.
 518          */
 519         uint8_t *outbuf;
 520
 521         size_t unread_bytes;
 522         bool encrypted;
 523         /* the tevent_context (wrapper) the request operates on */
 524         struct tevent_context *ev_ctx;
 525         connection_struct *conn;
 526         struct smbd_server_connection *sconn;
 527         struct smbXsrv_connection *xconn;
 528         struct smb_perfcount_data pcd;
 529
 530         /*
 531          * Chained request handling
 532          */
 533         struct files_struct *chain_fsp;
 534
 535         /*
 536          * state information for async smb handling
 537          */
 538         void *async_priv;
 539
 540         /*
 541          * Back pointer to smb2 request.
 542          */
 543         struct smbd_smb2_request *smb2req;
 544
 545         /*
 546          * Pathnames used if request done
 547          * under privilege.
 548          */
 549         struct privilege_paths *priv_paths;
 550
 551         /*
 552          * Request list for chained requests, we're part of it.
 553          */
 554         struct smb_request **chain;
 555
 556         struct timeval request_time;
 557
 558         bool posix_pathnames;
 559 };
 560
 561 /*
 562  * Info about an alternate data stream
 563  */
 564
 565 struct stream_struct {
 566         off_t size;
 567         off_t alloc_size;
 568         char *name;
 569 };
 570
 571 /* time info */
 572 struct smb_file_time {
 573         struct timespec mtime;
 574         struct timespec atime;
 575         struct timespec ctime;
 576         struct timespec create_time;
 577 };
 578
 579 /*
 580  * smb_filename
 581  */
 582 struct smb_filename {
 583         char *base_name;
 584         char *stream_name;
 585         char *original_lcomp;
 586         uint32_t flags;
 587         SMB_STRUCT_STAT st;
 588 };
 589
 590 /*
 591  * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
 592  * to keep the numeric values consistent.
 593  */
 594
 595 #define SMB_FILENAME_POSIX_PATH         FSP_POSIX_FLAGS_PATHNAMES
 596
 597 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
 598                                 handle = handle->next; \
 599                          }
 600
 601 enum vfs_translate_direction {
 602         vfs_translate_to_unix = 0,
 603         vfs_translate_to_windows
 604 };
 605
 606 enum vfs_fallocate_flags {
 607         VFS_FALLOCATE_FL_KEEP_SIZE              = 0x0001,
 608         VFS_FALLOCATE_FL_PUNCH_HOLE             = 0x0002,
 609 };
 610
 611 struct vfs_aio_state {
 612         int error;
 613         uint64_t duration;
 614 };
 615
 616 /*
 617     Available VFS operations. These values must be in sync with vfs_ops struct
 618     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
 619     In particular, if new operations are added to vfs_ops, appropriate constants
 620     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
 621 */
 622 struct shadow_copy_data;
 623
 624 struct vfs_fn_pointers {
 625         /* Disk operations */
 626
 627         int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
 628         void (*disconnect_fn)(struct vfs_handle_struct *handle);
 629         uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
 630                                 const struct smb_filename *smb_fname,
 631                                 uint64_t *bsize,
 632                                 uint64_t *dfree,
 633                                 uint64_t *dsize);
 634         int (*get_quota_fn)(struct vfs_handle_struct *handle,
 635                                 const struct smb_filename *smb_fname,
 636                                 enum SMB_QUOTA_TYPE qtype,
 637                                 unid_t id,
 638                                 SMB_DISK_QUOTA *qt);
 639         int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 640         int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
 641         int (*statvfs_fn)(struct vfs_handle_struct *handle,
 642                                 const struct smb_filename *smb_fname,
 643                                 struct vfs_statvfs_struct *statbuf);
 644         uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
 645
 646         /*
 647          * Note: that "struct dfs_GetDFSReferral *r"
 648          * needs to be a valid TALLOC_CTX
 649          */
 650         NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
 651                                          struct dfs_GetDFSReferral *r);
 652
 653         /* Directory operations */
 654
 655         DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
 656                                         const struct smb_filename *smb_fname,
 657                                         const char *mask,
 658                                         uint32_t attributes);
 659         DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
 660         struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
 661                                          DIR *dirp,
 662                                          SMB_STRUCT_STAT *sbuf);
 663         void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
 664         long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 665         void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 666         int (*mkdir_fn)(struct vfs_handle_struct *handle,
 667                         const struct smb_filename *smb_fname,
 668                         mode_t mode);
 669         int (*rmdir_fn)(struct vfs_handle_struct *handle,
 670                         const struct smb_filename *smb_fname);
 671         int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
 672
 673         /* File operations */
 674
 675         int (*open_fn)(struct vfs_handle_struct *handle,
 676                        struct smb_filename *smb_fname, files_struct *fsp,
 677                        int flags, mode_t mode);
 678         NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
 679                                    struct smb_request *req,
 680                                    uint16_t root_dir_fid,
 681                                    struct smb_filename *smb_fname,
 682                                    uint32_t access_mask,
 683                                    uint32_t share_access,
 684                                    uint32_t create_disposition,
 685                                    uint32_t create_options,
 686                                    uint32_t file_attributes,
 687                                    uint32_t oplock_request,
 688                                    struct smb2_lease *lease,
 689                                    uint64_t allocation_size,
 690                                    uint32_t private_flags,
 691                                    struct security_descriptor *sd,
 692                                    struct ea_list *ea_list,
 693                                    files_struct **result,
 694                                    int *pinfo,
 695                                    const struct smb2_create_blobs *in_context_blobs,
 696                                    struct smb2_create_blobs *out_context_blobs);
 697         int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 698         ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
 699         struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
 700                                             TALLOC_CTX *mem_ctx,
 701                                             struct tevent_context *ev,
 702                                             struct files_struct *fsp,
 703                                             void *data,
 704                                             size_t n, off_t offset);
 705         ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 706         ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
 707         struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
 708                                              TALLOC_CTX *mem_ctx,
 709                                              struct tevent_context *ev,
 710                                              struct files_struct *fsp,
 711                                              const void *data,
 712                                              size_t n, off_t offset);
 713         ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 714         off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
 715         ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
 716         ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
 717         int (*rename_fn)(struct vfs_handle_struct *handle,
 718                          const struct smb_filename *smb_fname_src,
 719                          const struct smb_filename *smb_fname_dst);
 720         struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
 721                                             TALLOC_CTX *mem_ctx,
 722                                             struct tevent_context *ev,
 723                                             struct files_struct *fsp);
 724         int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 725         int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
 726         int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
 727         int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
 728         uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
 729         int (*unlink_fn)(struct vfs_handle_struct *handle,
 730                          const struct smb_filename *smb_fname);
 731         int (*chmod_fn)(struct vfs_handle_struct *handle,
 732                         const struct smb_filename *smb_fname,
 733                         mode_t mode);
 734         int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 735         int (*chown_fn)(struct vfs_handle_struct *handle,
 736                         const struct smb_filename *smb_fname,
 737                         uid_t uid,
 738                         gid_t gid);
 739         int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
 740         int (*lchown_fn)(struct vfs_handle_struct *handle,
 741                         const struct smb_filename *smb_fname,
 742                         uid_t uid,
 743                         gid_t gid);
 744         int (*chdir_fn)(struct vfs_handle_struct *handle,
 745                          const struct smb_filename *smb_fname);
 746         struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
 747                                 TALLOC_CTX *mem_ctx);
 748         int (*ntimes_fn)(struct vfs_handle_struct *handle,
 749                          const struct smb_filename *smb_fname,
 750                          struct smb_file_time *ft);
 751         int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
 752         int (*fallocate_fn)(struct vfs_handle_struct *handle,
 753                             struct files_struct *fsp,
 754                             uint32_t mode,
 755                             off_t offset,
 756                             off_t len);
 757         bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
 758         int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 759                                uint32_t share_mode, uint32_t access_mask);
 760         int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
 761         bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
 762         int (*symlink_fn)(struct vfs_handle_struct *handle,
 763                                 const char *link_contents,
 764                                 const struct smb_filename *new_smb_fname);
 765         int (*readlink_fn)(struct vfs_handle_struct *handle,
 766                                 const struct smb_filename *smb_fname,
 767                                 char *buf,
 768                                 size_t bufsiz);
 769         int (*link_fn)(struct vfs_handle_struct *handle,
 770                                 const struct smb_filename *old_smb_fname,
 771                                 const struct smb_filename *new_smb_fname);
 772         int (*mknod_fn)(struct vfs_handle_struct *handle,
 773                                 const struct smb_filename *smb_fname,
 774                                 mode_t mode,
 775                                 SMB_DEV_T dev);
 776         struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
 777                                 TALLOC_CTX *ctx,
 778                                 const struct smb_filename *smb_fname);
 779         int (*chflags_fn)(struct vfs_handle_struct *handle,
 780                                 const struct smb_filename *smb_fname,
 781                                 unsigned int flags);
 782         struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
 783                                             const SMB_STRUCT_STAT *sbuf);
 784         struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
 785                                                    struct tevent_context *ev,
 786                                                    struct vfs_handle_struct *handle,
 787                                                    struct files_struct *fsp,
 788                                                    uint32_t fsctl,
 789                                                    uint32_t ttl,
 790                                                    off_t offset,
 791                                                    size_t to_copy);
 792         NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
 793                                          struct vfs_handle_struct *handle,
 794                                          TALLOC_CTX *mem_ctx,
 795                                          DATA_BLOB *token_blob);
 796         struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
 797                                                     TALLOC_CTX *mem_ctx,
 798                                                     struct tevent_context *ev,
 799                                                     uint32_t fsctl,
 800                                                     DATA_BLOB *token,
 801                                                     off_t transfer_offset,
 802                                                     struct files_struct *dest_fsp,
 803                                                     off_t dest_off,
 804                                                     off_t to_copy);
 805         NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
 806                                           struct tevent_req *req,
 807                                           off_t *copied);
 808         NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
 809                                        TALLOC_CTX *mem_ctx,
 810                                        struct files_struct *fsp,
 811                                        struct smb_filename *smb_fname,
 812                                        uint16_t *_compression_fmt);
 813         NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
 814                                        TALLOC_CTX *mem_ctx,
 815                                        struct files_struct *fsp,
 816                                        uint16_t compression_fmt);
 817         NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
 818                                        TALLOC_CTX *mem_ctx,
 819                                        const char *service_path,
 820                                        char **base_volume);
 821         NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
 822                                    TALLOC_CTX *mem_ctx,
 823                                    const char *base_volume,
 824                                    time_t *tstamp,
 825                                    bool rw,
 826                                    char **base_path,
 827                                    char **snap_path);
 828         NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
 829                                    TALLOC_CTX *mem_ctx,
 830                                    char *base_path,
 831                                    char *snap_path);
 832
 833         NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
 834                                   struct files_struct *fsp,
 835                                   const struct smb_filename *smb_fname,
 836                                   TALLOC_CTX *mem_ctx,
 837                                   unsigned int *num_streams,
 838                                   struct stream_struct **streams);
 839
 840         int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
 841                                     const char *path,
 842                                     const char *name,
 843                                     TALLOC_CTX *mem_ctx,
 844                                     char **found_name);
 845
 846         const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
 847                                       const struct smb_filename *smb_fname);
 848
 849         NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
 850                                         struct byte_range_lock *br_lck,
 851                                         struct lock_struct *plock,
 852                                         bool blocking_lock);
 853
 854         bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
 855                                       struct messaging_context *msg_ctx,
 856                                       struct byte_range_lock *br_lck,
 857                                       const struct lock_struct *plock);
 858
 859         bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
 860                                       struct byte_range_lock *br_lck,
 861                                       struct lock_struct *plock);
 862
 863         bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
 864                                      struct files_struct *fsp,
 865                                      struct lock_struct *plock);
 866
 867         NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
 868                                       const char *name,
 869                                       enum vfs_translate_direction direction,
 870                                       TALLOC_CTX *mem_ctx,
 871                                       char **mapped_name);
 872
 873         NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
 874                              struct files_struct *fsp,
 875                              TALLOC_CTX *ctx,
 876                              uint32_t function,
 877                              uint16_t req_flags,
 878                              const uint8_t *_in_data,
 879                              uint32_t in_len,
 880                              uint8_t **_out_data,
 881                              uint32_t max_out_len,
 882                              uint32_t *out_len);
 883
 884         NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
 885                                           struct smb_filename *smb_fname,
 886                                           uint32_t *dosmode);
 887
 888         NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
 889                                            struct files_struct *fsp,
 890                                            uint32_t *dosmode);
 891
 892         NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
 893                                           const struct smb_filename *smb_fname,
 894                                           uint32_t dosmode);
 895
 896         NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
 897                                            struct files_struct *fsp,
 898                                            uint32_t dosmode);
 899
 900         /* NT ACL operations. */
 901
 902         NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
 903                                    struct files_struct *fsp,
 904                                    uint32_t security_info,
 905                                    TALLOC_CTX *mem_ctx,
 906                                    struct security_descriptor **ppdesc);
 907         NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
 908                                   const struct smb_filename *smb_fname,
 909                                   uint32_t security_info,
 910                                    TALLOC_CTX *mem_ctx,
 911                                   struct security_descriptor **ppdesc);
 912         NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
 913                                    struct files_struct *fsp,
 914                                    uint32_t security_info_sent,
 915                                    const struct security_descriptor *psd);
 916
 917         NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
 918                                   struct smb_filename *file,
 919                                   struct security_acl *sacl,
 920                                   uint32_t access_requested,
 921                                   uint32_t access_denied);
 922
 923         /* POSIX ACL operations. */
 924
 925         SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
 926                                          const struct smb_filename *smb_fname,
 927                                          SMB_ACL_TYPE_T type,
 928                                          TALLOC_CTX *mem_ctx);
 929         SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
 930                                        struct files_struct *fsp,
 931                                        TALLOC_CTX *mem_ctx);
 932         int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
 933                                         const struct smb_filename *smb_fname,
 934                                         TALLOC_CTX *mem_ctx,
 935                                         char **blob_description,
 936                                         DATA_BLOB *blob);
 937         int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 938                                       TALLOC_CTX *mem_ctx, char **blob_description,
 939                                       DATA_BLOB *blob);
 940         int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
 941                                         const struct smb_filename *smb_fname,
 942                                         SMB_ACL_TYPE_T acltype,
 943                                         SMB_ACL_T theacl);
 944         int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
 945         int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
 946                                         const struct smb_filename *smb_fname);
 947
 948         /* EA operations. */
 949         ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
 950                                         const struct smb_filename *smb_fname,
 951                                         const char *name,
 952                                         void *value,
 953                                         size_t size);
 954         ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
 955         ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
 956                                         const struct smb_filename *smb_fname,
 957                                         char *list,
 958                                         size_t size);
 959         ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
 960         int (*removexattr_fn)(struct vfs_handle_struct *handle,
 961                                         const struct smb_filename *smb_fname,
 962                                         const char *name);
 963         int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
 964         int (*setxattr_fn)(struct vfs_handle_struct *handle,
 965                                         const struct smb_filename *smb_fname,
 966                                         const char *name,
 967                                         const void *value,
 968                                         size_t size,
 969                                         int flags);
 970         int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
 971
 972         /* aio operations */
 973         bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 974
 975         /* durable handle operations */
 976         NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
 977                                       struct files_struct *fsp,
 978                                       TALLOC_CTX *mem_ctx,
 979                                       DATA_BLOB *cookie);
 980         NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
 981                                           struct files_struct *fsp,
 982                                           const DATA_BLOB old_cookie,
 983                                           TALLOC_CTX *mem_ctx,
 984                                           DATA_BLOB *new_cookie);
 985         NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
 986                                          struct smb_request *smb1req,
 987                                          struct smbXsrv_open *op,
 988                                          const DATA_BLOB old_cookie,
 989                                          TALLOC_CTX *mem_ctx,
 990                                          struct files_struct **fsp,
 991                                          DATA_BLOB *new_cookie);
 992
 993         NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
 994                                     const struct smb_filename *fname,
 995                                     TALLOC_CTX *mem_ctx,
 996                                     struct readdir_attr_data **attr_data);
 997 };
 998
 999 /*
1000     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1001     which describes all operations this module is willing to intercept.
1002     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1003     using this information.
1004 */
1005
1006 typedef struct vfs_handle_struct {
1007         struct vfs_handle_struct  *next, *prev;
1008         const char *param;
1009         struct connection_struct *conn;
1010         const struct vfs_fn_pointers *fns;
1011         void *data;
1012         void (*free_data)(void **data);
1013 } vfs_handle_struct;
1014
1015
1016 typedef struct vfs_statvfs_struct {
1017         /* For undefined recommended transfer size return -1 in that field */
1018         uint32_t OptimalTransferSize;  /* bsize on some os, iosize on other os */
1019         uint32_t BlockSize;
1020
1021         /*
1022          The next three fields are in terms of the block size.
1023          (above). If block size is unknown, 4096 would be a
1024          reasonable block size for a server to report.
1025          Note that returning the blocks/blocksavail removes need
1026          to make a second call (to QFSInfo level 0x103 to get this info.
1027          UserBlockAvail is typically less than or equal to BlocksAvail,
1028          if no distinction is made return the same value in each.
1029         */
1030
1031         uint64_t TotalBlocks;
1032         uint64_t BlocksAvail;       /* bfree */
1033         uint64_t UserBlocksAvail;   /* bavail */
1034
1035         /* For undefined Node fields or FSID return -1 */
1036         uint64_t TotalFileNodes;
1037         uint64_t FreeFileNodes;
1038         uint64_t FsIdentifier;   /* fsid */
1039         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1040         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
1041
1042         int FsCapabilities;
1043 } vfs_statvfs_struct;
1044
1045 /* Add a new FSP extension of the given type. Returns a pointer to the
1046  * extenstion data.
1047  */
1048 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn)            \
1049     (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1050
1051 /* Return a pointer to the existing FSP extension data. */
1052 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1053     vfs_fetch_fsp_extension(handle, (fsp))
1054
1055 /* Return the talloc context associated with an FSP extension. */
1056 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1057     vfs_memctx_fsp_extension(handle, (fsp))
1058
1059 /* Remove and destroy an FSP extension. */
1060 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1061     vfs_remove_fsp_extension((handle), (fsp))
1062
1063 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1064         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1065                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1066                 ret; \
1067         } \
1068 }
1069
1070 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1071         if (!(handle)) { \
1072                 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1073                 ret; \
1074         } else { \
1075                 if ((handle)->free_data) { \
1076                         (handle)->free_data(&(handle)->data); \
1077                 } \
1078                 (handle)->data = (void *)datap; \
1079                 (handle)->free_data = free_fn; \
1080         } \
1081 }
1082
1083 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1084         if ((handle) && (handle)->free_data) { \
1085                 (handle)->free_data(&(handle)->data); \
1086         } \
1087 }
1088
1089 /* Check whether module-specific data handle was already allocated or not */
1090 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
1091
1092 #define SMB_VFS_OP(x) ((void *) x)
1093
1094 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1095
1096 #include "vfs_macros.h"
1097
1098 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1099                          const char *service, const char *user);
1100 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1101 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1102                                 const struct smb_filename *smb_filename,
1103                                 uint64_t *bsize,
1104                                 uint64_t *dfree,
1105                                 uint64_t *dsize);
1106 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1107                                 const struct smb_filename *smb_filename,
1108                                 enum SMB_QUOTA_TYPE qtype,
1109                                 unid_t id,
1110                                 SMB_DISK_QUOTA *qt);
1111 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1112                            enum SMB_QUOTA_TYPE qtype, unid_t id,
1113                            SMB_DISK_QUOTA *qt);
1114 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1115                                       struct files_struct *fsp,
1116                                       struct shadow_copy_data *shadow_copy_data,
1117                                       bool labels);
1118 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1119                         const struct smb_filename *smb_fname,
1120                         struct vfs_statvfs_struct *statbuf);
1121 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1122                                       enum timestamp_set_resolution *p_ts_res);
1123 /*
1124  * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1125  */
1126 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1127                                         struct dfs_GetDFSReferral *r);
1128 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1129                         const struct smb_filename *smb_fname,
1130                         const char *mask,
1131                         uint32_t attributes);
1132 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1133                                         struct files_struct *fsp,
1134                                         const char *mask,
1135                                         uint32_t attributes);
1136 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1137                                         DIR *dirp,
1138                                         SMB_STRUCT_STAT *sbuf);
1139 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1140                           DIR *dirp, long offset);
1141 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1142                           DIR *dirp);
1143 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1144                              DIR *dirp);
1145 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1146                         const struct smb_filename *smb_fname,
1147                         mode_t mode);
1148 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1149                         const struct smb_filename *smb_fname);
1150 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1151                           DIR *dir);
1152 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1153                       struct smb_filename *smb_fname, struct files_struct *fsp,
1154                       int flags, mode_t mode);
1155 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1156                                   struct smb_request *req,
1157                                   uint16_t root_dir_fid,
1158                                   struct smb_filename *smb_fname,
1159                                   uint32_t access_mask,
1160                                   uint32_t share_access,
1161                                   uint32_t create_disposition,
1162                                   uint32_t create_options,
1163                                   uint32_t file_attributes,
1164                                   uint32_t oplock_request,
1165                                   struct smb2_lease *lease,
1166                                   uint64_t allocation_size,
1167                                   uint32_t private_flags,
1168                                   struct security_descriptor *sd,
1169                                   struct ea_list *ea_list,
1170                                   files_struct **result,
1171                                   int *pinfo,
1172                                   const struct smb2_create_blobs *in_context_blobs,
1173                                   struct smb2_create_blobs *out_context_blobs);
1174 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1175                        struct files_struct *fsp);
1176 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1177                            struct files_struct *fsp, void *data, size_t n,
1178                            off_t offset);
1179 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1180                                            TALLOC_CTX *mem_ctx,
1181                                            struct tevent_context *ev,
1182                                            struct files_struct *fsp,
1183                                            void *data,
1184                                            size_t n, off_t offset);
1185 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1186
1187 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1188                             struct files_struct *fsp, const void *data,
1189                             size_t n, off_t offset);
1190 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1191                                             TALLOC_CTX *mem_ctx,
1192                                             struct tevent_context *ev,
1193                                             struct files_struct *fsp,
1194                                             const void *data,
1195                                             size_t n, off_t offset);
1196 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1197
1198 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1199                              struct files_struct *fsp, off_t offset,
1200                              int whence);
1201 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1202                               files_struct *fromfsp, const DATA_BLOB *header,
1203                               off_t offset, size_t count);
1204 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1205                               files_struct *tofsp, off_t offset,
1206                               size_t count);
1207 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1208                         const struct smb_filename *smb_fname_src,
1209                         const struct smb_filename *smb_fname_dst);
1210
1211 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1212                                            TALLOC_CTX *mem_ctx,
1213                                            struct tevent_context *ev,
1214                                            struct files_struct *fsp);
1215 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1216
1217 int smb_vfs_fsync_sync(files_struct *fsp);
1218 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1219                       struct smb_filename *smb_fname);
1220 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1221                        struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1222 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1223                        struct smb_filename *smb_filename);
1224 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1225                                      struct files_struct *fsp,
1226                                      const SMB_STRUCT_STAT *sbuf);
1227 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1228                         const struct smb_filename *smb_fname);
1229 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1230                         const struct smb_filename *smb_fname,
1231                         mode_t mode);
1232 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1233                         struct files_struct *fsp, mode_t mode);
1234 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1235                         const struct smb_filename *smb_fname,
1236                         uid_t uid,
1237                         gid_t gid);
1238 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1239                         struct files_struct *fsp, uid_t uid, gid_t gid);
1240 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1241                         const struct smb_filename *smb_fname,
1242                         uid_t uid,
1243                         gid_t gid);
1244 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1245                         const struct smb_filename *smb_fname);
1246 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1247                                 TALLOC_CTX *ctx);
1248 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1249                         const struct smb_filename *smb_fname,
1250                         struct smb_file_time *ft);
1251 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1252                            struct files_struct *fsp, off_t offset);
1253 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1254                            struct files_struct *fsp,
1255                            uint32_t mode,
1256                            off_t offset,
1257                            off_t len);
1258 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1259                        struct files_struct *fsp, int op, off_t offset,
1260                        off_t count, int type);
1261 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1262                               struct files_struct *fsp, uint32_t share_mode,
1263                               uint32_t access_mask);
1264 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1265                                 struct files_struct *fsp, int leasetype);
1266 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1267                           struct files_struct *fsp, off_t *poffset,
1268                           off_t *pcount, int *ptype, pid_t *ppid);
1269 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1270                         const char *link_contents,
1271                         const struct smb_filename *new_smb_fname);
1272 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1273                         const struct smb_filename *smb_fname,
1274                         char *buf,
1275                         size_t bufsiz);
1276 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1277                         const struct smb_filename *old_smb_fname,
1278                         const struct smb_filename *new_smb_fname);
1279 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1280                         const struct smb_filename *smb_fname,
1281                         mode_t mode,
1282                         SMB_DEV_T dev);
1283 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1284                         TALLOC_CTX *ctx,
1285                         const struct smb_filename *smb_fname);
1286 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1287                         const struct smb_filename *smb_fname,
1288                         unsigned int flags);
1289 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1290                                            const SMB_STRUCT_STAT *sbuf);
1291 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1292                                  struct files_struct *fsp,
1293                                  const struct smb_filename *smb_fname,
1294                                  TALLOC_CTX *mem_ctx,
1295                                  unsigned int *num_streams,
1296                                  struct stream_struct **streams);
1297 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1298                                    const char *path, const char *name,
1299                                    TALLOC_CTX *mem_ctx, char **found_name);
1300 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1301                                      const struct smb_filename *smb_fname);
1302 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1303                                        struct byte_range_lock *br_lck,
1304                                        struct lock_struct *plock,
1305                                        bool blocking_lock);
1306 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1307                                      struct messaging_context *msg_ctx,
1308                                      struct byte_range_lock *br_lck,
1309                                      const struct lock_struct *plock);
1310 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1311                                      struct byte_range_lock *br_lck,
1312                                      struct lock_struct *plock);
1313 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1314                                     struct files_struct *fsp,
1315                                     struct lock_struct *plock);
1316 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1317                                      const char *name,
1318                                      enum vfs_translate_direction direction,
1319                                      TALLOC_CTX *mem_ctx,
1320                                      char **mapped_name);
1321 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1322                             struct files_struct *fsp,
1323                             TALLOC_CTX *ctx,
1324                             uint32_t function,
1325                             uint16_t req_flags,
1326                             const uint8_t *_in_data,
1327                             uint32_t in_len,
1328                             uint8_t **_out_data,
1329                             uint32_t max_out_len,
1330                             uint32_t *out_len);
1331 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1332                                          struct smb_filename *smb_fname,
1333                                          uint32_t *dosmode);
1334 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1335                                           struct files_struct *fsp,
1336                                           uint32_t *dosmode);
1337 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1338                                          const struct smb_filename *smb_fname,
1339                                          uint32_t dosmode);
1340 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1341                                           struct files_struct *fsp,
1342                                           uint32_t dosmode);
1343 struct tevent_req *smb_vfs_call_offload_read_send(
1344         TALLOC_CTX *mem_ctx,
1345         struct tevent_context *ev,
1346         struct vfs_handle_struct *handle,
1347         struct files_struct *fsp,
1348         uint32_t fsctl,
1349         uint32_t ttl,
1350         off_t offset,
1351         size_t to_copy);
1352 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1353                                         struct vfs_handle_struct *handle,
1354                                         TALLOC_CTX *mem_ctx,
1355                                         DATA_BLOB *token_blob);
1356 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1357                                                    TALLOC_CTX *mem_ctx,
1358                                                    struct tevent_context *ev,
1359                                                    uint32_t fsctl,
1360                                                    DATA_BLOB *token,
1361                                                    off_t transfer_offset,
1362                                                    struct files_struct *dest_fsp,
1363                                                    off_t dest_off,
1364                                                    off_t num);
1365 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1366                                          struct tevent_req *req,
1367                                          off_t *copied);
1368 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1369                                       TALLOC_CTX *mem_ctx,
1370                                       struct files_struct *fsp,
1371                                       struct smb_filename *smb_fname,
1372                                       uint16_t *_compression_fmt);
1373 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1374                                       TALLOC_CTX *mem_ctx,
1375                                       struct files_struct *fsp,
1376                                       uint16_t compression_fmt);
1377 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1378                                       TALLOC_CTX *mem_ctx,
1379                                       const char *service_path,
1380                                       char **base_volume);
1381 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1382                                   TALLOC_CTX *mem_ctx,
1383                                   const char *base_volume,
1384                                   time_t *tstamp,
1385                                   bool rw,
1386                                   char **base_path,
1387                                   char **snap_path);
1388 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1389                                   TALLOC_CTX *mem_ctx,
1390                                   char *base_path,
1391                                   char *snap_path);
1392 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1393                                   struct files_struct *fsp,
1394                                   uint32_t security_info,
1395                                   TALLOC_CTX *mem_ctx,
1396                                   struct security_descriptor **ppdesc);
1397 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1398                                  const struct smb_filename *smb_fname,
1399                                  uint32_t security_info,
1400                                  TALLOC_CTX *mem_ctx,
1401                                  struct security_descriptor **ppdesc);
1402 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1403                                   struct files_struct *fsp,
1404                                   uint32_t security_info_sent,
1405                                   const struct security_descriptor *psd);
1406 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1407                                  struct smb_filename *file,
1408                                  struct security_acl *sacl,
1409                                  uint32_t access_requested,
1410                                  uint32_t access_denied);
1411 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1412                                 const struct smb_filename *file,
1413                                 mode_t mode);
1414 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1415                                         const struct smb_filename *smb_fname,
1416                                         SMB_ACL_TYPE_T type,
1417                                         TALLOC_CTX *mem_ctx);
1418 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1419                                       struct files_struct *fsp,
1420                                       TALLOC_CTX *mem_ctx);
1421 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1422                                        const struct smb_filename *smb_fname,
1423                                        TALLOC_CTX *mem_ctx,
1424                                        char **blob_description,
1425                                        DATA_BLOB *blob);
1426 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1427                                      struct files_struct *fsp,
1428                                      TALLOC_CTX *mem_ctx,
1429                                      char **blob_description,
1430                                      DATA_BLOB *blob);
1431 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1432                                 const struct smb_filename *smb_fname,
1433                                 SMB_ACL_TYPE_T acltype,
1434                                 SMB_ACL_T theacl);
1435 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1436                                 struct files_struct *fsp, SMB_ACL_T theacl);
1437 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1438                                 const struct smb_filename *smb_fname);
1439 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1440                                 const struct smb_filename *smb_fname,
1441                                 const char *name,
1442                                 void *value,
1443                                 size_t size);
1444 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1445                                struct files_struct *fsp, const char *name,
1446                                void *value, size_t size);
1447 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1448                                 const struct smb_filename *smb_fname,
1449                                 char *list,
1450                                 size_t size);
1451 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1452                                 struct files_struct *fsp, char *list,
1453                                 size_t size);
1454 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1455                                 const struct smb_filename *smb_fname,
1456                                 const char *name);
1457 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1458                               struct files_struct *fsp, const char *name);
1459 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1460                                 const struct smb_filename *smb_fname,
1461                                 const char *name,
1462                                 const void *value,
1463                                 size_t size,
1464                                 int flags);
1465 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1466                            const char *name, const void *value, size_t size,
1467                            int flags);
1468 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1469                            struct files_struct *fsp, const char *name,
1470                            const void *value, size_t size, int flags);
1471 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1472                             struct files_struct *fsp);
1473 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1474                                      struct files_struct *fsp,
1475                                      TALLOC_CTX *mem_ctx,
1476                                      DATA_BLOB *cookie);
1477 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1478                                          struct files_struct *fsp,
1479                                          const DATA_BLOB old_cookie,
1480                                          TALLOC_CTX *mem_ctx,
1481                                          DATA_BLOB *new_cookie);
1482 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1483                                         struct smb_request *smb1req,
1484                                         struct smbXsrv_open *op,
1485                                         const DATA_BLOB old_cookie,
1486                                         TALLOC_CTX *mem_ctx,
1487                                         struct files_struct **fsp,
1488                                         DATA_BLOB *new_cookie);
1489 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1490                                    const struct smb_filename *fname,
1491                                    TALLOC_CTX *mem_ctx,
1492                                    struct readdir_attr_data **attr_data);
1493
1494 NTSTATUS smb_register_vfs(int version, const char *name,
1495                           const struct vfs_fn_pointers *fns);
1496 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1497                                    files_struct *fsp, size_t ext_size,
1498                                    void (*destroy_fn)(void *p_data));
1499 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1500 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1501 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1502 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1503
1504 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1505                             const char *module);
1506
1507 /*
1508  * Notice the "Design of the smb_vfs_ev_glue infrastructure"
1509  * comment in source3/smbd/vfs.c!
1510  *
1511  * This explains smb_vfs_ev_glue infrastructure in detail.
1512  */
1513 struct tevent_context *smb_vfs_ev_glue_ev_ctx(const struct smb_vfs_ev_glue *evg);
1514 struct pthreadpool_tevent *smb_vfs_ev_glue_tp_fd_safe(const struct smb_vfs_ev_glue *evg);
1515 struct pthreadpool_tevent *smb_vfs_ev_glue_tp_path_safe(const struct smb_vfs_ev_glue *evg);
1516 struct pthreadpool_tevent *smb_vfs_ev_glue_tp_chdir_safe(const struct smb_vfs_ev_glue *evg);
1517 const struct smb_vfs_ev_glue *smb_vfs_ev_glue_get_root_glue(const struct smb_vfs_ev_glue *evg);
1518 struct smb_vfs_ev_glue *smb_vfs_ev_glue_create(TALLOC_CTX *mem_ctx,
1519                                 struct tevent_context *user_ev,
1520                                 struct pthreadpool_tevent *user_tp_fd_safe,
1521                                 struct pthreadpool_tevent *user_tp_path_safe,
1522                                 struct pthreadpool_tevent *user_tp_chdir_safe,
1523                                 struct tevent_context *root_ev,
1524                                 struct pthreadpool_tevent *root_tp_fd_safe,
1525                                 struct pthreadpool_tevent *root_tp_path_safe,
1526                                 struct pthreadpool_tevent *root_tp_chdir_safe);
1527 struct smb_vfs_ev_glue *smb_vfs_ev_glue_create_switch(
1528                         TALLOC_CTX *mem_ctx,
1529                         const struct smb_vfs_ev_glue *return_evg,
1530                         const struct smb_vfs_ev_glue *run_evg);
1531
1532 #endif /* _VFS_H */