ceph/src/spdk/include/spdk/blobfs_bdev.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 /** \file
  35  * Operations on blobfs whose backing device is spdk_bdev
  36  */
  37
  38 #ifndef SPDK_BLOBFS_BDEV_H
  39 #define SPDK_BLOBFS_BDEV_H
  40
  41 #include "spdk/stdinc.h"
  42 #include "spdk/bdev.h"
  43 #include "spdk/config.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 /**
  50  * blobfs on bdev operation completion callback.
  51  *
  52  * \param cb_arg Callback argument.
  53  * \param fserrno 0 if it completed successfully, or negative errno if it failed.
  54  */
  55 typedef void (*spdk_blobfs_bdev_op_complete)(void *cb_arg, int fserrno);
  56
  57 /**
  58  * Detect whether blobfs exists on the given device.
  59  *
  60  * \param bdev_name Name of block device.
  61  * \param cb_fn Called when the detecting is complete. fserrno is -EILSEQ if no blobfs exists.
  62  * \param cb_arg Argument passed to function cb_fn.
  63  */
  64 void spdk_blobfs_bdev_detect(const char *bdev_name,
  65                              spdk_blobfs_bdev_op_complete cb_fn, void *cb_arg);
  66
  67 /**
  68  * Create a blobfs on the given device.
  69  *
  70  * \param bdev_name Name of block device.
  71  * \param cluster_sz Size of cluster in bytes. Must be multiple of 4KiB page size.
  72  * \param cb_fn Called when the creation is complete.
  73  * \param cb_arg Argument passed to function cb_fn.
  74  */
  75 void spdk_blobfs_bdev_create(const char *bdev_name, uint32_t cluster_sz,
  76                              spdk_blobfs_bdev_op_complete cb_fn, void *cb_arg);
  77
  78 #ifdef SPDK_CONFIG_FUSE
  79 /**
  80  * Mount a blobfs on given device to a host path by FUSE
  81  *
  82  * A new thread is created dedicatedly for one mountpoint to handle FUSE request
  83  * by blobfs API.
  84  *
  85  * \param bdev_name Name of block device.
  86  * \param mountpoint Host path to mount blobfs.
  87  * \param cb_fn Called when mount operation is complete. fserrno is -EILSEQ if no blobfs exists.
  88  * \param cb_arg Argument passed to function cb_fn.
  89  */
  90 void spdk_blobfs_bdev_mount(const char *bdev_name, const char *mountpoint,
  91                             spdk_blobfs_bdev_op_complete cb_fn, void *cb_arg);
  92 #endif
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98 #endif /* SPDK_BLOBFS_BDEV_H */