| //===-- Process.h -----------------------------------------------*- C++ -*-===// |
| // |
| // The LLVM Compiler Infrastructure |
| // |
| // This file is distributed under the University of Illinois Open Source |
| // License. See LICENSE.TXT for details. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef liblldb_Process_h_ |
| #define liblldb_Process_h_ |
| |
| #include "lldb/Host/Config.h" |
| |
| // C Includes |
| #include <limits.h> |
| |
| // C++ Includes |
| #include <chrono> |
| #include <list> |
| #include <memory> |
| #include <mutex> |
| #include <string> |
| #include <unordered_set> |
| #include <vector> |
| |
| // Other libraries and framework includes |
| // Project includes |
| #include "lldb/Breakpoint/BreakpointSiteList.h" |
| #include "lldb/Core/Broadcaster.h" |
| #include "lldb/Core/Communication.h" |
| #include "lldb/Core/Event.h" |
| #include "lldb/Core/Listener.h" |
| #include "lldb/Core/LoadedModuleInfoList.h" |
| #include "lldb/Core/PluginInterface.h" |
| #include "lldb/Core/ThreadSafeValue.h" |
| #include "lldb/Core/UserSettingsController.h" |
| #include "lldb/Host/HostThread.h" |
| #include "lldb/Host/ProcessRunLock.h" |
| #include "lldb/Interpreter/Options.h" |
| #include "lldb/Symbol/ObjectFile.h" |
| #include "lldb/Target/ExecutionContextScope.h" |
| #include "lldb/Target/InstrumentationRuntime.h" |
| #include "lldb/Target/Memory.h" |
| #include "lldb/Target/ProcessInfo.h" |
| #include "lldb/Target/ProcessLaunchInfo.h" |
| #include "lldb/Target/QueueList.h" |
| #include "lldb/Target/ThreadList.h" |
| #include "lldb/Utility/ArchSpec.h" |
| #include "lldb/Utility/NameMatches.h" |
| #include "lldb/Utility/Status.h" |
| #include "lldb/Utility/StructuredData.h" |
| #include "lldb/Utility/TraceOptions.h" |
| #include "lldb/lldb-private.h" |
| |
| #include "llvm/ADT/ArrayRef.h" |
| |
| namespace lldb_private { |
| |
| template <typename B, typename S> struct Range; |
| |
| //---------------------------------------------------------------------- |
| // ProcessProperties |
| //---------------------------------------------------------------------- |
| class ProcessProperties : public Properties { |
| public: |
| // Pass nullptr for "process" if the ProcessProperties are to be the global |
| // copy |
| ProcessProperties(lldb_private::Process *process); |
| |
| ~ProcessProperties() override; |
| |
| bool GetDisableMemoryCache() const; |
| |
| uint64_t GetMemoryCacheLineSize() const; |
| |
| Args GetExtraStartupCommands() const; |
| |
| void SetExtraStartupCommands(const Args &args); |
| |
| FileSpec GetPythonOSPluginPath() const; |
| |
| void SetPythonOSPluginPath(const FileSpec &file); |
| |
| bool GetIgnoreBreakpointsInExpressions() const; |
| |
| void SetIgnoreBreakpointsInExpressions(bool ignore); |
| |
| bool GetUnwindOnErrorInExpressions() const; |
| |
| void SetUnwindOnErrorInExpressions(bool ignore); |
| |
| bool GetStopOnSharedLibraryEvents() const; |
| |
| void SetStopOnSharedLibraryEvents(bool stop); |
| |
| bool GetDetachKeepsStopped() const; |
| |
| void SetDetachKeepsStopped(bool keep_stopped); |
| |
| bool GetWarningsOptimization() const; |
| |
| bool GetStopOnExec() const; |
| |
| protected: |
| static void OptionValueChangedCallback(void *baton, |
| OptionValue *option_value); |
| |
| Process *m_process; // Can be nullptr for global ProcessProperties |
| }; |
| |
| typedef std::shared_ptr<ProcessProperties> ProcessPropertiesSP; |
| |
| //---------------------------------------------------------------------- |
| // ProcessInstanceInfo |
| // |
| // Describes an existing process and any discoverable information that |
| // pertains to that process. |
| //---------------------------------------------------------------------- |
| class ProcessInstanceInfo : public ProcessInfo { |
| public: |
| ProcessInstanceInfo() |
| : ProcessInfo(), m_euid(UINT32_MAX), m_egid(UINT32_MAX), |
| m_parent_pid(LLDB_INVALID_PROCESS_ID) {} |
| |
| ProcessInstanceInfo(const char *name, const ArchSpec &arch, lldb::pid_t pid) |
| : ProcessInfo(name, arch, pid), m_euid(UINT32_MAX), m_egid(UINT32_MAX), |
| m_parent_pid(LLDB_INVALID_PROCESS_ID) {} |
| |
| void Clear() { |
| ProcessInfo::Clear(); |
| m_euid = UINT32_MAX; |
| m_egid = UINT32_MAX; |
| m_parent_pid = LLDB_INVALID_PROCESS_ID; |
| } |
| |
| uint32_t GetEffectiveUserID() const { return m_euid; } |
| |
| uint32_t GetEffectiveGroupID() const { return m_egid; } |
| |
| bool EffectiveUserIDIsValid() const { return m_euid != UINT32_MAX; } |
| |
| bool EffectiveGroupIDIsValid() const { return m_egid != UINT32_MAX; } |
| |
| void SetEffectiveUserID(uint32_t uid) { m_euid = uid; } |
| |
| void SetEffectiveGroupID(uint32_t gid) { m_egid = gid; } |
| |
| lldb::pid_t GetParentProcessID() const { return m_parent_pid; } |
| |
| void SetParentProcessID(lldb::pid_t pid) { m_parent_pid = pid; } |
| |
| bool ParentProcessIDIsValid() const { |
| return m_parent_pid != LLDB_INVALID_PROCESS_ID; |
| } |
| |
| void Dump(Stream &s, Platform *platform) const; |
| |
| static void DumpTableHeader(Stream &s, Platform *platform, bool show_args, |
| bool verbose); |
| |
| void DumpAsTableRow(Stream &s, Platform *platform, bool show_args, |
| bool verbose) const; |
| |
| protected: |
| uint32_t m_euid; |
| uint32_t m_egid; |
| lldb::pid_t m_parent_pid; |
| }; |
| |
| //---------------------------------------------------------------------- |
| // ProcessAttachInfo |
| // |
| // Describes any information that is required to attach to a process. |
| //---------------------------------------------------------------------- |
| |
| class ProcessAttachInfo : public ProcessInstanceInfo { |
| public: |
| ProcessAttachInfo() |
| : ProcessInstanceInfo(), m_listener_sp(), m_hijack_listener_sp(), |
| m_plugin_name(), m_resume_count(0), m_wait_for_launch(false), |
| m_ignore_existing(true), m_continue_once_attached(false), |
| m_detach_on_error(true), m_async(false) {} |
| |
| ProcessAttachInfo(const ProcessLaunchInfo &launch_info) |
| : ProcessInstanceInfo(), m_listener_sp(), m_hijack_listener_sp(), |
| m_plugin_name(), m_resume_count(0), m_wait_for_launch(false), |
| m_ignore_existing(true), m_continue_once_attached(false), |
| m_detach_on_error(true), m_async(false) { |
| ProcessInfo::operator=(launch_info); |
| SetProcessPluginName(launch_info.GetProcessPluginName()); |
| SetResumeCount(launch_info.GetResumeCount()); |
| SetListener(launch_info.GetListener()); |
| SetHijackListener(launch_info.GetHijackListener()); |
| m_detach_on_error = launch_info.GetDetachOnError(); |
| } |
| |
| bool GetWaitForLaunch() const { return m_wait_for_launch; } |
| |
| void SetWaitForLaunch(bool b) { m_wait_for_launch = b; } |
| |
| bool GetAsync() const { return m_async; } |
| |
| void SetAsync(bool b) { m_async = b; } |
| |
| bool GetIgnoreExisting() const { return m_ignore_existing; } |
| |
| void SetIgnoreExisting(bool b) { m_ignore_existing = b; } |
| |
| bool GetContinueOnceAttached() const { return m_continue_once_attached; } |
| |
| void SetContinueOnceAttached(bool b) { m_continue_once_attached = b; } |
| |
| uint32_t GetResumeCount() const { return m_resume_count; } |
| |
| void SetResumeCount(uint32_t c) { m_resume_count = c; } |
| |
| const char *GetProcessPluginName() const { |
| return (m_plugin_name.empty() ? nullptr : m_plugin_name.c_str()); |
| } |
| |
| void SetProcessPluginName(llvm::StringRef plugin) { m_plugin_name = plugin; } |
| |
| void Clear() { |
| ProcessInstanceInfo::Clear(); |
| m_plugin_name.clear(); |
| m_resume_count = 0; |
| m_wait_for_launch = false; |
| m_ignore_existing = true; |
| m_continue_once_attached = false; |
| } |
| |
| bool ProcessInfoSpecified() const { |
| if (GetExecutableFile()) |
| return true; |
| if (GetProcessID() != LLDB_INVALID_PROCESS_ID) |
| return true; |
| if (GetParentProcessID() != LLDB_INVALID_PROCESS_ID) |
| return true; |
| return false; |
| } |
| |
| lldb::ListenerSP GetHijackListener() const { return m_hijack_listener_sp; } |
| |
| void SetHijackListener(const lldb::ListenerSP &listener_sp) { |
| m_hijack_listener_sp = listener_sp; |
| } |
| |
| bool GetDetachOnError() const { return m_detach_on_error; } |
| |
| void SetDetachOnError(bool enable) { m_detach_on_error = enable; } |
| |
| // Get and set the actual listener that will be used for the process events |
| lldb::ListenerSP GetListener() const { return m_listener_sp; } |
| |
| void SetListener(const lldb::ListenerSP &listener_sp) { |
| m_listener_sp = listener_sp; |
| } |
| |
| lldb::ListenerSP GetListenerForProcess(Debugger &debugger); |
| |
| protected: |
| lldb::ListenerSP m_listener_sp; |
| lldb::ListenerSP m_hijack_listener_sp; |
| std::string m_plugin_name; |
| uint32_t m_resume_count; // How many times do we resume after launching |
| bool m_wait_for_launch; |
| bool m_ignore_existing; |
| bool m_continue_once_attached; // Supports the use-case scenario of |
| // immediately continuing the process once |
| // attached. |
| bool m_detach_on_error; // If we are debugging remotely, instruct the stub to |
| // detach rather than killing the target on error. |
| bool m_async; // Use an async attach where we start the attach and return |
| // immediately (used by GUI programs with --waitfor so they can |
| // call SBProcess::Stop() to cancel attach) |
| }; |
| |
| class ProcessLaunchCommandOptions : public Options { |
| public: |
| ProcessLaunchCommandOptions() : Options() { |
| // Keep default values of all options in one place: OptionParsingStarting () |
| OptionParsingStarting(nullptr); |
| } |
| |
| ~ProcessLaunchCommandOptions() override = default; |
| |
| Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, |
| ExecutionContext *execution_context) override; |
| |
| void OptionParsingStarting(ExecutionContext *execution_context) override { |
| launch_info.Clear(); |
| disable_aslr = eLazyBoolCalculate; |
| } |
| |
| llvm::ArrayRef<OptionDefinition> GetDefinitions() override; |
| |
| // Instance variables to hold the values for command options. |
| |
| ProcessLaunchInfo launch_info; |
| lldb_private::LazyBool disable_aslr; |
| }; |
| |
| //---------------------------------------------------------------------- |
| // ProcessInstanceInfoMatch |
| // |
| // A class to help matching one ProcessInstanceInfo to another. |
| //---------------------------------------------------------------------- |
| |
| class ProcessInstanceInfoMatch { |
| public: |
| ProcessInstanceInfoMatch() |
| : m_match_info(), m_name_match_type(NameMatch::Ignore), |
| m_match_all_users(false) {} |
| |
| ProcessInstanceInfoMatch(const char *process_name, |
| NameMatch process_name_match_type) |
| : m_match_info(), m_name_match_type(process_name_match_type), |
| m_match_all_users(false) { |
| m_match_info.GetExecutableFile().SetFile(process_name, false); |
| } |
| |
| ProcessInstanceInfo &GetProcessInfo() { return m_match_info; } |
| |
| const ProcessInstanceInfo &GetProcessInfo() const { return m_match_info; } |
| |
| bool GetMatchAllUsers() const { return m_match_all_users; } |
| |
| void SetMatchAllUsers(bool b) { m_match_all_users = b; } |
| |
| NameMatch GetNameMatchType() const { return m_name_match_type; } |
| |
| void SetNameMatchType(NameMatch name_match_type) { |
| m_name_match_type = name_match_type; |
| } |
| |
| bool NameMatches(const char *process_name) const; |
| |
| bool Matches(const ProcessInstanceInfo &proc_info) const; |
| |
| bool MatchAllProcesses() const; |
| void Clear(); |
| |
| protected: |
| ProcessInstanceInfo m_match_info; |
| NameMatch m_name_match_type; |
| bool m_match_all_users; |
| }; |
| |
| class ProcessInstanceInfoList { |
| public: |
| ProcessInstanceInfoList() = default; |
| |
| void Clear() { m_infos.clear(); } |
| |
| size_t GetSize() { return m_infos.size(); } |
| |
| void Append(const ProcessInstanceInfo &info) { m_infos.push_back(info); } |
| |
| const char *GetProcessNameAtIndex(size_t idx) { |
| return ((idx < m_infos.size()) ? m_infos[idx].GetName() : nullptr); |
| } |
| |
| size_t GetProcessNameLengthAtIndex(size_t idx) { |
| return ((idx < m_infos.size()) ? m_infos[idx].GetNameLength() : 0); |
| } |
| |
| lldb::pid_t GetProcessIDAtIndex(size_t idx) { |
| return ((idx < m_infos.size()) ? m_infos[idx].GetProcessID() : 0); |
| } |
| |
| bool GetInfoAtIndex(size_t idx, ProcessInstanceInfo &info) { |
| if (idx < m_infos.size()) { |
| info = m_infos[idx]; |
| return true; |
| } |
| return false; |
| } |
| |
| // You must ensure "idx" is valid before calling this function |
| const ProcessInstanceInfo &GetProcessInfoAtIndex(size_t idx) const { |
| assert(idx < m_infos.size()); |
| return m_infos[idx]; |
| } |
| |
| protected: |
| typedef std::vector<ProcessInstanceInfo> collection; |
| collection m_infos; |
| }; |
| |
| // This class tracks the Modification state of the process. Things that can |
| // currently modify |
| // the program are running the program (which will up the StopID) and writing |
| // memory (which |
| // will up the MemoryID.) |
| // FIXME: Should we also include modification of register states? |
| |
| class ProcessModID { |
| friend bool operator==(const ProcessModID &lhs, const ProcessModID &rhs); |
| |
| public: |
| ProcessModID() |
| : m_stop_id(0), m_last_natural_stop_id(0), m_resume_id(0), m_memory_id(0), |
| m_last_user_expression_resume(0), m_running_user_expression(false) {} |
| |
| ProcessModID(const ProcessModID &rhs) |
| : m_stop_id(rhs.m_stop_id), m_memory_id(rhs.m_memory_id) {} |
| |
| const ProcessModID &operator=(const ProcessModID &rhs) { |
| if (this != &rhs) { |
| m_stop_id = rhs.m_stop_id; |
| m_memory_id = rhs.m_memory_id; |
| } |
| return *this; |
| } |
| |
| ~ProcessModID() = default; |
| |
| void BumpStopID() { |
| m_stop_id++; |
| if (!IsLastResumeForUserExpression()) |
| m_last_natural_stop_id++; |
| } |
| |
| void BumpMemoryID() { m_memory_id++; } |
| |
| void BumpResumeID() { |
| m_resume_id++; |
| if (m_running_user_expression > 0) |
| m_last_user_expression_resume = m_resume_id; |
| } |
| |
| uint32_t GetStopID() const { return m_stop_id; } |
| uint32_t GetLastNaturalStopID() const { return m_last_natural_stop_id; } |
| uint32_t GetMemoryID() const { return m_memory_id; } |
| uint32_t GetResumeID() const { return m_resume_id; } |
| uint32_t GetLastUserExpressionResumeID() const { |
| return m_last_user_expression_resume; |
| } |
| |
| bool MemoryIDEqual(const ProcessModID &compare) const { |
| return m_memory_id == compare.m_memory_id; |
| } |
| |
| bool StopIDEqual(const ProcessModID &compare) const { |
| return m_stop_id == compare.m_stop_id; |
| } |
| |
| void SetInvalid() { m_stop_id = UINT32_MAX; } |
| |
| bool IsValid() const { return m_stop_id != UINT32_MAX; } |
| |
| bool IsLastResumeForUserExpression() const { |
| // If we haven't yet resumed the target, then it can't be for a user |
| // expression... |
| if (m_resume_id == 0) |
| return false; |
| |
| return m_resume_id == m_last_user_expression_resume; |
| } |
| |
| void SetRunningUserExpression(bool on) { |
| if (on) |
| m_running_user_expression++; |
| else |
| m_running_user_expression--; |
| } |
| |
| void SetStopEventForLastNaturalStopID(lldb::EventSP event_sp) { |
| m_last_natural_stop_event = event_sp; |
| } |
| |
| lldb::EventSP GetStopEventForStopID(uint32_t stop_id) const { |
| if (stop_id == m_last_natural_stop_id) |
| return m_last_natural_stop_event; |
| return lldb::EventSP(); |
| } |
| |
| private: |
| uint32_t m_stop_id; |
| uint32_t m_last_natural_stop_id; |
| uint32_t m_resume_id; |
| uint32_t m_memory_id; |
| uint32_t m_last_user_expression_resume; |
| uint32_t m_running_user_expression; |
| lldb::EventSP m_last_natural_stop_event; |
| }; |
| |
| inline bool operator==(const ProcessModID &lhs, const ProcessModID &rhs) { |
| if (lhs.StopIDEqual(rhs) && lhs.MemoryIDEqual(rhs)) |
| return true; |
| else |
| return false; |
| } |
| |
| inline bool operator!=(const ProcessModID &lhs, const ProcessModID &rhs) { |
| return (!lhs.StopIDEqual(rhs) || !lhs.MemoryIDEqual(rhs)); |
| } |
| |
| //---------------------------------------------------------------------- |
| /// @class Process Process.h "lldb/Target/Process.h" |
| /// @brief A plug-in interface definition class for debugging a process. |
| //---------------------------------------------------------------------- |
| class Process : public std::enable_shared_from_this<Process>, |
| public ProcessProperties, |
| public UserID, |
| public Broadcaster, |
| public ExecutionContextScope, |
| public PluginInterface { |
| friend class FunctionCaller; // For WaitForStateChangeEventsPrivate |
| friend class Debugger; // For PopProcessIOHandler and ProcessIOHandlerIsActive |
| friend class DynamicLoader; // For LoadOperatingSystemPlugin |
| friend class ProcessEventData; |
| friend class StopInfo; |
| friend class Target; |
| friend class ThreadList; |
| |
| public: |
| //------------------------------------------------------------------ |
| /// Broadcaster event bits definitions. |
| //------------------------------------------------------------------ |
| enum { |
| eBroadcastBitStateChanged = (1 << 0), |
| eBroadcastBitInterrupt = (1 << 1), |
| eBroadcastBitSTDOUT = (1 << 2), |
| eBroadcastBitSTDERR = (1 << 3), |
| eBroadcastBitProfileData = (1 << 4), |
| eBroadcastBitStructuredData = (1 << 5), |
| }; |
| |
| enum { |
| eBroadcastInternalStateControlStop = (1 << 0), |
| eBroadcastInternalStateControlPause = (1 << 1), |
| eBroadcastInternalStateControlResume = (1 << 2) |
| }; |
| |
| //------------------------------------------------------------------ |
| /// Process warning types. |
| //------------------------------------------------------------------ |
| enum Warnings { eWarningsOptimization = 1 }; |
| |
| typedef Range<lldb::addr_t, lldb::addr_t> LoadRange; |
| // We use a read/write lock to allow on or more clients to |
| // access the process state while the process is stopped (reader). |
| // We lock the write lock to control access to the process |
| // while it is running (readers, or clients that want the process |
| // stopped can block waiting for the process to stop, or just |
| // try to lock it to see if they can immediately access the stopped |
| // process. If the try read lock fails, then the process is running. |
| typedef ProcessRunLock::ProcessRunLocker StopLocker; |
| |
| // These two functions fill out the Broadcaster interface: |
| |
| static ConstString &GetStaticBroadcasterClass(); |
| |
| ConstString &GetBroadcasterClass() const override { |
| return GetStaticBroadcasterClass(); |
| } |
| |
| //------------------------------------------------------------------ |
| /// A notification structure that can be used by clients to listen |
| /// for changes in a process's lifetime. |
| /// |
| /// @see RegisterNotificationCallbacks (const Notifications&) |
| /// @see UnregisterNotificationCallbacks (const Notifications&) |
| //------------------------------------------------------------------ |
| #ifndef SWIG |
| typedef struct { |
| void *baton; |
| void (*initialize)(void *baton, Process *process); |
| void (*process_state_changed)(void *baton, Process *process, |
| lldb::StateType state); |
| } Notifications; |
| |
| class ProcessEventData : public EventData { |
| friend class Process; |
| |
| public: |
| ProcessEventData(); |
| ProcessEventData(const lldb::ProcessSP &process, lldb::StateType state); |
| |
| ~ProcessEventData() override; |
| |
| static const ConstString &GetFlavorString(); |
| |
| const ConstString &GetFlavor() const override; |
| |
| lldb::ProcessSP GetProcessSP() const { return m_process_wp.lock(); } |
| |
| lldb::StateType GetState() const { return m_state; } |
| bool GetRestarted() const { return m_restarted; } |
| |
| size_t GetNumRestartedReasons() { return m_restarted_reasons.size(); } |
| |
| const char *GetRestartedReasonAtIndex(size_t idx) { |
| return ((idx < m_restarted_reasons.size()) |
| ? m_restarted_reasons[idx].c_str() |
| : nullptr); |
| } |
| |
| bool GetInterrupted() const { return m_interrupted; } |
| |
| void Dump(Stream *s) const override; |
| |
| void DoOnRemoval(Event *event_ptr) override; |
| |
| static const Process::ProcessEventData * |
| GetEventDataFromEvent(const Event *event_ptr); |
| |
| static lldb::ProcessSP GetProcessFromEvent(const Event *event_ptr); |
| |
| static lldb::StateType GetStateFromEvent(const Event *event_ptr); |
| |
| static bool GetRestartedFromEvent(const Event *event_ptr); |
| |
| static size_t GetNumRestartedReasons(const Event *event_ptr); |
| |
| static const char *GetRestartedReasonAtIndex(const Event *event_ptr, |
| size_t idx); |
| |
| static void AddRestartedReason(Event *event_ptr, const char *reason); |
| |
| static void SetRestartedInEvent(Event *event_ptr, bool new_value); |
| |
| static bool GetInterruptedFromEvent(const Event *event_ptr); |
| |
| static void SetInterruptedInEvent(Event *event_ptr, bool new_value); |
| |
| static bool SetUpdateStateOnRemoval(Event *event_ptr); |
| |
| private: |
| void SetUpdateStateOnRemoval() { m_update_state++; } |
| |
| void SetRestarted(bool new_value) { m_restarted = new_value; } |
| |
| void SetInterrupted(bool new_value) { m_interrupted = new_value; } |
| |
| void AddRestartedReason(const char *reason) { |
| m_restarted_reasons.push_back(reason); |
| } |
| |
| lldb::ProcessWP m_process_wp; |
| lldb::StateType m_state; |
| std::vector<std::string> m_restarted_reasons; |
| bool m_restarted; // For "eStateStopped" events, this is true if the target |
| // was automatically restarted. |
| int m_update_state; |
| bool m_interrupted; |
| |
| DISALLOW_COPY_AND_ASSIGN(ProcessEventData); |
| }; |
| #endif // SWIG |
| |
| //------------------------------------------------------------------ |
| /// Construct with a shared pointer to a target, and the Process listener. |
| /// Uses the Host UnixSignalsSP by default. |
| //------------------------------------------------------------------ |
| Process(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp); |
| |
| //------------------------------------------------------------------ |
| /// Construct with a shared pointer to a target, the Process listener, |
| /// and the appropriate UnixSignalsSP for the process. |
| //------------------------------------------------------------------ |
| Process(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, |
| const lldb::UnixSignalsSP &unix_signals_sp); |
| |
| //------------------------------------------------------------------ |
| /// Destructor. |
| /// |
| /// The destructor is virtual since this class is designed to be |
| /// inherited from by the plug-in instance. |
| //------------------------------------------------------------------ |
| ~Process() override; |
| |
| static void SettingsInitialize(); |
| |
| static void SettingsTerminate(); |
| |
| static const ProcessPropertiesSP &GetGlobalProperties(); |
| |
| //------------------------------------------------------------------ |
| /// Find a Process plug-in that can debug \a module using the |
| /// currently selected architecture. |
| /// |
| /// Scans all loaded plug-in interfaces that implement versions of |
| /// the Process plug-in interface and returns the first instance |
| /// that can debug the file. |
| /// |
| /// @param[in] module_sp |
| /// The module shared pointer that this process will debug. |
| /// |
| /// @param[in] plugin_name |
| /// If nullptr, select the best plug-in for the binary. If non-nullptr |
| /// then look for a plugin whose PluginInfo's name matches |
| /// this string. |
| /// |
| /// @see Process::CanDebug () |
| //------------------------------------------------------------------ |
| static lldb::ProcessSP FindPlugin(lldb::TargetSP target_sp, |
| llvm::StringRef plugin_name, |
| lldb::ListenerSP listener_sp, |
| const FileSpec *crash_file_path); |
| |
| //------------------------------------------------------------------ |
| /// Static function that can be used with the \b host function |
| /// Host::StartMonitoringChildProcess (). |
| /// |
| /// This function can be used by lldb_private::Process subclasses |
| /// when they want to watch for a local process and have its exit |
| /// status automatically set when the host child process exits. |
| /// Subclasses should call Host::StartMonitoringChildProcess () |
| /// with: |
| /// callback = Process::SetHostProcessExitStatus |
| /// pid = Process::GetID() |
| /// monitor_signals = false |
| //------------------------------------------------------------------ |
| static bool |
| SetProcessExitStatus(lldb::pid_t pid, // The process ID we want to monitor |
| bool exited, |
| int signo, // Zero for no signal |
| int status); // Exit value of process if signal is zero |
| |
| lldb::ByteOrder GetByteOrder() const; |
| |
| uint32_t GetAddressByteSize() const; |
| |
| uint32_t GetUniqueID() const { return m_process_unique_id; } |
| |
| //------------------------------------------------------------------ |
| /// Check if a plug-in instance can debug the file in \a module. |
| /// |
| /// Each plug-in is given a chance to say whether it can debug |
| /// the file in \a module. If the Process plug-in instance can |
| /// debug a file on the current system, it should return \b true. |
| /// |
| /// @return |
| /// Returns \b true if this Process plug-in instance can |
| /// debug the executable, \b false otherwise. |
| //------------------------------------------------------------------ |
| virtual bool CanDebug(lldb::TargetSP target, |
| bool plugin_specified_by_name) = 0; |
| |
| //------------------------------------------------------------------ |
| /// This object is about to be destroyed, do any necessary cleanup. |
| /// |
| /// Subclasses that override this method should always call this |
| /// superclass method. |
| //------------------------------------------------------------------ |
| virtual void Finalize(); |
| |
| //------------------------------------------------------------------ |
| /// Return whether this object is valid (i.e. has not been finalized.) |
| /// |
| /// @return |
| /// Returns \b true if this Process has not been finalized |
| /// and \b false otherwise. |
| //------------------------------------------------------------------ |
| bool IsValid() const { return !m_finalize_called; } |
| |
| //------------------------------------------------------------------ |
| /// Return a multi-word command object that can be used to expose |
| /// plug-in specific commands. |
| /// |
| /// This object will be used to resolve plug-in commands and can be |
| /// triggered by a call to: |
| /// |
| /// (lldb) process commmand <args> |
| /// |
| /// @return |
| /// A CommandObject which can be one of the concrete subclasses |
| /// of CommandObject like CommandObjectRaw, CommandObjectParsed, |
| /// or CommandObjectMultiword. |
| //------------------------------------------------------------------ |
| virtual CommandObject *GetPluginCommandObject() { return nullptr; } |
| |
| //------------------------------------------------------------------ |
| /// Launch a new process. |
| /// |
| /// Launch a new process by spawning a new process using the |
| /// target object's executable module's file as the file to launch. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses. It will first call Process::WillLaunch (Module *) |
| /// and if that returns \b true, Process::DoLaunch (Module*, |
| /// char const *[],char const *[],const char *,const char *, |
| /// const char *) will be called to actually do the launching. If |
| /// DoLaunch returns \b true, then Process::DidLaunch() will be |
| /// called. |
| /// |
| /// @param[in] launch_info |
| /// Details regarding the environment, STDIN/STDOUT/STDERR |
| /// redirection, working path, etc. related to the requested launch. |
| /// |
| /// @return |
| /// An error object. Call GetID() to get the process ID if |
| /// the error object is success. |
| //------------------------------------------------------------------ |
| virtual Status Launch(ProcessLaunchInfo &launch_info); |
| |
| virtual Status LoadCore(); |
| |
| virtual Status DoLoadCore() { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support loading core files.", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Get the dynamic loader plug-in for this process. |
| /// |
| /// The default action is to let the DynamicLoader plug-ins check |
| /// the main executable and the DynamicLoader will select itself |
| /// automatically. Subclasses can override this if inspecting the |
| /// executable is not desired, or if Process subclasses can only |
| /// use a specific DynamicLoader plug-in. |
| //------------------------------------------------------------------ |
| virtual DynamicLoader *GetDynamicLoader(); |
| |
| //------------------------------------------------------------------ |
| // Returns AUXV structure found in many ELF-based environments. |
| // |
| // The default action is to return an empty data buffer. |
| // |
| // @return |
| // A data buffer containing the contents of the AUXV data. |
| //------------------------------------------------------------------ |
| virtual const lldb::DataBufferSP GetAuxvData(); |
| |
| //------------------------------------------------------------------ |
| /// Sometimes processes know how to retrieve and load shared libraries. |
| /// This is normally done by DynamicLoader plug-ins, but sometimes the |
| /// connection to the process allows retrieving this information. The |
| /// dynamic loader plug-ins can use this function if they can't |
| /// determine the current shared library load state. |
| /// |
| /// @return |
| /// The number of shared libraries that were loaded |
| //------------------------------------------------------------------ |
| virtual size_t LoadModules() { return 0; } |
| |
| virtual size_t LoadModules(LoadedModuleInfoList &) { return 0; } |
| |
| protected: |
| virtual JITLoaderList &GetJITLoaders(); |
| |
| public: |
| //------------------------------------------------------------------ |
| /// Get the system runtime plug-in for this process. |
| /// |
| /// @return |
| /// Returns a pointer to the SystemRuntime plugin for this Process |
| /// if one is available. Else returns nullptr. |
| //------------------------------------------------------------------ |
| virtual SystemRuntime *GetSystemRuntime(); |
| |
| //------------------------------------------------------------------ |
| /// Attach to an existing process using the process attach info. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses. It will first call WillAttach (lldb::pid_t) |
| /// or WillAttach (const char *), and if that returns \b |
| /// true, DoAttach (lldb::pid_t) or DoAttach (const char *) will |
| /// be called to actually do the attach. If DoAttach returns \b |
| /// true, then Process::DidAttach() will be called. |
| /// |
| /// @param[in] pid |
| /// The process ID that we should attempt to attach to. |
| /// |
| /// @return |
| /// Returns \a pid if attaching was successful, or |
| /// LLDB_INVALID_PROCESS_ID if attaching fails. |
| //------------------------------------------------------------------ |
| virtual Status Attach(ProcessAttachInfo &attach_info); |
| |
| //------------------------------------------------------------------ |
| /// Attach to a remote system via a URL |
| /// |
| /// @param[in] strm |
| /// A stream where output intended for the user |
| /// (if the driver has a way to display that) generated during |
| /// the connection. This may be nullptr if no output is needed.A |
| /// |
| /// @param[in] remote_url |
| /// The URL format that we are connecting to. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status ConnectRemote(Stream *strm, llvm::StringRef remote_url); |
| |
| bool GetShouldDetach() const { return m_should_detach; } |
| |
| void SetShouldDetach(bool b) { m_should_detach = b; } |
| |
| //------------------------------------------------------------------ |
| /// Get the image information address for the current process. |
| /// |
| /// Some runtimes have system functions that can help dynamic |
| /// loaders locate the dynamic loader information needed to observe |
| /// shared libraries being loaded or unloaded. This function is |
| /// in the Process interface (as opposed to the DynamicLoader |
| /// interface) to ensure that remote debugging can take advantage of |
| /// this functionality. |
| /// |
| /// @return |
| /// The address of the dynamic loader information, or |
| /// LLDB_INVALID_ADDRESS if this is not supported by this |
| /// interface. |
| //------------------------------------------------------------------ |
| virtual lldb::addr_t GetImageInfoAddress(); |
| |
| //------------------------------------------------------------------ |
| /// Called when the process is about to broadcast a public stop. |
| /// |
| /// There are public and private stops. Private stops are when the |
| /// process is doing things like stepping and the client doesn't |
| /// need to know about starts and stop that implement a thread plan. |
| /// Single stepping over a source line in code might end up being |
| /// implemented by one or more process starts and stops. Public stops |
| /// are when clients will be notified that the process is stopped. |
| /// These events typically trigger UI updates (thread stack frames to |
| /// be displayed, variables to be displayed, and more). This function |
| /// can be overriden and allows process subclasses to do something |
| /// before the eBroadcastBitStateChanged event is sent to public |
| /// clients. |
| //------------------------------------------------------------------ |
| virtual void WillPublicStop() {} |
| |
| //------------------------------------------------------------------ |
| /// Register for process and thread notifications. |
| /// |
| /// Clients can register notification callbacks by filling out a |
| /// Process::Notifications structure and calling this function. |
| /// |
| /// @param[in] callbacks |
| /// A structure that contains the notification baton and |
| /// callback functions. |
| /// |
| /// @see Process::Notifications |
| //------------------------------------------------------------------ |
| #ifndef SWIG |
| void RegisterNotificationCallbacks(const Process::Notifications &callbacks); |
| #endif |
| |
| //------------------------------------------------------------------ |
| /// Unregister for process and thread notifications. |
| /// |
| /// Clients can unregister notification callbacks by passing a copy of |
| /// the original baton and callbacks in \a callbacks. |
| /// |
| /// @param[in] callbacks |
| /// A structure that contains the notification baton and |
| /// callback functions. |
| /// |
| /// @return |
| /// Returns \b true if the notification callbacks were |
| /// successfully removed from the process, \b false otherwise. |
| /// |
| /// @see Process::Notifications |
| //------------------------------------------------------------------ |
| #ifndef SWIG |
| bool UnregisterNotificationCallbacks(const Process::Notifications &callbacks); |
| #endif |
| |
| //================================================================== |
| // Built in Process Control functions |
| //================================================================== |
| //------------------------------------------------------------------ |
| /// Resumes all of a process's threads as configured using the |
| /// Thread run control functions. |
| /// |
| /// Threads for a process should be updated with one of the run |
| /// control actions (resume, step, or suspend) that they should take |
| /// when the process is resumed. If no run control action is given |
| /// to a thread it will be resumed by default. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses. This function will take care of disabling any |
| /// breakpoints that threads may be stopped at, single stepping, and |
| /// re-enabling breakpoints, and enabling the basic flow control |
| /// that the plug-in instances need not worry about. |
| /// |
| /// N.B. This function also sets the Write side of the Run Lock, |
| /// which is unset when the corresponding stop event is pulled off |
| /// the Public Event Queue. If you need to resume the process without |
| /// setting the Run Lock, use PrivateResume (though you should only do |
| /// that from inside the Process class. |
| /// |
| /// @return |
| /// Returns an error object. |
| /// |
| /// @see Thread:Resume() |
| /// @see Thread:Step() |
| /// @see Thread:Suspend() |
| //------------------------------------------------------------------ |
| Status Resume(); |
| |
| Status ResumeSynchronous(Stream *stream); |
| |
| //------------------------------------------------------------------ |
| /// Halts a running process. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses. |
| /// If the process is successfully halted, a eStateStopped |
| /// process event with GetInterrupted will be broadcast. If false, we will |
| /// halt the process with no events generated by the halt. |
| /// |
| /// @param[in] clear_thread_plans |
| /// If true, when the process stops, clear all thread plans. |
| /// |
| /// @param[in] use_run_lock |
| /// Whether to release the run lock after the stop. |
| /// |
| /// @return |
| /// Returns an error object. If the error is empty, the process is |
| /// halted. |
| /// otherwise the halt has failed. |
| //------------------------------------------------------------------ |
| Status Halt(bool clear_thread_plans = false, bool use_run_lock = true); |
| |
| //------------------------------------------------------------------ |
| /// Detaches from a running or stopped process. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses. |
| /// |
| /// @param[in] keep_stopped |
| /// If true, don't resume the process on detach. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| Status Detach(bool keep_stopped); |
| |
| //------------------------------------------------------------------ |
| /// Kills the process and shuts down all threads that were spawned |
| /// to track and monitor the process. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses. |
| /// |
| /// @param[in] force_kill |
| /// Whether lldb should force a kill (instead of a detach) from |
| /// the inferior process. Normally if lldb launched a binary and |
| /// Destory is called, lldb kills it. If lldb attached to a |
| /// running process and Destory is called, lldb detaches. If |
| /// this behavior needs to be over-ridden, this is the bool that |
| /// can be used. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| Status Destroy(bool force_kill); |
| |
| //------------------------------------------------------------------ |
| /// Sends a process a UNIX signal \a signal. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| Status Signal(int signal); |
| |
| void SetUnixSignals(lldb::UnixSignalsSP &&signals_sp); |
| |
| const lldb::UnixSignalsSP &GetUnixSignals(); |
| |
| //================================================================== |
| // Plug-in Process Control Overrides |
| //================================================================== |
| |
| //------------------------------------------------------------------ |
| /// Called before attaching to a process. |
| /// |
| /// Allow Process plug-ins to execute some code before attaching a |
| /// process. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status WillAttachToProcessWithID(lldb::pid_t pid) { return Status(); } |
| |
| //------------------------------------------------------------------ |
| /// Called before attaching to a process. |
| /// |
| /// Allow Process plug-ins to execute some code before attaching a |
| /// process. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status WillAttachToProcessWithName(const char *process_name, |
| bool wait_for_launch) { |
| return Status(); |
| } |
| |
| //------------------------------------------------------------------ |
| /// Attach to a remote system via a URL |
| /// |
| /// @param[in] strm |
| /// A stream where output intended for the user |
| /// (if the driver has a way to display that) generated during |
| /// the connection. This may be nullptr if no output is needed.A |
| /// |
| /// @param[in] remote_url |
| /// The URL format that we are connecting to. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status DoConnectRemote(Stream *strm, llvm::StringRef remote_url) { |
| Status error; |
| error.SetErrorString("remote connections are not supported"); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Attach to an existing process using a process ID. |
| /// |
| /// @param[in] pid |
| /// The process ID that we should attempt to attach to. |
| /// |
| /// @param[in] attach_info |
| /// Information on how to do the attach. For example, GetUserID() |
| /// will return the uid to attach as. |
| /// |
| /// @return |
| /// Returns a successful Status attaching was successful, or |
| /// an appropriate (possibly platform-specific) error code if |
| /// attaching fails. |
| /// hanming : need flag |
| //------------------------------------------------------------------ |
| virtual Status DoAttachToProcessWithID(lldb::pid_t pid, |
| const ProcessAttachInfo &attach_info) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support attaching to a process by pid", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Attach to an existing process using a partial process name. |
| /// |
| /// @param[in] process_name |
| /// The name of the process to attach to. |
| /// |
| /// @param[in] attach_info |
| /// Information on how to do the attach. For example, GetUserID() |
| /// will return the uid to attach as. |
| /// |
| /// @return |
| /// Returns a successful Status attaching was successful, or |
| /// an appropriate (possibly platform-specific) error code if |
| /// attaching fails. |
| //------------------------------------------------------------------ |
| virtual Status |
| DoAttachToProcessWithName(const char *process_name, |
| const ProcessAttachInfo &attach_info) { |
| Status error; |
| error.SetErrorString("attach by name is not supported"); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Called after attaching a process. |
| /// |
| /// @param[in] process_arch |
| /// If you can figure out the process architecture after attach, fill it |
| /// in here. |
| /// |
| /// Allow Process plug-ins to execute some code after attaching to |
| /// a process. |
| //------------------------------------------------------------------ |
| virtual void DidAttach(ArchSpec &process_arch) { process_arch.Clear(); } |
| |
| //------------------------------------------------------------------ |
| /// Called after a process re-execs itself. |
| /// |
| /// Allow Process plug-ins to execute some code after a process has |
| /// exec'ed itself. Subclasses typically should override DoDidExec() |
| /// as the lldb_private::Process class needs to remove its dynamic |
| /// loader, runtime, ABI and other plug-ins, as well as unload all |
| /// shared libraries. |
| //------------------------------------------------------------------ |
| virtual void DidExec(); |
| |
| //------------------------------------------------------------------ |
| /// Subclasses of Process should implement this function if they |
| /// need to do anything after a process exec's itself. |
| //------------------------------------------------------------------ |
| virtual void DoDidExec() {} |
| |
| //------------------------------------------------------------------ |
| /// Called before launching to a process. |
| /// |
| /// Allow Process plug-ins to execute some code before launching a |
| /// process. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status WillLaunch(Module *module) { return Status(); } |
| |
| //------------------------------------------------------------------ |
| /// Launch a new process. |
| /// |
| /// Launch a new process by spawning a new process using |
| /// \a exe_module's file as the file to launch. Launch details are |
| /// provided in \a launch_info. |
| /// |
| /// @param[in] exe_module |
| /// The module from which to extract the file specification and |
| /// launch. |
| /// |
| /// @param[in] launch_info |
| /// Details (e.g. arguments, stdio redirection, etc.) for the |
| /// requested launch. |
| /// |
| /// @return |
| /// An Status instance indicating success or failure of the |
| /// operation. |
| //------------------------------------------------------------------ |
| virtual Status DoLaunch(Module *exe_module, ProcessLaunchInfo &launch_info) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support launching processes", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Called after launching a process. |
| /// |
| /// Allow Process plug-ins to execute some code after launching |
| /// a process. |
| //------------------------------------------------------------------ |
| virtual void DidLaunch() {} |
| |
| //------------------------------------------------------------------ |
| /// Called before resuming to a process. |
| /// |
| /// Allow Process plug-ins to execute some code before resuming a |
| /// process. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status WillResume() { return Status(); } |
| |
| //------------------------------------------------------------------ |
| /// Resumes all of a process's threads as configured using the |
| /// Thread run control functions. |
| /// |
| /// Threads for a process should be updated with one of the run |
| /// control actions (resume, step, or suspend) that they should take |
| /// when the process is resumed. If no run control action is given |
| /// to a thread it will be resumed by default. |
| /// |
| /// @return |
| /// Returns \b true if the process successfully resumes using |
| /// the thread run control actions, \b false otherwise. |
| /// |
| /// @see Thread:Resume() |
| /// @see Thread:Step() |
| /// @see Thread:Suspend() |
| //------------------------------------------------------------------ |
| virtual Status DoResume() { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support resuming processes", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Called after resuming a process. |
| /// |
| /// Allow Process plug-ins to execute some code after resuming |
| /// a process. |
| //------------------------------------------------------------------ |
| virtual void DidResume() {} |
| |
| //------------------------------------------------------------------ |
| /// Called before halting to a process. |
| /// |
| /// Allow Process plug-ins to execute some code before halting a |
| /// process. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status WillHalt() { return Status(); } |
| |
| //------------------------------------------------------------------ |
| /// Halts a running process. |
| /// |
| /// DoHalt must produce one and only one stop StateChanged event if it |
| /// actually |
| /// stops the process. If the stop happens through some natural event (for |
| /// instance a SIGSTOP), then forwarding that event will do. Otherwise, you |
| /// must |
| /// generate the event manually. This function is called from the context of |
| /// the |
| /// private state thread. |
| /// |
| /// @param[out] caused_stop |
| /// If true, then this Halt caused the stop, otherwise, the |
| /// process was already stopped. |
| /// |
| /// @return |
| /// Returns \b true if the process successfully halts, \b false |
| /// otherwise. |
| //------------------------------------------------------------------ |
| virtual Status DoHalt(bool &caused_stop) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support halting processes", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Called after halting a process. |
| /// |
| /// Allow Process plug-ins to execute some code after halting |
| /// a process. |
| //------------------------------------------------------------------ |
| virtual void DidHalt() {} |
| |
| //------------------------------------------------------------------ |
| /// Called before detaching from a process. |
| /// |
| /// Allow Process plug-ins to execute some code before detaching |
| /// from a process. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status WillDetach() { return Status(); } |
| |
| //------------------------------------------------------------------ |
| /// Detaches from a running or stopped process. |
| /// |
| /// @return |
| /// Returns \b true if the process successfully detaches, \b |
| /// false otherwise. |
| //------------------------------------------------------------------ |
| virtual Status DoDetach(bool keep_stopped) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support detaching from processes", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Called after detaching from a process. |
| /// |
| /// Allow Process plug-ins to execute some code after detaching |
| /// from a process. |
| //------------------------------------------------------------------ |
| virtual void DidDetach() {} |
| |
| virtual bool DetachRequiresHalt() { return false; } |
| |
| //------------------------------------------------------------------ |
| /// Called before sending a signal to a process. |
| /// |
| /// Allow Process plug-ins to execute some code before sending a |
| /// signal to a process. |
| /// |
| /// @return |
| /// Returns no error if it is safe to proceed with a call to |
| /// Process::DoSignal(int), otherwise an error describing what |
| /// prevents the signal from being sent. |
| //------------------------------------------------------------------ |
| virtual Status WillSignal() { return Status(); } |
| |
| //------------------------------------------------------------------ |
| /// Sends a process a UNIX signal \a signal. |
| /// |
| /// @return |
| /// Returns an error object. |
| //------------------------------------------------------------------ |
| virtual Status DoSignal(int signal) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support sending signals to processes", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| virtual Status WillDestroy() { return Status(); } |
| |
| virtual Status DoDestroy() = 0; |
| |
| virtual void DidDestroy() {} |
| |
| virtual bool DestroyRequiresHalt() { return true; } |
| |
| //------------------------------------------------------------------ |
| /// Called after sending a signal to a process. |
| /// |
| /// Allow Process plug-ins to execute some code after sending a |
| /// signal to a process. |
| //------------------------------------------------------------------ |
| virtual void DidSignal() {} |
| |
| //------------------------------------------------------------------ |
| /// Currently called as part of ShouldStop. |
| /// FIXME: Should really happen when the target stops before the |
| /// event is taken from the queue... |
| /// |
| /// This callback is called as the event |
| /// is about to be queued up to allow Process plug-ins to execute |
| /// some code prior to clients being notified that a process was |
| /// stopped. Common operations include updating the thread list, |
| /// invalidating any thread state (registers, stack, etc) prior to |
| /// letting the notification go out. |
| /// |
| //------------------------------------------------------------------ |
| virtual void RefreshStateAfterStop() = 0; |
| |
| //------------------------------------------------------------------ |
| /// Sometimes the connection to a process can detect the host OS |
| /// version that the process is running on. The current platform |
| /// should be checked first in case the platform is connected, but |
| /// clients can fall back onto this function if the platform fails |
| /// to identify the host OS version. The platform should be checked |
| /// first in case you are running a simulator platform that might |
| /// itself be running natively, but have different heuristics for |
| /// figuring out which OS is is emulating. |
| /// |
| /// @param[out] major |
| /// The major OS version, or UINT32_MAX if it can't be determined |
| /// |
| /// @param[out] minor |
| /// The minor OS version, or UINT32_MAX if it can't be determined |
| /// |
| /// @param[out] update |
| /// The update OS version, or UINT32_MAX if it can't be determined |
| /// |
| /// @return |
| /// Returns \b true if the host OS version info was filled in |
| /// and \b false otherwise. |
| //------------------------------------------------------------------ |
| virtual bool GetHostOSVersion(uint32_t &major, uint32_t &minor, |
| uint32_t &update) { |
| major = UINT32_MAX; |
| minor = UINT32_MAX; |
| update = UINT32_MAX; |
| return false; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Get the target object pointer for this module. |
| /// |
| /// @return |
| /// A Target object pointer to the target that owns this |
| /// module. |
| //------------------------------------------------------------------ |
| Target &GetTarget() { return *m_target_sp.lock(); } |
| |
| //------------------------------------------------------------------ |
| /// Get the const target object pointer for this module. |
| /// |
| /// @return |
| /// A const Target object pointer to the target that owns this |
| /// module. |
| //------------------------------------------------------------------ |
| const Target &GetTarget() const { return *m_target_sp.lock(); } |
| |
| //------------------------------------------------------------------ |
| /// Flush all data in the process. |
| /// |
| /// Flush the memory caches, all threads, and any other cached data |
| /// in the process. |
| /// |
| /// This function can be called after a world changing event like |
| /// adding a new symbol file, or after the process makes a large |
| /// context switch (from boot ROM to booted into an OS). |
| //------------------------------------------------------------------ |
| void Flush(); |
| |
| //------------------------------------------------------------------ |
| /// Get accessor for the current process state. |
| /// |
| /// @return |
| /// The current state of the process. |
| /// |
| /// @see lldb::StateType |
| //------------------------------------------------------------------ |
| lldb::StateType GetState(); |
| |
| lldb::ExpressionResults |
| RunThreadPlan(ExecutionContext &exe_ctx, lldb::ThreadPlanSP &thread_plan_sp, |
| const EvaluateExpressionOptions &options, |
| DiagnosticManager &diagnostic_manager); |
| |
| static const char *ExecutionResultAsCString(lldb::ExpressionResults result); |
| |
| void GetStatus(Stream &ostrm); |
| |
| size_t GetThreadStatus(Stream &ostrm, bool only_threads_with_stop_reason, |
| uint32_t start_frame, uint32_t num_frames, |
| uint32_t num_frames_with_source, |
| bool stop_format); |
| |
| void SendAsyncInterrupt(); |
| |
| //------------------------------------------------------------------ |
| // Notify this process class that modules got loaded. |
| // |
| // If subclasses override this method, they must call this version |
| // before doing anything in the subclass version of the function. |
| //------------------------------------------------------------------ |
| virtual void ModulesDidLoad(ModuleList &module_list); |
| |
| //------------------------------------------------------------------ |
| /// Retrieve the list of shared libraries that are loaded for this process |
| /// This method is used on pre-macOS 10.12, pre-iOS 10, pre-tvOS 10, |
| /// pre-watchOS 3 systems. The following two methods are for newer versions |
| /// of those OSes. |
| /// |
| /// For certain platforms, the time it takes for the DynamicLoader plugin to |
| /// read all of the shared libraries out of memory over a slow communication |
| /// channel may be too long. In that instance, the gdb-remote stub may be |
| /// able to retrieve the necessary information about the solibs out of memory |
| /// and return a concise summary sufficient for the DynamicLoader plugin. |
| /// |
| /// @param [in] image_list_address |
| /// The address where the table of shared libraries is stored in memory, |
| /// if that is appropriate for this platform. Else this may be |
| /// passed as LLDB_INVALID_ADDRESS. |
| /// |
| /// @param [in] image_count |
| /// The number of shared libraries that are present in this process, if |
| /// that is appropriate for this platofrm Else this may be passed as |
| /// LLDB_INVALID_ADDRESS. |
| /// |
| /// @return |
| /// A StructureDataSP object which, if non-empty, will contain the |
| /// information the DynamicLoader needs to get the initial scan of |
| /// solibs resolved. |
| //------------------------------------------------------------------ |
| virtual lldb_private::StructuredData::ObjectSP |
| GetLoadedDynamicLibrariesInfos(lldb::addr_t image_list_address, |
| lldb::addr_t image_count) { |
| return StructuredData::ObjectSP(); |
| } |
| |
| // On macOS 10.12, tvOS 10, iOS 10, watchOS 3 and newer, debugserver can |
| // return |
| // the full list of loaded shared libraries without needing any input. |
| virtual lldb_private::StructuredData::ObjectSP |
| GetLoadedDynamicLibrariesInfos() { |
| return StructuredData::ObjectSP(); |
| } |
| |
| // On macOS 10.12, tvOS 10, iOS 10, watchOS 3 and newer, debugserver can |
| // return |
| // information about binaries given their load addresses. |
| virtual lldb_private::StructuredData::ObjectSP GetLoadedDynamicLibrariesInfos( |
| const std::vector<lldb::addr_t> &load_addresses) { |
| return StructuredData::ObjectSP(); |
| } |
| |
| //------------------------------------------------------------------ |
| // Get information about the library shared cache, if that exists |
| // |
| // On macOS 10.12, tvOS 10, iOS 10, watchOS 3 and newer, debugserver can |
| // return |
| // information about the library shared cache (a set of standard libraries |
| // that are |
| // loaded at the same location for all processes on a system) in use. |
| //------------------------------------------------------------------ |
| virtual lldb_private::StructuredData::ObjectSP GetSharedCacheInfo() { |
| return StructuredData::ObjectSP(); |
| } |
| |
| //------------------------------------------------------------------ |
| /// Print a user-visible warning about a module being built with optimization |
| /// |
| /// Prints a async warning message to the user one time per Module |
| /// where a function is found that was compiled with optimization, per |
| /// Process. |
| /// |
| /// @param [in] sc |
| /// A SymbolContext with eSymbolContextFunction and eSymbolContextModule |
| /// pre-computed. |
| //------------------------------------------------------------------ |
| void PrintWarningOptimization(const SymbolContext &sc); |
| |
| virtual bool GetProcessInfo(ProcessInstanceInfo &info); |
| |
| public: |
| //------------------------------------------------------------------ |
| /// Get the exit status for a process. |
| /// |
| /// @return |
| /// The process's return code, or -1 if the current process |
| /// state is not eStateExited. |
| //------------------------------------------------------------------ |
| int GetExitStatus(); |
| |
| //------------------------------------------------------------------ |
| /// Get a textual description of what the process exited. |
| /// |
| /// @return |
| /// The textual description of why the process exited, or nullptr |
| /// if there is no description available. |
| //------------------------------------------------------------------ |
| const char *GetExitDescription(); |
| |
| virtual void DidExit() {} |
| |
| //------------------------------------------------------------------ |
| /// Get the Modification ID of the process. |
| /// |
| /// @return |
| /// The modification ID of the process. |
| //------------------------------------------------------------------ |
| ProcessModID GetModID() const { return m_mod_id; } |
| |
| const ProcessModID &GetModIDRef() const { return m_mod_id; } |
| |
| uint32_t GetStopID() const { return m_mod_id.GetStopID(); } |
| |
| uint32_t GetResumeID() const { return m_mod_id.GetResumeID(); } |
| |
| uint32_t GetLastUserExpressionResumeID() const { |
| return m_mod_id.GetLastUserExpressionResumeID(); |
| } |
| |
| uint32_t GetLastNaturalStopID() const { |
| return m_mod_id.GetLastNaturalStopID(); |
| } |
| |
| lldb::EventSP GetStopEventForStopID(uint32_t stop_id) const { |
| return m_mod_id.GetStopEventForStopID(stop_id); |
| } |
| |
| //------------------------------------------------------------------ |
| /// Set accessor for the process exit status (return code). |
| /// |
| /// Sometimes a child exits and the exit can be detected by global |
| /// functions (signal handler for SIGCHLD for example). This |
| /// accessor allows the exit status to be set from an external |
| /// source. |
| /// |
| /// Setting this will cause a eStateExited event to be posted to |
| /// the process event queue. |
| /// |
| /// @param[in] exit_status |
| /// The value for the process's return code. |
| /// |
| /// @see lldb::StateType |
| //------------------------------------------------------------------ |
| virtual bool SetExitStatus(int exit_status, const char *cstr); |
| |
| //------------------------------------------------------------------ |
| /// Check if a process is still alive. |
| /// |
| /// @return |
| /// Returns \b true if the process is still valid, \b false |
| /// otherwise. |
| //------------------------------------------------------------------ |
| virtual bool IsAlive(); |
| |
| //------------------------------------------------------------------ |
| /// Before lldb detaches from a process, it warns the user that they are about |
| /// to lose their debug session. |
| /// In some cases, this warning doesn't need to be emitted -- for instance, |
| /// with core file debugging where |
| /// the user can reconstruct the "state" by simply re-running the debugger on |
| /// the core file. |
| /// |
| /// @return |
| // true if the user should be warned about detaching from this process. |
| //------------------------------------------------------------------ |
| virtual bool WarnBeforeDetach() const { return true; } |
| |
| //------------------------------------------------------------------ |
| /// Actually do the reading of memory from a process. |
| /// |
| /// Subclasses must override this function and can return fewer |
| /// bytes than requested when memory requests are too large. This |
| /// class will break up the memory requests and keep advancing the |
| /// arguments along as needed. |
| /// |
| /// @param[in] vm_addr |
| /// A virtual load address that indicates where to start reading |
| /// memory from. |
| /// |
| /// @param[in] size |
| /// The number of bytes to read. |
| /// |
| /// @param[out] buf |
| /// A byte buffer that is at least \a size bytes long that |
| /// will receive the memory bytes. |
| /// |
| /// @return |
| /// The number of bytes that were actually read into \a buf. |
| //------------------------------------------------------------------ |
| virtual size_t DoReadMemory(lldb::addr_t vm_addr, void *buf, size_t size, |
| Status &error) = 0; |
| |
| //------------------------------------------------------------------ |
| /// Read of memory from a process. |
| /// |
| /// This function will read memory from the current process's |
| /// address space and remove any traps that may have been inserted |
| /// into the memory. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses, the subclasses should implement |
| /// Process::DoReadMemory (lldb::addr_t, size_t, void *). |
| /// |
| /// @param[in] vm_addr |
| /// A virtual load address that indicates where to start reading |
| /// memory from. |
| /// |
| /// @param[out] buf |
| /// A byte buffer that is at least \a size bytes long that |
| /// will receive the memory bytes. |
| /// |
| /// @param[in] size |
| /// The number of bytes to read. |
| /// |
| /// @return |
| /// The number of bytes that were actually read into \a buf. If |
| /// the returned number is greater than zero, yet less than \a |
| /// size, then this function will get called again with \a |
| /// vm_addr, \a buf, and \a size updated appropriately. Zero is |
| /// returned to indicate an error. |
| //------------------------------------------------------------------ |
| virtual size_t ReadMemory(lldb::addr_t vm_addr, void *buf, size_t size, |
| Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Read a NULL terminated string from memory |
| /// |
| /// This function will read a cache page at a time until a NULL |
| /// string terminator is found. It will stop reading if an aligned |
| /// sequence of NULL termination \a type_width bytes is not found |
| /// before reading \a cstr_max_len bytes. The results are always |
| /// guaranteed to be NULL terminated, and that no more than |
| /// (max_bytes - type_width) bytes will be read. |
| /// |
| /// @param[in] vm_addr |
| /// The virtual load address to start the memory read. |
| /// |
| /// @param[in] str |
| /// A character buffer containing at least max_bytes. |
| /// |
| /// @param[in] max_bytes |
| /// The maximum number of bytes to read. |
| /// |
| /// @param[in] error |
| /// The error status of the read operation. |
| /// |
| /// @param[in] type_width |
| /// The size of the null terminator (1 to 4 bytes per |
| /// character). Defaults to 1. |
| /// |
| /// @return |
| /// The error status or the number of bytes prior to the null terminator. |
| //------------------------------------------------------------------ |
| size_t ReadStringFromMemory(lldb::addr_t vm_addr, char *str, size_t max_bytes, |
| Status &error, size_t type_width = 1); |
| |
| //------------------------------------------------------------------ |
| /// Read a NULL terminated C string from memory |
| /// |
| /// This function will read a cache page at a time until the NULL |
| /// C string terminator is found. It will stop reading if the NULL |
| /// termination byte isn't found before reading \a cstr_max_len |
| /// bytes, and the results are always guaranteed to be NULL |
| /// terminated (at most cstr_max_len - 1 bytes will be read). |
| //------------------------------------------------------------------ |
| size_t ReadCStringFromMemory(lldb::addr_t vm_addr, char *cstr, |
| size_t cstr_max_len, Status &error); |
| |
| size_t ReadCStringFromMemory(lldb::addr_t vm_addr, std::string &out_str, |
| Status &error); |
| |
| size_t ReadMemoryFromInferior(lldb::addr_t vm_addr, void *buf, size_t size, |
| Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Reads an unsigned integer of the specified byte size from |
| /// process memory. |
| /// |
| /// @param[in] load_addr |
| /// A load address of the integer to read. |
| /// |
| /// @param[in] byte_size |
| /// The size in byte of the integer to read. |
| /// |
| /// @param[in] fail_value |
| /// The value to return if we fail to read an integer. |
| /// |
| /// @param[out] error |
| /// An error that indicates the success or failure of this |
| /// operation. If error indicates success (error.Success()), |
| /// then the value returned can be trusted, otherwise zero |
| /// will be returned. |
| /// |
| /// @return |
| /// The unsigned integer that was read from the process memory |
| /// space. If the integer was smaller than a uint64_t, any |
| /// unused upper bytes will be zero filled. If the process |
| /// byte order differs from the host byte order, the integer |
| /// value will be appropriately byte swapped into host byte |
| /// order. |
| //------------------------------------------------------------------ |
| uint64_t ReadUnsignedIntegerFromMemory(lldb::addr_t load_addr, |
| size_t byte_size, uint64_t fail_value, |
| Status &error); |
| |
| int64_t ReadSignedIntegerFromMemory(lldb::addr_t load_addr, size_t byte_size, |
| int64_t fail_value, Status &error); |
| |
| lldb::addr_t ReadPointerFromMemory(lldb::addr_t vm_addr, Status &error); |
| |
| bool WritePointerToMemory(lldb::addr_t vm_addr, lldb::addr_t ptr_value, |
| Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Actually do the writing of memory to a process. |
| /// |
| /// @param[in] vm_addr |
| /// A virtual load address that indicates where to start writing |
| /// memory to. |
| /// |
| /// @param[in] buf |
| /// A byte buffer that is at least \a size bytes long that |
| /// contains the data to write. |
| /// |
| /// @param[in] size |
| /// The number of bytes to write. |
| /// |
| /// @param[out] error |
| /// An error value in case the memory write fails. |
| /// |
| /// @return |
| /// The number of bytes that were actually written. |
| //------------------------------------------------------------------ |
| virtual size_t DoWriteMemory(lldb::addr_t vm_addr, const void *buf, |
| size_t size, Status &error) { |
| error.SetErrorStringWithFormat( |
| "error: %s does not support writing to processes", |
| GetPluginName().GetCString()); |
| return 0; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Write all or part of a scalar value to memory. |
| /// |
| /// The value contained in \a scalar will be swapped to match the |
| /// byte order of the process that is being debugged. If \a size is |
| /// less than the size of scalar, the least significant \a size bytes |
| /// from scalar will be written. If \a size is larger than the byte |
| /// size of scalar, then the extra space will be padded with zeros |
| /// and the scalar value will be placed in the least significant |
| /// bytes in memory. |
| /// |
| /// @param[in] vm_addr |
| /// A virtual load address that indicates where to start writing |
| /// memory to. |
| /// |
| /// @param[in] scalar |
| /// The scalar to write to the debugged process. |
| /// |
| /// @param[in] size |
| /// This value can be smaller or larger than the scalar value |
| /// itself. If \a size is smaller than the size of \a scalar, |
| /// the least significant bytes in \a scalar will be used. If |
| /// \a size is larger than the byte size of \a scalar, then |
| /// the extra space will be padded with zeros. If \a size is |
| /// set to UINT32_MAX, then the size of \a scalar will be used. |
| /// |
| /// @param[out] error |
| /// An error value in case the memory write fails. |
| /// |
| /// @return |
| /// The number of bytes that were actually written. |
| //------------------------------------------------------------------ |
| size_t WriteScalarToMemory(lldb::addr_t vm_addr, const Scalar &scalar, |
| size_t size, Status &error); |
| |
| size_t ReadScalarIntegerFromMemory(lldb::addr_t addr, uint32_t byte_size, |
| bool is_signed, Scalar &scalar, |
| Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Write memory to a process. |
| /// |
| /// This function will write memory to the current process's |
| /// address space and maintain any traps that might be present due |
| /// to software breakpoints. |
| /// |
| /// This function is not meant to be overridden by Process |
| /// subclasses, the subclasses should implement |
| /// Process::DoWriteMemory (lldb::addr_t, size_t, void *). |
| /// |
| /// @param[in] vm_addr |
| /// A virtual load address that indicates where to start writing |
| /// memory to. |
| /// |
| /// @param[in] buf |
| /// A byte buffer that is at least \a size bytes long that |
| /// contains the data to write. |
| /// |
| /// @param[in] size |
| /// The number of bytes to write. |
| /// |
| /// @return |
| /// The number of bytes that were actually written. |
| //------------------------------------------------------------------ |
| // TODO: change this to take an ArrayRef<uint8_t> |
| size_t WriteMemory(lldb::addr_t vm_addr, const void *buf, size_t size, |
| Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Actually allocate memory in the process. |
| /// |
| /// This function will allocate memory in the process's address |
| /// space. This can't rely on the generic function calling mechanism, |
| /// since that requires this function. |
| /// |
| /// @param[in] size |
| /// The size of the allocation requested. |
| /// |
| /// @return |
| /// The address of the allocated buffer in the process, or |
| /// LLDB_INVALID_ADDRESS if the allocation failed. |
| //------------------------------------------------------------------ |
| |
| virtual lldb::addr_t DoAllocateMemory(size_t size, uint32_t permissions, |
| Status &error) { |
| error.SetErrorStringWithFormat( |
| "error: %s does not support allocating in the debug process", |
| GetPluginName().GetCString()); |
| return LLDB_INVALID_ADDRESS; |
| } |
| |
| virtual Status WriteObjectFile(std::vector<ObjectFile::LoadableData> entries); |
| |
| //------------------------------------------------------------------ |
| /// The public interface to allocating memory in the process. |
| /// |
| /// This function will allocate memory in the process's address |
| /// space. This can't rely on the generic function calling mechanism, |
| /// since that requires this function. |
| /// |
| /// @param[in] size |
| /// The size of the allocation requested. |
| /// |
| /// @param[in] permissions |
| /// Or together any of the lldb::Permissions bits. The permissions on |
| /// a given memory allocation can't be changed after allocation. Note |
| /// that a block that isn't set writable can still be written on from |
| /// lldb, |
| /// just not by the process itself. |
| /// |
| /// @param[in,out] error |
| /// An error object to fill in if things go wrong. |
| /// @return |
| /// The address of the allocated buffer in the process, or |
| /// LLDB_INVALID_ADDRESS if the allocation failed. |
| //------------------------------------------------------------------ |
| lldb::addr_t AllocateMemory(size_t size, uint32_t permissions, Status &error); |
| |
| //------------------------------------------------------------------ |
| /// The public interface to allocating memory in the process, this also |
| /// clears the allocated memory. |
| /// |
| /// This function will allocate memory in the process's address |
| /// space. This can't rely on the generic function calling mechanism, |
| /// since that requires this function. |
| /// |
| /// @param[in] size |
| /// The size of the allocation requested. |
| /// |
| /// @param[in] permissions |
| /// Or together any of the lldb::Permissions bits. The permissions on |
| /// a given memory allocation can't be changed after allocation. Note |
| /// that a block that isn't set writable can still be written on from |
| /// lldb, |
| /// just not by the process itself. |
| /// |
| /// @param[in/out] error |
| /// An error object to fill in if things go wrong. |
| /// @return |
| /// The address of the allocated buffer in the process, or |
| /// LLDB_INVALID_ADDRESS if the allocation failed. |
| //------------------------------------------------------------------ |
| |
| lldb::addr_t CallocateMemory(size_t size, uint32_t permissions, |
| Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Resolve dynamically loaded indirect functions. |
| /// |
| /// @param[in] address |
| /// The load address of the indirect function to resolve. |
| /// |
| /// @param[out] error |
| /// An error value in case the resolve fails. |
| /// |
| /// @return |
| /// The address of the resolved function. |
| /// LLDB_INVALID_ADDRESS if the resolution failed. |
| //------------------------------------------------------------------ |
| virtual lldb::addr_t ResolveIndirectFunction(const Address *address, |
| Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Locate the memory region that contains load_addr. |
| /// |
| /// If load_addr is within the address space the process has mapped |
| /// range_info will be filled in with the start and end of that range |
| /// as well as the permissions for that range and range_info.GetMapped |
| /// will return true. |
| /// |
| /// If load_addr is outside any mapped region then range_info will |
| /// have its start address set to load_addr and the end of the |
| /// range will indicate the start of the next mapped range or be |
| /// set to LLDB_INVALID_ADDRESS if there are no valid mapped ranges |
| /// between load_addr and the end of the process address space. |
| /// |
| /// GetMemoryRegionInfo will only return an error if it is |
| /// unimplemented for the current process. |
| /// |
| /// @param[in] load_addr |
| /// The load address to query the range_info for. |
| /// |
| /// @param[out] range_info |
| /// An range_info value containing the details of the range. |
| /// |
| /// @return |
| /// An error value. |
| //------------------------------------------------------------------ |
| virtual Status GetMemoryRegionInfo(lldb::addr_t load_addr, |
| MemoryRegionInfo &range_info) { |
| Status error; |
| error.SetErrorString("Process::GetMemoryRegionInfo() not supported"); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Obtain all the mapped memory regions within this process. |
| /// |
| /// @param[out] region_list |
| /// A vector to contain MemoryRegionInfo objects for all mapped |
| /// ranges. |
| /// |
| /// @return |
| /// An error value. |
| //------------------------------------------------------------------ |
| virtual Status |
| GetMemoryRegions(std::vector<lldb::MemoryRegionInfoSP> ®ion_list); |
| |
| virtual Status GetWatchpointSupportInfo(uint32_t &num) { |
| Status error; |
| num = 0; |
| error.SetErrorString("Process::GetWatchpointSupportInfo() not supported"); |
| return error; |
| } |
| |
| virtual Status GetWatchpointSupportInfo(uint32_t &num, bool &after) { |
| Status error; |
| num = 0; |
| after = true; |
| error.SetErrorString("Process::GetWatchpointSupportInfo() not supported"); |
| return error; |
| } |
| |
| lldb::ModuleSP ReadModuleFromMemory(const FileSpec &file_spec, |
| lldb::addr_t header_addr, |
| size_t size_to_read = 512); |
| |
| //------------------------------------------------------------------ |
| /// Attempt to get the attributes for a region of memory in the process. |
| /// |
| /// It may be possible for the remote debug server to inspect attributes |
| /// for a region of memory in the process, such as whether there is a |
| /// valid page of memory at a given address or whether that page is |
| /// readable/writable/executable by the process. |
| /// |
| /// @param[in] load_addr |
| /// The address of interest in the process. |
| /// |
| /// @param[out] permissions |
| /// If this call returns successfully, this bitmask will have |
| /// its Permissions bits set to indicate whether the region is |
| /// readable/writable/executable. If this call fails, the |
| /// bitmask values are undefined. |
| /// |
| /// @return |
| /// Returns true if it was able to determine the attributes of the |
| /// memory region. False if not. |
| //------------------------------------------------------------------ |
| virtual bool GetLoadAddressPermissions(lldb::addr_t load_addr, |
| uint32_t &permissions); |
| |
| //------------------------------------------------------------------ |
| /// Determines whether executing JIT-compiled code in this process |
| /// is possible. |
| /// |
| /// @return |
| /// True if execution of JIT code is possible; false otherwise. |
| //------------------------------------------------------------------ |
| bool CanJIT(); |
| |
| //------------------------------------------------------------------ |
| /// Sets whether executing JIT-compiled code in this process |
| /// is possible. |
| /// |
| /// @param[in] can_jit |
| /// True if execution of JIT code is possible; false otherwise. |
| //------------------------------------------------------------------ |
| void SetCanJIT(bool can_jit); |
| |
| //------------------------------------------------------------------ |
| /// Determines whether executing function calls using the interpreter |
| /// is possible for this process. |
| /// |
| /// @return |
| /// True if possible; false otherwise. |
| //------------------------------------------------------------------ |
| bool CanInterpretFunctionCalls() { return m_can_interpret_function_calls; } |
| |
| //------------------------------------------------------------------ |
| /// Sets whether executing function calls using the interpreter |
| /// is possible for this process. |
| /// |
| /// @param[in] can_interpret_function_calls |
| /// True if possible; false otherwise. |
| //------------------------------------------------------------------ |
| void SetCanInterpretFunctionCalls(bool can_interpret_function_calls) { |
| m_can_interpret_function_calls = can_interpret_function_calls; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Sets whether executing code in this process is possible. |
| /// This could be either through JIT or interpreting. |
| /// |
| /// @param[in] can_run_code |
| /// True if execution of code is possible; false otherwise. |
| //------------------------------------------------------------------ |
| void SetCanRunCode(bool can_run_code); |
| |
| //------------------------------------------------------------------ |
| /// Actually deallocate memory in the process. |
| /// |
| /// This function will deallocate memory in the process's address |
| /// space that was allocated with AllocateMemory. |
| /// |
| /// @param[in] ptr |
| /// A return value from AllocateMemory, pointing to the memory you |
| /// want to deallocate. |
| /// |
| /// @return |
| /// \btrue if the memory was deallocated, \bfalse otherwise. |
| //------------------------------------------------------------------ |
| virtual Status DoDeallocateMemory(lldb::addr_t ptr) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support deallocating in the debug process", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| //------------------------------------------------------------------ |
| /// The public interface to deallocating memory in the process. |
| /// |
| /// This function will deallocate memory in the process's address |
| /// space that was allocated with AllocateMemory. |
| /// |
| /// @param[in] ptr |
| /// A return value from AllocateMemory, pointing to the memory you |
| /// want to deallocate. |
| /// |
| /// @return |
| /// \btrue if the memory was deallocated, \bfalse otherwise. |
| //------------------------------------------------------------------ |
| Status DeallocateMemory(lldb::addr_t ptr); |
| |
| //------------------------------------------------------------------ |
| /// Get any available STDOUT. |
| /// |
| /// Calling this method is a valid operation only if all of the |
| /// following conditions are true: |
| /// 1) The process was launched, and not attached to. |
| /// 2) The process was not launched with eLaunchFlagDisableSTDIO. |
| /// 3) The process was launched without supplying a valid file path |
| /// for STDOUT. |
| /// |
| /// Note that the implementation will probably need to start a read |
| /// thread in the background to make sure that the pipe is drained |
| /// and the STDOUT buffered appropriately, to prevent the process |
| /// from deadlocking trying to write to a full buffer. |
| /// |
| /// Events will be queued indicating that there is STDOUT available |
| /// that can be retrieved using this function. |
| /// |
| /// @param[out] buf |
| /// A buffer that will receive any STDOUT bytes that are |
| /// currently available. |
| /// |
| /// @param[in] buf_size |
| /// The size in bytes for the buffer \a buf. |
| /// |
| /// @return |
| /// The number of bytes written into \a buf. If this value is |
| /// equal to \a buf_size, another call to this function should |
| /// be made to retrieve more STDOUT data. |
| //------------------------------------------------------------------ |
| virtual size_t GetSTDOUT(char *buf, size_t buf_size, Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Get any available STDERR. |
| /// |
| /// Calling this method is a valid operation only if all of the |
| /// following conditions are true: |
| /// 1) The process was launched, and not attached to. |
| /// 2) The process was not launched with eLaunchFlagDisableSTDIO. |
| /// 3) The process was launched without supplying a valid file path |
| /// for STDERR. |
| /// |
| /// Note that the implementation will probably need to start a read |
| /// thread in the background to make sure that the pipe is drained |
| /// and the STDERR buffered appropriately, to prevent the process |
| /// from deadlocking trying to write to a full buffer. |
| /// |
| /// Events will be queued indicating that there is STDERR available |
| /// that can be retrieved using this function. |
| /// |
| /// @param[in] buf |
| /// A buffer that will receive any STDERR bytes that are |
| /// currently available. |
| /// |
| /// @param[out] buf_size |
| /// The size in bytes for the buffer \a buf. |
| /// |
| /// @return |
| /// The number of bytes written into \a buf. If this value is |
| /// equal to \a buf_size, another call to this function should |
| /// be made to retrieve more STDERR data. |
| //------------------------------------------------------------------ |
| virtual size_t GetSTDERR(char *buf, size_t buf_size, Status &error); |
| |
| //------------------------------------------------------------------ |
| /// Puts data into this process's STDIN. |
| /// |
| /// Calling this method is a valid operation only if all of the |
| /// following conditions are true: |
| /// 1) The process was launched, and not attached to. |
| /// 2) The process was not launched with eLaunchFlagDisableSTDIO. |
| /// 3) The process was launched without supplying a valid file path |
| /// for STDIN. |
| /// |
| /// @param[in] buf |
| /// A buffer that contains the data to write to the process's STDIN. |
| /// |
| /// @param[in] buf_size |
| /// The size in bytes for the buffer \a buf. |
| /// |
| /// @return |
| /// The number of bytes written into \a buf. If this value is |
| /// less than \a buf_size, another call to this function should |
| /// be made to write the rest of the data. |
| //------------------------------------------------------------------ |
| virtual size_t PutSTDIN(const char *buf, size_t buf_size, Status &error) { |
| error.SetErrorString("stdin unsupported"); |
| return 0; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Get any available profile data. |
| /// |
| /// @param[out] buf |
| /// A buffer that will receive any profile data bytes that are |
| /// currently available. |
| /// |
| /// @param[out] buf_size |
| /// The size in bytes for the buffer \a buf. |
| /// |
| /// @return |
| /// The number of bytes written into \a buf. If this value is |
| /// equal to \a buf_size, another call to this function should |
| /// be made to retrieve more profile data. |
| //------------------------------------------------------------------ |
| virtual size_t GetAsyncProfileData(char *buf, size_t buf_size, Status &error); |
| |
| //---------------------------------------------------------------------- |
| // Process Breakpoints |
| //---------------------------------------------------------------------- |
| size_t GetSoftwareBreakpointTrapOpcode(BreakpointSite *bp_site); |
| |
| virtual Status EnableBreakpointSite(BreakpointSite *bp_site) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support enabling breakpoints", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| virtual Status DisableBreakpointSite(BreakpointSite *bp_site) { |
| Status error; |
| error.SetErrorStringWithFormat( |
| "error: %s does not support disabling breakpoints", |
| GetPluginName().GetCString()); |
| return error; |
| } |
| |
| // This is implemented completely using the lldb::Process API. Subclasses |
| // don't need to implement this function unless the standard flow of |
| // read existing opcode, write breakpoint opcode, verify breakpoint opcode |
| // doesn't work for a specific process plug-in. |
| virtual Status EnableSoftwareBreakpoint(BreakpointSite *bp_site); |
| |
| // This is implemented completely using the lldb::Process API. Subclasses |
| // don't need to implement this function unless the standard flow of |
| // restoring original opcode in memory and verifying the restored opcode |
| // doesn't work for a specific process plug-in. |
| virtual Status DisableSoftwareBreakpoint(BreakpointSite *bp_site); |
| |
| BreakpointSiteList &GetBreakpointSiteList(); |
| |
| const BreakpointSiteList &GetBreakpointSiteList() const; |
| |
| void DisableAllBreakpointSites(); |
| |
| Status ClearBreakpointSiteByID(lldb::user_id_t break_id); |
| |
| lldb::break_id_t CreateBreakpointSite(const lldb::BreakpointLocationSP &owner, |
| bool use_hardware); |
| |
| Status DisableBreakpointSiteByID(lldb::user_id_t break_id); |
| |
| Status EnableBreakpointSiteByID(lldb::user_id_t break_id); |
| |
| // BreakpointLocations use RemoveOwnerFromBreakpointSite to remove |
| // themselves from the owner's list of this breakpoint sites. |
| void RemoveOwnerFromBreakpointSite(lldb::user_id_t owner_id, |
| lldb::user_id_t owner_loc_id, |
| lldb::BreakpointSiteSP &bp_site_sp); |
| |
| //---------------------------------------------------------------------- |
| // Process Watchpoints (optional) |
| //---------------------------------------------------------------------- |
| virtual Status EnableWatchpoint(Watchpoint *wp, bool notify = true); |
| |
| virtual Status DisableWatchpoint(Watchpoint *wp, bool notify = true); |
| |
| //------------------------------------------------------------------ |
| // Thread Queries |
| //------------------------------------------------------------------ |
| virtual bool UpdateThreadList(ThreadList &old_thread_list, |
| ThreadList &new_thread_list) = 0; |
| |
| void UpdateThreadListIfNeeded(); |
| |
| ThreadList &GetThreadList() { return m_thread_list; } |
| |
| // When ExtendedBacktraces are requested, the HistoryThreads that are |
| // created need an owner -- they're saved here in the Process. The |
| // threads in this list are not iterated over - driver programs need to |
| // request the extended backtrace calls starting from a root concrete |
| // thread one by one. |
| ThreadList &GetExtendedThreadList() { return m_extended_thread_list; } |
| |
| ThreadList::ThreadIterable Threads() { return m_thread_list.Threads(); } |
| |
| uint32_t GetNextThreadIndexID(uint64_t thread_id); |
| |
| lldb::ThreadSP CreateOSPluginThread(lldb::tid_t tid, lldb::addr_t context); |
| |
| // Returns true if an index id has been assigned to a thread. |
| bool HasAssignedIndexIDToThread(uint64_t sb_thread_id); |
| |
| // Given a thread_id, it will assign a more reasonable index id for display to |
| // the user. |
| // If the thread_id has previously been assigned, the same index id will be |
| // used. |
| uint32_t AssignIndexIDToThread(uint64_t thread_id); |
| |
| //------------------------------------------------------------------ |
| // Queue Queries |
| //------------------------------------------------------------------ |
| |
| void UpdateQueueListIfNeeded(); |
| |
| QueueList &GetQueueList() { |
| UpdateQueueListIfNeeded(); |
| return m_queue_list; |
| } |
| |
| QueueList::QueueIterable Queues() { |
| UpdateQueueListIfNeeded(); |
| return m_queue_list.Queues(); |
| } |
| |
| //------------------------------------------------------------------ |
| // Event Handling |
| //------------------------------------------------------------------ |
| lldb::StateType GetNextEvent(lldb::EventSP &event_sp); |
| |
| // Returns the process state when it is stopped. If specified, event_sp_ptr |
| // is set to the event which triggered the stop. If wait_always = false, |
| // and the process is already stopped, this function returns immediately. |
| // If the process is hijacked and use_run_lock is true (the default), then |
| // this |
| // function releases the run lock after the stop. Setting use_run_lock to |
| // false |
| // will avoid this behavior. |
| lldb::StateType |
| WaitForProcessToStop(const Timeout<std::micro> &timeout, |
| lldb::EventSP *event_sp_ptr = nullptr, |
| bool wait_always = true, |
| lldb::ListenerSP hijack_listener = lldb::ListenerSP(), |
| Stream *stream = nullptr, bool use_run_lock = true); |
| |
| uint32_t GetIOHandlerID() const { return m_iohandler_sync.GetValue(); } |
| |
| //-------------------------------------------------------------------------------------- |
| /// Waits for the process state to be running within a given msec timeout. |
| /// |
| /// The main purpose of this is to implement an interlock waiting for |
| /// HandlePrivateEvent |
| /// to push an IOHandler. |
| /// |
| /// @param[in] timeout_msec |
| /// The maximum time length to wait for the process to transition to the |
| /// eStateRunning state, specified in milliseconds. |
| //-------------------------------------------------------------------------------------- |
| void SyncIOHandler(uint32_t iohandler_id, uint64_t timeout_msec); |
| |
| lldb::StateType GetStateChangedEvents( |
| lldb::EventSP &event_sp, const Timeout<std::micro> &timeout, |
| lldb::ListenerSP |
| hijack_listener); // Pass an empty ListenerSP to use builtin listener |
| |
| //-------------------------------------------------------------------------------------- |
| /// Centralize the code that handles and prints descriptions for process state |
| /// changes. |
| /// |
| /// @param[in] event_sp |
| /// The process state changed event |
| /// |
| /// @param[in] stream |
| /// The output stream to get the state change description |
| /// |
| /// @param[in,out] pop_process_io_handler |
| /// If this value comes in set to \b true, then pop the Process IOHandler |
| /// if needed. |
| /// Else this variable will be set to \b true or \b false to indicate if |
| /// the process |
| /// needs to have its process IOHandler popped. |
| /// |
| /// @return |
| /// \b true if the event describes a process state changed event, \b false |
| /// otherwise. |
| //-------------------------------------------------------------------------------------- |
| static bool HandleProcessStateChangedEvent(const lldb::EventSP &event_sp, |
| Stream *stream, |
| bool &pop_process_io_handler); |
| |
| Event *PeekAtStateChangedEvents(); |
| |
| class ProcessEventHijacker { |
| public: |
| ProcessEventHijacker(Process &process, lldb::ListenerSP listener_sp) |
| : m_process(process) { |
| m_process.HijackProcessEvents(listener_sp); |
| } |
| |
| ~ProcessEventHijacker() { m_process.RestoreProcessEvents(); } |
| |
| private: |
| Process &m_process; |
| }; |
| |
| friend class ProcessEventHijacker; |
| friend class ProcessProperties; |
| //------------------------------------------------------------------ |
| /// If you need to ensure that you and only you will hear about some public |
| /// event, then make a new listener, set to listen to process events, and |
| /// then call this with that listener. Then you will have to wait on that |
| /// listener explicitly for events (rather than using the GetNextEvent & |
| /// WaitFor* |
| /// calls above. Be sure to call RestoreProcessEvents when you are done. |
| /// |
| /// @param[in] listener |
| /// This is the new listener to whom all process events will be delivered. |
| /// |
| /// @return |
| /// Returns \b true if the new listener could be installed, |
| /// \b false otherwise. |
| //------------------------------------------------------------------ |
| bool HijackProcessEvents(lldb::ListenerSP listener_sp); |
| |
| //------------------------------------------------------------------ |
| /// Restores the process event broadcasting to its normal state. |
| /// |
| //------------------------------------------------------------------ |
| void RestoreProcessEvents(); |
| |
| const lldb::ABISP &GetABI(); |
| |
| OperatingSystem *GetOperatingSystem() { return m_os_ap.get(); } |
| |
| virtual LanguageRuntime *GetLanguageRuntime(lldb::LanguageType language, |
| bool retry_if_null = true); |
| |
| virtual CPPLanguageRuntime *GetCPPLanguageRuntime(bool retry_if_null = true); |
| |
| virtual ObjCLanguageRuntime * |
| GetObjCLanguageRuntime(bool retry_if_null = true); |
| |
| bool IsPossibleDynamicValue(ValueObject &in_value); |
| |
| bool IsRunning() const; |
| |
| DynamicCheckerFunctions *GetDynamicCheckers() { |
| return m_dynamic_checkers_ap.get(); |
| } |
| |
| void SetDynamicCheckers(DynamicCheckerFunctions *dynamic_checkers); |
| |
| //------------------------------------------------------------------ |
| /// Call this to set the lldb in the mode where it breaks on new thread |
| /// creations, and then auto-restarts. This is useful when you are trying |
| /// to run only one thread, but either that thread or the kernel is creating |
| /// new threads in the process. If you stop when the thread is created, you |
| /// can immediately suspend it, and keep executing only the one thread you |
| /// intend. |
| /// |
| /// @return |
| /// Returns \b true if we were able to start up the notification |
| /// \b false otherwise. |
| //------------------------------------------------------------------ |
| virtual bool StartNoticingNewThreads() { return true; } |
| |
| //------------------------------------------------------------------ |
| /// Call this to turn off the stop & notice new threads mode. |
| /// |
| /// @return |
| /// Returns \b true if we were able to start up the notification |
| /// \b false otherwise. |
| //------------------------------------------------------------------ |
| virtual bool StopNoticingNewThreads() { return true; } |
| |
| void SetRunningUserExpression(bool on); |
| |
| //------------------------------------------------------------------ |
| // lldb::ExecutionContextScope pure virtual functions |
| //------------------------------------------------------------------ |
| lldb::TargetSP CalculateTarget() override; |
| |
| lldb::ProcessSP CalculateProcess() override { return shared_from_this(); } |
| |
| lldb::ThreadSP CalculateThread() override { return lldb::ThreadSP(); } |
| |
| lldb::StackFrameSP CalculateStackFrame() override { |
| return lldb::StackFrameSP(); |
| } |
| |
| void CalculateExecutionContext(ExecutionContext &exe_ctx) override; |
| |
| void SetSTDIOFileDescriptor(int file_descriptor); |
| |
| //------------------------------------------------------------------ |
| // Add a permanent region of memory that should never be read or |
| // written to. This can be used to ensure that memory reads or writes |
| // to certain areas of memory never end up being sent to the |
| // DoReadMemory or DoWriteMemory functions which can improve |
| // performance. |
| //------------------------------------------------------------------ |
| void AddInvalidMemoryRegion(const LoadRange ®ion); |
| |
| //------------------------------------------------------------------ |
| // Remove a permanent region of memory that should never be read or |
| // written to that was previously added with AddInvalidMemoryRegion. |
| //------------------------------------------------------------------ |
| bool RemoveInvalidMemoryRange(const LoadRange ®ion); |
| |
| //------------------------------------------------------------------ |
| // If the setup code of a thread plan needs to do work that might involve |
| // calling a function in the target, it should not do that work directly |
| // in one of the thread plan functions (DidPush/WillResume) because |
| // such work needs to be handled carefully. Instead, put that work in |
| // a PreResumeAction callback, and register it with the process. It will |
| // get done before the actual "DoResume" gets called. |
| //------------------------------------------------------------------ |
| |
| typedef bool(PreResumeActionCallback)(void *); |
| |
| void AddPreResumeAction(PreResumeActionCallback callback, void *baton); |
| |
| bool RunPreResumeActions(); |
| |
| void ClearPreResumeActions(); |
| |
| void ClearPreResumeAction(PreResumeActionCallback callback, void *baton); |
| |
| ProcessRunLock &GetRunLock(); |
| |
| virtual Status SendEventData(const char *data) { |
| Status return_error("Sending an event is not supported for this process."); |
| return return_error; |
| } |
| |
| lldb::ThreadCollectionSP GetHistoryThreads(lldb::addr_t addr); |
| |
| lldb::InstrumentationRuntimeSP |
| GetInstrumentationRuntime(lldb::InstrumentationRuntimeType type); |
| |
| //------------------------------------------------------------------ |
| /// Try to fetch the module specification for a module with the |
| /// given file name and architecture. Process sub-classes have to |
| /// override this method if they support platforms where the |
| /// Platform object can't get the module spec for all module. |
| /// |
| /// @param[in] module_file_spec |
| /// The file name of the module to get specification for. |
| /// |
| /// @param[in] arch |
| /// The architecture of the module to get specification for. |
| /// |
| /// @param[out] module_spec |
| /// The fetched module specification if the return value is |
| /// \b true, unchanged otherwise. |
| /// |
| /// @return |
| /// Returns \b true if the module spec fetched successfully, |
| /// \b false otherwise. |
| //------------------------------------------------------------------ |
| virtual bool GetModuleSpec(const FileSpec &module_file_spec, |
| const ArchSpec &arch, ModuleSpec &module_spec); |
| |
| virtual void PrefetchModuleSpecs(llvm::ArrayRef<FileSpec> module_file_specs, |
| const llvm::Triple &triple) {} |
| |
| //------------------------------------------------------------------ |
| /// Try to find the load address of a file. |
| /// The load address is defined as the address of the first memory |
| /// region what contains data mapped from the specified file. |
| /// |
| /// @param[in] file |
| /// The name of the file whose load address we are looking for |
| /// |
| /// @param[out] is_loaded |
| /// \b True if the file is loaded into the memory and false |
| /// otherwise. |
| /// |
| /// @param[out] load_addr |
| /// The load address of the file if it is loaded into the |
| /// processes address space, LLDB_INVALID_ADDRESS otherwise. |
| //------------------------------------------------------------------ |
| virtual Status GetFileLoadAddress(const FileSpec &file, bool &is_loaded, |
| lldb::addr_t &load_addr) { |
| return Status("Not supported"); |
| } |
| |
| size_t AddImageToken(lldb::addr_t image_ptr); |
| |
| lldb::addr_t GetImagePtrFromToken(size_t token) const; |
| |
| void ResetImageToken(size_t token); |
| |
| //------------------------------------------------------------------ |
| /// Find the next branch instruction to set a breakpoint on |
| /// |
| /// When instruction stepping through a source line, instead of |
| /// stepping through each instruction, we can put a breakpoint on |
| /// the next branch instruction (within the range of instructions |
| /// we are stepping through) and continue the process to there, |
| /// yielding significant performance benefits over instruction |
| /// stepping. |
| /// |
| /// @param[in] default_stop_addr |
| /// The address of the instruction where lldb would put a |
| /// breakpoint normally. |
| /// |
| /// @param[in] range_bounds |
| /// The range which the breakpoint must be contained within. |
| /// Typically a source line. |
| /// |
| /// @return |
| /// The address of the next branch instruction, or the end of |
| /// the range provided in range_bounds. If there are any |
| /// problems with the disassembly or getting the instructions, |
| /// the original default_stop_addr will be returned. |
| //------------------------------------------------------------------ |
| Address AdvanceAddressToNextBranchInstruction(Address default_stop_addr, |
| AddressRange range_bounds); |
| |
| //------------------------------------------------------------------ |
| /// Configure asynchronous structured data feature. |
| /// |
| /// Each Process type that supports using an asynchronous StructuredData |
| /// feature should implement this to enable/disable/configure the feature. |
| /// The default implementation here will always return an error indiciating |
| /// the feature is unsupported. |
| /// |
| /// StructuredDataPlugin implementations will call this to configure |
| /// a feature that has been reported as being supported. |
| /// |
| /// @param[in] type_name |
| /// The StructuredData type name as previously discovered by |
| /// the Process-derived instance. |
| /// |
| /// @param[in] config |
| /// Configuration data for the feature being enabled. This config |
| /// data, which may be null, will be passed along to the feature |
| /// to process. The feature will dictate whether this is a dictionary, |
| /// an array or some other object. If the feature needs to be |
| /// set up properly before it can be enabled, then the config should |
| /// also take an enable/disable flag. |
| /// |
| /// @return |
| /// Returns the result of attempting to configure the feature. |
| //------------------------------------------------------------------ |
| virtual Status |
| ConfigureStructuredData(const ConstString &type_name, |
| const StructuredData::ObjectSP &config_sp); |
| |
| //------------------------------------------------------------------ |
| /// Broadcasts the given structured data object from the given |
| /// plugin. |
| /// |
| /// StructuredDataPlugin instances can use this to optionally |
| /// broadcast any of their data if they want to make it available |
| /// for clients. The data will come in on the structured data |
| /// event bit (eBroadcastBitStructuredData). |
| /// |
| /// @param[in] object_sp |
| /// The structured data object to broadcast. |
| /// |
| /// @param[in] plugin_sp |
| /// The plugin that will be reported in the event's plugin |
| /// parameter. |
| //------------------------------------------------------------------ |
| void BroadcastStructuredData(const StructuredData::ObjectSP &object_sp, |
| const lldb::StructuredDataPluginSP &plugin_sp); |
| |
| //------------------------------------------------------------------ |
| /// Returns the StructuredDataPlugin associated with a given type |
| /// name, if there is one. |
| /// |
| /// There will only be a plugin for a given StructuredDataType if the |
| /// debugged process monitor claims that the feature is supported. |
| /// This is one way to tell whether a feature is available. |
| /// |
| /// @return |
| /// The plugin if one is available for the specified feature; |
| /// otherwise, returns an empty shared pointer. |
| //------------------------------------------------------------------ |
| lldb::StructuredDataPluginSP |
| GetStructuredDataPlugin(const ConstString &type_name) const; |
| |
| //------------------------------------------------------------------ |
| /// Starts tracing with the configuration provided in options. To |
| /// enable tracing on the complete process the thread_id in the |
| /// options should be set to LLDB_INVALID_THREAD_ID. The API returns |
| /// a user_id which is needed by other API's that manipulate the |
| /// trace instance. |
| /// The handling of erroneous or unsupported configuration is left |
| /// to the trace technology implementations in the server, as they |
| /// could be returned as an error, or rounded to a valid |
| /// configuration to start tracing. In the later case the |
| /// GetTraceConfig should supply the actual used trace |
| /// configuration. |
| //------------------------------------------------------------------ |
| virtual lldb::user_id_t StartTrace(const TraceOptions &options, |
| Status &error) { |
| error.SetErrorString("Not implemented"); |
| return LLDB_INVALID_UID; |
| } |
| |
| //------------------------------------------------------------------ |
| /// Stops the tracing instance leading to deletion of the trace |
| /// data. The tracing instance is identified by the user_id which |
| /// is obtained when tracing was started from the StartTrace. |
| /// In case tracing of the complete process needs to be stopped |
| /// the thread_id should be set to LLDB_INVALID_THREAD_ID. |
| /// In the other case that tracing on an individual thread needs |
| /// to be stopped a thread_id can be supplied. |
| //------------------------------------------------------------------ |
| virtual Status StopTrace(lldb::user_id_t uid, lldb::tid_t thread_id) { |
| return Status("Not implemented"); |
| } |
| |
| //------------------------------------------------------------------ |
| /// Provides the trace data as raw bytes. A buffer needs to be |
| /// supplied to copy the trace data. The exact behavior of this API |
| /// may vary across trace technology, as some may support partial |
| /// reading of the trace data from a specified offset while some |
| /// may not. The thread_id should be used to select a particular |
| /// thread for trace extraction. |
| //------------------------------------------------------------------ |
| virtual Status GetData(lldb::user_id_t uid, lldb::tid_t thread_id, |
| llvm::MutableArrayRef<uint8_t> &buffer, |
| size_t offset = 0) { |
| return Status("Not implemented"); |
| } |
| |
| //------------------------------------------------------------------ |
| /// Similar API as above except for obtaining meta data |
| //------------------------------------------------------------------ |
| virtual Status GetMetaData(lldb::user_id_t uid, lldb::tid_t thread_id, |
| llvm::MutableArrayRef<uint8_t> &buffer, |
| size_t offset = 0) { |
| return Status("Not implemented"); |
| } |
| |
| //------------------------------------------------------------------ |
| /// API to obtain the trace configuration used by a trace instance. |
| /// Configurations that may be specific to some trace technology |
| /// should be stored in the custom parameters. The options are |
| /// transported to the server, which shall interpret accordingly. |
| /// The thread_id can be specified in the options to obtain the |
| /// configuration used by a specific thread. The thread_id specified |
| /// should also match the uid otherwise an error will be returned. |
| //------------------------------------------------------------------ |
| virtual Status GetTraceConfig(lldb::user_id_t uid, TraceOptions &options) { |
| return Status("Not implemented"); |
| } |
| |
| protected: |
| void SetState(lldb::EventSP &event_sp); |
| |
| lldb::StateType GetPrivateState(); |
| |
| //------------------------------------------------------------------ |
| /// The "private" side of resuming a process. This doesn't alter the |
| /// state of m_run_lock, but just causes the process to resume. |
| /// |
| /// @return |
| /// An Status object describing the success or failure of the resume. |
| //------------------------------------------------------------------ |
| Status PrivateResume(); |
| |
| //------------------------------------------------------------------ |
| // Called internally |
| //------------------------------------------------------------------ |
| void CompleteAttach(); |
| |
| //------------------------------------------------------------------ |
| /// Print a user-visible warning one time per Process |
| /// |
| /// A facility for printing a warning to the user once per repeat_key. |
| /// |
| /// warning_type is from the Process::Warnings enums. |
| /// repeat_key is a pointer value that will be used to ensure that the |
| /// warning message is not printed multiple times. For instance, with a |
| /// warning about a function being optimized, you can pass the CompileUnit |
| /// pointer to have the warning issued for only the first function in a |
| /// CU, or the Function pointer to have it issued once for every function, |
| /// or a Module pointer to have it issued once per Module. |
| /// |
| /// Classes outside Process should call a specific PrintWarning method |
| /// so that the warning strings are all centralized in Process, instead of |
| /// calling PrintWarning() directly. |
| /// |
| /// @param [in] warning_type |
| /// One of the types defined in Process::Warnings. |
| /// |
| /// @param [in] repeat_key |
| /// A pointer value used to ensure that the warning is only printed once. |
| /// May be nullptr, indicating that the warning is printed unconditionally |
| /// every time. |
| /// |
| /// @param [in] fmt |
| /// printf style format string |
| //------------------------------------------------------------------ |
| void PrintWarning(uint64_t warning_type, const void *repeat_key, |
| const char *fmt, ...) __attribute__((format(printf, 4, 5))); |
| |
| //------------------------------------------------------------------ |
| // NextEventAction provides a way to register an action on the next |
| // event that is delivered to this process. There is currently only |
| // one next event action allowed in the process at one time. If a |
| // new "NextEventAction" is added while one is already present, the |
| // old action will be discarded (with HandleBeingUnshipped called |
| // after it is discarded.) |
| // |
| // If you want to resume the process as a result of a resume action, |
| // call RequestResume, don't call Resume directly. |
| //------------------------------------------------------------------ |
| class NextEventAction { |
| public: |
| typedef enum EventActionResult { |
| eEventActionSuccess, |
| eEventActionRetry, |
| eEventActionExit |
| } EventActionResult; |
| |
| NextEventAction(Process *process) : m_process(process) {} |
| |
| virtual ~NextEventAction() = default; |
| |
| virtual EventActionResult PerformAction(lldb::EventSP &event_sp) = 0; |
| virtual void HandleBeingUnshipped() {} |
| virtual EventActionResult HandleBeingInterrupted() = 0; |
| virtual const char *GetExitString() = 0; |
| void RequestResume() { m_process->m_resume_requested = true; } |
| |
| protected: |
| Process *m_process; |
| }; |
| |
| void SetNextEventAction(Process::NextEventAction *next_event_action) { |
| if (m_next_event_action_ap.get()) |
| m_next_event_action_ap->HandleBeingUnshipped(); |
| |
| m_next_event_action_ap.reset(next_event_action); |
| } |
| |
| // This is the completer for Attaching: |
| class AttachCompletionHandler : public NextEventAction { |
| public: |
| AttachCompletionHandler(Process *process, uint32_t exec_count); |
| |
| ~AttachCompletionHandler() override = default; |
| |
| EventActionResult PerformAction(lldb::EventSP &event_sp) override; |
| EventActionResult HandleBeingInterrupted() override; |
| const char *GetExitString() override; |
| |
| private: |
| uint32_t m_exec_count; |
| std::string m_exit_string; |
| }; |
| |
| bool PrivateStateThreadIsValid() const { |
| lldb::StateType state = m_private_state.GetValue(); |
| return state != lldb::eStateInvalid && state != lldb::eStateDetached && |
| state != lldb::eStateExited && m_private_state_thread.IsJoinable(); |
| } |
| |
| void ForceNextEventDelivery() { m_force_next_event_delivery = true; } |
| |
| //------------------------------------------------------------------ |
| /// Loads any plugins associated with asynchronous structured data |
| /// and maps the relevant supported type name to the plugin. |
| /// |
| /// Processes can receive asynchronous structured data from the |
| /// process monitor. This method will load and map any structured |
| /// data plugins that support the given set of supported type names. |
| /// Later, if any of these features are enabled, the process monitor |
| /// is free to generate asynchronous structured data. The data must |
| /// come in as a single \b StructuredData::Dictionary. That dictionary |
| /// must have a string field named 'type', with a value that equals |
| /// the relevant type name string (one of the values in |
| /// \b supported_type_names). |
| /// |
| /// @param[in] supported_type_names |
| /// An array of zero or more type names. Each must be unique. |
| /// For each entry in the list, a StructuredDataPlugin will be |
| /// searched for that supports the structured data type name. |
| //------------------------------------------------------------------ |
| void MapSupportedStructuredDataPlugins( |
| const StructuredData::Array &supported_type_names); |
| |
| //------------------------------------------------------------------ |
| /// Route the incoming structured data dictionary to the right plugin. |
| /// |
| /// The incoming structured data must be a dictionary, and it must |
| /// have a key named 'type' that stores a string value. The string |
| /// value must be the name of the structured data feature that |
| /// knows how to handle it. |
| /// |
| /// @param[in] object_sp |
| /// When non-null and pointing to a dictionary, the 'type' |
| /// key's string value is used to look up the plugin that |
| /// was registered for that structured data type. It then |
| /// calls the following method on the StructuredDataPlugin |
| /// instance: |
| /// |
| /// virtual void |
| /// HandleArrivalOfStructuredData(Process &process, |
| /// const ConstString &type_name, |
| /// const StructuredData::ObjectSP |
| /// &object_sp) |
| /// |
| /// @return |
| /// True if the structured data was routed to a plugin; otherwise, |
| /// false. |
| //------------------------------------------------------------------ |
| bool RouteAsyncStructuredData(const StructuredData::ObjectSP object_sp); |
| |
| //------------------------------------------------------------------ |
| // Type definitions |
| //------------------------------------------------------------------ |
| typedef std::map<lldb::LanguageType, lldb::LanguageRuntimeSP> |
| LanguageRuntimeCollection; |
| typedef std::unordered_set<const void *> WarningsPointerSet; |
| typedef std::map<uint64_t, WarningsPointerSet> WarningsCollection; |
| |
| struct PreResumeCallbackAndBaton { |
| bool (*callback)(void *); |
| void *baton; |
| PreResumeCallbackAndBaton(PreResumeActionCallback in_callback, |
| void *in_baton) |
| : callback(in_callback), baton(in_baton) {} |
| bool operator== (const PreResumeCallbackAndBaton &rhs) { |
| return callback == rhs.callback && baton == rhs.baton; |
| } |
| }; |
| |
| using StructuredDataPluginMap = |
| std::map<ConstString, lldb::StructuredDataPluginSP>; |
| |
| //------------------------------------------------------------------ |
| // Member variables |
| //------------------------------------------------------------------ |
| std::weak_ptr<Target> m_target_sp; ///< The target that owns this process. |
| ThreadSafeValue<lldb::StateType> m_public_state; |
| ThreadSafeValue<lldb::StateType> |
| m_private_state; // The actual state of our process |
| Broadcaster m_private_state_broadcaster; // This broadcaster feeds state |
| // changed events into the private |
| // state thread's listener. |
| Broadcaster m_private_state_control_broadcaster; // This is the control |
| // broadcaster, used to |
| // pause, resume & stop the |
| // private state thread. |
| lldb::ListenerSP m_private_state_listener_sp; // This is the listener for the |
| // private state thread. |
| HostThread m_private_state_thread; ///< Thread ID for the thread that watches |
| ///internal state events |
| ProcessModID m_mod_id; ///< Tracks the state of the process over stops and |
| ///other alterations. |
| uint32_t m_process_unique_id; ///< Each lldb_private::Process class that is |
| ///created gets a unique integer ID that |
| ///increments with each new instance |
| uint32_t m_thread_index_id; ///< Each thread is created with a 1 based index |
| ///that won't get re-used. |
| std::map<uint64_t, uint32_t> m_thread_id_to_index_id_map; |
| int m_exit_status; ///< The exit status of the process, or -1 if not set. |
| std::string m_exit_string; ///< A textual description of why a process exited. |
| std::mutex m_exit_status_mutex; ///< Mutex so m_exit_status m_exit_string can |
| ///be safely accessed from multiple threads |
| std::recursive_mutex m_thread_mutex; |
| ThreadList m_thread_list_real; ///< The threads for this process as are known |
| ///to the protocol we are debugging with |
| ThreadList m_thread_list; ///< The threads for this process as the user will |
| ///see them. This is usually the same as |
| ///< m_thread_list_real, but might be different if there is an OS plug-in |
| ///creating memory threads |
| ThreadList m_extended_thread_list; ///< Owner for extended threads that may be |
| ///generated, cleared on natural stops |
| uint32_t m_extended_thread_stop_id; ///< The natural stop id when |
| ///extended_thread_list was last updated |
| QueueList |
| m_queue_list; ///< The list of libdispatch queues at a given stop point |
| uint32_t m_queue_list_stop_id; ///< The natural stop id when queue list was |
| ///last fetched |
| std::vector<Notifications> m_notifications; ///< The list of notifications |
| ///that this process can deliver. |
| std::vector<lldb::addr_t> m_image_tokens; |
| lldb::ListenerSP m_listener_sp; ///< Shared pointer to the listener used for |
| ///public events. Can not be empty. |
| BreakpointSiteList m_breakpoint_site_list; ///< This is the list of breakpoint |
| ///locations we intend to insert in |
| ///the target. |
| lldb::DynamicLoaderUP m_dyld_ap; |
| lldb::JITLoaderListUP m_jit_loaders_ap; |
| lldb::DynamicCheckerFunctionsUP m_dynamic_checkers_ap; ///< The functions used |
| ///by the expression |
| ///parser to validate |
| ///data that |
| ///expressions use. |
| lldb::OperatingSystemUP m_os_ap; |
| lldb::SystemRuntimeUP m_system_runtime_ap; |
| lldb::UnixSignalsSP |
| m_unix_signals_sp; /// This is the current signal set for this process. |
| lldb::ABISP m_abi_sp; |
| lldb::IOHandlerSP m_process_input_reader; |
| Communication m_stdio_communication; |
| std::recursive_mutex m_stdio_communication_mutex; |
| bool m_stdin_forward; /// Remember if stdin must be forwarded to remote debug |
| /// server |
| std::string m_stdout_data; |
| std::string m_stderr_data; |
| std::recursive_mutex m_profile_data_comm_mutex; |
| std::vector<std::string> m_profile_data; |
| Predicate<uint32_t> m_iohandler_sync; |
| MemoryCache m_memory_cache; |
| AllocatedMemoryCache m_allocated_memory_cache; |
| bool m_should_detach; /// Should we detach if the process object goes away |
| /// with an explicit call to Kill or Detach? |
| LanguageRuntimeCollection m_language_runtimes; |
| InstrumentationRuntimeCollection m_instrumentation_runtimes; |
| std::unique_ptr<NextEventAction> m_next_event_action_ap; |
| std::vector<PreResumeCallbackAndBaton> m_pre_resume_actions; |
| ProcessRunLock m_public_run_lock; |
| ProcessRunLock m_private_run_lock; |
| bool m_currently_handling_do_on_removals; |
| bool m_resume_requested; // If m_currently_handling_event or |
| // m_currently_handling_do_on_removals are true, |
| // Resume will only request a resume, using this flag |
| // to check. |
| bool m_finalizing; // This is set at the beginning of Process::Finalize() to |
| // stop functions from looking up or creating things during |
| // a finalize call |
| bool m_finalize_called; // This is set at the end of Process::Finalize() |
| bool m_clear_thread_plans_on_stop; |
| bool m_force_next_event_delivery; |
| lldb::StateType m_last_broadcast_state; /// This helps with the Public event |
| /// coalescing in |
| /// ShouldBroadcastEvent. |
| std::map<lldb::addr_t, lldb::addr_t> m_resolved_indirect_addresses; |
| bool m_destroy_in_process; |
| bool m_can_interpret_function_calls; // Some targets, e.g the OSX kernel, |
| // don't support the ability to modify |
| // the stack. |
| WarningsCollection m_warnings_issued; // A set of object pointers which have |
| // already had warnings printed |
| std::mutex m_run_thread_plan_lock; |
| StructuredDataPluginMap m_structured_data_plugin_map; |
| |
| enum { eCanJITDontKnow = 0, eCanJITYes, eCanJITNo } m_can_jit; |
| |
| size_t RemoveBreakpointOpcodesFromBuffer(lldb::addr_t addr, size_t size, |
| uint8_t *buf) const; |
| |
| void SynchronouslyNotifyStateChanged(lldb::StateType state); |
| |
| void SetPublicState(lldb::StateType new_state, bool restarted); |
| |
| void SetPrivateState(lldb::StateType state); |
| |
| bool StartPrivateStateThread(bool is_secondary_thread = false); |
| |
| void StopPrivateStateThread(); |
| |
| void PausePrivateStateThread(); |
| |
| void ResumePrivateStateThread(); |
| |
| private: |
| struct PrivateStateThreadArgs { |
| PrivateStateThreadArgs(Process *p, bool s) |
| : process(p), is_secondary_thread(s){}; |
| Process *process; |
| bool is_secondary_thread; |
| }; |
| |
| // arg is a pointer to a new'ed PrivateStateThreadArgs structure. |
| // PrivateStateThread will free it for you. |
| static lldb::thread_result_t PrivateStateThread(void *arg); |
| |
| // The starts up the private state thread that will watch for events from the |
| // debugee. |
| // Pass true for is_secondary_thread in the case where you have to temporarily |
| // spin up a |
| // secondary state thread to handle events from a hand-called function on the |
| // primary |
| // private state thread. |
| |
| lldb::thread_result_t RunPrivateStateThread(bool is_secondary_thread); |
| |
| protected: |
| void HandlePrivateEvent(lldb::EventSP &event_sp); |
| |
| Status HaltPrivate(); |
| |
| lldb::StateType WaitForProcessStopPrivate(lldb::EventSP &event_sp, |
| const Timeout<std::micro> &timeout); |
| |
| // This waits for both the state change broadcaster, and the control |
| // broadcaster. |
| // If control_only, it only waits for the control broadcaster. |
| |
| bool GetEventsPrivate(lldb::EventSP &event_sp, |
| const Timeout<std::micro> &timeout, bool control_only); |
| |
| lldb::StateType |
| GetStateChangedEventsPrivate(lldb::EventSP &event_sp, |
| const Timeout<std::micro> &timeout); |
| |
| size_t WriteMemoryPrivate(lldb::addr_t addr, const void *buf, size_t size, |
| Status &error); |
| |
| void AppendSTDOUT(const char *s, size_t len); |
| |
| void AppendSTDERR(const char *s, size_t len); |
| |
| void BroadcastAsyncProfileData(const std::string &one_profile_data); |
| |
| static void STDIOReadThreadBytesReceived(void *baton, const void *src, |
| size_t src_len); |
| |
| bool PushProcessIOHandler(); |
| |
| bool PopProcessIOHandler(); |
| |
| bool ProcessIOHandlerIsActive(); |
| |
| bool ProcessIOHandlerExists() const { |
| return static_cast<bool>(m_process_input_reader); |
| } |
| |
| Status StopForDestroyOrDetach(lldb::EventSP &exit_event_sp); |
| |
| virtual Status UpdateAutomaticSignalFiltering(); |
| |
| bool StateChangedIsExternallyHijacked(); |
| |
| void LoadOperatingSystemPlugin(bool flush); |
| |
| private: |
| //------------------------------------------------------------------ |
| /// This is the part of the event handling that for a process event. |
| /// It decides what to do with the event and returns true if the |
| /// event needs to be propagated to the user, and false otherwise. |
| /// If the event is not propagated, this call will most likely set |
| /// the target to executing again. |
| /// There is only one place where this call should be called, |
| /// HandlePrivateEvent. |
| /// Don't call it from anywhere else... |
| /// |
| /// @param[in] event_ptr |
| /// This is the event we are handling. |
| /// |
| /// @return |
| /// Returns \b true if the event should be reported to the |
| /// user, \b false otherwise. |
| //------------------------------------------------------------------ |
| bool ShouldBroadcastEvent(Event *event_ptr); |
| |
| void ControlPrivateStateThread(uint32_t signal); |
| |
| DISALLOW_COPY_AND_ASSIGN(Process); |
| }; |
| |
| } // namespace lldb_private |
| |
| #endif // liblldb_Process_h_ |