1 //===-- CommandObjectExpression.cpp -----------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "CommandObjectExpression.h" 11 12 // C Includes 13 // C++ Includes 14 // Other libraries and framework includes 15 // Project includes 16 #include "lldb/Interpreter/Args.h" 17 #include "lldb/Core/Value.h" 18 #include "lldb/Core/InputReader.h" 19 #include "lldb/Core/ValueObjectVariable.h" 20 #include "lldb/Expression/ClangExpressionVariable.h" 21 #include "lldb/Expression/ClangUserExpression.h" 22 #include "lldb/Expression/ClangFunction.h" 23 #include "lldb/Expression/DWARFExpression.h" 24 #include "lldb/Host/Host.h" 25 #include "lldb/Core/Debugger.h" 26 #include "lldb/Interpreter/CommandInterpreter.h" 27 #include "lldb/Interpreter/CommandReturnObject.h" 28 #include "lldb/Target/ObjCLanguageRuntime.h" 29 #include "lldb/Symbol/ObjectFile.h" 30 #include "lldb/Symbol/Variable.h" 31 #include "lldb/Target/Process.h" 32 #include "lldb/Target/StackFrame.h" 33 #include "lldb/Target/Target.h" 34 #include "lldb/Target/Thread.h" 35 #include "llvm/ADT/StringRef.h" 36 37 using namespace lldb; 38 using namespace lldb_private; 39 40 CommandObjectExpression::CommandOptions::CommandOptions (CommandInterpreter &interpreter) : 41 Options(interpreter) 42 { 43 // Keep only one place to reset the values to their defaults 44 OptionParsingStarting(); 45 } 46 47 48 CommandObjectExpression::CommandOptions::~CommandOptions () 49 { 50 } 51 52 Error 53 CommandObjectExpression::CommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg) 54 { 55 Error error; 56 57 char short_option = (char) m_getopt_table[option_idx].val; 58 59 switch (short_option) 60 { 61 //case 'l': 62 //if (language.SetLanguageFromCString (option_arg) == false) 63 //{ 64 // error.SetErrorStringWithFormat("Invalid language option argument '%s'.\n", option_arg); 65 //} 66 //break; 67 68 case 'g': 69 debug = true; 70 break; 71 72 case 'f': 73 error = Args::StringToFormat(option_arg, format, NULL); 74 break; 75 76 case 'o': 77 print_object = true; 78 break; 79 80 case 'd': 81 { 82 bool success; 83 bool result; 84 result = Args::StringToBoolean(option_arg, true, &success); 85 if (!success) 86 error.SetErrorStringWithFormat("Invalid dynamic value setting: \"%s\".\n", option_arg); 87 else 88 { 89 if (result) 90 use_dynamic = eLazyBoolYes; 91 else 92 use_dynamic = eLazyBoolNo; 93 } 94 } 95 break; 96 97 case 'u': 98 bool success; 99 unwind_on_error = Args::StringToBoolean(option_arg, true, &success); 100 if (!success) 101 error.SetErrorStringWithFormat("Could not convert \"%s\" to a boolean value.", option_arg); 102 break; 103 104 default: 105 error.SetErrorStringWithFormat("Invalid short option character '%c'.\n", short_option); 106 break; 107 } 108 109 return error; 110 } 111 112 void 113 CommandObjectExpression::CommandOptions::OptionParsingStarting () 114 { 115 //language.Clear(); 116 debug = false; 117 format = eFormatDefault; 118 print_object = false; 119 use_dynamic = eLazyBoolCalculate; 120 unwind_on_error = true; 121 show_types = true; 122 show_summary = true; 123 } 124 125 const OptionDefinition* 126 CommandObjectExpression::CommandOptions::GetDefinitions () 127 { 128 return g_option_table; 129 } 130 131 CommandObjectExpression::CommandObjectExpression (CommandInterpreter &interpreter) : 132 CommandObject (interpreter, 133 "expression", 134 "Evaluate a C/ObjC/C++ expression in the current program context, using variables currently in scope.", 135 NULL), 136 m_options (interpreter), 137 m_expr_line_count (0), 138 m_expr_lines () 139 { 140 SetHelpLong( 141 "Examples: \n\ 142 \n\ 143 expr my_struct->a = my_array[3] \n\ 144 expr -f bin -- (index * 8) + 5 \n\ 145 expr char c[] = \"foo\"; c[0]\n"); 146 147 CommandArgumentEntry arg; 148 CommandArgumentData expression_arg; 149 150 // Define the first (and only) variant of this arg. 151 expression_arg.arg_type = eArgTypeExpression; 152 expression_arg.arg_repetition = eArgRepeatPlain; 153 154 // There is only one variant this argument could be; put it into the argument entry. 155 arg.push_back (expression_arg); 156 157 // Push the data for the first argument into the m_arguments vector. 158 m_arguments.push_back (arg); 159 } 160 161 CommandObjectExpression::~CommandObjectExpression () 162 { 163 } 164 165 Options * 166 CommandObjectExpression::GetOptions () 167 { 168 return &m_options; 169 } 170 171 172 bool 173 CommandObjectExpression::Execute 174 ( 175 Args& command, 176 CommandReturnObject &result 177 ) 178 { 179 return false; 180 } 181 182 183 size_t 184 CommandObjectExpression::MultiLineExpressionCallback 185 ( 186 void *baton, 187 InputReader &reader, 188 lldb::InputReaderAction notification, 189 const char *bytes, 190 size_t bytes_len 191 ) 192 { 193 CommandObjectExpression *cmd_object_expr = (CommandObjectExpression *) baton; 194 195 switch (notification) 196 { 197 case eInputReaderActivate: 198 reader.GetDebugger().GetOutputStream().Printf("%s\n", "Enter expressions, then terminate with an empty line to evaluate:"); 199 // Fall through 200 case eInputReaderReactivate: 201 //if (out_fh) 202 // reader.GetDebugger().GetOutputStream().Printf ("%3u: ", cmd_object_expr->m_expr_line_count); 203 break; 204 205 case eInputReaderDeactivate: 206 break; 207 208 case eInputReaderGotToken: 209 ++cmd_object_expr->m_expr_line_count; 210 if (bytes && bytes_len) 211 { 212 cmd_object_expr->m_expr_lines.append (bytes, bytes_len + 1); 213 } 214 215 if (bytes_len == 0) 216 reader.SetIsDone(true); 217 //else if (out_fh && !reader->IsDone()) 218 // ::fprintf (out_fh, "%3u: ", cmd_object_expr->m_expr_line_count); 219 break; 220 221 case eInputReaderInterrupt: 222 cmd_object_expr->m_expr_lines.clear(); 223 reader.SetIsDone (true); 224 reader.GetDebugger().GetOutputStream().Printf("%s\n", "Expression evaluation cancelled."); 225 break; 226 227 case eInputReaderEndOfFile: 228 reader.SetIsDone (true); 229 break; 230 231 case eInputReaderDone: 232 if (cmd_object_expr->m_expr_lines.size() > 0) 233 { 234 cmd_object_expr->EvaluateExpression (cmd_object_expr->m_expr_lines.c_str(), 235 reader.GetDebugger().GetOutputStream(), 236 reader.GetDebugger().GetErrorStream()); 237 } 238 break; 239 } 240 241 return bytes_len; 242 } 243 244 bool 245 CommandObjectExpression::EvaluateExpression 246 ( 247 const char *expr, 248 Stream &output_stream, 249 Stream &error_stream, 250 CommandReturnObject *result 251 ) 252 { 253 if (m_exe_ctx.target) 254 { 255 lldb::ValueObjectSP result_valobj_sp; 256 257 ExecutionResults exe_results; 258 259 bool keep_in_memory = true; 260 bool use_dynamic; 261 // If use dynamic is not set, get it from the target: 262 switch (m_options.use_dynamic) 263 { 264 case eLazyBoolCalculate: 265 { 266 if (m_exe_ctx.target->GetPreferDynamicValue()) 267 use_dynamic = true; 268 else 269 use_dynamic = false; 270 } 271 break; 272 case eLazyBoolYes: 273 use_dynamic = true; 274 break; 275 case eLazyBoolNo: 276 use_dynamic = false; 277 break; 278 } 279 280 exe_results = m_exe_ctx.target->EvaluateExpression(expr, m_exe_ctx.frame, m_options.unwind_on_error, use_dynamic, keep_in_memory, result_valobj_sp); 281 282 if (exe_results == eExecutionInterrupted && !m_options.unwind_on_error) 283 { 284 uint32_t start_frame = 0; 285 uint32_t num_frames = 1; 286 uint32_t num_frames_with_source = 0; 287 if (m_exe_ctx.thread) 288 { 289 m_exe_ctx.thread->GetStatus (result->GetOutputStream(), 290 start_frame, 291 num_frames, 292 num_frames_with_source); 293 } 294 else if (m_exe_ctx.process) 295 { 296 bool only_threads_with_stop_reason = true; 297 m_exe_ctx.process->GetThreadStatus (result->GetOutputStream(), 298 only_threads_with_stop_reason, 299 start_frame, 300 num_frames, 301 num_frames_with_source); 302 } 303 } 304 305 if (result_valobj_sp) 306 { 307 if (result_valobj_sp->GetError().Success()) 308 { 309 if (m_options.format != eFormatDefault) 310 result_valobj_sp->SetFormat (m_options.format); 311 312 ValueObject::DumpValueObject (output_stream, 313 result_valobj_sp.get(), // Variable object to dump 314 result_valobj_sp->GetName().GetCString(),// Root object name 315 0, // Pointer depth to traverse (zero means stop at pointers) 316 0, // Current depth, this is the top most, so zero... 317 UINT32_MAX, // Max depth to go when dumping concrete types, dump everything... 318 m_options.show_types, // Show types when dumping? 319 false, // Show locations of variables, no since this is a host address which we don't care to see 320 m_options.print_object, // Print the objective C object? 321 use_dynamic, 322 true, // Scope is already checked. Const results are always in scope. 323 false); // Don't flatten output 324 if (result) 325 result->SetStatus (eReturnStatusSuccessFinishResult); 326 } 327 else 328 { 329 error_stream.PutCString(result_valobj_sp->GetError().AsCString()); 330 if (result) 331 result->SetStatus (eReturnStatusFailed); 332 } 333 } 334 } 335 else 336 { 337 error_stream.Printf ("error: invalid execution context for expression\n"); 338 return false; 339 } 340 341 return true; 342 } 343 344 bool 345 CommandObjectExpression::ExecuteRawCommandString 346 ( 347 const char *command, 348 CommandReturnObject &result 349 ) 350 { 351 m_exe_ctx = m_interpreter.GetExecutionContext(); 352 353 m_options.NotifyOptionParsingStarting(); 354 355 const char * expr = NULL; 356 357 if (command[0] == '\0') 358 { 359 m_expr_lines.clear(); 360 m_expr_line_count = 0; 361 362 InputReaderSP reader_sp (new InputReader(m_interpreter.GetDebugger())); 363 if (reader_sp) 364 { 365 Error err (reader_sp->Initialize (CommandObjectExpression::MultiLineExpressionCallback, 366 this, // baton 367 eInputReaderGranularityLine, // token size, to pass to callback function 368 NULL, // end token 369 NULL, // prompt 370 true)); // echo input 371 if (err.Success()) 372 { 373 m_interpreter.GetDebugger().PushInputReader (reader_sp); 374 result.SetStatus (eReturnStatusSuccessFinishNoResult); 375 } 376 else 377 { 378 result.AppendError (err.AsCString()); 379 result.SetStatus (eReturnStatusFailed); 380 } 381 } 382 else 383 { 384 result.AppendError("out of memory"); 385 result.SetStatus (eReturnStatusFailed); 386 } 387 return result.Succeeded(); 388 } 389 390 if (command[0] == '-') 391 { 392 // We have some options and these options MUST end with --. 393 const char *end_options = NULL; 394 const char *s = command; 395 while (s && s[0]) 396 { 397 end_options = ::strstr (s, "--"); 398 if (end_options) 399 { 400 end_options += 2; // Get past the "--" 401 if (::isspace (end_options[0])) 402 { 403 expr = end_options; 404 while (::isspace (*expr)) 405 ++expr; 406 break; 407 } 408 } 409 s = end_options; 410 } 411 412 if (end_options) 413 { 414 Args args (command, end_options - command); 415 if (!ParseOptions (args, result)) 416 return false; 417 418 Error error (m_options.NotifyOptionParsingFinished()); 419 if (error.Fail()) 420 { 421 result.AppendError (error.AsCString()); 422 result.SetStatus (eReturnStatusFailed); 423 return false; 424 } 425 } 426 } 427 428 if (expr == NULL) 429 expr = command; 430 431 if (EvaluateExpression (expr, result.GetOutputStream(), result.GetErrorStream(), &result)) 432 return true; 433 434 result.SetStatus (eReturnStatusFailed); 435 return false; 436 } 437 438 OptionDefinition 439 CommandObjectExpression::CommandOptions::g_option_table[] = 440 { 441 //{ LLDB_OPT_SET_ALL, false, "language", 'l', required_argument, NULL, 0, "[c|c++|objc|objc++]", "Sets the language to use when parsing the expression."}, 442 //{ LLDB_OPT_SET_1, false, "format", 'f', required_argument, NULL, 0, "[ [bool|b] | [bin] | [char|c] | [oct|o] | [dec|i|d|u] | [hex|x] | [float|f] | [cstr|s] ]", "Specify the format that the expression output should use."}, 443 { LLDB_OPT_SET_1, false, "format", 'f', required_argument, NULL, 0, eArgTypeExprFormat, "Specify the format that the expression output should use."}, 444 { LLDB_OPT_SET_2, false, "object-description", 'o', no_argument, NULL, 0, eArgTypeNone, "Print the object description of the value resulting from the expression."}, 445 { LLDB_OPT_SET_2, false, "dynamic-value", 'd', required_argument, NULL, 0, eArgTypeBoolean, "Upcast the value resulting from the expression to its dynamic type if available."}, 446 { LLDB_OPT_SET_ALL, false, "unwind-on-error", 'u', required_argument, NULL, 0, eArgTypeBoolean, "Clean up program state if the expression causes a crash, breakpoint hit or signal."}, 447 { LLDB_OPT_SET_ALL, false, "debug", 'g', no_argument, NULL, 0, eArgTypeNone, "Enable verbose debug logging of the expression parsing and evaluation."}, 448 { LLDB_OPT_SET_ALL, false, "use-ir", 'i', no_argument, NULL, 0, eArgTypeNone, "[Temporary] Instructs the expression evaluator to use IR instead of ASTs."}, 449 { 0, false, NULL, 0, 0, NULL, NULL, eArgTypeNone, NULL } 450 }; 451 452