Merge pull request #549 from null-cell/master

Adds RISCV support to Keystone

Author: wtdcode

.gitignore

@@ -23,6 +23,7 @@ samples/sample
 _sample*.txt
 tmp
 MANIFEST
+.vscode
 
 bindings/python/dist/
 bindings/python/src/

README.md

@@ -8,7 +8,7 @@ Keystone Engine
 Keystone is a lightweight multi-platform, multi-architecture assembler framework.
 It offers some unparalleled features:
 
-- Multi-architecture, with support for Arm, Arm64 (AArch64/Armv8), Ethereum Virtual Machine, Hexagon, Mips, PowerPC, Sparc, SystemZ & X86 (include 16/32/64bit).
+- Multi-architecture, with support for Arm, Arm64 (AArch64/Armv8), Ethereum Virtual Machine, Hexagon, Mips, PowerPC, RISC-V, Sparc, SystemZ & X86 (include 16/32/64bit).
 - Clean/simple/lightweight/intuitive architecture-neutral API.
 - Implemented in C/C++ languages, with bindings for Java, Masm, C#, PowerShell, Perl, Python, NodeJS, Ruby, Go, Rust, Haskell, VB6 & OCaml available.
 - Native support for Windows & \*nix (with Mac OSX, Linux, \*BSD & Solaris confirmed).

bindings/Makefile

@@ -10,6 +10,7 @@ SAMPLE_MIPS = $(TMPDIR)/sample_mips
 SAMPLE_M68K = $(TMPDIR)/sample_m68k
 SAMPLE_SPARC = $(TMPDIR)/sample_sparc
 SAMPLE_X86 = $(TMPDIR)/sample_x86
+SAMPLE_RISCV = $(TMPDIR)/sample_riscv
 
 .PHONY: all expected python rust go nodejs ruby
 
@@ -34,6 +35,7 @@ expected:
 	../samples/sample_sparc > $(SAMPLE_SPARC)_e
 	../samples/sample_m68k > $(SAMPLE_M68K)_e
 	../samples/sample_x86 > $(SAMPLE_X86)_e
+	../samples/sample_riscv > $(SAMPLE_RISCV)_e
 
 python: FORCE
 	cd python && $(MAKE)
@@ -43,6 +45,7 @@ python: FORCE
 	python python/sample_sparc.py > $(SAMPLE_SPARC)_o
 	python python/sample_m68k.py > $(SAMPLE_M68K)_o
 	python python/sample_x86.py > $(SAMPLE_X86)_o
+	python python/sample_riscv.py > $(SAMPLE_RISCV)_o
 	$(MAKE) sample_diff
 
 ruby: FORCE
@@ -67,6 +70,7 @@ sample_diff: FORCE
 	$(DIFF) $(SAMPLE_SPARC)_e $(SAMPLE_SPARC)_o
 	$(DIFF) $(SAMPLE_M68K)_e $(SAMPLE_M68K)_o
 	$(DIFF) $(SAMPLE_X86)_e $(SAMPLE_X86)_o
+	$(DIFF) $(SAMPLE_RISCV)_e $(SAMPLE_RISCV)_o
 
 clean:
 	rm -rf $(TMPDIR)

bindings/const_generator.py

@@ -8,7 +8,7 @@
 # NOTE: this reflects the value of KS_ERR_ASM_xxx in keystone.h
 ks_err_val = { 'KS_ERR_ASM': '128', 'KS_ERR_ASM_ARCH': '512' }
 
-include = [ 'arm.h', 'arm64.h', 'mips.h', 'x86.h', 'sparc.h', 'ppc.h', 'systemz.h', 'hexagon.h', 'evm.h', 'keystone.h' ]
+include = [ 'arm.h', 'arm64.h', 'mips.h', 'x86.h', 'sparc.h', 'riscv.h', 'ppc.h', 'systemz.h', 'hexagon.h', 'evm.h', 'keystone.h' ]
 
 def CamelCase(s):
     # return re.sub(r'(\w)+\_?', lambda m:m.group(0).capitalize(), s)
@@ -40,6 +40,7 @@ def CamelCase(s):
             'mips.h': 'keystone',
             'x86.h': 'keystone',
             'sparc.h': 'keystone',
+            'riscv.h': 'keystone',
             'systemz.h': 'keystone',
             'ppc.h': 'keystone',
             'hexagon.h': 'keystone',
@@ -112,6 +113,7 @@ def CamelCase(s):
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
+            'riscv.h': 'riscv',
             'systemz.h': 'systemz',
             'ppc.h': 'ppc',
             'hexagon.h': 'hexagon',
@@ -174,6 +176,7 @@ def CamelCase(s):
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
+            'riscv.h': 'riscv',
             'systemz.h': 'systemz',
             'ppc.h': 'ppc',
             'hexagon.h': 'hexagon',
@@ -199,6 +202,7 @@ def CamelCase(s):
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
+            'riscv.h': 'riscv',
             'systemz.h': 'systemz',
             'ppc.h': 'ppc',
             'hexagon.h': 'hexagon',
@@ -224,6 +228,7 @@ def CamelCase(s):
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
+            'riscv.h': 'riscv.h',
             'systemz.h': 'systemz',
             'ppc.h': 'ppc',
             'hexagon.h': 'hexagon',
@@ -250,6 +255,7 @@ def CamelCase(s):
             'mips.h': 'mips',
             'x86.h': 'x86',
             'sparc.h': 'sparc',
+            'riscv.h': 'riscv',
             'systemz.h': 'systemz',
             'ppc.h': 'ppc',
             'hexagon.h': 'hexagon',
@@ -387,7 +393,7 @@ def gen(lang):
 
     for prefix in consts.keys():
         outfile = open(templ['out_file'] % prefix, 'wb')   # open as binary prevents windows newlines
-        outfile.write (templ['header'] % prefix)
+        outfile.write (str.encode(templ['header'] % prefix))
 
         for rule in rules:
             regex = rule['regex']
@@ -403,18 +409,18 @@ def gen(lang):
                 continue
 
             if rule.get('pre'):
-                outfile.write(rule.get('pre').format(CamelCase(prefix)))
+                outfile.write(str.encode(rule.get('pre').format(CamelCase(prefix))))
 
             for const in consts2:
                 lhs_strip = const[0]
                 rhs = const[1]
                 outfile.write(rule['line_format'].format(rule['fn'](lhs_strip), rhs, lhs_strip).encode("utf-8"))
 
             if rule.get('post'):
-                outfile.write (rule.get('post'))
-                outfile.write ('\n')
+                outfile.write(str.encode (rule.get('post')))
+                outfile.write(str.encode ('\n'))
 
-        outfile.write (templ['footer'])
+        outfile.write(str.encode(templ['footer']))
         outfile.close()
 
 def main():

bindings/go/keystone/keystone_const.go

@@ -23,6 +23,8 @@ const (
 	MODE_PPC32 Mode = 4
 	MODE_PPC64 Mode = 8
 	MODE_QPX Mode = 16
+	MODE_RISCV32 Mode = 4
+	MODE_RISCV64 Mode = 8
 	MODE_SPARC32 Mode = 4
 	MODE_SPARC64 Mode = 8
 	MODE_V9 Mode = 16
@@ -38,7 +40,8 @@ const (
 	ARCH_SYSTEMZ Architecture = 7
 	ARCH_HEXAGON Architecture = 8
 	ARCH_EVM Architecture = 9
-	ARCH_MAX Architecture = 10
+	ARCH_RISCV Architecture = 10
+	ARCH_MAX Architecture = 11
 )
 
 const (

bindings/go/keystone/riscv_const.go

@@ -0,0 +1,9 @@
+package keystone
+// For Keystone Engine. AUTO-GENERATED FILE, DO NOT EDIT [riscv_const.go]
+
+const (
+	ERR_ASM_RISCV_INVALIDOPERAND Error = 512
+	ERR_ASM_RISCV_MISSINGFEATURE Error = 513
+	ERR_ASM_RISCV_MNEMONICFAIL Error = 514
+)
+

bindings/nodejs/consts/keystone.js

@@ -13,7 +13,8 @@ module.exports.ARCH_SPARC = 6
 module.exports.ARCH_SYSTEMZ = 7
 module.exports.ARCH_HEXAGON = 8
 module.exports.ARCH_EVM = 9
-module.exports.ARCH_MAX = 10
+module.exports.ARCH_RISCV = 10
+module.exports.ARCH_MAX = 11
 module.exports.MODE_LITTLE_ENDIAN = 0
 module.exports.MODE_BIG_ENDIAN = 1073741824
 module.exports.MODE_ARM = 1
@@ -30,6 +31,8 @@ module.exports.MODE_64 = 8
 module.exports.MODE_PPC32 = 4
 module.exports.MODE_PPC64 = 8
 module.exports.MODE_QPX = 16
+module.exports.MODE_RISCV32 = 4
+module.exports.MODE_RISCV64 = 8
 module.exports.MODE_SPARC32 = 4
 module.exports.MODE_SPARC64 = 8
 module.exports.MODE_V9 = 16

bindings/nodejs/consts/riscv.js

@@ -0,0 +1,4 @@
+// For Keystone Engine. AUTO-GENERATED FILE, DO NOT EDIT [riscv_const.js]
+module.exports.ERR_ASM_RISCV_INVALIDOPERAND = 512
+module.exports.ERR_ASM_RISCV_MISSINGFEATURE = 513
+module.exports.ERR_ASM_RISCV_MNEMONICFAIL = 514

bindings/powershell/Keystone/Const/keystone_h.cs

@@ -13,7 +13,8 @@
 KS_ARCH_SYSTEMZ = 7,
 KS_ARCH_HEXAGON = 8,
 KS_ARCH_EVM = 9,
-KS_ARCH_MAX = 10,
+KS_ARCH_RISCV = 10,
+KS_ARCH_MAX = 11,
 KS_MODE_LITTLE_ENDIAN = 0,
 KS_MODE_BIG_ENDIAN = 1073741824,
 KS_MODE_ARM = 1,
@@ -30,6 +31,8 @@
 KS_MODE_PPC32 = 4,
 KS_MODE_PPC64 = 8,
 KS_MODE_QPX = 16,
+KS_MODE_RISCV32 = 4,
+KS_MODE_RISCV64 = 8,
 KS_MODE_SPARC32 = 4,
 KS_MODE_SPARC64 = 8,
 KS_MODE_V9 = 16,

bindings/python/Makefile

@@ -6,6 +6,7 @@ else
 OBJDIR = $(abspath $(BUILDDIR))/obj/bindings/python
 endif
 
+ 
 .PHONY: gen_const install install3 clean
 
 gen_const: