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); \
180#define __GENERIC_SECTION(segment) __attribute__((section(STRINGIFY(segment))))
181#define Z_GENERIC_SECTION(segment) __GENERIC_SECTION(segment)
183#define __GENERIC_DOT_SECTION(segment) \
184 __attribute__((section("." STRINGIFY(segment))))
185#define Z_GENERIC_DOT_SECTION(segment) __GENERIC_DOT_SECTION(segment)
187#define ___in_section(a, b, c) \
188 __attribute__((section("." Z_STRINGIFY(a) \
190 "." Z_STRINGIFY(c))))
191#define __in_section(a, b, c) ___in_section(a, b, c)
193#ifndef __in_section_unique
194#define __in_section_unique(seg) ___in_section(seg, __FILE__, __COUNTER__)
197#ifndef __in_section_unique_named
198#define __in_section_unique_named(seg, name) \
199 ___in_section(seg, __FILE__, name)
208#if !defined(CONFIG_XIP)
210#elif defined(CONFIG_ARCH_HAS_RAMFUNC_SUPPORT)
211#if defined(CONFIG_ARM)
212#if defined(__clang__)
217#define __ramfunc __attribute__((noinline)) __attribute__((section(".ramfunc")))
220#define __ramfunc __attribute__((noinline)) \
221 __attribute__((long_call, section(".ramfunc")))
224#define __ramfunc __attribute__((noinline)) \
225 __attribute__((section(".ramfunc")))
231#define __fallthrough __attribute__((fallthrough))
238#define __packed __attribute__((__packed__))
242#define __aligned(x) __attribute__((__aligned__(x)))
246#define __noinline __attribute__((noinline))
249#define __may_alias __attribute__((__may_alias__))
252#ifdef CONFIG_ENFORCE_ZEPHYR_STDINT
253#define __printf_like(f, a) __attribute__((format (printf, f, a)))
264#define __printf_like(f, a)
268#define __used __attribute__((__used__))
269#define __unused __attribute__((__unused__))
270#define __maybe_unused __attribute__((__unused__))
273#define __deprecated __attribute__((deprecated))
279#ifndef __attribute_const__
280#define __attribute_const__ __attribute__((__const__))
284#define __must_check __attribute__((warn_unused_result))
287#define ARG_UNUSED(x) (void)(x)
289#define likely(x) (__builtin_expect((bool)!!(x), true) != 0L)
290#define unlikely(x) (__builtin_expect((bool)!!(x), false) != 0L)
291#define POPCOUNT(x) __builtin_popcount(x)
293#ifndef __no_optimization
294#define __no_optimization __attribute__((optimize("-O0")))
298#define __weak __attribute__((__weak__))
301#ifndef __attribute_nonnull
302#define __attribute_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
307#define HAS_BUILTIN___builtin_add_overflow 1
308#define HAS_BUILTIN___builtin_sub_overflow 1
309#define HAS_BUILTIN___builtin_mul_overflow 1
310#define HAS_BUILTIN___builtin_div_overflow 1
313#define HAS_BUILTIN___builtin_clz 1
314#define HAS_BUILTIN___builtin_clzl 1
315#define HAS_BUILTIN___builtin_clzll 1
316#define HAS_BUILTIN___builtin_ctz 1
317#define HAS_BUILTIN___builtin_ctzl 1
318#define HAS_BUILTIN___builtin_ctzll 1
333#define __WARN(msg) __WARN1(GCC warning msg)
334#define __WARN1(s) _Pragma(#s)
337#ifndef CONFIG_DEPRECATION_TEST
338#define __DEPRECATED_MACRO __WARN("Macro is deprecated")
343#define __DEPRECATED_MACRO
348#if defined(_ASMLANGUAGE)
350#if defined(CONFIG_ARM)
352#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
354#define FUNC_CODE() .thumb;
359#define FUNC_CODE() .code 32;
380#if defined(_ASMLANGUAGE)
382#if defined(CONFIG_ARM) || defined(CONFIG_RISCV) \
383 || defined(CONFIG_XTENSA) || defined(CONFIG_ARM64) \
384 || defined(CONFIG_MIPS) || defined(CONFIG_RX)
385#define GTEXT(sym) .global sym; .type sym, %function
386#define GDATA(sym) .global sym; .type sym, %object
387#define WTEXT(sym) .weak sym; .type sym, %function
388#define WDATA(sym) .weak sym; .type sym, %object
389#elif defined(CONFIG_ARC)
395.macro glbl_text symbol
397 .type \symbol, %function
400.macro glbl_data symbol
402 .type \symbol, %
object
405.macro weak_data symbol
407 .type \symbol, %
object
410#define GTEXT(sym) glbl_text sym
411#define GDATA(sym) glbl_data sym
412#define WDATA(sym) weak_data sym
415#define GTEXT(sym) .globl sym; .type sym, @function
416#define GDATA(sym) .globl sym; .type sym, @object
429#if defined(CONFIG_ARC)
438.macro section_var section, symbol
439 .section .\section\().\symbol
443.macro section_func section, symbol
444 .section .\section\().\symbol,
"ax"
451.macro section_subsec_func section, subsection, symbol
452 .section .\section\().\subsection,
"ax"
457#define SECTION_VAR(sect, sym) section_var sect, sym
458#define SECTION_FUNC(sect, sym) section_func sect, sym
459#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
460 section_subsec_func sect, subsec, sym
463#define SECTION_VAR(sect, sym) .section .sect.sym; sym:
464#define SECTION_FUNC(sect, sym) \
465 .section .sect.sym, "ax"; \
467 PERFOPT_ALIGN; sym : \
469#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
470 .section .sect.subsec, "ax"; PERFOPT_ALIGN; sym :
476#if defined(_ASMLANGUAGE)
477#if defined(CONFIG_ARM)
478#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
480#define _ASM_FILE_PROLOGUE .text; .syntax unified; .thumb
482#define _ASM_FILE_PROLOGUE .text; .code 32
484#elif defined(CONFIG_ARM64)
485#define _ASM_FILE_PROLOGUE .text
495#define GEN_OFFSET_EXTERN(name) extern const char name[]
497#define GEN_ABS_SYM_BEGIN(name) \
498 EXTERN_C void name(void); \
502#define GEN_ABS_SYM_END }
521#if defined(CONFIG_ARM)
531#define GEN_ABSOLUTE_SYM(name, value) \
532 __asm__(".globl\t" #name "\n\t.equ\t" #name \
534 "\n\t.type\t" #name ",%%object" : : "n"(~(value)))
536#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
537 __asm__(".globl\t" #name \
538 "\n\t.equ\t" #name "," #value \
539 "\n\t.type\t" #name ",%object")
541#elif defined(CONFIG_X86)
543#define GEN_ABSOLUTE_SYM(name, value) \
544 __asm__(".globl\t" #name "\n\t.equ\t" #name \
546 "\n\t.type\t" #name ",@object" : : "n"(value))
548#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
549 __asm__(".globl\t" #name \
550 "\n\t.equ\t" #name "," #value \
551 "\n\t.type\t" #name ",@object")
553#elif defined(CONFIG_ARC) || defined(CONFIG_ARM64)
555#define GEN_ABSOLUTE_SYM(name, value) \
556 __asm__(".globl\t" #name "\n\t.equ\t" #name \
558 "\n\t.type\t" #name ",@object" : : "n"(value))
560#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
561 __asm__(".globl\t" #name \
562 "\n\t.equ\t" #name "," #value \
563 "\n\t.type\t" #name ",@object")
565#elif defined(CONFIG_RISCV) || defined(CONFIG_XTENSA) || defined(CONFIG_MIPS)
568#define GEN_ABSOLUTE_SYM(name, value) \
569 __asm__(".globl\t" #name "\n\t.equ\t" #name \
571 "\n\t.type\t" #name ",%%object" : : "n"(value))
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")
578#elif defined(CONFIG_ARCH_POSIX)
579#define GEN_ABSOLUTE_SYM(name, value) \
580 __asm__(".globl\t" #name "\n\t.equ\t" #name \
582 "\n\t.type\t" #name ",@object" : : "n"(value))
584#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
585 __asm__(".globl\t" #name \
586 "\n\t.equ\t" #name "," #value \
587 "\n\t.type\t" #name ",@object")
589#elif defined(CONFIG_SPARC)
590#define GEN_ABSOLUTE_SYM(name, value) \
591 __asm__(".global\t" #name "\n\t.equ\t" #name \
593 "\n\t.type\t" #name ",#object" : : "n"(value))
595#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
596 __asm__(".globl\t" #name \
597 "\n\t.equ\t" #name "," #value \
598 "\n\t.type\t" #name ",#object")
600#elif defined(CONFIG_RX)
601#define GEN_ABSOLUTE_SYM(name, value) \
602 __asm__(".global\t" #name "\n\t.equ\t" #name \
604 "\n\t.type\t" #name ",%%object" : : "n"(value))
606#define GEN_ABSOLUTE_SYM_KCONFIG(name, value) \
607 __asm__(".global\t" #name \
608 "\n\t.equ\t" #name "," #value \
609 "\n\t.type\t" #name ",#object")
612#error processor architecture not supported
615#define compiler_barrier() do { \
616 __asm__ __volatile__ ("" ::: "memory"); \
628#define Z_MAX(a, b) ({ \
630 __typeof__(a) _value_a_ = (a); \
631 __typeof__(b) _value_b_ = (b); \
632 (_value_a_ > _value_b_) ? _value_a_ : _value_b_; \
640#define Z_MIN(a, b) ({ \
642 __typeof__(a) _value_a_ = (a); \
643 __typeof__(b) _value_b_ = (b); \
644 (_value_a_ < _value_b_) ? _value_a_ : _value_b_; \
652#define Z_CLAMP(val, low, high) ({ \
654 __typeof__(val) _value_val_ = (val); \
655 __typeof__(low) _value_low_ = (low); \
656 __typeof__(high) _value_high_ = (high); \
657 (_value_val_ < _value_low_) ? _value_low_ : \
658 (_value_val_ > _value_high_) ? _value_high_ : \
668#define Z_POW2_CEIL(x) \
669 ((x) <= 2UL ? (x) : (1UL << (8 * sizeof(long) - __builtin_clzl((x) - 1))))
677#define Z_IS_POW2(x) (((x) != 0) && (((x) & ((x)-1)) == 0))
679#if defined(CONFIG_ASAN) && defined(__clang__)
680#define __noasan __attribute__((no_sanitize("address")))
685#if defined(CONFIG_UBSAN)
686#define __noubsan __attribute__((no_sanitize("undefined")))
696#if (TOOLCHAIN_GCC_VERSION >= 110000) || \
697 (defined(TOOLCHAIN_CLANG_VERSION) && (TOOLCHAIN_CLANG_VERSION >= 70000))
698#define FUNC_NO_STACK_PROTECTOR __attribute__((no_stack_protector))
700#define FUNC_NO_STACK_PROTECTOR
705#define TOOLCHAIN_WARNING_ADDRESS_OF_PACKED_MEMBER "-Waddress-of-packed-member"
706#define TOOLCHAIN_WARNING_ARRAY_BOUNDS "-Warray-bounds"
707#define TOOLCHAIN_WARNING_ATTRIBUTES "-Wattributes"
708#define TOOLCHAIN_WARNING_DELETE_NON_VIRTUAL_DTOR "-Wdelete-non-virtual-dtor"
709#define TOOLCHAIN_WARNING_EXTRA "-Wextra"
710#define TOOLCHAIN_WARNING_NONNULL "-Wnonnull"
711#define TOOLCHAIN_WARNING_SHADOW "-Wshadow"
712#define TOOLCHAIN_WARNING_UNUSED_LABEL "-Wunused-label"
713#define TOOLCHAIN_WARNING_UNUSED_VARIABLE "-Wunused-variable"
716#if defined(__GNUC__) && !defined(__clang__)
717#define TOOLCHAIN_WARNING_POINTER_ARITH "-Wpointer-arith"
718#define TOOLCHAIN_WARNING_STRINGOP_OVERREAD "-Wstringop-overread"
721#define _TOOLCHAIN_DISABLE_WARNING(compiler, warning) \
722 TOOLCHAIN_PRAGMA(compiler diagnostic push) \
723 TOOLCHAIN_PRAGMA(compiler diagnostic ignored warning)
725#define _TOOLCHAIN_ENABLE_WARNING(compiler, warning) TOOLCHAIN_PRAGMA(compiler diagnostic pop)
727#define TOOLCHAIN_DISABLE_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
728#define TOOLCHAIN_ENABLE_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)
730#if defined(__GNUC__) && !defined(__clang__)
731#define TOOLCHAIN_DISABLE_GCC_WARNING(warning) _TOOLCHAIN_DISABLE_WARNING(GCC, warning)
732#define TOOLCHAIN_ENABLE_GCC_WARNING(warning) _TOOLCHAIN_ENABLE_WARNING(GCC, warning)