A basic block represents a single entry single exit section of code. More...

Collaboration diagram for Basic Block:

Functions
LLVM_C_ABI LLVMValueRef	LLVMBasicBlockAsValue (LLVMBasicBlockRef BB)
	Convert a basic block instance to a value type.
LLVM_C_ABI LLVMBool	LLVMValueIsBasicBlock (LLVMValueRef Val)
	Determine whether an LLVMValueRef is itself a basic block.
LLVM_C_ABI LLVMBasicBlockRef	LLVMValueAsBasicBlock (LLVMValueRef Val)
	Convert an LLVMValueRef to an LLVMBasicBlockRef instance.
LLVM_C_ABI const char *	LLVMGetBasicBlockName (LLVMBasicBlockRef BB)
	Obtain the string name of a basic block.
LLVM_C_ABI LLVMValueRef	LLVMGetBasicBlockParent (LLVMBasicBlockRef BB)
	Obtain the function to which a basic block belongs.
LLVM_C_ABI LLVMValueRef	LLVMGetBasicBlockTerminator (LLVMBasicBlockRef BB)
	Obtain the terminator instruction for a basic block.
LLVM_C_ABI unsigned	LLVMCountBasicBlocks (LLVMValueRef Fn)
	Obtain the number of basic blocks in a function.
LLVM_C_ABI void	LLVMGetBasicBlocks (LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks)
	Obtain all of the basic blocks in a function.
LLVM_C_ABI LLVMBasicBlockRef	LLVMGetFirstBasicBlock (LLVMValueRef Fn)
	Obtain the first basic block in a function.
LLVM_C_ABI LLVMBasicBlockRef	LLVMGetLastBasicBlock (LLVMValueRef Fn)
	Obtain the last basic block in a function.
LLVM_C_ABI LLVMBasicBlockRef	LLVMGetNextBasicBlock (LLVMBasicBlockRef BB)
	Advance a basic block iterator.
LLVM_C_ABI LLVMBasicBlockRef	LLVMGetPreviousBasicBlock (LLVMBasicBlockRef BB)
	Go backwards in a basic block iterator.
LLVM_C_ABI LLVMBasicBlockRef	LLVMGetEntryBasicBlock (LLVMValueRef Fn)
	Obtain the basic block that corresponds to the entry point of a function.
LLVM_C_ABI void	LLVMInsertExistingBasicBlockAfterInsertBlock (LLVMBuilderRef Builder, LLVMBasicBlockRef BB)
	Insert the given basic block after the insertion point of the given builder.
LLVM_C_ABI void	LLVMAppendExistingBasicBlock (LLVMValueRef Fn, LLVMBasicBlockRef BB)
	Append the given basic block to the basic block list of the given function.
LLVM_C_ABI LLVMBasicBlockRef	LLVMCreateBasicBlockInContext (LLVMContextRef C, const char *Name)
	Create a new basic block without inserting it into a function.
LLVM_C_ABI LLVMBasicBlockRef	LLVMAppendBasicBlockInContext (LLVMContextRef C, LLVMValueRef Fn, const char *Name)
	Append a basic block to the end of a function.
LLVM_C_ABI	LLVM_ATTRIBUTE_C_DEPRECATED (LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name), "Use of the global context is deprecated, use " "LLVMAppendBasicBlockInContext instead")
	Append a basic block to the end of a function using the global context.
LLVM_C_ABI LLVMBasicBlockRef	LLVMInsertBasicBlockInContext (LLVMContextRef C, LLVMBasicBlockRef BB, const char *Name)
	Insert a basic block in a function before another basic block.
LLVM_C_ABI	LLVM_ATTRIBUTE_C_DEPRECATED (LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB, const char *Name), "Use of the global context is deprecated, use " "LLVMInsertBasicBlockInContext instead")
	Insert a basic block in a function using the global context.
LLVM_C_ABI void	LLVMDeleteBasicBlock (LLVMBasicBlockRef BB)
	Remove a basic block from a function and delete it.
LLVM_C_ABI void	LLVMRemoveBasicBlockFromParent (LLVMBasicBlockRef BB)
	Remove a basic block from a function.
LLVM_C_ABI void	LLVMMoveBasicBlockBefore (LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos)
	Move a basic block to before another one.
LLVM_C_ABI void	LLVMMoveBasicBlockAfter (LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos)
	Move a basic block to after another one.
LLVM_C_ABI LLVMValueRef	LLVMGetFirstInstruction (LLVMBasicBlockRef BB)
	Obtain the first instruction in a basic block.
LLVM_C_ABI LLVMValueRef	LLVMGetLastInstruction (LLVMBasicBlockRef BB)
	Obtain the last instruction in a basic block.

Detailed Description

A basic block represents a single entry single exit section of code.

Basic blocks contain a list of instructions which form the body of the block.

Basic blocks belong to functions. They have the type of label.

Basic blocks are themselves values. However, the C API models them as LLVMBasicBlockRef.

See also: llvm::BasicBlock

Function Documentation

◆ LLVM_ATTRIBUTE_C_DEPRECATED() [1/2]

LLVM_C_ABI LLVM_ATTRIBUTE_C_DEPRECATED	(	LLVMBasicBlockRef	LLVMAppendBasicBlockLLVMValueRef Fn, const char *Name,
		"Use of the global context is	deprecated,
		use " "LLVMAppendBasicBlockInContext instead"	)

Append a basic block to the end of a function using the global context.

See also: llvm::BasicBlock::Create()

References C(), const, LLVM_ATTRIBUTE_C_DEPRECATED, LLVM_C_ABI, LLVMAppendBasicBlock(), and LLVMInsertBasicBlockInContext().

◆ LLVM_ATTRIBUTE_C_DEPRECATED() [2/2]

LLVM_C_ABI LLVM_ATTRIBUTE_C_DEPRECATED	(	LLVMBasicBlockRef	LLVMInsertBasicBlockLLVMBasicBlockRef InsertBeforeBB, const char *Name,
		"Use of the global context is	deprecated,
		use " "LLVMInsertBasicBlockInContext instead"	)

Insert a basic block in a function using the global context.

See also: llvm::BasicBlock::Create()

References A(), B(), block, C(), Cond, const, GEP, LLVM_ATTRIBUTE_C_DEPRECATED, LLVM_C_ABI, LLVMAddCallSiteAttribute(), LLVMAddIncoming(), LLVMCountIncoming(), LLVMCreateBuilderInContext(), LLVMDbgRecordGetDebugLoc(), LLVMDbgRecordGetKind(), LLVMDbgVariableRecordGetExpression(), LLVMDbgVariableRecordGetValue(), LLVMDbgVariableRecordGetVariable(), LLVMDeleteBasicBlock(), LLVMDeleteInstruction(), LLVMGEPGetNoWrapFlags(), LLVMGEPSetNoWrapFlags(), LLVMGetAllocatedType(), LLVMGetCallBrDefaultDest(), LLVMGetCallBrIndirectDest(), LLVMGetCallBrNumIndirectDests(), LLVMGetCalledFunctionType(), LLVMGetCalledValue(), LLVMGetCallSiteAttributeCount(), LLVMGetCallSiteAttributes(), LLVMGetCallSiteEnumAttribute(), LLVMGetCallSiteStringAttribute(), LLVMGetCondition(), LLVMGetFCmpPredicate(), LLVMGetFirstDbgRecord(), LLVMGetFirstInstruction(), LLVMGetGEPSourceElementType(), LLVMGetICmpPredicate(), LLVMGetICmpSameSign(), LLVMGetIncomingBlock(), LLVMGetIncomingValue(), LLVMGetIndices(), LLVMGetInstructionCallConv(), LLVMGetInstructionOpcode(), LLVMGetInstructionParent(), LLVMGetLastDbgRecord(), LLVMGetLastInstruction(), LLVMGetMetadata(), LLVMGetNextDbgRecord(), LLVMGetNextInstruction(), LLVMGetNormalDest(), LLVMGetNumArgOperands(), LLVMGetNumIndices(), LLVMGetNumOperandBundles(), LLVMGetNumSuccessors(), LLVMGetOperandBundleAtIndex(), LLVMGetPreviousDbgRecord(), LLVMGetPreviousInstruction(), LLVMGetSuccessor(), LLVMGetSwitchCaseValue(), LLVMGetSwitchDefaultDest(), LLVMGetTailCallKind(), LLVMGetUnwindDest(), LLVMHasMetadata(), LLVMInsertBasicBlock(), LLVMInstructionClone(), LLVMInstructionEraseFromParent(), LLVMInstructionGetAllMetadataOtherThanDebugLoc(), LLVMInstructionRemoveFromParent(), LLVMIsATerminatorInst(), LLVMIsConditional(), LLVMIsInBounds(), LLVMIsTailCall(), LLVMMoveBasicBlockAfter(), LLVMMoveBasicBlockBefore(), LLVMRemoveBasicBlockFromParent(), LLVMRemoveCallSiteEnumAttribute(), LLVMRemoveCallSiteStringAttribute(), LLVMSetCondition(), LLVMSetICmpSameSign(), LLVMSetInstrParamAlignment(), LLVMSetInstructionCallConv(), LLVMSetIsInBounds(), LLVMSetMetadata(), LLVMSetNormalDest(), LLVMSetSuccessor(), LLVMSetSwitchCaseValue(), LLVMSetTailCall(), LLVMSetTailCallKind(), LLVMSetUnwindDest(), and OpIdx.

◆ LLVMAppendBasicBlockInContext()

LLVM_C_ABI LLVMBasicBlockRef LLVMAppendBasicBlockInContext	(	LLVMContextRef	C,
		LLVMValueRef	Fn,
		const char *	Name )

Append a basic block to the end of a function.

See also: llvm::BasicBlock::Create()

Definition at line 2950 of file Core.cpp.

References llvm::CallingConv::C, llvm::BasicBlock::Create(), llvm::unwrap(), and llvm::wrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED(), and LLVMAppendBasicBlock().

◆ LLVMAppendExistingBasicBlock()

LLVM_C_ABI void LLVMAppendExistingBasicBlock	(	LLVMValueRef	Fn,
		LLVMBasicBlockRef	BB )

Append the given basic block to the basic block list of the given function.

See also: llvm::Function::BasicBlockListType::push_back()

Definition at line 2945 of file Core.cpp.

References llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMBasicBlockAsValue()

LLVM_C_ABI LLVMValueRef LLVMBasicBlockAsValue ( LLVMBasicBlockRef BB )

Convert a basic block instance to a value type.

Definition at line 2862 of file Core.cpp.

References llvm::unwrap(), and llvm::wrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMCountBasicBlocks()

LLVM_C_ABI unsigned LLVMCountBasicBlocks ( LLVMValueRef Fn )

Obtain the number of basic blocks in a function.

Parameters

Fn	Function value to operate on.

Definition at line 2886 of file Core.cpp.

References llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMCreateBasicBlockInContext()

LLVM_C_ABI LLVMBasicBlockRef LLVMCreateBasicBlockInContext	(	LLVMContextRef	C,
		const char *	Name )

Create a new basic block without inserting it into a function.

See also: llvm::BasicBlock::Create()

Definition at line 2932 of file Core.cpp.

References llvm::CallingConv::C, llvm::BasicBlock::Create(), llvm::unwrap(), and llvm::wrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMDeleteBasicBlock()

LLVM_C_ABI void LLVMDeleteBasicBlock ( LLVMBasicBlockRef BB )

Remove a basic block from a function and delete it.

This deletes the basic block from its containing function and deletes the basic block itself.

See also: llvm::BasicBlock::eraseFromParent()

Definition at line 2972 of file Core.cpp.

References llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetBasicBlockName()

LLVM_C_ABI const char * LLVMGetBasicBlockName ( LLVMBasicBlockRef BB )

Obtain the string name of a basic block.

Definition at line 2874 of file Core.cpp.

References llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetBasicBlockParent()

LLVM_C_ABI LLVMValueRef LLVMGetBasicBlockParent ( LLVMBasicBlockRef BB )

Obtain the function to which a basic block belongs.

See also: llvm::BasicBlock::getParent()

Definition at line 2878 of file Core.cpp.

References getParent(), llvm::unwrap(), and llvm::wrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetBasicBlocks()

LLVM_C_ABI void LLVMGetBasicBlocks	(	LLVMValueRef	Fn,
		LLVMBasicBlockRef *	BasicBlocks )

Obtain all of the basic blocks in a function.

This operates on a function value. The BasicBlocks parameter is a pointer to a pre-allocated array of LLVMBasicBlockRef of at least LLVMCountBasicBlocks() in length. This array is populated with LLVMBasicBlockRef instances.

Definition at line 2890 of file Core.cpp.

References llvm::unwrap(), and llvm::wrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().