LXR qemu/fsdev/file-op-9p.h

   1/*
   2 * 9p
   3 *
   4 * Copyright IBM, Corp. 2010
   5 *
   6 * Authors:
   7 *  Aneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.com>
   8 *
   9 * This work is licensed under the terms of the GNU GPL, version 2.  See
  10 * the COPYING file in the top-level directory.
  11 *
  12 */
  13
  14#ifndef FILE_OP_9P_H
  15#define FILE_OP_9P_H
  16
  17#include <dirent.h>
  18#include <utime.h>
  19#include <sys/vfs.h>
  20#include "qemu-fsdev-throttle.h"
  21
  22#define SM_LOCAL_MODE_BITS    0600
  23#define SM_LOCAL_DIR_MODE_BITS    0700
  24
  25typedef struct FsCred {
  26    uid_t   fc_uid;
  27    gid_t   fc_gid;
  28    mode_t  fc_mode;
  29    dev_t   fc_rdev;
  30} FsCred;
  31
  32typedef struct FsContext FsContext;
  33typedef struct V9fsPath V9fsPath;
  34
  35typedef struct ExtendedOps {
  36    int (*get_st_gen)(FsContext *, V9fsPath *, mode_t, uint64_t *);
  37} ExtendedOps;
  38
  39/* export flags */
  40#define V9FS_IMMEDIATE_WRITEOUT     0x00000001
  41#define V9FS_PATHNAME_FSCONTEXT     0x00000002
  42/*
  43 * uid/gid set on fileserver files
  44 */
  45#define V9FS_SM_PASSTHROUGH         0x00000004
  46/*
  47 * uid/gid part of xattr
  48 */
  49#define V9FS_SM_MAPPED              0x00000008
  50/*
  51 * Server will try to set uid/gid.
  52 * On failure ignore the error.
  53 */
  54#define V9FS_SM_NONE                0x00000010
  55/*
  56 * uid/gid part of .virtfs_meatadata namespace
  57 */
  58#define V9FS_SM_MAPPED_FILE         0x00000020
  59#define V9FS_RDONLY                 0x00000040
  60#define V9FS_PROXY_SOCK_FD          0x00000080
  61#define V9FS_PROXY_SOCK_NAME        0x00000100
  62/*
  63 * multidevs option (either one of the two applies exclusively)
  64 */
  65#define V9FS_REMAP_INODES           0x00000200
  66#define V9FS_FORBID_MULTIDEVS       0x00000400
  67/*
  68 * Disables certain performance warnings from being logged on host side.
  69 */
  70#define V9FS_NO_PERF_WARN           0x00000800
  71
  72#define V9FS_SEC_MASK               0x0000003C
  73
  74
  75typedef struct FileOperations FileOperations;
  76typedef struct XattrOperations XattrOperations;
  77
  78/*
  79 * Structure to store the various fsdev's passed through command line.
  80 */
  81typedef struct FsDriverEntry {
  82    char *fsdev_id;
  83    char *path;
  84    int export_flags;
  85    FileOperations *ops;
  86    FsThrottle fst;
  87    mode_t fmode;
  88    mode_t dmode;
  89} FsDriverEntry;
  90
  91struct FsContext {
  92    uid_t uid;
  93    char *fs_root;
  94    int export_flags;
  95    XattrOperations **xops;
  96    ExtendedOps exops;
  97    FsThrottle *fst;
  98    /* fs driver specific data */
  99    void *private;
 100    mode_t fmode;
 101    mode_t dmode;
 102};
 103
 104struct V9fsPath {
 105    uint16_t size;
 106    char *data;
 107};
 108
 109typedef union V9fsFidOpenState V9fsFidOpenState;
 110
 111void cred_init(FsCred *);
 112
 113struct FileOperations {
 114    int (*parse_opts)(QemuOpts *, FsDriverEntry *, Error **errp);
 115    int (*init)(FsContext *, Error **errp);
 116    void (*cleanup)(FsContext *);
 117    int (*lstat)(FsContext *, V9fsPath *, struct stat *);
 118    ssize_t (*readlink)(FsContext *, V9fsPath *, char *, size_t);
 119    int (*chmod)(FsContext *, V9fsPath *, FsCred *);
 120    int (*chown)(FsContext *, V9fsPath *, FsCred *);
 121    int (*mknod)(FsContext *, V9fsPath *, const char *, FsCred *);
 122    int (*utimensat)(FsContext *, V9fsPath *, const struct timespec *);
 123    int (*remove)(FsContext *, const char *);
 124    int (*symlink)(FsContext *, const char *, V9fsPath *,
 125                   const char *, FsCred *);
 126    int (*link)(FsContext *, V9fsPath *, V9fsPath *, const char *);
 127    int (*setuid)(FsContext *, uid_t);
 128    int (*close)(FsContext *, V9fsFidOpenState *);
 129    int (*closedir)(FsContext *, V9fsFidOpenState *);
 130    int (*opendir)(FsContext *, V9fsPath *, V9fsFidOpenState *);
 131    int (*open)(FsContext *, V9fsPath *, int, V9fsFidOpenState *);
 132    int (*open2)(FsContext *, V9fsPath *, const char *,
 133                 int, FsCred *, V9fsFidOpenState *);
 134    void (*rewinddir)(FsContext *, V9fsFidOpenState *);
 135    off_t (*telldir)(FsContext *, V9fsFidOpenState *);
 136    struct dirent * (*readdir)(FsContext *, V9fsFidOpenState *);
 137    void (*seekdir)(FsContext *, V9fsFidOpenState *, off_t);
 138    ssize_t (*preadv)(FsContext *, V9fsFidOpenState *,
 139                      const struct iovec *, int, off_t);
 140    ssize_t (*pwritev)(FsContext *, V9fsFidOpenState *,
 141                       const struct iovec *, int, off_t);
 142    int (*mkdir)(FsContext *, V9fsPath *, const char *, FsCred *);
 143    int (*fstat)(FsContext *, int, V9fsFidOpenState *, struct stat *);
 144    int (*rename)(FsContext *, const char *, const char *);
 145    int (*truncate)(FsContext *, V9fsPath *, off_t);
 146    int (*fsync)(FsContext *, int, V9fsFidOpenState *, int);
 147    int (*statfs)(FsContext *s, V9fsPath *path, struct statfs *stbuf);
 148    ssize_t (*lgetxattr)(FsContext *, V9fsPath *,
 149                         const char *, void *, size_t);
 150    ssize_t (*llistxattr)(FsContext *, V9fsPath *, void *, size_t);
 151    int (*lsetxattr)(FsContext *, V9fsPath *,
 152                     const char *, void *, size_t, int);
 153    int (*lremovexattr)(FsContext *, V9fsPath *, const char *);
 154    int (*name_to_path)(FsContext *, V9fsPath *, const char *, V9fsPath *);
 155    int (*renameat)(FsContext *ctx, V9fsPath *olddir, const char *old_name,
 156                    V9fsPath *newdir, const char *new_name);
 157    int (*unlinkat)(FsContext *ctx, V9fsPath *dir, const char *name, int flags);
 158};
 159
 160#endif
 161