44#include "llvm/ExecutionEngine/JITSymbol.h"
45#include "llvm/ExecutionEngine/Orc/EPCDynamicLibrarySearchGenerator.h"
46#include "llvm/ExecutionEngine/Orc/LLJIT.h"
47#include "llvm/IR/Module.h"
48#include "llvm/Support/Errc.h"
49#include "llvm/Support/ErrorHandling.h"
50#include "llvm/Support/VirtualFileSystem.h"
51#include "llvm/Support/raw_ostream.h"
52#include "llvm/TargetParser/Host.h"
53#include "llvm/Transforms/Utils/Cloning.h"
55#define DEBUG_TYPE "clang-repl"
70 return llvm::createStringError(llvm::errc::not_supported,
71 "Driver initialization failed. "
72 "Unable to create a driver job");
77 return llvm::createStringError(llvm::errc::not_supported,
78 "Driver initialization failed");
84CreateCI(
const llvm::opt::ArgStringList &Argv) {
89 auto PCHOps = Clang->getPCHContainerOperations();
90 PCHOps->registerWriter(std::make_unique<ObjectFilePCHContainerWriter>());
91 PCHOps->registerReader(std::make_unique<ObjectFilePCHContainerReader>());
99 Clang->getInvocation(),
llvm::ArrayRef(Argv.begin(), Argv.size()), Diags);
102 if (Clang->getHeaderSearchOpts().UseBuiltinIncludes &&
103 Clang->getHeaderSearchOpts().ResourceDir.empty())
104 Clang->getHeaderSearchOpts().ResourceDir =
107 Clang->createVirtualFileSystem();
110 Clang->createDiagnostics();
114 return llvm::createStringError(llvm::errc::not_supported,
115 "Initialization failed. "
116 "Unable to flush diagnostics");
119 llvm::MemoryBuffer *MB = llvm::MemoryBuffer::getMemBuffer(
"").release();
120 Clang->getPreprocessorOpts().addRemappedFile(
"<<< inputs >>>", MB);
123 Clang->getDiagnostics(), Clang->getInvocation().getTargetOpts()));
124 if (!Clang->hasTarget())
125 return llvm::createStringError(llvm::errc::not_supported,
126 "Initialization failed. "
127 "Target is missing");
129 Clang->getTarget().adjust(Clang->getDiagnostics(), Clang->getLangOpts(),
130 Clang->getAuxTarget());
134 Clang->getCodeGenOpts().ClearASTBeforeBackend =
false;
136 Clang->getFrontendOpts().DisableFree =
false;
137 Clang->getCodeGenOpts().DisableFree =
false;
138 return std::move(Clang);
146IncrementalCompilerBuilder::create(std::string TT,
147 std::vector<const char *> &ClangArgv) {
151 std::string MainExecutableName =
152 llvm::sys::fs::getMainExecutable(
nullptr,
nullptr);
154 ClangArgv.insert(ClangArgv.begin(), MainExecutableName.c_str());
161 ClangArgv.insert(ClangArgv.end(),
"-Xclang");
162 ClangArgv.insert(ClangArgv.end(),
"-fincremental-extensions");
163 ClangArgv.insert(ClangArgv.end(),
"-c");
167 ClangArgv.push_back(
"<<< inputs >>>");
171 std::unique_ptr<DiagnosticOptions> DiagOpts =
173 TextDiagnosticBuffer *DiagsBuffer =
new TextDiagnosticBuffer;
176 driver::Driver
Driver(ClangArgv[0], TT, Diags);
177 Driver.setCheckInputsExist(
false);
178 llvm::ArrayRef<const char *> RF = llvm::ArrayRef(ClangArgv);
179 std::unique_ptr<driver::Compilation> Compilation(
Driver.BuildCompilation(RF));
182 if (
auto Err = (*CompilationCB)(*Compilation.get()))
183 return std::move(Err);
185 if (Compilation->getArgs().hasArg(options::OPT_v))
186 Compilation->getJobs().Print(llvm::errs(),
"\n",
false);
188 auto ErrOrCC1Args = GetCC1Arguments(&Diags, Compilation.get());
189 if (
auto Err = ErrOrCC1Args.takeError())
190 return std::move(Err);
192 return CreateCI(**ErrOrCC1Args);
197 std::vector<const char *> Argv;
198 Argv.reserve(5 + 1 + UserArgs.size());
199 Argv.push_back(
"-xc++");
201 Argv.push_back(
"-target");
202 Argv.push_back(
"wasm32-unknown-emscripten");
203 Argv.push_back(
"-fvisibility=default");
205 llvm::append_range(Argv, UserArgs);
207 std::string TT = TargetTriple ? *TargetTriple : llvm::sys::getProcessTriple();
208 return IncrementalCompilerBuilder::create(TT, Argv);
212IncrementalCompilerBuilder::createCuda(
bool device) {
213 std::vector<const char *> Argv;
214 Argv.reserve(5 + 4 + UserArgs.size());
216 Argv.push_back(
"-xcuda");
218 Argv.push_back(
"--cuda-device-only");
220 Argv.push_back(
"--cuda-host-only");
222 std::string SDKPathArg =
"--cuda-path=";
223 if (!CudaSDKPath.empty()) {
224 SDKPathArg += CudaSDKPath;
225 Argv.push_back(SDKPathArg.c_str());
228 std::string ArchArg =
"--offload-arch=";
231 Argv.push_back(ArchArg.c_str());
234 llvm::append_range(Argv, UserArgs);
236 std::string TT = TargetTriple ? *TargetTriple : llvm::sys::getProcessTriple();
237 return IncrementalCompilerBuilder::create(TT, Argv);
242 return IncrementalCompilerBuilder::createCuda(
true);
247 return IncrementalCompilerBuilder::createCuda(
false);
252 std::unique_ptr<IncrementalExecutorBuilder> IEB,
253 std::unique_ptr<clang::ASTConsumer> Consumer)
254 : IncrExecutorBuilder(
std::move(IEB)) {
255 CI = std::move(Instance);
256 llvm::ErrorAsOutParameter EAO(&ErrOut);
257 auto LLVMCtx = std::make_unique<llvm::LLVMContext>();
258 TSCtx = std::make_unique<llvm::orc::ThreadSafeContext>(std::move(LLVMCtx));
260 Act = TSCtx->withContextDo([&](llvm::LLVMContext *Ctx) {
261 return std::make_unique<IncrementalAction>(*CI, *Ctx, ErrOut, *
this,
262 std::move(Consumer));
267 CI->ExecuteAction(*Act);
270 std::make_unique<IncrementalParser>(*CI, Act.get(), ErrOut, PTUs);
275 if (Act->getCodeGen()) {
276 Act->CacheCodeGenModule();
279 if (!CI->getPreprocessorOpts().Includes.empty() ||
280 !CI->getPreprocessorOpts().ImplicitPCHInclude.empty()) {
284 auto M = llvm::CloneModule(*Act->getCachedCodeGenModule());
286 IncrParser->RegisterPTU(
C.getTranslationUnitDecl(), std::move(M));
289 ErrOut = joinErrors(std::move(ErrOut), std::move(Err));
295 if (Act->getCodeGen()) {
299 if (llvm::Error Err =
Execute(PTU)) {
300 ErrOut = joinErrors(std::move(ErrOut), std::move(Err));
308 Act->FinalizeAction();
310 DeviceParser.reset();
312 DeviceAct->FinalizeAction();
314 if (llvm::Error Err = IncrExecutor->cleanUp())
315 llvm::report_fatal_error(
316 llvm::Twine(
"Failed to clean up IncrementalExecutor: ") +
325 #define __CLANG_REPL__ 1
327 #define EXTERN_C extern "C"
328 struct __clang_Interpreter_NewTag{} __ci_newtag;
329 void* operator new(__SIZE_TYPE__, void* __p, __clang_Interpreter_NewTag) noexcept;
330 template <class T, class = T (*)() /*disable for arrays*/>
331 void __clang_Interpreter_SetValueCopyArr(const T* Src, void* Placement, unsigned long Size) {
332 for (unsigned long Idx = 0; Idx < Size; ++Idx)
333 new ((void*)(((T*)Placement) + Idx), __ci_newtag) T(Src[Idx]);
335 template <class T, unsigned long N>
336 void __clang_Interpreter_SetValueCopyArr(const T (*Src)[N], void* Placement, unsigned long Size) {
337 __clang_Interpreter_SetValueCopyArr(Src[0], Placement, Size);
340 #define EXTERN_C extern
341 EXTERN_C void *memcpy(void *restrict dst, const void *restrict src, __SIZE_TYPE__ n);
342 EXTERN_C inline void __clang_Interpreter_SetValueCopyArr(const void* Src, void* Placement, unsigned long Size) {
343 memcpy(Placement, Src, Size);
346 EXTERN_C void *__clang_Interpreter_SetValueWithAlloc(void*, void*, void*);
347 EXTERN_C void __clang_Interpreter_SetValueNoAlloc(void *This, void *OutVal, void *OpaqueType, ...);
351 std::unique_ptr<CompilerInstance> CI,
352 std::unique_ptr<IncrementalExecutorBuilder> IEB ) {
353 llvm::Error Err = llvm::Error::success();
355 auto Interp = std::unique_ptr<Interpreter>(
new Interpreter(
356 std::move(CI), Err, std::move(IEB),
nullptr));
357 if (
auto E = std::move(Err))
362 if (
auto E = Interp->ParseAndExecute(
Runtimes))
365 Interp->markUserCodeStart();
367 return std::move(Interp);
372 std::unique_ptr<CompilerInstance> DCI) {
375 std::make_unique<llvm::vfs::InMemoryFileSystem>();
377 std::make_unique<llvm::vfs::OverlayFileSystem>(
378 llvm::vfs::getRealFileSystem());
379 OverlayVFS->pushOverlay(IMVFS);
380 CI->createVirtualFileSystem(OverlayVFS);
381 CI->createFileManager();
388 std::unique_ptr<Interpreter> Interp = std::move(*InterpOrErr);
390 llvm::Error Err = llvm::Error::success();
392 auto DeviceAct = Interp->TSCtx->withContextDo([&](llvm::LLVMContext *Ctx) {
393 return std::make_unique<IncrementalAction>(*DCI, *Ctx, Err, *Interp);
397 return std::move(Err);
399 Interp->DeviceAct = std::move(DeviceAct);
401 DCI->ExecuteAction(*Interp->DeviceAct);
403 Interp->DeviceCI = std::move(DCI);
405 auto DeviceParser = std::make_unique<IncrementalCUDADeviceParser>(
406 *Interp->DeviceCI, *Interp->getCompilerInstance(),
407 Interp->DeviceAct.get(), IMVFS, Err, Interp->PTUs);
410 return std::move(Err);
412 Interp->DeviceParser = std::move(DeviceParser);
413 return std::move(Interp);
424 return std::move(Err);
427 return *IncrExecutor.get();
438void Interpreter::markUserCodeStart() {
439 assert(!InitPTUSize &&
"We only do this once");
440 InitPTUSize = PTUs.size();
443size_t Interpreter::getEffectivePTUSize()
const {
444 assert(PTUs.size() >= InitPTUSize &&
"empty PTU list?");
445 return PTUs.size() - InitPTUSize;
454 if (
auto E = DeviceTU.takeError())
457 DeviceParser->RegisterPTU(*DeviceTU);
461 return PTX.takeError();
463 llvm::Error Err = DeviceParser->GenerateFatbinary();
465 return std::move(Err);
475 return TuOrErr.takeError();
484 return llvm::make_error<llvm::StringError>(
"Operation failed. "
485 "Execution engine exists",
487 if (!Act->getCodeGen())
488 return llvm::make_error<llvm::StringError>(
"Operation failed. "
489 "No code generator available",
492 if (!IncrExecutorBuilder)
493 IncrExecutorBuilder = std::make_unique<IncrementalExecutorBuilder>();
495 auto ExecutorOrErr = IncrExecutorBuilder->create(*TSCtx, CI->getTarget());
497 IncrExecutor = std::move(*ExecutorOrErr);
499 return ExecutorOrErr.takeError();
505 llvm::dbgs() <<
"execute-ptu "
506 << (llvm::is_contained(PTUs,
T)
507 ? std::distance(PTUs.begin(), llvm::find(PTUs,
T))
509 <<
": [TU=" <<
T.TUPart <<
", M=" <<
T.TheModule.get()
510 <<
" (" <<
T.TheModule->getName() <<
")]\n");
517 if (
auto Err = IncrExecutor->addModule(
T))
520 if (
auto Err = IncrExecutor->runCtors())
523 return llvm::Error::success();
528 auto PTU =
Parse(Code);
530 return PTU.takeError();
532 if (llvm::Error Err =
Execute(*PTU))
535 if (LastValue.isValid()) {
540 *
V = std::move(LastValue);
542 return llvm::Error::success();
548 return llvm::make_error<llvm::StringError>(
"Operation failed. "
549 "No execution engine",
551 llvm::StringRef MangledName = Act->getCodeGen()->GetMangledName(GD);
558 return llvm::make_error<llvm::StringError>(
"Operation failed. "
559 "No execution engine",
568 return llvm::make_error<llvm::StringError>(
"Operation failed. "
569 "No execution engine",
577 if (getEffectivePTUSize() == 0) {
578 return llvm::make_error<llvm::StringError>(
"Operation failed. "
579 "No input left to undo",
581 }
else if (N > getEffectivePTUSize()) {
582 return llvm::make_error<llvm::StringError>(
584 "Operation failed. Wanted to undo {0} inputs, only have {1}.", N,
585 getEffectivePTUSize()),
589 for (
unsigned I = 0; I < N; I++) {
591 if (llvm::Error Err = IncrExecutor->removeModule(PTUs.back()))
595 IncrParser->CleanUpPTU(PTUs.back().TUPart);
598 return llvm::Error::success();
604 return EEOrErr.takeError();
606 return EEOrErr->LoadDynamicLibrary(name);
Defines the clang::ASTContext interface.
Defines the clang::FrontendAction interface and various convenience abstract classes (clang::ASTFront...
static std::string toString(const clang::SanitizerSet &Sanitizers)
Produce a string containing comma-separated names of sanitizers in Sanitizers set.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
CompilerInstance - Helper class for managing a single instance of the Clang compiler.
DiagnosticsEngine & getDiagnostics() const
Get the current diagnostics engine.
ASTContext & getASTContext() const
static bool CreateFromArgs(CompilerInvocation &Res, ArrayRef< const char * > CommandLineArgs, DiagnosticsEngine &Diags, const char *Argv0=nullptr)
Create a compiler invocation from a list of input options.
static llvm::IntrusiveRefCntPtr< DiagnosticIDs > create()
Options for controlling the compiler diagnostics engine.
Concrete class used by the front-end to report problems and issues.
void setSeverity(diag::kind Diag, diag::Severity Map, SourceLocation Loc)
This allows the client to specify that certain warnings are ignored.
GlobalDecl - represents a global declaration.
llvm::Expected< std::unique_ptr< CompilerInstance > > CreateCudaHost()
llvm::Expected< std::unique_ptr< CompilerInstance > > CreateCudaDevice()
llvm::Expected< std::unique_ptr< CompilerInstance > > CreateCpp()
llvm::Expected< IncrementalExecutor & > getExecutionEngine()
llvm::Error ParseAndExecute(llvm::StringRef Code, Value *V=nullptr)
static llvm::Expected< std::unique_ptr< Interpreter > > create(std::unique_ptr< CompilerInstance > CI, std::unique_ptr< IncrementalExecutorBuilder > IEB=nullptr)
llvm::Error CreateExecutor()
llvm::Expected< llvm::orc::ExecutorAddr > getSymbolAddress(GlobalDecl GD) const
llvm::Error LoadDynamicLibrary(const char *name)
Link a dynamic library.
static llvm::Expected< std::unique_ptr< Interpreter > > createWithCUDA(std::unique_ptr< CompilerInstance > CI, std::unique_ptr< CompilerInstance > DCI)
llvm::Expected< PartialTranslationUnit & > Parse(llvm::StringRef Code)
llvm::Expected< llvm::orc::ExecutorAddr > getSymbolAddressFromLinkerName(llvm::StringRef LinkerName) const
Interpreter(std::unique_ptr< CompilerInstance > Instance, llvm::Error &Err, std::unique_ptr< IncrementalExecutorBuilder > IEB=nullptr, std::unique_ptr< clang::ASTConsumer > Consumer=nullptr)
llvm::Error Undo(unsigned N=1)
Undo N previous incremental inputs.
const CompilerInstance * getCompilerInstance() const
const ASTContext & getASTContext() const
llvm::Error Execute(PartialTranslationUnit &T)
Encodes a location in the source.
static TargetInfo * CreateTargetInfo(DiagnosticsEngine &Diags, TargetOptions &Opts)
Construct a target for the given options.
void FlushDiagnostics(DiagnosticsEngine &Diags) const
FlushDiagnostics - Flush the buffered diagnostics to an given diagnostic engine.
Command - An executable path/name and argument vector to execute.
const Tool & getCreator() const
getCreator - Return the Tool which caused the creation of this job.
const llvm::opt::ArgStringList & getArguments() const
Compilation - A set of tasks to perform for a single driver invocation.
JobList - A sequence of jobs to perform.
Defines the clang::TargetInfo interface.
@ Ignored
Do not present this diagnostic, ignore it.
The JSON file list parser is used to communicate input to InstallAPI.
bool isa(CodeGen::Address addr)
std::unique_ptr< DiagnosticOptions > CreateAndPopulateDiagOpts(ArrayRef< const char * > Argv)
@ Success
Annotation was successful.
@ Parse
Parse the block; this code is always used.
const char *const Runtimes
const FunctionProtoType * T
std::string GetResourcesPath(StringRef BinaryPath)
Get the directory where the compiler headers reside, relative to the compiler binary path BinaryPath.
U cast(CodeGen::Address addr)
bool(*)(llvm::ArrayRef< const char * >, llvm::raw_ostream &, llvm::raw_ostream &, bool, bool) Driver
The class keeps track of various objects created as part of processing incremental inputs.