heystone (empty) → 0.1.0
raw patch · 19 files changed
+1018/−0 lines, 19 filesdep +basedep +bytestringdep +transformerssetup-changed
Dependencies added: base, bytestring, transformers
Files
- CHANGELOG.md +3/−0
- LICENSE +339/−0
- README.md +32/−0
- Setup.hs +2/−0
- cbits/include/keystone_wrapper.h +11/−0
- cbits/src/keystone_wrapper.c +5/−0
- heystone.cabal +89/−0
- src/Heystone.hs +128/−0
- src/Heystone/CPU/Arm.chs +25/−0
- src/Heystone/CPU/Arm64.chs +25/−0
- src/Heystone/CPU/Hexagon.chs +25/−0
- src/Heystone/CPU/Mips.chs +25/−0
- src/Heystone/CPU/Ppc.chs +25/−0
- src/Heystone/CPU/Sparc.chs +24/−0
- src/Heystone/CPU/SystemZ.chs +25/−0
- src/Heystone/CPU/X86.chs +25/−0
- src/Heystone/Internal/Core.chs +51/−0
- src/Heystone/Internal/Keystone.chs +135/−0
- src/Heystone/Internal/Util.hs +24/−0
+ CHANGELOG.md view
@@ -0,0 +1,3 @@+## 0.1.0 (Unreleased)+Initial release. Imported from keystone-0.1.0.0 (last updated 2021-07-08) by+Adrian Herrera and other contributors.
+ LICENSE view
@@ -0,0 +1,339 @@+ GNU GENERAL PUBLIC LICENSE+ Version 2, June 1991++ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The licenses for most software are designed to take away your+freedom to share and change it. By contrast, the GNU General Public+License is intended to guarantee your freedom to share and change free+software--to make sure the software is free for all its users. This+General Public License applies to most of the Free Software+Foundation's software and to any other program whose authors commit to+using it. (Some other Free Software Foundation software is covered by+the GNU Lesser General Public License instead.) You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+this service if you wish), that you receive source code or can get it+if you want it, that you can change the software or use pieces of it+in new free programs; and that you know you can do these things.++ To protect your rights, we need to make restrictions that forbid+anyone to deny you these rights or to ask you to surrender the rights.+These restrictions translate to certain responsibilities for you if you+distribute copies of the software, or if you modify it.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must give the recipients all the rights that+you have. You must make sure that they, too, receive or can get the+source code. And you must show them these terms so they know their+rights.++ We protect your rights with two steps: (1) copyright the software, and+(2) offer you this license which gives you legal permission to copy,+distribute and/or modify the software.++ Also, for each author's protection and ours, we want to make certain+that everyone understands that there is no warranty for this free+software. If the software is modified by someone else and passed on, we+want its recipients to know that what they have is not the original, so+that any problems introduced by others will not reflect on the original+authors' reputations.++ Finally, any free program is threatened constantly by software+patents. We wish to avoid the danger that redistributors of a free+program will individually obtain patent licenses, in effect making the+program proprietary. To prevent this, we have made it clear that any+patent must be licensed for everyone's free use or not licensed at all.++ The precise terms and conditions for copying, distribution and+modification follow.++ GNU GENERAL PUBLIC LICENSE+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION++ 0. This License applies to any program or other work which contains+a notice placed by the copyright holder saying it may be distributed+under the terms of this General Public License. The "Program", below,+refers to any such program or work, and a "work based on the Program"+means either the Program or any derivative work under copyright law:+that is to say, a work containing the Program or a portion of it,+either verbatim or with modifications and/or translated into another+language. (Hereinafter, translation is included without limitation in+the term "modification".) Each licensee is addressed as "you".++Activities other than copying, distribution and modification are not+covered by this License; they are outside its scope. The act of+running the Program is not restricted, and the output from the Program+is covered only if its contents constitute a work based on the+Program (independent of having been made by running the Program).+Whether that is true depends on what the Program does.++ 1. You may copy and distribute verbatim copies of the Program's+source code as you receive it, in any medium, provided that you+conspicuously and appropriately publish on each copy an appropriate+copyright notice and disclaimer of warranty; keep intact all the+notices that refer to this License and to the absence of any warranty;+and give any other recipients of the Program a copy of this License+along with the Program.++You may charge a fee for the physical act of transferring a copy, and+you may at your option offer warranty protection in exchange for a fee.++ 2. You may modify your copy or copies of the Program or any portion+of it, thus forming a work based on the Program, and copy and+distribute such modifications or work under the terms of Section 1+above, provided that you also meet all of these conditions:++ a) You must cause the modified files to carry prominent notices+ stating that you changed the files and the date of any change.++ b) You must cause any work that you distribute or publish, that in+ whole or in part contains or is derived from the Program or any+ part thereof, to be licensed as a whole at no charge to all third+ parties under the terms of this License.++ c) If the modified program normally reads commands interactively+ when run, you must cause it, when started running for such+ interactive use in the most ordinary way, to print or display an+ announcement including an appropriate copyright notice and a+ notice that there is no warranty (or else, saying that you provide+ a warranty) and that users may redistribute the program under+ these conditions, and telling the user how to view a copy of this+ License. (Exception: if the Program itself is interactive but+ does not normally print such an announcement, your work based on+ the Program is not required to print an announcement.)++These requirements apply to the modified work as a whole. If+identifiable sections of that work are not derived from the Program,+and can be reasonably considered independent and separate works in+themselves, then this License, and its terms, do not apply to those+sections when you distribute them as separate works. But when you+distribute the same sections as part of a whole which is a work based+on the Program, the distribution of the whole must be on the terms of+this License, whose permissions for other licensees extend to the+entire whole, and thus to each and every part regardless of who wrote it.++Thus, it is not the intent of this section to claim rights or contest+your rights to work written entirely by you; rather, the intent is to+exercise the right to control the distribution of derivative or+collective works based on the Program.++In addition, mere aggregation of another work not based on the Program+with the Program (or with a work based on the Program) on a volume of+a storage or distribution medium does not bring the other work under+the scope of this License.++ 3. You may copy and distribute the Program (or a work based on it,+under Section 2) in object code or executable form under the terms of+Sections 1 and 2 above provided that you also do one of the following:++ a) Accompany it with the complete corresponding machine-readable+ source code, which must be distributed under the terms of Sections+ 1 and 2 above on a medium customarily used for software interchange; or,++ b) Accompany it with a written offer, valid for at least three+ years, to give any third party, for a charge no more than your+ cost of physically performing source distribution, a complete+ machine-readable copy of the corresponding source code, to be+ distributed under the terms of Sections 1 and 2 above on a medium+ customarily used for software interchange; or,++ c) Accompany it with the information you received as to the offer+ to distribute corresponding source code. (This alternative is+ allowed only for noncommercial distribution and only if you+ received the program in object code or executable form with such+ an offer, in accord with Subsection b above.)++The source code for a work means the preferred form of the work for+making modifications to it. For an executable work, complete source+code means all the source code for all modules it contains, plus any+associated interface definition files, plus the scripts used to+control compilation and installation of the executable. However, as a+special exception, the source code distributed need not include+anything that is normally distributed (in either source or binary+form) with the major components (compiler, kernel, and so on) of the+operating system on which the executable runs, unless that component+itself accompanies the executable.++If distribution of executable or object code is made by offering+access to copy from a designated place, then offering equivalent+access to copy the source code from the same place counts as+distribution of the source code, even though third parties are not+compelled to copy the source along with the object code.++ 4. You may not copy, modify, sublicense, or distribute the Program+except as expressly provided under this License. Any attempt+otherwise to copy, modify, sublicense or distribute the Program is+void, and will automatically terminate your rights under this License.+However, parties who have received copies, or rights, from you under+this License will not have their licenses terminated so long as such+parties remain in full compliance.++ 5. You are not required to accept this License, since you have not+signed it. However, nothing else grants you permission to modify or+distribute the Program or its derivative works. These actions are+prohibited by law if you do not accept this License. Therefore, by+modifying or distributing the Program (or any work based on the+Program), you indicate your acceptance of this License to do so, and+all its terms and conditions for copying, distributing or modifying+the Program or works based on it.++ 6. Each time you redistribute the Program (or any work based on the+Program), the recipient automatically receives a license from the+original licensor to copy, distribute or modify the Program subject to+these terms and conditions. You may not impose any further+restrictions on the recipients' exercise of the rights granted herein.+You are not responsible for enforcing compliance by third parties to+this License.++ 7. If, as a consequence of a court judgment or allegation of patent+infringement or for any other reason (not limited to patent issues),+conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot+distribute so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you+may not distribute the Program at all. For example, if a patent+license would not permit royalty-free redistribution of the Program by+all those who receive copies directly or indirectly through you, then+the only way you could satisfy both it and this License would be to+refrain entirely from distribution of the Program.++If any portion of this section is held invalid or unenforceable under+any particular circumstance, the balance of the section is intended to+apply and the section as a whole is intended to apply in other+circumstances.++It is not the purpose of this section to induce you to infringe any+patents or other property right claims or to contest validity of any+such claims; this section has the sole purpose of protecting the+integrity of the free software distribution system, which is+implemented by public license practices. Many people have made+generous contributions to the wide range of software distributed+through that system in reliance on consistent application of that+system; it is up to the author/donor to decide if he or she is willing+to distribute software through any other system and a licensee cannot+impose that choice.++This section is intended to make thoroughly clear what is believed to+be a consequence of the rest of this License.++ 8. If the distribution and/or use of the Program is restricted in+certain countries either by patents or by copyrighted interfaces, the+original copyright holder who places the Program under this License+may add an explicit geographical distribution limitation excluding+those countries, so that distribution is permitted only in or among+countries not thus excluded. In such case, this License incorporates+the limitation as if written in the body of this License.++ 9. The Free Software Foundation may publish revised and/or new versions+of the General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++Each version is given a distinguishing version number. If the Program+specifies a version number of this License which applies to it and "any+later version", you have the option of following the terms and conditions+either of that version or of any later version published by the Free+Software Foundation. If the Program does not specify a version number of+this License, you may choose any version ever published by the Free Software+Foundation.++ 10. If you wish to incorporate parts of the Program into other free+programs whose distribution conditions are different, write to the author+to ask for permission. For software which is copyrighted by the Free+Software Foundation, write to the Free Software Foundation; we sometimes+make exceptions for this. Our decision will be guided by the two goals+of preserving the free status of all derivatives of our free software and+of promoting the sharing and reuse of software generally.++ NO WARRANTY++ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,+REPAIR OR CORRECTION.++ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE+POSSIBILITY OF SUCH DAMAGES.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+convey the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software; you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation; either version 2 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License along+ with this program; if not, write to the Free Software Foundation, Inc.,+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.++Also add information on how to contact you by electronic and paper mail.++If the program is interactive, make it output a short notice like this+when it starts in an interactive mode:++ Gnomovision version 69, Copyright (C) year name of author+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, the commands you use may+be called something other than `show w' and `show c'; they could even be+mouse-clicks or menu items--whatever suits your program.++You should also get your employer (if you work as a programmer) or your+school, if any, to sign a "copyright disclaimer" for the program, if+necessary. Here is a sample; alter the names:++ Yoyodyne, Inc., hereby disclaims all copyright interest in the program+ `Gnomovision' (which makes passes at compilers) written by James Hacker.++ <signature of Ty Coon>, 1 April 1989+ Ty Coon, President of Vice++This General Public License does not permit incorporating your program into+proprietary programs. If your program is a subroutine library, you may+consider it more useful to permit linking proprietary applications with the+library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License.
+ README.md view
@@ -0,0 +1,32 @@+# Heystone - Haskell bindings for the Keystone assembler framework+[keystone-gh]: https://github.com/keystone-engine/keystone+[keystone-gh-hs]: https://github.com/keystone-engine/keystone/tree/master/bindings/haskell+[hapstone-gh]: https://github.com/ibabushkin/hapstone++Haskell bindings for [Keystone][keystone-gh], a powerful multi-architecture+assembler framework.++This package is derived from the Haskell bindings at+[keystone-engine/keystone][keystone-gh-hs], which at the time were highly usable+but unmaintained and never uploaded to Hackage. To not obstruct a potential+future official package (and to give myself flexibility), I'm appropriating+[Hapstone][hapstone-gh]'s naming convention.++## Usage+Specify as a dependency in your Cabal file (or Stack, but you'll have to+register it as an `extra-dep`).++You will need the Keystone engine installed. It's not packaged on many systems,+so you many wish to check the [Keystone+docs](https://www.keystone-engine.org/docs/) for instructions. For my fellow+Arch Linux fiends, it's in the main repos:++ pacman -S keystone++## Examples+To build a sample (after having built and installed the Haskell bindings):++```+$ cd bindings/haskell+$ ghc --make samples/Sample.hs+```
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ cbits/include/keystone_wrapper.h view
@@ -0,0 +1,11 @@+#ifndef KEYSTONE_WRAPPER_H+#define KEYSTONE_WRAPPER_H++#include <keystone/keystone.h>++/*+ * Wrap Keystone's ks_close function and ignore the returned error code.+ */+void ks_close_wrapper(ks_engine *ks);++#endif
+ cbits/src/keystone_wrapper.c view
@@ -0,0 +1,5 @@+#include "keystone_wrapper.h"++void ks_close_wrapper(ks_engine *ks) {+ ks_close(ks);+}
+ heystone.cabal view
@@ -0,0 +1,89 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.34.4.+--+-- see: https://github.com/sol/hpack++name: heystone+version: 0.1.0+synopsis: Haskell bindings for the Keystone assembler framework+description: Please see README.md.+category: Bindings, Compilers/Interpreters, Assembler+homepage: https://github.com/raehik/heystone#readme+bug-reports: https://github.com/raehik/heystone/issues+author: Adrian Herrera, Ben Orchard+maintainer: Ben Orchard <thefirstmuffinman@gmail.com>+license: GPL-2+license-file: LICENSE+build-type: Simple+tested-with:+ GHC ==8.0.2, GHC ==9.2.3+extra-source-files:+ README.md+ CHANGELOG.md+ cbits/include/keystone_wrapper.h++source-repository head+ type: git+ location: https://github.com/raehik/heystone++library+ exposed-modules:+ Heystone+ Heystone.CPU.Arm+ Heystone.CPU.Arm64+ Heystone.CPU.Hexagon+ Heystone.CPU.Mips+ Heystone.CPU.Ppc+ Heystone.CPU.Sparc+ Heystone.CPU.SystemZ+ Heystone.CPU.X86+ Heystone.Internal.Core+ Heystone.Internal.Keystone+ Heystone.Internal.Util+ other-modules:+ Paths_heystone+ hs-source-dirs:+ src+ default-extensions:+ EmptyCase+ LambdaCase+ InstanceSigs+ BangPatterns+ ExplicitNamespaces+ StandaloneDeriving+ DeriveAnyClass+ DeriveGeneric+ DeriveDataTypeable+ DeriveFunctor+ DeriveFoldable+ DeriveTraversable+ DeriveLift+ FlexibleContexts+ FlexibleInstances+ MultiParamTypeClasses+ GADTs+ PolyKinds+ RoleAnnotations+ RankNTypes+ TypeApplications+ DefaultSignatures+ TypeFamilies+ DataKinds+ MagicHash+ ScopedTypeVariables+ TypeOperators+ ghc-options: -Wall+ include-dirs:+ cbits/include+ c-sources:+ cbits/src/keystone_wrapper.c+ pkgconfig-depends:+ keystone+ build-tools:+ c2hs >=0.28.8 && <0.29+ build-depends:+ base >=4.9 && <5+ , bytestring >=0.11.3.1 && <0.12+ , transformers >=0.5 && <0.7+ default-language: Haskell2010
+ src/Heystone.hs view
@@ -0,0 +1,128 @@+{-|+Module : Heystone+Description : The Keystone assembler engine.+Copyright : (c) Adrian Herrera, 2016+License : GPL-2++Keystone is a lightweight multi-platform, multi-architecture assembler+framework.++Further information is available at <http://www.keystone-engine.org>.+-}+module Heystone+ ( -- * Assembler control+ Assembler+ , Engine+ , Architecture(..)+ , Mode(..)+ , OptionType(..)+ , OptionValue(..)+ , runAssembler+ , open+ , option+ , assemble++ -- * Error handling+ , Error(..)+ , errno+ , strerror++ -- * Misc.+ , version+ ) where++import Control.Monad.Trans.Class (lift)+import Control.Monad.Trans.Except (runExceptT, throwE)+import Data.ByteString (ByteString, packCStringLen)+import Data.List (intercalate)+import Foreign++import Heystone.Internal.Core+import Heystone.Internal.Keystone++-------------------------------------------------------------------------------+-- Assembler control+-------------------------------------------------------------------------------++-- | Run the Keystone assembler and return a result on success, or an 'Error'+-- on failure.+runAssembler :: Assembler a -- ^ The assembler code to execute+ -> IO (Either Error a) -- ^ A result on success, or an 'Error' on+ -- failure+runAssembler =+ runExceptT++-- | Create a new instance of the Keystone assembler.+open :: Architecture -- ^ CPU architecture+ -> [Mode] -- ^ CPU hardware mode+ -> Assembler Engine -- ^ A Keystone engine on success, or an 'Error'+ -- on failure+open arch mode = do+ (err, ksPtr) <- lift $ ksOpen arch mode+ if err == ErrOk then+ -- Return a pointer to the Keystone engine if ksOpen completed+ -- successfully+ lift $ mkEngine ksPtr+ else+ -- Otherwise return an error+ throwE err++option :: Engine -- ^ Keystone engine handle+ -> OptionType -- ^ Type of option to set+ -> OptionValue -- ^ Option value corresponding with the type+ -> Assembler () -- ^ An 'Error' on failure+option ks optType optValue = do+ err <- lift $ ksOption ks optType optValue+ if err == ErrOk then+ return ()+ else+ throwE err++-- | Assemble a list of statements.+assemble :: 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 ks stmts addr = do+ let string = intercalate ";" stmts+ (res, encPtr, encSize, statCount) <- lift $ ksAsm ks string (maybeZ addr)+ if res == 0 then do+ -- If ksAsm completed successfully, pack the encoded bytes into a+ -- ByteString. Once the encoded bytes have been packed the original+ -- encoded bytes can be freed. The ByteString is returned with the+ -- statement count+ bs <- lift $ packCStringLen (castPtr encPtr, encSize)+ lift $ ksFree encPtr+ return (bs, statCount)+ else do+ -- On failure, call errno for error code+ err <- errno ks+ throwE err+ where maybeZ = maybe 0 id++-------------------------------------------------------------------------------+-- Misc.+-------------------------------------------------------------------------------++-- | Combined API version & major and minor version numbers. Returns a+-- hexadecimal number as (major << 8 | minor), which encodes both major and+-- minor versions.+version :: Int+version =+ ksVersion nullPtr nullPtr++-- | Report the 'Error' number when some API function failed.+errno :: Engine -- ^ Keystone engine handle+ -> Assembler Error -- ^ The last 'Error' code+errno =+ lift . ksErrno++-- | Return a string describing the given 'Error'.+strerror :: Error -- ^ The 'Error' code+ -> String -- ^ Description of the error code+strerror =+ ksStrerror
+ src/Heystone/CPU/Arm.chs view
@@ -0,0 +1,25 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.Arm+Description : Definitions for the ARM architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the ARM architecture.+-}+module Heystone.CPU.Arm+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/arm.h>++-- | ARM errors.+{# enum ks_err_asm_arm as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_ARM_"+ deriving (Show, Eq, Bounded)+#}
+ src/Heystone/CPU/Arm64.chs view
@@ -0,0 +1,25 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.Arm64+Description : Definitions for the ARM64 architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the ARM64 architecture.+-}+module Heystone.CPU.Arm64+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/arm64.h>++-- | ARM64 errors.+{# enum ks_err_asm_arm64 as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_ARM64_"+ deriving (Show, Eq, Bounded)+#}
+ src/Heystone/CPU/Hexagon.chs view
@@ -0,0 +1,25 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.Hexagon+Description : Definitions for the Hexagon architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the Hexagon architecture.+-}+module Heystone.CPU.Hexagon+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/hexagon.h>++-- | Hexagon errors.+{# enum ks_err_asm_hexagon as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_HEXAGON_"+ deriving (Show, Eq, Bounded)+#}
+ src/Heystone/CPU/Mips.chs view
@@ -0,0 +1,25 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.Mips+Description : Definitions for the MIPS architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the MIPS architecture.+-}+module Heystone.CPU.Mips+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/mips.h>++-- | MIPS errors.+{# enum ks_err_asm_mips as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_MIPS_"+ deriving (Show, Eq, Bounded)+#}
+ src/Heystone/CPU/Ppc.chs view
@@ -0,0 +1,25 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.Ppc+Description : Definitions for the PPC architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the PPC architecture.+-}+module Heystone.CPU.Ppc+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/ppc.h>++-- | PPC errors.+{# enum ks_err_asm_ppc as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_PPC_"+ deriving (Show, Eq, Bounded)+#}
+ src/Heystone/CPU/Sparc.chs view
@@ -0,0 +1,24 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.Sparc+Description : Definitions for the SPARC architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the SPARC architecture.+-}+module Heystone.CPU.Sparc+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/sparc.h>++-- | SPARC errors.+{# enum ks_err_asm_sparc as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_SPARC_"+ deriving (Show, Eq, Bounded) #}
+ src/Heystone/CPU/SystemZ.chs view
@@ -0,0 +1,25 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.SystemZ+Description : Definitions for the SystemZ architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the SystemZ architecture.+-}+module Heystone.CPU.SystemZ+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/systemz.h>++-- | SystemZ errors.+{# enum ks_err_asm_systemz as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_SYSTEMZ_"+ deriving (Show, Eq, Bounded)+#}
+ src/Heystone/CPU/X86.chs view
@@ -0,0 +1,25 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.CPU.X86+Description : Definitions for the X86 architecture.+Copyright : (C) Adrian Herrera, 2016+License : GPL-2++Definitions for the X86 architecture.+-}+module Heystone.CPU.X86+ (+ Error(..)+ ) where++{# context lib = "keystone" #}++#include <keystone/x86.h>++-- | X86 errors.+{# enum ks_err_asm_x86 as Error+ { underscoreToCase }+ with prefix = "KS_ERR_ASM_X86_"+ deriving (Show, Eq, Bounded)+#}
+ src/Heystone/Internal/Core.chs view
@@ -0,0 +1,51 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.Internal.Core+Description : Core Keystone components.+Copyright : (c) Adrian Herrera, 2016+License : GPL-2++Defines core Keystone components.++This module should not be directly imported; it is only exposed because of the+way cabal handles ordering of chs files.+-}+module Heystone.Internal.Core where++import Control.Monad+import Control.Monad.Trans.Except (ExceptT)+import Foreign++{# context lib = "keystone" #}++#include <keystone/keystone.h>+#include "keystone_wrapper.h"++-- | The Keystone engine.+{# pointer *ks_engine as Engine+ foreign finalizer ks_close_wrapper as close+ newtype+#}++-- | A pointer to the Keystone engine.+{# pointer *ks_engine as EnginePtr -> Engine #}++-- | Make a new Keystone engine out of an engine pointer. The returned Keystone+-- engine will automatically call @ks_close_wrapper@ when it goes out of scope.+mkEngine :: EnginePtr+ -> IO Engine+mkEngine ptr =+ liftM Engine (newForeignPtr close ptr)++-- | Errors encountered by the Keystone API. These values are returned by+-- 'Heystone.errno'.+{# enum ks_err as Error+ { underscoreToCase }+ with prefix = "KS_"+ deriving (Show, Eq, Bounded)+#}++-- | The assembler runs in the IO monad and allows for the handling of errors+-- "under the hood".+type Assembler a = ExceptT Error IO a
+ src/Heystone/Internal/Keystone.chs view
@@ -0,0 +1,135 @@+{-# LANGUAGE ForeignFunctionInterface #-}++{-|+Module : Heystone.Internal.Keystone+Description : The Keystone assembler engine.+Copyright : (c) Adrian Herrera, 2016+License : GPL-2++Low-level bindings for the Keystone assembler engine.++This module should not be directly imported; it is only exposed because of the+way cabal handles ordering of chs files.+-}+module Heystone.Internal.Keystone+ ( -- * Types+ Architecture(..)+ , Mode(..)+ , OptionType(..)+ , OptionValue(..)++ -- * Function bindings+ , ksOpen+ , ksOption+ , ksFree+ , ksAsm+ , ksVersion+ , ksErrno+ , ksStrerror+ ) where++import Foreign+import Foreign.C++import Heystone.Internal.Util++{# import Heystone.Internal.Core #}++{# context lib = "keystone" #}++#include <keystone/keystone.h>++-------------------------------------------------------------------------------+-- Types+-------------------------------------------------------------------------------++-- | CPU architecture.+{# enum ks_arch as Architecture+ { underscoreToCase }+ with prefix = "KS_"+ deriving (Show, Eq, Bounded)+#}++-- | CPU hardware mode.+{# enum ks_mode as Mode+ { underscoreToCase }+ with prefix = "KS_"+ deriving (Show, Eq, Bounded)+#}++-- | Runtime option types.+{# enum ks_opt_type as OptionType+ { underscoreToCase }+ with prefix = "KS_"+ deriving (Show, Eq, Bounded)+#}++-- | Runtime option values.+{# enum ks_opt_value as OptionValue+ { underscoreToCase }+ with prefix = "KS_OPT_"+ deriving (Show, Eq, Bounded)+#}++-------------------------------------------------------------------------------+-- Assembler control+-------------------------------------------------------------------------------++{# fun ks_open as ^+ { `Architecture'+ , combineEnums `[Mode]'+ , alloca- `EnginePtr' peek*+ } -> `Error'+#}++{# fun ks_option as ^+ { `Engine'+ , `OptionType'+ , `OptionValue'+ } -> `Error'+#}++{# fun ks_asm as ^+ { `Engine'+ , `String'+ , `Word64'+ , alloca- `Ptr CUChar' peek*+ , alloca- `Int' peekToInt*+ , alloca- `Int' peekToInt*+ } -> `Int'+#}++{# fun ks_free as ^+ { castPtr `Ptr CUChar'+ } -> `()'+#}++-------------------------------------------------------------------------------+-- Misc.+-------------------------------------------------------------------------------++{# fun pure unsafe ks_version as ^+ { id `Ptr CUInt'+ , id `Ptr CUInt'+ } -> `Int'+#}++{# fun unsafe ks_errno as ^+ { `Engine'+ } -> `Error'+#}++{# fun pure unsafe ks_strerror as ^+ { `Error'+ } -> `String'+#}++-------------------------------------------------------------------------------+-- Helper functions+-------------------------------------------------------------------------------++peekToInt :: (Storable a, Integral a, Num b)+ => Ptr a+ -> IO b+peekToInt ptr =+ peek ptr >>= (return . fromIntegral)
+ src/Heystone/Internal/Util.hs view
@@ -0,0 +1,24 @@+{-|+Module : Heystone.Internal.Util+Description : Utility (aka helper) functions for the Keystone assembler.+Copyright : (c) Adrian Herrera, 2016+License : GPL-2+-}+module Heystone.Internal.Util where++--import Control.Applicative ((<$>))+import Data.Bits++-- | Combine a list of Enums by performing a bitwise-OR.+combineEnums :: (Enum a, Num b, Bits b)+ => [a]+ -> b+combineEnums =+ foldr ((.|.) <$> enumToNum) 0++-- | Convert an 'Enum' to a 'Num'.+enumToNum :: (Enum a, Num b)+ => a+ -> b+enumToNum =+ fromIntegral . fromEnum