LLDB  mainline
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
lldb::SBProcess Class Reference

#include <SBProcess.h>

Collaboration diagram for lldb::SBProcess:
Collaboration graph
[legend]

Public Member Functions

 FLAGS_ANONYMOUS_ENUM ()
 Broadcaster event bits definitions. More...
 
 SBProcess ()
 
 SBProcess (const lldb::SBProcess &rhs)
 
const lldb::SBProcessoperator= (const lldb::SBProcess &rhs)
 
 SBProcess (const lldb::ProcessSP &process_sp)
 
 ~SBProcess ()
 
const char * GetPluginName ()
 
const char * GetShortPluginName ()
 
void Clear ()
 
 operator bool () const
 
bool IsValid () const
 
lldb::SBTarget GetTarget () const
 
lldb::ByteOrder GetByteOrder () const
 
size_t PutSTDIN (const char *src, size_t src_len)
 
size_t GetSTDOUT (char *dst, size_t dst_len) const
 
size_t GetSTDERR (char *dst, size_t dst_len) const
 
size_t GetAsyncProfileData (char *dst, size_t dst_len) const
 
void ReportEventState (const lldb::SBEvent &event, FILE *out) const
 
void ReportEventState (const lldb::SBEvent &event, SBFile file) const
 
void ReportEventState (const lldb::SBEvent &event, FileSP file) const
 
void AppendEventStateReport (const lldb::SBEvent &event, lldb::SBCommandReturnObject &result)
 
bool RemoteAttachToProcessWithID (lldb::pid_t pid, lldb::SBError &error)
 Remote connection related functions. More...
 
bool RemoteLaunch (char const **argv, char const **envp, const char *stdin_path, const char *stdout_path, const char *stderr_path, const char *working_directory, uint32_t launch_flags, bool stop_at_entry, lldb::SBError &error)
 
uint32_t GetNumThreads ()
 
lldb::SBThread GetThreadAtIndex (size_t index)
 
lldb::SBThread GetThreadByID (lldb::tid_t sb_thread_id)
 
lldb::SBThread GetThreadByIndexID (uint32_t index_id)
 
lldb::SBThread GetSelectedThread () const
 
lldb::SBThread CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
 
bool SetSelectedThread (const lldb::SBThread &thread)
 
bool SetSelectedThreadByID (lldb::tid_t tid)
 
bool SetSelectedThreadByIndexID (uint32_t index_id)
 
uint32_t GetNumQueues ()
 
lldb::SBQueue GetQueueAtIndex (size_t index)
 
lldb::StateType GetState ()
 
int GetExitStatus ()
 
const char * GetExitDescription ()
 
lldb::pid_t GetProcessID ()
 Gets the process ID. More...
 
uint32_t GetUniqueID ()
 Gets the unique ID associated with this process object. More...
 
uint32_t GetAddressByteSize () const
 
lldb::SBError Destroy ()
 
lldb::SBError Continue ()
 
lldb::SBError Stop ()
 
lldb::SBError Kill ()
 
lldb::SBError Detach ()
 
lldb::SBError Detach (bool keep_stopped)
 
lldb::SBError Signal (int signal)
 
lldb::SBUnixSignals GetUnixSignals ()
 
void SendAsyncInterrupt ()
 
uint32_t GetStopID (bool include_expression_stops=false)
 
lldb::SBEvent GetStopEventForStopID (uint32_t stop_id)
 Gets the stop event corresponding to stop ID. More...
 
size_t ReadMemory (addr_t addr, void *buf, size_t size, lldb::SBError &error)
 
size_t WriteMemory (addr_t addr, const void *buf, size_t size, lldb::SBError &error)
 
size_t ReadCStringFromMemory (addr_t addr, void *buf, size_t size, lldb::SBError &error)
 
uint64_t ReadUnsignedFromMemory (addr_t addr, uint32_t byte_size, lldb::SBError &error)
 
lldb::addr_t ReadPointerFromMemory (addr_t addr, lldb::SBError &error)
 
lldb::SBBroadcaster GetBroadcaster () const
 
bool GetDescription (lldb::SBStream &description)
 
SBStructuredData GetExtendedCrashInformation ()
 
uint32_t GetNumSupportedHardwareWatchpoints (lldb::SBError &error) const
 
uint32_t LoadImage (lldb::SBFileSpec &remote_image_spec, lldb::SBError &error)
 Load a shared library into this process. More...
 
uint32_t LoadImage (const lldb::SBFileSpec &local_image_spec, const lldb::SBFileSpec &remote_image_spec, lldb::SBError &error)
 Load a shared library into this process. More...
 
uint32_t LoadImageUsingPaths (const lldb::SBFileSpec &image_spec, SBStringList &paths, lldb::SBFileSpec &loaded_path, lldb::SBError &error)
 Load a shared library into this process, starting with a library name and a list of paths, searching along the list of paths till you find a matching library. More...
 
lldb::SBError UnloadImage (uint32_t image_token)
 
lldb::SBError SendEventData (const char *data)
 
uint32_t GetNumExtendedBacktraceTypes ()
 Return the number of different thread-origin extended backtraces this process can support. More...
 
const char * GetExtendedBacktraceTypeAtIndex (uint32_t idx)
 Return the name of one of the thread-origin extended backtrace methods. More...
 
lldb::SBThreadCollection GetHistoryThreads (addr_t addr)
 
bool IsInstrumentationRuntimePresent (InstrumentationRuntimeType type)
 
lldb::SBError SaveCore (const char *file_name)
 Save the state of the process in a core file (or mini dump on Windows). More...
 
lldb::SBError GetMemoryRegionInfo (lldb::addr_t load_addr, lldb::SBMemoryRegionInfo &region_info)
 Query the address load_addr and store the details of the memory region that contains it in the supplied SBMemoryRegionInfo object. More...
 
lldb::SBMemoryRegionInfoList GetMemoryRegions ()
 Return the list of memory regions within the process. More...
 
lldb::SBProcessInfo GetProcessInfo ()
 Return information about the process. More...
 
lldb::addr_t AllocateMemory (size_t size, uint32_t permissions, lldb::SBError &error)
 Allocate memory within the process. More...
 
lldb::SBError DeallocateMemory (lldb::addr_t ptr)
 Deallocate memory in the process. More...
 

Static Public Member Functions

static const char * GetBroadcasterClassName ()
 
static lldb::StateType GetStateFromEvent (const lldb::SBEvent &event)
 
static bool GetRestartedFromEvent (const lldb::SBEvent &event)
 
static size_t GetNumRestartedReasonsFromEvent (const lldb::SBEvent &event)
 
static const char * GetRestartedReasonAtIndexFromEvent (const lldb::SBEvent &event, size_t idx)
 
static lldb::SBProcess GetProcessFromEvent (const lldb::SBEvent &event)
 
static bool GetInterruptedFromEvent (const lldb::SBEvent &event)
 
static lldb::SBStructuredData GetStructuredDataFromEvent (const lldb::SBEvent &event)
 
static bool EventIsProcessEvent (const lldb::SBEvent &event)
 
static bool EventIsStructuredDataEvent (const lldb::SBEvent &event)
 
static const char * GetBroadcasterClass ()
 

Protected Member Functions

lldb::ProcessSP GetSP () const
 
void SetSP (const lldb::ProcessSP &process_sp)
 

Protected Attributes

lldb::ProcessWP m_opaque_wp
 

Friends

class SBAddress
 
class SBBreakpoint
 
class SBBreakpointLocation
 
class SBCommandInterpreter
 
class SBDebugger
 
class SBExecutionContext
 
class SBFunction
 
class SBModule
 
class SBTarget
 
class SBThread
 
class SBValue
 
class lldb_private::QueueImpl
 

Detailed Description

Definition at line 23 of file SBProcess.h.

Constructor & Destructor Documentation

◆ SBProcess() [1/3]

SBProcess::SBProcess ( )

Definition at line 52 of file SBProcess.cpp.

References LLDB_RECORD_CONSTRUCTOR_NO_ARGS.

Referenced by GetProcessFromEvent().

◆ SBProcess() [2/3]

SBProcess::SBProcess ( const lldb::SBProcess rhs)

Definition at line 58 of file SBProcess.cpp.

References LLDB_RECORD_CONSTRUCTOR.

◆ SBProcess() [3/3]

SBProcess::SBProcess ( const lldb::ProcessSP &  process_sp)

Definition at line 62 of file SBProcess.cpp.

References LLDB_RECORD_CONSTRUCTOR.

◆ ~SBProcess()

SBProcess::~SBProcess ( )
default

Member Function Documentation

◆ AllocateMemory()

lldb::addr_t SBProcess::AllocateMemory ( size_t  size,
uint32_t  permissions,
lldb::SBError error 
)

Allocate memory within the process.

This function will allocate memory in the process's address space.

Parameters
[in]sizeThe size of the allocation requested.
[in]permissionsOr 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 from lldb, just not by the process itself.
[out]errorAn error object that gets filled in with any errors that might occur when trying allocate.
Returns
The address of the allocated buffer in the process, or LLDB_INVALID_ADDRESS if the allocation failed.

Definition at line 1291 of file SBProcess.cpp.

References GetSP(), LLDB_INVALID_ADDRESS, LLDB_RECORD_METHOD, lldb::SBError::ref(), lldb::SBError::SetErrorString(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ AppendEventStateReport()

void SBProcess::AppendEventStateReport ( const lldb::SBEvent event,
lldb::SBCommandReturnObject result 
)

◆ Clear()

void SBProcess::Clear ( )

Definition at line 110 of file SBProcess.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_wp.

◆ Continue()

SBError SBProcess::Continue ( )

◆ CreateOSPluginThread()

SBThread SBProcess::CreateOSPluginThread ( lldb::tid_t  tid,
lldb::addr_t  context 
)

◆ DeallocateMemory()

lldb::SBError SBProcess::DeallocateMemory ( lldb::addr_t  ptr)

Deallocate memory in the process.

This function will deallocate memory in the process's address space that was allocated with AllocateMemory.

Parameters
[in]ptrA return value from AllocateMemory, pointing to the memory you want to deallocate.
Returns
An error object describes any errors that occurred while deallocating.

Definition at line 1314 of file SBProcess.cpp.

References error(), GetSP(), LLDB_RECORD_METHOD, lldb::SBError::SetError(), lldb::SBError::SetErrorString(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ Destroy()

SBError SBProcess::Destroy ( )

◆ Detach() [1/2]

SBError SBProcess::Detach ( )

Definition at line 648 of file SBProcess.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and LLDB_RECORD_RESULT.

Referenced by Detach().

◆ Detach() [2/2]

SBError SBProcess::Detach ( bool  keep_stopped)

◆ EventIsProcessEvent()

bool SBProcess::EventIsProcessEvent ( const lldb::SBEvent event)
static

◆ EventIsStructuredDataEvent()

bool SBProcess::EventIsStructuredDataEvent ( const lldb::SBEvent event)
static

Definition at line 816 of file SBProcess.cpp.

References lldb_private::EventData::GetFlavor(), and LLDB_RECORD_STATIC_METHOD.

Referenced by EventIsProcessEvent().

◆ FLAGS_ANONYMOUS_ENUM()

lldb::SBProcess::FLAGS_ANONYMOUS_ENUM ( )
inline

Broadcaster event bits definitions.

Definition at line 26 of file SBProcess.h.

◆ GetAddressByteSize()

uint32_t SBProcess::GetAddressByteSize ( ) const

Definition at line 571 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD_CONST_NO_ARGS.

◆ GetAsyncProfileData()

size_t SBProcess::GetAsyncProfileData ( char *  dst,
size_t  dst_len 
) const

Definition at line 300 of file SBProcess.cpp.

References error(), GetSP(), and LLDB_RECORD_CHAR_PTR_METHOD_CONST.

◆ GetBroadcaster()

SBBroadcaster SBProcess::GetBroadcaster ( ) const

Definition at line 826 of file SBProcess.cpp.

References GetSP(), LLDB_RECORD_METHOD_CONST_NO_ARGS, and LLDB_RECORD_RESULT.

◆ GetBroadcasterClass()

const char * SBProcess::GetBroadcasterClass ( )
static

Definition at line 839 of file SBProcess.cpp.

References LLDB_RECORD_STATIC_METHOD_NO_ARGS.

Referenced by EventIsProcessEvent().

◆ GetBroadcasterClassName()

const char * SBProcess::GetBroadcasterClassName ( )
static

Definition at line 79 of file SBProcess.cpp.

References LLDB_RECORD_STATIC_METHOD_NO_ARGS.

◆ GetByteOrder()

ByteOrder SBProcess::GetByteOrder ( ) const

Definition at line 559 of file SBProcess.cpp.

References lldb::eByteOrderInvalid, GetSP(), and LLDB_RECORD_METHOD_CONST_NO_ARGS.

◆ GetDescription()

bool SBProcess::GetDescription ( lldb::SBStream description)

◆ GetExitDescription()

const char * SBProcess::GetExitDescription ( )

Definition at line 525 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

◆ GetExitStatus()

int SBProcess::GetExitStatus ( )

Definition at line 511 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

◆ GetExtendedBacktraceTypeAtIndex()

const char * SBProcess::GetExtendedBacktraceTypeAtIndex ( uint32_t  idx)

Return the name of one of the thread-origin extended backtrace methods.

Parameters
[in]idxThe index of the name to return. They will be returned in the order that the user will most likely want to see them. e.g. if the type at index 0 is not available for a thread, see if the type at index 1 provides an extended backtrace.
Returns
The name at that index.

Definition at line 1161 of file SBProcess.cpp.

References lldb_private::SystemRuntime::GetExtendedBacktraceTypes(), GetSP(), and LLDB_RECORD_METHOD.

◆ GetExtendedCrashInformation()

SBStructuredData SBProcess::GetExtendedCrashInformation ( )

◆ GetHistoryThreads()

SBThreadCollection SBProcess::GetHistoryThreads ( addr_t  addr)

◆ GetInterruptedFromEvent()

bool SBProcess::GetInterruptedFromEvent ( const lldb::SBEvent event)
static

Definition at line 792 of file SBProcess.cpp.

References lldb::SBEvent::get(), and LLDB_RECORD_STATIC_METHOD.

◆ GetMemoryRegionInfo()

lldb::SBError SBProcess::GetMemoryRegionInfo ( lldb::addr_t  load_addr,
lldb::SBMemoryRegionInfo region_info 
)

Query the address load_addr and store the details of the memory region that contains it in the supplied SBMemoryRegionInfo object.

To iterate over all memory regions use GetMemoryRegionList.

Parameters
[in]load_addrThe address to be queried.
[out]region_infoA reference to an SBMemoryRegionInfo object that will contain the details of the memory region containing load_addr.
Returns
An error object describes any errors that occurred while querying load_addr.

Definition at line 1236 of file SBProcess.cpp.

References GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, lldb::SBError::ref(), lldb::SBMemoryRegionInfo::ref(), lldb::SBError::SetErrorString(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetMemoryRegions()

lldb::SBMemoryRegionInfoList SBProcess::GetMemoryRegions ( )

Return the list of memory regions within the process.

Returns
A list of all witin the process memory regions.

Definition at line 1261 of file SBProcess.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, lldb::SBMemoryRegionInfoList::ref(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetNumExtendedBacktraceTypes()

uint32_t SBProcess::GetNumExtendedBacktraceTypes ( )

Return the number of different thread-origin extended backtraces this process can support.

When the process is stopped and you have an SBThread, lldb may be able to show a backtrace of when that thread was originally created, or the work item was enqueued to it (in the case of a libdispatch queue).

Returns
The number of thread-origin extended backtrace types that may be available.

Definition at line 1150 of file SBProcess.cpp.

References lldb_private::SystemRuntime::GetExtendedBacktraceTypes(), GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

◆ GetNumQueues()

uint32_t SBProcess::GetNumQueues ( )

◆ GetNumRestartedReasonsFromEvent()

size_t SBProcess::GetNumRestartedReasonsFromEvent ( const lldb::SBEvent event)
static

Definition at line 761 of file SBProcess.cpp.

References lldb::SBEvent::get(), and LLDB_RECORD_STATIC_METHOD.

◆ GetNumSupportedHardwareWatchpoints()

uint32_t SBProcess::GetNumSupportedHardwareWatchpoints ( lldb::SBError error) const

◆ GetNumThreads()

uint32_t SBProcess::GetNumThreads ( )

◆ GetPluginName()

const char * SBProcess::GetPluginName ( )

◆ GetProcessFromEvent()

SBProcess SBProcess::GetProcessFromEvent ( const lldb::SBEvent event)
static

◆ GetProcessID()

lldb::pid_t SBProcess::GetProcessID ( )

Gets the process ID.

Returns the process identifier for the process as it is known on the system on which the process is running. For unix systems this is typically the same as if you called "getpid()" in the process.

Returns
Returns LLDB_INVALID_PROCESS_ID if this object does not contain a valid process object, or if the process has not been launched. Returns a valid process ID if the process is valid.

Definition at line 538 of file SBProcess.cpp.

References GetSP(), LLDB_INVALID_PROCESS_ID, and LLDB_RECORD_METHOD_NO_ARGS.

◆ GetProcessInfo()

lldb::SBProcessInfo SBProcess::GetProcessInfo ( )

Return information about the process.

Valid process info will only be returned when the process is alive, use SBProcessInfo::IsValid() to check returned info is valid.

Definition at line 1279 of file SBProcess.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb::SBProcessInfo::SetProcessInfo().

◆ GetQueueAtIndex()

SBQueue SBProcess::GetQueueAtIndex ( size_t  index)

◆ GetRestartedFromEvent()

bool SBProcess::GetRestartedFromEvent ( const lldb::SBEvent event)
static

Definition at line 752 of file SBProcess.cpp.

References lldb::SBEvent::get(), and LLDB_RECORD_STATIC_METHOD.

◆ GetRestartedReasonAtIndexFromEvent()

const char * SBProcess::GetRestartedReasonAtIndexFromEvent ( const lldb::SBEvent event,
size_t  idx 
)
static

Definition at line 769 of file SBProcess.cpp.

References lldb::SBEvent::get(), and LLDB_RECORD_STATIC_METHOD.

◆ GetSelectedThread()

SBThread SBProcess::GetSelectedThread ( ) const

◆ GetShortPluginName()

const char * SBProcess::GetShortPluginName ( )

◆ GetSP()

lldb::ProcessSP SBProcess::GetSP ( ) const
protected

◆ GetState()

StateType SBProcess::GetState ( )

Definition at line 497 of file SBProcess.cpp.

References lldb::eStateInvalid, GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by GetDescription().

◆ GetStateFromEvent()

StateType SBProcess::GetStateFromEvent ( const lldb::SBEvent event)
static

◆ GetSTDERR()

size_t SBProcess::GetSTDERR ( char *  dst,
size_t  dst_len 
) const

Definition at line 286 of file SBProcess.cpp.

References error(), GetSP(), and LLDB_RECORD_CHAR_PTR_METHOD_CONST.

Referenced by lldb::SBDebugger::HandleProcessEvent().

◆ GetSTDOUT()

size_t SBProcess::GetSTDOUT ( char *  dst,
size_t  dst_len 
) const

Definition at line 272 of file SBProcess.cpp.

References error(), GetSP(), and LLDB_RECORD_CHAR_PTR_METHOD_CONST.

Referenced by lldb::SBDebugger::HandleProcessEvent().

◆ GetStopEventForStopID()

SBEvent SBProcess::GetStopEventForStopID ( uint32_t  stop_id)

Gets the stop event corresponding to stop ID.

Note that it wasn't fully implemented and tracks only the stop event for the last natural stop ID.

Parameters
[in]stop_idThe ID of the stop event to return.
Returns
The stop event corresponding to stop ID.

Definition at line 480 of file SBProcess.cpp.

References GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and lldb::SBEvent::reset().

◆ GetStopID()

uint32_t SBProcess::GetStopID ( bool  include_expression_stops = false)

Definition at line 464 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD.

◆ GetStructuredDataFromEvent()

lldb::SBStructuredData SBProcess::GetStructuredDataFromEvent ( const lldb::SBEvent event)
static

◆ GetTarget()

SBTarget SBProcess::GetTarget ( ) const

◆ GetThreadAtIndex()

SBThread SBProcess::GetThreadAtIndex ( size_t  index)

◆ GetThreadByID()

SBThread SBProcess::GetThreadByID ( lldb::tid_t  sb_thread_id)

◆ GetThreadByIndexID()

SBThread SBProcess::GetThreadByIndexID ( uint32_t  index_id)

◆ GetUniqueID()

uint32_t SBProcess::GetUniqueID ( )

Gets the unique ID associated with this process object.

Unique IDs start at 1 and increment up with each new process instance. Since starting a process on a system might always create a process with the same process ID, there needs to be a way to tell two process instances apart.

Returns
Returns a non-zero integer ID if this object contains a valid process object, zero if this object does not contain a valid process object.

Definition at line 549 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

◆ GetUnixSignals()

SBUnixSignals SBProcess::GetUnixSignals ( )

Definition at line 686 of file SBProcess.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, and LLDB_RECORD_RESULT.

◆ IsInstrumentationRuntimePresent()

bool SBProcess::IsInstrumentationRuntimePresent ( InstrumentationRuntimeType  type)

Definition at line 1189 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD.

◆ IsValid()

bool SBProcess::IsValid ( ) const

Definition at line 116 of file SBProcess.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS.

Referenced by lldb::SBDebugger::HandleProcessEvent().

◆ Kill()

SBError SBProcess::Kill ( )

◆ LoadImage() [1/2]

uint32_t SBProcess::LoadImage ( const lldb::SBFileSpec local_image_spec,
const lldb::SBFileSpec remote_image_spec,
lldb::SBError error 
)

Load a shared library into this process.

Parameters
[in]local_image_specThe file spec that points to the shared library that you want to load if the library is located on the host. The library will be copied over to the location specified by remote_image_spec or into the current working directory with the same filename if the remote_image_spec isn't specified.
[in]remote_image_specIf local_image_spec is specified then the location where the library should be copied over from the host. If local_image_spec isn't specified, then the path for the shared library on the target what you want to load.
[out]errorAn error object that gets filled in with any errors that might occur when trying to load the shared library.
Returns
A token that represents the shared library that can be later used to unload the shared library. A value of LLDB_INVALID_IMAGE_TOKEN will be returned if the shared library can't be opened.

Definition at line 1044 of file SBProcess.cpp.

References GetSP(), LLDB_INVALID_IMAGE_TOKEN, LLDB_RECORD_METHOD, LoadImage(), lldb::SBError::ref(), lldb::SBError::SetErrorString(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ LoadImage() [2/2]

uint32_t SBProcess::LoadImage ( lldb::SBFileSpec remote_image_spec,
lldb::SBError error 
)

Load a shared library into this process.

Parameters
[in]remote_image_specThe path for the shared library on the target what you want to load.
[out]errorAn error object that gets filled in with any errors that might occur when trying to load the shared library.
Returns
A token that represents the shared library that can be later used to unload the shared library. A value of LLDB_INVALID_IMAGE_TOKEN will be returned if the shared library can't be opened.

Definition at line 1035 of file SBProcess.cpp.

References LLDB_RECORD_METHOD, and lldb::SBFileSpec.

Referenced by LoadImage().

◆ LoadImageUsingPaths()

uint32_t SBProcess::LoadImageUsingPaths ( const lldb::SBFileSpec image_spec,
SBStringList paths,
lldb::SBFileSpec loaded_path,
lldb::SBError error 
)

Load a shared library into this process, starting with a library name and a list of paths, searching along the list of paths till you find a matching library.

Parameters
[in]image_specThe name of the shared library that you want to load. If image_spec is a relative path, the relative path will be appended to the search paths. If the image_spec is an absolute path, just the basename is used.
[in]pathsA list of paths to search for the library whose basename is local_spec.
[out]loaded_pathIf the library was found along the paths, this will store the full path to the found library.
[out]errorAn error object that gets filled in with any errors that might occur when trying to search for the shared library.
Returns
A token that represents the shared library that can be later passed to UnloadImage. A value of LLDB_INVALID_IMAGE_TOKEN will be returned if the shared library can't be opened.

Definition at line 1070 of file SBProcess.cpp.

References error(), lldb::SBStringList::GetSize(), GetSP(), lldb::SBStringList::GetStringAtIndex(), LLDB_INVALID_IMAGE_TOKEN, LLDB_RECORD_METHOD, and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ operator bool()

SBProcess::operator bool ( ) const
explicit

Definition at line 120 of file SBProcess.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS.

◆ operator=()

const SBProcess & SBProcess::operator= ( const lldb::SBProcess rhs)

Definition at line 67 of file SBProcess.cpp.

References LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and m_opaque_wp.

◆ PutSTDIN()

size_t SBProcess::PutSTDIN ( const char *  src,
size_t  src_len 
)

Definition at line 258 of file SBProcess.cpp.

References error(), GetSP(), and LLDB_RECORD_METHOD.

◆ ReadCStringFromMemory()

size_t SBProcess::ReadCStringFromMemory ( addr_t  addr,
void *  buf,
size_t  size,
lldb::SBError error 
)

◆ ReadMemory()

size_t SBProcess::ReadMemory ( addr_t  addr,
void *  buf,
size_t  size,
lldb::SBError error 
)

◆ ReadPointerFromMemory()

lldb::addr_t SBProcess::ReadPointerFromMemory ( addr_t  addr,
lldb::SBError error 
)

◆ ReadUnsignedFromMemory()

uint64_t SBProcess::ReadUnsignedFromMemory ( addr_t  addr,
uint32_t  byte_size,
lldb::SBError error 
)

◆ RemoteAttachToProcessWithID()

bool SBProcess::RemoteAttachToProcessWithID ( lldb::pid_t  pid,
lldb::SBError error 
)

Remote connection related functions.

These will fail if the process is not in eStateConnected. They are intended for use when connecting to an externally managed debugserver instance.

Definition at line 168 of file SBProcess.cpp.

References error(), lldb::eStateConnected, GetSP(), LLDB_RECORD_METHOD, and lldb_private::ProcessInfo::SetProcessID().

◆ RemoteLaunch()

bool SBProcess::RemoteLaunch ( char const **  argv,
char const **  envp,
const char *  stdin_path,
const char *  stdout_path,
const char *  stderr_path,
const char *  working_directory,
uint32_t  launch_flags,
bool  stop_at_entry,
lldb::SBError error 
)

◆ ReportEventState() [1/3]

void SBProcess::ReportEventState ( const lldb::SBEvent event,
FILE *  out 
) const

Definition at line 321 of file SBProcess.cpp.

References LLDB_RECORD_METHOD_CONST.

Referenced by lldb::SBDebugger::HandleProcessEvent(), and ReportEventState().

◆ ReportEventState() [2/3]

void SBProcess::ReportEventState ( const lldb::SBEvent event,
FileSP  file 
) const

◆ ReportEventState() [3/3]

void SBProcess::ReportEventState ( const lldb::SBEvent event,
SBFile  file 
) const

◆ SaveCore()

lldb::SBError SBProcess::SaveCore ( const char *  file_name)

Save the state of the process in a core file (or mini dump on Windows).

Definition at line 1210 of file SBProcess.cpp.

References error(), lldb::eSaveCoreFull, lldb::eStateStopped, GetSP(), LLDB_RECORD_METHOD, and LLDB_RECORD_RESULT.

◆ SendAsyncInterrupt()

void SBProcess::SendAsyncInterrupt ( )

Definition at line 695 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

◆ SendEventData()

lldb::SBError SBProcess::SendEventData ( const char *  data)

◆ SetSelectedThread()

bool SBProcess::SetSelectedThread ( const lldb::SBThread thread)

Definition at line 362 of file SBProcess.cpp.

References GetSP(), lldb::SBThread::GetThreadID(), and LLDB_RECORD_METHOD.

◆ SetSelectedThreadByID()

bool SBProcess::SetSelectedThreadByID ( lldb::tid_t  tid)

Definition at line 376 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD.

◆ SetSelectedThreadByIndexID()

bool SBProcess::SetSelectedThreadByIndexID ( uint32_t  index_id)

Definition at line 392 of file SBProcess.cpp.

References GetSP(), and LLDB_RECORD_METHOD.

◆ SetSP()

void SBProcess::SetSP ( const lldb::ProcessSP &  process_sp)
protected

◆ Signal()

SBError SBProcess::Signal ( int  signal)

◆ Stop()

SBError SBProcess::Stop ( )

◆ UnloadImage()

lldb::SBError SBProcess::UnloadImage ( uint32_t  image_token)

◆ WriteMemory()

size_t SBProcess::WriteMemory ( addr_t  addr,
const void *  buf,
size_t  size,
lldb::SBError error 
)

Friends And Related Function Documentation

◆ lldb_private::QueueImpl

friend class lldb_private::QueueImpl
friend

Definition at line 424 of file SBProcess.h.

◆ SBAddress

friend class SBAddress
friend

Definition at line 413 of file SBProcess.h.

◆ SBBreakpoint

friend class SBBreakpoint
friend

Definition at line 414 of file SBProcess.h.

◆ SBBreakpointLocation

friend class SBBreakpointLocation
friend

Definition at line 415 of file SBProcess.h.

◆ SBCommandInterpreter

friend class SBCommandInterpreter
friend

Definition at line 416 of file SBProcess.h.

◆ SBDebugger

friend class SBDebugger
friend

Definition at line 417 of file SBProcess.h.

◆ SBExecutionContext

friend class SBExecutionContext
friend

Definition at line 418 of file SBProcess.h.

◆ SBFunction

friend class SBFunction
friend

Definition at line 419 of file SBProcess.h.

◆ SBModule

friend class SBModule
friend

Definition at line 420 of file SBProcess.h.

◆ SBTarget

friend class SBTarget
friend

Definition at line 421 of file SBProcess.h.

◆ SBThread

friend class SBThread
friend

Definition at line 422 of file SBProcess.h.

◆ SBValue

friend class SBValue
friend

Definition at line 423 of file SBProcess.h.

Member Data Documentation

◆ m_opaque_wp

lldb::ProcessWP lldb::SBProcess::m_opaque_wp
protected

Definition at line 430 of file SBProcess.h.

Referenced by Clear(), GetSP(), operator=(), and SetSP().


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