]> Cypherpunks.ru repositories - gostls13.git/blob - src/runtime/cgocall.go
runtime: set stackguard1 on extra M g0
[gostls13.git] / src / runtime / cgocall.go
1 // Copyright 2009 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 // Cgo call and callback support.
6 //
7 // To call into the C function f from Go, the cgo-generated code calls
8 // runtime.cgocall(_cgo_Cfunc_f, frame), where _cgo_Cfunc_f is a
9 // gcc-compiled function written by cgo.
10 //
11 // runtime.cgocall (below) calls entersyscall so as not to block
12 // other goroutines or the garbage collector, and then calls
13 // runtime.asmcgocall(_cgo_Cfunc_f, frame).
14 //
15 // runtime.asmcgocall (in asm_$GOARCH.s) switches to the m->g0 stack
16 // (assumed to be an operating system-allocated stack, so safe to run
17 // gcc-compiled code on) and calls _cgo_Cfunc_f(frame).
18 //
19 // _cgo_Cfunc_f invokes the actual C function f with arguments
20 // taken from the frame structure, records the results in the frame,
21 // and returns to runtime.asmcgocall.
22 //
23 // After it regains control, runtime.asmcgocall switches back to the
24 // original g (m->curg)'s stack and returns to runtime.cgocall.
25 //
26 // After it regains control, runtime.cgocall calls exitsyscall, which blocks
27 // until this m can run Go code without violating the $GOMAXPROCS limit,
28 // and then unlocks g from m.
29 //
30 // The above description skipped over the possibility of the gcc-compiled
31 // function f calling back into Go. If that happens, we continue down
32 // the rabbit hole during the execution of f.
33 //
34 // To make it possible for gcc-compiled C code to call a Go function p.GoF,
35 // cgo writes a gcc-compiled function named GoF (not p.GoF, since gcc doesn't
36 // know about packages).  The gcc-compiled C function f calls GoF.
37 //
38 // GoF initializes "frame", a structure containing all of its
39 // arguments and slots for p.GoF's results. It calls
40 // crosscall2(_cgoexp_GoF, frame, framesize, ctxt) using the gcc ABI.
41 //
42 // crosscall2 (in cgo/asm_$GOARCH.s) is a four-argument adapter from
43 // the gcc function call ABI to the gc function call ABI. At this
44 // point we're in the Go runtime, but we're still running on m.g0's
45 // stack and outside the $GOMAXPROCS limit. crosscall2 calls
46 // runtime.cgocallback(_cgoexp_GoF, frame, ctxt) using the gc ABI.
47 // (crosscall2's framesize argument is no longer used, but there's one
48 // case where SWIG calls crosscall2 directly and expects to pass this
49 // argument. See _cgo_panic.)
50 //
51 // runtime.cgocallback (in asm_$GOARCH.s) switches from m.g0's stack
52 // to the original g (m.curg)'s stack, on which it calls
53 // runtime.cgocallbackg(_cgoexp_GoF, frame, ctxt). As part of the
54 // stack switch, runtime.cgocallback saves the current SP as
55 // m.g0.sched.sp, so that any use of m.g0's stack during the execution
56 // of the callback will be done below the existing stack frames.
57 // Before overwriting m.g0.sched.sp, it pushes the old value on the
58 // m.g0 stack, so that it can be restored later.
59 //
60 // runtime.cgocallbackg (below) is now running on a real goroutine
61 // stack (not an m.g0 stack).  First it calls runtime.exitsyscall, which will
62 // block until the $GOMAXPROCS limit allows running this goroutine.
63 // Once exitsyscall has returned, it is safe to do things like call the memory
64 // allocator or invoke the Go callback function.  runtime.cgocallbackg
65 // first defers a function to unwind m.g0.sched.sp, so that if p.GoF
66 // panics, m.g0.sched.sp will be restored to its old value: the m.g0 stack
67 // and the m.curg stack will be unwound in lock step.
68 // Then it calls _cgoexp_GoF(frame).
69 //
70 // _cgoexp_GoF, which was generated by cmd/cgo, unpacks the arguments
71 // from frame, calls p.GoF, writes the results back to frame, and
72 // returns. Now we start unwinding this whole process.
73 //
74 // runtime.cgocallbackg pops but does not execute the deferred
75 // function to unwind m.g0.sched.sp, calls runtime.entersyscall, and
76 // returns to runtime.cgocallback.
77 //
78 // After it regains control, runtime.cgocallback switches back to
79 // m.g0's stack (the pointer is still in m.g0.sched.sp), restores the old
80 // m.g0.sched.sp value from the stack, and returns to crosscall2.
81 //
82 // crosscall2 restores the callee-save registers for gcc and returns
83 // to GoF, which unpacks any result values and returns to f.
84
85 package runtime
86
87 import (
88         "internal/goarch"
89         "internal/goexperiment"
90         "runtime/internal/sys"
91         "unsafe"
92 )
93
94 // Addresses collected in a cgo backtrace when crashing.
95 // Length must match arg.Max in x_cgo_callers in runtime/cgo/gcc_traceback.c.
96 type cgoCallers [32]uintptr
97
98 // argset matches runtime/cgo/linux_syscall.c:argset_t
99 type argset struct {
100         args   unsafe.Pointer
101         retval uintptr
102 }
103
104 // wrapper for syscall package to call cgocall for libc (cgo) calls.
105 //
106 //go:linkname syscall_cgocaller syscall.cgocaller
107 //go:nosplit
108 //go:uintptrescapes
109 func syscall_cgocaller(fn unsafe.Pointer, args ...uintptr) uintptr {
110         as := argset{args: unsafe.Pointer(&args[0])}
111         cgocall(fn, unsafe.Pointer(&as))
112         return as.retval
113 }
114
115 var ncgocall uint64 // number of cgo calls in total for dead m
116
117 // Call from Go to C.
118 //
119 // This must be nosplit because it's used for syscalls on some
120 // platforms. Syscalls may have untyped arguments on the stack, so
121 // it's not safe to grow or scan the stack.
122 //
123 //go:nosplit
124 func cgocall(fn, arg unsafe.Pointer) int32 {
125         if !iscgo && GOOS != "solaris" && GOOS != "illumos" && GOOS != "windows" {
126                 throw("cgocall unavailable")
127         }
128
129         if fn == nil {
130                 throw("cgocall nil")
131         }
132
133         if raceenabled {
134                 racereleasemerge(unsafe.Pointer(&racecgosync))
135         }
136
137         mp := getg().m
138         mp.ncgocall++
139
140         // Reset traceback.
141         mp.cgoCallers[0] = 0
142
143         // Announce we are entering a system call
144         // so that the scheduler knows to create another
145         // M to run goroutines while we are in the
146         // foreign code.
147         //
148         // The call to asmcgocall is guaranteed not to
149         // grow the stack and does not allocate memory,
150         // so it is safe to call while "in a system call", outside
151         // the $GOMAXPROCS accounting.
152         //
153         // fn may call back into Go code, in which case we'll exit the
154         // "system call", run the Go code (which may grow the stack),
155         // and then re-enter the "system call" reusing the PC and SP
156         // saved by entersyscall here.
157         entersyscall()
158
159         // Tell asynchronous preemption that we're entering external
160         // code. We do this after entersyscall because this may block
161         // and cause an async preemption to fail, but at this point a
162         // sync preemption will succeed (though this is not a matter
163         // of correctness).
164         osPreemptExtEnter(mp)
165
166         mp.incgo = true
167         // We use ncgo as a check during execution tracing for whether there is
168         // any C on the call stack, which there will be after this point. If
169         // there isn't, we can use frame pointer unwinding to collect call
170         // stacks efficiently. This will be the case for the first Go-to-C call
171         // on a stack, so it's preferable to update it here, after we emit a
172         // trace event in entersyscall above.
173         mp.ncgo++
174
175         errno := asmcgocall(fn, arg)
176
177         // Update accounting before exitsyscall because exitsyscall may
178         // reschedule us on to a different M.
179         mp.incgo = false
180         mp.ncgo--
181
182         osPreemptExtExit(mp)
183
184         exitsyscall()
185
186         // Note that raceacquire must be called only after exitsyscall has
187         // wired this M to a P.
188         if raceenabled {
189                 raceacquire(unsafe.Pointer(&racecgosync))
190         }
191
192         // From the garbage collector's perspective, time can move
193         // backwards in the sequence above. If there's a callback into
194         // Go code, GC will see this function at the call to
195         // asmcgocall. When the Go call later returns to C, the
196         // syscall PC/SP is rolled back and the GC sees this function
197         // back at the call to entersyscall. Normally, fn and arg
198         // would be live at entersyscall and dead at asmcgocall, so if
199         // time moved backwards, GC would see these arguments as dead
200         // and then live. Prevent these undead arguments from crashing
201         // GC by forcing them to stay live across this time warp.
202         KeepAlive(fn)
203         KeepAlive(arg)
204         KeepAlive(mp)
205
206         return errno
207 }
208
209 // Set or reset the system stack bounds for a callback on sp.
210 //
211 // Must be nosplit because it is called by needm prior to fully initializing
212 // the M.
213 //
214 //go:nosplit
215 func callbackUpdateSystemStack(mp *m, sp uintptr, signal bool) {
216         g0 := mp.g0
217         if sp > g0.stack.lo && sp <= g0.stack.hi {
218                 // Stack already in bounds, nothing to do.
219                 return
220         }
221
222         if mp.ncgo > 0 {
223                 // ncgo > 0 indicates that this M was in Go further up the stack
224                 // (it called C and is now receiving a callback). It is not
225                 // safe for the C call to change the stack out from under us.
226
227                 // Note that this case isn't possible for signal == true, as
228                 // that is always passing a new M from needm.
229
230                 // Stack is bogus, but reset the bounds anyway so we can print.
231                 hi := g0.stack.hi
232                 lo := g0.stack.lo
233                 g0.stack.hi = sp + 1024
234                 g0.stack.lo = sp - 32*1024
235                 g0.stackguard0 = g0.stack.lo + stackGuard
236                 g0.stackguard1 = g0.stackguard0
237
238                 print("M ", mp.id, " procid ", mp.procid, " runtime: cgocallback with sp=", hex(sp), " out of bounds [", hex(lo), ", ", hex(hi), "]")
239                 print("\n")
240                 exit(2)
241         }
242
243         // This M does not have Go further up the stack. However, it may have
244         // previously called into Go, initializing the stack bounds. Between
245         // that call returning and now the stack may have changed (perhaps the
246         // C thread is running a coroutine library). We need to update the
247         // stack bounds for this case.
248         //
249         // Set the stack bounds to match the current stack. If we don't
250         // actually know how big the stack is, like we don't know how big any
251         // scheduling stack is, but we assume there's at least 32 kB. If we
252         // can get a more accurate stack bound from pthread, use that, provided
253         // it actually contains SP..
254         g0.stack.hi = sp + 1024
255         g0.stack.lo = sp - 32*1024
256         if !signal && _cgo_getstackbound != nil {
257                 // Don't adjust if called from the signal handler.
258                 // We are on the signal stack, not the pthread stack.
259                 // (We could get the stack bounds from sigaltstack, but
260                 // we're getting out of the signal handler very soon
261                 // anyway. Not worth it.)
262                 var bounds [2]uintptr
263                 asmcgocall(_cgo_getstackbound, unsafe.Pointer(&bounds))
264                 // getstackbound is an unsupported no-op on Windows.
265                 //
266                 // Don't use these bounds if they don't contain SP. Perhaps we
267                 // were called by something not using the standard thread
268                 // stack.
269                 if bounds[0] != 0  && sp > bounds[0] && sp <= bounds[1] {
270                         g0.stack.lo = bounds[0]
271                         g0.stack.hi = bounds[1]
272                 }
273         }
274         g0.stackguard0 = g0.stack.lo + stackGuard
275         g0.stackguard1 = g0.stackguard0
276 }
277
278 // Call from C back to Go. fn must point to an ABIInternal Go entry-point.
279 //
280 //go:nosplit
281 func cgocallbackg(fn, frame unsafe.Pointer, ctxt uintptr) {
282         gp := getg()
283         if gp != gp.m.curg {
284                 println("runtime: bad g in cgocallback")
285                 exit(2)
286         }
287
288         sp := gp.m.g0.sched.sp // system sp saved by cgocallback.
289         callbackUpdateSystemStack(gp.m, sp, false)
290
291         // The call from C is on gp.m's g0 stack, so we must ensure
292         // that we stay on that M. We have to do this before calling
293         // exitsyscall, since it would otherwise be free to move us to
294         // a different M. The call to unlockOSThread is in unwindm.
295         lockOSThread()
296
297         checkm := gp.m
298
299         // Save current syscall parameters, so m.syscall can be
300         // used again if callback decide to make syscall.
301         syscall := gp.m.syscall
302
303         // entersyscall saves the caller's SP to allow the GC to trace the Go
304         // stack. However, since we're returning to an earlier stack frame and
305         // need to pair with the entersyscall() call made by cgocall, we must
306         // save syscall* and let reentersyscall restore them.
307         savedsp := unsafe.Pointer(gp.syscallsp)
308         savedpc := gp.syscallpc
309         exitsyscall() // coming out of cgo call
310         gp.m.incgo = false
311         if gp.m.isextra {
312                 gp.m.isExtraInC = false
313         }
314
315         osPreemptExtExit(gp.m)
316
317         if gp.nocgocallback {
318                 panic("runtime: function marked with #cgo nocallback called back into Go")
319         }
320
321         cgocallbackg1(fn, frame, ctxt) // will call unlockOSThread
322
323         // At this point unlockOSThread has been called.
324         // The following code must not change to a different m.
325         // This is enforced by checking incgo in the schedule function.
326
327         gp.m.incgo = true
328         if gp.m.isextra {
329                 gp.m.isExtraInC = true
330         }
331
332         if gp.m != checkm {
333                 throw("m changed unexpectedly in cgocallbackg")
334         }
335
336         osPreemptExtEnter(gp.m)
337
338         // going back to cgo call
339         reentersyscall(savedpc, uintptr(savedsp))
340
341         gp.m.syscall = syscall
342 }
343
344 func cgocallbackg1(fn, frame unsafe.Pointer, ctxt uintptr) {
345         gp := getg()
346
347         // When we return, undo the call to lockOSThread in cgocallbackg.
348         // We must still stay on the same m.
349         defer unlockOSThread()
350
351         if gp.m.needextram || extraMWaiters.Load() > 0 {
352                 gp.m.needextram = false
353                 systemstack(newextram)
354         }
355
356         if ctxt != 0 {
357                 s := append(gp.cgoCtxt, ctxt)
358
359                 // Now we need to set gp.cgoCtxt = s, but we could get
360                 // a SIGPROF signal while manipulating the slice, and
361                 // the SIGPROF handler could pick up gp.cgoCtxt while
362                 // tracing up the stack.  We need to ensure that the
363                 // handler always sees a valid slice, so set the
364                 // values in an order such that it always does.
365                 p := (*slice)(unsafe.Pointer(&gp.cgoCtxt))
366                 atomicstorep(unsafe.Pointer(&p.array), unsafe.Pointer(&s[0]))
367                 p.cap = cap(s)
368                 p.len = len(s)
369
370                 defer func(gp *g) {
371                         // Decrease the length of the slice by one, safely.
372                         p := (*slice)(unsafe.Pointer(&gp.cgoCtxt))
373                         p.len--
374                 }(gp)
375         }
376
377         if gp.m.ncgo == 0 {
378                 // The C call to Go came from a thread not currently running
379                 // any Go. In the case of -buildmode=c-archive or c-shared,
380                 // this call may be coming in before package initialization
381                 // is complete. Wait until it is.
382                 <-main_init_done
383         }
384
385         // Check whether the profiler needs to be turned on or off; this route to
386         // run Go code does not use runtime.execute, so bypasses the check there.
387         hz := sched.profilehz
388         if gp.m.profilehz != hz {
389                 setThreadCPUProfiler(hz)
390         }
391
392         // Add entry to defer stack in case of panic.
393         restore := true
394         defer unwindm(&restore)
395
396         if raceenabled {
397                 raceacquire(unsafe.Pointer(&racecgosync))
398         }
399
400         // Invoke callback. This function is generated by cmd/cgo and
401         // will unpack the argument frame and call the Go function.
402         var cb func(frame unsafe.Pointer)
403         cbFV := funcval{uintptr(fn)}
404         *(*unsafe.Pointer)(unsafe.Pointer(&cb)) = noescape(unsafe.Pointer(&cbFV))
405         cb(frame)
406
407         if raceenabled {
408                 racereleasemerge(unsafe.Pointer(&racecgosync))
409         }
410
411         // Do not unwind m->g0->sched.sp.
412         // Our caller, cgocallback, will do that.
413         restore = false
414 }
415
416 func unwindm(restore *bool) {
417         if *restore {
418                 // Restore sp saved by cgocallback during
419                 // unwind of g's stack (see comment at top of file).
420                 mp := acquirem()
421                 sched := &mp.g0.sched
422                 sched.sp = *(*uintptr)(unsafe.Pointer(sched.sp + alignUp(sys.MinFrameSize, sys.StackAlign)))
423
424                 // Do the accounting that cgocall will not have a chance to do
425                 // during an unwind.
426                 //
427                 // In the case where a Go call originates from C, ncgo is 0
428                 // and there is no matching cgocall to end.
429                 if mp.ncgo > 0 {
430                         mp.incgo = false
431                         mp.ncgo--
432                         osPreemptExtExit(mp)
433                 }
434
435                 releasem(mp)
436         }
437 }
438
439 // called from assembly.
440 func badcgocallback() {
441         throw("misaligned stack in cgocallback")
442 }
443
444 // called from (incomplete) assembly.
445 func cgounimpl() {
446         throw("cgo not implemented")
447 }
448
449 var racecgosync uint64 // represents possible synchronization in C code
450
451 // Pointer checking for cgo code.
452
453 // We want to detect all cases where a program that does not use
454 // unsafe makes a cgo call passing a Go pointer to memory that
455 // contains an unpinned Go pointer. Here a Go pointer is defined as a
456 // pointer to memory allocated by the Go runtime. Programs that use
457 // unsafe can evade this restriction easily, so we don't try to catch
458 // them. The cgo program will rewrite all possibly bad pointer
459 // arguments to call cgoCheckPointer, where we can catch cases of a Go
460 // pointer pointing to an unpinned Go pointer.
461
462 // Complicating matters, taking the address of a slice or array
463 // element permits the C program to access all elements of the slice
464 // or array. In that case we will see a pointer to a single element,
465 // but we need to check the entire data structure.
466
467 // The cgoCheckPointer call takes additional arguments indicating that
468 // it was called on an address expression. An additional argument of
469 // true means that it only needs to check a single element. An
470 // additional argument of a slice or array means that it needs to
471 // check the entire slice/array, but nothing else. Otherwise, the
472 // pointer could be anything, and we check the entire heap object,
473 // which is conservative but safe.
474
475 // When and if we implement a moving garbage collector,
476 // cgoCheckPointer will pin the pointer for the duration of the cgo
477 // call.  (This is necessary but not sufficient; the cgo program will
478 // also have to change to pin Go pointers that cannot point to Go
479 // pointers.)
480
481 // cgoCheckPointer checks if the argument contains a Go pointer that
482 // points to an unpinned Go pointer, and panics if it does.
483 func cgoCheckPointer(ptr any, arg any) {
484         if !goexperiment.CgoCheck2 && debug.cgocheck == 0 {
485                 return
486         }
487
488         ep := efaceOf(&ptr)
489         t := ep._type
490
491         top := true
492         if arg != nil && (t.Kind_&kindMask == kindPtr || t.Kind_&kindMask == kindUnsafePointer) {
493                 p := ep.data
494                 if t.Kind_&kindDirectIface == 0 {
495                         p = *(*unsafe.Pointer)(p)
496                 }
497                 if p == nil || !cgoIsGoPointer(p) {
498                         return
499                 }
500                 aep := efaceOf(&arg)
501                 switch aep._type.Kind_ & kindMask {
502                 case kindBool:
503                         if t.Kind_&kindMask == kindUnsafePointer {
504                                 // We don't know the type of the element.
505                                 break
506                         }
507                         pt := (*ptrtype)(unsafe.Pointer(t))
508                         cgoCheckArg(pt.Elem, p, true, false, cgoCheckPointerFail)
509                         return
510                 case kindSlice:
511                         // Check the slice rather than the pointer.
512                         ep = aep
513                         t = ep._type
514                 case kindArray:
515                         // Check the array rather than the pointer.
516                         // Pass top as false since we have a pointer
517                         // to the array.
518                         ep = aep
519                         t = ep._type
520                         top = false
521                 default:
522                         throw("can't happen")
523                 }
524         }
525
526         cgoCheckArg(t, ep.data, t.Kind_&kindDirectIface == 0, top, cgoCheckPointerFail)
527 }
528
529 const cgoCheckPointerFail = "cgo argument has Go pointer to unpinned Go pointer"
530 const cgoResultFail = "cgo result has Go pointer"
531
532 // cgoCheckArg is the real work of cgoCheckPointer. The argument p
533 // is either a pointer to the value (of type t), or the value itself,
534 // depending on indir. The top parameter is whether we are at the top
535 // level, where Go pointers are allowed. Go pointers to pinned objects are
536 // always allowed.
537 func cgoCheckArg(t *_type, p unsafe.Pointer, indir, top bool, msg string) {
538         if t.PtrBytes == 0 || p == nil {
539                 // If the type has no pointers there is nothing to do.
540                 return
541         }
542
543         switch t.Kind_ & kindMask {
544         default:
545                 throw("can't happen")
546         case kindArray:
547                 at := (*arraytype)(unsafe.Pointer(t))
548                 if !indir {
549                         if at.Len != 1 {
550                                 throw("can't happen")
551                         }
552                         cgoCheckArg(at.Elem, p, at.Elem.Kind_&kindDirectIface == 0, top, msg)
553                         return
554                 }
555                 for i := uintptr(0); i < at.Len; i++ {
556                         cgoCheckArg(at.Elem, p, true, top, msg)
557                         p = add(p, at.Elem.Size_)
558                 }
559         case kindChan, kindMap:
560                 // These types contain internal pointers that will
561                 // always be allocated in the Go heap. It's never OK
562                 // to pass them to C.
563                 panic(errorString(msg))
564         case kindFunc:
565                 if indir {
566                         p = *(*unsafe.Pointer)(p)
567                 }
568                 if !cgoIsGoPointer(p) {
569                         return
570                 }
571                 panic(errorString(msg))
572         case kindInterface:
573                 it := *(**_type)(p)
574                 if it == nil {
575                         return
576                 }
577                 // A type known at compile time is OK since it's
578                 // constant. A type not known at compile time will be
579                 // in the heap and will not be OK.
580                 if inheap(uintptr(unsafe.Pointer(it))) {
581                         panic(errorString(msg))
582                 }
583                 p = *(*unsafe.Pointer)(add(p, goarch.PtrSize))
584                 if !cgoIsGoPointer(p) {
585                         return
586                 }
587                 if !top && !isPinned(p) {
588                         panic(errorString(msg))
589                 }
590                 cgoCheckArg(it, p, it.Kind_&kindDirectIface == 0, false, msg)
591         case kindSlice:
592                 st := (*slicetype)(unsafe.Pointer(t))
593                 s := (*slice)(p)
594                 p = s.array
595                 if p == nil || !cgoIsGoPointer(p) {
596                         return
597                 }
598                 if !top && !isPinned(p) {
599                         panic(errorString(msg))
600                 }
601                 if st.Elem.PtrBytes == 0 {
602                         return
603                 }
604                 for i := 0; i < s.cap; i++ {
605                         cgoCheckArg(st.Elem, p, true, false, msg)
606                         p = add(p, st.Elem.Size_)
607                 }
608         case kindString:
609                 ss := (*stringStruct)(p)
610                 if !cgoIsGoPointer(ss.str) {
611                         return
612                 }
613                 if !top && !isPinned(ss.str) {
614                         panic(errorString(msg))
615                 }
616         case kindStruct:
617                 st := (*structtype)(unsafe.Pointer(t))
618                 if !indir {
619                         if len(st.Fields) != 1 {
620                                 throw("can't happen")
621                         }
622                         cgoCheckArg(st.Fields[0].Typ, p, st.Fields[0].Typ.Kind_&kindDirectIface == 0, top, msg)
623                         return
624                 }
625                 for _, f := range st.Fields {
626                         if f.Typ.PtrBytes == 0 {
627                                 continue
628                         }
629                         cgoCheckArg(f.Typ, add(p, f.Offset), true, top, msg)
630                 }
631         case kindPtr, kindUnsafePointer:
632                 if indir {
633                         p = *(*unsafe.Pointer)(p)
634                         if p == nil {
635                                 return
636                         }
637                 }
638
639                 if !cgoIsGoPointer(p) {
640                         return
641                 }
642                 if !top && !isPinned(p) {
643                         panic(errorString(msg))
644                 }
645
646                 cgoCheckUnknownPointer(p, msg)
647         }
648 }
649
650 // cgoCheckUnknownPointer is called for an arbitrary pointer into Go
651 // memory. It checks whether that Go memory contains any other
652 // pointer into unpinned Go memory. If it does, we panic.
653 // The return values are unused but useful to see in panic tracebacks.
654 func cgoCheckUnknownPointer(p unsafe.Pointer, msg string) (base, i uintptr) {
655         if inheap(uintptr(p)) {
656                 b, span, _ := findObject(uintptr(p), 0, 0)
657                 base = b
658                 if base == 0 {
659                         return
660                 }
661                 n := span.elemsize
662                 hbits := heapBitsForAddr(base, n)
663                 for {
664                         var addr uintptr
665                         if hbits, addr = hbits.next(); addr == 0 {
666                                 break
667                         }
668                         pp := *(*unsafe.Pointer)(unsafe.Pointer(addr))
669                         if cgoIsGoPointer(pp) && !isPinned(pp) {
670                                 panic(errorString(msg))
671                         }
672                 }
673
674                 return
675         }
676
677         for _, datap := range activeModules() {
678                 if cgoInRange(p, datap.data, datap.edata) || cgoInRange(p, datap.bss, datap.ebss) {
679                         // We have no way to know the size of the object.
680                         // We have to assume that it might contain a pointer.
681                         panic(errorString(msg))
682                 }
683                 // In the text or noptr sections, we know that the
684                 // pointer does not point to a Go pointer.
685         }
686
687         return
688 }
689
690 // cgoIsGoPointer reports whether the pointer is a Go pointer--a
691 // pointer to Go memory. We only care about Go memory that might
692 // contain pointers.
693 //
694 //go:nosplit
695 //go:nowritebarrierrec
696 func cgoIsGoPointer(p unsafe.Pointer) bool {
697         if p == nil {
698                 return false
699         }
700
701         if inHeapOrStack(uintptr(p)) {
702                 return true
703         }
704
705         for _, datap := range activeModules() {
706                 if cgoInRange(p, datap.data, datap.edata) || cgoInRange(p, datap.bss, datap.ebss) {
707                         return true
708                 }
709         }
710
711         return false
712 }
713
714 // cgoInRange reports whether p is between start and end.
715 //
716 //go:nosplit
717 //go:nowritebarrierrec
718 func cgoInRange(p unsafe.Pointer, start, end uintptr) bool {
719         return start <= uintptr(p) && uintptr(p) < end
720 }
721
722 // cgoCheckResult is called to check the result parameter of an
723 // exported Go function. It panics if the result is or contains a Go
724 // pointer.
725 func cgoCheckResult(val any) {
726         if !goexperiment.CgoCheck2 && debug.cgocheck == 0 {
727                 return
728         }
729
730         ep := efaceOf(&val)
731         t := ep._type
732         cgoCheckArg(t, ep.data, t.Kind_&kindDirectIface == 0, false, cgoResultFail)
733 }