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