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 // A Checker maintains the state of the type checker.
  78 // It must be created with NewChecker.
  79 type Checker struct {
  80         // package information
  81         // (initialized by NewChecker, valid for the life-time of checker)
  82         conf *Config
  83         pkg  *Package
  84         *Info
  85         version version                // accepted language version
  86         nextID  uint64                 // unique Id for type parameters (first valid Id is 1)
  87         objMap  map[Object]*declInfo   // maps package-level objects and (non-interface) methods to declaration info
  88         impMap  map[importKey]*Package // maps (import path, source directory) to (complete or fake) package
  89
  90         // pkgPathMap maps package names to the set of distinct import paths we've
  91         // seen for that name, anywhere in the import graph. It is used for
  92         // disambiguating package names in error messages.
  93         //
  94         // pkgPathMap is allocated lazily, so that we don't pay the price of building
  95         // it on the happy path. seenPkgMap tracks the packages that we've already
  96         // walked.
  97         pkgPathMap map[string]map[string]bool
  98         seenPkgMap map[*Package]bool
  99
 100         // information collected during type-checking of a set of package files
 101         // (initialized by Files, valid only for the duration of check.Files;
 102         // maps and lists are allocated on demand)
 103         files        []*syntax.File            // list of package files
 104         imports      []*PkgName                // list of imported packages
 105         dotImportMap map[dotImportKey]*PkgName // maps dot-imported objects to the package they were dot-imported through
 106
 107         firstErr error                    // first error encountered
 108         methods  map[*TypeName][]*Func    // maps package scope type names to associated non-blank (non-interface) methods
 109         untyped  map[syntax.Expr]exprInfo // map of expressions without final type
 110         delayed  []func()                 // stack of delayed action segments; segments are processed in FIFO order
 111         objPath  []Object                 // path of object dependencies during type inference (for cycle reporting)
 112
 113         // context within which the current object is type-checked
 114         // (valid only for the duration of type-checking a specific object)
 115         context
 116
 117         // debugging
 118         indent int // indentation for tracing
 119 }
 120
 121 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
 122 func (check *Checker) addDeclDep(to Object) {
 123         from := check.decl
 124         if from == nil {
 125                 return // not in a package-level init expression
 126         }
 127         if _, found := check.objMap[to]; !found {
 128                 return // to is not a package-level object
 129         }
 130         from.addDep(to)
 131 }
 132
 133 func (check *Checker) rememberUntyped(e syntax.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
 134         m := check.untyped
 135         if m == nil {
 136                 m = make(map[syntax.Expr]exprInfo)
 137                 check.untyped = m
 138         }
 139         m[e] = exprInfo{lhs, mode, typ, val}
 140 }
 141
 142 // later pushes f on to the stack of actions that will be processed later;
 143 // either at the end of the current statement, or in case of a local constant
 144 // or variable declaration, before the constant or variable is in scope
 145 // (so that f still sees the scope before any new declarations).
 146 func (check *Checker) later(f func()) {
 147         check.delayed = append(check.delayed, f)
 148 }
 149
 150 // push pushes obj onto the object path and returns its index in the path.
 151 func (check *Checker) push(obj Object) int {
 152         check.objPath = append(check.objPath, obj)
 153         return len(check.objPath) - 1
 154 }
 155
 156 // pop pops and returns the topmost object from the object path.
 157 func (check *Checker) pop() Object {
 158         i := len(check.objPath) - 1
 159         obj := check.objPath[i]
 160         check.objPath[i] = nil
 161         check.objPath = check.objPath[:i]
 162         return obj
 163 }
 164
 165 // NewChecker returns a new Checker instance for a given package.
 166 // Package files may be added incrementally via checker.Files.
 167 func NewChecker(conf *Config, pkg *Package, info *Info) *Checker {
 168         // make sure we have a configuration
 169         if conf == nil {
 170                 conf = new(Config)
 171         }
 172
 173         // make sure we have an environment
 174         if conf.Environment == nil {
 175                 conf.Environment = NewEnvironment()
 176         }
 177
 178         // make sure we have an info struct
 179         if info == nil {
 180                 info = new(Info)
 181         }
 182
 183         version, err := parseGoVersion(conf.GoVersion)
 184         if err != nil {
 185                 panic(fmt.Sprintf("invalid Go version %q (%v)", conf.GoVersion, err))
 186         }
 187
 188         return &Checker{
 189                 conf:    conf,
 190                 pkg:     pkg,
 191                 Info:    info,
 192                 version: version,
 193                 objMap:  make(map[Object]*declInfo),
 194                 impMap:  make(map[importKey]*Package),
 195         }
 196 }
 197
 198 // initFiles initializes the files-specific portion of checker.
 199 // The provided files must all belong to the same package.
 200 func (check *Checker) initFiles(files []*syntax.File) {
 201         // start with a clean slate (check.Files may be called multiple times)
 202         check.files = nil
 203         check.imports = nil
 204         check.dotImportMap = nil
 205
 206         check.firstErr = nil
 207         check.methods = nil
 208         check.untyped = nil
 209         check.delayed = nil
 210
 211         // determine package name and collect valid files
 212         pkg := check.pkg
 213         for _, file := range files {
 214                 switch name := file.PkgName.Value; pkg.name {
 215                 case "":
 216                         if name != "_" {
 217                                 pkg.name = name
 218                         } else {
 219                                 check.error(file.PkgName, "invalid package name _")
 220                         }
 221                         fallthrough
 222
 223                 case name:
 224                         check.files = append(check.files, file)
 225
 226                 default:
 227                         check.errorf(file, "package %s; expected %s", name, pkg.name)
 228                         // ignore this file
 229                 }
 230         }
 231 }
 232
 233 // A bailout panic is used for early termination.
 234 type bailout struct{}
 235
 236 func (check *Checker) handleBailout(err *error) {
 237         switch p := recover().(type) {
 238         case nil, bailout:
 239                 // normal return or early exit
 240                 *err = check.firstErr
 241         default:
 242                 // re-panic
 243                 panic(p)
 244         }
 245 }
 246
 247 // Files checks the provided files as part of the checker's package.
 248 func (check *Checker) Files(files []*syntax.File) error { return check.checkFiles(files) }
 249
 250 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
 251
 252 func (check *Checker) checkFiles(files []*syntax.File) (err error) {
 253         if check.conf.FakeImportC && check.conf.go115UsesCgo {
 254                 return errBadCgo
 255         }
 256
 257         defer check.handleBailout(&err)
 258
 259         print := func(msg string) {
 260                 if check.conf.Trace {
 261                         fmt.Println(msg)
 262                 }
 263         }
 264
 265         print("== initFiles ==")
 266         check.initFiles(files)
 267
 268         print("== collectObjects ==")
 269         check.collectObjects()
 270
 271         print("== packageObjects ==")
 272         check.packageObjects()
 273
 274         print("== processDelayed ==")
 275         check.processDelayed(0) // incl. all functions
 276
 277         print("== initOrder ==")
 278         check.initOrder()
 279
 280         if !check.conf.DisableUnusedImportCheck {
 281                 print("== unusedImports ==")
 282                 check.unusedImports()
 283         }
 284
 285         print("== recordUntyped ==")
 286         check.recordUntyped()
 287
 288         check.pkg.complete = true
 289
 290         // no longer needed - release memory
 291         check.imports = nil
 292         check.dotImportMap = nil
 293         check.pkgPathMap = nil
 294         check.seenPkgMap = nil
 295
 296         // TODO(gri) There's more memory we should release at this point.
 297
 298         return
 299 }
 300
 301 // processDelayed processes all delayed actions pushed after top.
 302 func (check *Checker) processDelayed(top int) {
 303         // If each delayed action pushes a new action, the
 304         // stack will continue to grow during this loop.
 305         // However, it is only processing functions (which
 306         // are processed in a delayed fashion) that may
 307         // add more actions (such as nested functions), so
 308         // this is a sufficiently bounded process.
 309         for i := top; i < len(check.delayed); i++ {
 310                 check.delayed[i]() // may append to check.delayed
 311         }
 312         assert(top <= len(check.delayed)) // stack must not have shrunk
 313         check.delayed = check.delayed[:top]
 314 }
 315
 316 func (check *Checker) record(x *operand) {
 317         // convert x into a user-friendly set of values
 318         // TODO(gri) this code can be simplified
 319         var typ Type
 320         var val constant.Value
 321         switch x.mode {
 322         case invalid:
 323                 typ = Typ[Invalid]
 324         case novalue:
 325                 typ = (*Tuple)(nil)
 326         case constant_:
 327                 typ = x.typ
 328                 val = x.val
 329         default:
 330                 typ = x.typ
 331         }
 332         assert(x.expr != nil && typ != nil)
 333
 334         if isUntyped(typ) {
 335                 // delay type and value recording until we know the type
 336                 // or until the end of type checking
 337                 check.rememberUntyped(x.expr, false, x.mode, typ.(*Basic), val)
 338         } else {
 339                 check.recordTypeAndValue(x.expr, x.mode, typ, val)
 340         }
 341 }
 342
 343 func (check *Checker) recordUntyped() {
 344         if !debug && check.Types == nil {
 345                 return // nothing to do
 346         }
 347
 348         for x, info := range check.untyped {
 349                 if debug && isTyped(info.typ) {
 350                         check.dump("%v: %s (type %s) is typed", posFor(x), x, info.typ)
 351                         unreachable()
 352                 }
 353                 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
 354         }
 355 }
 356
 357 func (check *Checker) recordTypeAndValue(x syntax.Expr, mode operandMode, typ Type, val constant.Value) {
 358         assert(x != nil)
 359         assert(typ != nil)
 360         if mode == invalid {
 361                 return // omit
 362         }
 363         if mode == constant_ {
 364                 assert(val != nil)
 365                 // We check is(typ, IsConstType) here as constant expressions may be
 366                 // recorded as type parameters.
 367                 assert(typ == Typ[Invalid] || is(typ, IsConstType))
 368         }
 369         if m := check.Types; m != nil {
 370                 m[x] = TypeAndValue{mode, typ, val}
 371         }
 372 }
 373
 374 func (check *Checker) recordBuiltinType(f syntax.Expr, sig *Signature) {
 375         // f must be a (possibly parenthesized, possibly qualified)
 376         // identifier denoting a built-in (including unsafe's non-constant
 377         // functions Add and Slice): record the signature for f and possible
 378         // children.
 379         for {
 380                 check.recordTypeAndValue(f, builtin, sig, nil)
 381                 switch p := f.(type) {
 382                 case *syntax.Name, *syntax.SelectorExpr:
 383                         return // we're done
 384                 case *syntax.ParenExpr:
 385                         f = p.X
 386                 default:
 387                         unreachable()
 388                 }
 389         }
 390 }
 391
 392 func (check *Checker) recordCommaOkTypes(x syntax.Expr, a [2]Type) {
 393         assert(x != nil)
 394         if a[0] == nil || a[1] == nil {
 395                 return
 396         }
 397         assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
 398         if m := check.Types; m != nil {
 399                 for {
 400                         tv := m[x]
 401                         assert(tv.Type != nil) // should have been recorded already
 402                         pos := x.Pos()
 403                         tv.Type = NewTuple(
 404                                 NewVar(pos, check.pkg, "", a[0]),
 405                                 NewVar(pos, check.pkg, "", a[1]),
 406                         )
 407                         m[x] = tv
 408                         // if x is a parenthesized expression (p.X), update p.X
 409                         p, _ := x.(*syntax.ParenExpr)
 410                         if p == nil {
 411                                 break
 412                         }
 413                         x = p.X
 414                 }
 415         }
 416 }
 417
 418 // recordInstance records instantiation information into check.Info, if the
 419 // Instances map is non-nil. The given expr must be an ident, selector, or
 420 // index (list) expr with ident or selector operand.
 421 //
 422 // TODO(rfindley): the expr parameter is fragile. See if we can access the
 423 // instantiated identifier in some other way.
 424 func (check *Checker) recordInstance(expr syntax.Expr, targs []Type, typ Type) {
 425         ident := instantiatedIdent(expr)
 426         assert(ident != nil)
 427         assert(typ != nil)
 428         if m := check.Instances; m != nil {
 429                 m[ident] = Instance{NewTypeList(targs), typ}
 430         }
 431 }
 432
 433 func instantiatedIdent(expr syntax.Expr) *syntax.Name {
 434         var selOrIdent syntax.Expr
 435         switch e := expr.(type) {
 436         case *syntax.IndexExpr:
 437                 selOrIdent = e.X
 438         case *syntax.SelectorExpr, *syntax.Name:
 439                 selOrIdent = e
 440         }
 441         switch x := selOrIdent.(type) {
 442         case *syntax.Name:
 443                 return x
 444         case *syntax.SelectorExpr:
 445                 return x.Sel
 446         }
 447         panic("instantiated ident not found")
 448 }
 449
 450 func (check *Checker) recordDef(id *syntax.Name, obj Object) {
 451         assert(id != nil)
 452         if m := check.Defs; m != nil {
 453                 m[id] = obj
 454         }
 455 }
 456
 457 func (check *Checker) recordUse(id *syntax.Name, obj Object) {
 458         assert(id != nil)
 459         assert(obj != nil)
 460         if m := check.Uses; m != nil {
 461                 m[id] = obj
 462         }
 463 }
 464
 465 func (check *Checker) recordImplicit(node syntax.Node, obj Object) {
 466         assert(node != nil)
 467         assert(obj != nil)
 468         if m := check.Implicits; m != nil {
 469                 m[node] = obj
 470         }
 471 }
 472
 473 func (check *Checker) recordSelection(x *syntax.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
 474         assert(obj != nil && (recv == nil || len(index) > 0))
 475         check.recordUse(x.Sel, obj)
 476         if m := check.Selections; m != nil {
 477                 m[x] = &Selection{kind, recv, obj, index, indirect}
 478         }
 479 }
 480
 481 func (check *Checker) recordScope(node syntax.Node, scope *Scope) {
 482         assert(node != nil)
 483         assert(scope != nil)
 484         if m := check.Scopes; m != nil {
 485                 m[node] = scope
 486         }
 487 }