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