]> Cypherpunks.ru repositories - gostls13.git/commitdiff
runtime/cgo: store M for C-created thread in pthread key
authordoujiang24 <doujiang24@gmail.com>
Fri, 24 Mar 2023 01:30:46 +0000 (01:30 +0000)
committerCherry Mui <cherryyz@google.com>
Fri, 24 Mar 2023 16:00:24 +0000 (16:00 +0000)
In a C thread, it's necessary to acquire an extra M by using needm while invoking a Go function from C. But, needm and dropm are heavy costs due to the signal-related syscalls.
So, we change to not dropm while returning back to C, which means binding the extra M to the C thread until it exits, to avoid needm and dropm on each C to Go call.
Instead, we only dropm while the C thread exits, so the extra M won't leak.

When invoking a Go function from C:
Allocate a pthread variable using pthread_key_create, only once per shared object, and register a thread-exit-time destructor.
And store the g0 of the current m into the thread-specified value of the pthread key,  only once per C thread, so that the destructor will put the extra M back onto the extra M list while the C thread exits.

When returning back to C:
Skip dropm in cgocallback, when the pthread variable has been created, so that the extra M will be reused the next time invoke a Go function from C.

This is purely a performance optimization. The old version, in which needm & dropm happen on each cgo call, is still correct too, and we have to keep the old version on systems with cgo but without pthreads, like Windows.

This optimization is significant, and the specific value depends on the OS system and CPU, but in general, it can be considered as 10x faster, for a simple Go function call from a C thread.

For the newly added BenchmarkCGoInCThread, some benchmark results:
1. it's 28x faster, from 3395 ns/op to 121 ns/op, in darwin OS & Intel(R) Core(TM) i7-9750H CPU @ 2.60GHz
2. it's 6.5x faster, from 1495 ns/op to 230 ns/op, in Linux OS & Intel(R) Xeon(R) CPU E5-2630 0 @ 2.30GHz

Fixes #51676

Change-Id: I380702fe2f9b6b401b2d6f04b0aba990f4b9ee6c
GitHub-Last-Rev: 93dc64ad98e5583372e41f65ee4b7ab78b5aff51
GitHub-Pull-Request: golang/go#51679
Reviewed-on: https://go-review.googlesource.com/c/go/+/392854
Reviewed-by: Ian Lance Taylor <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: thepudds <thepudds1460@gmail.com>
Reviewed-by: Cherry Mui <cherryyz@google.com>
37 files changed:
misc/cgo/test/cgo_test.go
misc/cgo/test/cthread_unix.c
misc/cgo/test/cthread_windows.c
misc/cgo/test/testx.go
src/runtime/asm_386.s
src/runtime/asm_amd64.s
src/runtime/asm_arm.s
src/runtime/asm_arm64.s
src/runtime/asm_loong64.s
src/runtime/asm_mips64x.s
src/runtime/asm_mipsx.s
src/runtime/asm_ppc64x.s
src/runtime/asm_riscv64.s
src/runtime/asm_s390x.s
src/runtime/cgo.go
src/runtime/cgo/asm_386.s
src/runtime/cgo/asm_amd64.s
src/runtime/cgo/asm_arm.s
src/runtime/cgo/asm_arm64.s
src/runtime/cgo/asm_loong64.s
src/runtime/cgo/asm_mips64x.s
src/runtime/cgo/asm_mipsx.s
src/runtime/cgo/asm_ppc64x.s
src/runtime/cgo/asm_riscv64.s
src/runtime/cgo/asm_s390x.s
src/runtime/cgo/asm_wasm.s
src/runtime/cgo/callbacks.go
src/runtime/cgo/gcc_libinit.c
src/runtime/cgo/gcc_libinit_windows.c
src/runtime/cgo/libcgo.h
src/runtime/cgocall.go
src/runtime/crash_cgo_test.go
src/runtime/proc.go
src/runtime/runtime2.go
src/runtime/signal_unix.go
src/runtime/stubs.go
src/runtime/testdata/testprogcgo/bindm.go [new file with mode: 0644]

index 5b298954f59e592699bd0ba7c3bce0af8da8d6f9..0c3980c12d2da9f101f2c4392c104aba0d093803 100644 (file)
@@ -104,6 +104,7 @@ func TestThreadLock(t *testing.T)            { testThreadLockFunc(t) }
 func TestUnsignedInt(t *testing.T)           { testUnsignedInt(t) }
 func TestZeroArgCallback(t *testing.T)       { testZeroArgCallback(t) }
 
-func BenchmarkCgoCall(b *testing.B)     { benchCgoCall(b) }
-func BenchmarkGoString(b *testing.B)    { benchGoString(b) }
-func BenchmarkCGoCallback(b *testing.B) { benchCallback(b) }
+func BenchmarkCgoCall(b *testing.B)      { benchCgoCall(b) }
+func BenchmarkGoString(b *testing.B)     { benchGoString(b) }
+func BenchmarkCGoCallback(b *testing.B)  { benchCallback(b) }
+func BenchmarkCGoInCThread(b *testing.B) { benchCGoInCthread(b) }
index 247d636d06dc5d45e9c3c0986f499df1ab56b1af..13623254a97260999eea927d2f18acf7578576c6 100644 (file)
@@ -32,3 +32,27 @@ doAdd(int max, int nthread)
        for(i=0; i<nthread; i++)
                pthread_join(thread_id[i], 0);          
 }
+
+static void*
+goDummyCallbackThread(void* p)
+{
+       int i, max;
+
+       max = *(int*)p;
+       for(i=0; i<max; i++)
+               goDummy();
+       return NULL;
+}
+
+int
+callGoInCThread(int max)
+{
+       pthread_t thread;
+
+       if (pthread_create(&thread, NULL, goDummyCallbackThread, (void*)(&max)) != 0)
+               return -1;
+       if (pthread_join(thread, NULL) != 0)
+               return -1;
+
+       return max;
+}
index 3a62ddd3730f43b3aa6fafaf7466e35de2539d4f..4e52209dee1d1812ecdc9fcc25474364268198b2 100644 (file)
@@ -35,3 +35,25 @@ doAdd(int max, int nthread)
                CloseHandle((HANDLE)thread_id[i]);
        }
 }
+
+__stdcall
+static unsigned int
+goDummyCallbackThread(void* p)
+{
+       int i, max;
+
+       max = *(int*)p;
+       for(i=0; i<max; i++)
+               goDummy();
+       return 0;
+}
+
+int
+callGoInCThread(int max)
+{
+       uintptr_t thread_id;
+       thread_id = _beginthreadex(0, 0, goDummyCallbackThread, &max, 0, 0);
+       WaitForSingleObject((HANDLE)thread_id, INFINITE);
+       CloseHandle((HANDLE)thread_id);
+       return max;
+}
index 6a8e97ddf3f1ac30ce2870d6cdcd5db46e3ed8e2..0e2a51a52280ba3a43f2e80e167f1445cf6f39e8 100644 (file)
@@ -24,6 +24,7 @@ import (
 /*
 // threads
 extern void doAdd(int, int);
+extern int callGoInCThread(int);
 
 // issue 1328
 void IntoC(void);
@@ -146,6 +147,10 @@ func Add(x int) {
        *p = 2
 }
 
+//export goDummy
+func goDummy() {
+}
+
 func testCthread(t *testing.T) {
        if (runtime.GOOS == "darwin" || runtime.GOOS == "ios") && runtime.GOARCH == "arm64" {
                t.Skip("the iOS exec wrapper is unable to properly handle the panic from Add")
@@ -159,6 +164,15 @@ func testCthread(t *testing.T) {
        }
 }
 
+// Benchmark measuring overhead from C to Go in a C thread.
+// Create a new C thread and invoke Go function repeatedly in the new C thread.
+func benchCGoInCthread(b *testing.B) {
+       n := C.callGoInCThread(C.int(b.N))
+       if int(n) != b.N {
+               b.Fatal("unmatch loop times")
+       }
+}
+
 // issue 1328
 
 //export BackIntoGo
index f07fc6bdb48a29cc6b9a8ce0465281a391e520a5..209f811f815399059f3c7df1569e7e5c18a7bf55 100644 (file)
@@ -689,7 +689,20 @@ nosave:
 TEXT ·cgocallback(SB),NOSPLIT,$12-12  // Frame size must match commented places below
        NO_LOCAL_POINTERS
 
-       // If g is nil, Go did not create the current thread.
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVL    fn+0(FP), AX
+       CMPL    AX, $0
+       JNE     loadg
+       // Restore the g from frame.
+       get_tls(CX)
+       MOVL    frame+4(FP), BX
+       MOVL    BX, g(CX)
+       JMP     dropm
+
+loadg:
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -707,9 +720,9 @@ TEXT ·cgocallback(SB),NOSPLIT,$12-12  // Frame size must match commented places
        MOVL    BP, savedm-4(SP) // saved copy of oldm
        JMP     havem
 needm:
-       MOVL    $runtime·needm(SB), AX
+       MOVL    $runtime·needAndBindM(SB), AX
        CALL    AX
-       MOVL    $0, savedm-4(SP) // dropm on return
+       MOVL    $0, savedm-4(SP)
        get_tls(CX)
        MOVL    g(CX), BP
        MOVL    g_m(BP), BP
@@ -784,13 +797,29 @@ havem:
        MOVL    0(SP), AX
        MOVL    AX, (g_sched+gobuf_sp)(SI)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVL    savedm-4(SP), DX
        CMPL    DX, $0
-       JNE 3(PC)
+       JNE     droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVL    _cgo_pthread_key_created(SB), DX
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       CMPL    DX, $0
+       JEQ     dropm
+       CMPL    (DX), $0
+       JNE     droppedm
+
+dropm:
        MOVL    $runtime·dropm(SB), AX
        CALL    AX
+droppedm:
 
        // Done!
        RET
index 5e89c8d2da7ac14c568fea8756cdb8e7a97de231..c8641cb2c269f7ea9dabf79819cbe127d9a63255 100644 (file)
@@ -915,7 +915,20 @@ GLOBL zeroTLS<>(SB),RODATA,$const_tlsSize
 TEXT ·cgocallback(SB),NOSPLIT,$24-24
        NO_LOCAL_POINTERS
 
-       // If g is nil, Go did not create the current thread.
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVQ    fn+0(FP), AX
+       CMPQ    AX, $0
+       JNE     loadg
+       // Restore the g from frame.
+       get_tls(CX)
+       MOVQ    frame+8(FP), BX
+       MOVQ    BX, g(CX)
+       JMP     dropm
+
+loadg:
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one m for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -953,9 +966,9 @@ needm:
        // a bad value in there, in case needm tries to use it.
        XORPS   X15, X15
        XORQ    R14, R14
-       MOVQ    $runtime·needm<ABIInternal>(SB), AX
+       MOVQ    $runtime·needAndBindM<ABIInternal>(SB), AX
        CALL    AX
-       MOVQ    $0, savedm-8(SP) // dropm on return
+       MOVQ    $0, savedm-8(SP)
        get_tls(CX)
        MOVQ    g(CX), BX
        MOVQ    g_m(BX), BX
@@ -1044,11 +1057,26 @@ havem:
        MOVQ    0(SP), AX
        MOVQ    AX, (g_sched+gobuf_sp)(SI)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVQ    savedm-8(SP), BX
        CMPQ    BX, $0
        JNE     done
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVQ    _cgo_pthread_key_created(SB), AX
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       CMPQ    AX, $0
+       JEQ     dropm
+       CMPQ    (AX), $0
+       JNE     done
+
+dropm:
        MOVQ    $runtime·dropm(SB), AX
        CALL    AX
 #ifdef GOOS_windows
index 569165ed19ada58661b825e4d20d5c6524a88aa7..88e518b0c4fa2a619e2b5e09747b2c1acc5e0d38 100644 (file)
@@ -630,6 +630,15 @@ nosave:
 TEXT   ·cgocallback(SB),NOSPLIT,$12-12
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVW    fn+0(FP), R1
+       B.NE    loadg
+       // Restore the g from frame.
+       MOVW    frame+4(FP), g
+       B       dropm
+
+loadg:
        // Load m and g from thread-local storage.
 #ifdef GOOS_openbsd
        BL      runtime·load_g(SB)
@@ -639,7 +648,8 @@ TEXT        ·cgocallback(SB),NOSPLIT,$12-12
        BL.NE   runtime·load_g(SB)
 #endif
 
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -653,7 +663,7 @@ TEXT        ·cgocallback(SB),NOSPLIT,$12-12
 
 needm:
        MOVW    g, savedm-4(SP) // g is zero, so is m.
-       MOVW    $runtime·needm(SB), R0
+       MOVW    $runtime·needAndBindM(SB), R0
        BL      (R0)
 
        // Set m->g0->sched.sp = SP, so that if a panic happens
@@ -724,14 +734,31 @@ havem:
        MOVW    savedsp-12(SP), R4      // must match frame size
        MOVW    R4, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVW    savedm-4(SP), R6
        CMP     $0, R6
-       B.NE    3(PC)
+       B.NE    done
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVW    _cgo_pthread_key_created(SB), R6
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       CMP     $0, R6
+       B.EQ    dropm
+       MOVW    (R6), R6
+       CMP     $0, R6
+       B.NE    done
+
+dropm:
        MOVW    $runtime·dropm(SB), R0
        BL      (R0)
 
+done:
        // Done!
        RET
 
index d0dd73cc00ff6c8aee3866eda7d028db508ff093..7b659e3929924209ea3b41d0e37050a4852bbd3a 100644 (file)
@@ -1014,10 +1014,20 @@ nosave:
 TEXT ·cgocallback(SB),NOSPLIT,$24-24
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVD    fn+0(FP), R1
+       CBNZ    R1, loadg
+       // Restore the g from frame.
+       MOVD    frame+8(FP), g
+       B       dropm
+
+loadg:
        // Load g from thread-local storage.
        BL      runtime·load_g(SB)
 
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -1030,7 +1040,7 @@ TEXT ·cgocallback(SB),NOSPLIT,$24-24
 
 needm:
        MOVD    g, savedm-8(SP) // g is zero, so is m.
-       MOVD    $runtime·needm(SB), R0
+       MOVD    $runtime·needAndBindM(SB), R0
        BL      (R0)
 
        // Set m->g0->sched.sp = SP, so that if a panic happens
@@ -1111,10 +1121,24 @@ havem:
        MOVD    savedsp-16(SP), R4
        MOVD    R4, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVD    savedm-8(SP), R6
        CBNZ    R6, droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVD    _cgo_pthread_key_created(SB), R6
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       CBZ     R6, dropm
+       MOVD    (R6), R6
+       CBNZ    R6, droppedm
+
+dropm:
        MOVD    $runtime·dropm(SB), R0
        BL      (R0)
 droppedm:
index 6fa9484333e11a8e7d1282b1c647c23a00b70000..d2b15144e03b380e81038c25f9e56f4042f755af 100644 (file)
@@ -461,13 +461,23 @@ g0:
 TEXT ·cgocallback(SB),NOSPLIT,$24-24
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVV    fn+0(FP), R5
+       BNE     R5, loadg
+       // Restore the g from frame.
+       MOVV    frame+8(FP), g
+       JMP     dropm
+
+loadg:
        // Load m and g from thread-local storage.
        MOVB    runtime·iscgo(SB), R19
        BEQ     R19, nocgo
        JAL     runtime·load_g(SB)
 nocgo:
 
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -480,7 +490,7 @@ nocgo:
 
 needm:
        MOVV    g, savedm-8(SP) // g is zero, so is m.
-       MOVV    $runtime·needm(SB), R4
+       MOVV    $runtime·needAndBindM(SB), R4
        JAL     (R4)
 
        // Set m->sched.sp = SP, so that if a panic happens
@@ -552,10 +562,24 @@ havem:
        MOVV    savedsp-24(SP), R13 // must match frame size
        MOVV    R13, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVV    savedm-8(SP), R12
        BNE     R12, droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVV    _cgo_pthread_key_created(SB), R12
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       BEQ     R12, dropm
+       MOVV    (R12), R12
+       BNE     R12, droppedm
+
+dropm:
        MOVV    $runtime·dropm(SB), R4
        JAL     (R4)
 droppedm:
index 8d1f6506da4e82a447ff6fef52bfde65b6f0dada..c0f2b758f0983ab46d635d583d972cec169850d8 100644 (file)
@@ -469,13 +469,23 @@ g0:
 TEXT ·cgocallback(SB),NOSPLIT,$24-24
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVV    fn+0(FP), R5
+       BNE     R5, loadg
+       // Restore the g from frame.
+       MOVV    frame+8(FP), g
+       JMP     dropm
+
+loadg:
        // Load m and g from thread-local storage.
        MOVB    runtime·iscgo(SB), R1
        BEQ     R1, nocgo
        JAL     runtime·load_g(SB)
 nocgo:
 
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -488,7 +498,7 @@ nocgo:
 
 needm:
        MOVV    g, savedm-8(SP) // g is zero, so is m.
-       MOVV    $runtime·needm(SB), R4
+       MOVV    $runtime·needAndBindM(SB), R4
        JAL     (R4)
 
        // Set m->sched.sp = SP, so that if a panic happens
@@ -559,10 +569,24 @@ havem:
        MOVV    savedsp-24(SP), R2      // must match frame size
        MOVV    R2, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVV    savedm-8(SP), R3
        BNE     R3, droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVV    _cgo_pthread_key_created(SB), R3
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       BEQ     R3, dropm
+       MOVV    (R3), R3
+       BNE     R3, droppedm
+
+dropm:
        MOVV    $runtime·dropm(SB), R4
        JAL     (R4)
 droppedm:
index 33d37b2d0218424d08b2cc8c61f025e1b314c50b..5eaff79eb75bb167b24b25fc8e4820ee192d8099 100644 (file)
@@ -459,13 +459,23 @@ g0:
 TEXT ·cgocallback(SB),NOSPLIT,$12-12
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVW    fn+0(FP), R5
+       BNE     R5, loadg
+       // Restore the g from frame.
+       MOVW    frame+4(FP), g
+       JMP     dropm
+
+loadg:
        // Load m and g from thread-local storage.
        MOVB    runtime·iscgo(SB), R1
        BEQ     R1, nocgo
        JAL     runtime·load_g(SB)
 nocgo:
 
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -478,7 +488,7 @@ nocgo:
 
 needm:
        MOVW    g, savedm-4(SP) // g is zero, so is m.
-       MOVW    $runtime·needm(SB), R4
+       MOVW    $runtime·needAndBindM(SB), R4
        JAL     (R4)
 
        // Set m->sched.sp = SP, so that if a panic happens
@@ -549,10 +559,24 @@ havem:
        MOVW    savedsp-12(SP), R2      // must match frame size
        MOVW    R2, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVW    savedm-4(SP), R3
        BNE     R3, droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVW    _cgo_pthread_key_created(SB), R3
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       BEQ     R3, dropm
+       MOVW    (R3), R3
+       BNE     R3, droppedm
+
+dropm:
        MOVW    $runtime·dropm(SB), R4
        JAL     (R4)
 droppedm:
index 96a25f4047ed3ee89bd1e96d7133ae27da55085e..7c866b4bc3367acdb71cf3fef8fe7092d14d3192 100644 (file)
@@ -628,6 +628,16 @@ g0:
 TEXT ·cgocallback(SB),NOSPLIT,$24-24
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVD    fn+0(FP), R5
+       CMP     R5, $0
+       BNE     loadg
+       // Restore the g from frame.
+       MOVD    frame+8(FP), g
+       BR      dropm
+
+loadg:
        // Load m and g from thread-local storage.
        MOVBZ   runtime·iscgo(SB), R3
        CMP     R3, $0
@@ -635,7 +645,8 @@ TEXT ·cgocallback(SB),NOSPLIT,$24-24
        BL      runtime·load_g(SB)
 nocgo:
 
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -649,7 +660,7 @@ nocgo:
 
 needm:
        MOVD    g, savedm-8(SP) // g is zero, so is m.
-       MOVD    $runtime·needm(SB), R12
+       MOVD    $runtime·needAndBindM(SB), R12
        MOVD    R12, CTR
        BL      (CTR)
 
@@ -724,11 +735,27 @@ havem:
        MOVD    savedsp-24(SP), R4      // must match frame size
        MOVD    R4, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVD    savedm-8(SP), R6
        CMP     R6, $0
        BNE     droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVD    _cgo_pthread_key_created(SB), R6
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       CMP     R6, $0
+       BEQ     dropm
+       MOVD    (R6), R6
+       CMP     R6, $0
+       BNE     droppedm
+
+dropm:
        MOVD    $runtime·dropm(SB), R12
        MOVD    R12, CTR
        BL      (CTR)
index 7626f69684127da7938ef9e4b80385eaba0e6a8f..021b661817ca857b2ed7ed26b62209d01079fa0d 100644 (file)
@@ -519,13 +519,23 @@ TEXT runtime·goexit(SB),NOSPLIT|NOFRAME|TOPFRAME,$0-0
 TEXT ·cgocallback(SB),NOSPLIT,$24-24
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOV     fn+0(FP), X7
+       BNE     ZERO, X7, loadg
+       // Restore the g from frame.
+       MOV     frame+8(FP), g
+       JMP     dropm
+
+loadg:
        // Load m and g from thread-local storage.
        MOVBU   runtime·iscgo(SB), X5
        BEQ     ZERO, X5, nocgo
        CALL    runtime·load_g(SB)
 nocgo:
 
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -538,7 +548,7 @@ nocgo:
 
 needm:
        MOV     g, savedm-8(SP) // g is zero, so is m.
-       MOV     $runtime·needm(SB), X6
+       MOV     $runtime·needAndBindM(SB), X6
        JALR    RA, X6
 
        // Set m->sched.sp = SP, so that if a panic happens
@@ -609,10 +619,24 @@ havem:
        MOV     savedsp-24(SP), X6      // must match frame size
        MOV     X6, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOV     savedm-8(SP), X5
        BNE     ZERO, X5, droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOV     _cgo_pthread_key_created(SB), X5
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       BEQ     ZERO, X5, dropm
+       MOV     (X5), X5
+       BNE     ZERO, X5, droppedm
+
+dropm:
        MOV     $runtime·dropm(SB), X6
        JALR    RA, X6
 droppedm:
index e8fa10dee6137daa192290dee24368cab67e0bb6..56e5fc886b0cbd96812f943deddb085ddd97782a 100644 (file)
@@ -564,13 +564,23 @@ g0:
 TEXT ·cgocallback(SB),NOSPLIT,$24-24
        NO_LOCAL_POINTERS
 
+       // Skip cgocallbackg, just dropm when fn is nil, and frame is the saved g.
+       // It is used to dropm while thread is exiting.
+       MOVD    fn+0(FP), R1
+       CMPBNE  R1, $0, loadg
+       // Restore the g from frame.
+       MOVD    frame+8(FP), g
+       BR      dropm
+
+loadg:
        // Load m and g from thread-local storage.
        MOVB    runtime·iscgo(SB), R3
        CMPBEQ  R3, $0, nocgo
        BL      runtime·load_g(SB)
 
 nocgo:
-       // If g is nil, Go did not create the current thread.
+       // If g is nil, Go did not create the current thread,
+       // or if this thread never called into Go on pthread platforms.
        // Call needm to obtain one for temporary use.
        // In this case, we're running on the thread stack, so there's
        // lots of space, but the linker doesn't know. Hide the call from
@@ -583,7 +593,7 @@ nocgo:
 
 needm:
        MOVD    g, savedm-8(SP) // g is zero, so is m.
-       MOVD    $runtime·needm(SB), R3
+       MOVD    $runtime·needAndBindM(SB), R3
        BL      (R3)
 
        // Set m->sched.sp = SP, so that if a panic happens
@@ -654,10 +664,24 @@ havem:
        MOVD    savedsp-24(SP), R4      // must match frame size
        MOVD    R4, (g_sched+gobuf_sp)(g)
 
-       // If the m on entry was nil, we called needm above to borrow an m
-       // for the duration of the call. Since the call is over, return it with dropm.
+       // If the m on entry was nil, we called needm above to borrow an m,
+       // 1. for the duration of the call on non-pthread platforms,
+       // 2. or the duration of the C thread alive on pthread platforms.
+       // If the m on entry wasn't nil,
+       // 1. the thread might be a Go thread,
+       // 2. or it's wasn't the first call from a C thread on pthread platforms,
+       //    since the we skip dropm to resue the m in the first call.
        MOVD    savedm-8(SP), R6
        CMPBNE  R6, $0, droppedm
+
+       // Skip dropm to reuse it in the next call, when a pthread key has been created.
+       MOVD    _cgo_pthread_key_created(SB), R6
+       // It means cgo is disabled when _cgo_pthread_key_created is a nil pointer, need dropm.
+       CMPBEQ  R6, $0, dropm
+       MOVD    (R6), R6
+       CMPBNE  R6, $0, droppedm
+
+dropm:
        MOVD    $runtime·dropm(SB), R3
        BL      (R3)
 droppedm:
index d90468240df97cf131d64b19d563d19a0fb5b950..6a3eeb58221162c4b8062f6a42c43f7616bbf544 100644 (file)
@@ -17,6 +17,8 @@ import "unsafe"
 //go:linkname _cgo_callers _cgo_callers
 //go:linkname _cgo_set_context_function _cgo_set_context_function
 //go:linkname _cgo_yield _cgo_yield
+//go:linkname _cgo_pthread_key_created _cgo_pthread_key_created
+//go:linkname _cgo_bindm _cgo_bindm
 
 var (
        _cgo_init                     unsafe.Pointer
@@ -26,11 +28,16 @@ var (
        _cgo_callers                  unsafe.Pointer
        _cgo_set_context_function     unsafe.Pointer
        _cgo_yield                    unsafe.Pointer
+       _cgo_pthread_key_created      unsafe.Pointer
+       _cgo_bindm                    unsafe.Pointer
 )
 
 // iscgo is set to true by the runtime/cgo package
 var iscgo bool
 
+// set_crosscall2 is set by the runtime/cgo package
+var set_crosscall2 func()
+
 // cgoHasExtraM is set on startup when an extra M is created for cgo.
 // The extra M must be created before any C/C++ code calls cgocallback.
 var cgoHasExtraM bool
index 2e7e9512e273284f0b65d8864dbc00f7d7ecf3bc..086e20b02f50c3eb9eda89ac5053367ed8ce65b0 100644 (file)
@@ -4,6 +4,14 @@
 
 #include "textflag.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVL    _crosscall2_ptr(SB), AX
+       MOVL    $crosscall2(SB), BX
+       MOVL    BX, (AX)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index e223a6c8706c843f9436167b138522a5f6aef1c2..f254622f231f504ff62468d79abec7820d9ae4b3 100644 (file)
@@ -5,6 +5,14 @@
 #include "textflag.h"
 #include "abi_amd64.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVQ    _crosscall2_ptr(SB), AX
+       MOVQ    $crosscall2(SB), BX
+       MOVQ    BX, (AX)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index ea55e173c129bd334ebcbc4276bab4f94b54c4dd..f7f99772a6ce88b12bc16db01c69390d8220204e 100644 (file)
@@ -4,6 +4,14 @@
 
 #include "textflag.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVW    _crosscall2_ptr(SB), R1
+       MOVW    $crosscall2(SB), R2
+       MOVW    R2, (R1)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index e808dedcfc581537ead54dc3ce49ebe412928670..ce8909b49273e51e0f498468af172b8e125a887c 100644 (file)
@@ -5,6 +5,14 @@
 #include "textflag.h"
 #include "abi_arm64.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVD    _crosscall2_ptr(SB), R1
+       MOVD    $crosscall2(SB), R2
+       MOVD    R2, (R1)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index 961a3dd48426c7750e2f1c48870b0d58ec5ff871..1eb5b3ea37c090092d0bcf50325b82558e8bed13 100644 (file)
@@ -4,6 +4,14 @@
 
 #include "textflag.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVV    _crosscall2_ptr(SB), R5
+       MOVV    $crosscall2(SB), R6
+       MOVV    R6, (R5)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index 904f781d87eaf07bf5ab326d3446056e3924731b..0a8fbbbef05d11e2f68b72b7ce56746dbafa8fec 100644 (file)
@@ -6,6 +6,14 @@
 
 #include "textflag.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVV    _crosscall2_ptr(SB), R5
+       MOVV    $crosscall2(SB), R6
+       MOVV    R6, (R5)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index 5e2db0b56ecbe38190a9bad67d40bf20bc92c37d..a57ae97d7e96a19f0db77ffa026a43ad0fab773b 100644 (file)
@@ -6,6 +6,14 @@
 
 #include "textflag.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVW    _crosscall2_ptr(SB), R5
+       MOVW    $crosscall2(SB), R6
+       MOVW    R6, (R5)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index fea749670b828c07421168d7e1733da6b6a341ed..8eb4a4215788656bbac898af8f8ffd2fbd36d67c 100644 (file)
@@ -7,6 +7,26 @@
 #include "textflag.h"
 #include "asm_ppc64x.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVD    _crosscall2_ptr(SB), R5
+#ifdef GOARCH_ppc64
+       MOVD    $_crosscall2<>(SB), R6
+#else
+       MOVD    $crosscall2(SB), R6
+#endif
+       MOVD    R6, (R5)
+       RET
+
+#ifdef GO_PPC64X_HAS_FUNCDESC
+// _crosscall2<> is a function descriptor to the real crosscall2.
+DATA    _crosscall2<>+0(SB)/8, $crosscall2(SB)
+DATA    _crosscall2<>+8(SB)/8, $TOC(SB)
+DATA    _crosscall2<>+16(SB)/8, $0
+GLOBL   _crosscall2<>(SB), NOPTR, $24
+#endif
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
@@ -32,8 +52,12 @@ TEXT crosscall2(SB),NOSPLIT|NOFRAME,$0
 
 #ifdef GO_PPC64X_HAS_FUNCDESC
        // Load the real entry address from the first slot of the function descriptor.
+       // The first argument fn might be null, that means dropm in pthread key destructor.
+       CMP     R3, $0
+       BEQ     nil_fn
        MOVD    8(R3), R2
        MOVD    (R3), R3
+nil_fn:
 #endif
        MOVD    R3, FIXED_FRAME+0(R1)   // fn unsafe.Pointer
        MOVD    R4, FIXED_FRAME+8(R1)   // a unsafe.Pointer
index 45151bf02bacbea6c09e2e5a72ff9b29a209d570..08c4ed846671da32b10428d272307e7bce14d6a4 100644 (file)
@@ -4,6 +4,14 @@
 
 #include "textflag.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOV     _crosscall2_ptr(SB), X7
+       MOV     $crosscall2(SB), X8
+       MOV     X8, (X7)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index 8bf16e75e2c05542b963a2cc34cacd226f97783e..bb0dfc1e313d9a747a7c961a431a32fd4e8a3aae 100644 (file)
@@ -4,6 +4,14 @@
 
 #include "textflag.h"
 
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's such a pointer chain: _crosscall2_ptr -> x_crosscall2_ptr -> crosscall2
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       MOVD    _crosscall2_ptr(SB), R1
+       MOVD    $crosscall2(SB), R2
+       MOVD    R2, (R1)
+       RET
+
 // Called by C code generated by cmd/cgo.
 // func crosscall2(fn, a unsafe.Pointer, n int32, ctxt uintptr)
 // Saves C callee-saved registers and calls cgocallback with three arguments.
index cb140eb7b81fabfc888d53938e55b4955882e3da..e7f01bdc56e804410b1a3c80e9c0a6f1fd7ebe6f 100644 (file)
@@ -4,5 +4,8 @@
 
 #include "textflag.h"
 
+TEXT ·set_crosscall2(SB),NOSPLIT,$0-0
+       UNDEF
+
 TEXT crosscall2(SB), NOSPLIT, $0
        UNDEF
index e7c8ef3e07c2b3c4290e000cea35e8a81ef1011a..792dd7d0860d3f8c6a1572f509a438e194183b76 100644 (file)
@@ -71,6 +71,42 @@ var _cgo_thread_start = &x_cgo_thread_start
 var x_cgo_sys_thread_create byte
 var _cgo_sys_thread_create = &x_cgo_sys_thread_create
 
+// Indicates whether a dummy thread key has been created or not.
+//
+// When calling go exported function from C, we register a destructor
+// callback, for a dummy thread key, by using pthread_key_create.
+
+//go:cgo_import_static x_cgo_pthread_key_created
+//go:linkname x_cgo_pthread_key_created x_cgo_pthread_key_created
+//go:linkname _cgo_pthread_key_created _cgo_pthread_key_created
+var x_cgo_pthread_key_created byte
+var _cgo_pthread_key_created = &x_cgo_pthread_key_created
+
+// Export crosscall2 to a c function pointer variable.
+// Used to dropm in pthread key destructor, while C thread is exiting.
+
+//go:cgo_import_static x_crosscall2_ptr
+//go:linkname x_crosscall2_ptr x_crosscall2_ptr
+//go:linkname _crosscall2_ptr _crosscall2_ptr
+var x_crosscall2_ptr byte
+var _crosscall2_ptr = &x_crosscall2_ptr
+
+// Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+// It's for the runtime package to call at init time.
+func set_crosscall2()
+
+//go:linkname _set_crosscall2 runtime.set_crosscall2
+var _set_crosscall2 = set_crosscall2
+
+// Store the g into the thread-specific value.
+// So that pthread_key_destructor will dropm when the thread is exiting.
+
+//go:cgo_import_static x_cgo_bindm
+//go:linkname x_cgo_bindm x_cgo_bindm
+//go:linkname _cgo_bindm _cgo_bindm
+var x_cgo_bindm byte
+var _cgo_bindm = &x_cgo_bindm
+
 // Notifies that the runtime has been initialized.
 //
 // We currently block at every CGO entry point (via _cgo_wait_runtime_init_done)
index 57620fe4de81eda8f075af0d939b9013c7197cf0..96765932117ee6a49c6d431ecb09260720629879 100644 (file)
@@ -17,6 +17,14 @@ static pthread_cond_t runtime_init_cond = PTHREAD_COND_INITIALIZER;
 static pthread_mutex_t runtime_init_mu = PTHREAD_MUTEX_INITIALIZER;
 static int runtime_init_done;
 
+// pthread_g is a pthread specific key, for storing the g that binded to the C thread.
+// The registered pthread_key_destructor will dropm, when the pthread-specified value g is not NULL,
+// while a C thread is exiting.
+static pthread_key_t pthread_g;
+static void pthread_key_destructor(void* g);
+uintptr_t x_cgo_pthread_key_created;
+void (*x_crosscall2_ptr)(void (*fn)(void *), void *, int, size_t);
+
 // The context function, used when tracing back C calls into Go.
 static void (*cgo_context_function)(struct context_arg*);
 
@@ -39,6 +47,12 @@ _cgo_wait_runtime_init_done(void) {
                pthread_cond_wait(&runtime_init_cond, &runtime_init_mu);
        }
 
+       // The key and x_cgo_pthread_key_created are for the whole program,
+       // whereas the specific and destructor is per thread.
+       if (x_cgo_pthread_key_created == 0 && pthread_key_create(&pthread_g, pthread_key_destructor) == 0) {
+               x_cgo_pthread_key_created = 1;
+       }
+
        // TODO(iant): For the case of a new C thread calling into Go, such
        // as when using -buildmode=c-archive, we know that Go runtime
        // initialization is complete but we do not know that all Go init
@@ -61,6 +75,16 @@ _cgo_wait_runtime_init_done(void) {
        return 0;
 }
 
+// Store the g into a thread-specific value associated with the pthread key pthread_g.
+// And pthread_key_destructor will dropm when the thread is exiting.
+void x_cgo_bindm(void* g) {
+       // We assume this will always succeed, otherwise, there might be extra M leaking,
+       // when a C thread exits after a cgo call.
+       // We only invoke this function once per thread in runtime.needAndBindM,
+       // and the next calls just reuse the bound m.
+       pthread_setspecific(pthread_g, g);
+}
+
 void
 x_cgo_notify_runtime_init_done(void* dummy __attribute__ ((unused))) {
        pthread_mutex_lock(&runtime_init_mu);
@@ -110,3 +134,14 @@ _cgo_try_pthread_create(pthread_t* thread, const pthread_attr_t* attr, void* (*p
        }
        return EAGAIN;
 }
+
+static void
+pthread_key_destructor(void* g) {
+       if (x_crosscall2_ptr != NULL) {
+               // fn == NULL means dropm.
+               // We restore g by using the stored g, before dropm in runtime.cgocallback,
+               // since the g stored in the TLS by Go might be cleared in some platforms,
+               // before this destructor invoked.
+               x_crosscall2_ptr(NULL, g, 0, 0);
+       }
+}
index fdcf027424b6db28aef9dda6ec7620d3aded5dc8..9a8c65ea291ad8c342e448a52bc7e72c69549257 100644 (file)
@@ -30,6 +30,9 @@ static CRITICAL_SECTION runtime_init_cs;
 static HANDLE runtime_init_wait;
 static int runtime_init_done;
 
+uintptr_t x_cgo_pthread_key_created;
+void (*x_crosscall2_ptr)(void (*fn)(void *), void *, int, size_t);
+
 // Pre-initialize the runtime synchronization objects
 void
 _cgo_preinit_init() {
@@ -91,6 +94,12 @@ _cgo_wait_runtime_init_done(void) {
        return 0;
 }
 
+// Should not be used since x_cgo_pthread_key_created will always be zero.
+void x_cgo_bindm(void* dummy) {
+       fprintf(stderr, "unexpected cgo_bindm on Windows\n");
+       abort();
+}
+
 void
 x_cgo_notify_runtime_init_done(void* dummy) {
         _cgo_maybe_run_preinit();
index af4960e7e952206a0923d4495137bb8eafeac9b4..04755f0f207240bfbebd411642be468cb05afa80 100644 (file)
@@ -51,6 +51,11 @@ extern void (*_cgo_thread_start)(ThreadStart *ts);
  */
 extern void (*_cgo_sys_thread_create)(void* (*func)(void*), void* arg);
 
+/*
+ * Indicates whether a dummy pthread per-thread variable is allocated.
+ */
+extern uintptr_t *_cgo_pthread_key_created;
+
 /*
  * Creates the new operating system thread (OS, arch dependent).
  */
index f9d79eca4bc139a20aa393dbd9bec734fcced54c..7f1a02fb4b67e6b7e24584f3ccd4fac4f9e89cb9 100644 (file)
@@ -229,6 +229,9 @@ func cgocallbackg(fn, frame unsafe.Pointer, ctxt uintptr) {
        savedpc := gp.syscallpc
        exitsyscall() // coming out of cgo call
        gp.m.incgo = false
+       if gp.m.isextra {
+               gp.m.isExtraInC = false
+       }
 
        osPreemptExtExit(gp.m)
 
@@ -239,6 +242,9 @@ func cgocallbackg(fn, frame unsafe.Pointer, ctxt uintptr) {
        // This is enforced by checking incgo in the schedule function.
 
        gp.m.incgo = true
+       if gp.m.isextra {
+               gp.m.isExtraInC = true
+       }
 
        if gp.m != checkm {
                throw("m changed unexpectedly in cgocallbackg")
index 65556edd2ac27af48441401502114a69bb654fed..ad15ebf9c23040b098e765987928fc3329009ff8 100644 (file)
@@ -771,3 +771,16 @@ func TestCgoSigfwd(t *testing.T) {
                t.Fatalf("expected %q, but got:\n%s", want, got)
        }
 }
+
+func TestEnsureBindM(t *testing.T) {
+       t.Parallel()
+       switch runtime.GOOS {
+       case "windows", "plan9":
+               t.Skipf("skipping bindm test on %s", runtime.GOOS)
+       }
+       got := runTestProg(t, "testprogcgo", "EnsureBindM")
+       want := "OK\n"
+       if got != want {
+               t.Errorf("expected %q, got %v", want, got)
+       }
+}
index 76ed8966dc8b101d0fb488fd225cdf0f5eb499e5..f4bf650e3b10e1fe0bd49f53e191a36b6a28c129 100644 (file)
@@ -210,6 +210,10 @@ func main() {
 
        main_init_done = make(chan bool)
        if iscgo {
+               if _cgo_pthread_key_created == nil {
+                       throw("_cgo_pthread_key_created missing")
+               }
+
                if _cgo_thread_start == nil {
                        throw("_cgo_thread_start missing")
                }
@@ -224,6 +228,13 @@ func main() {
                if _cgo_notify_runtime_init_done == nil {
                        throw("_cgo_notify_runtime_init_done missing")
                }
+
+               // Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
+               if set_crosscall2 == nil {
+                       throw("set_crosscall2 missing")
+               }
+               set_crosscall2()
+
                // Start the template thread in case we enter Go from
                // a C-created thread and need to create a new thread.
                startTemplateThread()
@@ -1870,8 +1881,9 @@ func allocm(pp *p, fn func(), id int64) *m {
 // pressed into service as the scheduling stack and current
 // goroutine for the duration of the cgo callback.
 //
-// When the callback is done with the m, it calls dropm to
-// put the m back on the list.
+// It calls dropm to put the m back on the list,
+// 1. when the callback is done with the m in non-pthread platforms,
+// 2. or when the C thread exiting on pthread platforms.
 //
 //go:nosplit
 func needm() {
@@ -1933,6 +1945,11 @@ func needm() {
        gp.stack.lo = getcallersp() - 32*1024
        gp.stackguard0 = gp.stack.lo + _StackGuard
 
+       // Should mark we are already in Go now.
+       // Otherwise, we may call needm again when we get a signal, before cgocallbackg1,
+       // which means the extram list may be empty, that will cause a deadlock.
+       mp.isExtraInC = false
+
        // Initialize this thread to use the m.
        asminit()
        minit()
@@ -1942,6 +1959,17 @@ func needm() {
        sched.ngsys.Add(-1)
 }
 
+// Acquire an extra m and bind it to the C thread when a pthread key has been created.
+//
+//go:nosplit
+func needAndBindM() {
+       needm()
+
+       if _cgo_pthread_key_created != nil && *(*uintptr)(_cgo_pthread_key_created) != 0 {
+               cgoBindM()
+       }
+}
+
 // newextram allocates m's and puts them on the extra list.
 // It is called with a working local m, so that it can do things
 // like call schedlock and allocate.
@@ -1986,6 +2014,8 @@ func oneNewExtraM() {
        gp.m = mp
        mp.curg = gp
        mp.isextra = true
+       // mark we are in C by default.
+       mp.isExtraInC = true
        mp.lockedInt++
        mp.lockedg.set(gp)
        gp.lockedm.set(mp)
@@ -2018,9 +2048,11 @@ func oneNewExtraM() {
        unlockextra(mp)
 }
 
+// dropm puts the current m back onto the extra list.
+//
+// 1. On systems without pthreads, like Windows
 // dropm is called when a cgo callback has called needm but is now
 // done with the callback and returning back into the non-Go thread.
-// It puts the current m back onto the extra list.
 //
 // The main expense here is the call to signalstack to release the
 // m's signal stack, and then the call to needm on the next callback
@@ -2032,15 +2064,18 @@ func oneNewExtraM() {
 // call. These should typically not be scheduling operations, just a few
 // atomics, so the cost should be small.
 //
-// TODO(rsc): An alternative would be to allocate a dummy pthread per-thread
-// variable using pthread_key_create. Unlike the pthread keys we already use
-// on OS X, this dummy key would never be read by Go code. It would exist
-// only so that we could register at thread-exit-time destructor.
-// That destructor would put the m back onto the extra list.
-// This is purely a performance optimization. The current version,
-// in which dropm happens on each cgo call, is still correct too.
-// We may have to keep the current version on systems with cgo
-// but without pthreads, like Windows.
+// 2. On systems with pthreads
+// dropm is called while a non-Go thread is exiting.
+// We allocate a pthread per-thread variable using pthread_key_create,
+// to register a thread-exit-time destructor.
+// And store the g into a thread-specific value associated with the pthread key,
+// when first return back to C.
+// So that the destructor would invoke dropm while the non-Go thread is exiting.
+// This is much faster since it avoids expensive signal-related syscalls.
+//
+// NOTE: this always runs without a P, so, nowritebarrierrec required.
+//
+//go:nowritebarrierrec
 func dropm() {
        // Clear m and g, and return m to the extra list.
        // After the call to setg we can only call nosplit functions
@@ -2072,6 +2107,39 @@ func dropm() {
        msigrestore(sigmask)
 }
 
+// bindm store the g0 of the current m into a thread-specific value.
+//
+// We allocate a pthread per-thread variable using pthread_key_create,
+// to register a thread-exit-time destructor.
+// We are here setting the thread-specific value of the pthread key, to enable the destructor.
+// So that the pthread_key_destructor would dropm while the C thread is exiting.
+//
+// And the saved g will be used in pthread_key_destructor,
+// since the g stored in the TLS by Go might be cleared in some platforms,
+// before the destructor invoked, so, we restore g by the stored g, before dropm.
+//
+// We store g0 instead of m, to make the assembly code simpler,
+// since we need to restore g0 in runtime.cgocallback.
+//
+// On systems without pthreads, like Windows, bindm shouldn't be used.
+//
+// NOTE: this always runs without a P, so, nowritebarrierrec required.
+//
+//go:nosplit
+//go:nowritebarrierrec
+func cgoBindM() {
+       if GOOS == "windows" || GOOS == "plan9" {
+               fatal("bindm in unexpected GOOS")
+       }
+       g := getg()
+       if g.m.g0 != g {
+               fatal("the current g is not g0")
+       }
+       if _cgo_bindm != nil {
+               asmcgocall(_cgo_bindm, unsafe.Pointer(g))
+       }
+}
+
 // A helper function for EnsureDropM.
 func getm() uintptr {
        return uintptr(unsafe.Pointer(getg().m))
index a9706a642e802f0aa32e5d196c7cc033a8f6638b..3ef7521ff303fbd666054374683e11f3b55256c0 100644 (file)
@@ -561,6 +561,7 @@ type m struct {
        printlock     int8
        incgo         bool          // m is executing a cgo call
        isextra       bool          // m is an extra m
+       isExtraInC    bool          // m is an extra m that is not executing Go code
        freeWait      atomic.Uint32 // Whether it is safe to free g0 and delete m (one of freeMRef, freeMStack, freeMWait)
        fastrand      uint64
        needextram    bool
index c401fc1b7a572ba95f10c6ad5833c1799ac6bec0..026a503eb1a6ba1cf9f3853baaa4d3d60bc19f63 100644 (file)
@@ -435,7 +435,7 @@ func sigtrampgo(sig uint32, info *siginfo, ctx unsafe.Pointer) {
        c := &sigctxt{info, ctx}
        gp := sigFetchG(c)
        setg(gp)
-       if gp == nil {
+       if gp == nil || (gp.m != nil && gp.m.isExtraInC) {
                if sig == _SIGPROF {
                        // Some platforms (Linux) have per-thread timers, which we use in
                        // combination with the process-wide timer. Avoid double-counting.
@@ -458,7 +458,18 @@ func sigtrampgo(sig uint32, info *siginfo, ctx unsafe.Pointer) {
                        return
                }
                c.fixsigcode(sig)
+               // Set g to nil here and badsignal will use g0 by needm.
+               // TODO: reuse the current m here by using the gsignal and adjustSignalStack,
+               // since the current g maybe a normal goroutine and actually running on the signal stack,
+               // it may hit stack split that is not expected here.
+               if gp != nil {
+                       setg(nil)
+               }
                badsignal(uintptr(sig), c)
+               // Restore g
+               if gp != nil {
+                       setg(gp)
+               }
                return
        }
 
@@ -1121,8 +1132,9 @@ func sigfwdgo(sig uint32, info *siginfo, ctx unsafe.Pointer) bool {
        //   (1) we weren't in VDSO page,
        //   (2) we were in a goroutine (i.e., m.curg != nil), and
        //   (3) we weren't in CGO.
+       //   (4) we weren't in dropped extra m.
        gp := sigFetchG(c)
-       if gp != nil && gp.m != nil && gp.m.curg != nil && !gp.m.incgo {
+       if gp != nil && gp.m != nil && gp.m.curg != nil && !gp.m.isExtraInC && !gp.m.incgo {
                return false
        }
 
index 373445d613ea59f63840c7e06eae002ee2626644..65b7299f745be6be7bff1989f697e7e59b025634 100644 (file)
@@ -237,6 +237,9 @@ func noEscapePtr[T any](p *T) *T {
 // cgocallback is not called from Go, only from crosscall2.
 // This in turn calls cgocallbackg, which is where we'll find
 // pointer-declared arguments.
+//
+// When fn is nil (frame is saved g), call dropm instead,
+// this is used when the C thread is exiting.
 func cgocallback(fn, frame, ctxt uintptr)
 
 func gogo(buf *gobuf)
diff --git a/src/runtime/testdata/testprogcgo/bindm.go b/src/runtime/testdata/testprogcgo/bindm.go
new file mode 100644 (file)
index 0000000..ed2c6a7
--- /dev/null
@@ -0,0 +1,89 @@
+// Copyright 2023 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+//go:build !plan9 && !windows
+
+// Test that callbacks from C to Go in the same C-thread always get the same m.
+// Make sure the extra M bind to the C-thread.
+
+package main
+
+/*
+#include <stdint.h>
+#include <pthread.h>
+#include <unistd.h>
+
+extern void GoCheckBindM();
+
+#define CTHREADS 2
+#define CHECKCALLS 100
+
+static void* checkBindMThread(void* thread) {
+       int i;
+       for (i = 0; i < CHECKCALLS; i++) {
+               GoCheckBindM((uintptr_t)thread);
+               usleep(1);
+       }
+       return NULL;
+}
+
+static void CheckBindM() {
+       int i;
+       pthread_t s[CTHREADS];
+
+       for (i = 0; i < CTHREADS; i++) {
+               pthread_create(&s[i], NULL, checkBindMThread, &s[i]);
+       }
+       for (i = 0; i < CTHREADS; i++) {
+               pthread_join(s[i], NULL);
+       }
+}
+*/
+import "C"
+
+import (
+       "fmt"
+       "os"
+       "runtime"
+       "sync"
+       "sync/atomic"
+)
+
+var (
+       mutex      = sync.Mutex{}
+       cThreadToM = map[uintptr]uintptr{}
+       started    = atomic.Uint32{}
+)
+
+// same as CTHREADS in C, make sure all the C threads are actually started.
+const cThreadNum = 2
+
+func init() {
+       register("EnsureBindM", EnsureBindM)
+}
+
+//export GoCheckBindM
+func GoCheckBindM(thread uintptr) {
+       // Wait all threads start
+       if started.Load() != cThreadNum {
+               // Only once for each thread, since it will wait all threads start.
+               started.Add(1)
+               for started.Load() < cThreadNum {
+                       runtime.Gosched()
+               }
+       }
+       m := runtime_getm_for_test()
+       mutex.Lock()
+       defer mutex.Unlock()
+       if savedM, ok := cThreadToM[thread]; ok && savedM != m {
+               fmt.Printf("m == %x want %x\n", m, savedM)
+               os.Exit(1)
+       }
+       cThreadToM[thread] = m
+}
+
+func EnsureBindM() {
+       C.CheckBindM()
+       fmt.Println("OK")
+}