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