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