1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) 2020 Mellanox Technologies LTD. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * * Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in 14 * the documentation and/or other materials provided with the 15 * distribution. 16 * * Neither the name of Intel Corporation nor the names of its 17 * contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #include "spdk/sock.h" 34 35 #include "spdk/rpc.h" 36 #include "spdk/util.h" 37 #include "spdk/string.h" 38 39 #include "spdk_internal/log.h" 40 41 42 static const struct spdk_json_object_decoder rpc_sock_impl_get_opts_decoders[] = { 43 { "impl_name", 0, spdk_json_decode_string, false }, 44 }; 45 46 static void 47 rpc_sock_impl_get_options(struct spdk_jsonrpc_request *request, 48 const struct spdk_json_val *params) 49 { 50 char *impl_name = NULL; 51 struct spdk_sock_impl_opts sock_opts = {}; 52 struct spdk_json_write_ctx *w; 53 size_t len; 54 int rc; 55 56 if (spdk_json_decode_object(params, rpc_sock_impl_get_opts_decoders, 57 SPDK_COUNTOF(rpc_sock_impl_get_opts_decoders), &impl_name)) { 58 SPDK_ERRLOG("spdk_json_decode_object() failed\n"); 59 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 60 "Invalid parameters"); 61 return; 62 } 63 64 len = sizeof(sock_opts); 65 rc = spdk_sock_impl_get_opts(impl_name, &sock_opts, &len); 66 if (rc) { 67 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 68 "Invalid parameters"); 69 return; 70 } 71 72 w = spdk_jsonrpc_begin_result(request); 73 spdk_json_write_object_begin(w); 74 spdk_json_write_named_uint32(w, "recv_buf_size", sock_opts.recv_buf_size); 75 spdk_json_write_named_uint32(w, "send_buf_size", sock_opts.send_buf_size); 76 spdk_json_write_named_bool(w, "enable_recv_pipe", sock_opts.enable_recv_pipe); 77 spdk_json_write_named_bool(w, "enable_zerocopy_send", sock_opts.enable_zerocopy_send); 78 spdk_json_write_named_bool(w, "enable_quickack", sock_opts.enable_quickack); 79 spdk_json_write_named_bool(w, "enable_placement_id", sock_opts.enable_placement_id); 80 spdk_json_write_object_end(w); 81 spdk_jsonrpc_end_result(request, w); 82 free(impl_name); 83 } 84 SPDK_RPC_REGISTER("sock_impl_get_options", rpc_sock_impl_get_options, 85 SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME) 86 87 struct spdk_rpc_sock_impl_set_opts { 88 char *impl_name; 89 struct spdk_sock_impl_opts sock_opts; 90 }; 91 92 static const struct spdk_json_object_decoder rpc_sock_impl_set_opts_decoders[] = { 93 { 94 "impl_name", offsetof(struct spdk_rpc_sock_impl_set_opts, impl_name), 95 spdk_json_decode_string, false 96 }, 97 { 98 "recv_buf_size", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.recv_buf_size), 99 spdk_json_decode_uint32, true 100 }, 101 { 102 "send_buf_size", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.send_buf_size), 103 spdk_json_decode_uint32, true 104 }, 105 { 106 "enable_recv_pipe", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.enable_recv_pipe), 107 spdk_json_decode_bool, true 108 }, 109 { 110 "enable_zerocopy_send", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.enable_zerocopy_send), 111 spdk_json_decode_bool, true 112 }, 113 { 114 "enable_quickack", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.enable_quickack), 115 spdk_json_decode_bool, true 116 }, 117 { 118 "enable_placement_id", offsetof(struct spdk_rpc_sock_impl_set_opts, sock_opts.enable_placement_id), 119 spdk_json_decode_bool, true 120 }, 121 122 }; 123 124 static void 125 rpc_sock_impl_set_options(struct spdk_jsonrpc_request *request, 126 const struct spdk_json_val *params) 127 { 128 struct spdk_rpc_sock_impl_set_opts opts = {}; 129 struct spdk_json_write_ctx *w; 130 size_t len; 131 int rc; 132 133 /* Get type */ 134 if (spdk_json_decode_object(params, rpc_sock_impl_set_opts_decoders, 135 SPDK_COUNTOF(rpc_sock_impl_set_opts_decoders), &opts)) { 136 SPDK_ERRLOG("spdk_json_decode_object() failed\n"); 137 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 138 "Invalid parameters"); 139 return; 140 } 141 142 /* Retrieve default opts for requested socket implementation */ 143 len = sizeof(opts.sock_opts); 144 rc = spdk_sock_impl_get_opts(opts.impl_name, &opts.sock_opts, &len); 145 if (rc) { 146 free(opts.impl_name); 147 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 148 "Invalid parameters"); 149 return; 150 } 151 152 /* Decode opts */ 153 if (spdk_json_decode_object(params, rpc_sock_impl_set_opts_decoders, 154 SPDK_COUNTOF(rpc_sock_impl_set_opts_decoders), &opts)) { 155 SPDK_ERRLOG("spdk_json_decode_object() failed\n"); 156 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 157 "Invalid parameters"); 158 return; 159 } 160 161 rc = spdk_sock_impl_set_opts(opts.impl_name, &opts.sock_opts, sizeof(opts.sock_opts)); 162 if (rc != 0) { 163 free(opts.impl_name); 164 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 165 "Invalid parameters"); 166 return; 167 } 168 169 w = spdk_jsonrpc_begin_result(request); 170 spdk_json_write_bool(w, true); 171 spdk_jsonrpc_end_result(request, w); 172 free(opts.impl_name); 173 } 174 SPDK_RPC_REGISTER("sock_impl_set_options", rpc_sock_impl_set_options, SPDK_RPC_STARTUP) 175 176 static void 177 rpc_sock_set_default_impl(struct spdk_jsonrpc_request *request, 178 const struct spdk_json_val *params) 179 { 180 char *impl_name = NULL; 181 struct spdk_json_write_ctx *w; 182 int rc; 183 184 /* Reuse get_opts decoder */ 185 if (spdk_json_decode_object(params, rpc_sock_impl_get_opts_decoders, 186 SPDK_COUNTOF(rpc_sock_impl_get_opts_decoders), &impl_name)) { 187 SPDK_ERRLOG("spdk_json_decode_object() failed\n"); 188 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 189 "Invalid parameters"); 190 return; 191 } 192 193 rc = spdk_sock_set_default_impl(impl_name); 194 if (rc) { 195 free(impl_name); 196 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 197 "Invalid parameters"); 198 return; 199 } 200 201 w = spdk_jsonrpc_begin_result(request); 202 spdk_json_write_bool(w, true); 203 spdk_jsonrpc_end_result(request, w); 204 free(impl_name); 205 } 206 SPDK_RPC_REGISTER("sock_set_default_impl", rpc_sock_set_default_impl, SPDK_RPC_STARTUP) 207