1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (C) 2021 Intel Corporation.
3 * All rights reserved.
4 * Copyright (c) 2021, 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
5 */
6
7 #include "spdk/stdinc.h"
8 #include "spdk_internal/cunit.h"
9 #include "nvme/nvme_transport.c"
10 #include "common/lib/test_env.c"
11
12 SPDK_LOG_REGISTER_COMPONENT(nvme)
13
14 DEFINE_STUB(nvme_poll_group_connect_qpair, int, (struct spdk_nvme_qpair *qpair), 0);
15 DEFINE_STUB_V(nvme_qpair_abort_all_queued_reqs, (struct spdk_nvme_qpair *qpair));
16 DEFINE_STUB(nvme_poll_group_disconnect_qpair, int, (struct spdk_nvme_qpair *qpair), 0);
17 DEFINE_STUB(spdk_nvme_ctrlr_free_io_qpair, int, (struct spdk_nvme_qpair *qpair), 0);
18 DEFINE_STUB(spdk_nvme_transport_id_trtype_str, const char *,
19 (enum spdk_nvme_transport_type trtype), NULL);
20 DEFINE_STUB(spdk_nvme_qpair_process_completions, int32_t, (struct spdk_nvme_qpair *qpair,
21 uint32_t max_completions), 0);
22 DEFINE_STUB(spdk_nvme_poll_group_process_completions, int64_t, (struct spdk_nvme_poll_group *group,
23 uint32_t completions_per_qpair,
24 spdk_nvme_disconnected_qpair_cb disconnected_qpair_cb), 0);
25 DEFINE_STUB(nvme_ctrlr_get_current_process, struct spdk_nvme_ctrlr_process *,
26 (struct spdk_nvme_ctrlr *ctrlr), NULL);
27 DEFINE_STUB(spdk_nvme_ctrlr_is_fabrics, bool, (struct spdk_nvme_ctrlr *ctrlr), false);
28
29 static void
ut_construct_transport(struct spdk_nvme_transport * transport,const char name[])30 ut_construct_transport(struct spdk_nvme_transport *transport, const char name[])
31 {
32 memcpy(transport->ops.name, name, strlen(name));
33 TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, transport, link);
34 }
35
36 static void
test_nvme_get_transport(void)37 test_nvme_get_transport(void)
38 {
39 const struct spdk_nvme_transport *nvme_transport = NULL;
40 struct spdk_nvme_transport new_transport = {};
41
42 ut_construct_transport(&new_transport, "new_transport");
43
44 nvme_transport = nvme_get_transport("new_transport");
45 CU_ASSERT(nvme_transport == &new_transport);
46 TAILQ_REMOVE(&g_spdk_nvme_transports, nvme_transport, link);
47 CU_ASSERT(TAILQ_EMPTY(&g_spdk_nvme_transports));
48
49 /* Unavailable transport entry */
50 nvme_transport = nvme_get_transport("new_transport");
51 SPDK_CU_ASSERT_FATAL(nvme_transport == NULL);
52 }
53
54 static int
ut_poll_group_connect_qpair(struct spdk_nvme_qpair * qpair)55 ut_poll_group_connect_qpair(struct spdk_nvme_qpair *qpair)
56 {
57 return 0;
58 }
59
60 static void
test_nvme_transport_poll_group_connect_qpair(void)61 test_nvme_transport_poll_group_connect_qpair(void)
62 {
63 int rc;
64 struct spdk_nvme_qpair qpair = {};
65 struct spdk_nvme_transport_poll_group tgroup = {};
66 struct spdk_nvme_transport transport = {};
67
68 qpair.poll_group = &tgroup;
69 tgroup.transport = &transport;
70 transport.ops.poll_group_connect_qpair = ut_poll_group_connect_qpair;
71 STAILQ_INIT(&tgroup.connected_qpairs);
72 STAILQ_INIT(&tgroup.disconnected_qpairs);
73
74 /* Connected qpairs */
75 qpair.poll_group_tailq_head = &tgroup.connected_qpairs;
76
77 rc = nvme_transport_poll_group_connect_qpair(&qpair);
78 CU_ASSERT(rc == 0);
79
80 /* Disconnected qpairs */
81
82 qpair.poll_group_tailq_head = &tgroup.disconnected_qpairs;
83 STAILQ_INSERT_TAIL(&tgroup.disconnected_qpairs, &qpair, poll_group_stailq);
84
85 rc = nvme_transport_poll_group_connect_qpair(&qpair);
86 CU_ASSERT(rc == 0);
87 CU_ASSERT(STAILQ_EMPTY(&tgroup.disconnected_qpairs));
88 CU_ASSERT(!STAILQ_EMPTY(&tgroup.connected_qpairs));
89 STAILQ_REMOVE(&tgroup.connected_qpairs, &qpair, spdk_nvme_qpair, poll_group_stailq);
90 CU_ASSERT(STAILQ_EMPTY(&tgroup.connected_qpairs));
91
92 /* None qpairs */
93 qpair.poll_group_tailq_head = NULL;
94
95 rc = nvme_transport_poll_group_connect_qpair(&qpair);
96 SPDK_CU_ASSERT_FATAL(rc == -EINVAL);
97 }
98
99 static int
ut_poll_group_disconnect_qpair(struct spdk_nvme_qpair * qpair)100 ut_poll_group_disconnect_qpair(struct spdk_nvme_qpair *qpair)
101 {
102 return 0;
103 }
104
105 static void
test_nvme_transport_poll_group_disconnect_qpair(void)106 test_nvme_transport_poll_group_disconnect_qpair(void)
107 {
108 int rc;
109 struct spdk_nvme_qpair qpair = {};
110 struct spdk_nvme_transport_poll_group tgroup = {};
111 struct spdk_nvme_transport transport = {};
112
113 qpair.poll_group = &tgroup;
114 tgroup.transport = &transport;
115 transport.ops.poll_group_disconnect_qpair = ut_poll_group_disconnect_qpair;
116 STAILQ_INIT(&tgroup.connected_qpairs);
117 STAILQ_INIT(&tgroup.disconnected_qpairs);
118
119 /* Disconnected qpairs */
120 qpair.poll_group_tailq_head = &tgroup.disconnected_qpairs;
121
122 rc = nvme_transport_poll_group_disconnect_qpair(&qpair);
123 CU_ASSERT(rc == 0);
124
125 /* Connected qpairs */
126 qpair.poll_group_tailq_head = &tgroup.connected_qpairs;
127 STAILQ_INSERT_TAIL(&tgroup.connected_qpairs, &qpair, poll_group_stailq);
128 tgroup.num_connected_qpairs++;
129
130 rc = nvme_transport_poll_group_disconnect_qpair(&qpair);
131 CU_ASSERT(rc == 0);
132 CU_ASSERT(STAILQ_EMPTY(&tgroup.connected_qpairs));
133 CU_ASSERT(tgroup.num_connected_qpairs == 0);
134 CU_ASSERT(!STAILQ_EMPTY(&tgroup.disconnected_qpairs));
135 STAILQ_REMOVE(&tgroup.disconnected_qpairs, &qpair, spdk_nvme_qpair, poll_group_stailq);
136 CU_ASSERT(STAILQ_EMPTY(&tgroup.disconnected_qpairs));
137
138 /* None qpairs */
139 qpair.poll_group_tailq_head = NULL;
140
141 rc = nvme_transport_poll_group_disconnect_qpair(&qpair);
142 SPDK_CU_ASSERT_FATAL(rc == -EINVAL);
143 }
144
145 static int
ut_poll_group_add_remove(struct spdk_nvme_transport_poll_group * tgroup,struct spdk_nvme_qpair * qpair)146 ut_poll_group_add_remove(struct spdk_nvme_transport_poll_group *tgroup,
147 struct spdk_nvme_qpair *qpair)
148 {
149 return 0;
150 }
151
152 static void
test_nvme_transport_poll_group_add_remove(void)153 test_nvme_transport_poll_group_add_remove(void)
154 {
155 int rc;
156 struct spdk_nvme_transport_poll_group tgroup = {};
157 struct spdk_nvme_qpair qpair = {};
158 const struct spdk_nvme_transport transport = {
159 .ops.poll_group_add = ut_poll_group_add_remove,
160 .ops.poll_group_remove = ut_poll_group_add_remove
161 };
162
163 tgroup.transport = &transport;
164 qpair.poll_group = &tgroup;
165 qpair.state = NVME_QPAIR_DISCONNECTED;
166 STAILQ_INIT(&tgroup.connected_qpairs);
167 STAILQ_INIT(&tgroup.disconnected_qpairs);
168
169 /* Add qpair */
170 rc = nvme_transport_poll_group_add(&tgroup, &qpair);
171 CU_ASSERT(rc == 0);
172 CU_ASSERT(qpair.poll_group_tailq_head == &tgroup.disconnected_qpairs);
173 CU_ASSERT(STAILQ_FIRST(&tgroup.disconnected_qpairs) == &qpair);
174
175 /* Remove disconnected_qpairs */
176 SPDK_CU_ASSERT_FATAL(!STAILQ_EMPTY(&tgroup.disconnected_qpairs));
177
178 rc = nvme_transport_poll_group_remove(&tgroup, &qpair);
179 CU_ASSERT(rc == 0);
180 CU_ASSERT(STAILQ_EMPTY(&tgroup.disconnected_qpairs));
181 CU_ASSERT(qpair.poll_group == NULL);
182 CU_ASSERT(qpair.poll_group_tailq_head == NULL);
183
184 /* Remove connected_qpairs */
185 qpair.poll_group_tailq_head = &tgroup.connected_qpairs;
186 STAILQ_INSERT_TAIL(&tgroup.connected_qpairs, &qpair, poll_group_stailq);
187
188 rc = nvme_transport_poll_group_remove(&tgroup, &qpair);
189 CU_ASSERT(rc == -EINVAL);
190
191 STAILQ_REMOVE(&tgroup.connected_qpairs, &qpair, spdk_nvme_qpair, poll_group_stailq);
192
193 /* Invalid qpair */
194 qpair.poll_group_tailq_head = NULL;
195
196 rc = nvme_transport_poll_group_remove(&tgroup, &qpair);
197 CU_ASSERT(rc == -ENOENT);
198 }
199
200 static int
g_ut_ctrlr_get_memory_domains(const struct spdk_nvme_ctrlr * ctrlr,struct spdk_memory_domain ** domains,int array_size)201 g_ut_ctrlr_get_memory_domains(const struct spdk_nvme_ctrlr *ctrlr,
202 struct spdk_memory_domain **domains, int array_size)
203 {
204 return 1;
205 }
206
207 static void
test_ctrlr_get_memory_domains(void)208 test_ctrlr_get_memory_domains(void)
209 {
210 struct spdk_nvme_ctrlr ctrlr = {
211 .trid = {
212 .trstring = "new_transport"
213 }
214 };
215 struct spdk_nvme_transport new_transport = {
216 .ops = { .ctrlr_get_memory_domains = g_ut_ctrlr_get_memory_domains }
217 };
218
219 ut_construct_transport(&new_transport, "new_transport");
220
221 /* transport contains necessary op */
222 CU_ASSERT(nvme_transport_ctrlr_get_memory_domains(&ctrlr, NULL, 0) == 1);
223
224 /* transport doesn't contain necessary op */
225 new_transport.ops.ctrlr_get_memory_domains = NULL;
226 CU_ASSERT(nvme_transport_ctrlr_get_memory_domains(&ctrlr, NULL, 0) == 0);
227
228 TAILQ_REMOVE(&g_spdk_nvme_transports, &new_transport, link);
229 }
230
231 int
main(int argc,char ** argv)232 main(int argc, char **argv)
233 {
234 CU_pSuite suite = NULL;
235 unsigned int num_failures;
236
237 CU_initialize_registry();
238
239 suite = CU_add_suite("nvme_transport", NULL, NULL);
240 CU_ADD_TEST(suite, test_nvme_get_transport);
241 CU_ADD_TEST(suite, test_nvme_transport_poll_group_connect_qpair);
242 CU_ADD_TEST(suite, test_nvme_transport_poll_group_disconnect_qpair);
243 CU_ADD_TEST(suite, test_nvme_transport_poll_group_add_remove);
244 CU_ADD_TEST(suite, test_ctrlr_get_memory_domains);
245
246 num_failures = spdk_ut_run_tests(argc, argv, NULL);
247 CU_cleanup_registry();
248 return num_failures;
249 }
250