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
|
/*
* BSD LICENSE
*
* Copyright(c) 2017-2026 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.
*
*/
/**
* @brief Internal header file to PQoS utils initialization
*/
#ifndef __PQOS_UTILS_H__
#define __PQOS_UTILS_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "pqos.h"
#include "types.h"
/**
* @brief Initializes utils module
*
* @param interface option, MSR or OS
*
* @return Operational status
* @retval PQOS_RETVAL_OK success
*/
PQOS_LOCAL int _pqos_utils_init(int interface);
/**
* @brief Retrieves L3 MON I/O RDT status
*
* @param [in] cap platform QoS capabilities structure
* returned by \a pqos_cap_get
* @param [out] supported place to store I/O RDT monitoring support status
* @param [out] enabled place to store I/O RDT monitoring enable status
*
* @return Operation status
* @retval PQOS_RETVAL_OK on success
*/
int pqos_mon_iordt_enabled(const struct pqos_cap *cap,
int *supported,
int *enabled);
/**
* @brief Retrieves channel information from dev info structure
*
* @param [in] dev Device information structure
* @param [in] channel_id channel id
*
* @return Channel information structure
* @retval NULL on error
*/
const struct pqos_channel *
pqos_devinfo_get_channel(const struct pqos_devinfo *dev,
const pqos_channel_t channel_id);
/**
* @brief Checks if channel is shared between multiple devices
*
* @param [in] dev Device information structure
* @param [in] channel_id channel id
* @param [out] shared 1 if channel is shared
*
* @return Operation status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int pqos_devinfo_get_channel_shared(const struct pqos_devinfo *dev,
const pqos_channel_t channel_id,
int *shared);
/**
* @brief Internal API to retrieve \a type of capability
*
* @param [in] type capability type to look for
*
* @return Pointer to selected capability
*/
PQOS_LOCAL const struct pqos_capability *
_pqos_cap_get_type(const enum pqos_cap_type type);
/**
* @brief Returns CPU agent information for a given domain
*
* @param [in] domain_id domain to extract CPU agent information for
*
* @return CPU agent information for a given domain or NULL if not found
*/
PQOS_LOCAL const struct pqos_cpu_agent_info *
get_cpu_agent_by_domain(uint16_t domain_id);
/**
* @brief Returns DEV agent information for a given domain
*
* @param [in] domain_id domain to extract DEV agent information for
*
* @return DEV agent information for a given domain or NULL if not found
*/
PQOS_LOCAL const struct pqos_device_agent_info *
get_dev_agent_by_domain(uint16_t domain_id);
/**
* @brief Retrieves Domain ID of given PCI device
*
* @param [in] devinfo Device information structure
* @param [in] segment PCI device's segment
* @param [in] bdf PCI devices's bus,device and function information
* @param [out] domain_id domain id of given PCI device
*
* @return Operation status
* @retval PQOS_RETVAL_OK on success
*/
PQOS_LOCAL int pqos_devinfo_get_domain_id(const struct pqos_devinfo *devinfo,
const uint16_t segment,
const uint16_t bdf,
uint16_t *domain_id);
#ifdef __cplusplus
}
#endif
#endif /* __PQOS_UTULS_H__ */
|
