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