LXR linux/fs/vboxsf/vfsmod.h

   1/* SPDX-License-Identifier: MIT */
   2/*
   3 * VirtualBox Guest Shared Folders support: module header.
   4 *
   5 * Copyright (C) 2006-2018 Oracle Corporation
   6 */
   7
   8#ifndef VFSMOD_H
   9#define VFSMOD_H
  10
  11#include <linux/backing-dev.h>
  12#include <linux/idr.h>
  13#include "shfl_hostintf.h"
  14
  15#define DIR_BUFFER_SIZE SZ_16K
  16
  17/* The cast is to prevent assignment of void * to pointers of arbitrary type */
  18#define VBOXSF_SBI(sb)  ((struct vboxsf_sbi *)(sb)->s_fs_info)
  19#define VBOXSF_I(i)     container_of(i, struct vboxsf_inode, vfs_inode)
  20
  21struct vboxsf_handle;
  22
  23struct vboxsf_options {
  24        unsigned long ttl;
  25        kuid_t uid;
  26        kgid_t gid;
  27        bool dmode_set;
  28        bool fmode_set;
  29        umode_t dmode;
  30        umode_t fmode;
  31        umode_t dmask;
  32        umode_t fmask;
  33};
  34
  35struct vboxsf_fs_context {
  36        struct vboxsf_options o;
  37        char *nls_name;
  38};
  39
  40/* per-shared folder information */
  41struct vboxsf_sbi {
  42        struct vboxsf_options o;
  43        struct shfl_fsobjinfo root_info;
  44        struct idr ino_idr;
  45        spinlock_t ino_idr_lock; /* This protects ino_idr */
  46        struct nls_table *nls;
  47        u32 next_generation;
  48        u32 root;
  49        int bdi_id;
  50};
  51
  52/* per-inode information */
  53struct vboxsf_inode {
  54        /* some information was changed, update data on next revalidate */
  55        int force_restat;
  56        /* list of open handles for this inode + lock protecting it */
  57        struct list_head handle_list;
  58        /* This mutex protects handle_list accesses */
  59        struct mutex handle_list_mutex;
  60        /* The VFS inode struct */
  61        struct inode vfs_inode;
  62};
  63
  64struct vboxsf_dir_info {
  65        struct list_head info_list;
  66};
  67
  68struct vboxsf_dir_buf {
  69        size_t entries;
  70        size_t free;
  71        size_t used;
  72        void *buf;
  73        struct list_head head;
  74};
  75
  76/* globals */
  77extern const struct inode_operations vboxsf_dir_iops;
  78extern const struct inode_operations vboxsf_lnk_iops;
  79extern const struct inode_operations vboxsf_reg_iops;
  80extern const struct file_operations vboxsf_dir_fops;
  81extern const struct file_operations vboxsf_reg_fops;
  82extern const struct address_space_operations vboxsf_reg_aops;
  83extern const struct dentry_operations vboxsf_dentry_ops;
  84
  85/* from file.c */
  86struct vboxsf_handle *vboxsf_create_sf_handle(struct inode *inode,
  87                                              u64 handle, u32 access_flags);
  88void vboxsf_release_sf_handle(struct inode *inode, struct vboxsf_handle *sf_handle);
  89
  90/* from utils.c */
  91struct inode *vboxsf_new_inode(struct super_block *sb);
  92int vboxsf_init_inode(struct vboxsf_sbi *sbi, struct inode *inode,
  93                       const struct shfl_fsobjinfo *info, bool reinit);
  94int vboxsf_create_at_dentry(struct dentry *dentry,
  95                            struct shfl_createparms *params);
  96int vboxsf_stat(struct vboxsf_sbi *sbi, struct shfl_string *path,
  97                struct shfl_fsobjinfo *info);
  98int vboxsf_stat_dentry(struct dentry *dentry, struct shfl_fsobjinfo *info);
  99int vboxsf_inode_revalidate(struct dentry *dentry);
 100int vboxsf_getattr(struct user_namespace *mnt_userns, const struct path *path,
 101                   struct kstat *kstat, u32 request_mask,
 102                   unsigned int query_flags);
 103int vboxsf_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
 104                   struct iattr *iattr);
 105struct shfl_string *vboxsf_path_from_dentry(struct vboxsf_sbi *sbi,
 106                                            struct dentry *dentry);
 107int vboxsf_nlscpy(struct vboxsf_sbi *sbi, char *name, size_t name_bound_len,
 108                  const unsigned char *utf8_name, size_t utf8_len);
 109struct vboxsf_dir_info *vboxsf_dir_info_alloc(void);
 110void vboxsf_dir_info_free(struct vboxsf_dir_info *p);
 111int vboxsf_dir_read_all(struct vboxsf_sbi *sbi, struct vboxsf_dir_info *sf_d,
 112                        u64 handle);
 113
 114/* from vboxsf_wrappers.c */
 115int vboxsf_connect(void);
 116void vboxsf_disconnect(void);
 117
 118int vboxsf_create(u32 root, struct shfl_string *parsed_path,
 119                  struct shfl_createparms *create_parms);
 120
 121int vboxsf_close(u32 root, u64 handle);
 122int vboxsf_remove(u32 root, struct shfl_string *parsed_path, u32 flags);
 123int vboxsf_rename(u32 root, struct shfl_string *src_path,
 124                  struct shfl_string *dest_path, u32 flags);
 125
 126int vboxsf_read(u32 root, u64 handle, u64 offset, u32 *buf_len, u8 *buf);
 127int vboxsf_write(u32 root, u64 handle, u64 offset, u32 *buf_len, u8 *buf);
 128
 129int vboxsf_dirinfo(u32 root, u64 handle,
 130                   struct shfl_string *parsed_path, u32 flags, u32 index,
 131                   u32 *buf_len, struct shfl_dirinfo *buf, u32 *file_count);
 132int vboxsf_fsinfo(u32 root, u64 handle, u32 flags,
 133                  u32 *buf_len, void *buf);
 134
 135int vboxsf_map_folder(struct shfl_string *folder_name, u32 *root);
 136int vboxsf_unmap_folder(u32 root);
 137
 138int vboxsf_readlink(u32 root, struct shfl_string *parsed_path,
 139                    u32 buf_len, u8 *buf);
 140int vboxsf_symlink(u32 root, struct shfl_string *new_path,
 141                   struct shfl_string *old_path, struct shfl_fsobjinfo *buf);
 142
 143int vboxsf_set_utf8(void);
 144int vboxsf_set_symlinks(void);
 145
 146#endif
 147