gcassert.go

package gcassert

import (
	"bufio"
	"errors"
	"fmt"
	"go/ast"
	"go/printer"
	"go/token"
	"go/types"
	"io"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
	"sort"
	"strconv"
	"strings"

	"golang.org/x/tools/go/packages"
)

type assertDirective int

const (
	noDirective assertDirective = iota
	inline
	bce
	noescape
)

func stringToDirective(s string) (assertDirective, error) {
	switch s {
	case "inline":
		return inline, nil
	case "bce":
		return bce, nil
	case "noescape":
		return noescape, nil
	}
	return noDirective, errors.New(fmt.Sprintf("unknown directive %q", s))
}

// passInfo contains info on a passed directive for directives that have
// compiler output when they pass, such as the inlining directive.
type passInfo struct {
	passed bool
	// colNo is the column number of the location of the inlineable callsite.
	colNo int
}

type lineInfo struct {
	n          ast.Node
	directives []assertDirective

	inlinableCallsites []passInfo
	// passedDirective is a map from index into the directives slice to a
	// boolean that says whether or not the directive succeeded, in the case
	// of directives like inlining that have compiler output if they passed.
	// For directives like bce that have compiler output if they failed, there's
	// no entry in this map.
	passedDirective map[int]bool
}

var gcAssertRegex = regexp.MustCompile(`// ?gcassert:([\w,]+)`)

type assertVisitor struct {
	commentMap ast.CommentMap

	// directiveMap is a map from line number in the source file to the AST node
	// that the line number corresponded to, as well as any directives that we
	// parsed.
	directiveMap map[int]lineInfo

	// mustInlineFuncs is a set of types.Objects that represent FuncDecls of
	// some kind that were marked with //gcassert:inline by the user.
	mustInlineFuncs map[types.Object]struct{}
	fileSet         *token.FileSet
	cwd             string

	p *packages.Package

	errOutput io.Writer
}

func newAssertVisitor(
	commentMap ast.CommentMap,
	fileSet *token.FileSet,
	cwd string,
	p *packages.Package,
	mustInlineFuncs map[types.Object]struct{},
	errOutput io.Writer,
) assertVisitor {
	return assertVisitor{
		commentMap:      commentMap,
		fileSet:         fileSet,
		cwd:             cwd,
		directiveMap:    make(map[int]lineInfo),
		mustInlineFuncs: mustInlineFuncs,
		p:               p,
		errOutput:       errOutput,
	}
}

func (v *assertVisitor) Visit(node ast.Node) ast.Visitor {
	if node == nil {
		return nil
	}
	pos := v.fileSet.Position(node.Pos())

	m := v.commentMap[node]
	for _, g := range m {
		for _, c := range g.List {
			matches := gcAssertRegex.FindStringSubmatch(c.Text)
			if len(matches) == 0 {
				continue
			}
			// The 0th match is the whole string, and the 1st match is the
			// gcassert directive(s).
			directiveStrings := strings.Split(matches[1], ",")

			lineInfo := v.directiveMap[pos.Line]
			lineInfo.n = node
			for _, s := range directiveStrings {
				directive, err := stringToDirective(s)
				if err != nil {
					printAssertionFailure(v.cwd, v.fileSet, node, v.errOutput, err.Error())
					continue
				}
				if directive == inline {
					switch n := node.(type) {
					case *ast.FuncDecl:
						// Add the Object that this FuncDecl's ident is connected
						// to our map of must-inline functions.
						obj := v.p.TypesInfo.Defs[n.Name]
						if obj != nil {
							v.mustInlineFuncs[obj] = struct{}{}
						}
						continue
					}
				}
				lineInfo.directives = append(lineInfo.directives, directive)
				v.directiveMap[pos.Line] = lineInfo
			}
		}
	}
	return v
}

// GCAssert searches through the packages at the input path and writes failures
// to comply with //gcassert directives to the given io.Writer.
func GCAssert(w io.Writer, paths ...string) error {
	return GCAssertCwd(w, "", paths...)
}

// GCAssertCwd performs the same operation as GCAssert, but runs `go build` in
// the provided working directory `cwd`. If `cwd` is the empty string, then
// `go build` will be run in the current working directory.
func GCAssertCwd(w io.Writer, cwd string, paths ...string) error {
	var err error
	if cwd == "" {
		cwd, err = os.Getwd()
		if err != nil {
			return err
		}
	}

	fileSet := token.NewFileSet()
	pkgs, err := packages.Load(&packages.Config{
		Dir: cwd,
		Mode: packages.NeedName | packages.NeedFiles | packages.NeedSyntax | packages.NeedCompiledGoFiles |
			packages.NeedTypesInfo | packages.NeedTypes,
		Fset: fileSet,
	}, paths...)
	directiveMap, err := parseDirectives(pkgs, fileSet, cwd, w)
	if err != nil {
		return err
	}

	// Next: invoke Go compiler with -m flags to get the compiler to print
	// its optimization decisions.

	args := []string{"build", "-gcflags=-m=2 -d=ssa/check_bce/debug=1"}
	for i := range paths {
		if filepath.IsAbs(paths[i]) {
			args = append(args, paths[i])
		} else {
			args = append(args, "./"+paths[i])
		}
	}
	cmd := exec.Command("go", args...)
	cmd.Dir = cwd
	pr, pw := io.Pipe()
	// Create a temp file to log all diagnostic output.
	f, err := os.CreateTemp("", "gcassert-*.log")
	if err != nil {
		return err
	}
	fmt.Printf("See %s for full output.\n", f.Name())
	// Log full 'go build' command.
	fmt.Fprintln(f, cmd)
	mw := io.MultiWriter(pw, f)
	cmd.Stdout = mw
	cmd.Stderr = mw
	cmdErr := make(chan error, 1)

	go func() {
		cmdErr <- cmd.Run()
		_ = pw.Close()
		_ = f.Close()
	}()

	scanner := bufio.NewScanner(pr)
	optInfo := regexp.MustCompile(`([\.\/\w]+):(\d+):(\d+): (.*)`)
	boundsCheck := "Found IsInBounds"
	sliceBoundsCheck := "Found IsSliceInBounds"

	for scanner.Scan() {
		line := scanner.Text()
		matches := optInfo.FindStringSubmatch(line)
		if len(matches) != 0 {
			path := matches[1]
			lineNo, err := strconv.Atoi(matches[2])
			if err != nil {
				return err
			}
			colNo, err := strconv.Atoi(matches[3])
			if err != nil {
				return err
			}
			message := matches[4]

			if !filepath.IsAbs(path) {
				path = filepath.Join(cwd, path)
			}
			if lineToDirectives := directiveMap[path]; lineToDirectives != nil {
				info := lineToDirectives[lineNo]
				if len(info.directives) > 0 {
					if info.passedDirective == nil {
						info.passedDirective = make(map[int]bool)
						lineToDirectives[lineNo] = info
					}
				}
				for i, d := range info.directives {
					switch d {
					case bce:
						if message == boundsCheck || message == sliceBoundsCheck {
							// Error! We found a bounds check where the user expected
							// there to be none.
							// Print out the user's code lineNo that failed the assertion,
							// the assertion itself, and the compiler output that
							// proved that the assertion failed.
							printAssertionFailure(cwd, fileSet, info.n, w, message)
						}
					case inline:
						if strings.HasPrefix(message, "inlining call to") {
							info.passedDirective[i] = true
						}
					case noescape:
						if strings.HasSuffix(message, "escapes to heap:") {
							printAssertionFailure(cwd, fileSet, info.n, w, message)
						}
					}
				}
				for i := range info.inlinableCallsites {
					cs := &info.inlinableCallsites[i]
					if cs.colNo == colNo {
						cs.passed = true
					}
				}
			}
		}
	}

	keys := make([]string, 0, len(directiveMap))
	for k := range directiveMap {
		keys = append(keys, k)
	}
	sort.Strings(keys)

	var lines []int
	for _, k := range keys {
		lines = lines[:0]
		lineToDirectives := directiveMap[k]
		for line := range lineToDirectives {
			lines = append(lines, line)
		}
		sort.Ints(lines)
		for _, line := range lines {
			info := lineToDirectives[line]
			for _, d := range info.inlinableCallsites {
				// An inlining directive passes if it has compiler output. For
				// each inlining directive, check if there was matching compiler
				// output and fail if not.
				if !d.passed {
					printAssertionFailure(cwd, fileSet, info.n, w, "call was not inlined")
				}
			}
			for i, d := range info.directives {
				if d != inline {
					continue
				}
				if !info.passedDirective[i] {
					printAssertionFailure(cwd, fileSet, info.n, w, "call was not inlined")
				}
			}
		}
	}
	// If 'go build' failed, return the error.
	if err := <-cmdErr; err != nil {
		return err
	}
	return nil
}

func printAssertionFailure(cwd string, fileSet *token.FileSet, n ast.Node, w io.Writer, message string) {
	var buf strings.Builder
	_ = printer.Fprint(&buf, fileSet, n)
	pos := fileSet.Position(n.Pos())
	relPath, err := filepath.Rel(cwd, pos.Filename)
	if err != nil {
		relPath = pos.Filename
	}
	fmt.Fprintf(w, "%s:%d:\t%s: %s\n", relPath, pos.Line, buf.String(), message)
}

// directiveMap maps filepath to line number to lineInfo
type directiveMap map[string]map[int]lineInfo

func parseDirectives(pkgs []*packages.Package, fileSet *token.FileSet, cwd string, errOutput io.Writer) (directiveMap, error) {
	fileDirectiveMap := make(directiveMap)
	mustInlineFuncs := make(map[types.Object]struct{})
	for _, pkg := range pkgs {
		for i, file := range pkg.Syntax {
			commentMap := ast.NewCommentMap(fileSet, file, file.Comments)

			v := newAssertVisitor(commentMap, fileSet, cwd, pkg, mustInlineFuncs, errOutput)
			// First: find all lines of code annotated with our gcassert directives.
			ast.Walk(&v, file)

			file := pkg.CompiledGoFiles[i]
			if len(v.directiveMap) > 0 {
				fileDirectiveMap[file] = v.directiveMap
			}
		}
	}

	// Do another pass to find all callsites of funcs marked with inline.
	for _, pkg := range pkgs {
		for i, file := range pkg.Syntax {
			v := &inlinedDeclVisitor{assertVisitor: newAssertVisitor(nil, fileSet, cwd, pkg, mustInlineFuncs, errOutput)}
			filePath := pkg.CompiledGoFiles[i]
			v.directiveMap = fileDirectiveMap[filePath]
			if v.directiveMap == nil {
				v.directiveMap = make(map[int]lineInfo)
			}
			ast.Walk(v, file)
			if len(v.directiveMap) > 0 {
				fileDirectiveMap[filePath] = v.directiveMap
			}
		}
	}
	return fileDirectiveMap, nil
}

type inlinedDeclVisitor struct {
	assertVisitor
}

func (v *inlinedDeclVisitor) Visit(node ast.Node) ast.Visitor {
	if node == nil {
		return nil
	}
	pos := node.Pos()
	lineNumber := v.fileSet.Position(pos).Line

	// Search for all func callsites of functions that were marked with
	// gcassert:inline and add inline directives to those callsites.
	switch n := node.(type) {
	case *ast.CallExpr:
		callExpr := n
		var obj types.Object
		switch n := n.Fun.(type) {
		case *ast.Ident:
			obj = v.p.TypesInfo.Uses[n]
		case *ast.SelectorExpr:
			sel := v.p.TypesInfo.Selections[n]
			if sel != nil {
				obj = sel.Obj()
			} else {
				obj = v.p.TypesInfo.Uses[n.Sel]
			}
		}
		if _, ok := v.mustInlineFuncs[obj]; ok {
			lineInfo := v.directiveMap[lineNumber]
			lineInfo.n = node
			lineInfo.inlinableCallsites = append(lineInfo.inlinableCallsites,
				passInfo{colNo: v.fileSet.Position(callExpr.Lparen).Column})
			v.directiveMap[lineNumber] = lineInfo
		}
	}
	return v
}