Commit 91b30e7a authored by Konrad Sztyber's avatar Konrad Sztyber Committed by Tomasz Zawadzki
Browse files

test/external_code: initial definitions for basic NVMe driver 



This patch introduces initial definitions for a stripped down version of
an out-of-tree NVMe driver.  It's purpose is to showcase SPDK's
interfaces for writing user-space drivers for various types of devices.
The choice of NVMe as the example is based on the fact that it can be
emulated by QEMU and the code can be borrowed from SPDK's regular NVMe
driver.

This driver will only provide the most basic functionalities (e.g.
device probing, controller initialization, only admin queue support,
etc.) and won't have support for any device quirks.  Therefore, it's
only intented to be used with emulated devices.

In addition, an application utilizing the driver to list all available
NVMe controllers and print their identify data will be added.  It'll
be a very basic, stripped down version of `examples/nvme/identify`.

Signed-off-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Change-Id: I67c748aabf75a37ca72dfb74301a610f7c4ae2bc
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6663


Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent e8cde795

test/common/skipped_build_files.txt

+2 −0
Original line number Diff line number Diff line
@@ -32,3 +32,5 @@ test/unit/lib/sock/uring.c/uring_ut 
test/external_code/hello_world/hello_bdev

test/external_code/passthru/vbdev_passthru

test/external_code/passthru/vbdev_passthru_rpc

test/external_code/nvme/nvme

test/external_code/nvme/identify

test/external_code/Makefile

+10 −3
Original line number Diff line number Diff line
@@ -31,7 +31,7 @@ 
#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#



ALL_DEPDIRS+= hello_world passthru

ALL_DEPDIRS+= hello_world passthru nvme



ifneq ($(SPDK_HEADER_DIR),)

COMMON_CFLAGS+=-I$(SPDK_HEADER_DIR)
@@ -51,9 +51,9 @@ endif 
export

.PHONY: all



all: hello_world_bdev_shared_combo

all: hello_world_bdev_shared_combo nvme_shared



static: hello_world_bdev_static

static: hello_world_bdev_static nvme_static



hello_world_bdev_shared_combo: passthru_shared

	$(MAKE) --directory=hello_world bdev_shared_combo
@@ -79,6 +79,13 @@ passthru_shared: 
passthru_static:

	$(MAKE) --directory=passthru static



nvme_shared:

	$(MAKE) --directory=nvme shared



nvme_static:

	$(MAKE) --directory=nvme static



clean:

	rm -f ./hello_world/hello_bdev

	rm -f ./passthru/libpassthru_external.*

	rm -f ./nvme/*.{so,o} ./nvme/identify

test/external_code/nvme/.gitignore

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

test/external_code/nvme/Makefile

0 → 100644
+46 −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.

#



PKG_CONFIG_PATH = $(SPDK_LIB_DIR)/pkgconfig



DEPLIBS := $(shell PKG_CONFIG_PATH="$(PKG_CONFIG_PATH)" pkg-config --libs spdk_log)



shared:

	$(CC) $(COMMON_CFLAGS) -c -fPIC nvme.c -o nvme.o

	$(CC) $(COMMON_CFLAGS) -shared nvme.o -o libnvme_external.so

	$(CC) $(COMMON_CFLAGS) identify.c -o identify -L. -lnvme_external \

		-Wl,-rpath=$(SPDK_LIB_DIR) $(DEPLIBS)



static:

	$(CC) $(COMMON_CFLAGS) nvme.c identify.c -o identify -Wl,--whole-archive \

		$(DEPLIBS) -Wl,--no-whole-archive

test/external_code/nvme/identify.c

0 → 100644
+51 −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.

 */



#include "spdk/stdinc.h"

#include "nvme.h"



int

main(int argc, const char **argv)

{

	int rc;



	(void)argc;



	rc = nvme_probe(NULL, NULL);

	if (rc != 0) {

		fprintf(stderr, "%s: nvme probe failed\n", argv[0]);

		return 1;

	}



	return 0;

}