131 lines
4.1 KiB
C
131 lines
4.1 KiB
C
/*
|
|
* Copyright(c) 2012-2022 Intel Corporation
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
#ifndef __CASDISK_H__
|
|
#define __CASDISK_H__
|
|
|
|
#include <linux/blkdev.h>
|
|
#include "linux_kernel_version.h"
|
|
#include "disk.h"
|
|
#include "exp_obj.h"
|
|
|
|
struct casdsk_disk;
|
|
|
|
struct casdsk_exp_obj_ops {
|
|
/**
|
|
* @brief Set geometry of exported object (top) block device.
|
|
* Could be NULL.
|
|
*/
|
|
int (*set_geometry)(struct casdsk_disk *dsk, void *private);
|
|
|
|
/**
|
|
* @brief submit_bio of exported object (top) block device.
|
|
* Called by cas_disk when cas_disk device is in attached mode.
|
|
*
|
|
*/
|
|
void (*submit_bio)(struct casdsk_disk *dsk,
|
|
struct bio *bio, void *private);
|
|
};
|
|
|
|
/**
|
|
* @brief Open block device
|
|
* @param path Path to block device
|
|
* @param private Private data
|
|
* @return Pointer to casdsk_disk related to opened block device
|
|
*/
|
|
struct casdsk_disk *casdsk_disk_open(const char *path, void *private);
|
|
|
|
/**
|
|
* @brief Claim previously opened block device (holded by cas_disk)
|
|
* @param path Path to block device
|
|
* @param private Private data
|
|
* @return Pointer to casdsk_disk structure related to block device, or NULL
|
|
* if device is not opened by cas_disk.
|
|
*/
|
|
struct casdsk_disk *casdsk_disk_claim(const char *path, void *private);
|
|
|
|
/**
|
|
* @brief Close block device and remove from cas_disk
|
|
* @param dsk Pointer to casdsk_disk structure related to block device
|
|
* which should be closed.
|
|
*/
|
|
void casdsk_disk_close(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Get block_device structure of bottom block device
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return Pointer to block_device structure of bottom block device
|
|
*/
|
|
struct block_device *casdsk_disk_get_blkdev(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Get request queue of bottom block device
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return Pointer to reqest_queue structure of bottom block device
|
|
*/
|
|
struct request_queue *casdsk_disk_get_queue(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Get gendisk structure of bottom block device
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return Pointer to gendisk structure of bottom block device
|
|
*/
|
|
struct gendisk *casdsk_disk_get_gendisk(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Create exported object (top device)
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @param dev_name Name of exported object (top device)
|
|
* @param owner Pointer to cas module
|
|
* @param ops Pointer to structure with callback functions
|
|
* @return 0 if success, errno if failure
|
|
*/
|
|
int casdsk_exp_obj_create(struct casdsk_disk *dsk, const char *dev_name,
|
|
struct module *owner, struct casdsk_exp_obj_ops *ops);
|
|
|
|
/**
|
|
* @brief Get request queue of exported object (top) block device
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return Pointer to reqest_queue structure of top block device
|
|
*/
|
|
struct request_queue *casdsk_exp_obj_get_queue(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Get gendisk structure of exported object (top) block device
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return Pointer to gendisk structure of top block device
|
|
*/
|
|
struct gendisk *casdsk_exp_obj_get_gendisk(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Activate exported object (make it visible to OS
|
|
* and allow I/O handling)
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return 0 if success, errno if failure
|
|
*/
|
|
int casdsk_exp_obj_activate(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Lock exported object
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return 0 if success, errno if failure
|
|
*/
|
|
int casdsk_exp_obj_lock(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Unlock exported object
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return 0 if success, errno if failure
|
|
*/
|
|
int casdsk_exp_obj_unlock(struct casdsk_disk *dsk);
|
|
|
|
/**
|
|
* @brief Destroy exported object
|
|
* @param dsk Pointer to casdsk_disk structure related to cas_disk device
|
|
* @return 0 if success, errno if failure
|
|
*/
|
|
int casdsk_exp_obj_destroy(struct casdsk_disk *dsk);
|
|
|
|
#endif
|