abi_test.go

     1  // Copyright 2021 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  //go:build goexperiment.regabiargs
     6  
     7  // This file contains tests specific to making sure the register ABI
     8  // works in a bunch of contexts in the runtime.
     9  
    10  package runtime_test
    11  
    12  import (
    13  	"internal/abi"
    14  	"internal/runtime/atomic"
    15  	"internal/testenv"
    16  	"os"
    17  	"os/exec"
    18  	"runtime"
    19  	"strings"
    20  	"testing"
    21  	"time"
    22  )
    23  
    24  var regConfirmRun atomic.Int32
    25  
    26  //go:registerparams
    27  func regFinalizerPointer(v *TintPointer) (int, float32, [10]byte) {
    28  	regConfirmRun.Store(int32(*(*int)(v.p)))
    29  	return 5151, 4.0, [10]byte{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
    30  }
    31  
    32  //go:registerparams
    33  func regFinalizerIface(v Tinter) (int, float32, [10]byte) {
    34  	regConfirmRun.Store(int32(*(*int)(v.(*TintPointer).p)))
    35  	return 5151, 4.0, [10]byte{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
    36  }
    37  
    38  // TintPointer has a pointer member to make sure that it isn't allocated by the
    39  // tiny allocator, so we know when its finalizer will run
    40  type TintPointer struct {
    41  	p *Tint
    42  }
    43  
    44  func (*TintPointer) m() {}
    45  
    46  func TestFinalizerRegisterABI(t *testing.T) {
    47  	// Actually run the test in a subprocess because we don't want
    48  	// finalizers from other tests interfering.
    49  	if os.Getenv("TEST_FINALIZER_REGABI") != "1" {
    50  		cmd := testenv.CleanCmdEnv(exec.Command(testenv.Executable(t), "-test.run=^TestFinalizerRegisterABI$", "-test.v"))
    51  		cmd.Env = append(cmd.Env, "TEST_FINALIZER_REGABI=1")
    52  		out, err := cmd.CombinedOutput()
    53  		if !strings.Contains(string(out), "PASS\n") || err != nil {
    54  			t.Fatalf("%s\n(exit status %v)", string(out), err)
    55  		}
    56  		return
    57  	}
    58  
    59  	// Optimistically clear any latent finalizers from e.g. the testing
    60  	// package before continuing.
    61  	//
    62  	// It's possible that a finalizer only becomes available to run
    63  	// after this point, which would interfere with the test and could
    64  	// cause a crash, but because we're running in a separate process
    65  	// it's extremely unlikely.
    66  	runtime.GC()
    67  	runtime.GC()
    68  
    69  	// fing will only pick the new IntRegArgs up if it's currently
    70  	// sleeping and wakes up, so wait for it to go to sleep.
    71  	success := false
    72  	for i := 0; i < 100; i++ {
    73  		if runtime.FinalizerGAsleep() {
    74  			success = true
    75  			break
    76  		}
    77  		time.Sleep(20 * time.Millisecond)
    78  	}
    79  	if !success {
    80  		t.Fatal("finalizer not asleep?")
    81  	}
    82  
    83  	argRegsBefore := runtime.SetIntArgRegs(abi.IntArgRegs)
    84  	defer runtime.SetIntArgRegs(argRegsBefore)
    85  
    86  	tests := []struct {
    87  		name         string
    88  		fin          any
    89  		confirmValue int
    90  	}{
    91  		{"Pointer", regFinalizerPointer, -1},
    92  		{"Interface", regFinalizerIface, -2},
    93  	}
    94  	for i := range tests {
    95  		test := &tests[i]
    96  		t.Run(test.name, func(t *testing.T) {
    97  			x := &TintPointer{p: new(Tint)}
    98  			*x.p = (Tint)(test.confirmValue)
    99  			runtime.SetFinalizer(x, test.fin)
   100  
   101  			runtime.KeepAlive(x)
   102  
   103  			// Queue the finalizer.
   104  			runtime.GC()
   105  			runtime.GC()
   106  
   107  			if !runtime.BlockUntilEmptyFinalizerQueue(int64(time.Second)) {
   108  				t.Fatal("finalizer failed to execute")
   109  			}
   110  			if got := int(regConfirmRun.Load()); got != test.confirmValue {
   111  				t.Fatalf("wrong finalizer executed? got %d, want %d", got, test.confirmValue)
   112  			}
   113  		})
   114  	}
   115  }
   116
View as plain text