Fix issues with latest Go and generics (#202)

* Updated dependencies; removed `pointer` analyzer as it panics in go 1.22; updated docs * Updated pipeline * Alwaysa use InstantiateGenerics mode * Improve margin when using go graphviz for rendering * Fix detecting std packages * Update deps with fixes for go callgraph analysis * Handle synthetic function detection where callee pkg is nil * Add logging for analysis process Signed-off-by: Ondrej Fabry <[email protected]> * Update CI workflow Signed-off-by: Ondrej Fabry <[email protected]> --------- Signed-off-by: Ondrej Fabry <[email protected]> Co-authored-by: Egor Aristov <[email protected]>
ondrajz · Jan 1, 2025 · 25ddacd · 25ddacd
1 parent 5341ae2
commit 25ddacd
Show file tree

Hide file tree

Showing 12 changed files with 200 additions and 208 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,11 +2,10 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
   pull_request:
     branches: [ master ]
   schedule:
-    - cron: '0 */12 * * *'
+    - cron: '0 3 * * *'
 
 jobs:
   build-test:
@@ -15,14 +14,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go: [ '1.20', '1.19' ]
+        go: [ 'stable', 'oldstable', '1.21' ]
 
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "Setup Go ${{ matrix.go }}"
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
 

diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,6 @@ _testmain.go
 # Builds
 /.build/
 go-callvis
+
+# IDE
+/.idea/
diff --git a/Makefile b/Makefile
@@ -38,7 +38,7 @@ help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
 build:  ## Build go-callvis
-	go build -tags $(GO_BUILD_TAGS) -ldflags "$(GO_LDFLAGS)" $(GO_BUILD_ARGS)
+	go build -v -tags $(GO_BUILD_TAGS) -ldflags "$(GO_LDFLAGS)" $(GO_BUILD_ARGS)
 
 test:  ## Run unit tests
 	go test -tags $(GO_BUILD_TAGS) -ldflags "$(GO_LDFLAGS)" $(GO_BUILD_ARGS) -short -race ./...

diff --git a/README.md b/README.md
@@ -128,6 +128,8 @@ Usage of go-callvis:
     	a list of build tags to consider satisfied during the build. For more information about build tags, see the description of build constraints in the documentation for the go/build package
   -tests
     	Include test code.
+  -algo string
+        Use specific algorithm for package analyzer: static, cha or rta (default "static")
   -version
     	Show version and exit.
 ```

diff --git a/analysis.go b/analysis.go
@@ -5,33 +5,33 @@ import (
 	"fmt"
 	"go/build"
 	"go/types"
-	"golang.org/x/tools/go/callgraph"
-	"golang.org/x/tools/go/callgraph/cha"
-	"golang.org/x/tools/go/callgraph/rta"
-	"golang.org/x/tools/go/callgraph/static"
 	"io"
 	"log"
 	"net/http"
 	"os"
 	"path/filepath"
 	"strings"
+	"time"
+
+	"golang.org/x/tools/go/callgraph"
+	"golang.org/x/tools/go/callgraph/cha"
+	"golang.org/x/tools/go/callgraph/rta"
+	"golang.org/x/tools/go/callgraph/static"
 
 	"golang.org/x/tools/go/packages"
-	"golang.org/x/tools/go/pointer"
 	"golang.org/x/tools/go/ssa"
 	"golang.org/x/tools/go/ssa/ssautil"
 )
 
 type CallGraphType string
 
 const (
-	CallGraphTypeStatic  CallGraphType = "static"
-	CallGraphTypeCha                   = "cha"
-	CallGraphTypeRta                   = "rta"
-	CallGraphTypePointer               = "pointer"
+	CallGraphTypeStatic CallGraphType = "static"
+	CallGraphTypeCha    CallGraphType = "cha"
+	CallGraphTypeRta    CallGraphType = "rta"
 )
 
-//==[ type def/func: analysis   ]===============================================
+// ==[ type def/func: analysis   ]===============================================
 type renderOpts struct {
 	cacheDir string
 	focus    string
@@ -80,7 +80,7 @@ func initFuncs(pkgs []*ssa.Package) ([]*ssa.Function, error) {
 	return inits, nil
 }
 
-//==[ type def/func: analysis   ]===============================================
+// ==[ type def/func: analysis   ]===============================================
 type analysis struct {
 	opts      *renderOpts
 	prog      *ssa.Program
@@ -97,30 +97,35 @@ func (a *analysis) DoAnalysis(
 	tests bool,
 	args []string,
 ) error {
+	logf("begin analysis")
+	defer logf("analysis done")
+
 	cfg := &packages.Config{
 		Mode:       packages.LoadAllSyntax,
 		Tests:      tests,
 		Dir:        dir,
 		BuildFlags: getBuildFlags(),
 	}
 
+	logf("loading packages")
+
 	initial, err := packages.Load(cfg, args...)
 	if err != nil {
 		return err
 	}
-
 	if packages.PrintErrors(initial) > 0 {
 		return fmt.Errorf("packages contain errors")
 	}
 
+	logf("loaded %d initial packages, building program", len(initial))
+
 	// Create and build SSA-form program representation.
-	mode := ssa.BuilderMode(0)
-	if algo == CallGraphTypeRta {
-		mode = ssa.InstantiateGenerics
-	}
+	mode := ssa.InstantiateGenerics
 	prog, pkgs := ssautil.AllPackages(initial, mode)
 	prog.Build()
 
+	logf("build done, computing callgraph (algo: %v)", algo)
+
 	var graph *callgraph.Graph
 	var mainPkg *ssa.Package
 
@@ -139,7 +144,7 @@ func (a *analysis) DoAnalysis(
 		for _, main := range mains {
 			roots = append(roots, main.Func("main"))
 		}
-		
+
 		inits, err := initFuncs(prog.AllPackages())
 		if err != nil {
 			return err
@@ -149,26 +154,11 @@ func (a *analysis) DoAnalysis(
 		}
 
 		graph = rta.Analyze(roots, true).CallGraph
-	case CallGraphTypePointer:
-		mains, err := mainPackages(prog.AllPackages())
-		if err != nil {
-			return err
-		}
-		mainPkg = mains[0]
-		config := &pointer.Config{
-			Mains:          mains,
-			BuildCallGraph: true,
-		}
-		ptares, err := pointer.Analyze(config)
-		if err != nil {
-			return err
-		}
-		graph = ptares.CallGraph
 	default:
 		return fmt.Errorf("invalid call graph type: %s", a.opts.algo)
 	}
 
-	//cg.DeleteSyntheticNodes()
+	logf("callgraph resolved with %d nodes", len(graph.Nodes))
 
 	a.prog = prog
 	a.pkgs = pkgs
@@ -276,6 +266,9 @@ func (a *analysis) Render() ([]byte, error) {
 		focusPkg *types.Package
 	)
 
+	start := time.Now()
+	logf("begin rendering")
+
 	if a.opts.focus != "" {
 		if ssaPkg = a.prog.ImportedPackage(a.opts.focus); ssaPkg == nil {
 			if strings.Contains(a.opts.focus, "/") {
@@ -302,7 +295,7 @@ func (a *analysis) Render() ([]byte, error) {
 			}
 		}
 		focusPkg = ssaPkg.Pkg
-		logf("focusing: %v", focusPkg.Path())
+		logf("focusing package: %v (path: %v)", focusPkg.Name(), focusPkg.Path())
 	}
 
 	dot, err := printOutput(
@@ -321,6 +314,8 @@ func (a *analysis) Render() ([]byte, error) {
 		return nil, fmt.Errorf("processing failed: %v", err)
 	}
 
+	logf("rendering done (took %v sec)", time.Since(start).Round(time.Millisecond).Seconds())
+
 	return dot, nil
 }