1 //===-- CommandInterpreter.cpp --------------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include <limits> 10 #include <memory> 11 #include <stdlib.h> 12 #include <string> 13 #include <vector> 14 15 #include "CommandObjectScript.h" 16 #include "lldb/Interpreter/CommandObjectRegexCommand.h" 17 18 #include "Commands/CommandObjectApropos.h" 19 #include "Commands/CommandObjectBreakpoint.h" 20 #include "Commands/CommandObjectCommands.h" 21 #include "Commands/CommandObjectDisassemble.h" 22 #include "Commands/CommandObjectExpression.h" 23 #include "Commands/CommandObjectFrame.h" 24 #include "Commands/CommandObjectGUI.h" 25 #include "Commands/CommandObjectHelp.h" 26 #include "Commands/CommandObjectLanguage.h" 27 #include "Commands/CommandObjectLog.h" 28 #include "Commands/CommandObjectMemory.h" 29 #include "Commands/CommandObjectPlatform.h" 30 #include "Commands/CommandObjectPlugin.h" 31 #include "Commands/CommandObjectProcess.h" 32 #include "Commands/CommandObjectQuit.h" 33 #include "Commands/CommandObjectRegister.h" 34 #include "Commands/CommandObjectReproducer.h" 35 #include "Commands/CommandObjectSession.h" 36 #include "Commands/CommandObjectSettings.h" 37 #include "Commands/CommandObjectSource.h" 38 #include "Commands/CommandObjectStats.h" 39 #include "Commands/CommandObjectTarget.h" 40 #include "Commands/CommandObjectThread.h" 41 #include "Commands/CommandObjectType.h" 42 #include "Commands/CommandObjectVersion.h" 43 #include "Commands/CommandObjectWatchpoint.h" 44 45 #include "lldb/Core/Debugger.h" 46 #include "lldb/Core/PluginManager.h" 47 #include "lldb/Core/StreamFile.h" 48 #include "lldb/Utility/Log.h" 49 #include "lldb/Utility/State.h" 50 #include "lldb/Utility/Stream.h" 51 #include "lldb/Utility/Timer.h" 52 53 #include "lldb/Host/Config.h" 54 #if LLDB_ENABLE_LIBEDIT 55 #include "lldb/Host/Editline.h" 56 #endif 57 #include "lldb/Host/File.h" 58 #include "lldb/Host/FileCache.h" 59 #include "lldb/Host/Host.h" 60 #include "lldb/Host/HostInfo.h" 61 62 #include "lldb/Interpreter/CommandCompletions.h" 63 #include "lldb/Interpreter/CommandInterpreter.h" 64 #include "lldb/Interpreter/CommandReturnObject.h" 65 #include "lldb/Interpreter/OptionValueProperties.h" 66 #include "lldb/Interpreter/Options.h" 67 #include "lldb/Interpreter/Property.h" 68 #include "lldb/Utility/Args.h" 69 70 #include "lldb/Target/Process.h" 71 #include "lldb/Target/StopInfo.h" 72 #include "lldb/Target/TargetList.h" 73 #include "lldb/Target/Thread.h" 74 #include "lldb/Target/UnixSignals.h" 75 76 #include "llvm/ADT/STLExtras.h" 77 #include "llvm/ADT/SmallString.h" 78 #include "llvm/Support/FormatAdapters.h" 79 #include "llvm/Support/Path.h" 80 #include "llvm/Support/PrettyStackTrace.h" 81 #include "llvm/Support/ScopedPrinter.h" 82 83 using namespace lldb; 84 using namespace lldb_private; 85 86 static const char *k_white_space = " \t\v"; 87 88 static constexpr const char *InitFileWarning = 89 "There is a .lldbinit file in the current directory which is not being " 90 "read.\n" 91 "To silence this warning without sourcing in the local .lldbinit,\n" 92 "add the following to the lldbinit file in your home directory:\n" 93 " settings set target.load-cwd-lldbinit false\n" 94 "To allow lldb to source .lldbinit files in the current working " 95 "directory,\n" 96 "set the value of this variable to true. Only do so if you understand " 97 "and\n" 98 "accept the security risk."; 99 100 #define LLDB_PROPERTIES_interpreter 101 #include "InterpreterProperties.inc" 102 103 enum { 104 #define LLDB_PROPERTIES_interpreter 105 #include "InterpreterPropertiesEnum.inc" 106 }; 107 108 ConstString &CommandInterpreter::GetStaticBroadcasterClass() { 109 static ConstString class_name("lldb.commandInterpreter"); 110 return class_name; 111 } 112 113 CommandInterpreter::CommandInterpreter(Debugger &debugger, 114 bool synchronous_execution) 115 : Broadcaster(debugger.GetBroadcasterManager(), 116 CommandInterpreter::GetStaticBroadcasterClass().AsCString()), 117 Properties(OptionValuePropertiesSP( 118 new OptionValueProperties(ConstString("interpreter")))), 119 IOHandlerDelegate(IOHandlerDelegate::Completion::LLDBCommand), 120 m_debugger(debugger), m_synchronous_execution(true), 121 m_skip_lldbinit_files(false), m_skip_app_init_files(false), 122 m_command_io_handler_sp(), m_comment_char('#'), 123 m_batch_command_mode(false), m_truncation_warning(eNoTruncation), 124 m_command_source_depth(0), m_result(), m_transcript_stream() { 125 SetEventName(eBroadcastBitThreadShouldExit, "thread-should-exit"); 126 SetEventName(eBroadcastBitResetPrompt, "reset-prompt"); 127 SetEventName(eBroadcastBitQuitCommandReceived, "quit"); 128 SetSynchronous(synchronous_execution); 129 CheckInWithManager(); 130 m_collection_sp->Initialize(g_interpreter_properties); 131 } 132 133 bool CommandInterpreter::GetExpandRegexAliases() const { 134 const uint32_t idx = ePropertyExpandRegexAliases; 135 return m_collection_sp->GetPropertyAtIndexAsBoolean( 136 nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0); 137 } 138 139 bool CommandInterpreter::GetPromptOnQuit() const { 140 const uint32_t idx = ePropertyPromptOnQuit; 141 return m_collection_sp->GetPropertyAtIndexAsBoolean( 142 nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0); 143 } 144 145 void CommandInterpreter::SetPromptOnQuit(bool enable) { 146 const uint32_t idx = ePropertyPromptOnQuit; 147 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable); 148 } 149 150 bool CommandInterpreter::GetSaveSessionOnQuit() const { 151 const uint32_t idx = ePropertySaveSessionOnQuit; 152 return m_collection_sp->GetPropertyAtIndexAsBoolean( 153 nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0); 154 } 155 156 void CommandInterpreter::SetSaveSessionOnQuit(bool enable) { 157 const uint32_t idx = ePropertySaveSessionOnQuit; 158 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable); 159 } 160 161 bool CommandInterpreter::GetEchoCommands() const { 162 const uint32_t idx = ePropertyEchoCommands; 163 return m_collection_sp->GetPropertyAtIndexAsBoolean( 164 nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0); 165 } 166 167 void CommandInterpreter::SetEchoCommands(bool enable) { 168 const uint32_t idx = ePropertyEchoCommands; 169 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable); 170 } 171 172 bool CommandInterpreter::GetEchoCommentCommands() const { 173 const uint32_t idx = ePropertyEchoCommentCommands; 174 return m_collection_sp->GetPropertyAtIndexAsBoolean( 175 nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0); 176 } 177 178 void CommandInterpreter::SetEchoCommentCommands(bool enable) { 179 const uint32_t idx = ePropertyEchoCommentCommands; 180 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable); 181 } 182 183 void CommandInterpreter::AllowExitCodeOnQuit(bool allow) { 184 m_allow_exit_code = allow; 185 if (!allow) 186 m_quit_exit_code.reset(); 187 } 188 189 bool CommandInterpreter::SetQuitExitCode(int exit_code) { 190 if (!m_allow_exit_code) 191 return false; 192 m_quit_exit_code = exit_code; 193 return true; 194 } 195 196 int CommandInterpreter::GetQuitExitCode(bool &exited) const { 197 exited = m_quit_exit_code.hasValue(); 198 if (exited) 199 return *m_quit_exit_code; 200 return 0; 201 } 202 203 void CommandInterpreter::ResolveCommand(const char *command_line, 204 CommandReturnObject &result) { 205 std::string command = command_line; 206 if (ResolveCommandImpl(command, result) != nullptr) { 207 result.AppendMessageWithFormat("%s", command.c_str()); 208 result.SetStatus(eReturnStatusSuccessFinishResult); 209 } 210 } 211 212 bool CommandInterpreter::GetStopCmdSourceOnError() const { 213 const uint32_t idx = ePropertyStopCmdSourceOnError; 214 return m_collection_sp->GetPropertyAtIndexAsBoolean( 215 nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0); 216 } 217 218 bool CommandInterpreter::GetSpaceReplPrompts() const { 219 const uint32_t idx = ePropertySpaceReplPrompts; 220 return m_collection_sp->GetPropertyAtIndexAsBoolean( 221 nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0); 222 } 223 224 void CommandInterpreter::Initialize() { 225 static Timer::Category func_cat(LLVM_PRETTY_FUNCTION); 226 Timer scoped_timer(func_cat, LLVM_PRETTY_FUNCTION); 227 228 CommandReturnObject result(m_debugger.GetUseColor()); 229 230 LoadCommandDictionary(); 231 232 // An alias arguments vector to reuse - reset it before use... 233 OptionArgVectorSP alias_arguments_vector_sp(new OptionArgVector); 234 235 // Set up some initial aliases. 236 CommandObjectSP cmd_obj_sp = GetCommandSPExact("quit", false); 237 if (cmd_obj_sp) { 238 AddAlias("q", cmd_obj_sp); 239 AddAlias("exit", cmd_obj_sp); 240 } 241 242 cmd_obj_sp = GetCommandSPExact("_regexp-attach", false); 243 if (cmd_obj_sp) 244 AddAlias("attach", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 245 246 cmd_obj_sp = GetCommandSPExact("process detach", false); 247 if (cmd_obj_sp) { 248 AddAlias("detach", cmd_obj_sp); 249 } 250 251 cmd_obj_sp = GetCommandSPExact("process continue", false); 252 if (cmd_obj_sp) { 253 AddAlias("c", cmd_obj_sp); 254 AddAlias("continue", cmd_obj_sp); 255 } 256 257 cmd_obj_sp = GetCommandSPExact("_regexp-break", false); 258 if (cmd_obj_sp) 259 AddAlias("b", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 260 261 cmd_obj_sp = GetCommandSPExact("_regexp-tbreak", false); 262 if (cmd_obj_sp) 263 AddAlias("tbreak", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 264 265 cmd_obj_sp = GetCommandSPExact("thread step-inst", false); 266 if (cmd_obj_sp) { 267 AddAlias("stepi", cmd_obj_sp); 268 AddAlias("si", cmd_obj_sp); 269 } 270 271 cmd_obj_sp = GetCommandSPExact("thread step-inst-over", false); 272 if (cmd_obj_sp) { 273 AddAlias("nexti", cmd_obj_sp); 274 AddAlias("ni", cmd_obj_sp); 275 } 276 277 cmd_obj_sp = GetCommandSPExact("thread step-in", false); 278 if (cmd_obj_sp) { 279 AddAlias("s", cmd_obj_sp); 280 AddAlias("step", cmd_obj_sp); 281 CommandAlias *sif_alias = AddAlias( 282 "sif", cmd_obj_sp, "--end-linenumber block --step-in-target %1"); 283 if (sif_alias) { 284 sif_alias->SetHelp("Step through the current block, stopping if you step " 285 "directly into a function whose name matches the " 286 "TargetFunctionName."); 287 sif_alias->SetSyntax("sif <TargetFunctionName>"); 288 } 289 } 290 291 cmd_obj_sp = GetCommandSPExact("thread step-over", false); 292 if (cmd_obj_sp) { 293 AddAlias("n", cmd_obj_sp); 294 AddAlias("next", cmd_obj_sp); 295 } 296 297 cmd_obj_sp = GetCommandSPExact("thread step-out", false); 298 if (cmd_obj_sp) { 299 AddAlias("finish", cmd_obj_sp); 300 } 301 302 cmd_obj_sp = GetCommandSPExact("frame select", false); 303 if (cmd_obj_sp) { 304 AddAlias("f", cmd_obj_sp); 305 } 306 307 cmd_obj_sp = GetCommandSPExact("thread select", false); 308 if (cmd_obj_sp) { 309 AddAlias("t", cmd_obj_sp); 310 } 311 312 cmd_obj_sp = GetCommandSPExact("_regexp-jump", false); 313 if (cmd_obj_sp) { 314 AddAlias("j", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 315 AddAlias("jump", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 316 } 317 318 cmd_obj_sp = GetCommandSPExact("_regexp-list", false); 319 if (cmd_obj_sp) { 320 AddAlias("l", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 321 AddAlias("list", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 322 } 323 324 cmd_obj_sp = GetCommandSPExact("_regexp-env", false); 325 if (cmd_obj_sp) 326 AddAlias("env", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 327 328 cmd_obj_sp = GetCommandSPExact("memory read", false); 329 if (cmd_obj_sp) 330 AddAlias("x", cmd_obj_sp); 331 332 cmd_obj_sp = GetCommandSPExact("_regexp-up", false); 333 if (cmd_obj_sp) 334 AddAlias("up", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 335 336 cmd_obj_sp = GetCommandSPExact("_regexp-down", false); 337 if (cmd_obj_sp) 338 AddAlias("down", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 339 340 cmd_obj_sp = GetCommandSPExact("_regexp-display", false); 341 if (cmd_obj_sp) 342 AddAlias("display", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 343 344 cmd_obj_sp = GetCommandSPExact("disassemble", false); 345 if (cmd_obj_sp) 346 AddAlias("dis", cmd_obj_sp); 347 348 cmd_obj_sp = GetCommandSPExact("disassemble", false); 349 if (cmd_obj_sp) 350 AddAlias("di", cmd_obj_sp); 351 352 cmd_obj_sp = GetCommandSPExact("_regexp-undisplay", false); 353 if (cmd_obj_sp) 354 AddAlias("undisplay", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 355 356 cmd_obj_sp = GetCommandSPExact("_regexp-bt", false); 357 if (cmd_obj_sp) 358 AddAlias("bt", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax()); 359 360 cmd_obj_sp = GetCommandSPExact("target create", false); 361 if (cmd_obj_sp) 362 AddAlias("file", cmd_obj_sp); 363 364 cmd_obj_sp = GetCommandSPExact("target modules", false); 365 if (cmd_obj_sp) 366 AddAlias("image", cmd_obj_sp); 367 368 alias_arguments_vector_sp = std::make_shared<OptionArgVector>(); 369 370 cmd_obj_sp = GetCommandSPExact("expression", false); 371 if (cmd_obj_sp) { 372 AddAlias("p", cmd_obj_sp, "--")->SetHelpLong(""); 373 AddAlias("print", cmd_obj_sp, "--")->SetHelpLong(""); 374 AddAlias("call", cmd_obj_sp, "--")->SetHelpLong(""); 375 if (auto *po = AddAlias("po", cmd_obj_sp, "-O --")) { 376 po->SetHelp("Evaluate an expression on the current thread. Displays any " 377 "returned value with formatting " 378 "controlled by the type's author."); 379 po->SetHelpLong(""); 380 } 381 CommandAlias *parray_alias = 382 AddAlias("parray", cmd_obj_sp, "--element-count %1 --"); 383 if (parray_alias) { 384 parray_alias->SetHelp 385 ("parray <COUNT> <EXPRESSION> -- lldb will evaluate EXPRESSION " 386 "to get a typed-pointer-to-an-array in memory, and will display " 387 "COUNT elements of that type from the array."); 388 parray_alias->SetHelpLong(""); 389 } 390 CommandAlias *poarray_alias = AddAlias("poarray", cmd_obj_sp, 391 "--object-description --element-count %1 --"); 392 if (poarray_alias) { 393 poarray_alias->SetHelp("poarray <COUNT> <EXPRESSION> -- lldb will " 394 "evaluate EXPRESSION to get the address of an array of COUNT " 395 "objects in memory, and will call po on them."); 396 poarray_alias->SetHelpLong(""); 397 } 398 } 399 400 cmd_obj_sp = GetCommandSPExact("platform shell", false); 401 if (cmd_obj_sp) { 402 CommandAlias *shell_alias = AddAlias("shell", cmd_obj_sp, " --host --"); 403 if (shell_alias) { 404 shell_alias->SetHelp("Run a shell command on the host."); 405 shell_alias->SetHelpLong(""); 406 shell_alias->SetSyntax("shell <shell-command>"); 407 } 408 } 409 410 cmd_obj_sp = GetCommandSPExact("process kill", false); 411 if (cmd_obj_sp) { 412 AddAlias("kill", cmd_obj_sp); 413 } 414 415 cmd_obj_sp = GetCommandSPExact("process launch", false); 416 if (cmd_obj_sp) { 417 alias_arguments_vector_sp = std::make_shared<OptionArgVector>(); 418 #if defined(__arm__) || defined(__arm64__) || defined(__aarch64__) 419 AddAlias("r", cmd_obj_sp, "--"); 420 AddAlias("run", cmd_obj_sp, "--"); 421 #else 422 #if defined(__APPLE__) 423 std::string shell_option; 424 shell_option.append("--shell-expand-args"); 425 shell_option.append(" true"); 426 shell_option.append(" --"); 427 AddAlias("r", cmd_obj_sp, "--shell-expand-args true --"); 428 AddAlias("run", cmd_obj_sp, "--shell-expand-args true --"); 429 #else 430 StreamString defaultshell; 431 defaultshell.Printf("--shell=%s --", 432 HostInfo::GetDefaultShell().GetPath().c_str()); 433 AddAlias("r", cmd_obj_sp, defaultshell.GetString()); 434 AddAlias("run", cmd_obj_sp, defaultshell.GetString()); 435 #endif 436 #endif 437 } 438 439 cmd_obj_sp = GetCommandSPExact("target symbols add", false); 440 if (cmd_obj_sp) { 441 AddAlias("add-dsym", cmd_obj_sp); 442 } 443 444 cmd_obj_sp = GetCommandSPExact("breakpoint set", false); 445 if (cmd_obj_sp) { 446 AddAlias("rbreak", cmd_obj_sp, "--func-regex %1"); 447 } 448 449 cmd_obj_sp = GetCommandSPExact("frame variable", false); 450 if (cmd_obj_sp) { 451 AddAlias("v", cmd_obj_sp); 452 AddAlias("var", cmd_obj_sp); 453 AddAlias("vo", cmd_obj_sp, "--object-description"); 454 } 455 456 cmd_obj_sp = GetCommandSPExact("register", false); 457 if (cmd_obj_sp) { 458 AddAlias("re", cmd_obj_sp); 459 } 460 461 cmd_obj_sp = GetCommandSPExact("session history", false); 462 if (cmd_obj_sp) { 463 AddAlias("history", cmd_obj_sp); 464 } 465 } 466 467 void CommandInterpreter::Clear() { 468 m_command_io_handler_sp.reset(); 469 } 470 471 const char *CommandInterpreter::ProcessEmbeddedScriptCommands(const char *arg) { 472 // This function has not yet been implemented. 473 474 // Look for any embedded script command 475 // If found, 476 // get interpreter object from the command dictionary, 477 // call execute_one_command on it, 478 // get the results as a string, 479 // substitute that string for current stuff. 480 481 return arg; 482 } 483 484 #define REGISTER_COMMAND_OBJECT(NAME, CLASS) \ 485 m_command_dict[NAME] = std::make_shared<CLASS>(*this); 486 487 void CommandInterpreter::LoadCommandDictionary() { 488 static Timer::Category func_cat(LLVM_PRETTY_FUNCTION); 489 Timer scoped_timer(func_cat, LLVM_PRETTY_FUNCTION); 490 491 REGISTER_COMMAND_OBJECT("apropos", CommandObjectApropos); 492 REGISTER_COMMAND_OBJECT("breakpoint", CommandObjectMultiwordBreakpoint); 493 REGISTER_COMMAND_OBJECT("command", CommandObjectMultiwordCommands); 494 REGISTER_COMMAND_OBJECT("disassemble", CommandObjectDisassemble); 495 REGISTER_COMMAND_OBJECT("expression", CommandObjectExpression); 496 REGISTER_COMMAND_OBJECT("frame", CommandObjectMultiwordFrame); 497 REGISTER_COMMAND_OBJECT("gui", CommandObjectGUI); 498 REGISTER_COMMAND_OBJECT("help", CommandObjectHelp); 499 REGISTER_COMMAND_OBJECT("log", CommandObjectLog); 500 REGISTER_COMMAND_OBJECT("memory", CommandObjectMemory); 501 REGISTER_COMMAND_OBJECT("platform", CommandObjectPlatform); 502 REGISTER_COMMAND_OBJECT("plugin", CommandObjectPlugin); 503 REGISTER_COMMAND_OBJECT("process", CommandObjectMultiwordProcess); 504 REGISTER_COMMAND_OBJECT("quit", CommandObjectQuit); 505 REGISTER_COMMAND_OBJECT("register", CommandObjectRegister); 506 REGISTER_COMMAND_OBJECT("reproducer", CommandObjectReproducer); 507 REGISTER_COMMAND_OBJECT("script", CommandObjectScript); 508 REGISTER_COMMAND_OBJECT("settings", CommandObjectMultiwordSettings); 509 REGISTER_COMMAND_OBJECT("session", CommandObjectSession); 510 REGISTER_COMMAND_OBJECT("source", CommandObjectMultiwordSource); 511 REGISTER_COMMAND_OBJECT("statistics", CommandObjectStats); 512 REGISTER_COMMAND_OBJECT("target", CommandObjectMultiwordTarget); 513 REGISTER_COMMAND_OBJECT("thread", CommandObjectMultiwordThread); 514 REGISTER_COMMAND_OBJECT("type", CommandObjectType); 515 REGISTER_COMMAND_OBJECT("version", CommandObjectVersion); 516 REGISTER_COMMAND_OBJECT("watchpoint", CommandObjectMultiwordWatchpoint); 517 REGISTER_COMMAND_OBJECT("language", CommandObjectLanguage); 518 519 // clang-format off 520 const char *break_regexes[][2] = { 521 {"^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*$", 522 "breakpoint set --file '%1' --line %2 --column %3"}, 523 {"^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*$", 524 "breakpoint set --file '%1' --line %2"}, 525 {"^/([^/]+)/$", "breakpoint set --source-pattern-regexp '%1'"}, 526 {"^([[:digit:]]+)[[:space:]]*$", "breakpoint set --line %1"}, 527 {"^\\*?(0x[[:xdigit:]]+)[[:space:]]*$", "breakpoint set --address %1"}, 528 {"^[\"']?([-+]?\\[.*\\])[\"']?[[:space:]]*$", 529 "breakpoint set --name '%1'"}, 530 {"^(-.*)$", "breakpoint set %1"}, 531 {"^(.*[^[:space:]])`(.*[^[:space:]])[[:space:]]*$", 532 "breakpoint set --name '%2' --shlib '%1'"}, 533 {"^\\&(.*[^[:space:]])[[:space:]]*$", 534 "breakpoint set --name '%1' --skip-prologue=0"}, 535 {"^[\"']?(.*[^[:space:]\"'])[\"']?[[:space:]]*$", 536 "breakpoint set --name '%1'"}}; 537 // clang-format on 538 539 size_t num_regexes = llvm::array_lengthof(break_regexes); 540 541 std::unique_ptr<CommandObjectRegexCommand> break_regex_cmd_up( 542 new CommandObjectRegexCommand( 543 *this, "_regexp-break", 544 "Set a breakpoint using one of several shorthand formats.", 545 "\n" 546 "_regexp-break <filename>:<linenum>:<colnum>\n" 547 " main.c:12:21 // Break at line 12 and column " 548 "21 of main.c\n\n" 549 "_regexp-break <filename>:<linenum>\n" 550 " main.c:12 // Break at line 12 of " 551 "main.c\n\n" 552 "_regexp-break <linenum>\n" 553 " 12 // Break at line 12 of current " 554 "file\n\n" 555 "_regexp-break 0x<address>\n" 556 " 0x1234000 // Break at address " 557 "0x1234000\n\n" 558 "_regexp-break <name>\n" 559 " main // Break in 'main' after the " 560 "prologue\n\n" 561 "_regexp-break &<name>\n" 562 " &main // Break at first instruction " 563 "in 'main'\n\n" 564 "_regexp-break <module>`<name>\n" 565 " libc.so`malloc // Break in 'malloc' from " 566 "'libc.so'\n\n" 567 "_regexp-break /<source-regex>/\n" 568 " /break here/ // Break on source lines in " 569 "current file\n" 570 " // containing text 'break " 571 "here'.\n", 572 3, 573 CommandCompletions::eSymbolCompletion | 574 CommandCompletions::eSourceFileCompletion, 575 false)); 576 577 if (break_regex_cmd_up) { 578 bool success = true; 579 for (size_t i = 0; i < num_regexes; i++) { 580 success = break_regex_cmd_up->AddRegexCommand(break_regexes[i][0], 581 break_regexes[i][1]); 582 if (!success) 583 break; 584 } 585 success = 586 break_regex_cmd_up->AddRegexCommand("^$", "breakpoint list --full"); 587 588 if (success) { 589 CommandObjectSP break_regex_cmd_sp(break_regex_cmd_up.release()); 590 m_command_dict[std::string(break_regex_cmd_sp->GetCommandName())] = 591 break_regex_cmd_sp; 592 } 593 } 594 595 std::unique_ptr<CommandObjectRegexCommand> tbreak_regex_cmd_up( 596 new CommandObjectRegexCommand( 597 *this, "_regexp-tbreak", 598 "Set a one-shot breakpoint using one of several shorthand formats.", 599 "\n" 600 "_regexp-break <filename>:<linenum>:<colnum>\n" 601 " main.c:12:21 // Break at line 12 and column " 602 "21 of main.c\n\n" 603 "_regexp-break <filename>:<linenum>\n" 604 " main.c:12 // Break at line 12 of " 605 "main.c\n\n" 606 "_regexp-break <linenum>\n" 607 " 12 // Break at line 12 of current " 608 "file\n\n" 609 "_regexp-break 0x<address>\n" 610 " 0x1234000 // Break at address " 611 "0x1234000\n\n" 612 "_regexp-break <name>\n" 613 " main // Break in 'main' after the " 614 "prologue\n\n" 615 "_regexp-break &<name>\n" 616 " &main // Break at first instruction " 617 "in 'main'\n\n" 618 "_regexp-break <module>`<name>\n" 619 " libc.so`malloc // Break in 'malloc' from " 620 "'libc.so'\n\n" 621 "_regexp-break /<source-regex>/\n" 622 " /break here/ // Break on source lines in " 623 "current file\n" 624 " // containing text 'break " 625 "here'.\n", 626 2, 627 CommandCompletions::eSymbolCompletion | 628 CommandCompletions::eSourceFileCompletion, 629 false)); 630 631 if (tbreak_regex_cmd_up) { 632 bool success = true; 633 for (size_t i = 0; i < num_regexes; i++) { 634 std::string command = break_regexes[i][1]; 635 command += " -o 1"; 636 success = 637 tbreak_regex_cmd_up->AddRegexCommand(break_regexes[i][0], command); 638 if (!success) 639 break; 640 } 641 success = 642 tbreak_regex_cmd_up->AddRegexCommand("^$", "breakpoint list --full"); 643 644 if (success) { 645 CommandObjectSP tbreak_regex_cmd_sp(tbreak_regex_cmd_up.release()); 646 m_command_dict[std::string(tbreak_regex_cmd_sp->GetCommandName())] = 647 tbreak_regex_cmd_sp; 648 } 649 } 650 651 std::unique_ptr<CommandObjectRegexCommand> attach_regex_cmd_up( 652 new CommandObjectRegexCommand( 653 *this, "_regexp-attach", "Attach to process by ID or name.", 654 "_regexp-attach <pid> | <process-name>", 2, 0, false)); 655 if (attach_regex_cmd_up) { 656 if (attach_regex_cmd_up->AddRegexCommand("^([0-9]+)[[:space:]]*$", 657 "process attach --pid %1") && 658 attach_regex_cmd_up->AddRegexCommand( 659 "^(-.*|.* -.*)$", "process attach %1") && // Any options that are 660 // specified get passed to 661 // 'process attach' 662 attach_regex_cmd_up->AddRegexCommand("^(.+)$", 663 "process attach --name '%1'") && 664 attach_regex_cmd_up->AddRegexCommand("^$", "process attach")) { 665 CommandObjectSP attach_regex_cmd_sp(attach_regex_cmd_up.release()); 666 m_command_dict[std::string(attach_regex_cmd_sp->GetCommandName())] = 667 attach_regex_cmd_sp; 668 } 669 } 670 671 std::unique_ptr<CommandObjectRegexCommand> down_regex_cmd_up( 672 new CommandObjectRegexCommand(*this, "_regexp-down", 673 "Select a newer stack frame. Defaults to " 674 "moving one frame, a numeric argument can " 675 "specify an arbitrary number.", 676 "_regexp-down [<count>]", 2, 0, false)); 677 if (down_regex_cmd_up) { 678 if (down_regex_cmd_up->AddRegexCommand("^$", "frame select -r -1") && 679 down_regex_cmd_up->AddRegexCommand("^([0-9]+)$", 680 "frame select -r -%1")) { 681 CommandObjectSP down_regex_cmd_sp(down_regex_cmd_up.release()); 682 m_command_dict[std::string(down_regex_cmd_sp->GetCommandName())] = 683 down_regex_cmd_sp; 684 } 685 } 686 687 std::unique_ptr<CommandObjectRegexCommand> up_regex_cmd_up( 688 new CommandObjectRegexCommand( 689 *this, "_regexp-up", 690 "Select an older stack frame. Defaults to moving one " 691 "frame, a numeric argument can specify an arbitrary number.", 692 "_regexp-up [<count>]", 2, 0, false)); 693 if (up_regex_cmd_up) { 694 if (up_regex_cmd_up->AddRegexCommand("^$", "frame select -r 1") && 695 up_regex_cmd_up->AddRegexCommand("^([0-9]+)$", "frame select -r %1")) { 696 CommandObjectSP up_regex_cmd_sp(up_regex_cmd_up.release()); 697 m_command_dict[std::string(up_regex_cmd_sp->GetCommandName())] = 698 up_regex_cmd_sp; 699 } 700 } 701 702 std::unique_ptr<CommandObjectRegexCommand> display_regex_cmd_up( 703 new CommandObjectRegexCommand( 704 *this, "_regexp-display", 705 "Evaluate an expression at every stop (see 'help target stop-hook'.)", 706 "_regexp-display expression", 2, 0, false)); 707 if (display_regex_cmd_up) { 708 if (display_regex_cmd_up->AddRegexCommand( 709 "^(.+)$", "target stop-hook add -o \"expr -- %1\"")) { 710 CommandObjectSP display_regex_cmd_sp(display_regex_cmd_up.release()); 711 m_command_dict[std::string(display_regex_cmd_sp->GetCommandName())] = 712 display_regex_cmd_sp; 713 } 714 } 715 716 std::unique_ptr<CommandObjectRegexCommand> undisplay_regex_cmd_up( 717 new CommandObjectRegexCommand(*this, "_regexp-undisplay", 718 "Stop displaying expression at every " 719 "stop (specified by stop-hook index.)", 720 "_regexp-undisplay stop-hook-number", 2, 0, 721 false)); 722 if (undisplay_regex_cmd_up) { 723 if (undisplay_regex_cmd_up->AddRegexCommand("^([0-9]+)$", 724 "target stop-hook delete %1")) { 725 CommandObjectSP undisplay_regex_cmd_sp(undisplay_regex_cmd_up.release()); 726 m_command_dict[std::string(undisplay_regex_cmd_sp->GetCommandName())] = 727 undisplay_regex_cmd_sp; 728 } 729 } 730 731 std::unique_ptr<CommandObjectRegexCommand> connect_gdb_remote_cmd_up( 732 new CommandObjectRegexCommand( 733 *this, "gdb-remote", 734 "Connect to a process via remote GDB server. " 735 "If no host is specifed, localhost is assumed.", 736 "gdb-remote [<hostname>:]<portnum>", 2, 0, false)); 737 if (connect_gdb_remote_cmd_up) { 738 if (connect_gdb_remote_cmd_up->AddRegexCommand( 739 "^([^:]+|\\[[0-9a-fA-F:]+.*\\]):([0-9]+)$", 740 "process connect --plugin gdb-remote connect://%1:%2") && 741 connect_gdb_remote_cmd_up->AddRegexCommand( 742 "^([[:digit:]]+)$", 743 "process connect --plugin gdb-remote connect://localhost:%1")) { 744 CommandObjectSP command_sp(connect_gdb_remote_cmd_up.release()); 745 m_command_dict[std::string(command_sp->GetCommandName())] = command_sp; 746 } 747 } 748 749 std::unique_ptr<CommandObjectRegexCommand> connect_kdp_remote_cmd_up( 750 new CommandObjectRegexCommand( 751 *this, "kdp-remote", 752 "Connect to a process via remote KDP server. " 753 "If no UDP port is specified, port 41139 is " 754 "assumed.", 755 "kdp-remote <hostname>[:<portnum>]", 2, 0, false)); 756 if (connect_kdp_remote_cmd_up) { 757 if (connect_kdp_remote_cmd_up->AddRegexCommand( 758 "^([^:]+:[[:digit:]]+)$", 759 "process connect --plugin kdp-remote udp://%1") && 760 connect_kdp_remote_cmd_up->AddRegexCommand( 761 "^(.+)$", "process connect --plugin kdp-remote udp://%1:41139")) { 762 CommandObjectSP command_sp(connect_kdp_remote_cmd_up.release()); 763 m_command_dict[std::string(command_sp->GetCommandName())] = command_sp; 764 } 765 } 766 767 std::unique_ptr<CommandObjectRegexCommand> bt_regex_cmd_up( 768 new CommandObjectRegexCommand( 769 *this, "_regexp-bt", 770 "Show the current thread's call stack. Any numeric argument " 771 "displays at most that many " 772 "frames. The argument 'all' displays all threads. Use 'settings" 773 " set frame-format' to customize the printing of individual frames " 774 "and 'settings set thread-format' to customize the thread header.", 775 "bt [<digit> | all]", 2, 0, false)); 776 if (bt_regex_cmd_up) { 777 // accept but don't document "bt -c <number>" -- before bt was a regex 778 // command if you wanted to backtrace three frames you would do "bt -c 3" 779 // but the intention is to have this emulate the gdb "bt" command and so 780 // now "bt 3" is the preferred form, in line with gdb. 781 if (bt_regex_cmd_up->AddRegexCommand("^([[:digit:]]+)[[:space:]]*$", 782 "thread backtrace -c %1") && 783 bt_regex_cmd_up->AddRegexCommand("^-c ([[:digit:]]+)[[:space:]]*$", 784 "thread backtrace -c %1") && 785 bt_regex_cmd_up->AddRegexCommand("^all[[:space:]]*$", "thread backtrace all") && 786 bt_regex_cmd_up->AddRegexCommand("^[[:space:]]*$", "thread backtrace")) { 787 CommandObjectSP command_sp(bt_regex_cmd_up.release()); 788 m_command_dict[std::string(command_sp->GetCommandName())] = command_sp; 789 } 790 } 791 792 std::unique_ptr<CommandObjectRegexCommand> list_regex_cmd_up( 793 new CommandObjectRegexCommand( 794 *this, "_regexp-list", 795 "List relevant source code using one of several shorthand formats.", 796 "\n" 797 "_regexp-list <file>:<line> // List around specific file/line\n" 798 "_regexp-list <line> // List current file around specified " 799 "line\n" 800 "_regexp-list <function-name> // List specified function\n" 801 "_regexp-list 0x<address> // List around specified address\n" 802 "_regexp-list -[<count>] // List previous <count> lines\n" 803 "_regexp-list // List subsequent lines", 804 2, CommandCompletions::eSourceFileCompletion, false)); 805 if (list_regex_cmd_up) { 806 if (list_regex_cmd_up->AddRegexCommand("^([0-9]+)[[:space:]]*$", 807 "source list --line %1") && 808 list_regex_cmd_up->AddRegexCommand( 809 "^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]" 810 "]*$", 811 "source list --file '%1' --line %2") && 812 list_regex_cmd_up->AddRegexCommand( 813 "^\\*?(0x[[:xdigit:]]+)[[:space:]]*$", 814 "source list --address %1") && 815 list_regex_cmd_up->AddRegexCommand("^-[[:space:]]*$", 816 "source list --reverse") && 817 list_regex_cmd_up->AddRegexCommand( 818 "^-([[:digit:]]+)[[:space:]]*$", 819 "source list --reverse --count %1") && 820 list_regex_cmd_up->AddRegexCommand("^(.+)$", 821 "source list --name \"%1\"") && 822 list_regex_cmd_up->AddRegexCommand("^$", "source list")) { 823 CommandObjectSP list_regex_cmd_sp(list_regex_cmd_up.release()); 824 m_command_dict[std::string(list_regex_cmd_sp->GetCommandName())] = 825 list_regex_cmd_sp; 826 } 827 } 828 829 std::unique_ptr<CommandObjectRegexCommand> env_regex_cmd_up( 830 new CommandObjectRegexCommand( 831 *this, "_regexp-env", 832 "Shorthand for viewing and setting environment variables.", 833 "\n" 834 "_regexp-env // Show environment\n" 835 "_regexp-env <name>=<value> // Set an environment variable", 836 2, 0, false)); 837 if (env_regex_cmd_up) { 838 if (env_regex_cmd_up->AddRegexCommand("^$", 839 "settings show target.env-vars") && 840 env_regex_cmd_up->AddRegexCommand("^([A-Za-z_][A-Za-z_0-9]*=.*)$", 841 "settings set target.env-vars %1")) { 842 CommandObjectSP env_regex_cmd_sp(env_regex_cmd_up.release()); 843 m_command_dict[std::string(env_regex_cmd_sp->GetCommandName())] = 844 env_regex_cmd_sp; 845 } 846 } 847 848 std::unique_ptr<CommandObjectRegexCommand> jump_regex_cmd_up( 849 new CommandObjectRegexCommand( 850 *this, "_regexp-jump", "Set the program counter to a new address.", 851 "\n" 852 "_regexp-jump <line>\n" 853 "_regexp-jump +<line-offset> | -<line-offset>\n" 854 "_regexp-jump <file>:<line>\n" 855 "_regexp-jump *<addr>\n", 856 2, 0, false)); 857 if (jump_regex_cmd_up) { 858 if (jump_regex_cmd_up->AddRegexCommand("^\\*(.*)$", 859 "thread jump --addr %1") && 860 jump_regex_cmd_up->AddRegexCommand("^([0-9]+)$", 861 "thread jump --line %1") && 862 jump_regex_cmd_up->AddRegexCommand("^([^:]+):([0-9]+)$", 863 "thread jump --file %1 --line %2") && 864 jump_regex_cmd_up->AddRegexCommand("^([+\\-][0-9]+)$", 865 "thread jump --by %1")) { 866 CommandObjectSP jump_regex_cmd_sp(jump_regex_cmd_up.release()); 867 m_command_dict[std::string(jump_regex_cmd_sp->GetCommandName())] = 868 jump_regex_cmd_sp; 869 } 870 } 871 } 872 873 int CommandInterpreter::GetCommandNamesMatchingPartialString( 874 const char *cmd_str, bool include_aliases, StringList &matches, 875 StringList &descriptions) { 876 AddNamesMatchingPartialString(m_command_dict, cmd_str, matches, 877 &descriptions); 878 879 if (include_aliases) { 880 AddNamesMatchingPartialString(m_alias_dict, cmd_str, matches, 881 &descriptions); 882 } 883 884 return matches.GetSize(); 885 } 886 887 CommandObjectSP 888 CommandInterpreter::GetCommandSP(llvm::StringRef cmd_str, bool include_aliases, 889 bool exact, StringList *matches, 890 StringList *descriptions) const { 891 CommandObjectSP command_sp; 892 893 std::string cmd = std::string(cmd_str); 894 895 if (HasCommands()) { 896 auto pos = m_command_dict.find(cmd); 897 if (pos != m_command_dict.end()) 898 command_sp = pos->second; 899 } 900 901 if (include_aliases && HasAliases()) { 902 auto alias_pos = m_alias_dict.find(cmd); 903 if (alias_pos != m_alias_dict.end()) 904 command_sp = alias_pos->second; 905 } 906 907 if (HasUserCommands()) { 908 auto pos = m_user_dict.find(cmd); 909 if (pos != m_user_dict.end()) 910 command_sp = pos->second; 911 } 912 913 if (!exact && !command_sp) { 914 // We will only get into here if we didn't find any exact matches. 915 916 CommandObjectSP user_match_sp, alias_match_sp, real_match_sp; 917 918 StringList local_matches; 919 if (matches == nullptr) 920 matches = &local_matches; 921 922 unsigned int num_cmd_matches = 0; 923 unsigned int num_alias_matches = 0; 924 unsigned int num_user_matches = 0; 925 926 // Look through the command dictionaries one by one, and if we get only one 927 // match from any of them in toto, then return that, otherwise return an 928 // empty CommandObjectSP and the list of matches. 929 930 if (HasCommands()) { 931 num_cmd_matches = AddNamesMatchingPartialString(m_command_dict, cmd_str, 932 *matches, descriptions); 933 } 934 935 if (num_cmd_matches == 1) { 936 cmd.assign(matches->GetStringAtIndex(0)); 937 auto pos = m_command_dict.find(cmd); 938 if (pos != m_command_dict.end()) 939 real_match_sp = pos->second; 940 } 941 942 if (include_aliases && HasAliases()) { 943 num_alias_matches = AddNamesMatchingPartialString(m_alias_dict, cmd_str, 944 *matches, descriptions); 945 } 946 947 if (num_alias_matches == 1) { 948 cmd.assign(matches->GetStringAtIndex(num_cmd_matches)); 949 auto alias_pos = m_alias_dict.find(cmd); 950 if (alias_pos != m_alias_dict.end()) 951 alias_match_sp = alias_pos->second; 952 } 953 954 if (HasUserCommands()) { 955 num_user_matches = AddNamesMatchingPartialString(m_user_dict, cmd_str, 956 *matches, descriptions); 957 } 958 959 if (num_user_matches == 1) { 960 cmd.assign( 961 matches->GetStringAtIndex(num_cmd_matches + num_alias_matches)); 962 963 auto pos = m_user_dict.find(cmd); 964 if (pos != m_user_dict.end()) 965 user_match_sp = pos->second; 966 } 967 968 // If we got exactly one match, return that, otherwise return the match 969 // list. 970 971 if (num_user_matches + num_cmd_matches + num_alias_matches == 1) { 972 if (num_cmd_matches) 973 return real_match_sp; 974 else if (num_alias_matches) 975 return alias_match_sp; 976 else 977 return user_match_sp; 978 } 979 } else if (matches && command_sp) { 980 matches->AppendString(cmd_str); 981 if (descriptions) 982 descriptions->AppendString(command_sp->GetHelp()); 983 } 984 985 return command_sp; 986 } 987 988 bool CommandInterpreter::AddCommand(llvm::StringRef name, 989 const lldb::CommandObjectSP &cmd_sp, 990 bool can_replace) { 991 if (cmd_sp.get()) 992 lldbassert((this == &cmd_sp->GetCommandInterpreter()) && 993 "tried to add a CommandObject from a different interpreter"); 994 995 if (name.empty()) 996 return false; 997 998 std::string name_sstr(name); 999 auto name_iter = m_command_dict.find(name_sstr); 1000 if (name_iter != m_command_dict.end()) { 1001 if (!can_replace || !name_iter->second->IsRemovable()) 1002 return false; 1003 name_iter->second = cmd_sp; 1004 } else { 1005 m_command_dict[name_sstr] = cmd_sp; 1006 } 1007 return true; 1008 } 1009 1010 bool CommandInterpreter::AddUserCommand(llvm::StringRef name, 1011 const lldb::CommandObjectSP &cmd_sp, 1012 bool can_replace) { 1013 if (cmd_sp.get()) 1014 lldbassert((this == &cmd_sp->GetCommandInterpreter()) && 1015 "tried to add a CommandObject from a different interpreter"); 1016 1017 if (!name.empty()) { 1018 // do not allow replacement of internal commands 1019 if (CommandExists(name)) { 1020 if (!can_replace) 1021 return false; 1022 if (!m_command_dict[std::string(name)]->IsRemovable()) 1023 return false; 1024 } 1025 1026 if (UserCommandExists(name)) { 1027 if (!can_replace) 1028 return false; 1029 if (!m_user_dict[std::string(name)]->IsRemovable()) 1030 return false; 1031 } 1032 1033 m_user_dict[std::string(name)] = cmd_sp; 1034 return true; 1035 } 1036 return false; 1037 } 1038 1039 CommandObjectSP CommandInterpreter::GetCommandSPExact(llvm::StringRef cmd_str, 1040 bool include_aliases) const { 1041 Args cmd_words(cmd_str); // Break up the command string into words, in case 1042 // it's a multi-word command. 1043 CommandObjectSP ret_val; // Possibly empty return value. 1044 1045 if (cmd_str.empty()) 1046 return ret_val; 1047 1048 if (cmd_words.GetArgumentCount() == 1) 1049 return GetCommandSP(cmd_str, include_aliases, true, nullptr); 1050 else { 1051 // We have a multi-word command (seemingly), so we need to do more work. 1052 // First, get the cmd_obj_sp for the first word in the command. 1053 CommandObjectSP cmd_obj_sp = GetCommandSP(llvm::StringRef(cmd_words.GetArgumentAtIndex(0)), 1054 include_aliases, true, nullptr); 1055 if (cmd_obj_sp.get() != nullptr) { 1056 // Loop through the rest of the words in the command (everything passed 1057 // in was supposed to be part of a command name), and find the 1058 // appropriate sub-command SP for each command word.... 1059 size_t end = cmd_words.GetArgumentCount(); 1060 for (size_t j = 1; j < end; ++j) { 1061 if (cmd_obj_sp->IsMultiwordObject()) { 1062 cmd_obj_sp = 1063 cmd_obj_sp->GetSubcommandSP(cmd_words.GetArgumentAtIndex(j)); 1064 if (cmd_obj_sp.get() == nullptr) 1065 // The sub-command name was invalid. Fail and return the empty 1066 // 'ret_val'. 1067 return ret_val; 1068 } else 1069 // We have more words in the command name, but we don't have a 1070 // multiword object. Fail and return empty 'ret_val'. 1071 return ret_val; 1072 } 1073 // We successfully looped through all the command words and got valid 1074 // command objects for them. Assign the last object retrieved to 1075 // 'ret_val'. 1076 ret_val = cmd_obj_sp; 1077 } 1078 } 1079 return ret_val; 1080 } 1081 1082 CommandObject * 1083 CommandInterpreter::GetCommandObject(llvm::StringRef cmd_str, 1084 StringList *matches, 1085 StringList *descriptions) const { 1086 CommandObject *command_obj = 1087 GetCommandSP(cmd_str, false, true, matches, descriptions).get(); 1088 1089 // If we didn't find an exact match to the command string in the commands, 1090 // look in the aliases. 1091 1092 if (command_obj) 1093 return command_obj; 1094 1095 command_obj = GetCommandSP(cmd_str, true, true, matches, descriptions).get(); 1096 1097 if (command_obj) 1098 return command_obj; 1099 1100 // If there wasn't an exact match then look for an inexact one in just the 1101 // commands 1102 command_obj = GetCommandSP(cmd_str, false, false, nullptr).get(); 1103 1104 // Finally, if there wasn't an inexact match among the commands, look for an 1105 // inexact match in both the commands and aliases. 1106 1107 if (command_obj) { 1108 if (matches) 1109 matches->AppendString(command_obj->GetCommandName()); 1110 if (descriptions) 1111 descriptions->AppendString(command_obj->GetHelp()); 1112 return command_obj; 1113 } 1114 1115 return GetCommandSP(cmd_str, true, false, matches, descriptions).get(); 1116 } 1117 1118 bool CommandInterpreter::CommandExists(llvm::StringRef cmd) const { 1119 return m_command_dict.find(std::string(cmd)) != m_command_dict.end(); 1120 } 1121 1122 bool CommandInterpreter::GetAliasFullName(llvm::StringRef cmd, 1123 std::string &full_name) const { 1124 bool exact_match = 1125 (m_alias_dict.find(std::string(cmd)) != m_alias_dict.end()); 1126 if (exact_match) { 1127 full_name.assign(std::string(cmd)); 1128 return exact_match; 1129 } else { 1130 StringList matches; 1131 size_t num_alias_matches; 1132 num_alias_matches = 1133 AddNamesMatchingPartialString(m_alias_dict, cmd, matches); 1134 if (num_alias_matches == 1) { 1135 // Make sure this isn't shadowing a command in the regular command space: 1136 StringList regular_matches; 1137 const bool include_aliases = false; 1138 const bool exact = false; 1139 CommandObjectSP cmd_obj_sp( 1140 GetCommandSP(cmd, include_aliases, exact, ®ular_matches)); 1141 if (cmd_obj_sp || regular_matches.GetSize() > 0) 1142 return false; 1143 else { 1144 full_name.assign(matches.GetStringAtIndex(0)); 1145 return true; 1146 } 1147 } else 1148 return false; 1149 } 1150 } 1151 1152 bool CommandInterpreter::AliasExists(llvm::StringRef cmd) const { 1153 return m_alias_dict.find(std::string(cmd)) != m_alias_dict.end(); 1154 } 1155 1156 bool CommandInterpreter::UserCommandExists(llvm::StringRef cmd) const { 1157 return m_user_dict.find(std::string(cmd)) != m_user_dict.end(); 1158 } 1159 1160 CommandAlias * 1161 CommandInterpreter::AddAlias(llvm::StringRef alias_name, 1162 lldb::CommandObjectSP &command_obj_sp, 1163 llvm::StringRef args_string) { 1164 if (command_obj_sp.get()) 1165 lldbassert((this == &command_obj_sp->GetCommandInterpreter()) && 1166 "tried to add a CommandObject from a different interpreter"); 1167 1168 std::unique_ptr<CommandAlias> command_alias_up( 1169 new CommandAlias(*this, command_obj_sp, args_string, alias_name)); 1170 1171 if (command_alias_up && command_alias_up->IsValid()) { 1172 m_alias_dict[std::string(alias_name)] = 1173 CommandObjectSP(command_alias_up.get()); 1174 return command_alias_up.release(); 1175 } 1176 1177 return nullptr; 1178 } 1179 1180 bool CommandInterpreter::RemoveAlias(llvm::StringRef alias_name) { 1181 auto pos = m_alias_dict.find(std::string(alias_name)); 1182 if (pos != m_alias_dict.end()) { 1183 m_alias_dict.erase(pos); 1184 return true; 1185 } 1186 return false; 1187 } 1188 1189 bool CommandInterpreter::RemoveCommand(llvm::StringRef cmd) { 1190 auto pos = m_command_dict.find(std::string(cmd)); 1191 if (pos != m_command_dict.end()) { 1192 if (pos->second->IsRemovable()) { 1193 // Only regular expression objects or python commands are removable 1194 m_command_dict.erase(pos); 1195 return true; 1196 } 1197 } 1198 return false; 1199 } 1200 bool CommandInterpreter::RemoveUser(llvm::StringRef alias_name) { 1201 CommandObject::CommandMap::iterator pos = 1202 m_user_dict.find(std::string(alias_name)); 1203 if (pos != m_user_dict.end()) { 1204 m_user_dict.erase(pos); 1205 return true; 1206 } 1207 return false; 1208 } 1209 1210 void CommandInterpreter::GetHelp(CommandReturnObject &result, 1211 uint32_t cmd_types) { 1212 llvm::StringRef help_prologue(GetDebugger().GetIOHandlerHelpPrologue()); 1213 if (!help_prologue.empty()) { 1214 OutputFormattedHelpText(result.GetOutputStream(), llvm::StringRef(), 1215 help_prologue); 1216 } 1217 1218 CommandObject::CommandMap::const_iterator pos; 1219 size_t max_len = FindLongestCommandWord(m_command_dict); 1220 1221 if ((cmd_types & eCommandTypesBuiltin) == eCommandTypesBuiltin) { 1222 result.AppendMessage("Debugger commands:"); 1223 result.AppendMessage(""); 1224 1225 for (pos = m_command_dict.begin(); pos != m_command_dict.end(); ++pos) { 1226 if (!(cmd_types & eCommandTypesHidden) && 1227 (pos->first.compare(0, 1, "_") == 0)) 1228 continue; 1229 1230 OutputFormattedHelpText(result.GetOutputStream(), pos->first, "--", 1231 pos->second->GetHelp(), max_len); 1232 } 1233 result.AppendMessage(""); 1234 } 1235 1236 if (!m_alias_dict.empty() && 1237 ((cmd_types & eCommandTypesAliases) == eCommandTypesAliases)) { 1238 result.AppendMessageWithFormat( 1239 "Current command abbreviations " 1240 "(type '%shelp command alias' for more info):\n", 1241 GetCommandPrefix()); 1242 result.AppendMessage(""); 1243 max_len = FindLongestCommandWord(m_alias_dict); 1244 1245 for (auto alias_pos = m_alias_dict.begin(); alias_pos != m_alias_dict.end(); 1246 ++alias_pos) { 1247 OutputFormattedHelpText(result.GetOutputStream(), alias_pos->first, "--", 1248 alias_pos->second->GetHelp(), max_len); 1249 } 1250 result.AppendMessage(""); 1251 } 1252 1253 if (!m_user_dict.empty() && 1254 ((cmd_types & eCommandTypesUserDef) == eCommandTypesUserDef)) { 1255 result.AppendMessage("Current user-defined commands:"); 1256 result.AppendMessage(""); 1257 max_len = FindLongestCommandWord(m_user_dict); 1258 for (pos = m_user_dict.begin(); pos != m_user_dict.end(); ++pos) { 1259 OutputFormattedHelpText(result.GetOutputStream(), pos->first, "--", 1260 pos->second->GetHelp(), max_len); 1261 } 1262 result.AppendMessage(""); 1263 } 1264 1265 result.AppendMessageWithFormat( 1266 "For more information on any command, type '%shelp <command-name>'.\n", 1267 GetCommandPrefix()); 1268 } 1269 1270 CommandObject *CommandInterpreter::GetCommandObjectForCommand( 1271 llvm::StringRef &command_string) { 1272 // This function finds the final, lowest-level, alias-resolved command object 1273 // whose 'Execute' function will eventually be invoked by the given command 1274 // line. 1275 1276 CommandObject *cmd_obj = nullptr; 1277 size_t start = command_string.find_first_not_of(k_white_space); 1278 size_t end = 0; 1279 bool done = false; 1280 while (!done) { 1281 if (start != std::string::npos) { 1282 // Get the next word from command_string. 1283 end = command_string.find_first_of(k_white_space, start); 1284 if (end == std::string::npos) 1285 end = command_string.size(); 1286 std::string cmd_word = 1287 std::string(command_string.substr(start, end - start)); 1288 1289 if (cmd_obj == nullptr) 1290 // Since cmd_obj is NULL we are on our first time through this loop. 1291 // Check to see if cmd_word is a valid command or alias. 1292 cmd_obj = GetCommandObject(cmd_word); 1293 else if (cmd_obj->IsMultiwordObject()) { 1294 // Our current object is a multi-word object; see if the cmd_word is a 1295 // valid sub-command for our object. 1296 CommandObject *sub_cmd_obj = 1297 cmd_obj->GetSubcommandObject(cmd_word.c_str()); 1298 if (sub_cmd_obj) 1299 cmd_obj = sub_cmd_obj; 1300 else // cmd_word was not a valid sub-command word, so we are done 1301 done = true; 1302 } else 1303 // We have a cmd_obj and it is not a multi-word object, so we are done. 1304 done = true; 1305 1306 // If we didn't find a valid command object, or our command object is not 1307 // a multi-word object, or we are at the end of the command_string, then 1308 // we are done. Otherwise, find the start of the next word. 1309 1310 if (!cmd_obj || !cmd_obj->IsMultiwordObject() || 1311 end >= command_string.size()) 1312 done = true; 1313 else 1314 start = command_string.find_first_not_of(k_white_space, end); 1315 } else 1316 // Unable to find any more words. 1317 done = true; 1318 } 1319 1320 command_string = command_string.substr(end); 1321 return cmd_obj; 1322 } 1323 1324 static const char *k_valid_command_chars = 1325 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"; 1326 static void StripLeadingSpaces(std::string &s) { 1327 if (!s.empty()) { 1328 size_t pos = s.find_first_not_of(k_white_space); 1329 if (pos == std::string::npos) 1330 s.clear(); 1331 else if (pos == 0) 1332 return; 1333 s.erase(0, pos); 1334 } 1335 } 1336 1337 static size_t FindArgumentTerminator(const std::string &s) { 1338 const size_t s_len = s.size(); 1339 size_t offset = 0; 1340 while (offset < s_len) { 1341 size_t pos = s.find("--", offset); 1342 if (pos == std::string::npos) 1343 break; 1344 if (pos > 0) { 1345 if (llvm::isSpace(s[pos - 1])) { 1346 // Check if the string ends "\s--" (where \s is a space character) or 1347 // if we have "\s--\s". 1348 if ((pos + 2 >= s_len) || llvm::isSpace(s[pos + 2])) { 1349 return pos; 1350 } 1351 } 1352 } 1353 offset = pos + 2; 1354 } 1355 return std::string::npos; 1356 } 1357 1358 static bool ExtractCommand(std::string &command_string, std::string &command, 1359 std::string &suffix, char "e_char) { 1360 command.clear(); 1361 suffix.clear(); 1362 StripLeadingSpaces(command_string); 1363 1364 bool result = false; 1365 quote_char = '\0'; 1366 1367 if (!command_string.empty()) { 1368 const char first_char = command_string[0]; 1369 if (first_char == '\'' || first_char == '"') { 1370 quote_char = first_char; 1371 const size_t end_quote_pos = command_string.find(quote_char, 1); 1372 if (end_quote_pos == std::string::npos) { 1373 command.swap(command_string); 1374 command_string.erase(); 1375 } else { 1376 command.assign(command_string, 1, end_quote_pos - 1); 1377 if (end_quote_pos + 1 < command_string.size()) 1378 command_string.erase(0, command_string.find_first_not_of( 1379 k_white_space, end_quote_pos + 1)); 1380 else 1381 command_string.erase(); 1382 } 1383 } else { 1384 const size_t first_space_pos = 1385 command_string.find_first_of(k_white_space); 1386 if (first_space_pos == std::string::npos) { 1387 command.swap(command_string); 1388 command_string.erase(); 1389 } else { 1390 command.assign(command_string, 0, first_space_pos); 1391 command_string.erase(0, command_string.find_first_not_of( 1392 k_white_space, first_space_pos)); 1393 } 1394 } 1395 result = true; 1396 } 1397 1398 if (!command.empty()) { 1399 // actual commands can't start with '-' or '_' 1400 if (command[0] != '-' && command[0] != '_') { 1401 size_t pos = command.find_first_not_of(k_valid_command_chars); 1402 if (pos > 0 && pos != std::string::npos) { 1403 suffix.assign(command.begin() + pos, command.end()); 1404 command.erase(pos); 1405 } 1406 } 1407 } 1408 1409 return result; 1410 } 1411 1412 CommandObject *CommandInterpreter::BuildAliasResult( 1413 llvm::StringRef alias_name, std::string &raw_input_string, 1414 std::string &alias_result, CommandReturnObject &result) { 1415 CommandObject *alias_cmd_obj = nullptr; 1416 Args cmd_args(raw_input_string); 1417 alias_cmd_obj = GetCommandObject(alias_name); 1418 StreamString result_str; 1419 1420 if (!alias_cmd_obj || !alias_cmd_obj->IsAlias()) { 1421 alias_result.clear(); 1422 return alias_cmd_obj; 1423 } 1424 std::pair<CommandObjectSP, OptionArgVectorSP> desugared = 1425 ((CommandAlias *)alias_cmd_obj)->Desugar(); 1426 OptionArgVectorSP option_arg_vector_sp = desugared.second; 1427 alias_cmd_obj = desugared.first.get(); 1428 std::string alias_name_str = std::string(alias_name); 1429 if ((cmd_args.GetArgumentCount() == 0) || 1430 (alias_name_str != cmd_args.GetArgumentAtIndex(0))) 1431 cmd_args.Unshift(alias_name_str); 1432 1433 result_str.Printf("%s", alias_cmd_obj->GetCommandName().str().c_str()); 1434 1435 if (!option_arg_vector_sp.get()) { 1436 alias_result = std::string(result_str.GetString()); 1437 return alias_cmd_obj; 1438 } 1439 OptionArgVector *option_arg_vector = option_arg_vector_sp.get(); 1440 1441 int value_type; 1442 std::string option; 1443 std::string value; 1444 for (const auto &entry : *option_arg_vector) { 1445 std::tie(option, value_type, value) = entry; 1446 if (option == "<argument>") { 1447 result_str.Printf(" %s", value.c_str()); 1448 continue; 1449 } 1450 1451 result_str.Printf(" %s", option.c_str()); 1452 if (value_type == OptionParser::eNoArgument) 1453 continue; 1454 1455 if (value_type != OptionParser::eOptionalArgument) 1456 result_str.Printf(" "); 1457 int index = GetOptionArgumentPosition(value.c_str()); 1458 if (index == 0) 1459 result_str.Printf("%s", value.c_str()); 1460 else if (static_cast<size_t>(index) >= cmd_args.GetArgumentCount()) { 1461 1462 result.AppendErrorWithFormat("Not enough arguments provided; you " 1463 "need at least %d arguments to use " 1464 "this alias.\n", 1465 index); 1466 result.SetStatus(eReturnStatusFailed); 1467 return nullptr; 1468 } else { 1469 size_t strpos = raw_input_string.find(cmd_args.GetArgumentAtIndex(index)); 1470 if (strpos != std::string::npos) 1471 raw_input_string = raw_input_string.erase( 1472 strpos, strlen(cmd_args.GetArgumentAtIndex(index))); 1473 result_str.Printf("%s", cmd_args.GetArgumentAtIndex(index)); 1474 } 1475 } 1476 1477 alias_result = std::string(result_str.GetString()); 1478 return alias_cmd_obj; 1479 } 1480 1481 Status CommandInterpreter::PreprocessCommand(std::string &command) { 1482 // The command preprocessor needs to do things to the command line before any 1483 // parsing of arguments or anything else is done. The only current stuff that 1484 // gets preprocessed is anything enclosed in backtick ('`') characters is 1485 // evaluated as an expression and the result of the expression must be a 1486 // scalar that can be substituted into the command. An example would be: 1487 // (lldb) memory read `$rsp + 20` 1488 Status error; // Status for any expressions that might not evaluate 1489 size_t start_backtick; 1490 size_t pos = 0; 1491 while ((start_backtick = command.find('`', pos)) != std::string::npos) { 1492 // Stop if an error was encountered during the previous iteration. 1493 if (error.Fail()) 1494 break; 1495 1496 if (start_backtick > 0 && command[start_backtick - 1] == '\\') { 1497 // The backtick was preceded by a '\' character, remove the slash and 1498 // don't treat the backtick as the start of an expression. 1499 command.erase(start_backtick - 1, 1); 1500 // No need to add one to start_backtick since we just deleted a char. 1501 pos = start_backtick; 1502 continue; 1503 } 1504 1505 const size_t expr_content_start = start_backtick + 1; 1506 const size_t end_backtick = command.find('`', expr_content_start); 1507 1508 if (end_backtick == std::string::npos) { 1509 // Stop if there's no end backtick. 1510 break; 1511 } 1512 1513 if (end_backtick == expr_content_start) { 1514 // Skip over empty expression. (two backticks in a row) 1515 command.erase(start_backtick, 2); 1516 continue; 1517 } 1518 1519 std::string expr_str(command, expr_content_start, 1520 end_backtick - expr_content_start); 1521 1522 ExecutionContext exe_ctx(GetExecutionContext()); 1523 Target *target = exe_ctx.GetTargetPtr(); 1524 1525 // Get a dummy target to allow for calculator mode while processing 1526 // backticks. This also helps break the infinite loop caused when target is 1527 // null. 1528 if (!target) 1529 target = m_debugger.GetDummyTarget(); 1530 1531 if (!target) 1532 continue; 1533 1534 ValueObjectSP expr_result_valobj_sp; 1535 1536 EvaluateExpressionOptions options; 1537 options.SetCoerceToId(false); 1538 options.SetUnwindOnError(true); 1539 options.SetIgnoreBreakpoints(true); 1540 options.SetKeepInMemory(false); 1541 options.SetTryAllThreads(true); 1542 options.SetTimeout(llvm::None); 1543 1544 ExpressionResults expr_result = 1545 target->EvaluateExpression(expr_str.c_str(), exe_ctx.GetFramePtr(), 1546 expr_result_valobj_sp, options); 1547 1548 if (expr_result == eExpressionCompleted) { 1549 Scalar scalar; 1550 if (expr_result_valobj_sp) 1551 expr_result_valobj_sp = 1552 expr_result_valobj_sp->GetQualifiedRepresentationIfAvailable( 1553 expr_result_valobj_sp->GetDynamicValueType(), true); 1554 if (expr_result_valobj_sp->ResolveValue(scalar)) { 1555 command.erase(start_backtick, end_backtick - start_backtick + 1); 1556 StreamString value_strm; 1557 const bool show_type = false; 1558 scalar.GetValue(&value_strm, show_type); 1559 size_t value_string_size = value_strm.GetSize(); 1560 if (value_string_size) { 1561 command.insert(start_backtick, std::string(value_strm.GetString())); 1562 pos = start_backtick + value_string_size; 1563 continue; 1564 } else { 1565 error.SetErrorStringWithFormat("expression value didn't result " 1566 "in a scalar value for the " 1567 "expression '%s'", 1568 expr_str.c_str()); 1569 break; 1570 } 1571 } else { 1572 error.SetErrorStringWithFormat("expression value didn't result " 1573 "in a scalar value for the " 1574 "expression '%s'", 1575 expr_str.c_str()); 1576 break; 1577 } 1578 1579 continue; 1580 } 1581 1582 if (expr_result_valobj_sp) 1583 error = expr_result_valobj_sp->GetError(); 1584 1585 if (error.Success()) { 1586 switch (expr_result) { 1587 case eExpressionSetupError: 1588 error.SetErrorStringWithFormat( 1589 "expression setup error for the expression '%s'", expr_str.c_str()); 1590 break; 1591 case eExpressionParseError: 1592 error.SetErrorStringWithFormat( 1593 "expression parse error for the expression '%s'", expr_str.c_str()); 1594 break; 1595 case eExpressionResultUnavailable: 1596 error.SetErrorStringWithFormat( 1597 "expression error fetching result for the expression '%s'", 1598 expr_str.c_str()); 1599 break; 1600 case eExpressionCompleted: 1601 break; 1602 case eExpressionDiscarded: 1603 error.SetErrorStringWithFormat( 1604 "expression discarded for the expression '%s'", expr_str.c_str()); 1605 break; 1606 case eExpressionInterrupted: 1607 error.SetErrorStringWithFormat( 1608 "expression interrupted for the expression '%s'", expr_str.c_str()); 1609 break; 1610 case eExpressionHitBreakpoint: 1611 error.SetErrorStringWithFormat( 1612 "expression hit breakpoint for the expression '%s'", 1613 expr_str.c_str()); 1614 break; 1615 case eExpressionTimedOut: 1616 error.SetErrorStringWithFormat( 1617 "expression timed out for the expression '%s'", expr_str.c_str()); 1618 break; 1619 case eExpressionStoppedForDebug: 1620 error.SetErrorStringWithFormat("expression stop at entry point " 1621 "for debugging for the " 1622 "expression '%s'", 1623 expr_str.c_str()); 1624 break; 1625 case eExpressionThreadVanished: 1626 error.SetErrorStringWithFormat( 1627 "expression thread vanished for the expression '%s'", 1628 expr_str.c_str()); 1629 break; 1630 } 1631 } 1632 } 1633 return error; 1634 } 1635 1636 bool CommandInterpreter::HandleCommand(const char *command_line, 1637 LazyBool lazy_add_to_history, 1638 CommandReturnObject &result, 1639 ExecutionContext *override_context, 1640 bool repeat_on_empty_command, 1641 bool no_context_switching) 1642 1643 { 1644 1645 std::string command_string(command_line); 1646 std::string original_command_string(command_line); 1647 1648 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_COMMANDS)); 1649 llvm::PrettyStackTraceFormat stack_trace("HandleCommand(command = \"%s\")", 1650 command_line); 1651 1652 LLDB_LOGF(log, "Processing command: %s", command_line); 1653 1654 static Timer::Category func_cat(LLVM_PRETTY_FUNCTION); 1655 Timer scoped_timer(func_cat, "Handling command: %s.", command_line); 1656 1657 if (!no_context_switching) 1658 UpdateExecutionContext(override_context); 1659 1660 if (WasInterrupted()) { 1661 result.AppendError("interrupted"); 1662 result.SetStatus(eReturnStatusFailed); 1663 return false; 1664 } 1665 1666 bool add_to_history; 1667 if (lazy_add_to_history == eLazyBoolCalculate) 1668 add_to_history = (m_command_source_depth == 0); 1669 else 1670 add_to_history = (lazy_add_to_history == eLazyBoolYes); 1671 1672 m_transcript_stream << "(lldb) " << command_line << '\n'; 1673 1674 bool empty_command = false; 1675 bool comment_command = false; 1676 if (command_string.empty()) 1677 empty_command = true; 1678 else { 1679 const char *k_space_characters = "\t\n\v\f\r "; 1680 1681 size_t non_space = command_string.find_first_not_of(k_space_characters); 1682 // Check for empty line or comment line (lines whose first non-space 1683 // character is the comment character for this interpreter) 1684 if (non_space == std::string::npos) 1685 empty_command = true; 1686 else if (command_string[non_space] == m_comment_char) 1687 comment_command = true; 1688 else if (command_string[non_space] == CommandHistory::g_repeat_char) { 1689 llvm::StringRef search_str(command_string); 1690 search_str = search_str.drop_front(non_space); 1691 if (auto hist_str = m_command_history.FindString(search_str)) { 1692 add_to_history = false; 1693 command_string = std::string(*hist_str); 1694 original_command_string = std::string(*hist_str); 1695 } else { 1696 result.AppendErrorWithFormat("Could not find entry: %s in history", 1697 command_string.c_str()); 1698 result.SetStatus(eReturnStatusFailed); 1699 return false; 1700 } 1701 } 1702 } 1703 1704 if (empty_command) { 1705 if (repeat_on_empty_command) { 1706 if (m_command_history.IsEmpty()) { 1707 result.AppendError("empty command"); 1708 result.SetStatus(eReturnStatusFailed); 1709 return false; 1710 } else { 1711 command_line = m_repeat_command.c_str(); 1712 command_string = command_line; 1713 original_command_string = command_line; 1714 if (m_repeat_command.empty()) { 1715 result.AppendError("No auto repeat."); 1716 result.SetStatus(eReturnStatusFailed); 1717 return false; 1718 } 1719 } 1720 add_to_history = false; 1721 } else { 1722 result.SetStatus(eReturnStatusSuccessFinishNoResult); 1723 return true; 1724 } 1725 } else if (comment_command) { 1726 result.SetStatus(eReturnStatusSuccessFinishNoResult); 1727 return true; 1728 } 1729 1730 Status error(PreprocessCommand(command_string)); 1731 1732 if (error.Fail()) { 1733 result.AppendError(error.AsCString()); 1734 result.SetStatus(eReturnStatusFailed); 1735 return false; 1736 } 1737 1738 // Phase 1. 1739 1740 // Before we do ANY kind of argument processing, we need to figure out what 1741 // the real/final command object is for the specified command. This gets 1742 // complicated by the fact that the user could have specified an alias, and, 1743 // in translating the alias, there may also be command options and/or even 1744 // data (including raw text strings) that need to be found and inserted into 1745 // the command line as part of the translation. So this first step is plain 1746 // look-up and replacement, resulting in: 1747 // 1. the command object whose Execute method will actually be called 1748 // 2. a revised command string, with all substitutions and replacements 1749 // taken care of 1750 // From 1 above, we can determine whether the Execute function wants raw 1751 // input or not. 1752 1753 CommandObject *cmd_obj = ResolveCommandImpl(command_string, result); 1754 1755 // Although the user may have abbreviated the command, the command_string now 1756 // has the command expanded to the full name. For example, if the input was 1757 // "br s -n main", command_string is now "breakpoint set -n main". 1758 if (log) { 1759 llvm::StringRef command_name = cmd_obj ? cmd_obj->GetCommandName() : "<not found>"; 1760 LLDB_LOGF(log, "HandleCommand, cmd_obj : '%s'", command_name.str().c_str()); 1761 LLDB_LOGF(log, "HandleCommand, (revised) command_string: '%s'", 1762 command_string.c_str()); 1763 const bool wants_raw_input = 1764 (cmd_obj != nullptr) ? cmd_obj->WantsRawCommandString() : false; 1765 LLDB_LOGF(log, "HandleCommand, wants_raw_input:'%s'", 1766 wants_raw_input ? "True" : "False"); 1767 } 1768 1769 // Phase 2. 1770 // Take care of things like setting up the history command & calling the 1771 // appropriate Execute method on the CommandObject, with the appropriate 1772 // arguments. 1773 1774 if (cmd_obj != nullptr) { 1775 if (add_to_history) { 1776 Args command_args(command_string); 1777 const char *repeat_command = cmd_obj->GetRepeatCommand(command_args, 0); 1778 if (repeat_command != nullptr) 1779 m_repeat_command.assign(repeat_command); 1780 else 1781 m_repeat_command.assign(original_command_string); 1782 1783 m_command_history.AppendString(original_command_string); 1784 } 1785 1786 std::string remainder; 1787 const std::size_t actual_cmd_name_len = cmd_obj->GetCommandName().size(); 1788 if (actual_cmd_name_len < command_string.length()) 1789 remainder = command_string.substr(actual_cmd_name_len); 1790 1791 // Remove any initial spaces 1792 size_t pos = remainder.find_first_not_of(k_white_space); 1793 if (pos != 0 && pos != std::string::npos) 1794 remainder.erase(0, pos); 1795 1796 LLDB_LOGF( 1797 log, "HandleCommand, command line after removing command name(s): '%s'", 1798 remainder.c_str()); 1799 1800 cmd_obj->Execute(remainder.c_str(), result); 1801 } 1802 1803 LLDB_LOGF(log, "HandleCommand, command %s", 1804 (result.Succeeded() ? "succeeded" : "did not succeed")); 1805 1806 m_transcript_stream << result.GetOutputData(); 1807 m_transcript_stream << result.GetErrorData(); 1808 1809 return result.Succeeded(); 1810 } 1811 1812 void CommandInterpreter::HandleCompletionMatches(CompletionRequest &request) { 1813 bool look_for_subcommand = false; 1814 1815 // For any of the command completions a unique match will be a complete word. 1816 1817 if (request.GetParsedLine().GetArgumentCount() == 0) { 1818 // We got nothing on the command line, so return the list of commands 1819 bool include_aliases = true; 1820 StringList new_matches, descriptions; 1821 GetCommandNamesMatchingPartialString("", include_aliases, new_matches, 1822 descriptions); 1823 request.AddCompletions(new_matches, descriptions); 1824 } else if (request.GetCursorIndex() == 0) { 1825 // The cursor is in the first argument, so just do a lookup in the 1826 // dictionary. 1827 StringList new_matches, new_descriptions; 1828 CommandObject *cmd_obj = 1829 GetCommandObject(request.GetParsedLine().GetArgumentAtIndex(0), 1830 &new_matches, &new_descriptions); 1831 1832 if (new_matches.GetSize() && cmd_obj && cmd_obj->IsMultiwordObject() && 1833 new_matches.GetStringAtIndex(0) != nullptr && 1834 strcmp(request.GetParsedLine().GetArgumentAtIndex(0), 1835 new_matches.GetStringAtIndex(0)) == 0) { 1836 if (request.GetParsedLine().GetArgumentCount() != 1) { 1837 look_for_subcommand = true; 1838 new_matches.DeleteStringAtIndex(0); 1839 new_descriptions.DeleteStringAtIndex(0); 1840 request.AppendEmptyArgument(); 1841 } 1842 } 1843 request.AddCompletions(new_matches, new_descriptions); 1844 } 1845 1846 if (request.GetCursorIndex() > 0 || look_for_subcommand) { 1847 // We are completing further on into a commands arguments, so find the 1848 // command and tell it to complete the command. First see if there is a 1849 // matching initial command: 1850 CommandObject *command_object = 1851 GetCommandObject(request.GetParsedLine().GetArgumentAtIndex(0)); 1852 if (command_object) { 1853 request.ShiftArguments(); 1854 command_object->HandleCompletion(request); 1855 } 1856 } 1857 } 1858 1859 void CommandInterpreter::HandleCompletion(CompletionRequest &request) { 1860 1861 UpdateExecutionContext(nullptr); 1862 1863 // Don't complete comments, and if the line we are completing is just the 1864 // history repeat character, substitute the appropriate history line. 1865 llvm::StringRef first_arg = request.GetParsedLine().GetArgumentAtIndex(0); 1866 1867 if (!first_arg.empty()) { 1868 if (first_arg.front() == m_comment_char) 1869 return; 1870 if (first_arg.front() == CommandHistory::g_repeat_char) { 1871 if (auto hist_str = m_command_history.FindString(first_arg)) 1872 request.AddCompletion(*hist_str, "Previous command history event", 1873 CompletionMode::RewriteLine); 1874 return; 1875 } 1876 } 1877 1878 HandleCompletionMatches(request); 1879 } 1880 1881 llvm::Optional<std::string> 1882 CommandInterpreter::GetAutoSuggestionForCommand(llvm::StringRef line) { 1883 if (line.empty()) 1884 return llvm::None; 1885 const size_t s = m_command_history.GetSize(); 1886 for (int i = s - 1; i >= 0; --i) { 1887 llvm::StringRef entry = m_command_history.GetStringAtIndex(i); 1888 if (entry.consume_front(line)) 1889 return entry.str(); 1890 } 1891 return llvm::None; 1892 } 1893 1894 CommandInterpreter::~CommandInterpreter() {} 1895 1896 void CommandInterpreter::UpdatePrompt(llvm::StringRef new_prompt) { 1897 EventSP prompt_change_event_sp( 1898 new Event(eBroadcastBitResetPrompt, new EventDataBytes(new_prompt))); 1899 ; 1900 BroadcastEvent(prompt_change_event_sp); 1901 if (m_command_io_handler_sp) 1902 m_command_io_handler_sp->SetPrompt(new_prompt); 1903 } 1904 1905 bool CommandInterpreter::Confirm(llvm::StringRef message, bool default_answer) { 1906 // Check AutoConfirm first: 1907 if (m_debugger.GetAutoConfirm()) 1908 return default_answer; 1909 1910 IOHandlerConfirm *confirm = 1911 new IOHandlerConfirm(m_debugger, message, default_answer); 1912 IOHandlerSP io_handler_sp(confirm); 1913 m_debugger.RunIOHandlerSync(io_handler_sp); 1914 return confirm->GetResponse(); 1915 } 1916 1917 const CommandAlias * 1918 CommandInterpreter::GetAlias(llvm::StringRef alias_name) const { 1919 OptionArgVectorSP ret_val; 1920 1921 auto pos = m_alias_dict.find(std::string(alias_name)); 1922 if (pos != m_alias_dict.end()) 1923 return (CommandAlias *)pos->second.get(); 1924 1925 return nullptr; 1926 } 1927 1928 bool CommandInterpreter::HasCommands() const { return (!m_command_dict.empty()); } 1929 1930 bool CommandInterpreter::HasAliases() const { return (!m_alias_dict.empty()); } 1931 1932 bool CommandInterpreter::HasUserCommands() const { return (!m_user_dict.empty()); } 1933 1934 bool CommandInterpreter::HasAliasOptions() const { return HasAliases(); } 1935 1936 void CommandInterpreter::BuildAliasCommandArgs(CommandObject *alias_cmd_obj, 1937 const char *alias_name, 1938 Args &cmd_args, 1939 std::string &raw_input_string, 1940 CommandReturnObject &result) { 1941 OptionArgVectorSP option_arg_vector_sp = 1942 GetAlias(alias_name)->GetOptionArguments(); 1943 1944 bool wants_raw_input = alias_cmd_obj->WantsRawCommandString(); 1945 1946 // Make sure that the alias name is the 0th element in cmd_args 1947 std::string alias_name_str = alias_name; 1948 if (alias_name_str != cmd_args.GetArgumentAtIndex(0)) 1949 cmd_args.Unshift(alias_name_str); 1950 1951 Args new_args(alias_cmd_obj->GetCommandName()); 1952 if (new_args.GetArgumentCount() == 2) 1953 new_args.Shift(); 1954 1955 if (option_arg_vector_sp.get()) { 1956 if (wants_raw_input) { 1957 // We have a command that both has command options and takes raw input. 1958 // Make *sure* it has a " -- " in the right place in the 1959 // raw_input_string. 1960 size_t pos = raw_input_string.find(" -- "); 1961 if (pos == std::string::npos) { 1962 // None found; assume it goes at the beginning of the raw input string 1963 raw_input_string.insert(0, " -- "); 1964 } 1965 } 1966 1967 OptionArgVector *option_arg_vector = option_arg_vector_sp.get(); 1968 const size_t old_size = cmd_args.GetArgumentCount(); 1969 std::vector<bool> used(old_size + 1, false); 1970 1971 used[0] = true; 1972 1973 int value_type; 1974 std::string option; 1975 std::string value; 1976 for (const auto &option_entry : *option_arg_vector) { 1977 std::tie(option, value_type, value) = option_entry; 1978 if (option == "<argument>") { 1979 if (!wants_raw_input || (value != "--")) { 1980 // Since we inserted this above, make sure we don't insert it twice 1981 new_args.AppendArgument(value); 1982 } 1983 continue; 1984 } 1985 1986 if (value_type != OptionParser::eOptionalArgument) 1987 new_args.AppendArgument(option); 1988 1989 if (value == "<no-argument>") 1990 continue; 1991 1992 int index = GetOptionArgumentPosition(value.c_str()); 1993 if (index == 0) { 1994 // value was NOT a positional argument; must be a real value 1995 if (value_type != OptionParser::eOptionalArgument) 1996 new_args.AppendArgument(value); 1997 else { 1998 new_args.AppendArgument(option + value); 1999 } 2000 2001 } else if (static_cast<size_t>(index) >= cmd_args.GetArgumentCount()) { 2002 result.AppendErrorWithFormat("Not enough arguments provided; you " 2003 "need at least %d arguments to use " 2004 "this alias.\n", 2005 index); 2006 result.SetStatus(eReturnStatusFailed); 2007 return; 2008 } else { 2009 // Find and remove cmd_args.GetArgumentAtIndex(i) from raw_input_string 2010 size_t strpos = 2011 raw_input_string.find(cmd_args.GetArgumentAtIndex(index)); 2012 if (strpos != std::string::npos) { 2013 raw_input_string = raw_input_string.erase( 2014 strpos, strlen(cmd_args.GetArgumentAtIndex(index))); 2015 } 2016 2017 if (value_type != OptionParser::eOptionalArgument) 2018 new_args.AppendArgument(cmd_args.GetArgumentAtIndex(index)); 2019 else { 2020 new_args.AppendArgument(option + cmd_args.GetArgumentAtIndex(index)); 2021 } 2022 used[index] = true; 2023 } 2024 } 2025 2026 for (auto entry : llvm::enumerate(cmd_args.entries())) { 2027 if (!used[entry.index()] && !wants_raw_input) 2028 new_args.AppendArgument(entry.value().ref()); 2029 } 2030 2031 cmd_args.Clear(); 2032 cmd_args.SetArguments(new_args.GetArgumentCount(), 2033 new_args.GetConstArgumentVector()); 2034 } else { 2035 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2036 // This alias was not created with any options; nothing further needs to be 2037 // done, unless it is a command that wants raw input, in which case we need 2038 // to clear the rest of the data from cmd_args, since its in the raw input 2039 // string. 2040 if (wants_raw_input) { 2041 cmd_args.Clear(); 2042 cmd_args.SetArguments(new_args.GetArgumentCount(), 2043 new_args.GetConstArgumentVector()); 2044 } 2045 return; 2046 } 2047 2048 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2049 return; 2050 } 2051 2052 int CommandInterpreter::GetOptionArgumentPosition(const char *in_string) { 2053 int position = 0; // Any string that isn't an argument position, i.e. '%' 2054 // followed by an integer, gets a position 2055 // of zero. 2056 2057 const char *cptr = in_string; 2058 2059 // Does it start with '%' 2060 if (cptr[0] == '%') { 2061 ++cptr; 2062 2063 // Is the rest of it entirely digits? 2064 if (isdigit(cptr[0])) { 2065 const char *start = cptr; 2066 while (isdigit(cptr[0])) 2067 ++cptr; 2068 2069 // We've gotten to the end of the digits; are we at the end of the 2070 // string? 2071 if (cptr[0] == '\0') 2072 position = atoi(start); 2073 } 2074 } 2075 2076 return position; 2077 } 2078 2079 static void GetHomeInitFile(llvm::SmallVectorImpl<char> &init_file, 2080 llvm::StringRef suffix = {}) { 2081 std::string init_file_name = ".lldbinit"; 2082 if (!suffix.empty()) { 2083 init_file_name.append("-"); 2084 init_file_name.append(suffix.str()); 2085 } 2086 2087 FileSystem::Instance().GetHomeDirectory(init_file); 2088 llvm::sys::path::append(init_file, init_file_name); 2089 2090 FileSystem::Instance().Resolve(init_file); 2091 } 2092 2093 static void GetHomeREPLInitFile(llvm::SmallVectorImpl<char> &init_file, 2094 LanguageType language) { 2095 std::string init_file_name; 2096 2097 switch (language) { 2098 // TODO: Add support for a language used with a REPL. 2099 default: 2100 return; 2101 } 2102 2103 FileSystem::Instance().GetHomeDirectory(init_file); 2104 llvm::sys::path::append(init_file, init_file_name); 2105 2106 FileSystem::Instance().Resolve(init_file); 2107 } 2108 2109 static void GetCwdInitFile(llvm::SmallVectorImpl<char> &init_file) { 2110 llvm::StringRef s = ".lldbinit"; 2111 init_file.assign(s.begin(), s.end()); 2112 FileSystem::Instance().Resolve(init_file); 2113 } 2114 2115 static LoadCWDlldbinitFile ShouldLoadCwdInitFile() { 2116 lldb::TargetPropertiesSP properties = Target::GetGlobalProperties(); 2117 if (!properties) 2118 return eLoadCWDlldbinitFalse; 2119 return properties->GetLoadCWDlldbinitFile(); 2120 } 2121 2122 void CommandInterpreter::SourceInitFile(FileSpec file, 2123 CommandReturnObject &result) { 2124 assert(!m_skip_lldbinit_files); 2125 2126 if (!FileSystem::Instance().Exists(file)) { 2127 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2128 return; 2129 } 2130 2131 // Use HandleCommand to 'source' the given file; this will do the actual 2132 // broadcasting of the commands back to any appropriate listener (see 2133 // CommandObjectSource::Execute for more details). 2134 const bool saved_batch = SetBatchCommandMode(true); 2135 ExecutionContext *ctx = nullptr; 2136 CommandInterpreterRunOptions options; 2137 options.SetSilent(true); 2138 options.SetPrintErrors(true); 2139 options.SetStopOnError(false); 2140 options.SetStopOnContinue(true); 2141 HandleCommandsFromFile(file, ctx, options, result); 2142 SetBatchCommandMode(saved_batch); 2143 } 2144 2145 void CommandInterpreter::SourceInitFileCwd(CommandReturnObject &result) { 2146 if (m_skip_lldbinit_files) { 2147 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2148 return; 2149 } 2150 2151 llvm::SmallString<128> init_file; 2152 GetCwdInitFile(init_file); 2153 if (!FileSystem::Instance().Exists(init_file)) { 2154 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2155 return; 2156 } 2157 2158 LoadCWDlldbinitFile should_load = ShouldLoadCwdInitFile(); 2159 2160 switch (should_load) { 2161 case eLoadCWDlldbinitFalse: 2162 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2163 break; 2164 case eLoadCWDlldbinitTrue: 2165 SourceInitFile(FileSpec(init_file.str()), result); 2166 break; 2167 case eLoadCWDlldbinitWarn: { 2168 llvm::SmallString<128> home_init_file; 2169 GetHomeInitFile(home_init_file); 2170 if (llvm::sys::path::parent_path(init_file) == 2171 llvm::sys::path::parent_path(home_init_file)) { 2172 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2173 } else { 2174 result.AppendError(InitFileWarning); 2175 result.SetStatus(eReturnStatusFailed); 2176 } 2177 } 2178 } 2179 } 2180 2181 /// We will first see if there is an application specific ".lldbinit" file 2182 /// whose name is "~/.lldbinit" followed by a "-" and the name of the program. 2183 /// If this file doesn't exist, we fall back to the REPL init file or the 2184 /// default home init file in "~/.lldbinit". 2185 void CommandInterpreter::SourceInitFileHome(CommandReturnObject &result, 2186 bool is_repl) { 2187 if (m_skip_lldbinit_files) { 2188 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2189 return; 2190 } 2191 2192 llvm::SmallString<128> init_file; 2193 2194 if (is_repl) { 2195 LanguageType language = {}; 2196 TargetSP target_sp = GetDebugger().GetSelectedTarget(); 2197 if (target_sp) 2198 language = target_sp->GetLanguage(); 2199 GetHomeREPLInitFile(init_file, language); 2200 } 2201 2202 if (init_file.empty()) 2203 GetHomeInitFile(init_file); 2204 2205 if (!m_skip_app_init_files) { 2206 llvm::StringRef program_name = 2207 HostInfo::GetProgramFileSpec().GetFilename().GetStringRef(); 2208 llvm::SmallString<128> program_init_file; 2209 GetHomeInitFile(program_init_file, program_name); 2210 if (FileSystem::Instance().Exists(program_init_file)) 2211 init_file = program_init_file; 2212 } 2213 2214 SourceInitFile(FileSpec(init_file.str()), result); 2215 } 2216 2217 const char *CommandInterpreter::GetCommandPrefix() { 2218 const char *prefix = GetDebugger().GetIOHandlerCommandPrefix(); 2219 return prefix == nullptr ? "" : prefix; 2220 } 2221 2222 PlatformSP CommandInterpreter::GetPlatform(bool prefer_target_platform) { 2223 PlatformSP platform_sp; 2224 if (prefer_target_platform) { 2225 ExecutionContext exe_ctx(GetExecutionContext()); 2226 Target *target = exe_ctx.GetTargetPtr(); 2227 if (target) 2228 platform_sp = target->GetPlatform(); 2229 } 2230 2231 if (!platform_sp) 2232 platform_sp = m_debugger.GetPlatformList().GetSelectedPlatform(); 2233 return platform_sp; 2234 } 2235 2236 bool CommandInterpreter::DidProcessStopAbnormally() const { 2237 TargetSP target_sp = m_debugger.GetTargetList().GetSelectedTarget(); 2238 if (!target_sp) 2239 return false; 2240 2241 ProcessSP process_sp(target_sp->GetProcessSP()); 2242 if (!process_sp) 2243 return false; 2244 2245 if (eStateStopped != process_sp->GetState()) 2246 return false; 2247 2248 for (const auto &thread_sp : process_sp->GetThreadList().Threads()) { 2249 StopInfoSP stop_info = thread_sp->GetStopInfo(); 2250 if (!stop_info) 2251 return false; 2252 2253 const StopReason reason = stop_info->GetStopReason(); 2254 if (reason == eStopReasonException || reason == eStopReasonInstrumentation) 2255 return true; 2256 2257 if (reason == eStopReasonSignal) { 2258 const auto stop_signal = static_cast<int32_t>(stop_info->GetValue()); 2259 UnixSignalsSP signals_sp = process_sp->GetUnixSignals(); 2260 if (!signals_sp || !signals_sp->SignalIsValid(stop_signal)) 2261 // The signal is unknown, treat it as abnormal. 2262 return true; 2263 2264 const auto sigint_num = signals_sp->GetSignalNumberFromName("SIGINT"); 2265 const auto sigstop_num = signals_sp->GetSignalNumberFromName("SIGSTOP"); 2266 if ((stop_signal != sigint_num) && (stop_signal != sigstop_num)) 2267 // The signal very likely implies a crash. 2268 return true; 2269 } 2270 } 2271 2272 return false; 2273 } 2274 2275 void CommandInterpreter::HandleCommands(const StringList &commands, 2276 ExecutionContext *override_context, 2277 CommandInterpreterRunOptions &options, 2278 CommandReturnObject &result) { 2279 size_t num_lines = commands.GetSize(); 2280 2281 // If we are going to continue past a "continue" then we need to run the 2282 // commands synchronously. Make sure you reset this value anywhere you return 2283 // from the function. 2284 2285 bool old_async_execution = m_debugger.GetAsyncExecution(); 2286 2287 // If we've been given an execution context, set it at the start, but don't 2288 // keep resetting it or we will cause series of commands that change the 2289 // context, then do an operation that relies on that context to fail. 2290 2291 if (override_context != nullptr) 2292 UpdateExecutionContext(override_context); 2293 2294 if (!options.GetStopOnContinue()) { 2295 m_debugger.SetAsyncExecution(false); 2296 } 2297 2298 for (size_t idx = 0; idx < num_lines && !WasInterrupted(); idx++) { 2299 const char *cmd = commands.GetStringAtIndex(idx); 2300 if (cmd[0] == '\0') 2301 continue; 2302 2303 if (options.GetEchoCommands()) { 2304 // TODO: Add Stream support. 2305 result.AppendMessageWithFormat("%s %s\n", 2306 m_debugger.GetPrompt().str().c_str(), cmd); 2307 } 2308 2309 CommandReturnObject tmp_result(m_debugger.GetUseColor()); 2310 // If override_context is not NULL, pass no_context_switching = true for 2311 // HandleCommand() since we updated our context already. 2312 2313 // We might call into a regex or alias command, in which case the 2314 // add_to_history will get lost. This m_command_source_depth dingus is the 2315 // way we turn off adding to the history in that case, so set it up here. 2316 if (!options.GetAddToHistory()) 2317 m_command_source_depth++; 2318 bool success = 2319 HandleCommand(cmd, options.m_add_to_history, tmp_result, 2320 nullptr, /* override_context */ 2321 true, /* repeat_on_empty_command */ 2322 override_context != nullptr /* no_context_switching */); 2323 if (!options.GetAddToHistory()) 2324 m_command_source_depth--; 2325 2326 if (options.GetPrintResults()) { 2327 if (tmp_result.Succeeded()) 2328 result.AppendMessage(tmp_result.GetOutputData()); 2329 } 2330 2331 if (!success || !tmp_result.Succeeded()) { 2332 llvm::StringRef error_msg = tmp_result.GetErrorData(); 2333 if (error_msg.empty()) 2334 error_msg = "<unknown error>.\n"; 2335 if (options.GetStopOnError()) { 2336 result.AppendErrorWithFormat( 2337 "Aborting reading of commands after command #%" PRIu64 2338 ": '%s' failed with %s", 2339 (uint64_t)idx, cmd, error_msg.str().c_str()); 2340 result.SetStatus(eReturnStatusFailed); 2341 m_debugger.SetAsyncExecution(old_async_execution); 2342 return; 2343 } else if (options.GetPrintResults()) { 2344 result.AppendMessageWithFormat( 2345 "Command #%" PRIu64 " '%s' failed with %s", (uint64_t)idx + 1, cmd, 2346 error_msg.str().c_str()); 2347 } 2348 } 2349 2350 if (result.GetImmediateOutputStream()) 2351 result.GetImmediateOutputStream()->Flush(); 2352 2353 if (result.GetImmediateErrorStream()) 2354 result.GetImmediateErrorStream()->Flush(); 2355 2356 // N.B. Can't depend on DidChangeProcessState, because the state coming 2357 // into the command execution could be running (for instance in Breakpoint 2358 // Commands. So we check the return value to see if it is has running in 2359 // it. 2360 if ((tmp_result.GetStatus() == eReturnStatusSuccessContinuingNoResult) || 2361 (tmp_result.GetStatus() == eReturnStatusSuccessContinuingResult)) { 2362 if (options.GetStopOnContinue()) { 2363 // If we caused the target to proceed, and we're going to stop in that 2364 // case, set the status in our real result before returning. This is 2365 // an error if the continue was not the last command in the set of 2366 // commands to be run. 2367 if (idx != num_lines - 1) 2368 result.AppendErrorWithFormat( 2369 "Aborting reading of commands after command #%" PRIu64 2370 ": '%s' continued the target.\n", 2371 (uint64_t)idx + 1, cmd); 2372 else 2373 result.AppendMessageWithFormat("Command #%" PRIu64 2374 " '%s' continued the target.\n", 2375 (uint64_t)idx + 1, cmd); 2376 2377 result.SetStatus(tmp_result.GetStatus()); 2378 m_debugger.SetAsyncExecution(old_async_execution); 2379 2380 return; 2381 } 2382 } 2383 2384 // Also check for "stop on crash here: 2385 if (tmp_result.GetDidChangeProcessState() && options.GetStopOnCrash() && 2386 DidProcessStopAbnormally()) { 2387 if (idx != num_lines - 1) 2388 result.AppendErrorWithFormat( 2389 "Aborting reading of commands after command #%" PRIu64 2390 ": '%s' stopped with a signal or exception.\n", 2391 (uint64_t)idx + 1, cmd); 2392 else 2393 result.AppendMessageWithFormat( 2394 "Command #%" PRIu64 " '%s' stopped with a signal or exception.\n", 2395 (uint64_t)idx + 1, cmd); 2396 2397 result.SetStatus(tmp_result.GetStatus()); 2398 m_debugger.SetAsyncExecution(old_async_execution); 2399 2400 return; 2401 } 2402 } 2403 2404 result.SetStatus(eReturnStatusSuccessFinishResult); 2405 m_debugger.SetAsyncExecution(old_async_execution); 2406 2407 return; 2408 } 2409 2410 // Make flags that we can pass into the IOHandler so our delegates can do the 2411 // right thing 2412 enum { 2413 eHandleCommandFlagStopOnContinue = (1u << 0), 2414 eHandleCommandFlagStopOnError = (1u << 1), 2415 eHandleCommandFlagEchoCommand = (1u << 2), 2416 eHandleCommandFlagEchoCommentCommand = (1u << 3), 2417 eHandleCommandFlagPrintResult = (1u << 4), 2418 eHandleCommandFlagPrintErrors = (1u << 5), 2419 eHandleCommandFlagStopOnCrash = (1u << 6) 2420 }; 2421 2422 void CommandInterpreter::HandleCommandsFromFile( 2423 FileSpec &cmd_file, ExecutionContext *context, 2424 CommandInterpreterRunOptions &options, CommandReturnObject &result) { 2425 if (!FileSystem::Instance().Exists(cmd_file)) { 2426 result.AppendErrorWithFormat( 2427 "Error reading commands from file %s - file not found.\n", 2428 cmd_file.GetFilename().AsCString("<Unknown>")); 2429 result.SetStatus(eReturnStatusFailed); 2430 return; 2431 } 2432 2433 std::string cmd_file_path = cmd_file.GetPath(); 2434 auto input_file_up = 2435 FileSystem::Instance().Open(cmd_file, File::eOpenOptionRead); 2436 if (!input_file_up) { 2437 std::string error = llvm::toString(input_file_up.takeError()); 2438 result.AppendErrorWithFormatv( 2439 "error: an error occurred read file '{0}': {1}\n", cmd_file_path, 2440 llvm::fmt_consume(input_file_up.takeError())); 2441 result.SetStatus(eReturnStatusFailed); 2442 return; 2443 } 2444 FileSP input_file_sp = FileSP(std::move(input_file_up.get())); 2445 2446 Debugger &debugger = GetDebugger(); 2447 2448 uint32_t flags = 0; 2449 2450 if (options.m_stop_on_continue == eLazyBoolCalculate) { 2451 if (m_command_source_flags.empty()) { 2452 // Stop on continue by default 2453 flags |= eHandleCommandFlagStopOnContinue; 2454 } else if (m_command_source_flags.back() & 2455 eHandleCommandFlagStopOnContinue) { 2456 flags |= eHandleCommandFlagStopOnContinue; 2457 } 2458 } else if (options.m_stop_on_continue == eLazyBoolYes) { 2459 flags |= eHandleCommandFlagStopOnContinue; 2460 } 2461 2462 if (options.m_stop_on_error == eLazyBoolCalculate) { 2463 if (m_command_source_flags.empty()) { 2464 if (GetStopCmdSourceOnError()) 2465 flags |= eHandleCommandFlagStopOnError; 2466 } else if (m_command_source_flags.back() & eHandleCommandFlagStopOnError) { 2467 flags |= eHandleCommandFlagStopOnError; 2468 } 2469 } else if (options.m_stop_on_error == eLazyBoolYes) { 2470 flags |= eHandleCommandFlagStopOnError; 2471 } 2472 2473 // stop-on-crash can only be set, if it is present in all levels of 2474 // pushed flag sets. 2475 if (options.GetStopOnCrash()) { 2476 if (m_command_source_flags.empty()) { 2477 flags |= eHandleCommandFlagStopOnCrash; 2478 } else if (m_command_source_flags.back() & eHandleCommandFlagStopOnCrash) { 2479 flags |= eHandleCommandFlagStopOnCrash; 2480 } 2481 } 2482 2483 if (options.m_echo_commands == eLazyBoolCalculate) { 2484 if (m_command_source_flags.empty()) { 2485 // Echo command by default 2486 flags |= eHandleCommandFlagEchoCommand; 2487 } else if (m_command_source_flags.back() & eHandleCommandFlagEchoCommand) { 2488 flags |= eHandleCommandFlagEchoCommand; 2489 } 2490 } else if (options.m_echo_commands == eLazyBoolYes) { 2491 flags |= eHandleCommandFlagEchoCommand; 2492 } 2493 2494 // We will only ever ask for this flag, if we echo commands in general. 2495 if (options.m_echo_comment_commands == eLazyBoolCalculate) { 2496 if (m_command_source_flags.empty()) { 2497 // Echo comments by default 2498 flags |= eHandleCommandFlagEchoCommentCommand; 2499 } else if (m_command_source_flags.back() & 2500 eHandleCommandFlagEchoCommentCommand) { 2501 flags |= eHandleCommandFlagEchoCommentCommand; 2502 } 2503 } else if (options.m_echo_comment_commands == eLazyBoolYes) { 2504 flags |= eHandleCommandFlagEchoCommentCommand; 2505 } 2506 2507 if (options.m_print_results == eLazyBoolCalculate) { 2508 if (m_command_source_flags.empty()) { 2509 // Print output by default 2510 flags |= eHandleCommandFlagPrintResult; 2511 } else if (m_command_source_flags.back() & eHandleCommandFlagPrintResult) { 2512 flags |= eHandleCommandFlagPrintResult; 2513 } 2514 } else if (options.m_print_results == eLazyBoolYes) { 2515 flags |= eHandleCommandFlagPrintResult; 2516 } 2517 2518 if (options.m_print_errors == eLazyBoolCalculate) { 2519 if (m_command_source_flags.empty()) { 2520 // Print output by default 2521 flags |= eHandleCommandFlagPrintErrors; 2522 } else if (m_command_source_flags.back() & eHandleCommandFlagPrintErrors) { 2523 flags |= eHandleCommandFlagPrintErrors; 2524 } 2525 } else if (options.m_print_errors == eLazyBoolYes) { 2526 flags |= eHandleCommandFlagPrintErrors; 2527 } 2528 2529 if (flags & eHandleCommandFlagPrintResult) { 2530 debugger.GetOutputFile().Printf("Executing commands in '%s'.\n", 2531 cmd_file_path.c_str()); 2532 } 2533 2534 // Used for inheriting the right settings when "command source" might 2535 // have nested "command source" commands 2536 lldb::StreamFileSP empty_stream_sp; 2537 m_command_source_flags.push_back(flags); 2538 IOHandlerSP io_handler_sp(new IOHandlerEditline( 2539 debugger, IOHandler::Type::CommandInterpreter, input_file_sp, 2540 empty_stream_sp, // Pass in an empty stream so we inherit the top 2541 // input reader output stream 2542 empty_stream_sp, // Pass in an empty stream so we inherit the top 2543 // input reader error stream 2544 flags, 2545 nullptr, // Pass in NULL for "editline_name" so no history is saved, 2546 // or written 2547 debugger.GetPrompt(), llvm::StringRef(), 2548 false, // Not multi-line 2549 debugger.GetUseColor(), 0, *this, nullptr)); 2550 const bool old_async_execution = debugger.GetAsyncExecution(); 2551 2552 // Set synchronous execution if we are not stopping on continue 2553 if ((flags & eHandleCommandFlagStopOnContinue) == 0) 2554 debugger.SetAsyncExecution(false); 2555 2556 m_command_source_depth++; 2557 2558 debugger.RunIOHandlerSync(io_handler_sp); 2559 if (!m_command_source_flags.empty()) 2560 m_command_source_flags.pop_back(); 2561 m_command_source_depth--; 2562 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2563 debugger.SetAsyncExecution(old_async_execution); 2564 } 2565 2566 bool CommandInterpreter::GetSynchronous() { return m_synchronous_execution; } 2567 2568 void CommandInterpreter::SetSynchronous(bool value) { 2569 // Asynchronous mode is not supported during reproducer replay. 2570 if (repro::Reproducer::Instance().GetLoader()) 2571 return; 2572 m_synchronous_execution = value; 2573 } 2574 2575 void CommandInterpreter::OutputFormattedHelpText(Stream &strm, 2576 llvm::StringRef prefix, 2577 llvm::StringRef help_text) { 2578 const uint32_t max_columns = m_debugger.GetTerminalWidth(); 2579 2580 size_t line_width_max = max_columns - prefix.size(); 2581 if (line_width_max < 16) 2582 line_width_max = help_text.size() + prefix.size(); 2583 2584 strm.IndentMore(prefix.size()); 2585 bool prefixed_yet = false; 2586 while (!help_text.empty()) { 2587 // Prefix the first line, indent subsequent lines to line up 2588 if (!prefixed_yet) { 2589 strm << prefix; 2590 prefixed_yet = true; 2591 } else 2592 strm.Indent(); 2593 2594 // Never print more than the maximum on one line. 2595 llvm::StringRef this_line = help_text.substr(0, line_width_max); 2596 2597 // Always break on an explicit newline. 2598 std::size_t first_newline = this_line.find_first_of("\n"); 2599 2600 // Don't break on space/tab unless the text is too long to fit on one line. 2601 std::size_t last_space = llvm::StringRef::npos; 2602 if (this_line.size() != help_text.size()) 2603 last_space = this_line.find_last_of(" \t"); 2604 2605 // Break at whichever condition triggered first. 2606 this_line = this_line.substr(0, std::min(first_newline, last_space)); 2607 strm.PutCString(this_line); 2608 strm.EOL(); 2609 2610 // Remove whitespace / newlines after breaking. 2611 help_text = help_text.drop_front(this_line.size()).ltrim(); 2612 } 2613 strm.IndentLess(prefix.size()); 2614 } 2615 2616 void CommandInterpreter::OutputFormattedHelpText(Stream &strm, 2617 llvm::StringRef word_text, 2618 llvm::StringRef separator, 2619 llvm::StringRef help_text, 2620 size_t max_word_len) { 2621 StreamString prefix_stream; 2622 prefix_stream.Printf(" %-*s %*s ", (int)max_word_len, word_text.data(), 2623 (int)separator.size(), separator.data()); 2624 OutputFormattedHelpText(strm, prefix_stream.GetString(), help_text); 2625 } 2626 2627 void CommandInterpreter::OutputHelpText(Stream &strm, llvm::StringRef word_text, 2628 llvm::StringRef separator, 2629 llvm::StringRef help_text, 2630 uint32_t max_word_len) { 2631 int indent_size = max_word_len + separator.size() + 2; 2632 2633 strm.IndentMore(indent_size); 2634 2635 StreamString text_strm; 2636 text_strm.Printf("%-*s ", (int)max_word_len, word_text.data()); 2637 text_strm << separator << " " << help_text; 2638 2639 const uint32_t max_columns = m_debugger.GetTerminalWidth(); 2640 2641 llvm::StringRef text = text_strm.GetString(); 2642 2643 uint32_t chars_left = max_columns; 2644 2645 auto nextWordLength = [](llvm::StringRef S) { 2646 size_t pos = S.find(' '); 2647 return pos == llvm::StringRef::npos ? S.size() : pos; 2648 }; 2649 2650 while (!text.empty()) { 2651 if (text.front() == '\n' || 2652 (text.front() == ' ' && nextWordLength(text.ltrim(' ')) > chars_left)) { 2653 strm.EOL(); 2654 strm.Indent(); 2655 chars_left = max_columns - indent_size; 2656 if (text.front() == '\n') 2657 text = text.drop_front(); 2658 else 2659 text = text.ltrim(' '); 2660 } else { 2661 strm.PutChar(text.front()); 2662 --chars_left; 2663 text = text.drop_front(); 2664 } 2665 } 2666 2667 strm.EOL(); 2668 strm.IndentLess(indent_size); 2669 } 2670 2671 void CommandInterpreter::FindCommandsForApropos( 2672 llvm::StringRef search_word, StringList &commands_found, 2673 StringList &commands_help, CommandObject::CommandMap &command_map) { 2674 CommandObject::CommandMap::const_iterator pos; 2675 2676 for (pos = command_map.begin(); pos != command_map.end(); ++pos) { 2677 llvm::StringRef command_name = pos->first; 2678 CommandObject *cmd_obj = pos->second.get(); 2679 2680 const bool search_short_help = true; 2681 const bool search_long_help = false; 2682 const bool search_syntax = false; 2683 const bool search_options = false; 2684 if (command_name.contains_lower(search_word) || 2685 cmd_obj->HelpTextContainsWord(search_word, search_short_help, 2686 search_long_help, search_syntax, 2687 search_options)) { 2688 commands_found.AppendString(cmd_obj->GetCommandName()); 2689 commands_help.AppendString(cmd_obj->GetHelp()); 2690 } 2691 2692 if (cmd_obj->IsMultiwordObject()) { 2693 CommandObjectMultiword *cmd_multiword = cmd_obj->GetAsMultiwordCommand(); 2694 FindCommandsForApropos(search_word, commands_found, commands_help, 2695 cmd_multiword->GetSubcommandDictionary()); 2696 } 2697 } 2698 } 2699 2700 void CommandInterpreter::FindCommandsForApropos(llvm::StringRef search_word, 2701 StringList &commands_found, 2702 StringList &commands_help, 2703 bool search_builtin_commands, 2704 bool search_user_commands, 2705 bool search_alias_commands) { 2706 CommandObject::CommandMap::const_iterator pos; 2707 2708 if (search_builtin_commands) 2709 FindCommandsForApropos(search_word, commands_found, commands_help, 2710 m_command_dict); 2711 2712 if (search_user_commands) 2713 FindCommandsForApropos(search_word, commands_found, commands_help, 2714 m_user_dict); 2715 2716 if (search_alias_commands) 2717 FindCommandsForApropos(search_word, commands_found, commands_help, 2718 m_alias_dict); 2719 } 2720 2721 void CommandInterpreter::UpdateExecutionContext( 2722 ExecutionContext *override_context) { 2723 if (override_context != nullptr) { 2724 m_exe_ctx_ref = *override_context; 2725 } else { 2726 const bool adopt_selected = true; 2727 m_exe_ctx_ref.SetTargetPtr(m_debugger.GetSelectedTarget().get(), 2728 adopt_selected); 2729 } 2730 } 2731 2732 void CommandInterpreter::GetProcessOutput() { 2733 TargetSP target_sp(m_debugger.GetTargetList().GetSelectedTarget()); 2734 if (!target_sp) 2735 return; 2736 2737 if (ProcessSP process_sp = target_sp->GetProcessSP()) 2738 m_debugger.FlushProcessOutput(*process_sp, /*flush_stdout*/ true, 2739 /*flush_stderr*/ true); 2740 } 2741 2742 void CommandInterpreter::StartHandlingCommand() { 2743 auto idle_state = CommandHandlingState::eIdle; 2744 if (m_command_state.compare_exchange_strong( 2745 idle_state, CommandHandlingState::eInProgress)) 2746 lldbassert(m_iohandler_nesting_level == 0); 2747 else 2748 lldbassert(m_iohandler_nesting_level > 0); 2749 ++m_iohandler_nesting_level; 2750 } 2751 2752 void CommandInterpreter::FinishHandlingCommand() { 2753 lldbassert(m_iohandler_nesting_level > 0); 2754 if (--m_iohandler_nesting_level == 0) { 2755 auto prev_state = m_command_state.exchange(CommandHandlingState::eIdle); 2756 lldbassert(prev_state != CommandHandlingState::eIdle); 2757 } 2758 } 2759 2760 bool CommandInterpreter::InterruptCommand() { 2761 auto in_progress = CommandHandlingState::eInProgress; 2762 return m_command_state.compare_exchange_strong( 2763 in_progress, CommandHandlingState::eInterrupted); 2764 } 2765 2766 bool CommandInterpreter::WasInterrupted() const { 2767 bool was_interrupted = 2768 (m_command_state == CommandHandlingState::eInterrupted); 2769 lldbassert(!was_interrupted || m_iohandler_nesting_level > 0); 2770 return was_interrupted; 2771 } 2772 2773 void CommandInterpreter::PrintCommandOutput(Stream &stream, 2774 llvm::StringRef str) { 2775 // Split the output into lines and poll for interrupt requests 2776 const char *data = str.data(); 2777 size_t size = str.size(); 2778 while (size > 0 && !WasInterrupted()) { 2779 size_t chunk_size = 0; 2780 for (; chunk_size < size; ++chunk_size) { 2781 lldbassert(data[chunk_size] != '\0'); 2782 if (data[chunk_size] == '\n') { 2783 ++chunk_size; 2784 break; 2785 } 2786 } 2787 chunk_size = stream.Write(data, chunk_size); 2788 lldbassert(size >= chunk_size); 2789 data += chunk_size; 2790 size -= chunk_size; 2791 } 2792 if (size > 0) { 2793 stream.Printf("\n... Interrupted.\n"); 2794 } 2795 } 2796 2797 bool CommandInterpreter::EchoCommandNonInteractive( 2798 llvm::StringRef line, const Flags &io_handler_flags) const { 2799 if (!io_handler_flags.Test(eHandleCommandFlagEchoCommand)) 2800 return false; 2801 2802 llvm::StringRef command = line.trim(); 2803 if (command.empty()) 2804 return true; 2805 2806 if (command.front() == m_comment_char) 2807 return io_handler_flags.Test(eHandleCommandFlagEchoCommentCommand); 2808 2809 return true; 2810 } 2811 2812 void CommandInterpreter::IOHandlerInputComplete(IOHandler &io_handler, 2813 std::string &line) { 2814 // If we were interrupted, bail out... 2815 if (WasInterrupted()) 2816 return; 2817 2818 const bool is_interactive = io_handler.GetIsInteractive(); 2819 if (!is_interactive) { 2820 // When we are not interactive, don't execute blank lines. This will happen 2821 // sourcing a commands file. We don't want blank lines to repeat the 2822 // previous command and cause any errors to occur (like redefining an 2823 // alias, get an error and stop parsing the commands file). 2824 if (line.empty()) 2825 return; 2826 2827 // When using a non-interactive file handle (like when sourcing commands 2828 // from a file) we need to echo the command out so we don't just see the 2829 // command output and no command... 2830 if (EchoCommandNonInteractive(line, io_handler.GetFlags())) 2831 io_handler.GetOutputStreamFileSP()->Printf( 2832 "%s%s\n", io_handler.GetPrompt(), line.c_str()); 2833 } 2834 2835 StartHandlingCommand(); 2836 2837 lldb_private::CommandReturnObject result(m_debugger.GetUseColor()); 2838 HandleCommand(line.c_str(), eLazyBoolCalculate, result); 2839 2840 // Now emit the command output text from the command we just executed 2841 if ((result.Succeeded() && 2842 io_handler.GetFlags().Test(eHandleCommandFlagPrintResult)) || 2843 io_handler.GetFlags().Test(eHandleCommandFlagPrintErrors)) { 2844 // Display any STDOUT/STDERR _prior_ to emitting the command result text 2845 GetProcessOutput(); 2846 2847 if (!result.GetImmediateOutputStream()) { 2848 llvm::StringRef output = result.GetOutputData(); 2849 PrintCommandOutput(*io_handler.GetOutputStreamFileSP(), output); 2850 } 2851 2852 // Now emit the command error text from the command we just executed 2853 if (!result.GetImmediateErrorStream()) { 2854 llvm::StringRef error = result.GetErrorData(); 2855 PrintCommandOutput(*io_handler.GetErrorStreamFileSP(), error); 2856 } 2857 } 2858 2859 FinishHandlingCommand(); 2860 2861 switch (result.GetStatus()) { 2862 case eReturnStatusInvalid: 2863 case eReturnStatusSuccessFinishNoResult: 2864 case eReturnStatusSuccessFinishResult: 2865 case eReturnStatusStarted: 2866 break; 2867 2868 case eReturnStatusSuccessContinuingNoResult: 2869 case eReturnStatusSuccessContinuingResult: 2870 if (io_handler.GetFlags().Test(eHandleCommandFlagStopOnContinue)) 2871 io_handler.SetIsDone(true); 2872 break; 2873 2874 case eReturnStatusFailed: 2875 m_result.IncrementNumberOfErrors(); 2876 if (io_handler.GetFlags().Test(eHandleCommandFlagStopOnError)) { 2877 m_result.SetResult(lldb::eCommandInterpreterResultCommandError); 2878 io_handler.SetIsDone(true); 2879 } 2880 break; 2881 2882 case eReturnStatusQuit: 2883 m_result.SetResult(lldb::eCommandInterpreterResultQuitRequested); 2884 io_handler.SetIsDone(true); 2885 break; 2886 } 2887 2888 // Finally, if we're going to stop on crash, check that here: 2889 if (m_result.IsResult(lldb::eCommandInterpreterResultSuccess) && 2890 result.GetDidChangeProcessState() && 2891 io_handler.GetFlags().Test(eHandleCommandFlagStopOnCrash) && 2892 DidProcessStopAbnormally()) { 2893 io_handler.SetIsDone(true); 2894 m_result.SetResult(lldb::eCommandInterpreterResultInferiorCrash); 2895 } 2896 } 2897 2898 bool CommandInterpreter::IOHandlerInterrupt(IOHandler &io_handler) { 2899 ExecutionContext exe_ctx(GetExecutionContext()); 2900 Process *process = exe_ctx.GetProcessPtr(); 2901 2902 if (InterruptCommand()) 2903 return true; 2904 2905 if (process) { 2906 StateType state = process->GetState(); 2907 if (StateIsRunningState(state)) { 2908 process->Halt(); 2909 return true; // Don't do any updating when we are running 2910 } 2911 } 2912 2913 ScriptInterpreter *script_interpreter = 2914 m_debugger.GetScriptInterpreter(false); 2915 if (script_interpreter) { 2916 if (script_interpreter->Interrupt()) 2917 return true; 2918 } 2919 return false; 2920 } 2921 2922 bool CommandInterpreter::SaveTranscript( 2923 CommandReturnObject &result, llvm::Optional<std::string> output_file) { 2924 if (output_file == llvm::None || output_file->empty()) { 2925 std::string now = llvm::to_string(std::chrono::system_clock::now()); 2926 std::replace(now.begin(), now.end(), ' ', '_'); 2927 const std::string file_name = "lldb_session_" + now + ".log"; 2928 FileSpec tmp = HostInfo::GetGlobalTempDir(); 2929 tmp.AppendPathComponent(file_name); 2930 output_file = tmp.GetPath(); 2931 } 2932 2933 auto error_out = [&](llvm::StringRef error_message, std::string description) { 2934 LLDB_LOG(GetLogIfAllCategoriesSet(LIBLLDB_LOG_COMMANDS), "{0} ({1}:{2})", 2935 error_message, output_file, description); 2936 result.AppendErrorWithFormatv( 2937 "Failed to save session's transcripts to {0}!", *output_file); 2938 return false; 2939 }; 2940 2941 File::OpenOptions flags = File::eOpenOptionWrite | 2942 File::eOpenOptionCanCreate | 2943 File::eOpenOptionTruncate; 2944 2945 auto opened_file = FileSystem::Instance().Open(FileSpec(*output_file), flags); 2946 2947 if (!opened_file) 2948 return error_out("Unable to create file", 2949 llvm::toString(opened_file.takeError())); 2950 2951 FileUP file = std::move(opened_file.get()); 2952 2953 size_t byte_size = m_transcript_stream.GetSize(); 2954 2955 Status error = file->Write(m_transcript_stream.GetData(), byte_size); 2956 2957 if (error.Fail() || byte_size != m_transcript_stream.GetSize()) 2958 return error_out("Unable to write to destination file", 2959 "Bytes written do not match transcript size."); 2960 2961 result.AppendMessageWithFormat("Session's transcripts saved to %s\n", 2962 output_file->c_str()); 2963 2964 return true; 2965 } 2966 2967 void CommandInterpreter::GetLLDBCommandsFromIOHandler( 2968 const char *prompt, IOHandlerDelegate &delegate, void *baton) { 2969 Debugger &debugger = GetDebugger(); 2970 IOHandlerSP io_handler_sp( 2971 new IOHandlerEditline(debugger, IOHandler::Type::CommandList, 2972 "lldb", // Name of input reader for history 2973 llvm::StringRef::withNullAsEmpty(prompt), // Prompt 2974 llvm::StringRef(), // Continuation prompt 2975 true, // Get multiple lines 2976 debugger.GetUseColor(), 2977 0, // Don't show line numbers 2978 delegate, // IOHandlerDelegate 2979 nullptr)); // FileShadowCollector 2980 2981 if (io_handler_sp) { 2982 io_handler_sp->SetUserData(baton); 2983 debugger.RunIOHandlerAsync(io_handler_sp); 2984 } 2985 } 2986 2987 void CommandInterpreter::GetPythonCommandsFromIOHandler( 2988 const char *prompt, IOHandlerDelegate &delegate, void *baton) { 2989 Debugger &debugger = GetDebugger(); 2990 IOHandlerSP io_handler_sp( 2991 new IOHandlerEditline(debugger, IOHandler::Type::PythonCode, 2992 "lldb-python", // Name of input reader for history 2993 llvm::StringRef::withNullAsEmpty(prompt), // Prompt 2994 llvm::StringRef(), // Continuation prompt 2995 true, // Get multiple lines 2996 debugger.GetUseColor(), 2997 0, // Don't show line numbers 2998 delegate, // IOHandlerDelegate 2999 nullptr)); // FileShadowCollector 3000 3001 if (io_handler_sp) { 3002 io_handler_sp->SetUserData(baton); 3003 debugger.RunIOHandlerAsync(io_handler_sp); 3004 } 3005 } 3006 3007 bool CommandInterpreter::IsActive() { 3008 return m_debugger.IsTopIOHandler(m_command_io_handler_sp); 3009 } 3010 3011 lldb::IOHandlerSP 3012 CommandInterpreter::GetIOHandler(bool force_create, 3013 CommandInterpreterRunOptions *options) { 3014 // Always re-create the IOHandlerEditline in case the input changed. The old 3015 // instance might have had a non-interactive input and now it does or vice 3016 // versa. 3017 if (force_create || !m_command_io_handler_sp) { 3018 // Always re-create the IOHandlerEditline in case the input changed. The 3019 // old instance might have had a non-interactive input and now it does or 3020 // vice versa. 3021 uint32_t flags = 0; 3022 3023 if (options) { 3024 if (options->m_stop_on_continue == eLazyBoolYes) 3025 flags |= eHandleCommandFlagStopOnContinue; 3026 if (options->m_stop_on_error == eLazyBoolYes) 3027 flags |= eHandleCommandFlagStopOnError; 3028 if (options->m_stop_on_crash == eLazyBoolYes) 3029 flags |= eHandleCommandFlagStopOnCrash; 3030 if (options->m_echo_commands != eLazyBoolNo) 3031 flags |= eHandleCommandFlagEchoCommand; 3032 if (options->m_echo_comment_commands != eLazyBoolNo) 3033 flags |= eHandleCommandFlagEchoCommentCommand; 3034 if (options->m_print_results != eLazyBoolNo) 3035 flags |= eHandleCommandFlagPrintResult; 3036 if (options->m_print_errors != eLazyBoolNo) 3037 flags |= eHandleCommandFlagPrintErrors; 3038 } else { 3039 flags = eHandleCommandFlagEchoCommand | eHandleCommandFlagPrintResult | 3040 eHandleCommandFlagPrintErrors; 3041 } 3042 3043 m_command_io_handler_sp = std::make_shared<IOHandlerEditline>( 3044 m_debugger, IOHandler::Type::CommandInterpreter, 3045 m_debugger.GetInputFileSP(), m_debugger.GetOutputStreamSP(), 3046 m_debugger.GetErrorStreamSP(), flags, "lldb", m_debugger.GetPrompt(), 3047 llvm::StringRef(), // Continuation prompt 3048 false, // Don't enable multiple line input, just single line commands 3049 m_debugger.GetUseColor(), 3050 0, // Don't show line numbers 3051 *this, // IOHandlerDelegate 3052 GetDebugger().GetInputRecorder()); 3053 } 3054 return m_command_io_handler_sp; 3055 } 3056 3057 CommandInterpreterRunResult CommandInterpreter::RunCommandInterpreter( 3058 CommandInterpreterRunOptions &options) { 3059 // Always re-create the command interpreter when we run it in case any file 3060 // handles have changed. 3061 bool force_create = true; 3062 m_debugger.RunIOHandlerAsync(GetIOHandler(force_create, &options)); 3063 m_result = CommandInterpreterRunResult(); 3064 3065 if (options.GetAutoHandleEvents()) 3066 m_debugger.StartEventHandlerThread(); 3067 3068 if (options.GetSpawnThread()) { 3069 m_debugger.StartIOHandlerThread(); 3070 } else { 3071 m_debugger.RunIOHandlers(); 3072 3073 if (options.GetAutoHandleEvents()) 3074 m_debugger.StopEventHandlerThread(); 3075 } 3076 3077 return m_result; 3078 } 3079 3080 CommandObject * 3081 CommandInterpreter::ResolveCommandImpl(std::string &command_line, 3082 CommandReturnObject &result) { 3083 std::string scratch_command(command_line); // working copy so we don't modify 3084 // command_line unless we succeed 3085 CommandObject *cmd_obj = nullptr; 3086 StreamString revised_command_line; 3087 bool wants_raw_input = false; 3088 size_t actual_cmd_name_len = 0; 3089 std::string next_word; 3090 StringList matches; 3091 bool done = false; 3092 while (!done) { 3093 char quote_char = '\0'; 3094 std::string suffix; 3095 ExtractCommand(scratch_command, next_word, suffix, quote_char); 3096 if (cmd_obj == nullptr) { 3097 std::string full_name; 3098 bool is_alias = GetAliasFullName(next_word, full_name); 3099 cmd_obj = GetCommandObject(next_word, &matches); 3100 bool is_real_command = 3101 (!is_alias) || (cmd_obj != nullptr && !cmd_obj->IsAlias()); 3102 if (!is_real_command) { 3103 matches.Clear(); 3104 std::string alias_result; 3105 cmd_obj = 3106 BuildAliasResult(full_name, scratch_command, alias_result, result); 3107 revised_command_line.Printf("%s", alias_result.c_str()); 3108 if (cmd_obj) { 3109 wants_raw_input = cmd_obj->WantsRawCommandString(); 3110 actual_cmd_name_len = cmd_obj->GetCommandName().size(); 3111 } 3112 } else { 3113 if (cmd_obj) { 3114 llvm::StringRef cmd_name = cmd_obj->GetCommandName(); 3115 actual_cmd_name_len += cmd_name.size(); 3116 revised_command_line.Printf("%s", cmd_name.str().c_str()); 3117 wants_raw_input = cmd_obj->WantsRawCommandString(); 3118 } else { 3119 revised_command_line.Printf("%s", next_word.c_str()); 3120 } 3121 } 3122 } else { 3123 if (cmd_obj->IsMultiwordObject()) { 3124 CommandObject *sub_cmd_obj = 3125 cmd_obj->GetSubcommandObject(next_word.c_str()); 3126 if (sub_cmd_obj) { 3127 // The subcommand's name includes the parent command's name, so 3128 // restart rather than append to the revised_command_line. 3129 llvm::StringRef sub_cmd_name = sub_cmd_obj->GetCommandName(); 3130 actual_cmd_name_len = sub_cmd_name.size() + 1; 3131 revised_command_line.Clear(); 3132 revised_command_line.Printf("%s", sub_cmd_name.str().c_str()); 3133 cmd_obj = sub_cmd_obj; 3134 wants_raw_input = cmd_obj->WantsRawCommandString(); 3135 } else { 3136 if (quote_char) 3137 revised_command_line.Printf(" %c%s%s%c", quote_char, 3138 next_word.c_str(), suffix.c_str(), 3139 quote_char); 3140 else 3141 revised_command_line.Printf(" %s%s", next_word.c_str(), 3142 suffix.c_str()); 3143 done = true; 3144 } 3145 } else { 3146 if (quote_char) 3147 revised_command_line.Printf(" %c%s%s%c", quote_char, 3148 next_word.c_str(), suffix.c_str(), 3149 quote_char); 3150 else 3151 revised_command_line.Printf(" %s%s", next_word.c_str(), 3152 suffix.c_str()); 3153 done = true; 3154 } 3155 } 3156 3157 if (cmd_obj == nullptr) { 3158 const size_t num_matches = matches.GetSize(); 3159 if (matches.GetSize() > 1) { 3160 StreamString error_msg; 3161 error_msg.Printf("Ambiguous command '%s'. Possible matches:\n", 3162 next_word.c_str()); 3163 3164 for (uint32_t i = 0; i < num_matches; ++i) { 3165 error_msg.Printf("\t%s\n", matches.GetStringAtIndex(i)); 3166 } 3167 result.AppendRawError(error_msg.GetString()); 3168 } else { 3169 // We didn't have only one match, otherwise we wouldn't get here. 3170 lldbassert(num_matches == 0); 3171 result.AppendErrorWithFormat("'%s' is not a valid command.\n", 3172 next_word.c_str()); 3173 } 3174 result.SetStatus(eReturnStatusFailed); 3175 return nullptr; 3176 } 3177 3178 if (cmd_obj->IsMultiwordObject()) { 3179 if (!suffix.empty()) { 3180 result.AppendErrorWithFormat( 3181 "command '%s' did not recognize '%s%s%s' as valid (subcommand " 3182 "might be invalid).\n", 3183 cmd_obj->GetCommandName().str().c_str(), 3184 next_word.empty() ? "" : next_word.c_str(), 3185 next_word.empty() ? " -- " : " ", suffix.c_str()); 3186 result.SetStatus(eReturnStatusFailed); 3187 return nullptr; 3188 } 3189 } else { 3190 // If we found a normal command, we are done 3191 done = true; 3192 if (!suffix.empty()) { 3193 switch (suffix[0]) { 3194 case '/': 3195 // GDB format suffixes 3196 { 3197 Options *command_options = cmd_obj->GetOptions(); 3198 if (command_options && 3199 command_options->SupportsLongOption("gdb-format")) { 3200 std::string gdb_format_option("--gdb-format="); 3201 gdb_format_option += (suffix.c_str() + 1); 3202 3203 std::string cmd = std::string(revised_command_line.GetString()); 3204 size_t arg_terminator_idx = FindArgumentTerminator(cmd); 3205 if (arg_terminator_idx != std::string::npos) { 3206 // Insert the gdb format option before the "--" that terminates 3207 // options 3208 gdb_format_option.append(1, ' '); 3209 cmd.insert(arg_terminator_idx, gdb_format_option); 3210 revised_command_line.Clear(); 3211 revised_command_line.PutCString(cmd); 3212 } else 3213 revised_command_line.Printf(" %s", gdb_format_option.c_str()); 3214 3215 if (wants_raw_input && 3216 FindArgumentTerminator(cmd) == std::string::npos) 3217 revised_command_line.PutCString(" --"); 3218 } else { 3219 result.AppendErrorWithFormat( 3220 "the '%s' command doesn't support the --gdb-format option\n", 3221 cmd_obj->GetCommandName().str().c_str()); 3222 result.SetStatus(eReturnStatusFailed); 3223 return nullptr; 3224 } 3225 } 3226 break; 3227 3228 default: 3229 result.AppendErrorWithFormat( 3230 "unknown command shorthand suffix: '%s'\n", suffix.c_str()); 3231 result.SetStatus(eReturnStatusFailed); 3232 return nullptr; 3233 } 3234 } 3235 } 3236 if (scratch_command.empty()) 3237 done = true; 3238 } 3239 3240 if (!scratch_command.empty()) 3241 revised_command_line.Printf(" %s", scratch_command.c_str()); 3242 3243 if (cmd_obj != nullptr) 3244 command_line = std::string(revised_command_line.GetString()); 3245 3246 return cmd_obj; 3247 } 3248