ocf_core.h File Reference

OCF core API. More...

#include "ocf_volume.h"
#include "ocf_io.h"
#include "ocf_mngt.h"

Go to the source code of this file.

Data Structures
struct	ocf_core_info

Typedefs
typedef int(*	ocf_core_visitor_t) (ocf_core_t core, void *cntx)
	Core visitor function type which is called back when iterating over cores. More...

Functions
int	ocf_core_get_by_name (ocf_cache_t cache, const char *name, size_t name_len, ocf_core_t *core)
	Get OCF core by name. More...
ocf_cache_t	ocf_core_get_cache (ocf_core_t core)
	Obtain cache object from core. More...
ocf_volume_t	ocf_core_get_volume (ocf_core_t core)
	Obtain volume associated with core. More...
ocf_volume_t	ocf_core_get_front_volume (ocf_core_t core)
	Obtain volume of the core. More...
uint32_t	ocf_core_get_seq_cutoff_threshold (ocf_core_t core)
	Get sequential cutoff threshold of given core object. More...
ocf_seq_cutoff_policy	ocf_core_get_seq_cutoff_policy (ocf_core_t core)
	Get sequential cutoff policy of given core object. More...
const char *	ocf_core_get_name (ocf_core_t core)
	Get name of given core object. More...
ocf_core_state_t	ocf_core_get_state (ocf_core_t core)
	Get core state. More...
int	ocf_core_submit_io_fast (struct ocf_io *io)
	Fast path for submitting IO. If possible, request is processed immediately without adding to internal request queue. More...
int	ocf_core_visit (ocf_cache_t cache, ocf_core_visitor_t visitor, void *cntx, bool only_opened)
	Run visitor function for each core of given cache. More...
int	ocf_core_get_info (ocf_core_t core, struct ocf_core_info *info)
	Get info of given core object. More...
void	ocf_core_set_priv (ocf_core_t core, void *priv)
	Set core private data. More...
void *	ocf_core_get_priv (ocf_core_t core)
	Get core private data. More...

Detailed Description

OCF core API.

Typedef Documentation

ocf_core_visitor_t

typedef int(* ocf_core_visitor_t) (ocf_core_t core, void *cntx)

Core visitor function type which is called back when iterating over cores.

Parameters

[in]	core	Core which is currently iterated (visited)
[in]	cntx	Visitor context

Return values

0	continue visiting cores
Non-zero	stop iterating and return result

Function Documentation

ocf_core_get_by_name()

int ocf_core_get_by_name	(	ocf_cache_t	cache,
		const char *	name,
		size_t	name_len,
		ocf_core_t *	core
	)

Get OCF core by name.

Parameters

[in]	cache	OCF cache
[in]	name	Core name
[in]	name_len	Core name length
[out]	core	OCF core handle

Return values

0	Get cache successfully
-OCF_ERR_CORE_NOT_EXIST	Core with given name doesn't exist

ocf_core_get_cache()

ocf_cache_t ocf_core_get_cache

(

ocf_core_t

core

)

Obtain cache object from core.

Parameters

[in]

core

Core object

Return values

Cache

object

ocf_core_get_front_volume()

ocf_volume_t ocf_core_get_front_volume

(

ocf_core_t

core

)

Obtain volume of the core.

Parameters

[in]

core

Core object

Return values

Front

volume

ocf_core_get_info()

int ocf_core_get_info	(	ocf_core_t	core,
		struct ocf_core_info *	info
	)

Get info of given core object.

Parameters

[in]	core	Core object
[out]	info	Core info structure

Return values

0	Success
Non-zero	Fail

ocf_core_get_name()

const char* ocf_core_get_name

(

ocf_core_t

core

)

Get name of given core object.

Parameters

[in]

core

Core object

Return values

Core

name

ocf_core_get_priv()

void* ocf_core_get_priv

(

ocf_core_t

core

)

Get core private data.

Parameters

[in]

core

Core object

Return values

Private

data

ocf_core_get_seq_cutoff_policy()

ocf_seq_cutoff_policy ocf_core_get_seq_cutoff_policy

(

ocf_core_t

core

)

Get sequential cutoff policy of given core object.

Parameters

[in]

core

Core object

Return values

Sequential

cutoff policy

ocf_core_get_seq_cutoff_threshold()

uint32_t ocf_core_get_seq_cutoff_threshold

(

ocf_core_t

core

)

Get sequential cutoff threshold of given core object.

Parameters

[in]

core

Core object

Return values

Sequential

cutoff threshold [B]

ocf_core_get_state()

ocf_core_state_t ocf_core_get_state

(

ocf_core_t

core

)

Get core state.

Parameters

[in]

core

Core object

Return values

Core

state

ocf_core_get_volume()

ocf_volume_t ocf_core_get_volume

(

ocf_core_t

core

)

Obtain volume associated with core.

Parameters

[in]

core

Core object

Return values

Volume

ocf_core_set_priv()

void ocf_core_set_priv	(	ocf_core_t	core,
		void *	priv
	)

Set core private data.

Parameters

[in]	core	Core object
[in]	priv	Private data

ocf_core_submit_io_fast()

int ocf_core_submit_io_fast

(

struct ocf_io *

io

)

Fast path for submitting IO. If possible, request is processed immediately without adding to internal request queue.

Parameters

[in]

io

IO to be submitted

Return values

0	IO has been submitted successfully
Non-zero	Fast submit failed. Try to submit IO with ocf_core_submit_io()

ocf_core_visit()

int ocf_core_visit	(	ocf_cache_t	cache,
		ocf_core_visitor_t	visitor,
		void *	cntx,
		bool	only_opened
	)

Run visitor function for each core of given cache.

Parameters

[in]	cache	OCF cache instance
[in]	visitor	Visitor function
[in]	cntx	Visitor context
[in]	only_opened	Visit only opened cores

Return values

0	Success
Non-zero	Fail