1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2004 Marcel Moolenaar
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $FreeBSD$
29 */
30
31#ifndef _GDB_GDB_INT_H_
32#define	_GDB_GDB_INT_H_
33
34#include "opt_ddb.h"
35
36#include <sys/sysctl.h>
37
38#ifdef DDB
39#include <ddb/ddb.h>
40#endif
41
42#ifndef EOF
43#define EOF	(-1)
44#endif
45
46SYSCTL_DECL(_debug_gdb);
47
48extern struct gdb_dbgport *gdb_cur;
49
50extern int gdb_listening;
51void gdb_consinit(void);
52
53extern char *gdb_rxp;
54extern size_t gdb_rxsz;
55extern char *gdb_txp;
56
57extern bool gdb_ackmode;
58
59#ifdef DDB
60/* If set, return to DDB when controlling GDB detaches. */
61extern bool gdb_return_to_ddb;
62#endif
63
64int gdb_rx_begin(void);
65int gdb_rx_equal(const char *);
66int gdb_rx_mem(unsigned char *, size_t);
67int gdb_rx_varhex(uintmax_t *);
68
69static __inline int
70gdb_rx_char(void)
71{
72	int c;
73
74	if (gdb_rxsz > 0) {
75		c = *gdb_rxp++;
76		gdb_rxsz--;
77	} else
78		c = EOF;
79	return (c);
80}
81
82void gdb_tx_begin(char);
83int gdb_tx_end(void);
84int gdb_tx_mem(const unsigned char *, size_t);
85void gdb_tx_reg(int);
86bool gdb_txbuf_has_capacity(size_t);
87int gdb_rx_bindata(unsigned char *data, size_t datalen, size_t *amt);
88int gdb_search_mem(const unsigned char *addr, size_t size,
89    const unsigned char *pat, size_t patlen, const unsigned char **found);
90
91static __inline void
92gdb_tx_char(char c)
93{
94	*gdb_txp++ = c;
95}
96
97static __inline int
98gdb_tx_empty(void)
99{
100	gdb_tx_begin('\0');
101	return (gdb_tx_end());
102}
103
104static __inline void
105gdb_tx_hex(uintmax_t n, int sz)
106{
107	gdb_txp += sprintf(gdb_txp, "%0*jx", sz, n);
108}
109
110static __inline int
111gdb_tx_err(int err)
112{
113	gdb_tx_begin('E');
114	gdb_tx_hex(err, 2);
115	return (gdb_tx_end());
116}
117
118static __inline int
119gdb_tx_ok(void)
120{
121	gdb_tx_begin('O');
122	gdb_tx_char('K');
123	return (gdb_tx_end());
124}
125
126static __inline void
127gdb_tx_str(const char *s)
128{
129	while (*s)
130		*gdb_txp++ = *s++;
131}
132
133static __inline void
134gdb_tx_varhex(uintmax_t n)
135{
136	gdb_txp += sprintf(gdb_txp, "%jx", n);
137}
138
139static __inline void
140gdb_nack(void)
141{
142	if (gdb_ackmode)
143		gdb_cur->gdb_putc('-');
144}
145
146static __inline void
147gdb_ack(void)
148{
149	if (gdb_ackmode)
150		gdb_cur->gdb_putc('+');
151}
152
153#endif /* !_GDB_GDB_INT_H_ */
154