Merge remote-tracking branch 'upstream/master'

.gitignore

@@ -5,4 +5,5 @@ obj/
 .vs
 x64/
 Release/
-Debug/
+Debug/
+build/

CMakeLists.txt

@@ -51,32 +51,126 @@ src/virtual_machine.cpp
 src/vm_compiled_light.cpp
 src/blake2/blake2b.c)
 
-if (NOT ARCH_ID)
-  set(ARCH_ID ${CMAKE_HOST_SYSTEM_PROCESSOR})
+if(NOT ARCH_ID)
+  # allow cross compiling
+  if(CMAKE_SYSTEM_PROCESSOR STREQUAL "")
+    set(CMAKE_SYSTEM_PROCESSOR ${CMAKE_HOST_SYSTEM_PROCESSOR})
+  endif()
+  string(TOLOWER "${CMAKE_SYSTEM_PROCESSOR}" ARCH_ID)
+endif()
+
+if(NOT ARM_ID)
+  set(ARM_ID "${ARCH_ID}")
+endif()
+
+if(NOT ARCH)
+  set(ARCH "default")
 endif()
 
 if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE Release)
+  message(STATUS "Setting default build type: ${CMAKE_BUILD_TYPE}")
 endif()
 
+include(CheckCXXCompilerFlag)
+include(CheckCCompilerFlag)
+
+function(add_flag flag)
+  string(REPLACE "-" "_" supported_cxx ${flag}_cxx)
+  check_cxx_compiler_flag(${flag} ${supported_cxx})
+  if(${${supported_cxx}})
+    message(STATUS "Setting CXX flag ${flag}")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flag}" PARENT_SCOPE)
+  endif()
+  string(REPLACE "-" "_" supported_c ${flag}_c)
+  check_c_compiler_flag(${flag} ${supported_c})
+  if(${${supported_c}})
+    message(STATUS "Setting C flag ${flag}")
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${flag}" PARENT_SCOPE)
+  endif()
+endfunction()
+
+# x86-64
 if (ARCH_ID STREQUAL "x86_64" OR ARCH_ID STREQUAL "x86-64" OR ARCH_ID STREQUAL "amd64")
   list(APPEND randomx_sources
     src/jit_compiler_x86_static.S
     src/jit_compiler_x86.cpp)
-  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -maes")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -maes")
+  # cheat because cmake and ccache hate each other
+  set_property(SOURCE src/jit_compiler_x86_static.S PROPERTY LANGUAGE C)
+
+  if(ARCH STREQUAL "native")
+    add_flag("-march=native")
+  else()
+    # default build has hardware AES enabled (software AES can be selected at runtime)
+    add_flag("-maes")
+  endif()
+endif()
+
+# PowerPC
+if (ARCH_ID STREQUAL "ppc64" OR ARCH_ID STREQUAL "ppc64le")
+  if(ARCH STREQUAL "native")
+    add_flag("-mcpu=native")
+  endif()
+  # PowerPC AES requires ALTIVEC (POWER7+), so it cannot be enabled in the default build
+endif()
+
+# ARMv8
+if (ARM_ID STREQUAL "aarch64" OR ARM_ID STREQUAL "arm64" OR ARM_ID STREQUAL "armv8-a")
+  if(ARCH STREQUAL "native")
+    add_flag("-march=native")
+  else()
+    # default build has hardware AES enabled (software AES can be selected at runtime)
+    add_flag("-march=armv8-a+crypto")
+  endif()
 endif()
 
 set(RANDOMX_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/src" CACHE STRING "RandomX Include path")
 
 add_library(randomx
   ${randomx_sources})
-target_link_libraries(randomx
-  PRIVATE
-    ${CMAKE_THREAD_LIBS_INIT})
 set_property(TARGET randomx PROPERTY POSITION_INDEPENDENT_CODE ON)
 set_property(TARGET randomx PROPERTY CXX_STANDARD 11)
 set_property(TARGET randomx PROPERTY CXX_STANDARD_REQUIRED ON)
 
-# cheat because cmake and ccache hate each other
-set_property(SOURCE src/jit_compiler_x86_static.S PROPERTY LANGUAGE C)
+add_executable(randomx-tests
+  src/tests/tests.cpp)
+target_link_libraries(randomx-tests
+  PRIVATE randomx)
+set_property(TARGET randomx-tests PROPERTY POSITION_INDEPENDENT_CODE ON)
+set_property(TARGET randomx-tests PROPERTY CXX_STANDARD 11)
+
+add_executable(randomx-codegen
+  src/tests/code-generator.cpp)
+target_link_libraries(randomx-codegen
+  PRIVATE randomx)
+
+set_property(TARGET randomx-codegen PROPERTY POSITION_INDEPENDENT_CODE ON)
+set_property(TARGET randomx-codegen PROPERTY CXX_STANDARD 11)
+
+if (NOT Threads_FOUND AND UNIX AND NOT APPLE)
+  set(THREADS_PREFER_PTHREAD_FLAG ON)
+  find_package(Threads)
+endif()
+
+add_executable(randomx-benchmark
+  src/tests/benchmark.cpp
+  src/tests/affinity.cpp)
+target_link_libraries(randomx-benchmark
+  PRIVATE randomx
+  PRIVATE ${CMAKE_THREAD_LIBS_INIT})
+
+include(CheckCXXSourceCompiles)
+check_cxx_source_compiles("
+#include <cstdint>
+#include <atomic>
+int main() {
+  std::atomic<uint64_t> a;
+  a.is_lock_free();
+}" HAVE_CXX_ATOMICS)
+
+if(NOT HAVE_CXX_ATOMICS)
+  target_link_libraries(randomx-benchmark
+    PRIVATE "atomic")
+endif()
+set_property(TARGET randomx-benchmark PROPERTY POSITION_INDEPENDENT_CODE ON)
+set_property(TARGET randomx-benchmark PROPERTY CXX_STANDARD 11)

README.md

@@ -20,23 +20,28 @@ Design description and analysis is available in [design.md](doc/design.md).
 
 ## Build
 
-RandomX is written in C++11 and builds a static library with a C API provided by header file [randomx.h](src/randomx.h). Minimal API usage example is provided in [api-example1.c](src/tests/api-example1.c). The reference code includes a `benchmark` executable for testing.
+RandomX is written in C++11 and builds a static library with a C API provided by header file [randomx.h](src/randomx.h). Minimal API usage example is provided in [api-example1.c](src/tests/api-example1.c). The reference code includes a `randomx-benchmark` and `randomx-tests` executables for testing.
 
 ### Linux
 
-Build dependencies: `make` and `gcc` (minimum version 4.8, but version 7+ is recommended).
+Build dependencies: `cmake` (minimum 2.8.7) and `gcc` (minimum version 4.8, but version 7+ is recommended).
 
-Build using the provided makefile.
+To build optimized binaries for your machine, run:
+```
+git clone https://github.com/tevador/RandomX.git
+cd RandomX
+mkdir build && cd build
+cmake -DARCH=native ..
+make
+```
 
 ### Windows
 
-Build dependencies: Visual Studio 2017.
-
-A solution file is provided.
+On Windows, it is possible to build using MinGW (same procedure as on Linux) or using Visual Studio 2017 (solution file is provided).
 
 ### Precompiled binaries
 
-Precompiled `benchmark` binaries are available on the [Releases page](https://github.com/tevador/RandomX/releases).
+Precompiled `randomx-benchmark` binaries are available on the [Releases page](https://github.com/tevador/RandomX/releases).
 
 ## Proof of work
 

doc/configuration.md

@@ -192,14 +192,30 @@ There is a total of 29 different instructions. The sum of frequencies must be eq
 
 #### Notes
 
-Making large changes to the default values is not recommended. The only exceptions are the instruction pairs IROR_R/IROL_R, FADD_R/FSUB_R and FADD_M/FSUB_M, which are functionally equivalent.
+Making changes to the default values is not recommended. The only exceptions are the instruction pairs IROR_R/IROL_R, FADD_R/FSUB_R and FADD_M/FSUB_M, which are functionally equivalent. Example of a safe custom configuration:
+
+||default|custom|
+|-|------|------|-|
+|`RANDOMX_FREQ_IROR_R`|8|5|
+|`RANDOMX_FREQ_IROL_R`|2|5|
+
+||default|custom|
+|-|------|------|
+|`RANDOMX_FREQ_FADD_R`|16|17|
+|`RANDOMX_FREQ_FSUB_R`|16|15|
+
+||default|custom|
+|-|------|------|
+|`RANDOMX_FREQ_FADD_M`|5|4|
+|`RANDOMX_FREQ_FSUB_M`|5|6|
 
 ## Unsafe configurations
 
 There are some configurations that are considered 'unsafe' because they affect the security of the algorithm against attacks. If the conditions listed below are not satisfied, the configuration is unsafe and a compilation error is emitted when building the RandomX library.
 
 These checks can be disabled by definining `RANDOMX_UNSAFE` when building RandomX, e.g. by using `-DRANDOMX_UNSAFE` command line switch in GCC or MSVC. It is not recommended to disable these checks except for testing purposes.
 
+
 ### 1. Memory-time tradeoffs
 
 #### Condition