blob: dcecbc7a7da2a334d9fd16542135c5ce17532c65 [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),
Greg Clayton22a939a2011-01-19 23:00:49 +000056 m_cplusplus (false),
57 m_objectivec (false),
58 m_needs_object_ptr (false),
Sean Callanan63697e52011-05-07 01:06:41 +000059 m_const_object (false),
Sean Callanand5c17ed2011-11-15 02:11:17 +000060 m_static_method(false),
Daniel Dunbara08823f2011-10-31 22:50:49 +000061 m_target (NULL),
Sean Callanan3bfdaa22011-09-15 02:13:07 +000062 m_evaluated_statically (false),
Sean Callanand5cc1322011-12-13 01:42:04 +000063 m_const_result (),
64 m_enforce_valid_object (false)
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
Sean Callanan72e49402011-08-05 23:43:37 +0000160 do {
161 clang::QualType this_type = method_decl->getThisType(decl_context->getParentASTContext());
162
Sean Callananfc4f2fb2011-12-14 01:13:04 +0000163 const clang::PointerType *this_pointer_type = this_type->getAs<clang::PointerType>();
Sean Callanan72e49402011-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 Callanan3670ba52010-12-01 21:35:54 +0000170 }
171 }
Sean Callanan72e49402011-08-05 23:43:37 +0000172 else if (clang::ObjCMethodDecl *method_decl = llvm::dyn_cast<clang::ObjCMethodDecl>(decl_context))
Sean Callanan744756e2011-11-04 02:09:33 +0000173 {
Sean Callanand5c17ed2011-11-15 02:11:17 +0000174 if (m_allow_objc)
Sean Callanan9bc83842011-09-26 18:45:31 +0000175 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000176 if (m_enforce_valid_object)
Sean Callanan744756e2011-11-04 02:09:33 +0000177 {
Sean Callanand5cc1322011-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 Callanan744756e2011-11-04 02:09:33 +0000199 }
200
Sean Callanan72e49402011-08-05 23:43:37 +0000201 m_objectivec = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000202 m_needs_object_ptr = true;
Sean Callanand5c17ed2011-11-15 02:11:17 +0000203
204 if (!method_decl->isInstanceMethod())
205 m_static_method = true;
Sean Callanan9bc83842011-09-26 18:45:31 +0000206 }
Sean Callanan3670ba52010-12-01 21:35:54 +0000207 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000208}
209
Sean Callanancf5498f2010-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 Callanan64186e72010-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 Callanancf5498f2010-10-22 23:25:16 +0000249bool
Sean Callananf7c3e272010-11-19 02:52:21 +0000250ClangUserExpression::Parse (Stream &error_stream,
251 ExecutionContext &exe_ctx,
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000252 lldb_private::ExecutionPolicy execution_policy,
Sean Callanan63697e52011-05-07 01:06:41 +0000253 bool keep_result_in_memory)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000254{
Greg Clayton2d4edfb2010-11-06 01:53:30 +0000255 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000256
Sean Callanan744756e2011-11-04 02:09:33 +0000257 Error err;
258
259 ScanContext(exe_ctx, err);
260
261 if (!err.Success())
262 {
263 error_stream.Printf("warning: %s\n", err.AsCString());
264 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000265
266 StreamString m_transformed_stream;
267
268 ////////////////////////////////////
269 // Generate the expression
270 //
Sean Callanancf5498f2010-10-22 23:25:16 +0000271
272 ApplyObjcCastHack(m_expr_text);
Greg Clayton73b472d2010-10-27 03:32:59 +0000273 //ApplyUnicharHack(m_expr_text);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000274
Sean Callanan9bc83842011-09-26 18:45:31 +0000275 std::auto_ptr <ExpressionSourceCode> source_code (ExpressionSourceCode::CreateWrapped(m_expr_prefix.c_str(), m_expr_text.c_str()));
276
277 lldb::LanguageType lang_type;
278
Sean Callananfc55f5d2010-09-21 00:44:12 +0000279 if (m_cplusplus)
Sean Callanan9bc83842011-09-26 18:45:31 +0000280 lang_type = lldb::eLanguageTypeC_plus_plus;
281 else if(m_objectivec)
282 lang_type = lldb::eLanguageTypeObjC;
Sean Callananfc55f5d2010-09-21 00:44:12 +0000283 else
Sean Callanan9bc83842011-09-26 18:45:31 +0000284 lang_type = lldb::eLanguageTypeC;
285
Sean Callanand5c17ed2011-11-15 02:11:17 +0000286 if (!source_code->GetText(m_transformed_text, lang_type, m_const_object, m_static_method))
Sean Callananfc55f5d2010-09-21 00:44:12 +0000287 {
Sean Callanan9bc83842011-09-26 18:45:31 +0000288 error_stream.PutCString ("error: couldn't construct expression body");
289 return false;
Sean Callananfc55f5d2010-09-21 00:44:12 +0000290 }
291
Sean Callananfc55f5d2010-09-21 00:44:12 +0000292 if (log)
293 log->Printf("Parsing the following code:\n%s", m_transformed_text.c_str());
294
Sean Callanan1a8d4092010-08-27 01:01:44 +0000295 ////////////////////////////////////
296 // Set up the target and compiler
297 //
298
Greg Claytonc14ee322011-09-22 04:58:26 +0000299 Target *target = exe_ctx.GetTargetPtr();
Sean Callanan1a8d4092010-08-27 01:01:44 +0000300
301 if (!target)
302 {
303 error_stream.PutCString ("error: invalid target\n");
304 return false;
305 }
306
Sean Callanan1a8d4092010-08-27 01:01:44 +0000307 //////////////////////////
308 // Parse the expression
309 //
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000310
Sean Callanan1ee44b72011-10-29 01:58:46 +0000311 m_expr_decl_map.reset(new ClangExpressionDeclMap(keep_result_in_memory, exe_ctx));
Sean Callanan979f74d2010-12-03 01:38:59 +0000312
Sean Callananb9951192011-08-01 18:18:33 +0000313 if (!m_expr_decl_map->WillParse(exe_ctx))
314 {
315 error_stream.PutCString ("error: current process state is unsuitable for expression parsing\n");
316 return false;
317 }
Sean Callanan1a8d4092010-08-27 01:01:44 +0000318
Greg Claytonc14ee322011-09-22 04:58:26 +0000319 Process *process = exe_ctx.GetProcessPtr();
Sean Callananaa719af2012-02-08 18:43:35 +0000320 ExecutionContextScope *exe_scope = process;
321
322 if (!exe_scope)
323 exe_scope = exe_ctx.GetTargetPtr();
324
325 ClangExpressionParser parser(exe_scope, *this);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000326
327 unsigned num_errors = parser.Parse (error_stream);
328
329 if (num_errors)
330 {
331 error_stream.Printf ("error: %d errors parsing expression\n", num_errors);
Sean Callanan979f74d2010-12-03 01:38:59 +0000332
333 m_expr_decl_map->DidParse();
334
Sean Callanan1a8d4092010-08-27 01:01:44 +0000335 return false;
336 }
337
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000338 //////////////////////////////////////////////////////////////////////////////////////////
339 // Prepare the output of the parser for execution, evaluating it statically if possible
Sean Callanan1a8d4092010-08-27 01:01:44 +0000340 //
Sean Callanan1a8d4092010-08-27 01:01:44 +0000341
Greg Claytonc14ee322011-09-22 04:58:26 +0000342 if (execution_policy != eExecutionPolicyNever && process)
343 m_data_allocator.reset(new ProcessDataAllocator(*process));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000344
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000345 Error jit_error = parser.PrepareForExecution (m_jit_alloc,
346 m_jit_start_addr,
347 m_jit_end_addr,
348 exe_ctx,
349 m_data_allocator.get(),
350 m_evaluated_statically,
351 m_const_result,
352 execution_policy);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000353
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000354 if (log && m_data_allocator.get())
Sean Callanan79763a42011-05-23 21:40:23 +0000355 {
356 StreamString dump_string;
357 m_data_allocator->Dump(dump_string);
358
359 log->Printf("Data buffer contents:\n%s", dump_string.GetString().c_str());
360 }
Sean Callanane3aef1d2011-10-12 22:20:02 +0000361
Sean Callanan1a8d4092010-08-27 01:01:44 +0000362 if (jit_error.Success())
363 {
Greg Claytonc14ee322011-09-22 04:58:26 +0000364 if (process && m_jit_alloc != LLDB_INVALID_ADDRESS)
Greg Claytone1cd1be2012-01-29 20:56:30 +0000365 m_jit_process_sp = process->shared_from_this();
Sean Callanan1a8d4092010-08-27 01:01:44 +0000366 return true;
367 }
368 else
369 {
Greg Claytone6a9e432011-05-17 03:51:29 +0000370 const char *error_cstr = jit_error.AsCString();
371 if (error_cstr && error_cstr[0])
372 error_stream.Printf ("error: %s\n", error_cstr);
373 else
Jason Molendafd54b362011-09-20 21:44:10 +0000374 error_stream.Printf ("error: expression can't be interpreted or run\n");
Sean Callanan1a8d4092010-08-27 01:01:44 +0000375 return false;
376 }
377}
378
379bool
Jim Ingham36f3b362010-10-14 23:45:03 +0000380ClangUserExpression::PrepareToExecuteJITExpression (Stream &error_stream,
Sean Callanan104a6e92010-10-19 23:57:21 +0000381 ExecutionContext &exe_ctx,
382 lldb::addr_t &struct_address,
Sean Callanan9d48e802010-12-14 00:42:36 +0000383 lldb::addr_t &object_ptr,
384 lldb::addr_t &cmd_ptr)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000385{
Greg Clayton2d4edfb2010-11-06 01:53:30 +0000386 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
Sean Callanan1a8d4092010-08-27 01:01:44 +0000387
Greg Clayton22a939a2011-01-19 23:00:49 +0000388 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000389 {
Sean Callanan1a8d4092010-08-27 01:01:44 +0000390 Error materialize_error;
391
Sean Callanan17827832010-12-13 22:46:15 +0000392 if (m_needs_object_ptr)
Sean Callananfc55f5d2010-09-21 00:44:12 +0000393 {
Sean Callanan17827832010-12-13 22:46:15 +0000394 ConstString object_name;
395
396 if (m_cplusplus)
397 {
398 object_name.SetCString("this");
399 }
400 else if (m_objectivec)
401 {
402 object_name.SetCString("self");
403 }
404 else
405 {
406 error_stream.Printf("Need object pointer but don't know the language\n");
407 return false;
408 }
409
410 if (!(m_expr_decl_map->GetObjectPointer(object_ptr, object_name, exe_ctx, materialize_error)))
411 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000412 error_stream.Printf("warning: couldn't get required object pointer (substituting NULL): %s\n", materialize_error.AsCString());
413 object_ptr = 0;
Sean Callanan17827832010-12-13 22:46:15 +0000414 }
Sean Callanan9d48e802010-12-14 00:42:36 +0000415
416 if (m_objectivec)
417 {
418 ConstString cmd_name("_cmd");
419
420 if (!(m_expr_decl_map->GetObjectPointer(cmd_ptr, cmd_name, exe_ctx, materialize_error, true)))
421 {
Sean Callanand5cc1322011-12-13 01:42:04 +0000422 error_stream.Printf("warning: couldn't get object pointer (substituting NULL): %s\n", materialize_error.AsCString());
423 cmd_ptr = 0;
Sean Callanan9d48e802010-12-14 00:42:36 +0000424 }
425 }
Sean Callananfc55f5d2010-09-21 00:44:12 +0000426 }
427
Sean Callanan979f74d2010-12-03 01:38:59 +0000428 if (!m_expr_decl_map->Materialize(exe_ctx, struct_address, materialize_error))
Sean Callanan1a8d4092010-08-27 01:01:44 +0000429 {
Sean Callananfc55f5d2010-09-21 00:44:12 +0000430 error_stream.Printf("Couldn't materialize struct: %s\n", materialize_error.AsCString());
Sean Callanan1a8d4092010-08-27 01:01:44 +0000431 return false;
432 }
Greg Claytonc4e411f2011-01-18 19:36:39 +0000433
434#if 0
435 // jingham: look here
436 StreamFile logfile ("/tmp/exprs.txt", "a");
Greg Clayton22a939a2011-01-19 23:00:49 +0000437 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 +0000438#endif
Sean Callanan1a8d4092010-08-27 01:01:44 +0000439
440 if (log)
441 {
Sean Callanana162eba2010-12-07 22:55:01 +0000442 log->Printf("-- [ClangUserExpression::PrepareToExecuteJITExpression] Materializing for execution --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000443
Greg Clayton22a939a2011-01-19 23:00:49 +0000444 log->Printf(" Function address : 0x%llx", (uint64_t)m_jit_start_addr);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000445
446 if (m_needs_object_ptr)
Sean Callananc673a6e2010-12-07 10:00:20 +0000447 log->Printf(" Object pointer : 0x%llx", (uint64_t)object_ptr);
Sean Callananfc55f5d2010-09-21 00:44:12 +0000448
Sean Callananc673a6e2010-12-07 10:00:20 +0000449 log->Printf(" Structure address : 0x%llx", (uint64_t)struct_address);
Sean Callanan1a8d4092010-08-27 01:01:44 +0000450
451 StreamString args;
452
453 Error dump_error;
454
Sean Callanan9e6ed532010-09-13 21:34:21 +0000455 if (struct_address)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000456 {
Sean Callanan979f74d2010-12-03 01:38:59 +0000457 if (!m_expr_decl_map->DumpMaterializedStruct(exe_ctx, args, dump_error))
Sean Callanan9e6ed532010-09-13 21:34:21 +0000458 {
Sean Callananc673a6e2010-12-07 10:00:20 +0000459 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
Sean Callanan9e6ed532010-09-13 21:34:21 +0000460 }
461 else
462 {
Sean Callananc673a6e2010-12-07 10:00:20 +0000463 log->Printf(" Structure contents:\n%s", args.GetData());
Sean Callanan9e6ed532010-09-13 21:34:21 +0000464 }
Sean Callanan1a8d4092010-08-27 01:01:44 +0000465 }
466 }
Jim Ingham36f3b362010-10-14 23:45:03 +0000467 }
468 return true;
469}
470
471ThreadPlan *
472ClangUserExpression::GetThreadPlanToExecuteJITExpression (Stream &error_stream,
Sean Callanan92adcac2011-01-13 08:53:35 +0000473 ExecutionContext &exe_ctx)
Jim Ingham36f3b362010-10-14 23:45:03 +0000474{
475 lldb::addr_t struct_address;
476
Johnny Chen44805302011-07-19 19:48:13 +0000477 lldb::addr_t object_ptr = 0;
478 lldb::addr_t cmd_ptr = 0;
Jim Ingham36f3b362010-10-14 23:45:03 +0000479
Sean Callanan9d48e802010-12-14 00:42:36 +0000480 PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr);
Jim Ingham36f3b362010-10-14 23:45:03 +0000481
Jim Inghamf48169b2010-11-30 02:22:11 +0000482 // FIXME: This should really return a ThreadPlanCallUserExpression, in order to make sure that we don't release the
483 // ClangUserExpression resources before the thread plan finishes execution in the target. But because we are
Sean Callanan17827832010-12-13 22:46:15 +0000484 // forcing unwind_on_error to be true here, in practical terms that can't happen.
485
Jim Ingham36f3b362010-10-14 23:45:03 +0000486 return ClangFunction::GetThreadPlanToCallFunction (exe_ctx,
Greg Clayton22a939a2011-01-19 23:00:49 +0000487 m_jit_start_addr,
Sean Callanan1d47caf2010-12-01 01:28:23 +0000488 struct_address,
489 error_stream,
490 true,
491 true,
Sean Callanan17827832010-12-13 22:46:15 +0000492 (m_needs_object_ptr ? &object_ptr : NULL),
493 (m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL);
Jim Ingham36f3b362010-10-14 23:45:03 +0000494}
495
496bool
497ClangUserExpression::FinalizeJITExecution (Stream &error_stream,
498 ExecutionContext &exe_ctx,
Sean Callanane359d9b2011-05-09 22:04:36 +0000499 lldb::ClangExpressionVariableSP &result,
500 lldb::addr_t function_stack_pointer)
Jim Ingham36f3b362010-10-14 23:45:03 +0000501{
502 Error expr_error;
503
Sean Callananc673a6e2010-12-07 10:00:20 +0000504 lldb::LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
505
506 if (log)
507 {
Sean Callanana162eba2010-12-07 22:55:01 +0000508 log->Printf("-- [ClangUserExpression::FinalizeJITExecution] Dematerializing after execution --");
Sean Callananc673a6e2010-12-07 10:00:20 +0000509
510 StreamString args;
511
512 Error dump_error;
513
514 if (!m_expr_decl_map->DumpMaterializedStruct(exe_ctx, args, dump_error))
515 {
516 log->Printf(" Couldn't extract variable values : %s", dump_error.AsCString("unknown error"));
517 }
518 else
519 {
520 log->Printf(" Structure contents:\n%s", args.GetData());
521 }
522 }
Sean Callanane359d9b2011-05-09 22:04:36 +0000523
524 lldb::addr_t function_stack_bottom = function_stack_pointer - Host::GetPageSize();
525
Sean Callananc673a6e2010-12-07 10:00:20 +0000526
Sean Callanane359d9b2011-05-09 22:04:36 +0000527 if (!m_expr_decl_map->Dematerialize(exe_ctx, result, function_stack_pointer, function_stack_bottom, expr_error))
Jim Ingham36f3b362010-10-14 23:45:03 +0000528 {
529 error_stream.Printf ("Couldn't dematerialize struct : %s\n", expr_error.AsCString("unknown error"));
530 return false;
531 }
Sean Callanane3aef1d2011-10-12 22:20:02 +0000532
Johnny Chenb49440f2012-01-06 00:35:38 +0000533 if (result)
534 result->TransferAddress();
535
Jim Ingham36f3b362010-10-14 23:45:03 +0000536 return true;
537}
538
Greg Claytone0d378b2011-03-24 21:19:54 +0000539ExecutionResults
Jim Ingham36f3b362010-10-14 23:45:03 +0000540ClangUserExpression::Execute (Stream &error_stream,
541 ExecutionContext &exe_ctx,
Jim Ingham399f1ca2010-11-05 19:25:48 +0000542 bool discard_on_error,
Jim Inghamf48169b2010-11-30 02:22:11 +0000543 ClangUserExpression::ClangUserExpressionSP &shared_ptr_to_me,
Greg Clayton8b2fe6d2010-12-14 02:59:59 +0000544 lldb::ClangExpressionVariableSP &result)
Jim Ingham36f3b362010-10-14 23:45:03 +0000545{
Jim Inghamb086ff72011-01-18 22:20:08 +0000546 // The expression log is quite verbose, and if you're just tracking the execution of the
547 // expression, it's quite convenient to have these logs come out with the STEP log as well.
548 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callananc673a6e2010-12-07 10:00:20 +0000549
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000550 if (m_jit_start_addr != LLDB_INVALID_ADDRESS)
Jim Ingham36f3b362010-10-14 23:45:03 +0000551 {
552 lldb::addr_t struct_address;
553
Johnny Chen44805302011-07-19 19:48:13 +0000554 lldb::addr_t object_ptr = 0;
555 lldb::addr_t cmd_ptr = 0;
Jim Ingham36f3b362010-10-14 23:45:03 +0000556
Sean Callanan9d48e802010-12-14 00:42:36 +0000557 if (!PrepareToExecuteJITExpression (error_stream, exe_ctx, struct_address, object_ptr, cmd_ptr))
Greg Claytone0d378b2011-03-24 21:19:54 +0000558 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000559
Jim Ingham399f1ca2010-11-05 19:25:48 +0000560 const bool stop_others = true;
561 const bool try_all_threads = true;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000562
Greg Clayton22a939a2011-01-19 23:00:49 +0000563 Address wrapper_address (NULL, m_jit_start_addr);
Greg Claytonc14ee322011-09-22 04:58:26 +0000564 lldb::ThreadPlanSP call_plan_sp(new ThreadPlanCallUserExpression (exe_ctx.GetThreadRef(),
Sean Callanan17827832010-12-13 22:46:15 +0000565 wrapper_address,
566 struct_address,
567 stop_others,
568 discard_on_error,
569 (m_needs_object_ptr ? &object_ptr : NULL),
570 ((m_needs_object_ptr && m_objectivec) ? &cmd_ptr : NULL),
571 shared_ptr_to_me));
572
Jim Inghamf48169b2010-11-30 02:22:11 +0000573 if (call_plan_sp == NULL || !call_plan_sp->ValidatePlan (NULL))
Greg Claytone0d378b2011-03-24 21:19:54 +0000574 return eExecutionSetupError;
Sean Callanane359d9b2011-05-09 22:04:36 +0000575
576 lldb::addr_t function_stack_pointer = static_cast<ThreadPlanCallFunction *>(call_plan_sp.get())->GetFunctionStackPointer();
Jim Inghamf48169b2010-11-30 02:22:11 +0000577
Jim Ingham17e5c4e2011-05-17 22:24:54 +0000578 call_plan_sp->SetPrivate(true);
Jim Inghamf48169b2010-11-30 02:22:11 +0000579
Greg Claytone2d4f0d2011-01-19 07:54:15 +0000580 uint32_t single_thread_timeout_usec = 500000;
Sean Callananc673a6e2010-12-07 10:00:20 +0000581
582 if (log)
Sean Callanana162eba2010-12-07 22:55:01 +0000583 log->Printf("-- [ClangUserExpression::Execute] Execution of expression begins --");
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(true);
587
Greg Claytonc14ee322011-09-22 04:58:26 +0000588 ExecutionResults execution_result = exe_ctx.GetProcessRef().RunThreadPlan (exe_ctx,
589 call_plan_sp,
590 stop_others,
591 try_all_threads,
592 discard_on_error,
593 single_thread_timeout_usec,
594 error_stream);
Sean Callananc673a6e2010-12-07 10:00:20 +0000595
Jim Ingham0faa43f2011-11-08 03:00:11 +0000596 if (exe_ctx.GetProcessPtr())
597 exe_ctx.GetProcessPtr()->SetRunningUserExpression(false);
598
Sean Callananc673a6e2010-12-07 10:00:20 +0000599 if (log)
Sean Callanana162eba2010-12-07 22:55:01 +0000600 log->Printf("-- [ClangUserExpression::Execute] Execution of expression completed --");
Jim Inghamf48169b2010-11-30 02:22:11 +0000601
Greg Claytone0d378b2011-03-24 21:19:54 +0000602 if (execution_result == eExecutionInterrupted)
Sean Callanan1a8d4092010-08-27 01:01:44 +0000603 {
Jim Ingham160f78c2011-05-17 01:10:11 +0000604 const char *error_desc = NULL;
605
606 if (call_plan_sp)
607 {
608 lldb::StopInfoSP real_stop_info_sp = call_plan_sp->GetRealStopInfo();
609 if (real_stop_info_sp)
610 error_desc = real_stop_info_sp->GetDescription();
611 }
612 if (error_desc)
613 error_stream.Printf ("Execution was interrupted, reason: %s.", error_desc);
Jim Inghamf48169b2010-11-30 02:22:11 +0000614 else
Jason Molendafd54b362011-09-20 21:44:10 +0000615 error_stream.Printf ("Execution was interrupted.");
Jim Ingham160f78c2011-05-17 01:10:11 +0000616
617 if (discard_on_error)
618 error_stream.Printf ("\nThe process has been returned to the state before execution.");
619 else
620 error_stream.Printf ("\nThe process has been left at the point where it was interrupted.");
Jim Inghamf48169b2010-11-30 02:22:11 +0000621
622 return execution_result;
623 }
Greg Claytone0d378b2011-03-24 21:19:54 +0000624 else if (execution_result != eExecutionCompleted)
Jim Inghamf48169b2010-11-30 02:22:11 +0000625 {
626 error_stream.Printf ("Couldn't execute function; result was %s\n", Process::ExecutionResultAsCString (execution_result));
627 return execution_result;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000628 }
629
Sean Callanane359d9b2011-05-09 22:04:36 +0000630 if (FinalizeJITExecution (error_stream, exe_ctx, result, function_stack_pointer))
Greg Claytone0d378b2011-03-24 21:19:54 +0000631 return eExecutionCompleted;
Jim Inghamf48169b2010-11-30 02:22:11 +0000632 else
Greg Claytone0d378b2011-03-24 21:19:54 +0000633 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000634 }
635 else
636 {
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000637 error_stream.Printf("Expression can't be run, because there is no JIT compiled function");
Greg Claytone0d378b2011-03-24 21:19:54 +0000638 return eExecutionSetupError;
Sean Callanan1a8d4092010-08-27 01:01:44 +0000639 }
640}
641
Greg Claytone0d378b2011-03-24 21:19:54 +0000642ExecutionResults
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000643ClangUserExpression::Evaluate (ExecutionContext &exe_ctx,
644 lldb_private::ExecutionPolicy execution_policy,
Sean Callananc7b65062011-11-07 23:35:40 +0000645 lldb::LanguageType language,
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000646 ResultType desired_type,
Jim Ingham399f1ca2010-11-05 19:25:48 +0000647 bool discard_on_error,
Sean Callanan322f5292010-10-29 00:29:03 +0000648 const char *expr_cstr,
Jim Inghamf48169b2010-11-30 02:22:11 +0000649 const char *expr_prefix,
650 lldb::ValueObjectSP &result_valobj_sp)
Greg Clayton0184f012010-10-05 00:31:29 +0000651{
Jim Ingham41c75912011-08-09 00:00:49 +0000652 Error error;
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000653 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 +0000654}
655
656ExecutionResults
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000657ClangUserExpression::EvaluateWithError (ExecutionContext &exe_ctx,
658 lldb_private::ExecutionPolicy execution_policy,
Sean Callananc7b65062011-11-07 23:35:40 +0000659 lldb::LanguageType language,
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000660 ResultType desired_type,
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000661 bool discard_on_error,
662 const char *expr_cstr,
663 const char *expr_prefix,
664 lldb::ValueObjectSP &result_valobj_sp,
665 Error &error)
Jim Ingham41c75912011-08-09 00:00:49 +0000666{
Jim Inghamb086ff72011-01-18 22:20:08 +0000667 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_EXPRESSIONS | LIBLLDB_LOG_STEP));
Sean Callanana162eba2010-12-07 22:55:01 +0000668
Greg Claytone0d378b2011-03-24 21:19:54 +0000669 ExecutionResults execution_results = eExecutionSetupError;
Greg Clayton8f343b02010-11-04 01:54:29 +0000670
Greg Claytonc14ee322011-09-22 04:58:26 +0000671 Process *process = exe_ctx.GetProcessPtr();
672
673 if (process == NULL || process->GetState() != lldb::eStateStopped)
Jim Inghamf48169b2010-11-30 02:22:11 +0000674 {
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000675 if (execution_policy == eExecutionPolicyAlways)
676 {
677 if (log)
678 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
Jim Inghamf48169b2010-11-30 02:22:11 +0000679
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000680 error.SetErrorString ("expression needed to run but couldn't");
681
682 return execution_results;
683 }
Jim Inghamf48169b2010-11-30 02:22:11 +0000684 }
Sean Callanan64fe1992011-09-15 17:43:00 +0000685
Greg Claytonc14ee322011-09-22 04:58:26 +0000686 if (process == NULL || !process->CanJIT())
Sean Callanan64fe1992011-09-15 17:43:00 +0000687 execution_policy = eExecutionPolicyNever;
Greg Clayton8f343b02010-11-04 01:54:29 +0000688
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000689 ClangUserExpressionSP user_expression_sp (new ClangUserExpression (expr_cstr, expr_prefix, language, desired_type));
Jim Inghamf48169b2010-11-30 02:22:11 +0000690
Greg Clayton0184f012010-10-05 00:31:29 +0000691 StreamString error_stream;
Sean Callanan63697e52011-05-07 01:06:41 +0000692
Sean Callanana162eba2010-12-07 22:55:01 +0000693 if (log)
694 log->Printf("== [ClangUserExpression::Evaluate] Parsing expression %s ==", expr_cstr);
695
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000696 const bool keep_expression_in_memory = true;
697
Sean Callanan20bb3aa2011-12-21 22:22:58 +0000698 if (!user_expression_sp->Parse (error_stream, exe_ctx, execution_policy, keep_expression_in_memory))
Greg Clayton0184f012010-10-05 00:31:29 +0000699 {
700 if (error_stream.GetString().empty())
701 error.SetErrorString ("expression failed to parse, unknown error");
702 else
703 error.SetErrorString (error_stream.GetString().c_str());
704 }
705 else
706 {
Greg Clayton8b2fe6d2010-12-14 02:59:59 +0000707 lldb::ClangExpressionVariableSP expr_result;
Greg Clayton0184f012010-10-05 00:31:29 +0000708
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000709 if (user_expression_sp->EvaluatedStatically())
Greg Clayton0184f012010-10-05 00:31:29 +0000710 {
Sean Callanana162eba2010-12-07 22:55:01 +0000711 if (log)
Sean Callanane4ec90e2010-12-16 03:17:46 +0000712 log->Printf("== [ClangUserExpression::Evaluate] Expression evaluated as a constant ==");
Sean Callanana162eba2010-12-07 22:55:01 +0000713
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000714 if (user_expression_sp->m_const_result)
715 result_valobj_sp = user_expression_sp->m_const_result->GetValueObject();
716 else
717 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
718
Jim Ingham41c75912011-08-09 00:00:49 +0000719 execution_results = eExecutionCompleted;
Greg Clayton0184f012010-10-05 00:31:29 +0000720 }
Sean Callanan3bfdaa22011-09-15 02:13:07 +0000721 else if (execution_policy == eExecutionPolicyNever)
722 {
723 if (log)
724 log->Printf("== [ClangUserExpression::Evaluate] Expression may not run, but is not constant ==");
725
726 if (error_stream.GetString().empty())
727 error.SetErrorString ("expression needed to run but couldn't");
728 }
Sean Callanane4ec90e2010-12-16 03:17:46 +0000729 else
730 {
731 error_stream.GetString().clear();
732
733 if (log)
734 log->Printf("== [ClangUserExpression::Evaluate] Executing expression ==");
735
736 execution_results = user_expression_sp->Execute (error_stream,
737 exe_ctx,
Sean Callanan92adcac2011-01-13 08:53:35 +0000738 discard_on_error,
Sean Callanane4ec90e2010-12-16 03:17:46 +0000739 user_expression_sp,
740 expr_result);
741
Greg Claytone0d378b2011-03-24 21:19:54 +0000742 if (execution_results != eExecutionCompleted)
Greg Clayton0184f012010-10-05 00:31:29 +0000743 {
Sean Callanana162eba2010-12-07 22:55:01 +0000744 if (log)
Sean Callanane4ec90e2010-12-16 03:17:46 +0000745 log->Printf("== [ClangUserExpression::Evaluate] Execution completed abnormally ==");
746
747 if (error_stream.GetString().empty())
748 error.SetErrorString ("expression failed to execute, unknown error");
749 else
750 error.SetErrorString (error_stream.GetString().c_str());
Greg Clayton0184f012010-10-05 00:31:29 +0000751 }
Sean Callanane4ec90e2010-12-16 03:17:46 +0000752 else
Greg Clayton0184f012010-10-05 00:31:29 +0000753 {
Sean Callanane4ec90e2010-12-16 03:17:46 +0000754 if (expr_result)
755 {
756 result_valobj_sp = expr_result->GetValueObject();
757
758 if (log)
Jim Ingham6035b672011-03-31 00:19:25 +0000759 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with result %s ==", result_valobj_sp->GetValueAsCString());
Sean Callanane4ec90e2010-12-16 03:17:46 +0000760 }
761 else
762 {
763 if (log)
764 log->Printf("== [ClangUserExpression::Evaluate] Execution completed normally with no result ==");
765
Sean Callananbccce812011-08-23 21:20:51 +0000766 error.SetError(ClangUserExpression::kNoResult, lldb::eErrorTypeGeneric);
Sean Callanane4ec90e2010-12-16 03:17:46 +0000767 }
Greg Clayton0184f012010-10-05 00:31:29 +0000768 }
769 }
770 }
Sean Callananc57f64d2010-10-19 20:15:00 +0000771
Greg Claytonb71f3842010-10-05 03:13:51 +0000772 if (result_valobj_sp.get() == NULL)
Jim Ingham58b59f92011-04-22 23:53:53 +0000773 result_valobj_sp = ValueObjectConstResult::Create (NULL, error);
Greg Claytonb71f3842010-10-05 03:13:51 +0000774
Jim Inghamf48169b2010-11-30 02:22:11 +0000775 return execution_results;
Johnny Chendabefd02010-10-29 20:19:44 +0000776}