src/cmd/compile/internal/types2/check.go

   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.
   4
   5 // This file implements the Check function, which drives type-checking.
   6
   7 package types2
   8
   9 import (
  10         "cmd/compile/internal/syntax"
  11         "errors"
  12         "fmt"
  13         "go/constant"
  14 )
  15
  16 var nopos syntax.Pos
  17
  18 // debugging/development support
  19 const debug = false // leave on during development
  20
  21 // If forceStrict is set, the type-checker enforces additional
  22 // rules not specified by the Go 1 spec, but which will
  23 // catch guaranteed run-time errors if the respective
  24 // code is executed. In other words, programs passing in
  25 // strict mode are Go 1 compliant, but not all Go 1 programs
  26 // will pass in strict mode. The additional rules are:
  27 //
  28 // - A type assertion x.(T) where T is an interface type
  29 //   is invalid if any (statically known) method that exists
  30 //   for both x and T have different signatures.
  31 //
  32 const forceStrict = false
  33
  34 // exprInfo stores information about an untyped expression.
  35 type exprInfo struct {
  36         isLhs bool // expression is lhs operand of a shift with delayed type-check
  37         mode  operandMode
  38         typ   *Basic
  39         val   constant.Value // constant value; or nil (if not a constant)
  40 }
  41
  42 // A context represents the context within which an object is type-checked.
  43 type context struct {
  44         decl          *declInfo                 // package-level declaration whose init expression/function body is checked
  45         scope         *Scope                    // top-most scope for lookups
  46         pos           syntax.Pos                // if valid, identifiers are looked up as if at position pos (used by Eval)
  47         iota          constant.Value            // value of iota in a constant declaration; nil otherwise
  48         errpos        syntax.Pos                // if valid, identifier position of a constant with inherited initializer
  49         sig           *Signature                // function signature if inside a function; nil otherwise
  50         isPanic       map[*syntax.CallExpr]bool // set of panic call expressions (used for termination check)
  51         hasLabel      bool                      // set if a function makes use of labels (only ~1% of functions); unused outside functions
  52         hasCallOrRecv bool                      // set if an expression contains a function call or channel receive operation
  53 }
  54
  55 // lookup looks up name in the current context and returns the matching object, or nil.
  56 func (ctxt *context) lookup(name string) Object {
  57         _, obj := ctxt.scope.LookupParent(name, ctxt.pos)
  58         return obj
  59 }
  60
  61 // An importKey identifies an imported package by import path and source directory
  62 // (directory containing the file containing the import). In practice, the directory
  63 // may always be the same, or may not matter. Given an (import path, directory), an
  64 // importer must always return the same package (but given two different import paths,
  65 // an importer may still return the same package by mapping them to the same package
  66 // paths).
  67 type importKey struct {
  68         path, dir string
  69 }
  70
  71 // A dotImportKey describes a dot-imported object in the given scope.
  72 type dotImportKey struct {
  73         scope *Scope
  74         name  string
  75 }
  76
  77 // An action describes a (delayed) action.
  78 type action struct {
  79         f    func()      // action to be executed
  80         desc *actionDesc // action description; may be nil, requires debug to be set
  81 }
  82
  83 // If debug is set, describef sets a printf-formatted description for action a.
  84 // Otherwise, it is a no-op.
  85 func (a *action) describef(pos poser, format string, args ...interface{}) {
  86         if debug {
  87                 a.desc = &actionDesc{pos, format, args}
  88         }
  89 }
  90
  91 // An actionDesc provides information on an action.
  92 // For debugging only.
  93 type actionDesc struct {
  94         pos    poser
  95         format string
  96         args   []interface{}
  97 }
  98
  99 // A Checker maintains the state of the type checker.
 100 // It must be created with NewChecker.
 101 type Checker struct {
 102         // package information
 103         // (initialized by NewChecker, valid for the life-time of checker)
 104         conf *Config
 105         pkg  *Package
 106         *Info
 107         version version                // accepted language version
 108         nextID  uint64                 // unique Id for type parameters (first valid Id is 1)
 109         objMap  map[Object]*declInfo   // maps package-level objects and (non-interface) methods to declaration info
 110         impMap  map[importKey]*Package // maps (import path, source directory) to (complete or fake) package
 111
 112         // pkgPathMap maps package names to the set of distinct import paths we've
 113         // seen for that name, anywhere in the import graph. It is used for
 114         // disambiguating package names in error messages.
 115         //
 116         // pkgPathMap is allocated lazily, so that we don't pay the price of building
 117         // it on the happy path. seenPkgMap tracks the packages that we've already
 118         // walked.
 119         pkgPathMap map[string]map[string]bool
 120         seenPkgMap map[*Package]bool
 121
 122         // information collected during type-checking of a set of package files
 123         // (initialized by Files, valid only for the duration of check.Files;
 124         // maps and lists are allocated on demand)
 125         files         []*syntax.File              // list of package files
 126         imports       []*PkgName                  // list of imported packages
 127         dotImportMap  map[dotImportKey]*PkgName   // maps dot-imported objects to the package they were dot-imported through
 128         recvTParamMap map[*syntax.Name]*TypeParam // maps blank receiver type parameters to their type
 129
 130         firstErr error                    // first error encountered
 131         methods  map[*TypeName][]*Func    // maps package scope type names to associated non-blank (non-interface) methods
 132         untyped  map[syntax.Expr]exprInfo // map of expressions without final type
 133         delayed  []action                 // stack of delayed action segments; segments are processed in FIFO order
 134         objPath  []Object                 // path of object dependencies during type inference (for cycle reporting)
 135         defTypes []*Named                 // defined types created during type checking, for final validation.
 136
 137         // context within which the current object is type-checked
 138         // (valid only for the duration of type-checking a specific object)
 139         context
 140
 141         // debugging
 142         indent int // indentation for tracing
 143 }
 144
 145 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
 146 func (check *Checker) addDeclDep(to Object) {
 147         from := check.decl
 148         if from == nil {
 149                 return // not in a package-level init expression
 150         }
 151         if _, found := check.objMap[to]; !found {
 152                 return // to is not a package-level object
 153         }
 154         from.addDep(to)
 155 }
 156
 157 func (check *Checker) rememberUntyped(e syntax.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
 158         m := check.untyped
 159         if m == nil {
 160                 m = make(map[syntax.Expr]exprInfo)
 161                 check.untyped = m
 162         }
 163         m[e] = exprInfo{lhs, mode, typ, val}
 164 }
 165
 166 // later pushes f on to the stack of actions that will be processed later;
 167 // either at the end of the current statement, or in case of a local constant
 168 // or variable declaration, before the constant or variable is in scope
 169 // (so that f still sees the scope before any new declarations).
 170 // later returns the pushed action so one can provide a description
 171 // via action.describef for debugging, if desired.
 172 func (check *Checker) later(f func()) *action {
 173         i := len(check.delayed)
 174         check.delayed = append(check.delayed, action{f: f})
 175         return &check.delayed[i]
 176 }
 177
 178 // push pushes obj onto the object path and returns its index in the path.
 179 func (check *Checker) push(obj Object) int {
 180         check.objPath = append(check.objPath, obj)
 181         return len(check.objPath) - 1
 182 }
 183
 184 // pop pops and returns the topmost object from the object path.
 185 func (check *Checker) pop() Object {
 186         i := len(check.objPath) - 1
 187         obj := check.objPath[i]
 188         check.objPath[i] = nil
 189         check.objPath = check.objPath[:i]
 190         return obj
 191 }
 192
 193 // NewChecker returns a new Checker instance for a given package.
 194 // Package files may be added incrementally via checker.Files.
 195 func NewChecker(conf *Config, pkg *Package, info *Info) *Checker {
 196         // make sure we have a configuration
 197         if conf == nil {
 198                 conf = new(Config)
 199         }
 200
 201         // make sure we have a context
 202         if conf.Context == nil {
 203                 conf.Context = NewContext()
 204         }
 205
 206         // make sure we have an info struct
 207         if info == nil {
 208                 info = new(Info)
 209         }
 210
 211         version, err := parseGoVersion(conf.GoVersion)
 212         if err != nil {
 213                 panic(fmt.Sprintf("invalid Go version %q (%v)", conf.GoVersion, err))
 214         }
 215
 216         return &Checker{
 217                 conf:    conf,
 218                 pkg:     pkg,
 219                 Info:    info,
 220                 version: version,
 221                 objMap:  make(map[Object]*declInfo),
 222                 impMap:  make(map[importKey]*Package),
 223         }
 224 }
 225
 226 // initFiles initializes the files-specific portion of checker.
 227 // The provided files must all belong to the same package.
 228 func (check *Checker) initFiles(files []*syntax.File) {
 229         // start with a clean slate (check.Files may be called multiple times)
 230         check.files = nil
 231         check.imports = nil
 232         check.dotImportMap = nil
 233
 234         check.firstErr = nil
 235         check.methods = nil
 236         check.untyped = nil
 237         check.delayed = nil
 238
 239         // determine package name and collect valid files
 240         pkg := check.pkg
 241         for _, file := range files {
 242                 switch name := file.PkgName.Value; pkg.name {
 243                 case "":
 244                         if name != "_" {
 245                                 pkg.name = name
 246                         } else {
 247                                 check.error(file.PkgName, "invalid package name _")
 248                         }
 249                         fallthrough
 250
 251                 case name:
 252                         check.files = append(check.files, file)
 253
 254                 default:
 255                         check.errorf(file, "package %s; expected %s", name, pkg.name)
 256                         // ignore this file
 257                 }
 258         }
 259 }
 260
 261 // A bailout panic is used for early termination.
 262 type bailout struct{}
 263
 264 func (check *Checker) handleBailout(err *error) {
 265         switch p := recover().(type) {
 266         case nil, bailout:
 267                 // normal return or early exit
 268                 *err = check.firstErr
 269         default:
 270                 // re-panic
 271                 panic(p)
 272         }
 273 }
 274
 275 // Files checks the provided files as part of the checker's package.
 276 func (check *Checker) Files(files []*syntax.File) error { return check.checkFiles(files) }
 277
 278 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
 279
 280 func (check *Checker) checkFiles(files []*syntax.File) (err error) {
 281         if check.conf.FakeImportC && check.conf.go115UsesCgo {
 282                 return errBadCgo
 283         }
 284
 285         defer check.handleBailout(&err)
 286
 287         print := func(msg string) {
 288                 if check.conf.Trace {
 289                         fmt.Println()
 290                         fmt.Println(msg)
 291                 }
 292         }
 293
 294         print("== initFiles ==")
 295         check.initFiles(files)
 296
 297         print("== collectObjects ==")
 298         check.collectObjects()
 299
 300         print("== packageObjects ==")
 301         check.packageObjects()
 302
 303         print("== processDelayed ==")
 304         check.processDelayed(0) // incl. all functions
 305
 306         print("== expandDefTypes ==")
 307         check.expandDefTypes()
 308
 309         print("== initOrder ==")
 310         check.initOrder()
 311
 312         if !check.conf.DisableUnusedImportCheck {
 313                 print("== unusedImports ==")
 314                 check.unusedImports()
 315         }
 316
 317         print("== recordUntyped ==")
 318         check.recordUntyped()
 319
 320         check.pkg.complete = true
 321
 322         // no longer needed - release memory
 323         check.imports = nil
 324         check.dotImportMap = nil
 325         check.pkgPathMap = nil
 326         check.seenPkgMap = nil
 327         check.recvTParamMap = nil
 328         check.defTypes = nil
 329
 330         // TODO(gri) There's more memory we should release at this point.
 331
 332         return
 333 }
 334
 335 // processDelayed processes all delayed actions pushed after top.
 336 func (check *Checker) processDelayed(top int) {
 337         // If each delayed action pushes a new action, the
 338         // stack will continue to grow during this loop.
 339         // However, it is only processing functions (which
 340         // are processed in a delayed fashion) that may
 341         // add more actions (such as nested functions), so
 342         // this is a sufficiently bounded process.
 343         for i := top; i < len(check.delayed); i++ {
 344                 a := &check.delayed[i]
 345                 if check.conf.Trace && a.desc != nil {
 346                         fmt.Println()
 347                         check.trace(a.desc.pos.Pos(), "-- "+a.desc.format, a.desc.args...)
 348                 }
 349                 a.f() // may append to check.delayed
 350         }
 351         assert(top <= len(check.delayed)) // stack must not have shrunk
 352         check.delayed = check.delayed[:top]
 353 }
 354
 355 func (check *Checker) expandDefTypes() {
 356         // Ensure that every defined type created in the course of type-checking has
 357         // either non-*Named underlying, or is unresolved.
 358         //
 359         // This guarantees that we don't leak any types whose underlying is *Named,
 360         // because any unresolved instances will lazily compute their underlying by
 361         // substituting in the underlying of their origin. The origin must have
 362         // either been imported or type-checked and expanded here, and in either case
 363         // its underlying will be fully expanded.
 364         for i := 0; i < len(check.defTypes); i++ {
 365                 n := check.defTypes[i]
 366                 switch n.underlying.(type) {
 367                 case nil:
 368                         if n.resolver == nil {
 369                                 panic("nil underlying")
 370                         }
 371                 case *Named:
 372                         n.under() // n.under may add entries to check.defTypes
 373                 }
 374                 n.check = nil
 375         }
 376 }
 377
 378 func (check *Checker) record(x *operand) {
 379         // convert x into a user-friendly set of values
 380         // TODO(gri) this code can be simplified
 381         var typ Type
 382         var val constant.Value
 383         switch x.mode {
 384         case invalid:
 385                 typ = Typ[Invalid]
 386         case novalue:
 387                 typ = (*Tuple)(nil)
 388         case constant_:
 389                 typ = x.typ
 390                 val = x.val
 391         default:
 392                 typ = x.typ
 393         }
 394         assert(x.expr != nil && typ != nil)
 395
 396         if isUntyped(typ) {
 397                 // delay type and value recording until we know the type
 398                 // or until the end of type checking
 399                 check.rememberUntyped(x.expr, false, x.mode, typ.(*Basic), val)
 400         } else {
 401                 check.recordTypeAndValue(x.expr, x.mode, typ, val)
 402         }
 403 }
 404
 405 func (check *Checker) recordUntyped() {
 406         if !debug && check.Types == nil {
 407                 return // nothing to do
 408         }
 409
 410         for x, info := range check.untyped {
 411                 if debug && isTyped(info.typ) {
 412                         check.dump("%v: %s (type %s) is typed", posFor(x), x, info.typ)
 413                         unreachable()
 414                 }
 415                 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
 416         }
 417 }
 418
 419 func (check *Checker) recordTypeAndValue(x syntax.Expr, mode operandMode, typ Type, val constant.Value) {
 420         assert(x != nil)
 421         assert(typ != nil)
 422         if mode == invalid {
 423                 return // omit
 424         }
 425         if mode == constant_ {
 426                 assert(val != nil)
 427                 // We check is(typ, IsConstType) here as constant expressions may be
 428                 // recorded as type parameters.
 429                 assert(typ == Typ[Invalid] || is(typ, IsConstType))
 430         }
 431         if m := check.Types; m != nil {
 432                 m[x] = TypeAndValue{mode, typ, val}
 433         }
 434 }
 435
 436 func (check *Checker) recordBuiltinType(f syntax.Expr, sig *Signature) {
 437         // f must be a (possibly parenthesized, possibly qualified)
 438         // identifier denoting a built-in (including unsafe's non-constant
 439         // functions Add and Slice): record the signature for f and possible
 440         // children.
 441         for {
 442                 check.recordTypeAndValue(f, builtin, sig, nil)
 443                 switch p := f.(type) {
 444                 case *syntax.Name, *syntax.SelectorExpr:
 445                         return // we're done
 446                 case *syntax.ParenExpr:
 447                         f = p.X
 448                 default:
 449                         unreachable()
 450                 }
 451         }
 452 }
 453
 454 func (check *Checker) recordCommaOkTypes(x syntax.Expr, a [2]Type) {
 455         assert(x != nil)
 456         if a[0] == nil || a[1] == nil {
 457                 return
 458         }
 459         assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
 460         if m := check.Types; m != nil {
 461                 for {
 462                         tv := m[x]
 463                         assert(tv.Type != nil) // should have been recorded already
 464                         pos := x.Pos()
 465                         tv.Type = NewTuple(
 466                                 NewVar(pos, check.pkg, "", a[0]),
 467                                 NewVar(pos, check.pkg, "", a[1]),
 468                         )
 469                         m[x] = tv
 470                         // if x is a parenthesized expression (p.X), update p.X
 471                         p, _ := x.(*syntax.ParenExpr)
 472                         if p == nil {
 473                                 break
 474                         }
 475                         x = p.X
 476                 }
 477         }
 478 }
 479
 480 // recordInstance records instantiation information into check.Info, if the
 481 // Instances map is non-nil. The given expr must be an ident, selector, or
 482 // index (list) expr with ident or selector operand.
 483 //
 484 // TODO(rfindley): the expr parameter is fragile. See if we can access the
 485 // instantiated identifier in some other way.
 486 func (check *Checker) recordInstance(expr syntax.Expr, targs []Type, typ Type) {
 487         ident := instantiatedIdent(expr)
 488         assert(ident != nil)
 489         assert(typ != nil)
 490         if m := check.Instances; m != nil {
 491                 m[ident] = Instance{NewTypeList(targs), typ}
 492         }
 493 }
 494
 495 func instantiatedIdent(expr syntax.Expr) *syntax.Name {
 496         var selOrIdent syntax.Expr
 497         switch e := expr.(type) {
 498         case *syntax.IndexExpr:
 499                 selOrIdent = e.X
 500         case *syntax.SelectorExpr, *syntax.Name:
 501                 selOrIdent = e
 502         }
 503         switch x := selOrIdent.(type) {
 504         case *syntax.Name:
 505                 return x
 506         case *syntax.SelectorExpr:
 507                 return x.Sel
 508         }
 509         panic("instantiated ident not found")
 510 }
 511
 512 func (check *Checker) recordDef(id *syntax.Name, obj Object) {
 513         assert(id != nil)
 514         if m := check.Defs; m != nil {
 515                 m[id] = obj
 516         }
 517 }
 518
 519 func (check *Checker) recordUse(id *syntax.Name, obj Object) {
 520         assert(id != nil)
 521         assert(obj != nil)
 522         if m := check.Uses; m != nil {
 523                 m[id] = obj
 524         }
 525 }
 526
 527 func (check *Checker) recordImplicit(node syntax.Node, obj Object) {
 528         assert(node != nil)
 529         assert(obj != nil)
 530         if m := check.Implicits; m != nil {
 531                 m[node] = obj
 532         }
 533 }
 534
 535 func (check *Checker) recordSelection(x *syntax.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
 536         assert(obj != nil && (recv == nil || len(index) > 0))
 537         check.recordUse(x.Sel, obj)
 538         if m := check.Selections; m != nil {
 539                 m[x] = &Selection{kind, recv, obj, index, indirect}
 540         }
 541 }
 542
 543 func (check *Checker) recordScope(node syntax.Node, scope *Scope) {
 544         assert(node != nil)
 545         assert(scope != nil)
 546         if m := check.Scopes; m != nil {
 547                 m[node] = scope
 548         }
 549 }