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