1 /* Low-level RSP routines for GDB, the GNU debugger. 2 3 Copyright (C) 1988-2024 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 /* Convert number NIB to a hex digit. */ 24 25 extern int tohex (int nib); 26 27 /* Write a character representing the low order four bits of NIBBLE in 28 hex to *BUF. Returns BUF+1. */ 29 30 extern char *pack_nibble (char *buf, int nibble); 31 32 /* Write the low byte of BYTE in hex to *BUF. Returns BUF+2. */ 33 34 extern char *pack_hex_byte (char *pkt, int byte); 35 36 /* Read hex digits from BUFF and convert to a number, which is stored 37 in RESULT. Reads until a non-hex digit is seen. Returns a pointer 38 to the terminating character. */ 39 40 extern const char *unpack_varlen_hex (const char *buff, ULONGEST *result); 41 42 /* Like hex2bin, but return a std::string. */ 43 44 extern std::string hex2str (const char *hex); 45 46 /* Like hex2bin, but return a std::string. */ 47 48 extern std::string hex2str (const char *hex, int count); 49 50 /* Convert some bytes to a hexadecimal representation. BIN holds the 51 bytes to convert. COUNT says how many bytes to convert. The 52 resulting characters are stored in HEX, followed by a NUL 53 character. Returns the number of bytes actually converted. */ 54 55 extern int bin2hex (const gdb_byte *bin, char *hex, int count); 56 57 extern int bin2hex (gdb::array_view<gdb_byte> bin, char *hex); 58 59 /* Overloaded version of bin2hex that returns a std::string. */ 60 61 extern std::string bin2hex (const gdb_byte *bin, int count); 62 63 /* Convert BUFFER, binary data at least LEN_UNITS addressable memory units 64 long, into escaped binary data in OUT_BUF. Only copy memory units that fit 65 completely in OUT_BUF. Set *OUT_LEN_UNITS to the number of units from 66 BUFFER successfully encoded in OUT_BUF, and return the number of bytes used 67 in OUT_BUF. The total number of bytes in the output buffer will be at most 68 OUT_MAXLEN_BYTES. This function properly escapes '*', and so is suitable 69 for the server side as well as the client. */ 70 71 extern int remote_escape_output (const gdb_byte *buffer, int len_units, 72 int unit_size, gdb_byte *out_buf, 73 int *out_len_units, int out_maxlen_bytes); 74 75 /* Convert BUFFER, escaped data LEN bytes long, into binary data 76 in OUT_BUF. Return the number of bytes written to OUT_BUF. 77 Raise an error if the total number of bytes exceeds OUT_MAXLEN. 78 79 This function reverses remote_escape_output. */ 80 81 extern int remote_unescape_input (const gdb_byte *buffer, int len, 82 gdb_byte *out_buf, int out_maxlen); 83 84 #endif /* COMMON_RSP_LOW_H */ 85