d80267cc17
The net library isn't needed - everything these RPCs do can be done externally to the SPDK application. This library will be removed in the 21.07 release. As part of the deprecation, mark the net RPCs as private. This will prevent an upcoming patch from complaining that these RPCs are not documented. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I61118820fd29e410dca763595c3d9fd01a57373d Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7592 Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: <dongx.yi@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Community-CI: Mellanox Build Bot
200 lines
6.5 KiB
C
200 lines
6.5 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.
|
|
*/
|
|
|
|
#include "net_internal.h"
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#include "spdk/rpc.h"
|
|
#include "spdk/net.h"
|
|
#include "spdk/util.h"
|
|
|
|
#include "spdk/log.h"
|
|
|
|
struct rpc_ip_address {
|
|
int32_t ifc_index;
|
|
char *ip_address;
|
|
};
|
|
|
|
static void
|
|
free_rpc_ip_address(struct rpc_ip_address *req)
|
|
{
|
|
free(req->ip_address);
|
|
}
|
|
|
|
static const struct spdk_json_object_decoder rpc_ip_address_decoders[] = {
|
|
{"ifc_index", offsetof(struct rpc_ip_address, ifc_index), spdk_json_decode_int32},
|
|
{"ip_address", offsetof(struct rpc_ip_address, ip_address), spdk_json_decode_string},
|
|
};
|
|
|
|
static void
|
|
rpc_net_interface_add_ip_address(struct spdk_jsonrpc_request *request,
|
|
const struct spdk_json_val *params)
|
|
{
|
|
struct rpc_ip_address req = {};
|
|
int ret_val = 0;
|
|
|
|
SPDK_WARNLOG("net_interface_add_ip_address RPC is deprecated.\n");
|
|
|
|
if (spdk_json_decode_object(params, rpc_ip_address_decoders,
|
|
SPDK_COUNTOF(rpc_ip_address_decoders),
|
|
&req)) {
|
|
SPDK_DEBUGLOG(net, "spdk_json_decode_object failed\n");
|
|
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
|
|
"spdk_json_decode_object failed");
|
|
goto invalid;
|
|
}
|
|
|
|
ret_val = interface_net_interface_add_ip_address(req.ifc_index, req.ip_address);
|
|
if (ret_val) {
|
|
if (ret_val == -ENODEV) {
|
|
spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_STATE,
|
|
"Interface %d not available", req.ifc_index);
|
|
} else if (ret_val == -EADDRINUSE) {
|
|
spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
|
|
"IP address %s is already added to interface %d",
|
|
req.ip_address, req.ifc_index);
|
|
} else {
|
|
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
|
|
strerror(ret_val));
|
|
}
|
|
goto invalid;
|
|
}
|
|
|
|
free_rpc_ip_address(&req);
|
|
|
|
spdk_jsonrpc_send_bool_response(request, true);
|
|
return;
|
|
|
|
invalid:
|
|
free_rpc_ip_address(&req);
|
|
}
|
|
/* private */ SPDK_RPC_REGISTER("net_interface_add_ip_address", rpc_net_interface_add_ip_address,
|
|
SPDK_RPC_RUNTIME)
|
|
SPDK_RPC_REGISTER_ALIAS_DEPRECATED(net_interface_add_ip_address, add_ip_address)
|
|
|
|
static void
|
|
rpc_net_interface_delete_ip_address(struct spdk_jsonrpc_request *request,
|
|
const struct spdk_json_val *params)
|
|
{
|
|
struct rpc_ip_address req = {};
|
|
int ret_val = 0;
|
|
|
|
SPDK_WARNLOG("net_interface_delete_ip_address RPC is deprecated.\n");
|
|
|
|
if (spdk_json_decode_object(params, rpc_ip_address_decoders,
|
|
SPDK_COUNTOF(rpc_ip_address_decoders),
|
|
&req)) {
|
|
SPDK_DEBUGLOG(net, "spdk_json_decode_object failed\n");
|
|
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
|
|
"spdk_json_decode_object failed");
|
|
goto invalid;
|
|
}
|
|
|
|
ret_val = interface_net_interface_delete_ip_address(req.ifc_index, req.ip_address);
|
|
if (ret_val) {
|
|
if (ret_val == -ENODEV) {
|
|
spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_STATE,
|
|
"Interface %d not available", req.ifc_index);
|
|
} else if (ret_val == -ENXIO) {
|
|
spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
|
|
"IP address %s is not found in interface %d",
|
|
req.ip_address, req.ifc_index);
|
|
} else {
|
|
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
|
|
strerror(ret_val));
|
|
}
|
|
goto invalid;
|
|
}
|
|
|
|
free_rpc_ip_address(&req);
|
|
|
|
spdk_jsonrpc_send_bool_response(request, true);
|
|
return;
|
|
|
|
invalid:
|
|
free_rpc_ip_address(&req);
|
|
}
|
|
/* private */ SPDK_RPC_REGISTER("net_interface_delete_ip_address",
|
|
rpc_net_interface_delete_ip_address,
|
|
SPDK_RPC_RUNTIME)
|
|
SPDK_RPC_REGISTER_ALIAS_DEPRECATED(net_interface_delete_ip_address, delete_ip_address)
|
|
|
|
static void
|
|
rpc_net_get_interfaces(struct spdk_jsonrpc_request *request,
|
|
const struct spdk_json_val *params)
|
|
{
|
|
struct spdk_json_write_ctx *w;
|
|
TAILQ_HEAD(, spdk_interface) *interface_head = interface_get_list();
|
|
struct spdk_interface *ifc;
|
|
char *ip_address;
|
|
struct in_addr inaddr;
|
|
uint32_t i;
|
|
|
|
SPDK_WARNLOG("net_get_interfaces RPC is deprecated.\n");
|
|
|
|
if (params != NULL) {
|
|
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
|
|
"net_get_interfaces requires no parameters");
|
|
return;
|
|
}
|
|
|
|
w = spdk_jsonrpc_begin_result(request);
|
|
spdk_json_write_array_begin(w);
|
|
|
|
TAILQ_FOREACH(ifc, interface_head, tailq) {
|
|
spdk_json_write_object_begin(w);
|
|
|
|
spdk_json_write_named_string(w, "name", ifc->name);
|
|
|
|
spdk_json_write_named_int32(w, "ifc_index", ifc->index);
|
|
|
|
spdk_json_write_named_array_begin(w, "ip_addr");
|
|
for (i = 0; i < ifc->num_ip_addresses; i++) {
|
|
memcpy(&inaddr, &ifc->ip_address[i], sizeof(uint32_t));
|
|
ip_address = inet_ntoa(inaddr);
|
|
spdk_json_write_string(w, ip_address);
|
|
}
|
|
spdk_json_write_array_end(w);
|
|
|
|
spdk_json_write_object_end(w);
|
|
}
|
|
spdk_json_write_array_end(w);
|
|
|
|
spdk_jsonrpc_end_result(request, w);
|
|
}
|
|
/* private */ SPDK_RPC_REGISTER("net_get_interfaces", rpc_net_get_interfaces, SPDK_RPC_RUNTIME)
|
|
SPDK_RPC_REGISTER_ALIAS_DEPRECATED(net_get_interfaces, get_interfaces)
|
|
|
|
SPDK_LOG_REGISTER_COMPONENT(net)
|