Merge branch 'develop'

Author: flobernd

CMakeLists.txt

@@ -15,29 +15,32 @@ option(ZYDIS_FEATURE_DECODER
 option(ZYDIS_FEATURE_FORMATTER
     "Enable instruction formatting functionality"
     ON)
-option(ZYDIS_FEATURE_EVEX 
-    "Enable support for EVEX instructions" 
+option(ZYDIS_FEATURE_EVEX
+    "Enable support for EVEX instructions"
     ON)
-option(ZYDIS_FEATURE_MVEX 
-    "Enable support for MVEX instructions" 
+option(ZYDIS_FEATURE_MVEX
+    "Enable support for MVEX instructions"
     ON)
 
 # Build configuration
 option(BUILD_SHARED_LIBS
     "Build shared libraries"
     OFF)
+option(ZYDIS_WHOLE_PROGRAM_OPTIMIZATION
+    "Enable whole program optimization"
+    OFF)
 option(ZYDIS_NO_LIBC
     "Don't use any C standard library functions (for exotic build-envs like kernel drivers)"
     OFF)
-option(ZYDIS_BUILD_EXAMPLES 
-    "Build examples" 
+option(ZYDIS_BUILD_EXAMPLES
+    "Build examples"
     ON)
-option(ZYDIS_BUILD_TOOLS 
-    "Build tools" 
+option(ZYDIS_BUILD_TOOLS
+    "Build tools"
     ON)
 option(ZYDIS_FUZZ_AFL_FAST
-	"Enables AFL persistent mode and reduces prints in ZydisFuzzIn"
-	OFF)
+    "Enables AFL persistent mode and reduces prints in ZydisFuzzIn"
+    OFF)
 option(ZYDIS_DEV_MODE
     "Enable developer mode (-Wall, -Werror, ...)"
     OFF)
@@ -66,10 +69,15 @@ endif ()
 
 add_library("Zydis")
 
-target_include_directories("Zydis" 
+target_include_directories("Zydis"
     PUBLIC "include" ${PROJECT_BINARY_DIR}
     PRIVATE "src")
 target_compile_definitions("Zydis" PRIVATE "_CRT_SECURE_NO_WARNINGS" "ZYDIS_EXPORTS")
+if (ZYDIS_WHOLE_PROGRAM_OPTIMIZATION AND MSVC)
+    set_target_properties("Zydis" PROPERTIES COMPILE_FLAGS "/GL")
+    set_target_properties("Zydis" PROPERTIES LINK_FLAGS_RELEASE "/LTCG")
+    set_target_properties("Zydis" PROPERTIES STATIC_LIBRARY_FLAGS_RELEASE "/LTCG")
+endif ()
 generate_export_header("Zydis" BASE_NAME "ZYDIS" EXPORT_FILE_NAME "ZydisExportConfig.h")
 
 if (NOT ZYDIS_FEATURE_ENCODER AND NOT ZYDIS_FEATURE_DECODER)
@@ -80,6 +88,13 @@ if (NOT ZYDIS_FEATURE_ENCODER AND NOT ZYDIS_FEATURE_DECODER)
     )
 endif ()
 
+if (ZYDIS_FEATURE_FORMATTER AND NOT ZYDIS_FEATURE_DECODER)
+    message(
+        FATAL_ERROR
+        "\nZYDIS_FEATURE_FORMATTER requires ZYDIS_FEATURE_DECODER to be enabled"
+    )
+endif ()
+
 if (NOT ZYDIS_FEATURE_DECODER)
     target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_DECODER")
 endif ()
@@ -97,7 +112,7 @@ if (ZYDIS_NO_LIBC)
 endif ()
 
 target_sources("Zydis"
-    PUBLIC
+    PRIVATE
         "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/CommonTypes.h"
         "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Defines.h"
         "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/MetaInfo.h"
@@ -110,7 +125,6 @@ target_sources("Zydis"
         "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Zydis.h"
         "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/LibC.h"
         "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/SharedData.h"
-    PRIVATE
         "src/MetaInfo.c"
         "src/Mnemonic.c"
         "src/Register.c"
@@ -120,16 +134,19 @@ target_sources("Zydis"
         "src/Zydis.c")
 
 if (ZYDIS_FEATURE_DECODER)
-    target_sources("Zydis" 
-        PUBLIC 
+    target_sources("Zydis"
+        PRIVATE
             "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Decoder.h"
             "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/DecoderTypes.h"
-            "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Formatter.h"
             "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/DecoderData.h"
-        PRIVATE 
             "src/Decoder.c"
-            "src/DecoderData.c"
-            "src/Formatter.c")
+            "src/DecoderData.c")
+    if (ZYDIS_FEATURE_FORMATTER)
+        target_sources("Zydis"
+            PRIVATE
+                "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Formatter.h"
+                "src/Formatter.c")
+    endif ()
 endif ()
 
 if (BUILD_SHARED_LIBS AND WIN32)
@@ -141,14 +158,17 @@ install(TARGETS "Zydis"
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
-install(DIRECTORY "include" DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+install(FILES
+    "${PROJECT_BINARY_DIR}/ZydisExportConfig.h"
+    DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
+install(DIRECTORY "include/" DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
 
 # =============================================================================================== #
 # Examples                                                                                        #
 # =============================================================================================== #
 
 if (ZYDIS_BUILD_EXAMPLES)
-    if (ZYDIS_FEATURE_DECODER)
+    if (ZYDIS_FEATURE_DECODER AND ZYDIS_FEATURE_FORMATTER)
         add_executable("FormatterHooks" "examples/FormatterHooks.c")
         target_link_libraries("FormatterHooks" "Zydis")
         set_target_properties("FormatterHooks" PROPERTIES FOLDER "Examples/Formatter")
@@ -158,14 +178,22 @@ if (ZYDIS_BUILD_EXAMPLES)
         target_link_libraries("ZydisFuzzIn" "Zydis")
         set_target_properties("FormatterHooks" PROPERTIES FOLDER "Examples")
         target_compile_definitions("ZydisFuzzIn" PRIVATE "_CRT_SECURE_NO_WARNINGS")
-		if (ZYDIS_FUZZ_AFL_FAST)
-			target_compile_definitions("ZydisFuzzIn" PRIVATE "ZYDIS_FUZZ_AFL_FAST")
-		endif ()
+        if (ZYDIS_WHOLE_PROGRAM_OPTIMIZATION AND MSVC)
+            set_target_properties("ZydisFuzzIn" PROPERTIES COMPILE_FLAGS "/GL")
+            set_target_properties("ZydisFuzzIn" PROPERTIES LINK_FLAGS_RELEASE "/LTCG")
+        endif ()
+        if (ZYDIS_FUZZ_AFL_FAST)
+            target_compile_definitions("ZydisFuzzIn" PRIVATE "ZYDIS_FUZZ_AFL_FAST")
+        endif ()
 
         add_executable("ZydisPerfTest" "examples/ZydisPerfTest.c")
         target_link_libraries("ZydisPerfTest" "Zydis")
         set_target_properties("FormatterHooks" PROPERTIES FOLDER "Examples")
         target_compile_definitions("ZydisPerfTest" PRIVATE "_CRT_SECURE_NO_WARNINGS")
+        if (ZYDIS_WHOLE_PROGRAM_OPTIMIZATION AND MSVC)
+            set_target_properties("ZydisPerfTest" PROPERTIES COMPILE_FLAGS "/GL")
+            set_target_properties("ZydisPerfTest" PROPERTIES LINK_FLAGS_RELEASE "/LTCG")
+        endif ()
         if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
             target_compile_definitions("ZydisPerfTest" PRIVATE "_GNU_SOURCE")
             find_package(Threads REQUIRED)
@@ -179,15 +207,23 @@ endif ()
 # =============================================================================================== #
 
 if (ZYDIS_BUILD_TOOLS)
-    if (ZYDIS_FEATURE_DECODER)
+    if (ZYDIS_FEATURE_DECODER AND ZYDIS_FEATURE_FORMATTER)
         add_executable("ZydisDisasm" "tools/ZydisDisasm.c")
         target_link_libraries("ZydisDisasm" "Zydis")
         set_target_properties ("ZydisDisasm" PROPERTIES FOLDER "Tools")
         target_compile_definitions("ZydisDisasm" PRIVATE "_CRT_SECURE_NO_WARNINGS")
+        if (ZYDIS_WHOLE_PROGRAM_OPTIMIZATION AND MSVC)
+            set_target_properties("ZydisDisasm" PROPERTIES COMPILE_FLAGS "/GL")
+            set_target_properties("ZydisDisasm" PROPERTIES LINK_FLAGS_RELEASE "/LTCG")
+        endif ()
 
         add_executable("ZydisInfo" "tools/ZydisInfo.c")
         target_link_libraries("ZydisInfo" "Zydis")
         set_target_properties ("ZydisInfo" PROPERTIES FOLDER "Tools")
         target_compile_definitions("ZydisInfo" PRIVATE "_CRT_SECURE_NO_WARNINGS")
+        if (ZYDIS_WHOLE_PROGRAM_OPTIMIZATION AND MSVC)
+            set_target_properties("ZydisInfo" PROPERTIES COMPILE_FLAGS "/GL")
+            set_target_properties("ZydisInfo" PROPERTIES LINK_FLAGS_RELEASE "/LTCG")
+        endif ()
     endif ()
 endif ()

LICENSE

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Florian Bernd
-Copyright (c) 2017 Joel Höner
+Copyright (c) 2018 Florian Bernd
+Copyright (c) 2018 Joel Höner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,81 +1,72 @@
 ![zydis logo](https://mainframe.pw/u/P94JAqY9XSDdPedv.svg?x)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Gitter](https://badges.gitter.im/zyantific/zyan-disassembler-engine.svg)](https://gitter.im/zyantific/zyan-disassembler-engine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge) [![Build status](https://ci.appveyor.com/api/projects/status/2tad27q0b9v6qtga/branch/master?svg=true)](https://ci.appveyor.com/project/athre0z/zydis/branch/master)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Gitter](https://badges.gitter.im/zyantific/zyan-disassembler-engine.svg)](https://gitter.im/zyantific/zydis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge) [![Discord](https://img.shields.io/discord/390136917779415060.svg)](https://discordapp.com/channels/390136917779415060/390138781313007626) [![Build status](https://ci.appveyor.com/api/projects/status/2tad27q0b9v6qtga/branch/master?svg=true)](https://ci.appveyor.com/project/athre0z/zydis/branch/master)
 
 Fast and lightweight x86/x86-64 disassembler library.
 
 ## Features
 
-- Supports all x86 and x86-64 (AMD64) instructions.
-- Supports pretty much all ISA extensions (list incomplete):
-  - FPU (x87), MMX
-  - SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, SSE4A, AESNI
-  - AVX, AVX2, AVX512BW, AVX512CD, AVX512DQ, AVX512ER, AVX512F, AVX512PF, AVX512VL
-  - ADX, BMI1, BMI2, FMA, FMA4
+- Supports all x86 and x86-64 (AMD64) instructions and [extensions](https://github.com/zyantific/zydis/blob/master/include/Zydis/Generated/EnumISAExt.h)
 - Optimized for high performance
 - No dynamic memory allocation ("malloc")
+- Thread-safe by design
 - Very small file-size overhead compared to other common disassembler libraries
 - [Complete doxygen documentation](https://www.zyantific.com/doc/zydis/index.html)
-- No dependencies on platform specific APIs
-  - Should compile on any platform with a complete libc and CMake
-  - Tested on Windows, macOS and Linux
-
-## Roadmap
-
-- Language bindings [v2.0 final]
-- Tests [v2.0 final]
-- Graphical editor for the instruction-database [v2.0 final]
-- Implement CMake feature gates. Currently, everything is always included. [v2.0 final]
-- Encoding support [v2.1]
+- Absolutely no dependencies — [not even libc](https://github.com/zyantific/zydis/blob/develop/CMakeLists.txt#L32)
+  - Should compile on any platform with a working C99 compiler
+  - Tested on Windows, macOS, FreeBSD and Linux, both user and kernel mode
 
 ## Quick Example
 
 The following example program uses Zydis to disassemble a given memory buffer and prints the output to the console.
 
 ```C
 #include <stdio.h>
+#include <inttypes.h>
 #include <Zydis/Zydis.h>
 
 int main()
 {
     uint8_t data[] =
     {
-        0x51, 0x8D, 0x45, 0xFF, 0x50, 0xFF, 0x75, 0x0C, 0xFF, 0x75, 
-        0x08, 0xFF, 0x15, 0xA0, 0xA5, 0x48, 0x76, 0x85, 0xC0, 0x0F, 
+        0x51, 0x8D, 0x45, 0xFF, 0x50, 0xFF, 0x75, 0x0C, 0xFF, 0x75,
+        0x08, 0xFF, 0x15, 0xA0, 0xA5, 0x48, 0x76, 0x85, 0xC0, 0x0F,
         0x88, 0xFC, 0xDA, 0x02, 0x00
     };
 
     // Initialize decoder context.
     ZydisDecoder decoder;
     ZydisDecoderInit(
-        &decoder, 
-        ZYDIS_MACHINE_MODE_LONG_64, 
+        &decoder,
+        ZYDIS_MACHINE_MODE_LONG_64,
         ZYDIS_ADDRESS_WIDTH_64);
 
     // Initialize formatter. Only required when you actually plan to
     // do instruction formatting ("disassembling"), like we do here.
     ZydisFormatter formatter;
     ZydisFormatterInit(&formatter, ZYDIS_FORMATTER_STYLE_INTEL);
-  
+
     // Loop over the instructions in our buffer.
+    // The IP is chosen arbitrary here in order to better visualize
+    // relative addressing.
     uint64_t instructionPointer = 0x007FFFFFFF400000;
-    uint8_t* readPointer = data;
+    size_t offset = 0;
     size_t length = sizeof(data);
     ZydisDecodedInstruction instruction;
     while (ZYDIS_SUCCESS(ZydisDecoderDecodeBuffer(
-        &decoder, readPointer, length, instructionPointer, &instruction)))
+        &decoder, data + offset, length - offset,
+        instructionPointer, &instruction)))
     {
         // Print current instruction pointer.
         printf("%016" PRIX64 "  ", instructionPointer);
 
-        // Format & print the binary instruction 
+        // Format & print the binary instruction
         // structure to human readable format.
         char buffer[256];
         ZydisFormatterFormatInstruction(
             &formatter, &instruction, buffer, sizeof(buffer));
         puts(buffer);
 
-        readPointer += instruction.length;
-        length -= instruction.length;
+        offset += instruction.length;
         instructionPointer += instruction.length;
     }
 }
@@ -96,25 +87,30 @@ The above example program generates the following output:
 007FFFFFFF400013   js 0x007FFFFFFF42DB15
 ```
 
-## Compilation
+## Build
+
+#### Unix
 
 Zydis builds cleanly on most platforms without any external dependencies. You can use CMake to generate project files for your favorite C99 compiler.
 
 ```bash
-# Linux and OS X
 git clone 'https://github.com/zyantific/zydis.git'
 cd zydis
 mkdir build && cd build
 cmake ..
 make
 ```
 
+#### Windows
+
+Either use the [Visual Studio 2017 project](https://github.com/zyantific/zydis/tree/master/msvc) or build Zydis using [CMake](https://cmake.org/download/) ([video guide](https://www.youtube.com/watch?v=fywLDK1OAtQ)).
+
 ## `ZydisInfo` tool
 ![ZydisInfo](https://raw.githubusercontent.com/zyantific/zydis/master/assets/screenshots/ZydisInfo.png)
 
 ## Credits
 - Intel (for open-sourcing [XED](https://github.com/intelxed/xed), allowing for automatic comparision of our tables against theirs, improving both)
-- LLVM (for providing pretty solid instruction data as well)
+- [LLVM](https://llvm.org) (for providing pretty solid instruction data as well)
 - Christian Ludloff (http://sandpile.org, insanely helpful)
 - [LekoArts](https://www.lekoarts.de/) (for creating the project logo)
 - Our [contributors on GitHub](https://github.com/zyantific/zydis/graphs/contributors)