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