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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
/*
* BSD LICENSE
*
* Copyright(c) 2019-2023 Intel Corporation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.O
*
*/
/**
* @brief Internal header file for resctrl schemata
*/
#ifndef __PQOS_RESCTRL_SCHEMATA_H__
#define __PQOS_RESCTRL_SCHEMATA_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "pqos.h"
#include "types.h"
/*
* @brief Structure to hold schemata
*/
struct resctrl_schemata;
/**
* @brief Allocates memory of schemata struct
*
* @param [in] cap platform QoS capabilities structure
* returned by \a pqos_cap_get
* @param [in] cpu CPU information structure from \a pqos_cap_get
*
* @return Operational status
* @retval pointer to allocated data
*/
PQOS_LOCAL struct resctrl_schemata *
resctrl_schemata_alloc(const struct pqos_cap *cap,
const struct pqos_cpuinfo *cpu);
/*
* @brief Deallocate memory of schemata struct
*
* @param[in] schemata Schemata structure
*/
PQOS_LOCAL void resctrl_schemata_free(struct resctrl_schemata *schemata);
/*
* @brief Reset schemata to default values
*
* @param [out] schemata Schemata structure
* @param [in] l3ca_cap l3 cache capability
* @param [in] l2ca_cap l2 cache capability
* @param [in] mba_cap mba capability
* @param [in] smba_cap smba capability
*
* @return Operation status
*/
PQOS_LOCAL int resctrl_schemata_reset(struct resctrl_schemata *schemata,
const struct pqos_cap_l3ca *l3ca_cap,
const struct pqos_cap_l2ca *l2ca_cap,
const struct pqos_cap_mba *mba_cap,
const struct pqos_cap_mba *smba_cap);
/*
* @brief Reads L2 class of service from schemata
*
* @param [in] schemata Schemata structure
* @param [in] resource_id unique L2 cache identifier
* @param [out] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int
resctrl_schemata_l2ca_get(const struct resctrl_schemata *schemata,
unsigned resource_id,
struct pqos_l2ca *ca);
/*
* @brief Updates L2 class of service in schemata
*
* @param [in,out] schemata Schemata structure
* @param [in] resource_id unique L2 cache identifier
* @param [in] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int resctrl_schemata_l2ca_set(struct resctrl_schemata *schemata,
unsigned resource_id,
const struct pqos_l2ca *ca);
/*
* @brief Reads L3 class of service from schemata
*
* @param [in] schemata Schemata structure
* @param [in] resource_id unique L3 cache identifier
* @param [out] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int
resctrl_schemata_l3ca_get(const struct resctrl_schemata *schemata,
unsigned resource_id,
struct pqos_l3ca *ca);
/*
* @brief Updates L3 class of service in schemata
*
* @param [in,out] schemata Schemata structure
* @param [in] resource_id unique L3 cache identifier
* @param [in] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int resctrl_schemata_l3ca_set(struct resctrl_schemata *schemata,
unsigned resource_id,
const struct pqos_l3ca *ca);
/*
* @brief Reads MBA class of service from schemata
*
* @param [in] schemata Schemata structure
* @param [in] resource_id unique L3 cache identifier
* @param [out] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int resctrl_schemata_mba_get(const struct resctrl_schemata *schemata,
unsigned resource_id,
struct pqos_mba *ca);
/*
* @brief Updates MBA class of service in schemata
*
* @param [in,out] schemata Schemata structure
* @param [in] resource_id unique L3 cache identifier
* @param [in] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int resctrl_schemata_mba_set(struct resctrl_schemata *schemata,
unsigned resource_id,
const struct pqos_mba *ca);
/*
* @brief Reads SMBA class of service from schemata
*
* @param [in] schemata Schemata structure
* @param [in] resource_id unique L3 cache identifier
* @param [out] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int
resctrl_schemata_smba_get(const struct resctrl_schemata *schemata,
unsigned resource_id,
struct pqos_mba *ca);
/*
* @brief Updates MBA class of service in schemata
*
* @param [in,out] schemata Schemata structure
* @param [in] resource_id unique L3 cache identifier
* @param [in] ca class of service definition
*
* @return Operation status
*/
PQOS_LOCAL int resctrl_schemata_smba_set(struct resctrl_schemata *schemata,
unsigned resource_id,
const struct pqos_mba *ca);
/**
* @brief Read schemata from file
*
* @param [in] fd read file descriptor
* @param [out] schemata schemata struct to store values
*
* @return Operational status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int resctrl_schemata_read(FILE *fd,
struct resctrl_schemata *schemata);
/**
* @brief Write schemata to file
*
* @param [in] fd write file descriptor
* @param [in] schemata schemata to write
*
* @return Operational status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int resctrl_schemata_write(FILE *fd,
const struct resctrl_schemata *schemata);
/**
* @brief Write l3ca schemata to file
*
* @param [in] fd write file descriptor
* @param [in] schemata schemata to write
*
* @return Operational status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int
resctrl_schemata_l3ca_write(FILE *fd, const struct resctrl_schemata *schemata);
/**
* @brief Write l2ca schemata to file
*
* @param [in] fd write file descriptor
* @param [in] schemata schemata to write
*
* @return Operational status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int
resctrl_schemata_l2ca_write(FILE *fd, const struct resctrl_schemata *schemata);
/**
* @brief Write mba schemata to file
*
* @param [in] fd write file descriptor
* @param [in] schemata schemata to write
*
* @return Operational status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int
resctrl_schemata_mba_write(FILE *fd, const struct resctrl_schemata *schemata);
/**
* @brief Write mba schemata to file
*
* @param [in] fd write file descriptor
* @param [in] schemata schemata to write
*
* @return Operational status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int
resctrl_schemata_smba_write(FILE *fd, const struct resctrl_schemata *schemata);
#ifdef __cplusplus
}
#endif
#endif /* __PQOS_RESCTRL_SCHEMATA_H__ */
|
