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.
10 "cmd/compile/internal/syntax"
15 . "internal/types/errors"
18 // nopos indicates an unknown position
21 // debugging/development support
22 const debug = false // leave on during development
24 // exprInfo stores information about an untyped expression.
25 type exprInfo struct {
26 isLhs bool // expression is lhs operand of a shift with delayed type-check
29 val constant.Value // constant value; or nil (if not a constant)
32 // An environment represents the environment within which an object is
34 type environment struct {
35 decl *declInfo // package-level declaration whose init expression/function body is checked
36 scope *Scope // top-most scope for lookups
37 pos syntax.Pos // if valid, identifiers are looked up as if at position pos (used by Eval)
38 iota constant.Value // value of iota in a constant declaration; nil otherwise
39 errpos syntax.Pos // if valid, identifier position of a constant with inherited initializer
40 inTParamList bool // set if inside a type parameter list
41 sig *Signature // function signature if inside a function; nil otherwise
42 isPanic map[*syntax.CallExpr]bool // set of panic call expressions (used for termination check)
43 hasLabel bool // set if a function makes use of labels (only ~1% of functions); unused outside functions
44 hasCallOrRecv bool // set if an expression contains a function call or channel receive operation
47 // lookup looks up name in the current environment and returns the matching object, or nil.
48 func (env *environment) lookup(name string) Object {
49 _, obj := env.scope.LookupParent(name, env.pos)
53 // An importKey identifies an imported package by import path and source directory
54 // (directory containing the file containing the import). In practice, the directory
55 // may always be the same, or may not matter. Given an (import path, directory), an
56 // importer must always return the same package (but given two different import paths,
57 // an importer may still return the same package by mapping them to the same package
59 type importKey struct {
63 // A dotImportKey describes a dot-imported object in the given scope.
64 type dotImportKey struct {
69 // An action describes a (delayed) action.
71 f func() // action to be executed
72 desc *actionDesc // action description; may be nil, requires debug to be set
75 // If debug is set, describef sets a printf-formatted description for action a.
76 // Otherwise, it is a no-op.
77 func (a *action) describef(pos poser, format string, args ...interface{}) {
79 a.desc = &actionDesc{pos, format, args}
83 // An actionDesc provides information on an action.
84 // For debugging only.
85 type actionDesc struct {
91 // A Checker maintains the state of the type checker.
92 // It must be created with NewChecker.
94 // package information
95 // (initialized by NewChecker, valid for the life-time of checker)
97 ctxt *Context // context for de-duplicating instances
100 version version // accepted language version
101 posVers map[*syntax.PosBase]version // maps file PosBases to versions (may be nil)
102 nextID uint64 // unique Id for type parameters (first valid Id is 1)
103 objMap map[Object]*declInfo // maps package-level objects and (non-interface) methods to declaration info
104 impMap map[importKey]*Package // maps (import path, source directory) to (complete or fake) package
105 valids instanceLookup // valid *Named (incl. instantiated) types per the validType check
107 // pkgPathMap maps package names to the set of distinct import paths we've
108 // seen for that name, anywhere in the import graph. It is used for
109 // disambiguating package names in error messages.
111 // pkgPathMap is allocated lazily, so that we don't pay the price of building
112 // it on the happy path. seenPkgMap tracks the packages that we've already
114 pkgPathMap map[string]map[string]bool
115 seenPkgMap map[*Package]bool
117 // information collected during type-checking of a set of package files
118 // (initialized by Files, valid only for the duration of check.Files;
119 // maps and lists are allocated on demand)
120 files []*syntax.File // list of package files
121 imports []*PkgName // list of imported packages
122 dotImportMap map[dotImportKey]*PkgName // maps dot-imported objects to the package they were dot-imported through
123 recvTParamMap map[*syntax.Name]*TypeParam // maps blank receiver type parameters to their type
124 brokenAliases map[*TypeName]bool // set of aliases with broken (not yet determined) types
125 unionTypeSets map[*Union]*_TypeSet // computed type sets for union types
126 mono monoGraph // graph for detecting non-monomorphizable instantiation loops
128 firstErr error // first error encountered
129 methods map[*TypeName][]*Func // maps package scope type names to associated non-blank (non-interface) methods
130 untyped map[syntax.Expr]exprInfo // map of expressions without final type
131 delayed []action // stack of delayed action segments; segments are processed in FIFO order
132 objPath []Object // path of object dependencies during type inference (for cycle reporting)
133 cleaners []cleaner // list of types that may need a final cleanup at the end of type-checking
135 // environment within which the current object is type-checked (valid only
136 // for the duration of type-checking a specific object)
140 indent int // indentation for tracing
143 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
144 func (check *Checker) addDeclDep(to Object) {
147 return // not in a package-level init expression
149 if _, found := check.objMap[to]; !found {
150 return // to is not a package-level object
155 // brokenAlias records that alias doesn't have a determined type yet.
156 // It also sets alias.typ to Typ[Invalid].
157 func (check *Checker) brokenAlias(alias *TypeName) {
158 if check.brokenAliases == nil {
159 check.brokenAliases = make(map[*TypeName]bool)
161 check.brokenAliases[alias] = true
162 alias.typ = Typ[Invalid]
165 // validAlias records that alias has the valid type typ (possibly Typ[Invalid]).
166 func (check *Checker) validAlias(alias *TypeName, typ Type) {
167 delete(check.brokenAliases, alias)
171 // isBrokenAlias reports whether alias doesn't have a determined type yet.
172 func (check *Checker) isBrokenAlias(alias *TypeName) bool {
173 return alias.typ == Typ[Invalid] && check.brokenAliases[alias]
176 func (check *Checker) rememberUntyped(e syntax.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
179 m = make(map[syntax.Expr]exprInfo)
182 m[e] = exprInfo{lhs, mode, typ, val}
185 // later pushes f on to the stack of actions that will be processed later;
186 // either at the end of the current statement, or in case of a local constant
187 // or variable declaration, before the constant or variable is in scope
188 // (so that f still sees the scope before any new declarations).
189 // later returns the pushed action so one can provide a description
190 // via action.describef for debugging, if desired.
191 func (check *Checker) later(f func()) *action {
192 i := len(check.delayed)
193 check.delayed = append(check.delayed, action{f: f})
194 return &check.delayed[i]
197 // push pushes obj onto the object path and returns its index in the path.
198 func (check *Checker) push(obj Object) int {
199 check.objPath = append(check.objPath, obj)
200 return len(check.objPath) - 1
203 // pop pops and returns the topmost object from the object path.
204 func (check *Checker) pop() Object {
205 i := len(check.objPath) - 1
206 obj := check.objPath[i]
207 check.objPath[i] = nil
208 check.objPath = check.objPath[:i]
212 type cleaner interface {
216 // needsCleanup records objects/types that implement the cleanup method
217 // which will be called at the end of type-checking.
218 func (check *Checker) needsCleanup(c cleaner) {
219 check.cleaners = append(check.cleaners, c)
222 // NewChecker returns a new Checker instance for a given package.
223 // Package files may be added incrementally via checker.Files.
224 func NewChecker(conf *Config, pkg *Package, info *Info) *Checker {
225 // make sure we have a configuration
230 // make sure we have an info struct
235 // Note: clients may call NewChecker with the Unsafe package, which is
236 // globally shared and must not be mutated. Therefore NewChecker must not
239 // (previously, pkg.goVersion was mutated here: go.dev/issue/61212)
246 objMap: make(map[Object]*declInfo),
247 impMap: make(map[importKey]*Package),
251 // initFiles initializes the files-specific portion of checker.
252 // The provided files must all belong to the same package.
253 func (check *Checker) initFiles(files []*syntax.File) {
254 // start with a clean slate (check.Files may be called multiple times)
257 check.dotImportMap = nil
266 // determine package name and collect valid files
268 for _, file := range files {
269 switch name := file.PkgName.Value; pkg.name {
274 check.error(file.PkgName, BlankPkgName, "invalid package name _")
279 check.files = append(check.files, file)
282 check.errorf(file, MismatchedPkgName, "package %s; expected %s", name, pkg.name)
287 for _, file := range check.files {
288 v, _ := parseGoVersion(file.GoVersion)
290 if v.equal(check.version) {
293 // Go 1.21 introduced the feature of setting the go.mod
294 // go line to an early version of Go and allowing //go:build lines
295 // to “upgrade” the Go version in a given file.
296 // We can do that backwards compatibly.
297 // Go 1.21 also introduced the feature of allowing //go:build lines
298 // to “downgrade” the Go version in a given file.
299 // That can't be done compatibly in general, since before the
300 // build lines were ignored and code got the module's Go version.
301 // To work around this, downgrades are only allowed when the
302 // module's Go version is Go 1.21 or later.
303 // If there is no check.version, then we don't really know what Go version to apply.
304 // Legacy tools may do this, and they historically have accepted everything.
305 // Preserve that behavior by ignoring //go:build constraints entirely in that case.
306 if (v.before(check.version) && check.version.before(go1_21)) || check.version.equal(go0_0) {
309 if check.posVers == nil {
310 check.posVers = make(map[*syntax.PosBase]version)
312 check.posVers[base(file.Pos())] = v
317 // A bailout panic is used for early termination.
318 type bailout struct{}
320 func (check *Checker) handleBailout(err *error) {
321 switch p := recover().(type) {
323 // normal return or early exit
324 *err = check.firstErr
331 // Files checks the provided files as part of the checker's package.
332 func (check *Checker) Files(files []*syntax.File) error { return check.checkFiles(files) }
334 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
336 func (check *Checker) checkFiles(files []*syntax.File) (err error) {
337 if check.pkg == Unsafe {
338 // Defensive handling for Unsafe, which cannot be type checked, and must
339 // not be mutated. See https://go.dev/issue/61212 for an example of where
340 // Unsafe is passed to NewChecker.
344 // Note: parseGoVersion and the subsequent checks should happen once,
345 // when we create a new Checker, not for each batch of files.
346 // We can't change it at this point because NewChecker doesn't
348 check.version, err = parseGoVersion(check.conf.GoVersion)
352 if check.version.after(version{1, goversion.Version}) {
353 return fmt.Errorf("package requires newer Go version %v", check.version)
355 if check.conf.FakeImportC && check.conf.go115UsesCgo {
359 defer check.handleBailout(&err)
361 print := func(msg string) {
362 if check.conf.Trace {
368 print("== initFiles ==")
369 check.initFiles(files)
371 print("== collectObjects ==")
372 check.collectObjects()
374 print("== packageObjects ==")
375 check.packageObjects()
377 print("== processDelayed ==")
378 check.processDelayed(0) // incl. all functions
380 print("== cleanup ==")
383 print("== initOrder ==")
386 if !check.conf.DisableUnusedImportCheck {
387 print("== unusedImports ==")
388 check.unusedImports()
391 print("== recordUntyped ==")
392 check.recordUntyped()
394 if check.firstErr == nil {
395 // TODO(mdempsky): Ensure monomorph is safe when errors exist.
399 check.pkg.goVersion = check.conf.GoVersion
400 check.pkg.complete = true
402 // no longer needed - release memory
404 check.dotImportMap = nil
405 check.pkgPathMap = nil
406 check.seenPkgMap = nil
407 check.recvTParamMap = nil
408 check.brokenAliases = nil
409 check.unionTypeSets = nil
412 // TODO(gri) There's more memory we should release at this point.
417 // processDelayed processes all delayed actions pushed after top.
418 func (check *Checker) processDelayed(top int) {
419 // If each delayed action pushes a new action, the
420 // stack will continue to grow during this loop.
421 // However, it is only processing functions (which
422 // are processed in a delayed fashion) that may
423 // add more actions (such as nested functions), so
424 // this is a sufficiently bounded process.
425 for i := top; i < len(check.delayed); i++ {
426 a := &check.delayed[i]
427 if check.conf.Trace {
429 check.trace(a.desc.pos.Pos(), "-- "+a.desc.format, a.desc.args...)
431 check.trace(nopos, "-- delayed %p", a.f)
434 a.f() // may append to check.delayed
435 if check.conf.Trace {
439 assert(top <= len(check.delayed)) // stack must not have shrunk
440 check.delayed = check.delayed[:top]
443 // cleanup runs cleanup for all collected cleaners.
444 func (check *Checker) cleanup() {
445 // Don't use a range clause since Named.cleanup may add more cleaners.
446 for i := 0; i < len(check.cleaners); i++ {
447 check.cleaners[i].cleanup()
452 func (check *Checker) record(x *operand) {
453 // convert x into a user-friendly set of values
454 // TODO(gri) this code can be simplified
456 var val constant.Value
468 assert(x.expr != nil && typ != nil)
471 // delay type and value recording until we know the type
472 // or until the end of type checking
473 check.rememberUntyped(x.expr, false, x.mode, typ.(*Basic), val)
475 check.recordTypeAndValue(x.expr, x.mode, typ, val)
479 func (check *Checker) recordUntyped() {
480 if !debug && !check.recordTypes() {
481 return // nothing to do
484 for x, info := range check.untyped {
485 if debug && isTyped(info.typ) {
486 check.dump("%v: %s (type %s) is typed", atPos(x), x, info.typ)
489 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
493 func (check *Checker) recordTypeAndValue(x syntax.Expr, mode operandMode, typ Type, val constant.Value) {
499 if mode == constant_ {
501 // We check allBasic(typ, IsConstType) here as constant expressions may be
502 // recorded as type parameters.
503 assert(typ == Typ[Invalid] || allBasic(typ, IsConstType))
505 if m := check.Types; m != nil {
506 m[x] = TypeAndValue{mode, typ, val}
508 if check.StoreTypesInSyntax {
509 tv := TypeAndValue{mode, typ, val}
510 stv := syntax.TypeAndValue{Type: typ, Value: val}
526 if tv.Addressable() {
539 func (check *Checker) recordBuiltinType(f syntax.Expr, sig *Signature) {
540 // f must be a (possibly parenthesized, possibly qualified)
541 // identifier denoting a built-in (including unsafe's non-constant
542 // functions Add and Slice): record the signature for f and possible
545 check.recordTypeAndValue(f, builtin, sig, nil)
546 switch p := f.(type) {
547 case *syntax.Name, *syntax.SelectorExpr:
549 case *syntax.ParenExpr:
557 // recordCommaOkTypes updates recorded types to reflect that x is used in a commaOk context
558 // (and therefore has tuple type).
559 func (check *Checker) recordCommaOkTypes(x syntax.Expr, a []*operand) {
562 if a[0].mode == invalid {
565 t0, t1 := a[0].typ, a[1].typ
566 assert(isTyped(t0) && isTyped(t1) && (isBoolean(t1) || t1 == universeError))
567 if m := check.Types; m != nil {
570 assert(tv.Type != nil) // should have been recorded already
573 NewVar(pos, check.pkg, "", t0),
574 NewVar(pos, check.pkg, "", t1),
577 // if x is a parenthesized expression (p.X), update p.X
578 p, _ := x.(*syntax.ParenExpr)
585 if check.StoreTypesInSyntax {
586 // Note: this loop is duplicated because the type of tv is different.
587 // Above it is types2.TypeAndValue, here it is syntax.TypeAndValue.
589 tv := x.GetTypeInfo()
590 assert(tv.Type != nil) // should have been recorded already
593 NewVar(pos, check.pkg, "", t0),
594 NewVar(pos, check.pkg, "", t1),
597 p, _ := x.(*syntax.ParenExpr)
606 // recordInstance records instantiation information into check.Info, if the
607 // Instances map is non-nil. The given expr must be an ident, selector, or
608 // index (list) expr with ident or selector operand.
610 // TODO(rfindley): the expr parameter is fragile. See if we can access the
611 // instantiated identifier in some other way.
612 func (check *Checker) recordInstance(expr syntax.Expr, targs []Type, typ Type) {
613 ident := instantiatedIdent(expr)
616 if m := check.Instances; m != nil {
617 m[ident] = Instance{newTypeList(targs), typ}
621 func instantiatedIdent(expr syntax.Expr) *syntax.Name {
622 var selOrIdent syntax.Expr
623 switch e := expr.(type) {
624 case *syntax.IndexExpr:
626 case *syntax.SelectorExpr, *syntax.Name:
629 switch x := selOrIdent.(type) {
632 case *syntax.SelectorExpr:
635 panic("instantiated ident not found")
638 func (check *Checker) recordDef(id *syntax.Name, obj Object) {
640 if m := check.Defs; m != nil {
645 func (check *Checker) recordUse(id *syntax.Name, obj Object) {
648 if m := check.Uses; m != nil {
653 func (check *Checker) recordImplicit(node syntax.Node, obj Object) {
656 if m := check.Implicits; m != nil {
661 func (check *Checker) recordSelection(x *syntax.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
662 assert(obj != nil && (recv == nil || len(index) > 0))
663 check.recordUse(x.Sel, obj)
664 if m := check.Selections; m != nil {
665 m[x] = &Selection{kind, recv, obj, index, indirect}
669 func (check *Checker) recordScope(node syntax.Node, scope *Scope) {
672 if m := check.Scopes; m != nil {