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".

CMakeLists.txt

@@ -32,7 +32,6 @@ option(WITH_VAES            "Enable VAES instructions for Cryptonight" ON)
 option(WITH_BENCHMARK       "Enable builtin RandomX benchmark and stress test" ON)
 option(WITH_SECURE_JIT      "Enable secure access to JIT memory" OFF)
 option(WITH_DMI             "Enable DMI/SMBIOS reader" ON)
-option(WITH_BUNDLED_FMT     "Force use of bundled fmt library" ON)
 
 option(BUILD_STATIC         "Build static binary" OFF)
 option(ARM_V8               "Force ARMv8 (64 bit) architecture, use with caution if automatic detection fails, but you sure it may work" OFF)
@@ -199,7 +198,6 @@ add_definitions(-D__STDC_FORMAT_MACROS -DUNICODE -D_FILE_OFFSET_BITS=64)
 find_package(UV REQUIRED)
 
 include(cmake/flags.cmake)
-include(cmake/fmt.cmake)
 include(cmake/randomx.cmake)
 include(cmake/argon2.cmake)
 include(cmake/kawpow.cmake)
@@ -231,7 +229,7 @@ include(src/hw/api/api.cmake)
 include(src/hw/dmi/dmi.cmake)
 
 include_directories(src)
-include_directories(src/3rdparty/CL)
+include_directories(src/3rdparty)
 include_directories(${UV_INCLUDE_DIR})
 
 if (WITH_DEBUG_LOG)
@@ -239,7 +237,7 @@ if (WITH_DEBUG_LOG)
 endif()
 
 add_executable(${CMAKE_PROJECT_NAME} ${HEADERS} ${SOURCES} ${SOURCES_OS} ${HEADERS_CRYPTO} ${SOURCES_CRYPTO} ${SOURCES_SYSLOG} ${TLS_SOURCES} ${XMRIG_ASM_SOURCES})
-target_link_libraries(${CMAKE_PROJECT_NAME} ${XMRIG_ASM_LIBRARY} ${OPENSSL_LIBRARIES} ${UV_LIBRARIES} ${EXTRA_LIBS} ${CPUID_LIB} ${ARGON2_LIBRARY} ${ETHASH_LIBRARY} ${GHOSTRIDER_LIBRARY} ${FMT_LIBRARY})
+target_link_libraries(${CMAKE_PROJECT_NAME} ${XMRIG_ASM_LIBRARY} ${OPENSSL_LIBRARIES} ${UV_LIBRARIES} ${EXTRA_LIBS} ${CPUID_LIB} ${ARGON2_LIBRARY} ${ETHASH_LIBRARY} ${GHOSTRIDER_LIBRARY})
 
 if (WIN32)
     add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_if_different "${CMAKE_SOURCE_DIR}/bin/WinRing0/WinRing0x64.sys" $<TARGET_FILE_DIR:${CMAKE_PROJECT_NAME}>)

cmake/fmt.cmake

@@ -1,13 +0,0 @@
-# SPDX-FileCopyrightText: © 2023 Jean-Pierre De Jesus DIAZ <me@jeandudey.tech>
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-
-if(WITH_BUNDLED_FMT)
-    add_library(fmt INTERFACE)
-    target_sources(fmt INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/src/3rdparty/fmt/format.cc)
-    target_include_directories(fmt INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/src/3rdparty/fmt)
-else()
-    set(FMT_LIBRARY fmt)
-    find_package(fmt REQUIRED)
-    set(FMT_LIBRARY fmt::fmt)
-endif()

src/3rdparty/cl.h

@@ -29,7 +29,7 @@
 #if defined(__APPLE__)
 #   include <OpenCL/cl.h>
 #else
-#   include <CL/cl.h>
+#   include "3rdparty/CL/cl.h"
 #endif
 
 

src/3rdparty/fmt/format.cc

@@ -5,7 +5,7 @@
 //
 // For the license information refer to format.h.
 
-#include "fmt/format-inl.h"
+#include "3rdparty/fmt/format-inl.h"
 
 FMT_BEGIN_NAMESPACE
 namespace detail {

src/backend/cpu/platform/lscpu_arm.cpp

@@ -18,11 +18,11 @@
  */
 
 #include "base/tools/String.h"
+#include "3rdparty/fmt/core.h"
 
 
 #include <cstdio>
 #include <cctype>
-#include <fmt/core.h>
 
 
 namespace xmrig {

src/backend/opencl/wrappers/AdlLib_linux.cpp

@@ -20,6 +20,7 @@
 
 
 #include "backend/opencl/wrappers/AdlLib.h"
+#include "3rdparty/fmt/core.h"
 #include "backend/opencl/wrappers/OclDevice.h"
 
 
@@ -30,7 +31,6 @@
 #include <string>
 #include <sys/stat.h>
 #include <sys/types.h>
-#include <fmt/core.h>
 
 
 namespace xmrig {

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);
-    m_httpd->start();
+    if (!m_httpd) {
+        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/base.cmake

@@ -88,6 +88,7 @@ set(HEADERS_BASE
    )
 
 set(SOURCES_BASE
+    src/3rdparty/fmt/format.cc
     src/base/crypto/Algorithm.cpp
     src/base/crypto/Coin.cpp
     src/base/crypto/keccak.cpp

src/base/kernel/Process.cpp

@@ -22,10 +22,10 @@
 
 
 #include "base/kernel/Process.h"
+#include "3rdparty/fmt/core.h"
 #include "base/tools/Chrono.h"
 #include "version.h"
 
-#include <fmt/core.h>
 
 #ifdef XMRIG_OS_WIN
 #   ifdef _MSC_VER

src/base/net/stratum/BaseClient.cpp

@@ -17,6 +17,7 @@
  */
 
 #include "base/net/stratum/BaseClient.h"
+#include "3rdparty/fmt/core.h"
 #include "3rdparty/rapidjson/document.h"
 #include "base/io/Env.h"
 #include "base/io/log/Log.h"
@@ -24,8 +25,6 @@
 #include "base/kernel/interfaces/IClientListener.h"
 #include "base/net/stratum/SubmitResult.h"
 
-#include <fmt/core.h>
-
 
 namespace xmrig {
 

src/base/net/stratum/Pool.h

@@ -1,7 +1,7 @@
 /* XMRig
  * Copyright (c) 2019      Howard Chu  <https://github.com/hyc>
- * Copyright (c) 2018-2021 SChernykh   <https://github.com/SChernykh>
- * Copyright (c) 2016-2021 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
+ * Copyright (c) 2018-2024 SChernykh   <https://github.com/SChernykh>
+ * 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
@@ -59,7 +59,7 @@ public:
     static const char *kCoin;
     static const char *kDaemon;
     static const char *kDaemonPollInterval;
-    static const char* kDaemonJobTimeout;
+    static const char *kDaemonJobTimeout;
     static const char *kEnabled;
     static const char *kFingerprint;
     static const char *kKeepalive;
@@ -70,11 +70,11 @@ public:
     static const char *kSOCKS5;
     static const char *kSubmitToOrigin;
     static const char *kTls;
-    static const char* kSni;
+    static const char *kSni;
     static const char *kUrl;
     static const char *kUser;
-    static const char* kSpendSecretKey;
-    static const char* kDaemonZMQPort;
+    static const char *kSpendSecretKey;
+    static const char *kDaemonZMQPort;
     static const char *kNicehashHost;
 
     constexpr static int kKeepAliveTimeout         = 60;

src/base/net/stratum/benchmark/BenchClient.cpp

@@ -17,6 +17,7 @@
  */
 
 #include "base/net/stratum/benchmark/BenchClient.h"
+#include "3rdparty/fmt/core.h"
 #include "3rdparty/rapidjson/document.h"
 #include "backend/common/benchmark/BenchState.h"
 #include "backend/common/interfaces/IBackend.h"
@@ -38,8 +39,6 @@
 #   include "hw/dmi/DmiReader.h"
 #endif
 
-#include <fmt/core.h>
-
 
 xmrig::BenchClient::BenchClient(const std::shared_ptr<BenchConfig> &benchmark, IClientListener* listener) :
     m_listener(listener),

src/base/net/stratum/benchmark/BenchConfig.cpp

@@ -17,12 +17,12 @@
  */
 
 #include "base/net/stratum/benchmark/BenchConfig.h"
+#include "3rdparty/fmt/core.h"
 #include "3rdparty/rapidjson/document.h"
 #include "base/io/json/Json.h"
 
 
 #include <string>
-#include <fmt/core.h>
 
 
 #ifdef _MSC_VER

src/core/config/usage.h

@@ -4,8 +4,8 @@
  * Copyright (c) 2014      Lucas Jones <https://github.com/lucasjones>
  * Copyright (c) 2014-2016 Wolf9466    <https://github.com/OhGodAPet>
  * Copyright (c) 2016      Jay D Dee   <jayddee246@gmail.com>
- * Copyright (c) 2018-2021 SChernykh   <https://github.com/SChernykh>
- * Copyright (c) 2016-2021 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
+ * Copyright (c) 2018-2024 SChernykh   <https://github.com/SChernykh>
+ * 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
@@ -64,7 +64,7 @@ static inline const std::string &usage()
 
 #   ifdef XMRIG_FEATURE_HTTP
     u += "      --daemon                  use daemon RPC instead of pool for solo mining\n";
-    u += "      --daemon-zmq-port         daemon's zmq-pub port number (only use it if daemon has it enabled)\n";
+    u += "      --daemon-zmq-port=N       daemon's zmq-pub port number (only use it if daemon has it enabled)\n";
     u += "      --daemon-poll-interval=N  daemon poll interval in milliseconds (default: 1000)\n";
     u += "      --daemon-job-timeout=N    daemon job timeout in milliseconds (default: 15000)\n";
     u += "      --self-select=URL         self-select block templates from URL\n";

src/crypto/common/LinuxMemory.cpp

@@ -17,12 +17,12 @@
  */
 
 #include "crypto/common/LinuxMemory.h"
+#include "3rdparty/fmt/core.h"
 #include "crypto/common/VirtualMemory.h"
 
 
 #include <algorithm>
 #include <fstream>
-#include <fmt/core.h>
 #include <mutex>
 #include <string>
 

src/hw/dmi/DmiMemory.cpp

@@ -20,6 +20,7 @@
 
 
 #include "hw/dmi/DmiMemory.h"
+#include "3rdparty/fmt/format.h"
 #include "3rdparty/rapidjson/document.h"
 #include "hw/dmi/DmiTools.h"
 
@@ -27,7 +28,6 @@
 #include <algorithm>
 #include <array>
 #include <regex>
-#include <fmt/format.h>
 
 
 namespace xmrig {

src/hw/dmi/DmiReader.cpp

@@ -19,11 +19,10 @@
  */
 
 #include "hw/dmi/DmiReader.h"
+#include "3rdparty/fmt/core.h"
 #include "3rdparty/rapidjson/document.h"
 #include "hw/dmi/DmiTools.h"
 
-#include <fmt/core.h>
-
 
 namespace xmrig {
 

src/hw/msr/Msr_linux.cpp

@@ -18,6 +18,7 @@
 
 
 #include "hw/msr/Msr.h"
+#include "3rdparty/fmt/core.h"
 #include "backend/cpu/Cpu.h"
 #include "base/io/log/Log.h"
 
@@ -28,7 +29,6 @@
 #include <cstdio>
 #include <dirent.h>
 #include <fcntl.h>
-#include <fmt/core.h>
 #include <fstream>
 #include <sys/stat.h>
 #include <sys/types.h>

src/version.h

@@ -1,6 +1,6 @@
 /* XMRig
- * Copyright (c) 2018-2023 SChernykh   <https://github.com/SChernykh>
- * Copyright (c) 2016-2023 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
+ * Copyright (c) 2018-2024 SChernykh   <https://github.com/SChernykh>
+ * 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