2005-01-06 18:27:30 +00:00
|
|
|
/*-
|
2017-11-27 15:16:59 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
|
|
*
|
2004-07-10 17:47:22 +00:00
|
|
|
* Copyright (c) 2004 Marcel Moolenaar
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
*
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
|
|
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
|
|
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <sys/cdefs.h>
|
|
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
|
|
|
|
#include <sys/param.h>
|
|
|
|
#include <sys/systm.h>
|
|
|
|
#include <sys/kdb.h>
|
|
|
|
#include <sys/kernel.h>
|
|
|
|
#include <sys/pcpu.h>
|
|
|
|
#include <sys/proc.h>
|
|
|
|
#include <sys/reboot.h>
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
#include <sys/sbuf.h>
|
2004-07-10 17:47:22 +00:00
|
|
|
|
|
|
|
#include <machine/gdb_machdep.h>
|
|
|
|
#include <machine/kdb.h>
|
|
|
|
|
|
|
|
#include <gdb/gdb.h>
|
|
|
|
#include <gdb/gdb_int.h>
|
|
|
|
|
2020-02-26 14:26:36 +00:00
|
|
|
SYSCTL_NODE(_debug, OID_AUTO, gdb, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
|
|
|
|
"GDB settings");
|
2019-09-08 22:52:47 +00:00
|
|
|
|
2004-07-10 17:47:22 +00:00
|
|
|
static dbbe_init_f gdb_init;
|
|
|
|
static dbbe_trap_f gdb_trap;
|
|
|
|
|
2012-04-12 21:34:58 +00:00
|
|
|
KDB_BACKEND(gdb, gdb_init, NULL, NULL, gdb_trap);
|
2004-07-10 17:47:22 +00:00
|
|
|
|
2006-05-26 11:52:59 +00:00
|
|
|
static struct gdb_dbgport null_gdb_dbgport;
|
|
|
|
DATA_SET(gdb_dbgport_set, null_gdb_dbgport);
|
2004-07-10 17:47:22 +00:00
|
|
|
SET_DECLARE(gdb_dbgport_set, struct gdb_dbgport);
|
|
|
|
|
|
|
|
struct gdb_dbgport *gdb_cur = NULL;
|
2006-03-23 23:06:14 +00:00
|
|
|
int gdb_listening = 0;
|
gdb(4): Implement support for NoAckMode
When the underlying debugport transport is reliable, GDB's additional
checksums and acknowledgements are redundant. NoAckMode eliminates the
the acks and allows us to skip checking RX checksums. The GDB packet
framing does not change, so unfortunately (valid) checksums are still
included as message trailers.
The gdb(4) stub in FreeBSD advertises support for the feature in response to
the client's 'qSupported' request IFF the current debugport has the
gdb_dbfeatures flag GDB_DBGP_FEAT_RELIABLE set. Currently, only netgdb(4)
supports this feature.
If the remote GDB client supports the feature and does not have it disabled
via a GDB configuration knob, it may instruct our gdb(4) stub to enter
NoAckMode. Unless and until it issues that command, we must continue to
transmit acks as usual (and for now, we continue to wait until we receive
them as well, even if we know the debugport is on a reliable transport).
In the kernel sources, the sense of the flag representing the state of the
feature is reversed from that of the GDB command. (I.e., it is
'gdb_ackmode', not 'gdb_noackmode.') This is to avoid confusing double-
negative conditions.
For reference, see:
* https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html
* https://sourceware.org/gdb/onlinedocs/gdb/General-Query-Packets.html#QStartNoAckMode
Reviewed by: jhb, markj (both earlier version)
Differential Revision: https://reviews.freebsd.org/D21761
2019-10-17 22:37:25 +00:00
|
|
|
bool gdb_ackmode = true;
|
2004-07-10 17:47:22 +00:00
|
|
|
|
2014-09-05 16:40:47 +00:00
|
|
|
static unsigned char gdb_bindata[64];
|
|
|
|
|
2019-10-17 21:33:01 +00:00
|
|
|
#ifdef DDB
|
|
|
|
bool gdb_return_to_ddb = false;
|
|
|
|
#endif
|
|
|
|
|
2004-07-10 17:47:22 +00:00
|
|
|
static int
|
|
|
|
gdb_init(void)
|
|
|
|
{
|
|
|
|
struct gdb_dbgport *dp, **iter;
|
|
|
|
int cur_pri, pri;
|
|
|
|
|
|
|
|
gdb_cur = NULL;
|
|
|
|
cur_pri = -1;
|
|
|
|
SET_FOREACH(iter, gdb_dbgport_set) {
|
|
|
|
dp = *iter;
|
|
|
|
pri = (dp->gdb_probe != NULL) ? dp->gdb_probe() : -1;
|
|
|
|
dp->gdb_active = (pri >= 0) ? 0 : -1;
|
|
|
|
if (pri > cur_pri) {
|
|
|
|
cur_pri = pri;
|
|
|
|
gdb_cur = dp;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (gdb_cur != NULL) {
|
|
|
|
printf("GDB: debug ports:");
|
|
|
|
SET_FOREACH(iter, gdb_dbgport_set) {
|
|
|
|
dp = *iter;
|
|
|
|
if (dp->gdb_active == 0)
|
|
|
|
printf(" %s", dp->gdb_name);
|
|
|
|
}
|
|
|
|
printf("\n");
|
|
|
|
} else
|
|
|
|
printf("GDB: no debug ports present\n");
|
|
|
|
if (gdb_cur != NULL) {
|
|
|
|
gdb_cur->gdb_init();
|
|
|
|
printf("GDB: current port: %s\n", gdb_cur->gdb_name);
|
|
|
|
}
|
2006-03-23 23:06:14 +00:00
|
|
|
if (gdb_cur != NULL) {
|
2004-07-10 17:47:22 +00:00
|
|
|
cur_pri = (boothowto & RB_GDB) ? 2 : 0;
|
2006-03-23 23:06:14 +00:00
|
|
|
gdb_consinit();
|
|
|
|
} else
|
2004-07-10 17:47:22 +00:00
|
|
|
cur_pri = -1;
|
|
|
|
return (cur_pri);
|
|
|
|
}
|
|
|
|
|
2017-10-17 01:12:17 +00:00
|
|
|
static void
|
|
|
|
gdb_do_mem_search(void)
|
|
|
|
{
|
|
|
|
size_t patlen;
|
|
|
|
intmax_t addr, size;
|
|
|
|
const unsigned char *found;
|
|
|
|
|
|
|
|
if (gdb_rx_varhex(&addr) || gdb_rx_char() != ';' ||
|
|
|
|
gdb_rx_varhex(&size) || gdb_rx_char() != ';' ||
|
|
|
|
gdb_rx_bindata(gdb_bindata, sizeof(gdb_bindata), &patlen)) {
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if (gdb_search_mem((char *)(uintptr_t)addr, size, gdb_bindata,
|
|
|
|
patlen, &found)) {
|
|
|
|
if (found == 0ULL)
|
|
|
|
gdb_tx_begin('0');
|
|
|
|
else {
|
|
|
|
gdb_tx_begin('1');
|
|
|
|
gdb_tx_char(',');
|
|
|
|
gdb_tx_hex((intmax_t)(uintptr_t)found, 8);
|
|
|
|
}
|
|
|
|
gdb_tx_end();
|
|
|
|
} else
|
|
|
|
gdb_tx_err(EIO);
|
|
|
|
}
|
|
|
|
|
2019-08-19 22:57:03 +00:00
|
|
|
static void
|
|
|
|
gdb_do_threadinfo(struct thread **thr_iter)
|
|
|
|
{
|
|
|
|
static struct thread * const done_sentinel = (void *)(uintptr_t)1;
|
|
|
|
static const size_t tidsz_hex = sizeof(lwpid_t) * 2;
|
|
|
|
size_t tds_sent;
|
|
|
|
|
|
|
|
if (*thr_iter == NULL) {
|
|
|
|
gdb_tx_err(ENXIO);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (*thr_iter == done_sentinel) {
|
|
|
|
gdb_tx_begin('l');
|
|
|
|
*thr_iter = NULL;
|
|
|
|
goto sendit;
|
|
|
|
}
|
|
|
|
|
|
|
|
gdb_tx_begin('m');
|
|
|
|
|
|
|
|
for (tds_sent = 0;
|
|
|
|
*thr_iter != NULL && gdb_txbuf_has_capacity(tidsz_hex + 1);
|
|
|
|
*thr_iter = kdb_thr_next(*thr_iter), tds_sent++) {
|
|
|
|
if (tds_sent > 0)
|
|
|
|
gdb_tx_char(',');
|
|
|
|
gdb_tx_varhex((*thr_iter)->td_tid);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Can't send EOF and "some" in same packet, so set a sentinel to send
|
|
|
|
* EOF when GDB asks us next.
|
|
|
|
*/
|
|
|
|
if (*thr_iter == NULL && tds_sent > 0)
|
|
|
|
*thr_iter = done_sentinel;
|
|
|
|
|
|
|
|
sendit:
|
|
|
|
gdb_tx_end();
|
|
|
|
}
|
|
|
|
|
2019-08-22 00:19:41 +00:00
|
|
|
#define BIT(n) (1ull << (n))
|
|
|
|
enum {
|
|
|
|
GDB_MULTIPROCESS,
|
|
|
|
GDB_SWBREAK,
|
|
|
|
GDB_HWBREAK,
|
|
|
|
GDB_QRELOCINSN,
|
|
|
|
GDB_FORK_EVENTS,
|
|
|
|
GDB_VFORK_EVENTS,
|
|
|
|
GDB_EXEC_EVENTS,
|
|
|
|
GDB_VCONT_SUPPORTED,
|
|
|
|
GDB_QTHREADEVENTS,
|
|
|
|
GDB_NO_RESUMED,
|
|
|
|
};
|
|
|
|
static const char * const gdb_feature_names[] = {
|
|
|
|
[GDB_MULTIPROCESS] = "multiprocess",
|
|
|
|
[GDB_SWBREAK] = "swbreak",
|
|
|
|
[GDB_HWBREAK] = "hwbreak",
|
|
|
|
[GDB_QRELOCINSN] = "qRelocInsn",
|
|
|
|
[GDB_FORK_EVENTS] = "fork-events",
|
|
|
|
[GDB_VFORK_EVENTS] = "vfork-events",
|
|
|
|
[GDB_EXEC_EVENTS] = "exec-events",
|
|
|
|
[GDB_VCONT_SUPPORTED] = "vContSupported",
|
|
|
|
[GDB_QTHREADEVENTS] = "QThreadEvents",
|
|
|
|
[GDB_NO_RESUMED] = "no-resumed",
|
|
|
|
};
|
|
|
|
static void
|
|
|
|
gdb_do_qsupported(uint32_t *feat)
|
|
|
|
{
|
|
|
|
char *tok, *delim, ok;
|
|
|
|
size_t i, toklen;
|
|
|
|
|
|
|
|
/* Parse supported host features */
|
|
|
|
*feat = 0;
|
2020-08-18 20:59:10 +00:00
|
|
|
switch (gdb_rx_char()) {
|
|
|
|
case ':':
|
|
|
|
break;
|
|
|
|
case EOF:
|
|
|
|
goto nofeatures;
|
|
|
|
default:
|
2019-08-22 00:19:41 +00:00
|
|
|
goto error;
|
2020-08-18 20:59:10 +00:00
|
|
|
}
|
2019-08-22 00:19:41 +00:00
|
|
|
|
|
|
|
while (gdb_rxsz > 0) {
|
|
|
|
tok = gdb_rxp;
|
|
|
|
delim = strchrnul(gdb_rxp, ';');
|
|
|
|
toklen = (delim - tok);
|
|
|
|
|
|
|
|
gdb_rxp += toklen;
|
|
|
|
gdb_rxsz -= toklen;
|
|
|
|
if (*delim != '\0') {
|
|
|
|
*delim = '\0';
|
|
|
|
gdb_rxp += 1;
|
|
|
|
gdb_rxsz -= 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (toklen < 2)
|
|
|
|
goto error;
|
|
|
|
|
|
|
|
ok = tok[toklen - 1];
|
|
|
|
if (ok != '-' && ok != '+') {
|
|
|
|
/*
|
|
|
|
* GDB only has one KV-pair feature, and we don't
|
|
|
|
* support it, so ignore and move on.
|
|
|
|
*/
|
|
|
|
if (strchr(tok, '=') != NULL)
|
|
|
|
continue;
|
|
|
|
/* Not a KV-pair, and not a +/- flag? Malformed. */
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
if (ok != '+')
|
|
|
|
continue;
|
|
|
|
tok[toklen - 1] = '\0';
|
|
|
|
|
|
|
|
for (i = 0; i < nitems(gdb_feature_names); i++)
|
|
|
|
if (strcmp(gdb_feature_names[i], tok) == 0)
|
|
|
|
break;
|
|
|
|
|
|
|
|
if (i == nitems(gdb_feature_names)) {
|
|
|
|
/* Unknown GDB feature. */
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
*feat |= BIT(i);
|
|
|
|
}
|
|
|
|
|
2020-08-18 20:59:10 +00:00
|
|
|
nofeatures:
|
2019-08-22 00:19:41 +00:00
|
|
|
/* Send a supported feature list back */
|
|
|
|
gdb_tx_begin(0);
|
|
|
|
|
|
|
|
gdb_tx_str("PacketSize");
|
|
|
|
gdb_tx_char('=');
|
|
|
|
/*
|
|
|
|
* We don't buffer framing bytes, but we do need to retain a byte for a
|
|
|
|
* trailing nul.
|
|
|
|
*/
|
|
|
|
gdb_tx_varhex(GDB_BUFSZ + strlen("$#nn") - 1);
|
|
|
|
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
gdb_tx_str(";qXfer:threads:read+");
|
|
|
|
|
gdb(4): Implement support for NoAckMode
When the underlying debugport transport is reliable, GDB's additional
checksums and acknowledgements are redundant. NoAckMode eliminates the
the acks and allows us to skip checking RX checksums. The GDB packet
framing does not change, so unfortunately (valid) checksums are still
included as message trailers.
The gdb(4) stub in FreeBSD advertises support for the feature in response to
the client's 'qSupported' request IFF the current debugport has the
gdb_dbfeatures flag GDB_DBGP_FEAT_RELIABLE set. Currently, only netgdb(4)
supports this feature.
If the remote GDB client supports the feature and does not have it disabled
via a GDB configuration knob, it may instruct our gdb(4) stub to enter
NoAckMode. Unless and until it issues that command, we must continue to
transmit acks as usual (and for now, we continue to wait until we receive
them as well, even if we know the debugport is on a reliable transport).
In the kernel sources, the sense of the flag representing the state of the
feature is reversed from that of the GDB command. (I.e., it is
'gdb_ackmode', not 'gdb_noackmode.') This is to avoid confusing double-
negative conditions.
For reference, see:
* https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html
* https://sourceware.org/gdb/onlinedocs/gdb/General-Query-Packets.html#QStartNoAckMode
Reviewed by: jhb, markj (both earlier version)
Differential Revision: https://reviews.freebsd.org/D21761
2019-10-17 22:37:25 +00:00
|
|
|
/*
|
|
|
|
* If the debugport is a reliable transport, request No Ack mode from
|
|
|
|
* the server. The server may or may not choose to enter No Ack mode.
|
|
|
|
* https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html
|
|
|
|
*/
|
|
|
|
if (gdb_cur->gdb_dbfeatures & GDB_DBGP_FEAT_RELIABLE)
|
|
|
|
gdb_tx_str(";QStartNoAckMode+");
|
|
|
|
|
2019-08-22 00:19:41 +00:00
|
|
|
/*
|
|
|
|
* Future consideration:
|
|
|
|
* - vCont
|
|
|
|
* - multiprocess
|
|
|
|
*/
|
|
|
|
gdb_tx_end();
|
|
|
|
return;
|
|
|
|
|
|
|
|
error:
|
|
|
|
*feat = 0;
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
}
|
|
|
|
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
/*
|
|
|
|
* A qXfer_context provides a vaguely generic way to generate a multi-packet
|
|
|
|
* response on the fly, making some assumptions about the size of sbuf writes
|
|
|
|
* vs actual packet length constraints. A non-byzantine gdb host should allow
|
|
|
|
* hundreds of bytes per packet or more.
|
|
|
|
*
|
|
|
|
* Upper layers are considered responsible for escaping the four forbidden
|
|
|
|
* characters '# $ } *'.
|
|
|
|
*/
|
|
|
|
struct qXfer_context {
|
|
|
|
struct sbuf sb;
|
|
|
|
size_t last_offset;
|
|
|
|
bool flushed;
|
|
|
|
bool lastmessage;
|
|
|
|
char xfer_buf[GDB_BUFSZ];
|
|
|
|
};
|
|
|
|
|
|
|
|
static int
|
|
|
|
qXfer_drain(void *v, const char *buf, int len)
|
|
|
|
{
|
|
|
|
struct qXfer_context *qx;
|
|
|
|
|
|
|
|
if (len < 0)
|
|
|
|
return (-EINVAL);
|
|
|
|
|
|
|
|
qx = v;
|
|
|
|
if (qx->flushed) {
|
|
|
|
/*
|
|
|
|
* Overflow. We lost some message. Maybe the packet size is
|
|
|
|
* ridiculously small.
|
|
|
|
*/
|
|
|
|
printf("%s: Overflow in qXfer detected.\n", __func__);
|
|
|
|
return (-ENOBUFS);
|
|
|
|
}
|
|
|
|
|
|
|
|
qx->last_offset += len;
|
|
|
|
qx->flushed = true;
|
|
|
|
|
|
|
|
if (qx->lastmessage)
|
|
|
|
gdb_tx_begin('l');
|
|
|
|
else
|
|
|
|
gdb_tx_begin('m');
|
|
|
|
|
|
|
|
memcpy(gdb_txp, buf, len);
|
|
|
|
gdb_txp += len;
|
|
|
|
|
|
|
|
gdb_tx_end();
|
|
|
|
return (len);
|
|
|
|
}
|
|
|
|
|
|
|
|
static int
|
|
|
|
init_qXfer_ctx(struct qXfer_context *qx, uintmax_t len)
|
|
|
|
{
|
|
|
|
|
|
|
|
/* Protocol (max) length field includes framing overhead. */
|
|
|
|
if (len < sizeof("$m#nn"))
|
|
|
|
return (ENOSPC);
|
|
|
|
|
|
|
|
len -= 4;
|
|
|
|
len = ummin(len, GDB_BUFSZ - 1);
|
|
|
|
|
|
|
|
qx->last_offset = 0;
|
|
|
|
qx->flushed = false;
|
|
|
|
qx->lastmessage = false;
|
|
|
|
sbuf_new(&qx->sb, qx->xfer_buf, len, SBUF_FIXEDLEN);
|
|
|
|
sbuf_set_drain(&qx->sb, qXfer_drain, qx);
|
|
|
|
return (0);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2020-09-30 14:55:54 +00:00
|
|
|
* Squashes special XML and GDB characters down to _. Sorry.
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
*/
|
|
|
|
static void
|
|
|
|
qXfer_escape_xmlattr_str(char *dst, size_t dstlen, const char *src)
|
|
|
|
{
|
|
|
|
static const char *forbidden = "#$}*";
|
|
|
|
|
|
|
|
size_t i;
|
|
|
|
char c;
|
|
|
|
|
|
|
|
for (i = 0; i < dstlen - 1 && *src != 0; src++, i++) {
|
|
|
|
c = *src;
|
|
|
|
/* XML attr filter */
|
|
|
|
if (c < 32)
|
|
|
|
c = '_';
|
|
|
|
/* We assume attributes will be "" quoted. */
|
|
|
|
if (c == '<' || c == '&' || c == '"')
|
|
|
|
c = '_';
|
|
|
|
|
|
|
|
/* GDB escape. */
|
|
|
|
if (strchr(forbidden, c) != NULL) {
|
2020-09-30 14:55:54 +00:00
|
|
|
/*
|
|
|
|
* It would be nice to escape these properly, but to do
|
|
|
|
* it correctly we need to escape them in the transmit
|
|
|
|
* layer, potentially doubling our buffer requirements.
|
|
|
|
* For now, avoid breaking the protocol by squashing
|
|
|
|
* them to underscore.
|
|
|
|
*/
|
|
|
|
#if 0
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
*dst++ = '}';
|
|
|
|
c ^= 0x20;
|
2020-09-30 14:55:54 +00:00
|
|
|
#endif
|
|
|
|
c = '_';
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
}
|
|
|
|
*dst++ = c;
|
|
|
|
}
|
|
|
|
if (*src != 0)
|
|
|
|
printf("XXX%s: overflow; API misuse\n", __func__);
|
|
|
|
|
|
|
|
*dst = 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Dynamically generate qXfer:threads document, one packet at a time.
|
|
|
|
*
|
|
|
|
* The format is loosely described[0], although it does not seem that the
|
|
|
|
* <?xml?> mentioned on that page is required.
|
|
|
|
*
|
|
|
|
* [0]: https://sourceware.org/gdb/current/onlinedocs/gdb/Thread-List-Format.html
|
|
|
|
*/
|
|
|
|
static void
|
|
|
|
do_qXfer_threads_read(void)
|
|
|
|
{
|
|
|
|
/* Kludgy context */
|
|
|
|
static struct {
|
|
|
|
struct qXfer_context qXfer;
|
|
|
|
/* Kludgy state machine */
|
|
|
|
struct thread *iter;
|
|
|
|
enum {
|
|
|
|
XML_START_THREAD, /* '<thread' */
|
|
|
|
XML_THREAD_ID, /* ' id="xxx"' */
|
|
|
|
XML_THREAD_CORE, /* ' core="yyy"' */
|
|
|
|
XML_THREAD_NAME, /* ' name="zzz"' */
|
|
|
|
XML_THREAD_EXTRA, /* '> ...' */
|
|
|
|
XML_END_THREAD, /* '</thread>' */
|
|
|
|
XML_SENT_END_THREADS, /* '</threads>' */
|
|
|
|
} next_step;
|
|
|
|
} ctx;
|
|
|
|
static char td_name_escape[MAXCOMLEN * 2 + 1];
|
|
|
|
|
|
|
|
const char *name_src;
|
|
|
|
uintmax_t offset, len;
|
|
|
|
int error;
|
|
|
|
|
|
|
|
/* Annex part must be empty. */
|
|
|
|
if (gdb_rx_char() != ':')
|
|
|
|
goto misformed_request;
|
|
|
|
|
|
|
|
if (gdb_rx_varhex(&offset) != 0 ||
|
|
|
|
gdb_rx_char() != ',' ||
|
|
|
|
gdb_rx_varhex(&len) != 0)
|
|
|
|
goto misformed_request;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Validate resume xfers.
|
|
|
|
*/
|
|
|
|
if (offset != 0) {
|
|
|
|
if (offset != ctx.qXfer.last_offset) {
|
2019-08-22 04:31:07 +00:00
|
|
|
printf("%s: Resumed offset %ju != expected %zu\n",
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
__func__, offset, ctx.qXfer.last_offset);
|
|
|
|
error = ESPIPE;
|
|
|
|
goto request_error;
|
|
|
|
}
|
|
|
|
ctx.qXfer.flushed = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (offset == 0) {
|
|
|
|
ctx.iter = kdb_thr_first();
|
|
|
|
ctx.next_step = XML_START_THREAD;
|
|
|
|
error = init_qXfer_ctx(&ctx.qXfer, len);
|
|
|
|
if (error != 0)
|
|
|
|
goto request_error;
|
|
|
|
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "<threads>");
|
|
|
|
}
|
|
|
|
|
|
|
|
while (!ctx.qXfer.flushed && ctx.iter != NULL) {
|
|
|
|
switch (ctx.next_step) {
|
|
|
|
case XML_START_THREAD:
|
|
|
|
ctx.next_step = XML_THREAD_ID;
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "<thread");
|
|
|
|
continue;
|
|
|
|
|
|
|
|
case XML_THREAD_ID:
|
|
|
|
ctx.next_step = XML_THREAD_CORE;
|
|
|
|
sbuf_printf(&ctx.qXfer.sb, " id=\"%jx\"",
|
|
|
|
(uintmax_t)ctx.iter->td_tid);
|
|
|
|
continue;
|
|
|
|
|
|
|
|
case XML_THREAD_CORE:
|
|
|
|
ctx.next_step = XML_THREAD_NAME;
|
|
|
|
if (ctx.iter->td_oncpu != NOCPU) {
|
|
|
|
sbuf_printf(&ctx.qXfer.sb, " core=\"%d\"",
|
|
|
|
ctx.iter->td_oncpu);
|
|
|
|
}
|
|
|
|
continue;
|
|
|
|
|
|
|
|
case XML_THREAD_NAME:
|
|
|
|
ctx.next_step = XML_THREAD_EXTRA;
|
|
|
|
|
|
|
|
if (ctx.iter->td_name[0] != 0)
|
|
|
|
name_src = ctx.iter->td_name;
|
|
|
|
else if (ctx.iter->td_proc != NULL &&
|
|
|
|
ctx.iter->td_proc->p_comm[0] != 0)
|
|
|
|
name_src = ctx.iter->td_proc->p_comm;
|
|
|
|
else
|
|
|
|
continue;
|
|
|
|
|
|
|
|
qXfer_escape_xmlattr_str(td_name_escape,
|
|
|
|
sizeof(td_name_escape), name_src);
|
|
|
|
sbuf_printf(&ctx.qXfer.sb, " name=\"%s\"",
|
|
|
|
td_name_escape);
|
|
|
|
continue;
|
|
|
|
|
|
|
|
case XML_THREAD_EXTRA:
|
|
|
|
ctx.next_step = XML_END_THREAD;
|
|
|
|
|
|
|
|
sbuf_putc(&ctx.qXfer.sb, '>');
|
|
|
|
|
2021-02-18 10:25:10 +00:00
|
|
|
if (TD_GET_STATE(ctx.iter) == TDS_RUNNING)
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
sbuf_cat(&ctx.qXfer.sb, "Running");
|
2021-02-18 10:25:10 +00:00
|
|
|
else if (TD_GET_STATE(ctx.iter) == TDS_RUNQ)
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
sbuf_cat(&ctx.qXfer.sb, "RunQ");
|
2021-02-18 10:25:10 +00:00
|
|
|
else if (TD_GET_STATE(ctx.iter) == TDS_CAN_RUN)
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
sbuf_cat(&ctx.qXfer.sb, "CanRun");
|
|
|
|
else if (TD_ON_LOCK(ctx.iter))
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "Blocked");
|
|
|
|
else if (TD_IS_SLEEPING(ctx.iter))
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "Sleeping");
|
|
|
|
else if (TD_IS_SWAPPED(ctx.iter))
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "Swapped");
|
|
|
|
else if (TD_AWAITING_INTR(ctx.iter))
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "IthreadWait");
|
|
|
|
else if (TD_IS_SUSPENDED(ctx.iter))
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "Suspended");
|
|
|
|
else
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "???");
|
|
|
|
continue;
|
|
|
|
|
|
|
|
case XML_END_THREAD:
|
|
|
|
ctx.next_step = XML_START_THREAD;
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "</thread>");
|
|
|
|
ctx.iter = kdb_thr_next(ctx.iter);
|
|
|
|
continue;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This one isn't part of the looping state machine,
|
|
|
|
* but GCC complains if you leave an enum value out of the
|
|
|
|
* select.
|
|
|
|
*/
|
|
|
|
case XML_SENT_END_THREADS:
|
|
|
|
/* NOTREACHED */
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (ctx.qXfer.flushed)
|
|
|
|
return;
|
|
|
|
|
|
|
|
if (ctx.next_step != XML_SENT_END_THREADS) {
|
|
|
|
ctx.next_step = XML_SENT_END_THREADS;
|
|
|
|
sbuf_cat(&ctx.qXfer.sb, "</threads>");
|
|
|
|
}
|
|
|
|
if (ctx.qXfer.flushed)
|
|
|
|
return;
|
|
|
|
|
|
|
|
ctx.qXfer.lastmessage = true;
|
|
|
|
sbuf_finish(&ctx.qXfer.sb);
|
|
|
|
sbuf_delete(&ctx.qXfer.sb);
|
|
|
|
ctx.qXfer.last_offset = 0;
|
|
|
|
return;
|
|
|
|
|
|
|
|
misformed_request:
|
|
|
|
/*
|
|
|
|
* GDB "General-Query-Packets.html" qXfer-read anchor specifically
|
|
|
|
* documents an E00 code for malformed requests or invalid annex.
|
|
|
|
* Non-zero codes indicate invalid offset or "error reading the data."
|
|
|
|
*/
|
|
|
|
error = 0;
|
|
|
|
request_error:
|
|
|
|
gdb_tx_err(error);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* A set of standardized transfers from "special data areas."
|
|
|
|
*
|
|
|
|
* We've already matched on "qXfer:" and advanced the rx packet buffer past
|
|
|
|
* that bit. Parse out the rest of the packet and generate an appropriate
|
|
|
|
* response.
|
|
|
|
*/
|
|
|
|
static void
|
|
|
|
do_qXfer(void)
|
|
|
|
{
|
|
|
|
if (!gdb_rx_equal("threads:"))
|
|
|
|
goto unrecognized;
|
|
|
|
|
|
|
|
if (!gdb_rx_equal("read:"))
|
|
|
|
goto unrecognized;
|
|
|
|
|
|
|
|
do_qXfer_threads_read();
|
|
|
|
return;
|
|
|
|
|
|
|
|
unrecognized:
|
|
|
|
gdb_tx_empty();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2019-10-17 21:33:01 +00:00
|
|
|
static void
|
|
|
|
gdb_handle_detach(void)
|
|
|
|
{
|
|
|
|
kdb_cpu_clear_singlestep();
|
|
|
|
gdb_listening = 0;
|
|
|
|
|
|
|
|
if (gdb_cur->gdb_dbfeatures & GDB_DBGP_FEAT_WANTTERM)
|
|
|
|
gdb_cur->gdb_term();
|
|
|
|
|
|
|
|
#ifdef DDB
|
|
|
|
if (!gdb_return_to_ddb)
|
|
|
|
return;
|
|
|
|
|
|
|
|
gdb_return_to_ddb = false;
|
|
|
|
|
|
|
|
if (kdb_dbbe_select("ddb") != 0)
|
|
|
|
printf("The ddb backend could not be selected.\n");
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2021-03-08 19:03:45 +00:00
|
|
|
/*
|
|
|
|
* Handle a 'Z' packet: set a breakpoint or watchpoint.
|
|
|
|
*
|
|
|
|
* Currently, only watchpoints are supported.
|
|
|
|
*/
|
|
|
|
static void
|
|
|
|
gdb_z_insert(void)
|
|
|
|
{
|
|
|
|
intmax_t addr, length;
|
|
|
|
char ztype;
|
|
|
|
int error;
|
|
|
|
|
|
|
|
ztype = gdb_rx_char();
|
|
|
|
if (gdb_rx_char() != ',' || gdb_rx_varhex(&addr) ||
|
|
|
|
gdb_rx_char() != ',' || gdb_rx_varhex(&length)) {
|
|
|
|
error = EINVAL;
|
|
|
|
goto fail;
|
|
|
|
}
|
|
|
|
|
|
|
|
switch (ztype) {
|
|
|
|
case '2': /* write watchpoint */
|
|
|
|
error = kdb_cpu_set_watchpoint((vm_offset_t)addr,
|
|
|
|
(vm_size_t)length, KDB_DBG_ACCESS_W);
|
|
|
|
break;
|
|
|
|
case '3': /* read watchpoint */
|
|
|
|
error = kdb_cpu_set_watchpoint((vm_offset_t)addr,
|
|
|
|
(vm_size_t)length, KDB_DBG_ACCESS_R);
|
|
|
|
break;
|
|
|
|
case '4': /* access (RW) watchpoint */
|
|
|
|
error = kdb_cpu_set_watchpoint((vm_offset_t)addr,
|
|
|
|
(vm_size_t)length, KDB_DBG_ACCESS_RW);
|
|
|
|
break;
|
|
|
|
case '1': /* hardware breakpoint */
|
|
|
|
case '0': /* software breakpoint */
|
|
|
|
/* Not implemented. */
|
|
|
|
gdb_tx_empty();
|
|
|
|
return;
|
|
|
|
default:
|
|
|
|
error = EINVAL;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (error != 0)
|
|
|
|
goto fail;
|
|
|
|
gdb_tx_ok();
|
|
|
|
return;
|
|
|
|
fail:
|
|
|
|
gdb_tx_err(error);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Handle a 'z' packet; clear a breakpoint or watchpoint.
|
|
|
|
*
|
|
|
|
* Currently, only watchpoints are supported.
|
|
|
|
*/
|
|
|
|
static void
|
|
|
|
gdb_z_remove(void)
|
|
|
|
{
|
|
|
|
intmax_t addr, length;
|
|
|
|
char ztype;
|
|
|
|
int error;
|
|
|
|
|
|
|
|
ztype = gdb_rx_char();
|
|
|
|
if (gdb_rx_char() != ',' || gdb_rx_varhex(&addr) ||
|
|
|
|
gdb_rx_char() != ',' || gdb_rx_varhex(&length)) {
|
|
|
|
error = EINVAL;
|
|
|
|
goto fail;
|
|
|
|
}
|
|
|
|
|
|
|
|
switch (ztype) {
|
|
|
|
case '2': /* write watchpoint */
|
|
|
|
case '3': /* read watchpoint */
|
|
|
|
case '4': /* access (RW) watchpoint */
|
|
|
|
error = kdb_cpu_clr_watchpoint((vm_offset_t)addr,
|
|
|
|
(vm_size_t)length);
|
|
|
|
break;
|
|
|
|
case '1': /* hardware breakpoint */
|
|
|
|
case '0': /* software breakpoint */
|
|
|
|
/* Not implemented. */
|
|
|
|
gdb_tx_empty();
|
|
|
|
return;
|
|
|
|
default:
|
|
|
|
error = EINVAL;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (error != 0)
|
|
|
|
goto fail;
|
|
|
|
gdb_tx_ok();
|
|
|
|
return;
|
|
|
|
fail:
|
|
|
|
gdb_tx_err(error);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2004-07-10 17:47:22 +00:00
|
|
|
static int
|
|
|
|
gdb_trap(int type, int code)
|
|
|
|
{
|
2011-02-18 22:25:11 +00:00
|
|
|
jmp_buf jb;
|
2004-07-10 17:47:22 +00:00
|
|
|
struct thread *thr_iter;
|
2011-02-18 22:25:11 +00:00
|
|
|
void *prev_jb;
|
2019-08-22 00:19:41 +00:00
|
|
|
uint32_t host_features;
|
2011-02-18 22:25:11 +00:00
|
|
|
|
|
|
|
prev_jb = kdb_jmpbuf(jb);
|
|
|
|
if (setjmp(jb) != 0) {
|
|
|
|
printf("%s bailing, hopefully back to ddb!\n", __func__);
|
|
|
|
gdb_listening = 0;
|
|
|
|
(void)kdb_jmpbuf(prev_jb);
|
|
|
|
return (1);
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
|
2006-03-23 23:06:14 +00:00
|
|
|
gdb_listening = 0;
|
gdb(4): Implement support for NoAckMode
When the underlying debugport transport is reliable, GDB's additional
checksums and acknowledgements are redundant. NoAckMode eliminates the
the acks and allows us to skip checking RX checksums. The GDB packet
framing does not change, so unfortunately (valid) checksums are still
included as message trailers.
The gdb(4) stub in FreeBSD advertises support for the feature in response to
the client's 'qSupported' request IFF the current debugport has the
gdb_dbfeatures flag GDB_DBGP_FEAT_RELIABLE set. Currently, only netgdb(4)
supports this feature.
If the remote GDB client supports the feature and does not have it disabled
via a GDB configuration knob, it may instruct our gdb(4) stub to enter
NoAckMode. Unless and until it issues that command, we must continue to
transmit acks as usual (and for now, we continue to wait until we receive
them as well, even if we know the debugport is on a reliable transport).
In the kernel sources, the sense of the flag representing the state of the
feature is reversed from that of the GDB command. (I.e., it is
'gdb_ackmode', not 'gdb_noackmode.') This is to avoid confusing double-
negative conditions.
For reference, see:
* https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html
* https://sourceware.org/gdb/onlinedocs/gdb/General-Query-Packets.html#QStartNoAckMode
Reviewed by: jhb, markj (both earlier version)
Differential Revision: https://reviews.freebsd.org/D21761
2019-10-17 22:37:25 +00:00
|
|
|
gdb_ackmode = true;
|
|
|
|
|
2004-07-10 17:47:22 +00:00
|
|
|
/*
|
|
|
|
* Send a T packet. We currently do not support watchpoints (the
|
|
|
|
* awatch, rwatch or watch elements).
|
|
|
|
*/
|
|
|
|
gdb_tx_begin('T');
|
|
|
|
gdb_tx_hex(gdb_cpu_signal(type, code), 2);
|
|
|
|
gdb_tx_varhex(GDB_REG_PC);
|
|
|
|
gdb_tx_char(':');
|
|
|
|
gdb_tx_reg(GDB_REG_PC);
|
|
|
|
gdb_tx_char(';');
|
2021-03-08 19:04:51 +00:00
|
|
|
gdb_cpu_stop_reason(type, code);
|
2004-07-10 17:47:22 +00:00
|
|
|
gdb_tx_str("thread:");
|
2021-03-08 19:04:51 +00:00
|
|
|
gdb_tx_varhex((uintmax_t)kdb_thread->td_tid);
|
2004-07-10 17:47:22 +00:00
|
|
|
gdb_tx_char(';');
|
|
|
|
gdb_tx_end(); /* XXX check error condition. */
|
|
|
|
|
|
|
|
thr_iter = NULL;
|
|
|
|
while (gdb_rx_begin() == 0) {
|
2004-08-10 19:32:33 +00:00
|
|
|
/* printf("GDB: got '%s'\n", gdb_rxp); */
|
2004-07-10 17:47:22 +00:00
|
|
|
switch (gdb_rx_char()) {
|
|
|
|
case '?': /* Last signal. */
|
2019-08-22 00:19:14 +00:00
|
|
|
gdb_tx_begin('T');
|
2004-07-10 17:47:22 +00:00
|
|
|
gdb_tx_hex(gdb_cpu_signal(type, code), 2);
|
2019-08-22 00:19:14 +00:00
|
|
|
gdb_tx_str("thread:");
|
|
|
|
gdb_tx_varhex((long)kdb_thread->td_tid);
|
|
|
|
gdb_tx_char(';');
|
2004-07-10 17:47:22 +00:00
|
|
|
gdb_tx_end();
|
|
|
|
break;
|
|
|
|
case 'c': { /* Continue. */
|
|
|
|
uintmax_t addr;
|
2004-12-01 06:40:35 +00:00
|
|
|
register_t pc;
|
|
|
|
if (!gdb_rx_varhex(&addr)) {
|
|
|
|
pc = addr;
|
|
|
|
gdb_cpu_setreg(GDB_REG_PC, &pc);
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
kdb_cpu_clear_singlestep();
|
2006-03-23 23:06:14 +00:00
|
|
|
gdb_listening = 1;
|
2004-07-10 17:47:22 +00:00
|
|
|
return (1);
|
|
|
|
}
|
|
|
|
case 'C': { /* Continue with signal. */
|
|
|
|
uintmax_t addr, sig;
|
2004-12-01 06:40:35 +00:00
|
|
|
register_t pc;
|
2004-07-10 17:47:22 +00:00
|
|
|
if (!gdb_rx_varhex(&sig) && gdb_rx_char() == ';' &&
|
2004-12-01 06:40:35 +00:00
|
|
|
!gdb_rx_varhex(&addr)) {
|
|
|
|
pc = addr;
|
|
|
|
gdb_cpu_setreg(GDB_REG_PC, &pc);
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
kdb_cpu_clear_singlestep();
|
2006-03-23 23:06:14 +00:00
|
|
|
gdb_listening = 1;
|
2004-07-10 17:47:22 +00:00
|
|
|
return (1);
|
|
|
|
}
|
2008-02-29 01:57:20 +00:00
|
|
|
case 'D': { /* Detach */
|
|
|
|
gdb_tx_ok();
|
2019-10-17 21:33:01 +00:00
|
|
|
gdb_handle_detach();
|
2008-02-29 01:57:20 +00:00
|
|
|
return (1);
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
case 'g': { /* Read registers. */
|
|
|
|
size_t r;
|
|
|
|
gdb_tx_begin(0);
|
|
|
|
for (r = 0; r < GDB_NREGS; r++)
|
|
|
|
gdb_tx_reg(r);
|
|
|
|
gdb_tx_end();
|
|
|
|
break;
|
|
|
|
}
|
2020-12-23 18:37:05 +00:00
|
|
|
case 'G': { /* Write registers. */
|
|
|
|
char *val;
|
|
|
|
bool success;
|
|
|
|
size_t r;
|
|
|
|
for (success = true, r = 0; r < GDB_NREGS; r++) {
|
|
|
|
val = gdb_rxp;
|
|
|
|
if (!gdb_rx_mem(val, gdb_cpu_regsz(r))) {
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
success = false;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
gdb_cpu_setreg(r, val);
|
|
|
|
}
|
|
|
|
if (success)
|
|
|
|
gdb_tx_ok();
|
2004-07-10 17:47:22 +00:00
|
|
|
break;
|
2020-12-23 18:37:05 +00:00
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
case 'H': { /* Set thread. */
|
|
|
|
intmax_t tid;
|
|
|
|
struct thread *thr;
|
2019-08-22 00:36:16 +00:00
|
|
|
|
|
|
|
/* Ignore 'g' (general) or 'c' (continue) flag. */
|
|
|
|
(void) gdb_rx_char();
|
|
|
|
|
2005-03-28 18:31:18 +00:00
|
|
|
if (gdb_rx_varhex(&tid)) {
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
break;
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
if (tid > 0) {
|
|
|
|
thr = kdb_thr_lookup(tid);
|
|
|
|
if (thr == NULL) {
|
|
|
|
gdb_tx_err(ENOENT);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
kdb_thr_select(thr);
|
|
|
|
}
|
|
|
|
gdb_tx_ok();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case 'k': /* Kill request. */
|
2019-10-17 21:33:01 +00:00
|
|
|
gdb_handle_detach();
|
2004-07-10 17:47:22 +00:00
|
|
|
return (1);
|
|
|
|
case 'm': { /* Read memory. */
|
|
|
|
uintmax_t addr, size;
|
|
|
|
if (gdb_rx_varhex(&addr) || gdb_rx_char() != ',' ||
|
|
|
|
gdb_rx_varhex(&size)) {
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
gdb_tx_begin(0);
|
|
|
|
if (gdb_tx_mem((char *)(uintptr_t)addr, size))
|
|
|
|
gdb_tx_end();
|
|
|
|
else
|
|
|
|
gdb_tx_err(EIO);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case 'M': { /* Write memory. */
|
|
|
|
uintmax_t addr, size;
|
|
|
|
if (gdb_rx_varhex(&addr) || gdb_rx_char() != ',' ||
|
|
|
|
gdb_rx_varhex(&size) || gdb_rx_char() != ':') {
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (gdb_rx_mem((char *)(uintptr_t)addr, size) == 0)
|
|
|
|
gdb_tx_err(EIO);
|
|
|
|
else
|
|
|
|
gdb_tx_ok();
|
|
|
|
break;
|
|
|
|
}
|
2020-12-23 18:36:08 +00:00
|
|
|
case 'p': { /* Read register. */
|
|
|
|
uintmax_t reg;
|
|
|
|
if (gdb_rx_varhex(®)) {
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
gdb_tx_begin(0);
|
|
|
|
gdb_tx_reg(reg);
|
|
|
|
gdb_tx_end();
|
|
|
|
break;
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
case 'P': { /* Write register. */
|
2004-12-01 06:40:35 +00:00
|
|
|
char *val;
|
|
|
|
uintmax_t reg;
|
|
|
|
val = gdb_rxp;
|
2004-07-10 17:47:22 +00:00
|
|
|
if (gdb_rx_varhex(®) || gdb_rx_char() != '=' ||
|
2004-12-01 06:40:35 +00:00
|
|
|
!gdb_rx_mem(val, gdb_cpu_regsz(reg))) {
|
2004-07-10 17:47:22 +00:00
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
gdb_cpu_setreg(reg, val);
|
|
|
|
gdb_tx_ok();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case 'q': /* General query. */
|
2019-08-19 22:58:30 +00:00
|
|
|
if (gdb_rx_equal("C")) {
|
|
|
|
gdb_tx_begin('Q');
|
|
|
|
gdb_tx_char('C');
|
|
|
|
gdb_tx_varhex((long)kdb_thread->td_tid);
|
|
|
|
gdb_tx_end();
|
2019-08-22 00:19:41 +00:00
|
|
|
} else if (gdb_rx_equal("Supported")) {
|
|
|
|
gdb_do_qsupported(&host_features);
|
2019-08-19 22:58:30 +00:00
|
|
|
} else if (gdb_rx_equal("fThreadInfo")) {
|
2004-07-10 17:47:22 +00:00
|
|
|
thr_iter = kdb_thr_first();
|
2019-08-19 22:57:03 +00:00
|
|
|
gdb_do_threadinfo(&thr_iter);
|
2004-07-10 17:47:22 +00:00
|
|
|
} else if (gdb_rx_equal("sThreadInfo")) {
|
2019-08-19 22:57:03 +00:00
|
|
|
gdb_do_threadinfo(&thr_iter);
|
gdb(4): Implement qXfer:threads:read
This streams out an XML document over several GDB packets describing all
threads in the system; their ids, name, and any loosely defined "extra info"
we feel like including. For now, I have included a string version of the run
state, similar to some of the DDB logic to stringify thread state.
The benefit of supporting this in addition to the qfThreadInfo/qsThreadInfo
packing is that in this mode, the host gdb does not ask for every thread's
"qThreadExtraInfo," saving per-thread round-trips on "info threads."
To use this feature, (k)gdb needs to be built with the --with-expat option.
I would encourage enabling this option by default in our GDB port, if it is
not already.
Finally, there is another optional attribute you can specify per-thread
called a "handle." Handles are arbitrarily long sequences of bytes,
represented in the XML as hexadecimal. It is unclear to me how or if GDB
actually uses handles for anything. So I have left them out.
2019-08-22 00:34:11 +00:00
|
|
|
} else if (gdb_rx_equal("Xfer:")) {
|
|
|
|
do_qXfer();
|
2014-09-05 16:40:47 +00:00
|
|
|
} else if (gdb_rx_equal("Search:memory:")) {
|
2017-10-17 01:12:17 +00:00
|
|
|
gdb_do_mem_search();
|
2019-12-16 13:17:39 +00:00
|
|
|
#ifdef __powerpc__
|
|
|
|
} else if (gdb_rx_equal("Offsets")) {
|
|
|
|
gdb_cpu_do_offsets();
|
|
|
|
#endif
|
2004-07-10 17:47:22 +00:00
|
|
|
} else if (!gdb_cpu_query())
|
|
|
|
gdb_tx_empty();
|
|
|
|
break;
|
gdb(4): Implement support for NoAckMode
When the underlying debugport transport is reliable, GDB's additional
checksums and acknowledgements are redundant. NoAckMode eliminates the
the acks and allows us to skip checking RX checksums. The GDB packet
framing does not change, so unfortunately (valid) checksums are still
included as message trailers.
The gdb(4) stub in FreeBSD advertises support for the feature in response to
the client's 'qSupported' request IFF the current debugport has the
gdb_dbfeatures flag GDB_DBGP_FEAT_RELIABLE set. Currently, only netgdb(4)
supports this feature.
If the remote GDB client supports the feature and does not have it disabled
via a GDB configuration knob, it may instruct our gdb(4) stub to enter
NoAckMode. Unless and until it issues that command, we must continue to
transmit acks as usual (and for now, we continue to wait until we receive
them as well, even if we know the debugport is on a reliable transport).
In the kernel sources, the sense of the flag representing the state of the
feature is reversed from that of the GDB command. (I.e., it is
'gdb_ackmode', not 'gdb_noackmode.') This is to avoid confusing double-
negative conditions.
For reference, see:
* https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html
* https://sourceware.org/gdb/onlinedocs/gdb/General-Query-Packets.html#QStartNoAckMode
Reviewed by: jhb, markj (both earlier version)
Differential Revision: https://reviews.freebsd.org/D21761
2019-10-17 22:37:25 +00:00
|
|
|
case 'Q':
|
|
|
|
if (gdb_rx_equal("StartNoAckMode")) {
|
|
|
|
if ((gdb_cur->gdb_dbfeatures &
|
|
|
|
GDB_DBGP_FEAT_RELIABLE) == 0) {
|
|
|
|
/*
|
|
|
|
* Shouldn't happen if we didn't
|
|
|
|
* advertise support. Reject.
|
|
|
|
*/
|
|
|
|
gdb_tx_empty();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
gdb_ackmode = false;
|
|
|
|
gdb_tx_ok();
|
|
|
|
} else
|
|
|
|
gdb_tx_empty();
|
|
|
|
break;
|
2004-07-10 17:47:22 +00:00
|
|
|
case 's': { /* Step. */
|
|
|
|
uintmax_t addr;
|
2004-12-01 06:40:35 +00:00
|
|
|
register_t pc;
|
|
|
|
if (!gdb_rx_varhex(&addr)) {
|
|
|
|
pc = addr;
|
|
|
|
gdb_cpu_setreg(GDB_REG_PC, &pc);
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
kdb_cpu_set_singlestep();
|
2006-03-23 23:06:14 +00:00
|
|
|
gdb_listening = 1;
|
2004-07-10 17:47:22 +00:00
|
|
|
return (1);
|
|
|
|
}
|
|
|
|
case 'S': { /* Step with signal. */
|
|
|
|
uintmax_t addr, sig;
|
2004-12-01 06:40:35 +00:00
|
|
|
register_t pc;
|
2004-07-10 17:47:22 +00:00
|
|
|
if (!gdb_rx_varhex(&sig) && gdb_rx_char() == ';' &&
|
2004-12-01 06:40:35 +00:00
|
|
|
!gdb_rx_varhex(&addr)) {
|
|
|
|
pc = addr;
|
|
|
|
gdb_cpu_setreg(GDB_REG_PC, &pc);
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
kdb_cpu_set_singlestep();
|
2006-03-23 23:06:14 +00:00
|
|
|
gdb_listening = 1;
|
2004-07-10 17:47:22 +00:00
|
|
|
return (1);
|
|
|
|
}
|
|
|
|
case 'T': { /* Thread alive. */
|
|
|
|
intmax_t tid;
|
2005-03-28 18:31:18 +00:00
|
|
|
if (gdb_rx_varhex(&tid)) {
|
|
|
|
gdb_tx_err(EINVAL);
|
|
|
|
break;
|
|
|
|
}
|
2004-07-10 17:47:22 +00:00
|
|
|
if (kdb_thr_lookup(tid) != NULL)
|
|
|
|
gdb_tx_ok();
|
|
|
|
else
|
|
|
|
gdb_tx_err(ENOENT);
|
|
|
|
break;
|
|
|
|
}
|
2021-03-08 19:03:45 +00:00
|
|
|
case 'z': { /* Remove watchpoint. */
|
|
|
|
gdb_z_remove();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case 'Z': { /* Set watchpoint. */
|
|
|
|
gdb_z_insert();
|
|
|
|
break;
|
|
|
|
}
|
2019-08-22 00:36:16 +00:00
|
|
|
case EOF:
|
2004-07-10 17:47:22 +00:00
|
|
|
/* Empty command. Treat as unknown command. */
|
|
|
|
/* FALLTHROUGH */
|
|
|
|
default:
|
|
|
|
/* Unknown command. Send empty response. */
|
|
|
|
gdb_tx_empty();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
2011-02-18 22:25:11 +00:00
|
|
|
(void)kdb_jmpbuf(prev_jb);
|
2004-07-10 17:47:22 +00:00
|
|
|
return (0);
|
|
|
|
}
|