-
Notifications
You must be signed in to change notification settings - Fork 4
/
rte_vdpa.h
195 lines (177 loc) · 4.69 KB
/
rte_vdpa.h
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2018 Intel Corporation
*/
#ifndef _RTE_VDPA_H_
#define _RTE_VDPA_H_
#ifdef __cplusplus
extern "C" {
#endif
/**
* @file
*
* Device specific vhost lib
*/
#include <stdint.h>
/** Maximum name length for statistics counters */
#define RTE_VDPA_STATS_NAME_SIZE 64
struct rte_vdpa_device;
/**
* A vDPA device statistic structure
*
* This structure is used by rte_vdpa_stats_get() to provide
* statistics from the HW vDPA device.
*
* It maps a name id, corresponding to an index in the array returned
* by rte_vdpa_get_stats_names, to a statistic value.
*/
struct rte_vdpa_stat {
uint64_t id; /**< The index in stats name array */
uint64_t value; /**< The statistic counter value */
};
/**
* A name element for statistics
*
* An array of this structure is returned by rte_vdpa_get_stats_names
* It lists the names of extended statistics for a PMD. The rte_vdpa_stat
* structure references these names by their array index
*/
struct rte_vdpa_stat_name {
char name[RTE_VDPA_STATS_NAME_SIZE]; /**< The statistic name */
};
/**
* Find the device id of a vdpa device from its name
*
* @param name
* the vdpa device name
* @return
* vDPA device pointer on success, NULL on failure
*/
struct rte_vdpa_device *
rte_vdpa_find_device_by_name(const char *name);
/**
* Get the generic device from the vdpa device
*
* @param vdpa_dev
* the vdpa device pointer
* @return
* generic device pointer on success, NULL on failure
*/
struct rte_device *
rte_vdpa_get_rte_device(struct rte_vdpa_device *vdpa_dev);
/**
* Get number of queue pairs supported by the vDPA device
*
* @param dev
* vDP device pointer
* @param queue_num
* pointer on where the number of queue is stored
* @return
* 0 on success, -1 on failure
*/
int
rte_vdpa_get_queue_num(struct rte_vdpa_device *dev, uint32_t *queue_num);
/**
* Get the Virtio features supported by the vDPA device
*
* @param dev
* vDP device pointer
* @param features
* pointer on where the supported features are stored
* @return
* 0 on success, -1 on failure
*/
int
rte_vdpa_get_features(struct rte_vdpa_device *dev, uint64_t *features);
/**
* Get the Vhost-user protocol features supported by the vDPA device
*
* @param dev
* vDP device pointer
* @param features
* pointer on where the supported protocol features are stored
* @return
* 0 on success, -1 on failure
*/
int
rte_vdpa_get_protocol_features(struct rte_vdpa_device *dev, uint64_t *features);
/**
* Synchronize the used ring from mediated ring to guest, log dirty
* page for each writeable buffer, caller should handle the used
* ring logging before device stop.
*
* @param vid
* vhost device id
* @param qid
* vhost queue id
* @param vring_m
* mediated virtio ring pointer
* @return
* number of synced used entries on success, -1 on failure
*/
int
rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m);
/**
* Retrieve names of statistics of a vDPA device.
*
* There is an assumption that 'stat_names' and 'stats' arrays are matched
* by array index: stats_names[i].name => stats[i].value
*
* And the array index is same with id field of 'struct rte_vdpa_stat':
* stats[i].id == i
*
* @param dev
* vDPA device pointer
* @param stats_names
* array of at least size elements to be filled.
* If set to NULL, the function returns the required number of elements.
* @param size
* The number of elements in stats_names array.
* @return
* A negative value on error, otherwise the number of entries filled in the
* stats name array.
*/
int
rte_vdpa_get_stats_names(struct rte_vdpa_device *dev,
struct rte_vdpa_stat_name *stats_names,
unsigned int size);
/**
* Retrieve statistics of a vDPA device.
*
* There is an assumption that 'stat_names' and 'stats' arrays are matched
* by array index: stats_names[i].name => stats[i].value
*
* And the array index is same with id field of 'struct rte_vdpa_stat':
* stats[i].id == i
*
* @param dev
* vDPA device pointer
* @param qid
* queue id
* @param stats
* A pointer to a table of structure of type rte_vdpa_stat to be filled with
* device statistics ids and values.
* @param n
* The number of elements in stats array.
* @return
* A negative value on error, otherwise the number of entries filled in the
* stats table.
*/
int
rte_vdpa_get_stats(struct rte_vdpa_device *dev, uint16_t qid,
struct rte_vdpa_stat *stats, unsigned int n);
/**
* Reset statistics of a vDPA device.
*
* @param dev
* vDPA device pointer
* @param qid
* queue id
* @return
* 0 on success, a negative value on error.
*/
int
rte_vdpa_reset_stats(struct rte_vdpa_device *dev, uint16_t qid);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_VDPA_H_ */