gdb/common/rsp-low.h

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