source3/include/vfs.h

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