xref: /qemu/hw/vfio-user/proxy.h (revision c6ac52a4d8f7a7c03452454d36b60ac309f0b9ce)
1 #ifndef VFIO_USER_PROXY_H
2 #define VFIO_USER_PROXY_H
3 
4 /*
5  * vfio protocol over a UNIX socket.
6  *
7  * Copyright © 2018, 2021 Oracle and/or its affiliates.
8  *
9  * SPDX-License-Identifier: GPL-2.0-or-later
10  */
11 
12 #include "io/channel.h"
13 #include "io/channel-socket.h"
14 
15 #include "qemu/queue.h"
16 #include "qemu/sockets.h"
17 #include "qemu/thread.h"
18 #include "hw/vfio/vfio-device.h"
19 #include "hw/vfio-user/protocol.h"
20 
21 typedef struct {
22     int send_fds;
23     int recv_fds;
24     int *fds;
25 } VFIOUserFDs;
26 
27 enum msg_type {
28     VFIO_MSG_NONE,
29     VFIO_MSG_ASYNC,
30     VFIO_MSG_WAIT,
31     VFIO_MSG_NOWAIT,
32     VFIO_MSG_REQ,
33 };
34 
35 typedef struct VFIOUserMsg {
36     QTAILQ_ENTRY(VFIOUserMsg) next;
37     VFIOUserHdr *hdr;
38     VFIOUserFDs *fds;
39     uint32_t rsize;
40     uint32_t id;
41     QemuCond cv;
42     bool complete;
43     bool pending;
44     enum msg_type type;
45 } VFIOUserMsg;
46 
47 
48 enum proxy_state {
49     VFIO_PROXY_CONNECTED = 1,
50     VFIO_PROXY_ERROR = 2,
51     VFIO_PROXY_CLOSING = 3,
52     VFIO_PROXY_CLOSED = 4,
53 };
54 
55 typedef QTAILQ_HEAD(VFIOUserMsgQ, VFIOUserMsg) VFIOUserMsgQ;
56 
57 typedef struct VFIOUserProxy {
58     QLIST_ENTRY(VFIOUserProxy) next;
59     char *sockname;
60     struct QIOChannel *ioc;
61     void (*request)(void *opaque, VFIOUserMsg *msg);
62     void *req_arg;
63     uint64_t max_xfer_size;
64     uint64_t max_send_fds;
65     uint64_t max_dma;
66     uint64_t dma_pgsizes;
67     uint64_t max_bitmap;
68     uint64_t migr_pgsize;
69     int flags;
70     QemuCond close_cv;
71     AioContext *ctx;
72     QEMUBH *req_bh;
73     bool async_ops;
74 
75     /*
76      * above only changed when BQL is held
77      * below are protected by per-proxy lock
78      */
79     QemuMutex lock;
80     VFIOUserMsgQ free;
81     VFIOUserMsgQ pending;
82     VFIOUserMsgQ incoming;
83     VFIOUserMsgQ outgoing;
84     VFIOUserMsg *last_nowait;
85     VFIOUserMsg *part_recv;
86     size_t recv_left;
87     enum proxy_state state;
88 } VFIOUserProxy;
89 
90 /* VFIOProxy flags */
91 #define VFIO_PROXY_CLIENT        0x1
92 #define VFIO_PROXY_FORCE_QUEUED  0x4
93 
94 typedef struct VFIODevice VFIODevice;
95 
96 VFIOUserProxy *vfio_user_connect_dev(SocketAddress *addr, Error **errp);
97 void vfio_user_disconnect(VFIOUserProxy *proxy);
98 void vfio_user_set_handler(VFIODevice *vbasedev,
99                            void (*handler)(void *opaque, VFIOUserMsg *msg),
100                            void *reqarg);
101 bool vfio_user_validate_version(VFIOUserProxy *proxy, Error **errp);
102 
103 VFIOUserFDs *vfio_user_getfds(int numfds);
104 void vfio_user_putfds(VFIOUserMsg *msg);
105 
106 void vfio_user_request_msg(VFIOUserHdr *hdr, uint16_t cmd,
107                            uint32_t size, uint32_t flags);
108 void vfio_user_wait_reqs(VFIOUserProxy *proxy);
109 bool vfio_user_send_wait(VFIOUserProxy *proxy, VFIOUserHdr *hdr,
110                          VFIOUserFDs *fds, int rsize, Error **errp);
111 bool vfio_user_send_nowait(VFIOUserProxy *proxy, VFIOUserHdr *hdr,
112                            VFIOUserFDs *fds, int rsize, Error **errp);
113 void vfio_user_send_reply(VFIOUserProxy *proxy, VFIOUserHdr *hdr, int size);
114 void vfio_user_send_error(VFIOUserProxy *proxy, VFIOUserHdr *hdr, int error);
115 
116 #endif /* VFIO_USER_PROXY_H */
117