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