LCOV - code coverage report
Current view: top level - lib/nvmf - subsystem.c (source / functions) Hit Total Coverage
Test: ut_cov_unit.info Lines: 1097 1832 59.9 %
Date: 2024-08-13 14:04:00 Functions: 88 141 62.4 %

          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             : #include "spdk/stdinc.h"
       8             : 
       9             : #include "nvmf_internal.h"
      10             : #include "transport.h"
      11             : 
      12             : #include "spdk/assert.h"
      13             : #include "spdk/likely.h"
      14             : #include "spdk/string.h"
      15             : #include "spdk/trace.h"
      16             : #include "spdk/nvmf_spec.h"
      17             : #include "spdk/uuid.h"
      18             : #include "spdk/json.h"
      19             : #include "spdk/file.h"
      20             : #include "spdk/bit_array.h"
      21             : #include "spdk/bdev.h"
      22             : 
      23             : #define __SPDK_BDEV_MODULE_ONLY
      24             : #include "spdk/bdev_module.h"
      25             : #include "spdk/log.h"
      26             : #include "spdk_internal/utf.h"
      27             : #include "spdk_internal/usdt.h"
      28             : 
      29             : #define MODEL_NUMBER_DEFAULT "SPDK bdev Controller"
      30             : #define NVMF_SUBSYSTEM_DEFAULT_NAMESPACES 32
      31             : 
      32             : /*
      33             :  * States for parsing valid domains in NQNs according to RFC 1034
      34             :  */
      35             : enum spdk_nvmf_nqn_domain_states {
      36             :         /* First character of a domain must be a letter */
      37             :         SPDK_NVMF_DOMAIN_ACCEPT_LETTER = 0,
      38             : 
      39             :         /* Subsequent characters can be any of letter, digit, or hyphen */
      40             :         SPDK_NVMF_DOMAIN_ACCEPT_LDH = 1,
      41             : 
      42             :         /* A domain label must end with either a letter or digit */
      43             :         SPDK_NVMF_DOMAIN_ACCEPT_ANY = 2
      44             : };
      45             : 
      46             : static int _nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem);
      47             : 
      48             : /* Returns true if is a valid ASCII string as defined by the NVMe spec */
      49             : static bool
      50           3 : nvmf_valid_ascii_string(const void *buf, size_t size)
      51             : {
      52           3 :         const uint8_t *str = buf;
      53             :         size_t i;
      54             : 
      55          35 :         for (i = 0; i < size; i++) {
      56          33 :                 if (str[i] < 0x20 || str[i] > 0x7E) {
      57           1 :                         return false;
      58             :                 }
      59             :         }
      60             : 
      61           2 :         return true;
      62             : }
      63             : 
      64             : bool
      65          46 : nvmf_nqn_is_valid(const char *nqn)
      66             : {
      67             :         size_t len;
      68          46 :         struct spdk_uuid uuid_value;
      69             :         uint32_t i;
      70             :         int bytes_consumed;
      71             :         uint32_t domain_label_length;
      72             :         char *reverse_domain_end;
      73             :         uint32_t reverse_domain_end_index;
      74          46 :         enum spdk_nvmf_nqn_domain_states domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER;
      75             : 
      76             :         /* Check for length requirements */
      77          46 :         len = strlen(nqn);
      78          46 :         if (len > SPDK_NVMF_NQN_MAX_LEN) {
      79           1 :                 SPDK_ERRLOG("Invalid NQN \"%s\": length %zu > max %d\n", nqn, len, SPDK_NVMF_NQN_MAX_LEN);
      80           1 :                 return false;
      81             :         }
      82             : 
      83             :         /* The nqn must be at least as long as SPDK_NVMF_NQN_MIN_LEN to contain the necessary prefix. */
      84          45 :         if (len < SPDK_NVMF_NQN_MIN_LEN) {
      85           2 :                 SPDK_ERRLOG("Invalid NQN \"%s\": length %zu < min %d\n", nqn, len, SPDK_NVMF_NQN_MIN_LEN);
      86           2 :                 return false;
      87             :         }
      88             : 
      89             :         /* Check for discovery controller nqn */
      90          43 :         if (!strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN)) {
      91           2 :                 return true;
      92             :         }
      93             : 
      94             :         /* Check for equality with the generic nqn structure of the form "nqn.2014-08.org.nvmexpress:uuid:11111111-2222-3333-4444-555555555555" */
      95          41 :         if (!strncmp(nqn, SPDK_NVMF_NQN_UUID_PRE, SPDK_NVMF_NQN_UUID_PRE_LEN)) {
      96           6 :                 if (len != SPDK_NVMF_NQN_UUID_PRE_LEN + SPDK_NVMF_UUID_STRING_LEN) {
      97           2 :                         SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not the correct length\n", nqn);
      98           2 :                         return false;
      99             :                 }
     100             : 
     101           4 :                 if (spdk_uuid_parse(&uuid_value, &nqn[SPDK_NVMF_NQN_UUID_PRE_LEN])) {
     102           2 :                         SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not formatted correctly\n", nqn);
     103           2 :                         return false;
     104             :                 }
     105           2 :                 return true;
     106             :         }
     107             : 
     108             :         /* If the nqn does not match the uuid structure, the next several checks validate the form "nqn.yyyy-mm.reverse.domain:user-string" */
     109             : 
     110          35 :         if (strncmp(nqn, "nqn.", 4) != 0) {
     111           0 :                 SPDK_ERRLOG("Invalid NQN \"%s\": NQN must begin with \"nqn.\".\n", nqn);
     112           0 :                 return false;
     113             :         }
     114             : 
     115             :         /* Check for yyyy-mm. */
     116          35 :         if (!(isdigit(nqn[4]) && isdigit(nqn[5]) && isdigit(nqn[6]) && isdigit(nqn[7]) &&
     117          35 :               nqn[8] == '-' && isdigit(nqn[9]) && isdigit(nqn[10]) && nqn[11] == '.')) {
     118           0 :                 SPDK_ERRLOG("Invalid date code in NQN \"%s\"\n", nqn);
     119           0 :                 return false;
     120             :         }
     121             : 
     122          35 :         reverse_domain_end = strchr(nqn, ':');
     123          35 :         if (reverse_domain_end != NULL && (reverse_domain_end_index = reverse_domain_end - nqn) < len - 1) {
     124             :         } else {
     125           1 :                 SPDK_ERRLOG("Invalid NQN \"%s\". NQN must contain user specified name with a ':' as a prefix.\n",
     126             :                             nqn);
     127           1 :                 return false;
     128             :         }
     129             : 
     130             :         /* Check for valid reverse domain */
     131          34 :         domain_label_length = 0;
     132         338 :         for (i = 12; i < reverse_domain_end_index; i++) {
     133         310 :                 if (domain_label_length > SPDK_DOMAIN_LABEL_MAX_LEN) {
     134           1 :                         SPDK_ERRLOG("Invalid domain name in NQN \"%s\". At least one Label is too long.\n", nqn);
     135           1 :                         return false;
     136             :                 }
     137             : 
     138         309 :                 switch (domain_state) {
     139             : 
     140          69 :                 case SPDK_NVMF_DOMAIN_ACCEPT_LETTER: {
     141          69 :                         if (isalpha(nqn[i])) {
     142          65 :                                 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
     143          65 :                                 domain_label_length++;
     144          65 :                                 break;
     145             :                         } else {
     146           4 :                                 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must start with a letter.\n", nqn);
     147           4 :                                 return false;
     148             :                         }
     149             :                 }
     150             : 
     151           4 :                 case SPDK_NVMF_DOMAIN_ACCEPT_LDH: {
     152           4 :                         if (isalpha(nqn[i]) || isdigit(nqn[i])) {
     153           3 :                                 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
     154           3 :                                 domain_label_length++;
     155           3 :                                 break;
     156           1 :                         } else if (nqn[i] == '-') {
     157           1 :                                 if (i == reverse_domain_end_index - 1) {
     158           0 :                                         SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n",
     159             :                                                     nqn);
     160           0 :                                         return false;
     161             :                                 }
     162           1 :                                 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH;
     163           1 :                                 domain_label_length++;
     164           1 :                                 break;
     165           0 :                         } else if (nqn[i] == '.') {
     166           0 :                                 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n",
     167             :                                             nqn);
     168           0 :                                 return false;
     169             :                         } else {
     170           0 :                                 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only [a-z,A-Z,0-9,'-','.'].\n",
     171             :                                             nqn);
     172           0 :                                 return false;
     173             :                         }
     174             :                 }
     175             : 
     176         236 :                 case SPDK_NVMF_DOMAIN_ACCEPT_ANY: {
     177         236 :                         if (isalpha(nqn[i]) || isdigit(nqn[i])) {
     178         197 :                                 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
     179         197 :                                 domain_label_length++;
     180         197 :                                 break;
     181          39 :                         } else if (nqn[i] == '-') {
     182           4 :                                 if (i == reverse_domain_end_index - 1) {
     183           1 :                                         SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n",
     184             :                                                     nqn);
     185           1 :                                         return false;
     186             :                                 }
     187           3 :                                 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH;
     188           3 :                                 domain_label_length++;
     189           3 :                                 break;
     190          35 :                         } else if (nqn[i] == '.') {
     191          35 :                                 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER;
     192          35 :                                 domain_label_length = 0;
     193          35 :                                 break;
     194             :                         } else {
     195           0 :                                 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only [a-z,A-Z,0-9,'-','.'].\n",
     196             :                                             nqn);
     197           0 :                                 return false;
     198             :                         }
     199             :                 }
     200             :                 }
     201             :         }
     202             : 
     203          28 :         i = reverse_domain_end_index + 1;
     204         414 :         while (i < len) {
     205         387 :                 bytes_consumed = utf8_valid(&nqn[i], &nqn[len]);
     206         387 :                 if (bytes_consumed <= 0) {
     207           1 :                         SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only valid utf-8.\n", nqn);
     208           1 :                         return false;
     209             :                 }
     210             : 
     211         386 :                 i += bytes_consumed;
     212             :         }
     213          27 :         return true;
     214             : }
     215             : 
     216             : static void subsystem_state_change_on_pg(struct spdk_io_channel_iter *i);
     217             : 
     218             : struct spdk_nvmf_subsystem *
     219          24 : spdk_nvmf_subsystem_create(struct spdk_nvmf_tgt *tgt,
     220             :                            const char *nqn,
     221             :                            enum spdk_nvmf_subtype type,
     222             :                            uint32_t num_ns)
     223             : {
     224             :         struct spdk_nvmf_subsystem      *subsystem;
     225             :         uint32_t                        sid;
     226             : 
     227          24 :         if (spdk_nvmf_tgt_find_subsystem(tgt, nqn)) {
     228           0 :                 SPDK_ERRLOG("Subsystem NQN '%s' already exists\n", nqn);
     229           0 :                 return NULL;
     230             :         }
     231             : 
     232          24 :         if (!nvmf_nqn_is_valid(nqn)) {
     233          11 :                 SPDK_ERRLOG("Subsystem NQN '%s' is invalid\n", nqn);
     234          11 :                 return NULL;
     235             :         }
     236             : 
     237          13 :         if (type == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT ||
     238             :             type == SPDK_NVMF_SUBTYPE_DISCOVERY) {
     239           1 :                 if (num_ns != 0) {
     240           0 :                         SPDK_ERRLOG("Discovery subsystem cannot have namespaces.\n");
     241           0 :                         return NULL;
     242             :                 }
     243          12 :         } else if (num_ns == 0) {
     244          12 :                 num_ns = NVMF_SUBSYSTEM_DEFAULT_NAMESPACES;
     245             :         }
     246             : 
     247             :         /* Find a free subsystem id (sid) */
     248          13 :         sid = spdk_bit_array_find_first_clear(tgt->subsystem_ids, 0);
     249          13 :         if (sid == UINT32_MAX) {
     250           0 :                 SPDK_ERRLOG("No free subsystem IDs are available for subsystem creation\n");
     251           0 :                 return NULL;
     252             :         }
     253          13 :         subsystem = calloc(1, sizeof(struct spdk_nvmf_subsystem));
     254          13 :         if (subsystem == NULL) {
     255           0 :                 SPDK_ERRLOG("Subsystem memory allocation failed\n");
     256           0 :                 return NULL;
     257             :         }
     258             : 
     259          13 :         subsystem->thread = spdk_get_thread();
     260          13 :         subsystem->state = SPDK_NVMF_SUBSYSTEM_INACTIVE;
     261          13 :         subsystem->tgt = tgt;
     262          13 :         subsystem->id = sid;
     263          13 :         subsystem->subtype = type;
     264          13 :         subsystem->max_nsid = num_ns;
     265          13 :         subsystem->next_cntlid = 0;
     266          13 :         subsystem->min_cntlid = NVMF_MIN_CNTLID;
     267          13 :         subsystem->max_cntlid = NVMF_MAX_CNTLID;
     268          13 :         snprintf(subsystem->subnqn, sizeof(subsystem->subnqn), "%s", nqn);
     269          13 :         pthread_mutex_init(&subsystem->mutex, NULL);
     270          13 :         TAILQ_INIT(&subsystem->listeners);
     271          13 :         TAILQ_INIT(&subsystem->hosts);
     272          13 :         TAILQ_INIT(&subsystem->ctrlrs);
     273          13 :         TAILQ_INIT(&subsystem->state_changes);
     274          13 :         subsystem->used_listener_ids = spdk_bit_array_create(NVMF_MAX_LISTENERS_PER_SUBSYSTEM);
     275          13 :         if (subsystem->used_listener_ids == NULL) {
     276           0 :                 pthread_mutex_destroy(&subsystem->mutex);
     277           0 :                 free(subsystem);
     278           0 :                 SPDK_ERRLOG("Listener id array memory allocation failed\n");
     279           0 :                 return NULL;
     280             :         }
     281             : 
     282          13 :         if (num_ns != 0) {
     283          12 :                 subsystem->ns = calloc(num_ns, sizeof(struct spdk_nvmf_ns *));
     284          12 :                 if (subsystem->ns == NULL) {
     285           0 :                         SPDK_ERRLOG("Namespace memory allocation failed\n");
     286           0 :                         pthread_mutex_destroy(&subsystem->mutex);
     287           0 :                         spdk_bit_array_free(&subsystem->used_listener_ids);
     288           0 :                         free(subsystem);
     289           0 :                         return NULL;
     290             :                 }
     291          12 :                 subsystem->ana_group = calloc(num_ns, sizeof(uint32_t));
     292          12 :                 if (subsystem->ana_group == NULL) {
     293           0 :                         SPDK_ERRLOG("ANA group memory allocation failed\n");
     294           0 :                         pthread_mutex_destroy(&subsystem->mutex);
     295           0 :                         free(subsystem->ns);
     296           0 :                         spdk_bit_array_free(&subsystem->used_listener_ids);
     297           0 :                         free(subsystem);
     298           0 :                         return NULL;
     299             :                 }
     300             :         }
     301             : 
     302          13 :         memset(subsystem->sn, '0', sizeof(subsystem->sn) - 1);
     303          13 :         subsystem->sn[sizeof(subsystem->sn) - 1] = '\0';
     304             : 
     305          13 :         snprintf(subsystem->mn, sizeof(subsystem->mn), "%s",
     306             :                  MODEL_NUMBER_DEFAULT);
     307             : 
     308          13 :         spdk_bit_array_set(tgt->subsystem_ids, sid);
     309          13 :         RB_INSERT(subsystem_tree, &tgt->subsystems, subsystem);
     310             : 
     311             :         SPDK_DTRACE_PROBE1(nvmf_subsystem_create, subsystem->subnqn);
     312             : 
     313          13 :         return subsystem;
     314             : }
     315             : 
     316             : static void
     317           3 : nvmf_host_free(struct spdk_nvmf_host *host)
     318             : {
     319           3 :         spdk_keyring_put_key(host->dhchap_key);
     320           3 :         spdk_keyring_put_key(host->dhchap_ctrlr_key);
     321           3 :         free(host);
     322           3 : }
     323             : 
     324             : /* Must hold subsystem->mutex while calling this function */
     325             : static void
     326           3 : nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *host)
     327             : {
     328           3 :         TAILQ_REMOVE(&subsystem->hosts, host, link);
     329           3 :         nvmf_host_free(host);
     330           3 : }
     331             : 
     332             : static void
     333           7 : _nvmf_subsystem_remove_listener(struct spdk_nvmf_subsystem *subsystem,
     334             :                                 struct spdk_nvmf_subsystem_listener *listener,
     335             :                                 bool stop)
     336             : {
     337             :         struct spdk_nvmf_transport *transport;
     338             :         struct spdk_nvmf_ctrlr *ctrlr;
     339             : 
     340           7 :         if (stop) {
     341           0 :                 transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, listener->trid->trstring);
     342           0 :                 if (transport != NULL) {
     343           0 :                         spdk_nvmf_transport_stop_listen(transport, listener->trid);
     344             :                 }
     345             :         }
     346             : 
     347           7 :         TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
     348           0 :                 if (ctrlr->listener == listener) {
     349           0 :                         ctrlr->listener = NULL;
     350             :                 }
     351             :         }
     352             : 
     353           7 :         TAILQ_REMOVE(&subsystem->listeners, listener, link);
     354           7 :         if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) {
     355           0 :                 nvmf_tgt_update_mdns_prr(listener->subsystem->tgt);
     356             :         }
     357           7 :         nvmf_update_discovery_log(listener->subsystem->tgt, NULL);
     358           7 :         free(listener->ana_state);
     359           7 :         spdk_bit_array_clear(subsystem->used_listener_ids, listener->id);
     360           7 :         free(listener->opts.sock_impl);
     361           7 :         free(listener);
     362           7 : }
     363             : 
     364             : static void
     365           0 : _nvmf_subsystem_destroy_msg(void *cb_arg)
     366             : {
     367           0 :         struct spdk_nvmf_subsystem *subsystem = cb_arg;
     368             : 
     369           0 :         _nvmf_subsystem_destroy(subsystem);
     370           0 : }
     371             : 
     372             : static int
     373          13 : _nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem)
     374             : {
     375             :         struct nvmf_subsystem_state_change_ctx *ctx;
     376             :         struct spdk_nvmf_ns             *ns;
     377          13 :         nvmf_subsystem_destroy_cb       async_destroy_cb = NULL;
     378          13 :         void                            *async_destroy_cb_arg = NULL;
     379             :         int                             rc;
     380             : 
     381          13 :         if (!TAILQ_EMPTY(&subsystem->ctrlrs)) {
     382           0 :                 SPDK_DEBUGLOG(nvmf, "subsystem %p %s has active controllers\n", subsystem, subsystem->subnqn);
     383           0 :                 subsystem->async_destroy = true;
     384           0 :                 rc = spdk_thread_send_msg(subsystem->thread, _nvmf_subsystem_destroy_msg, subsystem);
     385           0 :                 if (rc) {
     386           0 :                         SPDK_ERRLOG("Failed to send thread msg, rc %d\n", rc);
     387           0 :                         assert(0);
     388             :                         return rc;
     389             :                 }
     390           0 :                 return -EINPROGRESS;
     391             :         }
     392             : 
     393          13 :         ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
     394          13 :         while (ns != NULL) {
     395           0 :                 struct spdk_nvmf_ns *next_ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns);
     396             : 
     397           0 :                 spdk_nvmf_subsystem_remove_ns(subsystem, ns->opts.nsid);
     398           0 :                 ns = next_ns;
     399             :         }
     400             : 
     401          13 :         while ((ctx = TAILQ_FIRST(&subsystem->state_changes))) {
     402           0 :                 SPDK_WARNLOG("subsystem %s has pending state change requests\n", subsystem->subnqn);
     403           0 :                 TAILQ_REMOVE(&subsystem->state_changes, ctx, link);
     404           0 :                 if (ctx->cb_fn != NULL) {
     405           0 :                         ctx->cb_fn(subsystem, ctx->cb_arg, -ECANCELED);
     406             :                 }
     407           0 :                 free(ctx);
     408             :         }
     409             : 
     410          13 :         free(subsystem->ns);
     411          13 :         free(subsystem->ana_group);
     412             : 
     413          13 :         RB_REMOVE(subsystem_tree, &subsystem->tgt->subsystems, subsystem);
     414          13 :         assert(spdk_bit_array_get(subsystem->tgt->subsystem_ids, subsystem->id) == true);
     415          13 :         spdk_bit_array_clear(subsystem->tgt->subsystem_ids, subsystem->id);
     416             : 
     417          13 :         pthread_mutex_destroy(&subsystem->mutex);
     418             : 
     419          13 :         spdk_bit_array_free(&subsystem->used_listener_ids);
     420             : 
     421          13 :         if (subsystem->async_destroy) {
     422           0 :                 async_destroy_cb = subsystem->async_destroy_cb;
     423           0 :                 async_destroy_cb_arg = subsystem->async_destroy_cb_arg;
     424             :         }
     425             : 
     426          13 :         free(subsystem);
     427             : 
     428          13 :         if (async_destroy_cb) {
     429           0 :                 async_destroy_cb(async_destroy_cb_arg);
     430             :         }
     431             : 
     432          13 :         return 0;
     433             : }
     434             : 
     435             : static struct spdk_nvmf_ns *
     436           0 : _nvmf_subsystem_get_first_zoned_ns(struct spdk_nvmf_subsystem *subsystem)
     437             : {
     438           0 :         struct spdk_nvmf_ns *ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
     439           0 :         while (ns != NULL) {
     440           0 :                 if (ns->csi == SPDK_NVME_CSI_ZNS) {
     441           0 :                         return ns;
     442             :                 }
     443           0 :                 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns);
     444             :         }
     445           0 :         return NULL;
     446             : }
     447             : 
     448             : int
     449          13 : spdk_nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem, nvmf_subsystem_destroy_cb cpl_cb,
     450             :                             void *cpl_cb_arg)
     451             : {
     452             :         struct spdk_nvmf_host *host, *host_tmp;
     453             :         struct spdk_nvmf_transport *transport;
     454             : 
     455          13 :         if (!subsystem) {
     456           0 :                 return -EINVAL;
     457             :         }
     458             : 
     459             :         SPDK_DTRACE_PROBE1(nvmf_subsystem_destroy, subsystem->subnqn);
     460             : 
     461          13 :         assert(spdk_get_thread() == subsystem->thread);
     462             : 
     463          13 :         if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
     464           0 :                 SPDK_ERRLOG("Subsystem can only be destroyed in inactive state, %s state %d\n",
     465             :                             subsystem->subnqn, subsystem->state);
     466           0 :                 return -EAGAIN;
     467             :         }
     468          13 :         if (subsystem->destroying) {
     469           0 :                 SPDK_ERRLOG("Subsystem destruction is already started\n");
     470           0 :                 assert(0);
     471             :                 return -EALREADY;
     472             :         }
     473             : 
     474          13 :         subsystem->destroying = true;
     475             : 
     476          13 :         SPDK_DEBUGLOG(nvmf, "subsystem is %p %s\n", subsystem, subsystem->subnqn);
     477             : 
     478          13 :         nvmf_subsystem_remove_all_listeners(subsystem, false);
     479             : 
     480          13 :         pthread_mutex_lock(&subsystem->mutex);
     481             : 
     482          13 :         TAILQ_FOREACH_SAFE(host, &subsystem->hosts, link, host_tmp) {
     483           0 :                 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
     484           0 :                      transport = spdk_nvmf_transport_get_next(transport)) {
     485           0 :                         if (transport->ops->subsystem_remove_host) {
     486           0 :                                 transport->ops->subsystem_remove_host(transport, subsystem, host->nqn);
     487             :                         }
     488             :                 }
     489           0 :                 nvmf_subsystem_remove_host(subsystem, host);
     490             :         }
     491             : 
     492          13 :         pthread_mutex_unlock(&subsystem->mutex);
     493             : 
     494          13 :         subsystem->async_destroy_cb = cpl_cb;
     495          13 :         subsystem->async_destroy_cb_arg = cpl_cb_arg;
     496             : 
     497          13 :         return _nvmf_subsystem_destroy(subsystem);
     498             : }
     499             : 
     500             : /* we have to use the typedef in the function declaration to appease astyle. */
     501             : typedef enum spdk_nvmf_subsystem_state spdk_nvmf_subsystem_state_t;
     502             : 
     503             : static spdk_nvmf_subsystem_state_t
     504           9 : nvmf_subsystem_get_intermediate_state(enum spdk_nvmf_subsystem_state current_state,
     505             :                                       enum spdk_nvmf_subsystem_state requested_state)
     506             : {
     507           9 :         switch (requested_state) {
     508           2 :         case SPDK_NVMF_SUBSYSTEM_INACTIVE:
     509           2 :                 return SPDK_NVMF_SUBSYSTEM_DEACTIVATING;
     510           4 :         case SPDK_NVMF_SUBSYSTEM_ACTIVE:
     511           4 :                 if (current_state == SPDK_NVMF_SUBSYSTEM_PAUSED) {
     512           2 :                         return SPDK_NVMF_SUBSYSTEM_RESUMING;
     513             :                 } else {
     514           2 :                         return SPDK_NVMF_SUBSYSTEM_ACTIVATING;
     515             :                 }
     516           3 :         case SPDK_NVMF_SUBSYSTEM_PAUSED:
     517           3 :                 return SPDK_NVMF_SUBSYSTEM_PAUSING;
     518           0 :         default:
     519           0 :                 assert(false);
     520             :                 return SPDK_NVMF_SUBSYSTEM_NUM_STATES;
     521             :         }
     522             : }
     523             : 
     524             : static int
     525          18 : nvmf_subsystem_set_state(struct spdk_nvmf_subsystem *subsystem,
     526             :                          enum spdk_nvmf_subsystem_state state)
     527             : {
     528          18 :         enum spdk_nvmf_subsystem_state actual_old_state, expected_old_state;
     529             :         bool exchanged;
     530             : 
     531          18 :         switch (state) {
     532           2 :         case SPDK_NVMF_SUBSYSTEM_INACTIVE:
     533           2 :                 expected_old_state = SPDK_NVMF_SUBSYSTEM_DEACTIVATING;
     534           2 :                 break;
     535           2 :         case SPDK_NVMF_SUBSYSTEM_ACTIVATING:
     536           2 :                 expected_old_state = SPDK_NVMF_SUBSYSTEM_INACTIVE;
     537           2 :                 break;
     538           4 :         case SPDK_NVMF_SUBSYSTEM_ACTIVE:
     539           4 :                 expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVATING;
     540           4 :                 break;
     541           3 :         case SPDK_NVMF_SUBSYSTEM_PAUSING:
     542           3 :                 expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE;
     543           3 :                 break;
     544           3 :         case SPDK_NVMF_SUBSYSTEM_PAUSED:
     545           3 :                 expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSING;
     546           3 :                 break;
     547           2 :         case SPDK_NVMF_SUBSYSTEM_RESUMING:
     548           2 :                 expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED;
     549           2 :                 break;
     550           2 :         case SPDK_NVMF_SUBSYSTEM_DEACTIVATING:
     551           2 :                 expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE;
     552           2 :                 break;
     553           0 :         default:
     554           0 :                 assert(false);
     555             :                 return -1;
     556             :         }
     557             : 
     558          18 :         actual_old_state = expected_old_state;
     559          18 :         exchanged = __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false,
     560             :                                                 __ATOMIC_RELAXED, __ATOMIC_RELAXED);
     561          18 :         if (spdk_unlikely(exchanged == false)) {
     562           3 :                 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING &&
     563             :                     state == SPDK_NVMF_SUBSYSTEM_ACTIVE) {
     564           2 :                         expected_old_state = SPDK_NVMF_SUBSYSTEM_RESUMING;
     565             :                 }
     566             :                 /* This is for the case when activating the subsystem fails. */
     567           3 :                 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_ACTIVATING &&
     568             :                     state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING) {
     569           0 :                         expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVATING;
     570             :                 }
     571             :                 /* This is for the case when resuming the subsystem fails. */
     572           3 :                 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING &&
     573             :                     state == SPDK_NVMF_SUBSYSTEM_PAUSING) {
     574           0 :                         expected_old_state = SPDK_NVMF_SUBSYSTEM_RESUMING;
     575             :                 }
     576             :                 /* This is for the case when stopping paused subsystem */
     577           3 :                 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_PAUSED &&
     578             :                     state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING) {
     579           1 :                         expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED;
     580             :                 }
     581           3 :                 actual_old_state = expected_old_state;
     582           3 :                 __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false,
     583             :                                             __ATOMIC_RELAXED, __ATOMIC_RELAXED);
     584             :         }
     585          18 :         assert(actual_old_state == expected_old_state);
     586          18 :         return actual_old_state - expected_old_state;
     587             : }
     588             : 
     589             : static void nvmf_subsystem_do_state_change(struct nvmf_subsystem_state_change_ctx *ctx);
     590             : 
     591             : static void
     592          10 : _nvmf_subsystem_state_change_complete(void *_ctx)
     593             : {
     594          10 :         struct nvmf_subsystem_state_change_ctx *next, *ctx = _ctx;
     595          10 :         struct spdk_nvmf_subsystem *subsystem = ctx->subsystem;
     596             : 
     597          10 :         pthread_mutex_lock(&subsystem->mutex);
     598          10 :         assert(TAILQ_FIRST(&subsystem->state_changes) == ctx);
     599          10 :         TAILQ_REMOVE(&subsystem->state_changes, ctx, link);
     600          10 :         next = TAILQ_FIRST(&subsystem->state_changes);
     601          10 :         pthread_mutex_unlock(&subsystem->mutex);
     602             : 
     603          10 :         if (ctx->cb_fn != NULL) {
     604           3 :                 ctx->cb_fn(subsystem, ctx->cb_arg, ctx->status);
     605             :         }
     606          10 :         free(ctx);
     607             : 
     608          10 :         if (next != NULL) {
     609           1 :                 nvmf_subsystem_do_state_change(next);
     610             :         }
     611          10 : }
     612             : 
     613             : static void
     614          10 : nvmf_subsystem_state_change_complete(struct nvmf_subsystem_state_change_ctx *ctx, int status)
     615             : {
     616          10 :         ctx->status = status;
     617          10 :         spdk_thread_exec_msg(ctx->thread, _nvmf_subsystem_state_change_complete, ctx);
     618          10 : }
     619             : 
     620             : static void
     621           0 : subsystem_state_change_revert_done(struct spdk_io_channel_iter *i, int status)
     622             : {
     623           0 :         struct nvmf_subsystem_state_change_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
     624             : 
     625             :         /* Nothing to be done here if the state setting fails, we are just screwed. */
     626           0 :         if (nvmf_subsystem_set_state(ctx->subsystem, ctx->requested_state)) {
     627           0 :                 SPDK_ERRLOG("Unable to revert the subsystem state after operation failure.\n");
     628             :         }
     629             : 
     630             :         /* return a failure here. This function only exists in an error path. */
     631           0 :         nvmf_subsystem_state_change_complete(ctx, -1);
     632           0 : }
     633             : 
     634             : static void
     635           9 : subsystem_state_change_done(struct spdk_io_channel_iter *i, int status)
     636             : {
     637           9 :         struct nvmf_subsystem_state_change_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
     638             :         enum spdk_nvmf_subsystem_state intermediate_state;
     639             : 
     640             :         SPDK_DTRACE_PROBE4(nvmf_subsystem_change_state_done, ctx->subsystem->subnqn,
     641             :                            ctx->requested_state, ctx->original_state, status);
     642             : 
     643           9 :         if (status == 0) {
     644           9 :                 status = nvmf_subsystem_set_state(ctx->subsystem, ctx->requested_state);
     645           9 :                 if (status) {
     646           0 :                         status = -1;
     647             :                 }
     648             :         }
     649             : 
     650           9 :         if (status) {
     651           0 :                 intermediate_state = nvmf_subsystem_get_intermediate_state(ctx->requested_state,
     652             :                                      ctx->original_state);
     653           0 :                 assert(intermediate_state != SPDK_NVMF_SUBSYSTEM_NUM_STATES);
     654             : 
     655           0 :                 if (nvmf_subsystem_set_state(ctx->subsystem, intermediate_state)) {
     656           0 :                         goto out;
     657             :                 }
     658           0 :                 ctx->requested_state = ctx->original_state;
     659           0 :                 spdk_for_each_channel(ctx->subsystem->tgt,
     660             :                                       subsystem_state_change_on_pg,
     661             :                                       ctx,
     662             :                                       subsystem_state_change_revert_done);
     663           0 :                 return;
     664             :         }
     665             : 
     666           9 : out:
     667           9 :         nvmf_subsystem_state_change_complete(ctx, status);
     668             : }
     669             : 
     670             : static void
     671           0 : subsystem_state_change_continue(void *ctx, int status)
     672             : {
     673           0 :         struct spdk_io_channel_iter *i = ctx;
     674             :         struct nvmf_subsystem_state_change_ctx *_ctx __attribute__((unused));
     675             : 
     676           0 :         _ctx = spdk_io_channel_iter_get_ctx(i);
     677             :         SPDK_DTRACE_PROBE3(nvmf_pg_change_state_done, _ctx->subsystem->subnqn,
     678             :                            _ctx->requested_state, spdk_thread_get_id(spdk_get_thread()));
     679             : 
     680           0 :         spdk_for_each_channel_continue(i, status);
     681           0 : }
     682             : 
     683             : static void
     684           0 : subsystem_state_change_on_pg(struct spdk_io_channel_iter *i)
     685             : {
     686             :         struct nvmf_subsystem_state_change_ctx *ctx;
     687             :         struct spdk_io_channel *ch;
     688             :         struct spdk_nvmf_poll_group *group;
     689             : 
     690           0 :         ctx = spdk_io_channel_iter_get_ctx(i);
     691           0 :         ch = spdk_io_channel_iter_get_channel(i);
     692           0 :         group = spdk_io_channel_get_ctx(ch);
     693             : 
     694             :         SPDK_DTRACE_PROBE3(nvmf_pg_change_state, ctx->subsystem->subnqn,
     695             :                            ctx->requested_state, spdk_thread_get_id(spdk_get_thread()));
     696           0 :         switch (ctx->requested_state) {
     697           0 :         case SPDK_NVMF_SUBSYSTEM_INACTIVE:
     698           0 :                 nvmf_poll_group_remove_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
     699           0 :                 break;
     700           0 :         case SPDK_NVMF_SUBSYSTEM_ACTIVE:
     701           0 :                 if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_ACTIVATING) {
     702           0 :                         nvmf_poll_group_add_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
     703           0 :                 } else if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_RESUMING) {
     704           0 :                         nvmf_poll_group_resume_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
     705             :                 }
     706           0 :                 break;
     707           0 :         case SPDK_NVMF_SUBSYSTEM_PAUSED:
     708           0 :                 nvmf_poll_group_pause_subsystem(group, ctx->subsystem, ctx->nsid, subsystem_state_change_continue,
     709             :                                                 i);
     710           0 :                 break;
     711           0 :         default:
     712           0 :                 assert(false);
     713             :                 break;
     714             :         }
     715           0 : }
     716             : 
     717             : static void
     718          10 : nvmf_subsystem_do_state_change(struct nvmf_subsystem_state_change_ctx *ctx)
     719             : {
     720          10 :         struct spdk_nvmf_subsystem *subsystem = ctx->subsystem;
     721             :         enum spdk_nvmf_subsystem_state intermediate_state;
     722             :         int rc;
     723             : 
     724             :         SPDK_DTRACE_PROBE3(nvmf_subsystem_change_state, subsystem->subnqn,
     725             :                            ctx->requested_state, subsystem->state);
     726             : 
     727             :         /* If we are already in the requested state, just call the callback immediately. */
     728          10 :         if (subsystem->state == ctx->requested_state) {
     729           1 :                 nvmf_subsystem_state_change_complete(ctx, 0);
     730           1 :                 return;
     731             :         }
     732             : 
     733           9 :         intermediate_state = nvmf_subsystem_get_intermediate_state(subsystem->state,
     734             :                              ctx->requested_state);
     735           9 :         assert(intermediate_state != SPDK_NVMF_SUBSYSTEM_NUM_STATES);
     736             : 
     737           9 :         ctx->original_state = subsystem->state;
     738           9 :         rc = nvmf_subsystem_set_state(subsystem, intermediate_state);
     739           9 :         if (rc) {
     740           0 :                 nvmf_subsystem_state_change_complete(ctx, -1);
     741           0 :                 return;
     742             :         }
     743             : 
     744           9 :         spdk_for_each_channel(subsystem->tgt,
     745             :                               subsystem_state_change_on_pg,
     746             :                               ctx,
     747             :                               subsystem_state_change_done);
     748             : }
     749             : 
     750             : 
     751             : static int
     752          10 : nvmf_subsystem_state_change(struct spdk_nvmf_subsystem *subsystem,
     753             :                             uint32_t nsid,
     754             :                             enum spdk_nvmf_subsystem_state requested_state,
     755             :                             spdk_nvmf_subsystem_state_change_done cb_fn,
     756             :                             void *cb_arg)
     757             : {
     758             :         struct nvmf_subsystem_state_change_ctx *ctx;
     759             :         struct spdk_thread *thread;
     760             : 
     761          10 :         thread = spdk_get_thread();
     762          10 :         if (thread == NULL) {
     763           0 :                 return -EINVAL;
     764             :         }
     765             : 
     766          10 :         ctx = calloc(1, sizeof(*ctx));
     767          10 :         if (!ctx) {
     768           0 :                 return -ENOMEM;
     769             :         }
     770             : 
     771          10 :         ctx->subsystem = subsystem;
     772          10 :         ctx->nsid = nsid;
     773          10 :         ctx->requested_state = requested_state;
     774          10 :         ctx->cb_fn = cb_fn;
     775          10 :         ctx->cb_arg = cb_arg;
     776          10 :         ctx->thread = thread;
     777             : 
     778          10 :         pthread_mutex_lock(&subsystem->mutex);
     779          10 :         TAILQ_INSERT_TAIL(&subsystem->state_changes, ctx, link);
     780          10 :         if (ctx != TAILQ_FIRST(&subsystem->state_changes)) {
     781           1 :                 pthread_mutex_unlock(&subsystem->mutex);
     782           1 :                 return 0;
     783             :         }
     784           9 :         pthread_mutex_unlock(&subsystem->mutex);
     785             : 
     786           9 :         nvmf_subsystem_do_state_change(ctx);
     787             : 
     788           9 :         return 0;
     789             : }
     790             : 
     791             : int
     792           2 : spdk_nvmf_subsystem_start(struct spdk_nvmf_subsystem *subsystem,
     793             :                           spdk_nvmf_subsystem_state_change_done cb_fn,
     794             :                           void *cb_arg)
     795             : {
     796           2 :         return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg);
     797             : }
     798             : 
     799             : int
     800           3 : spdk_nvmf_subsystem_stop(struct spdk_nvmf_subsystem *subsystem,
     801             :                          spdk_nvmf_subsystem_state_change_done cb_fn,
     802             :                          void *cb_arg)
     803             : {
     804           3 :         return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_INACTIVE, cb_fn, cb_arg);
     805             : }
     806             : 
     807             : int
     808           3 : spdk_nvmf_subsystem_pause(struct spdk_nvmf_subsystem *subsystem,
     809             :                           uint32_t nsid,
     810             :                           spdk_nvmf_subsystem_state_change_done cb_fn,
     811             :                           void *cb_arg)
     812             : {
     813           3 :         return nvmf_subsystem_state_change(subsystem, nsid, SPDK_NVMF_SUBSYSTEM_PAUSED, cb_fn, cb_arg);
     814             : }
     815             : 
     816             : int
     817           2 : spdk_nvmf_subsystem_resume(struct spdk_nvmf_subsystem *subsystem,
     818             :                            spdk_nvmf_subsystem_state_change_done cb_fn,
     819             :                            void *cb_arg)
     820             : {
     821           2 :         return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg);
     822             : }
     823             : 
     824             : struct spdk_nvmf_subsystem *
     825          33 : spdk_nvmf_subsystem_get_first(struct spdk_nvmf_tgt *tgt)
     826             : {
     827          33 :         return RB_MIN(subsystem_tree, &tgt->subsystems);
     828             : }
     829             : 
     830             : struct spdk_nvmf_subsystem *
     831          32 : spdk_nvmf_subsystem_get_next(struct spdk_nvmf_subsystem *subsystem)
     832             : {
     833          32 :         if (!subsystem) {
     834           0 :                 return NULL;
     835             :         }
     836             : 
     837          32 :         return RB_NEXT(subsystem_tree, &tgt->subsystems, subsystem);
     838             : }
     839             : 
     840             : static int
     841           2 : nvmf_ns_add_host(struct spdk_nvmf_ns *ns, const char *hostnqn)
     842             : {
     843             :         struct spdk_nvmf_host *host;
     844             : 
     845           2 :         host = calloc(1, sizeof(*host));
     846           2 :         if (!host) {
     847           0 :                 return -ENOMEM;
     848             :         }
     849           2 :         snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn);
     850           2 :         TAILQ_INSERT_HEAD(&ns->hosts, host, link);
     851           2 :         return 0;
     852             : }
     853             : 
     854             : static void
     855           2 : nvmf_ns_remove_host(struct spdk_nvmf_ns *ns, struct spdk_nvmf_host *host)
     856             : {
     857           2 :         TAILQ_REMOVE(&ns->hosts, host, link);
     858           2 :         free(host);
     859           2 : }
     860             : 
     861             : static void
     862           3 : _async_event_ns_notice(void *_ctrlr)
     863             : {
     864           3 :         struct spdk_nvmf_ctrlr *ctrlr = _ctrlr;
     865             : 
     866           3 :         nvmf_ctrlr_async_event_ns_notice(ctrlr);
     867           3 : }
     868             : 
     869             : static void
     870           3 : send_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr)
     871             : {
     872           3 :         spdk_thread_send_msg(ctrlr->thread, _async_event_ns_notice, ctrlr);
     873           3 : }
     874             : 
     875             : static int
     876          14 : nvmf_ns_visible(struct spdk_nvmf_subsystem *subsystem,
     877             :                 uint32_t nsid,
     878             :                 const char *hostnqn,
     879             :                 bool visible)
     880             : {
     881             :         struct spdk_nvmf_ns *ns;
     882             :         struct spdk_nvmf_ctrlr *ctrlr;
     883             :         struct spdk_nvmf_host *host;
     884             :         int rc;
     885             : 
     886          14 :         if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
     887           0 :               subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
     888           0 :                 assert(false);
     889             :                 return -1;
     890             :         }
     891             : 
     892          14 :         if (hostnqn == NULL || !nvmf_nqn_is_valid(hostnqn)) {
     893           3 :                 return -EINVAL;
     894             :         }
     895             : 
     896          11 :         if (nsid == 0 || nsid > subsystem->max_nsid) {
     897           2 :                 return -EINVAL;
     898             :         }
     899             : 
     900           9 :         ns = subsystem->ns[nsid - 1];
     901           9 :         if (!ns) {
     902           2 :                 return -ENOENT;
     903             :         }
     904             : 
     905           7 :         if (ns->always_visible) {
     906             :                 /* No individual host control */
     907           2 :                 return -EPERM;
     908             :         }
     909             : 
     910             :         /* Save host info to use for any future controllers. */
     911           5 :         host = nvmf_ns_find_host(ns, hostnqn);
     912           5 :         if (visible && host == NULL) {
     913           2 :                 rc = nvmf_ns_add_host(ns, hostnqn);
     914           2 :                 if (rc) {
     915           0 :                         return rc;
     916             :                 }
     917           3 :         } else if (!visible && host != NULL) {
     918           1 :                 nvmf_ns_remove_host(ns, host);
     919             :         }
     920             : 
     921             :         /* Also apply to existing controllers. */
     922          15 :         TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
     923          15 :                 if (strcmp(hostnqn, ctrlr->hostnqn) ||
     924           5 :                     spdk_bit_array_get(ctrlr->visible_ns, nsid - 1) == visible) {
     925           7 :                         continue;
     926             :                 }
     927           3 :                 if (visible) {
     928           2 :                         spdk_bit_array_set(ctrlr->visible_ns, nsid - 1);
     929             :                 } else {
     930           1 :                         spdk_bit_array_clear(ctrlr->visible_ns, nsid - 1);
     931             :                 }
     932           3 :                 send_async_event_ns_notice(ctrlr);
     933           3 :                 nvmf_ctrlr_ns_changed(ctrlr, nsid);
     934             :         }
     935             : 
     936           5 :         return 0;
     937             : }
     938             : 
     939             : int
     940           8 : spdk_nvmf_ns_add_host(struct spdk_nvmf_subsystem *subsystem,
     941             :                       uint32_t nsid,
     942             :                       const char *hostnqn,
     943             :                       uint32_t flags)
     944             : {
     945             :         SPDK_DTRACE_PROBE4(spdk_nvmf_ns_add_host,
     946             :                            subsystem->subnqn,
     947             :                            nsid,
     948             :                            hostnqn,
     949             :                            flags);
     950           8 :         return nvmf_ns_visible(subsystem, nsid, hostnqn, true);
     951             : }
     952             : 
     953             : int
     954           6 : spdk_nvmf_ns_remove_host(struct spdk_nvmf_subsystem *subsystem,
     955             :                          uint32_t nsid,
     956             :                          const char *hostnqn,
     957             :                          uint32_t flags)
     958             : {
     959             :         SPDK_DTRACE_PROBE4(spdk_nvmf_ns_remove_host,
     960             :                            subsystem->subnqn,
     961             :                            nsid,
     962             :                            hostnqn,
     963             :                            flags);
     964           6 :         return nvmf_ns_visible(subsystem, nsid, hostnqn, false);
     965             : }
     966             : 
     967             : /* Must hold subsystem->mutex while calling this function */
     968             : static struct spdk_nvmf_host *
     969          14 : nvmf_subsystem_find_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
     970             : {
     971          14 :         struct spdk_nvmf_host *host = NULL;
     972             : 
     973          14 :         TAILQ_FOREACH(host, &subsystem->hosts, link) {
     974           9 :                 if (strcmp(hostnqn, host->nqn) == 0) {
     975           9 :                         return host;
     976             :                 }
     977             :         }
     978             : 
     979           5 :         return NULL;
     980             : }
     981             : 
     982             : int
     983           4 : spdk_nvmf_subsystem_add_host_ext(struct spdk_nvmf_subsystem *subsystem,
     984             :                                  const char *hostnqn, struct spdk_nvmf_host_opts *opts)
     985             : {
     986             :         struct spdk_nvmf_host *host;
     987             :         struct spdk_nvmf_transport *transport;
     988             :         struct spdk_key *key;
     989             :         int rc;
     990             : 
     991           4 :         if (!nvmf_nqn_is_valid(hostnqn)) {
     992           0 :                 return -EINVAL;
     993             :         }
     994             : 
     995           4 :         pthread_mutex_lock(&subsystem->mutex);
     996             : 
     997           4 :         if (nvmf_subsystem_find_host(subsystem, hostnqn)) {
     998             :                 /* This subsystem already allows the specified host. */
     999           1 :                 pthread_mutex_unlock(&subsystem->mutex);
    1000           1 :                 return -EINVAL;
    1001             :         }
    1002             : 
    1003           3 :         host = calloc(1, sizeof(*host));
    1004           3 :         if (!host) {
    1005           0 :                 pthread_mutex_unlock(&subsystem->mutex);
    1006           0 :                 return -ENOMEM;
    1007             :         }
    1008             : 
    1009           3 :         key = SPDK_GET_FIELD(opts, dhchap_key, NULL);
    1010           3 :         if (key != NULL) {
    1011           0 :                 if (!nvmf_auth_is_supported()) {
    1012           0 :                         SPDK_ERRLOG("NVMe in-band authentication is unsupported\n");
    1013           0 :                         pthread_mutex_unlock(&subsystem->mutex);
    1014           0 :                         nvmf_host_free(host);
    1015           0 :                         return -EINVAL;
    1016             :                 }
    1017           0 :                 host->dhchap_key = spdk_key_dup(key);
    1018           0 :                 if (host->dhchap_key == NULL) {
    1019           0 :                         pthread_mutex_unlock(&subsystem->mutex);
    1020           0 :                         nvmf_host_free(host);
    1021           0 :                         return -EINVAL;
    1022             :                 }
    1023           0 :                 key = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL);
    1024           0 :                 if (key != NULL) {
    1025           0 :                         host->dhchap_ctrlr_key = spdk_key_dup(key);
    1026           0 :                         if (host->dhchap_ctrlr_key == NULL) {
    1027           0 :                                 pthread_mutex_unlock(&subsystem->mutex);
    1028           0 :                                 nvmf_host_free(host);
    1029           0 :                                 return -EINVAL;
    1030             :                         }
    1031             :                 }
    1032           3 :         } else if (SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL) != NULL) {
    1033           0 :                 SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n");
    1034           0 :                 pthread_mutex_unlock(&subsystem->mutex);
    1035           0 :                 nvmf_host_free(host);
    1036           0 :                 return -EINVAL;
    1037             :         }
    1038             : 
    1039           3 :         snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn);
    1040             : 
    1041             :         SPDK_DTRACE_PROBE2(nvmf_subsystem_add_host, subsystem->subnqn, host->nqn);
    1042             : 
    1043           3 :         TAILQ_INSERT_HEAD(&subsystem->hosts, host, link);
    1044             : 
    1045           3 :         if (!TAILQ_EMPTY(&subsystem->listeners)) {
    1046           0 :                 nvmf_update_discovery_log(subsystem->tgt, hostnqn);
    1047             :         }
    1048             : 
    1049           3 :         for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
    1050           0 :              transport = spdk_nvmf_transport_get_next(transport)) {
    1051           1 :                 if (transport->ops->subsystem_add_host) {
    1052           1 :                         rc = transport->ops->subsystem_add_host(transport, subsystem, hostnqn,
    1053           1 :                                                                 SPDK_GET_FIELD(opts, params, NULL));
    1054           1 :                         if (rc) {
    1055           1 :                                 SPDK_ERRLOG("Unable to add host to %s transport\n", transport->ops->name);
    1056             :                                 /* Remove this host from all transports we've managed to add it to. */
    1057           1 :                                 pthread_mutex_unlock(&subsystem->mutex);
    1058           1 :                                 spdk_nvmf_subsystem_remove_host(subsystem, hostnqn);
    1059           1 :                                 return rc;
    1060             :                         }
    1061             :                 }
    1062             :         }
    1063             : 
    1064           2 :         pthread_mutex_unlock(&subsystem->mutex);
    1065             : 
    1066           2 :         return 0;
    1067             : }
    1068             : 
    1069             : int
    1070           4 : spdk_nvmf_subsystem_add_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn,
    1071             :                              const struct spdk_json_val *params)
    1072             : {
    1073           4 :         struct spdk_nvmf_host_opts opts = {};
    1074             : 
    1075           4 :         opts.size = SPDK_SIZEOF(&opts, params);
    1076           4 :         opts.params = params;
    1077             : 
    1078           4 :         return spdk_nvmf_subsystem_add_host_ext(subsystem, hostnqn, &opts);
    1079             : }
    1080             : 
    1081             : int
    1082           4 : spdk_nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
    1083             : {
    1084             :         struct spdk_nvmf_host *host;
    1085             :         struct spdk_nvmf_transport *transport;
    1086             : 
    1087           4 :         pthread_mutex_lock(&subsystem->mutex);
    1088             : 
    1089           4 :         host = nvmf_subsystem_find_host(subsystem, hostnqn);
    1090           4 :         if (host == NULL) {
    1091           1 :                 pthread_mutex_unlock(&subsystem->mutex);
    1092           1 :                 return -ENOENT;
    1093             :         }
    1094             : 
    1095             :         SPDK_DTRACE_PROBE2(nvmf_subsystem_remove_host, subsystem->subnqn, host->nqn);
    1096             : 
    1097           3 :         nvmf_subsystem_remove_host(subsystem, host);
    1098             : 
    1099           3 :         if (!TAILQ_EMPTY(&subsystem->listeners)) {
    1100           1 :                 nvmf_update_discovery_log(subsystem->tgt, hostnqn);
    1101             :         }
    1102             : 
    1103           4 :         for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
    1104           1 :              transport = spdk_nvmf_transport_get_next(transport)) {
    1105           1 :                 if (transport->ops->subsystem_remove_host) {
    1106           0 :                         transport->ops->subsystem_remove_host(transport, subsystem, hostnqn);
    1107             :                 }
    1108             :         }
    1109             : 
    1110           3 :         pthread_mutex_unlock(&subsystem->mutex);
    1111             : 
    1112           3 :         return 0;
    1113             : }
    1114             : 
    1115             : struct nvmf_subsystem_disconnect_host_ctx {
    1116             :         struct spdk_nvmf_subsystem              *subsystem;
    1117             :         char                                    *hostnqn;
    1118             :         spdk_nvmf_tgt_subsystem_listen_done_fn  cb_fn;
    1119             :         void                                    *cb_arg;
    1120             : };
    1121             : 
    1122             : static void
    1123           0 : nvmf_subsystem_disconnect_host_fini(struct spdk_io_channel_iter *i, int status)
    1124             : {
    1125             :         struct nvmf_subsystem_disconnect_host_ctx *ctx;
    1126             : 
    1127           0 :         ctx = spdk_io_channel_iter_get_ctx(i);
    1128             : 
    1129           0 :         if (ctx->cb_fn) {
    1130           0 :                 ctx->cb_fn(ctx->cb_arg, status);
    1131             :         }
    1132           0 :         free(ctx->hostnqn);
    1133           0 :         free(ctx);
    1134           0 : }
    1135             : 
    1136             : static void
    1137           0 : nvmf_subsystem_disconnect_qpairs_by_host(struct spdk_io_channel_iter *i)
    1138             : {
    1139             :         struct nvmf_subsystem_disconnect_host_ctx *ctx;
    1140             :         struct spdk_nvmf_poll_group *group;
    1141             :         struct spdk_io_channel *ch;
    1142             :         struct spdk_nvmf_qpair *qpair, *tmp_qpair;
    1143             :         struct spdk_nvmf_ctrlr *ctrlr;
    1144             : 
    1145           0 :         ctx = spdk_io_channel_iter_get_ctx(i);
    1146           0 :         ch = spdk_io_channel_iter_get_channel(i);
    1147           0 :         group = spdk_io_channel_get_ctx(ch);
    1148             : 
    1149           0 :         TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, tmp_qpair) {
    1150           0 :                 ctrlr = qpair->ctrlr;
    1151             : 
    1152           0 :                 if (ctrlr == NULL || ctrlr->subsys != ctx->subsystem) {
    1153           0 :                         continue;
    1154             :                 }
    1155             : 
    1156           0 :                 if (strncmp(ctrlr->hostnqn, ctx->hostnqn, sizeof(ctrlr->hostnqn)) == 0) {
    1157             :                         /* Right now this does not wait for the queue pairs to actually disconnect. */
    1158           0 :                         spdk_nvmf_qpair_disconnect(qpair);
    1159             :                 }
    1160             :         }
    1161           0 :         spdk_for_each_channel_continue(i, 0);
    1162           0 : }
    1163             : 
    1164             : int
    1165           0 : spdk_nvmf_subsystem_disconnect_host(struct spdk_nvmf_subsystem *subsystem,
    1166             :                                     const char *hostnqn,
    1167             :                                     spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
    1168             :                                     void *cb_arg)
    1169             : {
    1170             :         struct nvmf_subsystem_disconnect_host_ctx *ctx;
    1171             : 
    1172           0 :         ctx = calloc(1, sizeof(struct nvmf_subsystem_disconnect_host_ctx));
    1173           0 :         if (ctx == NULL) {
    1174           0 :                 return -ENOMEM;
    1175             :         }
    1176             : 
    1177           0 :         ctx->hostnqn = strdup(hostnqn);
    1178           0 :         if (ctx->hostnqn == NULL) {
    1179           0 :                 free(ctx);
    1180           0 :                 return -ENOMEM;
    1181             :         }
    1182             : 
    1183           0 :         ctx->subsystem = subsystem;
    1184           0 :         ctx->cb_fn = cb_fn;
    1185           0 :         ctx->cb_arg = cb_arg;
    1186             : 
    1187           0 :         spdk_for_each_channel(subsystem->tgt, nvmf_subsystem_disconnect_qpairs_by_host, ctx,
    1188             :                               nvmf_subsystem_disconnect_host_fini);
    1189             : 
    1190           0 :         return 0;
    1191             : }
    1192             : 
    1193             : int
    1194           0 : spdk_nvmf_subsystem_set_allow_any_host(struct spdk_nvmf_subsystem *subsystem, bool allow_any_host)
    1195             : {
    1196           0 :         pthread_mutex_lock(&subsystem->mutex);
    1197           0 :         subsystem->allow_any_host = allow_any_host;
    1198           0 :         if (!TAILQ_EMPTY(&subsystem->listeners)) {
    1199           0 :                 nvmf_update_discovery_log(subsystem->tgt, NULL);
    1200             :         }
    1201           0 :         pthread_mutex_unlock(&subsystem->mutex);
    1202             : 
    1203           0 :         return 0;
    1204             : }
    1205             : 
    1206             : bool
    1207           0 : spdk_nvmf_subsystem_get_allow_any_host(const struct spdk_nvmf_subsystem *subsystem)
    1208             : {
    1209             :         bool allow_any_host;
    1210             :         struct spdk_nvmf_subsystem *sub;
    1211             : 
    1212             :         /* Technically, taking the mutex modifies data in the subsystem. But the const
    1213             :          * is still important to convey that this doesn't mutate any other data. Cast
    1214             :          * it away to work around this. */
    1215           0 :         sub = (struct spdk_nvmf_subsystem *)subsystem;
    1216             : 
    1217           0 :         pthread_mutex_lock(&sub->mutex);
    1218           0 :         allow_any_host = sub->allow_any_host;
    1219           0 :         pthread_mutex_unlock(&sub->mutex);
    1220             : 
    1221           0 :         return allow_any_host;
    1222             : }
    1223             : 
    1224             : bool
    1225          31 : spdk_nvmf_subsystem_host_allowed(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
    1226             : {
    1227             :         bool allowed;
    1228             : 
    1229          31 :         if (!hostnqn) {
    1230           0 :                 return false;
    1231             :         }
    1232             : 
    1233          31 :         pthread_mutex_lock(&subsystem->mutex);
    1234             : 
    1235          31 :         if (subsystem->allow_any_host) {
    1236          25 :                 pthread_mutex_unlock(&subsystem->mutex);
    1237          25 :                 return true;
    1238             :         }
    1239             : 
    1240           6 :         allowed =  nvmf_subsystem_find_host(subsystem, hostnqn) != NULL;
    1241           6 :         pthread_mutex_unlock(&subsystem->mutex);
    1242             : 
    1243           6 :         return allowed;
    1244             : }
    1245             : 
    1246             : bool
    1247           0 : nvmf_subsystem_host_auth_required(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
    1248             : {
    1249             :         struct spdk_nvmf_host *host;
    1250             :         bool status;
    1251             : 
    1252           0 :         pthread_mutex_lock(&subsystem->mutex);
    1253           0 :         host = nvmf_subsystem_find_host(subsystem, hostnqn);
    1254           0 :         status = host != NULL && host->dhchap_key != NULL;
    1255           0 :         pthread_mutex_unlock(&subsystem->mutex);
    1256             : 
    1257           0 :         return status;
    1258             : }
    1259             : 
    1260             : struct spdk_key *
    1261           0 : nvmf_subsystem_get_dhchap_key(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn,
    1262             :                               enum nvmf_auth_key_type type)
    1263             : {
    1264             :         struct spdk_nvmf_host *host;
    1265           0 :         struct spdk_key *key = NULL;
    1266             : 
    1267           0 :         pthread_mutex_lock(&subsystem->mutex);
    1268           0 :         host = nvmf_subsystem_find_host(subsystem, hostnqn);
    1269           0 :         if (host != NULL) {
    1270           0 :                 switch (type) {
    1271           0 :                 case NVMF_AUTH_KEY_HOST:
    1272           0 :                         key = host->dhchap_key;
    1273           0 :                         break;
    1274           0 :                 case NVMF_AUTH_KEY_CTRLR:
    1275           0 :                         key = host->dhchap_ctrlr_key;
    1276           0 :                         break;
    1277             :                 }
    1278           0 :                 if (key != NULL) {
    1279           0 :                         key = spdk_key_dup(key);
    1280             :                 }
    1281             :         }
    1282           0 :         pthread_mutex_unlock(&subsystem->mutex);
    1283             : 
    1284           0 :         return key;
    1285             : }
    1286             : 
    1287             : struct spdk_nvmf_host *
    1288           0 : spdk_nvmf_subsystem_get_first_host(struct spdk_nvmf_subsystem *subsystem)
    1289             : {
    1290           0 :         return TAILQ_FIRST(&subsystem->hosts);
    1291             : }
    1292             : 
    1293             : 
    1294             : struct spdk_nvmf_host *
    1295           0 : spdk_nvmf_subsystem_get_next_host(struct spdk_nvmf_subsystem *subsystem,
    1296             :                                   struct spdk_nvmf_host *prev_host)
    1297             : {
    1298           0 :         return TAILQ_NEXT(prev_host, link);
    1299             : }
    1300             : 
    1301             : const char *
    1302           0 : spdk_nvmf_host_get_nqn(const struct spdk_nvmf_host *host)
    1303             : {
    1304           0 :         return host->nqn;
    1305             : }
    1306             : 
    1307             : struct spdk_nvmf_subsystem_listener *
    1308           7 : nvmf_subsystem_find_listener(struct spdk_nvmf_subsystem *subsystem,
    1309             :                              const struct spdk_nvme_transport_id *trid)
    1310             : {
    1311             :         struct spdk_nvmf_subsystem_listener *listener;
    1312             : 
    1313          22 :         TAILQ_FOREACH(listener, &subsystem->listeners, link) {
    1314          15 :                 if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) {
    1315           0 :                         return listener;
    1316             :                 }
    1317             :         }
    1318             : 
    1319           7 :         return NULL;
    1320             : }
    1321             : 
    1322             : /**
    1323             :  * Function to be called once the target is listening.
    1324             :  *
    1325             :  * \param ctx Context argument passed to this function.
    1326             :  * \param status 0 if it completed successfully, or negative errno if it failed.
    1327             :  */
    1328             : static void
    1329           7 : _nvmf_subsystem_add_listener_done(void *ctx, int status)
    1330             : {
    1331           7 :         struct spdk_nvmf_subsystem_listener *listener = ctx;
    1332             : 
    1333           7 :         if (status) {
    1334           0 :                 listener->cb_fn(listener->cb_arg, status);
    1335           0 :                 free(listener);
    1336           0 :                 return;
    1337             :         }
    1338             : 
    1339           7 :         TAILQ_INSERT_HEAD(&listener->subsystem->listeners, listener, link);
    1340             : 
    1341           7 :         if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) {
    1342           0 :                 status = nvmf_tgt_update_mdns_prr(listener->subsystem->tgt);
    1343           0 :                 if (status) {
    1344           0 :                         TAILQ_REMOVE(&listener->subsystem->listeners, listener, link);
    1345           0 :                         listener->cb_fn(listener->cb_arg, status);
    1346           0 :                         free(listener);
    1347           0 :                         return;
    1348             :                 }
    1349             :         }
    1350             : 
    1351           7 :         nvmf_update_discovery_log(listener->subsystem->tgt, NULL);
    1352           7 :         listener->cb_fn(listener->cb_arg, status);
    1353             : }
    1354             : 
    1355             : void
    1356           7 : spdk_nvmf_subsystem_listener_opts_init(struct spdk_nvmf_listener_opts *opts, size_t size)
    1357             : {
    1358           7 :         if (opts == NULL) {
    1359           0 :                 SPDK_ERRLOG("opts should not be NULL\n");
    1360           0 :                 assert(false);
    1361             :                 return;
    1362             :         }
    1363           7 :         if (size == 0) {
    1364           0 :                 SPDK_ERRLOG("size should not be zero\n");
    1365           0 :                 assert(false);
    1366             :                 return;
    1367             :         }
    1368             : 
    1369           7 :         memset(opts, 0, size);
    1370           7 :         opts->opts_size = size;
    1371             : 
    1372             : #define FIELD_OK(field) \
    1373             :         offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(opts->field) <= size
    1374             : 
    1375             : #define SET_FIELD(field, value) \
    1376             :         if (FIELD_OK(field)) { \
    1377             :                 opts->field = value; \
    1378             :         } \
    1379             : 
    1380           7 :         SET_FIELD(secure_channel, false);
    1381           7 :         SET_FIELD(ana_state, SPDK_NVME_ANA_OPTIMIZED_STATE);
    1382           7 :         SET_FIELD(sock_impl, NULL);
    1383             : 
    1384             : #undef FIELD_OK
    1385             : #undef SET_FIELD
    1386             : }
    1387             : 
    1388             : static int
    1389           0 : listener_opts_copy(struct spdk_nvmf_listener_opts *src, struct spdk_nvmf_listener_opts *dst)
    1390             : {
    1391           0 :         if (src->opts_size == 0) {
    1392           0 :                 SPDK_ERRLOG("source structure size should not be zero\n");
    1393           0 :                 assert(false);
    1394             :                 return -EINVAL;
    1395             :         }
    1396             : 
    1397           0 :         memset(dst, 0, sizeof(*dst));
    1398           0 :         dst->opts_size = src->opts_size;
    1399             : 
    1400             : #define FIELD_OK(field) \
    1401             :         offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(src->field) <= src->opts_size
    1402             : 
    1403             : #define SET_FIELD(field) \
    1404             :         if (FIELD_OK(field)) { \
    1405             :                 dst->field = src->field; \
    1406             :         } \
    1407             : 
    1408           0 :         SET_FIELD(secure_channel);
    1409           0 :         SET_FIELD(ana_state);
    1410           0 :         SET_FIELD(sock_impl);
    1411             :         /* We should not remove this statement, but need to update the assert statement
    1412             :          * if we add a new field, and also add a corresponding SET_FIELD statement. */
    1413             :         SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_listener_opts) == 24, "Incorrect size");
    1414             : 
    1415             : #undef SET_FIELD
    1416             : #undef FIELD_OK
    1417             : 
    1418           0 :         return 0;
    1419             : }
    1420             : 
    1421             : static void
    1422           7 : _nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem,
    1423             :                              struct spdk_nvme_transport_id *trid,
    1424             :                              spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
    1425             :                              void *cb_arg, struct spdk_nvmf_listener_opts *opts)
    1426             : {
    1427             :         struct spdk_nvmf_transport *transport;
    1428             :         struct spdk_nvmf_subsystem_listener *listener;
    1429             :         struct spdk_nvmf_listener *tr_listener;
    1430             :         uint32_t i;
    1431             :         uint32_t id;
    1432           7 :         int rc = 0;
    1433             : 
    1434           7 :         assert(cb_fn != NULL);
    1435             : 
    1436           7 :         if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
    1437           0 :               subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
    1438           0 :                 cb_fn(cb_arg, -EAGAIN);
    1439           0 :                 return;
    1440             :         }
    1441             : 
    1442           7 :         if (nvmf_subsystem_find_listener(subsystem, trid)) {
    1443             :                 /* Listener already exists in this subsystem */
    1444           0 :                 cb_fn(cb_arg, 0);
    1445           0 :                 return;
    1446             :         }
    1447             : 
    1448           7 :         transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, trid->trstring);
    1449           7 :         if (!transport) {
    1450           0 :                 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n",
    1451             :                             trid->trstring);
    1452           0 :                 cb_fn(cb_arg, -EINVAL);
    1453           0 :                 return;
    1454             :         }
    1455             : 
    1456           7 :         tr_listener = nvmf_transport_find_listener(transport, trid);
    1457           7 :         if (!tr_listener) {
    1458           0 :                 SPDK_ERRLOG("Cannot find transport listener for %s\n", trid->traddr);
    1459           0 :                 cb_fn(cb_arg, -EINVAL);
    1460           0 :                 return;
    1461             :         }
    1462             : 
    1463           7 :         listener = calloc(1, sizeof(*listener));
    1464           7 :         if (!listener) {
    1465           0 :                 cb_fn(cb_arg, -ENOMEM);
    1466           0 :                 return;
    1467             :         }
    1468             : 
    1469           7 :         listener->trid = &tr_listener->trid;
    1470           7 :         listener->transport = transport;
    1471           7 :         listener->cb_fn = cb_fn;
    1472           7 :         listener->cb_arg = cb_arg;
    1473           7 :         listener->subsystem = subsystem;
    1474           7 :         listener->ana_state = calloc(subsystem->max_nsid, sizeof(enum spdk_nvme_ana_state));
    1475           7 :         if (!listener->ana_state) {
    1476           0 :                 free(listener);
    1477           0 :                 cb_fn(cb_arg, -ENOMEM);
    1478           0 :                 return;
    1479             :         }
    1480             : 
    1481           7 :         spdk_nvmf_subsystem_listener_opts_init(&listener->opts, sizeof(listener->opts));
    1482           7 :         if (opts != NULL) {
    1483           0 :                 rc = listener_opts_copy(opts, &listener->opts);
    1484           0 :                 if (rc) {
    1485           0 :                         SPDK_ERRLOG("Unable to copy listener options\n");
    1486           0 :                         free(listener->ana_state);
    1487           0 :                         free(listener);
    1488           0 :                         cb_fn(cb_arg, -EINVAL);
    1489           0 :                         return;
    1490             :                 }
    1491             :         }
    1492             : 
    1493           7 :         id = spdk_bit_array_find_first_clear(subsystem->used_listener_ids, 0);
    1494           7 :         if (id == UINT32_MAX) {
    1495           0 :                 SPDK_ERRLOG("Cannot add any more listeners\n");
    1496           0 :                 free(listener->ana_state);
    1497           0 :                 free(listener->opts.sock_impl);
    1498           0 :                 free(listener);
    1499           0 :                 cb_fn(cb_arg, -EINVAL);
    1500           0 :                 return;
    1501             :         }
    1502             : 
    1503           7 :         spdk_bit_array_set(subsystem->used_listener_ids, id);
    1504           7 :         listener->id = id;
    1505             : 
    1506         231 :         for (i = 0; i < subsystem->max_nsid; i++) {
    1507         224 :                 listener->ana_state[i] = listener->opts.ana_state;
    1508             :         }
    1509             : 
    1510           7 :         if (transport->ops->listen_associate != NULL) {
    1511           0 :                 rc = transport->ops->listen_associate(transport, subsystem, trid);
    1512             :         }
    1513             : 
    1514             :         SPDK_DTRACE_PROBE4(nvmf_subsystem_add_listener, subsystem->subnqn, listener->trid->trtype,
    1515             :                            listener->trid->traddr, listener->trid->trsvcid);
    1516             : 
    1517           7 :         _nvmf_subsystem_add_listener_done(listener, rc);
    1518             : }
    1519             : 
    1520             : void
    1521           7 : spdk_nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem,
    1522             :                                  struct spdk_nvme_transport_id *trid,
    1523             :                                  spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
    1524             :                                  void *cb_arg)
    1525             : {
    1526           7 :         _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, NULL);
    1527           7 : }
    1528             : 
    1529             : void
    1530           0 : spdk_nvmf_subsystem_add_listener_ext(struct spdk_nvmf_subsystem *subsystem,
    1531             :                                      struct spdk_nvme_transport_id *trid,
    1532             :                                      spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
    1533             :                                      void *cb_arg, struct spdk_nvmf_listener_opts *opts)
    1534             : {
    1535           0 :         _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, opts);
    1536           0 : }
    1537             : 
    1538             : int
    1539           0 : spdk_nvmf_subsystem_remove_listener(struct spdk_nvmf_subsystem *subsystem,
    1540             :                                     const struct spdk_nvme_transport_id *trid)
    1541             : {
    1542             :         struct spdk_nvmf_subsystem_listener *listener;
    1543             : 
    1544           0 :         if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
    1545           0 :               subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
    1546           0 :                 return -EAGAIN;
    1547             :         }
    1548             : 
    1549           0 :         listener = nvmf_subsystem_find_listener(subsystem, trid);
    1550           0 :         if (listener == NULL) {
    1551           0 :                 return -ENOENT;
    1552             :         }
    1553             : 
    1554             :         SPDK_DTRACE_PROBE4(nvmf_subsystem_remove_listener, subsystem->subnqn, listener->trid->trtype,
    1555             :                            listener->trid->traddr, listener->trid->trsvcid);
    1556             : 
    1557           0 :         _nvmf_subsystem_remove_listener(subsystem, listener, false);
    1558             : 
    1559           0 :         return 0;
    1560             : }
    1561             : 
    1562             : void
    1563          13 : nvmf_subsystem_remove_all_listeners(struct spdk_nvmf_subsystem *subsystem,
    1564             :                                     bool stop)
    1565             : {
    1566             :         struct spdk_nvmf_subsystem_listener *listener, *listener_tmp;
    1567             : 
    1568          20 :         TAILQ_FOREACH_SAFE(listener, &subsystem->listeners, link, listener_tmp) {
    1569           7 :                 _nvmf_subsystem_remove_listener(subsystem, listener, stop);
    1570             :         }
    1571          13 : }
    1572             : 
    1573             : bool
    1574           0 : spdk_nvmf_subsystem_listener_allowed(struct spdk_nvmf_subsystem *subsystem,
    1575             :                                      const struct spdk_nvme_transport_id *trid)
    1576             : {
    1577             :         struct spdk_nvmf_subsystem_listener *listener;
    1578             : 
    1579           0 :         TAILQ_FOREACH(listener, &subsystem->listeners, link) {
    1580           0 :                 if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) {
    1581           0 :                         return true;
    1582             :                 }
    1583             :         }
    1584             : 
    1585           0 :         if (!strcmp(subsystem->subnqn, SPDK_NVMF_DISCOVERY_NQN)) {
    1586           0 :                 SPDK_WARNLOG("Allowing connection to discovery subsystem on %s/%s/%s, "
    1587             :                              "even though this listener was not added to the discovery "
    1588             :                              "subsystem.  This behavior is deprecated and will be removed "
    1589             :                              "in a future release.\n",
    1590             :                              spdk_nvme_transport_id_trtype_str(trid->trtype), trid->traddr, trid->trsvcid);
    1591           0 :                 return true;
    1592             :         }
    1593             : 
    1594           0 :         return false;
    1595             : }
    1596             : 
    1597             : struct spdk_nvmf_subsystem_listener *
    1598          30 : spdk_nvmf_subsystem_get_first_listener(struct spdk_nvmf_subsystem *subsystem)
    1599             : {
    1600          30 :         return TAILQ_FIRST(&subsystem->listeners);
    1601             : }
    1602             : 
    1603             : struct spdk_nvmf_subsystem_listener *
    1604         155 : spdk_nvmf_subsystem_get_next_listener(struct spdk_nvmf_subsystem *subsystem,
    1605             :                                       struct spdk_nvmf_subsystem_listener *prev_listener)
    1606             : {
    1607         155 :         return TAILQ_NEXT(prev_listener, link);
    1608             : }
    1609             : 
    1610             : const struct spdk_nvme_transport_id *
    1611           0 : spdk_nvmf_subsystem_listener_get_trid(struct spdk_nvmf_subsystem_listener *listener)
    1612             : {
    1613           0 :         return listener->trid;
    1614             : }
    1615             : 
    1616             : void
    1617           0 : spdk_nvmf_subsystem_allow_any_listener(struct spdk_nvmf_subsystem *subsystem,
    1618             :                                        bool allow_any_listener)
    1619             : {
    1620           0 :         subsystem->flags.allow_any_listener = allow_any_listener;
    1621           0 : }
    1622             : 
    1623             : bool
    1624           0 : spdk_nvmf_subsystem_any_listener_allowed(struct spdk_nvmf_subsystem *subsystem)
    1625             : {
    1626           0 :         return subsystem->flags.allow_any_listener;
    1627             : }
    1628             : 
    1629             : struct subsystem_update_ns_ctx {
    1630             :         struct spdk_nvmf_subsystem *subsystem;
    1631             : 
    1632             :         spdk_nvmf_subsystem_state_change_done cb_fn;
    1633             :         void *cb_arg;
    1634             : };
    1635             : 
    1636             : static void
    1637           0 : subsystem_update_ns_done(struct spdk_io_channel_iter *i, int status)
    1638             : {
    1639           0 :         struct subsystem_update_ns_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
    1640             : 
    1641           0 :         if (ctx->cb_fn) {
    1642           0 :                 ctx->cb_fn(ctx->subsystem, ctx->cb_arg, status);
    1643             :         }
    1644           0 :         free(ctx);
    1645           0 : }
    1646             : 
    1647             : static void
    1648           0 : subsystem_update_ns_on_pg(struct spdk_io_channel_iter *i)
    1649             : {
    1650             :         int rc;
    1651             :         struct subsystem_update_ns_ctx *ctx;
    1652             :         struct spdk_nvmf_poll_group *group;
    1653             :         struct spdk_nvmf_subsystem *subsystem;
    1654             : 
    1655           0 :         ctx = spdk_io_channel_iter_get_ctx(i);
    1656           0 :         group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i));
    1657           0 :         subsystem = ctx->subsystem;
    1658             : 
    1659           0 :         rc = nvmf_poll_group_update_subsystem(group, subsystem);
    1660           0 :         spdk_for_each_channel_continue(i, rc);
    1661           0 : }
    1662             : 
    1663             : static int
    1664           0 : nvmf_subsystem_update_ns(struct spdk_nvmf_subsystem *subsystem,
    1665             :                          spdk_nvmf_subsystem_state_change_done cb_fn, void *cb_arg)
    1666             : {
    1667             :         struct subsystem_update_ns_ctx *ctx;
    1668             : 
    1669           0 :         ctx = calloc(1, sizeof(*ctx));
    1670           0 :         if (ctx == NULL) {
    1671           0 :                 SPDK_ERRLOG("Can't alloc subsystem poll group update context\n");
    1672           0 :                 return -ENOMEM;
    1673             :         }
    1674           0 :         ctx->subsystem = subsystem;
    1675           0 :         ctx->cb_fn = cb_fn;
    1676           0 :         ctx->cb_arg = cb_arg;
    1677             : 
    1678           0 :         spdk_for_each_channel(subsystem->tgt,
    1679             :                               subsystem_update_ns_on_pg,
    1680             :                               ctx,
    1681             :                               subsystem_update_ns_done);
    1682           0 :         return 0;
    1683             : }
    1684             : 
    1685             : static void
    1686          10 : nvmf_subsystem_ns_changed(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
    1687             : {
    1688             :         struct spdk_nvmf_ctrlr *ctrlr;
    1689             : 
    1690          14 :         TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
    1691           4 :                 if (nvmf_ctrlr_ns_is_visible(ctrlr, nsid)) {
    1692           3 :                         nvmf_ctrlr_ns_changed(ctrlr, nsid);
    1693             :                 }
    1694             :         }
    1695          10 : }
    1696             : 
    1697             : static uint32_t nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns);
    1698             : 
    1699             : int
    1700           5 : spdk_nvmf_subsystem_remove_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
    1701             : {
    1702             :         struct spdk_nvmf_transport *transport;
    1703             :         struct spdk_nvmf_ns *ns;
    1704             :         struct spdk_nvmf_host *host, *tmp;
    1705             :         struct spdk_nvmf_ctrlr *ctrlr;
    1706             : 
    1707           5 :         if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
    1708           1 :               subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
    1709           0 :                 assert(false);
    1710             :                 return -1;
    1711             :         }
    1712             : 
    1713           5 :         if (nsid == 0 || nsid > subsystem->max_nsid) {
    1714           0 :                 return -1;
    1715             :         }
    1716             : 
    1717           5 :         ns = subsystem->ns[nsid - 1];
    1718           5 :         if (!ns) {
    1719           0 :                 return -1;
    1720             :         }
    1721             : 
    1722           5 :         subsystem->ns[nsid - 1] = NULL;
    1723             : 
    1724           5 :         assert(ns->anagrpid - 1 < subsystem->max_nsid);
    1725           5 :         assert(subsystem->ana_group[ns->anagrpid - 1] > 0);
    1726             : 
    1727           5 :         subsystem->ana_group[ns->anagrpid - 1]--;
    1728             : 
    1729           6 :         TAILQ_FOREACH_SAFE(host, &ns->hosts, link, tmp) {
    1730           1 :                 nvmf_ns_remove_host(ns, host);
    1731             :         }
    1732             : 
    1733           5 :         free(ns->ptpl_file);
    1734           5 :         nvmf_ns_reservation_clear_all_registrants(ns);
    1735           5 :         spdk_bdev_module_release_bdev(ns->bdev);
    1736           5 :         spdk_bdev_close(ns->desc);
    1737           5 :         free(ns);
    1738             : 
    1739           5 :         if (subsystem->fdp_supported && !spdk_nvmf_subsystem_get_first_ns(subsystem)) {
    1740           1 :                 subsystem->fdp_supported = false;
    1741           1 :                 SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u doesn't have FDP capability.\n",
    1742             :                               subsystem->id);
    1743             :         }
    1744             : 
    1745           5 :         for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
    1746           0 :              transport = spdk_nvmf_transport_get_next(transport)) {
    1747           0 :                 if (transport->ops->subsystem_remove_ns) {
    1748           0 :                         transport->ops->subsystem_remove_ns(transport, subsystem, nsid);
    1749             :                 }
    1750             :         }
    1751             : 
    1752           5 :         nvmf_subsystem_ns_changed(subsystem, nsid);
    1753             : 
    1754           8 :         TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
    1755           3 :                 spdk_bit_array_clear(ctrlr->visible_ns, nsid - 1);
    1756             :         }
    1757             : 
    1758           5 :         return 0;
    1759             : }
    1760             : 
    1761             : struct subsystem_ns_change_ctx {
    1762             :         struct spdk_nvmf_subsystem              *subsystem;
    1763             :         spdk_nvmf_subsystem_state_change_done   cb_fn;
    1764             :         uint32_t                                nsid;
    1765             : };
    1766             : 
    1767             : static void
    1768           1 : _nvmf_ns_hot_remove(struct spdk_nvmf_subsystem *subsystem,
    1769             :                     void *cb_arg, int status)
    1770             : {
    1771           1 :         struct subsystem_ns_change_ctx *ctx = cb_arg;
    1772             :         int rc;
    1773             : 
    1774           1 :         rc = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid);
    1775           1 :         if (rc != 0) {
    1776           0 :                 SPDK_ERRLOG("Failed to make changes to NVME-oF subsystem with id: %u\n", subsystem->id);
    1777             :         }
    1778             : 
    1779           1 :         rc = spdk_nvmf_subsystem_resume(subsystem, NULL, NULL);
    1780           1 :         if (rc != 0) {
    1781           0 :                 SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id);
    1782             :         }
    1783             : 
    1784           1 :         free(ctx);
    1785           1 : }
    1786             : 
    1787             : static void
    1788           0 : nvmf_ns_change_msg(void *ns_ctx)
    1789             : {
    1790           0 :         struct subsystem_ns_change_ctx *ctx = ns_ctx;
    1791             :         int rc;
    1792             : 
    1793             :         SPDK_DTRACE_PROBE2(nvmf_ns_change, ctx->nsid, ctx->subsystem->subnqn);
    1794             : 
    1795           0 :         rc = spdk_nvmf_subsystem_pause(ctx->subsystem, ctx->nsid, ctx->cb_fn, ctx);
    1796           0 :         if (rc) {
    1797           0 :                 if (rc == -EBUSY) {
    1798             :                         /* Try again, this is not a permanent situation. */
    1799           0 :                         spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ctx);
    1800             :                 } else {
    1801           0 :                         free(ctx);
    1802           0 :                         SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n");
    1803             :                 }
    1804             :         }
    1805           0 : }
    1806             : 
    1807             : static void
    1808           1 : nvmf_ns_hot_remove(void *remove_ctx)
    1809             : {
    1810           1 :         struct spdk_nvmf_ns *ns = remove_ctx;
    1811             :         struct subsystem_ns_change_ctx *ns_ctx;
    1812             :         int rc;
    1813             : 
    1814             :         /* We have to allocate a new context because this op
    1815             :          * is asynchronous and we could lose the ns in the middle.
    1816             :          */
    1817           1 :         ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx));
    1818           1 :         if (!ns_ctx) {
    1819           0 :                 SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n");
    1820           0 :                 return;
    1821             :         }
    1822             : 
    1823           1 :         ns_ctx->subsystem = ns->subsystem;
    1824           1 :         ns_ctx->nsid = ns->opts.nsid;
    1825           1 :         ns_ctx->cb_fn = _nvmf_ns_hot_remove;
    1826             : 
    1827           1 :         rc = spdk_nvmf_subsystem_pause(ns->subsystem, ns_ctx->nsid, _nvmf_ns_hot_remove, ns_ctx);
    1828           1 :         if (rc) {
    1829           0 :                 if (rc == -EBUSY) {
    1830             :                         /* Try again, this is not a permanent situation. */
    1831           0 :                         spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx);
    1832             :                 } else {
    1833           0 :                         SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n");
    1834           0 :                         free(ns_ctx);
    1835             :                 }
    1836             :         }
    1837             : }
    1838             : 
    1839             : static void
    1840           1 : _nvmf_ns_resize(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status)
    1841             : {
    1842           1 :         struct subsystem_ns_change_ctx *ctx = cb_arg;
    1843             : 
    1844           1 :         nvmf_subsystem_ns_changed(subsystem, ctx->nsid);
    1845           1 :         if (spdk_nvmf_subsystem_resume(subsystem, NULL, NULL) != 0) {
    1846           0 :                 SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id);
    1847             :         }
    1848             : 
    1849           1 :         free(ctx);
    1850           1 : }
    1851             : 
    1852             : static void
    1853           1 : nvmf_ns_resize(void *event_ctx)
    1854             : {
    1855           1 :         struct spdk_nvmf_ns *ns = event_ctx;
    1856             :         struct subsystem_ns_change_ctx *ns_ctx;
    1857             :         int rc;
    1858             : 
    1859             :         /* We have to allocate a new context because this op
    1860             :          * is asynchronous and we could lose the ns in the middle.
    1861             :          */
    1862           1 :         ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx));
    1863           1 :         if (!ns_ctx) {
    1864           0 :                 SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n");
    1865           0 :                 return;
    1866             :         }
    1867             : 
    1868           1 :         ns_ctx->subsystem = ns->subsystem;
    1869           1 :         ns_ctx->nsid = ns->opts.nsid;
    1870           1 :         ns_ctx->cb_fn = _nvmf_ns_resize;
    1871             : 
    1872             :         /* Specify 0 for the nsid here, because we do not need to pause the namespace.
    1873             :          * Namespaces can only be resized bigger, so there is no need to quiesce I/O.
    1874             :          */
    1875           1 :         rc = spdk_nvmf_subsystem_pause(ns->subsystem, 0, _nvmf_ns_resize, ns_ctx);
    1876           1 :         if (rc) {
    1877           0 :                 if (rc == -EBUSY) {
    1878             :                         /* Try again, this is not a permanent situation. */
    1879           0 :                         spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx);
    1880             :                 } else {
    1881           0 :                         SPDK_ERRLOG("Unable to pause subsystem to process namespace resize!\n");
    1882           0 :                         free(ns_ctx);
    1883             :                 }
    1884             :         }
    1885             : }
    1886             : 
    1887             : static void
    1888           2 : nvmf_ns_event(enum spdk_bdev_event_type type,
    1889             :               struct spdk_bdev *bdev,
    1890             :               void *event_ctx)
    1891             : {
    1892           2 :         SPDK_DEBUGLOG(nvmf, "Bdev event: type %d, name %s, subsystem_id %d, ns_id %d\n",
    1893             :                       type,
    1894             :                       spdk_bdev_get_name(bdev),
    1895             :                       ((struct spdk_nvmf_ns *)event_ctx)->subsystem->id,
    1896             :                       ((struct spdk_nvmf_ns *)event_ctx)->nsid);
    1897             : 
    1898           2 :         switch (type) {
    1899           1 :         case SPDK_BDEV_EVENT_REMOVE:
    1900           1 :                 nvmf_ns_hot_remove(event_ctx);
    1901           1 :                 break;
    1902           1 :         case SPDK_BDEV_EVENT_RESIZE:
    1903           1 :                 nvmf_ns_resize(event_ctx);
    1904           1 :                 break;
    1905           0 :         default:
    1906           0 :                 SPDK_NOTICELOG("Unsupported bdev event: type %d\n", type);
    1907           0 :                 break;
    1908             :         }
    1909           2 : }
    1910             : 
    1911             : void
    1912          13 : spdk_nvmf_ns_opts_get_defaults(struct spdk_nvmf_ns_opts *opts, size_t opts_size)
    1913             : {
    1914          13 :         if (!opts) {
    1915           0 :                 SPDK_ERRLOG("opts should not be NULL.\n");
    1916           0 :                 return;
    1917             :         }
    1918             : 
    1919          13 :         if (!opts_size) {
    1920           0 :                 SPDK_ERRLOG("opts_size should not be zero.\n");
    1921           0 :                 return;
    1922             :         }
    1923             : 
    1924          13 :         memset(opts, 0, opts_size);
    1925          13 :         opts->opts_size = opts_size;
    1926             : 
    1927             : #define FIELD_OK(field) \
    1928             :         offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= opts_size
    1929             : 
    1930             : #define SET_FIELD(field, value) \
    1931             :         if (FIELD_OK(field)) { \
    1932             :                 opts->field = value; \
    1933             :         } \
    1934             : 
    1935             :         /* All current fields are set to 0 by default. */
    1936          13 :         SET_FIELD(nsid, 0);
    1937          13 :         if (FIELD_OK(nguid)) {
    1938          13 :                 memset(opts->nguid, 0, sizeof(opts->nguid));
    1939             :         }
    1940          13 :         if (FIELD_OK(eui64)) {
    1941          13 :                 memset(opts->eui64, 0, sizeof(opts->eui64));
    1942             :         }
    1943          13 :         if (FIELD_OK(uuid)) {
    1944          13 :                 spdk_uuid_set_null(&opts->uuid);
    1945             :         }
    1946          13 :         SET_FIELD(anagrpid, 0);
    1947          13 :         SET_FIELD(transport_specific, NULL);
    1948             : 
    1949             : #undef FIELD_OK
    1950             : #undef SET_FIELD
    1951             : }
    1952             : 
    1953             : static void
    1954           6 : nvmf_ns_opts_copy(struct spdk_nvmf_ns_opts *opts,
    1955             :                   const struct spdk_nvmf_ns_opts *user_opts,
    1956             :                   size_t opts_size)
    1957             : {
    1958             : #define FIELD_OK(field) \
    1959             :         offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= user_opts->opts_size
    1960             : 
    1961             : #define SET_FIELD(field) \
    1962             :         if (FIELD_OK(field)) { \
    1963             :                 opts->field = user_opts->field;   \
    1964             :         } \
    1965             : 
    1966           6 :         SET_FIELD(nsid);
    1967           6 :         if (FIELD_OK(nguid)) {
    1968           6 :                 memcpy(opts->nguid, user_opts->nguid, sizeof(opts->nguid));
    1969             :         }
    1970           6 :         if (FIELD_OK(eui64)) {
    1971           6 :                 memcpy(opts->eui64, user_opts->eui64, sizeof(opts->eui64));
    1972             :         }
    1973           6 :         if (FIELD_OK(uuid)) {
    1974           6 :                 spdk_uuid_copy(&opts->uuid, &user_opts->uuid);
    1975             :         }
    1976           6 :         SET_FIELD(anagrpid);
    1977           6 :         SET_FIELD(no_auto_visible);
    1978           6 :         SET_FIELD(transport_specific);
    1979             : 
    1980           6 :         opts->opts_size = user_opts->opts_size;
    1981             : 
    1982             :         /* We should not remove this statement, but need to update the assert statement
    1983             :          * if we add a new field, and also add a corresponding SET_FIELD statement.
    1984             :          */
    1985             :         SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ns_opts) == 72, "Incorrect size");
    1986             : 
    1987             : #undef FIELD_OK
    1988             : #undef SET_FIELD
    1989           6 : }
    1990             : 
    1991             : /* Dummy bdev module used to to claim bdevs. */
    1992             : static struct spdk_bdev_module ns_bdev_module = {
    1993             :         .name   = "NVMe-oF Target",
    1994             : };
    1995             : 
    1996             : static int nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns,
    1997             :                                       const struct spdk_nvmf_reservation_info *info);
    1998             : static int nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns,
    1999             :                                     struct spdk_nvmf_reservation_info *info);
    2000             : static int nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns,
    2001             :                                        struct spdk_nvmf_reservation_info *info);
    2002             : 
    2003             : bool
    2004           0 : nvmf_subsystem_zone_append_supported(struct spdk_nvmf_subsystem *subsystem)
    2005             : {
    2006             :         struct spdk_nvmf_ns *ns;
    2007             : 
    2008           0 :         for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
    2009           0 :              ns != NULL;
    2010           0 :              ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) {
    2011           0 :                 if (spdk_bdev_is_zoned(ns->bdev) &&
    2012           0 :                     spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZONE_APPEND)) {
    2013           0 :                         return true;
    2014             :                 }
    2015             :         }
    2016             : 
    2017           0 :         return false;
    2018             : }
    2019             : 
    2020             : uint32_t
    2021           7 : spdk_nvmf_subsystem_add_ns_ext(struct spdk_nvmf_subsystem *subsystem, const char *bdev_name,
    2022             :                                const struct spdk_nvmf_ns_opts *user_opts, size_t opts_size,
    2023             :                                const char *ptpl_file)
    2024             : {
    2025             :         struct spdk_nvmf_transport *transport;
    2026           7 :         struct spdk_nvmf_ns_opts opts;
    2027             :         struct spdk_nvmf_ns *ns, *first_ns;
    2028             :         struct spdk_nvmf_ctrlr *ctrlr;
    2029           7 :         struct spdk_nvmf_reservation_info info = {0};
    2030             :         int rc;
    2031             :         bool zone_append_supported;
    2032             :         uint64_t max_zone_append_size_kib;
    2033             : 
    2034           7 :         if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
    2035           0 :               subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
    2036           0 :                 return 0;
    2037             :         }
    2038             : 
    2039           7 :         spdk_nvmf_ns_opts_get_defaults(&opts, sizeof(opts));
    2040           7 :         if (user_opts) {
    2041           6 :                 nvmf_ns_opts_copy(&opts, user_opts, opts_size);
    2042             :         }
    2043             : 
    2044           7 :         if (opts.nsid == SPDK_NVME_GLOBAL_NS_TAG) {
    2045           1 :                 SPDK_ERRLOG("Invalid NSID %" PRIu32 "\n", opts.nsid);
    2046           1 :                 return 0;
    2047             :         }
    2048             : 
    2049           6 :         if (opts.nsid == 0) {
    2050             :                 /*
    2051             :                  * NSID not specified - find a free index.
    2052             :                  *
    2053             :                  * If no free slots are found, return error.
    2054             :                  */
    2055           2 :                 for (opts.nsid = 1; opts.nsid <= subsystem->max_nsid; opts.nsid++) {
    2056           2 :                         if (_nvmf_subsystem_get_ns(subsystem, opts.nsid) == NULL) {
    2057           2 :                                 break;
    2058             :                         }
    2059             :                 }
    2060           2 :                 if (opts.nsid > subsystem->max_nsid) {
    2061           0 :                         SPDK_ERRLOG("No free namespace slot available in the subsystem\n");
    2062           0 :                         return 0;
    2063             :                 }
    2064             :         }
    2065             : 
    2066           6 :         if (opts.nsid > subsystem->max_nsid) {
    2067           0 :                 SPDK_ERRLOG("NSID greater than maximum not allowed\n");
    2068           0 :                 return 0;
    2069             :         }
    2070             : 
    2071           6 :         if (_nvmf_subsystem_get_ns(subsystem, opts.nsid)) {
    2072           1 :                 SPDK_ERRLOG("Requested NSID %" PRIu32 " already in use\n", opts.nsid);
    2073           1 :                 return 0;
    2074             :         }
    2075             : 
    2076           5 :         if (opts.anagrpid == 0) {
    2077           5 :                 opts.anagrpid = opts.nsid;
    2078             :         }
    2079             : 
    2080           5 :         if (opts.anagrpid > subsystem->max_nsid) {
    2081           0 :                 SPDK_ERRLOG("ANAGRPID greater than maximum NSID not allowed\n");
    2082           0 :                 return 0;
    2083             :         }
    2084             : 
    2085           5 :         ns = calloc(1, sizeof(*ns));
    2086           5 :         if (ns == NULL) {
    2087           0 :                 SPDK_ERRLOG("Namespace allocation failed\n");
    2088           0 :                 return 0;
    2089             :         }
    2090             : 
    2091           5 :         TAILQ_INIT(&ns->hosts);
    2092           5 :         ns->always_visible = !opts.no_auto_visible;
    2093           5 :         if (ns->always_visible) {
    2094           5 :                 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
    2095           0 :                         spdk_bit_array_set(ctrlr->visible_ns, opts.nsid - 1);
    2096             :                 }
    2097             :         }
    2098             : 
    2099           5 :         rc = spdk_bdev_open_ext(bdev_name, true, nvmf_ns_event, ns, &ns->desc);
    2100           5 :         if (rc != 0) {
    2101           0 :                 SPDK_ERRLOG("Subsystem %s: bdev %s cannot be opened, error=%d\n",
    2102             :                             subsystem->subnqn, bdev_name, rc);
    2103           0 :                 free(ns);
    2104           0 :                 return 0;
    2105             :         }
    2106             : 
    2107           5 :         ns->bdev = spdk_bdev_desc_get_bdev(ns->desc);
    2108             : 
    2109           5 :         if (spdk_bdev_get_md_size(ns->bdev) != 0) {
    2110           0 :                 if (!spdk_bdev_is_md_interleaved(ns->bdev)) {
    2111           0 :                         SPDK_ERRLOG("Can't attach bdev with separate metadata.\n");
    2112           0 :                         spdk_bdev_close(ns->desc);
    2113           0 :                         free(ns);
    2114           0 :                         return 0;
    2115             :                 }
    2116             : 
    2117           0 :                 if (spdk_bdev_get_md_size(ns->bdev) > SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE) {
    2118           0 :                         SPDK_ERRLOG("Maximum supported interleaved md size %u, current md size %u\n",
    2119             :                                     SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE, spdk_bdev_get_md_size(ns->bdev));
    2120           0 :                         spdk_bdev_close(ns->desc);
    2121           0 :                         free(ns);
    2122           0 :                         return 0;
    2123             :                 }
    2124             :         }
    2125             : 
    2126           5 :         rc = spdk_bdev_module_claim_bdev(ns->bdev, ns->desc, &ns_bdev_module);
    2127           5 :         if (rc != 0) {
    2128           0 :                 spdk_bdev_close(ns->desc);
    2129           0 :                 free(ns);
    2130           0 :                 return 0;
    2131             :         }
    2132             : 
    2133             :         /* Cache the zcopy capability of the bdev device */
    2134           5 :         ns->zcopy = spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZCOPY);
    2135             : 
    2136           5 :         if (spdk_uuid_is_null(&opts.uuid)) {
    2137           5 :                 opts.uuid = *spdk_bdev_get_uuid(ns->bdev);
    2138             :         }
    2139             : 
    2140             :         /* if nguid descriptor is supported by bdev module (nvme) then uuid = nguid */
    2141           5 :         if (spdk_mem_all_zero(opts.nguid, sizeof(opts.nguid))) {
    2142             :                 SPDK_STATIC_ASSERT(sizeof(opts.nguid) == sizeof(opts.uuid), "size mismatch");
    2143           5 :                 memcpy(opts.nguid, spdk_bdev_get_uuid(ns->bdev), sizeof(opts.nguid));
    2144             :         }
    2145             : 
    2146           5 :         if (spdk_bdev_is_zoned(ns->bdev)) {
    2147           0 :                 SPDK_DEBUGLOG(nvmf, "The added namespace is backed by a zoned block device.\n");
    2148           0 :                 ns->csi = SPDK_NVME_CSI_ZNS;
    2149             : 
    2150           0 :                 zone_append_supported = spdk_bdev_io_type_supported(ns->bdev,
    2151             :                                         SPDK_BDEV_IO_TYPE_ZONE_APPEND);
    2152           0 :                 max_zone_append_size_kib = spdk_bdev_get_max_zone_append_size(
    2153           0 :                                                    ns->bdev) * spdk_bdev_get_block_size(ns->bdev);
    2154             : 
    2155           0 :                 if (_nvmf_subsystem_get_first_zoned_ns(subsystem) != NULL &&
    2156           0 :                     (nvmf_subsystem_zone_append_supported(subsystem) != zone_append_supported ||
    2157           0 :                      subsystem->max_zone_append_size_kib != max_zone_append_size_kib)) {
    2158           0 :                         SPDK_ERRLOG("Namespaces with different zone append support or different zone append size are not allowed.\n");
    2159           0 :                         goto err;
    2160             :                 }
    2161             : 
    2162           0 :                 subsystem->max_zone_append_size_kib = max_zone_append_size_kib;
    2163             :         }
    2164             : 
    2165           5 :         first_ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
    2166           5 :         if (!first_ns) {
    2167           4 :                 if (spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) {
    2168           1 :                         SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u has FDP capability.\n",
    2169             :                                       subsystem->id);
    2170           1 :                         subsystem->fdp_supported = true;
    2171             :                 }
    2172             :         } else {
    2173           1 :                 if (spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps !=
    2174           1 :                     spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) {
    2175           1 :                         SPDK_ERRLOG("Subsystem with id: %u can%s FDP namespace.\n", subsystem->id,
    2176             :                                     spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps ? " only add" : "not add");
    2177           1 :                         goto err;
    2178             :                 }
    2179             :         }
    2180             : 
    2181           4 :         ns->opts = opts;
    2182           4 :         ns->subsystem = subsystem;
    2183           4 :         subsystem->ns[opts.nsid - 1] = ns;
    2184           4 :         ns->nsid = opts.nsid;
    2185           4 :         ns->anagrpid = opts.anagrpid;
    2186           4 :         subsystem->ana_group[ns->anagrpid - 1]++;
    2187           4 :         TAILQ_INIT(&ns->registrants);
    2188           4 :         if (ptpl_file) {
    2189           0 :                 ns->ptpl_file = strdup(ptpl_file);
    2190           0 :                 if (!ns->ptpl_file) {
    2191           0 :                         SPDK_ERRLOG("Namespace ns->ptpl_file allocation failed\n");
    2192           0 :                         goto err;
    2193             :                 }
    2194             :         }
    2195             : 
    2196           4 :         if (nvmf_ns_is_ptpl_capable(ns)) {
    2197           1 :                 rc = nvmf_ns_reservation_load(ns, &info);
    2198           1 :                 if (rc) {
    2199           0 :                         SPDK_ERRLOG("Subsystem load reservation failed\n");
    2200           0 :                         goto err;
    2201             :                 }
    2202             : 
    2203           1 :                 rc = nvmf_ns_reservation_restore(ns, &info);
    2204           1 :                 if (rc) {
    2205           0 :                         SPDK_ERRLOG("Subsystem restore reservation failed\n");
    2206           0 :                         goto err;
    2207             :                 }
    2208             :         }
    2209             : 
    2210           4 :         for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
    2211           0 :              transport = spdk_nvmf_transport_get_next(transport)) {
    2212           0 :                 if (transport->ops->subsystem_add_ns) {
    2213           0 :                         rc = transport->ops->subsystem_add_ns(transport, subsystem, ns);
    2214           0 :                         if (rc) {
    2215           0 :                                 SPDK_ERRLOG("Namespace attachment is not allowed by %s transport\n", transport->ops->name);
    2216           0 :                                 nvmf_ns_reservation_clear_all_registrants(ns);
    2217           0 :                                 goto err;
    2218             :                         }
    2219             :                 }
    2220             :         }
    2221             : 
    2222             :         /* JSON value obj is freed before sending the response. Set NULL to prevent usage of dangling pointer. */
    2223           4 :         ns->opts.transport_specific = NULL;
    2224             : 
    2225           4 :         SPDK_DEBUGLOG(nvmf, "Subsystem %s: bdev %s assigned nsid %" PRIu32 "\n",
    2226             :                       spdk_nvmf_subsystem_get_nqn(subsystem),
    2227             :                       bdev_name,
    2228             :                       opts.nsid);
    2229             : 
    2230           4 :         nvmf_subsystem_ns_changed(subsystem, opts.nsid);
    2231             : 
    2232             :         SPDK_DTRACE_PROBE2(nvmf_subsystem_add_ns, subsystem->subnqn, ns->nsid);
    2233             : 
    2234           4 :         return opts.nsid;
    2235           1 : err:
    2236           1 :         subsystem->ns[opts.nsid - 1] = NULL;
    2237           1 :         spdk_bdev_module_release_bdev(ns->bdev);
    2238           1 :         spdk_bdev_close(ns->desc);
    2239           1 :         free(ns->ptpl_file);
    2240           1 :         free(ns);
    2241             : 
    2242           1 :         return 0;
    2243             : }
    2244             : 
    2245             : static uint32_t
    2246          19 : nvmf_subsystem_get_next_allocated_nsid(struct spdk_nvmf_subsystem *subsystem,
    2247             :                                        uint32_t prev_nsid)
    2248             : {
    2249             :         uint32_t nsid;
    2250             : 
    2251          19 :         if (prev_nsid >= subsystem->max_nsid) {
    2252           1 :                 return 0;
    2253             :         }
    2254             : 
    2255        4504 :         for (nsid = prev_nsid + 1; nsid <= subsystem->max_nsid; nsid++) {
    2256        4487 :                 if (subsystem->ns[nsid - 1]) {
    2257           1 :                         return nsid;
    2258             :                 }
    2259             :         }
    2260             : 
    2261          17 :         return 0;
    2262             : }
    2263             : 
    2264             : struct spdk_nvmf_ns *
    2265          19 : spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem)
    2266             : {
    2267             :         uint32_t first_nsid;
    2268             : 
    2269          19 :         first_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, 0);
    2270          19 :         return _nvmf_subsystem_get_ns(subsystem, first_nsid);
    2271             : }
    2272             : 
    2273             : struct spdk_nvmf_ns *
    2274           0 : spdk_nvmf_subsystem_get_next_ns(struct spdk_nvmf_subsystem *subsystem,
    2275             :                                 struct spdk_nvmf_ns *prev_ns)
    2276             : {
    2277             :         uint32_t next_nsid;
    2278             : 
    2279           0 :         next_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, prev_ns->opts.nsid);
    2280           0 :         return _nvmf_subsystem_get_ns(subsystem, next_nsid);
    2281             : }
    2282             : 
    2283             : struct spdk_nvmf_ns *
    2284           0 : spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
    2285             : {
    2286           0 :         return _nvmf_subsystem_get_ns(subsystem, nsid);
    2287             : }
    2288             : 
    2289             : uint32_t
    2290           0 : spdk_nvmf_ns_get_id(const struct spdk_nvmf_ns *ns)
    2291             : {
    2292           0 :         return ns->opts.nsid;
    2293             : }
    2294             : 
    2295             : struct spdk_bdev *
    2296           0 : spdk_nvmf_ns_get_bdev(struct spdk_nvmf_ns *ns)
    2297             : {
    2298           0 :         return ns->bdev;
    2299             : }
    2300             : 
    2301             : void
    2302           0 : spdk_nvmf_ns_get_opts(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_ns_opts *opts,
    2303             :                       size_t opts_size)
    2304             : {
    2305           0 :         memset(opts, 0, opts_size);
    2306           0 :         memcpy(opts, &ns->opts, spdk_min(sizeof(ns->opts), opts_size));
    2307           0 : }
    2308             : 
    2309             : const char *
    2310           0 : spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem)
    2311             : {
    2312           0 :         return subsystem->sn;
    2313             : }
    2314             : 
    2315             : int
    2316           4 : spdk_nvmf_subsystem_set_sn(struct spdk_nvmf_subsystem *subsystem, const char *sn)
    2317             : {
    2318             :         size_t len, max_len;
    2319             : 
    2320           4 :         max_len = sizeof(subsystem->sn) - 1;
    2321           4 :         len = strlen(sn);
    2322           4 :         if (len > max_len) {
    2323           1 :                 SPDK_DEBUGLOG(nvmf, "Invalid sn \"%s\": length %zu > max %zu\n",
    2324             :                               sn, len, max_len);
    2325           1 :                 return -1;
    2326             :         }
    2327             : 
    2328           3 :         if (!nvmf_valid_ascii_string(sn, len)) {
    2329           1 :                 SPDK_DEBUGLOG(nvmf, "Non-ASCII sn\n");
    2330           1 :                 SPDK_LOGDUMP(nvmf, "sn", sn, len);
    2331           1 :                 return -1;
    2332             :         }
    2333             : 
    2334           2 :         snprintf(subsystem->sn, sizeof(subsystem->sn), "%s", sn);
    2335             : 
    2336           2 :         return 0;
    2337             : }
    2338             : 
    2339             : const char *
    2340           0 : spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem)
    2341             : {
    2342           0 :         return subsystem->mn;
    2343             : }
    2344             : 
    2345             : int
    2346           0 : spdk_nvmf_subsystem_set_mn(struct spdk_nvmf_subsystem *subsystem, const char *mn)
    2347             : {
    2348             :         size_t len, max_len;
    2349             : 
    2350           0 :         if (mn == NULL) {
    2351           0 :                 mn = MODEL_NUMBER_DEFAULT;
    2352             :         }
    2353           0 :         max_len = sizeof(subsystem->mn) - 1;
    2354           0 :         len = strlen(mn);
    2355           0 :         if (len > max_len) {
    2356           0 :                 SPDK_DEBUGLOG(nvmf, "Invalid mn \"%s\": length %zu > max %zu\n",
    2357             :                               mn, len, max_len);
    2358           0 :                 return -1;
    2359             :         }
    2360             : 
    2361           0 :         if (!nvmf_valid_ascii_string(mn, len)) {
    2362           0 :                 SPDK_DEBUGLOG(nvmf, "Non-ASCII mn\n");
    2363           0 :                 SPDK_LOGDUMP(nvmf, "mn", mn, len);
    2364           0 :                 return -1;
    2365             :         }
    2366             : 
    2367           0 :         snprintf(subsystem->mn, sizeof(subsystem->mn), "%s", mn);
    2368             : 
    2369           0 :         return 0;
    2370             : }
    2371             : 
    2372             : const char *
    2373           0 : spdk_nvmf_subsystem_get_nqn(const struct spdk_nvmf_subsystem *subsystem)
    2374             : {
    2375           0 :         return subsystem->subnqn;
    2376             : }
    2377             : 
    2378             : /* We have to use the typedef in the function declaration to appease astyle. */
    2379             : typedef enum spdk_nvmf_subtype spdk_nvmf_subtype_t;
    2380             : 
    2381             : spdk_nvmf_subtype_t
    2382           0 : spdk_nvmf_subsystem_get_type(struct spdk_nvmf_subsystem *subsystem)
    2383             : {
    2384           0 :         return subsystem->subtype;
    2385             : }
    2386             : 
    2387             : uint32_t
    2388           0 : spdk_nvmf_subsystem_get_max_nsid(struct spdk_nvmf_subsystem *subsystem)
    2389             : {
    2390           0 :         return subsystem->max_nsid;
    2391             : }
    2392             : 
    2393             : int
    2394           0 : spdk_nvmf_subsystem_set_cntlid_range(struct spdk_nvmf_subsystem *subsystem,
    2395             :                                      uint16_t min_cntlid, uint16_t max_cntlid)
    2396             : {
    2397           0 :         if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
    2398           0 :                 return -EAGAIN;
    2399             :         }
    2400             : 
    2401           0 :         if (min_cntlid > max_cntlid) {
    2402           0 :                 return -EINVAL;
    2403             :         }
    2404             :         /* The spec reserves cntlid values in the range FFF0h to FFFFh. */
    2405           0 :         if (min_cntlid < NVMF_MIN_CNTLID || min_cntlid > NVMF_MAX_CNTLID ||
    2406           0 :             max_cntlid < NVMF_MIN_CNTLID || max_cntlid > NVMF_MAX_CNTLID) {
    2407           0 :                 return -EINVAL;
    2408             :         }
    2409           0 :         subsystem->min_cntlid = min_cntlid;
    2410           0 :         subsystem->max_cntlid = max_cntlid;
    2411           0 :         if (subsystem->next_cntlid < min_cntlid || subsystem->next_cntlid > max_cntlid - 1) {
    2412           0 :                 subsystem->next_cntlid = min_cntlid - 1;
    2413             :         }
    2414             : 
    2415           0 :         return 0;
    2416             : }
    2417             : 
    2418             : uint16_t
    2419           1 : nvmf_subsystem_gen_cntlid(struct spdk_nvmf_subsystem *subsystem)
    2420             : {
    2421             :         int count;
    2422             : 
    2423             :         /*
    2424             :          * In the worst case, we might have to try all CNTLID values between min_cntlid and max_cntlid
    2425             :          * before we find one that is unused (or find that all values are in use).
    2426             :          */
    2427           1 :         for (count = 0; count < subsystem->max_cntlid - subsystem->min_cntlid + 1; count++) {
    2428           1 :                 subsystem->next_cntlid++;
    2429           1 :                 if (subsystem->next_cntlid > subsystem->max_cntlid) {
    2430           0 :                         subsystem->next_cntlid = subsystem->min_cntlid;
    2431             :                 }
    2432             : 
    2433             :                 /* Check if a controller with this cntlid currently exists. */
    2434           1 :                 if (nvmf_subsystem_get_ctrlr(subsystem, subsystem->next_cntlid) == NULL) {
    2435             :                         /* Found unused cntlid */
    2436           1 :                         return subsystem->next_cntlid;
    2437             :                 }
    2438             :         }
    2439             : 
    2440             :         /* All valid cntlid values are in use. */
    2441           0 :         return 0xFFFF;
    2442             : }
    2443             : 
    2444             : int
    2445           1 : nvmf_subsystem_add_ctrlr(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr)
    2446             : {
    2447             : 
    2448           1 :         if (ctrlr->dynamic_ctrlr) {
    2449           1 :                 ctrlr->cntlid = nvmf_subsystem_gen_cntlid(subsystem);
    2450           1 :                 if (ctrlr->cntlid == 0xFFFF) {
    2451             :                         /* Unable to get a cntlid */
    2452           0 :                         SPDK_ERRLOG("Reached max simultaneous ctrlrs\n");
    2453           0 :                         return -EBUSY;
    2454             :                 }
    2455           0 :         } else if (nvmf_subsystem_get_ctrlr(subsystem, ctrlr->cntlid) != NULL) {
    2456           0 :                 SPDK_ERRLOG("Ctrlr with cntlid %u already exist\n", ctrlr->cntlid);
    2457           0 :                 return -EEXIST;
    2458             :         }
    2459             : 
    2460           1 :         TAILQ_INSERT_TAIL(&subsystem->ctrlrs, ctrlr, link);
    2461             : 
    2462             :         SPDK_DTRACE_PROBE3(nvmf_subsystem_add_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn);
    2463             : 
    2464           1 :         return 0;
    2465             : }
    2466             : 
    2467             : void
    2468           1 : nvmf_subsystem_remove_ctrlr(struct spdk_nvmf_subsystem *subsystem,
    2469             :                             struct spdk_nvmf_ctrlr *ctrlr)
    2470             : {
    2471             :         SPDK_DTRACE_PROBE3(nvmf_subsystem_remove_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn);
    2472             : 
    2473           1 :         assert(spdk_get_thread() == subsystem->thread);
    2474           1 :         assert(subsystem == ctrlr->subsys);
    2475           1 :         SPDK_DEBUGLOG(nvmf, "remove ctrlr %p id 0x%x from subsys %p %s\n", ctrlr, ctrlr->cntlid, subsystem,
    2476             :                       subsystem->subnqn);
    2477           1 :         TAILQ_REMOVE(&subsystem->ctrlrs, ctrlr, link);
    2478           1 : }
    2479             : 
    2480             : struct spdk_nvmf_ctrlr *
    2481           2 : nvmf_subsystem_get_ctrlr(struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid)
    2482             : {
    2483             :         struct spdk_nvmf_ctrlr *ctrlr;
    2484             : 
    2485           2 :         TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
    2486           1 :                 if (ctrlr->cntlid == cntlid) {
    2487           1 :                         return ctrlr;
    2488             :                 }
    2489             :         }
    2490             : 
    2491           1 :         return NULL;
    2492             : }
    2493             : 
    2494             : uint32_t
    2495           0 : spdk_nvmf_subsystem_get_max_namespaces(const struct spdk_nvmf_subsystem *subsystem)
    2496             : {
    2497           0 :         return subsystem->max_nsid;
    2498             : }
    2499             : 
    2500             : uint16_t
    2501           0 : spdk_nvmf_subsystem_get_min_cntlid(const struct spdk_nvmf_subsystem *subsystem)
    2502             : {
    2503           0 :         return subsystem->min_cntlid;
    2504             : }
    2505             : 
    2506             : uint16_t
    2507           0 : spdk_nvmf_subsystem_get_max_cntlid(const struct spdk_nvmf_subsystem *subsystem)
    2508             : {
    2509           0 :         return subsystem->max_cntlid;
    2510             : }
    2511             : 
    2512             : struct _nvmf_ns_registrant {
    2513             :         uint64_t                rkey;
    2514             :         char                    *host_uuid;
    2515             : };
    2516             : 
    2517             : struct _nvmf_ns_registrants {
    2518             :         size_t                          num_regs;
    2519             :         struct _nvmf_ns_registrant      reg[SPDK_NVMF_MAX_NUM_REGISTRANTS];
    2520             : };
    2521             : 
    2522             : struct _nvmf_ns_reservation {
    2523             :         bool                                    ptpl_activated;
    2524             :         enum spdk_nvme_reservation_type         rtype;
    2525             :         uint64_t                                crkey;
    2526             :         char                                    *bdev_uuid;
    2527             :         char                                    *holder_uuid;
    2528             :         struct _nvmf_ns_registrants             regs;
    2529             : };
    2530             : 
    2531             : static const struct spdk_json_object_decoder nvmf_ns_pr_reg_decoders[] = {
    2532             :         {"rkey", offsetof(struct _nvmf_ns_registrant, rkey), spdk_json_decode_uint64},
    2533             :         {"host_uuid", offsetof(struct _nvmf_ns_registrant, host_uuid), spdk_json_decode_string},
    2534             : };
    2535             : 
    2536             : static int
    2537           4 : nvmf_decode_ns_pr_reg(const struct spdk_json_val *val, void *out)
    2538             : {
    2539           4 :         struct _nvmf_ns_registrant *reg = out;
    2540             : 
    2541           4 :         return spdk_json_decode_object(val, nvmf_ns_pr_reg_decoders,
    2542             :                                        SPDK_COUNTOF(nvmf_ns_pr_reg_decoders), reg);
    2543             : }
    2544             : 
    2545             : static int
    2546           4 : nvmf_decode_ns_pr_regs(const struct spdk_json_val *val, void *out)
    2547             : {
    2548           4 :         struct _nvmf_ns_registrants *regs = out;
    2549             : 
    2550           4 :         return spdk_json_decode_array(val, nvmf_decode_ns_pr_reg, regs->reg,
    2551             :                                       SPDK_NVMF_MAX_NUM_REGISTRANTS, &regs->num_regs,
    2552             :                                       sizeof(struct _nvmf_ns_registrant));
    2553             : }
    2554             : 
    2555             : static const struct spdk_json_object_decoder nvmf_ns_pr_decoders[] = {
    2556             :         {"ptpl", offsetof(struct _nvmf_ns_reservation, ptpl_activated), spdk_json_decode_bool, true},
    2557             :         {"rtype", offsetof(struct _nvmf_ns_reservation, rtype), spdk_json_decode_uint32, true},
    2558             :         {"crkey", offsetof(struct _nvmf_ns_reservation, crkey), spdk_json_decode_uint64, true},
    2559             :         {"bdev_uuid", offsetof(struct _nvmf_ns_reservation, bdev_uuid), spdk_json_decode_string},
    2560             :         {"holder_uuid", offsetof(struct _nvmf_ns_reservation, holder_uuid), spdk_json_decode_string, true},
    2561             :         {"registrants", offsetof(struct _nvmf_ns_reservation, regs), nvmf_decode_ns_pr_regs},
    2562             : };
    2563             : 
    2564             : static int
    2565           5 : nvmf_ns_reservation_load_json(const struct spdk_nvmf_ns *ns,
    2566             :                               struct spdk_nvmf_reservation_info *info)
    2567             : {
    2568           5 :         size_t json_size;
    2569             :         ssize_t values_cnt, rc;
    2570           5 :         void *json = NULL, *end;
    2571           5 :         struct spdk_json_val *values = NULL;
    2572           5 :         struct _nvmf_ns_reservation res = {};
    2573           5 :         const char *file = ns->ptpl_file;
    2574             :         uint32_t i;
    2575             : 
    2576             :         /* It's not an error if the file does not exist */
    2577           5 :         if (access(file, F_OK) != 0) {
    2578           0 :                 SPDK_DEBUGLOG(nvmf, "File %s does not exist\n", file);
    2579           0 :                 return 0;
    2580             :         }
    2581             : 
    2582             :         /* Load all persist file contents into a local buffer */
    2583           5 :         json = spdk_posix_file_load_from_name(file, &json_size);
    2584           5 :         if (!json) {
    2585           0 :                 SPDK_ERRLOG("Load persist file %s failed\n", file);
    2586           0 :                 return -ENOMEM;
    2587             :         }
    2588             : 
    2589           5 :         rc = spdk_json_parse(json, json_size, NULL, 0, &end, 0);
    2590           5 :         if (rc < 0) {
    2591           1 :                 SPDK_NOTICELOG("Parsing JSON configuration failed (%zd)\n", rc);
    2592           1 :                 goto exit;
    2593             :         }
    2594             : 
    2595           4 :         values_cnt = rc;
    2596           4 :         values = calloc(values_cnt, sizeof(struct spdk_json_val));
    2597           4 :         if (values == NULL) {
    2598           0 :                 goto exit;
    2599             :         }
    2600             : 
    2601           4 :         rc = spdk_json_parse(json, json_size, values, values_cnt, &end, 0);
    2602           4 :         if (rc != values_cnt) {
    2603           0 :                 SPDK_ERRLOG("Parsing JSON configuration failed (%zd)\n", rc);
    2604           0 :                 goto exit;
    2605             :         }
    2606             : 
    2607             :         /* Decode json */
    2608           4 :         if (spdk_json_decode_object(values, nvmf_ns_pr_decoders,
    2609             :                                     SPDK_COUNTOF(nvmf_ns_pr_decoders),
    2610             :                                     &res)) {
    2611           0 :                 SPDK_ERRLOG("Invalid objects in the persist file %s\n", file);
    2612           0 :                 rc = -EINVAL;
    2613           0 :                 goto exit;
    2614             :         }
    2615             : 
    2616           4 :         if (res.regs.num_regs > SPDK_NVMF_MAX_NUM_REGISTRANTS) {
    2617           0 :                 SPDK_ERRLOG("Can only support up to %u registrants\n", SPDK_NVMF_MAX_NUM_REGISTRANTS);
    2618           0 :                 rc = -ERANGE;
    2619           0 :                 goto exit;
    2620             :         }
    2621             : 
    2622           4 :         rc = 0;
    2623           4 :         info->ptpl_activated = res.ptpl_activated;
    2624           4 :         info->rtype = res.rtype;
    2625           4 :         info->crkey = res.crkey;
    2626           4 :         snprintf(info->bdev_uuid, sizeof(info->bdev_uuid), "%s", res.bdev_uuid);
    2627           4 :         snprintf(info->holder_uuid, sizeof(info->holder_uuid), "%s", res.holder_uuid);
    2628           4 :         info->num_regs = res.regs.num_regs;
    2629           8 :         for (i = 0; i < res.regs.num_regs; i++) {
    2630           4 :                 info->registrants[i].rkey = res.regs.reg[i].rkey;
    2631           4 :                 snprintf(info->registrants[i].host_uuid, sizeof(info->registrants[i].host_uuid), "%s",
    2632             :                          res.regs.reg[i].host_uuid);
    2633             :         }
    2634             : 
    2635           5 : exit:
    2636           5 :         free(json);
    2637           5 :         free(values);
    2638           5 :         free(res.bdev_uuid);
    2639           5 :         free(res.holder_uuid);
    2640           9 :         for (i = 0; i < res.regs.num_regs; i++) {
    2641           4 :                 free(res.regs.reg[i].host_uuid);
    2642             :         }
    2643             : 
    2644           5 :         return rc;
    2645             : }
    2646             : 
    2647             : static bool nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns);
    2648             : 
    2649             : static int
    2650           5 : nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info)
    2651             : {
    2652             :         uint32_t i;
    2653           5 :         struct spdk_nvmf_registrant *reg, *holder = NULL;
    2654           5 :         struct spdk_uuid bdev_uuid, holder_uuid;
    2655           5 :         bool rkey_flag = false;
    2656             : 
    2657           5 :         SPDK_DEBUGLOG(nvmf, "NSID %u, PTPL %u, Number of registrants %u\n",
    2658             :                       ns->nsid, info->ptpl_activated, info->num_regs);
    2659             : 
    2660             :         /* it's not an error */
    2661           5 :         if (!info->ptpl_activated || !info->num_regs) {
    2662           0 :                 return 0;
    2663             :         }
    2664             : 
    2665             :         /* Check info->crkey exist or not in info->registrants[i].rkey */
    2666          14 :         for (i = 0; i < info->num_regs; i++) {
    2667           9 :                 if (info->crkey == info->registrants[i].rkey) {
    2668           3 :                         rkey_flag = true;
    2669             :                 }
    2670             :         }
    2671           5 :         if (!rkey_flag && info->crkey != 0) {
    2672           1 :                 return -EINVAL;
    2673             :         }
    2674             : 
    2675           4 :         spdk_uuid_parse(&bdev_uuid, info->bdev_uuid);
    2676           4 :         if (spdk_uuid_compare(&bdev_uuid, spdk_bdev_get_uuid(ns->bdev))) {
    2677           1 :                 SPDK_ERRLOG("Existing bdev UUID is not same with configuration file\n");
    2678           1 :                 return -EINVAL;
    2679             :         }
    2680             : 
    2681           3 :         ns->crkey = info->crkey;
    2682           3 :         ns->rtype = info->rtype;
    2683           3 :         ns->ptpl_activated = info->ptpl_activated;
    2684           3 :         spdk_uuid_parse(&holder_uuid, info->holder_uuid);
    2685             : 
    2686           3 :         SPDK_DEBUGLOG(nvmf, "Bdev UUID %s\n", info->bdev_uuid);
    2687           3 :         if (info->rtype) {
    2688           2 :                 SPDK_DEBUGLOG(nvmf, "Holder UUID %s, RTYPE %u, RKEY 0x%"PRIx64"\n",
    2689             :                               info->holder_uuid, info->rtype, info->crkey);
    2690             :         }
    2691             : 
    2692           8 :         for (i = 0; i < info->num_regs; i++) {
    2693           5 :                 reg = calloc(1, sizeof(*reg));
    2694           5 :                 if (!reg) {
    2695           0 :                         return -ENOMEM;
    2696             :                 }
    2697           5 :                 spdk_uuid_parse(&reg->hostid, info->registrants[i].host_uuid);
    2698           5 :                 reg->rkey = info->registrants[i].rkey;
    2699           5 :                 TAILQ_INSERT_TAIL(&ns->registrants, reg, link);
    2700           5 :                 if (info->crkey != 0 && !spdk_uuid_compare(&holder_uuid, &reg->hostid)) {
    2701           2 :                         holder = reg;
    2702             :                 }
    2703           5 :                 SPDK_DEBUGLOG(nvmf, "Registrant RKEY 0x%"PRIx64", Host UUID %s\n",
    2704             :                               info->registrants[i].rkey, info->registrants[i].host_uuid);
    2705             :         }
    2706             : 
    2707           3 :         if (nvmf_ns_reservation_all_registrants_type(ns)) {
    2708           1 :                 ns->holder = TAILQ_FIRST(&ns->registrants);
    2709             :         } else {
    2710           2 :                 ns->holder = holder;
    2711             :         }
    2712             : 
    2713           3 :         return 0;
    2714             : }
    2715             : 
    2716             : static int
    2717           5 : nvmf_ns_json_write_cb(void *cb_ctx, const void *data, size_t size)
    2718             : {
    2719           5 :         char *file = cb_ctx;
    2720             :         size_t rc;
    2721             :         FILE *fd;
    2722             : 
    2723           5 :         fd = fopen(file, "w");
    2724           5 :         if (!fd) {
    2725           0 :                 SPDK_ERRLOG("Can't open file %s for write\n", file);
    2726           0 :                 return -ENOENT;
    2727             :         }
    2728           5 :         rc = fwrite(data, 1, size, fd);
    2729           5 :         fclose(fd);
    2730             : 
    2731           5 :         return rc == size ? 0 : -1;
    2732             : }
    2733             : 
    2734             : static int
    2735           5 : nvmf_ns_reservation_update_json(const struct spdk_nvmf_ns *ns,
    2736             :                                 const struct spdk_nvmf_reservation_info *info)
    2737             : {
    2738           5 :         const char *file = ns->ptpl_file;
    2739             :         struct spdk_json_write_ctx *w;
    2740             :         uint32_t i;
    2741           5 :         int rc = 0;
    2742             : 
    2743           5 :         w = spdk_json_write_begin(nvmf_ns_json_write_cb, (void *)file, 0);
    2744           5 :         if (w == NULL) {
    2745           0 :                 return -ENOMEM;
    2746             :         }
    2747             :         /* clear the configuration file */
    2748           5 :         if (!info->ptpl_activated) {
    2749           1 :                 goto exit;
    2750             :         }
    2751             : 
    2752           4 :         spdk_json_write_object_begin(w);
    2753           4 :         spdk_json_write_named_bool(w, "ptpl", info->ptpl_activated);
    2754           4 :         spdk_json_write_named_uint32(w, "rtype", info->rtype);
    2755           4 :         spdk_json_write_named_uint64(w, "crkey", info->crkey);
    2756           4 :         spdk_json_write_named_string(w, "bdev_uuid", info->bdev_uuid);
    2757           4 :         spdk_json_write_named_string(w, "holder_uuid", info->holder_uuid);
    2758             : 
    2759           4 :         spdk_json_write_named_array_begin(w, "registrants");
    2760           8 :         for (i = 0; i < info->num_regs; i++) {
    2761           4 :                 spdk_json_write_object_begin(w);
    2762           4 :                 spdk_json_write_named_uint64(w, "rkey", info->registrants[i].rkey);
    2763           4 :                 spdk_json_write_named_string(w, "host_uuid", info->registrants[i].host_uuid);
    2764           4 :                 spdk_json_write_object_end(w);
    2765             :         }
    2766           4 :         spdk_json_write_array_end(w);
    2767           4 :         spdk_json_write_object_end(w);
    2768             : 
    2769           5 : exit:
    2770           5 :         rc = spdk_json_write_end(w);
    2771           5 :         return rc;
    2772             : }
    2773             : 
    2774             : static int
    2775           7 : nvmf_ns_update_reservation_info(struct spdk_nvmf_ns *ns)
    2776             : {
    2777           7 :         struct spdk_nvmf_reservation_info info;
    2778             :         struct spdk_nvmf_registrant *reg, *tmp;
    2779           7 :         uint32_t i = 0;
    2780             : 
    2781           7 :         assert(ns != NULL);
    2782             : 
    2783           7 :         if (!ns->bdev || !nvmf_ns_is_ptpl_capable(ns)) {
    2784           0 :                 return 0;
    2785             :         }
    2786             : 
    2787           7 :         memset(&info, 0, sizeof(info));
    2788           7 :         spdk_uuid_fmt_lower(info.bdev_uuid, sizeof(info.bdev_uuid), spdk_bdev_get_uuid(ns->bdev));
    2789             : 
    2790           7 :         if (ns->rtype) {
    2791           2 :                 info.rtype = ns->rtype;
    2792           2 :                 info.crkey = ns->crkey;
    2793           2 :                 if (!nvmf_ns_reservation_all_registrants_type(ns)) {
    2794           2 :                         assert(ns->holder != NULL);
    2795           2 :                         spdk_uuid_fmt_lower(info.holder_uuid, sizeof(info.holder_uuid), &ns->holder->hostid);
    2796             :                 }
    2797             :         }
    2798             : 
    2799          14 :         TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
    2800           7 :                 spdk_uuid_fmt_lower(info.registrants[i].host_uuid, sizeof(info.registrants[i].host_uuid),
    2801           7 :                                     &reg->hostid);
    2802           7 :                 info.registrants[i++].rkey = reg->rkey;
    2803             :         }
    2804             : 
    2805           7 :         info.num_regs = i;
    2806           7 :         info.ptpl_activated = ns->ptpl_activated;
    2807             : 
    2808           7 :         return nvmf_ns_reservation_update(ns, &info);
    2809             : }
    2810             : 
    2811             : static struct spdk_nvmf_registrant *
    2812         110 : nvmf_ns_reservation_get_registrant(struct spdk_nvmf_ns *ns,
    2813             :                                    struct spdk_uuid *uuid)
    2814             : {
    2815             :         struct spdk_nvmf_registrant *reg, *tmp;
    2816             : 
    2817         191 :         TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
    2818         151 :                 if (!spdk_uuid_compare(&reg->hostid, uuid)) {
    2819          70 :                         return reg;
    2820             :                 }
    2821             :         }
    2822             : 
    2823          40 :         return NULL;
    2824             : }
    2825             : 
    2826             : /* Generate reservation notice log to registered HostID controllers */
    2827             : static void
    2828          10 : nvmf_subsystem_gen_ctrlr_notification(struct spdk_nvmf_subsystem *subsystem,
    2829             :                                       struct spdk_nvmf_ns *ns,
    2830             :                                       struct spdk_uuid *hostid_list,
    2831             :                                       uint32_t num_hostid,
    2832             :                                       enum spdk_nvme_reservation_notification_log_page_type type)
    2833             : {
    2834             :         struct spdk_nvmf_ctrlr *ctrlr;
    2835             :         uint32_t i;
    2836             : 
    2837          25 :         for (i = 0; i < num_hostid; i++) {
    2838          75 :                 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
    2839          60 :                         if (!spdk_uuid_compare(&ctrlr->hostid, &hostid_list[i])) {
    2840          22 :                                 nvmf_ctrlr_reservation_notice_log(ctrlr, ns, type);
    2841             :                         }
    2842             :                 }
    2843             :         }
    2844          10 : }
    2845             : 
    2846             : /* Get all registrants' hostid other than the controller who issued the command */
    2847             : static uint32_t
    2848          16 : nvmf_ns_reservation_get_all_other_hostid(struct spdk_nvmf_ns *ns,
    2849             :                 struct spdk_uuid *hostid_list,
    2850             :                 uint32_t max_num_hostid,
    2851             :                 struct spdk_uuid *current_hostid)
    2852             : {
    2853             :         struct spdk_nvmf_registrant *reg, *tmp;
    2854          16 :         uint32_t num_hostid = 0;
    2855             : 
    2856          55 :         TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
    2857          39 :                 if (spdk_uuid_compare(&reg->hostid, current_hostid)) {
    2858          23 :                         if (num_hostid == max_num_hostid) {
    2859           0 :                                 assert(false);
    2860             :                                 return max_num_hostid;
    2861             :                         }
    2862          23 :                         hostid_list[num_hostid++] = reg->hostid;
    2863             :                 }
    2864             :         }
    2865             : 
    2866          16 :         return num_hostid;
    2867             : }
    2868             : 
    2869             : /* Calculate the unregistered HostID list according to list
    2870             :  * prior to execute preempt command and list after executing
    2871             :  * preempt command.
    2872             :  */
    2873             : static uint32_t
    2874           3 : nvmf_ns_reservation_get_unregistered_hostid(struct spdk_uuid *old_hostid_list,
    2875             :                 uint32_t old_num_hostid,
    2876             :                 struct spdk_uuid *remaining_hostid_list,
    2877             :                 uint32_t remaining_num_hostid)
    2878             : {
    2879           3 :         struct spdk_uuid temp_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
    2880           3 :         uint32_t i, j, num_hostid = 0;
    2881             :         bool found;
    2882             : 
    2883           3 :         if (!remaining_num_hostid) {
    2884           1 :                 return old_num_hostid;
    2885             :         }
    2886             : 
    2887           6 :         for (i = 0; i < old_num_hostid; i++) {
    2888           4 :                 found = false;
    2889           6 :                 for (j = 0; j < remaining_num_hostid; j++) {
    2890           4 :                         if (!spdk_uuid_compare(&old_hostid_list[i], &remaining_hostid_list[j])) {
    2891           2 :                                 found = true;
    2892           2 :                                 break;
    2893             :                         }
    2894             :                 }
    2895           4 :                 if (!found) {
    2896           2 :                         spdk_uuid_copy(&temp_hostid_list[num_hostid++], &old_hostid_list[i]);
    2897             :                 }
    2898             :         }
    2899             : 
    2900           2 :         if (num_hostid) {
    2901           2 :                 memcpy(old_hostid_list, temp_hostid_list, sizeof(struct spdk_uuid) * num_hostid);
    2902             :         }
    2903             : 
    2904           2 :         return num_hostid;
    2905             : }
    2906             : 
    2907             : /* current reservation type is all registrants or not */
    2908             : static bool
    2909          54 : nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns)
    2910             : {
    2911         102 :         return (ns->rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS ||
    2912          48 :                 ns->rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS);
    2913             : }
    2914             : 
    2915             : /* current registrant is reservation holder or not */
    2916             : static bool
    2917          26 : nvmf_ns_reservation_registrant_is_holder(struct spdk_nvmf_ns *ns,
    2918             :                 struct spdk_nvmf_registrant *reg)
    2919             : {
    2920          26 :         if (!reg) {
    2921           0 :                 return false;
    2922             :         }
    2923             : 
    2924          26 :         if (nvmf_ns_reservation_all_registrants_type(ns)) {
    2925           2 :                 return true;
    2926             :         }
    2927             : 
    2928          24 :         return (ns->holder == reg);
    2929             : }
    2930             : 
    2931             : static int
    2932          29 : nvmf_ns_reservation_add_registrant(struct spdk_nvmf_ns *ns,
    2933             :                                    struct spdk_nvmf_ctrlr *ctrlr,
    2934             :                                    uint64_t nrkey)
    2935             : {
    2936             :         struct spdk_nvmf_registrant *reg;
    2937             : 
    2938          29 :         reg = calloc(1, sizeof(*reg));
    2939          29 :         if (!reg) {
    2940           0 :                 return -ENOMEM;
    2941             :         }
    2942             : 
    2943          29 :         reg->rkey = nrkey;
    2944             :         /* set hostid for the registrant */
    2945          29 :         spdk_uuid_copy(&reg->hostid, &ctrlr->hostid);
    2946          29 :         TAILQ_INSERT_TAIL(&ns->registrants, reg, link);
    2947          29 :         ns->gen++;
    2948             : 
    2949          29 :         return 0;
    2950             : }
    2951             : 
    2952             : static void
    2953          11 : nvmf_ns_reservation_release_reservation(struct spdk_nvmf_ns *ns)
    2954             : {
    2955          11 :         ns->rtype = 0;
    2956          11 :         ns->crkey = 0;
    2957          11 :         ns->holder = NULL;
    2958          11 : }
    2959             : 
    2960             : /* release the reservation if the last registrant was removed */
    2961             : static void
    2962          19 : nvmf_ns_reservation_check_release_on_remove_registrant(struct spdk_nvmf_ns *ns,
    2963             :                 struct spdk_nvmf_registrant *reg)
    2964             : {
    2965             :         struct spdk_nvmf_registrant *next_reg;
    2966             : 
    2967             :         /* no reservation holder */
    2968          19 :         if (!ns->holder) {
    2969           7 :                 assert(ns->rtype == 0);
    2970           7 :                 return;
    2971             :         }
    2972             : 
    2973          12 :         next_reg = TAILQ_FIRST(&ns->registrants);
    2974          12 :         if (next_reg && nvmf_ns_reservation_all_registrants_type(ns)) {
    2975             :                 /* the next valid registrant is the new holder now */
    2976           2 :                 ns->holder = next_reg;
    2977          10 :         } else if (nvmf_ns_reservation_registrant_is_holder(ns, reg)) {
    2978             :                 /* release the reservation */
    2979           7 :                 nvmf_ns_reservation_release_reservation(ns);
    2980             :         }
    2981             : }
    2982             : 
    2983             : static void
    2984          19 : nvmf_ns_reservation_remove_registrant(struct spdk_nvmf_ns *ns,
    2985             :                                       struct spdk_nvmf_registrant *reg)
    2986             : {
    2987          19 :         TAILQ_REMOVE(&ns->registrants, reg, link);
    2988          19 :         nvmf_ns_reservation_check_release_on_remove_registrant(ns, reg);
    2989          19 :         free(reg);
    2990          19 :         ns->gen++;
    2991          19 :         return;
    2992             : }
    2993             : 
    2994             : static uint32_t
    2995           0 : nvmf_ns_reservation_remove_registrants_by_key(struct spdk_nvmf_ns *ns,
    2996             :                 uint64_t rkey)
    2997             : {
    2998             :         struct spdk_nvmf_registrant *reg, *tmp;
    2999           0 :         uint32_t count = 0;
    3000             : 
    3001           0 :         TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
    3002           0 :                 if (reg->rkey == rkey) {
    3003           0 :                         nvmf_ns_reservation_remove_registrant(ns, reg);
    3004           0 :                         count++;
    3005             :                 }
    3006             :         }
    3007           0 :         return count;
    3008             : }
    3009             : 
    3010             : static uint32_t
    3011           1 : nvmf_ns_reservation_remove_all_other_registrants(struct spdk_nvmf_ns *ns,
    3012             :                 struct spdk_nvmf_registrant *reg)
    3013             : {
    3014             :         struct spdk_nvmf_registrant *reg_tmp, *reg_tmp2;
    3015           1 :         uint32_t count = 0;
    3016             : 
    3017           3 :         TAILQ_FOREACH_SAFE(reg_tmp, &ns->registrants, link, reg_tmp2) {
    3018           2 :                 if (reg_tmp != reg) {
    3019           1 :                         nvmf_ns_reservation_remove_registrant(ns, reg_tmp);
    3020           1 :                         count++;
    3021             :                 }
    3022             :         }
    3023           1 :         return count;
    3024             : }
    3025             : 
    3026             : static uint32_t
    3027           9 : nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns)
    3028             : {
    3029             :         struct spdk_nvmf_registrant *reg, *reg_tmp;
    3030           9 :         uint32_t count = 0;
    3031             : 
    3032          20 :         TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, reg_tmp) {
    3033          11 :                 nvmf_ns_reservation_remove_registrant(ns, reg);
    3034          11 :                 count++;
    3035             :         }
    3036           9 :         return count;
    3037             : }
    3038             : 
    3039             : static void
    3040          12 : nvmf_ns_reservation_acquire_reservation(struct spdk_nvmf_ns *ns, uint64_t rkey,
    3041             :                                         enum spdk_nvme_reservation_type rtype,
    3042             :                                         struct spdk_nvmf_registrant *holder)
    3043             : {
    3044          12 :         ns->rtype = rtype;
    3045          12 :         ns->crkey = rkey;
    3046          12 :         assert(ns->holder == NULL);
    3047          12 :         ns->holder = holder;
    3048          12 : }
    3049             : 
    3050             : static bool
    3051          45 : nvmf_ns_reservation_register(struct spdk_nvmf_ns *ns,
    3052             :                              struct spdk_nvmf_ctrlr *ctrlr,
    3053             :                              struct spdk_nvmf_request *req)
    3054             : {
    3055          45 :         struct spdk_nvme_reservation_register_data key = { 0 };
    3056          45 :         struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
    3057             :         uint8_t rrega, iekey, cptpl, rtype;
    3058             :         struct spdk_nvmf_registrant *reg;
    3059          45 :         uint8_t status = SPDK_NVME_SC_SUCCESS;
    3060          45 :         bool update_sgroup = false;
    3061          45 :         struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
    3062          45 :         uint32_t num_hostid = 0;
    3063             :         int rc;
    3064             : 
    3065          45 :         rrega = cmd->cdw10_bits.resv_register.rrega;
    3066          45 :         iekey = cmd->cdw10_bits.resv_register.iekey;
    3067          45 :         cptpl = cmd->cdw10_bits.resv_register.cptpl;
    3068             : 
    3069          45 :         if (req->iovcnt > 0 && req->length >= sizeof(key)) {
    3070          45 :                 struct spdk_iov_xfer ix;
    3071          45 :                 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
    3072          45 :                 spdk_iov_xfer_to_buf(&ix, &key, sizeof(key));
    3073             :         } else {
    3074           0 :                 SPDK_ERRLOG("No key provided. Failing request.\n");
    3075           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3076           0 :                 goto exit;
    3077             :         }
    3078             : 
    3079          45 :         SPDK_DEBUGLOG(nvmf, "REGISTER: RREGA %u, IEKEY %u, CPTPL %u, "
    3080             :                       "NRKEY 0x%"PRIx64", NRKEY 0x%"PRIx64"\n",
    3081             :                       rrega, iekey, cptpl, key.crkey, key.nrkey);
    3082             : 
    3083          45 :         if (cptpl == SPDK_NVME_RESERVE_PTPL_CLEAR_POWER_ON) {
    3084             :                 /* True to OFF state, and need to be updated in the configuration file */
    3085           1 :                 if (ns->ptpl_activated) {
    3086           1 :                         ns->ptpl_activated = 0;
    3087           1 :                         update_sgroup = true;
    3088             :                 }
    3089          44 :         } else if (cptpl == SPDK_NVME_RESERVE_PTPL_PERSIST_POWER_LOSS) {
    3090           4 :                 if (!nvmf_ns_is_ptpl_capable(ns)) {
    3091           1 :                         status = SPDK_NVME_SC_INVALID_FIELD;
    3092           1 :                         goto exit;
    3093           3 :                 } else if (ns->ptpl_activated == 0) {
    3094           3 :                         ns->ptpl_activated = 1;
    3095           3 :                         update_sgroup = true;
    3096             :                 }
    3097             :         }
    3098             : 
    3099             :         /* current Host Identifier has registrant or not */
    3100          44 :         reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
    3101             : 
    3102          44 :         switch (rrega) {
    3103          36 :         case SPDK_NVME_RESERVE_REGISTER_KEY:
    3104          36 :                 if (!reg) {
    3105             :                         /* register new controller */
    3106          27 :                         if (key.nrkey == 0) {
    3107           0 :                                 SPDK_ERRLOG("Can't register zeroed new key\n");
    3108           0 :                                 status = SPDK_NVME_SC_INVALID_FIELD;
    3109           0 :                                 goto exit;
    3110             :                         }
    3111          27 :                         rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey);
    3112          27 :                         if (rc < 0) {
    3113           0 :                                 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
    3114           0 :                                 goto exit;
    3115             :                         }
    3116          27 :                         update_sgroup = true;
    3117             :                 } else {
    3118             :                         /* register with same key is not an error */
    3119           9 :                         if (reg->rkey != key.nrkey) {
    3120           8 :                                 SPDK_ERRLOG("The same host already register a "
    3121             :                                             "key with 0x%"PRIx64"\n",
    3122             :                                             reg->rkey);
    3123           8 :                                 status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3124           8 :                                 goto exit;
    3125             :                         }
    3126             :                 }
    3127          28 :                 break;
    3128           4 :         case SPDK_NVME_RESERVE_UNREGISTER_KEY:
    3129           4 :                 if (!reg || (!iekey && reg->rkey != key.crkey)) {
    3130           0 :                         SPDK_ERRLOG("No registrant or current key doesn't match "
    3131             :                                     "with existing registrant key\n");
    3132           0 :                         status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3133           0 :                         goto exit;
    3134             :                 }
    3135             : 
    3136           4 :                 rtype = ns->rtype;
    3137           4 :                 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
    3138             :                                 SPDK_NVMF_MAX_NUM_REGISTRANTS,
    3139             :                                 &ctrlr->hostid);
    3140             : 
    3141           4 :                 nvmf_ns_reservation_remove_registrant(ns, reg);
    3142             : 
    3143           4 :                 if (!ns->rtype && num_hostid && (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_REG_ONLY ||
    3144             :                                                  rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY)) {
    3145           1 :                         nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
    3146             :                                                               hostid_list,
    3147             :                                                               num_hostid,
    3148             :                                                               SPDK_NVME_RESERVATION_RELEASED);
    3149             :                 }
    3150           4 :                 update_sgroup = true;
    3151           4 :                 break;
    3152           4 :         case SPDK_NVME_RESERVE_REPLACE_KEY:
    3153           4 :                 if (key.nrkey == 0) {
    3154           0 :                         SPDK_ERRLOG("Can't register zeroed new key\n");
    3155           0 :                         status = SPDK_NVME_SC_INVALID_FIELD;
    3156           0 :                         goto exit;
    3157             :                 }
    3158             :                 /* Registrant exists */
    3159           4 :                 if (reg) {
    3160           2 :                         if (!iekey && reg->rkey != key.crkey) {
    3161           0 :                                 SPDK_ERRLOG("Current key doesn't match "
    3162             :                                             "existing registrant key\n");
    3163           0 :                                 status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3164           0 :                                 goto exit;
    3165             :                         }
    3166           2 :                         if (reg->rkey == key.nrkey) {
    3167           0 :                                 goto exit;
    3168             :                         }
    3169           2 :                         reg->rkey = key.nrkey;
    3170           2 :                 } else if (iekey) { /* No registrant but IEKEY is set */
    3171             :                         /* new registrant */
    3172           1 :                         rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey);
    3173           1 :                         if (rc < 0) {
    3174           0 :                                 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
    3175           0 :                                 goto exit;
    3176             :                         }
    3177             :                 } else { /* No registrant */
    3178           1 :                         SPDK_ERRLOG("No registrant\n");
    3179           1 :                         status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3180           1 :                         goto exit;
    3181             : 
    3182             :                 }
    3183           3 :                 update_sgroup = true;
    3184           3 :                 break;
    3185           0 :         default:
    3186           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3187           0 :                 goto exit;
    3188             :         }
    3189             : 
    3190          45 : exit:
    3191          45 :         req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
    3192          45 :         req->rsp->nvme_cpl.status.sc = status;
    3193          45 :         return update_sgroup;
    3194             : }
    3195             : 
    3196             : static bool
    3197          13 : nvmf_ns_reservation_acquire(struct spdk_nvmf_ns *ns,
    3198             :                             struct spdk_nvmf_ctrlr *ctrlr,
    3199             :                             struct spdk_nvmf_request *req)
    3200             : {
    3201          13 :         struct spdk_nvme_reservation_acquire_data key = { 0 };
    3202          13 :         struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
    3203             :         uint8_t racqa, iekey, rtype;
    3204             :         struct spdk_nvmf_registrant *reg;
    3205          13 :         bool all_regs = false;
    3206          13 :         uint32_t count = 0;
    3207          13 :         bool update_sgroup = true;
    3208          13 :         struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
    3209          13 :         uint32_t num_hostid = 0;
    3210          13 :         struct spdk_uuid new_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
    3211          13 :         uint32_t new_num_hostid = 0;
    3212          13 :         bool reservation_released = false;
    3213          13 :         uint8_t status = SPDK_NVME_SC_SUCCESS;
    3214             : 
    3215          13 :         racqa = cmd->cdw10_bits.resv_acquire.racqa;
    3216          13 :         iekey = cmd->cdw10_bits.resv_acquire.iekey;
    3217          13 :         rtype = cmd->cdw10_bits.resv_acquire.rtype;
    3218             : 
    3219          13 :         if (req->iovcnt > 0 && req->length >= sizeof(key)) {
    3220          13 :                 struct spdk_iov_xfer ix;
    3221          13 :                 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
    3222          13 :                 spdk_iov_xfer_to_buf(&ix, &key, sizeof(key));
    3223             :         } else {
    3224           0 :                 SPDK_ERRLOG("No key provided. Failing request.\n");
    3225           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3226           0 :                 goto exit;
    3227             :         }
    3228             : 
    3229          13 :         SPDK_DEBUGLOG(nvmf, "ACQUIRE: RACQA %u, IEKEY %u, RTYPE %u, "
    3230             :                       "NRKEY 0x%"PRIx64", PRKEY 0x%"PRIx64"\n",
    3231             :                       racqa, iekey, rtype, key.crkey, key.prkey);
    3232             : 
    3233          13 :         if (iekey || rtype > SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) {
    3234           0 :                 SPDK_ERRLOG("Ignore existing key field set to 1\n");
    3235           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3236           0 :                 update_sgroup = false;
    3237           0 :                 goto exit;
    3238             :         }
    3239             : 
    3240          13 :         reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
    3241             :         /* must be registrant and CRKEY must match */
    3242          13 :         if (!reg || reg->rkey != key.crkey) {
    3243           0 :                 SPDK_ERRLOG("No registrant or current key doesn't match "
    3244             :                             "with existing registrant key\n");
    3245           0 :                 status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3246           0 :                 update_sgroup = false;
    3247           0 :                 goto exit;
    3248             :         }
    3249             : 
    3250          13 :         all_regs = nvmf_ns_reservation_all_registrants_type(ns);
    3251             : 
    3252          13 :         switch (racqa) {
    3253          10 :         case SPDK_NVME_RESERVE_ACQUIRE:
    3254             :                 /* it's not an error for the holder to acquire same reservation type again */
    3255          10 :                 if (nvmf_ns_reservation_registrant_is_holder(ns, reg) && ns->rtype == rtype) {
    3256             :                         /* do nothing */
    3257           0 :                         update_sgroup = false;
    3258          10 :                 } else if (ns->holder == NULL) {
    3259             :                         /* first time to acquire the reservation */
    3260          10 :                         nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg);
    3261             :                 } else {
    3262           0 :                         SPDK_ERRLOG("Invalid rtype or current registrant is not holder\n");
    3263           0 :                         status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3264           0 :                         update_sgroup = false;
    3265           0 :                         goto exit;
    3266             :                 }
    3267          10 :                 break;
    3268           3 :         case SPDK_NVME_RESERVE_PREEMPT:
    3269             :                 /* no reservation holder */
    3270           3 :                 if (!ns->holder) {
    3271             :                         /* unregister with PRKEY */
    3272           0 :                         nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey);
    3273           0 :                         break;
    3274             :                 }
    3275           3 :                 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
    3276             :                                 SPDK_NVMF_MAX_NUM_REGISTRANTS,
    3277             :                                 &ctrlr->hostid);
    3278             : 
    3279             :                 /* only 1 reservation holder and reservation key is valid */
    3280           3 :                 if (!all_regs) {
    3281             :                         /* preempt itself */
    3282           2 :                         if (nvmf_ns_reservation_registrant_is_holder(ns, reg) &&
    3283           0 :                             ns->crkey == key.prkey) {
    3284           0 :                                 ns->rtype = rtype;
    3285           0 :                                 reservation_released = true;
    3286           0 :                                 break;
    3287             :                         }
    3288             : 
    3289           2 :                         if (ns->crkey == key.prkey) {
    3290           2 :                                 nvmf_ns_reservation_remove_registrant(ns, ns->holder);
    3291           2 :                                 nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg);
    3292           2 :                                 reservation_released = true;
    3293           0 :                         } else if (key.prkey != 0) {
    3294           0 :                                 nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey);
    3295             :                         } else {
    3296             :                                 /* PRKEY is zero */
    3297           0 :                                 SPDK_ERRLOG("Current PRKEY is zero\n");
    3298           0 :                                 status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3299           0 :                                 update_sgroup = false;
    3300           0 :                                 goto exit;
    3301             :                         }
    3302             :                 } else {
    3303             :                         /* release all other registrants except for the current one */
    3304           1 :                         if (key.prkey == 0) {
    3305           1 :                                 nvmf_ns_reservation_remove_all_other_registrants(ns, reg);
    3306           1 :                                 assert(ns->holder == reg);
    3307             :                         } else {
    3308           0 :                                 count = nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey);
    3309           0 :                                 if (count == 0) {
    3310           0 :                                         SPDK_ERRLOG("PRKEY doesn't match any registrant\n");
    3311           0 :                                         status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3312           0 :                                         update_sgroup = false;
    3313           0 :                                         goto exit;
    3314             :                                 }
    3315             :                         }
    3316             :                 }
    3317           3 :                 break;
    3318           0 :         default:
    3319           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3320           0 :                 update_sgroup = false;
    3321           0 :                 break;
    3322             :         }
    3323             : 
    3324          13 : exit:
    3325          13 :         if (update_sgroup && racqa == SPDK_NVME_RESERVE_PREEMPT) {
    3326           3 :                 new_num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, new_hostid_list,
    3327             :                                  SPDK_NVMF_MAX_NUM_REGISTRANTS,
    3328             :                                  &ctrlr->hostid);
    3329             :                 /* Preempt notification occurs on the unregistered controllers
    3330             :                  * other than the controller who issued the command.
    3331             :                  */
    3332           3 :                 num_hostid = nvmf_ns_reservation_get_unregistered_hostid(hostid_list,
    3333             :                                 num_hostid,
    3334             :                                 new_hostid_list,
    3335             :                                 new_num_hostid);
    3336           3 :                 if (num_hostid) {
    3337           3 :                         nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
    3338             :                                                               hostid_list,
    3339             :                                                               num_hostid,
    3340             :                                                               SPDK_NVME_REGISTRATION_PREEMPTED);
    3341             : 
    3342             :                 }
    3343             :                 /* Reservation released notification occurs on the
    3344             :                  * controllers which are the remaining registrants other than
    3345             :                  * the controller who issued the command.
    3346             :                  */
    3347           3 :                 if (reservation_released && new_num_hostid) {
    3348           2 :                         nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
    3349             :                                                               new_hostid_list,
    3350             :                                                               new_num_hostid,
    3351             :                                                               SPDK_NVME_RESERVATION_RELEASED);
    3352             : 
    3353             :                 }
    3354             :         }
    3355          13 :         req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
    3356          13 :         req->rsp->nvme_cpl.status.sc = status;
    3357          13 :         return update_sgroup;
    3358             : }
    3359             : 
    3360             : static bool
    3361           6 : nvmf_ns_reservation_release(struct spdk_nvmf_ns *ns,
    3362             :                             struct spdk_nvmf_ctrlr *ctrlr,
    3363             :                             struct spdk_nvmf_request *req)
    3364             : {
    3365           6 :         struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
    3366             :         uint8_t rrela, iekey, rtype;
    3367             :         struct spdk_nvmf_registrant *reg;
    3368           6 :         uint64_t crkey = 0;
    3369           6 :         uint8_t status = SPDK_NVME_SC_SUCCESS;
    3370           6 :         bool update_sgroup = true;
    3371           6 :         struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
    3372           6 :         uint32_t num_hostid = 0;
    3373             : 
    3374           6 :         rrela = cmd->cdw10_bits.resv_release.rrela;
    3375           6 :         iekey = cmd->cdw10_bits.resv_release.iekey;
    3376           6 :         rtype = cmd->cdw10_bits.resv_release.rtype;
    3377             : 
    3378           6 :         if (req->iovcnt > 0 && req->length >= sizeof(crkey)) {
    3379           6 :                 struct spdk_iov_xfer ix;
    3380           6 :                 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
    3381           6 :                 spdk_iov_xfer_to_buf(&ix, &crkey, sizeof(crkey));
    3382             :         } else {
    3383           0 :                 SPDK_ERRLOG("No key provided. Failing request.\n");
    3384           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3385           0 :                 goto exit;
    3386             :         }
    3387             : 
    3388           6 :         SPDK_DEBUGLOG(nvmf, "RELEASE: RRELA %u, IEKEY %u, RTYPE %u, "
    3389             :                       "CRKEY 0x%"PRIx64"\n",  rrela, iekey, rtype, crkey);
    3390             : 
    3391           6 :         if (iekey) {
    3392           0 :                 SPDK_ERRLOG("Ignore existing key field set to 1\n");
    3393           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3394           0 :                 update_sgroup = false;
    3395           0 :                 goto exit;
    3396             :         }
    3397             : 
    3398           6 :         reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
    3399           6 :         if (!reg || reg->rkey != crkey) {
    3400           0 :                 SPDK_ERRLOG("No registrant or current key doesn't match "
    3401             :                             "with existing registrant key\n");
    3402           0 :                 status = SPDK_NVME_SC_RESERVATION_CONFLICT;
    3403           0 :                 update_sgroup = false;
    3404           0 :                 goto exit;
    3405             :         }
    3406             : 
    3407           6 :         num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
    3408             :                         SPDK_NVMF_MAX_NUM_REGISTRANTS,
    3409             :                         &ctrlr->hostid);
    3410             : 
    3411           6 :         switch (rrela) {
    3412           4 :         case SPDK_NVME_RESERVE_RELEASE:
    3413           4 :                 if (!ns->holder) {
    3414           0 :                         SPDK_DEBUGLOG(nvmf, "RELEASE: no holder\n");
    3415           0 :                         update_sgroup = false;
    3416           0 :                         goto exit;
    3417             :                 }
    3418           4 :                 if (ns->rtype != rtype) {
    3419           0 :                         SPDK_ERRLOG("Type doesn't match\n");
    3420           0 :                         status = SPDK_NVME_SC_INVALID_FIELD;
    3421           0 :                         update_sgroup = false;
    3422           0 :                         goto exit;
    3423             :                 }
    3424           4 :                 if (!nvmf_ns_reservation_registrant_is_holder(ns, reg)) {
    3425             :                         /* not the reservation holder, this isn't an error */
    3426           0 :                         update_sgroup = false;
    3427           0 :                         goto exit;
    3428             :                 }
    3429             : 
    3430           4 :                 rtype = ns->rtype;
    3431           4 :                 nvmf_ns_reservation_release_reservation(ns);
    3432             : 
    3433           4 :                 if (num_hostid && rtype != SPDK_NVME_RESERVE_WRITE_EXCLUSIVE &&
    3434             :                     rtype != SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) {
    3435           2 :                         nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
    3436             :                                                               hostid_list,
    3437             :                                                               num_hostid,
    3438             :                                                               SPDK_NVME_RESERVATION_RELEASED);
    3439             :                 }
    3440           4 :                 break;
    3441           2 :         case SPDK_NVME_RESERVE_CLEAR:
    3442           2 :                 nvmf_ns_reservation_clear_all_registrants(ns);
    3443           2 :                 if (num_hostid) {
    3444           2 :                         nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
    3445             :                                                               hostid_list,
    3446             :                                                               num_hostid,
    3447             :                                                               SPDK_NVME_RESERVATION_PREEMPTED);
    3448             :                 }
    3449           2 :                 break;
    3450           0 :         default:
    3451           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3452           0 :                 update_sgroup = false;
    3453           0 :                 goto exit;
    3454             :         }
    3455             : 
    3456           6 : exit:
    3457           6 :         req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
    3458           6 :         req->rsp->nvme_cpl.status.sc = status;
    3459           6 :         return update_sgroup;
    3460             : }
    3461             : 
    3462             : static void
    3463           3 : nvmf_ns_reservation_report(struct spdk_nvmf_ns *ns,
    3464             :                            struct spdk_nvmf_ctrlr *ctrlr,
    3465             :                            struct spdk_nvmf_request *req)
    3466             : {
    3467           3 :         struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
    3468             :         struct spdk_nvmf_registrant *reg, *tmp;
    3469           3 :         struct spdk_nvme_reservation_status_extended_data status_data = { 0 };
    3470           3 :         struct spdk_iov_xfer ix;
    3471             :         uint32_t transfer_len;
    3472           3 :         uint32_t regctl = 0;
    3473           3 :         uint8_t status = SPDK_NVME_SC_SUCCESS;
    3474             : 
    3475           3 :         if (req->iovcnt == 0) {
    3476           0 :                 SPDK_ERRLOG("No data transfer specified for request. "
    3477             :                             " Unable to transfer back response.\n");
    3478           0 :                 status = SPDK_NVME_SC_INVALID_FIELD;
    3479           0 :                 goto exit;
    3480             :         }
    3481             : 
    3482           3 :         if (!cmd->cdw11_bits.resv_report.eds) {
    3483           1 :                 SPDK_ERRLOG("NVMeoF uses extended controller data structure, "
    3484             :                             "please set EDS bit in cdw11 and try again\n");
    3485           1 :                 status = SPDK_NVME_SC_HOSTID_INCONSISTENT_FORMAT;
    3486           1 :                 goto exit;
    3487             :         }
    3488             : 
    3489             :         /* Number of Dwords of the Reservation Status data structure to transfer */
    3490           2 :         transfer_len = (cmd->cdw10 + 1) * sizeof(uint32_t);
    3491             : 
    3492           2 :         if (transfer_len < sizeof(struct spdk_nvme_reservation_status_extended_data)) {
    3493           1 :                 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
    3494           1 :                 goto exit;
    3495             :         }
    3496             : 
    3497           1 :         spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
    3498             : 
    3499           1 :         status_data.data.gen = ns->gen;
    3500           1 :         status_data.data.rtype = ns->rtype;
    3501           1 :         status_data.data.ptpls = ns->ptpl_activated;
    3502             : 
    3503           3 :         TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
    3504           2 :                 regctl++;
    3505             :         }
    3506             : 
    3507             :         /*
    3508             :          * We report the number of registrants as per the spec here, even if
    3509             :          * the iov isn't big enough to contain them all. In that case, the
    3510             :          * spdk_iov_xfer_from_buf() won't actually copy any of the remaining
    3511             :          * data; as it keeps track of the iov cursor itself, it's simplest to
    3512             :          * just walk the entire list anyway.
    3513             :          */
    3514           1 :         status_data.data.regctl = regctl;
    3515             : 
    3516           1 :         spdk_iov_xfer_from_buf(&ix, &status_data, sizeof(status_data));
    3517             : 
    3518           3 :         TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
    3519           2 :                 struct spdk_nvme_registered_ctrlr_extended_data ctrlr_data = { 0 };
    3520             : 
    3521             :                 /* Set to 0xffffh for dynamic controller */
    3522           2 :                 ctrlr_data.cntlid = 0xffff;
    3523           2 :                 ctrlr_data.rcsts.status = (ns->holder == reg) ? true : false;
    3524           2 :                 ctrlr_data.rkey = reg->rkey;
    3525           2 :                 spdk_uuid_copy((struct spdk_uuid *)ctrlr_data.hostid, &reg->hostid);
    3526             : 
    3527           2 :                 spdk_iov_xfer_from_buf(&ix, &ctrlr_data, sizeof(ctrlr_data));
    3528             :         }
    3529             : 
    3530           3 : exit:
    3531           3 :         req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
    3532           3 :         req->rsp->nvme_cpl.status.sc = status;
    3533           3 :         return;
    3534             : }
    3535             : 
    3536             : static void
    3537           0 : nvmf_ns_reservation_complete(void *ctx)
    3538             : {
    3539           0 :         struct spdk_nvmf_request *req = ctx;
    3540             : 
    3541           0 :         spdk_nvmf_request_complete(req);
    3542           0 : }
    3543             : 
    3544             : static void
    3545           0 : _nvmf_ns_reservation_update_done(struct spdk_nvmf_subsystem *subsystem,
    3546             :                                  void *cb_arg, int status)
    3547             : {
    3548           0 :         struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)cb_arg;
    3549           0 :         struct spdk_nvmf_poll_group *group = req->qpair->group;
    3550             : 
    3551           0 :         spdk_thread_send_msg(group->thread, nvmf_ns_reservation_complete, req);
    3552           0 : }
    3553             : 
    3554             : void
    3555           0 : nvmf_ns_reservation_request(void *ctx)
    3556             : {
    3557           0 :         struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)ctx;
    3558           0 :         struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
    3559           0 :         struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
    3560             :         uint32_t nsid;
    3561             :         struct spdk_nvmf_ns *ns;
    3562           0 :         bool update_sgroup = false;
    3563           0 :         int status = 0;
    3564             : 
    3565           0 :         nsid = cmd->nsid;
    3566           0 :         ns = _nvmf_subsystem_get_ns(ctrlr->subsys, nsid);
    3567           0 :         assert(ns != NULL);
    3568             : 
    3569           0 :         switch (cmd->opc) {
    3570           0 :         case SPDK_NVME_OPC_RESERVATION_REGISTER:
    3571           0 :                 update_sgroup = nvmf_ns_reservation_register(ns, ctrlr, req);
    3572           0 :                 break;
    3573           0 :         case SPDK_NVME_OPC_RESERVATION_ACQUIRE:
    3574           0 :                 update_sgroup = nvmf_ns_reservation_acquire(ns, ctrlr, req);
    3575           0 :                 break;
    3576           0 :         case SPDK_NVME_OPC_RESERVATION_RELEASE:
    3577           0 :                 update_sgroup = nvmf_ns_reservation_release(ns, ctrlr, req);
    3578           0 :                 break;
    3579           0 :         case SPDK_NVME_OPC_RESERVATION_REPORT:
    3580           0 :                 nvmf_ns_reservation_report(ns, ctrlr, req);
    3581           0 :                 break;
    3582           0 :         default:
    3583           0 :                 break;
    3584             :         }
    3585             : 
    3586             :         /* update reservation information to subsystem's poll group */
    3587           0 :         if (update_sgroup) {
    3588           0 :                 if (ns->ptpl_activated || cmd->opc == SPDK_NVME_OPC_RESERVATION_REGISTER) {
    3589           0 :                         if (nvmf_ns_update_reservation_info(ns) != 0) {
    3590           0 :                                 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
    3591             :                         }
    3592             :                 }
    3593           0 :                 status = nvmf_subsystem_update_ns(ctrlr->subsys, _nvmf_ns_reservation_update_done, req);
    3594           0 :                 if (status == 0) {
    3595           0 :                         return;
    3596             :                 }
    3597             :         }
    3598             : 
    3599           0 :         _nvmf_ns_reservation_update_done(ctrlr->subsys, req, status);
    3600             : }
    3601             : 
    3602             : static bool
    3603          11 : nvmf_ns_is_ptpl_capable_json(const struct spdk_nvmf_ns *ns)
    3604             : {
    3605          11 :         return ns->ptpl_file != NULL;
    3606             : }
    3607             : 
    3608             : static struct spdk_nvmf_ns_reservation_ops g_reservation_ops = {
    3609             :         .is_ptpl_capable = nvmf_ns_is_ptpl_capable_json,
    3610             :         .update = nvmf_ns_reservation_update_json,
    3611             :         .load = nvmf_ns_reservation_load_json,
    3612             : };
    3613             : 
    3614             : bool
    3615          15 : nvmf_ns_is_ptpl_capable(const struct spdk_nvmf_ns *ns)
    3616             : {
    3617          15 :         return g_reservation_ops.is_ptpl_capable(ns);
    3618             : }
    3619             : 
    3620             : static int
    3621           7 : nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns,
    3622             :                            const struct spdk_nvmf_reservation_info *info)
    3623             : {
    3624           7 :         return g_reservation_ops.update(ns, info);
    3625             : }
    3626             : 
    3627             : static int
    3628           6 : nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info)
    3629             : {
    3630           6 :         return g_reservation_ops.load(ns, info);
    3631             : }
    3632             : 
    3633             : void
    3634           1 : spdk_nvmf_set_custom_ns_reservation_ops(const struct spdk_nvmf_ns_reservation_ops *ops)
    3635             : {
    3636           1 :         g_reservation_ops = *ops;
    3637           1 : }
    3638             : 
    3639             : int
    3640           0 : spdk_nvmf_subsystem_set_ana_reporting(struct spdk_nvmf_subsystem *subsystem,
    3641             :                                       bool ana_reporting)
    3642             : {
    3643           0 :         if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
    3644           0 :                 return -EAGAIN;
    3645             :         }
    3646             : 
    3647           0 :         subsystem->flags.ana_reporting = ana_reporting;
    3648             : 
    3649           0 :         return 0;
    3650             : }
    3651             : 
    3652             : bool
    3653           0 : spdk_nvmf_subsystem_get_ana_reporting(struct spdk_nvmf_subsystem *subsystem)
    3654             : {
    3655           0 :         return subsystem->flags.ana_reporting;
    3656             : }
    3657             : 
    3658             : struct subsystem_listener_update_ctx {
    3659             :         struct spdk_nvmf_subsystem_listener *listener;
    3660             : 
    3661             :         spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn;
    3662             :         void *cb_arg;
    3663             : };
    3664             : 
    3665             : static void
    3666           0 : subsystem_listener_update_done(struct spdk_io_channel_iter *i, int status)
    3667             : {
    3668           0 :         struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
    3669             : 
    3670           0 :         if (ctx->cb_fn) {
    3671           0 :                 ctx->cb_fn(ctx->cb_arg, status);
    3672             :         }
    3673           0 :         free(ctx);
    3674           0 : }
    3675             : 
    3676             : static void
    3677           0 : subsystem_listener_update_on_pg(struct spdk_io_channel_iter *i)
    3678             : {
    3679           0 :         struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
    3680             :         struct spdk_nvmf_subsystem_listener *listener;
    3681             :         struct spdk_nvmf_poll_group *group;
    3682             :         struct spdk_nvmf_ctrlr *ctrlr;
    3683             : 
    3684           0 :         listener = ctx->listener;
    3685           0 :         group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i));
    3686             : 
    3687           0 :         TAILQ_FOREACH(ctrlr, &listener->subsystem->ctrlrs, link) {
    3688           0 :                 if (ctrlr->thread != spdk_get_thread()) {
    3689           0 :                         continue;
    3690             :                 }
    3691             : 
    3692           0 :                 if (ctrlr->admin_qpair && ctrlr->admin_qpair->group == group && ctrlr->listener == listener) {
    3693           0 :                         nvmf_ctrlr_async_event_ana_change_notice(ctrlr);
    3694             :                 }
    3695             :         }
    3696             : 
    3697           0 :         spdk_for_each_channel_continue(i, 0);
    3698           0 : }
    3699             : 
    3700             : void
    3701           0 : spdk_nvmf_subsystem_set_ana_state(struct spdk_nvmf_subsystem *subsystem,
    3702             :                                   const struct spdk_nvme_transport_id *trid,
    3703             :                                   enum spdk_nvme_ana_state ana_state, uint32_t anagrpid,
    3704             :                                   spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, void *cb_arg)
    3705             : {
    3706             :         struct spdk_nvmf_subsystem_listener *listener;
    3707             :         struct subsystem_listener_update_ctx *ctx;
    3708             :         uint32_t i;
    3709             : 
    3710           0 :         assert(cb_fn != NULL);
    3711           0 :         assert(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
    3712             :                subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED);
    3713             : 
    3714           0 :         if (!subsystem->flags.ana_reporting) {
    3715           0 :                 SPDK_ERRLOG("ANA reporting is disabled\n");
    3716           0 :                 cb_fn(cb_arg, -EINVAL);
    3717           0 :                 return;
    3718             :         }
    3719             : 
    3720             :         /* ANA Change state is not used, ANA Persistent Loss state
    3721             :          * is not supported yet.
    3722             :          */
    3723           0 :         if (!(ana_state == SPDK_NVME_ANA_OPTIMIZED_STATE ||
    3724             :               ana_state == SPDK_NVME_ANA_NON_OPTIMIZED_STATE ||
    3725             :               ana_state == SPDK_NVME_ANA_INACCESSIBLE_STATE)) {
    3726           0 :                 SPDK_ERRLOG("ANA state %d is not supported\n", ana_state);
    3727           0 :                 cb_fn(cb_arg, -ENOTSUP);
    3728           0 :                 return;
    3729             :         }
    3730             : 
    3731           0 :         if (anagrpid > subsystem->max_nsid) {
    3732           0 :                 SPDK_ERRLOG("ANA group ID %" PRIu32 " is more than maximum\n", anagrpid);
    3733           0 :                 cb_fn(cb_arg, -EINVAL);
    3734           0 :                 return;
    3735             :         }
    3736             : 
    3737           0 :         listener = nvmf_subsystem_find_listener(subsystem, trid);
    3738           0 :         if (!listener) {
    3739           0 :                 SPDK_ERRLOG("Unable to find listener.\n");
    3740           0 :                 cb_fn(cb_arg, -EINVAL);
    3741           0 :                 return;
    3742             :         }
    3743             : 
    3744           0 :         if (anagrpid != 0 && listener->ana_state[anagrpid - 1] == ana_state) {
    3745           0 :                 cb_fn(cb_arg, 0);
    3746           0 :                 return;
    3747             :         }
    3748             : 
    3749           0 :         ctx = calloc(1, sizeof(*ctx));
    3750           0 :         if (!ctx) {
    3751           0 :                 SPDK_ERRLOG("Unable to allocate context\n");
    3752           0 :                 cb_fn(cb_arg, -ENOMEM);
    3753           0 :                 return;
    3754             :         }
    3755             : 
    3756           0 :         for (i = 1; i <= subsystem->max_nsid; i++) {
    3757           0 :                 if (anagrpid == 0 || i == anagrpid) {
    3758           0 :                         listener->ana_state[i - 1] = ana_state;
    3759             :                 }
    3760             :         }
    3761           0 :         listener->ana_state_change_count++;
    3762             : 
    3763           0 :         ctx->listener = listener;
    3764           0 :         ctx->cb_fn = cb_fn;
    3765           0 :         ctx->cb_arg = cb_arg;
    3766             : 
    3767           0 :         spdk_for_each_channel(subsystem->tgt,
    3768             :                               subsystem_listener_update_on_pg,
    3769             :                               ctx,
    3770             :                               subsystem_listener_update_done);
    3771             : }
    3772             : 
    3773             : int
    3774           0 : spdk_nvmf_subsystem_get_ana_state(struct spdk_nvmf_subsystem *subsystem,
    3775             :                                   const struct spdk_nvme_transport_id *trid,
    3776             :                                   uint32_t anagrpid,
    3777             :                                   enum spdk_nvme_ana_state *ana_state)
    3778             : {
    3779           0 :         assert(ana_state != NULL);
    3780             : 
    3781             :         struct spdk_nvmf_subsystem_listener *listener;
    3782             : 
    3783           0 :         if (!subsystem->flags.ana_reporting) {
    3784           0 :                 SPDK_ERRLOG("ANA reporting is disabled\n");
    3785           0 :                 return -EINVAL;
    3786             :         }
    3787             : 
    3788           0 :         if (anagrpid <= 0 || anagrpid > subsystem->max_nsid) {
    3789           0 :                 SPDK_ERRLOG("ANA group ID %" PRIu32 " is invalid\n", anagrpid);
    3790           0 :                 return -EINVAL;
    3791             :         }
    3792             : 
    3793           0 :         listener = nvmf_subsystem_find_listener(subsystem, trid);
    3794           0 :         if (!listener) {
    3795           0 :                 SPDK_ERRLOG("Unable to find listener.\n");
    3796           0 :                 return -EINVAL;
    3797             :         }
    3798             : 
    3799           0 :         *ana_state = listener->ana_state[anagrpid - 1];
    3800           0 :         return 0;
    3801             : }
    3802             : 
    3803             : bool
    3804          14 : spdk_nvmf_subsystem_is_discovery(struct spdk_nvmf_subsystem *subsystem)
    3805             : {
    3806          28 :         return subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT ||
    3807          14 :                subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY;
    3808             : }
    3809             : 
    3810             : bool
    3811           0 : nvmf_nqn_is_discovery(const char *nqn)
    3812             : {
    3813           0 :         return strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN) == 0;
    3814             : }

Generated by: LCOV version 1.15