diff options
author | Andrew Burgess <aburgess@redhat.com> | 2022-09-16 16:08:17 +0100 |
---|---|---|
committer | Andrew Burgess <aburgess@redhat.com> | 2023-05-05 18:24:42 +0100 |
commit | 3965bff5b9ae0957dfa882f7480dd20dae7adbfc (patch) | |
tree | 4d63641e8e24a6df8fd99782eab0d372f376bff0 /gdb/python/py-auto-load.c | |
parent | a5d3f94c271dde580980d82c2a8420bf6612e58c (diff) | |
download | binutils-3965bff5b9ae0957dfa882f7480dd20dae7adbfc.zip binutils-3965bff5b9ae0957dfa882f7480dd20dae7adbfc.tar.gz binutils-3965bff5b9ae0957dfa882f7480dd20dae7adbfc.tar.bz2 |
gdb/python: add mechanism to manage Python initialization functions
Currently, when we add a new python sub-system to GDB,
e.g. py-inferior.c, we end up having to create a new function like
gdbpy_initialize_inferior, which then has to be called from the
function do_start_initialization in python.c.
In some cases (py-micmd.c and py-tui.c), we have two functions
gdbpy_initialize_*, and gdbpy_finalize_*, with the second being called
from finalize_python which is also in python.c.
This commit proposes a mechanism to manage these initialization and
finalization calls, this means that adding a new Python subsystem will
no longer require changes to python.c or python-internal.h, instead,
the initialization and finalization functions will be registered
directly from the sub-system file, e.g. py-inferior.c, or py-micmd.c.
The initialization and finalization functions are managed through a
new class gdbpy_initialize_file in python-internal.h. This class
contains a single global vector of all the initialization and
finalization functions.
In each Python sub-system we create a new gdbpy_initialize_file
object, the object constructor takes care of registering the two
callback functions.
Now from python.c we can call static functions on the
gdbpy_initialize_file class which take care of walking the callback
list and invoking each callback in turn.
To slightly simplify the Python sub-system files I added a new macro
GDBPY_INITIALIZE_FILE, which hides the need to create an object. We
can now just do this:
GDBPY_INITIALIZE_FILE (gdbpy_initialize_registers);
One possible problem with this change is that there is now no
guaranteed ordering of how the various sub-systems are initialized (or
finalized). To try and avoid dependencies creeping in I have added a
use of the environment variable GDB_REVERSE_INIT_FUNCTIONS, this is
the same environment variable used in the generated init.c file.
Just like with init.c, when this environment variable is set we
reverse the list of Python initialization (and finalization)
functions. As there is already a test that starts GDB with the
environment variable set then this should offer some level of
protection against dependencies creeping in - though for full
protection I guess we'd need to run all gdb.python/*.exp tests with
the variable set.
I have tested this patch with the environment variable set, and saw no
regressions, so I think we are fine right now.
One other change of note was for gdbpy_initialize_gdb_readline, this
function previously returned void. In order to make this function
have the correct signature I've updated its return type to int, and we
now return 0 to indicate success.
All of the other initialize (and finalize) functions have been made
static within their respective sub-system files.
There should be no user visible changes after this commit.
Diffstat (limited to 'gdb/python/py-auto-load.c')
-rw-r--r-- | gdb/python/py-auto-load.c | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/gdb/python/py-auto-load.c b/gdb/python/py-auto-load.c index ed6202d..76ae3af 100644 --- a/gdb/python/py-auto-load.c +++ b/gdb/python/py-auto-load.c @@ -56,7 +56,7 @@ info_auto_load_python_scripts (const char *pattern, int from_tty) auto_load_info_scripts (pattern, from_tty, &extension_language_python); } -int +static int CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION gdbpy_initialize_auto_load (void) { add_setshow_boolean_cmd ("python-scripts", class_support, @@ -95,3 +95,5 @@ Print the list of automatically loaded Python scripts, deprecated.")); return 0; } + +GDBPY_INITIALIZE_FILE (gdbpy_initialize_auto_load); |