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