xref: /spdk/test/unit/lib/nvme/nvme_ns.c/nvme_ns_ut.c (revision 3931e12104559fd3fae20d83382a886b210cec0f)
1 /*   SPDX-License-Identifier: BSD-3-Clause
2  *   Copyright (C) 2017 Intel Corporation. All rights reserved.
3  *   Copyright (c) 2021 Mellanox Technologies LTD. All rights reserved.
4  */
5 
6 #include "spdk_internal/cunit.h"
7 
8 #include "spdk/env.h"
9 
10 #include "nvme/nvme_ns.c"
11 
12 #include "common/lib/test_env.c"
13 
14 SPDK_LOG_REGISTER_COMPONENT(nvme)
15 
16 DEFINE_STUB(nvme_wait_for_completion_robust_lock, int,
17 	    (struct spdk_nvme_qpair *qpair,
18 	     struct nvme_completion_poll_status *status,
19 	     pthread_mutex_t *robust_mutex), 0);
20 DEFINE_STUB(nvme_ctrlr_multi_iocs_enabled, bool, (struct spdk_nvme_ctrlr *ctrlr), true);
21 
22 static struct spdk_nvme_cpl fake_cpl = {};
23 static enum spdk_nvme_generic_command_status_code set_status_code = SPDK_NVME_SC_SUCCESS;
24 
25 static void
fake_cpl_sc(spdk_nvme_cmd_cb cb_fn,void * cb_arg)26 fake_cpl_sc(spdk_nvme_cmd_cb cb_fn, void *cb_arg)
27 {
28 	fake_cpl.status.sc = set_status_code;
29 	cb_fn(cb_arg, &fake_cpl);
30 }
31 
32 static struct spdk_nvme_ns_data *fake_nsdata;
33 static struct spdk_nvme_zns_ns_data nsdata_zns = {
34 	.mar = 1024,
35 	.mor = 1024,
36 };
37 static struct spdk_nvme_nvm_ns_data nsdata_nvm = {
38 	.lbstm = 0xFFFFFFFF,
39 	.pic._16bpists = 1,
40 	.pic._16bpistm = 1,
41 	.pic.stcrs = 1,
42 	.elbaf[0].sts = 32,
43 	.elbaf[0].pif = 0,
44 };
45 
46 struct spdk_nvme_cmd g_ut_cmd = {};
47 
48 int
nvme_ctrlr_cmd_identify(struct spdk_nvme_ctrlr * ctrlr,uint8_t cns,uint16_t cntid,uint32_t nsid,uint8_t csi,void * payload,size_t payload_size,spdk_nvme_cmd_cb cb_fn,void * cb_arg)49 nvme_ctrlr_cmd_identify(struct spdk_nvme_ctrlr *ctrlr, uint8_t cns, uint16_t cntid, uint32_t nsid,
50 			uint8_t csi, void *payload, size_t payload_size,
51 			spdk_nvme_cmd_cb cb_fn, void *cb_arg)
52 {
53 	memset(&g_ut_cmd, 0, sizeof(g_ut_cmd));
54 
55 	if (cns == SPDK_NVME_IDENTIFY_NS) {
56 		assert(payload_size == sizeof(struct spdk_nvme_ns_data));
57 		if (fake_nsdata) {
58 			memcpy(payload, fake_nsdata, sizeof(*fake_nsdata));
59 		} else {
60 			memset(payload, 0, payload_size);
61 		}
62 		fake_cpl_sc(cb_fn, cb_arg);
63 		return 0;
64 	} else if (cns == SPDK_NVME_IDENTIFY_NS_IOCS) {
65 		if (csi == SPDK_NVME_CSI_ZNS) {
66 			assert(payload_size == sizeof(struct spdk_nvme_zns_ns_data));
67 			memcpy(payload, &nsdata_zns, sizeof(struct spdk_nvme_zns_ns_data));
68 			return 0;
69 		} else if (csi == SPDK_NVME_CSI_NVM) {
70 			assert(payload_size == sizeof(struct spdk_nvme_nvm_ns_data));
71 			memcpy(payload, &nsdata_nvm, sizeof(struct spdk_nvme_nvm_ns_data));
72 			return 0;
73 		}
74 	} else if (cns == SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST) {
75 		g_ut_cmd.cdw10_bits.identify.cns = cns;
76 		g_ut_cmd.cdw10_bits.identify.cntid = cntid;
77 		g_ut_cmd.cdw11_bits.identify.csi = csi;
78 		g_ut_cmd.nsid = nsid;
79 		return 0;
80 	}
81 	return -1;
82 }
83 
84 void
nvme_completion_poll_cb(void * arg,const struct spdk_nvme_cpl * cpl)85 nvme_completion_poll_cb(void *arg, const struct spdk_nvme_cpl *cpl)
86 {
87 }
88 
89 int32_t
spdk_nvme_qpair_process_completions(struct spdk_nvme_qpair * qpair,uint32_t max_completions)90 spdk_nvme_qpair_process_completions(struct spdk_nvme_qpair *qpair, uint32_t max_completions)
91 {
92 	return -1;
93 }
94 
95 static void
test_nvme_ns_construct(void)96 test_nvme_ns_construct(void)
97 {
98 	struct spdk_nvme_ns ns = {};
99 	uint32_t id = 1;
100 	struct spdk_nvme_ctrlr ctrlr = { };
101 
102 	nvme_ns_construct(&ns, id, &ctrlr);
103 	CU_ASSERT(ns.id == 1);
104 }
105 
106 static void
test_nvme_ns_uuid(void)107 test_nvme_ns_uuid(void)
108 {
109 	struct spdk_nvme_ns ns = {};
110 	uint32_t id = 1;
111 	struct spdk_nvme_ctrlr ctrlr = {};
112 	const struct spdk_uuid *uuid;
113 	struct spdk_uuid expected_uuid;
114 
115 	memset(&expected_uuid, 0xA5, sizeof(expected_uuid));
116 
117 	/* Empty list - no UUID should be found */
118 	nvme_ns_construct(&ns, id, &ctrlr);
119 	uuid = spdk_nvme_ns_get_uuid(&ns);
120 	CU_ASSERT(uuid == NULL);
121 	nvme_ns_destruct(&ns);
122 
123 	/* NGUID only (no UUID in list) */
124 	nvme_ns_construct(&ns, id, &ctrlr);
125 	ns.id_desc_list[0] = 0x02; /* NIDT == NGUID */
126 	ns.id_desc_list[1] = 0x10; /* NIDL */
127 	memset(&ns.id_desc_list[4], 0xCC, 0x10);
128 	uuid = spdk_nvme_ns_get_uuid(&ns);
129 	CU_ASSERT(uuid == NULL);
130 	nvme_ns_destruct(&ns);
131 
132 	/* Just UUID in the list */
133 	nvme_ns_construct(&ns, id, &ctrlr);
134 	ns.id_desc_list[0] = 0x03; /* NIDT == UUID */
135 	ns.id_desc_list[1] = 0x10; /* NIDL */
136 	memcpy(&ns.id_desc_list[4], &expected_uuid, sizeof(expected_uuid));
137 	uuid = spdk_nvme_ns_get_uuid(&ns);
138 	SPDK_CU_ASSERT_FATAL(uuid != NULL);
139 	CU_ASSERT(memcmp(uuid, &expected_uuid, sizeof(*uuid)) == 0);
140 	nvme_ns_destruct(&ns);
141 
142 	/* UUID followed by NGUID */
143 	nvme_ns_construct(&ns, id, &ctrlr);
144 	ns.id_desc_list[0] = 0x03; /* NIDT == UUID */
145 	ns.id_desc_list[1] = 0x10; /* NIDL */
146 	memcpy(&ns.id_desc_list[4], &expected_uuid, sizeof(expected_uuid));
147 	ns.id_desc_list[20] = 0x02; /* NIDT == NGUID */
148 	ns.id_desc_list[21] = 0x10; /* NIDL */
149 	memset(&ns.id_desc_list[24], 0xCC, 0x10);
150 	uuid = spdk_nvme_ns_get_uuid(&ns);
151 	SPDK_CU_ASSERT_FATAL(uuid != NULL);
152 	CU_ASSERT(memcmp(uuid, &expected_uuid, sizeof(*uuid)) == 0);
153 	nvme_ns_destruct(&ns);
154 
155 	/* NGUID followed by UUID */
156 	nvme_ns_construct(&ns, id, &ctrlr);
157 	ns.id_desc_list[0] = 0x02; /* NIDT == NGUID */
158 	ns.id_desc_list[1] = 0x10; /* NIDL */
159 	memset(&ns.id_desc_list[4], 0xCC, 0x10);
160 	ns.id_desc_list[20] = 0x03; /* NIDT = UUID */
161 	ns.id_desc_list[21] = 0x10; /* NIDL */
162 	memcpy(&ns.id_desc_list[24], &expected_uuid, sizeof(expected_uuid));
163 	uuid = spdk_nvme_ns_get_uuid(&ns);
164 	SPDK_CU_ASSERT_FATAL(uuid != NULL);
165 	CU_ASSERT(memcmp(uuid, &expected_uuid, sizeof(*uuid)) == 0);
166 	nvme_ns_destruct(&ns);
167 }
168 
169 static void
test_nvme_ns_csi(void)170 test_nvme_ns_csi(void)
171 {
172 	struct spdk_nvme_ns ns = {};
173 	uint32_t id = 1;
174 	struct spdk_nvme_ctrlr ctrlr = {};
175 	enum spdk_nvme_csi csi;
176 
177 	/* Empty list - SPDK_NVME_CSI_NVM should be returned */
178 	nvme_ns_construct(&ns, id, &ctrlr);
179 	csi = nvme_ns_get_csi(&ns);
180 	CU_ASSERT(csi == SPDK_NVME_CSI_NVM);
181 	nvme_ns_destruct(&ns);
182 
183 	/* NVM CSI - SPDK_NVME_CSI_NVM should be returned */
184 	nvme_ns_construct(&ns, id, &ctrlr);
185 	ns.id_desc_list[0] = 0x4; /* NIDT == CSI */
186 	ns.id_desc_list[1] = 0x1; /* NIDL */
187 	ns.id_desc_list[4] = 0x0; /* SPDK_NVME_CSI_NVM */
188 	csi = nvme_ns_get_csi(&ns);
189 	CU_ASSERT(csi == SPDK_NVME_CSI_NVM);
190 	nvme_ns_destruct(&ns);
191 
192 	/* NGUID followed by ZNS CSI - SPDK_NVME_CSI_ZNS should be returned */
193 	nvme_ns_construct(&ns, id, &ctrlr);
194 	ns.id_desc_list[0] = 0x02; /* NIDT == NGUID */
195 	ns.id_desc_list[1] = 0x10; /* NIDL */
196 	memset(&ns.id_desc_list[4], 0xCC, 0x10);
197 	ns.id_desc_list[20] = 0x4; /* NIDT == CSI */
198 	ns.id_desc_list[21] = 0x1; /* NIDL */
199 	ns.id_desc_list[24] = 0x2; /* SPDK_NVME_CSI_ZNS */
200 	csi = nvme_ns_get_csi(&ns);
201 	CU_ASSERT(csi == SPDK_NVME_CSI_ZNS);
202 	nvme_ns_destruct(&ns);
203 
204 	/* KV CSI followed by NGUID - SPDK_NVME_CSI_KV should be returned */
205 	nvme_ns_construct(&ns, id, &ctrlr);
206 	ns.id_desc_list[0] = 0x4; /* NIDT == CSI */
207 	ns.id_desc_list[1] = 0x1; /* NIDL */
208 	ns.id_desc_list[4] = 0x1; /* SPDK_NVME_CSI_KV */
209 	ns.id_desc_list[5] = 0x02; /* NIDT == NGUID */
210 	ns.id_desc_list[6] = 0x10; /* NIDL */
211 	memset(&ns.id_desc_list[9], 0xCC, 0x10);
212 	csi = nvme_ns_get_csi(&ns);
213 	CU_ASSERT(csi == SPDK_NVME_CSI_KV);
214 	nvme_ns_destruct(&ns);
215 }
216 
217 static void
test_nvme_ns_data(void)218 test_nvme_ns_data(void)
219 {
220 	struct spdk_nvme_ns ns = {};
221 	struct spdk_nvme_ctrlr ctrlr = { };
222 	struct spdk_nvme_ns_data expected_nsdata = {
223 		.nsze = 1000,
224 		.ncap = 1000,
225 	};
226 	const struct spdk_nvme_ns_data *nsdata;
227 
228 	fake_nsdata = &expected_nsdata;
229 	SPDK_CU_ASSERT_FATAL(nvme_ns_construct(&ns, 1, &ctrlr) == 0);
230 	fake_nsdata = NULL;
231 	CU_ASSERT(spdk_nvme_ns_is_active(&ns));
232 	CU_ASSERT(spdk_nvme_ns_get_id(&ns) == 1);
233 	CU_ASSERT(spdk_nvme_ns_get_num_sectors(&ns) == 1000);
234 
235 	nsdata = spdk_nvme_ns_get_data(&ns);
236 	CU_ASSERT(nsdata != NULL);
237 	CU_ASSERT(nsdata->ncap == 1000);
238 
239 	nvme_ns_destruct(&ns);
240 
241 	/* Cached NS data is still accessible after destruction. But is cleared. */
242 	CU_ASSERT(!spdk_nvme_ns_is_active(&ns));
243 	CU_ASSERT(spdk_nvme_ns_get_id(&ns) == 1);
244 	CU_ASSERT(spdk_nvme_ns_get_num_sectors(&ns) == 0);
245 	CU_ASSERT(nsdata->ncap == 0);
246 	CU_ASSERT(nsdata == spdk_nvme_ns_get_data(&ns));
247 }
248 
249 static void
test_nvme_ns_set_identify_data(void)250 test_nvme_ns_set_identify_data(void)
251 {
252 	struct spdk_nvme_ns ns = {};
253 	struct spdk_nvme_ctrlr ctrlr = {};
254 
255 	ns.id = 1;
256 	ns.ctrlr = &ctrlr;
257 
258 	ns.ctrlr->cdata.oncs.dsm = 1;
259 	ns.ctrlr->cdata.oncs.compare = 1;
260 	ns.ctrlr->cdata.vwc.present = 1;
261 	ns.ctrlr->cdata.oncs.write_zeroes = 1;
262 	ns.ctrlr->cdata.oncs.write_unc = 1;
263 	ns.ctrlr->min_page_size = 4096;
264 	ns.ctrlr->max_xfer_size = 131072;
265 
266 	ns.nsdata.flbas.extended = 1;
267 	ns.nsdata.nsrescap.raw = 1;
268 	ns.nsdata.dps.pit = SPDK_NVME_FMT_NVM_PROTECTION_TYPE1;
269 	ns.nsdata.flbas.format = 0;
270 	ns.nsdata.flbas.msb_format = 0;
271 	ns.nsdata.lbaf[0].lbads = 9;
272 	ns.nsdata.lbaf[0].ms = 8;
273 
274 	/* case 1:  nsdata->noiob > 0 */
275 	ns.nsdata.noiob = 1;
276 	nvme_ns_set_identify_data(&ns);
277 	CU_ASSERT(spdk_nvme_ns_get_optimal_io_boundary(&ns) == 1)
278 
279 	CU_ASSERT(spdk_nvme_ns_get_sector_size(&ns) == 512);
280 	CU_ASSERT(spdk_nvme_ns_get_extended_sector_size(&ns) == 520);
281 	CU_ASSERT(spdk_nvme_ns_get_md_size(&ns) == 8);
282 	CU_ASSERT(spdk_nvme_ns_get_max_io_xfer_size(&ns) == 131072);
283 	CU_ASSERT(ns.sectors_per_max_io == 252);
284 	CU_ASSERT(ns.sectors_per_max_io_no_md == 256);
285 	CU_ASSERT(spdk_nvme_ns_get_pi_type(&ns) == SPDK_NVME_FMT_NVM_PROTECTION_TYPE1);
286 	CU_ASSERT(spdk_nvme_ns_get_pi_format(&ns) == SPDK_NVME_16B_GUARD_PI);
287 
288 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_EXTENDED_LBA_SUPPORTED);
289 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_RESERVATION_SUPPORTED);
290 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_COMPARE_SUPPORTED);
291 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_FLUSH_SUPPORTED);
292 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_WRITE_ZEROES_SUPPORTED);
293 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_WRITE_UNCORRECTABLE_SUPPORTED);
294 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_RESERVATION_SUPPORTED);
295 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) & SPDK_NVME_NS_DPS_PI_SUPPORTED);
296 
297 	/* case 2: quirks for NVME_QUIRK_MDTS_EXCLUDE_MD */
298 	ns.ctrlr->quirks = NVME_QUIRK_MDTS_EXCLUDE_MD;
299 	nvme_ns_set_identify_data(&ns);
300 	CU_ASSERT(ns.sectors_per_max_io == 256);
301 	CU_ASSERT(ns.sectors_per_max_io_no_md == 256);
302 }
303 
304 static void
test_spdk_nvme_ns_get_values(void)305 test_spdk_nvme_ns_get_values(void)
306 {
307 	struct spdk_nvme_ns ns = {};
308 	struct spdk_nvme_ctrlr nsctrlr = {};
309 
310 	ns.ctrlr = &nsctrlr;
311 
312 	/* case1: spdk_nvme_ns_get_id */
313 	ns.id = 1;
314 	CU_ASSERT(spdk_nvme_ns_get_id(&ns) == 1);
315 
316 	/* case2: spdk_nvme_ns_get_ctrlr */
317 	CU_ASSERT(spdk_nvme_ns_get_ctrlr(&ns) == &nsctrlr);
318 
319 	/* case3: spdk_nvme_ns_get_max_io_xfer_size */
320 	ns.ctrlr->max_xfer_size = 65536;
321 	CU_ASSERT(spdk_nvme_ns_get_max_io_xfer_size(&ns) == 65536);
322 
323 	/* case4: spdk_nvme_ns_get_sector_size */
324 	ns.sector_size = 512;
325 	CU_ASSERT(spdk_nvme_ns_get_sector_size(&ns) == 512);
326 
327 	/* case5: spdk_nvme_ns_get_extended_sector_size */
328 	ns.extended_lba_size = 512;
329 	CU_ASSERT(spdk_nvme_ns_get_extended_sector_size(&ns) == 512);
330 
331 	/* case6: spdk_nvme_ns_get_num_sectors */
332 	ns.nsdata.nsze = 1024;
333 	CU_ASSERT(spdk_nvme_ns_get_num_sectors(&ns) == 1024);
334 
335 	/* case7: spdk_nvme_ns_get_size */
336 	CU_ASSERT(spdk_nvme_ns_get_size(&ns) == 524288);
337 
338 	/* case8: spdk_nvme_ns_get_flags */
339 	ns.flags = 255;
340 	CU_ASSERT(spdk_nvme_ns_get_flags(&ns) == 255);
341 
342 	/* case9: spdk_nvme_ns_get_pi_type */
343 	ns.pi_type = SPDK_NVME_FMT_NVM_PROTECTION_DISABLE;
344 	CU_ASSERT(spdk_nvme_ns_get_pi_type(&ns) == SPDK_NVME_FMT_NVM_PROTECTION_DISABLE);
345 
346 	/* case10: spdk_nvme_ns_get_md_size */
347 	ns.md_size = 512;
348 	CU_ASSERT(spdk_nvme_ns_get_md_size(&ns) == 512);
349 
350 	/* case11: spdk_nvme_ns_get_data */
351 	CU_ASSERT(spdk_nvme_ns_get_data(&ns) != NULL);
352 
353 	/* case12: spdk_nvme_ns_get_optimal_io_boundary */
354 	ns.sectors_per_stripe = 1;
355 	CU_ASSERT(spdk_nvme_ns_get_optimal_io_boundary(&ns) == 1);
356 
357 	/* case13: spdk_nvme_ns_get_dealloc_logical_block_read_value */
358 	ns.ctrlr->quirks = NVME_QUIRK_READ_ZERO_AFTER_DEALLOCATE | NVME_INTEL_QUIRK_WRITE_LATENCY;
359 	ns.nsdata.dlfeat.bits.read_value = SPDK_NVME_DEALLOC_NOT_REPORTED;
360 	CU_ASSERT(spdk_nvme_ns_get_dealloc_logical_block_read_value(&ns) == SPDK_NVME_DEALLOC_READ_00);
361 
362 	ns.ctrlr->quirks = NVME_INTEL_QUIRK_READ_LATENCY;
363 	CU_ASSERT(spdk_nvme_ns_get_dealloc_logical_block_read_value(&ns) == SPDK_NVME_DEALLOC_NOT_REPORTED);
364 
365 	/* case14: spdk_nvme_ns_get_csi */
366 	ns.csi = SPDK_NVME_CSI_NVM;
367 	CU_ASSERT(spdk_nvme_ns_get_csi(&ns) == SPDK_NVME_CSI_NVM);
368 
369 	/* case15: spdk_nvme_ns_get_ana_group_id */
370 	ns.ana_group_id = 15;
371 	CU_ASSERT(spdk_nvme_ns_get_ana_group_id(&ns) == 15);
372 
373 	/* case16: spdk_nvme_ns_get_ana_state */
374 	ns.ana_state = SPDK_NVME_ANA_OPTIMIZED_STATE;
375 	CU_ASSERT(spdk_nvme_ns_get_ana_state(&ns) == SPDK_NVME_ANA_OPTIMIZED_STATE);
376 }
377 
378 static void
test_spdk_nvme_ns_is_active(void)379 test_spdk_nvme_ns_is_active(void)
380 {
381 	struct spdk_nvme_ns ns = {};
382 
383 	/* case1: nsdata->id == 0 return false */
384 	ns.id = 0;
385 	CU_ASSERT(spdk_nvme_ns_is_active(&ns) == false);
386 
387 	/* case2: nsdata->ncap == 0 return false */
388 	ns.id = 1;
389 	ns.nsdata.ncap = 0;
390 	CU_ASSERT(spdk_nvme_ns_is_active(&ns) == false);
391 
392 	/* case3: ns->ncap != 0 return true */
393 	ns.nsdata.ncap = 1;
394 	CU_ASSERT(spdk_nvme_ns_is_active(&ns) == true);
395 }
396 
397 static void
spdk_nvme_ns_supports(void)398 spdk_nvme_ns_supports(void)
399 {
400 	struct spdk_nvme_ns ns = {};
401 
402 	/* case1: spdk_nvme_ns_supports_extended_lba */
403 	ns.flags = SPDK_NVME_NS_DEALLOCATE_SUPPORTED;
404 	CU_ASSERT(spdk_nvme_ns_supports_extended_lba(&ns) == false);
405 	ns.flags = SPDK_NVME_NS_EXTENDED_LBA_SUPPORTED | SPDK_NVME_NS_DEALLOCATE_SUPPORTED;
406 	CU_ASSERT(spdk_nvme_ns_supports_extended_lba(&ns) == true);
407 
408 	/* case2: spdk_nvme_ns_supports_compare */
409 	ns.flags = SPDK_NVME_NS_DEALLOCATE_SUPPORTED;
410 	CU_ASSERT(spdk_nvme_ns_supports_compare(&ns) == false);
411 	ns.flags = SPDK_NVME_NS_COMPARE_SUPPORTED | SPDK_NVME_NS_DEALLOCATE_SUPPORTED;
412 	CU_ASSERT(spdk_nvme_ns_supports_compare(&ns) == true);
413 }
414 
415 static void
test_nvme_ns_has_supported_iocs_specific_data(void)416 test_nvme_ns_has_supported_iocs_specific_data(void)
417 {
418 	struct spdk_nvme_ctrlr ctrlr = {};
419 	struct spdk_nvme_ns ns = { .ctrlr = &ctrlr, };
420 
421 	/* case 1: ns.csi == SPDK_NVME_CSI_NVM && !ctrlr.cdata.ctratt.bits.elbas.
422 	 * Expect: false */
423 	ns.csi = SPDK_NVME_CSI_NVM;
424 	ctrlr.cdata.ctratt.bits.elbas = false;
425 	CU_ASSERT(nvme_ns_has_supported_iocs_specific_data(&ns) == false);
426 	/* case 2: ns.csi == SPDK_NVME_CSI_NVM && ctrlr.cdata.ctratt.bits.elbas.
427 	 * Expect: true */
428 	ctrlr.cdata.ctratt.bits.elbas = true;
429 	CU_ASSERT(nvme_ns_has_supported_iocs_specific_data(&ns) == true);
430 	/* case 3: ns.csi == SPDK_NVME_CSI_ZNS. Expect: true */
431 	ctrlr.cdata.ctratt.bits.elbas = false;
432 	ns.csi = SPDK_NVME_CSI_ZNS;
433 	CU_ASSERT(nvme_ns_has_supported_iocs_specific_data(&ns) == true);
434 	/* case 4: default ns.csi == SPDK_NVME_CSI_KV. Expect: false */
435 	ns.csi = SPDK_NVME_CSI_KV;
436 	CU_ASSERT(nvme_ns_has_supported_iocs_specific_data(&ns) == false);
437 }
438 
439 static void
test_nvme_ctrlr_identify_ns_iocs_specific(void)440 test_nvme_ctrlr_identify_ns_iocs_specific(void)
441 {
442 	struct spdk_nvme_ns ns = {};
443 	struct spdk_nvme_ctrlr ctrlr = {};
444 	int rc = 0;
445 
446 	ns.ctrlr = &ctrlr;
447 
448 	ns.csi = SPDK_NVME_CSI_ZNS;
449 	ns.id = 1;
450 
451 	/* case 1: Test nvme_ctrlr_identify_ns_iocs_specific. Expect: PASS. */
452 	rc = nvme_ctrlr_identify_ns_iocs_specific(&ns);
453 	CU_ASSERT(rc == 0);
454 	SPDK_CU_ASSERT_FATAL(ns.nsdata_zns != NULL);
455 	CU_ASSERT(ns.nsdata_zns->mar == 1024);
456 	CU_ASSERT(ns.nsdata_zns->mor == 1024);
457 
458 	/* case 2: Test nvme_ns_free_zns_specific_data. Expect: PASS. */
459 	nvme_ns_free_zns_specific_data(&ns);
460 	CU_ASSERT(ns.nsdata_zns == NULL);
461 
462 	ns.csi = SPDK_NVME_CSI_NVM;
463 	ctrlr.cdata.ctratt.bits.elbas = true;
464 
465 	/* case 3: Test nvme_ctrlr_identify_ns_iocs_specific. Expect: PASS. */
466 	rc = nvme_ctrlr_identify_ns_iocs_specific(&ns);
467 	CU_ASSERT(rc == 0);
468 	SPDK_CU_ASSERT_FATAL(ns.nsdata_nvm != NULL);
469 	CU_ASSERT(ns.nsdata_nvm->lbstm == 0xFFFFFFFF);
470 	CU_ASSERT(ns.nsdata_nvm->pic._16bpists == 1);
471 	CU_ASSERT(ns.nsdata_nvm->pic._16bpistm == 1);
472 	CU_ASSERT(ns.nsdata_nvm->pic.stcrs == 1);
473 	CU_ASSERT(ns.nsdata_nvm->elbaf[0].sts == 32);
474 	CU_ASSERT(ns.nsdata_nvm->elbaf[0].pif == 0);
475 
476 	/* case 4: Test vnme_ns_free_nvm_specific_data. Expect: PASS. */
477 	nvme_ns_free_nvm_specific_data(&ns);
478 	CU_ASSERT(ns.nsdata_nvm == NULL);
479 }
480 
481 static void
test_nvme_ctrlr_identify_id_desc(void)482 test_nvme_ctrlr_identify_id_desc(void)
483 {
484 	struct spdk_nvme_ns ns = {};
485 	struct spdk_nvme_ctrlr ctrlr = {};
486 	int rc;
487 
488 	ns.ctrlr = &ctrlr;
489 	ns.ctrlr->vs.raw = SPDK_NVME_VERSION(1, 3, 0);
490 	ns.ctrlr->cap.bits.css |= SPDK_NVME_CAP_CSS_IOCS;
491 	ns.id = 1;
492 
493 	rc = nvme_ctrlr_identify_id_desc(&ns);
494 	CU_ASSERT(rc == 0);
495 	CU_ASSERT(g_ut_cmd.cdw10_bits.identify.cns == SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST);
496 	CU_ASSERT(g_ut_cmd.cdw10_bits.identify.cntid == 0);
497 	CU_ASSERT(g_ut_cmd.cdw11_bits.identify.csi == spdk_nvme_ns_get_csi(&ns));
498 	CU_ASSERT(g_ut_cmd.nsid == 1);
499 
500 	/* NVME version and css unsupported */
501 	ns.ctrlr->vs.raw = SPDK_NVME_VERSION(1, 2, 0);
502 	ns.ctrlr->cap.bits.css &= ~SPDK_NVME_CAP_CSS_IOCS;
503 
504 	rc = nvme_ctrlr_identify_id_desc(&ns);
505 	CU_ASSERT(rc == 0);
506 }
507 
508 static void
test_nvme_ns_find_id_desc(void)509 test_nvme_ns_find_id_desc(void)
510 {
511 	struct spdk_nvme_ns ns = {};
512 	struct spdk_nvme_ns_id_desc *desc = NULL;
513 	const uint8_t *csi = NULL;
514 	size_t length = 0;
515 
516 	desc = (void *)ns.id_desc_list;
517 	desc->nidl = 4;
518 	desc->nidt = SPDK_NVME_NIDT_CSI;
519 
520 	/* Case 1: get id descriptor successfully */
521 	csi = nvme_ns_find_id_desc(&ns, SPDK_NVME_NIDT_CSI, &length);
522 	CU_ASSERT(csi == desc->nid);
523 	CU_ASSERT(length == 4);
524 
525 	/* Case 2: ns_id length invalid, expect fail */
526 	desc->nidl = 0;
527 
528 	csi = nvme_ns_find_id_desc(&ns, SPDK_NVME_NIDT_CSI, &length);
529 	CU_ASSERT(csi == NULL);
530 
531 	/* Case 3: No correct id descriptor type entry, expect fail */
532 	desc->nidl = 4;
533 	desc->nidt = SPDK_NVME_NIDT_CSI;
534 
535 	csi = nvme_ns_find_id_desc(&ns, SPDK_NVME_NIDT_UUID, &length);
536 	CU_ASSERT(csi == NULL);
537 }
538 
539 int
main(int argc,char ** argv)540 main(int argc, char **argv)
541 {
542 	CU_pSuite	suite = NULL;
543 	unsigned int	num_failures;
544 
545 	CU_initialize_registry();
546 
547 	suite = CU_add_suite("nvme", NULL, NULL);
548 
549 	CU_ADD_TEST(suite, test_nvme_ns_construct);
550 	CU_ADD_TEST(suite, test_nvme_ns_uuid);
551 	CU_ADD_TEST(suite, test_nvme_ns_csi);
552 	CU_ADD_TEST(suite, test_nvme_ns_data);
553 	CU_ADD_TEST(suite, test_nvme_ns_set_identify_data);
554 	CU_ADD_TEST(suite, test_spdk_nvme_ns_get_values);
555 	CU_ADD_TEST(suite, test_spdk_nvme_ns_is_active);
556 	CU_ADD_TEST(suite, spdk_nvme_ns_supports);
557 	CU_ADD_TEST(suite, test_nvme_ns_has_supported_iocs_specific_data);
558 	CU_ADD_TEST(suite, test_nvme_ctrlr_identify_ns_iocs_specific);
559 	CU_ADD_TEST(suite, test_nvme_ctrlr_identify_id_desc);
560 	CU_ADD_TEST(suite, test_nvme_ns_find_id_desc);
561 
562 	num_failures = spdk_ut_run_tests(argc, argv, NULL);
563 	CU_cleanup_registry();
564 	return num_failures;
565 }
566