[ceph.git] / ceph / src / spdk / lib / bdev / pmem / bdev_pmem.h

/*-
 *   BSD LICENSE
 *
 *   Copyright (c) Intel Corporation.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SPDK_BDEV_PMEM_H
#define SPDK_BDEV_PMEM_H

#include "spdk/bdev.h"

typedef void (*spdk_delete_pmem_complete)(void *cb_arg, int bdeverrno);

/**
 * Create new pmem bdev.
 *
 * \param pmem_file Pointer to pmem pool file.
 * \param name Bdev name.
 * \param bdev output parameter for bdev when operation is successful.
 * \return 0 on success.
 *         -EIO if pool check failed
 *         -EINVAL if input parameters check failed
 *         -ENOMEM if buffer cannot be allocated
 */
int spdk_create_pmem_disk(const char *pmem_file, const char *name, struct spdk_bdev **bdev);

/**
 * Delete pmem bdev.
 *
 * \param bdev Pointer to pmem bdev.
 * \param cb_fn Function to call after deletion.
 * \param cb_arg Argument to pass to cb_fn.
 */
void spdk_delete_pmem_disk(struct spdk_bdev *bdev, spdk_delete_pmem_complete cb_fn,
			   void *cb_arg);

#endif /* SPDK_BDEV_PMEM_H */
Commit	Line	Data
7c673cae FG	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
11fdf7f2 TL	34	#ifndef SPDK_BDEV_PMEM_H
11fdf7f2 TL	35	#define SPDK_BDEV_PMEM_H
7c673cae	36
7c673cae FG	37	#include "spdk/bdev.h"
7c673cae FG	38
11fdf7f2	39	typedef void (spdk_delete_pmem_complete)(void cb_arg, int bdeverrno);
7c673cae	40
11fdf7f2 TL	41	/**
	42	* Create new pmem bdev.
	43	*
	44	* \param pmem_file Pointer to pmem pool file.
	45	* \param name Bdev name.
	46	* \param bdev output parameter for bdev when operation is successful.
	47	* \return 0 on success.
	48	* -EIO if pool check failed
	49	* -EINVAL if input parameters check failed
	50	* -ENOMEM if buffer cannot be allocated
	51	*/
	52	int spdk_create_pmem_disk(const char pmem_file, const char name, struct spdk_bdev **bdev);
7c673cae	53
11fdf7f2 TL	54	/**
	55	* Delete pmem bdev.
	56	*
	57	* \param bdev Pointer to pmem bdev.
	58	* \param cb_fn Function to call after deletion.
	59	* \param cb_arg Argument to pass to cb_fn.
	60	*/
	61	void spdk_delete_pmem_disk(struct spdk_bdev *bdev, spdk_delete_pmem_complete cb_fn,
	62	void *cb_arg);
7c673cae	63
11fdf7f2	64	#endif /* SPDK_BDEV_PMEM_H */