about summary refs log tree commit diff
path: root/manual
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 /manual
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 'manual')
-rw-r--r--manual/install.texi13
1 files changed, 13 insertions, 0 deletions
diff --git a/manual/install.texi b/manual/install.texi
index 648f366371..8f26bb2a81 100644
--- a/manual/install.texi
+++ b/manual/install.texi
@@ -171,6 +171,19 @@ NOTE: @option{--enable-cet} has been tested for i686, x86_64 and x32
 on non-CET processors.  @option{--enable-cet} has been tested for
 i686, x86_64 and x32 on CET processors.
 
+@item --enable-memory-tagging
+Enable memory tagging support if the architecture supports it.  When
+@theglibc{} 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 @samp{glibc.mem.tagging}.  This includes
+the generation of tagged memory when using the @code{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.
+
 @item --disable-profile
 Don't build libraries with profiling information.  You may want to use
 this option if you don't plan to do profiling.