MicroVM.scala 6.39 KB
Newer Older
1 2
package uvm.refimpl

Kunshan Wang's avatar
Kunshan Wang committed
3
import java.io.OutputStreamWriter
Kunshan Wang's avatar
Kunshan Wang committed
4 5
import java.io.Writer

Kunshan Wang's avatar
Kunshan Wang committed
6 7
import scala.collection.mutable.HashSet

8
import uvm._
Kunshan Wang's avatar
Kunshan Wang committed
9
import uvm.ir.irbuilder.IRBuilder
10
import uvm.ir.irbuilder.IRBuilderListener
Kunshan Wang's avatar
Kunshan Wang committed
11
import uvm.ir.textinput.UIRTextReader
Kunshan Wang's avatar
Kunshan Wang committed
12
import uvm.ir.textoutput.BundleSerializer
Kunshan Wang's avatar
Kunshan Wang committed
13
import uvm.ir.textoutput.DebugBundleSerializer
Kunshan Wang's avatar
Kunshan Wang committed
14
import uvm.refimpl.bootimg.BootImageBuilder
Kunshan Wang's avatar
Kunshan Wang committed
15
import uvm.refimpl.bootimg.BootImageLoader
Kunshan Wang's avatar
Kunshan Wang committed
16
import uvm.refimpl.hail.HailScriptLoader
17
import uvm.refimpl.integerize.IDObjectKeeper
18 19
import uvm.refimpl.itpr._
import uvm.refimpl.mem._
Kunshan Wang's avatar
Kunshan Wang committed
20
import uvm.refimpl.nat.NativeCallHelper
Kunshan Wang's avatar
Kunshan Wang committed
21
import uvm.refimpl.nat.NativeLibraryHolder
22
import uvm.staticanalysis.StaticAnalyzer
23
import uvm.utils.IDFactory
24
import uvm.utils.WithUtils.tryWithResource
25 26

object MicroVM {
27 28
  val DEFAULT_SOS_SIZE: Word = 2L * 1024L * 1024L; // 2MiB
  val DEFAULT_LOS_SIZE: Word = 2L * 1024L * 1024L; // 2MiB
29 30
  val DEFAULT_GLOBAL_SIZE: Word = 1L * 1024L * 1024L; // 1MiB
  val DEFAULT_STACK_SIZE: Word = 63L * 1024L; // 60KiB per stack
31 32

  def apply(): MicroVM = {
Kunshan Wang's avatar
Kunshan Wang committed
33 34
    val vmConf = new VMConf()
    new MicroVM(vmConf)
35
  }
Kunshan Wang's avatar
Kunshan Wang committed
36

37
  def apply(confStr: String): MicroVM = {
Kunshan Wang's avatar
Kunshan Wang committed
38 39
    val vmConf = VMConf(confStr)
    new MicroVM(vmConf)
40 41
  }
}
Kunshan Wang's avatar
Kunshan Wang committed
42

43
class MicroVM(val vmConf: VMConf) extends IRBuilderListener {
44 45
  // implicitly injected resources
  private implicit val microVM = this
46

47
  val globalBundle = new GlobalBundle()
48
  val constantPool = new ConstantPool()
Kunshan Wang's avatar
Kunshan Wang committed
49

50
  /// Initialise the global bundle and constant pool with (private) pre-loaded stuff
51
  {
Kunshan Wang's avatar
Kunshan Wang committed
52 53
    // VOID, BYTE, BYTE_ARRAY: The micro VM allocates stacks on the heap in the large object space.
    // It is represented as a big chunk of byte array.
54
    // So the GC must know about this type because the GC looks up the globalBundle for types.
Kunshan Wang's avatar
Kunshan Wang committed
55 56 57 58 59 60 61 62 63

    // BYTES, BYTES_R, REFS, REFS_R: Types for the @uvm.meta.* common instructions.

    import InternalTypes._
    for (ty <- Seq(VOID, BYTE, BYTE_ARRAY, BYTES, BYTES_R, REFS, REFS_R)) {
      globalBundle.typeNs.add(ty)
    }

    // Some internal constants needed by the HAIL loader
64

Kunshan Wang's avatar
Kunshan Wang committed
65 66 67 68
    for (c <- Seq(NULL_REF_VOID, NULL_IREF_VOID, NULL_FUNCREF_VV, NULL_THREADREF, NULL_STACKREF)) {
      globalBundle.constantNs.add(c)
      constantPool.addGlobalVar(c)
    }
69

70
    // Some types required by the RunMu class
71

72 73 74
    for (ty <- Seq(C_INT, C_CHAR, C_CHARP, C_CHARPP)) {
      globalBundle.typeNs.add(ty)
    }
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
  }
  
  val memoryManager = new MemoryManager(vmConf)

  private implicit val memorySupport = memoryManager.memorySupport

  val nativeLibraryHolder = NativeLibraryHolder(vmConf.extraLibs: _*)

  implicit val nativeCallHelper = new NativeCallHelper()

  val threadStackManager = new ThreadStackManager()

  val trapManager = new TrapManager()
  val contexts = new HashSet[MuCtx]()

  val idFactory = IDFactory.newClientIDFactory()
  val irBuilderRegistry = new IDObjectKeeper[IRBuilder]("IR builder")
  val irReader = new UIRTextReader(idFactory, recordSourceInfo = vmConf.sourceInfo)
  val hailScriptLoader = new HailScriptLoader(recordSourceInfo = vmConf.sourceInfo)
  val staticAnalyzer = new StaticAnalyzer()

  val bootImageBuilder = new BootImageBuilder()
  
  /// Bundle building stuff
  
  def newIRBuilder(): IRBuilder = {
    val irBuilder = new IRBuilder(irBuilderRegistry.getID(), globalBundle, idFactory, Some(this))
    irBuilderRegistry.put(irBuilder)
    irBuilder
  }
  
  override def onBundleLoad(irBuilder: IRBuilder, bundle: TrantientBundle): Unit = {
    
  }
  
  override def onBundleAbort(irBuilder: IRBuilder): Unit = {
111
    
112
  }
113 114 115 116

  /**
   * Add things from a bundle to the Micro VM.
   */
117
  def addBundle(bundle: TrantientBundle) {
118 119 120 121 122
    if (vmConf.dumpBundle) {
      val dbs = new DebugBundleSerializer(bundle)
      dbs.writeUIR(new OutputStreamWriter(System.err))
    }

123 124 125
    if (vmConf.staticCheck) {
      staticAnalyzer.checkBundle(bundle, Some(globalBundle))
    }
126

127 128 129 130 131
    globalBundle.merge(bundle);

    for (gc <- bundle.globalCellNs.all) {
      memoryManager.globalMemory.addGlobalCell(gc)
    }
132
    for (ef <- bundle.expFuncNs.all) {
133
      nativeCallHelper.exposeFuncStatic(ef)
134 135
    }
    // Must allocate the memory and expose the functions before making constants.
136 137 138 139
    for (g <- bundle.globalVarNs.all) {
      constantPool.addGlobalVar(g)
    }
  }
Kunshan Wang's avatar
Kunshan Wang committed
140 141

  private val contextIDFactory = IDFactory.newOneBasedIDFactory()
Kunshan Wang's avatar
Kunshan Wang committed
142

143
  /**
Kunshan Wang's avatar
Kunshan Wang committed
144
   * Create a new MuCtx. Part of the API.
145
   */
146 147 148 149 150 151 152 153 154
  def newContext(): MuCtx = newContext("user")

  /**
   * Create a new MuCtx. Extended to add a name for debugging.
   */
  def newContext(name: String): MuCtx = {
    val id = contextIDFactory.getID()
    val mutator = microVM.memoryManager.heap.makeMutator("MuCtx-%d-%s".format(id, name)) // This may trigger GC
    val ca = new MuCtx(id, mutator)
Kunshan Wang's avatar
Kunshan Wang committed
155
    contexts.add(ca)
Kunshan Wang's avatar
Kunshan Wang committed
156 157
    ca
  }
158 159 160
  /**
   * Given a name, get the ID of an identified entity.
   */
Kunshan Wang's avatar
Kunshan Wang committed
161
  def idOf(name: MuName): MuID = globalBundle.allNs(name).id
Kunshan Wang's avatar
Kunshan Wang committed
162

163 164 165
  /**
   * Given an ID, get the name of an identified entity.
   */
Kunshan Wang's avatar
Kunshan Wang committed
166
  def nameOf(id: MuID): MuName = globalBundle.allNs(id).name.get
Kunshan Wang's avatar
Kunshan Wang committed
167

Kunshan Wang's avatar
Kunshan Wang committed
168 169 170 171 172 173
  /**
   * Set the trap handler.
   */
  def setTrapHandler(trapHandler: TrapHandler): Unit = {
    trapManager.trapHandler = trapHandler
  }
Kunshan Wang's avatar
Kunshan Wang committed
174

Kunshan Wang's avatar
Kunshan Wang committed
175 176 177
  /**
   * Make boot image.
   */
Kunshan Wang's avatar
Kunshan Wang committed
178
  def makeBootImage(whiteList: Seq[MuID], outputFile: String): Unit = {
179 180 181 182 183
    val whiteListObjs = whiteList.map { id =>
      val obj = globalBundle.allNs(id)
      obj match {
        case tl: TopLevel => tl
        case _ => throw new UvmRuntimeException(
Kunshan Wang's avatar
Kunshan Wang committed
184 185
          "White list may only contain top-level definitions. Entity ID %d%s is a %s".format(
            obj.id, obj.name.map(n => s" (${n})").getOrElse(""), obj.getClass.getName))
186 187
      }
    }
Kunshan Wang's avatar
Kunshan Wang committed
188

189
    bootImageBuilder.makeBootImage(whiteListObjs, outputFile)
Kunshan Wang's avatar
Kunshan Wang committed
190
  }
Kunshan Wang's avatar
Kunshan Wang committed
191

Kunshan Wang's avatar
Kunshan Wang committed
192
  /**
Kunshan Wang's avatar
Kunshan Wang committed
193
   * Print the global bundle to the writer w.
Kunshan Wang's avatar
Kunshan Wang committed
194 195
   */
  def debugPrintGlobalBundle(w: Writer): Unit = {
Kunshan Wang's avatar
Kunshan Wang committed
196
    val bs = new BundleSerializer(globalBundle, globalBundle.allTopLevels().toSet)
Kunshan Wang's avatar
Kunshan Wang committed
197 198
    bs.writeUIR(w)
  }
Kunshan Wang's avatar
Kunshan Wang committed
199 200 201 202 203 204 205 206

  /**
   * Print the global bundle to stderr.
   */
  def debugPrintGlobalBundle(): Unit = {
    debugPrintGlobalBundle(new OutputStreamWriter(System.err))
  }

Kunshan Wang's avatar
Kunshan Wang committed
207 208 209 210
  /**
   * Load from a boot image.
   */
  def loadBootImage(file: String): Unit = {
211 212 213
    tryWithResource(new BootImageLoader(file)) { bil =>
      bil.load()
    }
Kunshan Wang's avatar
Kunshan Wang committed
214
  }
Kunshan Wang's avatar
Kunshan Wang committed
215

Kunshan Wang's avatar
Kunshan Wang committed
216 217 218 219 220 221
  /**
   * Execute. This is the external pusher of the execution.
   */
  def execute(): Unit = {
    threadStackManager.execute()
  }
Kunshan Wang's avatar
Kunshan Wang committed
222 223 224 225 226 227 228

  // Automatically load the boot image if provided
  {
    vmConf.bootImg foreach { fileName =>
      loadBootImage(fileName)
    }
  }
229
}