From: Andrew Burgess <aburgess@redhat.com>
To: Bruno Larsen <blarsen@redhat.com>, gdb-patches@sourceware.org
Subject: Re: [PATCH v3 01/14] gdb/testsuite: introduce gdb_step_until_regexp
Date: Mon, 30 May 2022 15:06:16 +0100 [thread overview]
Message-ID: <87ee0bdsiv.fsf@redhat.com> (raw)
In-Reply-To: <704cc949-2cac-76e2-b8d2-1efdfc368d3a@redhat.com>
Bruno Larsen via Gdb-patches <gdb-patches@sourceware.org> writes:
> Hi Andrew,
>
> thanks for the review!
>
> On 5/27/22 13:19, Andrew Burgess wrote:
>> Bruno Larsen via Gdb-patches <gdb-patches@sourceware.org> writes:
>>
>>> Currently, GDB's testsuite uses a set amount of step commands to exit
>>> functions. This is a problem if a compiler emits different epilogue
>>> information from gcc, or emits no epilogue information at all. It was
>>> most noticeable if Clang was used to test GDB.
>>>
>>> To fix this unreliability, this commit introduces a new proc that will
>>> single step the inferior until it is stopped at a line that matches the
>>> given regexp, or until it steps too many times - defined as an optional
>>> argument. If the line is found, it shows up as a single PASS in the
>>> test, and if the line is not found, a single FAIL is emitted.
>>>
>>> This patch only introduces this proc, but does not add it to any
>>> existing tests, these will be introduced in the following commit.
>>> ---
>>>
>>> No change in v3
>>>
>>> New patch in v2
>>>
>>> ---
>>> gdb/testsuite/lib/gdb.exp | 30 ++++++++++++++++++++++++++++++
>>> 1 file changed, 30 insertions(+)
>>>
>>> diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp
>>> index b04fbb89e4e..c0ca1d04cc2 100644
>>> --- a/gdb/testsuite/lib/gdb.exp
>>> +++ b/gdb/testsuite/lib/gdb.exp
>>> @@ -8648,5 +8648,35 @@ proc get_set_option_choices {set_cmd} {
>>> return $values
>>> }
>>>
>>> +# This proc is used mainly to exit function in a compiler agnostic way
>>> +# It makes gdb single step and evaluate the output at every step, to see
>>> +# if the regexp is present.
>>> +#
>>> +# The proc takes 2 optional arguments, the first being the name of the
>>> +# test and the second the maximum amount of iterations until we expect to
>>> +# see the function. The default is 10 steps, since this is meant as the
>>> +# last step by default, and we don't expect any compiler generated epilogue
>>> +# longer than 10 steps.
>>
>> I feel like you are being overly prescriptive in how this function
>> should be used.
>>
>> I would rewrite this to just describe what the function does, and let
>> folk use it as they see fit. Sure, initially it will only be used as
>> you imagine - that's why you're adding it. But once it's there, who
>> knows what uses it might be put too.
>>
>> I'd go with something like:
>>
>> # Single step until the pattern REGEXP is found. Step at most
>> # MAX_STEPS times, but stop stepping once REGEXP is found.
>> #
>> # If REGEXP is found then a single pass is emitted, otherwise, after
>> # MAX_STEPS steps, a single fail is emitted.
>> #
>> # TEST_NAME is the name used in the pass/fail calls.
>>
>
> Good point. I've used your version of the comment.
>
>>> +
>>> +proc gdb_step_until_regexp { regexp {test_name "single stepping until regexp"} {max_steps 10} } {
>>
>> You should keep this line under 80 characters. You can wrap the
>> arguments I believe, like:
>>
>> proc gdb_step_until_regexp { regexp
>> {test_name "single stepping until regexp"}
>> {max_steps 10} } {
>>
>> However, I'd be tempted to take a different approach, like this:
>>
>> proc gdb_step_until_regexp { regexp {test_name ""} {max_steps 10} } {
>>
>> if { $test_name == "" } {
>> set test_name "single stepping until regexp"
>> }
>>
>> The benefit I see in this approach is that if a user wants to adjust
>> max_steps, but doesn't care about the test name, they can do this:
>>
>> gdb_step_until_regexp "SOME_PATTERN" "" 50
>>
>> And still get the default test name.
>
> That's a good reason. I didn't have any for my choice other than it's what I was comfortable with. Using your version again
>
>>
>>> + global gdb_prompt
>>
>> I think this is OK, there's certainly lots of precedent for this
>> approach, but I think more often these days, we just refer to the global
>> directly as:
>>
>> $::gdb_prompt
>>
>> As this removes the need for the 'global gdb_prompt' line.
>>
>> But I don't think this is a hard requirement if you prefer what you
>> have.
>
> I do like this version more too, more clear that it is a global variable for new contributors.
>
> At this point, I wonder if I should add a co-authored tag to the
> patch.
That's up to you, but not required from my side.
Thanks,
Andrew
>
>>
>> Thanks,
>> Andrew
>>
>>> +
>>> + set count 0
>>> + gdb_test_multiple "step" "$test_name" {
>>> + -re "$regexp\r\n$gdb_prompt $" {
>>> + pass $test_name
>>> + }
>>> + -re ".*$gdb_prompt $" {
>>> + if {$count < $max_steps} {
>>> + incr count
>>> + send_gdb "step\n"
>>> + exp_continue
>>> + } else {
>>> + fail $test_name
>>> + }
>>> + }
>>> + }
>>> +}
>>> +
>>> # Always load compatibility stuff.
>>> load_lib future.exp
>>> --
>>> 2.31.1
>>
> Cheers!
> Bruno Larsen
next prev parent reply other threads:[~2022-05-30 14:06 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-26 15:10 [PATCH v3 00/14] Clean gdb.base when testing with clang Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 01/14] gdb/testsuite: introduce gdb_step_until_regexp Bruno Larsen
2022-05-27 16:19 ` Andrew Burgess
2022-05-30 12:44 ` Bruno Larsen
2022-05-30 14:06 ` Andrew Burgess [this message]
2022-06-08 14:59 ` Pedro Alves
2022-05-26 15:10 ` [PATCH v3 02/14] Change gdb.base/skip-solib.exp deal with lack of epilogue information Bruno Larsen
2022-05-30 14:04 ` Andrew Burgess
2022-05-30 20:31 ` Bruno Larsen
2022-06-01 14:52 ` [PATCH] gdb/testsuite: Add test to step through function epilogue Bruno Larsen
2022-06-08 15:37 ` [PATCH v3 02/14] Change gdb.base/skip-solib.exp deal with lack of epilogue information Pedro Alves
2022-06-09 16:27 ` Bruno Larsen
2022-06-09 18:25 ` Pedro Alves
2022-06-09 18:55 ` Bruno Larsen
2022-06-13 15:32 ` Pedro Alves
2022-05-26 15:10 ` [PATCH v3 03/14] change gdb.base/symbol-alias to xfail with clang Bruno Larsen
2022-06-07 6:42 ` George, Jini Susan
2022-06-07 12:53 ` Bruno Larsen
2022-06-08 7:41 ` George, Jini Susan
2022-06-10 11:01 ` Andrew Burgess
2022-06-10 12:07 ` Bruno Larsen
2022-06-14 7:14 ` George, Jini Susan
2022-06-14 7:23 ` George, Jini Susan
2022-06-14 11:23 ` Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 04/14] change gdb.base/nodebug.c to not fail " Bruno Larsen
2022-06-10 18:24 ` Andrew Burgess
2022-05-26 15:10 ` [PATCH v3 05/14] update gdb.base/info-program.exp " Bruno Larsen
2022-06-30 14:45 ` Andrew Burgess
2022-05-26 15:10 ` [PATCH v3 06/14] fix gdb.base/access-mem-running.exp for clang testing Bruno Larsen
2022-06-30 15:06 ` Andrew Burgess
2022-05-26 15:10 ` [PATCH v3 07/14] Fix gdb.base/call-ar-st to work with Clang Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 08/14] add xfails to gdb.base/complex-parts.exp when testing with clang Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 09/14] gdb/testsuite: fix gdb.base/msym-bp-shl when running with Clang Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 10/14] explicitly test for stderr in gdb.base/dprintf.exp Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 11/14] gdb/testsuite: Update gdb.base/so-impl-ld.exp Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 12/14] [gdb/testsuite]: fix gdb.base/jit-elf.exp when testing with clang Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 13/14] gdb/testsuite: fix gdb.base/info-types-c++ " Bruno Larsen
2022-05-26 15:10 ` [PATCH v3 14/14] gdb.base/skip.exp: Use finish to exit functions Bruno Larsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ee0bdsiv.fsf@redhat.com \
--to=aburgess@redhat.com \
--cc=blarsen@redhat.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).