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#")))
137#define UNALIGNED_GET(g) \
140 __typeof__(*(g)) __v; \
141 unsigned char __b[sizeof(__typeof__(*(g)))]; \
143 __builtin_memcpy(__u.__b, (const void *)(g), sizeof(__u.__b)); \
147#define UNALIGNED_GET(g) \
149 struct __attribute__((__packed__)) { \
150 __typeof__(*(g)) __v; \
151 } *__g = (__typeof__(__g)) (g); \
157#if (__GNUC__ >= 7) && (defined(CONFIG_ARM) || defined(CONFIG_ARM64))
168#define UNALIGNED_PUT(v, p) \
170 struct __attribute__((__packed__)) { \
171 __typeof__(*p) __v; \
172 } *__p = (__typeof__(__p)) (p); \
174 compiler_barrier(); \
179#define UNALIGNED_PUT(v, p) \
181 struct __attribute__((__packed__)) { \
182 __typeof__(*p) __v; \
183 } *__p = (__typeof__(__p)) (p); \
196#define UNALIGNED_MEMBER_ADDR(_p, _member) ((__typeof__(_p->_member) *) \
197 (((intptr_t)(_p)) + offsetof(__typeof__(*_p), _member)))
202#define __GENERIC_SECTION(segment) __attribute__((section(STRINGIFY(segment))))
203#define Z_GENERIC_SECTION(segment) __GENERIC_SECTION(segment)
205#define __GENERIC_DOT_SECTION(segment) \
206 __attribute__((section("." STRINGIFY(segment))))
207#define Z_GENERIC_DOT_SECTION(segment) __GENERIC_DOT_SECTION(segment)
209#define ___in_section(a, b, c) \
210 __attribute__((section("." Z_STRINGIFY(a) \
212 "." Z_STRINGIFY(c))))
213#define __in_section(a, b, c) ___in_section(a, b, c)
215#define ___in_section_unique(a, b) \
216 __attribute__((section("." Z_STRINGIFY(a) \
218 "." Z_STRINGIFY(b))))
220#ifndef __in_section_unique
221#define __in_section_unique(seg) ___in_section_unique(seg, __COUNTER__)
224#ifndef __in_section_unique_named
225#define __in_section_unique_named(seg, name) ___in_section_unique(seg, name)
234#if !defined(CONFIG_XIP)
236#elif defined(CONFIG_ARCH_HAS_RAMFUNC_SUPPORT)
237#if defined(CONFIG_ARM)
238#if defined(__clang__)
243#define __ramfunc __attribute__((noinline)) __attribute__((section(".ramfunc")))
246#define __ramfunc __attribute__((noinline)) \
247 __attribute__((long_call, section(".ramfunc")))
250#define __ramfunc __attribute__((noinline)) \
251 __attribute__((section(".ramfunc")))
257#define __fallthrough __attribute__((fallthrough))
264#define __packed __attribute__((__packed__))
268#define __aligned(x) __attribute__((__aligned__(x)))
272#define __noinline __attribute__((noinline))
275#define __may_alias __attribute__((__may_alias__))
278#ifdef CONFIG_ENFORCE_ZEPHYR_STDINT
279#define __printf_like(f, a) __attribute__((format (printf, f, a)))
290#define __printf_like(f, a)
294#define __used __attribute__((__used__))
295#define __unused __attribute__((__unused__))
296#define __maybe_unused __attribute__((__unused__))
299#define __deprecated __attribute__((deprecated))
305#ifndef __deprecated_version
306#define __deprecated_version(version) \
307 __attribute__((deprecated("planned removal in v" #version)))
310#ifndef __attribute_const__
311#define __attribute_const__ __attribute__((__const__))
315#define __must_check __attribute__((warn_unused_result))
318#define ARG_UNUSED(x) (void)(x)
320#define likely(x) (__builtin_expect((bool)!!(x), true) != 0L)
321#define unlikely(x) (__builtin_expect((bool)!!(x), false) != 0L)
322#define POPCOUNT(x) __builtin_popcount(x)
324#ifndef __no_optimization
325#define __no_optimization __attribute__((optimize("-O0")))
329#define __weak __attribute__((__weak__))
332#ifndef __attribute_nonnull
333#define __attribute_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
337#define __cleanup(x) __attribute__((cleanup(x)))
342#define HAS_BUILTIN___builtin_add_overflow 1
343#define HAS_BUILTIN___builtin_sub_overflow 1
344#define HAS_BUILTIN___builtin_mul_overflow 1
346#if TOOLCHAIN_GCC_VERSION >= 40800
347#define HAS_BUILTIN___builtin_bswap16 1
349#if TOOLCHAIN_GCC_VERSION >= 40300
350#define HAS_BUILTIN___builtin_bswap32 1
351#define HAS_BUILTIN___builtin_bswap64 1
354#define HAS_BUILTIN___builtin_clz 1
355#define HAS_BUILTIN___builtin_clzl 1
356#define HAS_BUILTIN___builtin_clzll 1
357#define HAS_BUILTIN___builtin_ctz 1
358#define HAS_BUILTIN___builtin_ctzl 1
359#define HAS_BUILTIN___builtin_ctzll 1
372#ifndef TOOLCHAIN_PRAGMA_UNROLL
373#define _TOOLCHAIN_PRAGMA_UNROLL(x) _Pragma(#x)
374#define TOOLCHAIN_PRAGMA_UNROLL(n) _TOOLCHAIN_PRAGMA_UNROLL(GCC unroll n)
384#define __WARN(msg) __WARN1(GCC warning msg)
385#define __WARN1(s) _Pragma(#s)
388#if defined(CONFIG_WARN_DEPRECATED)
389#define __DEPRECATED_MACRO __WARN("Macro is deprecated")
394#define __DEPRECATED_MACRO
399#if defined(_ASMLANGUAGE)
401#if defined(CONFIG_ARM)
403#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
405#define FUNC_CODE() .thumb;
410#define FUNC_CODE() .code 32;
431#if defined(_ASMLANGUAGE)
433#if defined(CONFIG_ARM) || defined(CONFIG_RISCV) || defined(CONFIG_XTENSA) || \
434 defined(CONFIG_ARM64) || defined(CONFIG_MIPS) || defined(CONFIG_RX) || \
435 defined(CONFIG_OPENRISC) || defined(CONFIG_TRICORE)
436#define GTEXT(sym) .global sym; .type sym, %function
437#define GDATA(sym) .global sym; .type sym, %object
438#define WTEXT(sym) .weak sym; .type sym, %function
439#define WDATA(sym) .weak sym; .type sym, %object
440#elif defined(CONFIG_ARC)
446.macro glbl_text symbol
448 .type \symbol, %function
451.macro glbl_data symbol
453 .type \symbol, %
object
456.macro weak_data symbol
458 .type \symbol, %
object
461#define GTEXT(sym) glbl_text sym
462#define GDATA(sym) glbl_data sym
463#define WDATA(sym) weak_data sym
466#define GTEXT(sym) .globl sym; .type sym, @function
467#define GDATA(sym) .globl sym; .type sym, @object
480#if defined(CONFIG_ARC)
489.macro section_var section, symbol
490 .section .\section\().\symbol
494.macro section_func section, symbol
495 .section .\section\().\symbol,
"ax"
502.macro section_subsec_func section, subsection, symbol
503 .section .\section\().\subsection,
"ax"
508#define SECTION_VAR(sect, sym) section_var sect, sym
509#define SECTION_FUNC(sect, sym) section_func sect, sym
510#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
511 section_subsec_func sect, subsec, sym
514#define SECTION_VAR(sect, sym) .section .sect.sym; sym:
515#define SECTION_FUNC(sect, sym) \
516 .section .sect.sym, "ax"; \
518 PERFOPT_ALIGN; sym : \
520#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
521 .section .sect.subsec, "ax"; PERFOPT_ALIGN; sym :
527#if defined(_ASMLANGUAGE)
528#if defined(CONFIG_ARM)
529#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
531#define _ASM_FILE_PROLOGUE .text; .syntax unified; .thumb
533#define _ASM_FILE_PROLOGUE .text; .code 32
535#elif defined(CONFIG_ARM64)
536#define _ASM_FILE_PROLOGUE .text
546#define GEN_OFFSET_EXTERN(name) extern const char name[]
548#define GEN_ABS_SYM_BEGIN(name) \
549 EXTERN_C void name(void); \
553#define GEN_ABS_SYM_END }
572#if defined(CONFIG_ARM) || (defined(CONFIG_ARCH_POSIX) && defined(__arm__))
582#define GEN_ABSOLUTE_SYM(name, value) \
583 __asm__ __volatile__(".globl\t" #name "\n\t.equ\t" #name \
585 "\n\t.type\t" #name ",%%object" : : "n"(~(value)))
587#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
588 __asm__ __volatile__(".globl\t" #name \
589 "\n\t.equ\t" #name "," #value \
590 "\n\t.type\t" #name ",%object")
592#elif defined(CONFIG_ARC) || defined(CONFIG_ARM64) \
593 || defined(CONFIG_ARCH_POSIX) \
594 || defined(CONFIG_X86)
596#define GEN_ABSOLUTE_SYM(name, value) \
597 __asm__ __volatile__(".globl\t" #name "\n\t.equ\t" #name \
599 "\n\t.type\t" #name ",@object" : : "n"(value))
601#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
602 __asm__ __volatile__(".globl\t" #name \
603 "\n\t.equ\t" #name "," #value \
604 "\n\t.type\t" #name ",@object")
606#elif defined(CONFIG_RISCV) || defined(CONFIG_XTENSA) || \
607 defined(CONFIG_MIPS) || defined(CONFIG_OPENRISC)
610#define GEN_ABSOLUTE_SYM(name, value) \
611 __asm__ __volatile__(".globl\t" #name "\n\t.equ\t" #name \
613 "\n\t.type\t" #name ",%%object" : : "n"(value))
615#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
616 __asm__ __volatile__(".globl\t" #name \
617 "\n\t.equ\t" #name "," #value \
618 "\n\t.type\t" #name ",%object")
620#elif defined(CONFIG_SPARC)
621#define GEN_ABSOLUTE_SYM(name, value) \
622 __asm__ __volatile__(".global\t" #name "\n\t.equ\t" #name \
624 "\n\t.type\t" #name ",#object" : : "n"(value))
626#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
627 __asm__ __volatile__(".globl\t" #name \
628 "\n\t.equ\t" #name "," #value \
629 "\n\t.type\t" #name ",#object")
631#elif defined(CONFIG_RX)
632#define GEN_ABSOLUTE_SYM(name, value) \
633 __asm__ __volatile__(".global\t" #name "\n\t.equ\t" #name \
635 "\n\t.type\t" #name ",%%object" : : "n"(value))
637#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
638 __asm__ __volatile__(".global\t" #name \
639 "\n\t.equ\t" #name "," #value \
640 "\n\t.type\t" #name ",#object")
642#elif defined(CONFIG_HEXAGON)
644#define GEN_ABSOLUTE_SYM(name, value) \
645 __asm__(".globl\t" #name "\n\t.equ\t" #name ",%c0" \
646 "\n\t.type\t" #name ",@object" \
650#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) __asm__(".globl " #name "\n.equ " #name ", " #value)
652#elif defined(CONFIG_TRICORE)
653#define GEN_ABSOLUTE_SYM(name, value) \
654 __asm__(".global\t" #name "\n\t.equ\t" #name \
656 "\n\t.type\t" #name ",@object" : : "n"(value))
658#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
659 __asm__(".globl\t" #name \
660 "\n\t.equ\t" #name "," #value \
661 "\n\t.type\t" #name ",@object")
663#error processor architecture not supported
666#define compiler_barrier() do { \
667 __asm__ __volatile__ ("" ::: "memory"); \
676#define Z_POW2_CEIL(x) \
677 ((x) <= 2UL ? (x) : (1UL << (8 * sizeof(long) - __builtin_clzl((x) - 1))))
685#define Z_IS_POW2(x) (((x) != 0) && (((x) & ((x)-1)) == 0))
687#if defined(CONFIG_ASAN) && defined(__clang__)
688#define __noasan __attribute__((no_sanitize("address")))
693#if defined(CONFIG_UBSAN)
694#define __noubsan __attribute__((no_sanitize("undefined")))
704#if (TOOLCHAIN_GCC_VERSION >= 110000) || \
705 (defined(TOOLCHAIN_CLANG_VERSION) && (TOOLCHAIN_CLANG_VERSION >= 70000))
706#define FUNC_NO_STACK_PROTECTOR __attribute__((no_stack_protector))
708#define FUNC_NO_STACK_PROTECTOR
711#if defined(CONFIG_INSTRUMENTATION)
712#define __no_instrumentation__ __attribute__((__no_instrument_function__))
714#define __no_instrumentation__
719#define TOOLCHAIN_WARNING_ADDRESS_OF_PACKED_MEMBER "-Waddress-of-packed-member"
720#define TOOLCHAIN_WARNING_ARRAY_BOUNDS "-Warray-bounds"
721#define TOOLCHAIN_WARNING_ATTRIBUTES "-Wattributes"
722#define TOOLCHAIN_WARNING_DELETE_NON_VIRTUAL_DTOR "-Wdelete-non-virtual-dtor"
723#define TOOLCHAIN_WARNING_DEPRECATED_DECLARATIONS "-Wdeprecated-declarations"
724#define TOOLCHAIN_WARNING_EXTRA "-Wextra"
725#define TOOLCHAIN_WARNING_NONNULL "-Wnonnull"
726#define TOOLCHAIN_WARNING_SHADOW "-Wshadow"
727#define TOOLCHAIN_WARNING_UNUSED_LABEL "-Wunused-label"
728#define TOOLCHAIN_WARNING_UNUSED_VARIABLE "-Wunused-variable"
729#define TOOLCHAIN_WARNING_CAST_QUAL "-Wcast-qual"
732#if defined(__GNUC__) && !defined(__clang__)
733#define TOOLCHAIN_WARNING_POINTER_ARITH "-Wpointer-arith"
734#define TOOLCHAIN_WARNING_STRINGOP_OVERREAD "-Wstringop-overread"
737#define _TOOLCHAIN_DISABLE_WARNING(compiler, warning) \
738 TOOLCHAIN_PRAGMA(compiler diagnostic push) \
739 TOOLCHAIN_PRAGMA(compiler diagnostic ignored warning)
741#define _TOOLCHAIN_ENABLE_WARNING(compiler, warning) TOOLCHAIN_PRAGMA(compiler diagnostic pop)
743#define TOOLCHAIN_DISABLE_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
744#define TOOLCHAIN_ENABLE_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)
746#if defined(__GNUC__) && !defined(__clang__)
747#define TOOLCHAIN_DISABLE_GCC_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
748#define TOOLCHAIN_ENABLE_GCC_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)