Cleanup: header comments coding style
[urcu.git] / urcu / arch / generic.h
1 #ifndef _URCU_ARCH_GENERIC_H
2 #define _URCU_ARCH_GENERIC_H
3
4 /*
5 * arch_generic.h: common definitions for multiple architectures.
6 *
7 * Copyright (c) 2010 Paolo Bonzini <pbonzini@redhat.com>
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
13 *
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24 #include <urcu/compiler.h>
25 #include <urcu/config.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #ifndef CAA_CACHE_LINE_SIZE
32 #define CAA_CACHE_LINE_SIZE 64
33 #endif
34
35 #if !defined(cmm_mc) && !defined(cmm_rmc) && !defined(cmm_wmc)
36 #define CONFIG_HAVE_MEM_COHERENCY
37 /*
38 * Architectures with cache coherency must _not_ define cmm_mc/cmm_rmc/cmm_wmc.
39 *
40 * For them, cmm_mc/cmm_rmc/cmm_wmc are implemented with a simple
41 * compiler barrier; in addition, we provide defaults for cmm_mb (using
42 * GCC builtins) as well as cmm_rmb and cmm_wmb (defaulting to cmm_mb).
43 */
44
45 #ifndef cmm_mb
46 #define cmm_mb() __sync_synchronize()
47 #endif
48
49 #ifndef cmm_rmb
50 #define cmm_rmb() cmm_mb()
51 #endif
52
53 #ifndef cmm_wmb
54 #define cmm_wmb() cmm_mb()
55 #endif
56
57 #define cmm_mc() cmm_barrier()
58 #define cmm_rmc() cmm_barrier()
59 #define cmm_wmc() cmm_barrier()
60 #else
61 /*
62 * Architectures without cache coherency need something like the following:
63 *
64 * #define cmm_mc() arch_cache_flush()
65 * #define cmm_rmc() arch_cache_flush_read()
66 * #define cmm_wmc() arch_cache_flush_write()
67 *
68 * Of these, only cmm_mc is mandatory. cmm_rmc and cmm_wmc default to
69 * cmm_mc. cmm_mb/cmm_rmb/cmm_wmb use these definitions by default:
70 *
71 * #define cmm_mb() cmm_mc()
72 * #define cmm_rmb() cmm_rmc()
73 * #define cmm_wmb() cmm_wmc()
74 */
75
76 #ifndef cmm_mb
77 #define cmm_mb() cmm_mc()
78 #endif
79
80 #ifndef cmm_rmb
81 #define cmm_rmb() cmm_rmc()
82 #endif
83
84 #ifndef cmm_wmb
85 #define cmm_wmb() cmm_wmc()
86 #endif
87
88 #ifndef cmm_rmc
89 #define cmm_rmc() cmm_mc()
90 #endif
91
92 #ifndef cmm_wmc
93 #define cmm_wmc() cmm_mc()
94 #endif
95 #endif
96
97 /* Nop everywhere except on alpha. */
98 #ifndef cmm_read_barrier_depends
99 #define cmm_read_barrier_depends()
100 #endif
101
102 #ifdef CONFIG_RCU_SMP
103 #ifndef cmm_smp_mb
104 #define cmm_smp_mb() cmm_mb()
105 #endif
106 #ifndef cmm_smp_rmb
107 #define cmm_smp_rmb() cmm_rmb()
108 #endif
109 #ifndef cmm_smp_wmb
110 #define cmm_smp_wmb() cmm_wmb()
111 #endif
112 #ifndef cmm_smp_mc
113 #define cmm_smp_mc() cmm_mc()
114 #endif
115 #ifndef cmm_smp_rmc
116 #define cmm_smp_rmc() cmm_rmc()
117 #endif
118 #ifndef cmm_smp_wmc
119 #define cmm_smp_wmc() cmm_wmc()
120 #endif
121 #ifndef cmm_smp_read_barrier_depends
122 #define cmm_smp_read_barrier_depends() cmm_read_barrier_depends()
123 #endif
124 #else
125 #ifndef cmm_smp_mb
126 #define cmm_smp_mb() cmm_barrier()
127 #endif
128 #ifndef cmm_smp_rmb
129 #define cmm_smp_rmb() cmm_barrier()
130 #endif
131 #ifndef cmm_smp_wmb
132 #define cmm_smp_wmb() cmm_barrier()
133 #endif
134 #ifndef cmm_smp_mc
135 #define cmm_smp_mc() cmm_barrier()
136 #endif
137 #ifndef cmm_smp_rmc
138 #define cmm_smp_rmc() cmm_barrier()
139 #endif
140 #ifndef cmm_smp_wmc
141 #define cmm_smp_wmc() cmm_barrier()
142 #endif
143 #ifndef cmm_smp_read_barrier_depends
144 #define cmm_smp_read_barrier_depends()
145 #endif
146 #endif
147
148 #ifndef caa_cpu_relax
149 #define caa_cpu_relax() cmm_barrier()
150 #endif
151
152 #ifdef __cplusplus
153 }
154 #endif
155
156 #endif /* _URCU_ARCH_GENERIC_H */
This page took 0.045255 seconds and 5 git commands to generate.