Text file
src/runtime/race_s390x.s
Documentation: runtime
1// Copyright 2021 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
5//go:build race
6
7#include "go_asm.h"
8#include "funcdata.h"
9#include "textflag.h"
10
11// The following thunks allow calling the gcc-compiled race runtime directly
12// from Go code without going all the way through cgo.
13// First, it's much faster (up to 50% speedup for real Go programs).
14// Second, it eliminates race-related special cases from cgocall and scheduler.
15// Third, in long-term it will allow to remove cyclic runtime/race dependency on cmd/go.
16
17// A brief recap of the s390x C calling convention.
18// Arguments are passed in R2...R6, the rest is on stack.
19// Callee-saved registers are: R6...R13, R15.
20// Temporary registers are: R0...R5, R14.
21
22// When calling racecalladdr, R1 is the call target address.
23
24// The race ctx, ThreadState *thr below, is passed in R2 and loaded in racecalladdr.
25
26// func runtime·raceread(addr uintptr)
27// Called from instrumented code.
28TEXT runtime·raceread(SB), NOSPLIT, $0-8
29 // void __tsan_read(ThreadState *thr, void *addr, void *pc);
30 MOVD $__tsan_read(SB), R1
31 MOVD addr+0(FP), R3
32 MOVD R14, R4
33 JMP racecalladdr<>(SB)
34
35// func runtime·RaceRead(addr uintptr)
36TEXT runtime·RaceRead(SB), NOSPLIT, $0-8
37 // This needs to be a tail call, because raceread reads caller pc.
38 JMP runtime·raceread(SB)
39
40// func runtime·racereadpc(void *addr, void *callpc, void *pc)
41TEXT runtime·racereadpc(SB), NOSPLIT, $0-24
42 // void __tsan_read_pc(ThreadState *thr, void *addr, void *callpc, void *pc);
43 MOVD $__tsan_read_pc(SB), R1
44 LMG addr+0(FP), R3, R5
45 JMP racecalladdr<>(SB)
46
47// func runtime·racewrite(addr uintptr)
48// Called from instrumented code.
49TEXT runtime·racewrite(SB), NOSPLIT, $0-8
50 // void __tsan_write(ThreadState *thr, void *addr, void *pc);
51 MOVD $__tsan_write(SB), R1
52 MOVD addr+0(FP), R3
53 MOVD R14, R4
54 JMP racecalladdr<>(SB)
55
56// func runtime·RaceWrite(addr uintptr)
57TEXT runtime·RaceWrite(SB), NOSPLIT, $0-8
58 // This needs to be a tail call, because racewrite reads caller pc.
59 JMP runtime·racewrite(SB)
60
61// func runtime·racewritepc(void *addr, void *callpc, void *pc)
62TEXT runtime·racewritepc(SB), NOSPLIT, $0-24
63 // void __tsan_write_pc(ThreadState *thr, void *addr, void *callpc, void *pc);
64 MOVD $__tsan_write_pc(SB), R1
65 LMG addr+0(FP), R3, R5
66 JMP racecalladdr<>(SB)
67
68// func runtime·racereadrange(addr, size uintptr)
69// Called from instrumented code.
70TEXT runtime·racereadrange(SB), NOSPLIT, $0-16
71 // void __tsan_read_range(ThreadState *thr, void *addr, uintptr size, void *pc);
72 MOVD $__tsan_read_range(SB), R1
73 LMG addr+0(FP), R3, R4
74 MOVD R14, R5
75 JMP racecalladdr<>(SB)
76
77// func runtime·RaceReadRange(addr, size uintptr)
78TEXT runtime·RaceReadRange(SB), NOSPLIT, $0-16
79 // This needs to be a tail call, because racereadrange reads caller pc.
80 JMP runtime·racereadrange(SB)
81
82// func runtime·racereadrangepc1(void *addr, uintptr sz, void *pc)
83TEXT runtime·racereadrangepc1(SB), NOSPLIT, $0-24
84 // void __tsan_read_range(ThreadState *thr, void *addr, uintptr size, void *pc);
85 MOVD $__tsan_read_range(SB), R1
86 LMG addr+0(FP), R3, R5
87 // pc is an interceptor address, but TSan expects it to point to the
88 // middle of an interceptor (see LLVM's SCOPED_INTERCEPTOR_RAW).
89 ADD $2, R5
90 JMP racecalladdr<>(SB)
91
92// func runtime·racewriterange(addr, size uintptr)
93// Called from instrumented code.
94TEXT runtime·racewriterange(SB), NOSPLIT, $0-16
95 // void __tsan_write_range(ThreadState *thr, void *addr, uintptr size, void *pc);
96 MOVD $__tsan_write_range(SB), R1
97 LMG addr+0(FP), R3, R4
98 MOVD R14, R5
99 JMP racecalladdr<>(SB)
100
101// func runtime·RaceWriteRange(addr, size uintptr)
102TEXT runtime·RaceWriteRange(SB), NOSPLIT, $0-16
103 // This needs to be a tail call, because racewriterange reads caller pc.
104 JMP runtime·racewriterange(SB)
105
106// func runtime·racewriterangepc1(void *addr, uintptr sz, void *pc)
107TEXT runtime·racewriterangepc1(SB), NOSPLIT, $0-24
108 // void __tsan_write_range(ThreadState *thr, void *addr, uintptr size, void *pc);
109 MOVD $__tsan_write_range(SB), R1
110 LMG addr+0(FP), R3, R5
111 // pc is an interceptor address, but TSan expects it to point to the
112 // middle of an interceptor (see LLVM's SCOPED_INTERCEPTOR_RAW).
113 ADD $2, R5
114 JMP racecalladdr<>(SB)
115
116// If R3 is out of range, do nothing. Otherwise, setup goroutine context and
117// invoke racecall. Other arguments are already set.
118TEXT racecalladdr<>(SB), NOSPLIT, $0-0
119 MOVD runtime·racearenastart(SB), R0
120 CMPUBLT R3, R0, data // Before racearena start?
121 MOVD runtime·racearenaend(SB), R0
122 CMPUBLT R3, R0, call // Before racearena end?
123data:
124 MOVD runtime·racedatastart(SB), R0
125 CMPUBLT R3, R0, ret // Before racedata start?
126 MOVD runtime·racedataend(SB), R0
127 CMPUBGE R3, R0, ret // At or after racedata end?
128call:
129 MOVD g_racectx(g), R2
130 JMP racecall<>(SB)
131ret:
132 RET
133
134// func runtime·racefuncenter(pc uintptr)
135// Called from instrumented code.
136TEXT runtime·racefuncenter(SB), NOSPLIT, $0-8
137 MOVD callpc+0(FP), R3
138 JMP racefuncenter<>(SB)
139
140// Common code for racefuncenter
141// R3 = caller's return address
142TEXT racefuncenter<>(SB), NOSPLIT, $0-0
143 // void __tsan_func_enter(ThreadState *thr, void *pc);
144 MOVD $__tsan_func_enter(SB), R1
145 MOVD g_racectx(g), R2
146 BL racecall<>(SB)
147 RET
148
149// func runtime·racefuncexit()
150// Called from instrumented code.
151TEXT runtime·racefuncexit(SB), NOSPLIT, $0-0
152 // void __tsan_func_exit(ThreadState *thr);
153 MOVD $__tsan_func_exit(SB), R1
154 MOVD g_racectx(g), R2
155 JMP racecall<>(SB)
156
157// Atomic operations for sync/atomic package.
158
159// Load
160
161TEXT sync∕atomic·LoadInt32(SB), NOSPLIT, $0-12
162 GO_ARGS
163 MOVD $__tsan_go_atomic32_load(SB), R1
164 BL racecallatomic<>(SB)
165 RET
166
167TEXT sync∕atomic·LoadInt64(SB), NOSPLIT, $0-16
168 GO_ARGS
169 MOVD $__tsan_go_atomic64_load(SB), R1
170 BL racecallatomic<>(SB)
171 RET
172
173TEXT sync∕atomic·LoadUint32(SB), NOSPLIT, $0-12
174 GO_ARGS
175 JMP sync∕atomic·LoadInt32(SB)
176
177TEXT sync∕atomic·LoadUint64(SB), NOSPLIT, $0-16
178 GO_ARGS
179 JMP sync∕atomic·LoadInt64(SB)
180
181TEXT sync∕atomic·LoadUintptr(SB), NOSPLIT, $0-16
182 GO_ARGS
183 JMP sync∕atomic·LoadInt64(SB)
184
185TEXT sync∕atomic·LoadPointer(SB), NOSPLIT, $0-16
186 GO_ARGS
187 JMP sync∕atomic·LoadInt64(SB)
188
189// Store
190
191TEXT sync∕atomic·StoreInt32(SB), NOSPLIT, $0-12
192 GO_ARGS
193 MOVD $__tsan_go_atomic32_store(SB), R1
194 BL racecallatomic<>(SB)
195 RET
196
197TEXT sync∕atomic·StoreInt64(SB), NOSPLIT, $0-16
198 GO_ARGS
199 MOVD $__tsan_go_atomic64_store(SB), R1
200 BL racecallatomic<>(SB)
201 RET
202
203TEXT sync∕atomic·StoreUint32(SB), NOSPLIT, $0-12
204 GO_ARGS
205 JMP sync∕atomic·StoreInt32(SB)
206
207TEXT sync∕atomic·StoreUint64(SB), NOSPLIT, $0-16
208 GO_ARGS
209 JMP sync∕atomic·StoreInt64(SB)
210
211TEXT sync∕atomic·StoreUintptr(SB), NOSPLIT, $0-16
212 GO_ARGS
213 JMP sync∕atomic·StoreInt64(SB)
214
215// Swap
216
217TEXT sync∕atomic·SwapInt32(SB), NOSPLIT, $0-20
218 GO_ARGS
219 MOVD $__tsan_go_atomic32_exchange(SB), R1
220 BL racecallatomic<>(SB)
221 RET
222
223TEXT sync∕atomic·SwapInt64(SB), NOSPLIT, $0-24
224 GO_ARGS
225 MOVD $__tsan_go_atomic64_exchange(SB), R1
226 BL racecallatomic<>(SB)
227 RET
228
229TEXT sync∕atomic·SwapUint32(SB), NOSPLIT, $0-20
230 GO_ARGS
231 JMP sync∕atomic·SwapInt32(SB)
232
233TEXT sync∕atomic·SwapUint64(SB), NOSPLIT, $0-24
234 GO_ARGS
235 JMP sync∕atomic·SwapInt64(SB)
236
237TEXT sync∕atomic·SwapUintptr(SB), NOSPLIT, $0-24
238 GO_ARGS
239 JMP sync∕atomic·SwapInt64(SB)
240
241// Add
242
243TEXT sync∕atomic·AddInt32(SB), NOSPLIT, $0-20
244 GO_ARGS
245 MOVD $__tsan_go_atomic32_fetch_add(SB), R1
246 BL racecallatomic<>(SB)
247 // TSan performed fetch_add, but Go needs add_fetch.
248 MOVW add+8(FP), R0
249 MOVW ret+16(FP), R1
250 ADD R0, R1, R0
251 MOVW R0, ret+16(FP)
252 RET
253
254TEXT sync∕atomic·AddInt64(SB), NOSPLIT, $0-24
255 GO_ARGS
256 MOVD $__tsan_go_atomic64_fetch_add(SB), R1
257 BL racecallatomic<>(SB)
258 // TSan performed fetch_add, but Go needs add_fetch.
259 MOVD add+8(FP), R0
260 MOVD ret+16(FP), R1
261 ADD R0, R1, R0
262 MOVD R0, ret+16(FP)
263 RET
264
265TEXT sync∕atomic·AddUint32(SB), NOSPLIT, $0-20
266 GO_ARGS
267 JMP sync∕atomic·AddInt32(SB)
268
269TEXT sync∕atomic·AddUint64(SB), NOSPLIT, $0-24
270 GO_ARGS
271 JMP sync∕atomic·AddInt64(SB)
272
273TEXT sync∕atomic·AddUintptr(SB), NOSPLIT, $0-24
274 GO_ARGS
275 JMP sync∕atomic·AddInt64(SB)
276
277// CompareAndSwap
278
279TEXT sync∕atomic·CompareAndSwapInt32(SB), NOSPLIT, $0-17
280 GO_ARGS
281 MOVD $__tsan_go_atomic32_compare_exchange(SB), R1
282 BL racecallatomic<>(SB)
283 RET
284
285TEXT sync∕atomic·CompareAndSwapInt64(SB), NOSPLIT, $0-25
286 GO_ARGS
287 MOVD $__tsan_go_atomic64_compare_exchange(SB), R1
288 BL racecallatomic<>(SB)
289 RET
290
291TEXT sync∕atomic·CompareAndSwapUint32(SB), NOSPLIT, $0-17
292 GO_ARGS
293 JMP sync∕atomic·CompareAndSwapInt32(SB)
294
295TEXT sync∕atomic·CompareAndSwapUint64(SB), NOSPLIT, $0-25
296 GO_ARGS
297 JMP sync∕atomic·CompareAndSwapInt64(SB)
298
299TEXT sync∕atomic·CompareAndSwapUintptr(SB), NOSPLIT, $0-25
300 GO_ARGS
301 JMP sync∕atomic·CompareAndSwapInt64(SB)
302
303// Common code for atomic operations. Calls R1.
304TEXT racecallatomic<>(SB), NOSPLIT, $0
305 MOVD 24(R15), R5 // Address (arg1, after 2xBL).
306 // If we pass an invalid pointer to the TSan runtime, it will cause a
307 // "fatal error: unknown caller pc". So trigger a SEGV here instead.
308 MOVB (R5), R0
309 MOVD runtime·racearenastart(SB), R0
310 CMPUBLT R5, R0, racecallatomic_data // Before racearena start?
311 MOVD runtime·racearenaend(SB), R0
312 CMPUBLT R5, R0, racecallatomic_ok // Before racearena end?
313racecallatomic_data:
314 MOVD runtime·racedatastart(SB), R0
315 CMPUBLT R5, R0, racecallatomic_ignore // Before racedata start?
316 MOVD runtime·racedataend(SB), R0
317 CMPUBGE R5, R0, racecallatomic_ignore // At or after racearena end?
318racecallatomic_ok:
319 MOVD g_racectx(g), R2 // ThreadState *.
320 MOVD 8(R15), R3 // Caller PC.
321 MOVD R14, R4 // PC.
322 ADD $24, R15, R5 // Arguments.
323 // Tail call fails to restore R15, so use a normal one.
324 BL racecall<>(SB)
325 RET
326racecallatomic_ignore:
327 // Call __tsan_go_ignore_sync_begin to ignore synchronization during
328 // the atomic op. An attempt to synchronize on the address would cause
329 // a crash.
330 MOVD R1, R6 // Save target function.
331 MOVD R14, R7 // Save PC.
332 MOVD $__tsan_go_ignore_sync_begin(SB), R1
333 MOVD g_racectx(g), R2 // ThreadState *.
334 BL racecall<>(SB)
335 MOVD R6, R1 // Restore target function.
336 MOVD g_racectx(g), R2 // ThreadState *.
337 MOVD 8(R15), R3 // Caller PC.
338 MOVD R7, R4 // PC.
339 ADD $24, R15, R5 // Arguments.
340 BL racecall<>(SB)
341 MOVD $__tsan_go_ignore_sync_end(SB), R1
342 MOVD g_racectx(g), R2 // ThreadState *.
343 BL racecall<>(SB)
344 RET
345
346// func runtime·racecall(void(*f)(...), ...)
347// Calls C function f from race runtime and passes up to 4 arguments to it.
348// The arguments are never heap-object-preserving pointers, so we pretend there
349// are no arguments.
350TEXT runtime·racecall(SB), NOSPLIT, $0-0
351 MOVD fn+0(FP), R1
352 MOVD arg0+8(FP), R2
353 MOVD arg1+16(FP), R3
354 MOVD arg2+24(FP), R4
355 MOVD arg3+32(FP), R5
356 JMP racecall<>(SB)
357
358// Switches SP to g0 stack and calls R1. Arguments are already set.
359TEXT racecall<>(SB), NOSPLIT, $0-0
360 BL runtime·save_g(SB) // Save g for callbacks.
361 MOVD R15, R7 // Save SP.
362 MOVD g_m(g), R8 // R8 = thread.
363 MOVD m_g0(R8), R8 // R8 = g0.
364 CMPBEQ R8, g, call // Already on g0?
365 MOVD (g_sched+gobuf_sp)(R8), R15 // Switch SP to g0.
366call: SUB $160, R15 // Allocate C frame.
367 BL R1 // Call C code.
368 MOVD R7, R15 // Restore SP.
369 RET // Return to Go.
370
371// C->Go callback thunk that allows to call runtime·racesymbolize from C
372// code. racecall has only switched SP, finish g->g0 switch by setting correct
373// g. R2 contains command code, R3 contains command-specific context. See
374// racecallback for command codes.
375TEXT runtime·racecallbackthunk(SB), NOSPLIT|NOFRAME, $0
376 STMG R6, R15, 48(R15) // Save non-volatile regs.
377 BL runtime·load_g(SB) // Saved by racecall.
378 CMPBNE R2, $0, rest // raceGetProcCmd?
379 MOVD g_m(g), R2 // R2 = thread.
380 MOVD m_p(R2), R2 // R2 = processor.
381 MVC $8, p_raceprocctx(R2), (R3) // *R3 = ThreadState *.
382 LMG 48(R15), R6, R15 // Restore non-volatile regs.
383 BR R14 // Return to C.
384rest: MOVD g_m(g), R4 // R4 = current thread.
385 MOVD m_g0(R4), g // Switch to g0.
386 SUB $24, R15 // Allocate Go argument slots.
387 STMG R2, R3, 8(R15) // Fill Go frame.
388 BL runtime·racecallback(SB) // Call Go code.
389 LMG 72(R15), R6, R15 // Restore non-volatile regs.
390 BR R14 // Return to C.
View as plain text