bdev/compress: add compression vbdev module (db541f8e) · Commits · Public Repositories / spdk

lib/bdev/Makefile

+4 −0

Original line number	Diff line number	Diff line
		@@ -54,6 +54,10 @@ DIRS-y += ocf/env
		DEPDIRS-ocf := ocf/env
		endif

		ifeq ($(CONFIG_REDUCE),y)
		DIRS-y += compress
		endif

		ifeq ($(OS),Linux)
		DIRS-y += aio
		DIRS-$(CONFIG_ISCSI_INITIATOR) += iscsi

lib/bdev/compress/Makefile

0 → 100644

+43 −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

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

		C_SRCS = vbdev_compress.c vbdev_compress_rpc.c
		LIBNAME = bdev_compress
		CFLAGS += $(ENV_CFLAGS)

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

lib/bdev/compress/vbdev_compress.c

0 → 100644

+841 −0

File added.

Preview size limit exceeded, changes collapsed.

lib/bdev/compress/vbdev_compress.h

0 → 100644

+63 −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.
		*/

		#ifndef SPDK_VBDEV_COMPRESS_H
		#define SPDK_VBDEV_COMPRESS_H

		#include "spdk/stdinc.h"

		#include "spdk/bdev.h"

		typedef void (spdk_delete_compress_complete)(void cb_arg, int bdeverrno);

		/**
		* Create new compression bdev.
		*
		* \param bdev_name Bdev on which compression vbdev will be created.
		* \param vbdev_name Vbdev name.
		* \param comp_pmd Compression PMD name.
		* \return 0 on success, other on failure.
		*/
		int create_compress_disk(const char bdev_name, const char vbdev_name, const char *comp_pmd);

		/**
		* Delete compress bdev.
		*
		* \param bdev Pointer to compression bdev.
		* \param cb_fn Function to call after deletion.
		* \param cb_arg Argument to pass to cb_fn.
		*/
		void delete_compress_disk(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn,
		void *cb_arg);

		#endif /* SPDK_VBDEV_COMPRESS_H */

lib/bdev/compress/vbdev_compress_rpc.c

0 → 100644

+163 −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 "vbdev_compress.h"
		#include "spdk/rpc.h"
		#include "spdk/util.h"
		#include "spdk/string.h"
		#include "spdk_internal/log.h"

		/* Structure to hold the parameters for this RPC method. */
		struct rpc_construct_compress {
		char *base_bdev_name;
		char *name;
		char *comp_pmd;
		};

		/* Free the allocated memory resource after the RPC handling. */
		static void
		free_rpc_construct_compress(struct rpc_construct_compress *r)
		{
		free(r->base_bdev_name);
		free(r->name);
		free(r->comp_pmd);
		}

		/* Structure to decode the input parameters for this RPC method. */
		static const struct spdk_json_object_decoder rpc_construct_compress_decoders[] = {
		{"base_bdev_name", offsetof(struct rpc_construct_compress, base_bdev_name), spdk_json_decode_string},
		{"name", offsetof(struct rpc_construct_compress, name), spdk_json_decode_string},
		{"comp_pmd", offsetof(struct rpc_construct_compress, comp_pmd), spdk_json_decode_string},
		};

		/* Decode the parameters for this RPC method and properly construct the compress
		* device. Error status returned in the failed cases.
		*/
		static void
		spdk_rpc_construct_compress_bdev(struct spdk_jsonrpc_request *request,
		const struct spdk_json_val *params)
		{
		struct rpc_construct_compress req = {NULL};
		struct spdk_json_write_ctx *w;
		int rc;

		if (spdk_json_decode_object(params, rpc_construct_compress_decoders,
		SPDK_COUNTOF(rpc_construct_compress_decoders),
		&req)) {
		SPDK_DEBUGLOG(SPDK_LOG_VBDEV_COMPRESS, "spdk_json_decode_object failed\n");
		goto invalid;
		}

		rc = create_compress_disk(req.base_bdev_name, req.name, req.comp_pmd);
		if (rc != 0) {
		goto invalid;
		}

		w = spdk_jsonrpc_begin_result(request);
		if (w == NULL) {
		free_rpc_construct_compress(&req);
		return;
		}

		spdk_json_write_string(w, req.name);
		spdk_jsonrpc_end_result(request, w);
		free_rpc_construct_compress(&req);
		return;

		invalid:
		free_rpc_construct_compress(&req);
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
		}
		SPDK_RPC_REGISTER("construct_compress_bdev", spdk_rpc_construct_compress_bdev, SPDK_RPC_RUNTIME)

		struct rpc_delete_compress {
		char *name;
		};

		static void
		free_rpc_delete_compress(struct rpc_delete_compress *req)
		{
		free(req->name);
		}

		static const struct spdk_json_object_decoder rpc_delete_compress_decoders[] = {
		{"name", offsetof(struct rpc_delete_compress, name), spdk_json_decode_string},
		};

		static void
		_spdk_rpc_delete_compress_bdev_cb(void *cb_arg, int bdeverrno)
		{
		struct spdk_jsonrpc_request *request = cb_arg;
		struct spdk_json_write_ctx *w;

		w = spdk_jsonrpc_begin_result(request);
		if (w == NULL) {
		return;
		}

		spdk_json_write_bool(w, bdeverrno == 0);
		spdk_jsonrpc_end_result(request, w);
		}

		static void
		spdk_rpc_delete_compress_bdev(struct spdk_jsonrpc_request *request,
		const struct spdk_json_val *params)
		{
		struct rpc_delete_compress req = {NULL};
		struct spdk_bdev *bdev;
		int rc;

		if (spdk_json_decode_object(params, rpc_delete_compress_decoders,
		SPDK_COUNTOF(rpc_delete_compress_decoders),
		&req)) {
		rc = -EINVAL;
		goto invalid;
		}

		bdev = spdk_bdev_get_by_name(req.name);
		if (bdev == NULL) {
		rc = -ENODEV;
		goto invalid;
		}

		delete_compress_disk(bdev, _spdk_rpc_delete_compress_bdev_cb, request);

		free_rpc_delete_compress(&req);

		return;

		invalid:
		free_rpc_delete_compress(&req);
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(-rc));
		}
		SPDK_RPC_REGISTER("delete_compress_bdev", spdk_rpc_delete_compress_bdev, SPDK_RPC_RUNTIME)

Admin message