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