+2021-04-27 Michael Weghorn <m.weghorn@posteo.de>
+ Simon Marchi <simon.marchi@polymtl.ca>
+
+ * gdb/auto-load.c (_initialize_auto_load): 'Specify token
+ when attaching the 'auto_load_new_objfile' observer, so
+ other observers can specify it as a dependency.
+ * gdb/auto-load.h (struct token): Declare
+ 'auto_load_new_objfile_observer_token' as token to be used
+ for the 'auto_load_new_objfile' observer.
+ * gdb/python/py-inferior.c (gdbpy_initialize_inferior): Make
+ 'python_new_objfile' observer depend on 'auto_load_new_objfile'
+ observer, so it gets notified after the latter.
+
2021-04-27 Michael Weghorn <m.weghorn@posteo.de>
Simon Marchi <simon.marchi@polymtl.ca>
return &retval;
}
+/* See auto-load.h. */
+
+gdb::observers::token auto_load_new_objfile_observer_token;
+
void _initialize_auto_load ();
void
_initialize_auto_load ()
char *guile_name_help;
const char *suffix;
- gdb::observers::new_objfile.attach (auto_load_new_objfile, "auto-load");
-
+ gdb::observers::new_objfile.attach (auto_load_new_objfile,
+ auto_load_new_objfile_observer_token,
+ "auto-load");
add_setshow_boolean_cmd ("gdb-scripts", class_support,
&auto_load_gdb_scripts, _("\
Enable or disable auto-loading of canned sequences of commands scripts."), _("\
struct auto_load_pspace_info;
struct extension_language_defn;
+namespace gdb::observers {
+struct token;
+}
+
/* Value of the 'set debug auto-load' configuration variable. */
extern bool debug_auto_load;
extern char *auto_load_local_gdbinit_pathname;
extern bool auto_load_local_gdbinit_loaded;
+/* Token used for the auto_load_new_objfile observer, so other observers can
+ specify it as a dependency. */
+extern gdb::observers::token auto_load_new_objfile_observer_token;
+
extern struct auto_load_pspace_info *
get_auto_load_pspace_data_for_loading (struct program_space *pspace);
extern void auto_load_objfile_script (struct objfile *objfile,
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
+#include "auto-load.h"
#include "gdbcore.h"
#include "gdbthread.h"
#include "inferior.h"
gdb::observers::register_changed.attach (python_on_register_change,
"py-inferior");
gdb::observers::inferior_exit.attach (python_inferior_exit, "py-inferior");
- gdb::observers::new_objfile.attach (python_new_objfile, "py-inferior");
+ /* Need to run after auto-load's new_objfile observer, so that
+ auto-loaded pretty-printers are available. */
+ gdb::observers::new_objfile.attach
+ (python_new_objfile, "py-inferior",
+ { &auto_load_new_objfile_observer_token });
gdb::observers::inferior_added.attach (python_new_inferior, "py-inferior");
gdb::observers::inferior_removed.attach (python_inferior_deleted,
"py-inferior");
+2021-04-27 Michael Weghorn <m.weghorn@posteo.de>
+ Simon Marchi <simon.marchi@polymtl.ca>
+
+ * gdb.python/libpy-autoloaded-pretty-printers-in-newobjfile-event.so-gdb.py: New test.
+ * gdb.python/py-autoloaded-pretty-printers-in-newobjfile-event-lib.cc: New test.
+ * gdb.python/py-autoloaded-pretty-printers-in-newobjfile-event-lib.h: New test.
+ * gdb.python/py-autoloaded-pretty-printers-in-newobjfile-event-main.cc: New test.
+ * gdb.python/py-autoloaded-pretty-printers-in-newobjfile-event.exp: New test.
+ * gdb.python/py-autoloaded-pretty-printers-in-newobjfile-event.py: New test.
+
2021-04-26 Tom Tromey <tromey@adacore.com>
PR gdb/27743:
--- /dev/null
+# Copyright (C) 2021 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/>.
+
+# This file is part of the GDB testsuite. It tests that python pretty
+# printers defined in a python script that is autoloaded have been
+# registered when a custom event handler for the new_objfile event
+# is called.
+
+import gdb.printing
+
+
+class MyClassTestLibPrinter(object):
+ "Print a MyClassTestLib"
+
+ def __init__(self, val):
+ self.val = val
+
+ def to_string(self):
+ return "MyClassTestLib object, id: {}".format(self.val["id"])
+
+ def display_hint(self):
+ return "string"
+
+
+def build_pretty_printer():
+ pp = gdb.printing.RegexpCollectionPrettyPrinter("my_library")
+ pp.add_printer("MyClassTestLib", "^MyClassTestLib$", MyClassTestLibPrinter)
+ return pp
+
+
+gdb.printing.register_pretty_printer(gdb.current_objfile(), build_pretty_printer())
--- /dev/null
+/* This testcase is part of GDB, the GNU debugger.
+
+ Copyright 2021 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/>. */
+
+#include "py-autoloaded-pretty-printers-in-newobjfile-event-lib.h"
+
+MyClassTestLib::MyClassTestLib (int theId)
+{
+ id = theId;
+}
+
+int MyClassTestLib::getId ()
+{
+ return id;
+}
--- /dev/null
+/* This testcase is part of GDB, the GNU debugger.
+
+ Copyright 2021 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/>. */
+
+#ifndef TESTLIBRARY_H
+#define TESTLIBRARY_H
+
+class MyClassTestLib
+{
+public:
+ explicit MyClassTestLib (int theId);
+ int getId ();
+
+private:
+ int id;
+};
+
+#endif /* TESTLIBRARY_H */
--- /dev/null
+/* This testcase is part of GDB, the GNU debugger.
+
+ Copyright 2021 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/>. */
+
+#include "py-autoloaded-pretty-printers-in-newobjfile-event-lib.h"
+
+bool all_good = false;
+
+int
+main ()
+{
+ MyClassTestLib test (1);
+ return 0; /* break to inspect */
+}
--- /dev/null
+# Copyright (C) 2021 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/>.
+
+# This file is part of the GDB testsuite. It tests that Python pretty-printers
+# defined in a Python script that is autoloaded are registered when an event
+# handler for the new_objfile event is called.
+
+load_lib gdb-python.exp
+
+standard_testfile -main.cc
+
+set srcfile_lib "${testfile}-lib.cc"
+set python_event_handler_file "${srcdir}/${subdir}/${testfile}.py"
+set libname "lib${testfile}"
+set python_autoload_file "${srcdir}/${subdir}/${libname}.so-gdb.py"
+set binfile_lib [standard_output_file "${libname}.so"]
+
+# Start GDB first - needed for skip_python_tests.
+clean_restart
+
+# Skip all tests if Python scripting is not enabled.
+if { [skip_python_tests] } { continue }
+
+# Compile library.
+if { [gdb_compile_shlib ${srcdir}/${subdir}/${srcfile_lib} ${binfile_lib} \
+ {debug c++}] != "" } {
+ return -1
+}
+
+# Compile main program.
+if { [gdb_compile ${srcdir}/${subdir}/${srcfile} \
+ ${binfile} \
+ executable \
+ [list debug c++ shlib=$binfile_lib]] != "" } {
+ return -1
+}
+
+# Make the -gdb.py script available to gdb, it is automatically loaded by
+# gdb if it is put in the same directory as the library.
+set remote_python_autoload_file \
+ [gdb_remote_download host $python_autoload_file]
+
+gdb_test_no_output \
+ "set auto-load safe-path ${remote_python_autoload_file}" \
+ "set auto-load safe-path"
+
+# Load the Python file that defines a handler for the new_objfile event.
+set remote_python_event_handler_file\
+ [gdb_remote_download host $python_event_handler_file]
+gdb_test_no_output "source ${remote_python_event_handler_file}" "load python file"
+
+gdb_load ${binfile}
+
+gdb_test_no_output "set print pretty on"
+
+if { ![runto_main] } {
+ fail "failed to run to main"
+ return
+}
+
+# Check that the new_objfile handler saw the pretty-printer.
+gdb_test "print all_good" " = true"
+
+# Check that the pretty-printer actually works.
+gdb_test "info pretty-printer" "my_library.*MyClassTestLib.*"
+gdb_breakpoint [gdb_get_line_number "break to inspect"]
+gdb_test "continue" "Breakpoint $decimal, main .*"
+gdb_test "print test" "MyClassTestLib object, id: 1.*"
--- /dev/null
+# Copyright (C) 2021 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/>.
+
+# This file is part of the GDB testsuite. It tests that python pretty
+# printers defined in a python script that is autoloaded have been
+# registered when a custom event handler for the new_objfile event
+# is called.
+
+import gdb
+import os
+
+
+def new_objfile_handler(event):
+ assert isinstance(event, gdb.NewObjFileEvent)
+ objfile = event.new_objfile
+
+ # Only observe the custom test library.
+ libname = "libpy-autoloaded-pretty-printers-in-newobjfile-event"
+ if libname in os.path.basename(objfile.filename):
+ # If everything went well and the pretty-printer auto-load happened
+ # before notifying the Python listeners, we expect to see one pretty
+ # printer, and it must be ours.
+ all_good = (
+ len(objfile.pretty_printers) == 1
+ and objfile.pretty_printers[0].name == "my_library"
+ )
+
+ if all_good:
+ gdb.parse_and_eval("all_good = 1")
+ else:
+ print("Oops, not all good:")
+ print("pretty printer count: {}".format(len(objfile.pretty_printers)))
+
+ for pp in objfile.pretty_printers:
+ print(" - {}".format(pp.name))
+
+
+gdb.events.new_objfile.connect(new_objfile_handler)