source3/include/vfs.h

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