7#ifndef ZEPHYR_INCLUDE_TOOLCHAIN_GCC_H_
8#define ZEPHYR_INCLUDE_TOOLCHAIN_GCC_H_
10#ifndef ZEPHYR_INCLUDE_TOOLCHAIN_H_
11#error Please do not include toolchain-specific headers directly, use <zephyr/toolchain.h> instead
21#define TOOLCHAIN_GCC_VERSION \
22 ((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__)
25#if !defined(TOOLCHAIN_HAS_PRAGMA_DIAG) && (TOOLCHAIN_GCC_VERSION >= 40600)
26#define TOOLCHAIN_HAS_PRAGMA_DIAG 1
29#if !defined(TOOLCHAIN_HAS_C_GENERIC) && (TOOLCHAIN_GCC_VERSION >= 40900)
30#define TOOLCHAIN_HAS_C_GENERIC 1
33#if !defined(TOOLCHAIN_HAS_C_AUTO_TYPE) && (TOOLCHAIN_GCC_VERSION >= 40900)
34#define TOOLCHAIN_HAS_C_AUTO_TYPE 1
37#define TOOLCHAIN_HAS_ZLA 1
46#ifndef __ORDER_BIG_ENDIAN__
47#define __ORDER_BIG_ENDIAN__ (1)
50#ifndef __ORDER_LITTLE_ENDIAN__
51#define __ORDER_LITTLE_ENDIAN__ (2)
55#if defined(__BIG_ENDIAN__) || defined(__ARMEB__) || \
56 defined(__THUMBEB__) || defined(__AARCH64EB__) || \
57 defined(__MIPSEB__) || defined(__TC32EB__)
59#define __BYTE_ORDER__ __ORDER_BIG_ENDIAN__
61#elif defined(__LITTLE_ENDIAN__) || defined(__ARMEL__) || \
62 defined(__THUMBEL__) || defined(__AARCH64EL__) || \
63 defined(__MIPSEL__) || defined(__TC32EL__)
65#define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__
68#error "__BYTE_ORDER__ is not defined and cannot be automatically resolved"
75#if defined(__cplusplus) && (__cplusplus >= 201103L)
76#define BUILD_ASSERT(EXPR, MSG...) static_assert(EXPR, "" MSG)
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)
89#define BUILD_ASSERT(EXPR, MSG...)
93#define ZRESTRICT __restrict
95#define ZRESTRICT restrict
101#define ALIAS_OF(of) __attribute__((alias(#of)))
103#define FUNC_ALIAS(real_func, new_alias, return_type) \
104 return_type new_alias() ALIAS_OF(real_func)
106#if TOOLCHAIN_GCC_VERSION < 40500
107#define __builtin_unreachable() __builtin_trap()
110#if defined(CONFIG_ARCH_POSIX) && !defined(_ASMLANGUAGE)
114#define CODE_UNREACHABLE \
116 posix_print_error_and_exit("CODE_UNREACHABLE reached from %s:%d\n",\
117 __FILE__, __LINE__);\
118 __builtin_unreachable(); \
121#define CODE_UNREACHABLE __builtin_unreachable()
123#define FUNC_NORETURN __attribute__((__noreturn__))
128#if defined(CONFIG_ARM) || defined(CONFIG_ARM64)
129#define _NODATA_SECTION(segment) __attribute__((section(#segment)))
131#define _NODATA_SECTION(segment) \
132 __attribute__((section(#segment ",\"wa\",@nobits#")))
136#define UNALIGNED_GET(g) \
138 struct __attribute__((__packed__)) { \
139 __typeof__(*(g)) __v; \
140 } *__g = (__typeof__(__g)) (g); \
145#if (__GNUC__ >= 7) && (defined(CONFIG_ARM) || defined(CONFIG_ARM64))
156#define UNALIGNED_PUT(v, p) \
158 struct __attribute__((__packed__)) { \
159 __typeof__(*p) __v; \
160 } *__p = (__typeof__(__p)) (p); \
162 compiler_barrier(); \
167#define UNALIGNED_PUT(v, p) \
169 struct __attribute__((__packed__)) { \
170 __typeof__(*p) __v; \
171 } *__p = (__typeof__(__p)) (p); \
184#define UNALIGNED_MEMBER_ADDR(_p, _member) ((__typeof__(_p->_member) *) \
185 (((intptr_t)(_p)) + offsetof(__typeof__(*_p), _member)))
190#define __GENERIC_SECTION(segment) __attribute__((section(STRINGIFY(segment))))
191#define Z_GENERIC_SECTION(segment) __GENERIC_SECTION(segment)
193#define __GENERIC_DOT_SECTION(segment) \
194 __attribute__((section("." STRINGIFY(segment))))
195#define Z_GENERIC_DOT_SECTION(segment) __GENERIC_DOT_SECTION(segment)
197#define ___in_section(a, b, c) \
198 __attribute__((section("." Z_STRINGIFY(a) \
200 "." Z_STRINGIFY(c))))
201#define __in_section(a, b, c) ___in_section(a, b, c)
203#ifndef __in_section_unique
204#define __in_section_unique(seg) ___in_section(seg, __FILE__, __COUNTER__)
207#ifndef __in_section_unique_named
208#define __in_section_unique_named(seg, name) \
209 ___in_section(seg, __FILE__, name)
218#if !defined(CONFIG_XIP)
220#elif defined(CONFIG_ARCH_HAS_RAMFUNC_SUPPORT)
221#if defined(CONFIG_ARM)
222#if defined(__clang__)
227#define __ramfunc __attribute__((noinline)) __attribute__((section(".ramfunc")))
230#define __ramfunc __attribute__((noinline)) \
231 __attribute__((long_call, section(".ramfunc")))
234#define __ramfunc __attribute__((noinline)) \
235 __attribute__((section(".ramfunc")))
241#define __fallthrough __attribute__((fallthrough))
248#define __packed __attribute__((__packed__))
252#define __aligned(x) __attribute__((__aligned__(x)))
256#define __noinline __attribute__((noinline))
259#define __may_alias __attribute__((__may_alias__))
262#ifdef CONFIG_ENFORCE_ZEPHYR_STDINT
263#define __printf_like(f, a) __attribute__((format (printf, f, a)))
274#define __printf_like(f, a)
278#define __used __attribute__((__used__))
279#define __unused __attribute__((__unused__))
280#define __maybe_unused __attribute__((__unused__))
283#define __deprecated __attribute__((deprecated))
289#ifndef __deprecated_version
290#define __deprecated_version(version) \
291 __attribute__((deprecated("planned removal in v" #version)))
294#ifndef __attribute_const__
295#define __attribute_const__ __attribute__((__const__))
299#define __must_check __attribute__((warn_unused_result))
302#define ARG_UNUSED(x) (void)(x)
304#define likely(x) (__builtin_expect((bool)!!(x), true) != 0L)
305#define unlikely(x) (__builtin_expect((bool)!!(x), false) != 0L)
306#define POPCOUNT(x) __builtin_popcount(x)
308#ifndef __no_optimization
309#define __no_optimization __attribute__((optimize("-O0")))
313#define __weak __attribute__((__weak__))
316#ifndef __attribute_nonnull
317#define __attribute_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
322#define HAS_BUILTIN___builtin_add_overflow 1
323#define HAS_BUILTIN___builtin_sub_overflow 1
324#define HAS_BUILTIN___builtin_mul_overflow 1
325#define HAS_BUILTIN___builtin_div_overflow 1
328#define HAS_BUILTIN___builtin_clz 1
329#define HAS_BUILTIN___builtin_clzl 1
330#define HAS_BUILTIN___builtin_clzll 1
331#define HAS_BUILTIN___builtin_ctz 1
332#define HAS_BUILTIN___builtin_ctzl 1
333#define HAS_BUILTIN___builtin_ctzll 1
348#define __WARN(msg) __WARN1(GCC warning msg)
349#define __WARN1(s) _Pragma(#s)
352#ifndef CONFIG_DEPRECATION_TEST
353#define __DEPRECATED_MACRO __WARN("Macro is deprecated")
358#define __DEPRECATED_MACRO
363#if defined(_ASMLANGUAGE)
365#if defined(CONFIG_ARM)
367#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
369#define FUNC_CODE() .thumb;
374#define FUNC_CODE() .code 32;
395#if defined(_ASMLANGUAGE)
397#if defined(CONFIG_ARM) || defined(CONFIG_RISCV) \
398 || defined(CONFIG_XTENSA) || defined(CONFIG_ARM64) \
399 || defined(CONFIG_MIPS) || defined(CONFIG_RX)
400#define GTEXT(sym) .global sym; .type sym, %function
401#define GDATA(sym) .global sym; .type sym, %object
402#define WTEXT(sym) .weak sym; .type sym, %function
403#define WDATA(sym) .weak sym; .type sym, %object
404#elif defined(CONFIG_ARC)
410.macro glbl_text symbol
412 .type \symbol, %function
415.macro glbl_data symbol
417 .type \symbol, %
object
420.macro weak_data symbol
422 .type \symbol, %
object
425#define GTEXT(sym) glbl_text sym
426#define GDATA(sym) glbl_data sym
427#define WDATA(sym) weak_data sym
430#define GTEXT(sym) .globl sym; .type sym, @function
431#define GDATA(sym) .globl sym; .type sym, @object
444#if defined(CONFIG_ARC)
453.macro section_var section, symbol
454 .section .\section\().\symbol
458.macro section_func section, symbol
459 .section .\section\().\symbol,
"ax"
466.macro section_subsec_func section, subsection, symbol
467 .section .\section\().\subsection,
"ax"
472#define SECTION_VAR(sect, sym) section_var sect, sym
473#define SECTION_FUNC(sect, sym) section_func sect, sym
474#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
475 section_subsec_func sect, subsec, sym
478#define SECTION_VAR(sect, sym) .section .sect.sym; sym:
479#define SECTION_FUNC(sect, sym) \
480 .section .sect.sym, "ax"; \
482 PERFOPT_ALIGN; sym : \
484#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
485 .section .sect.subsec, "ax"; PERFOPT_ALIGN; sym :
491#if defined(_ASMLANGUAGE)
492#if defined(CONFIG_ARM)
493#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
495#define _ASM_FILE_PROLOGUE .text; .syntax unified; .thumb
497#define _ASM_FILE_PROLOGUE .text; .code 32
499#elif defined(CONFIG_ARM64)
500#define _ASM_FILE_PROLOGUE .text
510#define GEN_OFFSET_EXTERN(name) extern const char name[]
512#define GEN_ABS_SYM_BEGIN(name) \
513 EXTERN_C void name(void); \
517#define GEN_ABS_SYM_END }
536#if defined(CONFIG_ARM)
546#define GEN_ABSOLUTE_SYM(name, value) \
547 __asm__(".globl\t" #name "\n\t.equ\t" #name \
549 "\n\t.type\t" #name ",%%object" : : "n"(~(value)))
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")
556#elif defined(CONFIG_X86)
558#define GEN_ABSOLUTE_SYM(name, value) \
559 __asm__(".globl\t" #name "\n\t.equ\t" #name \
561 "\n\t.type\t" #name ",@object" : : "n"(value))
563#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
564 __asm__(".globl\t" #name \
565 "\n\t.equ\t" #name "," #value \
566 "\n\t.type\t" #name ",@object")
568#elif defined(CONFIG_ARC) || defined(CONFIG_ARM64)
570#define GEN_ABSOLUTE_SYM(name, value) \
571 __asm__(".globl\t" #name "\n\t.equ\t" #name \
573 "\n\t.type\t" #name ",@object" : : "n"(value))
575#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
576 __asm__(".globl\t" #name \
577 "\n\t.equ\t" #name "," #value \
578 "\n\t.type\t" #name ",@object")
580#elif defined(CONFIG_RISCV) || defined(CONFIG_XTENSA) || defined(CONFIG_MIPS)
583#define GEN_ABSOLUTE_SYM(name, value) \
584 __asm__(".globl\t" #name "\n\t.equ\t" #name \
586 "\n\t.type\t" #name ",%%object" : : "n"(value))
588#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
589 __asm__(".globl\t" #name \
590 "\n\t.equ\t" #name "," #value \
591 "\n\t.type\t" #name ",%object")
593#elif defined(CONFIG_ARCH_POSIX)
594#define GEN_ABSOLUTE_SYM(name, value) \
595 __asm__(".globl\t" #name "\n\t.equ\t" #name \
597 "\n\t.type\t" #name ",@object" : : "n"(value))
599#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
600 __asm__(".globl\t" #name \
601 "\n\t.equ\t" #name "," #value \
602 "\n\t.type\t" #name ",@object")
604#elif defined(CONFIG_SPARC)
605#define GEN_ABSOLUTE_SYM(name, value) \
606 __asm__(".global\t" #name "\n\t.equ\t" #name \
608 "\n\t.type\t" #name ",#object" : : "n"(value))
610#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
611 __asm__(".globl\t" #name \
612 "\n\t.equ\t" #name "," #value \
613 "\n\t.type\t" #name ",#object")
615#elif defined(CONFIG_RX)
616#define GEN_ABSOLUTE_SYM(name, value) \
617 __asm__(".global\t" #name "\n\t.equ\t" #name \
619 "\n\t.type\t" #name ",%%object" : : "n"(value))
621#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
622 __asm__(".global\t" #name \
623 "\n\t.equ\t" #name "," #value \
624 "\n\t.type\t" #name ",#object")
627#error processor architecture not supported
630#define compiler_barrier() do { \
631 __asm__ __volatile__ ("" ::: "memory"); \
640#define Z_POW2_CEIL(x) \
641 ((x) <= 2UL ? (x) : (1UL << (8 * sizeof(long) - __builtin_clzl((x) - 1))))
649#define Z_IS_POW2(x) (((x) != 0) && (((x) & ((x)-1)) == 0))
651#if defined(CONFIG_ASAN) && defined(__clang__)
652#define __noasan __attribute__((no_sanitize("address")))
657#if defined(CONFIG_UBSAN)
658#define __noubsan __attribute__((no_sanitize("undefined")))
668#if (TOOLCHAIN_GCC_VERSION >= 110000) || \
669 (defined(TOOLCHAIN_CLANG_VERSION) && (TOOLCHAIN_CLANG_VERSION >= 70000))
670#define FUNC_NO_STACK_PROTECTOR __attribute__((no_stack_protector))
672#define FUNC_NO_STACK_PROTECTOR
675#if defined(CONFIG_INSTRUMENTATION)
676#define __no_instrumentation__ __attribute__((__no_instrument_function__))
678#define __no_instrumentation__
683#define TOOLCHAIN_WARNING_ADDRESS_OF_PACKED_MEMBER "-Waddress-of-packed-member"
684#define TOOLCHAIN_WARNING_ARRAY_BOUNDS "-Warray-bounds"
685#define TOOLCHAIN_WARNING_ATTRIBUTES "-Wattributes"
686#define TOOLCHAIN_WARNING_DELETE_NON_VIRTUAL_DTOR "-Wdelete-non-virtual-dtor"
687#define TOOLCHAIN_WARNING_EXTRA "-Wextra"
688#define TOOLCHAIN_WARNING_NONNULL "-Wnonnull"
689#define TOOLCHAIN_WARNING_SHADOW "-Wshadow"
690#define TOOLCHAIN_WARNING_UNUSED_LABEL "-Wunused-label"
691#define TOOLCHAIN_WARNING_UNUSED_VARIABLE "-Wunused-variable"
692#define TOOLCHAIN_WARNING_CAST_QUAL "-Wcast-qual"
695#if defined(__GNUC__) && !defined(__clang__)
696#define TOOLCHAIN_WARNING_POINTER_ARITH "-Wpointer-arith"
697#define TOOLCHAIN_WARNING_STRINGOP_OVERREAD "-Wstringop-overread"
700#define _TOOLCHAIN_DISABLE_WARNING(compiler, warning) \
701 TOOLCHAIN_PRAGMA(compiler diagnostic push) \
702 TOOLCHAIN_PRAGMA(compiler diagnostic ignored warning)
704#define _TOOLCHAIN_ENABLE_WARNING(compiler, warning) TOOLCHAIN_PRAGMA(compiler diagnostic pop)
706#define TOOLCHAIN_DISABLE_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
707#define TOOLCHAIN_ENABLE_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)
709#if defined(__GNUC__) && !defined(__clang__)
710#define TOOLCHAIN_DISABLE_GCC_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
711#define TOOLCHAIN_ENABLE_GCC_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)