-
Notifications
You must be signed in to change notification settings - Fork 10.4k
/
Copy pathPassManager.cpp
1623 lines (1363 loc) · 55 KB
/
PassManager.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
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===--- PassManager.cpp - Swift Pass Manager -----------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#define DEBUG_TYPE "sil-passmanager"
#include "swift/SILOptimizer/PassManager/PassManager.h"
#include "../../IRGen/IRGenModule.h"
#include "swift/AST/ASTMangler.h"
#include "swift/AST/SILOptimizerRequests.h"
#include "swift/Basic/Assertions.h"
#include "swift/Demangling/Demangle.h"
#include "swift/Demangling/Demangler.h"
#include "swift/SIL/ApplySite.h"
#include "swift/SIL/SILFunction.h"
#include "swift/SIL/SILModule.h"
#include "swift/SILOptimizer/Analysis/BasicCalleeAnalysis.h"
#include "swift/SILOptimizer/Analysis/FunctionOrder.h"
#include "swift/SILOptimizer/PassManager/PrettyStackTrace.h"
#include "swift/SILOptimizer/PassManager/Transforms.h"
#include "swift/SILOptimizer/Utils/OptimizerStatsUtils.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/ADT/StringSwitch.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/GraphWriter.h"
#include "llvm/Support/ManagedStatic.h"
#include "llvm/Support/Casting.h"
#include <fstream>
using namespace swift;
llvm::cl::opt<bool> SILPrintAll(
"sil-print-all", llvm::cl::init(false),
llvm::cl::desc("Print SIL after each pass"));
llvm::cl::opt<bool> SILPrintPassName(
"sil-print-pass-name", llvm::cl::init(false),
llvm::cl::desc("Print the name of each SIL pass before it runs"));
llvm::cl::opt<bool> SILPrintPassTime(
"sil-print-pass-time", llvm::cl::init(false),
llvm::cl::desc("Print the execution time of each SIL pass"));
llvm::cl::opt<unsigned> SILMinPassTime(
"sil-min-pass-time", llvm::cl::init(0),
llvm::cl::desc("The minimum number of milliseconds for which a pass is printed with -sil-print-pass-time"));
llvm::cl::opt<bool> SILPrintLast(
"sil-print-last", llvm::cl::init(false),
llvm::cl::desc("Print the last optimized function before and after the last pass"));
llvm::cl::opt<std::string> SILNumOptPassesToRun(
"sil-opt-pass-count", llvm::cl::init(""),
llvm::cl::desc("Stop optimizing after <N> passes or <N>.<M> passes/sub-passes"));
// Read pass counts for each module from a config file.
// Config file format:
// <module-name>:<pass-count>(.<sub-pass-count>)?
//
// This is useful for bisecting passes in large projects:
// 1. create a config file from a full build log. E.g. with
// grep -e '-module-name' build.log | sed -e 's/.*-module-name \([^ ]*\) .*/\1:10000000/' | sort | uniq > config.txt
// 2. add the `-Xllvm -sil-pass-count-config-file config.txt` option to the project settings
// 3. bisect by modifying the counts in the config file
// 4. clean-rebuild after each bisecting step
llvm::cl::opt<std::string> SILPassCountConfigFile(
"sil-pass-count-config-file", llvm::cl::init(""),
llvm::cl::desc("Read optimization counts from file"));
llvm::cl::opt<unsigned> SILOptProfileRepeat(
"sil-opt-profile-repeat", llvm::cl::init(1),
llvm::cl::desc("repeat passes N times and report the run time"));
llvm::cl::opt<std::string> SILBreakOnFun(
"sil-break-on-function", llvm::cl::init(""),
llvm::cl::desc(
"Break before running each function pass on a particular function"));
llvm::cl::opt<std::string> SILBreakOnPass(
"sil-break-on-pass", llvm::cl::init(""),
llvm::cl::desc("Break before running a particular function pass"));
llvm::cl::opt<std::string>
SILBreakBeforePassCount("sil-break-before-pass-count", llvm::cl::init(""),
llvm::cl::desc("Break before running pass number"));
llvm::cl::list<std::string>
SILPrintFunction("sil-print-function", llvm::cl::CommaSeparated,
llvm::cl::desc("Only print out the sil for this function"));
llvm::cl::opt<std::string>
SILPrintFunctions("sil-print-functions", llvm::cl::init(""),
llvm::cl::desc("Only print out the sil for the functions "
"whose name contains this substring"));
llvm::cl::list<std::string>
SILPrintBefore("sil-print-before", llvm::cl::CommaSeparated,
llvm::cl::desc("Print out the sil before passes which "
"contain a string from this list."));
llvm::cl::list<std::string>
SILPrintAfter("sil-print-after", llvm::cl::CommaSeparated,
llvm::cl::desc("Print out the sil after passes which contain "
"a string from this list."));
llvm::cl::list<std::string>
SILPrintAround("sil-print-around", llvm::cl::CommaSeparated,
llvm::cl::desc("Print out the sil before and after passes "
"which contain a string from this list"));
llvm::cl::list<std::string>
SILDisablePass("sil-disable-pass", llvm::cl::CommaSeparated,
llvm::cl::desc("Disable passes "
"which contain a string from this list"));
llvm::cl::list<std::string> SILDisablePassOnlyFun(
"sil-disable-pass-only-function", llvm::cl::CommaSeparated,
llvm::cl::desc("Apply -sil-disable-pass only on this function"));
llvm::cl::list<std::string> SILVerifyBeforePass(
"sil-verify-before-pass", llvm::cl::CommaSeparated,
llvm::cl::desc("Verify the module/analyses before we run "
"a pass from this list"));
llvm::cl::list<std::string> SILVerifyAroundPass(
"sil-verify-around-pass", llvm::cl::CommaSeparated,
llvm::cl::desc("Verify the module/analyses before/after we run "
"a pass from this list"));
llvm::cl::list<std::string>
SILVerifyAfterPass("sil-verify-after-pass", llvm::cl::CommaSeparated,
llvm::cl::desc("Verify the module/analyses after we run "
"a pass from this list"));
llvm::cl::list<std::string> SILForceVerifyAroundPass(
"sil-verify-force-analysis-around-pass", llvm::cl::CommaSeparated,
llvm::cl::desc("For the given passes, precompute analyses before the pass "
"and verify analyses after the pass"));
llvm::cl::opt<bool> SILVerifyWithoutInvalidation(
"sil-verify-without-invalidation", llvm::cl::init(false),
llvm::cl::desc("Verify after passes even if the pass has not invalidated"));
llvm::cl::opt<bool> SILDisableSkippingPasses(
"sil-disable-skipping-passes", llvm::cl::init(false),
llvm::cl::desc("Do not skip passes even if nothing was changed"));
llvm::cl::opt<bool> SILForceVerifyAll(
"sil-verify-force-analysis", llvm::cl::init(false),
llvm::cl::desc("For all passes, precompute analyses before the pass and "
"verify analyses after the pass"));
static llvm::ManagedStatic<std::vector<unsigned>> DebugPassNumbers;
namespace {
struct DebugOnlyPassNumberOpt {
void operator=(const std::string &Val) const {
if (Val.empty())
return;
SmallVector<StringRef, 8> dbgPassNumbers;
StringRef(Val).split(dbgPassNumbers, ',', -1, false);
for (auto dbgPassNumber : dbgPassNumbers) {
int PassNumber;
if (dbgPassNumber.getAsInteger(10, PassNumber) || PassNumber < 0)
llvm_unreachable("The pass number should be an integer number >= 0");
DebugPassNumbers->push_back(static_cast<unsigned>(PassNumber));
}
}
};
} // end anonymous namespace
static DebugOnlyPassNumberOpt DebugOnlyPassNumberOptLoc;
static llvm::cl::opt<DebugOnlyPassNumberOpt, true,
llvm::cl::parser<std::string>>
DebugOnly("debug-only-pass-number",
llvm::cl::desc("Enable a specific type of debug output (comma "
"separated list pass numbers)"),
llvm::cl::Hidden, llvm::cl::ZeroOrMore,
llvm::cl::value_desc("pass number"),
llvm::cl::location(DebugOnlyPassNumberOptLoc),
llvm::cl::ValueRequired);
static llvm::cl::opt<bool> SILPrintEverySubpass(
"sil-print-every-subpass", llvm::cl::init(false),
llvm::cl::desc("Print the function before every subpass run of passes that "
"have multiple subpasses"));
static bool isInPrintFunctionList(SILFunction *F) {
for (const std::string &printFnName : SILPrintFunction) {
if (printFnName == F->getName())
return true;
if (!printFnName.empty() && printFnName[0] != '$' &&
!F->getName().empty() && F->getName()[0] == '$' &&
printFnName == F->getName().drop_front()) {
return true;
}
}
return false;
}
bool isFunctionSelectedForPrinting(SILFunction *F) {
if (!SILPrintFunction.empty() && !isInPrintFunctionList(F))
return false;
if (!F->getName().contains(SILPrintFunctions))
return false;
return true;
}
void printInliningDetails(StringRef passName, SILFunction *caller,
SILFunction *callee, bool isCaller,
bool alreadyInlined) {
if (!isFunctionSelectedForPrinting(caller))
return;
llvm::dbgs() << " " << passName
<< (alreadyInlined ? " has inlined " : " will inline ")
<< callee->getName() << " into " << caller->getName() << ".\n";
auto *printee = isCaller ? caller : callee;
printee->dump(caller->getModule().getOptions().EmitVerboseSIL);
llvm::dbgs() << '\n';
}
void printInliningDetailsCallee(StringRef passName, SILFunction *caller,
SILFunction *callee) {
printInliningDetails(passName, caller, callee, /*isCaller=*/false,
/*alreadyInlined=*/false);
}
void printInliningDetailsCallerBefore(StringRef passName, SILFunction *caller,
SILFunction *callee) {
printInliningDetails(passName, caller, callee, /*isCaller=*/true,
/*alreadyInlined=*/false);
}
void printInliningDetailsCallerAfter(StringRef passName, SILFunction *caller,
SILFunction *callee) {
printInliningDetails(passName, caller, callee, /*isCaller=*/true,
/*alreadyInlined=*/true);
}
static bool functionSelectionEmpty() {
return SILPrintFunction.empty() && SILPrintFunctions.empty();
}
bool SILPassManager::doPrintBefore(SILTransform *T, SILFunction *F) {
if (NumPassesRun == maxNumPassesToRun - 1 && SILPrintLast &&
maxNumSubpassesToRun == UINT_MAX && !isMandatory)
return true;
if (F && !isFunctionSelectedForPrinting(F))
return false;
auto MatchFun = [&](const std::string &Str) -> bool {
return T->getTag().contains(Str) || T->getID().contains(Str);
};
if (SILPrintBefore.end() !=
std::find_if(SILPrintBefore.begin(), SILPrintBefore.end(), MatchFun))
return true;
if (!SILPrintBefore.empty())
return false;
if (SILPrintAround.end() !=
std::find_if(SILPrintAround.begin(), SILPrintAround.end(), MatchFun))
return true;
if (!SILPrintAround.empty())
return false;
return false;
}
bool SILPassManager::doPrintAfter(SILTransform *T, SILFunction *F, bool PassChangedSIL) {
if (NumPassesRun == maxNumPassesToRun - 1 && SILPrintLast && !isMandatory)
return true;
if (F && !isFunctionSelectedForPrinting(F))
return false;
auto MatchFun = [&](const std::string &Str) -> bool {
return T->getTag().contains(Str) || T->getID().contains(Str);
};
if (SILPrintAfter.end() !=
std::find_if(SILPrintAfter.begin(), SILPrintAfter.end(), MatchFun))
return true;
if (!SILPrintAfter.empty())
return false;
if (SILPrintAround.end() !=
std::find_if(SILPrintAround.begin(), SILPrintAround.end(), MatchFun))
return true;
if (!SILPrintAround.empty())
return false;
return PassChangedSIL && (SILPrintAll || !functionSelectionEmpty());
}
static void printModule(SILModule *Mod, bool EmitVerboseSIL) {
if (functionSelectionEmpty()) {
Mod->dump();
return;
}
for (auto &F : *Mod) {
if (isFunctionSelectedForPrinting(&F))
F.dump(EmitVerboseSIL);
}
}
class DebugPrintEnabler {
#ifndef NDEBUG
bool OldDebugFlag;
#endif
public:
DebugPrintEnabler(unsigned PassNumber) {
#ifndef NDEBUG
OldDebugFlag = llvm::DebugFlag;
if (llvm::DebugFlag)
return;
if (DebugPassNumbers->empty())
return;
// Enable debug printing if the pass number matches
// one of the pass numbers provided as a command line option.
for (auto DebugPassNumber : *DebugPassNumbers) {
if (DebugPassNumber == PassNumber) {
llvm::DebugFlag = true;
return;
}
}
#endif
}
~DebugPrintEnabler() {
#ifndef NDEBUG
llvm::DebugFlag = OldDebugFlag;
#endif
}
};
//===----------------------------------------------------------------------===//
// Serialization Notification Implementation
//===----------------------------------------------------------------------===//
namespace {
class PassManagerDeserializationNotificationHandler final
: public DeserializationNotificationHandler {
NullablePtr<SILPassManager> pm;
public:
PassManagerDeserializationNotificationHandler(SILPassManager *pm) : pm(pm) {}
~PassManagerDeserializationNotificationHandler() override = default;
StringRef getName() const override {
return "PassManagerDeserializationNotificationHandler";
}
/// Observe that we deserialized a function declaration.
void didDeserialize(ModuleDecl *mod, SILFunction *fn) override {
pm.get()->notifyAnalysisOfFunction(fn);
}
};
} // end anonymous namespace
evaluator::SideEffect ExecuteSILPipelineRequest::evaluate(
Evaluator &evaluator, SILPipelineExecutionDescriptor desc) const {
SILPassManager PM(desc.SM, desc.IsMandatory, desc.IRMod);
PM.executePassPipelinePlan(desc.Plan);
return std::make_tuple<>();
}
void swift::executePassPipelinePlan(SILModule *SM,
const SILPassPipelinePlan &plan,
bool isMandatory,
irgen::IRGenModule *IRMod) {
auto &evaluator = SM->getASTContext().evaluator;
SILPipelineExecutionDescriptor desc{SM, plan, isMandatory, IRMod};
(void)evaluateOrFatal(evaluator, ExecuteSILPipelineRequest{desc});
}
SILPassManager::SILPassManager(SILModule *M, bool isMandatory,
irgen::IRGenModule *IRMod)
: Mod(M), IRMod(IRMod), irgen(nullptr),
swiftPassInvocation(this),
isMandatory(isMandatory), deserializationNotificationHandler(nullptr) {
#define SIL_ANALYSIS(NAME) \
Analyses.push_back(create##NAME##Analysis(Mod));
#include "swift/SILOptimizer/Analysis/Analysis.def"
if (!SILNumOptPassesToRun.empty()) {
parsePassesToRunCount(SILNumOptPassesToRun);
} else if (!SILPassCountConfigFile.empty()) {
StringRef moduleName = M->getSwiftModule()->getName().str();
std::fstream fs(SILPassCountConfigFile);
if (!fs) {
llvm::errs() << "cannot open pass count config file\n";
exit(1);
}
std::string line;
while (std::getline(fs, line)) {
auto pair = StringRef(line).split(":");
StringRef modName = pair.first;
StringRef countsStr = pair.second;
if (modName == moduleName) {
parsePassesToRunCount(countsStr);
break;
}
}
fs.close();
}
if (!SILBreakBeforePassCount.empty()) {
parseBreakBeforePassCount(SILBreakBeforePassCount);
}
for (SILAnalysis *A : Analyses) {
A->initialize(this);
}
std::unique_ptr<DeserializationNotificationHandler> handler(
new PassManagerDeserializationNotificationHandler(this));
deserializationNotificationHandler = handler.get();
M->registerDeserializationNotificationHandler(std::move(handler));
}
void SILPassManager::parsePassesToRunCount(StringRef countsStr) {
bool validFormat = true;
if (countsStr.consumeInteger(10, maxNumPassesToRun))
validFormat = false;
if (countsStr.starts_with(".")) {
countsStr = countsStr.drop_front(1);
if (countsStr.consumeInteger(10, maxNumSubpassesToRun))
validFormat = false;
}
if (!validFormat || !countsStr.empty()) {
llvm::errs() << "error: wrong format of -sil-opt-pass-count option\n";
exit(1);
}
}
void SILPassManager::parseBreakBeforePassCount(StringRef countsStr) {
bool validFormat = true;
if (countsStr.consumeInteger(10, breakBeforePassCount))
validFormat = false;
if (!validFormat || !countsStr.empty()) {
llvm::errs()
<< "error: wrong format of -sil-break-before-pass-count option\n";
exit(1);
}
}
bool SILPassManager::continueTransforming() {
if (isMandatory)
return true;
return NumPassesRun < maxNumPassesToRun;
}
bool SILPassManager::continueWithNextSubpassRun(
std::optional<Transformee> origTransformee, SILFunction *function,
SILTransform *trans) {
// Rewrite .some(nullptr) as .none.
std::optional<llvm::PointerUnion<SILValue, SILInstruction *>> forTransformee;
if (origTransformee) {
auto forValue = dyn_cast<SILValue>(*origTransformee);
if (forValue) {
forTransformee = forValue;
} else if (auto *forInst = cast<SILInstruction *>(*origTransformee)) {
forTransformee = forInst;
}
}
unsigned subPass = numSubpassesRun++;
if (isFunctionSelectedForPrinting(function) && SILPrintEverySubpass) {
dumpPassInfo("*** SIL function before ", trans, function);
llvm::dbgs() << " *** sub-pass " << subPass << " for ";
if (forTransformee) {
auto forValue = dyn_cast<SILValue>(*forTransformee);
if (forValue) {
llvm::dbgs() << forValue;
} else {
auto *forInst = cast<SILInstruction *>(*forTransformee);
llvm::dbgs() << *forInst;
}
} else {
llvm::dbgs() << "???\n";
}
function->dump(getOptions().EmitVerboseSIL);
}
if (isMandatory)
return true;
if (NumPassesRun != maxNumPassesToRun - 1)
return true;
if (subPass == maxNumSubpassesToRun - 1 && SILPrintLast) {
dumpPassInfo("*** SIL function before ", trans, function);
if (forTransformee) {
auto forValue = dyn_cast<SILValue>(*forTransformee);
if (forValue) {
llvm::dbgs() << forValue;
} else {
auto *forInst = cast<SILInstruction *>(*forTransformee);
llvm::dbgs() << *forInst;
}
} else {
llvm::dbgs() << "???\n";
}
function->dump(getOptions().EmitVerboseSIL);
}
return subPass < maxNumSubpassesToRun;
}
bool SILPassManager::analysesUnlocked() {
for (auto *A : Analyses)
if (A->isLocked())
return false;
return true;
}
// Test the function and pass names we're given against the debug
// options that force us to break prior to a given pass and/or on a
// given function.
bool SILPassManager::breakBeforeRunning(StringRef fnName,
SILFunctionTransform *SFT) {
if (SILBreakOnFun.empty() && SILBreakOnPass.empty() &&
SILBreakBeforePassCount.empty())
return false;
if (!SILBreakOnPass.empty() &&
(SFT->getID() == SILBreakOnPass || SFT->getTag() == SILBreakOnPass))
return true;
if (!SILBreakOnFun.empty() && fnName == SILBreakOnFun)
return true;
if (!SILBreakBeforePassCount.empty() &&
breakBeforePassCount == NumPassesRun) {
return true;
}
return false;
}
void SILPassManager::dumpPassInfo(const char *Title, SILTransform *Tr,
SILFunction *F, int passIdx) {
llvm::dbgs() << " " << Title << " #" << NumPassesRun
<< ", stage " << StageName << ", pass";
if (passIdx >= 0)
llvm::dbgs() << ' ' << passIdx;
llvm::dbgs() << ": " << Tr->getID() << " (" << Tr->getTag() << ")";
if (F)
llvm::dbgs() << ", Function: " << F->getName();
llvm::dbgs() << '\n';
}
void SILPassManager::dumpPassInfo(const char *Title, unsigned TransIdx,
SILFunction *F) {
dumpPassInfo(Title, Transformations[TransIdx], F, (int)TransIdx);
}
bool SILPassManager::isMandatoryFunctionPass(SILFunctionTransform *sft) {
return isMandatory ||
sft->getPassKind() ==
PassKind::NonTransparentFunctionOwnershipModelEliminator ||
sft->getPassKind() == PassKind::OwnershipModelEliminator;
}
static bool isDisabled(SILTransform *T, SILFunction *F = nullptr) {
if (SILDisablePass.empty())
return false;
if (SILPassManager::isPassDisabled(T->getTag()) ||
SILPassManager::isPassDisabled(T->getID())) {
if (F && !SILPassManager::disablePassesForFunction(F))
return false;
return true;
}
return false;
}
bool SILPassManager::isPassDisabled(StringRef passName) {
for (const std::string &namePattern : SILDisablePass) {
if (passName.contains(namePattern))
return true;
}
return false;
}
bool SILPassManager::isInstructionPassDisabled(StringRef instName) {
StringRef prefix("simplify-");
for (const std::string &namePattern : SILDisablePass) {
StringRef pattern(namePattern);
if (pattern.starts_with(prefix) && pattern.ends_with(instName) &&
pattern.size() == prefix.size() + instName.size()) {
return true;
}
}
return false;
}
bool SILPassManager::isAnyPassDisabled() {
return !SILDisablePass.empty();
}
bool SILPassManager::disablePassesForFunction(SILFunction *function) {
if (SILDisablePassOnlyFun.empty())
return true;
return std::find(SILDisablePassOnlyFun.begin(), SILDisablePassOnlyFun.end(),
function->getName()) != SILDisablePassOnlyFun.end();
}
void SILPassManager::runPassOnFunction(unsigned TransIdx, SILFunction *F) {
assert(analysesUnlocked() && "Expected all analyses to be unlocked!");
auto *SFT = cast<SILFunctionTransform>(Transformations[TransIdx]);
if (!F->shouldOptimize() && !isMandatoryFunctionPass(SFT)) {
return;
}
SFT->injectPassManager(this);
SFT->injectFunction(F);
PrettyStackTraceSILFunctionTransform X(SFT, NumPassesRun);
DebugPrintEnabler DebugPrint(NumPassesRun);
// If nothing changed since the last run of this pass, we can skip this
// pass if it is not mandatory
CompletedPasses &completedPasses = CompletedPassesMap[F];
if (!isMandatoryFunctionPass(SFT) &&
completedPasses.test((size_t)SFT->getPassKind()) &&
!SILDisableSkippingPasses) {
if (SILPrintPassName)
dumpPassInfo("(Skip)", TransIdx, F);
return;
}
if (isDisabled(SFT, F)) {
if (SILPrintPassName)
dumpPassInfo("(Disabled)", TransIdx, F);
return;
}
updateSILModuleStatsBeforeTransform(F->getModule(), SFT, *this, NumPassesRun);
CurrentPassHasInvalidated = false;
currentPassDependsOnCalleeBodies = false;
numSubpassesRun = 0;
auto MatchFun = [&](const std::string &Str) -> bool {
return SFT->getTag().contains(Str) || SFT->getID().contains(Str);
};
if ((SILVerifyBeforePass.end() != std::find_if(SILVerifyBeforePass.begin(),
SILVerifyBeforePass.end(),
MatchFun)) ||
(SILVerifyAroundPass.end() != std::find_if(SILVerifyAroundPass.begin(),
SILVerifyAroundPass.end(),
MatchFun))) {
F->verify(getAnalysis<BasicCalleeAnalysis>()->getCalleeCache());
verifyAnalyses();
runSwiftFunctionVerification(F);
}
if (SILPrintPassName)
dumpPassInfo("Run", TransIdx, F);
if (doPrintBefore(SFT, F)) {
dumpPassInfo("*** SIL function before ", TransIdx);
F->dump(getOptions().EmitVerboseSIL);
}
if (breakBeforeRunning(F->getName(), SFT))
LLVM_BUILTIN_DEBUGTRAP;
if (SILForceVerifyAll ||
SILForceVerifyAroundPass.end() !=
std::find_if(SILForceVerifyAroundPass.begin(),
SILForceVerifyAroundPass.end(), MatchFun)) {
forcePrecomputeAnalyses(F);
}
llvm::sys::TimePoint<> startTime = std::chrono::system_clock::now();
std::chrono::nanoseconds duration(0);
enum {
// In future we might want to make snapshots with positive number (e.g.
// corresponding to pass indices). Therefore use -1 here to avoid collisions.
SnapshotID = -1
};
unsigned numRepeats = SILOptProfileRepeat;
if (numRepeats > 1) {
// Need to create a snapshot to restore the original state for consecutive runs.
F->createSnapshot(SnapshotID);
}
for (unsigned runIdx = 0; runIdx < numRepeats; runIdx++) {
swiftPassInvocation.startFunctionPassRun(SFT);
// Run it!
SFT->run();
swiftPassInvocation.finishedFunctionPassRun();
if (CurrentPassHasInvalidated) {
// Pause time measurement while invalidating analysis and restoring the snapshot.
duration += (std::chrono::system_clock::now() - startTime);
if (runIdx < numRepeats - 1) {
invalidateAnalysis(F, SILAnalysis::InvalidationKind::Everything);
F->restoreFromSnapshot(SnapshotID);
}
// Continue time measurement (including flushing deleted instructions).
startTime = std::chrono::system_clock::now();
} else {
if (Mod->hasInstructionsScheduledForDeletion()) {
// Last chance for invalidating analysis if the pass forgot to call invalidateAnalysis.
invalidateAnalysis(F, SILAnalysis::InvalidationKind::FunctionBody);
}
}
Mod->flushDeletedInsts();
}
duration += (std::chrono::system_clock::now() - startTime);
totalPassRuntime += duration;
if (SILPrintPassTime) {
double milliSecs = (double)duration.count() / 1000000.;
if (milliSecs > (double)SILMinPassTime) {
llvm::dbgs() << llvm::format("%9.3f", milliSecs) << " ms: " << SFT->getTag()
<< " #" << NumPassesRun << " @" << F->getName() << "\n";
}
}
if (numRepeats > 1)
F->deleteSnapshot(SnapshotID);
assert(analysesUnlocked() && "Expected all analyses to be unlocked!");
if (SILForceVerifyAll ||
SILForceVerifyAroundPass.end() !=
std::find_if(SILForceVerifyAroundPass.begin(),
SILForceVerifyAroundPass.end(), MatchFun)) {
verifyAnalyses(F);
}
// If this pass invalidated anything, print and verify.
if (doPrintAfter(SFT, F, CurrentPassHasInvalidated)) {
dumpPassInfo("*** SIL function after ", TransIdx);
F->dump(getOptions().EmitVerboseSIL);
}
updateSILModuleStatsAfterTransform(F->getModule(), SFT, *this, NumPassesRun,
duration.count());
// Remember if this pass didn't change anything.
if (!CurrentPassHasInvalidated && !currentPassDependsOnCalleeBodies)
completedPasses.set((size_t)SFT->getPassKind());
if (getOptions().VerifyAll &&
(CurrentPassHasInvalidated || SILVerifyWithoutInvalidation)) {
F->verify(getAnalysis<BasicCalleeAnalysis>()->getCalleeCache());
verifyAnalyses(F);
runSwiftFunctionVerification(F);
} else if (getOptions().VerifyOwnershipAll &&
(CurrentPassHasInvalidated || SILVerifyWithoutInvalidation)) {
F->verifyOwnership();
} else {
if ((SILVerifyAfterPass.end() != std::find_if(SILVerifyAfterPass.begin(),
SILVerifyAfterPass.end(),
MatchFun)) ||
(SILVerifyAroundPass.end() != std::find_if(SILVerifyAroundPass.begin(),
SILVerifyAroundPass.end(),
MatchFun))) {
F->verify(getAnalysis<BasicCalleeAnalysis>()->getCalleeCache());
verifyAnalyses();
runSwiftFunctionVerification(F);
}
}
++NumPassesRun;
}
void SILPassManager::
runFunctionPasses(unsigned FromTransIdx, unsigned ToTransIdx) {
if (ToTransIdx <= FromTransIdx)
return;
BasicCalleeAnalysis *BCA = getAnalysis<BasicCalleeAnalysis>();
BottomUpFunctionOrder BottomUpOrder(*Mod, BCA);
auto BottomUpFunctions = BottomUpOrder.getFunctions();
assert(FunctionWorklist.empty() && "Expected empty function worklist!");
FunctionWorklist.reserve(BottomUpFunctions.size());
for (auto I = BottomUpFunctions.rbegin(), E = BottomUpFunctions.rend();
I != E; ++I) {
auto &F = **I;
// Only include functions that are definitions, and which have not
// been intentionally excluded from optimization.
if (F.isDefinition())
FunctionWorklist.push_back(*I);
}
DerivationLevels.clear();
// The maximum number of times the pass pipeline can be restarted for a
// function. This is used to ensure we are not going into an infinite loop in
// cases where (for example) we have recursive type-based specialization
// happening.
const unsigned MaxNumRestarts = 20;
if (SILPrintPassName)
llvm::dbgs() << "Start function passes at stage: " << StageName << "\n";
// Run all transforms for all functions, starting at the tail of the worklist.
while (!FunctionWorklist.empty() && continueTransforming()) {
unsigned TailIdx = FunctionWorklist.size() - 1;
unsigned PipelineIdx = FunctionWorklist[TailIdx].PipelineIdx;
SILFunction *F = FunctionWorklist[TailIdx].F;
if (PipelineIdx >= (ToTransIdx - FromTransIdx)) {
// All passes did already run for the function. Pop it off the worklist.
FunctionWorklist.pop_back();
continue;
}
assert(!shouldRestartPipeline() &&
"Did not expect function pipeline set up to restart from beginning!");
runPassOnFunction(FromTransIdx + PipelineIdx, F);
// Note: Don't get entry reference prior to runPassOnFunction().
// A pass can push a new function to the worklist which may cause a
// reallocation of the buffer and that would invalidate the reference.
WorklistEntry &Entry = FunctionWorklist[TailIdx];
if (shouldRestartPipeline() && Entry.NumRestarts < MaxNumRestarts) {
++Entry.NumRestarts;
Entry.PipelineIdx = 0;
} else {
++Entry.PipelineIdx;
}
clearRestartPipeline();
}
}
void SILPassManager::runModulePass(unsigned TransIdx) {
auto *SMT = cast<SILModuleTransform>(Transformations[TransIdx]);
if (isDisabled(SMT))
return;
const SILOptions &Options = getOptions();
SMT->injectPassManager(this);
SMT->injectModule(Mod);
PrettyStackTraceSILModuleTransform X(SMT, NumPassesRun);
DebugPrintEnabler DebugPrint(NumPassesRun);
updateSILModuleStatsBeforeTransform(*Mod, SMT, *this, NumPassesRun);
CurrentPassHasInvalidated = false;
numSubpassesRun = 0;
if (SILPrintPassName)
dumpPassInfo("Run module pass", TransIdx);
if (doPrintBefore(SMT, nullptr)) {
dumpPassInfo("*** SIL module before", TransIdx);
printModule(Mod, Options.EmitVerboseSIL);
}
auto MatchFun = [&](const std::string &Str) -> bool {
return SMT->getTag().contains(Str) || SMT->getID().contains(Str);
};
if ((SILVerifyBeforePass.end() != std::find_if(SILVerifyBeforePass.begin(),
SILVerifyBeforePass.end(),
MatchFun)) ||
(SILVerifyAroundPass.end() != std::find_if(SILVerifyAroundPass.begin(),
SILVerifyAroundPass.end(),
MatchFun))) {
Mod->verify(getAnalysis<BasicCalleeAnalysis>()->getCalleeCache());
verifyAnalyses();
runSwiftModuleVerification();
}
swiftPassInvocation.startModulePassRun(SMT);
llvm::sys::TimePoint<> StartTime = std::chrono::system_clock::now();
assert(analysesUnlocked() && "Expected all analyses to be unlocked!");
SMT->run();
assert(analysesUnlocked() && "Expected all analyses to be unlocked!");
if (!CurrentPassHasInvalidated && Mod->hasInstructionsScheduledForDeletion()) {
// Last chance for invalidating analysis if the pass forgot to call invalidateAnalysis.
invalidateAllAnalysis();
}
Mod->flushDeletedInsts();
swiftPassInvocation.finishedModulePassRun();
std::chrono::nanoseconds duration = std::chrono::system_clock::now() - StartTime;
totalPassRuntime += duration;
if (SILPrintPassTime) {
double milliSecs = (double)duration.count() / 1000000.;
if (milliSecs > (double)SILMinPassTime) {
llvm::dbgs() << llvm::format("%9.3f", milliSecs) << " ms: " << SMT->getTag()
<< " #" << NumPassesRun << "\n";
}
}
// If this pass invalidated anything, print and verify.
if (doPrintAfter(SMT, nullptr, CurrentPassHasInvalidated)) {
dumpPassInfo("*** SIL module after", TransIdx);
printModule(Mod, Options.EmitVerboseSIL);
}
updateSILModuleStatsAfterTransform(*Mod, SMT, *this, NumPassesRun, duration.count());
if (Options.VerifyAll &&
(CurrentPassHasInvalidated || !SILVerifyWithoutInvalidation)) {
Mod->verify(getAnalysis<BasicCalleeAnalysis>()->getCalleeCache());
verifyAnalyses();
runSwiftModuleVerification();
} else {
if ((SILVerifyAfterPass.end() != std::find_if(SILVerifyAfterPass.begin(),
SILVerifyAfterPass.end(),
MatchFun)) ||
(SILVerifyAroundPass.end() != std::find_if(SILVerifyAroundPass.begin(),
SILVerifyAroundPass.end(),
MatchFun))) {
Mod->verify(getAnalysis<BasicCalleeAnalysis>()->getCalleeCache());
verifyAnalyses();
runSwiftModuleVerification();
}
}
}
void SILPassManager::verifyAnalyses() const {
if (Mod->getOptions().VerifyNone)
return;
for (auto *A : Analyses) {
A->verify();
}
}
void SILPassManager::verifyAnalyses(SILFunction *F) const {
if (Mod->getOptions().VerifyNone)
return;
for (auto *A : Analyses) {
A->verify(F);
}
}
void SILPassManager::executePassPipelinePlan(const SILPassPipelinePlan &Plan) {
for (const SILPassPipeline &Pipeline : Plan.getPipelines()) {
setStageName(Pipeline.Name);
resetAndRemoveTransformations();
for (PassKind Kind : Plan.getPipelinePasses(Pipeline)) {
addPass(Kind);
assert(!Pipeline.isFunctionPassPipeline
|| isa<SILFunctionTransform>(Transformations.back()));
}
execute();
}
}
void SILPassManager::execute() {
const SILOptions &Options = getOptions();
LLVM_DEBUG(llvm::dbgs() << "*** Optimizing the module (" << StageName
<< ") *** \n");
if (SILPrintAll) {
llvm::dbgs() << "*** SIL module before " << StageName << " ***\n";
printModule(Mod, Options.EmitVerboseSIL);
}
// Run the transforms by alternating between function transforms and
// module transforms. We'll queue up all the function transforms
// that we see in a row and then run the entire group of transforms
// on each function in turn. Then we move on to running the next set
// of consecutive module transforms.