1537d1343SAlexander V. Chernikov /* SPDX-License-Identifier: BSD-3-Clause
2537d1343SAlexander V. Chernikov * Copyright(c) 2010-2019 Intel Corporation
3537d1343SAlexander V. Chernikov */
4537d1343SAlexander V. Chernikov
5537d1343SAlexander V. Chernikov #ifndef _RTE_COMMON_H_
6537d1343SAlexander V. Chernikov #define _RTE_COMMON_H_
7537d1343SAlexander V. Chernikov
8537d1343SAlexander V. Chernikov /**
9537d1343SAlexander V. Chernikov * @file
10537d1343SAlexander V. Chernikov *
11537d1343SAlexander V. Chernikov * Generic, commonly-used macro and inline function definitions
12537d1343SAlexander V. Chernikov * for DPDK.
13537d1343SAlexander V. Chernikov */
14537d1343SAlexander V. Chernikov
15537d1343SAlexander V. Chernikov #ifdef __cplusplus
16537d1343SAlexander V. Chernikov extern "C" {
17537d1343SAlexander V. Chernikov #endif
18537d1343SAlexander V. Chernikov
19537d1343SAlexander V. Chernikov //#include <rte_config.h>
20537d1343SAlexander V. Chernikov
21537d1343SAlexander V. Chernikov /* OS specific include */
22537d1343SAlexander V. Chernikov //#include <rte_os.h>
23537d1343SAlexander V. Chernikov
24537d1343SAlexander V. Chernikov #ifndef typeof
25537d1343SAlexander V. Chernikov #define typeof __typeof__
26537d1343SAlexander V. Chernikov #endif
27537d1343SAlexander V. Chernikov
28537d1343SAlexander V. Chernikov #ifndef asm
29537d1343SAlexander V. Chernikov #define asm __asm__
30537d1343SAlexander V. Chernikov #endif
31537d1343SAlexander V. Chernikov
32537d1343SAlexander V. Chernikov /** C extension macro for environments lacking C11 features. */
33537d1343SAlexander V. Chernikov #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
34537d1343SAlexander V. Chernikov #define RTE_STD_C11 __extension__
35537d1343SAlexander V. Chernikov #else
36537d1343SAlexander V. Chernikov #define RTE_STD_C11
37537d1343SAlexander V. Chernikov #endif
38537d1343SAlexander V. Chernikov
39537d1343SAlexander V. Chernikov /*
40537d1343SAlexander V. Chernikov * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
41537d1343SAlexander V. Chernikov * while a host application (like pmdinfogen) may have another compiler.
42537d1343SAlexander V. Chernikov * RTE_CC_IS_GNU is true if the file is compiled with GCC,
43537d1343SAlexander V. Chernikov * no matter it is a target or host application.
44537d1343SAlexander V. Chernikov */
45537d1343SAlexander V. Chernikov #define RTE_CC_IS_GNU 0
46537d1343SAlexander V. Chernikov #if defined __clang__
47537d1343SAlexander V. Chernikov #define RTE_CC_CLANG
48537d1343SAlexander V. Chernikov #elif defined __INTEL_COMPILER
49537d1343SAlexander V. Chernikov #define RTE_CC_ICC
50537d1343SAlexander V. Chernikov #elif defined __GNUC__
51537d1343SAlexander V. Chernikov #define RTE_CC_GCC
52537d1343SAlexander V. Chernikov #undef RTE_CC_IS_GNU
53537d1343SAlexander V. Chernikov #define RTE_CC_IS_GNU 1
54537d1343SAlexander V. Chernikov #endif
55537d1343SAlexander V. Chernikov #if RTE_CC_IS_GNU
56537d1343SAlexander V. Chernikov #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
57537d1343SAlexander V. Chernikov __GNUC_PATCHLEVEL__)
58537d1343SAlexander V. Chernikov #endif
59537d1343SAlexander V. Chernikov
60537d1343SAlexander V. Chernikov /**
61537d1343SAlexander V. Chernikov * Force alignment
62537d1343SAlexander V. Chernikov */
63537d1343SAlexander V. Chernikov #define __rte_aligned(a) __attribute__((__aligned__(a)))
64537d1343SAlexander V. Chernikov
65537d1343SAlexander V. Chernikov #ifdef RTE_ARCH_STRICT_ALIGN
66537d1343SAlexander V. Chernikov typedef uint64_t unaligned_uint64_t __rte_aligned(1);
67537d1343SAlexander V. Chernikov typedef uint32_t unaligned_uint32_t __rte_aligned(1);
68537d1343SAlexander V. Chernikov typedef uint16_t unaligned_uint16_t __rte_aligned(1);
69537d1343SAlexander V. Chernikov #else
70537d1343SAlexander V. Chernikov typedef uint64_t unaligned_uint64_t;
71537d1343SAlexander V. Chernikov typedef uint32_t unaligned_uint32_t;
72537d1343SAlexander V. Chernikov typedef uint16_t unaligned_uint16_t;
73537d1343SAlexander V. Chernikov #endif
74537d1343SAlexander V. Chernikov
75537d1343SAlexander V. Chernikov /**
76537d1343SAlexander V. Chernikov * Force a structure to be packed
77537d1343SAlexander V. Chernikov */
78537d1343SAlexander V. Chernikov #define __rte_packed __attribute__((__packed__))
79537d1343SAlexander V. Chernikov
80537d1343SAlexander V. Chernikov /******* Macro to mark functions and fields scheduled for removal *****/
81537d1343SAlexander V. Chernikov #define __rte_deprecated __attribute__((__deprecated__))
82537d1343SAlexander V. Chernikov
83537d1343SAlexander V. Chernikov /**
84537d1343SAlexander V. Chernikov * Mark a function or variable to a weak reference.
85537d1343SAlexander V. Chernikov */
86537d1343SAlexander V. Chernikov #define __rte_weak __attribute__((__weak__))
87537d1343SAlexander V. Chernikov
88537d1343SAlexander V. Chernikov /**
89537d1343SAlexander V. Chernikov * Force symbol to be generated even if it appears to be unused.
90537d1343SAlexander V. Chernikov */
91537d1343SAlexander V. Chernikov #define __rte_used __attribute__((used))
92537d1343SAlexander V. Chernikov
93537d1343SAlexander V. Chernikov /*********** Macros to eliminate unused variable warnings ********/
94537d1343SAlexander V. Chernikov
95537d1343SAlexander V. Chernikov /**
96537d1343SAlexander V. Chernikov * short definition to mark a function parameter unused
97537d1343SAlexander V. Chernikov */
98537d1343SAlexander V. Chernikov #define __rte_unused __attribute__((__unused__))
99537d1343SAlexander V. Chernikov
100537d1343SAlexander V. Chernikov /**
101537d1343SAlexander V. Chernikov * definition to mark a variable or function parameter as used so
102537d1343SAlexander V. Chernikov * as to avoid a compiler warning
103537d1343SAlexander V. Chernikov */
104537d1343SAlexander V. Chernikov #define RTE_SET_USED(x) (void)(x)
105537d1343SAlexander V. Chernikov
106537d1343SAlexander V. Chernikov /**
107537d1343SAlexander V. Chernikov * Check format string and its arguments at compile-time.
108537d1343SAlexander V. Chernikov *
109537d1343SAlexander V. Chernikov * GCC on Windows assumes MS-specific format string by default,
110537d1343SAlexander V. Chernikov * even if the underlying stdio implementation is ANSI-compliant,
111537d1343SAlexander V. Chernikov * so this must be overridden.
112537d1343SAlexander V. Chernikov */
113537d1343SAlexander V. Chernikov #if RTE_CC_IS_GNU
114537d1343SAlexander V. Chernikov #define __rte_format_printf(format_index, first_arg) \
115537d1343SAlexander V. Chernikov __attribute__((format(gnu_printf, format_index, first_arg)))
116537d1343SAlexander V. Chernikov #else
117537d1343SAlexander V. Chernikov #define __rte_format_printf(format_index, first_arg) \
118537d1343SAlexander V. Chernikov __attribute__((format(printf, format_index, first_arg)))
119537d1343SAlexander V. Chernikov #endif
120537d1343SAlexander V. Chernikov
121537d1343SAlexander V. Chernikov #define RTE_PRIORITY_LOG 101
122537d1343SAlexander V. Chernikov #define RTE_PRIORITY_BUS 110
123537d1343SAlexander V. Chernikov #define RTE_PRIORITY_CLASS 120
124537d1343SAlexander V. Chernikov #define RTE_PRIORITY_LAST 65535
125537d1343SAlexander V. Chernikov
126537d1343SAlexander V. Chernikov #define RTE_PRIO(prio) \
127537d1343SAlexander V. Chernikov RTE_PRIORITY_ ## prio
128537d1343SAlexander V. Chernikov
129537d1343SAlexander V. Chernikov /**
130537d1343SAlexander V. Chernikov * Run function before main() with high priority.
131537d1343SAlexander V. Chernikov *
132537d1343SAlexander V. Chernikov * @param func
133537d1343SAlexander V. Chernikov * Constructor function.
134537d1343SAlexander V. Chernikov * @param prio
135537d1343SAlexander V. Chernikov * Priority number must be above 100.
136537d1343SAlexander V. Chernikov * Lowest number is the first to run.
137537d1343SAlexander V. Chernikov */
138537d1343SAlexander V. Chernikov #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
139537d1343SAlexander V. Chernikov #define RTE_INIT_PRIO(func, prio) \
140537d1343SAlexander V. Chernikov static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
141537d1343SAlexander V. Chernikov #endif
142537d1343SAlexander V. Chernikov
143537d1343SAlexander V. Chernikov /**
144537d1343SAlexander V. Chernikov * Run function before main() with low priority.
145537d1343SAlexander V. Chernikov *
146537d1343SAlexander V. Chernikov * The constructor will be run after prioritized constructors.
147537d1343SAlexander V. Chernikov *
148537d1343SAlexander V. Chernikov * @param func
149537d1343SAlexander V. Chernikov * Constructor function.
150537d1343SAlexander V. Chernikov */
151537d1343SAlexander V. Chernikov #define RTE_INIT(func) \
152537d1343SAlexander V. Chernikov RTE_INIT_PRIO(func, LAST)
153537d1343SAlexander V. Chernikov
154537d1343SAlexander V. Chernikov /**
155537d1343SAlexander V. Chernikov * Run after main() with low priority.
156537d1343SAlexander V. Chernikov *
157537d1343SAlexander V. Chernikov * @param func
158537d1343SAlexander V. Chernikov * Destructor function name.
159537d1343SAlexander V. Chernikov * @param prio
160537d1343SAlexander V. Chernikov * Priority number must be above 100.
161537d1343SAlexander V. Chernikov * Lowest number is the last to run.
162537d1343SAlexander V. Chernikov */
163537d1343SAlexander V. Chernikov #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
164537d1343SAlexander V. Chernikov #define RTE_FINI_PRIO(func, prio) \
165537d1343SAlexander V. Chernikov static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
166537d1343SAlexander V. Chernikov #endif
167537d1343SAlexander V. Chernikov
168537d1343SAlexander V. Chernikov /**
169537d1343SAlexander V. Chernikov * Run after main() with high priority.
170537d1343SAlexander V. Chernikov *
171537d1343SAlexander V. Chernikov * The destructor will be run *before* prioritized destructors.
172537d1343SAlexander V. Chernikov *
173537d1343SAlexander V. Chernikov * @param func
174537d1343SAlexander V. Chernikov * Destructor function name.
175537d1343SAlexander V. Chernikov */
176537d1343SAlexander V. Chernikov #define RTE_FINI(func) \
177537d1343SAlexander V. Chernikov RTE_FINI_PRIO(func, LAST)
178537d1343SAlexander V. Chernikov
179537d1343SAlexander V. Chernikov /**
180537d1343SAlexander V. Chernikov * Hint never returning function
181537d1343SAlexander V. Chernikov */
182537d1343SAlexander V. Chernikov #define __rte_noreturn __attribute__((noreturn))
183537d1343SAlexander V. Chernikov
184537d1343SAlexander V. Chernikov /**
185537d1343SAlexander V. Chernikov * Force a function to be inlined
186537d1343SAlexander V. Chernikov */
187537d1343SAlexander V. Chernikov #define __rte_always_inline inline __attribute__((always_inline))
188537d1343SAlexander V. Chernikov
189537d1343SAlexander V. Chernikov /**
190537d1343SAlexander V. Chernikov * Force a function to be noinlined
191537d1343SAlexander V. Chernikov */
192537d1343SAlexander V. Chernikov #define __rte_noinline __attribute__((noinline))
193537d1343SAlexander V. Chernikov
194537d1343SAlexander V. Chernikov /**
195537d1343SAlexander V. Chernikov * Hint function in the hot path
196537d1343SAlexander V. Chernikov */
197537d1343SAlexander V. Chernikov #define __rte_hot __attribute__((hot))
198537d1343SAlexander V. Chernikov
199537d1343SAlexander V. Chernikov /**
200537d1343SAlexander V. Chernikov * Hint function in the cold path
201537d1343SAlexander V. Chernikov */
202537d1343SAlexander V. Chernikov #define __rte_cold __attribute__((cold))
203537d1343SAlexander V. Chernikov
204537d1343SAlexander V. Chernikov /*********** Macros for pointer arithmetic ********/
205537d1343SAlexander V. Chernikov
206537d1343SAlexander V. Chernikov /**
207537d1343SAlexander V. Chernikov * add a byte-value offset to a pointer
208537d1343SAlexander V. Chernikov */
209537d1343SAlexander V. Chernikov #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
210537d1343SAlexander V. Chernikov
211537d1343SAlexander V. Chernikov /**
212537d1343SAlexander V. Chernikov * subtract a byte-value offset from a pointer
213537d1343SAlexander V. Chernikov */
214537d1343SAlexander V. Chernikov #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
215537d1343SAlexander V. Chernikov
216537d1343SAlexander V. Chernikov /**
217537d1343SAlexander V. Chernikov * get the difference between two pointer values, i.e. how far apart
218537d1343SAlexander V. Chernikov * in bytes are the locations they point two. It is assumed that
219537d1343SAlexander V. Chernikov * ptr1 is greater than ptr2.
220537d1343SAlexander V. Chernikov */
221537d1343SAlexander V. Chernikov #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
222537d1343SAlexander V. Chernikov
223537d1343SAlexander V. Chernikov /**
224537d1343SAlexander V. Chernikov * Workaround to cast a const field of a structure to non-const type.
225537d1343SAlexander V. Chernikov */
226537d1343SAlexander V. Chernikov #define RTE_CAST_FIELD(var, field, type) \
227537d1343SAlexander V. Chernikov (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
228537d1343SAlexander V. Chernikov
229537d1343SAlexander V. Chernikov /*********** Macros/static functions for doing alignment ********/
230537d1343SAlexander V. Chernikov
231537d1343SAlexander V. Chernikov
232537d1343SAlexander V. Chernikov /**
233537d1343SAlexander V. Chernikov * Macro to align a pointer to a given power-of-two. The resultant
234537d1343SAlexander V. Chernikov * pointer will be a pointer of the same type as the first parameter, and
235537d1343SAlexander V. Chernikov * point to an address no higher than the first parameter. Second parameter
236537d1343SAlexander V. Chernikov * must be a power-of-two value.
237537d1343SAlexander V. Chernikov */
238537d1343SAlexander V. Chernikov #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
239537d1343SAlexander V. Chernikov ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
240537d1343SAlexander V. Chernikov
241537d1343SAlexander V. Chernikov /**
242537d1343SAlexander V. Chernikov * Macro to align a value to a given power-of-two. The resultant value
243537d1343SAlexander V. Chernikov * will be of the same type as the first parameter, and will be no
244537d1343SAlexander V. Chernikov * bigger than the first parameter. Second parameter must be a
245537d1343SAlexander V. Chernikov * power-of-two value.
246537d1343SAlexander V. Chernikov */
247537d1343SAlexander V. Chernikov #define RTE_ALIGN_FLOOR(val, align) \
248537d1343SAlexander V. Chernikov (typeof(val))((val) & (~((typeof(val))((align) - 1))))
249537d1343SAlexander V. Chernikov
250537d1343SAlexander V. Chernikov /**
251537d1343SAlexander V. Chernikov * Macro to align a pointer to a given power-of-two. The resultant
252537d1343SAlexander V. Chernikov * pointer will be a pointer of the same type as the first parameter, and
253537d1343SAlexander V. Chernikov * point to an address no lower than the first parameter. Second parameter
254537d1343SAlexander V. Chernikov * must be a power-of-two value.
255537d1343SAlexander V. Chernikov */
256537d1343SAlexander V. Chernikov #define RTE_PTR_ALIGN_CEIL(ptr, align) \
257537d1343SAlexander V. Chernikov RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
258537d1343SAlexander V. Chernikov
259537d1343SAlexander V. Chernikov /**
260537d1343SAlexander V. Chernikov * Macro to align a value to a given power-of-two. The resultant value
261537d1343SAlexander V. Chernikov * will be of the same type as the first parameter, and will be no lower
262537d1343SAlexander V. Chernikov * than the first parameter. Second parameter must be a power-of-two
263537d1343SAlexander V. Chernikov * value.
264537d1343SAlexander V. Chernikov */
265537d1343SAlexander V. Chernikov #define RTE_ALIGN_CEIL(val, align) \
266537d1343SAlexander V. Chernikov RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
267537d1343SAlexander V. Chernikov
268537d1343SAlexander V. Chernikov /**
269537d1343SAlexander V. Chernikov * Macro to align a pointer to a given power-of-two. The resultant
270537d1343SAlexander V. Chernikov * pointer will be a pointer of the same type as the first parameter, and
271537d1343SAlexander V. Chernikov * point to an address no lower than the first parameter. Second parameter
272537d1343SAlexander V. Chernikov * must be a power-of-two value.
273537d1343SAlexander V. Chernikov * This function is the same as RTE_PTR_ALIGN_CEIL
274537d1343SAlexander V. Chernikov */
275537d1343SAlexander V. Chernikov #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
276537d1343SAlexander V. Chernikov
277537d1343SAlexander V. Chernikov /**
278537d1343SAlexander V. Chernikov * Macro to align a value to a given power-of-two. The resultant
279537d1343SAlexander V. Chernikov * value will be of the same type as the first parameter, and
280537d1343SAlexander V. Chernikov * will be no lower than the first parameter. Second parameter
281537d1343SAlexander V. Chernikov * must be a power-of-two value.
282537d1343SAlexander V. Chernikov * This function is the same as RTE_ALIGN_CEIL
283537d1343SAlexander V. Chernikov */
284537d1343SAlexander V. Chernikov #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
285537d1343SAlexander V. Chernikov
286537d1343SAlexander V. Chernikov /**
287537d1343SAlexander V. Chernikov * Macro to align a value to the multiple of given value. The resultant
288537d1343SAlexander V. Chernikov * value will be of the same type as the first parameter and will be no lower
289537d1343SAlexander V. Chernikov * than the first parameter.
290537d1343SAlexander V. Chernikov */
291537d1343SAlexander V. Chernikov #define RTE_ALIGN_MUL_CEIL(v, mul) \
292537d1343SAlexander V. Chernikov (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
293537d1343SAlexander V. Chernikov
294537d1343SAlexander V. Chernikov /**
295537d1343SAlexander V. Chernikov * Macro to align a value to the multiple of given value. The resultant
296537d1343SAlexander V. Chernikov * value will be of the same type as the first parameter and will be no higher
297537d1343SAlexander V. Chernikov * than the first parameter.
298537d1343SAlexander V. Chernikov */
299537d1343SAlexander V. Chernikov #define RTE_ALIGN_MUL_FLOOR(v, mul) \
300537d1343SAlexander V. Chernikov ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
301537d1343SAlexander V. Chernikov
302537d1343SAlexander V. Chernikov /**
303537d1343SAlexander V. Chernikov * Macro to align value to the nearest multiple of the given value.
304537d1343SAlexander V. Chernikov * The resultant value might be greater than or less than the first parameter
305537d1343SAlexander V. Chernikov * whichever difference is the lowest.
306537d1343SAlexander V. Chernikov */
307537d1343SAlexander V. Chernikov #define RTE_ALIGN_MUL_NEAR(v, mul) \
308537d1343SAlexander V. Chernikov ({ \
309537d1343SAlexander V. Chernikov typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
310537d1343SAlexander V. Chernikov typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
311537d1343SAlexander V. Chernikov (ceil - v) > (v - floor) ? floor : ceil; \
312537d1343SAlexander V. Chernikov })
313537d1343SAlexander V. Chernikov
314537d1343SAlexander V. Chernikov /**
315537d1343SAlexander V. Chernikov * Checks if a pointer is aligned to a given power-of-two value
316537d1343SAlexander V. Chernikov *
317537d1343SAlexander V. Chernikov * @param ptr
318537d1343SAlexander V. Chernikov * The pointer whose alignment is to be checked
319537d1343SAlexander V. Chernikov * @param align
320537d1343SAlexander V. Chernikov * The power-of-two value to which the ptr should be aligned
321537d1343SAlexander V. Chernikov *
322537d1343SAlexander V. Chernikov * @return
323537d1343SAlexander V. Chernikov * True(1) where the pointer is correctly aligned, false(0) otherwise
324537d1343SAlexander V. Chernikov */
325537d1343SAlexander V. Chernikov static inline int
rte_is_aligned(void * ptr,unsigned align)326537d1343SAlexander V. Chernikov rte_is_aligned(void *ptr, unsigned align)
327537d1343SAlexander V. Chernikov {
328537d1343SAlexander V. Chernikov return RTE_PTR_ALIGN(ptr, align) == ptr;
329537d1343SAlexander V. Chernikov }
330537d1343SAlexander V. Chernikov
331537d1343SAlexander V. Chernikov /*********** Macros for compile type checks ********/
332537d1343SAlexander V. Chernikov
333537d1343SAlexander V. Chernikov /**
334537d1343SAlexander V. Chernikov * Triggers an error at compilation time if the condition is true.
335537d1343SAlexander V. Chernikov */
336537d1343SAlexander V. Chernikov #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
337537d1343SAlexander V. Chernikov
338537d1343SAlexander V. Chernikov /*********** Cache line related macros ********/
339537d1343SAlexander V. Chernikov
340537d1343SAlexander V. Chernikov /** Cache line mask. */
341537d1343SAlexander V. Chernikov #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
342537d1343SAlexander V. Chernikov
343537d1343SAlexander V. Chernikov /** Return the first cache-aligned value greater or equal to size. */
344537d1343SAlexander V. Chernikov #define RTE_CACHE_LINE_ROUNDUP(size) \
345537d1343SAlexander V. Chernikov (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
346537d1343SAlexander V. Chernikov RTE_CACHE_LINE_SIZE))
347537d1343SAlexander V. Chernikov
348537d1343SAlexander V. Chernikov /** Cache line size in terms of log2 */
349537d1343SAlexander V. Chernikov #if RTE_CACHE_LINE_SIZE == 64
350537d1343SAlexander V. Chernikov #define RTE_CACHE_LINE_SIZE_LOG2 6
351537d1343SAlexander V. Chernikov #elif RTE_CACHE_LINE_SIZE == 128
352537d1343SAlexander V. Chernikov #define RTE_CACHE_LINE_SIZE_LOG2 7
353537d1343SAlexander V. Chernikov #else
354537d1343SAlexander V. Chernikov #error "Unsupported cache line size"
355537d1343SAlexander V. Chernikov #endif
356537d1343SAlexander V. Chernikov
357537d1343SAlexander V. Chernikov /** Minimum Cache line size. */
358537d1343SAlexander V. Chernikov #define RTE_CACHE_LINE_MIN_SIZE 64
359537d1343SAlexander V. Chernikov
360537d1343SAlexander V. Chernikov /** Force alignment to cache line. */
361537d1343SAlexander V. Chernikov #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
362537d1343SAlexander V. Chernikov
363537d1343SAlexander V. Chernikov /** Force minimum cache line alignment. */
364537d1343SAlexander V. Chernikov #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
365537d1343SAlexander V. Chernikov
366537d1343SAlexander V. Chernikov /*********** PA/IOVA type definitions ********/
367537d1343SAlexander V. Chernikov
368537d1343SAlexander V. Chernikov /** Physical address */
369537d1343SAlexander V. Chernikov typedef uint64_t phys_addr_t;
370537d1343SAlexander V. Chernikov #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
371537d1343SAlexander V. Chernikov
372537d1343SAlexander V. Chernikov /**
373537d1343SAlexander V. Chernikov * IO virtual address type.
374537d1343SAlexander V. Chernikov * When the physical addressing mode (IOVA as PA) is in use,
375537d1343SAlexander V. Chernikov * the translation from an IO virtual address (IOVA) to a physical address
376537d1343SAlexander V. Chernikov * is a direct mapping, i.e. the same value.
377537d1343SAlexander V. Chernikov * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
378537d1343SAlexander V. Chernikov */
379537d1343SAlexander V. Chernikov typedef uint64_t rte_iova_t;
380537d1343SAlexander V. Chernikov #define RTE_BAD_IOVA ((rte_iova_t)-1)
381537d1343SAlexander V. Chernikov
382537d1343SAlexander V. Chernikov /*********** Structure alignment markers ********/
383537d1343SAlexander V. Chernikov
384537d1343SAlexander V. Chernikov /** Generic marker for any place in a structure. */
385537d1343SAlexander V. Chernikov __extension__ typedef void *RTE_MARKER[0];
386537d1343SAlexander V. Chernikov /** Marker for 1B alignment in a structure. */
387537d1343SAlexander V. Chernikov __extension__ typedef uint8_t RTE_MARKER8[0];
388537d1343SAlexander V. Chernikov /** Marker for 2B alignment in a structure. */
389537d1343SAlexander V. Chernikov __extension__ typedef uint16_t RTE_MARKER16[0];
390537d1343SAlexander V. Chernikov /** Marker for 4B alignment in a structure. */
391537d1343SAlexander V. Chernikov __extension__ typedef uint32_t RTE_MARKER32[0];
392537d1343SAlexander V. Chernikov /** Marker for 8B alignment in a structure. */
393537d1343SAlexander V. Chernikov __extension__ typedef uint64_t RTE_MARKER64[0];
394537d1343SAlexander V. Chernikov
395537d1343SAlexander V. Chernikov /**
396537d1343SAlexander V. Chernikov * Combines 32b inputs most significant set bits into the least
397537d1343SAlexander V. Chernikov * significant bits to construct a value with the same MSBs as x
398537d1343SAlexander V. Chernikov * but all 1's under it.
399537d1343SAlexander V. Chernikov *
400537d1343SAlexander V. Chernikov * @param x
401537d1343SAlexander V. Chernikov * The integer whose MSBs need to be combined with its LSBs
402537d1343SAlexander V. Chernikov * @return
403537d1343SAlexander V. Chernikov * The combined value.
404537d1343SAlexander V. Chernikov */
405537d1343SAlexander V. Chernikov static inline uint32_t
rte_combine32ms1b(register uint32_t x)406537d1343SAlexander V. Chernikov rte_combine32ms1b(register uint32_t x)
407537d1343SAlexander V. Chernikov {
408537d1343SAlexander V. Chernikov x |= x >> 1;
409537d1343SAlexander V. Chernikov x |= x >> 2;
410537d1343SAlexander V. Chernikov x |= x >> 4;
411537d1343SAlexander V. Chernikov x |= x >> 8;
412537d1343SAlexander V. Chernikov x |= x >> 16;
413537d1343SAlexander V. Chernikov
414537d1343SAlexander V. Chernikov return x;
415537d1343SAlexander V. Chernikov }
416537d1343SAlexander V. Chernikov
417537d1343SAlexander V. Chernikov /**
418537d1343SAlexander V. Chernikov * Combines 64b inputs most significant set bits into the least
419537d1343SAlexander V. Chernikov * significant bits to construct a value with the same MSBs as x
420537d1343SAlexander V. Chernikov * but all 1's under it.
421537d1343SAlexander V. Chernikov *
422537d1343SAlexander V. Chernikov * @param v
423537d1343SAlexander V. Chernikov * The integer whose MSBs need to be combined with its LSBs
424537d1343SAlexander V. Chernikov * @return
425537d1343SAlexander V. Chernikov * The combined value.
426537d1343SAlexander V. Chernikov */
427537d1343SAlexander V. Chernikov static inline uint64_t
rte_combine64ms1b(register uint64_t v)428537d1343SAlexander V. Chernikov rte_combine64ms1b(register uint64_t v)
429537d1343SAlexander V. Chernikov {
430537d1343SAlexander V. Chernikov v |= v >> 1;
431537d1343SAlexander V. Chernikov v |= v >> 2;
432537d1343SAlexander V. Chernikov v |= v >> 4;
433537d1343SAlexander V. Chernikov v |= v >> 8;
434537d1343SAlexander V. Chernikov v |= v >> 16;
435537d1343SAlexander V. Chernikov v |= v >> 32;
436537d1343SAlexander V. Chernikov
437537d1343SAlexander V. Chernikov return v;
438537d1343SAlexander V. Chernikov }
439537d1343SAlexander V. Chernikov
440537d1343SAlexander V. Chernikov /*********** Macros to work with powers of 2 ********/
441537d1343SAlexander V. Chernikov
442537d1343SAlexander V. Chernikov /**
443537d1343SAlexander V. Chernikov * Macro to return 1 if n is a power of 2, 0 otherwise
444537d1343SAlexander V. Chernikov */
445537d1343SAlexander V. Chernikov #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
446537d1343SAlexander V. Chernikov
447537d1343SAlexander V. Chernikov /**
448537d1343SAlexander V. Chernikov * Returns true if n is a power of 2
449537d1343SAlexander V. Chernikov * @param n
450537d1343SAlexander V. Chernikov * Number to check
451537d1343SAlexander V. Chernikov * @return 1 if true, 0 otherwise
452537d1343SAlexander V. Chernikov */
453537d1343SAlexander V. Chernikov static inline int
rte_is_power_of_2(uint32_t n)454537d1343SAlexander V. Chernikov rte_is_power_of_2(uint32_t n)
455537d1343SAlexander V. Chernikov {
456537d1343SAlexander V. Chernikov return n && !(n & (n - 1));
457537d1343SAlexander V. Chernikov }
458537d1343SAlexander V. Chernikov
459537d1343SAlexander V. Chernikov /**
460537d1343SAlexander V. Chernikov * Aligns input parameter to the next power of 2
461537d1343SAlexander V. Chernikov *
462537d1343SAlexander V. Chernikov * @param x
463537d1343SAlexander V. Chernikov * The integer value to align
464537d1343SAlexander V. Chernikov *
465537d1343SAlexander V. Chernikov * @return
466537d1343SAlexander V. Chernikov * Input parameter aligned to the next power of 2
467537d1343SAlexander V. Chernikov */
468537d1343SAlexander V. Chernikov static inline uint32_t
rte_align32pow2(uint32_t x)469537d1343SAlexander V. Chernikov rte_align32pow2(uint32_t x)
470537d1343SAlexander V. Chernikov {
471537d1343SAlexander V. Chernikov x--;
472537d1343SAlexander V. Chernikov x = rte_combine32ms1b(x);
473537d1343SAlexander V. Chernikov
474537d1343SAlexander V. Chernikov return x + 1;
475537d1343SAlexander V. Chernikov }
476537d1343SAlexander V. Chernikov
477537d1343SAlexander V. Chernikov /**
478537d1343SAlexander V. Chernikov * Aligns input parameter to the previous power of 2
479537d1343SAlexander V. Chernikov *
480537d1343SAlexander V. Chernikov * @param x
481537d1343SAlexander V. Chernikov * The integer value to align
482537d1343SAlexander V. Chernikov *
483537d1343SAlexander V. Chernikov * @return
484537d1343SAlexander V. Chernikov * Input parameter aligned to the previous power of 2
485537d1343SAlexander V. Chernikov */
486537d1343SAlexander V. Chernikov static inline uint32_t
rte_align32prevpow2(uint32_t x)487537d1343SAlexander V. Chernikov rte_align32prevpow2(uint32_t x)
488537d1343SAlexander V. Chernikov {
489537d1343SAlexander V. Chernikov x = rte_combine32ms1b(x);
490537d1343SAlexander V. Chernikov
491537d1343SAlexander V. Chernikov return x - (x >> 1);
492537d1343SAlexander V. Chernikov }
493537d1343SAlexander V. Chernikov
494537d1343SAlexander V. Chernikov /**
495537d1343SAlexander V. Chernikov * Aligns 64b input parameter to the next power of 2
496537d1343SAlexander V. Chernikov *
497537d1343SAlexander V. Chernikov * @param v
498537d1343SAlexander V. Chernikov * The 64b value to align
499537d1343SAlexander V. Chernikov *
500537d1343SAlexander V. Chernikov * @return
501537d1343SAlexander V. Chernikov * Input parameter aligned to the next power of 2
502537d1343SAlexander V. Chernikov */
503537d1343SAlexander V. Chernikov static inline uint64_t
rte_align64pow2(uint64_t v)504537d1343SAlexander V. Chernikov rte_align64pow2(uint64_t v)
505537d1343SAlexander V. Chernikov {
506537d1343SAlexander V. Chernikov v--;
507537d1343SAlexander V. Chernikov v = rte_combine64ms1b(v);
508537d1343SAlexander V. Chernikov
509537d1343SAlexander V. Chernikov return v + 1;
510537d1343SAlexander V. Chernikov }
511537d1343SAlexander V. Chernikov
512537d1343SAlexander V. Chernikov /**
513537d1343SAlexander V. Chernikov * Aligns 64b input parameter to the previous power of 2
514537d1343SAlexander V. Chernikov *
515537d1343SAlexander V. Chernikov * @param v
516537d1343SAlexander V. Chernikov * The 64b value to align
517537d1343SAlexander V. Chernikov *
518537d1343SAlexander V. Chernikov * @return
519537d1343SAlexander V. Chernikov * Input parameter aligned to the previous power of 2
520537d1343SAlexander V. Chernikov */
521537d1343SAlexander V. Chernikov static inline uint64_t
rte_align64prevpow2(uint64_t v)522537d1343SAlexander V. Chernikov rte_align64prevpow2(uint64_t v)
523537d1343SAlexander V. Chernikov {
524537d1343SAlexander V. Chernikov v = rte_combine64ms1b(v);
525537d1343SAlexander V. Chernikov
526537d1343SAlexander V. Chernikov return v - (v >> 1);
527537d1343SAlexander V. Chernikov }
528537d1343SAlexander V. Chernikov
529537d1343SAlexander V. Chernikov /*********** Macros for calculating min and max **********/
530537d1343SAlexander V. Chernikov
531537d1343SAlexander V. Chernikov /**
532537d1343SAlexander V. Chernikov * Macro to return the minimum of two numbers
533537d1343SAlexander V. Chernikov */
534537d1343SAlexander V. Chernikov #define RTE_MIN(a, b) \
535537d1343SAlexander V. Chernikov __extension__ ({ \
536537d1343SAlexander V. Chernikov typeof (a) _a = (a); \
537537d1343SAlexander V. Chernikov typeof (b) _b = (b); \
538537d1343SAlexander V. Chernikov _a < _b ? _a : _b; \
539537d1343SAlexander V. Chernikov })
540537d1343SAlexander V. Chernikov
541537d1343SAlexander V. Chernikov /**
542537d1343SAlexander V. Chernikov * Macro to return the maximum of two numbers
543537d1343SAlexander V. Chernikov */
544537d1343SAlexander V. Chernikov #define RTE_MAX(a, b) \
545537d1343SAlexander V. Chernikov __extension__ ({ \
546537d1343SAlexander V. Chernikov typeof (a) _a = (a); \
547537d1343SAlexander V. Chernikov typeof (b) _b = (b); \
548537d1343SAlexander V. Chernikov _a > _b ? _a : _b; \
549537d1343SAlexander V. Chernikov })
550537d1343SAlexander V. Chernikov
551537d1343SAlexander V. Chernikov /*********** Other general functions / macros ********/
552537d1343SAlexander V. Chernikov
553537d1343SAlexander V. Chernikov /**
554537d1343SAlexander V. Chernikov * Searches the input parameter for the least significant set bit
555537d1343SAlexander V. Chernikov * (starting from zero).
556537d1343SAlexander V. Chernikov * If a least significant 1 bit is found, its bit index is returned.
557537d1343SAlexander V. Chernikov * If the content of the input parameter is zero, then the content of the return
558537d1343SAlexander V. Chernikov * value is undefined.
559537d1343SAlexander V. Chernikov * @param v
560537d1343SAlexander V. Chernikov * input parameter, should not be zero.
561537d1343SAlexander V. Chernikov * @return
562537d1343SAlexander V. Chernikov * least significant set bit in the input parameter.
563537d1343SAlexander V. Chernikov */
564537d1343SAlexander V. Chernikov static inline uint32_t
rte_bsf32(uint32_t v)565537d1343SAlexander V. Chernikov rte_bsf32(uint32_t v)
566537d1343SAlexander V. Chernikov {
567537d1343SAlexander V. Chernikov return (uint32_t)__builtin_ctz(v);
568537d1343SAlexander V. Chernikov }
569537d1343SAlexander V. Chernikov
570537d1343SAlexander V. Chernikov /**
571537d1343SAlexander V. Chernikov * Searches the input parameter for the least significant set bit
572537d1343SAlexander V. Chernikov * (starting from zero). Safe version (checks for input parameter being zero).
573537d1343SAlexander V. Chernikov *
574537d1343SAlexander V. Chernikov * @warning ``pos`` must be a valid pointer. It is not checked!
575537d1343SAlexander V. Chernikov *
576537d1343SAlexander V. Chernikov * @param v
577537d1343SAlexander V. Chernikov * The input parameter.
578537d1343SAlexander V. Chernikov * @param pos
579537d1343SAlexander V. Chernikov * If ``v`` was not 0, this value will contain position of least significant
580537d1343SAlexander V. Chernikov * bit within the input parameter.
581537d1343SAlexander V. Chernikov * @return
582537d1343SAlexander V. Chernikov * Returns 0 if ``v`` was 0, otherwise returns 1.
583537d1343SAlexander V. Chernikov */
584537d1343SAlexander V. Chernikov static inline int
rte_bsf32_safe(uint64_t v,uint32_t * pos)585537d1343SAlexander V. Chernikov rte_bsf32_safe(uint64_t v, uint32_t *pos)
586537d1343SAlexander V. Chernikov {
587537d1343SAlexander V. Chernikov if (v == 0)
588537d1343SAlexander V. Chernikov return 0;
589537d1343SAlexander V. Chernikov
590537d1343SAlexander V. Chernikov *pos = rte_bsf32(v);
591537d1343SAlexander V. Chernikov return 1;
592537d1343SAlexander V. Chernikov }
593537d1343SAlexander V. Chernikov
594537d1343SAlexander V. Chernikov /**
595537d1343SAlexander V. Chernikov * Return the rounded-up log2 of a integer.
596537d1343SAlexander V. Chernikov *
597537d1343SAlexander V. Chernikov * @note Contrary to the logarithm mathematical operation,
598537d1343SAlexander V. Chernikov * rte_log2_u32(0) == 0 and not -inf.
599537d1343SAlexander V. Chernikov *
600537d1343SAlexander V. Chernikov * @param v
601537d1343SAlexander V. Chernikov * The input parameter.
602537d1343SAlexander V. Chernikov * @return
603537d1343SAlexander V. Chernikov * The rounded-up log2 of the input, or 0 if the input is 0.
604537d1343SAlexander V. Chernikov */
605537d1343SAlexander V. Chernikov static inline uint32_t
rte_log2_u32(uint32_t v)606537d1343SAlexander V. Chernikov rte_log2_u32(uint32_t v)
607537d1343SAlexander V. Chernikov {
608537d1343SAlexander V. Chernikov if (v == 0)
609537d1343SAlexander V. Chernikov return 0;
610537d1343SAlexander V. Chernikov v = rte_align32pow2(v);
611537d1343SAlexander V. Chernikov return rte_bsf32(v);
612537d1343SAlexander V. Chernikov }
613537d1343SAlexander V. Chernikov
614537d1343SAlexander V. Chernikov
615537d1343SAlexander V. Chernikov /**
616537d1343SAlexander V. Chernikov * Return the last (most-significant) bit set.
617537d1343SAlexander V. Chernikov *
618537d1343SAlexander V. Chernikov * @note The last (most significant) bit is at position 32.
619537d1343SAlexander V. Chernikov * @note rte_fls_u32(0) = 0, rte_fls_u32(1) = 1, rte_fls_u32(0x80000000) = 32
620537d1343SAlexander V. Chernikov *
621537d1343SAlexander V. Chernikov * @param x
622537d1343SAlexander V. Chernikov * The input parameter.
623537d1343SAlexander V. Chernikov * @return
624537d1343SAlexander V. Chernikov * The last (most-significant) bit set, or 0 if the input is 0.
625537d1343SAlexander V. Chernikov */
626537d1343SAlexander V. Chernikov static inline int
rte_fls_u32(uint32_t x)627537d1343SAlexander V. Chernikov rte_fls_u32(uint32_t x)
628537d1343SAlexander V. Chernikov {
629537d1343SAlexander V. Chernikov return (x == 0) ? 0 : 32 - __builtin_clz(x);
630537d1343SAlexander V. Chernikov }
631537d1343SAlexander V. Chernikov
632537d1343SAlexander V. Chernikov /**
633537d1343SAlexander V. Chernikov * Searches the input parameter for the least significant set bit
634537d1343SAlexander V. Chernikov * (starting from zero).
635537d1343SAlexander V. Chernikov * If a least significant 1 bit is found, its bit index is returned.
636537d1343SAlexander V. Chernikov * If the content of the input parameter is zero, then the content of the return
637537d1343SAlexander V. Chernikov * value is undefined.
638537d1343SAlexander V. Chernikov * @param v
639537d1343SAlexander V. Chernikov * input parameter, should not be zero.
640537d1343SAlexander V. Chernikov * @return
641537d1343SAlexander V. Chernikov * least significant set bit in the input parameter.
642537d1343SAlexander V. Chernikov */
643537d1343SAlexander V. Chernikov static inline int
rte_bsf64(uint64_t v)644537d1343SAlexander V. Chernikov rte_bsf64(uint64_t v)
645537d1343SAlexander V. Chernikov {
646537d1343SAlexander V. Chernikov return (uint32_t)__builtin_ctzll(v);
647537d1343SAlexander V. Chernikov }
648537d1343SAlexander V. Chernikov
649537d1343SAlexander V. Chernikov /**
650537d1343SAlexander V. Chernikov * Searches the input parameter for the least significant set bit
651537d1343SAlexander V. Chernikov * (starting from zero). Safe version (checks for input parameter being zero).
652537d1343SAlexander V. Chernikov *
653537d1343SAlexander V. Chernikov * @warning ``pos`` must be a valid pointer. It is not checked!
654537d1343SAlexander V. Chernikov *
655537d1343SAlexander V. Chernikov * @param v
656537d1343SAlexander V. Chernikov * The input parameter.
657537d1343SAlexander V. Chernikov * @param pos
658537d1343SAlexander V. Chernikov * If ``v`` was not 0, this value will contain position of least significant
659537d1343SAlexander V. Chernikov * bit within the input parameter.
660537d1343SAlexander V. Chernikov * @return
661537d1343SAlexander V. Chernikov * Returns 0 if ``v`` was 0, otherwise returns 1.
662537d1343SAlexander V. Chernikov */
663537d1343SAlexander V. Chernikov static inline int
rte_bsf64_safe(uint64_t v,uint32_t * pos)664537d1343SAlexander V. Chernikov rte_bsf64_safe(uint64_t v, uint32_t *pos)
665537d1343SAlexander V. Chernikov {
666537d1343SAlexander V. Chernikov if (v == 0)
667537d1343SAlexander V. Chernikov return 0;
668537d1343SAlexander V. Chernikov
669537d1343SAlexander V. Chernikov *pos = rte_bsf64(v);
670537d1343SAlexander V. Chernikov return 1;
671537d1343SAlexander V. Chernikov }
672537d1343SAlexander V. Chernikov
673537d1343SAlexander V. Chernikov /**
674537d1343SAlexander V. Chernikov * Return the last (most-significant) bit set.
675537d1343SAlexander V. Chernikov *
676537d1343SAlexander V. Chernikov * @note The last (most significant) bit is at position 64.
677537d1343SAlexander V. Chernikov * @note rte_fls_u64(0) = 0, rte_fls_u64(1) = 1,
678537d1343SAlexander V. Chernikov * rte_fls_u64(0x8000000000000000) = 64
679537d1343SAlexander V. Chernikov *
680537d1343SAlexander V. Chernikov * @param x
681537d1343SAlexander V. Chernikov * The input parameter.
682537d1343SAlexander V. Chernikov * @return
683537d1343SAlexander V. Chernikov * The last (most-significant) bit set, or 0 if the input is 0.
684537d1343SAlexander V. Chernikov */
685537d1343SAlexander V. Chernikov static inline int
rte_fls_u64(uint64_t x)686537d1343SAlexander V. Chernikov rte_fls_u64(uint64_t x)
687537d1343SAlexander V. Chernikov {
688537d1343SAlexander V. Chernikov return (x == 0) ? 0 : 64 - __builtin_clzll(x);
689537d1343SAlexander V. Chernikov }
690537d1343SAlexander V. Chernikov
691537d1343SAlexander V. Chernikov /**
692537d1343SAlexander V. Chernikov * Return the rounded-up log2 of a 64-bit integer.
693537d1343SAlexander V. Chernikov *
694537d1343SAlexander V. Chernikov * @note Contrary to the logarithm mathematical operation,
695537d1343SAlexander V. Chernikov * rte_log2_u64(0) == 0 and not -inf.
696537d1343SAlexander V. Chernikov *
697537d1343SAlexander V. Chernikov * @param v
698537d1343SAlexander V. Chernikov * The input parameter.
699537d1343SAlexander V. Chernikov * @return
700537d1343SAlexander V. Chernikov * The rounded-up log2 of the input, or 0 if the input is 0.
701537d1343SAlexander V. Chernikov */
702537d1343SAlexander V. Chernikov static inline uint32_t
rte_log2_u64(uint64_t v)703537d1343SAlexander V. Chernikov rte_log2_u64(uint64_t v)
704537d1343SAlexander V. Chernikov {
705537d1343SAlexander V. Chernikov if (v == 0)
706537d1343SAlexander V. Chernikov return 0;
707537d1343SAlexander V. Chernikov v = rte_align64pow2(v);
708537d1343SAlexander V. Chernikov /* we checked for v being 0 already, so no undefined behavior */
709537d1343SAlexander V. Chernikov return rte_bsf64(v);
710537d1343SAlexander V. Chernikov }
711537d1343SAlexander V. Chernikov
712537d1343SAlexander V. Chernikov #ifndef offsetof
713537d1343SAlexander V. Chernikov /** Return the offset of a field in a structure. */
714537d1343SAlexander V. Chernikov #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
715537d1343SAlexander V. Chernikov #endif
716537d1343SAlexander V. Chernikov
717537d1343SAlexander V. Chernikov /**
718537d1343SAlexander V. Chernikov * Return pointer to the wrapping struct instance.
719537d1343SAlexander V. Chernikov *
720537d1343SAlexander V. Chernikov * Example:
721537d1343SAlexander V. Chernikov *
722537d1343SAlexander V. Chernikov * struct wrapper {
723537d1343SAlexander V. Chernikov * ...
724537d1343SAlexander V. Chernikov * struct child c;
725537d1343SAlexander V. Chernikov * ...
726537d1343SAlexander V. Chernikov * };
727537d1343SAlexander V. Chernikov *
728537d1343SAlexander V. Chernikov * struct child *x = obtain(...);
729537d1343SAlexander V. Chernikov * struct wrapper *w = container_of(x, struct wrapper, c);
730537d1343SAlexander V. Chernikov */
731537d1343SAlexander V. Chernikov #ifndef container_of
732537d1343SAlexander V. Chernikov #define container_of(ptr, type, member) __extension__ ({ \
733537d1343SAlexander V. Chernikov const typeof(((type *)0)->member) *_ptr = (ptr); \
734537d1343SAlexander V. Chernikov __rte_unused type *_target_ptr = \
735537d1343SAlexander V. Chernikov (type *)(ptr); \
736537d1343SAlexander V. Chernikov (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
737537d1343SAlexander V. Chernikov })
738537d1343SAlexander V. Chernikov #endif
739537d1343SAlexander V. Chernikov
740537d1343SAlexander V. Chernikov /**
741537d1343SAlexander V. Chernikov * Get the size of a field in a structure.
742537d1343SAlexander V. Chernikov *
743537d1343SAlexander V. Chernikov * @param type
744537d1343SAlexander V. Chernikov * The type of the structure.
745537d1343SAlexander V. Chernikov * @param field
746537d1343SAlexander V. Chernikov * The field in the structure.
747537d1343SAlexander V. Chernikov * @return
748537d1343SAlexander V. Chernikov * The size of the field in the structure, in bytes.
749537d1343SAlexander V. Chernikov */
750537d1343SAlexander V. Chernikov #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
751537d1343SAlexander V. Chernikov
752537d1343SAlexander V. Chernikov #define _RTE_STR(x) #x
753537d1343SAlexander V. Chernikov /** Take a macro value and get a string version of it */
754537d1343SAlexander V. Chernikov #define RTE_STR(x) _RTE_STR(x)
755537d1343SAlexander V. Chernikov
756537d1343SAlexander V. Chernikov /**
757537d1343SAlexander V. Chernikov * ISO C helpers to modify format strings using variadic macros.
758537d1343SAlexander V. Chernikov * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
759537d1343SAlexander V. Chernikov * An empty %s argument is appended to avoid a dangling comma.
760537d1343SAlexander V. Chernikov */
761537d1343SAlexander V. Chernikov #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
762537d1343SAlexander V. Chernikov #define RTE_FMT_HEAD(fmt, ...) fmt
763537d1343SAlexander V. Chernikov #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
764537d1343SAlexander V. Chernikov
765537d1343SAlexander V. Chernikov /** Mask value of type "tp" for the first "ln" bit set. */
766537d1343SAlexander V. Chernikov #define RTE_LEN2MASK(ln, tp) \
767537d1343SAlexander V. Chernikov ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
768537d1343SAlexander V. Chernikov
769537d1343SAlexander V. Chernikov /** Number of elements in the array. */
770537d1343SAlexander V. Chernikov #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
771537d1343SAlexander V. Chernikov
772537d1343SAlexander V. Chernikov /**
773537d1343SAlexander V. Chernikov * Converts a numeric string to the equivalent uint64_t value.
774537d1343SAlexander V. Chernikov * As well as straight number conversion, also recognises the suffixes
775537d1343SAlexander V. Chernikov * k, m and g for kilobytes, megabytes and gigabytes respectively.
776537d1343SAlexander V. Chernikov *
777537d1343SAlexander V. Chernikov * If a negative number is passed in i.e. a string with the first non-black
778537d1343SAlexander V. Chernikov * character being "-", zero is returned. Zero is also returned in the case of
779537d1343SAlexander V. Chernikov * an error with the strtoull call in the function.
780537d1343SAlexander V. Chernikov *
781537d1343SAlexander V. Chernikov * @param str
782537d1343SAlexander V. Chernikov * String containing number to convert.
783537d1343SAlexander V. Chernikov * @return
784537d1343SAlexander V. Chernikov * Number.
785537d1343SAlexander V. Chernikov */
786537d1343SAlexander V. Chernikov #if 0
787537d1343SAlexander V. Chernikov static inline uint64_t
788537d1343SAlexander V. Chernikov rte_str_to_size(const char *str)
789537d1343SAlexander V. Chernikov {
790537d1343SAlexander V. Chernikov char *endptr;
791537d1343SAlexander V. Chernikov unsigned long long size;
792537d1343SAlexander V. Chernikov
793537d1343SAlexander V. Chernikov while (isspace((int)*str))
794537d1343SAlexander V. Chernikov str++;
795537d1343SAlexander V. Chernikov if (*str == '-')
796537d1343SAlexander V. Chernikov return 0;
797537d1343SAlexander V. Chernikov
798537d1343SAlexander V. Chernikov errno = 0;
799537d1343SAlexander V. Chernikov size = strtoull(str, &endptr, 0);
800537d1343SAlexander V. Chernikov if (errno)
801537d1343SAlexander V. Chernikov return 0;
802537d1343SAlexander V. Chernikov
803537d1343SAlexander V. Chernikov if (*endptr == ' ')
804537d1343SAlexander V. Chernikov endptr++; /* allow 1 space gap */
805537d1343SAlexander V. Chernikov
806537d1343SAlexander V. Chernikov switch (*endptr){
807537d1343SAlexander V. Chernikov case 'G': case 'g': size *= 1024; /* fall-through */
808537d1343SAlexander V. Chernikov case 'M': case 'm': size *= 1024; /* fall-through */
809537d1343SAlexander V. Chernikov case 'K': case 'k': size *= 1024; /* fall-through */
810537d1343SAlexander V. Chernikov default:
811537d1343SAlexander V. Chernikov break;
812537d1343SAlexander V. Chernikov }
813537d1343SAlexander V. Chernikov return size;
814537d1343SAlexander V. Chernikov }
815537d1343SAlexander V. Chernikov #endif
816537d1343SAlexander V. Chernikov
817537d1343SAlexander V. Chernikov /**
818537d1343SAlexander V. Chernikov * Function to terminate the application immediately, printing an error
819537d1343SAlexander V. Chernikov * message and returning the exit_code back to the shell.
820537d1343SAlexander V. Chernikov *
821537d1343SAlexander V. Chernikov * This function never returns
822537d1343SAlexander V. Chernikov *
823537d1343SAlexander V. Chernikov * @param exit_code
824537d1343SAlexander V. Chernikov * The exit code to be returned by the application
825537d1343SAlexander V. Chernikov * @param format
826537d1343SAlexander V. Chernikov * The format string to be used for printing the message. This can include
827537d1343SAlexander V. Chernikov * printf format characters which will be expanded using any further parameters
828537d1343SAlexander V. Chernikov * to the function.
829537d1343SAlexander V. Chernikov */
830537d1343SAlexander V. Chernikov __rte_noreturn void
831537d1343SAlexander V. Chernikov rte_exit(int exit_code, const char *format, ...)
832537d1343SAlexander V. Chernikov __rte_format_printf(2, 3);
833537d1343SAlexander V. Chernikov
834537d1343SAlexander V. Chernikov #ifdef __cplusplus
835537d1343SAlexander V. Chernikov }
836537d1343SAlexander V. Chernikov #endif
837537d1343SAlexander V. Chernikov
838537d1343SAlexander V. Chernikov #endif
839