* [PATCH v3 2/6] Refactor py-inferior.exp
2023-07-13 14:05 [PATCH v3 0/6] Fix some Python Inferior methods Tom Tromey
2023-07-13 14:05 ` [PATCH v3 1/6] Minor cleanups in py-inferior.exp Tom Tromey
@ 2023-07-13 14:05 ` Tom Tromey
2023-07-13 14:05 ` [PATCH v3 3/6] Rename Python variable in py-inferior.exp Tom Tromey
` (3 subsequent siblings)
5 siblings, 0 replies; 9+ messages in thread
From: Tom Tromey @ 2023-07-13 14:05 UTC (permalink / raw)
To: gdb-patches; +Cc: Pedro Alves
This changes py-inferior.exp to make it a bit more robust when adding
new inferiors during the course of the test.
Approved-By: Pedro Alves <pedro@palves.net>
---
gdb/testsuite/gdb.python/py-inferior.exp | 43 +++++++++++++++++++++-----------
1 file changed, 29 insertions(+), 14 deletions(-)
diff --git a/gdb/testsuite/gdb.python/py-inferior.exp b/gdb/testsuite/gdb.python/py-inferior.exp
index 576c2b716e6..723f212ecc3 100644
--- a/gdb/testsuite/gdb.python/py-inferior.exp
+++ b/gdb/testsuite/gdb.python/py-inferior.exp
@@ -40,6 +40,20 @@ if {![runto_main]} {
return 0
}
+# The most recently added inferior.
+set most_recent_inf 1
+
+# A helper function that adds a new inferior. It returns the expected
+# number of the new inferior. ARG is a string to pass to
+# add-inferior.
+proc add_inferior {{arg ""}} {
+ global most_recent_inf
+ incr most_recent_inf
+ gdb_test "add-inferior $arg" "Added inferior $most_recent_inf.*" \
+ "add inferior $most_recent_inf"
+ return $most_recent_inf
+}
+
# Test basic gdb.Inferior attributes and methods.
gdb_py_test_silent_cmd "python inferiors = gdb.inferiors ()" "get inferiors list" 1
@@ -234,7 +248,7 @@ with_test_prefix "is_valid" {
"gdb.events.inferior_deleted.connect(del_inf_handler)" "" \
"end" ""
- gdb_test "add-inferior" "Added inferior 2.*" "add empty inferior 2"
+ set num [add_inferior]
gdb_py_test_silent_cmd "python inf_list = gdb.inferiors()" "get new list" 1
gdb_test "python print (len(inf_list))" "2" "get inferior list length 2"
gdb_test "python print (inf_list\[0\].is_valid())" "True" \
@@ -246,7 +260,7 @@ with_test_prefix "is_valid" {
gdb_test "python print (inf_list\[1\].is_valid())" "True" \
"check inferior validity 3"
- gdb_test_no_output "remove-inferiors 2"
+ gdb_test_no_output "remove-inferiors $num"
gdb_test "python print (inf_list\[0\].is_valid())" "True" \
"check inferior validity 4"
@@ -287,15 +301,16 @@ with_test_prefix "selected_inferior" {
# Figure out if inf 1 has a native target.
set inf_1_is_native [gdb_is_target_native]
- gdb_test "add-inferior -no-connection" "Added inferior 3" "create new inferior"
- gdb_test "inferior 3" ".*" "switch to third inferior"
- gdb_test "py print (gdb.selected_inferior().num)" "3" "third inferior selected"
+ set num [add_inferior "-no-connection"]
+ gdb_test "inferior $num" ".*" "switch to inferior $num"
+ gdb_test "py print (gdb.selected_inferior().num)" "$num" \
+ "inferior $num selected"
gdb_test "py print (gdb.selected_inferior().connection_num)" "None" \
- "third inferior's None connection number"
+ "inferior $num's None connection number"
gdb_test "py print (gdb.selected_inferior().connection)" "None" \
- "third inferior's None connection"
+ "inferior $num's None connection"
gdb_test "target native" "Done. Use the \"run\" command to start a process." \
- "target for the third inferior"
+ "target for inferior $num"
# If inf 1 has a native target, inf 3's target is shared with 1's.
# Otherwise, it must have created a new target with a new number.
@@ -306,10 +321,10 @@ with_test_prefix "selected_inferior" {
}
gdb_test "py print (gdb.selected_inferior().connection_num)" \
"$expected_connection_num" \
- "third inferior's native connection number"
+ "inferior $num's native connection number"
gdb_test "py print (gdb.selected_inferior().connection.num)" \
"$expected_connection_num" \
- "third inferior's native connection number, though connection object"
+ "inferior $num's native connection number, though connection object"
# Test printing of gdb.TargetConnection object.
gdb_test "py print (gdb.selected_inferior().connection)" \
@@ -317,18 +332,18 @@ with_test_prefix "selected_inferior" {
"print a connection object"
gdb_test "inferior 1" ".*" "switch back to first inferior"
- gdb_test_no_output "remove-inferiors 3"
+ gdb_test_no_output "remove-inferiors $num"
}
# Test repr()/str()
with_test_prefix "__repr__" {
- gdb_test "add-inferior" "Added inferior 4 on connection .*" "add inferior 4"
+ set num [add_inferior]
gdb_py_test_silent_cmd "python infs = gdb.inferiors()" "get inferior list" 1
gdb_test "python print (infs\[0\])" "<gdb.Inferior num=1, pid=$decimal>"
gdb_test "python print (infs)" \
- "\\\(<gdb.Inferior num=1, pid=$decimal>, <gdb.Inferior num=4, pid=$decimal>\\\)" \
+ "\\\(<gdb.Inferior num=1, pid=$decimal>, <gdb.Inferior num=$num, pid=$decimal>\\\)" \
"print all inferiors 1"
- gdb_test_no_output "remove-inferiors 4"
+ gdb_test_no_output "remove-inferiors $num"
gdb_test "python print (infs)" \
"\\\(<gdb.Inferior num=1, pid=$decimal>, <gdb.Inferior \\\(invalid\\\)>\\\)" \
"print all inferiors 2"
--
2.40.1
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH v3 5/6] Introduce scoped_restore_current_inferior_for_memory
2023-07-13 14:05 [PATCH v3 0/6] Fix some Python Inferior methods Tom Tromey
` (3 preceding siblings ...)
2023-07-13 14:05 ` [PATCH v3 4/6] Remove obsolete comment from gdbthread.h Tom Tromey
@ 2023-07-13 14:05 ` Tom Tromey
2023-07-13 14:05 ` [PATCH v3 6/6] Use correct inferior in Inferior.read_memory et al Tom Tromey
5 siblings, 0 replies; 9+ messages in thread
From: Tom Tromey @ 2023-07-13 14:05 UTC (permalink / raw)
To: gdb-patches
This introduces a new class,
scoped_restore_current_inferior_for_memory, and arranges to use it in
a few places. This class is intended to handle setting up and
restoring the various globals that are needed to read or write memory
-- but without invalidating the frame cache.
I wasn't able to test the change to aix-thread.c.
---
gdb/aix-thread.c | 18 ++++--------------
gdb/inferior.h | 29 +++++++++++++++++++++++++++++
gdb/proc-service.c | 10 ++--------
3 files changed, 35 insertions(+), 22 deletions(-)
diff --git a/gdb/aix-thread.c b/gdb/aix-thread.c
index fbe80d656c2..74cc67c942b 100644
--- a/gdb/aix-thread.c
+++ b/gdb/aix-thread.c
@@ -615,13 +615,8 @@ pdc_read_data (pthdb_user_t user_current_pid, void *buf,
/* This is needed to eliminate the dependency of current thread
which is null so that thread reads the correct target memory. */
{
- scoped_restore save_inferior_ptid = make_scoped_restore (&inferior_ptid);
- inferior_ptid = ptid_t (user_current_pid);
- scoped_restore_current_inferior restore_inferior;
- set_current_inferior (inf);
-
- scoped_restore_current_program_space restore_current_progspace;
- set_current_program_space (inf->pspace);
+ scoped_restore_current_inferior_for_memory save_inferior
+ (inf, ptid_t (user_current_pid));
status = target_read_memory (addr, (gdb_byte *) buf, len);
}
ret = status == 0 ? PDC_SUCCESS : PDC_FAILURE;
@@ -648,13 +643,8 @@ pdc_write_data (pthdb_user_t user_current_pid, void *buf,
user_current_pid, (long) buf, hex_string (addr), len);
{
- scoped_restore save_inferior_ptid = make_scoped_restore (&inferior_ptid);
- inferior_ptid = ptid_t (user_current_pid);
- scoped_restore_current_inferior restore_inferior;
- set_current_inferior (inf);
-
- scoped_restore_current_program_space restore_current_progspace;
- set_current_program_space (inf->pspace);
+ scoped_restore_current_inferior_for_memory save_inferior
+ (inf, ptid_t (user_current_pid));
status = target_write_memory (addr, (gdb_byte *) buf, len);
}
diff --git a/gdb/inferior.h b/gdb/inferior.h
index caa8e4d494a..be76c456c8c 100644
--- a/gdb/inferior.h
+++ b/gdb/inferior.h
@@ -761,6 +761,35 @@ class scoped_restore_current_inferior
inferior *m_saved_inf;
};
+/* When reading memory from an inferior, the global inferior_ptid must
+ also be set. This class arranges to save and restore the necessary
+ state for reading or writing memory, but without invalidating the
+ frame cache. */
+
+class scoped_restore_current_inferior_for_memory
+{
+public:
+
+ /* Save the current globals and switch to the given inferior and the
+ inferior's program space. PTID must name a thread in INF, it is
+ used as the new inferior_ptid. */
+ scoped_restore_current_inferior_for_memory (inferior *inf, ptid_t ptid)
+ : m_save_ptid (&inferior_ptid)
+ {
+ set_current_inferior (inf);
+ set_current_program_space (inf->pspace);
+ inferior_ptid = ptid;
+ }
+
+ DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior_for_memory);
+
+private:
+
+ scoped_restore_current_inferior m_save_inferior;
+ scoped_restore_current_program_space m_save_progspace;
+ scoped_restore_tmpl<ptid_t> m_save_ptid;
+};
+
/* Traverse all inferiors. */
diff --git a/gdb/proc-service.c b/gdb/proc-service.c
index 509836ec1a8..366e0510070 100644
--- a/gdb/proc-service.c
+++ b/gdb/proc-service.c
@@ -72,14 +72,8 @@ static ps_err_e
ps_xfer_memory (const struct ps_prochandle *ph, psaddr_t addr,
gdb_byte *buf, size_t len, int write)
{
- scoped_restore_current_inferior restore_inferior;
- set_current_inferior (ph->thread->inf);
-
- scoped_restore_current_program_space restore_current_progspace;
- set_current_program_space (ph->thread->inf->pspace);
-
- scoped_restore save_inferior_ptid = make_scoped_restore (&inferior_ptid);
- inferior_ptid = ph->thread->ptid;
+ scoped_restore_current_inferior_for_memory save_inferior (ph->thread->inf,
+ ph->thread->ptid);
CORE_ADDR core_addr = ps_addr_to_core_addr (addr);
--
2.40.1
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH v3 6/6] Use correct inferior in Inferior.read_memory et al
2023-07-13 14:05 [PATCH v3 0/6] Fix some Python Inferior methods Tom Tromey
` (4 preceding siblings ...)
2023-07-13 14:05 ` [PATCH v3 5/6] Introduce scoped_restore_current_inferior_for_memory Tom Tromey
@ 2023-07-13 14:05 ` Tom Tromey
2023-07-14 16:56 ` Pedro Alves
5 siblings, 1 reply; 9+ messages in thread
From: Tom Tromey @ 2023-07-13 14:05 UTC (permalink / raw)
To: gdb-patches
A user noticed that Inferior.read_memory and a few other Python APIs
will always use the currently selected inferior, not the one passed to
the call.
This patch fixes the bug by arranging to switch to the inferior. I
found this same issue in several APIs, so this fixes them all.
I also added a few missing calls to INFPY_REQUIRE_VALID to these
methods.
Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=30615
---
gdb/python/py-inferior.c | 43 ++++++++++++++++++++++++++------
gdb/testsuite/gdb.python/py-inferior.exp | 26 +++++++++++++++++++
2 files changed, 62 insertions(+), 7 deletions(-)
diff --git a/gdb/python/py-inferior.c b/gdb/python/py-inferior.c
index af8bd8855a3..f6000b944da 100644
--- a/gdb/python/py-inferior.c
+++ b/gdb/python/py-inferior.c
@@ -30,6 +30,7 @@
#include "gdbsupport/gdb_signals.h"
#include "py-event.h"
#include "py-stopevent.h"
+#include "progspace-and-thread.h"
#include <unordered_map>
using thread_map_t
@@ -528,11 +529,14 @@ gdbpy_inferiors (PyObject *unused, PyObject *unused2)
static PyObject *
infpy_read_memory (PyObject *self, PyObject *args, PyObject *kw)
{
+ inferior_object *inf = (inferior_object *) self;
CORE_ADDR addr, length;
gdb::unique_xmalloc_ptr<gdb_byte> buffer;
PyObject *addr_obj, *length_obj;
static const char *keywords[] = { "address", "length", NULL };
+ INFPY_REQUIRE_VALID (inf);
+
if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "OO", keywords,
&addr_obj, &length_obj))
return NULL;
@@ -543,6 +547,11 @@ infpy_read_memory (PyObject *self, PyObject *args, PyObject *kw)
try
{
+ /* Use this scoped-restore because we want to be able to read
+ memory from an unwinder. */
+ scoped_restore_current_inferior_for_memory restore_inferior
+ (inf->inferior, any_thread_of_inferior (inf->inferior)->ptid);
+
buffer.reset ((gdb_byte *) xmalloc (length));
read_memory (addr, buffer.get (), length);
@@ -565,6 +574,7 @@ infpy_read_memory (PyObject *self, PyObject *args, PyObject *kw)
static PyObject *
infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
{
+ inferior_object *inf = (inferior_object *) self;
struct gdb_exception except;
Py_ssize_t buf_len;
const gdb_byte *buffer;
@@ -573,6 +583,8 @@ infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
static const char *keywords[] = { "address", "buffer", "length", NULL };
Py_buffer pybuf;
+ INFPY_REQUIRE_VALID (inf);
+
if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "Os*|O", keywords,
&addr_obj, &pybuf, &length_obj))
return NULL;
@@ -591,6 +603,13 @@ infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
try
{
+ /* It's probably not too important to avoid invalidating the
+ frame cache when writing memory, but this scoped-restore is
+ still used here, just to keep the code similar to other code
+ in this file. */
+ scoped_restore_current_inferior_for_memory restore_inferior
+ (inf->inferior, any_thread_of_inferior (inf->inferior)->ptid);
+
write_memory_with_notification (addr, buffer, length);
}
catch (gdb_exception &ex)
@@ -604,7 +623,7 @@ infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
}
/* Implementation of
- gdb.search_memory (address, length, pattern). ADDRESS is the
+ Inferior.search_memory (address, length, pattern). ADDRESS is the
address to start the search. LENGTH specifies the scope of the
search from ADDRESS. PATTERN is the pattern to search for (and
must be a Python object supporting the buffer protocol).
@@ -614,6 +633,7 @@ infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
static PyObject *
infpy_search_memory (PyObject *self, PyObject *args, PyObject *kw)
{
+ inferior_object *inf = (inferior_object *) self;
struct gdb_exception except;
CORE_ADDR start_addr, length;
static const char *keywords[] = { "address", "length", "pattern", NULL };
@@ -624,6 +644,8 @@ infpy_search_memory (PyObject *self, PyObject *args, PyObject *kw)
int found = 0;
Py_buffer pybuf;
+ INFPY_REQUIRE_VALID (inf);
+
if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "OOs*", keywords,
&start_addr_obj, &length_obj,
&pybuf))
@@ -656,6 +678,13 @@ infpy_search_memory (PyObject *self, PyObject *args, PyObject *kw)
try
{
+ /* It's probably not too important to avoid invalidating the
+ frame cache when searching memory, but this scoped-restore is
+ still used here, just to keep the code similar to other code
+ in this file. */
+ scoped_restore_current_inferior_for_memory restore_inferior
+ (inf->inferior, any_thread_of_inferior (inf->inferior)->ptid);
+
found = target_search_memory (start_addr, length,
buffer, pattern_size,
&found_addr);
@@ -910,12 +939,12 @@ infpy_get_main_name (PyObject *self, void *closure)
try
{
/* This is unfortunate but the implementation of main_name can
- reach into memory. */
- scoped_restore_current_inferior restore_inferior;
- set_current_inferior (inf->inferior);
-
- scoped_restore_current_program_space restore_current_progspace;
- set_current_program_space (inf->inferior->pspace);
+ reach into memory. It's probably not too important to avoid
+ invalidating the frame cache here, but this scoped-restore is
+ still used, just to keep the code similar to other code in
+ this file. */
+ scoped_restore_current_inferior_for_memory restore_inferior
+ (inf->inferior, any_thread_of_inferior (inf->inferior)->ptid);
name = main_name ();
}
diff --git a/gdb/testsuite/gdb.python/py-inferior.exp b/gdb/testsuite/gdb.python/py-inferior.exp
index 8762b6992ca..eb501838117 100644
--- a/gdb/testsuite/gdb.python/py-inferior.exp
+++ b/gdb/testsuite/gdb.python/py-inferior.exp
@@ -91,6 +91,7 @@ gdb_py_test_silent_cmd "python addr = gdb.selected_frame ().read_var ('str')" \
gdb_test "python astr = gdb.inferiors()\[0\].read_memory (addr, 5); print(astr)" \
"<memory at $hex>" \
"read str contents"
+gdb_test "python print(astr\[0\])" .*
gdb_py_test_silent_cmd "python a = bytes('a', 'ascii')" "" 0
gdb_py_test_silent_cmd "python astr\[1\] = a" "change str" 0
gdb_py_test_silent_cmd "python gdb.inferiors()\[0\].write_memory (addr, astr)" \
@@ -98,6 +99,10 @@ gdb_py_test_silent_cmd "python gdb.inferiors()\[0\].write_memory (addr, astr)" \
gdb_test "print str" " = \"hallo, testsuite\"" \
"ensure str was changed in the inferior"
+# Add a new inferior here, so we can test that operations work on the
+# correct inferior.
+set num [add_inferior]
+
# Test memory search.
set hex_number {0x[0-9a-fA-F][0-9a-fA-F]*}
@@ -115,6 +120,9 @@ with_test_prefix "string" {
gdb_test_no_output "py start_addr = search_buf.address"
gdb_test_no_output "py length = search_buf.type.sizeof"
+ # Switch to the new inferior before testing.
+ gdb_test "inferior $num" ".*" "switch to inferior $num"
+
gdb_test "py print (gdb.inferiors()\[0\].search_memory (start_addr, length, 'aaa'))" \
"${one_pattern_found}" "find string pattern"
@@ -128,6 +136,24 @@ with_test_prefix "string" {
"${one_pattern_found}" "pattern found at end of range"
}
+# While still in the new inferior, test reading and writing memory
+# again.
+gdb_test "python astr = gdb.inferiors()\[0\].read_memory (addr, 5); print(astr)" \
+ "<memory at $hex>" \
+ "read str while other inferior selected"
+gdb_test "python print(astr\[1\])" "b'a'" \
+ "print a character from the string"
+gdb_py_test_silent_cmd "python astr\[1\] = b'X'" "change str again" 0
+gdb_py_test_silent_cmd "python gdb.inferiors()\[0\].write_memory (addr, astr)" \
+ "write str while other inferior selected" 1
+
+gdb_test "inferior 1" ".*" "switch back to inferior 1"
+
+gdb_test "print str" " = \"hXllo, testsuite\"" \
+ "ensure str was changed while other inferior selected"
+
+gdb_test_no_output "remove-inferiors $num" "remove-inferiors $num"
+
# Import struct to pack the following patterns.
gdb_test_no_output "py from struct import *"
--
2.40.1
^ permalink raw reply [flat|nested] 9+ messages in thread