1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
|
/* NSC -- new Scala compiler
* Copyright 2005-2013 LAMP/EPFL
* @author Martin Odersky
*/
package scala.tools.nsc
package backend
package icode
import scala.reflect.internal.util.{Position,NoPosition}
/*
A pattern match
// locals
case THIS(clasz) =>
case STORE_THIS(kind) =>
case LOAD_LOCAL(local) =>
case STORE_LOCAL(local) =>
case SCOPE_ENTER(lv) =>
case SCOPE_EXIT(lv) =>
// stack
case LOAD_MODULE(module) =>
case LOAD_EXCEPTION(clasz) =>
case DROP(kind) =>
case DUP(kind) =>
// constants
case CONSTANT(const) =>
// arithlogic
case CALL_PRIMITIVE(primitive) =>
// casts
case IS_INSTANCE(tpe) =>
case CHECK_CAST(tpe) =>
// objs
case NEW(kind) =>
case MONITOR_ENTER() =>
case MONITOR_EXIT() =>
case BOX(boxType) =>
case UNBOX(tpe) =>
// flds
case LOAD_FIELD(field, isStatic) =>
case STORE_FIELD(field, isStatic) =>
// mthds
case CALL_METHOD(method, style) =>
// arrays
case LOAD_ARRAY_ITEM(kind) =>
case STORE_ARRAY_ITEM(kind) =>
case CREATE_ARRAY(elem, dims) =>
// jumps
case SWITCH(tags, labels) =>
case JUMP(whereto) =>
case CJUMP(success, failure, cond, kind) =>
case CZJUMP(success, failure, cond, kind) =>
// ret
case RETURN(kind) =>
case THROW(clasz) =>
*/
/**
* The ICode intermediate representation. It is a stack-based
* representation, very close to the JVM and .NET. It uses the
* erased types of Scala and references Symbols to refer named entities
* in the source files.
*/
trait Opcodes { self: ICodes =>
import global.{Symbol, NoSymbol, Name, Constant};
// categories of ICode instructions
final val localsCat = 1
final val stackCat = 2
final val constCat = 3
final val arilogCat = 4
final val castsCat = 5
final val objsCat = 6
final val fldsCat = 7
final val mthdsCat = 8
final val arraysCat = 9
final val jumpsCat = 10
final val retCat = 11
private lazy val ObjectReferenceList = ObjectReference :: Nil
/** This class represents an instruction of the intermediate code.
* Each case subclass will represent a specific operation.
*/
abstract class Instruction extends Cloneable {
// Vlad: I used these for checking the quality of the implementation, and we should regularely run a build with them
// enabled. But for production these should definitely be disabled, unless we enjoy getting angry emails from Greg :)
//if (!this.isInstanceOf[opcodes.LOAD_EXCEPTION])
// assert(consumed == consumedTypes.length)
//assert(produced == producedTypes.length)
def category: Int = 0 // undefined
/** This abstract method returns the number of used elements on the stack */
def consumed : Int = 0
/** This abstract method returns the number of produced elements on the stack */
def produced : Int = 0
/** This instruction consumes these types from the top of the stack, the first
* element in the list is the deepest element on the stack.
*/
def consumedTypes: List[TypeKind] = Nil
/** This instruction produces these types on top of the stack. */
// Vlad: I wonder why we keep producedTypes around -- it looks like an useless thing to have
def producedTypes: List[TypeKind] = Nil
/** The corresponding position in the source file */
private var _pos: Position = NoPosition
def pos: Position = _pos
def setPos(p: Position): this.type = {
_pos = p
this
}
/** Clone this instruction. */
override def clone(): Instruction =
super.clone.asInstanceOf[Instruction]
}
object opcodes {
/** Loads "this" on top of the stack.
* Stack: ...
* ->: ...:ref
*/
case class THIS(clasz: Symbol) extends Instruction {
/** Returns a string representation of this constant */
override def toString = "THIS(" + clasz.name + ")"
override def consumed = 0
override def produced = 1
override def producedTypes =
// we're not allowed to have REFERENCE(Array), but what about compiling the Array class? Well, we use object for it.
if (clasz != global.definitions.ArrayClass)
REFERENCE(clasz) :: Nil
else
ObjectReference :: Nil
override def category = localsCat
}
/** Loads a constant on the stack.
* Stack: ...
* ->: ...:constant
*/
case class CONSTANT(constant: Constant) extends Instruction {
override def toString = "CONSTANT(" + constant.escapedStringValue + ")"
override def consumed = 0
override def produced = 1
override def producedTypes = toTypeKind(constant.tpe) :: Nil
override def category = constCat
}
/** Loads an element of an array. The array and the index should
* be on top of the stack.
* Stack: ...:array[a](Ref):index(Int)
* ->: ...:element(a)
*/
case class LOAD_ARRAY_ITEM(kind: TypeKind) extends Instruction {
override def consumed = 2
override def produced = 1
override def consumedTypes = ARRAY(kind) :: INT :: Nil
override def producedTypes = kind :: Nil
override def category = arraysCat
}
/** Load a local variable on the stack. It can be a method argument.
* Stack: ...
* ->: ...:value
*/
case class LOAD_LOCAL(local: Local) extends Instruction {
override def consumed = 0
override def produced = 1
override def producedTypes = local.kind :: Nil
override def category = localsCat
}
/** Load a field on the stack. The object to which it refers should be
* on the stack.
* Stack: ...:ref (assuming isStatic = false)
* ->: ...:value
*/
case class LOAD_FIELD(field: Symbol, isStatic: Boolean) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String =
"LOAD_FIELD " + (if (isStatic) field.fullName else field.toString());
override def consumed = if (isStatic) 0 else 1
override def produced = 1
override def consumedTypes = if (isStatic) Nil else REFERENCE(field.owner) :: Nil
override def producedTypes = toTypeKind(field.tpe) :: Nil
// more precise information about how to load this field
// see #4283
var hostClass: Symbol = field.owner
def setHostClass(cls: Symbol): this.type = { hostClass = cls; this }
override def category = fldsCat
}
case class LOAD_MODULE(module: Symbol) extends Instruction {
assert(module != NoSymbol, "Invalid module symbol")
/** Returns a string representation of this instruction */
override def toString(): String = "LOAD_MODULE " + module
override def consumed = 0
override def produced = 1
override def producedTypes = REFERENCE(module) :: Nil
override def category = stackCat
}
/** Store a value into an array at a specified index.
* Stack: ...:array[a](Ref):index(Int):value(a)
* ->: ...
*/
case class STORE_ARRAY_ITEM(kind: TypeKind) extends Instruction {
override def consumed = 3
override def produced = 0
override def consumedTypes = ARRAY(kind) :: INT :: kind :: Nil
override def category = arraysCat
}
/** Store a value into a local variable. It can be an argument.
* Stack: ...:value
* ->: ...
*/
case class STORE_LOCAL(local: Local) extends Instruction {
override def consumed = 1
override def produced = 0
override def consumedTypes = local.kind :: Nil
override def category = localsCat
}
/** Store a value into a field.
* Stack: ...:ref:value (assuming isStatic=false)
* ->: ...
*/
case class STORE_FIELD(field: Symbol, isStatic: Boolean) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String =
"STORE_FIELD "+field + (if (isStatic) " (static)" else " (dynamic)");
override def consumed = if(isStatic) 1 else 2;
override def produced = 0;
override def consumedTypes =
if (isStatic)
toTypeKind(field.tpe) :: Nil
else
REFERENCE(field.owner) :: toTypeKind(field.tpe) :: Nil;
override def category = fldsCat
}
/** Store a value into the 'this' pointer.
* Stack: ...:ref
* ->: ...
*/
case class STORE_THIS(kind: TypeKind) extends Instruction {
override def consumed = 1
override def produced = 0
override def consumedTypes = kind :: Nil
override def category = localsCat
}
/** Call a primitive function.
* Stack: ...:arg1:arg2:...:argn
* ->: ...:result
*/
case class CALL_PRIMITIVE(primitive: Primitive) extends Instruction {
override def consumed = primitive match {
case Negation(_) => 1
case Test(_,_, true) => 1
case Test(_,_, false) => 2
case Comparison(_,_) => 2
case Arithmetic(NOT,_) => 1
case Arithmetic(_,_) => 2
case Logical(_,_) => 2
case Shift(_,_) => 2
case Conversion(_,_) => 1
case ArrayLength(_) => 1
case StringConcat(_) => 2
case StartConcat => 0
case EndConcat => 1
}
override def produced = 1
override def consumedTypes = primitive match {
case Negation(kind) => kind :: Nil
case Test(_, kind, true) => kind :: Nil
case Test(_, kind, false) => kind :: kind :: Nil
case Comparison(_, kind) => kind :: kind :: Nil
case Arithmetic(NOT, kind) => kind :: Nil
case Arithmetic(_, kind) => kind :: kind :: Nil
case Logical(_, kind) => kind :: kind :: Nil
case Shift(_, kind) => kind :: INT :: Nil
case Conversion(from, _) => from :: Nil
case ArrayLength(kind) => ARRAY(kind) :: Nil
case StringConcat(kind) => ConcatClass :: kind :: Nil
case StartConcat => Nil
case EndConcat => ConcatClass :: Nil
}
override def producedTypes = primitive match {
case Negation(kind) => kind :: Nil
case Test(_, _, true) => BOOL :: Nil
case Test(_, _, false) => BOOL :: Nil
case Comparison(_, _) => INT :: Nil
case Arithmetic(_, kind) => kind :: Nil
case Logical(_, kind) => kind :: Nil
case Shift(_, kind) => kind :: Nil
case Conversion(_, to) => to :: Nil
case ArrayLength(_) => INT :: Nil
case StringConcat(_) => ConcatClass :: Nil
case StartConcat => ConcatClass :: Nil
case EndConcat => REFERENCE(global.definitions.StringClass) :: Nil
}
override def category = arilogCat
}
/** This class represents a CALL_METHOD instruction
* STYLE: dynamic / static(StaticInstance)
* Stack: ...:ref:arg1:arg2:...:argn
* ->: ...:result
*
* STYLE: static(StaticClass)
* Stack: ...:arg1:arg2:...:argn
* ->: ...:result
*
*/
case class CALL_METHOD(method: Symbol, style: InvokeStyle) extends Instruction with ReferenceEquality {
def toShortString =
"CALL_METHOD " + method.name +" ("+style+")"
/** Returns a string representation of this instruction */
override def toString(): String =
"CALL_METHOD " + method.fullName +" ("+style+")"
var hostClass: Symbol = method.owner
def setHostClass(cls: Symbol): this.type = { hostClass = cls; this }
/** This is specifically for preserving the target native Array type long
* enough that clone() can generate the right call.
*/
var targetTypeKind: TypeKind = UNIT // the default should never be used, so UNIT should fail fast.
def setTargetTypeKind(tk: TypeKind) = targetTypeKind = tk
private def params = method.info.paramTypes
private def consumesInstance = style match {
case Static(false) => 0
case _ => 1
}
override def consumed = params.length + consumesInstance
override def consumedTypes = {
val args = params map toTypeKind
if (consumesInstance > 0) ObjectReference :: args
else args
}
private val producedList = toTypeKind(method.info.resultType) match {
case UNIT => Nil
case _ if method.isConstructor => Nil
case kind => kind :: Nil
}
override def produced = producedList.size
override def producedTypes = producedList
/** object identity is equality for CALL_METHODs. Needed for
* being able to store such instructions into maps, when more
* than one CALL_METHOD to the same method might exist.
*/
override def category = mthdsCat
}
case class BOX(boxType: TypeKind) extends Instruction {
assert(boxType.isValueType && (boxType ne UNIT)) // documentation
override def toString(): String = "BOX " + boxType
override def consumed = 1
override def consumedTypes = boxType :: Nil
override def produced = 1
override def producedTypes = BOXED(boxType) :: Nil
override def category = objsCat
}
case class UNBOX(boxType: TypeKind) extends Instruction {
assert(boxType.isValueType && !boxType.isInstanceOf[BOXED] && (boxType ne UNIT)) // documentation
override def toString(): String = "UNBOX " + boxType
override def consumed = 1
override def consumedTypes = ObjectReferenceList
override def produced = 1
override def producedTypes = boxType :: Nil
override def category = objsCat
}
/** Create a new instance of a class through the specified constructor
* Stack: ...:arg1:arg2:...:argn
* ->: ...:ref
*/
case class NEW(kind: REFERENCE) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String = "NEW "+ kind;
override def consumed = 0;
override def produced = 1;
override def producedTypes = kind :: Nil
/** The corresponding constructor call. */
var init: CALL_METHOD = _
override def category = objsCat
}
/** This class represents a CREATE_ARRAY instruction
* Stack: ...:size_1:size_2:..:size_n
* ->: ...:arrayref
*/
case class CREATE_ARRAY(elem: TypeKind, dims: Int) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="CREATE_ARRAY "+elem + " x " + dims;
override def consumed = dims;
override def consumedTypes = List.fill(dims)(INT)
override def produced = 1;
override def producedTypes = ARRAY(elem) :: Nil
override def category = arraysCat
}
/** This class represents a IS_INSTANCE instruction
* Stack: ...:ref
* ->: ...:result(boolean)
*/
case class IS_INSTANCE(typ: TypeKind) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="IS_INSTANCE "+typ
override def consumed = 1
override def produced = 1
override def consumedTypes = ObjectReferenceList
override def producedTypes = BOOL :: Nil
override def category = castsCat
}
/** This class represents a CHECK_CAST instruction
* Stack: ...:ref(oldtype)
* ->: ...:ref(typ <=: oldtype)
*/
case class CHECK_CAST(typ: TypeKind) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="CHECK_CAST "+typ
override def consumed = 1
override def produced = 1
override def consumedTypes = ObjectReferenceList
override def producedTypes = typ :: Nil
override def category = castsCat
}
/** This class represents a SWITCH instruction
* Stack: ...:index(int)
* ->: ...:
*
* The tags array contains one entry per label, each entry consisting of
* an array of ints, any of which will trigger the jump to the corresponding label.
* labels should contain an extra label, which is the 'default' jump.
*/
case class SWITCH(tags: List[List[Int]], labels: List[BasicBlock]) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="SWITCH ..."
override def consumed = 1
override def produced = 0
override def consumedTypes = INT :: Nil
def flatTagsCount: Int = { var acc = 0; var rest = tags; while(rest.nonEmpty) { acc += rest.head.length; rest = rest.tail }; acc } // a one-liner
override def category = jumpsCat
}
/** This class represents a JUMP instruction
* Stack: ...
* ->: ...
*/
case class JUMP(whereto: BasicBlock) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="JUMP "+whereto.label
override def consumed = 0
override def produced = 0
override def category = jumpsCat
}
/** This class represents a CJUMP instruction
* It compares the two values on the stack with the 'cond' test operator
* Stack: ...:value1:value2
* ->: ...
*/
case class CJUMP(successBlock: BasicBlock,
failureBlock: BasicBlock,
cond: TestOp,
kind: TypeKind) extends Instruction
{
/** Returns a string representation of this instruction */
override def toString(): String = (
"CJUMP (" + kind + ")" +
cond + " ? "+successBlock.label+" : "+failureBlock.label
);
override def consumed = 2
override def produced = 0
override def consumedTypes = kind :: kind :: Nil
override def category = jumpsCat
}
/** This class represents a CZJUMP instruction
* It compares the one value on the stack and zero with the 'cond' test operator
* Stack: ...:value:
* ->: ...
*/
case class CZJUMP(successBlock: BasicBlock,
failureBlock: BasicBlock,
cond: TestOp,
kind: TypeKind) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String = (
"CZJUMP (" + kind + ")" +
cond + " ? "+successBlock.label+" : "+failureBlock.label
);
override def consumed = 1
override def produced = 0
override def consumedTypes = kind :: Nil
override def category = jumpsCat
}
/** This class represents a RETURN instruction
* Stack: ...
* ->: ...
*/
case class RETURN(kind: TypeKind) extends Instruction {
override def consumed = if (kind == UNIT) 0 else 1
override def produced = 0
override def consumedTypes = if (kind == UNIT) Nil else kind :: Nil
override def category = retCat
}
/** This class represents a THROW instruction
* Stack: ...:Throwable(Ref)
* ->: ...:
*/
case class THROW(clasz: Symbol) extends Instruction {
/** PP to ID: We discussed parameterizing LOAD_EXCEPTION but
* not THROW, which came about organically. It seems like the
* right thing, but can you confirm?
*/
override def toString = "THROW(" + clasz.name + ")"
override def consumed = 1
override def produced = 0
override def consumedTypes = toTypeKind(clasz.tpe) :: Nil
override def category = retCat
}
/** This class represents a DROP instruction
* Stack: ...:something
* ->: ...
*/
case class DROP (typ: TypeKind) extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="DROP "+typ
override def consumed = 1
override def produced = 0
override def consumedTypes = typ :: Nil
override def category = stackCat
}
/** This class represents a DUP instruction
* Stack: ...:something
* ->: ...:something:something
*/
case class DUP (typ: TypeKind) extends Instruction {
override def consumed = 1
override def produced = 2
override def consumedTypes = typ :: Nil
override def producedTypes = typ :: typ :: Nil
override def category = stackCat
}
/** This class represents a MONITOR_ENTER instruction
* Stack: ...:object(ref)
* ->: ...:
*/
case class MONITOR_ENTER() extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="MONITOR_ENTER"
override def consumed = 1
override def produced = 0
override def consumedTypes = ObjectReference :: Nil
override def category = objsCat
}
/** This class represents a MONITOR_EXIT instruction
* Stack: ...:object(ref)
* ->: ...:
*/
case class MONITOR_EXIT() extends Instruction {
/** Returns a string representation of this instruction */
override def toString(): String ="MONITOR_EXIT";
override def consumed = 1;
override def produced = 0;
override def consumedTypes = ObjectReference :: Nil
override def category = objsCat
}
/** A local variable becomes visible at this point in code.
* Used only for generating precise local variable tables as
* debugging information.
*/
case class SCOPE_ENTER(lv: Local) extends Instruction {
override def toString(): String = "SCOPE_ENTER " + lv
override def consumed = 0
override def produced = 0
override def category = localsCat
}
/** A local variable leaves its scope at this point in code.
* Used only for generating precise local variable tables as
* debugging information.
*/
case class SCOPE_EXIT(lv: Local) extends Instruction {
override def toString(): String = "SCOPE_EXIT " + lv
override def consumed = 0
override def produced = 0
override def category = localsCat
}
/** Fake instruction. It designates the VM who pushes an exception
* on top of the /empty/ stack at the beginning of each exception handler.
* Note: Unlike other instructions, it consumes all elements on the stack!
* then pushes one exception instance.
*/
case class LOAD_EXCEPTION(clasz: Symbol) extends Instruction {
override def consumed = sys.error("LOAD_EXCEPTION does clean the whole stack, no idea how many things it consumes!")
override def produced = 1
override def producedTypes = REFERENCE(clasz) :: Nil
override def category = stackCat
}
/** This class represents a method invocation style. */
sealed abstract class InvokeStyle {
/** Is this a dynamic method call? */
def isDynamic: Boolean = false
/** Is this a static method call? */
def isStatic: Boolean = false
/** Is this an instance method call? */
def hasInstance: Boolean = true
/** Returns a string representation of this style. */
override def toString(): String
}
/** Virtual calls.
* On JVM, translated to either `invokeinterface` or `invokevirtual`.
*/
case object Dynamic extends InvokeStyle {
override def isDynamic = true
override def toString(): String = "dynamic"
}
/**
* Special invoke:
* Static(true) is used for calls to private members, ie `invokespecial` on JVM.
* Static(false) is used for calls to class-level instance-less static methods, ie `invokestatic` on JVM.
*/
case class Static(onInstance: Boolean) extends InvokeStyle {
override def isStatic = true
override def hasInstance = onInstance
override def toString(): String = {
if(onInstance) "static-instance"
else "static-class"
}
}
/** Call through super[mix].
* On JVM, translated to `invokespecial`.
*/
case class SuperCall(mix: Name) extends InvokeStyle {
override def toString(): String = { "super(" + mix + ")" }
}
}
}
|