root / hw / virtio.c @ 75b0646f
History | View | Annotate | Download (25.1 kB)
1 | 967f97fa | aliguori | /*
|
---|---|---|---|
2 | 967f97fa | aliguori | * Virtio Support
|
3 | 967f97fa | aliguori | *
|
4 | 967f97fa | aliguori | * Copyright IBM, Corp. 2007
|
5 | 967f97fa | aliguori | *
|
6 | 967f97fa | aliguori | * Authors:
|
7 | 967f97fa | aliguori | * Anthony Liguori <aliguori@us.ibm.com>
|
8 | 967f97fa | aliguori | *
|
9 | 967f97fa | aliguori | * This work is licensed under the terms of the GNU GPL, version 2. See
|
10 | 967f97fa | aliguori | * the COPYING file in the top-level directory.
|
11 | 967f97fa | aliguori | *
|
12 | 967f97fa | aliguori | */
|
13 | 967f97fa | aliguori | |
14 | 967f97fa | aliguori | #include <inttypes.h> |
15 | 967f97fa | aliguori | |
16 | 64979a4d | Stefan Hajnoczi | #include "trace.h" |
17 | ce67ed65 | Stefan Hajnoczi | #include "qemu-error.h" |
18 | 967f97fa | aliguori | #include "virtio.h" |
19 | 967f97fa | aliguori | |
20 | f46f15bc | aliguori | /* The alignment to use between consumer and producer parts of vring.
|
21 | f46f15bc | aliguori | * x86 pagesize again. */
|
22 | f46f15bc | aliguori | #define VIRTIO_PCI_VRING_ALIGN 4096 |
23 | f46f15bc | aliguori | |
24 | 967f97fa | aliguori | /* QEMU doesn't strictly need write barriers since everything runs in
|
25 | 967f97fa | aliguori | * lock-step. We'll leave the calls to wmb() in though to make it obvious for
|
26 | 967f97fa | aliguori | * KVM or if kqemu gets SMP support.
|
27 | 79758e95 | Michael S. Tsirkin | * In any case, we must prevent the compiler from reordering the code.
|
28 | 79758e95 | Michael S. Tsirkin | * TODO: we likely need some rmb()/mb() as well.
|
29 | 967f97fa | aliguori | */
|
30 | 79758e95 | Michael S. Tsirkin | |
31 | 79758e95 | Michael S. Tsirkin | #define wmb() __asm__ __volatile__("": : :"memory") |
32 | 967f97fa | aliguori | |
33 | 967f97fa | aliguori | typedef struct VRingDesc |
34 | 967f97fa | aliguori | { |
35 | 967f97fa | aliguori | uint64_t addr; |
36 | 967f97fa | aliguori | uint32_t len; |
37 | 967f97fa | aliguori | uint16_t flags; |
38 | 967f97fa | aliguori | uint16_t next; |
39 | 967f97fa | aliguori | } VRingDesc; |
40 | 967f97fa | aliguori | |
41 | 967f97fa | aliguori | typedef struct VRingAvail |
42 | 967f97fa | aliguori | { |
43 | 967f97fa | aliguori | uint16_t flags; |
44 | 967f97fa | aliguori | uint16_t idx; |
45 | 967f97fa | aliguori | uint16_t ring[0];
|
46 | 967f97fa | aliguori | } VRingAvail; |
47 | 967f97fa | aliguori | |
48 | 967f97fa | aliguori | typedef struct VRingUsedElem |
49 | 967f97fa | aliguori | { |
50 | 967f97fa | aliguori | uint32_t id; |
51 | 967f97fa | aliguori | uint32_t len; |
52 | 967f97fa | aliguori | } VRingUsedElem; |
53 | 967f97fa | aliguori | |
54 | 967f97fa | aliguori | typedef struct VRingUsed |
55 | 967f97fa | aliguori | { |
56 | 967f97fa | aliguori | uint16_t flags; |
57 | 967f97fa | aliguori | uint16_t idx; |
58 | 967f97fa | aliguori | VRingUsedElem ring[0];
|
59 | 967f97fa | aliguori | } VRingUsed; |
60 | 967f97fa | aliguori | |
61 | 967f97fa | aliguori | typedef struct VRing |
62 | 967f97fa | aliguori | { |
63 | 967f97fa | aliguori | unsigned int num; |
64 | c227f099 | Anthony Liguori | target_phys_addr_t desc; |
65 | c227f099 | Anthony Liguori | target_phys_addr_t avail; |
66 | c227f099 | Anthony Liguori | target_phys_addr_t used; |
67 | 967f97fa | aliguori | } VRing; |
68 | 967f97fa | aliguori | |
69 | 967f97fa | aliguori | struct VirtQueue
|
70 | 967f97fa | aliguori | { |
71 | 967f97fa | aliguori | VRing vring; |
72 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
73 | 967f97fa | aliguori | uint16_t last_avail_idx; |
74 | bcbabae8 | Michael S. Tsirkin | /* Last used index value we have signalled on */
|
75 | bcbabae8 | Michael S. Tsirkin | uint16_t signalled_used; |
76 | bcbabae8 | Michael S. Tsirkin | |
77 | bcbabae8 | Michael S. Tsirkin | /* Last used index value we have signalled on */
|
78 | bcbabae8 | Michael S. Tsirkin | bool signalled_used_valid;
|
79 | bcbabae8 | Michael S. Tsirkin | |
80 | bcbabae8 | Michael S. Tsirkin | /* Notification enabled? */
|
81 | bcbabae8 | Michael S. Tsirkin | bool notification;
|
82 | bcbabae8 | Michael S. Tsirkin | |
83 | 967f97fa | aliguori | int inuse;
|
84 | bcbabae8 | Michael S. Tsirkin | |
85 | 7055e687 | Michael S. Tsirkin | uint16_t vector; |
86 | 967f97fa | aliguori | void (*handle_output)(VirtIODevice *vdev, VirtQueue *vq);
|
87 | 1cbdabe2 | Michael S. Tsirkin | VirtIODevice *vdev; |
88 | 1cbdabe2 | Michael S. Tsirkin | EventNotifier guest_notifier; |
89 | 1cbdabe2 | Michael S. Tsirkin | EventNotifier host_notifier; |
90 | 967f97fa | aliguori | }; |
91 | 967f97fa | aliguori | |
92 | 967f97fa | aliguori | /* virt queue functions */
|
93 | 53c25cea | Paul Brook | static void virtqueue_init(VirtQueue *vq) |
94 | 967f97fa | aliguori | { |
95 | c227f099 | Anthony Liguori | target_phys_addr_t pa = vq->pa; |
96 | 53c25cea | Paul Brook | |
97 | 967f97fa | aliguori | vq->vring.desc = pa; |
98 | 967f97fa | aliguori | vq->vring.avail = pa + vq->vring.num * sizeof(VRingDesc);
|
99 | f46f15bc | aliguori | vq->vring.used = vring_align(vq->vring.avail + |
100 | f46f15bc | aliguori | offsetof(VRingAvail, ring[vq->vring.num]), |
101 | f46f15bc | aliguori | VIRTIO_PCI_VRING_ALIGN); |
102 | 967f97fa | aliguori | } |
103 | 967f97fa | aliguori | |
104 | c227f099 | Anthony Liguori | static inline uint64_t vring_desc_addr(target_phys_addr_t desc_pa, int i) |
105 | 967f97fa | aliguori | { |
106 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
107 | 5774cf98 | Mark McLoughlin | pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, addr);
|
108 | 967f97fa | aliguori | return ldq_phys(pa);
|
109 | 967f97fa | aliguori | } |
110 | 967f97fa | aliguori | |
111 | c227f099 | Anthony Liguori | static inline uint32_t vring_desc_len(target_phys_addr_t desc_pa, int i) |
112 | 967f97fa | aliguori | { |
113 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
114 | 5774cf98 | Mark McLoughlin | pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, len);
|
115 | 967f97fa | aliguori | return ldl_phys(pa);
|
116 | 967f97fa | aliguori | } |
117 | 967f97fa | aliguori | |
118 | c227f099 | Anthony Liguori | static inline uint16_t vring_desc_flags(target_phys_addr_t desc_pa, int i) |
119 | 967f97fa | aliguori | { |
120 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
121 | 5774cf98 | Mark McLoughlin | pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, flags);
|
122 | 967f97fa | aliguori | return lduw_phys(pa);
|
123 | 967f97fa | aliguori | } |
124 | 967f97fa | aliguori | |
125 | c227f099 | Anthony Liguori | static inline uint16_t vring_desc_next(target_phys_addr_t desc_pa, int i) |
126 | 967f97fa | aliguori | { |
127 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
128 | 5774cf98 | Mark McLoughlin | pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, next);
|
129 | 967f97fa | aliguori | return lduw_phys(pa);
|
130 | 967f97fa | aliguori | } |
131 | 967f97fa | aliguori | |
132 | 967f97fa | aliguori | static inline uint16_t vring_avail_flags(VirtQueue *vq) |
133 | 967f97fa | aliguori | { |
134 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
135 | 967f97fa | aliguori | pa = vq->vring.avail + offsetof(VRingAvail, flags); |
136 | 967f97fa | aliguori | return lduw_phys(pa);
|
137 | 967f97fa | aliguori | } |
138 | 967f97fa | aliguori | |
139 | 967f97fa | aliguori | static inline uint16_t vring_avail_idx(VirtQueue *vq) |
140 | 967f97fa | aliguori | { |
141 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
142 | 967f97fa | aliguori | pa = vq->vring.avail + offsetof(VRingAvail, idx); |
143 | 967f97fa | aliguori | return lduw_phys(pa);
|
144 | 967f97fa | aliguori | } |
145 | 967f97fa | aliguori | |
146 | 967f97fa | aliguori | static inline uint16_t vring_avail_ring(VirtQueue *vq, int i) |
147 | 967f97fa | aliguori | { |
148 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
149 | 967f97fa | aliguori | pa = vq->vring.avail + offsetof(VRingAvail, ring[i]); |
150 | 967f97fa | aliguori | return lduw_phys(pa);
|
151 | 967f97fa | aliguori | } |
152 | 967f97fa | aliguori | |
153 | bcbabae8 | Michael S. Tsirkin | static inline uint16_t vring_used_event(VirtQueue *vq) |
154 | bcbabae8 | Michael S. Tsirkin | { |
155 | bcbabae8 | Michael S. Tsirkin | return vring_avail_ring(vq, vq->vring.num);
|
156 | bcbabae8 | Michael S. Tsirkin | } |
157 | bcbabae8 | Michael S. Tsirkin | |
158 | 967f97fa | aliguori | static inline void vring_used_ring_id(VirtQueue *vq, int i, uint32_t val) |
159 | 967f97fa | aliguori | { |
160 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
161 | 967f97fa | aliguori | pa = vq->vring.used + offsetof(VRingUsed, ring[i].id); |
162 | 967f97fa | aliguori | stl_phys(pa, val); |
163 | 967f97fa | aliguori | } |
164 | 967f97fa | aliguori | |
165 | 967f97fa | aliguori | static inline void vring_used_ring_len(VirtQueue *vq, int i, uint32_t val) |
166 | 967f97fa | aliguori | { |
167 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
168 | 967f97fa | aliguori | pa = vq->vring.used + offsetof(VRingUsed, ring[i].len); |
169 | 967f97fa | aliguori | stl_phys(pa, val); |
170 | 967f97fa | aliguori | } |
171 | 967f97fa | aliguori | |
172 | 967f97fa | aliguori | static uint16_t vring_used_idx(VirtQueue *vq)
|
173 | 967f97fa | aliguori | { |
174 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
175 | 967f97fa | aliguori | pa = vq->vring.used + offsetof(VRingUsed, idx); |
176 | 967f97fa | aliguori | return lduw_phys(pa);
|
177 | 967f97fa | aliguori | } |
178 | 967f97fa | aliguori | |
179 | bcbabae8 | Michael S. Tsirkin | static inline void vring_used_idx_set(VirtQueue *vq, uint16_t val) |
180 | 967f97fa | aliguori | { |
181 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
182 | 967f97fa | aliguori | pa = vq->vring.used + offsetof(VRingUsed, idx); |
183 | bcbabae8 | Michael S. Tsirkin | stw_phys(pa, val); |
184 | 967f97fa | aliguori | } |
185 | 967f97fa | aliguori | |
186 | 967f97fa | aliguori | static inline void vring_used_flags_set_bit(VirtQueue *vq, int mask) |
187 | 967f97fa | aliguori | { |
188 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
189 | 967f97fa | aliguori | pa = vq->vring.used + offsetof(VRingUsed, flags); |
190 | 967f97fa | aliguori | stw_phys(pa, lduw_phys(pa) | mask); |
191 | 967f97fa | aliguori | } |
192 | 967f97fa | aliguori | |
193 | 967f97fa | aliguori | static inline void vring_used_flags_unset_bit(VirtQueue *vq, int mask) |
194 | 967f97fa | aliguori | { |
195 | c227f099 | Anthony Liguori | target_phys_addr_t pa; |
196 | 967f97fa | aliguori | pa = vq->vring.used + offsetof(VRingUsed, flags); |
197 | 967f97fa | aliguori | stw_phys(pa, lduw_phys(pa) & ~mask); |
198 | 967f97fa | aliguori | } |
199 | 967f97fa | aliguori | |
200 | bcbabae8 | Michael S. Tsirkin | static inline void vring_avail_event(VirtQueue *vq, uint16_t val) |
201 | bcbabae8 | Michael S. Tsirkin | { |
202 | bcbabae8 | Michael S. Tsirkin | target_phys_addr_t pa; |
203 | bcbabae8 | Michael S. Tsirkin | if (!vq->notification) {
|
204 | bcbabae8 | Michael S. Tsirkin | return;
|
205 | bcbabae8 | Michael S. Tsirkin | } |
206 | bcbabae8 | Michael S. Tsirkin | pa = vq->vring.used + offsetof(VRingUsed, ring[vq->vring.num]); |
207 | bcbabae8 | Michael S. Tsirkin | stw_phys(pa, val); |
208 | bcbabae8 | Michael S. Tsirkin | } |
209 | bcbabae8 | Michael S. Tsirkin | |
210 | 967f97fa | aliguori | void virtio_queue_set_notification(VirtQueue *vq, int enable) |
211 | 967f97fa | aliguori | { |
212 | bcbabae8 | Michael S. Tsirkin | vq->notification = enable; |
213 | bcbabae8 | Michael S. Tsirkin | if (vq->vdev->guest_features & (1 << VIRTIO_RING_F_EVENT_IDX)) { |
214 | bcbabae8 | Michael S. Tsirkin | vring_avail_event(vq, vring_avail_idx(vq)); |
215 | bcbabae8 | Michael S. Tsirkin | } else if (enable) { |
216 | 967f97fa | aliguori | vring_used_flags_unset_bit(vq, VRING_USED_F_NO_NOTIFY); |
217 | bcbabae8 | Michael S. Tsirkin | } else {
|
218 | 967f97fa | aliguori | vring_used_flags_set_bit(vq, VRING_USED_F_NO_NOTIFY); |
219 | bcbabae8 | Michael S. Tsirkin | } |
220 | 967f97fa | aliguori | } |
221 | 967f97fa | aliguori | |
222 | 967f97fa | aliguori | int virtio_queue_ready(VirtQueue *vq)
|
223 | 967f97fa | aliguori | { |
224 | 967f97fa | aliguori | return vq->vring.avail != 0; |
225 | 967f97fa | aliguori | } |
226 | 967f97fa | aliguori | |
227 | 967f97fa | aliguori | int virtio_queue_empty(VirtQueue *vq)
|
228 | 967f97fa | aliguori | { |
229 | 967f97fa | aliguori | return vring_avail_idx(vq) == vq->last_avail_idx;
|
230 | 967f97fa | aliguori | } |
231 | 967f97fa | aliguori | |
232 | 967f97fa | aliguori | void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, |
233 | 967f97fa | aliguori | unsigned int len, unsigned int idx) |
234 | 967f97fa | aliguori | { |
235 | 967f97fa | aliguori | unsigned int offset; |
236 | 967f97fa | aliguori | int i;
|
237 | 967f97fa | aliguori | |
238 | 64979a4d | Stefan Hajnoczi | trace_virtqueue_fill(vq, elem, len, idx); |
239 | 64979a4d | Stefan Hajnoczi | |
240 | 967f97fa | aliguori | offset = 0;
|
241 | 967f97fa | aliguori | for (i = 0; i < elem->in_num; i++) { |
242 | 967f97fa | aliguori | size_t size = MIN(len - offset, elem->in_sg[i].iov_len); |
243 | 967f97fa | aliguori | |
244 | 26b258e1 | aliguori | cpu_physical_memory_unmap(elem->in_sg[i].iov_base, |
245 | 26b258e1 | aliguori | elem->in_sg[i].iov_len, |
246 | 26b258e1 | aliguori | 1, size);
|
247 | 967f97fa | aliguori | |
248 | 26b258e1 | aliguori | offset += elem->in_sg[i].iov_len; |
249 | 967f97fa | aliguori | } |
250 | 967f97fa | aliguori | |
251 | 26b258e1 | aliguori | for (i = 0; i < elem->out_num; i++) |
252 | 26b258e1 | aliguori | cpu_physical_memory_unmap(elem->out_sg[i].iov_base, |
253 | 26b258e1 | aliguori | elem->out_sg[i].iov_len, |
254 | 26b258e1 | aliguori | 0, elem->out_sg[i].iov_len);
|
255 | 26b258e1 | aliguori | |
256 | 967f97fa | aliguori | idx = (idx + vring_used_idx(vq)) % vq->vring.num; |
257 | 967f97fa | aliguori | |
258 | 967f97fa | aliguori | /* Get a pointer to the next entry in the used ring. */
|
259 | 967f97fa | aliguori | vring_used_ring_id(vq, idx, elem->index); |
260 | 967f97fa | aliguori | vring_used_ring_len(vq, idx, len); |
261 | 967f97fa | aliguori | } |
262 | 967f97fa | aliguori | |
263 | 967f97fa | aliguori | void virtqueue_flush(VirtQueue *vq, unsigned int count) |
264 | 967f97fa | aliguori | { |
265 | bcbabae8 | Michael S. Tsirkin | uint16_t old, new; |
266 | 967f97fa | aliguori | /* Make sure buffer is written before we update index. */
|
267 | 967f97fa | aliguori | wmb(); |
268 | 64979a4d | Stefan Hajnoczi | trace_virtqueue_flush(vq, count); |
269 | bcbabae8 | Michael S. Tsirkin | old = vring_used_idx(vq); |
270 | bcbabae8 | Michael S. Tsirkin | new = old + count; |
271 | bcbabae8 | Michael S. Tsirkin | vring_used_idx_set(vq, new); |
272 | 967f97fa | aliguori | vq->inuse -= count; |
273 | bcbabae8 | Michael S. Tsirkin | if (unlikely((int16_t)(new - vq->signalled_used) < (uint16_t)(new - old)))
|
274 | bcbabae8 | Michael S. Tsirkin | vq->signalled_used_valid = false;
|
275 | 967f97fa | aliguori | } |
276 | 967f97fa | aliguori | |
277 | 967f97fa | aliguori | void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, |
278 | 967f97fa | aliguori | unsigned int len) |
279 | 967f97fa | aliguori | { |
280 | 967f97fa | aliguori | virtqueue_fill(vq, elem, len, 0);
|
281 | 967f97fa | aliguori | virtqueue_flush(vq, 1);
|
282 | 967f97fa | aliguori | } |
283 | 967f97fa | aliguori | |
284 | 967f97fa | aliguori | static int virtqueue_num_heads(VirtQueue *vq, unsigned int idx) |
285 | 967f97fa | aliguori | { |
286 | 967f97fa | aliguori | uint16_t num_heads = vring_avail_idx(vq) - idx; |
287 | 967f97fa | aliguori | |
288 | 967f97fa | aliguori | /* Check it isn't doing very strange things with descriptor numbers. */
|
289 | bb6834cf | aliguori | if (num_heads > vq->vring.num) {
|
290 | ce67ed65 | Stefan Hajnoczi | error_report("Guest moved used index from %u to %u",
|
291 | ce67ed65 | Stefan Hajnoczi | idx, vring_avail_idx(vq)); |
292 | bb6834cf | aliguori | exit(1);
|
293 | bb6834cf | aliguori | } |
294 | 967f97fa | aliguori | |
295 | 967f97fa | aliguori | return num_heads;
|
296 | 967f97fa | aliguori | } |
297 | 967f97fa | aliguori | |
298 | 967f97fa | aliguori | static unsigned int virtqueue_get_head(VirtQueue *vq, unsigned int idx) |
299 | 967f97fa | aliguori | { |
300 | 967f97fa | aliguori | unsigned int head; |
301 | 967f97fa | aliguori | |
302 | 967f97fa | aliguori | /* Grab the next descriptor number they're advertising, and increment
|
303 | 967f97fa | aliguori | * the index we've seen. */
|
304 | 967f97fa | aliguori | head = vring_avail_ring(vq, idx % vq->vring.num); |
305 | 967f97fa | aliguori | |
306 | 967f97fa | aliguori | /* If their number is silly, that's a fatal mistake. */
|
307 | bb6834cf | aliguori | if (head >= vq->vring.num) {
|
308 | ce67ed65 | Stefan Hajnoczi | error_report("Guest says index %u is available", head);
|
309 | bb6834cf | aliguori | exit(1);
|
310 | bb6834cf | aliguori | } |
311 | 967f97fa | aliguori | |
312 | 967f97fa | aliguori | return head;
|
313 | 967f97fa | aliguori | } |
314 | 967f97fa | aliguori | |
315 | c227f099 | Anthony Liguori | static unsigned virtqueue_next_desc(target_phys_addr_t desc_pa, |
316 | 5774cf98 | Mark McLoughlin | unsigned int i, unsigned int max) |
317 | 967f97fa | aliguori | { |
318 | 967f97fa | aliguori | unsigned int next; |
319 | 967f97fa | aliguori | |
320 | 967f97fa | aliguori | /* If this descriptor says it doesn't chain, we're done. */
|
321 | 5774cf98 | Mark McLoughlin | if (!(vring_desc_flags(desc_pa, i) & VRING_DESC_F_NEXT))
|
322 | 5774cf98 | Mark McLoughlin | return max;
|
323 | 967f97fa | aliguori | |
324 | 967f97fa | aliguori | /* Check they're not leading us off end of descriptors. */
|
325 | 5774cf98 | Mark McLoughlin | next = vring_desc_next(desc_pa, i); |
326 | 967f97fa | aliguori | /* Make sure compiler knows to grab that: we don't want it changing! */
|
327 | 967f97fa | aliguori | wmb(); |
328 | 967f97fa | aliguori | |
329 | 5774cf98 | Mark McLoughlin | if (next >= max) {
|
330 | ce67ed65 | Stefan Hajnoczi | error_report("Desc next is %u", next);
|
331 | bb6834cf | aliguori | exit(1);
|
332 | bb6834cf | aliguori | } |
333 | 967f97fa | aliguori | |
334 | 967f97fa | aliguori | return next;
|
335 | 967f97fa | aliguori | } |
336 | 967f97fa | aliguori | |
337 | 967f97fa | aliguori | int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes) |
338 | 967f97fa | aliguori | { |
339 | efeea6d0 | Mark McLoughlin | unsigned int idx; |
340 | efeea6d0 | Mark McLoughlin | int total_bufs, in_total, out_total;
|
341 | 967f97fa | aliguori | |
342 | 967f97fa | aliguori | idx = vq->last_avail_idx; |
343 | 967f97fa | aliguori | |
344 | efeea6d0 | Mark McLoughlin | total_bufs = in_total = out_total = 0;
|
345 | 967f97fa | aliguori | while (virtqueue_num_heads(vq, idx)) {
|
346 | efeea6d0 | Mark McLoughlin | unsigned int max, num_bufs, indirect = 0; |
347 | c227f099 | Anthony Liguori | target_phys_addr_t desc_pa; |
348 | 967f97fa | aliguori | int i;
|
349 | 967f97fa | aliguori | |
350 | efeea6d0 | Mark McLoughlin | max = vq->vring.num; |
351 | efeea6d0 | Mark McLoughlin | num_bufs = total_bufs; |
352 | 967f97fa | aliguori | i = virtqueue_get_head(vq, idx++); |
353 | efeea6d0 | Mark McLoughlin | desc_pa = vq->vring.desc; |
354 | efeea6d0 | Mark McLoughlin | |
355 | efeea6d0 | Mark McLoughlin | if (vring_desc_flags(desc_pa, i) & VRING_DESC_F_INDIRECT) {
|
356 | efeea6d0 | Mark McLoughlin | if (vring_desc_len(desc_pa, i) % sizeof(VRingDesc)) { |
357 | ce67ed65 | Stefan Hajnoczi | error_report("Invalid size for indirect buffer table");
|
358 | efeea6d0 | Mark McLoughlin | exit(1);
|
359 | efeea6d0 | Mark McLoughlin | } |
360 | efeea6d0 | Mark McLoughlin | |
361 | efeea6d0 | Mark McLoughlin | /* If we've got too many, that implies a descriptor loop. */
|
362 | efeea6d0 | Mark McLoughlin | if (num_bufs >= max) {
|
363 | ce67ed65 | Stefan Hajnoczi | error_report("Looped descriptor");
|
364 | efeea6d0 | Mark McLoughlin | exit(1);
|
365 | efeea6d0 | Mark McLoughlin | } |
366 | efeea6d0 | Mark McLoughlin | |
367 | efeea6d0 | Mark McLoughlin | /* loop over the indirect descriptor table */
|
368 | efeea6d0 | Mark McLoughlin | indirect = 1;
|
369 | efeea6d0 | Mark McLoughlin | max = vring_desc_len(desc_pa, i) / sizeof(VRingDesc);
|
370 | efeea6d0 | Mark McLoughlin | num_bufs = i = 0;
|
371 | efeea6d0 | Mark McLoughlin | desc_pa = vring_desc_addr(desc_pa, i); |
372 | efeea6d0 | Mark McLoughlin | } |
373 | efeea6d0 | Mark McLoughlin | |
374 | 967f97fa | aliguori | do {
|
375 | 967f97fa | aliguori | /* If we've got too many, that implies a descriptor loop. */
|
376 | 5774cf98 | Mark McLoughlin | if (++num_bufs > max) {
|
377 | ce67ed65 | Stefan Hajnoczi | error_report("Looped descriptor");
|
378 | bb6834cf | aliguori | exit(1);
|
379 | bb6834cf | aliguori | } |
380 | 967f97fa | aliguori | |
381 | 5774cf98 | Mark McLoughlin | if (vring_desc_flags(desc_pa, i) & VRING_DESC_F_WRITE) {
|
382 | 967f97fa | aliguori | if (in_bytes > 0 && |
383 | 5774cf98 | Mark McLoughlin | (in_total += vring_desc_len(desc_pa, i)) >= in_bytes) |
384 | 967f97fa | aliguori | return 1; |
385 | 967f97fa | aliguori | } else {
|
386 | 967f97fa | aliguori | if (out_bytes > 0 && |
387 | 5774cf98 | Mark McLoughlin | (out_total += vring_desc_len(desc_pa, i)) >= out_bytes) |
388 | 967f97fa | aliguori | return 1; |
389 | 967f97fa | aliguori | } |
390 | 5774cf98 | Mark McLoughlin | } while ((i = virtqueue_next_desc(desc_pa, i, max)) != max);
|
391 | efeea6d0 | Mark McLoughlin | |
392 | efeea6d0 | Mark McLoughlin | if (!indirect)
|
393 | efeea6d0 | Mark McLoughlin | total_bufs = num_bufs; |
394 | efeea6d0 | Mark McLoughlin | else
|
395 | efeea6d0 | Mark McLoughlin | total_bufs++; |
396 | 967f97fa | aliguori | } |
397 | 967f97fa | aliguori | |
398 | 967f97fa | aliguori | return 0; |
399 | 967f97fa | aliguori | } |
400 | 967f97fa | aliguori | |
401 | 42fb2e07 | Kevin Wolf | void virtqueue_map_sg(struct iovec *sg, target_phys_addr_t *addr, |
402 | 42fb2e07 | Kevin Wolf | size_t num_sg, int is_write)
|
403 | 42fb2e07 | Kevin Wolf | { |
404 | 42fb2e07 | Kevin Wolf | unsigned int i; |
405 | 42fb2e07 | Kevin Wolf | target_phys_addr_t len; |
406 | 42fb2e07 | Kevin Wolf | |
407 | 42fb2e07 | Kevin Wolf | for (i = 0; i < num_sg; i++) { |
408 | 42fb2e07 | Kevin Wolf | len = sg[i].iov_len; |
409 | 42fb2e07 | Kevin Wolf | sg[i].iov_base = cpu_physical_memory_map(addr[i], &len, is_write); |
410 | 42fb2e07 | Kevin Wolf | if (sg[i].iov_base == NULL || len != sg[i].iov_len) { |
411 | ce67ed65 | Stefan Hajnoczi | error_report("virtio: trying to map MMIO memory");
|
412 | 42fb2e07 | Kevin Wolf | exit(1);
|
413 | 42fb2e07 | Kevin Wolf | } |
414 | 42fb2e07 | Kevin Wolf | } |
415 | 42fb2e07 | Kevin Wolf | } |
416 | 42fb2e07 | Kevin Wolf | |
417 | 967f97fa | aliguori | int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem)
|
418 | 967f97fa | aliguori | { |
419 | 5774cf98 | Mark McLoughlin | unsigned int i, head, max; |
420 | c227f099 | Anthony Liguori | target_phys_addr_t desc_pa = vq->vring.desc; |
421 | 967f97fa | aliguori | |
422 | 967f97fa | aliguori | if (!virtqueue_num_heads(vq, vq->last_avail_idx))
|
423 | 967f97fa | aliguori | return 0; |
424 | 967f97fa | aliguori | |
425 | 967f97fa | aliguori | /* When we start there are none of either input nor output. */
|
426 | 967f97fa | aliguori | elem->out_num = elem->in_num = 0;
|
427 | 967f97fa | aliguori | |
428 | 5774cf98 | Mark McLoughlin | max = vq->vring.num; |
429 | 5774cf98 | Mark McLoughlin | |
430 | 967f97fa | aliguori | i = head = virtqueue_get_head(vq, vq->last_avail_idx++); |
431 | bcbabae8 | Michael S. Tsirkin | if (vq->vdev->guest_features & (1 << VIRTIO_RING_F_EVENT_IDX)) { |
432 | bcbabae8 | Michael S. Tsirkin | vring_avail_event(vq, vring_avail_idx(vq)); |
433 | bcbabae8 | Michael S. Tsirkin | } |
434 | efeea6d0 | Mark McLoughlin | |
435 | efeea6d0 | Mark McLoughlin | if (vring_desc_flags(desc_pa, i) & VRING_DESC_F_INDIRECT) {
|
436 | efeea6d0 | Mark McLoughlin | if (vring_desc_len(desc_pa, i) % sizeof(VRingDesc)) { |
437 | ce67ed65 | Stefan Hajnoczi | error_report("Invalid size for indirect buffer table");
|
438 | efeea6d0 | Mark McLoughlin | exit(1);
|
439 | efeea6d0 | Mark McLoughlin | } |
440 | efeea6d0 | Mark McLoughlin | |
441 | efeea6d0 | Mark McLoughlin | /* loop over the indirect descriptor table */
|
442 | efeea6d0 | Mark McLoughlin | max = vring_desc_len(desc_pa, i) / sizeof(VRingDesc);
|
443 | efeea6d0 | Mark McLoughlin | desc_pa = vring_desc_addr(desc_pa, i); |
444 | efeea6d0 | Mark McLoughlin | i = 0;
|
445 | efeea6d0 | Mark McLoughlin | } |
446 | efeea6d0 | Mark McLoughlin | |
447 | 42fb2e07 | Kevin Wolf | /* Collect all the descriptors */
|
448 | 967f97fa | aliguori | do {
|
449 | 967f97fa | aliguori | struct iovec *sg;
|
450 | 967f97fa | aliguori | |
451 | 5774cf98 | Mark McLoughlin | if (vring_desc_flags(desc_pa, i) & VRING_DESC_F_WRITE) {
|
452 | 5774cf98 | Mark McLoughlin | elem->in_addr[elem->in_num] = vring_desc_addr(desc_pa, i); |
453 | 967f97fa | aliguori | sg = &elem->in_sg[elem->in_num++]; |
454 | 42fb2e07 | Kevin Wolf | } else {
|
455 | 42fb2e07 | Kevin Wolf | elem->out_addr[elem->out_num] = vring_desc_addr(desc_pa, i); |
456 | 967f97fa | aliguori | sg = &elem->out_sg[elem->out_num++]; |
457 | 42fb2e07 | Kevin Wolf | } |
458 | 967f97fa | aliguori | |
459 | 5774cf98 | Mark McLoughlin | sg->iov_len = vring_desc_len(desc_pa, i); |
460 | 967f97fa | aliguori | |
461 | 967f97fa | aliguori | /* If we've got too many, that implies a descriptor loop. */
|
462 | 5774cf98 | Mark McLoughlin | if ((elem->in_num + elem->out_num) > max) {
|
463 | ce67ed65 | Stefan Hajnoczi | error_report("Looped descriptor");
|
464 | bb6834cf | aliguori | exit(1);
|
465 | bb6834cf | aliguori | } |
466 | 5774cf98 | Mark McLoughlin | } while ((i = virtqueue_next_desc(desc_pa, i, max)) != max);
|
467 | 967f97fa | aliguori | |
468 | 42fb2e07 | Kevin Wolf | /* Now map what we have collected */
|
469 | 42fb2e07 | Kevin Wolf | virtqueue_map_sg(elem->in_sg, elem->in_addr, elem->in_num, 1);
|
470 | 42fb2e07 | Kevin Wolf | virtqueue_map_sg(elem->out_sg, elem->out_addr, elem->out_num, 0);
|
471 | 42fb2e07 | Kevin Wolf | |
472 | 967f97fa | aliguori | elem->index = head; |
473 | 967f97fa | aliguori | |
474 | 967f97fa | aliguori | vq->inuse++; |
475 | 967f97fa | aliguori | |
476 | 64979a4d | Stefan Hajnoczi | trace_virtqueue_pop(vq, elem, elem->in_num, elem->out_num); |
477 | 967f97fa | aliguori | return elem->in_num + elem->out_num;
|
478 | 967f97fa | aliguori | } |
479 | 967f97fa | aliguori | |
480 | 967f97fa | aliguori | /* virtio device */
|
481 | 7055e687 | Michael S. Tsirkin | static void virtio_notify_vector(VirtIODevice *vdev, uint16_t vector) |
482 | 7055e687 | Michael S. Tsirkin | { |
483 | 7055e687 | Michael S. Tsirkin | if (vdev->binding->notify) {
|
484 | 7055e687 | Michael S. Tsirkin | vdev->binding->notify(vdev->binding_opaque, vector); |
485 | 7055e687 | Michael S. Tsirkin | } |
486 | 7055e687 | Michael S. Tsirkin | } |
487 | 967f97fa | aliguori | |
488 | 53c25cea | Paul Brook | void virtio_update_irq(VirtIODevice *vdev)
|
489 | 967f97fa | aliguori | { |
490 | 7055e687 | Michael S. Tsirkin | virtio_notify_vector(vdev, VIRTIO_NO_VECTOR); |
491 | 967f97fa | aliguori | } |
492 | 967f97fa | aliguori | |
493 | 53c25cea | Paul Brook | void virtio_reset(void *opaque) |
494 | 967f97fa | aliguori | { |
495 | 967f97fa | aliguori | VirtIODevice *vdev = opaque; |
496 | 967f97fa | aliguori | int i;
|
497 | 967f97fa | aliguori | |
498 | e0c472d8 | Michael S. Tsirkin | virtio_set_status(vdev, 0);
|
499 | e0c472d8 | Michael S. Tsirkin | |
500 | 967f97fa | aliguori | if (vdev->reset)
|
501 | 967f97fa | aliguori | vdev->reset(vdev); |
502 | 967f97fa | aliguori | |
503 | 704a76fc | Michael S. Tsirkin | vdev->guest_features = 0;
|
504 | 967f97fa | aliguori | vdev->queue_sel = 0;
|
505 | 967f97fa | aliguori | vdev->status = 0;
|
506 | 967f97fa | aliguori | vdev->isr = 0;
|
507 | 7055e687 | Michael S. Tsirkin | vdev->config_vector = VIRTIO_NO_VECTOR; |
508 | 7055e687 | Michael S. Tsirkin | virtio_notify_vector(vdev, vdev->config_vector); |
509 | 967f97fa | aliguori | |
510 | 967f97fa | aliguori | for(i = 0; i < VIRTIO_PCI_QUEUE_MAX; i++) { |
511 | 967f97fa | aliguori | vdev->vq[i].vring.desc = 0;
|
512 | 967f97fa | aliguori | vdev->vq[i].vring.avail = 0;
|
513 | 967f97fa | aliguori | vdev->vq[i].vring.used = 0;
|
514 | 967f97fa | aliguori | vdev->vq[i].last_avail_idx = 0;
|
515 | 53c25cea | Paul Brook | vdev->vq[i].pa = 0;
|
516 | 7055e687 | Michael S. Tsirkin | vdev->vq[i].vector = VIRTIO_NO_VECTOR; |
517 | bcbabae8 | Michael S. Tsirkin | vdev->vq[i].signalled_used = 0;
|
518 | bcbabae8 | Michael S. Tsirkin | vdev->vq[i].signalled_used_valid = false;
|
519 | bcbabae8 | Michael S. Tsirkin | vdev->vq[i].notification = true;
|
520 | 967f97fa | aliguori | } |
521 | 967f97fa | aliguori | } |
522 | 967f97fa | aliguori | |
523 | 53c25cea | Paul Brook | uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr) |
524 | 967f97fa | aliguori | { |
525 | 967f97fa | aliguori | uint8_t val; |
526 | 967f97fa | aliguori | |
527 | 967f97fa | aliguori | vdev->get_config(vdev, vdev->config); |
528 | 967f97fa | aliguori | |
529 | 967f97fa | aliguori | if (addr > (vdev->config_len - sizeof(val))) |
530 | 967f97fa | aliguori | return (uint32_t)-1; |
531 | 967f97fa | aliguori | |
532 | 967f97fa | aliguori | memcpy(&val, vdev->config + addr, sizeof(val));
|
533 | 967f97fa | aliguori | return val;
|
534 | 967f97fa | aliguori | } |
535 | 967f97fa | aliguori | |
536 | 53c25cea | Paul Brook | uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr) |
537 | 967f97fa | aliguori | { |
538 | 967f97fa | aliguori | uint16_t val; |
539 | 967f97fa | aliguori | |
540 | 967f97fa | aliguori | vdev->get_config(vdev, vdev->config); |
541 | 967f97fa | aliguori | |
542 | 967f97fa | aliguori | if (addr > (vdev->config_len - sizeof(val))) |
543 | 967f97fa | aliguori | return (uint32_t)-1; |
544 | 967f97fa | aliguori | |
545 | 967f97fa | aliguori | memcpy(&val, vdev->config + addr, sizeof(val));
|
546 | 967f97fa | aliguori | return val;
|
547 | 967f97fa | aliguori | } |
548 | 967f97fa | aliguori | |
549 | 53c25cea | Paul Brook | uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr) |
550 | 967f97fa | aliguori | { |
551 | 967f97fa | aliguori | uint32_t val; |
552 | 967f97fa | aliguori | |
553 | 967f97fa | aliguori | vdev->get_config(vdev, vdev->config); |
554 | 967f97fa | aliguori | |
555 | 967f97fa | aliguori | if (addr > (vdev->config_len - sizeof(val))) |
556 | 967f97fa | aliguori | return (uint32_t)-1; |
557 | 967f97fa | aliguori | |
558 | 967f97fa | aliguori | memcpy(&val, vdev->config + addr, sizeof(val));
|
559 | 967f97fa | aliguori | return val;
|
560 | 967f97fa | aliguori | } |
561 | 967f97fa | aliguori | |
562 | 53c25cea | Paul Brook | void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data)
|
563 | 967f97fa | aliguori | { |
564 | 967f97fa | aliguori | uint8_t val = data; |
565 | 967f97fa | aliguori | |
566 | 967f97fa | aliguori | if (addr > (vdev->config_len - sizeof(val))) |
567 | 967f97fa | aliguori | return;
|
568 | 967f97fa | aliguori | |
569 | 967f97fa | aliguori | memcpy(vdev->config + addr, &val, sizeof(val));
|
570 | 967f97fa | aliguori | |
571 | 967f97fa | aliguori | if (vdev->set_config)
|
572 | 967f97fa | aliguori | vdev->set_config(vdev, vdev->config); |
573 | 967f97fa | aliguori | } |
574 | 967f97fa | aliguori | |
575 | 53c25cea | Paul Brook | void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data)
|
576 | 967f97fa | aliguori | { |
577 | 967f97fa | aliguori | uint16_t val = data; |
578 | 967f97fa | aliguori | |
579 | 967f97fa | aliguori | if (addr > (vdev->config_len - sizeof(val))) |
580 | 967f97fa | aliguori | return;
|
581 | 967f97fa | aliguori | |
582 | 967f97fa | aliguori | memcpy(vdev->config + addr, &val, sizeof(val));
|
583 | 967f97fa | aliguori | |
584 | 967f97fa | aliguori | if (vdev->set_config)
|
585 | 967f97fa | aliguori | vdev->set_config(vdev, vdev->config); |
586 | 967f97fa | aliguori | } |
587 | 967f97fa | aliguori | |
588 | 53c25cea | Paul Brook | void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data)
|
589 | 967f97fa | aliguori | { |
590 | 967f97fa | aliguori | uint32_t val = data; |
591 | 967f97fa | aliguori | |
592 | 967f97fa | aliguori | if (addr > (vdev->config_len - sizeof(val))) |
593 | 967f97fa | aliguori | return;
|
594 | 967f97fa | aliguori | |
595 | 967f97fa | aliguori | memcpy(vdev->config + addr, &val, sizeof(val));
|
596 | 967f97fa | aliguori | |
597 | 967f97fa | aliguori | if (vdev->set_config)
|
598 | 967f97fa | aliguori | vdev->set_config(vdev, vdev->config); |
599 | 967f97fa | aliguori | } |
600 | 967f97fa | aliguori | |
601 | c227f099 | Anthony Liguori | void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr) |
602 | 967f97fa | aliguori | { |
603 | 7055e687 | Michael S. Tsirkin | vdev->vq[n].pa = addr; |
604 | 7055e687 | Michael S. Tsirkin | virtqueue_init(&vdev->vq[n]); |
605 | 53c25cea | Paul Brook | } |
606 | 53c25cea | Paul Brook | |
607 | c227f099 | Anthony Liguori | target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n)
|
608 | 53c25cea | Paul Brook | { |
609 | 53c25cea | Paul Brook | return vdev->vq[n].pa;
|
610 | 53c25cea | Paul Brook | } |
611 | 53c25cea | Paul Brook | |
612 | 53c25cea | Paul Brook | int virtio_queue_get_num(VirtIODevice *vdev, int n) |
613 | 53c25cea | Paul Brook | { |
614 | 53c25cea | Paul Brook | return vdev->vq[n].vring.num;
|
615 | 53c25cea | Paul Brook | } |
616 | 967f97fa | aliguori | |
617 | 25db9ebe | Stefan Hajnoczi | void virtio_queue_notify_vq(VirtQueue *vq)
|
618 | 25db9ebe | Stefan Hajnoczi | { |
619 | 25db9ebe | Stefan Hajnoczi | if (vq->vring.desc) {
|
620 | 25db9ebe | Stefan Hajnoczi | VirtIODevice *vdev = vq->vdev; |
621 | 25db9ebe | Stefan Hajnoczi | trace_virtio_queue_notify(vdev, vq - vdev->vq, vq); |
622 | 25db9ebe | Stefan Hajnoczi | vq->handle_output(vdev, vq); |
623 | 25db9ebe | Stefan Hajnoczi | } |
624 | 25db9ebe | Stefan Hajnoczi | } |
625 | 25db9ebe | Stefan Hajnoczi | |
626 | 53c25cea | Paul Brook | void virtio_queue_notify(VirtIODevice *vdev, int n) |
627 | 53c25cea | Paul Brook | { |
628 | 7157e2e2 | Stefan Hajnoczi | virtio_queue_notify_vq(&vdev->vq[n]); |
629 | 967f97fa | aliguori | } |
630 | 967f97fa | aliguori | |
631 | 7055e687 | Michael S. Tsirkin | uint16_t virtio_queue_vector(VirtIODevice *vdev, int n)
|
632 | 7055e687 | Michael S. Tsirkin | { |
633 | 7055e687 | Michael S. Tsirkin | return n < VIRTIO_PCI_QUEUE_MAX ? vdev->vq[n].vector :
|
634 | 7055e687 | Michael S. Tsirkin | VIRTIO_NO_VECTOR; |
635 | 7055e687 | Michael S. Tsirkin | } |
636 | 7055e687 | Michael S. Tsirkin | |
637 | 7055e687 | Michael S. Tsirkin | void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector) |
638 | 7055e687 | Michael S. Tsirkin | { |
639 | 7055e687 | Michael S. Tsirkin | if (n < VIRTIO_PCI_QUEUE_MAX)
|
640 | 7055e687 | Michael S. Tsirkin | vdev->vq[n].vector = vector; |
641 | 7055e687 | Michael S. Tsirkin | } |
642 | 7055e687 | Michael S. Tsirkin | |
643 | 967f97fa | aliguori | VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
|
644 | 967f97fa | aliguori | void (*handle_output)(VirtIODevice *, VirtQueue *))
|
645 | 967f97fa | aliguori | { |
646 | 967f97fa | aliguori | int i;
|
647 | 967f97fa | aliguori | |
648 | 967f97fa | aliguori | for (i = 0; i < VIRTIO_PCI_QUEUE_MAX; i++) { |
649 | 967f97fa | aliguori | if (vdev->vq[i].vring.num == 0) |
650 | 967f97fa | aliguori | break;
|
651 | 967f97fa | aliguori | } |
652 | 967f97fa | aliguori | |
653 | 967f97fa | aliguori | if (i == VIRTIO_PCI_QUEUE_MAX || queue_size > VIRTQUEUE_MAX_SIZE)
|
654 | 967f97fa | aliguori | abort(); |
655 | 967f97fa | aliguori | |
656 | 967f97fa | aliguori | vdev->vq[i].vring.num = queue_size; |
657 | 967f97fa | aliguori | vdev->vq[i].handle_output = handle_output; |
658 | 967f97fa | aliguori | |
659 | 967f97fa | aliguori | return &vdev->vq[i];
|
660 | 967f97fa | aliguori | } |
661 | 967f97fa | aliguori | |
662 | 1cbdabe2 | Michael S. Tsirkin | void virtio_irq(VirtQueue *vq)
|
663 | 1cbdabe2 | Michael S. Tsirkin | { |
664 | 64979a4d | Stefan Hajnoczi | trace_virtio_irq(vq); |
665 | 1cbdabe2 | Michael S. Tsirkin | vq->vdev->isr |= 0x01;
|
666 | 1cbdabe2 | Michael S. Tsirkin | virtio_notify_vector(vq->vdev, vq->vector); |
667 | 1cbdabe2 | Michael S. Tsirkin | } |
668 | 1cbdabe2 | Michael S. Tsirkin | |
669 | bcbabae8 | Michael S. Tsirkin | /* Assuming a given event_idx value from the other size, if
|
670 | bcbabae8 | Michael S. Tsirkin | * we have just incremented index from old to new_idx,
|
671 | bcbabae8 | Michael S. Tsirkin | * should we trigger an event? */
|
672 | bcbabae8 | Michael S. Tsirkin | static inline int vring_need_event(uint16_t event, uint16_t new, uint16_t old) |
673 | 967f97fa | aliguori | { |
674 | bcbabae8 | Michael S. Tsirkin | /* Note: Xen has similar logic for notification hold-off
|
675 | bcbabae8 | Michael S. Tsirkin | * in include/xen/interface/io/ring.h with req_event and req_prod
|
676 | bcbabae8 | Michael S. Tsirkin | * corresponding to event_idx + 1 and new respectively.
|
677 | bcbabae8 | Michael S. Tsirkin | * Note also that req_event and req_prod in Xen start at 1,
|
678 | bcbabae8 | Michael S. Tsirkin | * event indexes in virtio start at 0. */
|
679 | bcbabae8 | Michael S. Tsirkin | return (uint16_t)(new - event - 1) < (uint16_t)(new - old); |
680 | bcbabae8 | Michael S. Tsirkin | } |
681 | bcbabae8 | Michael S. Tsirkin | |
682 | bcbabae8 | Michael S. Tsirkin | static bool vring_notify(VirtIODevice *vdev, VirtQueue *vq) |
683 | bcbabae8 | Michael S. Tsirkin | { |
684 | bcbabae8 | Michael S. Tsirkin | uint16_t old, new; |
685 | bcbabae8 | Michael S. Tsirkin | bool v;
|
686 | 97b83deb | aliguori | /* Always notify when queue is empty (when feature acknowledge) */
|
687 | bcbabae8 | Michael S. Tsirkin | if (((vdev->guest_features & (1 << VIRTIO_F_NOTIFY_ON_EMPTY)) && |
688 | bcbabae8 | Michael S. Tsirkin | !vq->inuse && vring_avail_idx(vq) == vq->last_avail_idx)) { |
689 | bcbabae8 | Michael S. Tsirkin | return true; |
690 | bcbabae8 | Michael S. Tsirkin | } |
691 | bcbabae8 | Michael S. Tsirkin | |
692 | bcbabae8 | Michael S. Tsirkin | if (!(vdev->guest_features & (1 << VIRTIO_RING_F_EVENT_IDX))) { |
693 | bcbabae8 | Michael S. Tsirkin | return !(vring_avail_flags(vq) & VRING_AVAIL_F_NO_INTERRUPT);
|
694 | bcbabae8 | Michael S. Tsirkin | } |
695 | bcbabae8 | Michael S. Tsirkin | |
696 | bcbabae8 | Michael S. Tsirkin | v = vq->signalled_used_valid; |
697 | bcbabae8 | Michael S. Tsirkin | vq->signalled_used_valid = true;
|
698 | bcbabae8 | Michael S. Tsirkin | old = vq->signalled_used; |
699 | bcbabae8 | Michael S. Tsirkin | new = vq->signalled_used = vring_used_idx(vq); |
700 | bcbabae8 | Michael S. Tsirkin | return !v || vring_need_event(vring_used_event(vq), new, old);
|
701 | bcbabae8 | Michael S. Tsirkin | } |
702 | bcbabae8 | Michael S. Tsirkin | |
703 | bcbabae8 | Michael S. Tsirkin | void virtio_notify(VirtIODevice *vdev, VirtQueue *vq)
|
704 | bcbabae8 | Michael S. Tsirkin | { |
705 | bcbabae8 | Michael S. Tsirkin | if (!vring_notify(vdev, vq)) {
|
706 | 967f97fa | aliguori | return;
|
707 | bcbabae8 | Michael S. Tsirkin | } |
708 | 967f97fa | aliguori | |
709 | 64979a4d | Stefan Hajnoczi | trace_virtio_notify(vdev, vq); |
710 | 967f97fa | aliguori | vdev->isr |= 0x01;
|
711 | 7055e687 | Michael S. Tsirkin | virtio_notify_vector(vdev, vq->vector); |
712 | 967f97fa | aliguori | } |
713 | 967f97fa | aliguori | |
714 | 967f97fa | aliguori | void virtio_notify_config(VirtIODevice *vdev)
|
715 | 967f97fa | aliguori | { |
716 | 7625162c | aliguori | if (!(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK))
|
717 | 7625162c | aliguori | return;
|
718 | 7625162c | aliguori | |
719 | 967f97fa | aliguori | vdev->isr |= 0x03;
|
720 | 7055e687 | Michael S. Tsirkin | virtio_notify_vector(vdev, vdev->config_vector); |
721 | 967f97fa | aliguori | } |
722 | 967f97fa | aliguori | |
723 | 967f97fa | aliguori | void virtio_save(VirtIODevice *vdev, QEMUFile *f)
|
724 | 967f97fa | aliguori | { |
725 | 967f97fa | aliguori | int i;
|
726 | 967f97fa | aliguori | |
727 | ff24bd58 | Michael S. Tsirkin | if (vdev->binding->save_config)
|
728 | ff24bd58 | Michael S. Tsirkin | vdev->binding->save_config(vdev->binding_opaque, f); |
729 | 967f97fa | aliguori | |
730 | 967f97fa | aliguori | qemu_put_8s(f, &vdev->status); |
731 | 967f97fa | aliguori | qemu_put_8s(f, &vdev->isr); |
732 | 967f97fa | aliguori | qemu_put_be16s(f, &vdev->queue_sel); |
733 | 704a76fc | Michael S. Tsirkin | qemu_put_be32s(f, &vdev->guest_features); |
734 | 967f97fa | aliguori | qemu_put_be32(f, vdev->config_len); |
735 | 967f97fa | aliguori | qemu_put_buffer(f, vdev->config, vdev->config_len); |
736 | 967f97fa | aliguori | |
737 | 967f97fa | aliguori | for (i = 0; i < VIRTIO_PCI_QUEUE_MAX; i++) { |
738 | 967f97fa | aliguori | if (vdev->vq[i].vring.num == 0) |
739 | 967f97fa | aliguori | break;
|
740 | 967f97fa | aliguori | } |
741 | 967f97fa | aliguori | |
742 | 967f97fa | aliguori | qemu_put_be32(f, i); |
743 | 967f97fa | aliguori | |
744 | 967f97fa | aliguori | for (i = 0; i < VIRTIO_PCI_QUEUE_MAX; i++) { |
745 | 967f97fa | aliguori | if (vdev->vq[i].vring.num == 0) |
746 | 967f97fa | aliguori | break;
|
747 | 967f97fa | aliguori | |
748 | 967f97fa | aliguori | qemu_put_be32(f, vdev->vq[i].vring.num); |
749 | 53c25cea | Paul Brook | qemu_put_be64(f, vdev->vq[i].pa); |
750 | 967f97fa | aliguori | qemu_put_be16s(f, &vdev->vq[i].last_avail_idx); |
751 | ff24bd58 | Michael S. Tsirkin | if (vdev->binding->save_queue)
|
752 | ff24bd58 | Michael S. Tsirkin | vdev->binding->save_queue(vdev->binding_opaque, i, f); |
753 | 967f97fa | aliguori | } |
754 | 967f97fa | aliguori | } |
755 | 967f97fa | aliguori | |
756 | ff24bd58 | Michael S. Tsirkin | int virtio_load(VirtIODevice *vdev, QEMUFile *f)
|
757 | 967f97fa | aliguori | { |
758 | ff24bd58 | Michael S. Tsirkin | int num, i, ret;
|
759 | 6d74ca5a | Michael S. Tsirkin | uint32_t features; |
760 | 8172539d | Michael S. Tsirkin | uint32_t supported_features = |
761 | 6d74ca5a | Michael S. Tsirkin | vdev->binding->get_features(vdev->binding_opaque); |
762 | 967f97fa | aliguori | |
763 | ff24bd58 | Michael S. Tsirkin | if (vdev->binding->load_config) {
|
764 | ff24bd58 | Michael S. Tsirkin | ret = vdev->binding->load_config(vdev->binding_opaque, f); |
765 | ff24bd58 | Michael S. Tsirkin | if (ret)
|
766 | ff24bd58 | Michael S. Tsirkin | return ret;
|
767 | ff24bd58 | Michael S. Tsirkin | } |
768 | 967f97fa | aliguori | |
769 | 967f97fa | aliguori | qemu_get_8s(f, &vdev->status); |
770 | 967f97fa | aliguori | qemu_get_8s(f, &vdev->isr); |
771 | 967f97fa | aliguori | qemu_get_be16s(f, &vdev->queue_sel); |
772 | 6d74ca5a | Michael S. Tsirkin | qemu_get_be32s(f, &features); |
773 | 6d74ca5a | Michael S. Tsirkin | if (features & ~supported_features) {
|
774 | ce67ed65 | Stefan Hajnoczi | error_report("Features 0x%x unsupported. Allowed features: 0x%x",
|
775 | ce67ed65 | Stefan Hajnoczi | features, supported_features); |
776 | 6d74ca5a | Michael S. Tsirkin | return -1; |
777 | 6d74ca5a | Michael S. Tsirkin | } |
778 | fae054b0 | Michael S. Tsirkin | if (vdev->set_features)
|
779 | fae054b0 | Michael S. Tsirkin | vdev->set_features(vdev, features); |
780 | 704a76fc | Michael S. Tsirkin | vdev->guest_features = features; |
781 | 967f97fa | aliguori | vdev->config_len = qemu_get_be32(f); |
782 | 967f97fa | aliguori | qemu_get_buffer(f, vdev->config, vdev->config_len); |
783 | 967f97fa | aliguori | |
784 | 967f97fa | aliguori | num = qemu_get_be32(f); |
785 | 967f97fa | aliguori | |
786 | 967f97fa | aliguori | for (i = 0; i < num; i++) { |
787 | 967f97fa | aliguori | vdev->vq[i].vring.num = qemu_get_be32(f); |
788 | 53c25cea | Paul Brook | vdev->vq[i].pa = qemu_get_be64(f); |
789 | 967f97fa | aliguori | qemu_get_be16s(f, &vdev->vq[i].last_avail_idx); |
790 | bcbabae8 | Michael S. Tsirkin | vdev->vq[i].signalled_used_valid = false;
|
791 | bcbabae8 | Michael S. Tsirkin | vdev->vq[i].notification = true;
|
792 | 967f97fa | aliguori | |
793 | 53c25cea | Paul Brook | if (vdev->vq[i].pa) {
|
794 | 1abeb5a6 | Michael S. Tsirkin | uint16_t nheads; |
795 | 53c25cea | Paul Brook | virtqueue_init(&vdev->vq[i]); |
796 | 1abeb5a6 | Michael S. Tsirkin | nheads = vring_avail_idx(&vdev->vq[i]) - vdev->vq[i].last_avail_idx; |
797 | 1abeb5a6 | Michael S. Tsirkin | /* Check it isn't doing very strange things with descriptor numbers. */
|
798 | 1abeb5a6 | Michael S. Tsirkin | if (nheads > vdev->vq[i].vring.num) {
|
799 | 1abeb5a6 | Michael S. Tsirkin | error_report("VQ %d size 0x%x Guest index 0x%x "
|
800 | 6daf194d | Markus Armbruster | "inconsistent with Host index 0x%x: delta 0x%x",
|
801 | 1abeb5a6 | Michael S. Tsirkin | i, vdev->vq[i].vring.num, |
802 | 1abeb5a6 | Michael S. Tsirkin | vring_avail_idx(&vdev->vq[i]), |
803 | 1abeb5a6 | Michael S. Tsirkin | vdev->vq[i].last_avail_idx, nheads); |
804 | 1abeb5a6 | Michael S. Tsirkin | return -1; |
805 | 1abeb5a6 | Michael S. Tsirkin | } |
806 | 1abeb5a6 | Michael S. Tsirkin | } else if (vdev->vq[i].last_avail_idx) { |
807 | 1abeb5a6 | Michael S. Tsirkin | error_report("VQ %d address 0x0 "
|
808 | 6daf194d | Markus Armbruster | "inconsistent with Host index 0x%x",
|
809 | 1abeb5a6 | Michael S. Tsirkin | i, vdev->vq[i].last_avail_idx); |
810 | 1abeb5a6 | Michael S. Tsirkin | return -1; |
811 | 258dc7c9 | Michael S. Tsirkin | } |
812 | ff24bd58 | Michael S. Tsirkin | if (vdev->binding->load_queue) {
|
813 | ff24bd58 | Michael S. Tsirkin | ret = vdev->binding->load_queue(vdev->binding_opaque, i, f); |
814 | ff24bd58 | Michael S. Tsirkin | if (ret)
|
815 | ff24bd58 | Michael S. Tsirkin | return ret;
|
816 | 7055e687 | Michael S. Tsirkin | } |
817 | 967f97fa | aliguori | } |
818 | 967f97fa | aliguori | |
819 | 7055e687 | Michael S. Tsirkin | virtio_notify_vector(vdev, VIRTIO_NO_VECTOR); |
820 | ff24bd58 | Michael S. Tsirkin | return 0; |
821 | 967f97fa | aliguori | } |
822 | 967f97fa | aliguori | |
823 | b946a153 | aliguori | void virtio_cleanup(VirtIODevice *vdev)
|
824 | b946a153 | aliguori | { |
825 | 85cf2a8d | Michael S. Tsirkin | qemu_del_vm_change_state_handler(vdev->vmstate); |
826 | b946a153 | aliguori | if (vdev->config)
|
827 | b946a153 | aliguori | qemu_free(vdev->config); |
828 | b946a153 | aliguori | qemu_free(vdev->vq); |
829 | b946a153 | aliguori | } |
830 | b946a153 | aliguori | |
831 | 85cf2a8d | Michael S. Tsirkin | static void virtio_vmstate_change(void *opaque, int running, int reason) |
832 | 85cf2a8d | Michael S. Tsirkin | { |
833 | 85cf2a8d | Michael S. Tsirkin | VirtIODevice *vdev = opaque; |
834 | 85cf2a8d | Michael S. Tsirkin | bool backend_run = running && (vdev->status & VIRTIO_CONFIG_S_DRIVER_OK);
|
835 | 85cf2a8d | Michael S. Tsirkin | vdev->vm_running = running; |
836 | 85cf2a8d | Michael S. Tsirkin | |
837 | 85cf2a8d | Michael S. Tsirkin | if (backend_run) {
|
838 | 85cf2a8d | Michael S. Tsirkin | virtio_set_status(vdev, vdev->status); |
839 | 85cf2a8d | Michael S. Tsirkin | } |
840 | 85cf2a8d | Michael S. Tsirkin | |
841 | 85cf2a8d | Michael S. Tsirkin | if (vdev->binding->vmstate_change) {
|
842 | 85cf2a8d | Michael S. Tsirkin | vdev->binding->vmstate_change(vdev->binding_opaque, backend_run); |
843 | 85cf2a8d | Michael S. Tsirkin | } |
844 | 85cf2a8d | Michael S. Tsirkin | |
845 | 85cf2a8d | Michael S. Tsirkin | if (!backend_run) {
|
846 | 85cf2a8d | Michael S. Tsirkin | virtio_set_status(vdev, vdev->status); |
847 | 85cf2a8d | Michael S. Tsirkin | } |
848 | 85cf2a8d | Michael S. Tsirkin | } |
849 | 85cf2a8d | Michael S. Tsirkin | |
850 | 53c25cea | Paul Brook | VirtIODevice *virtio_common_init(const char *name, uint16_t device_id, |
851 | 53c25cea | Paul Brook | size_t config_size, size_t struct_size) |
852 | 967f97fa | aliguori | { |
853 | 967f97fa | aliguori | VirtIODevice *vdev; |
854 | b8193adb | Michael S. Tsirkin | int i;
|
855 | 967f97fa | aliguori | |
856 | 53c25cea | Paul Brook | vdev = qemu_mallocz(struct_size); |
857 | 967f97fa | aliguori | |
858 | 53c25cea | Paul Brook | vdev->device_id = device_id; |
859 | 967f97fa | aliguori | vdev->status = 0;
|
860 | 967f97fa | aliguori | vdev->isr = 0;
|
861 | 967f97fa | aliguori | vdev->queue_sel = 0;
|
862 | 7055e687 | Michael S. Tsirkin | vdev->config_vector = VIRTIO_NO_VECTOR; |
863 | 967f97fa | aliguori | vdev->vq = qemu_mallocz(sizeof(VirtQueue) * VIRTIO_PCI_QUEUE_MAX);
|
864 | d3674c57 | Jason Wang | vdev->vm_running = vm_running; |
865 | 1cbdabe2 | Michael S. Tsirkin | for(i = 0; i < VIRTIO_PCI_QUEUE_MAX; i++) { |
866 | b8193adb | Michael S. Tsirkin | vdev->vq[i].vector = VIRTIO_NO_VECTOR; |
867 | 1cbdabe2 | Michael S. Tsirkin | vdev->vq[i].vdev = vdev; |
868 | 1cbdabe2 | Michael S. Tsirkin | } |
869 | 967f97fa | aliguori | |
870 | 967f97fa | aliguori | vdev->name = name; |
871 | 967f97fa | aliguori | vdev->config_len = config_size; |
872 | 967f97fa | aliguori | if (vdev->config_len)
|
873 | 967f97fa | aliguori | vdev->config = qemu_mallocz(config_size); |
874 | 967f97fa | aliguori | else
|
875 | 967f97fa | aliguori | vdev->config = NULL;
|
876 | 967f97fa | aliguori | |
877 | 85cf2a8d | Michael S. Tsirkin | vdev->vmstate = qemu_add_vm_change_state_handler(virtio_vmstate_change, vdev); |
878 | 85cf2a8d | Michael S. Tsirkin | |
879 | 967f97fa | aliguori | return vdev;
|
880 | 967f97fa | aliguori | } |
881 | 53c25cea | Paul Brook | |
882 | 53c25cea | Paul Brook | void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding, |
883 | 53c25cea | Paul Brook | void *opaque)
|
884 | 53c25cea | Paul Brook | { |
885 | 53c25cea | Paul Brook | vdev->binding = binding; |
886 | 53c25cea | Paul Brook | vdev->binding_opaque = opaque; |
887 | 53c25cea | Paul Brook | } |
888 | 1cbdabe2 | Michael S. Tsirkin | |
889 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n)
|
890 | 1cbdabe2 | Michael S. Tsirkin | { |
891 | 1cbdabe2 | Michael S. Tsirkin | return vdev->vq[n].vring.desc;
|
892 | 1cbdabe2 | Michael S. Tsirkin | } |
893 | 1cbdabe2 | Michael S. Tsirkin | |
894 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n)
|
895 | 1cbdabe2 | Michael S. Tsirkin | { |
896 | 1cbdabe2 | Michael S. Tsirkin | return vdev->vq[n].vring.avail;
|
897 | 1cbdabe2 | Michael S. Tsirkin | } |
898 | 1cbdabe2 | Michael S. Tsirkin | |
899 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n)
|
900 | 1cbdabe2 | Michael S. Tsirkin | { |
901 | 1cbdabe2 | Michael S. Tsirkin | return vdev->vq[n].vring.used;
|
902 | 1cbdabe2 | Michael S. Tsirkin | } |
903 | 1cbdabe2 | Michael S. Tsirkin | |
904 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n)
|
905 | 1cbdabe2 | Michael S. Tsirkin | { |
906 | 1cbdabe2 | Michael S. Tsirkin | return vdev->vq[n].vring.desc;
|
907 | 1cbdabe2 | Michael S. Tsirkin | } |
908 | 1cbdabe2 | Michael S. Tsirkin | |
909 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n)
|
910 | 1cbdabe2 | Michael S. Tsirkin | { |
911 | 1cbdabe2 | Michael S. Tsirkin | return sizeof(VRingDesc) * vdev->vq[n].vring.num; |
912 | 1cbdabe2 | Michael S. Tsirkin | } |
913 | 1cbdabe2 | Michael S. Tsirkin | |
914 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n)
|
915 | 1cbdabe2 | Michael S. Tsirkin | { |
916 | 1cbdabe2 | Michael S. Tsirkin | return offsetof(VRingAvail, ring) +
|
917 | 2b3af999 | Stefan Weil | sizeof(uint64_t) * vdev->vq[n].vring.num;
|
918 | 1cbdabe2 | Michael S. Tsirkin | } |
919 | 1cbdabe2 | Michael S. Tsirkin | |
920 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n)
|
921 | 1cbdabe2 | Michael S. Tsirkin | { |
922 | 1cbdabe2 | Michael S. Tsirkin | return offsetof(VRingUsed, ring) +
|
923 | 1cbdabe2 | Michael S. Tsirkin | sizeof(VRingUsedElem) * vdev->vq[n].vring.num;
|
924 | 1cbdabe2 | Michael S. Tsirkin | } |
925 | 1cbdabe2 | Michael S. Tsirkin | |
926 | 1cbdabe2 | Michael S. Tsirkin | target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n)
|
927 | 1cbdabe2 | Michael S. Tsirkin | { |
928 | 1cbdabe2 | Michael S. Tsirkin | return vdev->vq[n].vring.used - vdev->vq[n].vring.desc +
|
929 | 1cbdabe2 | Michael S. Tsirkin | virtio_queue_get_used_size(vdev, n); |
930 | 1cbdabe2 | Michael S. Tsirkin | } |
931 | 1cbdabe2 | Michael S. Tsirkin | |
932 | 1cbdabe2 | Michael S. Tsirkin | uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n)
|
933 | 1cbdabe2 | Michael S. Tsirkin | { |
934 | 1cbdabe2 | Michael S. Tsirkin | return vdev->vq[n].last_avail_idx;
|
935 | 1cbdabe2 | Michael S. Tsirkin | } |
936 | 1cbdabe2 | Michael S. Tsirkin | |
937 | 1cbdabe2 | Michael S. Tsirkin | void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx) |
938 | 1cbdabe2 | Michael S. Tsirkin | { |
939 | 1cbdabe2 | Michael S. Tsirkin | vdev->vq[n].last_avail_idx = idx; |
940 | 1cbdabe2 | Michael S. Tsirkin | } |
941 | 1cbdabe2 | Michael S. Tsirkin | |
942 | 1cbdabe2 | Michael S. Tsirkin | VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n)
|
943 | 1cbdabe2 | Michael S. Tsirkin | { |
944 | 1cbdabe2 | Michael S. Tsirkin | return vdev->vq + n;
|
945 | 1cbdabe2 | Michael S. Tsirkin | } |
946 | 1cbdabe2 | Michael S. Tsirkin | |
947 | 1cbdabe2 | Michael S. Tsirkin | EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq) |
948 | 1cbdabe2 | Michael S. Tsirkin | { |
949 | 1cbdabe2 | Michael S. Tsirkin | return &vq->guest_notifier;
|
950 | 1cbdabe2 | Michael S. Tsirkin | } |
951 | 1cbdabe2 | Michael S. Tsirkin | EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq) |
952 | 1cbdabe2 | Michael S. Tsirkin | { |
953 | 1cbdabe2 | Michael S. Tsirkin | return &vq->host_notifier;
|
954 | 1cbdabe2 | Michael S. Tsirkin | } |