binutils-gdb/gdb/python/py-newobjfileevent.c
Tom Tromey 0b4fe76f95 Add gdb.free_objfile event registry
Currently, Python code can use event registries to detect when gdb
loads a new objfile, and when gdb clears the objfile list.  However,
there's no way to detect the removal of an objfile, say when the
inferior calls dlclose.

This patch adds a gdb.free_objfile event registry and arranges for an
event to be emitted in this case.
2022-07-18 11:25:34 -06:00

128 lines
3.7 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* Python interface to new object file loading events.
Copyright (C) 2011-2022 Free Software Foundation, Inc.
This file is part of GDB.
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/>. */
#include "defs.h"
#include "py-event.h"
static gdbpy_ref<>
create_new_objfile_event_object (struct objfile *objfile)
{
gdbpy_ref<> objfile_event
= create_event_object (&new_objfile_event_object_type);
if (objfile_event == NULL)
return NULL;
gdbpy_ref<> py_objfile = objfile_to_objfile_object (objfile);
if (py_objfile == NULL || evpy_add_attribute (objfile_event.get (),
"new_objfile",
py_objfile.get ()) < 0)
return NULL;
return objfile_event;
}
/* Callback function which notifies observers when a new objfile event occurs.
This function will create a new Python new_objfile event object.
Return -1 if emit fails. */
int
emit_new_objfile_event (struct objfile *objfile)
{
if (evregpy_no_listeners_p (gdb_py_events.new_objfile))
return 0;
gdbpy_ref<> event = create_new_objfile_event_object (objfile);
if (event != NULL)
return evpy_emit_event (event.get (), gdb_py_events.new_objfile);
return -1;
}
/* Create an event object representing a to-be-freed objfile. Return
nullptr, with the Python exception set, on error. */
static gdbpy_ref<>
create_free_objfile_event_object (struct objfile *objfile)
{
gdbpy_ref<> objfile_event
= create_event_object (&free_objfile_event_object_type);
if (objfile_event == nullptr)
return nullptr;
gdbpy_ref<> py_objfile = objfile_to_objfile_object (objfile);
if (py_objfile == nullptr
|| evpy_add_attribute (objfile_event.get (), "objfile",
py_objfile.get ()) < 0)
return nullptr;
return objfile_event;
}
/* Callback function which notifies observers when a free objfile
event occurs. This function will create a new Python event object.
Return -1 if emit fails. */
int
emit_free_objfile_event (struct objfile *objfile)
{
if (evregpy_no_listeners_p (gdb_py_events.free_objfile))
return 0;
gdbpy_ref<> event = create_free_objfile_event_object (objfile);
if (event == nullptr)
return -1;
return evpy_emit_event (event.get (), gdb_py_events.free_objfile);
}
/* Subroutine of emit_clear_objfiles_event to simplify it. */
static gdbpy_ref<>
create_clear_objfiles_event_object (void)
{
gdbpy_ref<> objfile_event
= create_event_object (&clear_objfiles_event_object_type);
if (objfile_event == NULL)
return NULL;
gdbpy_ref<> py_progspace = pspace_to_pspace_object (current_program_space);
if (py_progspace == NULL || evpy_add_attribute (objfile_event.get (),
"progspace",
py_progspace.get ()) < 0)
return NULL;
return objfile_event;
}
/* Callback function which notifies observers when the "clear objfiles"
event occurs.
This function will create a new Python clear_objfiles event object.
Return -1 if emit fails. */
int
emit_clear_objfiles_event (void)
{
if (evregpy_no_listeners_p (gdb_py_events.clear_objfiles))
return 0;
gdbpy_ref<> event = create_clear_objfiles_event_object ();
if (event != NULL)
return evpy_emit_event (event.get (), gdb_py_events.clear_objfiles);
return -1;
}