153 lines
4.1 KiB
C++
153 lines
4.1 KiB
C++
// This file Copyright © 2017-2022 Mnemosyne LLC.
|
|
// It may be used under GPLv2 (SPDX: GPL-2.0), GPLv3 (SPDX: GPL-3.0),
|
|
// or any future license endorsed by Mnemosyne LLC.
|
|
// License text can be found in the licenses/ folder.
|
|
|
|
#pragma once
|
|
|
|
#include <array>
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
|
|
/***
|
|
****
|
|
***/
|
|
|
|
#ifndef __has_feature
|
|
#define __has_feature(x) 0
|
|
#endif
|
|
|
|
#ifndef __has_extension
|
|
#define __has_extension __has_feature
|
|
#endif
|
|
|
|
#ifndef __has_attribute
|
|
#define __has_attribute(x) 0
|
|
#endif
|
|
|
|
#ifndef __has_builtin
|
|
#define __has_builtin(x) 0
|
|
#endif
|
|
|
|
#ifdef _WIN32
|
|
#define TR_IF_WIN32(ThenValue, ElseValue) ThenValue
|
|
#else
|
|
#define TR_IF_WIN32(ThenValue, ElseValue) ElseValue
|
|
#endif
|
|
|
|
#ifdef __GNUC__
|
|
#define TR_GNUC_CHECK_VERSION(major, minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
|
|
#else
|
|
#define TR_GNUC_CHECK_VERSION(major, minor) 0
|
|
#endif
|
|
|
|
#ifdef __UCLIBC__
|
|
#define TR_UCLIBC_CHECK_VERSION(major, minor, micro) \
|
|
(__UCLIBC_MAJOR__ > (major) || (__UCLIBC_MAJOR__ == (major) && __UCLIBC_MINOR__ > (minor)) || \
|
|
(__UCLIBC_MAJOR__ == (major) && __UCLIBC_MINOR__ == (minor) && __UCLIBC_SUBLEVEL__ >= (micro)))
|
|
#else
|
|
#define TR_UCLIBC_CHECK_VERSION(major, minor, micro) 0
|
|
#endif
|
|
|
|
/***
|
|
****
|
|
***/
|
|
|
|
#if __has_builtin(__builtin_expect) || TR_GNUC_CHECK_VERSION(3, 0)
|
|
#define TR_LIKELY(x) __builtin_expect(!!(x), 1)
|
|
#define TR_UNLIKELY(x) __builtin_expect(!!(x), 0)
|
|
#else
|
|
#define TR_LIKELY(x) (x)
|
|
#define TR_UNLIKELY(x) (x)
|
|
#endif
|
|
|
|
#define TR_DISABLE_COPY(Class) \
|
|
Class(Class const&) = delete; \
|
|
Class& operator=(Class const&) = delete;
|
|
|
|
#define TR_DISABLE_MOVE(Class) \
|
|
Class(Class&&) = delete; \
|
|
Class& operator=(Class&&) = delete;
|
|
|
|
#define TR_DISABLE_COPY_MOVE(Class) \
|
|
TR_DISABLE_COPY(Class) \
|
|
TR_DISABLE_MOVE(Class)
|
|
|
|
/***
|
|
****
|
|
***/
|
|
|
|
#if __has_attribute(__deprecated__) || TR_GNUC_CHECK_VERSION(3, 1)
|
|
#define TR_DEPRECATED __attribute__((__deprecated__))
|
|
#elif defined(_MSC_VER)
|
|
#define TR_DEPRECATED __declspec(deprecated)
|
|
#else
|
|
#define TR_DEPRECATED
|
|
#endif
|
|
|
|
#if __has_attribute(__format__) || TR_GNUC_CHECK_VERSION(2, 3)
|
|
#define TR_GNUC_PRINTF(fmt, args) __attribute__((__format__(printf, fmt, args)))
|
|
#else
|
|
#define TR_GNUC_PRINTF(fmt, args)
|
|
#endif
|
|
|
|
#if __has_attribute(__nonnull__) || TR_GNUC_CHECK_VERSION(3, 3)
|
|
#define TR_GNUC_NONNULL(...) __attribute__((__nonnull__(__VA_ARGS__)))
|
|
#else
|
|
#define TR_GNUC_NONNULL(...)
|
|
#endif
|
|
|
|
#if __has_attribute(__sentinel__) || TR_GNUC_CHECK_VERSION(4, 3)
|
|
#define TR_GNUC_NULL_TERMINATED __attribute__((__sentinel__))
|
|
#else
|
|
#define TR_GNUC_NULL_TERMINATED
|
|
#endif
|
|
|
|
#if __has_attribute(__hot__) || TR_GNUC_CHECK_VERSION(4, 3)
|
|
#define TR_GNUC_HOT __attribute__((__hot__))
|
|
#else
|
|
#define TR_GNUC_HOT
|
|
#endif
|
|
|
|
#if __has_attribute(__malloc__) || TR_GNUC_CHECK_VERSION(2, 96)
|
|
#define TR_GNUC_MALLOC __attribute__((__malloc__))
|
|
#else
|
|
#define TR_GNUC_MALLOC
|
|
#endif
|
|
|
|
/***
|
|
****
|
|
***/
|
|
|
|
#define TR_PATH_DELIMITER '/'
|
|
#define TR_PATH_DELIMITER_STR "/"
|
|
|
|
/* Only use this macro to suppress false-positive alignment warnings */
|
|
#define TR_DISCARD_ALIGN(ptr, type) ((type)(void*)(ptr))
|
|
|
|
#define TR_INET6_ADDRSTRLEN 46
|
|
|
|
#define TR_ADDRSTRLEN 64
|
|
|
|
// Mostly to enforce better formatting
|
|
#define TR_ARG_TUPLE(...) __VA_ARGS__
|
|
|
|
#define TR_PRIsv "*.*s"
|
|
#define TR_PRIsv_ARG(sv) TR_ARG_TUPLE(int(std::size(sv)), int(std::size(sv)), std::data(sv))
|
|
|
|
// https://www.bittorrent.org/beps/bep_0003.html
|
|
// A string of length 20 which this downloader uses as its id. Each
|
|
// downloader generates its own id at random at the start of a new
|
|
// download. This value will also almost certainly have to be escaped.
|
|
auto inline constexpr PEER_ID_LEN = size_t{ 20 };
|
|
using tr_peer_id_t = std::array<char, PEER_ID_LEN>;
|
|
|
|
#define SHA_DIGEST_LENGTH 20
|
|
|
|
// TODO #1: all arrays of SHA_DIGEST_LENGTH should be replaced with tr_sha1_digest_t
|
|
// TODO #2: tr_peer_id_t, tr_sha1_digest_t should be moved into a new 'types.h' header
|
|
auto inline constexpr TR_SHA1_DIGEST_LEN = size_t{ 20 };
|
|
auto inline constexpr TR_SHA1_DIGEST_STRLEN = size_t{ 40 };
|
|
using tr_sha1_digest_t = std::array<std::byte, TR_SHA1_DIGEST_LEN>;
|
|
using tr_sha1_digest_string_t = std::array<char, TR_SHA1_DIGEST_STRLEN + 1>; // +1 for '\0'
|