diff options
| author | Dimitry Andric <dim@FreeBSD.org> | 2019-12-20 19:53:05 +0000 |
|---|---|---|
| committer | Dimitry Andric <dim@FreeBSD.org> | 2019-12-20 19:53:05 +0000 |
| commit | 0b57cec536236d46e3dba9bd041533462f33dbb7 (patch) | |
| tree | 56229dbdbbf76d18580f72f789003db17246c8d9 /contrib/llvm/tools/lldb/source/Commands/CommandObjectLog.cpp | |
| parent | 718ef55ec7785aae63f98f8ca05dc07ed399c16d (diff) | |
Notes
Diffstat (limited to 'contrib/llvm/tools/lldb/source/Commands/CommandObjectLog.cpp')
| -rw-r--r-- | contrib/llvm/tools/lldb/source/Commands/CommandObjectLog.cpp | 368 |
1 files changed, 0 insertions, 368 deletions
diff --git a/contrib/llvm/tools/lldb/source/Commands/CommandObjectLog.cpp b/contrib/llvm/tools/lldb/source/Commands/CommandObjectLog.cpp deleted file mode 100644 index 2ad61de1a3e9..000000000000 --- a/contrib/llvm/tools/lldb/source/Commands/CommandObjectLog.cpp +++ /dev/null @@ -1,368 +0,0 @@ -//===-- CommandObjectLog.cpp ------------------------------------*- C++ -*-===// -// -// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. -// See https://llvm.org/LICENSE.txt for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -//===----------------------------------------------------------------------===// - -#include "CommandObjectLog.h" -#include "lldb/Core/Debugger.h" -#include "lldb/Core/Module.h" -#include "lldb/Core/StreamFile.h" -#include "lldb/Host/OptionParser.h" -#include "lldb/Interpreter/CommandInterpreter.h" -#include "lldb/Interpreter/CommandReturnObject.h" -#include "lldb/Interpreter/OptionArgParser.h" -#include "lldb/Interpreter/Options.h" -#include "lldb/Symbol/LineTable.h" -#include "lldb/Symbol/ObjectFile.h" -#include "lldb/Symbol/SymbolFile.h" -#include "lldb/Symbol/SymbolVendor.h" -#include "lldb/Target/Process.h" -#include "lldb/Target/Target.h" -#include "lldb/Utility/Args.h" -#include "lldb/Utility/FileSpec.h" -#include "lldb/Utility/Log.h" -#include "lldb/Utility/RegularExpression.h" -#include "lldb/Utility/Stream.h" -#include "lldb/Utility/Timer.h" - -using namespace lldb; -using namespace lldb_private; - -static constexpr OptionDefinition g_log_options[] = { - // clang-format off - { LLDB_OPT_SET_1, false, "file", 'f', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeFilename, "Set the destination file to log to." }, - { LLDB_OPT_SET_1, false, "threadsafe", 't', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Enable thread safe logging to avoid interweaved log lines." }, - { LLDB_OPT_SET_1, false, "verbose", 'v', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Enable verbose logging." }, - { LLDB_OPT_SET_1, false, "sequence", 's', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Prepend all log lines with an increasing integer sequence id." }, - { LLDB_OPT_SET_1, false, "timestamp", 'T', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Prepend all log lines with a timestamp." }, - { LLDB_OPT_SET_1, false, "pid-tid", 'p', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Prepend all log lines with the process and thread ID that generates the log line." }, - { LLDB_OPT_SET_1, false, "thread-name",'n', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Prepend all log lines with the thread name for the thread that generates the log line." }, - { LLDB_OPT_SET_1, false, "stack", 'S', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Append a stack backtrace to each log line." }, - { LLDB_OPT_SET_1, false, "append", 'a', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Append to the log file instead of overwriting." }, - { LLDB_OPT_SET_1, false, "file-function",'F',OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Prepend the names of files and function that generate the logs." }, - // clang-format on -}; - -class CommandObjectLogEnable : public CommandObjectParsed { -public: - // Constructors and Destructors - CommandObjectLogEnable(CommandInterpreter &interpreter) - : CommandObjectParsed(interpreter, "log enable", - "Enable logging for a single log channel.", - nullptr), - m_options() { - CommandArgumentEntry arg1; - CommandArgumentEntry arg2; - CommandArgumentData channel_arg; - CommandArgumentData category_arg; - - // Define the first (and only) variant of this arg. - channel_arg.arg_type = eArgTypeLogChannel; - channel_arg.arg_repetition = eArgRepeatPlain; - - // There is only one variant this argument could be; put it into the - // argument entry. - arg1.push_back(channel_arg); - - category_arg.arg_type = eArgTypeLogCategory; - category_arg.arg_repetition = eArgRepeatPlus; - - arg2.push_back(category_arg); - - // Push the data for the first argument into the m_arguments vector. - m_arguments.push_back(arg1); - m_arguments.push_back(arg2); - } - - ~CommandObjectLogEnable() override = default; - - Options *GetOptions() override { return &m_options; } - - class CommandOptions : public Options { - public: - CommandOptions() : Options(), log_file(), log_options(0) {} - - ~CommandOptions() override = default; - - Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, - ExecutionContext *execution_context) override { - Status error; - const int short_option = m_getopt_table[option_idx].val; - - switch (short_option) { - case 'f': - log_file.SetFile(option_arg, FileSpec::Style::native); - FileSystem::Instance().Resolve(log_file); - break; - case 't': - log_options |= LLDB_LOG_OPTION_THREADSAFE; - break; - case 'v': - log_options |= LLDB_LOG_OPTION_VERBOSE; - break; - case 's': - log_options |= LLDB_LOG_OPTION_PREPEND_SEQUENCE; - break; - case 'T': - log_options |= LLDB_LOG_OPTION_PREPEND_TIMESTAMP; - break; - case 'p': - log_options |= LLDB_LOG_OPTION_PREPEND_PROC_AND_THREAD; - break; - case 'n': - log_options |= LLDB_LOG_OPTION_PREPEND_THREAD_NAME; - break; - case 'S': - log_options |= LLDB_LOG_OPTION_BACKTRACE; - break; - case 'a': - log_options |= LLDB_LOG_OPTION_APPEND; - break; - case 'F': - log_options |= LLDB_LOG_OPTION_PREPEND_FILE_FUNCTION; - break; - default: - error.SetErrorStringWithFormat("unrecognized option '%c'", - short_option); - break; - } - - return error; - } - - void OptionParsingStarting(ExecutionContext *execution_context) override { - log_file.Clear(); - log_options = 0; - } - - llvm::ArrayRef<OptionDefinition> GetDefinitions() override { - return llvm::makeArrayRef(g_log_options); - } - - // Instance variables to hold the values for command options. - - FileSpec log_file; - uint32_t log_options; - }; - -protected: - bool DoExecute(Args &args, CommandReturnObject &result) override { - if (args.GetArgumentCount() < 2) { - result.AppendErrorWithFormat( - "%s takes a log channel and one or more log types.\n", - m_cmd_name.c_str()); - return false; - } - - // Store into a std::string since we're about to shift the channel off. - const std::string channel = args[0].ref; - args.Shift(); // Shift off the channel - char log_file[PATH_MAX]; - if (m_options.log_file) - m_options.log_file.GetPath(log_file, sizeof(log_file)); - else - log_file[0] = '\0'; - - std::string error; - llvm::raw_string_ostream error_stream(error); - bool success = - GetDebugger().EnableLog(channel, args.GetArgumentArrayRef(), log_file, - m_options.log_options, error_stream); - result.GetErrorStream() << error_stream.str(); - - if (success) - result.SetStatus(eReturnStatusSuccessFinishNoResult); - else - result.SetStatus(eReturnStatusFailed); - return result.Succeeded(); - } - - CommandOptions m_options; -}; - -class CommandObjectLogDisable : public CommandObjectParsed { -public: - // Constructors and Destructors - CommandObjectLogDisable(CommandInterpreter &interpreter) - : CommandObjectParsed(interpreter, "log disable", - "Disable one or more log channel categories.", - nullptr) { - CommandArgumentEntry arg1; - CommandArgumentEntry arg2; - CommandArgumentData channel_arg; - CommandArgumentData category_arg; - - // Define the first (and only) variant of this arg. - channel_arg.arg_type = eArgTypeLogChannel; - channel_arg.arg_repetition = eArgRepeatPlain; - - // There is only one variant this argument could be; put it into the - // argument entry. - arg1.push_back(channel_arg); - - category_arg.arg_type = eArgTypeLogCategory; - category_arg.arg_repetition = eArgRepeatPlus; - - arg2.push_back(category_arg); - - // Push the data for the first argument into the m_arguments vector. - m_arguments.push_back(arg1); - m_arguments.push_back(arg2); - } - - ~CommandObjectLogDisable() override = default; - -protected: - bool DoExecute(Args &args, CommandReturnObject &result) override { - if (args.empty()) { - result.AppendErrorWithFormat( - "%s takes a log channel and one or more log types.\n", - m_cmd_name.c_str()); - return false; - } - - const std::string channel = args[0].ref; - args.Shift(); // Shift off the channel - if (channel == "all") { - Log::DisableAllLogChannels(); - result.SetStatus(eReturnStatusSuccessFinishNoResult); - } else { - std::string error; - llvm::raw_string_ostream error_stream(error); - if (Log::DisableLogChannel(channel, args.GetArgumentArrayRef(), - error_stream)) - result.SetStatus(eReturnStatusSuccessFinishNoResult); - result.GetErrorStream() << error_stream.str(); - } - return result.Succeeded(); - } -}; - -class CommandObjectLogList : public CommandObjectParsed { -public: - // Constructors and Destructors - CommandObjectLogList(CommandInterpreter &interpreter) - : CommandObjectParsed(interpreter, "log list", - "List the log categories for one or more log " - "channels. If none specified, lists them all.", - nullptr) { - CommandArgumentEntry arg; - CommandArgumentData channel_arg; - - // Define the first (and only) variant of this arg. - channel_arg.arg_type = eArgTypeLogChannel; - channel_arg.arg_repetition = eArgRepeatStar; - - // There is only one variant this argument could be; put it into the - // argument entry. - arg.push_back(channel_arg); - - // Push the data for the first argument into the m_arguments vector. - m_arguments.push_back(arg); - } - - ~CommandObjectLogList() override = default; - -protected: - bool DoExecute(Args &args, CommandReturnObject &result) override { - std::string output; - llvm::raw_string_ostream output_stream(output); - if (args.empty()) { - Log::ListAllLogChannels(output_stream); - result.SetStatus(eReturnStatusSuccessFinishResult); - } else { - bool success = true; - for (const auto &entry : args.entries()) - success = - success && Log::ListChannelCategories(entry.ref, output_stream); - if (success) - result.SetStatus(eReturnStatusSuccessFinishResult); - } - result.GetOutputStream() << output_stream.str(); - return result.Succeeded(); - } -}; - -class CommandObjectLogTimer : public CommandObjectParsed { -public: - // Constructors and Destructors - CommandObjectLogTimer(CommandInterpreter &interpreter) - : CommandObjectParsed(interpreter, "log timers", - "Enable, disable, dump, and reset LLDB internal " - "performance timers.", - "log timers < enable <depth> | disable | dump | " - "increment <bool> | reset >") {} - - ~CommandObjectLogTimer() override = default; - -protected: - bool DoExecute(Args &args, CommandReturnObject &result) override { - result.SetStatus(eReturnStatusFailed); - - if (args.GetArgumentCount() == 1) { - auto sub_command = args[0].ref; - - if (sub_command.equals_lower("enable")) { - Timer::SetDisplayDepth(UINT32_MAX); - result.SetStatus(eReturnStatusSuccessFinishNoResult); - } else if (sub_command.equals_lower("disable")) { - Timer::DumpCategoryTimes(&result.GetOutputStream()); - Timer::SetDisplayDepth(0); - result.SetStatus(eReturnStatusSuccessFinishResult); - } else if (sub_command.equals_lower("dump")) { - Timer::DumpCategoryTimes(&result.GetOutputStream()); - result.SetStatus(eReturnStatusSuccessFinishResult); - } else if (sub_command.equals_lower("reset")) { - Timer::ResetCategoryTimes(); - result.SetStatus(eReturnStatusSuccessFinishResult); - } - } else if (args.GetArgumentCount() == 2) { - auto sub_command = args[0].ref; - auto param = args[1].ref; - - if (sub_command.equals_lower("enable")) { - uint32_t depth; - if (param.consumeInteger(0, depth)) { - result.AppendError( - "Could not convert enable depth to an unsigned integer."); - } else { - Timer::SetDisplayDepth(depth); - result.SetStatus(eReturnStatusSuccessFinishNoResult); - } - } else if (sub_command.equals_lower("increment")) { - bool success; - bool increment = OptionArgParser::ToBoolean(param, false, &success); - if (success) { - Timer::SetQuiet(!increment); - result.SetStatus(eReturnStatusSuccessFinishNoResult); - } else - result.AppendError("Could not convert increment value to boolean."); - } - } - - if (!result.Succeeded()) { - result.AppendError("Missing subcommand"); - result.AppendErrorWithFormat("Usage: %s\n", m_cmd_syntax.c_str()); - } - return result.Succeeded(); - } -}; - -CommandObjectLog::CommandObjectLog(CommandInterpreter &interpreter) - : CommandObjectMultiword(interpreter, "log", - "Commands controlling LLDB internal logging.", - "log <subcommand> [<command-options>]") { - LoadSubCommand("enable", - CommandObjectSP(new CommandObjectLogEnable(interpreter))); - LoadSubCommand("disable", - CommandObjectSP(new CommandObjectLogDisable(interpreter))); - LoadSubCommand("list", - CommandObjectSP(new CommandObjectLogList(interpreter))); - LoadSubCommand("timers", - CommandObjectSP(new CommandObjectLogTimer(interpreter))); -} - -CommandObjectLog::~CommandObjectLog() = default; |
