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