1 /*- 2 * BSD LICENSE 3 * 4 * Copyright(c) Intel Corporation. All rights reserved. 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 "spdk/stdinc.h" 35 36 #include "spdk/log.h" 37 #include "spdk/rpc.h" 38 #include "spdk/util.h" 39 #include "spdk/string.h" 40 #include "spdk/env.h" 41 42 #include "spdk/scsi.h" 43 #include "spdk/vhost.h" 44 #include "vhost_internal.h" 45 #include "spdk/bdev.h" 46 47 struct rpc_vhost_scsi_ctrlr { 48 char *ctrlr; 49 char *cpumask; 50 }; 51 52 static void 53 free_rpc_vhost_scsi_ctrlr(struct rpc_vhost_scsi_ctrlr *req) 54 { 55 free(req->ctrlr); 56 free(req->cpumask); 57 } 58 59 static const struct spdk_json_object_decoder rpc_vhost_create_scsi_ctrlr[] = { 60 {"ctrlr", offsetof(struct rpc_vhost_scsi_ctrlr, ctrlr), spdk_json_decode_string }, 61 {"cpumask", offsetof(struct rpc_vhost_scsi_ctrlr, cpumask), spdk_json_decode_string, true}, 62 }; 63 64 static void 65 rpc_vhost_create_scsi_controller(struct spdk_jsonrpc_request *request, 66 const struct spdk_json_val *params) 67 { 68 struct rpc_vhost_scsi_ctrlr req = {0}; 69 int rc; 70 71 if (spdk_json_decode_object(params, rpc_vhost_create_scsi_ctrlr, 72 SPDK_COUNTOF(rpc_vhost_create_scsi_ctrlr), 73 &req)) { 74 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 75 rc = -EINVAL; 76 goto invalid; 77 } 78 79 rc = spdk_vhost_scsi_dev_construct(req.ctrlr, req.cpumask); 80 if (rc < 0) { 81 goto invalid; 82 } 83 84 free_rpc_vhost_scsi_ctrlr(&req); 85 86 spdk_jsonrpc_send_bool_response(request, true); 87 return; 88 89 invalid: 90 free_rpc_vhost_scsi_ctrlr(&req); 91 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 92 spdk_strerror(-rc)); 93 } 94 SPDK_RPC_REGISTER("vhost_create_scsi_controller", rpc_vhost_create_scsi_controller, 95 SPDK_RPC_RUNTIME) 96 97 struct rpc_vhost_scsi_ctrlr_add_target { 98 char *ctrlr; 99 int32_t scsi_target_num; 100 char *bdev_name; 101 }; 102 103 static void 104 free_rpc_vhost_scsi_ctrlr_add_target(struct rpc_vhost_scsi_ctrlr_add_target *req) 105 { 106 free(req->ctrlr); 107 free(req->bdev_name); 108 } 109 110 static const struct spdk_json_object_decoder rpc_vhost_scsi_ctrlr_add_target[] = { 111 {"ctrlr", offsetof(struct rpc_vhost_scsi_ctrlr_add_target, ctrlr), spdk_json_decode_string }, 112 {"scsi_target_num", offsetof(struct rpc_vhost_scsi_ctrlr_add_target, scsi_target_num), spdk_json_decode_int32}, 113 {"bdev_name", offsetof(struct rpc_vhost_scsi_ctrlr_add_target, bdev_name), spdk_json_decode_string }, 114 }; 115 116 static void 117 rpc_vhost_scsi_controller_add_target(struct spdk_jsonrpc_request *request, 118 const struct spdk_json_val *params) 119 { 120 struct rpc_vhost_scsi_ctrlr_add_target req = {0}; 121 struct spdk_json_write_ctx *w; 122 struct spdk_vhost_dev *vdev; 123 int rc; 124 125 if (spdk_json_decode_object(params, rpc_vhost_scsi_ctrlr_add_target, 126 SPDK_COUNTOF(rpc_vhost_scsi_ctrlr_add_target), 127 &req)) { 128 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 129 rc = -EINVAL; 130 goto invalid; 131 } 132 133 spdk_vhost_lock(); 134 vdev = spdk_vhost_dev_find(req.ctrlr); 135 if (vdev == NULL) { 136 spdk_vhost_unlock(); 137 rc = -ENODEV; 138 goto invalid; 139 } 140 141 rc = spdk_vhost_scsi_dev_add_tgt(vdev, req.scsi_target_num, req.bdev_name); 142 spdk_vhost_unlock(); 143 if (rc < 0) { 144 goto invalid; 145 } 146 147 free_rpc_vhost_scsi_ctrlr_add_target(&req); 148 149 w = spdk_jsonrpc_begin_result(request); 150 spdk_json_write_int32(w, rc); 151 spdk_jsonrpc_end_result(request, w); 152 return; 153 154 invalid: 155 free_rpc_vhost_scsi_ctrlr_add_target(&req); 156 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 157 spdk_strerror(-rc)); 158 } 159 SPDK_RPC_REGISTER("vhost_scsi_controller_add_target", rpc_vhost_scsi_controller_add_target, 160 SPDK_RPC_RUNTIME) 161 162 struct rpc_remove_vhost_scsi_ctrlr_target { 163 char *ctrlr; 164 uint32_t scsi_target_num; 165 }; 166 167 static void 168 free_rpc_remove_vhost_scsi_ctrlr_target(struct rpc_remove_vhost_scsi_ctrlr_target *req) 169 { 170 free(req->ctrlr); 171 } 172 173 static const struct spdk_json_object_decoder rpc_vhost_remove_target[] = { 174 {"ctrlr", offsetof(struct rpc_remove_vhost_scsi_ctrlr_target, ctrlr), spdk_json_decode_string }, 175 {"scsi_target_num", offsetof(struct rpc_remove_vhost_scsi_ctrlr_target, scsi_target_num), spdk_json_decode_uint32}, 176 }; 177 178 static int 179 rpc_vhost_scsi_controller_remove_target_finish_cb(struct spdk_vhost_dev *vdev, void *arg) 180 { 181 struct spdk_jsonrpc_request *request = arg; 182 183 spdk_jsonrpc_send_bool_response(request, true); 184 return 0; 185 } 186 187 static void 188 rpc_vhost_scsi_controller_remove_target(struct spdk_jsonrpc_request *request, 189 const struct spdk_json_val *params) 190 { 191 struct rpc_remove_vhost_scsi_ctrlr_target req = {0}; 192 struct spdk_vhost_dev *vdev; 193 int rc; 194 195 if (spdk_json_decode_object(params, rpc_vhost_remove_target, 196 SPDK_COUNTOF(rpc_vhost_remove_target), 197 &req)) { 198 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 199 rc = -EINVAL; 200 goto invalid; 201 } 202 203 spdk_vhost_lock(); 204 vdev = spdk_vhost_dev_find(req.ctrlr); 205 if (vdev == NULL) { 206 spdk_vhost_unlock(); 207 rc = -ENODEV; 208 goto invalid; 209 } 210 211 rc = spdk_vhost_scsi_dev_remove_tgt(vdev, req.scsi_target_num, 212 rpc_vhost_scsi_controller_remove_target_finish_cb, 213 request); 214 spdk_vhost_unlock(); 215 if (rc < 0) { 216 goto invalid; 217 } 218 219 free_rpc_remove_vhost_scsi_ctrlr_target(&req); 220 return; 221 222 invalid: 223 free_rpc_remove_vhost_scsi_ctrlr_target(&req); 224 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 225 spdk_strerror(-rc)); 226 } 227 228 SPDK_RPC_REGISTER("vhost_scsi_controller_remove_target", 229 rpc_vhost_scsi_controller_remove_target, SPDK_RPC_RUNTIME) 230 231 struct rpc_vhost_blk_ctrlr { 232 char *ctrlr; 233 char *dev_name; 234 char *cpumask; 235 char *transport; 236 }; 237 238 static const struct spdk_json_object_decoder rpc_construct_vhost_blk_ctrlr[] = { 239 {"ctrlr", offsetof(struct rpc_vhost_blk_ctrlr, ctrlr), spdk_json_decode_string }, 240 {"dev_name", offsetof(struct rpc_vhost_blk_ctrlr, dev_name), spdk_json_decode_string }, 241 {"cpumask", offsetof(struct rpc_vhost_blk_ctrlr, cpumask), spdk_json_decode_string, true}, 242 {"transport", offsetof(struct rpc_vhost_blk_ctrlr, transport), spdk_json_decode_string, true}, 243 }; 244 245 static void 246 free_rpc_vhost_blk_ctrlr(struct rpc_vhost_blk_ctrlr *req) 247 { 248 free(req->ctrlr); 249 free(req->dev_name); 250 free(req->cpumask); 251 free(req->transport); 252 } 253 254 static void 255 rpc_vhost_create_blk_controller(struct spdk_jsonrpc_request *request, 256 const struct spdk_json_val *params) 257 { 258 struct rpc_vhost_blk_ctrlr req = {0}; 259 int rc; 260 261 if (spdk_json_decode_object_relaxed(params, rpc_construct_vhost_blk_ctrlr, 262 SPDK_COUNTOF(rpc_construct_vhost_blk_ctrlr), 263 &req)) { 264 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 265 rc = -EINVAL; 266 goto invalid; 267 } 268 269 rc = spdk_vhost_blk_construct(req.ctrlr, req.cpumask, req.dev_name, req.transport, params); 270 if (rc < 0) { 271 goto invalid; 272 } 273 274 free_rpc_vhost_blk_ctrlr(&req); 275 276 spdk_jsonrpc_send_bool_response(request, true); 277 return; 278 279 invalid: 280 free_rpc_vhost_blk_ctrlr(&req); 281 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 282 spdk_strerror(-rc)); 283 284 } 285 SPDK_RPC_REGISTER("vhost_create_blk_controller", rpc_vhost_create_blk_controller, 286 SPDK_RPC_RUNTIME) 287 288 struct rpc_delete_vhost_ctrlr { 289 char *ctrlr; 290 }; 291 292 static const struct spdk_json_object_decoder rpc_delete_vhost_ctrlr_decoder[] = { 293 {"ctrlr", offsetof(struct rpc_delete_vhost_ctrlr, ctrlr), spdk_json_decode_string }, 294 }; 295 296 static void 297 free_rpc_delete_vhost_ctrlr(struct rpc_delete_vhost_ctrlr *req) 298 { 299 free(req->ctrlr); 300 } 301 302 static void 303 rpc_vhost_delete_controller(struct spdk_jsonrpc_request *request, 304 const struct spdk_json_val *params) 305 { 306 struct rpc_delete_vhost_ctrlr req = {0}; 307 struct spdk_vhost_dev *vdev; 308 int rc; 309 310 if (spdk_json_decode_object(params, rpc_delete_vhost_ctrlr_decoder, 311 SPDK_COUNTOF(rpc_delete_vhost_ctrlr_decoder), &req)) { 312 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 313 rc = -EINVAL; 314 goto invalid; 315 } 316 317 spdk_vhost_lock(); 318 vdev = spdk_vhost_dev_find(req.ctrlr); 319 if (vdev == NULL) { 320 spdk_vhost_unlock(); 321 rc = -ENODEV; 322 goto invalid; 323 } 324 325 rc = spdk_vhost_dev_remove(vdev); 326 spdk_vhost_unlock(); 327 if (rc < 0) { 328 goto invalid; 329 } 330 331 free_rpc_delete_vhost_ctrlr(&req); 332 333 spdk_jsonrpc_send_bool_response(request, true); 334 return; 335 336 invalid: 337 free_rpc_delete_vhost_ctrlr(&req); 338 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 339 spdk_strerror(-rc)); 340 341 } 342 SPDK_RPC_REGISTER("vhost_delete_controller", rpc_vhost_delete_controller, SPDK_RPC_RUNTIME) 343 344 struct rpc_get_vhost_ctrlrs { 345 char *name; 346 }; 347 348 static void 349 _rpc_get_vhost_controller(struct spdk_json_write_ctx *w, struct spdk_vhost_dev *vdev) 350 { 351 uint32_t delay_base_us, iops_threshold; 352 353 spdk_vhost_get_coalescing(vdev, &delay_base_us, &iops_threshold); 354 355 spdk_json_write_object_begin(w); 356 357 spdk_json_write_named_string(w, "ctrlr", spdk_vhost_dev_get_name(vdev)); 358 spdk_json_write_named_string_fmt(w, "cpumask", "0x%s", 359 spdk_cpuset_fmt(spdk_thread_get_cpumask(vdev->thread))); 360 spdk_json_write_named_uint32(w, "delay_base_us", delay_base_us); 361 spdk_json_write_named_uint32(w, "iops_threshold", iops_threshold); 362 spdk_json_write_named_string(w, "socket", vdev->path); 363 364 spdk_json_write_named_object_begin(w, "backend_specific"); 365 vhost_dump_info_json(vdev, w); 366 spdk_json_write_object_end(w); 367 368 spdk_json_write_object_end(w); 369 } 370 371 static const struct spdk_json_object_decoder rpc_get_vhost_ctrlrs_decoders[] = { 372 {"name", offsetof(struct rpc_get_vhost_ctrlrs, name), spdk_json_decode_string, true}, 373 }; 374 375 static void 376 free_rpc_get_vhost_ctrlrs(struct rpc_get_vhost_ctrlrs *req) 377 { 378 free(req->name); 379 } 380 381 static void 382 rpc_vhost_get_controllers(struct spdk_jsonrpc_request *request, 383 const struct spdk_json_val *params) 384 { 385 struct rpc_get_vhost_ctrlrs req = {0}; 386 struct spdk_json_write_ctx *w; 387 struct spdk_vhost_dev *vdev; 388 int rc; 389 390 if (params && spdk_json_decode_object(params, rpc_get_vhost_ctrlrs_decoders, 391 SPDK_COUNTOF(rpc_get_vhost_ctrlrs_decoders), &req)) { 392 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 393 rc = -EINVAL; 394 goto invalid; 395 } 396 397 spdk_vhost_lock(); 398 if (req.name != NULL) { 399 vdev = spdk_vhost_dev_find(req.name); 400 if (vdev == NULL) { 401 spdk_vhost_unlock(); 402 rc = -ENODEV; 403 goto invalid; 404 } 405 406 free_rpc_get_vhost_ctrlrs(&req); 407 408 w = spdk_jsonrpc_begin_result(request); 409 spdk_json_write_array_begin(w); 410 411 _rpc_get_vhost_controller(w, vdev); 412 spdk_vhost_unlock(); 413 414 spdk_json_write_array_end(w); 415 spdk_jsonrpc_end_result(request, w); 416 return; 417 } 418 419 free_rpc_get_vhost_ctrlrs(&req); 420 421 w = spdk_jsonrpc_begin_result(request); 422 spdk_json_write_array_begin(w); 423 424 vdev = spdk_vhost_dev_next(NULL); 425 while (vdev != NULL) { 426 _rpc_get_vhost_controller(w, vdev); 427 vdev = spdk_vhost_dev_next(vdev); 428 } 429 spdk_vhost_unlock(); 430 431 spdk_json_write_array_end(w); 432 spdk_jsonrpc_end_result(request, w); 433 return; 434 435 invalid: 436 free_rpc_get_vhost_ctrlrs(&req); 437 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 438 spdk_strerror(-rc)); 439 } 440 SPDK_RPC_REGISTER("vhost_get_controllers", rpc_vhost_get_controllers, SPDK_RPC_RUNTIME) 441 442 443 struct rpc_vhost_ctrlr_coalescing { 444 char *ctrlr; 445 uint32_t delay_base_us; 446 uint32_t iops_threshold; 447 }; 448 449 static const struct spdk_json_object_decoder rpc_set_vhost_ctrlr_coalescing[] = { 450 {"ctrlr", offsetof(struct rpc_vhost_ctrlr_coalescing, ctrlr), spdk_json_decode_string }, 451 {"delay_base_us", offsetof(struct rpc_vhost_ctrlr_coalescing, delay_base_us), spdk_json_decode_uint32}, 452 {"iops_threshold", offsetof(struct rpc_vhost_ctrlr_coalescing, iops_threshold), spdk_json_decode_uint32}, 453 }; 454 455 static void 456 free_rpc_set_vhost_controllers_event_coalescing(struct rpc_vhost_ctrlr_coalescing *req) 457 { 458 free(req->ctrlr); 459 } 460 461 static void 462 rpc_vhost_controller_set_coalescing(struct spdk_jsonrpc_request *request, 463 const struct spdk_json_val *params) 464 { 465 struct rpc_vhost_ctrlr_coalescing req = {0}; 466 struct spdk_vhost_dev *vdev; 467 int rc; 468 469 if (spdk_json_decode_object(params, rpc_set_vhost_ctrlr_coalescing, 470 SPDK_COUNTOF(rpc_set_vhost_ctrlr_coalescing), &req)) { 471 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 472 rc = -EINVAL; 473 goto invalid; 474 } 475 476 spdk_vhost_lock(); 477 vdev = spdk_vhost_dev_find(req.ctrlr); 478 if (vdev == NULL) { 479 spdk_vhost_unlock(); 480 rc = -ENODEV; 481 goto invalid; 482 } 483 484 rc = spdk_vhost_set_coalescing(vdev, req.delay_base_us, req.iops_threshold); 485 spdk_vhost_unlock(); 486 if (rc) { 487 goto invalid; 488 } 489 490 free_rpc_set_vhost_controllers_event_coalescing(&req); 491 492 spdk_jsonrpc_send_bool_response(request, true); 493 return; 494 495 invalid: 496 free_rpc_set_vhost_controllers_event_coalescing(&req); 497 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 498 spdk_strerror(-rc)); 499 } 500 SPDK_RPC_REGISTER("vhost_controller_set_coalescing", rpc_vhost_controller_set_coalescing, 501 SPDK_RPC_RUNTIME) 502 503 struct rpc_virtio_blk_create_transport { 504 char *name; 505 }; 506 507 static const struct spdk_json_object_decoder rpc_create_virtio_blk_transport[] = { 508 {"name", offsetof(struct rpc_virtio_blk_create_transport, name), spdk_json_decode_string}, 509 }; 510 511 static void 512 free_rpc_virtio_blk_create_transport(struct rpc_virtio_blk_create_transport *req) 513 { 514 free(req->name); 515 } 516 517 static void 518 rpc_virtio_blk_create_transport(struct spdk_jsonrpc_request *request, 519 const struct spdk_json_val *params) 520 { 521 struct rpc_virtio_blk_create_transport req = {0}; 522 int rc; 523 524 if (spdk_json_decode_object_relaxed(params, rpc_create_virtio_blk_transport, 525 SPDK_COUNTOF(rpc_create_virtio_blk_transport), &req)) { 526 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 527 rc = -EINVAL; 528 goto invalid; 529 } 530 531 spdk_vhost_lock(); 532 rc = virtio_blk_transport_create(req.name, params); 533 spdk_vhost_unlock(); 534 if (rc != 0) { 535 goto invalid; 536 } 537 538 free_rpc_virtio_blk_create_transport(&req); 539 spdk_jsonrpc_send_bool_response(request, true); 540 return; 541 542 invalid: 543 free_rpc_virtio_blk_create_transport(&req); 544 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 545 spdk_strerror(-rc)); 546 } 547 SPDK_RPC_REGISTER("virtio_blk_create_transport", rpc_virtio_blk_create_transport, 548 SPDK_RPC_RUNTIME) 549 550 SPDK_LOG_REGISTER_COMPONENT(vhost_rpc) 551