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#")))
132#define UNALIGNED_GET(g) \
134 struct __attribute__((__packed__)) { \
135 __typeof__(*(g)) __v; \
136 } *__g = (__typeof__(__g)) (g); \
141#if (__GNUC__ >= 7) && (defined(CONFIG_ARM) || defined(CONFIG_ARM64))
152#define UNALIGNED_PUT(v, p) \
154 struct __attribute__((__packed__)) { \
155 __typeof__(*p) __v; \
156 } *__p = (__typeof__(__p)) (p); \
158 compiler_barrier(); \
163#define UNALIGNED_PUT(v, p) \
165 struct __attribute__((__packed__)) { \
166 __typeof__(*p) __v; \
167 } *__p = (__typeof__(__p)) (p); \
176#define __GENERIC_SECTION(segment) __attribute__((section(STRINGIFY(segment))))
177#define Z_GENERIC_SECTION(segment) __GENERIC_SECTION(segment)
179#define __GENERIC_DOT_SECTION(segment) \
180 __attribute__((section("." STRINGIFY(segment))))
181#define Z_GENERIC_DOT_SECTION(segment) __GENERIC_DOT_SECTION(segment)
183#define ___in_section(a, b, c) \
184 __attribute__((section("." Z_STRINGIFY(a) \
186 "." Z_STRINGIFY(c))))
187#define __in_section(a, b, c) ___in_section(a, b, c)
189#define __in_section_unique(seg) ___in_section(seg, __FILE__, __COUNTER__)
191#define __in_section_unique_named(seg, name) \
192 ___in_section(seg, __FILE__, name)
200#if !defined(CONFIG_XIP)
202#elif defined(CONFIG_ARCH_HAS_RAMFUNC_SUPPORT)
203#if defined(CONFIG_ARM)
204#define __ramfunc __attribute__((noinline)) \
205 __attribute__((long_call, section(".ramfunc")))
207#define __ramfunc __attribute__((noinline)) \
208 __attribute__((section(".ramfunc")))
214#define __fallthrough __attribute__((fallthrough))
221#define __packed __attribute__((__packed__))
225#define __aligned(x) __attribute__((__aligned__(x)))
228#define __may_alias __attribute__((__may_alias__))
231#ifdef CONFIG_ENFORCE_ZEPHYR_STDINT
232#define __printf_like(f, a) __attribute__((format (printf, f, a)))
243#define __printf_like(f, a)
247#define __used __attribute__((__used__))
248#define __unused __attribute__((__unused__))
249#define __maybe_unused __attribute__((__unused__))
252#define __deprecated __attribute__((deprecated))
258#ifndef __attribute_const__
259#define __attribute_const__ __attribute__((__const__))
263#define __must_check __attribute__((warn_unused_result))
266#define ARG_UNUSED(x) (void)(x)
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)
272#ifndef __no_optimization
273#define __no_optimization __attribute__((optimize("-O0")))
277#define __weak __attribute__((__weak__))
280#ifndef __attribute_nonnull
281#define __attribute_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
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
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
312#define __WARN(msg) __WARN1(GCC warning msg)
313#define __WARN1(s) _Pragma(#s)
316#ifndef __DEPRECATED_MACRO
317#define __DEPRECATED_MACRO __WARN("Macro is deprecated")
325#if defined(_ASMLANGUAGE)
327#if defined(CONFIG_ARM)
329#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
331#define FUNC_CODE() .thumb;
336#define FUNC_CODE() .code 32;
357#if defined(_ASMLANGUAGE)
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)
372.macro glbl_text symbol
374 .type \symbol, %function
377.macro glbl_data symbol
379 .type \symbol, %
object
382.macro weak_data symbol
384 .type \symbol, %
object
387#define GTEXT(sym) glbl_text sym
388#define GDATA(sym) glbl_data sym
389#define WDATA(sym) weak_data sym
392#define GTEXT(sym) .globl sym; .type sym, @function
393#define GDATA(sym) .globl sym; .type sym, @object
406#if defined(CONFIG_ARC)
415.macro section_var section, symbol
416 .section .\section\().\symbol
420.macro section_func section, symbol
421 .section .\section\().\symbol,
"ax"
428.macro section_subsec_func section, subsection, symbol
429 .section .\section\().\subsection,
"ax"
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
440#define SECTION_VAR(sect, sym) .section .sect.sym; sym:
441#define SECTION_FUNC(sect, sym) \
442 .section .sect.sym, "ax"; \
444 PERFOPT_ALIGN; sym : \
446#define SECTION_SUBSEC_FUNC(sect, subsec, sym) \
447 .section .sect.subsec, "ax"; PERFOPT_ALIGN; sym :
453#if defined(_ASMLANGUAGE)
454#if defined(CONFIG_ARM)
455#if defined(CONFIG_ASSEMBLER_ISA_THUMB2)
457#define _ASM_FILE_PROLOGUE .text; .syntax unified; .thumb
459#define _ASM_FILE_PROLOGUE .text; .code 32
461#elif defined(CONFIG_ARM64)
462#define _ASM_FILE_PROLOGUE .text
472#define GEN_OFFSET_EXTERN(name) extern const char name[]
474#define GEN_ABS_SYM_BEGIN(name) \
475 EXTERN_C void name(void); \
479#define GEN_ABS_SYM_END }
498#if defined(CONFIG_ARM)
508#define GEN_ABSOLUTE_SYM(name, value) \
509 __asm__(".globl\t" #name "\n\t.equ\t" #name \
511 "\n\t.type\t" #name ",%%object" : : "n"(~(value)))
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")
518#elif defined(CONFIG_X86)
520#define GEN_ABSOLUTE_SYM(name, value) \
521 __asm__(".globl\t" #name "\n\t.equ\t" #name \
523 "\n\t.type\t" #name ",@object" : : "n"(value))
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")
530#elif defined(CONFIG_ARC) || defined(CONFIG_ARM64)
532#define GEN_ABSOLUTE_SYM(name, value) \
533 __asm__(".globl\t" #name "\n\t.equ\t" #name \
535 "\n\t.type\t" #name ",@object" : : "n"(value))
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")
542#elif defined(CONFIG_NIOS2) || defined(CONFIG_RISCV) || \
543 defined(CONFIG_XTENSA) || defined(CONFIG_MIPS)
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_ARCH_POSIX)
557#define GEN_ABSOLUTE_SYM(name, value) \
558 __asm__(".globl\t" #name "\n\t.equ\t" #name \
560 "\n\t.type\t" #name ",@object" : : "n"(value))
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")
567#elif defined(CONFIG_SPARC)
568#define GEN_ABSOLUTE_SYM(name, value) \
569 __asm__(".global\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")
579#error processor architecture not supported
582#define compiler_barrier() do { \
583 __asm__ __volatile__ ("" ::: "memory"); \
595#define Z_MAX(a, b) ({ \
597 __typeof__(a) _value_a_ = (a); \
598 __typeof__(b) _value_b_ = (b); \
599 (_value_a_ > _value_b_) ? _value_a_ : _value_b_; \
607#define Z_MIN(a, b) ({ \
609 __typeof__(a) _value_a_ = (a); \
610 __typeof__(b) _value_b_ = (b); \
611 (_value_a_ < _value_b_) ? _value_a_ : _value_b_; \
619#define Z_CLAMP(val, low, high) ({ \
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_ : \
635#define Z_POW2_CEIL(x) \
636 ((x) <= 2UL ? (x) : (1UL << (8 * sizeof(long) - __builtin_clzl((x) - 1))))
644#define Z_IS_POW2(x) (((x) != 0) && (((x) & ((x)-1)) == 0))
646#if defined(CONFIG_ASAN) && defined(__clang__)
647#define __noasan __attribute__((no_sanitize("address")))
652#if defined(CONFIG_UBSAN)
653#define __noubsan __attribute__((no_sanitize("undefined")))
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))
667#define FUNC_NO_STACK_PROTECTOR
670#define TOOLCHAIN_IGNORE_WSHADOW_BEGIN \
671 _Pragma("GCC diagnostic push") \
672 _Pragma("GCC diagnostic ignored \"-Wshadow\"")
674#define TOOLCHAIN_IGNORE_WSHADOW_END \
675 _Pragma("GCC diagnostic pop")
Common toolchain abstraction.