-
Notifications
You must be signed in to change notification settings - Fork 28
/
controlflow.cpp
878 lines (763 loc) · 31.2 KB
/
controlflow.cpp
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
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
/* xoreos-tools - Tools to help with xoreos development
*
* xoreos-tools is the legal property of its developers, whose names
* can be found in the AUTHORS file distributed with this source
* distribution.
*
* xoreos-tools is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* xoreos-tools is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with xoreos-tools. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file
* Higher-level control flow analysis on NWScript bytecode.
*/
#include <cassert>
#include <algorithm>
#include "src/common/util.h"
#include "src/common/error.h"
#include "src/nwscript/controlflow.h"
#include "src/nwscript/instruction.h"
#include "src/nwscript/block.h"
#include "src/nwscript/subroutine.h"
namespace NWScript {
/** Does this block have only one instruction?
*
* For example, this block would qualify:
*
* .
* |
* V
* .------------------.
* | JMP loc_00000042 |
* '------------------'
* |
* '
*/
static bool isSingularBlock(const Block &block) {
return block.instructions.size() == 1;
}
/** Is this an independent block that consists of a single JMP?
*
* A dependent block is one that has only parents that unconditionally, seamlessy jump
* to this block. Essentially, the block has only been divided because a third
* block jumps into its middle.
*
* For example, the block at (1) would qualify:
*
* . .
* | |
* V V
* .------------------. .-----------------.
* | MOVSP -4 | | EQI |
* '------------------' | JZ loc_00000023 |
* | '-----------------'
* (1) V (true)| |(false)
* .------------------. | |
* | JMP loc_00000042 |<----------' |
* '------------------' |
* | |
* ' '
*/
static bool isLoneJump(const Block *block) {
if (!block)
return false;
const bool loneJump = isSingularBlock(*block) && (block->instructions[0]->opcode == kOpcodeJMP);
bool independ = false;
for (std::vector<const Block *>::const_iterator p = block->parents.begin();
p != block->parents.end(); ++p) {
if ((*p)->hasConditionalChildren()) {
independ = true;
break;
}
}
return loneJump && independ;
}
/** Is this a block that *doesn't* consist of a single JMP or isn't independent?
*
* This is a convenience negation of isLoneJump(), to be used in combination with
* std::remove_if().
*/
static bool isNotLoneJump(const Block *block) {
return !isLoneJump(block);
}
/** Is this a block that has a return instruction?
*
* Any block with a RETN instruction qualifies. For example:
*
* .
* |
* V
* .----------------.
* | CPDOWNSP -24 4 |
* | MOVSP -4 |
* | MOVSP -12 |
* | RETN |
* '----------------'
*/
static bool isReturnBlock(const Block &block) {
for (std::vector<const Instruction *>::const_iterator i = block.instructions.begin();
i != block.instructions.end(); i++)
if ((*i)->opcode == kOpcodeRETN)
return true;
return false;
}
/** Is this a block that has a Return control type?
*
* Any block with a RETN instruction that has been previously detected by
* detectReturn() qualifies. For example:
*
* .
* |
* V
* .----------------.
* | <RETN> |
* | CPDOWNSP -24 4 |
* | MOVSP -4 |
* | MOVSP -12 |
* | RETN |
* '----------------'
*/
static bool isReturnControl(const Block &block, bool checkChildren = false) {
if (block.isControl(kControlTypeReturn))
return true;
if (checkChildren) {
if (block.hasConditionalChildren())
return false;
for (std::vector<const Block *>::const_iterator c = block.children.begin();
c != block.children.end(); ++c)
if ((*c)->isControl(kControlTypeReturn))
return true;
}
return false;
}
/** Given a vector of pointers to blocks, return the block that has the earliest, lowest address. */
static const Block *getEarliestBlock(const std::vector<const Block *> &blocks) {
const Block *result = 0;
for (std::vector<const Block *>::const_iterator b = blocks.begin(); b != blocks.end(); ++b)
if (!result || ((*b)->address < result->address))
result = *b;
return result;
}
/** Given a vector of pointers to blocks, return the block that has the latest, largest address. */
static const Block *getLatestBlock(const std::vector<const Block *> &blocks) {
const Block *result = 0;
for (std::vector<const Block *>::const_iterator b = blocks.begin(); b != blocks.end(); ++b)
if (!result || ((*b)->address > result->address))
result = *b;
return result;
}
/** Recursive internal convenience function to be used by findPathMerge(). */
static void findPathMergeRec(std::vector<const Block *> &merges, std::set<uint32_t> &visited,
const Block &block1, const Block &block2) {
/* We hold the earlier block and recursively descend into the children
* of the later block. If at any point, there is a linear path between
* the earlier block and the later block (or one of its children), we
* have found a merge point. */
// Remember which blocks we already visited, so we don't process them twice
visited.insert(block2.address);
// We moved past the destination => no merge here
if (block1.address > block2.address)
return;
// There's a linear path => we found a merge point
if (hasLinearPath(block1, block2)) {
merges.push_back(&block2);
return;
}
// Continue along the children
assert(block2.children.size() == block2.childrenTypes.size());
for (size_t i = 0; i < block2.children.size(); i++) {
const Block &child = *block2.children[i];
const BlockEdgeType type = block2.childrenTypes[i];
// Don't follow subroutine calls, don't jump backwards and don't visit blocks twice
if (!isSubRoutineCall(type) && (child.address > block2.address))
if (visited.find(child.address) == visited.end())
findPathMergeRec(merges, visited, block1, child);
}
}
/** Find the block where the paths of these two blocks come back together.
*
* For example, when given the two blocks at (1) and (2), findPathMerge()
* will find the block at (3).
*
* .
* |
* V
* .-----------------.
* | EQI |
* | JZ loc_00000023 |
* '-----------------'
* (true)| |(false)
* .-----' '-----.
* | |
* V (1) (2) V
* .----------. .----------.
* | | | |
* '----------' '----------'
* | |
* V V
* .----------. .----------.
* | | | |
* '----------' '----------'
* | |
* V |
* .----------. |
* | | |
* '----------' |
* | .--------'
* V (3) V
* .------------.
* | |
* '------------'
* |
* '
*/
static const Block *findPathMerge(const Block &block1, const Block &block2) {
std::vector<const Block *> merges;
std::set<uint32_t> visited;
// Correctly order the two blocks we want to check
if (block1.address < block2.address)
findPathMergeRec(merges, visited, block1, block2);
else
findPathMergeRec(merges, visited, block2, block1);
// We're only interested in the earliest merge point
return getEarliestBlock(merges);
}
static void detectDoWhile(Blocks &blocks) {
/* Find all do-while loops. A do-while loop has a tail block that
* only has a single JMP that jumps back to the loop head.
*
* For example:
*
* .
* |
* (1) V
* .-------------.
* | |
* | |<---------------------------.
* '-------------' |
* | |
* V |
* .-------------. |
* | | |
* | | |
* '-------------' |
* (true)| |(false) |
* | '--------------------. |
* | (2) V |
* | .------------------. |
* | | JMP loc_00000042 | |
* (3) V '------------------' |
* .-------------. | |
* | | '----------'
* | |
* '-------------'
* |
* '
*
* Here, the block at (1) is the loop head, (2) is the loop tail and
* the block at (3) is the block immediately after the whole loop.
*/
for (Blocks::iterator head = blocks.begin(); head != blocks.end(); ++head) {
// Find all parents of this block from later in the script that only consist of a single JMP.
std::vector<const Block *> parents = head->getLaterParents();
parents.erase(std::remove_if(parents.begin(), parents.end(), isNotLoneJump), parents.end());
// Get the parent that has the highest address and make sure it's still undetermined
Block *tail = const_cast<Block *>(getLatestBlock(parents));
if (!tail || tail->hasMainControl())
continue;
Block *next = const_cast<Block *>(getNextBlock(blocks, *tail));
if (!next)
throw Common::Exception("Can't find a block following the do-while loop");
// If such a parent exists, it's the tail of a do-while loop
head->controls.push_back(ControlStructure(kControlTypeDoWhileHead, *head, *tail, *next));
tail->controls.push_back(ControlStructure(kControlTypeDoWhileTail, *head, *tail, *next));
next->controls.push_back(ControlStructure(kControlTypeDoWhileNext, *head, *tail, *next));
}
}
static void detectWhile(Blocks &blocks) {
/* Find all while loops. A while loop has a tail block that isn't a
* do-while loop tail, that jumps back to the loop head.
*
* For example:
*
* .
* |
* (1) V
* .-------------.
* | |
* | |<-----.
* '-------------' |
* (true)| |(false) |
* .--------' | |
* | V |
* | .------------. |
* | | | |
* | '------------' |
* | | |
* | (2) V |
* | .------------------. |
* | | | |
* | | | |
* | | | |
* | | JMP loc_00000042 | |
* | '------------------' |
* | | |
* | '----------'
* | (3)
* | .-------------.
* '->| |
* | |
* '-------------'
* |
* '
*
* Here, the block at (1) is the loop head, (2) is the loop tail and
* the block at (3) is the block immediately after the whole loop.
*/
for (Blocks::iterator head = blocks.begin(); head != blocks.end(); ++head) {
// Find all parents of this block from later in the script
std::vector<const Block *> parents = head->getLaterParents();
// Get the parent that has the highest address and make sure it's still undetermined
Block *tail = const_cast<Block *>(getLatestBlock(parents));
if (!tail || tail ->hasMainControl())
continue;
Block *next = const_cast<Block *>(getNextBlock(blocks, *tail));
if (!next)
throw Common::Exception("Can't find a block following the do-while loop");
// If such a parent exists, it's the tail of a while loop
head->controls.push_back(ControlStructure(kControlTypeWhileHead, *head, *tail, *next));
tail->controls.push_back(ControlStructure(kControlTypeWhileTail, *head, *tail, *next));
next->controls.push_back(ControlStructure(kControlTypeWhileNext, *head, *tail, *next));
}
}
static void detectBreak(Blocks &blocks) {
/* Find all "break;" statements. A break is created by a block that
* only contains a single JMP that jumps directly outside the loop.
*
* For example:
*
* .
* |
* (1) V
* .-------------.
* | |
* | |<---------------------------.
* '-------------' |
* | |
* V |
* .-------------. |
* | | |
* | | |
* '-------------' |
* (true)| |(false) |
* | '--------. |
* | V |
* | .-------------. |
* | | | |
* | | | |
* | '-------------' |
* | | |
* | V |
* | .-------------. |
* | | | |
* | | | |
* | '-------------' |
* | (true)| |(false) |
* | | '--------. |
* | | | |
* (4) V | (2) V |
* .------------------. | .------------------. |
* | JMP loc_0000007F | | | JMP loc_00000042 | |
* '------------------' | '------------------' |
* | | | |
* | | '----------'
* | (3) V
* | .-------------.
* '--->| |
* | |
* '-------------'
* |
* '
*
* Here, the block at (1) is the loop head, (2) is the loop tail and
* the block at (3) is the block immediately after the whole loop.
* The block at (4) is then a break statement.
*/
for (Blocks::iterator b = blocks.begin(); b != blocks.end(); ++b) {
// Find all undetermined blocks that consist of a single JMP
if (b->hasMainControl() || !isLoneJump(&*b))
continue;
// Make sure they jump to a block that directly follows a loop
if ((b->children.size() != 1) || !b->children[0]->isLoopNext())
continue;
// Get the loop blocks
const Block *head = 0, *tail = 0, *next = 0;
if (!b->children[0]->getLoop(head, tail, next))
continue;
// Mark the block as being a loop break
b->controls.push_back(ControlStructure(kControlTypeBreak, *head, *tail, *next));
}
}
static void detectContinue(Blocks &blocks) {
/* Find all "continue;" statements. A continue is created by a block that
* only contains a single JMP that jumps directly to the tail of the loop.
*
* For example:
*
* .
* |
* (1) V
* .-------------.
* | |
* | |<---------------------------.
* '-------------' |
* | |
* V |
* .-------------. |
* | | |
* | | |
* '-------------' |
* (true)| |(false) |
* | '--------------------. |
* V | |
* .-------------. (4) V |
* | | .------------------. |
* | | | JMP loc_0000007F | |
* '-------------' '------------------' |
* | | |
* V | |
* .-------------. | |
* | | | |
* | | | |
* '-------------' (2) V |
* (true)| |(false) .------------------. |
* | '--------->| JMP loc_00000042 | |
* (3) V '------------------' |
* .-------------. | |
* | | '----------'
* | |
* '-------------'
* |
* '
*
* Here, the block at (1) is the loop head, (2) is the loop tail and
* the block at (3) is the block immediately after the whole loop.
* The block at (4) is then a continue statement.
*/
for (Blocks::iterator b = blocks.begin(); b != blocks.end(); ++b) {
// Find all undetermined blocks that consist of a single JMP
if (b->hasMainControl() || !isLoneJump(&*b))
continue;
// Make sure they jump to a loop tail
if ((b->children.size() != 1) || !b->children[0]->isLoopTail())
continue;
// Get the loop blocks
const Block *head = 0, *tail = 0, *next = 0;
if (!b->children[0]->getLoop(head, tail, next))
continue;
// Mark the block as being a loop continue
b->controls.push_back(ControlStructure(kControlTypeContinue, *head, *tail, *next));
}
}
static void detectReturn(Blocks &blocks) {
/* Find all "return;" (and "return $value;") statements. A return block is
* a block that contains a RETN statement, or that unconditionally jumps
* to a block with a RETN statement.
*
* . .
* | |
* V V
* .-------------. .-------.
* | | | |
* | | '-------'
* '-------------' |
* (true)| |(false) V
* .-----' | .-------.
* | V | |
* | .-------. '-------'
* | | | |
* | '-------' (3) V
* | | .-------.
* | V | RETN |
* | .-------. '-------'
* | | |
* | '-------'
* | |
* (1) | (2) V
* .-------. .-------.
* | | | |
* '-------' '-------'
* | |
* | V
* | .-------.
* '----->| RETN |
* '-------'
*
* .
* |
* V
* .-------------.
* | |
* | |<---------------------------------------.
* '-------------' |
* | |
* V |
* .-------------. |
* | | |
* | | |
* '-------------' |
* (true)| |(false) |
* .---' '-------. |
* | | |
* (5) V V |
* .-----------. .-------------. |
* | | | | |
* ' | | | |
* '-----------' '-------------' |
* | | |
* | V |
* | .-------------. |
* | | | |
* | | | |
* | '-------------' |
* | (true)| |(false) .------------------. |
* | | '--------->| JMP loc_00000042 | |
* | V '------------------' |
* | .-------------. | |
* | | | '----------'
* | | |
* | '-------------'
* | |
* | (4) V
* | .-------------.
* | | |
* | '-------------'
* | |
* | V
* | .------.
* '----------->| RETN |
* '------'
*
* Here, the blocks at (1), (2), (3), (4) and (5) are all return statements.
*/
for (Blocks::iterator b = blocks.begin(); b != blocks.end(); ++b) {
// Find all undetermined blocks with a RETN
if (b->hasMainControl() || !isReturnBlock(*b))
continue;
// Make sure this is not the entry (and only) block in this subroutine
if (!b->subRoutine || (b->subRoutine->address == b->address))
continue;
bool hasReturnParent = false;
if (isSingularBlock(*b)) {
/* If this is a block that has *only* a RETN, this block is
* probably a shared RETN used by several "return;" statements. */
for (std::vector<const Block *>::const_iterator p = b->parents.begin();
p != b->parents.end(); ++p) {
if ((*p)->hasUnconditionalChildren() && !(*p)->hasMainControl()) {
hasReturnParent = true;
const_cast<Block *>(*p)->controls.push_back(ControlStructure(kControlTypeReturn, *b));
}
}
}
// If we haven't marked any of this block's parents, mark this block instead
if (!hasReturnParent)
b->controls.push_back(ControlStructure(kControlTypeReturn, *b));
}
}
static void detectIf(Blocks &blocks) {
/* Detect if and if-else statements. An if starts with a yet undetermined block
* that contains a conditional jump (JZ or JNZ).
*
* For example:
*
* . .
* | |
* (1) V (4) V
* .-----------------. .-----------------.
* | | | |
* | EQI | | EQI |
* | JZ loc_00000023 | | JZ loc_00000042 |
* '-----------------' '-----------------'
* (true)| |(false) (true)| |(false)
* .----' | .----' '----.
* | | | |
* (2) V | (5) V (6) V
* .---------. | .---------. .---------.
* | | | | | | |
* '---------' | '---------' '---------'
* | | | |
* V | V |
* .---------. | .---------. |
* | | | | | |
* '---------' | '---------' |
* | | | |
* (3) V | | (7) |
* .---------. | | .--------. |
* | |<---' '->| |<-'
* '---------' '--------'
* | |
* ' '
*
* Here, the blocks at (1) and (4) are conditional blocks, the blocks
* at (2) and (5) are the starting blocks of the true branch, the block
* at (6) is the starting block of the else branch, and the blocks at
* (3) and (7) are the blocks following the whole if construct.
*/
for (Blocks::iterator ifCond = blocks.begin(); ifCond != blocks.end(); ++ifCond) {
// Find all undetermined blocks (but while heads are okay, too)
if (ifCond->hasMainControl() && !ifCond->isControl(kControlTypeWhileHead))
continue;
// They do need to have conditionals, though
if ((ifCond->children.size() != 2) || !ifCond->hasConditionalChildren())
continue;
// If there's no direct linear path between the two branches, this is an if-else
const bool isIfElse = !hasLinearPath(*ifCond->children[0], *ifCond->children[1]);
Block *ifTrue = 0, *ifElse = 0, *ifNext = 0;
if (isIfElse) {
// The two branches are the if and the else
ifTrue = const_cast<Block *>(ifCond->children[0]);
ifElse = const_cast<Block *>(ifCond->children[1]);
// If we have both, try to find the block where the code flow unites again
if (ifTrue && ifElse)
ifNext = const_cast<Block *>(findPathMerge(*ifTrue, *ifElse));
} else {
// The if branch has the smaller address, and the flow continues at the larger address
const bool firstSmaller = ifCond->children[0]->address < ifCond->children[1]->address;
const Block *low = firstSmaller ? ifCond->children[0] : ifCond->children[1];
const Block *high = firstSmaller ? ifCond->children[1] : ifCond->children[0];
ifTrue = const_cast<Block *>(low);
ifNext = const_cast<Block *>(high);
}
assert(ifTrue);
// Mark the conditional and the true branch
ifCond->controls.push_back(ControlStructure(kControlTypeIfCond, *ifCond, *ifTrue, ifElse, ifNext));
ifTrue->controls.push_back(ControlStructure(kControlTypeIfTrue, *ifCond, *ifTrue, ifElse, ifNext));
// If we have an else and/or a next branch, mark them as well
if (ifElse)
ifElse->controls.push_back(ControlStructure(kControlTypeIfElse, *ifCond, *ifTrue, ifElse, ifNext));
if (ifNext)
ifNext->controls.push_back(ControlStructure(kControlTypeIfNext, *ifCond, *ifTrue, ifElse, ifNext));
}
}
/** Collect all control structures of a certain type from all blocks. */
static std::vector<const ControlStructure *> collectControls(const Blocks &blocks, ControlType type) {
std::vector<const ControlStructure *> controls;
for (Blocks::const_iterator b = blocks.begin(); b != blocks.end(); ++b)
for (std::vector<ControlStructure>::const_iterator c = b->controls.begin(); c != b->controls.end(); ++c)
if (c->type == type)
controls.push_back(&*c);
return controls;
}
static void verifyBlocks(const Blocks &blocks) {
/* Verify that all blocks that should have control structures attached do,
* in fact, have control structures attached. If we find one that doesn't,
* that's a fatal error. */
for (Blocks::const_iterator b = blocks.begin(); b != blocks.end(); ++b) {
if (b->hasBackEdge() && !b->isLoop())
throw Common::Exception("Block %08X has back edges but is no loop", b->address);
if (b->hasConditionalChildren()) {
if (!b->isControl(kControlTypeIfCond))
throw Common::Exception("Block %08X has conditional children but is no if", b->address);
for (std::vector<const Block *>::const_iterator c = b->children.begin(); c != b->children.end(); ++c)
if (!(*c)->isIfCond() && !(*c)->isControl(kControlTypeIfNext))
throw Common::Exception("Block %08X is child of if %08X but is not an if type",
(*c)->address, b->address);
}
}
}
static void verifyLoopBlocks(std::set<uint32_t> &visited, const Block &block,
const Block &head, const Block &tail, const Block &next) {
/* Recursively verify that all blocks inside a jump control structure don't
* jump to random script locations. The only valid jump destinations for
* a block of a loop is to another block of the loop, the block directly
* following the loop (thus ending the loop), or a return block (thus
* returning from the subroutine entirely). */
// Remember which blocks we already visited, so we don't process them twice
visited.insert(block.address);
if ((block.address > tail.address) || (block.address < head.address))
return;
for (size_t i = 0; i < block.children.size(); i++) {
if (block.isSubRoutineChild(i))
continue;
const Block &child = *block.children[i];
if ( (child.address < head.address) ||
((child.address > tail.address) && (child.address != next.address))) {
if (!isReturnControl(block) && !isReturnControl(child, true))
throw Common::Exception("Loop block jumps outside loop: %08X, %08X, %08X: %08X => %08X",
head.address, tail.address, next.address, block.address, child.address);
}
if (child.address > block.address)
if (visited.find(child.address) == visited.end())
verifyLoopBlocks(visited, child, head, tail, next);
}
}
static void verifyLoop(const Block &head, const Block &tail, const Block &next) {
/* Verify the loop assumption by making sure that the critical loop
* blocks are ordered correctly, that there is a path between them,
* and that all blocks within the loop jump to valid locations. */
if ((head.address >= tail.address) || (next.address <= tail.address))
throw Common::Exception("Loop blocks out of order: %08X, %08X, %08X",
head.address, tail.address, next.address);
if (!hasLinearPath(head, tail) || !hasLinearPath(head, next))
throw Common::Exception("Loop blocks have no linear path: %08X, %08X, %08X",
head.address, tail.address, next.address);
std::set<uint32_t> visited;
verifyLoopBlocks(visited, head, head, tail, next);
}
static void verifyLoops(const std::vector<const ControlStructure *> &loops) {
for (std::vector<const ControlStructure *>::const_iterator l = loops.begin(); l != loops.end(); ++l)
verifyLoop(*(*l)->loopHead, *(*l)->loopTail, *(*l)->loopNext);
}
static void verifyLoops(const Blocks &blocks) {
std::vector<const ControlStructure *> doWhileLoops = collectControls(blocks, kControlTypeDoWhileHead);
verifyLoops(doWhileLoops);
std::vector<const ControlStructure *> whileLoops = collectControls(blocks, kControlTypeWhileHead);
verifyLoops(whileLoops);
}
static void verifyIf(const Block *ifCond, const Block *ifTrue, const Block *ifElse, const Block *ifNext) {
/* Verify the if assumption by making sure that there is a path between
* the critical blocks of the if condition. */
assert(ifCond && ifTrue);
if (ifTrue && ifNext)
if (!hasLinearPath(*ifTrue, *ifNext))
throw Common::Exception("If blocks true and next have no linear path: %08X, %08X, %08X",
ifCond->address, ifTrue->address, ifNext->address);
if (ifElse && ifNext)
if (!hasLinearPath(*ifElse, *ifNext))
throw Common::Exception("If blocks else and next have no linear path: %08X, %08X, %08X",
ifCond->address, ifTrue->address, ifNext->address);
}
static void verifyIf(const Blocks &blocks) {
std::vector<const ControlStructure *> ifs = collectControls(blocks, kControlTypeIfCond);
for (std::vector<const ControlStructure *>::const_iterator i = ifs.begin(); i != ifs.end(); ++i)
verifyIf((*i)->ifCond, (*i)->ifTrue, (*i)->ifElse, (*i)->ifNext);
}
static void detectControlFlow(Blocks &blocks) {
// The order is important!
detectDoWhile (blocks);
detectWhile (blocks);
detectBreak (blocks);
detectContinue(blocks);
detectReturn (blocks);
detectIf (blocks);
}
static void verifyControlFlow(const Blocks &blocks) {
verifyBlocks(blocks);
verifyLoops (blocks);
verifyIf (blocks);
}
void analyzeControlFlow(Blocks &blocks) {
/* Analyze the control flow to detect (and verify) different control structures. */
detectControlFlow(blocks);
verifyControlFlow(blocks);
}
} // End of namespace NWScript