Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
gcc.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010-2014,2017 Wind River Systems, Inc.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_TOOLCHAIN_GCC_H_
8#define ZEPHYR_INCLUDE_TOOLCHAIN_GCC_H_
9
10#ifndef ZEPHYR_INCLUDE_TOOLCHAIN_H_
11#error Please do not include toolchain-specific headers directly, use <zephyr/toolchain.h> instead
12#endif
13
21#define TOOLCHAIN_GCC_VERSION \
22 ((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__)
23
24/* GCC supports #pragma diagnostics since 4.6.0 */
25#if !defined(TOOLCHAIN_HAS_PRAGMA_DIAG) && (TOOLCHAIN_GCC_VERSION >= 40600)
26#define TOOLCHAIN_HAS_PRAGMA_DIAG 1
27#endif
28
29#if !defined(TOOLCHAIN_HAS_C_GENERIC) && (TOOLCHAIN_GCC_VERSION >= 40900)
30#define TOOLCHAIN_HAS_C_GENERIC 1
31#endif
32
33#if !defined(TOOLCHAIN_HAS_C_AUTO_TYPE) && (TOOLCHAIN_GCC_VERSION >= 40900)
34#define TOOLCHAIN_HAS_C_AUTO_TYPE 1
35#endif
36
37#define TOOLCHAIN_HAS_ZLA 1
38
39/*
40 * Older versions of GCC do not define __BYTE_ORDER__, so it must be manually
41 * detected and defined using arch-specific definitions.
42 */
43
44#ifndef _LINKER
45
46#ifndef __ORDER_BIG_ENDIAN__
47#define __ORDER_BIG_ENDIAN__ (1)
48#endif
49
50#ifndef __ORDER_LITTLE_ENDIAN__
51#define __ORDER_LITTLE_ENDIAN__ (2)
52#endif
53
54#ifndef __BYTE_ORDER__
55#if defined(__BIG_ENDIAN__) || defined(__ARMEB__) || \
56 defined(__THUMBEB__) || defined(__AARCH64EB__) || \
57 defined(__MIPSEB__) || defined(__TC32EB__)
58
59#define __BYTE_ORDER__ __ORDER_BIG_ENDIAN__
60
61#elif defined(__LITTLE_ENDIAN__) || defined(__ARMEL__) || \
62 defined(__THUMBEL__) || defined(__AARCH64EL__) || \
63 defined(__MIPSEL__) || defined(__TC32EL__)
64
65#define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__
66
67#else
68#error "__BYTE_ORDER__ is not defined and cannot be automatically resolved"
69#endif
70#endif
71
72
73#undef BUILD_ASSERT /* clear out common version */
74/* C++11 has static_assert built in */
75#if defined(__cplusplus) && (__cplusplus >= 201103L)
76#define BUILD_ASSERT(EXPR, MSG...) static_assert(EXPR, "" MSG)
77
78/*
79 * GCC 4.6 and higher have the C11 _Static_assert built in and its
80 * output is easier to understand than the common BUILD_ASSERT macros.
81 * Don't use this in C++98 mode though (which we can hit, as
82 * static_assert() is not available)
83 */
84#elif !defined(__cplusplus) && \
85 (((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 6))) || \
86 (__STDC_VERSION__) >= 201100)
87#define BUILD_ASSERT(EXPR, MSG...) _Static_assert((EXPR), "" MSG)
88#else
89#define BUILD_ASSERT(EXPR, MSG...)
90#endif
91
92#ifdef __cplusplus
93#define ZRESTRICT __restrict
94#else
95#define ZRESTRICT restrict
96#endif
97
99#include <stdbool.h>
100
101#define ALIAS_OF(of) __attribute__((alias(#of)))
102
103#define FUNC_ALIAS(real_func, new_alias, return_type) \
104 return_type new_alias() ALIAS_OF(real_func)
105
106#if defined(CONFIG_ARCH_POSIX) && !defined(_ASMLANGUAGE)
108
109/*let's not segfault if this were to happen for some reason*/
110#define CODE_UNREACHABLE \
111{\
112 posix_print_error_and_exit("CODE_UNREACHABLE reached from %s:%d\n",\
113 __FILE__, __LINE__);\
114 __builtin_unreachable(); \
115}
116#else
117#define CODE_UNREACHABLE __builtin_unreachable()
118#endif
119#define FUNC_NORETURN __attribute__((__noreturn__))
120
121/* The GNU assembler for Cortex-M3 uses # for immediate values, not
122 * comments, so the @nobits# trick does not work.
123 */
124#if defined(CONFIG_ARM) || defined(CONFIG_ARM64)
125#define _NODATA_SECTION(segment) __attribute__((section(#segment)))
126#else
127#define _NODATA_SECTION(segment) \
128 __attribute__((section(#segment ",\"wa\",@nobits#")))
129#endif
130
131/* Unaligned access */
132#define UNALIGNED_GET(g) \
133__extension__ ({ \
134 struct __attribute__((__packed__)) { \
135 __typeof__(*(g)) __v; \
136 } *__g = (__typeof__(__g)) (g); \
137 __g->__v; \
138})
139
140
141#if (__GNUC__ >= 7) && (defined(CONFIG_ARM) || defined(CONFIG_ARM64))
142
143/* Version of UNALIGNED_PUT() which issues a compiler_barrier() after
144 * the store. It is required to workaround an apparent optimization
145 * bug in GCC for ARM Cortex-M3 and higher targets, when multiple
146 * byte, half-word and word stores (strb, strh, str instructions),
147 * which support unaligned access, can be coalesced into store double
148 * (strd) instruction, which doesn't support unaligned access (the
149 * compilers in question do this optimization ignoring __packed__
150 * attribute).
151 */
152#define UNALIGNED_PUT(v, p) \
153do { \
154 struct __attribute__((__packed__)) { \
155 __typeof__(*p) __v; \
156 } *__p = (__typeof__(__p)) (p); \
157 __p->__v = (v); \
158 compiler_barrier(); \
159} while (false)
160
161#else
162
163#define UNALIGNED_PUT(v, p) \
164do { \
165 struct __attribute__((__packed__)) { \
166 __typeof__(*p) __v; \
167 } *__p = (__typeof__(__p)) (p); \
168 __p->__v = (v); \
169} while (false)
170
171#endif
172
173/* Double indirection to ensure section names are expanded before
174 * stringification
175 */
176#define __GENERIC_SECTION(segment) __attribute__((section(STRINGIFY(segment))))
177#define Z_GENERIC_SECTION(segment) __GENERIC_SECTION(segment)
178
179#define __GENERIC_DOT_SECTION(segment) \
180 __attribute__((section("." STRINGIFY(segment))))
181#define Z_GENERIC_DOT_SECTION(segment) __GENERIC_DOT_SECTION(segment)
182
183#define ___in_section(a, b, c) \
184 __attribute__((section("." Z_STRINGIFY(a) \
185 "." Z_STRINGIFY(b) \
186 "." Z_STRINGIFY(c))))
187#define __in_section(a, b, c) ___in_section(a, b, c)
188
189#define __in_section_unique(seg) ___in_section(seg, __FILE__, __COUNTER__)
190
191#define __in_section_unique_named(seg, name) \
192 ___in_section(seg, __FILE__, name)
193
194/* When using XIP, using '__ramfunc' places a function into RAM instead
195 * of FLASH. Make sure '__ramfunc' is defined only when
196 * CONFIG_ARCH_HAS_RAMFUNC_SUPPORT is defined, so that the compiler can
197 * report an error if '__ramfunc' is used but the architecture does not
198 * support it.
199 */
200#if !defined(CONFIG_XIP)
201#define __ramfunc
202#elif defined(CONFIG_ARCH_HAS_RAMFUNC_SUPPORT)
203#if defined(CONFIG_ARM)
204#define __ramfunc __attribute__((noinline)) \
205 __attribute__((long_call, section(".ramfunc")))
206#else
207#define __ramfunc __attribute__((noinline)) \
208 __attribute__((section(".ramfunc")))
209#endif
210#endif /* !CONFIG_XIP */
211
212#ifndef __fallthrough
213#if __GNUC__ >= 7
214#define __fallthrough __attribute__((fallthrough))
215#else
216#define __fallthrough
217#endif /* __GNUC__ >= 7 */
218#endif
219
220#ifndef __packed
221#define __packed __attribute__((__packed__))
222#endif
223
224#ifndef __aligned
225#define __aligned(x) __attribute__((__aligned__(x)))
226#endif
227
228#define __may_alias __attribute__((__may_alias__))
229
230#ifndef __printf_like
231#ifdef CONFIG_ENFORCE_ZEPHYR_STDINT
232#define __printf_like(f, a) __attribute__((format (printf, f, a)))
233#else
234/*
235 * The Zephyr stdint convention enforces int32_t = int, int64_t = long long,
236 * and intptr_t = long so that short string format length modifiers can be
237 * used universally across ILP32 and LP64 architectures. Without that it
238 * is possible for ILP32 toolchains to have int32_t = long and intptr_t = int
239 * clashing with the Zephyr convention and generating pointless warnings
240 * as they're still the same size. Inhibit the format argument type
241 * validation in that case and let the other configs do it.
242 */
243#define __printf_like(f, a)
244#endif
245#endif
246
247#define __used __attribute__((__used__))
248#define __unused __attribute__((__unused__))
249#define __maybe_unused __attribute__((__unused__))
250
251#ifndef __deprecated
252#define __deprecated __attribute__((deprecated))
253/* When adding this, remember to follow the instructions in
254 * https://docs.zephyrproject.org/latest/develop/api/api_lifecycle.html#deprecated
255 */
256#endif
257
258#ifndef __attribute_const__
259#define __attribute_const__ __attribute__((__const__))
260#endif
261
262#ifndef __must_check
263#define __must_check __attribute__((warn_unused_result))
264#endif
265
266#define ARG_UNUSED(x) (void)(x)
267
268#define likely(x) (__builtin_expect((bool)!!(x), true) != 0L)
269#define unlikely(x) (__builtin_expect((bool)!!(x), false) != 0L)
270#define POPCOUNT(x) __builtin_popcount(x)
271
272#ifndef __no_optimization
273#define __no_optimization __attribute__((optimize("-O0")))
274#endif
275
276#ifndef __weak
277#define __weak __attribute__((__weak__))
278#endif
279
280#ifndef __attribute_nonnull
281#define __attribute_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
282#endif
283
284/* Builtins with availability that depend on the compiler version. */
285#if __GNUC__ >= 5
286#define HAS_BUILTIN___builtin_add_overflow 1
287#define HAS_BUILTIN___builtin_sub_overflow 1
288#define HAS_BUILTIN___builtin_mul_overflow 1
289#define HAS_BUILTIN___builtin_div_overflow 1
290#endif
291#if __GNUC__ >= 4
292#define HAS_BUILTIN___builtin_clz 1
293#define HAS_BUILTIN___builtin_clzl 1
294#define HAS_BUILTIN___builtin_clzll 1
295#define HAS_BUILTIN___builtin_ctz 1
296#define HAS_BUILTIN___builtin_ctzl 1
297#define HAS_BUILTIN___builtin_ctzll 1
298#endif
299
300/*
301 * Be *very* careful with these. You cannot filter out __DEPRECATED_MACRO with
302 * -wno-deprecated, which has implications for -Werror.
303 */
304
305/*
306 * Expands to nothing and generates a warning. Used like
307 *
308 * #define FOO __WARN("Please use BAR instead") ...
309 *
310 * The warning points to the location where the macro is expanded.
311 */
312#define __WARN(msg) __WARN1(GCC warning msg)
313#define __WARN1(s) _Pragma(#s)
314
315/* Generic message */
316#ifndef __DEPRECATED_MACRO
317#define __DEPRECATED_MACRO __WARN("Macro is deprecated")
318/* When adding this, remember to follow the instructions in
319 * https://docs.zephyrproject.org/latest/develop/api/api_lifecycle.html#deprecated
320 */
321#endif
322
323/* These macros allow having ARM asm functions callable from thumb */
324
325#if defined(_ASMLANGUAGE)
326
327#if defined(CONFIG_ARM)
328
329#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
330
331#define FUNC_CODE() .thumb;
332#define FUNC_INSTR(a)
333
334#else
335
336#define FUNC_CODE() .code 32;
337#define FUNC_INSTR(a)
338
339#endif /* CONFIG_ASSEMBLER_ISA_THUMB2 */
340
341#else
342
343#define FUNC_CODE()
344#define FUNC_INSTR(a)
345
346#endif /* CONFIG_ARM */
347
348#endif /* _ASMLANGUAGE */
349
350/*
351 * These macros are used to declare assembly language symbols that need
352 * to be typed properly(func or data) to be visible to the OMF tool.
353 * So that the build tool could mark them as an entry point to be linked
354 * correctly. This is an elfism. Use #if 0 for a.out.
355 */
356
357#if defined(_ASMLANGUAGE)
358
359#if defined(CONFIG_ARM) || defined(CONFIG_NIOS2) || defined(CONFIG_RISCV) \
360 || defined(CONFIG_XTENSA) || defined(CONFIG_ARM64) \
361 || defined(CONFIG_MIPS)
362#define GTEXT(sym) .global sym; .type sym, %function
363#define GDATA(sym) .global sym; .type sym, %object
364#define WTEXT(sym) .weak sym; .type sym, %function
365#define WDATA(sym) .weak sym; .type sym, %object
366#elif defined(CONFIG_ARC)
367/*
368 * Need to use assembly macros because ';' is interpreted as the start of
369 * a single line comment in the ARC assembler.
370 */
371
372.macro glbl_text symbol
373 .globl \symbol
374 .type \symbol, %function
375.endm
376
377.macro glbl_data symbol
378 .globl \symbol
379 .type \symbol, %object
380.endm
381
382.macro weak_data symbol
383 .weak \symbol
384 .type \symbol, %object
385.endm
386
387#define GTEXT(sym) glbl_text sym
388#define GDATA(sym) glbl_data sym
389#define WDATA(sym) weak_data sym
390
391#else /* !CONFIG_ARM && !CONFIG_ARC */
392#define GTEXT(sym) .globl sym; .type sym, @function
393#define GDATA(sym) .globl sym; .type sym, @object
394#endif
395
396/*
397 * These macros specify the section in which a given function or variable
398 * resides.
399 *
400 * - SECTION_FUNC allows only one function to reside in a sub-section
401 * - SECTION_SUBSEC_FUNC allows multiple functions to reside in a sub-section
402 * This ensures that garbage collection only discards the section
403 * if all functions in the sub-section are not referenced.
404 */
405
406#if defined(CONFIG_ARC)
407/*
408 * Need to use assembly macros because ';' is interpreted as the start of
409 * a single line comment in the ARC assembler.
410 *
411 * Also, '\‍()' is needed in the .section directive of these macros for
412 * correct substitution of the 'section' variable.
413 */
414
415.macro section_var section, symbol
416 .section .\section\‍().\symbol
417 \symbol :
418.endm
419
420.macro section_func section, symbol
421 .section .\section\().\symbol, "ax"
422 FUNC_CODE()
423 PERFOPT_ALIGN
424 \symbol :
425 FUNC_INSTR(\symbol)
426.endm
427
428.macro section_subsec_func section, subsection, symbol
429 .section .\section\().\subsection, "ax"
430 PERFOPT_ALIGN
431 \symbol :
432.endm
433
434#define SECTION_VAR(sect, sym) section_var sect, sym
435#define SECTION_FUNC(sect, sym) section_func sect, sym
436#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
437 section_subsec_func sect, subsec, sym
438#else /* !CONFIG_ARC */
439
440#define SECTION_VAR(sect, sym) .section .sect.sym; sym:
441#define SECTION_FUNC(sect, sym) \
442 .section .sect.sym, "ax"; \
443 FUNC_CODE() \
444 PERFOPT_ALIGN; sym : \
445 FUNC_INSTR(sym)
446#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
447 .section .sect.subsec, "ax"; PERFOPT_ALIGN; sym :
448
449#endif /* CONFIG_ARC */
450
451#endif /* _ASMLANGUAGE */
452
453#if defined(_ASMLANGUAGE)
454#if defined(CONFIG_ARM)
455#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
456/* '.syntax unified' is a gcc-ism used in thumb-2 asm files */
457#define _ASM_FILE_PROLOGUE .text; .syntax unified; .thumb
458#else
459#define _ASM_FILE_PROLOGUE .text; .code 32
460#endif /* CONFIG_ASSEMBLER_ISA_THUMB2 */
461#elif defined(CONFIG_ARM64)
462#define _ASM_FILE_PROLOGUE .text
463#endif /* CONFIG_ARM64 || CONFIG_ARM */
464#endif /* _ASMLANGUAGE */
465
466/*
467 * These macros generate absolute symbols for GCC
468 */
469
470/* create an extern reference to the absolute symbol */
471
472#define GEN_OFFSET_EXTERN(name) extern const char name[]
473
474#define GEN_ABS_SYM_BEGIN(name) \
475 EXTERN_C void name(void); \
476 void name(void) \
477 {
478
479#define GEN_ABS_SYM_END }
480
481/*
482 * Note that GEN_ABSOLUTE_SYM(), depending on the architecture
483 * and toolchain, may restrict the range of values permitted
484 * for assignment to the named symbol.
485 *
486 * For example, on x86, "value" is interpreted as signed
487 * 32-bit integer. Passing in an unsigned 32-bit integer
488 * with MSB set would result in a negative integer.
489 * Moreover, GCC would error out if an integer larger
490 * than 2^32-1 is passed as "value".
491 */
492
493/*
494 * GEN_ABSOLUTE_SYM_KCONFIG() is outputted by the build system
495 * to generate named symbol/value pairs for kconfigs.
496 */
497
498#if defined(CONFIG_ARM)
499
500/*
501 * GNU/ARM backend does not have a proper operand modifier which does not
502 * produces prefix # followed by value, such as %0 for PowerPC, Intel, and
503 * MIPS. The workaround performed here is using %B0 which converts
504 * the value to ~(value). Thus "n"(~(value)) is set in operand constraint
505 * to output (value) in the ARM specific GEN_OFFSET macro.
506 */
507
508#define GEN_ABSOLUTE_SYM(name, value) \
509 __asm__(".globl\t" #name "\n\t.equ\t" #name \
510 ",%B0" \
511 "\n\t.type\t" #name ",%%object" : : "n"(~(value)))
512
513#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
514 __asm__(".globl\t" #name \
515 "\n\t.equ\t" #name "," #value \
516 "\n\t.type\t" #name ",%object")
517
518#elif defined(CONFIG_X86)
519
520#define GEN_ABSOLUTE_SYM(name, value) \
521 __asm__(".globl\t" #name "\n\t.equ\t" #name \
522 ",%c0" \
523 "\n\t.type\t" #name ",@object" : : "n"(value))
524
525#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
526 __asm__(".globl\t" #name \
527 "\n\t.equ\t" #name "," #value \
528 "\n\t.type\t" #name ",@object")
529
530#elif defined(CONFIG_ARC) || defined(CONFIG_ARM64)
531
532#define GEN_ABSOLUTE_SYM(name, value) \
533 __asm__(".globl\t" #name "\n\t.equ\t" #name \
534 ",%c0" \
535 "\n\t.type\t" #name ",@object" : : "n"(value))
536
537#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
538 __asm__(".globl\t" #name \
539 "\n\t.equ\t" #name "," #value \
540 "\n\t.type\t" #name ",@object")
541
542#elif defined(CONFIG_NIOS2) || defined(CONFIG_RISCV) || \
543 defined(CONFIG_XTENSA) || defined(CONFIG_MIPS)
544
545/* No special prefixes necessary for constants in this arch AFAICT */
546#define GEN_ABSOLUTE_SYM(name, value) \
547 __asm__(".globl\t" #name "\n\t.equ\t" #name \
548 ",%0" \
549 "\n\t.type\t" #name ",%%object" : : "n"(value))
550
551#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
552 __asm__(".globl\t" #name \
553 "\n\t.equ\t" #name "," #value \
554 "\n\t.type\t" #name ",%object")
555
556#elif defined(CONFIG_ARCH_POSIX)
557#define GEN_ABSOLUTE_SYM(name, value) \
558 __asm__(".globl\t" #name "\n\t.equ\t" #name \
559 ",%c0" \
560 "\n\t.type\t" #name ",@object" : : "n"(value))
561
562#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
563 __asm__(".globl\t" #name \
564 "\n\t.equ\t" #name "," #value \
565 "\n\t.type\t" #name ",@object")
566
567#elif defined(CONFIG_SPARC)
568#define GEN_ABSOLUTE_SYM(name, value) \
569 __asm__(".global\t" #name "\n\t.equ\t" #name \
570 ",%0" \
571 "\n\t.type\t" #name ",#object" : : "n"(value))
572
573#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
574 __asm__(".globl\t" #name \
575 "\n\t.equ\t" #name "," #value \
576 "\n\t.type\t" #name ",#object")
577
578#else
579#error processor architecture not supported
580#endif
581
582#define compiler_barrier() do { \
583 __asm__ __volatile__ ("" ::: "memory"); \
584} while (false)
585
595#define Z_MAX(a, b) ({ \
596 /* random suffix to avoid naming conflict */ \
597 __typeof__(a) _value_a_ = (a); \
598 __typeof__(b) _value_b_ = (b); \
599 (_value_a_ > _value_b_) ? _value_a_ : _value_b_; \
600 })
601
607#define Z_MIN(a, b) ({ \
608 /* random suffix to avoid naming conflict */ \
609 __typeof__(a) _value_a_ = (a); \
610 __typeof__(b) _value_b_ = (b); \
611 (_value_a_ < _value_b_) ? _value_a_ : _value_b_; \
612 })
613
619#define Z_CLAMP(val, low, high) ({ \
620 /* random suffix to avoid naming conflict */ \
621 __typeof__(val) _value_val_ = (val); \
622 __typeof__(low) _value_low_ = (low); \
623 __typeof__(high) _value_high_ = (high); \
624 (_value_val_ < _value_low_) ? _value_low_ : \
625 (_value_val_ > _value_high_) ? _value_high_ : \
626 _value_val_; \
627 })
628
635#define Z_POW2_CEIL(x) \
636 ((x) <= 2UL ? (x) : (1UL << (8 * sizeof(long) - __builtin_clzl((x) - 1))))
637
644#define Z_IS_POW2(x) (((x) != 0) && (((x) & ((x)-1)) == 0))
645
646#if defined(CONFIG_ASAN) && defined(__clang__)
647#define __noasan __attribute__((no_sanitize("address")))
648#else
649#define __noasan
650#endif
651
652#if defined(CONFIG_UBSAN)
653#define __noubsan __attribute__((no_sanitize("undefined")))
654#else
655#define __noubsan
656#endif
657
663#if (TOOLCHAIN_GCC_VERSION >= 110000) || \
664 (defined(TOOLCHAIN_CLANG_VERSION) && (TOOLCHAIN_CLANG_VERSION >= 70000))
665#define FUNC_NO_STACK_PROTECTOR __attribute__((no_stack_protector))
666#else
667#define FUNC_NO_STACK_PROTECTOR
668#endif
669
670#define TOOLCHAIN_IGNORE_WSHADOW_BEGIN \
671 _Pragma("GCC diagnostic push") \
672 _Pragma("GCC diagnostic ignored \"-Wshadow\"")
673
674#define TOOLCHAIN_IGNORE_WSHADOW_END \
675 _Pragma("GCC diagnostic pop")
676
677#endif /* !_LINKER */
678#endif /* ZEPHYR_INCLUDE_TOOLCHAIN_GCC_H_ */
Common toolchain abstraction.