xref: /freebsd/sys/gdb/gdb_int.h (revision 7b01d357a29d6aa0dcafb04a9a370332e33eaae1)
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 <sys/sysctl.h>
35 
36 #ifndef EOF
37 #define EOF	(-1)
38 #endif
39 
40 SYSCTL_DECL(_debug_gdb);
41 
42 extern struct gdb_dbgport *gdb_cur;
43 
44 extern int gdb_listening;
45 void gdb_consinit(void);
46 
47 extern char *gdb_rxp;
48 extern size_t gdb_rxsz;
49 extern char *gdb_txp;
50 
51 int gdb_rx_begin(void);
52 int gdb_rx_equal(const char *);
53 int gdb_rx_mem(unsigned char *, size_t);
54 int gdb_rx_varhex(uintmax_t *);
55 
56 static __inline int
57 gdb_rx_char(void)
58 {
59 	int c;
60 
61 	if (gdb_rxsz > 0) {
62 		c = *gdb_rxp++;
63 		gdb_rxsz--;
64 	} else
65 		c = EOF;
66 	return (c);
67 }
68 
69 void gdb_tx_begin(char);
70 int gdb_tx_end(void);
71 int gdb_tx_mem(const unsigned char *, size_t);
72 void gdb_tx_reg(int);
73 bool gdb_txbuf_has_capacity(size_t);
74 int gdb_rx_bindata(unsigned char *data, size_t datalen, size_t *amt);
75 int gdb_search_mem(const unsigned char *addr, size_t size,
76     const unsigned char *pat, size_t patlen, const unsigned char **found);
77 
78 static __inline void
79 gdb_tx_char(char c)
80 {
81 	*gdb_txp++ = c;
82 }
83 
84 static __inline int
85 gdb_tx_empty(void)
86 {
87 	gdb_tx_begin('\0');
88 	return (gdb_tx_end());
89 }
90 
91 static __inline void
92 gdb_tx_hex(uintmax_t n, int sz)
93 {
94 	gdb_txp += sprintf(gdb_txp, "%0*jx", sz, n);
95 }
96 
97 static __inline int
98 gdb_tx_err(int err)
99 {
100 	gdb_tx_begin('E');
101 	gdb_tx_hex(err, 2);
102 	return (gdb_tx_end());
103 }
104 
105 static __inline int
106 gdb_tx_ok(void)
107 {
108 	gdb_tx_begin('O');
109 	gdb_tx_char('K');
110 	return (gdb_tx_end());
111 }
112 
113 static __inline void
114 gdb_tx_str(const char *s)
115 {
116 	while (*s)
117 		*gdb_txp++ = *s++;
118 }
119 
120 static __inline void
121 gdb_tx_varhex(uintmax_t n)
122 {
123 	gdb_txp += sprintf(gdb_txp, "%jx", n);
124 }
125 
126 #endif /* !_GDB_GDB_INT_H_ */
127