source3/include/vfs.h

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