LLVM 22.0.0git
LTOCodeGenerator.cpp
Go to the documentation of this file.
1//===-LTOCodeGenerator.cpp - LLVM Link Time Optimizer ---------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the Link Time Optimization library. This library is
10// intended to be used by linker to optimize code at link time.
11//
12//===----------------------------------------------------------------------===//
13
15
16#include "llvm/ADT/Statistic.h"
23#include "llvm/Config/config.h"
24#include "llvm/IR/DataLayout.h"
25#include "llvm/IR/DebugInfo.h"
29#include "llvm/IR/LLVMContext.h"
32#include "llvm/IR/Mangler.h"
33#include "llvm/IR/Module.h"
35#include "llvm/IR/Verifier.h"
36#include "llvm/LTO/LTO.h"
37#include "llvm/LTO/LTOBackend.h"
40#include "llvm/Linker/Linker.h"
53#include "llvm/Transforms/IPO.h"
57#include <optional>
58#include <system_error>
59using namespace llvm;
60
62 return PACKAGE_NAME " version " PACKAGE_VERSION;
63}
64
65namespace llvm {
67 "lto-discard-value-names",
68 cl::desc("Strip names from Value during LTO (other than GlobalValue)."),
69#ifdef NDEBUG
70 cl::init(true),
71#else
72 cl::init(false),
73#endif
75
77 "lto-pass-remarks-with-hotness",
78 cl::desc("With PGO, include profile count in optimization remarks"),
80
83 "lto-pass-remarks-hotness-threshold",
84 cl::desc("Minimum profile count required for an "
85 "optimization remark to be output."
86 " Use 'auto' to apply the threshold from profile summary."),
87 cl::value_desc("uint or 'auto'"), cl::init(0), cl::Hidden);
88
90 RemarksFilename("lto-pass-remarks-output",
91 cl::desc("Output filename for pass remarks"),
92 cl::value_desc("filename"));
93
95 RemarksPasses("lto-pass-remarks-filter",
96 cl::desc("Only record optimization remarks from passes whose "
97 "names match the given regular expression"),
98 cl::value_desc("regex"));
99
101 "lto-pass-remarks-format",
102 cl::desc("The format used for serializing remarks (default: YAML)"),
103 cl::value_desc("format"), cl::init("yaml"));
104
106 LTOStatsFile("lto-stats-file",
107 cl::desc("Save statistics to the specified file"), cl::Hidden);
108
110 "lto-aix-system-assembler",
111 cl::desc("Path to a system assembler, picked up on AIX only"),
112 cl::value_desc("path"));
113
114static cl::opt<bool>
115 LTORunCSIRInstr("cs-profile-generate",
116 cl::desc("Perform context sensitive PGO instrumentation"));
117
119 LTOCSIRProfile("cs-profile-path",
120 cl::desc("Context sensitive profile file path"));
121} // namespace llvm
122
124 : Context(Context), MergedModule(new Module("ld-temp.o", Context)),
125 TheLinker(new Linker(*MergedModule)) {
126 Context.setDiscardValueNames(LTODiscardValueNames);
127 Context.enableDebugTypeODRUniquing();
128
129 Config.CodeModel = std::nullopt;
130 Config.StatsFile = LTOStatsFile;
131 Config.RunCSIRInstr = LTORunCSIRInstr;
132 Config.CSIRProfile = LTOCSIRProfile;
133}
134
136
138 AsmUndefinedRefs.insert_range(Mod->getAsmUndefinedRefs());
139}
140
142 assert(&Mod->getModule().getContext() == &Context &&
143 "Expected module in same context");
144
145 bool ret = TheLinker->linkInModule(Mod->takeModule());
147
148 // We've just changed the input, so let's make sure we verify it.
149 HasVerifiedInput = false;
150
151 return !ret;
152}
153
154void LTOCodeGenerator::setModule(std::unique_ptr<LTOModule> Mod) {
155 assert(&Mod->getModule().getContext() == &Context &&
156 "Expected module in same context");
157
158 AsmUndefinedRefs.clear();
159
160 MergedModule = Mod->takeModule();
161 TheLinker = std::make_unique<Linker>(*MergedModule);
163
164 // We've just changed the input, so let's make sure we verify it.
165 HasVerifiedInput = false;
166}
167
169 Config.Options = Options;
170}
171
173 switch (Debug) {
175 EmitDwarfDebugInfo = false;
176 return;
177
179 EmitDwarfDebugInfo = true;
180 return;
181 }
182 llvm_unreachable("Unknown debug format!");
183}
184
185void LTOCodeGenerator::setOptLevel(unsigned Level) {
186 Config.OptLevel = Level;
187 Config.PTO.LoopVectorization = Config.OptLevel > 1;
188 Config.PTO.SLPVectorization = Config.OptLevel > 1;
189 std::optional<CodeGenOptLevel> CGOptLevelOrNone =
190 CodeGenOpt::getLevel(Config.OptLevel);
191 assert(CGOptLevelOrNone && "Unknown optimization level!");
192 Config.CGOptLevel = *CGOptLevelOrNone;
193}
194
196 if (!determineTarget())
197 return false;
198
199 // We always run the verifier once on the merged module.
200 verifyMergedModuleOnce();
201
202 // mark which symbols can not be internalized
203 applyScopeRestrictions();
204
205 // create output file
206 std::error_code EC;
207 ToolOutputFile Out(Path, EC, sys::fs::OF_None);
208 if (EC) {
209 std::string ErrMsg = "could not open bitcode file for writing: ";
210 ErrMsg += Path.str() + ": " + EC.message();
211 emitError(ErrMsg);
212 return false;
213 }
214
215 // write bitcode to it
216 WriteBitcodeToFile(*MergedModule, Out.os(), ShouldEmbedUselists);
217 Out.os().close();
218
219 if (Out.os().has_error()) {
220 std::string ErrMsg = "could not write bitcode file: ";
221 ErrMsg += Path.str() + ": " + Out.os().error().message();
222 emitError(ErrMsg);
223 Out.os().clear_error();
224 return false;
225 }
226
227 Out.keep();
228 return true;
229}
230
231bool LTOCodeGenerator::useAIXSystemAssembler() {
232 const auto &Triple = TargetMach->getTargetTriple();
233 return Triple.isOSAIX() && Config.Options.DisableIntegratedAS;
234}
235
236bool LTOCodeGenerator::runAIXSystemAssembler(SmallString<128> &AssemblyFile) {
237 assert(useAIXSystemAssembler() &&
238 "Runing AIX system assembler when integrated assembler is available!");
239
240 // Set the system assembler path.
241 SmallString<256> AssemblerPath("/usr/bin/as");
242 if (!llvm::AIXSystemAssemblerPath.empty()) {
244 /* expand_tilde */ true)) {
245 emitError(
246 "Cannot find the assembler specified by lto-aix-system-assembler");
247 return false;
248 }
249 }
250
251 // Setup the LDR_CNTRL variable
252 std::string LDR_CNTRL_var = "LDR_CNTRL=MAXDATA32=0xA0000000@DSA";
253 if (std::optional<std::string> V = sys::Process::GetEnv("LDR_CNTRL"))
254 LDR_CNTRL_var += ("@" + *V);
255
256 // Prepare inputs for the assember.
257 const auto &Triple = TargetMach->getTargetTriple();
258 const char *Arch = Triple.isArch64Bit() ? "-a64" : "-a32";
259 std::string ObjectFileName(AssemblyFile);
260 ObjectFileName[ObjectFileName.size() - 1] = 'o';
262 "/bin/env", LDR_CNTRL_var,
263 AssemblerPath, Arch,
264 "-many", "-o",
265 ObjectFileName, AssemblyFile};
266
267 // Invoke the assembler.
268 int RC = sys::ExecuteAndWait(Args[0], Args);
269
270 // Handle errors.
271 if (RC < -1) {
272 emitError("LTO assembler exited abnormally");
273 return false;
274 }
275 if (RC < 0) {
276 emitError("Unable to invoke LTO assembler");
277 return false;
278 }
279 if (RC > 0) {
280 emitError("LTO assembler invocation returned non-zero");
281 return false;
282 }
283
284 // Cleanup.
285 remove(AssemblyFile.c_str());
286
287 // Fix the output file name.
288 AssemblyFile = ObjectFileName;
289
290 return true;
291}
292
293bool LTOCodeGenerator::compileOptimizedToFile(const char **Name) {
294 if (useAIXSystemAssembler())
296
297 // make unique temp output file to put generated code
298 SmallString<128> Filename;
299
300 auto AddStream =
301 [&](size_t Task,
302 const Twine &ModuleName) -> std::unique_ptr<CachedFileStream> {
303 StringRef Extension(
304 Config.CGFileType == CodeGenFileType::AssemblyFile ? "s" : "o");
305
306 int FD;
307 std::error_code EC =
308 sys::fs::createTemporaryFile("lto-llvm", Extension, FD, Filename);
309 if (EC)
310 emitError(EC.message());
311
312 return std::make_unique<CachedFileStream>(
313 std::make_unique<llvm::raw_fd_ostream>(FD, true));
314 };
315
316 bool genResult = compileOptimized(AddStream, 1);
317
318 if (!genResult) {
319 sys::fs::remove(Twine(Filename));
320 return false;
321 }
322
323 // If statistics were requested, save them to the specified file or
324 // print them out after codegen.
325 if (StatsFile)
326 PrintStatisticsJSON(StatsFile->os());
327 else if (AreStatisticsEnabled())
329
330 if (useAIXSystemAssembler())
331 if (!runAIXSystemAssembler(Filename))
332 return false;
333
334 NativeObjectPath = Filename.c_str();
335 *Name = NativeObjectPath.c_str();
336 return true;
337}
338
339std::unique_ptr<MemoryBuffer>
341 const char *name;
342 if (!compileOptimizedToFile(&name))
343 return nullptr;
344
345 // read .o file into memory buffer
347 name, /*IsText=*/false, /*RequiresNullTerminator=*/false);
348 if (std::error_code EC = BufferOrErr.getError()) {
349 emitError(EC.message());
350 sys::fs::remove(NativeObjectPath);
351 return nullptr;
352 }
353
354 // remove temp files
355 sys::fs::remove(NativeObjectPath);
356
357 return std::move(*BufferOrErr);
358}
359
360bool LTOCodeGenerator::compile_to_file(const char **Name) {
361 if (!optimize())
362 return false;
363
364 return compileOptimizedToFile(Name);
365}
366
367std::unique_ptr<MemoryBuffer> LTOCodeGenerator::compile() {
368 if (!optimize())
369 return nullptr;
370
371 return compileOptimized();
372}
373
374bool LTOCodeGenerator::determineTarget() {
375 if (TargetMach)
376 return true;
377
378 if (MergedModule->getTargetTriple().empty())
379 MergedModule->setTargetTriple(Triple(sys::getDefaultTargetTriple()));
380
381 // create target machine from info for merged modules
382 std::string ErrMsg;
383 MArch = TargetRegistry::lookupTarget(MergedModule->getTargetTriple(), ErrMsg);
384 if (!MArch) {
385 emitError(ErrMsg);
386 return false;
387 }
388
389 // Construct LTOModule, hand over ownership of module and target. Use MAttr as
390 // the default set of features.
391 SubtargetFeatures Features(join(Config.MAttrs, ""));
392 Features.getDefaultSubtargetFeatures(MergedModule->getTargetTriple());
393 FeatureStr = Features.getString();
394 if (Config.CPU.empty())
395 Config.CPU = lto::getThinLTODefaultCPU(MergedModule->getTargetTriple());
396
397 // If data-sections is not explicitly set or unset, set data-sections by
398 // default to match the behaviour of lld and gold plugin.
400 Config.Options.DataSections = true;
401
402 TargetMach = createTargetMachine();
403 assert(TargetMach && "Unable to create target machine");
404
405 return true;
406}
407
408std::unique_ptr<TargetMachine> LTOCodeGenerator::createTargetMachine() {
409 assert(MArch && "MArch is not set!");
410 return std::unique_ptr<TargetMachine>(MArch->createTargetMachine(
411 MergedModule->getTargetTriple(), Config.CPU, FeatureStr, Config.Options,
412 Config.RelocModel, std::nullopt, Config.CGOptLevel));
413}
414
415// If a linkonce global is present in the MustPreserveSymbols, we need to make
416// sure we honor this. To force the compiler to not drop it, we add it to the
417// "llvm.compiler.used" global.
418void LTOCodeGenerator::preserveDiscardableGVs(
419 Module &TheModule,
421 std::vector<GlobalValue *> Used;
422 auto mayPreserveGlobal = [&](GlobalValue &GV) {
423 if (!GV.isDiscardableIfUnused() || GV.isDeclaration() ||
424 !mustPreserveGV(GV))
425 return;
426 if (GV.hasAvailableExternallyLinkage())
427 return emitWarning(
428 (Twine("Linker asked to preserve available_externally global: '") +
429 GV.getName() + "'").str());
430 if (GV.hasInternalLinkage())
431 return emitWarning((Twine("Linker asked to preserve internal global: '") +
432 GV.getName() + "'").str());
433 Used.push_back(&GV);
434 };
435 for (auto &GV : TheModule)
436 mayPreserveGlobal(GV);
437 for (auto &GV : TheModule.globals())
438 mayPreserveGlobal(GV);
439 for (auto &GV : TheModule.aliases())
440 mayPreserveGlobal(GV);
441
442 if (Used.empty())
443 return;
444
445 appendToCompilerUsed(TheModule, Used);
446}
447
448void LTOCodeGenerator::applyScopeRestrictions() {
449 if (ScopeRestrictionsDone)
450 return;
451
452 // Declare a callback for the internalize pass that will ask for every
453 // candidate GlobalValue if it can be internalized or not.
454 Mangler Mang;
455 SmallString<64> MangledName;
456 auto mustPreserveGV = [&](const GlobalValue &GV) -> bool {
457 // Unnamed globals can't be mangled, but they can't be preserved either.
458 if (!GV.hasName())
459 return false;
460
461 // Need to mangle the GV as the "MustPreserveSymbols" StringSet is filled
462 // with the linker supplied name, which on Darwin includes a leading
463 // underscore.
464 MangledName.clear();
465 MangledName.reserve(GV.getName().size() + 1);
466 Mang.getNameWithPrefix(MangledName, &GV, /*CannotUsePrivateLabel=*/false);
467 return MustPreserveSymbols.count(MangledName);
468 };
469
470 // Preserve linkonce value on linker request
471 preserveDiscardableGVs(*MergedModule, mustPreserveGV);
472
473 if (!ShouldInternalize)
474 return;
475
476 if (ShouldRestoreGlobalsLinkage) {
477 // Record the linkage type of non-local symbols so they can be restored
478 // prior
479 // to module splitting.
480 auto RecordLinkage = [&](const GlobalValue &GV) {
481 if (!GV.hasAvailableExternallyLinkage() && !GV.hasLocalLinkage() &&
482 GV.hasName())
483 ExternalSymbols.insert(std::make_pair(GV.getName(), GV.getLinkage()));
484 };
485 for (auto &GV : *MergedModule)
486 RecordLinkage(GV);
487 for (auto &GV : MergedModule->globals())
488 RecordLinkage(GV);
489 for (auto &GV : MergedModule->aliases())
490 RecordLinkage(GV);
491 }
492
493 // Update the llvm.compiler_used globals to force preserving libcalls and
494 // symbols referenced from asm
495 updateCompilerUsed(*MergedModule, *TargetMach, AsmUndefinedRefs);
496
497 internalizeModule(*MergedModule, mustPreserveGV);
498
499 ScopeRestrictionsDone = true;
500}
501
502/// Restore original linkage for symbols that may have been internalized
503void LTOCodeGenerator::restoreLinkageForExternals() {
504 if (!ShouldInternalize || !ShouldRestoreGlobalsLinkage)
505 return;
506
507 assert(ScopeRestrictionsDone &&
508 "Cannot externalize without internalization!");
509
510 if (ExternalSymbols.empty())
511 return;
512
513 auto externalize = [this](GlobalValue &GV) {
514 if (!GV.hasLocalLinkage() || !GV.hasName())
515 return;
516
517 auto I = ExternalSymbols.find(GV.getName());
518 if (I == ExternalSymbols.end())
519 return;
520
521 GV.setLinkage(I->second);
522 };
523
524 llvm::for_each(MergedModule->functions(), externalize);
525 llvm::for_each(MergedModule->globals(), externalize);
526 llvm::for_each(MergedModule->aliases(), externalize);
527}
528
529void LTOCodeGenerator::verifyMergedModuleOnce() {
530 // Only run on the first call.
531 if (HasVerifiedInput)
532 return;
533 HasVerifiedInput = true;
534
535 bool BrokenDebugInfo = false;
536 if (verifyModule(*MergedModule, &dbgs(), &BrokenDebugInfo))
537 report_fatal_error("Broken module found, compilation aborted!");
538 if (BrokenDebugInfo) {
539 emitWarning("Invalid debug info found, debug info will be stripped");
540 StripDebugInfo(*MergedModule);
541 }
542}
543
544void LTOCodeGenerator::finishOptimizationRemarks() {
545 if (DiagnosticOutputFile) {
546 DiagnosticOutputFile->keep();
547 // FIXME: LTOCodeGenerator dtor is not invoked on Darwin
548 DiagnosticOutputFile->os().flush();
549 }
550}
551
552/// Optimize merged modules using various IPO passes
554 if (!this->determineTarget())
555 return false;
556
557 // libLTO parses options late, so re-set them here.
558 Context.setDiscardValueNames(LTODiscardValueNames);
559
560 auto DiagFileOrErr = lto::setupLLVMOptimizationRemarks(
563 if (!DiagFileOrErr) {
564 errs() << "Error: " << toString(DiagFileOrErr.takeError()) << "\n";
565 report_fatal_error("Can't get an output file for the remarks");
566 }
567 DiagnosticOutputFile = std::move(*DiagFileOrErr);
568
569 // Setup output file to emit statistics.
570 auto StatsFileOrErr = lto::setupStatsFile(LTOStatsFile);
571 if (!StatsFileOrErr) {
572 errs() << "Error: " << toString(StatsFileOrErr.takeError()) << "\n";
573 report_fatal_error("Can't get an output file for the statistics");
574 }
575 StatsFile = std::move(StatsFileOrErr.get());
576
577 // Currently there is no support for enabling whole program visibility via a
578 // linker option in the old LTO API, but this call allows it to be specified
579 // via the internal option. Must be done before WPD invoked via the optimizer
580 // pipeline run below.
581 updatePublicTypeTestCalls(*MergedModule,
582 /* WholeProgramVisibilityEnabledInLTO */ false);
584 *MergedModule,
585 /* WholeProgramVisibilityEnabledInLTO */ false,
586 // FIXME: These need linker information via a
587 // TBD new interface.
588 /*DynamicExportSymbols=*/{},
589 /*ValidateAllVtablesHaveTypeInfos=*/false,
590 /*IsVisibleToRegularObj=*/[](StringRef) { return true; });
591
592 // We always run the verifier once on the merged module, the `DisableVerify`
593 // parameter only applies to subsequent verify.
594 verifyMergedModuleOnce();
595
596 // Mark which symbols can not be internalized
597 this->applyScopeRestrictions();
598
599 // Add an appropriate DataLayout instance for this module...
600 MergedModule->setDataLayout(TargetMach->createDataLayout());
601
602 if (!SaveIRBeforeOptPath.empty()) {
603 std::error_code EC;
604 raw_fd_ostream OS(SaveIRBeforeOptPath, EC, sys::fs::OF_None);
605 if (EC)
606 report_fatal_error(Twine("Failed to open ") + SaveIRBeforeOptPath +
607 " to save optimized bitcode\n");
608 WriteBitcodeToFile(*MergedModule, OS,
609 /* ShouldPreserveUseListOrder */ true);
610 }
611
612 ModuleSummaryIndex CombinedIndex(false);
613 TargetMach = createTargetMachine();
614 if (!opt(Config, TargetMach.get(), 0, *MergedModule, /*IsThinLTO=*/false,
615 /*ExportSummary=*/&CombinedIndex, /*ImportSummary=*/nullptr,
616 /*CmdArgs*/ std::vector<uint8_t>())) {
617 emitError("LTO middle-end optimizations failed");
618 return false;
619 }
620
621 return true;
622}
623
625 unsigned ParallelismLevel) {
626 if (!this->determineTarget())
627 return false;
628
629 // We always run the verifier once on the merged module. If it has already
630 // been called in optimize(), this call will return early.
631 verifyMergedModuleOnce();
632
633 // Re-externalize globals that may have been internalized to increase scope
634 // for splitting
635 restoreLinkageForExternals();
636
637 ModuleSummaryIndex CombinedIndex(false);
638
639 Config.CodeGenOnly = true;
640 Error Err = backend(Config, AddStream, ParallelismLevel, *MergedModule,
641 CombinedIndex);
642 assert(!Err && "unexpected code-generation failure");
643 (void)Err;
644
645 // If statistics were requested, save them to the specified file or
646 // print them out after codegen.
647 if (StatsFile)
648 PrintStatisticsJSON(StatsFile->os());
649 else if (AreStatisticsEnabled())
651
653
654 finishOptimizationRemarks();
655
656 return true;
657}
658
660 for (StringRef Option : Options)
661 CodegenOptions.push_back(Option.str());
662}
663
665 if (!CodegenOptions.empty())
666 llvm::parseCommandLineOptions(CodegenOptions);
667}
668
669void llvm::parseCommandLineOptions(std::vector<std::string> &Options) {
670 if (!Options.empty()) {
671 // ParseCommandLineOptions() expects argv[0] to be program name.
672 std::vector<const char *> CodegenArgv(1, "libLLVMLTO");
673 for (std::string &Arg : Options)
674 CodegenArgv.push_back(Arg.c_str());
675 cl::ParseCommandLineOptions(CodegenArgv.size(), CodegenArgv.data());
676 }
677}
678
680 // Map the LLVM internal diagnostic severity to the LTO diagnostic severity.
682 switch (DI.getSeverity()) {
683 case DS_Error:
684 Severity = LTO_DS_ERROR;
685 break;
686 case DS_Warning:
687 Severity = LTO_DS_WARNING;
688 break;
689 case DS_Remark:
690 Severity = LTO_DS_REMARK;
691 break;
692 case DS_Note:
693 Severity = LTO_DS_NOTE;
694 break;
695 }
696 // Create the string that will be reported to the external diagnostic handler.
697 std::string MsgStorage;
698 raw_string_ostream Stream(MsgStorage);
700 DI.print(DP);
701 Stream.flush();
702
703 // If this method has been called it means someone has set up an external
704 // diagnostic handler. Assert on that.
705 assert(DiagHandler && "Invalid diagnostic handler");
706 (*DiagHandler)(Severity, MsgStorage.c_str(), DiagContext);
707}
708
709namespace {
710struct LTODiagnosticHandler : public DiagnosticHandler {
711 LTOCodeGenerator *CodeGenerator;
712 LTODiagnosticHandler(LTOCodeGenerator *CodeGenPtr)
713 : CodeGenerator(CodeGenPtr) {}
714 bool handleDiagnostics(const DiagnosticInfo &DI) override {
715 CodeGenerator->DiagnosticHandler(DI);
716 return true;
717 }
718};
719}
720
721void
723 void *Ctxt) {
724 this->DiagHandler = DiagHandler;
725 this->DiagContext = Ctxt;
726 if (!DiagHandler)
727 return Context.setDiagnosticHandler(nullptr);
728 // Register the LTOCodeGenerator stub in the LLVMContext to forward the
729 // diagnostic to the external DiagHandler.
730 Context.setDiagnosticHandler(std::make_unique<LTODiagnosticHandler>(this),
731 true);
732}
733
734namespace {
735class LTODiagnosticInfo : public DiagnosticInfo {
736 const Twine &Msg;
737public:
738 LTODiagnosticInfo(const Twine &DiagMsg LLVM_LIFETIME_BOUND,
739 DiagnosticSeverity Severity = DS_Error)
740 : DiagnosticInfo(DK_Linker, Severity), Msg(DiagMsg) {}
741 void print(DiagnosticPrinter &DP) const override { DP << Msg; }
742};
743}
744
745void LTOCodeGenerator::emitError(const std::string &ErrMsg) {
746 if (DiagHandler)
747 (*DiagHandler)(LTO_DS_ERROR, ErrMsg.c_str(), DiagContext);
748 else
749 Context.diagnose(LTODiagnosticInfo(ErrMsg));
750}
751
752void LTOCodeGenerator::emitWarning(const std::string &ErrMsg) {
753 if (DiagHandler)
754 (*DiagHandler)(LTO_DS_WARNING, ErrMsg.c_str(), DiagContext);
755 else
756 Context.diagnose(LTODiagnosticInfo(ErrMsg, DS_Warning));
757}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static bool mustPreserveGV(const GlobalValue &GV)
Predicate for Internalize pass.
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
#define LLVM_LIFETIME_BOUND
Definition Compiler.h:435
static ManagedStatic< cl::opt< bool, true >, CreateDebug > Debug
Definition Debug.cpp:147
This file implements a simple parser to decode commandline option for remarks hotness threshold that ...
Module.h This file contains the declarations for the Module class.
static LVOptions Options
Definition LVOptions.cpp:25
#define I(x, y, z)
Definition MD5.cpp:58
static std::unique_ptr< TargetMachine > createTargetMachine(Function *F, CodeGenOptLevel OptLevel)
Create the TargetMachine object to query the backend for optimization preferences.
This header defines classes/functions to handle pass execution timing information with interfaces for...
Provides a library for accessing information about this process and other processes on the operating ...
static const char * name
static void externalize(GlobalValue *GV)
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
This file contains some functions that are useful when dealing with strings.
This pass exposes codegen information to IR-level passes.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:41
This is the base abstract class for diagnostic reporting in the backend.
DiagnosticSeverity getSeverity() const
virtual void print(DiagnosticPrinter &DP) const =0
Print using the given DP a user-friendly message.
Basic diagnostic printer that uses an underlying raw_ostream.
Interface for custom diagnostic printing.
Represents either an error or a value T.
Definition ErrorOr.h:56
std::error_code getError() const
Definition ErrorOr.h:152
Lightweight error class with error context and mandatory checking.
Definition Error.h:159
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
This class provides the core functionality of linking in LLVM.
Definition Linker.h:23
LLVM_ABI void getNameWithPrefix(raw_ostream &OS, const GlobalValue *GV, bool CannotUsePrivateLabel) const
Print the appropriate prefix and the specified global variable's name.
Definition Mangler.cpp:121
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFile(const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful,...
Class to hold module path string table and global value map, and encapsulate methods for operating on...
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:67
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition SmallString.h:26
void reserve(size_type N)
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
Manages the enabling and disabling of subtarget specific features.
unsigned DataSections
Emit data into separate sections.
unsigned DisableIntegratedAS
Disable the integrated assembler.
This class contains a raw_fd_ostream and adds a few extra features commonly needed for compiler-like ...
void keep()
Indicate that the tool's job wrt this output file has been successful and the file should not be dele...
raw_fd_ostream & os()
Return the contained raw_fd_ostream.
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
bool isOSAIX() const
Tests whether the OS is AIX.
Definition Triple.h:760
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
An efficient, type-erasing, non-owning reference to a callable.
A raw_ostream that writes to a file descriptor.
bool has_error() const
Return the value of the flag in this raw_fd_ostream indicating whether an output error has been encou...
std::error_code error() const
void close()
Manually flush the stream and close the file.
void clear_error()
Set the flag read by has_error() to false.
A raw_ostream that writes to an std::string.
static LLVM_ABI std::optional< std::string > GetEnv(StringRef name)
lto_debug_model
Definition lto.h:79
lto_codegen_diagnostic_severity_t
Diagnostic severity.
Definition lto.h:345
void(* lto_diagnostic_handler_t)(lto_codegen_diagnostic_severity_t severity, const char *diag, void *ctxt)
Diagnostic handler type.
Definition lto.h:361
@ LTO_DEBUG_MODEL_DWARF
Definition lto.h:81
@ LTO_DEBUG_MODEL_NONE
Definition lto.h:80
@ LTO_DS_REMARK
Definition lto.h:348
@ LTO_DS_WARNING
Definition lto.h:347
@ LTO_DS_NOTE
Definition lto.h:349
@ LTO_DS_ERROR
Definition lto.h:346
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
std::optional< CodeGenOptLevel > getLevel(int OL)
Get the Level identified by the integer OL.
Definition CodeGen.h:93
initializer< Ty > init(const Ty &Val)
LLVM_ABI bool ParseCommandLineOptions(int argc, const char *const *argv, StringRef Overview="", raw_ostream *Errs=nullptr, vfs::FileSystem *VFS=nullptr, const char *EnvVar=nullptr, bool LongOptionsUseDoubleDash=false)
LLVM_ABI std::optional< bool > getExplicitDataSections()
LLVM_ABI StringLiteral getThinLTODefaultCPU(const Triple &TheTriple)
Definition LTO.cpp:1807
LLVM_ABI Expected< std::unique_ptr< ToolOutputFile > > setupStatsFile(StringRef StatsFilename)
Setups the output file for saving statistics.
Definition LTO.cpp:2205
LLVM_ABI Expected< std::unique_ptr< ToolOutputFile > > setupLLVMOptimizationRemarks(LLVMContext &Context, StringRef RemarksFilename, StringRef RemarksPasses, StringRef RemarksFormat, bool RemarksWithHotness, std::optional< uint64_t > RemarksHotnessThreshold=0, int Count=-1)
Setup optimization remarks.
Definition LTO.cpp:2180
LLVM_ABI std::error_code remove(const Twine &path, bool IgnoreNonExisting=true)
Remove path.
LLVM_ABI std::error_code real_path(const Twine &path, SmallVectorImpl< char > &output, bool expand_tilde=false)
Collapse all .
LLVM_ABI std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix, int &ResultFD, SmallVectorImpl< char > &ResultPath, OpenFlags Flags=OF_None)
Create a file in the system temporary directory.
Definition Path.cpp:863
LLVM_ABI std::string getDefaultTargetTriple()
getDefaultTargetTriple() - Return the default target triple the compiler has been configured to produ...
LLVM_ABI int ExecuteAndWait(StringRef Program, ArrayRef< StringRef > Args, std::optional< ArrayRef< StringRef > > Env=std::nullopt, ArrayRef< std::optional< StringRef > > Redirects={}, unsigned SecondsToWait=0, unsigned MemoryLimit=0, std::string *ErrMsg=nullptr, bool *ExecutionFailed=nullptr, std::optional< ProcessStatistics > *ProcStat=nullptr, BitVector *AffinityMask=nullptr)
This function executes the program using the arguments provided.
Definition Program.cpp:32
This is an optimization pass for GlobalISel generic memory operations.
cl::opt< std::string > RemarksFormat("lto-pass-remarks-format", cl::desc("The format used for serializing remarks (default: YAML)"), cl::value_desc("format"), cl::init("yaml"))
UnaryFunction for_each(R &&Range, UnaryFunction F)
Provide wrappers to std::for_each which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1698
cl::opt< bool > LTODiscardValueNames("lto-discard-value-names", cl::desc("Strip names from Value during LTO (other than GlobalValue)."), cl::init(false), cl::Hidden)
LLVM_ABI void WriteBitcodeToFile(const Module &M, raw_ostream &Out, bool ShouldPreserveUseListOrder=false, const ModuleSummaryIndex *Index=nullptr, bool GenerateHash=false, ModuleHash *ModHash=nullptr)
Write the specified module to the specified raw output stream.
bool internalizeModule(Module &TheModule, std::function< bool(const GlobalValue &)> MustPreserveGV)
Helper function to internalize functions and variables in a Module.
Definition Internalize.h:78
static cl::opt< std::string > LTOCSIRProfile("cs-profile-path", cl::desc("Context sensitive profile file path"))
cl::opt< std::string > RemarksPasses("lto-pass-remarks-filter", cl::desc("Only record optimization remarks from passes whose " "names match the given regular expression"), cl::value_desc("regex"))
void updateCompilerUsed(Module &TheModule, const TargetMachine &TM, const StringSet<> &AsmUndefinedRefs)
Find all globals in TheModule that are referenced in AsmUndefinedRefs, as well as the user-supplied f...
LLVM_ABI void reportAndResetTimings(raw_ostream *OutStream=nullptr)
If -time-passes has been specified, report the timings immediately and then reset the timers to zero.
static cl::opt< std::string > AIXSystemAssemblerPath("lto-aix-system-assembler", cl::desc("Path to a system assembler, picked up on AIX only"), cl::value_desc("path"))
LLVM_ABI void updatePublicTypeTestCalls(Module &M, bool WholeProgramVisibilityEnabledInLTO)
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:207
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:167
LLVM_ABI bool AreStatisticsEnabled()
Check if statistics are enabled.
cl::opt< bool > RemarksWithHotness("lto-pass-remarks-with-hotness", cl::desc("With PGO, include profile count in optimization remarks"), cl::Hidden)
cl::opt< std::string > RemarksFilename("lto-pass-remarks-output", cl::desc("Output filename for pass remarks"), cl::value_desc("filename"))
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
LLVM_ABI void parseCommandLineOptions(std::vector< std::string > &Options)
A convenience function that calls cl::ParseCommandLineOptions on the given set of options.
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
LLVM_ABI bool StripDebugInfo(Module &M)
Strip debug info in the module if it exists.
@ Mod
The access may modify the value stored in memory.
Definition ModRef.h:34
std::string join(IteratorT Begin, IteratorT End, StringRef Separator)
Joins the strings in the range [Begin, End), adding Separator between the elements.
LLVM_ABI void PrintStatistics()
Print statistics to the file returned by CreateInfoOutputFile().
LLVM_ABI void appendToCompilerUsed(Module &M, ArrayRef< GlobalValue * > Values)
Adds global values to the llvm.compiler.used list.
std::string toString(const APInt &I, unsigned Radix, bool Signed, bool formatAsCLiteral=false, bool UpperCase=true, bool InsertSeparators=false)
DiagnosticSeverity
Defines the different supported severity of a diagnostic.
cl::opt< std::optional< uint64_t >, false, remarks::HotnessThresholdParser > RemarksHotnessThreshold("lto-pass-remarks-hotness-threshold", cl::desc("Minimum profile count required for an " "optimization remark to be output." " Use 'auto' to apply the threshold from profile summary."), cl::value_desc("uint or 'auto'"), cl::init(0), cl::Hidden)
static cl::opt< std::string > LTOStatsFile("lto-stats-file", cl::desc("Save statistics to the specified file"), cl::Hidden)
std::function< Expected< std::unique_ptr< CachedFileStream > >( unsigned Task, const Twine &ModuleName)> AddStreamFn
This type defines the callback to add a file that is generated on the fly.
Definition Caching.h:59
LLVM_ABI void PrintStatisticsJSON(raw_ostream &OS)
Print statistics in JSON format.
static cl::opt< bool > LTORunCSIRInstr("cs-profile-generate", cl::desc("Perform context sensitive PGO instrumentation"))
LLVM_ABI void updateVCallVisibilityInModule(Module &M, bool WholeProgramVisibilityEnabledInLTO, const DenseSet< GlobalValue::GUID > &DynamicExportSymbols, bool ValidateAllVtablesHaveTypeInfos, function_ref< bool(StringRef)> IsVisibleToRegularObj)
If whole program visibility asserted, then upgrade all public vcall visibility metadata on vtable def...
LLVM_ABI bool verifyModule(const Module &M, raw_ostream *OS=nullptr, bool *BrokenDebugInfo=nullptr)
Check a module for errors.
#define NDEBUG
Definition regutils.h:48
This is the base class for diagnostic handling in LLVM.
C++ class which implements the opaque lto_code_gen_t type.
LLVM_ABI bool optimize()
Optimizes the merged module.
LLVM_ABI std::unique_ptr< MemoryBuffer > compile()
As with compile_to_file(), this function compiles the merged module into single output file.
LLVM_ABI void setModule(std::unique_ptr< LTOModule > M)
Set the destination module.
LLVM_ABI bool compile_to_file(const char **Name)
Compile the merged module into a single output file; the path to output file is returned to the calle...
LLVM_ABI void parseCodeGenDebugOptions()
Parse the options set in setCodeGenDebugOptions.
LLVM_ABI void setOptLevel(unsigned OptLevel)
LLVM_ABI void setAsmUndefinedRefs(struct LTOModule *)
LLVM_ABI void setDiagnosticHandler(lto_diagnostic_handler_t, void *)
void setFileType(CodeGenFileType FT)
Set the file type to be emitted (assembly or object code).
LLVM_ABI void setTargetOptions(const TargetOptions &Options)
LLVM_ABI void setCodeGenDebugOptions(ArrayRef< StringRef > Opts)
Pass options to the driver and optimization passes.
LLVM_ABI LTOCodeGenerator(LLVMContext &Context)
LLVM_ABI std::unique_ptr< MemoryBuffer > compileOptimized()
Compiles the merged optimized module into a single output file.
LLVM_ABI bool addModule(struct LTOModule *)
Merge given module.
LLVM_ABI void setDebugInfo(lto_debug_model)
LLVM_ABI ~LTOCodeGenerator()
LLVM_ABI bool writeMergedModules(StringRef Path)
Write the merged module to the file specified by the given path.
LLVM_ABI void DiagnosticHandler(const DiagnosticInfo &DI)
static LLVM_ABI const char * getVersionString()
C++ class which implements the opaque lto_module_t type.
Definition LTOModule.h:39
static const Target * lookupTarget(StringRef TripleStr, std::string &Error)
lookupTarget - Lookup a target based on a target triple.
std::vector< std::string > MAttrs
Definition Config.h:51
std::string CPU
Definition Config.h:49
TargetOptions Options
Definition Config.h:50