source3/include/vfs.h

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