blob: 7a2541d9173ff436a75e46a9460ba91c2b47a384 [file] [log] [blame]
Sean Callananc0492742011-05-23 21:40:23 +00001//===-- ClangUserExpression.cpp ---------------------------------*- C++ -*-===//
Sean Callanan65dafa82010-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 Claytonc71899e2011-01-18 19:36:39 +000023#include "lldb/Core/StreamFile.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000024#include "lldb/Core/StreamString.h"
Greg Claytond1719722010-10-05 03:13:51 +000025#include "lldb/Core/ValueObjectConstResult.h"
Sean Callanan05a5a1b2010-12-16 03:17:46 +000026#include "lldb/Expression/ASTResultSynthesizer.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000027#include "lldb/Expression/ClangExpressionDeclMap.h"
28#include "lldb/Expression/ClangExpressionParser.h"
29#include "lldb/Expression/ClangFunction.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000030#include "lldb/Expression/ClangUserExpression.h"
Sean Callanande3d27e2011-09-26 18:45:31 +000031#include "lldb/Expression/ExpressionSourceCode.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000032#include "lldb/Host/Host.h"
Sean Callanan3c9c5eb2010-09-21 00:44:12 +000033#include "lldb/Symbol/VariableList.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000034#include "lldb/Target/ExecutionContext.h"
Greg Clayton0baa3942010-11-04 01:54:29 +000035#include "lldb/Target/Process.h"
Sean Callanan3c9c5eb2010-09-21 00:44:12 +000036#include "lldb/Target/StackFrame.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000037#include "lldb/Target/Target.h"
Jim Ingham360f53f2010-11-30 02:22:11 +000038#include "lldb/Target/ThreadPlan.h"
39#include "lldb/Target/ThreadPlanCallUserExpression.h"
Sean Callanan65dafa82010-08-27 01:01:44 +000040
Sean Callananc617a4c2011-08-05 23:43:37 +000041#include "clang/AST/DeclCXX.h"
42#include "clang/AST/DeclObjC.h"
43
Sean Callanan65dafa82010-08-27 01:01:44 +000044using namespace lldb_private;
45
Sean Callanan77e93942010-10-29 00:29:03 +000046ClangUserExpression::ClangUserExpression (const char *expr,
Sean Callanan5b658cc2011-11-07 23:35:40 +000047 const char *expr_prefix,
Sean Callanandaa6efe2011-12-21 22:22:58 +000048 lldb::LanguageType language,
49 ResultType desired_type) :
Greg Claytond0882d02011-01-19 23:00:49 +000050 ClangExpression (),
51 m_expr_text (expr),
52 m_expr_prefix (expr_prefix ? expr_prefix : ""),
Sean Callanan5b658cc2011-11-07 23:35:40 +000053 m_language (language),
Greg Claytond0882d02011-01-19 23:00:49 +000054 m_transformed_text (),
Sean Callanandaa6efe2011-12-21 22:22:58 +000055 m_desired_type (desired_type),
Greg Claytond0882d02011-01-19 23:00:49 +000056 m_cplusplus (false),
57 m_objectivec (false),
58 m_needs_object_ptr (false),
Sean Callanan696cf5f2011-05-07 01:06:41 +000059 m_const_object (false),
Sean Callanane6ea5fe2011-11-15 02:11:17 +000060 m_static_method(false),
Daniel Dunbar97c89572011-10-31 22:50:49 +000061 m_target (NULL),
Sean Callanan47dc4572011-09-15 02:13:07 +000062 m_evaluated_statically (false),
Sean Callanan5ed59a72011-12-13 01:42:04 +000063 m_const_result (),
64 m_enforce_valid_object (false)
Sean Callanan65dafa82010-08-27 01:01:44 +000065{
Sean Callanan5b658cc2011-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 Callanan65dafa82010-08-27 01:01:44 +000080}
81
Sean Callanan830a9032010-08-27 23:31:21 +000082ClangUserExpression::~ClangUserExpression ()
83{
84}
85
Sean Callanan65dafa82010-08-27 01:01:44 +000086clang::ASTConsumer *
87ClangUserExpression::ASTTransformer (clang::ASTConsumer *passthrough)
Sean Callanan036fa902011-08-24 22:18:12 +000088{
Sean Callanan24312442011-08-23 21:20:51 +000089 ClangASTContext *clang_ast_context = m_target->GetScratchClangASTContext();
90
91 if (!clang_ast_context)
92 return NULL;
93
Sean Callanan060d53f2011-10-08 00:21:35 +000094 if (!m_result_synthesizer.get())
95 m_result_synthesizer.reset(new ASTResultSynthesizer(passthrough,
Sean Callanane1301a62011-12-06 03:41:14 +000096 *m_target));
Sean Callanan060d53f2011-10-08 00:21:35 +000097
98 return m_result_synthesizer.get();
Sean Callanan65dafa82010-08-27 01:01:44 +000099}
100
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000101void
Sean Callananfa9e6dd2011-11-04 02:09:33 +0000102ClangUserExpression::ScanContext(ExecutionContext &exe_ctx, Error &err)
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000103{
Greg Clayton567e7f32011-09-22 04:58:26 +0000104 m_target = exe_ctx.GetTargetPtr();
Greg Clayton144188b2011-09-12 23:21:58 +0000105
Sean Callanan5b658cc2011-11-07 23:35:40 +0000106 if (!(m_allow_cxx || m_allow_objc))
107 return;
108
Greg Clayton567e7f32011-09-22 04:58:26 +0000109 StackFrame *frame = exe_ctx.GetFramePtr();
110 if (frame == NULL)
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000111 return;
112
Greg Clayton567e7f32011-09-22 04:58:26 +0000113 SymbolContext sym_ctx = frame->GetSymbolContext(lldb::eSymbolContextFunction);
Sean Callanane8e55572010-12-01 21:35:54 +0000114
Sean Callananc617a4c2011-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 Callanan036fa902011-08-24 22:18:12 +0000127
Sean Callananc617a4c2011-08-05 23:43:37 +0000128 if (clang::CXXMethodDecl *method_decl = llvm::dyn_cast<clang::CXXMethodDecl>(decl_context))
Sean Callanane8e55572010-12-01 21:35:54 +0000129 {
Sean Callanan5b658cc2011-11-07 23:35:40 +0000130 if (m_allow_cxx && method_decl->isInstance())
Sean Callanane8e55572010-12-01 21:35:54 +0000131 {
Sean Callanan5ed59a72011-12-13 01:42:04 +0000132 if (m_enforce_valid_object)
Sean Callananfa9e6dd2011-11-04 02:09:33 +0000133 {
Sean Callanan5ed59a72011-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 Callananfa9e6dd2011-11-04 02:09:33 +0000155 }
156
Sean Callananc617a4c2011-08-05 23:43:37 +0000157 m_cplusplus = true;
Sean Callanande3d27e2011-09-26 18:45:31 +0000158 m_needs_object_ptr = true;
Sean Callanane8e55572010-12-01 21:35:54 +0000159
Sean Callananc617a4c2011-08-05 23:43:37 +0000160 do {
161 clang::QualType this_type = method_decl->getThisType(decl_context->getParentASTContext());
162
Sean Callanan21f2e192011-12-14 01:13:04 +0000163 const clang::PointerType *this_pointer_type = this_type->getAs<clang::PointerType>();
Sean Callananc617a4c2011-08-05 23:43:37 +0000164
165 if (!this_pointer_type)
166 break;
167
168 clang::QualType this_pointee_type = this_pointer_type->getPointeeType();
169 } while (0);
Sean Callanane8e55572010-12-01 21:35:54 +0000170 }
171 }
Sean Callananc617a4c2011-08-05 23:43:37 +0000172 else if (clang::ObjCMethodDecl *method_decl = llvm::dyn_cast<clang::ObjCMethodDecl>(decl_context))
Sean Callananfa9e6dd2011-11-04 02:09:33 +0000173 {
Sean Callanane6ea5fe2011-11-15 02:11:17 +0000174 if (m_allow_objc)
Sean Callanande3d27e2011-09-26 18:45:31 +0000175 {
Sean Callanan5ed59a72011-12-13 01:42:04 +0000176 if (m_enforce_valid_object)
Sean Callananfa9e6dd2011-11-04 02:09:33 +0000177 {
Sean Callanan5ed59a72011-12-13 01:42:04 +0000178 VariableList *vars = frame->GetVariableList(false);
179
180 const char *selfErrorString = "Stopped in an Objective-C method, but 'self' isn't available; pretending we are in a generic context";
181
182 if (!vars)
183 {
184 err.SetErrorToGenericError();
185 err.SetErrorString(selfErrorString);
186 return;
187 }
188
189 lldb::VariableSP self_var = vars->FindVariable(ConstString("self"));
190
191 if (!self_var ||
192 !self_var->IsInScope(frame) ||
193 !self_var->LocationIsValidForFrame (frame))
194 {
195 err.SetErrorToGenericError();
196 err.SetErrorString(selfErrorString);
197 return;
198 }
Sean Callananfa9e6dd2011-11-04 02:09:33 +0000199 }
200
Sean Callananc617a4c2011-08-05 23:43:37 +0000201 m_objectivec = true;
Sean Callanande3d27e2011-09-26 18:45:31 +0000202 m_needs_object_ptr = true;
Sean Callanane6ea5fe2011-11-15 02:11:17 +0000203
204 if (!method_decl->isInstanceMethod())
205 m_static_method = true;
Sean Callanande3d27e2011-09-26 18:45:31 +0000206 }
Sean Callanane8e55572010-12-01 21:35:54 +0000207 }
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000208}
209
Sean Callanan550f2762010-10-22 23:25:16 +0000210// This is a really nasty hack, meant to fix Objective-C expressions of the form
211// (int)[myArray count]. Right now, because the type information for count is
212// not available, [myArray count] returns id, which can't be directly cast to
213// int without causing a clang error.
214static void
215ApplyObjcCastHack(std::string &expr)
216{
217#define OBJC_CAST_HACK_FROM "(int)["
218#define OBJC_CAST_HACK_TO "(int)(long long)["
219
220 size_t from_offset;
221
222 while ((from_offset = expr.find(OBJC_CAST_HACK_FROM)) != expr.npos)
223 expr.replace(from_offset, sizeof(OBJC_CAST_HACK_FROM) - 1, OBJC_CAST_HACK_TO);
224
225#undef OBJC_CAST_HACK_TO
226#undef OBJC_CAST_HACK_FROM
227}
228
Sean Callanan30892372010-10-24 20:45:49 +0000229// Another hack, meant to allow use of unichar despite it not being available in
230// the type information. Although we could special-case it in type lookup,
231// hopefully we'll figure out a way to #include the same environment as is
232// present in the original source file rather than try to hack specific type
233// definitions in as needed.
234static void
235ApplyUnicharHack(std::string &expr)
236{
237#define UNICHAR_HACK_FROM "unichar"
238#define UNICHAR_HACK_TO "unsigned short"
239
240 size_t from_offset;
241
242 while ((from_offset = expr.find(UNICHAR_HACK_FROM)) != expr.npos)
243 expr.replace(from_offset, sizeof(UNICHAR_HACK_FROM) - 1, UNICHAR_HACK_TO);
244
245#undef UNICHAR_HACK_TO
246#undef UNICHAR_HACK_FROM
247}
248
Sean Callanan550f2762010-10-22 23:25:16 +0000249bool
Sean Callanana91dd992010-11-19 02:52:21 +0000250ClangUserExpression::Parse (Stream &error_stream,
251 ExecutionContext &exe_ctx,
Sean Callanan47dc4572011-09-15 02:13:07 +0000252 lldb_private::ExecutionPolicy execution_policy,
Sean Callanan696cf5f2011-05-07 01:06:41 +0000253 bool keep_result_in_memory)
Sean Callanan65dafa82010-08-27 01:01:44 +0000254{
Greg Claytone005f2c2010-11-06 01:53:30 +0000255 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan65dafa82010-08-27 01:01:44 +0000256
Sean Callananfa9e6dd2011-11-04 02:09:33 +0000257 Error err;
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000258
259 InstallContext(exe_ctx);
Sean Callananfa9e6dd2011-11-04 02:09:33 +0000260
261 ScanContext(exe_ctx, err);
262
263 if (!err.Success())
264 {
265 error_stream.Printf("warning: %s\n", err.AsCString());
266 }
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000267
268 StreamString m_transformed_stream;
269
270 ////////////////////////////////////
271 // Generate the expression
272 //
Sean Callanan550f2762010-10-22 23:25:16 +0000273
274 ApplyObjcCastHack(m_expr_text);
Greg Claytonf3d0b0c2010-10-27 03:32:59 +0000275 //ApplyUnicharHack(m_expr_text);
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000276
Sean Callanande3d27e2011-09-26 18:45:31 +0000277 std::auto_ptr <ExpressionSourceCode> source_code (ExpressionSourceCode::CreateWrapped(m_expr_prefix.c_str(), m_expr_text.c_str()));
278
279 lldb::LanguageType lang_type;
280
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000281 if (m_cplusplus)
Sean Callanande3d27e2011-09-26 18:45:31 +0000282 lang_type = lldb::eLanguageTypeC_plus_plus;
283 else if(m_objectivec)
284 lang_type = lldb::eLanguageTypeObjC;
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000285 else
Sean Callanande3d27e2011-09-26 18:45:31 +0000286 lang_type = lldb::eLanguageTypeC;
287
Sean Callanane6ea5fe2011-11-15 02:11:17 +0000288 if (!source_code->GetText(m_transformed_text, lang_type, m_const_object, m_static_method))
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000289 {
Sean Callanande3d27e2011-09-26 18:45:31 +0000290 error_stream.PutCString ("error: couldn't construct expression body");
291 return false;
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000292 }
293
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000294 if (log)
295 log->Printf("Parsing the following code:\n%s", m_transformed_text.c_str());
296
Sean Callanan65dafa82010-08-27 01:01:44 +0000297 ////////////////////////////////////
298 // Set up the target and compiler
299 //
300
Greg Clayton567e7f32011-09-22 04:58:26 +0000301 Target *target = exe_ctx.GetTargetPtr();
Sean Callanan65dafa82010-08-27 01:01:44 +0000302
303 if (!target)
304 {
305 error_stream.PutCString ("error: invalid target\n");
306 return false;
307 }
308
Sean Callanan65dafa82010-08-27 01:01:44 +0000309 //////////////////////////
310 // Parse the expression
311 //
Sean Callanandaa6efe2011-12-21 22:22:58 +0000312
Sean Callanan73b520f2011-10-29 01:58:46 +0000313 m_expr_decl_map.reset(new ClangExpressionDeclMap(keep_result_in_memory, exe_ctx));
Sean Callananaa301c42010-12-03 01:38:59 +0000314
Sean Callanan166ba102011-08-01 18:18:33 +0000315 if (!m_expr_decl_map->WillParse(exe_ctx))
316 {
317 error_stream.PutCString ("error: current process state is unsuitable for expression parsing\n");
318 return false;
319 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000320
Greg Clayton567e7f32011-09-22 04:58:26 +0000321 Process *process = exe_ctx.GetProcessPtr();
Sean Callanane7ba1122012-02-08 18:43:35 +0000322 ExecutionContextScope *exe_scope = process;
323
324 if (!exe_scope)
325 exe_scope = exe_ctx.GetTargetPtr();
326
327 ClangExpressionParser parser(exe_scope, *this);
Sean Callanan65dafa82010-08-27 01:01:44 +0000328
329 unsigned num_errors = parser.Parse (error_stream);
330
331 if (num_errors)
332 {
333 error_stream.Printf ("error: %d errors parsing expression\n", num_errors);
Sean Callananaa301c42010-12-03 01:38:59 +0000334
335 m_expr_decl_map->DidParse();
336
Sean Callanan65dafa82010-08-27 01:01:44 +0000337 return false;
338 }
339
Sean Callanan47dc4572011-09-15 02:13:07 +0000340 //////////////////////////////////////////////////////////////////////////////////////////
341 // Prepare the output of the parser for execution, evaluating it statically if possible
Sean Callanan65dafa82010-08-27 01:01:44 +0000342 //
Sean Callanan65dafa82010-08-27 01:01:44 +0000343
Greg Clayton567e7f32011-09-22 04:58:26 +0000344 if (execution_policy != eExecutionPolicyNever && process)
345 m_data_allocator.reset(new ProcessDataAllocator(*process));
Sean Callanan65dafa82010-08-27 01:01:44 +0000346
Sean Callanan47dc4572011-09-15 02:13:07 +0000347 Error jit_error = parser.PrepareForExecution (m_jit_alloc,
348 m_jit_start_addr,
349 m_jit_end_addr,
350 exe_ctx,
351 m_data_allocator.get(),
352 m_evaluated_statically,
353 m_const_result,
354 execution_policy);
Sean Callanan65dafa82010-08-27 01:01:44 +0000355
Sean Callanan47dc4572011-09-15 02:13:07 +0000356 if (log && m_data_allocator.get())
Sean Callananc0492742011-05-23 21:40:23 +0000357 {
358 StreamString dump_string;
359 m_data_allocator->Dump(dump_string);
360
361 log->Printf("Data buffer contents:\n%s", dump_string.GetString().c_str());
362 }
Sean Callanan6d284ef2011-10-12 22:20:02 +0000363
Sean Callanan65dafa82010-08-27 01:01:44 +0000364 if (jit_error.Success())
365 {
Greg Clayton567e7f32011-09-22 04:58:26 +0000366 if (process && m_jit_alloc != LLDB_INVALID_ADDRESS)
Greg Clayton13d24fb2012-01-29 20:56:30 +0000367 m_jit_process_sp = process->shared_from_this();
Sean Callanan65dafa82010-08-27 01:01:44 +0000368 return true;
369 }
370 else
371 {
Greg Clayton30581972011-05-17 03:51:29 +0000372 const char *error_cstr = jit_error.AsCString();
373 if (error_cstr && error_cstr[0])
374 error_stream.Printf ("error: %s\n", error_cstr);
375 else
Jason Molenda7e5fa7f2011-09-20 21:44:10 +0000376 error_stream.Printf ("error: expression can't be interpreted or run\n");
Sean Callanan65dafa82010-08-27 01:01:44 +0000377 return false;
378 }
379}
380
381bool
Jim Inghamd1686902010-10-14 23:45:03 +0000382ClangUserExpression::PrepareToExecuteJITExpression (Stream &error_stream,
Sean Callananab06af92010-10-19 23:57:21 +0000383 ExecutionContext &exe_ctx,
384 lldb::addr_t &struct_address,
Sean Callanan047923c2010-12-14 00:42:36 +0000385 lldb::addr_t &object_ptr,
386 lldb::addr_t &cmd_ptr)
Sean Callanan65dafa82010-08-27 01:01:44 +0000387{
Greg Claytone005f2c2010-11-06 01:53:30 +0000388 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan65dafa82010-08-27 01:01:44 +0000389
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000390 lldb::TargetSP target;
391 lldb::ProcessSP process;
392 lldb::StackFrameSP frame;
393
394 if (!LockAndCheckContext(exe_ctx,
395 target,
396 process,
397 frame))
398 {
399 error_stream.Printf("The context has changed before we could JIT the expression!");
400 return false;
401 }
402
Greg Claytond0882d02011-01-19 23:00:49 +0000403 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Sean Callanan65dafa82010-08-27 01:01:44 +0000404 {
Sean Callanan65dafa82010-08-27 01:01:44 +0000405 Error materialize_error;
406
Sean Callanan3aa7da52010-12-13 22:46:15 +0000407 if (m_needs_object_ptr)
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000408 {
Sean Callanan3aa7da52010-12-13 22:46:15 +0000409 ConstString object_name;
410
411 if (m_cplusplus)
412 {
413 object_name.SetCString("this");
414 }
415 else if (m_objectivec)
416 {
417 object_name.SetCString("self");
418 }
419 else
420 {
421 error_stream.Printf("Need object pointer but don't know the language\n");
422 return false;
423 }
424
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000425 if (!(m_expr_decl_map->GetObjectPointer(object_ptr, object_name, materialize_error)))
Sean Callanan3aa7da52010-12-13 22:46:15 +0000426 {
Sean Callanan5ed59a72011-12-13 01:42:04 +0000427 error_stream.Printf("warning: couldn't get required object pointer (substituting NULL): %s\n", materialize_error.AsCString());
428 object_ptr = 0;
Sean Callanan3aa7da52010-12-13 22:46:15 +0000429 }
Sean Callanan047923c2010-12-14 00:42:36 +0000430
431 if (m_objectivec)
432 {
433 ConstString cmd_name("_cmd");
434
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000435 if (!(m_expr_decl_map->GetObjectPointer(cmd_ptr, cmd_name, materialize_error, true)))
Sean Callanan047923c2010-12-14 00:42:36 +0000436 {
Sean Callanan5ed59a72011-12-13 01:42:04 +0000437 error_stream.Printf("warning: couldn't get object pointer (substituting NULL): %s\n", materialize_error.AsCString());
438 cmd_ptr = 0;
Sean Callanan047923c2010-12-14 00:42:36 +0000439 }
440 }
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000441 }
442
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000443 if (!m_expr_decl_map->Materialize(struct_address, materialize_error))
Sean Callanan65dafa82010-08-27 01:01:44 +0000444 {
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000445 error_stream.Printf("Couldn't materialize struct: %s\n", materialize_error.AsCString());
Sean Callanan65dafa82010-08-27 01:01:44 +0000446 return false;
447 }
Greg Claytonc71899e2011-01-18 19:36:39 +0000448
449#if 0
450 // jingham: look here
451 StreamFile logfile ("/tmp/exprs.txt", "a");
Greg Claytond0882d02011-01-19 23:00:49 +0000452 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 Claytonc71899e2011-01-18 19:36:39 +0000453#endif
Sean Callanan65dafa82010-08-27 01:01:44 +0000454
455 if (log)
456 {
Sean Callanan94d255f2010-12-07 22:55:01 +0000457 log->Printf("-- [ClangUserExpression::PrepareToExecuteJITExpression] Materializing for execution --");
Sean Callanan33711022010-12-07 10:00:20 +0000458
Greg Claytond0882d02011-01-19 23:00:49 +0000459 log->Printf(" Function address : 0x%llx", (uint64_t)m_jit_start_addr);
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000460
461 if (m_needs_object_ptr)
Sean Callanan33711022010-12-07 10:00:20 +0000462 log->Printf(" Object pointer : 0x%llx", (uint64_t)object_ptr);
Sean Callanan3c9c5eb2010-09-21 00:44:12 +0000463
Sean Callanan33711022010-12-07 10:00:20 +0000464 log->Printf(" Structure address : 0x%llx", (uint64_t)struct_address);
Sean Callanan65dafa82010-08-27 01:01:44 +0000465
466 StreamString args;
467
468 Error dump_error;
469
Sean Callanane8a59a82010-09-13 21:34:21 +0000470 if (struct_address)
Sean Callanan65dafa82010-08-27 01:01:44 +0000471 {
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000472 if (!m_expr_decl_map->DumpMaterializedStruct(args, dump_error))
Sean Callanane8a59a82010-09-13 21:34:21 +0000473 {
Sean Callanan33711022010-12-07 10:00:20 +0000474 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
Sean Callanane8a59a82010-09-13 21:34:21 +0000475 }
476 else
477 {
Sean Callanan33711022010-12-07 10:00:20 +0000478 log->Printf(" Structure contents:\n%s", args.GetData());
Sean Callanane8a59a82010-09-13 21:34:21 +0000479 }
Sean Callanan65dafa82010-08-27 01:01:44 +0000480 }
481 }
Jim Inghamd1686902010-10-14 23:45:03 +0000482 }
483 return true;
484}
485
486ThreadPlan *
487ClangUserExpression::GetThreadPlanToExecuteJITExpression (Stream &error_stream,
Sean Callanan6a925532011-01-13 08:53:35 +0000488 ExecutionContext &exe_ctx)
Jim Inghamd1686902010-10-14 23:45:03 +0000489{
490 lldb::addr_t struct_address;
491
Johnny Chen2bc9eb32011-07-19 19:48:13 +0000492 lldb::addr_t object_ptr = 0;
493 lldb::addr_t cmd_ptr = 0;
Jim Inghamd1686902010-10-14 23:45:03 +0000494
Sean Callanan047923c2010-12-14 00:42:36 +0000495 PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr);
Jim Inghamd1686902010-10-14 23:45:03 +0000496
Jim Ingham360f53f2010-11-30 02:22:11 +0000497 // FIXME: This should really return a ThreadPlanCallUserExpression, in order to make sure that we don't release the
498 // ClangUserExpression resources before the thread plan finishes execution in the target. But because we are
Sean Callanan3aa7da52010-12-13 22:46:15 +0000499 // forcing unwind_on_error to be true here, in practical terms that can't happen.
500
Jim Inghamd1686902010-10-14 23:45:03 +0000501 return ClangFunction::GetThreadPlanToCallFunction (exe_ctx,
Greg Claytond0882d02011-01-19 23:00:49 +0000502 m_jit_start_addr,
Sean Callanana65b5272010-12-01 01:28:23 +0000503 struct_address,
504 error_stream,
505 true,
506 true,
Sean Callanan3aa7da52010-12-13 22:46:15 +0000507 (m_needs_object_ptr ? &object_ptr : NULL),
508 (m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL);
Jim Inghamd1686902010-10-14 23:45:03 +0000509}
510
511bool
512ClangUserExpression::FinalizeJITExecution (Stream &error_stream,
513 ExecutionContext &exe_ctx,
Sean Callanan0ddf8062011-05-09 22:04:36 +0000514 lldb::ClangExpressionVariableSP &result,
515 lldb::addr_t function_stack_pointer)
Jim Inghamd1686902010-10-14 23:45:03 +0000516{
517 Error expr_error;
518
Sean Callanan33711022010-12-07 10:00:20 +0000519 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
520
521 if (log)
522 {
Sean Callanan94d255f2010-12-07 22:55:01 +0000523 log->Printf("-- [ClangUserExpression::FinalizeJITExecution] Dematerializing after execution --");
Sean Callanan33711022010-12-07 10:00:20 +0000524
525 StreamString args;
526
527 Error dump_error;
528
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000529 if (!m_expr_decl_map->DumpMaterializedStruct(args, dump_error))
Sean Callanan33711022010-12-07 10:00:20 +0000530 {
531 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
532 }
533 else
534 {
535 log->Printf(" Structure contents:\n%s", args.GetData());
536 }
537 }
Sean Callanan0ddf8062011-05-09 22:04:36 +0000538
539 lldb::addr_t function_stack_bottom = function_stack_pointer - Host::GetPageSize();
540
Sean Callanan33711022010-12-07 10:00:20 +0000541
Sean Callanandd1dcfd2012-02-10 01:22:05 +0000542 if (!m_expr_decl_map->Dematerialize(result, function_stack_pointer, function_stack_bottom, expr_error))
Jim Inghamd1686902010-10-14 23:45:03 +0000543 {
544 error_stream.Printf ("Couldn't dematerialize struct : %s\n", expr_error.AsCString("unknown error"));
545 return false;
546 }
Sean Callanan6d284ef2011-10-12 22:20:02 +0000547
Johnny Chenc6134962012-01-06 00:35:38 +0000548 if (result)
549 result->TransferAddress();
550
Jim Inghamd1686902010-10-14 23:45:03 +0000551 return true;
552}
553
Greg Claytonb3448432011-03-24 21:19:54 +0000554ExecutionResults
Jim Inghamd1686902010-10-14 23:45:03 +0000555ClangUserExpression::Execute (Stream &error_stream,
556 ExecutionContext &exe_ctx,
Jim Inghamea9d4262010-11-05 19:25:48 +0000557 bool discard_on_error,
Jim Ingham360f53f2010-11-30 02:22:11 +0000558 ClangUserExpression::ClangUserExpressionSP &shared_ptr_to_me,
Greg Clayton427f2902010-12-14 02:59:59 +0000559 lldb::ClangExpressionVariableSP &result)
Jim Inghamd1686902010-10-14 23:45:03 +0000560{
Jim Ingham7812e012011-01-18 22:20:08 +0000561 // The expression log is quite verbose, and if you're just tracking the execution of the
562 // expression, it's quite convenient to have these logs come out with the STEP log as well.
563 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callanan33711022010-12-07 10:00:20 +0000564
Sean Callanan47dc4572011-09-15 02:13:07 +0000565 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Jim Inghamd1686902010-10-14 23:45:03 +0000566 {
567 lldb::addr_t struct_address;
568
Johnny Chen2bc9eb32011-07-19 19:48:13 +0000569 lldb::addr_t object_ptr = 0;
570 lldb::addr_t cmd_ptr = 0;
Jim Inghamd1686902010-10-14 23:45:03 +0000571
Sean Callanan047923c2010-12-14 00:42:36 +0000572 if (!PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr))
Greg Claytonb3448432011-03-24 21:19:54 +0000573 return eExecutionSetupError;
Sean Callanan65dafa82010-08-27 01:01:44 +0000574
Jim Inghamea9d4262010-11-05 19:25:48 +0000575 const bool stop_others = true;
576 const bool try_all_threads = true;
Sean Callanan65dafa82010-08-27 01:01:44 +0000577
Greg Clayton3508c382012-02-24 01:59:29 +0000578 Address wrapper_address (m_jit_start_addr);
Greg Clayton567e7f32011-09-22 04:58:26 +0000579 lldb::ThreadPlanSP call_plan_sp(new ThreadPlanCallUserExpression (exe_ctx.GetThreadRef(),
Sean Callanan3aa7da52010-12-13 22:46:15 +0000580 wrapper_address,
581 struct_address,
582 stop_others,
583 discard_on_error,
584 (m_needs_object_ptr ? &object_ptr : NULL),
585 ((m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL),
586 shared_ptr_to_me));
587
Jim Ingham360f53f2010-11-30 02:22:11 +0000588 if (call_plan_sp == NULL || !call_plan_sp->ValidatePlan (NULL))
Greg Claytonb3448432011-03-24 21:19:54 +0000589 return eExecutionSetupError;
Sean Callanan0ddf8062011-05-09 22:04:36 +0000590
591 lldb::addr_t function_stack_pointer = static_cast<ThreadPlanCallFunction *>(call_plan_sp.get())->GetFunctionStackPointer();
Jim Ingham360f53f2010-11-30 02:22:11 +0000592
Jim Ingham5ab7fba2011-05-17 22:24:54 +0000593 call_plan_sp->SetPrivate(true);
Jim Ingham360f53f2010-11-30 02:22:11 +0000594
Greg Clayton61468e82011-01-19 07:54:15 +0000595 uint32_t single_thread_timeout_usec = 500000;
Sean Callanan33711022010-12-07 10:00:20 +0000596
597 if (log)
Sean Callanan94d255f2010-12-07 22:55:01 +0000598 log->Printf("-- [ClangUserExpression::Execute] Execution of expression begins --");
Sean Callanan33711022010-12-07 10:00:20 +0000599
Jim Ingham0296fe72011-11-08 03:00:11 +0000600 if (exe_ctx.GetProcessPtr())
601 exe_ctx.GetProcessPtr()->SetRunningUserExpression(true);
602
Greg Clayton567e7f32011-09-22 04:58:26 +0000603 ExecutionResults execution_result = exe_ctx.GetProcessRef().RunThreadPlan (exe_ctx,
604 call_plan_sp,
605 stop_others,
606 try_all_threads,
607 discard_on_error,
608 single_thread_timeout_usec,
609 error_stream);
Sean Callanan33711022010-12-07 10:00:20 +0000610
Jim Ingham0296fe72011-11-08 03:00:11 +0000611 if (exe_ctx.GetProcessPtr())
612 exe_ctx.GetProcessPtr()->SetRunningUserExpression(false);
613
Sean Callanan33711022010-12-07 10:00:20 +0000614 if (log)
Sean Callanan94d255f2010-12-07 22:55:01 +0000615 log->Printf("-- [ClangUserExpression::Execute] Execution of expression completed --");
Jim Ingham360f53f2010-11-30 02:22:11 +0000616
Greg Claytonb3448432011-03-24 21:19:54 +0000617 if (execution_result == eExecutionInterrupted)
Sean Callanan65dafa82010-08-27 01:01:44 +0000618 {
Jim Ingham2370a972011-05-17 01:10:11 +0000619 const char *error_desc = NULL;
620
621 if (call_plan_sp)
622 {
623 lldb::StopInfoSP real_stop_info_sp = call_plan_sp->GetRealStopInfo();
624 if (real_stop_info_sp)
625 error_desc = real_stop_info_sp->GetDescription();
626 }
627 if (error_desc)
628 error_stream.Printf ("Execution was interrupted, reason: %s.", error_desc);
Jim Ingham360f53f2010-11-30 02:22:11 +0000629 else
Jason Molenda7e5fa7f2011-09-20 21:44:10 +0000630 error_stream.Printf ("Execution was interrupted.");
Jim Ingham2370a972011-05-17 01:10:11 +0000631
632 if (discard_on_error)
633 error_stream.Printf ("\nThe process has been returned to the state before execution.");
634 else
635 error_stream.Printf ("\nThe process has been left at the point where it was interrupted.");
Jim Ingham360f53f2010-11-30 02:22:11 +0000636
637 return execution_result;
638 }
Greg Claytonb3448432011-03-24 21:19:54 +0000639 else if (execution_result != eExecutionCompleted)
Jim Ingham360f53f2010-11-30 02:22:11 +0000640 {
641 error_stream.Printf ("Couldn't execute function; result was %s\n", Process::ExecutionResultAsCString (execution_result));
642 return execution_result;
Sean Callanan65dafa82010-08-27 01:01:44 +0000643 }
644
Sean Callanan0ddf8062011-05-09 22:04:36 +0000645 if (FinalizeJITExecution (error_stream, exe_ctx, result, function_stack_pointer))
Greg Claytonb3448432011-03-24 21:19:54 +0000646 return eExecutionCompleted;
Jim Ingham360f53f2010-11-30 02:22:11 +0000647 else
Greg Claytonb3448432011-03-24 21:19:54 +0000648 return eExecutionSetupError;
Sean Callanan65dafa82010-08-27 01:01:44 +0000649 }
650 else
651 {
Sean Callanan47dc4572011-09-15 02:13:07 +0000652 error_stream.Printf("Expression can't be run, because there is no JIT compiled function");
Greg Claytonb3448432011-03-24 21:19:54 +0000653 return eExecutionSetupError;
Sean Callanan65dafa82010-08-27 01:01:44 +0000654 }
655}
656
Greg Claytonb3448432011-03-24 21:19:54 +0000657ExecutionResults
Sean Callanan47dc4572011-09-15 02:13:07 +0000658ClangUserExpression::Evaluate (ExecutionContext &exe_ctx,
659 lldb_private::ExecutionPolicy execution_policy,
Sean Callanan5b658cc2011-11-07 23:35:40 +0000660 lldb::LanguageType language,
Sean Callanandaa6efe2011-12-21 22:22:58 +0000661 ResultType desired_type,
Jim Inghamea9d4262010-11-05 19:25:48 +0000662 bool discard_on_error,
Sean Callanan77e93942010-10-29 00:29:03 +0000663 const char *expr_cstr,
Jim Ingham360f53f2010-11-30 02:22:11 +0000664 const char *expr_prefix,
665 lldb::ValueObjectSP &result_valobj_sp)
Greg Clayton377e0b42010-10-05 00:31:29 +0000666{
Jim Inghamec07c0d2011-08-09 00:00:49 +0000667 Error error;
Sean Callanandaa6efe2011-12-21 22:22:58 +0000668 return EvaluateWithError (exe_ctx, execution_policy, language, desired_type, discard_on_error, expr_cstr, expr_prefix, result_valobj_sp, error);
Jim Inghamec07c0d2011-08-09 00:00:49 +0000669}
670
671ExecutionResults
Sean Callanan47dc4572011-09-15 02:13:07 +0000672ClangUserExpression::EvaluateWithError (ExecutionContext &exe_ctx,
673 lldb_private::ExecutionPolicy execution_policy,
Sean Callanan5b658cc2011-11-07 23:35:40 +0000674 lldb::LanguageType language,
Sean Callanandaa6efe2011-12-21 22:22:58 +0000675 ResultType desired_type,
Sean Callanan47dc4572011-09-15 02:13:07 +0000676 bool discard_on_error,
677 const char *expr_cstr,
678 const char *expr_prefix,
679 lldb::ValueObjectSP &result_valobj_sp,
680 Error &error)
Jim Inghamec07c0d2011-08-09 00:00:49 +0000681{
Jim Ingham7812e012011-01-18 22:20:08 +0000682 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callanan94d255f2010-12-07 22:55:01 +0000683
Greg Claytonb3448432011-03-24 21:19:54 +0000684 ExecutionResults execution_results = eExecutionSetupError;
Greg Clayton0baa3942010-11-04 01:54:29 +0000685
Greg Clayton567e7f32011-09-22 04:58:26 +0000686 Process *process = exe_ctx.GetProcessPtr();
687
688 if (process == NULL || process->GetState() != lldb::eStateStopped)
Jim Ingham360f53f2010-11-30 02:22:11 +0000689 {
Sean Callanan47dc4572011-09-15 02:13:07 +0000690 if (execution_policy == eExecutionPolicyAlways)
691 {
692 if (log)
693 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
Jim Ingham360f53f2010-11-30 02:22:11 +0000694
Sean Callanan47dc4572011-09-15 02:13:07 +0000695 error.SetErrorString ("expression needed to run but couldn't");
696
697 return execution_results;
698 }
Jim Ingham360f53f2010-11-30 02:22:11 +0000699 }
Sean Callananf7649bb2011-09-15 17:43:00 +0000700
Greg Clayton567e7f32011-09-22 04:58:26 +0000701 if (process == NULL || !process->CanJIT())
Sean Callananf7649bb2011-09-15 17:43:00 +0000702 execution_policy = eExecutionPolicyNever;
Greg Clayton0baa3942010-11-04 01:54:29 +0000703
Sean Callanandaa6efe2011-12-21 22:22:58 +0000704 ClangUserExpressionSP user_expression_sp (new ClangUserExpression (expr_cstr, expr_prefix, language, desired_type));
Jim Ingham360f53f2010-11-30 02:22:11 +0000705
Greg Clayton377e0b42010-10-05 00:31:29 +0000706 StreamString error_stream;
Sean Callanan696cf5f2011-05-07 01:06:41 +0000707
Sean Callanan94d255f2010-12-07 22:55:01 +0000708 if (log)
709 log->Printf("== [ClangUserExpression::Evaluate] Parsing expression %s ==", expr_cstr);
710
Sean Callanan47dc4572011-09-15 02:13:07 +0000711 const bool keep_expression_in_memory = true;
712
Sean Callanandaa6efe2011-12-21 22:22:58 +0000713 if (!user_expression_sp->Parse (error_stream, exe_ctx, execution_policy, keep_expression_in_memory))
Greg Clayton377e0b42010-10-05 00:31:29 +0000714 {
715 if (error_stream.GetString().empty())
716 error.SetErrorString ("expression failed to parse, unknown error");
717 else
718 error.SetErrorString (error_stream.GetString().c_str());
719 }
720 else
721 {
Greg Clayton427f2902010-12-14 02:59:59 +0000722 lldb::ClangExpressionVariableSP expr_result;
Greg Clayton377e0b42010-10-05 00:31:29 +0000723
Sean Callanan47dc4572011-09-15 02:13:07 +0000724 if (user_expression_sp->EvaluatedStatically())
Greg Clayton377e0b42010-10-05 00:31:29 +0000725 {
Sean Callanan94d255f2010-12-07 22:55:01 +0000726 if (log)
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000727 log->Printf("== [ClangUserExpression::Evaluate] Expression evaluated as a constant ==");
Sean Callanan94d255f2010-12-07 22:55:01 +0000728
Sean Callanan47dc4572011-09-15 02:13:07 +0000729 if (user_expression_sp->m_const_result)
730 result_valobj_sp = user_expression_sp->m_const_result->GetValueObject();
731 else
732 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
733
Jim Inghamec07c0d2011-08-09 00:00:49 +0000734 execution_results = eExecutionCompleted;
Greg Clayton377e0b42010-10-05 00:31:29 +0000735 }
Sean Callanan47dc4572011-09-15 02:13:07 +0000736 else if (execution_policy == eExecutionPolicyNever)
737 {
738 if (log)
739 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
740
741 if (error_stream.GetString().empty())
742 error.SetErrorString ("expression needed to run but couldn't");
743 }
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000744 else
745 {
746 error_stream.GetString().clear();
747
748 if (log)
749 log->Printf("== [ClangUserExpression::Evaluate] Executing expression ==");
750
751 execution_results = user_expression_sp->Execute (error_stream,
752 exe_ctx,
Sean Callanan6a925532011-01-13 08:53:35 +0000753 discard_on_error,
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000754 user_expression_sp,
755 expr_result);
756
Greg Claytonb3448432011-03-24 21:19:54 +0000757 if (execution_results != eExecutionCompleted)
Greg Clayton377e0b42010-10-05 00:31:29 +0000758 {
Sean Callanan94d255f2010-12-07 22:55:01 +0000759 if (log)
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000760 log->Printf("== [ClangUserExpression::Evaluate] Execution completed abnormally ==");
761
762 if (error_stream.GetString().empty())
763 error.SetErrorString ("expression failed to execute, unknown error");
764 else
765 error.SetErrorString (error_stream.GetString().c_str());
Greg Clayton377e0b42010-10-05 00:31:29 +0000766 }
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000767 else
Greg Clayton377e0b42010-10-05 00:31:29 +0000768 {
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000769 if (expr_result)
770 {
771 result_valobj_sp = expr_result->GetValueObject();
772
773 if (log)
Jim Inghamfa3a16a2011-03-31 00:19:25 +0000774 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with result %s ==", result_valobj_sp->GetValueAsCString());
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000775 }
776 else
777 {
778 if (log)
779 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with no result ==");
780
Sean Callanan24312442011-08-23 21:20:51 +0000781 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
Sean Callanan05a5a1b2010-12-16 03:17:46 +0000782 }
Greg Clayton377e0b42010-10-05 00:31:29 +0000783 }
784 }
785 }
Sean Callanan44820ec2010-10-19 20:15:00 +0000786
Greg Claytond1719722010-10-05 03:13:51 +0000787 if (result_valobj_sp.get() == NULL)
Jim Ingham47da8102011-04-22 23:53:53 +0000788 result_valobj_sp = ValueObjectConstResult::Create (NULL, error);
Greg Claytond1719722010-10-05 03:13:51 +0000789
Jim Ingham360f53f2010-11-30 02:22:11 +0000790 return execution_results;
Johnny Chenb4c0f022010-10-29 20:19:44 +0000791}