1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 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 #include "spdk/string.h" 36 #include "spdk/rpc.h" 37 #include "spdk/util.h" 38 #include "spdk/string.h" 39 #include "spdk_internal/log.h" 40 #include "vbdev_error.h" 41 42 #define ERROR_BDEV_IO_TYPE_INVALID (SPDK_BDEV_IO_TYPE_RESET + 1) 43 #define ERROR_BDEV_ERROR_TYPE_INVALID (VBDEV_IO_PENDING + 1) 44 45 static uint32_t 46 spdk_rpc_error_bdev_io_type_parse(char *name) 47 { 48 if (strcmp(name, "read") == 0) { 49 return SPDK_BDEV_IO_TYPE_READ; 50 } else if (strcmp(name, "write") == 0) { 51 return SPDK_BDEV_IO_TYPE_WRITE; 52 } else if (strcmp(name, "flush") == 0) { 53 return SPDK_BDEV_IO_TYPE_FLUSH; 54 } else if (strcmp(name, "unmap") == 0) { 55 return SPDK_BDEV_IO_TYPE_UNMAP; 56 } else if (strcmp(name, "all") == 0) { 57 return 0xffffffff; 58 } else if (strcmp(name, "clear") == 0) { 59 return 0; 60 } 61 return ERROR_BDEV_IO_TYPE_INVALID; 62 } 63 64 static uint32_t 65 spdk_rpc_error_bdev_error_type_parse(char *name) 66 { 67 if (strcmp(name, "failure") == 0) { 68 return VBDEV_IO_FAILURE; 69 } else if (strcmp(name, "pending") == 0) { 70 return VBDEV_IO_PENDING; 71 } 72 return ERROR_BDEV_ERROR_TYPE_INVALID; 73 } 74 75 struct rpc_bdev_error_create { 76 char *base_name; 77 }; 78 79 static void 80 free_rpc_bdev_error_create(struct rpc_bdev_error_create *req) 81 { 82 free(req->base_name); 83 } 84 85 static const struct spdk_json_object_decoder rpc_bdev_error_create_decoders[] = { 86 {"base_name", offsetof(struct rpc_bdev_error_create, base_name), spdk_json_decode_string}, 87 }; 88 89 static void 90 spdk_rpc_bdev_error_create(struct spdk_jsonrpc_request *request, 91 const struct spdk_json_val *params) 92 { 93 struct rpc_bdev_error_create req = {}; 94 struct spdk_json_write_ctx *w; 95 int rc = 0; 96 97 if (spdk_json_decode_object(params, rpc_bdev_error_create_decoders, 98 SPDK_COUNTOF(rpc_bdev_error_create_decoders), 99 &req)) { 100 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 101 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 102 "spdk_json_decode_object failed"); 103 goto cleanup; 104 } 105 106 rc = spdk_vbdev_error_create(req.base_name); 107 if (rc) { 108 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 109 goto cleanup; 110 } 111 112 w = spdk_jsonrpc_begin_result(request); 113 spdk_json_write_bool(w, true); 114 spdk_jsonrpc_end_result(request, w); 115 116 cleanup: 117 free_rpc_bdev_error_create(&req); 118 } 119 SPDK_RPC_REGISTER("bdev_error_create", spdk_rpc_bdev_error_create, SPDK_RPC_RUNTIME) 120 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_error_create, construct_error_bdev) 121 122 struct rpc_delete_error { 123 char *name; 124 }; 125 126 static void 127 free_rpc_delete_error(struct rpc_delete_error *r) 128 { 129 free(r->name); 130 } 131 132 static const struct spdk_json_object_decoder rpc_delete_error_decoders[] = { 133 {"name", offsetof(struct rpc_delete_error, name), spdk_json_decode_string}, 134 }; 135 136 static void 137 _spdk_rpc_bdev_error_delete_cb(void *cb_arg, int bdeverrno) 138 { 139 struct spdk_jsonrpc_request *request = cb_arg; 140 struct spdk_json_write_ctx *w; 141 142 w = spdk_jsonrpc_begin_result(request); 143 spdk_json_write_bool(w, bdeverrno == 0); 144 spdk_jsonrpc_end_result(request, w); 145 } 146 147 static void 148 spdk_rpc_bdev_error_delete(struct spdk_jsonrpc_request *request, 149 const struct spdk_json_val *params) 150 { 151 struct rpc_delete_error req = {NULL}; 152 struct spdk_bdev *vbdev; 153 154 if (spdk_json_decode_object(params, rpc_delete_error_decoders, 155 SPDK_COUNTOF(rpc_delete_error_decoders), 156 &req)) { 157 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 158 "spdk_json_decode_object failed"); 159 goto cleanup; 160 } 161 162 vbdev = spdk_bdev_get_by_name(req.name); 163 if (vbdev == NULL) { 164 spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV)); 165 goto cleanup; 166 } 167 168 spdk_vbdev_error_delete(vbdev, _spdk_rpc_bdev_error_delete_cb, request); 169 170 cleanup: 171 free_rpc_delete_error(&req); 172 } 173 SPDK_RPC_REGISTER("bdev_error_delete", spdk_rpc_bdev_error_delete, SPDK_RPC_RUNTIME) 174 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_error_delete, delete_error_bdev) 175 176 struct rpc_error_information { 177 char *name; 178 char *io_type; 179 char *error_type; 180 uint32_t num; 181 }; 182 183 static const struct spdk_json_object_decoder rpc_error_information_decoders[] = { 184 {"name", offsetof(struct rpc_error_information, name), spdk_json_decode_string}, 185 {"io_type", offsetof(struct rpc_error_information, io_type), spdk_json_decode_string}, 186 {"error_type", offsetof(struct rpc_error_information, error_type), spdk_json_decode_string}, 187 {"num", offsetof(struct rpc_error_information, num), spdk_json_decode_uint32, true}, 188 }; 189 190 static void 191 free_rpc_error_information(struct rpc_error_information *p) 192 { 193 free(p->name); 194 free(p->io_type); 195 free(p->error_type); 196 } 197 198 static void 199 spdk_rpc_bdev_error_inject_error(struct spdk_jsonrpc_request *request, 200 const struct spdk_json_val *params) 201 { 202 struct rpc_error_information req = {}; 203 struct spdk_json_write_ctx *w; 204 uint32_t io_type; 205 uint32_t error_type; 206 int rc = 0; 207 208 if (spdk_json_decode_object(params, rpc_error_information_decoders, 209 SPDK_COUNTOF(rpc_error_information_decoders), 210 &req)) { 211 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 212 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 213 "spdk_json_decode_object failed"); 214 goto cleanup; 215 } 216 217 io_type = spdk_rpc_error_bdev_io_type_parse(req.io_type); 218 if (io_type == ERROR_BDEV_IO_TYPE_INVALID) { 219 spdk_jsonrpc_send_error_response(request, -EINVAL, 220 "Unexpected io_type value"); 221 goto cleanup; 222 } 223 224 error_type = spdk_rpc_error_bdev_error_type_parse(req.error_type); 225 if (error_type == ERROR_BDEV_ERROR_TYPE_INVALID) { 226 spdk_jsonrpc_send_error_response(request, -EINVAL, 227 "Unexpected error_type value"); 228 goto cleanup; 229 } 230 231 rc = spdk_vbdev_error_inject_error(req.name, io_type, error_type, req.num); 232 if (rc) { 233 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 234 goto cleanup; 235 } 236 237 w = spdk_jsonrpc_begin_result(request); 238 spdk_json_write_bool(w, true); 239 spdk_jsonrpc_end_result(request, w); 240 241 cleanup: 242 free_rpc_error_information(&req); 243 } 244 SPDK_RPC_REGISTER("bdev_error_inject_error", spdk_rpc_bdev_error_inject_error, SPDK_RPC_RUNTIME) 245 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_error_inject_error, bdev_inject_error) 246