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