| 1 | /* Low-level RSP routines for GDB, the GNU debugger. |
| 2 | |
| 3 | Copyright (C) 1988-2020 Free Software Foundation, Inc. |
| 4 | |
| 5 | This file is part of GDB. |
| 6 | |
| 7 | This program is free software; you can redistribute it and/or modify |
| 8 | it under the terms of the GNU General Public License as published by |
| 9 | the Free Software Foundation; either version 3 of the License, or |
| 10 | (at your option) any later version. |
| 11 | |
| 12 | This program is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | GNU General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU General Public License |
| 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | #ifndef COMMON_RSP_LOW_H |
| 21 | #define COMMON_RSP_LOW_H |
| 22 | |
| 23 | #include "gdbsupport/byte-vector.h" |
| 24 | |
| 25 | /* Convert hex digit A to a number, or throw an exception. */ |
| 26 | |
| 27 | extern int fromhex (int a); |
| 28 | |
| 29 | /* Convert number NIB to a hex digit. */ |
| 30 | |
| 31 | extern int tohex (int nib); |
| 32 | |
| 33 | /* Write a character representing the low order four bits of NIBBLE in |
| 34 | hex to *BUF. Returns BUF+1. */ |
| 35 | |
| 36 | extern char *pack_nibble (char *buf, int nibble); |
| 37 | |
| 38 | /* Write the low byte of BYTE in hex to *BUF. Returns BUF+2. */ |
| 39 | |
| 40 | extern char *pack_hex_byte (char *pkt, int byte); |
| 41 | |
| 42 | /* Read hex digits from BUFF and convert to a number, which is stored |
| 43 | in RESULT. Reads until a non-hex digit is seen. Returns a pointer |
| 44 | to the terminating character. */ |
| 45 | |
| 46 | extern const char *unpack_varlen_hex (const char *buff, ULONGEST *result); |
| 47 | |
| 48 | /* HEX is a string of characters representing hexadecimal digits. |
| 49 | Convert pairs of hex digits to bytes and store sequentially into |
| 50 | BIN. COUNT is the maximum number of characters to convert. This |
| 51 | will convert fewer characters if the number of hex characters |
| 52 | actually seen is odd, or if HEX terminates before COUNT characters. |
| 53 | Returns the number of characters actually converted. */ |
| 54 | |
| 55 | extern int hex2bin (const char *hex, gdb_byte *bin, int count); |
| 56 | |
| 57 | /* Like the above, but return a gdb::byte_vector. */ |
| 58 | |
| 59 | gdb::byte_vector hex2bin (const char *hex); |
| 60 | |
| 61 | /* Like hex2bin, but return a std::string. */ |
| 62 | |
| 63 | extern std::string hex2str (const char *hex); |
| 64 | |
| 65 | /* Like hex2bin, but return a std::string. */ |
| 66 | |
| 67 | extern std::string hex2str (const char *hex, int count); |
| 68 | |
| 69 | /* Convert some bytes to a hexadecimal representation. BIN holds the |
| 70 | bytes to convert. COUNT says how many bytes to convert. The |
| 71 | resulting characters are stored in HEX, followed by a NUL |
| 72 | character. Returns the number of bytes actually converted. */ |
| 73 | |
| 74 | extern int bin2hex (const gdb_byte *bin, char *hex, int count); |
| 75 | |
| 76 | /* Overloaded version of bin2hex that returns a std::string. */ |
| 77 | |
| 78 | extern std::string bin2hex (const gdb_byte *bin, int count); |
| 79 | |
| 80 | /* Convert BUFFER, binary data at least LEN_UNITS addressable memory units |
| 81 | long, into escaped binary data in OUT_BUF. Only copy memory units that fit |
| 82 | completely in OUT_BUF. Set *OUT_LEN_UNITS to the number of units from |
| 83 | BUFFER successfully encoded in OUT_BUF, and return the number of bytes used |
| 84 | in OUT_BUF. The total number of bytes in the output buffer will be at most |
| 85 | OUT_MAXLEN_BYTES. This function properly escapes '*', and so is suitable |
| 86 | for the server side as well as the client. */ |
| 87 | |
| 88 | extern int remote_escape_output (const gdb_byte *buffer, int len_units, |
| 89 | int unit_size, gdb_byte *out_buf, |
| 90 | int *out_len_units, int out_maxlen_bytes); |
| 91 | |
| 92 | /* Convert BUFFER, escaped data LEN bytes long, into binary data |
| 93 | in OUT_BUF. Return the number of bytes written to OUT_BUF. |
| 94 | Raise an error if the total number of bytes exceeds OUT_MAXLEN. |
| 95 | |
| 96 | This function reverses remote_escape_output. */ |
| 97 | |
| 98 | extern int remote_unescape_input (const gdb_byte *buffer, int len, |
| 99 | gdb_byte *out_buf, int out_maxlen); |
| 100 | |
| 101 | #endif /* COMMON_RSP_LOW_H */ |