Commit e008db08 authored by Shuhei Matsumoto's avatar Shuhei Matsumoto Committed by Daniel Verkamp
Browse files

rpc: Add state_mask to each RPC method to make sets of RPCs 



Add state_mask to each RPC method and state to RPC server, respectively.
State mask of RPC method is set at registration. State of RPC server
is changed according to the state of the SPDK.

When any RPC method is recieved, if the bit of the RPC server is on in
the state mask of the RPC method, it is allowed. Otherwise, it is
rejected.

When any RPC is rejected by state_mask control, the new error code
is returned to describe the error clearly.

Change-Id: I84e52b8725a286e9329d61c56f498aa2c8664ec1
Signed-off-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-on: https://review.gerrithub.io/407397


Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarPawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
parent cc87019a

include/spdk/jsonrpc.h

+8 −0
Original line number Diff line number Diff line
@@ -47,12 +47,20 @@ 
extern "C" {

#endif



/* Defined error codes in JSON-RPC specification 2.0 */

#define SPDK_JSONRPC_ERROR_PARSE_ERROR		-32700

#define SPDK_JSONRPC_ERROR_INVALID_REQUEST	-32600

#define SPDK_JSONRPC_ERROR_METHOD_NOT_FOUND	-32601

#define SPDK_JSONRPC_ERROR_INVALID_PARAMS	-32602

#define SPDK_JSONRPC_ERROR_INTERNAL_ERROR	-32603



/* Custom error codes in SPDK



 * Error codes from and including -32768 to -32000 are reserved for

 * predefined errors, hence custom error codes must be outside of the range.

 */

#define SPDK_JSONRPC_ERROR_INVALID_STATE	-1



struct spdk_jsonrpc_server;

struct spdk_jsonrpc_request;

include/spdk/rpc.h

+18 −3
Original line number Diff line number Diff line
@@ -75,15 +75,30 @@ typedef void (*spdk_rpc_method_handler)(struct spdk_jsonrpc_request *request, 
 *

 * \param method Name for the registered method.

 * \param func Function registered for this method to handle the RPC request.

 * \param state_mask State mask of the registered method. If the bit of the state of

 * the RPC server is set in the state_mask, the method is allowed. Otherwise, it is rejected.

 */

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

void spdk_rpc_register_method(const char *method, spdk_rpc_method_handler func,

			      uint32_t state_mask);



#define SPDK_RPC_REGISTER(method, func) \

#define SPDK_RPC_STARTUP	0x1

#define SPDK_RPC_RUNTIME	0x2



#define SPDK_RPC_REGISTER(method, func, state_mask) \

static void __attribute__((constructor)) rpc_register_##func(void) \

{ \

	spdk_rpc_register_method(method, func); \

	spdk_rpc_register_method(method, func, state_mask); \

}



/**

 * Set the state mask of the RPC server. Any RPC method whose state mask is

 * equal to the state of the RPC server is allowed.

 *

 * \param state_mask New state mask of the RPC server.

 */

void spdk_rpc_set_state(uint32_t state_mask);





#ifdef __cplusplus

}

#endif

lib/bdev/aio/bdev_aio_rpc.c

+1 −1
Original line number Diff line number Diff line
@@ -97,4 +97,4 @@ invalid: 
	spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");

	free_rpc_construct_aio(&req);

}

SPDK_RPC_REGISTER("construct_aio_bdev", spdk_rpc_construct_aio_bdev)
 
SPDK_RPC_REGISTER("construct_aio_bdev", spdk_rpc_construct_aio_bdev, SPDK_RPC_RUNTIME)

lib/bdev/error/vbdev_error_rpc.c

+2 −2
Original line number Diff line number Diff line
@@ -122,7 +122,7 @@ invalid: 
	spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");

	free_rpc_construct_error_bdev(&req);

}

SPDK_RPC_REGISTER("construct_error_bdev", spdk_rpc_construct_error_bdev)

SPDK_RPC_REGISTER("construct_error_bdev", spdk_rpc_construct_error_bdev, SPDK_RPC_RUNTIME)



struct rpc_error_information {

	char *name;
@@ -193,4 +193,4 @@ invalid: 
	spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");

	free_rpc_error_information(&req);

}

SPDK_RPC_REGISTER("bdev_inject_error", spdk_rpc_bdev_inject_error)
 
SPDK_RPC_REGISTER("bdev_inject_error", spdk_rpc_bdev_inject_error, SPDK_RPC_RUNTIME)

lib/bdev/lvol/vbdev_lvol_rpc.c

+10 −10
Original line number Diff line number Diff line
@@ -166,7 +166,7 @@ invalid: 
					 spdk_strerror(-rc));

	free_rpc_construct_lvol_store(&req);

}

SPDK_RPC_REGISTER("construct_lvol_store", spdk_rpc_construct_lvol_store)

SPDK_RPC_REGISTER("construct_lvol_store", spdk_rpc_construct_lvol_store, SPDK_RPC_RUNTIME)



struct rpc_rename_lvol_store {

	char *old_name;
@@ -242,7 +242,7 @@ invalid: 
	spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(-rc));

	free_rpc_rename_lvol_store(&req);

}

SPDK_RPC_REGISTER("rename_lvol_store", spdk_rpc_rename_lvol_store)

SPDK_RPC_REGISTER("rename_lvol_store", spdk_rpc_rename_lvol_store, SPDK_RPC_RUNTIME)



struct rpc_destroy_lvol_store {

	char *uuid;
@@ -317,7 +317,7 @@ invalid: 
					 spdk_strerror(-rc));

	free_rpc_destroy_lvol_store(&req);

}

SPDK_RPC_REGISTER("destroy_lvol_store", spdk_rpc_destroy_lvol_store)

SPDK_RPC_REGISTER("destroy_lvol_store", spdk_rpc_destroy_lvol_store, SPDK_RPC_RUNTIME)



struct rpc_construct_lvol_bdev {

	char *uuid;
@@ -413,7 +413,7 @@ invalid: 
	free_rpc_construct_lvol_bdev(&req);

}



SPDK_RPC_REGISTER("construct_lvol_bdev", spdk_rpc_construct_lvol_bdev)

SPDK_RPC_REGISTER("construct_lvol_bdev", spdk_rpc_construct_lvol_bdev, SPDK_RPC_RUNTIME)



struct rpc_snapshot_lvol_bdev {

	char *lvol_name;
@@ -501,7 +501,7 @@ invalid: 
	free_rpc_snapshot_lvol_bdev(&req);

}



SPDK_RPC_REGISTER("snapshot_lvol_bdev", spdk_rpc_snapshot_lvol_bdev)

SPDK_RPC_REGISTER("snapshot_lvol_bdev", spdk_rpc_snapshot_lvol_bdev, SPDK_RPC_RUNTIME)



struct rpc_clone_lvol_bdev {

	char *snapshot_name;
@@ -589,7 +589,7 @@ invalid: 
	free_rpc_clone_lvol_bdev(&req);

}



SPDK_RPC_REGISTER("clone_lvol_bdev", spdk_rpc_clone_lvol_bdev)

SPDK_RPC_REGISTER("clone_lvol_bdev", spdk_rpc_clone_lvol_bdev, SPDK_RPC_RUNTIME)



struct rpc_rename_lvol_bdev {

	char *old_name;
@@ -675,7 +675,7 @@ invalid: 
	free_rpc_rename_lvol_bdev(&req);

}



SPDK_RPC_REGISTER("rename_lvol_bdev", spdk_rpc_rename_lvol_bdev)

SPDK_RPC_REGISTER("rename_lvol_bdev", spdk_rpc_rename_lvol_bdev, SPDK_RPC_RUNTIME)



struct rpc_resize_lvol_bdev {

	char *name;
@@ -766,7 +766,7 @@ invalid: 
	free_rpc_resize_lvol_bdev(&req);

}



SPDK_RPC_REGISTER("resize_lvol_bdev", spdk_rpc_resize_lvol_bdev)

SPDK_RPC_REGISTER("resize_lvol_bdev", spdk_rpc_resize_lvol_bdev, SPDK_RPC_RUNTIME)



struct rpc_destroy_lvol_bdev {

	char *name;
@@ -847,7 +847,7 @@ invalid: 
	free_rpc_destroy_lvol_bdev(&req);

}



SPDK_RPC_REGISTER("destroy_lvol_bdev", spdk_rpc_destroy_lvol_bdev)

SPDK_RPC_REGISTER("destroy_lvol_bdev", spdk_rpc_destroy_lvol_bdev, SPDK_RPC_RUNTIME)



struct rpc_get_lvol_stores {

	char *uuid;
@@ -965,4 +965,4 @@ invalid: 
	free_rpc_get_lvol_stores(&req);

}



SPDK_RPC_REGISTER("get_lvol_stores", spdk_rpc_get_lvol_stores)
 
SPDK_RPC_REGISTER("get_lvol_stores", spdk_rpc_get_lvol_stores, SPDK_RPC_RUNTIME)