1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * Copyright (c) 2019 Mellanox Technologies LTD. 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/rpc.h" 35 #include "spdk/util.h" 36 #include "spdk/string.h" 37 #include "spdk/bdev_module.h" 38 #include "spdk_internal/log.h" 39 40 #include "bdev_null.h" 41 42 struct rpc_construct_null { 43 char *name; 44 char *uuid; 45 uint64_t num_blocks; 46 uint32_t block_size; 47 uint32_t md_size; 48 int32_t dif_type; 49 bool dif_is_head_of_md; 50 }; 51 52 static void 53 free_rpc_construct_null(struct rpc_construct_null *req) 54 { 55 free(req->name); 56 free(req->uuid); 57 } 58 59 static const struct spdk_json_object_decoder rpc_construct_null_decoders[] = { 60 {"name", offsetof(struct rpc_construct_null, name), spdk_json_decode_string}, 61 {"uuid", offsetof(struct rpc_construct_null, uuid), spdk_json_decode_string, true}, 62 {"num_blocks", offsetof(struct rpc_construct_null, num_blocks), spdk_json_decode_uint64}, 63 {"block_size", offsetof(struct rpc_construct_null, block_size), spdk_json_decode_uint32}, 64 {"md_size", offsetof(struct rpc_construct_null, md_size), spdk_json_decode_uint32, true}, 65 {"dif_type", offsetof(struct rpc_construct_null, dif_type), spdk_json_decode_int32, true}, 66 {"dif_is_head_of_md", offsetof(struct rpc_construct_null, dif_is_head_of_md), spdk_json_decode_bool, true}, 67 }; 68 69 static void 70 spdk_rpc_bdev_null_create(struct spdk_jsonrpc_request *request, 71 const struct spdk_json_val *params) 72 { 73 struct rpc_construct_null req = {}; 74 struct spdk_json_write_ctx *w; 75 struct spdk_uuid *uuid = NULL; 76 struct spdk_uuid decoded_uuid; 77 struct spdk_bdev *bdev; 78 struct spdk_null_bdev_opts opts = {}; 79 uint32_t data_block_size; 80 int rc = 0; 81 82 if (spdk_json_decode_object(params, rpc_construct_null_decoders, 83 SPDK_COUNTOF(rpc_construct_null_decoders), 84 &req)) { 85 SPDK_DEBUGLOG(SPDK_LOG_BDEV_NULL, "spdk_json_decode_object failed\n"); 86 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 87 "spdk_json_decode_object failed"); 88 goto cleanup; 89 } 90 91 if (req.block_size < req.md_size) { 92 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, 93 "Interleaved metadata size can not be greater than block size"); 94 goto cleanup; 95 } 96 data_block_size = req.block_size - req.md_size; 97 if (data_block_size % 512 != 0) { 98 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, 99 "Data block size %u is not a multiple of 512", req.block_size); 100 goto cleanup; 101 } 102 103 if (req.num_blocks == 0) { 104 spdk_jsonrpc_send_error_response(request, -EINVAL, 105 "Disk num_blocks must be greater than 0"); 106 goto cleanup; 107 } 108 109 if (req.uuid) { 110 if (spdk_uuid_parse(&decoded_uuid, req.uuid)) { 111 spdk_jsonrpc_send_error_response(request, -EINVAL, 112 "Failed to parse bdev UUID"); 113 goto cleanup; 114 } 115 uuid = &decoded_uuid; 116 } 117 118 if (req.dif_type < SPDK_DIF_DISABLE || req.dif_type > SPDK_DIF_TYPE3) { 119 spdk_jsonrpc_send_error_response(request, -EINVAL, "Invalid protection information type"); 120 goto cleanup; 121 } 122 123 opts.name = req.name; 124 opts.uuid = uuid; 125 opts.num_blocks = req.num_blocks; 126 opts.block_size = req.block_size; 127 opts.md_size = req.md_size; 128 opts.md_interleave = true; 129 opts.dif_type = req.dif_type; 130 opts.dif_is_head_of_md = req.dif_is_head_of_md; 131 rc = bdev_null_create(&bdev, &opts); 132 if (rc) { 133 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 134 goto cleanup; 135 } 136 137 w = spdk_jsonrpc_begin_result(request); 138 spdk_json_write_string(w, bdev->name); 139 spdk_jsonrpc_end_result(request, w); 140 free_rpc_construct_null(&req); 141 return; 142 143 cleanup: 144 free_rpc_construct_null(&req); 145 } 146 SPDK_RPC_REGISTER("bdev_null_create", spdk_rpc_bdev_null_create, SPDK_RPC_RUNTIME) 147 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_null_create, construct_null_bdev) 148 149 struct rpc_delete_null { 150 char *name; 151 }; 152 153 static void 154 free_rpc_delete_null(struct rpc_delete_null *req) 155 { 156 free(req->name); 157 } 158 159 static const struct spdk_json_object_decoder rpc_delete_null_decoders[] = { 160 {"name", offsetof(struct rpc_delete_null, name), spdk_json_decode_string}, 161 }; 162 163 static void 164 _spdk_rpc_bdev_null_delete_cb(void *cb_arg, int bdeverrno) 165 { 166 struct spdk_jsonrpc_request *request = cb_arg; 167 struct spdk_json_write_ctx *w = spdk_jsonrpc_begin_result(request); 168 169 spdk_json_write_bool(w, bdeverrno == 0); 170 spdk_jsonrpc_end_result(request, w); 171 } 172 173 static void 174 spdk_rpc_bdev_null_delete(struct spdk_jsonrpc_request *request, 175 const struct spdk_json_val *params) 176 { 177 struct rpc_delete_null req = {NULL}; 178 struct spdk_bdev *bdev; 179 180 if (spdk_json_decode_object(params, rpc_delete_null_decoders, 181 SPDK_COUNTOF(rpc_delete_null_decoders), 182 &req)) { 183 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 184 "spdk_json_decode_object failed"); 185 goto cleanup; 186 } 187 188 bdev = spdk_bdev_get_by_name(req.name); 189 if (bdev == NULL) { 190 spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV)); 191 goto cleanup; 192 } 193 194 bdev_null_delete(bdev, _spdk_rpc_bdev_null_delete_cb, request); 195 196 free_rpc_delete_null(&req); 197 198 return; 199 200 cleanup: 201 free_rpc_delete_null(&req); 202 } 203 SPDK_RPC_REGISTER("bdev_null_delete", spdk_rpc_bdev_null_delete, SPDK_RPC_RUNTIME) 204 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_null_delete, delete_null_bdev) 205