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