enable --trap-all if has call to trap.AddInterceptor

Author: xhd2015

cmd/xgo/instrument.go

@@ -40,7 +40,7 @@ import (
 const MAX_FILE_SIZE = 1 * 1024 * 1024
 
 // goroot is critical for stdlib
-func instrumentUserCode(goroot string, projectDir string, projectRoot string, goVersion *goinfo.GoVersion, xgoSrc string, mod string, modfile string, mainModule string, xgoRuntimeModuleDir string, mayHaveCover bool, overlayFS overlay.Overlay, includeTest bool, rules []Rule, trapPkgs []string, trapAll bool, collectTestTrace bool, collectTestTraceDir string, goFlag bool, triedUpgrade bool) error {
+func instrumentUserCode(goroot string, projectDir string, projectRoot string, goVersion *goinfo.GoVersion, xgoSrc string, mod string, modfile string, mainModule string, xgoRuntimeModuleDir string, mayHaveCover bool, overlayFS overlay.Overlay, includeTest bool, rules []Rule, trapPkgs []string, trapAll string, collectTestTrace bool, collectTestTraceDir string, goFlag bool, triedUpgrade bool) error {
 	logDebug("instrumentUserSpace: mod=%s, modfile=%s, xgoRuntimeModuleDir=%s, includeTest=%v, collectTestTrace=%v", mod, modfile, xgoRuntimeModuleDir, includeTest, collectTestTrace)
 	if mod == "" {
 		// check vendor dir
@@ -189,13 +189,14 @@ func instrumentUserCode(goroot string, projectDir string, projectRoot string, go
 	mainPkgs := pkgs.Filter(func(pkg *edit.Package) bool {
 		return pkg.Main && pkg.AllowInstrument
 	})
-	var recorder resolve.Recorder
 	for _, pkg := range mainPkgs {
 		resolve.CollectDecls(pkg)
 	}
 
 	traverseBegin := time.Now()
 	logDebug("traverse: len(mainPkgs)=%d", len(mainPkgs))
+
+	var recorder resolve.Recorder
 	err = resolve.Traverse(reg, mainPkgs, &recorder)
 	if err != nil {
 		return err
@@ -208,7 +209,10 @@ func instrumentUserCode(goroot string, projectDir string, projectRoot string, go
 		return err
 	}
 
-	logDebug("start instrumentFuncTrap: len(packages)=%d", len(pkgs.Packages))
+	// ""->default
+	needTrapAll := trapAll == "true" || (trapAll == "" && recorder.HasTrapInterceptorRef)
+
+	logDebug("start instrumentFuncTrap: len(packages)=%d, needTrapAll=%v", len(pkgs.Packages), needTrapAll)
 	for _, pkg := range pkgs.Packages {
 		if !pkg.AllowInstrument {
 			continue
@@ -217,7 +221,7 @@ func instrumentUserCode(goroot string, projectDir string, projectRoot string, go
 		cfg := config.GetPkgConfig(pkgPath)
 		var defaultAllow bool
 		if !pkg.LoadPackage.GoPackage.Standard {
-			if trapAll || pkg.Initial {
+			if needTrapAll || pkg.Initial {
 				defaultAllow = true
 			}
 		}

cmd/xgo/main.go

@@ -445,7 +445,7 @@ func handleBuild(cmd string, args []string) error {
 		buildCacheSuffix += "-strace_" + v
 	}
 	// see https://github.com/xhd2015/xgo/issues/311
-	if trapAll {
+	if trapAll != "false" {
 		buildCacheSuffix += "-trap-all"
 	}
 	if stackTraceDir != "" && stackTraceDir != "." && stackTraceDir != "./" {

cmd/xgo/option.go

@@ -64,7 +64,8 @@ type options struct {
 	// --trap-stdlib
 	trapStdlib bool
 	// --trap-all
-	trapAll bool
+	// "": default, "true"->true, "false"->false
+	trapAll string
 
 	// --trap pkg
 	// where pkg cannot be runtime
@@ -149,7 +150,7 @@ func parseOptions(cmd string, args []string) (*options, error) {
 	var stackTraceDir string
 	var straceSnapshotMainModuleDefault string
 	var trapStdlib bool
-	var trapAll bool
+	var trapAll string
 	var trap []string
 
 	var remainArgs []string
@@ -439,9 +440,9 @@ func parseOptions(cmd string, args []string) (*options, error) {
 		trapAllFlag, trapAllVal := flag.TrySingleFlag([]string{"--trap-all"}, arg)
 		if trapAllFlag != "" {
 			if trapAllVal == "" || trapAllVal == "true" {
-				trapAll = true
+				trapAll = "true"
 			} else {
-				trapAll = false
+				trapAll = "false"
 			}
 			continue
 		}

cmd/xgo/version.go

@@ -7,8 +7,8 @@ import "fmt"
 // VERSION is manually updated when needed a new tag
 // if you did not install git hooks, you can manually update them
 const VERSION = "1.1.1"
-const REVISION = "0d3787edd9e0b47f8b62e3e445b2461d753d17a5+1"
-const NUMBER = 404
+const REVISION = "09acbf99d8ada59af1648fe155931d901f3614d5+1"
+const NUMBER = 405
 
 // The CORE_REVISION is cache related.
 // because xgo contains multiple packages, not every

instrument/resolve/record.go

@@ -31,6 +31,12 @@ func (c *Scope) recordTrap(sel *ast.SelectorExpr) bool {
 	if name == "InfoFunc" || name == "InfoVar" {
 		return pkgPath == constants.RUNTIME_FUNCTAB_PKG
 	}
+	if name == "AddInterceptor" {
+		if pkgPath == constants.RUNTIME_TRAP_PKG {
+			c.Global.Recorder.HasTrapInterceptorRef = true
+		}
+		return false
+	}
 	return false
 }
 

instrument/resolve/scope.go

@@ -17,7 +17,11 @@ import (
 type PkgScopeNames map[string]*edit.Decl
 
 type Recorder struct {
-	Pkgs map[string]*PkgRecorder
+	// has called `trap.AddInterceptor`?
+	// if so, we need to enable trapAll mode
+	// as mentioned in https://github.com/xhd2015/xgo/issues/308#issuecomment-2800327536
+	HasTrapInterceptorRef bool
+	Pkgs                  map[string]*PkgRecorder
 }
 
 func (c *Recorder) GetOrInit(pkgPath string) *PkgRecorder {

runtime/test/build/overlay_build_cache_error_with_go/gomod_test.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/xhd2015/xgo/runtime/test/build/util"
 	"github.com/xhd2015/xgo/support/cmd"
+	"github.com/xhd2015/xgo/support/goinfo"
 )
 
 func TestGoModNonOverlayFirstShouldError(t *testing.T) {
@@ -33,16 +34,43 @@ func TestGoModNonOverlayFirstShouldError(t *testing.T) {
 	// this should error
 	var errOut bytes.Buffer
 	afterErr := cmd.Debug().Stdout(&errOut).Stderr(&errOut).Env([]string{"GOCACHE=" + gocache, "GO_BYPASS_XGO=true"}).Run("go", "test", "-v", "-overlay", overlayFile, "./overlay_test_with_gomod")
-	if afterErr == nil {
-		t.Errorf("expect cache+overlay combination error, actual nil")
+
+	// 17, 18 passes, only after go1.19 this issue happens
+	minor, err := getGo1MinorVersion()
+	if err != nil {
+		t.Fatalf("failed to get go minor version: %v", err)
 	}
-	expectContains := "could not import runtime (open : no such file or directory)"
-	errOutStr := errOut.String()
-	if !strings.Contains(errOutStr, expectContains) {
-		t.Errorf("expect containing %q, actual none", expectContains)
-		t.Logf("DEBUG: %s", errOutStr)
-		return
+	if minor >= 19 {
+		if afterErr == nil {
+			t.Errorf("expect cache+overlay combination error, actual nil")
+		}
+		expectContains := "could not import runtime (open : no such file or directory)"
+		errOutStr := errOut.String()
+		if !strings.Contains(errOutStr, expectContains) {
+			t.Errorf("expect containing %q, actual none", expectContains)
+			t.Logf("DEBUG: %s", errOutStr)
+			return
+		}
+	} else {
+		if afterErr != nil {
+			t.Errorf("expect cache+overlay under go1.19 success, actual error: %v", afterErr)
+		}
+	}
+}
+
+func getGo1MinorVersion() (int, error) {
+	rv, err := goinfo.GetGoVersionOutput("go")
+	if err != nil {
+		return 0, err
+	}
+	goV, err := goinfo.ParseGoVersion(rv)
+	if err != nil {
+		return 0, err
+	}
+	if goV.Major != 1 {
+		return 0, fmt.Errorf("unrecognized go major: %s", rv)
 	}
+	return goV.Minor, nil
 }
 
 func TestGoModNonOverlayLaterShouldSucceed(t *testing.T) {

runtime/test/test-config.txt

@@ -1,4 +1,4 @@
-flags: --trap-stdlib
+flags: --trap-stdlib --trap-all=false
 args: ./bugs/...
 args: ./core/...
 args: ./functab/...

script/run-test/main.go

@@ -714,8 +714,8 @@ func doRunTest(goroot string, usePlainGo bool, dir string, args []string, tests
 		}
 		testArgs = testArgs[:i]
 	}
-	// debug
 
+	// debug
 	var binary string
 	if debug {
 		fmt.Printf("testArgs: %v\n", testArgs)