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