mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-11-12 23:18:14 +01:00
Merge bitcoin/bitcoin#24933: util: Replace non-threadsafe strerror
e3a06a3c6ctest: Add `strerror` to locale-dependence linter (laanwj)f00fb1265autil: Increase buffer size to 1024 in SysErrorString (laanwj)718da302c7util: Refactor SysErrorString logic (laanwj)e7f2f77756util: Use strerror_s for SysErrorString on Windows (laanwj)46971c6dbfutil: Replace non-threadsafe strerror (laanwj) Pull request description: Some uses of non-threadsafe `strerror` have snuck into the code since they were removed in #4152. Add a wrapper `SysErrorString` for thread-safe strerror alternatives (with code from `NetworkErrorString`) and replace all uses of `strerror` with this. Edit: I've also added a commit that refactors the code so that buf[] is never read at all if the function fails, making some fragile-looking code unnecessary. Edit2: from the linux manpage: ``` ATTRIBUTES For an explanation of the terms used in this section, see attributes(7). ┌───────────────────┬───────────────┬─────────────────────────┐ │Interface │ Attribute │ Value │ ├───────────────────┼───────────────┼─────────────────────────┤ │strerror() │ Thread safety │ MT-Unsafe race:strerror │ ├───────────────────┼───────────────┼─────────────────────────┤ … ├───────────────────┼───────────────┼─────────────────────────┤ │strerror_r(), │ Thread safety │ MT-Safe │ │strerror_l() │ │ │ └───────────────────┴───────────────┴─────────────────────────┘ ``` As the function can be called from any thread at any time, using a non-thread-safe function is unacceptable. ACKs for top commit: jonatack: ACKe3a06a3c6cTree-SHA512: 20e71ebb9e979d4e1d8cafbb2e32e20c2a63f09115fe72cdde67c8f80ae98c531d286f935fd8a6e92a18b72607d7bd3e846b2d871d9691a6036b0676de8aaf25
This commit is contained in:
@@ -7,6 +7,7 @@
|
||||
#include <threadinterrupt.h>
|
||||
#include <tinyformat.h>
|
||||
#include <util/sock.h>
|
||||
#include <util/syserror.h>
|
||||
#include <util/system.h>
|
||||
#include <util/time.h>
|
||||
|
||||
@@ -344,19 +345,8 @@ std::string NetworkErrorString(int err)
|
||||
#else
|
||||
std::string NetworkErrorString(int err)
|
||||
{
|
||||
char buf[256];
|
||||
buf[0] = 0;
|
||||
/* Too bad there are two incompatible implementations of the
|
||||
* thread-safe strerror. */
|
||||
const char *s;
|
||||
#ifdef STRERROR_R_CHAR_P /* GNU variant can return a pointer outside the passed buffer */
|
||||
s = strerror_r(err, buf, sizeof(buf));
|
||||
#else /* POSIX variant always returns message in buffer */
|
||||
s = buf;
|
||||
if (strerror_r(err, buf, sizeof(buf)))
|
||||
buf[0] = 0;
|
||||
#endif
|
||||
return strprintf("%s (%d)", s, err);
|
||||
// On BSD sockets implementations, NetworkErrorString is the same as SysErrorString.
|
||||
return SysErrorString(err);
|
||||
}
|
||||
#endif
|
||||
|
||||
|
||||
34
src/util/syserror.cpp
Normal file
34
src/util/syserror.cpp
Normal file
@@ -0,0 +1,34 @@
|
||||
// Copyright (c) 2020-2022 The Bitcoin Core developers
|
||||
// Distributed under the MIT software license, see the accompanying
|
||||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#if defined(HAVE_CONFIG_H)
|
||||
#include <config/bitcoin-config.h>
|
||||
#endif
|
||||
|
||||
#include <tinyformat.h>
|
||||
#include <util/syserror.h>
|
||||
|
||||
#include <cstring>
|
||||
|
||||
std::string SysErrorString(int err)
|
||||
{
|
||||
char buf[1024];
|
||||
/* Too bad there are three incompatible implementations of the
|
||||
* thread-safe strerror. */
|
||||
const char *s = nullptr;
|
||||
#ifdef WIN32
|
||||
if (strerror_s(buf, sizeof(buf), err) == 0) s = buf;
|
||||
#else
|
||||
#ifdef STRERROR_R_CHAR_P /* GNU variant can return a pointer outside the passed buffer */
|
||||
s = strerror_r(err, buf, sizeof(buf));
|
||||
#else /* POSIX variant always returns message in buffer */
|
||||
if (strerror_r(err, buf, sizeof(buf)) == 0) s = buf;
|
||||
#endif
|
||||
#endif
|
||||
if (s != nullptr) {
|
||||
return strprintf("%s (%d)", s, err);
|
||||
} else {
|
||||
return strprintf("Unknown error (%d)", err);
|
||||
}
|
||||
}
|
||||
16
src/util/syserror.h
Normal file
16
src/util/syserror.h
Normal file
@@ -0,0 +1,16 @@
|
||||
// Copyright (c) 2010-2022 The Bitcoin Core developers
|
||||
// Distributed under the MIT software license, see the accompanying
|
||||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#ifndef BITCOIN_UTIL_SYSERROR_H
|
||||
#define BITCOIN_UTIL_SYSERROR_H
|
||||
|
||||
#include <string>
|
||||
|
||||
/** Return system error string from errno value. Use this instead of
|
||||
* std::strerror, which is not thread-safe. For network errors use
|
||||
* NetworkErrorString from sock.h instead.
|
||||
*/
|
||||
std::string SysErrorString(int err);
|
||||
|
||||
#endif // BITCOIN_UTIL_SYSERROR_H
|
||||
@@ -25,6 +25,7 @@
|
||||
#include <util/getuniquepath.h>
|
||||
#include <util/strencodings.h>
|
||||
#include <util/string.h>
|
||||
#include <util/syserror.h>
|
||||
#include <util/translation.h>
|
||||
|
||||
|
||||
@@ -1374,7 +1375,7 @@ void ScheduleBatchPriority()
|
||||
const static sched_param param{};
|
||||
const int rc = pthread_setschedparam(pthread_self(), SCHED_BATCH, ¶m);
|
||||
if (rc != 0) {
|
||||
LogPrintf("Failed to pthread_setschedparam: %s\n", strerror(rc));
|
||||
LogPrintf("Failed to pthread_setschedparam: %s\n", SysErrorString(rc));
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user