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 "vbdev_compress.h" 35 #include "spdk/rpc.h" 36 #include "spdk/util.h" 37 #include "spdk/string.h" 38 #include "spdk_internal/log.h" 39 40 struct rpc_bdev_compress_get_orphans { 41 char *name; 42 }; 43 44 static void 45 free_rpc_bdev_compress_get_orphans(struct rpc_bdev_compress_get_orphans *r) 46 { 47 free(r->name); 48 } 49 50 static const struct spdk_json_object_decoder rpc_bdev_compress_get_orphans_decoders[] = { 51 {"name", offsetof(struct rpc_bdev_compress_get_orphans, name), spdk_json_decode_string, true}, 52 }; 53 54 static void 55 spdk_rpc_bdev_compress_get_orphans(struct spdk_jsonrpc_request *request, 56 const struct spdk_json_val *params) 57 { 58 struct rpc_bdev_compress_get_orphans req = {}; 59 struct spdk_json_write_ctx *w; 60 struct vbdev_compress *comp_bdev; 61 bool found = false; 62 63 64 if (params && spdk_json_decode_object(params, rpc_bdev_compress_get_orphans_decoders, 65 SPDK_COUNTOF(rpc_bdev_compress_get_orphans_decoders), 66 &req)) { 67 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 68 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 69 "spdk_json_decode_object failed"); 70 free_rpc_bdev_compress_get_orphans(&req); 71 return; 72 } 73 74 if (req.name) { 75 if (compress_has_orphan(req.name) == false) { 76 spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV)); 77 free_rpc_bdev_compress_get_orphans(&req); 78 return; 79 } 80 found = true; 81 } 82 83 w = spdk_jsonrpc_begin_result(request); 84 spdk_json_write_array_begin(w); 85 if (found) { 86 spdk_json_write_string(w, req.name); 87 } else { 88 for (comp_bdev = compress_bdev_first(); comp_bdev != NULL; 89 comp_bdev = compress_bdev_next(comp_bdev)) { 90 if (compress_has_orphan(compress_get_name(comp_bdev))) { 91 spdk_json_write_string(w, compress_get_name(comp_bdev)); 92 } 93 } 94 } 95 spdk_json_write_array_end(w); 96 spdk_jsonrpc_end_result(request, w); 97 free_rpc_bdev_compress_get_orphans(&req); 98 } 99 SPDK_RPC_REGISTER("bdev_compress_get_orphans", spdk_rpc_bdev_compress_get_orphans, SPDK_RPC_RUNTIME) 100 101 struct rpc_set_compress_pmd { 102 enum compress_pmd pmd; 103 }; 104 105 static const struct spdk_json_object_decoder rpc_compress_pmd_decoder[] = { 106 {"pmd", offsetof(struct rpc_set_compress_pmd, pmd), spdk_json_decode_int32}, 107 }; 108 109 static void 110 spdk_rpc_set_compress_pmd(struct spdk_jsonrpc_request *request, 111 const struct spdk_json_val *params) 112 { 113 struct rpc_set_compress_pmd req; 114 struct spdk_json_write_ctx *w; 115 int rc = 0; 116 117 if (spdk_json_decode_object(params, rpc_compress_pmd_decoder, 118 SPDK_COUNTOF(rpc_compress_pmd_decoder), 119 &req)) { 120 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 121 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 122 "spdk_json_decode_object failed"); 123 return; 124 } 125 126 if (req.pmd >= COMPRESS_PMD_MAX) { 127 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, 128 "PMD value %d should be less than %d", req.pmd, COMPRESS_PMD_MAX); 129 return; 130 } 131 132 rc = set_compress_pmd(&req.pmd); 133 if (rc) { 134 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 135 return; 136 } 137 138 w = spdk_jsonrpc_begin_result(request); 139 if (w != NULL) { 140 spdk_json_write_bool(w, true); 141 spdk_jsonrpc_end_result(request, w); 142 } 143 } 144 SPDK_RPC_REGISTER("set_compress_pmd", spdk_rpc_set_compress_pmd, 145 SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME) 146 147 /* Structure to hold the parameters for this RPC method. */ 148 struct rpc_construct_compress { 149 char *base_bdev_name; 150 char *pm_path; 151 }; 152 153 /* Free the allocated memory resource after the RPC handling. */ 154 static void 155 free_rpc_construct_compress(struct rpc_construct_compress *r) 156 { 157 free(r->base_bdev_name); 158 free(r->pm_path); 159 } 160 161 /* Structure to decode the input parameters for this RPC method. */ 162 static const struct spdk_json_object_decoder rpc_construct_compress_decoders[] = { 163 {"base_bdev_name", offsetof(struct rpc_construct_compress, base_bdev_name), spdk_json_decode_string}, 164 {"pm_path", offsetof(struct rpc_construct_compress, pm_path), spdk_json_decode_string}, 165 }; 166 167 /* Decode the parameters for this RPC method and properly construct the compress 168 * device. Error status returned in the failed cases. 169 */ 170 static void 171 spdk_rpc_bdev_compress_create(struct spdk_jsonrpc_request *request, 172 const struct spdk_json_val *params) 173 { 174 struct rpc_construct_compress req = {NULL}; 175 struct spdk_json_write_ctx *w; 176 char *name; 177 int rc; 178 179 if (spdk_json_decode_object(params, rpc_construct_compress_decoders, 180 SPDK_COUNTOF(rpc_construct_compress_decoders), 181 &req)) { 182 SPDK_DEBUGLOG(SPDK_LOG_VBDEV_COMPRESS, "spdk_json_decode_object failed\n"); 183 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 184 "spdk_json_decode_object failed"); 185 goto cleanup; 186 } 187 188 rc = create_compress_bdev(req.base_bdev_name, req.pm_path); 189 if (rc != 0) { 190 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 191 goto cleanup; 192 } 193 194 w = spdk_jsonrpc_begin_result(request); 195 name = spdk_sprintf_alloc("COMP_%s", req.base_bdev_name); 196 spdk_json_write_string(w, name); 197 spdk_jsonrpc_end_result(request, w); 198 free(name); 199 200 cleanup: 201 free_rpc_construct_compress(&req); 202 } 203 SPDK_RPC_REGISTER("bdev_compress_create", spdk_rpc_bdev_compress_create, SPDK_RPC_RUNTIME) 204 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_compress_create, construct_compress_bdev) 205 206 struct rpc_delete_compress { 207 char *name; 208 }; 209 210 static void 211 free_rpc_delete_compress(struct rpc_delete_compress *req) 212 { 213 free(req->name); 214 } 215 216 static const struct spdk_json_object_decoder rpc_delete_compress_decoders[] = { 217 {"name", offsetof(struct rpc_delete_compress, name), spdk_json_decode_string}, 218 }; 219 220 static void 221 _spdk_rpc_bdev_compress_delete_cb(void *cb_arg, int bdeverrno) 222 { 223 struct spdk_jsonrpc_request *request = cb_arg; 224 struct spdk_json_write_ctx *w; 225 226 w = spdk_jsonrpc_begin_result(request); 227 spdk_json_write_bool(w, bdeverrno == 0); 228 spdk_jsonrpc_end_result(request, w); 229 } 230 231 static void 232 spdk_rpc_bdev_compress_delete(struct spdk_jsonrpc_request *request, 233 const struct spdk_json_val *params) 234 { 235 struct rpc_delete_compress req = {NULL}; 236 237 if (spdk_json_decode_object(params, rpc_delete_compress_decoders, 238 SPDK_COUNTOF(rpc_delete_compress_decoders), 239 &req)) { 240 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 241 "spdk_json_decode_object failed"); 242 } else { 243 bdev_compress_delete(req.name, _spdk_rpc_bdev_compress_delete_cb, request); 244 } 245 246 free_rpc_delete_compress(&req); 247 } 248 SPDK_RPC_REGISTER("bdev_compress_delete", spdk_rpc_bdev_compress_delete, SPDK_RPC_RUNTIME) 249 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_compress_delete, delete_compress_bdev) 250