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