1 // Copyright 2011 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.
5 // This file implements the Check function, which drives type-checking.
17 // debugging/development support
19 debug = false // leave on during development
20 trace = false // turn on for detailed type resolution traces
22 // TODO(rfindley): add compiler error message handling from types2, guarded
23 // behind this flag, so that we can keep the code in sync.
24 compilerErrorMessages = false // match compiler error messages
27 // exprInfo stores information about an untyped expression.
28 type exprInfo struct {
29 isLhs bool // expression is lhs operand of a shift with delayed type-check
32 val constant.Value // constant value; or nil (if not a constant)
35 // An environment represents the environment within which an object is
37 type environment struct {
38 decl *declInfo // package-level declaration whose init expression/function body is checked
39 scope *Scope // top-most scope for lookups
40 pos token.Pos // if valid, identifiers are looked up as if at position pos (used by Eval)
41 iota constant.Value // value of iota in a constant declaration; nil otherwise
42 errpos positioner // if set, identifier position of a constant with inherited initializer
43 inTParamList bool // set if inside a type parameter list
44 sig *Signature // function signature if inside a function; nil otherwise
45 isPanic map[*ast.CallExpr]bool // set of panic call expressions (used for termination check)
46 hasLabel bool // set if a function makes use of labels (only ~1% of functions); unused outside functions
47 hasCallOrRecv bool // set if an expression contains a function call or channel receive operation
50 // lookup looks up name in the current environment and returns the matching object, or nil.
51 func (env *environment) lookup(name string) Object {
52 _, obj := env.scope.LookupParent(name, env.pos)
56 // An importKey identifies an imported package by import path and source directory
57 // (directory containing the file containing the import). In practice, the directory
58 // may always be the same, or may not matter. Given an (import path, directory), an
59 // importer must always return the same package (but given two different import paths,
60 // an importer may still return the same package by mapping them to the same package
62 type importKey struct {
66 // A dotImportKey describes a dot-imported object in the given scope.
67 type dotImportKey struct {
72 // An action describes a (delayed) action.
74 f func() // action to be executed
75 desc *actionDesc // action description; may be nil, requires debug to be set
78 // If debug is set, describef sets a printf-formatted description for action a.
79 // Otherwise, it is a no-op.
80 func (a *action) describef(pos positioner, format string, args ...any) {
82 a.desc = &actionDesc{pos, format, args}
86 // An actionDesc provides information on an action.
87 // For debugging only.
88 type actionDesc struct {
94 // A Checker maintains the state of the type checker.
95 // It must be created with NewChecker.
97 // package information
98 // (initialized by NewChecker, valid for the life-time of checker)
100 ctxt *Context // context for de-duplicating instances
104 version version // accepted language version
105 nextID uint64 // unique Id for type parameters (first valid Id is 1)
106 objMap map[Object]*declInfo // maps package-level objects and (non-interface) methods to declaration info
107 impMap map[importKey]*Package // maps (import path, source directory) to (complete or fake) package
108 valids instanceLookup // valid *Named (incl. instantiated) types per the validType check
110 // pkgPathMap maps package names to the set of distinct import paths we've
111 // seen for that name, anywhere in the import graph. It is used for
112 // disambiguating package names in error messages.
114 // pkgPathMap is allocated lazily, so that we don't pay the price of building
115 // it on the happy path. seenPkgMap tracks the packages that we've already
117 pkgPathMap map[string]map[string]bool
118 seenPkgMap map[*Package]bool
120 // information collected during type-checking of a set of package files
121 // (initialized by Files, valid only for the duration of check.Files;
122 // maps and lists are allocated on demand)
123 files []*ast.File // package files
124 imports []*PkgName // list of imported packages
125 dotImportMap map[dotImportKey]*PkgName // maps dot-imported objects to the package they were dot-imported through
126 recvTParamMap map[*ast.Ident]*TypeParam // maps blank receiver type parameters to their type
127 brokenAliases map[*TypeName]bool // set of aliases with broken (not yet determined) types
128 unionTypeSets map[*Union]*_TypeSet // computed type sets for union types
129 mono monoGraph // graph for detecting non-monomorphizable instantiation loops
131 firstErr error // first error encountered
132 methods map[*TypeName][]*Func // maps package scope type names to associated non-blank (non-interface) methods
133 untyped map[ast.Expr]exprInfo // map of expressions without final type
134 delayed []action // stack of delayed action segments; segments are processed in FIFO order
135 objPath []Object // path of object dependencies during type inference (for cycle reporting)
136 cleaners []cleaner // list of types that may need a final cleanup at the end of type-checking
138 // environment within which the current object is type-checked (valid only
139 // for the duration of type-checking a specific object)
143 indent int // indentation for tracing
146 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
147 func (check *Checker) addDeclDep(to Object) {
150 return // not in a package-level init expression
152 if _, found := check.objMap[to]; !found {
153 return // to is not a package-level object
158 // brokenAlias records that alias doesn't have a determined type yet.
159 // It also sets alias.typ to Typ[Invalid].
160 func (check *Checker) brokenAlias(alias *TypeName) {
161 if check.brokenAliases == nil {
162 check.brokenAliases = make(map[*TypeName]bool)
164 check.brokenAliases[alias] = true
165 alias.typ = Typ[Invalid]
168 // validAlias records that alias has the valid type typ (possibly Typ[Invalid]).
169 func (check *Checker) validAlias(alias *TypeName, typ Type) {
170 delete(check.brokenAliases, alias)
174 // isBrokenAlias reports whether alias doesn't have a determined type yet.
175 func (check *Checker) isBrokenAlias(alias *TypeName) bool {
176 return alias.typ == Typ[Invalid] && check.brokenAliases[alias]
179 func (check *Checker) rememberUntyped(e ast.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
182 m = make(map[ast.Expr]exprInfo)
185 m[e] = exprInfo{lhs, mode, typ, val}
188 // later pushes f on to the stack of actions that will be processed later;
189 // either at the end of the current statement, or in case of a local constant
190 // or variable declaration, before the constant or variable is in scope
191 // (so that f still sees the scope before any new declarations).
192 // later returns the pushed action so one can provide a description
193 // via action.describef for debugging, if desired.
194 func (check *Checker) later(f func()) *action {
195 i := len(check.delayed)
196 check.delayed = append(check.delayed, action{f: f})
197 return &check.delayed[i]
200 // push pushes obj onto the object path and returns its index in the path.
201 func (check *Checker) push(obj Object) int {
202 check.objPath = append(check.objPath, obj)
203 return len(check.objPath) - 1
206 // pop pops and returns the topmost object from the object path.
207 func (check *Checker) pop() Object {
208 i := len(check.objPath) - 1
209 obj := check.objPath[i]
210 check.objPath[i] = nil
211 check.objPath = check.objPath[:i]
215 type cleaner interface {
219 // needsCleanup records objects/types that implement the cleanup method
220 // which will be called at the end of type-checking.
221 func (check *Checker) needsCleanup(c cleaner) {
222 check.cleaners = append(check.cleaners, c)
225 // NewChecker returns a new Checker instance for a given package.
226 // Package files may be added incrementally via checker.Files.
227 func NewChecker(conf *Config, fset *token.FileSet, pkg *Package, info *Info) *Checker {
228 // make sure we have a configuration
233 // make sure we have an info struct
238 version, err := parseGoVersion(conf.GoVersion)
240 panic(fmt.Sprintf("invalid Go version %q (%v)", conf.GoVersion, err))
250 objMap: make(map[Object]*declInfo),
251 impMap: make(map[importKey]*Package),
255 // initFiles initializes the files-specific portion of checker.
256 // The provided files must all belong to the same package.
257 func (check *Checker) initFiles(files []*ast.File) {
258 // start with a clean slate (check.Files may be called multiple times)
261 check.dotImportMap = nil
270 // determine package name and collect valid files
272 for _, file := range files {
273 switch name := file.Name.Name; pkg.name {
278 check.errorf(file.Name, _BlankPkgName, "invalid package name _")
283 check.files = append(check.files, file)
286 check.errorf(atPos(file.Package), _MismatchedPkgName, "package %s; expected %s", name, pkg.name)
292 // A bailout panic is used for early termination.
293 type bailout struct{}
295 func (check *Checker) handleBailout(err *error) {
296 switch p := recover().(type) {
298 // normal return or early exit
299 *err = check.firstErr
306 // Files checks the provided files as part of the checker's package.
307 func (check *Checker) Files(files []*ast.File) error { return check.checkFiles(files) }
309 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
311 func (check *Checker) checkFiles(files []*ast.File) (err error) {
312 if check.conf.FakeImportC && check.conf.go115UsesCgo {
316 defer check.handleBailout(&err)
318 print := func(msg string) {
325 print("== initFiles ==")
326 check.initFiles(files)
328 print("== collectObjects ==")
329 check.collectObjects()
331 print("== packageObjects ==")
332 check.packageObjects()
334 print("== processDelayed ==")
335 check.processDelayed(0) // incl. all functions
337 print("== cleanup ==")
340 print("== initOrder ==")
343 if !check.conf.DisableUnusedImportCheck {
344 print("== unusedImports ==")
345 check.unusedImports()
348 print("== recordUntyped ==")
349 check.recordUntyped()
351 if check.firstErr == nil {
352 // TODO(mdempsky): Ensure monomorph is safe when errors exist.
356 check.pkg.complete = true
358 // no longer needed - release memory
360 check.dotImportMap = nil
361 check.pkgPathMap = nil
362 check.seenPkgMap = nil
363 check.recvTParamMap = nil
364 check.brokenAliases = nil
365 check.unionTypeSets = nil
368 // TODO(rFindley) There's more memory we should release at this point.
373 // processDelayed processes all delayed actions pushed after top.
374 func (check *Checker) processDelayed(top int) {
375 // If each delayed action pushes a new action, the
376 // stack will continue to grow during this loop.
377 // However, it is only processing functions (which
378 // are processed in a delayed fashion) that may
379 // add more actions (such as nested functions), so
380 // this is a sufficiently bounded process.
381 for i := top; i < len(check.delayed); i++ {
382 a := &check.delayed[i]
385 check.trace(a.desc.pos.Pos(), "-- "+a.desc.format, a.desc.args...)
387 check.trace(token.NoPos, "-- delayed %p", a.f)
390 a.f() // may append to check.delayed
395 assert(top <= len(check.delayed)) // stack must not have shrunk
396 check.delayed = check.delayed[:top]
399 // cleanup runs cleanup for all collected cleaners.
400 func (check *Checker) cleanup() {
401 // Don't use a range clause since Named.cleanup may add more cleaners.
402 for i := 0; i < len(check.cleaners); i++ {
403 check.cleaners[i].cleanup()
408 func (check *Checker) record(x *operand) {
409 // convert x into a user-friendly set of values
410 // TODO(gri) this code can be simplified
412 var val constant.Value
424 assert(x.expr != nil && typ != nil)
427 // delay type and value recording until we know the type
428 // or until the end of type checking
429 check.rememberUntyped(x.expr, false, x.mode, typ.(*Basic), val)
431 check.recordTypeAndValue(x.expr, x.mode, typ, val)
435 func (check *Checker) recordUntyped() {
436 if !debug && check.Types == nil {
437 return // nothing to do
440 for x, info := range check.untyped {
441 if debug && isTyped(info.typ) {
442 check.dump("%v: %s (type %s) is typed", x.Pos(), x, info.typ)
445 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
449 func (check *Checker) recordTypeAndValue(x ast.Expr, mode operandMode, typ Type, val constant.Value) {
455 if mode == constant_ {
457 // We check allBasic(typ, IsConstType) here as constant expressions may be
458 // recorded as type parameters.
459 assert(typ == Typ[Invalid] || allBasic(typ, IsConstType))
461 if m := check.Types; m != nil {
462 m[x] = TypeAndValue{mode, typ, val}
466 func (check *Checker) recordBuiltinType(f ast.Expr, sig *Signature) {
467 // f must be a (possibly parenthesized, possibly qualified)
468 // identifier denoting a built-in (including unsafe's non-constant
469 // functions Add and Slice): record the signature for f and possible
472 check.recordTypeAndValue(f, builtin, sig, nil)
473 switch p := f.(type) {
474 case *ast.Ident, *ast.SelectorExpr:
484 func (check *Checker) recordCommaOkTypes(x ast.Expr, a [2]Type) {
486 if a[0] == nil || a[1] == nil {
489 assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
490 if m := check.Types; m != nil {
493 assert(tv.Type != nil) // should have been recorded already
496 NewVar(pos, check.pkg, "", a[0]),
497 NewVar(pos, check.pkg, "", a[1]),
500 // if x is a parenthesized expression (p.X), update p.X
501 p, _ := x.(*ast.ParenExpr)
510 // recordInstance records instantiation information into check.Info, if the
511 // Instances map is non-nil. The given expr must be an ident, selector, or
512 // index (list) expr with ident or selector operand.
514 // TODO(rfindley): the expr parameter is fragile. See if we can access the
515 // instantiated identifier in some other way.
516 func (check *Checker) recordInstance(expr ast.Expr, targs []Type, typ Type) {
517 ident := instantiatedIdent(expr)
520 if m := check.Instances; m != nil {
521 m[ident] = Instance{newTypeList(targs), typ}
525 func instantiatedIdent(expr ast.Expr) *ast.Ident {
526 var selOrIdent ast.Expr
527 switch e := expr.(type) {
530 case *ast.IndexListExpr:
532 case *ast.SelectorExpr, *ast.Ident:
535 switch x := selOrIdent.(type) {
538 case *ast.SelectorExpr:
541 panic("instantiated ident not found")
544 func (check *Checker) recordDef(id *ast.Ident, obj Object) {
546 if m := check.Defs; m != nil {
551 func (check *Checker) recordUse(id *ast.Ident, obj Object) {
554 if m := check.Uses; m != nil {
559 func (check *Checker) recordImplicit(node ast.Node, obj Object) {
562 if m := check.Implicits; m != nil {
567 func (check *Checker) recordSelection(x *ast.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
568 assert(obj != nil && (recv == nil || len(index) > 0))
569 check.recordUse(x.Sel, obj)
570 if m := check.Selections; m != nil {
571 m[x] = &Selection{kind, recv, obj, index, indirect}
575 func (check *Checker) recordScope(node ast.Node, scope *Scope) {
578 if m := check.Scopes; m != nil {