LLDB  mainline
Public Member Functions | Static Public Member Functions | Public Attributes | Private Attributes | List of all members
lldb_private::platform_linux::PlatformLinux Class Reference

#include <PlatformLinux.h>

Inheritance diagram for lldb_private::platform_linux::PlatformLinux:
Inheritance graph
Collaboration diagram for lldb_private::platform_linux::PlatformLinux:
Collaboration graph

Public Member Functions

 PlatformLinux (bool is_host)
 Default Constructor. More...
llvm::StringRef GetPluginName () override
llvm::StringRef GetDescription () override
void GetStatus (Stream &strm) override
 Report the current status for this platform. More...
std::vector< ArchSpecGetSupportedArchitectures (const ArchSpec &process_host_arch) override
 Get the platform's supported architectures in the order in which they should be searched. More...
uint32_t GetResumeCountForLaunchInfo (ProcessLaunchInfo &launch_info) override
bool CanDebugProcess () override
 Not all platforms will support debugging a process by spawning somehow halted for a debugger (specified using the "eLaunchFlagDebug" launch flag) and then attaching. More...
void CalculateTrapHandlerSymbolNames () override
 Ask the Platform subclass to fill in the list of trap handler names. More...
lldb::UnwindPlanSP GetTrapHandlerUnwindPlan (const llvm::Triple &triple, ConstString name) override
 Try to get a specific unwind plan for a named trap handler. More...
MmapArgList GetMmapArgumentList (const ArchSpec &arch, lldb::addr_t addr, lldb::addr_t length, unsigned prot, unsigned flags, lldb::addr_t fd, lldb::addr_t offset) override
CompilerType GetSiginfoType (const llvm::Triple &triple) override
- Public Member Functions inherited from PlatformPOSIX
 PlatformPOSIX (bool is_host)
 Default Constructor. More...
 ~PlatformPOSIX () override
 Destructor. More...
lldb_private::OptionGroupOptionsGetConnectionOptions (lldb_private::CommandInterpreter &interpreter) override
lldb_private::Status PutFile (const lldb_private::FileSpec &source, const lldb_private::FileSpec &destination, uint32_t uid=UINT32_MAX, uint32_t gid=UINT32_MAX) override
lldb_private::Status GetFile (const lldb_private::FileSpec &source, const lldb_private::FileSpec &destination) override
const lldb::UnixSignalsSP & GetRemoteUnixSignals () override
lldb::ProcessSP Attach (lldb_private::ProcessAttachInfo &attach_info, lldb_private::Debugger &debugger, lldb_private::Target *target, lldb_private::Status &error) override
 Attach to an existing process using a process ID. More...
lldb::ProcessSP DebugProcess (lldb_private::ProcessLaunchInfo &launch_info, lldb_private::Debugger &debugger, lldb_private::Target &target, lldb_private::Status &error) override
 Subclasses do not need to implement this function as it uses the Platform::LaunchProcess() followed by Platform::Attach (). More...
std::string GetPlatformSpecificConnectionInformation () override
void CalculateTrapHandlerSymbolNames () override
 Ask the Platform subclass to fill in the list of trap handler names. More...
lldb_private::Status ConnectRemote (lldb_private::Args &args) override
lldb_private::Status DisconnectRemote () override
uint32_t DoLoadImage (lldb_private::Process *process, const lldb_private::FileSpec &remote_file, const std::vector< std::string > *paths, lldb_private::Status &error, lldb_private::FileSpec *loaded_image) override
lldb_private::Status UnloadImage (lldb_private::Process *process, uint32_t image_token) override
lldb_private::ConstString GetFullNameForDylib (lldb_private::ConstString basename) override
- Public Member Functions inherited from lldb_private::RemoteAwarePlatform
bool GetModuleSpec (const FileSpec &module_file_spec, const ArchSpec &arch, ModuleSpec &module_spec) override
Status ResolveExecutable (const ModuleSpec &module_spec, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr) override
 Find a platform plugin for a given process. More...
lldb::user_id_t OpenFile (const FileSpec &file_spec, File::OpenOptions flags, uint32_t mode, Status &error) override
bool CloseFile (lldb::user_id_t fd, Status &error) override
uint64_t ReadFile (lldb::user_id_t fd, uint64_t offset, void *dst, uint64_t dst_len, Status &error) override
uint64_t WriteFile (lldb::user_id_t fd, uint64_t offset, const void *src, uint64_t src_len, Status &error) override
lldb::user_id_t GetFileSize (const FileSpec &file_spec) override
Status CreateSymlink (const FileSpec &src, const FileSpec &dst) override
bool GetFileExists (const FileSpec &file_spec) override
Status Unlink (const FileSpec &file_spec) override
FileSpec GetRemoteWorkingDirectory () override
bool SetRemoteWorkingDirectory (const FileSpec &working_dir) override
Status MakeDirectory (const FileSpec &file_spec, uint32_t mode) override
Status GetFilePermissions (const FileSpec &file_spec, uint32_t &file_permissions) override
Status SetFilePermissions (const FileSpec &file_spec, uint32_t file_permissions) override
bool CalculateMD5 (const FileSpec &file_spec, uint64_t &low, uint64_t &high) override
Status GetFileWithUUID (const FileSpec &platform_file, const UUID *uuid, FileSpec &local_file) override
 Locate a file for a platform. More...
bool GetRemoteOSVersion () override
llvm::Optional< std::stringGetRemoteOSBuildString () override
llvm::Optional< std::stringGetRemoteOSKernelDescription () override
ArchSpec GetRemoteSystemArchitecture () override
Status RunShellCommand (llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout) override
Status RunShellCommand (llvm::StringRef interpreter, llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout) override
const char * GetHostname () override
UserIDResolverGetUserIDResolver () override
lldb_private::Environment GetEnvironment () override
bool IsConnected () const override
bool GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &proc_info) override
uint32_t FindProcesses (const ProcessInstanceInfoMatch &match_info, ProcessInstanceInfoList &process_infos) override
 Attach to an existing process by process name. More...
lldb::ProcessSP ConnectProcess (llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Target *target, Status &error) override
Status LaunchProcess (ProcessLaunchInfo &launch_info) override
 Launch a new process on a platform, not necessarily for debugging, it could be just for running the process. More...
Status KillProcess (const lldb::pid_t pid) override
 Kill process on a platform. More...
size_t ConnectToWaitingProcesses (Debugger &debugger, Status &error) override
 Connect to all processes waiting for a debugger to attach. More...
 Platform (bool is_host_platform)
 Default Constructor. More...
- Public Member Functions inherited from lldb_private::Platform
 Platform (bool is_host_platform)
 Default Constructor. More...
 ~Platform () override
 The destructor is virtual since this class is designed to be inherited from by the plug-in instance. More...
virtual Status ResolveSymbolFile (Target &target, const ModuleSpec &sym_spec, FileSpec &sym_file)
 Find a symbol file given a symbol file module specification. More...
virtual bool ResolveRemotePath (const FileSpec &platform_path, FileSpec &resolved_platform_path)
 Resolves the FileSpec to a (possibly) remote path. More...
virtual llvm::VersionTuple GetOSVersion (Process *process=nullptr)
 Get the OS version from a connected platform. More...
bool SetOSVersion (llvm::VersionTuple os_version)
llvm::Optional< std::stringGetOSBuildString ()
llvm::Optional< std::stringGetOSKernelDescription ()
llvm::StringRef GetName ()
virtual FileSpecList LocateExecutableScriptingResources (Target *target, Module &module, Stream *feedback_stream)
virtual Status GetSharedModule (const ModuleSpec &module_spec, Process *process, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr, llvm::SmallVectorImpl< lldb::ModuleSP > *old_modules, bool *did_create_ptr)
virtual size_t GetSoftwareBreakpointTrapOpcode (Target &target, BreakpointSite *bp_site)
virtual Status ShellExpandArguments (ProcessLaunchInfo &launch_info)
 Perform expansion of the command-line for this launch info This can potentially involve wildcard expansion environment variable replacement, and whatever other argument magic the platform defines as part of its typical user experience. More...
virtual bool IsCompatibleArchitecture (const ArchSpec &arch, const ArchSpec &process_host_arch, ArchSpec::MatchType match, ArchSpec *compatible_arch_ptr)
 Lets a platform answer if it is compatible with a given architecture and the target triple contained within. More...
virtual lldb::ProcessSP ConnectProcessSynchronous (llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Stream &stream, Target *target, Status &error)
virtual lldb::BreakpointSP SetThreadCreationBreakpoint (Target &target)
virtual lldb_private::ConstString GetSDKDirectory (lldb_private::Target &target)
const std::stringGetRemoteURL () const
bool IsHost () const
bool IsRemote () const
const ArchSpecGetSystemArchitecture ()
void SetSystemArchitecture (const ArchSpec &arch)
ArchSpec GetAugmentedArchSpec (llvm::StringRef triple)
 If the triple contains not specify the vendor, os, and environment parts, we "augment" these using information from the platform and return the resulting ArchSpec object. More...
size_t GetMaxUserIDNameLength () const
size_t GetMaxGroupIDNameLength () const
ConstString GetSDKRootDirectory () const
void SetSDKRootDirectory (ConstString dir)
ConstString GetSDKBuild () const
void SetSDKBuild (ConstString sdk_build)
virtual bool SupportsModules ()
virtual void AddClangModuleCompilationOptions (Target *target, std::vector< std::string > &options)
FileSpec GetWorkingDirectory ()
bool SetWorkingDirectory (const FileSpec &working_dir)
virtual bool ModuleIsExcludedForUnconstrainedSearches (Target &target, const lldb::ModuleSP &module_sp)
virtual void AutoCompleteDiskFileOrDirectory (CompletionRequest &request, bool only_dir)
virtual Status Install (const FileSpec &src, const FileSpec &dst)
 Install a file or directory to the remote system. More...
virtual bool GetSupportsRSync ()
virtual void SetSupportsRSync (bool flag)
virtual const char * GetRSyncOpts ()
virtual void SetRSyncOpts (const char *opts)
virtual const char * GetRSyncPrefix ()
virtual void SetRSyncPrefix (const char *prefix)
virtual bool GetSupportsSSH ()
virtual void SetSupportsSSH (bool flag)
virtual const char * GetSSHOpts ()
virtual void SetSSHOpts (const char *opts)
virtual bool GetIgnoresRemoteHostname ()
virtual void SetIgnoresRemoteHostname (bool flag)
virtual void SetLocalCacheDirectory (const char *local)
virtual const char * GetLocalCacheDirectory ()
lldb::UnixSignalsSP GetUnixSignals ()
virtual std::string GetQueueNameForThreadQAddress (Process *process, lldb::addr_t dispatch_qaddr)
 Locate a queue name given a thread's qaddr. More...
virtual lldb::queue_id_t GetQueueIDForThreadQAddress (Process *process, lldb::addr_t dispatch_qaddr)
 Locate a queue ID given a thread's qaddr. More...
virtual const std::vector< ConstString > & GetTrapHandlerSymbolNames ()
 Provide a list of trap handler function names for this platform. More...
virtual FileSpec LocateExecutable (const char *basename)
 Find a support executable that may not live within in the standard locations related to LLDB. More...
virtual uint32_t GetDefaultMemoryCacheLineSize ()
 Allow the platform to set preferred memory cache line size. More...
uint32_t LoadImage (lldb_private::Process *process, const lldb_private::FileSpec &local_file, const lldb_private::FileSpec &remote_file, lldb_private::Status &error)
 Load a shared library into this process. More...
uint32_t LoadImageUsingPaths (lldb_private::Process *process, const lldb_private::FileSpec &library_name, const std::vector< std::string > &paths, lldb_private::Status &error, lldb_private::FileSpec *loaded_path)
 Load a shared library specified by base name into this process, looking by hand along a set of paths. More...
virtual llvm::Expected< StructuredData::DictionarySPFetchExtendedCrashInformation (lldb_private::Process &process)
 Gather all of crash informations into a structured data dictionary. More...
virtual bool LoadPlatformBinaryAndSetup (Process *process, lldb::addr_t addr, bool notify)
 Detect a binary in memory that will determine which Platform and DynamicLoader should be used in this target/process, and update the Platform/DynamicLoader. More...
virtual Args GetExtraStartupCommands ()
- Public Member Functions inherited from lldb_private::PluginInterface
 PluginInterface ()=default
virtual ~PluginInterface ()=default
 PluginInterface (const PluginInterface &)=delete
PluginInterfaceoperator= (const PluginInterface &)=delete

Static Public Member Functions

static void Initialize ()
static void Terminate ()
static lldb::PlatformSP CreateInstance (bool force, const ArchSpec *arch)
static llvm::StringRef GetPluginNameStatic (bool is_host)
static llvm::StringRef GetPluginDescriptionStatic (bool is_host)
- Static Public Member Functions inherited from lldb_private::Platform
static void Initialize ()
static void Terminate ()
static PlatformPropertiesGetGlobalPlatformProperties ()
static lldb::PlatformSP GetHostPlatform ()
 Get the native host platform plug-in. More...
static const char * GetHostPlatformName ()
static void SetHostPlatform (const lldb::PlatformSP &platform_sp)
static lldb::PlatformSP Create (llvm::StringRef name)
static ArchSpec GetAugmentedArchSpec (Platform *platform, llvm::StringRef triple)
 Augments the triple either with information from platform or the host system (if platform is null). More...

Public Attributes

std::vector< ArchSpecm_supported_architectures

Private Attributes

std::mutex m_mutex
std::shared_ptr< TypeSystemClangm_type_system

Additional Inherited Members

- Protected Types inherited from lldb_private::Platform
typedef std::map< uint32_t, ConstStringIDToNameMap
- Protected Member Functions inherited from PlatformPOSIX
lldb_private::Status EvaluateLibdlExpression (lldb_private::Process *process, const char *expr_cstr, llvm::StringRef expr_prefix, lldb::ValueObjectSP &result_valobj_sp)
std::unique_ptr< lldb_private::UtilityFunctionMakeLoadImageUtilityFunction (lldb_private::ExecutionContext &exe_ctx, lldb_private::Status &error)
virtual llvm::StringRef GetLibdlFunctionDeclarations (lldb_private::Process *process)
- Protected Member Functions inherited from lldb_private::Platform
lldb::ProcessSP DoConnectProcess (llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Stream *stream, Target *target, Status &error)
 Private implementation of connecting to a process. More...
Status GetCachedExecutable (ModuleSpec &module_spec, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr)
virtual Status DownloadModuleSlice (const FileSpec &src_file_spec, const uint64_t src_offset, const uint64_t src_size, const FileSpec &dst_file_spec)
virtual Status DownloadSymbolFile (const lldb::ModuleSP &module_sp, const FileSpec &dst_file_spec)
virtual const char * GetCacheHostname ()
virtual Status ResolveRemoteExecutable (const ModuleSpec &module_spec, lldb::ModuleSP &exe_module_sp, const FileSpecList *module_search_paths_ptr)
- Static Protected Member Functions inherited from lldb_private::Platform
static std::vector< ArchSpecCreateArchList (llvm::ArrayRef< llvm::Triple::ArchType > archs, llvm::Triple::OSType os)
 Create a list of ArchSpecs with the given OS and a architectures. More...
- Protected Attributes inherited from PlatformPOSIX
std::unique_ptr< lldb_private::OptionGroupPlatformRSyncm_option_group_platform_rsync
std::unique_ptr< lldb_private::OptionGroupPlatformSSHm_option_group_platform_ssh
std::unique_ptr< lldb_private::OptionGroupPlatformCachingm_option_group_platform_caching
std::map< lldb_private::CommandInterpreter *, std::unique_ptr< lldb_private::OptionGroupOptions > > m_options
- Protected Attributes inherited from lldb_private::RemoteAwarePlatform
lldb::PlatformSP m_remote_platform_sp
- Protected Attributes inherited from lldb_private::Platform
bool m_is_host
bool m_os_version_set_while_connected
bool m_system_arch_set_while_connected
ConstString m_sdk_sysroot
ConstString m_sdk_build
FileSpec m_working_dir
std::string m_remote_url
std::string m_hostname
llvm::VersionTuple m_os_version
ArchSpec m_system_arch
std::mutex m_mutex
size_t m_max_uid_name_len
size_t m_max_gid_name_len
bool m_supports_rsync
std::string m_rsync_opts
std::string m_rsync_prefix
bool m_supports_ssh
std::string m_ssh_opts
bool m_ignores_remote_hostname
std::string m_local_cache_directory
std::vector< ConstStringm_trap_handlers
bool m_calculated_trap_handlers
const std::unique_ptr< ModuleCachem_module_cache

Detailed Description

Definition at line 18 of file PlatformLinux.h.

Constructor & Destructor Documentation

◆ PlatformLinux()

PlatformLinux::PlatformLinux ( bool  is_host)

Member Function Documentation

◆ CalculateTrapHandlerSymbolNames()

void PlatformLinux::CalculateTrapHandlerSymbolNames ( )

Ask the Platform subclass to fill in the list of trap handler names.

For most Unix user process environments, this will be a single function name, _sigtramp. More specialized environments may have additional handler names. The unwinder code needs to know when a trap handler is on the stack because the unwind rules for the frame that caused the trap are different.

The base class Platform ivar m_trap_handlers should be updated by the Platform subclass when this method is called. If there are no predefined trap handlers, this method may be a no-op.

Implements lldb_private::Platform.

Definition at line 202 of file PlatformLinux.cpp.

References lldb_private::Platform::m_trap_handlers.

◆ CanDebugProcess()

bool PlatformLinux::CanDebugProcess ( )

Not all platforms will support debugging a process by spawning somehow halted for a debugger (specified using the "eLaunchFlagDebug" launch flag) and then attaching.

If your platform doesn't support this, override this function and return false.

Reimplemented from lldb_private::Platform.

Definition at line 193 of file PlatformLinux.cpp.

References lldb_private::RemoteAwarePlatform::IsConnected(), and lldb_private::Platform::IsHost().

◆ CreateInstance()

PlatformSP PlatformLinux::CreateInstance ( bool  force,
const ArchSpec arch 

Definition at line 45 of file PlatformLinux.cpp.

References lldb_private::GetLog(), and LLDB_LOG.

◆ GetDescription()

llvm::StringRef lldb_private::platform_linux::PlatformLinux::GetDescription ( )

◆ GetMmapArgumentList()

MmapArgList PlatformLinux::GetMmapArgumentList ( const ArchSpec arch,
lldb::addr_t  addr,
lldb::addr_t  length,
unsigned  prot,
unsigned  flags,
lldb::addr_t  fd,
lldb::addr_t  offset 

◆ GetPluginDescriptionStatic()

llvm::StringRef PlatformLinux::GetPluginDescriptionStatic ( bool  is_host)

Definition at line 78 of file PlatformLinux.cpp.

Referenced by GetDescription().

◆ GetPluginName()

llvm::StringRef lldb_private::platform_linux::PlatformLinux::GetPluginName ( )

◆ GetPluginNameStatic()

static llvm::StringRef lldb_private::platform_linux::PlatformLinux::GetPluginNameStatic ( bool  is_host)

Definition at line 29 of file PlatformLinux.h.

References lldb_private::Platform::GetHostPlatformName().

Referenced by GetPluginName().

◆ GetResumeCountForLaunchInfo()

uint32_t PlatformLinux::GetResumeCountForLaunchInfo ( ProcessLaunchInfo launch_info)

◆ GetSiginfoType()

CompilerType PlatformLinux::GetSiginfoType ( const llvm::Triple &  triple)

◆ GetStatus()

void PlatformLinux::GetStatus ( Stream strm)

Report the current status for this platform.

The returned string usually involves returning the OS version (if available), and any SDK directory that might be being used for local file caching, and if connected a quick blurb about what this platform is connected to.

Reimplemented from lldb_private::Platform.

Definition at line 138 of file PlatformLinux.cpp.

References lldb_private::Platform::GetStatus(), lldb_private::Platform::IsHost(), and lldb_private::Stream::Printf().

◆ GetSupportedArchitectures()

std::vector< ArchSpec > PlatformLinux::GetSupportedArchitectures ( const ArchSpec process_host_arch)

Get the platform's supported architectures in the order in which they should be searched.

[in]process_host_archThe process host architecture if it's known. An invalid ArchSpec represents that the process host architecture is unknown.

Implements lldb_private::Platform.

Definition at line 132 of file PlatformLinux.cpp.

References lldb_private::RemoteAwarePlatform::m_remote_platform_sp, and m_supported_architectures.

◆ GetTrapHandlerUnwindPlan()

lldb::UnwindPlanSP PlatformLinux::GetTrapHandlerUnwindPlan ( const llvm::Triple &  triple,
ConstString  name 

Try to get a specific unwind plan for a named trap handler.

The default is not to have specific unwind plans for trap handlers.

[in]tripleTriple of the current target.
[in]nameName of the trap handler function.
A specific unwind plan for that trap handler, or an empty shared pointer. The latter means there is no specific plan, unwind as normal.

Reimplemented from lldb_private::Platform.

Definition at line 290 of file PlatformLinux.cpp.

References GetAArch64TrapHanlderUnwindPlan().

◆ Initialize()

void PlatformLinux::Initialize ( )

Definition at line 84 of file PlatformLinux.cpp.

References g_initialize_count, and lldb_private::Platform::Initialize().

◆ Terminate()

void PlatformLinux::Terminate ( )

Definition at line 100 of file PlatformLinux.cpp.

References g_initialize_count, and lldb_private::Platform::Terminate().

Member Data Documentation

◆ m_mutex

std::mutex lldb_private::platform_linux::PlatformLinux::m_mutex

Definition at line 68 of file PlatformLinux.h.

Referenced by GetSiginfoType().

◆ m_supported_architectures

std::vector<ArchSpec> lldb_private::platform_linux::PlatformLinux::m_supported_architectures

Definition at line 65 of file PlatformLinux.h.

Referenced by GetSupportedArchitectures(), and PlatformLinux().

◆ m_type_system

std::shared_ptr<TypeSystemClang> lldb_private::platform_linux::PlatformLinux::m_type_system

Definition at line 69 of file PlatformLinux.h.

Referenced by GetSiginfoType().

The documentation for this class was generated from the following files: