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