blob: 3d795cd4ecdd5a1b2bc188fab50fd26c9ca2e694 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
* Copyright(c) 2012-2018 Intel Corporation
* SPDX-License-Identifier: BSD-3-Clause-Clear
*/
#ifndef OCF_QUEUE_H_
#define OCF_QUEUE_H_
/**
* @file
* @brief OCF queues API
*/
/**
* @brief I/O queue operations
*/
struct ocf_queue_ops {
/**
* @brief Kick I/O queue processing
*
* This function should inform worker, thread or any other queue
* processing mechanism, that there are new requests in queue to
* be processed. Processing requests synchronously in this function
* is not allowed.
*
* @param[in] q I/O queue to be kicked
*/
void (*kick)(ocf_queue_t q);
/**
* @brief Kick I/O queue processing
*
* This function should inform worker, thread or any other queue
* processing mechanism, that there are new requests in queue to
* be processed. Function kick_sync is allowed to process requests
* synchronously without delegating them to the worker.
*
* @param[in] q I/O queue to be kicked
*/
void (*kick_sync)(ocf_queue_t q);
/**
* @brief Stop I/O queue
*
* @param[in] q I/O queue beeing stopped
*/
void (*stop)(ocf_queue_t q);
};
/**
* @brief Allocate IO queue and add it to list in cache
*
* @param[in] cache Handle to cache instance
* @param[out] queue Handle to created queue
* @param[in] ops Queue operations
*
* @return Zero on success, otherwise error code
*/
int ocf_queue_create(ocf_cache_t cache, ocf_queue_t *queue,
const struct ocf_queue_ops *ops);
/**
* @brief Increase reference counter in queue
*
* @param[in] queue Queue
*
*/
void ocf_queue_get(ocf_queue_t queue);
/**
* @brief Decrease reference counter in queue
*
* @note If queue don't have any reference - deallocate it
*
* @param[in] queue Queue
*
*/
void ocf_queue_put(ocf_queue_t queue);
/**
* @brief Process single request from queue
*
* @param[in] q Queue to run
*/
void ocf_queue_run_single(ocf_queue_t q);
/**
* @brief Run queue processing
*
* @param[in] q Queue to run
*/
void ocf_queue_run(ocf_queue_t q);
/**
* @brief Set queue private data
*
* @param[in] q I/O queue
* @param[in] priv Private data
*/
void ocf_queue_set_priv(ocf_queue_t q, void *priv);
/**
* @brief Get queue private data
*
* @param[in] q I/O queue
*
* @retval I/O queue private data
*/
void *ocf_queue_get_priv(ocf_queue_t q);
/**
* @brief Get number of pending requests in I/O queue
*
* @param[in] q I/O queue
*
* @retval Number of pending requests in I/O queue
*/
uint32_t ocf_queue_pending_io(ocf_queue_t q);
/**
* @brief Get cache instance to which I/O queue belongs
*
* @param[in] q I/O queue
*
* @retval Cache instance
*/
ocf_cache_t ocf_queue_get_cache(ocf_queue_t q);
#endif
|
