blob: c9e65e8faacdd0d02942b54fba9b262976d8b068 [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 Melo8c98abf2016-07-14 12:03:04 -030020#ifdef __ANDROID__
21/*
22 * FIXME: Big hammer to get rid of tons of:
23 * "warning: always_inline function might not be inlinable"
24 *
25 * At least on android-ndk-r12/platforms/android-24/arch-arm
26 */
27#undef __always_inline
28#define __always_inline inline
29#endif
30
Frederic Weisbecker5a116dd2009-10-17 17:12:33 +020031#define __user
Matthew Wilcox12ea6532016-12-16 14:53:45 -050032#define __rcu
33#define __read_mostly
Ingo Molnar7a108222013-10-07 11:26:18 +020034
Josh Boyer195bcbf2011-08-18 07:37:21 -040035#ifndef __attribute_const__
Ingo Molnar7a108222013-10-07 11:26:18 +020036# define __attribute_const__
Josh Boyer195bcbf2011-08-18 07:37:21 -040037#endif
Frederic Weisbecker5a116dd2009-10-17 17:12:33 +020038
Irina Tirdea1d037ca2012-09-11 01:15:03 +030039#ifndef __maybe_unused
Ingo Molnar7a108222013-10-07 11:26:18 +020040# define __maybe_unused __attribute__((unused))
Irina Tirdea1d037ca2012-09-11 01:15:03 +030041#endif
Ingo Molnar7a108222013-10-07 11:26:18 +020042
43#ifndef __packed
44# define __packed __attribute__((__packed__))
45#endif
Arnaldo Carvalho de Melo618038d2010-03-25 19:58:59 -030046
Irina Tirdea86d5a702012-09-11 01:14:59 +030047#ifndef __force
Ingo Molnar7a108222013-10-07 11:26:18 +020048# define __force
Irina Tirdea86d5a702012-09-11 01:14:59 +030049#endif
50
Ingo Molnarfb1c9182013-10-01 13:26:13 +020051#ifndef __weak
52# define __weak __attribute__((weak))
53#endif
54
Namhyung Kim835d44b2014-01-09 23:00:53 +090055#ifndef likely
56# define likely(x) __builtin_expect(!!(x), 1)
57#endif
58
59#ifndef unlikely
60# define unlikely(x) __builtin_expect(!!(x), 0)
61#endif
62
Matthew Wilcox12ea6532016-12-16 14:53:45 -050063#define uninitialized_var(x) x = *(&(x))
64
Jiri Olsa73a31b72014-05-05 13:16:41 +020065#define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
66
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -030067#include <linux/types.h>
68
Jiri Olsac95f3432015-10-13 10:52:14 +020069/*
70 * Following functions are taken from kernel sources and
71 * break aliasing rules in their original form.
72 *
73 * While kernel is compiled with -fno-strict-aliasing,
74 * perf uses -Wstrict-aliasing=3 which makes build fail
75 * under gcc 4.4.
76 *
77 * Using extra __may_alias__ type to allow aliasing
78 * in this case.
79 */
80typedef __u8 __attribute__((__may_alias__)) __u8_alias_t;
81typedef __u16 __attribute__((__may_alias__)) __u16_alias_t;
82typedef __u32 __attribute__((__may_alias__)) __u32_alias_t;
83typedef __u64 __attribute__((__may_alias__)) __u64_alias_t;
84
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -030085static __always_inline void __read_once_size(const volatile void *p, void *res, int size)
86{
87 switch (size) {
Jiri Olsac95f3432015-10-13 10:52:14 +020088 case 1: *(__u8_alias_t *) res = *(volatile __u8_alias_t *) p; break;
89 case 2: *(__u16_alias_t *) res = *(volatile __u16_alias_t *) p; break;
90 case 4: *(__u32_alias_t *) res = *(volatile __u32_alias_t *) p; break;
91 case 8: *(__u64_alias_t *) res = *(volatile __u64_alias_t *) p; break;
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -030092 default:
93 barrier();
94 __builtin_memcpy((void *)res, (const void *)p, size);
95 barrier();
96 }
97}
98
99static __always_inline void __write_once_size(volatile void *p, void *res, int size)
100{
101 switch (size) {
Jiri Olsac95f3432015-10-13 10:52:14 +0200102 case 1: *(volatile __u8_alias_t *) p = *(__u8_alias_t *) res; break;
103 case 2: *(volatile __u16_alias_t *) p = *(__u16_alias_t *) res; break;
104 case 4: *(volatile __u32_alias_t *) p = *(__u32_alias_t *) res; break;
105 case 8: *(volatile __u64_alias_t *) p = *(__u64_alias_t *) res; break;
Arnaldo Carvalho de Melo728abda2015-07-05 14:12:42 -0300106 default:
107 barrier();
108 __builtin_memcpy((void *)p, (const void *)res, size);
109 barrier();
110 }
111}
112
113/*
114 * Prevent the compiler from merging or refetching reads or writes. The
115 * compiler is also forbidden from reordering successive instances of
116 * READ_ONCE, WRITE_ONCE and ACCESS_ONCE (see below), but only when the
117 * compiler is aware of some particular ordering. One way to make the
118 * compiler aware of ordering is to put the two invocations of READ_ONCE,
119 * WRITE_ONCE or ACCESS_ONCE() in different C statements.
120 *
121 * In contrast to ACCESS_ONCE these two macros will also work on aggregate
122 * data types like structs or unions. If the size of the accessed data
123 * type exceeds the word size of the machine (e.g., 32 bits or 64 bits)
124 * READ_ONCE() and WRITE_ONCE() will fall back to memcpy and print a
125 * compile-time warning.
126 *
127 * Their two major use cases are: (1) Mediating communication between
128 * process-level code and irq/NMI handlers, all running on the same CPU,
129 * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
130 * mutilate accesses that either do not require ordering or that interact
131 * with an explicit memory barrier or atomic instruction that provides the
132 * required ordering.
133 */
134
135#define READ_ONCE(x) \
136 ({ union { typeof(x) __val; char __c[1]; } __u; __read_once_size(&(x), __u.__c, sizeof(x)); __u.__val; })
137
138#define WRITE_ONCE(x, val) \
139 ({ union { typeof(x) __val; char __c[1]; } __u = { .__val = (val) }; __write_once_size(&(x), __u.__c, sizeof(x)); __u.__val; })
140
Arnaldo Carvalho de Melob5bf1732017-02-08 17:01:46 -0300141
142#ifndef __fallthrough
Arnaldo Carvalho de Melo19261402017-02-10 11:41:11 -0300143# define __fallthrough
Arnaldo Carvalho de Melob5bf1732017-02-08 17:01:46 -0300144#endif
145
Namhyung Kim8a625c12014-01-09 23:00:52 +0900146#endif /* _TOOLS_LINUX_COMPILER_H */