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 #ifndef SPDK_BDEV_RBD_H 35 #define SPDK_BDEV_RBD_H 36 37 #include "spdk/stdinc.h" 38 39 #include "spdk/bdev.h" 40 #include "spdk/rpc.h" 41 42 struct cluster_register_info { 43 char *name; 44 char *user_id; 45 char **config_param; 46 char *config_file; 47 }; 48 49 void bdev_rbd_free_config(char **config); 50 char **bdev_rbd_dup_config(const char *const *config); 51 52 typedef void (*spdk_delete_rbd_complete)(void *cb_arg, int bdeverrno); 53 54 int bdev_rbd_create(struct spdk_bdev **bdev, const char *name, const char *user_id, 55 const char *pool_name, 56 const char *const *config, 57 const char *rbd_name, uint32_t block_size, const char *cluster_name); 58 /** 59 * Delete rbd bdev. 60 * 61 * \param bdev Pointer to rbd bdev. 62 * \param cb_fn Function to call after deletion. 63 * \param cb_arg Argument to pass to cb_fn. 64 */ 65 void bdev_rbd_delete(struct spdk_bdev *bdev, spdk_delete_rbd_complete cb_fn, 66 void *cb_arg); 67 68 /** 69 * Resize rbd bdev. 70 * 71 * \param bdev Pointer to rbd bdev. 72 * \param new_size_in_mb The new size in MiB for this bdev. 73 */ 74 int bdev_rbd_resize(struct spdk_bdev *bdev, const uint64_t new_size_in_mb); 75 76 /** 77 * Create a Rados cluster. 78 * 79 * \param info the info to register the Rados cluster object 80 */ 81 int bdev_rbd_register_cluster(struct cluster_register_info *info); 82 83 /** 84 * Delete a registered cluster. 85 * 86 * \param name the name of the cluster to be deleted. 87 */ 88 int bdev_rbd_unregister_cluster(const char *name); 89 90 /** 91 * Show the cluster info of a given name. If given name is empty, 92 * the info of every registered cluster name will be showed. 93 * 94 * \param request the json request. 95 * \param name the name of the cluster. 96 */ 97 int bdev_rbd_get_clusters_info(struct spdk_jsonrpc_request *request, const char *name); 98 99 #endif /* SPDK_BDEV_RBD_H */ 100