phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-10 11:57:28 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge bitcoin/bitcoin#25493: compat: document code in compat.h

Browse source 
f7dc99244c compat: document redefining ssize_t when using MSVC (fanquake)
3be7ee750f compat: document error-code mapping (fanquake)
3f1d2fb035 compat: document sockopt_arg_type definition (fanquake)
fb6db6fb0e compat: document S_I* defines when building for Windows (fanquake)
203e682d22 compat: extract and document MAX_PATH (fanquake)
b63ddb7e6d compat: remove unused WSA* definitions (fanquake)
7c3df5e548 compat: document FD_SETSIZE redefinition for WIN32 (fanquake)
cc7b2fdd70 refactor: move compat.h into compat/ (fanquake)

Pull request description:

  Move `compat.h` into `compat/`, and document what is in there.

ACKs for top commit:
  vasild:
    ACK f7dc99244c
  hebasto:
    re-ACK f7dc99244c

Tree-SHA512: 9e7e90261a97eae7998ef8d140d8ffab504cccf19abb44ca253d8919a067bb01e3fa9876a44194a1a9fb08a4b0489376844f827d8a27aa66c0f99c60ad5d7041
This commit is contained in:
MacroFake 2022-07-20 15:50:51 +02:00
commit 5c82ca3365
No known key found for this signature in database
GPG key ID: CE2B75697E69A548
30 changed files with 59 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/Makefile.am
View file

@ -133,9 +133,9 @@ BITCOIN_CORE_H = \
clientversion.h \
coins.h \
common/bloom.h \
compat.h \
compat/assumptions.h \
compat/byteswap.h \
compat/compat.h \
compat/cpuid.h \
compat/endian.h \
compressor.h \

2
src/bitcoin-cli.cpp
View file

@ -9,7 +9,7 @@
#include <chainparamsbase.h>
#include <clientversion.h>
#include <compat.h>
#include <compat/compat.h>
#include <compat/stdin.h>
#include <policy/feerate.h>
#include <rpc/client.h>

2
src/bitcoin-tx.cpp
View file

@ -8,7 +8,7 @@
#include <clientversion.h>
#include <coins.h>
#include <compat.h>
#include <compat/compat.h>
#include <consensus/amount.h>
#include <consensus/consensus.h>
#include <core_io.h>

2
src/bitcoin-util.cpp
View file

@ -11,7 +11,7 @@
#include <chainparams.h>
#include <chainparamsbase.h>
#include <clientversion.h>
#include <compat.h>
#include <compat/compat.h>
#include <core_io.h>
#include <streams.h>
#include <util/system.h>

2
src/bitcoin-wallet.cpp
View file

@ -9,7 +9,7 @@
#include <chainparams.h>
#include <chainparamsbase.h>
#include <clientversion.h>
#include <compat.h>
#include <compat/compat.h>
#include <interfaces/init.h>
#include <key.h>
#include <logging.h>

2
src/bitcoind.cpp
View file

@ -9,7 +9,7 @@
#include <chainparams.h>
#include <clientversion.h>
#include <compat.h>
#include <compat/compat.h>
#include <init.h>
#include <interfaces/chain.h>
#include <interfaces/init.h>

52
src/compat.h → src/compat/compat.h
View file

@ -3,21 +3,24 @@
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#ifndef BITCOIN_COMPAT_H
#define BITCOIN_COMPAT_H
#ifndef BITCOIN_COMPAT_COMPAT_H
#define BITCOIN_COMPAT_COMPAT_H
#if defined(HAVE_CONFIG_H)
#include <config/bitcoin-config.h>
#endif
// Windows defines FD_SETSIZE to 64 (see _fd_types.h in mingw-w64),
// which is too small for our usage, but allows us to redefine it safely.
// We redefine it to be 1024, to match glibc, see typesizes.h.
#ifdef WIN32
#ifdef FD_SETSIZE
#undef FD_SETSIZE // prevent redefinition compiler warning
#undef FD_SETSIZE
#endif
#define FD_SETSIZE 1024 // max number of fds in fd_set
#define FD_SETSIZE 1024
#include <winsock2.h>
#include <ws2tcpip.h>
#include <stdint.h>
#include <cstdint>
#else
#include <fcntl.h>
#include <sys/mman.h>
@ -34,49 +37,54 @@
#include <unistd.h>
#endif
// We map Linux / BSD error functions and codes, to the equivalent
// Windows definitions, and use the WSA* names throughout our code.
// Note that glibc defines EWOULDBLOCK as EAGAIN (see errno.h).
#ifndef WIN32
typedef unsigned int SOCKET;
#include <errno.h>
#include <cerrno>
#define WSAGetLastError() errno
#define WSAEINVAL EINVAL
#define WSAEALREADY EALREADY
#define WSAEWOULDBLOCK EWOULDBLOCK
#define WSAEAGAIN EAGAIN
#define WSAEMSGSIZE EMSGSIZE
#define WSAEINTR EINTR
#define WSAEINPROGRESS EINPROGRESS
#define WSAEADDRINUSE EADDRINUSE
#define WSAENOTSOCK EBADF
#define INVALID_SOCKET (SOCKET)(~0)
#define SOCKET_ERROR -1
#else
#ifndef WSAEAGAIN
// WSAEAGAIN doesn't exist on Windows
#ifdef EAGAIN
#define WSAEAGAIN EAGAIN
#else
#define WSAEAGAIN WSAEWOULDBLOCK
#endif
#endif
#endif
// Windows doesn't define S_IRUSR or S_IWUSR. We define both
// here, with the same values as glibc (see stat.h).
#ifdef WIN32
#ifndef S_IRUSR
#define S_IRUSR 0400
#define S_IWUSR 0200
#endif
#else
#define MAX_PATH 1024
#endif
#ifdef _MSC_VER
#if !defined(ssize_t)
#ifdef _WIN64
typedef int64_t ssize_t;
#else
typedef int32_t ssize_t;
#endif
#endif
#endif
// Windows defines MAX_PATH as it's maximum path length.
// We define MAX_PATH for use on non-Windows systems.
#ifndef WIN32
#define MAX_PATH 1024
#endif
// ssize_t is POSIX, and not present when using MSVC.
#ifdef _MSC_VER
#include <BaseTsd.h>
typedef SSIZE_T ssize_t;
#endif
// The type of the option value passed to getsockopt & setsockopt
// differs between Windows and non-Windows.
#ifndef WIN32
typedef void* sockopt_arg_type;
#else
@ -119,4 +127,4 @@ bool static inline IsSelectableSocket(const SOCKET& s) {
#define MSG_DONTWAIT 0
#endif
#endif // BITCOIN_COMPAT_H
#endif // BITCOIN_COMPAT_COMPAT_H

2
src/httpserver.cpp
View file

@ -9,7 +9,7 @@
#include <httpserver.h>
#include <chainparamsbase.h>
#include <compat.h>
#include <compat/compat.h>
#include <netbase.h>
#include <node/interface_ui.h>
#include <rpc/protocol.h> // For HTTP status codes

2
src/i2p.cpp
View file

@ -3,7 +3,7 @@
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <chainparams.h>
#include <compat.h>
#include <compat/compat.h>
#include <compat/endian.h>
#include <crypto/sha256.h>
#include <fs.h>

2
src/i2p.h
View file

@ -5,7 +5,7 @@
#ifndef BITCOIN_I2P_H
#define BITCOIN_I2P_H
#include <compat.h>
#include <compat/compat.h>
#include <fs.h>
#include <netaddress.h>
#include <sync.h>

2
src/mapport.cpp
View file

@ -19,7 +19,7 @@
#include <util/thread.h>
#ifdef USE_NATPMP
#include <compat.h>
#include <compat/compat.h>
#include <natpmp.h>
#endif // USE_NATPMP

2
src/net.cpp
View file

@ -13,7 +13,7 @@
#include <addrman.h>
#include <banman.h>
#include <clientversion.h>
#include <compat.h>
#include <compat/compat.h>
#include <consensus/consensus.h>
#include <crypto/sha256.h>
#include <node/eviction.h>

2
src/net.h
View file

@ -8,7 +8,7 @@
#include <chainparams.h>
#include <common/bloom.h>
#include <compat.h>
#include <compat/compat.h>
#include <node/connection_types.h>
#include <consensus/amount.h>
#include <crypto/siphash.h>

2
src/netaddress.h
View file

@ -9,7 +9,7 @@
#include <config/bitcoin-config.h>
#endif
#include <compat.h>
#include <compat/compat.h>
#include <crypto/siphash.h>
#include <prevector.h>
#include <random.h>

2
src/netbase.cpp
View file

@ -5,7 +5,7 @@
#include <netbase.h>
#include <compat.h>
#include <compat/compat.h>
#include <sync.h>
#include <tinyformat.h>
#include <util/sock.h>

2
src/netbase.h
View file

@ -9,7 +9,7 @@
#include <config/bitcoin-config.h>
#endif
#include <compat.h>
#include <compat/compat.h>
#include <netaddress.h>
#include <serialize.h>
#include <util/sock.h>

2
src/qt/main.cpp
View file

@ -4,7 +4,7 @@
#include <qt/bitcoin.h>
#include <compat.h>
#include <compat/compat.h>
#include <util/translation.h>
#include <util/url.h>

2
src/random.cpp
View file

@ -10,7 +10,7 @@
#include <crypto/sha512.h>
#include <support/cleanse.h>
#ifdef WIN32
#include <compat.h> // for Windows API
#include <compat/compat.h>
#include <wincrypt.h>
#endif
#include <logging.h>

2
src/randomenv.cpp
View file

@ -15,7 +15,7 @@
#include <support/cleanse.h>
#include <util/time.h> // for GetTime()
#ifdef WIN32
#include <compat.h> // for Windows API
#include <compat/compat.h>
#endif
#include <algorithm>

2
src/test/fuzz/util.h
View file

@ -8,7 +8,7 @@
#include <arith_uint256.h>
#include <chainparamsbase.h>
#include <coins.h>
#include <compat.h>
#include <compat/compat.h>
#include <consensus/amount.h>
#include <consensus/consensus.h>
#include <merkleblock.h>

2
src/test/net_tests.cpp
View file

@ -4,7 +4,7 @@
#include <chainparams.h>
#include <clientversion.h>
#include <compat.h>
#include <compat/compat.h>
#include <cstdint>
#include <net.h>
#include <net_processing.h>

2
src/test/sock_tests.cpp
View file

@ -2,7 +2,7 @@
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <compat.h>
#include <compat/compat.h>
#include <test/util/setup_common.h>
#include <threadinterrupt.h>
#include <util/sock.h>

2
src/test/util/net.h
View file

@ -5,7 +5,7 @@
#ifndef BITCOIN_TEST_UTIL_NET_H
#define BITCOIN_TEST_UTIL_NET_H
#include <compat.h>
#include <compat/compat.h>
#include <node/eviction.h>
#include <netaddress.h>
#include <net.h>

2
src/torcontrol.cpp
View file

@ -7,7 +7,7 @@
#include <chainparams.h>
#include <chainparamsbase.h>
#include <compat.h>
#include <compat/compat.h>
#include <crypto/hmac_sha256.h>
#include <net.h>
#include <netaddress.h>

2
src/util/sock.cpp
View file

@ -2,7 +2,7 @@
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <compat.h>
#include <compat/compat.h>
#include <logging.h>
#include <threadinterrupt.h>
#include <tinyformat.h>

2
src/util/sock.h
View file

@ -5,7 +5,7 @@
#ifndef BITCOIN_UTIL_SOCK_H
#define BITCOIN_UTIL_SOCK_H
#include <compat.h>
#include <compat/compat.h>
#include <threadinterrupt.h>
#include <util/time.h>

2
src/util/system.h
View file

@ -14,7 +14,7 @@
#include <config/bitcoin-config.h>
#endif
#include <compat.h>
#include <compat/compat.h>
#include <compat/assumptions.h>
#include <fs.h>
#include <logging.h>

2
src/util/time.cpp
View file

@ -7,7 +7,7 @@
#include <config/bitcoin-config.h>
#endif
#include <compat.h>
#include <compat/compat.h>
#include <tinyformat.h>
#include <util/time.h>
#include <util/check.h>

2
src/util/time.h
View file

@ -6,7 +6,7 @@
#ifndef BITCOIN_UTIL_TIME_H
#define BITCOIN_UTIL_TIME_H
#include <compat.h>
#include <compat/compat.h>
#include <chrono>
#include <cstdint>

1
src/wallet/bdb.cpp
View file

@ -3,6 +3,7 @@
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <compat/compat.h>
#include <fs.h>
#include <wallet/bdb.h>
#include <wallet/db.h>