blob: 51654626fcd9886bb4e6854efb90334c701b9ec8 [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 Callananf18d91c2010-09-01 00:58:00 +000020#include "lldb/Expression/IRDynamicChecks.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000021#include "lldb/Expression/IRForTarget.h"
22#include "lldb/Expression/IRToDWARF.h"
23#include "lldb/Expression/RecordingMemoryManager.h"
24#include "lldb/Target/ExecutionContext.h"
Sean Callananc7674af2011-01-17 23:42:46 +000025#include "lldb/Target/ObjCLanguageRuntime.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000026#include "lldb/Target/Process.h"
27#include "lldb/Target/Target.h"
28
29#include "clang/AST/ASTContext.h"
30#include "clang/AST/ExternalASTSource.h"
31#include "clang/Basic/FileManager.h"
32#include "clang/Basic/TargetInfo.h"
33#include "clang/Basic/Version.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000034#include "clang/CodeGen/CodeGenAction.h"
35#include "clang/CodeGen/ModuleBuilder.h"
36#include "clang/Driver/CC1Options.h"
37#include "clang/Driver/OptTable.h"
38#include "clang/Frontend/CompilerInstance.h"
39#include "clang/Frontend/CompilerInvocation.h"
40#include "clang/Frontend/FrontendActions.h"
41#include "clang/Frontend/FrontendDiagnostic.h"
42#include "clang/Frontend/FrontendPluginRegistry.h"
43#include "clang/Frontend/TextDiagnosticBuffer.h"
44#include "clang/Frontend/TextDiagnosticPrinter.h"
45#include "clang/Frontend/VerifyDiagnosticsClient.h"
46#include "clang/Lex/Preprocessor.h"
Sean Callanan47a5c4c2010-09-23 03:01:22 +000047#include "clang/Parse/ParseAST.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000048#include "clang/Rewrite/FrontendActions.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000049#include "clang/Sema/SemaConsumer.h"
Sean Callanan279584c2011-03-15 00:17:19 +000050#include "clang/StaticAnalyzer/Frontend/FrontendActions.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000051
52#include "llvm/ADT/StringRef.h"
53#include "llvm/ExecutionEngine/ExecutionEngine.h"
54#include "llvm/ExecutionEngine/JIT.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000055#include "llvm/LLVMContext.h"
Sean Callanan279584c2011-03-15 00:17:19 +000056#include "llvm/Module.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000057#include "llvm/Support/ErrorHandling.h"
58#include "llvm/Support/MemoryBuffer.h"
Greg Clayton22defe82010-12-02 23:20:03 +000059#include "llvm/Support/DynamicLibrary.h"
60#include "llvm/Support/Host.h"
61#include "llvm/Support/Signals.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000062#include "llvm/Target/TargetRegistry.h"
63#include "llvm/Target/TargetSelect.h"
64
65using namespace clang;
66using namespace llvm;
67using namespace lldb_private;
68
69//===----------------------------------------------------------------------===//
70// Utility Methods for Clang
71//===----------------------------------------------------------------------===//
72
73std::string GetBuiltinIncludePath(const char *Argv0) {
74 llvm::sys::Path P =
75 llvm::sys::Path::GetMainExecutable(Argv0,
76 (void*)(intptr_t) GetBuiltinIncludePath);
77
78 if (!P.isEmpty()) {
79 P.eraseComponent(); // Remove /clang from foo/bin/clang
80 P.eraseComponent(); // Remove /bin from foo/bin
81
82 // Get foo/lib/clang/<version>/include
83 P.appendComponent("lib");
84 P.appendComponent("clang");
85 P.appendComponent(CLANG_VERSION_STRING);
86 P.appendComponent("include");
87 }
88
89 return P.str();
90}
91
92
93//===----------------------------------------------------------------------===//
94// Main driver for Clang
95//===----------------------------------------------------------------------===//
96
97static void LLVMErrorHandler(void *UserData, const std::string &Message) {
98 Diagnostic &Diags = *static_cast<Diagnostic*>(UserData);
99
100 Diags.Report(diag::err_fe_error_backend) << Message;
101
102 // We cannot recover from llvm errors.
103 exit(1);
104}
105
106static FrontendAction *CreateFrontendBaseAction(CompilerInstance &CI) {
107 using namespace clang::frontend;
108
109 switch (CI.getFrontendOpts().ProgramAction) {
110 default:
111 llvm_unreachable("Invalid program action!");
112
113 case ASTDump: return new ASTDumpAction();
114 case ASTPrint: return new ASTPrintAction();
Sean Callanan279584c2011-03-15 00:17:19 +0000115 case ASTDumpXML: return new ASTDumpXMLAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000116 case ASTView: return new ASTViewAction();
117 case BoostCon: return new BoostConAction();
118 case DumpRawTokens: return new DumpRawTokensAction();
119 case DumpTokens: return new DumpTokensAction();
120 case EmitAssembly: return new EmitAssemblyAction();
121 case EmitBC: return new EmitBCAction();
122 case EmitHTML: return new HTMLPrintAction();
123 case EmitLLVM: return new EmitLLVMAction();
124 case EmitLLVMOnly: return new EmitLLVMOnlyAction();
125 case EmitCodeGenOnly: return new EmitCodeGenOnlyAction();
126 case EmitObj: return new EmitObjAction();
127 case FixIt: return new FixItAction();
128 case GeneratePCH: return new GeneratePCHAction();
129 case GeneratePTH: return new GeneratePTHAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000130 case InitOnly: return new InitOnlyAction();
131 case ParseSyntaxOnly: return new SyntaxOnlyAction();
132
133 case PluginAction: {
134 for (FrontendPluginRegistry::iterator it =
135 FrontendPluginRegistry::begin(), ie = FrontendPluginRegistry::end();
136 it != ie; ++it) {
137 if (it->getName() == CI.getFrontendOpts().ActionName) {
138 llvm::OwningPtr<PluginASTAction> P(it->instantiate());
139 if (!P->ParseArgs(CI, CI.getFrontendOpts().PluginArgs))
140 return 0;
141 return P.take();
142 }
143 }
144
145 CI.getDiagnostics().Report(diag::err_fe_invalid_plugin_name)
146 << CI.getFrontendOpts().ActionName;
147 return 0;
148 }
149
150 case PrintDeclContext: return new DeclContextPrintAction();
151 case PrintPreamble: return new PrintPreambleAction();
152 case PrintPreprocessedInput: return new PrintPreprocessedAction();
153 case RewriteMacros: return new RewriteMacrosAction();
154 case RewriteObjC: return new RewriteObjCAction();
155 case RewriteTest: return new RewriteTestAction();
Sean Callananad293092011-01-18 23:32:05 +0000156 //case RunAnalysis: return new AnalysisAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000157 case RunPreprocessorOnly: return new PreprocessOnlyAction();
158 }
159}
160
161static FrontendAction *CreateFrontendAction(CompilerInstance &CI) {
162 // Create the underlying action.
163 FrontendAction *Act = CreateFrontendBaseAction(CI);
164 if (!Act)
165 return 0;
166
167 // If there are any AST files to merge, create a frontend action
168 // adaptor to perform the merge.
169 if (!CI.getFrontendOpts().ASTMergeFiles.empty())
170 Act = new ASTMergeAction(Act, &CI.getFrontendOpts().ASTMergeFiles[0],
171 CI.getFrontendOpts().ASTMergeFiles.size());
172
173 return Act;
174}
175
176//===----------------------------------------------------------------------===//
177// Implementation of ClangExpressionParser
178//===----------------------------------------------------------------------===//
179
Greg Clayton395fc332011-02-15 21:59:32 +0000180ClangExpressionParser::ClangExpressionParser (ExecutionContextScope *exe_scope,
181 ClangExpression &expr) :
182 m_expr (expr),
Sean Callanan65dafa82010-08-27 01:01:44 +0000183 m_compiler (),
184 m_code_generator (NULL),
185 m_execution_engine (),
186 m_jitted_functions ()
187{
188 // Initialize targets first, so that --version shows registered targets.
189 static struct InitializeLLVM {
190 InitializeLLVM() {
191 llvm::InitializeAllTargets();
192 llvm::InitializeAllAsmPrinters();
193 }
194 } InitializeLLVM;
Greg Clayton395fc332011-02-15 21:59:32 +0000195
Sean Callanan65dafa82010-08-27 01:01:44 +0000196 // 1. Create a new compiler instance.
197 m_compiler.reset(new CompilerInstance());
Sean Callanan65dafa82010-08-27 01:01:44 +0000198
199 // 2. Set options.
200
201 // Parse expressions as Objective C++ regardless of context.
202 // Our hook into Clang's lookup mechanism only works in C++.
203 m_compiler->getLangOpts().CPlusPlus = true;
Greg Claytonf51ed302011-01-15 01:32:14 +0000204
205 // Setup objective C
Sean Callanan65dafa82010-08-27 01:01:44 +0000206 m_compiler->getLangOpts().ObjC1 = true;
Greg Claytonf51ed302011-01-15 01:32:14 +0000207 m_compiler->getLangOpts().ObjC2 = true;
Sean Callananc7674af2011-01-17 23:42:46 +0000208
Greg Clayton395fc332011-02-15 21:59:32 +0000209 Process *process = NULL;
210 if (exe_scope)
211 process = exe_scope->CalculateProcess();
212
Sean Callananc7674af2011-01-17 23:42:46 +0000213 if (process)
214 {
215 if (process->GetObjCLanguageRuntime())
216 {
Greg Claytonb3448432011-03-24 21:19:54 +0000217 if (process->GetObjCLanguageRuntime()->GetRuntimeVersion() == eAppleObjC_V2)
Sean Callananc7674af2011-01-17 23:42:46 +0000218 {
219 m_compiler->getLangOpts().ObjCNonFragileABI = true; // NOT i386
220 m_compiler->getLangOpts().ObjCNonFragileABI2 = true; // NOT i386
221 }
222 }
223 }
Greg Claytonf51ed302011-01-15 01:32:14 +0000224
Sean Callanan65dafa82010-08-27 01:01:44 +0000225 m_compiler->getLangOpts().ThreadsafeStatics = false;
226 m_compiler->getLangOpts().AccessControl = false; // Debuggers get universal access
227 m_compiler->getLangOpts().DollarIdents = true; // $ indicates a persistent variable name
228
229 // Set CodeGen options
230 m_compiler->getCodeGenOpts().EmitDeclMetadata = true;
231 m_compiler->getCodeGenOpts().InstrumentFunctions = false;
232
233 // Disable some warnings.
234 m_compiler->getDiagnosticOpts().Warnings.push_back("no-unused-value");
235
236 // Set the target triple.
Greg Clayton395fc332011-02-15 21:59:32 +0000237 Target *target = NULL;
238 if (exe_scope)
239 target = exe_scope->CalculateTarget();
240
241 // TODO: figure out what to really do when we don't have a valid target.
242 // Sometimes this will be ok to just use the host target triple (when we
243 // evaluate say "2+3", but other expressions like breakpoint conditions
244 // and other things that _are_ target specific really shouldn't just be
245 // using the host triple. This needs to be fixed in a better way.
246 if (target && target->GetArchitecture().IsValid())
Sean Callanan2a8c3382011-04-14 02:01:31 +0000247 {
248 std::string triple = target->GetArchitecture().GetTriple().str();
249
250 int dash_count = 0;
251 for (int i = 0; i < triple.size(); ++i)
252 {
253 if (triple[i] == '-')
254 dash_count++;
255 if (dash_count == 3)
256 {
257 triple.resize(i);
258 break;
259 }
260 }
261
262 m_compiler->getTargetOpts().Triple = triple;
263 }
Greg Clayton395fc332011-02-15 21:59:32 +0000264 else
Sean Callanan2a8c3382011-04-14 02:01:31 +0000265 {
Greg Clayton395fc332011-02-15 21:59:32 +0000266 m_compiler->getTargetOpts().Triple = llvm::sys::getHostTriple();
Sean Callanan2a8c3382011-04-14 02:01:31 +0000267 }
268
Sean Callanan65dafa82010-08-27 01:01:44 +0000269 // 3. Set up various important bits of infrastructure.
270 m_compiler->createDiagnostics(0, 0);
271
272 // Create the target instance.
273 m_compiler->setTarget(TargetInfo::CreateTargetInfo(m_compiler->getDiagnostics(),
274 m_compiler->getTargetOpts()));
275
276 assert (m_compiler->hasTarget());
277
278 // Inform the target of the language options
279 //
280 // FIXME: We shouldn't need to do this, the target should be immutable once
281 // created. This complexity should be lifted elsewhere.
282 m_compiler->getTarget().setForcedLangOptions(m_compiler->getLangOpts());
283
284 // 4. Set up the diagnostic buffer for reporting errors
285
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000286 m_compiler->getDiagnostics().setClient(new clang::TextDiagnosticBuffer);
Sean Callanan65dafa82010-08-27 01:01:44 +0000287
288 // 5. Set up the source management objects inside the compiler
289
Greg Clayton22defe82010-12-02 23:20:03 +0000290 clang::FileSystemOptions file_system_options;
291 m_file_manager.reset(new clang::FileManager(file_system_options));
Sean Callanan8a3b0a82010-11-18 02:56:27 +0000292
Sean Callanan65dafa82010-08-27 01:01:44 +0000293 if (!m_compiler->hasSourceManager())
Greg Clayton22defe82010-12-02 23:20:03 +0000294 m_compiler->createSourceManager(*m_file_manager.get());
Sean Callanan65dafa82010-08-27 01:01:44 +0000295
296 m_compiler->createFileManager();
297 m_compiler->createPreprocessor();
298
299 // 6. Most of this we get from the CompilerInstance, but we
300 // also want to give the context an ExternalASTSource.
Sean Callananee8fc722010-11-19 20:20:02 +0000301 m_selector_table.reset(new SelectorTable());
Sean Callanan65dafa82010-08-27 01:01:44 +0000302 m_builtin_context.reset(new Builtin::Context(m_compiler->getTarget()));
303
304 std::auto_ptr<clang::ASTContext> ast_context(new ASTContext(m_compiler->getLangOpts(),
305 m_compiler->getSourceManager(),
306 m_compiler->getTarget(),
307 m_compiler->getPreprocessor().getIdentifierTable(),
Sean Callananee8fc722010-11-19 20:20:02 +0000308 *m_selector_table.get(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000309 *m_builtin_context.get(),
310 0));
311
312 ClangExpressionDeclMap *decl_map = m_expr.DeclMap();
313
314 if (decl_map)
315 {
316 OwningPtr<clang::ExternalASTSource> ast_source(new ClangASTSource(*ast_context, *decl_map));
317 ast_context->setExternalSource(ast_source);
318 }
319
320 m_compiler->setASTContext(ast_context.release());
321
Greg Clayton8de27c72010-10-15 22:48:33 +0000322 std::string module_name("$__lldb_module");
Sean Callanan65dafa82010-08-27 01:01:44 +0000323
Sean Callanan279584c2011-03-15 00:17:19 +0000324 m_llvm_context.reset(new LLVMContext());
Sean Callanan65dafa82010-08-27 01:01:44 +0000325 m_code_generator.reset(CreateLLVMCodeGen(m_compiler->getDiagnostics(),
326 module_name,
327 m_compiler->getCodeGenOpts(),
Sean Callanan279584c2011-03-15 00:17:19 +0000328 *m_llvm_context));
Sean Callanan65dafa82010-08-27 01:01:44 +0000329}
330
331ClangExpressionParser::~ClangExpressionParser()
332{
333}
334
335unsigned
336ClangExpressionParser::Parse (Stream &stream)
337{
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000338 TextDiagnosticBuffer *diag_buf = static_cast<TextDiagnosticBuffer*>(m_compiler->getDiagnostics().getClient());
339
340 diag_buf->FlushDiagnostics (m_compiler->getDiagnostics());
Sean Callanan65dafa82010-08-27 01:01:44 +0000341
342 MemoryBuffer *memory_buffer = MemoryBuffer::getMemBufferCopy(m_expr.Text(), __FUNCTION__);
343 FileID memory_buffer_file_id = m_compiler->getSourceManager().createMainFileIDForMemBuffer (memory_buffer);
344
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000345 diag_buf->BeginSourceFile(m_compiler->getLangOpts(), &m_compiler->getPreprocessor());
Sean Callanan65dafa82010-08-27 01:01:44 +0000346
347 ASTConsumer *ast_transformer = m_expr.ASTTransformer(m_code_generator.get());
348
349 if (ast_transformer)
350 ParseAST(m_compiler->getPreprocessor(), ast_transformer, m_compiler->getASTContext());
351 else
352 ParseAST(m_compiler->getPreprocessor(), m_code_generator.get(), m_compiler->getASTContext());
353
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000354 diag_buf->EndSourceFile();
Sean Callanan65dafa82010-08-27 01:01:44 +0000355
356 TextDiagnosticBuffer::const_iterator diag_iterator;
357
358 int num_errors = 0;
Sean Callanan7617c292010-11-01 20:28:09 +0000359
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000360 for (diag_iterator = diag_buf->warn_begin();
361 diag_iterator != diag_buf->warn_end();
Sean Callanan65dafa82010-08-27 01:01:44 +0000362 ++diag_iterator)
363 stream.Printf("warning: %s\n", (*diag_iterator).second.c_str());
364
365 num_errors = 0;
366
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000367 for (diag_iterator = diag_buf->err_begin();
368 diag_iterator != diag_buf->err_end();
Sean Callanan65dafa82010-08-27 01:01:44 +0000369 ++diag_iterator)
370 {
371 num_errors++;
372 stream.Printf("error: %s\n", (*diag_iterator).second.c_str());
373 }
374
Sean Callanan7617c292010-11-01 20:28:09 +0000375 for (diag_iterator = diag_buf->note_begin();
376 diag_iterator != diag_buf->note_end();
377 ++diag_iterator)
378 stream.Printf("note: %s\n", (*diag_iterator).second.c_str());
379
Sean Callanan65dafa82010-08-27 01:01:44 +0000380 return num_errors;
381}
382
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000383static bool FindFunctionInModule (std::string &mangled_name,
384 llvm::Module *module,
385 const char *orig_name)
386{
387 for (llvm::Module::iterator fi = module->getFunctionList().begin(), fe = module->getFunctionList().end();
388 fi != fe;
389 ++fi)
390 {
391 if (fi->getName().str().find(orig_name) != std::string::npos)
392 {
393 mangled_name = fi->getName().str();
394 return true;
395 }
396 }
397
398 return false;
399}
400
Sean Callanan65dafa82010-08-27 01:01:44 +0000401Error
402ClangExpressionParser::MakeDWARF ()
403{
404 Error err;
405
406 llvm::Module *module = m_code_generator->GetModule();
407
408 if (!module)
409 {
410 err.SetErrorToGenericError();
411 err.SetErrorString("IR doesn't contain a module");
412 return err;
413 }
414
Greg Clayton427f2902010-12-14 02:59:59 +0000415 ClangExpressionVariableList *local_variables = m_expr.LocalVariables();
Sean Callanan65dafa82010-08-27 01:01:44 +0000416 ClangExpressionDeclMap *decl_map = m_expr.DeclMap();
417
418 if (!local_variables)
419 {
420 err.SetErrorToGenericError();
421 err.SetErrorString("Can't convert an expression without a VariableList to DWARF");
422 return err;
423 }
424
425 if (!decl_map)
426 {
427 err.SetErrorToGenericError();
428 err.SetErrorString("Can't convert an expression without a DeclMap to DWARF");
429 return err;
430 }
431
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000432 std::string function_name;
433
434 if (!FindFunctionInModule(function_name, module, m_expr.FunctionName()))
435 {
436 err.SetErrorToGenericError();
437 err.SetErrorStringWithFormat("Couldn't find %s() in the module", m_expr.FunctionName());
438 return err;
439 }
440
441 IRToDWARF ir_to_dwarf(*local_variables, decl_map, m_expr.DwarfOpcodeStream(), function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000442
443 if (!ir_to_dwarf.runOnModule(*module))
444 {
445 err.SetErrorToGenericError();
446 err.SetErrorString("Couldn't convert the expression to DWARF");
447 return err;
448 }
449
450 err.Clear();
451 return err;
452}
453
454Error
Greg Claytond0882d02011-01-19 23:00:49 +0000455ClangExpressionParser::MakeJIT (lldb::addr_t &func_allocation_addr,
456 lldb::addr_t &func_addr,
Sean Callanan830a9032010-08-27 23:31:21 +0000457 lldb::addr_t &func_end,
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000458 ExecutionContext &exe_ctx,
Sean Callanan696cf5f2011-05-07 01:06:41 +0000459 lldb::ClangExpressionVariableSP &const_result,
460 bool jit_only_if_needed)
Sean Callanan65dafa82010-08-27 01:01:44 +0000461{
Greg Claytond0882d02011-01-19 23:00:49 +0000462 func_allocation_addr = LLDB_INVALID_ADDRESS;
463 func_addr = LLDB_INVALID_ADDRESS;
464 func_end = LLDB_INVALID_ADDRESS;
Greg Claytone005f2c2010-11-06 01:53:30 +0000465 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000466
Sean Callanan65dafa82010-08-27 01:01:44 +0000467 Error err;
468
469 llvm::Module *module = m_code_generator->ReleaseModule();
470
471 if (!module)
472 {
473 err.SetErrorToGenericError();
474 err.SetErrorString("IR doesn't contain a module");
475 return err;
476 }
477
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000478 // Find the actual name of the function (it's often mangled somehow)
479
480 std::string function_name;
481
482 if (!FindFunctionInModule(function_name, module, m_expr.FunctionName()))
483 {
484 err.SetErrorToGenericError();
485 err.SetErrorStringWithFormat("Couldn't find %s() in the module", m_expr.FunctionName());
486 return err;
487 }
488 else
489 {
490 if(log)
491 log->Printf("Found function %s for %s", function_name.c_str(), m_expr.FunctionName());
492 }
493
Sean Callanan65dafa82010-08-27 01:01:44 +0000494 ClangExpressionDeclMap *decl_map = m_expr.DeclMap(); // result can be NULL
495
496 if (decl_map)
497 {
Sean Callanan97c924e2011-01-27 01:07:04 +0000498 Stream *error_stream = NULL;
499
500 if (exe_ctx.target)
501 error_stream = &exe_ctx.target->GetDebugger().GetErrorStream();
502
Sean Callanane8a59a82010-09-13 21:34:21 +0000503 IRForTarget ir_for_target(decl_map,
Sean Callanane8a59a82010-09-13 21:34:21 +0000504 m_expr.NeedsVariableResolution(),
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000505 const_result,
Sean Callanan97c924e2011-01-27 01:07:04 +0000506 error_stream,
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000507 function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000508
509 if (!ir_for_target.runOnModule(*module))
510 {
511 err.SetErrorToGenericError();
512 err.SetErrorString("Couldn't convert the expression to DWARF");
513 return err;
514 }
Sean Callananf18d91c2010-09-01 00:58:00 +0000515
Sean Callanan696cf5f2011-05-07 01:06:41 +0000516 if (jit_only_if_needed && const_result.get())
517 {
518 err.Clear();
519 return err;
520 }
521
Jim Inghamd1686902010-10-14 23:45:03 +0000522 if (m_expr.NeedsValidation() && exe_ctx.process->GetDynamicCheckers())
Sean Callananf18d91c2010-09-01 00:58:00 +0000523 {
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000524 IRDynamicChecks ir_dynamic_checks(*exe_ctx.process->GetDynamicCheckers(), function_name.c_str());
Sean Callanane8a59a82010-09-13 21:34:21 +0000525
526 if (!ir_dynamic_checks.runOnModule(*module))
527 {
528 err.SetErrorToGenericError();
529 err.SetErrorString("Couldn't add dynamic checks to the expression");
530 return err;
531 }
532 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000533 }
534
Greg Claytond0882d02011-01-19 23:00:49 +0000535 // llvm will own this pointer when llvm::ExecutionEngine::createJIT is called
536 // below so we don't need to free it.
537 RecordingMemoryManager *jit_memory_manager = new RecordingMemoryManager();
Sean Callanan65dafa82010-08-27 01:01:44 +0000538
539 std::string error_string;
Sean Callanan9ac3a962010-11-02 23:20:00 +0000540
Sean Callananc2c6f772010-10-26 00:31:56 +0000541 llvm::TargetMachine::setRelocationModel(llvm::Reloc::PIC_);
542
Sean Callanan65dafa82010-08-27 01:01:44 +0000543 m_execution_engine.reset(llvm::ExecutionEngine::createJIT (module,
544 &error_string,
Greg Claytond0882d02011-01-19 23:00:49 +0000545 jit_memory_manager,
Sean Callananc2c6f772010-10-26 00:31:56 +0000546 CodeGenOpt::Less,
Sean Callanan65dafa82010-08-27 01:01:44 +0000547 true,
548 CodeModel::Small));
Sean Callanan9ac3a962010-11-02 23:20:00 +0000549
Sean Callanan65dafa82010-08-27 01:01:44 +0000550 if (!m_execution_engine.get())
551 {
552 err.SetErrorToGenericError();
553 err.SetErrorStringWithFormat("Couldn't JIT the function: %s", error_string.c_str());
554 return err;
555 }
556
557 m_execution_engine->DisableLazyCompilation();
558
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000559 llvm::Function *function = module->getFunction (function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000560
561 // We don't actually need the function pointer here, this just forces it to get resolved.
562
563 void *fun_ptr = m_execution_engine->getPointerToFunction(function);
564
565 // Errors usually cause failures in the JIT, but if we're lucky we get here.
566
567 if (!fun_ptr)
568 {
569 err.SetErrorToGenericError();
570 err.SetErrorString("Couldn't JIT the function");
571 return err;
572 }
573
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000574 m_jitted_functions.push_back (ClangExpressionParser::JittedFunction(function_name.c_str(), (lldb::addr_t)fun_ptr));
Sean Callanan65dafa82010-08-27 01:01:44 +0000575
576 ExecutionContext &exc_context(exe_ctx);
577
578 if (exc_context.process == NULL)
579 {
580 err.SetErrorToGenericError();
581 err.SetErrorString("Couldn't write the JIT compiled code into the target because there is no target");
582 return err;
583 }
584
585 // Look over the regions allocated for the function compiled. The JIT
586 // tries to allocate the functions & stubs close together, so we should try to
587 // write them that way too...
588 // For now I only write functions with no stubs, globals, exception tables,
589 // etc. So I only need to write the functions.
590
591 size_t alloc_size = 0;
592
Greg Claytond0882d02011-01-19 23:00:49 +0000593 std::map<uint8_t *, uint8_t *>::iterator fun_pos = jit_memory_manager->m_functions.begin();
594 std::map<uint8_t *, uint8_t *>::iterator fun_end = jit_memory_manager->m_functions.end();
Sean Callanan65dafa82010-08-27 01:01:44 +0000595
596 for (; fun_pos != fun_end; ++fun_pos)
597 alloc_size += (*fun_pos).second - (*fun_pos).first;
598
599 Error alloc_error;
Greg Claytond0882d02011-01-19 23:00:49 +0000600 func_allocation_addr = exc_context.process->AllocateMemory (alloc_size,
601 lldb::ePermissionsReadable|lldb::ePermissionsExecutable,
602 alloc_error);
Sean Callanan65dafa82010-08-27 01:01:44 +0000603
Greg Claytond0882d02011-01-19 23:00:49 +0000604 if (func_allocation_addr == LLDB_INVALID_ADDRESS)
Sean Callanan65dafa82010-08-27 01:01:44 +0000605 {
606 err.SetErrorToGenericError();
607 err.SetErrorStringWithFormat("Couldn't allocate memory for the JITted function: %s", alloc_error.AsCString("unknown error"));
608 return err;
609 }
610
Greg Claytond0882d02011-01-19 23:00:49 +0000611 lldb::addr_t cursor = func_allocation_addr;
Sean Callanan65dafa82010-08-27 01:01:44 +0000612
Greg Claytond0882d02011-01-19 23:00:49 +0000613 for (fun_pos = jit_memory_manager->m_functions.begin(); fun_pos != fun_end; fun_pos++)
Sean Callanan65dafa82010-08-27 01:01:44 +0000614 {
615 lldb::addr_t lstart = (lldb::addr_t) (*fun_pos).first;
616 lldb::addr_t lend = (lldb::addr_t) (*fun_pos).second;
617 size_t size = lend - lstart;
618
619 Error write_error;
620
621 if (exc_context.process->WriteMemory(cursor, (void *) lstart, size, write_error) != size)
622 {
623 err.SetErrorToGenericError();
624 err.SetErrorStringWithFormat("Couldn't copy JITted function into the target: %s", write_error.AsCString("unknown error"));
625 return err;
626 }
627
Greg Claytond0882d02011-01-19 23:00:49 +0000628 jit_memory_manager->AddToLocalToRemoteMap (lstart, size, cursor);
Sean Callanan65dafa82010-08-27 01:01:44 +0000629 cursor += size;
630 }
631
632 std::vector<JittedFunction>::iterator pos, end = m_jitted_functions.end();
633
634 for (pos = m_jitted_functions.begin(); pos != end; pos++)
635 {
Greg Claytond0882d02011-01-19 23:00:49 +0000636 (*pos).m_remote_addr = jit_memory_manager->GetRemoteAddressForLocal ((*pos).m_local_addr);
Sean Callanan65dafa82010-08-27 01:01:44 +0000637
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000638 if (!(*pos).m_name.compare(function_name.c_str()))
Sean Callanan830a9032010-08-27 23:31:21 +0000639 {
Greg Claytond0882d02011-01-19 23:00:49 +0000640 func_end = jit_memory_manager->GetRemoteRangeForLocal ((*pos).m_local_addr).second;
Sean Callanan65dafa82010-08-27 01:01:44 +0000641 func_addr = (*pos).m_remote_addr;
Sean Callanan830a9032010-08-27 23:31:21 +0000642 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000643 }
644
Sean Callanan6dff8272010-11-08 03:49:50 +0000645 if (log)
646 {
647 log->Printf("Code can be run in the target.");
648
649 StreamString disassembly_stream;
650
Greg Claytond0882d02011-01-19 23:00:49 +0000651 Error err = DisassembleFunction(disassembly_stream, exe_ctx, jit_memory_manager);
Sean Callanan6dff8272010-11-08 03:49:50 +0000652
653 if (!err.Success())
654 {
655 log->Printf("Couldn't disassemble function : %s", err.AsCString("unknown error"));
656 }
657 else
658 {
659 log->Printf("Function disassembly:\n%s", disassembly_stream.GetData());
660 }
661 }
662
Sean Callanan65dafa82010-08-27 01:01:44 +0000663 err.Clear();
664 return err;
665}
666
667Error
Greg Claytond0882d02011-01-19 23:00:49 +0000668ClangExpressionParser::DisassembleFunction (Stream &stream, ExecutionContext &exe_ctx, RecordingMemoryManager *jit_memory_manager)
Sean Callanan65dafa82010-08-27 01:01:44 +0000669{
Greg Claytone005f2c2010-11-06 01:53:30 +0000670 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan65dafa82010-08-27 01:01:44 +0000671
672 const char *name = m_expr.FunctionName();
673
674 Error ret;
675
676 ret.Clear();
677
678 lldb::addr_t func_local_addr = LLDB_INVALID_ADDRESS;
679 lldb::addr_t func_remote_addr = LLDB_INVALID_ADDRESS;
680
681 std::vector<JittedFunction>::iterator pos, end = m_jitted_functions.end();
682
683 for (pos = m_jitted_functions.begin(); pos < end; pos++)
684 {
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000685 if (strstr(pos->m_name.c_str(), name))
Sean Callanan65dafa82010-08-27 01:01:44 +0000686 {
687 func_local_addr = pos->m_local_addr;
688 func_remote_addr = pos->m_remote_addr;
689 }
690 }
691
692 if (func_local_addr == LLDB_INVALID_ADDRESS)
693 {
694 ret.SetErrorToGenericError();
695 ret.SetErrorStringWithFormat("Couldn't find function %s for disassembly", name);
696 return ret;
697 }
698
699 if(log)
700 log->Printf("Found function, has local address 0x%llx and remote address 0x%llx", (uint64_t)func_local_addr, (uint64_t)func_remote_addr);
701
702 std::pair <lldb::addr_t, lldb::addr_t> func_range;
703
Greg Claytond0882d02011-01-19 23:00:49 +0000704 func_range = jit_memory_manager->GetRemoteRangeForLocal(func_local_addr);
Sean Callanan65dafa82010-08-27 01:01:44 +0000705
706 if (func_range.first == 0 && func_range.second == 0)
707 {
708 ret.SetErrorToGenericError();
709 ret.SetErrorStringWithFormat("Couldn't find code range for function %s", name);
710 return ret;
711 }
712
713 if(log)
714 log->Printf("Function's code range is [0x%llx-0x%llx]", func_range.first, func_range.second);
715
716 if (!exe_ctx.target)
717 {
718 ret.SetErrorToGenericError();
719 ret.SetErrorString("Couldn't find the target");
720 }
721
722 lldb::DataBufferSP buffer_sp(new DataBufferHeap(func_range.second - func_remote_addr, 0));
723
724 Error err;
725 exe_ctx.process->ReadMemory(func_remote_addr, buffer_sp->GetBytes(), buffer_sp->GetByteSize(), err);
726
727 if (!err.Success())
728 {
729 ret.SetErrorToGenericError();
730 ret.SetErrorStringWithFormat("Couldn't read from process: %s", err.AsCString("unknown error"));
731 return ret;
732 }
733
734 ArchSpec arch(exe_ctx.target->GetArchitecture());
735
Greg Clayton149731c2011-03-25 18:03:16 +0000736 Disassembler *disassembler = Disassembler::FindPlugin(arch, NULL);
Sean Callanan65dafa82010-08-27 01:01:44 +0000737
738 if (disassembler == NULL)
739 {
740 ret.SetErrorToGenericError();
Greg Clayton940b1032011-02-23 00:35:02 +0000741 ret.SetErrorStringWithFormat("Unable to find disassembler plug-in for %s architecture.", arch.GetArchitectureName());
Sean Callanan65dafa82010-08-27 01:01:44 +0000742 return ret;
743 }
744
745 if (!exe_ctx.process)
746 {
747 ret.SetErrorToGenericError();
748 ret.SetErrorString("Couldn't find the process");
749 return ret;
750 }
751
752 DataExtractor extractor(buffer_sp,
753 exe_ctx.process->GetByteOrder(),
754 exe_ctx.target->GetArchitecture().GetAddressByteSize());
755
Greg Claytone005f2c2010-11-06 01:53:30 +0000756 if (log)
Sean Callanan65dafa82010-08-27 01:01:44 +0000757 {
758 log->Printf("Function data has contents:");
Greg Claytone005f2c2010-11-06 01:53:30 +0000759 extractor.PutToLog (log.get(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000760 0,
761 extractor.GetByteSize(),
762 func_remote_addr,
763 16,
764 DataExtractor::TypeUInt8);
765 }
766
Jim Inghamaa3e3e12011-03-22 01:48:42 +0000767 disassembler->DecodeInstructions (Address (NULL, func_remote_addr), extractor, 0, UINT32_MAX, false);
Sean Callanan65dafa82010-08-27 01:01:44 +0000768
Greg Clayton5c4c7462010-10-06 03:09:58 +0000769 InstructionList &instruction_list = disassembler->GetInstructionList();
Greg Clayton889fbd02011-03-26 19:14:58 +0000770 const uint32_t max_opcode_byte_size = instruction_list.GetMaxOpcocdeByteSize();
Sean Callanan65dafa82010-08-27 01:01:44 +0000771 for (uint32_t instruction_index = 0, num_instructions = instruction_list.GetSize();
772 instruction_index < num_instructions;
773 ++instruction_index)
774 {
Greg Clayton5c4c7462010-10-06 03:09:58 +0000775 Instruction *instruction = instruction_list.GetInstructionAtIndex(instruction_index).get();
Sean Callanan65dafa82010-08-27 01:01:44 +0000776 instruction->Dump (&stream,
Greg Clayton889fbd02011-03-26 19:14:58 +0000777 max_opcode_byte_size,
Greg Clayton5c4c7462010-10-06 03:09:58 +0000778 true,
Greg Clayton149731c2011-03-25 18:03:16 +0000779 true,
Greg Clayton5c4c7462010-10-06 03:09:58 +0000780 &exe_ctx,
Sean Callanan65dafa82010-08-27 01:01:44 +0000781 true);
782 stream.PutChar('\n');
Sean Callanan65dafa82010-08-27 01:01:44 +0000783 }
784
785 return ret;
786}