about summary refs log tree commit diff
path: root/INSTALL
diff options
context:
space:
mode:
authorRichard Earnshaw <Richard.Earnshaw@arm.com>2020-12-21 15:03:03 +0000
committerRichard Earnshaw <rearnsha@arm.com>2020-12-21 15:25:25 +0000
commit3378408987189772eec7bc62fc9923a6f01dc63c (patch)
tree91852b072e2b766bfc63ab738424c70d3ee92d3d /INSTALL
parentd552058570ea2c00fb88b4621be3285cda03033f (diff)
downloadglibc-3378408987189772eec7bc62fc9923a6f01dc63c.tar.gz
glibc-3378408987189772eec7bc62fc9923a6f01dc63c.tar.xz
glibc-3378408987189772eec7bc62fc9923a6f01dc63c.zip
config: Allow memory tagging to be enabled when configuring glibc
This patch adds the configuration machinery to allow memory tagging to be
enabled from the command line via the configure option --enable-memory-tagging.

The current default is off, though in time we may change that once the API
is more stable.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL14
1 files changed, 14 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
index accdc39821..de75e72760 100644
--- a/INSTALL
+++ b/INSTALL
@@ -142,6 +142,20 @@ if 'CFLAGS' is specified it must enable optimization.  For example:
      non-CET processors.  '--enable-cet' has been tested for i686,
      x86_64 and x32 on CET processors.
 
+'--enable-memory-tagging'
+     Enable memory tagging support if the architecture supports it.
+     When the GNU C Library is built with this option then the resulting
+     library will be able to control the use of tagged memory when
+     hardware support is present by use of the tunable
+     'glibc.mem.tagging'.  This includes the generation of tagged memory
+     when using the 'malloc' APIs.
+
+     At present only AArch64 platforms with MTE provide this
+     functionality, although the library will still operate (without
+     memory tagging) on older versions of the architecture.
+
+     The default is to disable support for memory tagging.
+
 '--disable-profile'
      Don't build libraries with profiling information.  You may want to
      use this option if you don't plan to do profiling.