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