Copyright	(c) Adrian Herrera 2016
License	GPL-2
Safe Haskell	Safe-Inferred
Language	Haskell2010

Heystone

Contents

Assembler control
Error handling
Misc.

Description

Keystone is a lightweight multi-platform, multi-architecture assembler framework.

Further information is available at http://www.keystone-engine.org.

Synopsis

type Assembler a = ExceptT Error IO a
data Engine
data Architecture
- = ArchArm
- | ArchArm64
- | ArchMips
- | ArchX86
- | ArchPpc
- | ArchSparc
- | ArchSystemz
- | ArchHexagon
- | ArchEvm
- | ArchMax
data Mode
- = ModeLittleEndian
- | ModeArm
- | Mode16
- | ModeMips32
- | Mode32
- | ModePpc32
- | ModeSparc32
- | ModeMips64
- | Mode64
- | ModePpc64
- | ModeSparc64
- | ModeThumb
- | ModeMicro
- | ModeQpx
- | ModeV9
- | ModeMips3
- | ModeV8
- | ModeMips32r6
- | ModeBigEndian
data OptionType
- = OptSyntax
- | OptSymResolver
data OptionValue
- = SyntaxIntel
- | SyntaxAtt
- | SyntaxNasm
- | SyntaxMasm
- | SyntaxGas
- | SyntaxRadix16
runAssembler :: Assembler a -> IO (Either Error a)
open :: Architecture -> [Mode] -> Assembler Engine
option :: Engine -> OptionType -> OptionValue -> Assembler ()
assemble :: Engine -> [String] -> Maybe Word64 -> Assembler (ByteString, Int)
data Error
errno :: Engine -> Assembler Error
strerror :: Error -> String
version :: Int

Assembler control

type Assembler a = ExceptT Error IO a Source #

The assembler runs in the IO monad and allows for the handling of errors "under the hood".

data Engine Source #

The Keystone engine.

data Architecture Source #

CPU architecture.

Constructors

ArchArm
ArchArm64
ArchMips
ArchX86
ArchPpc
ArchSparc
ArchSystemz
ArchHexagon
ArchEvm
ArchMax

Instances

Instances details

Bounded Architecture Source #
Instance details Defined in Heystone.Internal.Keystone Methods minBound :: Architecture # maxBound :: Architecture #
Enum Architecture Source #
Instance details Defined in Heystone.Internal.Keystone Methods succ :: Architecture -> Architecture # pred :: Architecture -> Architecture # toEnum :: Int -> Architecture # fromEnum :: Architecture -> Int # enumFrom :: Architecture -> [Architecture] # enumFromThen :: Architecture -> Architecture -> [Architecture] # enumFromTo :: Architecture -> Architecture -> [Architecture] # enumFromThenTo :: Architecture -> Architecture -> Architecture -> [Architecture] #
Show Architecture Source #
Instance details Defined in Heystone.Internal.Keystone Methods showsPrec :: Int -> Architecture -> ShowS # show :: Architecture -> String # showList :: [Architecture] -> ShowS #
Eq Architecture Source #
Instance details Defined in Heystone.Internal.Keystone Methods (==) :: Architecture -> Architecture -> Bool # (/=) :: Architecture -> Architecture -> Bool #

data Mode Source #

CPU hardware mode.

Constructors

ModeLittleEndian
ModeArm
Mode16
ModeMips32
Mode32
ModePpc32
ModeSparc32
ModeMips64
Mode64
ModePpc64
ModeSparc64
ModeThumb
ModeMicro
ModeQpx
ModeV9
ModeMips3
ModeV8
ModeMips32r6
ModeBigEndian

Instances

Instances details

Bounded Mode Source #
Instance details Defined in Heystone.Internal.Keystone Methods minBound :: Mode # maxBound :: Mode #
Enum Mode Source #
Instance details Defined in Heystone.Internal.Keystone Methods succ :: Mode -> Mode # pred :: Mode -> Mode # toEnum :: Int -> Mode # fromEnum :: Mode -> Int # enumFrom :: Mode -> [Mode] # enumFromThen :: Mode -> Mode -> [Mode] # enumFromTo :: Mode -> Mode -> [Mode] # enumFromThenTo :: Mode -> Mode -> Mode -> [Mode] #
Show Mode Source #
Instance details Defined in Heystone.Internal.Keystone Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #
Eq Mode Source #
Instance details Defined in Heystone.Internal.Keystone Methods (==) :: Mode -> Mode -> Bool # (/=) :: Mode -> Mode -> Bool #

data OptionType Source #

Runtime option types.

Constructors

OptSyntax
OptSymResolver

Instances

Instances details

Bounded OptionType Source #
Instance details Defined in Heystone.Internal.Keystone Methods minBound :: OptionType # maxBound :: OptionType #
Enum OptionType Source #
Instance details Defined in Heystone.Internal.Keystone Methods succ :: OptionType -> OptionType # pred :: OptionType -> OptionType # toEnum :: Int -> OptionType # fromEnum :: OptionType -> Int # enumFrom :: OptionType -> [OptionType] # enumFromThen :: OptionType -> OptionType -> [OptionType] # enumFromTo :: OptionType -> OptionType -> [OptionType] # enumFromThenTo :: OptionType -> OptionType -> OptionType -> [OptionType] #
Show OptionType Source #
Instance details Defined in Heystone.Internal.Keystone Methods showsPrec :: Int -> OptionType -> ShowS # show :: OptionType -> String # showList :: [OptionType] -> ShowS #
Eq OptionType Source #
Instance details Defined in Heystone.Internal.Keystone Methods (==) :: OptionType -> OptionType -> Bool # (/=) :: OptionType -> OptionType -> Bool #

data OptionValue Source #

Runtime option values.

Constructors

SyntaxIntel
SyntaxAtt
SyntaxNasm
SyntaxMasm
SyntaxGas
SyntaxRadix16

Instances

Instances details

Bounded OptionValue Source #
Instance details Defined in Heystone.Internal.Keystone Methods minBound :: OptionValue # maxBound :: OptionValue #
Enum OptionValue Source #
Instance details Defined in Heystone.Internal.Keystone Methods succ :: OptionValue -> OptionValue # pred :: OptionValue -> OptionValue # toEnum :: Int -> OptionValue # fromEnum :: OptionValue -> Int # enumFrom :: OptionValue -> [OptionValue] # enumFromThen :: OptionValue -> OptionValue -> [OptionValue] # enumFromTo :: OptionValue -> OptionValue -> [OptionValue] # enumFromThenTo :: OptionValue -> OptionValue -> OptionValue -> [OptionValue] #
Show OptionValue Source #
Instance details Defined in Heystone.Internal.Keystone Methods showsPrec :: Int -> OptionValue -> ShowS # show :: OptionValue -> String # showList :: [OptionValue] -> ShowS #
Eq OptionValue Source #
Instance details Defined in Heystone.Internal.Keystone Methods (==) :: OptionValue -> OptionValue -> Bool # (/=) :: OptionValue -> OptionValue -> Bool #

runAssembler Source #

Arguments

:: Assembler a	The assembler code to execute
-> IO (Either Error a)	A result on success, or an `Error` on failure

Run the Keystone assembler and return a result on success, or an Error on failure.

open Source #

Arguments

:: Architecture	CPU architecture
-> [Mode]	CPU hardware mode
-> Assembler Engine	A Keystone engine on success, or an `Error` on failure

Create a new instance of the Keystone assembler.

option Source #

Arguments

:: Engine	Keystone engine handle
-> OptionType	Type of option to set
-> OptionValue	Option value corresponding with the type
-> Assembler ()	An `Error` on failure

assemble Source #

Arguments

:: Engine	Keystone engine handle
-> [String]	List of statements to assemble.
-> Maybe Word64	Optional address of the first assembly instruction
-> Assembler (ByteString, Int)	Returns the encoded input assembly string and the number of statements successfully processed. Returns an `Error` on failure

Assemble a list of statements.

Error handling

data Error Source #

Errors encountered by the Keystone API. These values are returned by errno.

Constructors

ErrOk
ErrNomem
ErrArch
ErrHandle
ErrMode
ErrVersion
ErrOptInvalid
ErrAsmExprToken
ErrAsmDirectiveValueRange
ErrAsmDirectiveId
ErrAsmDirectiveToken
ErrAsmDirectiveStr
ErrAsmDirectiveComma
ErrAsmDirectiveRelocName
ErrAsmDirectiveRelocToken
ErrAsmDirectiveFpoint
ErrAsmDirectiveUnknown
ErrAsmDirectiveEqu
ErrAsmDirectiveInvalid
ErrAsmVariantInvalid
ErrAsmExprBracket
ErrAsmSymbolModifier
ErrAsmSymbolRedefined
ErrAsmSymbolMissing
ErrAsmRparen
ErrAsmStatToken
ErrAsmUnsupported
ErrAsmMacroToken
ErrAsmMacroParen
ErrAsmMacroEqu
ErrAsmMacroArgs
ErrAsmMacroLevelsExceed
ErrAsmMacroStr
ErrAsmMacroInvalid
ErrAsmEscBackslash
ErrAsmEscOctal
ErrAsmEscSequence
ErrAsmEscStr
ErrAsmTokenInvalid
ErrAsmInsnUnsupported
ErrAsmFixupInvalid
ErrAsmLabelInvalid
ErrAsmFragmentInvalid
ErrAsmInvalidoperand
ErrAsmMissingfeature
ErrAsmMnemonicfail

Instances

Instances details

Bounded Error Source #
Instance details Defined in Heystone.Internal.Core Methods minBound :: Error # maxBound :: Error #
Enum Error Source #
Instance details Defined in Heystone.Internal.Core Methods succ :: Error -> Error # pred :: Error -> Error # toEnum :: Int -> Error # fromEnum :: Error -> Int # enumFrom :: Error -> [Error] # enumFromThen :: Error -> Error -> [Error] # enumFromTo :: Error -> Error -> [Error] # enumFromThenTo :: Error -> Error -> Error -> [Error] #
Show Error Source #
Instance details Defined in Heystone.Internal.Core Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Eq Error Source #
Instance details Defined in Heystone.Internal.Core Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #

errno Source #

Arguments

:: Engine	Keystone engine handle
-> Assembler Error	The last `Error` code

Report the Error number when some API function failed.

strerror Source #

Arguments

:: Error	The `Error` code
-> String	Description of the error code

Return a string describing the given Error.

Misc.

version :: Int Source #

Combined API version & major and minor version numbers. Returns a hexadecimal number as (major << 8 | minor), which encodes both major and minor versions.