Merge tag 'riscv/for-v5.3-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/riscv...
[sfrench/cifs-2.6.git] / Documentation / arm64 / tagged-pointers.rst
1 =========================================
2 Tagged virtual addresses in AArch64 Linux
3 =========================================
4
5 Author: Will Deacon <will.deacon@arm.com>
6
7 Date  : 12 June 2013
8
9 This document briefly describes the provision of tagged virtual
10 addresses in the AArch64 translation system and their potential uses
11 in AArch64 Linux.
12
13 The kernel configures the translation tables so that translations made
14 via TTBR0 (i.e. userspace mappings) have the top byte (bits 63:56) of
15 the virtual address ignored by the translation hardware. This frees up
16 this byte for application use.
17
18
19 Passing tagged addresses to the kernel
20 --------------------------------------
21
22 All interpretation of userspace memory addresses by the kernel assumes
23 an address tag of 0x00.
24
25 This includes, but is not limited to, addresses found in:
26
27  - pointer arguments to system calls, including pointers in structures
28    passed to system calls,
29
30  - the stack pointer (sp), e.g. when interpreting it to deliver a
31    signal,
32
33  - the frame pointer (x29) and frame records, e.g. when interpreting
34    them to generate a backtrace or call graph.
35
36 Using non-zero address tags in any of these locations may result in an
37 error code being returned, a (fatal) signal being raised, or other modes
38 of failure.
39
40 For these reasons, passing non-zero address tags to the kernel via
41 system calls is forbidden, and using a non-zero address tag for sp is
42 strongly discouraged.
43
44 Programs maintaining a frame pointer and frame records that use non-zero
45 address tags may suffer impaired or inaccurate debug and profiling
46 visibility.
47
48
49 Preserving tags
50 ---------------
51
52 Non-zero tags are not preserved when delivering signals. This means that
53 signal handlers in applications making use of tags cannot rely on the
54 tag information for user virtual addresses being maintained for fields
55 inside siginfo_t. One exception to this rule is for signals raised in
56 response to watchpoint debug exceptions, where the tag information will
57 be preserved.
58
59 The architecture prevents the use of a tagged PC, so the upper byte will
60 be set to a sign-extension of bit 55 on exception return.
61
62
63 Other considerations
64 --------------------
65
66 Special care should be taken when using tagged pointers, since it is
67 likely that C compilers will not hazard two virtual addresses differing
68 only in the upper byte.