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