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