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         obj   Object
  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         posMap  map[*Interface][]token.Pos // maps interface types to lists of embedded interface positions
  93         typMap  map[string]*Named          // maps an instantiated named type hash to a *Named type
  94         pkgCnt  map[string]int             // counts number of imported packages with a given name (for better error messages)
  95
  96         // information collected during type-checking of a set of package files
  97         // (initialized by Files, valid only for the duration of check.Files;
  98         // maps and lists are allocated on demand)
  99         files        []*ast.File               // package files
 100         imports      []*PkgName                // list of imported packages
 101         dotImportMap map[dotImportKey]*PkgName // maps dot-imported objects to the package they were dot-imported through
 102
 103         firstErr error                 // first error encountered
 104         methods  map[*TypeName][]*Func // maps package scope type names to associated non-blank (non-interface) methods
 105         untyped  map[ast.Expr]exprInfo // map of expressions without final type
 106         delayed  []func()              // stack of delayed action segments; segments are processed in FIFO order
 107         finals   []func()              // list of final actions; processed at the end of type-checking the current set of files
 108         objPath  []Object              // path of object dependencies during type inference (for cycle reporting)
 109
 110         // context within which the current object is type-checked
 111         // (valid only for the duration of type-checking a specific object)
 112         context
 113
 114         // debugging
 115         indent int // indentation for tracing
 116 }
 117
 118 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
 119 func (check *Checker) addDeclDep(to Object) {
 120         from := check.decl
 121         if from == nil {
 122                 return // not in a package-level init expression
 123         }
 124         if _, found := check.objMap[to]; !found {
 125                 return // to is not a package-level object
 126         }
 127         from.addDep(to)
 128 }
 129
 130 func (check *Checker) rememberUntyped(e ast.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
 131         m := check.untyped
 132         if m == nil {
 133                 m = make(map[ast.Expr]exprInfo)
 134                 check.untyped = m
 135         }
 136         m[e] = exprInfo{lhs, mode, typ, val}
 137 }
 138
 139 // later pushes f on to the stack of actions that will be processed later;
 140 // either at the end of the current statement, or in case of a local constant
 141 // or variable declaration, before the constant or variable is in scope
 142 // (so that f still sees the scope before any new declarations).
 143 func (check *Checker) later(f func()) {
 144         check.delayed = append(check.delayed, f)
 145 }
 146
 147 // atEnd adds f to the list of actions processed at the end
 148 // of type-checking, before initialization order computation.
 149 // Actions added by atEnd are processed after any actions
 150 // added by later.
 151 func (check *Checker) atEnd(f func()) {
 152         check.finals = append(check.finals, f)
 153 }
 154
 155 // push pushes obj onto the object path and returns its index in the path.
 156 func (check *Checker) push(obj Object) int {
 157         check.objPath = append(check.objPath, obj)
 158         return len(check.objPath) - 1
 159 }
 160
 161 // pop pops and returns the topmost object from the object path.
 162 func (check *Checker) pop() Object {
 163         i := len(check.objPath) - 1
 164         obj := check.objPath[i]
 165         check.objPath[i] = nil
 166         check.objPath = check.objPath[:i]
 167         return obj
 168 }
 169
 170 // NewChecker returns a new Checker instance for a given package.
 171 // Package files may be added incrementally via checker.Files.
 172 func NewChecker(conf *Config, fset *token.FileSet, pkg *Package, info *Info) *Checker {
 173         // make sure we have a configuration
 174         if conf == nil {
 175                 conf = new(Config)
 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                 fset:    fset,
 191                 pkg:     pkg,
 192                 Info:    info,
 193                 version: version,
 194                 nextId:  1,
 195                 objMap:  make(map[Object]*declInfo),
 196                 impMap:  make(map[importKey]*Package),
 197                 posMap:  make(map[*Interface][]token.Pos),
 198                 typMap:  make(map[string]*Named),
 199                 pkgCnt:  make(map[string]int),
 200         }
 201 }
 202
 203 // initFiles initializes the files-specific portion of checker.
 204 // The provided files must all belong to the same package.
 205 func (check *Checker) initFiles(files []*ast.File) {
 206         // start with a clean slate (check.Files may be called multiple times)
 207         check.files = nil
 208         check.imports = nil
 209         check.dotImportMap = nil
 210
 211         check.firstErr = nil
 212         check.methods = nil
 213         check.untyped = nil
 214         check.delayed = nil
 215         check.finals = nil
 216
 217         // determine package name and collect valid files
 218         pkg := check.pkg
 219         for _, file := range files {
 220                 switch name := file.Name.Name; pkg.name {
 221                 case "":
 222                         if name != "_" {
 223                                 pkg.name = name
 224                         } else {
 225                                 check.errorf(file.Name, _BlankPkgName, "invalid package name _")
 226                         }
 227                         fallthrough
 228
 229                 case name:
 230                         check.files = append(check.files, file)
 231
 232                 default:
 233                         check.errorf(atPos(file.Package), _MismatchedPkgName, "package %s; expected %s", name, pkg.name)
 234                         // ignore this file
 235                 }
 236         }
 237 }
 238
 239 // A bailout panic is used for early termination.
 240 type bailout struct{}
 241
 242 func (check *Checker) handleBailout(err *error) {
 243         switch p := recover().(type) {
 244         case nil, bailout:
 245                 // normal return or early exit
 246                 *err = check.firstErr
 247         default:
 248                 // re-panic
 249                 panic(p)
 250         }
 251 }
 252
 253 // Files checks the provided files as part of the checker's package.
 254 func (check *Checker) Files(files []*ast.File) error { return check.checkFiles(files) }
 255
 256 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
 257
 258 func (check *Checker) checkFiles(files []*ast.File) (err error) {
 259         if check.conf.FakeImportC && check.conf.go115UsesCgo {
 260                 return errBadCgo
 261         }
 262
 263         defer check.handleBailout(&err)
 264
 265         check.initFiles(files)
 266
 267         check.collectObjects()
 268
 269         check.packageObjects()
 270
 271         check.processDelayed(0) // incl. all functions
 272         check.processFinals()
 273
 274         check.initOrder()
 275
 276         if !check.conf.DisableUnusedImportCheck {
 277                 check.unusedImports()
 278         }
 279         // no longer needed - release memory
 280         check.imports = nil
 281         check.dotImportMap = nil
 282
 283         check.recordUntyped()
 284
 285         if check.Info != nil {
 286                 sanitizeInfo(check.Info)
 287         }
 288
 289         check.pkg.complete = true
 290
 291         // TODO(rFindley) There's more memory we should release at this point.
 292
 293         return
 294 }
 295
 296 // processDelayed processes all delayed actions pushed after top.
 297 func (check *Checker) processDelayed(top int) {
 298         // If each delayed action pushes a new action, the
 299         // stack will continue to grow during this loop.
 300         // However, it is only processing functions (which
 301         // are processed in a delayed fashion) that may
 302         // add more actions (such as nested functions), so
 303         // this is a sufficiently bounded process.
 304         for i := top; i < len(check.delayed); i++ {
 305                 check.delayed[i]() // may append to check.delayed
 306         }
 307         assert(top <= len(check.delayed)) // stack must not have shrunk
 308         check.delayed = check.delayed[:top]
 309 }
 310
 311 func (check *Checker) processFinals() {
 312         n := len(check.finals)
 313         for _, f := range check.finals {
 314                 f() // must not append to check.finals
 315         }
 316         if len(check.finals) != n {
 317                 panic("internal error: final action list grew")
 318         }
 319 }
 320
 321 func (check *Checker) recordUntyped() {
 322         if !debug && check.Types == nil {
 323                 return // nothing to do
 324         }
 325
 326         for x, info := range check.untyped {
 327                 if debug && isTyped(info.typ) {
 328                         check.dump("%v: %s (type %s) is typed", x.Pos(), x, info.typ)
 329                         unreachable()
 330                 }
 331                 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
 332         }
 333 }
 334
 335 func (check *Checker) recordTypeAndValue(x ast.Expr, mode operandMode, typ Type, val constant.Value) {
 336         assert(x != nil)
 337         assert(typ != nil)
 338         if mode == invalid {
 339                 return // omit
 340         }
 341         if mode == constant_ {
 342                 assert(val != nil)
 343                 assert(typ == Typ[Invalid] || isConstType(typ))
 344         }
 345         if m := check.Types; m != nil {
 346                 m[x] = TypeAndValue{mode, typ, val}
 347         }
 348 }
 349
 350 func (check *Checker) recordBuiltinType(f ast.Expr, sig *Signature) {
 351         // f must be a (possibly parenthesized) identifier denoting a built-in
 352         // (built-ins in package unsafe always produce a constant result and
 353         // we don't record their signatures, so we don't see qualified idents
 354         // here): record the signature for f and possible children.
 355         for {
 356                 check.recordTypeAndValue(f, builtin, sig, nil)
 357                 switch p := f.(type) {
 358                 case *ast.Ident:
 359                         return // we're done
 360                 case *ast.ParenExpr:
 361                         f = p.X
 362                 default:
 363                         unreachable()
 364                 }
 365         }
 366 }
 367
 368 func (check *Checker) recordCommaOkTypes(x ast.Expr, a [2]Type) {
 369         assert(x != nil)
 370         if a[0] == nil || a[1] == nil {
 371                 return
 372         }
 373         assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
 374         if m := check.Types; m != nil {
 375                 for {
 376                         tv := m[x]
 377                         assert(tv.Type != nil) // should have been recorded already
 378                         pos := x.Pos()
 379                         tv.Type = NewTuple(
 380                                 NewVar(pos, check.pkg, "", a[0]),
 381                                 NewVar(pos, check.pkg, "", a[1]),
 382                         )
 383                         m[x] = tv
 384                         // if x is a parenthesized expression (p.X), update p.X
 385                         p, _ := x.(*ast.ParenExpr)
 386                         if p == nil {
 387                                 break
 388                         }
 389                         x = p.X
 390                 }
 391         }
 392 }
 393
 394 func (check *Checker) recordInferred(call ast.Expr, targs []Type, sig *Signature) {
 395         assert(call != nil)
 396         assert(sig != nil)
 397         if m := check.Inferred; m != nil {
 398                 m[call] = Inferred{targs, sig}
 399         }
 400 }
 401
 402 func (check *Checker) recordDef(id *ast.Ident, obj Object) {
 403         assert(id != nil)
 404         if m := check.Defs; m != nil {
 405                 m[id] = obj
 406         }
 407 }
 408
 409 func (check *Checker) recordUse(id *ast.Ident, obj Object) {
 410         assert(id != nil)
 411         assert(obj != nil)
 412         if m := check.Uses; m != nil {
 413                 m[id] = obj
 414         }
 415 }
 416
 417 func (check *Checker) recordImplicit(node ast.Node, obj Object) {
 418         assert(node != nil)
 419         assert(obj != nil)
 420         if m := check.Implicits; m != nil {
 421                 m[node] = obj
 422         }
 423 }
 424
 425 func (check *Checker) recordSelection(x *ast.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
 426         assert(obj != nil && (recv == nil || len(index) > 0))
 427         check.recordUse(x.Sel, obj)
 428         if m := check.Selections; m != nil {
 429                 m[x] = &Selection{kind, recv, obj, index, indirect}
 430         }
 431 }
 432
 433 func (check *Checker) recordScope(node ast.Node, scope *Scope) {
 434         assert(node != nil)
 435         assert(scope != nil)
 436         if m := check.Scopes; m != nil {
 437                 m[node] = scope
 438         }
 439 }