L4Re Operating System Framework
Interface and Usage Documentation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
compiler.h
Go to the documentation of this file.
1/*****************************************************************************/
7/*
8 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
9 * Alexander Warg <warg@os.inf.tu-dresden.de>,
10 * Frank Mehnert <fm3@os.inf.tu-dresden.de>,
11 * Jork Löser <jork@os.inf.tu-dresden.de>,
12 * Ronald Aigner <ra3@os.inf.tu-dresden.de>
13 * economic rights: Technische Universität Dresden (Germany)
14 *
15 * License: see LICENSE.spdx (in this directory or the directories above)
16 */
17/*****************************************************************************/
18#ifndef __L4_COMPILER_H__
19#define __L4_COMPILER_H__
20
21#if !defined(__ASSEMBLY__) && !defined(__ASSEMBLER__)
22
34#ifndef L4_INLINE
35#ifndef __cplusplus
36# ifdef __OPTIMIZE__
37# define L4_INLINE_STATIC static __inline__
38# define L4_INLINE_EXTERN extern __inline__
39# ifdef __GNUC_STDC_INLINE__
40# define L4_INLINE L4_INLINE_STATIC
41# else
42# define L4_INLINE L4_INLINE_EXTERN
43# endif
44# else /* ! __OPTIMIZE__ */
45# define L4_INLINE static
46# endif /* ! __OPTIMIZE__ */
47#else /* __cplusplus */
48# define L4_INLINE inline
49#endif /* __cplusplus */
50#elif defined DOXYGEN
51# define L4_INLINE inline
52#endif /* L4_INLINE */
53
58#define L4_ALWAYS_INLINE L4_INLINE __attribute__((__always_inline__))
59
60
61#define L4_DECLARE_CONSTRUCTOR(func, prio) \
62 static inline __attribute__((constructor(prio))) void func ## _ctor_func(void) { func(); }
63
64
147#ifndef __cplusplus
148# define L4_NOTHROW__A __attribute__((nothrow))
149# define L4_NOTHROW
150# ifndef __BEGIN_DECLS
151# define __BEGIN_DECLS
152# endif
153# ifndef __END_DECLS
154# define __END_DECLS
155# endif
156# define L4_BEGIN_DECLS
157# define L4_END_DECLS
158# define L4_DEFAULT_PARAM(x)
159#else /* __cplusplus */
160# if __cplusplus >= 201103L
161# define L4_NOTHROW noexcept
162# else /* C++ < 11 */
163# define L4_NOTHROW throw()
164# endif
165# define L4_BEGIN_DECLS extern "C" {
166# define L4_END_DECLS }
167# if !defined __BEGIN_DECLS || defined DOXYGEN
168# define __BEGIN_DECLS extern "C" {
169# endif
170# if !defined __END_DECLS || defined DOXYGEN
171# define __END_DECLS }
172# endif
173# define L4_DEFAULT_PARAM(x) = x
174#endif /* __cplusplus */
175
176/* Depration hints during compile -- remove later (2025+) */
177#ifndef EXTERN_C
178#define EXTERN_C DO_NOT_USE_EXTERN_C_ANY_MORE
179#endif
180#ifndef EXTERN_C_BEGIN
181#define EXTERN_C_BEGIN DO_NOT_USE_EXTERN_C_BEGIN_ANY_MORE__USE_L4_BEGIN_DECLS
182#endif
183#ifndef EXTERN_C_END
184#define EXTERN_C_END DO_NOT_USE_EXTERN_C_END_ANY_MORE__USE_L4_END_DECLS
185#endif
186
191#if defined __cplusplus && __cplusplus >= 201402L
192# define L4_CONSTEXPR constexpr
193#else
194# define L4_CONSTEXPR
195#endif
196
201#define L4_NORETURN __attribute__((noreturn))
202
203#define L4_PURE __attribute__((pure))
204
209#define L4_NOINSTRUMENT __attribute__((no_instrument_function))
210#ifndef L4_HIDDEN
211# define L4_HIDDEN __attribute__((visibility("hidden")))
212#endif
213#if !defined L4_EXPORT || defined DOXYGEN
214# define L4_EXPORT __attribute__((visibility("default")))
215#endif
216#ifndef L4_EXPORT_TYPE
217# ifdef __cplusplus
218# define L4_EXPORT_TYPE __attribute__((visibility("default")))
219# else
220# define L4_EXPORT_TYPE
221# endif
222#endif
223#define L4_STRONG_ALIAS(name, aliasname) L4__STRONG_ALIAS(name, aliasname)
224#ifdef __clang__
225#define L4__STRONG_ALIAS(name, aliasname) \
226 extern __typeof (name) aliasname __attribute__ ((alias (#name)));
227#else
228#define L4__STRONG_ALIAS(name, aliasname) \
229 extern __typeof (name) aliasname __attribute__ ((alias (#name), copy(name)));
230#endif
231
239#if defined(__i386__) || defined(__amd64__) || \
240 defined(__arm__) || defined(__aarch64__) || \
241 defined(__mips__) || defined(__riscv) || \
242 defined(__powerpc__) || defined(__sparc__)
243# define L4_STACK_ALIGN __BIGGEST_ALIGNMENT__
244#else
245# error Define L4_STACK_ALIGN for this target!
246#endif
247
265#if defined(__i386__) || defined(__amd64__)
266L4_INLINE unsigned long l4_align_stack_for_direct_fncall(unsigned long stack)
267{
268 if ((stack & (L4_STACK_ALIGN - 1)) == (L4_STACK_ALIGN - sizeof(unsigned long)))
269 return stack;
270 return (stack & ~(L4_STACK_ALIGN)) - sizeof(unsigned long);
271}
272#else
273L4_INLINE unsigned long l4_align_stack_for_direct_fncall(unsigned long stack)
274{
275 return stack & ~(L4_STACK_ALIGN);
276}
277#endif
278
279#endif /* !__ASSEMBLY__ */
280
281#include <l4/sys/linkage.h>
282
283#define L4_LIKELY(x) __builtin_expect((x),1)
284#define L4_UNLIKELY(x) __builtin_expect((x),0)
285
286/* Make sure that the function is not removed by optimization. Without the
287 * "used" attribute, unreferenced static functions are removed. */
288#define L4_STICKY(x) __attribute__((used)) x
289#define L4_DEPRECATED(s) __attribute__((deprecated(s)))
290
291#ifndef static_assert
292# if !defined(__cplusplus)
293# define static_assert(x, y) _Static_assert(x, y)
294# elif __cplusplus < 201103L
295# define static_assert(x, y) \
296 extern int l4_static_assert[-(!(x))] __attribute__((unused))
297# endif
298#endif
299
300#define L4_stringify_helper(x) #x
301#define L4_stringify(x) L4_stringify_helper(x)
302
303#ifdef __has_builtin
304#define L4_HAS_BUILTIN(def) __has_builtin(def)
305#else
306#define L4_HAS_BUILTIN(def) 0
307#endif
308
309#ifndef __ASSEMBLER__
313L4_INLINE void l4_barrier(void);
314
318L4_INLINE void l4_mb(void);
319
323L4_INLINE void l4_wmb(void);
324
329
330
331/* Implementations */
333{
334 __asm__ __volatile__ ("" : : : "memory");
335}
336
337L4_INLINE void l4_mb(void)
338{
339 __asm__ __volatile__ ("" : : : "memory");
340}
341
343{
344 __asm__ __volatile__ ("" : : : "memory");
345}
346
348{
349 while (1)
350 l4_barrier();
351}
352#endif
353
356#endif /* !__L4_COMPILER_H__ */
void l4_wmb(void)
Write memory barrier.
Definition compiler.h:342
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:51
void l4_barrier(void)
Memory barrier.
Definition compiler.h:332
void l4_mb(void)
Memory barrier.
Definition compiler.h:337
unsigned long l4_align_stack_for_direct_fncall(unsigned long stack)
Specify the desired alignment of the stack pointer.
Definition compiler.h:273
L4_NORETURN void l4_infinite_loop(void)
Infinite loop.
Definition compiler.h:347
#define L4_NORETURN
Noreturn function attribute.
Definition compiler.h:201