Commit 38317981 authored by Hailiang Wang's avatar Hailiang Wang Committed by Daniel Verkamp
Browse files

Gpt: add unit tests for parse,check_mbr,read_header,read_partitions functions. 



Change-Id: I45c6f696052213b00c8db0c9c63e01d14b900672
Signed-off-by: default avatarHailiang Wang <hailiangx.e.wang@intel.com>
Reviewed-on: https://review.gerrithub.io/370775


Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Tested-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent e2b76ec8

test/unit/lib/bdev/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ 
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../..)

include $(SPDK_ROOT_DIR)/mk/spdk.common.mk



DIRS-y = bdev.c scsi_nvme.c

DIRS-y = bdev.c scsi_nvme.c gpt



.PHONY: all clean $(DIRS-y)

test/unit/lib/bdev/gpt/Makefile

0 → 100644
+44 −0
Original line number Diff line number Diff line 
#

#  BSD LICENSE

#

#  Copyright (c) Intel Corporation.

#  All rights reserved.

#

#  Redistribution and use in source and binary forms, with or without

#  modification, are permitted provided that the following conditions

#  are met:

#

#    * Redistributions of source code must retain the above copyright

#      notice, this list of conditions and the following disclaimer.

#    * Redistributions in binary form must reproduce the above copyright

#      notice, this list of conditions and the following disclaimer in

#      the documentation and/or other materials provided with the

#      distribution.

#    * Neither the name of Intel Corporation nor the names of its

#      contributors may be used to endorse or promote products derived

#      from this software without specific prior written permission.

#

#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

#  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

#  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

#  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#



SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../../..)

include $(SPDK_ROOT_DIR)/mk/spdk.common.mk



DIRS-y = gpt.c



.PHONY: all clean $(DIRS-y)



all: $(DIRS-y)

clean: $(DIRS-y)



include $(SPDK_ROOT_DIR)/mk/spdk.subdirs.mk

test/unit/lib/bdev/gpt/gpt.c/.gitignore

0 → 100644
+1 −0
Original line number Diff line number Diff line 
gpt_ut

test/unit/lib/bdev/gpt/gpt.c/Makefile

0 → 100644
+56 −0
Original line number Diff line number Diff line 
#

#  BSD LICENSE

#

#  Copyright (c) Intel Corporation.

#  All rights reserved.

#

#  Redistribution and use in source and binary forms, with or without

#  modification, are permitted provided that the following conditions

#  are met:

#

#    * Redistributions of source code must retain the above copyright

#      notice, this list of conditions and the following disclaimer.

#    * Redistributions in binary form must reproduce the above copyright

#      notice, this list of conditions and the following disclaimer in

#      the documentation and/or other materials provided with the

#      distribution.

#    * Neither the name of the copyright holder nor the names of its

#      contributors may be used to endorse or promote products derived

#      from this software without specific prior written permission.

#

#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

#  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

#  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

#  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#



SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../../../..)

include $(SPDK_ROOT_DIR)/mk/spdk.common.mk

include $(SPDK_ROOT_DIR)/mk/spdk.app.mk



SPDK_LIB_LIST = log cunit



CFLAGS += -I$(SPDK_ROOT_DIR)/test

CFLAGS += -I$(SPDK_ROOT_DIR)/lib/bdev

LIBS += $(SPDK_LIB_LINKER_ARGS)

LIBS += -lcunit



APP = gpt_ut

C_SRCS = gpt_ut.c



all: $(APP)



$(APP): $(OBJS) $(SPDK_LIB_FILES)

	$(LINK_C)



clean:

	$(CLEAN_C) $(APP)



include $(SPDK_ROOT_DIR)/mk/spdk.deps.mk

test/unit/lib/bdev/gpt/gpt.c/gpt_ut.c

0 → 100644
+297 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright (c) Intel Corporation.

 *   All rights reserved.

 *

 *   Redistribution and use in source and binary forms, with or without

 *   modification, are permitted provided that the following conditions

 *   are met:

 *

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in

 *       the documentation and/or other materials provided with the

 *       distribution.

 *     * Neither the name of the copyright holder nor the names of its

 *       contributors may be used to endorse or promote products derived

 *       from this software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



#include "spdk_cunit.h"



#include "lib/test_env.c"



#include "gpt/gpt.c"



static void

test_check_mbr(void)

{

	struct spdk_gpt *gpt;

	struct spdk_mbr *mbr;

	unsigned char a[SPDK_GPT_BUFFER_SIZE];

	int re;



	/* spdk_gpt_check_mbr(NULL) does not exist, NULL is filtered out in spdk_gpt_parse() */

	gpt = calloc(1, sizeof(*gpt));

	SPDK_CU_ASSERT_FATAL(gpt != NULL);



	/* Set *gpt is "aaa...", all are mismatch include mbr_signature */

	memset(a, 'a', sizeof(a));

	gpt->buf = &a[0];

	re = spdk_gpt_check_mbr(gpt);

	CU_ASSERT(re == -1);



	/* Set mbr->mbr_signature matched, start lba mismatch */

	mbr = (struct spdk_mbr *)gpt->buf;

	mbr->mbr_signature = 0xAA55;

	re = spdk_gpt_check_mbr(gpt);

	CU_ASSERT(re == -1);



	/* Set mbr->partitions[0].start lba matched, os_type mismatch */

	mbr->partitions[0].start_lba = 1;

	re = spdk_gpt_check_mbr(gpt);

	CU_ASSERT(re == -1);



	/* Set mbr->partitions[0].os_type matched, size_lba mismatch */

	mbr->partitions[0].os_type = 0xEE;

	re = spdk_gpt_check_mbr(gpt);

	CU_ASSERT(re == -1);



	/* Set mbr->partitions[0].size_lba matched, passing case */

	mbr->partitions[0].size_lba = 0xFFFFFFFF;

	re = spdk_gpt_check_mbr(gpt);

	CU_ASSERT(re == 0);



	free(gpt);

}



static void

test_read_header(void)

{

	struct spdk_gpt *gpt;

	struct spdk_gpt_header *head;

	unsigned char a[SPDK_GPT_BUFFER_SIZE];

	int re;



	/* spdk_gpt_read_header(NULL) does not exist, NULL is filtered out in spdk_gpt_parse() */

	gpt = calloc(1, sizeof(*gpt));

	SPDK_CU_ASSERT_FATAL(gpt != NULL);



	/* Set *gpt is "aaa..." */

	memset(a, 'a', sizeof(a));

	gpt->buf = &a[0];



	/* Set header_size mismatch */

	gpt->sector_size = 512;

	head = (struct spdk_gpt_header *)(gpt->buf + GPT_PRIMARY_PARTITION_TABLE_LBA * gpt->sector_size);

	to_le32(&head->header_size, 0x258);

	re = spdk_gpt_read_header(gpt);

	CU_ASSERT(re == -1);



	/* Set head->header_size matched, header_crc32 mismatch */

	head->header_size = sizeof(*head);

	to_le32(&head->header_crc32, 0x22D18C80);

	re = spdk_gpt_read_header(gpt);

	CU_ASSERT(re == -1);



	/* Set head->header_crc32 matched, gpt_signature mismatch */

	to_le32(&head->header_crc32, 0xC5B2117E);

	re = spdk_gpt_read_header(gpt);

	CU_ASSERT(re == -1);



	/* Set head->gpt_signature matched, lba_end usable_lba mismatch */

	to_le32(&head->header_crc32, 0xD637335A);

	head->gpt_signature[0] = 'E';

	head->gpt_signature[1] = 'F';

	head->gpt_signature[2] = 'I';

	head->gpt_signature[3] = ' ';

	head->gpt_signature[4] = 'P';

	head->gpt_signature[5] = 'A';

	head->gpt_signature[6] = 'R';

	head->gpt_signature[7] = 'T';

	re = spdk_gpt_read_header(gpt);

	CU_ASSERT(re == -1);



	/* Set gpt->lba_end usable_lba matched, passing case */

	to_le32(&head->header_crc32, 0x30CB7378);

	to_le64(&gpt->lba_start, 0x0);

	to_le64(&gpt->lba_end, 0x2E935FFE);

	to_le64(&head->first_usable_lba, 0xA);

	to_le64(&head->last_usable_lba, 0xF4240);

	re = spdk_gpt_read_header(gpt);

	CU_ASSERT(re == 0);



	free(gpt);

}



static void

test_read_partitions(void)

{

	struct spdk_gpt *gpt;

	struct spdk_gpt_header *head;

	unsigned char a[SPDK_GPT_BUFFER_SIZE];

	int re;



	/* spdk_gpt_read_partitions(NULL) does not exist, NULL is filtered out in spdk_gpt_parse() */

	gpt = calloc(1, sizeof(*gpt));

	SPDK_CU_ASSERT_FATAL(gpt != NULL);



	/* Set *gpt is "aaa..." */

	memset(a, 'a', sizeof(a));

	gpt->buf = &a[0];



	/* Set num_partition_entries exceeds Max vaule of entries GPT supported */

	gpt->sector_size = 512;

	head = (struct spdk_gpt_header *)(gpt->buf + GPT_PRIMARY_PARTITION_TABLE_LBA * gpt->sector_size);

	gpt->header = head;

	to_le32(&head->num_partition_entries, 0x100);

	re = spdk_gpt_read_partitions(gpt);

	CU_ASSERT(re == -1);



	/* Set num_partition_entries within Max vaule, size_of_partition_entry mismatch */

	to_le32(&head->header_crc32, 0x573857BE);

	to_le32(&head->num_partition_entries, 0x40);

	to_le32(&head->size_of_partition_entry, 0x0);

	re = spdk_gpt_read_partitions(gpt);

	CU_ASSERT(re == -1);



	/* Set size_of_partition_entry matched, partition_entry_lba mismatch */

	to_le32(&head->header_crc32, 0x5279B712);

	to_le32(&head->size_of_partition_entry, 0x80);

	to_le64(&head->partition_entry_lba, 0x64);

	re = spdk_gpt_read_partitions(gpt);

	CU_ASSERT(re == -1);



	/* Set partition_entry_lba matched, partition_entry_array_crc32 mismatch */

	to_le32(&head->header_crc32, 0xEC093B43);

	to_le64(&head->partition_entry_lba, 0x20);

	to_le32(&head->partition_entry_array_crc32, 0x0);

	re = spdk_gpt_read_partitions(gpt);

	CU_ASSERT(re == -1);



	/* Set partition_entry_array_crc32 matched, passing case */

	to_le32(&head->header_crc32, 0xE1A08822);

	to_le32(&head->partition_entry_array_crc32, 0xEBEE44FB);

	to_le32(&head->num_partition_entries, 0x80);

	re = spdk_gpt_read_partitions(gpt);

	CU_ASSERT(re == 0);



	free(gpt);

}



static void

test_parse(void)

{

	struct spdk_gpt *gpt;

	struct spdk_mbr *mbr;

	struct spdk_gpt_header *head;

	unsigned char a[SPDK_GPT_BUFFER_SIZE];

	int re;



	/* Set gpt is NULL */

	re = spdk_gpt_parse(NULL);

	CU_ASSERT(re == -1);



	/* Set gpt->buf is NULL */

	gpt = calloc(1, sizeof(*gpt));

	SPDK_CU_ASSERT_FATAL(gpt != NULL);

	re = spdk_gpt_parse(gpt);

	CU_ASSERT(re == -1);



	/* Set *gpt is "aaa...", check_mbr failed */

	memset(a, 'a', sizeof(a));

	gpt->buf = &a[0];

	re = spdk_gpt_parse(gpt);

	CU_ASSERT(re == -1);



	/* Set check_mbr passed, read_header failed */

	mbr = (struct spdk_mbr *)gpt->buf;

	mbr->mbr_signature = 0xAA55;

	mbr->partitions[0].start_lba = 1;

	mbr->partitions[0].os_type = 0xEE;

	mbr->partitions[0].size_lba = 0xFFFFFFFF;

	re = spdk_gpt_parse(gpt);

	CU_ASSERT(re == -1);



	/* Set read_header passed, read_partitions failed */

	gpt->sector_size = 512;

	head = (struct spdk_gpt_header *)(gpt->buf + GPT_PRIMARY_PARTITION_TABLE_LBA * gpt->sector_size);

	head->header_size = sizeof(*head);

	head->gpt_signature[0] = 'E';

	head->gpt_signature[1] = 'F';

	head->gpt_signature[2] = 'I';

	head->gpt_signature[3] = ' ';

	head->gpt_signature[4] = 'P';

	head->gpt_signature[5] = 'A';

	head->gpt_signature[6] = 'R';

	head->gpt_signature[7] = 'T';

	to_le32(&head->header_crc32, 0x30CB7378);

	to_le64(&gpt->lba_start, 0x0);

	to_le64(&gpt->lba_end, 0x2E935FFE);

	to_le64(&head->first_usable_lba, 0xA);

	to_le64(&head->last_usable_lba, 0xF4240);

	re = spdk_gpt_parse(gpt);

	CU_ASSERT(re == -1);



	/* Set read_partitions passed, all passed */

	to_le32(&head->size_of_partition_entry, 0x80);

	to_le64(&head->partition_entry_lba, 0x20);

	to_le32(&head->header_crc32, 0xE1A08822);

	to_le32(&head->partition_entry_array_crc32, 0xEBEE44FB);

	to_le32(&head->num_partition_entries, 0x80);

	re = spdk_gpt_parse(gpt);

	CU_ASSERT(re == 0);



	free(gpt);

}



int

main(int argc, char **argv)

{

	CU_pSuite	suite = NULL;

	unsigned int	num_failures;



	if (CU_initialize_registry() != CUE_SUCCESS) {

		return CU_get_error();

	}



	suite = CU_add_suite("gpt_parse", NULL, NULL);

	if (suite == NULL) {

		CU_cleanup_registry();

		return CU_get_error();

	}



	if (

		CU_add_test(suite, "parse",

			    test_parse) == NULL ||

		CU_add_test(suite, "check mbr",

			    test_check_mbr) == NULL ||

		CU_add_test(suite, "read header",

			    test_read_header) == NULL ||

		CU_add_test(suite, "read partitions",

			    test_read_partitions) == NULL

	) {

		CU_cleanup_registry();

		return CU_get_error();

	}



	CU_basic_set_mode(CU_BRM_VERBOSE);

	CU_basic_run_tests();

	num_failures = CU_get_number_of_failures();

	CU_cleanup_registry();

	return num_failures;

}