//===-- CommandObjectPlatform.cpp -------------------------------*- C++ -*-===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// #include "CommandObjectPlatform.h" // C Includes // C++ Includes // Other libraries and framework includes // Project includes #include "lldb/Core/DataExtractor.h" #include "lldb/Core/Debugger.h" #include "lldb/Core/PluginManager.h" #include "lldb/Interpreter/Args.h" #include "lldb/Interpreter/CommandInterpreter.h" #include "lldb/Interpreter/CommandReturnObject.h" #include "lldb/Interpreter/Options.h" #include "lldb/Target/ExecutionContext.h" #include "lldb/Target/Platform.h" #include "lldb/Target/Process.h" using namespace lldb; using namespace lldb_private; PlatformSP PlatformOptionGroup::CreatePlatformWithOptions (CommandInterpreter &interpreter, const char *platform_name, bool select, Error& error) { if (platform_name && platform_name[0]) { if (platform_sp) { error.SetErrorString ("platform can't be set more than once in a command"); return PlatformSP(); } platform_sp = Platform::Create (platform_name, error); if (platform_sp) { interpreter.GetDebugger().GetPlatformList().Append (platform_sp, select); if (os_version_major != UINT32_MAX) { platform_sp->SetOSVersion (os_version_major, os_version_minor, os_version_update); } } } else { error.SetErrorString ("invalid platform name"); platform_sp.reset(); } return platform_sp; } void PlatformOptionGroup::OptionParsingStarting (CommandInterpreter &interpreter) { platform_sp.reset(); os_version_major = UINT32_MAX; os_version_minor = UINT32_MAX; os_version_update = UINT32_MAX; } static OptionDefinition g_option_table[] = { { LLDB_OPT_SET_ALL, false, "platform" , 'p', required_argument, NULL, 0, eArgTypeNone, "Specify name of the platform to use for this target, creating the platform if necessary."}, { LLDB_OPT_SET_ALL, false, "sdk-version", 'v', required_argument, NULL, 0, eArgTypeNone, "Specify the initial SDK version to use prior to connecting." } }; static const uint32_t k_option_table_size = sizeof(g_option_table)/sizeof (OptionDefinition); const OptionDefinition* PlatformOptionGroup::GetDefinitions () { if (m_include_platform_option) return g_option_table; return g_option_table + 1; } uint32_t PlatformOptionGroup::GetNumDefinitions () { if (m_include_platform_option) return k_option_table_size; return k_option_table_size - 1; } Error PlatformOptionGroup::SetOptionValue (CommandInterpreter &interpreter, uint32_t option_idx, const char *option_arg) { Error error; if (!m_include_platform_option) --option_idx; char short_option = (char) g_option_table[option_idx].short_option; switch (short_option) { case 'p': CreatePlatformWithOptions (interpreter, option_arg, true, error); break; case 'v': if (Args::StringToVersion (option_arg, os_version_major, os_version_minor, os_version_update) == option_arg) { error.SetErrorStringWithFormat ("invalid version string '%s'", option_arg); } else { if (platform_sp) platform_sp->SetOSVersion (os_version_major, os_version_minor, os_version_update); } break; default: error.SetErrorStringWithFormat ("Unrecognized option '%c'.\n", short_option); break; } return error; } //---------------------------------------------------------------------- // "platform create " //---------------------------------------------------------------------- class CommandObjectPlatformSelect : public CommandObject { public: CommandObjectPlatformSelect (CommandInterpreter &interpreter) : CommandObject (interpreter, "platform select", "Create a platform if needed and select it as the current platform.", "platform select ", 0), m_option_group (interpreter), m_platform_options (false) // Don't include the "--platform" option by passing false { m_option_group.Append (&m_platform_options); m_option_group.Finalize(); } virtual ~CommandObjectPlatformSelect () { } virtual bool Execute (Args& args, CommandReturnObject &result) { Error error; if (args.GetArgumentCount() == 1) { const bool select = true; PlatformSP platform_sp (m_platform_options.CreatePlatformWithOptions (m_interpreter, args.GetArgumentAtIndex (0), select, error)); if (platform_sp) platform_sp->GetStatus (result.GetOutputStream()); } else { result.AppendError ("platform create takes a platform name as an argument\n"); result.SetStatus (eReturnStatusFailed); } return result.Succeeded(); } virtual Options * GetOptions () { return &m_option_group; } protected: OptionGroupOptions m_option_group; PlatformOptionGroup m_platform_options; }; //---------------------------------------------------------------------- // "platform list" //---------------------------------------------------------------------- class CommandObjectPlatformList : public CommandObject { public: CommandObjectPlatformList (CommandInterpreter &interpreter) : CommandObject (interpreter, "platform list", "List all platforms that are available.", NULL, 0) { } virtual ~CommandObjectPlatformList () { } virtual bool Execute (Args& args, CommandReturnObject &result) { Stream &ostrm = result.GetOutputStream(); ostrm.Printf("Available platforms:\n"); PlatformSP host_platform_sp (Platform::GetDefaultPlatform()); ostrm.Printf ("%s: %s\n", host_platform_sp->GetShortPluginName(), host_platform_sp->GetDescription()); uint32_t idx; for (idx = 0; 1; ++idx) { const char *plugin_name = PluginManager::GetPlatformPluginNameAtIndex (idx); if (plugin_name == NULL) break; const char *plugin_desc = PluginManager::GetPlatformPluginDescriptionAtIndex (idx); if (plugin_desc == NULL) break; ostrm.Printf("%s: %s\n", plugin_name, plugin_desc); } if (idx == 0) { result.AppendError ("no platforms are available\n"); result.SetStatus (eReturnStatusFailed); } else result.SetStatus (eReturnStatusSuccessFinishResult); return result.Succeeded(); } }; //---------------------------------------------------------------------- // "platform status" //---------------------------------------------------------------------- class CommandObjectPlatformStatus : public CommandObject { public: CommandObjectPlatformStatus (CommandInterpreter &interpreter) : CommandObject (interpreter, "platform status", "Display status for the currently selected platform.", NULL, 0) { } virtual ~CommandObjectPlatformStatus () { } virtual bool Execute (Args& args, CommandReturnObject &result) { Stream &ostrm = result.GetOutputStream(); PlatformSP platform_sp (m_interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform()); if (platform_sp) { platform_sp->GetStatus (ostrm); result.SetStatus (eReturnStatusSuccessFinishResult); } else { result.AppendError ("no platform us currently selected\n"); result.SetStatus (eReturnStatusFailed); } return result.Succeeded(); } }; //---------------------------------------------------------------------- // "platform connect " //---------------------------------------------------------------------- class CommandObjectPlatformConnect : public CommandObject { public: CommandObjectPlatformConnect (CommandInterpreter &interpreter) : CommandObject (interpreter, "platform connect", "Connect a platform by name to be the currently selected platform.", "platform connect ", 0) { } virtual ~CommandObjectPlatformConnect () { } virtual bool Execute (Args& args, CommandReturnObject &result) { Stream &ostrm = result.GetOutputStream(); PlatformSP platform_sp (m_interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform()); if (platform_sp) { Error error (platform_sp->ConnectRemote (args)); if (error.Success()) { platform_sp->GetStatus (ostrm); result.SetStatus (eReturnStatusSuccessFinishResult); } else { result.AppendErrorWithFormat ("%s\n", error.AsCString()); result.SetStatus (eReturnStatusFailed); } } else { result.AppendError ("no platform us currently selected\n"); result.SetStatus (eReturnStatusFailed); } return result.Succeeded(); } }; //---------------------------------------------------------------------- // "platform disconnect" //---------------------------------------------------------------------- class CommandObjectPlatformDisconnect : public CommandObject { public: CommandObjectPlatformDisconnect (CommandInterpreter &interpreter) : CommandObject (interpreter, "platform disconnect", "Disconnect a platform by name to be the currently selected platform.", "platform disconnect", 0) { } virtual ~CommandObjectPlatformDisconnect () { } virtual bool Execute (Args& args, CommandReturnObject &result) { PlatformSP platform_sp (m_interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform()); if (platform_sp) { if (args.GetArgumentCount() == 0) { Error error; if (platform_sp->IsConnected()) { // Cache the instance name if there is one since we are // about to disconnect and the name might go with it. const char *hostname_cstr = platform_sp->GetHostname(); std::string hostname; if (hostname_cstr) hostname.assign (hostname_cstr); error = platform_sp->DisconnectRemote (); if (error.Success()) { Stream &ostrm = result.GetOutputStream(); if (hostname.empty()) ostrm.Printf ("Disconnected from \"%s\"\n", platform_sp->GetShortPluginName()); else ostrm.Printf ("Disconnected from \"%s\"\n", hostname.c_str()); result.SetStatus (eReturnStatusSuccessFinishResult); } else { result.AppendErrorWithFormat ("%s", error.AsCString()); result.SetStatus (eReturnStatusFailed); } } else { // Not connected... result.AppendErrorWithFormat ("not connected to '%s'", platform_sp->GetShortPluginName()); result.SetStatus (eReturnStatusFailed); } } else { // Bad args result.AppendError ("\"platform disconnect\" doesn't take any arguments"); result.SetStatus (eReturnStatusFailed); } } else { result.AppendError ("no platform is currently selected"); result.SetStatus (eReturnStatusFailed); } return result.Succeeded(); } }; //---------------------------------------------------------------------- // "platform process launch" //---------------------------------------------------------------------- class CommandObjectPlatformProcessLaunch : public CommandObject { public: CommandObjectPlatformProcessLaunch (CommandInterpreter &interpreter) : CommandObject (interpreter, "platform process launch", "Launch a new process on a remote platform.", "platform process launch program", 0), m_options (interpreter) { } virtual ~CommandObjectPlatformProcessLaunch () { } virtual bool Execute (Args& args, CommandReturnObject &result) { PlatformSP platform_sp (m_interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform()); if (platform_sp) { Error error; const uint32_t argc = args.GetArgumentCount(); Target *target = m_interpreter.GetExecutionContext().target; ModuleSP exe_module_sp; if (target) { exe_module_sp = target->GetExecutableModule(); if (exe_module_sp) { m_options.launch_info.GetExecutableFile () = exe_module_sp->GetFileSpec(); char exe_path[PATH_MAX]; if (m_options.launch_info.GetExecutableFile ().GetPath (exe_path, sizeof(exe_path))) m_options.launch_info.GetArguments().AppendArgument (exe_path); m_options.launch_info.GetArchitecture() = exe_module_sp->GetArchitecture(); } } if (argc > 0) { if (m_options.launch_info.GetExecutableFile ()) { // We already have an executable file, so we will use this // and all arguments to this function are extra arguments m_options.launch_info.GetArguments().AppendArguments (args); } else { // We don't have any file yet, so the first argument is our // executable, and the rest are program arguments const bool first_arg_is_executable = true; m_options.launch_info.SetArgumentsFromArgs (args, first_arg_is_executable, first_arg_is_executable); } } if (m_options.launch_info.GetExecutableFile ()) { Debugger &debugger = m_interpreter.GetDebugger(); if (argc == 0) { lldb::UserSettingsControllerSP process_usc_sp (Process::GetSettingsController ()); if (process_usc_sp) { SettableVariableType type; StringList settings_args (process_usc_sp->GetVariable ("process.run-args", type, m_interpreter.GetDebugger().GetInstanceName().GetCString(), error)); if (error.Success()) { const size_t num_settings_args = settings_args.GetSize(); for (size_t i=0; iDebugProcess (m_options.launch_info, debugger, target, debugger.GetListener(), error)); if (process_sp && process_sp->IsAlive()) { result.SetStatus (eReturnStatusSuccessFinishNoResult); return true; } if (error.Success()) result.AppendError ("process launch failed"); else result.AppendError (error.AsCString()); result.SetStatus (eReturnStatusFailed); } else { result.AppendError ("'platform process launch' uses the current target file and arguments, or the executable and its arguments can be specified in this command"); result.SetStatus (eReturnStatusFailed); return false; } } else { result.AppendError ("no platform is selected\n"); } return result.Succeeded(); } virtual Options * GetOptions () { return &m_options; } protected: ProcessLaunchCommandOptions m_options; }; //---------------------------------------------------------------------- // "platform process list" //---------------------------------------------------------------------- class CommandObjectPlatformProcessList : public CommandObject { public: CommandObjectPlatformProcessList (CommandInterpreter &interpreter) : CommandObject (interpreter, "platform process list", "List processes on a remote platform by name, pid, or many other matching attributes.", "platform process list", 0), m_options (interpreter) { } virtual ~CommandObjectPlatformProcessList () { } virtual bool Execute (Args& args, CommandReturnObject &result) { PlatformSP platform_sp (m_interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform()); if (platform_sp) { Error error; if (args.GetArgumentCount() == 0) { if (platform_sp) { Stream &ostrm = result.GetOutputStream(); lldb::pid_t pid = m_options.match_info.GetProcessInfo().GetProcessID(); if (pid != LLDB_INVALID_PROCESS_ID) { ProcessInstanceInfo proc_info; if (platform_sp->GetProcessInfo (pid, proc_info)) { ProcessInstanceInfo::DumpTableHeader (ostrm, platform_sp.get(), m_options.show_args, m_options.verbose); proc_info.DumpAsTableRow(ostrm, platform_sp.get(), m_options.show_args, m_options.verbose); result.SetStatus (eReturnStatusSuccessFinishResult); } else { result.AppendErrorWithFormat ("no process found with pid = %i\n", pid); result.SetStatus (eReturnStatusFailed); } } else { ProcessInstanceInfoList proc_infos; const uint32_t matches = platform_sp->FindProcesses (m_options.match_info, proc_infos); const char *match_desc = NULL; const char *match_name = m_options.match_info.GetProcessInfo().GetName(); if (match_name && match_name[0]) { switch (m_options.match_info.GetNameMatchType()) { case eNameMatchIgnore: break; case eNameMatchEquals: match_desc = "matched"; break; case eNameMatchContains: match_desc = "contained"; break; case eNameMatchStartsWith: match_desc = "started with"; break; case eNameMatchEndsWith: match_desc = "ended with"; break; case eNameMatchRegularExpression: match_desc = "matched the regular expression"; break; } } if (matches == 0) { if (match_desc) result.AppendErrorWithFormat ("no processes were found that %s \"%s\" on the \"%s\" platform\n", match_desc, match_name, platform_sp->GetShortPluginName()); else result.AppendErrorWithFormat ("no processes were found on the \"%s\" platform\n", platform_sp->GetShortPluginName()); result.SetStatus (eReturnStatusFailed); } else { result.AppendMessageWithFormat ("%u matching process%s found on \"%s\"", matches, matches > 1 ? "es were" : " was", platform_sp->GetName()); if (match_desc) result.AppendMessageWithFormat (" whose name %s \"%s\"", match_desc, match_name); result.AppendMessageWithFormat ("\n"); ProcessInstanceInfo::DumpTableHeader (ostrm, platform_sp.get(), m_options.show_args, m_options.verbose); for (uint32_t i=0; i [ ...]", 0) { CommandArgumentEntry arg; CommandArgumentData pid_args; // Define the first (and only) variant of this arg. pid_args.arg_type = eArgTypePid; pid_args.arg_repetition = eArgRepeatStar; // There is only one variant this argument could be; put it into the argument entry. arg.push_back (pid_args); // Push the data for the first argument into the m_arguments vector. m_arguments.push_back (arg); } virtual ~CommandObjectPlatformProcessInfo () { } virtual bool Execute (Args& args, CommandReturnObject &result) { PlatformSP platform_sp (m_interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform()); if (platform_sp) { const size_t argc = args.GetArgumentCount(); if (argc > 0) { Error error; if (platform_sp->IsConnected()) { Stream &ostrm = result.GetOutputStream(); bool success; for (size_t i=0; iGetProcessInfo (pid, proc_info)) { ostrm.Printf ("Process information for process %i:\n", pid); proc_info.Dump (ostrm, platform_sp.get()); } else { ostrm.Printf ("error: no process information is available for process %i\n", pid); } ostrm.EOL(); } else { result.AppendErrorWithFormat ("invalid process ID argument '%s'", arg); result.SetStatus (eReturnStatusFailed); break; } } } else { // Not connected... result.AppendErrorWithFormat ("not connected to '%s'", platform_sp->GetShortPluginName()); result.SetStatus (eReturnStatusFailed); } } else { // Bad args result.AppendError ("\"platform disconnect\" doesn't take any arguments"); result.SetStatus (eReturnStatusFailed); } } else { result.AppendError ("no platform is currently selected"); result.SetStatus (eReturnStatusFailed); } return result.Succeeded(); } }; class CommandObjectPlatformProcess : public CommandObjectMultiword { public: //------------------------------------------------------------------ // Constructors and Destructors //------------------------------------------------------------------ CommandObjectPlatformProcess (CommandInterpreter &interpreter) : CommandObjectMultiword (interpreter, "platform process", "A set of commands to query, launch and attach to platform processes", "platform process [attach|launch|list] ...") { // LoadSubCommand ("attach", CommandObjectSP (new CommandObjectPlatformProcessAttach (interpreter))); LoadSubCommand ("launch", CommandObjectSP (new CommandObjectPlatformProcessLaunch (interpreter))); LoadSubCommand ("info" , CommandObjectSP (new CommandObjectPlatformProcessInfo (interpreter))); LoadSubCommand ("list" , CommandObjectSP (new CommandObjectPlatformProcessList (interpreter))); } virtual ~CommandObjectPlatformProcess () { } private: //------------------------------------------------------------------ // For CommandObjectPlatform only //------------------------------------------------------------------ DISALLOW_COPY_AND_ASSIGN (CommandObjectPlatformProcess); }; //---------------------------------------------------------------------- // CommandObjectPlatform constructor //---------------------------------------------------------------------- CommandObjectPlatform::CommandObjectPlatform(CommandInterpreter &interpreter) : CommandObjectMultiword (interpreter, "platform", "A set of commands to manage and create platforms.", "platform [connect|disconnect|info|list|status|select] ...") { LoadSubCommand ("select", CommandObjectSP (new CommandObjectPlatformSelect (interpreter))); LoadSubCommand ("list" , CommandObjectSP (new CommandObjectPlatformList (interpreter))); LoadSubCommand ("status", CommandObjectSP (new CommandObjectPlatformStatus (interpreter))); LoadSubCommand ("connect", CommandObjectSP (new CommandObjectPlatformConnect (interpreter))); LoadSubCommand ("disconnect", CommandObjectSP (new CommandObjectPlatformDisconnect (interpreter))); LoadSubCommand ("process", CommandObjectSP (new CommandObjectPlatformProcess (interpreter))); } //---------------------------------------------------------------------- // Destructor //---------------------------------------------------------------------- CommandObjectPlatform::~CommandObjectPlatform() { }