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