Initial commit
Signed-off-by: Robert Baldyga <robert.baldyga@intel.com>
This commit is contained in:
Robert Baldyga
336
inc/ocf_io.h
Normal file
336
inc/ocf_io.h
Normal file
@@ -0,0 +1,336 @@
|
||||
/*
|
||||
* Copyright(c) 2012-2018 Intel Corporation
|
||||
* SPDX-License-Identifier: BSD-3-Clause-Clear
|
||||
*/
|
||||
|
||||
|
||||
#ifndef __OCF_IO_H__
|
||||
#define __OCF_IO_H__
|
||||
|
||||
#include "ocf_types.h"
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @brief OCF IO definitions
|
||||
*/
|
||||
|
||||
struct ocf_io;
|
||||
|
||||
/**
|
||||
* @brief OCF IO legacy completion
|
||||
*
|
||||
* @note This type of completion is for legacy completion type
|
||||
*
|
||||
* @param[in] private_data Private data for completion function
|
||||
* @param[in] error Completion status code
|
||||
*/
|
||||
typedef void (*ocf_end_t)(void *private_data, int error);
|
||||
|
||||
/**
|
||||
* @brief OCF IO start
|
||||
*
|
||||
* @note OCF IO start notification callback
|
||||
*
|
||||
* @param[in] io OCF IO being started
|
||||
*/
|
||||
typedef void (*ocf_start_io_t)(struct ocf_io *io);
|
||||
|
||||
/**
|
||||
* @brief OCF IO handle
|
||||
*
|
||||
* @note OCF IO handle callback
|
||||
*
|
||||
* @param[in] io OCF IO to handle
|
||||
*/
|
||||
typedef void (*ocf_handle_io_t)(struct ocf_io *io, void *opaque);
|
||||
|
||||
/**
|
||||
* @brief OCF IO completion
|
||||
*
|
||||
* @note Completion function for OCF IO
|
||||
*
|
||||
* @param[in] io OCF IO being completed
|
||||
* @param[in] error Completion status code
|
||||
*/
|
||||
typedef void (*ocf_end_io_t)(struct ocf_io *io, int error);
|
||||
|
||||
/**
|
||||
* @brief OCF IO main structure
|
||||
*/
|
||||
struct ocf_io {
|
||||
/**
|
||||
* @brief OCF IO destination data object
|
||||
*/
|
||||
ocf_data_obj_t obj;
|
||||
|
||||
/**
|
||||
* @brief Operations set for this OCF IO
|
||||
*/
|
||||
const struct ocf_io_ops *ops;
|
||||
|
||||
/**
|
||||
* @brief OCF IO destination address
|
||||
*/
|
||||
uint64_t addr;
|
||||
|
||||
/**
|
||||
* @brief OCF IO flags
|
||||
*/
|
||||
uint64_t flags;
|
||||
|
||||
/**
|
||||
* @brief OCF IO size in bytes
|
||||
*/
|
||||
uint32_t bytes;
|
||||
|
||||
/**
|
||||
* @brief OCF IO destination class
|
||||
*/
|
||||
uint32_t class;
|
||||
|
||||
/**
|
||||
* @brief OCF IO direction
|
||||
*/
|
||||
uint32_t dir;
|
||||
|
||||
/**
|
||||
* @brief Queue id
|
||||
*/
|
||||
uint32_t io_queue;
|
||||
|
||||
/**
|
||||
* @brief OCF IO start function
|
||||
*/
|
||||
ocf_start_io_t start;
|
||||
|
||||
/**
|
||||
* @brief OCF IO handle function
|
||||
*/
|
||||
ocf_handle_io_t handle;
|
||||
|
||||
/**
|
||||
* @brief OCF IO completion function
|
||||
*/
|
||||
ocf_end_io_t end;
|
||||
|
||||
/**
|
||||
* @brief OCF IO private 1
|
||||
*/
|
||||
void *priv1;
|
||||
|
||||
/**
|
||||
* @brief OCF IO private 2
|
||||
*/
|
||||
void *priv2;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief OCF IO operations set structure
|
||||
*/
|
||||
struct ocf_io_ops {
|
||||
/**
|
||||
* @brief Set up data vector in OCF IO
|
||||
*
|
||||
* @param[in] io OCF IO to set up
|
||||
* @param[in] data Source context data
|
||||
* @param[in] offset Data offset in source context data
|
||||
*
|
||||
* @retval 0 Data set up successfully
|
||||
* @retval Non-zero Data set up failure
|
||||
*/
|
||||
int (*set_data)(struct ocf_io *io, ctx_data_t *data,
|
||||
uint32_t offset);
|
||||
|
||||
/**
|
||||
* @brief Get context data from OCF IO
|
||||
*
|
||||
* @param[in] io OCF IO to get data
|
||||
*
|
||||
* @return Data vector from IO
|
||||
*/
|
||||
ctx_data_t *(*get_data)(struct ocf_io *io);
|
||||
|
||||
/**
|
||||
* @brief Increase reference counter in OCF IO
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
*/
|
||||
void (*get)(struct ocf_io *io);
|
||||
|
||||
/**
|
||||
* @brief Decrease reference counter in OCF IO
|
||||
*
|
||||
* @note If IO don't have any reference - deallocate it
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
*/
|
||||
void (*put)(struct ocf_io *io);
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Configure OCF IO
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
* @param[in] addr OCF IO destination address
|
||||
* @param[in] bytes OCF IO size in bytes
|
||||
* @param[in] dir OCF IO direction
|
||||
* @param[in] class OCF IO destination class
|
||||
* @param[in] flags OCF IO flags
|
||||
*/
|
||||
static inline void ocf_io_configure(struct ocf_io *io, uint64_t addr,
|
||||
uint32_t bytes, uint32_t dir, uint32_t class, uint64_t flags)
|
||||
{
|
||||
io->addr = addr;
|
||||
io->bytes = bytes;
|
||||
io->class = class;
|
||||
io->flags = flags;
|
||||
io->dir = dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Increase reference counter in OCF IO
|
||||
*
|
||||
* @note Wrapper for get IO operation
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
*/
|
||||
static inline void ocf_io_get(struct ocf_io *io)
|
||||
{
|
||||
io->ops->get(io);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Decrease reference counter in OCF IO
|
||||
*
|
||||
* @note If IO don't have any reference - deallocate it
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
*/
|
||||
static inline void ocf_io_put(struct ocf_io *io)
|
||||
{
|
||||
io->ops->put(io);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set OCF IO completion function
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
* @param[in] context Context for completion function
|
||||
* @param[in] fn Completion function
|
||||
*/
|
||||
static inline void ocf_io_set_cmpl(struct ocf_io *io, void *context,
|
||||
void *context2, ocf_end_io_t fn)
|
||||
{
|
||||
io->priv1 = context;
|
||||
io->priv2 = context2;
|
||||
io->end = fn;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set OCF IO start function
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
* @param[in] fn Start callback function
|
||||
*/
|
||||
static inline void ocf_io_set_start(struct ocf_io *io, ocf_start_io_t fn)
|
||||
{
|
||||
io->start = fn;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set OCF IO handle function
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
* @param[in] fn Handle callback function
|
||||
*/
|
||||
static inline void ocf_io_set_handle(struct ocf_io *io, ocf_handle_io_t fn)
|
||||
{
|
||||
io->handle = fn;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Call default completion function
|
||||
*
|
||||
* @note It is helper function for legacy completion functions
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
* @param[in] error Completion status code
|
||||
*/
|
||||
static inline void ocf_io_end_default(struct ocf_io *io, int error)
|
||||
{
|
||||
ocf_end_t end = io->priv2;
|
||||
|
||||
end(io->priv1, error);
|
||||
|
||||
ocf_io_put(io);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set OCF IO default completion function
|
||||
*
|
||||
* @note This type of completion is for legacy completion type
|
||||
*
|
||||
* @param[in] io OCF IO
|
||||
* @param[in] context Context for completion function
|
||||
* @param[in] fn Completion function
|
||||
*/
|
||||
static inline void ocf_io_set_default_cmpl(struct ocf_io *io, void *context,
|
||||
ocf_end_t fn)
|
||||
{
|
||||
io->priv1 = context;
|
||||
io->priv2 = fn;
|
||||
io->end = ocf_io_end_default;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set up data vector in OCF IO
|
||||
*
|
||||
* @note Wrapper for set up data vector function
|
||||
*
|
||||
* @param[in] io OCF IO to set up
|
||||
* @param[in] data Source data vector
|
||||
* @param[in] offset Data offset in source data vector
|
||||
*
|
||||
* @retval 0 Data set up successfully
|
||||
* @retval Non-zero Data set up failure
|
||||
*/
|
||||
static inline int ocf_io_set_data(struct ocf_io *io, ctx_data_t *data,
|
||||
uint32_t offset)
|
||||
{
|
||||
return io->ops->set_data(io, data, offset);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Get data vector from OCF IO
|
||||
*
|
||||
* @note Wrapper for get data vector function
|
||||
*
|
||||
* @param[in] io OCF IO to get data
|
||||
*
|
||||
* @return Data vector from IO
|
||||
*/
|
||||
static inline ctx_data_t *ocf_io_get_data(struct ocf_io *io)
|
||||
{
|
||||
return io->ops->get_data(io);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set queue id to which IO should be submitted
|
||||
*
|
||||
* @param[in] io OCF IO to set up
|
||||
* @param[in] queue IO queue id
|
||||
*/
|
||||
static inline void ocf_io_set_queue(struct ocf_io *io, uint32_t queue)
|
||||
{
|
||||
io->io_queue = queue;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Handle IO in cache engine
|
||||
*
|
||||
* @param[in] io OCF IO to be handled
|
||||
* @param[in] opaque OCF opaque
|
||||
*/
|
||||
void ocf_io_handle(struct ocf_io *io, void *opaque);
|
||||
|
||||
#endif /* __OCF_IO_H__ */
|
||||
Reference in New Issue
Block a user