Line data Source code
1 : /* SPDX-License-Identifier: BSD-3-Clause
2 : * Copyright (C) 2016 Intel Corporation. All rights reserved.
3 : * Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.
4 : * Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
5 : */
6 :
7 : #ifndef __NVMF_INTERNAL_H__
8 : #define __NVMF_INTERNAL_H__
9 :
10 : #include "spdk/stdinc.h"
11 :
12 : #include "spdk/keyring.h"
13 : #include "spdk/likely.h"
14 : #include "spdk/nvmf.h"
15 : #include "spdk/nvmf_cmd.h"
16 : #include "spdk/nvmf_transport.h"
17 : #include "spdk/nvmf_spec.h"
18 : #include "spdk/assert.h"
19 : #include "spdk/bdev.h"
20 : #include "spdk/queue.h"
21 : #include "spdk/util.h"
22 : #include "spdk/thread.h"
23 : #include "spdk/tree.h"
24 : #include "spdk/bit_array.h"
25 :
26 : /* The spec reserves cntlid values in the range FFF0h to FFFFh. */
27 : #define NVMF_MIN_CNTLID 1
28 : #define NVMF_MAX_CNTLID 0xFFEF
29 :
30 : enum spdk_nvmf_tgt_state {
31 : NVMF_TGT_IDLE = 0,
32 : NVMF_TGT_RUNNING,
33 : NVMF_TGT_PAUSING,
34 : NVMF_TGT_PAUSED,
35 : NVMF_TGT_RESUMING,
36 : };
37 :
38 : enum spdk_nvmf_subsystem_state {
39 : SPDK_NVMF_SUBSYSTEM_INACTIVE = 0,
40 : SPDK_NVMF_SUBSYSTEM_ACTIVATING,
41 : SPDK_NVMF_SUBSYSTEM_ACTIVE,
42 : SPDK_NVMF_SUBSYSTEM_PAUSING,
43 : SPDK_NVMF_SUBSYSTEM_PAUSED,
44 : SPDK_NVMF_SUBSYSTEM_RESUMING,
45 : SPDK_NVMF_SUBSYSTEM_DEACTIVATING,
46 : SPDK_NVMF_SUBSYSTEM_NUM_STATES,
47 : };
48 :
49 : RB_HEAD(subsystem_tree, spdk_nvmf_subsystem);
50 :
51 : struct spdk_nvmf_tgt {
52 : char name[NVMF_TGT_NAME_MAX_LENGTH];
53 :
54 : pthread_mutex_t mutex;
55 :
56 : uint64_t discovery_genctr;
57 :
58 : uint32_t max_subsystems;
59 :
60 : uint32_t discovery_filter;
61 :
62 : enum spdk_nvmf_tgt_state state;
63 :
64 : struct spdk_bit_array *subsystem_ids;
65 :
66 : struct subsystem_tree subsystems;
67 :
68 : TAILQ_HEAD(, spdk_nvmf_transport) transports;
69 : TAILQ_HEAD(, spdk_nvmf_poll_group) poll_groups;
70 : TAILQ_HEAD(, spdk_nvmf_referral) referrals;
71 :
72 : /* Used for round-robin assignment of connections to poll groups */
73 : struct spdk_nvmf_poll_group *next_poll_group;
74 :
75 : spdk_nvmf_tgt_destroy_done_fn *destroy_cb_fn;
76 : void *destroy_cb_arg;
77 :
78 : uint16_t crdt[3];
79 : uint16_t num_poll_groups;
80 :
81 : /* Allowed DH-HMAC-CHAP digests/dhgroups */
82 : uint32_t dhchap_digests;
83 : uint32_t dhchap_dhgroups;
84 :
85 : TAILQ_ENTRY(spdk_nvmf_tgt) link;
86 : };
87 :
88 : struct spdk_nvmf_host {
89 : char nqn[SPDK_NVMF_NQN_MAX_LEN + 1];
90 : struct spdk_key *dhchap_key;
91 : struct spdk_key *dhchap_ctrlr_key;
92 : TAILQ_ENTRY(spdk_nvmf_host) link;
93 : };
94 :
95 : struct spdk_nvmf_subsystem_listener {
96 : struct spdk_nvmf_subsystem *subsystem;
97 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn;
98 : void *cb_arg;
99 : struct spdk_nvme_transport_id *trid;
100 : struct spdk_nvmf_transport *transport;
101 : enum spdk_nvme_ana_state *ana_state;
102 : uint64_t ana_state_change_count;
103 : uint16_t id;
104 : struct spdk_nvmf_listener_opts opts;
105 : TAILQ_ENTRY(spdk_nvmf_subsystem_listener) link;
106 : };
107 :
108 : struct spdk_nvmf_referral {
109 : /* Discovery Log Page Entry for this referral */
110 : struct spdk_nvmf_discovery_log_page_entry entry;
111 : /* Transport ID */
112 : struct spdk_nvme_transport_id trid;
113 : TAILQ_ENTRY(spdk_nvmf_referral) link;
114 : };
115 :
116 : struct spdk_nvmf_subsystem_pg_ns_info {
117 : struct spdk_io_channel *channel;
118 : struct spdk_uuid uuid;
119 : /* current reservation key, no reservation if the value is 0 */
120 : uint64_t crkey;
121 : /* reservation type */
122 : enum spdk_nvme_reservation_type rtype;
123 : /* Host ID which holds the reservation */
124 : struct spdk_uuid holder_id;
125 : /* Host ID for the registrants with the namespace */
126 : struct spdk_uuid reg_hostid[SPDK_NVMF_MAX_NUM_REGISTRANTS];
127 : uint64_t num_blocks;
128 :
129 : /* I/O outstanding to this namespace */
130 : uint64_t io_outstanding;
131 : enum spdk_nvmf_subsystem_state state;
132 : };
133 :
134 : typedef void(*spdk_nvmf_poll_group_mod_done)(void *cb_arg, int status);
135 :
136 : struct spdk_nvmf_subsystem_poll_group {
137 : /* Array of namespace information for each namespace indexed by nsid - 1 */
138 : struct spdk_nvmf_subsystem_pg_ns_info *ns_info;
139 : uint32_t num_ns;
140 : enum spdk_nvmf_subsystem_state state;
141 :
142 : /* Number of ADMIN and FABRICS requests outstanding */
143 : uint64_t mgmt_io_outstanding;
144 : spdk_nvmf_poll_group_mod_done cb_fn;
145 : void *cb_arg;
146 :
147 : TAILQ_HEAD(, spdk_nvmf_request) queued;
148 : };
149 :
150 : struct spdk_nvmf_registrant {
151 : TAILQ_ENTRY(spdk_nvmf_registrant) link;
152 : struct spdk_uuid hostid;
153 : /* Registration key */
154 : uint64_t rkey;
155 : };
156 :
157 : struct spdk_nvmf_ns {
158 : uint32_t nsid;
159 : uint32_t anagrpid;
160 : struct spdk_nvmf_subsystem *subsystem;
161 : struct spdk_bdev *bdev;
162 : struct spdk_bdev_desc *desc;
163 : struct spdk_nvmf_ns_opts opts;
164 : /* reservation notification mask */
165 : uint32_t mask;
166 : /* generation code */
167 : uint32_t gen;
168 : /* registrants head */
169 : TAILQ_HEAD(, spdk_nvmf_registrant) registrants;
170 : /* current reservation key */
171 : uint64_t crkey;
172 : /* reservation type */
173 : enum spdk_nvme_reservation_type rtype;
174 : /* current reservation holder, only valid if reservation type can only have one holder */
175 : struct spdk_nvmf_registrant *holder;
176 : /* Persist Through Power Loss file which contains the persistent reservation */
177 : char *ptpl_file;
178 : /* Persist Through Power Loss feature is enabled */
179 : bool ptpl_activated;
180 : /* ZCOPY supported on bdev device */
181 : bool zcopy;
182 : /* Command Set Identifier */
183 : enum spdk_nvme_csi csi;
184 : /* Make namespace visible to controllers of these hosts */
185 : TAILQ_HEAD(, spdk_nvmf_host) hosts;
186 : /* Namespace is always visible to all controllers */
187 : bool always_visible;
188 : };
189 :
190 : /*
191 : * NVMf reservation notification log page.
192 : */
193 : struct spdk_nvmf_reservation_log {
194 : struct spdk_nvme_reservation_notification_log log;
195 : TAILQ_ENTRY(spdk_nvmf_reservation_log) link;
196 : struct spdk_nvmf_ctrlr *ctrlr;
197 : };
198 :
199 : /*
200 : * NVMf async event completion.
201 : */
202 : struct spdk_nvmf_async_event_completion {
203 : union spdk_nvme_async_event_completion event;
204 : STAILQ_ENTRY(spdk_nvmf_async_event_completion) link;
205 : };
206 :
207 : /*
208 : * This structure represents an NVMe-oF controller,
209 : * which is like a "session" in networking terms.
210 : */
211 : struct spdk_nvmf_ctrlr {
212 : uint16_t cntlid;
213 : char hostnqn[SPDK_NVMF_NQN_MAX_LEN + 1];
214 : struct spdk_nvmf_subsystem *subsys;
215 : struct spdk_bit_array *visible_ns;
216 :
217 : struct spdk_nvmf_ctrlr_data cdata;
218 :
219 : struct spdk_nvmf_registers vcprop;
220 :
221 : struct spdk_nvmf_ctrlr_feat feat;
222 :
223 : struct spdk_nvmf_qpair *admin_qpair;
224 : struct spdk_thread *thread;
225 : struct spdk_bit_array *qpair_mask;
226 :
227 : const struct spdk_nvmf_subsystem_listener *listener;
228 :
229 : struct spdk_nvmf_request *aer_req[SPDK_NVMF_MAX_ASYNC_EVENTS];
230 : STAILQ_HEAD(, spdk_nvmf_async_event_completion) async_events;
231 : uint64_t notice_aen_mask;
232 : uint8_t nr_aer_reqs;
233 : struct spdk_uuid hostid;
234 :
235 : uint32_t association_timeout; /* in milliseconds */
236 : uint16_t changed_ns_list_count;
237 : struct spdk_nvme_ns_list changed_ns_list;
238 : uint64_t log_page_count;
239 : uint8_t num_avail_log_pages;
240 : TAILQ_HEAD(log_page_head, spdk_nvmf_reservation_log) log_head;
241 :
242 : /* Time to trigger keep-alive--poller_time = now_tick + period */
243 : uint64_t last_keep_alive_tick;
244 : struct spdk_poller *keep_alive_poller;
245 :
246 : struct spdk_poller *association_timer;
247 :
248 : struct spdk_poller *cc_timer;
249 : uint64_t cc_timeout_tsc;
250 : struct spdk_poller *cc_timeout_timer;
251 :
252 : bool dif_insert_or_strip;
253 : bool in_destruct;
254 : bool disconnect_in_progress;
255 : /* valid only when disconnect_in_progress is true */
256 : bool disconnect_is_shn;
257 : bool acre_enabled;
258 : bool dynamic_ctrlr;
259 : /* LBA Format Extension Enabled (LBAFEE) */
260 : bool lbafee_enabled;
261 :
262 : TAILQ_ENTRY(spdk_nvmf_ctrlr) link;
263 : };
264 :
265 : #define NVMF_MAX_LISTENERS_PER_SUBSYSTEM 16
266 :
267 : struct nvmf_subsystem_state_change_ctx {
268 : struct spdk_nvmf_subsystem *subsystem;
269 : uint16_t nsid;
270 :
271 : enum spdk_nvmf_subsystem_state original_state;
272 : enum spdk_nvmf_subsystem_state requested_state;
273 : int status;
274 : struct spdk_thread *thread;
275 :
276 : spdk_nvmf_subsystem_state_change_done cb_fn;
277 : void *cb_arg;
278 : TAILQ_ENTRY(nvmf_subsystem_state_change_ctx) link;
279 : };
280 :
281 : struct spdk_nvmf_subsystem {
282 : struct spdk_thread *thread;
283 :
284 : uint32_t id;
285 :
286 : enum spdk_nvmf_subsystem_state state;
287 : enum spdk_nvmf_subtype subtype;
288 :
289 : uint16_t next_cntlid;
290 : struct {
291 : uint8_t allow_any_listener : 1;
292 : uint8_t ana_reporting : 1;
293 : uint8_t reserved : 6;
294 : } flags;
295 :
296 : /* Protected against concurrent access by ->mutex */
297 : bool allow_any_host;
298 :
299 : bool destroying;
300 : bool async_destroy;
301 :
302 : /* FDP related fields */
303 : bool fdp_supported;
304 :
305 : /* Zoned storage related fields */
306 : uint64_t max_zone_append_size_kib;
307 :
308 : struct spdk_nvmf_tgt *tgt;
309 : RB_ENTRY(spdk_nvmf_subsystem) link;
310 :
311 : /* Array of pointers to namespaces of size max_nsid indexed by nsid - 1 */
312 : struct spdk_nvmf_ns **ns;
313 : uint32_t max_nsid;
314 :
315 : uint16_t min_cntlid;
316 : uint16_t max_cntlid;
317 :
318 : uint64_t max_discard_size_kib;
319 : uint64_t max_write_zeroes_size_kib;
320 :
321 : TAILQ_HEAD(, spdk_nvmf_ctrlr) ctrlrs;
322 :
323 : /* This mutex is used to protect fields that aren't touched on the I/O path (e.g. it's
324 : * needed for handling things like the CONNECT command) instead of requiring the subsystem
325 : * to be paused. It makes it possible to modify those fields (e.g. add/remove hosts)
326 : * without affecting outstanding I/O requests.
327 : */
328 : pthread_mutex_t mutex;
329 : /* Protected against concurrent access by ->mutex */
330 : TAILQ_HEAD(, spdk_nvmf_host) hosts;
331 : TAILQ_HEAD(, spdk_nvmf_subsystem_listener) listeners;
332 : struct spdk_bit_array *used_listener_ids;
333 :
334 : TAILQ_ENTRY(spdk_nvmf_subsystem) entries;
335 :
336 : nvmf_subsystem_destroy_cb async_destroy_cb;
337 : void *async_destroy_cb_arg;
338 :
339 : char sn[SPDK_NVME_CTRLR_SN_LEN + 1];
340 : char mn[SPDK_NVME_CTRLR_MN_LEN + 1];
341 : char subnqn[SPDK_NVMF_NQN_MAX_LEN + 1];
342 :
343 : /* Array of namespace count per ANA group of size max_nsid indexed anagrpid - 1
344 : * It will be enough for ANA group to use the same size as namespaces.
345 : */
346 : uint32_t *ana_group;
347 : /* Queue of a state change requests */
348 : TAILQ_HEAD(, nvmf_subsystem_state_change_ctx) state_changes;
349 : /* In-band authentication sequence number, protected by ->mutex */
350 : uint32_t auth_seqnum;
351 : };
352 :
353 : static int
354 1 : subsystem_cmp(struct spdk_nvmf_subsystem *subsystem1, struct spdk_nvmf_subsystem *subsystem2)
355 : {
356 1 : return strncmp(subsystem1->subnqn, subsystem2->subnqn, sizeof(subsystem1->subnqn));
357 : }
358 :
359 141 : RB_GENERATE_STATIC(subsystem_tree, spdk_nvmf_subsystem, link, subsystem_cmp);
360 :
361 : int nvmf_poll_group_update_subsystem(struct spdk_nvmf_poll_group *group,
362 : struct spdk_nvmf_subsystem *subsystem);
363 : int nvmf_poll_group_add_subsystem(struct spdk_nvmf_poll_group *group,
364 : struct spdk_nvmf_subsystem *subsystem,
365 : spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg);
366 : void nvmf_poll_group_remove_subsystem(struct spdk_nvmf_poll_group *group,
367 : struct spdk_nvmf_subsystem *subsystem, spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg);
368 : void nvmf_poll_group_pause_subsystem(struct spdk_nvmf_poll_group *group,
369 : struct spdk_nvmf_subsystem *subsystem,
370 : uint32_t nsid,
371 : spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg);
372 : void nvmf_poll_group_resume_subsystem(struct spdk_nvmf_poll_group *group,
373 : struct spdk_nvmf_subsystem *subsystem, spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg);
374 :
375 : void nvmf_update_discovery_log(struct spdk_nvmf_tgt *tgt, const char *hostnqn);
376 : void nvmf_get_discovery_log_page(struct spdk_nvmf_tgt *tgt, const char *hostnqn, struct iovec *iov,
377 : uint32_t iovcnt, uint64_t offset, uint32_t length,
378 : struct spdk_nvme_transport_id *cmd_source_trid);
379 :
380 : void nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr);
381 : int nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req);
382 : int nvmf_ctrlr_process_io_cmd(struct spdk_nvmf_request *req);
383 : bool nvmf_ctrlr_dsm_supported(struct spdk_nvmf_ctrlr *ctrlr);
384 : bool nvmf_ctrlr_write_zeroes_supported(struct spdk_nvmf_ctrlr *ctrlr);
385 : bool nvmf_ctrlr_copy_supported(struct spdk_nvmf_ctrlr *ctrlr);
386 : void nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid);
387 : bool nvmf_ctrlr_use_zcopy(struct spdk_nvmf_request *req);
388 :
389 : void nvmf_bdev_ctrlr_identify_ns(struct spdk_nvmf_ns *ns, struct spdk_nvme_ns_data *nsdata,
390 : bool dif_insert_or_strip);
391 : int nvmf_bdev_ctrlr_read_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
392 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
393 : int nvmf_bdev_ctrlr_write_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
394 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
395 : int nvmf_bdev_ctrlr_compare_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
396 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
397 : int nvmf_bdev_ctrlr_compare_and_write_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
398 : struct spdk_io_channel *ch, struct spdk_nvmf_request *cmp_req, struct spdk_nvmf_request *write_req);
399 : int nvmf_bdev_ctrlr_write_zeroes_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
400 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
401 : int nvmf_bdev_ctrlr_flush_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
402 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
403 : int nvmf_bdev_ctrlr_dsm_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
404 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
405 : int nvmf_bdev_ctrlr_copy_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
406 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
407 : int nvmf_bdev_ctrlr_nvme_passthru_io(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
408 : struct spdk_io_channel *ch, struct spdk_nvmf_request *req);
409 : bool nvmf_bdev_ctrlr_get_dif_ctx(struct spdk_bdev *bdev, struct spdk_nvme_cmd *cmd,
410 : struct spdk_dif_ctx *dif_ctx);
411 : bool nvmf_bdev_zcopy_enabled(struct spdk_bdev *bdev);
412 :
413 : int nvmf_subsystem_add_ctrlr(struct spdk_nvmf_subsystem *subsystem,
414 : struct spdk_nvmf_ctrlr *ctrlr);
415 : void nvmf_subsystem_remove_ctrlr(struct spdk_nvmf_subsystem *subsystem,
416 : struct spdk_nvmf_ctrlr *ctrlr);
417 : void nvmf_subsystem_remove_all_listeners(struct spdk_nvmf_subsystem *subsystem,
418 : bool stop);
419 : struct spdk_nvmf_ctrlr *nvmf_subsystem_get_ctrlr(struct spdk_nvmf_subsystem *subsystem,
420 : uint16_t cntlid);
421 : bool nvmf_subsystem_host_auth_required(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn);
422 : enum nvmf_auth_key_type {
423 : NVMF_AUTH_KEY_HOST,
424 : NVMF_AUTH_KEY_CTRLR,
425 : };
426 : struct spdk_key *nvmf_subsystem_get_dhchap_key(struct spdk_nvmf_subsystem *subsys, const char *nqn,
427 : enum nvmf_auth_key_type type);
428 : struct spdk_nvmf_subsystem_listener *nvmf_subsystem_find_listener(
429 : struct spdk_nvmf_subsystem *subsystem,
430 : const struct spdk_nvme_transport_id *trid);
431 : bool nvmf_subsystem_zone_append_supported(struct spdk_nvmf_subsystem *subsystem);
432 : struct spdk_nvmf_listener *nvmf_transport_find_listener(
433 : struct spdk_nvmf_transport *transport,
434 : const struct spdk_nvme_transport_id *trid);
435 : void nvmf_transport_dump_opts(struct spdk_nvmf_transport *transport, struct spdk_json_write_ctx *w,
436 : bool named);
437 : void nvmf_transport_listen_dump_trid(const struct spdk_nvme_transport_id *trid,
438 : struct spdk_json_write_ctx *w);
439 :
440 : int nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr);
441 : int nvmf_ctrlr_async_event_ana_change_notice(struct spdk_nvmf_ctrlr *ctrlr);
442 : void nvmf_ctrlr_async_event_discovery_log_change_notice(void *ctx);
443 : void nvmf_ctrlr_async_event_reservation_notification(struct spdk_nvmf_ctrlr *ctrlr);
444 :
445 : void nvmf_ns_reservation_request(void *ctx);
446 : void nvmf_ctrlr_reservation_notice_log(struct spdk_nvmf_ctrlr *ctrlr,
447 : struct spdk_nvmf_ns *ns,
448 : enum spdk_nvme_reservation_notification_log_page_type type);
449 :
450 : bool nvmf_ns_is_ptpl_capable(const struct spdk_nvmf_ns *ns);
451 :
452 : static inline struct spdk_nvmf_host *
453 43 : nvmf_ns_find_host(struct spdk_nvmf_ns *ns, const char *hostnqn)
454 : {
455 43 : struct spdk_nvmf_host *host = NULL;
456 :
457 46 : TAILQ_FOREACH(host, &ns->hosts, link) {
458 11 : if (strcmp(hostnqn, host->nqn) == 0) {
459 8 : return host;
460 : }
461 : }
462 :
463 35 : return NULL;
464 : }
465 :
466 : /*
467 : * Abort zero-copy requests that already got the buffer (received zcopy_start cb), but haven't
468 : * started zcopy_end. These requests are kept on the outstanding queue, but are not waiting for a
469 : * completion from the bdev layer, so, when a qpair is being disconnected, we need to kick them to
470 : * force their completion.
471 : */
472 : void nvmf_qpair_abort_pending_zcopy_reqs(struct spdk_nvmf_qpair *qpair);
473 :
474 : /*
475 : * Free aer simply frees the rdma resources for the aer without informing the host.
476 : * This function should be called when deleting a qpair when one wants to make sure
477 : * the qpair is completely empty before freeing the request. The reason we free the
478 : * AER without sending a completion is to prevent the host from sending another AER.
479 : */
480 : void nvmf_qpair_free_aer(struct spdk_nvmf_qpair *qpair);
481 :
482 : int nvmf_ctrlr_abort_request(struct spdk_nvmf_request *req);
483 :
484 : void nvmf_ctrlr_set_fatal_status(struct spdk_nvmf_ctrlr *ctrlr);
485 :
486 : static inline bool
487 48 : nvmf_ctrlr_ns_is_visible(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid)
488 : {
489 48 : return spdk_bit_array_get(ctrlr->visible_ns, nsid - 1);
490 : }
491 :
492 : static inline struct spdk_nvmf_ns *
493 77 : _nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
494 : {
495 : /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */
496 77 : if (spdk_unlikely(nsid - 1 >= subsystem->max_nsid)) {
497 22 : return NULL;
498 : }
499 :
500 55 : return subsystem->ns[nsid - 1];
501 : }
502 :
503 : static inline struct spdk_nvmf_ns *
504 49 : nvmf_ctrlr_get_ns(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid)
505 : {
506 49 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
507 49 : struct spdk_nvmf_ns *ns = _nvmf_subsystem_get_ns(subsystem, nsid);
508 :
509 49 : return ns && nvmf_ctrlr_ns_is_visible(ctrlr, nsid) ? ns : NULL;
510 : }
511 :
512 : static inline bool
513 313 : nvmf_qpair_is_admin_queue(struct spdk_nvmf_qpair *qpair)
514 : {
515 313 : return qpair->qid == 0;
516 : }
517 :
518 : void nvmf_qpair_set_state(struct spdk_nvmf_qpair *qpair, enum spdk_nvmf_qpair_state state);
519 :
520 : int nvmf_qpair_auth_init(struct spdk_nvmf_qpair *qpair);
521 : void nvmf_qpair_auth_destroy(struct spdk_nvmf_qpair *qpair);
522 : void nvmf_qpair_auth_dump(struct spdk_nvmf_qpair *qpair, struct spdk_json_write_ctx *w);
523 :
524 : int nvmf_auth_request_exec(struct spdk_nvmf_request *req);
525 : bool nvmf_auth_is_supported(void);
526 :
527 : static inline bool
528 27 : nvmf_request_is_fabric_connect(struct spdk_nvmf_request *req)
529 : {
530 45 : return req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC &&
531 18 : req->cmd->nvmf_cmd.fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT;
532 : }
533 :
534 : /*
535 : * Tests whether a given string represents a valid NQN.
536 : */
537 : bool nvmf_nqn_is_valid(const char *nqn);
538 :
539 : /*
540 : * Tests whether a given NQN describes a discovery subsystem.
541 : */
542 : bool nvmf_nqn_is_discovery(const char *nqn);
543 :
544 : /**
545 : * Initiates a zcopy start operation
546 : *
547 : * \param bdev The \ref spdk_bdev
548 : * \param desc The \ref spdk_bdev_desc
549 : * \param ch The \ref spdk_io_channel
550 : * \param req The \ref spdk_nvmf_request passed to the bdev for processing
551 : *
552 : * \return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE if the command was completed immediately or
553 : * SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS if the command was submitted and will be
554 : * completed asynchronously. Asynchronous completions are notified through
555 : * spdk_nvmf_request_complete().
556 : */
557 : int nvmf_bdev_ctrlr_zcopy_start(struct spdk_bdev *bdev,
558 : struct spdk_bdev_desc *desc,
559 : struct spdk_io_channel *ch,
560 : struct spdk_nvmf_request *req);
561 :
562 : /**
563 : * Ends a zcopy operation
564 : *
565 : * \param req The NVMe-oF request
566 : * \param commit Flag indicating whether the buffers should be committed
567 : */
568 : void nvmf_bdev_ctrlr_zcopy_end(struct spdk_nvmf_request *req, bool commit);
569 :
570 : /**
571 : * Publishes the mDNS PRR (Pull Registration Request) for the NVMe-oF target.
572 : *
573 : * \param tgt The NVMe-oF target
574 : *
575 : * \return 0 on success, negative errno on failure
576 : */
577 : int nvmf_publish_mdns_prr(struct spdk_nvmf_tgt *tgt);
578 :
579 : /**
580 : * Stops the mDNS PRR (Pull Registration Request) for the NVMe-oF target.
581 : *
582 : * \param tgt The NVMe-oF target
583 : */
584 : void nvmf_tgt_stop_mdns_prr(struct spdk_nvmf_tgt *tgt);
585 :
586 : /**
587 : * Updates the listener list in the mDNS PRR (Pull Registration Request) for the NVMe-oF target.
588 : *
589 : * \param tgt The NVMe-oF target
590 : *
591 : * \return 0 on success, negative errno on failure
592 : */
593 : int nvmf_tgt_update_mdns_prr(struct spdk_nvmf_tgt *tgt);
594 :
595 : static inline struct spdk_nvmf_transport_poll_group *
596 1 : nvmf_get_transport_poll_group(struct spdk_nvmf_poll_group *group,
597 : struct spdk_nvmf_transport *transport)
598 : {
599 : struct spdk_nvmf_transport_poll_group *tgroup;
600 :
601 1 : TAILQ_FOREACH(tgroup, &group->tgroups, link) {
602 0 : if (tgroup->transport == transport) {
603 0 : return tgroup;
604 : }
605 : }
606 :
607 1 : return NULL;
608 : }
609 :
610 : /**
611 : * Generates a new NVMF controller id
612 : *
613 : * \param subsystem The subsystem
614 : *
615 : * \return unique controller id or 0xFFFF when all controller ids are in use
616 : */
617 : uint16_t nvmf_subsystem_gen_cntlid(struct spdk_nvmf_subsystem *subsystem);
618 :
619 : #endif /* __NVMF_INTERNAL_H__ */
|