xref: /spdk/lib/nvmf/nvmf.c (revision 4d43844f4d50a7abd5b6029ff3f2baff329890a8)
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 struct spdk_nvmf_tgt g_nvmf_tgt;
50 
51 int
52 spdk_nvmf_tgt_init(uint16_t max_queue_depth, uint16_t max_qpairs_per_ctrlr,
53 		   uint32_t in_capsule_data_size, uint32_t max_io_size)
54 {
55 	g_nvmf_tgt.max_qpairs_per_ctrlr = max_qpairs_per_ctrlr;
56 	g_nvmf_tgt.max_queue_depth = max_queue_depth;
57 	g_nvmf_tgt.in_capsule_data_size = in_capsule_data_size;
58 	g_nvmf_tgt.max_io_size = max_io_size;
59 	g_nvmf_tgt.discovery_genctr = 0;
60 	g_nvmf_tgt.discovery_log_page = NULL;
61 	g_nvmf_tgt.discovery_log_page_size = 0;
62 	g_nvmf_tgt.current_subsystem_id = 0;
63 	TAILQ_INIT(&g_nvmf_tgt.subsystems);
64 	TAILQ_INIT(&g_nvmf_tgt.listen_addrs);
65 	TAILQ_INIT(&g_nvmf_tgt.transports);
66 
67 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max Queue Pairs Per Controller: %d\n", max_qpairs_per_ctrlr);
68 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max Queue Depth: %d\n", max_queue_depth);
69 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max In Capsule Data: %d bytes\n", in_capsule_data_size);
70 	SPDK_TRACELOG(SPDK_TRACE_NVMF, "Max I/O Size: %d bytes\n", max_io_size);
71 
72 	return 0;
73 }
74 
75 int
76 spdk_nvmf_tgt_fini(void)
77 {
78 	struct spdk_nvmf_listen_addr *listen_addr, *listen_addr_tmp;
79 	struct spdk_nvmf_transport *transport, *transport_tmp;
80 
81 	TAILQ_FOREACH_SAFE(listen_addr, &g_nvmf_tgt.listen_addrs, link, listen_addr_tmp) {
82 		TAILQ_REMOVE(&g_nvmf_tgt.listen_addrs, listen_addr, link);
83 		g_nvmf_tgt.discovery_genctr++;
84 
85 		spdk_nvmf_listen_addr_destroy(listen_addr);
86 	}
87 
88 	TAILQ_FOREACH_SAFE(transport, &g_nvmf_tgt.transports, link, transport_tmp) {
89 		TAILQ_REMOVE(&g_nvmf_tgt.transports, transport, link);
90 		spdk_nvmf_transport_destroy(transport);
91 	}
92 
93 	return 0;
94 }
95 
96 struct spdk_nvmf_transport *
97 spdk_nvmf_tgt_get_transport(struct spdk_nvmf_tgt *tgt, enum spdk_nvme_transport_type type)
98 {
99 	struct spdk_nvmf_transport *transport;
100 
101 	TAILQ_FOREACH(transport, &tgt->transports, link) {
102 		if (transport->ops->type == type) {
103 			return transport;
104 		}
105 	}
106 
107 	return NULL;
108 }
109 
110 struct spdk_nvmf_listen_addr *
111 spdk_nvmf_listen_addr_create(struct spdk_nvme_transport_id *trid)
112 {
113 	struct spdk_nvmf_listen_addr *listen_addr;
114 
115 	listen_addr = calloc(1, sizeof(*listen_addr));
116 	if (!listen_addr) {
117 		return NULL;
118 	}
119 
120 	listen_addr->trid = *trid;
121 
122 	return listen_addr;
123 }
124 
125 void
126 spdk_nvmf_listen_addr_destroy(struct spdk_nvmf_listen_addr *addr)
127 {
128 	struct spdk_nvmf_transport *transport;
129 
130 	transport = spdk_nvmf_tgt_get_transport(&g_nvmf_tgt, addr->trid.trtype);
131 	if (!transport) {
132 		SPDK_ERRLOG("Attempted to destroy listener without a valid transport\n");
133 		return;
134 	}
135 
136 	spdk_nvmf_transport_stop_listen(transport, &addr->trid);
137 	free(addr);
138 }
139 
140 void
141 spdk_nvmf_tgt_poll(void)
142 {
143 	struct spdk_nvmf_transport *transport, *tmp;
144 
145 	TAILQ_FOREACH_SAFE(transport, &g_nvmf_tgt.transports, link, tmp) {
146 		spdk_nvmf_transport_accept(transport);
147 	}
148 }
149 
150 SPDK_TRACE_REGISTER_FN(nvmf_trace)
151 {
152 	spdk_trace_register_object(OBJECT_NVMF_IO, 'r');
153 	spdk_trace_register_description("NVMF_IO_START", "", TRACE_NVMF_IO_START,
154 					OWNER_NONE, OBJECT_NVMF_IO, 1, 0, 0, "");
155 	spdk_trace_register_description("NVMF_RDMA_READ_START", "", TRACE_RDMA_READ_START,
156 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
157 	spdk_trace_register_description("NVMF_RDMA_WRITE_START", "", TRACE_RDMA_WRITE_START,
158 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
159 	spdk_trace_register_description("NVMF_RDMA_READ_COMPLETE", "", TRACE_RDMA_READ_COMPLETE,
160 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
161 	spdk_trace_register_description("NVMF_RDMA_WRITE_COMPLETE", "", TRACE_RDMA_WRITE_COMPLETE,
162 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
163 	spdk_trace_register_description("NVMF_LIB_READ_START", "", TRACE_NVMF_LIB_READ_START,
164 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
165 	spdk_trace_register_description("NVMF_LIB_WRITE_START", "", TRACE_NVMF_LIB_WRITE_START,
166 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
167 	spdk_trace_register_description("NVMF_LIB_COMPLETE", "", TRACE_NVMF_LIB_COMPLETE,
168 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
169 	spdk_trace_register_description("NVMF_IO_COMPLETION_DONE", "", TRACE_NVMF_IO_COMPLETE,
170 					OWNER_NONE, OBJECT_NVMF_IO, 0, 0, 0, "");
171 }
172