source3/include/vfs.h

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