#include <ScriptedProcess.h>

Inheritance diagram for lldb_private::ScriptedProcess:

[legend]

Public Member Functions
	~ScriptedProcess () override

bool	CanDebug (lldb::TargetSP target_sp, bool plugin_specified_by_name) override
	Check if a plug-in instance can debug the file in module.

DynamicLoader *	GetDynamicLoader () override
	Get the dynamic loader plug-in for this process.

llvm::StringRef	GetPluginName () override

Status	DoLoadCore () override

Status	DoLaunch (Module *exe_module, ProcessLaunchInfo &launch_info) override
	Launch a new process.

void	DidLaunch () override
	Called after launching a process.

void	DidResume () override
	Called after resuming a process.

Status	DoResume () override
	Resumes all of a process's threads as configured using the Thread run control functions.

Status	DoAttachToProcessWithID (lldb::pid_t pid, const ProcessAttachInfo &attach_info) override
	Attach to an existing process using a process ID.

Status	DoAttachToProcessWithName (const char *process_name, const ProcessAttachInfo &attach_info) override
	Attach to an existing process using a partial process name.

void	DidAttach (ArchSpec &process_arch) override
	Called after attaching a process.

Status	DoDestroy () override

void	RefreshStateAfterStop () override
	Currently called as part of ShouldStop.

bool	IsAlive () override
	Check if a process is still alive.

size_t	DoReadMemory (lldb::addr_t addr, void *buf, size_t size, Status &error) override
	Actually do the reading of memory from a process.

size_t	DoWriteMemory (lldb::addr_t vm_addr, const void *buf, size_t size, Status &error) override
	Actually do the writing of memory to a process.

Status	EnableBreakpointSite (BreakpointSite *bp_site) override

ArchSpec	GetArchitecture ()

Status	GetMemoryRegions (lldb_private::MemoryRegionInfos &region_list) override
	Obtain all the mapped memory regions within this process.

bool	GetProcessInfo (ProcessInstanceInfo &info) override

lldb_private::StructuredData::ObjectSP	GetLoadedDynamicLibrariesInfos () override

lldb_private::StructuredData::DictionarySP	GetMetadata () override
	Fetch process defined metadata.

void	UpdateQueueListIfNeeded () override

void *	GetImplementation () override

void	ForceScriptedState (lldb::StateType state) override

Public Member Functions inherited from lldb_private::Process
llvm::StringRef	GetBroadcasterClass () const override
	This needs to be filled in if you are going to register the broadcaster with the broadcaster manager and do broadcaster class matching.

	~Process () override
	Destructor.

lldb::ByteOrder	GetByteOrder () const

uint32_t	GetAddressByteSize () const

lldb::pid_t	GetID () const
	Returns the pid of the process or LLDB_INVALID_PROCESS_ID if there is no known pid.

void	SetID (lldb::pid_t new_pid)
	Sets the stored pid.

uint32_t	GetUniqueID () const

virtual bool	CanDebug (lldb::TargetSP target, bool plugin_specified_by_name)=0
	Check if a plug-in instance can debug the file in module.

virtual void	Finalize (bool destructing)
	This object is about to be destroyed, do any necessary cleanup.

bool	IsValid () const
	Return whether this object is valid (i.e.

virtual CommandObject *	GetPluginCommandObject ()
	Return a multi-word command object that can be used to expose plug-in specific commands.

virtual void	DumpPluginHistory (Stream &s)
	The underlying plugin might store the low-level communication history for this session.

virtual Status	Launch (ProcessLaunchInfo &launch_info)
	Launch a new process.

virtual Status	LoadCore ()

virtual Status	DoLoadCore ()

void	SetShadowListener (lldb::ListenerSP shadow_listener_sp)
	The "ShadowListener" for a process is just an ordinary Listener that listens for all the Process event bits.

UtilityFunction *	GetLoadImageUtilityFunction (Platform *platform, llvm::function_ref< std::unique_ptr< UtilityFunction >()> factory)
	Get the cached UtilityFunction that assists in loading binary images into the process.

virtual DynamicLoader *	GetDynamicLoader ()
	Get the dynamic loader plug-in for this process.

void	SetDynamicLoader (lldb::DynamicLoaderUP dyld)

virtual DataExtractor	GetAuxvData ()

virtual llvm::Error	LoadModules ()
	Sometimes processes know how to retrieve and load shared libraries.

virtual llvm::Expected< LoadedModuleInfoList >	GetLoadedModuleList ()
	Query remote GDBServer for a detailed loaded library list.

virtual llvm::Expected< bool >	SaveCore (llvm::StringRef outfile)
	Save core dump into the specified file.

Status	CalculateCoreFileSaveRanges (const SaveCoreOptions &core_options, CoreFileMemoryRanges &ranges)
	Helper function for Process::SaveCore(...) that calculates the address ranges that should be saved.

std::vector< lldb::ThreadSP >	CalculateCoreFileThreadList (const SaveCoreOptions &core_options)
	Helper function for Process::SaveCore(...) that calculates the thread list based upon options set within a given core_options object.

virtual ArchSpec	GetSystemArchitecture ()
	Get the system architecture for this process.

virtual SystemRuntime *	GetSystemRuntime ()
	Get the system runtime plug-in for this process.

virtual Status	Attach (ProcessAttachInfo &attach_info)
	Attach to an existing process using the process attach info.

virtual Status	ConnectRemote (llvm::StringRef remote_url)
	Attach to a remote system via a URL.

bool	GetShouldDetach () const

void	SetShouldDetach (bool b)

const std::vector< lldb::addr_t > &	GetImageTokens ()
	Get the image vector for the current process.

virtual lldb::addr_t	GetImageInfoAddress ()
	Get the image information address for the current process.

virtual void	WillPublicStop ()
	Called when the process is about to broadcast a public stop.

void	RegisterNotificationCallbacks (const Process::Notifications &callbacks)
	Register for process and thread notifications.

bool	UnregisterNotificationCallbacks (const Process::Notifications &callbacks)
	Unregister for process and thread notifications.

Status	Resume ()
	Resumes all of a process's threads as configured using the Thread run control functions.

Status	ResumeSynchronous (Stream *stream)
	Resume a process, and wait for it to stop.

Status	Halt (bool clear_thread_plans=false, bool use_run_lock=true)
	Halts a running process.

Status	Detach (bool keep_stopped)
	Detaches from a running or stopped process.

Status	Destroy (bool force_kill)
	Kills the process and shuts down all threads that were spawned to track and monitor the process.

Status	Signal (int signal)
	Sends a process a UNIX signal signal.

void	SetUnixSignals (lldb::UnixSignalsSP &&signals_sp)

const lldb::UnixSignalsSP &	GetUnixSignals ()

Status	WillAttachToProcessWithID (lldb::pid_t pid)
	Called before attaching to a process.

virtual Status	DoWillAttachToProcessWithID (lldb::pid_t pid)
	Called before attaching to a process.

Status	WillAttachToProcessWithName (const char *process_name, bool wait_for_launch)
	Called before attaching to a process.

virtual Status	DoWillAttachToProcessWithName (const char *process_name, bool wait_for_launch)
	Called before attaching to a process.

virtual Status	DoConnectRemote (llvm::StringRef remote_url)
	Attach to a remote system via a URL.

virtual Status	DoAttachToProcessWithID (lldb::pid_t pid, const ProcessAttachInfo &attach_info)
	Attach to an existing process using a process ID.

virtual Status	DoAttachToProcessWithName (const char *process_name, const ProcessAttachInfo &attach_info)
	Attach to an existing process using a partial process name.

virtual void	DidAttach (ArchSpec &process_arch)
	Called after attaching a process.

virtual void	DidExec ()
	Called after a process re-execs itself.

virtual void	DoDidExec ()
	Subclasses of Process should implement this function if they need to do anything after a process exec's itself.

virtual void	DidFork (lldb::pid_t child_pid, lldb::tid_t child_tid)
	Called after a reported fork.

virtual void	DidVFork (lldb::pid_t child_pid, lldb::tid_t child_tid)
	Called after a reported vfork.

virtual void	DidVForkDone ()
	Called after reported vfork completion.

Status	WillLaunch (Module *module)
	Called before launching to a process.

virtual Status	DoWillLaunch (Module *module)
	Called before launching to a process.

virtual Status	DoLaunch (Module *exe_module, ProcessLaunchInfo &launch_info)
	Launch a new process.

virtual void	DidLaunch ()
	Called after launching a process.

virtual Status	WillResume ()
	Called before resuming to a process.

virtual Status	DoResume ()
	Resumes all of a process's threads as configured using the Thread run control functions.

virtual void	DidResume ()
	Called after resuming a process.

virtual Status	WillHalt ()
	Called before halting to a process.

virtual Status	DoHalt (bool &caused_stop)
	Halts a running process.

virtual void	DidHalt ()
	Called after halting a process.

virtual Status	WillDetach ()
	Called before detaching from a process.

virtual Status	DoDetach (bool keep_stopped)
	Detaches from a running or stopped process.

virtual void	DidDetach ()
	Called after detaching from a process.

virtual bool	DetachRequiresHalt ()

virtual Status	WillSignal ()
	Called before sending a signal to a process.

virtual Status	DoSignal (int signal)
	Sends a process a UNIX signal signal.

virtual Status	WillDestroy ()

virtual Status	DoDestroy ()=0

virtual void	DidDestroy ()

virtual bool	DestroyRequiresHalt ()

virtual void	DidSignal ()
	Called after sending a signal to a process.

virtual void	RefreshStateAfterStop ()=0
	Currently called as part of ShouldStop.

virtual llvm::VersionTuple	GetHostOSVersion ()
	Sometimes the connection to a process can detect the host OS version that the process is running on.

virtual llvm::VersionTuple	GetHostMacCatalystVersion ()

Target &	GetTarget ()
	Get the target object pointer for this module.

const Target &	GetTarget () const
	Get the const target object pointer for this module.

void	Flush ()
	Flush all data in the process.

lldb::StateType	GetState ()
	Get accessor for the current process state.

lldb::ExpressionResults	RunThreadPlan (ExecutionContext &exe_ctx, lldb::ThreadPlanSP &thread_plan_sp, const EvaluateExpressionOptions &options, DiagnosticManager &diagnostic_manager)

void	GetStatus (Stream &ostrm)

size_t	GetThreadStatus (Stream &ostrm, bool only_threads_with_stop_reason, uint32_t start_frame, uint32_t num_frames, uint32_t num_frames_with_source, bool stop_format)

void	SendAsyncInterrupt (Thread *thread=nullptr)
	Send an async interrupt request.

virtual void	ModulesDidLoad (ModuleList &module_list)

virtual lldb_private::StructuredData::ObjectSP	GetLoadedDynamicLibrariesInfos (lldb::addr_t image_list_address, lldb::addr_t image_count)
	Retrieve the list of shared libraries that are loaded for this process This method is used on pre-macOS 10.12, pre-iOS 10, pre-tvOS 10, pre- watchOS 3 systems.

virtual lldb_private::StructuredData::ObjectSP	GetLoadedDynamicLibrariesInfos ()

virtual lldb_private::StructuredData::ObjectSP	GetLoadedDynamicLibrariesInfos (const std::vector< lldb::addr_t > &load_addresses)

virtual lldb_private::StructuredData::ObjectSP	GetSharedCacheInfo ()

virtual lldb_private::StructuredData::ObjectSP	GetDynamicLoaderProcessState ()

void	PrintWarningOptimization (const SymbolContext &sc)
	Print a user-visible warning about a module being built with optimization.

void	PrintWarningUnsupportedLanguage (const SymbolContext &sc)
	Print a user-visible warning about a function written in a language that this version of LLDB doesn't support.

virtual bool	GetProcessInfo (ProcessInstanceInfo &info)

virtual lldb_private::UUID	FindModuleUUID (const llvm::StringRef path)

int	GetExitStatus ()
	Get the exit status for a process.

const char *	GetExitDescription ()
	Get a textual description of what the process exited.

virtual void	DidExit ()

lldb::addr_t	GetCodeAddressMask ()
	Get the current address mask in the Process.

lldb::addr_t	GetDataAddressMask ()

lldb::addr_t	GetHighmemCodeAddressMask ()
	The highmem masks are for targets where we may have different masks for low memory versus high memory addresses, and they will be left as LLDB_INVALID_ADDRESS_MASK normally, meaning the base masks should be applied to all addresses.

lldb::addr_t	GetHighmemDataAddressMask ()

void	SetCodeAddressMask (lldb::addr_t code_address_mask)

void	SetDataAddressMask (lldb::addr_t data_address_mask)

void	SetHighmemCodeAddressMask (lldb::addr_t code_address_mask)

void	SetHighmemDataAddressMask (lldb::addr_t data_address_mask)

lldb::addr_t	FixCodeAddress (lldb::addr_t pc)
	Some targets might use bits in a code address to indicate a mode switch, ARM uses bit zero to signify a code address is thumb, so any ARM ABI plug-ins would strip those bits.

lldb::addr_t	FixDataAddress (lldb::addr_t pc)

lldb::addr_t	FixAnyAddress (lldb::addr_t pc)
	Use this method when you do not know, or do not care what kind of address you are fixing.

ProcessModID	GetModID () const
	Get the Modification ID of the process.

const ProcessModID &	GetModIDRef () const

uint32_t	GetStopID () const

uint32_t	GetResumeID () const

uint32_t	GetLastUserExpressionResumeID () const

uint32_t	GetLastNaturalStopID () const

lldb::EventSP	GetStopEventForStopID (uint32_t stop_id) const

virtual bool	SetExitStatus (int exit_status, llvm::StringRef exit_string)
	Set accessor for the process exit status (return code).

virtual bool	IsAlive ()
	Check if a process is still alive.

virtual bool	IsLiveDebugSession () const

virtual FileSpec	GetCoreFile () const
	Provide a way to retrieve the core dump file that is loaded for debugging.

virtual bool	WarnBeforeDetach () const
	Before lldb detaches from a process, it warns the user that they are about to lose their debug session.

virtual size_t	ReadMemory (lldb::addr_t vm_addr, void *buf, size_t size, Status &error)
	Read of memory from a process.

size_t	ReadMemoryFromInferior (lldb::addr_t vm_addr, void *buf, size_t size, Status &error)
	Read of memory from a process.

size_t	ReadCStringFromMemory (lldb::addr_t vm_addr, char *cstr, size_t cstr_max_len, Status &error)
	Read a NULL terminated C string from memory.

size_t	ReadCStringFromMemory (lldb::addr_t vm_addr, std::string &out_str, Status &error)

uint64_t	ReadUnsignedIntegerFromMemory (lldb::addr_t load_addr, size_t byte_size, uint64_t fail_value, Status &error)
	Reads an unsigned integer of the specified byte size from process memory.

int64_t	ReadSignedIntegerFromMemory (lldb::addr_t load_addr, size_t byte_size, int64_t fail_value, Status &error)

lldb::addr_t	ReadPointerFromMemory (lldb::addr_t vm_addr, Status &error)

bool	WritePointerToMemory (lldb::addr_t vm_addr, lldb::addr_t ptr_value, Status &error)

virtual size_t	DoWriteMemory (lldb::addr_t vm_addr, const void *buf, size_t size, Status &error)
	Actually do the writing of memory to a process.

size_t	WriteScalarToMemory (lldb::addr_t vm_addr, const Scalar &scalar, size_t size, Status &error)
	Write all or part of a scalar value to memory.

size_t	ReadScalarIntegerFromMemory (lldb::addr_t addr, uint32_t byte_size, bool is_signed, Scalar &scalar, Status &error)

size_t	WriteMemory (lldb::addr_t vm_addr, const void *buf, size_t size, Status &error)
	Write memory to a process.

virtual lldb::addr_t	DoAllocateMemory (size_t size, uint32_t permissions, Status &error)
	Actually allocate memory in the process.

virtual Status	WriteObjectFile (std::vector< ObjectFile::LoadableData > entries)

lldb::addr_t	AllocateMemory (size_t size, uint32_t permissions, Status &error)
	The public interface to allocating memory in the process.

lldb::addr_t	CallocateMemory (size_t size, uint32_t permissions, Status &error)
	The public interface to allocating memory in the process, this also clears the allocated memory.

llvm::Expected< const MemoryTagManager * >	GetMemoryTagManager ()
	If this architecture and process supports memory tagging, return a tag manager that can be used to maniupulate those memory tags.

virtual llvm::Expected< std::vector< lldb::addr_t > >	ReadMemoryTags (lldb::addr_t addr, size_t len)
	Read memory tags for the range addr to addr+len.

Status	WriteMemoryTags (lldb::addr_t addr, size_t len, const std::vector< lldb::addr_t > &tags)
	Write memory tags for a range of memory.

virtual lldb::addr_t	ResolveIndirectFunction (const Address *address, Status &error)
	Resolve dynamically loaded indirect functions.

Status	GetMemoryRegionInfo (lldb::addr_t load_addr, MemoryRegionInfo &range_info)
	Locate the memory region that contains load_addr.

virtual Status	GetMemoryRegions (lldb_private::MemoryRegionInfos &region_list)
	Obtain all the mapped memory regions within this process.

virtual std::optional< uint32_t >	GetWatchpointSlotCount ()
	Get the number of watchpoints supported by this target.

bool	GetWatchpointReportedAfter ()
	Whether lldb will be notified about watchpoints after the instruction has completed executing, or if the instruction is rolled back and it is notified before it executes.

lldb::ModuleSP	ReadModuleFromMemory (const FileSpec &file_spec, lldb::addr_t header_addr, size_t size_to_read=512)

virtual bool	GetLoadAddressPermissions (lldb::addr_t load_addr, uint32_t &permissions)
	Attempt to get the attributes for a region of memory in the process.

bool	CanJIT ()
	Determines whether executing JIT-compiled code in this process is possible.

void	SetCanJIT (bool can_jit)
	Sets whether executing JIT-compiled code in this process is possible.

bool	CanInterpretFunctionCalls ()
	Determines whether executing function calls using the interpreter is possible for this process.

void	SetCanInterpretFunctionCalls (bool can_interpret_function_calls)
	Sets whether executing function calls using the interpreter is possible for this process.

void	SetCanRunCode (bool can_run_code)
	Sets whether executing code in this process is possible.

virtual Status	DoDeallocateMemory (lldb::addr_t ptr)
	Actually deallocate memory in the process.

Status	DeallocateMemory (lldb::addr_t ptr)
	The public interface to deallocating memory in the process.

virtual size_t	GetSTDOUT (char *buf, size_t buf_size, Status &error)
	Get any available STDOUT.

virtual size_t	GetSTDERR (char *buf, size_t buf_size, Status &error)
	Get any available STDERR.

virtual size_t	PutSTDIN (const char *buf, size_t buf_size, Status &error)
	Puts data into this process's STDIN.

virtual size_t	GetAsyncProfileData (char *buf, size_t buf_size, Status &error)
	Get any available profile data.

size_t	GetSoftwareBreakpointTrapOpcode (BreakpointSite *bp_site)

virtual Status	EnableBreakpointSite (BreakpointSite *bp_site)

virtual Status	DisableBreakpointSite (BreakpointSite *bp_site)

virtual Status	EnableSoftwareBreakpoint (BreakpointSite *bp_site)

virtual Status	DisableSoftwareBreakpoint (BreakpointSite *bp_site)

StopPointSiteList< lldb_private::BreakpointSite > &	GetBreakpointSiteList ()

const StopPointSiteList< lldb_private::BreakpointSite > &	GetBreakpointSiteList () const

void	DisableAllBreakpointSites ()

Status	ClearBreakpointSiteByID (lldb::user_id_t break_id)

lldb::break_id_t	CreateBreakpointSite (const lldb::BreakpointLocationSP &owner, bool use_hardware)

Status	DisableBreakpointSiteByID (lldb::user_id_t break_id)

Status	EnableBreakpointSiteByID (lldb::user_id_t break_id)

void	RemoveConstituentFromBreakpointSite (lldb::user_id_t site_id, lldb::user_id_t constituent_id, lldb::BreakpointSiteSP &bp_site_sp)

virtual Status	EnableWatchpoint (lldb::WatchpointSP wp_sp, bool notify=true)

virtual Status	DisableWatchpoint (lldb::WatchpointSP wp_sp, bool notify=true)

bool	UpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list)
	Update the thread list.

void	UpdateThreadListIfNeeded ()

ThreadList &	GetThreadList ()

StopPointSiteList< lldb_private::WatchpointResource > &	GetWatchpointResourceList ()

ThreadList &	GetExtendedThreadList ()

ThreadList::ThreadIterable	Threads ()

uint32_t	GetNextThreadIndexID (uint64_t thread_id)

lldb::ThreadSP	CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)

bool	HasAssignedIndexIDToThread (uint64_t sb_thread_id)

uint32_t	AssignIndexIDToThread (uint64_t thread_id)

virtual void	UpdateQueueListIfNeeded ()

QueueList &	GetQueueList ()

QueueList::QueueIterable	Queues ()

lldb::StateType	GetNextEvent (lldb::EventSP &event_sp)

lldb::StateType	WaitForProcessToStop (const Timeout< std::micro > &timeout, lldb::EventSP event_sp_ptr=nullptr, bool wait_always=true, lldb::ListenerSP hijack_listener=lldb::ListenerSP(), Stream stream=nullptr, bool use_run_lock=true, SelectMostRelevant select_most_relevant=DoNoSelectMostRelevantFrame)

uint32_t	GetIOHandlerID () const

void	SyncIOHandler (uint32_t iohandler_id, const Timeout< std::micro > &timeout)
	Waits for the process state to be running within a given msec timeout.

lldb::StateType	GetStateChangedEvents (lldb::EventSP &event_sp, const Timeout< std::micro > &timeout, lldb::ListenerSP hijack_listener)

Event *	PeekAtStateChangedEvents ()

bool	HijackProcessEvents (lldb::ListenerSP listener_sp)
	If you need to ensure that you and only you will hear about some public event, then make a new listener, set to listen to process events, and then call this with that listener.

void	RestoreProcessEvents ()
	Restores the process event broadcasting to its normal state.

bool	StateChangedIsHijackedForSynchronousResume ()

bool	StateChangedIsExternallyHijacked ()

const lldb::ABISP &	GetABI ()

OperatingSystem *	GetOperatingSystem ()

std::vector< LanguageRuntime * >	GetLanguageRuntimes ()

LanguageRuntime *	GetLanguageRuntime (lldb::LanguageType language)

bool	IsPossibleDynamicValue (ValueObject &in_value)

bool	IsRunning () const

DynamicCheckerFunctions *	GetDynamicCheckers ()

void	SetDynamicCheckers (DynamicCheckerFunctions *dynamic_checkers)

bool	PruneThreadPlansForTID (lldb::tid_t tid)
	Prune ThreadPlanStacks for unreported threads.

void	PruneThreadPlans ()
	Prune ThreadPlanStacks for all unreported threads.

ThreadPlanStack *	FindThreadPlans (lldb::tid_t tid)
	Find the thread plan stack associated with thread with tid.

bool	DumpThreadPlansForTID (Stream &strm, lldb::tid_t tid, lldb::DescriptionLevel desc_level, bool internal, bool condense_trivial, bool skip_unreported_plans)
	Dump the thread plans associated with thread with tid.

void	DumpThreadPlans (Stream &strm, lldb::DescriptionLevel desc_level, bool internal, bool condense_trivial, bool skip_unreported_plans)
	Dump all the thread plans for this process.

virtual bool	StartNoticingNewThreads ()
	Call this to set the lldb in the mode where it breaks on new thread creations, and then auto-restarts.

virtual bool	StopNoticingNewThreads ()
	Call this to turn off the stop & notice new threads mode.

void	SetRunningUserExpression (bool on)

void	SetRunningUtilityFunction (bool on)

lldb::TargetSP	CalculateTarget () override

lldb::ProcessSP	CalculateProcess () override

lldb::ThreadSP	CalculateThread () override

lldb::StackFrameSP	CalculateStackFrame () override

void	CalculateExecutionContext (ExecutionContext &exe_ctx) override
	Reconstruct the object's execution context into sc.

void	SetSTDIOFileDescriptor (int file_descriptor)

void	AddInvalidMemoryRegion (const LoadRange &region)

bool	RemoveInvalidMemoryRange (const LoadRange &region)

void	AddPreResumeAction (PreResumeActionCallback callback, void *baton)

bool	RunPreResumeActions ()

void	ClearPreResumeActions ()

void	ClearPreResumeAction (PreResumeActionCallback callback, void *baton)

ProcessRunLock &	GetRunLock ()

bool	CurrentThreadIsPrivateStateThread ()

virtual Status	SendEventData (const char *data)

lldb::ThreadCollectionSP	GetHistoryThreads (lldb::addr_t addr)

lldb::InstrumentationRuntimeSP	GetInstrumentationRuntime (lldb::InstrumentationRuntimeType type)

virtual bool	GetModuleSpec (const FileSpec &module_file_spec, const ArchSpec &arch, ModuleSpec &module_spec)
	Try to fetch the module specification for a module with the given file name and architecture.

virtual void	PrefetchModuleSpecs (llvm::ArrayRef< FileSpec > module_file_specs, const llvm::Triple &triple)

virtual Status	GetFileLoadAddress (const FileSpec &file, bool &is_loaded, lldb::addr_t &load_addr)
	Try to find the load address of a file.

virtual StructuredData::DictionarySP	GetMetadata ()
	Fetch process defined metadata.

StructuredData::DictionarySP	GetExtendedCrashInfoDict ()
	Fetch extended crash information held by the process.

void	ResetExtendedCrashInfoDict ()

size_t	AddImageToken (lldb::addr_t image_ptr)

lldb::addr_t	GetImagePtrFromToken (size_t token) const

void	ResetImageToken (size_t token)

Address	AdvanceAddressToNextBranchInstruction (Address default_stop_addr, AddressRange range_bounds)
	Find the next branch instruction to set a breakpoint on.

virtual Status	ConfigureStructuredData (llvm::StringRef type_name, const StructuredData::ObjectSP &config_sp)
	Configure asynchronous structured data feature.

void	BroadcastStructuredData (const StructuredData::ObjectSP &object_sp, const lldb::StructuredDataPluginSP &plugin_sp)
	Broadcasts the given structured data object from the given plugin.

lldb::StructuredDataPluginSP	GetStructuredDataPlugin (llvm::StringRef type_name) const
	Returns the StructuredDataPlugin associated with a given type name, if there is one.

virtual void *	GetImplementation ()

virtual void	ForceScriptedState (lldb::StateType state)

SourceManager::SourceFileCache &	GetSourceFileCache ()

lldb::addr_t	FindInMemory (lldb::addr_t low, lldb::addr_t high, const uint8_t *buf, size_t size)
	Find a pattern within a memory region.

AddressRanges	FindRangesInMemory (const uint8_t *buf, uint64_t size, const AddressRanges &ranges, size_t alignment, size_t max_matches, Status &error)

lldb::addr_t	FindInMemory (const uint8_t *buf, uint64_t size, const AddressRange &range, size_t alignment, Status &error)

Public Member Functions inherited from lldb_private::ProcessProperties
	ProcessProperties (lldb_private::Process *process)

	~ProcessProperties () override

bool	GetDisableMemoryCache () const

uint64_t	GetMemoryCacheLineSize () const

Args	GetExtraStartupCommands () const

void	SetExtraStartupCommands (const Args &args)

FileSpec	GetPythonOSPluginPath () const

uint32_t	GetVirtualAddressableBits () const

void	SetVirtualAddressableBits (uint32_t bits)

uint32_t	GetHighmemVirtualAddressableBits () const

void	SetHighmemVirtualAddressableBits (uint32_t bits)

void	SetPythonOSPluginPath (const FileSpec &file)

bool	GetIgnoreBreakpointsInExpressions () const

void	SetIgnoreBreakpointsInExpressions (bool ignore)

bool	GetUnwindOnErrorInExpressions () const

void	SetUnwindOnErrorInExpressions (bool ignore)

bool	GetStopOnSharedLibraryEvents () const

void	SetStopOnSharedLibraryEvents (bool stop)

bool	GetDisableLangRuntimeUnwindPlans () const

void	SetDisableLangRuntimeUnwindPlans (bool disable)

bool	GetDetachKeepsStopped () const

void	SetDetachKeepsStopped (bool keep_stopped)

bool	GetWarningsOptimization () const

bool	GetWarningsUnsupportedLanguage () const

bool	GetStopOnExec () const

std::chrono::seconds	GetUtilityExpressionTimeout () const

std::chrono::seconds	GetInterruptTimeout () const

bool	GetOSPluginReportsAllThreads () const

void	SetOSPluginReportsAllThreads (bool does_report)

bool	GetSteppingRunsAllThreads () const

FollowForkMode	GetFollowForkMode () const

Public Member Functions inherited from lldb_private::Properties
	Properties ()

	Properties (const lldb::OptionValuePropertiesSP &collection_sp)

virtual	~Properties ()

virtual lldb::OptionValuePropertiesSP	GetValueProperties () const

virtual lldb::OptionValueSP	GetPropertyValue (const ExecutionContext *exe_ctx, llvm::StringRef property_path, Status &error) const

virtual Status	SetPropertyValue (const ExecutionContext *exe_ctx, VarSetOperationType op, llvm::StringRef property_path, llvm::StringRef value)

virtual Status	DumpPropertyValue (const ExecutionContext *exe_ctx, Stream &strm, llvm::StringRef property_path, uint32_t dump_mask, bool is_json=false)

virtual void	DumpAllPropertyValues (const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask, bool is_json=false)

virtual void	DumpAllDescriptions (CommandInterpreter &interpreter, Stream &strm) const

size_t	Apropos (llvm::StringRef keyword, std::vector< const Property * > &matching_properties) const

template<typename T >
T	GetPropertyAtIndexAs (uint32_t idx, T default_value, const ExecutionContext *exe_ctx=nullptr) const

template<typename T , typename U = typename std::remove_pointer<T>::type, std::enable_if_t< std::is_pointer_v< T >, bool > = true>
const U *	GetPropertyAtIndexAs (uint32_t idx, const ExecutionContext *exe_ctx=nullptr) const

template<typename T >
bool	SetPropertyAtIndex (uint32_t idx, T t, const ExecutionContext *exe_ctx=nullptr) const

Public Member Functions inherited from lldb_private::Broadcaster
	Broadcaster (lldb::BroadcasterManagerSP manager_sp, std::string name)
	Construct with a broadcaster with a name.

virtual	~Broadcaster ()
	Destructor.

void	CheckInWithManager ()

void	BroadcastEvent (lldb::EventSP &event_sp)
	Broadcast an event which has no associated data.

void	BroadcastEventIfUnique (lldb::EventSP &event_sp)

void	BroadcastEvent (uint32_t event_type, const lldb::EventDataSP &event_data_sp)

void	BroadcastEvent (uint32_t event_type)

void	BroadcastEventIfUnique (uint32_t event_type)

void	Clear ()

virtual void	AddInitialEventsToListener (const lldb::ListenerSP &listener_sp, uint32_t requested_events)

uint32_t	AddListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask)
	Listen for any events specified by event_mask.

const std::string &	GetBroadcasterName ()
	Get this broadcaster's name.

bool	GetEventNames (Stream &s, const uint32_t event_mask, bool prefix_with_broadcaster_name) const
	Get the event name(s) for one or more event bits.

void	SetEventName (uint32_t event_mask, const char *name)
	Set the name for an event bit.

const char *	GetEventName (uint32_t event_mask) const

bool	EventTypeHasListeners (uint32_t event_type)

bool	RemoveListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Removes a Listener from this broadcasters list and frees the event bits specified by event_mask that were previously acquired by listener (assuming listener was listening to this object) for other listener objects to use.

bool	HijackBroadcaster (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Provides a simple mechanism to temporarily redirect events from broadcaster.

bool	IsHijackedForEvent (uint32_t event_mask)

void	RestoreBroadcaster ()
	Restore the state of the Broadcaster from a previous hijack attempt.

virtual llvm::StringRef	GetBroadcasterClass () const
	This needs to be filled in if you are going to register the broadcaster with the broadcaster manager and do broadcaster class matching.

lldb::BroadcasterManagerSP	GetManager ()

void	SetPrimaryListener (lldb::ListenerSP listener_sp)

lldb::ListenerSP	GetPrimaryListener ()

Public Member Functions inherited from lldb_private::ExecutionContextScope
virtual	~ExecutionContextScope ()=default

virtual lldb::TargetSP	CalculateTarget ()=0

virtual lldb::ProcessSP	CalculateProcess ()=0

virtual lldb::ThreadSP	CalculateThread ()=0

virtual lldb::StackFrameSP	CalculateStackFrame ()=0

virtual void	CalculateExecutionContext (ExecutionContext &exe_ctx)=0
	Reconstruct the object's execution context into sc.

Public Member Functions inherited from lldb_private::PluginInterface
	PluginInterface ()=default

virtual	~PluginInterface ()=default

virtual llvm::StringRef	GetPluginName ()=0

	PluginInterface (const PluginInterface &)=delete

PluginInterface &	operator= (const PluginInterface &)=delete

Static Public Member Functions
static lldb::ProcessSP	CreateInstance (lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, const FileSpec *crash_file_path, bool can_connect)

static void	Initialize ()

static void	Terminate ()

static llvm::StringRef	GetPluginNameStatic ()

static llvm::StringRef	GetPluginDescriptionStatic ()

Static Public Member Functions inherited from lldb_private::Process
static llvm::StringRef	GetStaticBroadcasterClass ()

static void	SettingsInitialize ()

static void	SettingsTerminate ()

static ProcessProperties &	GetGlobalProperties ()

static lldb::ProcessSP	FindPlugin (lldb::TargetSP target_sp, llvm::StringRef plugin_name, lldb::ListenerSP listener_sp, const FileSpec *crash_file_path, bool can_connect)
	Find a Process plug-in that can debug module using the currently selected architecture.

static bool	SetProcessExitStatus (lldb::pid_t pid, bool exited, int signo, int status)
	Static function that can be used with the host function Host::StartMonitoringChildProcess ().

static bool	HandleProcessStateChangedEvent (const lldb::EventSP &event_sp, Stream *stream, SelectMostRelevant select_most_relevant, bool &pop_process_io_handler)
	Centralize the code that handles and prints descriptions for process state changes.

Static Public Member Functions inherited from lldb_private::Properties
static llvm::StringRef	GetExperimentalSettingsName ()

static bool	IsSettingExperimental (llvm::StringRef setting)

Protected Member Functions
	ScriptedProcess (lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, const ScriptedMetadata &scripted_metadata, Status &error)

void	Clear ()

bool	DoUpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list) override
	Update the thread list following process plug-in's specific logic.

Status	DoGetMemoryRegionInfo (lldb::addr_t load_addr, MemoryRegionInfo &range_info) override
	DoGetMemoryRegionInfo is called by GetMemoryRegionInfo after it has removed non address bits from load_addr.

Status	DoAttach (const ProcessAttachInfo &attach_info)

Protected Member Functions inherited from lldb_private::Process
virtual JITLoaderList &	GetJITLoaders ()

	Process (lldb::TargetSP target_sp, lldb::ListenerSP listener_sp)
	Construct with a shared pointer to a target, and the Process listener.

	Process (lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, const lldb::UnixSignalsSP &unix_signals_sp)
	Construct with a shared pointer to a target, the Process listener, and the appropriate UnixSignalsSP for the process.

virtual llvm::Expected< TraceSupportedResponse >	TraceSupported ()
	Get the processor tracing type supported for this process.

virtual llvm::Error	TraceStart (const llvm::json::Value &request)
	Start tracing a process or its threads.

virtual llvm::Error	TraceStop (const TraceStopRequest &request)
	Stop tracing a live process or its threads.

virtual llvm::Expected< std::string >	TraceGetState (llvm::StringRef type)
	Get the current tracing state of the process and its threads.

virtual llvm::Expected< std::vector< uint8_t > >	TraceGetBinaryData (const TraceGetBinaryDataRequest &request)
	Get binary data given a trace technology and a data identifier.

bool	CallVoidArgVoidPtrReturn (const Address *address, lldb::addr_t &returned_func, bool trap_exceptions=false)

virtual bool	DoUpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list)=0
	Update the thread list following process plug-in's specific logic.

virtual size_t	DoReadMemory (lldb::addr_t vm_addr, void *buf, size_t size, Status &error)=0
	Actually do the reading of memory from a process.

virtual void	DoFindInMemory (lldb::addr_t start_addr, lldb::addr_t end_addr, const uint8_t *buf, size_t size, AddressRanges &matches, size_t alignment, size_t max_matches)

virtual Status	DoGetMemoryRegionInfo (lldb::addr_t load_addr, MemoryRegionInfo &range_info)
	DoGetMemoryRegionInfo is called by GetMemoryRegionInfo after it has removed non address bits from load_addr.

virtual std::optional< bool >	DoGetWatchpointReportedAfter ()
	Provide an override value in the subclass for lldb's CPU-based logic for whether watchpoint exceptions are received before or after an instruction executes.

virtual lldb::ThreadSP	HandleThreadAsyncInterrupt (uint8_t signo, const std::string &description)
	Handle thread specific async interrupt and return the original thread that requested the async interrupt.

lldb::StateType	GetPrivateState ()

Status	PrivateResume ()
	The "private" side of resuming a process.

void	CompleteAttach ()

void	SetNextEventAction (Process::NextEventAction *next_event_action)

bool	PrivateStateThreadIsValid () const

void	ForceNextEventDelivery ()

void	MapSupportedStructuredDataPlugins (const StructuredData::Array &supported_type_names)
	Loads any plugins associated with asynchronous structured data and maps the relevant supported type name to the plugin.

bool	RouteAsyncStructuredData (const StructuredData::ObjectSP object_sp)
	Route the incoming structured data dictionary to the right plugin.

virtual bool	SupportsMemoryTagging ()
	Check whether the process supports memory tagging.

virtual llvm::Expected< std::vector< uint8_t > >	DoReadMemoryTags (lldb::addr_t addr, size_t len, int32_t type)
	Does the final operation to read memory tags.

virtual Status	DoWriteMemoryTags (lldb::addr_t addr, size_t len, int32_t type, const std::vector< uint8_t > &tags)
	Does the final operation to write memory tags.

size_t	RemoveBreakpointOpcodesFromBuffer (lldb::addr_t addr, size_t size, uint8_t *buf) const

void	SynchronouslyNotifyStateChanged (lldb::StateType state)

void	SetPublicState (lldb::StateType new_state, bool restarted)

void	SetPrivateState (lldb::StateType state)

bool	StartPrivateStateThread (bool is_secondary_thread=false)

void	StopPrivateStateThread ()

void	PausePrivateStateThread ()

void	ResumePrivateStateThread ()

void	HandlePrivateEvent (lldb::EventSP &event_sp)

Status	HaltPrivate ()

lldb::StateType	WaitForProcessStopPrivate (lldb::EventSP &event_sp, const Timeout< std::micro > &timeout)

bool	GetEventsPrivate (lldb::EventSP &event_sp, const Timeout< std::micro > &timeout, bool control_only)

lldb::StateType	GetStateChangedEventsPrivate (lldb::EventSP &event_sp, const Timeout< std::micro > &timeout)

size_t	WriteMemoryPrivate (lldb::addr_t addr, const void *buf, size_t size, Status &error)

void	AppendSTDOUT (const char *s, size_t len)

void	AppendSTDERR (const char *s, size_t len)

void	BroadcastAsyncProfileData (const std::string &one_profile_data)

bool	PushProcessIOHandler ()

bool	PopProcessIOHandler ()

bool	ProcessIOHandlerIsActive ()

bool	ProcessIOHandlerExists () const

Status	StopForDestroyOrDetach (lldb::EventSP &exit_event_sp)

virtual Status	UpdateAutomaticSignalFiltering ()

void	LoadOperatingSystemPlugin (bool flush)

void	SetAddressableBitMasks (AddressableBits bit_masks)

Protected Member Functions inherited from lldb_private::Broadcaster
BroadcasterImplSP	GetBroadcasterImpl ()

const char *	GetHijackingListenerName ()

Private Member Functions
void	CheckScriptedInterface () const

ScriptedProcessInterface &	GetInterface () const

Static Private Member Functions
static bool	IsScriptLanguageSupported (lldb::ScriptLanguage language)

Private Attributes
const ScriptedMetadata	m_scripted_metadata

lldb::ScriptedProcessInterfaceUP	m_interface_up

Friends
class	ScriptedThread

Additional Inherited Members
Public Types inherited from lldb_private::Process
enum	{ eBroadcastBitStateChanged = (1 << 0) , eBroadcastBitInterrupt = (1 << 1) , eBroadcastBitSTDOUT = (1 << 2) , eBroadcastBitSTDERR = (1 << 3) , eBroadcastBitProfileData = (1 << 4) , eBroadcastBitStructuredData = (1 << 5) }
	Broadcaster event bits definitions. More...

enum	{ eBroadcastInternalStateControlStop = (1 << 0) , eBroadcastInternalStateControlPause = (1 << 1) , eBroadcastInternalStateControlResume = (1 << 2) }

typedef Range< lldb::addr_t, lldb::addr_t >	LoadRange

typedef ProcessRunLock::ProcessRunLocker	StopLocker

typedef bool()	PreResumeActionCallback(void *)

Static Public Attributes inherited from lldb_private::Process
static constexpr int	g_all_event_bits

static constexpr llvm::StringRef	AttachSynchronousHijackListenerName

static constexpr llvm::StringRef	LaunchSynchronousHijackListenerName

static constexpr llvm::StringRef	ResumeSynchronousHijackListenerName

Protected Types inherited from lldb_private::Process
enum	{ eCanJITDontKnow = 0 , eCanJITYes , eCanJITNo }

typedef std::map< lldb::LanguageType, lldb::LanguageRuntimeSP >	LanguageRuntimeCollection

Protected Types inherited from lldb_private::Broadcaster
typedef std::shared_ptr< BroadcasterImpl >	BroadcasterImplSP

typedef std::weak_ptr< BroadcasterImpl >	BroadcasterImplWP

Static Protected Member Functions inherited from lldb_private::Process
static void	STDIOReadThreadBytesReceived (void baton, const void src, size_t src_len)

Protected Attributes inherited from lldb_private::Process
std::weak_ptr< Target >	m_target_wp
	The target that owns this process.

lldb::pid_t	m_pid = LLDB_INVALID_PROCESS_ID

ThreadSafeValue< lldb::StateType >	m_public_state

ThreadSafeValue< lldb::StateType >	m_private_state

Broadcaster	m_private_state_broadcaster

Broadcaster	m_private_state_control_broadcaster

lldb::ListenerSP	m_private_state_listener_sp

HostThread	m_private_state_thread
	Thread ID for the thread that watches internal state events.

ProcessModID	m_mod_id
	Tracks the state of the process over stops and other alterations.

uint32_t	m_process_unique_id
	Each lldb_private::Process class that is created gets a unique integer ID that increments with each new instance.

uint32_t	m_thread_index_id
	Each thread is created with a 1 based index that won't get re-used.

std::map< uint64_t, uint32_t >	m_thread_id_to_index_id_map

int	m_exit_status
	The exit status of the process, or -1 if not set.

std::string	m_exit_string
	A textual description of why a process exited.

std::mutex	m_exit_status_mutex
	Mutex so m_exit_status m_exit_string can be safely accessed from multiple threads.

std::recursive_mutex	m_thread_mutex

ThreadList	m_thread_list_real
	The threads for this process as are known to the protocol we are debugging with.

ThreadList	m_thread_list
	The threads for this process as the user will see them.

ThreadPlanStackMap	m_thread_plans
	This is the list of thread plans for threads in m_thread_list, as well as threads we knew existed, but haven't determined that they have died yet.

ThreadList	m_extended_thread_list
	Constituent for extended threads that may be generated, cleared on natural stops.

uint32_t	m_extended_thread_stop_id
	The natural stop id when extended_thread_list was last updated.

QueueList	m_queue_list
	The list of libdispatch queues at a given stop point.

uint32_t	m_queue_list_stop_id
	The natural stop id when queue list was last fetched.

StopPointSiteList< lldb_private::WatchpointResource >	m_watchpoint_resource_list
	Watchpoint resources currently in use.

std::vector< Notifications >	m_notifications
	The list of notifications that this process can deliver.

std::vector< lldb::addr_t >	m_image_tokens

StopPointSiteList< lldb_private::BreakpointSite >	m_breakpoint_site_list
	This is the list of breakpoint locations we intend to insert in the target.

lldb::DynamicLoaderUP	m_dyld_up

lldb::JITLoaderListUP	m_jit_loaders_up

lldb::DynamicCheckerFunctionsUP	m_dynamic_checkers_up
	The functions used by the expression parser to validate data that expressions use.

lldb::OperatingSystemUP	m_os_up

lldb::SystemRuntimeUP	m_system_runtime_up

lldb::UnixSignalsSP	m_unix_signals_sp

lldb::ABISP	m_abi_sp
	This is the current signal set for this process.

lldb::IOHandlerSP	m_process_input_reader

std::mutex	m_process_input_reader_mutex

ThreadedCommunication	m_stdio_communication

std::recursive_mutex	m_stdio_communication_mutex

bool	m_stdin_forward

std::string	m_stdout_data
	Remember if stdin must be forwarded to remote debug server.

std::string	m_stderr_data

std::recursive_mutex	m_profile_data_comm_mutex

std::vector< std::string >	m_profile_data

Predicate< uint32_t >	m_iohandler_sync

MemoryCache	m_memory_cache

AllocatedMemoryCache	m_allocated_memory_cache

bool	m_should_detach

LanguageRuntimeCollection	m_language_runtimes
	Should we detach if the process object goes away with an explicit call to Kill or Detach?

std::recursive_mutex	m_language_runtimes_mutex

InstrumentationRuntimeCollection	m_instrumentation_runtimes

std::unique_ptr< NextEventAction >	m_next_event_action_up

std::vector< PreResumeCallbackAndBaton >	m_pre_resume_actions

ProcessRunLock	m_public_run_lock

ProcessRunLock	m_private_run_lock

bool	m_currently_handling_do_on_removals

bool	m_resume_requested

lldb::tid_t	m_interrupt_tid

std::atomic< bool >	m_finalizing
	The tid of the thread that issued the async interrupt, used by thread plan timeout.

std::atomic< bool >	m_destructing

bool	m_clear_thread_plans_on_stop

bool	m_force_next_event_delivery

lldb::StateType	m_last_broadcast_state

std::map< lldb::addr_t, lldb::addr_t >	m_resolved_indirect_addresses
	This helps with the Public event coalescing in ShouldBroadcastEvent.

bool	m_destroy_in_process

bool	m_can_interpret_function_calls

std::mutex	m_run_thread_plan_lock

llvm::StringMap< lldb::StructuredDataPluginSP >	m_structured_data_plugin_map

enum lldb_private::Process:: { ... }	m_can_jit

std::unique_ptr< UtilityFunction >	m_dlopen_utility_func_up

llvm::once_flag	m_dlopen_utility_func_flag_once

SourceManager::SourceFileCache	m_source_file_cache
	Per process source file cache.

StructuredData::DictionarySP	m_crash_info_dict_sp
	A repository for extra crash information, consulted in GetExtendedCrashInformation.

lldb::addr_t	m_code_address_mask = LLDB_INVALID_ADDRESS_MASK
	Mask for code an data addresses.

lldb::addr_t	m_data_address_mask = LLDB_INVALID_ADDRESS_MASK

lldb::addr_t	m_highmem_code_address_mask = LLDB_INVALID_ADDRESS_MASK

lldb::addr_t	m_highmem_data_address_mask = LLDB_INVALID_ADDRESS_MASK

Protected Attributes inherited from lldb_private::ProcessProperties
Process *	m_process

std::unique_ptr< ProcessExperimentalProperties >	m_experimental_properties_up

Protected Attributes inherited from lldb_private::Properties
lldb::OptionValuePropertiesSP	m_collection_sp

Detailed Description

Definition at line 23 of file ScriptedProcess.h.

Constructor & Destructor Documentation

◆ ~ScriptedProcess()

ScriptedProcess::~ScriptedProcess ( )

override

Definition at line 131 of file ScriptedProcess.cpp.

References Clear(), lldb_private::Process::Finalize(), and m_interface_up.

◆ ScriptedProcess()

ScriptedProcess::ScriptedProcess	(	lldb::TargetSP	target_sp,
		lldb::ListenerSP	listener_sp,
		const ScriptedMetadata &	scripted_metadata,
		Status &	error
	)

protected

Definition at line 77 of file ScriptedProcess.cpp.

References lldb_private::ScriptedProcessInterface::CreatePluginObject(), lldb_private::ScriptInterpreter::CreateScriptedProcessInterface(), error(), lldb_private::Status::FromErrorString(), lldb_private::Status::FromErrorStringWithFormat(), lldb_private::ScriptedMetadata::GetArgsSP(), lldb_private::ScriptedMetadata::GetClassName(), GetInterface(), m_interface_up, and m_scripted_metadata.

Member Function Documentation

◆ CanDebug()

bool ScriptedProcess::CanDebug	(	lldb::TargetSP	target,
		bool	plugin_specified_by_name
	)

overridevirtual

Check if a plug-in instance can debug the file in module.

Each plug-in is given a chance to say whether it can debug the file in module. If the Process plug-in instance can debug a file on the current system, it should return true.

Returns: Returns true if this Process plug-in instance can debug the executable, false otherwise.

Implements lldb_private::Process.

Definition at line 72 of file ScriptedProcess.cpp.

◆ CheckScriptedInterface()

void lldb_private::ScriptedProcess::CheckScriptedInterface ( ) const

inlineprivate

Definition at line 122 of file ScriptedProcess.h.

References lldbassert, and m_interface_up.

Referenced by lldb_private::ScriptedThread::Create(), GetInterface(), and UpdateQueueListIfNeeded().

◆ Clear()

void ScriptedProcess::Clear ( )

protected

Definition at line 315 of file ScriptedProcess.cpp.

References lldb_private::ThreadList::Clear(), and lldb_private::Process::m_thread_list.

Referenced by ~ScriptedProcess().

◆ CreateInstance()

lldb::ProcessSP ScriptedProcess::CreateInstance	(	lldb::TargetSP	target_sp,
		lldb::ListenerSP	listener_sp,
		const FileSpec *	crash_file_path,
		bool	can_connect
	)

static

Definition at line 50 of file ScriptedProcess.cpp.

References error(), lldb_private::GetLog(), IsScriptLanguageSupported(), LLDB_LOGF, and lldb_private::Process.

Referenced by Initialize(), and Terminate().

◆ DidAttach()

void ScriptedProcess::DidAttach ( ArchSpec & process_arch )

overridevirtual

Called after attaching a process.

Parameters

[in] process_arch If you can figure out the process architecture after attach, fill it in here.

Allow Process plug-ins to execute some code after attaching to a process.

Reimplemented from lldb_private::Process.

Definition at line 215 of file ScriptedProcess.cpp.

References GetArchitecture().

◆ DidLaunch()

void ScriptedProcess::DidLaunch ( )

overridevirtual

Called after launching a process.

Allow Process plug-ins to execute some code after launching a process.

Reimplemented from lldb_private::Process.

Definition at line 178 of file ScriptedProcess.cpp.

References GetInterface(), lldb_private::ScriptedProcessInterface::GetProcessID(), and lldb_private::Process::m_pid.

Referenced by DoAttach().

◆ DidResume()

void ScriptedProcess::DidResume ( )

overridevirtual

Called after resuming a process.

Allow Process plug-ins to execute some code after resuming a process.

Reimplemented from lldb_private::Process.

Definition at line 180 of file ScriptedProcess.cpp.

References GetInterface(), lldb_private::ScriptedProcessInterface::GetProcessID(), and lldb_private::Process::m_pid.

◆ DoAttach()

Status ScriptedProcess::DoAttach ( const ProcessAttachInfo & attach_info )

protected

Definition at line 191 of file ScriptedProcess.cpp.

References lldb_private::ScriptedProcessInterface::Attach(), DidLaunch(), error(), lldb::eStateRunning, lldb::eStateStopped, GetInterface(), and lldb_private::Process::SetPrivateState().

Referenced by DoAttachToProcessWithID(), and DoAttachToProcessWithName().

◆ DoAttachToProcessWithID()

Status ScriptedProcess::DoAttachToProcessWithID	(	lldb::pid_t	pid,
		const ProcessAttachInfo &	attach_info
	)

overridevirtual

Attach to an existing process using a process ID.

Parameters

[in]	pid	The process ID that we should attempt to attach to.
[in]	attach_info	Information on how to do the attach. For example, GetUserID() will return the uid to attach as.

Returns: Returns a successful Status attaching was successful, or an appropriate (possibly platform-specific) error code if attaching fails. hanming : need flag

Reimplemented from lldb_private::Process.

Definition at line 205 of file ScriptedProcess.cpp.

References DoAttach().

◆ DoAttachToProcessWithName()

Status ScriptedProcess::DoAttachToProcessWithName	(	const char *	process_name,
		const ProcessAttachInfo &	attach_info
	)

overridevirtual

Attach to an existing process using a partial process name.

Parameters

[in]	process_name	The name of the process to attach to.
[in]	attach_info	Information on how to do the attach. For example, GetUserID() will return the uid to attach as.

Returns: Returns a successful Status attaching was successful, or an appropriate (possibly platform-specific) error code if attaching fails.

Reimplemented from lldb_private::Process.

Definition at line 210 of file ScriptedProcess.cpp.

References DoAttach().

◆ DoDestroy()

Status ScriptedProcess::DoDestroy ( )

overridevirtual

Implements lldb_private::Process.

Definition at line 219 of file ScriptedProcess.cpp.

◆ DoGetMemoryRegionInfo()

Status ScriptedProcess::DoGetMemoryRegionInfo	(	lldb::addr_t	load_addr,
		MemoryRegionInfo &	range_info
	)

overrideprotectedvirtual

DoGetMemoryRegionInfo is called by GetMemoryRegionInfo after it has removed non address bits from load_addr.

Override this method in subclasses of Process.

See GetMemoryRegionInfo for details of the logic.

Parameters

[in]	load_addr	The load address to query the range_info for. (non address bits removed)
[out]	range_info	An range_info value containing the details of the range.

Returns: An error value.

Reimplemented from lldb_private::Process.

Definition at line 287 of file ScriptedProcess.cpp.

References error(), and GetInterface().

◆ DoLaunch()

Status ScriptedProcess::DoLaunch	(	Module *	exe_module,
		ProcessLaunchInfo &	launch_info
	)

overridevirtual

Launch a new process.

Launch a new process by spawning a new process using exe_module's file as the file to launch. Launch details are provided in launch_info.

Parameters

[in]	exe_module	The module from which to extract the file specification and launch.
[in]	launch_info	Details (e.g. arguments, stdio redirection, etc.) for the requested launch.

Returns: An Status instance indicating success or failure of the operation.

Reimplemented from lldb_private::Process.

Definition at line 165 of file ScriptedProcess.cpp.

References error(), lldb::eStateStopped, GetInterface(), lldb_private::GetLog(), lldb_private::ScriptedProcessInterface::Launch(), LLDB_LOGF, lldb_private::Process, and lldb_private::Process::SetPrivateState().

Referenced by DoLoadCore().

◆ DoLoadCore()

Status ScriptedProcess::DoLoadCore ( )

overridevirtual

Reimplemented from lldb_private::Process.

Definition at line 159 of file ScriptedProcess.cpp.

References DoLaunch(), lldb_private::TargetProperties::GetProcessLaunchInfo(), and lldb_private::Process::GetTarget().

◆ DoReadMemory()

size_t ScriptedProcess::DoReadMemory	(	lldb::addr_t	vm_addr,
		void *	buf,
		size_t	size,
		Status &	error
	)

overridevirtual

Actually do the reading of memory from a process.

Subclasses must override this function and can return fewer bytes than requested when memory requests are too large. This class will break up the memory requests and keep advancing the arguments along as needed.

Parameters

[in]	vm_addr	A virtual load address that indicates where to start reading memory from.
[in]	size	The number of bytes to read.
[out]	buf	A byte buffer that is at least size bytes long that will receive the memory bytes.
[out]	error	An error that indicates the success or failure of this operation. If error indicates success (error.Success()), then the value returned can be trusted, otherwise zero will be returned.

Returns: The number of bytes that were actually read into buf. Zero is returned in the case of an error.

Implements lldb_private::Process.

Definition at line 223 of file ScriptedProcess.cpp.

References error(), lldb_private::Process::GetByteOrder(), GetInterface(), LLDB_INVALID_OFFSET, and lldb_private::ScriptedProcessInterface::ReadMemoryAtAddress().

◆ DoResume()

Status ScriptedProcess::DoResume ( )

overridevirtual

Resumes all of a process's threads as configured using the Thread run control functions.

Threads for a process should be updated with one of the run control actions (resume, step, or suspend) that they should take when the process is resumed. If no run control action is given to a thread it will be resumed by default.

Returns: Returns true if the process successfully resumes using the thread run control actions, false otherwise.

See also: Thread:Resume(); Thread:Step(); Thread:Suspend()

Reimplemented from lldb_private::Process.

Definition at line 185 of file ScriptedProcess.cpp.

References GetInterface(), lldb_private::GetLog(), LLDB_LOGF, lldb_private::Process, and lldb_private::ScriptedProcessInterface::Resume().

◆ DoUpdateThreadList()

bool ScriptedProcess::DoUpdateThreadList	(	ThreadList &	old_thread_list,
		ThreadList &	new_thread_list
	)

overrideprotectedvirtual

Update the thread list following process plug-in's specific logic.

This method should only be invoked by UpdateThreadList.

Returns: true if the new thread list could be generated, false otherwise.

Implements lldb_private::Process.

Definition at line 317 of file ScriptedProcess.cpp.

References lldb_private::ThreadCollection::AddThread(), lldb_private::ThreadPlanStackMap::ClearThreadCache(), lldb_private::ScriptedThread::Create(), error(), GetInterface(), lldb_private::ThreadList::GetSize(), lldb_private::ScriptedProcessInterface::GetThreadsInfo(), lldbassert, lldb_private::Process::m_thread_plans, and lldb_private::toString().

◆ DoWriteMemory()

size_t ScriptedProcess::DoWriteMemory	(	lldb::addr_t	vm_addr,
		const void *	buf,
		size_t	size,
		Status &	error
	)

overridevirtual

Actually do the writing of memory to a process.

Parameters

[in]	vm_addr	A virtual load address that indicates where to start writing memory to.
[in]	buf	A byte buffer that is at least size bytes long that contains the data to write.
[in]	size	The number of bytes to write.
[out]	error	An error value in case the memory write fails.

Returns: The number of bytes that were actually written.

Reimplemented from lldb_private::Process.

Definition at line 244 of file ScriptedProcess.cpp.

References error(), lldb_private::Process::GetAddressByteSize(), lldb_private::Process::GetByteOrder(), GetInterface(), LLDB_INVALID_OFFSET, and lldb_private::ScriptedProcessInterface::WriteMemoryAtAddress().

◆ EnableBreakpointSite()

Status ScriptedProcess::EnableBreakpointSite ( BreakpointSite * bp_site )

overridevirtual

Reimplemented from lldb_private::Process.

Definition at line 265 of file ScriptedProcess.cpp.

References lldb_private::ScriptedProcessInterface::CreateBreakpoint(), error(), lldb_private::Status::FromErrorString(), GetInterface(), lldb_private::StoppointSite::GetLoadAddress(), lldb_private::StoppointSite::HardwareRequired(), and lldb_private::BreakpointSite::IsEnabled().

◆ ForceScriptedState()

void lldb_private::ScriptedProcess::ForceScriptedState ( lldb::StateType state )

inlineoverridevirtual

Reimplemented from lldb_private::Process.

Definition at line 96 of file ScriptedProcess.h.

References GetLoadedDynamicLibrariesInfos(), lldb_private::Process::SetPrivateState(), and lldb_private::StateIsStoppedState().

◆ GetArchitecture()

ArchSpec ScriptedProcess::GetArchitecture ( )

Definition at line 283 of file ScriptedProcess.cpp.

References lldb_private::Target::GetArchitecture(), and lldb_private::Process::GetTarget().

Referenced by DidAttach(), and GetProcessInfo().

◆ GetDynamicLoader()

DynamicLoader * lldb_private::ScriptedProcess::GetDynamicLoader ( )

inlineoverridevirtual

Get the dynamic loader plug-in for this process.

The default action is to let the DynamicLoader plug-ins check the main executable and the DynamicLoader will select itself automatically. Subclasses can override this if inspecting the executable is not desired, or if Process subclasses can only use a specific DynamicLoader plug-in.

Reimplemented from lldb_private::Process.

Definition at line 43 of file ScriptedProcess.h.

◆ GetImplementation()

void * ScriptedProcess::GetImplementation ( )

overridevirtual

Reimplemented from lldb_private::Process.

Definition at line 534 of file ScriptedProcess.cpp.

References lldb::eStructuredDataTypeGeneric, GetInterface(), and lldb_private::ScriptedInterface::GetScriptObjectInstance().

◆ GetInterface()

ScriptedProcessInterface & ScriptedProcess::GetInterface ( ) const

private

Definition at line 529 of file ScriptedProcess.cpp.

References CheckScriptedInterface(), and m_interface_up.

Referenced by lldb_private::ScriptedThread::Create(), DidLaunch(), DidResume(), DoAttach(), DoGetMemoryRegionInfo(), DoLaunch(), DoReadMemory(), DoResume(), DoUpdateThreadList(), DoWriteMemory(), EnableBreakpointSite(), GetImplementation(), GetLoadedDynamicLibrariesInfos(), GetMemoryRegions(), GetMetadata(), IsAlive(), and ScriptedProcess().

◆ GetLoadedDynamicLibrariesInfos()

lldb_private::StructuredData::ObjectSP ScriptedProcess::GetLoadedDynamicLibrariesInfos ( )

overridevirtual

Reimplemented from lldb_private::Process.

Definition at line 423 of file ScriptedProcess.cpp.

References lldb_private::ModuleList::AppendIfNeeded(), error(), lldb_private::ModuleSpec::GetArchitecture(), lldb_private::Target::GetArchitecture(), lldb_private::StructuredData::Object::GetAsDictionary(), lldb_private::FileSpec::GetFilename(), lldb_private::ModuleSpec::GetFileSpec(), GetInterface(), lldb_private::ScriptedProcessInterface::GetLoadedImages(), lldb_private::Target::GetOrCreateModule(), lldb_private::Process::GetTarget(), lldb_private::ModuleSpec::GetUUID(), lldb_private::StructuredData::Dictionary::GetValueForKeyAsInteger(), lldb_private::StructuredData::Dictionary::GetValueForKeyAsString(), lldb_private::StructuredData::Dictionary::HasKey(), LLDB_INVALID_ADDRESS, LLDB_INVALID_OFFSET, lldb_private::Target::ModulesDidLoad(), lldb_private::UUID::SetFromStringRef(), and lldb_private::FileSpec::SetPath().

Referenced by ForceScriptedState().

◆ GetMemoryRegions()

Status ScriptedProcess::GetMemoryRegions ( lldb_private::MemoryRegionInfos & region_list )

overridevirtual

Obtain all the mapped memory regions within this process.

Parameters

[out] region_list A vector to contain MemoryRegionInfo objects for all mapped ranges.

Returns: An error value.

Reimplemented from lldb_private::Process.

Definition at line 297 of file ScriptedProcess.cpp.

References error(), GetInterface(), lldb_private::MemoryRegionInfo::GetRange(), and lldb_private::Range< B, S >::GetRangeBase().

◆ GetMetadata()

lldb_private::StructuredData::DictionarySP ScriptedProcess::GetMetadata ( )

overridevirtual

Fetch process defined metadata.

Returns: A StructuredDataSP object which, if non-empty, will contain the information related to the process.

Reimplemented from lldb_private::Process.

Definition at line 507 of file ScriptedProcess.cpp.

References error(), GetInterface(), and lldb_private::ScriptedProcessInterface::GetMetadata().

◆ GetPluginDescriptionStatic()

llvm::StringRef ScriptedProcess::GetPluginDescriptionStatic ( )

static

Definition at line 35 of file ScriptedProcess.cpp.

Referenced by Initialize().

◆ GetPluginName()

llvm::StringRef lldb_private::ScriptedProcess::GetPluginName ( )

inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 45 of file ScriptedProcess.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

static llvm::StringRef lldb_private::ScriptedProcess::GetPluginNameStatic ( )

inlinestatic

Definition at line 34 of file ScriptedProcess.h.

Referenced by GetPluginName(), and Initialize().

◆ GetProcessInfo()

bool ScriptedProcess::GetProcessInfo ( ProcessInstanceInfo & info )

overridevirtual

Reimplemented from lldb_private::Process.

Definition at line 409 of file ScriptedProcess.cpp.

References lldb_private::ProcessInstanceInfo::Clear(), GetArchitecture(), lldb_private::Target::GetExecutableModule(), lldb_private::Process::GetID(), lldb_private::Process::GetTarget(), lldb_private::ProcessInfo::SetArchitecture(), lldb_private::ProcessInfo::SetExecutableFile(), and lldb_private::ProcessInfo::SetProcessID().

◆ Initialize()

void ScriptedProcess::Initialize ( )

static

Definition at line 146 of file ScriptedProcess.cpp.

References CreateInstance(), GetPluginDescriptionStatic(), GetPluginNameStatic(), and lldb_private::PluginManager::RegisterPlugin().

◆ IsAlive()

bool ScriptedProcess::IsAlive ( )

overridevirtual

Check if a process is still alive.

Returns: Returns true if the process is still valid, false otherwise.

Reimplemented from lldb_private::Process.

Definition at line 221 of file ScriptedProcess.cpp.

References GetInterface(), and lldb_private::ScriptedProcessInterface::IsAlive().

◆ IsScriptLanguageSupported()

bool ScriptedProcess::IsScriptLanguageSupported ( lldb::ScriptLanguage language )

staticprivate

Definition at line 43 of file ScriptedProcess.cpp.

References g_supported_script_languages.

Referenced by CreateInstance().

◆ RefreshStateAfterStop()

void ScriptedProcess::RefreshStateAfterStop ( )

overridevirtual

Currently called as part of ShouldStop.

FIXME: Should really happen when the target stops before the event is taken from the queue...

This callback is called as the event is about to be queued up to allow Process plug-ins to execute some code prior to clients being notified that a process was stopped. Common operations include updating the thread list, invalidating any thread state (registers, stack, etc) prior to letting the notification go out.

Implements lldb_private::Process.

Definition at line 403 of file ScriptedProcess.cpp.

References lldb_private::Process::m_thread_list, and lldb_private::ThreadList::RefreshStateAfterStop().

◆ Terminate()

void ScriptedProcess::Terminate ( )

static

Definition at line 155 of file ScriptedProcess.cpp.

References CreateInstance(), and lldb_private::PluginManager::UnregisterPlugin().

◆ UpdateQueueListIfNeeded()

void ScriptedProcess::UpdateQueueListIfNeeded ( )

overridevirtual

Reimplemented from lldb_private::Process.

Definition at line 518 of file ScriptedProcess.cpp.

References lldb_private::QueueList::AddQueue(), CheckScriptedInterface(), lldb_private::ProcessProperties::m_process, lldb_private::Process::m_queue_list, and lldb_private::Process::Threads().

Friends And Related Function Documentation

◆ ScriptedThread

friend class ScriptedThread

friend

Definition at line 120 of file ScriptedProcess.h.

Member Data Documentation

◆ m_interface_up

lldb::ScriptedProcessInterfaceUP lldb_private::ScriptedProcess::m_interface_up

private

Definition at line 131 of file ScriptedProcess.h.

Referenced by CheckScriptedInterface(), GetInterface(), ScriptedProcess(), and ~ScriptedProcess().

◆ m_scripted_metadata

const ScriptedMetadata lldb_private::ScriptedProcess::m_scripted_metadata

private

Definition at line 130 of file ScriptedProcess.h.

Referenced by lldb_private::ScriptedThread::Create(), and ScriptedProcess().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ScriptedProcess()

◆ ScriptedProcess()

Member Function Documentation

◆ CanDebug()

◆ CheckScriptedInterface()

◆ Clear()

◆ CreateInstance()

◆ DidAttach()

◆ DidLaunch()

◆ DidResume()

◆ DoAttach()

◆ DoAttachToProcessWithID()

◆ DoAttachToProcessWithName()

◆ DoDestroy()

◆ DoGetMemoryRegionInfo()

◆ DoLaunch()

◆ DoLoadCore()

◆ DoReadMemory()

◆ DoResume()

◆ DoUpdateThreadList()

◆ DoWriteMemory()

◆ EnableBreakpointSite()

◆ ForceScriptedState()

◆ GetArchitecture()

◆ GetDynamicLoader()

◆ GetImplementation()

◆ GetInterface()

◆ GetLoadedDynamicLibrariesInfos()

◆ GetMemoryRegions()

◆ GetMetadata()

◆ GetPluginDescriptionStatic()

◆ GetPluginName()

◆ GetPluginNameStatic()

◆ GetProcessInfo()

◆ Initialize()

◆ IsAlive()

◆ IsScriptLanguageSupported()

◆ RefreshStateAfterStop()

◆ Terminate()

◆ UpdateQueueListIfNeeded()

Friends And Related Function Documentation

◆ ScriptedThread

Member Data Documentation

◆ m_interface_up

◆ m_scripted_metadata