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