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
 245 #define SMB_VFS_INTERFACE_VERSION 37
 246
 247 /*
 248     All intercepted VFS operations must be declared as static functions inside module source
 249     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
 250     example VFS modules for more details.
 251 */
 252
 253 /* VFS operations structure */
 254
 255 struct vfs_handle_struct;
 256 struct connection_struct;
 257 struct files_struct;
 258 struct security_descriptor;
 259 struct vfs_statvfs_struct;
 260 struct smb_request;
 261 struct ea_list;
 262 struct smb_file_time;
 263 struct blocking_lock_record;
 264 struct smb_filename;
 265 struct dfs_GetDFSReferral;
 266
 267 typedef union unid_t {
 268         uid_t uid;
 269         gid_t gid;
 270 } unid_t;
 271
 272 struct fd_handle {
 273         size_t ref_count;
 274         int fd;
 275         uint64_t position_information;
 276         off_t pos;
 277         uint32_t private_options;       /* NT Create options, but we only look at
 278                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
 279                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
 280                                  * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
 281                                  * for print files *only*, where
 282                                  * DELETE_ON_CLOSE is not stored in the share
 283                                  * mode database.
 284                                  */
 285         unsigned long gen_id;
 286 };
 287
 288 struct fsp_lease {
 289         size_t ref_count;
 290         struct smbd_server_connection *sconn;
 291         struct tevent_timer *timeout;
 292         struct smb2_lease lease;
 293 };
 294
 295 typedef struct files_struct {
 296         struct files_struct *next, *prev;
 297         uint64_t fnum;
 298         struct smbXsrv_open *op;
 299         struct connection_struct *conn;
 300         struct fd_handle *fh;
 301         unsigned int num_smb_operations;
 302         struct file_id file_id;
 303         uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
 304         uint16_t file_pid;
 305         uint64_t vuid; /* SMB2 compat */
 306         struct write_cache *wcp;
 307         struct timeval open_time;
 308         uint32_t access_mask;           /* NTCreateX access bits (FILE_READ_DATA etc.) */
 309         uint32_t share_access;          /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 310
 311         bool kernel_share_modes_taken;
 312
 313         bool update_write_time_triggered;
 314         struct tevent_timer *update_write_time_event;
 315         bool update_write_time_on_close;
 316         struct timespec close_write_time;
 317         bool write_time_forced;
 318
 319         int oplock_type;
 320         struct fsp_lease *lease;
 321         int sent_oplock_break;
 322         struct tevent_timer *oplock_timeout;
 323         struct lock_struct last_lock_failure;
 324         int current_lock_count; /* Count the number of outstanding locks and pending locks. */
 325
 326         bool can_lock;
 327         bool can_read;
 328         bool can_write;
 329         bool modified;
 330         bool is_directory;
 331         bool aio_write_behind;
 332         bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
 333         bool delete_on_close;
 334         uint64_t posix_flags;
 335         bool is_sparse;
 336         bool backup_intent; /* Handle was successfully opened with backup intent
 337                                 and opener has privilege to do so. */
 338         bool aapl_copyfile_supported;
 339         bool use_ofd_locks; /* Are we using open file description locks ? */
 340         struct smb_filename *fsp_name;
 341         uint32_t name_hash;             /* Jenkins hash of full pathname. */
 342         uint64_t mid;                   /* Mid of the operation that created us. */
 343
 344         struct vfs_fsp_data *vfs_extension;
 345         struct fake_file_handle *fake_file_handle;
 346
 347         struct notify_change_buf *notify;
 348
 349         struct files_struct *base_fsp; /* placeholder for delete on close */
 350
 351         /*
 352          * Read-only cached brlock record, thrown away when the
 353          * brlock.tdb seqnum changes. This avoids fetching data from
 354          * the brlock.tdb on every read/write call.
 355          */
 356         int brlock_seqnum;
 357         struct byte_range_lock *brlock_rec;
 358
 359         struct dptr_struct *dptr;
 360
 361         /* if not NULL, means this is a print file */
 362         struct print_file_data *print_file;
 363
 364         unsigned num_aio_requests;
 365         struct tevent_req **aio_requests;
 366
 367         /*
 368          * If a close request comes in while we still have aio_requests
 369          * around, we need to hold back the close. When all aio_requests are
 370          * done, the aio completion routines need tevent_wait_done() on
 371          * this. A bit ugly, but before we have close_file() fully async
 372          * possibly the simplest approach. Thanks, Jeremy for the idea.
 373          */
 374         struct tevent_req *deferred_close;
 375 } files_struct;
 376
 377 #define FSP_POSIX_FLAGS_OPEN            0x01
 378 #define FSP_POSIX_FLAGS_RENAME          0x02
 379 #define FSP_POSIX_FLAGS_PATHNAMES       0x04
 380
 381 #define FSP_POSIX_FLAGS_ALL                     \
 382         (FSP_POSIX_FLAGS_OPEN |                 \
 383          FSP_POSIX_FLAGS_PATHNAMES |            \
 384          FSP_POSIX_FLAGS_RENAME)
 385
 386 struct vuid_cache_entry {
 387         struct auth_session_info *session_info;
 388         uint64_t vuid; /* SMB2 compat */
 389         bool read_only;
 390         uint32_t share_access;
 391 };
 392
 393 struct vuid_cache {
 394         unsigned int next_entry;
 395         struct vuid_cache_entry array[VUID_CACHE_SIZE];
 396 };
 397
 398 typedef struct {
 399         char *name;
 400         bool is_wild;
 401 } name_compare_entry;
 402
 403 struct dfree_cached_info {
 404         time_t last_dfree_time;
 405         uint64_t dfree_ret;
 406         uint64_t bsize;
 407         uint64_t dfree;
 408         uint64_t dsize;
 409 };
 410
 411 struct share_params {
 412         int service;
 413 };
 414
 415 typedef struct connection_struct {
 416         struct connection_struct *next, *prev;
 417         struct smbd_server_connection *sconn; /* can be NULL */
 418         struct smbXsrv_tcon *tcon; /* can be NULL */
 419         uint32_t cnum; /* an index passed over the wire */
 420         struct share_params *params;
 421         bool force_user;
 422         struct vuid_cache *vuid_cache;
 423         bool printer;
 424         bool ipc;
 425         bool read_only; /* Attributes for the current user of the share. */
 426         uint32_t share_access;
 427         /* Does this filesystem honor
 428            sub second timestamps on files
 429            and directories when setting time ? */
 430         enum timestamp_set_resolution ts_res;
 431         char *connectpath;
 432         char *origpath;
 433         struct smb_filename *cwd_fname; /* Working directory. */
 434
 435         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
 436
 437         /*
 438          * This represents the user information on this connection. Depending
 439          * on the vuid using this tid, this might change per SMB request.
 440          */
 441         struct auth_session_info *session_info;
 442
 443         /*
 444          * If the "force group" parameter is set, this is the primary gid that
 445          * may be used in the users token, depending on the vuid using this tid.
 446          */
 447         gid_t force_group_gid;
 448
 449         uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
 450
 451         time_t lastused;
 452         time_t lastused_count;
 453         int num_files_open;
 454         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
 455         int encrypt_level;
 456         bool encrypted_tid;
 457
 458         /* Semantics requested by the client or forced by the server config. */
 459         bool case_sensitive;
 460         bool case_preserve;
 461         bool short_case_preserve;
 462
 463         /* Semantics provided by the underlying filesystem. */
 464         int fs_capabilities;
 465         /* Device number of the directory of the share mount.
 466            Used to ensure unique FileIndex returns. */
 467         SMB_DEV_T base_share_dev;
 468
 469         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
 470         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
 471         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
 472         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
 473         struct dfree_cached_info *dfree_info;
 474         struct trans_state *pending_trans;
 475
 476         struct rpc_pipe_client *spoolss_pipe;
 477
 478 } connection_struct;
 479
 480 struct smbd_smb2_request;
 481 struct privilege_paths;
 482
 483 struct smb_request {
 484         uint8_t cmd;
 485         uint16_t flags2;
 486         uint16_t smbpid;
 487         uint64_t mid; /* For compatibility with SMB2. */
 488         uint32_t seqnum;
 489         uint64_t vuid; /* For compatibility with SMB2. */
 490         uint32_t tid;
 491         uint8_t  wct;
 492         const uint16_t *vwv;
 493         uint16_t buflen;
 494         const uint8_t *buf;
 495         const uint8_t *inbuf;
 496
 497         /*
 498          * Async handling in the main smb processing loop is directed by
 499          * outbuf: reply_xxx routines indicate sync behaviour by putting their
 500          * reply into "outbuf". If they leave it as NULL, they take care of it
 501          * themselves, possibly later.
 502          *
 503          * If async handling is wanted, the reply_xxx routine must make sure
 504          * that it talloc_move()s the smb_req somewhere else.
 505          */
 506         uint8_t *outbuf;
 507
 508         size_t unread_bytes;
 509         bool encrypted;
 510         connection_struct *conn;
 511         struct smbd_server_connection *sconn;
 512         struct smbXsrv_connection *xconn;
 513         struct smb_perfcount_data pcd;
 514
 515         /*
 516          * Chained request handling
 517          */
 518         struct files_struct *chain_fsp;
 519
 520         /*
 521          * state information for async smb handling
 522          */
 523         void *async_priv;
 524
 525         /*
 526          * Back pointer to smb2 request.
 527          */
 528         struct smbd_smb2_request *smb2req;
 529
 530         /*
 531          * Pathnames used if request done
 532          * under privilege.
 533          */
 534         struct privilege_paths *priv_paths;
 535
 536         /*
 537          * Request list for chained requests, we're part of it.
 538          */
 539         struct smb_request **chain;
 540
 541         struct timeval request_time;
 542
 543         bool posix_pathnames;
 544 };
 545
 546 /*
 547  * Info about an alternate data stream
 548  */
 549
 550 struct stream_struct {
 551         off_t size;
 552         off_t alloc_size;
 553         char *name;
 554 };
 555
 556 /* time info */
 557 struct smb_file_time {
 558         struct timespec mtime;
 559         struct timespec atime;
 560         struct timespec ctime;
 561         struct timespec create_time;
 562 };
 563
 564 /*
 565  * smb_filename
 566  */
 567 struct smb_filename {
 568         char *base_name;
 569         char *stream_name;
 570         char *original_lcomp;
 571         uint32_t flags;
 572         SMB_STRUCT_STAT st;
 573 };
 574
 575 /*
 576  * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
 577  * to keep the numeric values consistent.
 578  */
 579
 580 #define SMB_FILENAME_POSIX_PATH         FSP_POSIX_FLAGS_PATHNAMES
 581
 582 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
 583                                 handle = handle->next; \
 584                          }
 585
 586 enum vfs_translate_direction {
 587         vfs_translate_to_unix = 0,
 588         vfs_translate_to_windows
 589 };
 590
 591 enum vfs_fallocate_flags {
 592         VFS_FALLOCATE_FL_KEEP_SIZE              = 0x0001,
 593         VFS_FALLOCATE_FL_PUNCH_HOLE             = 0x0002,
 594 };
 595
 596 /*
 597  * @VFS_OFFLOAD_WRITE_FL_MUST_CLONE: indicates that offload_write_send_fn() copy must
 598  *                                be handled as a COW clone, AKA reflink.
 599  * @VFS_OFFLOAD_WRITE_FL_MASK_ALL: all valid flags.
 600  */
 601 enum vfs_offload_write_flags {
 602         VFS_OFFLOAD_WRITE_FL_MUST_CLONE         = 0x0001,
 603         VFS_OFFLOAD_WRITE_FL_IGNORE_LOCKS       = 0x0002,
 604
 605         VFS_OFFLOAD_WRITE_FL_MASK_ALL           =
 606                                         (VFS_OFFLOAD_WRITE_FL_MUST_CLONE
 607                                          | VFS_OFFLOAD_WRITE_FL_IGNORE_LOCKS),
 608 };
 609
 610 struct vfs_aio_state {
 611         int error;
 612         uint64_t duration;
 613 };
 614
 615 /*
 616     Available VFS operations. These values must be in sync with vfs_ops struct
 617     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
 618     In particular, if new operations are added to vfs_ops, appropriate constants
 619     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
 620 */
 621 struct shadow_copy_data;
 622
 623 struct vfs_fn_pointers {
 624         /* Disk operations */
 625
 626         int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
 627         void (*disconnect_fn)(struct vfs_handle_struct *handle);
 628         uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
 629                                 const struct smb_filename *smb_fname,
 630                                 uint64_t *bsize,
 631                                 uint64_t *dfree,
 632                                 uint64_t *dsize);
 633         int (*get_quota_fn)(struct vfs_handle_struct *handle,
 634                                 const struct smb_filename *smb_fname,
 635                                 enum SMB_QUOTA_TYPE qtype,
 636                                 unid_t id,
 637                                 SMB_DISK_QUOTA *qt);
 638         int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 639         int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
 640         int (*statvfs_fn)(struct vfs_handle_struct *handle,
 641                                 const struct smb_filename *smb_fname,
 642                                 struct vfs_statvfs_struct *statbuf);
 643         uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
 644
 645         /*
 646          * Note: that "struct dfs_GetDFSReferral *r"
 647          * needs to be a valid TALLOC_CTX
 648          */
 649         NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
 650                                          struct dfs_GetDFSReferral *r);
 651
 652         /* Directory operations */
 653
 654         DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
 655                                         const struct smb_filename *smb_fname,
 656                                         const char *mask,
 657                                         uint32_t attributes);
 658         DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
 659         struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
 660                                          DIR *dirp,
 661                                          SMB_STRUCT_STAT *sbuf);
 662         void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
 663         long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 664         void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 665         int (*mkdir_fn)(struct vfs_handle_struct *handle,
 666                         const struct smb_filename *smb_fname,
 667                         mode_t mode);
 668         int (*rmdir_fn)(struct vfs_handle_struct *handle,
 669                         const struct smb_filename *smb_fname);
 670         int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
 671         void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 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 (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
 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 (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
 708         ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
 709         struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
 710                                              TALLOC_CTX *mem_ctx,
 711                                              struct tevent_context *ev,
 712                                              struct files_struct *fsp,
 713                                              const void *data,
 714                                              size_t n, off_t offset);
 715         ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 716         off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
 717         ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
 718         ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
 719         int (*rename_fn)(struct vfs_handle_struct *handle,
 720                          const struct smb_filename *smb_fname_src,
 721                          const struct smb_filename *smb_fname_dst);
 722         int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 723         struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
 724                                             TALLOC_CTX *mem_ctx,
 725                                             struct tevent_context *ev,
 726                                             struct files_struct *fsp);
 727         int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 728         int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
 729         int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
 730         int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
 731         uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
 732         int (*unlink_fn)(struct vfs_handle_struct *handle,
 733                          const struct smb_filename *smb_fname);
 734         int (*chmod_fn)(struct vfs_handle_struct *handle,
 735                         const struct smb_filename *smb_fname,
 736                         mode_t mode);
 737         int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 738         int (*chown_fn)(struct vfs_handle_struct *handle,
 739                         const struct smb_filename *smb_fname,
 740                         uid_t uid,
 741                         gid_t gid);
 742         int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
 743         int (*lchown_fn)(struct vfs_handle_struct *handle,
 744                         const struct smb_filename *smb_fname,
 745                         uid_t uid,
 746                         gid_t gid);
 747         int (*chdir_fn)(struct vfs_handle_struct *handle,
 748                          const struct smb_filename *smb_fname);
 749         struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
 750                                 TALLOC_CTX *mem_ctx);
 751         int (*ntimes_fn)(struct vfs_handle_struct *handle,
 752                          const struct smb_filename *smb_fname,
 753                          struct smb_file_time *ft);
 754         int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
 755         int (*fallocate_fn)(struct vfs_handle_struct *handle,
 756                             struct files_struct *fsp,
 757                             uint32_t mode,
 758                             off_t offset,
 759                             off_t len);
 760         bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
 761         int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 762                                uint32_t share_mode, uint32_t access_mask);
 763         int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
 764         bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
 765         int (*symlink_fn)(struct vfs_handle_struct *handle,
 766                                 const char *link_contents,
 767                                 const struct smb_filename *new_smb_fname);
 768         int (*readlink_fn)(struct vfs_handle_struct *handle,
 769                                 const struct smb_filename *smb_fname,
 770                                 char *buf,
 771                                 size_t bufsiz);
 772         int (*link_fn)(struct vfs_handle_struct *handle,
 773                                 const struct smb_filename *old_smb_fname,
 774                                 const struct smb_filename *new_smb_fname);
 775         int (*mknod_fn)(struct vfs_handle_struct *handle,
 776                                 const struct smb_filename *smb_fname,
 777                                 mode_t mode,
 778                                 SMB_DEV_T dev);
 779         struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
 780                                 TALLOC_CTX *ctx,
 781                                 const struct smb_filename *smb_fname);
 782         int (*chflags_fn)(struct vfs_handle_struct *handle,
 783                                 const struct smb_filename *smb_fname,
 784                                 unsigned int flags);
 785         struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
 786                                             const SMB_STRUCT_STAT *sbuf);
 787         struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
 788                                                    struct tevent_context *ev,
 789                                                    struct vfs_handle_struct *handle,
 790                                                    struct files_struct *fsp,
 791                                                    uint32_t fsctl,
 792                                                    uint32_t ttl,
 793                                                    off_t offset,
 794                                                    size_t to_copy);
 795         NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
 796                                          struct vfs_handle_struct *handle,
 797                                          TALLOC_CTX *mem_ctx,
 798                                          DATA_BLOB *token_blob);
 799         struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
 800                                                     TALLOC_CTX *mem_ctx,
 801                                                     struct tevent_context *ev,
 802                                                     uint32_t fsctl,
 803                                                     DATA_BLOB *token,
 804                                                     off_t transfer_offset,
 805                                                     struct files_struct *dest_fsp,
 806                                                     off_t dest_off,
 807                                                     off_t to_copy,
 808                                                     uint32_t flags);
 809         NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
 810                                           struct tevent_req *req,
 811                                           off_t *copied);
 812         NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
 813                                        TALLOC_CTX *mem_ctx,
 814                                        struct files_struct *fsp,
 815                                        struct smb_filename *smb_fname,
 816                                        uint16_t *_compression_fmt);
 817         NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
 818                                        TALLOC_CTX *mem_ctx,
 819                                        struct files_struct *fsp,
 820                                        uint16_t compression_fmt);
 821         NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
 822                                        TALLOC_CTX *mem_ctx,
 823                                        const char *service_path,
 824                                        char **base_volume);
 825         NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
 826                                    TALLOC_CTX *mem_ctx,
 827                                    const char *base_volume,
 828                                    time_t *tstamp,
 829                                    bool rw,
 830                                    char **base_path,
 831                                    char **snap_path);
 832         NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
 833                                    TALLOC_CTX *mem_ctx,
 834                                    char *base_path,
 835                                    char *snap_path);
 836
 837         NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
 838                                   struct files_struct *fsp,
 839                                   const struct smb_filename *smb_fname,
 840                                   TALLOC_CTX *mem_ctx,
 841                                   unsigned int *num_streams,
 842                                   struct stream_struct **streams);
 843
 844         int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
 845                                     const char *path,
 846                                     const char *name,
 847                                     TALLOC_CTX *mem_ctx,
 848                                     char **found_name);
 849
 850         const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
 851                                       const struct smb_filename *smb_fname);
 852
 853         NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
 854                                         struct byte_range_lock *br_lck,
 855                                         struct lock_struct *plock,
 856                                         bool blocking_lock);
 857
 858         bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
 859                                       struct messaging_context *msg_ctx,
 860                                       struct byte_range_lock *br_lck,
 861                                       const struct lock_struct *plock);
 862
 863         bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
 864                                       struct byte_range_lock *br_lck,
 865                                       struct lock_struct *plock);
 866
 867         bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
 868                                struct files_struct *fsp,
 869                                struct lock_struct *plock);
 870
 871         void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
 872                                  struct files_struct *fsp,
 873                                  struct lock_struct *plock);
 874
 875         NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
 876                                       const char *name,
 877                                       enum vfs_translate_direction direction,
 878                                       TALLOC_CTX *mem_ctx,
 879                                       char **mapped_name);
 880
 881         NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
 882                              struct files_struct *fsp,
 883                              TALLOC_CTX *ctx,
 884                              uint32_t function,
 885                              uint16_t req_flags,
 886                              const uint8_t *_in_data,
 887                              uint32_t in_len,
 888                              uint8_t **_out_data,
 889                              uint32_t max_out_len,
 890                              uint32_t *out_len);
 891
 892         NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
 893                                           struct smb_filename *smb_fname,
 894                                           uint32_t *dosmode);
 895
 896         NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
 897                                            struct files_struct *fsp,
 898                                            uint32_t *dosmode);
 899
 900         NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
 901                                           const struct smb_filename *smb_fname,
 902                                           uint32_t dosmode);
 903
 904         NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
 905                                            struct files_struct *fsp,
 906                                            uint32_t dosmode);
 907
 908         /* NT ACL operations. */
 909
 910         NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
 911                                    struct files_struct *fsp,
 912                                    uint32_t security_info,
 913                                    TALLOC_CTX *mem_ctx,
 914                                    struct security_descriptor **ppdesc);
 915         NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
 916                                   const struct smb_filename *smb_fname,
 917                                   uint32_t security_info,
 918                                    TALLOC_CTX *mem_ctx,
 919                                   struct security_descriptor **ppdesc);
 920         NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
 921                                    struct files_struct *fsp,
 922                                    uint32_t security_info_sent,
 923                                    const struct security_descriptor *psd);
 924
 925         NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
 926                                   struct smb_filename *file,
 927                                   struct security_acl *sacl,
 928                                   uint32_t access_requested,
 929                                   uint32_t access_denied);
 930
 931         /* POSIX ACL operations. */
 932
 933         int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
 934                                         const struct smb_filename *smb_fname,
 935                                         mode_t mode);
 936         int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 937
 938         SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
 939                                          const struct smb_filename *smb_fname,
 940                                          SMB_ACL_TYPE_T type,
 941                                          TALLOC_CTX *mem_ctx);
 942         SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
 943                                        struct files_struct *fsp,
 944                                        TALLOC_CTX *mem_ctx);
 945         int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
 946                                         const struct smb_filename *smb_fname,
 947                                         TALLOC_CTX *mem_ctx,
 948                                         char **blob_description,
 949                                         DATA_BLOB *blob);
 950         int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 951                                       TALLOC_CTX *mem_ctx, char **blob_description,
 952                                       DATA_BLOB *blob);
 953         int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
 954                                         const struct smb_filename *smb_fname,
 955                                         SMB_ACL_TYPE_T acltype,
 956                                         SMB_ACL_T theacl);
 957         int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
 958         int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
 959                                         const struct smb_filename *smb_fname);
 960
 961         /* EA operations. */
 962         ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
 963                                         const struct smb_filename *smb_fname,
 964                                         const char *name,
 965                                         void *value,
 966                                         size_t size);
 967         ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
 968         ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
 969                                         const struct smb_filename *smb_fname,
 970                                         char *list,
 971                                         size_t size);
 972         ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
 973         int (*removexattr_fn)(struct vfs_handle_struct *handle,
 974                                         const struct smb_filename *smb_fname,
 975                                         const char *name);
 976         int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
 977         int (*setxattr_fn)(struct vfs_handle_struct *handle,
 978                                         const struct smb_filename *smb_fname,
 979                                         const char *name,
 980                                         const void *value,
 981                                         size_t size,
 982                                         int flags);
 983         int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
 984
 985         /* aio operations */
 986         bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 987
 988         /* durable handle operations */
 989         NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
 990                                       struct files_struct *fsp,
 991                                       TALLOC_CTX *mem_ctx,
 992                                       DATA_BLOB *cookie);
 993         NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
 994                                           struct files_struct *fsp,
 995                                           const DATA_BLOB old_cookie,
 996                                           TALLOC_CTX *mem_ctx,
 997                                           DATA_BLOB *new_cookie);
 998         NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
 999                                          struct smb_request *smb1req,
1000                                          struct smbXsrv_open *op,
1001                                          const DATA_BLOB old_cookie,
1002                                          TALLOC_CTX *mem_ctx,
1003                                          struct files_struct **fsp,
1004                                          DATA_BLOB *new_cookie);
1005
1006         NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
1007                                     const struct smb_filename *fname,
1008                                     TALLOC_CTX *mem_ctx,
1009                                     struct readdir_attr_data **attr_data);
1010 };
1011
1012 /*
1013     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1014     which describes all operations this module is willing to intercept.
1015     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1016     using this information.
1017 */
1018
1019 typedef struct vfs_handle_struct {
1020         struct vfs_handle_struct  *next, *prev;
1021         const char *param;
1022         struct connection_struct *conn;
1023         const struct vfs_fn_pointers *fns;
1024         void *data;
1025         void (*free_data)(void **data);
1026 } vfs_handle_struct;
1027
1028
1029 typedef struct vfs_statvfs_struct {
1030         /* For undefined recommended transfer size return -1 in that field */
1031         uint32_t OptimalTransferSize;  /* bsize on some os, iosize on other os */
1032         uint32_t BlockSize;
1033
1034         /*
1035          The next three fields are in terms of the block size.
1036          (above). If block size is unknown, 4096 would be a
1037          reasonable block size for a server to report.
1038          Note that returning the blocks/blocksavail removes need
1039          to make a second call (to QFSInfo level 0x103 to get this info.
1040          UserBlockAvail is typically less than or equal to BlocksAvail,
1041          if no distinction is made return the same value in each.
1042         */
1043
1044         uint64_t TotalBlocks;
1045         uint64_t BlocksAvail;       /* bfree */
1046         uint64_t UserBlocksAvail;   /* bavail */
1047
1048         /* For undefined Node fields or FSID return -1 */
1049         uint64_t TotalFileNodes;
1050         uint64_t FreeFileNodes;
1051         uint64_t FsIdentifier;   /* fsid */
1052         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1053         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
1054
1055         int FsCapabilities;
1056 } vfs_statvfs_struct;
1057
1058 /* Add a new FSP extension of the given type. Returns a pointer to the
1059  * extenstion data.
1060  */
1061 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn)            \
1062     vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1063
1064 /* Return a pointer to the existing FSP extension data. */
1065 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1066     vfs_fetch_fsp_extension(handle, (fsp))
1067
1068 /* Return the talloc context associated with an FSP extension. */
1069 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1070     vfs_memctx_fsp_extension(handle, (fsp))
1071
1072 /* Remove and destroy an FSP extension. */
1073 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1074     vfs_remove_fsp_extension((handle), (fsp))
1075
1076 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1077         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1078                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1079                 ret; \
1080         } \
1081 }
1082
1083 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1084         if (!(handle)) { \
1085                 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1086                 ret; \
1087         } else { \
1088                 if ((handle)->free_data) { \
1089                         (handle)->free_data(&(handle)->data); \
1090                 } \
1091                 (handle)->data = (void *)datap; \
1092                 (handle)->free_data = free_fn; \
1093         } \
1094 }
1095
1096 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1097         if ((handle) && (handle)->free_data) { \
1098                 (handle)->free_data(&(handle)->data); \
1099         } \
1100 }
1101
1102 /* Check whether module-specific data handle was already allocated or not */
1103 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
1104
1105 #define SMB_VFS_OP(x) ((void *) x)
1106
1107 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1108
1109 #include "vfs_macros.h"
1110
1111 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1112                          const char *service, const char *user);
1113 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1114 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1115                                 const struct smb_filename *smb_filename,
1116                                 uint64_t *bsize,
1117                                 uint64_t *dfree,
1118                                 uint64_t *dsize);
1119 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1120                                 const struct smb_filename *smb_filename,
1121                                 enum SMB_QUOTA_TYPE qtype,
1122                                 unid_t id,
1123                                 SMB_DISK_QUOTA *qt);
1124 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1125                            enum SMB_QUOTA_TYPE qtype, unid_t id,
1126                            SMB_DISK_QUOTA *qt);
1127 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1128                                       struct files_struct *fsp,
1129                                       struct shadow_copy_data *shadow_copy_data,
1130                                       bool labels);
1131 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1132                         const struct smb_filename *smb_fname,
1133                         struct vfs_statvfs_struct *statbuf);
1134 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1135                                       enum timestamp_set_resolution *p_ts_res);
1136 /*
1137  * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1138  */
1139 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1140                                         struct dfs_GetDFSReferral *r);
1141 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1142                         const struct smb_filename *smb_fname,
1143                         const char *mask,
1144                         uint32_t attributes);
1145 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1146                                         struct files_struct *fsp,
1147                                         const char *mask,
1148                                         uint32_t attributes);
1149 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1150                                         DIR *dirp,
1151                                         SMB_STRUCT_STAT *sbuf);
1152 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1153                           DIR *dirp, long offset);
1154 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1155                           DIR *dirp);
1156 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1157                              DIR *dirp);
1158 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1159                         const struct smb_filename *smb_fname,
1160                         mode_t mode);
1161 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1162                         const struct smb_filename *smb_fname);
1163 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1164                           DIR *dir);
1165 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1166                                  DIR *dirp);
1167 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1168                       struct smb_filename *smb_fname, struct files_struct *fsp,
1169                       int flags, mode_t mode);
1170 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1171                                   struct smb_request *req,
1172                                   uint16_t root_dir_fid,
1173                                   struct smb_filename *smb_fname,
1174                                   uint32_t access_mask,
1175                                   uint32_t share_access,
1176                                   uint32_t create_disposition,
1177                                   uint32_t create_options,
1178                                   uint32_t file_attributes,
1179                                   uint32_t oplock_request,
1180                                   struct smb2_lease *lease,
1181                                   uint64_t allocation_size,
1182                                   uint32_t private_flags,
1183                                   struct security_descriptor *sd,
1184                                   struct ea_list *ea_list,
1185                                   files_struct **result,
1186                                   int *pinfo,
1187                                   const struct smb2_create_blobs *in_context_blobs,
1188                                   struct smb2_create_blobs *out_context_blobs);
1189 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1190                        struct files_struct *fsp);
1191 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1192                           struct files_struct *fsp, void *data, size_t n);
1193 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1194                            struct files_struct *fsp, void *data, size_t n,
1195                            off_t offset);
1196 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1197                                            TALLOC_CTX *mem_ctx,
1198                                            struct tevent_context *ev,
1199                                            struct files_struct *fsp,
1200                                            void *data,
1201                                            size_t n, off_t offset);
1202 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1203
1204 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1205                            struct files_struct *fsp, const void *data,
1206                            size_t n);
1207 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1208                             struct files_struct *fsp, const void *data,
1209                             size_t n, off_t offset);
1210 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1211                                             TALLOC_CTX *mem_ctx,
1212                                             struct tevent_context *ev,
1213                                             struct files_struct *fsp,
1214                                             const void *data,
1215                                             size_t n, off_t offset);
1216 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1217
1218 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1219                              struct files_struct *fsp, off_t offset,
1220                              int whence);
1221 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1222                               files_struct *fromfsp, const DATA_BLOB *header,
1223                               off_t offset, size_t count);
1224 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1225                               files_struct *tofsp, off_t offset,
1226                               size_t count);
1227 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1228                         const struct smb_filename *smb_fname_src,
1229                         const struct smb_filename *smb_fname_dst);
1230 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1231                        struct files_struct *fsp);
1232
1233 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1234                                            TALLOC_CTX *mem_ctx,
1235                                            struct tevent_context *ev,
1236                                            struct files_struct *fsp);
1237 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1238
1239 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1240                       struct smb_filename *smb_fname);
1241 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1242                        struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1243 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1244                        struct smb_filename *smb_filename);
1245 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1246                                      struct files_struct *fsp,
1247                                      const SMB_STRUCT_STAT *sbuf);
1248 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1249                         const struct smb_filename *smb_fname);
1250 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1251                         const struct smb_filename *smb_fname,
1252                         mode_t mode);
1253 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1254                         struct files_struct *fsp, mode_t mode);
1255 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1256                         const struct smb_filename *smb_fname,
1257                         uid_t uid,
1258                         gid_t gid);
1259 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1260                         struct files_struct *fsp, uid_t uid, gid_t gid);
1261 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1262                         const struct smb_filename *smb_fname,
1263                         uid_t uid,
1264                         gid_t gid);
1265 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1266                         const struct smb_filename *smb_fname);
1267 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1268                                 TALLOC_CTX *ctx);
1269 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1270                         const struct smb_filename *smb_fname,
1271                         struct smb_file_time *ft);
1272 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1273                            struct files_struct *fsp, off_t offset);
1274 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1275                            struct files_struct *fsp,
1276                            uint32_t mode,
1277                            off_t offset,
1278                            off_t len);
1279 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1280                        struct files_struct *fsp, int op, off_t offset,
1281                        off_t count, int type);
1282 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1283                               struct files_struct *fsp, uint32_t share_mode,
1284                               uint32_t access_mask);
1285 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1286                                 struct files_struct *fsp, int leasetype);
1287 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1288                           struct files_struct *fsp, off_t *poffset,
1289                           off_t *pcount, int *ptype, pid_t *ppid);
1290 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1291                         const char *link_contents,
1292                         const struct smb_filename *new_smb_fname);
1293 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1294                         const struct smb_filename *smb_fname,
1295                         char *buf,
1296                         size_t bufsiz);
1297 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1298                         const struct smb_filename *old_smb_fname,
1299                         const struct smb_filename *new_smb_fname);
1300 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1301                         const struct smb_filename *smb_fname,
1302                         mode_t mode,
1303                         SMB_DEV_T dev);
1304 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1305                         TALLOC_CTX *ctx,
1306                         const struct smb_filename *smb_fname);
1307 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1308                         const struct smb_filename *smb_fname,
1309                         unsigned int flags);
1310 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1311                                            const SMB_STRUCT_STAT *sbuf);
1312 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1313                                  struct files_struct *fsp,
1314                                  const struct smb_filename *smb_fname,
1315                                  TALLOC_CTX *mem_ctx,
1316                                  unsigned int *num_streams,
1317                                  struct stream_struct **streams);
1318 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1319                                    const char *path, const char *name,
1320                                    TALLOC_CTX *mem_ctx, char **found_name);
1321 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1322                                      const struct smb_filename *smb_fname);
1323 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1324                                        struct byte_range_lock *br_lck,
1325                                        struct lock_struct *plock,
1326                                        bool blocking_lock);
1327 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1328                                      struct messaging_context *msg_ctx,
1329                                      struct byte_range_lock *br_lck,
1330                                      const struct lock_struct *plock);
1331 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1332                                      struct byte_range_lock *br_lck,
1333                                      struct lock_struct *plock);
1334 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1335                               struct files_struct *fsp,
1336                               struct lock_struct *plock);
1337 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1338                                 struct files_struct *fsp,
1339                                 struct lock_struct *plock);
1340 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1341                                      const char *name,
1342                                      enum vfs_translate_direction direction,
1343                                      TALLOC_CTX *mem_ctx,
1344                                      char **mapped_name);
1345 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1346                             struct files_struct *fsp,
1347                             TALLOC_CTX *ctx,
1348                             uint32_t function,
1349                             uint16_t req_flags,
1350                             const uint8_t *_in_data,
1351                             uint32_t in_len,
1352                             uint8_t **_out_data,
1353                             uint32_t max_out_len,
1354                             uint32_t *out_len);
1355 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1356                                          struct smb_filename *smb_fname,
1357                                          uint32_t *dosmode);
1358 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1359                                           struct files_struct *fsp,
1360                                           uint32_t *dosmode);
1361 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1362                                          const struct smb_filename *smb_fname,
1363                                          uint32_t dosmode);
1364 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1365                                           struct files_struct *fsp,
1366                                           uint32_t dosmode);
1367 struct tevent_req *smb_vfs_call_offload_read_send(
1368         TALLOC_CTX *mem_ctx,
1369         struct tevent_context *ev,
1370         struct vfs_handle_struct *handle,
1371         struct files_struct *fsp,
1372         uint32_t fsctl,
1373         uint32_t ttl,
1374         off_t offset,
1375         size_t to_copy);
1376 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1377                                         struct vfs_handle_struct *handle,
1378                                         TALLOC_CTX *mem_ctx,
1379                                         DATA_BLOB *token_blob);
1380 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1381                                                    TALLOC_CTX *mem_ctx,
1382                                                    struct tevent_context *ev,
1383                                                    uint32_t fsctl,
1384                                                    DATA_BLOB *token,
1385                                                    off_t transfer_offset,
1386                                                    struct files_struct *dest_fsp,
1387                                                    off_t dest_off,
1388                                                    off_t num,
1389                                                    uint32_t flags);
1390 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1391                                          struct tevent_req *req,
1392                                          off_t *copied);
1393 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1394                                       TALLOC_CTX *mem_ctx,
1395                                       struct files_struct *fsp,
1396                                       struct smb_filename *smb_fname,
1397                                       uint16_t *_compression_fmt);
1398 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1399                                       TALLOC_CTX *mem_ctx,
1400                                       struct files_struct *fsp,
1401                                       uint16_t compression_fmt);
1402 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1403                                       TALLOC_CTX *mem_ctx,
1404                                       const char *service_path,
1405                                       char **base_volume);
1406 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1407                                   TALLOC_CTX *mem_ctx,
1408                                   const char *base_volume,
1409                                   time_t *tstamp,
1410                                   bool rw,
1411                                   char **base_path,
1412                                   char **snap_path);
1413 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1414                                   TALLOC_CTX *mem_ctx,
1415                                   char *base_path,
1416                                   char *snap_path);
1417 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1418                                   struct files_struct *fsp,
1419                                   uint32_t security_info,
1420                                   TALLOC_CTX *mem_ctx,
1421                                   struct security_descriptor **ppdesc);
1422 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1423                                  const struct smb_filename *smb_fname,
1424                                  uint32_t security_info,
1425                                  TALLOC_CTX *mem_ctx,
1426                                  struct security_descriptor **ppdesc);
1427 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1428                                   struct files_struct *fsp,
1429                                   uint32_t security_info_sent,
1430                                   const struct security_descriptor *psd);
1431 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1432                                  struct smb_filename *file,
1433                                  struct security_acl *sacl,
1434                                  uint32_t access_requested,
1435                                  uint32_t access_denied);
1436 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1437                                 const struct smb_filename *file,
1438                                 mode_t mode);
1439 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1440                             struct files_struct *fsp, mode_t mode);
1441 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1442                                         const struct smb_filename *smb_fname,
1443                                         SMB_ACL_TYPE_T type,
1444                                         TALLOC_CTX *mem_ctx);
1445 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1446                                       struct files_struct *fsp,
1447                                       TALLOC_CTX *mem_ctx);
1448 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1449                                        const struct smb_filename *smb_fname,
1450                                        TALLOC_CTX *mem_ctx,
1451                                        char **blob_description,
1452                                        DATA_BLOB *blob);
1453 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1454                                      struct files_struct *fsp,
1455                                      TALLOC_CTX *mem_ctx,
1456                                      char **blob_description,
1457                                      DATA_BLOB *blob);
1458 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1459                                 const struct smb_filename *smb_fname,
1460                                 SMB_ACL_TYPE_T acltype,
1461                                 SMB_ACL_T theacl);
1462 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1463                                 struct files_struct *fsp, SMB_ACL_T theacl);
1464 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1465                                 const struct smb_filename *smb_fname);
1466 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1467                                 const struct smb_filename *smb_fname,
1468                                 const char *name,
1469                                 void *value,
1470                                 size_t size);
1471 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1472                                struct files_struct *fsp, const char *name,
1473                                void *value, size_t size);
1474 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1475                                 const struct smb_filename *smb_fname,
1476                                 char *list,
1477                                 size_t size);
1478 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1479                                 struct files_struct *fsp, char *list,
1480                                 size_t size);
1481 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1482                                 const struct smb_filename *smb_fname,
1483                                 const char *name);
1484 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1485                               struct files_struct *fsp, const char *name);
1486 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1487                                 const struct smb_filename *smb_fname,
1488                                 const char *name,
1489                                 const void *value,
1490                                 size_t size,
1491                                 int flags);
1492 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1493                            const char *name, const void *value, size_t size,
1494                            int flags);
1495 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1496                            struct files_struct *fsp, const char *name,
1497                            const void *value, size_t size, int flags);
1498 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1499                             struct files_struct *fsp);
1500 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1501                              const struct smb_filename *fname,
1502                              SMB_STRUCT_STAT *sbuf);
1503 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1504                              const struct smb_filename *fname);
1505 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1506                                      struct files_struct *fsp,
1507                                      TALLOC_CTX *mem_ctx,
1508                                      DATA_BLOB *cookie);
1509 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1510                                          struct files_struct *fsp,
1511                                          const DATA_BLOB old_cookie,
1512                                          TALLOC_CTX *mem_ctx,
1513                                          DATA_BLOB *new_cookie);
1514 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1515                                         struct smb_request *smb1req,
1516                                         struct smbXsrv_open *op,
1517                                         const DATA_BLOB old_cookie,
1518                                         TALLOC_CTX *mem_ctx,
1519                                         struct files_struct **fsp,
1520                                         DATA_BLOB *new_cookie);
1521 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1522                                    const struct smb_filename *fname,
1523                                    TALLOC_CTX *mem_ctx,
1524                                    struct readdir_attr_data **attr_data);
1525
1526 NTSTATUS smb_register_vfs(int version, const char *name,
1527                           const struct vfs_fn_pointers *fns);
1528 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1529                                    files_struct *fsp, size_t ext_size,
1530                                    void (*destroy_fn)(void *p_data));
1531 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1532 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1533 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1534 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1535
1536 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1537                             const char *module);
1538
1539 #endif /* _VFS_H */