Re: [PATCH 4/5] gdb.base/: Introduce jit-protocol-util.h

[Andrew Burgess <aburgess@redhat.com>]

Ilya Leoshkevich <iii@linux.ibm.com> writes:

> jit-elf-fork-main, jit-elf-main and jit-reader-host use the same
> boilerplate to register and unregister JITed code.  Move it to a new
> header that can be shared with performance tests.

LGTM.

Thanks,
Andrew

> ---
>  gdb/testsuite/gdb.base/jit-elf-fork-main.c | 37 ++---------
>  gdb/testsuite/gdb.base/jit-elf-main.c      | 37 ++---------
>  gdb/testsuite/gdb.base/jit-protocol-util.h | 74 ++++++++++++++++++++++
>  gdb/testsuite/gdb.base/jit-reader-host.c   |  8 +--
>  4 files changed, 84 insertions(+), 72 deletions(-)
>  create mode 100644 gdb/testsuite/gdb.base/jit-protocol-util.h
>
> diff --git a/gdb/testsuite/gdb.base/jit-elf-fork-main.c b/gdb/testsuite/gdb.base/jit-elf-fork-main.c
> index 45792622548..96fadaa57b7 100644
> --- a/gdb/testsuite/gdb.base/jit-elf-fork-main.c
> +++ b/gdb/testsuite/gdb.base/jit-elf-fork-main.c
> @@ -29,8 +29,8 @@
>  #include <sys/stat.h>
>  #include <unistd.h>
>  
> -#include "jit-protocol.h"
>  #include "jit-elf-util.h"
> +#include "jit-protocol-util.h"
>  
>  static void
>  usage (void)
> @@ -77,17 +77,7 @@ main (int argc, char *argv[])
>        struct jit_code_entry *const entry = calloc (1, sizeof (*entry));
>        entry->symfile_addr = (const char *)addr;
>        entry->symfile_size = obj_size;
> -      entry->prev_entry = __jit_debug_descriptor.relevant_entry;
> -      __jit_debug_descriptor.relevant_entry = entry;
> -
> -      if (entry->prev_entry != NULL)
> -	entry->prev_entry->next_entry = entry;
> -      else
> -	__jit_debug_descriptor.first_entry = entry;
> -
> -      /* Notify GDB.  */
> -      __jit_debug_descriptor.action_flag = JIT_REGISTER;
> -      __jit_debug_register_code ();
> +      jit_push_back (entry);
>  
>        if (jit_function () != 42)
>  	{
> @@ -103,27 +93,8 @@ main (int argc, char *argv[])
>    i = 0;  /* break after fork */
>  
>    /* Now unregister them all in reverse order.  */
> -  while (__jit_debug_descriptor.relevant_entry != NULL)
> -    {
> -      struct jit_code_entry *const entry =
> -	__jit_debug_descriptor.relevant_entry;
> -      struct jit_code_entry *const prev_entry = entry->prev_entry;
> -
> -      if (prev_entry != NULL)
> -	{
> -	  prev_entry->next_entry = NULL;
> -	  entry->prev_entry = NULL;
> -	}
> -      else
> -	__jit_debug_descriptor.first_entry = NULL;
> -
> -      /* Notify GDB.  */
> -      __jit_debug_descriptor.action_flag = JIT_UNREGISTER;
> -      __jit_debug_register_code ();
> -
> -      __jit_debug_descriptor.relevant_entry = prev_entry;
> -      free (entry);
> -    }
> +  while (!jit_empty ())
> +    free (jit_pop_back ());
>  
>    return 0;  /* break before return  */
>  }
> diff --git a/gdb/testsuite/gdb.base/jit-elf-main.c b/gdb/testsuite/gdb.base/jit-elf-main.c
> index 948530f3197..8f482748ee5 100644
> --- a/gdb/testsuite/gdb.base/jit-elf-main.c
> +++ b/gdb/testsuite/gdb.base/jit-elf-main.c
> @@ -29,8 +29,8 @@
>  #include <sys/stat.h>
>  #include <unistd.h>
>  
> -#include "jit-protocol.h"
>  #include "jit-elf-util.h"
> +#include "jit-protocol-util.h"
>  
>  static void
>  usage (void)
> @@ -96,17 +96,7 @@ MAIN (int argc, char *argv[])
>        struct jit_code_entry *const entry = calloc (1, sizeof (*entry));
>        entry->symfile_addr = (const char *)addr;
>        entry->symfile_size = obj_size;
> -      entry->prev_entry = __jit_debug_descriptor.relevant_entry;
> -      __jit_debug_descriptor.relevant_entry = entry;
> -
> -      if (entry->prev_entry != NULL)
> -	entry->prev_entry->next_entry = entry;
> -      else
> -	__jit_debug_descriptor.first_entry = entry;
> -
> -      /* Notify GDB.  */
> -      __jit_debug_descriptor.action_flag = JIT_REGISTER;
> -      __jit_debug_register_code ();
> +      jit_push_back (entry);
>  
>        if (jit_function () != 42)
>  	{
> @@ -118,27 +108,8 @@ MAIN (int argc, char *argv[])
>    WAIT_FOR_GDB; i = 0;  /* gdb break here 1 */
>  
>    /* Now unregister them all in reverse order.  */
> -  while (__jit_debug_descriptor.relevant_entry != NULL)
> -    {
> -      struct jit_code_entry *const entry =
> -	__jit_debug_descriptor.relevant_entry;
> -      struct jit_code_entry *const prev_entry = entry->prev_entry;
> -
> -      if (prev_entry != NULL)
> -	{
> -	  prev_entry->next_entry = NULL;
> -	  entry->prev_entry = NULL;
> -	}
> -      else
> -	__jit_debug_descriptor.first_entry = NULL;
> -
> -      /* Notify GDB.  */
> -      __jit_debug_descriptor.action_flag = JIT_UNREGISTER;
> -      __jit_debug_register_code ();
> -
> -      __jit_debug_descriptor.relevant_entry = prev_entry;
> -      free (entry);
> -    }
> +  while (!jit_empty ())
> +    free (jit_pop_back ());
>  
>    WAIT_FOR_GDB; return 0;  /* gdb break here 2  */
>  }
> diff --git a/gdb/testsuite/gdb.base/jit-protocol-util.h b/gdb/testsuite/gdb.base/jit-protocol-util.h
> new file mode 100644
> index 00000000000..d0a59518429
> --- /dev/null
> +++ b/gdb/testsuite/gdb.base/jit-protocol-util.h
> @@ -0,0 +1,74 @@
> +/* This test program is part of GDB, the GNU debugger.
> +
> +   Copyright (C) 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 <http://www.gnu.org/licenses/>.  */
> +
> +/* Frequently used functions for testing JITed objects.  */
> +
> +#ifndef JIT_PROTOCOL_UTIL_H
> +#define JIT_PROTOCOL_UTIL_H
> +
> +#include "jit-protocol.h"
> +#include <stddef.h>
> +
> +/* Return whether there are no registered JITed objects.  */
> +static int
> +jit_empty (void)
> +{
> +  return __jit_debug_descriptor.relevant_entry == NULL;
> +}
> +
> +/* Register JITed object.  symfile_addr and symfile_size must be set.  */
> +static void
> +jit_push_back (struct jit_code_entry *entry)
> +{
> +  entry->prev_entry = __jit_debug_descriptor.relevant_entry;
> +  __jit_debug_descriptor.relevant_entry = entry;
> +
> +  if (entry->prev_entry != NULL)
> +    entry->prev_entry->next_entry = entry;
> +  else
> +    __jit_debug_descriptor.first_entry = entry;
> +
> +  /* Notify GDB.  */
> +  __jit_debug_descriptor.action_flag = JIT_REGISTER;
> +  __jit_debug_register_code ();
> +}
> +
> +/* Unregister the last registered JITed object.  */
> +static struct jit_code_entry *
> +jit_pop_back (void)
> +{
> +  struct jit_code_entry *const entry = __jit_debug_descriptor.relevant_entry;
> +  struct jit_code_entry *const prev_entry = entry->prev_entry;
> +
> +  if (prev_entry != NULL)
> +    {
> +      prev_entry->next_entry = NULL;
> +      entry->prev_entry = NULL;
> +    }
> +  else
> +    __jit_debug_descriptor.first_entry = NULL;
> +
> +  /* Notify GDB.  */
> +  __jit_debug_descriptor.action_flag = JIT_UNREGISTER;
> +  __jit_debug_register_code ();
> +
> +  __jit_debug_descriptor.relevant_entry = prev_entry;
> +
> +  return entry;
> +}
> +
> +#endif /* JIT_PROTOCOL_UTIL_H */
> diff --git a/gdb/testsuite/gdb.base/jit-reader-host.c b/gdb/testsuite/gdb.base/jit-reader-host.c
> index 0cca894a3a5..65f77b981d6 100644
> --- a/gdb/testsuite/gdb.base/jit-reader-host.c
> +++ b/gdb/testsuite/gdb.base/jit-reader-host.c
> @@ -24,8 +24,8 @@
>  #include <sys/mman.h>
>  
>  #include JIT_READER_H  /* Please see jit-reader.exp for an explanation.  */
> +#include "jit-protocol-util.h"
>  #include "jit-reader-host.h"
> -#include "jit-protocol.h"
>  
>  struct jit_code_entry only_entry;
>  
> @@ -85,11 +85,7 @@ main (int argc, char **argv)
>    only_entry.symfile_addr = symfile;
>    only_entry.symfile_size = sizeof (struct jithost_abi);
>  
> -  __jit_debug_descriptor.first_entry = &only_entry;
> -  __jit_debug_descriptor.relevant_entry = &only_entry;
> -  __jit_debug_descriptor.action_flag = JIT_REGISTER;
> -  __jit_debug_descriptor.version = 1;
> -  __jit_debug_register_code ();
> +  jit_push_back (&only_entry);
>  
>    function_stack_mangle ();
>    function_add (5, 6);
> -- 
> 2.35.3