Branch data Line data Source code
1 : : /* SPDX-License-Identifier: BSD-3-Clause
2 : : * Copyright (C) 2020 Intel Corporation.
3 : : * Copyright (c) 2019-2022, Nutanix Inc. All rights reserved.
4 : : * Copyright (c) 2022, 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
5 : : */
6 : :
7 : : /*
8 : : * NVMe over vfio-user transport
9 : : */
10 : :
11 : : #include <sys/param.h>
12 : :
13 : : #include <vfio-user/libvfio-user.h>
14 : : #include <vfio-user/pci_defs.h>
15 : :
16 : : #include "spdk/barrier.h"
17 : : #include "spdk/stdinc.h"
18 : : #include "spdk/assert.h"
19 : : #include "spdk/thread.h"
20 : : #include "spdk/nvmf_transport.h"
21 : : #include "spdk/sock.h"
22 : : #include "spdk/string.h"
23 : : #include "spdk/util.h"
24 : : #include "spdk/log.h"
25 : :
26 : : #include "transport.h"
27 : :
28 : : #include "nvmf_internal.h"
29 : :
30 : : #define SWAP(x, y) \
31 : : do \
32 : : { \
33 : : typeof(x) _tmp = x; \
34 : : x = y; \
35 : : y = _tmp; \
36 : : } while (0)
37 : :
38 : : #define NVMF_VFIO_USER_DEFAULT_MAX_QUEUE_DEPTH 256
39 : : #define NVMF_VFIO_USER_DEFAULT_AQ_DEPTH 32
40 : : #define NVMF_VFIO_USER_DEFAULT_MAX_IO_SIZE ((NVMF_REQ_MAX_BUFFERS - 1) << SHIFT_4KB)
41 : : #define NVMF_VFIO_USER_DEFAULT_IO_UNIT_SIZE NVMF_VFIO_USER_DEFAULT_MAX_IO_SIZE
42 : :
43 : : #define NVME_DOORBELLS_OFFSET 0x1000
44 : : #define NVMF_VFIO_USER_SHADOW_DOORBELLS_BUFFER_COUNT 2
45 : : #define NVMF_VFIO_USER_SET_EVENTIDX_MAX_ATTEMPTS 3
46 : : #define NVMF_VFIO_USER_EVENTIDX_POLL UINT32_MAX
47 : :
48 : : #define NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR 512
49 : : #define NVMF_VFIO_USER_DEFAULT_MAX_QPAIRS_PER_CTRLR (NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR / 4)
50 : :
51 : : /* NVMe spec 1.4, section 5.21.1.7 */
52 : : SPDK_STATIC_ASSERT(NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR >= 2 &&
53 : : NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR <= SPDK_NVME_MAX_IO_QUEUES,
54 : : "bad number of queues");
55 : :
56 : : /*
57 : : * NVMe driver reads 4096 bytes, which is the extended PCI configuration space
58 : : * available on PCI-X 2.0 and PCI Express buses
59 : : */
60 : : #define NVME_REG_CFG_SIZE 0x1000
61 : :
62 : : /*
63 : : * Doorbells must be page aligned so that they can memory mapped.
64 : : *
65 : : * TODO does the NVMe spec also require this? Document it.
66 : : */
67 : : #define NVMF_VFIO_USER_DOORBELLS_SIZE \
68 : : SPDK_ALIGN_CEIL( \
69 : : (NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR * 2 * SPDK_NVME_DOORBELL_REGISTER_SIZE), \
70 : : 0x1000)
71 : : #define NVME_REG_BAR0_SIZE (NVME_DOORBELLS_OFFSET + NVMF_VFIO_USER_DOORBELLS_SIZE)
72 : :
73 : : /*
74 : : * TODO check the PCI spec whether BAR4 and BAR5 really have to be at least one
75 : : * page and a multiple of page size (maybe QEMU also needs this?). Document all
76 : : * this.
77 : : */
78 : :
79 : : /*
80 : : * MSI-X Pending Bit Array Size
81 : : *
82 : : * TODO according to the PCI spec we need one bit per vector, document the
83 : : * relevant section.
84 : : *
85 : : * If the first argument to SPDK_ALIGN_CEIL is 0 then the result is 0, so we
86 : : * would end up with a 0-size BAR5.
87 : : */
88 : : #define NVME_IRQ_MSIX_NUM MAX(CHAR_BIT, NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR)
89 : : #define NVME_BAR5_SIZE SPDK_ALIGN_CEIL((NVME_IRQ_MSIX_NUM / CHAR_BIT), 0x1000)
90 : : SPDK_STATIC_ASSERT(NVME_BAR5_SIZE > 0, "Incorrect size");
91 : :
92 : : /* MSI-X Table Size */
93 : : #define NVME_BAR4_SIZE SPDK_ALIGN_CEIL((NVME_IRQ_MSIX_NUM * 16), 0x1000)
94 : : SPDK_STATIC_ASSERT(NVME_BAR4_SIZE > 0, "Incorrect size");
95 : :
96 : : struct nvmf_vfio_user_req;
97 : :
98 : : typedef int (*nvmf_vfio_user_req_cb_fn)(struct nvmf_vfio_user_req *req, void *cb_arg);
99 : :
100 : : /* 1 more for PRP2 list itself */
101 : : #define NVMF_VFIO_USER_MAX_IOVECS (NVMF_REQ_MAX_BUFFERS + 1)
102 : :
103 : : enum nvmf_vfio_user_req_state {
104 : : VFIO_USER_REQUEST_STATE_FREE = 0,
105 : : VFIO_USER_REQUEST_STATE_EXECUTING,
106 : : };
107 : :
108 : : /*
109 : : * Support for live migration in NVMf/vfio-user: live migration is implemented
110 : : * by stopping the NVMf subsystem when the device is instructed to enter the
111 : : * stop-and-copy state and then trivially, and most importantly safely,
112 : : * collecting migration state and providing it to the vfio-user client. We
113 : : * don't provide any migration state at the pre-copy state as that's too
114 : : * complicated to do, we might support this in the future.
115 : : */
116 : :
117 : :
118 : : /* NVMe device state representation */
119 : : struct nvme_migr_sq_state {
120 : : uint16_t sqid;
121 : : uint16_t cqid;
122 : : uint32_t head;
123 : : uint32_t size;
124 : : uint32_t reserved;
125 : : uint64_t dma_addr;
126 : : };
127 : : SPDK_STATIC_ASSERT(sizeof(struct nvme_migr_sq_state) == 0x18, "Incorrect size");
128 : :
129 : : struct nvme_migr_cq_state {
130 : : uint16_t cqid;
131 : : uint16_t phase;
132 : : uint32_t tail;
133 : : uint32_t size;
134 : : uint32_t iv;
135 : : uint32_t ien;
136 : : uint32_t reserved;
137 : : uint64_t dma_addr;
138 : : };
139 : : SPDK_STATIC_ASSERT(sizeof(struct nvme_migr_cq_state) == 0x20, "Incorrect size");
140 : :
141 : : #define VFIO_USER_MIGR_CALLBACK_VERS 1
142 : : #define VFIO_USER_NVME_MIGR_MAGIC 0xAFEDBC23
143 : :
144 : : /* The device state is in VFIO MIGRATION BAR(9) region, keep the device state page aligned.
145 : : *
146 : : * NVMe device migration region is defined as below:
147 : : * -------------------------------------------------------------------------
148 : : * | vfio_user_nvme_migr_header | nvmf controller data | queue pairs | BARs |
149 : : * -------------------------------------------------------------------------
150 : : *
151 : : * Keep vfio_user_nvme_migr_header as a fixed 0x1000 length, all new added fields
152 : : * can use the reserved space at the end of the data structure.
153 : : */
154 : : struct vfio_user_nvme_migr_header {
155 : : /* Magic value to validate migration data */
156 : : uint32_t magic;
157 : : /* Version to check the data is same from source to destination */
158 : : uint32_t version;
159 : :
160 : : /* The library uses this field to know how many fields in this
161 : : * structure are valid, starting at the beginning of this data
162 : : * structure. New added fields in future use `unused` memory
163 : : * spaces.
164 : : */
165 : : uint32_t opts_size;
166 : : uint32_t reserved0;
167 : :
168 : : /* BARs information */
169 : : uint64_t bar_offset[VFU_PCI_DEV_NUM_REGIONS];
170 : : uint64_t bar_len[VFU_PCI_DEV_NUM_REGIONS];
171 : :
172 : : /* Queue pair start offset, starting at the beginning of this
173 : : * data structure.
174 : : */
175 : : uint64_t qp_offset;
176 : : uint64_t qp_len;
177 : :
178 : : /* Controller data structure */
179 : : uint32_t num_io_queues;
180 : : uint32_t reserved1;
181 : :
182 : : /* NVMf controller data offset and length if exist, starting at
183 : : * the beginning of this data structure.
184 : : */
185 : : uint64_t nvmf_data_offset;
186 : : uint64_t nvmf_data_len;
187 : :
188 : : /*
189 : : * Whether or not shadow doorbells are used in the source. 0 is a valid DMA
190 : : * address.
191 : : */
192 : : uint32_t sdbl;
193 : :
194 : : /* Shadow doorbell DMA addresses. */
195 : : uint64_t shadow_doorbell_buffer;
196 : : uint64_t eventidx_buffer;
197 : :
198 : : /* Reserved memory space for new added fields, the
199 : : * field is always at the end of this data structure.
200 : : */
201 : : uint8_t unused[3856];
202 : : };
203 : : SPDK_STATIC_ASSERT(sizeof(struct vfio_user_nvme_migr_header) == 0x1000, "Incorrect size");
204 : :
205 : : struct vfio_user_nvme_migr_qp {
206 : : struct nvme_migr_sq_state sq;
207 : : struct nvme_migr_cq_state cq;
208 : : };
209 : :
210 : : /* NVMe state definition used to load/restore from/to NVMe migration BAR region */
211 : : struct vfio_user_nvme_migr_state {
212 : : struct vfio_user_nvme_migr_header ctrlr_header;
213 : : struct spdk_nvmf_ctrlr_migr_data nvmf_data;
214 : : struct vfio_user_nvme_migr_qp qps[NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR];
215 : : uint8_t doorbells[NVMF_VFIO_USER_DOORBELLS_SIZE];
216 : : uint8_t cfg[NVME_REG_CFG_SIZE];
217 : : };
218 : :
219 : : struct nvmf_vfio_user_req {
220 : : struct spdk_nvmf_request req;
221 : : struct spdk_nvme_cpl rsp;
222 : : struct spdk_nvme_cmd cmd;
223 : :
224 : : enum nvmf_vfio_user_req_state state;
225 : : nvmf_vfio_user_req_cb_fn cb_fn;
226 : : void *cb_arg;
227 : :
228 : : /* old CC before prop_set_cc fabric command */
229 : : union spdk_nvme_cc_register cc;
230 : :
231 : : TAILQ_ENTRY(nvmf_vfio_user_req) link;
232 : :
233 : : struct iovec iov[NVMF_VFIO_USER_MAX_IOVECS];
234 : : uint8_t iovcnt;
235 : :
236 : : /* NVMF_VFIO_USER_MAX_IOVECS worth of dma_sg_t. */
237 : : uint8_t sg[];
238 : : };
239 : :
240 : : #define MAP_R (0)
241 : : #define MAP_RW (1 << 0)
242 : : #define MAP_INITIALIZE (1 << 1)
243 : : #define MAP_QUIET (1 << 2)
244 : :
245 : : /*
246 : : * Mapping of an NVMe queue.
247 : : *
248 : : * This holds the information tracking a local process mapping of an NVMe queue
249 : : * shared by the client.
250 : : */
251 : : struct nvme_q_mapping {
252 : : /* iov of local process mapping. */
253 : : struct iovec iov;
254 : : /* Stored sg, needed for unmap. */
255 : : dma_sg_t *sg;
256 : : /* Client PRP of queue. */
257 : : uint64_t prp1;
258 : : /* Total length in bytes. */
259 : : uint64_t len;
260 : : };
261 : :
262 : : enum nvmf_vfio_user_sq_state {
263 : : VFIO_USER_SQ_UNUSED = 0,
264 : : VFIO_USER_SQ_CREATED,
265 : : VFIO_USER_SQ_DELETED,
266 : : VFIO_USER_SQ_ACTIVE,
267 : : VFIO_USER_SQ_INACTIVE
268 : : };
269 : :
270 : : enum nvmf_vfio_user_cq_state {
271 : : VFIO_USER_CQ_UNUSED = 0,
272 : : VFIO_USER_CQ_CREATED,
273 : : VFIO_USER_CQ_DELETED,
274 : : };
275 : :
276 : : enum nvmf_vfio_user_ctrlr_state {
277 : : VFIO_USER_CTRLR_CREATING = 0,
278 : : VFIO_USER_CTRLR_RUNNING,
279 : : /* Quiesce requested by libvfio-user */
280 : : VFIO_USER_CTRLR_PAUSING,
281 : : /* NVMf subsystem is paused, it's safe to do PCI reset, memory register,
282 : : * memory unergister, and vfio migration state transition in this state.
283 : : */
284 : : VFIO_USER_CTRLR_PAUSED,
285 : : /*
286 : : * Implies that the NVMf subsystem is paused. Device will be unquiesced (PCI
287 : : * reset, memory register and unregister, controller in destination VM has
288 : : * been restored). NVMf subsystem resume has been requested.
289 : : */
290 : : VFIO_USER_CTRLR_RESUMING,
291 : : /*
292 : : * Implies that the NVMf subsystem is paused. Both controller in source VM and
293 : : * destinatiom VM is in this state when doing live migration.
294 : : */
295 : : VFIO_USER_CTRLR_MIGRATING
296 : : };
297 : :
298 : : struct nvmf_vfio_user_sq {
299 : : struct spdk_nvmf_qpair qpair;
300 : : struct spdk_nvmf_transport_poll_group *group;
301 : : struct nvmf_vfio_user_ctrlr *ctrlr;
302 : :
303 : : uint32_t qid;
304 : : /* Number of entries in queue. */
305 : : uint32_t size;
306 : : struct nvme_q_mapping mapping;
307 : : enum nvmf_vfio_user_sq_state sq_state;
308 : :
309 : : uint32_t head;
310 : : volatile uint32_t *dbl_tailp;
311 : :
312 : : /* Whether a shadow doorbell eventidx needs setting. */
313 : : bool need_rearm;
314 : :
315 : : /* multiple SQs can be mapped to the same CQ */
316 : : uint16_t cqid;
317 : :
318 : : /* handle_queue_connect_rsp() can be used both for CREATE IO SQ response
319 : : * and SQ re-connect response in the destination VM, for the prior case,
320 : : * we will post a NVMe completion to VM, we will not set this flag when
321 : : * re-connecting SQs in the destination VM.
322 : : */
323 : : bool post_create_io_sq_completion;
324 : : /* Copy of Create IO SQ command, this field is used together with
325 : : * `post_create_io_sq_completion` flag.
326 : : */
327 : : struct spdk_nvme_cmd create_io_sq_cmd;
328 : :
329 : : struct vfio_user_delete_sq_ctx *delete_ctx;
330 : :
331 : : /* Currently unallocated reqs. */
332 : : TAILQ_HEAD(, nvmf_vfio_user_req) free_reqs;
333 : : /* Poll group entry */
334 : : TAILQ_ENTRY(nvmf_vfio_user_sq) link;
335 : : /* Connected SQ entry */
336 : : TAILQ_ENTRY(nvmf_vfio_user_sq) tailq;
337 : : };
338 : :
339 : : struct nvmf_vfio_user_cq {
340 : : struct spdk_nvmf_transport_poll_group *group;
341 : : int cq_ref;
342 : :
343 : : uint32_t qid;
344 : : /* Number of entries in queue. */
345 : : uint32_t size;
346 : : struct nvme_q_mapping mapping;
347 : : enum nvmf_vfio_user_cq_state cq_state;
348 : :
349 : : uint32_t tail;
350 : : volatile uint32_t *dbl_headp;
351 : :
352 : : bool phase;
353 : :
354 : : uint16_t iv;
355 : : bool ien;
356 : :
357 : : uint32_t last_head;
358 : : uint32_t last_trigger_irq_tail;
359 : : };
360 : :
361 : : struct nvmf_vfio_user_poll_group {
362 : : struct spdk_nvmf_transport_poll_group group;
363 : : TAILQ_ENTRY(nvmf_vfio_user_poll_group) link;
364 : : TAILQ_HEAD(, nvmf_vfio_user_sq) sqs;
365 : : struct spdk_interrupt *intr;
366 : : int intr_fd;
367 : : struct {
368 : :
369 : : /*
370 : : * ctrlr_intr and ctrlr_kicks will be zero for all other poll
371 : : * groups. However, they can be zero even for the poll group
372 : : * the controller belongs are if no vfio-user message has been
373 : : * received or the controller hasn't been kicked yet.
374 : : */
375 : :
376 : : /*
377 : : * Number of times vfio_user_ctrlr_intr() has run:
378 : : * vfio-user file descriptor has been ready or explicitly
379 : : * kicked (see below).
380 : : */
381 : : uint64_t ctrlr_intr;
382 : :
383 : : /*
384 : : * Kicks to the controller by ctrlr_kick().
385 : : * ctrlr_intr - ctrlr_kicks is the number of times the
386 : : * vfio-user poll file descriptor has been ready.
387 : : */
388 : : uint64_t ctrlr_kicks;
389 : :
390 : : /*
391 : : * How many times we won the race arming an SQ.
392 : : */
393 : : uint64_t won;
394 : :
395 : : /*
396 : : * How many times we lost the race arming an SQ
397 : : */
398 : : uint64_t lost;
399 : :
400 : : /*
401 : : * How many requests we processed in total each time we lost
402 : : * the rearm race.
403 : : */
404 : : uint64_t lost_count;
405 : :
406 : : /*
407 : : * Number of attempts we attempted to rearm all the SQs in the
408 : : * poll group.
409 : : */
410 : : uint64_t rearms;
411 : :
412 : : uint64_t pg_process_count;
413 : : uint64_t intr;
414 : : uint64_t polls;
415 : : uint64_t polls_spurious;
416 : : uint64_t poll_reqs;
417 : : uint64_t poll_reqs_squared;
418 : : uint64_t cqh_admin_writes;
419 : : uint64_t cqh_io_writes;
420 : : } stats;
421 : : };
422 : :
423 : : struct nvmf_vfio_user_shadow_doorbells {
424 : : volatile uint32_t *shadow_doorbells;
425 : : volatile uint32_t *eventidxs;
426 : : dma_sg_t *sgs;
427 : : struct iovec *iovs;
428 : : };
429 : :
430 : : struct nvmf_vfio_user_ctrlr {
431 : : struct nvmf_vfio_user_endpoint *endpoint;
432 : : struct nvmf_vfio_user_transport *transport;
433 : :
434 : : /* Connected SQs list */
435 : : TAILQ_HEAD(, nvmf_vfio_user_sq) connected_sqs;
436 : : enum nvmf_vfio_user_ctrlr_state state;
437 : :
438 : : /*
439 : : * Tells whether live migration data have been prepared. This is used
440 : : * by the get_pending_bytes callback to tell whether or not the
441 : : * previous iteration finished.
442 : : */
443 : : bool migr_data_prepared;
444 : :
445 : : /* Controller is in source VM when doing live migration */
446 : : bool in_source_vm;
447 : :
448 : : struct spdk_thread *thread;
449 : : struct spdk_poller *vfu_ctx_poller;
450 : : struct spdk_interrupt *intr;
451 : : int intr_fd;
452 : :
453 : : bool queued_quiesce;
454 : :
455 : : bool reset_shn;
456 : : bool disconnect;
457 : :
458 : : uint16_t cntlid;
459 : : struct spdk_nvmf_ctrlr *ctrlr;
460 : :
461 : : struct nvmf_vfio_user_sq *sqs[NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR];
462 : : struct nvmf_vfio_user_cq *cqs[NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR];
463 : :
464 : : TAILQ_ENTRY(nvmf_vfio_user_ctrlr) link;
465 : :
466 : : volatile uint32_t *bar0_doorbells;
467 : : struct nvmf_vfio_user_shadow_doorbells *sdbl;
468 : : /*
469 : : * Shadow doorbells PRPs to provide during the stop-and-copy state.
470 : : */
471 : : uint64_t shadow_doorbell_buffer;
472 : : uint64_t eventidx_buffer;
473 : :
474 : : bool adaptive_irqs_enabled;
475 : : };
476 : :
477 : : /* Endpoint in vfio-user is associated with a socket file, which
478 : : * is the representative of a PCI endpoint.
479 : : */
480 : : struct nvmf_vfio_user_endpoint {
481 : : struct nvmf_vfio_user_transport *transport;
482 : : vfu_ctx_t *vfu_ctx;
483 : : struct spdk_poller *accept_poller;
484 : : struct spdk_thread *accept_thread;
485 : : bool interrupt_mode;
486 : : struct msixcap *msix;
487 : : vfu_pci_config_space_t *pci_config_space;
488 : : int devmem_fd;
489 : : int accept_intr_fd;
490 : : struct spdk_interrupt *accept_intr;
491 : :
492 : : volatile uint32_t *bar0_doorbells;
493 : :
494 : : int migr_fd;
495 : : void *migr_data;
496 : :
497 : : struct spdk_nvme_transport_id trid;
498 : : struct spdk_nvmf_subsystem *subsystem;
499 : :
500 : : /* Controller is associated with an active socket connection,
501 : : * the lifecycle of the controller is same as the VM.
502 : : * Currently we only support one active connection, as the NVMe
503 : : * specification defines, we may support multiple controllers in
504 : : * future, so that it can support e.g: RESERVATION.
505 : : */
506 : : struct nvmf_vfio_user_ctrlr *ctrlr;
507 : : pthread_mutex_t lock;
508 : :
509 : : bool need_async_destroy;
510 : : /* The subsystem is in PAUSED state and need to be resumed, TRUE
511 : : * only when migration is done successfully and the controller is
512 : : * in source VM.
513 : : */
514 : : bool need_resume;
515 : : /* Start the accept poller again after destroying the controller */
516 : : bool need_relisten;
517 : :
518 : : TAILQ_ENTRY(nvmf_vfio_user_endpoint) link;
519 : : };
520 : :
521 : : struct nvmf_vfio_user_transport_opts {
522 : : bool disable_mappable_bar0;
523 : : bool disable_adaptive_irq;
524 : : bool disable_shadow_doorbells;
525 : : bool disable_compare;
526 : : bool enable_intr_mode_sq_spreading;
527 : : };
528 : :
529 : : struct nvmf_vfio_user_transport {
530 : : struct spdk_nvmf_transport transport;
531 : : struct nvmf_vfio_user_transport_opts transport_opts;
532 : : bool intr_mode_supported;
533 : : pthread_mutex_t lock;
534 : : TAILQ_HEAD(, nvmf_vfio_user_endpoint) endpoints;
535 : :
536 : : pthread_mutex_t pg_lock;
537 : : TAILQ_HEAD(, nvmf_vfio_user_poll_group) poll_groups;
538 : : struct nvmf_vfio_user_poll_group *next_pg;
539 : : };
540 : :
541 : : /*
542 : : * function prototypes
543 : : */
544 : : static int nvmf_vfio_user_req_free(struct spdk_nvmf_request *req);
545 : :
546 : : static struct nvmf_vfio_user_req *get_nvmf_vfio_user_req(struct nvmf_vfio_user_sq *sq);
547 : :
548 : : /*
549 : : * Local process virtual address of a queue.
550 : : */
551 : : static inline void *
552 : 6044955 : q_addr(struct nvme_q_mapping *mapping)
553 : : {
554 : 6044955 : return mapping->iov.iov_base;
555 : : }
556 : :
557 : : static inline int
558 : 834 : queue_index(uint16_t qid, bool is_cq)
559 : : {
560 : 834 : return (qid * 2) + is_cq;
561 : : }
562 : :
563 : : static inline volatile uint32_t *
564 : 91055948 : sq_headp(struct nvmf_vfio_user_sq *sq)
565 : : {
566 [ - + ]: 91055948 : assert(sq != NULL);
567 : 91055948 : return &sq->head;
568 : : }
569 : :
570 : : static inline volatile uint32_t *
571 : 73377288 : sq_dbl_tailp(struct nvmf_vfio_user_sq *sq)
572 : : {
573 [ - + ]: 73377288 : assert(sq != NULL);
574 : 73377288 : return sq->dbl_tailp;
575 : : }
576 : :
577 : : static inline volatile uint32_t *
578 : 41277 : cq_dbl_headp(struct nvmf_vfio_user_cq *cq)
579 : : {
580 [ - + ]: 41277 : assert(cq != NULL);
581 : 41277 : return cq->dbl_headp;
582 : : }
583 : :
584 : : static inline volatile uint32_t *
585 : 42667825 : cq_tailp(struct nvmf_vfio_user_cq *cq)
586 : : {
587 [ - + ]: 42667825 : assert(cq != NULL);
588 : 42667825 : return &cq->tail;
589 : : }
590 : :
591 : : static inline void
592 : 2903142 : sq_head_advance(struct nvmf_vfio_user_sq *sq)
593 : : {
594 [ - + ]: 2903142 : assert(sq != NULL);
595 : :
596 [ - + ]: 2903142 : assert(*sq_headp(sq) < sq->size);
597 : 2903142 : (*sq_headp(sq))++;
598 : :
599 [ + + ]: 2903142 : if (spdk_unlikely(*sq_headp(sq) == sq->size)) {
600 : 11323 : *sq_headp(sq) = 0;
601 : : }
602 : 2903142 : }
603 : :
604 : : static inline void
605 : 2902990 : cq_tail_advance(struct nvmf_vfio_user_cq *cq)
606 : : {
607 [ - + ]: 2902990 : assert(cq != NULL);
608 : :
609 [ - + ]: 2902990 : assert(*cq_tailp(cq) < cq->size);
610 : 2902990 : (*cq_tailp(cq))++;
611 : :
612 [ + + ]: 2902990 : if (spdk_unlikely(*cq_tailp(cq) == cq->size)) {
613 : 11323 : *cq_tailp(cq) = 0;
614 [ - + ]: 11323 : cq->phase = !cq->phase;
615 : : }
616 : 2902990 : }
617 : :
618 : : static bool
619 : 2816 : io_q_exists(struct nvmf_vfio_user_ctrlr *vu_ctrlr, const uint16_t qid, const bool is_cq)
620 : : {
621 [ - + ]: 2816 : assert(vu_ctrlr != NULL);
622 : :
623 [ + + + + ]: 2816 : if (qid == 0 || qid >= NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR) {
624 : 1888 : return false;
625 : : }
626 : :
627 [ + + ]: 928 : if (is_cq) {
628 [ + + ]: 555 : if (vu_ctrlr->cqs[qid] == NULL) {
629 : 189 : return false;
630 : : }
631 : :
632 [ + + ]: 727 : return (vu_ctrlr->cqs[qid]->cq_state != VFIO_USER_CQ_DELETED &&
633 [ + + ]: 361 : vu_ctrlr->cqs[qid]->cq_state != VFIO_USER_CQ_UNUSED);
634 : : }
635 : :
636 [ + + ]: 373 : if (vu_ctrlr->sqs[qid] == NULL) {
637 : 189 : return false;
638 : : }
639 : :
640 [ + + ]: 353 : return (vu_ctrlr->sqs[qid]->sq_state != VFIO_USER_SQ_DELETED &&
641 [ + - ]: 169 : vu_ctrlr->sqs[qid]->sq_state != VFIO_USER_SQ_UNUSED);
642 : : }
643 : :
644 : : static char *
645 : 1436887 : endpoint_id(struct nvmf_vfio_user_endpoint *endpoint)
646 : : {
647 : 1436887 : return endpoint->trid.traddr;
648 : : }
649 : :
650 : : static char *
651 : 1436836 : ctrlr_id(struct nvmf_vfio_user_ctrlr *ctrlr)
652 : : {
653 [ + - - + ]: 1436836 : if (!ctrlr || !ctrlr->endpoint) {
654 : 0 : return "Null Ctrlr";
655 : : }
656 : :
657 : 1436836 : return endpoint_id(ctrlr->endpoint);
658 : : }
659 : :
660 : : /* Return the poll group for the admin queue of the controller. */
661 : : static inline struct nvmf_vfio_user_poll_group *
662 : 0 : ctrlr_to_poll_group(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
663 : : {
664 : 0 : return SPDK_CONTAINEROF(vu_ctrlr->sqs[0]->group,
665 : : struct nvmf_vfio_user_poll_group,
666 : : group);
667 : : }
668 : :
669 : : static inline struct spdk_thread *
670 : 942 : poll_group_to_thread(struct nvmf_vfio_user_poll_group *vu_pg)
671 : : {
672 : 942 : return vu_pg->group.group->thread;
673 : : }
674 : :
675 : : static dma_sg_t *
676 : 4105276 : index_to_sg_t(void *arr, size_t i)
677 : : {
678 : 4105276 : return (dma_sg_t *)((uintptr_t)arr + i * dma_sg_size());
679 : : }
680 : :
681 : : static inline size_t
682 : 85 : vfio_user_migr_data_len(void)
683 : : {
684 : 85 : return SPDK_ALIGN_CEIL(sizeof(struct vfio_user_nvme_migr_state), PAGE_SIZE);
685 : : }
686 : :
687 : : static inline bool
688 : 514 : in_interrupt_mode(struct nvmf_vfio_user_transport *vu_transport)
689 : : {
690 [ + + ]: 522 : return spdk_interrupt_mode_is_enabled() &&
691 [ - + + - ]: 8 : vu_transport->intr_mode_supported;
692 : : }
693 : :
694 : : static int vfio_user_ctrlr_intr(void *ctx);
695 : :
696 : : static void
697 : 0 : vfio_user_msg_ctrlr_intr(void *ctx)
698 : : {
699 : 0 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = ctx;
700 : 0 : struct nvmf_vfio_user_poll_group *vu_ctrlr_group = ctrlr_to_poll_group(vu_ctrlr);
701 : :
702 : 0 : vu_ctrlr_group->stats.ctrlr_kicks++;
703 : :
704 : 0 : vfio_user_ctrlr_intr(ctx);
705 : 0 : }
706 : :
707 : : /*
708 : : * Kick (force a wakeup) of all poll groups for this controller.
709 : : * vfio_user_ctrlr_intr() itself arranges for kicking other poll groups if
710 : : * needed.
711 : : */
712 : : static void
713 : 0 : ctrlr_kick(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
714 : : {
715 : : struct nvmf_vfio_user_poll_group *vu_ctrlr_group;
716 : :
717 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db, "%s: kicked\n", ctrlr_id(vu_ctrlr));
718 : :
719 : 0 : vu_ctrlr_group = ctrlr_to_poll_group(vu_ctrlr);
720 : :
721 : 0 : spdk_thread_send_msg(poll_group_to_thread(vu_ctrlr_group),
722 : : vfio_user_msg_ctrlr_intr, vu_ctrlr);
723 : 0 : }
724 : :
725 : : /*
726 : : * Make the given DMA address and length available (locally mapped) via iov.
727 : : */
728 : : static void *
729 : 2423598 : map_one(vfu_ctx_t *ctx, uint64_t addr, uint64_t len, dma_sg_t *sg,
730 : : struct iovec *iov, int32_t flags)
731 : : {
732 : 2423598 : int prot = PROT_READ;
733 : : int ret;
734 : :
735 [ + + ]: 2423598 : if (flags & MAP_RW) {
736 : 2421253 : prot |= PROT_WRITE;
737 : : }
738 : :
739 [ - + ]: 2423598 : assert(ctx != NULL);
740 [ - + ]: 2423598 : assert(sg != NULL);
741 [ - + ]: 2423598 : assert(iov != NULL);
742 : :
743 : 2423598 : ret = vfu_addr_to_sgl(ctx, (void *)(uintptr_t)addr, len, sg, 1, prot);
744 [ + + ]: 2423598 : if (ret < 0) {
745 [ + - ]: 705786 : if (ret == -1) {
746 [ + + ]: 705786 : if (!(flags & MAP_QUIET)) {
747 : 705736 : SPDK_ERRLOG("failed to translate IOVA [%#lx, %#lx) (prot=%d) to local VA: %m\n",
748 : : addr, addr + len, prot);
749 : : }
750 : : } else {
751 : 0 : SPDK_ERRLOG("failed to translate IOVA [%#lx, %#lx) (prot=%d) to local VA: %d segments needed\n",
752 : : addr, addr + len, prot, -(ret + 1));
753 : : }
754 : 705786 : return NULL;
755 : : }
756 : :
757 : 1717812 : ret = vfu_sgl_get(ctx, sg, iov, 1, 0);
758 [ - + ]: 1717812 : if (ret != 0) {
759 : 0 : SPDK_ERRLOG("failed to get iovec for IOVA [%#lx, %#lx): %m\n",
760 : : addr, addr + len);
761 : 0 : return NULL;
762 : : }
763 : :
764 [ - + ]: 1717812 : assert(iov->iov_base != NULL);
765 : 1717812 : return iov->iov_base;
766 : : }
767 : :
768 : : static int
769 : 715962 : nvme_cmd_map_prps(void *prv, struct spdk_nvme_cmd *cmd, struct iovec *iovs,
770 : : uint32_t max_iovcnt, uint32_t len, size_t mps,
771 : : void *(*gpa_to_vva)(void *prv, uint64_t addr, uint64_t len, uint32_t flags))
772 : : {
773 : : uint64_t prp1, prp2;
774 : : void *vva;
775 : : uint32_t i;
776 : : uint32_t residue_len, nents;
777 : : uint64_t *prp_list;
778 : : uint32_t iovcnt;
779 : :
780 [ - + ]: 715962 : assert(max_iovcnt > 0);
781 : :
782 : 715962 : prp1 = cmd->dptr.prp.prp1;
783 : 715962 : prp2 = cmd->dptr.prp.prp2;
784 : :
785 : : /* PRP1 may started with unaligned page address */
786 [ - + ]: 715962 : residue_len = mps - (prp1 % mps);
787 : 715962 : residue_len = spdk_min(len, residue_len);
788 : :
789 : 715962 : vva = gpa_to_vva(prv, prp1, residue_len, MAP_RW);
790 [ + + ]: 715962 : if (spdk_unlikely(vva == NULL)) {
791 : 705736 : SPDK_ERRLOG("GPA to VVA failed\n");
792 : 705736 : return -EINVAL;
793 : : }
794 : 10226 : len -= residue_len;
795 [ + + - + ]: 10226 : if (len && max_iovcnt < 2) {
796 : 0 : SPDK_ERRLOG("Too many page entries, at least two iovs are required\n");
797 : 0 : return -ERANGE;
798 : : }
799 : 10226 : iovs[0].iov_base = vva;
800 : 10226 : iovs[0].iov_len = residue_len;
801 : :
802 [ + + ]: 10226 : if (len) {
803 [ + + ]: 4158 : if (spdk_unlikely(prp2 == 0)) {
804 : 1 : SPDK_ERRLOG("no PRP2, %d remaining\n", len);
805 : 1 : return -EINVAL;
806 : : }
807 : :
808 [ + + ]: 4157 : if (len <= mps) {
809 : : /* 2 PRP used */
810 : 2154 : iovcnt = 2;
811 : 2154 : vva = gpa_to_vva(prv, prp2, len, MAP_RW);
812 [ - + ]: 2154 : if (spdk_unlikely(vva == NULL)) {
813 : 0 : SPDK_ERRLOG("no VVA for %#" PRIx64 ", len%#x\n",
814 : : prp2, len);
815 : 0 : return -EINVAL;
816 : : }
817 : 2154 : iovs[1].iov_base = vva;
818 : 2154 : iovs[1].iov_len = len;
819 : : } else {
820 : : /* PRP list used */
821 [ - + ]: 2003 : nents = (len + mps - 1) / mps;
822 [ - + ]: 2003 : if (spdk_unlikely(nents + 1 > max_iovcnt)) {
823 : 0 : SPDK_ERRLOG("Too many page entries\n");
824 : 0 : return -ERANGE;
825 : : }
826 : :
827 : 2003 : vva = gpa_to_vva(prv, prp2, nents * sizeof(*prp_list), MAP_R);
828 [ - + ]: 2003 : if (spdk_unlikely(vva == NULL)) {
829 : 0 : SPDK_ERRLOG("no VVA for %#" PRIx64 ", nents=%#x\n",
830 : : prp2, nents);
831 : 0 : return -EINVAL;
832 : : }
833 : 2003 : prp_list = vva;
834 : 2003 : i = 0;
835 [ + + ]: 32725 : while (len != 0) {
836 : 30722 : residue_len = spdk_min(len, mps);
837 : 30722 : vva = gpa_to_vva(prv, prp_list[i], residue_len, MAP_RW);
838 [ - + ]: 30722 : if (spdk_unlikely(vva == NULL)) {
839 : 0 : SPDK_ERRLOG("no VVA for %#" PRIx64 ", residue_len=%#x\n",
840 : : prp_list[i], residue_len);
841 : 0 : return -EINVAL;
842 : : }
843 : 30722 : iovs[i + 1].iov_base = vva;
844 : 30722 : iovs[i + 1].iov_len = residue_len;
845 : 30722 : len -= residue_len;
846 : 30722 : i++;
847 : : }
848 : 2003 : iovcnt = i + 1;
849 : : }
850 : : } else {
851 : : /* 1 PRP used */
852 : 6068 : iovcnt = 1;
853 : : }
854 : :
855 [ - + ]: 10225 : assert(iovcnt <= max_iovcnt);
856 : 10225 : return iovcnt;
857 : : }
858 : :
859 : : static int
860 : 90 : nvme_cmd_map_sgls_data(void *prv, struct spdk_nvme_sgl_descriptor *sgls, uint32_t num_sgls,
861 : : struct iovec *iovs, uint32_t max_iovcnt,
862 : : void *(*gpa_to_vva)(void *prv, uint64_t addr, uint64_t len, uint32_t flags))
863 : : {
864 : : uint32_t i;
865 : : void *vva;
866 : :
867 [ - + ]: 90 : if (spdk_unlikely(max_iovcnt < num_sgls)) {
868 : 0 : return -ERANGE;
869 : : }
870 : :
871 [ + + ]: 293 : for (i = 0; i < num_sgls; i++) {
872 [ - + ]: 203 : if (spdk_unlikely(sgls[i].unkeyed.type != SPDK_NVME_SGL_TYPE_DATA_BLOCK)) {
873 : 0 : SPDK_ERRLOG("Invalid SGL type %u\n", sgls[i].unkeyed.type);
874 : 0 : return -EINVAL;
875 : : }
876 : 203 : vva = gpa_to_vva(prv, sgls[i].address, sgls[i].unkeyed.length, MAP_RW);
877 [ - + ]: 203 : if (spdk_unlikely(vva == NULL)) {
878 : 0 : SPDK_ERRLOG("GPA to VVA failed\n");
879 : 0 : return -EINVAL;
880 : : }
881 : 203 : iovs[i].iov_base = vva;
882 : 203 : iovs[i].iov_len = sgls[i].unkeyed.length;
883 : : }
884 : :
885 : 90 : return num_sgls;
886 : : }
887 : :
888 : : static int
889 : 1672003 : nvme_cmd_map_sgls(void *prv, struct spdk_nvme_cmd *cmd, struct iovec *iovs, uint32_t max_iovcnt,
890 : : uint32_t len, size_t mps,
891 : : void *(*gpa_to_vva)(void *prv, uint64_t addr, uint64_t len, uint32_t flags))
892 : : {
893 : : struct spdk_nvme_sgl_descriptor *sgl, *last_sgl;
894 : : uint32_t num_sgls, seg_len;
895 : : void *vva;
896 : : int ret;
897 : 1672003 : uint32_t total_iovcnt = 0;
898 : :
899 : : /* SGL cases */
900 : 1672003 : sgl = &cmd->dptr.sgl1;
901 : :
902 : : /* only one SGL segment */
903 [ + + ]: 1672003 : if (sgl->unkeyed.type == SPDK_NVME_SGL_TYPE_DATA_BLOCK) {
904 [ - + ]: 1671913 : assert(max_iovcnt > 0);
905 : 1671913 : vva = gpa_to_vva(prv, sgl->address, sgl->unkeyed.length, MAP_RW);
906 [ - + ]: 1671913 : if (spdk_unlikely(vva == NULL)) {
907 : 0 : SPDK_ERRLOG("GPA to VVA failed\n");
908 : 0 : return -EINVAL;
909 : : }
910 : 1671913 : iovs[0].iov_base = vva;
911 : 1671913 : iovs[0].iov_len = sgl->unkeyed.length;
912 [ - + ]: 1671913 : assert(sgl->unkeyed.length == len);
913 : :
914 : 1671913 : return 1;
915 : : }
916 : :
917 : : for (;;) {
918 [ + - - + ]: 90 : if (spdk_unlikely((sgl->unkeyed.type != SPDK_NVME_SGL_TYPE_SEGMENT) &&
919 : : (sgl->unkeyed.type != SPDK_NVME_SGL_TYPE_LAST_SEGMENT))) {
920 : 0 : SPDK_ERRLOG("Invalid SGL type %u\n", sgl->unkeyed.type);
921 : 0 : return -EINVAL;
922 : : }
923 : :
924 : 90 : seg_len = sgl->unkeyed.length;
925 [ - + ]: 90 : if (spdk_unlikely(seg_len % sizeof(struct spdk_nvme_sgl_descriptor))) {
926 : 0 : SPDK_ERRLOG("Invalid SGL segment len %u\n", seg_len);
927 : 0 : return -EINVAL;
928 : : }
929 : :
930 : 90 : num_sgls = seg_len / sizeof(struct spdk_nvme_sgl_descriptor);
931 : 90 : vva = gpa_to_vva(prv, sgl->address, sgl->unkeyed.length, MAP_R);
932 [ - + ]: 90 : if (spdk_unlikely(vva == NULL)) {
933 : 0 : SPDK_ERRLOG("GPA to VVA failed\n");
934 : 0 : return -EINVAL;
935 : : }
936 : :
937 : : /* sgl point to the first segment */
938 : 90 : sgl = (struct spdk_nvme_sgl_descriptor *)vva;
939 : 90 : last_sgl = &sgl[num_sgls - 1];
940 : :
941 : : /* we are done */
942 [ + - ]: 90 : if (last_sgl->unkeyed.type == SPDK_NVME_SGL_TYPE_DATA_BLOCK) {
943 : : /* map whole sgl list */
944 : 90 : ret = nvme_cmd_map_sgls_data(prv, sgl, num_sgls, &iovs[total_iovcnt],
945 : : max_iovcnt - total_iovcnt, gpa_to_vva);
946 [ - + ]: 90 : if (spdk_unlikely(ret < 0)) {
947 : 0 : return ret;
948 : : }
949 : 90 : total_iovcnt += ret;
950 : :
951 : 90 : return total_iovcnt;
952 : : }
953 : :
954 [ # # ]: 0 : if (num_sgls > 1) {
955 : : /* map whole sgl exclude last_sgl */
956 : 0 : ret = nvme_cmd_map_sgls_data(prv, sgl, num_sgls - 1, &iovs[total_iovcnt],
957 : : max_iovcnt - total_iovcnt, gpa_to_vva);
958 [ # # ]: 0 : if (spdk_unlikely(ret < 0)) {
959 : 0 : return ret;
960 : : }
961 : 0 : total_iovcnt += ret;
962 : : }
963 : :
964 : : /* move to next level's segments */
965 : 0 : sgl = last_sgl;
966 : : }
967 : :
968 : : return 0;
969 : : }
970 : :
971 : : static int
972 : 2387965 : nvme_map_cmd(void *prv, struct spdk_nvme_cmd *cmd, struct iovec *iovs, uint32_t max_iovcnt,
973 : : uint32_t len, size_t mps,
974 : : void *(*gpa_to_vva)(void *prv, uint64_t addr, uint64_t len, uint32_t flags))
975 : : {
976 [ + + ]: 2387965 : if (cmd->psdt == SPDK_NVME_PSDT_PRP) {
977 : 715962 : return nvme_cmd_map_prps(prv, cmd, iovs, max_iovcnt, len, mps, gpa_to_vva);
978 : : }
979 : :
980 : 1672003 : return nvme_cmd_map_sgls(prv, cmd, iovs, max_iovcnt, len, mps, gpa_to_vva);
981 : : }
982 : :
983 : : /*
984 : : * For each queue, update the location of its doorbell to the correct location:
985 : : * either our own BAR0, or the guest's configured shadow doorbell area.
986 : : *
987 : : * The Admin queue (qid: 0) does not ever use shadow doorbells.
988 : : */
989 : : static void
990 : 49 : vfio_user_ctrlr_switch_doorbells(struct nvmf_vfio_user_ctrlr *ctrlr, bool shadow)
991 : : {
992 [ - + ]: 49 : volatile uint32_t *doorbells = shadow ? ctrlr->sdbl->shadow_doorbells :
993 : : ctrlr->bar0_doorbells;
994 : :
995 [ - + ]: 49 : assert(doorbells != NULL);
996 : :
997 [ + + ]: 6272 : for (size_t i = 1; i < NVMF_VFIO_USER_DEFAULT_MAX_QPAIRS_PER_CTRLR; i++) {
998 : 6223 : struct nvmf_vfio_user_sq *sq = ctrlr->sqs[i];
999 : 6223 : struct nvmf_vfio_user_cq *cq = ctrlr->cqs[i];
1000 : :
1001 [ + + ]: 6223 : if (sq != NULL) {
1002 : 177 : sq->dbl_tailp = doorbells + queue_index(sq->qid, false);
1003 : :
1004 : 177 : ctrlr->sqs[i]->need_rearm = shadow;
1005 : : }
1006 : :
1007 [ + + ]: 6223 : if (cq != NULL) {
1008 : 176 : cq->dbl_headp = doorbells + queue_index(cq->qid, true);
1009 : : }
1010 : : }
1011 : 49 : }
1012 : :
1013 : : static void
1014 : 0 : unmap_sdbl(vfu_ctx_t *vfu_ctx, struct nvmf_vfio_user_shadow_doorbells *sdbl)
1015 : : {
1016 [ # # ]: 0 : assert(vfu_ctx != NULL);
1017 [ # # ]: 0 : assert(sdbl != NULL);
1018 : :
1019 : : /*
1020 : : * An allocation error would result in only one of the two being
1021 : : * non-NULL. If that is the case, no memory should have been mapped.
1022 : : */
1023 [ # # # # ]: 0 : if (sdbl->iovs == NULL || sdbl->sgs == NULL) {
1024 : 0 : return;
1025 : : }
1026 : :
1027 [ # # ]: 0 : for (size_t i = 0; i < NVMF_VFIO_USER_SHADOW_DOORBELLS_BUFFER_COUNT; ++i) {
1028 : : struct iovec *iov;
1029 : : dma_sg_t *sg;
1030 : :
1031 [ # # ]: 0 : if (!sdbl->iovs[i].iov_len) {
1032 : 0 : continue;
1033 : : }
1034 : :
1035 : 0 : sg = index_to_sg_t(sdbl->sgs, i);
1036 : 0 : iov = sdbl->iovs + i;
1037 : :
1038 : 0 : vfu_sgl_put(vfu_ctx, sg, iov, 1);
1039 : : }
1040 : : }
1041 : :
1042 : : static void
1043 : 96 : free_sdbl(vfu_ctx_t *vfu_ctx, struct nvmf_vfio_user_shadow_doorbells *sdbl)
1044 : : {
1045 [ + - ]: 96 : if (sdbl == NULL) {
1046 : 96 : return;
1047 : : }
1048 : :
1049 : 0 : unmap_sdbl(vfu_ctx, sdbl);
1050 : :
1051 : : /*
1052 : : * sdbl->shadow_doorbells and sdbl->eventidxs were mapped,
1053 : : * not allocated, so don't free() them.
1054 : : */
1055 : 0 : free(sdbl->sgs);
1056 : 0 : free(sdbl->iovs);
1057 : 0 : free(sdbl);
1058 : : }
1059 : :
1060 : : static struct nvmf_vfio_user_shadow_doorbells *
1061 : 0 : map_sdbl(vfu_ctx_t *vfu_ctx, uint64_t prp1, uint64_t prp2, size_t len)
1062 : : {
1063 : 0 : struct nvmf_vfio_user_shadow_doorbells *sdbl = NULL;
1064 : 0 : dma_sg_t *sg2 = NULL;
1065 : : void *p;
1066 : :
1067 [ # # ]: 0 : assert(vfu_ctx != NULL);
1068 : :
1069 : 0 : sdbl = calloc(1, sizeof(*sdbl));
1070 [ # # ]: 0 : if (sdbl == NULL) {
1071 : 0 : goto err;
1072 : : }
1073 : :
1074 : 0 : sdbl->sgs = calloc(NVMF_VFIO_USER_SHADOW_DOORBELLS_BUFFER_COUNT, dma_sg_size());
1075 : 0 : sdbl->iovs = calloc(NVMF_VFIO_USER_SHADOW_DOORBELLS_BUFFER_COUNT, sizeof(*sdbl->iovs));
1076 [ # # # # ]: 0 : if (sdbl->sgs == NULL || sdbl->iovs == NULL) {
1077 : 0 : goto err;
1078 : : }
1079 : :
1080 : : /* Map shadow doorbell buffer (PRP1). */
1081 : 0 : p = map_one(vfu_ctx, prp1, len, sdbl->sgs, sdbl->iovs, MAP_RW);
1082 : :
1083 [ # # ]: 0 : if (p == NULL) {
1084 : 0 : goto err;
1085 : : }
1086 : :
1087 : : /*
1088 : : * Map eventidx buffer (PRP2).
1089 : : * Should only be written to by the controller.
1090 : : */
1091 : :
1092 : 0 : sg2 = index_to_sg_t(sdbl->sgs, 1);
1093 : :
1094 : 0 : p = map_one(vfu_ctx, prp2, len, sg2, sdbl->iovs + 1, MAP_RW);
1095 : :
1096 [ # # ]: 0 : if (p == NULL) {
1097 : 0 : goto err;
1098 : : }
1099 : :
1100 : 0 : sdbl->shadow_doorbells = (uint32_t *)sdbl->iovs[0].iov_base;
1101 : 0 : sdbl->eventidxs = (uint32_t *)sdbl->iovs[1].iov_base;
1102 : :
1103 : 0 : return sdbl;
1104 : :
1105 : 0 : err:
1106 : 0 : free_sdbl(vfu_ctx, sdbl);
1107 : 0 : return NULL;
1108 : : }
1109 : :
1110 : : /*
1111 : : * Copy doorbells from one buffer to the other, during switches betweeen BAR0
1112 : : * doorbells and shadow doorbells.
1113 : : */
1114 : : static void
1115 : 0 : copy_doorbells(struct nvmf_vfio_user_ctrlr *ctrlr,
1116 : : const volatile uint32_t *from, volatile uint32_t *to)
1117 : : {
1118 [ # # ]: 0 : assert(ctrlr != NULL);
1119 [ # # ]: 0 : assert(from != NULL);
1120 [ # # ]: 0 : assert(to != NULL);
1121 : :
1122 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db,
1123 : : "%s: migrating shadow doorbells from %p to %p\n",
1124 : : ctrlr_id(ctrlr), from, to);
1125 : :
1126 : : /* Can't use memcpy because it doesn't respect volatile semantics. */
1127 [ # # ]: 0 : for (size_t i = 0; i < NVMF_VFIO_USER_DEFAULT_MAX_QPAIRS_PER_CTRLR; ++i) {
1128 [ # # ]: 0 : if (ctrlr->sqs[i] != NULL) {
1129 : 0 : to[queue_index(i, false)] = from[queue_index(i, false)];
1130 : : }
1131 : :
1132 [ # # ]: 0 : if (ctrlr->cqs[i] != NULL) {
1133 : 0 : to[queue_index(i, true)] = from[queue_index(i, true)];
1134 : : }
1135 : : }
1136 : 0 : }
1137 : :
1138 : : static void
1139 : 0 : fail_ctrlr(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
1140 : : {
1141 : : const struct spdk_nvmf_registers *regs;
1142 : :
1143 [ # # ]: 0 : assert(vu_ctrlr != NULL);
1144 [ # # ]: 0 : assert(vu_ctrlr->ctrlr != NULL);
1145 : :
1146 : 0 : regs = spdk_nvmf_ctrlr_get_regs(vu_ctrlr->ctrlr);
1147 [ # # ]: 0 : if (regs->csts.bits.cfs == 0) {
1148 : 0 : SPDK_ERRLOG(":%s failing controller\n", ctrlr_id(vu_ctrlr));
1149 : : }
1150 : :
1151 : 0 : nvmf_ctrlr_set_fatal_status(vu_ctrlr->ctrlr);
1152 : 0 : }
1153 : :
1154 : : static inline bool
1155 : 31324463 : ctrlr_interrupt_enabled(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
1156 : : {
1157 [ - + ]: 31324463 : assert(vu_ctrlr != NULL);
1158 [ - + ]: 31324463 : assert(vu_ctrlr->endpoint != NULL);
1159 : :
1160 : 31324463 : vfu_pci_config_space_t *pci = vu_ctrlr->endpoint->pci_config_space;
1161 : :
1162 [ + + + + ]: 31324463 : return (!pci->hdr.cmd.id || vu_ctrlr->endpoint->msix->mxc.mxe);
1163 : : }
1164 : :
1165 : : static void
1166 : 17 : nvmf_vfio_user_destroy_endpoint(struct nvmf_vfio_user_endpoint *endpoint)
1167 : : {
1168 [ - + - + ]: 17 : SPDK_DEBUGLOG(nvmf_vfio, "destroy endpoint %s\n", endpoint_id(endpoint));
1169 : :
1170 : 17 : spdk_interrupt_unregister(&endpoint->accept_intr);
1171 : 17 : spdk_poller_unregister(&endpoint->accept_poller);
1172 : :
1173 [ + - ]: 17 : if (endpoint->bar0_doorbells) {
1174 : 17 : munmap((void *)endpoint->bar0_doorbells, NVMF_VFIO_USER_DOORBELLS_SIZE);
1175 : : }
1176 : :
1177 [ + - ]: 17 : if (endpoint->devmem_fd > 0) {
1178 : 17 : close(endpoint->devmem_fd);
1179 : : }
1180 : :
1181 [ + - ]: 17 : if (endpoint->migr_data) {
1182 : 17 : munmap(endpoint->migr_data, vfio_user_migr_data_len());
1183 : : }
1184 : :
1185 [ + - ]: 17 : if (endpoint->migr_fd > 0) {
1186 : 17 : close(endpoint->migr_fd);
1187 : : }
1188 : :
1189 [ + - ]: 17 : if (endpoint->vfu_ctx) {
1190 : 17 : vfu_destroy_ctx(endpoint->vfu_ctx);
1191 : : }
1192 : :
1193 [ - + ]: 17 : pthread_mutex_destroy(&endpoint->lock);
1194 : 17 : free(endpoint);
1195 : 17 : }
1196 : :
1197 : : /* called when process exits */
1198 : : static int
1199 : 7 : nvmf_vfio_user_destroy(struct spdk_nvmf_transport *transport,
1200 : : spdk_nvmf_transport_destroy_done_cb cb_fn, void *cb_arg)
1201 : : {
1202 : : struct nvmf_vfio_user_transport *vu_transport;
1203 : : struct nvmf_vfio_user_endpoint *endpoint, *tmp;
1204 : :
1205 [ - + - + ]: 7 : SPDK_DEBUGLOG(nvmf_vfio, "destroy transport\n");
1206 : :
1207 : 7 : vu_transport = SPDK_CONTAINEROF(transport, struct nvmf_vfio_user_transport,
1208 : : transport);
1209 : :
1210 [ - + ]: 7 : pthread_mutex_destroy(&vu_transport->lock);
1211 [ - + ]: 7 : pthread_mutex_destroy(&vu_transport->pg_lock);
1212 : :
1213 [ - + ]: 7 : TAILQ_FOREACH_SAFE(endpoint, &vu_transport->endpoints, link, tmp) {
1214 [ # # ]: 0 : TAILQ_REMOVE(&vu_transport->endpoints, endpoint, link);
1215 : 0 : nvmf_vfio_user_destroy_endpoint(endpoint);
1216 : : }
1217 : :
1218 : 7 : free(vu_transport);
1219 : :
1220 [ + - ]: 7 : if (cb_fn) {
1221 : 7 : cb_fn(cb_arg);
1222 : : }
1223 : :
1224 : 7 : return 0;
1225 : : }
1226 : :
1227 : : static const struct spdk_json_object_decoder vfio_user_transport_opts_decoder[] = {
1228 : : {
1229 : : "disable_mappable_bar0",
1230 : : offsetof(struct nvmf_vfio_user_transport, transport_opts.disable_mappable_bar0),
1231 : : spdk_json_decode_bool, true
1232 : : },
1233 : : {
1234 : : "disable_adaptive_irq",
1235 : : offsetof(struct nvmf_vfio_user_transport, transport_opts.disable_adaptive_irq),
1236 : : spdk_json_decode_bool, true
1237 : : },
1238 : : {
1239 : : "disable_shadow_doorbells",
1240 : : offsetof(struct nvmf_vfio_user_transport, transport_opts.disable_shadow_doorbells),
1241 : : spdk_json_decode_bool, true
1242 : : },
1243 : : {
1244 : : "disable_compare",
1245 : : offsetof(struct nvmf_vfio_user_transport, transport_opts.disable_compare),
1246 : : spdk_json_decode_bool, true
1247 : : },
1248 : : {
1249 : : "enable_intr_mode_sq_spreading",
1250 : : offsetof(struct nvmf_vfio_user_transport, transport_opts.enable_intr_mode_sq_spreading),
1251 : : spdk_json_decode_bool, true
1252 : : },
1253 : : };
1254 : :
1255 : : static struct spdk_nvmf_transport *
1256 : 7 : nvmf_vfio_user_create(struct spdk_nvmf_transport_opts *opts)
1257 : : {
1258 : : struct nvmf_vfio_user_transport *vu_transport;
1259 : : int err;
1260 : :
1261 [ - + ]: 7 : if (opts->max_qpairs_per_ctrlr > NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR) {
1262 : 0 : SPDK_ERRLOG("Invalid max_qpairs_per_ctrlr=%d, supported max_qpairs_per_ctrlr=%d\n",
1263 : : opts->max_qpairs_per_ctrlr, NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR);
1264 : 0 : return NULL;
1265 : : }
1266 : :
1267 : 7 : vu_transport = calloc(1, sizeof(*vu_transport));
1268 [ - + ]: 7 : if (vu_transport == NULL) {
1269 : 0 : SPDK_ERRLOG("Transport alloc fail: %m\n");
1270 : 0 : return NULL;
1271 : : }
1272 : :
1273 [ - + ]: 7 : err = pthread_mutex_init(&vu_transport->lock, NULL);
1274 [ - + ]: 7 : if (err != 0) {
1275 : 0 : SPDK_ERRLOG("Pthread initialisation failed (%d)\n", err);
1276 : 0 : goto err;
1277 : : }
1278 : 7 : TAILQ_INIT(&vu_transport->endpoints);
1279 : :
1280 [ - + ]: 7 : err = pthread_mutex_init(&vu_transport->pg_lock, NULL);
1281 [ - + ]: 7 : if (err != 0) {
1282 [ # # ]: 0 : pthread_mutex_destroy(&vu_transport->lock);
1283 : 0 : SPDK_ERRLOG("Pthread initialisation failed (%d)\n", err);
1284 : 0 : goto err;
1285 : : }
1286 : 7 : TAILQ_INIT(&vu_transport->poll_groups);
1287 : :
1288 [ + - - + ]: 14 : if (opts->transport_specific != NULL &&
1289 : 7 : spdk_json_decode_object_relaxed(opts->transport_specific, vfio_user_transport_opts_decoder,
1290 : : SPDK_COUNTOF(vfio_user_transport_opts_decoder),
1291 : : vu_transport)) {
1292 : 0 : SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n");
1293 : 0 : goto cleanup;
1294 : : }
1295 : :
1296 : : /*
1297 : : * To support interrupt mode, the transport must be configured with
1298 : : * mappable BAR0 disabled: we need a vfio-user message to wake us up
1299 : : * when a client writes new doorbell values to BAR0, via the
1300 : : * libvfio-user socket fd.
1301 : : */
1302 : 7 : vu_transport->intr_mode_supported =
1303 [ - + ]: 7 : vu_transport->transport_opts.disable_mappable_bar0;
1304 : :
1305 : : /*
1306 : : * If BAR0 is mappable, it doesn't make sense to support shadow
1307 : : * doorbells, so explicitly turn it off.
1308 : : */
1309 [ - + + + ]: 7 : if (!vu_transport->transport_opts.disable_mappable_bar0) {
1310 : 6 : vu_transport->transport_opts.disable_shadow_doorbells = true;
1311 : : }
1312 : :
1313 [ + + ]: 7 : if (spdk_interrupt_mode_is_enabled()) {
1314 [ - + - + ]: 1 : if (!vu_transport->intr_mode_supported) {
1315 : 0 : SPDK_ERRLOG("interrupt mode not supported\n");
1316 : 0 : goto cleanup;
1317 : : }
1318 : :
1319 : : /*
1320 : : * If we are in interrupt mode, we cannot support adaptive IRQs,
1321 : : * as there is no guarantee the SQ poller will run subsequently
1322 : : * to send pending IRQs.
1323 : : */
1324 : 1 : vu_transport->transport_opts.disable_adaptive_irq = true;
1325 : : }
1326 : :
1327 [ - + - + : 7 : SPDK_DEBUGLOG(nvmf_vfio, "vfio_user transport: disable_mappable_bar0=%d\n",
- - ]
1328 : : vu_transport->transport_opts.disable_mappable_bar0);
1329 [ - + - + : 7 : SPDK_DEBUGLOG(nvmf_vfio, "vfio_user transport: disable_adaptive_irq=%d\n",
- - ]
1330 : : vu_transport->transport_opts.disable_adaptive_irq);
1331 [ - + - + : 7 : SPDK_DEBUGLOG(nvmf_vfio, "vfio_user transport: disable_shadow_doorbells=%d\n",
- - ]
1332 : : vu_transport->transport_opts.disable_shadow_doorbells);
1333 : :
1334 : 7 : return &vu_transport->transport;
1335 : :
1336 : 0 : cleanup:
1337 [ # # ]: 0 : pthread_mutex_destroy(&vu_transport->lock);
1338 [ # # ]: 0 : pthread_mutex_destroy(&vu_transport->pg_lock);
1339 : 0 : err:
1340 : 0 : free(vu_transport);
1341 : 0 : return NULL;
1342 : : }
1343 : :
1344 : : static uint32_t
1345 : 386 : max_queue_size(struct nvmf_vfio_user_ctrlr const *vu_ctrlr)
1346 : : {
1347 [ - + ]: 386 : assert(vu_ctrlr != NULL);
1348 [ - + ]: 386 : assert(vu_ctrlr->ctrlr != NULL);
1349 : :
1350 : 386 : return vu_ctrlr->ctrlr->vcprop.cap.bits.mqes + 1;
1351 : : }
1352 : :
1353 : : static uint32_t
1354 : 0 : doorbell_stride(const struct nvmf_vfio_user_ctrlr *vu_ctrlr)
1355 : : {
1356 [ # # ]: 0 : assert(vu_ctrlr != NULL);
1357 [ # # ]: 0 : assert(vu_ctrlr->ctrlr != NULL);
1358 : :
1359 : 0 : return vu_ctrlr->ctrlr->vcprop.cap.bits.dstrd;
1360 : : }
1361 : :
1362 : : static uintptr_t
1363 : 0 : memory_page_size(const struct nvmf_vfio_user_ctrlr *vu_ctrlr)
1364 : : {
1365 : 0 : uint32_t memory_page_shift = vu_ctrlr->ctrlr->vcprop.cc.bits.mps + 12;
1366 [ # # ]: 0 : return 1ul << memory_page_shift;
1367 : : }
1368 : :
1369 : : static uintptr_t
1370 : 0 : memory_page_mask(const struct nvmf_vfio_user_ctrlr *ctrlr)
1371 : : {
1372 : 0 : return ~(memory_page_size(ctrlr) - 1);
1373 : : }
1374 : :
1375 : : static int
1376 : 551 : map_q(struct nvmf_vfio_user_ctrlr *vu_ctrlr, struct nvme_q_mapping *mapping,
1377 : : uint32_t flags)
1378 : : {
1379 : : void *ret;
1380 : :
1381 [ - + ]: 551 : assert(mapping->len != 0);
1382 [ - + ]: 551 : assert(q_addr(mapping) == NULL);
1383 : :
1384 : 551 : ret = map_one(vu_ctrlr->endpoint->vfu_ctx, mapping->prp1, mapping->len,
1385 : : mapping->sg, &mapping->iov, flags);
1386 [ + + ]: 551 : if (ret == NULL) {
1387 : 50 : return -EFAULT;
1388 : : }
1389 : :
1390 [ + + ]: 501 : if (flags & MAP_INITIALIZE) {
1391 [ - + ]: 481 : memset(q_addr(mapping), 0, mapping->len);
1392 : : }
1393 : :
1394 : 501 : return 0;
1395 : : }
1396 : :
1397 : : static inline void
1398 : 1024 : unmap_q(struct nvmf_vfio_user_ctrlr *vu_ctrlr, struct nvme_q_mapping *mapping)
1399 : : {
1400 [ + + ]: 1024 : if (q_addr(mapping) != NULL) {
1401 : 501 : vfu_sgl_put(vu_ctrlr->endpoint->vfu_ctx, mapping->sg,
1402 : : &mapping->iov, 1);
1403 : 501 : mapping->iov.iov_base = NULL;
1404 : : }
1405 : 1024 : }
1406 : :
1407 : : static int
1408 : 52 : asq_setup(struct nvmf_vfio_user_ctrlr *ctrlr)
1409 : : {
1410 : : struct nvmf_vfio_user_sq *sq;
1411 : : const struct spdk_nvmf_registers *regs;
1412 : : int ret;
1413 : :
1414 [ - + ]: 52 : assert(ctrlr != NULL);
1415 : :
1416 : 52 : sq = ctrlr->sqs[0];
1417 : :
1418 [ - + ]: 52 : assert(sq != NULL);
1419 [ - + ]: 52 : assert(q_addr(&sq->mapping) == NULL);
1420 : : /* XXX ctrlr->asq == 0 is a valid memory address */
1421 : :
1422 : 52 : regs = spdk_nvmf_ctrlr_get_regs(ctrlr->ctrlr);
1423 : 52 : sq->qid = 0;
1424 : 52 : sq->size = regs->aqa.bits.asqs + 1;
1425 : 52 : sq->mapping.prp1 = regs->asq;
1426 : 52 : sq->mapping.len = sq->size * sizeof(struct spdk_nvme_cmd);
1427 : 52 : *sq_headp(sq) = 0;
1428 : 52 : sq->cqid = 0;
1429 : :
1430 : 52 : ret = map_q(ctrlr, &sq->mapping, MAP_INITIALIZE);
1431 [ - + ]: 52 : if (ret) {
1432 : 0 : return ret;
1433 : : }
1434 : :
1435 : : /* The Admin queue (qid: 0) does not ever use shadow doorbells. */
1436 : 52 : sq->dbl_tailp = ctrlr->bar0_doorbells + queue_index(0, false);
1437 : :
1438 : 52 : *sq_dbl_tailp(sq) = 0;
1439 : :
1440 : 52 : return 0;
1441 : : }
1442 : :
1443 : : /*
1444 : : * Updates eventidx to set an SQ into interrupt or polling mode.
1445 : : *
1446 : : * Returns false if the current SQ tail does not match the SQ head, as
1447 : : * this means that the host has submitted more items to the queue while we were
1448 : : * not looking - or during the event index update. In that case, we must retry,
1449 : : * or otherwise make sure we are going to wake up again.
1450 : : */
1451 : : static bool
1452 : 0 : set_sq_eventidx(struct nvmf_vfio_user_sq *sq)
1453 : : {
1454 : : struct nvmf_vfio_user_ctrlr *ctrlr;
1455 : : volatile uint32_t *sq_tail_eidx;
1456 : : uint32_t old_tail, new_tail;
1457 : :
1458 [ # # ]: 0 : assert(sq != NULL);
1459 [ # # ]: 0 : assert(sq->ctrlr != NULL);
1460 [ # # ]: 0 : assert(sq->ctrlr->sdbl != NULL);
1461 [ # # # # ]: 0 : assert(sq->need_rearm);
1462 [ # # ]: 0 : assert(sq->qid != 0);
1463 : :
1464 : 0 : ctrlr = sq->ctrlr;
1465 : :
1466 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db, "%s: updating eventidx of sqid:%u\n",
1467 : : ctrlr_id(ctrlr), sq->qid);
1468 : :
1469 : 0 : sq_tail_eidx = ctrlr->sdbl->eventidxs + queue_index(sq->qid, false);
1470 : :
1471 [ # # ]: 0 : assert(ctrlr->endpoint != NULL);
1472 : :
1473 [ # # # # ]: 0 : if (!ctrlr->endpoint->interrupt_mode) {
1474 : : /* No synchronisation necessary. */
1475 : 0 : *sq_tail_eidx = NVMF_VFIO_USER_EVENTIDX_POLL;
1476 : 0 : return true;
1477 : : }
1478 : :
1479 : 0 : old_tail = *sq_dbl_tailp(sq);
1480 : 0 : *sq_tail_eidx = old_tail;
1481 : :
1482 : : /*
1483 : : * Ensure that the event index is updated before re-reading the tail
1484 : : * doorbell. If it's not, then the host might race us and update the
1485 : : * tail after the second read but before the event index is written, so
1486 : : * it won't write to BAR0 and we'll miss the update.
1487 : : *
1488 : : * The driver should provide similar ordering with an mb().
1489 : : */
1490 : 0 : spdk_mb();
1491 : :
1492 : : /*
1493 : : * Check if the host has updated the tail doorbell after we've read it
1494 : : * for the first time, but before the event index was written. If that's
1495 : : * the case, then we've lost the race and we need to update the event
1496 : : * index again (after polling the queue, since the host won't write to
1497 : : * BAR0).
1498 : : */
1499 : 0 : new_tail = *sq_dbl_tailp(sq);
1500 : :
1501 : : /*
1502 : : * We might poll the queue straight after this function returns if the
1503 : : * tail has been updated, so we need to ensure that any changes to the
1504 : : * queue will be visible to us if the doorbell has been updated.
1505 : : *
1506 : : * The driver should provide similar ordering with a wmb() to ensure
1507 : : * that the queue is written before it updates the tail doorbell.
1508 : : */
1509 : 0 : spdk_rmb();
1510 : :
1511 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db, "%s: sqid:%u, old_tail=%u, new_tail=%u, "
1512 : : "sq_head=%u\n", ctrlr_id(ctrlr), sq->qid, old_tail,
1513 : : new_tail, *sq_headp(sq));
1514 : :
1515 [ # # ]: 0 : if (new_tail == *sq_headp(sq)) {
1516 : 0 : sq->need_rearm = false;
1517 : 0 : return true;
1518 : : }
1519 : :
1520 : : /*
1521 : : * We've lost the race: the tail was updated since we last polled,
1522 : : * including if it happened within this routine.
1523 : : *
1524 : : * The caller should retry after polling (think of this as a cmpxchg
1525 : : * loop); if we go to sleep while the SQ is not empty, then we won't
1526 : : * process the remaining events.
1527 : : */
1528 : 0 : return false;
1529 : : }
1530 : :
1531 : : static int nvmf_vfio_user_sq_poll(struct nvmf_vfio_user_sq *sq);
1532 : :
1533 : : /*
1534 : : * Arrange for an SQ to interrupt us if written. Returns non-zero if we
1535 : : * processed some SQ entries.
1536 : : */
1537 : : static int
1538 : 0 : vfio_user_sq_rearm(struct nvmf_vfio_user_ctrlr *ctrlr,
1539 : : struct nvmf_vfio_user_sq *sq,
1540 : : struct nvmf_vfio_user_poll_group *vu_group)
1541 : : {
1542 : 0 : int count = 0;
1543 : : size_t i;
1544 : :
1545 [ # # # # ]: 0 : assert(sq->need_rearm);
1546 : :
1547 [ # # ]: 0 : for (i = 0; i < NVMF_VFIO_USER_SET_EVENTIDX_MAX_ATTEMPTS; i++) {
1548 : : int ret;
1549 : :
1550 [ # # ]: 0 : if (set_sq_eventidx(sq)) {
1551 : : /* We won the race and set eventidx; done. */
1552 : 0 : vu_group->stats.won++;
1553 : 0 : return count;
1554 : : }
1555 : :
1556 : 0 : ret = nvmf_vfio_user_sq_poll(sq);
1557 : :
1558 [ # # ]: 0 : count += (ret < 0) ? 1 : ret;
1559 : :
1560 : : /*
1561 : : * set_sq_eventidx() hit the race, so we expected
1562 : : * to process at least one command from this queue.
1563 : : * If there were no new commands waiting for us, then
1564 : : * we must have hit an unexpected race condition.
1565 : : */
1566 [ # # ]: 0 : if (ret == 0) {
1567 : 0 : SPDK_ERRLOG("%s: unexpected race condition detected "
1568 : : "while updating the shadow doorbell buffer\n",
1569 : : ctrlr_id(ctrlr));
1570 : :
1571 : 0 : fail_ctrlr(ctrlr);
1572 : 0 : return count;
1573 : : }
1574 : : }
1575 : :
1576 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db,
1577 : : "%s: set_sq_eventidx() lost the race %zu times\n",
1578 : : ctrlr_id(ctrlr), i);
1579 : :
1580 : 0 : vu_group->stats.lost++;
1581 : 0 : vu_group->stats.lost_count += count;
1582 : :
1583 : : /*
1584 : : * We couldn't arrange an eventidx guaranteed to cause a BAR0 write, as
1585 : : * we raced with the producer too many times; force ourselves to wake up
1586 : : * instead. We'll process all queues at that point.
1587 : : */
1588 : 0 : ctrlr_kick(ctrlr);
1589 : :
1590 : 0 : return count;
1591 : : }
1592 : :
1593 : : /*
1594 : : * We're in interrupt mode, and potentially about to go to sleep. We need to
1595 : : * make sure any further I/O submissions are guaranteed to wake us up: for
1596 : : * shadow doorbells that means we may need to go through set_sq_eventidx() for
1597 : : * every SQ that needs re-arming.
1598 : : *
1599 : : * Returns non-zero if we processed something.
1600 : : */
1601 : : static int
1602 : 0 : vfio_user_poll_group_rearm(struct nvmf_vfio_user_poll_group *vu_group)
1603 : : {
1604 : : struct nvmf_vfio_user_sq *sq;
1605 : 0 : int count = 0;
1606 : :
1607 : 0 : vu_group->stats.rearms++;
1608 : :
1609 [ # # ]: 0 : TAILQ_FOREACH(sq, &vu_group->sqs, link) {
1610 [ # # # # ]: 0 : if (spdk_unlikely(sq->sq_state != VFIO_USER_SQ_ACTIVE || !sq->size)) {
1611 : 0 : continue;
1612 : : }
1613 : :
1614 [ # # # # ]: 0 : if (sq->need_rearm) {
1615 : 0 : count += vfio_user_sq_rearm(sq->ctrlr, sq, vu_group);
1616 : : }
1617 : : }
1618 : :
1619 : 0 : return count;
1620 : : }
1621 : :
1622 : : static int
1623 : 52 : acq_setup(struct nvmf_vfio_user_ctrlr *ctrlr)
1624 : : {
1625 : : struct nvmf_vfio_user_cq *cq;
1626 : : const struct spdk_nvmf_registers *regs;
1627 : : int ret;
1628 : :
1629 [ - + ]: 52 : assert(ctrlr != NULL);
1630 : :
1631 : 52 : cq = ctrlr->cqs[0];
1632 : :
1633 [ - + ]: 52 : assert(cq != NULL);
1634 : :
1635 [ - + ]: 52 : assert(q_addr(&cq->mapping) == NULL);
1636 : :
1637 : 52 : regs = spdk_nvmf_ctrlr_get_regs(ctrlr->ctrlr);
1638 [ - + ]: 52 : assert(regs != NULL);
1639 : 52 : cq->qid = 0;
1640 : 52 : cq->size = regs->aqa.bits.acqs + 1;
1641 : 52 : cq->mapping.prp1 = regs->acq;
1642 : 52 : cq->mapping.len = cq->size * sizeof(struct spdk_nvme_cpl);
1643 : 52 : *cq_tailp(cq) = 0;
1644 : 52 : cq->ien = true;
1645 : 52 : cq->phase = true;
1646 : :
1647 : 52 : ret = map_q(ctrlr, &cq->mapping, MAP_RW | MAP_INITIALIZE);
1648 [ - + ]: 52 : if (ret) {
1649 : 0 : return ret;
1650 : : }
1651 : :
1652 : : /* The Admin queue (qid: 0) does not ever use shadow doorbells. */
1653 : 52 : cq->dbl_headp = ctrlr->bar0_doorbells + queue_index(0, true);
1654 : :
1655 : 52 : *cq_dbl_headp(cq) = 0;
1656 : :
1657 : 52 : return 0;
1658 : : }
1659 : :
1660 : : static void *
1661 : 2423047 : _map_one(void *prv, uint64_t addr, uint64_t len, uint32_t flags)
1662 : : {
1663 : 2423047 : struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)prv;
1664 : : struct spdk_nvmf_qpair *qpair;
1665 : : struct nvmf_vfio_user_req *vu_req;
1666 : : struct nvmf_vfio_user_sq *sq;
1667 : : void *ret;
1668 : :
1669 [ - + ]: 2423047 : assert(req != NULL);
1670 : 2423047 : qpair = req->qpair;
1671 : 2423047 : vu_req = SPDK_CONTAINEROF(req, struct nvmf_vfio_user_req, req);
1672 : 2423047 : sq = SPDK_CONTAINEROF(qpair, struct nvmf_vfio_user_sq, qpair);
1673 : :
1674 [ - + ]: 2423047 : assert(vu_req->iovcnt < NVMF_VFIO_USER_MAX_IOVECS);
1675 : 4846094 : ret = map_one(sq->ctrlr->endpoint->vfu_ctx, addr, len,
1676 : 2423047 : index_to_sg_t(vu_req->sg, vu_req->iovcnt),
1677 : 2423047 : &vu_req->iov[vu_req->iovcnt], flags);
1678 [ + + ]: 2423047 : if (spdk_likely(ret != NULL)) {
1679 : 1717311 : vu_req->iovcnt++;
1680 : : }
1681 : 2423047 : return ret;
1682 : : }
1683 : :
1684 : : static int
1685 : 2387965 : vfio_user_map_cmd(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvmf_request *req,
1686 : : struct iovec *iov, uint32_t length)
1687 : : {
1688 : : /* Map PRP list to from Guest physical memory to
1689 : : * virtual memory address.
1690 : : */
1691 : 2387965 : return nvme_map_cmd(req, &req->cmd->nvme_cmd, iov, NVMF_REQ_MAX_BUFFERS,
1692 : : length, 4096, _map_one);
1693 : : }
1694 : :
1695 : : static int handle_cmd_req(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd,
1696 : : struct nvmf_vfio_user_sq *sq);
1697 : :
1698 : : static uint32_t
1699 : 3151587 : cq_free_slots(struct nvmf_vfio_user_cq *cq)
1700 : : {
1701 : : uint32_t free_slots;
1702 : :
1703 [ - + ]: 3151587 : assert(cq != NULL);
1704 : :
1705 [ + + ]: 3151587 : if (cq->tail == cq->last_head) {
1706 : 9012 : free_slots = cq->size;
1707 [ + + ]: 3142575 : } else if (cq->tail > cq->last_head) {
1708 : 1454093 : free_slots = cq->size - (cq->tail - cq->last_head);
1709 : : } else {
1710 : 1688482 : free_slots = cq->last_head - cq->tail;
1711 : : }
1712 [ - + ]: 3151587 : assert(free_slots > 0);
1713 : :
1714 : 3151587 : return free_slots - 1;
1715 : : }
1716 : :
1717 : : /*
1718 : : * Since reading the head doorbell is relatively expensive, we use the cached
1719 : : * value, so we only have to read it for real if it appears that we are full.
1720 : : */
1721 : : static inline bool
1722 : 2902990 : cq_is_full(struct nvmf_vfio_user_cq *cq)
1723 : : {
1724 : : uint32_t free_cq_slots;
1725 : :
1726 [ - + ]: 2902990 : assert(cq != NULL);
1727 : :
1728 : 2902990 : free_cq_slots = cq_free_slots(cq);
1729 : :
1730 [ + + ]: 2902990 : if (spdk_unlikely(free_cq_slots == 0)) {
1731 : 9 : cq->last_head = *cq_dbl_headp(cq);
1732 : 9 : free_cq_slots = cq_free_slots(cq);
1733 : : }
1734 : :
1735 : 2902990 : return free_cq_slots == 0;
1736 : : }
1737 : :
1738 : : /*
1739 : : * Posts a CQE in the completion queue.
1740 : : *
1741 : : * @ctrlr: the vfio-user controller
1742 : : * @cq: the completion queue
1743 : : * @cdw0: cdw0 as reported by NVMf
1744 : : * @sqid: submission queue ID
1745 : : * @cid: command identifier in NVMe command
1746 : : * @sc: the NVMe CQE status code
1747 : : * @sct: the NVMe CQE status code type
1748 : : */
1749 : : static int
1750 : 2903134 : post_completion(struct nvmf_vfio_user_ctrlr *ctrlr, struct nvmf_vfio_user_cq *cq,
1751 : : uint32_t cdw0, uint16_t sqid, uint16_t cid, uint16_t sc, uint16_t sct)
1752 : : {
1753 : 2903134 : struct spdk_nvme_status cpl_status = { 0 };
1754 : : struct spdk_nvme_cpl *cpl;
1755 : : int err;
1756 : :
1757 [ - + ]: 2903134 : assert(ctrlr != NULL);
1758 : :
1759 [ + - + + ]: 2903134 : if (spdk_unlikely(cq == NULL || q_addr(&cq->mapping) == NULL)) {
1760 : 144 : return 0;
1761 : : }
1762 : :
1763 [ + + ]: 2902990 : if (cq->qid == 0) {
1764 [ - + ]: 255083 : assert(spdk_get_thread() == cq->group->group->thread);
1765 : : }
1766 : :
1767 : : /*
1768 : : * As per NVMe Base spec 3.3.1.2.1, we are supposed to implement CQ flow
1769 : : * control: if there is no space in the CQ, we should wait until there is.
1770 : : *
1771 : : * In practice, we just fail the controller instead: as it happens, all host
1772 : : * implementations we care about right-size the CQ: this is required anyway for
1773 : : * NVMEoF support (see 3.3.2.8).
1774 : : */
1775 [ - + ]: 2902990 : if (cq_is_full(cq)) {
1776 : 0 : SPDK_ERRLOG("%s: cqid:%d full (tail=%d, head=%d)\n",
1777 : : ctrlr_id(ctrlr), cq->qid, *cq_tailp(cq),
1778 : : *cq_dbl_headp(cq));
1779 : 0 : return -1;
1780 : : }
1781 : :
1782 : 2902990 : cpl = ((struct spdk_nvme_cpl *)q_addr(&cq->mapping)) + *cq_tailp(cq);
1783 : :
1784 [ - + ]: 2902990 : assert(ctrlr->sqs[sqid] != NULL);
1785 [ - + - + ]: 2902990 : SPDK_DEBUGLOG(nvmf_vfio,
1786 : : "%s: request complete sqid:%d cid=%d status=%#x "
1787 : : "sqhead=%d cq tail=%d\n", ctrlr_id(ctrlr), sqid, cid, sc,
1788 : : *sq_headp(ctrlr->sqs[sqid]), *cq_tailp(cq));
1789 : :
1790 : 2902990 : cpl->sqhd = *sq_headp(ctrlr->sqs[sqid]);
1791 : 2902990 : cpl->sqid = sqid;
1792 : 2902990 : cpl->cid = cid;
1793 : 2902990 : cpl->cdw0 = cdw0;
1794 : :
1795 : : /*
1796 : : * This is a bitfield: instead of setting the individual bits we need
1797 : : * directly in cpl->status, which would cause a read-modify-write cycle,
1798 : : * we'll avoid reading from the CPL altogether by filling in a local
1799 : : * cpl_status variable, then writing the whole thing.
1800 : : */
1801 : 2902990 : cpl_status.sct = sct;
1802 : 2902990 : cpl_status.sc = sc;
1803 [ - + ]: 2902990 : cpl_status.p = cq->phase;
1804 : 2902990 : cpl->status = cpl_status;
1805 : :
1806 : : /* Ensure the Completion Queue Entry is visible. */
1807 : 2902990 : spdk_wmb();
1808 : 2902990 : cq_tail_advance(cq);
1809 : :
1810 [ + + - + : 2902990 : if ((cq->qid == 0 || !ctrlr->adaptive_irqs_enabled) &&
- + ]
1811 [ - + + - : 255083 : cq->ien && ctrlr_interrupt_enabled(ctrlr)) {
+ + ]
1812 : 386 : err = vfu_irq_trigger(ctrlr->endpoint->vfu_ctx, cq->iv);
1813 [ - + ]: 386 : if (err != 0) {
1814 : 0 : SPDK_ERRLOG("%s: failed to trigger interrupt: %m\n",
1815 : : ctrlr_id(ctrlr));
1816 : 0 : return err;
1817 : : }
1818 : : }
1819 : :
1820 : 2902990 : return 0;
1821 : : }
1822 : :
1823 : : static void
1824 : 467 : free_sq_reqs(struct nvmf_vfio_user_sq *sq)
1825 : : {
1826 [ + + ]: 17361 : while (!TAILQ_EMPTY(&sq->free_reqs)) {
1827 : 16894 : struct nvmf_vfio_user_req *vu_req = TAILQ_FIRST(&sq->free_reqs);
1828 [ + + ]: 16894 : TAILQ_REMOVE(&sq->free_reqs, vu_req, link);
1829 : 16894 : free(vu_req);
1830 : : }
1831 : 467 : }
1832 : :
1833 : : static void
1834 : 210 : delete_cq_done(struct nvmf_vfio_user_ctrlr *ctrlr, struct nvmf_vfio_user_cq *cq)
1835 : : {
1836 [ - + ]: 210 : assert(cq->cq_ref == 0);
1837 : 210 : unmap_q(ctrlr, &cq->mapping);
1838 : 210 : cq->size = 0;
1839 : 210 : cq->cq_state = VFIO_USER_CQ_DELETED;
1840 : 210 : cq->group = NULL;
1841 : 210 : }
1842 : :
1843 : : /* Deletes a SQ, if this SQ is the last user of the associated CQ
1844 : : * and the controller is being shut down/reset or vfio-user client disconnects,
1845 : : * then the CQ is also deleted.
1846 : : */
1847 : : static void
1848 : 237 : delete_sq_done(struct nvmf_vfio_user_ctrlr *vu_ctrlr, struct nvmf_vfio_user_sq *sq)
1849 : : {
1850 : : struct nvmf_vfio_user_cq *cq;
1851 : : uint16_t cqid;
1852 : :
1853 [ - + - + ]: 237 : SPDK_DEBUGLOG(nvmf_vfio, "%s: delete sqid:%d=%p done\n", ctrlr_id(vu_ctrlr),
1854 : : sq->qid, sq);
1855 : :
1856 : : /* Free SQ resources */
1857 : 237 : unmap_q(vu_ctrlr, &sq->mapping);
1858 : :
1859 : 237 : free_sq_reqs(sq);
1860 : :
1861 : 237 : sq->size = 0;
1862 : :
1863 : 237 : sq->sq_state = VFIO_USER_SQ_DELETED;
1864 : :
1865 : : /* Controller RESET and SHUTDOWN are special cases,
1866 : : * VM may not send DELETE IO SQ/CQ commands, NVMf library
1867 : : * will disconnect IO queue pairs.
1868 : : */
1869 [ - + + + : 237 : if (vu_ctrlr->reset_shn || vu_ctrlr->disconnect) {
- + - + ]
1870 : 44 : cqid = sq->cqid;
1871 : 44 : cq = vu_ctrlr->cqs[cqid];
1872 : :
1873 [ - + - + ]: 44 : SPDK_DEBUGLOG(nvmf_vfio, "%s: try to delete cqid:%u=%p\n", ctrlr_id(vu_ctrlr),
1874 : : cq->qid, cq);
1875 : :
1876 [ - + ]: 44 : assert(cq->cq_ref > 0);
1877 [ + - ]: 44 : if (--cq->cq_ref == 0) {
1878 : 44 : delete_cq_done(vu_ctrlr, cq);
1879 : : }
1880 : : }
1881 : 237 : }
1882 : :
1883 : : static void
1884 : 24064 : free_qp(struct nvmf_vfio_user_ctrlr *ctrlr, uint16_t qid)
1885 : : {
1886 : : struct nvmf_vfio_user_sq *sq;
1887 : : struct nvmf_vfio_user_cq *cq;
1888 : :
1889 [ - + ]: 24064 : if (ctrlr == NULL) {
1890 : 0 : return;
1891 : : }
1892 : :
1893 : 24064 : sq = ctrlr->sqs[qid];
1894 [ + + ]: 24064 : if (sq) {
1895 [ - + - + ]: 230 : SPDK_DEBUGLOG(nvmf_vfio, "%s: Free sqid:%u\n", ctrlr_id(ctrlr), qid);
1896 : 230 : unmap_q(ctrlr, &sq->mapping);
1897 : :
1898 : 230 : free_sq_reqs(sq);
1899 : :
1900 : 230 : free(sq->mapping.sg);
1901 : 230 : free(sq);
1902 : 230 : ctrlr->sqs[qid] = NULL;
1903 : : }
1904 : :
1905 : 24064 : cq = ctrlr->cqs[qid];
1906 [ + + ]: 24064 : if (cq) {
1907 [ - + - + ]: 229 : SPDK_DEBUGLOG(nvmf_vfio, "%s: Free cqid:%u\n", ctrlr_id(ctrlr), qid);
1908 : 229 : unmap_q(ctrlr, &cq->mapping);
1909 : 229 : free(cq->mapping.sg);
1910 : 229 : free(cq);
1911 : 229 : ctrlr->cqs[qid] = NULL;
1912 : : }
1913 : : }
1914 : :
1915 : : static int
1916 : 230 : init_sq(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvmf_transport *transport,
1917 : : const uint16_t id)
1918 : : {
1919 : : struct nvmf_vfio_user_sq *sq;
1920 : :
1921 [ - + ]: 230 : assert(ctrlr != NULL);
1922 [ - + ]: 230 : assert(transport != NULL);
1923 [ - + ]: 230 : assert(ctrlr->sqs[id] == NULL);
1924 : :
1925 : 230 : sq = calloc(1, sizeof(*sq));
1926 [ - + ]: 230 : if (sq == NULL) {
1927 : 0 : return -ENOMEM;
1928 : : }
1929 : 230 : sq->mapping.sg = calloc(1, dma_sg_size());
1930 [ - + ]: 230 : if (sq->mapping.sg == NULL) {
1931 : 0 : free(sq);
1932 : 0 : return -ENOMEM;
1933 : : }
1934 : :
1935 : 230 : sq->qid = id;
1936 : 230 : sq->qpair.qid = id;
1937 : 230 : sq->qpair.transport = transport;
1938 : 230 : sq->ctrlr = ctrlr;
1939 : 230 : ctrlr->sqs[id] = sq;
1940 : :
1941 : 230 : TAILQ_INIT(&sq->free_reqs);
1942 : :
1943 : 230 : return 0;
1944 : : }
1945 : :
1946 : : static int
1947 : 229 : init_cq(struct nvmf_vfio_user_ctrlr *vu_ctrlr, const uint16_t id)
1948 : : {
1949 : : struct nvmf_vfio_user_cq *cq;
1950 : :
1951 [ - + ]: 229 : assert(vu_ctrlr != NULL);
1952 [ - + ]: 229 : assert(vu_ctrlr->cqs[id] == NULL);
1953 : :
1954 : 229 : cq = calloc(1, sizeof(*cq));
1955 [ - + ]: 229 : if (cq == NULL) {
1956 : 0 : return -ENOMEM;
1957 : : }
1958 : 229 : cq->mapping.sg = calloc(1, dma_sg_size());
1959 [ - + ]: 229 : if (cq->mapping.sg == NULL) {
1960 : 0 : free(cq);
1961 : 0 : return -ENOMEM;
1962 : : }
1963 : :
1964 : 229 : cq->qid = id;
1965 : 229 : vu_ctrlr->cqs[id] = cq;
1966 : :
1967 : 229 : return 0;
1968 : : }
1969 : :
1970 : : static int
1971 : 237 : alloc_sq_reqs(struct nvmf_vfio_user_ctrlr *vu_ctrlr, struct nvmf_vfio_user_sq *sq)
1972 : : {
1973 : : struct nvmf_vfio_user_req *vu_req, *tmp;
1974 : : size_t req_size;
1975 : : uint32_t i;
1976 : :
1977 : 237 : req_size = sizeof(struct nvmf_vfio_user_req) +
1978 : 237 : (dma_sg_size() * NVMF_VFIO_USER_MAX_IOVECS);
1979 : :
1980 [ + + ]: 17131 : for (i = 0; i < sq->size; i++) {
1981 : : struct spdk_nvmf_request *req;
1982 : :
1983 : 16894 : vu_req = calloc(1, req_size);
1984 [ - + ]: 16894 : if (vu_req == NULL) {
1985 : 0 : goto err;
1986 : : }
1987 : :
1988 : 16894 : req = &vu_req->req;
1989 : 16894 : req->qpair = &sq->qpair;
1990 : 16894 : req->rsp = (union nvmf_c2h_msg *)&vu_req->rsp;
1991 : 16894 : req->cmd = (union nvmf_h2c_msg *)&vu_req->cmd;
1992 : 16894 : req->stripped_data = NULL;
1993 : :
1994 : 16894 : TAILQ_INSERT_TAIL(&sq->free_reqs, vu_req, link);
1995 : : }
1996 : :
1997 : 237 : return 0;
1998 : :
1999 : 0 : err:
2000 [ # # ]: 0 : TAILQ_FOREACH_SAFE(vu_req, &sq->free_reqs, link, tmp) {
2001 : 0 : free(vu_req);
2002 : : }
2003 : 0 : return -ENOMEM;
2004 : : }
2005 : :
2006 : : static volatile uint32_t *
2007 : 377 : ctrlr_doorbell_ptr(struct nvmf_vfio_user_ctrlr *ctrlr)
2008 : : {
2009 : 377 : return ctrlr->sdbl != NULL ?
2010 [ - + ]: 377 : ctrlr->sdbl->shadow_doorbells :
2011 : : ctrlr->bar0_doorbells;
2012 : : }
2013 : :
2014 : : static uint16_t
2015 : 193 : handle_create_io_sq(struct nvmf_vfio_user_ctrlr *ctrlr,
2016 : : struct spdk_nvme_cmd *cmd, uint16_t *sct)
2017 : : {
2018 : 193 : struct nvmf_vfio_user_transport *vu_transport = ctrlr->transport;
2019 : : struct nvmf_vfio_user_sq *sq;
2020 : : uint32_t qsize;
2021 : : uint16_t cqid;
2022 : : uint16_t qid;
2023 : : int err;
2024 : :
2025 : 193 : qid = cmd->cdw10_bits.create_io_q.qid;
2026 : 193 : cqid = cmd->cdw11_bits.create_io_sq.cqid;
2027 : 193 : qsize = cmd->cdw10_bits.create_io_q.qsize + 1;
2028 : :
2029 [ + + ]: 193 : if (ctrlr->sqs[qid] == NULL) {
2030 : 183 : err = init_sq(ctrlr, ctrlr->sqs[0]->qpair.transport, qid);
2031 [ - + ]: 183 : if (err != 0) {
2032 : 0 : *sct = SPDK_NVME_SCT_GENERIC;
2033 : 0 : return SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2034 : : }
2035 : : }
2036 : :
2037 [ + + + + ]: 193 : if (cqid == 0 || cqid >= vu_transport->transport.opts.max_qpairs_per_ctrlr) {
2038 : 2 : SPDK_ERRLOG("%s: invalid cqid:%u\n", ctrlr_id(ctrlr), cqid);
2039 : 2 : *sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2040 : 2 : return SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER;
2041 : : }
2042 : :
2043 : : /* CQ must be created before SQ. */
2044 [ - + ]: 191 : if (!io_q_exists(ctrlr, cqid, true)) {
2045 : 0 : SPDK_ERRLOG("%s: cqid:%u does not exist\n", ctrlr_id(ctrlr), cqid);
2046 : 0 : *sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2047 : 0 : return SPDK_NVME_SC_COMPLETION_QUEUE_INVALID;
2048 : : }
2049 : :
2050 [ + + ]: 191 : if (cmd->cdw11_bits.create_io_sq.pc != 0x1) {
2051 : 1 : SPDK_ERRLOG("%s: non-PC SQ not supported\n", ctrlr_id(ctrlr));
2052 : 1 : *sct = SPDK_NVME_SCT_GENERIC;
2053 : 1 : return SPDK_NVME_SC_INVALID_FIELD;
2054 : : }
2055 : :
2056 : 190 : sq = ctrlr->sqs[qid];
2057 : 190 : sq->size = qsize;
2058 : :
2059 [ - + - + ]: 190 : SPDK_DEBUGLOG(nvmf_vfio, "%s: sqid:%d cqid:%d\n", ctrlr_id(ctrlr),
2060 : : qid, cqid);
2061 : :
2062 : 190 : sq->mapping.prp1 = cmd->dptr.prp.prp1;
2063 : 190 : sq->mapping.len = sq->size * sizeof(struct spdk_nvme_cmd);
2064 : :
2065 : 190 : err = map_q(ctrlr, &sq->mapping, MAP_INITIALIZE);
2066 [ - + ]: 190 : if (err) {
2067 : 0 : SPDK_ERRLOG("%s: failed to map I/O queue: %m\n", ctrlr_id(ctrlr));
2068 : 0 : *sct = SPDK_NVME_SCT_GENERIC;
2069 : 0 : return SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2070 : : }
2071 : :
2072 [ - + - + ]: 190 : SPDK_DEBUGLOG(nvmf_vfio, "%s: mapped sqid:%d IOVA=%#lx vaddr=%p\n",
2073 : : ctrlr_id(ctrlr), qid, cmd->dptr.prp.prp1,
2074 : : q_addr(&sq->mapping));
2075 : :
2076 : 190 : err = alloc_sq_reqs(ctrlr, sq);
2077 [ - + ]: 190 : if (err < 0) {
2078 : 0 : SPDK_ERRLOG("%s: failed to allocate SQ requests: %m\n", ctrlr_id(ctrlr));
2079 : 0 : *sct = SPDK_NVME_SCT_GENERIC;
2080 : 0 : return SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2081 : : }
2082 : :
2083 : 190 : sq->cqid = cqid;
2084 : 190 : ctrlr->cqs[sq->cqid]->cq_ref++;
2085 : 190 : sq->sq_state = VFIO_USER_SQ_CREATED;
2086 : 190 : *sq_headp(sq) = 0;
2087 : :
2088 : 190 : sq->dbl_tailp = ctrlr_doorbell_ptr(ctrlr) + queue_index(qid, false);
2089 : :
2090 : : /*
2091 : : * We should always reset the doorbells.
2092 : : *
2093 : : * The Specification prohibits the controller from writing to the shadow
2094 : : * doorbell buffer, however older versions of the Linux NVMe driver
2095 : : * don't reset the shadow doorbell buffer after a Queue-Level or
2096 : : * Controller-Level reset, which means that we're left with garbage
2097 : : * doorbell values.
2098 : : */
2099 : 190 : *sq_dbl_tailp(sq) = 0;
2100 : :
2101 [ - + ]: 190 : if (ctrlr->sdbl != NULL) {
2102 : 0 : sq->need_rearm = true;
2103 : :
2104 [ # # ]: 0 : if (!set_sq_eventidx(sq)) {
2105 : 0 : SPDK_ERRLOG("%s: host updated SQ tail doorbell before "
2106 : : "sqid:%hu was initialized\n",
2107 : : ctrlr_id(ctrlr), qid);
2108 : 0 : fail_ctrlr(ctrlr);
2109 : 0 : *sct = SPDK_NVME_SCT_GENERIC;
2110 : 0 : return SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2111 : : }
2112 : : }
2113 : :
2114 : : /*
2115 : : * Create our new I/O qpair. This asynchronously invokes, on a suitable
2116 : : * poll group, the nvmf_vfio_user_poll_group_add() callback, which will
2117 : : * call spdk_nvmf_request_exec() with a generated fabrics
2118 : : * connect command. This command is then eventually completed via
2119 : : * handle_queue_connect_rsp().
2120 : : */
2121 : 190 : sq->create_io_sq_cmd = *cmd;
2122 : 190 : sq->post_create_io_sq_completion = true;
2123 : :
2124 : 190 : spdk_nvmf_tgt_new_qpair(ctrlr->transport->transport.tgt,
2125 : : &sq->qpair);
2126 : :
2127 : 190 : *sct = SPDK_NVME_SCT_GENERIC;
2128 : 190 : return SPDK_NVME_SC_SUCCESS;
2129 : : }
2130 : :
2131 : : static uint16_t
2132 : 189 : handle_create_io_cq(struct nvmf_vfio_user_ctrlr *ctrlr,
2133 : : struct spdk_nvme_cmd *cmd, uint16_t *sct)
2134 : : {
2135 : : struct nvmf_vfio_user_cq *cq;
2136 : : uint32_t qsize;
2137 : : uint16_t qid;
2138 : : int err;
2139 : :
2140 : 189 : qid = cmd->cdw10_bits.create_io_q.qid;
2141 : 189 : qsize = cmd->cdw10_bits.create_io_q.qsize + 1;
2142 : :
2143 [ + + ]: 189 : if (ctrlr->cqs[qid] == NULL) {
2144 : 182 : err = init_cq(ctrlr, qid);
2145 [ - + ]: 182 : if (err != 0) {
2146 : 0 : *sct = SPDK_NVME_SCT_GENERIC;
2147 : 0 : return SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2148 : : }
2149 : : }
2150 : :
2151 [ + + ]: 189 : if (cmd->cdw11_bits.create_io_cq.pc != 0x1) {
2152 : 1 : SPDK_ERRLOG("%s: non-PC CQ not supported\n", ctrlr_id(ctrlr));
2153 : 1 : *sct = SPDK_NVME_SCT_GENERIC;
2154 : 1 : return SPDK_NVME_SC_INVALID_FIELD;
2155 : : }
2156 : :
2157 [ + + ]: 188 : if (cmd->cdw11_bits.create_io_cq.iv > NVME_IRQ_MSIX_NUM - 1) {
2158 : 1 : SPDK_ERRLOG("%s: IV is too big\n", ctrlr_id(ctrlr));
2159 : 1 : *sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2160 : 1 : return SPDK_NVME_SC_INVALID_INTERRUPT_VECTOR;
2161 : : }
2162 : :
2163 : 187 : cq = ctrlr->cqs[qid];
2164 : 187 : cq->size = qsize;
2165 : :
2166 : 187 : cq->mapping.prp1 = cmd->dptr.prp.prp1;
2167 : 187 : cq->mapping.len = cq->size * sizeof(struct spdk_nvme_cpl);
2168 : :
2169 : 187 : cq->dbl_headp = ctrlr_doorbell_ptr(ctrlr) + queue_index(qid, true);
2170 : :
2171 : 187 : err = map_q(ctrlr, &cq->mapping, MAP_RW | MAP_INITIALIZE);
2172 [ - + ]: 187 : if (err) {
2173 : 0 : SPDK_ERRLOG("%s: failed to map I/O queue: %m\n", ctrlr_id(ctrlr));
2174 : 0 : *sct = SPDK_NVME_SCT_GENERIC;
2175 : 0 : return SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2176 : : }
2177 : :
2178 [ - + - + ]: 187 : SPDK_DEBUGLOG(nvmf_vfio, "%s: mapped cqid:%u IOVA=%#lx vaddr=%p\n",
2179 : : ctrlr_id(ctrlr), qid, cmd->dptr.prp.prp1,
2180 : : q_addr(&cq->mapping));
2181 : :
2182 : 187 : cq->ien = cmd->cdw11_bits.create_io_cq.ien;
2183 : 187 : cq->iv = cmd->cdw11_bits.create_io_cq.iv;
2184 : 187 : cq->phase = true;
2185 : 187 : cq->cq_state = VFIO_USER_CQ_CREATED;
2186 : :
2187 : 187 : *cq_tailp(cq) = 0;
2188 : :
2189 : : /*
2190 : : * We should always reset the doorbells.
2191 : : *
2192 : : * The Specification prohibits the controller from writing to the shadow
2193 : : * doorbell buffer, however older versions of the Linux NVMe driver
2194 : : * don't reset the shadow doorbell buffer after a Queue-Level or
2195 : : * Controller-Level reset, which means that we're left with garbage
2196 : : * doorbell values.
2197 : : */
2198 : 187 : *cq_dbl_headp(cq) = 0;
2199 : :
2200 : 187 : *sct = SPDK_NVME_SCT_GENERIC;
2201 : 187 : return SPDK_NVME_SC_SUCCESS;
2202 : : }
2203 : :
2204 : : /*
2205 : : * Creates a completion or submission I/O queue. Returns 0 on success, -errno
2206 : : * on error.
2207 : : */
2208 : : static int
2209 : 2228 : handle_create_io_q(struct nvmf_vfio_user_ctrlr *ctrlr,
2210 : : struct spdk_nvme_cmd *cmd, const bool is_cq)
2211 : : {
2212 : 2228 : struct nvmf_vfio_user_transport *vu_transport = ctrlr->transport;
2213 : 2228 : uint16_t sct = SPDK_NVME_SCT_GENERIC;
2214 : 2228 : uint16_t sc = SPDK_NVME_SC_SUCCESS;
2215 : : uint32_t qsize;
2216 : : uint16_t qid;
2217 : :
2218 [ - + ]: 2228 : assert(ctrlr != NULL);
2219 [ - + ]: 2228 : assert(cmd != NULL);
2220 : :
2221 : 2228 : qid = cmd->cdw10_bits.create_io_q.qid;
2222 [ + - + + ]: 2228 : if (qid == 0 || qid >= vu_transport->transport.opts.max_qpairs_per_ctrlr) {
2223 : 1841 : SPDK_ERRLOG("%s: invalid qid=%d, max=%d\n", ctrlr_id(ctrlr),
2224 : : qid, vu_transport->transport.opts.max_qpairs_per_ctrlr);
2225 : 1841 : sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2226 : 1841 : sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER;
2227 : 1841 : goto out;
2228 : : }
2229 : :
2230 [ - + ]: 387 : if (io_q_exists(ctrlr, qid, is_cq)) {
2231 [ # # ]: 0 : SPDK_ERRLOG("%s: %cqid:%d already exists\n", ctrlr_id(ctrlr),
2232 : : is_cq ? 'c' : 's', qid);
2233 : 0 : sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2234 : 0 : sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER;
2235 : 0 : goto out;
2236 : : }
2237 : :
2238 : 387 : qsize = cmd->cdw10_bits.create_io_q.qsize + 1;
2239 [ + + + + ]: 387 : if (qsize == 1 || qsize > max_queue_size(ctrlr)) {
2240 : 5 : SPDK_ERRLOG("%s: invalid I/O queue size %u\n", ctrlr_id(ctrlr), qsize);
2241 : 5 : sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2242 : 5 : sc = SPDK_NVME_SC_INVALID_QUEUE_SIZE;
2243 : 5 : goto out;
2244 : : }
2245 : :
2246 [ + + ]: 382 : if (is_cq) {
2247 : 189 : sc = handle_create_io_cq(ctrlr, cmd, &sct);
2248 : : } else {
2249 : 193 : sc = handle_create_io_sq(ctrlr, cmd, &sct);
2250 : :
2251 [ + + + + ]: 193 : if (sct == SPDK_NVME_SCT_GENERIC &&
2252 : : sc == SPDK_NVME_SC_SUCCESS) {
2253 : : /* Completion posted asynchronously. */
2254 : 190 : return 0;
2255 : : }
2256 : : }
2257 : :
2258 : 32 : out:
2259 : 2038 : return post_completion(ctrlr, ctrlr->cqs[0], 0, 0, cmd->cid, sc, sct);
2260 : : }
2261 : :
2262 : : /* For ADMIN I/O DELETE SUBMISSION QUEUE the NVMf library will disconnect and free
2263 : : * queue pair, so save the command id and controller in a context.
2264 : : */
2265 : : struct vfio_user_delete_sq_ctx {
2266 : : struct nvmf_vfio_user_ctrlr *vu_ctrlr;
2267 : : uint16_t cid;
2268 : : };
2269 : :
2270 : : static void
2271 : 293 : vfio_user_qpair_delete_cb(void *cb_arg)
2272 : : {
2273 : 293 : struct vfio_user_delete_sq_ctx *ctx = cb_arg;
2274 : 293 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = ctx->vu_ctrlr;
2275 : 293 : struct nvmf_vfio_user_cq *admin_cq = vu_ctrlr->cqs[0];
2276 : :
2277 [ - + ]: 293 : assert(admin_cq != NULL);
2278 [ - + ]: 293 : assert(admin_cq->group != NULL);
2279 [ - + ]: 293 : assert(admin_cq->group->group->thread != NULL);
2280 [ + + ]: 293 : if (admin_cq->group->group->thread != spdk_get_thread()) {
2281 : 124 : spdk_thread_send_msg(admin_cq->group->group->thread,
2282 : : vfio_user_qpair_delete_cb,
2283 : : cb_arg);
2284 : : } else {
2285 : 169 : post_completion(vu_ctrlr, admin_cq, 0, 0,
2286 : 169 : ctx->cid,
2287 : : SPDK_NVME_SC_SUCCESS, SPDK_NVME_SCT_GENERIC);
2288 : 169 : free(ctx);
2289 : : }
2290 : 293 : }
2291 : :
2292 : : /*
2293 : : * Deletes a completion or submission I/O queue.
2294 : : */
2295 : : static int
2296 : 2238 : handle_del_io_q(struct nvmf_vfio_user_ctrlr *ctrlr,
2297 : : struct spdk_nvme_cmd *cmd, const bool is_cq)
2298 : : {
2299 : 2238 : uint16_t sct = SPDK_NVME_SCT_GENERIC;
2300 : 2238 : uint16_t sc = SPDK_NVME_SC_SUCCESS;
2301 : : struct nvmf_vfio_user_sq *sq;
2302 : : struct nvmf_vfio_user_cq *cq;
2303 : :
2304 [ - + - + : 2238 : SPDK_DEBUGLOG(nvmf_vfio, "%s: delete I/O %cqid:%d\n",
- - ]
2305 : : ctrlr_id(ctrlr), is_cq ? 'c' : 's',
2306 : : cmd->cdw10_bits.delete_io_q.qid);
2307 : :
2308 [ + + ]: 2238 : if (!io_q_exists(ctrlr, cmd->cdw10_bits.delete_io_q.qid, is_cq)) {
2309 [ + + ]: 1901 : SPDK_ERRLOG("%s: I/O %cqid:%d does not exist\n", ctrlr_id(ctrlr),
2310 : : is_cq ? 'c' : 's', cmd->cdw10_bits.delete_io_q.qid);
2311 : 1901 : sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2312 : 1901 : sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER;
2313 : 1901 : goto out;
2314 : : }
2315 : :
2316 [ + + ]: 337 : if (is_cq) {
2317 : 168 : cq = ctrlr->cqs[cmd->cdw10_bits.delete_io_q.qid];
2318 [ + + ]: 168 : if (cq->cq_ref) {
2319 : 2 : SPDK_ERRLOG("%s: the associated SQ must be deleted first\n", ctrlr_id(ctrlr));
2320 : 2 : sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2321 : 2 : sc = SPDK_NVME_SC_INVALID_QUEUE_DELETION;
2322 : 2 : goto out;
2323 : : }
2324 : 166 : delete_cq_done(ctrlr, cq);
2325 : : } else {
2326 : : /*
2327 : : * Deletion of the CQ is only deferred to delete_sq_done() on
2328 : : * VM reboot or CC.EN change, so we have to delete it in all
2329 : : * other cases.
2330 : : */
2331 : 169 : sq = ctrlr->sqs[cmd->cdw10_bits.delete_io_q.qid];
2332 : 169 : sq->delete_ctx = calloc(1, sizeof(*sq->delete_ctx));
2333 [ - + ]: 169 : if (!sq->delete_ctx) {
2334 : 0 : sct = SPDK_NVME_SCT_GENERIC;
2335 : 0 : sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2336 : 0 : goto out;
2337 : : }
2338 : 169 : sq->delete_ctx->vu_ctrlr = ctrlr;
2339 : 169 : sq->delete_ctx->cid = cmd->cid;
2340 : 169 : sq->sq_state = VFIO_USER_SQ_DELETED;
2341 [ - + ]: 169 : assert(ctrlr->cqs[sq->cqid]->cq_ref);
2342 : 169 : ctrlr->cqs[sq->cqid]->cq_ref--;
2343 : :
2344 : 169 : spdk_nvmf_qpair_disconnect(&sq->qpair);
2345 : 169 : return 0;
2346 : : }
2347 : :
2348 : 2069 : out:
2349 : 2069 : return post_completion(ctrlr, ctrlr->cqs[0], 0, 0, cmd->cid, sc, sct);
2350 : : }
2351 : :
2352 : : /*
2353 : : * Configures Shadow Doorbells.
2354 : : */
2355 : : static int
2356 : 0 : handle_doorbell_buffer_config(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd)
2357 : : {
2358 : 0 : struct nvmf_vfio_user_shadow_doorbells *sdbl = NULL;
2359 : : uint32_t dstrd;
2360 : : uintptr_t page_size, page_mask;
2361 : : uint64_t prp1, prp2;
2362 : 0 : uint16_t sct = SPDK_NVME_SCT_GENERIC;
2363 : 0 : uint16_t sc = SPDK_NVME_SC_INVALID_FIELD;
2364 : :
2365 [ # # ]: 0 : assert(ctrlr != NULL);
2366 [ # # ]: 0 : assert(ctrlr->endpoint != NULL);
2367 [ # # ]: 0 : assert(cmd != NULL);
2368 : :
2369 : 0 : dstrd = doorbell_stride(ctrlr);
2370 : 0 : page_size = memory_page_size(ctrlr);
2371 : 0 : page_mask = memory_page_mask(ctrlr);
2372 : :
2373 : : /* FIXME: we don't check doorbell stride when setting queue doorbells. */
2374 [ # # # # ]: 0 : if ((4u << dstrd) * NVMF_VFIO_USER_DEFAULT_MAX_QPAIRS_PER_CTRLR > page_size) {
2375 : 0 : SPDK_ERRLOG("%s: doorbells do not fit in a single host page",
2376 : : ctrlr_id(ctrlr));
2377 : :
2378 : 0 : goto out;
2379 : : }
2380 : :
2381 : : /* Verify guest physical addresses passed as PRPs. */
2382 [ # # ]: 0 : if (cmd->psdt != SPDK_NVME_PSDT_PRP) {
2383 : 0 : SPDK_ERRLOG("%s: received Doorbell Buffer Config without PRPs",
2384 : : ctrlr_id(ctrlr));
2385 : :
2386 : 0 : goto out;
2387 : : }
2388 : :
2389 : 0 : prp1 = cmd->dptr.prp.prp1;
2390 : 0 : prp2 = cmd->dptr.prp.prp2;
2391 : :
2392 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio,
2393 : : "%s: configuring shadow doorbells with PRP1=%#lx and PRP2=%#lx (GPAs)\n",
2394 : : ctrlr_id(ctrlr), prp1, prp2);
2395 : :
2396 [ # # ]: 0 : if (prp1 == prp2
2397 [ # # ]: 0 : || prp1 != (prp1 & page_mask)
2398 [ # # ]: 0 : || prp2 != (prp2 & page_mask)) {
2399 : 0 : SPDK_ERRLOG("%s: invalid shadow doorbell GPAs\n",
2400 : : ctrlr_id(ctrlr));
2401 : :
2402 : 0 : goto out;
2403 : : }
2404 : :
2405 : : /* Map guest physical addresses to our virtual address space. */
2406 : 0 : sdbl = map_sdbl(ctrlr->endpoint->vfu_ctx, prp1, prp2, page_size);
2407 [ # # ]: 0 : if (sdbl == NULL) {
2408 : 0 : SPDK_ERRLOG("%s: failed to map shadow doorbell buffers\n",
2409 : : ctrlr_id(ctrlr));
2410 : :
2411 : 0 : goto out;
2412 : : }
2413 : :
2414 : 0 : ctrlr->shadow_doorbell_buffer = prp1;
2415 : 0 : ctrlr->eventidx_buffer = prp2;
2416 : :
2417 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio,
2418 : : "%s: mapped shadow doorbell buffers [%p, %p) and [%p, %p)\n",
2419 : : ctrlr_id(ctrlr),
2420 : : sdbl->iovs[0].iov_base,
2421 : : sdbl->iovs[0].iov_base + sdbl->iovs[0].iov_len,
2422 : : sdbl->iovs[1].iov_base,
2423 : : sdbl->iovs[1].iov_base + sdbl->iovs[1].iov_len);
2424 : :
2425 : :
2426 : : /*
2427 : : * Set all possible CQ head doorbells to polling mode now, such that we
2428 : : * don't have to worry about it later if the host creates more queues.
2429 : : *
2430 : : * We only ever want interrupts for writes to the SQ tail doorbells
2431 : : * (which are initialised in set_ctrlr_intr_mode() below).
2432 : : */
2433 [ # # ]: 0 : for (uint16_t i = 0; i < NVMF_VFIO_USER_DEFAULT_MAX_QPAIRS_PER_CTRLR; ++i) {
2434 : 0 : sdbl->eventidxs[queue_index(i, true)] = NVMF_VFIO_USER_EVENTIDX_POLL;
2435 : : }
2436 : :
2437 : : /* Update controller. */
2438 : 0 : SWAP(ctrlr->sdbl, sdbl);
2439 : :
2440 : : /*
2441 : : * Copy doorbells from either the previous shadow doorbell buffer or the
2442 : : * BAR0 doorbells and make I/O queue doorbells point to the new buffer.
2443 : : *
2444 : : * This needs to account for older versions of the Linux NVMe driver,
2445 : : * which don't clear out the buffer after a controller reset.
2446 : : */
2447 [ # # ]: 0 : copy_doorbells(ctrlr, sdbl != NULL ?
2448 : : sdbl->shadow_doorbells : ctrlr->bar0_doorbells,
2449 : 0 : ctrlr->sdbl->shadow_doorbells);
2450 : :
2451 : 0 : vfio_user_ctrlr_switch_doorbells(ctrlr, true);
2452 : :
2453 : 0 : ctrlr_kick(ctrlr);
2454 : :
2455 : 0 : sc = SPDK_NVME_SC_SUCCESS;
2456 : :
2457 : 0 : out:
2458 : : /*
2459 : : * Unmap existing buffers, in case Doorbell Buffer Config was sent
2460 : : * more than once (pointless, but not prohibited by the spec), or
2461 : : * in case of an error.
2462 : : *
2463 : : * If this is the first time Doorbell Buffer Config was processed,
2464 : : * then we've just swapped a NULL from ctrlr->sdbl into sdbl, so
2465 : : * free_sdbl() becomes a noop.
2466 : : */
2467 : 0 : free_sdbl(ctrlr->endpoint->vfu_ctx, sdbl);
2468 : :
2469 : 0 : return post_completion(ctrlr, ctrlr->cqs[0], 0, 0, cmd->cid, sc, sct);
2470 : : }
2471 : :
2472 : : /* Returns 0 on success and -errno on error. */
2473 : : static int
2474 : 255235 : consume_admin_cmd(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd)
2475 : : {
2476 [ - + ]: 255235 : assert(ctrlr != NULL);
2477 [ - + ]: 255235 : assert(cmd != NULL);
2478 : :
2479 [ + + ]: 255235 : if (cmd->fuse != 0) {
2480 : : /* Fused admin commands are not supported. */
2481 : 2 : return post_completion(ctrlr, ctrlr->cqs[0], 0, 0, cmd->cid,
2482 : : SPDK_NVME_SC_INVALID_FIELD,
2483 : : SPDK_NVME_SCT_GENERIC);
2484 : : }
2485 : :
2486 [ + + + + ]: 255233 : switch (cmd->opc) {
2487 : 2228 : case SPDK_NVME_OPC_CREATE_IO_CQ:
2488 : : case SPDK_NVME_OPC_CREATE_IO_SQ:
2489 : 2228 : return handle_create_io_q(ctrlr, cmd,
2490 : 2228 : cmd->opc == SPDK_NVME_OPC_CREATE_IO_CQ);
2491 : 2238 : case SPDK_NVME_OPC_DELETE_IO_SQ:
2492 : : case SPDK_NVME_OPC_DELETE_IO_CQ:
2493 : 2238 : return handle_del_io_q(ctrlr, cmd,
2494 : 2238 : cmd->opc == SPDK_NVME_OPC_DELETE_IO_CQ);
2495 : 946 : case SPDK_NVME_OPC_DOORBELL_BUFFER_CONFIG:
2496 [ - + ]: 946 : SPDK_NOTICELOG("%s: requested shadow doorbells (supported: %d)\n",
2497 : : ctrlr_id(ctrlr),
2498 : : !ctrlr->transport->transport_opts.disable_shadow_doorbells);
2499 [ - + - + ]: 946 : if (!ctrlr->transport->transport_opts.disable_shadow_doorbells) {
2500 : 0 : return handle_doorbell_buffer_config(ctrlr, cmd);
2501 : : }
2502 : : /* FALLTHROUGH */
2503 : : default:
2504 : 250767 : return handle_cmd_req(ctrlr, cmd, ctrlr->sqs[0]);
2505 : : }
2506 : : }
2507 : :
2508 : : static int
2509 : 2898666 : handle_cmd_rsp(struct nvmf_vfio_user_req *vu_req, void *cb_arg)
2510 : : {
2511 : 2898666 : struct nvmf_vfio_user_sq *sq = cb_arg;
2512 : 2898666 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = sq->ctrlr;
2513 : : uint16_t sqid, cqid;
2514 : :
2515 [ - + ]: 2898666 : assert(sq != NULL);
2516 [ - + ]: 2898666 : assert(vu_req != NULL);
2517 [ - + ]: 2898666 : assert(vu_ctrlr != NULL);
2518 : :
2519 [ + + ]: 2898666 : if (spdk_likely(vu_req->iovcnt)) {
2520 : 1682229 : vfu_sgl_put(vu_ctrlr->endpoint->vfu_ctx,
2521 : 1682229 : index_to_sg_t(vu_req->sg, 0),
2522 : 1682229 : vu_req->iov, vu_req->iovcnt);
2523 : : }
2524 : 2898666 : sqid = sq->qid;
2525 : 2898666 : cqid = sq->cqid;
2526 : :
2527 : 2898666 : return post_completion(vu_ctrlr, vu_ctrlr->cqs[cqid],
2528 : 2898666 : vu_req->req.rsp->nvme_cpl.cdw0,
2529 : : sqid,
2530 : 2898666 : vu_req->req.cmd->nvme_cmd.cid,
2531 : 2898666 : vu_req->req.rsp->nvme_cpl.status.sc,
2532 : 2898666 : vu_req->req.rsp->nvme_cpl.status.sct);
2533 : : }
2534 : :
2535 : : static int
2536 : 2903142 : consume_cmd(struct nvmf_vfio_user_ctrlr *ctrlr, struct nvmf_vfio_user_sq *sq,
2537 : : struct spdk_nvme_cmd *cmd)
2538 : : {
2539 [ - + ]: 2903142 : assert(sq != NULL);
2540 [ + + ]: 2903142 : if (spdk_unlikely(nvmf_qpair_is_admin_queue(&sq->qpair))) {
2541 : 255235 : return consume_admin_cmd(ctrlr, cmd);
2542 : : }
2543 : :
2544 : 2647907 : return handle_cmd_req(ctrlr, cmd, sq);
2545 : : }
2546 : :
2547 : : /* Returns the number of commands processed, or a negative value on error. */
2548 : : static int
2549 : 235215 : handle_sq_tdbl_write(struct nvmf_vfio_user_ctrlr *ctrlr, const uint32_t new_tail,
2550 : : struct nvmf_vfio_user_sq *sq)
2551 : : {
2552 : : struct spdk_nvme_cmd *queue;
2553 : 235215 : struct nvmf_vfio_user_cq *cq = ctrlr->cqs[sq->cqid];
2554 : 235215 : int count = 0;
2555 : : uint32_t free_cq_slots;
2556 : :
2557 [ - + ]: 235215 : assert(ctrlr != NULL);
2558 [ - + ]: 235215 : assert(sq != NULL);
2559 : :
2560 [ - + - - ]: 235215 : if (ctrlr->sdbl != NULL && sq->qid != 0) {
2561 : : /*
2562 : : * Submission queue index has moved past the event index, so it
2563 : : * needs to be re-armed before we go to sleep.
2564 : : */
2565 : 0 : sq->need_rearm = true;
2566 : : }
2567 : :
2568 : 235215 : free_cq_slots = cq_free_slots(cq);
2569 : 235215 : queue = q_addr(&sq->mapping);
2570 [ + + ]: 3151730 : while (*sq_headp(sq) != new_tail) {
2571 : : int err;
2572 : : struct spdk_nvme_cmd *cmd;
2573 : :
2574 : : /*
2575 : : * Linux host nvme driver can submit cmd's more than free cq slots
2576 : : * available. So process only those who have cq slots available.
2577 : : */
2578 [ + + ]: 2916515 : if (free_cq_slots-- == 0) {
2579 : 13373 : cq->last_head = *cq_dbl_headp(cq);
2580 : :
2581 : 13373 : free_cq_slots = cq_free_slots(cq);
2582 [ + - ]: 13373 : if (free_cq_slots > 0) {
2583 : 13373 : continue;
2584 : : }
2585 : :
2586 : : /*
2587 : : * If there are no free cq slots then kick interrupt FD to loop
2588 : : * again to process remaining sq cmds.
2589 : : * In case of polling mode we will process remaining sq cmds during
2590 : : * next polling interation.
2591 : : * sq head is advanced only for consumed commands.
2592 : : */
2593 [ # # ]: 0 : if (in_interrupt_mode(ctrlr->transport)) {
2594 : 0 : eventfd_write(ctrlr->intr_fd, 1);
2595 : : }
2596 : 0 : break;
2597 : : }
2598 : :
2599 : 2903142 : cmd = &queue[*sq_headp(sq)];
2600 : 2903142 : count++;
2601 : :
2602 : : /*
2603 : : * SQHD must contain the new head pointer, so we must increase
2604 : : * it before we generate a completion.
2605 : : */
2606 : 2903142 : sq_head_advance(sq);
2607 : :
2608 : 2903142 : err = consume_cmd(ctrlr, sq, cmd);
2609 [ - + ]: 2903142 : if (spdk_unlikely(err != 0)) {
2610 : 0 : return err;
2611 : : }
2612 : : }
2613 : :
2614 : 235215 : return count;
2615 : : }
2616 : :
2617 : : /* Checks whether endpoint is connected from the same process */
2618 : : static bool
2619 : 284 : is_peer_same_process(struct nvmf_vfio_user_endpoint *endpoint)
2620 : : {
2621 : 176 : struct ucred ucred;
2622 : 284 : socklen_t ucredlen = sizeof(ucred);
2623 : :
2624 [ - + ]: 284 : if (endpoint == NULL) {
2625 : 0 : return false;
2626 : : }
2627 : :
2628 [ - + ]: 284 : if (getsockopt(vfu_get_poll_fd(endpoint->vfu_ctx), SOL_SOCKET, SO_PEERCRED, &ucred,
2629 : : &ucredlen) < 0) {
2630 : 0 : SPDK_ERRLOG("getsockopt(SO_PEERCRED): %s\n", strerror(errno));
2631 : 0 : return false;
2632 : : }
2633 : :
2634 : 284 : return ucred.pid == getpid();
2635 : : }
2636 : :
2637 : : static void
2638 : 335 : memory_region_add_cb(vfu_ctx_t *vfu_ctx, vfu_dma_info_t *info)
2639 : : {
2640 : 335 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
2641 : : struct nvmf_vfio_user_ctrlr *ctrlr;
2642 : : struct nvmf_vfio_user_sq *sq;
2643 : : struct nvmf_vfio_user_cq *cq;
2644 : : void *map_start, *map_end;
2645 : : int ret;
2646 : :
2647 : : /*
2648 : : * We're not interested in any DMA regions that aren't mappable (we don't
2649 : : * support clients that don't share their memory).
2650 : : */
2651 [ + + ]: 335 : if (!info->vaddr) {
2652 : 152 : return;
2653 : : }
2654 : :
2655 : 183 : map_start = info->mapping.iov_base;
2656 : 183 : map_end = info->mapping.iov_base + info->mapping.iov_len;
2657 : :
2658 [ + - ]: 183 : if (((uintptr_t)info->mapping.iov_base & MASK_2MB) ||
2659 [ - + ]: 183 : (info->mapping.iov_len & MASK_2MB)) {
2660 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "Invalid memory region vaddr %p, IOVA %p-%p\n",
2661 : : info->vaddr, map_start, map_end);
2662 : 0 : return;
2663 : : }
2664 : :
2665 [ - + ]: 183 : assert(endpoint != NULL);
2666 [ - + ]: 183 : if (endpoint->ctrlr == NULL) {
2667 : 0 : return;
2668 : : }
2669 : 183 : ctrlr = endpoint->ctrlr;
2670 : :
2671 [ - + - + ]: 183 : SPDK_DEBUGLOG(nvmf_vfio, "%s: map IOVA %p-%p\n", endpoint_id(endpoint),
2672 : : map_start, map_end);
2673 : :
2674 : : /* VFIO_DMA_MAP_FLAG_READ | VFIO_DMA_MAP_FLAG_WRITE are enabled when registering to VFIO, here we also
2675 : : * check the protection bits before registering. When vfio client and server are run in same process
2676 : : * there is no need to register the same memory again.
2677 : : */
2678 [ + + + - ]: 183 : if (info->prot == (PROT_WRITE | PROT_READ) && !is_peer_same_process(endpoint)) {
2679 : 142 : ret = spdk_mem_register(info->mapping.iov_base, info->mapping.iov_len);
2680 [ - + ]: 142 : if (ret) {
2681 : 0 : SPDK_ERRLOG("Memory region register %p-%p failed, ret=%d\n",
2682 : : map_start, map_end, ret);
2683 : : }
2684 : : }
2685 : :
2686 [ - + ]: 183 : pthread_mutex_lock(&endpoint->lock);
2687 [ + + ]: 1108 : TAILQ_FOREACH(sq, &ctrlr->connected_sqs, tailq) {
2688 [ + + ]: 925 : if (sq->sq_state != VFIO_USER_SQ_INACTIVE) {
2689 : 865 : continue;
2690 : : }
2691 : :
2692 : 60 : cq = ctrlr->cqs[sq->cqid];
2693 : :
2694 : : /* For shared CQ case, we will use q_addr() to avoid mapping CQ multiple times */
2695 [ + - + - ]: 60 : if (cq->size && q_addr(&cq->mapping) == NULL) {
2696 : 60 : ret = map_q(ctrlr, &cq->mapping, MAP_RW | MAP_QUIET);
2697 [ + + ]: 60 : if (ret) {
2698 [ - + - + ]: 50 : SPDK_DEBUGLOG(nvmf_vfio, "Memory isn't ready to remap cqid:%d %#lx-%#lx\n",
2699 : : cq->qid, cq->mapping.prp1,
2700 : : cq->mapping.prp1 + cq->mapping.len);
2701 : 50 : continue;
2702 : : }
2703 : : }
2704 : :
2705 [ + - ]: 10 : if (sq->size) {
2706 : 10 : ret = map_q(ctrlr, &sq->mapping, MAP_R | MAP_QUIET);
2707 [ - + ]: 10 : if (ret) {
2708 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "Memory isn't ready to remap sqid:%d %#lx-%#lx\n",
2709 : : sq->qid, sq->mapping.prp1,
2710 : : sq->mapping.prp1 + sq->mapping.len);
2711 : 0 : continue;
2712 : : }
2713 : : }
2714 : 10 : sq->sq_state = VFIO_USER_SQ_ACTIVE;
2715 [ - + - + ]: 10 : SPDK_DEBUGLOG(nvmf_vfio, "Remap sqid:%u successfully\n", sq->qid);
2716 : : }
2717 [ - + ]: 183 : pthread_mutex_unlock(&endpoint->lock);
2718 : : }
2719 : :
2720 : : static void
2721 : 335 : memory_region_remove_cb(vfu_ctx_t *vfu_ctx, vfu_dma_info_t *info)
2722 : : {
2723 : 335 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
2724 : : struct nvmf_vfio_user_sq *sq;
2725 : : struct nvmf_vfio_user_cq *cq;
2726 : : void *map_start, *map_end;
2727 : 335 : int ret = 0;
2728 : :
2729 [ + + ]: 335 : if (!info->vaddr) {
2730 : 152 : return;
2731 : : }
2732 : :
2733 : 183 : map_start = info->mapping.iov_base;
2734 : 183 : map_end = info->mapping.iov_base + info->mapping.iov_len;
2735 : :
2736 [ + - ]: 183 : if (((uintptr_t)info->mapping.iov_base & MASK_2MB) ||
2737 [ - + ]: 183 : (info->mapping.iov_len & MASK_2MB)) {
2738 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "Invalid memory region vaddr %p, IOVA %p-%p\n",
2739 : : info->vaddr, map_start, map_end);
2740 : 0 : return;
2741 : : }
2742 : :
2743 [ - + ]: 183 : assert(endpoint != NULL);
2744 [ - + - + ]: 183 : SPDK_DEBUGLOG(nvmf_vfio, "%s: unmap IOVA %p-%p\n", endpoint_id(endpoint),
2745 : : map_start, map_end);
2746 : :
2747 [ + + ]: 183 : if (endpoint->ctrlr != NULL) {
2748 : : struct nvmf_vfio_user_ctrlr *ctrlr;
2749 : 127 : ctrlr = endpoint->ctrlr;
2750 : :
2751 [ - + ]: 127 : pthread_mutex_lock(&endpoint->lock);
2752 [ + + ]: 800 : TAILQ_FOREACH(sq, &ctrlr->connected_sqs, tailq) {
2753 [ + + + + ]: 673 : if (q_addr(&sq->mapping) >= map_start && q_addr(&sq->mapping) <= map_end) {
2754 : 10 : unmap_q(ctrlr, &sq->mapping);
2755 : 10 : sq->sq_state = VFIO_USER_SQ_INACTIVE;
2756 : : }
2757 : :
2758 : 673 : cq = ctrlr->cqs[sq->cqid];
2759 [ + + + + ]: 673 : if (q_addr(&cq->mapping) >= map_start && q_addr(&cq->mapping) <= map_end) {
2760 : 10 : unmap_q(ctrlr, &cq->mapping);
2761 : : }
2762 : : }
2763 : :
2764 [ - + ]: 127 : if (ctrlr->sdbl != NULL) {
2765 : : size_t i;
2766 : :
2767 [ # # ]: 0 : for (i = 0; i < NVMF_VFIO_USER_SHADOW_DOORBELLS_BUFFER_COUNT; i++) {
2768 : 0 : const void *const iov_base = ctrlr->sdbl->iovs[i].iov_base;
2769 : :
2770 [ # # # # ]: 0 : if (iov_base >= map_start && iov_base < map_end) {
2771 : 0 : copy_doorbells(ctrlr,
2772 : 0 : ctrlr->sdbl->shadow_doorbells,
2773 : : ctrlr->bar0_doorbells);
2774 : 0 : vfio_user_ctrlr_switch_doorbells(ctrlr, false);
2775 : 0 : free_sdbl(endpoint->vfu_ctx, ctrlr->sdbl);
2776 : 0 : ctrlr->sdbl = NULL;
2777 : 0 : break;
2778 : : }
2779 : : }
2780 : : }
2781 : :
2782 [ - + ]: 127 : pthread_mutex_unlock(&endpoint->lock);
2783 : : }
2784 : :
2785 [ + + + - ]: 183 : if (info->prot == (PROT_WRITE | PROT_READ) && !is_peer_same_process(endpoint)) {
2786 : 142 : ret = spdk_mem_unregister(info->mapping.iov_base, info->mapping.iov_len);
2787 [ - + ]: 142 : if (ret) {
2788 : 0 : SPDK_ERRLOG("Memory region unregister %p-%p failed, ret=%d\n",
2789 : : map_start, map_end, ret);
2790 : : }
2791 : : }
2792 : : }
2793 : :
2794 : : /* Used to initiate a controller-level reset or a controller shutdown. */
2795 : : static void
2796 : 49 : disable_ctrlr(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
2797 : : {
2798 : 49 : SPDK_NOTICELOG("%s: disabling controller\n", ctrlr_id(vu_ctrlr));
2799 : :
2800 : : /* Unmap Admin queue. */
2801 : :
2802 [ - + ]: 49 : assert(vu_ctrlr->sqs[0] != NULL);
2803 [ - + ]: 49 : assert(vu_ctrlr->cqs[0] != NULL);
2804 : :
2805 : 49 : unmap_q(vu_ctrlr, &vu_ctrlr->sqs[0]->mapping);
2806 : 49 : unmap_q(vu_ctrlr, &vu_ctrlr->cqs[0]->mapping);
2807 : :
2808 : 49 : vu_ctrlr->sqs[0]->size = 0;
2809 : 49 : *sq_headp(vu_ctrlr->sqs[0]) = 0;
2810 : :
2811 : 49 : vu_ctrlr->sqs[0]->sq_state = VFIO_USER_SQ_INACTIVE;
2812 : :
2813 : 49 : vu_ctrlr->cqs[0]->size = 0;
2814 : 49 : *cq_tailp(vu_ctrlr->cqs[0]) = 0;
2815 : :
2816 : : /*
2817 : : * For PCIe controller reset or shutdown, we will drop all AER
2818 : : * responses.
2819 : : */
2820 : 49 : spdk_nvmf_ctrlr_abort_aer(vu_ctrlr->ctrlr);
2821 : :
2822 : : /* Free the shadow doorbell buffer. */
2823 : 49 : vfio_user_ctrlr_switch_doorbells(vu_ctrlr, false);
2824 : 49 : free_sdbl(vu_ctrlr->endpoint->vfu_ctx, vu_ctrlr->sdbl);
2825 : 49 : vu_ctrlr->sdbl = NULL;
2826 : 49 : }
2827 : :
2828 : : /* Used to re-enable the controller after a controller-level reset. */
2829 : : static int
2830 : 52 : enable_ctrlr(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
2831 : : {
2832 : : int err;
2833 : :
2834 [ - + ]: 52 : assert(vu_ctrlr != NULL);
2835 : :
2836 : 52 : SPDK_NOTICELOG("%s: enabling controller\n", ctrlr_id(vu_ctrlr));
2837 : :
2838 : 52 : err = acq_setup(vu_ctrlr);
2839 [ - + ]: 52 : if (err != 0) {
2840 : 0 : return err;
2841 : : }
2842 : :
2843 : 52 : err = asq_setup(vu_ctrlr);
2844 [ - + ]: 52 : if (err != 0) {
2845 : 0 : return err;
2846 : : }
2847 : :
2848 : 52 : vu_ctrlr->sqs[0]->sq_state = VFIO_USER_SQ_ACTIVE;
2849 : :
2850 : 52 : return 0;
2851 : : }
2852 : :
2853 : : static int
2854 : 310 : nvmf_vfio_user_prop_req_rsp_set(struct nvmf_vfio_user_req *req,
2855 : : struct nvmf_vfio_user_sq *sq)
2856 : : {
2857 : : struct nvmf_vfio_user_ctrlr *vu_ctrlr;
2858 : : union spdk_nvme_cc_register cc, diff;
2859 : :
2860 [ - + ]: 310 : assert(req->req.cmd->prop_set_cmd.fctype == SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET);
2861 [ - + ]: 310 : assert(sq->ctrlr != NULL);
2862 : 310 : vu_ctrlr = sq->ctrlr;
2863 : :
2864 [ + + ]: 310 : if (req->req.cmd->prop_set_cmd.ofst != offsetof(struct spdk_nvme_registers, cc)) {
2865 : 190 : return 0;
2866 : : }
2867 : :
2868 : 120 : cc.raw = req->req.cmd->prop_set_cmd.value.u64;
2869 : 120 : diff.raw = cc.raw ^ req->cc.raw;
2870 : :
2871 [ + + ]: 120 : if (diff.bits.en) {
2872 [ + + ]: 57 : if (cc.bits.en) {
2873 : 52 : int ret = enable_ctrlr(vu_ctrlr);
2874 [ - + ]: 52 : if (ret) {
2875 : 0 : SPDK_ERRLOG("%s: failed to enable ctrlr\n", ctrlr_id(vu_ctrlr));
2876 : 0 : return ret;
2877 : : }
2878 : 52 : vu_ctrlr->reset_shn = false;
2879 : : } else {
2880 : 5 : vu_ctrlr->reset_shn = true;
2881 : : }
2882 : : }
2883 : :
2884 [ + + ]: 120 : if (diff.bits.shn) {
2885 [ - + - - ]: 39 : if (cc.bits.shn == SPDK_NVME_SHN_NORMAL || cc.bits.shn == SPDK_NVME_SHN_ABRUPT) {
2886 : 39 : vu_ctrlr->reset_shn = true;
2887 : : }
2888 : : }
2889 : :
2890 [ - + + + ]: 120 : if (vu_ctrlr->reset_shn) {
2891 : 49 : disable_ctrlr(vu_ctrlr);
2892 : : }
2893 : 120 : return 0;
2894 : : }
2895 : :
2896 : : static int
2897 : 829 : nvmf_vfio_user_prop_req_rsp(struct nvmf_vfio_user_req *req, void *cb_arg)
2898 : : {
2899 : 829 : struct nvmf_vfio_user_sq *sq = cb_arg;
2900 : :
2901 [ - + ]: 829 : assert(sq != NULL);
2902 [ - + ]: 829 : assert(req != NULL);
2903 : :
2904 [ + + ]: 829 : if (req->req.cmd->prop_get_cmd.fctype == SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET) {
2905 [ - + ]: 519 : assert(sq->ctrlr != NULL);
2906 [ - + ]: 519 : assert(req != NULL);
2907 : :
2908 [ - + - + ]: 519 : memcpy(req->req.iov[0].iov_base,
2909 : 519 : &req->req.rsp->prop_get_rsp.value.u64,
2910 : 519 : req->req.length);
2911 : 519 : return 0;
2912 : : }
2913 : :
2914 : 310 : return nvmf_vfio_user_prop_req_rsp_set(req, sq);
2915 : : }
2916 : :
2917 : : /*
2918 : : * Handles a write at offset 0x1000 or more; this is the non-mapped path when a
2919 : : * doorbell is written via access_bar0_fn().
2920 : : *
2921 : : * DSTRD is set to fixed value 0 for NVMf.
2922 : : *
2923 : : */
2924 : : static int
2925 : 0 : handle_dbl_access(struct nvmf_vfio_user_ctrlr *ctrlr, uint32_t *buf,
2926 : : const size_t count, loff_t pos, const bool is_write)
2927 : : {
2928 : : struct nvmf_vfio_user_poll_group *group;
2929 : :
2930 [ # # ]: 0 : assert(ctrlr != NULL);
2931 [ # # ]: 0 : assert(buf != NULL);
2932 : :
2933 [ # # ]: 0 : if (spdk_unlikely(!is_write)) {
2934 : 0 : SPDK_WARNLOG("%s: host tried to read BAR0 doorbell %#lx\n",
2935 : : ctrlr_id(ctrlr), pos);
2936 : 0 : errno = EPERM;
2937 : 0 : return -1;
2938 : : }
2939 : :
2940 [ # # ]: 0 : if (spdk_unlikely(count != sizeof(uint32_t))) {
2941 : 0 : SPDK_ERRLOG("%s: bad doorbell buffer size %ld\n",
2942 : : ctrlr_id(ctrlr), count);
2943 : 0 : errno = EINVAL;
2944 : 0 : return -1;
2945 : : }
2946 : :
2947 : 0 : pos -= NVME_DOORBELLS_OFFSET;
2948 : :
2949 : : /* pos must be dword aligned */
2950 [ # # ]: 0 : if (spdk_unlikely((pos & 0x3) != 0)) {
2951 : 0 : SPDK_ERRLOG("%s: bad doorbell offset %#lx\n", ctrlr_id(ctrlr), pos);
2952 : 0 : errno = EINVAL;
2953 : 0 : return -1;
2954 : : }
2955 : :
2956 : : /* convert byte offset to array index */
2957 : 0 : pos >>= 2;
2958 : :
2959 [ # # ]: 0 : if (spdk_unlikely(pos >= NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR * 2)) {
2960 : 0 : SPDK_ERRLOG("%s: bad doorbell index %#lx\n", ctrlr_id(ctrlr), pos);
2961 : 0 : errno = EINVAL;
2962 : 0 : return -1;
2963 : : }
2964 : :
2965 : 0 : ctrlr->bar0_doorbells[pos] = *buf;
2966 : 0 : spdk_wmb();
2967 : :
2968 : 0 : group = ctrlr_to_poll_group(ctrlr);
2969 [ # # ]: 0 : if (pos == 1) {
2970 : 0 : group->stats.cqh_admin_writes++;
2971 [ # # ]: 0 : } else if (pos & 1) {
2972 : 0 : group->stats.cqh_io_writes++;
2973 : : }
2974 : :
2975 [ # # # # : 0 : SPDK_DEBUGLOG(vfio_user_db, "%s: updating BAR0 doorbell %s:%ld to %u\n",
# # ]
2976 : : ctrlr_id(ctrlr), (pos & 1) ? "cqid" : "sqid",
2977 : : pos / 2, *buf);
2978 : :
2979 : :
2980 : 0 : return 0;
2981 : : }
2982 : :
2983 : : static size_t
2984 : 829 : vfio_user_property_access(struct nvmf_vfio_user_ctrlr *vu_ctrlr,
2985 : : char *buf, size_t count, loff_t pos,
2986 : : bool is_write)
2987 : : {
2988 : : struct nvmf_vfio_user_req *req;
2989 : : const struct spdk_nvmf_registers *regs;
2990 : :
2991 [ + + - + ]: 829 : if ((count != 4) && (count != 8)) {
2992 : 0 : errno = EINVAL;
2993 : 0 : return -1;
2994 : : }
2995 : :
2996 : : /* Construct a Fabric Property Get/Set command and send it */
2997 : 829 : req = get_nvmf_vfio_user_req(vu_ctrlr->sqs[0]);
2998 [ - + ]: 829 : if (req == NULL) {
2999 : 0 : errno = ENOBUFS;
3000 : 0 : return -1;
3001 : : }
3002 : 829 : regs = spdk_nvmf_ctrlr_get_regs(vu_ctrlr->ctrlr);
3003 : 829 : req->cc.raw = regs->cc.raw;
3004 : :
3005 : 829 : req->cb_fn = nvmf_vfio_user_prop_req_rsp;
3006 : 829 : req->cb_arg = vu_ctrlr->sqs[0];
3007 : 829 : req->req.cmd->prop_set_cmd.opcode = SPDK_NVME_OPC_FABRIC;
3008 : 829 : req->req.cmd->prop_set_cmd.cid = 0;
3009 [ + + ]: 829 : if (count == 4) {
3010 : 689 : req->req.cmd->prop_set_cmd.attrib.size = 0;
3011 : : } else {
3012 : 140 : req->req.cmd->prop_set_cmd.attrib.size = 1;
3013 : : }
3014 : 829 : req->req.cmd->prop_set_cmd.ofst = pos;
3015 [ + + ]: 829 : if (is_write) {
3016 : 310 : req->req.cmd->prop_set_cmd.fctype = SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET;
3017 [ + + ]: 310 : if (req->req.cmd->prop_set_cmd.attrib.size) {
3018 : 70 : req->req.cmd->prop_set_cmd.value.u64 = *(uint64_t *)buf;
3019 : : } else {
3020 : 240 : req->req.cmd->prop_set_cmd.value.u32.high = 0;
3021 : 240 : req->req.cmd->prop_set_cmd.value.u32.low = *(uint32_t *)buf;
3022 : : }
3023 : : } else {
3024 : 519 : req->req.cmd->prop_get_cmd.fctype = SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET;
3025 : : }
3026 : 829 : req->req.length = count;
3027 : 829 : SPDK_IOV_ONE(req->req.iov, &req->req.iovcnt, buf, req->req.length);
3028 : :
3029 : 829 : spdk_nvmf_request_exec(&req->req);
3030 : :
3031 : 829 : return count;
3032 : : }
3033 : :
3034 : : static ssize_t
3035 : 829 : access_bar0_fn(vfu_ctx_t *vfu_ctx, char *buf, size_t count, loff_t pos,
3036 : : bool is_write)
3037 : : {
3038 : 829 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
3039 : : struct nvmf_vfio_user_ctrlr *ctrlr;
3040 : : int ret;
3041 : :
3042 : 829 : ctrlr = endpoint->ctrlr;
3043 [ - + + - : 829 : if (spdk_unlikely(endpoint->need_async_destroy || !ctrlr)) {
- + ]
3044 : 0 : errno = EIO;
3045 : 0 : return -1;
3046 : : }
3047 : :
3048 [ - + ]: 829 : if (pos >= NVME_DOORBELLS_OFFSET) {
3049 : : /*
3050 : : * The fact that the doorbells can be memory mapped doesn't mean
3051 : : * that the client (VFIO in QEMU) is obliged to memory map them,
3052 : : * it might still elect to access them via regular read/write;
3053 : : * we might also have had disable_mappable_bar0 set.
3054 : : */
3055 : 0 : ret = handle_dbl_access(ctrlr, (uint32_t *)buf, count,
3056 : : pos, is_write);
3057 [ # # ]: 0 : if (ret == 0) {
3058 : 0 : return count;
3059 : : }
3060 : 0 : return ret;
3061 : : }
3062 : :
3063 : 829 : return vfio_user_property_access(ctrlr, buf, count, pos, is_write);
3064 : : }
3065 : :
3066 : : static ssize_t
3067 : 12 : access_pci_config(vfu_ctx_t *vfu_ctx, char *buf, size_t count, loff_t offset,
3068 : : bool is_write)
3069 : : {
3070 : 12 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
3071 : :
3072 [ - + ]: 12 : if (is_write) {
3073 : 0 : SPDK_ERRLOG("%s: write %#lx-%#lx not supported\n",
3074 : : endpoint_id(endpoint), offset, offset + count);
3075 : 0 : errno = EINVAL;
3076 : 0 : return -1;
3077 : : }
3078 : :
3079 [ - + ]: 12 : if (offset + count > NVME_REG_CFG_SIZE) {
3080 : 0 : SPDK_ERRLOG("%s: access past end of extended PCI configuration space, want=%ld+%ld, max=%d\n",
3081 : : endpoint_id(endpoint), offset, count,
3082 : : NVME_REG_CFG_SIZE);
3083 : 0 : errno = ERANGE;
3084 : 0 : return -1;
3085 : : }
3086 : :
3087 [ - + - + ]: 12 : memcpy(buf, ((unsigned char *)endpoint->pci_config_space) + offset, count);
3088 : :
3089 : 12 : return count;
3090 : : }
3091 : :
3092 : : static void
3093 : 0 : vfio_user_log(vfu_ctx_t *vfu_ctx, int level, char const *msg)
3094 : : {
3095 : 0 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
3096 : :
3097 [ # # ]: 0 : if (level >= LOG_DEBUG) {
3098 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s: %s\n", endpoint_id(endpoint), msg);
3099 [ # # ]: 0 : } else if (level >= LOG_INFO) {
3100 [ # # # # ]: 0 : SPDK_INFOLOG(nvmf_vfio, "%s: %s\n", endpoint_id(endpoint), msg);
3101 [ # # ]: 0 : } else if (level >= LOG_NOTICE) {
3102 : 0 : SPDK_NOTICELOG("%s: %s\n", endpoint_id(endpoint), msg);
3103 [ # # ]: 0 : } else if (level >= LOG_WARNING) {
3104 : 0 : SPDK_WARNLOG("%s: %s\n", endpoint_id(endpoint), msg);
3105 : : } else {
3106 : 0 : SPDK_ERRLOG("%s: %s\n", endpoint_id(endpoint), msg);
3107 : : }
3108 : 0 : }
3109 : :
3110 : : static int
3111 : 17 : vfio_user_get_log_level(void)
3112 : : {
3113 : : int level;
3114 : :
3115 [ - + ]: 17 : if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf_vfio")) {
3116 : 0 : return LOG_DEBUG;
3117 : : }
3118 : :
3119 : 17 : level = spdk_log_to_syslog_level(spdk_log_get_level());
3120 [ - + ]: 17 : if (level < 0) {
3121 : 0 : return LOG_ERR;
3122 : : }
3123 : :
3124 : 17 : return level;
3125 : : }
3126 : :
3127 : : static void
3128 : 17 : init_pci_config_space(vfu_pci_config_space_t *p)
3129 : : {
3130 : : /* MLBAR */
3131 : 17 : p->hdr.bars[0].raw = 0x0;
3132 : : /* MUBAR */
3133 : 17 : p->hdr.bars[1].raw = 0x0;
3134 : :
3135 : : /* vendor specific, let's set them to zero for now */
3136 : 17 : p->hdr.bars[3].raw = 0x0;
3137 : 17 : p->hdr.bars[4].raw = 0x0;
3138 : 17 : p->hdr.bars[5].raw = 0x0;
3139 : :
3140 : : /* enable INTx */
3141 : 17 : p->hdr.intr.ipin = 0x1;
3142 : 17 : }
3143 : :
3144 : : struct ctrlr_quiesce_ctx {
3145 : : struct nvmf_vfio_user_endpoint *endpoint;
3146 : : struct nvmf_vfio_user_poll_group *group;
3147 : : int status;
3148 : : };
3149 : :
3150 : : static void ctrlr_quiesce(struct nvmf_vfio_user_ctrlr *vu_ctrlr);
3151 : :
3152 : : static void
3153 : 244 : _vfio_user_endpoint_resume_done_msg(void *ctx)
3154 : : {
3155 : 244 : struct nvmf_vfio_user_endpoint *endpoint = ctx;
3156 : 244 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = endpoint->ctrlr;
3157 : :
3158 : 244 : endpoint->need_resume = false;
3159 : :
3160 [ - + ]: 244 : if (!vu_ctrlr) {
3161 : 0 : return;
3162 : : }
3163 : :
3164 [ - + + + ]: 244 : if (!vu_ctrlr->queued_quiesce) {
3165 : 239 : vu_ctrlr->state = VFIO_USER_CTRLR_RUNNING;
3166 : :
3167 : : /*
3168 : : * We might have ignored new SQ entries while we were quiesced:
3169 : : * kick ourselves so we'll definitely check again while in
3170 : : * VFIO_USER_CTRLR_RUNNING state.
3171 : : */
3172 [ - + ]: 239 : if (in_interrupt_mode(endpoint->transport)) {
3173 : 0 : ctrlr_kick(vu_ctrlr);
3174 : : }
3175 : 239 : return;
3176 : : }
3177 : :
3178 : :
3179 : : /*
3180 : : * Basically, once we call `vfu_device_quiesced` the device is
3181 : : * unquiesced from libvfio-user's perspective so from the moment
3182 : : * `vfio_user_quiesce_done` returns libvfio-user might quiesce the device
3183 : : * again. However, because the NVMf subsytem is an asynchronous
3184 : : * operation, this quiesce might come _before_ the NVMf subsystem has
3185 : : * been resumed, so in the callback of `spdk_nvmf_subsystem_resume` we
3186 : : * need to check whether a quiesce was requested.
3187 : : */
3188 [ - + - + ]: 5 : SPDK_DEBUGLOG(nvmf_vfio, "%s has queued quiesce event, quiesce again\n",
3189 : : ctrlr_id(vu_ctrlr));
3190 : 5 : ctrlr_quiesce(vu_ctrlr);
3191 : : }
3192 : :
3193 : : static void
3194 : 244 : vfio_user_endpoint_resume_done(struct spdk_nvmf_subsystem *subsystem,
3195 : : void *cb_arg, int status)
3196 : : {
3197 : 244 : struct nvmf_vfio_user_endpoint *endpoint = cb_arg;
3198 : 244 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = endpoint->ctrlr;
3199 : :
3200 [ - + - + ]: 244 : SPDK_DEBUGLOG(nvmf_vfio, "%s resumed done with status %d\n", endpoint_id(endpoint), status);
3201 : :
3202 [ - + ]: 244 : if (!vu_ctrlr) {
3203 : 0 : return;
3204 : : }
3205 : :
3206 : 244 : spdk_thread_send_msg(vu_ctrlr->thread, _vfio_user_endpoint_resume_done_msg, endpoint);
3207 : : }
3208 : :
3209 : : static void
3210 : 244 : vfio_user_quiesce_done(void *ctx)
3211 : : {
3212 : 244 : struct ctrlr_quiesce_ctx *quiesce_ctx = ctx;
3213 : 244 : struct nvmf_vfio_user_endpoint *endpoint = quiesce_ctx->endpoint;
3214 : 244 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = endpoint->ctrlr;
3215 : : int ret;
3216 : :
3217 [ - + ]: 244 : if (!vu_ctrlr) {
3218 : 0 : free(quiesce_ctx);
3219 : 0 : return;
3220 : : }
3221 : :
3222 [ - + - + ]: 244 : SPDK_DEBUGLOG(nvmf_vfio, "%s device quiesced\n", ctrlr_id(vu_ctrlr));
3223 : :
3224 [ - + ]: 244 : assert(vu_ctrlr->state == VFIO_USER_CTRLR_PAUSING);
3225 : 244 : vu_ctrlr->state = VFIO_USER_CTRLR_PAUSED;
3226 : 244 : vfu_device_quiesced(endpoint->vfu_ctx, quiesce_ctx->status);
3227 : 244 : vu_ctrlr->queued_quiesce = false;
3228 : 244 : free(quiesce_ctx);
3229 : :
3230 : : /* `vfu_device_quiesced` can change the migration state,
3231 : : * so we need to re-check `vu_ctrlr->state`.
3232 : : */
3233 [ - + ]: 244 : if (vu_ctrlr->state == VFIO_USER_CTRLR_MIGRATING) {
3234 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s is in MIGRATION state\n", ctrlr_id(vu_ctrlr));
3235 : 0 : return;
3236 : : }
3237 : :
3238 [ - + - + ]: 244 : SPDK_DEBUGLOG(nvmf_vfio, "%s start to resume\n", ctrlr_id(vu_ctrlr));
3239 : 244 : vu_ctrlr->state = VFIO_USER_CTRLR_RESUMING;
3240 : 244 : ret = spdk_nvmf_subsystem_resume((struct spdk_nvmf_subsystem *)endpoint->subsystem,
3241 : : vfio_user_endpoint_resume_done, endpoint);
3242 [ - + ]: 244 : if (ret < 0) {
3243 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_PAUSED;
3244 : 0 : SPDK_ERRLOG("%s: failed to resume, ret=%d\n", endpoint_id(endpoint), ret);
3245 : : }
3246 : : }
3247 : :
3248 : : static void
3249 : 244 : vfio_user_pause_done(struct spdk_nvmf_subsystem *subsystem,
3250 : : void *ctx, int status)
3251 : : {
3252 : 244 : struct ctrlr_quiesce_ctx *quiesce_ctx = ctx;
3253 : 244 : struct nvmf_vfio_user_endpoint *endpoint = quiesce_ctx->endpoint;
3254 : 244 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = endpoint->ctrlr;
3255 : :
3256 [ - + ]: 244 : if (!vu_ctrlr) {
3257 : 0 : free(quiesce_ctx);
3258 : 0 : return;
3259 : : }
3260 : :
3261 : 244 : quiesce_ctx->status = status;
3262 : :
3263 [ - + - + ]: 244 : SPDK_DEBUGLOG(nvmf_vfio, "%s pause done with status %d\n",
3264 : : ctrlr_id(vu_ctrlr), status);
3265 : :
3266 : 244 : spdk_thread_send_msg(vu_ctrlr->thread,
3267 : : vfio_user_quiesce_done, ctx);
3268 : : }
3269 : :
3270 : : /*
3271 : : * Ensure that, for this PG, we've stopped running in nvmf_vfio_user_sq_poll();
3272 : : * we've already set ctrlr->state, so we won't process new entries, but we need
3273 : : * to ensure that this PG is quiesced. This only works because there's no
3274 : : * callback context set up between polling the SQ and spdk_nvmf_request_exec().
3275 : : *
3276 : : * Once we've walked all PGs, we need to pause any submitted I/O via
3277 : : * spdk_nvmf_subsystem_pause(SPDK_NVME_GLOBAL_NS_TAG).
3278 : : */
3279 : : static void
3280 : 942 : vfio_user_quiesce_pg(void *ctx)
3281 : : {
3282 : 942 : struct ctrlr_quiesce_ctx *quiesce_ctx = ctx;
3283 : 942 : struct nvmf_vfio_user_endpoint *endpoint = quiesce_ctx->endpoint;
3284 : 942 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = endpoint->ctrlr;
3285 : 942 : struct nvmf_vfio_user_poll_group *vu_group = quiesce_ctx->group;
3286 : 942 : struct spdk_nvmf_subsystem *subsystem = endpoint->subsystem;
3287 : : int ret;
3288 : :
3289 [ - + - + ]: 942 : SPDK_DEBUGLOG(nvmf_vfio, "quiesced pg:%p\n", vu_group);
3290 : :
3291 [ - + ]: 942 : if (!vu_ctrlr) {
3292 : 0 : free(quiesce_ctx);
3293 : 0 : return;
3294 : : }
3295 : :
3296 : 942 : quiesce_ctx->group = TAILQ_NEXT(vu_group, link);
3297 [ + + ]: 942 : if (quiesce_ctx->group != NULL) {
3298 : 698 : spdk_thread_send_msg(poll_group_to_thread(quiesce_ctx->group),
3299 : : vfio_user_quiesce_pg, quiesce_ctx);
3300 : 698 : return;
3301 : : }
3302 : :
3303 : 244 : ret = spdk_nvmf_subsystem_pause(subsystem, SPDK_NVME_GLOBAL_NS_TAG,
3304 : : vfio_user_pause_done, quiesce_ctx);
3305 [ - + ]: 244 : if (ret < 0) {
3306 : 0 : SPDK_ERRLOG("%s: failed to pause, ret=%d\n",
3307 : : endpoint_id(endpoint), ret);
3308 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_RUNNING;
3309 : 0 : fail_ctrlr(vu_ctrlr);
3310 : 0 : free(quiesce_ctx);
3311 : : }
3312 : : }
3313 : :
3314 : : static void
3315 : 244 : ctrlr_quiesce(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
3316 : : {
3317 : : struct ctrlr_quiesce_ctx *quiesce_ctx;
3318 : :
3319 : 244 : vu_ctrlr->state = VFIO_USER_CTRLR_PAUSING;
3320 : :
3321 : 244 : quiesce_ctx = calloc(1, sizeof(*quiesce_ctx));
3322 [ - + ]: 244 : if (!quiesce_ctx) {
3323 : 0 : SPDK_ERRLOG("Failed to allocate subsystem pause context\n");
3324 : 0 : assert(false);
3325 : : return;
3326 : : }
3327 : :
3328 : 244 : quiesce_ctx->endpoint = vu_ctrlr->endpoint;
3329 : 244 : quiesce_ctx->status = 0;
3330 : 244 : quiesce_ctx->group = TAILQ_FIRST(&vu_ctrlr->transport->poll_groups);
3331 : :
3332 : 244 : spdk_thread_send_msg(poll_group_to_thread(quiesce_ctx->group),
3333 : : vfio_user_quiesce_pg, quiesce_ctx);
3334 : : }
3335 : :
3336 : : static int
3337 : 587 : vfio_user_dev_quiesce_cb(vfu_ctx_t *vfu_ctx)
3338 : : {
3339 : 587 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
3340 : 587 : struct spdk_nvmf_subsystem *subsystem = endpoint->subsystem;
3341 : 587 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = endpoint->ctrlr;
3342 : :
3343 [ - + ]: 587 : if (!vu_ctrlr) {
3344 : 0 : return 0;
3345 : : }
3346 : :
3347 : : /* NVMf library will destruct controller when no
3348 : : * connected queue pairs.
3349 : : */
3350 [ - + ]: 587 : if (!nvmf_subsystem_get_ctrlr(subsystem, vu_ctrlr->cntlid)) {
3351 : 0 : return 0;
3352 : : }
3353 : :
3354 [ - + - + ]: 587 : SPDK_DEBUGLOG(nvmf_vfio, "%s starts to quiesce\n", ctrlr_id(vu_ctrlr));
3355 : :
3356 : : /* There is no race condition here as device quiesce callback
3357 : : * and nvmf_prop_set_cc() are running in the same thread context.
3358 : : */
3359 [ + + ]: 587 : if (!vu_ctrlr->ctrlr->vcprop.cc.bits.en) {
3360 : 265 : return 0;
3361 [ - + ]: 322 : } else if (!vu_ctrlr->ctrlr->vcprop.csts.bits.rdy) {
3362 : 0 : return 0;
3363 [ + + ]: 322 : } else if (vu_ctrlr->ctrlr->vcprop.csts.bits.shst == SPDK_NVME_SHST_COMPLETE) {
3364 : 78 : return 0;
3365 : : }
3366 : :
3367 [ - + + - ]: 244 : switch (vu_ctrlr->state) {
3368 : 0 : case VFIO_USER_CTRLR_PAUSED:
3369 : : case VFIO_USER_CTRLR_MIGRATING:
3370 : 0 : return 0;
3371 : 239 : case VFIO_USER_CTRLR_RUNNING:
3372 : 239 : ctrlr_quiesce(vu_ctrlr);
3373 : 239 : break;
3374 : 5 : case VFIO_USER_CTRLR_RESUMING:
3375 : 5 : vu_ctrlr->queued_quiesce = true;
3376 [ - + - + ]: 5 : SPDK_DEBUGLOG(nvmf_vfio, "%s is busy to quiesce, current state %u\n", ctrlr_id(vu_ctrlr),
3377 : : vu_ctrlr->state);
3378 : 5 : break;
3379 : 0 : default:
3380 [ # # ]: 0 : assert(vu_ctrlr->state != VFIO_USER_CTRLR_PAUSING);
3381 : 0 : break;
3382 : : }
3383 : :
3384 : 244 : errno = EBUSY;
3385 : 244 : return -1;
3386 : : }
3387 : :
3388 : : static void
3389 : 0 : vfio_user_ctrlr_dump_migr_data(const char *name,
3390 : : struct vfio_user_nvme_migr_state *migr_data,
3391 : : struct nvmf_vfio_user_shadow_doorbells *sdbl)
3392 : : {
3393 : : struct spdk_nvmf_registers *regs;
3394 : : struct nvme_migr_sq_state *sq;
3395 : : struct nvme_migr_cq_state *cq;
3396 : : uint32_t *doorbell_base;
3397 : : uint32_t i;
3398 : :
3399 : 0 : SPDK_NOTICELOG("Dump %s\n", name);
3400 : :
3401 : 0 : regs = &migr_data->nvmf_data.regs;
3402 : 0 : doorbell_base = (uint32_t *)&migr_data->doorbells;
3403 : :
3404 : 0 : SPDK_NOTICELOG("Registers\n");
3405 : 0 : SPDK_NOTICELOG("CSTS 0x%x\n", regs->csts.raw);
3406 : 0 : SPDK_NOTICELOG("CAP 0x%"PRIx64"\n", regs->cap.raw);
3407 : 0 : SPDK_NOTICELOG("VS 0x%x\n", regs->vs.raw);
3408 : 0 : SPDK_NOTICELOG("CC 0x%x\n", regs->cc.raw);
3409 : 0 : SPDK_NOTICELOG("AQA 0x%x\n", regs->aqa.raw);
3410 : 0 : SPDK_NOTICELOG("ASQ 0x%"PRIx64"\n", regs->asq);
3411 : 0 : SPDK_NOTICELOG("ACQ 0x%"PRIx64"\n", regs->acq);
3412 : :
3413 : 0 : SPDK_NOTICELOG("Number of IO Queues %u\n", migr_data->ctrlr_header.num_io_queues);
3414 : :
3415 [ # # ]: 0 : if (sdbl != NULL) {
3416 : 0 : SPDK_NOTICELOG("shadow doorbell buffer=%#lx\n",
3417 : : migr_data->ctrlr_header.shadow_doorbell_buffer);
3418 : 0 : SPDK_NOTICELOG("eventidx buffer=%#lx\n",
3419 : : migr_data->ctrlr_header.eventidx_buffer);
3420 : : }
3421 : :
3422 [ # # ]: 0 : for (i = 0; i < NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR; i++) {
3423 : 0 : sq = &migr_data->qps[i].sq;
3424 : 0 : cq = &migr_data->qps[i].cq;
3425 : :
3426 [ # # ]: 0 : if (sq->size) {
3427 : 0 : SPDK_NOTICELOG("sqid:%u, bar0_doorbell:%u\n", sq->sqid, doorbell_base[i * 2]);
3428 [ # # # # ]: 0 : if (i > 0 && sdbl != NULL) {
3429 : 0 : SPDK_NOTICELOG("sqid:%u, shadow_doorbell:%u, eventidx:%u\n",
3430 : : sq->sqid,
3431 : : sdbl->shadow_doorbells[queue_index(i, false)],
3432 : : sdbl->eventidxs[queue_index(i, false)]);
3433 : : }
3434 : 0 : SPDK_NOTICELOG("SQ sqid:%u, cqid:%u, sqhead:%u, size:%u, dma_addr:0x%"PRIx64"\n",
3435 : : sq->sqid, sq->cqid, sq->head, sq->size, sq->dma_addr);
3436 : : }
3437 : :
3438 [ # # ]: 0 : if (cq->size) {
3439 : 0 : SPDK_NOTICELOG("cqid:%u, bar0_doorbell:%u\n", cq->cqid, doorbell_base[i * 2 + 1]);
3440 [ # # # # ]: 0 : if (i > 0 && sdbl != NULL) {
3441 : 0 : SPDK_NOTICELOG("cqid:%u, shadow_doorbell:%u, eventidx:%u\n",
3442 : : cq->cqid,
3443 : : sdbl->shadow_doorbells[queue_index(i, true)],
3444 : : sdbl->eventidxs[queue_index(i, true)]);
3445 : : }
3446 : 0 : SPDK_NOTICELOG("CQ cqid:%u, phase:%u, cqtail:%u, size:%u, iv:%u, ien:%u, dma_addr:0x%"PRIx64"\n",
3447 : : cq->cqid, cq->phase, cq->tail, cq->size, cq->iv, cq->ien, cq->dma_addr);
3448 : : }
3449 : : }
3450 : :
3451 : 0 : SPDK_NOTICELOG("%s Dump Done\n", name);
3452 : 0 : }
3453 : :
3454 : : /* Read region 9 content and restore it to migration data structures */
3455 : : static int
3456 : 0 : vfio_user_migr_stream_to_data(struct nvmf_vfio_user_endpoint *endpoint,
3457 : : struct vfio_user_nvme_migr_state *migr_state)
3458 : : {
3459 : 0 : void *data_ptr = endpoint->migr_data;
3460 : :
3461 : : /* Load vfio_user_nvme_migr_header first */
3462 [ # # # # ]: 0 : memcpy(&migr_state->ctrlr_header, data_ptr, sizeof(struct vfio_user_nvme_migr_header));
3463 : : /* TODO: version check */
3464 [ # # ]: 0 : if (migr_state->ctrlr_header.magic != VFIO_USER_NVME_MIGR_MAGIC) {
3465 : 0 : SPDK_ERRLOG("%s: bad magic number %x\n", endpoint_id(endpoint), migr_state->ctrlr_header.magic);
3466 : 0 : return -EINVAL;
3467 : : }
3468 : :
3469 : : /* Load nvmf controller data */
3470 : 0 : data_ptr = endpoint->migr_data + migr_state->ctrlr_header.nvmf_data_offset;
3471 [ # # # # ]: 0 : memcpy(&migr_state->nvmf_data, data_ptr, migr_state->ctrlr_header.nvmf_data_len);
3472 : :
3473 : : /* Load queue pairs */
3474 : 0 : data_ptr = endpoint->migr_data + migr_state->ctrlr_header.qp_offset;
3475 [ # # # # ]: 0 : memcpy(&migr_state->qps, data_ptr, migr_state->ctrlr_header.qp_len);
3476 : :
3477 : : /* Load doorbells */
3478 : 0 : data_ptr = endpoint->migr_data + migr_state->ctrlr_header.bar_offset[VFU_PCI_DEV_BAR0_REGION_IDX];
3479 [ # # # # ]: 0 : memcpy(&migr_state->doorbells, data_ptr,
3480 : : migr_state->ctrlr_header.bar_len[VFU_PCI_DEV_BAR0_REGION_IDX]);
3481 : :
3482 : : /* Load CFG */
3483 : 0 : data_ptr = endpoint->migr_data + migr_state->ctrlr_header.bar_offset[VFU_PCI_DEV_CFG_REGION_IDX];
3484 [ # # # # ]: 0 : memcpy(&migr_state->cfg, data_ptr, migr_state->ctrlr_header.bar_len[VFU_PCI_DEV_CFG_REGION_IDX]);
3485 : :
3486 : 0 : return 0;
3487 : : }
3488 : :
3489 : :
3490 : : static void
3491 : 0 : vfio_user_migr_ctrlr_save_data(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
3492 : : {
3493 : 0 : struct spdk_nvmf_ctrlr *ctrlr = vu_ctrlr->ctrlr;
3494 : 0 : struct nvmf_vfio_user_endpoint *endpoint = vu_ctrlr->endpoint;
3495 : : struct nvmf_vfio_user_sq *sq;
3496 : : struct nvmf_vfio_user_cq *cq;
3497 : : uint64_t data_offset;
3498 : : void *data_ptr;
3499 : : uint32_t *doorbell_base;
3500 : 0 : uint32_t i = 0;
3501 : : uint16_t sqid, cqid;
3502 : 0 : struct vfio_user_nvme_migr_state migr_state = {
3503 : : .nvmf_data = {
3504 : : .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused),
3505 : : .regs_size = sizeof(struct spdk_nvmf_registers),
3506 : : .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat)
3507 : : }
3508 : : };
3509 : :
3510 : : /* Save all data to vfio_user_nvme_migr_state first, then we will
3511 : : * copy it to device migration region at last.
3512 : : */
3513 : :
3514 : : /* save magic number */
3515 : 0 : migr_state.ctrlr_header.magic = VFIO_USER_NVME_MIGR_MAGIC;
3516 : :
3517 : : /* save controller data */
3518 : 0 : spdk_nvmf_ctrlr_save_migr_data(ctrlr, &migr_state.nvmf_data);
3519 : :
3520 : : /* save connected queue pairs */
3521 [ # # ]: 0 : TAILQ_FOREACH(sq, &vu_ctrlr->connected_sqs, tailq) {
3522 : : /* save sq */
3523 : 0 : sqid = sq->qid;
3524 : 0 : migr_state.qps[sqid].sq.sqid = sq->qid;
3525 : 0 : migr_state.qps[sqid].sq.cqid = sq->cqid;
3526 : 0 : migr_state.qps[sqid].sq.head = *sq_headp(sq);
3527 : 0 : migr_state.qps[sqid].sq.size = sq->size;
3528 : 0 : migr_state.qps[sqid].sq.dma_addr = sq->mapping.prp1;
3529 : :
3530 : : /* save cq, for shared cq case, cq may be saved multiple times */
3531 : 0 : cqid = sq->cqid;
3532 : 0 : cq = vu_ctrlr->cqs[cqid];
3533 : 0 : migr_state.qps[cqid].cq.cqid = cqid;
3534 : 0 : migr_state.qps[cqid].cq.tail = *cq_tailp(cq);
3535 [ # # ]: 0 : migr_state.qps[cqid].cq.ien = cq->ien;
3536 : 0 : migr_state.qps[cqid].cq.iv = cq->iv;
3537 : 0 : migr_state.qps[cqid].cq.size = cq->size;
3538 [ # # ]: 0 : migr_state.qps[cqid].cq.phase = cq->phase;
3539 : 0 : migr_state.qps[cqid].cq.dma_addr = cq->mapping.prp1;
3540 : 0 : i++;
3541 : : }
3542 : :
3543 [ # # ]: 0 : assert(i > 0);
3544 : 0 : migr_state.ctrlr_header.num_io_queues = i - 1;
3545 : :
3546 : : /* Save doorbells */
3547 : 0 : doorbell_base = (uint32_t *)&migr_state.doorbells;
3548 [ # # # # ]: 0 : memcpy(doorbell_base, (void *)vu_ctrlr->bar0_doorbells, NVMF_VFIO_USER_DOORBELLS_SIZE);
3549 : :
3550 : : /* Save PCI configuration space */
3551 : 0 : memcpy(&migr_state.cfg, (void *)endpoint->pci_config_space, NVME_REG_CFG_SIZE);
3552 : :
3553 : : /* Save all data to device migration region */
3554 : 0 : data_ptr = endpoint->migr_data;
3555 : :
3556 : : /* Copy nvmf controller data */
3557 : 0 : data_offset = sizeof(struct vfio_user_nvme_migr_header);
3558 : 0 : data_ptr += data_offset;
3559 : 0 : migr_state.ctrlr_header.nvmf_data_offset = data_offset;
3560 : 0 : migr_state.ctrlr_header.nvmf_data_len = sizeof(struct spdk_nvmf_ctrlr_migr_data);
3561 [ # # # # ]: 0 : memcpy(data_ptr, &migr_state.nvmf_data, sizeof(struct spdk_nvmf_ctrlr_migr_data));
3562 : :
3563 : : /* Copy queue pairs */
3564 : 0 : data_offset += sizeof(struct spdk_nvmf_ctrlr_migr_data);
3565 : 0 : data_ptr += sizeof(struct spdk_nvmf_ctrlr_migr_data);
3566 : 0 : migr_state.ctrlr_header.qp_offset = data_offset;
3567 : 0 : migr_state.ctrlr_header.qp_len = i * (sizeof(struct nvme_migr_sq_state) + sizeof(
3568 : : struct nvme_migr_cq_state));
3569 [ # # # # ]: 0 : memcpy(data_ptr, &migr_state.qps, migr_state.ctrlr_header.qp_len);
3570 : :
3571 : : /* Copy doorbells */
3572 : 0 : data_offset += migr_state.ctrlr_header.qp_len;
3573 : 0 : data_ptr += migr_state.ctrlr_header.qp_len;
3574 : 0 : migr_state.ctrlr_header.bar_offset[VFU_PCI_DEV_BAR0_REGION_IDX] = data_offset;
3575 : 0 : migr_state.ctrlr_header.bar_len[VFU_PCI_DEV_BAR0_REGION_IDX] = NVMF_VFIO_USER_DOORBELLS_SIZE;
3576 : 0 : memcpy(data_ptr, &migr_state.doorbells, NVMF_VFIO_USER_DOORBELLS_SIZE);
3577 : :
3578 : : /* Copy CFG */
3579 : 0 : data_offset += NVMF_VFIO_USER_DOORBELLS_SIZE;
3580 : 0 : data_ptr += NVMF_VFIO_USER_DOORBELLS_SIZE;
3581 : 0 : migr_state.ctrlr_header.bar_offset[VFU_PCI_DEV_CFG_REGION_IDX] = data_offset;
3582 : 0 : migr_state.ctrlr_header.bar_len[VFU_PCI_DEV_CFG_REGION_IDX] = NVME_REG_CFG_SIZE;
3583 : 0 : memcpy(data_ptr, &migr_state.cfg, NVME_REG_CFG_SIZE);
3584 : :
3585 : : /* copy shadow doorbells */
3586 [ # # ]: 0 : if (vu_ctrlr->sdbl != NULL) {
3587 : 0 : migr_state.ctrlr_header.sdbl = true;
3588 : 0 : migr_state.ctrlr_header.shadow_doorbell_buffer = vu_ctrlr->shadow_doorbell_buffer;
3589 : 0 : migr_state.ctrlr_header.eventidx_buffer = vu_ctrlr->eventidx_buffer;
3590 : : }
3591 : :
3592 : : /* Copy nvme migration header finally */
3593 [ # # # # ]: 0 : memcpy(endpoint->migr_data, &migr_state.ctrlr_header, sizeof(struct vfio_user_nvme_migr_header));
3594 : :
3595 [ # # ]: 0 : if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf_vfio")) {
3596 : 0 : vfio_user_ctrlr_dump_migr_data("SAVE", &migr_state, vu_ctrlr->sdbl);
3597 : : }
3598 : 0 : }
3599 : :
3600 : : /*
3601 : : * If we are about to close the connection, we need to unregister the interrupt,
3602 : : * as the library will subsequently close the file descriptor we registered.
3603 : : */
3604 : : static int
3605 : 68 : vfio_user_device_reset(vfu_ctx_t *vfu_ctx, vfu_reset_type_t type)
3606 : : {
3607 : 68 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
3608 : 68 : struct nvmf_vfio_user_ctrlr *ctrlr = endpoint->ctrlr;
3609 : :
3610 [ - + - + ]: 68 : SPDK_DEBUGLOG(nvmf_vfio, "Device reset type %u\n", type);
3611 : :
3612 [ + + ]: 68 : if (type == VFU_RESET_LOST_CONN) {
3613 [ + + ]: 56 : if (ctrlr != NULL) {
3614 : 39 : spdk_interrupt_unregister(&ctrlr->intr);
3615 : 39 : ctrlr->intr_fd = -1;
3616 : : }
3617 : 56 : return 0;
3618 : : }
3619 : :
3620 : : /* FIXME: LOST_CONN case ? */
3621 [ - + ]: 12 : if (ctrlr->sdbl != NULL) {
3622 : 0 : vfio_user_ctrlr_switch_doorbells(ctrlr, false);
3623 : 0 : free_sdbl(vfu_ctx, ctrlr->sdbl);
3624 : 0 : ctrlr->sdbl = NULL;
3625 : : }
3626 : :
3627 : : /* FIXME: much more needed here. */
3628 : :
3629 : 12 : return 0;
3630 : : }
3631 : :
3632 : : static int
3633 : 0 : vfio_user_migr_ctrlr_construct_qps(struct nvmf_vfio_user_ctrlr *vu_ctrlr,
3634 : : struct vfio_user_nvme_migr_state *migr_state)
3635 : : {
3636 : 0 : uint32_t i, qsize = 0;
3637 : : uint16_t sqid, cqid;
3638 : : struct vfio_user_nvme_migr_qp migr_qp;
3639 : : void *addr;
3640 : 0 : uint32_t cqs_ref[NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR] = {};
3641 : : int ret;
3642 : :
3643 [ # # ]: 0 : if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf_vfio")) {
3644 : 0 : vfio_user_ctrlr_dump_migr_data("RESUME", migr_state, vu_ctrlr->sdbl);
3645 : : }
3646 : :
3647 : : /* restore submission queues */
3648 [ # # ]: 0 : for (i = 0; i < NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR; i++) {
3649 : 0 : migr_qp = migr_state->qps[i];
3650 : :
3651 : 0 : qsize = migr_qp.sq.size;
3652 [ # # ]: 0 : if (qsize) {
3653 : : struct nvmf_vfio_user_sq *sq;
3654 : :
3655 : 0 : sqid = migr_qp.sq.sqid;
3656 [ # # ]: 0 : if (sqid != i) {
3657 : 0 : SPDK_ERRLOG("Expected sqid %u while got %u", i, sqid);
3658 : 0 : return -EINVAL;
3659 : : }
3660 : :
3661 : : /* allocate sq if necessary */
3662 [ # # ]: 0 : if (vu_ctrlr->sqs[sqid] == NULL) {
3663 : 0 : ret = init_sq(vu_ctrlr, &vu_ctrlr->transport->transport, sqid);
3664 [ # # ]: 0 : if (ret) {
3665 : 0 : SPDK_ERRLOG("Construct qpair with qid %u failed\n", sqid);
3666 : 0 : return -EFAULT;
3667 : : }
3668 : : }
3669 : :
3670 : 0 : sq = vu_ctrlr->sqs[sqid];
3671 : 0 : sq->size = qsize;
3672 : :
3673 : 0 : ret = alloc_sq_reqs(vu_ctrlr, sq);
3674 [ # # ]: 0 : if (ret) {
3675 : 0 : SPDK_ERRLOG("Construct sq with qid %u failed\n", sqid);
3676 : 0 : return -EFAULT;
3677 : : }
3678 : :
3679 : : /* restore sq */
3680 : 0 : sq->sq_state = VFIO_USER_SQ_CREATED;
3681 : 0 : sq->cqid = migr_qp.sq.cqid;
3682 : 0 : *sq_headp(sq) = migr_qp.sq.head;
3683 : 0 : sq->mapping.prp1 = migr_qp.sq.dma_addr;
3684 : 0 : sq->mapping.len = sq->size * sizeof(struct spdk_nvme_cmd);
3685 : 0 : addr = map_one(vu_ctrlr->endpoint->vfu_ctx,
3686 : : sq->mapping.prp1, sq->mapping.len,
3687 : : sq->mapping.sg, &sq->mapping.iov,
3688 : : PROT_READ);
3689 [ # # ]: 0 : if (addr == NULL) {
3690 : 0 : SPDK_ERRLOG("Restore sq with qid %u PRP1 0x%"PRIx64" with size %u failed\n",
3691 : : sqid, sq->mapping.prp1, sq->size);
3692 : 0 : return -EFAULT;
3693 : : }
3694 : 0 : cqs_ref[sq->cqid]++;
3695 : : }
3696 : : }
3697 : :
3698 : : /* restore completion queues */
3699 [ # # ]: 0 : for (i = 0; i < NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR; i++) {
3700 : 0 : migr_qp = migr_state->qps[i];
3701 : :
3702 : 0 : qsize = migr_qp.cq.size;
3703 [ # # ]: 0 : if (qsize) {
3704 : : struct nvmf_vfio_user_cq *cq;
3705 : :
3706 : : /* restore cq */
3707 : 0 : cqid = migr_qp.sq.cqid;
3708 [ # # ]: 0 : assert(cqid == i);
3709 : :
3710 : : /* allocate cq if necessary */
3711 [ # # ]: 0 : if (vu_ctrlr->cqs[cqid] == NULL) {
3712 : 0 : ret = init_cq(vu_ctrlr, cqid);
3713 [ # # ]: 0 : if (ret) {
3714 : 0 : SPDK_ERRLOG("Construct qpair with qid %u failed\n", cqid);
3715 : 0 : return -EFAULT;
3716 : : }
3717 : : }
3718 : :
3719 : 0 : cq = vu_ctrlr->cqs[cqid];
3720 : :
3721 : 0 : cq->size = qsize;
3722 : :
3723 : 0 : cq->cq_state = VFIO_USER_CQ_CREATED;
3724 : 0 : cq->cq_ref = cqs_ref[cqid];
3725 : 0 : *cq_tailp(cq) = migr_qp.cq.tail;
3726 : 0 : cq->mapping.prp1 = migr_qp.cq.dma_addr;
3727 : 0 : cq->mapping.len = cq->size * sizeof(struct spdk_nvme_cpl);
3728 : 0 : cq->ien = migr_qp.cq.ien;
3729 : 0 : cq->iv = migr_qp.cq.iv;
3730 : 0 : cq->phase = migr_qp.cq.phase;
3731 : 0 : addr = map_one(vu_ctrlr->endpoint->vfu_ctx,
3732 : : cq->mapping.prp1, cq->mapping.len,
3733 : : cq->mapping.sg, &cq->mapping.iov,
3734 : : PROT_READ | PROT_WRITE);
3735 [ # # ]: 0 : if (addr == NULL) {
3736 : 0 : SPDK_ERRLOG("Restore cq with qid %u PRP1 0x%"PRIx64" with size %u failed\n",
3737 : : cqid, cq->mapping.prp1, cq->size);
3738 : 0 : return -EFAULT;
3739 : : }
3740 : : }
3741 : : }
3742 : :
3743 : 0 : return 0;
3744 : : }
3745 : :
3746 : : static int
3747 : 0 : vfio_user_migr_ctrlr_restore(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
3748 : : {
3749 : 0 : struct nvmf_vfio_user_endpoint *endpoint = vu_ctrlr->endpoint;
3750 : 0 : struct spdk_nvmf_ctrlr *ctrlr = vu_ctrlr->ctrlr;
3751 : : uint32_t *doorbell_base;
3752 : 0 : struct spdk_nvme_cmd cmd;
3753 : : uint16_t i;
3754 : 0 : int rc = 0;
3755 : 0 : struct vfio_user_nvme_migr_state migr_state = {
3756 : : .nvmf_data = {
3757 : : .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused),
3758 : : .regs_size = sizeof(struct spdk_nvmf_registers),
3759 : : .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat)
3760 : : }
3761 : : };
3762 : :
3763 [ # # ]: 0 : assert(endpoint->migr_data != NULL);
3764 [ # # ]: 0 : assert(ctrlr != NULL);
3765 : 0 : rc = vfio_user_migr_stream_to_data(endpoint, &migr_state);
3766 [ # # ]: 0 : if (rc) {
3767 : 0 : return rc;
3768 : : }
3769 : :
3770 : : /* restore shadow doorbells */
3771 [ # # ]: 0 : if (migr_state.ctrlr_header.sdbl) {
3772 : : struct nvmf_vfio_user_shadow_doorbells *sdbl;
3773 : 0 : sdbl = map_sdbl(vu_ctrlr->endpoint->vfu_ctx,
3774 : : migr_state.ctrlr_header.shadow_doorbell_buffer,
3775 : : migr_state.ctrlr_header.eventidx_buffer,
3776 : : memory_page_size(vu_ctrlr));
3777 [ # # ]: 0 : if (sdbl == NULL) {
3778 : 0 : SPDK_ERRLOG("%s: failed to re-map shadow doorbell buffers\n",
3779 : : ctrlr_id(vu_ctrlr));
3780 : 0 : return -1;
3781 : : }
3782 : :
3783 : 0 : vu_ctrlr->shadow_doorbell_buffer = migr_state.ctrlr_header.shadow_doorbell_buffer;
3784 : 0 : vu_ctrlr->eventidx_buffer = migr_state.ctrlr_header.eventidx_buffer;
3785 : :
3786 : 0 : SWAP(vu_ctrlr->sdbl, sdbl);
3787 : : }
3788 : :
3789 : 0 : rc = vfio_user_migr_ctrlr_construct_qps(vu_ctrlr, &migr_state);
3790 [ # # ]: 0 : if (rc) {
3791 : 0 : return rc;
3792 : : }
3793 : :
3794 : : /* restore PCI configuration space */
3795 : 0 : memcpy((void *)endpoint->pci_config_space, &migr_state.cfg, NVME_REG_CFG_SIZE);
3796 : :
3797 : 0 : doorbell_base = (uint32_t *)&migr_state.doorbells;
3798 : : /* restore doorbells from saved registers */
3799 [ # # # # ]: 0 : memcpy((void *)vu_ctrlr->bar0_doorbells, doorbell_base, NVMF_VFIO_USER_DOORBELLS_SIZE);
3800 : :
3801 : : /* restore nvmf controller data */
3802 : 0 : rc = spdk_nvmf_ctrlr_restore_migr_data(ctrlr, &migr_state.nvmf_data);
3803 [ # # ]: 0 : if (rc) {
3804 : 0 : return rc;
3805 : : }
3806 : :
3807 : : /* resubmit pending AERs */
3808 [ # # ]: 0 : for (i = 0; i < migr_state.nvmf_data.num_aer_cids; i++) {
3809 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s AER resubmit, CID %u\n", ctrlr_id(vu_ctrlr),
3810 : : migr_state.nvmf_data.aer_cids[i]);
3811 : 0 : memset(&cmd, 0, sizeof(cmd));
3812 : 0 : cmd.opc = SPDK_NVME_OPC_ASYNC_EVENT_REQUEST;
3813 : 0 : cmd.cid = migr_state.nvmf_data.aer_cids[i];
3814 : 0 : rc = handle_cmd_req(vu_ctrlr, &cmd, vu_ctrlr->sqs[0]);
3815 [ # # ]: 0 : if (spdk_unlikely(rc)) {
3816 : 0 : break;
3817 : : }
3818 : : }
3819 : :
3820 : 0 : return rc;
3821 : : }
3822 : :
3823 : : static void
3824 : 0 : vfio_user_migr_ctrlr_enable_sqs(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
3825 : : {
3826 : : uint32_t i;
3827 : : struct nvmf_vfio_user_sq *sq;
3828 : :
3829 : : /* The Admin queue (qid: 0) does not ever use shadow doorbells. */
3830 : :
3831 [ # # ]: 0 : if (vu_ctrlr->sqs[0] != NULL) {
3832 : 0 : vu_ctrlr->sqs[0]->dbl_tailp = vu_ctrlr->bar0_doorbells +
3833 : 0 : queue_index(0, false);
3834 : : }
3835 : :
3836 [ # # ]: 0 : if (vu_ctrlr->cqs[0] != NULL) {
3837 : 0 : vu_ctrlr->cqs[0]->dbl_headp = vu_ctrlr->bar0_doorbells +
3838 : 0 : queue_index(0, true);
3839 : : }
3840 : :
3841 : 0 : vfio_user_ctrlr_switch_doorbells(vu_ctrlr, vu_ctrlr->sdbl != NULL);
3842 : :
3843 [ # # ]: 0 : for (i = 0; i < NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR; i++) {
3844 : 0 : sq = vu_ctrlr->sqs[i];
3845 [ # # # # ]: 0 : if (!sq || !sq->size) {
3846 : 0 : continue;
3847 : : }
3848 : :
3849 [ # # ]: 0 : if (nvmf_qpair_is_admin_queue(&sq->qpair)) {
3850 : : /* ADMIN queue pair is always in the poll group, just enable it */
3851 : 0 : sq->sq_state = VFIO_USER_SQ_ACTIVE;
3852 : : } else {
3853 : 0 : spdk_nvmf_tgt_new_qpair(vu_ctrlr->transport->transport.tgt, &sq->qpair);
3854 : : }
3855 : : }
3856 : 0 : }
3857 : :
3858 : : /*
3859 : : * We are in stop-and-copy state, but still potentially have some current dirty
3860 : : * sgls: while we're quiesced and thus should have no active requests, we still
3861 : : * have potentially dirty maps of the shadow doorbells and the CQs (SQs are
3862 : : * mapped read only).
3863 : : *
3864 : : * Since we won't be calling vfu_sgl_put() for them, we need to explicitly
3865 : : * mark them dirty now.
3866 : : */
3867 : : static void
3868 : 0 : vfio_user_migr_ctrlr_mark_dirty(struct nvmf_vfio_user_ctrlr *vu_ctrlr)
3869 : : {
3870 : 0 : struct nvmf_vfio_user_endpoint *endpoint = vu_ctrlr->endpoint;
3871 : :
3872 [ # # ]: 0 : assert(vu_ctrlr->state == VFIO_USER_CTRLR_MIGRATING);
3873 : :
3874 [ # # ]: 0 : for (size_t i = 0; i < NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR; i++) {
3875 : 0 : struct nvmf_vfio_user_cq *cq = vu_ctrlr->cqs[i];
3876 : :
3877 [ # # # # ]: 0 : if (cq == NULL || q_addr(&cq->mapping) == NULL) {
3878 : 0 : continue;
3879 : : }
3880 : :
3881 : 0 : vfu_sgl_mark_dirty(endpoint->vfu_ctx, cq->mapping.sg, 1);
3882 : : }
3883 : :
3884 [ # # ]: 0 : if (vu_ctrlr->sdbl != NULL) {
3885 : : dma_sg_t *sg;
3886 : : size_t i;
3887 : :
3888 [ # # ]: 0 : for (i = 0; i < NVMF_VFIO_USER_SHADOW_DOORBELLS_BUFFER_COUNT;
3889 : 0 : ++i) {
3890 : :
3891 [ # # ]: 0 : if (!vu_ctrlr->sdbl->iovs[i].iov_len) {
3892 : 0 : continue;
3893 : : }
3894 : :
3895 : 0 : sg = index_to_sg_t(vu_ctrlr->sdbl->sgs, i);
3896 : :
3897 : 0 : vfu_sgl_mark_dirty(endpoint->vfu_ctx, sg, 1);
3898 : : }
3899 : : }
3900 : 0 : }
3901 : :
3902 : : static int
3903 : 0 : vfio_user_migration_device_state_transition(vfu_ctx_t *vfu_ctx, vfu_migr_state_t state)
3904 : : {
3905 : 0 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
3906 : 0 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = endpoint->ctrlr;
3907 : : struct nvmf_vfio_user_sq *sq;
3908 : 0 : int ret = 0;
3909 : :
3910 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s controller state %u, migration state %u\n", endpoint_id(endpoint),
3911 : : vu_ctrlr->state, state);
3912 : :
3913 [ # # # # : 0 : switch (state) {
# # ]
3914 : 0 : case VFU_MIGR_STATE_STOP_AND_COPY:
3915 : 0 : vu_ctrlr->in_source_vm = true;
3916 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_MIGRATING;
3917 : 0 : vfio_user_migr_ctrlr_mark_dirty(vu_ctrlr);
3918 : 0 : vfio_user_migr_ctrlr_save_data(vu_ctrlr);
3919 : 0 : break;
3920 : 0 : case VFU_MIGR_STATE_STOP:
3921 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_MIGRATING;
3922 : : /* The controller associates with source VM is dead now, we will resume
3923 : : * the subsystem after destroying the controller data structure, then the
3924 : : * subsystem can be re-used for another new client.
3925 : : */
3926 [ # # # # ]: 0 : if (vu_ctrlr->in_source_vm) {
3927 : 0 : endpoint->need_resume = true;
3928 : : }
3929 : 0 : break;
3930 : 0 : case VFU_MIGR_STATE_PRE_COPY:
3931 [ # # ]: 0 : assert(vu_ctrlr->state == VFIO_USER_CTRLR_PAUSED);
3932 : 0 : break;
3933 : 0 : case VFU_MIGR_STATE_RESUME:
3934 : : /*
3935 : : * Destination ADMIN queue pair is connected when starting the VM,
3936 : : * but the ADMIN queue pair isn't enabled in destination VM, the poll
3937 : : * group will do nothing to ADMIN queue pair for now.
3938 : : */
3939 [ # # ]: 0 : if (vu_ctrlr->state != VFIO_USER_CTRLR_RUNNING) {
3940 : 0 : break;
3941 : : }
3942 : :
3943 [ # # # # ]: 0 : assert(!vu_ctrlr->in_source_vm);
3944 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_MIGRATING;
3945 : :
3946 : 0 : sq = TAILQ_FIRST(&vu_ctrlr->connected_sqs);
3947 [ # # ]: 0 : assert(sq != NULL);
3948 [ # # ]: 0 : assert(sq->qpair.qid == 0);
3949 : 0 : sq->sq_state = VFIO_USER_SQ_INACTIVE;
3950 : :
3951 : : /* Free ADMIN SQ resources first, SQ resources will be
3952 : : * allocated based on queue size from source VM.
3953 : : */
3954 : 0 : free_sq_reqs(sq);
3955 : 0 : sq->size = 0;
3956 : 0 : break;
3957 : 0 : case VFU_MIGR_STATE_RUNNING:
3958 : :
3959 [ # # ]: 0 : if (vu_ctrlr->state != VFIO_USER_CTRLR_MIGRATING) {
3960 : 0 : break;
3961 : : }
3962 : :
3963 [ # # # # ]: 0 : if (!vu_ctrlr->in_source_vm) {
3964 : : /* Restore destination VM from BAR9 */
3965 : 0 : ret = vfio_user_migr_ctrlr_restore(vu_ctrlr);
3966 [ # # ]: 0 : if (ret) {
3967 : 0 : break;
3968 : : }
3969 : :
3970 : 0 : vfio_user_ctrlr_switch_doorbells(vu_ctrlr, false);
3971 : 0 : vfio_user_migr_ctrlr_enable_sqs(vu_ctrlr);
3972 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_RUNNING;
3973 : : /* FIXME where do we resume nvmf? */
3974 : : } else {
3975 : : /* Rollback source VM */
3976 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_RESUMING;
3977 : 0 : ret = spdk_nvmf_subsystem_resume((struct spdk_nvmf_subsystem *)endpoint->subsystem,
3978 : : vfio_user_endpoint_resume_done, endpoint);
3979 [ # # ]: 0 : if (ret < 0) {
3980 : : /* TODO: fail controller with CFS bit set */
3981 : 0 : vu_ctrlr->state = VFIO_USER_CTRLR_PAUSED;
3982 : 0 : SPDK_ERRLOG("%s: failed to resume, ret=%d\n", endpoint_id(endpoint), ret);
3983 : : }
3984 : : }
3985 : 0 : vu_ctrlr->migr_data_prepared = false;
3986 : 0 : vu_ctrlr->in_source_vm = false;
3987 : 0 : break;
3988 : :
3989 : 0 : default:
3990 : 0 : return -EINVAL;
3991 : : }
3992 : :
3993 : 0 : return ret;
3994 : : }
3995 : :
3996 : : static uint64_t
3997 : 0 : vfio_user_migration_get_pending_bytes(vfu_ctx_t *vfu_ctx)
3998 : : {
3999 : 0 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
4000 : 0 : struct nvmf_vfio_user_ctrlr *ctrlr = endpoint->ctrlr;
4001 : : uint64_t pending_bytes;
4002 : :
4003 [ # # # # ]: 0 : if (ctrlr->migr_data_prepared) {
4004 [ # # ]: 0 : assert(ctrlr->state == VFIO_USER_CTRLR_MIGRATING);
4005 : 0 : pending_bytes = 0;
4006 : : } else {
4007 : 0 : pending_bytes = vfio_user_migr_data_len();
4008 : : }
4009 : :
4010 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio,
4011 : : "%s current state %u, pending bytes 0x%"PRIx64"\n",
4012 : : endpoint_id(endpoint), ctrlr->state, pending_bytes);
4013 : :
4014 : 0 : return pending_bytes;
4015 : : }
4016 : :
4017 : : static int
4018 : 0 : vfio_user_migration_prepare_data(vfu_ctx_t *vfu_ctx, uint64_t *offset, uint64_t *size)
4019 : : {
4020 : 0 : struct nvmf_vfio_user_endpoint *endpoint = vfu_get_private(vfu_ctx);
4021 : 0 : struct nvmf_vfio_user_ctrlr *ctrlr = endpoint->ctrlr;
4022 : :
4023 : : /*
4024 : : * When transitioning to pre-copy state we set pending_bytes to 0,
4025 : : * so the vfio-user client shouldn't attempt to read any migration
4026 : : * data. This is not yet guaranteed by libvfio-user.
4027 : : */
4028 [ # # ]: 0 : if (ctrlr->state != VFIO_USER_CTRLR_MIGRATING) {
4029 [ # # ]: 0 : assert(size != NULL);
4030 : 0 : *offset = 0;
4031 : 0 : *size = 0;
4032 : 0 : return 0;
4033 : : }
4034 : :
4035 [ # # # # ]: 0 : if (ctrlr->in_source_vm) { /* migration source */
4036 [ # # ]: 0 : assert(size != NULL);
4037 : 0 : *size = vfio_user_migr_data_len();
4038 : 0 : vfio_user_migr_ctrlr_save_data(ctrlr);
4039 : : } else { /* migration destination */
4040 [ # # ]: 0 : assert(size == NULL);
4041 [ # # # # ]: 0 : assert(!ctrlr->migr_data_prepared);
4042 : : }
4043 : 0 : *offset = 0;
4044 : 0 : ctrlr->migr_data_prepared = true;
4045 : :
4046 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s current state %u\n", endpoint_id(endpoint), ctrlr->state);
4047 : :
4048 : 0 : return 0;
4049 : : }
4050 : :
4051 : : static ssize_t
4052 : 0 : vfio_user_migration_read_data(vfu_ctx_t *vfu_ctx __attribute__((unused)),
4053 : : void *buf __attribute__((unused)),
4054 : : uint64_t count __attribute__((unused)),
4055 : : uint64_t offset __attribute__((unused)))
4056 : : {
4057 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s: migration read data not supported\n",
4058 : : endpoint_id(vfu_get_private(vfu_ctx)));
4059 : 0 : errno = ENOTSUP;
4060 : 0 : return -1;
4061 : : }
4062 : :
4063 : : static ssize_t
4064 : 0 : vfio_user_migration_write_data(vfu_ctx_t *vfu_ctx __attribute__((unused)),
4065 : : void *buf __attribute__((unused)),
4066 : : uint64_t count __attribute__((unused)),
4067 : : uint64_t offset __attribute__((unused)))
4068 : : {
4069 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s: migration write data not supported\n",
4070 : : endpoint_id(vfu_get_private(vfu_ctx)));
4071 : 0 : errno = ENOTSUP;
4072 : 0 : return -1;
4073 : : }
4074 : :
4075 : : static int
4076 : 0 : vfio_user_migration_data_written(vfu_ctx_t *vfu_ctx __attribute__((unused)),
4077 : : uint64_t count)
4078 : : {
4079 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "write 0x%"PRIx64"\n", (uint64_t)count);
4080 : :
4081 [ # # ]: 0 : if (count != vfio_user_migr_data_len()) {
4082 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s bad count %#lx\n",
4083 : : endpoint_id(vfu_get_private(vfu_ctx)), count);
4084 : 0 : errno = EINVAL;
4085 : 0 : return -1;
4086 : : }
4087 : :
4088 : 0 : return 0;
4089 : : }
4090 : :
4091 : : static int
4092 : 17 : vfio_user_dev_info_fill(struct nvmf_vfio_user_transport *vu_transport,
4093 : : struct nvmf_vfio_user_endpoint *endpoint)
4094 : : {
4095 : : int ret;
4096 : : ssize_t cap_offset;
4097 : 17 : vfu_ctx_t *vfu_ctx = endpoint->vfu_ctx;
4098 : 17 : struct iovec migr_sparse_mmap = {};
4099 : :
4100 : 17 : struct pmcap pmcap = { .hdr.id = PCI_CAP_ID_PM, .pmcs.nsfrst = 0x1 };
4101 : 17 : struct pxcap pxcap = {
4102 : : .hdr.id = PCI_CAP_ID_EXP,
4103 : : .pxcaps.ver = 0x2,
4104 : : .pxdcap = {.rer = 0x1, .flrc = 0x1},
4105 : : .pxdcap2.ctds = 0x1
4106 : : };
4107 : :
4108 : 17 : struct msixcap msixcap = {
4109 : : .hdr.id = PCI_CAP_ID_MSIX,
4110 : : .mxc.ts = NVME_IRQ_MSIX_NUM - 1,
4111 : : .mtab = {.tbir = 0x4, .to = 0x0},
4112 : : .mpba = {.pbir = 0x5, .pbao = 0x0}
4113 : : };
4114 : :
4115 : 17 : struct iovec sparse_mmap[] = {
4116 : : {
4117 : : .iov_base = (void *)NVME_DOORBELLS_OFFSET,
4118 : : .iov_len = NVMF_VFIO_USER_DOORBELLS_SIZE,
4119 : : },
4120 : : };
4121 : :
4122 : 17 : const vfu_migration_callbacks_t migr_callbacks = {
4123 : : .version = VFIO_USER_MIGR_CALLBACK_VERS,
4124 : : .transition = &vfio_user_migration_device_state_transition,
4125 : : .get_pending_bytes = &vfio_user_migration_get_pending_bytes,
4126 : : .prepare_data = &vfio_user_migration_prepare_data,
4127 : : .read_data = &vfio_user_migration_read_data,
4128 : : .data_written = &vfio_user_migration_data_written,
4129 : : .write_data = &vfio_user_migration_write_data
4130 : : };
4131 : :
4132 : 17 : ret = vfu_pci_init(vfu_ctx, VFU_PCI_TYPE_EXPRESS, PCI_HEADER_TYPE_NORMAL, 0);
4133 [ - + ]: 17 : if (ret < 0) {
4134 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to initialize PCI\n", vfu_ctx);
4135 : 0 : return ret;
4136 : : }
4137 : 17 : vfu_pci_set_id(vfu_ctx, SPDK_PCI_VID_NUTANIX, 0x0001, SPDK_PCI_VID_NUTANIX, 0);
4138 : : /*
4139 : : * 0x02, controller uses the NVM Express programming interface
4140 : : * 0x08, non-volatile memory controller
4141 : : * 0x01, mass storage controller
4142 : : */
4143 : 17 : vfu_pci_set_class(vfu_ctx, 0x01, 0x08, 0x02);
4144 : :
4145 : 17 : cap_offset = vfu_pci_add_capability(vfu_ctx, 0, 0, &pmcap);
4146 [ - + ]: 17 : if (cap_offset < 0) {
4147 : 0 : SPDK_ERRLOG("vfu_ctx %p failed add pmcap\n", vfu_ctx);
4148 : 0 : return ret;
4149 : : }
4150 : :
4151 : 17 : cap_offset = vfu_pci_add_capability(vfu_ctx, 0, 0, &pxcap);
4152 [ - + ]: 17 : if (cap_offset < 0) {
4153 : 0 : SPDK_ERRLOG("vfu_ctx %p failed add pxcap\n", vfu_ctx);
4154 : 0 : return ret;
4155 : : }
4156 : :
4157 : 17 : cap_offset = vfu_pci_add_capability(vfu_ctx, 0, 0, &msixcap);
4158 [ - + ]: 17 : if (cap_offset < 0) {
4159 : 0 : SPDK_ERRLOG("vfu_ctx %p failed add msixcap\n", vfu_ctx);
4160 : 0 : return ret;
4161 : : }
4162 : :
4163 : 17 : ret = vfu_setup_region(vfu_ctx, VFU_PCI_DEV_CFG_REGION_IDX, NVME_REG_CFG_SIZE,
4164 : : access_pci_config, VFU_REGION_FLAG_RW, NULL, 0, -1, 0);
4165 [ - + ]: 17 : if (ret < 0) {
4166 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup cfg\n", vfu_ctx);
4167 : 0 : return ret;
4168 : : }
4169 : :
4170 [ - + + + ]: 17 : if (vu_transport->transport_opts.disable_mappable_bar0) {
4171 : 2 : ret = vfu_setup_region(vfu_ctx, VFU_PCI_DEV_BAR0_REGION_IDX, NVME_REG_BAR0_SIZE,
4172 : : access_bar0_fn, VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM,
4173 : : NULL, 0, -1, 0);
4174 : : } else {
4175 : 15 : ret = vfu_setup_region(vfu_ctx, VFU_PCI_DEV_BAR0_REGION_IDX, NVME_REG_BAR0_SIZE,
4176 : : access_bar0_fn, VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM,
4177 : : sparse_mmap, 1, endpoint->devmem_fd, 0);
4178 : : }
4179 : :
4180 [ - + ]: 17 : if (ret < 0) {
4181 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup bar 0\n", vfu_ctx);
4182 : 0 : return ret;
4183 : : }
4184 : :
4185 : 17 : ret = vfu_setup_region(vfu_ctx, VFU_PCI_DEV_BAR4_REGION_IDX, NVME_BAR4_SIZE,
4186 : : NULL, VFU_REGION_FLAG_RW, NULL, 0, -1, 0);
4187 [ - + ]: 17 : if (ret < 0) {
4188 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup bar 4\n", vfu_ctx);
4189 : 0 : return ret;
4190 : : }
4191 : :
4192 : 17 : ret = vfu_setup_region(vfu_ctx, VFU_PCI_DEV_BAR5_REGION_IDX, NVME_BAR5_SIZE,
4193 : : NULL, VFU_REGION_FLAG_RW, NULL, 0, -1, 0);
4194 [ - + ]: 17 : if (ret < 0) {
4195 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup bar 5\n", vfu_ctx);
4196 : 0 : return ret;
4197 : : }
4198 : :
4199 : 17 : ret = vfu_setup_device_dma(vfu_ctx, memory_region_add_cb, memory_region_remove_cb);
4200 [ - + ]: 17 : if (ret < 0) {
4201 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup dma callback\n", vfu_ctx);
4202 : 0 : return ret;
4203 : : }
4204 : :
4205 : 17 : ret = vfu_setup_device_reset_cb(vfu_ctx, vfio_user_device_reset);
4206 [ - + ]: 17 : if (ret < 0) {
4207 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup reset callback\n", vfu_ctx);
4208 : 0 : return ret;
4209 : : }
4210 : :
4211 : 17 : ret = vfu_setup_device_nr_irqs(vfu_ctx, VFU_DEV_INTX_IRQ, 1);
4212 [ - + ]: 17 : if (ret < 0) {
4213 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup INTX\n", vfu_ctx);
4214 : 0 : return ret;
4215 : : }
4216 : :
4217 : 17 : ret = vfu_setup_device_nr_irqs(vfu_ctx, VFU_DEV_MSIX_IRQ, NVME_IRQ_MSIX_NUM);
4218 [ - + ]: 17 : if (ret < 0) {
4219 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup MSIX\n", vfu_ctx);
4220 : 0 : return ret;
4221 : : }
4222 : :
4223 : 17 : vfu_setup_device_quiesce_cb(vfu_ctx, vfio_user_dev_quiesce_cb);
4224 : :
4225 : 17 : migr_sparse_mmap.iov_base = (void *)4096;
4226 : 17 : migr_sparse_mmap.iov_len = vfio_user_migr_data_len();
4227 : 34 : ret = vfu_setup_region(vfu_ctx, VFU_PCI_DEV_MIGR_REGION_IDX,
4228 : 17 : vfu_get_migr_register_area_size() + vfio_user_migr_data_len(),
4229 : : NULL, VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM, &migr_sparse_mmap,
4230 : : 1, endpoint->migr_fd, 0);
4231 [ - + ]: 17 : if (ret < 0) {
4232 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup migration region\n", vfu_ctx);
4233 : 0 : return ret;
4234 : : }
4235 : :
4236 : 17 : ret = vfu_setup_device_migration_callbacks(vfu_ctx, &migr_callbacks,
4237 : : vfu_get_migr_register_area_size());
4238 [ - + ]: 17 : if (ret < 0) {
4239 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to setup migration callbacks\n", vfu_ctx);
4240 : 0 : return ret;
4241 : : }
4242 : :
4243 : 17 : ret = vfu_realize_ctx(vfu_ctx);
4244 [ - + ]: 17 : if (ret < 0) {
4245 : 0 : SPDK_ERRLOG("vfu_ctx %p failed to realize\n", vfu_ctx);
4246 : 0 : return ret;
4247 : : }
4248 : :
4249 : 17 : endpoint->pci_config_space = vfu_pci_get_config_space(endpoint->vfu_ctx);
4250 [ - + ]: 17 : assert(endpoint->pci_config_space != NULL);
4251 : 17 : init_pci_config_space(endpoint->pci_config_space);
4252 : :
4253 [ - + ]: 17 : assert(cap_offset != 0);
4254 : 17 : endpoint->msix = (struct msixcap *)((uint8_t *)endpoint->pci_config_space + cap_offset);
4255 : :
4256 : 17 : return 0;
4257 : : }
4258 : :
4259 : : static int nvmf_vfio_user_accept(void *ctx);
4260 : :
4261 : : static void
4262 : 6 : set_intr_mode_noop(struct spdk_poller *poller, void *arg, bool interrupt_mode)
4263 : : {
4264 : : /* Nothing for us to do here. */
4265 : 6 : }
4266 : :
4267 : : /*
4268 : : * Register an "accept" poller: this is polling for incoming vfio-user socket
4269 : : * connections (on the listening socket).
4270 : : *
4271 : : * We need to do this on first listening, and also after destroying a
4272 : : * controller, so we can accept another connection.
4273 : : */
4274 : : static int
4275 : 56 : vfio_user_register_accept_poller(struct nvmf_vfio_user_endpoint *endpoint)
4276 : : {
4277 : 56 : uint64_t poll_rate_us = endpoint->transport->transport.opts.acceptor_poll_rate;
4278 : :
4279 [ - + - + ]: 56 : SPDK_DEBUGLOG(nvmf_vfio, "registering accept poller\n");
4280 : :
4281 : 56 : endpoint->accept_poller = SPDK_POLLER_REGISTER(nvmf_vfio_user_accept,
4282 : : endpoint, poll_rate_us);
4283 : :
4284 [ - + ]: 56 : if (!endpoint->accept_poller) {
4285 : 0 : return -1;
4286 : : }
4287 : :
4288 : 56 : endpoint->accept_thread = spdk_get_thread();
4289 : 56 : endpoint->need_relisten = false;
4290 : :
4291 [ + + ]: 56 : if (!spdk_interrupt_mode_is_enabled()) {
4292 : 54 : return 0;
4293 : : }
4294 : :
4295 : 2 : endpoint->accept_intr_fd = vfu_get_poll_fd(endpoint->vfu_ctx);
4296 [ - + ]: 2 : assert(endpoint->accept_intr_fd != -1);
4297 : :
4298 : 2 : endpoint->accept_intr = SPDK_INTERRUPT_REGISTER(endpoint->accept_intr_fd,
4299 : : nvmf_vfio_user_accept, endpoint);
4300 : :
4301 [ - + ]: 2 : assert(endpoint->accept_intr != NULL);
4302 : :
4303 : 2 : spdk_poller_register_interrupt(endpoint->accept_poller,
4304 : : set_intr_mode_noop, NULL);
4305 : 2 : return 0;
4306 : : }
4307 : :
4308 : : static void
4309 : 39 : _vfio_user_relisten(void *ctx)
4310 : : {
4311 : 39 : struct nvmf_vfio_user_endpoint *endpoint = ctx;
4312 : :
4313 : 39 : vfio_user_register_accept_poller(endpoint);
4314 : 39 : }
4315 : :
4316 : : static void
4317 : 47 : _free_ctrlr(void *ctx)
4318 : : {
4319 : 47 : struct nvmf_vfio_user_ctrlr *ctrlr = ctx;
4320 : 47 : struct nvmf_vfio_user_endpoint *endpoint = ctrlr->endpoint;
4321 : :
4322 : 47 : free_sdbl(endpoint->vfu_ctx, ctrlr->sdbl);
4323 : :
4324 : 47 : spdk_interrupt_unregister(&ctrlr->intr);
4325 : 47 : ctrlr->intr_fd = -1;
4326 : 47 : spdk_poller_unregister(&ctrlr->vfu_ctx_poller);
4327 : :
4328 : 47 : free(ctrlr);
4329 : :
4330 [ - + - + ]: 47 : if (endpoint->need_async_destroy) {
4331 : 0 : nvmf_vfio_user_destroy_endpoint(endpoint);
4332 [ - + + + ]: 47 : } else if (endpoint->need_relisten) {
4333 : 39 : spdk_thread_send_msg(endpoint->accept_thread,
4334 : : _vfio_user_relisten, endpoint);
4335 : : }
4336 : 47 : }
4337 : :
4338 : : static void
4339 : 47 : free_ctrlr(struct nvmf_vfio_user_ctrlr *ctrlr)
4340 : : {
4341 : : struct spdk_thread *thread;
4342 : : int i;
4343 : :
4344 [ - + ]: 47 : assert(ctrlr != NULL);
4345 [ + - ]: 47 : thread = ctrlr->thread ? ctrlr->thread : spdk_get_thread();
4346 : :
4347 [ - + - + ]: 47 : SPDK_DEBUGLOG(nvmf_vfio, "free %s\n", ctrlr_id(ctrlr));
4348 : :
4349 [ + + ]: 24111 : for (i = 0; i < NVMF_VFIO_USER_MAX_QPAIRS_PER_CTRLR; i++) {
4350 : 24064 : free_qp(ctrlr, i);
4351 : : }
4352 : :
4353 : 47 : spdk_thread_exec_msg(thread, _free_ctrlr, ctrlr);
4354 : 47 : }
4355 : :
4356 : : static int
4357 : 47 : nvmf_vfio_user_create_ctrlr(struct nvmf_vfio_user_transport *transport,
4358 : : struct nvmf_vfio_user_endpoint *endpoint)
4359 : : {
4360 : : struct nvmf_vfio_user_ctrlr *ctrlr;
4361 : 47 : int err = 0;
4362 : :
4363 [ - + - + ]: 47 : SPDK_DEBUGLOG(nvmf_vfio, "%s\n", endpoint_id(endpoint));
4364 : :
4365 : : /* First, construct a vfio-user CUSTOM transport controller */
4366 : 47 : ctrlr = calloc(1, sizeof(*ctrlr));
4367 [ - + ]: 47 : if (ctrlr == NULL) {
4368 : 0 : err = -ENOMEM;
4369 : 0 : goto out;
4370 : : }
4371 : : /* We can only support one connection for now */
4372 : 47 : ctrlr->cntlid = 0x1;
4373 : 47 : ctrlr->intr_fd = -1;
4374 : 47 : ctrlr->transport = transport;
4375 : 47 : ctrlr->endpoint = endpoint;
4376 : 47 : ctrlr->bar0_doorbells = endpoint->bar0_doorbells;
4377 : 47 : TAILQ_INIT(&ctrlr->connected_sqs);
4378 : :
4379 : 47 : ctrlr->adaptive_irqs_enabled =
4380 [ - + ]: 47 : !transport->transport_opts.disable_adaptive_irq;
4381 : :
4382 : : /* Then, construct an admin queue pair */
4383 : 47 : err = init_sq(ctrlr, &transport->transport, 0);
4384 [ - + ]: 47 : if (err != 0) {
4385 : 0 : free(ctrlr);
4386 : 0 : goto out;
4387 : : }
4388 : :
4389 : 47 : err = init_cq(ctrlr, 0);
4390 [ - + ]: 47 : if (err != 0) {
4391 : 0 : free(ctrlr);
4392 : 0 : goto out;
4393 : : }
4394 : :
4395 : 47 : ctrlr->sqs[0]->size = NVMF_VFIO_USER_DEFAULT_AQ_DEPTH;
4396 : :
4397 : 47 : err = alloc_sq_reqs(ctrlr, ctrlr->sqs[0]);
4398 [ - + ]: 47 : if (err != 0) {
4399 : 0 : free(ctrlr);
4400 : 0 : goto out;
4401 : : }
4402 : 47 : endpoint->ctrlr = ctrlr;
4403 : :
4404 : : /* Notify the generic layer about the new admin queue pair */
4405 : 47 : spdk_nvmf_tgt_new_qpair(transport->transport.tgt, &ctrlr->sqs[0]->qpair);
4406 : :
4407 : 47 : out:
4408 [ - + ]: 47 : if (err != 0) {
4409 : 0 : SPDK_ERRLOG("%s: failed to create vfio-user controller: %s\n",
4410 : : endpoint_id(endpoint), strerror(-err));
4411 : : }
4412 : :
4413 : 47 : return err;
4414 : : }
4415 : :
4416 : : static int
4417 : 17 : nvmf_vfio_user_listen(struct spdk_nvmf_transport *transport,
4418 : : const struct spdk_nvme_transport_id *trid,
4419 : : struct spdk_nvmf_listen_opts *listen_opts)
4420 : : {
4421 : : struct nvmf_vfio_user_transport *vu_transport;
4422 : : struct nvmf_vfio_user_endpoint *endpoint, *tmp;
4423 : 17 : char path[PATH_MAX] = {};
4424 : 17 : char uuid[PATH_MAX] = {};
4425 : : int ret;
4426 : :
4427 : 17 : vu_transport = SPDK_CONTAINEROF(transport, struct nvmf_vfio_user_transport,
4428 : : transport);
4429 : :
4430 [ - + ]: 17 : pthread_mutex_lock(&vu_transport->lock);
4431 [ + + ]: 24 : TAILQ_FOREACH_SAFE(endpoint, &vu_transport->endpoints, link, tmp) {
4432 : : /* Only compare traddr */
4433 [ - + - + : 7 : if (strncmp(endpoint->trid.traddr, trid->traddr, sizeof(endpoint->trid.traddr)) == 0) {
- + ]
4434 [ # # ]: 0 : pthread_mutex_unlock(&vu_transport->lock);
4435 : 0 : return -EEXIST;
4436 : : }
4437 : : }
4438 [ - + ]: 17 : pthread_mutex_unlock(&vu_transport->lock);
4439 : :
4440 : 17 : endpoint = calloc(1, sizeof(*endpoint));
4441 [ - + ]: 17 : if (!endpoint) {
4442 : 0 : return -ENOMEM;
4443 : : }
4444 : :
4445 [ - + ]: 17 : pthread_mutex_init(&endpoint->lock, NULL);
4446 : 17 : endpoint->devmem_fd = -1;
4447 [ - + - + ]: 17 : memcpy(&endpoint->trid, trid, sizeof(endpoint->trid));
4448 : 17 : endpoint->transport = vu_transport;
4449 : :
4450 : 17 : ret = snprintf(path, PATH_MAX, "%s/bar0", endpoint_id(endpoint));
4451 [ + - - + ]: 17 : if (ret < 0 || ret >= PATH_MAX) {
4452 : 0 : SPDK_ERRLOG("%s: error to get socket path: %s.\n", endpoint_id(endpoint), spdk_strerror(errno));
4453 : 0 : ret = -1;
4454 : 0 : goto out;
4455 : : }
4456 : :
4457 : 17 : ret = open(path, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
4458 [ - + ]: 17 : if (ret == -1) {
4459 : 0 : SPDK_ERRLOG("%s: failed to open device memory at %s: %s.\n",
4460 : : endpoint_id(endpoint), path, spdk_strerror(errno));
4461 : 0 : goto out;
4462 : : }
4463 : 17 : unlink(path);
4464 : :
4465 : 17 : endpoint->devmem_fd = ret;
4466 : 17 : ret = ftruncate(endpoint->devmem_fd,
4467 : : NVME_DOORBELLS_OFFSET + NVMF_VFIO_USER_DOORBELLS_SIZE);
4468 [ - + ]: 17 : if (ret != 0) {
4469 : 0 : SPDK_ERRLOG("%s: error to ftruncate file %s: %s.\n", endpoint_id(endpoint), path,
4470 : : spdk_strerror(errno));
4471 : 0 : goto out;
4472 : : }
4473 : :
4474 : 17 : endpoint->bar0_doorbells = mmap(NULL, NVMF_VFIO_USER_DOORBELLS_SIZE,
4475 : : PROT_READ | PROT_WRITE, MAP_SHARED, endpoint->devmem_fd, NVME_DOORBELLS_OFFSET);
4476 [ - + ]: 17 : if (endpoint->bar0_doorbells == MAP_FAILED) {
4477 : 0 : SPDK_ERRLOG("%s: error to mmap file %s: %s.\n", endpoint_id(endpoint), path, spdk_strerror(errno));
4478 : 0 : endpoint->bar0_doorbells = NULL;
4479 : 0 : ret = -1;
4480 : 0 : goto out;
4481 : : }
4482 : :
4483 : 17 : ret = snprintf(path, PATH_MAX, "%s/migr", endpoint_id(endpoint));
4484 [ + - - + ]: 17 : if (ret < 0 || ret >= PATH_MAX) {
4485 : 0 : SPDK_ERRLOG("%s: error to get migration file path: %s.\n", endpoint_id(endpoint),
4486 : : spdk_strerror(errno));
4487 : 0 : ret = -1;
4488 : 0 : goto out;
4489 : : }
4490 : 17 : ret = open(path, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
4491 [ - + ]: 17 : if (ret == -1) {
4492 : 0 : SPDK_ERRLOG("%s: failed to open device memory at %s: %s.\n",
4493 : : endpoint_id(endpoint), path, spdk_strerror(errno));
4494 : 0 : goto out;
4495 : : }
4496 : 17 : unlink(path);
4497 : :
4498 : 17 : endpoint->migr_fd = ret;
4499 : 17 : ret = ftruncate(endpoint->migr_fd,
4500 : 17 : vfu_get_migr_register_area_size() + vfio_user_migr_data_len());
4501 [ - + ]: 17 : if (ret != 0) {
4502 : 0 : SPDK_ERRLOG("%s: error to ftruncate migration file %s: %s.\n", endpoint_id(endpoint), path,
4503 : : spdk_strerror(errno));
4504 : 0 : goto out;
4505 : : }
4506 : :
4507 : 17 : endpoint->migr_data = mmap(NULL, vfio_user_migr_data_len(),
4508 : 17 : PROT_READ | PROT_WRITE, MAP_SHARED, endpoint->migr_fd, vfu_get_migr_register_area_size());
4509 [ - + ]: 17 : if (endpoint->migr_data == MAP_FAILED) {
4510 : 0 : SPDK_ERRLOG("%s: error to mmap file %s: %s.\n", endpoint_id(endpoint), path, spdk_strerror(errno));
4511 : 0 : endpoint->migr_data = NULL;
4512 : 0 : ret = -1;
4513 : 0 : goto out;
4514 : : }
4515 : :
4516 : 17 : ret = snprintf(uuid, PATH_MAX, "%s/cntrl", endpoint_id(endpoint));
4517 [ + - - + ]: 17 : if (ret < 0 || ret >= PATH_MAX) {
4518 : 0 : SPDK_ERRLOG("%s: error to get ctrlr file path: %s\n", endpoint_id(endpoint), spdk_strerror(errno));
4519 : 0 : ret = -1;
4520 : 0 : goto out;
4521 : : }
4522 : :
4523 : 17 : endpoint->vfu_ctx = vfu_create_ctx(VFU_TRANS_SOCK, uuid, LIBVFIO_USER_FLAG_ATTACH_NB,
4524 : : endpoint, VFU_DEV_TYPE_PCI);
4525 [ - + ]: 17 : if (endpoint->vfu_ctx == NULL) {
4526 : 0 : SPDK_ERRLOG("%s: error creating libmuser context: %m\n",
4527 : : endpoint_id(endpoint));
4528 : 0 : ret = -1;
4529 : 0 : goto out;
4530 : : }
4531 : :
4532 : 17 : ret = vfu_setup_log(endpoint->vfu_ctx, vfio_user_log,
4533 : : vfio_user_get_log_level());
4534 [ - + ]: 17 : if (ret < 0) {
4535 : 0 : goto out;
4536 : : }
4537 : :
4538 : :
4539 : 17 : ret = vfio_user_dev_info_fill(vu_transport, endpoint);
4540 [ - + ]: 17 : if (ret < 0) {
4541 : 0 : goto out;
4542 : : }
4543 : :
4544 : 17 : ret = vfio_user_register_accept_poller(endpoint);
4545 : :
4546 [ - + ]: 17 : if (ret != 0) {
4547 : 0 : goto out;
4548 : : }
4549 : :
4550 [ - + ]: 17 : pthread_mutex_lock(&vu_transport->lock);
4551 : 17 : TAILQ_INSERT_TAIL(&vu_transport->endpoints, endpoint, link);
4552 [ - + ]: 17 : pthread_mutex_unlock(&vu_transport->lock);
4553 : :
4554 : 17 : out:
4555 [ - + ]: 17 : if (ret != 0) {
4556 : 0 : nvmf_vfio_user_destroy_endpoint(endpoint);
4557 : : }
4558 : :
4559 : 17 : return ret;
4560 : : }
4561 : :
4562 : : static void
4563 : 17 : nvmf_vfio_user_stop_listen(struct spdk_nvmf_transport *transport,
4564 : : const struct spdk_nvme_transport_id *trid)
4565 : : {
4566 : : struct nvmf_vfio_user_transport *vu_transport;
4567 : : struct nvmf_vfio_user_endpoint *endpoint, *tmp;
4568 : :
4569 [ - + ]: 17 : assert(trid != NULL);
4570 [ - + ]: 17 : assert(trid->traddr != NULL);
4571 : :
4572 [ - + - + ]: 17 : SPDK_DEBUGLOG(nvmf_vfio, "%s: stop listen\n", trid->traddr);
4573 : :
4574 : 17 : vu_transport = SPDK_CONTAINEROF(transport, struct nvmf_vfio_user_transport,
4575 : : transport);
4576 : :
4577 [ - + ]: 17 : pthread_mutex_lock(&vu_transport->lock);
4578 [ + - ]: 17 : TAILQ_FOREACH_SAFE(endpoint, &vu_transport->endpoints, link, tmp) {
4579 [ - + - + : 17 : if (strcmp(trid->traddr, endpoint->trid.traddr) == 0) {
+ - ]
4580 [ + + ]: 17 : TAILQ_REMOVE(&vu_transport->endpoints, endpoint, link);
4581 : : /* Defer to free endpoint resources until the controller
4582 : : * is freed. There are two cases when running here:
4583 : : * 1. kill nvmf target while VM is connected
4584 : : * 2. remove listener via RPC call
4585 : : * nvmf library will disconnect all queue paris.
4586 : : */
4587 [ - + ]: 17 : if (endpoint->ctrlr) {
4588 [ # # # # ]: 0 : assert(!endpoint->need_async_destroy);
4589 : 0 : endpoint->need_async_destroy = true;
4590 [ # # ]: 0 : pthread_mutex_unlock(&vu_transport->lock);
4591 : 0 : return;
4592 : : }
4593 : :
4594 : 17 : nvmf_vfio_user_destroy_endpoint(endpoint);
4595 [ - + ]: 17 : pthread_mutex_unlock(&vu_transport->lock);
4596 : 17 : return;
4597 : : }
4598 : : }
4599 [ # # ]: 0 : pthread_mutex_unlock(&vu_transport->lock);
4600 : :
4601 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s: not found\n", trid->traddr);
4602 : : }
4603 : :
4604 : : static void
4605 : 47 : nvmf_vfio_user_cdata_init(struct spdk_nvmf_transport *transport,
4606 : : struct spdk_nvmf_subsystem *subsystem,
4607 : : struct spdk_nvmf_ctrlr_data *cdata)
4608 : : {
4609 : : struct nvmf_vfio_user_transport *vu_transport;
4610 : :
4611 : 47 : vu_transport = SPDK_CONTAINEROF(transport, struct nvmf_vfio_user_transport, transport);
4612 : :
4613 : 47 : cdata->vid = SPDK_PCI_VID_NUTANIX;
4614 : 47 : cdata->ssvid = SPDK_PCI_VID_NUTANIX;
4615 : 47 : cdata->ieee[0] = 0x8d;
4616 : 47 : cdata->ieee[1] = 0x6b;
4617 : 47 : cdata->ieee[2] = 0x50;
4618 [ - + ]: 47 : memset(&cdata->sgls, 0, sizeof(struct spdk_nvme_cdata_sgls));
4619 : 47 : cdata->sgls.supported = SPDK_NVME_SGLS_SUPPORTED_DWORD_ALIGNED;
4620 [ - + ]: 47 : cdata->oncs.compare = !vu_transport->transport_opts.disable_compare;
4621 : : /* libvfio-user can only support 1 connection for now */
4622 : 47 : cdata->oncs.reservations = 0;
4623 [ - + ]: 47 : cdata->oacs.doorbell_buffer_config = !vu_transport->transport_opts.disable_shadow_doorbells;
4624 [ - + ]: 47 : cdata->fuses.compare_and_write = !vu_transport->transport_opts.disable_compare;
4625 : 47 : }
4626 : :
4627 : : static int
4628 : 17 : nvmf_vfio_user_listen_associate(struct spdk_nvmf_transport *transport,
4629 : : const struct spdk_nvmf_subsystem *subsystem,
4630 : : const struct spdk_nvme_transport_id *trid)
4631 : : {
4632 : : struct nvmf_vfio_user_transport *vu_transport;
4633 : : struct nvmf_vfio_user_endpoint *endpoint;
4634 : :
4635 : 17 : vu_transport = SPDK_CONTAINEROF(transport, struct nvmf_vfio_user_transport, transport);
4636 : :
4637 [ - + ]: 17 : pthread_mutex_lock(&vu_transport->lock);
4638 [ + - ]: 24 : TAILQ_FOREACH(endpoint, &vu_transport->endpoints, link) {
4639 [ - + - + : 24 : if (strncmp(endpoint->trid.traddr, trid->traddr, sizeof(endpoint->trid.traddr)) == 0) {
+ + ]
4640 : 17 : break;
4641 : : }
4642 : : }
4643 [ - + ]: 17 : pthread_mutex_unlock(&vu_transport->lock);
4644 : :
4645 [ - + ]: 17 : if (endpoint == NULL) {
4646 : 0 : return -ENOENT;
4647 : : }
4648 : :
4649 : : /* Drop const - we will later need to pause/unpause. */
4650 : 17 : endpoint->subsystem = (struct spdk_nvmf_subsystem *)subsystem;
4651 : :
4652 : 17 : return 0;
4653 : : }
4654 : :
4655 : : /*
4656 : : * Executed periodically at a default SPDK_NVMF_DEFAULT_ACCEPT_POLL_RATE_US
4657 : : * frequency.
4658 : : *
4659 : : * For this endpoint (which at the libvfio-user level corresponds to a socket),
4660 : : * if we don't currently have a controller set up, peek to see if the socket is
4661 : : * able to accept a new connection.
4662 : : */
4663 : : static int
4664 : 6979 : nvmf_vfio_user_accept(void *ctx)
4665 : : {
4666 : 6979 : struct nvmf_vfio_user_endpoint *endpoint = ctx;
4667 : : struct nvmf_vfio_user_transport *vu_transport;
4668 : : int err;
4669 : :
4670 : 6979 : vu_transport = endpoint->transport;
4671 : :
4672 [ - + ]: 6979 : if (endpoint->ctrlr != NULL) {
4673 : 0 : return SPDK_POLLER_IDLE;
4674 : : }
4675 : :
4676 : : /* While we're here, the controller is already destroyed,
4677 : : * subsystem may still be in RESUMING state, we will wait
4678 : : * until the subsystem is in RUNNING state.
4679 : : */
4680 [ - + - + ]: 6979 : if (endpoint->need_resume) {
4681 : 0 : return SPDK_POLLER_IDLE;
4682 : : }
4683 : :
4684 : 6979 : err = vfu_attach_ctx(endpoint->vfu_ctx);
4685 [ + + ]: 6979 : if (err == 0) {
4686 [ - + - + ]: 47 : SPDK_DEBUGLOG(nvmf_vfio, "attach succeeded\n");
4687 : 47 : err = nvmf_vfio_user_create_ctrlr(vu_transport, endpoint);
4688 [ + - ]: 47 : if (err == 0) {
4689 : : /*
4690 : : * Unregister ourselves: now we've accepted a
4691 : : * connection, there is nothing for us to poll for, and
4692 : : * we will poll the connection via vfu_run_ctx()
4693 : : * instead.
4694 : : */
4695 : 47 : spdk_interrupt_unregister(&endpoint->accept_intr);
4696 : 47 : spdk_poller_unregister(&endpoint->accept_poller);
4697 : : }
4698 : 47 : return SPDK_POLLER_BUSY;
4699 : : }
4700 : :
4701 [ - + - - ]: 6932 : if (errno == EAGAIN || errno == EWOULDBLOCK) {
4702 : 6932 : return SPDK_POLLER_IDLE;
4703 : : }
4704 : :
4705 : 0 : return SPDK_POLLER_BUSY;
4706 : : }
4707 : :
4708 : : static void
4709 : 0 : nvmf_vfio_user_discover(struct spdk_nvmf_transport *transport,
4710 : : struct spdk_nvme_transport_id *trid,
4711 : : struct spdk_nvmf_discovery_log_page_entry *entry)
4712 : 0 : { }
4713 : :
4714 : : static int vfio_user_poll_group_intr(void *ctx);
4715 : :
4716 : : static void
4717 : 4 : vfio_user_poll_group_add_intr(struct nvmf_vfio_user_poll_group *vu_group,
4718 : : struct spdk_nvmf_poll_group *group)
4719 : : {
4720 : 4 : vu_group->intr_fd = eventfd(0, EFD_NONBLOCK);
4721 [ - + ]: 4 : assert(vu_group->intr_fd != -1);
4722 : :
4723 : 4 : vu_group->intr = SPDK_INTERRUPT_REGISTER(vu_group->intr_fd,
4724 : : vfio_user_poll_group_intr, vu_group);
4725 [ - + ]: 4 : assert(vu_group->intr != NULL);
4726 : :
4727 : 4 : spdk_poller_register_interrupt(group->poller, set_intr_mode_noop,
4728 : : vu_group);
4729 : 4 : }
4730 : :
4731 : : static struct spdk_nvmf_transport_poll_group *
4732 : 21 : nvmf_vfio_user_poll_group_create(struct spdk_nvmf_transport *transport,
4733 : : struct spdk_nvmf_poll_group *group)
4734 : : {
4735 : : struct nvmf_vfio_user_transport *vu_transport;
4736 : : struct nvmf_vfio_user_poll_group *vu_group;
4737 : :
4738 : 21 : vu_transport = SPDK_CONTAINEROF(transport, struct nvmf_vfio_user_transport,
4739 : : transport);
4740 : :
4741 [ - + - + ]: 21 : SPDK_DEBUGLOG(nvmf_vfio, "create poll group\n");
4742 : :
4743 : 21 : vu_group = calloc(1, sizeof(*vu_group));
4744 [ - + ]: 21 : if (vu_group == NULL) {
4745 : 0 : SPDK_ERRLOG("Error allocating poll group: %m");
4746 : 0 : return NULL;
4747 : : }
4748 : :
4749 [ + + ]: 21 : if (in_interrupt_mode(vu_transport)) {
4750 : 4 : vfio_user_poll_group_add_intr(vu_group, group);
4751 : : }
4752 : :
4753 : 21 : TAILQ_INIT(&vu_group->sqs);
4754 : :
4755 [ - + ]: 21 : pthread_mutex_lock(&vu_transport->pg_lock);
4756 : 21 : TAILQ_INSERT_TAIL(&vu_transport->poll_groups, vu_group, link);
4757 [ + + ]: 21 : if (vu_transport->next_pg == NULL) {
4758 : 7 : vu_transport->next_pg = vu_group;
4759 : : }
4760 [ - + ]: 21 : pthread_mutex_unlock(&vu_transport->pg_lock);
4761 : :
4762 : 21 : return &vu_group->group;
4763 : : }
4764 : :
4765 : : static struct spdk_nvmf_transport_poll_group *
4766 : 237 : nvmf_vfio_user_get_optimal_poll_group(struct spdk_nvmf_qpair *qpair)
4767 : : {
4768 : : struct nvmf_vfio_user_transport *vu_transport;
4769 : : struct nvmf_vfio_user_poll_group **vu_group;
4770 : : struct nvmf_vfio_user_sq *sq;
4771 : : struct nvmf_vfio_user_cq *cq;
4772 : :
4773 : 237 : struct spdk_nvmf_transport_poll_group *result = NULL;
4774 : :
4775 : 237 : sq = SPDK_CONTAINEROF(qpair, struct nvmf_vfio_user_sq, qpair);
4776 : 237 : cq = sq->ctrlr->cqs[sq->cqid];
4777 [ - + ]: 237 : assert(cq != NULL);
4778 : 237 : vu_transport = SPDK_CONTAINEROF(qpair->transport, struct nvmf_vfio_user_transport, transport);
4779 : :
4780 [ - + ]: 237 : pthread_mutex_lock(&vu_transport->pg_lock);
4781 [ - + ]: 237 : if (TAILQ_EMPTY(&vu_transport->poll_groups)) {
4782 : 0 : goto out;
4783 : : }
4784 : :
4785 [ + + ]: 237 : if (!nvmf_qpair_is_admin_queue(qpair)) {
4786 : : /*
4787 : : * If this is shared IO CQ case, just return the used CQ's poll
4788 : : * group, so I/O completions don't have to use
4789 : : * spdk_thread_send_msg().
4790 : : */
4791 [ + + ]: 190 : if (cq->group != NULL) {
4792 : 4 : result = cq->group;
4793 : 4 : goto out;
4794 : : }
4795 : :
4796 : : /*
4797 : : * If we're in interrupt mode, align all qpairs for a controller
4798 : : * on the same poll group by default, unless requested. This can
4799 : : * be lower in performance than running on a single poll group,
4800 : : * so we disable spreading by default.
4801 : : */
4802 [ - + ]: 186 : if (in_interrupt_mode(vu_transport) &&
4803 [ # # # # ]: 0 : !vu_transport->transport_opts.enable_intr_mode_sq_spreading) {
4804 : 0 : result = sq->ctrlr->sqs[0]->group;
4805 : 0 : goto out;
4806 : : }
4807 : :
4808 : : }
4809 : :
4810 : 233 : vu_group = &vu_transport->next_pg;
4811 [ - + ]: 233 : assert(*vu_group != NULL);
4812 : :
4813 : 233 : result = &(*vu_group)->group;
4814 : 233 : *vu_group = TAILQ_NEXT(*vu_group, link);
4815 [ + + ]: 233 : if (*vu_group == NULL) {
4816 : 87 : *vu_group = TAILQ_FIRST(&vu_transport->poll_groups);
4817 : : }
4818 : :
4819 : 146 : out:
4820 [ + + ]: 237 : if (cq->group == NULL) {
4821 : 233 : cq->group = result;
4822 : : }
4823 : :
4824 [ - + ]: 237 : pthread_mutex_unlock(&vu_transport->pg_lock);
4825 : 237 : return result;
4826 : : }
4827 : :
4828 : : static void
4829 : 4 : vfio_user_poll_group_del_intr(struct nvmf_vfio_user_poll_group *vu_group)
4830 : : {
4831 [ - + ]: 4 : assert(vu_group->intr_fd != -1);
4832 : :
4833 : 4 : spdk_interrupt_unregister(&vu_group->intr);
4834 : :
4835 : 4 : close(vu_group->intr_fd);
4836 : 4 : vu_group->intr_fd = -1;
4837 : 4 : }
4838 : :
4839 : : /* called when process exits */
4840 : : static void
4841 : 21 : nvmf_vfio_user_poll_group_destroy(struct spdk_nvmf_transport_poll_group *group)
4842 : : {
4843 : : struct nvmf_vfio_user_poll_group *vu_group, *next_tgroup;
4844 : : struct nvmf_vfio_user_transport *vu_transport;
4845 : :
4846 [ - + - + ]: 21 : SPDK_DEBUGLOG(nvmf_vfio, "destroy poll group\n");
4847 : :
4848 : 21 : vu_group = SPDK_CONTAINEROF(group, struct nvmf_vfio_user_poll_group, group);
4849 : 21 : vu_transport = SPDK_CONTAINEROF(vu_group->group.transport, struct nvmf_vfio_user_transport,
4850 : : transport);
4851 : :
4852 [ + + ]: 21 : if (in_interrupt_mode(vu_transport)) {
4853 : 4 : vfio_user_poll_group_del_intr(vu_group);
4854 : : }
4855 : :
4856 [ - + ]: 21 : pthread_mutex_lock(&vu_transport->pg_lock);
4857 : 21 : next_tgroup = TAILQ_NEXT(vu_group, link);
4858 [ + + ]: 21 : TAILQ_REMOVE(&vu_transport->poll_groups, vu_group, link);
4859 [ + + ]: 21 : if (next_tgroup == NULL) {
4860 : 11 : next_tgroup = TAILQ_FIRST(&vu_transport->poll_groups);
4861 : : }
4862 [ + + ]: 21 : if (vu_transport->next_pg == vu_group) {
4863 : 14 : vu_transport->next_pg = next_tgroup;
4864 : : }
4865 [ - + ]: 21 : pthread_mutex_unlock(&vu_transport->pg_lock);
4866 : :
4867 : 21 : free(vu_group);
4868 : 21 : }
4869 : :
4870 : : static void
4871 : 39 : _vfio_user_qpair_disconnect(void *ctx)
4872 : : {
4873 : 39 : struct nvmf_vfio_user_sq *sq = ctx;
4874 : :
4875 : 39 : spdk_nvmf_qpair_disconnect(&sq->qpair);
4876 : 39 : }
4877 : :
4878 : : /* The function is used when socket connection is destroyed */
4879 : : static int
4880 : 39 : vfio_user_destroy_ctrlr(struct nvmf_vfio_user_ctrlr *ctrlr)
4881 : : {
4882 : : struct nvmf_vfio_user_sq *sq;
4883 : : struct nvmf_vfio_user_endpoint *endpoint;
4884 : :
4885 [ - + - + ]: 39 : SPDK_DEBUGLOG(nvmf_vfio, "%s stop processing\n", ctrlr_id(ctrlr));
4886 : :
4887 : 39 : endpoint = ctrlr->endpoint;
4888 [ - + ]: 39 : assert(endpoint != NULL);
4889 : :
4890 [ - + ]: 39 : pthread_mutex_lock(&endpoint->lock);
4891 : 39 : endpoint->need_relisten = true;
4892 : 39 : ctrlr->disconnect = true;
4893 [ - + ]: 39 : if (TAILQ_EMPTY(&ctrlr->connected_sqs)) {
4894 : 0 : endpoint->ctrlr = NULL;
4895 : 0 : free_ctrlr(ctrlr);
4896 [ # # ]: 0 : pthread_mutex_unlock(&endpoint->lock);
4897 : 0 : return 0;
4898 : : }
4899 : :
4900 [ + + ]: 78 : TAILQ_FOREACH(sq, &ctrlr->connected_sqs, tailq) {
4901 : : /* add another round thread poll to avoid recursive endpoint lock */
4902 : 39 : spdk_thread_send_msg(ctrlr->thread, _vfio_user_qpair_disconnect, sq);
4903 : : }
4904 [ - + ]: 39 : pthread_mutex_unlock(&endpoint->lock);
4905 : :
4906 : 39 : return 0;
4907 : : }
4908 : :
4909 : : /*
4910 : : * Poll for and process any incoming vfio-user messages.
4911 : : */
4912 : : static int
4913 : 263073 : vfio_user_poll_vfu_ctx(void *ctx)
4914 : : {
4915 : 263073 : struct nvmf_vfio_user_ctrlr *ctrlr = ctx;
4916 : : int ret;
4917 : :
4918 [ - + ]: 263073 : assert(ctrlr != NULL);
4919 : :
4920 : : /* This will call access_bar0_fn() if there are any writes
4921 : : * to the portion of the BAR that is not mmap'd */
4922 : 263073 : ret = vfu_run_ctx(ctrlr->endpoint->vfu_ctx);
4923 [ + + ]: 263073 : if (spdk_unlikely(ret == -1)) {
4924 [ + + ]: 292 : if (errno == EBUSY) {
4925 : 253 : return SPDK_POLLER_IDLE;
4926 : : }
4927 : :
4928 : 39 : spdk_poller_unregister(&ctrlr->vfu_ctx_poller);
4929 : :
4930 : : /*
4931 : : * We lost the client; the reset callback will already have
4932 : : * unregistered the interrupt.
4933 : : */
4934 [ + - ]: 39 : if (errno == ENOTCONN) {
4935 : 39 : vfio_user_destroy_ctrlr(ctrlr);
4936 : 39 : return SPDK_POLLER_BUSY;
4937 : : }
4938 : :
4939 : : /*
4940 : : * We might not have got a reset callback in this case, so
4941 : : * explicitly unregister the interrupt here.
4942 : : */
4943 : 0 : spdk_interrupt_unregister(&ctrlr->intr);
4944 : 0 : ctrlr->intr_fd = -1;
4945 : 0 : fail_ctrlr(ctrlr);
4946 : : }
4947 : :
4948 : 262781 : return ret != 0 ? SPDK_POLLER_BUSY : SPDK_POLLER_IDLE;
4949 : : }
4950 : :
4951 : : struct vfio_user_post_cpl_ctx {
4952 : : struct nvmf_vfio_user_ctrlr *ctrlr;
4953 : : struct nvmf_vfio_user_cq *cq;
4954 : : struct spdk_nvme_cpl cpl;
4955 : : };
4956 : :
4957 : : static void
4958 : 131 : _post_completion_msg(void *ctx)
4959 : : {
4960 : 131 : struct vfio_user_post_cpl_ctx *cpl_ctx = ctx;
4961 : :
4962 : 131 : post_completion(cpl_ctx->ctrlr, cpl_ctx->cq, cpl_ctx->cpl.cdw0, cpl_ctx->cpl.sqid,
4963 : 131 : cpl_ctx->cpl.cid, cpl_ctx->cpl.status.sc, cpl_ctx->cpl.status.sct);
4964 : 131 : free(cpl_ctx);
4965 : 131 : }
4966 : :
4967 : : static int nvmf_vfio_user_poll_group_poll(struct spdk_nvmf_transport_poll_group *group);
4968 : :
4969 : : static int
4970 : 0 : vfio_user_poll_group_process(void *ctx)
4971 : : {
4972 : 0 : struct nvmf_vfio_user_poll_group *vu_group = ctx;
4973 : 0 : int ret = 0;
4974 : :
4975 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db, "pg:%p got intr\n", vu_group);
4976 : :
4977 : 0 : ret |= nvmf_vfio_user_poll_group_poll(&vu_group->group);
4978 : :
4979 : : /*
4980 : : * Re-arm the event indexes. NB: this also could rearm other
4981 : : * controller's SQs.
4982 : : */
4983 : 0 : ret |= vfio_user_poll_group_rearm(vu_group);
4984 : :
4985 : 0 : vu_group->stats.pg_process_count++;
4986 : 0 : return ret != 0 ? SPDK_POLLER_BUSY : SPDK_POLLER_IDLE;
4987 : : }
4988 : :
4989 : : static int
4990 : 0 : vfio_user_poll_group_intr(void *ctx)
4991 : : {
4992 : 0 : struct nvmf_vfio_user_poll_group *vu_group = ctx;
4993 : 0 : eventfd_t val;
4994 : :
4995 : 0 : eventfd_read(vu_group->intr_fd, &val);
4996 : :
4997 : 0 : vu_group->stats.intr++;
4998 : :
4999 : 0 : return vfio_user_poll_group_process(ctx);
5000 : : }
5001 : :
5002 : : /*
5003 : : * Handle an interrupt for the given controller: we must poll the vfu_ctx, and
5004 : : * the SQs assigned to our own poll group. Other poll groups are handled via
5005 : : * vfio_user_poll_group_intr().
5006 : : */
5007 : : static int
5008 : 0 : vfio_user_ctrlr_intr(void *ctx)
5009 : : {
5010 : : struct nvmf_vfio_user_poll_group *vu_ctrlr_group;
5011 : 0 : struct nvmf_vfio_user_ctrlr *vu_ctrlr = ctx;
5012 : : struct nvmf_vfio_user_poll_group *vu_group;
5013 : 0 : int ret = SPDK_POLLER_IDLE;
5014 : :
5015 : 0 : vu_ctrlr_group = ctrlr_to_poll_group(vu_ctrlr);
5016 : :
5017 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db, "ctrlr pg:%p got intr\n", vu_ctrlr_group);
5018 : :
5019 : 0 : vu_ctrlr_group->stats.ctrlr_intr++;
5020 : :
5021 : : /*
5022 : : * Poll vfio-user for this controller. We need to do this before polling
5023 : : * any SQs, as this is where doorbell writes may be handled.
5024 : : */
5025 : 0 : ret = vfio_user_poll_vfu_ctx(vu_ctrlr);
5026 : :
5027 : : /*
5028 : : * `sqs[0]` could be set to NULL in vfio_user_poll_vfu_ctx() context,
5029 : : * just return for this case.
5030 : : */
5031 [ # # ]: 0 : if (vu_ctrlr->sqs[0] == NULL) {
5032 : 0 : return ret;
5033 : : }
5034 : :
5035 [ # # # # ]: 0 : if (vu_ctrlr->transport->transport_opts.enable_intr_mode_sq_spreading) {
5036 : : /*
5037 : : * We may have just written to a doorbell owned by another
5038 : : * reactor: we need to prod them to make sure its SQs are polled
5039 : : * *after* the doorbell value is updated.
5040 : : */
5041 [ # # ]: 0 : TAILQ_FOREACH(vu_group, &vu_ctrlr->transport->poll_groups, link) {
5042 [ # # ]: 0 : if (vu_group != vu_ctrlr_group) {
5043 [ # # # # ]: 0 : SPDK_DEBUGLOG(vfio_user_db, "prodding pg:%p\n", vu_group);
5044 : 0 : eventfd_write(vu_group->intr_fd, 1);
5045 : : }
5046 : : }
5047 : : }
5048 : :
5049 : 0 : ret |= vfio_user_poll_group_process(vu_ctrlr_group);
5050 : :
5051 : 0 : return ret;
5052 : : }
5053 : :
5054 : : static void
5055 : 0 : vfio_user_ctrlr_set_intr_mode(struct spdk_poller *poller, void *ctx,
5056 : : bool interrupt_mode)
5057 : : {
5058 : 0 : struct nvmf_vfio_user_ctrlr *ctrlr = ctx;
5059 [ # # ]: 0 : assert(ctrlr != NULL);
5060 [ # # ]: 0 : assert(ctrlr->endpoint != NULL);
5061 : :
5062 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s: setting interrupt mode to %d\n",
5063 : : ctrlr_id(ctrlr), interrupt_mode);
5064 : :
5065 : : /*
5066 : : * interrupt_mode needs to persist across controller resets, so store
5067 : : * it in the endpoint instead.
5068 : : */
5069 : 0 : ctrlr->endpoint->interrupt_mode = interrupt_mode;
5070 : :
5071 : 0 : vfio_user_poll_group_rearm(ctrlr_to_poll_group(ctrlr));
5072 : 0 : }
5073 : :
5074 : : /*
5075 : : * In response to the nvmf_vfio_user_create_ctrlr() path, the admin queue is now
5076 : : * set up and we can start operating on this controller.
5077 : : */
5078 : : static void
5079 : 47 : start_ctrlr(struct nvmf_vfio_user_ctrlr *vu_ctrlr,
5080 : : struct spdk_nvmf_ctrlr *ctrlr)
5081 : : {
5082 : 47 : struct nvmf_vfio_user_endpoint *endpoint = vu_ctrlr->endpoint;
5083 : :
5084 : 47 : vu_ctrlr->ctrlr = ctrlr;
5085 : 47 : vu_ctrlr->cntlid = ctrlr->cntlid;
5086 : 47 : vu_ctrlr->thread = spdk_get_thread();
5087 : 47 : vu_ctrlr->state = VFIO_USER_CTRLR_RUNNING;
5088 : :
5089 [ + - ]: 47 : if (!in_interrupt_mode(endpoint->transport)) {
5090 : 47 : vu_ctrlr->vfu_ctx_poller = SPDK_POLLER_REGISTER(vfio_user_poll_vfu_ctx,
5091 : : vu_ctrlr, 1000);
5092 : 47 : return;
5093 : : }
5094 : :
5095 : 0 : vu_ctrlr->vfu_ctx_poller = SPDK_POLLER_REGISTER(vfio_user_poll_vfu_ctx,
5096 : : vu_ctrlr, 0);
5097 : :
5098 : 0 : vu_ctrlr->intr_fd = vfu_get_poll_fd(vu_ctrlr->endpoint->vfu_ctx);
5099 [ # # ]: 0 : assert(vu_ctrlr->intr_fd != -1);
5100 : :
5101 : 0 : vu_ctrlr->intr = SPDK_INTERRUPT_REGISTER(vu_ctrlr->intr_fd,
5102 : : vfio_user_ctrlr_intr, vu_ctrlr);
5103 : :
5104 [ # # ]: 0 : assert(vu_ctrlr->intr != NULL);
5105 : :
5106 : 0 : spdk_poller_register_interrupt(vu_ctrlr->vfu_ctx_poller,
5107 : : vfio_user_ctrlr_set_intr_mode,
5108 : : vu_ctrlr);
5109 : : }
5110 : :
5111 : : static int
5112 : 237 : handle_queue_connect_rsp(struct nvmf_vfio_user_req *req, void *cb_arg)
5113 : : {
5114 : : struct nvmf_vfio_user_poll_group *vu_group;
5115 : 237 : struct nvmf_vfio_user_sq *sq = cb_arg;
5116 : : struct nvmf_vfio_user_cq *admin_cq;
5117 : : struct nvmf_vfio_user_ctrlr *vu_ctrlr;
5118 : : struct nvmf_vfio_user_endpoint *endpoint;
5119 : :
5120 [ - + ]: 237 : assert(sq != NULL);
5121 [ - + ]: 237 : assert(req != NULL);
5122 : :
5123 : 237 : vu_ctrlr = sq->ctrlr;
5124 [ - + ]: 237 : assert(vu_ctrlr != NULL);
5125 : 237 : endpoint = vu_ctrlr->endpoint;
5126 [ - + ]: 237 : assert(endpoint != NULL);
5127 : :
5128 [ + - - + ]: 237 : if (spdk_nvme_cpl_is_error(&req->req.rsp->nvme_cpl)) {
5129 : 0 : SPDK_ERRLOG("SC %u, SCT %u\n", req->req.rsp->nvme_cpl.status.sc, req->req.rsp->nvme_cpl.status.sct);
5130 : 0 : endpoint->ctrlr = NULL;
5131 : 0 : free_ctrlr(vu_ctrlr);
5132 : 0 : return -1;
5133 : : }
5134 : :
5135 : 237 : vu_group = SPDK_CONTAINEROF(sq->group, struct nvmf_vfio_user_poll_group, group);
5136 : 237 : TAILQ_INSERT_TAIL(&vu_group->sqs, sq, link);
5137 : :
5138 : 237 : admin_cq = vu_ctrlr->cqs[0];
5139 [ - + ]: 237 : assert(admin_cq != NULL);
5140 [ - + ]: 237 : assert(admin_cq->group != NULL);
5141 [ - + ]: 237 : assert(admin_cq->group->group->thread != NULL);
5142 : :
5143 [ - + ]: 237 : pthread_mutex_lock(&endpoint->lock);
5144 [ + + ]: 237 : if (nvmf_qpair_is_admin_queue(&sq->qpair)) {
5145 [ - + ]: 47 : assert(admin_cq->group->group->thread == spdk_get_thread());
5146 : : /*
5147 : : * The admin queue is special as SQ0 and CQ0 are created
5148 : : * together.
5149 : : */
5150 : 47 : admin_cq->cq_ref = 1;
5151 : 47 : start_ctrlr(vu_ctrlr, sq->qpair.ctrlr);
5152 : : } else {
5153 : : /* For I/O queues this command was generated in response to an
5154 : : * ADMIN I/O CREATE SUBMISSION QUEUE command which has not yet
5155 : : * been completed. Complete it now.
5156 : : */
5157 [ - + + - ]: 190 : if (sq->post_create_io_sq_completion) {
5158 [ + + ]: 190 : if (admin_cq->group->group->thread != spdk_get_thread()) {
5159 : : struct vfio_user_post_cpl_ctx *cpl_ctx;
5160 : :
5161 : 131 : cpl_ctx = calloc(1, sizeof(*cpl_ctx));
5162 [ - + ]: 131 : if (!cpl_ctx) {
5163 : 0 : return -ENOMEM;
5164 : : }
5165 : 131 : cpl_ctx->ctrlr = vu_ctrlr;
5166 : 131 : cpl_ctx->cq = admin_cq;
5167 : 131 : cpl_ctx->cpl.sqid = 0;
5168 : 131 : cpl_ctx->cpl.cdw0 = 0;
5169 : 131 : cpl_ctx->cpl.cid = sq->create_io_sq_cmd.cid;
5170 : 131 : cpl_ctx->cpl.status.sc = SPDK_NVME_SC_SUCCESS;
5171 : 131 : cpl_ctx->cpl.status.sct = SPDK_NVME_SCT_GENERIC;
5172 : :
5173 : 131 : spdk_thread_send_msg(admin_cq->group->group->thread,
5174 : : _post_completion_msg,
5175 : : cpl_ctx);
5176 : : } else {
5177 : 59 : post_completion(vu_ctrlr, admin_cq, 0, 0,
5178 : 59 : sq->create_io_sq_cmd.cid, SPDK_NVME_SC_SUCCESS, SPDK_NVME_SCT_GENERIC);
5179 : : }
5180 : 190 : sq->post_create_io_sq_completion = false;
5181 [ # # ]: 0 : } else if (in_interrupt_mode(endpoint->transport)) {
5182 : : /*
5183 : : * If we're live migrating a guest, there is a window
5184 : : * where the I/O queues haven't been set up but the
5185 : : * device is in running state, during which the guest
5186 : : * might write to a doorbell. This doorbell write will
5187 : : * go unnoticed, so let's poll the whole controller to
5188 : : * pick that up.
5189 : : */
5190 : 0 : ctrlr_kick(vu_ctrlr);
5191 : : }
5192 : 190 : sq->sq_state = VFIO_USER_SQ_ACTIVE;
5193 : : }
5194 : :
5195 : 237 : TAILQ_INSERT_TAIL(&vu_ctrlr->connected_sqs, sq, tailq);
5196 [ - + ]: 237 : pthread_mutex_unlock(&endpoint->lock);
5197 : :
5198 : 237 : free(req->req.iov[0].iov_base);
5199 : 237 : req->req.iov[0].iov_base = NULL;
5200 : 237 : req->req.iovcnt = 0;
5201 : :
5202 : 237 : return 0;
5203 : : }
5204 : :
5205 : : static void
5206 : 237 : _nvmf_vfio_user_poll_group_add(void *req)
5207 : : {
5208 : 237 : spdk_nvmf_request_exec(req);
5209 : 237 : }
5210 : :
5211 : : /*
5212 : : * Add the given qpair to the given poll group. New qpairs are added via
5213 : : * spdk_nvmf_tgt_new_qpair(), which picks a poll group via
5214 : : * nvmf_vfio_user_get_optimal_poll_group(), then calls back here via
5215 : : * nvmf_transport_poll_group_add().
5216 : : */
5217 : : static int
5218 : 237 : nvmf_vfio_user_poll_group_add(struct spdk_nvmf_transport_poll_group *group,
5219 : : struct spdk_nvmf_qpair *qpair)
5220 : : {
5221 : : struct nvmf_vfio_user_sq *sq;
5222 : : struct nvmf_vfio_user_req *vu_req;
5223 : : struct nvmf_vfio_user_ctrlr *ctrlr;
5224 : : struct spdk_nvmf_request *req;
5225 : : struct spdk_nvmf_fabric_connect_data *data;
5226 : : bool admin;
5227 : :
5228 : 237 : sq = SPDK_CONTAINEROF(qpair, struct nvmf_vfio_user_sq, qpair);
5229 : 237 : sq->group = group;
5230 : 237 : ctrlr = sq->ctrlr;
5231 : :
5232 [ - + - + ]: 237 : SPDK_DEBUGLOG(nvmf_vfio, "%s: add QP%d=%p(%p) to poll_group=%p\n",
5233 : : ctrlr_id(ctrlr), sq->qpair.qid,
5234 : : sq, qpair, group);
5235 : :
5236 : 237 : admin = nvmf_qpair_is_admin_queue(&sq->qpair);
5237 : :
5238 : 237 : vu_req = get_nvmf_vfio_user_req(sq);
5239 [ - + ]: 237 : if (vu_req == NULL) {
5240 : 0 : return -1;
5241 : : }
5242 : :
5243 : 237 : req = &vu_req->req;
5244 : 237 : req->cmd->connect_cmd.opcode = SPDK_NVME_OPC_FABRIC;
5245 : 237 : req->cmd->connect_cmd.cid = 0;
5246 : 237 : req->cmd->connect_cmd.fctype = SPDK_NVMF_FABRIC_COMMAND_CONNECT;
5247 : 237 : req->cmd->connect_cmd.recfmt = 0;
5248 : 237 : req->cmd->connect_cmd.sqsize = sq->size - 1;
5249 [ + + ]: 237 : req->cmd->connect_cmd.qid = admin ? 0 : qpair->qid;
5250 : :
5251 : 237 : req->length = sizeof(struct spdk_nvmf_fabric_connect_data);
5252 : :
5253 : 237 : data = calloc(1, req->length);
5254 [ - + ]: 237 : if (data == NULL) {
5255 : 0 : nvmf_vfio_user_req_free(req);
5256 : 0 : return -ENOMEM;
5257 : : }
5258 : :
5259 : 237 : SPDK_IOV_ONE(req->iov, &req->iovcnt, data, req->length);
5260 : :
5261 : 237 : data->cntlid = ctrlr->cntlid;
5262 [ - + ]: 237 : snprintf(data->subnqn, sizeof(data->subnqn), "%s",
5263 : 237 : spdk_nvmf_subsystem_get_nqn(ctrlr->endpoint->subsystem));
5264 : :
5265 : 237 : vu_req->cb_fn = handle_queue_connect_rsp;
5266 : 237 : vu_req->cb_arg = sq;
5267 : :
5268 [ - + - + ]: 237 : SPDK_DEBUGLOG(nvmf_vfio,
5269 : : "%s: sending connect fabrics command for qid:%#x cntlid=%#x\n",
5270 : : ctrlr_id(ctrlr), qpair->qid, data->cntlid);
5271 : :
5272 : : /*
5273 : : * By the time transport's poll_group_add() callback is executed, the
5274 : : * qpair isn't in the ACTIVE state yet, so spdk_nvmf_request_exec()
5275 : : * would fail. The state changes to ACTIVE immediately after the
5276 : : * callback finishes, so delay spdk_nvmf_request_exec() by sending a
5277 : : * message.
5278 : : */
5279 : 237 : spdk_thread_send_msg(spdk_get_thread(), _nvmf_vfio_user_poll_group_add, req);
5280 : 237 : return 0;
5281 : : }
5282 : :
5283 : : static int
5284 : 237 : nvmf_vfio_user_poll_group_remove(struct spdk_nvmf_transport_poll_group *group,
5285 : : struct spdk_nvmf_qpair *qpair)
5286 : : {
5287 : : struct nvmf_vfio_user_sq *sq;
5288 : : struct nvmf_vfio_user_poll_group *vu_group;
5289 : :
5290 : 237 : sq = SPDK_CONTAINEROF(qpair, struct nvmf_vfio_user_sq, qpair);
5291 : :
5292 [ - + - + ]: 237 : SPDK_DEBUGLOG(nvmf_vfio,
5293 : : "%s: remove NVMf QP%d=%p from NVMf poll_group=%p\n",
5294 : : ctrlr_id(sq->ctrlr), qpair->qid, qpair, group);
5295 : :
5296 : :
5297 : 237 : vu_group = SPDK_CONTAINEROF(group, struct nvmf_vfio_user_poll_group, group);
5298 [ + + ]: 237 : TAILQ_REMOVE(&vu_group->sqs, sq, link);
5299 : :
5300 : 237 : return 0;
5301 : : }
5302 : :
5303 : : static void
5304 : 2899740 : _nvmf_vfio_user_req_free(struct nvmf_vfio_user_sq *sq, struct nvmf_vfio_user_req *vu_req)
5305 : : {
5306 [ - + ]: 2899740 : memset(&vu_req->cmd, 0, sizeof(vu_req->cmd));
5307 [ - + ]: 2899740 : memset(&vu_req->rsp, 0, sizeof(vu_req->rsp));
5308 : 2899740 : vu_req->iovcnt = 0;
5309 : 2899740 : vu_req->req.iovcnt = 0;
5310 : 2899740 : vu_req->req.length = 0;
5311 : 2899740 : vu_req->state = VFIO_USER_REQUEST_STATE_FREE;
5312 : :
5313 : 2899740 : TAILQ_INSERT_TAIL(&sq->free_reqs, vu_req, link);
5314 : 2899740 : }
5315 : :
5316 : : static int
5317 : 8 : nvmf_vfio_user_req_free(struct spdk_nvmf_request *req)
5318 : : {
5319 : : struct nvmf_vfio_user_sq *sq;
5320 : : struct nvmf_vfio_user_req *vu_req;
5321 : :
5322 [ - + ]: 8 : assert(req != NULL);
5323 : :
5324 : 8 : vu_req = SPDK_CONTAINEROF(req, struct nvmf_vfio_user_req, req);
5325 : 8 : sq = SPDK_CONTAINEROF(req->qpair, struct nvmf_vfio_user_sq, qpair);
5326 : :
5327 : 8 : _nvmf_vfio_user_req_free(sq, vu_req);
5328 : :
5329 : 8 : return 0;
5330 : : }
5331 : :
5332 : : static int
5333 : 2173434 : nvmf_vfio_user_req_complete(struct spdk_nvmf_request *req)
5334 : : {
5335 : : struct nvmf_vfio_user_sq *sq;
5336 : : struct nvmf_vfio_user_req *vu_req;
5337 : :
5338 [ - + ]: 2173434 : assert(req != NULL);
5339 : :
5340 : 2173434 : vu_req = SPDK_CONTAINEROF(req, struct nvmf_vfio_user_req, req);
5341 : 2173434 : sq = SPDK_CONTAINEROF(req->qpair, struct nvmf_vfio_user_sq, qpair);
5342 : :
5343 [ + - ]: 2173434 : if (vu_req->cb_fn != NULL) {
5344 [ - + ]: 2173434 : if (vu_req->cb_fn(vu_req, vu_req->cb_arg) != 0) {
5345 : 0 : fail_ctrlr(sq->ctrlr);
5346 : : }
5347 : : }
5348 : :
5349 : 2173434 : _nvmf_vfio_user_req_free(sq, vu_req);
5350 : :
5351 : 2173434 : return 0;
5352 : : }
5353 : :
5354 : : static void
5355 : 237 : nvmf_vfio_user_close_qpair(struct spdk_nvmf_qpair *qpair,
5356 : : spdk_nvmf_transport_qpair_fini_cb cb_fn, void *cb_arg)
5357 : : {
5358 : : struct nvmf_vfio_user_sq *sq;
5359 : : struct nvmf_vfio_user_ctrlr *vu_ctrlr;
5360 : : struct nvmf_vfio_user_endpoint *endpoint;
5361 : : struct vfio_user_delete_sq_ctx *del_ctx;
5362 : :
5363 [ - + ]: 237 : assert(qpair != NULL);
5364 : 237 : sq = SPDK_CONTAINEROF(qpair, struct nvmf_vfio_user_sq, qpair);
5365 : 237 : vu_ctrlr = sq->ctrlr;
5366 : 237 : endpoint = vu_ctrlr->endpoint;
5367 : 237 : del_ctx = sq->delete_ctx;
5368 : 237 : sq->delete_ctx = NULL;
5369 : :
5370 [ - + ]: 237 : pthread_mutex_lock(&endpoint->lock);
5371 [ + + ]: 237 : TAILQ_REMOVE(&vu_ctrlr->connected_sqs, sq, tailq);
5372 : 237 : delete_sq_done(vu_ctrlr, sq);
5373 [ + + ]: 237 : if (TAILQ_EMPTY(&vu_ctrlr->connected_sqs)) {
5374 : 47 : endpoint->ctrlr = NULL;
5375 [ - + - + : 47 : if (vu_ctrlr->in_source_vm && endpoint->need_resume) {
- - - - ]
5376 : : /* The controller will be freed, we can resume the subsystem
5377 : : * now so that the endpoint can be ready to accept another
5378 : : * new connection.
5379 : : */
5380 : 0 : spdk_nvmf_subsystem_resume((struct spdk_nvmf_subsystem *)endpoint->subsystem,
5381 : : vfio_user_endpoint_resume_done, endpoint);
5382 : : }
5383 : 47 : free_ctrlr(vu_ctrlr);
5384 : : }
5385 [ - + ]: 237 : pthread_mutex_unlock(&endpoint->lock);
5386 : :
5387 [ + + ]: 237 : if (del_ctx) {
5388 : 169 : vfio_user_qpair_delete_cb(del_ctx);
5389 : : }
5390 : :
5391 [ + - ]: 237 : if (cb_fn) {
5392 : 237 : cb_fn(cb_arg);
5393 : : }
5394 : 237 : }
5395 : :
5396 : : /**
5397 : : * Returns a preallocated request, or NULL if there isn't one available.
5398 : : */
5399 : : static struct nvmf_vfio_user_req *
5400 : 2899740 : get_nvmf_vfio_user_req(struct nvmf_vfio_user_sq *sq)
5401 : : {
5402 : : struct nvmf_vfio_user_req *req;
5403 : :
5404 [ - + ]: 2899740 : if (sq == NULL) {
5405 : 0 : return NULL;
5406 : : }
5407 : :
5408 : 2899740 : req = TAILQ_FIRST(&sq->free_reqs);
5409 [ - + ]: 2899740 : if (req == NULL) {
5410 : 0 : return NULL;
5411 : : }
5412 : :
5413 [ + - ]: 2899740 : TAILQ_REMOVE(&sq->free_reqs, req, link);
5414 : :
5415 : 2899740 : return req;
5416 : : }
5417 : :
5418 : : static int
5419 : 2386321 : get_nvmf_io_req_length(struct spdk_nvmf_request *req)
5420 : : {
5421 : : uint16_t nr;
5422 : : uint32_t nlb, nsid;
5423 : 2386321 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
5424 : 2386321 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
5425 : : struct spdk_nvmf_ns *ns;
5426 : :
5427 : 2386321 : nsid = cmd->nsid;
5428 : 2386321 : ns = _nvmf_subsystem_get_ns(ctrlr->subsys, nsid);
5429 [ + - - + ]: 2386321 : if (ns == NULL || ns->bdev == NULL) {
5430 : 0 : SPDK_ERRLOG("unsuccessful query for nsid %u\n", cmd->nsid);
5431 : 0 : return -EINVAL;
5432 : : }
5433 : :
5434 [ + + ]: 2386321 : if (cmd->opc == SPDK_NVME_OPC_DATASET_MANAGEMENT) {
5435 : 3772 : nr = cmd->cdw10_bits.dsm.nr + 1;
5436 : 3772 : return nr * sizeof(struct spdk_nvme_dsm_range);
5437 : : }
5438 : :
5439 [ + + ]: 2382549 : if (cmd->opc == SPDK_NVME_OPC_COPY) {
5440 : 3739 : nr = (cmd->cdw12 & 0x000000ffu) + 1;
5441 : 3739 : return nr * sizeof(struct spdk_nvme_scc_source_range);
5442 : : }
5443 : :
5444 : 2378810 : nlb = (cmd->cdw12 & 0x0000ffffu) + 1;
5445 : 2378810 : return nlb * spdk_bdev_get_block_size(ns->bdev);
5446 : : }
5447 : :
5448 : : static int
5449 : 250767 : map_admin_cmd_req(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvmf_request *req)
5450 : : {
5451 : 250767 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
5452 : 250767 : uint32_t len = 0, numdw = 0;
5453 : : uint8_t fid;
5454 : : int iovcnt;
5455 : :
5456 : 250767 : req->xfer = spdk_nvme_opc_get_data_transfer(cmd->opc);
5457 : :
5458 [ + + ]: 250767 : if (req->xfer == SPDK_NVME_DATA_NONE) {
5459 : 57014 : return 0;
5460 : : }
5461 : :
5462 [ + + + + : 193753 : switch (cmd->opc) {
+ ]
5463 : 1332 : case SPDK_NVME_OPC_IDENTIFY:
5464 : 1332 : len = 4096;
5465 : 1332 : break;
5466 : 992 : case SPDK_NVME_OPC_GET_LOG_PAGE:
5467 : 992 : numdw = ((((uint32_t)cmd->cdw11_bits.get_log_page.numdu << 16) |
5468 : 992 : cmd->cdw10_bits.get_log_page.numdl) + 1);
5469 [ + + ]: 992 : if (numdw > UINT32_MAX / 4) {
5470 : 715 : return -EINVAL;
5471 : : }
5472 : 277 : len = numdw * 4;
5473 : 277 : break;
5474 : 18984 : case SPDK_NVME_OPC_GET_FEATURES:
5475 : : case SPDK_NVME_OPC_SET_FEATURES:
5476 : 18984 : fid = cmd->cdw10_bits.set_features.fid;
5477 [ + + + + : 18984 : switch (fid) {
+ + ]
5478 : 5 : case SPDK_NVME_FEAT_LBA_RANGE_TYPE:
5479 : 5 : len = 4096;
5480 : 5 : break;
5481 : 8 : case SPDK_NVME_FEAT_AUTONOMOUS_POWER_STATE_TRANSITION:
5482 : 8 : len = 256;
5483 : 8 : break;
5484 : 5 : case SPDK_NVME_FEAT_TIMESTAMP:
5485 : 5 : len = 8;
5486 : 5 : break;
5487 : 10 : case SPDK_NVME_FEAT_HOST_BEHAVIOR_SUPPORT:
5488 : 10 : len = 512;
5489 : 10 : break;
5490 : 7 : case SPDK_NVME_FEAT_HOST_IDENTIFIER:
5491 [ + + ]: 7 : if (cmd->cdw11_bits.feat_host_identifier.bits.exhid) {
5492 : 3 : len = 16;
5493 : : } else {
5494 : 4 : len = 8;
5495 : : }
5496 : 7 : break;
5497 : 18949 : default:
5498 : 18949 : return 0;
5499 : : }
5500 : 35 : break;
5501 : 947 : case SPDK_NVME_OPC_FABRIC:
5502 : 947 : return -ENOTSUP;
5503 : 171498 : default:
5504 : 171498 : return 0;
5505 : : }
5506 : :
5507 : : /* ADMIN command will not use SGL */
5508 [ - + ]: 1644 : if (cmd->psdt != 0) {
5509 : 0 : return -EINVAL;
5510 : : }
5511 : :
5512 : 1644 : iovcnt = vfio_user_map_cmd(ctrlr, req, req->iov, len);
5513 [ + + ]: 1644 : if (iovcnt < 0) {
5514 : 1193 : SPDK_ERRLOG("%s: map Admin Opc %x failed\n",
5515 : : ctrlr_id(ctrlr), cmd->opc);
5516 : 1193 : return -1;
5517 : : }
5518 : 451 : req->length = len;
5519 : 451 : req->iovcnt = iovcnt;
5520 : :
5521 : 451 : return 0;
5522 : : }
5523 : :
5524 : : /*
5525 : : * Map an I/O command's buffers.
5526 : : *
5527 : : * Returns 0 on success and -errno on failure.
5528 : : */
5529 : : static int
5530 : 2629008 : map_io_cmd_req(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvmf_request *req)
5531 : : {
5532 : : int len, iovcnt;
5533 : : struct spdk_nvme_cmd *cmd;
5534 : :
5535 [ - + ]: 2629008 : assert(ctrlr != NULL);
5536 [ - + ]: 2629008 : assert(req != NULL);
5537 : :
5538 : 2629008 : cmd = &req->cmd->nvme_cmd;
5539 : 2629008 : req->xfer = spdk_nvme_opc_get_data_transfer(cmd->opc);
5540 : :
5541 [ + + ]: 2629008 : if (spdk_unlikely(req->xfer == SPDK_NVME_DATA_NONE)) {
5542 : 242687 : return 0;
5543 : : }
5544 : :
5545 : 2386321 : len = get_nvmf_io_req_length(req);
5546 [ - + ]: 2386321 : if (len < 0) {
5547 : 0 : return -EINVAL;
5548 : : }
5549 : 2386321 : req->length = len;
5550 : :
5551 : 2386321 : iovcnt = vfio_user_map_cmd(ctrlr, req, req->iov, req->length);
5552 [ + + ]: 2386321 : if (iovcnt < 0) {
5553 : 704544 : SPDK_ERRLOG("%s: failed to map IO OPC %u\n", ctrlr_id(ctrlr), cmd->opc);
5554 : 704544 : return -EFAULT;
5555 : : }
5556 : 1681777 : req->iovcnt = iovcnt;
5557 : :
5558 : 1681777 : return 0;
5559 : : }
5560 : :
5561 : : static int
5562 : 2898674 : handle_cmd_req(struct nvmf_vfio_user_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd,
5563 : : struct nvmf_vfio_user_sq *sq)
5564 : : {
5565 : : int err;
5566 : : struct nvmf_vfio_user_req *vu_req;
5567 : : struct spdk_nvmf_request *req;
5568 : :
5569 [ - + ]: 2898674 : assert(ctrlr != NULL);
5570 [ - + ]: 2898674 : assert(cmd != NULL);
5571 : :
5572 : 2898674 : vu_req = get_nvmf_vfio_user_req(sq);
5573 [ - + ]: 2898674 : if (spdk_unlikely(vu_req == NULL)) {
5574 : 0 : SPDK_ERRLOG("%s: no request for NVMe command opc 0x%x\n", ctrlr_id(ctrlr), cmd->opc);
5575 : 0 : return post_completion(ctrlr, ctrlr->cqs[sq->cqid], 0, 0, cmd->cid,
5576 : : SPDK_NVME_SC_INTERNAL_DEVICE_ERROR, SPDK_NVME_SCT_GENERIC);
5577 : :
5578 : : }
5579 : 2898674 : req = &vu_req->req;
5580 : :
5581 [ - + ]: 2898674 : assert(req->qpair != NULL);
5582 [ - + - + ]: 2898674 : SPDK_DEBUGLOG(nvmf_vfio, "%s: handle sqid:%u, req opc=%#x cid=%d\n",
5583 : : ctrlr_id(ctrlr), req->qpair->qid, cmd->opc, cmd->cid);
5584 : :
5585 : 2898674 : vu_req->cb_fn = handle_cmd_rsp;
5586 : 2898674 : vu_req->cb_arg = SPDK_CONTAINEROF(req->qpair, struct nvmf_vfio_user_sq, qpair);
5587 : 2898674 : req->cmd->nvme_cmd = *cmd;
5588 : :
5589 [ + + ]: 2898674 : if (nvmf_qpair_is_admin_queue(req->qpair)) {
5590 : 250767 : err = map_admin_cmd_req(ctrlr, req);
5591 : : } else {
5592 [ + + ]: 2647907 : switch (cmd->opc) {
5593 : 18899 : case SPDK_NVME_OPC_RESERVATION_REGISTER:
5594 : : case SPDK_NVME_OPC_RESERVATION_REPORT:
5595 : : case SPDK_NVME_OPC_RESERVATION_ACQUIRE:
5596 : : case SPDK_NVME_OPC_RESERVATION_RELEASE:
5597 : : case SPDK_NVME_OPC_FABRIC:
5598 : 18899 : err = -ENOTSUP;
5599 : 18899 : break;
5600 : 2629008 : default:
5601 : 2629008 : err = map_io_cmd_req(ctrlr, req);
5602 : 2629008 : break;
5603 : : }
5604 : : }
5605 : :
5606 [ + + ]: 2898674 : if (spdk_unlikely(err < 0)) {
5607 : 726298 : SPDK_ERRLOG("%s: process NVMe command opc 0x%x failed\n",
5608 : : ctrlr_id(ctrlr), cmd->opc);
5609 : 726298 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
5610 [ + + ]: 726298 : req->rsp->nvme_cpl.status.sc = err == -ENOTSUP ?
5611 : : SPDK_NVME_SC_INVALID_OPCODE :
5612 : : SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
5613 : 726298 : err = handle_cmd_rsp(vu_req, vu_req->cb_arg);
5614 : 726298 : _nvmf_vfio_user_req_free(sq, vu_req);
5615 : 726298 : return err;
5616 : : }
5617 : :
5618 : 2172376 : vu_req->state = VFIO_USER_REQUEST_STATE_EXECUTING;
5619 : 2172376 : spdk_nvmf_request_exec(req);
5620 : :
5621 : 2172376 : return 0;
5622 : : }
5623 : :
5624 : : /*
5625 : : * If we suppressed an IRQ in post_completion(), check if it needs to be fired
5626 : : * here: if the host isn't up to date, and is apparently not actively processing
5627 : : * the queue (i.e. ->last_head isn't changing), we need an IRQ.
5628 : : */
5629 : : static void
5630 : 73377046 : handle_suppressed_irq(struct nvmf_vfio_user_ctrlr *ctrlr,
5631 : : struct nvmf_vfio_user_sq *sq)
5632 : : {
5633 : 73377046 : struct nvmf_vfio_user_cq *cq = ctrlr->cqs[sq->cqid];
5634 : : uint32_t cq_head;
5635 : : uint32_t cq_tail;
5636 : :
5637 [ - + + + : 73377046 : if (!cq->ien || cq->qid == 0 || !ctrlr_interrupt_enabled(ctrlr)) {
+ + + + ]
5638 : 42332792 : return;
5639 : : }
5640 : :
5641 : 31044254 : cq_tail = *cq_tailp(cq);
5642 : :
5643 : : /* Already sent? */
5644 [ + + ]: 31044254 : if (cq_tail == cq->last_trigger_irq_tail) {
5645 : 31016598 : return;
5646 : : }
5647 : :
5648 : : spdk_ivdt_dcache(cq_dbl_headp(cq));
5649 : 27656 : cq_head = *cq_dbl_headp(cq);
5650 : :
5651 [ + + + + ]: 27656 : if (cq_head != cq_tail && cq_head == cq->last_head) {
5652 : 13982 : int err = vfu_irq_trigger(ctrlr->endpoint->vfu_ctx, cq->iv);
5653 [ - + ]: 13982 : if (err != 0) {
5654 : 0 : SPDK_ERRLOG("%s: failed to trigger interrupt: %m\n",
5655 : : ctrlr_id(ctrlr));
5656 : : } else {
5657 : 13982 : cq->last_trigger_irq_tail = cq_tail;
5658 : : }
5659 : : }
5660 : :
5661 : 27656 : cq->last_head = cq_head;
5662 : : }
5663 : :
5664 : : /* Returns the number of commands processed, or a negative value on error. */
5665 : : static int
5666 : 73716994 : nvmf_vfio_user_sq_poll(struct nvmf_vfio_user_sq *sq)
5667 : : {
5668 : : struct nvmf_vfio_user_ctrlr *ctrlr;
5669 : : uint32_t new_tail;
5670 : 73716994 : int count = 0;
5671 : :
5672 [ - + ]: 73716994 : assert(sq != NULL);
5673 : :
5674 : 73716994 : ctrlr = sq->ctrlr;
5675 : :
5676 : : /*
5677 : : * A quiesced, or migrating, controller should never process new
5678 : : * commands.
5679 : : */
5680 [ + + ]: 73716994 : if (ctrlr->state != VFIO_USER_CTRLR_RUNNING) {
5681 : 339948 : return SPDK_POLLER_IDLE;
5682 : : }
5683 : :
5684 [ - + + - ]: 73377046 : if (ctrlr->adaptive_irqs_enabled) {
5685 : 73377046 : handle_suppressed_irq(ctrlr, sq);
5686 : : }
5687 : :
5688 : : /* On aarch64 platforms, doorbells update from guest VM may not be seen
5689 : : * on SPDK target side. This is because there is memory type mismatch
5690 : : * situation here. That is on guest VM side, the doorbells are treated as
5691 : : * device memory while on SPDK target side, it is treated as normal
5692 : : * memory. And this situation cause problem on ARM platform.
5693 : : * Refer to "https://developer.arm.com/documentation/102376/0100/
5694 : : * Memory-aliasing-and-mismatched-memory-types". Only using spdk_mb()
5695 : : * cannot fix this. Use "dc civac" to invalidate cache may solve
5696 : : * this.
5697 : : */
5698 : : spdk_ivdt_dcache(sq_dbl_tailp(sq));
5699 : :
5700 : : /* Load-Acquire. */
5701 : 73377046 : new_tail = *sq_dbl_tailp(sq);
5702 : :
5703 : 73377046 : new_tail = new_tail & 0xffffu;
5704 [ - + ]: 73377046 : if (spdk_unlikely(new_tail >= sq->size)) {
5705 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio, "%s: invalid sqid:%u doorbell value %u\n", ctrlr_id(ctrlr), sq->qid,
5706 : : new_tail);
5707 : 0 : spdk_nvmf_ctrlr_async_event_error_event(ctrlr->ctrlr, SPDK_NVME_ASYNC_EVENT_INVALID_DB_WRITE);
5708 : :
5709 : 0 : return -1;
5710 : : }
5711 : :
5712 [ + + ]: 73377046 : if (*sq_headp(sq) == new_tail) {
5713 : 73141831 : return 0;
5714 : : }
5715 : :
5716 [ - + - + ]: 235215 : SPDK_DEBUGLOG(nvmf_vfio, "%s: sqid:%u doorbell old=%u new=%u\n",
5717 : : ctrlr_id(ctrlr), sq->qid, *sq_headp(sq), new_tail);
5718 [ - + ]: 235215 : if (ctrlr->sdbl != NULL) {
5719 [ # # # # ]: 0 : SPDK_DEBUGLOG(nvmf_vfio,
5720 : : "%s: sqid:%u bar0_doorbell=%u shadow_doorbell=%u eventidx=%u\n",
5721 : : ctrlr_id(ctrlr), sq->qid,
5722 : : ctrlr->bar0_doorbells[queue_index(sq->qid, false)],
5723 : : ctrlr->sdbl->shadow_doorbells[queue_index(sq->qid, false)],
5724 : : ctrlr->sdbl->eventidxs[queue_index(sq->qid, false)]);
5725 : : }
5726 : :
5727 : : /*
5728 : : * Ensure that changes to the queue are visible to us.
5729 : : * The host driver should write the queue first, do a wmb(), and then
5730 : : * update the SQ tail doorbell (their Store-Release).
5731 : : */
5732 : 235215 : spdk_rmb();
5733 : :
5734 : 235215 : count = handle_sq_tdbl_write(ctrlr, new_tail, sq);
5735 [ - + ]: 235215 : if (spdk_unlikely(count < 0)) {
5736 : 0 : fail_ctrlr(ctrlr);
5737 : : }
5738 : :
5739 : 235215 : return count;
5740 : : }
5741 : :
5742 : : /*
5743 : : * vfio-user transport poll handler. Note that the library context is polled in
5744 : : * a separate poller (->vfu_ctx_poller), so this poller only needs to poll the
5745 : : * active SQs.
5746 : : *
5747 : : * Returns the number of commands processed, or a negative value on error.
5748 : : */
5749 : : static int
5750 : 80933142 : nvmf_vfio_user_poll_group_poll(struct spdk_nvmf_transport_poll_group *group)
5751 : : {
5752 : : struct nvmf_vfio_user_poll_group *vu_group;
5753 : : struct nvmf_vfio_user_sq *sq, *tmp;
5754 : 80933142 : int count = 0;
5755 : :
5756 [ - + ]: 80933142 : assert(group != NULL);
5757 : :
5758 : 80933142 : vu_group = SPDK_CONTAINEROF(group, struct nvmf_vfio_user_poll_group, group);
5759 : :
5760 [ - + - + ]: 80933142 : SPDK_DEBUGLOG(vfio_user_db, "polling all SQs\n");
5761 : :
5762 [ + + ]: 155730679 : TAILQ_FOREACH_SAFE(sq, &vu_group->sqs, link, tmp) {
5763 : : int ret;
5764 : :
5765 [ + + - + ]: 74797537 : if (spdk_unlikely(sq->sq_state != VFIO_USER_SQ_ACTIVE || !sq->size)) {
5766 : 1080543 : continue;
5767 : : }
5768 : :
5769 : 73716994 : ret = nvmf_vfio_user_sq_poll(sq);
5770 : :
5771 [ - + ]: 73716994 : if (spdk_unlikely(ret < 0)) {
5772 : 0 : return ret;
5773 : : }
5774 : :
5775 : 73716994 : count += ret;
5776 : : }
5777 : :
5778 : 80933142 : vu_group->stats.polls++;
5779 : 80933142 : vu_group->stats.poll_reqs += count;
5780 : 80933142 : vu_group->stats.poll_reqs_squared += count * count;
5781 [ + + ]: 80933142 : if (count == 0) {
5782 : 80721574 : vu_group->stats.polls_spurious++;
5783 : : }
5784 : :
5785 : 80933142 : return count;
5786 : : }
5787 : :
5788 : : static int
5789 : 0 : nvmf_vfio_user_qpair_get_local_trid(struct spdk_nvmf_qpair *qpair,
5790 : : struct spdk_nvme_transport_id *trid)
5791 : : {
5792 : : struct nvmf_vfio_user_sq *sq;
5793 : : struct nvmf_vfio_user_ctrlr *ctrlr;
5794 : :
5795 : 0 : sq = SPDK_CONTAINEROF(qpair, struct nvmf_vfio_user_sq, qpair);
5796 : 0 : ctrlr = sq->ctrlr;
5797 : :
5798 [ # # # # ]: 0 : memcpy(trid, &ctrlr->endpoint->trid, sizeof(*trid));
5799 : 0 : return 0;
5800 : : }
5801 : :
5802 : : static int
5803 : 0 : nvmf_vfio_user_qpair_get_peer_trid(struct spdk_nvmf_qpair *qpair,
5804 : : struct spdk_nvme_transport_id *trid)
5805 : : {
5806 : 0 : return 0;
5807 : : }
5808 : :
5809 : : static int
5810 : 287 : nvmf_vfio_user_qpair_get_listen_trid(struct spdk_nvmf_qpair *qpair,
5811 : : struct spdk_nvme_transport_id *trid)
5812 : : {
5813 : : struct nvmf_vfio_user_sq *sq;
5814 : : struct nvmf_vfio_user_ctrlr *ctrlr;
5815 : :
5816 : 287 : sq = SPDK_CONTAINEROF(qpair, struct nvmf_vfio_user_sq, qpair);
5817 : 287 : ctrlr = sq->ctrlr;
5818 : :
5819 [ - + - + ]: 287 : memcpy(trid, &ctrlr->endpoint->trid, sizeof(*trid));
5820 : 287 : return 0;
5821 : : }
5822 : :
5823 : : static void
5824 : 0 : nvmf_vfio_user_qpair_abort_request(struct spdk_nvmf_qpair *qpair,
5825 : : struct spdk_nvmf_request *req)
5826 : : {
5827 : 0 : struct spdk_nvmf_request *req_to_abort = NULL;
5828 : 0 : struct spdk_nvmf_request *temp_req = NULL;
5829 : : uint16_t cid;
5830 : :
5831 : 0 : cid = req->cmd->nvme_cmd.cdw10_bits.abort.cid;
5832 : :
5833 [ # # ]: 0 : TAILQ_FOREACH(temp_req, &qpair->outstanding, link) {
5834 : : struct nvmf_vfio_user_req *vu_req;
5835 : :
5836 : 0 : vu_req = SPDK_CONTAINEROF(temp_req, struct nvmf_vfio_user_req, req);
5837 : :
5838 [ # # # # ]: 0 : if (vu_req->state == VFIO_USER_REQUEST_STATE_EXECUTING && vu_req->cmd.cid == cid) {
5839 : 0 : req_to_abort = temp_req;
5840 : 0 : break;
5841 : : }
5842 : : }
5843 : :
5844 [ # # ]: 0 : if (req_to_abort == NULL) {
5845 : 0 : spdk_nvmf_request_complete(req);
5846 : 0 : return;
5847 : : }
5848 : :
5849 : 0 : req->req_to_abort = req_to_abort;
5850 : 0 : nvmf_ctrlr_abort_request(req);
5851 : : }
5852 : :
5853 : : static void
5854 : 0 : nvmf_vfio_user_poll_group_dump_stat(struct spdk_nvmf_transport_poll_group *group,
5855 : : struct spdk_json_write_ctx *w)
5856 : : {
5857 : 0 : struct nvmf_vfio_user_poll_group *vu_group = SPDK_CONTAINEROF(group,
5858 : : struct nvmf_vfio_user_poll_group, group);
5859 : : uint64_t polls_denom;
5860 : :
5861 : 0 : spdk_json_write_named_uint64(w, "ctrlr_intr", vu_group->stats.ctrlr_intr);
5862 : 0 : spdk_json_write_named_uint64(w, "ctrlr_kicks", vu_group->stats.ctrlr_kicks);
5863 : 0 : spdk_json_write_named_uint64(w, "won", vu_group->stats.won);
5864 : 0 : spdk_json_write_named_uint64(w, "lost", vu_group->stats.lost);
5865 : 0 : spdk_json_write_named_uint64(w, "lost_count", vu_group->stats.lost_count);
5866 : 0 : spdk_json_write_named_uint64(w, "rearms", vu_group->stats.rearms);
5867 : 0 : spdk_json_write_named_uint64(w, "pg_process_count", vu_group->stats.pg_process_count);
5868 : 0 : spdk_json_write_named_uint64(w, "intr", vu_group->stats.intr);
5869 : 0 : spdk_json_write_named_uint64(w, "polls", vu_group->stats.polls);
5870 : 0 : spdk_json_write_named_uint64(w, "polls_spurious", vu_group->stats.polls_spurious);
5871 : 0 : spdk_json_write_named_uint64(w, "poll_reqs", vu_group->stats.poll_reqs);
5872 : 0 : polls_denom = vu_group->stats.polls * (vu_group->stats.polls - 1);
5873 [ # # ]: 0 : if (polls_denom) {
5874 : 0 : uint64_t n = vu_group->stats.polls * vu_group->stats.poll_reqs_squared - vu_group->stats.poll_reqs *
5875 : 0 : vu_group->stats.poll_reqs;
5876 [ # # ]: 0 : spdk_json_write_named_double(w, "poll_reqs_variance", sqrt(n / polls_denom));
5877 : : }
5878 : :
5879 : 0 : spdk_json_write_named_uint64(w, "cqh_admin_writes", vu_group->stats.cqh_admin_writes);
5880 : 0 : spdk_json_write_named_uint64(w, "cqh_io_writes", vu_group->stats.cqh_io_writes);
5881 : 0 : }
5882 : :
5883 : : static void
5884 : 7 : nvmf_vfio_user_opts_init(struct spdk_nvmf_transport_opts *opts)
5885 : : {
5886 : 7 : opts->max_queue_depth = NVMF_VFIO_USER_DEFAULT_MAX_QUEUE_DEPTH;
5887 : 7 : opts->max_qpairs_per_ctrlr = NVMF_VFIO_USER_DEFAULT_MAX_QPAIRS_PER_CTRLR;
5888 : 7 : opts->in_capsule_data_size = 0;
5889 : 7 : opts->max_io_size = NVMF_VFIO_USER_DEFAULT_MAX_IO_SIZE;
5890 : 7 : opts->io_unit_size = NVMF_VFIO_USER_DEFAULT_IO_UNIT_SIZE;
5891 : 7 : opts->max_aq_depth = NVMF_VFIO_USER_DEFAULT_AQ_DEPTH;
5892 : 7 : opts->num_shared_buffers = 0;
5893 : 7 : opts->buf_cache_size = 0;
5894 : 7 : opts->association_timeout = 0;
5895 : 7 : opts->transport_specific = NULL;
5896 : 7 : }
5897 : :
5898 : : const struct spdk_nvmf_transport_ops spdk_nvmf_transport_vfio_user = {
5899 : : .name = "VFIOUSER",
5900 : : .type = SPDK_NVME_TRANSPORT_VFIOUSER,
5901 : : .opts_init = nvmf_vfio_user_opts_init,
5902 : : .create = nvmf_vfio_user_create,
5903 : : .destroy = nvmf_vfio_user_destroy,
5904 : :
5905 : : .listen = nvmf_vfio_user_listen,
5906 : : .stop_listen = nvmf_vfio_user_stop_listen,
5907 : : .cdata_init = nvmf_vfio_user_cdata_init,
5908 : : .listen_associate = nvmf_vfio_user_listen_associate,
5909 : :
5910 : : .listener_discover = nvmf_vfio_user_discover,
5911 : :
5912 : : .poll_group_create = nvmf_vfio_user_poll_group_create,
5913 : : .get_optimal_poll_group = nvmf_vfio_user_get_optimal_poll_group,
5914 : : .poll_group_destroy = nvmf_vfio_user_poll_group_destroy,
5915 : : .poll_group_add = nvmf_vfio_user_poll_group_add,
5916 : : .poll_group_remove = nvmf_vfio_user_poll_group_remove,
5917 : : .poll_group_poll = nvmf_vfio_user_poll_group_poll,
5918 : :
5919 : : .req_free = nvmf_vfio_user_req_free,
5920 : : .req_complete = nvmf_vfio_user_req_complete,
5921 : :
5922 : : .qpair_fini = nvmf_vfio_user_close_qpair,
5923 : : .qpair_get_local_trid = nvmf_vfio_user_qpair_get_local_trid,
5924 : : .qpair_get_peer_trid = nvmf_vfio_user_qpair_get_peer_trid,
5925 : : .qpair_get_listen_trid = nvmf_vfio_user_qpair_get_listen_trid,
5926 : : .qpair_abort_request = nvmf_vfio_user_qpair_abort_request,
5927 : :
5928 : : .poll_group_dump_stat = nvmf_vfio_user_poll_group_dump_stat,
5929 : : };
5930 : :
5931 : 141 : SPDK_NVMF_TRANSPORT_REGISTER(muser, &spdk_nvmf_transport_vfio_user);
5932 : 141 : SPDK_LOG_REGISTER_COMPONENT(nvmf_vfio)
5933 : 141 : SPDK_LOG_REGISTER_COMPONENT(vfio_user_db)
|