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