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