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 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_create_scsi_controller, construct_vhost_scsi_controller) 97 98 struct rpc_vhost_scsi_ctrlr_add_target { 99 char *ctrlr; 100 int32_t scsi_target_num; 101 char *bdev_name; 102 }; 103 104 static void 105 free_rpc_vhost_scsi_ctrlr_add_target(struct rpc_vhost_scsi_ctrlr_add_target *req) 106 { 107 free(req->ctrlr); 108 free(req->bdev_name); 109 } 110 111 static const struct spdk_json_object_decoder rpc_vhost_scsi_ctrlr_add_target[] = { 112 {"ctrlr", offsetof(struct rpc_vhost_scsi_ctrlr_add_target, ctrlr), spdk_json_decode_string }, 113 {"scsi_target_num", offsetof(struct rpc_vhost_scsi_ctrlr_add_target, scsi_target_num), spdk_json_decode_int32}, 114 {"bdev_name", offsetof(struct rpc_vhost_scsi_ctrlr_add_target, bdev_name), spdk_json_decode_string }, 115 }; 116 117 static void 118 rpc_vhost_scsi_controller_add_target(struct spdk_jsonrpc_request *request, 119 const struct spdk_json_val *params) 120 { 121 struct rpc_vhost_scsi_ctrlr_add_target req = {0}; 122 struct spdk_json_write_ctx *w; 123 struct spdk_vhost_dev *vdev; 124 int rc; 125 126 if (spdk_json_decode_object(params, rpc_vhost_scsi_ctrlr_add_target, 127 SPDK_COUNTOF(rpc_vhost_scsi_ctrlr_add_target), 128 &req)) { 129 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 130 rc = -EINVAL; 131 goto invalid; 132 } 133 134 spdk_vhost_lock(); 135 vdev = spdk_vhost_dev_find(req.ctrlr); 136 if (vdev == NULL) { 137 spdk_vhost_unlock(); 138 rc = -ENODEV; 139 goto invalid; 140 } 141 142 rc = spdk_vhost_scsi_dev_add_tgt(vdev, req.scsi_target_num, req.bdev_name); 143 spdk_vhost_unlock(); 144 if (rc < 0) { 145 goto invalid; 146 } 147 148 free_rpc_vhost_scsi_ctrlr_add_target(&req); 149 150 w = spdk_jsonrpc_begin_result(request); 151 spdk_json_write_int32(w, rc); 152 spdk_jsonrpc_end_result(request, w); 153 return; 154 155 invalid: 156 free_rpc_vhost_scsi_ctrlr_add_target(&req); 157 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 158 spdk_strerror(-rc)); 159 } 160 SPDK_RPC_REGISTER("vhost_scsi_controller_add_target", rpc_vhost_scsi_controller_add_target, 161 SPDK_RPC_RUNTIME) 162 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_scsi_controller_add_target, add_vhost_scsi_lun) 163 164 struct rpc_remove_vhost_scsi_ctrlr_target { 165 char *ctrlr; 166 uint32_t scsi_target_num; 167 }; 168 169 static void 170 free_rpc_remove_vhost_scsi_ctrlr_target(struct rpc_remove_vhost_scsi_ctrlr_target *req) 171 { 172 free(req->ctrlr); 173 } 174 175 static const struct spdk_json_object_decoder rpc_vhost_remove_target[] = { 176 {"ctrlr", offsetof(struct rpc_remove_vhost_scsi_ctrlr_target, ctrlr), spdk_json_decode_string }, 177 {"scsi_target_num", offsetof(struct rpc_remove_vhost_scsi_ctrlr_target, scsi_target_num), spdk_json_decode_uint32}, 178 }; 179 180 static int 181 rpc_vhost_scsi_controller_remove_target_finish_cb(struct spdk_vhost_dev *vdev, void *arg) 182 { 183 struct spdk_jsonrpc_request *request = arg; 184 185 spdk_jsonrpc_send_bool_response(request, true); 186 return 0; 187 } 188 189 static void 190 rpc_vhost_scsi_controller_remove_target(struct spdk_jsonrpc_request *request, 191 const struct spdk_json_val *params) 192 { 193 struct rpc_remove_vhost_scsi_ctrlr_target req = {0}; 194 struct spdk_vhost_dev *vdev; 195 int rc; 196 197 if (spdk_json_decode_object(params, rpc_vhost_remove_target, 198 SPDK_COUNTOF(rpc_vhost_remove_target), 199 &req)) { 200 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 201 rc = -EINVAL; 202 goto invalid; 203 } 204 205 spdk_vhost_lock(); 206 vdev = spdk_vhost_dev_find(req.ctrlr); 207 if (vdev == NULL) { 208 spdk_vhost_unlock(); 209 rc = -ENODEV; 210 goto invalid; 211 } 212 213 rc = spdk_vhost_scsi_dev_remove_tgt(vdev, req.scsi_target_num, 214 rpc_vhost_scsi_controller_remove_target_finish_cb, 215 request); 216 spdk_vhost_unlock(); 217 if (rc < 0) { 218 goto invalid; 219 } 220 221 free_rpc_remove_vhost_scsi_ctrlr_target(&req); 222 return; 223 224 invalid: 225 free_rpc_remove_vhost_scsi_ctrlr_target(&req); 226 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 227 spdk_strerror(-rc)); 228 } 229 230 SPDK_RPC_REGISTER("vhost_scsi_controller_remove_target", 231 rpc_vhost_scsi_controller_remove_target, SPDK_RPC_RUNTIME) 232 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_scsi_controller_remove_target, remove_vhost_scsi_target) 233 234 struct rpc_vhost_blk_ctrlr { 235 char *ctrlr; 236 char *dev_name; 237 char *cpumask; 238 bool readonly; 239 bool packed_ring; 240 bool packed_ring_recovery; 241 }; 242 243 static const struct spdk_json_object_decoder rpc_construct_vhost_blk_ctrlr[] = { 244 {"ctrlr", offsetof(struct rpc_vhost_blk_ctrlr, ctrlr), spdk_json_decode_string }, 245 {"dev_name", offsetof(struct rpc_vhost_blk_ctrlr, dev_name), spdk_json_decode_string }, 246 {"cpumask", offsetof(struct rpc_vhost_blk_ctrlr, cpumask), spdk_json_decode_string, true}, 247 {"readonly", offsetof(struct rpc_vhost_blk_ctrlr, readonly), spdk_json_decode_bool, true}, 248 {"packed_ring", offsetof(struct rpc_vhost_blk_ctrlr, packed_ring), spdk_json_decode_bool, true}, 249 {"packed_ring_recovery", offsetof(struct rpc_vhost_blk_ctrlr, packed_ring_recovery), spdk_json_decode_bool, true}, 250 }; 251 252 static void 253 free_rpc_vhost_blk_ctrlr(struct rpc_vhost_blk_ctrlr *req) 254 { 255 free(req->ctrlr); 256 free(req->dev_name); 257 free(req->cpumask); 258 } 259 260 static void 261 rpc_vhost_create_blk_controller(struct spdk_jsonrpc_request *request, 262 const struct spdk_json_val *params) 263 { 264 struct rpc_vhost_blk_ctrlr req = {0}; 265 int rc; 266 267 if (spdk_json_decode_object(params, rpc_construct_vhost_blk_ctrlr, 268 SPDK_COUNTOF(rpc_construct_vhost_blk_ctrlr), 269 &req)) { 270 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 271 rc = -EINVAL; 272 goto invalid; 273 } 274 275 g_packed_ring_recovery = req.packed_ring_recovery; 276 277 rc = spdk_vhost_blk_construct(req.ctrlr, req.cpumask, req.dev_name, 278 req.readonly, req.packed_ring); 279 if (rc < 0) { 280 goto invalid; 281 } 282 283 free_rpc_vhost_blk_ctrlr(&req); 284 285 spdk_jsonrpc_send_bool_response(request, true); 286 return; 287 288 invalid: 289 free_rpc_vhost_blk_ctrlr(&req); 290 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 291 spdk_strerror(-rc)); 292 293 } 294 SPDK_RPC_REGISTER("vhost_create_blk_controller", rpc_vhost_create_blk_controller, 295 SPDK_RPC_RUNTIME) 296 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_create_blk_controller, construct_vhost_blk_controller) 297 298 struct rpc_delete_vhost_ctrlr { 299 char *ctrlr; 300 }; 301 302 static const struct spdk_json_object_decoder rpc_delete_vhost_ctrlr_decoder[] = { 303 {"ctrlr", offsetof(struct rpc_delete_vhost_ctrlr, ctrlr), spdk_json_decode_string }, 304 }; 305 306 static void 307 free_rpc_delete_vhost_ctrlr(struct rpc_delete_vhost_ctrlr *req) 308 { 309 free(req->ctrlr); 310 } 311 312 static void 313 rpc_vhost_delete_controller(struct spdk_jsonrpc_request *request, 314 const struct spdk_json_val *params) 315 { 316 struct rpc_delete_vhost_ctrlr req = {0}; 317 struct spdk_vhost_dev *vdev; 318 int rc; 319 320 if (spdk_json_decode_object(params, rpc_delete_vhost_ctrlr_decoder, 321 SPDK_COUNTOF(rpc_delete_vhost_ctrlr_decoder), &req)) { 322 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 323 rc = -EINVAL; 324 goto invalid; 325 } 326 327 spdk_vhost_lock(); 328 vdev = spdk_vhost_dev_find(req.ctrlr); 329 if (vdev == NULL) { 330 spdk_vhost_unlock(); 331 rc = -ENODEV; 332 goto invalid; 333 } 334 335 rc = spdk_vhost_dev_remove(vdev); 336 spdk_vhost_unlock(); 337 if (rc < 0) { 338 goto invalid; 339 } 340 341 free_rpc_delete_vhost_ctrlr(&req); 342 343 spdk_jsonrpc_send_bool_response(request, true); 344 return; 345 346 invalid: 347 free_rpc_delete_vhost_ctrlr(&req); 348 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 349 spdk_strerror(-rc)); 350 351 } 352 SPDK_RPC_REGISTER("vhost_delete_controller", rpc_vhost_delete_controller, SPDK_RPC_RUNTIME) 353 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_delete_controller, remove_vhost_controller) 354 355 struct rpc_get_vhost_ctrlrs { 356 char *name; 357 }; 358 359 static void 360 _rpc_get_vhost_controller(struct spdk_json_write_ctx *w, struct spdk_vhost_dev *vdev) 361 { 362 uint32_t delay_base_us, iops_threshold; 363 364 spdk_vhost_get_coalescing(vdev, &delay_base_us, &iops_threshold); 365 366 spdk_json_write_object_begin(w); 367 368 spdk_json_write_named_string(w, "ctrlr", spdk_vhost_dev_get_name(vdev)); 369 spdk_json_write_named_string_fmt(w, "cpumask", "0x%s", 370 spdk_cpuset_fmt(spdk_thread_get_cpumask(vdev->thread))); 371 spdk_json_write_named_uint32(w, "delay_base_us", delay_base_us); 372 spdk_json_write_named_uint32(w, "iops_threshold", iops_threshold); 373 spdk_json_write_named_string(w, "socket", vdev->path); 374 375 spdk_json_write_named_object_begin(w, "backend_specific"); 376 vhost_dump_info_json(vdev, w); 377 spdk_json_write_object_end(w); 378 379 spdk_json_write_object_end(w); 380 } 381 382 static const struct spdk_json_object_decoder rpc_get_vhost_ctrlrs_decoders[] = { 383 {"name", offsetof(struct rpc_get_vhost_ctrlrs, name), spdk_json_decode_string, true}, 384 }; 385 386 static void 387 free_rpc_get_vhost_ctrlrs(struct rpc_get_vhost_ctrlrs *req) 388 { 389 free(req->name); 390 } 391 392 static void 393 rpc_vhost_get_controllers(struct spdk_jsonrpc_request *request, 394 const struct spdk_json_val *params) 395 { 396 struct rpc_get_vhost_ctrlrs req = {0}; 397 struct spdk_json_write_ctx *w; 398 struct spdk_vhost_dev *vdev; 399 int rc; 400 401 if (params && spdk_json_decode_object(params, rpc_get_vhost_ctrlrs_decoders, 402 SPDK_COUNTOF(rpc_get_vhost_ctrlrs_decoders), &req)) { 403 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 404 rc = -EINVAL; 405 goto invalid; 406 } 407 408 spdk_vhost_lock(); 409 if (req.name != NULL) { 410 vdev = spdk_vhost_dev_find(req.name); 411 if (vdev == NULL) { 412 spdk_vhost_unlock(); 413 rc = -ENODEV; 414 goto invalid; 415 } 416 417 free_rpc_get_vhost_ctrlrs(&req); 418 419 w = spdk_jsonrpc_begin_result(request); 420 spdk_json_write_array_begin(w); 421 422 _rpc_get_vhost_controller(w, vdev); 423 spdk_vhost_unlock(); 424 425 spdk_json_write_array_end(w); 426 spdk_jsonrpc_end_result(request, w); 427 return; 428 } 429 430 free_rpc_get_vhost_ctrlrs(&req); 431 432 w = spdk_jsonrpc_begin_result(request); 433 spdk_json_write_array_begin(w); 434 435 vdev = spdk_vhost_dev_next(NULL); 436 while (vdev != NULL) { 437 _rpc_get_vhost_controller(w, vdev); 438 vdev = spdk_vhost_dev_next(vdev); 439 } 440 spdk_vhost_unlock(); 441 442 spdk_json_write_array_end(w); 443 spdk_jsonrpc_end_result(request, w); 444 return; 445 446 invalid: 447 free_rpc_get_vhost_ctrlrs(&req); 448 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 449 spdk_strerror(-rc)); 450 } 451 SPDK_RPC_REGISTER("vhost_get_controllers", rpc_vhost_get_controllers, SPDK_RPC_RUNTIME) 452 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_get_controllers, get_vhost_controllers) 453 454 455 struct rpc_vhost_ctrlr_coalescing { 456 char *ctrlr; 457 uint32_t delay_base_us; 458 uint32_t iops_threshold; 459 }; 460 461 static const struct spdk_json_object_decoder rpc_set_vhost_ctrlr_coalescing[] = { 462 {"ctrlr", offsetof(struct rpc_vhost_ctrlr_coalescing, ctrlr), spdk_json_decode_string }, 463 {"delay_base_us", offsetof(struct rpc_vhost_ctrlr_coalescing, delay_base_us), spdk_json_decode_uint32}, 464 {"iops_threshold", offsetof(struct rpc_vhost_ctrlr_coalescing, iops_threshold), spdk_json_decode_uint32}, 465 }; 466 467 static void 468 free_rpc_set_vhost_controllers_event_coalescing(struct rpc_vhost_ctrlr_coalescing *req) 469 { 470 free(req->ctrlr); 471 } 472 473 static void 474 rpc_vhost_controller_set_coalescing(struct spdk_jsonrpc_request *request, 475 const struct spdk_json_val *params) 476 { 477 struct rpc_vhost_ctrlr_coalescing req = {0}; 478 struct spdk_vhost_dev *vdev; 479 int rc; 480 481 if (spdk_json_decode_object(params, rpc_set_vhost_ctrlr_coalescing, 482 SPDK_COUNTOF(rpc_set_vhost_ctrlr_coalescing), &req)) { 483 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 484 rc = -EINVAL; 485 goto invalid; 486 } 487 488 spdk_vhost_lock(); 489 vdev = spdk_vhost_dev_find(req.ctrlr); 490 if (vdev == NULL) { 491 spdk_vhost_unlock(); 492 rc = -ENODEV; 493 goto invalid; 494 } 495 496 rc = spdk_vhost_set_coalescing(vdev, req.delay_base_us, req.iops_threshold); 497 spdk_vhost_unlock(); 498 if (rc) { 499 goto invalid; 500 } 501 502 free_rpc_set_vhost_controllers_event_coalescing(&req); 503 504 spdk_jsonrpc_send_bool_response(request, true); 505 return; 506 507 invalid: 508 free_rpc_set_vhost_controllers_event_coalescing(&req); 509 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 510 spdk_strerror(-rc)); 511 } 512 SPDK_RPC_REGISTER("vhost_controller_set_coalescing", rpc_vhost_controller_set_coalescing, 513 SPDK_RPC_RUNTIME) 514 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_controller_set_coalescing, set_vhost_controller_coalescing) 515 516 SPDK_LOG_REGISTER_COMPONENT(vhost_rpc) 517