1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "vbdev_ocf.h" 35 #include "stats.h" 36 #include "spdk/log.h" 37 #include "spdk/rpc.h" 38 #include "spdk/string.h" 39 40 /* Structure to hold the parameters for this RPC method. */ 41 struct rpc_bdev_ocf_create { 42 char *name; /* master vbdev */ 43 char *mode; /* OCF mode (choose one) */ 44 char *cache_bdev_name; /* sub bdev */ 45 char *core_bdev_name; /* sub bdev */ 46 }; 47 48 static void 49 free_rpc_bdev_ocf_create(struct rpc_bdev_ocf_create *r) 50 { 51 free(r->name); 52 free(r->core_bdev_name); 53 free(r->cache_bdev_name); 54 free(r->mode); 55 } 56 57 /* Structure to decode the input parameters for this RPC method. */ 58 static const struct spdk_json_object_decoder rpc_bdev_ocf_create_decoders[] = { 59 {"name", offsetof(struct rpc_bdev_ocf_create, name), spdk_json_decode_string}, 60 {"mode", offsetof(struct rpc_bdev_ocf_create, mode), spdk_json_decode_string}, 61 {"cache_bdev_name", offsetof(struct rpc_bdev_ocf_create, cache_bdev_name), spdk_json_decode_string}, 62 {"core_bdev_name", offsetof(struct rpc_bdev_ocf_create, core_bdev_name), spdk_json_decode_string}, 63 }; 64 65 static void 66 construct_cb(int status, struct vbdev_ocf *vbdev, void *cb_arg) 67 { 68 struct spdk_jsonrpc_request *request = cb_arg; 69 struct spdk_json_write_ctx *w; 70 71 if (status) { 72 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 73 "Could not create OCF vbdev: %d", 74 status); 75 } else { 76 w = spdk_jsonrpc_begin_result(request); 77 spdk_json_write_string(w, vbdev->name); 78 spdk_jsonrpc_end_result(request, w); 79 } 80 } 81 82 static void 83 spdk_rpc_bdev_ocf_create(struct spdk_jsonrpc_request *request, 84 const struct spdk_json_val *params) 85 { 86 struct rpc_bdev_ocf_create req = {NULL}; 87 int ret; 88 89 ret = spdk_json_decode_object(params, rpc_bdev_ocf_create_decoders, 90 SPDK_COUNTOF(rpc_bdev_ocf_create_decoders), 91 &req); 92 if (ret) { 93 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 94 "Invalid parameters"); 95 free_rpc_bdev_ocf_create(&req); 96 return; 97 } 98 99 vbdev_ocf_construct(req.name, req.mode, req.cache_bdev_name, req.core_bdev_name, false, 100 construct_cb, request); 101 free_rpc_bdev_ocf_create(&req); 102 } 103 SPDK_RPC_REGISTER("bdev_ocf_create", spdk_rpc_bdev_ocf_create, SPDK_RPC_RUNTIME) 104 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_create, construct_ocf_bdev) 105 106 /* Structure to hold the parameters for this RPC method. */ 107 struct rpc_bdev_ocf_delete { 108 char *name; /* master vbdev name */ 109 }; 110 111 static void 112 free_rpc_bdev_ocf_delete(struct rpc_bdev_ocf_delete *r) 113 { 114 free(r->name); 115 } 116 117 /* Structure to decode the input parameters for this RPC method. */ 118 static const struct spdk_json_object_decoder rpc_bdev_ocf_delete_decoders[] = { 119 {"name", offsetof(struct rpc_bdev_ocf_delete, name), spdk_json_decode_string}, 120 }; 121 122 static void 123 delete_cb(void *cb_arg, int status) 124 { 125 struct spdk_jsonrpc_request *request = cb_arg; 126 struct spdk_json_write_ctx *w; 127 128 if (status) { 129 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 130 "Could not delete OCF vbdev: %d", 131 status); 132 } else { 133 w = spdk_jsonrpc_begin_result(request); 134 spdk_json_write_bool(w, true); 135 spdk_jsonrpc_end_result(request, w); 136 } 137 } 138 139 static void 140 spdk_rpc_bdev_ocf_delete(struct spdk_jsonrpc_request *request, 141 const struct spdk_json_val *params) 142 { 143 struct rpc_bdev_ocf_delete req = {NULL}; 144 struct vbdev_ocf *vbdev; 145 int status; 146 147 status = spdk_json_decode_object(params, rpc_bdev_ocf_delete_decoders, 148 SPDK_COUNTOF(rpc_bdev_ocf_delete_decoders), 149 &req); 150 if (status) { 151 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 152 "Invalid parameters"); 153 goto end; 154 } 155 156 vbdev = vbdev_ocf_get_by_name(req.name); 157 if (vbdev == NULL) { 158 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 159 spdk_strerror(ENODEV)); 160 goto end; 161 } 162 163 status = vbdev_ocf_delete_clean(vbdev, delete_cb, request); 164 if (status) { 165 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 166 "Could not delete OCF vbdev: %s", 167 spdk_strerror(-status)); 168 goto end; 169 } 170 171 end: 172 free_rpc_bdev_ocf_delete(&req); 173 } 174 SPDK_RPC_REGISTER("bdev_ocf_delete", spdk_rpc_bdev_ocf_delete, SPDK_RPC_RUNTIME) 175 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_delete, delete_ocf_bdev) 176 177 /* Structure to hold the parameters for this RPC method. */ 178 struct rpc_bdev_ocf_get_stats { 179 char *name; /* master vbdev name */ 180 }; 181 182 static void 183 free_rpc_bdev_ocf_get_stats(struct rpc_bdev_ocf_get_stats *r) 184 { 185 free(r->name); 186 } 187 188 /* Structure to decode the input parameters for this RPC method. */ 189 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_stats_decoders[] = { 190 {"name", offsetof(struct rpc_bdev_ocf_get_stats, name), spdk_json_decode_string}, 191 }; 192 193 static void 194 spdk_rpc_bdev_ocf_get_stats(struct spdk_jsonrpc_request *request, 195 const struct spdk_json_val *params) 196 { 197 struct rpc_bdev_ocf_get_stats req = {NULL}; 198 struct spdk_json_write_ctx *w; 199 struct vbdev_ocf *vbdev; 200 struct vbdev_ocf_stats stats; 201 int status; 202 203 if (spdk_json_decode_object(params, rpc_bdev_ocf_get_stats_decoders, 204 SPDK_COUNTOF(rpc_bdev_ocf_get_stats_decoders), 205 &req)) { 206 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 207 "Invalid parameters"); 208 goto end; 209 } 210 211 vbdev = vbdev_ocf_get_by_name(req.name); 212 if (vbdev == NULL) { 213 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 214 spdk_strerror(ENODEV)); 215 goto end; 216 } 217 218 status = vbdev_ocf_stats_get(vbdev->ocf_cache, vbdev->core.id, &stats); 219 if (status) { 220 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 221 "Could not get stats: %s", 222 spdk_strerror(-status)); 223 goto end; 224 } 225 226 w = spdk_jsonrpc_begin_result(request); 227 vbdev_ocf_stats_write_json(w, &stats); 228 spdk_jsonrpc_end_result(request, w); 229 230 end: 231 free_rpc_bdev_ocf_get_stats(&req); 232 } 233 SPDK_RPC_REGISTER("bdev_ocf_get_stats", spdk_rpc_bdev_ocf_get_stats, SPDK_RPC_RUNTIME) 234 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_get_stats, get_ocf_stats) 235 236 /* Structure to hold the parameters for this RPC method. */ 237 struct rpc_bdev_ocf_get_bdevs { 238 char *name; 239 }; 240 241 static void 242 free_rpc_bdev_ocf_get_bdevs(struct rpc_bdev_ocf_get_bdevs *r) 243 { 244 free(r->name); 245 } 246 247 /* Structure to decode the input parameters for this RPC method. */ 248 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_bdevs_decoders[] = { 249 {"name", offsetof(struct rpc_bdev_ocf_get_bdevs, name), spdk_json_decode_string, true}, 250 }; 251 252 struct bdev_get_bdevs_ctx { 253 char *name; 254 struct spdk_json_write_ctx *w; 255 }; 256 257 static void 258 bdev_get_bdevs_fn(struct vbdev_ocf *vbdev, void *ctx) 259 { 260 struct bdev_get_bdevs_ctx *cctx = ctx; 261 struct spdk_json_write_ctx *w = cctx->w; 262 263 if (cctx->name != NULL && 264 strcmp(vbdev->name, cctx->name) && 265 strcmp(vbdev->cache.name, cctx->name) && 266 strcmp(vbdev->core.name, cctx->name)) { 267 return; 268 } 269 270 spdk_json_write_object_begin(w); 271 spdk_json_write_named_string(w, "name", vbdev->name); 272 spdk_json_write_named_bool(w, "started", vbdev->state.started); 273 274 spdk_json_write_named_object_begin(w, "cache"); 275 spdk_json_write_named_string(w, "name", vbdev->cache.name); 276 spdk_json_write_named_bool(w, "attached", vbdev->cache.attached); 277 spdk_json_write_object_end(w); 278 279 spdk_json_write_named_object_begin(w, "core"); 280 spdk_json_write_named_string(w, "name", vbdev->core.name); 281 spdk_json_write_named_bool(w, "attached", vbdev->core.attached); 282 spdk_json_write_object_end(w); 283 284 spdk_json_write_object_end(w); 285 } 286 287 static void 288 spdk_rpc_bdev_ocf_get_bdevs(struct spdk_jsonrpc_request *request, 289 const struct spdk_json_val *params) 290 { 291 struct spdk_json_write_ctx *w; 292 struct rpc_bdev_ocf_get_bdevs req = {NULL}; 293 struct bdev_get_bdevs_ctx cctx; 294 295 if (params && spdk_json_decode_object(params, rpc_bdev_ocf_get_bdevs_decoders, 296 SPDK_COUNTOF(rpc_bdev_ocf_get_bdevs_decoders), 297 &req)) { 298 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 299 "Invalid parameters"); 300 goto end; 301 } 302 303 if (req.name) { 304 if (!(vbdev_ocf_get_by_name(req.name) || vbdev_ocf_get_base_by_name(req.name))) { 305 spdk_jsonrpc_send_error_response(request, 306 SPDK_JSONRPC_ERROR_INVALID_PARAMS, 307 spdk_strerror(ENODEV)); 308 goto end; 309 } 310 } 311 312 w = spdk_jsonrpc_begin_result(request); 313 314 cctx.name = req.name; 315 cctx.w = w; 316 317 spdk_json_write_array_begin(w); 318 vbdev_ocf_foreach(bdev_get_bdevs_fn, &cctx); 319 spdk_json_write_array_end(w); 320 spdk_jsonrpc_end_result(request, w); 321 322 end: 323 free_rpc_bdev_ocf_get_bdevs(&req); 324 } 325 SPDK_RPC_REGISTER("bdev_ocf_get_bdevs", spdk_rpc_bdev_ocf_get_bdevs, SPDK_RPC_RUNTIME) 326 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_get_bdevs, get_ocf_bdevs) 327