From patchwork Thu Oct 27 19:55:27 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pedro Alves X-Patchwork-Id: 59560 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 4BB3C385828B for ; Thu, 27 Oct 2022 19:57:18 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-wm1-f42.google.com (mail-wm1-f42.google.com [209.85.128.42]) by sourceware.org (Postfix) with ESMTPS id DD36B384B12C for ; Thu, 27 Oct 2022 19:55:30 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org DD36B384B12C Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=palves.net Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-wm1-f42.google.com with SMTP id t4so1697021wmj.5 for ; Thu, 27 Oct 2022 12:55:30 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:content-language:in-reply-to:mime-version :user-agent:date:message-id:from:references:to:subject :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=Z+0CaTQPZ9S24E3G24p2VbE5hj8+7yeWwD8a/zYYxWw=; b=dblZR+4QY3I7+/ogSioo/obKqn9mgRs8I1JpgZo/3Lq2kJhEZiDq8tHqenfD9CoJoH 2XnNue5/GATLdPBTA17M4vgI/Kp0BMchKRTxcFmAVGsyhB21uHCgQyATzjgGwVKja5ii J3CDiO4ahbV73zdYRkVogHe3lw8S44dLtnjQkDGWwuwXHRGjCZ6xD//MGPiVWyDt29kd OjnnpNuuooETRJrdt+4Ufd4LySdN8om6MoPpuNWJLtrqB8avOT6hSfgqupcjk7/qAm+d iA7oyNW4rWZQ1RTJ7V7U8VMxJW3sZ3NViEVWhBW6aAdPkui3J/gtZfGbIlMllH10VXyP ncFQ== X-Gm-Message-State: ACrzQf1MJSwvad2gkJ/k65AAuj5wTFQPMhg/4gsBo4QxQdF6wh5Qs3pE MKmh+Yp8MCJaNdwL9XOjUDndzgeSBgi3Cg== X-Google-Smtp-Source: AMsMyM4nt4tZZK2VxxsP67Xc21cioK1Utr+oxOQRYArdVCHb2P49keOh2dtVBGQLoPcSV9KZ5CFJ5g== X-Received: by 2002:a05:600c:314f:b0:3c7:87f:6c7d with SMTP id h15-20020a05600c314f00b003c7087f6c7dmr7191517wmo.149.1666900529407; Thu, 27 Oct 2022 12:55:29 -0700 (PDT) Received: from ?IPv6:2001:8a0:f93a:3b00:e038:5cdc:b8bf:4653? ([2001:8a0:f93a:3b00:e038:5cdc:b8bf:4653]) by smtp.gmail.com with ESMTPSA id q15-20020adff50f000000b002365b759b65sm1770983wro.86.2022.10.27.12.55.28 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 27 Oct 2022 12:55:28 -0700 (PDT) Subject: [PATCH] enum_flags to_string (was: Re: [PATCH v2 07/29] Thread options & clone events (core + remote)) To: Simon Marchi , gdb-patches@sourceware.org References: <20220713222433.374898-1-pedro@palves.net> <20220713222433.374898-8-pedro@palves.net> <5d68cd36-e8d6-e8ad-5428-863e79742062@simark.ca> From: Pedro Alves Message-ID: Date: Thu, 27 Oct 2022 20:55:27 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.10.1 MIME-Version: 1.0 In-Reply-To: <5d68cd36-e8d6-e8ad-5428-863e79742062@simark.ca> Content-Language: en-US X-Spam-Status: No, score=-10.0 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM, GIT_PATCH_0, HEADER_FROM_DIFFERENT_DOMAINS, KAM_DMARC_STATUS, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Hi, On 2022-07-21 4:14 a.m., Simon Marchi wrote: >> + ptid = ptid_t (ptid.pid ()); >> + >> + for_each_thread ([&] (thread_info *thread) >> + { >> + if (ptid_of (thread).matches (ptid)) >> + set_options[thread] = options; >> + }); >> + } >> + >> + for (const auto &iter : set_options) >> + { >> + thread_info *thread = iter.first; >> + gdb_thread_options options = iter.second; >> + >> + if (debug_threads && thread->thread_options != options) >> + { >> + debug_printf ("[options for %s are now 0x%x]\n", >> + target_pid_to_str (ptid_of (thread)).c_str (), >> + (unsigned) options); > > This should probably use threads_debug_printf. > > IWBN to have a small function that formats `options` as an "or" of the > enabled bits, it would make logs easier to read. For example if the two > options are enabled, it would show up as "GDB_TO_CLONE | GDB_TO_EXIT". > How about this? Since I think we'd want to print every enum_flags type using the same format, I wrote code that can be used by all enum_flags specializations to convert to string. Each specialization just needs to provide the enumerator->string mapping, since there's no reflection in C++ (yet). From 6ed71a904b84b95ced85e8dda496ce79a5f205b4 Mon Sep 17 00:00:00 2001 From: Pedro Alves Date: Tue, 25 Oct 2022 15:39:37 +0100 Subject: [PATCH] enum_flags to_string This commit introduces shared infrastructure that can be used to implement enum_flags -> to_string functions. With this, if we want to support converting a given enum_flags specialization to string, we just need to implement a function that provides the enumerator->string mapping, like so: enum some_flag { SOME_FLAG1 = 1 << 1, SOME_FLAG2 = 1 << 2, SOME_FLAG3 = 1 << 3, }; DEF_ENUM_FLAGS_TYPE (some_flag, some_flags); static std::string to_string (some_flags flags) { #define CASE(X) { X, #X } static constexpr test_flags::string_map_element mapping[] = { CASE (SOME_FLAG1), CASE (SOME_FLAG2), CASE (SOME_FLAG3), }; #undef CASE return flags.to_string (mapping); } .. and then to_string(SOME_FLAG1 | SOME_FLAG2) produces a string like "0x6 [SOME_FLAG1 SOME_FLAG2]". If we happen to forget to update the mapping array when we introduce a new enumerator, then the string representation will pretty-print the flags it knows about, and then the leftover flags in hex (one single number). For example, if we had missed mapping SOME_FLAG2 above, we'd end up with: to_string(SOME_FLAG1 | SOME_FLAG2) => "0x6 [SOME_FLAG1 0x4]"); Other than in the unit tests included, no actual usage of the functionality is added in this commit. Change-Id: I835de43c33d13bc0c95132f42c3f97318b875779 --- gdb/unittests/enum-flags-selftests.c | 27 ++++++++++++++ gdbsupport/enum-flags.h | 53 ++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+) base-commit: 508ccf9b3e1db355037a4a1c9004efe0d6d3ffbf diff --git a/gdb/unittests/enum-flags-selftests.c b/gdb/unittests/enum-flags-selftests.c index f52fc7220a1..3165b2d0730 100644 --- a/gdb/unittests/enum-flags-selftests.c +++ b/gdb/unittests/enum-flags-selftests.c @@ -374,6 +374,23 @@ enum test_uflag : unsigned DEF_ENUM_FLAGS_TYPE (test_flag, test_flags); DEF_ENUM_FLAGS_TYPE (test_uflag, test_uflags); +/* to_string enumerator->string mapping function used to test + enum_flags::to_string. This intentionally misses mapping one + enumerator (FLAG2). */ + +static std::string +to_string (test_flags flags) +{ +#define CASE(X) { X, #X } + static constexpr test_flags::string_map_element mapping[] = { + CASE (FLAG1), + CASE (FLAG3), + }; +#undef CASE + + return flags.to_string (mapping); +} + static void self_test () { @@ -581,6 +598,16 @@ self_test () SELF_CHECK (ok); } + + /* Check string conversion. */ + { + SELF_CHECK (to_string (0) == "0x0 []"); + SELF_CHECK (to_string (FLAG1) == "0x2 [FLAG1]"); + SELF_CHECK (to_string (FLAG1 | FLAG3) == "0xa [FLAG1 FLAG3]"); + SELF_CHECK (to_string (FLAG1 | FLAG2 | FLAG3) == "0xe [FLAG1 FLAG3 0x4]"); + SELF_CHECK (to_string (FLAG2) == "0x4 [0x4]"); + SELF_CHECK (to_string (test_flag (0xff)) == "0xff [FLAG1 FLAG3 0xf5]"); + } } } /* namespace enum_flags_tests */ diff --git a/gdbsupport/enum-flags.h b/gdbsupport/enum-flags.h index cd500f55ff3..01e8c6e54ce 100644 --- a/gdbsupport/enum-flags.h +++ b/gdbsupport/enum-flags.h @@ -130,6 +130,13 @@ class enum_flags typedef E enum_type; typedef typename enum_underlying_type::type underlying_type; + /* For to_string. Maps one enumerator of E to a string. */ + struct string_map_element + { + E flag; + const char *str; + }; + public: /* Allow default construction. */ constexpr enum_flags () @@ -183,6 +190,52 @@ class enum_flags /* Binary operations involving some unrelated type (which would be a bug) are implemented as non-members, and deleted. */ + /* Convert this object to a std::string, using MAPPING as + enumerator-to-string mapping array. This is not meant to be + called directly. Instead, enum_flags specializations that have + their own to_string function wrapping this one, thus hidding the + mapping array from callers. */ + + template + std::string + to_string (const string_map_element (&mapping)[N]) const + { + enum_type flags = raw (); + std::string res = hex_string (flags); + res += " ["; + + bool need_space = false; + for (const auto &entry : mapping) + { + if ((flags & entry.flag) != 0) + { + /* Do op~ in the underlying type, because if enum_type's + underlying type is signed, op~ won't be defined for + it. */ + flags &= (enum_type) ~(underlying_type) entry.flag; + + if (need_space) + res += " "; + res += entry.str; + + need_space = true; + } + } + + /* If there were flags not included in the mapping, print them as + an hex number. */ + if (flags != 0) + { + if (need_space) + res += " "; + res += hex_string (flags); + } + + res += "]"; + + return res; + } + private: /* Stored as enum_type because GDB knows to print the bit flags neatly if the enum values look like bit flags. */