rpc: Add an RPC subsystem (bb125a6f) · Commits · Public Repositories / spdk

include/spdk/rpc.h

0 → 100644

+55 −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_RPC_CONFIG_H_
		#define SPDK_RPC_CONFIG_H_

		#include <stdint.h>

		#include "spdk/jsonrpc.h"

		#define SPDK_JSONRPC_PORT_BASE 5260

		typedef void (spdk_rpc_method_handler)(struct spdk_jsonrpc_server_conn conn,
		const struct spdk_json_val *params,
		const struct spdk_json_val *id);

		void spdk_rpc_register_method(const char *method, spdk_rpc_method_handler func);

		#define SPDK_RPC_REGISTER(method, func) \
		static void __attribute__((constructor)) rpc_register_##func(void) \
		{ \
		spdk_rpc_register_method(method, func); \
		}

		#endif

lib/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 += conf cunit event json jsonrpc log memory trace util nvme ioat
		DIRS-y += conf cunit event json jsonrpc log memory rpc trace util nvme ioat

		DIRS-$(CONFIG_NVMF) += nvmf

lib/rpc/Makefile

0 → 100644

+40 −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)/../..)

		CFLAGS += $(DPDK_INC)
		C_SRCS = rpc.c
		LIBNAME = rpc

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

lib/rpc/rpc.c

0 → 100644

+206 −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 <stdio.h>
		#include <stdlib.h>
		#include <sys/select.h>
		#include <sys/types.h>
		#include <sys/socket.h>
		#include <netinet/in.h>
		#include <netinet/tcp.h>
		#include <arpa/inet.h>
		#include <netdb.h>
		#include <unistd.h>
		#include <errno.h>
		#include <string.h>

		#include <rte_config.h>
		#include <rte_cycles.h>
		#include <rte_timer.h>
		#include <rte_lcore.h>

		#include "spdk/queue.h"
		#include "spdk/rpc.h"
		#include "spdk/event.h"
		#include "spdk/conf.h"
		#include "spdk/log.h"

		#define RPC_SELECT_INTERVAL (rte_get_timer_hz() >> 8) /* ~4ms */

		static struct rte_timer g_rpc_timer;

		static struct spdk_jsonrpc_server *g_jsonrpc_server = NULL;

		struct spdk_rpc_method {
		const char *name;
		spdk_rpc_method_handler func;
		SLIST_ENTRY(spdk_rpc_method) slist;
		};

		static SLIST_HEAD(, spdk_rpc_method) g_rpc_methods = SLIST_HEAD_INITIALIZER(g_rpc_methods);

		static void
		spdk_rpc_server_do_work(struct rte_timer timer, void arg)
		{
		spdk_jsonrpc_server_poll(g_jsonrpc_server);
		}

		static int
		enable_rpc(void)
		{
		struct spdk_conf_section *sp;
		char *val;

		sp = spdk_conf_find_section(NULL, "Rpc");
		if (sp == NULL) {
		return 0;
		}

		val = spdk_conf_section_get_val(sp, "Enable");
		if (val == NULL) {
		return 0;
		}

		if (!strcmp(val, "Yes")) {
		return 1;
		}

		return 0;
		}

		void
		spdk_rpc_register_method(const char *method, spdk_rpc_method_handler func)
		{
		struct spdk_rpc_method *m;

		m = calloc(1, sizeof(struct spdk_rpc_method));
		RTE_VERIFY(m != NULL);

		m->name = strdup(method);
		RTE_VERIFY(m->name != NULL);

		m->func = func;

		/* TODO: use a hash table or sorted list */
		SLIST_INSERT_HEAD(&g_rpc_methods, m, slist);
		}

		static void
		spdk_jsonrpc_handler(
		struct spdk_jsonrpc_server_conn *conn,
		const struct spdk_json_val *method,
		const struct spdk_json_val *params,
		const struct spdk_json_val *id)
		{
		struct spdk_rpc_method *m;

		RTE_VERIFY(method != NULL);

		SLIST_FOREACH(m, &g_rpc_methods, slist) {
		if (spdk_json_strequal(method, m->name)) {
		m->func(conn, params, id);
		return;
		}
		}

		spdk_jsonrpc_send_error_response(conn, id, SPDK_JSONRPC_ERROR_METHOD_NOT_FOUND, "Method not found");
		}

		static void
		spdk_rpc_setup(struct rte_timer timer, void arg)
		{
		struct sockaddr_in serv_addr;
		uint16_t port;

		if (!enable_rpc()) {
		return;
		}

		port = SPDK_JSONRPC_PORT_BASE + spdk_app_get_instance_id();

		memset(&serv_addr, 0, sizeof(serv_addr));
		serv_addr.sin_family = AF_INET;
		serv_addr.sin_addr.s_addr = INADDR_ANY;
		serv_addr.sin_port = htons(port);

		g_jsonrpc_server = spdk_jsonrpc_server_listen((struct sockaddr *)&serv_addr, sizeof(serv_addr),
		spdk_jsonrpc_handler);
		if (g_jsonrpc_server == NULL) {
		SPDK_ERRLOG("spdk_jsonrpc_server_listen() failed\n");
		return;
		}

		rte_timer_reset(&g_rpc_timer, RPC_SELECT_INTERVAL, PERIODICAL,
		rte_lcore_id(), spdk_rpc_server_do_work, NULL);
		}

		static int
		spdk_rpc_initialize(void)
		{
		rte_timer_init(&g_rpc_timer);

		/*
		* Defer setup of the RPC service until the timer subsystem has started. This
		* allows us to detect the RPC listen socket as a suitable proxy for determining
		* when the SPDK application has finished initialization and ready for logins
		* or RPC commands.
		*/
		rte_timer_reset(&g_rpc_timer, 0, SINGLE, rte_lcore_id(), spdk_rpc_setup, NULL);
		return 0;
		}

		static int
		spdk_rpc_finish(void)
		{
		rte_timer_stop(&g_rpc_timer);
		if (g_jsonrpc_server) {
		spdk_jsonrpc_server_shutdown(g_jsonrpc_server);
		}
		return 0;
		}

		static void
		spdk_rpc_config_text(FILE *fp)
		{
		fprintf(fp,
		"\n"
		"[Rpc]\n"
		" # Defines whether to enable configuration via RPC.\n"
		" # Default is disabled. Note that the RPC interface is not\n"
		" # authenticated, so users should be careful about enabling\n"
		" # RPC in non-trusted environments.\n"
		" Enable %s\n",
		enable_rpc() ? "Yes" : "No");
		}

		SPDK_SUBSYSTEM_REGISTER(spdk_rpc, spdk_rpc_initialize, spdk_rpc_finish, spdk_rpc_config_text)