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 }; 239 240 static const struct spdk_json_object_decoder rpc_construct_vhost_blk_ctrlr[] = { 241 {"ctrlr", offsetof(struct rpc_vhost_blk_ctrlr, ctrlr), spdk_json_decode_string }, 242 {"dev_name", offsetof(struct rpc_vhost_blk_ctrlr, dev_name), spdk_json_decode_string }, 243 {"cpumask", offsetof(struct rpc_vhost_blk_ctrlr, cpumask), spdk_json_decode_string, true}, 244 }; 245 246 static void 247 free_rpc_vhost_blk_ctrlr(struct rpc_vhost_blk_ctrlr *req) 248 { 249 free(req->ctrlr); 250 free(req->dev_name); 251 free(req->cpumask); 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, 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 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_create_blk_controller, construct_vhost_blk_controller) 288 289 struct rpc_delete_vhost_ctrlr { 290 char *ctrlr; 291 }; 292 293 static const struct spdk_json_object_decoder rpc_delete_vhost_ctrlr_decoder[] = { 294 {"ctrlr", offsetof(struct rpc_delete_vhost_ctrlr, ctrlr), spdk_json_decode_string }, 295 }; 296 297 static void 298 free_rpc_delete_vhost_ctrlr(struct rpc_delete_vhost_ctrlr *req) 299 { 300 free(req->ctrlr); 301 } 302 303 static void 304 rpc_vhost_delete_controller(struct spdk_jsonrpc_request *request, 305 const struct spdk_json_val *params) 306 { 307 struct rpc_delete_vhost_ctrlr req = {0}; 308 struct spdk_vhost_dev *vdev; 309 int rc; 310 311 if (spdk_json_decode_object(params, rpc_delete_vhost_ctrlr_decoder, 312 SPDK_COUNTOF(rpc_delete_vhost_ctrlr_decoder), &req)) { 313 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 314 rc = -EINVAL; 315 goto invalid; 316 } 317 318 spdk_vhost_lock(); 319 vdev = spdk_vhost_dev_find(req.ctrlr); 320 if (vdev == NULL) { 321 spdk_vhost_unlock(); 322 rc = -ENODEV; 323 goto invalid; 324 } 325 326 rc = spdk_vhost_dev_remove(vdev); 327 spdk_vhost_unlock(); 328 if (rc < 0) { 329 goto invalid; 330 } 331 332 free_rpc_delete_vhost_ctrlr(&req); 333 334 spdk_jsonrpc_send_bool_response(request, true); 335 return; 336 337 invalid: 338 free_rpc_delete_vhost_ctrlr(&req); 339 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 340 spdk_strerror(-rc)); 341 342 } 343 SPDK_RPC_REGISTER("vhost_delete_controller", rpc_vhost_delete_controller, SPDK_RPC_RUNTIME) 344 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_delete_controller, remove_vhost_controller) 345 346 struct rpc_get_vhost_ctrlrs { 347 char *name; 348 }; 349 350 static void 351 _rpc_get_vhost_controller(struct spdk_json_write_ctx *w, struct spdk_vhost_dev *vdev) 352 { 353 uint32_t delay_base_us, iops_threshold; 354 355 spdk_vhost_get_coalescing(vdev, &delay_base_us, &iops_threshold); 356 357 spdk_json_write_object_begin(w); 358 359 spdk_json_write_named_string(w, "ctrlr", spdk_vhost_dev_get_name(vdev)); 360 spdk_json_write_named_string_fmt(w, "cpumask", "0x%s", 361 spdk_cpuset_fmt(spdk_thread_get_cpumask(vdev->thread))); 362 spdk_json_write_named_uint32(w, "delay_base_us", delay_base_us); 363 spdk_json_write_named_uint32(w, "iops_threshold", iops_threshold); 364 spdk_json_write_named_string(w, "socket", vdev->path); 365 366 spdk_json_write_named_object_begin(w, "backend_specific"); 367 vhost_dump_info_json(vdev, w); 368 spdk_json_write_object_end(w); 369 370 spdk_json_write_object_end(w); 371 } 372 373 static const struct spdk_json_object_decoder rpc_get_vhost_ctrlrs_decoders[] = { 374 {"name", offsetof(struct rpc_get_vhost_ctrlrs, name), spdk_json_decode_string, true}, 375 }; 376 377 static void 378 free_rpc_get_vhost_ctrlrs(struct rpc_get_vhost_ctrlrs *req) 379 { 380 free(req->name); 381 } 382 383 static void 384 rpc_vhost_get_controllers(struct spdk_jsonrpc_request *request, 385 const struct spdk_json_val *params) 386 { 387 struct rpc_get_vhost_ctrlrs req = {0}; 388 struct spdk_json_write_ctx *w; 389 struct spdk_vhost_dev *vdev; 390 int rc; 391 392 if (params && spdk_json_decode_object(params, rpc_get_vhost_ctrlrs_decoders, 393 SPDK_COUNTOF(rpc_get_vhost_ctrlrs_decoders), &req)) { 394 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 395 rc = -EINVAL; 396 goto invalid; 397 } 398 399 spdk_vhost_lock(); 400 if (req.name != NULL) { 401 vdev = spdk_vhost_dev_find(req.name); 402 if (vdev == NULL) { 403 spdk_vhost_unlock(); 404 rc = -ENODEV; 405 goto invalid; 406 } 407 408 free_rpc_get_vhost_ctrlrs(&req); 409 410 w = spdk_jsonrpc_begin_result(request); 411 spdk_json_write_array_begin(w); 412 413 _rpc_get_vhost_controller(w, vdev); 414 spdk_vhost_unlock(); 415 416 spdk_json_write_array_end(w); 417 spdk_jsonrpc_end_result(request, w); 418 return; 419 } 420 421 free_rpc_get_vhost_ctrlrs(&req); 422 423 w = spdk_jsonrpc_begin_result(request); 424 spdk_json_write_array_begin(w); 425 426 vdev = spdk_vhost_dev_next(NULL); 427 while (vdev != NULL) { 428 _rpc_get_vhost_controller(w, vdev); 429 vdev = spdk_vhost_dev_next(vdev); 430 } 431 spdk_vhost_unlock(); 432 433 spdk_json_write_array_end(w); 434 spdk_jsonrpc_end_result(request, w); 435 return; 436 437 invalid: 438 free_rpc_get_vhost_ctrlrs(&req); 439 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 440 spdk_strerror(-rc)); 441 } 442 SPDK_RPC_REGISTER("vhost_get_controllers", rpc_vhost_get_controllers, SPDK_RPC_RUNTIME) 443 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_get_controllers, get_vhost_controllers) 444 445 446 struct rpc_vhost_ctrlr_coalescing { 447 char *ctrlr; 448 uint32_t delay_base_us; 449 uint32_t iops_threshold; 450 }; 451 452 static const struct spdk_json_object_decoder rpc_set_vhost_ctrlr_coalescing[] = { 453 {"ctrlr", offsetof(struct rpc_vhost_ctrlr_coalescing, ctrlr), spdk_json_decode_string }, 454 {"delay_base_us", offsetof(struct rpc_vhost_ctrlr_coalescing, delay_base_us), spdk_json_decode_uint32}, 455 {"iops_threshold", offsetof(struct rpc_vhost_ctrlr_coalescing, iops_threshold), spdk_json_decode_uint32}, 456 }; 457 458 static void 459 free_rpc_set_vhost_controllers_event_coalescing(struct rpc_vhost_ctrlr_coalescing *req) 460 { 461 free(req->ctrlr); 462 } 463 464 static void 465 rpc_vhost_controller_set_coalescing(struct spdk_jsonrpc_request *request, 466 const struct spdk_json_val *params) 467 { 468 struct rpc_vhost_ctrlr_coalescing req = {0}; 469 struct spdk_vhost_dev *vdev; 470 int rc; 471 472 if (spdk_json_decode_object(params, rpc_set_vhost_ctrlr_coalescing, 473 SPDK_COUNTOF(rpc_set_vhost_ctrlr_coalescing), &req)) { 474 SPDK_DEBUGLOG(vhost_rpc, "spdk_json_decode_object failed\n"); 475 rc = -EINVAL; 476 goto invalid; 477 } 478 479 spdk_vhost_lock(); 480 vdev = spdk_vhost_dev_find(req.ctrlr); 481 if (vdev == NULL) { 482 spdk_vhost_unlock(); 483 rc = -ENODEV; 484 goto invalid; 485 } 486 487 rc = spdk_vhost_set_coalescing(vdev, req.delay_base_us, req.iops_threshold); 488 spdk_vhost_unlock(); 489 if (rc) { 490 goto invalid; 491 } 492 493 free_rpc_set_vhost_controllers_event_coalescing(&req); 494 495 spdk_jsonrpc_send_bool_response(request, true); 496 return; 497 498 invalid: 499 free_rpc_set_vhost_controllers_event_coalescing(&req); 500 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 501 spdk_strerror(-rc)); 502 } 503 SPDK_RPC_REGISTER("vhost_controller_set_coalescing", rpc_vhost_controller_set_coalescing, 504 SPDK_RPC_RUNTIME) 505 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vhost_controller_set_coalescing, set_vhost_controller_coalescing) 506 507 SPDK_LOG_REGISTER_COMPONENT(vhost_rpc) 508