blob: 838088084d60aedf917ebd1f1a21f04f23f29d67 [file] [log] [blame]
Sean Callanan79763a42011-05-23 21:40:23 +00001//===-- ClangUserExpression.cpp ---------------------------------*- C++ -*-===//
Sean Callanan1a8d4092010-08-27 01:01:44 +00002//
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// C Includes
11#include <stdio.h>
12#if HAVE_SYS_TYPES_H
13# include <sys/types.h>
14#endif
15
16// C++ Includes
17#include <cstdlib>
18#include <string>
19#include <map>
20
21#include "lldb/Core/ConstString.h"
22#include "lldb/Core/Log.h"
Greg Claytonc4e411f2011-01-18 19:36:39 +000023#include "lldb/Core/StreamFile.h"
Sean Callanan1a8d4092010-08-27 01:01:44 +000024#include "lldb/Core/StreamString.h"
Greg Claytonb71f3842010-10-05 03:13:51 +000025#include "lldb/Core/ValueObjectConstResult.h"
Sean Callanane4ec90e2010-12-16 03:17:46 +000026#include "lldb/Expression/ASTResultSynthesizer.h"
Sean Callanan1a8d4092010-08-27 01:01:44 +000027#include "lldb/Expression/ClangExpressionDeclMap.h"
28#include "lldb/Expression/ClangExpressionParser.h"
29#include "lldb/Expression/ClangFunction.h"
Sean Callanan1a8d4092010-08-27 01:01:44 +000030#include "lldb/Expression/ClangUserExpression.h"
Sean Callanan9bc83842011-09-26 18:45:31 +000031#include "lldb/Expression/ExpressionSourceCode.h"
Sean Callanan1a8d4092010-08-27 01:01:44 +000032#include "lldb/Host/Host.h"
Sean Callananfc55f5d2010-09-21 00:44:12 +000033#include "lldb/Symbol/VariableList.h"
Sean Callanan1a8d4092010-08-27 01:01:44 +000034#include "lldb/Target/ExecutionContext.h"
Greg Clayton8f343b02010-11-04 01:54:29 +000035#include "lldb/Target/Process.h"
Sean Callananfc55f5d2010-09-21 00:44:12 +000036#include "lldb/Target/StackFrame.h"
Sean Callanan1a8d4092010-08-27 01:01:44 +000037#include "lldb/Target/Target.h"
Jim Inghamf48169b2010-11-30 02:22:11 +000038#include "lldb/Target/ThreadPlan.h"
39#include "lldb/Target/ThreadPlanCallUserExpression.h"
Sean Callanan1a8d4092010-08-27 01:01:44 +000040
Sean Callanan72e49402011-08-05 23:43:37 +000041#include "clang/AST/DeclCXX.h"
42#include "clang/AST/DeclObjC.h"
43
Sean Callanan1a8d4092010-08-27 01:01:44 +000044using namespace lldb_private;
45
Sean Callanan322f5292010-10-29 00:29:03 +000046ClangUserExpression::ClangUserExpression (const char *expr,
Sean Callananc7b65062011-11-07 23:35:40 +000047 const char *expr_prefix,
Sean Callanan20bb3aa2011-12-21 22:22:58 +000048 lldb::LanguageType language,
49 ResultType desired_type) :
Greg Clayton22a939a2011-01-19 23:00:49 +000050 ClangExpression (),
51 m_expr_text (expr),
52 m_expr_prefix (expr_prefix ? expr_prefix : ""),
Sean Callananc7b65062011-11-07 23:35:40 +000053 m_language (language),
Greg Clayton22a939a2011-01-19 23:00:49 +000054 m_transformed_text (),
Sean Callanan20bb3aa2011-12-21 22:22:58 +000055 m_desired_type (desired_type),
Bill Wendlingd53b5de2012-04-03 08:46:13 +000056 m_enforce_valid_object (false),
Greg Clayton22a939a2011-01-19 23:00:49 +000057 m_cplusplus (false),
58 m_objectivec (false),
Bill Wendlingd53b5de2012-04-03 08:46:13 +000059 m_static_method(false),
Greg Clayton22a939a2011-01-19 23:00:49 +000060 m_needs_object_ptr (false),
Sean Callanan63697e52011-05-07 01:06:41 +000061 m_const_object (false),
Daniel Dunbara08823f2011-10-31 22:50:49 +000062 m_target (NULL),
Sean Callanan3bfdaa22011-09-15 02:13:07 +000063 m_evaluated_statically (false),
Bill Wendlingd53b5de2012-04-03 08:46:13 +000064 m_const_result ()
Sean Callanan1a8d4092010-08-27 01:01:44 +000065{
Sean Callananc7b65062011-11-07 23:35:40 +000066 switch (m_language)
67 {
68 case lldb::eLanguageTypeC_plus_plus:
69 m_allow_cxx = true;
70 break;
71 case lldb::eLanguageTypeObjC:
72 m_allow_objc = true;
73 break;
74 case lldb::eLanguageTypeObjC_plus_plus:
75 default:
76 m_allow_cxx = true;
77 m_allow_objc = true;
78 break;
79 }
Sean Callanan1a8d4092010-08-27 01:01:44 +000080}
81
Sean Callanane71d5532010-08-27 23:31:21 +000082ClangUserExpression::~ClangUserExpression ()
83{
84}
85
Sean Callanan1a8d4092010-08-27 01:01:44 +000086clang::ASTConsumer *
87ClangUserExpression::ASTTransformer (clang::ASTConsumer *passthrough)
Sean Callanan737330c2011-08-24 22:18:12 +000088{
Sean Callananbccce812011-08-23 21:20:51 +000089 ClangASTContext *clang_ast_context = m_target->GetScratchClangASTContext();
90
91 if (!clang_ast_context)
92 return NULL;
93
Sean Callanan2590b9a2011-10-08 00:21:35 +000094 if (!m_result_synthesizer.get())
95 m_result_synthesizer.reset(new ASTResultSynthesizer(passthrough,
Sean Callanan0eed0d42011-12-06 03:41:14 +000096 *m_target));
Sean Callanan2590b9a2011-10-08 00:21:35 +000097
98 return m_result_synthesizer.get();
Sean Callanan1a8d4092010-08-27 01:01:44 +000099}
100
Sean Callananfc55f5d2010-09-21 00:44:12 +0000101void
Sean Callanan744756e2011-11-04 02:09:33 +0000102ClangUserExpression::ScanContext(ExecutionContext &exe_ctx, Error &err)
Sean Callananfc55f5d2010-09-21 00:44:12 +0000103{
Greg Claytonc14ee322011-09-22 04:58:26 +0000104 m_target = exe_ctx.GetTargetPtr();
Greg Claytond4a2b372011-09-12 23:21:58 +0000105
Sean Callananc7b65062011-11-07 23:35:40 +0000106 if (!(m_allow_cxx || m_allow_objc))
107 return;
108
Greg Claytonc14ee322011-09-22 04:58:26 +0000109 StackFrame *frame = exe_ctx.GetFramePtr();
110 if (frame == NULL)
Sean Callananfc55f5d2010-09-21 00:44:12 +0000111 return;
112
Greg Claytonc14ee322011-09-22 04:58:26 +0000113 SymbolContext sym_ctx = frame->GetSymbolContext(lldb::eSymbolContextFunction);
Sean Callanan3670ba52010-12-01 21:35:54 +0000114
Sean Callanan72e49402011-08-05 23:43:37 +0000115 if (!sym_ctx.function)
116 return;
117
118 clang::DeclContext *decl_context;
119
120 if (sym_ctx.block && sym_ctx.block->GetInlinedFunctionInfo())
121 decl_context = sym_ctx.block->GetClangDeclContextForInlinedFunction();
122 else
123 decl_context = sym_ctx.function->GetClangDeclContext();
124
125 if (!decl_context)
126 return;
Sean Callanan737330c2011-08-24 22:18:12 +0000127
Sean Callanan72e49402011-08-05 23:43:37 +0000128 if (clang::CXXMethodDecl *method_decl = llvm::dyn_cast<clang::CXXMethodDecl>(decl_context))
Sean Callanan3670ba52010-12-01 21:35:54 +0000129 {
Sean Callananc7b65062011-11-07 23:35:40 +0000130 if (m_allow_cxx && method_decl->isInstance())
Sean Callanan3670ba52010-12-01 21:35:54 +0000131 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000132 if (m_enforce_valid_object)
Sean Callanan744756e2011-11-04 02:09:33 +0000133 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000134 VariableList *vars = frame->GetVariableList(false);
135
136 const char *thisErrorString = "Stopped in a C++ method, but 'this' isn't available; pretending we are in a generic context";
137
138 if (!vars)
139 {
140 err.SetErrorToGenericError();
141 err.SetErrorString(thisErrorString);
142 return;
143 }
144
145 lldb::VariableSP this_var = vars->FindVariable(ConstString("this"));
146
147 if (!this_var ||
148 !this_var->IsInScope(frame) ||
149 !this_var->LocationIsValidForFrame (frame))
150 {
151 err.SetErrorToGenericError();
152 err.SetErrorString(thisErrorString);
153 return;
154 }
Sean Callanan744756e2011-11-04 02:09:33 +0000155 }
156
Sean Callanan72e49402011-08-05 23:43:37 +0000157 m_cplusplus = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000158 m_needs_object_ptr = true;
Sean Callanan3670ba52010-12-01 21:35:54 +0000159 }
160 }
Sean Callanan72e49402011-08-05 23:43:37 +0000161 else if (clang::ObjCMethodDecl *method_decl = llvm::dyn_cast<clang::ObjCMethodDecl>(decl_context))
Sean Callanan744756e2011-11-04 02:09:33 +0000162 {
Sean Callanand5c17ed2011-11-15 02:11:17 +0000163 if (m_allow_objc)
Sean Callanan9bc83842011-09-26 18:45:31 +0000164 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000165 if (m_enforce_valid_object)
Sean Callanan744756e2011-11-04 02:09:33 +0000166 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000167 VariableList *vars = frame->GetVariableList(false);
168
169 const char *selfErrorString = "Stopped in an Objective-C method, but 'self' isn't available; pretending we are in a generic context";
170
171 if (!vars)
172 {
173 err.SetErrorToGenericError();
174 err.SetErrorString(selfErrorString);
175 return;
176 }
177
178 lldb::VariableSP self_var = vars->FindVariable(ConstString("self"));
179
180 if (!self_var ||
181 !self_var->IsInScope(frame) ||
182 !self_var->LocationIsValidForFrame (frame))
183 {
184 err.SetErrorToGenericError();
185 err.SetErrorString(selfErrorString);
186 return;
187 }
Sean Callanan744756e2011-11-04 02:09:33 +0000188 }
189
Sean Callanan72e49402011-08-05 23:43:37 +0000190 m_objectivec = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000191 m_needs_object_ptr = true;
Sean Callanand5c17ed2011-11-15 02:11:17 +0000192
193 if (!method_decl->isInstanceMethod())
194 m_static_method = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000195 }
Sean Callanan3670ba52010-12-01 21:35:54 +0000196 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000197}
198
Sean Callanancf5498f2010-10-22 23:25:16 +0000199// This is a really nasty hack, meant to fix Objective-C expressions of the form
200// (int)[myArray count]. Right now, because the type information for count is
201// not available, [myArray count] returns id, which can't be directly cast to
202// int without causing a clang error.
203static void
204ApplyObjcCastHack(std::string &expr)
205{
206#define OBJC_CAST_HACK_FROM "(int)["
207#define OBJC_CAST_HACK_TO "(int)(long long)["
208
209 size_t from_offset;
210
211 while ((from_offset = expr.find(OBJC_CAST_HACK_FROM)) != expr.npos)
212 expr.replace(from_offset, sizeof(OBJC_CAST_HACK_FROM) - 1, OBJC_CAST_HACK_TO);
213
214#undef OBJC_CAST_HACK_TO
215#undef OBJC_CAST_HACK_FROM
216}
217
Sean Callanan64186e72010-10-24 20:45:49 +0000218// Another hack, meant to allow use of unichar despite it not being available in
219// the type information. Although we could special-case it in type lookup,
220// hopefully we'll figure out a way to #include the same environment as is
221// present in the original source file rather than try to hack specific type
222// definitions in as needed.
223static void
224ApplyUnicharHack(std::string &expr)
225{
226#define UNICHAR_HACK_FROM "unichar"
227#define UNICHAR_HACK_TO "unsigned short"
228
229 size_t from_offset;
230
231 while ((from_offset = expr.find(UNICHAR_HACK_FROM)) != expr.npos)
232 expr.replace(from_offset, sizeof(UNICHAR_HACK_FROM) - 1, UNICHAR_HACK_TO);
233
234#undef UNICHAR_HACK_TO
235#undef UNICHAR_HACK_FROM
236}
237
Sean Callanancf5498f2010-10-22 23:25:16 +0000238bool
Sean Callananf7c3e272010-11-19 02:52:21 +0000239ClangUserExpression::Parse (Stream &error_stream,
240 ExecutionContext &exe_ctx,
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000241 lldb_private::ExecutionPolicy execution_policy,
Sean Callanan63697e52011-05-07 01:06:41 +0000242 bool keep_result_in_memory)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000243{
Greg Clayton2d4edfb2010-11-06 01:53:30 +0000244 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000245
Sean Callanan744756e2011-11-04 02:09:33 +0000246 Error err;
Sean Callanan933693b2012-02-10 01:22:05 +0000247
248 InstallContext(exe_ctx);
Sean Callanan744756e2011-11-04 02:09:33 +0000249
250 ScanContext(exe_ctx, err);
251
252 if (!err.Success())
253 {
254 error_stream.Printf("warning: %s\n", err.AsCString());
255 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000256
257 StreamString m_transformed_stream;
258
259 ////////////////////////////////////
260 // Generate the expression
261 //
Sean Callanancf5498f2010-10-22 23:25:16 +0000262
263 ApplyObjcCastHack(m_expr_text);
Greg Clayton73b472d2010-10-27 03:32:59 +0000264 //ApplyUnicharHack(m_expr_text);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000265
Sean Callanan9bc83842011-09-26 18:45:31 +0000266 std::auto_ptr <ExpressionSourceCode> source_code (ExpressionSourceCode::CreateWrapped(m_expr_prefix.c_str(), m_expr_text.c_str()));
267
268 lldb::LanguageType lang_type;
269
Sean Callananfc55f5d2010-09-21 00:44:12 +0000270 if (m_cplusplus)
Sean Callanan9bc83842011-09-26 18:45:31 +0000271 lang_type = lldb::eLanguageTypeC_plus_plus;
272 else if(m_objectivec)
273 lang_type = lldb::eLanguageTypeObjC;
Sean Callananfc55f5d2010-09-21 00:44:12 +0000274 else
Sean Callanan9bc83842011-09-26 18:45:31 +0000275 lang_type = lldb::eLanguageTypeC;
276
Sean Callanand5c17ed2011-11-15 02:11:17 +0000277 if (!source_code->GetText(m_transformed_text, lang_type, m_const_object, m_static_method))
Sean Callananfc55f5d2010-09-21 00:44:12 +0000278 {
Sean Callanan9bc83842011-09-26 18:45:31 +0000279 error_stream.PutCString ("error: couldn't construct expression body");
280 return false;
Sean Callananfc55f5d2010-09-21 00:44:12 +0000281 }
282
Sean Callananfc55f5d2010-09-21 00:44:12 +0000283 if (log)
284 log->Printf("Parsing the following code:\n%s", m_transformed_text.c_str());
285
Sean Callanan1a8d4092010-08-27 01:01:44 +0000286 ////////////////////////////////////
287 // Set up the target and compiler
288 //
289
Greg Claytonc14ee322011-09-22 04:58:26 +0000290 Target *target = exe_ctx.GetTargetPtr();
Sean Callanan1a8d4092010-08-27 01:01:44 +0000291
292 if (!target)
293 {
294 error_stream.PutCString ("error: invalid target\n");
295 return false;
296 }
297
Sean Callanan1a8d4092010-08-27 01:01:44 +0000298 //////////////////////////
299 // Parse the expression
300 //
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000301
Sean Callanan1ee44b72011-10-29 01:58:46 +0000302 m_expr_decl_map.reset(new ClangExpressionDeclMap(keep_result_in_memory, exe_ctx));
Sean Callanan979f74d2010-12-03 01:38:59 +0000303
Sean Callananb9951192011-08-01 18:18:33 +0000304 if (!m_expr_decl_map->WillParse(exe_ctx))
305 {
306 error_stream.PutCString ("error: current process state is unsuitable for expression parsing\n");
307 return false;
308 }
Sean Callanan1a8d4092010-08-27 01:01:44 +0000309
Greg Claytonc14ee322011-09-22 04:58:26 +0000310 Process *process = exe_ctx.GetProcessPtr();
Sean Callananaa719af2012-02-08 18:43:35 +0000311 ExecutionContextScope *exe_scope = process;
312
313 if (!exe_scope)
314 exe_scope = exe_ctx.GetTargetPtr();
315
316 ClangExpressionParser parser(exe_scope, *this);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000317
318 unsigned num_errors = parser.Parse (error_stream);
319
320 if (num_errors)
321 {
322 error_stream.Printf ("error: %d errors parsing expression\n", num_errors);
Sean Callanan979f74d2010-12-03 01:38:59 +0000323
324 m_expr_decl_map->DidParse();
325
Sean Callanan1a8d4092010-08-27 01:01:44 +0000326 return false;
327 }
328
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000329 //////////////////////////////////////////////////////////////////////////////////////////
330 // Prepare the output of the parser for execution, evaluating it statically if possible
Sean Callanan1a8d4092010-08-27 01:01:44 +0000331 //
Sean Callanan1a8d4092010-08-27 01:01:44 +0000332
Greg Claytonc14ee322011-09-22 04:58:26 +0000333 if (execution_policy != eExecutionPolicyNever && process)
334 m_data_allocator.reset(new ProcessDataAllocator(*process));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000335
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000336 Error jit_error = parser.PrepareForExecution (m_jit_alloc,
337 m_jit_start_addr,
338 m_jit_end_addr,
339 exe_ctx,
340 m_data_allocator.get(),
341 m_evaluated_statically,
342 m_const_result,
343 execution_policy);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000344
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000345 if (log && m_data_allocator.get())
Sean Callanan79763a42011-05-23 21:40:23 +0000346 {
347 StreamString dump_string;
348 m_data_allocator->Dump(dump_string);
349
350 log->Printf("Data buffer contents:\n%s", dump_string.GetString().c_str());
351 }
Sean Callanane3aef1d2011-10-12 22:20:02 +0000352
Sean Callanan1a8d4092010-08-27 01:01:44 +0000353 if (jit_error.Success())
354 {
Greg Claytonc14ee322011-09-22 04:58:26 +0000355 if (process && m_jit_alloc != LLDB_INVALID_ADDRESS)
Greg Claytone1cd1be2012-01-29 20:56:30 +0000356 m_jit_process_sp = process->shared_from_this();
Sean Callanan1a8d4092010-08-27 01:01:44 +0000357 return true;
358 }
359 else
360 {
Greg Claytone6a9e432011-05-17 03:51:29 +0000361 const char *error_cstr = jit_error.AsCString();
362 if (error_cstr && error_cstr[0])
363 error_stream.Printf ("error: %s\n", error_cstr);
364 else
Jason Molendafd54b362011-09-20 21:44:10 +0000365 error_stream.Printf ("error: expression can't be interpreted or run\n");
Sean Callanan1a8d4092010-08-27 01:01:44 +0000366 return false;
367 }
368}
369
370bool
Jim Ingham36f3b362010-10-14 23:45:03 +0000371ClangUserExpression::PrepareToExecuteJITExpression (Stream &error_stream,
Sean Callanan104a6e92010-10-19 23:57:21 +0000372 ExecutionContext &exe_ctx,
373 lldb::addr_t &struct_address,
Sean Callanan9d48e802010-12-14 00:42:36 +0000374 lldb::addr_t &object_ptr,
375 lldb::addr_t &cmd_ptr)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000376{
Greg Clayton2d4edfb2010-11-06 01:53:30 +0000377 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000378
Sean Callanan933693b2012-02-10 01:22:05 +0000379 lldb::TargetSP target;
380 lldb::ProcessSP process;
381 lldb::StackFrameSP frame;
382
383 if (!LockAndCheckContext(exe_ctx,
384 target,
385 process,
386 frame))
387 {
388 error_stream.Printf("The context has changed before we could JIT the expression!");
389 return false;
390 }
391
Greg Clayton22a939a2011-01-19 23:00:49 +0000392 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000393 {
Sean Callanan1a8d4092010-08-27 01:01:44 +0000394 Error materialize_error;
395
Sean Callanan17827832010-12-13 22:46:15 +0000396 if (m_needs_object_ptr)
Sean Callananfc55f5d2010-09-21 00:44:12 +0000397 {
Sean Callanan17827832010-12-13 22:46:15 +0000398 ConstString object_name;
399
400 if (m_cplusplus)
401 {
402 object_name.SetCString("this");
403 }
404 else if (m_objectivec)
405 {
406 object_name.SetCString("self");
407 }
408 else
409 {
410 error_stream.Printf("Need object pointer but don't know the language\n");
411 return false;
412 }
413
Sean Callanan933693b2012-02-10 01:22:05 +0000414 if (!(m_expr_decl_map->GetObjectPointer(object_ptr, object_name, materialize_error)))
Sean Callanan17827832010-12-13 22:46:15 +0000415 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000416 error_stream.Printf("warning: couldn't get required object pointer (substituting NULL): %s\n", materialize_error.AsCString());
417 object_ptr = 0;
Sean Callanan17827832010-12-13 22:46:15 +0000418 }
Sean Callanan9d48e802010-12-14 00:42:36 +0000419
420 if (m_objectivec)
421 {
422 ConstString cmd_name("_cmd");
423
Sean Callanan933693b2012-02-10 01:22:05 +0000424 if (!(m_expr_decl_map->GetObjectPointer(cmd_ptr, cmd_name, materialize_error, true)))
Sean Callanan9d48e802010-12-14 00:42:36 +0000425 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000426 error_stream.Printf("warning: couldn't get object pointer (substituting NULL): %s\n", materialize_error.AsCString());
427 cmd_ptr = 0;
Sean Callanan9d48e802010-12-14 00:42:36 +0000428 }
429 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000430 }
431
Sean Callanan933693b2012-02-10 01:22:05 +0000432 if (!m_expr_decl_map->Materialize(struct_address, materialize_error))
Sean Callanan1a8d4092010-08-27 01:01:44 +0000433 {
Sean Callananfc55f5d2010-09-21 00:44:12 +0000434 error_stream.Printf("Couldn't materialize struct: %s\n", materialize_error.AsCString());
Sean Callanan1a8d4092010-08-27 01:01:44 +0000435 return false;
436 }
Greg Claytonc4e411f2011-01-18 19:36:39 +0000437
438#if 0
439 // jingham: look here
440 StreamFile logfile ("/tmp/exprs.txt", "a");
Greg Clayton22a939a2011-01-19 23:00:49 +0000441 logfile.Printf("0x%16.16llx: thread = 0x%4.4x, expr = '%s'\n", m_jit_start_addr, exe_ctx.thread ? exe_ctx.thread->GetID() : -1, m_expr_text.c_str());
Greg Claytonc4e411f2011-01-18 19:36:39 +0000442#endif
Sean Callanan1a8d4092010-08-27 01:01:44 +0000443
444 if (log)
445 {
Sean Callanana162eba2010-12-07 22:55:01 +0000446 log->Printf("-- [ClangUserExpression::PrepareToExecuteJITExpression] Materializing for execution --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000447
Greg Clayton22a939a2011-01-19 23:00:49 +0000448 log->Printf(" Function address : 0x%llx", (uint64_t)m_jit_start_addr);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000449
450 if (m_needs_object_ptr)
Sean Callananc673a6e2010-12-07 10:00:20 +0000451 log->Printf(" Object pointer : 0x%llx", (uint64_t)object_ptr);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000452
Sean Callananc673a6e2010-12-07 10:00:20 +0000453 log->Printf(" Structure address : 0x%llx", (uint64_t)struct_address);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000454
455 StreamString args;
456
457 Error dump_error;
458
Sean Callanan9e6ed532010-09-13 21:34:21 +0000459 if (struct_address)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000460 {
Sean Callanan933693b2012-02-10 01:22:05 +0000461 if (!m_expr_decl_map->DumpMaterializedStruct(args, dump_error))
Sean Callanan9e6ed532010-09-13 21:34:21 +0000462 {
Sean Callananc673a6e2010-12-07 10:00:20 +0000463 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
Sean Callanan9e6ed532010-09-13 21:34:21 +0000464 }
465 else
466 {
Sean Callananc673a6e2010-12-07 10:00:20 +0000467 log->Printf(" Structure contents:\n%s", args.GetData());
Sean Callanan9e6ed532010-09-13 21:34:21 +0000468 }
Sean Callanan1a8d4092010-08-27 01:01:44 +0000469 }
470 }
Jim Ingham36f3b362010-10-14 23:45:03 +0000471 }
472 return true;
473}
474
475ThreadPlan *
476ClangUserExpression::GetThreadPlanToExecuteJITExpression (Stream &error_stream,
Sean Callanan92adcac2011-01-13 08:53:35 +0000477 ExecutionContext &exe_ctx)
Jim Ingham36f3b362010-10-14 23:45:03 +0000478{
479 lldb::addr_t struct_address;
480
Johnny Chen44805302011-07-19 19:48:13 +0000481 lldb::addr_t object_ptr = 0;
482 lldb::addr_t cmd_ptr = 0;
Jim Ingham36f3b362010-10-14 23:45:03 +0000483
Sean Callanan9d48e802010-12-14 00:42:36 +0000484 PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr);
Jim Ingham36f3b362010-10-14 23:45:03 +0000485
Jim Inghamf48169b2010-11-30 02:22:11 +0000486 // FIXME: This should really return a ThreadPlanCallUserExpression, in order to make sure that we don't release the
487 // ClangUserExpression resources before the thread plan finishes execution in the target. But because we are
Sean Callanan17827832010-12-13 22:46:15 +0000488 // forcing unwind_on_error to be true here, in practical terms that can't happen.
489
Jim Ingham36f3b362010-10-14 23:45:03 +0000490 return ClangFunction::GetThreadPlanToCallFunction (exe_ctx,
Greg Clayton22a939a2011-01-19 23:00:49 +0000491 m_jit_start_addr,
Sean Callanan1d47caf2010-12-01 01:28:23 +0000492 struct_address,
493 error_stream,
494 true,
495 true,
Sean Callanan17827832010-12-13 22:46:15 +0000496 (m_needs_object_ptr ? &object_ptr : NULL),
497 (m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL);
Jim Ingham36f3b362010-10-14 23:45:03 +0000498}
499
500bool
501ClangUserExpression::FinalizeJITExecution (Stream &error_stream,
502 ExecutionContext &exe_ctx,
Sean Callanane359d9b2011-05-09 22:04:36 +0000503 lldb::ClangExpressionVariableSP &result,
504 lldb::addr_t function_stack_pointer)
Jim Ingham36f3b362010-10-14 23:45:03 +0000505{
506 Error expr_error;
507
Sean Callananc673a6e2010-12-07 10:00:20 +0000508 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
509
510 if (log)
511 {
Sean Callanana162eba2010-12-07 22:55:01 +0000512 log->Printf("-- [ClangUserExpression::FinalizeJITExecution] Dematerializing after execution --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000513
514 StreamString args;
515
516 Error dump_error;
517
Sean Callanan933693b2012-02-10 01:22:05 +0000518 if (!m_expr_decl_map->DumpMaterializedStruct(args, dump_error))
Sean Callananc673a6e2010-12-07 10:00:20 +0000519 {
520 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
521 }
522 else
523 {
524 log->Printf(" Structure contents:\n%s", args.GetData());
525 }
526 }
Sean Callanane359d9b2011-05-09 22:04:36 +0000527
528 lldb::addr_t function_stack_bottom = function_stack_pointer - Host::GetPageSize();
529
Sean Callananc673a6e2010-12-07 10:00:20 +0000530
Sean Callanan933693b2012-02-10 01:22:05 +0000531 if (!m_expr_decl_map->Dematerialize(result, function_stack_pointer, function_stack_bottom, expr_error))
Jim Ingham36f3b362010-10-14 23:45:03 +0000532 {
533 error_stream.Printf ("Couldn't dematerialize struct : %s\n", expr_error.AsCString("unknown error"));
534 return false;
535 }
Sean Callanane3aef1d2011-10-12 22:20:02 +0000536
Johnny Chenb49440f2012-01-06 00:35:38 +0000537 if (result)
538 result->TransferAddress();
539
Jim Ingham36f3b362010-10-14 23:45:03 +0000540 return true;
541}
542
Greg Claytone0d378b2011-03-24 21:19:54 +0000543ExecutionResults
Jim Ingham36f3b362010-10-14 23:45:03 +0000544ClangUserExpression::Execute (Stream &error_stream,
545 ExecutionContext &exe_ctx,
Jim Ingham399f1ca2010-11-05 19:25:48 +0000546 bool discard_on_error,
Jim Inghamf48169b2010-11-30 02:22:11 +0000547 ClangUserExpression::ClangUserExpressionSP &shared_ptr_to_me,
Greg Clayton8b2fe6d2010-12-14 02:59:59 +0000548 lldb::ClangExpressionVariableSP &result)
Jim Ingham36f3b362010-10-14 23:45:03 +0000549{
Jim Inghamb086ff72011-01-18 22:20:08 +0000550 // The expression log is quite verbose, and if you're just tracking the execution of the
551 // expression, it's quite convenient to have these logs come out with the STEP log as well.
552 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callananc673a6e2010-12-07 10:00:20 +0000553
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000554 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Jim Ingham36f3b362010-10-14 23:45:03 +0000555 {
556 lldb::addr_t struct_address;
557
Johnny Chen44805302011-07-19 19:48:13 +0000558 lldb::addr_t object_ptr = 0;
559 lldb::addr_t cmd_ptr = 0;
Jim Ingham36f3b362010-10-14 23:45:03 +0000560
Sean Callanan9d48e802010-12-14 00:42:36 +0000561 if (!PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr))
Greg Claytone0d378b2011-03-24 21:19:54 +0000562 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000563
Jim Ingham399f1ca2010-11-05 19:25:48 +0000564 const bool stop_others = true;
565 const bool try_all_threads = true;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000566
Greg Claytone72dfb32012-02-24 01:59:29 +0000567 Address wrapper_address (m_jit_start_addr);
Greg Claytonc14ee322011-09-22 04:58:26 +0000568 lldb::ThreadPlanSP call_plan_sp(new ThreadPlanCallUserExpression (exe_ctx.GetThreadRef(),
Sean Callanan17827832010-12-13 22:46:15 +0000569 wrapper_address,
570 struct_address,
571 stop_others,
572 discard_on_error,
573 (m_needs_object_ptr ? &object_ptr : NULL),
574 ((m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL),
575 shared_ptr_to_me));
576
Jim Inghamf48169b2010-11-30 02:22:11 +0000577 if (call_plan_sp == NULL || !call_plan_sp->ValidatePlan (NULL))
Greg Claytone0d378b2011-03-24 21:19:54 +0000578 return eExecutionSetupError;
Sean Callanane359d9b2011-05-09 22:04:36 +0000579
580 lldb::addr_t function_stack_pointer = static_cast<ThreadPlanCallFunction *>(call_plan_sp.get())->GetFunctionStackPointer();
Jim Inghamf48169b2010-11-30 02:22:11 +0000581
Jim Ingham17e5c4e2011-05-17 22:24:54 +0000582 call_plan_sp->SetPrivate(true);
Jim Inghamf48169b2010-11-30 02:22:11 +0000583
Greg Claytone2d4f0d2011-01-19 07:54:15 +0000584 uint32_t single_thread_timeout_usec = 500000;
Sean Callananc673a6e2010-12-07 10:00:20 +0000585
586 if (log)
Sean Callanana162eba2010-12-07 22:55:01 +0000587 log->Printf("-- [ClangUserExpression::Execute] Execution of expression begins --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000588
Jim Ingham0faa43f2011-11-08 03:00:11 +0000589 if (exe_ctx.GetProcessPtr())
590 exe_ctx.GetProcessPtr()->SetRunningUserExpression(true);
591
Greg Claytonc14ee322011-09-22 04:58:26 +0000592 ExecutionResults execution_result = exe_ctx.GetProcessRef().RunThreadPlan (exe_ctx,
593 call_plan_sp,
594 stop_others,
595 try_all_threads,
596 discard_on_error,
597 single_thread_timeout_usec,
598 error_stream);
Sean Callananc673a6e2010-12-07 10:00:20 +0000599
Jim Ingham0faa43f2011-11-08 03:00:11 +0000600 if (exe_ctx.GetProcessPtr())
601 exe_ctx.GetProcessPtr()->SetRunningUserExpression(false);
602
Sean Callananc673a6e2010-12-07 10:00:20 +0000603 if (log)
Sean Callanana162eba2010-12-07 22:55:01 +0000604 log->Printf("-- [ClangUserExpression::Execute] Execution of expression completed --");
Jim Inghamf48169b2010-11-30 02:22:11 +0000605
Greg Claytone0d378b2011-03-24 21:19:54 +0000606 if (execution_result == eExecutionInterrupted)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000607 {
Jim Ingham160f78c2011-05-17 01:10:11 +0000608 const char *error_desc = NULL;
609
610 if (call_plan_sp)
611 {
612 lldb::StopInfoSP real_stop_info_sp = call_plan_sp->GetRealStopInfo();
613 if (real_stop_info_sp)
614 error_desc = real_stop_info_sp->GetDescription();
615 }
616 if (error_desc)
617 error_stream.Printf ("Execution was interrupted, reason: %s.", error_desc);
Jim Inghamf48169b2010-11-30 02:22:11 +0000618 else
Jason Molendafd54b362011-09-20 21:44:10 +0000619 error_stream.Printf ("Execution was interrupted.");
Jim Ingham160f78c2011-05-17 01:10:11 +0000620
621 if (discard_on_error)
622 error_stream.Printf ("\nThe process has been returned to the state before execution.");
623 else
624 error_stream.Printf ("\nThe process has been left at the point where it was interrupted.");
Jim Inghamf48169b2010-11-30 02:22:11 +0000625
626 return execution_result;
627 }
Greg Claytone0d378b2011-03-24 21:19:54 +0000628 else if (execution_result != eExecutionCompleted)
Jim Inghamf48169b2010-11-30 02:22:11 +0000629 {
630 error_stream.Printf ("Couldn't execute function; result was %s\n", Process::ExecutionResultAsCString (execution_result));
631 return execution_result;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000632 }
633
Sean Callanane359d9b2011-05-09 22:04:36 +0000634 if (FinalizeJITExecution (error_stream, exe_ctx, result, function_stack_pointer))
Greg Claytone0d378b2011-03-24 21:19:54 +0000635 return eExecutionCompleted;
Jim Inghamf48169b2010-11-30 02:22:11 +0000636 else
Greg Claytone0d378b2011-03-24 21:19:54 +0000637 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000638 }
639 else
640 {
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000641 error_stream.Printf("Expression can't be run, because there is no JIT compiled function");
Greg Claytone0d378b2011-03-24 21:19:54 +0000642 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000643 }
644}
645
Greg Claytone0d378b2011-03-24 21:19:54 +0000646ExecutionResults
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000647ClangUserExpression::Evaluate (ExecutionContext &exe_ctx,
648 lldb_private::ExecutionPolicy execution_policy,
Sean Callananc7b65062011-11-07 23:35:40 +0000649 lldb::LanguageType language,
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000650 ResultType desired_type,
Jim Ingham399f1ca2010-11-05 19:25:48 +0000651 bool discard_on_error,
Sean Callanan322f5292010-10-29 00:29:03 +0000652 const char *expr_cstr,
Jim Inghamf48169b2010-11-30 02:22:11 +0000653 const char *expr_prefix,
654 lldb::ValueObjectSP &result_valobj_sp)
Greg Clayton0184f012010-10-05 00:31:29 +0000655{
Jim Ingham41c75912011-08-09 00:00:49 +0000656 Error error;
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000657 return EvaluateWithError (exe_ctx, execution_policy, language, desired_type, discard_on_error, expr_cstr, expr_prefix, result_valobj_sp, error);
Jim Ingham41c75912011-08-09 00:00:49 +0000658}
659
660ExecutionResults
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000661ClangUserExpression::EvaluateWithError (ExecutionContext &exe_ctx,
662 lldb_private::ExecutionPolicy execution_policy,
Sean Callananc7b65062011-11-07 23:35:40 +0000663 lldb::LanguageType language,
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000664 ResultType desired_type,
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000665 bool discard_on_error,
666 const char *expr_cstr,
667 const char *expr_prefix,
668 lldb::ValueObjectSP &result_valobj_sp,
669 Error &error)
Jim Ingham41c75912011-08-09 00:00:49 +0000670{
Jim Inghamb086ff72011-01-18 22:20:08 +0000671 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callanana162eba2010-12-07 22:55:01 +0000672
Greg Claytone0d378b2011-03-24 21:19:54 +0000673 ExecutionResults execution_results = eExecutionSetupError;
Greg Clayton8f343b02010-11-04 01:54:29 +0000674
Greg Claytonc14ee322011-09-22 04:58:26 +0000675 Process *process = exe_ctx.GetProcessPtr();
676
677 if (process == NULL || process->GetState() != lldb::eStateStopped)
Jim Inghamf48169b2010-11-30 02:22:11 +0000678 {
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000679 if (execution_policy == eExecutionPolicyAlways)
680 {
681 if (log)
682 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
Jim Inghamf48169b2010-11-30 02:22:11 +0000683
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000684 error.SetErrorString ("expression needed to run but couldn't");
685
686 return execution_results;
687 }
Jim Inghamf48169b2010-11-30 02:22:11 +0000688 }
Sean Callanan64fe1992011-09-15 17:43:00 +0000689
Greg Claytonc14ee322011-09-22 04:58:26 +0000690 if (process == NULL || !process->CanJIT())
Sean Callanan64fe1992011-09-15 17:43:00 +0000691 execution_policy = eExecutionPolicyNever;
Greg Clayton8f343b02010-11-04 01:54:29 +0000692
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000693 ClangUserExpressionSP user_expression_sp (new ClangUserExpression (expr_cstr, expr_prefix, language, desired_type));
Jim Inghamf48169b2010-11-30 02:22:11 +0000694
Greg Clayton0184f012010-10-05 00:31:29 +0000695 StreamString error_stream;
Sean Callanan63697e52011-05-07 01:06:41 +0000696
Sean Callanana162eba2010-12-07 22:55:01 +0000697 if (log)
698 log->Printf("== [ClangUserExpression::Evaluate] Parsing expression %s ==", expr_cstr);
699
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000700 const bool keep_expression_in_memory = true;
701
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000702 if (!user_expression_sp->Parse (error_stream, exe_ctx, execution_policy, keep_expression_in_memory))
Greg Clayton0184f012010-10-05 00:31:29 +0000703 {
704 if (error_stream.GetString().empty())
705 error.SetErrorString ("expression failed to parse, unknown error");
706 else
707 error.SetErrorString (error_stream.GetString().c_str());
708 }
709 else
710 {
Greg Clayton8b2fe6d2010-12-14 02:59:59 +0000711 lldb::ClangExpressionVariableSP expr_result;
Greg Clayton0184f012010-10-05 00:31:29 +0000712
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000713 if (user_expression_sp->EvaluatedStatically())
Greg Clayton0184f012010-10-05 00:31:29 +0000714 {
Sean Callanana162eba2010-12-07 22:55:01 +0000715 if (log)
Sean Callanane4ec90e2010-12-16 03:17:46 +0000716 log->Printf("== [ClangUserExpression::Evaluate] Expression evaluated as a constant ==");
Sean Callanana162eba2010-12-07 22:55:01 +0000717
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000718 if (user_expression_sp->m_const_result)
719 result_valobj_sp = user_expression_sp->m_const_result->GetValueObject();
720 else
721 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
722
Jim Ingham41c75912011-08-09 00:00:49 +0000723 execution_results = eExecutionCompleted;
Greg Clayton0184f012010-10-05 00:31:29 +0000724 }
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000725 else if (execution_policy == eExecutionPolicyNever)
726 {
727 if (log)
728 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
729
730 if (error_stream.GetString().empty())
731 error.SetErrorString ("expression needed to run but couldn't");
732 }
Sean Callanane4ec90e2010-12-16 03:17:46 +0000733 else
734 {
735 error_stream.GetString().clear();
736
737 if (log)
738 log->Printf("== [ClangUserExpression::Evaluate] Executing expression ==");
739
740 execution_results = user_expression_sp->Execute (error_stream,
741 exe_ctx,
Sean Callanan92adcac2011-01-13 08:53:35 +0000742 discard_on_error,
Sean Callanane4ec90e2010-12-16 03:17:46 +0000743 user_expression_sp,
744 expr_result);
745
Greg Claytone0d378b2011-03-24 21:19:54 +0000746 if (execution_results != eExecutionCompleted)
Greg Clayton0184f012010-10-05 00:31:29 +0000747 {
Sean Callanana162eba2010-12-07 22:55:01 +0000748 if (log)
Sean Callanane4ec90e2010-12-16 03:17:46 +0000749 log->Printf("== [ClangUserExpression::Evaluate] Execution completed abnormally ==");
750
751 if (error_stream.GetString().empty())
752 error.SetErrorString ("expression failed to execute, unknown error");
753 else
754 error.SetErrorString (error_stream.GetString().c_str());
Greg Clayton0184f012010-10-05 00:31:29 +0000755 }
Sean Callanane4ec90e2010-12-16 03:17:46 +0000756 else
Greg Clayton0184f012010-10-05 00:31:29 +0000757 {
Sean Callanane4ec90e2010-12-16 03:17:46 +0000758 if (expr_result)
759 {
760 result_valobj_sp = expr_result->GetValueObject();
761
762 if (log)
Jim Ingham6035b672011-03-31 00:19:25 +0000763 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with result %s ==", result_valobj_sp->GetValueAsCString());
Sean Callanane4ec90e2010-12-16 03:17:46 +0000764 }
765 else
766 {
767 if (log)
768 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with no result ==");
769
Sean Callananbccce812011-08-23 21:20:51 +0000770 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
Sean Callanane4ec90e2010-12-16 03:17:46 +0000771 }
Greg Clayton0184f012010-10-05 00:31:29 +0000772 }
773 }
774 }
Sean Callananc57f64d2010-10-19 20:15:00 +0000775
Greg Claytonb71f3842010-10-05 03:13:51 +0000776 if (result_valobj_sp.get() == NULL)
Jim Ingham58b59f92011-04-22 23:53:53 +0000777 result_valobj_sp = ValueObjectConstResult::Create (NULL, error);
Greg Claytonb71f3842010-10-05 03:13:51 +0000778
Jim Inghamf48169b2010-11-30 02:22:11 +0000779 return execution_results;
Johnny Chendabefd02010-10-29 20:19:44 +0000780}