/usr/share/dpdk/x86_64-default-linuxapp-gcc/include/rte_eal.h is in dpdk-dev 17.11.1-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 | /*-
* BSD LICENSE
*
* Copyright(c) 2010-2016 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 _RTE_EAL_H_
#define _RTE_EAL_H_
/**
* @file
*
* EAL Configuration API
*/
#include <stdint.h>
#include <sched.h>
#include <rte_config.h>
#include <rte_per_lcore.h>
#include <rte_bus.h>
#include <rte_pci_dev_feature_defs.h>
#ifdef __cplusplus
extern "C" {
#endif
#define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
/* Maximum thread_name length. */
#define RTE_MAX_THREAD_NAME_LEN 16
/**
* The lcore role (used in RTE or not).
*/
enum rte_lcore_role_t {
ROLE_RTE,
ROLE_OFF,
ROLE_SERVICE,
};
/**
* The type of process in a linuxapp, multi-process setup
*/
enum rte_proc_type_t {
RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
RTE_PROC_SECONDARY,
RTE_PROC_INVALID
};
/**
* The global RTE configuration structure.
*/
struct rte_config {
uint32_t master_lcore; /**< Id of the master lcore */
uint32_t lcore_count; /**< Number of available logical cores. */
uint32_t service_lcore_count;/**< Number of available service cores. */
enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
/** Primary or secondary configuration */
enum rte_proc_type_t process_type;
/** PA or VA mapping mode */
enum rte_iova_mode iova_mode;
/**
* Pointer to memory configuration, which may be shared across multiple
* DPDK instances
*/
struct rte_mem_config *mem_config;
} __attribute__((__packed__));
/**
* Get the global configuration structure.
*
* @return
* A pointer to the global configuration structure.
*/
struct rte_config *rte_eal_get_configuration(void);
/**
* Get a lcore's role.
*
* @param lcore_id
* The identifier of the lcore.
* @return
* The role of the lcore.
*/
enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
/**
* Get the process type in a multi-process setup
*
* @return
* The process type
*/
enum rte_proc_type_t rte_eal_process_type(void);
/**
* Request iopl privilege for all RPL.
*
* This function should be called by pmds which need access to ioports.
* @return
* - On success, returns 0.
* - On failure, returns -1.
*/
int rte_eal_iopl_init(void);
/**
* Initialize the Environment Abstraction Layer (EAL).
*
* This function is to be executed on the MASTER lcore only, as soon
* as possible in the application's main() function.
*
* The function finishes the initialization process before main() is called.
* It puts the SLAVE lcores in the WAIT state.
*
* When the multi-partition feature is supported, depending on the
* configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
* function waits to ensure that the magic number is set before
* returning. See also the rte_eal_get_configuration() function. Note:
* This behavior may change in the future.
*
* @param argc
* A non-negative value. If it is greater than 0, the array members
* for argv[0] through argv[argc] (non-inclusive) shall contain pointers
* to strings.
* @param argv
* An array of strings. The contents of the array, as well as the strings
* which are pointed to by the array, may be modified by this function.
* @return
* - On success, the number of parsed arguments, which is greater or
* equal to zero. After the call to rte_eal_init(),
* all arguments argv[x] with x < ret may have been modified by this
* function call and should not be further interpreted by the
* application. The EAL does not take any ownership of the memory used
* for either the argv array, or its members.
* - On failure, -1 and rte_errno is set to a value indicating the cause
* for failure. In some instances, the application will need to be
* restarted as part of clearing the issue.
*
* Error codes returned via rte_errno:
* EACCES indicates a permissions issue.
*
* EAGAIN indicates either a bus or system resource was not available,
* setup may be attempted again.
*
* EALREADY indicates that the rte_eal_init function has already been
* called, and cannot be called again.
*
* EFAULT indicates the tailq configuration name was not found in
* memory configuration.
*
* EINVAL indicates invalid parameters were passed as argv/argc.
*
* ENOMEM indicates failure likely caused by an out-of-memory condition.
*
* ENODEV indicates memory setup issues.
*
* ENOTSUP indicates that the EAL cannot initialize on this system.
*
* EPROTO indicates that the PCI bus is either not present, or is not
* readable by the eal.
*
* ENOEXEC indicates that a service core failed to launch successfully.
*/
int rte_eal_init(int argc, char **argv);
/**
* Check if a primary process is currently alive
*
* This function returns true when a primary process is currently
* active.
*
* @param config_file_path
* The config_file_path argument provided should point at the location
* that the primary process will create its config file. If NULL, the default
* config file path is used.
*
* @return
* - If alive, returns 1.
* - If dead, returns 0.
*/
int rte_eal_primary_proc_alive(const char *config_file_path);
/**
* Usage function typedef used by the application usage function.
*
* Use this function typedef to define and call rte_set_application_usage_hook()
* routine.
*/
typedef void (*rte_usage_hook_t)(const char * prgname);
/**
* Add application usage routine callout from the eal_usage() routine.
*
* This function allows the application to include its usage message
* in the EAL system usage message. The routine rte_set_application_usage_hook()
* needs to be called before the rte_eal_init() routine in the application.
*
* This routine is optional for the application and will behave as if the set
* routine was never called as the default behavior.
*
* @param usage_func
* The func argument is a function pointer to the application usage routine.
* Called function is defined using rte_usage_hook_t typedef, which is of
* the form void rte_usage_func(const char * prgname).
*
* Calling this routine with a NULL value will reset the usage hook routine and
* return the current value, which could be NULL.
* @return
* - Returns the current value of the rte_application_usage pointer to allow
* the caller to daisy chain the usage routines if needing more then one.
*/
rte_usage_hook_t
rte_set_application_usage_hook(rte_usage_hook_t usage_func);
/**
* macro to get the lock of tailq in mem_config
*/
#define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock)
/**
* macro to get the multiple lock of mempool shared by mutiple-instance
*/
#define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock)
/**
* Whether EAL is using huge pages (disabled by --no-huge option).
* The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
* It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
* crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
* as 6WIND.
*
* @return
* Nonzero if hugepages are enabled.
*/
int rte_eal_has_hugepages(void);
/**
* Whether EAL is using PCI bus.
* Disabled by --no-pci option.
*
* @return
* Nonzero if the PCI bus is enabled.
*/
int rte_eal_has_pci(void);
/**
* Whether the EAL was asked to create UIO device.
*
* @return
* Nonzero if true.
*/
int rte_eal_create_uio_dev(void);
/**
* The user-configured vfio interrupt mode.
*
* @return
* Interrupt mode configured with the command line,
* RTE_INTR_MODE_NONE by default.
*/
enum rte_intr_mode rte_eal_vfio_intr_mode(void);
/**
* A wrap API for syscall gettid.
*
* @return
* On success, returns the thread ID of calling process.
* It is always successful.
*/
int rte_sys_gettid(void);
/**
* Get system unique thread id.
*
* @return
* On success, returns the thread ID of calling process.
* It is always successful.
*/
static inline int rte_gettid(void)
{
static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
if (RTE_PER_LCORE(_thread_id) == -1)
RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
return RTE_PER_LCORE(_thread_id);
}
/**
* Get the iova mode
*
* @return
* enum rte_iova_mode value.
*/
enum rte_iova_mode rte_eal_iova_mode(void);
/**
* Get default pool ops name for mbuf
*
* @return
* returns default pool ops name.
*/
const char *
rte_eal_mbuf_default_mempool_ops(void);
/**
* Set owner/permissions on sockets if requested on EAL commandline
*/
void rte_eal_set_socket_permissions(const char *);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_EAL_H_ */
|