sock/rpc: Add sock_impl_get/set_options RPC methods (b1074c49) · Commits · Public Repositories / spdk

CHANGELOG.md

+2 −0

Original line number	Diff line number	Diff line
		@@ -66,6 +66,8 @@ rpc.py script is deprecated, new parameter `-m` or `--max-io-qpairs-per-ctrlr` i
		Parameter `max_qpairs_per_ctrlr` of `nvmf_create_transport` RPC command accepted by the NVMF target
		is deprecated, new parameter `max_io_qpairs_per_ctrlr` is added.

		Added `sock_impl_get_options` and `sock_impl_set_options` RPC methods.

		### sock

		Added `spdk_sock_impl_get_opts` and `spdk_sock_impl_set_opts` functions to set/get socket layer configuration

doc/jsonrpc.md

+87 −0

Original line number	Diff line number	Diff line
		@@ -6543,6 +6543,93 @@ Example response:
		}
		~~~

		# Socket layer {#jsonrpc_components_sock}

		## sock_impl_get_options {#rpc_sock_impl_get_options}

		Get parameters for the socket layer implementation.

		### Parameters

		Name \| Optional \| Type \| Description
		----------------------- \| -------- \| ----------- \| -----------
		impl_name \| Required \| string \| Name of socket implementation, e.g. posix

		### Response

		Response is an object with current socket layer options for requested implementation.

		### Example

		Example request:

		~~~
		{
		"jsonrpc": "2.0",
		"method": "sock_impl_get_options",
		"id": 1,
		"params": {
		"impl_name": "posix"
		}
		}
		~~~

		Example response:

		~~~
		{
		"jsonrpc": "2.0",
		"id": 1,
		"result": {
		"recv_buf_size": 2097152,
		"send_buf_size": 2097152
		}
		}
		~~~

		## sock_impl_set_options {#rpc_sock_impl_set_options}

		Set parameters for the socket layer implementation.

		### Parameters

		Name \| Optional \| Type \| Description
		----------------------- \| -------- \| ----------- \| -----------
		impl_name \| Required \| string \| Name of socket implementation, e.g. posix
		recv_buf_size \| Optional \| number \| Size of socket receive buffer in bytes
		send_buf_size \| Optional \| number \| Size of socket send buffer in bytes

		### Response

		True if socket layer options were set successfully.

		### Example

		Example request:

		~~~
		{
		"jsonrpc": "2.0",
		"method": "sock_impl_set_options",
		"id": 1,
		"params": {
		"impl_name": "posix",
		"recv_buf_size": 2097152,
		"send_buf_size": 2097152
		}
		}
		~~~

		Example response:

		~~~
		{
		"jsonrpc": "2.0",
		"id": 1,
		"result": true
		}
		~~~

		# Miscellaneous RPC commands

		## bdev_nvme_send_cmd {#rpc_bdev_nvme_send_cmd}

examples/nvme/fio_plugin/Makefile

+1 −1

Original line number	Diff line number	Diff line
		@@ -42,7 +42,7 @@ C_SRCS = fio_plugin.c

		# Unable to combine the FIO plugin and the VPP socket abstraction (license incompatibility)
		SPDK_LIB_LIST = $(filter-out sock_vpp,$(SOCK_MODULES_LIST))
		SPDK_LIB_LIST += nvme thread util log sock vmd
		SPDK_LIB_LIST += nvme thread util log sock vmd jsonrpc json rpc

		ifeq ($(CONFIG_RDMA),y)
		SPDK_LIB_LIST += rdma

lib/sock/Makefile

+1 −1

Original line number	Diff line number	Diff line
		@@ -37,7 +37,7 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
		SO_VER := 3
		SO_MINOR := 1

		C_SRCS = sock.c net_framework.c
		C_SRCS = sock.c net_framework.c sock_rpc.c

		LIBNAME = sock

lib/sock/sock_rpc.c

0 → 100644

+151 −0

Original line number	Diff line number	Diff line
		/*-
		* BSD LICENSE
		*
		* Copyright (c) 2020 Mellanox Technologies LTD. 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/sock.h"

		#include "spdk/rpc.h"
		#include "spdk/util.h"
		#include "spdk/string.h"

		#include "spdk_internal/log.h"


		static const struct spdk_json_object_decoder rpc_sock_impl_get_opts_decoders[] = {
		{ "impl_name", 0, spdk_json_decode_string, false },
		};

		static void
		rpc_sock_impl_get_options(struct spdk_jsonrpc_request *request,
		const struct spdk_json_val *params)
		{
		char *impl_name = NULL;
		struct spdk_sock_impl_opts sock_opts = {};
		struct spdk_json_write_ctx *w;
		size_t len;
		int rc;

		if (spdk_json_decode_object(params, rpc_sock_impl_get_opts_decoders,
		SPDK_COUNTOF(rpc_sock_impl_get_opts_decoders), &impl_name)) {
		SPDK_ERRLOG("spdk_json_decode_object() failed\n");
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
		"Invalid parameters");
		return;
		}

		len = sizeof(sock_opts);
		rc = spdk_sock_impl_get_opts(impl_name, &sock_opts, &len);
		if (rc) {
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
		"Invalid parameters");
		return;
		}

		w = spdk_jsonrpc_begin_result(request);
		spdk_json_write_object_begin(w);
		spdk_json_write_named_uint32(w, "recv_buf_size", sock_opts.recv_buf_size);
		spdk_json_write_named_uint32(w, "send_buf_size", sock_opts.send_buf_size);
		spdk_json_write_object_end(w);
		spdk_jsonrpc_end_result(request, w);
		free(impl_name);
		}
		SPDK_RPC_REGISTER("sock_impl_get_options", rpc_sock_impl_get_options,
		SPDK_RPC_STARTUP \| SPDK_RPC_RUNTIME)

		struct spdk_rpc_sock_impl_set_opts {
		char *impl_name;
		struct spdk_sock_impl_opts sock_opts;
		};

		static const struct spdk_json_object_decoder rpc_sock_impl_set_opts_decoders[] = {
		{
		"impl_name", offsetof(struct spdk_rpc_sock_impl_set_opts, impl_name),
		spdk_json_decode_string, false
		},
		{
		"recv_buf_size", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.recv_buf_size),
		spdk_json_decode_uint32, true
		},
		{
		"send_buf_size", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.send_buf_size),
		spdk_json_decode_uint32, true
		},
		};

		static void
		rpc_sock_impl_set_options(struct spdk_jsonrpc_request *request,
		const struct spdk_json_val *params)
		{
		struct spdk_rpc_sock_impl_set_opts opts = {};
		struct spdk_json_write_ctx *w;
		size_t len;
		int rc;

		/* Get type */
		if (spdk_json_decode_object(params, rpc_sock_impl_set_opts_decoders,
		SPDK_COUNTOF(rpc_sock_impl_set_opts_decoders), &opts)) {
		SPDK_ERRLOG("spdk_json_decode_object() failed\n");
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
		"Invalid parameters");
		return;
		}

		/* Retrieve default opts for requested socket implementation */
		len = sizeof(opts.sock_opts);
		rc = spdk_sock_impl_get_opts(opts.impl_name, &opts.sock_opts, &len);
		if (rc) {
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
		"Invalid parameters");
		return;
		}

		/* Decode opts */
		if (spdk_json_decode_object(params, rpc_sock_impl_set_opts_decoders,
		SPDK_COUNTOF(rpc_sock_impl_set_opts_decoders), &opts)) {
		SPDK_ERRLOG("spdk_json_decode_object() failed\n");
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
		"Invalid parameters");
		return;
		}

		rc = spdk_sock_impl_set_opts(opts.impl_name, &opts.sock_opts, sizeof(opts.sock_opts));
		if (rc != 0) {
		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
		"Invalid parameters");
		return;
		}

		w = spdk_jsonrpc_begin_result(request);
		spdk_json_write_bool(w, true);
		spdk_jsonrpc_end_result(request, w);
		free(opts.impl_name);
		}
		SPDK_RPC_REGISTER("sock_impl_set_options", rpc_sock_impl_set_options, SPDK_RPC_STARTUP)