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