Skip to content

Commit

Permalink
gdbserver: fix memory leak when handling qsupported packet
Browse files Browse the repository at this point in the history
When building gdbserver with AddressSanitizer, I get this annoying
little leak when gdbserver exits:

==307817==ERROR: LeakSanitizer: detected memory leaks

    Direct leak of 14 byte(s) in 1 object(s) allocated from:
        #0 0x7f7fd4256459 in __interceptor_malloc /build/gcc/src/gcc/libsanitizer/asan/asan_malloc_linux.cpp:145
        riscvarchive#1 0x563bef981b80 in xmalloc /home/simark/src/binutils-gdb/gdbserver/../gdb/alloc.c:60
        riscvarchive#2 0x563befb53301 in xstrdup /home/simark/src/binutils-gdb/libiberty/xstrdup.c:34
        riscvarchive#3 0x563bef9d742b in handle_query /home/simark/src/binutils-gdb/gdbserver/server.cc:2286
        riscvarchive#4 0x563bef9ed0b7 in process_serial_event /home/simark/src/binutils-gdb/gdbserver/server.cc:4061
        riscvarchive#5 0x563bef9f1d9e in handle_serial_event(int, void*) /home/simark/src/binutils-gdb/gdbserver/server.cc:4402
        riscvarchive#6 0x563befb0ec65 in handle_file_event /home/simark/src/binutils-gdb/gdbsupport/event-loop.cc:548
        riscvarchive#7 0x563befb0f49f in gdb_wait_for_event /home/simark/src/binutils-gdb/gdbsupport/event-loop.cc:673
        riscvarchive#8 0x563befb0d4a1 in gdb_do_one_event() /home/simark/src/binutils-gdb/gdbsupport/event-loop.cc:215
        riscvarchive#9 0x563bef9e721a in start_event_loop /home/simark/src/binutils-gdb/gdbserver/server.cc:3484
        riscvarchive#10 0x563bef9eb90a in captured_main /home/simark/src/binutils-gdb/gdbserver/server.cc:3875
        riscvarchive#11 0x563bef9ec2c7 in main /home/simark/src/binutils-gdb/gdbserver/server.cc:3961
        riscvarchive#12 0x7f7fd3330001 in __libc_start_main (/usr/lib/libc.so.6+0x27001)

    SUMMARY: AddressSanitizer: 14 byte(s) leaked in 1 allocation(s).

This is due to the handling of unknown qsupported features in
handle_query.  The `qsupported` vector is built, containing all the
feature names received from GDB.  As we iterate on them, when we
encounter unknown ones, we move them at the beginning of the vector, in
preparation of passing this vector of unknown features down to the
target (which may know about them).

When moving these unknown features to other slots in the vector, we
overwrite other pointers without freeing them, which therefore leak.

An easy fix would be to add a `free` when doing the move.  However, I
think this is a good opportunity to sprinkle a bit of automatic memory
management in this code.

So, use a vector of std::string which owns all the entries.  And use a
separate vector (that doesn't own the entries) for the unknown ones,
which is then passed to target_process_qsupported.

Given that the `c_str` method of std::string returns a `const char *`,
it follows that process_stratum_target::process_qsupported must accept a
`const char **` instead of a `char **`.  And while at it, change the
pointer + size paramters to use an array_view instead.

gdbserver/ChangeLog:

	* server.cc (handle_query): Use std::vector of
	std::string for `qsupported` vector.  Use separate
	vector for unknowns.
	* target.h (class process_stratum_target) <process_qsupported>:
	Change parameters to array_view of const char *.
	(target_process_qsupported): Remove `count` parameter.
	* target.cc (process_stratum_target::process_qsupported): Change
	parameters to array_view of const char *.
	* linux-x86-low.cc (class x86_target) <process_qsupported>:
	Likewise.

Change-Id: I97f133825faa6d7abbf83a58504eb0ba77462812
simark committed Jul 14, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 0a3a820 commit b315b67
Showing 5 changed files with 42 additions and 41 deletions.
13 changes: 13 additions & 0 deletions gdbserver/ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
2020-07-13 Simon Marchi <simon.marchi@polymtl.ca>

* server.cc (handle_query): Use std::vector of
std::string for `qsupported` vector. Use separate
vector for unknowns.
* target.h (class process_stratum_target) <process_qsupported>:
Change parameters to array_view of const char *.
(target_process_qsupported): Remove `count` parameter.
* target.cc (process_stratum_target::process_qsupported): Change
parameters to array_view of const char *.
* linux-x86-low.cc (class x86_target) <process_qsupported>:
Likewise.

2020-06-29 Tom de Vries <tdevries@suse.de>

* ax.h: Include gdbsupport/debug_agent.h.
12 changes: 5 additions & 7 deletions gdbserver/linux-x86-low.cc
Original file line number Diff line number Diff line change
@@ -106,7 +106,7 @@ class x86_target : public linux_process_target

bool supports_z_point_type (char z_type) override;

void process_qsupported (char **features, int count) override;
void process_qsupported (gdb::array_view<const char * const> features) override;

bool supports_tracepoints () override;

@@ -1003,18 +1003,15 @@ x86_target::update_xmltarget ()
PTRACE_GETREGSET. */

void
x86_target::process_qsupported (char **features, int count)
x86_target::process_qsupported (gdb::array_view<const char * const> features)
{
int i;

/* Return if gdb doesn't support XML. If gdb sends "xmlRegisters="
with "i386" in qSupported query, it supports x86 XML target
descriptions. */
use_xml = 0;
for (i = 0; i < count; i++)
{
const char *feature = features[i];

for (const char *feature : features)
{
if (startswith (feature, "xmlRegisters="))
{
char *copy = xstrdup (feature + 13);
@@ -1034,6 +1031,7 @@ x86_target::process_qsupported (char **features, int count)
free (copy);
}
}

update_xmltarget ();
}

45 changes: 16 additions & 29 deletions gdbserver/server.cc
Original file line number Diff line number Diff line change
@@ -2269,76 +2269,69 @@ handle_query (char *own_buf, int packet_len, int *new_packet_len_p)
';'. */
if (*p == ':')
{
char **qsupported = NULL;
int count = 0;
int unknown = 0;
int i;
std::vector<std::string> qsupported;
std::vector<const char *> unknowns;

/* Two passes, to avoid nested strtok calls in
target_process_qsupported. */
char *saveptr;
for (p = strtok_r (p + 1, ";", &saveptr);
p != NULL;
p = strtok_r (NULL, ";", &saveptr))
{
count++;
qsupported = XRESIZEVEC (char *, qsupported, count);
qsupported[count - 1] = xstrdup (p);
}
qsupported.emplace_back (p);

for (i = 0; i < count; i++)
for (const std::string &feature : qsupported)
{
p = qsupported[i];
if (strcmp (p, "multiprocess+") == 0)
if (feature == "multiprocess+")
{
/* GDB supports and wants multi-process support if
possible. */
if (target_supports_multi_process ())
cs.multi_process = 1;
}
else if (strcmp (p, "qRelocInsn+") == 0)
else if (feature == "qRelocInsn+")
{
/* GDB supports relocate instruction requests. */
gdb_supports_qRelocInsn = 1;
}
else if (strcmp (p, "swbreak+") == 0)
else if (feature == "swbreak+")
{
/* GDB wants us to report whether a trap is caused
by a software breakpoint and for us to handle PC
adjustment if necessary on this target. */
if (target_supports_stopped_by_sw_breakpoint ())
cs.swbreak_feature = 1;
}
else if (strcmp (p, "hwbreak+") == 0)
else if (feature == "hwbreak+")
{
/* GDB wants us to report whether a trap is caused
by a hardware breakpoint. */
if (target_supports_stopped_by_hw_breakpoint ())
cs.hwbreak_feature = 1;
}
else if (strcmp (p, "fork-events+") == 0)
else if (feature == "fork-events+")
{
/* GDB supports and wants fork events if possible. */
if (target_supports_fork_events ())
cs.report_fork_events = 1;
}
else if (strcmp (p, "vfork-events+") == 0)
else if (feature == "vfork-events+")
{
/* GDB supports and wants vfork events if possible. */
if (target_supports_vfork_events ())
cs.report_vfork_events = 1;
}
else if (strcmp (p, "exec-events+") == 0)
else if (feature == "exec-events+")
{
/* GDB supports and wants exec events if possible. */
if (target_supports_exec_events ())
cs.report_exec_events = 1;
}
else if (strcmp (p, "vContSupported+") == 0)
else if (feature == "vContSupported+")
cs.vCont_supported = 1;
else if (strcmp (p, "QThreadEvents+") == 0)
else if (feature == "QThreadEvents+")
;
else if (strcmp (p, "no-resumed+") == 0)
else if (feature == "no-resumed+")
{
/* GDB supports and wants TARGET_WAITKIND_NO_RESUMED
events. */
@@ -2347,19 +2340,13 @@ handle_query (char *own_buf, int packet_len, int *new_packet_len_p)
else
{
/* Move the unknown features all together. */
qsupported[i] = NULL;
qsupported[unknown] = p;
unknown++;
unknowns.push_back (feature.c_str ());
}
}

/* Give the target backend a chance to process the unknown
features. */
target_process_qsupported (qsupported, unknown);

for (i = 0; i < count; i++)
free (qsupported[i]);
free (qsupported);
target_process_qsupported (unknowns);
}

sprintf (own_buf,
3 changes: 2 additions & 1 deletion gdbserver/target.cc
Original file line number Diff line number Diff line change
@@ -599,7 +599,8 @@ process_stratum_target::read_loadmap (const char *annex,
}

void
process_stratum_target::process_qsupported (char **features, int count)
process_stratum_target::process_qsupported
(gdb::array_view<const char * const> features)
{
/* Nop. */
}
10 changes: 6 additions & 4 deletions gdbserver/target.h
Original file line number Diff line number Diff line change
@@ -27,6 +27,7 @@
#include "target/wait.h"
#include "target/waitstatus.h"
#include "mem-break.h"
#include "gdbsupport/array-view.h"
#include "gdbsupport/btrace-common.h"
#include <vector>

@@ -315,8 +316,9 @@ class process_stratum_target
unsigned char *myaddr, unsigned int len);

/* Target specific qSupported support. FEATURES is an array of
features with COUNT elements. */
virtual void process_qsupported (char **features, int count);
features unsupported by the core of GDBserver. */
virtual void process_qsupported
(gdb::array_view<const char * const> features);

/* Return true if the target supports tracepoints, false otherwise. */
virtual bool supports_tracepoints ();
@@ -547,8 +549,8 @@ int kill_inferior (process_info *proc);
#define target_async(enable) \
the_target->async (enable)

#define target_process_qsupported(features, count) \
the_target->process_qsupported (features, count)
#define target_process_qsupported(features) \
the_target->process_qsupported (features)

#define target_supports_catch_syscall() \
the_target->supports_catch_syscall ()

0 comments on commit b315b67

Please sign in to comment.