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
|
/* NSC -- new Scala compiler
* Copyright 2005-2011 LAMP/EPFL
* @author Martin Odersky
*/
package scala.tools.nsc
package backend
package icode
import scala.collection.{ mutable, immutable }
import mutable.{ ListBuffer, ArrayBuffer }
import scala.reflect.internal.util.{ Position, NoPosition }
import backend.icode.analysis.ProgramPoint
import language.postfixOps
trait BasicBlocks {
self: ICodes =>
import opcodes._
import global.{ ifDebug, settings, log, nme }
import nme.isExceptionResultName
object NoBasicBlock extends BasicBlock(-1, null)
/** This class represents a basic block. Each
* basic block contains a list of instructions that are
* either executed all, or none. No jumps
* to/from the "middle" of the basic block are allowed (modulo exceptions).
*/
class BasicBlock(val label: Int, val method: IMethod) extends ProgramPoint[BasicBlock] {
outer =>
import BBFlags._
def code = method.code
private final class SuccessorList() {
private var successors: List[BasicBlock] = Nil
private def updateConserve() {
var lb: ListBuffer[BasicBlock] = null
var matches = 0
var remaining = successors
def addBlock(bb: BasicBlock) {
if (matches < 0)
lb += bb
else if (remaining.isEmpty || bb != remaining.head) {
lb = ListBuffer[BasicBlock]() ++= (successors take matches) += bb
matches = -1
}
else {
matches += 1
remaining = remaining.tail
}
}
// exceptionSuccessors
method.exh foreach { handler =>
if (handler covers outer)
addBlock(handler.startBlock)
}
// directSuccessors
val direct = directSuccessors
direct foreach addBlock
/** Return a list of successors for 'b' that come from exception handlers
* covering b's (non-exceptional) successors. These exception handlers
* might not cover 'b' itself. This situation corresponds to an
* exception being thrown as the first thing of one of b's successors.
*/
method.exh foreach { handler =>
direct foreach { block =>
if (handler covers block)
addBlock(handler.startBlock)
}
}
// Blocks did not align: create a new list.
if (matches < 0)
successors = lb.toList
// Blocks aligned, but more blocks remain. Take a prefix of the list.
else if (remaining.nonEmpty)
successors = successors take matches
// Otherwise the list is unchanged, leave it alone.
}
/** This is called millions of times: it is performance sensitive. */
def updateSuccs() {
if (isEmpty) {
if (successors.nonEmpty)
successors = Nil
}
else updateConserve()
}
def toList = successors
}
/** Flags of this basic block. */
private var flags: Int = 0
/** Does this block have the given flag? */
def hasFlag(flag: Int): Boolean = (flags & flag) != 0
/** Set the given flag. */
private def setFlag(flag: Int): Unit = flags |= flag
private def resetFlag(flag: Int) {
flags &= ~flag
}
/** Is this block closed? */
def closed: Boolean = hasFlag(CLOSED)
def closed_=(b: Boolean) = if (b) setFlag(CLOSED) else resetFlag(CLOSED)
/** When set, the <code>emit</code> methods will be ignored. */
def ignore: Boolean = hasFlag(IGNORING)
def ignore_=(b: Boolean) = if (b) setFlag(IGNORING) else resetFlag(IGNORING)
/** Is this block the head of a while? */
def loopHeader = hasFlag(LOOP_HEADER)
def loopHeader_=(b: Boolean) =
if (b) setFlag(LOOP_HEADER) else resetFlag(LOOP_HEADER)
/** Is this block the start block of an exception handler? */
def exceptionHandlerStart = hasFlag(EX_HEADER)
def exceptionHandlerStart_=(b: Boolean) =
if (b) setFlag(EX_HEADER) else resetFlag(EX_HEADER)
/** Has this basic block been modified since the last call to 'successors'? */
def touched = hasFlag(DIRTYSUCCS)
def touched_=(b: Boolean) = if (b) {
setFlag(DIRTYSUCCS | DIRTYPREDS)
} else {
resetFlag(DIRTYSUCCS | DIRTYPREDS)
}
// basic blocks start in a dirty state
setFlag(DIRTYSUCCS | DIRTYPREDS)
/** Cached predecessors. */
var preds: List[BasicBlock] = Nil
/** Local variables that are in scope at entry of this basic block. Used
* for debugging information.
*/
val varsInScope: mutable.Set[Local] = new mutable.LinkedHashSet()
/** ICode instructions, used as temporary storage while emitting code.
* Once closed is called, only the `instrs` array should be used.
*/
private var instructionList: List[Instruction] = Nil
private var instrs: Array[Instruction] = _
def take(n: Int): Seq[Instruction] =
if (closed) instrs take n else instructionList takeRight n reverse
def toList: List[Instruction] =
if (closed) instrs.toList else instructionList.reverse
/** Return an iterator over the instructions in this basic block. */
def iterator: Iterator[Instruction] =
if (closed) instrs.iterator else instructionList.reverseIterator
/** return the underlying array of instructions */
def getArray: Array[Instruction] = {
assert(closed, this)
instrs
}
def fromList(is: List[Instruction]) {
code.touched = true
instrs = is.toArray
closed = true
}
/** Return the index of inst. Uses reference equality.
* Returns -1 if not found.
*/
def indexOf(inst: Instruction): Int = {
assert(closed, this)
instrs indexWhere (_ eq inst)
}
/** Apply a function to all the instructions of the block. */
final def foreach[U](f: Instruction => U) = {
if (!closed) dumpMethodAndAbort(method, this)
else instrs foreach f
// !!! If I replace "instrs foreach f" with the following:
// var i = 0
// val len = instrs.length
// while (i < len) {
// f(instrs(i))
// i += 1
// }
//
// Then when compiling under -optimise, quick.plugins fails as follows:
//
// quick.plugins:
// [mkdir] Created dir: /scratch/trunk6/build/quick/classes/continuations-plugin
// [scalacfork] Compiling 5 files to /scratch/trunk6/build/quick/classes/continuations-plugin
// [scalacfork] error: java.lang.VerifyError: (class: scala/tools/nsc/typechecker/Implicits$ImplicitSearch, method: typedImplicit0 signature: (Lscala/tools/nsc/typechecker/Implicits$ImplicitInfo;Z)Lscala/tools/nsc/typechecker/Implicits$SearchResult;) Incompatible object argument for function call
// [scalacfork] at scala.tools.nsc.typechecker.Implicits$class.inferImplicit(Implicits.scala:67)
// [scalacfork] at scala.tools.nsc.Global$$anon$1.inferImplicit(Global.scala:419)
// [scalacfork] at scala.tools.nsc.typechecker.Typers$Typer.wrapImplicit$1(Typers.scala:170)
// [scalacfork] at scala.tools.nsc.typechecker.Typers$Typer.inferView(Typers.scala:174)
// [scalacfork] at scala.tools.nsc.typechecker.Typers$Typer.adapt(Typers.scala:963)
// [scalacfork] at scala.tools.nsc.typechecker.Typers$Typer.typed(Typers.scala:4378)
//
// This is bad and should be understood/eliminated.
}
/** The number of instructions in this basic block so far. */
def length = if (closed) instrs.length else instructionList.length
def size = length
/** Return the n-th instruction. */
def apply(n: Int): Instruction =
if (closed) instrs(n) else instructionList.reverse(n)
///////////////////// Substitutions ///////////////////////
/**
* Replace the instruction at the given position. Used by labels when they are anchored.
* The replacing instruction is given the nsc.util.Position of the instruction it replaces.
*/
def replaceInstruction(pos: Int, instr: Instruction): Boolean = {
assert(closed, "Instructions can be replaced only after the basic block is closed")
instr.setPos(instrs(pos).pos)
instrs(pos) = instr
code.touched = true
true
}
/**
* Replace the given instruction with the new one.
* Returns `true` if it actually changed something.
* The replacing instruction is given the nsc.util.Position of the instruction it replaces.
*/
def replaceInstruction(oldInstr: Instruction, newInstr: Instruction): Boolean = {
assert(closed, "Instructions can be replaced only after the basic block is closed")
indexOf(oldInstr) match {
case -1 => false
case idx =>
newInstr setPos oldInstr.pos
instrs(idx) = newInstr
code.touched = true
true
}
}
/** Replaces <code>oldInstr</code> with <code>is</code>. It does not update
* the position field in the newly inserted instructions, so it behaves
* differently than the one-instruction versions of this function.
*
* @param iold ..
* @param is ..
* @return ..
*/
def replaceInstruction(oldInstr: Instruction, is: List[Instruction]): Boolean = {
assert(closed, "Instructions can be replaced only after the basic block is closed")
indexOf(oldInstr) match {
case -1 => false
case idx =>
instrs = instrs.patch(idx, is, 1)
code.touched = true
true
}
}
/** Insert instructions in 'is' immediately after index 'idx'. */
def insertAfter(idx: Int, is: List[Instruction]) {
assert(closed, "Instructions can be replaced only after the basic block is closed")
instrs = instrs.patch(idx + 1, is, 0)
code.touched = true
}
/** Removes instructions found at the given positions.
*
* @param positions ...
*/
def removeInstructionsAt(positions: Int*) {
assert(closed, this)
instrs = instrs.indices.toArray filterNot positions.toSet map instrs
code.touched = true
}
/** Remove the last instruction of this basic block. It is
* fast for an open block, but slower when the block is closed.
*/
def removeLastInstruction() {
if (closed)
removeInstructionsAt(length)
else {
instructionList = instructionList.tail
code.touched = true
}
}
/** Replaces all instructions found in the map.
*
* @param map ...
*/
def subst(map: Map[Instruction, Instruction]): Unit =
if (!closed)
instructionList = instructionList map (x => map.getOrElse(x, x))
else
instrs.zipWithIndex collect {
case (oldInstr, i) if map contains oldInstr =>
code.touched |= replaceInstruction(i, map(oldInstr))
}
////////////////////// Emit //////////////////////
/** Add a new instruction at the end of the block,
* using the same source position as the last emitted instruction
*/
def emit(instr: Instruction) {
val pos = if (instructionList.isEmpty) NoPosition else instructionList.head.pos
emit(instr, pos)
}
/** Emitting does not set touched to true. During code generation this is a hotspot and
* setting the flag for each emit is a waste. Caching should happen only after a block
* is closed, which sets the DIRTYSUCCS flag.
*/
def emit(instr: Instruction, pos: Position) {
/* if (closed) {
print()
Console.println("trying to emit: " + instr)
} */
assert(!closed || ignore, this)
if (ignore) {
if (settings.debug.value) {
/** Trying to pin down what it's likely to see after a block has been
* put into ignore mode so we hear about it if there's a problem.
*/
instr match {
case JUMP(_) | RETURN(_) | THROW(_) | SCOPE_EXIT(_) => // ok
case STORE_LOCAL(local) if isExceptionResultName(local.sym.name) => // ok
case x => log("Ignoring instruction, possibly at our peril, at " + pos + ": " + x)
}
}
}
else {
instr.setPos(pos)
instructionList ::= instr
}
}
def emit(is: Seq[Instruction]) {
is foreach (i => emit(i, i.pos))
}
/** The semantics of this are a little odd but it's designed to work
* seamlessly with the existing code. It emits each supplied instruction,
* then closes the block. The odd part is that if the instruction has
* pos == NoPosition, it calls the 1-arg emit, but otherwise it calls
* the 2-arg emit. This way I could retain existing behavior exactly by
* calling setPos on any instruction using the two arg version which
* I wanted to include in a call to emitOnly.
*/
def emitOnly(is: Instruction*) {
is foreach (i => if (i.pos == NoPosition) emit(i) else emit(i, i.pos))
this.close()
}
/** do nothing if block is already closed */
def closeWith(instr: Instruction) {
if (!closed) {
emit(instr)
close()
}
}
def closeWith(instr: Instruction, pos: Position) {
if (!closed) {
emit(instr, pos)
close()
}
}
/** Close the block */
def close() {
assert(!closed || ignore, this)
assert(instructionList.nonEmpty, "Empty block: " + this)
if (ignore && closed) { // redundant `ignore &&` for clarity -- we should never be in state `!ignore && closed`
// not doing anything to this block is important...
// because the else branch reverses innocent blocks, which is wrong when they're in ignore mode (and closed)
// reversing the instructions when (closed && ignore) wreaks havoc for nested label jumps (see comments in genLoad)
} else {
closed = true
setFlag(DIRTYSUCCS)
instructionList = instructionList.reverse
instrs = instructionList.toArray
}
}
def open() {
assert(closed, this)
closed = false
ignore = false
touched = true
instructionList = instructionList.reverse // prepare for appending to the head
}
def clear() {
instructionList = Nil
instrs = null
preds = Nil
}
final def isEmpty = instructionList.isEmpty
final def nonEmpty = !isEmpty
/** Enter ignore mode: new 'emit'ted instructions will not be
* added to this basic block. It makes the generation of THROW
* and RETURNs easier.
*/
def enterIgnoreMode() = {
ignore = true
}
def exitIgnoreMode() {
assert(ignore, "Exit ignore mode when not in ignore mode: " + this)
ignore = false
}
/** Return the last instruction of this basic block. */
def lastInstruction =
if (closed) instrs(instrs.length - 1)
else instructionList.head
def firstInstruction =
if (closed) instrs(0)
else instructionList.last
def exceptionSuccessors: List[BasicBlock] =
exceptionSuccessorsForBlock(this)
def exceptionSuccessorsForBlock(block: BasicBlock): List[BasicBlock] =
method.exh collect { case x if x covers block => x.startBlock }
/** Cached value of successors. Must be recomputed whenever a block in the current method is changed. */
private val succs = new SuccessorList
def successors: List[BasicBlock] = {
if (touched) {
succs.updateSuccs()
resetFlag(DIRTYSUCCS)
}
succs.toList
}
def directSuccessors: List[BasicBlock] =
if (isEmpty) Nil else lastInstruction match {
case JUMP(whereto) => whereto :: Nil
case CJUMP(succ, fail, _, _) => fail :: succ :: Nil
case CZJUMP(succ, fail, _, _) => fail :: succ :: Nil
case SWITCH(_, labels) => labels
case RETURN(_) => Nil
case THROW(_) => Nil
case _ =>
if (closed)
dumpClassesAndAbort("The last instruction is not a control flow instruction: " + lastInstruction)
else Nil
}
/** Returns the predecessors of this block. */
def predecessors: List[BasicBlock] = {
if (hasFlag(DIRTYPREDS)) {
resetFlag(DIRTYPREDS)
preds = code.blocks.iterator filter (_.successors contains this) toList
}
preds
}
override def equals(other: Any): Boolean = other match {
case that: BasicBlock => (that.label == label) && (that.code == code)
case _ => false
}
override def hashCode = label * 41 + code.hashCode
// Instead of it, rather use a printer
def print() { print(java.lang.System.out) }
def print(out: java.io.PrintStream) {
out.println("block #"+label+" :")
foreach(i => out.println(" " + i))
out.print("Successors: ")
successors.foreach((x: BasicBlock) => out.print(" "+x.label.toString()))
out.println()
}
private def succString = if (successors.isEmpty) "[S: N/A]" else successors.distinct.mkString("[S: ", ", ", "]")
private def predString = if (predecessors.isEmpty) "[P: N/A]" else predecessors.distinct.mkString("[P: ", ", ", "]")
override def toString(): String = "" + label
def blockContents = {
def posStr(p: Position) = if (p.isDefined) p.line.toString else "<??>"
val xs = this.toList map (instr => posStr(instr.pos) + "\t" + instr)
xs.mkString(fullString + " {\n ", "\n ", "\n}")
}
def predContents = predecessors.map(_.blockContents).mkString(predecessors.size + " preds:\n", "\n", "\n")
def succContents = successors.map(_.blockContents).mkString(successors.size + " succs:\n", "\n", "\n")
def fullString: String = List("Block", label, succString, predString, flagsString) mkString " "
def flagsString: String = BBFlags.flagsToString(flags)
}
}
object BBFlags {
val flagMap = Map[Int, String](
LOOP_HEADER -> "loopheader",
IGNORING -> "ignore",
EX_HEADER -> "exheader",
CLOSED -> "closed",
DIRTYSUCCS -> "dirtysuccs",
DIRTYPREDS -> "dirtypreds"
)
def flagsToString(flags: Int) = {
flagMap collect { case (bit, name) if (bit & flags) != 0 => "<" + name + ">" } mkString " "
}
/** This block is a loop header (was translated from a while). */
final val LOOP_HEADER = (1 << 0)
/** Ignoring mode: emit instructions are dropped. */
final val IGNORING = (1 << 1)
/** This block is the header of an exception handler. */
final val EX_HEADER = (1 << 2)
/** This block is closed. No new instructions can be added. */
final val CLOSED = (1 << 3)
/** Code has been changed, recompute successors. */
final val DIRTYSUCCS = (1 << 4)
/** Code has been changed, recompute predecessors. */
final val DIRTYPREDS = (1 << 5)
}
|