2 * mem.spin: Promela code to validate memory barriers with OOO memory.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 * Copyright (c) 2009 Mathieu Desnoyers
21 /* Promela validation variables. */
24 * Produced process data flow. Updated after each instruction to show which
25 * variables are ready. Assigned using SSA (static single assignment) (defuse
26 * analysis must be done on the program to map "real" variables to single define
27 * followed by use). Using one-hot bit encoding per variable to save state
28 * space. Used as triggers to execute the instructions having those variables
32 #define PRODUCE_TOKENS(state, bits) \
33 state = (state) | (bits)
35 /* All bits must be active to consume. All notbits must be inactive. */
36 /* Consuming a token does not clear it, it just waits for it. */
37 #define CONSUME_TOKENS(state, bits, notbits) \
38 ((!((state) & (notbits))) && ((state) & (bits)) == (bits))
40 #define CLEAR_TOKENS(state, bits) \
41 state = (state) & ~(bits)
44 * Bit encoding, proc_one_produced :
47 #define P1_PROD_NONE (1 << 0)
49 #define P1_WRITE (1 << 1)
50 #define P1_WMB (1 << 2)
51 #define P1_SYNC_CORE (1 << 3)
52 #define P1_RMB (1 << 4)
53 #define P1_READ (1 << 5)
55 int proc_one_produced;
57 #define P2_PROD_NONE (1 << 0)
59 #define P2_WRITE (1 << 1)
60 #define P2_WMB (1 << 2)
61 #define P2_SYNC_CORE (1 << 3)
62 #define P2_RMB (1 << 4)
63 #define P2_READ (1 << 5)
65 int proc_two_produced;
69 #define get_pid() (_pid)
72 * Each process have its own data in cache. Caches are randomly updated.
73 * smp_wmb and smp_rmb forces cache updates (write and read), wmb_mb forces
77 #define DECLARE_CACHED_VAR(type, x, v) \
79 type cached_##x[NR_PROCS] = v; \
80 bit cache_dirty_##x[NR_PROCS] = 0;
82 #define IS_CACHE_DIRTY(x, id) (cache_dirty_##x[id])
84 #define READ_CACHED_VAR(x) \
85 (cached_##x[get_pid()])
87 #define WRITE_CACHED_VAR(x, v) \
89 cached_##x[get_pid()] = v; \
90 cache_dirty_##x[get_pid()] = 1; \
93 #define CACHE_WRITE_TO_MEM(x, id) \
95 :: IS_CACHE_DIRTY(x, id) -> \
96 mem_##x = cached_##x[id]; \
97 cache_dirty_##x[id] = 0; \
102 #define CACHE_READ_FROM_MEM(x, id) \
104 :: !IS_CACHE_DIRTY(x, id) -> \
105 cached_##x[id] = mem_##x; \
111 * May update other caches if cache is dirty, or not.
113 #define RANDOM_CACHE_WRITE_TO_MEM(x, id) \
115 :: 1 -> CACHE_WRITE_TO_MEM(x, id); \
119 #define RANDOM_CACHE_READ_FROM_MEM(x, id)\
121 :: 1 -> CACHE_READ_FROM_MEM(x, id); \
128 RANDOM_CACHE_WRITE_TO_MEM(alpha, get_pid());
129 RANDOM_CACHE_WRITE_TO_MEM(beta, get_pid());
130 RANDOM_CACHE_READ_FROM_MEM(alpha, get_pid());
131 RANDOM_CACHE_READ_FROM_MEM(beta, get_pid());
135 /* must consume all prior read tokens */
139 /* todo : consume all read tokens .. ? */
140 CACHE_READ_FROM_MEM(alpha, get_pid());
141 CACHE_READ_FROM_MEM(beta, get_pid());
145 /* must consume all prior write tokens */
149 CACHE_WRITE_TO_MEM(alpha, get_pid());
150 CACHE_WRITE_TO_MEM(beta, get_pid());
154 /* sync_core() must consume all prior read and write tokens, including rmb/wmb
157 /* must consume all prior read and write tokens */
167 /* Keep in sync manually with smp_rmb, wmp_wmb and ooo_mem */
168 DECLARE_CACHED_VAR(byte, alpha, 0);
169 DECLARE_CACHED_VAR(byte, beta, 0);
171 /* value 2 is uninitialized */
175 active proctype test_proc_one()
177 assert(get_pid() < NR_PROCS);
179 PRODUCE_TOKENS(proc_one_produced, P1_PROD_NONE);
182 PRODUCE_TOKENS(proc_one_produced, P1_WMB);
185 PRODUCE_TOKENS(proc_one_produced, P1_RMB);
189 :: CONSUME_TOKENS(proc_one_produced, P1_PROD_NONE, P1_WRITE) ->
191 WRITE_CACHED_VAR(alpha, 1);
193 PRODUCE_TOKENS(proc_one_produced, P1_WRITE);
194 :: CONSUME_TOKENS(proc_one_produced, P1_WRITE, P1_WMB) ->
196 PRODUCE_TOKENS(proc_one_produced, P1_WMB);
197 :: CONSUME_TOKENS(proc_one_produced, P1_WRITE | P1_WMB, P1_SYNC_CORE) ->
199 PRODUCE_TOKENS(proc_one_produced, P1_SYNC_CORE);
200 :: CONSUME_TOKENS(proc_one_produced, P1_SYNC_CORE, P1_RMB) ->
202 PRODUCE_TOKENS(proc_one_produced, P1_RMB);
203 :: CONSUME_TOKENS(proc_one_produced, P1_RMB | P1_SYNC_CORE, P1_READ) ->
205 read_one = READ_CACHED_VAR(beta);
207 PRODUCE_TOKENS(proc_one_produced, P1_READ);
208 :: CONSUME_TOKENS(proc_one_produced, P1_PROD_NONE | P1_WRITE
209 | P1_WMB | P1_SYNC_CORE | P1_RMB | P1_READ, 0) ->
213 //CLEAR_TOKENS(proc_one_produced,
214 // P1_PROD_NONE | P1_WRITE | P1_WMB | P1_SYNC_CORE | P1_RMB |
217 // test : [] (read_one == 0 -> read_two != 0)
218 // test : [] (read_two == 0 -> read_one != 0)
219 assert(!(read_one == 0 && read_two == 0));
222 active proctype test_proc_two()
224 assert(get_pid() < NR_PROCS);
226 PRODUCE_TOKENS(proc_two_produced, P2_PROD_NONE);
229 PRODUCE_TOKENS(proc_two_produced, P2_WMB);
232 PRODUCE_TOKENS(proc_two_produced, P2_RMB);
236 :: CONSUME_TOKENS(proc_two_produced, P2_PROD_NONE, P2_WRITE) ->
238 WRITE_CACHED_VAR(beta, 1);
240 PRODUCE_TOKENS(proc_two_produced, P2_WRITE);
241 :: CONSUME_TOKENS(proc_two_produced, P2_WRITE, P2_WMB) ->
243 PRODUCE_TOKENS(proc_two_produced, P2_WMB);
244 :: CONSUME_TOKENS(proc_two_produced, P2_WRITE | P2_WMB, P2_SYNC_CORE) ->
246 PRODUCE_TOKENS(proc_two_produced, P2_SYNC_CORE);
247 :: CONSUME_TOKENS(proc_two_produced, P2_SYNC_CORE, P2_RMB) ->
249 PRODUCE_TOKENS(proc_two_produced, P2_RMB);
250 :: CONSUME_TOKENS(proc_two_produced, P2_SYNC_CORE | P2_RMB, P2_READ) ->
252 read_two = READ_CACHED_VAR(alpha);
254 PRODUCE_TOKENS(proc_two_produced, P2_READ);
255 :: CONSUME_TOKENS(proc_two_produced, P2_PROD_NONE | P2_WRITE
256 | P2_WMB | P2_SYNC_CORE | P2_RMB | P2_READ, 0) ->
260 //CLEAR_TOKENS(proc_two_produced,
261 // P2_PROD_NONE | P2_WRITE | P2_WMB | P2_SYNC_CORE | P2_RMB |
264 // test : [] (read_one == 0 -> read_two != 0)
265 // test : [] (read_two == 0 -> read_one != 0)
266 assert(!(read_one == 0 && read_two == 0));