Provides top-level interfaces for incremental compilation and execution. More...

#include "clang/Interpreter/Interpreter.h"

Classes
struct	JITConfig

Public Member Functions
virtual	~Interpreter ()
const ASTContext &	getASTContext () const
ASTContext &	getASTContext ()
const CompilerInstance *	getCompilerInstance () const
CompilerInstance *	getCompilerInstance ()
llvm::Expected< llvm::orc::LLJIT & >	getExecutionEngine ()
llvm::Expected< PartialTranslationUnit & >	Parse (llvm::StringRef Code)
llvm::Error	Execute (PartialTranslationUnit &T)
llvm::Error	ParseAndExecute (llvm::StringRef Code, Value *V=nullptr)
llvm::Error	Undo (unsigned N=1)
	Undo N previous incremental inputs.
llvm::Error	LoadDynamicLibrary (const char *name)
	Link a dynamic library.
llvm::Expected< llvm::orc::ExecutorAddr >	getSymbolAddress (GlobalDecl GD) const
llvm::Expected< llvm::orc::ExecutorAddr >	getSymbolAddress (llvm::StringRef IRName) const
llvm::Expected< llvm::orc::ExecutorAddr >	getSymbolAddressFromLinkerName (llvm::StringRef LinkerName) const
uint32_t	getOutOfProcessExecutorPID () const

Static Public Member Functions
static llvm::Expected< std::unique_ptr< Interpreter > >	create (std::unique_ptr< CompilerInstance > CI, JITConfig Config={})
static llvm::Expected< std::unique_ptr< Interpreter > >	createWithCUDA (std::unique_ptr< CompilerInstance > CI, std::unique_ptr< CompilerInstance > DCI)
static llvm::Expected< std::unique_ptr< llvm::orc::LLJITBuilder > >	createLLJITBuilder (std::unique_ptr< llvm::orc::ExecutorProcessControl > EPC, llvm::StringRef OrcRuntimePath)
static llvm::Expected< std::pair< std::unique_ptr< llvm::orc::LLJITBuilder >, uint32_t > >	outOfProcessJITBuilder (JITConfig Config)
static llvm::Expected< std::string >	getOrcRuntimePath (const driver::ToolChain &TC)

Protected Member Functions
	Interpreter (std::unique_ptr< CompilerInstance > Instance, llvm::Error &Err, std::unique_ptr< llvm::orc::LLJITBuilder > JITBuilder=nullptr, std::unique_ptr< clang::ASTConsumer > Consumer=nullptr, JITConfig Config=JITConfig())
llvm::Error	CreateExecutor (JITConfig Config=JITConfig())
void	ResetExecutor ()

Friends
class	Value

Detailed Description

Provides top-level interfaces for incremental compilation and execution.

Definition at line 91 of file Interpreter.h.

Constructor & Destructor Documentation

◆ Interpreter()

clang::Interpreter::Interpreter	(	std::unique_ptr< CompilerInstance >	Instance,
		llvm::Error &	Err,
		std::unique_ptr< llvm::orc::LLJITBuilder >	JITBuilder = nullptr,
		std::unique_ptr< clang::ASTConsumer >	Consumer = nullptr,
		JITConfig	Config = JITConfig() )

protected

Definition at line 253 of file Interpreter.cpp.

References clang::C, CreateExecutor(), and Execute().

Referenced by create(), and getCompilerInstance().

◆ ~Interpreter()

clang::Interpreter::~Interpreter ( )

virtual

Definition at line 310 of file Interpreter.cpp.

References toString().

Member Function Documentation

◆ create()

llvm::Expected< std::unique_ptr< Interpreter > > clang::Interpreter::create	(	std::unique_ptr< CompilerInstance >	CI,
		JITConfig	Config = {} )

static

Definition at line 438 of file Interpreter.cpp.

References clang::C, getOrcRuntimePath(), clang::TargetInfo::getTriple(), Interpreter(), clang::Interpreter::JITConfig::IsOutOfProcess, clang::Interpreter::JITConfig::OrcRuntimePath, and clang::Runtimes.

Referenced by createWithCUDA().

◆ CreateExecutor()

llvm::Error clang::Interpreter::CreateExecutor ( JITConfig Config = JITConfig() )

protected

Definition at line 633 of file Interpreter.cpp.

References clang::Interpreter::JITConfig::CM, clang::IncrementalExecutor::createDefaultJITBuilder(), clang::createJITTargetMachineBuilder(), clang::Interpreter::JITConfig::ExecutorPID, getCompilerInstance(), clang::CompilerInstance::getTargetOpts(), clang::Interpreter::JITConfig::IsOutOfProcess, outOfProcessJITBuilder(), and clang::TargetOptions::Triple.

Referenced by Execute(), getExecutionEngine(), and Interpreter().

◆ createLLJITBuilder()

llvm::Expected< std::unique_ptr< llvm::orc::LLJITBuilder > > clang::Interpreter::createLLJITBuilder	(	std::unique_ptr< llvm::orc::ExecutorProcessControl >	EPC,
		llvm::StringRef	OrcRuntimePath )

static

Definition at line 615 of file Interpreter.cpp.

References clang::IncrementalExecutor::createDefaultJITBuilder(), and clang::createJITTargetMachineBuilder().

Referenced by outOfProcessJITBuilder().

◆ createWithCUDA()

llvm::Expected< std::unique_ptr< Interpreter > > clang::Interpreter::createWithCUDA	(	std::unique_ptr< CompilerInstance >	CI,
		std::unique_ptr< CompilerInstance >	DCI )

static

Definition at line 487 of file Interpreter.cpp.

References create().

◆ Execute()

llvm::Error clang::Interpreter::Execute ( PartialTranslationUnit & T )

Definition at line 692 of file Interpreter.cpp.

References CreateExecutor(), and clang::T.

Referenced by Interpreter(), and ParseAndExecute().

◆ getASTContext() [1/2]

ASTContext & clang::Interpreter::getASTContext ( )

Definition at line 546 of file Interpreter.cpp.

References clang::CompilerInstance::getASTContext(), and getCompilerInstance().

◆ getASTContext() [2/2]

const ASTContext & clang::Interpreter::getASTContext ( ) const

Definition at line 550 of file Interpreter.cpp.

References clang::CompilerInstance::getASTContext(), and getCompilerInstance().

Referenced by clang::Value::getASTContext().

◆ getCompilerInstance() [1/2]

CompilerInstance * clang::Interpreter::getCompilerInstance ( )

Definition at line 532 of file Interpreter.cpp.

◆ getCompilerInstance() [2/2]

const CompilerInstance * clang::Interpreter::getCompilerInstance ( ) const

Definition at line 533 of file Interpreter.cpp.

References getCompilerInstance(), and Interpreter().

Referenced by CreateExecutor(), getASTContext(), getASTContext(), getCompilerInstance(), and Parse().

◆ getExecutionEngine()

llvm::Expected< llvm::orc::LLJIT & > clang::Interpreter::getExecutionEngine ( )

Definition at line 537 of file Interpreter.cpp.

References CreateExecutor().

Referenced by LoadDynamicLibrary().

◆ getOrcRuntimePath()

llvm::Expected< std::string > clang::Interpreter::getOrcRuntimePath ( const driver::ToolChain & TC )

static

Definition at line 396 of file Interpreter.cpp.

References clang::Found, clang::driver::ToolChain::getCompilerRTPath(), and clang::driver::ToolChain::getRuntimePath().

Referenced by create().

◆ getOutOfProcessExecutorPID()

uint32_t clang::Interpreter::getOutOfProcessExecutorPID ( ) const

Definition at line 564 of file Interpreter.cpp.

◆ getSymbolAddress() [1/2]

llvm::Expected< llvm::orc::ExecutorAddr > clang::Interpreter::getSymbolAddress ( GlobalDecl GD ) const

Returns: the ExecutorAddr of a GlobalDecl. This interface uses the CodeGenModule's internal mangling cache to avoid recomputing the mangled name.

Definition at line 736 of file Interpreter.cpp.

References getSymbolAddress().

Referenced by getSymbolAddress().

◆ getSymbolAddress() [2/2]

llvm::Expected< llvm::orc::ExecutorAddr > clang::Interpreter::getSymbolAddress ( llvm::StringRef IRName ) const

Returns: the ExecutorAddr of a given name as written in the IR.

Definition at line 746 of file Interpreter.cpp.

References clang::IncrementalExecutor::IRName.

◆ getSymbolAddressFromLinkerName()

llvm::Expected< llvm::orc::ExecutorAddr > clang::Interpreter::getSymbolAddressFromLinkerName ( llvm::StringRef LinkerName ) const

Returns: the ExecutorAddr of a given name as written in the object file.

Definition at line 756 of file Interpreter.cpp.

References clang::IncrementalExecutor::LinkerName.

◆ LoadDynamicLibrary()

llvm::Error clang::Interpreter::LoadDynamicLibrary ( const char * name )

Link a dynamic library.

Definition at line 791 of file Interpreter.cpp.

References getExecutionEngine().

◆ outOfProcessJITBuilder()

llvm::Expected< std::pair< std::unique_ptr< llvm::orc::LLJITBuilder >, uint32_t > > clang::Interpreter::outOfProcessJITBuilder ( JITConfig Config )

static

Definition at line 355 of file Interpreter.cpp.

References createLLJITBuilder(), clang::Interpreter::JITConfig::CustomizeFork, clang::IncrementalExecutor::launchExecutor(), clang::Interpreter::JITConfig::OOPExecutor, clang::Interpreter::JITConfig::OOPExecutorConnect, clang::Interpreter::JITConfig::OrcRuntimePath, clang::Interpreter::JITConfig::SlabAllocateSize, and clang::Interpreter::JITConfig::UseSharedMemory.

Referenced by CreateExecutor().

◆ Parse()

llvm::Expected< PartialTranslationUnit & > clang::Interpreter::Parse ( llvm::StringRef Code )

Definition at line 571 of file Interpreter.cpp.

References getCompilerInstance(), clang::CompilerInstance::getDiagnostics(), clang::diag::Ignored, and clang::DiagnosticsEngine::setSeverity().

◆ ParseAndExecute()

llvm::Error clang::Interpreter::ParseAndExecute	(	llvm::StringRef	Code,
		Value *	V = nullptr )

Definition at line 716 of file Interpreter.cpp.

References Execute(), clang::Parse, V, and Value.

◆ ResetExecutor()

void clang::Interpreter::ResetExecutor ( )

protected

Definition at line 690 of file Interpreter.cpp.

◆ Undo()

llvm::Error clang::Interpreter::Undo ( unsigned N = 1 )

Undo N previous incremental inputs.

Definition at line 765 of file Interpreter.cpp.

◆ Value

friend class Value

friend

Definition at line 92 of file Interpreter.h.

References Value.

Referenced by ParseAndExecute(), and Value.

The documentation for this class was generated from the following files:

include/clang/Interpreter/Interpreter.h
lib/Interpreter/Interpreter.cpp
lib/Interpreter/InterpreterValuePrinter.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Interpreter()

◆ ~Interpreter()

Member Function Documentation

◆ create()

◆ CreateExecutor()

◆ createLLJITBuilder()

◆ createWithCUDA()

◆ Execute()

◆ getASTContext() [1/2]

◆ getASTContext() [2/2]

◆ getCompilerInstance() [1/2]

◆ getCompilerInstance() [2/2]

◆ getExecutionEngine()

◆ getOrcRuntimePath()

◆ getOutOfProcessExecutorPID()

◆ getSymbolAddress() [1/2]

◆ getSymbolAddress() [2/2]

◆ getSymbolAddressFromLinkerName()

◆ LoadDynamicLibrary()

◆ outOfProcessJITBuilder()

◆ Parse()

◆ ParseAndExecute()

◆ ResetExecutor()

◆ Undo()

Friends And Related Symbol Documentation

◆ Value