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         mono          monoGraph                   // graph for detecting non-monomorphizable instantiation loops
 130
 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[syntax.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         defTypes []*Named                 // defined types created during type checking, for final validation.
 137
 138         // context within which the current object is type-checked
 139         // (valid only for the duration of type-checking a specific object)
 140         context
 141
 142         // debugging
 143         indent int // indentation for tracing
 144 }
 145
 146 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
 147 func (check *Checker) addDeclDep(to Object) {
 148         from := check.decl
 149         if from == nil {
 150                 return // not in a package-level init expression
 151         }
 152         if _, found := check.objMap[to]; !found {
 153                 return // to is not a package-level object
 154         }
 155         from.addDep(to)
 156 }
 157
 158 func (check *Checker) rememberUntyped(e syntax.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
 159         m := check.untyped
 160         if m == nil {
 161                 m = make(map[syntax.Expr]exprInfo)
 162                 check.untyped = m
 163         }
 164         m[e] = exprInfo{lhs, mode, typ, val}
 165 }
 166
 167 // later pushes f on to the stack of actions that will be processed later;
 168 // either at the end of the current statement, or in case of a local constant
 169 // or variable declaration, before the constant or variable is in scope
 170 // (so that f still sees the scope before any new declarations).
 171 // later returns the pushed action so one can provide a description
 172 // via action.describef for debugging, if desired.
 173 func (check *Checker) later(f func()) *action {
 174         i := len(check.delayed)
 175         check.delayed = append(check.delayed, action{f: f})
 176         return &check.delayed[i]
 177 }
 178
 179 // push pushes obj onto the object path and returns its index in the path.
 180 func (check *Checker) push(obj Object) int {
 181         check.objPath = append(check.objPath, obj)
 182         return len(check.objPath) - 1
 183 }
 184
 185 // pop pops and returns the topmost object from the object path.
 186 func (check *Checker) pop() Object {
 187         i := len(check.objPath) - 1
 188         obj := check.objPath[i]
 189         check.objPath[i] = nil
 190         check.objPath = check.objPath[:i]
 191         return obj
 192 }
 193
 194 // NewChecker returns a new Checker instance for a given package.
 195 // Package files may be added incrementally via checker.Files.
 196 func NewChecker(conf *Config, pkg *Package, info *Info) *Checker {
 197         // make sure we have a configuration
 198         if conf == nil {
 199                 conf = new(Config)
 200         }
 201
 202         // make sure we have a context
 203         if conf.Context == nil {
 204                 conf.Context = NewContext()
 205         }
 206
 207         // make sure we have an info struct
 208         if info == nil {
 209                 info = new(Info)
 210         }
 211
 212         version, err := parseGoVersion(conf.GoVersion)
 213         if err != nil {
 214                 panic(fmt.Sprintf("invalid Go version %q (%v)", conf.GoVersion, err))
 215         }
 216
 217         return &Checker{
 218                 conf:    conf,
 219                 pkg:     pkg,
 220                 Info:    info,
 221                 version: version,
 222                 objMap:  make(map[Object]*declInfo),
 223                 impMap:  make(map[importKey]*Package),
 224         }
 225 }
 226
 227 // initFiles initializes the files-specific portion of checker.
 228 // The provided files must all belong to the same package.
 229 func (check *Checker) initFiles(files []*syntax.File) {
 230         // start with a clean slate (check.Files may be called multiple times)
 231         check.files = nil
 232         check.imports = nil
 233         check.dotImportMap = nil
 234
 235         check.firstErr = nil
 236         check.methods = nil
 237         check.untyped = nil
 238         check.delayed = nil
 239
 240         // determine package name and collect valid files
 241         pkg := check.pkg
 242         for _, file := range files {
 243                 switch name := file.PkgName.Value; pkg.name {
 244                 case "":
 245                         if name != "_" {
 246                                 pkg.name = name
 247                         } else {
 248                                 check.error(file.PkgName, "invalid package name _")
 249                         }
 250                         fallthrough
 251
 252                 case name:
 253                         check.files = append(check.files, file)
 254
 255                 default:
 256                         check.errorf(file, "package %s; expected %s", name, pkg.name)
 257                         // ignore this file
 258                 }
 259         }
 260 }
 261
 262 // A bailout panic is used for early termination.
 263 type bailout struct{}
 264
 265 func (check *Checker) handleBailout(err *error) {
 266         switch p := recover().(type) {
 267         case nil, bailout:
 268                 // normal return or early exit
 269                 *err = check.firstErr
 270         default:
 271                 // re-panic
 272                 panic(p)
 273         }
 274 }
 275
 276 // Files checks the provided files as part of the checker's package.
 277 func (check *Checker) Files(files []*syntax.File) error { return check.checkFiles(files) }
 278
 279 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
 280
 281 func (check *Checker) checkFiles(files []*syntax.File) (err error) {
 282         if check.conf.FakeImportC && check.conf.go115UsesCgo {
 283                 return errBadCgo
 284         }
 285
 286         defer check.handleBailout(&err)
 287
 288         print := func(msg string) {
 289                 if check.conf.Trace {
 290                         fmt.Println()
 291                         fmt.Println(msg)
 292                 }
 293         }
 294
 295         print("== initFiles ==")
 296         check.initFiles(files)
 297
 298         print("== collectObjects ==")
 299         check.collectObjects()
 300
 301         print("== packageObjects ==")
 302         check.packageObjects()
 303
 304         print("== processDelayed ==")
 305         check.processDelayed(0) // incl. all functions
 306
 307         print("== expandDefTypes ==")
 308         check.expandDefTypes()
 309
 310         print("== initOrder ==")
 311         check.initOrder()
 312
 313         if !check.conf.DisableUnusedImportCheck {
 314                 print("== unusedImports ==")
 315                 check.unusedImports()
 316         }
 317
 318         print("== recordUntyped ==")
 319         check.recordUntyped()
 320
 321         if check.firstErr == nil {
 322                 // TODO(mdempsky): Ensure monomorph is safe when errors exist.
 323                 check.monomorph()
 324         }
 325
 326         check.pkg.complete = true
 327
 328         // no longer needed - release memory
 329         check.imports = nil
 330         check.dotImportMap = nil
 331         check.pkgPathMap = nil
 332         check.seenPkgMap = nil
 333         check.recvTParamMap = nil
 334         check.defTypes = nil
 335
 336         // TODO(gri) There's more memory we should release at this point.
 337
 338         return
 339 }
 340
 341 // processDelayed processes all delayed actions pushed after top.
 342 func (check *Checker) processDelayed(top int) {
 343         // If each delayed action pushes a new action, the
 344         // stack will continue to grow during this loop.
 345         // However, it is only processing functions (which
 346         // are processed in a delayed fashion) that may
 347         // add more actions (such as nested functions), so
 348         // this is a sufficiently bounded process.
 349         for i := top; i < len(check.delayed); i++ {
 350                 a := &check.delayed[i]
 351                 if check.conf.Trace && a.desc != nil {
 352                         fmt.Println()
 353                         check.trace(a.desc.pos.Pos(), "-- "+a.desc.format, a.desc.args...)
 354                 }
 355                 a.f() // may append to check.delayed
 356         }
 357         assert(top <= len(check.delayed)) // stack must not have shrunk
 358         check.delayed = check.delayed[:top]
 359 }
 360
 361 func (check *Checker) expandDefTypes() {
 362         // Ensure that every defined type created in the course of type-checking has
 363         // either non-*Named underlying, or is unresolved.
 364         //
 365         // This guarantees that we don't leak any types whose underlying is *Named,
 366         // because any unresolved instances will lazily compute their underlying by
 367         // substituting in the underlying of their origin. The origin must have
 368         // either been imported or type-checked and expanded here, and in either case
 369         // its underlying will be fully expanded.
 370         for i := 0; i < len(check.defTypes); i++ {
 371                 n := check.defTypes[i]
 372                 switch n.underlying.(type) {
 373                 case nil:
 374                         if n.resolver == nil {
 375                                 panic("nil underlying")
 376                         }
 377                 case *Named:
 378                         n.under() // n.under may add entries to check.defTypes
 379                 }
 380                 n.check = nil
 381         }
 382 }
 383
 384 func (check *Checker) record(x *operand) {
 385         // convert x into a user-friendly set of values
 386         // TODO(gri) this code can be simplified
 387         var typ Type
 388         var val constant.Value
 389         switch x.mode {
 390         case invalid:
 391                 typ = Typ[Invalid]
 392         case novalue:
 393                 typ = (*Tuple)(nil)
 394         case constant_:
 395                 typ = x.typ
 396                 val = x.val
 397         default:
 398                 typ = x.typ
 399         }
 400         assert(x.expr != nil && typ != nil)
 401
 402         if isUntyped(typ) {
 403                 // delay type and value recording until we know the type
 404                 // or until the end of type checking
 405                 check.rememberUntyped(x.expr, false, x.mode, typ.(*Basic), val)
 406         } else {
 407                 check.recordTypeAndValue(x.expr, x.mode, typ, val)
 408         }
 409 }
 410
 411 func (check *Checker) recordUntyped() {
 412         if !debug && check.Types == nil {
 413                 return // nothing to do
 414         }
 415
 416         for x, info := range check.untyped {
 417                 if debug && isTyped(info.typ) {
 418                         check.dump("%v: %s (type %s) is typed", posFor(x), x, info.typ)
 419                         unreachable()
 420                 }
 421                 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
 422         }
 423 }
 424
 425 func (check *Checker) recordTypeAndValue(x syntax.Expr, mode operandMode, typ Type, val constant.Value) {
 426         assert(x != nil)
 427         assert(typ != nil)
 428         if mode == invalid {
 429                 return // omit
 430         }
 431         if mode == constant_ {
 432                 assert(val != nil)
 433                 // We check allBasic(typ, IsConstType) here as constant expressions may be
 434                 // recorded as type parameters.
 435                 assert(typ == Typ[Invalid] || allBasic(typ, IsConstType))
 436         }
 437         if m := check.Types; m != nil {
 438                 m[x] = TypeAndValue{mode, typ, val}
 439         }
 440 }
 441
 442 func (check *Checker) recordBuiltinType(f syntax.Expr, sig *Signature) {
 443         // f must be a (possibly parenthesized, possibly qualified)
 444         // identifier denoting a built-in (including unsafe's non-constant
 445         // functions Add and Slice): record the signature for f and possible
 446         // children.
 447         for {
 448                 check.recordTypeAndValue(f, builtin, sig, nil)
 449                 switch p := f.(type) {
 450                 case *syntax.Name, *syntax.SelectorExpr:
 451                         return // we're done
 452                 case *syntax.ParenExpr:
 453                         f = p.X
 454                 default:
 455                         unreachable()
 456                 }
 457         }
 458 }
 459
 460 func (check *Checker) recordCommaOkTypes(x syntax.Expr, a [2]Type) {
 461         assert(x != nil)
 462         if a[0] == nil || a[1] == nil {
 463                 return
 464         }
 465         assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
 466         if m := check.Types; m != nil {
 467                 for {
 468                         tv := m[x]
 469                         assert(tv.Type != nil) // should have been recorded already
 470                         pos := x.Pos()
 471                         tv.Type = NewTuple(
 472                                 NewVar(pos, check.pkg, "", a[0]),
 473                                 NewVar(pos, check.pkg, "", a[1]),
 474                         )
 475                         m[x] = tv
 476                         // if x is a parenthesized expression (p.X), update p.X
 477                         p, _ := x.(*syntax.ParenExpr)
 478                         if p == nil {
 479                                 break
 480                         }
 481                         x = p.X
 482                 }
 483         }
 484 }
 485
 486 // recordInstance records instantiation information into check.Info, if the
 487 // Instances map is non-nil. The given expr must be an ident, selector, or
 488 // index (list) expr with ident or selector operand.
 489 //
 490 // TODO(rfindley): the expr parameter is fragile. See if we can access the
 491 // instantiated identifier in some other way.
 492 func (check *Checker) recordInstance(expr syntax.Expr, targs []Type, typ Type) {
 493         ident := instantiatedIdent(expr)
 494         assert(ident != nil)
 495         assert(typ != nil)
 496         if m := check.Instances; m != nil {
 497                 m[ident] = Instance{NewTypeList(targs), typ}
 498         }
 499 }
 500
 501 func instantiatedIdent(expr syntax.Expr) *syntax.Name {
 502         var selOrIdent syntax.Expr
 503         switch e := expr.(type) {
 504         case *syntax.IndexExpr:
 505                 selOrIdent = e.X
 506         case *syntax.SelectorExpr, *syntax.Name:
 507                 selOrIdent = e
 508         }
 509         switch x := selOrIdent.(type) {
 510         case *syntax.Name:
 511                 return x
 512         case *syntax.SelectorExpr:
 513                 return x.Sel
 514         }
 515         panic("instantiated ident not found")
 516 }
 517
 518 func (check *Checker) recordDef(id *syntax.Name, obj Object) {
 519         assert(id != nil)
 520         if m := check.Defs; m != nil {
 521                 m[id] = obj
 522         }
 523 }
 524
 525 func (check *Checker) recordUse(id *syntax.Name, obj Object) {
 526         assert(id != nil)
 527         assert(obj != nil)
 528         if m := check.Uses; m != nil {
 529                 m[id] = obj
 530         }
 531 }
 532
 533 func (check *Checker) recordImplicit(node syntax.Node, obj Object) {
 534         assert(node != nil)
 535         assert(obj != nil)
 536         if m := check.Implicits; m != nil {
 537                 m[node] = obj
 538         }
 539 }
 540
 541 func (check *Checker) recordSelection(x *syntax.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
 542         assert(obj != nil && (recv == nil || len(index) > 0))
 543         check.recordUse(x.Sel, obj)
 544         if m := check.Selections; m != nil {
 545                 m[x] = &Selection{kind, recv, obj, index, indirect}
 546         }
 547 }
 548
 549 func (check *Checker) recordScope(node syntax.Node, scope *Scope) {
 550         assert(node != nil)
 551         assert(scope != nil)
 552         if m := check.Scopes; m != nil {
 553                 m[node] = scope
 554         }
 555 }