| // Copyright 2020 The Fuchsia Authors. All rights reserved. | |
| // Use of this source code is governed by a BSD-style license that can be | |
| // found in the LICENSE file. | |
| #include "src/developer/debug/zxdb/console/commands/verb_backtrace.h" | |
| #include "src/developer/debug/zxdb/client/process.h" | |
| #include "src/developer/debug/zxdb/client/target.h" | |
| #include "src/developer/debug/zxdb/console/command.h" | |
| #include "src/developer/debug/zxdb/console/command_utils.h" | |
| #include "src/developer/debug/zxdb/console/format_frame.h" | |
| #include "src/developer/debug/zxdb/console/format_location.h" | |
| #include "src/developer/debug/zxdb/console/verbs.h" | |
| #include "src/developer/debug/zxdb/format/format.h" | |
| namespace zxdb { | |
| namespace { | |
| constexpr int kForceAllTypes = 1; | |
| constexpr int kRawOutput = 2; | |
| constexpr int kVerboseBacktrace = 3; | |
| constexpr int kForceRefresh = 4; | |
| constexpr int kForceRemoteUnwind = 5; | |
| constexpr int kTrust = 6; | |
| constexpr int kUnwinder = 7; | |
| const char kBacktraceShortHelp[] = "backtrace / bt: Print a backtrace."; | |
| const char kBacktraceUsage[] = "backtrace / bt"; | |
| const char kBacktraceHelp[] = R"( | |
| Prints a backtrace of the thread, including function parameters. | |
| To see just function names and line numbers, use "frame" or just "f". | |
| Arguments | |
| -f | |
| --force | |
| Force an update to the stack when listing stack frames. This will always | |
| reevaluate the complete call stack based on the current stop location. Use | |
| --force-remote-unwind to unwind completely on the target. | |
| --force-remote-unwind | |
| Force the unwinding operation to happen from the target backend. Note that | |
| this may result in different results than the default due to less metadata | |
| availability on the target compared to the default option. Implies | |
| --force. | |
| -r | |
| --raw | |
| Expands frames that were collapsed by the "pretty" stack formatter. | |
| -t | |
| --types | |
| Include all type information for function parameters. | |
| --trust | |
| Include the frame's Trust as reported by the unwinder, indicating which | |
| unwinder implementation retrieved this frame. | |
| --unwinder <type> | |
| Force the unwinder to use ONLY the specified implementation. Supported | |
| types: cfi, fp, scs, plt, armehabi, sigreturn. Implies --force. | |
| -v | |
| --verbose | |
| Include extra stack frame information: | |
| • Full template lists and function parameter types. | |
| • Instruction pointer. | |
| • Stack pointer. | |
| • Stack frame base pointer. | |
| • Frame trust. | |
| Examples | |
| t 2 bt | |
| thread 2 backtrace | |
| t * bt | |
| all threads backtrace | |
| )"; | |
| void RunVerbBacktrace(const Command& cmd, fxl::RefPtr<CommandContext> cmd_context) { | |
| if (Err err = cmd.ValidateNouns({Noun::kProcess, Noun::kThread}, true); err.has_error()) | |
| return cmd_context->ReportError(err); | |
| if (!cmd.thread() && cmd.GetNounIndex(Noun::kThread) != Command::kWildcard) | |
| return cmd_context->ReportError(Err("There is no thread to have frames.")); | |
| auto opts = | |
| FormatStackOptions::GetFrameOptions(cmd.target(), cmd.HasSwitch(kVerboseBacktrace), | |
| cmd.HasSwitch(kForceAllTypes), cmd.HasSwitch(kTrust), 3); | |
| if (!cmd.HasSwitch(kRawOutput)) | |
| opts.pretty_stack = cmd_context->GetConsoleContext()->pretty_stack_manager(); | |
| opts.frame.detail = FormatFrameOptions::kParameters; | |
| if (cmd.HasSwitch(kVerboseBacktrace)) { | |
| opts.frame.detail = FormatFrameOptions::kVerbose; | |
| opts.frame.include_frame_trust = true; | |
| } | |
| // These are minimal since there is often a lot of data. | |
| opts.frame.variable.verbosity = FormatBufferOptions::Verbosity::kMinimal; | |
| opts.frame.variable.verbosity = cmd.HasSwitch(kForceAllTypes) | |
| ? FormatBufferOptions::Verbosity::kAllTypes | |
| : FormatBufferOptions::Verbosity::kMinimal; | |
| if (cmd.HasSwitch(kForceRefresh)) { | |
| opts.sync_options.force_update = true; | |
| } | |
| if (cmd.HasSwitch(kForceRemoteUnwind)) { | |
| opts.sync_options.force_update = true; | |
| opts.sync_options.remote_unwind = true; | |
| } | |
| if (cmd.HasSwitch(kUnwinder)) { | |
| debug_ipc::StackFrame::Trust trust; | |
| if (Err err = StringToTrust(cmd.GetSwitchValue(kUnwinder), &trust); err.has_error()) | |
| return cmd_context->ReportError(err); | |
| opts.sync_options.force_update = true; | |
| opts.sync_options.forced_unwinder = trust; | |
| } | |
| if (cmd.GetNounIndex(Noun::kThread) == Command::kWildcard) { | |
| FX_DCHECK(cmd.target()); | |
| FX_DCHECK(cmd.target()->GetProcess()); | |
| cmd_context->Output( | |
| FormatAllThreadStacks(cmd.target()->GetProcess()->GetThreads(), opts, cmd_context)); | |
| return; | |
| } | |
| cmd_context->Output(FormatStack(cmd.thread(), opts)); | |
| } | |
| } // namespace | |
| VerbRecord GetBacktraceVerbRecord() { | |
| VerbRecord backtrace(&RunVerbBacktrace, {"backtrace", "where", "bt"}, kBacktraceShortHelp, | |
| kBacktraceUsage, kBacktraceHelp, CommandGroup::kQuery); | |
| SwitchRecord force_types(kForceAllTypes, false, "types", 't'); | |
| SwitchRecord raw(kRawOutput, false, "raw", 'r'); | |
| SwitchRecord verbose(kVerboseBacktrace, false, "verbose", 'v'); | |
| SwitchRecord force_refresh(kForceRefresh, false, "force", 'f'); | |
| SwitchRecord force_remote_unwind(kForceRemoteUnwind, false, "force-remote-unwind"); | |
| SwitchRecord trust(kTrust, false, "trust"); | |
| SwitchRecord unwinder(kUnwinder, true, "unwinder"); | |
| backtrace.switches = {force_types, raw, verbose, force_refresh, | |
| force_remote_unwind, trust, unwinder}; | |
| return backtrace; | |
| } | |
| } // namespace zxdb |