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