ceph/src/spdk/lib/bdev/split/vbdev_split.h

   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_VBDEV_SPLIT_H
  35 #define SPDK_VBDEV_SPLIT_H
  36
  37 #include "spdk/bdev_module.h"
  38
  39 /**
  40  * Add given disk name to split config. If bdev with \c base_bdev_name name
  41  * exist the split bdevs will be created right away, if not the split bdevs will
  42  * be created when base bdev became be available (during examination process).
  43  *
  44  * \param base_bdev_name Base bdev name
  45  * \param split_count number of splits to be created.
  46  * \param split_size_mb size of each bdev. If 0 use base bdev size / split_count
  47  * \return value >= 0 - number of splits create. Negative errno code on error.
  48  */
  49 int create_vbdev_split(const char *base_bdev_name, unsigned split_count, uint64_t split_size_mb);
  50
  51 /**
  52  * Remove all created split bdevs and split config.
  53  *
  54  * \param base_bdev_name base bdev name
  55  * \return 0 on success or negative errno value.
  56  */
  57 int spdk_vbdev_split_destruct(const char *base_bdev_name);
  58
  59 /**
  60  * Get the spdk_bdev_part_base associated with the given split base_bdev.
  61  *
  62  * \param base_bdev Bdev to get the part_base from
  63  * \return pointer to the associated spdk_bdev_part_base
  64  * \return NULL if the base_bdev is not being split by the split module
  65  */
  66 struct spdk_bdev_part_base *spdk_vbdev_split_get_part_base(struct spdk_bdev *base_bdev);
  67
  68 #endif // SPDK_VBDEV_SPLIT_H