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