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         uint64_t duration;
 527 };
 528
 529 /*
 530     Available VFS operations. These values must be in sync with vfs_ops struct
 531     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
 532     In particular, if new operations are added to vfs_ops, appropriate constants
 533     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
 534 */
 535 struct shadow_copy_data;
 536
 537 struct vfs_fn_pointers {
 538         /* Disk operations */
 539
 540         int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
 541         void (*disconnect_fn)(struct vfs_handle_struct *handle);
 542         uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
 543                               uint64_t *dfree, uint64_t *dsize);
 544         int (*get_quota_fn)(struct vfs_handle_struct *handle, const char *path,
 545                             enum SMB_QUOTA_TYPE qtype, unid_t id,
 546                             SMB_DISK_QUOTA *qt);
 547         int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 548         int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
 549         int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
 550         uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
 551
 552         /*
 553          * Note: that "struct dfs_GetDFSReferral *r"
 554          * needs to be a valid TALLOC_CTX
 555          */
 556         NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
 557                                          struct dfs_GetDFSReferral *r);
 558
 559         /* Directory operations */
 560
 561         DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
 562                                         const struct smb_filename *smb_fname,
 563                                         const char *mask,
 564                                         uint32_t attributes);
 565         DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
 566         struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
 567                                          DIR *dirp,
 568                                          SMB_STRUCT_STAT *sbuf);
 569         void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
 570         long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 571         void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 572         int (*mkdir_fn)(struct vfs_handle_struct *handle,
 573                         const struct smb_filename *smb_fname,
 574                         mode_t mode);
 575         int (*rmdir_fn)(struct vfs_handle_struct *handle,
 576                         const struct smb_filename *smb_fname);
 577         int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
 578         void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
 579
 580         /* File operations */
 581
 582         int (*open_fn)(struct vfs_handle_struct *handle,
 583                        struct smb_filename *smb_fname, files_struct *fsp,
 584                        int flags, mode_t mode);
 585         NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
 586                                    struct smb_request *req,
 587                                    uint16_t root_dir_fid,
 588                                    struct smb_filename *smb_fname,
 589                                    uint32_t access_mask,
 590                                    uint32_t share_access,
 591                                    uint32_t create_disposition,
 592                                    uint32_t create_options,
 593                                    uint32_t file_attributes,
 594                                    uint32_t oplock_request,
 595                                    struct smb2_lease *lease,
 596                                    uint64_t allocation_size,
 597                                    uint32_t private_flags,
 598                                    struct security_descriptor *sd,
 599                                    struct ea_list *ea_list,
 600                                    files_struct **result,
 601                                    int *pinfo,
 602                                    const struct smb2_create_blobs *in_context_blobs,
 603                                    struct smb2_create_blobs *out_context_blobs);
 604         int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 605         ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
 606         ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
 607         struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
 608                                             TALLOC_CTX *mem_ctx,
 609                                             struct tevent_context *ev,
 610                                             struct files_struct *fsp,
 611                                             void *data,
 612                                             size_t n, off_t offset);
 613         ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 614         ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
 615         ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
 616         struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
 617                                              TALLOC_CTX *mem_ctx,
 618                                              struct tevent_context *ev,
 619                                              struct files_struct *fsp,
 620                                              const void *data,
 621                                              size_t n, off_t offset);
 622         ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 623         off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
 624         ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
 625         ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
 626         int (*rename_fn)(struct vfs_handle_struct *handle,
 627                          const struct smb_filename *smb_fname_src,
 628                          const struct smb_filename *smb_fname_dst);
 629         int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 630         struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
 631                                             TALLOC_CTX *mem_ctx,
 632                                             struct tevent_context *ev,
 633                                             struct files_struct *fsp);
 634         int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
 635         int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
 636         int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
 637         int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
 638         uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
 639         int (*unlink_fn)(struct vfs_handle_struct *handle,
 640                          const struct smb_filename *smb_fname);
 641         int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
 642         int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 643         int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
 644         int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
 645         int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
 646         int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
 647         char *(*getwd_fn)(struct vfs_handle_struct *handle);
 648         int (*ntimes_fn)(struct vfs_handle_struct *handle,
 649                          const struct smb_filename *smb_fname,
 650                          struct smb_file_time *ft);
 651         int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
 652         int (*fallocate_fn)(struct vfs_handle_struct *handle,
 653                             struct files_struct *fsp,
 654                             uint32_t mode,
 655                             off_t offset,
 656                             off_t len);
 657         bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
 658         int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 659                                uint32_t share_mode, uint32_t access_mask);
 660         int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
 661         bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
 662         int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
 663         int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
 664         int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
 665         int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
 666         char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
 667         int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
 668         struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
 669                                             const SMB_STRUCT_STAT *sbuf);
 670         struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
 671                                                  TALLOC_CTX *mem_ctx,
 672                                                  struct tevent_context *ev,
 673                                                  struct files_struct *src_fsp,
 674                                                  off_t src_off,
 675                                                  struct files_struct *dest_fsp,
 676                                                  off_t dest_off,
 677                                                  off_t num);
 678         NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
 679                                        struct tevent_req *req,
 680                                        off_t *copied);
 681         NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
 682                                        TALLOC_CTX *mem_ctx,
 683                                        struct files_struct *fsp,
 684                                        struct smb_filename *smb_fname,
 685                                        uint16_t *_compression_fmt);
 686         NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
 687                                        TALLOC_CTX *mem_ctx,
 688                                        struct files_struct *fsp,
 689                                        uint16_t compression_fmt);
 690         NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
 691                                        TALLOC_CTX *mem_ctx,
 692                                        const char *service_path,
 693                                        char **base_volume);
 694         NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
 695                                    TALLOC_CTX *mem_ctx,
 696                                    const char *base_volume,
 697                                    time_t *tstamp,
 698                                    bool rw,
 699                                    char **base_path,
 700                                    char **snap_path);
 701         NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
 702                                    TALLOC_CTX *mem_ctx,
 703                                    char *base_path,
 704                                    char *snap_path);
 705
 706         NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
 707                                   struct files_struct *fsp,
 708                                   const char *fname,
 709                                   TALLOC_CTX *mem_ctx,
 710                                   unsigned int *num_streams,
 711                                   struct stream_struct **streams);
 712
 713         int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
 714                                     const char *path,
 715                                     const char *name,
 716                                     TALLOC_CTX *mem_ctx,
 717                                     char **found_name);
 718
 719         const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
 720                                       const char *filename);
 721
 722         NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
 723                                         struct byte_range_lock *br_lck,
 724                                         struct lock_struct *plock,
 725                                         bool blocking_lock);
 726
 727         bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
 728                                       struct messaging_context *msg_ctx,
 729                                       struct byte_range_lock *br_lck,
 730                                       const struct lock_struct *plock);
 731
 732         bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
 733                                       struct byte_range_lock *br_lck,
 734                                       struct lock_struct *plock);
 735
 736         bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
 737                                struct files_struct *fsp,
 738                                struct lock_struct *plock);
 739
 740         void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
 741                                  struct files_struct *fsp,
 742                                  struct lock_struct *plock);
 743
 744         NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
 745                                       const char *name,
 746                                       enum vfs_translate_direction direction,
 747                                       TALLOC_CTX *mem_ctx,
 748                                       char **mapped_name);
 749
 750         NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
 751                              struct files_struct *fsp,
 752                              TALLOC_CTX *ctx,
 753                              uint32_t function,
 754                              uint16_t req_flags,
 755                              const uint8_t *_in_data,
 756                              uint32_t in_len,
 757                              uint8_t **_out_data,
 758                              uint32_t max_out_len,
 759                              uint32_t *out_len);
 760
 761         /* NT ACL operations. */
 762
 763         NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
 764                                    struct files_struct *fsp,
 765                                    uint32_t security_info,
 766                                    TALLOC_CTX *mem_ctx,
 767                                    struct security_descriptor **ppdesc);
 768         NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
 769                                   const struct smb_filename *smb_fname,
 770                                   uint32_t security_info,
 771                                    TALLOC_CTX *mem_ctx,
 772                                   struct security_descriptor **ppdesc);
 773         NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
 774                                    struct files_struct *fsp,
 775                                    uint32_t security_info_sent,
 776                                    const struct security_descriptor *psd);
 777
 778         NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
 779                                   struct smb_filename *file,
 780                                   struct security_acl *sacl,
 781                                   uint32_t access_requested,
 782                                   uint32_t access_denied);
 783
 784         /* POSIX ACL operations. */
 785
 786         int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
 787         int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 788
 789         SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
 790                                          const char *path_p,
 791                                          SMB_ACL_TYPE_T type,
 792                                          TALLOC_CTX *mem_ctx);
 793         SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
 794                                        struct files_struct *fsp,
 795                                        TALLOC_CTX *mem_ctx);
 796         int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
 797                                         const char *path_p,
 798                                         TALLOC_CTX *mem_ctx,
 799                                         char **blob_description,
 800                                         DATA_BLOB *blob);
 801         int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
 802                                       TALLOC_CTX *mem_ctx, char **blob_description,
 803                                       DATA_BLOB *blob);
 804         int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
 805         int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
 806         int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
 807
 808         /* EA operations. */
 809         ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
 810         ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
 811         ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
 812         ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
 813         int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
 814         int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
 815         int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
 816         int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
 817
 818         /* aio operations */
 819         bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 820
 821         /* offline operations */
 822         bool (*is_offline_fn)(struct vfs_handle_struct *handle,
 823                            const struct smb_filename *fname,
 824                            SMB_STRUCT_STAT *sbuf);
 825         int (*set_offline_fn)(struct vfs_handle_struct *handle,
 826                            const struct smb_filename *fname);
 827
 828         /* durable handle operations */
 829         NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
 830                                       struct files_struct *fsp,
 831                                       TALLOC_CTX *mem_ctx,
 832                                       DATA_BLOB *cookie);
 833         NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
 834                                           struct files_struct *fsp,
 835                                           const DATA_BLOB old_cookie,
 836                                           TALLOC_CTX *mem_ctx,
 837                                           DATA_BLOB *new_cookie);
 838         NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
 839                                          struct smb_request *smb1req,
 840                                          struct smbXsrv_open *op,
 841                                          const DATA_BLOB old_cookie,
 842                                          TALLOC_CTX *mem_ctx,
 843                                          struct files_struct **fsp,
 844                                          DATA_BLOB *new_cookie);
 845
 846         NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
 847                                     const struct smb_filename *fname,
 848                                     TALLOC_CTX *mem_ctx,
 849                                     struct readdir_attr_data **attr_data);
 850 };
 851
 852 /*
 853     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
 854     which describes all operations this module is willing to intercept.
 855     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
 856     using this information.
 857 */
 858
 859 typedef struct vfs_handle_struct {
 860         struct vfs_handle_struct  *next, *prev;
 861         const char *param;
 862         struct connection_struct *conn;
 863         const struct vfs_fn_pointers *fns;
 864         void *data;
 865         void (*free_data)(void **data);
 866 } vfs_handle_struct;
 867
 868
 869 typedef struct vfs_statvfs_struct {
 870         /* For undefined recommended transfer size return -1 in that field */
 871         uint32_t OptimalTransferSize;  /* bsize on some os, iosize on other os */
 872         uint32_t BlockSize;
 873
 874         /*
 875          The next three fields are in terms of the block size.
 876          (above). If block size is unknown, 4096 would be a
 877          reasonable block size for a server to report.
 878          Note that returning the blocks/blocksavail removes need
 879          to make a second call (to QFSInfo level 0x103 to get this info.
 880          UserBlockAvail is typically less than or equal to BlocksAvail,
 881          if no distinction is made return the same value in each.
 882         */
 883
 884         uint64_t TotalBlocks;
 885         uint64_t BlocksAvail;       /* bfree */
 886         uint64_t UserBlocksAvail;   /* bavail */
 887
 888         /* For undefined Node fields or FSID return -1 */
 889         uint64_t TotalFileNodes;
 890         uint64_t FreeFileNodes;
 891         uint64_t FsIdentifier;   /* fsid */
 892         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
 893         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
 894
 895         int FsCapabilities;
 896 } vfs_statvfs_struct;
 897
 898 /* Add a new FSP extension of the given type. Returns a pointer to the
 899  * extenstion data.
 900  */
 901 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn)            \
 902     vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
 903
 904 /* Return a pointer to the existing FSP extension data. */
 905 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
 906     vfs_fetch_fsp_extension(handle, (fsp))
 907
 908 /* Return the talloc context associated with an FSP extension. */
 909 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
 910     vfs_memctx_fsp_extension(handle, (fsp))
 911
 912 /* Remove and destroy an FSP extension. */
 913 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
 914     vfs_remove_fsp_extension((handle), (fsp))
 915
 916 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
 917         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
 918                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
 919                 ret; \
 920         } \
 921 }
 922
 923 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
 924         if (!(handle)) { \
 925                 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
 926                 ret; \
 927         } else { \
 928                 if ((handle)->free_data) { \
 929                         (handle)->free_data(&(handle)->data); \
 930                 } \
 931                 (handle)->data = (void *)datap; \
 932                 (handle)->free_data = free_fn; \
 933         } \
 934 }
 935
 936 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
 937         if ((handle) && (handle)->free_data) { \
 938                 (handle)->free_data(&(handle)->data); \
 939         } \
 940 }
 941
 942 /* Check whether module-specific data handle was already allocated or not */
 943 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
 944
 945 #define SMB_VFS_OP(x) ((void *) x)
 946
 947 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
 948
 949 #include "vfs_macros.h"
 950
 951 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
 952                          const char *service, const char *user);
 953 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
 954 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
 955                                 const char *path, uint64_t *bsize,
 956                                 uint64_t *dfree, uint64_t *dsize);
 957 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle, const char *path,
 958                            enum SMB_QUOTA_TYPE qtype, unid_t id,
 959                            SMB_DISK_QUOTA *qt);
 960 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
 961                            enum SMB_QUOTA_TYPE qtype, unid_t id,
 962                            SMB_DISK_QUOTA *qt);
 963 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
 964                                       struct files_struct *fsp,
 965                                       struct shadow_copy_data *shadow_copy_data,
 966                                       bool labels);
 967 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
 968                          struct vfs_statvfs_struct *statbuf);
 969 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
 970                                       enum timestamp_set_resolution *p_ts_res);
 971 /*
 972  * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
 973  */
 974 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
 975                                         struct dfs_GetDFSReferral *r);
 976 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
 977                         const struct smb_filename *smb_fname,
 978                         const char *mask,
 979                         uint32_t attributes);
 980 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
 981                                         struct files_struct *fsp,
 982                                         const char *mask,
 983                                         uint32_t attributes);
 984 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
 985                                         DIR *dirp,
 986                                         SMB_STRUCT_STAT *sbuf);
 987 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
 988                           DIR *dirp, long offset);
 989 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
 990                           DIR *dirp);
 991 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
 992                              DIR *dirp);
 993 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
 994                         const struct smb_filename *smb_fname,
 995                         mode_t mode);
 996 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
 997                         const struct smb_filename *smb_fname);
 998 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
 999                           DIR *dir);
1000 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1001                                  DIR *dirp);
1002 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1003                       struct smb_filename *smb_fname, struct files_struct *fsp,
1004                       int flags, mode_t mode);
1005 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1006                                   struct smb_request *req,
1007                                   uint16_t root_dir_fid,
1008                                   struct smb_filename *smb_fname,
1009                                   uint32_t access_mask,
1010                                   uint32_t share_access,
1011                                   uint32_t create_disposition,
1012                                   uint32_t create_options,
1013                                   uint32_t file_attributes,
1014                                   uint32_t oplock_request,
1015                                   struct smb2_lease *lease,
1016                                   uint64_t allocation_size,
1017                                   uint32_t private_flags,
1018                                   struct security_descriptor *sd,
1019                                   struct ea_list *ea_list,
1020                                   files_struct **result,
1021                                   int *pinfo,
1022                                   const struct smb2_create_blobs *in_context_blobs,
1023                                   struct smb2_create_blobs *out_context_blobs);
1024 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1025                        struct files_struct *fsp);
1026 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1027                           struct files_struct *fsp, void *data, size_t n);
1028 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1029                            struct files_struct *fsp, void *data, size_t n,
1030                            off_t offset);
1031 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1032                                            TALLOC_CTX *mem_ctx,
1033                                            struct tevent_context *ev,
1034                                            struct files_struct *fsp,
1035                                            void *data,
1036                                            size_t n, off_t offset);
1037 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1038
1039 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1040                            struct files_struct *fsp, const void *data,
1041                            size_t n);
1042 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1043                             struct files_struct *fsp, const void *data,
1044                             size_t n, off_t offset);
1045 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1046                                             TALLOC_CTX *mem_ctx,
1047                                             struct tevent_context *ev,
1048                                             struct files_struct *fsp,
1049                                             const void *data,
1050                                             size_t n, off_t offset);
1051 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1052
1053 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1054                              struct files_struct *fsp, off_t offset,
1055                              int whence);
1056 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1057                               files_struct *fromfsp, const DATA_BLOB *header,
1058                               off_t offset, size_t count);
1059 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1060                               files_struct *tofsp, off_t offset,
1061                               size_t count);
1062 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1063                         const struct smb_filename *smb_fname_src,
1064                         const struct smb_filename *smb_fname_dst);
1065 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1066                        struct files_struct *fsp);
1067
1068 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1069                                            TALLOC_CTX *mem_ctx,
1070                                            struct tevent_context *ev,
1071                                            struct files_struct *fsp);
1072 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1073
1074 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1075                       struct smb_filename *smb_fname);
1076 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1077                        struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1078 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1079                        struct smb_filename *smb_filename);
1080 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1081                                      struct files_struct *fsp,
1082                                      const SMB_STRUCT_STAT *sbuf);
1083 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1084                         const struct smb_filename *smb_fname);
1085 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
1086                        mode_t mode);
1087 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1088                         struct files_struct *fsp, mode_t mode);
1089 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
1090                        uid_t uid, gid_t gid);
1091 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1092                         struct files_struct *fsp, uid_t uid, gid_t gid);
1093 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
1094                         uid_t uid, gid_t gid);
1095 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1096 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1097 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1098                         const struct smb_filename *smb_fname,
1099                         struct smb_file_time *ft);
1100 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1101                            struct files_struct *fsp, off_t offset);
1102 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1103                            struct files_struct *fsp,
1104                            uint32_t mode,
1105                            off_t offset,
1106                            off_t len);
1107 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1108                        struct files_struct *fsp, int op, off_t offset,
1109                        off_t count, int type);
1110 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1111                               struct files_struct *fsp, uint32_t share_mode,
1112                               uint32_t access_mask);
1113 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1114                                 struct files_struct *fsp, int leasetype);
1115 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1116                           struct files_struct *fsp, off_t *poffset,
1117                           off_t *pcount, int *ptype, pid_t *ppid);
1118 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1119                          const char *newpath);
1120 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1121                           const char *path, char *buf, size_t bufsiz);
1122 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1123                       const char *newpath);
1124 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1125                        mode_t mode, SMB_DEV_T dev);
1126 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1127 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1128                          unsigned int flags);
1129 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1130                                            const SMB_STRUCT_STAT *sbuf);
1131 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1132                                  struct files_struct *fsp,
1133                                  const char *fname,
1134                                  TALLOC_CTX *mem_ctx,
1135                                  unsigned int *num_streams,
1136                                  struct stream_struct **streams);
1137 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1138                                    const char *path, const char *name,
1139                                    TALLOC_CTX *mem_ctx, char **found_name);
1140 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1141                                      const char *filename);
1142 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1143                                        struct byte_range_lock *br_lck,
1144                                        struct lock_struct *plock,
1145                                        bool blocking_lock);
1146 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1147                                      struct messaging_context *msg_ctx,
1148                                      struct byte_range_lock *br_lck,
1149                                      const struct lock_struct *plock);
1150 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1151                                      struct byte_range_lock *br_lck,
1152                                      struct lock_struct *plock);
1153 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1154                               struct files_struct *fsp,
1155                               struct lock_struct *plock);
1156 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1157                                 struct files_struct *fsp,
1158                                 struct lock_struct *plock);
1159 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1160                                      const char *name,
1161                                      enum vfs_translate_direction direction,
1162                                      TALLOC_CTX *mem_ctx,
1163                                      char **mapped_name);
1164 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1165                             struct files_struct *fsp,
1166                             TALLOC_CTX *ctx,
1167                             uint32_t function,
1168                             uint16_t req_flags,
1169                             const uint8_t *_in_data,
1170                             uint32_t in_len,
1171                             uint8_t **_out_data,
1172                             uint32_t max_out_len,
1173                             uint32_t *out_len);
1174 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1175                                                 TALLOC_CTX *mem_ctx,
1176                                                 struct tevent_context *ev,
1177                                                 struct files_struct *src_fsp,
1178                                                 off_t src_off,
1179                                                 struct files_struct *dest_fsp,
1180                                                 off_t dest_off,
1181                                                 off_t num);
1182 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1183                                       struct tevent_req *req,
1184                                       off_t *copied);
1185 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1186                                       TALLOC_CTX *mem_ctx,
1187                                       struct files_struct *fsp,
1188                                       struct smb_filename *smb_fname,
1189                                       uint16_t *_compression_fmt);
1190 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1191                                       TALLOC_CTX *mem_ctx,
1192                                       struct files_struct *fsp,
1193                                       uint16_t compression_fmt);
1194 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1195                                       TALLOC_CTX *mem_ctx,
1196                                       const char *service_path,
1197                                       char **base_volume);
1198 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1199                                   TALLOC_CTX *mem_ctx,
1200                                   const char *base_volume,
1201                                   time_t *tstamp,
1202                                   bool rw,
1203                                   char **base_path,
1204                                   char **snap_path);
1205 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1206                                   TALLOC_CTX *mem_ctx,
1207                                   char *base_path,
1208                                   char *snap_path);
1209 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1210                                   struct files_struct *fsp,
1211                                   uint32_t security_info,
1212                                   TALLOC_CTX *mem_ctx,
1213                                   struct security_descriptor **ppdesc);
1214 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1215                                  const struct smb_filename *smb_fname,
1216                                  uint32_t security_info,
1217                                  TALLOC_CTX *mem_ctx,
1218                                  struct security_descriptor **ppdesc);
1219 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1220                                   struct files_struct *fsp,
1221                                   uint32_t security_info_sent,
1222                                   const struct security_descriptor *psd);
1223 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1224                                  struct smb_filename *file,
1225                                  struct security_acl *sacl,
1226                                  uint32_t access_requested,
1227                                  uint32_t access_denied);
1228 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
1229                            mode_t mode);
1230 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1231                             struct files_struct *fsp, mode_t mode);
1232 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1233                                         const char *path_p,
1234                                         SMB_ACL_TYPE_T type,
1235                                         TALLOC_CTX *mem_ctx);
1236 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1237                                       struct files_struct *fsp,
1238                                       TALLOC_CTX *mem_ctx);
1239 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1240                                        const char *path_p,
1241                                        TALLOC_CTX *mem_ctx,
1242                                        char **blob_description,
1243                                        DATA_BLOB *blob);
1244 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1245                                      struct files_struct *fsp,
1246                                      TALLOC_CTX *mem_ctx,
1247                                      char **blob_description,
1248                                      DATA_BLOB *blob);
1249 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1250                                   const char *name, SMB_ACL_TYPE_T acltype,
1251                                   SMB_ACL_T theacl);
1252 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1253                                 struct files_struct *fsp, SMB_ACL_T theacl);
1254 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1255                                          const char *path);
1256 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1257                               const char *path, const char *name, void *value,
1258                               size_t size);
1259 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1260                                struct files_struct *fsp, const char *name,
1261                                void *value, size_t size);
1262 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1263                                const char *path, char *list, size_t size);
1264 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1265                                 const char *path, char *list, size_t size);
1266 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1267                                 struct files_struct *fsp, char *list,
1268                                 size_t size);
1269 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1270                              const char *path, const char *name);
1271 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1272                               struct files_struct *fsp, const char *name);
1273 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
1274                           const char *name, const void *value, size_t size,
1275                           int flags);
1276 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1277                            const char *name, const void *value, size_t size,
1278                            int flags);
1279 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1280                            struct files_struct *fsp, const char *name,
1281                            const void *value, size_t size, int flags);
1282 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1283                             struct files_struct *fsp);
1284 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1285                              const struct smb_filename *fname,
1286                              SMB_STRUCT_STAT *sbuf);
1287 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1288                              const struct smb_filename *fname);
1289 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1290                                      struct files_struct *fsp,
1291                                      TALLOC_CTX *mem_ctx,
1292                                      DATA_BLOB *cookie);
1293 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1294                                          struct files_struct *fsp,
1295                                          const DATA_BLOB old_cookie,
1296                                          TALLOC_CTX *mem_ctx,
1297                                          DATA_BLOB *new_cookie);
1298 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1299                                         struct smb_request *smb1req,
1300                                         struct smbXsrv_open *op,
1301                                         const DATA_BLOB old_cookie,
1302                                         TALLOC_CTX *mem_ctx,
1303                                         struct files_struct **fsp,
1304                                         DATA_BLOB *new_cookie);
1305 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1306                                    const struct smb_filename *fname,
1307                                    TALLOC_CTX *mem_ctx,
1308                                    struct readdir_attr_data **attr_data);
1309
1310 NTSTATUS smb_register_vfs(int version, const char *name,
1311                           const struct vfs_fn_pointers *fns);
1312 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1313                                    files_struct *fsp, size_t ext_size,
1314                                    void (*destroy_fn)(void *p_data));
1315 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1316 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1317 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1318 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1319
1320 #endif /* _VFS_H */