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

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
13
import uvm.ir.textoutput.DebugBundleSerializer
Kunshan Wang's avatar
Kunshan Wang committed
14
import uvm.refimpl.bootimg.BootImageBuilder
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
Kunshan Wang's avatar
Kunshan Wang committed
25
import uvm.refimpl.bootimg.PrimordialInfo
Kunshan Wang's avatar
Kunshan Wang committed
26 27
import com.typesafe.scalalogging.Logger
import org.slf4j.LoggerFactory
28
import uvm.refimpl.cmdline.NativeArgv
29 30

object MicroVM {
Kunshan Wang's avatar
Kunshan Wang committed
31 32
  val logger = Logger(LoggerFactory.getLogger(getClass.getName))

33 34
  val DEFAULT_SOS_SIZE: Word = 2L * 1024L * 1024L; // 2MiB
  val DEFAULT_LOS_SIZE: Word = 2L * 1024L * 1024L; // 2MiB
35 36
  val DEFAULT_GLOBAL_SIZE: Word = 1L * 1024L * 1024L; // 1MiB
  val DEFAULT_STACK_SIZE: Word = 63L * 1024L; // 60KiB per stack
37 38

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

43
  def apply(confStr: String): MicroVM = {
44
    val vmConf = VMConf(confStr)
45
    MicroVM(vmConf)
Kunshan Wang's avatar
Kunshan Wang committed
46 47
  }

Kunshan Wang's avatar
Kunshan Wang committed
48
  def apply(confStr: String, allArgs: Seq[String]): MicroVM = {
Kunshan Wang's avatar
Kunshan Wang committed
49
    val vmConf = VMConf(confStr)
Kunshan Wang's avatar
Kunshan Wang committed
50
    MicroVM(vmConf, allArgs)
Kunshan Wang's avatar
Kunshan Wang committed
51 52 53 54 55 56
  }
  
  def apply(vmConf: VMConf): MicroVM = {
    new MicroVM(vmConf, None)
  }
  
Kunshan Wang's avatar
Kunshan Wang committed
57 58
  def apply(vmConf: VMConf, allArgs: Seq[String]): MicroVM = {
    new MicroVM(vmConf, Some(allArgs))
59 60
  }
}
Kunshan Wang's avatar
Kunshan Wang committed
61

62
class MicroVM private (val vmConf: VMConf, val allArgs: Option[Seq[String]]) extends IRBuilderListener with AutoCloseable {
63 64
  // implicitly injected resources
  private implicit val microVM = this
Kunshan Wang's avatar
Kunshan Wang committed
65 66
  
  val stats = new VMStats()
67

68 69
  val staticAnalyzer = new StaticAnalyzer()

70
  val globalBundle = new GlobalBundle()
71
  val constantPool = new ConstantPool()
Kunshan Wang's avatar
Kunshan Wang committed
72

73
  /// Initialise the global bundle and constant pool with (private) pre-loaded stuff
74
  {
Kunshan Wang's avatar
Kunshan Wang committed
75 76
    // 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.
77
    // So the GC must know about this type because the GC looks up the globalBundle for types.
Kunshan Wang's avatar
Kunshan Wang committed
78 79 80

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

81
    import staticAnalyzer.predefinedEntities._
Kunshan Wang's avatar
Kunshan Wang committed
82 83 84 85 86
    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
87

Kunshan Wang's avatar
Kunshan Wang committed
88 89 90 91
    for (c <- Seq(NULL_REF_VOID, NULL_IREF_VOID, NULL_FUNCREF_VV, NULL_THREADREF, NULL_STACKREF)) {
      globalBundle.constantNs.add(c)
      constantPool.addGlobalVar(c)
    }
92

93
    // Some types required by the RunMu class
94

95 96 97
    for (ty <- Seq(C_INT, C_CHAR, C_CHARP, C_CHARPP)) {
      globalBundle.typeNs.add(ty)
    }
98 99 100
    
    // Perform type inference on all preloaded s
    staticAnalyzer.typeInferer.inferBundle(globalBundle)
101 102
  }
  
103 104 105 106 107 108 109 110 111 112 113 114
  /**
   * A hack that allows general reference types to be accessed by pointers.
   * <p>
   * By default (true), memory locations of general reference types can only be accessed via iref.
   * This enforcement can be disabled as a workaround for the current mu-client-pypy project.
   */
  val enforceRefTypeNoPointerAccess = !vmConf.uPtrHack
  
  if (!enforceRefTypeNoPointerAccess) {
    MicroVM.logger.warn("Allowing memory locations of general reference types to be accessed by uptr.")
  }
  
115 116 117 118 119 120 121
  val memoryManager = new MemoryManager(vmConf)

  private implicit val memorySupport = memoryManager.memorySupport

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

  implicit val nativeCallHelper = new NativeCallHelper()
122 123
  
  var maybeNativeArgv: Option[NativeArgv] = None
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

  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 bootImageBuilder = new BootImageBuilder()
  
  /// Bundle building stuff
  
  def newIRBuilder(): IRBuilder = {
Kunshan Wang's avatar
Kunshan Wang committed
140
    val irBuilder = new IRBuilder(irBuilderRegistry.newID(), globalBundle, idFactory, Some(this))
141 142 143 144 145
    irBuilderRegistry.put(irBuilder)
    irBuilder
  }
  
  override def onBundleLoad(irBuilder: IRBuilder, bundle: TrantientBundle): Unit = {
Kunshan Wang's avatar
Kunshan Wang committed
146 147
    addBundle(bundle)
    irBuilderRegistry.remove(irBuilder)
148 149 150
  }
  
  override def onBundleAbort(irBuilder: IRBuilder): Unit = {
Kunshan Wang's avatar
Kunshan Wang committed
151
    irBuilderRegistry.remove(irBuilder)
152
  }
153 154 155 156

  /**
   * Add things from a bundle to the Micro VM.
   */
157
  def addBundle(bundle: TrantientBundle) {
158 159 160
    // Make sure all SSA variables have undergone type inference
    staticAnalyzer.typeInferer.inferBundle(bundle)

161 162 163 164 165
    if (vmConf.dumpBundle) {
      val dbs = new DebugBundleSerializer(bundle)
      dbs.writeUIR(new OutputStreamWriter(System.err))
    }

166
    if (vmConf.staticCheck) {
167
      staticAnalyzer.bundleChecker.checkBundle(bundle, Some(globalBundle))
168
    }
169

170 171 172 173 174
    globalBundle.merge(bundle);

    for (gc <- bundle.globalCellNs.all) {
      memoryManager.globalMemory.addGlobalCell(gc)
    }
175
    for (ef <- bundle.expFuncNs.all) {
176
      nativeCallHelper.exposeFuncStatic(ef)
177 178
    }
    // Must allocate the memory and expose the functions before making constants.
179 180 181 182
    for (g <- bundle.globalVarNs.all) {
      constantPool.addGlobalVar(g)
    }
  }
Kunshan Wang's avatar
Kunshan Wang committed
183 184

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

186
  /**
187
   * Create a new MuCtx. Part of the API.
188
   */
189 190 191 192 193 194 195 196 197
  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)
198
    contexts.add(ca)
Kunshan Wang's avatar
Kunshan Wang committed
199 200
    ca
  }
201 202 203
  /**
   * Given a name, get the ID of an identified entity.
   */
Kunshan Wang's avatar
Kunshan Wang committed
204
  def idOf(name: MuName): MuID = globalBundle.allNs(name).id
Kunshan Wang's avatar
Kunshan Wang committed
205

206 207 208
  /**
   * Given an ID, get the name of an identified entity.
   */
Kunshan Wang's avatar
Kunshan Wang committed
209
  def nameOf(id: MuID): MuName = globalBundle.allNs(id).name.get
Kunshan Wang's avatar
Kunshan Wang committed
210

211 212 213 214 215 216
  /**
   * Set the trap handler.
   */
  def setTrapHandler(trapHandler: TrapHandler): Unit = {
    trapManager.trapHandler = trapHandler
  }
Kunshan Wang's avatar
Kunshan Wang committed
217

Kunshan Wang's avatar
Kunshan Wang committed
218 219 220
  /**
   * Make boot image.
   */
Kunshan Wang's avatar
Kunshan Wang committed
221
  def makeBootImage(whiteList: Seq[MuID], outputFile: String): Unit = {
Kunshan Wang's avatar
Kunshan Wang committed
222
    val whiteListObjs = whiteList.map(globalBundle.topLevelNs.apply)
Kunshan Wang's avatar
Kunshan Wang committed
223

Kunshan Wang's avatar
Kunshan Wang committed
224
    bootImageBuilder.makeBootImage(whiteListObjs, PrimordialInfo.NO_PRIMORDIAL, Seq(), Seq(), outputFile)
Kunshan Wang's avatar
Kunshan Wang committed
225
  }
Kunshan Wang's avatar
Kunshan Wang committed
226

Kunshan Wang's avatar
Kunshan Wang committed
227
  /**
228
   * Print the global bundle to the writer w.
Kunshan Wang's avatar
Kunshan Wang committed
229 230
   */
  def debugPrintGlobalBundle(w: Writer): Unit = {
Kunshan Wang's avatar
Kunshan Wang committed
231
    val bs = new BundleSerializer(globalBundle, globalBundle.allTopLevels().toSet)
Kunshan Wang's avatar
Kunshan Wang committed
232 233
    bs.writeUIR(w)
  }
234 235 236 237 238 239 240 241

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

242 243 244 245
  /**
   * Load from a boot image.
   */
  def loadBootImage(file: String): Unit = {
Kunshan Wang's avatar
Kunshan Wang committed
246
    tryWithResource(new BootImageLoader(file, allArgs)) { bil =>
247 248
      bil.load()
    }
249
  }
250

Kunshan Wang's avatar
Kunshan Wang committed
251 252 253 254 255
  /**
   * Execute. This is the external pusher of the execution.
   */
  def execute(): Unit = {
    threadStackManager.execute()
Kunshan Wang's avatar
Kunshan Wang committed
256 257
    
    MicroVM.logger.info("Execution statistics:")
258
    MicroVM.logger.info(stats.getStatsString(0))
Kunshan Wang's avatar
Kunshan Wang committed
259
  }
260 261 262 263 264 265 266

  // Automatically load the boot image if provided
  {
    vmConf.bootImg foreach { fileName =>
      loadBootImage(fileName)
    }
  }
267 268 269 270 271 272 273
  
  override def close(): Unit = {
    maybeNativeArgv.foreach(_.close())
    threadStackManager.close()
    nativeLibraryHolder.close()
    memoryManager.close()
  }
274
}