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