294 lines
12 KiB
C
294 lines
12 KiB
C
|
//===- llvm/Transforms/IPO.h - Interprocedural Transformations --*- C++ -*-===//
|
||
|
|
//
|
||
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
||
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
||
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
// This header file defines prototypes for accessor functions that expose passes
|
||
|
|
// in the IPO transformations library.
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
|
||
|
|
#ifndef LLVM_TRANSFORMS_IPO_H
|
||
|
|
#define LLVM_TRANSFORMS_IPO_H
|
||
|
|
|
||
|
|
#include "llvm/ADT/SmallVector.h"
|
||
|
|
#include <functional>
|
||
|
|
#include <vector>
|
||
|
|
|
||
|
|
namespace llvm {
|
||
|
|
|
||
|
|
struct InlineParams;
|
||
|
|
class StringRef;
|
||
|
|
class ModuleSummaryIndex;
|
||
|
|
class ModulePass;
|
||
|
|
class Pass;
|
||
|
|
class BasicBlock;
|
||
|
|
class GlobalValue;
|
||
|
|
class raw_ostream;
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
// This pass adds !annotation metadata to entries in the
|
||
|
|
// @llvm.global.annotations global constant.
|
||
|
|
//
|
||
|
|
ModulePass *createAnnotation2MetadataLegacyPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
// These functions removes symbols from functions and modules. If OnlyDebugInfo
|
||
|
|
// is true, only debugging information is removed from the module.
|
||
|
|
//
|
||
|
|
ModulePass *createStripSymbolsPass(bool OnlyDebugInfo = false);
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
// These functions strips symbols from functions and modules.
|
||
|
|
// Only debugging information is not stripped.
|
||
|
|
//
|
||
|
|
ModulePass *createStripNonDebugSymbolsPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
// This pass removes llvm.dbg.declare intrinsics.
|
||
|
|
ModulePass *createStripDebugDeclarePass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
// This pass removes unused symbols' debug info.
|
||
|
|
ModulePass *createStripDeadDebugInfoPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createConstantMergePass - This function returns a new pass that merges
|
||
|
|
/// duplicate global constants together into a single constant that is shared.
|
||
|
|
/// This is useful because some passes (ie TraceValues) insert a lot of string
|
||
|
|
/// constants into the program, regardless of whether or not they duplicate an
|
||
|
|
/// existing string.
|
||
|
|
///
|
||
|
|
ModulePass *createConstantMergePass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createGlobalOptimizerPass - This function returns a new pass that optimizes
|
||
|
|
/// non-address taken internal globals.
|
||
|
|
///
|
||
|
|
ModulePass *createGlobalOptimizerPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createGlobalDCEPass - This transform is designed to eliminate unreachable
|
||
|
|
/// internal globals (functions or global variables)
|
||
|
|
///
|
||
|
|
ModulePass *createGlobalDCEPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// This transform is designed to eliminate available external globals
|
||
|
|
/// (functions or global variables)
|
||
|
|
///
|
||
|
|
ModulePass *createEliminateAvailableExternallyPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createGVExtractionPass - If deleteFn is true, this pass deletes
|
||
|
|
/// the specified global values. Otherwise, it deletes as much of the module as
|
||
|
|
/// possible, except for the global values specified. If keepConstInit is true,
|
||
|
|
/// the initializers of global constants are not deleted even if they are
|
||
|
|
/// unused.
|
||
|
|
///
|
||
|
|
ModulePass *createGVExtractionPass(std::vector<GlobalValue*>& GVs, bool
|
||
|
|
deleteFn = false, bool keepConstInit = false);
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// This pass performs iterative function importing from other modules.
|
||
|
|
Pass *createFunctionImportPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createFunctionInliningPass - Return a new pass object that uses a heuristic
|
||
|
|
/// to inline direct function calls to small functions.
|
||
|
|
///
|
||
|
|
/// The Threshold can be passed directly, or asked to be computed from the
|
||
|
|
/// given optimization and size optimization arguments.
|
||
|
|
///
|
||
|
|
/// The -inline-threshold command line option takes precedence over the
|
||
|
|
/// threshold given here.
|
||
|
|
Pass *createFunctionInliningPass();
|
||
|
|
Pass *createFunctionInliningPass(int Threshold);
|
||
|
|
Pass *createFunctionInliningPass(unsigned OptLevel, unsigned SizeOptLevel,
|
||
|
|
bool DisableInlineHotCallSite);
|
||
|
|
Pass *createFunctionInliningPass(InlineParams &Params);
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createPruneEHPass - Return a new pass object which transforms invoke
|
||
|
|
/// instructions into calls, if the callee can _not_ unwind the stack.
|
||
|
|
///
|
||
|
|
Pass *createPruneEHPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createInternalizePass - This pass loops over all of the functions in the
|
||
|
|
/// input module, internalizing all globals (functions and variables) it can.
|
||
|
|
////
|
||
|
|
/// Before internalizing a symbol, the callback \p MustPreserveGV is invoked and
|
||
|
|
/// gives to the client the ability to prevent internalizing specific symbols.
|
||
|
|
///
|
||
|
|
/// The symbol in DSOList are internalized if it is safe to drop them from
|
||
|
|
/// the symbol table.
|
||
|
|
///
|
||
|
|
/// Note that commandline options that are used with the above function are not
|
||
|
|
/// used now!
|
||
|
|
ModulePass *
|
||
|
|
createInternalizePass(std::function<bool(const GlobalValue &)> MustPreserveGV);
|
||
|
|
|
||
|
|
/// createInternalizePass - Same as above, but with an empty exportList.
|
||
|
|
ModulePass *createInternalizePass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createDeadArgEliminationPass - This pass removes arguments from functions
|
||
|
|
/// which are not used by the body of the function.
|
||
|
|
///
|
||
|
|
ModulePass *createDeadArgEliminationPass();
|
||
|
|
|
||
|
|
/// DeadArgHacking pass - Same as DAE, but delete arguments of external
|
||
|
|
/// functions as well. This is definitely not safe, and should only be used by
|
||
|
|
/// bugpoint.
|
||
|
|
ModulePass *createDeadArgHackingPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createArgumentPromotionPass - This pass promotes "by reference" arguments to
|
||
|
|
/// be passed by value if the number of elements passed is smaller or
|
||
|
|
/// equal to maxElements (maxElements == 0 means always promote).
|
||
|
|
///
|
||
|
|
Pass *createArgumentPromotionPass(unsigned maxElements = 3);
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createOpenMPOptLegacyPass - OpenMP specific optimizations.
|
||
|
|
Pass *createOpenMPOptLegacyPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createIPSCCPPass - This pass propagates constants from call sites into the
|
||
|
|
/// bodies of functions, and keeps track of whether basic blocks are executable
|
||
|
|
/// in the process.
|
||
|
|
///
|
||
|
|
ModulePass *createIPSCCPPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
/// createLoopExtractorPass - This pass extracts all natural loops from the
|
||
|
|
/// program into a function if it can.
|
||
|
|
///
|
||
|
|
Pass *createLoopExtractorPass();
|
||
|
|
|
||
|
|
/// createSingleLoopExtractorPass - This pass extracts one natural loop from the
|
||
|
|
/// program into a function if it can. This is used by bugpoint.
|
||
|
|
///
|
||
|
|
Pass *createSingleLoopExtractorPass();
|
||
|
|
|
||
|
|
/// createBlockExtractorPass - This pass extracts all the specified blocks
|
||
|
|
/// from the functions in the module.
|
||
|
|
///
|
||
|
|
ModulePass *createBlockExtractorPass();
|
||
|
|
ModulePass *
|
||
|
|
createBlockExtractorPass(const SmallVectorImpl<BasicBlock *> &BlocksToExtract,
|
||
|
|
bool EraseFunctions);
|
||
|
|
ModulePass *
|
||
|
|
createBlockExtractorPass(const SmallVectorImpl<SmallVector<BasicBlock *, 16>>
|
||
|
|
&GroupsOfBlocksToExtract,
|
||
|
|
bool EraseFunctions);
|
||
|
|
|
||
|
|
/// createStripDeadPrototypesPass - This pass removes any function declarations
|
||
|
|
/// (prototypes) that are not used.
|
||
|
|
ModulePass *createStripDeadPrototypesPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createReversePostOrderFunctionAttrsPass - This pass walks SCCs of the call
|
||
|
|
/// graph in RPO to deduce and propagate function attributes. Currently it
|
||
|
|
/// only handles synthesizing norecurse attributes.
|
||
|
|
///
|
||
|
|
Pass *createReversePostOrderFunctionAttrsPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createMergeFunctionsPass - This pass discovers identical functions and
|
||
|
|
/// collapses them.
|
||
|
|
///
|
||
|
|
ModulePass *createMergeFunctionsPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createHotColdSplittingPass - This pass outlines cold blocks into a separate
|
||
|
|
/// function(s).
|
||
|
|
ModulePass *createHotColdSplittingPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createIROutlinerPass - This pass finds similar code regions and factors
|
||
|
|
/// those regions out into functions.
|
||
|
|
ModulePass *createIROutlinerPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createPartialInliningPass - This pass inlines parts of functions.
|
||
|
|
///
|
||
|
|
ModulePass *createPartialInliningPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// createBarrierNoopPass - This pass is purely a module pass barrier in a pass
|
||
|
|
/// manager.
|
||
|
|
ModulePass *createBarrierNoopPass();
|
||
|
|
|
||
|
|
/// createCalledValuePropagationPass - Attach metadata to indirct call sites
|
||
|
|
/// indicating the set of functions they may target at run-time.
|
||
|
|
ModulePass *createCalledValuePropagationPass();
|
||
|
|
|
||
|
|
/// What to do with the summary when running passes that operate on it.
|
||
|
|
enum class PassSummaryAction {
|
||
|
|
None, ///< Do nothing.
|
||
|
|
Import, ///< Import information from summary.
|
||
|
|
Export, ///< Export information to summary.
|
||
|
|
};
|
||
|
|
|
||
|
|
/// This pass lowers type metadata and the llvm.type.test intrinsic to
|
||
|
|
/// bitsets.
|
||
|
|
///
|
||
|
|
/// The behavior depends on the summary arguments:
|
||
|
|
/// - If ExportSummary is non-null, this pass will export type identifiers to
|
||
|
|
/// the given summary.
|
||
|
|
/// - If ImportSummary is non-null, this pass will import type identifiers from
|
||
|
|
/// the given summary.
|
||
|
|
/// - Otherwise, if both are null and DropTypeTests is true, all type test
|
||
|
|
/// assume sequences will be removed from the IR.
|
||
|
|
/// It is invalid for both ExportSummary and ImportSummary to be non-null
|
||
|
|
/// unless DropTypeTests is true.
|
||
|
|
ModulePass *createLowerTypeTestsPass(ModuleSummaryIndex *ExportSummary,
|
||
|
|
const ModuleSummaryIndex *ImportSummary,
|
||
|
|
bool DropTypeTests = false);
|
||
|
|
|
||
|
|
/// This pass export CFI checks for use by external modules.
|
||
|
|
ModulePass *createCrossDSOCFIPass();
|
||
|
|
|
||
|
|
/// This pass implements whole-program devirtualization using type
|
||
|
|
/// metadata.
|
||
|
|
///
|
||
|
|
/// The behavior depends on the summary arguments:
|
||
|
|
/// - If ExportSummary is non-null, this pass will export type identifiers to
|
||
|
|
/// the given summary.
|
||
|
|
/// - Otherwise, if ImportSummary is non-null, this pass will import type
|
||
|
|
/// identifiers from the given summary.
|
||
|
|
/// - Otherwise it does neither.
|
||
|
|
/// It is invalid for both ExportSummary and ImportSummary to be non-null.
|
||
|
|
ModulePass *
|
||
|
|
createWholeProgramDevirtPass(ModuleSummaryIndex *ExportSummary,
|
||
|
|
const ModuleSummaryIndex *ImportSummary);
|
||
|
|
|
||
|
|
/// This pass splits globals into pieces for the benefit of whole-program
|
||
|
|
/// devirtualization and control-flow integrity.
|
||
|
|
ModulePass *createGlobalSplitPass();
|
||
|
|
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
// SampleProfilePass - Loads sample profile data from disk and generates
|
||
|
|
// IR metadata to reflect the profile.
|
||
|
|
ModulePass *createSampleProfileLoaderPass();
|
||
|
|
ModulePass *createSampleProfileLoaderPass(StringRef Name);
|
||
|
|
|
||
|
|
/// Write ThinLTO-ready bitcode to Str.
|
||
|
|
ModulePass *createWriteThinLTOBitcodePass(raw_ostream &Str,
|
||
|
|
raw_ostream *ThinLinkOS = nullptr);
|
||
|
|
|
||
|
|
} // End llvm namespace
|
||
|
|
|
||
|
|
#endif
|