keystone.h File Reference

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdbool.h>
#include "arm64.h"
#include "arm.h"
#include "evm.h"
#include "hexagon.h"
#include "mips.h"
#include "ppc.h"
#include "riscv.h"
#include "sparc.h"
#include "systemz.h"
#include "x86.h"

Go to the source code of this file.

Macros
#define	KEYSTONE_EXPORT
#define	KS_API_MAJOR   0
#define	KS_API_MINOR   9
#define	KS_VERSION_MAJOR   KS_API_MAJOR
#define	KS_VERSION_MINOR   KS_API_MINOR
#define	KS_VERSION_EXTRA   2
#define	KS_MAKE_VERSION(major, minor)   ((major << 8) + minor)
#define	KS_ERR_ASM   128
#define	KS_ERR_ASM_ARCH   512

Typedefs
typedef struct ks_struct	ks_engine
typedef enum ks_arch	ks_arch
typedef enum ks_mode	ks_mode
typedef enum ks_err	ks_err
typedef bool(*	ks_sym_resolver) (const char *symbol, uint64_t *value)
typedef enum ks_opt_type	ks_opt_type
typedef enum ks_opt_value	ks_opt_value

Enumerations
enum	ks_arch {   KS_ARCH_ARM = 1 , KS_ARCH_ARM64 , KS_ARCH_MIPS , KS_ARCH_X86 ,   KS_ARCH_PPC , KS_ARCH_SPARC , KS_ARCH_SYSTEMZ , KS_ARCH_HEXAGON ,   KS_ARCH_EVM , KS_ARCH_RISCV , KS_ARCH_MAX }
enum	ks_mode {   KS_MODE_LITTLE_ENDIAN = 0 , KS_MODE_BIG_ENDIAN = 1 << 30 , KS_MODE_ARM = 1 << 0 , KS_MODE_THUMB = 1 << 4 ,   KS_MODE_V8 = 1 << 6 , KS_MODE_MICRO = 1 << 4 , KS_MODE_MIPS3 = 1 << 5 , KS_MODE_MIPS32R6 = 1 << 6 ,   KS_MODE_MIPS32 = 1 << 2 , KS_MODE_MIPS64 = 1 << 3 , KS_MODE_16 = 1 << 1 , KS_MODE_32 = 1 << 2 ,   KS_MODE_64 = 1 << 3 , KS_MODE_PPC32 = 1 << 2 , KS_MODE_PPC64 = 1 << 3 , KS_MODE_QPX = 1 << 4 ,   KS_MODE_RISCV32 = 1 << 2 , KS_MODE_RISCV64 = 1 << 3 , KS_MODE_SPARC32 = 1 << 2 , KS_MODE_SPARC64 = 1 << 3 ,   KS_MODE_V9 = 1 << 4 }
enum	ks_err {   KS_ERR_OK = 0 , KS_ERR_NOMEM , KS_ERR_ARCH , KS_ERR_HANDLE ,   KS_ERR_MODE , KS_ERR_VERSION , KS_ERR_OPT_INVALID , KS_ERR_ASM_EXPR_TOKEN = KS_ERR_ASM ,   KS_ERR_ASM_DIRECTIVE_VALUE_RANGE , KS_ERR_ASM_DIRECTIVE_ID , KS_ERR_ASM_DIRECTIVE_TOKEN , KS_ERR_ASM_DIRECTIVE_STR ,   KS_ERR_ASM_DIRECTIVE_COMMA , KS_ERR_ASM_DIRECTIVE_RELOC_NAME , KS_ERR_ASM_DIRECTIVE_RELOC_TOKEN , KS_ERR_ASM_DIRECTIVE_FPOINT ,   KS_ERR_ASM_DIRECTIVE_UNKNOWN , KS_ERR_ASM_DIRECTIVE_EQU , KS_ERR_ASM_DIRECTIVE_INVALID , KS_ERR_ASM_VARIANT_INVALID ,   KS_ERR_ASM_EXPR_BRACKET , KS_ERR_ASM_SYMBOL_MODIFIER , KS_ERR_ASM_SYMBOL_REDEFINED , KS_ERR_ASM_SYMBOL_MISSING ,   KS_ERR_ASM_RPAREN , KS_ERR_ASM_STAT_TOKEN , KS_ERR_ASM_UNSUPPORTED , KS_ERR_ASM_MACRO_TOKEN ,   KS_ERR_ASM_MACRO_PAREN , KS_ERR_ASM_MACRO_EQU , KS_ERR_ASM_MACRO_ARGS , KS_ERR_ASM_MACRO_LEVELS_EXCEED ,   KS_ERR_ASM_MACRO_STR , KS_ERR_ASM_MACRO_INVALID , KS_ERR_ASM_ESC_BACKSLASH , KS_ERR_ASM_ESC_OCTAL ,   KS_ERR_ASM_ESC_SEQUENCE , KS_ERR_ASM_ESC_STR , KS_ERR_ASM_TOKEN_INVALID , KS_ERR_ASM_INSN_UNSUPPORTED ,   KS_ERR_ASM_FIXUP_INVALID , KS_ERR_ASM_LABEL_INVALID , KS_ERR_ASM_FRAGMENT_INVALID , KS_ERR_ASM_INVALIDOPERAND = KS_ERR_ASM_ARCH ,   KS_ERR_ASM_MISSINGFEATURE , KS_ERR_ASM_MNEMONICFAIL }
enum	ks_opt_type { KS_OPT_SYNTAX = 1 , KS_OPT_SYM_RESOLVER }
enum	ks_opt_value {   KS_OPT_SYNTAX_INTEL = 1 << 0 , KS_OPT_SYNTAX_ATT = 1 << 1 , KS_OPT_SYNTAX_NASM = 1 << 2 , KS_OPT_SYNTAX_MASM = 1 << 3 ,   KS_OPT_SYNTAX_GAS = 1 << 4 , KS_OPT_SYNTAX_RADIX16 = 1 << 5 }

Functions
KEYSTONE_EXPORT unsigned int	ks_version (unsigned int *major, unsigned int *minor)
KEYSTONE_EXPORT bool	ks_arch_supported (ks_arch arch)
KEYSTONE_EXPORT ks_err	ks_open (ks_arch arch, int mode, ks_engine **ks)
KEYSTONE_EXPORT ks_err	ks_close (ks_engine *ks)
KEYSTONE_EXPORT ks_err	ks_errno (ks_engine *ks)
KEYSTONE_EXPORT const char *	ks_strerror (ks_err code)
KEYSTONE_EXPORT ks_err	ks_option (ks_engine *ks, ks_opt_type type, size_t value)
KEYSTONE_EXPORT int	ks_asm (ks_engine *ks, const char *string, uint64_t address, unsigned char **encoding, size_t *encoding_size, size_t *stat_count)
KEYSTONE_EXPORT void	ks_free (unsigned char *p)

Macro Definition Documentation

KEYSTONE_EXPORT

#define KEYSTONE_EXPORT

KS_API_MAJOR

#define KS_API_MAJOR   0

KS_API_MINOR

#define KS_API_MINOR   9

KS_ERR_ASM

#define KS_ERR_ASM   128

KS_ERR_ASM_ARCH

#define KS_ERR_ASM_ARCH   512

KS_MAKE_VERSION

#define KS_MAKE_VERSION	(		major,
			minor )   ((major << 8) + minor)

KS_VERSION_EXTRA

#define KS_VERSION_EXTRA   2

KS_VERSION_MAJOR

#define KS_VERSION_MAJOR   KS_API_MAJOR

KS_VERSION_MINOR

#define KS_VERSION_MINOR   KS_API_MINOR

Typedef Documentation

ks_arch

typedef enum ks_arch ks_arch

ks_engine

typedef struct ks_struct ks_engine

ks_err

typedef enum ks_err ks_err

ks_mode

typedef enum ks_mode ks_mode

ks_opt_type

typedef enum ks_opt_type ks_opt_type

ks_opt_value

typedef enum ks_opt_value ks_opt_value

ks_sym_resolver

typedef bool(* ks_sym_resolver) (const char *symbol, uint64_t *value)

Enumeration Type Documentation

ks_arch

enum ks_arch

Enumerator
KS_ARCH_ARM
KS_ARCH_ARM64
KS_ARCH_MIPS
KS_ARCH_X86
KS_ARCH_PPC
KS_ARCH_SPARC
KS_ARCH_SYSTEMZ
KS_ARCH_HEXAGON
KS_ARCH_EVM
KS_ARCH_RISCV
KS_ARCH_MAX

{
    KS_ARCH_ARM = 1, // ARM architecture (including Thumb, Thumb-2)
    KS_ARCH_ARM64,   // ARM-64, also called AArch64
    KS_ARCH_MIPS,    // Mips architecture
    KS_ARCH_X86,     // X86 architecture (including x86 & x86-64)
    KS_ARCH_PPC,     // PowerPC architecture (currently unsupported)
    KS_ARCH_SPARC,   // Sparc architecture
    KS_ARCH_SYSTEMZ, // SystemZ architecture (S390X)
    KS_ARCH_HEXAGON, // Hexagon architecture
    KS_ARCH_EVM,     // Ethereum Virtual Machine architecture
    KS_ARCH_RISCV,   // RISC-V architecture
    KS_ARCH_MAX,
} ks_arch;

ks_err

enum ks_err

Enumerator
KS_ERR_OK
KS_ERR_NOMEM
KS_ERR_ARCH
KS_ERR_HANDLE
KS_ERR_MODE
KS_ERR_VERSION
KS_ERR_OPT_INVALID
KS_ERR_ASM_EXPR_TOKEN
KS_ERR_ASM_DIRECTIVE_VALUE_RANGE
KS_ERR_ASM_DIRECTIVE_ID
KS_ERR_ASM_DIRECTIVE_TOKEN
KS_ERR_ASM_DIRECTIVE_STR
KS_ERR_ASM_DIRECTIVE_COMMA
KS_ERR_ASM_DIRECTIVE_RELOC_NAME
KS_ERR_ASM_DIRECTIVE_RELOC_TOKEN
KS_ERR_ASM_DIRECTIVE_FPOINT
KS_ERR_ASM_DIRECTIVE_UNKNOWN
KS_ERR_ASM_DIRECTIVE_EQU
KS_ERR_ASM_DIRECTIVE_INVALID
KS_ERR_ASM_VARIANT_INVALID
KS_ERR_ASM_EXPR_BRACKET
KS_ERR_ASM_SYMBOL_MODIFIER
KS_ERR_ASM_SYMBOL_REDEFINED
KS_ERR_ASM_SYMBOL_MISSING
KS_ERR_ASM_RPAREN
KS_ERR_ASM_STAT_TOKEN
KS_ERR_ASM_UNSUPPORTED
KS_ERR_ASM_MACRO_TOKEN
KS_ERR_ASM_MACRO_PAREN
KS_ERR_ASM_MACRO_EQU
KS_ERR_ASM_MACRO_ARGS
KS_ERR_ASM_MACRO_LEVELS_EXCEED
KS_ERR_ASM_MACRO_STR
KS_ERR_ASM_MACRO_INVALID
KS_ERR_ASM_ESC_BACKSLASH
KS_ERR_ASM_ESC_OCTAL
KS_ERR_ASM_ESC_SEQUENCE
KS_ERR_ASM_ESC_STR
KS_ERR_ASM_TOKEN_INVALID
KS_ERR_ASM_INSN_UNSUPPORTED
KS_ERR_ASM_FIXUP_INVALID
KS_ERR_ASM_LABEL_INVALID
KS_ERR_ASM_FRAGMENT_INVALID
KS_ERR_ASM_INVALIDOPERAND
KS_ERR_ASM_MISSINGFEATURE
KS_ERR_ASM_MNEMONICFAIL

{
    KS_ERR_OK = 0,      // No error: everything was fine
    KS_ERR_NOMEM,       // Out-Of-Memory error: ks_open(), ks_emulate()
    KS_ERR_ARCH,        // Unsupported architecture: ks_open()
    KS_ERR_HANDLE,      // Invalid handle
    KS_ERR_MODE,        // Invalid/unsupported mode: ks_open()
    KS_ERR_VERSION,     // Unsupported version (bindings)
    KS_ERR_OPT_INVALID, // Unsupported option
 
    // generic input assembly errors - parser specific
    KS_ERR_ASM_EXPR_TOKEN = KS_ERR_ASM, // unknown token in expression
    KS_ERR_ASM_DIRECTIVE_VALUE_RANGE,   // literal value out of range for directive
    KS_ERR_ASM_DIRECTIVE_ID,            // expected identifier in directive
    KS_ERR_ASM_DIRECTIVE_TOKEN,         // unexpected token in directive
    KS_ERR_ASM_DIRECTIVE_STR,           // expected string in directive
    KS_ERR_ASM_DIRECTIVE_COMMA,         // expected comma in directive
    KS_ERR_ASM_DIRECTIVE_RELOC_NAME,    // expected relocation name in directive
    KS_ERR_ASM_DIRECTIVE_RELOC_TOKEN,   // unexpected token in .reloc directive
    KS_ERR_ASM_DIRECTIVE_FPOINT,        // invalid floating point in directive
    KS_ERR_ASM_DIRECTIVE_UNKNOWN,       // unknown directive
    KS_ERR_ASM_DIRECTIVE_EQU,           // invalid equal directive
    KS_ERR_ASM_DIRECTIVE_INVALID,       // (generic) invalid directive
    KS_ERR_ASM_VARIANT_INVALID,         // invalid variant
    KS_ERR_ASM_EXPR_BRACKET,            // brackets expression not supported on this target
    KS_ERR_ASM_SYMBOL_MODIFIER,         // unexpected symbol modifier following '@'
    KS_ERR_ASM_SYMBOL_REDEFINED,        // invalid symbol redefinition
    KS_ERR_ASM_SYMBOL_MISSING,          // cannot find a symbol
    KS_ERR_ASM_RPAREN,                  // expected ')' in parentheses expression
    KS_ERR_ASM_STAT_TOKEN,              // unexpected token at start of statement
    KS_ERR_ASM_UNSUPPORTED,             // unsupported token yet
    KS_ERR_ASM_MACRO_TOKEN,             // unexpected token in macro instantiation
    KS_ERR_ASM_MACRO_PAREN,             // unbalanced parentheses in macro argument
    KS_ERR_ASM_MACRO_EQU,               // expected '=' after formal parameter identifier
    KS_ERR_ASM_MACRO_ARGS,              // too many positional arguments
    KS_ERR_ASM_MACRO_LEVELS_EXCEED,     // macros cannot be nested more than 20 levels deep
    KS_ERR_ASM_MACRO_STR,               // invalid macro string
    KS_ERR_ASM_MACRO_INVALID,           // invalid macro (generic error)
    KS_ERR_ASM_ESC_BACKSLASH,           // unexpected backslash at end of escaped string
    KS_ERR_ASM_ESC_OCTAL,               // invalid octal escape sequence  (out of range)
    KS_ERR_ASM_ESC_SEQUENCE,            // invalid escape sequence (unrecognized character)
    KS_ERR_ASM_ESC_STR,                 // broken escape string
    KS_ERR_ASM_TOKEN_INVALID,           // invalid token
    KS_ERR_ASM_INSN_UNSUPPORTED,        // this instruction is unsupported in this mode
    KS_ERR_ASM_FIXUP_INVALID,           // invalid fixup
    KS_ERR_ASM_LABEL_INVALID,           // invalid label
    KS_ERR_ASM_FRAGMENT_INVALID,        // invalid fragment
 
    // generic input assembly errors - architecture specific
    KS_ERR_ASM_INVALIDOPERAND = KS_ERR_ASM_ARCH,
    KS_ERR_ASM_MISSINGFEATURE,
    KS_ERR_ASM_MNEMONICFAIL,
} ks_err;

ks_mode

enum ks_mode

Enumerator
KS_MODE_LITTLE_ENDIAN
KS_MODE_BIG_ENDIAN
KS_MODE_ARM
KS_MODE_THUMB
KS_MODE_V8
KS_MODE_MICRO
KS_MODE_MIPS3
KS_MODE_MIPS32R6
KS_MODE_MIPS32
KS_MODE_MIPS64
KS_MODE_16
KS_MODE_32
KS_MODE_64
KS_MODE_PPC32
KS_MODE_PPC64
KS_MODE_QPX
KS_MODE_RISCV32
KS_MODE_RISCV64
KS_MODE_SPARC32
KS_MODE_SPARC64
KS_MODE_V9

{
    KS_MODE_LITTLE_ENDIAN = 0,       // little-endian mode (default mode)
    KS_MODE_BIG_ENDIAN    = 1 << 30, // big-endian mode
    // arm / arm64
    KS_MODE_ARM   = 1 << 0, // ARM mode
    KS_MODE_THUMB = 1 << 4, // THUMB mode (including Thumb-2)
    KS_MODE_V8    = 1 << 6, // ARMv8 A32 encodings for ARM
    // mips
    KS_MODE_MICRO    = 1 << 4, // MicroMips mode
    KS_MODE_MIPS3    = 1 << 5, // Mips III ISA
    KS_MODE_MIPS32R6 = 1 << 6, // Mips32r6 ISA
    KS_MODE_MIPS32   = 1 << 2, // Mips32 ISA
    KS_MODE_MIPS64   = 1 << 3, // Mips64 ISA
    // x86 / x64
    KS_MODE_16 = 1 << 1, // 16-bit mode
    KS_MODE_32 = 1 << 2, // 32-bit mode
    KS_MODE_64 = 1 << 3, // 64-bit mode
    // ppc
    KS_MODE_PPC32 = 1 << 2, // 32-bit mode
    KS_MODE_PPC64 = 1 << 3, // 64-bit mode
    KS_MODE_QPX   = 1 << 4, // Quad Processing eXtensions mode
                          // riscv
    KS_MODE_RISCV32 = 1 << 2, // 32-bit mode
    KS_MODE_RISCV64 = 1 << 3, // 64-bit mode
    // sparc
    KS_MODE_SPARC32 = 1 << 2, // 32-bit mode
    KS_MODE_SPARC64 = 1 << 3, // 64-bit mode
    KS_MODE_V9      = 1 << 4, // SparcV9 mode
} ks_mode;

ks_opt_type

enum ks_opt_type

Enumerator
KS_OPT_SYNTAX
KS_OPT_SYM_RESOLVER

{
    KS_OPT_SYNTAX = 1,   // Choose syntax for input assembly
    KS_OPT_SYM_RESOLVER, // Set symbol resolver callback
} ks_opt_type;

ks_opt_value

enum ks_opt_value

Enumerator
KS_OPT_SYNTAX_INTEL
KS_OPT_SYNTAX_ATT
KS_OPT_SYNTAX_NASM
KS_OPT_SYNTAX_MASM
KS_OPT_SYNTAX_GAS
KS_OPT_SYNTAX_RADIX16

{
    KS_OPT_SYNTAX_INTEL   = 1 << 0, // X86 Intel syntax - default on X86 (KS_OPT_SYNTAX).
    KS_OPT_SYNTAX_ATT     = 1 << 1, // X86 ATT asm syntax (KS_OPT_SYNTAX).
    KS_OPT_SYNTAX_NASM    = 1 << 2, // X86 Nasm syntax (KS_OPT_SYNTAX).
    KS_OPT_SYNTAX_MASM    = 1 << 3, // X86 Masm syntax (KS_OPT_SYNTAX) - unsupported yet.
    KS_OPT_SYNTAX_GAS     = 1 << 4, // X86 GNU GAS syntax (KS_OPT_SYNTAX).
    KS_OPT_SYNTAX_RADIX16 = 1 << 5, // All immediates are in hex format (i.e 12 is 0x12)
} ks_opt_value;

Function Documentation

ks_arch_supported()

KEYSTONE_EXPORT bool ks_arch_supported

(

ks_arch

arch

)

ks_asm()

KEYSTONE_EXPORT int ks_asm	(	ks_engine *	ks,
		const char *	string,
		uint64_t	address,
		unsigned char **	encoding,
		size_t *	encoding_size,
		size_t *	stat_count )

ks_close()

KEYSTONE_EXPORT ks_err ks_close

(

ks_engine *

ks

)

ks_errno()

KEYSTONE_EXPORT ks_err ks_errno

(

ks_engine *

ks

)

ks_free()

KEYSTONE_EXPORT void ks_free

(

unsigned char *

p

)

ks_open()

KEYSTONE_EXPORT ks_err ks_open	(	ks_arch	arch,
		int	mode,
		ks_engine **	ks )

ks_option()

KEYSTONE_EXPORT ks_err ks_option	(	ks_engine *	ks,
		ks_opt_type	type,
		size_t	value )

ks_strerror()

KEYSTONE_EXPORT const char * ks_strerror

(

ks_err

code

)

ks_version()

KEYSTONE_EXPORT unsigned int ks_version	(	unsigned int *	major,
		unsigned int *	minor )