LLVM 22.0.0git
LTOBackend.h
Go to the documentation of this file.
1//===-LTOBackend.h - LLVM Link Time Optimizer Backend ---------------------===//
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 "backend" phase of LTO, i.e. it performs
10// optimization and code generation on a loaded module. It is generally used
11// internally by the LTO class but can also be used independently, for example
12// to implement a standalone ThinLTO backend.
13//
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_LTO_LTOBACKEND_H
17#define LLVM_LTO_LTOBACKEND_H
18
19#include "llvm/ADT/MapVector.h"
22#include "llvm/LTO/LTO.h"
27
28namespace llvm {
29
30class BitcodeModule;
31class Error;
32class Module;
33class Target;
34
35namespace lto {
36
37/// Runs middle-end LTO optimizations on \p Mod.
38LLVM_ABI bool opt(const Config &Conf, TargetMachine *TM, unsigned Task,
39 Module &Mod, bool IsThinLTO,
40 ModuleSummaryIndex *ExportSummary,
41 const ModuleSummaryIndex *ImportSummary,
42 const std::vector<uint8_t> &CmdArgs);
43
44/// Runs a regular LTO backend. The regular LTO backend can also act as the
45/// regular LTO phase of ThinLTO, which may need to access the combined index.
46LLVM_ABI Error backend(const Config &C, AddStreamFn AddStream,
47 unsigned ParallelCodeGenParallelismLevel, Module &M,
48 ModuleSummaryIndex &CombinedIndex);
49
50/// Runs a ThinLTO backend.
51/// If \p ModuleMap is not nullptr, all the module files to be imported have
52/// already been mapped to memory and the corresponding BitcodeModule objects
53/// are saved in the ModuleMap. If \p ModuleMap is nullptr, module files will
54/// be mapped to memory on demand and at any given time during importing, only
55/// one source module will be kept open at the most. If \p CodeGenOnly is true,
56/// the backend will skip optimization and only perform code generation. If
57/// \p IRAddStream is not nullptr, it will be called just before code generation
58/// to serialize the optimized IR.
60thinBackend(const Config &C, unsigned Task, AddStreamFn AddStream, Module &M,
61 const ModuleSummaryIndex &CombinedIndex,
62 const FunctionImporter::ImportMapTy &ImportList,
63 const GVSummaryMapTy &DefinedGlobals,
64 MapVector<StringRef, BitcodeModule> *ModuleMap, bool CodeGenOnly,
65 AddStreamFn IRAddStream = nullptr,
66 const std::vector<uint8_t> &CmdArgs = std::vector<uint8_t>());
67
69finalizeOptimizationRemarks(std::unique_ptr<ToolOutputFile> DiagOutputFile);
70
71/// Returns the BitcodeModule that is ThinLTO.
72LLVM_ABI BitcodeModule *findThinLTOModule(MutableArrayRef<BitcodeModule> BMs);
73
74/// Variant of the above.
75LLVM_ABI Expected<BitcodeModule> findThinLTOModule(MemoryBufferRef MBRef);
76
77/// Distributed ThinLTO: collect the referenced modules based on
78/// module summary and initialize ImportList. Returns false if the
79/// operation failed.
80LLVM_ABI bool initImportList(const Module &M,
81 const ModuleSummaryIndex &CombinedIndex,
82 FunctionImporter::ImportMapTy &ImportList);
83}
84}
85
86#endif
arm prera ldst opt
#define LLVM_ABI
Definition: Compiler.h:213
Machine Check Debug Module
This file implements a map that provides insertion order iteration.
ModuleSummaryIndex.h This file contains the declarations the classes that hold the module index and s...
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
LLVM_ABI BitcodeModule * findThinLTOModule(MutableArrayRef< BitcodeModule > BMs)
Returns the BitcodeModule that is ThinLTO.
Definition: LTOBackend.cpp:730
LLVM_ABI Error backend(const Config &C, AddStreamFn AddStream, unsigned ParallelCodeGenParallelismLevel, Module &M, ModuleSummaryIndex &CombinedIndex)
Runs a regular LTO backend.
Definition: LTOBackend.cpp:552
LLVM_ABI Error finalizeOptimizationRemarks(std::unique_ptr< ToolOutputFile > DiagOutputFile)
Definition: LTOBackend.cpp:541
LLVM_ABI bool initImportList(const Module &M, const ModuleSummaryIndex &CombinedIndex, FunctionImporter::ImportMapTy &ImportList)
Distributed ThinLTO: collect the referenced modules based on module summary and initialize ImportList...
Definition: LTOBackend.cpp:756
LLVM_ABI Error thinBackend(const Config &C, unsigned Task, AddStreamFn AddStream, Module &M, const ModuleSummaryIndex &CombinedIndex, const FunctionImporter::ImportMapTy &ImportList, const GVSummaryMapTy &DefinedGlobals, MapVector< StringRef, BitcodeModule > *ModuleMap, bool CodeGenOnly, AddStreamFn IRAddStream=nullptr, const std::vector< uint8_t > &CmdArgs=std::vector< uint8_t >())
Runs a ThinLTO backend.
Definition: LTOBackend.cpp:599
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
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:60
@ Mod
The access may modify the value stored in memory.
DenseMap< GlobalValue::GUID, GlobalValueSummary * > GVSummaryMapTy
Map of global value GUID to its summary, used to identify values defined in a particular module,...