Class MacosX64InterruptorAgent

This class is the main part of tracing and parsing part. It provides every parts very specific to an architecture, an OS, ...

Hierarchy

InterruptorAgent
- MacosX64InterruptorAgent

Implements

IStringIndex

Constructors

constructor

new MacosX64InterruptorAgent(pConfig, pDoFollowThread, pInterrupts): MacosX64InterruptorAgent
Parameters
- pConfig: MacosX64InterruptorAgentConfig
- pDoFollowThread: any
- pInterrupts: InterruptSignatureMap
Returns MacosX64InterruptorAgent
Overrides InterruptorAgent.constructor
- Defined in src/arch/MacosX64InterruptorAgent.ts:99

Properties

_do_ft

_do_ft: any = null

_tids

_tids: number[] = []

`Optional` coverage

coverage?: CoverageAgent

debug

debug: DebugOptions = ...

emulator

emulator: boolean

filter_name

filter_name: string[] = []

filter_num

filter_num: string[] = []

followFork

followFork: boolean = false

followThread

followThread: boolean = false

hook

hook: InterruptorHooks = ...

hvc_hk

hvc_hk: any = {}

interrupts

interrupts: InterruptSignatureMap

irq_hk

irq_hk: any = {}

loadCtr

loadCtr: number = 0

modules

modules: Module[] = []

onStart

onStart: any = ...

To use with startOnLoad() A callback function executed when the modules specified in "startOnLoad" are loaded

Field

output

output: OutputOpts = ...

pid

pid: number = -1

PID of process to stalk, when followFork is enabled or on attach

Field

ranges

ranges: any = ...

scope

scope: ScopeMap

smc_hk

smc_hk: any = {}

svc_hk

svc_hk: any = {}

tid

tid: number = -1

types

types: any = {}

uid

uid: number = 0

`Static` FLAVOR_DXC

FLAVOR_DXC: string = "dxc"

`Static` FLAVOR_STRACE

FLAVOR_STRACE: string = "strace"

Methods

`Protected` _setupDelegateFilters

_setupDelegateFilters(pType, pOpts): void
Protected
Parameters
- pType: string
- pOpts: any
Returns void
Inherited from InterruptorAgent._setupDelegateFilters
- Defined in src/common/InterruptorAgent.ts:340

configure

configure(pConfig): void
Parameters
- pConfig: any
Returns void
- Defined in src/arch/MacosX64InterruptorAgent.ts:104

formatLogLine

formatLogLine(pContext, pSysc, pInst, pSysNum): string
Parameters
- pContext: any
- pSysc: string
- pInst: string
- pSysNum: number
Returns string
- Defined in src/arch/MacosX64InterruptorAgent.ts:543

getModuleList

getModuleList(pFilters, pSrcList?, pList?): string[]
To generate a filtered list of syscalls
Parameters
- pFilters: ScopeFilter[]
- pSrcList: Module[] = []
- pList: string[] = []
Returns string[]

Method
Inherited from InterruptorAgent.getModuleList
- Defined in src/common/InterruptorAgent.ts:351

getSyscallError

getSyscallError(pErrRet, pErrEnum): any
To retrieve litteral ErrorCode from the numeric value inside a list of error code.
Parameters
- pErrRet: number
  
  Error code
- pErrEnum: any[]
  
  The list of error codes
Returns any
- Defined in src/arch/MacosX64InterruptorAgent.ts:557

getSyscallList

getSyscallList(pSyscalls): number[]
To generate a filtered list of syscalls
Parameters
- pSyscalls: ScopeFilter
  
  An array of syscall number
Returns number[]

Method
Inherited from InterruptorAgent.getSyscallList
- Defined in src/common/InterruptorAgent.ts:390

isTrackCoverage

isTrackCoverage(): boolean
To check if coverage is enabled

Returns boolean
TRUE is coverage is enabled, else FALSE

Methpd
Inherited from InterruptorAgent.isTrackCoverage
- Defined in src/common/InterruptorAgent.ts:583

locatePC

locatePC(pContext): string
Parameters
- pContext: any
Returns string
- Defined in src/arch/MacosX64InterruptorAgent.ts:148

onHypervisorCall

onHypervisorCall(pIntNum, pHooks): void
Parameters
- pIntNum: number
- pHooks: any
Returns void
- Defined in src/arch/MacosX64InterruptorAgent.ts:137

onSupervisorCall

onSupervisorCall(pIntName, pHooks): void
Parameters
- pIntName: string
- pHooks: any
Returns void
- Defined in src/arch/MacosX64InterruptorAgent.ts:128

parseOptions

parseOptions(pConfig): void
To parse object containing options
Parameters
- pConfig: any
  
  Options
Returns void

Method
Inherited from InterruptorAgent.parseOptions
- Defined in src/common/InterruptorAgent.ts:275

parseRawArgs

parseRawArgs(pContext, pFormat, pIndex): any
Parameters
- pContext: any
- pFormat: SyscallParamSignature
- pIndex: number
Returns any
- Defined in src/arch/MacosX64InterruptorAgent.ts:484

parseStruct

parseStruct(pContext, pFormats, pPointer, pSeparator?, pAlign?): string
To parse memory according to the structure defined by pFormat
Parameters
- pContext: any
- pFormats: TypedData[]
- pPointer: NativePointer
- pSeparator: string = "\n"
- pAlign: boolean = false
Returns string
- Defined in src/arch/MacosX64InterruptorAgent.ts:292

parseValue

parseValue(pContext, pValue, pFormat, pIndex): any
This method is called
Parameters
- pContext: any
- pValue: any
- pFormat: SyscallParamSignature
- pIndex: number
Returns any
- Defined in src/arch/MacosX64InterruptorAgent.ts:351

prepareScope

prepareScope(): void
The aim of this method is to ttr

Returns void
Inherited from InterruptorAgent.prepareScope
- Defined in src/common/InterruptorAgent.ts:326

printStats

printStats(): void
To print some statistic about coverage for linux/arm64

Returns void

Method
Overrides InterruptorAgent.printStats
- Defined in src/arch/MacosX64InterruptorAgent.ts:800

processBbsCoverage

processBbsCoverage(pStalkerEvents): void
To process coverage events
Parameters
- pStalkerEvents: StalkerEventFull[] | StalkerEventBare[]
Returns void
Inherited from InterruptorAgent.processBbsCoverage
- Defined in src/common/InterruptorAgent.ts:592

setupBuiltinHook

setupBuiltinHook(): void
Returns void
- Defined in src/arch/MacosX64InterruptorAgent.ts:144

start

start(pTID?): void
To start to trace
Parameters
- pTID: number = -1
Returns void
Inherited from InterruptorAgent.start
- Defined in src/common/InterruptorAgent.ts:621

startOnLoad

startOnLoad(pModuleRegExp, pOptions?): any
This method setup linker hook to
Parameters
- pModuleRegExp: RegExp
- pOptions: any = null
Returns any
Overrides InterruptorAgent.startOnLoad
- Defined in src/arch/MacosX64InterruptorAgent.ts:186

trace

trace(pStalkerInterator, pInstruction, pExtra): number
To setup "trace" hook is the current instruction is an interruption or follow immediately one.

This function is called by Stalker's event listener for each instruction
Parameters
- pStalkerInterator: StalkerX86Iterator | StalkerArmIterator | StalkerThumbIterator | StalkerArm64Iterator
  
  The stalker iterator
- pInstruction: any
  
  The current instruction
- pExtra: any
  
  Some extra options
Returns number

Method
Overrides InterruptorAgent.trace
- Defined in src/arch/MacosX64InterruptorAgent.ts:701

traceSyscall

traceSyscall(pContext, pHookCfg?): void
Method executed before the syscall interruption if the syscall is not excluded.

This method is responsible of argument parsing, and work as described below :
- 1. read syscall number from a register according to @link{ SyscallCallingConvention }
- 1. find description of corresponding syscall
- 1. save the type of return value from description into hook context
Parameters
- pContext: any
  
  CPU context
- pHookCfg: any = null
  
  Addition hook configuration
Returns void

Method
- Defined in src/arch/MacosX64InterruptorAgent.ts:508

traceSyscallRet

traceSyscallRet(pContext, pHookCfg?): void
Method executed AFTER the syscall interruption if the syscall is not excluded

This method does several operations :
- print the syscall trace
- parse return value
- process return value and correlating
Parameters
- pContext: any
- pHookCfg: any = null
Returns void

Method
- Defined in src/arch/MacosX64InterruptorAgent.ts:580

Class MacosX64InterruptorAgent

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

pConfig: MacosX64InterruptorAgentConfig

pDoFollowThread: any

pInterrupts: InterruptSignatureMap

Returns MacosX64InterruptorAgent

Properties

_do_ft

_tids

Optional coverage

debug

emulator

filter_name

filter_num

followFork

followThread

hook

hvc_hk

interrupts

irq_hk

loadCtr

modules

onStart

Field

output

pid

Field

ranges

scope

smc_hk

svc_hk

tid

types

uid

Static FLAVOR_DXC

Static FLAVOR_STRACE

Methods

Protected _setupDelegateFilters

Parameters

pType: string

pOpts: any

Returns void

configure

Parameters

pConfig: any

Returns void

formatLogLine

Parameters

pContext: any

pSysc: string

pInst: string

pSysNum: number

Returns string

getModuleList

Parameters

pFilters: ScopeFilter[]

pSrcList: Module[] = []

pList: string[] = []

Returns string[]

Method

getSyscallError

Parameters

pErrRet: number

pErrEnum: any[]

Returns any

getSyscallList

Parameters

pSyscalls: ScopeFilter

Returns number[]

Method

isTrackCoverage

Returns boolean

`Optional` coverage

`Static` FLAVOR_DXC

`Static` FLAVOR_STRACE

`Protected` _setupDelegateFilters