Base class for instruction visitors. More...

#include <InstVisitor.h>

Inheritance diagram for llvm::InstVisitor< SubClass, RetTy >:

Collaboration diagram for llvm::InstVisitor< SubClass, RetTy >:

Public Member Functions
template<class Iterator >
void	visit (Iterator Start, Iterator End)
void	visit (Module &M)
void	visit (Function &F)
void	visit (BasicBlock &BB)
void	visit (Module *M)
void	visit (Function *F)
void	visit (BasicBlock *BB)
RetTy	visit (Instruction *I)
RetTy	visit (Instruction &I)
void	visitModule (Module &M)
void	visitFunction (Function &F)
void	visitBasicBlock (BasicBlock &BB)
	HANDLE_BINARY_INST (20, Shl, BinaryOperator) HANDLE_BINARY_INST(21
BinaryOperator	HANDLE_BINARY_INST (22, AShr, BinaryOperator) HANDLE_MEMORY_INST(26
BinaryOperator AllocaInst	HANDLE_MEMORY_INST (27, Load, LoadInst) HANDLE_CAST_INST(33
BinaryOperator AllocaInst TruncInst	HANDLE_CAST_INST (34, ZExt, ZExtInst) HANDLE_CAST_INST(35
BinaryOperator AllocaInst TruncInst SExtInst	HANDLE_CAST_INST (36, FPToUI, FPToUIInst) HANDLE_CAST_INST(37
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst	HANDLE_CAST_INST (38, UIToFP, UIToFPInst) HANDLE_CAST_INST(39
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst	HANDLE_CAST_INST (40, FPTrunc, FPTruncInst) HANDLE_CAST_INST(41
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst	HANDLE_CAST_INST (42, PtrToInt, PtrToIntInst) HANDLE_CAST_INST(43
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst	HANDLE_CAST_INST (44, BitCast, BitCastInst) HANDLE_CAST_INST(45
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst	HANDLE_OTHER_INST (46, ICmp, ICmpInst) HANDLE_OTHER_INST(47
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst	HANDLE_OTHER_INST (48, PHI, PHINode) HANDLE_OTHER_INST(49
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst	HANDLE_OTHER_INST (50, Select, SelectInst) HANDLE_OTHER_INST(51
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction	HANDLE_OTHER_INST (52, UserOp2, Instruction) HANDLE_OTHER_INST(53
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction VAArgInst	HANDLE_OTHER_INST (54, ExtractElement, ExtractElementInst) HANDLE_OTHER_INST(55
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction VAArgInst InsertElementInst	HANDLE_OTHER_INST (56, ShuffleVector, ShuffleVectorInst) HANDLE_OTHER_INST(57
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction VAArgInst InsertElementInst ExtractValueInst	HANDLE_OTHER_INST (58, InsertValue, InsertValueInst) HANDLE_OTHER_INST(59
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction VAArgInst InsertElementInst ExtractValueInst LandingPadInst RetTy	visitReturnInst (ReturnInst &I)
RetTy	visitBranchInst (BranchInst &I)
RetTy	visitSwitchInst (SwitchInst &I)
RetTy	visitIndirectBrInst (IndirectBrInst &I)
RetTy	visitResumeInst (ResumeInst &I)
RetTy	visitUnreachableInst (UnreachableInst &I)
RetTy	visitICmpInst (ICmpInst &I)
RetTy	visitFCmpInst (FCmpInst &I)
RetTy	visitAllocaInst (AllocaInst &I)
RetTy	visitLoadInst (LoadInst &I)
RetTy	visitStoreInst (StoreInst &I)
RetTy	visitAtomicCmpXchgInst (AtomicCmpXchgInst &I)
RetTy	visitAtomicRMWInst (AtomicRMWInst &I)
RetTy	visitFenceInst (FenceInst &I)
RetTy	visitGetElementPtrInst (GetElementPtrInst &I)
RetTy	visitPHINode (PHINode &I)
RetTy	visitTruncInst (TruncInst &I)
RetTy	visitZExtInst (ZExtInst &I)
RetTy	visitSExtInst (SExtInst &I)
RetTy	visitFPTruncInst (FPTruncInst &I)
RetTy	visitFPExtInst (FPExtInst &I)
RetTy	visitFPToUIInst (FPToUIInst &I)
RetTy	visitFPToSIInst (FPToSIInst &I)
RetTy	visitUIToFPInst (UIToFPInst &I)
RetTy	visitSIToFPInst (SIToFPInst &I)
RetTy	visitPtrToIntInst (PtrToIntInst &I)
RetTy	visitIntToPtrInst (IntToPtrInst &I)
RetTy	visitBitCastInst (BitCastInst &I)
RetTy	visitAddrSpaceCastInst (AddrSpaceCastInst &I)
RetTy	visitSelectInst (SelectInst &I)
RetTy	visitVAArgInst (VAArgInst &I)
RetTy	visitExtractElementInst (ExtractElementInst &I)
RetTy	visitInsertElementInst (InsertElementInst &I)
RetTy	visitShuffleVectorInst (ShuffleVectorInst &I)
RetTy	visitExtractValueInst (ExtractValueInst &I)
RetTy	visitInsertValueInst (InsertValueInst &I)
RetTy	visitLandingPadInst (LandingPadInst &I)
RetTy	visitDbgDeclareInst (DbgDeclareInst &I)
RetTy	visitDbgValueInst (DbgValueInst &I)
RetTy	visitDbgInfoIntrinsic (DbgInfoIntrinsic &I)
RetTy	visitMemSetInst (MemSetInst &I)
RetTy	visitMemCpyInst (MemCpyInst &I)
RetTy	visitMemMoveInst (MemMoveInst &I)
RetTy	visitMemTransferInst (MemTransferInst &I)
RetTy	visitMemIntrinsic (MemIntrinsic &I)
RetTy	visitVAStartInst (VAStartInst &I)
RetTy	visitVAEndInst (VAEndInst &I)
RetTy	visitVACopyInst (VACopyInst &I)
RetTy	visitIntrinsicInst (IntrinsicInst &I)
RetTy	visitCallInst (CallInst &I)
RetTy	visitInvokeInst (InvokeInst &I)
RetTy	visitCastInst (CastInst &I)
RetTy	visitBinaryOperator (BinaryOperator &I)
RetTy	visitCmpInst (CmpInst &I)
RetTy	visitTerminatorInst (TerminatorInst &I)
RetTy	visitUnaryInstruction (UnaryInstruction &I)
RetTy	visitCallSite (CallSite CS)
void	visitInstruction (Instruction &I)
Public Attributes
	LShr
BinaryOperator	Alloca
BinaryOperator AllocaInst	Trunc
BinaryOperator AllocaInst TruncInst	SExt
BinaryOperator AllocaInst TruncInst SExtInst	FPToSI
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst	SIToFP
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst	FPExt
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst	IntToPtr
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst	AddrSpaceCast
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst	FCmp
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst	Call
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst	UserOp1
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction	VAArg
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction VAArgInst	InsertElement
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction VAArgInst InsertElementInst	ExtractValue
BinaryOperator AllocaInst TruncInst SExtInst FPToSIInst SIToFPInst FPExtInst IntToPtrInst AddrSpaceCastInst FCmpInst CallInst Instruction VAArgInst InsertElementInst ExtractValueInst	LandingPad

Detailed Description

template<typename SubClass, typename RetTy = void>
class llvm::InstVisitor< SubClass, RetTy >

Base class for instruction visitors.

Instruction visitors are used when you want to perform different actions for different kinds of instructions without having to use lots of casts and a big switch statement (in your code, that is).

To define your own visitor, inherit from this class, specifying your new type for the 'SubClass' template parameter, and "override" visitXXX functions in your class. I say "override" because this class is defined in terms of statically resolved overloading, not virtual functions.

For example, here is a visitor that counts the number of malloc instructions processed:

/ Declare the class. Note that we derive from InstVisitor instantiated / with _our new subclasses_ type. / struct CountAllocaVisitor : public InstVisitor<CountAllocaVisitor> { unsigned Count; CountAllocaVisitor() : Count(0) {}

void visitAllocaInst(AllocaInst &AI) { ++Count; } };

And this class would be used like this: CountAllocaVisitor CAV; CAV.visit(function); NumAllocas = CAV.Count;

The defined has 'visit' methods for Instruction, and also for BasicBlock, Function, and Module, which recursively process all contained instructions.

Note that if you don't implement visitXXX for some instruction type, the visitXXX method for instruction superclass will be invoked. So if instructions are added in the future, they will be automatically supported, if you handle one of their superclasses.

The optional second template argument specifies the type that instruction visitation functions should return. If you specify this, you *MUST* provide an implementation of visitInstruction though!.

Note that this class is specifically designed as a template to avoid virtual function call overhead. Defining and using an InstVisitor is just as efficient as having your own switch statement over the instruction opcode.

Definition at line 81 of file InstVisitor.h.