Initial commit

README.md

@@ -0,0 +1,18 @@
+# libx86decode
+
+A fast and lightweight decoder for x86 and x86-64. *This is not a disassembler, it does not intend to procude valid assembly.* To meet the goal of speed, lookup tables are used to map the opcode the (internal) description of the instruction encoding. This table currently has a size of roughly 21 kiB.
+
+Currently, decoding 32-bit assembly required the `ARCH_386` macro to be defined and  is only tested when compiling as 32-bit binary. Decoding of 64-bit instruction requires the macro `ARCH_X86_64` and is only supported in 64-bit mode. This restriction might change in future.
+
+### Known issues
+- An implicit `FWAIT` in FPU instructions is decoded as a separate instruction. For example, the instruction `FINIT` is decoded as an `FWAIT` followed by an `FINIT` where as `FNINIT` is decoded as a plain `FINIT` instruction.
+- The AVX VSIB encoding is not supported yet, all instructions using this will result in a decode error.
+- A mandatory L0 or L1 in the VEX prefix is currently ignored to reduce the size of the prefix tables. The only instructions where this has an effect are `VZEROALL` (L1) and `VZEROUPPER` (L0) and are currently decoded as `VZERO`, the vector length prefix can be used to determine the actual instruction.
+- The EVEX prefix (AVX-512) is not supported (yet).
+- No ABI stability as the value associated with the mnemonics will change if further instructions are added. When using this library, please link it statically.
+- The instruction formatter does not include prefixes. (Help needed.)
+- The layout of entries in the tables can be improved to improve usage of caches. (Help needed.)
+- Low test coverage. (Help needed.)
+- No benchmarking has been performed yet. (Help needed.)
+
+If you find any other issues, please report a bug. Or, even better, send a patch fixing the issue.