DirectMappingKeystoneNative (Keystone Java bindings 0.9.7 API)

java.lang.Object
- keystone.natives.DirectMappingKeystoneNative

```
public final class DirectMappingKeystoneNative
extends Object
```
The class providing the native functions of Keystone using the Direct Mapping of JNA for best performance.
The original function prototypes are declared in the header file keystone.h.

另请参阅:

JNA: Direct Mapping

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static boolean`	`ks_arch_supported(KeystoneArchitecture architecture)` Determine if the given architecture is supported by this library.
`static int`	`ks_asm(com.sun.jna.Pointer engine, String assembly, long address, com.sun.jna.ptr.PointerByReference machineCodeBuffer, com.sun.jna.ptr.IntByReference machineCodeSize, com.sun.jna.ptr.IntByReference numberOfStatements)` Assemble a string given its the buffer, size, start address and number of instructions to be decoded.
`static KeystoneError`	`ks_close(com.sun.jna.Pointer engine)` Close KS instance: MUST do to release the handle when it is not used anymore.
`static KeystoneError`	`ks_errno(com.sun.jna.Pointer engine)` Report the last error number when some API function fail.
`static void`	`ks_free(com.sun.jna.Pointer machineCodeBuffer)` Free memory allocated by ks_asm().
`static KeystoneError`	`ks_open(KeystoneArchitecture architecture, KeystoneMode mode, com.sun.jna.ptr.PointerByReference engine)` Create new instance of Keystone engine.
`static KeystoneError`	`ks_option(com.sun.jna.Pointer engine, KeystoneOptionType type, int value)` Set option for Keystone engine at runtime.
`static KeystoneError`	`ks_option(com.sun.jna.Pointer engine, KeystoneOptionType type, SymbolResolverCallback callback)` Set option for Keystone engine at runtime Native function prototype: err ks_option(ks_engine ks, ks_opt_type type, size_t value);*
`static String`	`ks_strerror(KeystoneError errorCode)` Return a string describing given error code.
`static int`	`ks_version(com.sun.jna.ptr.IntByReference major, com.sun.jna.ptr.IntByReference minor)` Returns combined API version & major and minor version numbers.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - ks_arch_supported
```
public static boolean ks_arch_supported(KeystoneArchitecture architecture)
```
    Determine if the given architecture is supported by this library.
    Native function prototype: bool ks_arch_supported(ks_arch arch);
    
    参数:
    
    architecture - architecture type
    
    返回:
    
    true if this library supports the given arch.
  - ks_asm
```
public static int ks_asm(com.sun.jna.Pointer engine,
                         String assembly,
                         long address,
                         com.sun.jna.ptr.PointerByReference machineCodeBuffer,
                         com.sun.jna.ptr.IntByReference machineCodeSize,
                         com.sun.jna.ptr.IntByReference numberOfStatements)
```
    Assemble a string given its the buffer, size, start address and number of instructions to be decoded. This API dynamically allocate memory to contain assembled instruction. Resulted array of bytes containing the machine code is put into @machineCode.
    On failure, call ks_errno(com.sun.jna.Pointer) for error code.
    NOTE 1: this API will automatically determine memory needed to contain output bytes in *encoding.
    NOTE 2: caller must free the allocated memory itself to avoid memory leaking.
    Native function prototype: int ks_asm(ks_engine *ks, const char *string, uint64_t address, unsigned char **encoding, size_t *encoding_size, size_t *stat_count);
    
    参数:
    
    engine - handle returned by ks_open()
    
    assembly - NULL-terminated assembly string. Use ; or \n to separate statements.
    
    address - address of the first assembly instruction, or 0 to ignore.
    
    machineCodeBuffer - array of bytes containing encoding of input assembly string. NOTE: *encoding will be allocated by this function, and should be freed with ks_free() function.
    
    machineCodeSize - size of machineCode
    
    numberOfStatements - number of statements successfully processed
    
    返回:
    
    0 on success, or -1 on failure.
  - ks_close
```
public static KeystoneError ks_close(com.sun.jna.Pointer engine)
```
    Close KS instance: MUST do to release the handle when it is not used anymore. NOTE: this must be called only when there is no longer usage of Keystone. The reason is this API releases some cached memory, thus access to any Keystone API after ks_close() might crash your application. After this, @engine is invalid, and no longer usable.
    Native function prototype: ks_err ks_close(ks_engine *ks);
    
    参数:
    
    engine - pointer to a handle returned by ks_open().
    
    返回:
    
    KS_ERR_OK on success, or other value on failure (refer to ks_err enum for detailed error).
  - ks_errno
```
public static KeystoneError ks_errno(com.sun.jna.Pointer engine)
```
    Report the last error number when some API function fail. Like glibc's errno, ks_errno might not retain its old error once accessed.
    Native function prototype: ks_err ks_errno(ks_engine *ks)
    
    参数:
    
    engine - handle returned by ks_open()
    
    返回:
    
    error code of ks_err enum type KeystoneError
  - ks_free
```
public static void ks_free(com.sun.jna.Pointer machineCodeBuffer)
```
    Free memory allocated by ks_asm().
    Native function prototype: void ks_free(unsigned char *p)
    
    参数:
    
    machineCodeBuffer - memory allocated in @encoding argument of ks_asm()
  - ks_open
```
public static KeystoneError ks_open(KeystoneArchitecture architecture,
                                    KeystoneMode mode,
                                    com.sun.jna.ptr.PointerByReference engine)
```
    Create new instance of Keystone engine.
    Native function prototype: ks_err ks_open(ks_arch arch, int mode, ks_engine **ks);
    
    参数:
    
    architecture - architecture type (KS_ARCH_*).
    
    mode - hardware mode. This is combined of KS_MODE_*.
    
    engine - pointer to ks_engine, which will be updated at return time.
    
    返回:
    
    KS_ERR_OK on success, or other value on failure (refer to ks_err enum for detailed error).
  - ks_option
```
public static KeystoneError ks_option(com.sun.jna.Pointer engine,
                                      KeystoneOptionType type,
                                      int value)
```
    Set option for Keystone engine at runtime.
    Native function prototype: err ks_option(ks_engine *ks, ks_opt_type type, size_t value);
    
    参数:
    
    engine - handle returned by ks_open()
    
    type - type of option to be set. See KeystoneOptionType
    
    value - option value corresponding with @type
    
    返回:
    
    KeystoneError.Ok on success, or other value on failure. Refer to KeystoneError enum for detailed error.
  - ks_option
```
public static KeystoneError ks_option(com.sun.jna.Pointer engine,
                                      KeystoneOptionType type,
                                      SymbolResolverCallback callback)
```
    Set option for Keystone engine at runtime
    Native function prototype: err ks_option(ks_engine *ks, ks_opt_type type, size_t value);
    
    参数:
    
    engine - handle returned by ks_open()
    
    type - ype of option to be set. See KeystoneOptionType
    
    callback - callback to resolve a unrecognized symbol.
    
    返回:
    
    KeystoneError.Ok on success, or other value on failure. Refer to KeystoneError enum for detailed error.
  - ks_strerror
```
public static String ks_strerror(KeystoneError errorCode)
```
    Return a string describing given error code.
    Native function prototype: const char *ks_strerror(ks_err code);
    
    参数:
    
    errorCode - error code.
    
    返回:
    
    returns a pointer to a string that describes the error code passed in the argument @errorCode.
  - ks_version
```
public static int ks_version(com.sun.jna.ptr.IntByReference major,
                             com.sun.jna.ptr.IntByReference minor)
```
    Returns combined API version & major and minor version numbers.
    Native function prototype: unsigned int ks_version(unsigned int *major, unsigned int *minor);
    
    参数:
    
    major - The major number of API version.
    
    minor - The minor number of API version.
    
    返回:
    
    An hexadecimal number as (major << 8 | minor), which encodes both major & minor versions.

类 DirectMappingKeystoneNative

方法概要

从类继承的方法 java.lang.Object

方法详细资料

ks_arch_supported

ks_asm

ks_close

ks_errno

ks_free

ks_open

ks_option

ks_option

ks_strerror

ks_version