v6.21.1

Previously with HTTP API enabled on brenchmarking run, it is possible
to cause a segfault due to an issue handling the m_httpd pointer and
rebinding.

  - Initialize m_httpd to nullptr to indicate when it's not in use.
  - Safely delete m_httpd in Api's destructor to prevent use-after-free
    issues.
  - Add checks to ensure m_httpd is not nullptr before usage in start,
    stop, and tick methods.
  - Log errors for HTTP server start failures to aid in debugging.

Fixes MoneroOcean/xmrig#120

Signed-off-by: Dave Walker (Daviey) <email@daviey.com>

CHANGELOG.md

@@ -1,3 +1,8 @@
+# v6.21.1
+- [#3391](https://github.com/xmrig/xmrig/pull/3391) Added support for townforge (monero fork using randomx).
+- [#3399](https://github.com/xmrig/xmrig/pull/3399) Fixed Zephyr mining (OpenCL).
+- [#3420](https://github.com/xmrig/xmrig/pull/3420) Fixed segfault in HTTP API rebind.
+
 # v6.21.0
 - [#3302](https://github.com/xmrig/xmrig/pull/3302) [#3312](https://github.com/xmrig/xmrig/pull/3312) Enabled keepalive for Windows (>= Vista).
 - [#3320](https://github.com/xmrig/xmrig/pull/3320) Added "built for OS/architecture/bits" to "ABOUT".

doc/API.md

@@ -4,7 +4,7 @@ If you want use HTTP API you need enable it (`"enabled": true,`) then choice `po
 
 Offical HTTP client for API: http://workers.xmrig.info/
 
-Example configuration, used in Curl examples below:
+Example configuration:
 
 ```json
 "api": {
@@ -12,11 +12,11 @@ Example configuration, used in Curl examples below:
 	"worker-id": null,
 },
 "http": {
-	"enabled": true,
+	"enabled": false,
 	"host": "127.0.0.1",
-	"port": 44444,
+	"port": 0,
-	"access-token": "SECRET",
+	"access-token": null,
-	"restricted": false
+	"restricted": true
 }
 ```
 
@@ -37,78 +37,30 @@ Versions before 2.15 was use another options for API https://github.com/xmrig/xm
 
 ## Endpoints
 
-### APIVersion 2
+### GET /1/summary
 
-#### GET /2/summary
+Get miner summary information. [Example](api/1/summary.json).
 
-Get miner summary information. [Example](api/2/summary.json).
+### GET /1/threads
 
-#### GET /2/backends
+Get detailed information about miner threads. [Example](api/1/threads.json).
-
-Get detailed information about miner backends. [Example](api/2/backends.json).
-
-### APIVersion 1 (deprecated)
-
-#### GET /1/summary
-
-Get miner summary information. Currently identical to `GET /2/summary`
-
-#### GET /1/threads
-
-**REMOVED** Get detailed information about miner threads. [Example](api/1/threads.json).
-
-Functionally replaced by `GET /2/backends` which contains a `threads` item per backend.
-
-### APIVersion 0 (deprecated)
-
-#### GET /api.json
-
-Get miner summary information. Currently identical to `GET /2/summary`
 
 
 ## Restricted endpoints
 
 All API endpoints below allow access to sensitive information and remote configure miner. You should set `access-token` and allow unrestricted access (`"restricted": false`).
 
-### JSON-RPC Interface
+### GET /1/config
 
-#### POST /json_rpc
+Get current miner configuration. [Example](api/1/config.json).
 
-Control miner with JSON-RPC. Methods: `pause`, `resume`, `stop`, `start`
 
-Curl example:
+### PUT /1/config
-
-```
-curl -v --data "{\"method\":\"pause\",\"id\":1}" -H "Content-Type: application/json" -H "Authorization: Bearer SECRET" http://127.0.0.1:44444/json_rpc
-```
-
-### APIVersion 2
-
-#### GET /2/config
-
-Get current miner configuration. [Example](api/2/config.json).
-
-#### PUT /2/config
 
 Update current miner configuration. Common use case, get current configuration, make changes, and upload it to miner.
 
 Curl example:
 
 ```
-...GET current config...
+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
-curl -v -H "Content-Type: application/json" -H "Authorization: Bearer SECRET" http://127.0.0.1:44444/2/config > config.json
-...make changes...
-vim config.json
-...PUT changed config...
-curl -v --data-binary @config.json -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer SECRET" http://127.0.0.1:44444/2/config
 ```
-
-### APIVersion 1 (deprecated)
-
-#### GET /1/config
-
-Get current miner configuration. Currently identical to `GET /2/config`
-
-#### PUT /1/config
-
-Update current miner configuration. Currently identical to `PUT /2/config`

doc/api/2/backends.json

@@ -1,78 +0,0 @@
-[
-    {
-        "type": "cpu",
-        "enabled": true,
-        "algo": "rx/0",
-        "profile": "rx",
-        "hw-aes": true,
-        "priority": -1,
-        "msr": true,
-        "asm": "intel",
-        "argon2-impl": "AVX2",
-        "hugepages": [6, 6],
-        "memory": 6291456,
-        "hashrate": [1235.78, 1228.89, null],
-        "threads": [
-            {
-                "intensity": 1,
-                "affinity": 0,
-                "av": 1,
-                "hashrate": [409.75, 406.58, null]
-            },
-            {
-                "intensity": 1,
-                "affinity": 2,
-                "av": 1,
-                "hashrate": [412.9, 411.33, null]
-            },
-            {
-                "intensity": 1,
-                "affinity": 4,
-                "av": 1,
-                "hashrate": [413.11, 410.98, null]
-            }
-        ]
-    },
-    {
-        "type": "cuda",
-        "enabled": true,
-        "algo": "cn-heavy/xhv",
-        "profile": "cn-heavy/xhv",
-        "versions": {
-            "cuda-runtime": "11.6",
-            "cuda-driver": "11.6",
-            "plugin": "6.17.1-dev",
-            "nvml": "11.512.15",
-            "driver": "512.15"
-        },
-        "hashrate": [247.02, 247.34, null],
-        "threads": [
-            {
-                "index": 0,
-                "threads": 32,
-                "blocks": 38,
-                "bfactor": 6,
-                "bsleep": 25,
-                "affinity": -1,
-                "cclock": 0,
-                "mclock": 0,
-                "dataset_host": false,
-                "hashrate": [246.77, 247.26, null],
-                "name": "NVIDIA GeForce GTX 970",
-                "bus_id": "01:00.0",
-                "smx": 13,
-                "arch": 52,
-                "global_mem": 4294836224,
-                "clock": 1177,
-                "memory_clock": 3666,
-                "health": {
-                    "temperature": 69,
-                    "power": 161,
-                    "clock": 1328,
-                    "mem_clock": 3662,
-                    "fan_speed": [100]
-                }
-            }
-        ]
-    }
-]

doc/api/2/config.json

@@ -1,136 +0,0 @@
-{
-    "api": {
-        "id": null,
-        "worker-id": null
-    },
-    "http": {
-        "enabled": true,
-        "host": "127.0.0.1",
-        "port": 44444,
-        "access-token": "SECRET",
-        "restricted": false
-    },
-    "autosave": true,
-    "background": false,
-    "colors": true,
-    "title": true,
-    "randomx": {
-        "init": -1,
-        "init-avx2": -1,
-        "mode": "auto",
-        "1gb-pages": true,
-        "rdmsr": true,
-        "wrmsr": true,
-        "cache_qos": false,
-        "numa": true,
-        "scratchpad_prefetch_mode": 1
-    },
-    "cpu": {
-        "enabled": true,
-        "huge-pages": true,
-        "huge-pages-jit": true,
-        "hw-aes": null,
-        "priority": null,
-        "memory-pool": true,
-        "yield": true,
-        "asm": true,
-        "argon2-impl": null,
-        "argon2": [0, 2, 4, 6, 5, 7],
-        "astrobwt/v2": [1, 2, 3, 4, 5, 6, 7],
-        "cn": [
-            [1, 0],
-            [1, 2],
-            [1, 4]
-        ],
-        "cn-heavy": [
-            [1, 0],
-            [1, 2]
-        ],
-        "cn-lite": [
-            [1, 0],
-            [1, 2],
-            [1, 4],
-            [1, 6],
-            [1, 5],
-            [1, 7]
-        ],
-        "cn-pico": [
-            [2, 1],
-            [2, 2],
-            [2, 3],
-            [2, 4],
-            [2, 5],
-            [2, 6],
-            [2, 7]
-        ],
-        "cn/2": [
-            [1, 0],
-            [1, 2],
-            [1, 4]
-        ],
-        "cn/upx2": [
-            [2, 1],
-            [2, 2],
-            [2, 3],
-            [2, 4],
-            [2, 5],
-            [2, 6],
-            [2, 7]
-        ],
-        "ghostrider": [
-            [8, 0],
-            [8, 2],
-            [8, 4]
-        ],
-        "rx": [0, 2, 4],
-        "rx/arq": [1, 2, 3, 4, 5, 6, 7],
-        "rx/keva": [0, 2, 4, 6, 5, 7],
-        "rx/wow": [0, 2, 4, 6, 5, 7],
-        "cn-lite/0": false,
-        "cn/0": "cn"
-    },
-    "log-file": null,
-    "donate-level": 0,
-    "donate-over-proxy": 0,
-    "pools": [
-        {
-            "algo": null,
-            "coin": null,
-            "url": "some.pool:10064",
-            "user": "4blahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahbl",
-            "pass": "x",
-            "rig-id": null,
-            "nicehash": false,
-            "keepalive": true,
-            "enabled": true,
-            "tls": false,
-            "wss": false,
-            "daemon": false,
-            "socks5": null,
-            "self-select": null,
-            "submit-to-origin": false
-        }
-    ],
-    "retries": 5,
-    "retry-pause": 5,
-    "print-time": 64,
-    "syslog": false,
-    "tls": {
-        "enabled": false,
-        "protocols": null,
-        "cert": null,
-        "cert_key": null,
-        "ciphers": null,
-        "ciphersuites": null,
-        "dhparam": null
-    },
-    "dns": {
-        "ipv6": false,
-        "ttl": 30
-    },
-    "user-agent": null,
-    "verbose": 1,
-    "watch": true,
-    "pause-on-battery": false,
-    "pause-on-active": false
-}

doc/api/2/summary.json

@@ -1,76 +0,0 @@
-{
-    "id": "51aca77da137cb62",
-    "worker_id": "tpad",
-    "uptime": 106,
-    "restricted": false,
-    "resources": {
-        "memory": {
-            "free": 4977348608,
-            "total": 16659546112,
-            "resident_set_memory": 16441344
-        },
-        "load_average": [3.4, 2.7, 2.44],
-        "hardware_concurrency": 8
-    },
-    "features": ["api", "asm", "http", "hwloc", "tls"],
-    "results": {
-        "diff_current": 37638,
-        "shares_good": 3,
-        "shares_total": 3,
-        "avg_time": 35,
-        "avg_time_ms": 35603,
-        "hashes_total": 165638,
-        "best": [358821, 344438, 73371, 0, 0, 0, 0, 0, 0, 0]
-    },
-    "algo": "rx/0",
-    "connection": {
-        "pool": "some.pool:20064",
-        "ip": "127.1.2.3",
-        "uptime": 106,
-        "uptime_ms": 106811,
-        "ping": 405,
-        "failures": 0,
-        "tls": "TLSv1.3",
-        "tls-fingerprint": null,
-        "algo": "rx/0",
-        "diff": 37638,
-        "accepted": 3,
-        "rejected": 0,
-        "avg_time": 35,
-        "avg_time_ms": 35603,
-        "hashes_total": 165638
-    },
-    "version": "6.17.1-dev",
-    "kind": "miner",
-    "ua": "XMRig/6.17.1-dev (Linux x86_64) libuv/1.43.0 gcc/9.4.0",
-    "cpu": {
-        "brand": "Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz",
-        "family": 6,
-        "model": 60,
-        "stepping": 3,
-        "proc_info": 198339,
-        "aes": true,
-        "avx2": true,
-        "x64": true,
-        "64_bit": true,
-        "l2": 1048576,
-        "l3": 6291456,
-        "cores": 4,
-        "threads": 8,
-        "packages": 1,
-        "nodes": 1,
-        "backend": "hwloc/2.7.0",
-        "msr": "intel",
-        "assembly": "intel",
-        "arch": "x86_64",
-        "flags": ["aes", "avx", "avx2", "bmi2", "osxsave", "pdpe1gb", "sse2", "ssse3", "sse4.1", "popcnt"]
-    },
-    "donate_level": 0,
-    "paused": false,
-    "algorithms": ["cn/0", "cn/1", "cn/2", "cn/r", "cn/fast", "cn/half", "cn/xao", "cn/rto", "cn/rwz", "cn/zls", "cn/double", "cn/ccx", "cn-lite/1", "cn-heavy/0", "cn-heavy/tube", "cn-heavy/xhv", "cn-pico", "cn-pico/tlo", "cn/upx2", "rx/0", "rx/wow", "rx/arq", "rx/graft", "rx/sfx", "rx/keva", "argon2/chukwa", "argon2/chukwav2", "argon2/ninja", "astrobwt/v2", "ghostrider"],
-    "hashrate": {
-        "total": [1207.19, 1210.82, null],
-        "highest": 1316.85
-    },
-    "hugepages": [6, 6]
-}

src/base/api/Api.cpp

@@ -39,6 +39,7 @@
 
 
 #include <thread>
+#include <iostream>
 
 
 namespace xmrig {
@@ -80,7 +81,8 @@ static rapidjson::Value getResources(rapidjson::Document &doc)
 
 xmrig::Api::Api(Base *base) :
     m_base(base),
-    m_timestamp(Chrono::currentMSecsSinceEpoch())
+    m_timestamp(Chrono::currentMSecsSinceEpoch()),
+    m_httpd(nullptr)
 {
     base->addListener(this);
 
@@ -91,7 +93,11 @@ xmrig::Api::Api(Base *base) :
 xmrig::Api::~Api()
 {
 #   ifdef XMRIG_FEATURE_HTTP
-    delete m_httpd;
+    if (m_httpd) {
+        m_httpd->stop();
+        delete m_httpd;
+        m_httpd = nullptr; // Ensure the pointer is set to nullptr after deletion
+    }
 #   endif
 }
 
@@ -109,8 +115,14 @@ void xmrig::Api::start()
     genWorkerId(m_base->config()->apiWorkerId());
 
 #   ifdef XMRIG_FEATURE_HTTP
-    m_httpd = new Httpd(m_base);
+    if (!m_httpd) {
-    m_httpd->start();
+        m_httpd = new Httpd(m_base);
+        if (!m_httpd->start()) {
+            std::cerr << "HTTP server failed to start." << std::endl;
+            delete m_httpd; // Properly handle failure to start
+            m_httpd = nullptr;
+        }
+    }
 #   endif
 }
 
@@ -118,7 +130,9 @@ void xmrig::Api::start()
 void xmrig::Api::stop()
 {
 #   ifdef XMRIG_FEATURE_HTTP
-    m_httpd->stop();
+    if (m_httpd) {
+        m_httpd->stop();
+    }
 #   endif
 }
 
@@ -126,13 +140,15 @@ void xmrig::Api::stop()
 void xmrig::Api::tick()
 {
 #   ifdef XMRIG_FEATURE_HTTP
-    if (m_httpd->isBound() || !m_base->config()->http().isEnabled()) {
+    if (!m_httpd || !m_base->config()->http().isEnabled() || m_httpd->isBound()) {
         return;
     }
 
     if (++m_ticks % 10 == 0) {
         m_ticks = 0;
-        m_httpd->start();
+        if (m_httpd) {
+            m_httpd->start();
+        }
     }
 #   endif
 }

src/base/api/interfaces/IApiRequest.h

@@ -52,8 +52,6 @@ public:
     enum RequestType {
         REQ_UNKNOWN,
         REQ_SUMMARY,
-        REQ_BACKENDS,
-        REQ_CONFIG,
         REQ_JSON_RPC
     };
 

src/base/api/requests/ApiRequest.h

@@ -60,7 +60,7 @@ protected:
     inline Source source() const override           { return m_source; }
     inline void done(int) override                  { m_state = STATE_DONE; }
 
-    int m_version       = 0;
+    int m_version       = 1;
     RequestType m_type  = REQ_UNKNOWN;
     State m_state       = STATE_NEW;
     String m_rpcMethod;

src/base/api/requests/HttpApiRequest.cpp

@@ -67,33 +67,10 @@ xmrig::HttpApiRequest::HttpApiRequest(const HttpData &req, bool restricted) :
     m_res(req.id()),
     m_url(req.url.c_str())
 {
-    if (url().size() > 4 && memcmp(url().data(), "/", 1) == 0 && memcmp(url().data()+2, "/", 1) == 0) {
+    if (method() == METHOD_GET) {
-        if (memcmp(url().data(), "/2/", 3) == 0) {
+        if (url() == "/1/summary" || url() == "/2/summary" || url() == "/api.json") {
-            m_version = 2;
-        } else if (memcmp(url().data(), "/1/", 3) == 0) {
-            m_version = 1;
-        }
-        switch (url().size()) {
-        case 9:
-            if (memcmp(url().data()+3, "config", 6) == 0) {
-                m_type = REQ_CONFIG;
-            }
-            break;
-        case 10:
-            if (memcmp(url().data()+3, "summary", 7) == 0) {
-                m_type = REQ_SUMMARY;
-            }
-            break;
-        case 11:
-            if (memcmp(url().data()+3, "backends", 8) == 0) {
-                m_type = REQ_BACKENDS;
-            }
-            break;
-        }
-    }
-
-    if (url() == "/api.json") {
             m_type = REQ_SUMMARY;
+        }
     }
 
     if (method() == METHOD_POST && url() == "/json_rpc") {
@@ -117,6 +94,12 @@ xmrig::HttpApiRequest::HttpApiRequest(const HttpData &req, bool restricted) :
 
         return;
     }
+
+    if (url().size() > 4) {
+        if (memcmp(url().data(), "/2/", 3) == 0) {
+            m_version = 2;
+        }
+    }
 }
 
 

src/base/kernel/Base.cpp

@@ -45,6 +45,13 @@
 #ifdef XMRIG_FEATURE_API
 #   include "base/api/Api.h"
 #   include "base/api/interfaces/IApiRequest.h"
+
+namespace xmrig {
+
+static const char *kConfigPathV1 = "/1/config";
+static const char *kConfigPathV2 = "/2/config";
+
+} // namespace xmrig
 #endif
 
 
@@ -310,7 +317,7 @@ void xmrig::Base::onFileChanged(const String &fileName)
 void xmrig::Base::onRequest(IApiRequest &request)
 {
     if (request.method() == IApiRequest::METHOD_GET) {
-        if (request.type() == IApiRequest::REQ_CONFIG) {
+        if (request.url() == kConfigPathV1 || request.url() == kConfigPathV2) {
             if (request.isRestricted()) {
                 return request.done(403);
             }
@@ -320,7 +327,7 @@ void xmrig::Base::onRequest(IApiRequest &request)
         }
     }
     else if (request.method() == IApiRequest::METHOD_PUT || request.method() == IApiRequest::METHOD_POST) {
-        if (request.type() == IApiRequest::REQ_CONFIG) {
+        if (request.url() == kConfigPathV1 || request.url() == kConfigPathV2) {
             request.accept();
 
             if (!reload(request.json())) {

src/core/Miner.cpp

@@ -689,7 +689,7 @@ void xmrig::Miner::onRequest(IApiRequest &request)
             d_ptr->getMiner(request.reply(), request.doc(), request.version());
             d_ptr->getHashrate(request.reply(), request.doc(), request.version());
         }
-        else if (request.type() == IApiRequest::REQ_BACKENDS && request.version() == 2) {
+        else if (request.url() == "/2/backends") {
             request.accept();
 
             d_ptr->getBackends(request.reply(), request.doc());
@@ -711,12 +711,6 @@ void xmrig::Miner::onRequest(IApiRequest &request)
 
             stop();
         }
-        else if (request.rpcMethod() == "start") {
-            request.accept();
-
-            const auto config = d_ptr->controller->config();
-            onConfigChanged(config, config);
-        }
     }
 
     for (IBackend *backend : d_ptr->backends) {

src/version.h

@@ -1,6 +1,6 @@
 /* XMRig
- * Copyright (c) 2018-2023 SChernykh   <https://github.com/SChernykh>
+ * Copyright (c) 2018-2024 SChernykh   <https://github.com/SChernykh>
- * Copyright (c) 2016-2023 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
+ * Copyright (c) 2016-2024 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -22,10 +22,10 @@
 #define APP_ID        "xmrig"
 #define APP_NAME      "XMRig"
 #define APP_DESC      "XMRig miner"
-#define APP_VERSION   "6.21.1-dev"
+#define APP_VERSION   "6.21.1"
 #define APP_DOMAIN    "xmrig.com"
 #define APP_SITE      "www.xmrig.com"
-#define APP_COPYRIGHT "Copyright (C) 2016-2023 xmrig.com"
+#define APP_COPYRIGHT "Copyright (C) 2016-2024 xmrig.com"
 #define APP_KIND      "miner"
 
 #define APP_VER_MAJOR  6