src/cmd/compile/internal/types2/check.go

   1 // UNREVIEWED
   2 // Copyright 2011 The Go Authors. All rights reserved.
   3 // Use of this source code is governed by a BSD-style
   4 // license that can be found in the LICENSE file.
   5
   6 // This file implements the Check function, which drives type-checking.
   7
   8 package types2
   9
  10 import (
  11         "cmd/compile/internal/syntax"
  12         "errors"
  13         "fmt"
  14         "go/constant"
  15 )
  16
  17 var nopos syntax.Pos
  18
  19 // debugging/development support
  20 const debug = true // leave on during development
  21
  22 // If forceStrict is set, the type-checker enforces additional
  23 // rules not specified by the Go 1 spec, but which will
  24 // catch guaranteed run-time errors if the respective
  25 // code is executed. In other words, programs passing in
  26 // strict mode are Go 1 compliant, but not all Go 1 programs
  27 // will pass in strict mode. The additional rules are:
  28 //
  29 // - A type assertion x.(T) where T is an interface type
  30 //   is invalid if any (statically known) method that exists
  31 //   for both x and T have different signatures.
  32 //
  33 const forceStrict = false
  34
  35 // If methodTypeParamsOk is set, type parameters are
  36 // permitted in method declarations (in interfaces, too).
  37 // Generalization and experimental feature.
  38 const methodTypeParamsOk = true
  39
  40 // exprInfo stores information about an untyped expression.
  41 type exprInfo struct {
  42         isLhs bool // expression is lhs operand of a shift with delayed type-check
  43         mode  operandMode
  44         typ   *Basic
  45         val   constant.Value // constant value; or nil (if not a constant)
  46 }
  47
  48 // A context represents the context within which an object is type-checked.
  49 type context struct {
  50         decl          *declInfo                 // package-level declaration whose init expression/function body is checked
  51         scope         *Scope                    // top-most scope for lookups
  52         pos           syntax.Pos                // if valid, identifiers are looked up as if at position pos (used by Eval)
  53         iota          constant.Value            // value of iota in a constant declaration; nil otherwise
  54         errpos        syntax.Pos                // if valid, identifier position of a constant with inherited initializer
  55         sig           *Signature                // function signature if inside a function; nil otherwise
  56         isPanic       map[*syntax.CallExpr]bool // set of panic call expressions (used for termination check)
  57         hasLabel      bool                      // set if a function makes use of labels (only ~1% of functions); unused outside functions
  58         hasCallOrRecv bool                      // set if an expression contains a function call or channel receive operation
  59 }
  60
  61 // lookup looks up name in the current context and returns the matching object, or nil.
  62 func (ctxt *context) lookup(name string) Object {
  63         _, obj := ctxt.scope.LookupParent(name, ctxt.pos)
  64         return obj
  65 }
  66
  67 // An importKey identifies an imported package by import path and source directory
  68 // (directory containing the file containing the import). In practice, the directory
  69 // may always be the same, or may not matter. Given an (import path, directory), an
  70 // importer must always return the same package (but given two different import paths,
  71 // an importer may still return the same package by mapping them to the same package
  72 // paths).
  73 type importKey struct {
  74         path, dir string
  75 }
  76
  77 // A dotImportKey describes a dot-imported object in the given scope.
  78 type dotImportKey struct {
  79         scope *Scope
  80         obj   Object
  81 }
  82
  83 // A Checker maintains the state of the type checker.
  84 // It must be created with NewChecker.
  85 type Checker struct {
  86         // package information
  87         // (initialized by NewChecker, valid for the life-time of checker)
  88         conf *Config
  89         pkg  *Package
  90         *Info
  91         nextId uint64                      // unique Id for type parameters (first valid Id is 1)
  92         objMap map[Object]*declInfo        // maps package-level objects and (non-interface) methods to declaration info
  93         impMap map[importKey]*Package      // maps (import path, source directory) to (complete or fake) package
  94         posMap map[*Interface][]syntax.Pos // maps interface types to lists of embedded interface positions
  95         typMap map[string]*Named           // maps an instantiated named type hash to a *Named type
  96         pkgCnt map[string]int              // counts number of imported packages with a given name (for better error messages)
  97
  98         // information collected during type-checking of a set of package files
  99         // (initialized by Files, valid only for the duration of check.Files;
 100         // maps and lists are allocated on demand)
 101         files        []*syntax.File            // list of package files
 102         imports      []*PkgName                // list of imported packages
 103         dotImportMap map[dotImportKey]*PkgName // maps dot-imported objects to the package they were dot-imported through
 104
 105         firstErr error                    // first error encountered
 106         methods  map[*TypeName][]*Func    // maps package scope type names to associated non-blank (non-interface) methods
 107         untyped  map[syntax.Expr]exprInfo // map of expressions without final type
 108         delayed  []func()                 // stack of delayed action segments; segments are processed in FIFO order
 109         finals   []func()                 // list of final actions; processed at the end of type-checking the current set of files
 110         objPath  []Object                 // path of object dependencies during type inference (for cycle reporting)
 111
 112         // context within which the current object is type-checked
 113         // (valid only for the duration of type-checking a specific object)
 114         context
 115
 116         // debugging
 117         indent int // indentation for tracing
 118 }
 119
 120 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
 121 func (check *Checker) addDeclDep(to Object) {
 122         from := check.decl
 123         if from == nil {
 124                 return // not in a package-level init expression
 125         }
 126         if _, found := check.objMap[to]; !found {
 127                 return // to is not a package-level object
 128         }
 129         from.addDep(to)
 130 }
 131
 132 func (check *Checker) rememberUntyped(e syntax.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
 133         m := check.untyped
 134         if m == nil {
 135                 m = make(map[syntax.Expr]exprInfo)
 136                 check.untyped = m
 137         }
 138         m[e] = exprInfo{lhs, mode, typ, val}
 139 }
 140
 141 // later pushes f on to the stack of actions that will be processed later;
 142 // either at the end of the current statement, or in case of a local constant
 143 // or variable declaration, before the constant or variable is in scope
 144 // (so that f still sees the scope before any new declarations).
 145 func (check *Checker) later(f func()) {
 146         check.delayed = append(check.delayed, f)
 147 }
 148
 149 // atEnd adds f to the list of actions processed at the end
 150 // of type-checking, before initialization order computation.
 151 // Actions added by atEnd are processed after any actions
 152 // added by later.
 153 func (check *Checker) atEnd(f func()) {
 154         check.finals = append(check.finals, f)
 155 }
 156
 157 // push pushes obj onto the object path and returns its index in the path.
 158 func (check *Checker) push(obj Object) int {
 159         check.objPath = append(check.objPath, obj)
 160         return len(check.objPath) - 1
 161 }
 162
 163 // pop pops and returns the topmost object from the object path.
 164 func (check *Checker) pop() Object {
 165         i := len(check.objPath) - 1
 166         obj := check.objPath[i]
 167         check.objPath[i] = nil
 168         check.objPath = check.objPath[:i]
 169         return obj
 170 }
 171
 172 // NewChecker returns a new Checker instance for a given package.
 173 // Package files may be added incrementally via checker.Files.
 174 func NewChecker(conf *Config, pkg *Package, info *Info) *Checker {
 175         // make sure we have a configuration
 176         if conf == nil {
 177                 conf = new(Config)
 178         }
 179
 180         // make sure we have an info struct
 181         if info == nil {
 182                 info = new(Info)
 183         }
 184
 185         return &Checker{
 186                 conf:   conf,
 187                 pkg:    pkg,
 188                 Info:   info,
 189                 nextId: 1,
 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                 pkgCnt: make(map[string]int),
 195         }
 196 }
 197
 198 // initFiles initializes the files-specific portion of checker.
 199 // The provided files must all belong to the same package.
 200 func (check *Checker) initFiles(files []*syntax.File) {
 201         // start with a clean slate (check.Files may be called multiple times)
 202         check.files = nil
 203         check.imports = nil
 204         check.dotImportMap = nil
 205
 206         check.firstErr = nil
 207         check.methods = nil
 208         check.untyped = nil
 209         check.delayed = nil
 210         check.finals = nil
 211
 212         // determine package name and collect valid files
 213         pkg := check.pkg
 214         for _, file := range files {
 215                 switch name := file.PkgName.Value; pkg.name {
 216                 case "":
 217                         if name != "_" {
 218                                 pkg.name = name
 219                         } else {
 220                                 check.errorf(file.PkgName, "invalid package name _")
 221                         }
 222                         fallthrough
 223
 224                 case name:
 225                         check.files = append(check.files, file)
 226
 227                 default:
 228                         check.errorf(file, "package %s; expected %s", name, pkg.name)
 229                         // ignore this file
 230                 }
 231         }
 232 }
 233
 234 // A bailout panic is used for early termination.
 235 type bailout struct{}
 236
 237 func (check *Checker) handleBailout(err *error) {
 238         switch p := recover().(type) {
 239         case nil, bailout:
 240                 // normal return or early exit
 241                 *err = check.firstErr
 242         default:
 243                 // re-panic
 244                 panic(p)
 245         }
 246 }
 247
 248 // Files checks the provided files as part of the checker's package.
 249 func (check *Checker) Files(files []*syntax.File) error { return check.checkFiles(files) }
 250
 251 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
 252
 253 func (check *Checker) checkFiles(files []*syntax.File) (err error) {
 254         if check.conf.FakeImportC && check.conf.go115UsesCgo {
 255                 return errBadCgo
 256         }
 257
 258         defer check.handleBailout(&err)
 259
 260         print := func(msg string) {
 261                 if check.conf.Trace {
 262                         fmt.Println(msg)
 263                 }
 264         }
 265
 266         print("== initFiles ==")
 267         check.initFiles(files)
 268
 269         print("== collectObjects ==")
 270         check.collectObjects()
 271
 272         print("== packageObjects ==")
 273         check.packageObjects()
 274
 275         print("== processDelayed ==")
 276         check.processDelayed(0) // incl. all functions
 277         check.processFinals()
 278
 279         print("== initOrder ==")
 280         check.initOrder()
 281
 282         if !check.conf.DisableUnusedImportCheck {
 283                 print("== unusedImports ==")
 284                 check.unusedImports()
 285         }
 286         // no longer needed - release memory
 287         check.imports = nil
 288         check.dotImportMap = nil
 289
 290         print("== recordUntyped ==")
 291         check.recordUntyped()
 292
 293         if check.Info != nil {
 294                 print("== sanitizeInfo ==")
 295                 sanitizeInfo(check.Info)
 296         }
 297
 298         check.pkg.complete = true
 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) processFinals() {
 321         n := len(check.finals)
 322         for _, f := range check.finals {
 323                 f() // must not append to check.finals
 324         }
 325         if len(check.finals) != n {
 326                 panic("internal error: final action list grew")
 327         }
 328 }
 329
 330 func (check *Checker) recordUntyped() {
 331         if !debug && check.Types == nil {
 332                 return // nothing to do
 333         }
 334
 335         for x, info := range check.untyped {
 336                 if debug && isTyped(info.typ) {
 337                         check.dump("%v: %s (type %s) is typed", posFor(x), x, info.typ)
 338                         unreachable()
 339                 }
 340                 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
 341         }
 342 }
 343
 344 func (check *Checker) recordTypeAndValue(x syntax.Expr, mode operandMode, typ Type, val constant.Value) {
 345         assert(x != nil)
 346         assert(typ != nil)
 347         if mode == invalid {
 348                 return // omit
 349         }
 350         if mode == constant_ {
 351                 assert(val != nil)
 352                 assert(typ == Typ[Invalid] || isConstType(typ))
 353         }
 354         if m := check.Types; m != nil {
 355                 m[x] = TypeAndValue{mode, typ, val}
 356         }
 357 }
 358
 359 func (check *Checker) recordBuiltinType(f syntax.Expr, sig *Signature) {
 360         // f must be a (possibly parenthesized) identifier denoting a built-in
 361         // (built-ins in package unsafe always produce a constant result and
 362         // we don't record their signatures, so we don't see qualified idents
 363         // here): record the signature for f and possible children.
 364         for {
 365                 check.recordTypeAndValue(f, builtin, sig, nil)
 366                 switch p := f.(type) {
 367                 case *syntax.Name:
 368                         return // we're done
 369                 case *syntax.ParenExpr:
 370                         f = p.X
 371                 default:
 372                         unreachable()
 373                 }
 374         }
 375 }
 376
 377 func (check *Checker) recordCommaOkTypes(x syntax.Expr, a [2]Type) {
 378         assert(x != nil)
 379         if a[0] == nil || a[1] == nil {
 380                 return
 381         }
 382         assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
 383         if m := check.Types; m != nil {
 384                 for {
 385                         tv := m[x]
 386                         assert(tv.Type != nil) // should have been recorded already
 387                         pos := x.Pos()
 388                         tv.Type = NewTuple(
 389                                 NewVar(pos, check.pkg, "", a[0]),
 390                                 NewVar(pos, check.pkg, "", a[1]),
 391                         )
 392                         m[x] = tv
 393                         // if x is a parenthesized expression (p.X), update p.X
 394                         p, _ := x.(*syntax.ParenExpr)
 395                         if p == nil {
 396                                 break
 397                         }
 398                         x = p.X
 399                 }
 400         }
 401 }
 402
 403 func (check *Checker) recordInferred(call syntax.Expr, targs []Type, sig *Signature) {
 404         assert(call != nil)
 405         assert(sig != nil)
 406         if m := check.Inferred; m != nil {
 407                 m[call] = Inferred{targs, sig}
 408         }
 409 }
 410
 411 func (check *Checker) recordDef(id *syntax.Name, obj Object) {
 412         assert(id != nil)
 413         if m := check.Defs; m != nil {
 414                 m[id] = obj
 415         }
 416 }
 417
 418 func (check *Checker) recordUse(id *syntax.Name, obj Object) {
 419         assert(id != nil)
 420         assert(obj != nil)
 421         if m := check.Uses; m != nil {
 422                 m[id] = obj
 423         }
 424 }
 425
 426 func (check *Checker) recordImplicit(node syntax.Node, obj Object) {
 427         assert(node != nil)
 428         assert(obj != nil)
 429         if m := check.Implicits; m != nil {
 430                 m[node] = obj
 431         }
 432 }
 433
 434 func (check *Checker) recordSelection(x *syntax.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
 435         assert(obj != nil && (recv == nil || len(index) > 0))
 436         check.recordUse(x.Sel, obj)
 437         if m := check.Selections; m != nil {
 438                 m[x] = &Selection{kind, recv, obj, index, indirect}
 439         }
 440 }
 441
 442 func (check *Checker) recordScope(node syntax.Node, scope *Scope) {
 443         assert(node != nil)
 444         assert(scope != nil)
 445         if m := check.Scopes; m != nil {
 446                 m[node] = scope
 447         }
 448 }