gdb/extract-store-integer.h

   1 /* Copyright (C) 1986-2024 Free Software Foundation, Inc.
   2
   3    This file is part of GDB.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef GDB_EXTRACT_STORE_INTEGER_H
  19 #define GDB_EXTRACT_STORE_INTEGER_H
  20
  21 #include <type_traits>
  22
  23 template<typename T, typename = std::is_integral<T>>
  24 T extract_integer (gdb::array_view<const gdb_byte>, enum bfd_endian byte_order);
  25
  26 static inline LONGEST
  27 extract_signed_integer (gdb::array_view<const gdb_byte> buf,
  28                         enum bfd_endian byte_order)
  29 {
  30   return extract_integer<LONGEST> (buf, byte_order);
  31 }
  32
  33 static inline LONGEST
  34 extract_signed_integer (const gdb_byte *addr, int len,
  35                         enum bfd_endian byte_order)
  36 {
  37   return extract_signed_integer (gdb::array_view<const gdb_byte> (addr, len),
  38                                  byte_order);
  39 }
  40
  41 static inline ULONGEST
  42 extract_unsigned_integer (gdb::array_view<const gdb_byte> buf,
  43                           enum bfd_endian byte_order)
  44 {
  45   return extract_integer<ULONGEST> (buf, byte_order);
  46 }
  47
  48 static inline ULONGEST
  49 extract_unsigned_integer (const gdb_byte *addr, int len,
  50                           enum bfd_endian byte_order)
  51 {
  52   return extract_unsigned_integer (gdb::array_view<const gdb_byte> (addr, len),
  53                                    byte_order);
  54 }
  55
  56 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
  57                                         struct type *type);
  58
  59 /* All 'store' functions accept a host-format integer and store a
  60    target-format integer at ADDR which is LEN bytes long.  */
  61
  62 template<typename T, typename = RequireLongest<T>>
  63 extern void store_integer (gdb::array_view<gdb_byte> dst,
  64                            bfd_endian byte_order, T val);
  65
  66 template<typename T>
  67 static inline void
  68 store_integer (gdb_byte *addr, int len, bfd_endian byte_order, T val)
  69 {
  70   return store_integer (gdb::make_array_view (addr, len), byte_order, val);
  71 }
  72
  73 static inline void
  74 store_signed_integer (gdb::array_view<gdb_byte> dst, bfd_endian byte_order,
  75                       LONGEST val)
  76 {
  77   return store_integer (dst, byte_order, val);
  78 }
  79
  80 static inline void
  81 store_signed_integer (gdb_byte *addr, int len, bfd_endian byte_order,
  82                       LONGEST val)
  83 {
  84   return store_signed_integer (gdb::make_array_view (addr, len), byte_order,
  85                                val);
  86 }
  87
  88 static inline void
  89 store_unsigned_integer (gdb::array_view<gdb_byte> dst, bfd_endian byte_order,
  90                         ULONGEST val)
  91 {
  92   return store_integer (dst, byte_order, val);
  93 }
  94
  95 static inline void
  96 store_unsigned_integer (gdb_byte *addr, int len, bfd_endian byte_order,
  97                         ULONGEST val)
  98 {
  99   return store_unsigned_integer (gdb::make_array_view (addr, len), byte_order,
 100                                  val);
 101 }
 102
 103 extern void store_typed_address (gdb_byte *buf, struct type *type,
 104                                  CORE_ADDR addr);
 105
 106 extern void copy_integer_to_size (gdb_byte *dest, int dest_size,
 107                                   const gdb_byte *source, int source_size,
 108                                   bool is_signed, enum bfd_endian byte_order);
 109
 110 #endif /* GDB_EXTRACT_STORE_INTEGER_H */