xref: /freebsd/sys/gdb/gdb_main.c (revision e24a65528388f4debfb12e936f314f85ba6ac407)
1fa521b03SWarner Losh /*-
24d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
3497b6b2aSPedro F. Giffuni  *
472d44f31SMarcel Moolenaar  * Copyright (c) 2004 Marcel Moolenaar
572d44f31SMarcel Moolenaar  * All rights reserved.
672d44f31SMarcel Moolenaar  *
772d44f31SMarcel Moolenaar  * Redistribution and use in source and binary forms, with or without
872d44f31SMarcel Moolenaar  * modification, are permitted provided that the following conditions
972d44f31SMarcel Moolenaar  * are met:
1072d44f31SMarcel Moolenaar  *
1172d44f31SMarcel Moolenaar  * 1. Redistributions of source code must retain the above copyright
1272d44f31SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer.
1372d44f31SMarcel Moolenaar  * 2. Redistributions in binary form must reproduce the above copyright
1472d44f31SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer in the
1572d44f31SMarcel Moolenaar  *    documentation and/or other materials provided with the distribution.
1672d44f31SMarcel Moolenaar  *
1772d44f31SMarcel Moolenaar  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
1872d44f31SMarcel Moolenaar  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1972d44f31SMarcel Moolenaar  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
2072d44f31SMarcel Moolenaar  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
2172d44f31SMarcel Moolenaar  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2272d44f31SMarcel Moolenaar  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2372d44f31SMarcel Moolenaar  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2472d44f31SMarcel Moolenaar  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2572d44f31SMarcel Moolenaar  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2672d44f31SMarcel Moolenaar  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2772d44f31SMarcel Moolenaar  */
2872d44f31SMarcel Moolenaar 
2972d44f31SMarcel Moolenaar #include <sys/param.h>
3072d44f31SMarcel Moolenaar #include <sys/systm.h>
3172d44f31SMarcel Moolenaar #include <sys/kdb.h>
3272d44f31SMarcel Moolenaar #include <sys/kernel.h>
3372d44f31SMarcel Moolenaar #include <sys/pcpu.h>
3472d44f31SMarcel Moolenaar #include <sys/proc.h>
3572d44f31SMarcel Moolenaar #include <sys/reboot.h>
365555afa1SConrad Meyer #include <sys/sbuf.h>
3772d44f31SMarcel Moolenaar 
3872d44f31SMarcel Moolenaar #include <machine/gdb_machdep.h>
3972d44f31SMarcel Moolenaar #include <machine/kdb.h>
4072d44f31SMarcel Moolenaar 
4172d44f31SMarcel Moolenaar #include <gdb/gdb.h>
4272d44f31SMarcel Moolenaar #include <gdb/gdb_int.h>
4372d44f31SMarcel Moolenaar 
447029da5cSPawel Biernacki SYSCTL_NODE(_debug, OID_AUTO, gdb, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
457029da5cSPawel Biernacki     "GDB settings");
4610f6c05cSConrad Meyer 
4772d44f31SMarcel Moolenaar static dbbe_init_f gdb_init;
4872d44f31SMarcel Moolenaar static dbbe_trap_f gdb_trap;
4972d44f31SMarcel Moolenaar 
5028926c57SJohn Baldwin KDB_BACKEND(gdb, gdb_init, NULL, NULL, gdb_trap);
5172d44f31SMarcel Moolenaar 
52e8d86c0eSPoul-Henning Kamp static struct gdb_dbgport null_gdb_dbgport;
53e8d86c0eSPoul-Henning Kamp DATA_SET(gdb_dbgport_set, null_gdb_dbgport);
5472d44f31SMarcel Moolenaar SET_DECLARE(gdb_dbgport_set, struct gdb_dbgport);
5572d44f31SMarcel Moolenaar 
5672d44f31SMarcel Moolenaar struct gdb_dbgport *gdb_cur = NULL;
577d0c6c9fSSam Leffler int gdb_listening = 0;
586310546dSConrad Meyer bool gdb_ackmode = true;
5972d44f31SMarcel Moolenaar 
6027ecc2adSBenno Rice static unsigned char gdb_bindata[64];
6127ecc2adSBenno Rice 
62dda17b36SConrad Meyer #ifdef DDB
63dda17b36SConrad Meyer bool gdb_return_to_ddb = false;
64dda17b36SConrad Meyer #endif
65dda17b36SConrad Meyer 
6672d44f31SMarcel Moolenaar static int
6772d44f31SMarcel Moolenaar gdb_init(void)
6872d44f31SMarcel Moolenaar {
6972d44f31SMarcel Moolenaar 	struct gdb_dbgport *dp, **iter;
7072d44f31SMarcel Moolenaar 	int cur_pri, pri;
7172d44f31SMarcel Moolenaar 
7272d44f31SMarcel Moolenaar 	gdb_cur = NULL;
7372d44f31SMarcel Moolenaar 	cur_pri = -1;
7472d44f31SMarcel Moolenaar 	SET_FOREACH(iter, gdb_dbgport_set) {
7572d44f31SMarcel Moolenaar 		dp = *iter;
7672d44f31SMarcel Moolenaar 		pri = (dp->gdb_probe != NULL) ? dp->gdb_probe() : -1;
7772d44f31SMarcel Moolenaar 		dp->gdb_active = (pri >= 0) ? 0 : -1;
7872d44f31SMarcel Moolenaar 		if (pri > cur_pri) {
7972d44f31SMarcel Moolenaar 			cur_pri = pri;
8072d44f31SMarcel Moolenaar 			gdb_cur = dp;
8172d44f31SMarcel Moolenaar 		}
8272d44f31SMarcel Moolenaar 	}
8372d44f31SMarcel Moolenaar 	if (gdb_cur != NULL) {
8472d44f31SMarcel Moolenaar 		printf("GDB: debug ports:");
8572d44f31SMarcel Moolenaar 		SET_FOREACH(iter, gdb_dbgport_set) {
8672d44f31SMarcel Moolenaar 			dp = *iter;
8772d44f31SMarcel Moolenaar 			if (dp->gdb_active == 0)
8872d44f31SMarcel Moolenaar 				printf(" %s", dp->gdb_name);
8972d44f31SMarcel Moolenaar 		}
9072d44f31SMarcel Moolenaar 		printf("\n");
9172d44f31SMarcel Moolenaar 	} else
9272d44f31SMarcel Moolenaar 		printf("GDB: no debug ports present\n");
9372d44f31SMarcel Moolenaar 	if (gdb_cur != NULL) {
9472d44f31SMarcel Moolenaar 		gdb_cur->gdb_init();
9572d44f31SMarcel Moolenaar 		printf("GDB: current port: %s\n", gdb_cur->gdb_name);
9672d44f31SMarcel Moolenaar 	}
977d0c6c9fSSam Leffler 	if (gdb_cur != NULL) {
9872d44f31SMarcel Moolenaar 		cur_pri = (boothowto & RB_GDB) ? 2 : 0;
997d0c6c9fSSam Leffler 		gdb_consinit();
1007d0c6c9fSSam Leffler 	} else
10172d44f31SMarcel Moolenaar 		cur_pri = -1;
10272d44f31SMarcel Moolenaar 	return (cur_pri);
10372d44f31SMarcel Moolenaar }
10472d44f31SMarcel Moolenaar 
1058a7a6571SRyan Libby static void
1068a7a6571SRyan Libby gdb_do_mem_search(void)
1078a7a6571SRyan Libby {
1088a7a6571SRyan Libby 	size_t patlen;
1098a7a6571SRyan Libby 	intmax_t addr, size;
1108a7a6571SRyan Libby 	const unsigned char *found;
1118a7a6571SRyan Libby 
1128a7a6571SRyan Libby 	if (gdb_rx_varhex(&addr) || gdb_rx_char() != ';' ||
1138a7a6571SRyan Libby 	    gdb_rx_varhex(&size) || gdb_rx_char() != ';' ||
1148a7a6571SRyan Libby 	    gdb_rx_bindata(gdb_bindata, sizeof(gdb_bindata), &patlen)) {
1158a7a6571SRyan Libby 		gdb_tx_err(EINVAL);
1168a7a6571SRyan Libby 		return;
1178a7a6571SRyan Libby 	}
1188a7a6571SRyan Libby 	if (gdb_search_mem((char *)(uintptr_t)addr, size, gdb_bindata,
1198a7a6571SRyan Libby 	    patlen, &found)) {
1208a7a6571SRyan Libby 		if (found == 0ULL)
1218a7a6571SRyan Libby 			gdb_tx_begin('0');
1228a7a6571SRyan Libby 		else {
1238a7a6571SRyan Libby 			gdb_tx_begin('1');
1248a7a6571SRyan Libby 			gdb_tx_char(',');
1258a7a6571SRyan Libby 			gdb_tx_hex((intmax_t)(uintptr_t)found, 8);
1268a7a6571SRyan Libby 		}
1278a7a6571SRyan Libby 		gdb_tx_end();
1288a7a6571SRyan Libby 	} else
1298a7a6571SRyan Libby 		gdb_tx_err(EIO);
1308a7a6571SRyan Libby }
1318a7a6571SRyan Libby 
132130ef1adSConrad Meyer static void
133130ef1adSConrad Meyer gdb_do_threadinfo(struct thread **thr_iter)
134130ef1adSConrad Meyer {
135130ef1adSConrad Meyer 	static struct thread * const done_sentinel = (void *)(uintptr_t)1;
136130ef1adSConrad Meyer 	static const size_t tidsz_hex = sizeof(lwpid_t) * 2;
137130ef1adSConrad Meyer 	size_t tds_sent;
138130ef1adSConrad Meyer 
139130ef1adSConrad Meyer 	if (*thr_iter == NULL) {
140130ef1adSConrad Meyer 		gdb_tx_err(ENXIO);
141130ef1adSConrad Meyer 		return;
142130ef1adSConrad Meyer 	}
143130ef1adSConrad Meyer 
144130ef1adSConrad Meyer 	if (*thr_iter == done_sentinel) {
145130ef1adSConrad Meyer 		gdb_tx_begin('l');
146130ef1adSConrad Meyer 		*thr_iter = NULL;
147130ef1adSConrad Meyer 		goto sendit;
148130ef1adSConrad Meyer 	}
149130ef1adSConrad Meyer 
150130ef1adSConrad Meyer 	gdb_tx_begin('m');
151130ef1adSConrad Meyer 
152130ef1adSConrad Meyer 	for (tds_sent = 0;
153130ef1adSConrad Meyer 	    *thr_iter != NULL && gdb_txbuf_has_capacity(tidsz_hex + 1);
154130ef1adSConrad Meyer 	    *thr_iter = kdb_thr_next(*thr_iter), tds_sent++) {
155130ef1adSConrad Meyer 		if (tds_sent > 0)
156130ef1adSConrad Meyer 			gdb_tx_char(',');
157130ef1adSConrad Meyer 		gdb_tx_varhex((*thr_iter)->td_tid);
158130ef1adSConrad Meyer 	}
159130ef1adSConrad Meyer 
160130ef1adSConrad Meyer 	/*
161130ef1adSConrad Meyer 	 * Can't send EOF and "some" in same packet, so set a sentinel to send
162130ef1adSConrad Meyer 	 * EOF when GDB asks us next.
163130ef1adSConrad Meyer 	 */
164130ef1adSConrad Meyer 	if (*thr_iter == NULL && tds_sent > 0)
165130ef1adSConrad Meyer 		*thr_iter = done_sentinel;
166130ef1adSConrad Meyer 
167130ef1adSConrad Meyer sendit:
168130ef1adSConrad Meyer 	gdb_tx_end();
169130ef1adSConrad Meyer }
170130ef1adSConrad Meyer 
171c4fbbfaaSConrad Meyer #define	BIT(n)	(1ull << (n))
172c4fbbfaaSConrad Meyer enum {
173c4fbbfaaSConrad Meyer 	GDB_MULTIPROCESS,
174c4fbbfaaSConrad Meyer 	GDB_SWBREAK,
175c4fbbfaaSConrad Meyer 	GDB_HWBREAK,
176c4fbbfaaSConrad Meyer 	GDB_QRELOCINSN,
177c4fbbfaaSConrad Meyer 	GDB_FORK_EVENTS,
178c4fbbfaaSConrad Meyer 	GDB_VFORK_EVENTS,
179c4fbbfaaSConrad Meyer 	GDB_EXEC_EVENTS,
180c4fbbfaaSConrad Meyer 	GDB_VCONT_SUPPORTED,
181c4fbbfaaSConrad Meyer 	GDB_QTHREADEVENTS,
182c4fbbfaaSConrad Meyer 	GDB_NO_RESUMED,
183c4fbbfaaSConrad Meyer };
184c4fbbfaaSConrad Meyer static const char * const gdb_feature_names[] = {
185c4fbbfaaSConrad Meyer 	[GDB_MULTIPROCESS] = "multiprocess",
186c4fbbfaaSConrad Meyer 	[GDB_SWBREAK] = "swbreak",
187c4fbbfaaSConrad Meyer 	[GDB_HWBREAK] = "hwbreak",
188c4fbbfaaSConrad Meyer 	[GDB_QRELOCINSN] = "qRelocInsn",
189c4fbbfaaSConrad Meyer 	[GDB_FORK_EVENTS] = "fork-events",
190c4fbbfaaSConrad Meyer 	[GDB_VFORK_EVENTS] = "vfork-events",
191c4fbbfaaSConrad Meyer 	[GDB_EXEC_EVENTS] = "exec-events",
192c4fbbfaaSConrad Meyer 	[GDB_VCONT_SUPPORTED] = "vContSupported",
193c4fbbfaaSConrad Meyer 	[GDB_QTHREADEVENTS] = "QThreadEvents",
194c4fbbfaaSConrad Meyer 	[GDB_NO_RESUMED] = "no-resumed",
195c4fbbfaaSConrad Meyer };
196c4fbbfaaSConrad Meyer static void
197c4fbbfaaSConrad Meyer gdb_do_qsupported(uint32_t *feat)
198c4fbbfaaSConrad Meyer {
199c4fbbfaaSConrad Meyer 	char *tok, *delim, ok;
200c4fbbfaaSConrad Meyer 	size_t i, toklen;
201c4fbbfaaSConrad Meyer 
202c4fbbfaaSConrad Meyer 	/* Parse supported host features */
203c4fbbfaaSConrad Meyer 	*feat = 0;
2045af88677SConrad Meyer 	switch (gdb_rx_char()) {
2055af88677SConrad Meyer 	case ':':
2065af88677SConrad Meyer 		break;
2075af88677SConrad Meyer 	case EOF:
2085af88677SConrad Meyer 		goto nofeatures;
2095af88677SConrad Meyer 	default:
210c4fbbfaaSConrad Meyer 		goto error;
2115af88677SConrad Meyer 	}
212c4fbbfaaSConrad Meyer 
213c4fbbfaaSConrad Meyer 	while (gdb_rxsz > 0) {
214c4fbbfaaSConrad Meyer 		tok = gdb_rxp;
215c4fbbfaaSConrad Meyer 		delim = strchrnul(gdb_rxp, ';');
216c4fbbfaaSConrad Meyer 		toklen = (delim - tok);
217c4fbbfaaSConrad Meyer 
218c4fbbfaaSConrad Meyer 		gdb_rxp += toklen;
219c4fbbfaaSConrad Meyer 		gdb_rxsz -= toklen;
220c4fbbfaaSConrad Meyer 		if (*delim != '\0') {
221c4fbbfaaSConrad Meyer 			*delim = '\0';
222c4fbbfaaSConrad Meyer 			gdb_rxp += 1;
223c4fbbfaaSConrad Meyer 			gdb_rxsz -= 1;
224c4fbbfaaSConrad Meyer 		}
225c4fbbfaaSConrad Meyer 
226c4fbbfaaSConrad Meyer 		if (toklen < 2)
227c4fbbfaaSConrad Meyer 			goto error;
228c4fbbfaaSConrad Meyer 
229c4fbbfaaSConrad Meyer 		ok = tok[toklen - 1];
230c4fbbfaaSConrad Meyer 		if (ok != '-' && ok != '+') {
231c4fbbfaaSConrad Meyer 			/*
232c4fbbfaaSConrad Meyer 			 * GDB only has one KV-pair feature, and we don't
233c4fbbfaaSConrad Meyer 			 * support it, so ignore and move on.
234c4fbbfaaSConrad Meyer 			 */
235c4fbbfaaSConrad Meyer 			if (strchr(tok, '=') != NULL)
236c4fbbfaaSConrad Meyer 				continue;
237c4fbbfaaSConrad Meyer 			/* Not a KV-pair, and not a +/- flag?  Malformed. */
238c4fbbfaaSConrad Meyer 			goto error;
239c4fbbfaaSConrad Meyer 		}
240c4fbbfaaSConrad Meyer 		if (ok != '+')
241c4fbbfaaSConrad Meyer 			continue;
242c4fbbfaaSConrad Meyer 		tok[toklen - 1] = '\0';
243c4fbbfaaSConrad Meyer 
244c4fbbfaaSConrad Meyer 		for (i = 0; i < nitems(gdb_feature_names); i++)
245c4fbbfaaSConrad Meyer 			if (strcmp(gdb_feature_names[i], tok) == 0)
246c4fbbfaaSConrad Meyer 				break;
247c4fbbfaaSConrad Meyer 
248c4fbbfaaSConrad Meyer 		if (i == nitems(gdb_feature_names)) {
249c4fbbfaaSConrad Meyer 			/* Unknown GDB feature. */
250c4fbbfaaSConrad Meyer 			continue;
251c4fbbfaaSConrad Meyer 		}
252c4fbbfaaSConrad Meyer 
253c4fbbfaaSConrad Meyer 		*feat |= BIT(i);
254c4fbbfaaSConrad Meyer 	}
255c4fbbfaaSConrad Meyer 
2565af88677SConrad Meyer nofeatures:
257c4fbbfaaSConrad Meyer 	/* Send a supported feature list back */
258c4fbbfaaSConrad Meyer 	gdb_tx_begin(0);
259c4fbbfaaSConrad Meyer 
260c4fbbfaaSConrad Meyer 	gdb_tx_str("PacketSize");
261c4fbbfaaSConrad Meyer 	gdb_tx_char('=');
262c4fbbfaaSConrad Meyer 	/*
263c4fbbfaaSConrad Meyer 	 * We don't buffer framing bytes, but we do need to retain a byte for a
264c4fbbfaaSConrad Meyer 	 * trailing nul.
265c4fbbfaaSConrad Meyer 	 */
266c4fbbfaaSConrad Meyer 	gdb_tx_varhex(GDB_BUFSZ + strlen("$#nn") - 1);
267c4fbbfaaSConrad Meyer 
2685555afa1SConrad Meyer 	gdb_tx_str(";qXfer:threads:read+");
2695555afa1SConrad Meyer 
270*0adc959aSAndrew Turner #ifdef HAS_HW_BREAKPOINT
271*0adc959aSAndrew Turner 	if ((*feat & GDB_HWBREAK) != 0)
272*0adc959aSAndrew Turner 		gdb_tx_str(";hwbreak+");
273*0adc959aSAndrew Turner #endif
274*0adc959aSAndrew Turner 
275c4fbbfaaSConrad Meyer 	/*
2766310546dSConrad Meyer 	 * If the debugport is a reliable transport, request No Ack mode from
2776310546dSConrad Meyer 	 * the server.  The server may or may not choose to enter No Ack mode.
2786310546dSConrad Meyer 	 * https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html
2796310546dSConrad Meyer 	 */
2806310546dSConrad Meyer 	if (gdb_cur->gdb_dbfeatures & GDB_DBGP_FEAT_RELIABLE)
2816310546dSConrad Meyer 		gdb_tx_str(";QStartNoAckMode+");
2826310546dSConrad Meyer 
2836310546dSConrad Meyer 	/*
284c4fbbfaaSConrad Meyer 	 * Future consideration:
285c4fbbfaaSConrad Meyer 	 *   - vCont
286c4fbbfaaSConrad Meyer 	 *   - multiprocess
287c4fbbfaaSConrad Meyer 	 */
288c4fbbfaaSConrad Meyer 	gdb_tx_end();
289c4fbbfaaSConrad Meyer 	return;
290c4fbbfaaSConrad Meyer 
291c4fbbfaaSConrad Meyer error:
292c4fbbfaaSConrad Meyer 	*feat = 0;
293c4fbbfaaSConrad Meyer 	gdb_tx_err(EINVAL);
294c4fbbfaaSConrad Meyer }
295c4fbbfaaSConrad Meyer 
2965555afa1SConrad Meyer /*
2975555afa1SConrad Meyer  * A qXfer_context provides a vaguely generic way to generate a multi-packet
2985555afa1SConrad Meyer  * response on the fly, making some assumptions about the size of sbuf writes
2995555afa1SConrad Meyer  * vs actual packet length constraints.  A non-byzantine gdb host should allow
3005555afa1SConrad Meyer  * hundreds of bytes per packet or more.
3015555afa1SConrad Meyer  *
3025555afa1SConrad Meyer  * Upper layers are considered responsible for escaping the four forbidden
3035555afa1SConrad Meyer  * characters '# $ } *'.
3045555afa1SConrad Meyer  */
3055555afa1SConrad Meyer struct qXfer_context {
3065555afa1SConrad Meyer 	struct sbuf sb;
3075555afa1SConrad Meyer 	size_t last_offset;
3085555afa1SConrad Meyer 	bool flushed;
3095555afa1SConrad Meyer 	bool lastmessage;
3105555afa1SConrad Meyer 	char xfer_buf[GDB_BUFSZ];
3115555afa1SConrad Meyer };
3125555afa1SConrad Meyer 
3135555afa1SConrad Meyer static int
3145555afa1SConrad Meyer qXfer_drain(void *v, const char *buf, int len)
3155555afa1SConrad Meyer {
3165555afa1SConrad Meyer 	struct qXfer_context *qx;
3175555afa1SConrad Meyer 
3185555afa1SConrad Meyer 	if (len < 0)
3195555afa1SConrad Meyer 		return (-EINVAL);
3205555afa1SConrad Meyer 
3215555afa1SConrad Meyer 	qx = v;
3225555afa1SConrad Meyer 	if (qx->flushed) {
3235555afa1SConrad Meyer 		/*
3245555afa1SConrad Meyer 		 * Overflow.  We lost some message.  Maybe the packet size is
3255555afa1SConrad Meyer 		 * ridiculously small.
3265555afa1SConrad Meyer 		 */
3275555afa1SConrad Meyer 		printf("%s: Overflow in qXfer detected.\n", __func__);
3285555afa1SConrad Meyer 		return (-ENOBUFS);
3295555afa1SConrad Meyer 	}
3305555afa1SConrad Meyer 
3315555afa1SConrad Meyer 	qx->last_offset += len;
3325555afa1SConrad Meyer 	qx->flushed = true;
3335555afa1SConrad Meyer 
3345555afa1SConrad Meyer 	if (qx->lastmessage)
3355555afa1SConrad Meyer 		gdb_tx_begin('l');
3365555afa1SConrad Meyer 	else
3375555afa1SConrad Meyer 		gdb_tx_begin('m');
3385555afa1SConrad Meyer 
3395555afa1SConrad Meyer 	memcpy(gdb_txp, buf, len);
3405555afa1SConrad Meyer 	gdb_txp += len;
3415555afa1SConrad Meyer 
3425555afa1SConrad Meyer 	gdb_tx_end();
3435555afa1SConrad Meyer 	return (len);
3445555afa1SConrad Meyer }
3455555afa1SConrad Meyer 
3465555afa1SConrad Meyer static int
3475555afa1SConrad Meyer init_qXfer_ctx(struct qXfer_context *qx, uintmax_t len)
3485555afa1SConrad Meyer {
3495555afa1SConrad Meyer 
3505555afa1SConrad Meyer 	/* Protocol (max) length field includes framing overhead. */
3515555afa1SConrad Meyer 	if (len < sizeof("$m#nn"))
3525555afa1SConrad Meyer 		return (ENOSPC);
3535555afa1SConrad Meyer 
3545555afa1SConrad Meyer 	len -= 4;
3555555afa1SConrad Meyer 	len = ummin(len, GDB_BUFSZ - 1);
3565555afa1SConrad Meyer 
3575555afa1SConrad Meyer 	qx->last_offset = 0;
3585555afa1SConrad Meyer 	qx->flushed = false;
3595555afa1SConrad Meyer 	qx->lastmessage = false;
3605555afa1SConrad Meyer 	sbuf_new(&qx->sb, qx->xfer_buf, len, SBUF_FIXEDLEN);
3615555afa1SConrad Meyer 	sbuf_set_drain(&qx->sb, qXfer_drain, qx);
3625555afa1SConrad Meyer 	return (0);
3635555afa1SConrad Meyer }
3645555afa1SConrad Meyer 
3655555afa1SConrad Meyer /*
366a91812f6SConrad Meyer  * Squashes special XML and GDB characters down to _.  Sorry.
3675555afa1SConrad Meyer  */
3685555afa1SConrad Meyer static void
3695555afa1SConrad Meyer qXfer_escape_xmlattr_str(char *dst, size_t dstlen, const char *src)
3705555afa1SConrad Meyer {
3715555afa1SConrad Meyer 	static const char *forbidden = "#$}*";
3725555afa1SConrad Meyer 
3735555afa1SConrad Meyer 	size_t i;
3745555afa1SConrad Meyer 	char c;
3755555afa1SConrad Meyer 
3765555afa1SConrad Meyer 	for (i = 0; i < dstlen - 1 && *src != 0; src++, i++) {
3775555afa1SConrad Meyer 		c = *src;
3785555afa1SConrad Meyer 		/* XML attr filter */
3795555afa1SConrad Meyer 		if (c < 32)
3805555afa1SConrad Meyer 			c = '_';
3815555afa1SConrad Meyer 		/* We assume attributes will be "" quoted. */
3825555afa1SConrad Meyer 		if (c == '<' || c == '&' || c == '"')
3835555afa1SConrad Meyer 			c = '_';
3845555afa1SConrad Meyer 
3855555afa1SConrad Meyer 		/* GDB escape. */
3865555afa1SConrad Meyer 		if (strchr(forbidden, c) != NULL) {
387a91812f6SConrad Meyer 			/*
388a91812f6SConrad Meyer 			 * It would be nice to escape these properly, but to do
389a91812f6SConrad Meyer 			 * it correctly we need to escape them in the transmit
390a91812f6SConrad Meyer 			 * layer, potentially doubling our buffer requirements.
391a91812f6SConrad Meyer 			 * For now, avoid breaking the protocol by squashing
392a91812f6SConrad Meyer 			 * them to underscore.
393a91812f6SConrad Meyer 			 */
394a91812f6SConrad Meyer #if 0
3955555afa1SConrad Meyer 			*dst++ = '}';
3965555afa1SConrad Meyer 			c ^= 0x20;
397a91812f6SConrad Meyer #endif
398a91812f6SConrad Meyer 			c = '_';
3995555afa1SConrad Meyer 		}
4005555afa1SConrad Meyer 		*dst++ = c;
4015555afa1SConrad Meyer 	}
4025555afa1SConrad Meyer 	if (*src != 0)
4035555afa1SConrad Meyer 		printf("XXX%s: overflow; API misuse\n", __func__);
4045555afa1SConrad Meyer 
4055555afa1SConrad Meyer 	*dst = 0;
4065555afa1SConrad Meyer }
4075555afa1SConrad Meyer 
4085555afa1SConrad Meyer /*
4095555afa1SConrad Meyer  * Dynamically generate qXfer:threads document, one packet at a time.
4105555afa1SConrad Meyer  *
4115555afa1SConrad Meyer  * The format is loosely described[0], although it does not seem that the
4125555afa1SConrad Meyer  * <?xml?> mentioned on that page is required.
4135555afa1SConrad Meyer  *
4145555afa1SConrad Meyer  * [0]: https://sourceware.org/gdb/current/onlinedocs/gdb/Thread-List-Format.html
4155555afa1SConrad Meyer  */
4165555afa1SConrad Meyer static void
4175555afa1SConrad Meyer do_qXfer_threads_read(void)
4185555afa1SConrad Meyer {
4195555afa1SConrad Meyer 	/* Kludgy context */
4205555afa1SConrad Meyer 	static struct {
4215555afa1SConrad Meyer 		struct qXfer_context qXfer;
4225555afa1SConrad Meyer 		/* Kludgy state machine */
4235555afa1SConrad Meyer 		struct thread *iter;
4245555afa1SConrad Meyer 		enum {
4255555afa1SConrad Meyer 			XML_START_THREAD,	/* '<thread' */
4265555afa1SConrad Meyer 			XML_THREAD_ID,		/* ' id="xxx"' */
4275555afa1SConrad Meyer 			XML_THREAD_CORE,	/* ' core="yyy"' */
4285555afa1SConrad Meyer 			XML_THREAD_NAME,	/* ' name="zzz"' */
4295555afa1SConrad Meyer 			XML_THREAD_EXTRA,	/* '> ...' */
4305555afa1SConrad Meyer 			XML_END_THREAD,		/* '</thread>' */
4315555afa1SConrad Meyer 			XML_SENT_END_THREADS,	/* '</threads>' */
4325555afa1SConrad Meyer 		} next_step;
4335555afa1SConrad Meyer 	} ctx;
4345555afa1SConrad Meyer 	static char td_name_escape[MAXCOMLEN * 2 + 1];
4355555afa1SConrad Meyer 
4365555afa1SConrad Meyer 	const char *name_src;
4375555afa1SConrad Meyer 	uintmax_t offset, len;
4385555afa1SConrad Meyer 	int error;
4395555afa1SConrad Meyer 
4405555afa1SConrad Meyer 	/* Annex part must be empty. */
4415555afa1SConrad Meyer 	if (gdb_rx_char() != ':')
4425555afa1SConrad Meyer 		goto misformed_request;
4435555afa1SConrad Meyer 
4445555afa1SConrad Meyer 	if (gdb_rx_varhex(&offset) != 0 ||
4455555afa1SConrad Meyer 	    gdb_rx_char() != ',' ||
4465555afa1SConrad Meyer 	    gdb_rx_varhex(&len) != 0)
4475555afa1SConrad Meyer 		goto misformed_request;
4485555afa1SConrad Meyer 
4495555afa1SConrad Meyer 	/*
4505555afa1SConrad Meyer 	 * Validate resume xfers.
4515555afa1SConrad Meyer 	 */
4525555afa1SConrad Meyer 	if (offset != 0) {
4535555afa1SConrad Meyer 		if (offset != ctx.qXfer.last_offset) {
454acef7371SConrad Meyer 			printf("%s: Resumed offset %ju != expected %zu\n",
4555555afa1SConrad Meyer 			    __func__, offset, ctx.qXfer.last_offset);
4565555afa1SConrad Meyer 			error = ESPIPE;
4575555afa1SConrad Meyer 			goto request_error;
4585555afa1SConrad Meyer 		}
4595555afa1SConrad Meyer 		ctx.qXfer.flushed = false;
4605555afa1SConrad Meyer 	}
4615555afa1SConrad Meyer 
4625555afa1SConrad Meyer 	if (offset == 0) {
4635555afa1SConrad Meyer 		ctx.iter = kdb_thr_first();
4645555afa1SConrad Meyer 		ctx.next_step = XML_START_THREAD;
4655555afa1SConrad Meyer 		error = init_qXfer_ctx(&ctx.qXfer, len);
4665555afa1SConrad Meyer 		if (error != 0)
4675555afa1SConrad Meyer 			goto request_error;
4685555afa1SConrad Meyer 
4695555afa1SConrad Meyer 		sbuf_cat(&ctx.qXfer.sb, "<threads>");
4705555afa1SConrad Meyer 	}
4715555afa1SConrad Meyer 
4725555afa1SConrad Meyer 	while (!ctx.qXfer.flushed && ctx.iter != NULL) {
4735555afa1SConrad Meyer 		switch (ctx.next_step) {
4745555afa1SConrad Meyer 		case XML_START_THREAD:
4755555afa1SConrad Meyer 			ctx.next_step = XML_THREAD_ID;
4765555afa1SConrad Meyer 			sbuf_cat(&ctx.qXfer.sb, "<thread");
4775555afa1SConrad Meyer 			continue;
4785555afa1SConrad Meyer 
4795555afa1SConrad Meyer 		case XML_THREAD_ID:
4805555afa1SConrad Meyer 			ctx.next_step = XML_THREAD_CORE;
4815555afa1SConrad Meyer 			sbuf_printf(&ctx.qXfer.sb, " id=\"%jx\"",
4825555afa1SConrad Meyer 			    (uintmax_t)ctx.iter->td_tid);
4835555afa1SConrad Meyer 			continue;
4845555afa1SConrad Meyer 
4855555afa1SConrad Meyer 		case XML_THREAD_CORE:
4865555afa1SConrad Meyer 			ctx.next_step = XML_THREAD_NAME;
4875555afa1SConrad Meyer 			if (ctx.iter->td_oncpu != NOCPU) {
4885555afa1SConrad Meyer 				sbuf_printf(&ctx.qXfer.sb, " core=\"%d\"",
4895555afa1SConrad Meyer 				    ctx.iter->td_oncpu);
4905555afa1SConrad Meyer 			}
4915555afa1SConrad Meyer 			continue;
4925555afa1SConrad Meyer 
4935555afa1SConrad Meyer 		case XML_THREAD_NAME:
4945555afa1SConrad Meyer 			ctx.next_step = XML_THREAD_EXTRA;
4955555afa1SConrad Meyer 
4965555afa1SConrad Meyer 			if (ctx.iter->td_name[0] != 0)
4975555afa1SConrad Meyer 				name_src = ctx.iter->td_name;
4985555afa1SConrad Meyer 			else if (ctx.iter->td_proc != NULL &&
4995555afa1SConrad Meyer 			    ctx.iter->td_proc->p_comm[0] != 0)
5005555afa1SConrad Meyer 				name_src = ctx.iter->td_proc->p_comm;
5015555afa1SConrad Meyer 			else
5025555afa1SConrad Meyer 				continue;
5035555afa1SConrad Meyer 
5045555afa1SConrad Meyer 			qXfer_escape_xmlattr_str(td_name_escape,
5055555afa1SConrad Meyer 			    sizeof(td_name_escape), name_src);
5065555afa1SConrad Meyer 			sbuf_printf(&ctx.qXfer.sb, " name=\"%s\"",
5075555afa1SConrad Meyer 			    td_name_escape);
5085555afa1SConrad Meyer 			continue;
5095555afa1SConrad Meyer 
5105555afa1SConrad Meyer 		case XML_THREAD_EXTRA:
5115555afa1SConrad Meyer 			ctx.next_step = XML_END_THREAD;
5125555afa1SConrad Meyer 
5135555afa1SConrad Meyer 			sbuf_putc(&ctx.qXfer.sb, '>');
5145555afa1SConrad Meyer 
515fa2528acSAlex Richardson 			if (TD_GET_STATE(ctx.iter) == TDS_RUNNING)
5165555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "Running");
517fa2528acSAlex Richardson 			else if (TD_GET_STATE(ctx.iter) == TDS_RUNQ)
5185555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "RunQ");
519fa2528acSAlex Richardson 			else if (TD_GET_STATE(ctx.iter) == TDS_CAN_RUN)
5205555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "CanRun");
5215555afa1SConrad Meyer 			else if (TD_ON_LOCK(ctx.iter))
5225555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "Blocked");
5235555afa1SConrad Meyer 			else if (TD_IS_SLEEPING(ctx.iter))
5245555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "Sleeping");
5255555afa1SConrad Meyer 			else if (TD_AWAITING_INTR(ctx.iter))
5265555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "IthreadWait");
5275555afa1SConrad Meyer 			else if (TD_IS_SUSPENDED(ctx.iter))
5285555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "Suspended");
5295555afa1SConrad Meyer 			else
5305555afa1SConrad Meyer 				sbuf_cat(&ctx.qXfer.sb, "???");
5315555afa1SConrad Meyer 			continue;
5325555afa1SConrad Meyer 
5335555afa1SConrad Meyer 		case XML_END_THREAD:
5345555afa1SConrad Meyer 			ctx.next_step = XML_START_THREAD;
5355555afa1SConrad Meyer 			sbuf_cat(&ctx.qXfer.sb, "</thread>");
5365555afa1SConrad Meyer 			ctx.iter = kdb_thr_next(ctx.iter);
5375555afa1SConrad Meyer 			continue;
5385555afa1SConrad Meyer 
5395555afa1SConrad Meyer 		/*
5405555afa1SConrad Meyer 		 * This one isn't part of the looping state machine,
5415555afa1SConrad Meyer 		 * but GCC complains if you leave an enum value out of the
5425555afa1SConrad Meyer 		 * select.
5435555afa1SConrad Meyer 		 */
5445555afa1SConrad Meyer 		case XML_SENT_END_THREADS:
5455555afa1SConrad Meyer 			/* NOTREACHED */
5465555afa1SConrad Meyer 			break;
5475555afa1SConrad Meyer 		}
5485555afa1SConrad Meyer 	}
5495555afa1SConrad Meyer 	if (ctx.qXfer.flushed)
5505555afa1SConrad Meyer 		return;
5515555afa1SConrad Meyer 
5525555afa1SConrad Meyer 	if (ctx.next_step != XML_SENT_END_THREADS) {
5535555afa1SConrad Meyer 		ctx.next_step = XML_SENT_END_THREADS;
5545555afa1SConrad Meyer 		sbuf_cat(&ctx.qXfer.sb, "</threads>");
5555555afa1SConrad Meyer 	}
5565555afa1SConrad Meyer 	if (ctx.qXfer.flushed)
5575555afa1SConrad Meyer 		return;
5585555afa1SConrad Meyer 
5595555afa1SConrad Meyer 	ctx.qXfer.lastmessage = true;
5605555afa1SConrad Meyer 	sbuf_finish(&ctx.qXfer.sb);
5615555afa1SConrad Meyer 	sbuf_delete(&ctx.qXfer.sb);
5625555afa1SConrad Meyer 	ctx.qXfer.last_offset = 0;
5635555afa1SConrad Meyer 	return;
5645555afa1SConrad Meyer 
5655555afa1SConrad Meyer misformed_request:
5665555afa1SConrad Meyer 	/*
5675555afa1SConrad Meyer 	 * GDB "General-Query-Packets.html" qXfer-read anchor specifically
5685555afa1SConrad Meyer 	 * documents an E00 code for malformed requests or invalid annex.
5695555afa1SConrad Meyer 	 * Non-zero codes indicate invalid offset or "error reading the data."
5705555afa1SConrad Meyer 	 */
5715555afa1SConrad Meyer 	error = 0;
5725555afa1SConrad Meyer request_error:
5735555afa1SConrad Meyer 	gdb_tx_err(error);
5745555afa1SConrad Meyer 	return;
5755555afa1SConrad Meyer }
5765555afa1SConrad Meyer 
5775555afa1SConrad Meyer /*
5785555afa1SConrad Meyer  * A set of standardized transfers from "special data areas."
5795555afa1SConrad Meyer  *
5805555afa1SConrad Meyer  * We've already matched on "qXfer:" and advanced the rx packet buffer past
5815555afa1SConrad Meyer  * that bit.  Parse out the rest of the packet and generate an appropriate
5825555afa1SConrad Meyer  * response.
5835555afa1SConrad Meyer  */
5845555afa1SConrad Meyer static void
5855555afa1SConrad Meyer do_qXfer(void)
5865555afa1SConrad Meyer {
5875555afa1SConrad Meyer 	if (!gdb_rx_equal("threads:"))
5885555afa1SConrad Meyer 		goto unrecognized;
5895555afa1SConrad Meyer 
5905555afa1SConrad Meyer 	if (!gdb_rx_equal("read:"))
5915555afa1SConrad Meyer 		goto unrecognized;
5925555afa1SConrad Meyer 
5935555afa1SConrad Meyer 	do_qXfer_threads_read();
5945555afa1SConrad Meyer 	return;
5955555afa1SConrad Meyer 
5965555afa1SConrad Meyer unrecognized:
5975555afa1SConrad Meyer 	gdb_tx_empty();
5985555afa1SConrad Meyer 	return;
5995555afa1SConrad Meyer }
6005555afa1SConrad Meyer 
601dda17b36SConrad Meyer static void
602dda17b36SConrad Meyer gdb_handle_detach(void)
603dda17b36SConrad Meyer {
604dda17b36SConrad Meyer 	kdb_cpu_clear_singlestep();
605dda17b36SConrad Meyer 	gdb_listening = 0;
606dda17b36SConrad Meyer 
607dda17b36SConrad Meyer 	if (gdb_cur->gdb_dbfeatures & GDB_DBGP_FEAT_WANTTERM)
608dda17b36SConrad Meyer 		gdb_cur->gdb_term();
609dda17b36SConrad Meyer 
610dda17b36SConrad Meyer #ifdef DDB
611dda17b36SConrad Meyer 	if (!gdb_return_to_ddb)
612dda17b36SConrad Meyer 		return;
613dda17b36SConrad Meyer 
614dda17b36SConrad Meyer 	gdb_return_to_ddb = false;
615dda17b36SConrad Meyer 
616dda17b36SConrad Meyer 	if (kdb_dbbe_select("ddb") != 0)
617dda17b36SConrad Meyer 		printf("The ddb backend could not be selected.\n");
618dda17b36SConrad Meyer #endif
619dda17b36SConrad Meyer }
620dda17b36SConrad Meyer 
6214beb3858SMitchell Horne /*
6224beb3858SMitchell Horne  * Handle a 'Z' packet: set a breakpoint or watchpoint.
6234beb3858SMitchell Horne  *
6244beb3858SMitchell Horne  * Currently, only watchpoints are supported.
6254beb3858SMitchell Horne  */
6264beb3858SMitchell Horne static void
6274beb3858SMitchell Horne gdb_z_insert(void)
6284beb3858SMitchell Horne {
6294beb3858SMitchell Horne 	intmax_t addr, length;
6304beb3858SMitchell Horne 	char ztype;
6314beb3858SMitchell Horne 	int error;
6324beb3858SMitchell Horne 
6334beb3858SMitchell Horne 	ztype = gdb_rx_char();
6344beb3858SMitchell Horne 	if (gdb_rx_char() != ',' || gdb_rx_varhex(&addr) ||
6354beb3858SMitchell Horne 	    gdb_rx_char() != ',' || gdb_rx_varhex(&length)) {
6364beb3858SMitchell Horne 		error = EINVAL;
6374beb3858SMitchell Horne 		goto fail;
6384beb3858SMitchell Horne 	}
6394beb3858SMitchell Horne 
6404beb3858SMitchell Horne 	switch (ztype) {
6414beb3858SMitchell Horne 	case '2': /* write watchpoint */
6424beb3858SMitchell Horne 		error = kdb_cpu_set_watchpoint((vm_offset_t)addr,
6434beb3858SMitchell Horne 		    (vm_size_t)length, KDB_DBG_ACCESS_W);
6444beb3858SMitchell Horne 		break;
6454beb3858SMitchell Horne 	case '3': /* read watchpoint */
6464beb3858SMitchell Horne 		error = kdb_cpu_set_watchpoint((vm_offset_t)addr,
6474beb3858SMitchell Horne 		    (vm_size_t)length, KDB_DBG_ACCESS_R);
6484beb3858SMitchell Horne 		break;
6494beb3858SMitchell Horne 	case '4': /* access (RW) watchpoint */
6504beb3858SMitchell Horne 		error = kdb_cpu_set_watchpoint((vm_offset_t)addr,
6514beb3858SMitchell Horne 		    (vm_size_t)length, KDB_DBG_ACCESS_RW);
6524beb3858SMitchell Horne 		break;
6534beb3858SMitchell Horne 	case '1': /* hardware breakpoint */
654*0adc959aSAndrew Turner #ifdef HAS_HW_BREAKPOINT
655*0adc959aSAndrew Turner 		error = kdb_cpu_set_breakpoint((vm_offset_t)addr);
656*0adc959aSAndrew Turner 		break;
657*0adc959aSAndrew Turner #endif
6584beb3858SMitchell Horne 	case '0': /* software breakpoint */
6594beb3858SMitchell Horne 		/* Not implemented. */
6604beb3858SMitchell Horne 		gdb_tx_empty();
6614beb3858SMitchell Horne 		return;
6624beb3858SMitchell Horne 	default:
6634beb3858SMitchell Horne 		error = EINVAL;
6644beb3858SMitchell Horne 		break;
6654beb3858SMitchell Horne 	}
6664beb3858SMitchell Horne 	if (error != 0)
6674beb3858SMitchell Horne 		goto fail;
6684beb3858SMitchell Horne 	gdb_tx_ok();
6694beb3858SMitchell Horne 	return;
6704beb3858SMitchell Horne fail:
6714beb3858SMitchell Horne 	gdb_tx_err(error);
6724beb3858SMitchell Horne 	return;
6734beb3858SMitchell Horne }
6744beb3858SMitchell Horne 
6754beb3858SMitchell Horne /*
6764beb3858SMitchell Horne  * Handle a 'z' packet; clear a breakpoint or watchpoint.
6774beb3858SMitchell Horne  *
6784beb3858SMitchell Horne  * Currently, only watchpoints are supported.
6794beb3858SMitchell Horne  */
6804beb3858SMitchell Horne static void
6814beb3858SMitchell Horne gdb_z_remove(void)
6824beb3858SMitchell Horne {
6834beb3858SMitchell Horne 	intmax_t addr, length;
6844beb3858SMitchell Horne 	char ztype;
6854beb3858SMitchell Horne 	int error;
6864beb3858SMitchell Horne 
6874beb3858SMitchell Horne 	ztype = gdb_rx_char();
6884beb3858SMitchell Horne 	if (gdb_rx_char() != ',' || gdb_rx_varhex(&addr) ||
6894beb3858SMitchell Horne 	    gdb_rx_char() != ',' || gdb_rx_varhex(&length)) {
6904beb3858SMitchell Horne 		error = EINVAL;
6914beb3858SMitchell Horne 		goto fail;
6924beb3858SMitchell Horne 	}
6934beb3858SMitchell Horne 
6944beb3858SMitchell Horne 	switch (ztype) {
6954beb3858SMitchell Horne 	case '2': /* write watchpoint */
6964beb3858SMitchell Horne 	case '3': /* read watchpoint */
6974beb3858SMitchell Horne 	case '4': /* access (RW) watchpoint */
6984beb3858SMitchell Horne 		error = kdb_cpu_clr_watchpoint((vm_offset_t)addr,
6994beb3858SMitchell Horne 		    (vm_size_t)length);
7004beb3858SMitchell Horne 		break;
7014beb3858SMitchell Horne 	case '1': /* hardware breakpoint */
702*0adc959aSAndrew Turner #ifdef HAS_HW_BREAKPOINT
703*0adc959aSAndrew Turner 		error = kdb_cpu_clr_breakpoint((vm_offset_t)addr);
704*0adc959aSAndrew Turner 		break;
705*0adc959aSAndrew Turner #endif
7064beb3858SMitchell Horne 	case '0': /* software breakpoint */
7074beb3858SMitchell Horne 		/* Not implemented. */
7084beb3858SMitchell Horne 		gdb_tx_empty();
7094beb3858SMitchell Horne 		return;
7104beb3858SMitchell Horne 	default:
7114beb3858SMitchell Horne 		error = EINVAL;
7124beb3858SMitchell Horne 		break;
7134beb3858SMitchell Horne 	}
7144beb3858SMitchell Horne 	if (error != 0)
7154beb3858SMitchell Horne 		goto fail;
7164beb3858SMitchell Horne 	gdb_tx_ok();
7174beb3858SMitchell Horne 	return;
7184beb3858SMitchell Horne fail:
7194beb3858SMitchell Horne 	gdb_tx_err(error);
7204beb3858SMitchell Horne 	return;
7214beb3858SMitchell Horne }
7224beb3858SMitchell Horne 
72372d44f31SMarcel Moolenaar static int
72472d44f31SMarcel Moolenaar gdb_trap(int type, int code)
72572d44f31SMarcel Moolenaar {
7263a5d3671SMatthew D Fleming 	jmp_buf jb;
72772d44f31SMarcel Moolenaar 	struct thread *thr_iter;
7283a5d3671SMatthew D Fleming 	void *prev_jb;
729c4fbbfaaSConrad Meyer 	uint32_t host_features;
7303a5d3671SMatthew D Fleming 
7313a5d3671SMatthew D Fleming 	prev_jb = kdb_jmpbuf(jb);
7323a5d3671SMatthew D Fleming 	if (setjmp(jb) != 0) {
7333a5d3671SMatthew D Fleming 		printf("%s bailing, hopefully back to ddb!\n", __func__);
7343a5d3671SMatthew D Fleming 		gdb_listening = 0;
7353a5d3671SMatthew D Fleming 		(void)kdb_jmpbuf(prev_jb);
7363a5d3671SMatthew D Fleming 		return (1);
7373a5d3671SMatthew D Fleming 	}
73872d44f31SMarcel Moolenaar 
7397d0c6c9fSSam Leffler 	gdb_listening = 0;
7406310546dSConrad Meyer 	gdb_ackmode = true;
7416310546dSConrad Meyer 
74272d44f31SMarcel Moolenaar 	/*
74372d44f31SMarcel Moolenaar 	 * Send a T packet. We currently do not support watchpoints (the
74472d44f31SMarcel Moolenaar 	 * awatch, rwatch or watch elements).
74572d44f31SMarcel Moolenaar 	 */
74672d44f31SMarcel Moolenaar 	gdb_tx_begin('T');
74772d44f31SMarcel Moolenaar 	gdb_tx_hex(gdb_cpu_signal(type, code), 2);
74872d44f31SMarcel Moolenaar 	gdb_tx_varhex(GDB_REG_PC);
74972d44f31SMarcel Moolenaar 	gdb_tx_char(':');
75072d44f31SMarcel Moolenaar 	gdb_tx_reg(GDB_REG_PC);
75172d44f31SMarcel Moolenaar 	gdb_tx_char(';');
7527446b088SMitchell Horne 	gdb_cpu_stop_reason(type, code);
75372d44f31SMarcel Moolenaar 	gdb_tx_str("thread:");
7547446b088SMitchell Horne 	gdb_tx_varhex((uintmax_t)kdb_thread->td_tid);
75572d44f31SMarcel Moolenaar 	gdb_tx_char(';');
75672d44f31SMarcel Moolenaar 	gdb_tx_end();			/* XXX check error condition. */
75772d44f31SMarcel Moolenaar 
75872d44f31SMarcel Moolenaar 	thr_iter = NULL;
75972d44f31SMarcel Moolenaar 	while (gdb_rx_begin() == 0) {
76003e62bf3SMarcel Moolenaar 		/* printf("GDB: got '%s'\n", gdb_rxp); */
76172d44f31SMarcel Moolenaar 		switch (gdb_rx_char()) {
76272d44f31SMarcel Moolenaar 		case '?':	/* Last signal. */
76376c8c090SConrad Meyer 			gdb_tx_begin('T');
76472d44f31SMarcel Moolenaar 			gdb_tx_hex(gdb_cpu_signal(type, code), 2);
76576c8c090SConrad Meyer 			gdb_tx_str("thread:");
76676c8c090SConrad Meyer 			gdb_tx_varhex((long)kdb_thread->td_tid);
76776c8c090SConrad Meyer 			gdb_tx_char(';');
76872d44f31SMarcel Moolenaar 			gdb_tx_end();
76972d44f31SMarcel Moolenaar 			break;
77072d44f31SMarcel Moolenaar 		case 'c': {	/* Continue. */
77172d44f31SMarcel Moolenaar 			uintmax_t addr;
772bcc5241cSMarcel Moolenaar 			register_t pc;
773bcc5241cSMarcel Moolenaar 			if (!gdb_rx_varhex(&addr)) {
774bcc5241cSMarcel Moolenaar 				pc = addr;
775bcc5241cSMarcel Moolenaar 				gdb_cpu_setreg(GDB_REG_PC, &pc);
776bcc5241cSMarcel Moolenaar 			}
77772d44f31SMarcel Moolenaar 			kdb_cpu_clear_singlestep();
7787d0c6c9fSSam Leffler 			gdb_listening = 1;
77972d44f31SMarcel Moolenaar 			return (1);
78072d44f31SMarcel Moolenaar 		}
78172d44f31SMarcel Moolenaar 		case 'C': {	/* Continue with signal. */
78272d44f31SMarcel Moolenaar 			uintmax_t addr, sig;
783bcc5241cSMarcel Moolenaar 			register_t pc;
78472d44f31SMarcel Moolenaar 			if (!gdb_rx_varhex(&sig) && gdb_rx_char() == ';' &&
785bcc5241cSMarcel Moolenaar 			    !gdb_rx_varhex(&addr)) {
786bcc5241cSMarcel Moolenaar 				pc = addr;
787bcc5241cSMarcel Moolenaar 				gdb_cpu_setreg(GDB_REG_PC, &pc);
788bcc5241cSMarcel Moolenaar 			}
78972d44f31SMarcel Moolenaar 			kdb_cpu_clear_singlestep();
7907d0c6c9fSSam Leffler 			gdb_listening = 1;
79172d44f31SMarcel Moolenaar 			return (1);
79272d44f31SMarcel Moolenaar 		}
793d412b2deSPeter Grehan 		case 'D': {     /* Detach */
794d412b2deSPeter Grehan 			gdb_tx_ok();
795dda17b36SConrad Meyer 			gdb_handle_detach();
796d412b2deSPeter Grehan 			return (1);
797d412b2deSPeter Grehan 		}
79872d44f31SMarcel Moolenaar 		case 'g': {	/* Read registers. */
79972d44f31SMarcel Moolenaar 			size_t r;
80072d44f31SMarcel Moolenaar 			gdb_tx_begin(0);
80172d44f31SMarcel Moolenaar 			for (r = 0; r < GDB_NREGS; r++)
80272d44f31SMarcel Moolenaar 				gdb_tx_reg(r);
80372d44f31SMarcel Moolenaar 			gdb_tx_end();
80472d44f31SMarcel Moolenaar 			break;
80572d44f31SMarcel Moolenaar 		}
8063f3cc995SMitchell Horne 		case 'G': {	/* Write registers. */
8073f3cc995SMitchell Horne 			char *val;
8083f3cc995SMitchell Horne 			bool success;
8093f3cc995SMitchell Horne 			size_t r;
8103f3cc995SMitchell Horne 			for (success = true, r = 0; r < GDB_NREGS; r++) {
8113f3cc995SMitchell Horne 				val = gdb_rxp;
8123f3cc995SMitchell Horne 				if (!gdb_rx_mem(val, gdb_cpu_regsz(r))) {
8133f3cc995SMitchell Horne 					gdb_tx_err(EINVAL);
8143f3cc995SMitchell Horne 					success = false;
81572d44f31SMarcel Moolenaar 					break;
8163f3cc995SMitchell Horne 				}
8173f3cc995SMitchell Horne 				gdb_cpu_setreg(r, val);
8183f3cc995SMitchell Horne 			}
8193f3cc995SMitchell Horne 			if (success)
8203f3cc995SMitchell Horne 				gdb_tx_ok();
8213f3cc995SMitchell Horne 			break;
8223f3cc995SMitchell Horne 		}
82372d44f31SMarcel Moolenaar 		case 'H': {	/* Set thread. */
82472d44f31SMarcel Moolenaar 			intmax_t tid;
82572d44f31SMarcel Moolenaar 			struct thread *thr;
8265df6fa43SConrad Meyer 
8275df6fa43SConrad Meyer 			/* Ignore 'g' (general) or 'c' (continue) flag. */
8285df6fa43SConrad Meyer 			(void) gdb_rx_char();
8295df6fa43SConrad Meyer 
8304af77eceSSam Leffler 			if (gdb_rx_varhex(&tid)) {
8314af77eceSSam Leffler 				gdb_tx_err(EINVAL);
8324af77eceSSam Leffler 				break;
8334af77eceSSam Leffler 			}
83472d44f31SMarcel Moolenaar 			if (tid > 0) {
83572d44f31SMarcel Moolenaar 				thr = kdb_thr_lookup(tid);
83672d44f31SMarcel Moolenaar 				if (thr == NULL) {
83772d44f31SMarcel Moolenaar 					gdb_tx_err(ENOENT);
83872d44f31SMarcel Moolenaar 					break;
83972d44f31SMarcel Moolenaar 				}
84072d44f31SMarcel Moolenaar 				kdb_thr_select(thr);
84172d44f31SMarcel Moolenaar 			}
84272d44f31SMarcel Moolenaar 			gdb_tx_ok();
84372d44f31SMarcel Moolenaar 			break;
84472d44f31SMarcel Moolenaar 		}
84572d44f31SMarcel Moolenaar 		case 'k':	/* Kill request. */
846dda17b36SConrad Meyer 			gdb_handle_detach();
84772d44f31SMarcel Moolenaar 			return (1);
84872d44f31SMarcel Moolenaar 		case 'm': {	/* Read memory. */
84972d44f31SMarcel Moolenaar 			uintmax_t addr, size;
85072d44f31SMarcel Moolenaar 			if (gdb_rx_varhex(&addr) || gdb_rx_char() != ',' ||
85172d44f31SMarcel Moolenaar 			    gdb_rx_varhex(&size)) {
85272d44f31SMarcel Moolenaar 				gdb_tx_err(EINVAL);
85372d44f31SMarcel Moolenaar 				break;
85472d44f31SMarcel Moolenaar 			}
85572d44f31SMarcel Moolenaar 			gdb_tx_begin(0);
85672d44f31SMarcel Moolenaar 			if (gdb_tx_mem((char *)(uintptr_t)addr, size))
85772d44f31SMarcel Moolenaar 				gdb_tx_end();
85872d44f31SMarcel Moolenaar 			else
85972d44f31SMarcel Moolenaar 				gdb_tx_err(EIO);
86072d44f31SMarcel Moolenaar 			break;
86172d44f31SMarcel Moolenaar 		}
86272d44f31SMarcel Moolenaar 		case 'M': {	/* Write memory. */
86372d44f31SMarcel Moolenaar 			uintmax_t addr, size;
86472d44f31SMarcel Moolenaar 			if (gdb_rx_varhex(&addr) || gdb_rx_char() != ',' ||
86572d44f31SMarcel Moolenaar 			    gdb_rx_varhex(&size) || gdb_rx_char() != ':') {
86672d44f31SMarcel Moolenaar 				gdb_tx_err(EINVAL);
86772d44f31SMarcel Moolenaar 				break;
86872d44f31SMarcel Moolenaar 			}
86972d44f31SMarcel Moolenaar 			if (gdb_rx_mem((char *)(uintptr_t)addr, size) == 0)
87072d44f31SMarcel Moolenaar 				gdb_tx_err(EIO);
87172d44f31SMarcel Moolenaar 			else
87272d44f31SMarcel Moolenaar 				gdb_tx_ok();
87372d44f31SMarcel Moolenaar 			break;
87472d44f31SMarcel Moolenaar 		}
875fd29833dSMitchell Horne 		case 'p': {     /* Read register. */
876fd29833dSMitchell Horne 			uintmax_t reg;
877fd29833dSMitchell Horne 			if (gdb_rx_varhex(&reg)) {
878fd29833dSMitchell Horne 				gdb_tx_err(EINVAL);
879fd29833dSMitchell Horne 				break;
880fd29833dSMitchell Horne 			}
881fd29833dSMitchell Horne 			gdb_tx_begin(0);
882fd29833dSMitchell Horne 			gdb_tx_reg(reg);
883fd29833dSMitchell Horne 			gdb_tx_end();
884fd29833dSMitchell Horne 			break;
885fd29833dSMitchell Horne 		}
88672d44f31SMarcel Moolenaar 		case 'P': {	/* Write register. */
887bcc5241cSMarcel Moolenaar 			char *val;
888bcc5241cSMarcel Moolenaar 			uintmax_t reg;
889bcc5241cSMarcel Moolenaar 			val = gdb_rxp;
89072d44f31SMarcel Moolenaar 			if (gdb_rx_varhex(&reg) || gdb_rx_char() != '=' ||
891bcc5241cSMarcel Moolenaar 			    !gdb_rx_mem(val, gdb_cpu_regsz(reg))) {
89272d44f31SMarcel Moolenaar 				gdb_tx_err(EINVAL);
89372d44f31SMarcel Moolenaar 				break;
89472d44f31SMarcel Moolenaar 			}
89572d44f31SMarcel Moolenaar 			gdb_cpu_setreg(reg, val);
89672d44f31SMarcel Moolenaar 			gdb_tx_ok();
89772d44f31SMarcel Moolenaar 			break;
89872d44f31SMarcel Moolenaar 		}
89972d44f31SMarcel Moolenaar 		case 'q':	/* General query. */
9003bbe6e64SConrad Meyer 			if (gdb_rx_equal("C")) {
9013bbe6e64SConrad Meyer 				gdb_tx_begin('Q');
9023bbe6e64SConrad Meyer 				gdb_tx_char('C');
9033bbe6e64SConrad Meyer 				gdb_tx_varhex((long)kdb_thread->td_tid);
9043bbe6e64SConrad Meyer 				gdb_tx_end();
905c4fbbfaaSConrad Meyer 			} else if (gdb_rx_equal("Supported")) {
906c4fbbfaaSConrad Meyer 				gdb_do_qsupported(&host_features);
9073bbe6e64SConrad Meyer 			} else if (gdb_rx_equal("fThreadInfo")) {
90872d44f31SMarcel Moolenaar 				thr_iter = kdb_thr_first();
909130ef1adSConrad Meyer 				gdb_do_threadinfo(&thr_iter);
91072d44f31SMarcel Moolenaar 			} else if (gdb_rx_equal("sThreadInfo")) {
911130ef1adSConrad Meyer 				gdb_do_threadinfo(&thr_iter);
9125555afa1SConrad Meyer 			} else if (gdb_rx_equal("Xfer:")) {
9135555afa1SConrad Meyer 				do_qXfer();
91427ecc2adSBenno Rice 			} else if (gdb_rx_equal("Search:memory:")) {
9158a7a6571SRyan Libby 				gdb_do_mem_search();
916fa76c6f9SLeandro Lupori #ifdef __powerpc__
917fa76c6f9SLeandro Lupori 			} else if (gdb_rx_equal("Offsets")) {
918fa76c6f9SLeandro Lupori 				gdb_cpu_do_offsets();
919fa76c6f9SLeandro Lupori #endif
92072d44f31SMarcel Moolenaar 			} else if (!gdb_cpu_query())
92172d44f31SMarcel Moolenaar 				gdb_tx_empty();
92272d44f31SMarcel Moolenaar 			break;
9236310546dSConrad Meyer 		case 'Q':
9246310546dSConrad Meyer 			if (gdb_rx_equal("StartNoAckMode")) {
9256310546dSConrad Meyer 				if ((gdb_cur->gdb_dbfeatures &
9266310546dSConrad Meyer 				    GDB_DBGP_FEAT_RELIABLE) == 0) {
9276310546dSConrad Meyer 					/*
9286310546dSConrad Meyer 					 * Shouldn't happen if we didn't
9296310546dSConrad Meyer 					 * advertise support.  Reject.
9306310546dSConrad Meyer 					 */
9316310546dSConrad Meyer 					gdb_tx_empty();
9326310546dSConrad Meyer 					break;
9336310546dSConrad Meyer 				}
9346310546dSConrad Meyer 				gdb_ackmode = false;
9356310546dSConrad Meyer 				gdb_tx_ok();
9366310546dSConrad Meyer 			} else
9376310546dSConrad Meyer 				gdb_tx_empty();
9386310546dSConrad Meyer 			break;
93972d44f31SMarcel Moolenaar 		case 's': {	/* Step. */
94072d44f31SMarcel Moolenaar 			uintmax_t addr;
941bcc5241cSMarcel Moolenaar 			register_t pc;
942bcc5241cSMarcel Moolenaar 			if (!gdb_rx_varhex(&addr)) {
943bcc5241cSMarcel Moolenaar 				pc = addr;
944bcc5241cSMarcel Moolenaar 				gdb_cpu_setreg(GDB_REG_PC, &pc);
945bcc5241cSMarcel Moolenaar 			}
94672d44f31SMarcel Moolenaar 			kdb_cpu_set_singlestep();
9477d0c6c9fSSam Leffler 			gdb_listening = 1;
94872d44f31SMarcel Moolenaar 			return (1);
94972d44f31SMarcel Moolenaar 		}
95072d44f31SMarcel Moolenaar 		case 'S': {	/* Step with signal. */
95172d44f31SMarcel Moolenaar 			uintmax_t addr, sig;
952bcc5241cSMarcel Moolenaar 			register_t pc;
95372d44f31SMarcel Moolenaar 			if (!gdb_rx_varhex(&sig) && gdb_rx_char() == ';' &&
954bcc5241cSMarcel Moolenaar 			    !gdb_rx_varhex(&addr)) {
955bcc5241cSMarcel Moolenaar 				pc = addr;
956bcc5241cSMarcel Moolenaar 				gdb_cpu_setreg(GDB_REG_PC, &pc);
957bcc5241cSMarcel Moolenaar 			}
95872d44f31SMarcel Moolenaar 			kdb_cpu_set_singlestep();
9597d0c6c9fSSam Leffler 			gdb_listening = 1;
96072d44f31SMarcel Moolenaar 			return (1);
96172d44f31SMarcel Moolenaar 		}
96272d44f31SMarcel Moolenaar 		case 'T': {	/* Thread alive. */
96372d44f31SMarcel Moolenaar 			intmax_t tid;
9644af77eceSSam Leffler 			if (gdb_rx_varhex(&tid)) {
9654af77eceSSam Leffler 				gdb_tx_err(EINVAL);
9664af77eceSSam Leffler 				break;
9674af77eceSSam Leffler 			}
96872d44f31SMarcel Moolenaar 			if (kdb_thr_lookup(tid) != NULL)
96972d44f31SMarcel Moolenaar 				gdb_tx_ok();
97072d44f31SMarcel Moolenaar 			else
97172d44f31SMarcel Moolenaar 				gdb_tx_err(ENOENT);
97272d44f31SMarcel Moolenaar 			break;
97372d44f31SMarcel Moolenaar 		}
9744beb3858SMitchell Horne 		case 'z': {	/* Remove watchpoint. */
9754beb3858SMitchell Horne 			gdb_z_remove();
9764beb3858SMitchell Horne 			break;
9774beb3858SMitchell Horne 		}
9784beb3858SMitchell Horne 		case 'Z': {	/* Set watchpoint. */
9794beb3858SMitchell Horne 			gdb_z_insert();
9804beb3858SMitchell Horne 			break;
9814beb3858SMitchell Horne 		}
9825df6fa43SConrad Meyer 		case EOF:
98372d44f31SMarcel Moolenaar 			/* Empty command. Treat as unknown command. */
98472d44f31SMarcel Moolenaar 			/* FALLTHROUGH */
98572d44f31SMarcel Moolenaar 		default:
98672d44f31SMarcel Moolenaar 			/* Unknown command. Send empty response. */
98772d44f31SMarcel Moolenaar 			gdb_tx_empty();
98872d44f31SMarcel Moolenaar 			break;
98972d44f31SMarcel Moolenaar 		}
99072d44f31SMarcel Moolenaar 	}
9913a5d3671SMatthew D Fleming 	(void)kdb_jmpbuf(prev_jb);
99272d44f31SMarcel Moolenaar 	return (0);
99372d44f31SMarcel Moolenaar }
994