v6.3.0

Cryptonight OpenCL: fix for long input data

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Required data**
+ - Miner log as text or screenshot
+ - Config file or command line (without wallets)
+ - OS: [e.g. Windows]
+ - For GPU related issues: information about GPUs and driver version.
+
+**Additional context**
+Add any other context about the problem here.

.gitignore

@@ -1,2 +1,4 @@
 /build
 /CMakeLists.txt.user
+/.idea
+/src/backend/opencl/cl/cn/cryptonight_gen.cl

README.md

@@ -7,38 +7,14 @@
 [![GitHub stars](https://img.shields.io/github/stars/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/stargazers)
 [![GitHub forks](https://img.shields.io/github/forks/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/network)
 
-XMRig is a high performance Monero (XMR) CPU miner, with official support for Windows.
-Originally based on cpuminer-multi with heavy optimizations/rewrites and removing a lot of legacy code, since version 1.0.0 completely rewritten from scratch on C++.
+XMRig High performance, open source, cross platform RandomX, KawPow, CryptoNight, AstroBWT and Argon2 CPU/GPU miner, with official support for Windows.
 
-* This is the **CPU-mining** version, there is also a [NVIDIA GPU version](https://github.com/xmrig/xmrig-nvidia) and [AMD GPU version]( https://github.com/xmrig/xmrig-amd).
-* [Roadmap](https://github.com/xmrig/xmrig/issues/106) for next releases.
+## Mining backends
+- **CPU** (x64/x86/ARM)
+- **OpenCL** for AMD GPUs.
+- **CUDA** for NVIDIA GPUs via external [CUDA plugin](https://github.com/xmrig/xmrig-cuda).
 
-<img src="http://i.imgur.com/Ymumes5.png" width="670" >
-
-#### Table of contents
-* [Features](#features)
-* [Download](#download)
-* [Usage](#usage)
-* [Algorithm variations](#algorithm-variations)
-* [Build](https://github.com/xmrig/xmrig/wiki/Build)
-* [Common Issues](#common-issues)
-* [Other information](#other-information)
-* [Donations](#donations)
-* [Release checksums](#release-checksums)
-* [Contacts](#contacts)
-
-## Features
-* High performance.
-* Official Windows support.
-* Small Windows executable, without dependencies.
-* x86/x64 support.
-* Support for backup (failover) mining server.
-* keepalived support.
-* Command line options compatible with cpuminer.
-* CryptoNight-Lite support for AEON.
-* Smart automatic [CPU configuration](https://github.com/xmrig/xmrig/wiki/Threads).
-* Nicehash support
-* It's open source software.
+<img src="doc/screenshot_v5_2_0.png" width="833" >
 
 ## Download
 * Binary releases: https://github.com/xmrig/xmrig/releases
@@ -46,97 +22,108 @@ Originally based on cpuminer-multi with heavy optimizations/rewrites and removin
   * Clone with `git clone https://github.com/xmrig/xmrig.git` :hammer: [Build instructions](https://github.com/xmrig/xmrig/wiki/Build).
 
 ## Usage
-Use [config.xmrig.com](https://config.xmrig.com/xmrig) to generate, edit or share configurations.
+The preferred way to configure the miner is the [JSON config file](src/config.json) as it is more flexible and human friendly. The command line interface does not cover all features, such as mining profiles for different algorithms. Important options can be changed during runtime without miner restart by editing the config file or executing API calls.
 
-### Options
+* **[xmrig.com/wizard](https://xmrig.com/wizard)** helps you create initial configuration for the miner.
+* **[workers.xmrig.info](http://workers.xmrig.info)** helps manage your miners via HTTP API.
+
+### Command line options
 ```
-  -a, --algo=ALGO          specify the algorithm to use
-                             cryptonight
-                             cryptonight-lite
-                             cryptonight-heavy
-  -o, --url=URL            URL of mining server
-  -O, --userpass=U:P       username:password pair for mining server
-  -u, --user=USERNAME      username for mining server
-  -p, --pass=PASSWORD      password for mining server
-      --rig-id=ID          rig identifier for pool-side statistics (needs pool support)
-  -t, --threads=N          number of miner threads
-  -v, --av=N               algorithm variation, 0 auto select
-  -k, --keepalive          send keepalived packet for prevent timeout (needs pool support)
-      --nicehash           enable nicehash.com support
-      --tls                enable SSL/TLS support (needs pool support)
-      --tls-fingerprint=F  pool TLS certificate fingerprint, if set enable strict certificate pinning
-  -r, --retries=N          number of times to retry before switch to backup server (default: 5)
-  -R, --retry-pause=N      time to pause between retries (default: 5)
-      --cpu-affinity       set process affinity to CPU core(s), mask 0x3 for cores 0 and 1
-      --cpu-priority       set process priority (0 idle, 2 normal to 5 highest)
-      --no-huge-pages      disable huge pages support
-      --no-color           disable colored output
-      --variant            algorithm PoW variant
-      --donate-level=N     donate level, default 5% (5 minutes in 100 minutes)
-      --user-agent         set custom user-agent string for pool
-  -B, --background         run the miner in the background
-  -c, --config=FILE        load a JSON-format configuration file
-  -l, --log-file=FILE      log all output to a file
-  -S, --syslog             use system log for output messages
-      --max-cpu-usage=N    maximum CPU usage for automatic threads mode (default 75)
-      --safe               safe adjust threads and av settings for current CPU
-      --asm=ASM            ASM code for cn/2, possible values: auto, none, intel, ryzen.
-      --print-time=N       print hashrate report every N seconds
-      --api-port=N         port for the miner API
-      --api-access-token=T access token for API
-      --api-worker-id=ID   custom worker-id for API
-      --api-id=ID          custom instance ID for API
-      --api-ipv6           enable IPv6 support for API
-      --api-no-restricted  enable full remote access (only if API token set)
-      --dry-run            test configuration and exit
-  -h, --help               display this help and exit
-  -V, --version            output version information and exit
+Network:
+  -o, --url=URL                 URL of mining server
+  -a, --algo=ALGO               mining algorithm https://xmrig.com/docs/algorithms
+      --coin=COIN               specify coin instead of algorithm
+  -u, --user=USERNAME           username for mining server
+  -p, --pass=PASSWORD           password for mining server
+  -O, --userpass=U:P            username:password pair for mining server
+  -x, --proxy=HOST:PORT         connect through a SOCKS5 proxy
+  -k, --keepalive               send keepalive packet for prevent timeout (needs pool support)
+      --nicehash                enable nicehash.com support
+      --rig-id=ID               rig identifier for pool-side statistics (needs pool support)
+      --tls                     enable SSL/TLS support (needs pool support)
+      --tls-fingerprint=HEX     pool TLS certificate fingerprint for strict certificate pinning
+      --daemon                  use daemon RPC instead of pool for solo mining
+      --daemon-poll-interval=N  daemon poll interval in milliseconds (default: 1000)
+  -r, --retries=N               number of times to retry before switch to backup server (default: 5)
+  -R, --retry-pause=N           time to pause between retries (default: 5)
+      --user-agent              set custom user-agent string for pool
+      --donate-level=N          donate level, default 5%% (5 minutes in 100 minutes)
+      --donate-over-proxy=N     control donate over xmrig-proxy feature
+
+CPU backend:
+      --no-cpu                  disable CPU mining backend
+  -t, --threads=N               number of CPU threads
+  -v, --av=N                    algorithm variation, 0 auto select
+      --cpu-affinity            set process affinity to CPU core(s), mask 0x3 for cores 0 and 1
+      --cpu-priority            set process priority (0 idle, 2 normal to 5 highest)
+      --cpu-max-threads-hint=N  maximum CPU threads count (in percentage) hint for autoconfig
+      --cpu-memory-pool=N       number of 2 MB pages for persistent memory pool, -1 (auto), 0 (disable)
+      --cpu-no-yield            prefer maximum hashrate rather than system response/stability
+      --no-huge-pages           disable huge pages support
+      --asm=ASM                 ASM optimizations, possible values: auto, none, intel, ryzen, bulldozer
+      --randomx-init=N          thread count to initialize RandomX dataset
+      --randomx-no-numa         disable NUMA support for RandomX
+      --randomx-mode=MODE       RandomX mode: auto, fast, light
+      --randomx-1gb-pages       use 1GB hugepages for dataset (Linux only)
+      --randomx-wrmsr=N         write custom value (0-15) to Intel MSR register 0x1a4 or disable MSR mod (-1)
+      --randomx-no-rdmsr        disable reverting initial MSR values on exit
+      --astrobwt-max-size=N     skip hashes with large stage 2 size, default: 550, min: 400, max: 1200
+      --astrobwt-avx2           enable AVX2 optimizations for AstroBWT algorithm
+
+API:
+      --api-worker-id=ID        custom worker-id for API
+      --api-id=ID               custom instance ID for API
+      --http-host=HOST          bind host for HTTP API (default: 127.0.0.1)
+      --http-port=N             bind port for HTTP API
+      --http-access-token=T     access token for HTTP API
+      --http-no-restricted      enable full remote access to HTTP API (only if access token set)
+
+OpenCL backend:
+      --opencl                  enable OpenCL mining backend
+      --opencl-devices=N        comma separated list of OpenCL devices to use
+      --opencl-platform=N       OpenCL platform index or name
+      --opencl-loader=PATH      path to OpenCL-ICD-Loader (OpenCL.dll or libOpenCL.so)
+      --opencl-no-cache         disable OpenCL cache
+      --print-platforms         print available OpenCL platforms and exit
+
+CUDA backend:
+      --cuda                    enable CUDA mining backend
+      --cuda-loader=PATH        path to CUDA plugin (xmrig-cuda.dll or libxmrig-cuda.so)
+      --cuda-devices=N          comma separated list of CUDA devices to use
+      --cuda-bfactor-hint=N     bfactor hint for autoconfig (0-12)
+      --cuda-bsleep-hint=N      bsleep hint for autoconfig
+      --no-nvml                 disable NVML (NVIDIA Management Library) support
+
+TLS:
+      --tls-gen=HOSTNAME        generate TLS certificate for specific hostname
+      --tls-cert=FILE           load TLS certificate chain from a file in the PEM format
+      --tls-cert-key=FILE       load TLS certificate private key from a file in the PEM format
+      --tls-dhparam=FILE        load DH parameters for DHE ciphers from a file in the PEM format
+      --tls-protocols=N         enable specified TLS protocols, example: "TLSv1 TLSv1.1 TLSv1.2 TLSv1.3"
+      --tls-ciphers=S           set list of available ciphers (TLSv1.2 and below)
+      --tls-ciphersuites=S      set list of available TLSv1.3 ciphersuites
+
+Logging:
+  -S, --syslog                  use system log for output messages
+  -l, --log-file=FILE           log all output to a file
+      --print-time=N            print hashrate report every N seconds
+      --health-print-time=N     print health report every N seconds
+      --no-color                disable colored output
+      --verbose                 verbose output
+
+Misc:
+  -c, --config=FILE             load a JSON-format configuration file
+  -B, --background              run the miner in the background
+  -V, --version                 output version information and exit
+  -h, --help                    display this help and exit
+      --dry-run                 test configuration and exit
+      --export-topology         export hwloc topology to a XML file and exit
+      --title                   set custom console window title
+      --no-title                disable setting console window title      
 ```
 
-Also you can use configuration via config file, default name **config.json**. Some options available only via config file: [`autosave`](https://github.com/xmrig/xmrig/issues/767), [`hw-aes`](https://github.com/xmrig/xmrig/issues/563). `watch` option currently not implemented in miners only in proxy.
-
-## Algorithm variations
-
-- `av` option used for automatic and simple threads mode (when you specify only threads count).
-- For [advanced threads mode](https://github.com/xmrig/xmrig/issues/563) each thread configured individually and `av` option not used.
-
-| av | Hashes per round | Hardware AES |
-|----|------------------|--------------|
-| 1  | 1 (Single)       | yes          |
-| 2  | 2 (Double)       | yes          |
-| 3  | 1 (Single)       | no           |
-| 4  | 2 (Double)       | no           |
-| 5  | 3 (Triple)       | yes          |
-| 6  | 4 (Quard)        | yes          |
-| 7  | 5 (Penta)        | yes          |
-| 8  | 3 (Triple)       | no           |
-| 9  | 4 (Quard)        | no           |
-| 10 | 5 (Penta)        | no           |
-
-## Common Issues
-### HUGE PAGES unavailable
-* Run XMRig as Administrator.
-* Since version 0.8.0 XMRig automatically enables SeLockMemoryPrivilege for current user, but reboot or sign out still required. [Manual instruction](https://msdn.microsoft.com/en-gb/library/ms190730.aspx).
-
-## Other information
-* No HTTP support, only stratum protocol support.
-* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via option `donate-level`.
-
-
-### CPU mining performance
-* **Intel i7-7700** - 307 H/s (4 threads)
-* **AMD Ryzen 7 1700X** - 560 H/s (8 threads)
-
-Please note performance is highly dependent on system load. The numbers above are obtained on an idle system. Tasks heavily using a processor cache, such as video playback, can greatly degrade hashrate. Optimal number of threads depends on the size of the L3 cache of a processor, 1 thread requires 2 MB of cache.
-
-### Maximum performance checklist
-* Idle operating system.
-* Do not exceed optimal thread count.
-* Use modern CPUs with AES-NI instruction set.
-* Try setup optimal cpu affinity.
-* Enable fast memory (Large/Huge pages).
-
 ## Donations
+* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via option `donate-level` or disabled in source code.
 * XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
 * BTC: `1P7ujsXeX7GxQwHNnJsRMgAdNkFZmNVqJT`
 

bin/WinRing0/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2007-2009 OpenLibSys.org. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cmake/FindHWLOC.cmake

@@ -0,0 +1,25 @@
+find_path(
+    HWLOC_INCLUDE_DIR
+    NAMES hwloc.h
+    PATHS "${XMRIG_DEPS}" ENV "XMRIG_DEPS"
+    PATH_SUFFIXES "include"
+    NO_DEFAULT_PATH
+)
+
+find_path(HWLOC_INCLUDE_DIR NAMES hwloc.h)
+
+find_library(
+    HWLOC_LIBRARY
+    NAMES hwloc.a hwloc libhwloc
+    PATHS "${XMRIG_DEPS}" ENV "XMRIG_DEPS"
+    PATH_SUFFIXES "lib"
+    NO_DEFAULT_PATH
+)
+
+find_library(HWLOC_LIBRARY NAMES hwloc.a hwloc libhwloc)
+
+set(HWLOC_LIBRARIES ${HWLOC_LIBRARY})
+set(HWLOC_INCLUDE_DIRS ${HWLOC_INCLUDE_DIR})
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(HWLOC DEFAULT_MSG HWLOC_LIBRARY HWLOC_INCLUDE_DIR)

cmake/FindMHD.cmake

@@ -1,49 +0,0 @@
-# - Try to find MHD
-# Once done this will define
-#
-#  MHD_FOUND - system has MHD
-#  MHD_INCLUDE_DIRS - the MHD include directory
-#  MHD_LIBRARY - Link these to use MHD
-
-find_path(
-    MHD_INCLUDE_DIR
-    NAMES microhttpd.h
-    PATHS "${XMRIG_DEPS}" ENV "XMRIG_DEPS"
-    PATH_SUFFIXES "include"
-    DOC "microhttpd include dir"
-    NO_DEFAULT_PATH
-)
-
-find_path(MHD_INCLUDE_DIR NAMES microhttpd.h)
-
-find_library(
-    MHD_LIBRARY
-    NAMES libmicrohttpd.a microhttpd libmicrohttpd
-    PATHS "${XMRIG_DEPS}" ENV "XMRIG_DEPS"
-    PATH_SUFFIXES "lib"
-    DOC "microhttpd library"
-    NO_DEFAULT_PATH
-)
-
-find_library(MHD_LIBRARY NAMES microhttpd libmicrohttpd)
-
-set(MHD_INCLUDE_DIRS ${MHD_INCLUDE_DIR})
-set(MHD_LIBRARIES ${MHD_LIBRARY})
-
-# debug library on windows
-# same naming convention as in qt (appending debug library with d)
-# boost is using the same "hack" as us with "optimized" and "debug"
-# official MHD project actually uses _d suffix
-if (${CMAKE_CXX_COMPILER_ID} STREQUAL MSVC)
-    find_library(
-        MHD_LIBRARY_DEBUG
-        NAMES microhttpd_d microhttpd-10_d libmicrohttpd_d libmicrohttpd-dll_d
-        DOC "mhd debug library"
-    )
-    set(MHD_LIBRARIES optimized ${MHD_LIBRARIES} debug ${MHD_LIBRARY_DEBUG})
-endif()
-
-include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args(MHD DEFAULT_MSG MHD_LIBRARY MHD_INCLUDE_DIR)
-mark_as_advanced(MHD_INCLUDE_DIR MHD_LIBRARY)
-

cmake/OpenSSL.cmake

@@ -5,21 +5,55 @@ if (WITH_TLS)
         set(OPENSSL_USE_STATIC_LIBS TRUE)
         set(OPENSSL_MSVC_STATIC_RT TRUE)
 
-        set(EXTRA_LIBS ${EXTRA_LIBS} Crypt32)
+        set(EXTRA_LIBS ${EXTRA_LIBS} crypt32)
+    elseif (APPLE)
+        set(OPENSSL_USE_STATIC_LIBS TRUE)
     endif()
 
     find_package(OpenSSL)
 
     if (OPENSSL_FOUND)
-        set(TLS_SOURCES src/common/net/Tls.h src/common/net/Tls.cpp)
+        set(TLS_SOURCES
+            src/base/net/stratum/Tls.cpp
+            src/base/net/stratum/Tls.h
+            src/base/net/tls/ServerTls.cpp
+            src/base/net/tls/ServerTls.h
+            src/base/net/tls/TlsConfig.cpp
+            src/base/net/tls/TlsConfig.h
+            src/base/net/tls/TlsContext.cpp
+            src/base/net/tls/TlsContext.h
+            src/base/net/tls/TlsGen.cpp
+            src/base/net/tls/TlsGen.h
+            )
+
         include_directories(${OPENSSL_INCLUDE_DIR})
+
+        if (WITH_HTTP)
+            set(TLS_SOURCES ${TLS_SOURCES}
+                src/base/net/https/HttpsClient.cpp
+                src/base/net/https/HttpsClient.h
+                src/base/net/https/HttpsContext.cpp
+                src/base/net/https/HttpsContext.h
+                src/base/net/https/HttpsServer.cpp
+                src/base/net/https/HttpsServer.h
+                )
+        endif()
     else()
         message(FATAL_ERROR "OpenSSL NOT found: use `-DWITH_TLS=OFF` to build without TLS support")
     endif()
+
+    add_definitions(/DXMRIG_FEATURE_TLS)
 else()
     set(TLS_SOURCES "")
     set(OPENSSL_LIBRARIES "")
-    add_definitions(/DXMRIG_NO_TLS)
+    remove_definitions(/DXMRIG_FEATURE_TLS)
+
+    if (WITH_HTTP)
+        set(TLS_SOURCES ${TLS_SOURCES}
+            src/base/net/http/HttpServer.cpp
+            src/base/net/http/HttpServer.h
+            )
+    endif()
 
     set(CMAKE_PROJECT_NAME "${CMAKE_PROJECT_NAME}-notls")
 endif()

cmake/argon2.cmake

@@ -0,0 +1,18 @@
+if (WITH_ARGON2)
+    add_definitions(/DXMRIG_ALGO_ARGON2)
+
+    list(APPEND HEADERS_CRYPTO
+        src/crypto/argon2/Hash.h
+        src/crypto/argon2/Impl.h
+    )
+
+    list(APPEND SOURCES_CRYPTO
+        src/crypto/argon2/Impl.cpp
+    )
+
+    add_subdirectory(src/3rdparty/argon2)
+    set(ARGON2_LIBRARY argon2)
+else()
+    remove_definitions(/DXMRIG_ALGO_ARGON2)
+    set(ARGON2_LIBRARY "")
+endif()

cmake/asm.cmake

@@ -6,13 +6,13 @@ if (WITH_ASM AND NOT XMRIG_ARM AND CMAKE_SIZEOF_VOID_P EQUAL 8)
 
         if (MSVC_TOOLSET_VERSION GREATER_EQUAL 141)
             set(XMRIG_ASM_FILES
-                "src/crypto/asm/cn_main_loop.asm"
-                "src/crypto/asm/CryptonightR_template.asm"
+                "src/crypto/cn/asm/cn_main_loop.asm"
+                "src/crypto/cn/asm/CryptonightR_template.asm"
             )
         else()
             set(XMRIG_ASM_FILES
-                "src/crypto/asm/win64/cn_main_loop.asm"
-                "src/crypto/asm/win64/CryptonightR_template.asm"
+                "src/crypto/cn/asm/win64/cn_main_loop.asm"
+                "src/crypto/cn/asm/win64/CryptonightR_template.asm"
             )
         endif()
 
@@ -22,13 +22,13 @@ if (WITH_ASM AND NOT XMRIG_ARM AND CMAKE_SIZEOF_VOID_P EQUAL 8)
 
         if (WIN32 AND CMAKE_C_COMPILER_ID MATCHES GNU)
             set(XMRIG_ASM_FILES
-                "src/crypto/asm/win64/cn_main_loop.S"
-                "src/crypto/asm/CryptonightR_template.S"
+                "src/crypto/cn/asm/win64/cn_main_loop.S"
+                "src/crypto/cn/asm/CryptonightR_template.S"
             )
         else()
             set(XMRIG_ASM_FILES
-                "src/crypto/asm/cn_main_loop.S"
-                "src/crypto/asm/CryptonightR_template.S"
+                "src/crypto/cn/asm/cn_main_loop.S"
+                "src/crypto/cn/asm/CryptonightR_template.S"
             )
         endif()
 
@@ -36,10 +36,17 @@ if (WITH_ASM AND NOT XMRIG_ARM AND CMAKE_SIZEOF_VOID_P EQUAL 8)
     endif()
 
     add_library(${XMRIG_ASM_LIBRARY} STATIC ${XMRIG_ASM_FILES})
-    set(XMRIG_ASM_SOURCES src/crypto/Asm.h src/crypto/Asm.cpp src/crypto/CryptonightR_gen.cpp)
+    set(XMRIG_ASM_SOURCES
+        src/crypto/common/Assembly.h
+        src/crypto/common/Assembly.cpp
+        src/crypto/cn/r/CryptonightR_gen.cpp
+        )
     set_property(TARGET ${XMRIG_ASM_LIBRARY} PROPERTY LINKER_LANGUAGE C)
+
+    add_definitions(/DXMRIG_FEATURE_ASM)
 else()
     set(XMRIG_ASM_SOURCES "")
     set(XMRIG_ASM_LIBRARY "")
-    add_definitions(/DXMRIG_NO_ASM)
+
+    remove_definitions(/DXMRIG_FEATURE_ASM)
 endif()

cmake/astrobwt.cmake

@@ -0,0 +1,45 @@
+if (WITH_ASTROBWT)
+    add_definitions(/DXMRIG_ALGO_ASTROBWT)
+
+    list(APPEND HEADERS_CRYPTO
+        src/crypto/astrobwt/AstroBWT.h
+    )
+
+    list(APPEND SOURCES_CRYPTO
+        src/crypto/astrobwt/AstroBWT.cpp
+    )
+
+    if (XMRIG_ARM)
+        list(APPEND HEADERS_CRYPTO
+            src/crypto/astrobwt/salsa20_ref/ecrypt-config.h
+            src/crypto/astrobwt/salsa20_ref/ecrypt-machine.h
+            src/crypto/astrobwt/salsa20_ref/ecrypt-portable.h
+            src/crypto/astrobwt/salsa20_ref/ecrypt-sync.h
+        )
+
+        list(APPEND SOURCES_CRYPTO
+            src/crypto/astrobwt/salsa20_ref/salsa20.c
+        )
+    else()
+        if (CMAKE_SIZEOF_VOID_P EQUAL 8)
+            add_definitions(/DASTROBWT_AVX2)
+            if (CMAKE_C_COMPILER_ID MATCHES MSVC)
+                enable_language(ASM_MASM)
+                list(APPEND SOURCES_CRYPTO src/crypto/astrobwt/sha3_256_avx2.asm)
+            else()
+                enable_language(ASM)
+                list(APPEND SOURCES_CRYPTO src/crypto/astrobwt/sha3_256_avx2.S)
+            endif()
+        endif()
+
+        list(APPEND HEADERS_CRYPTO
+            src/crypto/astrobwt/Salsa20.hpp
+        )
+
+        list(APPEND SOURCES_CRYPTO
+            src/crypto/astrobwt/Salsa20.cpp
+        )
+    endif()
+else()
+    remove_definitions(/DXMRIG_ALGO_ASTROBWT)
+endif()

cmake/cn-gpu.cmake

@@ -1,23 +0,0 @@
-if (WITH_CN_GPU AND CMAKE_SIZEOF_VOID_P EQUAL 8)
-
-    if (XMRIG_ARM)
-        set(CN_GPU_SOURCES src/crypto/cn_gpu_arm.cpp)
-
-        if (CMAKE_CXX_COMPILER_ID MATCHES GNU OR CMAKE_CXX_COMPILER_ID MATCHES Clang)
-            set_source_files_properties(src/crypto/cn_gpu_arm.cpp PROPERTIES COMPILE_FLAGS "-O3")
-        endif()
-    else()
-        set(CN_GPU_SOURCES src/crypto/cn_gpu_avx.cpp src/crypto/cn_gpu_ssse3.cpp)
-
-        if (CMAKE_CXX_COMPILER_ID MATCHES GNU OR CMAKE_CXX_COMPILER_ID MATCHES Clang)
-            set_source_files_properties(src/crypto/cn_gpu_avx.cpp PROPERTIES COMPILE_FLAGS "-O3 -mavx2")
-            set_source_files_properties(src/crypto/cn_gpu_ssse3.cpp PROPERTIES COMPILE_FLAGS "-O3")
-        elseif (CMAKE_CXX_COMPILER_ID MATCHES MSVC)
-            set_source_files_properties(src/crypto/cn_gpu_avx.cpp PROPERTIES COMPILE_FLAGS "/arch:AVX")
-        endif()
-    endif()
-else()
-    set(CN_GPU_SOURCES "")
-
-    add_definitions(/DXMRIG_NO_CN_GPU)
-endif()

cmake/flags.cmake

@@ -2,6 +2,9 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_STANDARD 11)
 
+set(CMAKE_C_STANDARD 99)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+
 if ("${CMAKE_BUILD_TYPE}" STREQUAL "")
     set(CMAKE_BUILD_TYPE Release)
 endif()
@@ -13,11 +16,10 @@ endif()
 include(CheckSymbolExists)
 
 if (CMAKE_CXX_COMPILER_ID MATCHES GNU)
-
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wno-strict-aliasing")
     set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -Ofast")
 
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -fno-exceptions -fno-rtti -Wno-class-memaccess")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -fexceptions -fno-rtti -Wno-strict-aliasing -Wno-class-memaccess")
     set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -Ofast -s")
 
     if (XMRIG_ARMv8)
@@ -34,7 +36,11 @@ if (CMAKE_CXX_COMPILER_ID MATCHES GNU)
     endif()
 
     if (WIN32)
-        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
+        if (CMAKE_SIZEOF_VOID_P EQUAL 8)
+            set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
+        else()
+            set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static -Wl,--large-address-aware")
+        endif()
     else()
         set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc -static-libstdc++")
     endif()
@@ -42,15 +48,18 @@ if (CMAKE_CXX_COMPILER_ID MATCHES GNU)
     add_definitions(/D_GNU_SOURCE)
 
     if (${CMAKE_VERSION} VERSION_LESS "3.1.0")
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
     endif()
 
     #set(CMAKE_C_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -gdwarf-2")
 
-elseif (CMAKE_CXX_COMPILER_ID MATCHES MSVC)
+    add_definitions(/DHAVE_BUILTIN_CLEAR_CACHE)
+
+elseif (CMAKE_CXX_COMPILER_ID MATCHES MSVC)
+    set(CMAKE_C_FLAGS_RELEASE "/MT /O2 /Oi /DNDEBUG /GL")
+    set(CMAKE_CXX_FLAGS_RELEASE "/MT /O2 /Oi /DNDEBUG /GL")
 
-    set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Ox /Ot /Oi /MT /GL")
-    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Ox /Ot /Oi /MT /GL")
     add_definitions(/D_CRT_SECURE_NO_WARNINGS)
     add_definitions(/D_CRT_NONSTDC_NO_WARNINGS)
     add_definitions(/DNOMINMAX)
@@ -61,7 +70,7 @@ elseif (CMAKE_CXX_COMPILER_ID MATCHES Clang)
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall")
     set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -Ofast -funroll-loops -fmerge-all-constants")
 
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -fno-exceptions -fno-rtti -Wno-missing-braces")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -fexceptions -fno-rtti -Wno-missing-braces")
     set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -Ofast -funroll-loops -fmerge-all-constants")
 
     if (XMRIG_ARMv8)
@@ -81,3 +90,10 @@ elseif (CMAKE_CXX_COMPILER_ID MATCHES Clang)
     endif()
 
 endif()
+
+if (NOT WIN32)
+    check_symbol_exists("__builtin___clear_cache" "stdlib.h" HAVE_BUILTIN_CLEAR_CACHE)
+    if (HAVE_BUILTIN_CLEAR_CACHE)
+        add_definitions(/DHAVE_BUILTIN_CLEAR_CACHE)
+    endif()
+endif()

cmake/kawpow.cmake

@@ -0,0 +1,19 @@
+if (WITH_KAWPOW)
+    add_definitions(/DXMRIG_ALGO_KAWPOW)
+
+    list(APPEND HEADERS_CRYPTO
+        src/crypto/kawpow/KPCache.h
+        src/crypto/kawpow/KPHash.h
+    )
+
+    list(APPEND SOURCES_CRYPTO
+        src/crypto/kawpow/KPCache.cpp
+        src/crypto/kawpow/KPHash.cpp
+    )
+
+    add_subdirectory(src/3rdparty/libethash)
+    set(ETHASH_LIBRARY ethash)
+else()
+    remove_definitions(/DXMRIG_ALGO_KAWPOW)
+    set(ETHASH_LIBRARY "")
+endif()

cmake/os.cmake

@@ -0,0 +1,45 @@
+if (WIN32)
+    set(XMRIG_OS_WIN ON)
+elseif (APPLE)
+    set(XMRIG_OS_APPLE ON)
+
+    if (IOS OR CMAKE_SYSTEM_NAME STREQUAL iOS)
+        set(XMRIG_OS_IOS ON)
+    else()
+        set(XMRIG_OS_MACOS ON)
+    endif()
+else()
+    set(XMRIG_OS_UNIX ON)
+
+    if (ANDROID OR CMAKE_SYSTEM_NAME MATCHES "Android")
+        set(XMRIG_OS_ANDROID ON)
+    elseif(CMAKE_SYSTEM_NAME MATCHES "Linux")
+        set(XMRIG_OS_LINUX ON)
+    elseif(CMAKE_SYSTEM_NAME STREQUAL FreeBSD)
+        set(XMRIG_OS_FREEBSD ON)
+    endif()
+endif()
+
+
+if (XMRIG_OS_WIN)
+    add_definitions(/DWIN32)
+    add_definitions(/DXMRIG_OS_WIN)
+elseif(XMRIG_OS_APPLE)
+    add_definitions(/DXMRIG_OS_APPLE)
+
+    if (XMRIG_OS_IOS)
+        add_definitions(/DXMRIG_OS_IOS)
+    else()
+        add_definitions(/DXMRIG_OS_MACOS)
+    endif()
+elseif(XMRIG_OS_UNIX)
+    add_definitions(/DXMRIG_OS_UNIX)
+
+    if (XMRIG_OS_ANDROID)
+        add_definitions(/DXMRIG_OS_ANDROID)
+    elseif (XMRIG_OS_LINUX)
+        add_definitions(/DXMRIG_OS_LINUX)
+    elseif (XMRIG_OS_FREEBSD)
+        add_definitions(/DXMRIG_OS_FREEBSD)
+    endif()
+endif()

cmake/randomx.cmake

@@ -0,0 +1,101 @@
+if (WITH_RANDOMX)
+    add_definitions(/DXMRIG_ALGO_RANDOMX)
+    set(WITH_ARGON2 ON)
+
+    list(APPEND HEADERS_CRYPTO
+        src/crypto/rx/Rx.h
+        src/crypto/rx/RxAlgo.h
+        src/crypto/rx/RxBasicStorage.h
+        src/crypto/rx/RxCache.h
+        src/crypto/rx/RxConfig.h
+        src/crypto/rx/RxDataset.h
+        src/crypto/rx/RxQueue.h
+        src/crypto/rx/RxSeed.h
+        src/crypto/rx/RxVm.h
+    )
+
+    list(APPEND SOURCES_CRYPTO
+        src/crypto/randomx/aes_hash.cpp
+        src/crypto/randomx/allocator.cpp
+        src/crypto/randomx/blake2_generator.cpp
+        src/crypto/randomx/blake2/blake2b.c
+        src/crypto/randomx/bytecode_machine.cpp
+        src/crypto/randomx/dataset.cpp
+        src/crypto/randomx/instructions_portable.cpp
+        src/crypto/randomx/randomx.cpp
+        src/crypto/randomx/reciprocal.c
+        src/crypto/randomx/soft_aes.cpp
+        src/crypto/randomx/superscalar.cpp
+        src/crypto/randomx/virtual_machine.cpp
+        src/crypto/randomx/virtual_memory.cpp
+        src/crypto/randomx/vm_compiled_light.cpp
+        src/crypto/randomx/vm_compiled.cpp
+        src/crypto/randomx/vm_interpreted_light.cpp
+        src/crypto/randomx/vm_interpreted.cpp
+        src/crypto/rx/Rx.cpp
+        src/crypto/rx/RxAlgo.cpp
+        src/crypto/rx/RxBasicStorage.cpp
+        src/crypto/rx/RxCache.cpp
+        src/crypto/rx/RxConfig.cpp
+        src/crypto/rx/RxDataset.cpp
+        src/crypto/rx/RxQueue.cpp
+        src/crypto/rx/RxVm.cpp
+    )
+
+    if (CMAKE_C_COMPILER_ID MATCHES MSVC)
+        enable_language(ASM_MASM)
+        list(APPEND SOURCES_CRYPTO
+             src/crypto/randomx/jit_compiler_x86_static.asm
+             src/crypto/randomx/jit_compiler_x86.cpp
+            )
+    elseif (NOT XMRIG_ARM AND CMAKE_SIZEOF_VOID_P EQUAL 8)
+        list(APPEND SOURCES_CRYPTO
+             src/crypto/randomx/jit_compiler_x86_static.S
+             src/crypto/randomx/jit_compiler_x86.cpp
+            )
+        # cheat because cmake and ccache hate each other
+        set_property(SOURCE src/crypto/randomx/jit_compiler_x86_static.S PROPERTY LANGUAGE C)
+    elseif (XMRIG_ARM AND CMAKE_SIZEOF_VOID_P EQUAL 8)
+        list(APPEND SOURCES_CRYPTO
+             src/crypto/randomx/jit_compiler_a64_static.S
+             src/crypto/randomx/jit_compiler_a64.cpp
+            )
+        # cheat because cmake and ccache hate each other
+        set_property(SOURCE src/crypto/randomx/jit_compiler_a64_static.S PROPERTY LANGUAGE C)
+    endif()
+
+    if (CMAKE_CXX_COMPILER_ID MATCHES Clang)
+        set_source_files_properties(src/crypto/randomx/jit_compiler_x86.cpp PROPERTIES COMPILE_FLAGS -Wno-unused-const-variable)
+    endif()
+
+    if (WITH_HWLOC)
+        list(APPEND HEADERS_CRYPTO
+             src/crypto/rx/RxNUMAStorage.h
+            )
+
+        list(APPEND SOURCES_CRYPTO
+             src/crypto/rx/RxNUMAStorage.cpp
+            )
+    endif()
+
+    if (WITH_MSR AND NOT XMRIG_ARM AND CMAKE_SIZEOF_VOID_P EQUAL 8 AND (XMRIG_OS_WIN OR XMRIG_OS_LINUX))
+        add_definitions(/DXMRIG_FEATURE_MSR)
+        add_definitions(/DXMRIG_FIX_RYZEN)
+        message("-- WITH_MSR=ON")
+
+        if (XMRIG_OS_WIN)
+            list(APPEND SOURCES_CRYPTO src/crypto/rx/Rx_win.cpp)
+        elseif (XMRIG_OS_LINUX)
+            list(APPEND SOURCES_CRYPTO src/crypto/rx/Rx_linux.cpp)
+        endif()
+
+        list(APPEND HEADERS_CRYPTO src/crypto/rx/msr/MsrItem.h)
+        list(APPEND SOURCES_CRYPTO src/crypto/rx/msr/MsrItem.cpp)
+    else()
+        remove_definitions(/DXMRIG_FEATURE_MSR)
+        remove_definitions(/DXMRIG_FIX_RYZEN)
+        message("-- WITH_MSR=OFF")
+    endif()
+else()
+    remove_definitions(/DXMRIG_ALGO_RANDOMX)
+endif()

doc/ALGORITHMS.md

@@ -1,31 +1,60 @@
 # Algorithms
 
-XMRig uses a different way to specify algorithms, compared to other miners.
+Algorithm can be defined in 3 ways:
 
-Algorithm selection splitted to 2 parts:
+1. By pool, using algorithm negotiation, in this case no need specify algorithm on miner side.
+2. Per pool `coin` option, currently only usable values for this option is `monero` and `arqma`.
+3. Per pool `algo` option.
 
- * Global base algorithm per miner or proxy instance, `algo` option. Possible values: `cryptonight`, `cryptonight-lite`, `cryptonight-heavy`.
- * Algorithm variant specified separately for each pool, `variant` option.
- * [Full table for supported algorithm and variants.](https://github.com/xmrig/xmrig-proxy/blob/master/doc/STRATUM_EXT.md#14-algorithm-names-and-variants)
+Option `coin` useful for pools without [algorithm negotiation](https://xmrig.com/docs/extensions/algorithm-negotiation) support or daemon to allow automatically switch algorithm in next hard fork. If you use xmrig-proxy don't need specify algorithm on miner side.
+
+## Algorithm names
+
+| Name | Memory | Version | Description | Notes |
+|------|--------|---------|-------------|-------|
+| `kawpow` | - | 6.0.0+ | KawPow (Ravencoin) | GPU only |
+| `rx/keva` | 1 MB | 5.9.0+ | RandomKEVA (RandomX variant for Keva). |  |
+| `astrobwt` | 20 MB | 5.8.0+ | AstroBWT (Dero). |  |
+| `cn-pico/tlo` | 256 KB | 5.5.0+ | CryptoNight-Pico (Talleo). |  |
+| `rx/sfx` | 2 MB | 5.4.0+ | RandomSFX (RandomX variant for Safex). |  |
+| `rx/arq` | 256 KB | 4.3.0+ | RandomARQ (RandomX variant for ArQmA). |  |
+| `rx/0` | 2 MB | 3.2.0+ | RandomX (Monero). |  |
+| `argon2/chukwa` | 512 KB | 3.1.0+ | Argon2id (Chukwa). | CPU only |
+| `argon2/wrkz` | 256 KB | 3.1.0+ | Argon2id (WRKZ) | CPU only |
+| `rx/wow` | 1 MB | 3.0.0+ | RandomWOW (RandomX variant for Wownero). |  |
+| `rx/loki` | 2 MB | 3.0.0+ | RandomXL (RandomX variant for Loki). |  |
+| `cn/fast` | 2 MB | 3.0.0+ | CryptoNight variant 1 with half iterations. |  |
+| `cn/rwz` | 2 MB | 2.14.0+ | CryptoNight variant 2 with 3/4 iterations and reversed shuffle operation. |  |
+| `cn/zls` | 2 MB | 2.14.0+ | CryptoNight variant 2 with 3/4 iterations. |  |
+| `cn/double` | 2 MB | 2.14.0+ | CryptoNight variant 2 with double iterations. |  |
+| `cn/r` | 2 MB | 2.13.0+ | CryptoNightR (Monero's variant 4). |  |
+| `cn-pico` | 256 KB | 2.10.0+ | CryptoNight-Pico. |  |
+| `cn/half` | 2 MB | 2.9.0+ | CryptoNight variant 2 with half iterations. |  |
+| `cn/2` | 2 MB | 2.8.0+ | CryptoNight variant 2. |  |
+| `cn/xao` | 2 MB | 2.6.4+ | CryptoNight variant 0 (modified). |  |
+| `cn/rto` | 2 MB | 2.6.4+ | CryptoNight variant 1 (modified). |  |
+| `cn-heavy/tube` | 4 MB | 2.6.4+ | CryptoNight-Heavy (modified). |  |
+| `cn-heavy/xhv` | 4 MB | 2.6.3+ | CryptoNight-Heavy (modified). |  |
+| `cn-heavy/0` | 4 MB | 2.6.0+ | CryptoNight-Heavy. |  |
+| `cn/1` | 2 MB | 2.5.0+ | CryptoNight variant 1. |  |
+| `cn-lite/1` | 1 MB | 2.5.0+ | CryptoNight-Lite variant 1. |  |
+| `cn-lite/0` | 1 MB | 0.8.0+ | CryptoNight-Lite variant 0. |  |
+| `cn/0` | 2 MB | 0.5.0+ | CryptoNight (original). |  |
+
+## Migration to v3
+Since version 3 mining [algorithm](#algorithm-names) should specified for each pool separately (`algo` option), earlier versions was use one global `algo` option and per pool `variant` option (this option was removed in v3). If your pool support [mining algorithm negotiation](https://github.com/xmrig/xmrig-proxy/issues/168) you may not specify this option at all.
  
 #### Example
 ```json
 {
-  "algo": "cryptonight",
-  ...
   "pools": [
     {
       "url": "...",
-      "variant": 1,
+      "algo": "cn/r",
+      "coin": null
       ...
     }
  ],
  ...
 }
 ```
-
-## Mining algorithm negotiation
-If your pool support [mining algorithm negotiation](https://github.com/xmrig/xmrig-proxy/issues/168) miner will choice proper variant automaticaly and if you choice wrong base algorithm you will see error message.
-
-Pools with mining algorithm negotiation support.
- * [www.hashvault.pro](https://www.hashvault.pro/)

doc/API.md

@@ -1,26 +1,39 @@
 # HTTP API
 
-If you want use API you need choice a port where is internal HTTP server will listen for incoming connections. API will not available if miner built without `libmicrohttpd`.
+If you want use HTTP API you need enable it (`"enabled": true,`) then choice `port` and optionaly `host`. API not available if miner built without HTTP support (`-DWITH_HTTP=OFF`).
+
+Offical HTTP client for API: http://workers.xmrig.info/
 
 Example configuration:
 
 ```json
 "api": {
-    "port": 44444,
-    "access-token": "TOKEN",
-    "worker-id": null,
-    "ipv6": false,
-    "restricted": false
+	"id": null,
+	"worker-id": null,
 },
+"http": {
+	"enabled": false,
+	"host": "127.0.0.1",
+	"port": 0,
+	"access-token": null,
+	"restricted": true
+}
 ```
 
-* **port** Port for incoming connections `http://<miner ip>:<port>`.
-* **access-token** [Bearer](https://gist.github.com/xmrig/c75fdd1f8e0f3bac05500be2ab718f8e#file-api-html-L54) access token to secure access to API.
+#### Global API options
+* **id** Miner ID, if not set created automatically.
 * **worker-id** Optional worker name, if not set will be detected automatically.
-* **ipv6** Enable (`true`) or disable (`false`) IPv6 for API.
+
+#### HTTP API options,
+* **enabled** Enable (`true`) or disable (`false`) HTTP API.
+* **host** Host for incoming connections `http://<host>:<port>`, to allow connections from all interfaces use `0.0.0.0` (IPv4) or `::` (IPv4+IPv6).
+* **port** Port for incoming connections `http://<host>:<port>`, zero port is valid option and means random port.
+* **access-token** [Bearer](https://gist.github.com/xmrig/c75fdd1f8e0f3bac05500be2ab718f8e#file-api-html-L54) access token to secure access to API. Miner support this token only via `Authorization` header.
 * **restricted** Use `false` to allow remote configuration.
 
-If you prefer use command line options instead of config file, you can use options: `--api-port`, `--api-access-token`, `--api-worker-id`, `--api-ipv6` and `api-no-restricted`.
+If you prefer use command line options instead of config file, you can use options: `--api-id`, `--api-worker-id`, `--http-enabled`, `--http-host`, `--http-access-token`, `--http-port`, `--http-no-restricted`.
+
+Versions before 2.15 was use another options for API https://github.com/xmrig/xmrig/issues/1007
 
 ## Endpoints
 
@@ -50,4 +63,4 @@ Curl example:
 
 ```
 curl -v --data-binary @config.json -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer SECRET" http://127.0.0.1:44444/1/config
-```
+```

doc/CPU.md

@@ -0,0 +1,105 @@
+# CPU backend
+
+All CPU related settings contains in one `cpu` object in config file, CPU backend allow specify multiple profiles and allow switch between them without restrictions by pool request or config change. Default auto-configuration create reasonable minimum of profiles which cover all supported algorithms.
+
+### Example
+
+Example below demonstrate all primary ideas of flexible profiles configuration:
+
+* `"rx/wow"` Exact match to algorithm `rx/wow`, defined 4 threads without CPU affinity.
+* `"cn"` Default failback profile for all `cn/*` algorithms, defined 2 threads with CPU affinity, another failback profiles is `cn-lite`, `cn-heavy` and `rx`.
+* `"cn-lite"` Default failback profile for all `cn-lite/*` algorithms, defined 2 double threads with CPU affinity.
+* `"cn-pico"` Alternative short object format.
+* `"custom-profile"` Custom user defined profile.
+* `"*"` Failback profile for all unhandled by other profiles algorithms.
+* `"cn/r"` Exact match, alias to profile `custom-profile`.
+* `"cn/0"` Exact match, disabled algorithm.
+
+```json
+{
+    "cpu": {
+        "enabled": true,
+        "huge-pages": true,
+        "hw-aes": null,
+        "priority": null,
+        "asm": true,
+        "rx/wow": [-1, -1, -1, -1],
+        "cn": [
+            [1, 0],
+            [1, 2]
+        ],
+        "cn-lite": [
+            [2, 0],
+            [2, 2]
+        ],
+        "cn-pico": {
+            "intensity": 2,
+            "threads": 8,
+            "affinity": -1
+        },
+        "custom-profile": [0, 2],
+        "*": [-1],
+        "cn/r": "custom-profile",
+        "cn/0": false
+    }
+}
+```
+
+## Threads definition
+Threads can be defined in 3 formats.
+
+#### Array format
+```json
+[
+    [1, 0],
+    [1, 2],
+    [1, -1],
+    [2, -1]
+]
+```
+Each line represent one thread, first element is intensity, this option was known as `low_power_mode`, possible values is range from 1 to 5, second element is CPU affinity, special value `-1` means no affinity.
+
+#### Short array format
+```json
+[-1, -1, -1, -1]
+```
+Each number represent one thread and means CPU affinity, this is default format for algorithm with maximum intensity 1, currently it all RandomX variants and cryptonight-gpu.
+
+#### Short object format
+```json
+{
+    "intensity": 2,
+    "threads": 8,
+    "affinity": -1
+}
+```
+Internal format, but can be user defined.
+
+## Shared options
+
+#### `enabled`
+Enable (`true`) or disable (`false`) CPU backend, by default `true`.
+
+#### `huge-pages`
+Enable (`true`) or disable (`false`) huge pages support, by default `true`.
+
+#### `hw-aes`
+Force enable (`true`) or disable (`false`) hardware AES support. Default value `null` means miner autodetect this feature. Usually don't need change this option, this option useful for some rare cases when miner can't detect hardware AES, but it available. If you force enable this option, but your hardware not support it, miner will crash.
+
+#### `priority`
+Mining threads priority, value from `1` (lowest priority) to `5` (highest possible priority). Default value `null` means miner don't change threads priority at all.
+
+#### `asm`
+Enable/configure or disable ASM optimizations. Possible values: `true`, `false`, `"intel"`, `"ryzen"`, `"bulldozer"`.
+
+#### `argon2-impl` (since v3.1.0)
+Allow override automatically detected Argon2 implementation, this option added mostly for debug purposes, default value `null` means autodetect. Other possible values: `"x86_64"`, `"SSE2"`, `"SSSE3"`, `"XOP"`, `"AVX2"`, `"AVX-512F"`. Manual selection has no safe guards, if you CPU not support required instuctions, miner will crash.
+
+#### `max-threads-hint` (since v4.2.0)
+Maximum CPU threads count (in percentage) hint for autoconfig. [CPU_MAX_USAGE.md](CPU_MAX_USAGE.md)
+
+#### `memory-pool` (since v4.3.0)
+Use continuous, persistent memory block for mining threads, useful for preserve huge pages allocation while algorithm swithing. Possible values `false` (feature disabled, by default) or `true` or specific count of 2 MB huge pages.
+
+#### `yield` (since v5.1.1)
+Prefer system better system response/stability `true` (default value) or maximum hashrate `false`.

doc/CPU_MAX_USAGE.md

@@ -0,0 +1,26 @@
+# Maximum CPU usage
+
+Please read this document carefully, `max-threads-hint` (was known as `max-cpu-usage`) option is most confusing option in the miner with many myth and legends.
+This option is just hint for automatic configuration and can't precise define CPU usage.
+
+### Option definition
+#### Config file:
+```json
+{
+    ...
+    "cpu": {
+        "max-threads-hint": 100,
+        ...
+    },
+    ...
+}
+```
+
+#### Command line
+`--cpu-max-threads-hint 100`
+
+### Known issues and usage
+
+* This option has no effect if miner already generated CPU configuration, to prevent config generation use `"autosave":false,`.
+* Only threads count can be changed, for 1 core CPU this option has no effect, for 2 core CPU only 2 values possible 50% and 100%, for 4 cores: 25%, 50%, 75%, 100%. etc. 
+* You CPU may limited by other factors, eg cache.

doc/PERSISTENT_OPTIONS.md

@@ -0,0 +1,9 @@
+# Persistent options
+
+Options in list below can't changed in runtime by watching config file or via API.
+
+* `background`
+* `donate-level`
+* `cpu/argon2-impl`
+* `opencl/loader`
+* `opencl/platform`

doc/build/CMAKE_OPTIONS.md

@@ -0,0 +1,40 @@
+# CMake options
+**Recent version of this document: https://xmrig.com/docs/miner/cmake-options**
+
+## Algorithms
+
+* **`-DWITH_CN_LITE=OFF`** disable all CryptoNight-Lite algorithms (`cn-lite/0`, `cn-lite/1`).
+* **`-DWITH_CN_HEAVY=OFF`** disable all CryptoNight-Heavy algorithms (`cn-heavy/0`, `cn-heavy/xhv`, `cn-heavy/tube`).
+* **`-DWITH_CN_PICO=OFF`** disable CryptoNight-Pico algorithm (`cn-pico`).
+* **`-DWITH_RANDOMX=OFF`** disable RandomX algorithms (`rx/loki`, `rx/wow`).
+* **`-DWITH_ARGON2=OFF`** disable Argon2 algorithms (`argon2/chukwa`, `argon2/wrkz`).
+
+## Features
+
+* **`-DWITH_HWLOC=OFF`**
+disable [hwloc](https://github.com/xmrig/xmrig/issues/1077) support.
+Disabling this feature is not recommended in most cases.
+This feature add external dependency to libhwloc (1.10.0+) (except MSVC builds).
+* **`-DWITH_LIBCPUID=OFF`** disable built in libcpuid support, this feature always disabled if hwloc enabled, if both hwloc and libcpuid disabled auto configuration for CPU will very limited.
+* **`-DWITH_HTTP=OFF`** disable built in HTTP support, this feature used for HTTP API and daemon (solo mining) support.
+* **`-DWITH_TLS=OFF`** disable SSL/TLS support (secure connections to pool). This feature add external dependency to OpenSSL.
+* **`-DWITH_ASM=OFF`** disable assembly optimizations for modern CryptoNight algorithms.
+* **`-DWITH_EMBEDDED_CONFIG=ON`** Enable [embedded](https://github.com/xmrig/xmrig/issues/957) config support.
+* **`-DWITH_OPENCL=OFF`** Disable OpenCL backend.
+* **`-DWITH_CUDA=OFF`** Disable CUDA backend.
+
+## Debug options
+
+* **`-DWITH_DEBUG_LOG=ON`** enable debug log (mostly network requests).
+* **`-DHWLOC_DEBUG=ON`** enable some debug log for hwloc.
+* **`-DCMAKE_BUILD_TYPE=Debug`** enable debug build, only useful for investigate crashes, this option slow down miner.
+
+## Special build options
+
+* **`-DXMRIG_DEPS=<path>`** path to precompiled dependencies https://github.com/xmrig/xmrig-deps
+* **`-DARM_TARGET=<number>`** override ARM target, possible values `7` (ARMv7) and `8` (ARMv8).
+* **`-DUV_INCLUDE_DIR=<path>`** custom path to libuv headers.
+* **`-DUV_LIBRARY=<path>`** custom path to libuv library.
+* **`-DHWLOC_INCLUDE_DIR=<path>`** custom path to hwloc headers.
+* **`-DHWLOC_LIBRARY=<path>`** custom path to hwloc library.
+* **`-DOPENSSL_ROOT_DIR=<path>`** custom path to OpenSSL.

doc/gpg_keys/xmrig.asc

@@ -0,0 +1,30 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQENBF3VSRIBCADfFjDUbq0WLGulFeSou0A+jTvweNllPyLNOn3SNCC0XLEYyEcu
+JiEBK80DlvR06TVr8Aw1rT5S2iH0i5Tl8DqShH2mmcN1rBp1M0Y95D89KVj3BIhE
+nxmgmD4N3Wgm+5FmEH4W/RpG1xdYWJx3eJhtWPdFJqpg083E2D5P30wIQem+EnTR
+5YrtTZPh5cPj2KRY+UmsDE3ahmxCgP7LYgnnpZQlWBBiMV932s7MvYBPJQc1wecS
+0wi1zxyS81xHc3839EkA7wueCeNo+5jha+KH66tMKsfrI2WvfPHTCPjK9v7WJc/O
+/eRp9d+wacn09D1L6CoRO0ers5p10GO84VhTABEBAAG0GVhNUmlnIDxzdXBwb3J0
+QHhtcmlnLmNvbT6JAU4EEwEIADgWIQSaxM6o5m41pcfN3BtEalNji+lECQUCXdVJ
+EgIbAwULCQgHAgYVCgkICwIEFgIDAQIeAQIXgAAKCRBEalNji+lECbkQB/9nRou0
+tOlBwYn8xVgBu7IiDWNVETRWfrjrtdTvSahgbbo6lWgjA/vBLkjN9fISdBQ/n/Mt
+hNDJbEtxHHt2baJhvT8du1eWcIHHXCV/rmv+iY/hTXa1gKqHiHDJrtYSVBG3BMme
+1rdsUHTiKf3t5yRHOXAfY2C+XNblKAV7mhlxQBiKxdFDIkFEQKNrHNUvnzkOqoCT
+2kTZZ2tPUMQdOn1eek6zG/+C7SwcBpJnakJ8jce4yA/xZbOVKetNWO3Ufu3TE34k
+OdA+H4PU9+fV77XfOY8DtXeS3boUI97ei+4s/mwX/NFC0i8CPXyefxl3WRUBGDOI
+w//kPNQVh4HobOCeuQENBF3VSRIBCADl29WorEi+vRA/3kg9VUXtxSU6caibFS3N
+VXANiFRjrOmICdfrIgOSGNrYCQFsXu0Xe0udDYVX8yX6WJk+CT02Pdg0gkXiKoze
+KrnK15mo3xXbb2tr1o9ROPgwY/o2AwQHj0o1JhdS2cybfuRiUQRoGgBX7a9X0cTY
+r4ZJvOjzgAajl3ciwB3yWUmDiRlzZpO7YWESXbOhGVzyCnP5MlMEJ/fPRw9h38vK
+HNKLhzcRfsLpXk34ghY3SxIv4NWUfuZXFWqpSdC9JgNc5zA72lJEQcF4DHJCKl7B
+ddmrfsr9mdiIpo+/ZZFPPngdeZ2kvkJ2YKaZNVu2XooJARPQ8B8tABEBAAGJATYE
+GAEIACAWIQSaxM6o5m41pcfN3BtEalNji+lECQUCXdVJEgIbDAAKCRBEalNji+lE
+CdPUB/4nH1IdhHGmfko2kxdaHqQgCGLqh3pcrQXD9mBv/LYVnoHZpVRHsIDgg2Z4
+lQYrIRRqe69FjVxo7sA2eMIlV0GRDlUrw+HeURFpEhKPEdwFy6i/cti2MY0YxOrB
+TvQoRutUoMnyjM4TBJWaaqccbTsavMdLmG3JHdAkiHtUis/fUwVctmEQwN+d/J2b
+wJAtliqw3nXchUfdIfwHF/7hg8seUuYUaifzkazBZhVWvRkTVLVanzZ51HRfuzwD
+ntaa7kfYGdE+4TKOylAPh+8E6WnR19RRTpsaW0dVBgOiBTE0uc7rUv2HWS/u6RUR
+t7ldSBzkuDTlM2V59Iq2hXoSC6dT
+=cIG9
+-----END PGP PUBLIC KEY BLOCK-----

doc/releases/5_0_1/SHA256SUMS

@@ -0,0 +1,5 @@
+6bb1a2e3a0fbca5195be6022f2a9fbff8a353c37c7542e7ab89420cb45b64505  xmrig-5.0.1-gcc-win32.zip
+24dba9ec281acfb2ea2c401ebd0e4e2d1f1ee5fd557da5ff3c7049020c1f78b6  xmrig-5.0.1-gcc-win64.zip
+86d65c6693ec9e35cd7547329580638b85c9eb0cf8383892a1c15199de5b556f  xmrig-5.0.1-msvc-cuda10_1-win64.zip
+0fbfe518b1c4b6993b0f66ff01302626375b15620ccf8f64d6fb97845068ffca  xmrig-5.0.1-msvc-win64.zip
+aa34890738a3494de2fa0e44db346937fea7339852f5f10b5d4655f95e2d8f1f  xmrig-5.0.1-xenial-x64.tar.gz

doc/releases/5_0_1/SHA256SUMS.sig

@@ -0,0 +1,11 @@
+-----BEGIN PGP SIGNATURE-----
+
+iQEzBAABCgAdFiEEmsTOqOZuNaXHzdwbRGpTY4vpRAkFAl3VcsoACgkQRGpTY4vp
+RAm9vQgA1MyTUU2jley2TCYLUzQy2Fffc8fbXYv64r44jbWOjC/6qo2iIlRgPhIc
+oVyPKr5TYS3QjDzCEm8IvozS0YudS6soESbPzqDonboK8pd0K4bsML9TQY2feV7A
+NL5vln0rfVHp1wxLLrQpfBqAgvJUXEyaHece6gFQN79JOGhEo2bHL2NyrOl+FViS
+b2BaMtXq410Fh+XT6ShnOaG/2EuO8ZqSGdCO6A/2LHQw1UY+mZiCvue6P6B06HmB
+WD/urOv38V389v+V+Sp4UlEW6VpBOOjvtChoVWtLt+tKzydrnt2EmoWWWg475pka
+4G6whHuMWS8CTt5/PDhJpvVXNQTIOw==
+=C764
+-----END PGP SIGNATURE-----