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