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
|
/*-
* BSD LICENSE
*
* Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
* 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.
*/
#ifndef _EAL_PRIVATE_H_
#define _EAL_PRIVATE_H_
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
/**
* Initialize the memzone subsystem (private to eal).
*
* @return
* - 0 on success
* - Negative on error
*/
int rte_eal_memzone_init(void);
/**
* Common log initialization function (private to eal). Determines
* where log data is written when no call to rte_openlog_stream is
* in effect.
*
* @param default_log
* The default log stream to be used.
* @return
* - 0 on success
* - Negative on error
*/
void eal_log_set_default(FILE *default_log);
/**
* Fill configuration with number of physical and logical processors
*
* This function is private to EAL.
*
* Parse /proc/cpuinfo to get the number of physical and logical
* processors on the machine.
*
* @return
* 0 on success, negative on error
*/
int rte_eal_cpu_init(void);
/**
* Map memory
*
* This function is private to EAL.
*
* Fill configuration structure with these infos, and return 0 on success.
*
* @return
* 0 on success, negative on error
*/
int rte_eal_memory_init(void);
/**
* Configure timers
*
* This function is private to EAL.
*
* Mmap memory areas used by HPET (high precision event timer) that will
* provide our time reference, and configure the TSC frequency also for it
* to be used as a reference.
*
* @return
* 0 on success, negative on error
*/
int rte_eal_timer_init(void);
/**
* Init the default log stream
*
* This function is private to EAL.
*
* @return
* 0 on success, negative on error
*/
int rte_eal_log_init(const char *id, int facility);
/**
* Init tail queues for non-EAL library structures. This is to allow
* the rings, mempools, etc. lists to be shared among multiple processes
*
* This function is private to EAL
*
* @return
* 0 on success, negative on error
*/
int rte_eal_tailqs_init(void);
/**
* Init interrupt handling.
*
* This function is private to EAL.
*
* @return
* 0 on success, negative on error
*/
int rte_eal_intr_init(void);
/**
* Init alarm mechanism. This is to allow a callback be called after
* specific time.
*
* This function is private to EAL.
*
* @return
* 0 on success, negative on error
*/
int rte_eal_alarm_init(void);
/**
* Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
* etc.) loaded.
*
* @param module_name
* The module's name which need to be checked
*
* @return
* -1 means some error happens(NULL pointer or open failure)
* 0 means the module not loaded
* 1 means the module loaded
*/
int rte_eal_check_module(const char *module_name);
/**
* Get cpu core_id.
*
* This function is private to the EAL.
*/
unsigned eal_cpu_core_id(unsigned lcore_id);
/**
* Check if cpu is present.
*
* This function is private to the EAL.
*/
int eal_cpu_detected(unsigned lcore_id);
/**
* Set TSC frequency from precise value or estimation
*
* This function is private to the EAL.
*/
void set_tsc_freq(void);
/**
* Get precise TSC frequency from system
*
* This function is private to the EAL.
*/
uint64_t get_tsc_freq(void);
/**
* Get TSC frequency if the architecture supports.
*
* This function is private to the EAL.
*
* @return
* The number of TSC cycles in one second.
* Returns zero if the architecture support is not available.
*/
uint64_t get_tsc_freq_arch(void);
/**
* Prepare physical memory mapping
* i.e. hugepages on Linux and
* contigmem on BSD.
*
* This function is private to the EAL.
*/
int rte_eal_hugepage_init(void);
/**
* Creates memory mapping in secondary process
* i.e. hugepages on Linux and
* contigmem on BSD.
*
* This function is private to the EAL.
*/
int rte_eal_hugepage_attach(void);
/**
* Find a bus capable of identifying a device.
*
* @param str
* A device identifier (PCI address, virtual PMD name, ...).
*
* @return
* A valid bus handle if found.
* NULL if no bus is able to parse this device.
*/
struct rte_bus *rte_bus_find_by_device_name(const char *str);
#endif /* _EAL_PRIVATE_H_ */
|
