HID: uclogic: Add support for Ugee Rainbow CV720
[sfrench/cifs-2.6.git] / Documentation / x86 / kernel-stacks
1 Kernel stacks on x86-64 bit
2 ---------------------------
3
4 Most of the text from Keith Owens, hacked by AK
5
6 x86_64 page size (PAGE_SIZE) is 4K.
7
8 Like all other architectures, x86_64 has a kernel stack for every
9 active thread.  These thread stacks are THREAD_SIZE (2*PAGE_SIZE) big.
10 These stacks contain useful data as long as a thread is alive or a
11 zombie. While the thread is in user space the kernel stack is empty
12 except for the thread_info structure at the bottom.
13
14 In addition to the per thread stacks, there are specialized stacks
15 associated with each CPU.  These stacks are only used while the kernel
16 is in control on that CPU; when a CPU returns to user space the
17 specialized stacks contain no useful data.  The main CPU stacks are:
18
19 * Interrupt stack.  IRQ_STACK_SIZE
20
21   Used for external hardware interrupts.  If this is the first external
22   hardware interrupt (i.e. not a nested hardware interrupt) then the
23   kernel switches from the current task to the interrupt stack.  Like
24   the split thread and interrupt stacks on i386, this gives more room
25   for kernel interrupt processing without having to increase the size
26   of every per thread stack.
27
28   The interrupt stack is also used when processing a softirq.
29
30 Switching to the kernel interrupt stack is done by software based on a
31 per CPU interrupt nest counter. This is needed because x86-64 "IST"
32 hardware stacks cannot nest without races.
33
34 x86_64 also has a feature which is not available on i386, the ability
35 to automatically switch to a new stack for designated events such as
36 double fault or NMI, which makes it easier to handle these unusual
37 events on x86_64.  This feature is called the Interrupt Stack Table
38 (IST).  There can be up to 7 IST entries per CPU. The IST code is an
39 index into the Task State Segment (TSS). The IST entries in the TSS
40 point to dedicated stacks; each stack can be a different size.
41
42 An IST is selected by a non-zero value in the IST field of an
43 interrupt-gate descriptor.  When an interrupt occurs and the hardware
44 loads such a descriptor, the hardware automatically sets the new stack
45 pointer based on the IST value, then invokes the interrupt handler.  If
46 the interrupt came from user mode, then the interrupt handler prologue
47 will switch back to the per-thread stack.  If software wants to allow
48 nested IST interrupts then the handler must adjust the IST values on
49 entry to and exit from the interrupt handler.  (This is occasionally
50 done, e.g. for debug exceptions.)
51
52 Events with different IST codes (i.e. with different stacks) can be
53 nested.  For example, a debug interrupt can safely be interrupted by an
54 NMI.  arch/x86_64/kernel/entry.S::paranoidentry adjusts the stack
55 pointers on entry to and exit from all IST events, in theory allowing
56 IST events with the same code to be nested.  However in most cases, the
57 stack size allocated to an IST assumes no nesting for the same code.
58 If that assumption is ever broken then the stacks will become corrupt.
59
60 The currently assigned IST stacks are :-
61
62 * ESTACK_DF.  EXCEPTION_STKSZ (PAGE_SIZE).
63
64   Used for interrupt 8 - Double Fault Exception (#DF).
65
66   Invoked when handling one exception causes another exception. Happens
67   when the kernel is very confused (e.g. kernel stack pointer corrupt).
68   Using a separate stack allows the kernel to recover from it well enough
69   in many cases to still output an oops.
70
71 * ESTACK_NMI.  EXCEPTION_STKSZ (PAGE_SIZE).
72
73   Used for non-maskable interrupts (NMI).
74
75   NMI can be delivered at any time, including when the kernel is in the
76   middle of switching stacks.  Using IST for NMI events avoids making
77   assumptions about the previous state of the kernel stack.
78
79 * ESTACK_DB.  EXCEPTION_STKSZ (PAGE_SIZE).
80
81   Used for hardware debug interrupts (interrupt 1) and for software
82   debug interrupts (INT3).
83
84   When debugging a kernel, debug interrupts (both hardware and
85   software) can occur at any time.  Using IST for these interrupts
86   avoids making assumptions about the previous state of the kernel
87   stack.
88
89   To handle nested #DB correctly there exist two instances of DB stacks. On
90   #DB entry the IST stackpointer for #DB is switched to the second instance
91   so a nested #DB starts from a clean stack. The nested #DB switches
92   the IST stackpointer to a guard hole to catch triple nesting.
93
94 * ESTACK_MCE.  EXCEPTION_STKSZ (PAGE_SIZE).
95
96   Used for interrupt 18 - Machine Check Exception (#MC).
97
98   MCE can be delivered at any time, including when the kernel is in the
99   middle of switching stacks.  Using IST for MCE events avoids making
100   assumptions about the previous state of the kernel stack.
101
102 For more details see the Intel IA32 or AMD AMD64 architecture manuals.
103
104
105 Printing backtraces on x86
106 --------------------------
107
108 The question about the '?' preceding function names in an x86 stacktrace
109 keeps popping up, here's an indepth explanation. It helps if the reader
110 stares at print_context_stack() and the whole machinery in and around
111 arch/x86/kernel/dumpstack.c.
112
113 Adapted from Ingo's mail, Message-ID: <20150521101614.GA10889@gmail.com>:
114
115 We always scan the full kernel stack for return addresses stored on
116 the kernel stack(s) [*], from stack top to stack bottom, and print out
117 anything that 'looks like' a kernel text address.
118
119 If it fits into the frame pointer chain, we print it without a question
120 mark, knowing that it's part of the real backtrace.
121
122 If the address does not fit into our expected frame pointer chain we
123 still print it, but we print a '?'. It can mean two things:
124
125  - either the address is not part of the call chain: it's just stale
126    values on the kernel stack, from earlier function calls. This is
127    the common case.
128
129  - or it is part of the call chain, but the frame pointer was not set
130    up properly within the function, so we don't recognize it.
131
132 This way we will always print out the real call chain (plus a few more
133 entries), regardless of whether the frame pointer was set up correctly
134 or not - but in most cases we'll get the call chain right as well. The
135 entries printed are strictly in stack order, so you can deduce more
136 information from that as well.
137
138 The most important property of this method is that we _never_ lose
139 information: we always strive to print _all_ addresses on the stack(s)
140 that look like kernel text addresses, so if debug information is wrong,
141 we still print out the real call chain as well - just with more question
142 marks than ideal.
143
144 [*] For things like IRQ and IST stacks, we also scan those stacks, in
145     the right order, and try to cross from one stack into another
146     reconstructing the call chain. This works most of the time.