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