codescan.md

amx_assembly codescan

AMX Assembly Library: Compiled code scanning and pattern matching.

Enums

CodeScanMatcher:

Members

• CodeScanMatcher_func = 0
• CodeScanMatcher_user_data = 1
• CodeScanMatcher_type = 2
• CodeScanMatcher_code = 66
• CodeScanMatcher_len = 130
• CodeScanMatcher_offset = 131
• CodeScanMatcher_start = 133
• CodeScanMatcher_holeidx = 135
• CodeScanMatcher_holes = 137
• CodeScanMatcher_next = 169
• CodeScanMatcher_flags = 170

CodeScanner:

Members

• CodeScanMatch_func = 0
• CodeScanMatch_size = 1
• CodeScanMatch_type = 2
• CodeScanMatch_heap = 3
• CodeScanMatch_stack = 4
• CodeScanMatch_params = 5
• CodeScanMatch_cip = 6
• CodeScanMatch_holes = 7
• CodeScanMatch_hole_count = 23
• CodeScanMatch_name = 24
• CodeScanner_first = 40
• CodeScanner_minn = 41
• CodeScanner_jump_switch = 42
• CodeScanner_jump_target = 74
• CodeScanner_jump_stack = 106
• CodeScanner_jump_heap = 138
• CodeScanner_state = 170
• CodeScanner_param = 171

Variables

gBase:

gCodBase:

gCodeScanCallback_match:

gDat:

gFakeMatcher:

gHdr:

gOP_CASETBL:

gOP_NOP:

gRelocateRequired:

Tag

bool:

Functions

CodeScanAddJumpTarget:

Syntax

CodeScanAddJumpTarget(cip, target, stk, hea, jumpTargets[], num)

Parameters

Name	Info
cip
target
stk
hea
jumpTargets	[172]
num

Depends on

• CodeScanner_jump_heap
• CodeScanner_jump_stack
• CodeScanner_jump_switch
• CodeScanner_jump_target
• CodeScanner_minn
• min

Estimated stack usage

4 cells

CodeScanAddMatcher:

Syntax

CodeScanAddMatcher(scanner[], searcher[])

Parameters

Name	Info
scanner	[172]
searcher	[171]

Depends on

• CodeScanMatcher_next
• CodeScanner_first
• ref

Estimated stack usage

4 cells

CodeScanAddSwitchTarget:

Syntax

CodeScanAddSwitchTarget(cip, stk, hea, jumpTargets[], num)

Parameters

Name	Info
cip
stk
hea
jumpTargets	[172]
num

Depends on

• AMX_HDR_COD
• AMX_HDR_DAT
• CodeScanner_jump_heap
• CodeScanner_jump_stack
• CodeScanner_jump_switch
• CodeScanner_jump_target
• CodeScanner_minn
• cellbytes
• cellmin
• gAmxAssemblyAddress_
• gBase
• gHdr
• gOP_CASETBL
• min

Estimated stack usage

8 cells

CodeScanCheck:

Syntax

CodeScanCheck(op, dctx[], cs[], matcher__, fctx[], &next)

Parameters

Name	Info
op	Opcode
dctx	[5]
cs	[171]
matcher__
fctx	[172]
next	&

Tag

bool:

Depends on

• CodeScanMatch_cip
• CodeScanMatch_hole_count
• CodeScanMatch_holes
• CodeScanMatch_size
• CodeScanMatcher_code
• CodeScanMatcher_holeidx
• CodeScanMatcher_holes
• CodeScanMatcher_len
• CodeScanMatcher_next
• CodeScanMatcher_offset
• CodeScanMatcher_start
• CodeScanMatcher_type
• DisasmContext_cip
• DisasmContext_nip
• DisasmGetOperandReloc
• FIXES_memcpy
• OP_CASETBL
• cellbytes
• false
• gAMXOpcodeParameterCounts
• gAmxAssemblyAddress_
• true

Estimated stack usage

13 cells

CodeScanCheckJumpTarget:

Syntax

CodeScanCheckJumpTarget(cip, deloc, &stk, &hea, jumpTargets[], num)

Parameters

Name	Info
cip
deloc
stk	&
hea	&
jumpTargets	[172]
num

Tag

bool:

Depends on

• CodeScanner_jump_heap
• CodeScanner_jump_stack
• CodeScanner_jump_switch
• CodeScanner_jump_target
• CodeScanner_minn
• cellbytes
• cellmin
• false
• gAmxAssemblyAddress_
• true

Estimated stack usage

4 cells

CodeScanClone:

Syntax

CodeScanClone(dest[], src[])

Parameters

Name	Info
dest	[172]
src	[172]

Depends on

• CodeScanner_first

Estimated stack usage

1 cells

CodeScanFindOneFastPattern2:

Syntax

CodeScanFindOneFastPattern2(matcher[], matcher__, &addr)

Parameters

Name	Info
matcher	[171]
matcher__
addr	&

Tag

bool:

Depends on

• CodeScanFindOneFastPattern3
• CodeScanMatcher_code
• CodeScanMatcher_len
• CodeScanMatcher_next
• CodeScanMatcher_type
• OP_CALL
• false
• gFakeMatcher
• true

Estimated stack usage

10 cells

CodeScanFindOneFastPattern3:

Syntax

CodeScanFindOneFastPattern3(matcher[], matcher__, addr, &cur)

Parameters

Name	Info
matcher	[171]
matcher__
addr
cur	&

Tag

bool:

Depends on

• CodeScanMatcher_code
• CodeScanMatcher_len
• CodeScanMatcher_next
• CodeScanMatcher_type
• OP_CALL
• false
• true

Estimated stack usage

3 cells

CodeScanGetFuncName:

Syntax

CodeScanGetFuncName(addr, name[])

Parameters

Name	Info
addr
name	[]

Tag

bool:

Depends on

• GetPublicIndexFromAddress
• GetPublicNameFromIndex
• false
• true

Estimated stack usage

7 cells

CodeScanGetFunctionAsm:

Syntax

CodeScanGetFunctionAsm(csm[], ctx[], offset)

Parameters

Name	Info
csm	[172]
ctx	[21]
offset

Depends on

• AsmInitPtr
• CodeScanMatch_func
• cellmax

Estimated stack usage

6 cells

CodeScanGetFunctionDisasm:

Syntax

CodeScanGetFunctionDisasm(csm[], ctx[], offset)

Parameters

Name	Info
csm	[172]
ctx	[5]
offset

Depends on

• CodeScanMatch_func
• DisasmContext_cip
• DisasmContext_end_ip
• DisasmContext_nip
• DisasmContext_start_ip

Estimated stack usage

1 cells

CodeScanGetFunctionScanner:

Syntax

CodeScanGetFunctionScanner(csm[], ret[], ctx[])

Parameters

Name	Info
csm	[172]
ret	[172]
ctx	[5]

Depends on

• CodeScanInit
• CodeScanMatch_func
• CodeScanMatch_type
• CodeScanner_state
• DisasmContext_cip
• DisasmContext_end_ip
• DisasmContext_nip
• DisasmContext_start_ip

Estimated stack usage

4 cells

CodeScanGetHoleCount:

Syntax

CodeScanGetHoleCount(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_hole_count

Estimated stack usage

1 cells

CodeScanGetMatchAddress:

Syntax

CodeScanGetMatchAddress(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_cip
• gDat

Estimated stack usage

1 cells

CodeScanGetMatchAddressData:

Syntax

CodeScanGetMatchAddressData(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_cip

Estimated stack usage

1 cells

CodeScanGetMatchAsm:

Syntax

CodeScanGetMatchAsm(csm[], ctx[], offset)

Parameters

Name	Info
csm	[172]
ctx	[21]
offset

Depends on

• AsmInitPtr
• CodeScanMatch_cip
• cellmax

Estimated stack usage

6 cells

CodeScanGetMatchDisasm:

Syntax

CodeScanGetMatchDisasm(csm[], ctx[], offset)

Parameters

Name	Info
csm	[172]
ctx	[5]
offset

Depends on

• CodeScanMatch_cip
• DisasmContext_cip
• DisasmContext_end_ip
• DisasmContext_nip
• DisasmContext_start_ip

Estimated stack usage

1 cells

CodeScanGetMatchFunc:

Syntax

CodeScanGetMatchFunc(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_func
• gDat

Estimated stack usage

1 cells

CodeScanGetMatchFuncData:

Syntax

CodeScanGetMatchFuncData(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_func

Estimated stack usage

1 cells

CodeScanGetMatchHeap:

Syntax

CodeScanGetMatchHeap(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_heap

Estimated stack usage

1 cells

CodeScanGetMatchHole:

Syntax

CodeScanGetMatchHole(csm[], idx)

Parameters

Name	Info
csm	[172]
idx

Depends on

• CodeScanMatch_holes

Estimated stack usage

1 cells

CodeScanGetMatchLength:

Syntax

CodeScanGetMatchLength(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_size

Estimated stack usage

1 cells

CodeScanGetMatchName:

Syntax

CodeScanGetMatchName(csm[], name[])

Parameters

Name	Info
csm	[172]
name	[]

Depends on

• CodeScanGetMatchType
• CodeScanMatch_name
• CodeScanMatch_type
• strcat

Estimated stack usage

5 cells

CodeScanGetMatchScanner:

Syntax

CodeScanGetMatchScanner(csm[], ret[], ctx[], accurate)

Parameters

Name	Info
csm	[172]
ret	[172]
ctx	[5]
accurate	bool

Depends on

• CodeScanGetFunctionScanner
• CodeScanMatch_cip
• CodeScanStepInternal
• CodeScanner_param
• CodeScanner_state
• DisasmContext_cip
• DisasmContext_nip
• DisasmContext_start_ip
• cellmin

Estimated stack usage

8 cells

CodeScanGetMatchStack:

Syntax

CodeScanGetMatchStack(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_stack

Estimated stack usage

1 cells

CodeScanGetMatchType:

Syntax

CodeScanGetMatchType(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanGetFuncName
• CodeScanMatch_func
• CodeScanMatch_name
• CodeScanMatch_type

Estimated stack usage

5 cells

CodeScanInit:

Syntax

CodeScanInit(scanner[])

Parameters

Name	Info
scanner	[172]

Depends on

• AMX_HDR_COD
• AMX_HDR_DAT
• CodeScanMatch_cip
• CodeScanMatch_heap
• CodeScanMatch_name
• CodeScanMatch_params
• CodeScanMatch_stack
• CodeScanMatch_type
• CodeScanResetJumpTargets
• CodeScanner_first
• CodeScanner_param
• CodeScanner_state
• GetAmxBaseAddress
• GetAmxHeader
• OP_CASETBL
• OP_NOP
• RelocateOpcode
• cellmin
• gBase
• gCodBase
• gDat
• gHdr
• gOP_CASETBL
• gOP_NOP

Estimated stack usage

5 cells

CodeScanMatcherData:

Syntax

CodeScanMatcherData(searcher[], val)

Parameters

Name	Info
searcher	[171]
val

Depends on

• CodeScanMatcher_flags
• CodeScanMatcher_user_data

Estimated stack usage

1 cells

CodeScanMatcherInit_:

Syntax

CodeScanMatcherInit_(searcher[], address, flags)

Parameters

Name	Info
searcher	[171]
address
flags

Depends on

• CodeScanMatcher_flags
• CodeScanMatcher_func
• CodeScanMatcher_holeidx
• CodeScanMatcher_len
• CodeScanMatcher_next
• CodeScanMatcher_offset
• CodeScanMatcher_user_data
• IsOpcodeRelocationRequired
• OP_NOP
• RelocateOpcode
• gRelocateRequired
• printf

Estimated stack usage

4 cells

CodeScanMatcherPattern_:

Syntax

CodeScanMatcherPattern_(searcher[], ...)

Parameters

Name	Info
searcher	[171]
...	{Opcode,Float,_}

Depends on

• CodeScanMatcher_code
• CodeScanMatcher_len
• CodeScanMatcher_type
• __COMPILER_CELL_SHIFT
• __args_offset
• gAMXOpcodeParameterCounts
• getarg

Estimated stack usage

11 cells

CodeScanNOPMatch:

Syntax

CodeScanNOPMatch(csm[])

Parameters

Name	Info
csm	[172]

Depends on

• CodeScanMatch_cip
• CodeScanMatch_size
• cellbytes
• gOP_NOP

Estimated stack usage

3 cells

CodeScanReset:

Syntax

CodeScanReset(cs[], matcher__, &next)

Parameters

Name	Info
cs	[171]
matcher__
next	&

Depends on

• CodeScanMatcher_func
• CodeScanMatcher_holeidx
• CodeScanMatcher_len
• CodeScanMatcher_next
• CodeScanMatcher_offset

Estimated stack usage

1 cells

CodeScanResetJumpTargets:

Syntax

CodeScanResetJumpTargets(jumpTargets[], num)

Parameters

Name	Info
jumpTargets	[172]
num

Depends on

• CodeScanner_jump_target
• CodeScanner_minn
• cellmin

Estimated stack usage

1 cells

CodeScanRun:

Syntax

CodeScanRun(csState[])

Parameters

Name	Info
csState	[172]

Tag

bool:

Depends on

• CodeScanCall
• CodeScanCheck
• CodeScanMatch_cip
• CodeScanMatch_func
• CodeScanReset
• CodeScanStepInternal
• CodeScanner_first
• DisasmContext
• DisasmContext_cip
• DisasmContext_end_ip
• DisasmContext_nip
• DisasmContext_opcode
• DisasmContext_start_ip
• OP_NONE
• cellmin
• gFakeMatcher
• true

Estimated stack usage

18 cells

CodeScanRunFast:

Syntax

CodeScanRunFast(csState[], searchFuncAddr)

Parameters

Name	Info
csState	[172]
searchFuncAddr

Tag

bool:

Depends on

• CodeScanCall
• CodeScanCheck
• CodeScanFindOneFastPattern2
• CodeScanMatch_cip
• CodeScanReset
• CodeScanRun
• CodeScanRunFastPrescanLocated
• CodeScanRunFastPrescanRelocate
• CodeScanStepInternal
• CodeScanner_first
• DisasmContext
• DisasmContext_cip
• DisasmContext_end_ip
• DisasmContext_nip
• DisasmContext_opcode
• DisasmContext_start_ip
• DisasmGetOpcode
• OP_NONE
• OP_PROC
• cellbytes
• cellmin
• false
• gDat
• gFakeMatcher
• gRelocateRequired
• print
• true

Estimated stack usage

21 cells

CodeScanRunFastPrescanLocated:

Syntax

CodeScanRunFastPrescanLocated(&proc, &nextaddr, searchFuncAddr)

Parameters

Name	Info
proc	&
nextaddr	&
searchFuncAddr

Depends on

• OP_CALL
• OP_CASETBL
• OP_NONE
• OP_PROC
• cellbytes
• cellmin
• false
• gAMXOpcodeBaseSizes
• gAmxAssemblyAddress_
• gCodBase
• true

Estimated stack usage

3 cells

CodeScanRunFastPrescanRelocate:

Syntax

CodeScanRunFastPrescanRelocate(&proc, &nextaddr, searchFuncAddr)

Parameters

Name	Info
proc	&
nextaddr	&
searchFuncAddr

Depends on

• OP_CALL
• OP_CASETBL
• OP_NONE
• OP_PROC
• UnrelocateOpcode
• cellbytes
• cellmin
• false
• gAMXOpcodeBaseSizes
• gAmxAssemblyAddress_
• gCodBase
• true

Estimated stack usage

6 cells

CodeScanStep:

Syntax

CodeScanStep(dctx[], csState[])

Parameters

Name	Info
dctx	[5]
csState	[172]

Tag

bool:

Depends on

• CodeScanStepInternal
• CodeScanner_param
• CodeScanner_state
• cellmin

Estimated stack usage

8 cells

CodeScanStepInternal:

Syntax

CodeScanStepInternal(dctx[], csState[], &parseState, &parseParam)

Parameters

Name	Info
dctx	[5]
csState	[172]
parseState	&
parseParam	&

Tag

bool:

Depends on

• CodeScanAddJumpTarget
• CodeScanAddSwitchTarget
• CodeScanCheckJumpTarget
• CodeScanMatch_func
• CodeScanMatch_heap
• CodeScanMatch_stack
• CodeScanMatch_type
• CodeScanResetJumpTargets
• DisasmContext_cip
• DisasmContext_end_ip
• DisasmContext_nip
• DisasmContext_opcode
• NUM_OPCODES
• OP_ADD_C
• OP_BOUNDS
• OP_BREAK
• OP_CALL
• OP_CALL_PRI
• OP_CASETBL
• OP_HALT
• OP_HEAP
• OP_JEQ
• OP_JGEQ
• OP_JGRTR
• OP_JLEQ
• OP_JLESS
• OP_JNEQ
• OP_JNZ
• OP_JREL
• OP_JSGEQ
• OP_JSGRTR
• OP_JSLEQ
• OP_JSLESS
• OP_JUMP
• OP_JZER
• OP_LCTRL
• OP_LOAD_PRI
• OP_NONE
• OP_NOP
• OP_POP_ALT
• OP_POP_PRI
• OP_PROC
• OP_PUSH
• OP_PUSH_ADR
• OP_PUSH_ALT
• OP_PUSH_C
• OP_PUSH_PRI
• OP_PUSH_R
• OP_PUSH_S
• OP_RETN
• OP_SCTRL
• OP_STACK
• OP_SWITCH
• UnsafeUnrelocateOpcode
• cellbytes
• cellmin
• false
• gAMXOpcodeBaseSizes
• gAmxAssemblyAddress_
• gBase
• true

Estimated stack usage

13 cells