func.go

     1  // Copyright 2020 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 ir
     6  
     7  import (
     8  	"cmd/compile/internal/base"
     9  	"cmd/compile/internal/types"
    10  	"cmd/internal/obj"
    11  	"cmd/internal/objabi"
    12  	"cmd/internal/src"
    13  	"fmt"
    14  	"strings"
    15  	"unicode/utf8"
    16  )
    17  
    18  // A Func corresponds to a single function in a Go program
    19  // (and vice versa: each function is denoted by exactly one *Func).
    20  //
    21  // There are multiple nodes that represent a Func in the IR.
    22  //
    23  // The ONAME node (Func.Nname) is used for plain references to it.
    24  // The ODCLFUNC node (the Func itself) is used for its declaration code.
    25  // The OCLOSURE node (Func.OClosure) is used for a reference to a
    26  // function literal.
    27  //
    28  // An imported function will have an ONAME node which points to a Func
    29  // with an empty body.
    30  // A declared function or method has an ODCLFUNC (the Func itself) and an ONAME.
    31  // A function literal is represented directly by an OCLOSURE, but it also
    32  // has an ODCLFUNC (and a matching ONAME) representing the compiled
    33  // underlying form of the closure, which accesses the captured variables
    34  // using a special data structure passed in a register.
    35  //
    36  // A method declaration is represented like functions, except f.Sym
    37  // will be the qualified method name (e.g., "T.m").
    38  //
    39  // A method expression (T.M) is represented as an OMETHEXPR node,
    40  // in which n.Left and n.Right point to the type and method, respectively.
    41  // Each distinct mention of a method expression in the source code
    42  // constructs a fresh node.
    43  //
    44  // A method value (t.M) is represented by ODOTMETH/ODOTINTER
    45  // when it is called directly and by OMETHVALUE otherwise.
    46  // These are like method expressions, except that for ODOTMETH/ODOTINTER,
    47  // the method name is stored in Sym instead of Right.
    48  // Each OMETHVALUE ends up being implemented as a new
    49  // function, a bit like a closure, with its own ODCLFUNC.
    50  // The OMETHVALUE uses n.Func to record the linkage to
    51  // the generated ODCLFUNC, but there is no
    52  // pointer from the Func back to the OMETHVALUE.
    53  type Func struct {
    54  	// if you add or remove a field, don't forget to update sizeof_test.go
    55  
    56  	miniNode
    57  	Body Nodes
    58  
    59  	Nname    *Name        // ONAME node
    60  	OClosure *ClosureExpr // OCLOSURE node
    61  
    62  	// ONAME nodes for all params/locals for this func/closure, does NOT
    63  	// include closurevars until transforming closures during walk.
    64  	// Names must be listed PPARAMs, PPARAMOUTs, then PAUTOs,
    65  	// with PPARAMs and PPARAMOUTs in order corresponding to the function signature.
    66  	// Anonymous and blank params are declared as ~pNN (for PPARAMs) and ~rNN (for PPARAMOUTs).
    67  	Dcl []*Name
    68  
    69  	// ClosureVars lists the free variables that are used within a
    70  	// function literal, but formally declared in an enclosing
    71  	// function. The variables in this slice are the closure function's
    72  	// own copy of the variables, which are used within its function
    73  	// body. They will also each have IsClosureVar set, and will have
    74  	// Byval set if they're captured by value.
    75  	ClosureVars []*Name
    76  
    77  	// Enclosed functions that need to be compiled.
    78  	// Populated during walk.
    79  	Closures []*Func
    80  
    81  	// Parent of a closure
    82  	ClosureParent *Func
    83  
    84  	// Parents records the parent scope of each scope within a
    85  	// function. The root scope (0) has no parent, so the i'th
    86  	// scope's parent is stored at Parents[i-1].
    87  	Parents []ScopeID
    88  
    89  	// Marks records scope boundary changes.
    90  	Marks []Mark
    91  
    92  	FieldTrack map[*obj.LSym]struct{}
    93  	DebugInfo  any
    94  	LSym       *obj.LSym // Linker object in this function's native ABI (Func.ABI)
    95  
    96  	Inl *Inline
    97  
    98  	// RangeParent, if non-nil, is the first non-range body function containing
    99  	// the closure for the body of a range function.
   100  	RangeParent *Func
   101  
   102  	// funcLitGen, rangeLitGen and goDeferGen track how many closures have been
   103  	// created in this function for function literals, range-over-func loops,
   104  	// and go/defer wrappers, respectively. Used by closureName for creating
   105  	// unique function names.
   106  	// Tracking goDeferGen separately avoids wrappers throwing off
   107  	// function literal numbering (e.g., runtime/trace_test.TestTraceSymbolize.func11).
   108  	funcLitGen  int32
   109  	rangeLitGen int32
   110  	goDeferGen  int32
   111  
   112  	Label int32 // largest auto-generated label in this function
   113  
   114  	Endlineno src.XPos
   115  	WBPos     src.XPos // position of first write barrier; see SetWBPos
   116  
   117  	Pragma PragmaFlag // go:xxx function annotations
   118  
   119  	flags bitset16
   120  
   121  	// ABI is a function's "definition" ABI. This is the ABI that
   122  	// this function's generated code is expecting to be called by.
   123  	//
   124  	// For most functions, this will be obj.ABIInternal. It may be
   125  	// a different ABI for functions defined in assembly or ABI wrappers.
   126  	//
   127  	// This is included in the export data and tracked across packages.
   128  	ABI obj.ABI
   129  	// ABIRefs is the set of ABIs by which this function is referenced.
   130  	// For ABIs other than this function's definition ABI, the
   131  	// compiler generates ABI wrapper functions. This is only tracked
   132  	// within a package.
   133  	ABIRefs obj.ABISet
   134  
   135  	NumDefers  int32 // number of defer calls in the function
   136  	NumReturns int32 // number of explicit returns in the function
   137  
   138  	// NWBRCalls records the LSyms of functions called by this
   139  	// function for go:nowritebarrierrec analysis. Only filled in
   140  	// if nowritebarrierrecCheck != nil.
   141  	NWBRCalls *[]SymAndPos
   142  
   143  	// For wrapper functions, WrappedFunc point to the original Func.
   144  	// Currently only used for go/defer wrappers.
   145  	WrappedFunc *Func
   146  
   147  	// WasmImport is used by the //go:wasmimport directive to store info about
   148  	// a WebAssembly function import.
   149  	WasmImport *WasmImport
   150  	// WasmExport is used by the //go:wasmexport directive to store info about
   151  	// a WebAssembly function import.
   152  	WasmExport *WasmExport
   153  }
   154  
   155  // WasmImport stores metadata associated with the //go:wasmimport pragma.
   156  type WasmImport struct {
   157  	Module string
   158  	Name   string
   159  }
   160  
   161  // WasmExport stores metadata associated with the //go:wasmexport pragma.
   162  type WasmExport struct {
   163  	Name string
   164  }
   165  
   166  // NewFunc returns a new Func with the given name and type.
   167  //
   168  // fpos is the position of the "func" token, and npos is the position
   169  // of the name identifier.
   170  //
   171  // TODO(mdempsky): I suspect there's no need for separate fpos and
   172  // npos.
   173  func NewFunc(fpos, npos src.XPos, sym *types.Sym, typ *types.Type) *Func {
   174  	name := NewNameAt(npos, sym, typ)
   175  	name.Class = PFUNC
   176  	sym.SetFunc(true)
   177  
   178  	fn := &Func{Nname: name}
   179  	fn.pos = fpos
   180  	fn.op = ODCLFUNC
   181  	// Most functions are ABIInternal. The importer or symabis
   182  	// pass may override this.
   183  	fn.ABI = obj.ABIInternal
   184  	fn.SetTypecheck(1)
   185  
   186  	name.Func = fn
   187  
   188  	return fn
   189  }
   190  
   191  func (f *Func) isStmt() {}
   192  
   193  func (n *Func) copy() Node                                   { panic(n.no("copy")) }
   194  func (n *Func) doChildren(do func(Node) bool) bool           { return doNodes(n.Body, do) }
   195  func (n *Func) doChildrenWithHidden(do func(Node) bool) bool { return doNodes(n.Body, do) }
   196  func (n *Func) editChildren(edit func(Node) Node)            { editNodes(n.Body, edit) }
   197  func (n *Func) editChildrenWithHidden(edit func(Node) Node)  { editNodes(n.Body, edit) }
   198  
   199  func (f *Func) Type() *types.Type                { return f.Nname.Type() }
   200  func (f *Func) Sym() *types.Sym                  { return f.Nname.Sym() }
   201  func (f *Func) Linksym() *obj.LSym               { return f.Nname.Linksym() }
   202  func (f *Func) LinksymABI(abi obj.ABI) *obj.LSym { return f.Nname.LinksymABI(abi) }
   203  
   204  // An Inline holds fields used for function bodies that can be inlined.
   205  type Inline struct {
   206  	Cost int32 // heuristic cost of inlining this function
   207  
   208  	// Copy of Func.Dcl for use during inlining. This copy is needed
   209  	// because the function's Dcl may change from later compiler
   210  	// transformations. This field is also populated when a function
   211  	// from another package is imported and inlined.
   212  	Dcl     []*Name
   213  	HaveDcl bool // whether we've loaded Dcl
   214  
   215  	// Function properties, encoded as a string (these are used for
   216  	// making inlining decisions). See cmd/compile/internal/inline/inlheur.
   217  	Properties string
   218  
   219  	// CanDelayResults reports whether it's safe for the inliner to delay
   220  	// initializing the result parameters until immediately before the
   221  	// "return" statement.
   222  	CanDelayResults bool
   223  }
   224  
   225  // A Mark represents a scope boundary.
   226  type Mark struct {
   227  	// Pos is the position of the token that marks the scope
   228  	// change.
   229  	Pos src.XPos
   230  
   231  	// Scope identifies the innermost scope to the right of Pos.
   232  	Scope ScopeID
   233  }
   234  
   235  // A ScopeID represents a lexical scope within a function.
   236  type ScopeID int32
   237  
   238  const (
   239  	funcDupok                    = 1 << iota // duplicate definitions ok
   240  	funcWrapper                              // hide frame from users (elide in tracebacks, don't count as a frame for recover())
   241  	funcABIWrapper                           // is an ABI wrapper (also set flagWrapper)
   242  	funcNeedctxt                             // function uses context register (has closure variables)
   243  	funcHasDefer                             // contains a defer statement
   244  	funcNilCheckDisabled                     // disable nil checks when compiling this function
   245  	funcInlinabilityChecked                  // inliner has already determined whether the function is inlinable
   246  	funcNeverReturns                         // function never returns (in most cases calls panic(), os.Exit(), or equivalent)
   247  	funcOpenCodedDeferDisallowed             // can't do open-coded defers
   248  	funcClosureResultsLost                   // closure is called indirectly and we lost track of its results; used by escape analysis
   249  	funcPackageInit                          // compiler emitted .init func for package
   250  )
   251  
   252  type SymAndPos struct {
   253  	Sym *obj.LSym // LSym of callee
   254  	Pos src.XPos  // line of call
   255  }
   256  
   257  func (f *Func) Dupok() bool                    { return f.flags&funcDupok != 0 }
   258  func (f *Func) Wrapper() bool                  { return f.flags&funcWrapper != 0 }
   259  func (f *Func) ABIWrapper() bool               { return f.flags&funcABIWrapper != 0 }
   260  func (f *Func) Needctxt() bool                 { return f.flags&funcNeedctxt != 0 }
   261  func (f *Func) HasDefer() bool                 { return f.flags&funcHasDefer != 0 }
   262  func (f *Func) NilCheckDisabled() bool         { return f.flags&funcNilCheckDisabled != 0 }
   263  func (f *Func) InlinabilityChecked() bool      { return f.flags&funcInlinabilityChecked != 0 }
   264  func (f *Func) NeverReturns() bool             { return f.flags&funcNeverReturns != 0 }
   265  func (f *Func) OpenCodedDeferDisallowed() bool { return f.flags&funcOpenCodedDeferDisallowed != 0 }
   266  func (f *Func) ClosureResultsLost() bool       { return f.flags&funcClosureResultsLost != 0 }
   267  func (f *Func) IsPackageInit() bool            { return f.flags&funcPackageInit != 0 }
   268  
   269  func (f *Func) SetDupok(b bool)                    { f.flags.set(funcDupok, b) }
   270  func (f *Func) SetWrapper(b bool)                  { f.flags.set(funcWrapper, b) }
   271  func (f *Func) SetABIWrapper(b bool)               { f.flags.set(funcABIWrapper, b) }
   272  func (f *Func) SetNeedctxt(b bool)                 { f.flags.set(funcNeedctxt, b) }
   273  func (f *Func) SetHasDefer(b bool)                 { f.flags.set(funcHasDefer, b) }
   274  func (f *Func) SetNilCheckDisabled(b bool)         { f.flags.set(funcNilCheckDisabled, b) }
   275  func (f *Func) SetInlinabilityChecked(b bool)      { f.flags.set(funcInlinabilityChecked, b) }
   276  func (f *Func) SetNeverReturns(b bool)             { f.flags.set(funcNeverReturns, b) }
   277  func (f *Func) SetOpenCodedDeferDisallowed(b bool) { f.flags.set(funcOpenCodedDeferDisallowed, b) }
   278  func (f *Func) SetClosureResultsLost(b bool)       { f.flags.set(funcClosureResultsLost, b) }
   279  func (f *Func) SetIsPackageInit(b bool)            { f.flags.set(funcPackageInit, b) }
   280  
   281  func (f *Func) SetWBPos(pos src.XPos) {
   282  	if base.Debug.WB != 0 {
   283  		base.WarnfAt(pos, "write barrier")
   284  	}
   285  	if !f.WBPos.IsKnown() {
   286  		f.WBPos = pos
   287  	}
   288  }
   289  
   290  // IsClosure reports whether f is a function literal that captures at least one value.
   291  func (f *Func) IsClosure() bool {
   292  	if f.OClosure == nil {
   293  		return false
   294  	}
   295  	return len(f.ClosureVars) > 0
   296  }
   297  
   298  // FuncName returns the name (without the package) of the function f.
   299  func FuncName(f *Func) string {
   300  	if f == nil || f.Nname == nil {
   301  		return "<nil>"
   302  	}
   303  	return f.Sym().Name
   304  }
   305  
   306  // PkgFuncName returns the name of the function referenced by f, with package
   307  // prepended.
   308  //
   309  // This differs from the compiler's internal convention where local functions
   310  // lack a package. This is primarily useful when the ultimate consumer of this
   311  // is a human looking at message.
   312  func PkgFuncName(f *Func) string {
   313  	if f == nil || f.Nname == nil {
   314  		return "<nil>"
   315  	}
   316  	s := f.Sym()
   317  	pkg := s.Pkg
   318  	if pkg == nil {
   319  		return "<nil>." + s.Name
   320  	}
   321  	return pkg.Path + "." + s.Name
   322  }
   323  
   324  // LinkFuncName returns the name of the function f, as it will appear in the
   325  // symbol table of the final linked binary.
   326  func LinkFuncName(f *Func) string {
   327  	if f == nil || f.Nname == nil {
   328  		return "<nil>"
   329  	}
   330  	s := f.Sym()
   331  	pkg := s.Pkg
   332  
   333  	return objabi.PathToPrefix(pkg.Path) + "." + s.Name
   334  }
   335  
   336  // ParseLinkFuncName parsers a symbol name (as returned from LinkFuncName) back
   337  // to the package path and local symbol name.
   338  func ParseLinkFuncName(name string) (pkg, sym string, err error) {
   339  	pkg, sym = splitPkg(name)
   340  	if pkg == "" {
   341  		return "", "", fmt.Errorf("no package path in name")
   342  	}
   343  
   344  	pkg, err = objabi.PrefixToPath(pkg) // unescape
   345  	if err != nil {
   346  		return "", "", fmt.Errorf("malformed package path: %v", err)
   347  	}
   348  
   349  	return pkg, sym, nil
   350  }
   351  
   352  // Borrowed from x/mod.
   353  func modPathOK(r rune) bool {
   354  	if r < utf8.RuneSelf {
   355  		return r == '-' || r == '.' || r == '_' || r == '~' ||
   356  			'0' <= r && r <= '9' ||
   357  			'A' <= r && r <= 'Z' ||
   358  			'a' <= r && r <= 'z'
   359  	}
   360  	return false
   361  }
   362  
   363  func escapedImportPathOK(r rune) bool {
   364  	return modPathOK(r) || r == '+' || r == '/' || r == '%'
   365  }
   366  
   367  // splitPkg splits the full linker symbol name into package and local symbol
   368  // name.
   369  func splitPkg(name string) (pkgpath, sym string) {
   370  	// package-sym split is at first dot after last the / that comes before
   371  	// any characters illegal in a package path.
   372  
   373  	lastSlashIdx := 0
   374  	for i, r := range name {
   375  		// Catches cases like:
   376  		// * example.foo[sync/atomic.Uint64].
   377  		// * example%2ecom.foo[sync/atomic.Uint64].
   378  		//
   379  		// Note that name is still escaped; unescape occurs after splitPkg.
   380  		if !escapedImportPathOK(r) {
   381  			break
   382  		}
   383  		if r == '/' {
   384  			lastSlashIdx = i
   385  		}
   386  	}
   387  	for i := lastSlashIdx; i < len(name); i++ {
   388  		r := name[i]
   389  		if r == '.' {
   390  			return name[:i], name[i+1:]
   391  		}
   392  	}
   393  
   394  	return "", name
   395  }
   396  
   397  var CurFunc *Func
   398  
   399  // WithFunc invokes do with CurFunc and base.Pos set to curfn and
   400  // curfn.Pos(), respectively, and then restores their previous values
   401  // before returning.
   402  func WithFunc(curfn *Func, do func()) {
   403  	oldfn, oldpos := CurFunc, base.Pos
   404  	defer func() { CurFunc, base.Pos = oldfn, oldpos }()
   405  
   406  	CurFunc, base.Pos = curfn, curfn.Pos()
   407  	do()
   408  }
   409  
   410  func FuncSymName(s *types.Sym) string {
   411  	return s.Name + "·f"
   412  }
   413  
   414  // ClosureDebugRuntimeCheck applies boilerplate checks for debug flags
   415  // and compiling runtime.
   416  func ClosureDebugRuntimeCheck(clo *ClosureExpr) {
   417  	if base.Debug.Closure > 0 {
   418  		if clo.Esc() == EscHeap {
   419  			base.WarnfAt(clo.Pos(), "heap closure, captured vars = %v", clo.Func.ClosureVars)
   420  		} else {
   421  			base.WarnfAt(clo.Pos(), "stack closure, captured vars = %v", clo.Func.ClosureVars)
   422  		}
   423  	}
   424  	if base.Flag.CompilingRuntime && clo.Esc() == EscHeap && !clo.IsGoWrap {
   425  		base.ErrorfAt(clo.Pos(), 0, "heap-allocated closure %s, not allowed in runtime", FuncName(clo.Func))
   426  	}
   427  }
   428  
   429  // globClosgen is like Func.Closgen, but for the global scope.
   430  var globClosgen int32
   431  
   432  // closureName generates a new unique name for a closure within outerfn at pos.
   433  func closureName(outerfn *Func, pos src.XPos, why Op) *types.Sym {
   434  	if outerfn.OClosure != nil && outerfn.OClosure.Func.RangeParent != nil {
   435  		outerfn = outerfn.OClosure.Func.RangeParent
   436  	}
   437  	pkg := types.LocalPkg
   438  	outer := "glob."
   439  	var suffix string = "."
   440  	switch why {
   441  	default:
   442  		base.FatalfAt(pos, "closureName: bad Op: %v", why)
   443  	case OCLOSURE:
   444  		if outerfn.OClosure == nil {
   445  			suffix = ".func"
   446  		}
   447  	case ORANGE:
   448  		suffix = "-range"
   449  	case OGO:
   450  		suffix = ".gowrap"
   451  	case ODEFER:
   452  		suffix = ".deferwrap"
   453  	}
   454  	gen := &globClosgen
   455  
   456  	// There may be multiple functions named "_". In those
   457  	// cases, we can't use their individual Closgens as it
   458  	// would lead to name clashes.
   459  	if !IsBlank(outerfn.Nname) {
   460  		pkg = outerfn.Sym().Pkg
   461  		outer = FuncName(outerfn)
   462  
   463  		switch why {
   464  		case OCLOSURE:
   465  			gen = &outerfn.funcLitGen
   466  		case ORANGE:
   467  			gen = &outerfn.rangeLitGen
   468  		default:
   469  			gen = &outerfn.goDeferGen
   470  		}
   471  	}
   472  
   473  	// If this closure was created due to inlining, then incorporate any
   474  	// inlined functions' names into the closure's linker symbol name
   475  	// too (#60324).
   476  	if inlIndex := base.Ctxt.InnermostPos(pos).Base().InliningIndex(); inlIndex >= 0 {
   477  		names := []string{outer}
   478  		base.Ctxt.InlTree.AllParents(inlIndex, func(call obj.InlinedCall) {
   479  			names = append(names, call.Name)
   480  		})
   481  		outer = strings.Join(names, ".")
   482  	}
   483  
   484  	*gen++
   485  	return pkg.Lookup(fmt.Sprintf("%s%s%d", outer, suffix, *gen))
   486  }
   487  
   488  // NewClosureFunc creates a new Func to represent a function literal
   489  // with the given type.
   490  //
   491  // fpos the position used for the underlying ODCLFUNC and ONAME,
   492  // whereas cpos is the position used for the OCLOSURE. They're
   493  // separate because in the presence of inlining, the OCLOSURE node
   494  // should have an inline-adjusted position, whereas the ODCLFUNC and
   495  // ONAME must not.
   496  //
   497  // outerfn is the enclosing function. The returned function is
   498  // appending to pkg.Funcs.
   499  //
   500  // why is the reason we're generating this Func. It can be OCLOSURE
   501  // (for a normal function literal) or OGO or ODEFER (for wrapping a
   502  // call expression that has parameters or results).
   503  func NewClosureFunc(fpos, cpos src.XPos, why Op, typ *types.Type, outerfn *Func, pkg *Package) *Func {
   504  	if outerfn == nil {
   505  		base.FatalfAt(fpos, "outerfn is nil")
   506  	}
   507  
   508  	fn := NewFunc(fpos, fpos, closureName(outerfn, cpos, why), typ)
   509  	fn.SetDupok(outerfn.Dupok()) // if the outer function is dupok, so is the closure
   510  
   511  	clo := &ClosureExpr{Func: fn}
   512  	clo.op = OCLOSURE
   513  	clo.pos = cpos
   514  	clo.SetType(typ)
   515  	clo.SetTypecheck(1)
   516  	if why == ORANGE {
   517  		clo.Func.RangeParent = outerfn
   518  		if outerfn.OClosure != nil && outerfn.OClosure.Func.RangeParent != nil {
   519  			clo.Func.RangeParent = outerfn.OClosure.Func.RangeParent
   520  		}
   521  	}
   522  	fn.OClosure = clo
   523  
   524  	fn.Nname.Defn = fn
   525  	pkg.Funcs = append(pkg.Funcs, fn)
   526  	fn.ClosureParent = outerfn
   527  
   528  	return fn
   529  }
   530  
   531  // IsFuncPCIntrinsic returns whether n is a direct call of internal/abi.FuncPCABIxxx functions.
   532  func IsFuncPCIntrinsic(n *CallExpr) bool {
   533  	if n.Op() != OCALLFUNC || n.Fun.Op() != ONAME {
   534  		return false
   535  	}
   536  	fn := n.Fun.(*Name).Sym()
   537  	return (fn.Name == "FuncPCABI0" || fn.Name == "FuncPCABIInternal") &&
   538  		fn.Pkg.Path == "internal/abi"
   539  }
   540  
   541  // IsIfaceOfFunc inspects whether n is an interface conversion from a direct
   542  // reference of a func. If so, it returns referenced Func; otherwise nil.
   543  //
   544  // This is only usable before walk.walkConvertInterface, which converts to an
   545  // OMAKEFACE.
   546  func IsIfaceOfFunc(n Node) *Func {
   547  	if n, ok := n.(*ConvExpr); ok && n.Op() == OCONVIFACE {
   548  		if name, ok := n.X.(*Name); ok && name.Op() == ONAME && name.Class == PFUNC {
   549  			return name.Func
   550  		}
   551  	}
   552  	return nil
   553  }
   554  
   555  // FuncPC returns a uintptr-typed expression that evaluates to the PC of a
   556  // function as uintptr, as returned by internal/abi.FuncPC{ABI0,ABIInternal}.
   557  //
   558  // n should be a Node of an interface type, as is passed to
   559  // internal/abi.FuncPC{ABI0,ABIInternal}.
   560  //
   561  // TODO(prattmic): Since n is simply an interface{} there is no assertion that
   562  // it is actually a function at all. Perhaps we should emit a runtime type
   563  // assertion?
   564  func FuncPC(pos src.XPos, n Node, wantABI obj.ABI) Node {
   565  	if !n.Type().IsInterface() {
   566  		base.ErrorfAt(pos, 0, "internal/abi.FuncPC%s expects an interface value, got %v", wantABI, n.Type())
   567  	}
   568  
   569  	if fn := IsIfaceOfFunc(n); fn != nil {
   570  		name := fn.Nname
   571  		abi := fn.ABI
   572  		if abi != wantABI {
   573  			base.ErrorfAt(pos, 0, "internal/abi.FuncPC%s expects an %v function, %s is defined as %v", wantABI, wantABI, name.Sym().Name, abi)
   574  		}
   575  		var e Node = NewLinksymExpr(pos, name.LinksymABI(abi), types.Types[types.TUINTPTR])
   576  		e = NewAddrExpr(pos, e)
   577  		e.SetType(types.Types[types.TUINTPTR].PtrTo())
   578  		e = NewConvExpr(pos, OCONVNOP, types.Types[types.TUINTPTR], e)
   579  		e.SetTypecheck(1)
   580  		return e
   581  	}
   582  	// fn is not a defined function. It must be ABIInternal.
   583  	// Read the address from func value, i.e. *(*uintptr)(idata(fn)).
   584  	if wantABI != obj.ABIInternal {
   585  		base.ErrorfAt(pos, 0, "internal/abi.FuncPC%s does not accept func expression, which is ABIInternal", wantABI)
   586  	}
   587  	var e Node = NewUnaryExpr(pos, OIDATA, n)
   588  	e.SetType(types.Types[types.TUINTPTR].PtrTo())
   589  	e.SetTypecheck(1)
   590  	e = NewStarExpr(pos, e)
   591  	e.SetType(types.Types[types.TUINTPTR])
   592  	e.SetTypecheck(1)
   593  	return e
   594  }
   595  
   596  // DeclareParams creates Names for all of the parameters in fn's
   597  // signature and adds them to fn.Dcl.
   598  //
   599  // If setNname is true, then it also sets types.Field.Nname for each
   600  // parameter.
   601  func (fn *Func) DeclareParams(setNname bool) {
   602  	if fn.Dcl != nil {
   603  		base.FatalfAt(fn.Pos(), "%v already has Dcl", fn)
   604  	}
   605  
   606  	declareParams := func(params []*types.Field, ctxt Class, prefix string, offset int) {
   607  		for i, param := range params {
   608  			sym := param.Sym
   609  			if sym == nil || sym.IsBlank() {
   610  				sym = fn.Sym().Pkg.LookupNum(prefix, i)
   611  			}
   612  
   613  			name := NewNameAt(param.Pos, sym, param.Type)
   614  			name.Class = ctxt
   615  			name.Curfn = fn
   616  			fn.Dcl[offset+i] = name
   617  
   618  			if setNname {
   619  				param.Nname = name
   620  			}
   621  		}
   622  	}
   623  
   624  	sig := fn.Type()
   625  	params := sig.RecvParams()
   626  	results := sig.Results()
   627  
   628  	fn.Dcl = make([]*Name, len(params)+len(results))
   629  	declareParams(params, PPARAM, "~p", 0)
   630  	declareParams(results, PPARAMOUT, "~r", len(params))
   631  }
   632  
   633  // ContainsClosure reports whether c is a closure contained within f.
   634  func ContainsClosure(f, c *Func) bool {
   635  	// Common cases.
   636  	if f == c || c.OClosure == nil {
   637  		return false
   638  	}
   639  
   640  	for p := c.ClosureParent; p != nil; p = p.ClosureParent {
   641  		if p == f {
   642  			return true
   643  		}
   644  	}
   645  	return false
   646  }
   647
View as plain text