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