src/cmd/compile/internal/inline/inlheur/callsite.go

   1 // Copyright 2023 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 package inlheur
   6
   7 import (
   8         "cmd/compile/internal/base"
   9         "cmd/compile/internal/ir"
  10         "cmd/internal/src"
  11         "fmt"
  12         "io"
  13         "path/filepath"
  14         "sort"
  15         "strings"
  16 )
  17
  18 // CallSite records useful information about a potentially inlinable
  19 // (direct) function call. "Callee" is the target of the call, "Call"
  20 // is the ir node corresponding to the call itself, "Assign" is
  21 // the top-level assignment statement containing the call (if the call
  22 // appears in the form of a top-level statement, e.g. "x := foo()"),
  23 // "Flags" contains properties of the call that might be useful for
  24 // making inlining decisions, "Score" is the final score assigned to
  25 // the site, and "ID" is a numeric ID for the site within its
  26 // containing function.
  27 type CallSite struct {
  28         Callee    *ir.Func
  29         Call      *ir.CallExpr
  30         Assign    ir.Node
  31         Flags     CSPropBits
  32         Score     int
  33         ScoreMask scoreAdjustTyp
  34         ID        uint
  35 }
  36
  37 // CallSiteTab is a table of call sites, keyed by call expr.
  38 // Ideally it would be nice to key the table by src.XPos, but
  39 // this results in collisions for calls on very long lines (the
  40 // front end saturates column numbers at 255). We also wind up
  41 // with many calls that share the same auto-generated pos.
  42 type CallSiteTab map[*ir.CallExpr]*CallSite
  43
  44 // Package-level table of callsites.
  45 var cstab = CallSiteTab{}
  46
  47 func GetCallSiteScore(ce *ir.CallExpr) (bool, int) {
  48         cs, ok := cstab[ce]
  49         if !ok {
  50                 return false, 0
  51         }
  52         return true, cs.Score
  53 }
  54
  55 type CSPropBits uint32
  56
  57 const (
  58         CallSiteInLoop CSPropBits = 1 << iota
  59         CallSiteOnPanicPath
  60         CallSiteInInitFunc
  61 )
  62
  63 // encodedCallSiteTab is a table keyed by "encoded" callsite
  64 // (stringified src.XPos plus call site ID) mapping to a value of call
  65 // property bits and score.
  66 type encodedCallSiteTab map[string]propsAndScore
  67
  68 type propsAndScore struct {
  69         props CSPropBits
  70         score int
  71         mask  scoreAdjustTyp
  72 }
  73
  74 func (pas propsAndScore) String() string {
  75         return fmt.Sprintf("P=%s|S=%d|M=%s", pas.props.String(),
  76                 pas.score, pas.mask.String())
  77 }
  78
  79 func (cst CallSiteTab) merge(other CallSiteTab) error {
  80         for k, v := range other {
  81                 if prev, ok := cst[k]; ok {
  82                         return fmt.Errorf("internal error: collision during call site table merge, fn=%s callsite=%s", prev.Callee.Sym().Name, fmtFullPos(prev.Call.Pos()))
  83                 }
  84                 cst[k] = v
  85         }
  86         return nil
  87 }
  88
  89 func fmtFullPos(p src.XPos) string {
  90         var sb strings.Builder
  91         sep := ""
  92         base.Ctxt.AllPos(p, func(pos src.Pos) {
  93                 fmt.Fprintf(&sb, sep)
  94                 sep = "|"
  95                 file := filepath.Base(pos.Filename())
  96                 fmt.Fprintf(&sb, "%s:%d:%d", file, pos.Line(), pos.Col())
  97         })
  98         return sb.String()
  99 }
 100
 101 func encodeCallSiteKey(cs *CallSite) string {
 102         var sb strings.Builder
 103         // FIXME: maybe rewrite line offsets relative to function start?
 104         sb.WriteString(fmtFullPos(cs.Call.Pos()))
 105         fmt.Fprintf(&sb, "|%d", cs.ID)
 106         return sb.String()
 107 }
 108
 109 func buildEncodedCallSiteTab(tab CallSiteTab) encodedCallSiteTab {
 110         r := make(encodedCallSiteTab)
 111         for _, cs := range tab {
 112                 k := encodeCallSiteKey(cs)
 113                 r[k] = propsAndScore{
 114                         props: cs.Flags,
 115                         score: cs.Score,
 116                         mask:  cs.ScoreMask,
 117                 }
 118         }
 119         return r
 120 }
 121
 122 // dumpCallSiteComments emits comments into the dump file for the
 123 // callsites in the function of interest. If "ecst" is non-nil, we use
 124 // that, otherwise generated a fresh encodedCallSiteTab from "tab".
 125 func dumpCallSiteComments(w io.Writer, tab CallSiteTab, ecst encodedCallSiteTab) {
 126         if ecst == nil {
 127                 ecst = buildEncodedCallSiteTab(tab)
 128         }
 129         tags := make([]string, 0, len(ecst))
 130         for k := range ecst {
 131                 tags = append(tags, k)
 132         }
 133         sort.Strings(tags)
 134         for _, s := range tags {
 135                 v := ecst[s]
 136                 fmt.Fprintf(w, "// callsite: %s flagstr %q flagval %d score %d mask %d maskstr %q\n", s, v.props.String(), v.props, v.score, v.mask, v.mask.String())
 137         }
 138         fmt.Fprintf(w, "// %s\n", csDelimiter)
 139 }