source3/include/vfs.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    VFS structures and parameters
   4    Copyright (C) Jeremy Allison                         1999-2003
   5    Copyright (C) Tim Potter                             1999
   6    Copyright (C) Alexander Bokovoy                      2002
   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 2 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, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22
  23    This work was sponsored by Optifacio Software Services, Inc.
  24 */
  25
  26 #ifndef _VFS_H
  27 #define _VFS_H
  28
  29 /* Avoid conflict with an AIX include file */
  30
  31 #ifdef vfs_ops
  32 #undef vfs_ops
  33 #endif
  34
  35 /*
  36  * As we're now (thanks Andrew ! :-) using file_structs and connection
  37  * structs in the vfs - then anyone writing a vfs must include includes.h...
  38  */
  39
  40 /*
  41  * This next constant specifies the version number of the VFS interface
  42  * this smbd will load. Increment this if *ANY* changes are made to the
  43  * vfs_ops below. JRA.
  44  *
  45  * If you change anything here, please also update modules/vfs_full_audit.c.
  46  * VL.
  47  */
  48
  49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
  50 /* Changed to version 3 for POSIX acl extensions. JRA. */
  51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
  52 /* Changed to version 5 for sendfile addition. JRA. */
  53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
  54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
  55 /* Changed to version 8 includes EA calls. JRA. */
  56 /* Changed to version 9 to include the get_shadow_data call. --metze */
  57 /* Changed to version 10 to include pread/pwrite calls. */
  58 #define SMB_VFS_INTERFACE_VERSION 10
  59
  60
  61 /* to bug old modules witch are trying to compile with the old functions */
  62 #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 };
  63 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
  64   __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
  65 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
  66   __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
  67
  68 /*
  69     All intercepted VFS operations must be declared as static functions inside module source
  70     in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
  71     example VFS modules for more details.
  72 */
  73
  74 /* VFS operations structure */
  75
  76 struct vfs_handle_struct;
  77 struct connection_struct;
  78 struct files_struct;
  79 struct security_descriptor_info;
  80
  81 /*
  82     Available VFS operations. These values must be in sync with vfs_ops struct
  83     (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
  84     In particular, if new operations are added to vfs_ops, appropriate constants
  85     should be added to vfs_op_type so that order of them kept same as in vfs_ops.
  86 */
  87
  88 typedef enum _vfs_op_type {
  89         SMB_VFS_OP_NOOP = -1,
  90
  91         /* Disk operations */
  92
  93         SMB_VFS_OP_CONNECT = 0,
  94         SMB_VFS_OP_DISCONNECT,
  95         SMB_VFS_OP_DISK_FREE,
  96         SMB_VFS_OP_GET_QUOTA,
  97         SMB_VFS_OP_SET_QUOTA,
  98         SMB_VFS_OP_GET_SHADOW_COPY_DATA,
  99
 100
 101         /* Directory operations */
 102
 103         SMB_VFS_OP_OPENDIR,
 104         SMB_VFS_OP_READDIR,
 105         SMB_VFS_OP_MKDIR,
 106         SMB_VFS_OP_RMDIR,
 107         SMB_VFS_OP_CLOSEDIR,
 108
 109         /* File operations */
 110
 111         SMB_VFS_OP_OPEN,
 112         SMB_VFS_OP_CLOSE,
 113         SMB_VFS_OP_READ,
 114         SMB_VFS_OP_PREAD,
 115         SMB_VFS_OP_WRITE,
 116         SMB_VFS_OP_PWRITE,
 117         SMB_VFS_OP_LSEEK,
 118         SMB_VFS_OP_SENDFILE,
 119         SMB_VFS_OP_RENAME,
 120         SMB_VFS_OP_FSYNC,
 121         SMB_VFS_OP_STAT,
 122         SMB_VFS_OP_FSTAT,
 123         SMB_VFS_OP_LSTAT,
 124         SMB_VFS_OP_UNLINK,
 125         SMB_VFS_OP_CHMOD,
 126         SMB_VFS_OP_FCHMOD,
 127         SMB_VFS_OP_CHOWN,
 128         SMB_VFS_OP_FCHOWN,
 129         SMB_VFS_OP_CHDIR,
 130         SMB_VFS_OP_GETWD,
 131         SMB_VFS_OP_UTIME,
 132         SMB_VFS_OP_FTRUNCATE,
 133         SMB_VFS_OP_LOCK,
 134         SMB_VFS_OP_SYMLINK,
 135         SMB_VFS_OP_READLINK,
 136         SMB_VFS_OP_LINK,
 137         SMB_VFS_OP_MKNOD,
 138         SMB_VFS_OP_REALPATH,
 139
 140         /* NT ACL operations. */
 141
 142         SMB_VFS_OP_FGET_NT_ACL,
 143         SMB_VFS_OP_GET_NT_ACL,
 144         SMB_VFS_OP_FSET_NT_ACL,
 145         SMB_VFS_OP_SET_NT_ACL,
 146
 147         /* POSIX ACL operations. */
 148
 149         SMB_VFS_OP_CHMOD_ACL,
 150         SMB_VFS_OP_FCHMOD_ACL,
 151
 152         SMB_VFS_OP_SYS_ACL_GET_ENTRY,
 153         SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
 154         SMB_VFS_OP_SYS_ACL_GET_PERMSET,
 155         SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
 156         SMB_VFS_OP_SYS_ACL_GET_FILE,
 157         SMB_VFS_OP_SYS_ACL_GET_FD,
 158         SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
 159         SMB_VFS_OP_SYS_ACL_ADD_PERM,
 160         SMB_VFS_OP_SYS_ACL_TO_TEXT,
 161         SMB_VFS_OP_SYS_ACL_INIT,
 162         SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
 163         SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
 164         SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
 165         SMB_VFS_OP_SYS_ACL_SET_PERMSET,
 166         SMB_VFS_OP_SYS_ACL_VALID,
 167         SMB_VFS_OP_SYS_ACL_SET_FILE,
 168         SMB_VFS_OP_SYS_ACL_SET_FD,
 169         SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
 170         SMB_VFS_OP_SYS_ACL_GET_PERM,
 171         SMB_VFS_OP_SYS_ACL_FREE_TEXT,
 172         SMB_VFS_OP_SYS_ACL_FREE_ACL,
 173         SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
 174
 175         /* EA operations. */
 176         SMB_VFS_OP_GETXATTR,
 177         SMB_VFS_OP_LGETXATTR,
 178         SMB_VFS_OP_FGETXATTR,
 179         SMB_VFS_OP_LISTXATTR,
 180         SMB_VFS_OP_LLISTXATTR,
 181         SMB_VFS_OP_FLISTXATTR,
 182         SMB_VFS_OP_REMOVEXATTR,
 183         SMB_VFS_OP_LREMOVEXATTR,
 184         SMB_VFS_OP_FREMOVEXATTR,
 185         SMB_VFS_OP_SETXATTR,
 186         SMB_VFS_OP_LSETXATTR,
 187         SMB_VFS_OP_FSETXATTR,
 188
 189         /* This should always be last enum value */
 190
 191         SMB_VFS_OP_LAST
 192 } vfs_op_type;
 193
 194 /*
 195     Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
 196 */
 197 struct vfs_ops {
 198         struct vfs_fn_pointers {
 199                 /* Disk operations */
 200
 201                 int (*connect)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *service, const char *user);
 202                 void (*disconnect)(struct vfs_handle_struct *handle, struct connection_struct *conn);
 203                 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, BOOL small_query, SMB_BIG_UINT *bsize,
 204                         SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
 205                 int (*get_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 206                 int (*set_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
 207                 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, BOOL labels);
 208
 209                 /* Directory operations */
 210
 211                 DIR *(*opendir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname);
 212                 struct dirent *(*readdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
 213                 int (*mkdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
 214                 int (*rmdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
 215                 int (*closedir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dir);
 216
 217                 /* File operations */
 218
 219                 int (*open)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, int flags, mode_t mode);
 220                 int (*close)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
 221                 ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
 222                 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
 223                 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
 224                 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
 225                 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
 226                 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);
 227                 int (*rename)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *old, const char *new);
 228                 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
 229                 int (*stat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, SMB_STRUCT_STAT *sbuf);
 230                 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
 231                 int (*lstat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf);
 232                 int (*unlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
 233                 int (*chmod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
 234                 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
 235                 int (*chown)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, uid_t uid, gid_t gid);
 236                 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
 237                 int (*chdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
 238                 char *(*getwd)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *buf);
 239                 int (*utime)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, struct utimbuf *times);
 240                 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
 241                 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);
 242                 int (*symlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
 243                 int (*readlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *buf, size_t bufsiz);
 244                 int (*link)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
 245                 int (*mknod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode, SMB_DEV_T dev);
 246                 char *(*realpath)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *resolved_path);
 247
 248                 /* NT ACL operations. */
 249
 250                 size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd,  uint32 security_info, struct security_descriptor_info **ppdesc);
 251                 size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name,  uint32 security_info, struct security_descriptor_info **ppdesc);
 252                 BOOL (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor_info *psd);
 253                 BOOL (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor_info *psd);
 254
 255                 /* POSIX ACL operations. */
 256
 257                 int (*chmod_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, mode_t mode);
 258                 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
 259
 260                 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
 261                 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
 262                 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
 263                 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d);
 264                 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path_p, SMB_ACL_TYPE_T type);
 265                 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
 266                 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset);
 267                 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
 268                 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, ssize_t *plen);
 269                 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, struct connection_struct *conn, int count);
 270                 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
 271                 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
 272                 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, void *qual);
 273                 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
 274                 int (*sys_acl_valid)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl );
 275                 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
 276                 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
 277                 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
 278                 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
 279                 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *text);
 280                 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T posix_acl);
 281                 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, void *qualifier, SMB_ACL_TAG_T tagtype);
 282
 283                 /* EA operations. */
 284                 ssize_t (*getxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
 285                 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
 286                 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
 287                 ssize_t (*listxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
 288                 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
 289                 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
 290                 int (*removexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
 291                 int (*lremovexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
 292                 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
 293                 int (*setxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
 294                 int (*lsetxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
 295                 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
 296
 297         } ops;
 298
 299         struct vfs_handles_pointers {
 300                 /* Disk operations */
 301
 302                 struct vfs_handle_struct *connect;
 303                 struct vfs_handle_struct *disconnect;
 304                 struct vfs_handle_struct *disk_free;
 305                 struct vfs_handle_struct *get_quota;
 306                 struct vfs_handle_struct *set_quota;
 307                 struct vfs_handle_struct *get_shadow_copy_data;
 308
 309                 /* Directory operations */
 310
 311                 struct vfs_handle_struct *opendir;
 312                 struct vfs_handle_struct *readdir;
 313                 struct vfs_handle_struct *mkdir;
 314                 struct vfs_handle_struct *rmdir;
 315                 struct vfs_handle_struct *closedir;
 316
 317                 /* File operations */
 318
 319                 struct vfs_handle_struct *open;
 320                 struct vfs_handle_struct *close;
 321                 struct vfs_handle_struct *read;
 322                 struct vfs_handle_struct *pread;
 323                 struct vfs_handle_struct *write;
 324                 struct vfs_handle_struct *pwrite;
 325                 struct vfs_handle_struct *lseek;
 326                 struct vfs_handle_struct *sendfile;
 327                 struct vfs_handle_struct *rename;
 328                 struct vfs_handle_struct *fsync;
 329                 struct vfs_handle_struct *stat;
 330                 struct vfs_handle_struct *fstat;
 331                 struct vfs_handle_struct *lstat;
 332                 struct vfs_handle_struct *unlink;
 333                 struct vfs_handle_struct *chmod;
 334                 struct vfs_handle_struct *fchmod;
 335                 struct vfs_handle_struct *chown;
 336                 struct vfs_handle_struct *fchown;
 337                 struct vfs_handle_struct *chdir;
 338                 struct vfs_handle_struct *getwd;
 339                 struct vfs_handle_struct *utime;
 340                 struct vfs_handle_struct *ftruncate;
 341                 struct vfs_handle_struct *lock;
 342                 struct vfs_handle_struct *symlink;
 343                 struct vfs_handle_struct *readlink;
 344                 struct vfs_handle_struct *link;
 345                 struct vfs_handle_struct *mknod;
 346                 struct vfs_handle_struct *realpath;
 347
 348                 /* NT ACL operations. */
 349
 350                 struct vfs_handle_struct *fget_nt_acl;
 351                 struct vfs_handle_struct *get_nt_acl;
 352                 struct vfs_handle_struct *fset_nt_acl;
 353                 struct vfs_handle_struct *set_nt_acl;
 354
 355                 /* POSIX ACL operations. */
 356
 357                 struct vfs_handle_struct *chmod_acl;
 358                 struct vfs_handle_struct *fchmod_acl;
 359
 360                 struct vfs_handle_struct *sys_acl_get_entry;
 361                 struct vfs_handle_struct *sys_acl_get_tag_type;
 362                 struct vfs_handle_struct *sys_acl_get_permset;
 363                 struct vfs_handle_struct *sys_acl_get_qualifier;
 364                 struct vfs_handle_struct *sys_acl_get_file;
 365                 struct vfs_handle_struct *sys_acl_get_fd;
 366                 struct vfs_handle_struct *sys_acl_clear_perms;
 367                 struct vfs_handle_struct *sys_acl_add_perm;
 368                 struct vfs_handle_struct *sys_acl_to_text;
 369                 struct vfs_handle_struct *sys_acl_init;
 370                 struct vfs_handle_struct *sys_acl_create_entry;
 371                 struct vfs_handle_struct *sys_acl_set_tag_type;
 372                 struct vfs_handle_struct *sys_acl_set_qualifier;
 373                 struct vfs_handle_struct *sys_acl_set_permset;
 374                 struct vfs_handle_struct *sys_acl_valid;
 375                 struct vfs_handle_struct *sys_acl_set_file;
 376                 struct vfs_handle_struct *sys_acl_set_fd;
 377                 struct vfs_handle_struct *sys_acl_delete_def_file;
 378                 struct vfs_handle_struct *sys_acl_get_perm;
 379                 struct vfs_handle_struct *sys_acl_free_text;
 380                 struct vfs_handle_struct *sys_acl_free_acl;
 381                 struct vfs_handle_struct *sys_acl_free_qualifier;
 382
 383                 /* EA operations. */
 384                 struct vfs_handle_struct *getxattr;
 385                 struct vfs_handle_struct *lgetxattr;
 386                 struct vfs_handle_struct *fgetxattr;
 387                 struct vfs_handle_struct *listxattr;
 388                 struct vfs_handle_struct *llistxattr;
 389                 struct vfs_handle_struct *flistxattr;
 390                 struct vfs_handle_struct *removexattr;
 391                 struct vfs_handle_struct *lremovexattr;
 392                 struct vfs_handle_struct *fremovexattr;
 393                 struct vfs_handle_struct *setxattr;
 394                 struct vfs_handle_struct *lsetxattr;
 395                 struct vfs_handle_struct *fsetxattr;
 396
 397         } handles;
 398 };
 399
 400 /*
 401     Possible VFS operation layers (per-operation)
 402
 403     These values are used by VFS subsystem when building vfs_ops for connection
 404     from multiple VFS modules. Internally, Samba differentiates only opaque and
 405     transparent layers at this process. Other types are used for providing better
 406     diagnosing facilities.
 407
 408     Most modules will provide transparent layers. Opaque layer is for modules
 409     which implement actual file system calls (like DB-based VFS). For example,
 410     default POSIX VFS which is built in into Samba is an opaque VFS module.
 411
 412     Other layer types (audit, splitter, scanner) were designed to provide different
 413     degree of transparency and for diagnosing VFS module behaviour.
 414
 415     Each module can implement several layers at the same time provided that only
 416     one layer is used per each operation.
 417
 418 */
 419
 420 typedef enum _vfs_op_layer {
 421         SMB_VFS_LAYER_NOOP = -1,        /* - For using in VFS module to indicate end of array */
 422                                         /*   of operations description */
 423         SMB_VFS_LAYER_OPAQUE = 0,       /* - Final level, does not call anything beyond itself */
 424         SMB_VFS_LAYER_TRANSPARENT,      /* - Normal operation, calls underlying layer after */
 425                                         /*   possibly changing passed data */
 426         SMB_VFS_LAYER_LOGGER,           /* - Logs data, calls underlying layer, logging may not */
 427                                         /*   use Samba VFS */
 428         SMB_VFS_LAYER_SPLITTER,         /* - Splits operation, calls underlying layer _and_ own facility, */
 429                                         /*   then combines result */
 430         SMB_VFS_LAYER_SCANNER           /* - Checks data and possibly initiates additional */
 431                                         /*   file activity like logging to files _inside_ samba VFS */
 432 } vfs_op_layer;
 433
 434 /*
 435     VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
 436     which describes all operations this module is willing to intercept.
 437     VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
 438     using this information.
 439 */
 440
 441 typedef struct _vfs_op_tuple {
 442         void* op;
 443         vfs_op_type type;
 444         vfs_op_layer layer;
 445 } vfs_op_tuple;
 446
 447
 448 typedef struct vfs_handle_struct {
 449         struct vfs_handle_struct  *next, *prev;
 450         const char *param;
 451         struct vfs_ops vfs_next;
 452         struct connection_struct *conn;
 453         void *data;
 454         void (*free_data)(void **data);
 455 } vfs_handle_struct;
 456
 457
 458 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
 459         if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
 460                 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
 461                 ret; \
 462         } \
 463 }
 464
 465 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
 466         if (!(handle)) { \
 467                 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
 468                 ret; \
 469         } else { \
 470                 if ((handle)->free_data) { \
 471                         (handle)->free_data(&(handle)->data); \
 472                 } \
 473                 (handle)->data = (void *)datap; \
 474                 (handle)->free_data = free_fn; \
 475         } \
 476 }
 477
 478 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
 479         if ((handle) && (handle)->free_data) { \
 480                 (handle)->free_data(&(handle)->data); \
 481         } \
 482 }
 483
 484 /* Check whether module-specific data handle was already allocated or not */
 485 #define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
 486
 487 #define SMB_VFS_OP(x) ((void *) x)
 488
 489
 490 #include "vfs_macros.h"
 491
 492 #endif /* _VFS_H */