source3/include/vfs.h

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