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; /* main vbdev */ 43 char *mode; /* OCF mode (choose one) */ 44 uint64_t cache_line_size; /* OCF cache line size */ 45 char *cache_bdev_name; /* sub bdev */ 46 char *core_bdev_name; /* sub bdev */ 47 }; 48 49 static void 50 free_rpc_bdev_ocf_create(struct rpc_bdev_ocf_create *r) 51 { 52 free(r->name); 53 free(r->core_bdev_name); 54 free(r->cache_bdev_name); 55 free(r->mode); 56 } 57 58 /* Structure to decode the input parameters for this RPC method. */ 59 static const struct spdk_json_object_decoder rpc_bdev_ocf_create_decoders[] = { 60 {"name", offsetof(struct rpc_bdev_ocf_create, name), spdk_json_decode_string}, 61 {"mode", offsetof(struct rpc_bdev_ocf_create, mode), spdk_json_decode_string}, 62 {"cache_line_size", offsetof(struct rpc_bdev_ocf_create, cache_line_size), spdk_json_decode_uint64, true}, 63 {"cache_bdev_name", offsetof(struct rpc_bdev_ocf_create, cache_bdev_name), spdk_json_decode_string}, 64 {"core_bdev_name", offsetof(struct rpc_bdev_ocf_create, core_bdev_name), spdk_json_decode_string}, 65 }; 66 67 static void 68 construct_cb(int status, struct vbdev_ocf *vbdev, void *cb_arg) 69 { 70 struct spdk_jsonrpc_request *request = cb_arg; 71 struct spdk_json_write_ctx *w; 72 73 if (status) { 74 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 75 "Could not create OCF vbdev: %d", 76 status); 77 } else { 78 w = spdk_jsonrpc_begin_result(request); 79 spdk_json_write_string(w, vbdev->name); 80 spdk_jsonrpc_end_result(request, w); 81 } 82 } 83 84 static void 85 rpc_bdev_ocf_create(struct spdk_jsonrpc_request *request, 86 const struct spdk_json_val *params) 87 { 88 struct rpc_bdev_ocf_create req = {NULL}; 89 int ret; 90 91 ret = spdk_json_decode_object(params, rpc_bdev_ocf_create_decoders, 92 SPDK_COUNTOF(rpc_bdev_ocf_create_decoders), 93 &req); 94 if (ret) { 95 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 96 "Invalid parameters"); 97 free_rpc_bdev_ocf_create(&req); 98 return; 99 } 100 101 vbdev_ocf_construct(req.name, req.mode, req.cache_line_size, req.cache_bdev_name, 102 req.core_bdev_name, false, construct_cb, request); 103 free_rpc_bdev_ocf_create(&req); 104 } 105 SPDK_RPC_REGISTER("bdev_ocf_create", rpc_bdev_ocf_create, SPDK_RPC_RUNTIME) 106 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_create, construct_ocf_bdev) 107 108 /* Structure to hold the parameters for this RPC method. */ 109 struct rpc_bdev_ocf_delete { 110 char *name; /* main vbdev name */ 111 }; 112 113 static void 114 free_rpc_bdev_ocf_delete(struct rpc_bdev_ocf_delete *r) 115 { 116 free(r->name); 117 } 118 119 /* Structure to decode the input parameters for this RPC method. */ 120 static const struct spdk_json_object_decoder rpc_bdev_ocf_delete_decoders[] = { 121 {"name", offsetof(struct rpc_bdev_ocf_delete, name), spdk_json_decode_string}, 122 }; 123 124 static void 125 delete_cb(void *cb_arg, int status) 126 { 127 struct spdk_jsonrpc_request *request = cb_arg; 128 129 if (status) { 130 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 131 "Could not delete OCF vbdev: %d", 132 status); 133 } else { 134 spdk_jsonrpc_send_bool_response(request, true); 135 } 136 } 137 138 static void 139 rpc_bdev_ocf_delete(struct spdk_jsonrpc_request *request, 140 const struct spdk_json_val *params) 141 { 142 struct rpc_bdev_ocf_delete req = {NULL}; 143 struct vbdev_ocf *vbdev; 144 int status; 145 146 status = spdk_json_decode_object(params, rpc_bdev_ocf_delete_decoders, 147 SPDK_COUNTOF(rpc_bdev_ocf_delete_decoders), 148 &req); 149 if (status) { 150 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 151 "Invalid parameters"); 152 goto end; 153 } 154 155 vbdev = vbdev_ocf_get_by_name(req.name); 156 if (vbdev == NULL) { 157 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 158 spdk_strerror(ENODEV)); 159 goto end; 160 } 161 162 status = vbdev_ocf_delete_clean(vbdev, delete_cb, request); 163 if (status) { 164 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 165 "Could not delete OCF vbdev: %s", 166 spdk_strerror(-status)); 167 goto end; 168 } 169 170 end: 171 free_rpc_bdev_ocf_delete(&req); 172 } 173 SPDK_RPC_REGISTER("bdev_ocf_delete", rpc_bdev_ocf_delete, SPDK_RPC_RUNTIME) 174 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_delete, delete_ocf_bdev) 175 176 /* Structure to hold the parameters for this RPC method. */ 177 struct rpc_bdev_ocf_get_stats { 178 char *name; /* main vbdev name */ 179 }; 180 181 static void 182 free_rpc_bdev_ocf_get_stats(struct rpc_bdev_ocf_get_stats *r) 183 { 184 free(r->name); 185 } 186 187 /* Structure to decode the input parameters for this RPC method. */ 188 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_stats_decoders[] = { 189 {"name", offsetof(struct rpc_bdev_ocf_get_stats, name), spdk_json_decode_string}, 190 }; 191 192 struct get_ocf_stats_ctx { 193 struct spdk_jsonrpc_request *request; 194 char *core_name; 195 }; 196 197 static void 198 rpc_bdev_ocf_get_stats_cmpl(ocf_cache_t cache, void *priv, int error) 199 { 200 struct get_ocf_stats_ctx *ctx = (struct get_ocf_stats_ctx *) priv; 201 struct spdk_json_write_ctx *w; 202 struct vbdev_ocf_stats stats; 203 204 if (error) { 205 goto end; 206 } 207 208 error = vbdev_ocf_stats_get(cache, ctx->core_name, &stats); 209 210 ocf_mngt_cache_read_unlock(cache); 211 212 if (error) { 213 goto end; 214 } 215 216 w = spdk_jsonrpc_begin_result(ctx->request); 217 vbdev_ocf_stats_write_json(w, &stats); 218 spdk_jsonrpc_end_result(ctx->request, w); 219 220 end: 221 if (error) { 222 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 223 "Could not get stats: %s", 224 spdk_strerror(-error)); 225 } 226 free(ctx); 227 } 228 229 static void 230 rpc_bdev_ocf_get_stats(struct spdk_jsonrpc_request *request, 231 const struct spdk_json_val *params) 232 { 233 struct rpc_bdev_ocf_get_stats req = {NULL}; 234 struct vbdev_ocf *vbdev; 235 struct get_ocf_stats_ctx *ctx; 236 237 ctx = calloc(1, sizeof(*ctx)); 238 if (!ctx) { 239 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 240 "Not enough memory to process request"); 241 goto end; 242 } 243 244 if (spdk_json_decode_object(params, rpc_bdev_ocf_get_stats_decoders, 245 SPDK_COUNTOF(rpc_bdev_ocf_get_stats_decoders), 246 &req)) { 247 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 248 "Invalid parameters"); 249 free(ctx); 250 goto end; 251 } 252 253 vbdev = vbdev_ocf_get_by_name(req.name); 254 if (vbdev == NULL) { 255 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 256 spdk_strerror(ENODEV)); 257 free(ctx); 258 goto end; 259 } 260 261 ctx->core_name = vbdev->core.name; 262 ctx->request = request; 263 ocf_mngt_cache_read_lock(vbdev->ocf_cache, rpc_bdev_ocf_get_stats_cmpl, ctx); 264 265 end: 266 free_rpc_bdev_ocf_get_stats(&req); 267 } 268 SPDK_RPC_REGISTER("bdev_ocf_get_stats", rpc_bdev_ocf_get_stats, SPDK_RPC_RUNTIME) 269 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_get_stats, get_ocf_stats) 270 271 /* Structure to hold the parameters for this RPC method. */ 272 struct rpc_bdev_ocf_get_bdevs { 273 char *name; 274 }; 275 276 static void 277 free_rpc_bdev_ocf_get_bdevs(struct rpc_bdev_ocf_get_bdevs *r) 278 { 279 free(r->name); 280 } 281 282 /* Structure to decode the input parameters for this RPC method. */ 283 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_bdevs_decoders[] = { 284 {"name", offsetof(struct rpc_bdev_ocf_get_bdevs, name), spdk_json_decode_string, true}, 285 }; 286 287 struct bdev_get_bdevs_ctx { 288 char *name; 289 struct spdk_json_write_ctx *w; 290 }; 291 292 static void 293 bdev_get_bdevs_fn(struct vbdev_ocf *vbdev, void *ctx) 294 { 295 struct bdev_get_bdevs_ctx *cctx = ctx; 296 struct spdk_json_write_ctx *w = cctx->w; 297 298 if (cctx->name != NULL && 299 strcmp(vbdev->name, cctx->name) && 300 strcmp(vbdev->cache.name, cctx->name) && 301 strcmp(vbdev->core.name, cctx->name)) { 302 return; 303 } 304 305 spdk_json_write_object_begin(w); 306 spdk_json_write_named_string(w, "name", vbdev->name); 307 spdk_json_write_named_bool(w, "started", vbdev->state.started); 308 309 spdk_json_write_named_object_begin(w, "cache"); 310 spdk_json_write_named_string(w, "name", vbdev->cache.name); 311 spdk_json_write_named_bool(w, "attached", vbdev->cache.attached); 312 spdk_json_write_object_end(w); 313 314 spdk_json_write_named_object_begin(w, "core"); 315 spdk_json_write_named_string(w, "name", vbdev->core.name); 316 spdk_json_write_named_bool(w, "attached", vbdev->core.attached); 317 spdk_json_write_object_end(w); 318 319 spdk_json_write_object_end(w); 320 } 321 322 static void 323 rpc_bdev_ocf_get_bdevs(struct spdk_jsonrpc_request *request, 324 const struct spdk_json_val *params) 325 { 326 struct spdk_json_write_ctx *w; 327 struct rpc_bdev_ocf_get_bdevs req = {NULL}; 328 struct bdev_get_bdevs_ctx cctx; 329 330 if (params && spdk_json_decode_object(params, rpc_bdev_ocf_get_bdevs_decoders, 331 SPDK_COUNTOF(rpc_bdev_ocf_get_bdevs_decoders), 332 &req)) { 333 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 334 "Invalid parameters"); 335 goto end; 336 } 337 338 if (req.name) { 339 if (!(vbdev_ocf_get_by_name(req.name) || vbdev_ocf_get_base_by_name(req.name))) { 340 spdk_jsonrpc_send_error_response(request, 341 SPDK_JSONRPC_ERROR_INVALID_PARAMS, 342 spdk_strerror(ENODEV)); 343 goto end; 344 } 345 } 346 347 w = spdk_jsonrpc_begin_result(request); 348 349 cctx.name = req.name; 350 cctx.w = w; 351 352 spdk_json_write_array_begin(w); 353 vbdev_ocf_foreach(bdev_get_bdevs_fn, &cctx); 354 spdk_json_write_array_end(w); 355 spdk_jsonrpc_end_result(request, w); 356 357 end: 358 free_rpc_bdev_ocf_get_bdevs(&req); 359 } 360 SPDK_RPC_REGISTER("bdev_ocf_get_bdevs", rpc_bdev_ocf_get_bdevs, SPDK_RPC_RUNTIME) 361 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_get_bdevs, get_ocf_bdevs) 362