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 defined(CONFIG_ARCH_POSIX) && !defined(_ASMLANGUAGE)
110#define CODE_UNREACHABLE \
112 posix_print_error_and_exit("CODE_UNREACHABLE reached from %s:%d\n",\
113 __FILE__, __LINE__);\
114 __builtin_unreachable(); \
117#define CODE_UNREACHABLE __builtin_unreachable()
119#define FUNC_NORETURN __attribute__((__noreturn__))
124#if defined(CONFIG_ARM) || defined(CONFIG_ARM64)
125#define _NODATA_SECTION(segment) __attribute__((section(#segment)))
127#define _NODATA_SECTION(segment) \
128 __attribute__((section(#segment ",\"wa\",@nobits#")))
133#define UNALIGNED_GET(g) \
136 __typeof__(*(g)) __v; \
137 unsigned char __b[sizeof(__typeof__(*(g)))]; \
139 __builtin_memcpy(__u.__b, (const void *)(g), sizeof(__u.__b)); \
143#define UNALIGNED_GET(g) \
145 struct __attribute__((__packed__)) { \
146 __typeof__(*(g)) __v; \
147 } *__g = (__typeof__(__g)) (g); \
153#if (__GNUC__ >= 7) && (defined(CONFIG_ARM) || defined(CONFIG_ARM64))
164#define UNALIGNED_PUT(v, p) \
166 struct __attribute__((__packed__)) { \
167 __typeof__(*p) __v; \
168 } *__p = (__typeof__(__p)) (p); \
170 compiler_barrier(); \
175#define UNALIGNED_PUT(v, p) \
177 struct __attribute__((__packed__)) { \
178 __typeof__(*p) __v; \
179 } *__p = (__typeof__(__p)) (p); \
192#define UNALIGNED_MEMBER_ADDR(_p, _member) ((__typeof__(_p->_member) *) \
193 (((intptr_t)(_p)) + offsetof(__typeof__(*_p), _member)))
198#define __GENERIC_SECTION(segment) __attribute__((section(STRINGIFY(segment))))
199#define Z_GENERIC_SECTION(segment) __GENERIC_SECTION(segment)
201#define __GENERIC_DOT_SECTION(segment) \
202 __attribute__((section("." STRINGIFY(segment))))
203#define Z_GENERIC_DOT_SECTION(segment) __GENERIC_DOT_SECTION(segment)
205#define ___in_section(a, b, c) \
206 __attribute__((section("." Z_STRINGIFY(a) \
208 "." Z_STRINGIFY(c))))
209#define __in_section(a, b, c) ___in_section(a, b, c)
211#define ___in_section_unique(a, b) \
212 __attribute__((section("." Z_STRINGIFY(a) \
214 "." Z_STRINGIFY(b))))
216#ifndef __in_section_unique
217#define __in_section_unique(seg) ___in_section_unique(seg, __COUNTER__)
220#ifndef __in_section_unique_named
221#define __in_section_unique_named(seg, name) ___in_section_unique(seg, name)
230#if !defined(CONFIG_XIP)
232#elif defined(CONFIG_ARCH_HAS_RAMFUNC_SUPPORT)
233#if defined(CONFIG_ARM)
234#if defined(__clang__)
239#define __ramfunc __attribute__((noinline)) __attribute__((section(".ramfunc")))
242#define __ramfunc __attribute__((noinline)) \
243 __attribute__((long_call, section(".ramfunc")))
246#define __ramfunc __attribute__((noinline)) \
247 __attribute__((section(".ramfunc")))
253#define __fallthrough __attribute__((fallthrough))
260#define __packed __attribute__((__packed__))
264#define __aligned(x) __attribute__((__aligned__(x)))
268#define __noinline __attribute__((noinline))
271#define __may_alias __attribute__((__may_alias__))
274#ifdef CONFIG_ENFORCE_ZEPHYR_STDINT
275#define __printf_like(f, a) __attribute__((format (printf, f, a)))
286#define __printf_like(f, a)
290#define __used __attribute__((__used__))
291#define __unused __attribute__((__unused__))
292#define __maybe_unused __attribute__((__unused__))
295#define __deprecated __attribute__((deprecated))
301#ifndef __deprecated_version
302#define __deprecated_version(version) \
303 __attribute__((deprecated("planned removal in v" #version)))
306#ifndef __attribute_const__
307#define __attribute_const__ __attribute__((__const__))
311#define __must_check __attribute__((warn_unused_result))
314#define ARG_UNUSED(x) (void)(x)
316#define likely(x) (__builtin_expect((bool)!!(x), true) != 0L)
317#define unlikely(x) (__builtin_expect((bool)!!(x), false) != 0L)
318#define POPCOUNT(x) __builtin_popcount(x)
320#ifndef __no_optimization
321#define __no_optimization __attribute__((optimize("-O0")))
325#define __weak __attribute__((__weak__))
328#ifndef __attribute_nonnull
329#define __attribute_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
333#define __cleanup(x) __attribute__((cleanup(x)))
338#define HAS_BUILTIN___builtin_add_overflow 1
339#define HAS_BUILTIN___builtin_sub_overflow 1
340#define HAS_BUILTIN___builtin_mul_overflow 1
342#if TOOLCHAIN_GCC_VERSION >= 40800
343#define HAS_BUILTIN___builtin_bswap16 1
345#if TOOLCHAIN_GCC_VERSION >= 40300
346#define HAS_BUILTIN___builtin_bswap32 1
347#define HAS_BUILTIN___builtin_bswap64 1
350#define HAS_BUILTIN___builtin_clz 1
351#define HAS_BUILTIN___builtin_clzl 1
352#define HAS_BUILTIN___builtin_clzll 1
353#define HAS_BUILTIN___builtin_ctz 1
354#define HAS_BUILTIN___builtin_ctzl 1
355#define HAS_BUILTIN___builtin_ctzll 1
368#ifndef TOOLCHAIN_PRAGMA_UNROLL
369#define _TOOLCHAIN_PRAGMA_UNROLL(x) _Pragma(#x)
370#define TOOLCHAIN_PRAGMA_UNROLL(n) _TOOLCHAIN_PRAGMA_UNROLL(GCC unroll n)
380#define __WARN(msg) __WARN1(GCC warning msg)
381#define __WARN1(s) _Pragma(#s)
384#if defined(CONFIG_WARN_DEPRECATED)
385#define __DEPRECATED_MACRO __WARN("Macro is deprecated")
390#define __DEPRECATED_MACRO
395#if defined(_ASMLANGUAGE)
397#if defined(CONFIG_ARM)
399#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
401#define FUNC_CODE() .thumb;
406#define FUNC_CODE() .code 32;
427#if defined(_ASMLANGUAGE)
429#if defined(CONFIG_ARM) || defined(CONFIG_RISCV) || defined(CONFIG_XTENSA) || \
430 defined(CONFIG_ARM64) || defined(CONFIG_MIPS) || defined(CONFIG_RX) || \
431 defined(CONFIG_OPENRISC) || defined(CONFIG_TRICORE)
432#define GTEXT(sym) .global sym; .type sym, %function
433#define GDATA(sym) .global sym; .type sym, %object
434#define WTEXT(sym) .weak sym; .type sym, %function
435#define WDATA(sym) .weak sym; .type sym, %object
436#elif defined(CONFIG_ARC)
442.macro glbl_text symbol
444 .type \symbol, %function
447.macro glbl_data symbol
449 .type \symbol, %
object
452.macro weak_data symbol
454 .type \symbol, %
object
457#define GTEXT(sym) glbl_text sym
458#define GDATA(sym) glbl_data sym
459#define WDATA(sym) weak_data sym
462#define GTEXT(sym) .globl sym; .type sym, @function
463#define GDATA(sym) .globl sym; .type sym, @object
476#if defined(CONFIG_ARC)
485.macro section_var section, symbol
486 .section .\section\().\symbol
490.macro section_func section, symbol
491 .section .\section\().\symbol,
"ax"
498.macro section_subsec_func section, subsection, symbol
499 .section .\section\().\subsection,
"ax"
504#define SECTION_VAR(sect, sym) section_var sect, sym
505#define SECTION_FUNC(sect, sym) section_func sect, sym
506#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
507 section_subsec_func sect, subsec, sym
510#define SECTION_VAR(sect, sym) .section .sect.sym; sym:
511#define SECTION_FUNC(sect, sym) \
512 .section .sect.sym, "ax"; \
514 PERFOPT_ALIGN; sym : \
516#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
517 .section .sect.subsec, "ax"; PERFOPT_ALIGN; sym :
523#if defined(_ASMLANGUAGE)
524#if defined(CONFIG_ARM)
525#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
527#define _ASM_FILE_PROLOGUE .text; .syntax unified; .thumb
529#define _ASM_FILE_PROLOGUE .text; .code 32
531#elif defined(CONFIG_ARM64)
532#define _ASM_FILE_PROLOGUE .text
542#define GEN_OFFSET_EXTERN(name) extern const char name[]
544#define GEN_ABS_SYM_BEGIN(name) \
545 EXTERN_C void name(void); \
549#define GEN_ABS_SYM_END }
568#if defined(CONFIG_ARM) || (defined(CONFIG_ARCH_POSIX) && defined(__arm__))
578#define GEN_ABSOLUTE_SYM(name, value) \
579 __asm__ __volatile__(".globl\t" #name "\n\t.equ\t" #name \
581 "\n\t.type\t" #name ",%%object" : : "n"(~(value)))
583#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
584 __asm__ __volatile__(".globl\t" #name \
585 "\n\t.equ\t" #name "," #value \
586 "\n\t.type\t" #name ",%object")
588#elif defined(CONFIG_ARC) || defined(CONFIG_ARM64) \
589 || defined(CONFIG_ARCH_POSIX) \
590 || defined(CONFIG_X86)
592#define GEN_ABSOLUTE_SYM(name, value) \
593 __asm__ __volatile__(".globl\t" #name "\n\t.equ\t" #name \
595 "\n\t.type\t" #name ",@object" : : "n"(value))
597#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
598 __asm__ __volatile__(".globl\t" #name \
599 "\n\t.equ\t" #name "," #value \
600 "\n\t.type\t" #name ",@object")
602#elif defined(CONFIG_RISCV) || defined(CONFIG_XTENSA) || \
603 defined(CONFIG_MIPS) || defined(CONFIG_OPENRISC)
606#define GEN_ABSOLUTE_SYM(name, value) \
607 __asm__ __volatile__(".globl\t" #name "\n\t.equ\t" #name \
609 "\n\t.type\t" #name ",%%object" : : "n"(value))
611#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
612 __asm__ __volatile__(".globl\t" #name \
613 "\n\t.equ\t" #name "," #value \
614 "\n\t.type\t" #name ",%object")
616#elif defined(CONFIG_SPARC)
617#define GEN_ABSOLUTE_SYM(name, value) \
618 __asm__ __volatile__(".global\t" #name "\n\t.equ\t" #name \
620 "\n\t.type\t" #name ",#object" : : "n"(value))
622#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
623 __asm__ __volatile__(".globl\t" #name \
624 "\n\t.equ\t" #name "," #value \
625 "\n\t.type\t" #name ",#object")
627#elif defined(CONFIG_RX)
628#define GEN_ABSOLUTE_SYM(name, value) \
629 __asm__ __volatile__(".global\t" #name "\n\t.equ\t" #name \
631 "\n\t.type\t" #name ",%%object" : : "n"(value))
633#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
634 __asm__ __volatile__(".global\t" #name \
635 "\n\t.equ\t" #name "," #value \
636 "\n\t.type\t" #name ",#object")
638#elif defined(CONFIG_HEXAGON)
640#define GEN_ABSOLUTE_SYM(name, value) \
641 __asm__(".globl\t" #name "\n\t.equ\t" #name ",%c0" \
642 "\n\t.type\t" #name ",@object" \
646#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) __asm__(".globl " #name "\n.equ " #name ", " #value)
648#elif defined(CONFIG_TRICORE)
649#define GEN_ABSOLUTE_SYM(name, value) \
650 __asm__(".global\t" #name "\n\t.equ\t" #name \
652 "\n\t.type\t" #name ",@object" : : "n"(value))
654#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
655 __asm__(".globl\t" #name \
656 "\n\t.equ\t" #name "," #value \
657 "\n\t.type\t" #name ",@object")
659#error processor architecture not supported
662#define compiler_barrier() do { \
663 __asm__ __volatile__ ("" ::: "memory"); \
672#define Z_POW2_CEIL(x) \
673 ((x) <= 2UL ? (x) : (1UL << (8 * sizeof(long) - __builtin_clzl((x) - 1))))
681#define Z_IS_POW2(x) (((x) != 0) && (((x) & ((x)-1)) == 0))
683#if defined(CONFIG_ASAN) && defined(__clang__)
684#define __noasan __attribute__((no_sanitize("address")))
689#if defined(CONFIG_UBSAN)
690#define __noubsan __attribute__((no_sanitize("undefined")))
700#if (TOOLCHAIN_GCC_VERSION >= 110000) || \
701 (defined(TOOLCHAIN_CLANG_VERSION) && (TOOLCHAIN_CLANG_VERSION >= 70000))
702#define FUNC_NO_STACK_PROTECTOR __attribute__((no_stack_protector))
704#define FUNC_NO_STACK_PROTECTOR
707#if defined(CONFIG_INSTRUMENTATION)
708#define __no_instrumentation__ __attribute__((__no_instrument_function__))
710#define __no_instrumentation__
715#define TOOLCHAIN_WARNING_ADDRESS_OF_PACKED_MEMBER "-Waddress-of-packed-member"
716#define TOOLCHAIN_WARNING_ARRAY_BOUNDS "-Warray-bounds"
717#define TOOLCHAIN_WARNING_ATTRIBUTES "-Wattributes"
718#define TOOLCHAIN_WARNING_DELETE_NON_VIRTUAL_DTOR "-Wdelete-non-virtual-dtor"
719#define TOOLCHAIN_WARNING_DEPRECATED_DECLARATIONS "-Wdeprecated-declarations"
720#define TOOLCHAIN_WARNING_EXTRA "-Wextra"
721#define TOOLCHAIN_WARNING_NONNULL "-Wnonnull"
722#define TOOLCHAIN_WARNING_SHADOW "-Wshadow"
723#define TOOLCHAIN_WARNING_UNUSED_LABEL "-Wunused-label"
724#define TOOLCHAIN_WARNING_UNUSED_VARIABLE "-Wunused-variable"
725#define TOOLCHAIN_WARNING_CAST_QUAL "-Wcast-qual"
728#if defined(__GNUC__) && !defined(__clang__)
729#define TOOLCHAIN_WARNING_POINTER_ARITH "-Wpointer-arith"
730#define TOOLCHAIN_WARNING_STRINGOP_OVERREAD "-Wstringop-overread"
733#define _TOOLCHAIN_DISABLE_WARNING(compiler, warning) \
734 TOOLCHAIN_PRAGMA(compiler diagnostic push) \
735 TOOLCHAIN_PRAGMA(compiler diagnostic ignored warning)
737#define _TOOLCHAIN_ENABLE_WARNING(compiler, warning) TOOLCHAIN_PRAGMA(compiler diagnostic pop)
739#define TOOLCHAIN_DISABLE_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
740#define TOOLCHAIN_ENABLE_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)
742#if defined(__GNUC__) && !defined(__clang__)
743#define TOOLCHAIN_DISABLE_GCC_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
744#define TOOLCHAIN_ENABLE_GCC_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)