QBDI · nsurbay · Sep 27, 2021 · Sep 27, 2021 · Sep 27, 2021 · Sep 27, 2021
diff --git a/README.rst b/README.rst
@@ -209,22 +209,30 @@ Then, the following commands must be run::
 Android
 +++++++
 
-Cross-compiling for Android requires the NDK to be installed on your workstation. For now, it has only been tested under Linux.
-If not already installed, you can download the latest Android NDK package through the `official website <https://developer.android.com/ndk/downloads>`_.
-Afterwards, the ``config-android-*.sh`` configuration script needs to be customised to match your NDK installation
-directory and the target platform:
-
-* ``NDK_PATH`` should point to your Android NDK
+Cross-compiling for Android requires the NDK (or the SDK) to be installed on your workstation.
+For now, it has only been tested under Linux.
+If not already installed, you can download the latest Android NDK package
+through the `official website <https://developer.android.com/ndk/downloads>`_
+and extract it.
+Afterwards, the ``config-android-*.sh`` configuration script needs to be
+customised to match your NDK installation directory and the target platform.::
+
+    # Configure and compile QBDI X86_64 with a NDK
+    mkdir build && cd build
+    NDK_PATH=<your_NDK_PATH> ../cmake/config/config-android-X86_64.sh
+    ninja
 
-At this point, you should be able to continue following the instructions of the Linux section since the procedure is the same.
+    # Configure and compile QBDI X86 with a SDK
+    mkdir build && cd build
+    ANDROID_SDK_ROOT=<your_SDK_PATH> ../cmake/config/config-android-X86.sh
+    ninja
 
 PyQBDI compilation
 ++++++++++++++++++
 
 The PyQDBI library (apart from the wheel package) can be built by solely passing the **'-DQBDI_TOOLS_PYQBDI=ON'** option to the CMake build system.
 
-However, if you want to build the wheel package, you have to compile the LLVM libraries beforehand.
-Once done, you can run these commands::
+However, if you want to build the wheel package, you can run these commands::
 
     python -m pip install --upgrade pip
     python -m pip install setuptools wheel

diff --git a/docs/qbdi_c.doxygen.in b/docs/qbdi_c.doxygen.in
diff --git a/docs/qbdi_cpp.doxygen.in b/docs/qbdi_cpp.doxygen.in
diff --git a/docs/qbdipreload.doxygen.in b/docs/qbdipreload.doxygen.in
diff --git a/docs/source/api_c.rst b/docs/source/api_c.rst
@@ -138,10 +138,10 @@ MemoryAccess
 InstrRuleCallback
 ^^^^^^^^^^^^^^^^^
 
-.. doxygenfunction:: qbdi_addInstrRule(InstrRuleCallback cbk, AnalysisType type, void* data)
+.. doxygenfunction:: qbdi_addInstrRule
     :project: QBDI_C
 
-.. doxygenfunction:: qbdi_addInstrRuleRange(rword start, rword end, InstrRuleCallback cbk, AnalysisType type, void* data)
+.. doxygenfunction:: qbdi_addInstrRuleRange
     :project: QBDI_C
 
 Removal
@@ -223,14 +223,14 @@ Register state
 
     For X86 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86/State.h
        :start-after: SPHINX_X86_GPRSTATE_BEGIN
        :end-before: // SPHINX_X86_GPRSTATE_END
        :code:
 
     For X86_64 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86_64/State.h
        :start-after: SPHINX_X86_64_GPRSTATE_BEGIN
        :end-before: // SPHINX_X86_64_GPRSTATE_END
        :code:
@@ -241,14 +241,14 @@ Register state
 
     For X86 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86/State.h
        :start-after: SPHINX_X86_FPRSTATE_BEGIN
        :end-before: // SPHINX_X86_FPRSTATE_END
        :code:
 
     For X86_64 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86_64/State.h
        :start-after: SPHINX_X86_64_FPRSTATE_BEGIN
        :end-before: // SPHINX_X86_64_FPRSTATE_END
        :code:
@@ -302,6 +302,9 @@ Callback
 .. doxygenenum:: InstPosition
     :project: QBDI_C
 
+.. doxygenenum:: CallbackPriority
+    :project: QBDI_C
+
 .. doxygenenum:: VMAction
     :project: QBDI_C
 
@@ -430,9 +433,14 @@ Log
 .. doxygenenum:: LogPriority
     :project: QBDI_C
 
-.. doxygenfunction:: qbdi_setLogOutput
+.. doxygenfunction:: qbdi_setLogFile
     :project: QBDI_C
 
-.. doxygenfunction:: qbdi_addLogFilter
+.. doxygenfunction:: qbdi_setLogConsole
     :project: QBDI_C
 
+.. doxygenfunction:: qbdi_setLogDefault
+    :project: QBDI_C
+
+.. doxygenfunction:: qbdi_setLogPriority
+    :project: QBDI_C
diff --git a/docs/source/api_cpp.rst b/docs/source/api_cpp.rst
@@ -172,14 +172,14 @@ Register state
 
     For X86 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86/State.h
        :start-after: SPHINX_X86_GPRSTATE_BEGIN
        :end-before: // SPHINX_X86_GPRSTATE_END
        :code:
 
     For X86_64 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86_64/State.h
        :start-after: SPHINX_X86_64_GPRSTATE_BEGIN
        :end-before: // SPHINX_X86_64_GPRSTATE_END
        :code:
@@ -190,14 +190,14 @@ Register state
 
     For X86 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86/State.h
        :start-after: SPHINX_X86_FPRSTATE_BEGIN
        :end-before: // SPHINX_X86_FPRSTATE_END
        :code:
 
     For X86_64 architecture:
 
-    .. include:: ../../include/QBDI/State.h
+    .. include:: ../../include/QBDI/arch/X86_64/State.h
        :start-after: SPHINX_X86_64_FPRSTATE_BEGIN
        :end-before: // SPHINX_X86_64_FPRSTATE_END
        :code:
@@ -243,6 +243,8 @@ Callback
 
 .. doxygenenum:: QBDI::InstPosition
 
+.. doxygenenum:: QBDI::CallbackPriority
+
 .. doxygenenum:: QBDI::VMAction
 
 .. _instanalysis-cpp:
@@ -340,9 +342,13 @@ Log
 
 .. doxygenenum:: QBDI::LogPriority
 
-.. doxygenfunction:: QBDI::setLogOutput
+.. doxygenfunction:: QBDI::setLogFile
+
+.. doxygenfunction:: QBDI::setLogPriority
+
+.. doxygenfunction:: QBDI::setLogConsole
 
-.. doxygenfunction:: QBDI::addLogFilter
+.. doxygenfunction:: QBDI::setLogDefault
 
 Range
 +++++

diff --git a/docs/source/api_js.rst b/docs/source/api_js.rst
@@ -274,6 +274,11 @@ Callback
     .. js:autoattribute:: PREINST
     .. js:autoattribute:: POSTINST
 
+.. js:autoclass:: CallbackPriority
+
+    .. js:autoattribute:: PRIORITY_DEFAULT
+    .. js:autoattribute:: PRIORITY_MEMACCESS_LIMIT
+
 .. _instanalysis-js:
 
 InstAnalysis

diff --git a/docs/source/api_pyqbdi.rst b/docs/source/api_pyqbdi.rst
@@ -229,6 +229,8 @@ Callback
 
 .. autodata:: pyqbdi.InstPosition
 
+.. autodata:: pyqbdi.CallbackPriority
+
 .. autodata:: pyqbdi.VMAction
 
 .. _instanalysis-pyqbdi:
@@ -332,7 +334,7 @@ Log
 
 .. autodata:: pyqbdi.LogPriority
 
-.. autofunction:: pyqbdi.addLogFilter
+.. autofunction:: pyqbdi.setLogPriority
 
 Range
 +++++

diff --git a/docs/source/compilation.rst b/docs/source/compilation.rst
@@ -1,8 +1,40 @@
-.. _developer-compilation:
 
 Compilation From Source
 =======================
 
 .. include:: ../../README.rst
     :start-after: .. compil
     :end-before: .. compil-end
+
+CMake Parameters
+++++++++++++++++
+
+The compilation of QBDI can be configured with the command line. Each parameter
+should be placed on the command line with the form ``-D<param>=<value>``.
+
+* ``QBDI_PLATFORM`` (mandatory) : Target platform of the compilation
+  (supported: ``windows``, ``linux``, ``android``, ``osx``)
+* ``QBDI_ARCH`` (mandatory) : Target architecture of the compilation
+  (supported: ``X86_64``, ``X86``)
+* ``QBDI_CCACHE`` (default ON) : enable compilation optimisation with ccache or sccache.
+* ``QBDI_DISABLE_AVX`` (default OFF) : disable the support of AVX instruction
+  on X86 and X86_64
+* ``QBDI_ASAN`` (default OFF) : compile with ASAN to detect memory leak in QBDI.
+* ``QBDI_LOG_DEBUG`` (default OFF) : enable the debug level of the logging
+  system. Note that the support of this level has an impact on the performances,
+  even if this log level is not enabled.
+* ``QBDI_STATIC_LIBRARY`` (default ON) : build the static library of QBDI. Note
+  than some subproject need ``QBDI_STATIC_LIBRARY`` (test, PyQBDI, ...)
+* ``QBDI_SHARED_LIBRARY`` (default ON) : build the shared library of QBDI. Note
+  than some subproject need ``QBDI_SHARED_LIBRARY`` (Frida/QBDI, examples, ...)
+* ``QBDI_TEST`` (default ON) : build the tests suite
+* ``QBDI_BENCHMARK`` (default OFF) : build the benchmark tools
+* ``QBDI_TOOLS_QBDIPRELOAD`` (default ON on supported platform) : build
+  QBDIPreload static library (supported on Linux and OSX).
+* ``QBDI_TOOLS_VALIDATOR`` (default ON on supported platform) : build
+  the validator library (supported on Linux and OSX).
+* ``QBDI_TOOLS_PYQBDI`` (default ON on X86_64) : build PyQBDI library.
+  Supported on Linux, Windows and OSX.
+* ``QBDI_TOOLS_FRIDAQBDI`` (default ON) : add Frida/QBDI in the package.
+
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -55,11 +55,12 @@ def extract_version(cmakefile):
 
 if read_the_docs_build:
     # Update documentation in doxygen config file (what is normally done by cmake)
-    sedcmd = "sed 's/${QBDI_VERSION_MAJOR}/%u/;s/${QBDI_VERSION_MINOR}/%u/;s/${QBDI_VERSION_PATCH}/%u/'" % (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
+    sedcmd = "sed 's/${QBDI_VERSION_MAJOR}/%u/;s/${QBDI_VERSION_MINOR}/%u/;s/${QBDI_VERSION_PATCH}/%u/;s/${CMAKE_CURRENT_BINARY_DIR}/./ '" % (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
     # Call doxygen
     subprocess.call("cd ../; %s qbdi_cpp.doxygen.in > qbdi_cpp.doxygen" % sedcmd, shell=True)
     subprocess.call("cd ../; %s qbdi_c.doxygen.in > qbdi_c.doxygen" % sedcmd, shell=True)
     subprocess.call("cd ../; %s qbdipreload.doxygen.in > qbdipreload.doxygen" % sedcmd, shell=True)
+    subprocess.call("cp ../../include/QBDI/arch/X86_64/* ../../include/QBDI/", shell=True)
     subprocess.call('cd ../; doxygen qbdi_cpp.doxygen', shell=True)
     subprocess.call('cd ../; doxygen qbdi_c.doxygen', shell=True)
     subprocess.call('cd ../; doxygen qbdipreload.doxygen', shell=True)

diff --git a/docs/source/dev.rst b/docs/source/dev.rst
@@ -3,7 +3,7 @@ Developer Documentation
 
 .. toctree::
     :maxdepth: 2
- 
+
     Compilation <compilation>
     Repository Organization <repo_organization>
     Testing <testing>

diff --git a/docs/source/get_started-c.rst b/docs/source/get_started-c.rst
@@ -107,7 +107,7 @@ a callback for every instruction. The callback can be called before the instruct
 
 .. code:: c
 
-    uint32_t cid = qbdi_addCodeCB(vm, QBDI_PREINST, showInstruction, NULL);
+    uint32_t cid = qbdi_addCodeCB(vm, QBDI_PREINST, showInstruction, NULL, 0);
     assert(cid != QBDI_INVALID_EVENTID);
 
 The function returns a callback ID or the special ID :cpp:enumerator:`QBDI_INVALID_EVENTID <VMError::QBDI_INVALID_EVENTID>` if
@@ -130,7 +130,7 @@ All QBDI callbacks allow users to pass a custom parameter ``data`` of type ``voi
     }
 
     unsigned iterationCount = 0;
-    qbdi_addMnemonicCB(vm, "CALL*", QBDI_PREINST, countIteration, &iterationCount);
+    qbdi_addMnemonicCB(vm, "CALL*", QBDI_PREINST, countIteration, &iterationCount, 0);
 
 
 Set instrumented ranges

diff --git a/docs/source/logs.rst b/docs/source/logs.rst