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