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