1 // Copyright 2015 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.
5 // Code to check that pointer writes follow the cgo rules.
6 // These functions are invoked via the write barrier when debug.cgocheck > 1.
11 "runtime/internal/sys"
15 const cgoWriteBarrierFail = "Go pointer stored into non-Go memory"
17 // cgoCheckWriteBarrier is called whenever a pointer is stored into memory.
18 // It throws if the program is storing a Go pointer into non-Go memory.
20 // This is called from the write barrier, so its entire call tree must
25 func cgoCheckWriteBarrier(dst *uintptr, src uintptr) {
26 if !cgoIsGoPointer(unsafe.Pointer(src)) {
29 if cgoIsGoPointer(unsafe.Pointer(dst)) {
33 // If we are running on the system stack then dst might be an
34 // address on the stack, which is OK.
36 if g == g.m.g0 || g == g.m.gsignal {
40 // Allocating memory can write to various mfixalloc structs
41 // that look like they are non-Go memory.
42 if g.m.mallocing != 0 {
46 // It's OK if writing to memory allocated by persistentalloc.
47 // Do this check last because it is more expensive and rarely true.
48 // If it is false the expense doesn't matter since we are crashing.
49 if inPersistentAlloc(uintptr(unsafe.Pointer(dst))) {
54 println("write of Go pointer", hex(src), "to non-Go memory", hex(uintptr(unsafe.Pointer(dst))))
55 throw(cgoWriteBarrierFail)
59 // cgoCheckMemmove is called when moving a block of memory.
60 // dst and src point off bytes into the value to copy.
61 // size is the number of bytes to copy.
62 // It throws if the program is copying a block that contains a Go pointer
63 // into non-Go memory.
66 func cgoCheckMemmove(typ *_type, dst, src unsafe.Pointer, off, size uintptr) {
70 if !cgoIsGoPointer(src) {
73 if cgoIsGoPointer(dst) {
76 cgoCheckTypedBlock(typ, src, off, size)
79 // cgoCheckSliceCopy is called when copying n elements of a slice from
80 // src to dst. typ is the element type of the slice.
81 // It throws if the program is copying slice elements that contain Go pointers
82 // into non-Go memory.
85 func cgoCheckSliceCopy(typ *_type, dst, src slice, n int) {
89 if !cgoIsGoPointer(src.array) {
92 if cgoIsGoPointer(dst.array) {
96 for i := 0; i < n; i++ {
97 cgoCheckTypedBlock(typ, p, 0, typ.size)
102 // cgoCheckTypedBlock checks the block of memory at src, for up to size bytes,
103 // and throws if it finds a Go pointer. The type of the memory is typ,
104 // and src is off bytes into that type.
107 func cgoCheckTypedBlock(typ *_type, src unsafe.Pointer, off, size uintptr) {
108 // Anything past typ.ptrdata is not a pointer.
109 if typ.ptrdata <= off {
112 if ptrdataSize := typ.ptrdata - off; size > ptrdataSize {
116 if typ.kind&kindGCProg == 0 {
117 cgoCheckBits(src, typ.gcdata, off, size)
121 // The type has a GC program. Try to find GC bits somewhere else.
122 for _, datap := range activeModules() {
123 if cgoInRange(src, datap.data, datap.edata) {
124 doff := uintptr(src) - datap.data
125 cgoCheckBits(add(src, -doff), datap.gcdatamask.bytedata, off+doff, size)
128 if cgoInRange(src, datap.bss, datap.ebss) {
129 boff := uintptr(src) - datap.bss
130 cgoCheckBits(add(src, -boff), datap.gcbssmask.bytedata, off+boff, size)
135 s := spanOfUnchecked(uintptr(src))
136 if s.state == mSpanManual {
137 // There are no heap bits for value stored on the stack.
138 // For a channel receive src might be on the stack of some
139 // other goroutine, so we can't unwind the stack even if
141 // We can't expand the GC program without extra storage
142 // space we can't easily get.
143 // Fortunately we have the type information.
145 cgoCheckUsingType(typ, src, off, size)
150 // src must be in the regular heap.
152 hbits := heapBitsForAddr(uintptr(src))
153 for i := uintptr(0); i < off+size; i += sys.PtrSize {
155 if i >= off && bits&bitPointer != 0 {
156 v := *(*unsafe.Pointer)(add(src, i))
157 if cgoIsGoPointer(v) {
158 throw(cgoWriteBarrierFail)
165 // cgoCheckBits checks the block of memory at src, for up to size
166 // bytes, and throws if it finds a Go pointer. The gcbits mark each
167 // pointer value. The src pointer is off bytes into the gcbits.
170 func cgoCheckBits(src unsafe.Pointer, gcbits *byte, off, size uintptr) {
171 skipMask := off / sys.PtrSize / 8
172 skipBytes := skipMask * sys.PtrSize * 8
173 ptrmask := addb(gcbits, skipMask)
174 src = add(src, skipBytes)
178 for i := uintptr(0); i < size; i += sys.PtrSize {
179 if i&(sys.PtrSize*8-1) == 0 {
180 bits = uint32(*ptrmask)
181 ptrmask = addb(ptrmask, 1)
189 v := *(*unsafe.Pointer)(add(src, i))
190 if cgoIsGoPointer(v) {
191 throw(cgoWriteBarrierFail)
198 // cgoCheckUsingType is like cgoCheckTypedBlock, but is a last ditch
199 // fall back to look for pointers in src using the type information.
200 // We only use this when looking at a value on the stack when the type
201 // uses a GC program, because otherwise it's more efficient to use the
202 // GC bits. This is called on the system stack.
205 func cgoCheckUsingType(typ *_type, src unsafe.Pointer, off, size uintptr) {
206 if typ.ptrdata == 0 {
210 // Anything past typ.ptrdata is not a pointer.
211 if typ.ptrdata <= off {
214 if ptrdataSize := typ.ptrdata - off; size > ptrdataSize {
218 if typ.kind&kindGCProg == 0 {
219 cgoCheckBits(src, typ.gcdata, off, size)
222 switch typ.kind & kindMask {
224 throw("can't happen")
226 at := (*arraytype)(unsafe.Pointer(typ))
227 for i := uintptr(0); i < at.len; i++ {
228 if off < at.elem.size {
229 cgoCheckUsingType(at.elem, src, off, size)
231 src = add(src, at.elem.size)
233 if skipped > at.elem.size {
234 skipped = at.elem.size
236 checked := at.elem.size - skipped
244 st := (*structtype)(unsafe.Pointer(typ))
245 for _, f := range st.fields {
246 if off < f.typ.size {
247 cgoCheckUsingType(f.typ, src, off, size)
249 src = add(src, f.typ.size)
251 if skipped > f.typ.size {
254 checked := f.typ.size - skipped