xref: /freebsd/sys/gdb/gdb_packet.c (revision f346afc439e869482f22d1550d756e4e3f717025)
1fa521b03SWarner Losh /*-
272d44f31SMarcel Moolenaar  * Copyright (c) 2004 Marcel Moolenaar
372d44f31SMarcel Moolenaar  * All rights reserved.
472d44f31SMarcel Moolenaar  *
572d44f31SMarcel Moolenaar  * Redistribution and use in source and binary forms, with or without
672d44f31SMarcel Moolenaar  * modification, are permitted provided that the following conditions
772d44f31SMarcel Moolenaar  * are met:
872d44f31SMarcel Moolenaar  *
972d44f31SMarcel Moolenaar  * 1. Redistributions of source code must retain the above copyright
1072d44f31SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer.
1172d44f31SMarcel Moolenaar  * 2. Redistributions in binary form must reproduce the above copyright
1272d44f31SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer in the
1372d44f31SMarcel Moolenaar  *    documentation and/or other materials provided with the distribution.
1472d44f31SMarcel Moolenaar  *
1572d44f31SMarcel Moolenaar  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1672d44f31SMarcel Moolenaar  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1772d44f31SMarcel Moolenaar  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1872d44f31SMarcel Moolenaar  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
1972d44f31SMarcel Moolenaar  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2072d44f31SMarcel Moolenaar  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2172d44f31SMarcel Moolenaar  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2272d44f31SMarcel Moolenaar  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2372d44f31SMarcel Moolenaar  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2472d44f31SMarcel Moolenaar  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2572d44f31SMarcel Moolenaar  */
2672d44f31SMarcel Moolenaar 
2772d44f31SMarcel Moolenaar #include <sys/cdefs.h>
2872d44f31SMarcel Moolenaar __FBSDID("$FreeBSD$");
2972d44f31SMarcel Moolenaar 
3072d44f31SMarcel Moolenaar #include <sys/param.h>
3172d44f31SMarcel Moolenaar #include <sys/systm.h>
3272d44f31SMarcel Moolenaar #include <sys/ctype.h>
3372d44f31SMarcel Moolenaar #include <sys/kdb.h>
3472d44f31SMarcel Moolenaar 
3572d44f31SMarcel Moolenaar #include <machine/gdb_machdep.h>
3672d44f31SMarcel Moolenaar 
3772d44f31SMarcel Moolenaar #include <gdb/gdb.h>
3872d44f31SMarcel Moolenaar #include <gdb/gdb_int.h>
3972d44f31SMarcel Moolenaar 
4072d44f31SMarcel Moolenaar static char gdb_rxbuf[GDB_BUFSZ];
4172d44f31SMarcel Moolenaar char *gdb_rxp = NULL;
4272d44f31SMarcel Moolenaar size_t gdb_rxsz = 0;
4372d44f31SMarcel Moolenaar static char gdb_txbuf[GDB_BUFSZ];
4472d44f31SMarcel Moolenaar char *gdb_txp = NULL;			/* Used in inline functions. */
4572d44f31SMarcel Moolenaar 
4672d44f31SMarcel Moolenaar #define	C2N(c)	(((c) < 'A') ? (c) - '0' : \
4772d44f31SMarcel Moolenaar 	    10 + (((c) < 'a') ? (c) - 'A' : (c) - 'a'))
4872d44f31SMarcel Moolenaar #define	N2C(n)	(((n) < 10) ? (n) + '0' : (n) + 'a' - 10)
4972d44f31SMarcel Moolenaar 
5072d44f31SMarcel Moolenaar /*
51f346afc4SPoul-Henning Kamp  * Get a single character
52f346afc4SPoul-Henning Kamp  */
53f346afc4SPoul-Henning Kamp 
54f346afc4SPoul-Henning Kamp static int
55f346afc4SPoul-Henning Kamp gdb_getc(void)
56f346afc4SPoul-Henning Kamp {
57f346afc4SPoul-Henning Kamp 	int c;
58f346afc4SPoul-Henning Kamp 
59f346afc4SPoul-Henning Kamp 	do
60f346afc4SPoul-Henning Kamp 		c = gdb_cur->gdb_getc();
61f346afc4SPoul-Henning Kamp 	while (c == -1);
62f346afc4SPoul-Henning Kamp 	return (c);
63f346afc4SPoul-Henning Kamp }
64f346afc4SPoul-Henning Kamp 
65f346afc4SPoul-Henning Kamp /*
6672d44f31SMarcel Moolenaar  * Functions to receive and extract from a packet.
6772d44f31SMarcel Moolenaar  */
6872d44f31SMarcel Moolenaar 
6972d44f31SMarcel Moolenaar int
7072d44f31SMarcel Moolenaar gdb_rx_begin(void)
7172d44f31SMarcel Moolenaar {
7272d44f31SMarcel Moolenaar 	int c, cksum;
7372d44f31SMarcel Moolenaar 
7472d44f31SMarcel Moolenaar 	gdb_rxp = NULL;
7572d44f31SMarcel Moolenaar 	do {
7672d44f31SMarcel Moolenaar 		/*
7772d44f31SMarcel Moolenaar 		 * Wait for the start character, ignore all others.
7872d44f31SMarcel Moolenaar 		 * XXX needs a timeout.
7972d44f31SMarcel Moolenaar 		 */
80f346afc4SPoul-Henning Kamp 		while ((c = gdb_getc()) != '$')
8172d44f31SMarcel Moolenaar 			;
8272d44f31SMarcel Moolenaar 
8372d44f31SMarcel Moolenaar 		/* Read until a # or end of buffer is found. */
8472d44f31SMarcel Moolenaar 		cksum = 0;
8572d44f31SMarcel Moolenaar 		gdb_rxsz = 0;
8672d44f31SMarcel Moolenaar 		while (gdb_rxsz < sizeof(gdb_rxbuf) - 1) {
87f346afc4SPoul-Henning Kamp 			c = gdb_getc();
8872d44f31SMarcel Moolenaar 			if (c == '#')
8972d44f31SMarcel Moolenaar 				break;
9072d44f31SMarcel Moolenaar 			gdb_rxbuf[gdb_rxsz++] = c;
9172d44f31SMarcel Moolenaar 			cksum += c;
9272d44f31SMarcel Moolenaar 		}
9372d44f31SMarcel Moolenaar 		gdb_rxbuf[gdb_rxsz] = 0;
9472d44f31SMarcel Moolenaar 		cksum &= 0xff;
9572d44f31SMarcel Moolenaar 
9672d44f31SMarcel Moolenaar 		/* Bail out on a buffer overflow. */
9772d44f31SMarcel Moolenaar 		if (c != '#') {
9872d44f31SMarcel Moolenaar 			gdb_cur->gdb_putc('-');
9972d44f31SMarcel Moolenaar 			return (ENOSPC);
10072d44f31SMarcel Moolenaar 		}
10172d44f31SMarcel Moolenaar 
102f346afc4SPoul-Henning Kamp 		c = gdb_getc();
10372d44f31SMarcel Moolenaar 		cksum -= (C2N(c) << 4) & 0xf0;
104f346afc4SPoul-Henning Kamp 		c = gdb_getc();
10572d44f31SMarcel Moolenaar 		cksum -= C2N(c) & 0x0f;
10672d44f31SMarcel Moolenaar 		gdb_cur->gdb_putc((cksum == 0) ? '+' : '-');
10772d44f31SMarcel Moolenaar 		if (cksum != 0)
10872d44f31SMarcel Moolenaar 			printf("GDB: packet `%s' has invalid checksum\n",
10972d44f31SMarcel Moolenaar 			    gdb_rxbuf);
11072d44f31SMarcel Moolenaar 	} while (cksum != 0);
11172d44f31SMarcel Moolenaar 
11272d44f31SMarcel Moolenaar 	gdb_rxp = gdb_rxbuf;
11372d44f31SMarcel Moolenaar 	return (0);
11472d44f31SMarcel Moolenaar }
11572d44f31SMarcel Moolenaar 
11672d44f31SMarcel Moolenaar int
11772d44f31SMarcel Moolenaar gdb_rx_equal(const char *str)
11872d44f31SMarcel Moolenaar {
11972d44f31SMarcel Moolenaar 	int len;
12072d44f31SMarcel Moolenaar 
12172d44f31SMarcel Moolenaar 	len = strlen(str);
12272d44f31SMarcel Moolenaar 	if (len > gdb_rxsz || strncmp(str, gdb_rxp, len) != 0)
12372d44f31SMarcel Moolenaar 		return (0);
12472d44f31SMarcel Moolenaar 	gdb_rxp += len;
12572d44f31SMarcel Moolenaar 	gdb_rxsz -= len;
12672d44f31SMarcel Moolenaar 	return (1);
12772d44f31SMarcel Moolenaar }
12872d44f31SMarcel Moolenaar 
12972d44f31SMarcel Moolenaar int
13072d44f31SMarcel Moolenaar gdb_rx_mem(unsigned char *addr, size_t size)
13172d44f31SMarcel Moolenaar {
13272d44f31SMarcel Moolenaar 	void *prev;
13372d44f31SMarcel Moolenaar 	jmp_buf jb;
13472d44f31SMarcel Moolenaar 	int ret;
13572d44f31SMarcel Moolenaar 	unsigned char c;
13672d44f31SMarcel Moolenaar 
13772d44f31SMarcel Moolenaar 	if (size * 2 != gdb_rxsz)
13872d44f31SMarcel Moolenaar 		return (-1);
13972d44f31SMarcel Moolenaar 
14072d44f31SMarcel Moolenaar 	prev = kdb_jmpbuf(jb);
14172d44f31SMarcel Moolenaar 	ret = setjmp(jb);
14272d44f31SMarcel Moolenaar 	if (ret == 0) {
14372d44f31SMarcel Moolenaar 		while (size-- > 0) {
14472d44f31SMarcel Moolenaar 			c = (C2N(gdb_rxp[0]) << 4) & 0xf0;
14572d44f31SMarcel Moolenaar 			c |= C2N(gdb_rxp[1]) & 0x0f;
14672d44f31SMarcel Moolenaar 			*addr++ = c;
14772d44f31SMarcel Moolenaar 			gdb_rxsz -= 2;
14872d44f31SMarcel Moolenaar 			gdb_rxp += 2;
14972d44f31SMarcel Moolenaar 		}
15072d44f31SMarcel Moolenaar 	}
15172d44f31SMarcel Moolenaar 	(void)kdb_jmpbuf(prev);
15272d44f31SMarcel Moolenaar 	return ((ret == 0) ? 1 : 0);
15372d44f31SMarcel Moolenaar }
15472d44f31SMarcel Moolenaar 
15572d44f31SMarcel Moolenaar int
15672d44f31SMarcel Moolenaar gdb_rx_varhex(uintmax_t *vp)
15772d44f31SMarcel Moolenaar {
15872d44f31SMarcel Moolenaar 	uintmax_t v;
15972d44f31SMarcel Moolenaar 	int c, neg;
16072d44f31SMarcel Moolenaar 
16172d44f31SMarcel Moolenaar 	c = gdb_rx_char();
16272d44f31SMarcel Moolenaar 	neg = (c == '-') ? 1 : 0;
16372d44f31SMarcel Moolenaar 	if (neg == 1)
16472d44f31SMarcel Moolenaar 		c = gdb_rx_char();
16572d44f31SMarcel Moolenaar 	if (!isxdigit(c)) {
16672d44f31SMarcel Moolenaar 		gdb_rxp -= ((c == -1) ? 0 : 1) + neg;
16772d44f31SMarcel Moolenaar 		gdb_rxsz += ((c == -1) ? 0 : 1) + neg;
16872d44f31SMarcel Moolenaar 		return (-1);
16972d44f31SMarcel Moolenaar 	}
17072d44f31SMarcel Moolenaar 	v = 0;
17172d44f31SMarcel Moolenaar 	do {
17272d44f31SMarcel Moolenaar 		v <<= 4;
17372d44f31SMarcel Moolenaar 		v += C2N(c);
17472d44f31SMarcel Moolenaar 		c = gdb_rx_char();
17572d44f31SMarcel Moolenaar 	} while (isxdigit(c));
17672d44f31SMarcel Moolenaar 	if (c != -1) {
17772d44f31SMarcel Moolenaar 		gdb_rxp--;
17872d44f31SMarcel Moolenaar 		gdb_rxsz++;
17972d44f31SMarcel Moolenaar 	}
18072d44f31SMarcel Moolenaar 	*vp = (neg) ? -v : v;
18172d44f31SMarcel Moolenaar 	return (0);
18272d44f31SMarcel Moolenaar }
18372d44f31SMarcel Moolenaar 
18472d44f31SMarcel Moolenaar /*
18572d44f31SMarcel Moolenaar  * Function to build and send a package.
18672d44f31SMarcel Moolenaar  */
18772d44f31SMarcel Moolenaar 
18872d44f31SMarcel Moolenaar void
18972d44f31SMarcel Moolenaar gdb_tx_begin(char tp)
19072d44f31SMarcel Moolenaar {
19172d44f31SMarcel Moolenaar 
19272d44f31SMarcel Moolenaar 	gdb_txp = gdb_txbuf;
19372d44f31SMarcel Moolenaar 	if (tp != '\0')
19472d44f31SMarcel Moolenaar 		gdb_tx_char(tp);
19572d44f31SMarcel Moolenaar }
19672d44f31SMarcel Moolenaar 
19772d44f31SMarcel Moolenaar int
19872d44f31SMarcel Moolenaar gdb_tx_end(void)
19972d44f31SMarcel Moolenaar {
20072d44f31SMarcel Moolenaar 	const char *p;
20172d44f31SMarcel Moolenaar 	int runlen;
20272d44f31SMarcel Moolenaar 	unsigned char c, cksum;
20372d44f31SMarcel Moolenaar 
20472d44f31SMarcel Moolenaar 	do {
20572d44f31SMarcel Moolenaar 		gdb_cur->gdb_putc('$');
20672d44f31SMarcel Moolenaar 
20772d44f31SMarcel Moolenaar 		cksum = 0;
20872d44f31SMarcel Moolenaar 		p = gdb_txbuf;
20972d44f31SMarcel Moolenaar 		while (p < gdb_txp) {
21072d44f31SMarcel Moolenaar 			/* Send a character and start run-length encoding. */
21172d44f31SMarcel Moolenaar 			c = *p++;
21272d44f31SMarcel Moolenaar 			gdb_cur->gdb_putc(c);
21372d44f31SMarcel Moolenaar 			cksum += c;
21472d44f31SMarcel Moolenaar 			runlen = 0;
21572d44f31SMarcel Moolenaar 			/* Determine run-length and update checksum. */
21672d44f31SMarcel Moolenaar 			while (p < gdb_txp && *p == c) {
21772d44f31SMarcel Moolenaar 				runlen++;
21872d44f31SMarcel Moolenaar 				p++;
21972d44f31SMarcel Moolenaar 			}
22072d44f31SMarcel Moolenaar 			/* Emit the run-length encoded string. */
22172d44f31SMarcel Moolenaar 			while (runlen >= 97) {
22272d44f31SMarcel Moolenaar 				gdb_cur->gdb_putc('*');
22372d44f31SMarcel Moolenaar 				cksum += '*';
22472d44f31SMarcel Moolenaar 				gdb_cur->gdb_putc(97+29);
22572d44f31SMarcel Moolenaar 				cksum += 97+29;
22672d44f31SMarcel Moolenaar 				runlen -= 97;
22772d44f31SMarcel Moolenaar 				if (runlen > 0) {
22872d44f31SMarcel Moolenaar 					gdb_cur->gdb_putc(c);
22972d44f31SMarcel Moolenaar 					cksum += c;
23072d44f31SMarcel Moolenaar 					runlen--;
23172d44f31SMarcel Moolenaar 				}
23272d44f31SMarcel Moolenaar 			}
23372d44f31SMarcel Moolenaar 			if (runlen == 1) {
23472d44f31SMarcel Moolenaar 				gdb_cur->gdb_putc(c);
23572d44f31SMarcel Moolenaar 				cksum += c;
23672d44f31SMarcel Moolenaar 				runlen--;
23772d44f31SMarcel Moolenaar 			}
23872d44f31SMarcel Moolenaar 			if (runlen == 0)
23972d44f31SMarcel Moolenaar 				continue;
24072d44f31SMarcel Moolenaar 			/* Don't emit '$', '#', '+' or '-'. */
24172d44f31SMarcel Moolenaar 			if (runlen == 7) {
24272d44f31SMarcel Moolenaar 				gdb_cur->gdb_putc(c);
24372d44f31SMarcel Moolenaar 				cksum += c;
24472d44f31SMarcel Moolenaar 				runlen--;
24572d44f31SMarcel Moolenaar 			}
24672d44f31SMarcel Moolenaar 			if (runlen == 6 || runlen == 14 || runlen == 16) {
24772d44f31SMarcel Moolenaar 				gdb_cur->gdb_putc(c);
24872d44f31SMarcel Moolenaar 				cksum += c;
24972d44f31SMarcel Moolenaar 				runlen--;
25072d44f31SMarcel Moolenaar 			}
25172d44f31SMarcel Moolenaar 			gdb_cur->gdb_putc('*');
25272d44f31SMarcel Moolenaar 			cksum += '*';
25372d44f31SMarcel Moolenaar 			gdb_cur->gdb_putc(runlen+29);
25472d44f31SMarcel Moolenaar 			cksum += runlen+29;
25572d44f31SMarcel Moolenaar 		}
25672d44f31SMarcel Moolenaar 
25772d44f31SMarcel Moolenaar 		gdb_cur->gdb_putc('#');
25872d44f31SMarcel Moolenaar 		c = cksum >> 4;
25972d44f31SMarcel Moolenaar 		gdb_cur->gdb_putc(N2C(c));
26072d44f31SMarcel Moolenaar 		c = cksum & 0x0f;
26172d44f31SMarcel Moolenaar 		gdb_cur->gdb_putc(N2C(c));
26272d44f31SMarcel Moolenaar 
263f346afc4SPoul-Henning Kamp 		c = gdb_getc();
26472d44f31SMarcel Moolenaar 	} while (c != '+');
26572d44f31SMarcel Moolenaar 
26672d44f31SMarcel Moolenaar 	return (0);
26772d44f31SMarcel Moolenaar }
26872d44f31SMarcel Moolenaar 
26972d44f31SMarcel Moolenaar int
27072d44f31SMarcel Moolenaar gdb_tx_mem(const unsigned char *addr, size_t size)
27172d44f31SMarcel Moolenaar {
27272d44f31SMarcel Moolenaar 	void *prev;
27372d44f31SMarcel Moolenaar 	jmp_buf jb;
27472d44f31SMarcel Moolenaar 	int ret;
27572d44f31SMarcel Moolenaar 
27672d44f31SMarcel Moolenaar 	prev = kdb_jmpbuf(jb);
27772d44f31SMarcel Moolenaar 	ret = setjmp(jb);
27872d44f31SMarcel Moolenaar 	if (ret == 0) {
27972d44f31SMarcel Moolenaar 		while (size-- > 0) {
28072d44f31SMarcel Moolenaar 			*gdb_txp++ = N2C(*addr >> 4);
28172d44f31SMarcel Moolenaar 			*gdb_txp++ = N2C(*addr & 0x0f);
28272d44f31SMarcel Moolenaar 			addr++;
28372d44f31SMarcel Moolenaar 		}
28472d44f31SMarcel Moolenaar 	}
28572d44f31SMarcel Moolenaar 	(void)kdb_jmpbuf(prev);
28672d44f31SMarcel Moolenaar 	return ((ret == 0) ? 1 : 0);
28772d44f31SMarcel Moolenaar }
28872d44f31SMarcel Moolenaar 
28972d44f31SMarcel Moolenaar void
29072d44f31SMarcel Moolenaar gdb_tx_reg(int regnum)
29172d44f31SMarcel Moolenaar {
29272d44f31SMarcel Moolenaar 	unsigned char *regp;
29372d44f31SMarcel Moolenaar 	size_t regsz;
29472d44f31SMarcel Moolenaar 
29572d44f31SMarcel Moolenaar 	regp = gdb_cpu_getreg(regnum, &regsz);
29672d44f31SMarcel Moolenaar 	if (regp == NULL) {
29772d44f31SMarcel Moolenaar 		/* Register unavailable. */
29872d44f31SMarcel Moolenaar 		while (regsz--) {
29972d44f31SMarcel Moolenaar 			gdb_tx_char('x');
30072d44f31SMarcel Moolenaar 			gdb_tx_char('x');
30172d44f31SMarcel Moolenaar 		}
30272d44f31SMarcel Moolenaar 	} else
30372d44f31SMarcel Moolenaar 		gdb_tx_mem(regp, regsz);
30472d44f31SMarcel Moolenaar }
305