blob: 8b129e314c7e15f374957e8f975e1093058ff5ef [file] [log] [blame]
Namhyung Kim8a625c12014-01-09 23:00:52 +09001#ifndef _TOOLS_LINUX_COMPILER_H_
2#define _TOOLS_LINUX_COMPILER_H_
Frederic Weisbecker5a116dd2009-10-17 17:12:33 +02003
Arnaldo Carvalho de Melo19261402017-02-10 11:41:11 -03004#ifdef __GNUC__
5#include <linux/compiler-gcc.h>
6#endif
7
Arnaldo Carvalho de Melo49006532017-02-22 16:48:24 -03008#ifndef __compiletime_error
9# define __compiletime_error(message)
10#endif
11
Arnaldo Carvalho de Melo5ac69732015-05-07 13:38:16 -030012/* Optimization barrier */
13/* The "volatile" is due to gcc bugs */
14#define barrier() __asm__ __volatile__("": : :"memory")
15
Frederic Weisbecker5a116dd2009-10-17 17:12:33 +020016#ifndef __always_inline
Ingo Molnar7a108222013-10-07 11:26:18 +020017# define __always_inline inline __attribute__((always_inline))
Frederic Weisbecker5a116dd2009-10-17 17:12:33 +020018#endif
Ingo Molnar7a108222013-10-07 11:26:18 +020019
Arnaldo Carvalho de Melo9dd4ca42017-06-16 11:39:15 -030020#ifndef noinline
21#define noinline
22#endif
23
Arnaldo Carvalho de Melof6441af2017-04-17 11:25:00 -030024/* Are two types/vars the same type (ignoring qualifiers)? */
25#ifndef __same_type
26# define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
27#endif
28
Arnaldo Carvalho de Melo8c98abf2016-07-14 12:03:04 -030029#ifdef __ANDROID__
30/*
31 * FIXME: Big hammer to get rid of tons of:
32 * "warning: always_inline function might not be inlinable"
33 *
34 * At least on android-ndk-r12/platforms/android-24/arch-arm
35 */
36#undef __always_inline
37#define __always_inline inline
38#endif
39
Frederic Weisbecker5a116dd2009-10-17 17:12:33 +020040#define __user
Matthew Wilcox12ea6532016-12-16 14:53:45 -050041#define __rcu
42#define __read_mostly
Ingo Molnar7a108222013-10-07 11:26:18 +020043
Josh Boyer195bcbf2011-08-18 07:37:21 -040044#ifndef __attribute_const__
Ingo Molnar7a108222013-10-07 11:26:18 +020045# define __attribute_const__
Josh Boyer195bcbf2011-08-18 07:37:21 -040046#endif
Frederic Weisbecker5a116dd2009-10-17 17:12:33 +020047
Irina Tirdea1d037ca2012-09-11 01:15:03 +030048#ifndef __maybe_unused
Ingo Molnar7a108222013-10-07 11:26:18 +020049# define __maybe_unused __attribute__((unused))
Irina Tirdea1d037ca2012-09-11 01:15:03 +030050#endif
Ingo Molnar7a108222013-10-07 11:26:18 +020051
52#ifndef __packed
53# define __packed __attribute__((__packed__))
54#endif
Arnaldo Carvalho de Melo618038d2010-03-25 19:58:59 -030055
Irina Tirdea86d5a702012-09-11 01:14:59 +030056#ifndef __force
Ingo Molnar7a108222013-10-07 11:26:18 +020057# define __force
Irina Tirdea86d5a702012-09-11 01:14:59 +030058#endif
59
Ingo Molnarfb1c9182013-10-01 13:26:13 +020060#ifndef __weak
61# define __weak __attribute__((weak))
62#endif
63
Namhyung Kim835d44b2014-01-09 23:00:53 +090064#ifndef likely
65# define likely(x) __builtin_expect(!!(x), 1)
66#endif
67
68#ifndef unlikely
69# define unlikely(x) __builtin_expect(!!(x), 0)
70#endif
71
Matthew Wilcox12ea6532016-12-16 14:53:45 -050072#define uninitialized_var(x) x = *(&(x))
73
Jiri Olsa73a31b72014-05-05 13:16:41 +020074#define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
75
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -030076#include <linux/types.h>
77
Jiri Olsac95f3432015-10-13 10:52:14 +020078/*
79 * Following functions are taken from kernel sources and
80 * break aliasing rules in their original form.
81 *
82 * While kernel is compiled with -fno-strict-aliasing,
83 * perf uses -Wstrict-aliasing=3 which makes build fail
84 * under gcc 4.4.
85 *
86 * Using extra __may_alias__ type to allow aliasing
87 * in this case.
88 */
89typedef __u8 __attribute__((__may_alias__)) __u8_alias_t;
90typedef __u16 __attribute__((__may_alias__)) __u16_alias_t;
91typedef __u32 __attribute__((__may_alias__)) __u32_alias_t;
92typedef __u64 __attribute__((__may_alias__)) __u64_alias_t;
93
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -030094static __always_inline void __read_once_size(const volatile void *p, void *res, int size)
95{
96 switch (size) {
Jiri Olsac95f3432015-10-13 10:52:14 +020097 case 1: *(__u8_alias_t *) res = *(volatile __u8_alias_t *) p; break;
98 case 2: *(__u16_alias_t *) res = *(volatile __u16_alias_t *) p; break;
99 case 4: *(__u32_alias_t *) res = *(volatile __u32_alias_t *) p; break;
100 case 8: *(__u64_alias_t *) res = *(volatile __u64_alias_t *) p; break;
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -0300101 default:
102 barrier();
103 __builtin_memcpy((void *)res, (const void *)p, size);
104 barrier();
105 }
106}
107
108static __always_inline void __write_once_size(volatile void *p, void *res, int size)
109{
110 switch (size) {
Jiri Olsac95f3432015-10-13 10:52:14 +0200111 case 1: *(volatile __u8_alias_t *) p = *(__u8_alias_t *) res; break;
112 case 2: *(volatile __u16_alias_t *) p = *(__u16_alias_t *) res; break;
113 case 4: *(volatile __u32_alias_t *) p = *(__u32_alias_t *) res; break;
114 case 8: *(volatile __u64_alias_t *) p = *(__u64_alias_t *) res; break;
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -0300115 default:
116 barrier();
117 __builtin_memcpy((void *)p, (const void *)res, size);
118 barrier();
119 }
120}
121
122/*
123 * Prevent the compiler from merging or refetching reads or writes. The
124 * compiler is also forbidden from reordering successive instances of
125 * READ_ONCE, WRITE_ONCE and ACCESS_ONCE (see below), but only when the
126 * compiler is aware of some particular ordering. One way to make the
127 * compiler aware of ordering is to put the two invocations of READ_ONCE,
128 * WRITE_ONCE or ACCESS_ONCE() in different C statements.
129 *
130 * In contrast to ACCESS_ONCE these two macros will also work on aggregate
131 * data types like structs or unions. If the size of the accessed data
132 * type exceeds the word size of the machine (e.g., 32 bits or 64 bits)
133 * READ_ONCE() and WRITE_ONCE() will fall back to memcpy and print a
134 * compile-time warning.
135 *
136 * Their two major use cases are: (1) Mediating communication between
137 * process-level code and irq/NMI handlers, all running on the same CPU,
138 * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
139 * mutilate accesses that either do not require ordering or that interact
140 * with an explicit memory barrier or atomic instruction that provides the
141 * required ordering.
142 */
143
144#define READ_ONCE(x) \
145 ({ union { typeof(x) __val; char __c[1]; } __u; __read_once_size(&(x), __u.__c, sizeof(x)); __u.__val; })
146
147#define WRITE_ONCE(x, val) \
148 ({ union { typeof(x) __val; char __c[1]; } __u = { .__val = (val) }; __write_once_size(&(x), __u.__c, sizeof(x)); __u.__val; })
149
Arnaldo Carvalho de Melob5bf1732017-02-08 17:01:46 -0300150
151#ifndef __fallthrough
Arnaldo Carvalho de Melo19261402017-02-10 11:41:11 -0300152# define __fallthrough
Arnaldo Carvalho de Melob5bf1732017-02-08 17:01:46 -0300153#endif
154
Namhyung Kim8a625c12014-01-09 23:00:52 +0900155#endif /* _TOOLS_LINUX_COMPILER_H */