blob: 4ae34a38d583300756cd1a3d1210db8dda4b1a5a [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,
48 lldb::LanguageType language) :
Greg Clayton22a939a2011-01-19 23:00:49 +000049 ClangExpression (),
50 m_expr_text (expr),
51 m_expr_prefix (expr_prefix ? expr_prefix : ""),
Sean Callananc7b65062011-11-07 23:35:40 +000052 m_language (language),
Greg Clayton22a939a2011-01-19 23:00:49 +000053 m_transformed_text (),
Stephen Wilson71c21d12011-04-11 19:41:40 +000054 m_desired_type (NULL, NULL),
Greg Clayton22a939a2011-01-19 23:00:49 +000055 m_cplusplus (false),
56 m_objectivec (false),
57 m_needs_object_ptr (false),
Sean Callanan63697e52011-05-07 01:06:41 +000058 m_const_object (false),
Sean Callanand5c17ed2011-11-15 02:11:17 +000059 m_static_method(false),
Daniel Dunbara08823f2011-10-31 22:50:49 +000060 m_target (NULL),
Sean Callanan3bfdaa22011-09-15 02:13:07 +000061 m_evaluated_statically (false),
Daniel Dunbara08823f2011-10-31 22:50:49 +000062 m_const_result ()
Sean Callanan1a8d4092010-08-27 01:01:44 +000063{
Sean Callananc7b65062011-11-07 23:35:40 +000064 switch (m_language)
65 {
66 case lldb::eLanguageTypeC_plus_plus:
67 m_allow_cxx = true;
68 break;
69 case lldb::eLanguageTypeObjC:
70 m_allow_objc = true;
71 break;
72 case lldb::eLanguageTypeObjC_plus_plus:
73 default:
74 m_allow_cxx = true;
75 m_allow_objc = true;
76 break;
77 }
Sean Callanan1a8d4092010-08-27 01:01:44 +000078}
79
Sean Callanane71d5532010-08-27 23:31:21 +000080ClangUserExpression::~ClangUserExpression ()
81{
82}
83
Sean Callanan1a8d4092010-08-27 01:01:44 +000084clang::ASTConsumer *
85ClangUserExpression::ASTTransformer (clang::ASTConsumer *passthrough)
Sean Callanan737330c2011-08-24 22:18:12 +000086{
Sean Callananbccce812011-08-23 21:20:51 +000087 ClangASTContext *clang_ast_context = m_target->GetScratchClangASTContext();
88
89 if (!clang_ast_context)
90 return NULL;
91
Sean Callanan2590b9a2011-10-08 00:21:35 +000092 if (!m_result_synthesizer.get())
93 m_result_synthesizer.reset(new ASTResultSynthesizer(passthrough,
94 m_desired_type,
95 *m_target->GetScratchClangASTContext()->getASTContext(),
96 m_target->GetPersistentVariables()));
97
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 Callanan744756e2011-11-04 02:09:33 +0000132 VariableList *vars = frame->GetVariableList(false);
133
134 const char *thisErrorString = "Stopped in a C++ method, but 'this' isn't available; pretending we are in a generic context";
135
136 if (!vars)
137 {
138 err.SetErrorToGenericError();
139 err.SetErrorString(thisErrorString);
140 return;
141 }
142
143 lldb::VariableSP this_var = vars->FindVariable(ConstString("this"));
144
145 if (!this_var ||
146 !this_var->IsInScope(frame) ||
147 !this_var->LocationIsValidForFrame (frame))
148 {
149 err.SetErrorToGenericError();
150 err.SetErrorString(thisErrorString);
151 return;
152 }
153
Sean Callanan72e49402011-08-05 23:43:37 +0000154 m_cplusplus = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000155 m_needs_object_ptr = true;
Sean Callanan3670ba52010-12-01 21:35:54 +0000156
Sean Callanan72e49402011-08-05 23:43:37 +0000157 do {
158 clang::QualType this_type = method_decl->getThisType(decl_context->getParentASTContext());
159
160 const clang::PointerType *this_pointer_type = llvm::dyn_cast<clang::PointerType>(this_type.getTypePtr());
161
162 if (!this_pointer_type)
163 break;
164
165 clang::QualType this_pointee_type = this_pointer_type->getPointeeType();
166 } while (0);
Sean Callanan3670ba52010-12-01 21:35:54 +0000167 }
168 }
Sean Callanan72e49402011-08-05 23:43:37 +0000169 else if (clang::ObjCMethodDecl *method_decl = llvm::dyn_cast<clang::ObjCMethodDecl>(decl_context))
Sean Callanan744756e2011-11-04 02:09:33 +0000170 {
Sean Callanand5c17ed2011-11-15 02:11:17 +0000171 if (m_allow_objc)
Sean Callanan9bc83842011-09-26 18:45:31 +0000172 {
Sean Callanan744756e2011-11-04 02:09:33 +0000173 VariableList *vars = frame->GetVariableList(false);
174
175 const char *selfErrorString = "Stopped in an Objective-C method, but 'self' isn't available; pretending we are in a generic context";
176
177 if (!vars)
178 {
179 err.SetErrorToGenericError();
180 err.SetErrorString(selfErrorString);
181 return;
182 }
183
184 lldb::VariableSP self_var = vars->FindVariable(ConstString("self"));
185
186 if (!self_var ||
187 !self_var->IsInScope(frame) ||
188 !self_var->LocationIsValidForFrame (frame))
189 {
190 err.SetErrorToGenericError();
191 err.SetErrorString(selfErrorString);
192 return;
193 }
194
Sean Callanan72e49402011-08-05 23:43:37 +0000195 m_objectivec = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000196 m_needs_object_ptr = true;
Sean Callanand5c17ed2011-11-15 02:11:17 +0000197
198 if (!method_decl->isInstanceMethod())
199 m_static_method = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000200 }
Sean Callanan3670ba52010-12-01 21:35:54 +0000201 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000202}
203
Sean Callanancf5498f2010-10-22 23:25:16 +0000204// This is a really nasty hack, meant to fix Objective-C expressions of the form
205// (int)[myArray count]. Right now, because the type information for count is
206// not available, [myArray count] returns id, which can't be directly cast to
207// int without causing a clang error.
208static void
209ApplyObjcCastHack(std::string &expr)
210{
211#define OBJC_CAST_HACK_FROM "(int)["
212#define OBJC_CAST_HACK_TO "(int)(long long)["
213
214 size_t from_offset;
215
216 while ((from_offset = expr.find(OBJC_CAST_HACK_FROM)) != expr.npos)
217 expr.replace(from_offset, sizeof(OBJC_CAST_HACK_FROM) - 1, OBJC_CAST_HACK_TO);
218
219#undef OBJC_CAST_HACK_TO
220#undef OBJC_CAST_HACK_FROM
221}
222
Sean Callanan64186e72010-10-24 20:45:49 +0000223// Another hack, meant to allow use of unichar despite it not being available in
224// the type information. Although we could special-case it in type lookup,
225// hopefully we'll figure out a way to #include the same environment as is
226// present in the original source file rather than try to hack specific type
227// definitions in as needed.
228static void
229ApplyUnicharHack(std::string &expr)
230{
231#define UNICHAR_HACK_FROM "unichar"
232#define UNICHAR_HACK_TO "unsigned short"
233
234 size_t from_offset;
235
236 while ((from_offset = expr.find(UNICHAR_HACK_FROM)) != expr.npos)
237 expr.replace(from_offset, sizeof(UNICHAR_HACK_FROM) - 1, UNICHAR_HACK_TO);
238
239#undef UNICHAR_HACK_TO
240#undef UNICHAR_HACK_FROM
241}
242
Sean Callanancf5498f2010-10-22 23:25:16 +0000243bool
Sean Callananf7c3e272010-11-19 02:52:21 +0000244ClangUserExpression::Parse (Stream &error_stream,
245 ExecutionContext &exe_ctx,
Sean Callanane4ec90e2010-12-16 03:17:46 +0000246 TypeFromUser desired_type,
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000247 lldb_private::ExecutionPolicy execution_policy,
Sean Callanan63697e52011-05-07 01:06:41 +0000248 bool keep_result_in_memory)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000249{
Greg Clayton2d4edfb2010-11-06 01:53:30 +0000250 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000251
Sean Callanan744756e2011-11-04 02:09:33 +0000252 Error err;
253
254 ScanContext(exe_ctx, err);
255
256 if (!err.Success())
257 {
258 error_stream.Printf("warning: %s\n", err.AsCString());
259 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000260
261 StreamString m_transformed_stream;
262
263 ////////////////////////////////////
264 // Generate the expression
265 //
Sean Callanancf5498f2010-10-22 23:25:16 +0000266
267 ApplyObjcCastHack(m_expr_text);
Greg Clayton73b472d2010-10-27 03:32:59 +0000268 //ApplyUnicharHack(m_expr_text);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000269
Sean Callanan9bc83842011-09-26 18:45:31 +0000270 std::auto_ptr <ExpressionSourceCode> source_code (ExpressionSourceCode::CreateWrapped(m_expr_prefix.c_str(), m_expr_text.c_str()));
271
272 lldb::LanguageType lang_type;
273
Sean Callananfc55f5d2010-09-21 00:44:12 +0000274 if (m_cplusplus)
Sean Callanan9bc83842011-09-26 18:45:31 +0000275 lang_type = lldb::eLanguageTypeC_plus_plus;
276 else if(m_objectivec)
277 lang_type = lldb::eLanguageTypeObjC;
Sean Callananfc55f5d2010-09-21 00:44:12 +0000278 else
Sean Callanan9bc83842011-09-26 18:45:31 +0000279 lang_type = lldb::eLanguageTypeC;
280
Sean Callanand5c17ed2011-11-15 02:11:17 +0000281 if (!source_code->GetText(m_transformed_text, lang_type, m_const_object, m_static_method))
Sean Callananfc55f5d2010-09-21 00:44:12 +0000282 {
Sean Callanan9bc83842011-09-26 18:45:31 +0000283 error_stream.PutCString ("error: couldn't construct expression body");
284 return false;
Sean Callananfc55f5d2010-09-21 00:44:12 +0000285 }
286
Sean Callananfc55f5d2010-09-21 00:44:12 +0000287 if (log)
288 log->Printf("Parsing the following code:\n%s", m_transformed_text.c_str());
289
Sean Callanan1a8d4092010-08-27 01:01:44 +0000290 ////////////////////////////////////
291 // Set up the target and compiler
292 //
293
Greg Claytonc14ee322011-09-22 04:58:26 +0000294 Target *target = exe_ctx.GetTargetPtr();
Sean Callanan1a8d4092010-08-27 01:01:44 +0000295
296 if (!target)
297 {
298 error_stream.PutCString ("error: invalid target\n");
299 return false;
300 }
301
Sean Callanan1a8d4092010-08-27 01:01:44 +0000302 //////////////////////////
303 // Parse the expression
304 //
305
Sean Callananf7c3e272010-11-19 02:52:21 +0000306 m_desired_type = desired_type;
307
Sean Callanan1ee44b72011-10-29 01:58:46 +0000308 m_expr_decl_map.reset(new ClangExpressionDeclMap(keep_result_in_memory, exe_ctx));
Sean Callanan979f74d2010-12-03 01:38:59 +0000309
Sean Callananb9951192011-08-01 18:18:33 +0000310 if (!m_expr_decl_map->WillParse(exe_ctx))
311 {
312 error_stream.PutCString ("error: current process state is unsuitable for expression parsing\n");
313 return false;
314 }
Sean Callanan1a8d4092010-08-27 01:01:44 +0000315
Greg Claytonc14ee322011-09-22 04:58:26 +0000316 Process *process = exe_ctx.GetProcessPtr();
317 ClangExpressionParser parser(process, *this);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000318
319 unsigned num_errors = parser.Parse (error_stream);
320
321 if (num_errors)
322 {
323 error_stream.Printf ("error: %d errors parsing expression\n", num_errors);
Sean Callanan979f74d2010-12-03 01:38:59 +0000324
325 m_expr_decl_map->DidParse();
326
Sean Callanan1a8d4092010-08-27 01:01:44 +0000327 return false;
328 }
329
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000330 //////////////////////////////////////////////////////////////////////////////////////////
331 // Prepare the output of the parser for execution, evaluating it statically if possible
Sean Callanan1a8d4092010-08-27 01:01:44 +0000332 //
Sean Callanan1a8d4092010-08-27 01:01:44 +0000333
Greg Claytonc14ee322011-09-22 04:58:26 +0000334 if (execution_policy != eExecutionPolicyNever && process)
335 m_data_allocator.reset(new ProcessDataAllocator(*process));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000336
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000337 Error jit_error = parser.PrepareForExecution (m_jit_alloc,
338 m_jit_start_addr,
339 m_jit_end_addr,
340 exe_ctx,
341 m_data_allocator.get(),
342 m_evaluated_statically,
343 m_const_result,
344 execution_policy);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000345
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000346 if (log && m_data_allocator.get())
Sean Callanan79763a42011-05-23 21:40:23 +0000347 {
348 StreamString dump_string;
349 m_data_allocator->Dump(dump_string);
350
351 log->Printf("Data buffer contents:\n%s", dump_string.GetString().c_str());
352 }
Sean Callanane3aef1d2011-10-12 22:20:02 +0000353
Sean Callanan1a8d4092010-08-27 01:01:44 +0000354 if (jit_error.Success())
355 {
Greg Claytonc14ee322011-09-22 04:58:26 +0000356 if (process && m_jit_alloc != LLDB_INVALID_ADDRESS)
357 m_jit_process_sp = process->GetSP();
Sean Callanan1a8d4092010-08-27 01:01:44 +0000358 return true;
359 }
360 else
361 {
Greg Claytone6a9e432011-05-17 03:51:29 +0000362 const char *error_cstr = jit_error.AsCString();
363 if (error_cstr && error_cstr[0])
364 error_stream.Printf ("error: %s\n", error_cstr);
365 else
Jason Molendafd54b362011-09-20 21:44:10 +0000366 error_stream.Printf ("error: expression can't be interpreted or run\n");
Sean Callanan1a8d4092010-08-27 01:01:44 +0000367 return false;
368 }
369}
370
371bool
Jim Ingham36f3b362010-10-14 23:45:03 +0000372ClangUserExpression::PrepareToExecuteJITExpression (Stream &error_stream,
Sean Callanan104a6e92010-10-19 23:57:21 +0000373 ExecutionContext &exe_ctx,
374 lldb::addr_t &struct_address,
Sean Callanan9d48e802010-12-14 00:42:36 +0000375 lldb::addr_t &object_ptr,
376 lldb::addr_t &cmd_ptr)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000377{
Greg Clayton2d4edfb2010-11-06 01:53:30 +0000378 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000379
Greg Clayton22a939a2011-01-19 23:00:49 +0000380 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000381 {
Sean Callanan1a8d4092010-08-27 01:01:44 +0000382 Error materialize_error;
383
Sean Callanan17827832010-12-13 22:46:15 +0000384 if (m_needs_object_ptr)
Sean Callananfc55f5d2010-09-21 00:44:12 +0000385 {
Sean Callanan17827832010-12-13 22:46:15 +0000386 ConstString object_name;
387
388 if (m_cplusplus)
389 {
390 object_name.SetCString("this");
391 }
392 else if (m_objectivec)
393 {
394 object_name.SetCString("self");
395 }
396 else
397 {
398 error_stream.Printf("Need object pointer but don't know the language\n");
399 return false;
400 }
401
402 if (!(m_expr_decl_map->GetObjectPointer(object_ptr, object_name, exe_ctx, materialize_error)))
403 {
404 error_stream.Printf("Couldn't get required object pointer: %s\n", materialize_error.AsCString());
405 return false;
406 }
Sean Callanan9d48e802010-12-14 00:42:36 +0000407
408 if (m_objectivec)
409 {
410 ConstString cmd_name("_cmd");
411
412 if (!(m_expr_decl_map->GetObjectPointer(cmd_ptr, cmd_name, exe_ctx, materialize_error, true)))
413 {
414 error_stream.Printf("Couldn't get required object pointer: %s\n", materialize_error.AsCString());
415 return false;
416 }
417 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000418 }
419
Sean Callanan979f74d2010-12-03 01:38:59 +0000420 if (!m_expr_decl_map->Materialize(exe_ctx, struct_address, materialize_error))
Sean Callanan1a8d4092010-08-27 01:01:44 +0000421 {
Sean Callananfc55f5d2010-09-21 00:44:12 +0000422 error_stream.Printf("Couldn't materialize struct: %s\n", materialize_error.AsCString());
Sean Callanan1a8d4092010-08-27 01:01:44 +0000423 return false;
424 }
Greg Claytonc4e411f2011-01-18 19:36:39 +0000425
426#if 0
427 // jingham: look here
428 StreamFile logfile ("/tmp/exprs.txt", "a");
Greg Clayton22a939a2011-01-19 23:00:49 +0000429 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 +0000430#endif
Sean Callanan1a8d4092010-08-27 01:01:44 +0000431
432 if (log)
433 {
Sean Callanana162eba2010-12-07 22:55:01 +0000434 log->Printf("-- [ClangUserExpression::PrepareToExecuteJITExpression] Materializing for execution --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000435
Greg Clayton22a939a2011-01-19 23:00:49 +0000436 log->Printf(" Function address : 0x%llx", (uint64_t)m_jit_start_addr);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000437
438 if (m_needs_object_ptr)
Sean Callananc673a6e2010-12-07 10:00:20 +0000439 log->Printf(" Object pointer : 0x%llx", (uint64_t)object_ptr);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000440
Sean Callananc673a6e2010-12-07 10:00:20 +0000441 log->Printf(" Structure address : 0x%llx", (uint64_t)struct_address);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000442
443 StreamString args;
444
445 Error dump_error;
446
Sean Callanan9e6ed532010-09-13 21:34:21 +0000447 if (struct_address)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000448 {
Sean Callanan979f74d2010-12-03 01:38:59 +0000449 if (!m_expr_decl_map->DumpMaterializedStruct(exe_ctx, args, dump_error))
Sean Callanan9e6ed532010-09-13 21:34:21 +0000450 {
Sean Callananc673a6e2010-12-07 10:00:20 +0000451 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
Sean Callanan9e6ed532010-09-13 21:34:21 +0000452 }
453 else
454 {
Sean Callananc673a6e2010-12-07 10:00:20 +0000455 log->Printf(" Structure contents:\n%s", args.GetData());
Sean Callanan9e6ed532010-09-13 21:34:21 +0000456 }
Sean Callanan1a8d4092010-08-27 01:01:44 +0000457 }
458 }
Jim Ingham36f3b362010-10-14 23:45:03 +0000459 }
460 return true;
461}
462
463ThreadPlan *
464ClangUserExpression::GetThreadPlanToExecuteJITExpression (Stream &error_stream,
Sean Callanan92adcac2011-01-13 08:53:35 +0000465 ExecutionContext &exe_ctx)
Jim Ingham36f3b362010-10-14 23:45:03 +0000466{
467 lldb::addr_t struct_address;
468
Johnny Chen44805302011-07-19 19:48:13 +0000469 lldb::addr_t object_ptr = 0;
470 lldb::addr_t cmd_ptr = 0;
Jim Ingham36f3b362010-10-14 23:45:03 +0000471
Sean Callanan9d48e802010-12-14 00:42:36 +0000472 PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr);
Jim Ingham36f3b362010-10-14 23:45:03 +0000473
Jim Inghamf48169b2010-11-30 02:22:11 +0000474 // FIXME: This should really return a ThreadPlanCallUserExpression, in order to make sure that we don't release the
475 // ClangUserExpression resources before the thread plan finishes execution in the target. But because we are
Sean Callanan17827832010-12-13 22:46:15 +0000476 // forcing unwind_on_error to be true here, in practical terms that can't happen.
477
Jim Ingham36f3b362010-10-14 23:45:03 +0000478 return ClangFunction::GetThreadPlanToCallFunction (exe_ctx,
Greg Clayton22a939a2011-01-19 23:00:49 +0000479 m_jit_start_addr,
Sean Callanan1d47caf2010-12-01 01:28:23 +0000480 struct_address,
481 error_stream,
482 true,
483 true,
Sean Callanan17827832010-12-13 22:46:15 +0000484 (m_needs_object_ptr ? &object_ptr : NULL),
485 (m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL);
Jim Ingham36f3b362010-10-14 23:45:03 +0000486}
487
488bool
489ClangUserExpression::FinalizeJITExecution (Stream &error_stream,
490 ExecutionContext &exe_ctx,
Sean Callanane359d9b2011-05-09 22:04:36 +0000491 lldb::ClangExpressionVariableSP &result,
492 lldb::addr_t function_stack_pointer)
Jim Ingham36f3b362010-10-14 23:45:03 +0000493{
494 Error expr_error;
495
Sean Callananc673a6e2010-12-07 10:00:20 +0000496 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
497
498 if (log)
499 {
Sean Callanana162eba2010-12-07 22:55:01 +0000500 log->Printf("-- [ClangUserExpression::FinalizeJITExecution] Dematerializing after execution --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000501
502 StreamString args;
503
504 Error dump_error;
505
506 if (!m_expr_decl_map->DumpMaterializedStruct(exe_ctx, args, dump_error))
507 {
508 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
509 }
510 else
511 {
512 log->Printf(" Structure contents:\n%s", args.GetData());
513 }
514 }
Sean Callanane359d9b2011-05-09 22:04:36 +0000515
516 lldb::addr_t function_stack_bottom = function_stack_pointer - Host::GetPageSize();
517
Sean Callananc673a6e2010-12-07 10:00:20 +0000518
Sean Callanane359d9b2011-05-09 22:04:36 +0000519 if (!m_expr_decl_map->Dematerialize(exe_ctx, result, function_stack_pointer, function_stack_bottom, expr_error))
Jim Ingham36f3b362010-10-14 23:45:03 +0000520 {
521 error_stream.Printf ("Couldn't dematerialize struct : %s\n", expr_error.AsCString("unknown error"));
522 return false;
523 }
Sean Callanane3aef1d2011-10-12 22:20:02 +0000524
Jim Ingham36f3b362010-10-14 23:45:03 +0000525 return true;
526}
527
Greg Claytone0d378b2011-03-24 21:19:54 +0000528ExecutionResults
Jim Ingham36f3b362010-10-14 23:45:03 +0000529ClangUserExpression::Execute (Stream &error_stream,
530 ExecutionContext &exe_ctx,
Jim Ingham399f1ca2010-11-05 19:25:48 +0000531 bool discard_on_error,
Jim Inghamf48169b2010-11-30 02:22:11 +0000532 ClangUserExpression::ClangUserExpressionSP &shared_ptr_to_me,
Greg Clayton8b2fe6d2010-12-14 02:59:59 +0000533 lldb::ClangExpressionVariableSP &result)
Jim Ingham36f3b362010-10-14 23:45:03 +0000534{
Jim Inghamb086ff72011-01-18 22:20:08 +0000535 // The expression log is quite verbose, and if you're just tracking the execution of the
536 // expression, it's quite convenient to have these logs come out with the STEP log as well.
537 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callananc673a6e2010-12-07 10:00:20 +0000538
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000539 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Jim Ingham36f3b362010-10-14 23:45:03 +0000540 {
541 lldb::addr_t struct_address;
542
Johnny Chen44805302011-07-19 19:48:13 +0000543 lldb::addr_t object_ptr = 0;
544 lldb::addr_t cmd_ptr = 0;
Jim Ingham36f3b362010-10-14 23:45:03 +0000545
Sean Callanan9d48e802010-12-14 00:42:36 +0000546 if (!PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr))
Greg Claytone0d378b2011-03-24 21:19:54 +0000547 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000548
Jim Ingham399f1ca2010-11-05 19:25:48 +0000549 const bool stop_others = true;
550 const bool try_all_threads = true;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000551
Greg Clayton22a939a2011-01-19 23:00:49 +0000552 Address wrapper_address (NULL, m_jit_start_addr);
Greg Claytonc14ee322011-09-22 04:58:26 +0000553 lldb::ThreadPlanSP call_plan_sp(new ThreadPlanCallUserExpression (exe_ctx.GetThreadRef(),
Sean Callanan17827832010-12-13 22:46:15 +0000554 wrapper_address,
555 struct_address,
556 stop_others,
557 discard_on_error,
558 (m_needs_object_ptr ? &object_ptr : NULL),
559 ((m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL),
560 shared_ptr_to_me));
561
Jim Inghamf48169b2010-11-30 02:22:11 +0000562 if (call_plan_sp == NULL || !call_plan_sp->ValidatePlan (NULL))
Greg Claytone0d378b2011-03-24 21:19:54 +0000563 return eExecutionSetupError;
Sean Callanane359d9b2011-05-09 22:04:36 +0000564
565 lldb::addr_t function_stack_pointer = static_cast<ThreadPlanCallFunction *>(call_plan_sp.get())->GetFunctionStackPointer();
Jim Inghamf48169b2010-11-30 02:22:11 +0000566
Jim Ingham17e5c4e2011-05-17 22:24:54 +0000567 call_plan_sp->SetPrivate(true);
Jim Inghamf48169b2010-11-30 02:22:11 +0000568
Greg Claytone2d4f0d2011-01-19 07:54:15 +0000569 uint32_t single_thread_timeout_usec = 500000;
Sean Callananc673a6e2010-12-07 10:00:20 +0000570
571 if (log)
Sean Callanana162eba2010-12-07 22:55:01 +0000572 log->Printf("-- [ClangUserExpression::Execute] Execution of expression begins --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000573
Jim Ingham0faa43f2011-11-08 03:00:11 +0000574 if (exe_ctx.GetProcessPtr())
575 exe_ctx.GetProcessPtr()->SetRunningUserExpression(true);
576
Greg Claytonc14ee322011-09-22 04:58:26 +0000577 ExecutionResults execution_result = exe_ctx.GetProcessRef().RunThreadPlan (exe_ctx,
578 call_plan_sp,
579 stop_others,
580 try_all_threads,
581 discard_on_error,
582 single_thread_timeout_usec,
583 error_stream);
Sean Callananc673a6e2010-12-07 10:00:20 +0000584
Jim Ingham0faa43f2011-11-08 03:00:11 +0000585 if (exe_ctx.GetProcessPtr())
586 exe_ctx.GetProcessPtr()->SetRunningUserExpression(false);
587
Sean Callananc673a6e2010-12-07 10:00:20 +0000588 if (log)
Sean Callanana162eba2010-12-07 22:55:01 +0000589 log->Printf("-- [ClangUserExpression::Execute] Execution of expression completed --");
Jim Inghamf48169b2010-11-30 02:22:11 +0000590
Greg Claytone0d378b2011-03-24 21:19:54 +0000591 if (execution_result == eExecutionInterrupted)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000592 {
Jim Ingham160f78c2011-05-17 01:10:11 +0000593 const char *error_desc = NULL;
594
595 if (call_plan_sp)
596 {
597 lldb::StopInfoSP real_stop_info_sp = call_plan_sp->GetRealStopInfo();
598 if (real_stop_info_sp)
599 error_desc = real_stop_info_sp->GetDescription();
600 }
601 if (error_desc)
602 error_stream.Printf ("Execution was interrupted, reason: %s.", error_desc);
Jim Inghamf48169b2010-11-30 02:22:11 +0000603 else
Jason Molendafd54b362011-09-20 21:44:10 +0000604 error_stream.Printf ("Execution was interrupted.");
Jim Ingham160f78c2011-05-17 01:10:11 +0000605
606 if (discard_on_error)
607 error_stream.Printf ("\nThe process has been returned to the state before execution.");
608 else
609 error_stream.Printf ("\nThe process has been left at the point where it was interrupted.");
Jim Inghamf48169b2010-11-30 02:22:11 +0000610
611 return execution_result;
612 }
Greg Claytone0d378b2011-03-24 21:19:54 +0000613 else if (execution_result != eExecutionCompleted)
Jim Inghamf48169b2010-11-30 02:22:11 +0000614 {
615 error_stream.Printf ("Couldn't execute function; result was %s\n", Process::ExecutionResultAsCString (execution_result));
616 return execution_result;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000617 }
618
Sean Callanane359d9b2011-05-09 22:04:36 +0000619 if (FinalizeJITExecution (error_stream, exe_ctx, result, function_stack_pointer))
Greg Claytone0d378b2011-03-24 21:19:54 +0000620 return eExecutionCompleted;
Jim Inghamf48169b2010-11-30 02:22:11 +0000621 else
Greg Claytone0d378b2011-03-24 21:19:54 +0000622 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000623 }
624 else
625 {
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000626 error_stream.Printf("Expression can't be run, because there is no JIT compiled function");
Greg Claytone0d378b2011-03-24 21:19:54 +0000627 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000628 }
629}
630
Greg Claytone0d378b2011-03-24 21:19:54 +0000631ExecutionResults
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000632ClangUserExpression::Evaluate (ExecutionContext &exe_ctx,
633 lldb_private::ExecutionPolicy execution_policy,
Sean Callananc7b65062011-11-07 23:35:40 +0000634 lldb::LanguageType language,
Jim Ingham399f1ca2010-11-05 19:25:48 +0000635 bool discard_on_error,
Sean Callanan322f5292010-10-29 00:29:03 +0000636 const char *expr_cstr,
Jim Inghamf48169b2010-11-30 02:22:11 +0000637 const char *expr_prefix,
638 lldb::ValueObjectSP &result_valobj_sp)
Greg Clayton0184f012010-10-05 00:31:29 +0000639{
Jim Ingham41c75912011-08-09 00:00:49 +0000640 Error error;
Sean Callananc7b65062011-11-07 23:35:40 +0000641 return EvaluateWithError (exe_ctx, execution_policy, language, discard_on_error, expr_cstr, expr_prefix, result_valobj_sp, error);
Jim Ingham41c75912011-08-09 00:00:49 +0000642}
643
644ExecutionResults
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000645ClangUserExpression::EvaluateWithError (ExecutionContext &exe_ctx,
646 lldb_private::ExecutionPolicy execution_policy,
Sean Callananc7b65062011-11-07 23:35:40 +0000647 lldb::LanguageType language,
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000648 bool discard_on_error,
649 const char *expr_cstr,
650 const char *expr_prefix,
651 lldb::ValueObjectSP &result_valobj_sp,
652 Error &error)
Jim Ingham41c75912011-08-09 00:00:49 +0000653{
Jim Inghamb086ff72011-01-18 22:20:08 +0000654 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callanana162eba2010-12-07 22:55:01 +0000655
Greg Claytone0d378b2011-03-24 21:19:54 +0000656 ExecutionResults execution_results = eExecutionSetupError;
Greg Clayton8f343b02010-11-04 01:54:29 +0000657
Greg Claytonc14ee322011-09-22 04:58:26 +0000658 Process *process = exe_ctx.GetProcessPtr();
659
660 if (process == NULL || process->GetState() != lldb::eStateStopped)
Jim Inghamf48169b2010-11-30 02:22:11 +0000661 {
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000662 if (execution_policy == eExecutionPolicyAlways)
663 {
664 if (log)
665 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
Jim Inghamf48169b2010-11-30 02:22:11 +0000666
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000667 error.SetErrorString ("expression needed to run but couldn't");
668
669 return execution_results;
670 }
Jim Inghamf48169b2010-11-30 02:22:11 +0000671 }
Sean Callanan64fe1992011-09-15 17:43:00 +0000672
Greg Claytonc14ee322011-09-22 04:58:26 +0000673 if (process == NULL || !process->CanJIT())
Sean Callanan64fe1992011-09-15 17:43:00 +0000674 execution_policy = eExecutionPolicyNever;
Greg Clayton8f343b02010-11-04 01:54:29 +0000675
Sean Callananc7b65062011-11-07 23:35:40 +0000676 ClangUserExpressionSP user_expression_sp (new ClangUserExpression (expr_cstr, expr_prefix, language));
Jim Inghamf48169b2010-11-30 02:22:11 +0000677
Greg Clayton0184f012010-10-05 00:31:29 +0000678 StreamString error_stream;
Sean Callanan63697e52011-05-07 01:06:41 +0000679
Sean Callanana162eba2010-12-07 22:55:01 +0000680 if (log)
681 log->Printf("== [ClangUserExpression::Evaluate] Parsing expression %s ==", expr_cstr);
682
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000683 const bool keep_expression_in_memory = true;
684
685 if (!user_expression_sp->Parse (error_stream, exe_ctx, TypeFromUser(NULL, NULL), execution_policy, keep_expression_in_memory))
Greg Clayton0184f012010-10-05 00:31:29 +0000686 {
687 if (error_stream.GetString().empty())
688 error.SetErrorString ("expression failed to parse, unknown error");
689 else
690 error.SetErrorString (error_stream.GetString().c_str());
691 }
692 else
693 {
Greg Clayton8b2fe6d2010-12-14 02:59:59 +0000694 lldb::ClangExpressionVariableSP expr_result;
Greg Clayton0184f012010-10-05 00:31:29 +0000695
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000696 if (user_expression_sp->EvaluatedStatically())
Greg Clayton0184f012010-10-05 00:31:29 +0000697 {
Sean Callanana162eba2010-12-07 22:55:01 +0000698 if (log)
Sean Callanane4ec90e2010-12-16 03:17:46 +0000699 log->Printf("== [ClangUserExpression::Evaluate] Expression evaluated as a constant ==");
Sean Callanana162eba2010-12-07 22:55:01 +0000700
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000701 if (user_expression_sp->m_const_result)
702 result_valobj_sp = user_expression_sp->m_const_result->GetValueObject();
703 else
704 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
705
Jim Ingham41c75912011-08-09 00:00:49 +0000706 execution_results = eExecutionCompleted;
Greg Clayton0184f012010-10-05 00:31:29 +0000707 }
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000708 else if (execution_policy == eExecutionPolicyNever)
709 {
710 if (log)
711 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
712
713 if (error_stream.GetString().empty())
714 error.SetErrorString ("expression needed to run but couldn't");
715 }
Sean Callanane4ec90e2010-12-16 03:17:46 +0000716 else
717 {
718 error_stream.GetString().clear();
719
720 if (log)
721 log->Printf("== [ClangUserExpression::Evaluate] Executing expression ==");
722
723 execution_results = user_expression_sp->Execute (error_stream,
724 exe_ctx,
Sean Callanan92adcac2011-01-13 08:53:35 +0000725 discard_on_error,
Sean Callanane4ec90e2010-12-16 03:17:46 +0000726 user_expression_sp,
727 expr_result);
728
Greg Claytone0d378b2011-03-24 21:19:54 +0000729 if (execution_results != eExecutionCompleted)
Greg Clayton0184f012010-10-05 00:31:29 +0000730 {
Sean Callanana162eba2010-12-07 22:55:01 +0000731 if (log)
Sean Callanane4ec90e2010-12-16 03:17:46 +0000732 log->Printf("== [ClangUserExpression::Evaluate] Execution completed abnormally ==");
733
734 if (error_stream.GetString().empty())
735 error.SetErrorString ("expression failed to execute, unknown error");
736 else
737 error.SetErrorString (error_stream.GetString().c_str());
Greg Clayton0184f012010-10-05 00:31:29 +0000738 }
Sean Callanane4ec90e2010-12-16 03:17:46 +0000739 else
Greg Clayton0184f012010-10-05 00:31:29 +0000740 {
Sean Callanane4ec90e2010-12-16 03:17:46 +0000741 if (expr_result)
742 {
743 result_valobj_sp = expr_result->GetValueObject();
744
745 if (log)
Jim Ingham6035b672011-03-31 00:19:25 +0000746 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with result %s ==", result_valobj_sp->GetValueAsCString());
Sean Callanane4ec90e2010-12-16 03:17:46 +0000747 }
748 else
749 {
750 if (log)
751 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with no result ==");
752
Sean Callananbccce812011-08-23 21:20:51 +0000753 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
Sean Callanane4ec90e2010-12-16 03:17:46 +0000754 }
Greg Clayton0184f012010-10-05 00:31:29 +0000755 }
756 }
757 }
Sean Callananc57f64d2010-10-19 20:15:00 +0000758
Greg Claytonb71f3842010-10-05 03:13:51 +0000759 if (result_valobj_sp.get() == NULL)
Jim Ingham58b59f92011-04-22 23:53:53 +0000760 result_valobj_sp = ValueObjectConstResult::Create (NULL, error);
Greg Claytonb71f3842010-10-05 03:13:51 +0000761
Jim Inghamf48169b2010-11-30 02:22:11 +0000762 return execution_results;
Johnny Chendabefd02010-10-29 20:19:44 +0000763}