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