src/cmd/compile/internal/noder/unified.go

   1 // UNREVIEWED
   2
   3 // Copyright 2021 The Go Authors. All rights reserved.
   4 // Use of this source code is governed by a BSD-style
   5 // license that can be found in the LICENSE file.
   6
   7 package noder
   8
   9 import (
  10         "bytes"
  11         "fmt"
  12         "internal/goversion"
  13         "internal/pkgbits"
  14         "io"
  15         "runtime"
  16         "sort"
  17
  18         "cmd/compile/internal/base"
  19         "cmd/compile/internal/importer"
  20         "cmd/compile/internal/inline"
  21         "cmd/compile/internal/ir"
  22         "cmd/compile/internal/typecheck"
  23         "cmd/compile/internal/types"
  24         "cmd/compile/internal/types2"
  25         "cmd/internal/src"
  26 )
  27
  28 // localPkgReader holds the package reader used for reading the local
  29 // package. It exists so the unified IR linker can refer back to it
  30 // later.
  31 var localPkgReader *pkgReader
  32
  33 // unified construct the local package's IR from syntax's AST.
  34 //
  35 // The pipeline contains 2 steps:
  36 //
  37 // (1) Generate package export data "stub".
  38 //
  39 // (2) Generate package IR from package export data.
  40 //
  41 // The package data "stub" at step (1) contains everything from the local package,
  42 // but nothing that have been imported. When we're actually writing out export data
  43 // to the output files (see writeNewExport function), we run the "linker", which does
  44 // a few things:
  45 //
  46 // + Updates compiler extensions data (e.g., inlining cost, escape analysis results).
  47 //
  48 // + Handles re-exporting any transitive dependencies.
  49 //
  50 // + Prunes out any unnecessary details (e.g., non-inlineable functions, because any
  51 //   downstream importers only care about inlinable functions).
  52 //
  53 // The source files are typechecked twice, once before writing export data
  54 // using types2 checker, once after read export data using gc/typecheck.
  55 // This duplication of work will go away once we always use types2 checker,
  56 // we can remove the gc/typecheck pass. The reason it is still here:
  57 //
  58 // + It reduces engineering costs in maintaining a fork of typecheck
  59 //   (e.g., no need to backport fixes like CL 327651).
  60 //
  61 // + It makes it easier to pass toolstash -cmp.
  62 //
  63 // + Historically, we would always re-run the typechecker after import, even though
  64 //   we know the imported data is valid. It's not ideal, but also not causing any
  65 //   problem either.
  66 //
  67 // + There's still transformation that being done during gc/typecheck, like rewriting
  68 //   multi-valued function call, or transform ir.OINDEX -> ir.OINDEXMAP.
  69 //
  70 // Using syntax+types2 tree, which already has a complete representation of generics,
  71 // the unified IR has the full typed AST for doing introspection during step (1).
  72 // In other words, we have all necessary information to build the generic IR form
  73 // (see writer.captureVars for an example).
  74 func unified(noders []*noder) {
  75         inline.NewInline = InlineCall
  76
  77         writeNewExportFunc = writeNewExport
  78
  79         newReadImportFunc = func(data string, pkg1 *types.Pkg, ctxt *types2.Context, packages map[string]*types2.Package) (pkg2 *types2.Package, err error) {
  80                 pr := pkgbits.NewPkgDecoder(pkg1.Path, data)
  81
  82                 // Read package descriptors for both types2 and compiler backend.
  83                 readPackage(newPkgReader(pr), pkg1)
  84                 pkg2 = importer.ReadPackage(ctxt, packages, pr)
  85                 return
  86         }
  87
  88         data := writePkgStub(noders)
  89
  90         // We already passed base.Flag.Lang to types2 to handle validating
  91         // the user's source code. Bump it up now to the current version and
  92         // re-parse, so typecheck doesn't complain if we construct IR that
  93         // utilizes newer Go features.
  94         base.Flag.Lang = fmt.Sprintf("go1.%d", goversion.Version)
  95         types.ParseLangFlag()
  96
  97         assert(types.LocalPkg.Path == "")
  98         types.LocalPkg.Height = 0 // reset so pkgReader.pkgIdx doesn't complain
  99         target := typecheck.Target
 100
 101         typecheck.TypecheckAllowed = true
 102
 103         localPkgReader = newPkgReader(pkgbits.NewPkgDecoder(types.LocalPkg.Path, data))
 104         readPackage(localPkgReader, types.LocalPkg)
 105
 106         r := localPkgReader.newReader(pkgbits.RelocMeta, pkgbits.PrivateRootIdx, pkgbits.SyncPrivate)
 107         r.pkgInit(types.LocalPkg, target)
 108
 109         // Type-check any top-level assignments. We ignore non-assignments
 110         // here because other declarations are typechecked as they're
 111         // constructed.
 112         for i, ndecls := 0, len(target.Decls); i < ndecls; i++ {
 113                 switch n := target.Decls[i]; n.Op() {
 114                 case ir.OAS, ir.OAS2:
 115                         target.Decls[i] = typecheck.Stmt(n)
 116                 }
 117         }
 118
 119         // Don't use range--bodyIdx can add closures to todoBodies.
 120         for len(todoBodies) > 0 {
 121                 // The order we expand bodies doesn't matter, so pop from the end
 122                 // to reduce todoBodies reallocations if it grows further.
 123                 fn := todoBodies[len(todoBodies)-1]
 124                 todoBodies = todoBodies[:len(todoBodies)-1]
 125
 126                 pri, ok := bodyReader[fn]
 127                 assert(ok)
 128                 pri.funcBody(fn)
 129
 130                 // Instantiated generic function: add to Decls for typechecking
 131                 // and compilation.
 132                 if fn.OClosure == nil && len(pri.dict.targs) != 0 {
 133                         target.Decls = append(target.Decls, fn)
 134                 }
 135         }
 136         todoBodies = nil
 137         todoBodiesDone = true
 138
 139         // Check that nothing snuck past typechecking.
 140         for _, n := range target.Decls {
 141                 if n.Typecheck() == 0 {
 142                         base.FatalfAt(n.Pos(), "missed typecheck: %v", n)
 143                 }
 144
 145                 // For functions, check that at least their first statement (if
 146                 // any) was typechecked too.
 147                 if fn, ok := n.(*ir.Func); ok && len(fn.Body) != 0 {
 148                         if stmt := fn.Body[0]; stmt.Typecheck() == 0 {
 149                                 base.FatalfAt(stmt.Pos(), "missed typecheck: %v", stmt)
 150                         }
 151                 }
 152         }
 153
 154         base.ExitIfErrors() // just in case
 155 }
 156
 157 // writePkgStub type checks the given parsed source files,
 158 // writes an export data package stub representing them,
 159 // and returns the result.
 160 func writePkgStub(noders []*noder) string {
 161         m, pkg, info := checkFiles(noders)
 162
 163         pw := newPkgWriter(m, pkg, info)
 164
 165         pw.collectDecls(noders)
 166
 167         publicRootWriter := pw.newWriter(pkgbits.RelocMeta, pkgbits.SyncPublic)
 168         privateRootWriter := pw.newWriter(pkgbits.RelocMeta, pkgbits.SyncPrivate)
 169
 170         assert(publicRootWriter.Idx == pkgbits.PublicRootIdx)
 171         assert(privateRootWriter.Idx == pkgbits.PrivateRootIdx)
 172
 173         {
 174                 w := publicRootWriter
 175                 w.pkg(pkg)
 176                 w.Bool(false) // has init; XXX
 177
 178                 scope := pkg.Scope()
 179                 names := scope.Names()
 180                 w.Len(len(names))
 181                 for _, name := range scope.Names() {
 182                         w.obj(scope.Lookup(name), nil)
 183                 }
 184
 185                 w.Sync(pkgbits.SyncEOF)
 186                 w.Flush()
 187         }
 188
 189         {
 190                 w := privateRootWriter
 191                 w.pkgInit(noders)
 192                 w.Flush()
 193         }
 194
 195         var sb bytes.Buffer // TODO(mdempsky): strings.Builder after #44505 is resolved
 196         pw.DumpTo(&sb)
 197
 198         // At this point, we're done with types2. Make sure the package is
 199         // garbage collected.
 200         freePackage(pkg)
 201
 202         return sb.String()
 203 }
 204
 205 // freePackage ensures the given package is garbage collected.
 206 func freePackage(pkg *types2.Package) {
 207         // The GC test below relies on a precise GC that runs finalizers as
 208         // soon as objects are unreachable. Our implementation provides
 209         // this, but other/older implementations may not (e.g., Go 1.4 does
 210         // not because of #22350). To avoid imposing unnecessary
 211         // restrictions on the GOROOT_BOOTSTRAP toolchain, we skip the test
 212         // during bootstrapping.
 213         if base.CompilerBootstrap {
 214                 return
 215         }
 216
 217         // Set a finalizer on pkg so we can detect if/when it's collected.
 218         done := make(chan struct{})
 219         runtime.SetFinalizer(pkg, func(*types2.Package) { close(done) })
 220
 221         // Important: objects involved in cycles are not finalized, so zero
 222         // out pkg to break its cycles and allow the finalizer to run.
 223         *pkg = types2.Package{}
 224
 225         // It typically takes just 1 or 2 cycles to release pkg, but it
 226         // doesn't hurt to try a few more times.
 227         for i := 0; i < 10; i++ {
 228                 select {
 229                 case <-done:
 230                         return
 231                 default:
 232                         runtime.GC()
 233                 }
 234         }
 235
 236         base.Fatalf("package never finalized")
 237 }
 238
 239 func readPackage(pr *pkgReader, importpkg *types.Pkg) {
 240         r := pr.newReader(pkgbits.RelocMeta, pkgbits.PublicRootIdx, pkgbits.SyncPublic)
 241
 242         pkg := r.pkg()
 243         assert(pkg == importpkg)
 244
 245         if r.Bool() {
 246                 sym := pkg.Lookup(".inittask")
 247                 task := ir.NewNameAt(src.NoXPos, sym)
 248                 task.Class = ir.PEXTERN
 249                 sym.Def = task
 250         }
 251
 252         for i, n := 0, r.Len(); i < n; i++ {
 253                 r.Sync(pkgbits.SyncObject)
 254                 assert(!r.Bool())
 255                 idx := r.Reloc(pkgbits.RelocObj)
 256                 assert(r.Len() == 0)
 257
 258                 path, name, code := r.p.PeekObj(idx)
 259                 if code != pkgbits.ObjStub {
 260                         objReader[types.NewPkg(path, "").Lookup(name)] = pkgReaderIndex{pr, idx, nil}
 261                 }
 262         }
 263 }
 264
 265 func writeNewExport(out io.Writer) {
 266         l := linker{
 267                 pw: pkgbits.NewPkgEncoder(base.Debug.SyncFrames),
 268
 269                 pkgs:  make(map[string]int),
 270                 decls: make(map[*types.Sym]int),
 271         }
 272
 273         publicRootWriter := l.pw.NewEncoder(pkgbits.RelocMeta, pkgbits.SyncPublic)
 274         assert(publicRootWriter.Idx == pkgbits.PublicRootIdx)
 275
 276         var selfPkgIdx int
 277
 278         {
 279                 pr := localPkgReader
 280                 r := pr.NewDecoder(pkgbits.RelocMeta, pkgbits.PublicRootIdx, pkgbits.SyncPublic)
 281
 282                 r.Sync(pkgbits.SyncPkg)
 283                 selfPkgIdx = l.relocIdx(pr, pkgbits.RelocPkg, r.Reloc(pkgbits.RelocPkg))
 284
 285                 r.Bool() // has init
 286
 287                 for i, n := 0, r.Len(); i < n; i++ {
 288                         r.Sync(pkgbits.SyncObject)
 289                         assert(!r.Bool())
 290                         idx := r.Reloc(pkgbits.RelocObj)
 291                         assert(r.Len() == 0)
 292
 293                         xpath, xname, xtag := pr.PeekObj(idx)
 294                         assert(xpath == pr.PkgPath())
 295                         assert(xtag != pkgbits.ObjStub)
 296
 297                         if types.IsExported(xname) {
 298                                 l.relocIdx(pr, pkgbits.RelocObj, idx)
 299                         }
 300                 }
 301
 302                 r.Sync(pkgbits.SyncEOF)
 303         }
 304
 305         {
 306                 var idxs []int
 307                 for _, idx := range l.decls {
 308                         idxs = append(idxs, idx)
 309                 }
 310                 sort.Ints(idxs)
 311
 312                 w := publicRootWriter
 313
 314                 w.Sync(pkgbits.SyncPkg)
 315                 w.Reloc(pkgbits.RelocPkg, selfPkgIdx)
 316
 317                 w.Bool(typecheck.Lookup(".inittask").Def != nil)
 318
 319                 w.Len(len(idxs))
 320                 for _, idx := range idxs {
 321                         w.Sync(pkgbits.SyncObject)
 322                         w.Bool(false)
 323                         w.Reloc(pkgbits.RelocObj, idx)
 324                         w.Len(0)
 325                 }
 326
 327                 w.Sync(pkgbits.SyncEOF)
 328                 w.Flush()
 329         }
 330
 331         l.pw.DumpTo(out)
 332 }