From fbacad1880341ace31f669530c66d4e322d19235 Mon Sep 17 00:00:00 2001 From: Vasil Dimov Date: Fri, 29 May 2020 18:49:26 +0200 Subject: util: simplify the interface of serviceFlagToStr() Don't take two redundant arguments in `serviceFlagToStr()`. As a side effect this fixes an issue introduced in https://github.com/bitcoin/bitcoin/pull/18165 due to which the GUI could print something like `UNKNOWN[1033] & UNKNOWN[1033] & UNKNOWN[2^10]` instead of `NETWORK & WITNESS`. --- src/protocol.cpp | 7 ++++--- src/protocol.h | 7 ++++++- src/qt/guiutil.cpp | 2 +- src/rpc/util.cpp | 2 +- 4 files changed, 12 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/protocol.cpp b/src/protocol.cpp index 737baff36b..56071f4748 100644 --- a/src/protocol.cpp +++ b/src/protocol.cpp @@ -195,9 +195,10 @@ const std::vector &getAllNetMessageTypes() return allNetMessageTypesVec; } -std::string serviceFlagToStr(const uint64_t mask, const int bit) +std::string serviceFlagToStr(size_t bit) { - switch (ServiceFlags(mask)) { + const uint64_t service_flag = 1ULL << bit; + switch ((ServiceFlags)service_flag) { case NODE_NONE: abort(); // impossible case NODE_NETWORK: return "NETWORK"; case NODE_GETUTXO: return "GETUTXO"; @@ -211,7 +212,7 @@ std::string serviceFlagToStr(const uint64_t mask, const int bit) stream.imbue(std::locale::classic()); stream << "UNKNOWN["; if (bit < 8) { - stream << mask; + stream << service_flag; } else { stream << "2^" << bit; } diff --git a/src/protocol.h b/src/protocol.h index c12bec9bf3..4fb4594fbb 100644 --- a/src/protocol.h +++ b/src/protocol.h @@ -288,7 +288,12 @@ enum ServiceFlags : uint64_t { // BIP process. }; -std::string serviceFlagToStr(uint64_t mask, int bit); +/** + * Convert a service flag (NODE_*) to a human readable string. + * It supports unknown service flags which will be returned as "UNKNOWN[...]". + * @param[in] bit the service flag is calculated as (1 << bit) + */ +std::string serviceFlagToStr(size_t bit); /** * Gets the set of service flags which are "desirable" for a given peer. diff --git a/src/qt/guiutil.cpp b/src/qt/guiutil.cpp index e78e400f07..d2892f32c7 100644 --- a/src/qt/guiutil.cpp +++ b/src/qt/guiutil.cpp @@ -759,7 +759,7 @@ QString formatServicesStr(quint64 mask) uint64_t check = 1ull << i; if (mask & check) { - strList.append(QString::fromStdString(serviceFlagToStr(mask, i))); + strList.append(QString::fromStdString(serviceFlagToStr(i))); } } diff --git a/src/rpc/util.cpp b/src/rpc/util.cpp index 0e13d8dfce..6cd4c2664d 100644 --- a/src/rpc/util.cpp +++ b/src/rpc/util.cpp @@ -847,7 +847,7 @@ UniValue GetServicesNames(ServiceFlags services) for (int i = 0; i < 64; ++i) { const uint64_t mask = 1ull << i; if (services_n & mask) { - servicesNames.push_back(serviceFlagToStr(mask, i)); + servicesNames.push_back(serviceFlagToStr(i)); } } -- cgit v1.2.3 From 189ae0c38b7d4927c5c73b94664e9542b2b06ed9 Mon Sep 17 00:00:00 2001 From: Vasil Dimov Date: Fri, 29 May 2020 18:52:59 +0200 Subject: util: dedup code in callers of serviceFlagToStr() Introduce `serviceFlagsToStr()` which hides the internals of the bitmask and simplifies callers of `serviceFlagToStr()`. --- src/protocol.cpp | 20 +++++++++++++++++++- src/protocol.h | 6 +++--- src/qt/guiutil.cpp | 8 ++------ src/rpc/util.cpp | 8 ++------ 4 files changed, 26 insertions(+), 16 deletions(-) (limited to 'src') diff --git a/src/protocol.cpp b/src/protocol.cpp index 56071f4748..93e76f1f13 100644 --- a/src/protocol.cpp +++ b/src/protocol.cpp @@ -195,7 +195,12 @@ const std::vector &getAllNetMessageTypes() return allNetMessageTypesVec; } -std::string serviceFlagToStr(size_t bit) +/** + * Convert a service flag (NODE_*) to a human readable string. + * It supports unknown service flags which will be returned as "UNKNOWN[...]". + * @param[in] bit the service flag is calculated as (1 << bit) + */ +static std::string serviceFlagToStr(size_t bit) { const uint64_t service_flag = 1ULL << bit; switch ((ServiceFlags)service_flag) { @@ -219,3 +224,16 @@ std::string serviceFlagToStr(size_t bit) stream << "]"; return stream.str(); } + +std::vector serviceFlagsToStr(uint64_t flags) +{ + std::vector str_flags; + + for (size_t i = 0; i < sizeof(flags) * 8; ++i) { + if (flags & (1ULL << i)) { + str_flags.emplace_back(serviceFlagToStr(i)); + } + } + + return str_flags; +} diff --git a/src/protocol.h b/src/protocol.h index 4fb4594fbb..b720a6ce91 100644 --- a/src/protocol.h +++ b/src/protocol.h @@ -289,11 +289,11 @@ enum ServiceFlags : uint64_t { }; /** - * Convert a service flag (NODE_*) to a human readable string. + * Convert service flags (a bitmask of NODE_*) to human readable strings. * It supports unknown service flags which will be returned as "UNKNOWN[...]". - * @param[in] bit the service flag is calculated as (1 << bit) + * @param[in] flags multiple NODE_* bitwise-OR-ed together */ -std::string serviceFlagToStr(size_t bit); +std::vector serviceFlagsToStr(uint64_t flags); /** * Gets the set of service flags which are "desirable" for a given peer. diff --git a/src/qt/guiutil.cpp b/src/qt/guiutil.cpp index d2892f32c7..ce44d4f3a5 100644 --- a/src/qt/guiutil.cpp +++ b/src/qt/guiutil.cpp @@ -755,12 +755,8 @@ QString formatServicesStr(quint64 mask) { QStringList strList; - for (int i = 0; i < 64; i++) { - uint64_t check = 1ull << i; - if (mask & check) - { - strList.append(QString::fromStdString(serviceFlagToStr(i))); - } + for (const auto& flag : serviceFlagsToStr(mask)) { + strList.append(QString::fromStdString(flag)); } if (strList.size()) diff --git a/src/rpc/util.cpp b/src/rpc/util.cpp index 6cd4c2664d..39bf05fbbd 100644 --- a/src/rpc/util.cpp +++ b/src/rpc/util.cpp @@ -841,14 +841,10 @@ std::vector EvalDescriptorStringOrObject(const UniValue& scanobject, Fl UniValue GetServicesNames(ServiceFlags services) { - const uint64_t services_n = services; UniValue servicesNames(UniValue::VARR); - for (int i = 0; i < 64; ++i) { - const uint64_t mask = 1ull << i; - if (services_n & mask) { - servicesNames.push_back(serviceFlagToStr(i)); - } + for (const auto& flag : serviceFlagsToStr(services)) { + servicesNames.push_back(flag); } return servicesNames; -- cgit v1.2.3