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