A template wrapper used to implement the polymorphic API. More...

#include "llvm/IR/PassManagerInternal.h"

Inheritance diagram for llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >:

Public Member Functions
	PassModel (PassT Pass)
	PassModel (const PassModel &Arg)
	PassModel (PassModel &&Arg)
PassModel &	operator= (PassModel RHS)
PreservedAnalyses	run (IRUnitT &IR, AnalysisManagerT &AM, ExtraArgTs... ExtraArgs) override
	The polymorphic API which runs the pass over a given IR entity.
void	printPipeline (raw_ostream &OS, function_ref< StringRef(StringRef)> MapClassName2PassName) override
StringRef	name () const override
	Polymorphic method to access the name of a pass.
bool	isRequired () const override
	Polymorphic method to let a pass optionally exempted from skipping by PassInstrumentation.
Public Member Functions inherited from llvm::detail::PassConcept< IRUnitT, AnalysisManagerT, ExtraArgTs... >
virtual	~PassConcept ()=default

Public Attributes
PassT	Pass

Friends
void	swap (PassModel &LHS, PassModel &RHS)

Detailed Description

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>
struct llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >

A template wrapper used to implement the polymorphic API.

Can be instantiated for any object which provides a run method accepting an IRUnitT& and an AnalysisManager<IRUnit>&. It requires the pass to be a copyable object.

Definition at line 74 of file PassManagerInternal.h.

Constructor & Destructor Documentation

◆ PassModel() [1/3]

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::PassModel ( PassT Pass )

inlineexplicit

Definition at line 75 of file PassManagerInternal.h.

References llvm::move(), and Pass.

Referenced by operator=(), PassModel(), PassModel(), and swap.

◆ PassModel() [2/3]

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::PassModel ( const PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs > & Arg )

inline

Definition at line 78 of file PassManagerInternal.h.

References Pass, and PassModel().

◆ PassModel() [3/3]

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::PassModel ( PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs > && Arg )

inline

Definition at line 79 of file PassManagerInternal.h.

References llvm::move(), Pass, and PassModel().

Member Function Documentation

◆ isRequired()

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

bool llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::isRequired ( ) const

inlineoverridevirtual

Polymorphic method to let a pass optionally exempted from skipping by PassInstrumentation.

To opt-in, pass should implement static bool isRequired(), or inherit from RequiredPassInfoMixin or OptionalPassInfoMixin. It's no-op to have isRequired always return false since that is the default.

Implements llvm::detail::PassConcept< IRUnitT, AnalysisManagerT, ExtraArgTs... >.

Definition at line 104 of file PassManagerInternal.h.

◆ name()

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

StringRef llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::name ( ) const

inlineoverridevirtual

Polymorphic method to access the name of a pass.

Implements llvm::detail::PassConcept< IRUnitT, AnalysisManagerT, ExtraArgTs... >.

Definition at line 102 of file PassManagerInternal.h.

◆ operator=()

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

PassModel & llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::operator= ( PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs > RHS )

inline

Definition at line 86 of file PassManagerInternal.h.

References PassModel(), RHS, and swap.

◆ printPipeline()

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

void llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::printPipeline	(	raw_ostream &	OS,
		function_ref< StringRef(StringRef)>	MapClassName2PassName )

inlineoverridevirtual

Implements llvm::detail::PassConcept< IRUnitT, AnalysisManagerT, ExtraArgTs... >.

Definition at line 96 of file PassManagerInternal.h.

References Pass.

◆ run()

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

PreservedAnalyses llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::run	(	IRUnitT &	IR,
		AnalysisManagerT &	AM,
		ExtraArgTs...	ExtraArgs )

inlineoverridevirtual

The polymorphic API which runs the pass over a given IR entity.

Note that actual pass object can omit the analysis manager argument if desired. Also that the analysis manager may be null if there is no analysis manager in the pass pipeline.

Implements llvm::detail::PassConcept< IRUnitT, AnalysisManagerT, ExtraArgTs... >.

Definition at line 91 of file PassManagerInternal.h.

References IR, and Pass.

◆ swap

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

void swap	(	PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs > &	LHS,
		PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs > &	RHS )

friend

Definition at line 81 of file PassManagerInternal.h.

References LHS, PassModel(), RHS, swap, and std::swap().

Referenced by operator=(), and swap.

Member Data Documentation

◆ Pass

template<typename IRUnitT, typename PassT, typename AnalysisManagerT, typename... ExtraArgTs>

PassT llvm::detail::PassModel< IRUnitT, PassT, AnalysisManagerT, ExtraArgTs >::Pass

Definition at line 106 of file PassManagerInternal.h.

Referenced by PassModel(), PassModel(), PassModel(), printPipeline(), and run().

The documentation for this struct was generated from the following file:

include/llvm/IR/PassManagerInternal.h

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PassModel() [1/3]

◆ PassModel() [2/3]

◆ PassModel() [3/3]

Member Function Documentation

◆ isRequired()

◆ name()

◆ operator=()

◆ printPipeline()

◆ run()

Friends And Related Symbol Documentation

◆ swap

Member Data Documentation

◆ Pass