Spdk/module/bdev/compress/vbdev_compress.h
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

81 lines
2.0 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) Intel Corporation.
* All rights reserved.
* Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
*/
#ifndef SPDK_VBDEV_COMPRESS_H
#define SPDK_VBDEV_COMPRESS_H
#include "spdk/stdinc.h"
#include "spdk/bdev.h"
#define LB_SIZE_4K 0x1000UL
#define LB_SIZE_512B 0x200UL
/**
* Get the first compression bdev.
*
* \return the first compression bdev.
*/
struct vbdev_compress *compress_bdev_first(void);
/**
* Get the next compression bdev.
*
* \param prev previous compression bdev.
* \return the next compression bdev.
*/
struct vbdev_compress *compress_bdev_next(struct vbdev_compress *prev);
/**
* Test to see if a compression bdev orphan exists.
*
* \param name The name of the compression bdev.
* \return true if found, false if not.
*/
bool compress_has_orphan(const char *name);
/**
* Get the name of a compression bdev.
*
* \param comp_bdev The compression bdev.
* \return the name of the compression bdev.
*/
const char *compress_get_name(const struct vbdev_compress *comp_bdev);
enum compress_pmd {
COMPRESS_PMD_AUTO = 0,
COMPRESS_PMD_QAT_ONLY,
COMPRESS_PMD_ISAL_ONLY,
COMPRESS_PMD_MLX5_PCI_ONLY,
COMPRESS_PMD_MAX
};
int compress_set_pmd(enum compress_pmd *opts);
typedef void (*spdk_delete_compress_complete)(void *cb_arg, int bdeverrno);
/**
* Create new compression bdev.
*
* \param bdev_name Bdev on which compression bdev will be created.
* \param pm_path Path to persistent memory.
* \param lb_size Logical block size for the compressed volume in bytes. Must be 4K or 512.
* \return 0 on success, other on failure.
*/
int create_compress_bdev(const char *bdev_name, const char *pm_path, uint32_t lb_size);
/**
* Delete compress bdev.
*
* \param bdev_name Bdev on which compression bdev will be deleted.
* \param cb_fn Function to call after deletion.
* \param cb_arg Argument to pass to cb_fn.
*/
void bdev_compress_delete(const char *bdev_name, spdk_delete_compress_complete cb_fn,
void *cb_arg);
#endif /* SPDK_VBDEV_COMPRESS_H */