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