DPDK 25.07.0
rte_lcore.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
3 */
4
5#ifndef _RTE_LCORE_H_
6#define _RTE_LCORE_H_
7
13#include <stdio.h>
14
15#include <rte_compat.h>
16#include <rte_config.h>
17#include <rte_per_lcore.h>
18#include <rte_eal.h>
19#include <rte_launch.h>
20#include <rte_thread.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
26#define LCORE_ID_ANY UINT32_MAX
28RTE_DECLARE_PER_LCORE(unsigned, _lcore_id);
34 ROLE_RTE,
35 ROLE_OFF,
36 ROLE_SERVICE,
37 ROLE_NON_EAL,
38};
39
48enum rte_lcore_role_t rte_eal_lcore_role(unsigned int lcore_id);
49
61int
62rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
63
77static inline unsigned
79{
80 return RTE_PER_LCORE(_lcore_id);
81}
82
89unsigned int rte_get_main_lcore(void);
90
97unsigned int rte_lcore_count(void);
98
112int rte_lcore_index(int lcore_id);
113
119unsigned int rte_socket_id(void);
120
131unsigned int
133
149int
150rte_socket_id_by_idx(unsigned int idx);
151
160unsigned int
161rte_lcore_to_socket_id(unsigned int lcore_id);
162
171int rte_lcore_to_cpu_id(int lcore_id);
172
173#ifdef RTE_HAS_CPUSET
174
183rte_cpuset_t rte_lcore_cpuset(unsigned int lcore_id);
184
185#endif /* RTE_HAS_CPUSET */
186
196int rte_lcore_is_enabled(unsigned int lcore_id);
197
211unsigned int rte_get_next_lcore(unsigned int i, int skip_main, int wrap);
212
216#define RTE_LCORE_FOREACH(i) \
217 for (i = rte_get_next_lcore(-1, 0, 0); \
218 i < RTE_MAX_LCORE; \
219 i = rte_get_next_lcore(i, 0, 0))
220
224#define RTE_LCORE_FOREACH_WORKER(i) \
225 for (i = rte_get_next_lcore(-1, 1, 0); \
226 i < RTE_MAX_LCORE; \
227 i = rte_get_next_lcore(i, 1, 0))
228
240typedef int (*rte_lcore_init_cb)(unsigned int lcore_id, void *arg);
241
250typedef void (*rte_lcore_uninit_cb)(unsigned int lcore_id, void *arg);
251
280void *
282 rte_lcore_uninit_cb uninit, void *arg);
283
294void
296
308typedef int (*rte_lcore_iterate_cb)(unsigned int lcore_id, void *arg);
309
326int
328
337 uint64_t total_cycles;
342 uint64_t busy_cycles;
343};
344
358typedef int (*rte_lcore_usage_cb)(unsigned int lcore_id, struct rte_lcore_usage *usage);
359
373
380void
382
396int
398
402void
404
405#ifdef __cplusplus
406}
407#endif
408
409
410#endif /* _RTE_LCORE_H_ */
unsigned int rte_lcore_to_socket_id(unsigned int lcore_id)
void rte_lcore_callback_unregister(void *handle)
RTE_DECLARE_PER_LCORE(unsigned, _lcore_id)
unsigned int rte_lcore_count(void)
void(* rte_lcore_uninit_cb)(unsigned int lcore_id, void *arg)
Definition: rte_lcore.h:250
int rte_lcore_index(int lcore_id)
int(* rte_lcore_usage_cb)(unsigned int lcore_id, struct rte_lcore_usage *usage)
Definition: rte_lcore.h:358
rte_lcore_role_t
Definition: rte_lcore.h:33
void rte_lcore_register_usage_cb(rte_lcore_usage_cb cb)
int rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role)
int rte_lcore_is_enabled(unsigned int lcore_id)
unsigned int rte_get_main_lcore(void)
int rte_socket_id_by_idx(unsigned int idx)
void rte_lcore_dump(FILE *f)
int rte_thread_register(void)
unsigned int rte_socket_id(void)
rte_cpuset_t rte_lcore_cpuset(unsigned int lcore_id)
void * rte_lcore_callback_register(const char *name, rte_lcore_init_cb init, rte_lcore_uninit_cb uninit, void *arg)
enum rte_lcore_role_t rte_eal_lcore_role(unsigned int lcore_id)
int rte_lcore_iterate(rte_lcore_iterate_cb cb, void *arg)
int(* rte_lcore_iterate_cb)(unsigned int lcore_id, void *arg)
Definition: rte_lcore.h:308
int(* rte_lcore_init_cb)(unsigned int lcore_id, void *arg)
Definition: rte_lcore.h:240
unsigned int rte_get_next_lcore(unsigned int i, int skip_main, int wrap)
int rte_lcore_to_cpu_id(int lcore_id)
void rte_thread_unregister(void)
unsigned int rte_socket_count(void)
static unsigned rte_lcore_id(void)
Definition: rte_lcore.h:78
#define RTE_PER_LCORE(name)
Definition: rte_per_lcore.h:46
uint64_t busy_cycles
Definition: rte_lcore.h:342
uint64_t total_cycles
Definition: rte_lcore.h:337