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