From patchwork Sat Oct 29 13:53:18 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Maciej W. Rozycki" X-Patchwork-Id: 59619 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 3277538582A2 for ; Sat, 29 Oct 2022 13:53:37 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-wr1-x42f.google.com (mail-wr1-x42f.google.com [IPv6:2a00:1450:4864:20::42f]) by sourceware.org (Postfix) with ESMTPS id 1931638582A8 for ; Sat, 29 Oct 2022 13:53:21 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 1931638582A8 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=embecosm.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=embecosm.com Received: by mail-wr1-x42f.google.com with SMTP id bk15so9902374wrb.13 for ; Sat, 29 Oct 2022 06:53:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=embecosm.com; s=google; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=kqW2hQ2bbjChPYywa5668+lWEn0za7ub9UDHBLoY3uE=; b=ctfTEhikfJMw6+7OmE2xF+27L4dHjkbmPrjkLAcNBZ5EiJl41wRyM5xXkwMrys7YnP NviJRcPhfJinqNSY2xyWrlh9j/nLtfPjtKIDvDrVU0nf0OVslDEnyAn3XaW9r2s6lQh/ TGK+82Ptxh8NVtQ5hAZbjy5jg2bt3h9rbLjksuXSZ2SnDhvLP6y5pke8k1IUCYNYcNuW f3RrKXXITnjIZ+s5GLaYt/KQpE2jlHTVl5I/aFgMCDPeP8UlJ4a02cZic2+V4zAsmiGx ctQ7ksJN0IiTiljCBLu+UBs342q2cG4+8gPlk+MxxRx125Yw6GMC+00B5sATnGitvdIX S2lw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=kqW2hQ2bbjChPYywa5668+lWEn0za7ub9UDHBLoY3uE=; b=U7uh5nK9rTRx2Xe937vDFWlxN1mGFgfC7U3fDACJrCnwlcLsRWLkrtvu9acPrEj06j vAg4QdbJs9I+rGV60sHA6ru1PCquIWo07qM+tdCUT6+XPMyabU0+yR49W1KymU8x4KEr PwKEgC7QVhd+a9FESXjWpNpNy8M8YpBmu3/782GQ/zFNSvuy4YObl7C+XwrYSQNFdP95 5ij9SpVWMoCHyob/HdbKFyvyu9Oo/fXfHiqF9Kbw6SxWNE5kwI/j52MFMVXuNYt+yXKz GLj2YAReI/69iUEzFTb1P4JLDOcBQwJmAG0zYHTkRcd/ytouhiihRAAFo8feaJVMDfdX zayw== X-Gm-Message-State: ACrzQf3LCkTUPxkJUhPR9XpXoYoPlg0v3xTADY4Khz0Nh1G6M4raEOqp k+Ql0IBv35gin20dETZbJCWkEXSBvcb550rV X-Google-Smtp-Source: AMsMyM6AwLH2we/yc52emy0rfs2HaeaF7Ez4C6G0vAiGbIwwCkr/FO+2kfG4IdbnG/wibk7QO7EVCw== X-Received: by 2002:adf:e804:0:b0:236:657e:756e with SMTP id o4-20020adfe804000000b00236657e756emr2477099wrm.452.1667051599892; Sat, 29 Oct 2022 06:53:19 -0700 (PDT) Received: from tpp.orcam.me.uk (tpp.orcam.me.uk. [2001:8b0:154:0:ea6a:64ff:fe24:f2fc]) by smtp.gmail.com with ESMTPSA id p1-20020a05600c358100b003c6237e867esm2053030wmq.0.2022.10.29.06.53.18 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Sat, 29 Oct 2022 06:53:19 -0700 (PDT) Date: Sat, 29 Oct 2022 14:53:18 +0100 (BST) From: "Maciej W. Rozycki" To: gdb-patches@sourceware.org Subject: [PATCH v7 1/4] GDB/Python: Use None for `var_zuinteger_unlimited' value set to `unlimited' In-Reply-To: Message-ID: References: User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 X-Spam-Status: No, score=-2.2 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, KAM_ASCII_DIVIDERS, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=no 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: , Cc: Simon Sobisch , Tom Tromey Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Consistently with parameters of the PARAM_UINTEGER and PARAM_INTEGER types, return the special value of `None' for a PARAM_ZUINTEGER_UNLIMITED parameter set to `unlimited', fixing an inconsistency introduced with commit 0489430a0e1a ("Handle var_zuinteger and var_zuinteger_unlimited from Python"); cf. PR python/20084. Adjust the testsuite accordingly. This makes all the three parameter types consistent with each other as far as the use of `None' is concerned, and similar to the Guile/Scheme interface where the `#:unlimited' keyword is likewise used. We have a precedent already documented for a similar API correction: -- Function: gdb.breakpoints () Return a sequence holding all of GDB's breakpoints. *Note Breakpoints In Python::, for more information. In GDB version 7.11 and earlier, this function returned 'None' if there were no breakpoints. This peculiarity was subsequently fixed, and now 'gdb.breakpoints' returns an empty sequence in this case. made in the past. And then we have documentation not matching the interface as far as the value of `None' already returned for parameters of the PARAM_UINTEGER and PARAM_INTEGER types is concerned, and the case of an incorrect assertion for PARAM_UINTEGER and PARAM_ZUINTEGER_UNLIMITED parameters in the sibling Guile/Scheme module making such parameters unusable that has never been reported, both indicating that these features may indeed not be heavily used, and therefore that the risk from such an API change is likely lower than the long-term burden of the inconsistency. And where the value read from a parameter is only used for presentation purposes, then such a change is expected to be transparent. --- Changes from v6: - Add a comma in the first sentence of the change description. Changes from v5: - Refer to Python parameter types in the change description rather than underlying GDB variable types in preparation for breaking the tight coupling between the two later in this series. - Document existing and updated semantics in the GDB manual. - Update the testsuite adjustment to fit in the now expanded test case. - Add a NEWS entry. No change from v4. New change in v4. --- gdb/NEWS | 7 +++++++ gdb/doc/python.texi | 30 +++++++++++++++++++----------- gdb/python/python.c | 10 +++++++++- gdb/testsuite/gdb.python/py-parameter.exp | 16 +++++----------- 4 files changed, 40 insertions(+), 23 deletions(-) gdb-python-var-zuinteger-unlimited-none.diff Index: src/gdb/NEWS =================================================================== --- src.orig/gdb/NEWS +++ src/gdb/NEWS @@ -216,6 +216,13 @@ GNU/Linux/CSKY (gdbserver) csky*-*linux* must start with a character in the set [a-zA-Z], every subsequent character of a window's name must be in the set [-_.a-zA-Z0-9]. + ** Parameters of gdb.PARAM_ZUINTEGER_UNLIMITED type now return the + value of None for the 'unlimited' setting, consistently with + parameters of gdb.PARAM_UINTEGER and gdb.PARAM_INTEGER types. + Parameters of all the three types now accept the value of None + to mean 'unlimited'. The use of internal integer representation + for the 'unlimited' setting is now deprecated. + * New features in the GDB remote stub, GDBserver ** GDBserver is now supported on LoongArch GNU/Linux. Index: src/gdb/doc/python.texi =================================================================== --- src.orig/gdb/doc/python.texi +++ src/gdb/doc/python.texi @@ -4598,14 +4598,16 @@ Python, true and false are represented u @findex PARAM_UINTEGER @findex gdb.PARAM_UINTEGER @item gdb.PARAM_UINTEGER -The value is an unsigned integer. The value of 0 should be -interpreted to mean ``unlimited''. +The value is an unsigned integer. The value of @code{None} should be +interpreted to mean ``unlimited'', and the value of 0 is reserved and +should not be used. @findex PARAM_INTEGER @findex gdb.PARAM_INTEGER @item gdb.PARAM_INTEGER -The value is a signed integer. The value of 0 should be interpreted -to mean ``unlimited''. +The value is a signed integer. The value of @code{None} should be +interpreted to mean ``unlimited'', and the value of 0 is reserved and +should not be used. @findex PARAM_STRING @findex gdb.PARAM_STRING @@ -4635,21 +4637,27 @@ The value is a filename. This is just l @findex PARAM_ZINTEGER @findex gdb.PARAM_ZINTEGER @item gdb.PARAM_ZINTEGER -The value is an integer. This is like @code{PARAM_INTEGER}, except 0 -is interpreted as itself. +The value is a signed integer. This is like @code{PARAM_INTEGER}, +except that 0 is allowed and the value of @code{None} is not supported. @findex PARAM_ZUINTEGER @findex gdb.PARAM_ZUINTEGER @item gdb.PARAM_ZUINTEGER -The value is an unsigned integer. This is like @code{PARAM_INTEGER}, -except 0 is interpreted as itself, and the value cannot be negative. +The value is an unsigned integer. This is like @code{PARAM_UINTEGER}, +except that 0 is allowed and the value of @code{None} is not supported. @findex PARAM_ZUINTEGER_UNLIMITED @findex gdb.PARAM_ZUINTEGER_UNLIMITED @item gdb.PARAM_ZUINTEGER_UNLIMITED -The value is a signed integer. This is like @code{PARAM_ZUINTEGER}, -except the special value -1 should be interpreted to mean -``unlimited''. Other negative values are not allowed. +The value is a signed integer. This is like @code{PARAM_INTEGER} +including that the value of @code{None} should be interpreted to mean +``unlimited'', except that 0 is allowed, and the value cannot be negative. + +In GDB version 12 and earlier, a parameter of this type when read would +return -1 rather than @code{None} for the setting of ``unlimited''. +This peculiarity was subsequently fixed, for consistency with parameters +of @code{PARAM_UINTEGER} and @code{PARAM_INTEGER} types, so that all the +three types return the value of @code{None} for ``unlimited''. @findex PARAM_ENUM @findex gdb.PARAM_ENUM Index: src/gdb/python/python.c =================================================================== --- src.orig/gdb/python/python.c +++ src/gdb/python/python.c @@ -509,9 +509,17 @@ gdbpy_parameter_value (const setting &va Py_RETURN_NONE; /* Fall through. */ case var_zinteger: - case var_zuinteger_unlimited: return gdb_py_object_from_longest (var.get ()).release (); + case var_zuinteger_unlimited: + { + int val = var.get (); + + if (val == -1) + Py_RETURN_NONE; + return gdb_py_object_from_longest (val).release (); + } + case var_uinteger: { unsigned int val = var.get (); Index: src/gdb/testsuite/gdb.python/py-parameter.exp =================================================================== --- src.orig/gdb/testsuite/gdb.python/py-parameter.exp +++ src/gdb/testsuite/gdb.python/py-parameter.exp @@ -346,22 +346,16 @@ proc_with_prefix test_gdb_parameter { } "listsize" { set param_get_zero None set param_get_minus_one -1 - set param_get_none None - set param_get_unlimited None set param_set_minus_one "" } "print elements" { set param_get_zero None set param_get_minus_one None - set param_get_none None - set param_get_unlimited None set param_set_minus_one $param_range_error } "max-completions" { set param_get_zero 0 - set param_get_minus_one -1 - set param_get_none -1 - set param_get_unlimited -1 + set param_get_minus_one None set param_set_minus_one "" } default { @@ -392,13 +386,13 @@ proc_with_prefix test_gdb_parameter { } "test set to None" gdb_test "python print(gdb.parameter('$param'))" \ - $param_get_none "test value of None" + None "test value of None" gdb_test_no_output "python gdb.set_parameter('$param', 'unlimited')" \ "test set to 'unlimited'" gdb_test "python print(gdb.parameter('$param'))" \ - $param_get_unlimited "test value of 'unlimited'" + None "test value of 'unlimited'" } clean_restart @@ -468,9 +462,9 @@ proc_with_prefix test_integer_parameter } PARAM_ZUINTEGER_UNLIMITED { set param_get_zero 0 - set param_get_minus_one -1 + set param_get_minus_one None set param_get_minus_five 1 - set param_get_none -1 + set param_get_none None set param_set_minus_one "" set param_set_minus_five $param_range_error set param_set_none "" From patchwork Sat Oct 29 13:53:29 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Maciej W. Rozycki" X-Patchwork-Id: 59620 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 0808238582BF for ; Sat, 29 Oct 2022 13:54:00 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-wm1-x32e.google.com (mail-wm1-x32e.google.com [IPv6:2a00:1450:4864:20::32e]) by sourceware.org (Postfix) with ESMTPS id 51FE6385841F for ; Sat, 29 Oct 2022 13:53:34 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 51FE6385841F Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=embecosm.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=embecosm.com Received: by mail-wm1-x32e.google.com with SMTP id l16-20020a05600c4f1000b003c6c0d2a445so5460166wmq.4 for ; Sat, 29 Oct 2022 06:53:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=embecosm.com; s=google; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=JPN6h5WyvoT9F/nq8gaPByW8b7oAx8pDV9hx21c7aMQ=; b=CA0I9Tn/YUBq6OMyEWjMbq/nTRswCodjrYjGFxbOPOWEfjtyEtuQSIyV/GUhcf8324 Vc+4ld2FjsB+Y8f43Z72S4j5u7Z1ZcspiHsueyWa/NQ6nuYPEeoKgEUuvH2B5cFe9zuF cXNnFmVGH7KHUGs9ZYQY8YDPI/yN9Kg7sFIS1jHYnR/9XYrZ4guLxlpz2HogCUbXiJBx 5w22drW0FiWBlTNcoBrM+Xb/rI8J5R+Vkdq6GXdCjKtf1vgolQrLvaU+5sIQKRSCw/Sx AR5UIt2vUmo+c5K/dmX5d4wW2m8Qa3xaDtiRpEVaQp3uXk1zy3ckb3H46qjFQtHHHdk3 3UFw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=JPN6h5WyvoT9F/nq8gaPByW8b7oAx8pDV9hx21c7aMQ=; b=G/+Kfzj61CGvkuZgNdRPgDeMDkDINz/I5KLNx6ZikafEanlDvOpw9Kbof5VttdA250 tazHTKAbU0Ms38C7/L80l0hrEuumo1WvRRbUKjR2qD+CgnUEi56nifs36O10siq6Qq5J EWsokcsgD6YAEp1BkrK2Xk+wk30FZFbI1QqRkD8e/jixO7d6KAt4jHS8HRvMIh8TLnrx jl1J18wTAIZpE8ysVyVZjVw3v2MxQqG94NAvzdi58T+Y6hRORnqK/VYLKlGi3R0X7wsA SaZZCEhVMG4WbeL9kNwGE05E2lAcydF+5SlZhMRy6Mf3L+fHksPphp6cSnYOkrxnU+2r IOWw== X-Gm-Message-State: ACrzQf3Wee57Px5XHOBE0WHkBq8Dnt2bnRo1ncoPWIkFmjhhsKgBq+bh UYuMcDRlc1q4SIcVbxBv6YlhCQyDdHAVYh97 X-Google-Smtp-Source: AMsMyM4UFAmzkRD/grrgkxasV+uIE16UD6vM0qwCEdtP4TyLGZlural90LcvXFE/hr9SRmCAsOUlxg== X-Received: by 2002:a05:600c:3b88:b0:3c6:cef8:8465 with SMTP id n8-20020a05600c3b8800b003c6cef88465mr12529925wms.64.1667051612342; Sat, 29 Oct 2022 06:53:32 -0700 (PDT) Received: from tpp.orcam.me.uk (tpp.orcam.me.uk. [2001:8b0:154:0:ea6a:64ff:fe24:f2fc]) by smtp.gmail.com with ESMTPSA id i10-20020adffdca000000b00236674840e9sm1577448wrs.59.2022.10.29.06.53.30 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Sat, 29 Oct 2022 06:53:31 -0700 (PDT) Date: Sat, 29 Oct 2022 14:53:29 +0100 (BST) From: "Maciej W. Rozycki" To: gdb-patches@sourceware.org Subject: [PATCH v7 2/4] GDB: Allow arbitrary keywords in integer set commands In-Reply-To: Message-ID: References: User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 X-Spam-Status: No, score=-2.2 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, KAM_ASCII_DIVIDERS, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=no 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: , Cc: Simon Sobisch , Tom Tromey Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Rather than just `unlimited' allow the integer set commands (or command options) to define arbitrary keywords for the user to use, removing hardcoded arrangements for the `unlimited' keyword. Remove the confusingly named `var_zinteger', `var_zuinteger' and `var_zuinteger_unlimited' `set'/`show' command variable types redefining them in terms of `var_uinteger', `var_integer' and `var_pinteger', which have the range of [0;UINT_MAX], [INT_MIN;INT_MAX], and [0;INT_MAX] each. Following existing practice `var_pinteger' allows extra negative values to be used, however unlike `var_zuinteger_unlimited' any number of such values can be defined rather than just `-1'. The "p" in `var_pinteger' stands for "positive", for the lack of a more appropriate unambiguous letter, even though 0 obviously is not positive; "n" would be confusing as to whether it stands for "non-negative" or "negative". Add a new structure, `literal_def', the entries of which define extra keywords allowed for a command and numerical values they correspond to. Those values are not verified against the basic range supported by the underlying variable type, allowing extra values to be allowed outside that range, which may or may not be individually made visible to the user. An optional value translation is possible with the structure to follow the existing practice for some commands where user-entered 0 is internally translated to UINT_MAX or INT_MAX. Such translation can now be arbitrary. Literals defined by this structure are automatically used for completion as necessary. So for example: const literal_def integer_unlimited_literals[] = { { "unlimited", INT_MAX, 0 }, { nullptr } }; defines an extra `unlimited' keyword and a user-visible 0 value, both of which get translated to INT_MAX for the setting to be used with. Similarly: const literal_def zuinteger_unlimited_literals[] = { { "unlimited", -1, -1 }, { nullptr } }; defines the same keyword and a corresponding user-visible -1 value that is used for the requested setting. If the last member were omitted (or set to `{}') here, then only the keyword would be allowed for the user to enter and while -1 would still be used internally trying to enter it as a part of a command would result in an "integer -1 out of range" error. Use said error message in all cases (citing the invalid value requested) replacing "only -1 is allowed to set as unlimited" previously used for `var_zuinteger_unlimited' settings only rather than propagating it to `var_pinteger' type. It could only be used for the specific case where a single extra `unlimited' keyword was defined standing for -1 and the use of numeric equivalents is discouraged anyway as it is for historical reasons only that they expose GDB internals, confusingly different across variable types. Similarly update the "must be >= -1" Guile error message. Redefine Guile and Python parameter types in terms of the new variable types and interpret extra keywords as Scheme keywords and Python strings used to communicate corresponding parameter values. Do not add a new PARAM_INTEGER Guile parameter type, however do handle the `var_integer' variable type now, permitting existing parameters defined by GDB proper, such as `listsize', to be accessed from Scheme code. With these changes in place it should be trivial for a Scheme or Python programmer to expand the syntax of the `make-parameter' command and the `gdb.Parameter' class initializer to have arbitrary extra literals along with their internal representation supplied. Update the testsuite accordingly. --- No change from v6. Changes from v5: - Add a translation layer from Guile and Python parameter types to new GDB variable types and remove `var_zuinteger', `var_uinteger', and `var_zuinteger_unlimited' variable types altogether now. - Add an optional `extra_literals' initialiser to the `setting' class constructor. - Remove the "only -1 is allowed to set as unlimited" error message altogether now rather than propagating it to `var_pinteger' type. - Make the `val' member of `struct literal_def' optional and remove the `allow' member; simplify processing accordingly. - Rename `zuinteger_unlimited_literals' to `pinteger_unlimited_literals', making the names of all `*_unlimited_literals' arrays consistent with the corresponding `var_*' variable types. - Rename `struct integer_option_def' to `struct pinteger_option_def', observing it's come from `struct zuinteger_unlimited_option_def' and what used to be the `var_zuinteger_unlimited' now has `var_pinteger' semantics. - Update the names of test flags used by `maint test-options' accordingly. - Add constructor variants to `struct uinteger_option_def' and `struct pinteger_option_def' that allow one to skip the `extra_literals' initialiser altogether rather than having to pass in `nullptr'. - Update Python documentation mentioning the use of literal `unlimited' with the respective parameter types. No change from v4. New change in v4. --- gdb/cli/cli-cmds.c | 59 +++-- gdb/cli/cli-decode.c | 302 +++++++++++++++++++++++----- gdb/cli/cli-option.c | 117 +++++++---- gdb/cli/cli-option.h | 54 +++-- gdb/cli/cli-setshow.c | 245 ++++++++++------------- gdb/cli/cli-setshow.h | 20 - gdb/command.h | 104 +++++++-- gdb/doc/python.texi | 13 - gdb/guile/scm-param.c | 319 +++++++++++++++++++----------- gdb/maint-test-options.c | 44 ++-- gdb/python/py-param.c | 286 ++++++++++++++++---------- gdb/python/python.c | 52 ++-- gdb/testsuite/gdb.base/max-value-size.exp | 2 gdb/testsuite/gdb.base/options.exp | 47 ++-- gdb/testsuite/gdb.base/settings.exp | 2 gdb/testsuite/gdb.base/with.exp | 2 gdb/testsuite/gdb.guile/scm-parameter.exp | 23 -- gdb/testsuite/gdb.python/py-parameter.exp | 15 + gdb/valprint.c | 9 19 files changed, 1106 insertions(+), 609 deletions(-) gdb-setshow-cmd-extra-literals.diff Index: src/gdb/cli/cli-cmds.c =================================================================== --- src.orig/gdb/cli/cli-cmds.c +++ src/gdb/cli/cli-cmds.c @@ -2200,22 +2200,40 @@ value_from_setting (const setting &var, { switch (var.type ()) { + case var_uinteger: case var_integer: - if (var.get () == INT_MAX) - return value_from_longest (builtin_type (gdbarch)->builtin_int, - 0); - else - return value_from_longest (builtin_type (gdbarch)->builtin_int, - var.get ()); - case var_zinteger: - return value_from_longest (builtin_type (gdbarch)->builtin_int, - var.get ()); + case var_pinteger: + { + LONGEST value + = (var.type () == var_uinteger + ? static_cast (var.get ()) + : static_cast (var.get ())); + + if (var.extra_literals () != nullptr) + for (const literal_def *l = var.extra_literals (); + l->literal != nullptr; + l++) + if (value == l->use) + { + if (l->val.has_value ()) + value = *l->val; + else + return allocate_value (builtin_type (gdbarch)->builtin_void); + break; + } + + if (var.type () == var_uinteger) + return + value_from_ulongest (builtin_type (gdbarch)->builtin_unsigned_int, + static_cast (value)); + else + return + value_from_longest (builtin_type (gdbarch)->builtin_int, + static_cast (value)); + } case var_boolean: return value_from_longest (builtin_type (gdbarch)->builtin_int, var.get () ? 1 : 0); - case var_zuinteger_unlimited: - return value_from_longest (builtin_type (gdbarch)->builtin_int, - var.get ()); case var_auto_boolean: { int val; @@ -2237,17 +2255,6 @@ value_from_setting (const setting &var, return value_from_longest (builtin_type (gdbarch)->builtin_int, val); } - case var_uinteger: - if (var.get () == UINT_MAX) - return value_from_ulongest - (builtin_type (gdbarch)->builtin_unsigned_int, 0); - else - return value_from_ulongest - (builtin_type (gdbarch)->builtin_unsigned_int, - var.get ()); - case var_zuinteger: - return value_from_ulongest (builtin_type (gdbarch)->builtin_unsigned_int, - var.get ()); case var_string: case var_string_noescape: case var_optional_filename: @@ -2317,13 +2324,11 @@ str_value_from_setting (const setting &v { switch (var.type ()) { + case var_uinteger: case var_integer: - case var_zinteger: + case var_pinteger: case var_boolean: - case var_zuinteger_unlimited: case var_auto_boolean: - case var_uinteger: - case var_zuinteger: { std::string cmd_val = get_setshow_command_value_string (var); Index: src/gdb/cli/cli-decode.c =================================================================== --- src.orig/gdb/cli/cli-decode.c +++ src/gdb/cli/cli-decode.c @@ -580,11 +580,51 @@ add_setshow_cmd_full_erased (const char return {set, show}; } +/* Completes on integer commands that support extra literals. */ + +static void +integer_literals_completer (struct cmd_list_element *c, + completion_tracker &tracker, + const char *text, const char *word) +{ + const literal_def *extra_literals = c->var->extra_literals (); + + if (*text == '\0') + { + tracker.add_completion (make_unique_xstrdup ("NUMBER")); + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++) + tracker.add_completion (make_unique_xstrdup (l->literal)); + } + else + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++) + if (startswith (l->literal, text)) + tracker.add_completion (make_unique_xstrdup (l->literal)); +} + +/* Add element named NAME to both the command SET_LIST and SHOW_LIST. + THECLASS is as in add_cmd. VAR_TYPE is the kind of thing we are + setting. VAR is address of the variable being controlled by this + command. EXTRA_LITERALS if non-NULL define extra literals to be + accepted in lieu of a number for integer variables. If nullptr is + given as VAR, then both SET_SETTING_FUNC and GET_SETTING_FUNC must + be provided. SET_SETTING_FUNC and GET_SETTING_FUNC are callbacks + used to access and modify the underlying property, whatever its + storage is. SET_FUNC and SHOW_FUNC are the callback functions + (if non-NULL). SET_DOC, SHOW_DOC and HELP_DOC are the + documentation strings. + + Return the newly created set and show commands. */ + template static set_show_commands add_setshow_cmd_full (const char *name, enum command_class theclass, var_types var_type, T *var, + const literal_def *extra_literals, const char *set_doc, const char *show_doc, const char *help_doc, typename setting_func_types::set set_setting_func, @@ -595,18 +635,44 @@ add_setshow_cmd_full (const char *name, struct cmd_list_element **show_list) { auto erased_args - = setting::erase_args (var_type, var, + = setting::erase_args (var_type, var, extra_literals, set_setting_func, get_setting_func); + auto cmds = add_setshow_cmd_full_erased (name, + theclass, + var_type, erased_args, + set_doc, show_doc, + help_doc, + set_func, + show_func, + set_list, + show_list); - return add_setshow_cmd_full_erased (name, - theclass, - var_type, erased_args, - set_doc, show_doc, - help_doc, - set_func, - show_func, - set_list, - show_list); + if (extra_literals != nullptr) + set_cmd_completer (cmds.set, integer_literals_completer); + + return cmds; +} + +/* Same as above but omitting EXTRA_LITERALS. */ + +template +static set_show_commands +add_setshow_cmd_full (const char *name, + enum command_class theclass, + var_types var_type, T *var, + const char *set_doc, const char *show_doc, + const char *help_doc, + typename setting_func_types::set set_setting_func, + typename setting_func_types::get get_setting_func, + cmd_func_ftype *set_func, + show_value_ftype *show_func, + struct cmd_list_element **set_list, + struct cmd_list_element **show_list) +{ + return add_setshow_cmd_full (name, theclass, var_type, var, nullptr, + set_doc, show_doc, help_doc, + set_setting_func, get_setting_func, + set_func, show_func, set_list, show_list); } /* Add element named NAME to command list LIST (the list for set or @@ -975,25 +1041,6 @@ add_setshow_optional_filename_cmd (const return cmds; } -/* Completes on literal "unlimited". Used by integer commands that - support a special "unlimited" value. */ - -static void -integer_unlimited_completer (struct cmd_list_element *ignore, - completion_tracker &tracker, - const char *text, const char *word) -{ - static const char * const keywords[] = - { - "unlimited", - NULL, - }; - - if (*text == '\0') - tracker.add_completion (make_unique_xstrdup ("NUMBER")); - complete_on_enum (tracker, keywords, text, word); -} - /* Add element named NAME to both the set and show command LISTs (the list for set/show or some sublist thereof). CLASS is as in add_cmd. VAR is address of the variable which will contain the @@ -1002,6 +1049,55 @@ integer_unlimited_completer (struct cmd_ set_show_commands add_setshow_integer_cmd (const char *name, enum command_class theclass, + int *var, const literal_def *extra_literals, + const char *set_doc, const char *show_doc, + const char *help_doc, + cmd_func_ftype *set_func, + show_value_ftype *show_func, + struct cmd_list_element **set_list, + struct cmd_list_element **show_list) +{ + set_show_commands commands + = add_setshow_cmd_full (name, theclass, var_integer, var, + extra_literals, set_doc, show_doc, + help_doc, nullptr, nullptr, set_func, + show_func, set_list, show_list); + return commands; +} + +/* Same as above but using a getter and a setter function instead of a pointer + to a global storage buffer. */ + +set_show_commands +add_setshow_integer_cmd (const char *name, command_class theclass, + const literal_def *extra_literals, + const char *set_doc, const char *show_doc, + const char *help_doc, + setting_func_types::set set_func, + setting_func_types::get get_func, + show_value_ftype *show_func, + cmd_list_element **set_list, + cmd_list_element **show_list) +{ + auto cmds = add_setshow_cmd_full (name, theclass, var_integer, nullptr, + extra_literals, set_doc, show_doc, + help_doc, set_func, get_func, nullptr, + show_func, set_list, show_list); + return cmds; +} + +/* Accept `unlimited' or 0, translated internally to INT_MAX. */ +const literal_def integer_unlimited_literals[] = + { + { "unlimited", INT_MAX, 0 }, + { nullptr } + }; + +/* Same as above but using `integer_unlimited_literals', with a pointer + to a global storage buffer. */ + +set_show_commands +add_setshow_integer_cmd (const char *name, enum command_class theclass, int *var, const char *set_doc, const char *show_doc, const char *help_doc, @@ -1012,12 +1108,10 @@ add_setshow_integer_cmd (const char *nam { set_show_commands commands = add_setshow_cmd_full (name, theclass, var_integer, var, + integer_unlimited_literals, set_doc, show_doc, help_doc, nullptr, nullptr, set_func, show_func, set_list, show_list); - - set_cmd_completer (commands.set, integer_unlimited_completer); - return commands; } @@ -1035,12 +1129,54 @@ add_setshow_integer_cmd (const char *nam cmd_list_element **show_list) { auto cmds = add_setshow_cmd_full (name, theclass, var_integer, nullptr, + integer_unlimited_literals, set_doc, show_doc, help_doc, set_func, get_func, nullptr, show_func, set_list, show_list); + return cmds; +} - set_cmd_completer (cmds.set, integer_unlimited_completer); +/* Add element named NAME to both the set and show command LISTs (the + list for set/show or some sublist thereof). CLASS is as in + add_cmd. VAR is address of the variable which will contain the + value. SET_DOC and SHOW_DOC are the documentation strings. */ + +set_show_commands +add_setshow_pinteger_cmd (const char *name, enum command_class theclass, + int *var, const literal_def *extra_literals, + const char *set_doc, const char *show_doc, + const char *help_doc, + cmd_func_ftype *set_func, + show_value_ftype *show_func, + struct cmd_list_element **set_list, + struct cmd_list_element **show_list) +{ + set_show_commands commands + = add_setshow_cmd_full (name, theclass, var_pinteger, var, + extra_literals, set_doc, show_doc, + help_doc, nullptr, nullptr, set_func, + show_func, set_list, show_list); + return commands; +} +/* Same as above but using a getter and a setter function instead of a pointer + to a global storage buffer. */ + +set_show_commands +add_setshow_pinteger_cmd (const char *name, command_class theclass, + const literal_def *extra_literals, + const char *set_doc, const char *show_doc, + const char *help_doc, + setting_func_types::set set_func, + setting_func_types::get get_func, + show_value_ftype *show_func, + cmd_list_element **set_list, + cmd_list_element **show_list) +{ + auto cmds = add_setshow_cmd_full (name, theclass, var_pinteger, nullptr, + extra_literals, set_doc, show_doc, + help_doc, set_func, get_func, nullptr, + show_func, set_list, show_list); return cmds; } @@ -1051,7 +1187,7 @@ add_setshow_integer_cmd (const char *nam set_show_commands add_setshow_uinteger_cmd (const char *name, enum command_class theclass, - unsigned int *var, + unsigned int *var, const literal_def *extra_literals, const char *set_doc, const char *show_doc, const char *help_doc, cmd_func_ftype *set_func, @@ -1061,12 +1197,9 @@ add_setshow_uinteger_cmd (const char *na { set_show_commands commands = add_setshow_cmd_full (name, theclass, var_uinteger, var, - set_doc, show_doc, help_doc, - nullptr, nullptr, set_func, + extra_literals, set_doc, show_doc, + help_doc, nullptr, nullptr, set_func, show_func, set_list, show_list); - - set_cmd_completer (commands.set, integer_unlimited_completer); - return commands; } @@ -1075,6 +1208,7 @@ add_setshow_uinteger_cmd (const char *na set_show_commands add_setshow_uinteger_cmd (const char *name, command_class theclass, + const literal_def *extra_literals, const char *set_doc, const char *show_doc, const char *help_doc, setting_func_types::set set_func, @@ -1084,13 +1218,63 @@ add_setshow_uinteger_cmd (const char *na cmd_list_element **show_list) { auto cmds = add_setshow_cmd_full (name, theclass, var_uinteger, - nullptr, set_doc, show_doc, - help_doc, set_func, get_func, - nullptr, show_func, set_list, + nullptr, extra_literals, + set_doc, show_doc, help_doc, + set_func, get_func, nullptr, + show_func, set_list, show_list); + return cmds; +} - set_cmd_completer (cmds.set, integer_unlimited_completer); +/* Accept `unlimited' or 0, translated internally to UINT_MAX. */ +const literal_def uinteger_unlimited_literals[] = + { + { "unlimited", UINT_MAX, 0 }, + { nullptr } + }; + +/* Same as above but using `uinteger_unlimited_literals', with a pointer + to a global storage buffer. */ + +set_show_commands +add_setshow_uinteger_cmd (const char *name, enum command_class theclass, + unsigned int *var, + const char *set_doc, const char *show_doc, + const char *help_doc, + cmd_func_ftype *set_func, + show_value_ftype *show_func, + struct cmd_list_element **set_list, + struct cmd_list_element **show_list) +{ + set_show_commands commands + = add_setshow_cmd_full (name, theclass, var_uinteger, var, + uinteger_unlimited_literals, + set_doc, show_doc, help_doc, nullptr, + nullptr, set_func, show_func, + set_list, show_list); + return commands; +} + +/* Same as above but using a getter and a setter function instead of a pointer + to a global storage buffer. */ +set_show_commands +add_setshow_uinteger_cmd (const char *name, command_class theclass, + const char *set_doc, const char *show_doc, + const char *help_doc, + setting_func_types::set set_func, + setting_func_types::get get_func, + show_value_ftype *show_func, + cmd_list_element **set_list, + cmd_list_element **show_list) +{ + auto cmds = add_setshow_cmd_full (name, theclass, var_uinteger, + nullptr, + uinteger_unlimited_literals, + set_doc, show_doc, help_doc, + set_func, get_func, nullptr, + show_func, set_list, + show_list); return cmds; } @@ -1109,7 +1293,7 @@ add_setshow_zinteger_cmd (const char *na struct cmd_list_element **set_list, struct cmd_list_element **show_list) { - return add_setshow_cmd_full (name, theclass, var_zinteger, var, + return add_setshow_cmd_full (name, theclass, var_integer, var, set_doc, show_doc, help_doc, nullptr, nullptr, set_func, show_func, set_list, show_list); @@ -1128,12 +1312,22 @@ add_setshow_zinteger_cmd (const char *na cmd_list_element **set_list, cmd_list_element **show_list) { - return add_setshow_cmd_full (name, theclass, var_zinteger, nullptr, + return add_setshow_cmd_full (name, theclass, var_integer, nullptr, set_doc, show_doc, help_doc, set_func, get_func, nullptr, show_func, set_list, show_list); } +/* Accept `unlimited' or -1, using -1 internally. */ +const literal_def pinteger_unlimited_literals[] = + { + { "unlimited", -1, -1 }, + { nullptr } + }; + +/* Same as above but using `pinteger_unlimited_literals', with a pointer + to a global storage buffer. */ + set_show_commands add_setshow_zuinteger_unlimited_cmd (const char *name, enum command_class theclass, @@ -1147,13 +1341,11 @@ add_setshow_zuinteger_unlimited_cmd (con struct cmd_list_element **show_list) { set_show_commands commands - = add_setshow_cmd_full (name, theclass, var_zuinteger_unlimited, var, + = add_setshow_cmd_full (name, theclass, var_pinteger, var, + pinteger_unlimited_literals, set_doc, show_doc, help_doc, nullptr, nullptr, set_func, show_func, set_list, show_list); - - set_cmd_completer (commands.set, integer_unlimited_completer); - return commands; } @@ -1171,13 +1363,11 @@ add_setshow_zuinteger_unlimited_cmd (con cmd_list_element **show_list) { auto cmds - = add_setshow_cmd_full (name, theclass, var_zuinteger_unlimited, - nullptr, set_doc, show_doc, help_doc, set_func, + = add_setshow_cmd_full (name, theclass, var_pinteger, nullptr, + pinteger_unlimited_literals, + set_doc, show_doc, help_doc, set_func, get_func, nullptr, show_func, set_list, show_list); - - set_cmd_completer (cmds.set, integer_unlimited_completer); - return cmds; } @@ -1196,7 +1386,7 @@ add_setshow_zuinteger_cmd (const char *n struct cmd_list_element **set_list, struct cmd_list_element **show_list) { - return add_setshow_cmd_full (name, theclass, var_zuinteger, + return add_setshow_cmd_full (name, theclass, var_uinteger, var, set_doc, show_doc, help_doc, nullptr, nullptr, set_func, show_func, set_list, show_list); @@ -1215,7 +1405,7 @@ add_setshow_zuinteger_cmd (const char *n cmd_list_element **set_list, cmd_list_element **show_list) { - return add_setshow_cmd_full (name, theclass, var_zuinteger, + return add_setshow_cmd_full (name, theclass, var_uinteger, nullptr, set_doc, show_doc, help_doc, set_func, get_func, nullptr, show_func, set_list, Index: src/gdb/cli/cli-option.c =================================================================== --- src.orig/gdb/cli/cli-option.c +++ src/gdb/cli/cli-option.c @@ -38,7 +38,7 @@ union option_value /* For var_uinteger options. */ unsigned int uinteger; - /* For var_zuinteger_unlimited options. */ + /* For var_integer and var_pinteger options. */ int integer; /* For var_enum options. */ @@ -356,42 +356,55 @@ parse_option (gdb::array_viewtracker.add_completion - (make_unique_xstrdup ("NUMBER")); - completion->tracker.add_completion - (make_unique_xstrdup ("unlimited")); - return {}; - } - else if (startswith ("unlimited", *args)) + if (match->extra_literals != nullptr) { - completion->tracker.add_completion - (make_unique_xstrdup ("unlimited")); - return {}; + /* Convenience to let the user know what the option can + accept. Make sure there's no common prefix between + "NUMBER" and all the strings when adding new ones, + so that readline doesn't do a partial match. */ + if (**args == '\0') + { + completion->tracker.add_completion + (make_unique_xstrdup ("NUMBER")); + for (const literal_def *l = match->extra_literals; + l->literal != nullptr; + l++) + completion->tracker.add_completion + (make_unique_xstrdup (l->literal)); + return {}; + } + else + { + bool completions = false; + for (const literal_def *l = match->extra_literals; + l->literal != nullptr; + l++) + if (startswith (l->literal, *args)) + { + completion->tracker.add_completion + (make_unique_xstrdup (l->literal)); + completions = true; + } + if (completions) + return {}; + } } } - if (match->type == var_zuinteger_unlimited) - { - option_value val; - val.integer = parse_cli_var_zuinteger_unlimited (args, false); - return option_def_and_value {*match, match_ctx, val}; - } + LONGEST v = parse_cli_var_integer (match->type, + match->extra_literals, + args, false); + option_value val; + if (match->type == var_uinteger) + val.uinteger = v; else - { - option_value val; - val.uinteger = parse_cli_var_uinteger (match->type, args, false); - return option_def_and_value {*match, match_ctx, val}; - } + val.integer = v; + return option_def_and_value {*match, match_ctx, val}; } case var_enum: { @@ -593,7 +606,8 @@ save_option_value_in_ctx (gdb::optional< *ov->option.var_address.uinteger (ov->option, ov->ctx) = ov->value->uinteger; break; - case var_zuinteger_unlimited: + case var_integer: + case var_pinteger: *ov->option.var_address.integer (ov->option, ov->ctx) = ov->value->integer; break; @@ -664,8 +678,20 @@ get_val_type_str (const option_def &opt, case var_boolean: return "[on|off]"; case var_uinteger: - case var_zuinteger_unlimited: - return "NUMBER|unlimited"; + case var_integer: + case var_pinteger: + { + buffer = "NUMBER"; + if (opt.extra_literals != nullptr) + for (const literal_def *l = opt.extra_literals; + l->literal != nullptr; + l++) + { + buffer += '|'; + buffer += l->literal; + } + return buffer.c_str (); + } case var_enum: { buffer = ""; @@ -789,20 +815,31 @@ add_setshow_cmds_for_options (command_cl { add_setshow_uinteger_cmd (option.name, cmd_class, option.var_address.uinteger (option, data), + option.extra_literals, option.set_doc, option.show_doc, option.help_doc, nullptr, option.show_cmd_cb, set_list, show_list); } - else if (option.type == var_zuinteger_unlimited) + else if (option.type == var_integer) { - add_setshow_zuinteger_unlimited_cmd - (option.name, cmd_class, - option.var_address.integer (option, data), - option.set_doc, option.show_doc, - option.help_doc, - nullptr, option.show_cmd_cb, - set_list, show_list); + add_setshow_integer_cmd (option.name, cmd_class, + option.var_address.integer (option, data), + option.extra_literals, + option.set_doc, option.show_doc, + option.help_doc, + nullptr, option.show_cmd_cb, + set_list, show_list); + } + else if (option.type == var_pinteger) + { + add_setshow_pinteger_cmd (option.name, cmd_class, + option.var_address.integer (option, data), + option.extra_literals, + option.set_doc, option.show_doc, + option.help_doc, + nullptr, option.show_cmd_cb, + set_list, show_list); } else if (option.type == var_enum) { Index: src/gdb/cli/cli-option.h =================================================================== --- src.orig/gdb/cli/cli-option.h +++ src/gdb/cli/cli-option.h @@ -49,12 +49,13 @@ struct option_def used to create the option's "set/show" commands. */ constexpr option_def (const char *name_, var_types var_type_, + const literal_def *extra_literals_, erased_get_var_address_ftype *erased_get_var_address_, show_value_ftype *show_cmd_cb_, const char *set_doc_, const char *show_doc_, const char *help_doc_) - : name (name_), type (var_type_), + : name (name_), type (var_type_), extra_literals (extra_literals_), erased_get_var_address (erased_get_var_address_), var_address {}, show_cmd_cb (show_cmd_cb_), @@ -68,6 +69,9 @@ struct option_def /* The option's type. */ var_types type; + /* Extra literals, such as `unlimited', accepted in lieu of a number. */ + const literal_def *extra_literals; + /* A function that gets the controlling variable's address, type erased. */ erased_get_var_address_ftype *erased_get_var_address; @@ -160,7 +164,7 @@ struct boolean_option_def : option_def const char *set_doc_, const char *show_doc_ = nullptr, const char *help_doc_ = nullptr) - : option_def (long_option_, var_boolean, + : option_def (long_option_, var_boolean, nullptr, (erased_get_var_address_ftype *) get_var_address_cb_, show_cmd_cb_, set_doc_, show_doc_, help_doc_) @@ -207,37 +211,59 @@ struct uinteger_option_def : option_def { uinteger_option_def (const char *long_option_, unsigned int *(*get_var_address_cb_) (Context *), + const literal_def *extra_literals_, show_value_ftype *show_cmd_cb_, const char *set_doc_, const char *show_doc_ = nullptr, const char *help_doc_ = nullptr) - : option_def (long_option_, var_uinteger, + : option_def (long_option_, var_uinteger, extra_literals_, (erased_get_var_address_ftype *) get_var_address_cb_, show_cmd_cb_, set_doc_, show_doc_, help_doc_) { var_address.uinteger = detail::get_var_address; } + + uinteger_option_def (const char *long_option_, + unsigned int *(*get_var_address_cb_) (Context *), + show_value_ftype *show_cmd_cb_, + const char *set_doc_, + const char *show_doc_ = nullptr, + const char *help_doc_ = nullptr) + : uinteger_option_def (long_option_, get_var_address_cb_, nullptr, + show_cmd_cb_, set_doc_, show_doc_, help_doc_) + { /* Nothing. */ } }; -/* A var_zuinteger_unlimited command line option. */ +/* A var_pinteger command line option. */ template -struct zuinteger_unlimited_option_def : option_def +struct pinteger_option_def : option_def { - zuinteger_unlimited_option_def (const char *long_option_, - int *(*get_var_address_cb_) (Context *), - show_value_ftype *show_cmd_cb_, - const char *set_doc_, - const char *show_doc_ = nullptr, - const char *help_doc_ = nullptr) - : option_def (long_option_, var_zuinteger_unlimited, + pinteger_option_def (const char *long_option_, + int *(*get_var_address_cb_) (Context *), + const literal_def *extra_literals_, + show_value_ftype *show_cmd_cb_, + const char *set_doc_, + const char *show_doc_ = nullptr, + const char *help_doc_ = nullptr) + : option_def (long_option_, var_pinteger, extra_literals_, (erased_get_var_address_ftype *) get_var_address_cb_, show_cmd_cb_, set_doc_, show_doc_, help_doc_) { var_address.integer = detail::get_var_address; } + + pinteger_option_def (const char *long_option_, + int *(*get_var_address_cb_) (Context *), + show_value_ftype *show_cmd_cb_, + const char *set_doc_, + const char *show_doc_ = nullptr, + const char *help_doc_ = nullptr) + : pinteger_option_def (long_option_, get_var_address_cb_, nullptr, + show_cmd_cb_, set_doc_, show_doc_, help_doc_) + { /* Nothing. */ } }; /* An var_enum command line option. */ @@ -252,7 +278,7 @@ struct enum_option_def : option_def const char *set_doc_, const char *show_doc_ = nullptr, const char *help_doc_ = nullptr) - : option_def (long_option_, var_enum, + : option_def (long_option_, var_enum, nullptr, (erased_get_var_address_ftype *) get_var_address_cb_, show_cmd_cb_, set_doc_, show_doc_, help_doc_) @@ -273,7 +299,7 @@ struct string_option_def : option_def const char *set_doc_, const char *show_doc_ = nullptr, const char *help_doc_ = nullptr) - : option_def (long_option_, var_string, + : option_def (long_option_, var_string, nullptr, (erased_get_var_address_ftype *) get_var_address_cb_, show_cmd_cb_, set_doc_, show_doc_, help_doc_) Index: src/gdb/cli/cli-setshow.c =================================================================== --- src.orig/gdb/cli/cli-setshow.c +++ src/gdb/cli/cli-setshow.c @@ -149,10 +149,11 @@ deprecated_show_value_hack (struct ui_fi } } -/* Returns true if ARG is "unlimited". */ +/* Returns true and the value in VAL if ARG is an accepted literal. */ static bool -is_unlimited_literal (const char **arg, bool expression) +get_literal_val (LONGEST &val, const literal_def *extra_literals, + const char **arg, bool expression) { *arg = skip_spaces (*arg); @@ -162,85 +163,104 @@ is_unlimited_literal (const char **arg, size_t len = p - *arg; - if (len > 0 && strncmp ("unlimited", *arg, len) == 0) - { - *arg += len; - - /* If parsing an expression (i.e., parsing for a "set" command), - anything after "unlimited" is junk. For options, anything - after "unlimited" might be a command argument or another - option. */ - if (expression) + if (len > 0 && extra_literals != nullptr) + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++) + if (strncmp (l->literal, *arg, len) == 0) { - const char *after = skip_spaces (*arg); - if (*after != '\0') - error (_("Junk after \"%.*s\": %s"), - (int) len, unl_start, after); - } + *arg += len; - return true; - } + /* If parsing an expression (i.e., parsing for a "set" command), + anything after the literal is junk. For options, anything + after the literal might be a command argument or another + option. */ + if (expression) + { + const char *after = skip_spaces (*arg); + if (*after != '\0') + error (_("Junk after \"%.*s\": %s"), + (int) len, unl_start, after); + } + + val = l->use; + return true; + } return false; } /* See cli-setshow.h. */ -unsigned int -parse_cli_var_uinteger (var_types var_type, const char **arg, - bool expression) +LONGEST +parse_cli_var_integer (var_types var_type, const literal_def *extra_literals, + const char **arg, bool expression) { LONGEST val; if (*arg == nullptr || **arg == '\0') { - if (var_type == var_uinteger) - error_no_arg (_("integer to set it to, or \"unlimited\"")); - else + if (extra_literals == nullptr) error_no_arg (_("integer to set it to")); - } - - if (var_type == var_uinteger && is_unlimited_literal (arg, expression)) - val = 0; - else if (expression) - val = parse_and_eval_long (*arg); - else - val = get_ulongest (arg); - - if (var_type == var_uinteger && val == 0) - val = UINT_MAX; - else if (val < 0 - /* For var_uinteger, don't let the user set the value - to UINT_MAX directly, as that exposes an - implementation detail to the user interface. */ - || (var_type == var_uinteger && val >= UINT_MAX) - || (var_type == var_zuinteger && val > UINT_MAX)) - error (_("integer %s out of range"), plongest (val)); - - return val; -} - -/* See cli-setshow.h. */ + else + { + std::string buffer = ""; + size_t count = 0; -int -parse_cli_var_zuinteger_unlimited (const char **arg, bool expression) -{ - LONGEST val; + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++, count++) + { + if (count != 0) + buffer += ", "; + buffer = buffer + '"' + l->literal + '"'; + } + if (count > 1) + error_no_arg + (string_printf (_("integer to set it to, or one of: %s"), + buffer.c_str ()).c_str ()); + else + error_no_arg + (string_printf (_("integer to set it to, or %s"), + buffer.c_str ()).c_str ()); + } + } - if (*arg == nullptr || **arg == '\0') - error_no_arg (_("integer to set it to, or \"unlimited\"")); + if (!get_literal_val (val, extra_literals, arg, expression)) + { + if (expression) + val = parse_and_eval_long (*arg); + else + val = get_ulongest (arg); - if (is_unlimited_literal (arg, expression)) - val = -1; - else if (expression) - val = parse_and_eval_long (*arg); - else - val = get_ulongest (arg); + enum tribool allowed = TRIBOOL_UNKNOWN; + if (extra_literals != nullptr) + { + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++) + if (l->val.has_value () && val == *l->val) + { + allowed = TRIBOOL_TRUE; + val = l->use; + break; + } + else if (val == l->use) + allowed = TRIBOOL_FALSE; + } - if (val > INT_MAX) - error (_("integer %s out of range"), plongest (val)); - else if (val < -1) - error (_("only -1 is allowed to set as unlimited")); + if (allowed == TRIBOOL_UNKNOWN) + { + if (val > UINT_MAX || val < INT_MIN + || (var_type == var_uinteger && val < 0) + || (var_type == var_integer && val > INT_MAX) + || (var_type == var_pinteger && val < 0) + || (var_type == var_pinteger && val > INT_MAX)) + allowed = TRIBOOL_FALSE; + } + if (allowed == TRIBOOL_FALSE) + error (_("integer %s out of range"), plongest (val)); + } return val; } @@ -405,41 +425,18 @@ do_set_command (const char *arg, int fro option_changed = c->var->set (parse_auto_binary_operation (arg)); break; case var_uinteger: - case var_zuinteger: option_changed - = c->var->set (parse_cli_var_uinteger (c->var->type (), - &arg, true)); + = c->var->set (parse_cli_var_integer (c->var->type (), + c->var-> + extra_literals (), + &arg, true)); break; case var_integer: - case var_zinteger: - { - LONGEST val; - - if (*arg == '\0') - { - if (c->var->type () == var_integer) - error_no_arg (_("integer to set it to, or \"unlimited\"")); - else - error_no_arg (_("integer to set it to")); - } - - if (c->var->type () == var_integer && is_unlimited_literal (&arg, true)) - val = 0; - else - val = parse_and_eval_long (arg); - - if (val == 0 && c->var->type () == var_integer) - val = INT_MAX; - else if (val < INT_MIN - /* For var_integer, don't let the user set the value - to INT_MAX directly, as that exposes an - implementation detail to the user interface. */ - || (c->var->type () == var_integer && val >= INT_MAX) - || (c->var->type () == var_zinteger && val > INT_MAX)) - error (_("integer %s out of range"), plongest (val)); - - option_changed = c->var->set (val); - } + case var_pinteger: + option_changed + = c->var->set (parse_cli_var_integer (c->var->type (), + c->var->extra_literals (), + &arg, true)); break; case var_enum: { @@ -454,10 +451,6 @@ do_set_command (const char *arg, int fro option_changed = c->var->set (match); } break; - case var_zuinteger_unlimited: - option_changed = c->var->set - (parse_cli_var_zuinteger_unlimited (&arg, true)); - break; default: error (_("gdb internal error: bad var_type in do_setshow_command")); } @@ -551,7 +544,6 @@ do_set_command (const char *arg, int fro } break; case var_uinteger: - case var_zuinteger: { char s[64]; @@ -560,8 +552,7 @@ do_set_command (const char *arg, int fro } break; case var_integer: - case var_zinteger: - case var_zuinteger_unlimited: + case var_pinteger: { char s[64]; @@ -623,36 +614,32 @@ get_setshow_command_value_string (const } break; case var_uinteger: - case var_zuinteger: - { - const unsigned int value = var.get (); - - if (var.type () == var_uinteger - && value == UINT_MAX) - stb.puts ("unlimited"); - else - stb.printf ("%u", value); - } - break; case var_integer: - case var_zinteger: + case var_pinteger: { - const int value = var.get (); + bool printed = false; + const LONGEST value + = (var.type () == var_uinteger + ? static_cast (var.get ()) + : static_cast (var.get ())); - if (var.type () == var_integer - && value == INT_MAX) - stb.puts ("unlimited"); - else - stb.printf ("%d", value); - } - break; - case var_zuinteger_unlimited: - { - const int value = var.get (); - if (value == -1) - stb.puts ("unlimited"); - else - stb.printf ("%d", value); + if (var.extra_literals () != nullptr) + for (const literal_def *l = var.extra_literals (); + l->literal != nullptr; + l++) + if (value == l->use) + { + stb.puts (l->literal); + printed = true; + break; + } + if (!printed) + { + if (var.type () == var_uinteger) + stb.printf ("%u", static_cast (value)); + else + stb.printf ("%d", static_cast (value)); + } } break; default: Index: src/gdb/cli/cli-setshow.h =================================================================== --- src.orig/gdb/cli/cli-setshow.h +++ src/gdb/cli/cli-setshow.h @@ -29,21 +29,19 @@ extern int parse_cli_boolean_value (cons past a successfully parsed value. */ extern int parse_cli_boolean_value (const char **arg); -/* Parse ARG, an option to a var_uinteger or var_zuinteger variable. - Either returns the parsed value on success or throws an error. If - EXPRESSION is true, *ARG is parsed as an expression; otherwise, it - is parsed with get_ulongest. It's not possible to parse the +/* Parse ARG, an option to a var_uinteger, var_integer or var_pinteger + variable. Return the parsed value on success or throw an error. If + EXTRA_LITERALS is non-null, then interpret those literals accordingly. + If EXPRESSION is true, *ARG is parsed as an expression; otherwise, + it is parsed with get_ulongest. It's not possible to parse the integer as an expression when there may be valid input after the integer, such as when parsing command options. E.g., "print -elements NUMBER -obj --". In such case, parsing as an expression would parse "-obj --" as part of the expression as well. */ -extern unsigned int parse_cli_var_uinteger (var_types var_type, - const char **arg, - bool expression); - -/* Like parse_cli_var_uinteger, for var_zuinteger_unlimited. */ -extern int parse_cli_var_zuinteger_unlimited (const char **arg, - bool expression); +extern LONGEST parse_cli_var_integer (var_types var_type, + const literal_def *extra_literals, + const char **arg, + bool expression); /* Parse ARG, an option to a var_enum variable. ENUM is a null-terminated array of possible values. Either returns the parsed Index: src/gdb/command.h =================================================================== --- src.orig/gdb/command.h +++ src/gdb/command.h @@ -84,16 +84,18 @@ enum var_types value. */ var_auto_boolean, - /* Unsigned Integer. *VAR is an unsigned int. The user can type - 0 to mean "unlimited", which is stored in *VAR as UINT_MAX. */ + /* Unsigned Integer. *VAR is an unsigned int. In the Guile and Python + APIs 0 means unlimited, which is stored in *VAR as UINT_MAX. */ var_uinteger, - /* Like var_uinteger but signed. *VAR is an int. The user can - type 0 to mean "unlimited", which is stored in *VAR as - INT_MAX. The only remaining use of it is the Python API. - Don't use it elsewhere. */ + /* Like var_uinteger but signed. *VAR is an int. In the Guile and + Python APIs 0 means unlimited, which is stored in *VAR as INT_MAX. */ var_integer, + /* Like var_integer but negative numbers are not allowed, + except for special values. *VAR is an int. */ + var_pinteger, + /* String which the user enters with escapes (e.g. the user types \n and it is a real newline in the stored string). *VAR is a std::string, "" if the string is empty. */ @@ -106,22 +108,25 @@ enum var_types var_optional_filename, /* String which stores a filename. (*VAR) is a std::string. */ var_filename, - /* ZeroableInteger. *VAR is an int. Like var_integer except - that zero really means zero. */ - var_zinteger, - /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really - means zero. */ - var_zuinteger, - /* ZeroableUnsignedInteger with unlimited value. *VAR is an int, - but its range is [0, INT_MAX]. -1 stands for unlimited and - other negative numbers are not allowed. */ - var_zuinteger_unlimited, /* Enumerated type. Can only have one of the specified values. *VAR is a char pointer to the name of the element that we find. */ var_enum }; +/* A structure describing an extra literal accepted and shown in place + of a number. */ +struct literal_def + { + /* The literal to define, e.g. "unlimited". */ + const char *literal; + /* The number to substitute internally for LITERAL or VAL; + the use of this number is not allowed (unless the same as VAL). */ + LONGEST use; + /* An optional number accepted that stands for the literal. */ + gdb::optional val; + }; + /* Return true if a setting of type VAR_TYPE is backed with type T. This function is left without definition intentionally. This template is @@ -152,15 +157,14 @@ inline bool var_type_uses inline bool var_type_uses (var_types t) { - return (t == var_uinteger || t == var_zinteger || t == var_zuinteger); + return t == var_uinteger; } /* Return true if a setting of type T is backed by an int variable. */ template<> inline bool var_type_uses (var_types t) { - return (t == var_integer || t == var_zinteger - || t == var_zuinteger_unlimited); + return t == var_integer || t == var_pinteger; } /* Return true if a setting of type T is backed by a std::string variable. */ @@ -218,8 +222,8 @@ struct setting Type T must match the var type VAR_TYPE (see VAR_TYPE_USES). */ template - setting (var_types var_type, T *var) - : m_var_type (var_type), m_var (var) + setting (var_types var_type, T *var, const void *extra_literals = nullptr) + : m_var_type (var_type), m_var (var), m_extra_literals (extra_literals) { gdb_assert (var != nullptr); gdb_assert (var_type_uses (var_type)); @@ -232,6 +236,7 @@ struct setting struct erased_args { void *var; + const void *extra_literals; erased_func setter; erased_func getter; }; @@ -239,6 +244,7 @@ struct setting template static erased_args erase_args (var_types var_type, T *var, + const literal_def *extra_literals, typename setting_func_types::set set_setting_func, typename setting_func_types::get get_setting_func) { @@ -253,6 +259,7 @@ struct setting return { var, + extra_literals, reinterpret_cast (set_setting_func), reinterpret_cast (get_setting_func) }; @@ -264,6 +271,7 @@ struct setting setting (var_types var_type, const erased_args &args) : m_var_type (var_type), m_var (args.var), + m_extra_literals (args.extra_literals), m_getter (args.getter), m_setter (args.setter) { @@ -294,6 +302,10 @@ struct setting var_types type () const { return m_var_type; } + /* Access any extra literals accepted. */ + const literal_def *extra_literals () const + { return static_cast (m_extra_literals); } + /* Return the current value. The template parameter T is the type of the variable used to store the @@ -356,6 +368,9 @@ struct setting non-nullptr. */ void *m_var = nullptr; + /* Any extra literals accepted. */ + const void *m_extra_literals = nullptr; + /* Pointer to a user provided getter. */ erased_func m_getter = nullptr; @@ -651,6 +666,11 @@ typedef void (show_value_ftype) (struct instead print the value out directly. */ extern show_value_ftype deprecated_show_value_hack; +/* Various sets of extra literals accepted. */ +extern const literal_def integer_unlimited_literals[]; +extern const literal_def uinteger_unlimited_literals[]; +extern const literal_def pinteger_unlimited_literals[]; + extern set_show_commands add_setshow_enum_cmd (const char *name, command_class theclass, const char *const *enumlist, const char **var, const char *set_doc, const char *show_doc, @@ -747,6 +767,20 @@ extern set_show_commands add_setshow_opt cmd_list_element **show_list); extern set_show_commands add_setshow_integer_cmd + (const char *name, command_class theclass, int *var, + const literal_def *extra_literals, const char *set_doc, + const char *show_doc, const char *help_doc, cmd_func_ftype *set_func, + show_value_ftype *show_func, cmd_list_element **set_list, + cmd_list_element **show_list); + +extern set_show_commands add_setshow_integer_cmd + (const char *name, command_class theclass, const literal_def *extra_literals, + const char *set_doc, const char *show_doc, const char *help_doc, + setting_func_types::set set_func, + setting_func_types::get get_func, show_value_ftype *show_func, + cmd_list_element **set_list, cmd_list_element **show_list); + +extern set_show_commands add_setshow_integer_cmd (const char *name, command_class theclass, int *var, const char *set_doc, const char *show_doc, const char *help_doc, cmd_func_ftype *set_func, show_value_ftype *show_func, cmd_list_element **set_list, @@ -759,6 +793,34 @@ extern set_show_commands add_setshow_int setting_func_types::get get_func, show_value_ftype *show_func, cmd_list_element **set_list, cmd_list_element **show_list); +extern set_show_commands add_setshow_pinteger_cmd + (const char *name, command_class theclass, int *var, + const literal_def *extra_literals, const char *set_doc, + const char *show_doc, const char *help_doc, cmd_func_ftype *set_func, + show_value_ftype *show_func, cmd_list_element **set_list, + cmd_list_element **show_list); + +extern set_show_commands add_setshow_pinteger_cmd + (const char *name, command_class theclass, const literal_def *extra_literals, + const char *set_doc, const char *show_doc, const char *help_doc, + setting_func_types::set set_func, + setting_func_types::get get_func, show_value_ftype *show_func, + cmd_list_element **set_list, cmd_list_element **show_list); + +extern set_show_commands add_setshow_uinteger_cmd + (const char *name, command_class theclass, unsigned int *var, + const literal_def *extra_literals, + const char *set_doc, const char *show_doc, const char *help_doc, + cmd_func_ftype *set_func, show_value_ftype *show_func, + cmd_list_element **set_list, cmd_list_element **show_list); + +extern set_show_commands add_setshow_uinteger_cmd + (const char *name, command_class theclass, const literal_def *extra_literals, + const char *set_doc, const char *show_doc, const char *help_doc, + setting_func_types::set set_func, + setting_func_types::get get_func, show_value_ftype *show_func, + cmd_list_element **set_list, cmd_list_element **show_list); + extern set_show_commands add_setshow_uinteger_cmd (const char *name, command_class theclass, unsigned int *var, const char *set_doc, const char *show_doc, const char *help_doc, Index: src/gdb/doc/python.texi =================================================================== --- src.orig/gdb/doc/python.texi +++ src/gdb/doc/python.texi @@ -4599,15 +4599,17 @@ Python, true and false are represented u @findex gdb.PARAM_UINTEGER @item gdb.PARAM_UINTEGER The value is an unsigned integer. The value of @code{None} should be -interpreted to mean ``unlimited'', and the value of 0 is reserved and -should not be used. +interpreted to mean ``unlimited'' (literal @code{'unlimited'} can also +be used to set that value), and the value of 0 is reserved and should +not be used. @findex PARAM_INTEGER @findex gdb.PARAM_INTEGER @item gdb.PARAM_INTEGER The value is a signed integer. The value of @code{None} should be -interpreted to mean ``unlimited'', and the value of 0 is reserved and -should not be used. +interpreted to mean ``unlimited'' (literal @code{'unlimited'} can also +be used to set that value), and the value of 0 is reserved and should +not be used. @findex PARAM_STRING @findex gdb.PARAM_STRING @@ -4651,7 +4653,8 @@ except that 0 is allowed and the value o @item gdb.PARAM_ZUINTEGER_UNLIMITED The value is a signed integer. This is like @code{PARAM_INTEGER} including that the value of @code{None} should be interpreted to mean -``unlimited'', except that 0 is allowed, and the value cannot be negative. +``unlimited'' (literal @code{'unlimited'} can also be used to set that +value), except that 0 is allowed, and the value cannot be negative. In GDB version 12 and earlier, a parameter of this type when read would return -1 rather than @code{None} for the setting of ``unlimited''. Index: src/gdb/guile/scm-param.c =================================================================== --- src.orig/gdb/guile/scm-param.c +++ src/gdb/guile/scm-param.c @@ -75,9 +75,15 @@ struct param_smob /* One of the COMMAND_* constants. */ enum command_class cmd_class; + /* Guile parameter type name. */ + const char *pname; + /* The type of the parameter. */ enum var_types type; + /* Extra literals, such as `unlimited', accepted in lieu of a number. */ + const literal_def *extra_literals; + /* The docs for the parameter. */ char *set_doc; char *show_doc; @@ -110,6 +116,50 @@ struct param_smob SCM containing_scm; }; +/* Guile parameter types as in PARAMETER_TYPES later on. */ + +typedef enum param_types + { + param_boolean, + param_auto_boolean, + param_zinteger, + param_uinteger, + param_zuinteger, + param_zuinteger_unlimited, + param_string, + param_string_noescape, + param_optional_filename, + param_filename, + param_enum, + } +param_types; + +/* Translation from Guile parameters to GDB variable types. Keep in the + same order as PARAM_TYPES due to C++'s lack of designated initializers. */ + +static const struct + { + /* The type of the parameter. */ + enum var_types type; + + /* Extra literals, such as `unlimited', accepted in lieu of a number. */ + const literal_def *extra_literals; + } +param_to_var[] = + { + { var_boolean }, + { var_auto_boolean }, + { var_integer }, + { var_uinteger, uinteger_unlimited_literals }, + { var_uinteger }, + { var_pinteger, pinteger_unlimited_literals }, + { var_string }, + { var_string_noescape }, + { var_optional_filename }, + { var_filename }, + { var_enum } + }; + /* Wraps a setting around an existing param_smob. This abstraction is used to manipulate the value in S->VALUE in a type safe manner using the setting interface. */ @@ -117,18 +167,20 @@ struct param_smob static setting make_setting (param_smob *s) { - if (var_type_uses (s->type)) - return setting (s->type, &s->value.boolval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.intval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.autoboolval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.uintval); - else if (var_type_uses (s->type)) - return setting (s->type, s->value.stringval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.cstringval); + enum var_types type = s->type; + + if (var_type_uses (type)) + return setting (type, &s->value.boolval); + else if (var_type_uses (type)) + return setting (type, &s->value.intval, s->extra_literals); + else if (var_type_uses (type)) + return setting (type, &s->value.autoboolval); + else if (var_type_uses (type)) + return setting (type, &s->value.uintval, s->extra_literals); + else if (var_type_uses (type)) + return setting (type, s->value.stringval); + else if (var_type_uses (type)) + return setting (type, &s->value.cstringval); else gdb_assert_not_reached ("unhandled var type"); } @@ -149,10 +201,9 @@ static SCM set_doc_keyword; static SCM show_doc_keyword; static SCM initial_value_keyword; static SCM auto_keyword; -static SCM unlimited_keyword; static int pascm_is_valid (param_smob *); -static const char *pascm_param_type_name (enum var_types type); +static const char *pascm_param_type_name (enum param_types type); static SCM pascm_param_value (const setting &var, int arg_pos, const char *func_name); @@ -171,7 +222,7 @@ pascm_print_param_smob (SCM self, SCM po if (! pascm_is_valid (p_smob)) scm_puts (" {invalid}", port); - gdbscm_printf (port, " %s ", pascm_param_type_name (p_smob->type)); + gdbscm_printf (port, " %s ", p_smob->pname); value = pascm_param_value (make_setting (p_smob), GDBSCM_ARG_NONE, NULL); scm_display (value, port); @@ -369,7 +420,9 @@ pascm_show_func (struct ui_file *file, i function. */ static set_show_commands -add_setshow_generic (enum var_types param_type, enum command_class cmd_class, +add_setshow_generic (enum var_types param_type, + const literal_def *extra_literals, + enum command_class cmd_class, char *cmd_name, param_smob *self, char *set_doc, char *show_doc, char *help_doc, cmd_func_ftype *set_func, @@ -398,32 +451,26 @@ add_setshow_generic (enum var_types para case var_uinteger: commands = add_setshow_uinteger_cmd (cmd_name, cmd_class, - &self->value.uintval, set_doc, - show_doc, help_doc, set_func, - show_func, set_list, show_list); - break; - - case var_zinteger: - commands = add_setshow_zinteger_cmd (cmd_name, cmd_class, - &self->value.intval, set_doc, + &self->value.uintval, + extra_literals, set_doc, show_doc, help_doc, set_func, show_func, set_list, show_list); break; - case var_zuinteger: - commands = add_setshow_zuinteger_cmd (cmd_name, cmd_class, - &self->value.uintval, set_doc, - show_doc, help_doc, set_func, - show_func, set_list, show_list); + case var_integer: + commands = add_setshow_integer_cmd (cmd_name, cmd_class, + &self->value.intval, + extra_literals, set_doc, + show_doc, help_doc, set_func, + show_func, set_list, show_list); break; - case var_zuinteger_unlimited: - commands = add_setshow_zuinteger_unlimited_cmd (cmd_name, cmd_class, - &self->value.intval, - set_doc, show_doc, - help_doc, set_func, - show_func, set_list, - show_list); + case var_pinteger: + commands = add_setshow_pinteger_cmd (cmd_name, cmd_class, + &self->value.intval, + extra_literals, set_doc, + show_doc, help_doc, set_func, + show_func, set_list, show_list); break; case var_string: @@ -532,19 +579,17 @@ compute_enum_list (SCM enum_values_scm, static const scheme_integer_constant parameter_types[] = { - /* Note: var_integer is deprecated, and intentionally does not - appear here. */ - { "PARAM_BOOLEAN", var_boolean }, /* ARI: var_boolean */ - { "PARAM_AUTO_BOOLEAN", var_auto_boolean }, - { "PARAM_ZINTEGER", var_zinteger }, - { "PARAM_UINTEGER", var_uinteger }, - { "PARAM_ZUINTEGER", var_zuinteger }, - { "PARAM_ZUINTEGER_UNLIMITED", var_zuinteger_unlimited }, - { "PARAM_STRING", var_string }, - { "PARAM_STRING_NOESCAPE", var_string_noescape }, - { "PARAM_OPTIONAL_FILENAME", var_optional_filename }, - { "PARAM_FILENAME", var_filename }, - { "PARAM_ENUM", var_enum }, + { "PARAM_BOOLEAN", param_boolean }, /* ARI: param_boolean */ + { "PARAM_AUTO_BOOLEAN", param_auto_boolean }, + { "PARAM_ZINTEGER", param_zinteger }, + { "PARAM_UINTEGER", param_uinteger }, + { "PARAM_ZUINTEGER", param_zuinteger }, + { "PARAM_ZUINTEGER_UNLIMITED", param_zuinteger_unlimited }, + { "PARAM_STRING", param_string }, + { "PARAM_STRING_NOESCAPE", param_string_noescape }, + { "PARAM_OPTIONAL_FILENAME", param_optional_filename }, + { "PARAM_FILENAME", param_filename }, + { "PARAM_ENUM", param_enum }, END_INTEGER_CONSTANTS }; @@ -568,7 +613,7 @@ pascm_valid_parameter_type_p (int param_ /* Return PARAM_TYPE as a string. */ static const char * -pascm_param_type_name (enum var_types param_type) +pascm_param_type_name (enum param_types param_type) { int i; @@ -588,10 +633,6 @@ pascm_param_type_name (enum var_types pa static SCM pascm_param_value (const setting &var, int arg_pos, const char *func_name) { - /* Note: We *could* support var_integer here in case someone is trying to get - the value of a Python-created parameter (which is the only place that - still supports var_integer). To further discourage its use we do not. */ - switch (var.type ()) { case var_string: @@ -631,20 +672,29 @@ pascm_param_value (const setting &var, i return auto_keyword; } - case var_zuinteger_unlimited: - if (var.get () == -1) - return unlimited_keyword; - gdb_assert (var.get () >= 0); - /* Fall through. */ - case var_zinteger: - return scm_from_int (var.get ()); - case var_uinteger: - if (var.get ()== UINT_MAX) - return unlimited_keyword; - /* Fall through. */ - case var_zuinteger: - return scm_from_uint (var.get ()); + case var_integer: + case var_pinteger: + { + LONGEST value + = (var.type () == var_uinteger + ? static_cast (var.get ()) + : static_cast (var.get ())); + + if (var.extra_literals () != nullptr) + for (const literal_def *l = var.extra_literals (); + l->literal != nullptr; + l++) + if (value == l->use) + return scm_from_latin1_keyword (l->literal); + if (var.type () == var_pinteger) + gdb_assert (value >= 0); + + if (var.type () == var_uinteger) + return scm_from_uint (static_cast (value)); + else + return scm_from_int (static_cast (value)); + } default: break; @@ -735,53 +785,91 @@ pascm_set_param_value_x (param_smob *p_s var.set (AUTO_BOOLEAN_FALSE); break; - case var_zinteger: + case var_integer: case var_uinteger: - case var_zuinteger: - case var_zuinteger_unlimited: - if (var.type () == var_uinteger - || var.type () == var_zuinteger_unlimited) - { - SCM_ASSERT_TYPE (scm_is_integer (value) - || scm_is_eq (value, unlimited_keyword), - value, arg_pos, func_name, - _("integer or #:unlimited")); - if (scm_is_eq (value, unlimited_keyword)) + case var_pinteger: + { + const literal_def *extra_literals = p_smob->extra_literals; + enum tribool allowed = TRIBOOL_UNKNOWN; + enum var_types var_type = var.type (); + bool integer = scm_is_integer (value); + bool keyword = scm_is_keyword (value); + std::string buffer = ""; + size_t count = 0; + LONGEST val; + + if (extra_literals != nullptr) + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++, count++) { - if (var.type () == var_uinteger) - var.set (UINT_MAX); - else - var.set (-1); - break; + if (count != 0) + buffer += ", "; + buffer = buffer + "#:" + l->literal; + if (keyword + && allowed == TRIBOOL_UNKNOWN + && scm_is_eq (value, + scm_from_latin1_keyword (l->literal))) + { + val = l->use; + allowed = TRIBOOL_TRUE; + } } - } - else - { - SCM_ASSERT_TYPE (scm_is_integer (value), value, arg_pos, func_name, - _("integer")); - } - if (var.type () == var_uinteger - || var.type () == var_zuinteger) - { - unsigned int u = scm_to_uint (value); + if (allowed == TRIBOOL_UNKNOWN) + { + if (extra_literals == nullptr) + SCM_ASSERT_TYPE (integer, value, arg_pos, func_name, + _("integer")); + else if (count > 1) + SCM_ASSERT_TYPE (integer, value, arg_pos, func_name, + string_printf (_("integer or one of: %s"), + buffer.c_str ()).c_str ()); + else + SCM_ASSERT_TYPE (integer, value, arg_pos, func_name, + string_printf (_("integer or %s"), + buffer.c_str ()).c_str ()); - if (var.type () == var_uinteger && u == 0) - u = UINT_MAX; - var.set (u); - } - else - { - int i = scm_to_int (value); + val = (var_type == var_uinteger + ? static_cast (scm_to_uint (value)) + : static_cast (scm_to_int (value))); - if (var.type () == var_zuinteger_unlimited && i < -1) - { - gdbscm_out_of_range_error (func_name, arg_pos, value, - _("must be >= -1")); + if (extra_literals != nullptr) + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++) + { + if (l->val.has_value () && val == *l->val) + { + allowed = TRIBOOL_TRUE; + val = l->use; + break; + } + else if (val == l->use) + allowed = TRIBOOL_FALSE; + } } - var.set (i); - } - break; + + if (allowed == TRIBOOL_UNKNOWN) + { + if (val > UINT_MAX || val < INT_MIN + || (var_type == var_uinteger && val < 0) + || (var_type == var_integer && val > INT_MAX) + || (var_type == var_pinteger && val < 0) + || (var_type == var_pinteger && val > INT_MAX)) + allowed = TRIBOOL_FALSE; + } + if (allowed == TRIBOOL_FALSE) + gdbscm_out_of_range_error (func_name, arg_pos, value, + _("integer out of range")); + + if (var_type == var_uinteger) + var.set (static_cast (val)); + else + var.set (static_cast (val)); + + break; + } default: gdb_assert_not_reached ("bad parameter type"); @@ -858,7 +946,7 @@ gdbscm_make_parameter (SCM name_scm, SCM char *s; char *name; int cmd_class = no_class; - int param_type = var_boolean; /* ARI: var_boolean */ + int param_type = param_boolean; /* ARI: param_boolean */ SCM enum_list_scm = SCM_BOOL_F; SCM set_func = SCM_BOOL_F, show_func = SCM_BOOL_F; char *doc = NULL, *set_doc = NULL, *show_doc = NULL; @@ -913,12 +1001,12 @@ gdbscm_make_parameter (SCM name_scm, SCM scm_from_int (param_type), _("invalid parameter type argument")); } - if (enum_list_arg_pos > 0 && param_type != var_enum) + if (enum_list_arg_pos > 0 && param_type != param_enum) { gdbscm_misc_error (FUNC_NAME, enum_list_arg_pos, enum_list_scm, _("#:enum-values can only be provided with PARAM_ENUM")); } - if (enum_list_arg_pos < 0 && param_type == var_enum) + if (enum_list_arg_pos < 0 && param_type == param_enum) { gdbscm_misc_error (FUNC_NAME, GDBSCM_ARG_NONE, SCM_BOOL_F, _("PARAM_ENUM requires an enum-values argument")); @@ -933,7 +1021,7 @@ gdbscm_make_parameter (SCM name_scm, SCM SCM_ASSERT_TYPE (gdbscm_is_procedure (show_func), show_func, show_func_arg_pos, FUNC_NAME, _("procedure")); } - if (param_type == var_enum) + if (param_type == param_enum) { /* Note: enum_list lives in GC space, so we don't have to worry about freeing it if we later throw an exception. */ @@ -950,7 +1038,10 @@ gdbscm_make_parameter (SCM name_scm, SCM freeing them if we throw an exception. */ p_smob->name = name; p_smob->cmd_class = (enum command_class) cmd_class; - p_smob->type = (enum var_types) param_type; + p_smob->pname + = pascm_param_type_name (static_cast (param_type)); + p_smob->type = param_to_var[param_type].type; + p_smob->extra_literals = param_to_var[param_type].extra_literals; p_smob->doc = doc; p_smob->set_doc = set_doc; p_smob->show_doc = show_doc; @@ -1031,7 +1122,8 @@ gdbscm_register_parameter_x (SCM self) try { p_smob->commands = add_setshow_generic - (p_smob->type, p_smob->cmd_class, p_smob->cmd_name, p_smob, + (p_smob->type, p_smob->extra_literals, + p_smob->cmd_class, p_smob->cmd_name, p_smob, p_smob->set_doc, p_smob->show_doc, p_smob->doc, (gdbscm_is_procedure (p_smob->set_func) ? pascm_set_func : NULL), (gdbscm_is_procedure (p_smob->show_func) ? pascm_show_func : NULL), @@ -1203,5 +1295,4 @@ gdbscm_initialize_parameters (void) show_doc_keyword = scm_from_latin1_keyword ("show-doc"); initial_value_keyword = scm_from_latin1_keyword ("initial-value"); auto_keyword = scm_from_latin1_keyword ("auto"); - unlimited_keyword = scm_from_latin1_keyword ("unlimited"); } Index: src/gdb/maint-test-options.c =================================================================== --- src.orig/gdb/maint-test-options.c +++ src/gdb/maint-test-options.c @@ -61,13 +61,15 @@ available kinds of commands (boolean, enum, flag, string, uinteger): (gdb) maint test-options require-delimiter -[TAB] - -bool -enum -flag -string -uinteger -xx1 -xx2 + -bool -pinteger-unlimited -xx1 + -enum -string -xx2 + -flag -uinteger-unlimited (gdb) maint test-options require-delimiter -bool o[TAB] off on (gdb) maint test-options require-delimiter -enum [TAB] xxx yyy zzz - (gdb) maint test-options require-delimiter -uinteger [TAB] + (gdb) maint test-options require-delimiter -uinteger-unlimited [TAB] NUMBER unlimited '-xx1' and '-xx2' are flag options too. They exist in order to @@ -76,14 +78,14 @@ Invoking the commands makes them print out the options parsed: (gdb) maint test-options unknown-is-error -flag -enum yyy cmdarg - -flag 1 -xx1 0 -xx2 0 -bool 0 -enum yyy -uint 0 -zuint-unl 0 -- cmdarg + -flag 1 -xx1 0 -xx2 0 -bool 0 -enum yyy -uint-unl 0 -pint-unl 0 -string '' -- cmdarg (gdb) maint test-options require-delimiter -flag -enum yyy cmdarg - -flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint 0 -zuint-unl 0 -- -flag -enum yyy cmdarg + -flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint-unl 0 -pint-unl 0 -string '' -- -flag -enum yyy cmdarg (gdb) maint test-options require-delimiter -flag -enum yyy cmdarg -- Unrecognized option at: cmdarg -- (gdb) maint test-options require-delimiter -flag -enum yyy -- cmdarg - -flag 1 -xx1 0 -xx2 0 -bool 0 -enum yyy -uint 0 -zuint-unl 0 -- cmdarg + -flag 1 -xx1 0 -xx2 0 -bool 0 -enum yyy -uint-unl 0 -pint-unl 0 -string '' -- cmdarg The "maint show test-options-completion-result" command exists in order to do something similar for completion: @@ -131,8 +133,8 @@ struct test_options_opts bool xx2_opt = false; bool boolean_opt = false; const char *enum_opt = test_options_enum_values_xxx; - unsigned int uint_opt = 0; - int zuint_unl_opt = 0; + unsigned int uint_unl_opt = 0; + int pint_unl_opt = 0; std::string string_opt; test_options_opts () = default; @@ -145,18 +147,18 @@ struct test_options_opts { gdb_printf (file, _("-flag %d -xx1 %d -xx2 %d -bool %d " - "-enum %s -uint %s -zuint-unl %s -string '%s' -- %s\n"), + "-enum %s -uint-unl %s -pint-unl %s -string '%s' -- %s\n"), flag_opt, xx1_opt, xx2_opt, boolean_opt, enum_opt, - (uint_opt == UINT_MAX + (uint_unl_opt == UINT_MAX ? "unlimited" - : pulongest (uint_opt)), - (zuint_unl_opt == -1 + : pulongest (uint_unl_opt)), + (pint_unl_opt == -1 ? "unlimited" - : plongest (zuint_unl_opt)), + : plongest (pint_unl_opt)), string_opt.c_str (), args); } @@ -203,22 +205,24 @@ static const gdb::option::option_def tes N_("An enum option."), }, - /* A uinteger option. */ + /* A uinteger + "unlimited" option. */ gdb::option::uinteger_option_def { - "uinteger", - [] (test_options_opts *opts) { return &opts->uint_opt; }, + "uinteger-unlimited", + [] (test_options_opts *opts) { return &opts->uint_unl_opt; }, + uinteger_unlimited_literals, nullptr, /* show_cmd_cb */ N_("A uinteger option."), nullptr, /* show_doc */ N_("A help doc that spawns\nmultiple lines."), }, - /* A zuinteger_unlimited option. */ - gdb::option::zuinteger_unlimited_option_def { - "zuinteger-unlimited", - [] (test_options_opts *opts) { return &opts->zuint_unl_opt; }, + /* A pinteger + "unlimited" option. */ + gdb::option::pinteger_option_def { + "pinteger-unlimited", + [] (test_options_opts *opts) { return &opts->pint_unl_opt; }, + pinteger_unlimited_literals, nullptr, /* show_cmd_cb */ - N_("A zuinteger-unlimited option."), + N_("A pinteger-unlimited option."), nullptr, /* show_doc */ nullptr, /* help_doc */ }, Index: src/gdb/python/py-param.c =================================================================== --- src.orig/gdb/python/py-param.c +++ src/gdb/python/py-param.c @@ -28,24 +28,70 @@ #include "language.h" #include "arch-utils.h" +/* Python parameter types as in PARM_CONSTANTS below. */ + +typedef enum param_types + { + param_boolean, + param_auto_boolean, + param_uinteger, + param_integer, + param_string, + param_string_noescape, + param_optional_filename, + param_filename, + param_zinteger, + param_zuinteger, + param_zuinteger_unlimited, + param_enum, + } +param_types; + +/* Translation from Python parameters to GDB variable types. Keep in the + same order as PARAM_TYPES due to C++'s lack of designated initializers. */ + +static const struct + { + /* The type of the parameter. */ + enum var_types type; + + /* Extra literals, such as `unlimited', accepted in lieu of a number. */ + const literal_def *extra_literals; + } +param_to_var[] = + { + { var_boolean }, + { var_auto_boolean }, + { var_uinteger, uinteger_unlimited_literals }, + { var_integer, integer_unlimited_literals }, + { var_string }, + { var_string_noescape }, + { var_optional_filename }, + { var_filename }, + { var_integer }, + { var_uinteger }, + { var_pinteger, pinteger_unlimited_literals }, + { var_enum } + }; + /* Parameter constants and their values. */ static struct { const char *name; int value; } parm_constants[] = { - { "PARAM_BOOLEAN", var_boolean }, /* ARI: var_boolean */ - { "PARAM_AUTO_BOOLEAN", var_auto_boolean }, - { "PARAM_UINTEGER", var_uinteger }, - { "PARAM_INTEGER", var_integer }, - { "PARAM_STRING", var_string }, - { "PARAM_STRING_NOESCAPE", var_string_noescape }, - { "PARAM_OPTIONAL_FILENAME", var_optional_filename }, - { "PARAM_FILENAME", var_filename }, - { "PARAM_ZINTEGER", var_zinteger }, - { "PARAM_ZUINTEGER", var_zuinteger }, - { "PARAM_ZUINTEGER_UNLIMITED", var_zuinteger_unlimited }, - { "PARAM_ENUM", var_enum }, + { "PARAM_BOOLEAN", param_boolean }, /* ARI: param_boolean */ + { "PARAM_AUTO_BOOLEAN", param_auto_boolean }, + { "PARAM_UINTEGER", param_uinteger }, + { "PARAM_INTEGER", param_integer }, + { "PARAM_STRING", param_string }, + { "PARAM_STRING_NOESCAPE", param_string_noescape }, + { "PARAM_OPTIONAL_FILENAME", param_optional_filename }, + { "PARAM_FILENAME", param_filename }, + { "PARAM_ZINTEGER", param_zinteger }, + { "PARAM_ZUINTEGER", param_zuinteger }, + { "PARAM_ZUINTEGER_UNLIMITED", param_zuinteger_unlimited }, + { "PARAM_ENUM", param_enum }, { NULL, 0 } }; @@ -80,6 +126,9 @@ struct parmpy_object /* The type of the parameter. */ enum var_types type; + /* Extra literals, such as `unlimited', accepted in lieu of a number. */ + const literal_def *extra_literals; + /* The value of the parameter. */ union parmpy_variable value; @@ -96,18 +145,20 @@ struct parmpy_object static setting make_setting (parmpy_object *s) { - if (var_type_uses (s->type)) - return setting (s->type, &s->value.boolval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.intval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.autoboolval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.uintval); - else if (var_type_uses (s->type)) - return setting (s->type, s->value.stringval); - else if (var_type_uses (s->type)) - return setting (s->type, &s->value.cstringval); + enum var_types type = s->type; + + if (var_type_uses (type)) + return setting (type, &s->value.boolval); + else if (var_type_uses (type)) + return setting (type, &s->value.intval, s->extra_literals); + else if (var_type_uses (type)) + return setting (type, &s->value.autoboolval); + else if (var_type_uses (type)) + return setting (type, &s->value.uintval, s->extra_literals); + else if (var_type_uses (type)) + return setting (type, s->value.stringval); + else if (var_type_uses (type)) + return setting (type, &s->value.cstringval); else gdb_assert_not_reached ("unhandled var type"); } @@ -234,68 +285,98 @@ set_parameter_value (parmpy_object *self } break; - case var_integer: - case var_zinteger: case var_uinteger: - case var_zuinteger: - case var_zuinteger_unlimited: + case var_integer: + case var_pinteger: { - long l; - int ok; + const literal_def *extra_literals = self->extra_literals; + enum tribool allowed = TRIBOOL_UNKNOWN; + enum var_types var_type = self->type; + std::string buffer = ""; + size_t count = 0; + LONGEST val; - if (value == Py_None - && (self->type == var_uinteger || self->type == var_integer)) - l = 0; - else if (value == Py_None && self->type == var_zuinteger_unlimited) - l = -1; - else if (!PyLong_Check (value)) + if (extra_literals != nullptr) { - PyErr_SetString (PyExc_RuntimeError, - _("The value must be integer.")); - return -1; + gdb::unique_xmalloc_ptr + str (python_string_to_host_string (value)); + const char *s = str != nullptr ? str.get () : nullptr; + PyErr_Clear (); + + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++, count++) + { + if (count != 0) + buffer += ", "; + buffer = buffer + "'" + l->literal + "'"; + if (allowed == TRIBOOL_UNKNOWN + && ((value == Py_None && !strcmp ("unlimited", l->literal)) + || (s != nullptr && !strcmp (s, l->literal)))) + { + val = l->use; + allowed = TRIBOOL_TRUE; + } + } } - else if (! gdb_py_int_as_long (value, &l)) - return -1; - switch (self->type) + if (allowed == TRIBOOL_UNKNOWN) { - case var_uinteger: - if (l == 0) - l = UINT_MAX; - /* Fall through. */ - case var_zuinteger: - ok = (l >= 0 && l <= UINT_MAX); - break; + val = PyLong_AsLongLong (value); - case var_zuinteger_unlimited: - ok = (l >= -1 && l <= INT_MAX); - break; + if (PyErr_Occurred ()) + { + if (extra_literals == nullptr) + PyErr_SetString (PyExc_RuntimeError, + _("The value must be integer.")); + else if (count > 1) + PyErr_SetString (PyExc_RuntimeError, + string_printf (_("integer or one of: %s"), + buffer.c_str ()).c_str ()); + else + PyErr_SetString (PyExc_RuntimeError, + string_printf (_("integer or %s"), + buffer.c_str ()).c_str ()); + return -1; + } - case var_integer: - ok = (l >= INT_MIN && l <= INT_MAX); - if (l == 0) - l = INT_MAX; - break; - case var_zinteger: - ok = (l >= INT_MIN && l <= INT_MAX); - break; + if (extra_literals != nullptr) + for (const literal_def *l = extra_literals; + l->literal != nullptr; + l++) + { + if (l->val.has_value () && val == *l->val) + { + allowed = TRIBOOL_TRUE; + val = l->use; + break; + } + else if (val == l->use) + allowed = TRIBOOL_FALSE; + } + } - default: - gdb_assert_not_reached ("unknown var_ constant"); + if (allowed == TRIBOOL_UNKNOWN) + { + if (val > UINT_MAX || val < INT_MIN + || (var_type == var_uinteger && val < 0) + || (var_type == var_integer && val > INT_MAX) + || (var_type == var_pinteger && val < 0) + || (var_type == var_pinteger && val > INT_MAX)) + allowed = TRIBOOL_FALSE; } - - if (! ok) + if (allowed == TRIBOOL_FALSE) { PyErr_SetString (PyExc_RuntimeError, _("Range exceeded.")); return -1; } - if (self->type == var_uinteger || self->type == var_zuinteger) - self->value.uintval = (unsigned) l; + if (self->type == var_uinteger) + self->value.uintval = (unsigned) val; else - self->value.intval = (int) l; + self->value.intval = (int) val; break; } @@ -534,7 +615,8 @@ get_show_value (struct ui_file *file, in /* A helper function that dispatches to the appropriate add_setshow function. */ static void -add_setshow_generic (int parmclass, enum command_class cmdclass, +add_setshow_generic (enum var_types type, const literal_def *extra_literals, + enum command_class cmdclass, gdb::unique_xmalloc_ptr cmd_name, parmpy_object *self, const char *set_doc, const char *show_doc, @@ -544,7 +626,7 @@ add_setshow_generic (int parmclass, enum { set_show_commands commands; - switch (parmclass) + switch (type) { case var_boolean: commands = add_setshow_boolean_cmd (cmd_name.get (), cmdclass, @@ -564,18 +646,28 @@ add_setshow_generic (int parmclass, enum case var_uinteger: commands = add_setshow_uinteger_cmd (cmd_name.get (), cmdclass, - &self->value.uintval, set_doc, + &self->value.uintval, + extra_literals, set_doc, show_doc, help_doc, get_set_value, get_show_value, set_list, show_list); break; case var_integer: commands = add_setshow_integer_cmd (cmd_name.get (), cmdclass, - &self->value.intval, set_doc, + &self->value.intval, + extra_literals, set_doc, show_doc, help_doc, get_set_value, get_show_value, set_list, show_list); break; + case var_pinteger: + commands = add_setshow_pinteger_cmd (cmd_name.get (), cmdclass, + &self->value.intval, + extra_literals, set_doc, + show_doc, help_doc, get_set_value, + get_show_value, set_list, show_list); + break; + case var_string: commands = add_setshow_string_cmd (cmd_name.get (), cmdclass, self->value.stringval, set_doc, @@ -607,30 +699,6 @@ add_setshow_generic (int parmclass, enum get_show_value, set_list, show_list); break; - case var_zinteger: - commands = add_setshow_zinteger_cmd (cmd_name.get (), cmdclass, - &self->value.intval, set_doc, - show_doc, help_doc, get_set_value, - get_show_value, set_list, show_list); - break; - - case var_zuinteger: - commands = add_setshow_zuinteger_cmd (cmd_name.get (), cmdclass, - &self->value.uintval, set_doc, - show_doc, help_doc, get_set_value, - get_show_value, set_list, - show_list); - break; - - case var_zuinteger_unlimited: - commands = add_setshow_zuinteger_unlimited_cmd (cmd_name.get (), cmdclass, - &self->value.intval, - set_doc, show_doc, - help_doc, get_set_value, - get_show_value, set_list, - show_list); - break; - case var_enum: /* Initialize the value, just in case. */ self->value.cstringval = self->enumeration[0]; @@ -740,6 +808,8 @@ parmpy_init (PyObject *self, PyObject *a int parmclass, cmdtype; PyObject *enum_values = NULL; struct cmd_list_element **set_list, **show_list; + const literal_def *extra_literals; + enum var_types type; if (! PyArg_ParseTuple (args, "sii|O", &name, &cmdtype, &parmclass, &enum_values)) @@ -756,33 +826,36 @@ parmpy_init (PyObject *self, PyObject *a return -1; } - if (parmclass != var_boolean /* ARI: var_boolean */ - && parmclass != var_auto_boolean - && parmclass != var_uinteger && parmclass != var_integer - && parmclass != var_string && parmclass != var_string_noescape - && parmclass != var_optional_filename && parmclass != var_filename - && parmclass != var_zinteger && parmclass != var_zuinteger - && parmclass != var_zuinteger_unlimited && parmclass != var_enum) + if (parmclass != param_boolean /* ARI: param_boolean */ + && parmclass != param_auto_boolean + && parmclass != param_uinteger && parmclass != param_integer + && parmclass != param_string && parmclass != param_string_noescape + && parmclass != param_optional_filename && parmclass != param_filename + && parmclass != param_zinteger && parmclass != param_zuinteger + && parmclass != param_zuinteger_unlimited && parmclass != param_enum) { PyErr_SetString (PyExc_RuntimeError, _("Invalid parameter class argument.")); return -1; } - if (enum_values && parmclass != var_enum) + if (enum_values && parmclass != param_enum) { PyErr_SetString (PyExc_RuntimeError, _("Only PARAM_ENUM accepts a fourth argument.")); return -1; } - if (parmclass == var_enum) + if (parmclass == param_enum) { if (! compute_enum_values (obj, enum_values)) return -1; } else obj->enumeration = NULL; - obj->type = (enum var_types) parmclass; + type = param_to_var[parmclass].type; + extra_literals = param_to_var[parmclass].extra_literals; + obj->type = type; + obj->extra_literals = extra_literals; memset (&obj->value, 0, sizeof (obj->value)); if (var_type_uses (obj->type)) @@ -805,7 +878,8 @@ parmpy_init (PyObject *self, PyObject *a try { - add_setshow_generic (parmclass, (enum command_class) cmdtype, + add_setshow_generic (type, extra_literals, + (enum command_class) cmdtype, std::move (cmd_name), obj, set_doc.get (), show_doc.get (), doc.get (), set_list, show_list); Index: src/gdb/python/python.c =================================================================== --- src.orig/gdb/python/python.c +++ src/gdb/python/python.c @@ -504,35 +504,37 @@ gdbpy_parameter_value (const setting &va Py_RETURN_NONE; } - case var_integer: - if (var.get () == INT_MAX) - Py_RETURN_NONE; - /* Fall through. */ - case var_zinteger: - return gdb_py_object_from_longest (var.get ()).release (); - - case var_zuinteger_unlimited: - { - int val = var.get (); - - if (val == -1) - Py_RETURN_NONE; - return gdb_py_object_from_longest (val).release (); - } - case var_uinteger: + case var_integer: + case var_pinteger: { - unsigned int val = var.get (); + LONGEST value + = (var.type () == var_uinteger + ? static_cast (var.get ()) + : static_cast (var.get ())); - if (val == UINT_MAX) - Py_RETURN_NONE; - return gdb_py_object_from_ulongest (val).release (); - } + if (var.extra_literals () != nullptr) + for (const literal_def *l = var.extra_literals (); + l->literal != nullptr; + l++) + if (value == l->use) + { + if (strcmp (l->literal, "unlimited") == 0) + Py_RETURN_NONE; + else if (l->val.has_value ()) + value = *l->val; + else + return host_string_to_python_string (l->literal).release (); + } - case var_zuinteger: - { - unsigned int val = var.get (); - return gdb_py_object_from_ulongest (val).release (); + if (var.type () == var_uinteger) + return + gdb_py_object_from_ulongest + (static_cast (value)).release (); + else + return + gdb_py_object_from_longest + (static_cast (value)).release (); } } Index: src/gdb/testsuite/gdb.base/max-value-size.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/max-value-size.exp +++ src/gdb/testsuite/gdb.base/max-value-size.exp @@ -92,4 +92,4 @@ gdb_test "set max-value-size 1" \ gdb_test "set max-value-size 0" \ "max-value-size set too low, increasing to \[0-9\]+ bytes" gdb_test "set max-value-size -5" \ - "only -1 is allowed to set as unlimited" + "integer -5 out of range" Index: src/gdb/testsuite/gdb.base/options.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/options.exp +++ src/gdb/testsuite/gdb.base/options.exp @@ -97,19 +97,22 @@ proc make_cmd {variant} { # test-options xxx", with no flag/option set. OPERAND is the expected # operand. proc expect_none {operand} { - return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint 0 -zuint-unl 0 -string '' -- $operand" + return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint-unl 0 -pint-unl 0\ + -string '' -- $operand" } # Return a string for the expected result of running "maint # test-options xxx", with -flag set. OPERAND is the expected operand. proc expect_flag {operand} { - return "-flag 1 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint 0 -zuint-unl 0 -string '' -- $operand" + return "-flag 1 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint-unl 0 -pint-unl 0\ + -string '' -- $operand" } # Return a string for the expected result of running "maint # test-options xxx", with -bool set. OPERAND is the expected operand. proc expect_bool {operand} { - return "-flag 0 -xx1 0 -xx2 0 -bool 1 -enum xxx -uint 0 -zuint-unl 0 -string '' -- $operand" + return "-flag 0 -xx1 0 -xx2 0 -bool 1 -enum xxx -uint-unl 0 -pint-unl 0\ + -string '' -- $operand" } # Return a string for the expected result of running "maint @@ -117,10 +120,12 @@ proc expect_bool {operand} { # OPTION determines which option to expect set. OPERAND is the # expected operand. proc expect_integer {option val operand} { - if {$option == "uinteger"} { - return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint $val -zuint-unl 0 -string '' -- $operand" - } elseif {$option == "zuinteger-unlimited"} { - return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint 0 -zuint-unl $val -string '' -- $operand" + if {$option == "uinteger-unlimited"} { + return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint-unl $val\ + -pint-unl 0 -string '' -- $operand" + } elseif {$option == "pinteger-unlimited"} { + return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint-unl 0\ + -pint-unl $val -string '' -- $operand" } else { error "unsupported option: $option" } @@ -137,18 +142,19 @@ proc expect_string {str operand} { && [string range $str end end] == "'")} { set str [string range $str 1 end-1] } - return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint 0 -zuint-unl 0 -string '$str' -- $operand" + return "-flag 0 -xx1 0 -xx2 0 -bool 0 -enum xxx -uint-unl 0 -pint-unl 0\ + -string '$str' -- $operand" } set all_options { "-bool" "-enum" "-flag" + "-pinteger-unlimited" "-string" - "-uinteger" + "-uinteger-unlimited" "-xx1" "-xx2" - "-zuinteger-unlimited" } # Basic option-machinery + "print" command integration tests. @@ -603,7 +609,8 @@ proc_with_prefix test-flag {variant} { # Extract twice the same flag, separated by one space. gdb_test "$cmd -xx1 -xx2 -xx1 -xx2 -xx1 -- non flags args" \ - "-flag 0 -xx1 1 -xx2 1 -bool 0 -enum xxx -uint 0 -zuint-unl 0 -string '' -- non flags args" + "-flag 0 -xx1 1 -xx2 1 -bool 0 -enum xxx -uint-unl 0 -pint-unl 0\ + -string '' -- non flags args" # Extract 2 known flags in front of unknown flags. gdb_test "$cmd -xx1 -xx2 -a -b -c -xx1 --" \ @@ -821,13 +828,13 @@ proc_with_prefix test-boolean {variant} } # Uinteger option tests. OPTION is which integer option we're -# testing. Can be "uinteger" or "zuinteger-unlimited". +# testing. Can be "uinteger-unlimited" or "pinteger-unlimited". proc_with_prefix test-uinteger {variant option} { global all_options set cmd "[make_cmd $variant] -$option" - # Test completing a uinteger option: + # Test completing an integer option: res_test_gdb_complete_multiple \ "1 [expect_none ""]" \ "$cmd " "" "" { @@ -851,7 +858,7 @@ proc_with_prefix test-uinteger {variant gdb_test "$cmd 1 -- 999" [expect_integer $option "1" "999"] gdb_test "$cmd unlimited -- 999" \ [expect_integer $option "unlimited" "999"] - if {$option == "zuinteger-unlimited"} { + if {$option == "pinteger-unlimited"} { gdb_test "$cmd -1 --" [expect_integer $option "unlimited" ""] gdb_test "$cmd 0 --" [expect_integer $option "0" ""] } else { @@ -864,7 +871,7 @@ proc_with_prefix test-uinteger {variant "Expected integer at: unlimitedx --" # Don't offer completions until we're past the - # -uinteger/-zuinteger-unlimited argument. + # -uinteger-unlimited/-pinteger-unlimited argument. res_test_gdb_complete_none \ "1 [expect_none ""]" \ "$cmd 1" @@ -877,15 +884,15 @@ proc_with_prefix test-uinteger {variant } # Try "-1". - if {$option == "uinteger"} { - # -1 is invalid uinteger. + if {$option == "uinteger-unlimited"} { + # -1 is invalid uinteger-unlimited. foreach value {"-1" "-1 "} { res_test_gdb_complete_none \ "1 [expect_none ""]" \ "$cmd $value" } } else { - # -1 is valid for zuinteger-unlimited. + # -1 is valid for pinteger-unlimited. res_test_gdb_complete_none \ "1 [expect_none ""]" \ "$cmd -1" @@ -913,7 +920,7 @@ proc_with_prefix test-uinteger {variant res_test_gdb_complete_none "0 " "$cmd 1 " } - # Test completing non-option arguments after "-uinteger 1 ". + # Test completing non-option arguments after "-uinteger-unlimited 1 ". foreach operand {"x" "x " "1a" "1a " "1-" "1- "} { if {$variant == "require-delimiter"} { res_test_gdb_complete_none \ @@ -1031,7 +1038,7 @@ foreach_with_prefix cmd { test-misc $cmd test-flag $cmd test-boolean $cmd - foreach subcmd {"uinteger" "zuinteger-unlimited" } { + foreach subcmd {"uinteger-unlimited" "pinteger-unlimited" } { test-uinteger $cmd $subcmd } test-enum $cmd Index: src/gdb/testsuite/gdb.base/settings.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/settings.exp +++ src/gdb/testsuite/gdb.base/settings.exp @@ -143,7 +143,7 @@ proc test-integer {variant} { if {$variant == "zuinteger-unlimited"} { # -1 means unlimited. Other negative values are rejected. -1 # -is tested further below, along the "unlimited" tests. - gdb_test "$set_cmd -2" "only -1 is allowed to set as unlimited" + gdb_test "$set_cmd -2" "integer -2 out of range" check_type "test-settings $variant" "type = int" } elseif {$variant == "uinteger" || $variant == "zuinteger"} { # Negative values are not accepted. Index: src/gdb/testsuite/gdb.base/with.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/with.exp +++ src/gdb/testsuite/gdb.base/with.exp @@ -104,7 +104,7 @@ with_test_prefix "maint" { test_with_error "zuinteger" "" \ "Argument required \\(integer to set it to\\)\\." test_with_error "zuinteger-unlimited" "-2" \ - "only -1 is allowed to set as unlimited" + "integer -2 out of range" test_with_error "zuinteger-unlimited" "" \ "Argument required \\(integer to set it to, or \"unlimited\"\\)\\." test_with_error "filename" "" \ Index: src/gdb/testsuite/gdb.guile/scm-parameter.exp =================================================================== --- src.orig/gdb/testsuite/gdb.guile/scm-parameter.exp +++ src/gdb/testsuite/gdb.guile/scm-parameter.exp @@ -114,24 +114,18 @@ foreach_with_prefix param { \\(3\\) \\(3\\)\\)>" switch -- $param { "listsize" { - set param_get_one $param_type_error - set param_get_zero $param_type_error - set param_get_minus_one $param_type_error - set param_get_unlimited $param_type_error + set param_get_zero "#:unlimited" + set param_get_minus_one -1 set param_set_minus_one "" } "print elements" { - set param_get_one 1 set param_get_zero "#:unlimited" set param_get_minus_one "#:unlimited" - set param_get_unlimited "#:unlimited" set param_set_minus_one $param_range_error } "max-completions" { - set param_get_one 1 set param_get_zero 0 set param_get_minus_one "#:unlimited" - set param_get_unlimited "#:unlimited" set param_set_minus_one "" } default { @@ -142,7 +136,7 @@ foreach_with_prefix param { gdb_test_no_output "set $param 1" "test set to 1" gdb_test "guile (print (parameter-value \"$param\"))" \ - $param_get_one "test value of 1" + 1 "test value of 1" gdb_test_no_output "set $param 0" "test set to 0" @@ -158,7 +152,7 @@ foreach_with_prefix param { gdb_test_no_output "set $param unlimited" "test set to 'unlimited'" gdb_test "guile (print (parameter-value \"$param\"))" \ - $param_get_unlimited "test value of 'unlimited'" + "#:unlimited" "test value of 'unlimited'" } foreach_with_prefix kind { @@ -190,8 +184,7 @@ foreach_with_prefix kind { #:unlimited" \ "Error while executing Scheme code\\."] set param_minus_one_error "integer -1 out of range" - set param_minus_two_range "integer -2 out of range" - set param_minus_two_unlimited "only -1 is allowed to set as unlimited" + set param_minus_two_error "integer -2 out of range" switch -- $kind { PARAM_UINTEGER { set param_get_zero "#:unlimited" @@ -200,7 +193,7 @@ foreach_with_prefix kind { set param_str_unlimited unlimited set param_set_unlimited "" set param_set_minus_one $param_minus_one_error - set param_set_minus_two $param_minus_two_range + set param_set_minus_two $param_minus_two_error } PARAM_ZINTEGER { set param_get_zero 0 @@ -218,7 +211,7 @@ foreach_with_prefix kind { set param_str_unlimited 2 set param_set_unlimited $param_integer_error set param_set_minus_one $param_minus_one_error - set param_set_minus_two $param_minus_two_range + set param_set_minus_two $param_minus_two_error } PARAM_ZUINTEGER_UNLIMITED { set param_get_zero 0 @@ -227,7 +220,7 @@ foreach_with_prefix kind { set param_str_unlimited unlimited set param_set_unlimited "" set param_set_minus_one "" - set param_set_minus_two $param_minus_two_unlimited + set param_set_minus_two $param_minus_two_error } default { error "invalid kind: $kind" Index: src/gdb/testsuite/gdb.python/py-parameter.exp =================================================================== --- src.orig/gdb/testsuite/gdb.python/py-parameter.exp +++ src/gdb/testsuite/gdb.python/py-parameter.exp @@ -429,6 +429,7 @@ proc_with_prefix test_integer_parameter set param_get_minus_one None set param_get_minus_five 1 set param_get_none None + set param_get_unlimited None set param_set_minus_one $param_range_error set param_set_minus_five $param_range_error set param_set_none "" @@ -438,6 +439,7 @@ proc_with_prefix test_integer_parameter set param_get_minus_one -1 set param_get_minus_five -5 set param_get_none None + set param_get_unlimited None set param_set_minus_one -1 set param_set_minus_five -5 set param_set_none "" @@ -447,6 +449,7 @@ proc_with_prefix test_integer_parameter set param_get_minus_one -1 set param_get_minus_five -5 set param_get_none 5 + set param_get_unlimited 0 set param_set_minus_one "" set param_set_minus_five "" set param_set_none $param_integer_error @@ -456,6 +459,7 @@ proc_with_prefix test_integer_parameter set param_get_minus_one 0 set param_get_minus_five 1 set param_get_none 5 + set param_get_unlimited 0 set param_set_minus_one $param_range_error set param_set_minus_five $param_range_error set param_set_none $param_integer_error @@ -465,6 +469,7 @@ proc_with_prefix test_integer_parameter set param_get_minus_one None set param_get_minus_five 1 set param_get_none None + set param_get_unlimited None set param_set_minus_one "" set param_set_minus_five $param_range_error set param_set_none "" @@ -521,6 +526,16 @@ proc_with_prefix test_integer_parameter gdb_test "python print(gdb.parameter('test-$kind'))" \ $param_get_zero "test value of 0 via gdb.parameter" + + py_param_test_maybe_no_output \ + "python test_param_$kind.value = 'unlimited'" \ + $param_set_none "test set to 'unlimited'" + + gdb_test "python print(test_param_$kind.value)" \ + $param_get_unlimited "test value of 'unlimited'" + + gdb_test "python print(gdb.parameter('test-$kind'))" \ + $param_get_unlimited "test value of 'unlimited' via gdb.parameter" } } Index: src/gdb/valprint.c =================================================================== --- src.orig/gdb/valprint.c +++ src/gdb/valprint.c @@ -2861,8 +2861,8 @@ using boolean_option_def = gdb::option::boolean_option_def; using uinteger_option_def = gdb::option::uinteger_option_def; -using zuinteger_unlimited_option_def - = gdb::option::zuinteger_unlimited_option_def; +using pinteger_option_def + = gdb::option::pinteger_option_def; /* Definitions of options for the "print" and "compile print" commands. */ @@ -2907,15 +2907,17 @@ static const gdb::option::option_def val uinteger_option_def { "elements", [] (value_print_options *opt) { return &opt->print_max; }, + uinteger_unlimited_literals, show_print_max, /* show_cmd_cb */ N_("Set limit on string chars or array elements to print."), N_("Show limit on string chars or array elements to print."), N_("\"unlimited\" causes there to be no limit."), }, - zuinteger_unlimited_option_def { + pinteger_option_def { "max-depth", [] (value_print_options *opt) { return &opt->max_depth; }, + pinteger_unlimited_literals, show_print_max_depth, /* show_cmd_cb */ N_("Set maximum print depth for nested structures, unions and arrays."), N_("Show maximum print depth for nested structures, unions, and arrays."), @@ -2975,6 +2977,7 @@ pretty-printers for that value.") uinteger_option_def { "repeats", [] (value_print_options *opt) { return &opt->repeat_count_threshold; }, + uinteger_unlimited_literals, show_repeat_count_threshold, /* show_cmd_cb */ N_("Set threshold for repeated print elements."), N_("Show threshold for repeated print elements."), From patchwork Sat Oct 29 13:53:44 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Maciej W. Rozycki" X-Patchwork-Id: 59621 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 48C273857C59 for ; Sat, 29 Oct 2022 13:54:06 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-wr1-x431.google.com (mail-wr1-x431.google.com [IPv6:2a00:1450:4864:20::431]) by sourceware.org (Postfix) with ESMTPS id 0C0F9385829F for ; Sat, 29 Oct 2022 13:53:48 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 0C0F9385829F Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=embecosm.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=embecosm.com Received: by mail-wr1-x431.google.com with SMTP id k4so459644wri.9 for ; Sat, 29 Oct 2022 06:53:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=embecosm.com; s=google; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=ontCzHdoShQWATB7xYyYJWHYbRHBUmrDr4MbAm1timk=; b=fQxeLqqpfuyYZVe8Aakzub6fd0LLuUvyojoXAfOCcGE6k1OouY85sKRc8qLKr2EI/H EfLOOqE5DFvgvU+NLZSpfjoYEEM9SNtbQgQfzG1SqLsHmuShk2pod3gU6U0iU6Sc0qdJ 35cLVTnbEwddds4UgY4nDKFF91bz3ORcOGIq9UbQOE4xqbRcvKZccwlqg4LjbR7DkleQ knjwdbMjl9I4HdSE8nk0VRgGZuX6G7+IPvS2LFqBsnVWFVp8LsuM7VZjlVfIi+wg5mG7 oJ86bgV/xRsRffNU0dqEJgs4T8aPLrM0q9tgG+xfK7y8pDvB9YeyfmaUdxPHDfND0eof UcYA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=ontCzHdoShQWATB7xYyYJWHYbRHBUmrDr4MbAm1timk=; b=yZs3xCEebsZ6LK+OIm1r06tqbzbWe6ycRwFjVcOeCKy3fugegoiF4BUI9zKjkLRfy2 3Bql37KlelZDg/DNFNirkXdhObMVYrhvV2rmvFAwAaBo9y1PpfZuDQlSVLnHFwO8j2ct tgMTI2VQMBFzCSQwm57AYL9onqf8B+ztwcgzTM2+XvrOD5Y16xK5jiSMJ22ExDA6F6yB KtttFqYKRIS5rzdtgfgvQSmWSmdfXNpCN1mi58uReLnspibB53DxH6kyzNhEiJltRUfs E7sgk5kCLsgjUFLn9oHT/pGklrvzzDz0j2c1kIp0dPwOJlKQprYfopYZw3S2P2680huz clkA== X-Gm-Message-State: ACrzQf1pczzZLWEcnPLe93UNmn/8n08wZAeLmgE9dUP6cIpUVVNekypq 42x9T2LwO2AY+kiD+/tP1FIxVXS+BJ5WEsc+ X-Google-Smtp-Source: AMsMyM5BJwBmQCSFYdm38H/myZvttVbORcsRA106lFhyeaa/jfcDTDvDW0ndqdFCtBdOJRkiEmHTkg== X-Received: by 2002:a05:6000:15c6:b0:22e:5c0c:13d6 with SMTP id y6-20020a05600015c600b0022e5c0c13d6mr2370405wry.485.1667051626402; Sat, 29 Oct 2022 06:53:46 -0700 (PDT) Received: from tpp.orcam.me.uk (tpp.orcam.me.uk. [2001:8b0:154:0:ea6a:64ff:fe24:f2fc]) by smtp.gmail.com with ESMTPSA id d2-20020a05600c34c200b003b3365b38f9sm1766503wmq.10.2022.10.29.06.53.44 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Sat, 29 Oct 2022 06:53:45 -0700 (PDT) Date: Sat, 29 Oct 2022 14:53:44 +0100 (BST) From: "Maciej W. Rozycki" To: gdb-patches@sourceware.org Subject: [PATCH v7 3/4] GDB: Add a character string limiting option In-Reply-To: Message-ID: References: User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 X-Spam-Status: No, score=-2.2 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, KAM_ASCII_DIVIDERS, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=no 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: , Cc: Simon Sobisch , Tom Tromey Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" From: Andrew Burgess This commit splits the `set/show print elements' option into two. We retain `set/show print elements' for controlling how many elements of an array we print, but a new `set/show print characters' setting is added which is used for controlling how many characters of a string are printed. The motivation behind this change is to allow users a finer level of control over how data is printed, reflecting that, although strings can be thought of as arrays of characters, users often want to treat these two things differently. For compatibility reasons by default the `set/show print characters' option is set to `elements', which makes the limit for character strings follow the setting of the `set/show print elements' option, as it used to. Using `set print characters' with any other value makes the limit independent from the `set/show print elements' setting, however it can be restored to the default with the `set print characters elements' command at any time. A corresponding `-characters' option for the `print' command is added, with the same semantics, i.e. one can use `elements' to make a given `print' invocation follow the limit of elements, be it set with the `-elements' option also given with the same invocation or taken from the `set/show print elements' setting, for characters as well regardless of the current setting of the `set/show print characters' option. The GDB changes are all pretty straightforward, just changing references to the old 'print_max' to use a new `get_print_max_chars' helper which figures out which of the two of `print_max' and `print_max_chars' values to use. Likewise, the documentation is just updated to reference the new setting where appropriate. To make people's life easier the message shown by `show print elements' now indicates if the setting also applies to character strings: (gdb) set print characters elements (gdb) show print elements Limit on string chars or array elements to print is 200. (gdb) set print characters unlimited (gdb) show print elements Limit on array elements to print is 200. (gdb) which keeps it the same as it used to be, although in other contexts the setting is described as applying to array elements only, e.g.: (gdb) help set print elements Set limit on array elements to print. "unlimited" causes there to be no limit. (gdb) In the testsuite there are two minor updates, one to add `-characters' to the list of completions now shown for the `print' command, and a bare minimum pair of checks for the right handling of `set print characters' and `show print characters', copied from the corresponding checks for `set print elements' and `show print elements' respectively. Co-Authored-By: Maciej W. Rozycki --- No change from v6. Changes from v5: - Allow the use of `set print characters 0' to stand for `unlimited', and likewise via the corresponding Guile and Python APIs. - Define PRINT_MAX_CHARS_ELEMENTS and PRINT_MAX_CHARS_UNLIMITED macros and use them throughout instead of hardcoded 0/UINT_MAX, making it easier to track usage. Changes from v4: - Move the NEWS entry past GDB 12 and describe `print -characters LIMIT' separately. - Clarify the effect on multi-byte and wide character strings in the manual (borrowing from the original NEWS entry that added support for them). - Fix issues with `@ref' and `@xref' usage in the manual. Changes from v3: - Rewrite in terms of flexible literal keyword handling added with 6/8. - Add a `set print characters elements' setting, which is also the default, to make the string character limit follow that for array elements in backwards-compatible manner. - Update documentation accordingly. - Remove testsuite updates delegated to 8/8, guaranteeing that the new command does not influence any preexisting environment (except for obvious cases where it is expected, such as command completion or help messages). - Amend gdb.base/options.exp for the added completion for `print' command's `-characters' option. - Expand gdb.base/default.exp with minimal test cases for `set/show print characters'. Changes from v2: - Place the new and the changed command at the right places each in NEWS. Changes from v1: - Rename `print_smax' setting throughout to `print_max_chars', and likewise `show_print_smax' function to `show_print_max_chars'. - Document the Python part in the manual. - Update comments for `print_max' and `print_max_chars' in `value_print_options'. - Fix some typos. --- gdb/NEWS | 14 ++++++ gdb/ada-valprint.c | 6 +- gdb/c-lang.c | 4 - gdb/c-valprint.c | 5 +- gdb/doc/gdb.texinfo | 44 +++++++++++++++++-- gdb/doc/python.texi | 5 ++ gdb/language.h | 2 gdb/m2-lang.c | 3 - gdb/m2-valprint.c | 4 + gdb/p-lang.c | 3 - gdb/p-valprint.c | 9 ++- gdb/printcmd.c | 9 ++- gdb/python/py-value.c | 4 + gdb/testsuite/gdb.base/default.exp | 7 +++ gdb/testsuite/gdb.base/options.exp | 1 gdb/tracepoint.c | 4 - gdb/valprint.c | 84 ++++++++++++++++++++++++++++--------- gdb/valprint.h | 26 +++++++++-- 18 files changed, 185 insertions(+), 49 deletions(-) gdb-aburgess-print-elements-characters.diff Index: src/gdb/NEWS =================================================================== --- src.orig/gdb/NEWS +++ src/gdb/NEWS @@ -115,6 +115,20 @@ set debug infcall on|off show debug infcall Print additional debug messages about inferior function calls. +set print characters LIMIT +show print characters + This new setting is like 'set print elements', but controls how many + characters of a string are printed. This functionality used to be + covered by 'set print elements', but it can be controlled separately + now. LIMIT can be set to a numerical value to request that particular + character count, to 'unlimited' to print all characters of a string, + or to 'elements', which is also the default, to follow the setting of + 'set print elements' as it used to be. + +print -characters LIMIT + This new option to the 'print' command has the same effect as a temporary + use of 'set print characters'. + * Changed commands document user-defined Index: src/gdb/ada-valprint.c =================================================================== --- src.orig/gdb/ada-valprint.c +++ src/gdb/ada-valprint.c @@ -469,7 +469,8 @@ printstr (struct ui_file *stream, struct return; } - for (i = 0; i < length && things_printed < options->print_max; i += 1) + unsigned int print_max_chars = get_print_max_chars (options); + for (i = 0; i < length && things_printed < print_max_chars; i += 1) { /* Position of the character we are examining to see whether it is repeated. */ @@ -705,12 +706,13 @@ ada_val_print_string (struct type *type, elements up to it. */ if (options->stop_print_at_null) { + unsigned int print_max_chars = get_print_max_chars (options); int temp_len; /* Look for a NULL char. */ for (temp_len = 0; (temp_len < len - && temp_len < options->print_max + && temp_len < print_max_chars && char_at (valaddr + offset_aligned, temp_len, eltlen, byte_order) != 0); temp_len += 1); Index: src/gdb/c-lang.c =================================================================== --- src.orig/gdb/c-lang.c +++ src/gdb/c-lang.c @@ -185,8 +185,8 @@ language_defn::printchar (int c, struct /* Print the character string STRING, printing at most LENGTH characters. LENGTH is -1 if the string is nul terminated. Each character is WIDTH bytes long. Printing stops early if the number - hits print_max; repeat counts are printed as appropriate. Print - ellipses at the end if we had to stop before printing LENGTH + hits print_max_chars; repeat counts are printed as appropriate. + Print ellipses at the end if we had to stop before printing LENGTH characters, or if FORCE_ELLIPSES. */ void Index: src/gdb/c-valprint.c =================================================================== --- src.orig/gdb/c-valprint.c +++ src/gdb/c-valprint.c @@ -267,11 +267,12 @@ c_value_print_array (struct value *val, print elements up to it. */ if (options->stop_print_at_null) { + unsigned int print_max_chars = get_print_max_chars (options); unsigned int temp_len; for (temp_len = 0; (temp_len < len - && temp_len < options->print_max + && temp_len < print_max_chars && extract_unsigned_integer (valaddr + temp_len * eltlen, eltlen, byte_order) != 0); ++temp_len) @@ -280,7 +281,7 @@ c_value_print_array (struct value *val, /* Force printstr to print ellipses if we've printed the maximum characters and the next character is not \000. */ - if (temp_len == options->print_max && temp_len < len) + if (temp_len == print_max_chars && temp_len < len) { ULONGEST ival = extract_unsigned_integer (valaddr + temp_len * eltlen, Index: src/gdb/doc/gdb.texinfo =================================================================== --- src.orig/gdb/doc/gdb.texinfo +++ src/gdb/doc/gdb.texinfo @@ -10223,10 +10223,18 @@ Related setting: @ref{set print array}. Set printing of array indexes. Related setting: @ref{set print array-indexes}. -@item -elements @var{number-of-elements}|@code{unlimited} -Set limit on string chars or array elements to print. The value +@item -characters @var{number-of-characters}|@code{elements}|@code{unlimited} +Set limit on string characters to print. The value @code{elements} +causes the limit on array elements to print to be used. The value @code{unlimited} causes there to be no limit. Related setting: -@ref{set print elements}. +@ref{set print characters}. + +@item -elements @var{number-of-elements}|@code{unlimited} +Set limit on array elements and optionally string characters to print. +See @ref{set print characters}, and the @code{-characters} option above +for when this option applies to strings. The value @code{unlimited} +causes there to be no limit. @xref{set print elements}, for a related +CLI command. @item -max-depth @var{depth}|@code{unlimited} Set the threshold after which nested structures are replaced with @@ -11623,6 +11631,31 @@ Don't printing binary values in groups. @item show print nibbles Show whether to print binary values in groups of four bits. +@anchor{set print characters} +@item set print characters @var{number-of-characters} +@itemx set print characters elements +@itemx set print characters unlimited +@cindex number of string characters to print +@cindex limit on number of printed string characters +Set a limit on how many characters of a string @value{GDBN} will print. +If @value{GDBN} is printing a large string, it stops printing after it +has printed the number of characters set by the @code{set print +characters} command. This equally applies to multi-byte and wide +character strings, that is for strings whose character type is +@code{wchar_t}, @code{char16_t}, or @code{char32_t} it is the number of +actual characters rather than underlying bytes the encoding uses that +this setting controls. +Setting @var{number-of-characters} to @code{elements} means that the +limit on the number of characters to print follows one for array +elements; see @ref{set print elements}. +Setting @var{number-of-characters} to @code{unlimited} means that the +number of characters to print is unlimited. +When @value{GDBN} starts, this limit is set to @code{elements}. + +@item show print characters +Display the number of characters of a large string that @value{GDBN} +will print. + @anchor{set print elements} @item set print elements @var{number-of-elements} @itemx set print elements unlimited @@ -11631,7 +11664,8 @@ Show whether to print binary values in g Set a limit on how many elements of an array @value{GDBN} will print. If @value{GDBN} is printing a large array, it stops printing after it has printed the number of elements set by the @code{set print elements} command. -This limit also applies to the display of strings. +By default this limit also applies to the display of strings; see +@ref{set print characters}. When @value{GDBN} starts, this limit is set to 200. Setting @var{number-of-elements} to @code{unlimited} or zero means that the number of elements to print is unlimited. @@ -15144,7 +15178,7 @@ The optional @var{mods} changes the usua @code{s} requests that pointers to chars be handled as strings, in particular collecting the contents of the memory being pointed at, up to the first zero. The upper bound is by default the value of the -@code{print elements} variable; if @code{s} is followed by a decimal +@code{print characters} variable; if @code{s} is followed by a decimal number, that is the upper bound instead. So for instance @samp{collect/s25 mystr} collects as many as 25 characters at @samp{mystr}. Index: src/gdb/doc/python.texi =================================================================== --- src.orig/gdb/doc/python.texi +++ src/gdb/doc/python.texi @@ -1135,6 +1135,11 @@ the @emph{declared} type should be used. representation of a C@t{++} object, @code{False} if they shouldn't (see @code{set print static-members} in @ref{Print Settings}). +@item max_characters +Number of string characters to print, @code{0} to follow +@code{max_elements}, or @code{UINT_MAX} to print an unlimited number +of characters (see @code{set print characters} in @ref{Print Settings}). + @item max_elements Number of array elements to print, or @code{0} to print an unlimited number of elements (see @code{set print elements} in @ref{Print Index: src/gdb/language.h =================================================================== --- src.orig/gdb/language.h +++ src/gdb/language.h @@ -541,7 +541,7 @@ struct language_defn struct ui_file * stream) const; /* Print the character string STRING, printing at most LENGTH characters. - Printing stops early if the number hits print_max; repeat counts + Printing stops early if the number hits print_max_chars; repeat counts are printed as appropriate. Print ellipses at the end if we had to stop before printing LENGTH characters, or if FORCE_ELLIPSES. */ Index: src/gdb/m2-lang.c =================================================================== --- src.orig/gdb/m2-lang.c +++ src/gdb/m2-lang.c @@ -169,7 +169,8 @@ m2_language::printstr (struct ui_file *s return; } - for (i = 0; i < length && things_printed < options->print_max; ++i) + unsigned int print_max_chars = get_print_max_chars (options); + for (i = 0; i < length && things_printed < print_max_chars; ++i) { /* Position of the character we are examining to see whether it is repeated. */ Index: src/gdb/m2-valprint.c =================================================================== --- src.orig/gdb/m2-valprint.c +++ src/gdb/m2-valprint.c @@ -327,12 +327,14 @@ m2_language::value_print_inner (struct v elements up to it. */ if (options->stop_print_at_null) { + unsigned int print_max_chars = get_print_max_chars (options); unsigned int temp_len; /* Look for a NULL char. */ for (temp_len = 0; (valaddr[temp_len] - && temp_len < len && temp_len < options->print_max); + && temp_len < len + && temp_len < print_max_chars); temp_len++); len = temp_len; } Index: src/gdb/p-lang.c =================================================================== --- src.orig/gdb/p-lang.c +++ src/gdb/p-lang.c @@ -253,7 +253,8 @@ pascal_language::printstr (struct ui_fil return; } - for (i = 0; i < length && things_printed < options->print_max; ++i) + unsigned int print_max_chars = get_print_max_chars (options); + for (i = 0; i < length && things_printed < print_max_chars; ++i) { /* Position of the character we are examining to see whether it is repeated. */ Index: src/gdb/p-valprint.c =================================================================== --- src.orig/gdb/p-valprint.c +++ src/gdb/p-valprint.c @@ -105,13 +105,16 @@ pascal_language::value_print_inner (stru elements up to it. */ if (options->stop_print_at_null) { + unsigned int print_max_chars + = get_print_max_chars (options); unsigned int temp_len; /* Look for a NULL char. */ for (temp_len = 0; - extract_unsigned_integer (valaddr + temp_len * eltlen, - eltlen, byte_order) - && temp_len < len && temp_len < options->print_max; + (extract_unsigned_integer + (valaddr + temp_len * eltlen, eltlen, byte_order) + && temp_len < len + && temp_len < print_max_chars); temp_len++); len = temp_len; } Index: src/gdb/printcmd.c =================================================================== --- src.orig/gdb/printcmd.c +++ src/gdb/printcmd.c @@ -957,17 +957,18 @@ find_string_backward (struct gdbarch *gd chars_to_read * char_size); chars_read /= char_size; read_error = (chars_read == chars_to_read) ? 0 : 1; + unsigned int print_max_chars = get_print_max_chars (options); /* Searching for '\0' from the end of buffer in backward direction. */ for (i = 0; i < chars_read && count > 0 ; ++i, ++chars_counted) { int offset = (chars_to_read - i - 1) * char_size; if (integer_is_zero (&buffer[offset], char_size) - || chars_counted == options->print_max) + || chars_counted == print_max_chars) { - /* Found '\0' or reached print_max. As OFFSET is the offset to - '\0', we add CHAR_SIZE to return the start address of - a string. */ + /* Found '\0' or reached `print_max_chars'. As OFFSET + is the offset to '\0', we add CHAR_SIZE to return + the start address of a string. */ --count; string_start_addr = addr + offset + char_size; chars_counted = 0; Index: src/gdb/python/py-value.c =================================================================== --- src.orig/gdb/python/py-value.c +++ src/gdb/python/py-value.c @@ -647,6 +647,7 @@ valpy_format_string (PyObject *self, PyO "actual_objects", /* See set print object on|off. */ "static_members", /* See set print static-members on|off. */ /* C non-bool options. */ + "max_characters", /* See set print characters N. */ "max_elements", /* See set print elements N. */ "max_depth", /* See set print max-depth N. */ "repeat_threshold", /* See set print repeats. */ @@ -695,7 +696,7 @@ valpy_format_string (PyObject *self, PyO char *format = NULL; if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, - "|O!O!O!O!O!O!O!O!O!O!O!O!O!IIIs", + "|O!O!O!O!O!O!O!O!O!O!O!O!O!IIIIs", keywords, &PyBool_Type, &raw_obj, &PyBool_Type, &pretty_arrays_obj, @@ -710,6 +711,7 @@ valpy_format_string (PyObject *self, PyO &PyBool_Type, &deref_refs_obj, &PyBool_Type, &actual_objects_obj, &PyBool_Type, &static_members_obj, + &opts.print_max_chars, &opts.print_max, &opts.max_depth, &opts.repeat_count_threshold, Index: src/gdb/testsuite/gdb.base/default.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/default.exp +++ src/gdb/testsuite/gdb.base/default.exp @@ -520,6 +520,10 @@ gdb_test_no_output "set print address" " gdb_test_no_output "set print array" "set print array" #test set print asm-demangle gdb_test_no_output "set print asm-demangle" "set print asm-demangle" +#test set print characters +gdb_test "set print characters" \ + "Argument required \\(integer to set it to, or one of:\ + \"elements\", \"unlimited\"\\)\\." #test set print demangle gdb_test_no_output "set print demangle" "set print demangle" #test set print elements @@ -663,6 +667,9 @@ gdb_test "show print address" "Printing gdb_test "show print array" "Pretty formatting of arrays is on." #test show print asm-demangle gdb_test "show print asm-demangle" "Demangling of C\[+\]+/ObjC names in disassembly listings is on." +#test show print characters +gdb_test "show print characters" \ + "Limit on string characters to print is elements\\." #test show print demangle gdb_test "show print demangle" "Demangling of encoded C\[+\]+/ObjC names when displaying symbols is on." #test show print elements Index: src/gdb/testsuite/gdb.base/options.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/options.exp +++ src/gdb/testsuite/gdb.base/options.exp @@ -171,6 +171,7 @@ proc_with_prefix test-print {{prefix ""} "-address" "-array" "-array-indexes" + "-characters" "-elements" "-max-depth" "-memory-tag-violations" Index: src/gdb/tracepoint.c =================================================================== --- src.orig/gdb/tracepoint.c +++ src/gdb/tracepoint.c @@ -541,9 +541,9 @@ decode_agent_options (const char *exp, i if (target_supports_string_tracing ()) { /* Allow an optional decimal number giving an explicit maximum - string length, defaulting it to the "print elements" value; + string length, defaulting it to the "print characters" value; so "collect/s80 mystr" gets at most 80 bytes of string. */ - *trace_string = opts.print_max; + *trace_string = get_print_max_chars (&opts); exp++; if (*exp >= '0' && *exp <= '9') *trace_string = atoi (exp); Index: src/gdb/valprint.c =================================================================== --- src.orig/gdb/valprint.c +++ src/gdb/valprint.c @@ -94,8 +94,14 @@ static void val_print_type_code_flags (s int embedded_offset, struct ui_file *stream); -#define PRINT_MAX_DEFAULT 200 /* Start print_max off at this value. */ -#define PRINT_MAX_DEPTH_DEFAULT 20 /* Start print_max_depth off at this value. */ +/* Start print_max at this value. */ +#define PRINT_MAX_DEFAULT 200 + +/* Start print_max_chars at this value (meaning follow print_max). */ +#define PRINT_MAX_CHARS_DEFAULT PRINT_MAX_CHARS_ELEMENTS + +/* Start print_max_depth at this value. */ +#define PRINT_MAX_DEPTH_DEFAULT 20 struct value_print_options user_print_options = { @@ -108,6 +114,7 @@ struct value_print_options user_print_op false, /* nibblesprint */ 0, /* objectprint */ PRINT_MAX_DEFAULT, /* print_max */ + PRINT_MAX_CHARS_DEFAULT, /* print_max_chars */ 10, /* repeat_count_threshold */ 0, /* output_format */ 0, /* format */ @@ -149,17 +156,31 @@ get_formatted_print_options (struct valu opts->format = format; } +/* Implement 'show print elements'. */ + static void show_print_max (struct ui_file *file, int from_tty, struct cmd_list_element *c, const char *value) { + gdb_printf + (file, + (user_print_options.print_max_chars != PRINT_MAX_CHARS_ELEMENTS + ? _("Limit on array elements to print is %s.\n") + : _("Limit on string chars or array elements to print is %s.\n")), + value); +} + +/* Implement 'show print characters'. */ + +static void +show_print_max_chars (struct ui_file *file, int from_tty, + struct cmd_list_element *c, const char *value) +{ gdb_printf (file, - _("Limit on string chars or array " - "elements to print is %s.\n"), + _("Limit on string characters to print is %s.\n"), value); } - /* Default input and output radixes, and output format letter. */ unsigned input_radix = 10; @@ -2481,9 +2502,9 @@ print_converted_chars_to_obstack (struct /* Print the character string STRING, printing at most LENGTH characters. LENGTH is -1 if the string is nul terminated. TYPE is the type of each character. OPTIONS holds the printing options; - printing stops early if the number hits print_max; repeat counts - are printed as appropriate. Print ellipses at the end if we had to - stop before printing LENGTH characters, or if FORCE_ELLIPSES. + printing stops early if the number hits print_max_chars; repeat + counts are printed as appropriate. Print ellipses at the end if we + had to stop before printing LENGTH characters, or if FORCE_ELLIPSES. QUOTE_CHAR is the character to print at each end of the string. If C_STYLE_TERMINATOR is true, and the last character is 0, then it is omitted. */ @@ -2537,7 +2558,8 @@ generic_printstr (struct ui_file *stream /* Convert characters until the string is over or the maximum number of printed characters has been reached. */ i = 0; - while (i < options->print_max) + unsigned int print_max_chars = get_print_max_chars (options); + while (i < print_max_chars) { int r; @@ -2589,7 +2611,7 @@ generic_printstr (struct ui_file *stream /* Print a string from the inferior, starting at ADDR and printing up to LEN characters, of WIDTH bytes a piece, to STREAM. If LEN is -1, printing stops at the first null byte, otherwise printing proceeds (including null - bytes) until either print_max or LEN characters have been printed, + bytes) until either print_max_chars or LEN characters have been printed, whichever is smaller. ENCODING is the name of the string's encoding. It can be NULL, in which case the target encoding is assumed. */ @@ -2611,15 +2633,17 @@ val_print_string (struct type *elttype, int width = elttype->length (); /* First we need to figure out the limit on the number of characters we are - going to attempt to fetch and print. This is actually pretty simple. If - LEN >= zero, then the limit is the minimum of LEN and print_max. If - LEN is -1, then the limit is print_max. This is true regardless of - whether print_max is zero, UINT_MAX (unlimited), or something in between, - because finding the null byte (or available memory) is what actually - limits the fetch. */ + going to attempt to fetch and print. This is actually pretty simple. + If LEN >= zero, then the limit is the minimum of LEN and print_max_chars. + If LEN is -1, then the limit is print_max_chars. This is true regardless + of whether print_max_chars is zero, UINT_MAX (unlimited), or something in + between, because finding the null byte (or available memory) is what + actually limits the fetch. */ - fetchlimit = (len == -1 ? options->print_max : std::min ((unsigned) len, - options->print_max)); + unsigned int print_max_chars = get_print_max_chars (options); + fetchlimit = (len == -1 + ? print_max_chars + : std::min ((unsigned) len, print_max_chars)); err = target_read_string (addr, len, width, fetchlimit, &buffer, &bytes_read); @@ -2864,6 +2888,15 @@ using uinteger_option_def using pinteger_option_def = gdb::option::pinteger_option_def; +/* Extra literals supported with the `set print characters' and + `print -characters' commands. */ +static const literal_def print_characters_literals[] = + { + { "elements", PRINT_MAX_CHARS_ELEMENTS }, + { "unlimited", PRINT_MAX_CHARS_UNLIMITED, 0 }, + { nullptr } + }; + /* Definitions of options for the "print" and "compile print" commands. */ static const gdb::option::option_def value_print_option_defs[] = { @@ -2905,12 +2938,23 @@ static const gdb::option::option_def val }, uinteger_option_def { + "characters", + [] (value_print_options *opt) { return &opt->print_max_chars; }, + print_characters_literals, + show_print_max_chars, /* show_cmd_cb */ + N_("Set limit on string chars to print."), + N_("Show limit on string chars to print."), + N_("\"elements\" causes the array element limit to be used.\n" + "\"unlimited\" causes there to be no limit."), + }, + + uinteger_option_def { "elements", [] (value_print_options *opt) { return &opt->print_max; }, uinteger_unlimited_literals, show_print_max, /* show_cmd_cb */ - N_("Set limit on string chars or array elements to print."), - N_("Show limit on string chars or array elements to print."), + N_("Set limit on array elements to print."), + N_("Show limit on array elements to print."), N_("\"unlimited\" causes there to be no limit."), }, Index: src/gdb/valprint.h =================================================================== --- src.orig/gdb/valprint.h +++ src/gdb/valprint.h @@ -51,12 +51,15 @@ struct value_print_options in its vtables. */ bool objectprint; - /* Maximum number of chars to print for a string pointer value or vector - contents, or UINT_MAX for no limit. Note that "set print elements 0" - stores UINT_MAX in print_max, which displays in a show command as - "unlimited". */ + /* Maximum number of elements to print for vector contents, or UINT_MAX + for no limit. Note that "set print elements 0" stores UINT_MAX in + print_max, which displays in a show command as "unlimited". */ unsigned int print_max; + /* Maximum number of string chars to print for a string pointer value, + zero if to follow the value of print_max, or UINT_MAX for no limit. */ + unsigned int print_max_chars; + /* Print repeat counts if there are more than this many repetitions of an element in an array. */ unsigned int repeat_count_threshold; @@ -105,6 +108,21 @@ struct value_print_options int max_depth; }; +/* The value to use for `print_max_chars' to follow `print_max'. */ +#define PRINT_MAX_CHARS_ELEMENTS 0 + +/* The value to use for `print_max_chars' for no limit. */ +#define PRINT_MAX_CHARS_UNLIMITED UINT_MAX + +/* Return the character count limit for printing strings. */ + +static inline unsigned int +get_print_max_chars (const struct value_print_options *options) +{ + return (options->print_max_chars != PRINT_MAX_CHARS_ELEMENTS + ? options->print_max_chars : options->print_max); +} + /* Create an option_def_group for the value_print options, with OPTS as context. */ extern gdb::option::option_def_group make_value_print_options_def_group From patchwork Sat Oct 29 13:53:54 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Maciej W. Rozycki" X-Patchwork-Id: 59622 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 7D3DE3858003 for ; Sat, 29 Oct 2022 13:54:24 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by sourceware.org (Postfix) with ESMTPS id 3A9C5385800F for ; Sat, 29 Oct 2022 13:53:57 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 3A9C5385800F Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=embecosm.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=embecosm.com Received: by mail-wr1-x42d.google.com with SMTP id j15so9956978wrq.3 for ; Sat, 29 Oct 2022 06:53:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=embecosm.com; s=google; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=8nCPuFkhHX4+xkIBn1yBd1pu2W1A0FW+1N7ntV/0gXs=; b=Fg2lA0E5LiyqkCfQZoVXao91L1f8dVnLwYd2G+kKrdSXtuV7kTfb6aZY0zNmt25OxN UBoCeyTw61Llv6XevKKAzI1qNLvZODMAE5ivjCWV34WK36hGet2qUIaeXyt1vqVSMd6B 33iPLPH/RMRuuTghB+zDpnMOIoeh8oejJZqosG7/LSOguY5N29wG3h3iVyjX0JoMZ2ks y0YMlYzr85oZ5rXRnmyl1GNCfPxt6/1AOkWsoOyrQwjA4z9mt+1tQhNjqZ3TodKtb06P KwIcIJ6r3mervGej+A7N+eWMVFJI2HadSF3gui0DmOMTK9U1yjl6iv9G14wZKtn5TCQf Cb0g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=8nCPuFkhHX4+xkIBn1yBd1pu2W1A0FW+1N7ntV/0gXs=; b=n4NlTlZ4kpkDgLYv0Pt5pxbO6XZhpcUIwGxTrwOGqTevI7cSF06yHMWhLIsRpDiDuz PU1zDIPWdmbRsf318wNPMQ98OehXL2eNj8O1ZEgTcIKX6J6hbn96k+VK2Qs0k4EO21Rb 0YjLW6XiQeAvjhP/slV46ontAWEH4ZAbDeUgXvGwB7TA418/66H7TnANeF/jXSbSdMLF Ycmh1BDq1gz7UGVkhBkTdmzCryCBjevKgBlLN9GdH7AUjAilllQevESDA3YHjhe09uYg KAK285ybtfWGI0e1Fkd0aqbk6RNjCyact51W52RqHZ/+K+ck5wqsHupaJMzEvKrHZA+6 GSog== X-Gm-Message-State: ACrzQf0KjTLTZ2D0Iky0pAt2QvD0rRlAgaGxVYknQ/9VwRUc3BG2cTff OCg929BCh0gVsPs6XqRWNsohAedwunzJuSAn X-Google-Smtp-Source: AMsMyM7gsO5ndFQOKiLwzHVxjdb9vGZ3pu1g2AbnNWsWxhxM6QxBmWpG9RdUF87u7DkeciaspFRyaw== X-Received: by 2002:a05:6000:178e:b0:22e:6d9f:1592 with SMTP id e14-20020a056000178e00b0022e6d9f1592mr2505472wrg.6.1667051635910; Sat, 29 Oct 2022 06:53:55 -0700 (PDT) Received: from tpp.orcam.me.uk (tpp.orcam.me.uk. [2001:8b0:154:0:ea6a:64ff:fe24:f2fc]) by smtp.gmail.com with ESMTPSA id f16-20020a05600c155000b003b47e75b401sm1817015wmg.37.2022.10.29.06.53.54 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Sat, 29 Oct 2022 06:53:55 -0700 (PDT) Date: Sat, 29 Oct 2022 14:53:54 +0100 (BST) From: "Maciej W. Rozycki" To: gdb-patches@sourceware.org Subject: [PATCH v7 4/4] GDB/testsuite: Expand for character string limiting options In-Reply-To: Message-ID: References: User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 X-Spam-Status: No, score=-2.2 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, KAM_ASCII_DIVIDERS, KAM_SHORT, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=no 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: , Cc: Simon Sobisch , Tom Tromey Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" From: Andrew Burgess Modify test cases that verify the operation of the array element limit with character strings such that they are executed twice, once with the `set print characters' option set to `elements' and the limit controlled with the `set print elements' option, and then again with the limit controlled with the `set print characters' option instead. Similarly with the `-elements' and `-characters' options for the `print' command. Additionally verify that said `print' command options combined yield the expected result. Verify correct $_gdb_setting and $_gdb_setting_str values for the `print characters' setting, in particular the `void' value for the `elements' default, which has no corresponding integer value exposed. Add Guile and Python coverage for the `print characters' GDB setting. There are new tests for Ada and Pascal, as the string printing code for these languages is different than the generic string printing code used by other languages. Modula2 also has different string printing code, but (a) this is similar to Pascal, and (b) there are no existing modula2 tests written in Modula2, so I'm not sure how I'd even test the Modula2 string printing. Co-Authored-By: Maciej W. Rozycki --- No change from v6.1. Changes from v6: - Add tests for $_gdb_setting and $_gdb_setting_str values with `print characters' to cover the `void' value in particular. Changes from v5: - Update testing for the use of `set print characters 0' now permitted. - Add Guile and Python `print characters' testing. No changes from v4. Changes from v3: - Split off from what is now 7/8; see the change log there for earlier changes. - Remove test case modifications to switch from the `set print elements' command to `set print characters'; instead run them twice with each of the two commands verified. - Likewise with the `print -elements' and `print -characters' commands. - Also cover `print -elements ... -characters ...', i.e. both options combined. - Expand the Ada and Pascal test cases to cover `set print characters elements' too. --- gdb/testsuite/gdb.ada/str_chars.exp | 70 ++++++++++++++++++++++++++ gdb/testsuite/gdb.ada/str_chars/foo.adb | 26 +++++++++ gdb/testsuite/gdb.base/printcmds.exp | 65 +++++++++++++++++------- gdb/testsuite/gdb.base/setshow.exp | 22 ++++++++ gdb/testsuite/gdb.guile/scm-parameter.exp | 11 +++- gdb/testsuite/gdb.pascal/str-chars.exp | 56 ++++++++++++++++++++ gdb/testsuite/gdb.pascal/str-chars.pas | 28 ++++++++++ gdb/testsuite/gdb.python/py-format-string.exp | 47 +++++++++++------ gdb/testsuite/gdb.python/py-parameter.exp | 13 ++++ 9 files changed, 301 insertions(+), 37 deletions(-) gdb-aburgess-print-elements-characters-test.diff Index: src/gdb/testsuite/gdb.ada/str_chars.exp =================================================================== --- /dev/null +++ src/gdb/testsuite/gdb.ada/str_chars.exp @@ -0,0 +1,70 @@ +# Copyright 2022 Free Software Foundation, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# Test GDB's 'set print characters' setting works for Ada strings. + +load_lib "ada.exp" + +if { [skip_ada_tests] } { return -1 } + +standard_ada_testfile foo + +if {[gdb_compile_ada "${srcfile}" "${binfile}" executable [list debug ]] != "" } { + return -1 +} + +clean_restart ${testfile} + +set bp_location [gdb_get_line_number "STOP" ${testdir}/foo.adb] +if ![runto "foo.adb:$bp_location" ] then { + return -1 +} + +gdb_test "print Arg" \ + " = \"abcdefghijklmnopqrstuvwxyz\"" \ + "print with default settings" + +gdb_test_no_output "set print characters 26" +gdb_test "print Arg" \ + " = \"abcdefghijklmnopqrstuvwxyz\"" \ + "print with character limit of 26" + +gdb_test "print -characters 11 -- Arg" \ + " = \"abcdefghijk\"\\.\\.\\." \ + "print with character limit of 11" + +gdb_test_no_output "set print characters 10" +gdb_test "print Arg" \ + " = \"abcdefghij\"\\.\\.\\." \ + "print with character limit of 10" + +gdb_test_no_output "set print characters unlimited" +gdb_test "print Arg" \ + " = \"abcdefghijklmnopqrstuvwxyz\"" \ + "print with unlimited character limit" + +# The 'set print elements' command used to control printing of characters +# in a string, before we created 'set print characters'. This test makes +# sure that 'set print elements' doens't effect string printing any more. +gdb_test_no_output "set print elements 12" +gdb_test "print Arg" \ + " = \"abcdefghijklmnopqrstuvwxyz\"" \ + "print with unlimited character limit, but lower element limit" + +# Except when 'set print characters elements' has been used. +gdb_test_no_output "set print characters elements" +gdb_test "print Arg" \ + " = \"abcdefghijkl\"\\.\\.\\." \ + "print with character limit of elements" Index: src/gdb/testsuite/gdb.ada/str_chars/foo.adb =================================================================== --- /dev/null +++ src/gdb/testsuite/gdb.ada/str_chars/foo.adb @@ -0,0 +1,26 @@ +-- Copyright 2022 Free Software Foundation, Inc. +-- +-- This program is free software; you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation; either version 3 of the License, or +-- (at your option) any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +procedure Foo is + + procedure Blah (Arg : String) is + begin + null; -- STOP + end; + +begin + + Blah ("abcdefghijklmnopqrstuvwxyz"); +end Foo; Index: src/gdb/testsuite/gdb.base/printcmds.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/printcmds.exp +++ src/gdb/testsuite/gdb.base/printcmds.exp @@ -451,11 +451,11 @@ proc test_print_all_chars {} { # Test interaction of the number of print elements to print and the # repeat count, set to the default of 10. -proc test_print_repeats_10 {} { +proc test_print_repeats_10_one { setting } { global gdb_prompt decimal for { set x 1 } { $x <= 16 } { incr x } { - gdb_test_no_output "set print elements $x" "elements $x repeats" + gdb_test_no_output "set print $setting $x" "$setting $x repeats" for { set e 1 } { $e <= 16 } {incr e } { set v [expr $e - 1] set command "p &ctable2\[${v}*16\]" @@ -495,11 +495,18 @@ proc test_print_repeats_10 {} { set xstr "${xstr}\[.\]\[.\]\[.\]" } set string " = \[(\]unsigned char \[*\]\[)\] ${a}${xstr}" - gdb_test "$command" "$string" "$command with print elements set to $x" + gdb_test "$command" "$string" "$command with print $setting set to $x" } } } +proc test_print_repeats_10 {} { + foreach_with_prefix setting { "elements" "characters" } { + test_print_repeats_10_one $setting + } + gdb_test_no_output "set print characters elements" +} + # This tests whether GDB uses the correct element content offsets # (relative to the complete `some_struct' value) when counting value # repetitions. @@ -512,7 +519,7 @@ proc test_print_repeats_embedded_array { "correct element repeats in array embedded at offset > 0" } -proc test_print_strings {} { +proc test_print_strings_one { setting } { global gdb_prompt decimal # We accept "(unsigned char *) " before the string. char vs. unsigned char @@ -520,35 +527,35 @@ proc test_print_strings {} { # Test that setting print elements unlimited doesn't completely suppress # printing; this was a bug in older gdb's. - gdb_test_no_output "set print elements 0" + gdb_test_no_output "set print $setting 0" gdb_test "p teststring" \ - " = (.unsigned char .. )?\"teststring contents\"" "p teststring with elements set to 0" - gdb_test_no_output "set print elements 1" + " = (.unsigned char .. )?\"teststring contents\"" "p teststring with $setting set to 0" + gdb_test_no_output "set print $setting 1" gdb_test "p teststring" \ - " = (.unsigned char .. )?\"t\"\\.\\.\\." "p teststring with elements set to 1" - gdb_test_no_output "set print elements 5" + " = (.unsigned char .. )?\"t\"\\.\\.\\." "p teststring with $setting set to 1" + gdb_test_no_output "set print $setting 5" gdb_test "p teststring" \ - " = (.unsigned char .. )?\"tests\"\\.\\.\\." "p teststring with elements set to 5" - gdb_test_no_output "set print elements 19" + " = (.unsigned char .. )?\"tests\"\\.\\.\\." "p teststring with $setting set to 5" + gdb_test_no_output "set print $setting 19" gdb_test "p teststring" \ - " = (.unsigned char .. )?\"teststring contents\"" "p teststring with elements set to 19" - gdb_test_no_output "set print elements 20" + " = (.unsigned char .. )?\"teststring contents\"" "p teststring with $setting set to 19" + gdb_test_no_output "set print $setting 20" gdb_test "p teststring" \ - " = (.unsigned char .. )?\"teststring contents\"" "p teststring with elements set to 20" + " = (.unsigned char .. )?\"teststring contents\"" "p teststring with $setting set to 20" - gdb_test "p -elements 1 -- teststring" \ + gdb_test "p -$setting 1 -- teststring" \ " = (.unsigned char .. )?\"t\"\\.\\.\\." - gdb_test "p -elements 5 -- teststring" \ + gdb_test "p -$setting 5 -- teststring" \ " = (.unsigned char .. )?\"tests\"\\.\\.\\." - gdb_test "p -elements 19 -- teststring" \ + gdb_test "p -$setting 19 -- teststring" \ " = (.unsigned char .. )?\"teststring contents\"" - gdb_test "p -elements 20 -- teststring" \ + gdb_test "p -$setting 20 -- teststring" \ " = (.unsigned char .. )?\"teststring contents\"" gdb_test "print teststring2" \ " = \\(charptr\\) \"more contents\"" - gdb_test_no_output "set print elements 8" + gdb_test_no_output "set print $setting 8" # Set the target-charset to ASCII, because the output varies from # different charset. @@ -620,6 +627,26 @@ proc test_print_strings {} { gdb_test "p &ctable1\[31*8\]" \ " = \\(unsigned char \\*\\) \"\\\\370\\\\371\\\\372\\\\373\\\\374\\\\375\\\\376\\\\377\"..." } + + gdb_test_no_output "set print $setting unlimited" +} + +proc test_print_strings {} { + + foreach_with_prefix setting { "elements" "characters" } { + test_print_strings_one $setting + } + + gdb_test "p -elements 8 -- teststring" \ + " = (.unsigned char .. )?\"teststring contents\"" + gdb_test "p -characters 8 -- teststring" \ + " = (.unsigned char .. )?\"teststri\"\\.\\.\\." + gdb_test "p -elements 8 -characters elements -- teststring" \ + " = (.unsigned char .. )?\"teststri\"\\.\\.\\." + + with_test_prefix strings { + gdb_test_no_output "set print characters elements" + } } proc test_print_int_arrays {} { Index: src/gdb/testsuite/gdb.base/setshow.exp =================================================================== --- src.orig/gdb/testsuite/gdb.base/setshow.exp +++ src/gdb/testsuite/gdb.base/setshow.exp @@ -374,6 +374,27 @@ proc_with_prefix test_setshow_listsize { gdb_test "show listsize" "Number of source lines gdb will list by default is 100..*" "show listsize (100)" } +proc_with_prefix test_setshow_print_characters {} { + clean_restart + + gdb_test "p \$_gdb_setting(\"print characters\")" " = void" \ + "_gdb_setting print characters default" + gdb_test "p \$_gdb_setting_str(\"print characters\")" " = \"elements\"" \ + "_gdb_setting_str print characters default" + + gdb_test_no_output "set print characters unlimited" + gdb_test "p \$_gdb_setting(\"print characters\")" " = 0" \ + "_gdb_setting print characters unlimited" + gdb_test "p \$_gdb_setting_str(\"print characters\")" " = \"unlimited\"" \ + "_gdb_setting_str print characters unlimited" + + gdb_test_no_output "set print characters 1" + gdb_test "p \$_gdb_setting(\"print characters\")" " = 1" \ + "_gdb_setting print characters 1" + gdb_test "p \$_gdb_setting_str(\"print characters\")" " = \"1\"" \ + "_gdb_setting_str print characters 1" +} + proc_with_prefix test_setshow_prompt {} { clean_restart @@ -493,6 +514,7 @@ test_setshow_height test_setshow_history test_setshow_language test_setshow_listsize +test_setshow_print_characters test_setshow_prompt test_setshow_radix test_setshow_width Index: src/gdb/testsuite/gdb.guile/scm-parameter.exp =================================================================== --- src.orig/gdb/testsuite/gdb.guile/scm-parameter.exp +++ src/gdb/testsuite/gdb.guile/scm-parameter.exp @@ -105,6 +105,7 @@ foreach_with_prefix param { "listsize" "print elements" "max-completions" + "print characters" } { set param_range_error "integer -1 out of range" set param_type_error \ @@ -118,7 +119,8 @@ foreach_with_prefix param { set param_get_minus_one -1 set param_set_minus_one "" } - "print elements" { + "print elements" - + "print characters" { set param_get_zero "#:unlimited" set param_get_minus_one "#:unlimited" set param_set_minus_one $param_range_error @@ -153,6 +155,13 @@ foreach_with_prefix param { gdb_test "guile (print (parameter-value \"$param\"))" \ "#:unlimited" "test value of 'unlimited'" + + if {$param == "print characters"} { + gdb_test_no_output "set $param elements" "test set to 'elements'" + + gdb_test "guile (print (parameter-value \"$param\"))" \ + "#:elements" "test value of 'elements'" + } } foreach_with_prefix kind { Index: src/gdb/testsuite/gdb.pascal/str-chars.exp =================================================================== --- /dev/null +++ src/gdb/testsuite/gdb.pascal/str-chars.exp @@ -0,0 +1,56 @@ +# Copyright 2022 Free Software Foundation, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +load_lib "pascal.exp" + +standard_testfile .pas + +if {[gdb_compile_pascal "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable [list debug ]] != "" } { + return -1 +} + +clean_restart ${testfile} +gdb_breakpoint ${srcfile}:[gdb_get_line_number "set breakpoint 1 here"] + +# Verify that "start" lands inside the right procedure. +if { [gdb_start_cmd] < 0 } { + untested start + return -1 +} + +gdb_continue_to_breakpoint "continue to breakpoint" + +gdb_test "print message" " = 'abcdefghijklmnopqrstuvwxyz'" \ + "print message with the default settings" + +gdb_test_no_output "set print elements 10" +gdb_test "print message" " = 'abcdefghij'\\.\\.\\." \ + "print message with 'print elements' set to 10" + +gdb_test_no_output "set print characters 20" +gdb_test "print message" " = 'abcdefghijklmnopqrst'\\.\\.\\." \ + "print message with 'print characters' set to 20" + +gdb_test_no_output "set print elements 15" +gdb_test "print message" " = 'abcdefghijklmnopqrst'\\.\\.\\." \ + "print message with 'print elements' set to 15" + +gdb_test_no_output "set print characters unlimited" +gdb_test "print message" " = 'abcdefghijklmnopqrstuvwxyz'" \ + "print message with 'print characters' set to unlimited" + +gdb_test_no_output "set print characters elements" +gdb_test "print message" " = 'abcdefghijklmno'\\.\\.\\." \ + "print message with 'print characters' set to elements" Index: src/gdb/testsuite/gdb.pascal/str-chars.pas =================================================================== --- /dev/null +++ src/gdb/testsuite/gdb.pascal/str-chars.pas @@ -0,0 +1,28 @@ +{ + Copyright 2022 Free Software Foundation, Inc. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +} + +program str_char; + +var + message : string; + +begin + + message := 'abcdefghijklmnopqrstuvwxyz'; + writeln (message) { set breakpoint 1 here } + +end. Index: src/gdb/testsuite/gdb.python/py-format-string.exp =================================================================== --- src.orig/gdb/testsuite/gdb.python/py-format-string.exp +++ src/gdb/testsuite/gdb.python/py-format-string.exp @@ -705,13 +705,13 @@ proc_with_prefix test_static_members {} } # Test the max_elements option for gdb.Value.format_string. -proc_with_prefix test_max_elements {} { +proc test_max_string_one { setting unlimited } { global current_lang global default_pointer_regexp # 200 is the default maximum number of elements, so setting it should # not change the output. - set opts "max_elements=200" + set opts "max_$setting=200" with_test_prefix $opts { check_format_string "a_point_t" $opts check_format_string "a_point_t_pointer" $opts @@ -722,8 +722,10 @@ proc_with_prefix test_max_elements {} { check_format_string "a_binary_string" $opts check_format_string "a_binary_string_array" $opts check_format_string "a_big_string" $opts - check_format_string "an_array" $opts - check_format_string "an_array_with_repetition" $opts + if { $setting == "elements"} { + check_format_string "an_array" $opts + check_format_string "an_array_with_repetition" $opts + } check_format_string "a_symbol_pointer" $opts if { $current_lang == "c++" } { @@ -732,7 +734,7 @@ proc_with_prefix test_max_elements {} { } } - set opts "max_elements=3" + set opts "max_$setting=3" with_test_prefix $opts { check_format_string "a_point_t" $opts check_format_string "a_point_t_pointer" $opts @@ -749,9 +751,11 @@ proc_with_prefix test_max_elements {} { "\"hell\"..." check_format_string "a_big_string" $opts \ [get_cut_big_string 3] - check_format_string "an_array" $opts - check_format_string "an_array_with_repetition" $opts \ - "\\{1, 3 ...\\}" + if { $setting == "elements"} { + check_format_string "an_array" $opts + check_format_string "an_array_with_repetition" $opts \ + "\\{1, 3 ...\\}" + } check_format_string "a_symbol_pointer" $opts if { $current_lang == "c++" } { @@ -760,9 +764,9 @@ proc_with_prefix test_max_elements {} { } } - # Both 1,000 (we don't have that many elements) and 0 (unlimited) should + # Both 1,000 (we don't have that many elements) and unlimited should # mean no truncation. - foreach opts { "max_elements=1000" "max_elements=0" } { + foreach opts [list "max_$setting=1000" "max_$setting=$unlimited"] { with_test_prefix $opts { check_format_string "a_point_t" $opts check_format_string "a_point_t_pointer" $opts @@ -774,8 +778,10 @@ proc_with_prefix test_max_elements {} { check_format_string "a_binary_string_array" $opts check_format_string "a_big_string" $opts \ [get_cut_big_string 1000] - check_format_string "an_array" $opts - check_format_string "an_array_with_repetition" $opts + if { $setting == "elements"} { + check_format_string "an_array" $opts + check_format_string "an_array_with_repetition" $opts + } check_format_string "a_symbol_pointer" $opts if { $current_lang == "c++" } { @@ -785,15 +791,24 @@ proc_with_prefix test_max_elements {} { } } - with_temp_option "set print elements 4" "set print elements 200" { + with_temp_option "set print $setting 4" "set print $setting 200" { check_format_string "a_string" "" \ "${default_pointer_regexp} \"hell\"..." check_format_string "a_binary_string" "" \ "${default_pointer_regexp} \"hell\"..." check_format_string "a_binary_string_array" "" \ "\"hell\"..." - check_format_string "an_array_with_repetition" "" \ - "\\{1, 3 ...\\}" + if { $setting == "elements"} { + check_format_string "an_array_with_repetition" "" \ + "\\{1, 3 ...\\}" + } + } +} + +proc_with_prefix test_max_string {} { + foreach_with_prefix setting { "elements" "characters" } { + test_max_string_one $setting \ + [string map {elements 0 characters 4294967295} $setting] } } @@ -1153,7 +1168,7 @@ proc_with_prefix test_all_common {} { test_deref_refs test_actual_objects test_static_members - test_max_elements + test_max_string test_max_depth test_repeat_threshold test_format Index: src/gdb/testsuite/gdb.python/py-parameter.exp =================================================================== --- src.orig/gdb/testsuite/gdb.python/py-parameter.exp +++ src/gdb/testsuite/gdb.python/py-parameter.exp @@ -338,6 +338,7 @@ proc_with_prefix test_gdb_parameter { } "listsize" "print elements" "max-completions" + "print characters" } { clean_restart @@ -348,7 +349,8 @@ proc_with_prefix test_gdb_parameter { } set param_get_minus_one -1 set param_set_minus_one "" } - "print elements" { + "print elements" - + "print characters" { set param_get_zero None set param_get_minus_one None set param_set_minus_one $param_range_error @@ -393,6 +395,15 @@ proc_with_prefix test_gdb_parameter { } gdb_test "python print(gdb.parameter('$param'))" \ None "test value of 'unlimited'" + + if {$param == "print characters"} { + gdb_test_no_output \ + "python gdb.set_parameter('$param', 'elements')" \ + "test set to 'elements'" + + gdb_test "python print(gdb.parameter('$param'))" \ + elements "test value of 'elements'" + } } clean_restart