xref: /spdk/lib/nvmf/nvmf.c (revision 179ed697b3c461d100e675915d074be717b7b9cc)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #include "spdk/stdinc.h"
35 
36 #include "spdk/conf.h"
37 #include "spdk/nvmf.h"
38 #include "spdk/trace.h"
39 
40 #include "spdk_internal/log.h"
41 
42 #include "subsystem.h"
43 #include "transport.h"
44 
45 SPDK_LOG_REGISTER_TRACE_FLAG("nvmf", SPDK_TRACE_NVMF)
46 
47 #define MAX_SUBSYSTEMS 4
48 
49 #define SPDK_NVMF_DEFAULT_MAX_QUEUE_DEPTH 128
50 #define SPDK_NVMF_DEFAULT_MAX_QPAIRS_PER_CTRLR 64
51 #define SPDK_NVMF_DEFAULT_IN_CAPSULE_DATA_SIZE 4096
52 #define SPDK_NVMF_DEFAULT_MAX_IO_SIZE 131072
53 
54 struct spdk_nvmf_tgt g_nvmf_tgt;
55 
56 void
57 spdk_nvmf_tgt_opts_init(struct spdk_nvmf_tgt_opts *opts)
58 {
59 	opts->max_queue_depth = SPDK_NVMF_DEFAULT_MAX_QUEUE_DEPTH;
60 	opts->max_qpairs_per_ctrlr = SPDK_NVMF_DEFAULT_MAX_QPAIRS_PER_CTRLR;
61 	opts->in_capsule_data_size = SPDK_NVMF_DEFAULT_IN_CAPSULE_DATA_SIZE;
62 	opts->max_io_size = SPDK_NVMF_DEFAULT_MAX_IO_SIZE;
63 }
64 
65 struct spdk_nvmf_tgt *
66 spdk_nvmf_tgt_create(struct spdk_nvmf_tgt_opts *opts)
67 {
68 	struct spdk_nvmf_tgt *tgt;
69 
70 	tgt = &g_nvmf_tgt;
71 
72 	if (!opts) {
73 		spdk_nvmf_tgt_opts_init(&tgt->opts);
74 	} else {
75 		tgt->opts = *opts;
76 	}
77 
78 	tgt->discovery_genctr = 0;
79 	tgt->discovery_log_page = NULL;
80 	tgt->discovery_log_page_size = 0;
81 	tgt->current_subsystem_id = 0;
82 	TAILQ_INIT(&tgt->subsystems);
83 	TAILQ_INIT(&tgt->listen_addrs);
84 	TAILQ_INIT(&tgt->transports);
85 
86 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max Queue Pairs Per Controller: %d\n",
87 		      tgt->opts.max_qpairs_per_ctrlr);
88 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max Queue Depth: %d\n", tgt->opts.max_queue_depth);
89 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max In Capsule Data: %d bytes\n",
90 		      tgt->opts.in_capsule_data_size);
91 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max I/O Size: %d bytes\n", tgt->opts.max_io_size);
92 
93 	return tgt;
94 }
95 
96 void
97 spdk_nvmf_tgt_destroy(struct spdk_nvmf_tgt *tgt)
98 {
99 	struct spdk_nvmf_listen_addr *listen_addr, *listen_addr_tmp;
100 	struct spdk_nvmf_transport *transport, *transport_tmp;
101 
102 	TAILQ_FOREACH_SAFE(listen_addr, &tgt->listen_addrs, link, listen_addr_tmp) {
103 		TAILQ_REMOVE(&tgt->listen_addrs, listen_addr, link);
104 		tgt->discovery_genctr++;
105 
106 		spdk_nvmf_listen_addr_destroy(listen_addr);
107 	}
108 
109 	TAILQ_FOREACH_SAFE(transport, &tgt->transports, link, transport_tmp) {
110 		TAILQ_REMOVE(&tgt->transports, transport, link);
111 		spdk_nvmf_transport_destroy(transport);
112 	}
113 }
114 
115 struct spdk_nvmf_transport *
116 spdk_nvmf_tgt_get_transport(struct spdk_nvmf_tgt *tgt, enum spdk_nvme_transport_type type)
117 {
118 	struct spdk_nvmf_transport *transport;
119 
120 	TAILQ_FOREACH(transport, &tgt->transports, link) {
121 		if (transport->ops->type == type) {
122 			return transport;
123 		}
124 	}
125 
126 	return NULL;
127 }
128 
129 struct spdk_nvmf_listen_addr *
130 spdk_nvmf_listen_addr_create(struct spdk_nvme_transport_id *trid)
131 {
132 	struct spdk_nvmf_listen_addr *listen_addr;
133 
134 	listen_addr = calloc(1, sizeof(*listen_addr));
135 	if (!listen_addr) {
136 		return NULL;
137 	}
138 
139 	listen_addr->trid = *trid;
140 
141 	return listen_addr;
142 }
143 
144 void
145 spdk_nvmf_listen_addr_destroy(struct spdk_nvmf_listen_addr *addr)
146 {
147 	struct spdk_nvmf_transport *transport;
148 
149 	transport = spdk_nvmf_tgt_get_transport(&g_nvmf_tgt, addr->trid.trtype);
150 	if (!transport) {
151 		SPDK_ERRLOG("Attempted to destroy listener without a valid transport\n");
152 		return;
153 	}
154 
155 	spdk_nvmf_transport_stop_listen(transport, &addr->trid);
156 	free(addr);
157 }
158 
159 void
160 spdk_nvmf_tgt_poll(void)
161 {
162 	struct spdk_nvmf_transport *transport, *tmp;
163 
164 	TAILQ_FOREACH_SAFE(transport, &g_nvmf_tgt.transports, link, tmp) {
165 		spdk_nvmf_transport_accept(transport);
166 	}
167 }
168 
169 SPDK_TRACE_REGISTER_FN(nvmf_trace)
170 {
171 	spdk_trace_register_object(OBJECT_NVMF_IO, 'r');
172 	spdk_trace_register_description("NVMF_IO_START", "", TRACE_NVMF_IO_START,
173 					OWNER_NONE, OBJECT_NVMF_IO, 1, 0, 0, "");
174 	spdk_trace_register_description("NVMF_RDMA_READ_START", "", TRACE_RDMA_READ_START,
175 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
176 	spdk_trace_register_description("NVMF_RDMA_WRITE_START", "", TRACE_RDMA_WRITE_START,
177 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
178 	spdk_trace_register_description("NVMF_RDMA_READ_COMPLETE", "", TRACE_RDMA_READ_COMPLETE,
179 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
180 	spdk_trace_register_description("NVMF_RDMA_WRITE_COMPLETE", "", TRACE_RDMA_WRITE_COMPLETE,
181 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
182 	spdk_trace_register_description("NVMF_LIB_READ_START", "", TRACE_NVMF_LIB_READ_START,
183 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
184 	spdk_trace_register_description("NVMF_LIB_WRITE_START", "", TRACE_NVMF_LIB_WRITE_START,
185 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
186 	spdk_trace_register_description("NVMF_LIB_COMPLETE", "", TRACE_NVMF_LIB_COMPLETE,
187 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
188 	spdk_trace_register_description("NVMF_IO_COMPLETION_DONE", "", TRACE_NVMF_IO_COMPLETE,
189 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
190 }
191