source3/include/vfs.h

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