blob: 1bf791bfc0898c389522e3f362036a89ed001ba2 [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 Callanan06dc17f2012-09-24 22:25:51 +000046#include "clang/Rewrite/Frontend/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 Callanan06dc17f2012-09-24 22:25:51 +000052#include "llvm/Support/Debug.h"
Sean Callananc1535182011-10-07 23:18:13 +000053#include "llvm/Support/TargetSelect.h"
Greg Clayton2f085c62011-05-15 01:25:55 +000054
Peter Collingbournec3f55732011-06-03 20:40:12 +000055#if !defined(__APPLE__)
56#define USE_STANDARD_JIT
57#endif
58
Greg Clayton2f085c62011-05-15 01:25:55 +000059#if defined (USE_STANDARD_JIT)
Sean Callanan65dafa82010-08-27 01:01:44 +000060#include "llvm/ExecutionEngine/JIT.h"
Greg Clayton2f085c62011-05-15 01:25:55 +000061#else
62#include "llvm/ExecutionEngine/MCJIT.h"
63#endif
Sean Callanan65dafa82010-08-27 01:01:44 +000064#include "llvm/LLVMContext.h"
Sean Callanan279584c2011-03-15 00:17:19 +000065#include "llvm/Module.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000066#include "llvm/Support/ErrorHandling.h"
67#include "llvm/Support/MemoryBuffer.h"
Greg Clayton22defe82010-12-02 23:20:03 +000068#include "llvm/Support/DynamicLibrary.h"
69#include "llvm/Support/Host.h"
70#include "llvm/Support/Signals.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000071
72using namespace clang;
73using namespace llvm;
74using namespace lldb_private;
75
76//===----------------------------------------------------------------------===//
77// Utility Methods for Clang
78//===----------------------------------------------------------------------===//
79
80std::string GetBuiltinIncludePath(const char *Argv0) {
81 llvm::sys::Path P =
82 llvm::sys::Path::GetMainExecutable(Argv0,
83 (void*)(intptr_t) GetBuiltinIncludePath);
84
85 if (!P.isEmpty()) {
86 P.eraseComponent(); // Remove /clang from foo/bin/clang
87 P.eraseComponent(); // Remove /bin from foo/bin
88
89 // Get foo/lib/clang/<version>/include
90 P.appendComponent("lib");
91 P.appendComponent("clang");
92 P.appendComponent(CLANG_VERSION_STRING);
93 P.appendComponent("include");
94 }
95
96 return P.str();
97}
98
99
100//===----------------------------------------------------------------------===//
101// Main driver for Clang
102//===----------------------------------------------------------------------===//
103
104static void LLVMErrorHandler(void *UserData, const std::string &Message) {
Sean Callananc1535182011-10-07 23:18:13 +0000105 DiagnosticsEngine &Diags = *static_cast<DiagnosticsEngine*>(UserData);
Sean Callanan65dafa82010-08-27 01:01:44 +0000106
107 Diags.Report(diag::err_fe_error_backend) << Message;
108
109 // We cannot recover from llvm errors.
Sean Callananc1535182011-10-07 23:18:13 +0000110 assert(0);
Sean Callanan65dafa82010-08-27 01:01:44 +0000111}
112
113static FrontendAction *CreateFrontendBaseAction(CompilerInstance &CI) {
114 using namespace clang::frontend;
115
116 switch (CI.getFrontendOpts().ProgramAction) {
117 default:
118 llvm_unreachable("Invalid program action!");
119
120 case ASTDump: return new ASTDumpAction();
121 case ASTPrint: return new ASTPrintAction();
Sean Callanan279584c2011-03-15 00:17:19 +0000122 case ASTDumpXML: return new ASTDumpXMLAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000123 case ASTView: return new ASTViewAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000124 case DumpRawTokens: return new DumpRawTokensAction();
125 case DumpTokens: return new DumpTokensAction();
126 case EmitAssembly: return new EmitAssemblyAction();
127 case EmitBC: return new EmitBCAction();
128 case EmitHTML: return new HTMLPrintAction();
129 case EmitLLVM: return new EmitLLVMAction();
130 case EmitLLVMOnly: return new EmitLLVMOnlyAction();
131 case EmitCodeGenOnly: return new EmitCodeGenOnlyAction();
132 case EmitObj: return new EmitObjAction();
133 case FixIt: return new FixItAction();
Sean Callanan05230832011-12-01 04:31:46 +0000134 case GeneratePCH: return new GeneratePCHAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000135 case GeneratePTH: return new GeneratePTHAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000136 case InitOnly: return new InitOnlyAction();
137 case ParseSyntaxOnly: return new SyntaxOnlyAction();
138
139 case PluginAction: {
140 for (FrontendPluginRegistry::iterator it =
141 FrontendPluginRegistry::begin(), ie = FrontendPluginRegistry::end();
142 it != ie; ++it) {
143 if (it->getName() == CI.getFrontendOpts().ActionName) {
144 llvm::OwningPtr<PluginASTAction> P(it->instantiate());
145 if (!P->ParseArgs(CI, CI.getFrontendOpts().PluginArgs))
146 return 0;
147 return P.take();
148 }
149 }
150
151 CI.getDiagnostics().Report(diag::err_fe_invalid_plugin_name)
152 << CI.getFrontendOpts().ActionName;
153 return 0;
154 }
155
156 case PrintDeclContext: return new DeclContextPrintAction();
157 case PrintPreamble: return new PrintPreambleAction();
158 case PrintPreprocessedInput: return new PrintPreprocessedAction();
159 case RewriteMacros: return new RewriteMacrosAction();
160 case RewriteObjC: return new RewriteObjCAction();
161 case RewriteTest: return new RewriteTestAction();
Sean Callananad293092011-01-18 23:32:05 +0000162 //case RunAnalysis: return new AnalysisAction();
Sean Callanan65dafa82010-08-27 01:01:44 +0000163 case RunPreprocessorOnly: return new PreprocessOnlyAction();
164 }
165}
166
167static FrontendAction *CreateFrontendAction(CompilerInstance &CI) {
168 // Create the underlying action.
169 FrontendAction *Act = CreateFrontendBaseAction(CI);
170 if (!Act)
171 return 0;
172
173 // If there are any AST files to merge, create a frontend action
174 // adaptor to perform the merge.
175 if (!CI.getFrontendOpts().ASTMergeFiles.empty())
Sean Callanan8f2e3922012-02-04 08:49:35 +0000176 Act = new ASTMergeAction(Act, CI.getFrontendOpts().ASTMergeFiles);
Sean Callanan65dafa82010-08-27 01:01:44 +0000177
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),
Sean Callanan65dafa82010-08-27 01:01:44 +0000190 m_jitted_functions ()
191{
192 // Initialize targets first, so that --version shows registered targets.
193 static struct InitializeLLVM {
194 InitializeLLVM() {
195 llvm::InitializeAllTargets();
196 llvm::InitializeAllAsmPrinters();
Sean Callanan9b6898f2011-07-30 02:42:06 +0000197 llvm::InitializeAllTargetMCs();
Sean Callanan05230832011-12-01 04:31:46 +0000198 llvm::InitializeAllDisassemblers();
Sean Callanan877e57b2012-09-06 01:39:02 +0000199
200 llvm::DisablePrettyStackTrace = true;
Sean Callanan65dafa82010-08-27 01:01:44 +0000201 }
202 } InitializeLLVM;
Sean Callanan06dc17f2012-09-24 22:25:51 +0000203
Sean Callanan65dafa82010-08-27 01:01:44 +0000204 // 1. Create a new compiler instance.
205 m_compiler.reset(new CompilerInstance());
Sean Callanan65dafa82010-08-27 01:01:44 +0000206
Sean Callanan06dc17f2012-09-24 22:25:51 +0000207 // 2. Install the target.
208
209 lldb::TargetSP target_sp;
210 if (exe_scope)
211 target_sp = exe_scope->CalculateTarget();
212
213 // TODO: figure out what to really do when we don't have a valid target.
214 // Sometimes this will be ok to just use the host target triple (when we
215 // evaluate say "2+3", but other expressions like breakpoint conditions
216 // and other things that _are_ target specific really shouldn't just be
217 // using the host triple. This needs to be fixed in a better way.
218 if (target_sp && target_sp->GetArchitecture().IsValid())
219 {
220 std::string triple = target_sp->GetArchitecture().GetTriple().str();
221
222 int dash_count = 0;
223 for (size_t i = 0; i < triple.size(); ++i)
224 {
225 if (triple[i] == '-')
226 dash_count++;
227 if (dash_count == 3)
228 {
229 triple.resize(i);
230 break;
231 }
232 }
233
234 m_compiler->getTargetOpts().Triple = triple;
235 }
236 else
237 {
238 m_compiler->getTargetOpts().Triple = llvm::sys::getDefaultTargetTriple();
239 }
240
241 if (m_compiler->getTargetOpts().Triple.find("ios") != std::string::npos)
242 m_compiler->getTargetOpts().ABI = "apcs-gnu";
243
244 m_compiler->createDiagnostics(0, 0);
245
246 // Create the target instance.
247 m_compiler->setTarget(TargetInfo::CreateTargetInfo(m_compiler->getDiagnostics(),
248 m_compiler->getTargetOpts()));
249
250 assert (m_compiler->hasTarget());
251
252 // 3. Set options.
Sean Callanan65dafa82010-08-27 01:01:44 +0000253
Sean Callanan5b658cc2011-11-07 23:35:40 +0000254 lldb::LanguageType language = expr.Language();
Greg Claytonf51ed302011-01-15 01:32:14 +0000255
Sean Callanan5b658cc2011-11-07 23:35:40 +0000256 switch (language)
257 {
258 case lldb::eLanguageTypeC:
259 break;
260 case lldb::eLanguageTypeObjC:
261 m_compiler->getLangOpts().ObjC1 = true;
262 m_compiler->getLangOpts().ObjC2 = true;
263 break;
264 case lldb::eLanguageTypeC_plus_plus:
265 m_compiler->getLangOpts().CPlusPlus = true;
Sean Callananf0613182012-05-16 21:03:38 +0000266 m_compiler->getLangOpts().CPlusPlus0x = true;
Sean Callanan5b658cc2011-11-07 23:35:40 +0000267 break;
268 case lldb::eLanguageTypeObjC_plus_plus:
269 default:
270 m_compiler->getLangOpts().ObjC1 = true;
271 m_compiler->getLangOpts().ObjC2 = true;
272 m_compiler->getLangOpts().CPlusPlus = true;
Sean Callananf0613182012-05-16 21:03:38 +0000273 m_compiler->getLangOpts().CPlusPlus0x = true;
Sean Callanan5b658cc2011-11-07 23:35:40 +0000274 break;
275 }
Sean Callananc7674af2011-01-17 23:42:46 +0000276
Sean Callanan6e12c7a2012-03-08 02:39:03 +0000277 m_compiler->getLangOpts().DebuggerSupport = true; // Features specifically for debugger clients
278 if (expr.DesiredResultType() == ClangExpression::eResultTypeId)
279 m_compiler->getLangOpts().DebuggerCastResultToId = true;
280
Sean Callanan6c797dc2012-04-17 00:49:48 +0000281 // Spell checking is a nice feature, but it ends up completing a
282 // lot of types that we didn't strictly speaking need to complete.
283 // As a result, we spend a long time parsing and importing debug
284 // information.
285 m_compiler->getLangOpts().SpellChecking = false;
286
Greg Clayton289afcb2012-02-18 05:35:26 +0000287 lldb::ProcessSP process_sp;
Greg Clayton395fc332011-02-15 21:59:32 +0000288 if (exe_scope)
Greg Clayton289afcb2012-02-18 05:35:26 +0000289 process_sp = exe_scope->CalculateProcess();
Greg Clayton395fc332011-02-15 21:59:32 +0000290
Greg Clayton289afcb2012-02-18 05:35:26 +0000291 if (process_sp && m_compiler->getLangOpts().ObjC1)
Sean Callananc7674af2011-01-17 23:42:46 +0000292 {
Greg Clayton289afcb2012-02-18 05:35:26 +0000293 if (process_sp->GetObjCLanguageRuntime())
Sean Callananc7674af2011-01-17 23:42:46 +0000294 {
Greg Clayton289afcb2012-02-18 05:35:26 +0000295 if (process_sp->GetObjCLanguageRuntime()->GetRuntimeVersion() == eAppleObjC_V2)
Sean Callanan06dc17f2012-09-24 22:25:51 +0000296 m_compiler->getLangOpts().ObjCRuntime.set(ObjCRuntime::MacOSX, VersionTuple(10, 7));
297 else
298 m_compiler->getLangOpts().ObjCRuntime.set(ObjCRuntime::FragileMacOSX, VersionTuple(10, 7));
Sean Callanan6e12c7a2012-03-08 02:39:03 +0000299
300 if (process_sp->GetObjCLanguageRuntime()->HasNewLiteralsAndIndexing())
Sean Callanan6e12c7a2012-03-08 02:39:03 +0000301 m_compiler->getLangOpts().DebuggerObjCLiteral = true;
Sean Callananc7674af2011-01-17 23:42:46 +0000302 }
303 }
Greg Claytonf51ed302011-01-15 01:32:14 +0000304
Sean Callanan65dafa82010-08-27 01:01:44 +0000305 m_compiler->getLangOpts().ThreadsafeStatics = false;
306 m_compiler->getLangOpts().AccessControl = false; // Debuggers get universal access
307 m_compiler->getLangOpts().DollarIdents = true; // $ indicates a persistent variable name
Sean Callanandaa6efe2011-12-21 22:22:58 +0000308
Sean Callanan65dafa82010-08-27 01:01:44 +0000309 // Set CodeGen options
310 m_compiler->getCodeGenOpts().EmitDeclMetadata = true;
311 m_compiler->getCodeGenOpts().InstrumentFunctions = false;
312
313 // Disable some warnings.
314 m_compiler->getDiagnosticOpts().Warnings.push_back("no-unused-value");
315
Sean Callanan65dafa82010-08-27 01:01:44 +0000316 // Inform the target of the language options
317 //
318 // FIXME: We shouldn't need to do this, the target should be immutable once
319 // created. This complexity should be lifted elsewhere.
320 m_compiler->getTarget().setForcedLangOptions(m_compiler->getLangOpts());
321
322 // 4. Set up the diagnostic buffer for reporting errors
323
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000324 m_compiler->getDiagnostics().setClient(new clang::TextDiagnosticBuffer);
Sean Callanan65dafa82010-08-27 01:01:44 +0000325
326 // 5. Set up the source management objects inside the compiler
327
Greg Clayton22defe82010-12-02 23:20:03 +0000328 clang::FileSystemOptions file_system_options;
329 m_file_manager.reset(new clang::FileManager(file_system_options));
Sean Callanan8a3b0a82010-11-18 02:56:27 +0000330
Sean Callanan65dafa82010-08-27 01:01:44 +0000331 if (!m_compiler->hasSourceManager())
Greg Clayton22defe82010-12-02 23:20:03 +0000332 m_compiler->createSourceManager(*m_file_manager.get());
Sean Callanan65dafa82010-08-27 01:01:44 +0000333
334 m_compiler->createFileManager();
335 m_compiler->createPreprocessor();
336
337 // 6. Most of this we get from the CompilerInstance, but we
338 // also want to give the context an ExternalASTSource.
Sean Callananee8fc722010-11-19 20:20:02 +0000339 m_selector_table.reset(new SelectorTable());
Sean Callananc1535182011-10-07 23:18:13 +0000340 m_builtin_context.reset(new Builtin::Context());
Sean Callanan65dafa82010-08-27 01:01:44 +0000341
342 std::auto_ptr<clang::ASTContext> ast_context(new ASTContext(m_compiler->getLangOpts(),
343 m_compiler->getSourceManager(),
Sean Callananc1535182011-10-07 23:18:13 +0000344 &m_compiler->getTarget(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000345 m_compiler->getPreprocessor().getIdentifierTable(),
Sean Callananee8fc722010-11-19 20:20:02 +0000346 *m_selector_table.get(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000347 *m_builtin_context.get(),
348 0));
349
350 ClangExpressionDeclMap *decl_map = m_expr.DeclMap();
351
352 if (decl_map)
353 {
Sean Callananf76afff2011-10-28 23:38:38 +0000354 llvm::OwningPtr<clang::ExternalASTSource> ast_source(decl_map->CreateProxy());
355 decl_map->InstallASTContext(ast_context.get());
Sean Callanan65dafa82010-08-27 01:01:44 +0000356 ast_context->setExternalSource(ast_source);
357 }
358
359 m_compiler->setASTContext(ast_context.release());
360
Greg Clayton8de27c72010-10-15 22:48:33 +0000361 std::string module_name("$__lldb_module");
Sean Callanan65dafa82010-08-27 01:01:44 +0000362
Sean Callanan279584c2011-03-15 00:17:19 +0000363 m_llvm_context.reset(new LLVMContext());
Sean Callanan65dafa82010-08-27 01:01:44 +0000364 m_code_generator.reset(CreateLLVMCodeGen(m_compiler->getDiagnostics(),
365 module_name,
366 m_compiler->getCodeGenOpts(),
Sean Callanan279584c2011-03-15 00:17:19 +0000367 *m_llvm_context));
Sean Callanan65dafa82010-08-27 01:01:44 +0000368}
369
370ClangExpressionParser::~ClangExpressionParser()
371{
372}
373
374unsigned
375ClangExpressionParser::Parse (Stream &stream)
376{
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000377 TextDiagnosticBuffer *diag_buf = static_cast<TextDiagnosticBuffer*>(m_compiler->getDiagnostics().getClient());
378
379 diag_buf->FlushDiagnostics (m_compiler->getDiagnostics());
Sean Callanan65dafa82010-08-27 01:01:44 +0000380
381 MemoryBuffer *memory_buffer = MemoryBuffer::getMemBufferCopy(m_expr.Text(), __FUNCTION__);
Sean Callanan142f94c2012-03-01 02:03:47 +0000382 m_compiler->getSourceManager().createMainFileIDForMemBuffer (memory_buffer);
Sean Callanan65dafa82010-08-27 01:01:44 +0000383
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000384 diag_buf->BeginSourceFile(m_compiler->getLangOpts(), &m_compiler->getPreprocessor());
Sean Callanan65dafa82010-08-27 01:01:44 +0000385
386 ASTConsumer *ast_transformer = m_expr.ASTTransformer(m_code_generator.get());
387
388 if (ast_transformer)
389 ParseAST(m_compiler->getPreprocessor(), ast_transformer, m_compiler->getASTContext());
390 else
391 ParseAST(m_compiler->getPreprocessor(), m_code_generator.get(), m_compiler->getASTContext());
392
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000393 diag_buf->EndSourceFile();
Sean Callananfb3058e2011-05-12 23:54:16 +0000394
Sean Callanan65dafa82010-08-27 01:01:44 +0000395 TextDiagnosticBuffer::const_iterator diag_iterator;
396
397 int num_errors = 0;
Sean Callanan7617c292010-11-01 20:28:09 +0000398
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000399 for (diag_iterator = diag_buf->warn_begin();
400 diag_iterator != diag_buf->warn_end();
Sean Callanan65dafa82010-08-27 01:01:44 +0000401 ++diag_iterator)
402 stream.Printf("warning: %s\n", (*diag_iterator).second.c_str());
403
404 num_errors = 0;
405
Sean Callanan47a5c4c2010-09-23 03:01:22 +0000406 for (diag_iterator = diag_buf->err_begin();
407 diag_iterator != diag_buf->err_end();
Sean Callanan65dafa82010-08-27 01:01:44 +0000408 ++diag_iterator)
409 {
410 num_errors++;
411 stream.Printf("error: %s\n", (*diag_iterator).second.c_str());
412 }
413
Sean Callanan7617c292010-11-01 20:28:09 +0000414 for (diag_iterator = diag_buf->note_begin();
415 diag_iterator != diag_buf->note_end();
416 ++diag_iterator)
417 stream.Printf("note: %s\n", (*diag_iterator).second.c_str());
418
Sean Callananfb3058e2011-05-12 23:54:16 +0000419 if (!num_errors)
420 {
421 if (m_expr.DeclMap() && !m_expr.DeclMap()->ResolveUnknownTypes())
422 {
423 stream.Printf("error: Couldn't infer the type of a variable\n");
424 num_errors++;
425 }
426 }
427
Sean Callanan65dafa82010-08-27 01:01:44 +0000428 return num_errors;
429}
430
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000431static bool FindFunctionInModule (std::string &mangled_name,
432 llvm::Module *module,
433 const char *orig_name)
434{
435 for (llvm::Module::iterator fi = module->getFunctionList().begin(), fe = module->getFunctionList().end();
436 fi != fe;
437 ++fi)
438 {
439 if (fi->getName().str().find(orig_name) != std::string::npos)
440 {
441 mangled_name = fi->getName().str();
442 return true;
443 }
444 }
445
446 return false;
447}
448
Sean Callanan65dafa82010-08-27 01:01:44 +0000449Error
Sean Callanan47dc4572011-09-15 02:13:07 +0000450ClangExpressionParser::PrepareForExecution (lldb::addr_t &func_allocation_addr,
451 lldb::addr_t &func_addr,
452 lldb::addr_t &func_end,
453 ExecutionContext &exe_ctx,
454 IRForTarget::StaticDataAllocator *data_allocator,
455 bool &evaluated_statically,
456 lldb::ClangExpressionVariableSP &const_result,
457 ExecutionPolicy execution_policy)
Sean Callanan65dafa82010-08-27 01:01:44 +0000458{
Greg Claytond0882d02011-01-19 23:00:49 +0000459 func_allocation_addr = LLDB_INVALID_ADDRESS;
460 func_addr = LLDB_INVALID_ADDRESS;
461 func_end = LLDB_INVALID_ADDRESS;
Greg Claytone005f2c2010-11-06 01:53:30 +0000462 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000463
Sean Callananddf110d2012-01-24 22:06:48 +0000464 std::auto_ptr<llvm::ExecutionEngine> execution_engine;
465
Sean Callanan65dafa82010-08-27 01:01:44 +0000466 Error err;
467
468 llvm::Module *module = m_code_generator->ReleaseModule();
469
470 if (!module)
471 {
472 err.SetErrorToGenericError();
473 err.SetErrorString("IR doesn't contain a module");
474 return err;
475 }
476
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000477 // Find the actual name of the function (it's often mangled somehow)
478
479 std::string function_name;
480
481 if (!FindFunctionInModule(function_name, module, m_expr.FunctionName()))
482 {
483 err.SetErrorToGenericError();
484 err.SetErrorStringWithFormat("Couldn't find %s() in the module", m_expr.FunctionName());
485 return err;
486 }
487 else
488 {
Enrico Granata4c3fb4b2011-07-19 18:03:25 +0000489 if (log)
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000490 log->Printf("Found function %s for %s", function_name.c_str(), m_expr.FunctionName());
491 }
492
Sean Callanan65dafa82010-08-27 01:01:44 +0000493 ClangExpressionDeclMap *decl_map = m_expr.DeclMap(); // result can be NULL
494
495 if (decl_map)
496 {
Sean Callanan97c924e2011-01-27 01:07:04 +0000497 Stream *error_stream = NULL;
Greg Clayton567e7f32011-09-22 04:58:26 +0000498 Target *target = exe_ctx.GetTargetPtr();
499 if (target)
500 error_stream = &target->GetDebugger().GetErrorStream();
Sean Callanan97c924e2011-01-27 01:07:04 +0000501
Sean Callanan47dc4572011-09-15 02:13:07 +0000502 IRForTarget ir_for_target(decl_map,
Sean Callanane8a59a82010-09-13 21:34:21 +0000503 m_expr.NeedsVariableResolution(),
Sean Callanan47dc4572011-09-15 02:13:07 +0000504 execution_policy,
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000505 const_result,
Sean Callananc0492742011-05-23 21:40:23 +0000506 data_allocator,
Sean Callanan97c924e2011-01-27 01:07:04 +0000507 error_stream,
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000508 function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000509
Sean Callanan06dc17f2012-09-24 22:25:51 +0000510 bool ir_can_run = ir_for_target.runOnModule(*module);
Sean Callananf18d91c2010-09-01 00:58:00 +0000511
Sean Callananddf110d2012-01-24 22:06:48 +0000512 Error &interpreter_error(ir_for_target.getInterpreterError());
513
514 if (execution_policy != eExecutionPolicyAlways && interpreter_error.Success())
Sean Callanan696cf5f2011-05-07 01:06:41 +0000515 {
Johnny Chenc6134962012-01-06 00:35:38 +0000516 if (const_result)
517 const_result->TransferAddress();
Sean Callanan47dc4572011-09-15 02:13:07 +0000518 evaluated_statically = true;
Sean Callanan696cf5f2011-05-07 01:06:41 +0000519 err.Clear();
520 return err;
521 }
522
Greg Clayton567e7f32011-09-22 04:58:26 +0000523 Process *process = exe_ctx.GetProcessPtr();
524
525 if (!process || execution_policy == eExecutionPolicyNever)
Sean Callanan47dc4572011-09-15 02:13:07 +0000526 {
527 err.SetErrorToGenericError();
Sean Callananddf110d2012-01-24 22:06:48 +0000528 if (execution_policy == eExecutionPolicyAlways)
529 err.SetErrorString("Execution needed to run in the target, but the target can't be run");
530 else
531 err.SetErrorStringWithFormat("Interpreting the expression locally failed: %s", interpreter_error.AsCString());
Sean Callanan8f2e3922012-02-04 08:49:35 +0000532
Sean Callanan47dc4572011-09-15 02:13:07 +0000533 return err;
534 }
Sean Callanan06dc17f2012-09-24 22:25:51 +0000535 else if (!ir_can_run)
536 {
537 err.SetErrorToGenericError();
538 err.SetErrorString("The expression could not be prepared to run in the target");
539
540 return err;
541 }
Sean Callanan47dc4572011-09-15 02:13:07 +0000542
Sean Callanan6cf6c472011-09-20 23:01:51 +0000543 if (execution_policy != eExecutionPolicyNever &&
544 m_expr.NeedsValidation() &&
Greg Clayton567e7f32011-09-22 04:58:26 +0000545 process)
Sean Callananf18d91c2010-09-01 00:58:00 +0000546 {
Greg Clayton567e7f32011-09-22 04:58:26 +0000547 if (!process->GetDynamicCheckers())
Sean Callanan6cf6c472011-09-20 23:01:51 +0000548 {
549 DynamicCheckerFunctions *dynamic_checkers = new DynamicCheckerFunctions();
550
551 StreamString install_errors;
552
553 if (!dynamic_checkers->Install(install_errors, exe_ctx))
554 {
555 if (install_errors.GetString().empty())
556 err.SetErrorString ("couldn't install checkers, unknown error");
557 else
558 err.SetErrorString (install_errors.GetString().c_str());
559
560 return err;
561 }
562
Greg Clayton567e7f32011-09-22 04:58:26 +0000563 process->SetDynamicCheckers(dynamic_checkers);
Sean Callanan6cf6c472011-09-20 23:01:51 +0000564
565 if (log)
566 log->Printf("== [ClangUserExpression::Evaluate] Finished installing dynamic checkers ==");
567 }
568
Greg Clayton567e7f32011-09-22 04:58:26 +0000569 IRDynamicChecks ir_dynamic_checks(*process->GetDynamicCheckers(), function_name.c_str());
Sean Callanane8a59a82010-09-13 21:34:21 +0000570
571 if (!ir_dynamic_checks.runOnModule(*module))
572 {
573 err.SetErrorToGenericError();
574 err.SetErrorString("Couldn't add dynamic checks to the expression");
575 return err;
576 }
577 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000578 }
579
Greg Claytond0882d02011-01-19 23:00:49 +0000580 // llvm will own this pointer when llvm::ExecutionEngine::createJIT is called
581 // below so we don't need to free it.
582 RecordingMemoryManager *jit_memory_manager = new RecordingMemoryManager();
Sean Callanan65dafa82010-08-27 01:01:44 +0000583
584 std::string error_string;
Sean Callanan7b8eb762011-11-01 17:33:54 +0000585
586 if (log)
587 {
588 std::string s;
589 raw_string_ostream oss(s);
590
591 module->print(oss, NULL);
592
593 oss.flush();
594
595 log->Printf ("Module being sent to JIT: \n%s", s.c_str());
596 }
597
Greg Clayton2f085c62011-05-15 01:25:55 +0000598 EngineBuilder builder(module);
599 builder.setEngineKind(EngineKind::JIT)
600 .setErrorStr(&error_string)
Sean Callanan9b6898f2011-07-30 02:42:06 +0000601 .setRelocationModel(llvm::Reloc::PIC_)
Greg Clayton2f085c62011-05-15 01:25:55 +0000602 .setJITMemoryManager(jit_memory_manager)
603 .setOptLevel(CodeGenOpt::Less)
604 .setAllocateGVsWithCode(true)
605 .setCodeModel(CodeModel::Small)
Sean Callanan16b53ab2011-10-12 00:12:34 +0000606 .setUseMCJIT(true);
Sean Callanan06dc17f2012-09-24 22:25:51 +0000607
608 llvm::Triple triple(module->getTargetTriple());
609 StringRef mArch;
610 StringRef mCPU;
611 SmallVector<std::string, 0> mAttrs;
612
613 TargetMachine *target_machine = builder.selectTarget(triple,
614 mArch,
615 mCPU,
616 mAttrs);
617
618 execution_engine.reset(builder.create(target_machine));
Sean Callanan9ac3a962010-11-02 23:20:00 +0000619
Sean Callananddf110d2012-01-24 22:06:48 +0000620 if (!execution_engine.get())
Sean Callanan65dafa82010-08-27 01:01:44 +0000621 {
622 err.SetErrorToGenericError();
623 err.SetErrorStringWithFormat("Couldn't JIT the function: %s", error_string.c_str());
624 return err;
625 }
626
Sean Callananddf110d2012-01-24 22:06:48 +0000627 execution_engine->DisableLazyCompilation();
Sean Callanan65dafa82010-08-27 01:01:44 +0000628
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000629 llvm::Function *function = module->getFunction (function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000630
631 // We don't actually need the function pointer here, this just forces it to get resolved.
632
Sean Callananddf110d2012-01-24 22:06:48 +0000633 void *fun_ptr = execution_engine->getPointerToFunction(function);
634
Sean Callanan65dafa82010-08-27 01:01:44 +0000635 // Errors usually cause failures in the JIT, but if we're lucky we get here.
636
Sean Callanan7b8eb762011-11-01 17:33:54 +0000637 if (!function)
638 {
639 err.SetErrorToGenericError();
640 err.SetErrorStringWithFormat("Couldn't find '%s' in the JITted module", function_name.c_str());
641 return err;
642 }
643
Sean Callanan65dafa82010-08-27 01:01:44 +0000644 if (!fun_ptr)
645 {
646 err.SetErrorToGenericError();
Sean Callanan7b8eb762011-11-01 17:33:54 +0000647 err.SetErrorStringWithFormat("'%s' was in the JITted module but wasn't lowered", function_name.c_str());
Sean Callanan65dafa82010-08-27 01:01:44 +0000648 return err;
649 }
650
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000651 m_jitted_functions.push_back (ClangExpressionParser::JittedFunction(function_name.c_str(), (lldb::addr_t)fun_ptr));
Sean Callanan65dafa82010-08-27 01:01:44 +0000652
Greg Clayton567e7f32011-09-22 04:58:26 +0000653
654 Process *process = exe_ctx.GetProcessPtr();
655 if (process == NULL)
Sean Callanan65dafa82010-08-27 01:01:44 +0000656 {
657 err.SetErrorToGenericError();
658 err.SetErrorString("Couldn't write the JIT compiled code into the target because there is no target");
659 return err;
660 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000661
Sean Callanan8f2e3922012-02-04 08:49:35 +0000662 jit_memory_manager->CommitAllocations(*process);
Sean Callanan142f94c2012-03-01 02:03:47 +0000663 jit_memory_manager->ReportAllocations(*execution_engine);
Sean Callanan8f2e3922012-02-04 08:49:35 +0000664 jit_memory_manager->WriteData(*process);
Sean Callanan65dafa82010-08-27 01:01:44 +0000665
666 std::vector<JittedFunction>::iterator pos, end = m_jitted_functions.end();
667
668 for (pos = m_jitted_functions.begin(); pos != end; pos++)
669 {
Greg Claytond0882d02011-01-19 23:00:49 +0000670 (*pos).m_remote_addr = jit_memory_manager->GetRemoteAddressForLocal ((*pos).m_local_addr);
Sean Callanan65dafa82010-08-27 01:01:44 +0000671
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000672 if (!(*pos).m_name.compare(function_name.c_str()))
Sean Callanan830a9032010-08-27 23:31:21 +0000673 {
Sean Callanan8f2e3922012-02-04 08:49:35 +0000674 RecordingMemoryManager::AddrRange func_range = jit_memory_manager->GetRemoteRangeForLocal((*pos).m_local_addr);
675 func_end = func_range.first + func_range.second;
Sean Callanan65dafa82010-08-27 01:01:44 +0000676 func_addr = (*pos).m_remote_addr;
Sean Callanan830a9032010-08-27 23:31:21 +0000677 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000678 }
679
Sean Callanan6dff8272010-11-08 03:49:50 +0000680 if (log)
681 {
682 log->Printf("Code can be run in the target.");
683
684 StreamString disassembly_stream;
685
Greg Claytond0882d02011-01-19 23:00:49 +0000686 Error err = DisassembleFunction(disassembly_stream, exe_ctx, jit_memory_manager);
Sean Callanan6dff8272010-11-08 03:49:50 +0000687
688 if (!err.Success())
689 {
690 log->Printf("Couldn't disassemble function : %s", err.AsCString("unknown error"));
691 }
692 else
693 {
694 log->Printf("Function disassembly:\n%s", disassembly_stream.GetData());
695 }
696 }
697
Sean Callananddf110d2012-01-24 22:06:48 +0000698 execution_engine.reset();
699
Sean Callanan65dafa82010-08-27 01:01:44 +0000700 err.Clear();
701 return err;
702}
703
704Error
Greg Claytond0882d02011-01-19 23:00:49 +0000705ClangExpressionParser::DisassembleFunction (Stream &stream, ExecutionContext &exe_ctx, RecordingMemoryManager *jit_memory_manager)
Sean Callanan65dafa82010-08-27 01:01:44 +0000706{
Greg Claytone005f2c2010-11-06 01:53:30 +0000707 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan65dafa82010-08-27 01:01:44 +0000708
709 const char *name = m_expr.FunctionName();
710
711 Error ret;
712
713 ret.Clear();
714
715 lldb::addr_t func_local_addr = LLDB_INVALID_ADDRESS;
716 lldb::addr_t func_remote_addr = LLDB_INVALID_ADDRESS;
717
718 std::vector<JittedFunction>::iterator pos, end = m_jitted_functions.end();
719
720 for (pos = m_jitted_functions.begin(); pos < end; pos++)
721 {
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000722 if (strstr(pos->m_name.c_str(), name))
Sean Callanan65dafa82010-08-27 01:01:44 +0000723 {
724 func_local_addr = pos->m_local_addr;
725 func_remote_addr = pos->m_remote_addr;
726 }
727 }
728
729 if (func_local_addr == LLDB_INVALID_ADDRESS)
730 {
731 ret.SetErrorToGenericError();
732 ret.SetErrorStringWithFormat("Couldn't find function %s for disassembly", name);
733 return ret;
734 }
735
Enrico Granata4c3fb4b2011-07-19 18:03:25 +0000736 if (log)
Sean Callanan65dafa82010-08-27 01:01:44 +0000737 log->Printf("Found function, has local address 0x%llx and remote address 0x%llx", (uint64_t)func_local_addr, (uint64_t)func_remote_addr);
738
739 std::pair <lldb::addr_t, lldb::addr_t> func_range;
740
Greg Claytond0882d02011-01-19 23:00:49 +0000741 func_range = jit_memory_manager->GetRemoteRangeForLocal(func_local_addr);
Sean Callanan65dafa82010-08-27 01:01:44 +0000742
743 if (func_range.first == 0 && func_range.second == 0)
744 {
745 ret.SetErrorToGenericError();
746 ret.SetErrorStringWithFormat("Couldn't find code range for function %s", name);
747 return ret;
748 }
749
Enrico Granata4c3fb4b2011-07-19 18:03:25 +0000750 if (log)
Sean Callanan8f2e3922012-02-04 08:49:35 +0000751 log->Printf("Function's code range is [0x%llx+0x%llx]", func_range.first, func_range.second);
Sean Callanan65dafa82010-08-27 01:01:44 +0000752
Greg Clayton567e7f32011-09-22 04:58:26 +0000753 Target *target = exe_ctx.GetTargetPtr();
754 if (!target)
Sean Callanan65dafa82010-08-27 01:01:44 +0000755 {
756 ret.SetErrorToGenericError();
757 ret.SetErrorString("Couldn't find the target");
758 }
759
Sean Callanan8f2e3922012-02-04 08:49:35 +0000760 lldb::DataBufferSP buffer_sp(new DataBufferHeap(func_range.second, 0));
Sean Callanan65dafa82010-08-27 01:01:44 +0000761
Greg Clayton567e7f32011-09-22 04:58:26 +0000762 Process *process = exe_ctx.GetProcessPtr();
Sean Callanan65dafa82010-08-27 01:01:44 +0000763 Error err;
Greg Clayton567e7f32011-09-22 04:58:26 +0000764 process->ReadMemory(func_remote_addr, buffer_sp->GetBytes(), buffer_sp->GetByteSize(), err);
Sean Callanan65dafa82010-08-27 01:01:44 +0000765
766 if (!err.Success())
767 {
768 ret.SetErrorToGenericError();
769 ret.SetErrorStringWithFormat("Couldn't read from process: %s", err.AsCString("unknown error"));
770 return ret;
771 }
772
Greg Clayton567e7f32011-09-22 04:58:26 +0000773 ArchSpec arch(target->GetArchitecture());
Sean Callanan65dafa82010-08-27 01:01:44 +0000774
Sean Callanan4f28c312012-08-01 18:50:59 +0000775 lldb::DisassemblerSP disassembler = Disassembler::FindPlugin(arch, NULL);
Sean Callanan65dafa82010-08-27 01:01:44 +0000776
Sean Callananb386d822012-08-09 00:50:26 +0000777 if (!disassembler)
Sean Callanan65dafa82010-08-27 01:01:44 +0000778 {
779 ret.SetErrorToGenericError();
Greg Clayton940b1032011-02-23 00:35:02 +0000780 ret.SetErrorStringWithFormat("Unable to find disassembler plug-in for %s architecture.", arch.GetArchitectureName());
Sean Callanan65dafa82010-08-27 01:01:44 +0000781 return ret;
782 }
783
Greg Clayton567e7f32011-09-22 04:58:26 +0000784 if (!process)
Sean Callanan65dafa82010-08-27 01:01:44 +0000785 {
786 ret.SetErrorToGenericError();
787 ret.SetErrorString("Couldn't find the process");
788 return ret;
789 }
790
791 DataExtractor extractor(buffer_sp,
Greg Clayton567e7f32011-09-22 04:58:26 +0000792 process->GetByteOrder(),
793 target->GetArchitecture().GetAddressByteSize());
Sean Callanan65dafa82010-08-27 01:01:44 +0000794
Greg Claytone005f2c2010-11-06 01:53:30 +0000795 if (log)
Sean Callanan65dafa82010-08-27 01:01:44 +0000796 {
797 log->Printf("Function data has contents:");
Greg Claytone005f2c2010-11-06 01:53:30 +0000798 extractor.PutToLog (log.get(),
Sean Callanan65dafa82010-08-27 01:01:44 +0000799 0,
800 extractor.GetByteSize(),
801 func_remote_addr,
802 16,
803 DataExtractor::TypeUInt8);
804 }
805
Greg Clayton3508c382012-02-24 01:59:29 +0000806 disassembler->DecodeInstructions (Address (func_remote_addr), extractor, 0, UINT32_MAX, false);
Sean Callanan65dafa82010-08-27 01:01:44 +0000807
Greg Clayton5c4c7462010-10-06 03:09:58 +0000808 InstructionList &instruction_list = disassembler->GetInstructionList();
Greg Clayton889fbd02011-03-26 19:14:58 +0000809 const uint32_t max_opcode_byte_size = instruction_list.GetMaxOpcocdeByteSize();
Sean Callanan65dafa82010-08-27 01:01:44 +0000810 for (uint32_t instruction_index = 0, num_instructions = instruction_list.GetSize();
811 instruction_index < num_instructions;
812 ++instruction_index)
813 {
Greg Clayton5c4c7462010-10-06 03:09:58 +0000814 Instruction *instruction = instruction_list.GetInstructionAtIndex(instruction_index).get();
Sean Callanan65dafa82010-08-27 01:01:44 +0000815 instruction->Dump (&stream,
Greg Clayton889fbd02011-03-26 19:14:58 +0000816 max_opcode_byte_size,
Greg Clayton5c4c7462010-10-06 03:09:58 +0000817 true,
Greg Clayton149731c2011-03-25 18:03:16 +0000818 true,
Greg Clayton0fef9682012-05-10 02:52:23 +0000819 &exe_ctx);
Sean Callanan65dafa82010-08-27 01:01:44 +0000820 stream.PutChar('\n');
Sean Callanan65dafa82010-08-27 01:01:44 +0000821 }
822
823 return ret;
824}