ssavariables.scala 10.6 KB
Newer Older
1 2 3 4 5 6
package uvm.ssavariables

import uvm._
import uvm.comminsts._
import uvm.types._

7 8
abstract class SSAVariable extends IdentifiedSettable {
  override def hashCode(): Int = id
9 10
  override def equals(that: Any): Boolean = that match {
    case v: AnyRef => this eq v
11
    case _         => false
12
  }
13
}
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

// Global variables: Constants, Global Cells and Functions (Function is defined in controlFlow.scala)

abstract class GlobalVariable extends SSAVariable

abstract class Constant extends GlobalVariable {
  var constTy: Type
}

case class ConstInt(var constTy: Type, var num: BigInt) extends Constant

case class ConstFloat(var constTy: Type, var num: Float) extends Constant

case class ConstDouble(var constTy: Type, var num: Double) extends Constant

case class ConstStruct(var constTy: Type, var fields: Seq[GlobalVariable]) extends Constant

case class ConstNull(var constTy: Type) extends Constant

Kunshan Wang's avatar
Kunshan Wang committed
33 34
case class ConstVector(var constTy: Type, var elems: Seq[Constant]) extends Constant

35 36
case class ConstPointer(var constTy: Type, var addr: Long) extends Constant

37 38
case class GlobalCell(var cellTy: Type) extends GlobalVariable

39 40 41 42
case class ExposedFunc(var func: Function, var callConv: Flag, var cookie: ConstInt) extends GlobalVariable {
  /** This value will be supplied when the function is actually exposed. */
  var addr: Long = 0L
}
43

44 45
// Local variables: Parameters and Instructions

Kunshan Wang's avatar
Kunshan Wang committed
46
abstract class LocalVariable extends SSAVariable
47

Kunshan Wang's avatar
Kunshan Wang committed
48
case class Parameter(var funcVer: FuncVer, var index: Int) extends LocalVariable
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

// Instructions

abstract class Instruction extends LocalVariable

/// enumerations

object BinOptr extends Enumeration {
  type BinOptr = Value
  val ADD, SUB, MUL, UDIV, SDIV, UREM, SREM, SHL, LSHR, ASHR, AND, OR, XOR = Value
  val FADD, FSUB, FMUL, FDIV, FREM = Value
}

import uvm.ssavariables.BinOptr.BinOptr

object CmpOptr extends Enumeration {
  type CmpOptr = Value
  val EQ, NE, ULT, ULE, UGT, UGE, SLT, SLE, SGT, SGE = Value
  val FTRUE, FFALSE, FORD, FOEQ, FONE, FOLT, FOLE, FOGT, FOGE = Value
  val FUNO, FUEQ, FUNE, FULT, FULE, FUGT, FUGE = Value
}

import uvm.ssavariables.CmpOptr.CmpOptr

object ConvOptr extends Enumeration {
  type ConvOptr = Value
75
  val TRUNC, ZEXT, SEXT, FPTRUNC, FPEXT, FPTOUI, FPTOSI, UITOFP, SITOFP, BITCAST, REFCAST, PTRCAST = Value
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 111 112 113 114 115
}

import uvm.ssavariables.ConvOptr.ConvOptr

object MemoryOrder extends Enumeration {
  type MemoryOrder = Value
  val NOT_ATOMIC, RELAXED, CONSUME, ACQUIRE, RELEASE, ACQ_REL, SEQ_CST = Value
}

import uvm.ssavariables.MemoryOrder.MemoryOrder

object AtomicRMWOptr extends Enumeration {
  type AtomicRMWOptr = Value
  val XCHG, ADD, SUB, AND, NAND, OR, XOR, MIN, MAX, UMIN, UMAX = Value
}

import uvm.ssavariables.AtomicRMWOptr.AtomicRMWOptr

/// Abstract instructions and traits

trait HasTypeList extends Instruction {
  var typeList: Seq[Type]
}

trait HasArgList extends Instruction {
  var argList: Seq[SSAVariable]
}

trait CallLike extends HasArgList {
  var sig: FuncSig
  var callee: SSAVariable
}

case class ExcClause(val nor: BasicBlock, val exc: BasicBlock)

trait HasExcClause extends Instruction {
  var excClause: Option[ExcClause]
}

trait HasKeepAliveClause extends Instruction {
Kunshan Wang's avatar
Kunshan Wang committed
116
  var keepAlives: Seq[LocalVariable]
117 118 119 120 121 122
}

abstract class AbstractCall extends CallLike

abstract class AbstractRet extends Instruction

Kunshan Wang's avatar
Kunshan Wang committed
123
abstract class AbstractAlloc extends HasExcClause {
124 125 126 127 128 129
  def allocTy: Type
}

trait FixedAlloc extends AbstractAlloc

trait HybridAlloc extends AbstractAlloc {
Kunshan Wang's avatar
Kunshan Wang committed
130
  def lenTy: TypeInt
131 132 133 134 135 136 137
  def length: SSAVariable
}

abstract class HeapAlloc extends AbstractAlloc

abstract class StackAlloc extends AbstractAlloc

138 139 140 141
trait WorksWithPointer extends Instruction {
  var ptr: Boolean
}

142 143 144 145 146 147 148 149 150
abstract class AbstractTrap extends HasKeepAliveClause {
  var retTy: Type
}

abstract class CurStackAction
case class RetWith(var retTy: Type) extends CurStackAction
case class KillOld() extends CurStackAction

abstract class NewStackAction
Kunshan Wang's avatar
Kunshan Wang committed
151 152
case class PassValue(var argTy: Type, var arg: SSAVariable) extends NewStackAction
case class PassVoid() extends NewStackAction
153 154
case class ThrowExc(var exc: SSAVariable) extends NewStackAction

155 156 157 158 159 160
/**
 * An EdgeAssigned instruction is evaluated at control flow edges rather than sequentially when the PC
 * reaches that instruction. Currently PHI and LANDINGPAD are the only two such instructions.
 */
trait EdgeAssigned extends Instruction

161 162 163 164 165
/**
 * Flags are used in common instructions.
 */
case class Flag(name: String)

166 167 168 169 170 171 172 173
/// Concrete instructions
case class InstBinOp(var op: BinOptr, var opndTy: Type, var op1: SSAVariable, var op2: SSAVariable,
                     var excClause: Option[ExcClause]) extends HasExcClause

case class InstCmp(var op: CmpOptr, var opndTy: Type, var op1: SSAVariable, var op2: SSAVariable) extends Instruction

case class InstConv(var op: ConvOptr, var fromTy: Type, var toTy: Type, var opnd: SSAVariable) extends Instruction

174
case class InstSelect(var condTy: Type, var opndTy: Type,
175 176 177 178 179 180 181 182 183
                      var cond: SSAVariable, var ifTrue: SSAVariable, var ifFalse: SSAVariable) extends Instruction

case class InstBranch(var dest: BasicBlock) extends Instruction

case class InstBranch2(var cond: SSAVariable, var ifTrue: BasicBlock, var ifFalse: BasicBlock) extends Instruction

case class InstSwitch(var opndTy: Type, var opnd: SSAVariable, var defDest: BasicBlock,
                      var cases: Seq[(SSAVariable, BasicBlock)]) extends Instruction

184
case class InstPhi(var opndTy: Type, var cases: Seq[(BasicBlock, SSAVariable)]) extends Instruction with EdgeAssigned
185 186

case class InstCall(var sig: FuncSig, var callee: SSAVariable, var argList: Seq[SSAVariable],
187
                    var excClause: Option[ExcClause], var keepAlives: Seq[LocalVariable]) extends AbstractCall with HasExcClause with HasKeepAliveClause
188 189 190 191 192 193 194 195 196

case class InstTailCall(var sig: FuncSig, var callee: SSAVariable, var argList: Seq[SSAVariable]) extends AbstractCall

case class InstRet(var retTy: Type, var retVal: SSAVariable) extends AbstractRet

case class InstRetVoid() extends AbstractRet

case class InstThrow(var excVal: SSAVariable) extends Instruction

197
case class InstLandingPad() extends Instruction with EdgeAssigned
198

Kunshan Wang's avatar
Kunshan Wang committed
199
case class InstExtractValue(var strTy: TypeStruct, var index: Int, var opnd: SSAVariable) extends Instruction
200

Kunshan Wang's avatar
Kunshan Wang committed
201
case class InstInsertValue(var strTy: TypeStruct, var index: Int, var opnd: SSAVariable, var newVal: SSAVariable) extends Instruction
202

Kunshan Wang's avatar
Kunshan Wang committed
203
case class InstExtractElement(var vecTy: TypeVector, var indTy: TypeInt,
204 205
                              var opnd: SSAVariable, var index: SSAVariable) extends Instruction

Kunshan Wang's avatar
Kunshan Wang committed
206
case class InstInsertElement(var vecTy: TypeVector, var indTy: TypeInt,
207 208
                             var opnd: SSAVariable, var index: SSAVariable, var newVal: SSAVariable) extends Instruction

Kunshan Wang's avatar
Kunshan Wang committed
209
case class InstShuffleVector(var vecTy: TypeVector, var maskTy: TypeVector,
210 211
                             var vec1: SSAVariable, var vec2: SSAVariable, var mask: SSAVariable) extends Instruction

Kunshan Wang's avatar
Kunshan Wang committed
212
case class InstNew(var allocTy: Type, var excClause: Option[ExcClause]) extends HeapAlloc with FixedAlloc
213

Kunshan Wang's avatar
Kunshan Wang committed
214
case class InstNewHybrid(var allocTy: TypeHybrid, var lenTy: TypeInt, var length: SSAVariable, var excClause: Option[ExcClause]) extends HeapAlloc with HybridAlloc
215

Kunshan Wang's avatar
Kunshan Wang committed
216
case class InstAlloca(var allocTy: Type, var excClause: Option[ExcClause]) extends StackAlloc with FixedAlloc
217

Kunshan Wang's avatar
Kunshan Wang committed
218
case class InstAllocaHybrid(var allocTy: TypeHybrid, var lenTy: TypeInt, var length: SSAVariable, var excClause: Option[ExcClause]) extends StackAlloc with HybridAlloc
219 220 221

case class InstGetIRef(var referentTy: Type, var opnd: SSAVariable) extends Instruction

222
case class InstGetFieldIRef(var ptr: Boolean, var referentTy: TypeStruct, var index: Int, var opnd: SSAVariable) extends WorksWithPointer
223

224 225
case class InstGetElemIRef(var ptr: Boolean, var referentTy: AbstractSeqType, var indTy: TypeInt,
                           var opnd: SSAVariable, var index: SSAVariable) extends WorksWithPointer
226

227 228
case class InstShiftIRef(var ptr: Boolean, var referentTy: Type, var offTy: TypeInt,
                         var opnd: SSAVariable, var offset: SSAVariable) extends WorksWithPointer
229

230
case class InstGetFixedPartIRef(var ptr: Boolean, var referentTy: TypeHybrid, var opnd: SSAVariable) extends WorksWithPointer
231

232
case class InstGetVarPartIRef(var ptr: Boolean, var referentTy: TypeHybrid, var opnd: SSAVariable) extends WorksWithPointer
233

234
case class InstLoad(var ptr: Boolean, var ord: MemoryOrder, var referentTy: Type, var loc: SSAVariable, var excClause: Option[ExcClause]) extends WorksWithPointer with HasExcClause
235

236
case class InstStore(var ptr: Boolean, var ord: MemoryOrder, var referentTy: Type, var loc: SSAVariable, var newVal: SSAVariable, var excClause: Option[ExcClause]) extends WorksWithPointer with HasExcClause
237

238 239
case class InstCmpXchg(var ptr: Boolean, var weak: Boolean, var ordSucc: MemoryOrder, var ordFail: MemoryOrder, var referentTy: Type,
                       var loc: SSAVariable, var expected: SSAVariable, var desired: SSAVariable, var excClause: Option[ExcClause]) extends WorksWithPointer with HasExcClause
240

241 242
case class InstAtomicRMW(var ptr: Boolean, var ord: MemoryOrder, var op: AtomicRMWOptr,
                         var referentTy: Type, var loc: SSAVariable, var opnd: SSAVariable, var excClause: Option[ExcClause]) extends WorksWithPointer with HasExcClause
Kunshan Wang's avatar
Kunshan Wang committed
243 244

case class InstFence(var ord: MemoryOrder) extends Instruction
245

246
case class InstTrap(var retTy: Type, var excClause: Option[ExcClause], var keepAlives: Seq[LocalVariable]) extends AbstractTrap with HasExcClause
247 248 249

case class InstWatchPoint(var wpID: Int, var retTy: Type,
                          var dis: BasicBlock, var ena: BasicBlock, var exc: Option[BasicBlock],
Kunshan Wang's avatar
Kunshan Wang committed
250
                          var keepAlives: Seq[LocalVariable]) extends AbstractTrap
251

252 253
case class InstCCall(var callConv: Flag, var funcTy: Type,
                     var sig: FuncSig, var callee: SSAVariable, var argList: Seq[SSAVariable], var keepAlives: Seq[LocalVariable]) extends CallLike with HasKeepAliveClause
254 255 256 257 258

case class InstNewStack(var sig: FuncSig, var callee: SSAVariable, var argList: Seq[SSAVariable],
                        var excClause: Option[ExcClause]) extends CallLike with HasExcClause

case class InstSwapStack(var swappee: SSAVariable, var curStackAction: CurStackAction, var newStackAction: NewStackAction,
Kunshan Wang's avatar
Kunshan Wang committed
259
                         var excClause: Option[ExcClause], var keepAlives: Seq[LocalVariable]) extends HasExcClause with HasKeepAliveClause
260

261
case class InstCommInst(var inst: CommInst, var flagList: Seq[Flag], var typeList: Seq[Type], var funcSigList: Seq[FuncSig], var argList: Seq[SSAVariable],
Kunshan Wang's avatar
Kunshan Wang committed
262
                        var excClause: Option[ExcClause], var keepAlives: Seq[LocalVariable])
263
    extends HasTypeList with HasArgList with HasExcClause with HasKeepAliveClause