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 bool batch_mode = reader.GetDebugger().GetCommandInterpreter().GetBatchCommandMode(); 195 196 switch (notification) 197 { 198 case eInputReaderActivate: 199 if (!batch_mode) 200 { 201 StreamSP out_stream = reader.GetDebugger().GetAsyncOutputStream(); 202 out_stream->Printf("%s\n", "Enter expressions, then terminate with an empty line to evaluate:"); 203 out_stream->Flush(); 204 } 205 // Fall through 206 case eInputReaderReactivate: 207 break; 208 209 case eInputReaderDeactivate: 210 break; 211 212 case eInputReaderAsynchronousOutputWritten: 213 break; 214 215 case eInputReaderGotToken: 216 ++cmd_object_expr->m_expr_line_count; 217 if (bytes && bytes_len) 218 { 219 cmd_object_expr->m_expr_lines.append (bytes, bytes_len + 1); 220 } 221 222 if (bytes_len == 0) 223 reader.SetIsDone(true); 224 break; 225 226 case eInputReaderInterrupt: 227 cmd_object_expr->m_expr_lines.clear(); 228 reader.SetIsDone (true); 229 if (!batch_mode) 230 { 231 StreamSP out_stream = reader.GetDebugger().GetAsyncOutputStream(); 232 out_stream->Printf("%s\n", "Expression evaluation cancelled."); 233 out_stream->Flush(); 234 } 235 break; 236 237 case eInputReaderEndOfFile: 238 reader.SetIsDone (true); 239 break; 240 241 case eInputReaderDone: 242 if (cmd_object_expr->m_expr_lines.size() > 0) 243 { 244 StreamSP output_stream = reader.GetDebugger().GetAsyncOutputStream(); 245 StreamSP error_stream = reader.GetDebugger().GetAsyncErrorStream(); 246 cmd_object_expr->EvaluateExpression (cmd_object_expr->m_expr_lines.c_str(), 247 output_stream.get(), 248 error_stream.get()); 249 output_stream->Flush(); 250 error_stream->Flush(); 251 } 252 break; 253 } 254 255 return bytes_len; 256 } 257 258 bool 259 CommandObjectExpression::EvaluateExpression 260 ( 261 const char *expr, 262 Stream *output_stream, 263 Stream *error_stream, 264 CommandReturnObject *result 265 ) 266 { 267 if (m_exe_ctx.target) 268 { 269 lldb::ValueObjectSP result_valobj_sp; 270 271 ExecutionResults exe_results; 272 273 bool keep_in_memory = true; 274 lldb::DynamicValueType use_dynamic; 275 // If use dynamic is not set, get it from the target: 276 switch (m_options.use_dynamic) 277 { 278 case eLazyBoolCalculate: 279 use_dynamic = m_exe_ctx.target->GetPreferDynamicValue(); 280 break; 281 case eLazyBoolYes: 282 use_dynamic = lldb::eDynamicCanRunTarget; 283 break; 284 case eLazyBoolNo: 285 use_dynamic = lldb::eNoDynamicValues; 286 break; 287 } 288 289 exe_results = m_exe_ctx.target->EvaluateExpression(expr, m_exe_ctx.frame, m_options.unwind_on_error, keep_in_memory, use_dynamic, result_valobj_sp); 290 291 if (exe_results == eExecutionInterrupted && !m_options.unwind_on_error) 292 { 293 uint32_t start_frame = 0; 294 uint32_t num_frames = 1; 295 uint32_t num_frames_with_source = 0; 296 if (m_exe_ctx.thread) 297 { 298 m_exe_ctx.thread->GetStatus (result->GetOutputStream(), 299 start_frame, 300 num_frames, 301 num_frames_with_source); 302 } 303 else if (m_exe_ctx.process) 304 { 305 bool only_threads_with_stop_reason = true; 306 m_exe_ctx.process->GetThreadStatus (result->GetOutputStream(), 307 only_threads_with_stop_reason, 308 start_frame, 309 num_frames, 310 num_frames_with_source); 311 } 312 } 313 314 if (result_valobj_sp) 315 { 316 if (result_valobj_sp->GetError().Success()) 317 { 318 if (m_options.format != eFormatDefault) 319 result_valobj_sp->SetFormat (m_options.format); 320 321 ValueObject::DumpValueObject (*(output_stream), 322 result_valobj_sp.get(), // Variable object to dump 323 result_valobj_sp->GetName().GetCString(),// Root object name 324 0, // Pointer depth to traverse (zero means stop at pointers) 325 0, // Current depth, this is the top most, so zero... 326 UINT32_MAX, // Max depth to go when dumping concrete types, dump everything... 327 m_options.show_types, // Show types when dumping? 328 false, // Show locations of variables, no since this is a host address which we don't care to see 329 m_options.print_object, // Print the objective C object? 330 use_dynamic, 331 true, // Scope is already checked. Const results are always in scope. 332 false); // Don't flatten output 333 if (result) 334 result->SetStatus (eReturnStatusSuccessFinishResult); 335 } 336 else 337 { 338 error_stream->PutCString(result_valobj_sp->GetError().AsCString()); 339 if (result) 340 result->SetStatus (eReturnStatusFailed); 341 } 342 } 343 } 344 else 345 { 346 error_stream->Printf ("error: invalid execution context for expression\n"); 347 return false; 348 } 349 350 return true; 351 } 352 353 bool 354 CommandObjectExpression::ExecuteRawCommandString 355 ( 356 const char *command, 357 CommandReturnObject &result 358 ) 359 { 360 m_exe_ctx = m_interpreter.GetExecutionContext(); 361 362 m_options.NotifyOptionParsingStarting(); 363 364 const char * expr = NULL; 365 366 if (command[0] == '\0') 367 { 368 m_expr_lines.clear(); 369 m_expr_line_count = 0; 370 371 InputReaderSP reader_sp (new InputReader(m_interpreter.GetDebugger())); 372 if (reader_sp) 373 { 374 Error err (reader_sp->Initialize (CommandObjectExpression::MultiLineExpressionCallback, 375 this, // baton 376 eInputReaderGranularityLine, // token size, to pass to callback function 377 NULL, // end token 378 NULL, // prompt 379 true)); // echo input 380 if (err.Success()) 381 { 382 m_interpreter.GetDebugger().PushInputReader (reader_sp); 383 result.SetStatus (eReturnStatusSuccessFinishNoResult); 384 } 385 else 386 { 387 result.AppendError (err.AsCString()); 388 result.SetStatus (eReturnStatusFailed); 389 } 390 } 391 else 392 { 393 result.AppendError("out of memory"); 394 result.SetStatus (eReturnStatusFailed); 395 } 396 return result.Succeeded(); 397 } 398 399 if (command[0] == '-') 400 { 401 // We have some options and these options MUST end with --. 402 const char *end_options = NULL; 403 const char *s = command; 404 while (s && s[0]) 405 { 406 end_options = ::strstr (s, "--"); 407 if (end_options) 408 { 409 end_options += 2; // Get past the "--" 410 if (::isspace (end_options[0])) 411 { 412 expr = end_options; 413 while (::isspace (*expr)) 414 ++expr; 415 break; 416 } 417 } 418 s = end_options; 419 } 420 421 if (end_options) 422 { 423 Args args (command, end_options - command); 424 if (!ParseOptions (args, result)) 425 return false; 426 427 Error error (m_options.NotifyOptionParsingFinished()); 428 if (error.Fail()) 429 { 430 result.AppendError (error.AsCString()); 431 result.SetStatus (eReturnStatusFailed); 432 return false; 433 } 434 } 435 } 436 437 if (expr == NULL) 438 expr = command; 439 440 if (EvaluateExpression (expr, &(result.GetOutputStream()), &(result.GetErrorStream()), &result)) 441 return true; 442 443 result.SetStatus (eReturnStatusFailed); 444 return false; 445 } 446 447 OptionDefinition 448 CommandObjectExpression::CommandOptions::g_option_table[] = 449 { 450 //{ LLDB_OPT_SET_ALL, false, "language", 'l', required_argument, NULL, 0, "[c|c++|objc|objc++]", "Sets the language to use when parsing the expression."}, 451 //{ 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."}, 452 { LLDB_OPT_SET_1, false, "format", 'f', required_argument, NULL, 0, eArgTypeExprFormat, "Specify the format that the expression output should use."}, 453 { LLDB_OPT_SET_2, false, "object-description", 'o', no_argument, NULL, 0, eArgTypeNone, "Print the object description of the value resulting from the expression."}, 454 { 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."}, 455 { 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."}, 456 { LLDB_OPT_SET_ALL, false, "debug", 'g', no_argument, NULL, 0, eArgTypeNone, "Enable verbose debug logging of the expression parsing and evaluation."}, 457 { LLDB_OPT_SET_ALL, false, "use-ir", 'i', no_argument, NULL, 0, eArgTypeNone, "[Temporary] Instructs the expression evaluator to use IR instead of ASTs."}, 458 { 0, false, NULL, 0, 0, NULL, NULL, eArgTypeNone, NULL } 459 }; 460 461