e008db08e7
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: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-on: https://review.gerrithub.io/407397 Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Pawel Wodkowski <pawelx.wodkowski@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
107 lines
3.3 KiB
C
107 lines
3.3 KiB
C
/*-
|
|
* 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 "spdk/stdinc.h"
|
|
|
|
#include "spdk/jsonrpc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Start listening for RPC connections.
|
|
*
|
|
* \param listen_addr Listening address.
|
|
*
|
|
* \return 0 on success, -1 on failure.
|
|
*/
|
|
int spdk_rpc_listen(const char *listen_addr);
|
|
|
|
/**
|
|
* Poll the RPC server.
|
|
*/
|
|
void spdk_rpc_accept(void);
|
|
|
|
/**
|
|
* Stop listening for RPC connections.
|
|
*/
|
|
void spdk_rpc_close(void);
|
|
|
|
/**
|
|
* Function signature for RPC request handlers.
|
|
*
|
|
* \param request RPC request to handle.
|
|
* \param params Parameters associated with the RPC request.
|
|
*/
|
|
typedef void (*spdk_rpc_method_handler)(struct spdk_jsonrpc_request *request,
|
|
const struct spdk_json_val *params);
|
|
|
|
/**
|
|
* Register an RPC method.
|
|
*
|
|
* \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,
|
|
uint32_t state_mask);
|
|
|
|
#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, 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
|
|
|
|
#endif
|