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