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
|
/* NSC -- new Scala compiler
* Copyright 2005-2009 LAMP/EPFL
* @author Martin Odersky
*/
// $Id$
package scala.tools.nsc
package backend
package icode
import scala.collection.mutable.{Buffer, ListBuffer, Map, HashMap}
import scala.tools.nsc.symtab._
abstract class Checkers {
val global: Global
import global._
/** <p>
* This class performs a set of checks similar to what the bytecode
* verifier does. For each basic block, it checks that:
* </p>
* <ul>
* <li>
* for primitive operations: the type and numer of operands match
* the type of the operation
* </li>
* <li>
* for method calls: the method exists in the type of the receiver
* and the number and type of arguments match the declared type of
* the method.
* </li>
* <li>
* for object creation: the constructor can be called.
* </li>
* <li>
* for load/stores: the field/local/param exists and the type
* of the value matches that of the target.
* </li>
* </ul>
* <p>
* For a control flow graph it checks that type stacks at entry to
* each basic block 'agree':
* </p>
* <ul>
* <li>they have the same length</li>
* <li>there exists a lub for all types at the same position in stacks.</li>
* </ul>
*
* @author Iulian Dragos
* @version 1.0, 06/09/2005
*
* @todo Better checks for <code>MONITOR_ENTER/EXIT</code>
* Better checks for local var initializations
*/
class ICodeChecker {
import icodes._
import opcodes._
var clasz: IClass = _
var method: IMethod = _
var code: Code = _
val in: Map[BasicBlock, TypeStack] = new HashMap()
val out: Map[BasicBlock, TypeStack] = new HashMap()
val emptyStack = new TypeStack()
val STRING = REFERENCE(definitions.StringClass)
val SCALA_ALL = REFERENCE(definitions.NothingClass)
val SCALA_ALL_REF = REFERENCE(definitions.NullClass)
val THROWABLE = REFERENCE(definitions.ThrowableClass)
def checkICodes: Unit = {
if (settings.verbose.value)
println("[[consistency check at the beginning of phase " + globalPhase.name + "]]")
classes.values foreach check
}
def check(cls: IClass) {
log("Checking class " + cls)
clasz = cls
for (f1 <- cls.fields; f2 <- cls.fields if f1 ne f2)
if (f1.symbol.name == f2.symbol.name)
Checkers.this.global.error("Repetitive field name: " +
f1.symbol.fullNameString);
for (m1 <- cls.methods; m2 <- cls.methods if m1 ne m2)
if (m1.symbol.name == m2.symbol.name &&
m1.symbol.tpe =:= m2.symbol.tpe)
Checkers.this.global.error("Repetitive method: " +
m1.symbol.fullNameString);
clasz.methods.foreach(check)
}
/** Apply the give funtion to each pair of the cartesian product of
* l1 x l2.
*/
def pairwise[a](l1: List[a], l2: List[a])(f: (a, a) => Unit) =
l1 foreach { x =>
l2 foreach { y => f(x, y) }
}
def check(m: IMethod) {
log("Checking method " + m)
method = m
if (!m.isDeferred)
check(m.code)
}
def check(c: Code) {
var worklist: Buffer[BasicBlock] = new ListBuffer()
def append(elems: List[BasicBlock]) = elems foreach appendBlock;
def appendBlock(bl: BasicBlock) =
if ( !worklist.exists(bl.==) )
worklist + bl;
in.clear; out.clear;
code = c;
worklist + c.startBlock;
for (bl <- c.blocks) {
in += (bl -> emptyStack)
out += (bl -> emptyStack)
}
while (worklist.length > 0) {
val block = worklist(0); worklist.trimStart(1);
val output = check(block, in(block));
if (output != out(block) ||
(out(block) eq emptyStack)) {
log("Output changed for block: " + block.fullString);
out(block) = output;
append(block.successors);
block.successors foreach meet;
}
}
}
/**
* Apply the meet operator of the stack lattice on bl's predecessors.
* :-). Compute the input to bl by checking that all stacks have the
* same length, and taking the lub of types at the same positions.
*/
def meet(bl: BasicBlock) {
val preds = bl.predecessors
def meet2(s1: TypeStack, s2: TypeStack): TypeStack = {
if (s1 eq emptyStack) s2
else if (s2 eq emptyStack) s1
else {
if (s1.length != s2.length)
throw new CheckerError("Incompatible stacks: " + s1 + " and " + s2 + " in " + method + " at entry to block: " + bl);
new TypeStack(List.map2(s1.types, s2.types) (lub))
}
}
if (preds != Nil) {
in(bl) = (preds map out.apply) reduceLeft meet2;
log("Input changed for block: " + bl +" to: " + in(bl));
}
}
private var typeStack: TypeStack = null
private var instruction: Instruction = null
private var basicBlock: BasicBlock = null
/**
* Check the basic block to be type correct and return the
* produced type stack.
*/
def check(b: BasicBlock, initial: TypeStack): TypeStack = {
log("** Checking block:\n" + b.fullString + " with initial stack:\n" + initial)
var stack = new TypeStack(initial)
this.typeStack = stack
this.basicBlock = b
def typeError(k1: TypeKind, k2: TypeKind) {
error(" expected: " + k1 + " but " + k2 + " found")
}
for (instr <- b) {
def checkStack(len: Int) {
if (stack.length < len)
ICodeChecker.this.error("Expected at least " + len + " elements on the stack", stack);
else
()
}
def checkLocal(local: Local) {
method.lookupLocal(local.sym.name) match {
case None => error(" " + local + " is not defined in method " + method);
case _ => ()
}
}
def checkField(obj: TypeKind, field: Symbol) {
obj match {
case REFERENCE(sym) =>
if (sym.info.member(field.name) == NoSymbol)
error(" " + field + " is not defined in class " + clasz);
case _ =>
error(" expected reference type, but " + obj + " found");
}
}
/** Checks that tpe is a subtype of one of the allowed types */
def checkType(tpe: TypeKind, allowed: TypeKind*) {
if (isOneOf(tpe, allowed: _*))
()
else
error(tpe.toString() + " is not one of: " + allowed.toList.mkString("{", ", ", "}"));
}
/** Checks that the 2 topmost elements on stack are of the
* kind TypeKind.
*/
def checkBinop(kind: TypeKind) {
val (a, b) = stack.pop2
checkType(a, kind)
checkType(b, kind)
}
/** Check that arguments on the stack match method params. */
def checkMethodArgs(method: Symbol) {
val params = method.info.paramTypes
checkStack(params.length)
params.reverse.foreach( (tpe) => checkType(stack.pop, toTypeKind(tpe)))
}
/** Checks that the object passed as receiver has a method
* <code>method</code> and that it is callable from the current method.
*
* @param receiver ...
* @param method ...
*/
def checkMethod(receiver: TypeKind, method: Symbol) =
receiver match {
case REFERENCE(sym) =>
checkBool(sym.info.member(method.name) != NoSymbol,
"Method " + method + " does not exist in " + sym.fullNameString);
if (method hasFlag Flags.PRIVATE)
checkBool(method.owner == clasz.symbol,
"Cannot call private method of " + method.owner.fullNameString
+ " from " + clasz.symbol.fullNameString);
else if (method hasFlag Flags.PROTECTED)
checkBool(clasz.symbol isSubClass method.owner,
"Cannot call protected method of " + method.owner.fullNameString
+ " from " + clasz.symbol.fullNameString);
case ARRAY(_) =>
checkBool(receiver.toType.member(method.name) != NoSymbol,
"Method " + method + " does not exist in " + receiver)
case t =>
error("Not a reference type: " + t)
}
def checkBool(cond: Boolean, msg: String) =
if (cond) () else error(msg)
this.instruction = instr
if (settings.debug.value) {
log("PC: " + instr)
log("stack: " + stack)
log("================")
}
instr match {
case THIS(clasz) =>
stack push toTypeKind(clasz.tpe)
case CONSTANT(const) =>
stack push toTypeKind(const.tpe)
case LOAD_ARRAY_ITEM(kind) =>
checkStack(2)
(stack.pop2: @unchecked) match {
case (INT, ARRAY(elem)) =>
if (!(elem <:< kind))
typeError(kind, elem);
stack.push(elem);
case (a, b) =>
error(" expected and INT and a array reference, but " +
a + ", " + b + " found");
}
case LOAD_LOCAL(local) =>
checkLocal(local)
stack.push(local.kind)
case LOAD_FIELD(field, isStatic) =>
if (isStatic) {
// the symbol's owner should contain it's field, but
// this is already checked by the type checker, no need
// to redo that here
} else {
checkStack(1)
val obj = stack.pop
checkField(obj, field)
}
stack.push(toTypeKind(field.tpe))
case LOAD_MODULE(module) =>
checkBool((module.isModule || module.isModuleClass),
"Expected module: " + module + " flags: " + Flags.flagsToString(module.flags));
stack.push(toTypeKind(module.tpe));
case STORE_ARRAY_ITEM(kind) =>
checkStack(3);
(stack.pop3: @unchecked) match {
case (k, INT, ARRAY(elem)) =>
if (!(k <:< kind))
typeError(kind, k);
if (!(k <:< elem))
typeError(elem, k);
case (a, b, c) =>
error(" expected and array reference, and int and " + kind +
" but " + a + ", " + b + ", " + c + " found");
}
case STORE_LOCAL(local) =>
checkLocal(local)
checkStack(1)
val actualType = stack.pop;
if (!(actualType <:< local.kind) &&
//actualType != CASE_CLASS &&
local.kind != SCALA_ALL_REF)
typeError(local.kind, actualType);
case STORE_FIELD(field, isStatic) =>
if (isStatic) {
checkStack(1);
val fieldType = toTypeKind(field.tpe);
val actualType = stack.pop;
if (!(actualType <:< fieldType))
// && actualType != CASE_CLASS)
typeError(fieldType, actualType);
} else {
checkStack(2);
stack.pop2 match {
case (value, obj) =>
checkField(obj, field);
val fieldType = toTypeKind(field.tpe);
if (fieldType != SCALA_ALL_REF && !(value <:< fieldType))
//&& value != CASE_CLASS)
typeError(fieldType, value);
}
}
case CALL_PRIMITIVE(primitive) =>
checkStack(instr.consumed);
primitive match {
case Negation(kind) =>
checkType(kind, BOOL, BYTE, CHAR, SHORT, INT, LONG, FLOAT, DOUBLE);
checkType(stack.pop, kind);
stack push kind;
case Test(op, kind, zero) =>
if (zero) {
val actualType = stack.pop;
checkType(actualType, kind);
} else
checkBinop(kind);
stack push BOOL
case Comparison(op, kind) =>
checkType(kind, BYTE, CHAR, SHORT, INT, LONG, FLOAT, DOUBLE)
checkBinop(kind)
stack push INT
case Arithmetic(op, kind) =>
checkType(kind, BYTE, CHAR, SHORT, INT, LONG, FLOAT, DOUBLE)
if (op == NOT)
checkType(stack.pop, kind)
else
checkBinop(kind)
stack push kind
case Logical(op, kind) =>
checkType(kind, BOOL, BYTE, CHAR, SHORT, INT, LONG)
checkBinop(kind)
stack push kind
case Shift(op, kind) =>
checkType(kind, BYTE, CHAR, SHORT, INT, LONG)
val (a, b) = stack.pop2
checkType(a, INT)
checkType(b, kind)
stack push kind
case Conversion(src, dst) =>
checkType(src, BYTE, CHAR, SHORT, INT, LONG, FLOAT, DOUBLE)
checkType(dst, BYTE, CHAR, SHORT, INT, LONG, FLOAT, DOUBLE)
checkType(stack.pop, src)
stack push dst
case ArrayLength(kind) =>
val arr = stack.pop
arr match {
case ARRAY(elem) =>
checkType(elem, kind);
case _ =>
error(" array reference expected, but " + arr + " found");
}
stack push INT
case StartConcat =>
stack.push(ConcatClass)
case EndConcat =>
checkType(stack.pop, ConcatClass)
stack.push(STRING)
case StringConcat(el) =>
checkType(stack.pop, el)
checkType(stack.pop, ConcatClass)
stack push ConcatClass
}
case CALL_METHOD(method, style) =>
style match {
case Dynamic | InvokeDynamic =>
checkStack(1 + method.info.paramTypes.length)
checkMethodArgs(method)
checkMethod(stack.pop, method)
stack.push(toTypeKind(method.info.resultType))
case Static(onInstance) =>
if (onInstance) {
checkStack(1 + method.info.paramTypes.length)
checkBool(method.hasFlag(Flags.PRIVATE) || method.isConstructor,
"Static call to non-private method.")
checkMethodArgs(method)
checkMethod(stack.pop, method)
if (!method.isConstructor)
stack.push(toTypeKind(method.info.resultType));
} else {
checkStack(method.info.paramTypes.length);
checkMethodArgs(method);
stack.push(toTypeKind(method.info.resultType));
}
case SuperCall(mix) =>
checkStack(1 + method.info.paramTypes.length)
checkMethodArgs(method)
checkMethod(stack.pop, method)
stack.push(toTypeKind(method.info.resultType))
}
case NEW(kind) =>
kind match {
case REFERENCE(cls) =>
stack.push(kind)
//bq: had to change from _ to null, because otherwise would be unreachable code
case null =>
error("NEW call to non-reference type: " + kind)
}
case CREATE_ARRAY(elem, dims) =>
checkStack(dims)
stack.pop(dims) foreach (checkType(_, INT))
stack.push(ARRAY(elem))
case IS_INSTANCE(tpe) =>
val ref = stack.pop
checkBool(ref.isReferenceType || ref.isArrayType,
"IS_INSTANCE on primitive type: " + ref)
checkBool(tpe.isReferenceType || tpe.isArrayType,
"IS_INSTANCE to primitive type: " + tpe)
stack.push(BOOL);
case CHECK_CAST(tpe) =>
val ref = stack.pop
checkBool(ref.isReferenceType || ref.isArrayType,
"CHECK_CAST on primitive type: " + ref)
checkBool(tpe.isReferenceType || tpe.isArrayType,
"CHECK_CAST to primitive type: " + tpe)
stack.push(tpe);
case SWITCH(tags, labels) =>
checkType(stack.pop, INT)
checkBool(tags.length == labels.length - 1,
"The number of tags and labels does not coincide.")
checkBool(labels forall (b => code.blocks contains b),
"Switch target cannot be found in code.")
case JUMP(whereto) =>
checkBool(code.blocks contains whereto,
"Jump to non-existant block " + whereto)
case CJUMP(success, failure, cond, kind) =>
checkBool(code.blocks contains success,
"Jump to non-existant block " + success)
checkBool(code.blocks contains failure,
"Jump to non-existant block " + failure)
checkBinop(kind)
case CZJUMP(success, failure, cond, kind) =>
checkBool(code.blocks contains success,
"Jump to non-existant block " + success)
checkBool(code.blocks contains failure,
"Jump to non-existant block " + failure)
checkType(stack.pop, kind)
case RETURN(kind) =>
kind match {
case UNIT => ()
case REFERENCE(_) | ARRAY(_) =>
checkStack(1)
val top = stack.pop
checkBool(top.isReferenceType || top.isArrayType,
"" + kind + " is a reference type, but " + top + " is not");
case _ =>
checkStack(1)
val top = stack.pop
checkType(top, kind)
}
case THROW() =>
val thrown = stack.pop
checkBool(thrown.toType <:< definitions.ThrowableClass.tpe,
"Element on top of stack should implement 'Throwable': " + thrown);
stack.push(SCALA_ALL)
case DROP(kind) =>
checkType(stack.pop, kind)
case DUP(kind) =>
val top = stack.pop
checkType(top, kind)
stack.push(top)
stack.push(top)
case MONITOR_ENTER() =>
checkStack(1)
checkBool(stack.pop.isReferenceType,
"MONITOR_ENTER on non-reference type")
case MONITOR_EXIT() =>
checkStack(1)
checkBool(stack.pop.isReferenceType,
"MONITOR_EXIT on non-reference type")
case BOX(kind) =>
checkStack(1)
checkType(stack.pop, kind)
stack.push(icodes.AnyRefReference)
case UNBOX(kind) =>
checkStack(1)
stack.pop
stack.push(kind)
case LOAD_EXCEPTION() =>
stack.push(THROWABLE)
case SCOPE_ENTER(_) | SCOPE_EXIT(_) =>
()
case _ =>
abort("Unknown instruction: " + instr)
}
}
stack
}
//////////////// Error reporting /////////////////////////
def error(msg: String) {
Console.println(method.toString() + " in block: " + basicBlock.label)
printLastIntructions
Checkers.this.global.error("ICode checker: " + method + ": " + msg)
}
/** Prints the last 4 instructions. */
def printLastIntructions {
var printed = 0
var buf: List[Instruction] = Nil
for (i <- basicBlock.reverse) {
if (i == instruction || (printed > 0 && printed < 3)) {
buf = i :: buf
printed += 1
}
}
buf foreach Console.println
Console.println("at: " + (buf.head.pos))
}
def error(msg: String, stack: TypeStack) {
error(msg + "\n type stack: " + stack)
}
//////////////////// Checking /////////////////////////////
/** Return true if <code>k1</code> is a subtype of any of the following
* types.
*/
def isOneOf(k1: TypeKind, kinds: TypeKind*) =
kinds.exists( k => k1 <:< k)
}
}
|