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