gdb/arch/aarch64-mte-linux.h

   1 /* Common Linux target-dependent definitions for AArch64 MTE
   2
   3    Copyright (C) 2021-2023 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 ARCH_AARCH64_MTE_LINUX_H
  21 #define ARCH_AARCH64_MTE_LINUX_H
  22
  23 #include "gdbsupport/common-defs.h"
  24
  25 /* Feature check for Memory Tagging Extension.  */
  26 #ifndef HWCAP2_MTE
  27 #define HWCAP2_MTE  (1 << 18)
  28 #endif
  29
  30 /* The MTE regset consists of a single 64-bit register.  */
  31 #define AARCH64_LINUX_SIZEOF_MTE 8
  32
  33 /* We have one tag per 16 bytes of memory.  */
  34 #define AARCH64_MTE_GRANULE_SIZE 16
  35 #define AARCH64_MTE_TAG_BIT_SIZE 4
  36 #define AARCH64_MTE_LOGICAL_TAG_START_BIT 56
  37 #define AARCH64_MTE_LOGICAL_MAX_VALUE 0xf
  38
  39 /* Memory tagging definitions.  */
  40 #ifndef SEGV_MTEAERR
  41 # define SEGV_MTEAERR 8
  42 # define SEGV_MTESERR 9
  43 #endif
  44
  45 /* Memory tag types for AArch64.  */
  46 enum class aarch64_memtag_type
  47 {
  48   /* MTE logical tag contained in pointers.  */
  49   mte_logical = 0,
  50   /* MTE allocation tag stored in memory tag granules.  */
  51   mte_allocation
  52 };
  53
  54 /* Return the number of tag granules in the memory range
  55    [ADDR, ADDR + LEN) given GRANULE_SIZE.  */
  56 extern size_t aarch64_mte_get_tag_granules (CORE_ADDR addr, size_t len,
  57                                             size_t granule_size);
  58
  59 /* Return the 4-bit tag made from VALUE.  */
  60 extern CORE_ADDR aarch64_mte_make_ltag_bits (CORE_ADDR value);
  61
  62 /* Return the 4-bit tag that can be OR-ed to an address.  */
  63 extern CORE_ADDR aarch64_mte_make_ltag (CORE_ADDR value);
  64
  65 /* Helper to set the logical TAG for a 64-bit ADDRESS.
  66
  67    It is always possible to set the logical tag.  */
  68 extern CORE_ADDR aarch64_mte_set_ltag (CORE_ADDR address, CORE_ADDR tag);
  69
  70 /* Helper to get the logical tag from a 64-bit ADDRESS.
  71
  72    It is always possible to get the logical tag.  */
  73 extern CORE_ADDR aarch64_mte_get_ltag (CORE_ADDR address);
  74
  75 /* Given a TAGS vector containing 1 MTE tag per byte, pack the data as
  76    2 tags per byte and resize the vector.  */
  77 extern void aarch64_mte_pack_tags (gdb::byte_vector &tags);
  78
  79 /* Given a TAGS vector containing 2 MTE tags per byte, unpack the data as
  80    1 tag per byte and resize the vector.  If SKIP_FIRST is TRUE, skip the
  81    first unpacked element.  Otherwise leave it in the unpacked vector.  */
  82 extern void aarch64_mte_unpack_tags (gdb::byte_vector &tags, bool skip_first);
  83
  84 #endif /* ARCH_AARCH64_MTE_LINUX_H */