source3/include/vfs.h

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