blob: 351c484717003744ad2886998b06db1f09dd9da3 [file] [log] [blame]
Sean Callanan65dafa82010-08-27 01:01:44 +00001//===-- ClangExpressionParser.cpp -------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "lldb/Expression/ClangExpressionParser.h"
11
12#include "lldb/Core/ArchSpec.h"
13#include "lldb/Core/DataBufferHeap.h"
Sean Callanan97c924e2011-01-27 01:07:04 +000014#include "lldb/Core/Debugger.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000015#include "lldb/Core/Disassembler.h"
16#include "lldb/Core/Stream.h"
Sean Callananf18d91c2010-09-01 00:58:00 +000017#include "lldb/Core/StreamString.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000018#include "lldb/Expression/ClangASTSource.h"
19#include "lldb/Expression/ClangExpression.h"
Sean Callananfb3058e2011-05-12 23:54:16 +000020#include "lldb/Expression/ClangExpressionDeclMap.h"
Sean Callananf18d91c2010-09-01 00:58:00 +000021#include "lldb/Expression/IRDynamicChecks.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000022#include "lldb/Expression/RecordingMemoryManager.h"
23#include "lldb/Target/ExecutionContext.h"
Sean Callananc7674af2011-01-17 23:42:46 +000024#include "lldb/Target/ObjCLanguageRuntime.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000025#include "lldb/Target/Process.h"
26#include "lldb/Target/Target.h"
27
28#include "clang/AST/ASTContext.h"
29#include "clang/AST/ExternalASTSource.h"
30#include "clang/Basic/FileManager.h"
31#include "clang/Basic/TargetInfo.h"
32#include "clang/Basic/Version.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000033#include "clang/CodeGen/CodeGenAction.h"
34#include "clang/CodeGen/ModuleBuilder.h"
35#include "clang/Driver/CC1Options.h"
36#include "clang/Driver/OptTable.h"
37#include "clang/Frontend/CompilerInstance.h"
38#include "clang/Frontend/CompilerInvocation.h"
39#include "clang/Frontend/FrontendActions.h"
40#include "clang/Frontend/FrontendDiagnostic.h"
41#include "clang/Frontend/FrontendPluginRegistry.h"
42#include "clang/Frontend/TextDiagnosticBuffer.h"
43#include "clang/Frontend/TextDiagnosticPrinter.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000044#include "clang/Lex/Preprocessor.h"
Sean Callanan47a5c4c2010-09-23 03:01:22 +000045#include "clang/Parse/ParseAST.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000046#include "clang/Rewrite/FrontendActions.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000047#include "clang/Sema/SemaConsumer.h"
Sean Callanan279584c2011-03-15 00:17:19 +000048#include "clang/StaticAnalyzer/Frontend/FrontendActions.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000049
50#include "llvm/ADT/StringRef.h"
51#include "llvm/ExecutionEngine/ExecutionEngine.h"
Sean Callananc1535182011-10-07 23:18:13 +000052#include "llvm/Support/TargetSelect.h"
Greg Clayton2f085c62011-05-15 01:25:55 +000053
Peter Collingbournec3f55732011-06-03 20:40:12 +000054#if !defined(__APPLE__)
55#define USE_STANDARD_JIT
56#endif
57
Greg Clayton2f085c62011-05-15 01:25:55 +000058#if defined (USE_STANDARD_JIT)
Sean Callanan65dafa82010-08-27 01:01:44 +000059#include "llvm/ExecutionEngine/JIT.h"
Greg Clayton2f085c62011-05-15 01:25:55 +000060#else
61#include "llvm/ExecutionEngine/MCJIT.h"
62#endif
Sean Callanan65dafa82010-08-27 01:01:44 +000063#include "llvm/LLVMContext.h"
Sean Callanan279584c2011-03-15 00:17:19 +000064#include "llvm/Module.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000065#include "llvm/Support/ErrorHandling.h"
66#include "llvm/Support/MemoryBuffer.h"
Greg Clayton22defe82010-12-02 23:20:03 +000067#include "llvm/Support/DynamicLibrary.h"
68#include "llvm/Support/Host.h"
69#include "llvm/Support/Signals.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000070
71using namespace clang;
72using namespace llvm;
73using namespace lldb_private;
74
75//===----------------------------------------------------------------------===//
76// Utility Methods for Clang
77//===----------------------------------------------------------------------===//
78
79std::string GetBuiltinIncludePath(const char *Argv0) {
80 llvm::sys::Path P =
81 llvm::sys::Path::GetMainExecutable(Argv0,
82 (void*)(intptr_t) GetBuiltinIncludePath);
83
84 if (!P.isEmpty()) {
85 P.eraseComponent(); // Remove /clang from foo/bin/clang
86 P.eraseComponent(); // Remove /bin from foo/bin
87
88 // Get foo/lib/clang/<version>/include
89 P.appendComponent("lib");
90 P.appendComponent("clang");
91 P.appendComponent(CLANG_VERSION_STRING);
92 P.appendComponent("include");
93 }
94
95 return P.str();
96}
97
98
99//===----------------------------------------------------------------------===//
100// Main driver for Clang
101//===----------------------------------------------------------------------===//
102
103static void LLVMErrorHandler(void *UserData, const std::string &Message) {
Sean Callananc1535182011-10-07 23:18:13 +0000104 DiagnosticsEngine &Diags = *static_cast<DiagnosticsEngine*>(UserData);
Sean Callanan65dafa82010-08-27 01:01:44 +0000105
106 Diags.Report(diag::err_fe_error_backend) << Message;
107
108 // We cannot recover from llvm errors.
Sean Callananc1535182011-10-07 23:18:13 +0000109 assert(0);
Sean Callanan65dafa82010-08-27 01:01:44 +0000110}
111
112static FrontendAction *CreateFrontendBaseAction(CompilerInstance &CI) {
113 using namespace clang::frontend;
114
115 switch (CI.getFrontendOpts().ProgramAction) {
116 default:
117 llvm_unreachable("Invalid program action!");
118
119 case ASTDump: return new ASTDumpAction();
120 case ASTPrint: return new ASTPrintAction();
Sean Callanan279584c2011-03-15 00:17:19 +0000121 case ASTDumpXML: return new ASTDumpXMLAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000122 case ASTView: return new ASTViewAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000123 case DumpRawTokens: return new DumpRawTokensAction();
124 case DumpTokens: return new DumpTokensAction();
125 case EmitAssembly: return new EmitAssemblyAction();
126 case EmitBC: return new EmitBCAction();
127 case EmitHTML: return new HTMLPrintAction();
128 case EmitLLVM: return new EmitLLVMAction();
129 case EmitLLVMOnly: return new EmitLLVMOnlyAction();
130 case EmitCodeGenOnly: return new EmitCodeGenOnlyAction();
131 case EmitObj: return new EmitObjAction();
132 case FixIt: return new FixItAction();
Sean Callanan05230832011-12-01 04:31:46 +0000133 case GeneratePCH: return new GeneratePCHAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000134 case GeneratePTH: return new GeneratePTHAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000135 case InitOnly: return new InitOnlyAction();
136 case ParseSyntaxOnly: return new SyntaxOnlyAction();
137
138 case PluginAction: {
139 for (FrontendPluginRegistry::iterator it =
140 FrontendPluginRegistry::begin(), ie = FrontendPluginRegistry::end();
141 it != ie; ++it) {
142 if (it->getName() == CI.getFrontendOpts().ActionName) {
143 llvm::OwningPtr<PluginASTAction> P(it->instantiate());
144 if (!P->ParseArgs(CI, CI.getFrontendOpts().PluginArgs))
145 return 0;
146 return P.take();
147 }
148 }
149
150 CI.getDiagnostics().Report(diag::err_fe_invalid_plugin_name)
151 << CI.getFrontendOpts().ActionName;
152 return 0;
153 }
154
155 case PrintDeclContext: return new DeclContextPrintAction();
156 case PrintPreamble: return new PrintPreambleAction();
157 case PrintPreprocessedInput: return new PrintPreprocessedAction();
158 case RewriteMacros: return new RewriteMacrosAction();
159 case RewriteObjC: return new RewriteObjCAction();
160 case RewriteTest: return new RewriteTestAction();
Sean Callananad293092011-01-18 23:32:05 +0000161 //case RunAnalysis: return new AnalysisAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000162 case RunPreprocessorOnly: return new PreprocessOnlyAction();
163 }
164}
165
166static FrontendAction *CreateFrontendAction(CompilerInstance &CI) {
167 // Create the underlying action.
168 FrontendAction *Act = CreateFrontendBaseAction(CI);
169 if (!Act)
170 return 0;
171
172 // If there are any AST files to merge, create a frontend action
173 // adaptor to perform the merge.
174 if (!CI.getFrontendOpts().ASTMergeFiles.empty())
175 Act = new ASTMergeAction(Act, &CI.getFrontendOpts().ASTMergeFiles[0],
176 CI.getFrontendOpts().ASTMergeFiles.size());
177
178 return Act;
179}
180
181//===----------------------------------------------------------------------===//
182// Implementation of ClangExpressionParser
183//===----------------------------------------------------------------------===//
184
Greg Clayton395fc332011-02-15 21:59:32 +0000185ClangExpressionParser::ClangExpressionParser (ExecutionContextScope *exe_scope,
186 ClangExpression &expr) :
187 m_expr (expr),
Sean Callanan65dafa82010-08-27 01:01:44 +0000188 m_compiler (),
189 m_code_generator (NULL),
190 m_execution_engine (),
191 m_jitted_functions ()
192{
193 // Initialize targets first, so that --version shows registered targets.
194 static struct InitializeLLVM {
195 InitializeLLVM() {
196 llvm::InitializeAllTargets();
197 llvm::InitializeAllAsmPrinters();
Sean Callanan9b6898f2011-07-30 02:42:06 +0000198 llvm::InitializeAllTargetMCs();
Sean Callanan05230832011-12-01 04:31:46 +0000199 llvm::InitializeAllDisassemblers();
Sean Callanan65dafa82010-08-27 01:01:44 +0000200 }
201 } InitializeLLVM;
Greg Clayton395fc332011-02-15 21:59:32 +0000202
Sean Callanan65dafa82010-08-27 01:01:44 +0000203 // 1. Create a new compiler instance.
204 m_compiler.reset(new CompilerInstance());
Sean Callanan65dafa82010-08-27 01:01:44 +0000205
206 // 2. Set options.
207
Sean Callanan5b658cc2011-11-07 23:35:40 +0000208 lldb::LanguageType language = expr.Language();
Greg Claytonf51ed302011-01-15 01:32:14 +0000209
Sean Callanan5b658cc2011-11-07 23:35:40 +0000210 switch (language)
211 {
212 case lldb::eLanguageTypeC:
213 break;
214 case lldb::eLanguageTypeObjC:
215 m_compiler->getLangOpts().ObjC1 = true;
216 m_compiler->getLangOpts().ObjC2 = true;
217 break;
218 case lldb::eLanguageTypeC_plus_plus:
219 m_compiler->getLangOpts().CPlusPlus = true;
220 break;
221 case lldb::eLanguageTypeObjC_plus_plus:
222 default:
223 m_compiler->getLangOpts().ObjC1 = true;
224 m_compiler->getLangOpts().ObjC2 = true;
225 m_compiler->getLangOpts().CPlusPlus = true;
226 break;
227 }
Sean Callananc7674af2011-01-17 23:42:46 +0000228
Greg Clayton395fc332011-02-15 21:59:32 +0000229 Process *process = NULL;
230 if (exe_scope)
231 process = exe_scope->CalculateProcess();
232
Sean Callanan5b658cc2011-11-07 23:35:40 +0000233 if (process && m_compiler->getLangOpts().ObjC1)
Sean Callananc7674af2011-01-17 23:42:46 +0000234 {
235 if (process->GetObjCLanguageRuntime())
236 {
Greg Claytonb3448432011-03-24 21:19:54 +0000237 if (process->GetObjCLanguageRuntime()->GetRuntimeVersion() == eAppleObjC_V2)
Sean Callananc7674af2011-01-17 23:42:46 +0000238 {
239 m_compiler->getLangOpts().ObjCNonFragileABI = true; // NOT i386
240 m_compiler->getLangOpts().ObjCNonFragileABI2 = true; // NOT i386
241 }
242 }
243 }
Greg Claytonf51ed302011-01-15 01:32:14 +0000244
Sean Callanan65dafa82010-08-27 01:01:44 +0000245 m_compiler->getLangOpts().ThreadsafeStatics = false;
246 m_compiler->getLangOpts().AccessControl = false; // Debuggers get universal access
247 m_compiler->getLangOpts().DollarIdents = true; // $ indicates a persistent variable name
Sean Callanan1cbfabd2011-10-21 23:40:00 +0000248 m_compiler->getLangOpts().DebuggerSupport = true; // Features specifically for debugger clients
Sean Callanan65dafa82010-08-27 01:01:44 +0000249
250 // Set CodeGen options
251 m_compiler->getCodeGenOpts().EmitDeclMetadata = true;
252 m_compiler->getCodeGenOpts().InstrumentFunctions = false;
253
254 // Disable some warnings.
255 m_compiler->getDiagnosticOpts().Warnings.push_back("no-unused-value");
256
257 // Set the target triple.
Greg Clayton395fc332011-02-15 21:59:32 +0000258 Target *target = NULL;
259 if (exe_scope)
260 target = exe_scope->CalculateTarget();
261
262 // TODO: figure out what to really do when we don't have a valid target.
263 // Sometimes this will be ok to just use the host target triple (when we
264 // evaluate say "2+3", but other expressions like breakpoint conditions
265 // and other things that _are_ target specific really shouldn't just be
266 // using the host triple. This needs to be fixed in a better way.
267 if (target && target->GetArchitecture().IsValid())
Sean Callanan2a8c3382011-04-14 02:01:31 +0000268 {
269 std::string triple = target->GetArchitecture().GetTriple().str();
270
271 int dash_count = 0;
Johnny Chen2bc9eb32011-07-19 19:48:13 +0000272 for (size_t i = 0; i < triple.size(); ++i)
Sean Callanan2a8c3382011-04-14 02:01:31 +0000273 {
274 if (triple[i] == '-')
275 dash_count++;
276 if (dash_count == 3)
277 {
278 triple.resize(i);
279 break;
280 }
281 }
282
283 m_compiler->getTargetOpts().Triple = triple;
284 }
Greg Clayton395fc332011-02-15 21:59:32 +0000285 else
Sean Callanan2a8c3382011-04-14 02:01:31 +0000286 {
Sean Callanan7537dce2011-11-04 22:46:46 +0000287 m_compiler->getTargetOpts().Triple = llvm::sys::getDefaultTargetTriple();
Sean Callanan2a8c3382011-04-14 02:01:31 +0000288 }
289
Sean Callanan65dafa82010-08-27 01:01:44 +0000290 // 3. Set up various important bits of infrastructure.
291 m_compiler->createDiagnostics(0, 0);
292
293 // Create the target instance.
294 m_compiler->setTarget(TargetInfo::CreateTargetInfo(m_compiler->getDiagnostics(),
295 m_compiler->getTargetOpts()));
296
297 assert (m_compiler->hasTarget());
298
299 // Inform the target of the language options
300 //
301 // FIXME: We shouldn't need to do this, the target should be immutable once
302 // created. This complexity should be lifted elsewhere.
303 m_compiler->getTarget().setForcedLangOptions(m_compiler->getLangOpts());
304
305 // 4. Set up the diagnostic buffer for reporting errors
306
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000307 m_compiler->getDiagnostics().setClient(new clang::TextDiagnosticBuffer);
Sean Callanan65dafa82010-08-27 01:01:44 +0000308
309 // 5. Set up the source management objects inside the compiler
310
Greg Clayton22defe82010-12-02 23:20:03 +0000311 clang::FileSystemOptions file_system_options;
312 m_file_manager.reset(new clang::FileManager(file_system_options));
Sean Callanan8a3b0a82010-11-18 02:56:27 +0000313
Sean Callanan65dafa82010-08-27 01:01:44 +0000314 if (!m_compiler->hasSourceManager())
Greg Clayton22defe82010-12-02 23:20:03 +0000315 m_compiler->createSourceManager(*m_file_manager.get());
Sean Callanan65dafa82010-08-27 01:01:44 +0000316
317 m_compiler->createFileManager();
318 m_compiler->createPreprocessor();
319
320 // 6. Most of this we get from the CompilerInstance, but we
321 // also want to give the context an ExternalASTSource.
Sean Callananee8fc722010-11-19 20:20:02 +0000322 m_selector_table.reset(new SelectorTable());
Sean Callananc1535182011-10-07 23:18:13 +0000323 m_builtin_context.reset(new Builtin::Context());
Sean Callanan65dafa82010-08-27 01:01:44 +0000324
325 std::auto_ptr<clang::ASTContext> ast_context(new ASTContext(m_compiler->getLangOpts(),
326 m_compiler->getSourceManager(),
Sean Callananc1535182011-10-07 23:18:13 +0000327 &m_compiler->getTarget(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000328 m_compiler->getPreprocessor().getIdentifierTable(),
Sean Callananee8fc722010-11-19 20:20:02 +0000329 *m_selector_table.get(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000330 *m_builtin_context.get(),
331 0));
332
333 ClangExpressionDeclMap *decl_map = m_expr.DeclMap();
334
335 if (decl_map)
336 {
Sean Callananf76afff2011-10-28 23:38:38 +0000337 llvm::OwningPtr<clang::ExternalASTSource> ast_source(decl_map->CreateProxy());
338 decl_map->InstallASTContext(ast_context.get());
Sean Callanan65dafa82010-08-27 01:01:44 +0000339 ast_context->setExternalSource(ast_source);
340 }
341
342 m_compiler->setASTContext(ast_context.release());
343
Greg Clayton8de27c72010-10-15 22:48:33 +0000344 std::string module_name("$__lldb_module");
Sean Callanan65dafa82010-08-27 01:01:44 +0000345
Sean Callanan279584c2011-03-15 00:17:19 +0000346 m_llvm_context.reset(new LLVMContext());
Sean Callanan65dafa82010-08-27 01:01:44 +0000347 m_code_generator.reset(CreateLLVMCodeGen(m_compiler->getDiagnostics(),
348 module_name,
349 m_compiler->getCodeGenOpts(),
Sean Callanan279584c2011-03-15 00:17:19 +0000350 *m_llvm_context));
Sean Callanan65dafa82010-08-27 01:01:44 +0000351}
352
353ClangExpressionParser::~ClangExpressionParser()
354{
355}
356
357unsigned
358ClangExpressionParser::Parse (Stream &stream)
359{
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000360 TextDiagnosticBuffer *diag_buf = static_cast<TextDiagnosticBuffer*>(m_compiler->getDiagnostics().getClient());
361
362 diag_buf->FlushDiagnostics (m_compiler->getDiagnostics());
Sean Callanan65dafa82010-08-27 01:01:44 +0000363
364 MemoryBuffer *memory_buffer = MemoryBuffer::getMemBufferCopy(m_expr.Text(), __FUNCTION__);
365 FileID memory_buffer_file_id = m_compiler->getSourceManager().createMainFileIDForMemBuffer (memory_buffer);
366
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000367 diag_buf->BeginSourceFile(m_compiler->getLangOpts(), &m_compiler->getPreprocessor());
Sean Callanan65dafa82010-08-27 01:01:44 +0000368
369 ASTConsumer *ast_transformer = m_expr.ASTTransformer(m_code_generator.get());
370
371 if (ast_transformer)
372 ParseAST(m_compiler->getPreprocessor(), ast_transformer, m_compiler->getASTContext());
373 else
374 ParseAST(m_compiler->getPreprocessor(), m_code_generator.get(), m_compiler->getASTContext());
375
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000376 diag_buf->EndSourceFile();
Sean Callananfb3058e2011-05-12 23:54:16 +0000377
Sean Callanan65dafa82010-08-27 01:01:44 +0000378 TextDiagnosticBuffer::const_iterator diag_iterator;
379
380 int num_errors = 0;
Sean Callanan7617c292010-11-01 20:28:09 +0000381
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000382 for (diag_iterator = diag_buf->warn_begin();
383 diag_iterator != diag_buf->warn_end();
Sean Callanan65dafa82010-08-27 01:01:44 +0000384 ++diag_iterator)
385 stream.Printf("warning: %s\n", (*diag_iterator).second.c_str());
386
387 num_errors = 0;
388
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000389 for (diag_iterator = diag_buf->err_begin();
390 diag_iterator != diag_buf->err_end();
Sean Callanan65dafa82010-08-27 01:01:44 +0000391 ++diag_iterator)
392 {
393 num_errors++;
394 stream.Printf("error: %s\n", (*diag_iterator).second.c_str());
395 }
396
Sean Callanan7617c292010-11-01 20:28:09 +0000397 for (diag_iterator = diag_buf->note_begin();
398 diag_iterator != diag_buf->note_end();
399 ++diag_iterator)
400 stream.Printf("note: %s\n", (*diag_iterator).second.c_str());
401
Sean Callananfb3058e2011-05-12 23:54:16 +0000402 if (!num_errors)
403 {
404 if (m_expr.DeclMap() && !m_expr.DeclMap()->ResolveUnknownTypes())
405 {
406 stream.Printf("error: Couldn't infer the type of a variable\n");
407 num_errors++;
408 }
409 }
410
Sean Callanan65dafa82010-08-27 01:01:44 +0000411 return num_errors;
412}
413
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000414static bool FindFunctionInModule (std::string &mangled_name,
415 llvm::Module *module,
416 const char *orig_name)
417{
418 for (llvm::Module::iterator fi = module->getFunctionList().begin(), fe = module->getFunctionList().end();
419 fi != fe;
420 ++fi)
421 {
422 if (fi->getName().str().find(orig_name) != std::string::npos)
423 {
424 mangled_name = fi->getName().str();
425 return true;
426 }
427 }
428
429 return false;
430}
431
Sean Callanan65dafa82010-08-27 01:01:44 +0000432Error
Sean Callanan47dc4572011-09-15 02:13:07 +0000433ClangExpressionParser::PrepareForExecution (lldb::addr_t &func_allocation_addr,
434 lldb::addr_t &func_addr,
435 lldb::addr_t &func_end,
436 ExecutionContext &exe_ctx,
437 IRForTarget::StaticDataAllocator *data_allocator,
438 bool &evaluated_statically,
439 lldb::ClangExpressionVariableSP &const_result,
440 ExecutionPolicy execution_policy)
Sean Callanan65dafa82010-08-27 01:01:44 +0000441{
Greg Claytond0882d02011-01-19 23:00:49 +0000442 func_allocation_addr = LLDB_INVALID_ADDRESS;
443 func_addr = LLDB_INVALID_ADDRESS;
444 func_end = LLDB_INVALID_ADDRESS;
Greg Claytone005f2c2010-11-06 01:53:30 +0000445 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000446
Sean Callanan65dafa82010-08-27 01:01:44 +0000447 Error err;
448
449 llvm::Module *module = m_code_generator->ReleaseModule();
450
451 if (!module)
452 {
453 err.SetErrorToGenericError();
454 err.SetErrorString("IR doesn't contain a module");
455 return err;
456 }
457
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000458 // Find the actual name of the function (it's often mangled somehow)
459
460 std::string function_name;
461
462 if (!FindFunctionInModule(function_name, module, m_expr.FunctionName()))
463 {
464 err.SetErrorToGenericError();
465 err.SetErrorStringWithFormat("Couldn't find %s() in the module", m_expr.FunctionName());
466 return err;
467 }
468 else
469 {
Enrico Granata4c3fb4b2011-07-19 18:03:25 +0000470 if (log)
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000471 log->Printf("Found function %s for %s", function_name.c_str(), m_expr.FunctionName());
472 }
473
Sean Callanan65dafa82010-08-27 01:01:44 +0000474 ClangExpressionDeclMap *decl_map = m_expr.DeclMap(); // result can be NULL
475
476 if (decl_map)
477 {
Sean Callanan97c924e2011-01-27 01:07:04 +0000478 Stream *error_stream = NULL;
Greg Clayton567e7f32011-09-22 04:58:26 +0000479 Target *target = exe_ctx.GetTargetPtr();
480 if (target)
481 error_stream = &target->GetDebugger().GetErrorStream();
Sean Callanan97c924e2011-01-27 01:07:04 +0000482
Sean Callanan47dc4572011-09-15 02:13:07 +0000483 IRForTarget ir_for_target(decl_map,
Sean Callanane8a59a82010-09-13 21:34:21 +0000484 m_expr.NeedsVariableResolution(),
Sean Callanan47dc4572011-09-15 02:13:07 +0000485 execution_policy,
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000486 const_result,
Sean Callananc0492742011-05-23 21:40:23 +0000487 data_allocator,
Sean Callanan97c924e2011-01-27 01:07:04 +0000488 error_stream,
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000489 function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000490
491 if (!ir_for_target.runOnModule(*module))
492 {
493 err.SetErrorToGenericError();
Sean Callanan47dc4572011-09-15 02:13:07 +0000494 err.SetErrorString("Couldn't prepare the expression for execution in the target");
Sean Callanan65dafa82010-08-27 01:01:44 +0000495 return err;
496 }
Sean Callananf18d91c2010-09-01 00:58:00 +0000497
Sean Callanan47dc4572011-09-15 02:13:07 +0000498 if (execution_policy != eExecutionPolicyAlways && ir_for_target.interpretSuccess())
Sean Callanan696cf5f2011-05-07 01:06:41 +0000499 {
Sean Callanan47dc4572011-09-15 02:13:07 +0000500 evaluated_statically = true;
Sean Callanan696cf5f2011-05-07 01:06:41 +0000501 err.Clear();
502 return err;
503 }
504
Greg Clayton567e7f32011-09-22 04:58:26 +0000505 Process *process = exe_ctx.GetProcessPtr();
506
507 if (!process || execution_policy == eExecutionPolicyNever)
Sean Callanan47dc4572011-09-15 02:13:07 +0000508 {
509 err.SetErrorToGenericError();
510 err.SetErrorString("Execution needed to run in the target, but the target can't be run");
511 return err;
512 }
513
Sean Callanan6cf6c472011-09-20 23:01:51 +0000514 if (execution_policy != eExecutionPolicyNever &&
515 m_expr.NeedsValidation() &&
Greg Clayton567e7f32011-09-22 04:58:26 +0000516 process)
Sean Callananf18d91c2010-09-01 00:58:00 +0000517 {
Greg Clayton567e7f32011-09-22 04:58:26 +0000518 if (!process->GetDynamicCheckers())
Sean Callanan6cf6c472011-09-20 23:01:51 +0000519 {
520 DynamicCheckerFunctions *dynamic_checkers = new DynamicCheckerFunctions();
521
522 StreamString install_errors;
523
524 if (!dynamic_checkers->Install(install_errors, exe_ctx))
525 {
526 if (install_errors.GetString().empty())
527 err.SetErrorString ("couldn't install checkers, unknown error");
528 else
529 err.SetErrorString (install_errors.GetString().c_str());
530
531 return err;
532 }
533
Greg Clayton567e7f32011-09-22 04:58:26 +0000534 process->SetDynamicCheckers(dynamic_checkers);
Sean Callanan6cf6c472011-09-20 23:01:51 +0000535
536 if (log)
537 log->Printf("== [ClangUserExpression::Evaluate] Finished installing dynamic checkers ==");
538 }
539
Greg Clayton567e7f32011-09-22 04:58:26 +0000540 IRDynamicChecks ir_dynamic_checks(*process->GetDynamicCheckers(), function_name.c_str());
Sean Callanane8a59a82010-09-13 21:34:21 +0000541
542 if (!ir_dynamic_checks.runOnModule(*module))
543 {
544 err.SetErrorToGenericError();
545 err.SetErrorString("Couldn't add dynamic checks to the expression");
546 return err;
547 }
548 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000549 }
550
Greg Claytond0882d02011-01-19 23:00:49 +0000551 // llvm will own this pointer when llvm::ExecutionEngine::createJIT is called
552 // below so we don't need to free it.
553 RecordingMemoryManager *jit_memory_manager = new RecordingMemoryManager();
Sean Callanan65dafa82010-08-27 01:01:44 +0000554
555 std::string error_string;
Sean Callanan7b8eb762011-11-01 17:33:54 +0000556
557 if (log)
558 {
559 std::string s;
560 raw_string_ostream oss(s);
561
562 module->print(oss, NULL);
563
564 oss.flush();
565
566 log->Printf ("Module being sent to JIT: \n%s", s.c_str());
567 }
568
Greg Clayton2f085c62011-05-15 01:25:55 +0000569#if defined (USE_STANDARD_JIT)
Sean Callanan65dafa82010-08-27 01:01:44 +0000570 m_execution_engine.reset(llvm::ExecutionEngine::createJIT (module,
571 &error_string,
Greg Claytond0882d02011-01-19 23:00:49 +0000572 jit_memory_manager,
Sean Callananc2c6f772010-10-26 00:31:56 +0000573 CodeGenOpt::Less,
Sean Callanan65dafa82010-08-27 01:01:44 +0000574 true,
Peter Collingbournec4d4fb52011-07-30 22:42:24 +0000575 Reloc::Default,
Sean Callanan65dafa82010-08-27 01:01:44 +0000576 CodeModel::Small));
Greg Clayton2f085c62011-05-15 01:25:55 +0000577#else
578 EngineBuilder builder(module);
579 builder.setEngineKind(EngineKind::JIT)
580 .setErrorStr(&error_string)
Sean Callanan9b6898f2011-07-30 02:42:06 +0000581 .setRelocationModel(llvm::Reloc::PIC_)
Greg Clayton2f085c62011-05-15 01:25:55 +0000582 .setJITMemoryManager(jit_memory_manager)
583 .setOptLevel(CodeGenOpt::Less)
584 .setAllocateGVsWithCode(true)
585 .setCodeModel(CodeModel::Small)
Sean Callanan16b53ab2011-10-12 00:12:34 +0000586 .setUseMCJIT(true);
Greg Clayton2f085c62011-05-15 01:25:55 +0000587 m_execution_engine.reset(builder.create());
588#endif
Sean Callanan9ac3a962010-11-02 23:20:00 +0000589
Sean Callanan65dafa82010-08-27 01:01:44 +0000590 if (!m_execution_engine.get())
591 {
592 err.SetErrorToGenericError();
593 err.SetErrorStringWithFormat("Couldn't JIT the function: %s", error_string.c_str());
594 return err;
595 }
596
597 m_execution_engine->DisableLazyCompilation();
598
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000599 llvm::Function *function = module->getFunction (function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000600
601 // We don't actually need the function pointer here, this just forces it to get resolved.
602
603 void *fun_ptr = m_execution_engine->getPointerToFunction(function);
604
605 // Errors usually cause failures in the JIT, but if we're lucky we get here.
606
Sean Callanan7b8eb762011-11-01 17:33:54 +0000607 if (!function)
608 {
609 err.SetErrorToGenericError();
610 err.SetErrorStringWithFormat("Couldn't find '%s' in the JITted module", function_name.c_str());
611 return err;
612 }
613
Sean Callanan65dafa82010-08-27 01:01:44 +0000614 if (!fun_ptr)
615 {
616 err.SetErrorToGenericError();
Sean Callanan7b8eb762011-11-01 17:33:54 +0000617 err.SetErrorStringWithFormat("'%s' was in the JITted module but wasn't lowered", function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000618 return err;
619 }
620
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000621 m_jitted_functions.push_back (ClangExpressionParser::JittedFunction(function_name.c_str(), (lldb::addr_t)fun_ptr));
Sean Callanan65dafa82010-08-27 01:01:44 +0000622
Greg Clayton567e7f32011-09-22 04:58:26 +0000623
624 Process *process = exe_ctx.GetProcessPtr();
625 if (process == NULL)
Sean Callanan65dafa82010-08-27 01:01:44 +0000626 {
627 err.SetErrorToGenericError();
628 err.SetErrorString("Couldn't write the JIT compiled code into the target because there is no target");
629 return err;
630 }
631
632 // Look over the regions allocated for the function compiled. The JIT
633 // tries to allocate the functions & stubs close together, so we should try to
634 // write them that way too...
635 // For now I only write functions with no stubs, globals, exception tables,
636 // etc. So I only need to write the functions.
637
638 size_t alloc_size = 0;
639
Greg Claytond0882d02011-01-19 23:00:49 +0000640 std::map<uint8_t *, uint8_t *>::iterator fun_pos = jit_memory_manager->m_functions.begin();
641 std::map<uint8_t *, uint8_t *>::iterator fun_end = jit_memory_manager->m_functions.end();
Greg Clayton9d2b3212011-05-15 23:56:52 +0000642
Sean Callanan65dafa82010-08-27 01:01:44 +0000643 for (; fun_pos != fun_end; ++fun_pos)
Greg Clayton9d2b3212011-05-15 23:56:52 +0000644 {
645 size_t mem_size = fun_pos->second - fun_pos->first;
646 if (log)
647 log->Printf ("JIT memory: [%p - %p) size = %zu", fun_pos->first, fun_pos->second, mem_size);
648 alloc_size += mem_size;
649 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000650
651 Error alloc_error;
Greg Clayton567e7f32011-09-22 04:58:26 +0000652 func_allocation_addr = process->AllocateMemory (alloc_size,
Greg Claytond0882d02011-01-19 23:00:49 +0000653 lldb::ePermissionsReadable|lldb::ePermissionsExecutable,
654 alloc_error);
Sean Callanan65dafa82010-08-27 01:01:44 +0000655
Greg Claytond0882d02011-01-19 23:00:49 +0000656 if (func_allocation_addr == LLDB_INVALID_ADDRESS)
Sean Callanan65dafa82010-08-27 01:01:44 +0000657 {
658 err.SetErrorToGenericError();
659 err.SetErrorStringWithFormat("Couldn't allocate memory for the JITted function: %s", alloc_error.AsCString("unknown error"));
660 return err;
661 }
662
Greg Claytond0882d02011-01-19 23:00:49 +0000663 lldb::addr_t cursor = func_allocation_addr;
Sean Callanan65dafa82010-08-27 01:01:44 +0000664
Greg Claytond0882d02011-01-19 23:00:49 +0000665 for (fun_pos = jit_memory_manager->m_functions.begin(); fun_pos != fun_end; fun_pos++)
Sean Callanan65dafa82010-08-27 01:01:44 +0000666 {
667 lldb::addr_t lstart = (lldb::addr_t) (*fun_pos).first;
668 lldb::addr_t lend = (lldb::addr_t) (*fun_pos).second;
669 size_t size = lend - lstart;
670
671 Error write_error;
672
Greg Clayton567e7f32011-09-22 04:58:26 +0000673 if (process->WriteMemory(cursor, (void *) lstart, size, write_error) != size)
Sean Callanan65dafa82010-08-27 01:01:44 +0000674 {
675 err.SetErrorToGenericError();
Greg Claytonc0fa5332011-05-22 22:46:53 +0000676 err.SetErrorStringWithFormat("Couldn't copy JIT code for function into the target: %s", write_error.AsCString("unknown error"));
Sean Callanan65dafa82010-08-27 01:01:44 +0000677 return err;
678 }
679
Greg Claytond0882d02011-01-19 23:00:49 +0000680 jit_memory_manager->AddToLocalToRemoteMap (lstart, size, cursor);
Sean Callanan65dafa82010-08-27 01:01:44 +0000681 cursor += size;
682 }
683
684 std::vector<JittedFunction>::iterator pos, end = m_jitted_functions.end();
685
686 for (pos = m_jitted_functions.begin(); pos != end; pos++)
687 {
Greg Claytond0882d02011-01-19 23:00:49 +0000688 (*pos).m_remote_addr = jit_memory_manager->GetRemoteAddressForLocal ((*pos).m_local_addr);
Sean Callanan65dafa82010-08-27 01:01:44 +0000689
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000690 if (!(*pos).m_name.compare(function_name.c_str()))
Sean Callanan830a9032010-08-27 23:31:21 +0000691 {
Greg Claytond0882d02011-01-19 23:00:49 +0000692 func_end = jit_memory_manager->GetRemoteRangeForLocal ((*pos).m_local_addr).second;
Sean Callanan65dafa82010-08-27 01:01:44 +0000693 func_addr = (*pos).m_remote_addr;
Sean Callanan830a9032010-08-27 23:31:21 +0000694 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000695 }
696
Sean Callanan6dff8272010-11-08 03:49:50 +0000697 if (log)
698 {
699 log->Printf("Code can be run in the target.");
700
701 StreamString disassembly_stream;
702
Greg Claytond0882d02011-01-19 23:00:49 +0000703 Error err = DisassembleFunction(disassembly_stream, exe_ctx, jit_memory_manager);
Sean Callanan6dff8272010-11-08 03:49:50 +0000704
705 if (!err.Success())
706 {
707 log->Printf("Couldn't disassemble function : %s", err.AsCString("unknown error"));
708 }
709 else
710 {
711 log->Printf("Function disassembly:\n%s", disassembly_stream.GetData());
712 }
713 }
714
Sean Callanan65dafa82010-08-27 01:01:44 +0000715 err.Clear();
716 return err;
717}
718
719Error
Greg Claytond0882d02011-01-19 23:00:49 +0000720ClangExpressionParser::DisassembleFunction (Stream &stream, ExecutionContext &exe_ctx, RecordingMemoryManager *jit_memory_manager)
Sean Callanan65dafa82010-08-27 01:01:44 +0000721{
Greg Claytone005f2c2010-11-06 01:53:30 +0000722 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan65dafa82010-08-27 01:01:44 +0000723
724 const char *name = m_expr.FunctionName();
725
726 Error ret;
727
728 ret.Clear();
729
730 lldb::addr_t func_local_addr = LLDB_INVALID_ADDRESS;
731 lldb::addr_t func_remote_addr = LLDB_INVALID_ADDRESS;
732
733 std::vector<JittedFunction>::iterator pos, end = m_jitted_functions.end();
734
735 for (pos = m_jitted_functions.begin(); pos < end; pos++)
736 {
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000737 if (strstr(pos->m_name.c_str(), name))
Sean Callanan65dafa82010-08-27 01:01:44 +0000738 {
739 func_local_addr = pos->m_local_addr;
740 func_remote_addr = pos->m_remote_addr;
741 }
742 }
743
744 if (func_local_addr == LLDB_INVALID_ADDRESS)
745 {
746 ret.SetErrorToGenericError();
747 ret.SetErrorStringWithFormat("Couldn't find function %s for disassembly", name);
748 return ret;
749 }
750
Enrico Granata4c3fb4b2011-07-19 18:03:25 +0000751 if (log)
Sean Callanan65dafa82010-08-27 01:01:44 +0000752 log->Printf("Found function, has local address 0x%llx and remote address 0x%llx", (uint64_t)func_local_addr, (uint64_t)func_remote_addr);
753
754 std::pair <lldb::addr_t, lldb::addr_t> func_range;
755
Greg Claytond0882d02011-01-19 23:00:49 +0000756 func_range = jit_memory_manager->GetRemoteRangeForLocal(func_local_addr);
Sean Callanan65dafa82010-08-27 01:01:44 +0000757
758 if (func_range.first == 0 && func_range.second == 0)
759 {
760 ret.SetErrorToGenericError();
761 ret.SetErrorStringWithFormat("Couldn't find code range for function %s", name);
762 return ret;
763 }
764
Enrico Granata4c3fb4b2011-07-19 18:03:25 +0000765 if (log)
Sean Callanan65dafa82010-08-27 01:01:44 +0000766 log->Printf("Function's code range is [0x%llx-0x%llx]", func_range.first, func_range.second);
767
Greg Clayton567e7f32011-09-22 04:58:26 +0000768 Target *target = exe_ctx.GetTargetPtr();
769 if (!target)
Sean Callanan65dafa82010-08-27 01:01:44 +0000770 {
771 ret.SetErrorToGenericError();
772 ret.SetErrorString("Couldn't find the target");
773 }
774
775 lldb::DataBufferSP buffer_sp(new DataBufferHeap(func_range.second - func_remote_addr, 0));
776
Greg Clayton567e7f32011-09-22 04:58:26 +0000777 Process *process = exe_ctx.GetProcessPtr();
Sean Callanan65dafa82010-08-27 01:01:44 +0000778 Error err;
Greg Clayton567e7f32011-09-22 04:58:26 +0000779 process->ReadMemory(func_remote_addr, buffer_sp->GetBytes(), buffer_sp->GetByteSize(), err);
Sean Callanan65dafa82010-08-27 01:01:44 +0000780
781 if (!err.Success())
782 {
783 ret.SetErrorToGenericError();
784 ret.SetErrorStringWithFormat("Couldn't read from process: %s", err.AsCString("unknown error"));
785 return ret;
786 }
787
Greg Clayton567e7f32011-09-22 04:58:26 +0000788 ArchSpec arch(target->GetArchitecture());
Sean Callanan65dafa82010-08-27 01:01:44 +0000789
Greg Clayton149731c2011-03-25 18:03:16 +0000790 Disassembler *disassembler = Disassembler::FindPlugin(arch, NULL);
Sean Callanan65dafa82010-08-27 01:01:44 +0000791
792 if (disassembler == NULL)
793 {
794 ret.SetErrorToGenericError();
Greg Clayton940b1032011-02-23 00:35:02 +0000795 ret.SetErrorStringWithFormat("Unable to find disassembler plug-in for %s architecture.", arch.GetArchitectureName());
Sean Callanan65dafa82010-08-27 01:01:44 +0000796 return ret;
797 }
798
Greg Clayton567e7f32011-09-22 04:58:26 +0000799 if (!process)
Sean Callanan65dafa82010-08-27 01:01:44 +0000800 {
801 ret.SetErrorToGenericError();
802 ret.SetErrorString("Couldn't find the process");
803 return ret;
804 }
805
806 DataExtractor extractor(buffer_sp,
Greg Clayton567e7f32011-09-22 04:58:26 +0000807 process->GetByteOrder(),
808 target->GetArchitecture().GetAddressByteSize());
Sean Callanan65dafa82010-08-27 01:01:44 +0000809
Greg Claytone005f2c2010-11-06 01:53:30 +0000810 if (log)
Sean Callanan65dafa82010-08-27 01:01:44 +0000811 {
812 log->Printf("Function data has contents:");
Greg Claytone005f2c2010-11-06 01:53:30 +0000813 extractor.PutToLog (log.get(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000814 0,
815 extractor.GetByteSize(),
816 func_remote_addr,
817 16,
818 DataExtractor::TypeUInt8);
819 }
820
Jim Inghamaa3e3e12011-03-22 01:48:42 +0000821 disassembler->DecodeInstructions (Address (NULL, func_remote_addr), extractor, 0, UINT32_MAX, false);
Sean Callanan65dafa82010-08-27 01:01:44 +0000822
Greg Clayton5c4c7462010-10-06 03:09:58 +0000823 InstructionList &instruction_list = disassembler->GetInstructionList();
Greg Clayton889fbd02011-03-26 19:14:58 +0000824 const uint32_t max_opcode_byte_size = instruction_list.GetMaxOpcocdeByteSize();
Sean Callanan65dafa82010-08-27 01:01:44 +0000825 for (uint32_t instruction_index = 0, num_instructions = instruction_list.GetSize();
826 instruction_index < num_instructions;
827 ++instruction_index)
828 {
Greg Clayton5c4c7462010-10-06 03:09:58 +0000829 Instruction *instruction = instruction_list.GetInstructionAtIndex(instruction_index).get();
Sean Callanan65dafa82010-08-27 01:01:44 +0000830 instruction->Dump (&stream,
Greg Clayton889fbd02011-03-26 19:14:58 +0000831 max_opcode_byte_size,
Greg Clayton5c4c7462010-10-06 03:09:58 +0000832 true,
Greg Clayton149731c2011-03-25 18:03:16 +0000833 true,
Greg Clayton5c4c7462010-10-06 03:09:58 +0000834 &exe_ctx,
Sean Callanan65dafa82010-08-27 01:01:44 +0000835 true);
836 stream.PutChar('\n');
Sean Callanan65dafa82010-08-27 01:01:44 +0000837 }
838
839 return ret;
840}