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