Commit 95b76c4d authored by Tomasz Zawadzki's avatar Tomasz Zawadzki Committed by Jim Harris
Browse files

test/external_code: replace copies of test apps with symbolic links 



The files for external_code tests were copies of the same files
in SPDK. Intention of external_code tests is to verify
that nothing breaks in regards to building process.

The copies were getting out of sync with functional changes.
So to address this:
- hello_bdev app is now symlinked
- vbdev_passthrough is copied from respective files
- RPC and name of the module were changed to not conflict with
the original passthrough module

Signed-off-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: Idb83b8a06dea7143505d2062b23bfb35c86e3274
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4804


Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent 1cb73242

test/external_code/README.md

+1 −1
Original line number Diff line number Diff line
@@ -12,6 +12,6 @@ repository and should be run as follows: 
sudo ./test_make.sh /path/to/spdk

~~~



The application `hello_world` and bdev module `passthru_external` have been copied from their namesakes

The application `hello_bdev` is a symlink and bdev module `passthru_external` have been copied from their namesakes

in the top level [SPDK github repository](https://github.com/spdk/spdk) and don't have any special

functionality.

test/external_code/hello_world/hello_bdev.c

deleted100644 → 0
+1 −300
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 "spdk/thread.h"

#include "spdk/bdev.h"

#include "spdk/env.h"

#include "spdk/event.h"

#include "spdk/log.h"

#include "spdk/string.h"

#include "spdk/bdev_module.h"



static char *g_bdev_name = "Malloc0";



/*

 * We'll use this struct to gather housekeeping hello_context to pass between

 * our events and callbacks.

 */

struct hello_context_t {

	struct spdk_bdev *bdev;

	struct spdk_bdev_desc *bdev_desc;

	struct spdk_io_channel *bdev_io_channel;

	char *buff;

	char *bdev_name;

	struct spdk_bdev_io_wait_entry bdev_io_wait;

};



/*

 * Usage function for printing parameters that are specific to this application

 */

static void

hello_bdev_usage(void)

{

	printf(" -b <bdev>                 name of the bdev to use\n");

}



/*

 * This function is called to parse the parameters that are specific to this application

 */

static int hello_bdev_parse_arg(int ch, char *arg)

{

	switch (ch) {

	case 'b':

		g_bdev_name = arg;

		break;

	default:

		return -EINVAL;

	}

	return 0;

}



/*

 * Callback function for read io completion.

 */

static void

read_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)

{

	struct hello_context_t *hello_context = cb_arg;



	if (success) {

		SPDK_NOTICELOG("Read string from bdev : %s\n", hello_context->buff);

	} else {

		SPDK_ERRLOG("bdev io read error\n");

	}



	/* Complete the bdev io and close the channel */

	spdk_bdev_free_io(bdev_io);

	spdk_put_io_channel(hello_context->bdev_io_channel);

	spdk_bdev_close(hello_context->bdev_desc);

	SPDK_NOTICELOG("Stopping app\n");

	spdk_app_stop(success ? 0 : -1);

}



static void

hello_read(void *arg)

{

	struct hello_context_t *hello_context = arg;

	int rc = 0;

	uint32_t length = spdk_bdev_get_block_size(hello_context->bdev);



	SPDK_NOTICELOG("Reading io\n");

	rc = spdk_bdev_read(hello_context->bdev_desc, hello_context->bdev_io_channel,

			    hello_context->buff, 0, length, read_complete, hello_context);



	if (rc == -ENOMEM) {

		SPDK_NOTICELOG("Queueing io\n");

		/* In case we cannot perform I/O now, queue I/O */

		hello_context->bdev_io_wait.bdev = hello_context->bdev;

		hello_context->bdev_io_wait.cb_fn = hello_read;

		hello_context->bdev_io_wait.cb_arg = hello_context;

		spdk_bdev_queue_io_wait(hello_context->bdev, hello_context->bdev_io_channel,

					&hello_context->bdev_io_wait);

	} else if (rc) {

		SPDK_ERRLOG("%s error while reading from bdev: %d\n", spdk_strerror(-rc), rc);

		spdk_put_io_channel(hello_context->bdev_io_channel);

		spdk_bdev_close(hello_context->bdev_desc);

		spdk_app_stop(-1);

	}

}



/*

 * Callback function for write io completion.

 */

static void

write_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)

{

	struct hello_context_t *hello_context = cb_arg;

	uint32_t length;



	/* Complete the I/O */

	spdk_bdev_free_io(bdev_io);



	if (success) {

		SPDK_NOTICELOG("bdev io write completed successfully\n");

	} else {

		SPDK_ERRLOG("bdev io write error: %d\n", EIO);

		spdk_put_io_channel(hello_context->bdev_io_channel);

		spdk_bdev_close(hello_context->bdev_desc);

		spdk_app_stop(-1);

		return;

	}



	/* Zero the buffer so that we can use it for reading */

	length = spdk_bdev_get_block_size(hello_context->bdev);

	memset(hello_context->buff, 0, length);



	hello_read(hello_context);

}



static void

hello_write(void *arg)

{

	struct hello_context_t *hello_context = arg;

	int rc = 0;

	uint32_t length = spdk_bdev_get_block_size(hello_context->bdev);



	SPDK_NOTICELOG("Writing to the bdev\n");

	rc = spdk_bdev_write(hello_context->bdev_desc, hello_context->bdev_io_channel,

			     hello_context->buff, 0, length, write_complete, hello_context);



	if (rc == -ENOMEM) {

		SPDK_NOTICELOG("Queueing io\n");

		/* In case we cannot perform I/O now, queue I/O */

		hello_context->bdev_io_wait.bdev = hello_context->bdev;

		hello_context->bdev_io_wait.cb_fn = hello_write;

		hello_context->bdev_io_wait.cb_arg = hello_context;

		spdk_bdev_queue_io_wait(hello_context->bdev, hello_context->bdev_io_channel,

					&hello_context->bdev_io_wait);

	} else if (rc) {

		SPDK_ERRLOG("%s error while writing to bdev: %d\n", spdk_strerror(-rc), rc);

		spdk_put_io_channel(hello_context->bdev_io_channel);

		spdk_bdev_close(hello_context->bdev_desc);

		spdk_app_stop(-1);

	}

}



/*

 * Our initial event that kicks off everything from main().

 */

static void

hello_start(void *arg1)

{

	struct hello_context_t *hello_context = arg1;

	uint32_t blk_size, buf_align;

	int rc = 0;

	hello_context->bdev = NULL;

	hello_context->bdev_desc = NULL;



	SPDK_NOTICELOG("Successfully started the application\n");



	/*

	 * Get the bdev. There can be many bdevs configured in

	 * in the configuration file but this application will only

	 * use the one input by the user at runtime so we get it via its name.

	 */

	hello_context->bdev = spdk_bdev_get_by_name(hello_context->bdev_name);

	if (hello_context->bdev == NULL) {

		SPDK_ERRLOG("Could not find the bdev: %s\n", hello_context->bdev_name);

		spdk_app_stop(-1);

		return;

	}



	/*

	 * Open the bdev by calling spdk_bdev_open()

	 * The function will return a descriptor

	 */

	SPDK_NOTICELOG("Opening the bdev %s\n", hello_context->bdev_name);

	rc = spdk_bdev_open(hello_context->bdev, true, NULL, NULL, &hello_context->bdev_desc);

	if (rc) {

		SPDK_ERRLOG("Could not open bdev: %s\n", hello_context->bdev_name);

		spdk_app_stop(-1);

		return;

	}



	SPDK_NOTICELOG("Opening io channel\n");

	/* Open I/O channel */

	hello_context->bdev_io_channel = spdk_bdev_get_io_channel(hello_context->bdev_desc);

	if (hello_context->bdev_io_channel == NULL) {

		SPDK_ERRLOG("Could not create bdev I/O channel!!\n");

		spdk_bdev_close(hello_context->bdev_desc);

		spdk_app_stop(-1);

		return;

	}



	/* Allocate memory for the write buffer.

	 * Initialize the write buffer with the string "Hello World!"

	 */

	blk_size = spdk_bdev_get_block_size(hello_context->bdev);

	buf_align = spdk_bdev_get_buf_align(hello_context->bdev);

	hello_context->buff = spdk_dma_zmalloc(blk_size, buf_align, NULL);

	if (!hello_context->buff) {

		SPDK_ERRLOG("Failed to allocate buffer\n");

		spdk_put_io_channel(hello_context->bdev_io_channel);

		spdk_bdev_close(hello_context->bdev_desc);

		spdk_app_stop(-1);

		return;

	}

	snprintf(hello_context->buff, blk_size, "%s", "Hello World!\n");



	hello_write(hello_context);

}



int

main(int argc, char **argv)

{

	struct spdk_app_opts opts = {};

	int rc = 0;

	struct hello_context_t hello_context = {};



	/* Set default values in opts structure. */

	spdk_app_opts_init(&opts);

	opts.name = "hello_bdev";



	/*

	 * The user can provide the config file and bdev name at run time.

	 * For example, to use Malloc0 in file bdev.json run with params

	 * ./hello_bdev --json bdev.json -b Malloc0

	 * To use passthru bdev PT0 run with params

	 * ./hello_bdev --json bdev.json -b PT0

	 * If the bdev name is not specified,

	 * then Malloc0 is used by default

	 */

	if ((rc = spdk_app_parse_args(argc, argv, &opts, "b:", NULL, hello_bdev_parse_arg,

				      hello_bdev_usage)) != SPDK_APP_PARSE_ARGS_SUCCESS) {

		exit(rc);

	}

	if (opts.json_config_file == NULL) {

		SPDK_ERRLOG("configfile must be specified using --json <conffile> e.g. --json bdev.json\n");

		exit(1);

	}

	hello_context.bdev_name = g_bdev_name;



	/*

	 * spdk_app_start() will block running hello_start() until

	 * spdk_app_stop() is called by someone (not simply when

	 * hello_start() returns), or if an error occurs during

	 * spdk_app_start() before hello_start() runs.

	 */

	rc = spdk_app_start(&opts, hello_start, &hello_context);

	if (rc) {

		SPDK_ERRLOG("ERROR starting application\n");

	}



	/* When the app stops, free up memory that we allocated. */

	spdk_dma_free(hello_context.buff);



	/* Gracefully close out all of the SPDK subsystems. */

	spdk_app_fini();

	return rc;

}

test/external_code/hello_world/hello_bdev.c

0 → 120000
+1 −300
Original line number Diff line number Diff line 
./../../../examples/bdev/hello_world/hello_bdev.c
 
 No newline at end of file

test/external_code/passthru/vbdev_passthru.c

+135 −115

File changed.

Preview size limit exceeded, changes collapsed.

test/external_code/passthru/vbdev_passthru.h

+3 −7
Original line number Diff line number Diff line
@@ -38,10 +38,6 @@ 


#include "spdk/bdev.h"

#include "spdk/bdev_module.h"

#include "spdk/log.h"

#include "spdk/rpc.h"

#include "spdk/string.h"

#include "spdk/util.h"



/**

 * Create new pass through bdev.
@@ -50,7 +46,7 @@ 
 * \param vbdev_name Name of the pass through bdev.

 * \return 0 on success, other on failure.

 */

int create_passthru_disk(const char *bdev_name, const char *vbdev_name);

int bdev_passthru_create_disk(const char *bdev_name, const char *vbdev_name);



/**

 * Delete passthru bdev.
@@ -59,7 +55,7 @@ int create_passthru_disk(const char *bdev_name, const char *vbdev_name); 
 * \param cb_fn Function to call after deletion.

 * \param cb_arg Argument to pass to cb_fn.

 */

void delete_passthru_disk(struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn,

void bdev_passthru_delete_disk(struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn,

			       void *cb_arg);



#endif /* SPDK_VBDEV_PASSTHRU_H */