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