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