hw/9pfs/virtio-9p.h

   1 #ifndef _QEMU_VIRTIO_9P_H
   2 #define _QEMU_VIRTIO_9P_H
   3
   4 #include <sys/types.h>
   5 #include <dirent.h>
   6 #include <sys/time.h>
   7 #include <utime.h>
   8 #include "hw/virtio.h"
   9 #include "fsdev/file-op-9p.h"
  10
  11 /* The feature bitmap for virtio 9P */
  12 /* The mount point is specified in a config variable */
  13 #define VIRTIO_9P_MOUNT_TAG 0
  14
  15 enum {
  16     P9_TLERROR = 6,
  17     P9_RLERROR,
  18     P9_TSTATFS = 8,
  19     P9_RSTATFS,
  20     P9_TLOPEN = 12,
  21     P9_RLOPEN,
  22     P9_TLCREATE = 14,
  23     P9_RLCREATE,
  24     P9_TSYMLINK = 16,
  25     P9_RSYMLINK,
  26     P9_TMKNOD = 18,
  27     P9_RMKNOD,
  28     P9_TRENAME = 20,
  29     P9_RRENAME,
  30     P9_TREADLINK = 22,
  31     P9_RREADLINK,
  32     P9_TGETATTR = 24,
  33     P9_RGETATTR,
  34     P9_TSETATTR = 26,
  35     P9_RSETATTR,
  36     P9_TXATTRWALK = 30,
  37     P9_RXATTRWALK,
  38     P9_TXATTRCREATE = 32,
  39     P9_RXATTRCREATE,
  40     P9_TREADDIR = 40,
  41     P9_RREADDIR,
  42     P9_TFSYNC = 50,
  43     P9_RFSYNC,
  44     P9_TLOCK = 52,
  45     P9_RLOCK,
  46     P9_TGETLOCK = 54,
  47     P9_RGETLOCK,
  48     P9_TLINK = 70,
  49     P9_RLINK,
  50     P9_TMKDIR = 72,
  51     P9_RMKDIR,
  52     P9_TVERSION = 100,
  53     P9_RVERSION,
  54     P9_TAUTH = 102,
  55     P9_RAUTH,
  56     P9_TATTACH = 104,
  57     P9_RATTACH,
  58     P9_TERROR = 106,
  59     P9_RERROR,
  60     P9_TFLUSH = 108,
  61     P9_RFLUSH,
  62     P9_TWALK = 110,
  63     P9_RWALK,
  64     P9_TOPEN = 112,
  65     P9_ROPEN,
  66     P9_TCREATE = 114,
  67     P9_RCREATE,
  68     P9_TREAD = 116,
  69     P9_RREAD,
  70     P9_TWRITE = 118,
  71     P9_RWRITE,
  72     P9_TCLUNK = 120,
  73     P9_RCLUNK,
  74     P9_TREMOVE = 122,
  75     P9_RREMOVE,
  76     P9_TSTAT = 124,
  77     P9_RSTAT,
  78     P9_TWSTAT = 126,
  79     P9_RWSTAT,
  80 };
  81
  82
  83 /* qid.types */
  84 enum {
  85     P9_QTDIR = 0x80,
  86     P9_QTAPPEND = 0x40,
  87     P9_QTEXCL = 0x20,
  88     P9_QTMOUNT = 0x10,
  89     P9_QTAUTH = 0x08,
  90     P9_QTTMP = 0x04,
  91     P9_QTSYMLINK = 0x02,
  92     P9_QTLINK = 0x01,
  93     P9_QTFILE = 0x00,
  94 };
  95
  96 enum p9_proto_version {
  97     V9FS_PROTO_2000U = 0x01,
  98     V9FS_PROTO_2000L = 0x02,
  99 };
 100
 101 #define P9_NOTAG    (u16)(~0)
 102 #define P9_NOFID    (u32)(~0)
 103 #define P9_MAXWELEM 16
 104 static inline const char *rpath(FsContext *ctx, const char *path, char *buffer)
 105 {
 106     snprintf(buffer, PATH_MAX, "%s/%s", ctx->fs_root, path);
 107     return buffer;
 108 }
 109
 110 /*
 111  * ample room for Twrite/Rread header
 112  * size[4] Tread/Twrite tag[2] fid[4] offset[8] count[4]
 113  */
 114 #define P9_IOHDRSZ 24
 115
 116 typedef struct V9fsPDU V9fsPDU;
 117 struct V9fsState;
 118
 119 struct V9fsPDU
 120 {
 121     uint32_t size;
 122     uint16_t tag;
 123     uint8_t id;
 124     VirtQueueElement elem;
 125     struct V9fsState *s;
 126     QLIST_ENTRY(V9fsPDU) next;
 127 };
 128
 129
 130 /* FIXME
 131  * 1) change user needs to set groups and stuff
 132  */
 133
 134 /* from Linux's linux/virtio_9p.h */
 135
 136 /* The ID for virtio console */
 137 #define VIRTIO_ID_9P    9
 138 #define MAX_REQ         128
 139 #define MAX_TAG_LEN     32
 140
 141 #define BUG_ON(cond) assert(!(cond))
 142
 143 typedef struct V9fsFidState V9fsFidState;
 144
 145 typedef struct V9fsString
 146 {
 147     int16_t size;
 148     char *data;
 149 } V9fsString;
 150
 151 typedef struct V9fsQID
 152 {
 153     int8_t type;
 154     int32_t version;
 155     int64_t path;
 156 } V9fsQID;
 157
 158 typedef struct V9fsStat
 159 {
 160     int16_t size;
 161     int16_t type;
 162     int32_t dev;
 163     V9fsQID qid;
 164     int32_t mode;
 165     int32_t atime;
 166     int32_t mtime;
 167     int64_t length;
 168     V9fsString name;
 169     V9fsString uid;
 170     V9fsString gid;
 171     V9fsString muid;
 172     /* 9p2000.u */
 173     V9fsString extension;
 174    int32_t n_uid;
 175     int32_t n_gid;
 176     int32_t n_muid;
 177 } V9fsStat;
 178
 179 enum {
 180     P9_FID_NONE = 0,
 181     P9_FID_FILE,
 182     P9_FID_DIR,
 183     P9_FID_XATTR,
 184 };
 185
 186 typedef struct V9fsXattr
 187 {
 188     int64_t copied_len;
 189     int64_t len;
 190     void *value;
 191     V9fsString name;
 192     int flags;
 193 } V9fsXattr;
 194
 195 struct V9fsFidState
 196 {
 197     int fid_type;
 198     int32_t fid;
 199     V9fsString path;
 200     union {
 201         int fd;
 202         DIR *dir;
 203         V9fsXattr xattr;
 204     } fs;
 205     uid_t uid;
 206     V9fsFidState *next;
 207 };
 208
 209 typedef struct V9fsState
 210 {
 211     VirtIODevice vdev;
 212     VirtQueue *vq;
 213     V9fsPDU pdus[MAX_REQ];
 214     QLIST_HEAD(, V9fsPDU) free_list;
 215     V9fsFidState *fid_list;
 216     FileOperations *ops;
 217     FsContext ctx;
 218     uint16_t tag_len;
 219     uint8_t *tag;
 220     size_t config_size;
 221     enum p9_proto_version proto_version;
 222     int32_t msize;
 223 } V9fsState;
 224
 225 typedef struct V9fsCreateState {
 226     V9fsPDU *pdu;
 227     size_t offset;
 228     V9fsFidState *fidp;
 229     V9fsQID qid;
 230     int32_t perm;
 231     int8_t mode;
 232     struct stat stbuf;
 233     V9fsString name;
 234     V9fsString extension;
 235     V9fsString fullname;
 236     int iounit;
 237 } V9fsCreateState;
 238
 239 typedef struct V9fsStatState {
 240     V9fsPDU *pdu;
 241     size_t offset;
 242     V9fsStat v9stat;
 243     V9fsFidState *fidp;
 244     struct stat stbuf;
 245 } V9fsStatState;
 246
 247 typedef struct V9fsStatDotl {
 248     uint64_t st_result_mask;
 249     V9fsQID qid;
 250     uint32_t st_mode;
 251     uint32_t st_uid;
 252     uint32_t st_gid;
 253     uint64_t st_nlink;
 254     uint64_t st_rdev;
 255     uint64_t st_size;
 256     uint64_t st_blksize;
 257     uint64_t st_blocks;
 258     uint64_t st_atime_sec;
 259     uint64_t st_atime_nsec;
 260     uint64_t st_mtime_sec;
 261     uint64_t st_mtime_nsec;
 262     uint64_t st_ctime_sec;
 263     uint64_t st_ctime_nsec;
 264     uint64_t st_btime_sec;
 265     uint64_t st_btime_nsec;
 266     uint64_t st_gen;
 267     uint64_t st_data_version;
 268 } V9fsStatDotl;
 269
 270 typedef struct V9fsOpenState {
 271     V9fsPDU *pdu;
 272     size_t offset;
 273     int32_t mode;
 274     V9fsFidState *fidp;
 275     V9fsQID qid;
 276     struct stat stbuf;
 277     int iounit;
 278 } V9fsOpenState;
 279
 280 typedef struct V9fsReadState {
 281     V9fsPDU *pdu;
 282     size_t offset;
 283     int32_t count;
 284     int32_t total;
 285     int64_t off;
 286     V9fsFidState *fidp;
 287     struct iovec iov[128]; /* FIXME: bad, bad, bad */
 288     struct iovec *sg;
 289     off_t dir_pos;
 290     struct dirent *dent;
 291     struct stat stbuf;
 292     V9fsString name;
 293     V9fsStat v9stat;
 294     int32_t len;
 295     int32_t cnt;
 296     int32_t max_count;
 297 } V9fsReadState;
 298
 299 typedef struct V9fsWriteState {
 300     V9fsPDU *pdu;
 301     size_t offset;
 302     int32_t len;
 303     int32_t count;
 304     int32_t total;
 305     int64_t off;
 306     V9fsFidState *fidp;
 307     struct iovec iov[128]; /* FIXME: bad, bad, bad */
 308     struct iovec *sg;
 309     int cnt;
 310 } V9fsWriteState;
 311
 312 typedef struct V9fsWstatState
 313 {
 314     V9fsPDU *pdu;
 315     size_t offset;
 316     int16_t unused;
 317     V9fsStat v9stat;
 318     V9fsFidState *fidp;
 319     struct stat stbuf;
 320 } V9fsWstatState;
 321
 322 typedef struct V9fsSymlinkState
 323 {
 324     V9fsPDU *pdu;
 325     size_t offset;
 326     V9fsString name;
 327     V9fsString symname;
 328     V9fsString fullname;
 329     V9fsFidState *dfidp;
 330     V9fsQID qid;
 331     struct stat stbuf;
 332 } V9fsSymlinkState;
 333
 334 typedef struct V9fsIattr
 335 {
 336     int32_t valid;
 337     int32_t mode;
 338     int32_t uid;
 339     int32_t gid;
 340     int64_t size;
 341     int64_t atime_sec;
 342     int64_t atime_nsec;
 343     int64_t mtime_sec;
 344     int64_t mtime_nsec;
 345 } V9fsIattr;
 346
 347 struct virtio_9p_config
 348 {
 349     /* number of characters in tag */
 350     uint16_t tag_len;
 351     /* Variable size tag name */
 352     uint8_t tag[0];
 353 } __attribute__((packed));
 354
 355 typedef struct V9fsMkState {
 356     V9fsPDU *pdu;
 357     size_t offset;
 358     V9fsQID qid;
 359     struct stat stbuf;
 360     V9fsString name;
 361     V9fsString fullname;
 362 } V9fsMkState;
 363
 364 #define P9_LOCK_SUCCESS 0
 365 #define P9_LOCK_BLOCKED 1
 366 #define P9_LOCK_ERROR 2
 367 #define P9_LOCK_GRACE 3
 368
 369 #define P9_LOCK_FLAGS_BLOCK 1
 370 #define P9_LOCK_FLAGS_RECLAIM 2
 371
 372 typedef struct V9fsFlock
 373 {
 374     uint8_t type;
 375     uint32_t flags;
 376     uint64_t start; /* absolute offset */
 377     uint64_t length;
 378     uint32_t proc_id;
 379     V9fsString client_id;
 380 } V9fsFlock;
 381
 382 typedef struct V9fsGetlock
 383 {
 384     uint8_t type;
 385     uint64_t start; /* absolute offset */
 386     uint64_t length;
 387     uint32_t proc_id;
 388     V9fsString client_id;
 389 } V9fsGetlock;
 390
 391 size_t pdu_packunpack(void *addr, struct iovec *sg, int sg_count,
 392                       size_t offset, size_t size, int pack);
 393
 394 static inline size_t do_pdu_unpack(void *dst, struct iovec *sg, int sg_count,
 395                         size_t offset, size_t size)
 396 {
 397     return pdu_packunpack(dst, sg, sg_count, offset, size, 0);
 398 }
 399
 400 extern void handle_9p_output(VirtIODevice *vdev, VirtQueue *vq);
 401 #endif