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
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21
  22    This work was sponsored by Optifacio Software Services, Inc.
  23 */
  24
  25 #ifndef _VFS_H
  26 #define _VFS_H
  27
  28 /* Avoid conflict with an AIX include file */
  29
  30 #ifdef vfs_ops
  31 #undef vfs_ops
  32 #endif
  33
  34 /*
  35  * As we're now (thanks Andrew ! :-) using file_structs and connection
  36  * structs in the vfs - then anyone writing a vfs must include includes.h...
  37  */
  38
  39 /*
  40  * This next constant specifies the version number of the VFS interface
  41  * this smbd will load. Increment this if *ANY* changes are made to the
  42  * vfs_ops below. JRA.
  43  *
  44  * If you change anything here, please also update modules/vfs_full_audit.c.
  45  * VL.
  46  */
  47
  48 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
  49 /* Changed to version 3 for POSIX acl extensions. JRA. */
  50 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
  51 /* Changed to version 5 for sendfile addition. JRA. */
  52 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
  53 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
  54 /* Changed to version 8 includes EA calls. JRA. */
  55 /* Changed to version 9 to include the get_shadow_data call. --metze */
  56 /* Changed to version 10 to include pread/pwrite calls. */
  57 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
  58 /* Changed to version 12 to add mask and attributes to opendir(). JRA
  59    Also include aio calls. JRA. */
  60 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
  61 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
  62 /* Changed to version 15 as we added the statvfs call. JRA */
  63 /* Changed to version 16 as we added the getlock call. JRA */
  64 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
  65 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
  66    Also include kernel_flock call - jmcd */
  67 /* Changed to version 19, kernel change notify has been merged
  68    Also included linux setlease call - jmcd */
  69 /* Changed to version 20, use ntimes call instead of utime (greater
  70  * timestamp resolition. JRA. */
  71 /* Changed to version21 to add chflags operation -- jpeach */
  72 /* Changed to version22 to add lchown operation -- jra */
  73 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
  74 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
  75 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
  76 /* Leave at 22 - not yet released. Added recvfile. */
  77 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
  78 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
  79  * files_struct. - obnox.*/
  80 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
  81 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
  82 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
  83 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
  84 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
  85 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
  86 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
  87 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
  88 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
  89 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
  90 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
  91 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
  92 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
  93 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
  94 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
  95 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
  96 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
  97 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
  98 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
  99 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
 100 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
 101 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
 102 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
 103 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
 104 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
 105 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
 106 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
 107 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
 108 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
 109 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
 110    open handle. JRA. */
 111 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
 112 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
 113 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
 114 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
 115 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
 116 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
 117 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
 118 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
 119 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
 120
 121 #define SMB_VFS_INTERFACE_VERSION 25
 122
 123
 124 /* to bug old modules which are trying to compile with the old functions */
 125 #define vfs_init __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore(void) { __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore };
 126 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
 127   __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
 128 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
 129   __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
 130
 131 /*
 132     All intercepted VFS operations must be declared as static functions inside module source
 133     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
 134     example VFS modules for more details.
 135 */
 136
 137 /* VFS operations structure */
 138
 139 struct vfs_handle_struct;
 140 struct connection_struct;
 141 struct files_struct;
 142 struct security_descriptor;
 143 struct vfs_statvfs_struct;
 144 struct smb_request;
 145 struct ea_list;
 146 struct smb_file_time;
 147 struct blocking_lock_record;
 148
 149 /*
 150     Available VFS operations. These values must be in sync with vfs_ops struct
 151     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
 152     In particular, if new operations are added to vfs_ops, appropriate constants
 153     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
 154 */
 155
 156 typedef enum _vfs_op_type {
 157         SMB_VFS_OP_NOOP = -1,
 158
 159         /* Disk operations */
 160
 161         SMB_VFS_OP_CONNECT = 0,
 162         SMB_VFS_OP_DISCONNECT,
 163         SMB_VFS_OP_DISK_FREE,
 164         SMB_VFS_OP_GET_QUOTA,
 165         SMB_VFS_OP_SET_QUOTA,
 166         SMB_VFS_OP_GET_SHADOW_COPY_DATA,
 167         SMB_VFS_OP_STATVFS,
 168         SMB_VFS_OP_FS_CAPABILITIES,
 169
 170         /* Directory operations */
 171
 172         SMB_VFS_OP_OPENDIR,
 173         SMB_VFS_OP_READDIR,
 174         SMB_VFS_OP_SEEKDIR,
 175         SMB_VFS_OP_TELLDIR,
 176         SMB_VFS_OP_REWINDDIR,
 177         SMB_VFS_OP_MKDIR,
 178         SMB_VFS_OP_RMDIR,
 179         SMB_VFS_OP_CLOSEDIR,
 180         SMB_VFS_OP_INIT_SEARCH_OP,
 181
 182         /* File operations */
 183
 184         SMB_VFS_OP_OPEN,
 185         SMB_VFS_OP_CREATE_FILE,
 186         SMB_VFS_OP_CLOSE,
 187         SMB_VFS_OP_READ,
 188         SMB_VFS_OP_PREAD,
 189         SMB_VFS_OP_WRITE,
 190         SMB_VFS_OP_PWRITE,
 191         SMB_VFS_OP_LSEEK,
 192         SMB_VFS_OP_SENDFILE,
 193         SMB_VFS_OP_RECVFILE,
 194         SMB_VFS_OP_RENAME,
 195         SMB_VFS_OP_FSYNC,
 196         SMB_VFS_OP_STAT,
 197         SMB_VFS_OP_FSTAT,
 198         SMB_VFS_OP_LSTAT,
 199         SMB_VFS_OP_GET_ALLOC_SIZE,
 200         SMB_VFS_OP_UNLINK,
 201         SMB_VFS_OP_CHMOD,
 202         SMB_VFS_OP_FCHMOD,
 203         SMB_VFS_OP_CHOWN,
 204         SMB_VFS_OP_FCHOWN,
 205         SMB_VFS_OP_LCHOWN,
 206         SMB_VFS_OP_CHDIR,
 207         SMB_VFS_OP_GETWD,
 208         SMB_VFS_OP_NTIMES,
 209         SMB_VFS_OP_FTRUNCATE,
 210         SMB_VFS_OP_LOCK,
 211         SMB_VFS_OP_KERNEL_FLOCK,
 212         SMB_VFS_OP_LINUX_SETLEASE,
 213         SMB_VFS_OP_GETLOCK,
 214         SMB_VFS_OP_SYMLINK,
 215         SMB_VFS_OP_READLINK,
 216         SMB_VFS_OP_LINK,
 217         SMB_VFS_OP_MKNOD,
 218         SMB_VFS_OP_REALPATH,
 219         SMB_VFS_OP_NOTIFY_WATCH,
 220         SMB_VFS_OP_CHFLAGS,
 221         SMB_VFS_OP_FILE_ID_CREATE,
 222         SMB_VFS_OP_STREAMINFO,
 223         SMB_VFS_OP_GET_REAL_FILENAME,
 224         SMB_VFS_OP_BRL_LOCK_WINDOWS,
 225         SMB_VFS_OP_BRL_UNLOCK_WINDOWS,
 226         SMB_VFS_OP_BRL_CANCEL_WINDOWS,
 227         SMB_VFS_OP_STRICT_LOCK,
 228         SMB_VFS_OP_STRICT_UNLOCK,
 229
 230         /* NT ACL operations. */
 231
 232         SMB_VFS_OP_FGET_NT_ACL,
 233         SMB_VFS_OP_GET_NT_ACL,
 234         SMB_VFS_OP_FSET_NT_ACL,
 235
 236         /* POSIX ACL operations. */
 237
 238         SMB_VFS_OP_CHMOD_ACL,
 239         SMB_VFS_OP_FCHMOD_ACL,
 240
 241         SMB_VFS_OP_SYS_ACL_GET_ENTRY,
 242         SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
 243         SMB_VFS_OP_SYS_ACL_GET_PERMSET,
 244         SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
 245         SMB_VFS_OP_SYS_ACL_GET_FILE,
 246         SMB_VFS_OP_SYS_ACL_GET_FD,
 247         SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
 248         SMB_VFS_OP_SYS_ACL_ADD_PERM,
 249         SMB_VFS_OP_SYS_ACL_TO_TEXT,
 250         SMB_VFS_OP_SYS_ACL_INIT,
 251         SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
 252         SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
 253         SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
 254         SMB_VFS_OP_SYS_ACL_SET_PERMSET,
 255         SMB_VFS_OP_SYS_ACL_VALID,
 256         SMB_VFS_OP_SYS_ACL_SET_FILE,
 257         SMB_VFS_OP_SYS_ACL_SET_FD,
 258         SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
 259         SMB_VFS_OP_SYS_ACL_GET_PERM,
 260         SMB_VFS_OP_SYS_ACL_FREE_TEXT,
 261         SMB_VFS_OP_SYS_ACL_FREE_ACL,
 262         SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
 263
 264         /* EA operations. */
 265         SMB_VFS_OP_GETXATTR,
 266         SMB_VFS_OP_LGETXATTR,
 267         SMB_VFS_OP_FGETXATTR,
 268         SMB_VFS_OP_LISTXATTR,
 269         SMB_VFS_OP_LLISTXATTR,
 270         SMB_VFS_OP_FLISTXATTR,
 271         SMB_VFS_OP_REMOVEXATTR,
 272         SMB_VFS_OP_LREMOVEXATTR,
 273         SMB_VFS_OP_FREMOVEXATTR,
 274         SMB_VFS_OP_SETXATTR,
 275         SMB_VFS_OP_LSETXATTR,
 276         SMB_VFS_OP_FSETXATTR,
 277
 278         /* aio operations */
 279         SMB_VFS_OP_AIO_READ,
 280         SMB_VFS_OP_AIO_WRITE,
 281         SMB_VFS_OP_AIO_RETURN,
 282         SMB_VFS_OP_AIO_CANCEL,
 283         SMB_VFS_OP_AIO_ERROR,
 284         SMB_VFS_OP_AIO_FSYNC,
 285         SMB_VFS_OP_AIO_SUSPEND,
 286         SMB_VFS_OP_AIO_FORCE,
 287
 288         /* offline operations */
 289         SMB_VFS_OP_IS_OFFLINE,
 290         SMB_VFS_OP_SET_OFFLINE,
 291
 292         /* This should always be last enum value */
 293
 294         SMB_VFS_OP_LAST
 295 } vfs_op_type;
 296
 297 /*
 298     Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
 299 */
 300 struct vfs_ops {
 301         struct vfs_fn_pointers {
 302                 /* Disk operations */
 303
 304                 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
 305                 void (*disconnect)(struct vfs_handle_struct *handle);
 306                 uint64_t (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
 307                         uint64_t *dfree, uint64_t *dsize);
 308                 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 309                 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 310                 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
 311                 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
 312                 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle);
 313
 314                 /* Directory operations */
 315
 316                 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
 317                 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle,
 318                                               SMB_STRUCT_DIR *dirp,
 319                                               SMB_STRUCT_STAT *sbuf);
 320                 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
 321                 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
 322                 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
 323                 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
 324                 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
 325                 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
 326                 void (*init_search_op)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
 327
 328                 /* File operations */
 329
 330                 int (*open)(struct vfs_handle_struct *handle, const char *fname, files_struct *fsp, int flags, mode_t mode);
 331                 NTSTATUS (*create_file)(struct vfs_handle_struct *handle,
 332                                         struct smb_request *req,
 333                                         uint16_t root_dir_fid,
 334                                         const char *fname,
 335                                         uint32_t create_file_flags,
 336                                         uint32_t access_mask,
 337                                         uint32_t share_access,
 338                                         uint32_t create_disposition,
 339                                         uint32_t create_options,
 340                                         uint32_t file_attributes,
 341                                         uint32_t oplock_request,
 342                                         uint64_t allocation_size,
 343                                         struct security_descriptor *sd,
 344                                         struct ea_list *ea_list,
 345                                         files_struct **result,
 346                                         int *pinfo,
 347                                         SMB_STRUCT_STAT *psbuf);
 348                 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 349                 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
 350                 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
 351                 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
 352                 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
 353                 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
 354                 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
 355                 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
 356                 int (*rename)(struct vfs_handle_struct *handle, const char *oldname, const char *newname);
 357                 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 358                 int (*stat)(struct vfs_handle_struct *handle, const char *fname, SMB_STRUCT_STAT *sbuf);
 359                 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
 360                 int (*lstat)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
 361                 uint64_t (*get_alloc_size)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
 362                 int (*unlink)(struct vfs_handle_struct *handle, const char *path);
 363                 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
 364                 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 365                 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
 366                 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
 367                 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
 368                 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
 369                 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
 370                 int (*ntimes)(struct vfs_handle_struct *handle, const char *path, struct smb_file_time *ft);
 371                 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
 372                 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
 373                 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, uint32 share_mode);
 374                 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
 375                 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
 376                 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
 377                 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
 378                 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
 379                 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
 380                 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
 381                 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
 382                                          struct sys_notify_context *ctx,
 383                                          struct notify_entry *e,
 384                                          void (*callback)(struct sys_notify_context *ctx,
 385                                                           void *private_data,
 386                                                           struct notify_event *ev),
 387                                          void *private_data, void *handle_p);
 388                 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
 389                 struct file_id (*file_id_create)(struct vfs_handle_struct *handle,
 390                                                  const SMB_STRUCT_STAT *sbuf);
 391
 392                 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
 393                                        struct files_struct *fsp,
 394                                        const char *fname,
 395                                        TALLOC_CTX *mem_ctx,
 396                                        unsigned int *num_streams,
 397                                        struct stream_struct **streams);
 398
 399                 int (*get_real_filename)(struct vfs_handle_struct *handle,
 400                                          const char *path,
 401                                          const char *name,
 402                                          TALLOC_CTX *mem_ctx,
 403                                          char **found_name);
 404
 405                 NTSTATUS (*brl_lock_windows)(struct vfs_handle_struct *handle,
 406                                              struct byte_range_lock *br_lck,
 407                                              struct lock_struct *plock,
 408                                              bool blocking_lock,
 409                                              struct blocking_lock_record *blr);
 410
 411                 bool (*brl_unlock_windows)(struct vfs_handle_struct *handle,
 412                                            struct messaging_context *msg_ctx,
 413                                            struct byte_range_lock *br_lck,
 414                                            const struct lock_struct *plock);
 415
 416                 bool (*brl_cancel_windows)(struct vfs_handle_struct *handle,
 417                                            struct byte_range_lock *br_lck,
 418                                            struct lock_struct *plock,
 419                                            struct blocking_lock_record *blr);
 420
 421                 bool (*strict_lock)(struct vfs_handle_struct *handle,
 422                                         struct files_struct *fsp,
 423                                         struct lock_struct *plock);
 424
 425                 void (*strict_unlock)(struct vfs_handle_struct *handle,
 426                                         struct files_struct *fsp,
 427                                         struct lock_struct *plock);
 428
 429                 /* NT ACL operations. */
 430
 431                 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
 432                                         struct files_struct *fsp,
 433                                         uint32 security_info,
 434                                         struct security_descriptor **ppdesc);
 435                 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
 436                                        const char *name,
 437                                        uint32 security_info,
 438                                        struct security_descriptor **ppdesc);
 439                 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
 440                                         struct files_struct *fsp,
 441                                         uint32 security_info_sent,
 442                                         const struct security_descriptor *psd);
 443
 444                 /* POSIX ACL operations. */
 445
 446                 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
 447                 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 448
 449                 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
 450                 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
 451                 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
 452                 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
 453                 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
 454                 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 455                 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
 456                 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
 457                 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
 458                 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
 459                 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
 460                 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
 461                 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
 462                 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
 463                 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
 464                 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
 465                 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
 466                 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
 467                 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
 468                 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
 469                 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
 470                 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
 471
 472                 /* EA operations. */
 473                 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
 474                 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
 475                 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
 476                 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
 477                 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
 478                 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
 479                 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
 480                 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
 481                 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
 482                 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
 483                 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
 484                 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
 485
 486                 /* aio operations */
 487                 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 488                 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 489                 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 490                 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 491                 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
 492                 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
 493                 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
 494                 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 495
 496                 /* offline operations */
 497                 bool (*is_offline)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
 498                 int (*set_offline)(struct vfs_handle_struct *handle, const char *path);
 499         } ops;
 500
 501         struct vfs_handles_pointers {
 502                 /* Disk operations */
 503
 504                 struct vfs_handle_struct *connect_hnd;
 505                 struct vfs_handle_struct *disconnect;
 506                 struct vfs_handle_struct *disk_free;
 507                 struct vfs_handle_struct *get_quota;
 508                 struct vfs_handle_struct *set_quota;
 509                 struct vfs_handle_struct *get_shadow_copy_data;
 510                 struct vfs_handle_struct *statvfs;
 511                 struct vfs_handle_struct *fs_capabilities;
 512
 513                 /* Directory operations */
 514
 515                 struct vfs_handle_struct *opendir;
 516                 struct vfs_handle_struct *readdir;
 517                 struct vfs_handle_struct *seekdir;
 518                 struct vfs_handle_struct *telldir;
 519                 struct vfs_handle_struct *rewind_dir;
 520                 struct vfs_handle_struct *mkdir;
 521                 struct vfs_handle_struct *rmdir;
 522                 struct vfs_handle_struct *closedir;
 523                 struct vfs_handle_struct *init_search_op;
 524
 525                 /* File operations */
 526
 527                 struct vfs_handle_struct *open;
 528                 struct vfs_handle_struct *create_file;
 529                 struct vfs_handle_struct *close_hnd;
 530                 struct vfs_handle_struct *vfs_read;
 531                 struct vfs_handle_struct *pread;
 532                 struct vfs_handle_struct *write;
 533                 struct vfs_handle_struct *pwrite;
 534                 struct vfs_handle_struct *lseek;
 535                 struct vfs_handle_struct *sendfile;
 536                 struct vfs_handle_struct *recvfile;
 537                 struct vfs_handle_struct *rename;
 538                 struct vfs_handle_struct *fsync;
 539                 struct vfs_handle_struct *stat;
 540                 struct vfs_handle_struct *fstat;
 541                 struct vfs_handle_struct *lstat;
 542                 struct vfs_handle_struct *get_alloc_size;
 543                 struct vfs_handle_struct *unlink;
 544                 struct vfs_handle_struct *chmod;
 545                 struct vfs_handle_struct *fchmod;
 546                 struct vfs_handle_struct *chown;
 547                 struct vfs_handle_struct *fchown;
 548                 struct vfs_handle_struct *lchown;
 549                 struct vfs_handle_struct *chdir;
 550                 struct vfs_handle_struct *getwd;
 551                 struct vfs_handle_struct *ntimes;
 552                 struct vfs_handle_struct *ftruncate;
 553                 struct vfs_handle_struct *lock;
 554                 struct vfs_handle_struct *kernel_flock;
 555                 struct vfs_handle_struct *linux_setlease;
 556                 struct vfs_handle_struct *getlock;
 557                 struct vfs_handle_struct *symlink;
 558                 struct vfs_handle_struct *vfs_readlink;
 559                 struct vfs_handle_struct *link;
 560                 struct vfs_handle_struct *mknod;
 561                 struct vfs_handle_struct *realpath;
 562                 struct vfs_handle_struct *notify_watch;
 563                 struct vfs_handle_struct *chflags;
 564                 struct vfs_handle_struct *file_id_create;
 565                 struct vfs_handle_struct *streaminfo;
 566                 struct vfs_handle_struct *get_real_filename;
 567                 struct vfs_handle_struct *brl_lock_windows;
 568                 struct vfs_handle_struct *brl_unlock_windows;
 569                 struct vfs_handle_struct *brl_cancel_windows;
 570                 struct vfs_handle_struct *strict_lock;
 571                 struct vfs_handle_struct *strict_unlock;
 572
 573                 /* NT ACL operations. */
 574
 575                 struct vfs_handle_struct *fget_nt_acl;
 576                 struct vfs_handle_struct *get_nt_acl;
 577                 struct vfs_handle_struct *fset_nt_acl;
 578
 579                 /* POSIX ACL operations. */
 580
 581                 struct vfs_handle_struct *chmod_acl;
 582                 struct vfs_handle_struct *fchmod_acl;
 583
 584                 struct vfs_handle_struct *sys_acl_get_entry;
 585                 struct vfs_handle_struct *sys_acl_get_tag_type;
 586                 struct vfs_handle_struct *sys_acl_get_permset;
 587                 struct vfs_handle_struct *sys_acl_get_qualifier;
 588                 struct vfs_handle_struct *sys_acl_get_file;
 589                 struct vfs_handle_struct *sys_acl_get_fd;
 590                 struct vfs_handle_struct *sys_acl_clear_perms;
 591                 struct vfs_handle_struct *sys_acl_add_perm;
 592                 struct vfs_handle_struct *sys_acl_to_text;
 593                 struct vfs_handle_struct *sys_acl_init;
 594                 struct vfs_handle_struct *sys_acl_create_entry;
 595                 struct vfs_handle_struct *sys_acl_set_tag_type;
 596                 struct vfs_handle_struct *sys_acl_set_qualifier;
 597                 struct vfs_handle_struct *sys_acl_set_permset;
 598                 struct vfs_handle_struct *sys_acl_valid;
 599                 struct vfs_handle_struct *sys_acl_set_file;
 600                 struct vfs_handle_struct *sys_acl_set_fd;
 601                 struct vfs_handle_struct *sys_acl_delete_def_file;
 602                 struct vfs_handle_struct *sys_acl_get_perm;
 603                 struct vfs_handle_struct *sys_acl_free_text;
 604                 struct vfs_handle_struct *sys_acl_free_acl;
 605                 struct vfs_handle_struct *sys_acl_free_qualifier;
 606
 607                 /* EA operations. */
 608                 struct vfs_handle_struct *getxattr;
 609                 struct vfs_handle_struct *lgetxattr;
 610                 struct vfs_handle_struct *fgetxattr;
 611                 struct vfs_handle_struct *listxattr;
 612                 struct vfs_handle_struct *llistxattr;
 613                 struct vfs_handle_struct *flistxattr;
 614                 struct vfs_handle_struct *removexattr;
 615                 struct vfs_handle_struct *lremovexattr;
 616                 struct vfs_handle_struct *fremovexattr;
 617                 struct vfs_handle_struct *setxattr;
 618                 struct vfs_handle_struct *lsetxattr;
 619                 struct vfs_handle_struct *fsetxattr;
 620
 621                 /* aio operations */
 622                 struct vfs_handle_struct *aio_read;
 623                 struct vfs_handle_struct *aio_write;
 624                 struct vfs_handle_struct *aio_return;
 625                 struct vfs_handle_struct *aio_cancel;
 626                 struct vfs_handle_struct *aio_error;
 627                 struct vfs_handle_struct *aio_fsync;
 628                 struct vfs_handle_struct *aio_suspend;
 629                 struct vfs_handle_struct *aio_force;
 630
 631                 /* offline operations */
 632                 struct vfs_handle_struct *is_offline;
 633                 struct vfs_handle_struct *set_offline;
 634         } handles;
 635 };
 636
 637 /*
 638     Possible VFS operation layers (per-operation)
 639
 640     These values are used by VFS subsystem when building vfs_ops for connection
 641     from multiple VFS modules. Internally, Samba differentiates only opaque and
 642     transparent layers at this process. Other types are used for providing better
 643     diagnosing facilities.
 644
 645     Most modules will provide transparent layers. Opaque layer is for modules
 646     which implement actual file system calls (like DB-based VFS). For example,
 647     default POSIX VFS which is built in into Samba is an opaque VFS module.
 648
 649     Other layer types (audit, splitter, scanner) were designed to provide different
 650     degree of transparency and for diagnosing VFS module behaviour.
 651
 652     Each module can implement several layers at the same time provided that only
 653     one layer is used per each operation.
 654
 655 */
 656
 657 typedef enum _vfs_op_layer {
 658         SMB_VFS_LAYER_NOOP = -1,        /* - For using in VFS module to indicate end of array */
 659                                         /*   of operations description */
 660         SMB_VFS_LAYER_OPAQUE = 0,       /* - Final level, does not call anything beyond itself */
 661         SMB_VFS_LAYER_TRANSPARENT,      /* - Normal operation, calls underlying layer after */
 662                                         /*   possibly changing passed data */
 663         SMB_VFS_LAYER_LOGGER,           /* - Logs data, calls underlying layer, logging may not */
 664                                         /*   use Samba VFS */
 665         SMB_VFS_LAYER_SPLITTER,         /* - Splits operation, calls underlying layer _and_ own facility, */
 666                                         /*   then combines result */
 667         SMB_VFS_LAYER_SCANNER           /* - Checks data and possibly initiates additional */
 668                                         /*   file activity like logging to files _inside_ samba VFS */
 669 } vfs_op_layer;
 670
 671 /*
 672     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
 673     which describes all operations this module is willing to intercept.
 674     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
 675     using this information.
 676 */
 677
 678 typedef struct vfs_op_tuple {
 679         void* op;
 680         vfs_op_type type;
 681         vfs_op_layer layer;
 682 } vfs_op_tuple;
 683
 684
 685 typedef struct vfs_handle_struct {
 686         struct vfs_handle_struct  *next, *prev;
 687         const char *param;
 688         struct vfs_ops vfs_next;
 689         struct connection_struct *conn;
 690         void *data;
 691         void (*free_data)(void **data);
 692 } vfs_handle_struct;
 693
 694
 695 typedef struct vfs_statvfs_struct {
 696         /* For undefined recommended transfer size return -1 in that field */
 697         uint32 OptimalTransferSize;  /* bsize on some os, iosize on other os */
 698         uint32 BlockSize;
 699
 700         /*
 701          The next three fields are in terms of the block size.
 702          (above). If block size is unknown, 4096 would be a
 703          reasonable block size for a server to report.
 704          Note that returning the blocks/blocksavail removes need
 705          to make a second call (to QFSInfo level 0x103 to get this info.
 706          UserBlockAvail is typically less than or equal to BlocksAvail,
 707          if no distinction is made return the same value in each.
 708         */
 709
 710         uint64_t TotalBlocks;
 711         uint64_t BlocksAvail;       /* bfree */
 712         uint64_t UserBlocksAvail;   /* bavail */
 713
 714         /* For undefined Node fields or FSID return -1 */
 715         uint64_t TotalFileNodes;
 716         uint64_t FreeFileNodes;
 717         uint64_t FsIdentifier;   /* fsid */
 718         /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
 719         /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
 720
 721         int FsCapabilities;
 722 } vfs_statvfs_struct;
 723
 724 /* Add a new FSP extension of the given type. Returns a pointer to the
 725  * extenstion data.
 726  */
 727 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn)            \
 728     vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
 729
 730 /* Return a pointer to the existing FSP extension data. */
 731 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
 732     vfs_fetch_fsp_extension(handle, (fsp))
 733
 734 /* Return the talloc context associated with an FSP extension. */
 735 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
 736     vfs_memctx_fsp_extension(handle, (fsp))
 737
 738 /* Remove and destroy an FSP extension. */
 739 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
 740     vfs_remove_fsp_extension((handle), (fsp))
 741
 742 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
 743         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
 744                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
 745                 ret; \
 746         } \
 747 }
 748
 749 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
 750         if (!(handle)) { \
 751                 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
 752                 ret; \
 753         } else { \
 754                 if ((handle)->free_data) { \
 755                         (handle)->free_data(&(handle)->data); \
 756                 } \
 757                 (handle)->data = (void *)datap; \
 758                 (handle)->free_data = free_fn; \
 759         } \
 760 }
 761
 762 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
 763         if ((handle) && (handle)->free_data) { \
 764                 (handle)->free_data(&(handle)->data); \
 765         } \
 766 }
 767
 768 /* Check whether module-specific data handle was already allocated or not */
 769 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
 770
 771 #define SMB_VFS_OP(x) ((void *) x)
 772
 773 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
 774
 775 #include "vfs_macros.h"
 776
 777 #endif /* _VFS_H */