ceph/src/spdk/lib/bdev/compress/vbdev_compress.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_COMPRESS_H
  35 #define SPDK_VBDEV_COMPRESS_H
  36
  37 #include "spdk/stdinc.h"
  38
  39 #include "spdk/bdev.h"
  40
  41 typedef void (*spdk_delete_compress_complete)(void *cb_arg, int bdeverrno);
  42
  43 /**
  44  * Create new compression bdev.
  45  *
  46  * \param bdev_name Bdev on which compression bdev will be created.
  47  * \param pm_path Path to persistent memory.
  48  * \param comp_pmd Compression PMD name.
  49  * \return 0 on success, other on failure.
  50  */
  51 int create_compress_bdev(const char *bdev_name, const char *pm_path, const char *comp_pmd);
  52
  53 /**
  54  * Delete compress bdev.
  55  *
  56  * \param bdev Pointer to compression bdev.
  57  * \param cb_fn Function to call after deletion.
  58  * \param cb_arg Argument to pass to cb_fn.
  59  */
  60 void delete_compress_bdev(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn,
  61                           void *cb_arg);
  62
  63 #endif /* SPDK_VBDEV_COMPRESS_H */