blob: 875a8b1e2c18776dff7bf3e7a5aa0a0275408119 [file] [log] [blame]
//===-- Target.h ------------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef liblldb_Target_h_
#define liblldb_Target_h_
#include <list>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "lldb/Breakpoint/BreakpointList.h"
#include "lldb/Breakpoint/BreakpointName.h"
#include "lldb/Breakpoint/WatchpointList.h"
#include "lldb/Core/Architecture.h"
#include "lldb/Core/Disassembler.h"
#include "lldb/Core/ModuleList.h"
#include "lldb/Core/UserSettingsController.h"
#include "lldb/Expression/Expression.h"
#include "lldb/Host/ProcessLaunchInfo.h"
#include "lldb/Symbol/TypeSystem.h"
#include "lldb/Target/ExecutionContextScope.h"
#include "lldb/Target/PathMappingList.h"
#include "lldb/Target/SectionLoadHistory.h"
#include "lldb/Utility/ArchSpec.h"
#include "lldb/Utility/Broadcaster.h"
#include "lldb/Utility/LLDBAssert.h"
#include "lldb/Utility/Timeout.h"
#include "lldb/lldb-public.h"
namespace lldb_private {
OptionEnumValues GetDynamicValueTypes();
enum InlineStrategy {
eInlineBreakpointsNever = 0,
eInlineBreakpointsHeaders,
eInlineBreakpointsAlways
};
enum LoadScriptFromSymFile {
eLoadScriptFromSymFileTrue,
eLoadScriptFromSymFileFalse,
eLoadScriptFromSymFileWarn
};
enum LoadCWDlldbinitFile {
eLoadCWDlldbinitTrue,
eLoadCWDlldbinitFalse,
eLoadCWDlldbinitWarn
};
enum LoadDependentFiles {
eLoadDependentsDefault,
eLoadDependentsYes,
eLoadDependentsNo,
};
// TargetProperties
class TargetExperimentalProperties : public Properties {
public:
TargetExperimentalProperties();
};
class TargetProperties : public Properties {
public:
TargetProperties(Target *target);
~TargetProperties() override;
ArchSpec GetDefaultArchitecture() const;
void SetDefaultArchitecture(const ArchSpec &arch);
bool GetMoveToNearestCode() const;
lldb::DynamicValueType GetPreferDynamicValue() const;
bool SetPreferDynamicValue(lldb::DynamicValueType d);
bool GetPreloadSymbols() const;
void SetPreloadSymbols(bool b);
bool GetDisableASLR() const;
void SetDisableASLR(bool b);
bool GetDetachOnError() const;
void SetDetachOnError(bool b);
bool GetDisableSTDIO() const;
void SetDisableSTDIO(bool b);
const char *GetDisassemblyFlavor() const;
InlineStrategy GetInlineStrategy() const;
llvm::StringRef GetArg0() const;
void SetArg0(llvm::StringRef arg);
bool GetRunArguments(Args &args) const;
void SetRunArguments(const Args &args);
Environment GetEnvironment() const;
void SetEnvironment(Environment env);
bool GetSkipPrologue() const;
PathMappingList &GetSourcePathMap() const;
FileSpecList GetExecutableSearchPaths();
void AppendExecutableSearchPaths(const FileSpec&);
FileSpecList GetDebugFileSearchPaths();
FileSpecList GetClangModuleSearchPaths();
bool GetEnableAutoImportClangModules() const;
bool GetEnableImportStdModule() const;
bool GetEnableAutoApplyFixIts() const;
bool GetEnableNotifyAboutFixIts() const;
bool GetEnableSaveObjects() const;
bool GetEnableSyntheticValue() const;
uint32_t GetMaximumNumberOfChildrenToDisplay() const;
uint32_t GetMaximumSizeOfStringSummary() const;
uint32_t GetMaximumMemReadSize() const;
FileSpec GetStandardInputPath() const;
FileSpec GetStandardErrorPath() const;
FileSpec GetStandardOutputPath() const;
void SetStandardInputPath(llvm::StringRef path);
void SetStandardOutputPath(llvm::StringRef path);
void SetStandardErrorPath(llvm::StringRef path);
void SetStandardInputPath(const char *path) = delete;
void SetStandardOutputPath(const char *path) = delete;
void SetStandardErrorPath(const char *path) = delete;
bool GetBreakpointsConsultPlatformAvoidList();
lldb::LanguageType GetLanguage() const;
llvm::StringRef GetExpressionPrefixContents();
bool GetUseHexImmediates() const;
bool GetUseFastStepping() const;
bool GetDisplayExpressionsInCrashlogs() const;
LoadScriptFromSymFile GetLoadScriptFromSymbolFile() const;
LoadCWDlldbinitFile GetLoadCWDlldbinitFile() const;
Disassembler::HexImmediateStyle GetHexImmediateStyle() const;
MemoryModuleLoadLevel GetMemoryModuleLoadLevel() const;
bool GetUserSpecifiedTrapHandlerNames(Args &args) const;
void SetUserSpecifiedTrapHandlerNames(const Args &args);
bool GetNonStopModeEnabled() const;
void SetNonStopModeEnabled(bool b);
bool GetDisplayRuntimeSupportValues() const;
void SetDisplayRuntimeSupportValues(bool b);
bool GetDisplayRecognizedArguments() const;
void SetDisplayRecognizedArguments(bool b);
const ProcessLaunchInfo &GetProcessLaunchInfo();
void SetProcessLaunchInfo(const ProcessLaunchInfo &launch_info);
bool GetInjectLocalVariables(ExecutionContext *exe_ctx) const;
void SetInjectLocalVariables(ExecutionContext *exe_ctx, bool b);
bool GetUseModernTypeLookup() const;
void SetRequireHardwareBreakpoints(bool b);
bool GetRequireHardwareBreakpoints() const;
private:
// Callbacks for m_launch_info.
static void Arg0ValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void RunArgsValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void EnvVarsValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void InheritEnvValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void InputPathValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void OutputPathValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void ErrorPathValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void DetachOnErrorValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void DisableASLRValueChangedCallback(void *target_property_ptr,
OptionValue *);
static void DisableSTDIOValueChangedCallback(void *target_property_ptr,
OptionValue *);
// Member variables.
ProcessLaunchInfo m_launch_info;
std::unique_ptr<TargetExperimentalProperties> m_experimental_properties_up;
};
class EvaluateExpressionOptions {
public:
// MSVC has a bug here that reports C4268: 'const' static/global data
// initialized with compiler generated default constructor fills the object
// with zeros. Confirmed that MSVC is *not* zero-initializing, it's just a
// bogus warning.
#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable : 4268)
#endif
static constexpr std::chrono::milliseconds default_timeout{500};
#if defined(_MSC_VER)
#pragma warning(pop)
#endif
static constexpr ExecutionPolicy default_execution_policy =
eExecutionPolicyOnlyWhenNeeded;
EvaluateExpressionOptions() = default;
ExecutionPolicy GetExecutionPolicy() const { return m_execution_policy; }
void SetExecutionPolicy(ExecutionPolicy policy = eExecutionPolicyAlways) {
m_execution_policy = policy;
}
lldb::LanguageType GetLanguage() const { return m_language; }
void SetLanguage(lldb::LanguageType language) { m_language = language; }
bool DoesCoerceToId() const { return m_coerce_to_id; }
const char *GetPrefix() const {
return (m_prefix.empty() ? nullptr : m_prefix.c_str());
}
void SetPrefix(const char *prefix) {
if (prefix && prefix[0])
m_prefix = prefix;
else
m_prefix.clear();
}
void SetCoerceToId(bool coerce = true) { m_coerce_to_id = coerce; }
bool DoesUnwindOnError() const { return m_unwind_on_error; }
void SetUnwindOnError(bool unwind = false) { m_unwind_on_error = unwind; }
bool DoesIgnoreBreakpoints() const { return m_ignore_breakpoints; }
void SetIgnoreBreakpoints(bool ignore = false) {
m_ignore_breakpoints = ignore;
}
bool DoesKeepInMemory() const { return m_keep_in_memory; }
void SetKeepInMemory(bool keep = true) { m_keep_in_memory = keep; }
lldb::DynamicValueType GetUseDynamic() const { return m_use_dynamic; }
void
SetUseDynamic(lldb::DynamicValueType dynamic = lldb::eDynamicCanRunTarget) {
m_use_dynamic = dynamic;
}
const Timeout<std::micro> &GetTimeout() const { return m_timeout; }
void SetTimeout(const Timeout<std::micro> &timeout) { m_timeout = timeout; }
const Timeout<std::micro> &GetOneThreadTimeout() const {
return m_one_thread_timeout;
}
void SetOneThreadTimeout(const Timeout<std::micro> &timeout) {
m_one_thread_timeout = timeout;
}
bool GetTryAllThreads() const { return m_try_others; }
void SetTryAllThreads(bool try_others = true) { m_try_others = try_others; }
bool GetStopOthers() const { return m_stop_others; }
void SetStopOthers(bool stop_others = true) { m_stop_others = stop_others; }
bool GetDebug() const { return m_debug; }
void SetDebug(bool b) {
m_debug = b;
if (m_debug)
m_generate_debug_info = true;
}
bool GetGenerateDebugInfo() const { return m_generate_debug_info; }
void SetGenerateDebugInfo(bool b) { m_generate_debug_info = b; }
bool GetColorizeErrors() const { return m_ansi_color_errors; }
void SetColorizeErrors(bool b) { m_ansi_color_errors = b; }
bool GetTrapExceptions() const { return m_trap_exceptions; }
void SetTrapExceptions(bool b) { m_trap_exceptions = b; }
bool GetREPLEnabled() const { return m_repl; }
void SetREPLEnabled(bool b) { m_repl = b; }
void SetCancelCallback(lldb::ExpressionCancelCallback callback, void *baton) {
m_cancel_callback_baton = baton;
m_cancel_callback = callback;
}
bool InvokeCancelCallback(lldb::ExpressionEvaluationPhase phase) const {
return ((m_cancel_callback != nullptr)
? m_cancel_callback(phase, m_cancel_callback_baton)
: false);
}
// Allows the expression contents to be remapped to point to the specified
// file and line using #line directives.
void SetPoundLine(const char *path, uint32_t line) const {
if (path && path[0]) {
m_pound_line_file = path;
m_pound_line_line = line;
} else {
m_pound_line_file.clear();
m_pound_line_line = 0;
}
}
const char *GetPoundLineFilePath() const {
return (m_pound_line_file.empty() ? nullptr : m_pound_line_file.c_str());
}
uint32_t GetPoundLineLine() const { return m_pound_line_line; }
void SetResultIsInternal(bool b) { m_result_is_internal = b; }
bool GetResultIsInternal() const { return m_result_is_internal; }
void SetAutoApplyFixIts(bool b) { m_auto_apply_fixits = b; }
bool GetAutoApplyFixIts() const { return m_auto_apply_fixits; }
bool IsForUtilityExpr() const { return m_running_utility_expression; }
void SetIsForUtilityExpr(bool b) { m_running_utility_expression = b; }
private:
ExecutionPolicy m_execution_policy = default_execution_policy;
lldb::LanguageType m_language = lldb::eLanguageTypeUnknown;
std::string m_prefix;
bool m_coerce_to_id = false;
bool m_unwind_on_error = true;
bool m_ignore_breakpoints = false;
bool m_keep_in_memory = false;
bool m_try_others = true;
bool m_stop_others = true;
bool m_debug = false;
bool m_trap_exceptions = true;
bool m_repl = false;
bool m_generate_debug_info = false;
bool m_ansi_color_errors = false;
bool m_result_is_internal = false;
bool m_auto_apply_fixits = true;
/// True if the executed code should be treated as utility code that is only
/// used by LLDB internally.
bool m_running_utility_expression = false;
lldb::DynamicValueType m_use_dynamic = lldb::eNoDynamicValues;
Timeout<std::micro> m_timeout = default_timeout;
Timeout<std::micro> m_one_thread_timeout = llvm::None;
lldb::ExpressionCancelCallback m_cancel_callback = nullptr;
void *m_cancel_callback_baton = nullptr;
// If m_pound_line_file is not empty and m_pound_line_line is non-zero, use
// #line %u "%s" before the expression content to remap where the source
// originates
mutable std::string m_pound_line_file;
mutable uint32_t m_pound_line_line;
};
// Target
class Target : public std::enable_shared_from_this<Target>,
public TargetProperties,
public Broadcaster,
public ExecutionContextScope,
public ModuleList::Notifier {
public:
friend class TargetList;
/// Broadcaster event bits definitions.
enum {
eBroadcastBitBreakpointChanged = (1 << 0),
eBroadcastBitModulesLoaded = (1 << 1),
eBroadcastBitModulesUnloaded = (1 << 2),
eBroadcastBitWatchpointChanged = (1 << 3),
eBroadcastBitSymbolsLoaded = (1 << 4)
};
// These two functions fill out the Broadcaster interface:
static ConstString &GetStaticBroadcasterClass();
ConstString &GetBroadcasterClass() const override {
return GetStaticBroadcasterClass();
}
// This event data class is for use by the TargetList to broadcast new target
// notifications.
class TargetEventData : public EventData {
public:
TargetEventData(const lldb::TargetSP &target_sp);
TargetEventData(const lldb::TargetSP &target_sp,
const ModuleList &module_list);
~TargetEventData() override;
static ConstString GetFlavorString();
ConstString GetFlavor() const override {
return TargetEventData::GetFlavorString();
}
void Dump(Stream *s) const override;
static const TargetEventData *GetEventDataFromEvent(const Event *event_ptr);
static lldb::TargetSP GetTargetFromEvent(const Event *event_ptr);
static ModuleList GetModuleListFromEvent(const Event *event_ptr);
const lldb::TargetSP &GetTarget() const { return m_target_sp; }
const ModuleList &GetModuleList() const { return m_module_list; }
private:
lldb::TargetSP m_target_sp;
ModuleList m_module_list;
DISALLOW_COPY_AND_ASSIGN(TargetEventData);
};
~Target() override;
static void SettingsInitialize();
static void SettingsTerminate();
static FileSpecList GetDefaultExecutableSearchPaths();
static FileSpecList GetDefaultDebugFileSearchPaths();
static FileSpecList GetDefaultClangModuleSearchPaths();
static ArchSpec GetDefaultArchitecture();
static void SetDefaultArchitecture(const ArchSpec &arch);
/// Find a binary on the system and return its Module,
/// or return an existing Module that is already in the Target.
///
/// Given a ModuleSpec, find a binary satisifying that specification,
/// or identify a matching Module already present in the Target,
/// and return a shared pointer to it.
///
/// \param[in] module_spec
/// The criteria that must be matched for the binary being loaded.
/// e.g. UUID, architecture, file path.
///
/// \param[in] notify
/// If notify is true, and the Module is new to this Target,
/// Target::ModulesDidLoad will be called.
/// If notify is false, it is assumed that the caller is adding
/// multiple Modules and will call ModulesDidLoad with the
/// full list at the end.
/// ModulesDidLoad must be called when a Module/Modules have
/// been added to the target, one way or the other.
///
/// \param[out] error_ptr
/// Optional argument, pointing to a Status object to fill in
/// with any results / messages while attempting to find/load
/// this binary. Many callers will be internal functions that
/// will handle / summarize the failures in a custom way and
/// don't use these messages.
///
/// \return
/// An empty ModuleSP will be returned if no matching file
/// was found. If error_ptr was non-nullptr, an error message
/// will likely be provided.
lldb::ModuleSP GetOrCreateModule(const ModuleSpec &module_spec,
bool notify,
Status *error_ptr = nullptr);
// Settings accessors
static const lldb::TargetPropertiesSP &GetGlobalProperties();
std::recursive_mutex &GetAPIMutex() { return m_mutex; }
void DeleteCurrentProcess();
void CleanupProcess();
/// Dump a description of this object to a Stream.
///
/// Dump a description of the contents of this object to the
/// supplied stream \a s. The dumped content will be only what has
/// been loaded or parsed up to this point at which this function
/// is called, so this is a good way to see what has been parsed
/// in a target.
///
/// \param[in] s
/// The stream to which to dump the object description.
void Dump(Stream *s, lldb::DescriptionLevel description_level);
// If listener_sp is null, the listener of the owning Debugger object will be
// used.
const lldb::ProcessSP &CreateProcess(lldb::ListenerSP listener_sp,
llvm::StringRef plugin_name,
const FileSpec *crash_file);
const lldb::ProcessSP &GetProcessSP() const;
bool IsValid() { return m_valid; }
void Destroy();
Status Launch(ProcessLaunchInfo &launch_info,
Stream *stream); // Optional stream to receive first stop info
Status Attach(ProcessAttachInfo &attach_info,
Stream *stream); // Optional stream to receive first stop info
// This part handles the breakpoints.
BreakpointList &GetBreakpointList(bool internal = false);
const BreakpointList &GetBreakpointList(bool internal = false) const;
lldb::BreakpointSP GetLastCreatedBreakpoint() {
return m_last_created_breakpoint;
}
lldb::BreakpointSP GetBreakpointByID(lldb::break_id_t break_id);
// Use this to create a file and line breakpoint to a given module or all
// module it is nullptr
lldb::BreakpointSP CreateBreakpoint(const FileSpecList *containingModules,
const FileSpec &file, uint32_t line_no,
uint32_t column, lldb::addr_t offset,
LazyBool check_inlines,
LazyBool skip_prologue, bool internal,
bool request_hardware,
LazyBool move_to_nearest_code);
// Use this to create breakpoint that matches regex against the source lines
// in files given in source_file_list: If function_names is non-empty, also
// filter by function after the matches are made.
lldb::BreakpointSP CreateSourceRegexBreakpoint(
const FileSpecList *containingModules,
const FileSpecList *source_file_list,
const std::unordered_set<std::string> &function_names,
RegularExpression &source_regex, bool internal, bool request_hardware,
LazyBool move_to_nearest_code);
// Use this to create a breakpoint from a load address
lldb::BreakpointSP CreateBreakpoint(lldb::addr_t load_addr, bool internal,
bool request_hardware);
// Use this to create a breakpoint from a load address and a module file spec
lldb::BreakpointSP CreateAddressInModuleBreakpoint(lldb::addr_t file_addr,
bool internal,
const FileSpec *file_spec,
bool request_hardware);
// Use this to create Address breakpoints:
lldb::BreakpointSP CreateBreakpoint(const Address &addr, bool internal,
bool request_hardware);
// Use this to create a function breakpoint by regexp in
// containingModule/containingSourceFiles, or all modules if it is nullptr
// When "skip_prologue is set to eLazyBoolCalculate, we use the current
// target setting, else we use the values passed in
lldb::BreakpointSP CreateFuncRegexBreakpoint(
const FileSpecList *containingModules,
const FileSpecList *containingSourceFiles, RegularExpression &func_regexp,
lldb::LanguageType requested_language, LazyBool skip_prologue,
bool internal, bool request_hardware);
// Use this to create a function breakpoint by name in containingModule, or
// all modules if it is nullptr When "skip_prologue is set to
// eLazyBoolCalculate, we use the current target setting, else we use the
// values passed in. func_name_type_mask is or'ed values from the
// FunctionNameType enum.
lldb::BreakpointSP CreateBreakpoint(
const FileSpecList *containingModules,
const FileSpecList *containingSourceFiles, const char *func_name,
lldb::FunctionNameType func_name_type_mask, lldb::LanguageType language,
lldb::addr_t offset, LazyBool skip_prologue, bool internal,
bool request_hardware);
lldb::BreakpointSP
CreateExceptionBreakpoint(enum lldb::LanguageType language, bool catch_bp,
bool throw_bp, bool internal,
Args *additional_args = nullptr,
Status *additional_args_error = nullptr);
lldb::BreakpointSP
CreateScriptedBreakpoint(const llvm::StringRef class_name,
const FileSpecList *containingModules,
const FileSpecList *containingSourceFiles,
bool internal,
bool request_hardware,
StructuredData::ObjectSP extra_args_sp,
Status *creation_error = nullptr);
// This is the same as the func_name breakpoint except that you can specify a
// vector of names. This is cheaper than a regular expression breakpoint in
// the case where you just want to set a breakpoint on a set of names you
// already know. func_name_type_mask is or'ed values from the
// FunctionNameType enum.
lldb::BreakpointSP CreateBreakpoint(
const FileSpecList *containingModules,
const FileSpecList *containingSourceFiles, const char *func_names[],
size_t num_names, lldb::FunctionNameType func_name_type_mask,
lldb::LanguageType language, lldb::addr_t offset, LazyBool skip_prologue,
bool internal, bool request_hardware);
lldb::BreakpointSP
CreateBreakpoint(const FileSpecList *containingModules,
const FileSpecList *containingSourceFiles,
const std::vector<std::string> &func_names,
lldb::FunctionNameType func_name_type_mask,
lldb::LanguageType language, lldb::addr_t m_offset,
LazyBool skip_prologue, bool internal,
bool request_hardware);
// Use this to create a general breakpoint:
lldb::BreakpointSP CreateBreakpoint(lldb::SearchFilterSP &filter_sp,
lldb::BreakpointResolverSP &resolver_sp,
bool internal, bool request_hardware,
bool resolve_indirect_symbols);
// Use this to create a watchpoint:
lldb::WatchpointSP CreateWatchpoint(lldb::addr_t addr, size_t size,
const CompilerType *type, uint32_t kind,
Status &error);
lldb::WatchpointSP GetLastCreatedWatchpoint() {
return m_last_created_watchpoint;
}
WatchpointList &GetWatchpointList() { return m_watchpoint_list; }
// Manages breakpoint names:
void AddNameToBreakpoint(BreakpointID &id, const char *name, Status &error);
void AddNameToBreakpoint(lldb::BreakpointSP &bp_sp, const char *name,
Status &error);
void RemoveNameFromBreakpoint(lldb::BreakpointSP &bp_sp,
ConstString name);
BreakpointName *FindBreakpointName(ConstString name, bool can_create,
Status &error);
void DeleteBreakpointName(ConstString name);
void ConfigureBreakpointName(BreakpointName &bp_name,
const BreakpointOptions &options,
const BreakpointName::Permissions &permissions);
void ApplyNameToBreakpoints(BreakpointName &bp_name);
// This takes ownership of the name obj passed in.
void AddBreakpointName(BreakpointName *bp_name);
void GetBreakpointNames(std::vector<std::string> &names);
//This call removes ALL breakpoints regardless of permission.
void RemoveAllBreakpoints(bool internal_also = false);
// This removes all the breakpoints, but obeys the ePermDelete on them.
void RemoveAllowedBreakpoints();
void DisableAllBreakpoints(bool internal_also = false);
void DisableAllowedBreakpoints();
void EnableAllBreakpoints(bool internal_also = false);
void EnableAllowedBreakpoints();
bool DisableBreakpointByID(lldb::break_id_t break_id);
bool EnableBreakpointByID(lldb::break_id_t break_id);
bool RemoveBreakpointByID(lldb::break_id_t break_id);
// The flag 'end_to_end', default to true, signifies that the operation is
// performed end to end, for both the debugger and the debuggee.
bool RemoveAllWatchpoints(bool end_to_end = true);
bool DisableAllWatchpoints(bool end_to_end = true);
bool EnableAllWatchpoints(bool end_to_end = true);
bool ClearAllWatchpointHitCounts();
bool ClearAllWatchpointHistoricValues();
bool IgnoreAllWatchpoints(uint32_t ignore_count);
bool DisableWatchpointByID(lldb::watch_id_t watch_id);
bool EnableWatchpointByID(lldb::watch_id_t watch_id);
bool RemoveWatchpointByID(lldb::watch_id_t watch_id);
bool IgnoreWatchpointByID(lldb::watch_id_t watch_id, uint32_t ignore_count);
Status SerializeBreakpointsToFile(const FileSpec &file,
const BreakpointIDList &bp_ids,
bool append);
Status CreateBreakpointsFromFile(const FileSpec &file,
BreakpointIDList &new_bps);
Status CreateBreakpointsFromFile(const FileSpec &file,
std::vector<std::string> &names,
BreakpointIDList &new_bps);
/// Get \a load_addr as a callable code load address for this target
///
/// Take \a load_addr and potentially add any address bits that are
/// needed to make the address callable. For ARM this can set bit
/// zero (if it already isn't) if \a load_addr is a thumb function.
/// If \a addr_class is set to AddressClass::eInvalid, then the address
/// adjustment will always happen. If it is set to an address class
/// that doesn't have code in it, LLDB_INVALID_ADDRESS will be
/// returned.
lldb::addr_t GetCallableLoadAddress(
lldb::addr_t load_addr,
AddressClass addr_class = AddressClass::eInvalid) const;
/// Get \a load_addr as an opcode for this target.
///
/// Take \a load_addr and potentially strip any address bits that are
/// needed to make the address point to an opcode. For ARM this can
/// clear bit zero (if it already isn't) if \a load_addr is a
/// thumb function and load_addr is in code.
/// If \a addr_class is set to AddressClass::eInvalid, then the address
/// adjustment will always happen. If it is set to an address class
/// that doesn't have code in it, LLDB_INVALID_ADDRESS will be
/// returned.
lldb::addr_t
GetOpcodeLoadAddress(lldb::addr_t load_addr,
AddressClass addr_class = AddressClass::eInvalid) const;
// Get load_addr as breakable load address for this target. Take a addr and
// check if for any reason there is a better address than this to put a
// breakpoint on. If there is then return that address. For MIPS, if
// instruction at addr is a delay slot instruction then this method will find
// the address of its previous instruction and return that address.
lldb::addr_t GetBreakableLoadAddress(lldb::addr_t addr);
void ModulesDidLoad(ModuleList &module_list);
void ModulesDidUnload(ModuleList &module_list, bool delete_locations);
void SymbolsDidLoad(ModuleList &module_list);
void ClearModules(bool delete_locations);
/// Called as the last function in Process::DidExec().
///
/// Process::DidExec() will clear a lot of state in the process,
/// then try to reload a dynamic loader plugin to discover what
/// binaries are currently available and then this function should
/// be called to allow the target to do any cleanup after everything
/// has been figured out. It can remove breakpoints that no longer
/// make sense as the exec might have changed the target
/// architecture, and unloaded some modules that might get deleted.
void DidExec();
/// Gets the module for the main executable.
///
/// Each process has a notion of a main executable that is the file
/// that will be executed or attached to. Executable files can have
/// dependent modules that are discovered from the object files, or
/// discovered at runtime as things are dynamically loaded.
///
/// \return
/// The shared pointer to the executable module which can
/// contains a nullptr Module object if no executable has been
/// set.
///
/// \see DynamicLoader
/// \see ObjectFile::GetDependentModules (FileSpecList&)
/// \see Process::SetExecutableModule(lldb::ModuleSP&)
lldb::ModuleSP GetExecutableModule();
Module *GetExecutableModulePointer();
/// Set the main executable module.
///
/// Each process has a notion of a main executable that is the file
/// that will be executed or attached to. Executable files can have
/// dependent modules that are discovered from the object files, or
/// discovered at runtime as things are dynamically loaded.
///
/// Setting the executable causes any of the current dependent
/// image information to be cleared and replaced with the static
/// dependent image information found by calling
/// ObjectFile::GetDependentModules (FileSpecList&) on the main
/// executable and any modules on which it depends. Calling
/// Process::GetImages() will return the newly found images that
/// were obtained from all of the object files.
///
/// \param[in] module_sp
/// A shared pointer reference to the module that will become
/// the main executable for this process.
///
/// \param[in] load_dependent_files
/// If \b true then ask the object files to track down any
/// known dependent files.
///
/// \see ObjectFile::GetDependentModules (FileSpecList&)
/// \see Process::GetImages()
void SetExecutableModule(
lldb::ModuleSP &module_sp,
LoadDependentFiles load_dependent_files = eLoadDependentsDefault);
bool LoadScriptingResources(std::list<Status> &errors,
Stream *feedback_stream = nullptr,
bool continue_on_error = true) {
return m_images.LoadScriptingResourcesInTarget(
this, errors, feedback_stream, continue_on_error);
}
/// Get accessor for the images for this process.
///
/// Each process has a notion of a main executable that is the file
/// that will be executed or attached to. Executable files can have
/// dependent modules that are discovered from the object files, or
/// discovered at runtime as things are dynamically loaded. After
/// a main executable has been set, the images will contain a list
/// of all the files that the executable depends upon as far as the
/// object files know. These images will usually contain valid file
/// virtual addresses only. When the process is launched or attached
/// to, the DynamicLoader plug-in will discover where these images
/// were loaded in memory and will resolve the load virtual
/// addresses is each image, and also in images that are loaded by
/// code.
///
/// \return
/// A list of Module objects in a module list.
const ModuleList &GetImages() const { return m_images; }
ModuleList &GetImages() { return m_images; }
/// Return whether this FileSpec corresponds to a module that should be
/// considered for general searches.
///
/// This API will be consulted by the SearchFilterForUnconstrainedSearches
/// and any module that returns \b true will not be searched. Note the
/// SearchFilterForUnconstrainedSearches is the search filter that
/// gets used in the CreateBreakpoint calls when no modules is provided.
///
/// The target call at present just consults the Platform's call of the
/// same name.
///
/// \param[in] module_sp
/// A shared pointer reference to the module that checked.
///
/// \return \b true if the module should be excluded, \b false otherwise.
bool ModuleIsExcludedForUnconstrainedSearches(const FileSpec &module_spec);
/// Return whether this module should be considered for general searches.
///
/// This API will be consulted by the SearchFilterForUnconstrainedSearches
/// and any module that returns \b true will not be searched. Note the
/// SearchFilterForUnconstrainedSearches is the search filter that
/// gets used in the CreateBreakpoint calls when no modules is provided.
///
/// The target call at present just consults the Platform's call of the
/// same name.
///
/// FIXME: When we get time we should add a way for the user to set modules
/// that they
/// don't want searched, in addition to or instead of the platform ones.
///
/// \param[in] module_sp
/// A shared pointer reference to the module that checked.
///
/// \return \b true if the module should be excluded, \b false otherwise.
bool
ModuleIsExcludedForUnconstrainedSearches(const lldb::ModuleSP &module_sp);
const ArchSpec &GetArchitecture() const { return m_arch.GetSpec(); }
/// Set the architecture for this target.
///
/// If the current target has no Images read in, then this just sets the
/// architecture, which will be used to select the architecture of the
/// ExecutableModule when that is set. If the current target has an
/// ExecutableModule, then calling SetArchitecture with a different
/// architecture from the currently selected one will reset the
/// ExecutableModule to that slice of the file backing the ExecutableModule.
/// If the file backing the ExecutableModule does not contain a fork of this
/// architecture, then this code will return false, and the architecture
/// won't be changed. If the input arch_spec is the same as the already set
/// architecture, this is a no-op.
///
/// \param[in] arch_spec
/// The new architecture.
///
/// \param[in] set_platform
/// If \b true, then the platform will be adjusted if the currently
/// selected platform is not compatible with the archicture being set.
/// If \b false, then just the architecture will be set even if the
/// currently selected platform isn't compatible (in case it might be
/// manually set following this function call).
///
/// \return
/// \b true if the architecture was successfully set, \bfalse otherwise.
bool SetArchitecture(const ArchSpec &arch_spec, bool set_platform = false);
bool MergeArchitecture(const ArchSpec &arch_spec);
Architecture *GetArchitecturePlugin() const { return m_arch.GetPlugin(); }
Debugger &GetDebugger() { return m_debugger; }
size_t ReadMemoryFromFileCache(const Address &addr, void *dst, size_t dst_len,
Status &error);
// Reading memory through the target allows us to skip going to the process
// for reading memory if possible and it allows us to try and read from any
// constant sections in our object files on disk. If you always want live
// program memory, read straight from the process. If you possibly want to
// read from const sections in object files, read from the target. This
// version of ReadMemory will try and read memory from the process if the
// process is alive. The order is:
// 1 - if (prefer_file_cache == true) then read from object file cache
// 2 - if there is a valid process, try and read from its memory
// 3 - if (prefer_file_cache == false) then read from object file cache
size_t ReadMemory(const Address &addr, bool prefer_file_cache, void *dst,
size_t dst_len, Status &error,
lldb::addr_t *load_addr_ptr = nullptr);
size_t ReadCStringFromMemory(const Address &addr, std::string &out_str,
Status &error);
size_t ReadCStringFromMemory(const Address &addr, char *dst,
size_t dst_max_len, Status &result_error);
size_t ReadScalarIntegerFromMemory(const Address &addr,
bool prefer_file_cache, uint32_t byte_size,
bool is_signed, Scalar &scalar,
Status &error);
uint64_t ReadUnsignedIntegerFromMemory(const Address &addr,
bool prefer_file_cache,
size_t integer_byte_size,
uint64_t fail_value, Status &error);
bool ReadPointerFromMemory(const Address &addr, bool prefer_file_cache,
Status &error, Address &pointer_addr);
SectionLoadList &GetSectionLoadList() {
return m_section_load_history.GetCurrentSectionLoadList();
}
static Target *GetTargetFromContexts(const ExecutionContext *exe_ctx_ptr,
const SymbolContext *sc_ptr);
// lldb::ExecutionContextScope pure virtual functions
lldb::TargetSP CalculateTarget() override;
lldb::ProcessSP CalculateProcess() override;
lldb::ThreadSP CalculateThread() override;
lldb::StackFrameSP CalculateStackFrame() override;
void CalculateExecutionContext(ExecutionContext &exe_ctx) override;
PathMappingList &GetImageSearchPathList();
TypeSystem *GetScratchTypeSystemForLanguage(Status *error,
lldb::LanguageType language,
bool create_on_demand = true);
PersistentExpressionState *
GetPersistentExpressionStateForLanguage(lldb::LanguageType language);
// Creates a UserExpression for the given language, the rest of the
// parameters have the same meaning as for the UserExpression constructor.
// Returns a new-ed object which the caller owns.
UserExpression *GetUserExpressionForLanguage(
llvm::StringRef expr, llvm::StringRef prefix, lldb::LanguageType language,
Expression::ResultType desired_type,
const EvaluateExpressionOptions &options,
ValueObject *ctx_obj, Status &error);
// Creates a FunctionCaller for the given language, the rest of the
// parameters have the same meaning as for the FunctionCaller constructor.
// Since a FunctionCaller can't be
// IR Interpreted, it makes no sense to call this with an
// ExecutionContextScope that lacks
// a Process.
// Returns a new-ed object which the caller owns.
FunctionCaller *GetFunctionCallerForLanguage(lldb::LanguageType language,
const CompilerType &return_type,
const Address &function_address,
const ValueList &arg_value_list,
const char *name, Status &error);
// Creates a UtilityFunction for the given language, the rest of the
// parameters have the same meaning as for the UtilityFunction constructor.
// Returns a new-ed object which the caller owns.
UtilityFunction *GetUtilityFunctionForLanguage(const char *expr,
lldb::LanguageType language,
const char *name,
Status &error);
ClangASTContext *GetScratchClangASTContext(bool create_on_demand = true);
lldb::ClangASTImporterSP GetClangASTImporter();
// Install any files through the platform that need be to installed prior to
// launching or attaching.
Status Install(ProcessLaunchInfo *launch_info);
bool ResolveFileAddress(lldb::addr_t load_addr, Address &so_addr);
bool ResolveLoadAddress(lldb::addr_t load_addr, Address &so_addr,
uint32_t stop_id = SectionLoadHistory::eStopIDNow);
bool SetSectionLoadAddress(const lldb::SectionSP &section,
lldb::addr_t load_addr,
bool warn_multiple = false);
size_t UnloadModuleSections(const lldb::ModuleSP &module_sp);
size_t UnloadModuleSections(const ModuleList &module_list);
bool SetSectionUnloaded(const lldb::SectionSP &section_sp);
bool SetSectionUnloaded(const lldb::SectionSP &section_sp,
lldb::addr_t load_addr);
void ClearAllLoadedSections();
// Since expressions results can persist beyond the lifetime of a process,
// and the const expression results are available after a process is gone, we
// provide a way for expressions to be evaluated from the Target itself. If
// an expression is going to be run, then it should have a frame filled in in
// the execution context.
lldb::ExpressionResults EvaluateExpression(
llvm::StringRef expression, ExecutionContextScope *exe_scope,
lldb::ValueObjectSP &result_valobj_sp,
const EvaluateExpressionOptions &options = EvaluateExpressionOptions(),
std::string *fixed_expression = nullptr,
ValueObject *ctx_obj = nullptr);
lldb::ExpressionVariableSP GetPersistentVariable(ConstString name);
/// Return the next available number for numbered persistent variables.
unsigned GetNextPersistentVariableIndex() {
return m_next_persistent_variable_index++;
}
lldb::addr_t GetPersistentSymbol(ConstString name);
// Target Stop Hooks
class StopHook : public UserID {
public:
StopHook(const StopHook &rhs);
~StopHook();
StringList *GetCommandPointer() { return &m_commands; }
const StringList &GetCommands() { return m_commands; }
lldb::TargetSP &GetTarget() { return m_target_sp; }
void SetCommands(StringList &in_commands) { m_commands = in_commands; }
// Set the specifier. The stop hook will own the specifier, and is
// responsible for deleting it when we're done.
void SetSpecifier(SymbolContextSpecifier *specifier);
SymbolContextSpecifier *GetSpecifier() { return m_specifier_sp.get(); }
// Set the Thread Specifier. The stop hook will own the thread specifier,
// and is responsible for deleting it when we're done.
void SetThreadSpecifier(ThreadSpec *specifier);
ThreadSpec *GetThreadSpecifier() { return m_thread_spec_up.get(); }
bool IsActive() { return m_active; }
void SetIsActive(bool is_active) { m_active = is_active; }
void SetAutoContinue(bool auto_continue) {m_auto_continue = auto_continue;}
bool GetAutoContinue() const { return m_auto_continue; }
void GetDescription(Stream *s, lldb::DescriptionLevel level) const;
private:
lldb::TargetSP m_target_sp;
StringList m_commands;
lldb::SymbolContextSpecifierSP m_specifier_sp;
std::unique_ptr<ThreadSpec> m_thread_spec_up;
bool m_active = true;
bool m_auto_continue = false;
// Use CreateStopHook to make a new empty stop hook. The GetCommandPointer
// and fill it with commands, and SetSpecifier to set the specifier shared
// pointer (can be null, that will match anything.)
StopHook(lldb::TargetSP target_sp, lldb::user_id_t uid);
friend class Target;
};
typedef std::shared_ptr<StopHook> StopHookSP;
// Add an empty stop hook to the Target's stop hook list, and returns a
// shared pointer to it in new_hook. Returns the id of the new hook.
StopHookSP CreateStopHook();
void RunStopHooks();
size_t GetStopHookSize();
bool SetSuppresStopHooks(bool suppress) {
bool old_value = m_suppress_stop_hooks;
m_suppress_stop_hooks = suppress;
return old_value;
}
bool GetSuppressStopHooks() { return m_suppress_stop_hooks; }
bool RemoveStopHookByID(lldb::user_id_t uid);
void RemoveAllStopHooks();
StopHookSP GetStopHookByID(lldb::user_id_t uid);
bool SetStopHookActiveStateByID(lldb::user_id_t uid, bool active_state);
void SetAllStopHooksActiveState(bool active_state);
size_t GetNumStopHooks() const { return m_stop_hooks.size(); }
StopHookSP GetStopHookAtIndex(size_t index) {
if (index >= GetNumStopHooks())
return StopHookSP();
StopHookCollection::iterator pos = m_stop_hooks.begin();
while (index > 0) {
pos++;
index--;
}
return (*pos).second;
}
lldb::PlatformSP GetPlatform() { return m_platform_sp; }
void SetPlatform(const lldb::PlatformSP &platform_sp) {
m_platform_sp = platform_sp;
}
SourceManager &GetSourceManager();
ClangModulesDeclVendor *GetClangModulesDeclVendor();
// Methods.
lldb::SearchFilterSP
GetSearchFilterForModule(const FileSpec *containingModule);
lldb::SearchFilterSP
GetSearchFilterForModuleList(const FileSpecList *containingModuleList);
lldb::SearchFilterSP
GetSearchFilterForModuleAndCUList(const FileSpecList *containingModules,
const FileSpecList *containingSourceFiles);
lldb::REPLSP GetREPL(Status &err, lldb::LanguageType language,
const char *repl_options, bool can_create);
void SetREPL(lldb::LanguageType language, lldb::REPLSP repl_sp);
protected:
/// Implementing of ModuleList::Notifier.
void NotifyModuleAdded(const ModuleList &module_list,
const lldb::ModuleSP &module_sp) override;
void NotifyModuleRemoved(const ModuleList &module_list,
const lldb::ModuleSP &module_sp) override;
void NotifyModuleUpdated(const ModuleList &module_list,
const lldb::ModuleSP &old_module_sp,
const lldb::ModuleSP &new_module_sp) override;
void NotifyWillClearList(const ModuleList &module_list) override;
void NotifyModulesRemoved(lldb_private::ModuleList &module_list) override;
class Arch {
public:
explicit Arch(const ArchSpec &spec);
const Arch &operator=(const ArchSpec &spec);
const ArchSpec &GetSpec() const { return m_spec; }
Architecture *GetPlugin() const { return m_plugin_up.get(); }
private:
ArchSpec m_spec;
std::unique_ptr<Architecture> m_plugin_up;
};
// Member variables.
Debugger &m_debugger;
lldb::PlatformSP m_platform_sp; ///< The platform for this target.
std::recursive_mutex m_mutex; ///< An API mutex that is used by the lldb::SB*
/// classes make the SB interface thread safe
Arch m_arch;
ModuleList m_images; ///< The list of images for this process (shared
/// libraries and anything dynamically loaded).
SectionLoadHistory m_section_load_history;
BreakpointList m_breakpoint_list;
BreakpointList m_internal_breakpoint_list;
using BreakpointNameList = std::map<ConstString, BreakpointName *>;
BreakpointNameList m_breakpoint_names;
lldb::BreakpointSP m_last_created_breakpoint;
WatchpointList m_watchpoint_list;
lldb::WatchpointSP m_last_created_watchpoint;
// We want to tightly control the process destruction process so we can
// correctly tear down everything that we need to, so the only class that
// knows about the process lifespan is this target class.
lldb::ProcessSP m_process_sp;
lldb::SearchFilterSP m_search_filter_sp;
PathMappingList m_image_search_paths;
TypeSystemMap m_scratch_type_system_map;
typedef std::map<lldb::LanguageType, lldb::REPLSP> REPLMap;
REPLMap m_repl_map;
lldb::ClangASTImporterSP m_ast_importer_sp;
lldb::ClangModulesDeclVendorUP m_clang_modules_decl_vendor_up;
lldb::SourceManagerUP m_source_manager_up;
typedef std::map<lldb::user_id_t, StopHookSP> StopHookCollection;
StopHookCollection m_stop_hooks;
lldb::user_id_t m_stop_hook_next_id;
bool m_valid;
bool m_suppress_stop_hooks;
bool m_is_dummy_target;
unsigned m_next_persistent_variable_index = 0;
static void ImageSearchPathsChanged(const PathMappingList &path_list,
void *baton);
// Utilities for `statistics` command.
private:
std::vector<uint32_t> m_stats_storage;
bool m_collecting_stats = false;
public:
void SetCollectingStats(bool v) { m_collecting_stats = v; }
bool GetCollectingStats() { return m_collecting_stats; }
void IncrementStats(lldb_private::StatisticKind key) {
if (!GetCollectingStats())
return;
lldbassert(key < lldb_private::StatisticKind::StatisticMax &&
"invalid statistics!");
m_stats_storage[key] += 1;
}
std::vector<uint32_t> GetStatistics() { return m_stats_storage; }
private:
/// Construct with optional file and arch.
///
/// This member is private. Clients must use
/// TargetList::CreateTarget(const FileSpec*, const ArchSpec*)
/// so all targets can be tracked from the central target list.
///
/// \see TargetList::CreateTarget(const FileSpec*, const ArchSpec*)
Target(Debugger &debugger, const ArchSpec &target_arch,
const lldb::PlatformSP &platform_sp, bool is_dummy_target);
// Helper function.
bool ProcessIsValid();
// Copy breakpoints, stop hooks and so forth from the dummy target:
void PrimeFromDummyTarget(Target *dummy_target);
void AddBreakpoint(lldb::BreakpointSP breakpoint_sp, bool internal);
void FinalizeFileActions(ProcessLaunchInfo &info);
DISALLOW_COPY_AND_ASSIGN(Target);
};
} // namespace lldb_private
#endif // liblldb_Target_h_