Add ARM example stack to Stackwalker manual
[dyninst.git] / stackwalk / doc / fig / layout-armv8.tex
1 \begin{figure}
2 \centering
3 \tikzstyle{class} = [rectangle, draw, minimum width=4cm, minimum height=1.5em,
4 font=\ttfamily, node distance=1.5em]
5 \tikzstyle{top} = [rectangle, minimum width=4cm, draw, minimum height=1.5em,
6 fill=white, draw=white]
7 \tikzstyle{annotate} = [rectangle]
8 \tikzstyle{code} = [rectangle, font=\ttfamily]
9 \tikzstyle{line} = [draw, -latex']
10 \begin{tikzpicture}[
11         every text node part/.style={align=left}
12     ]
13
14     % Label
15     \node [annotate] (callstack) {\textbf{Call Stack}};
16
17     % The callstack
18     \node [top, below of=callstack] (dots) {...};
19     \node [class, below of=dots] (a) {a};
20     \node [class, below of=a] (b) {b};
21     \node [class, below of=b] (mainRA) {X's RA(0x400000c)};
22 \node [class, below of=mainRA] (mainFP) {X's FP};
23     \node [class, below of=mainFP] (c) {c};
24     \node [class, below of=c] (fooRA) {main's RA(0x400010c)};
25     \node [class, below of=fooRA] (fooFP) {main's FP};
26     \node [class, below of=fooFP] (d) {d};
27     \node [class, below of=d] (barRA) {foo's RA(0x400020c)};
28     \node [class, below of=barRA] (barFP) {foo's FP};
29
30     % Registers
31     \node [annotate, below=1cm of barFP] (registers) {Registers};
32     \node [class, below of=registers] (FramePointer) {Frame Pointer};
33     \node [class, below of=FramePointer] (StackPointer) {StackPointer};
34     \node [class, below of=StackPointer] (ProgramCounter) {Program Counter};
35
36     % Left labels
37     \node [code, left=7.5cm of dots,anchor=north] (main) {
38         0x4000100\hspace{0.5cm}void main() \{\\
39         0x4000104\hspace{1cm}int a;\\
40         0x4000108\hspace{1cm}foo(0);\\
41         0x400010c\hspace{1cm}...\\
42         \hspace{2.2cm}\}
43     };
44
45     \node [code, above=2.5cm of main.west, anchor=west](callmain){
46         0x4000000\hspace{0.5cm}\_\_X:\\
47         0x400000x\hspace{1cm}...\\
48         0x4000008\hspace{1cm}jmp main\\
49         0x400000c\hspace{1cm}...\\
50     };
51
52     \node [code, above=1.5cm of callmain.west, anchor=west](codeTitle){
53         pseudo line number\\and code\\
54     };
55     
56     \node [code, below=3cm of main.west,anchor=west] (foo) {
57         0x4000200\hspace{0.5cm}void foo(int b) \{\\
58         0x4000204\hspace{1cm}int c;\\
59         0x4000208\hspace{1cm}bar();\\
60         0x400020c\hspace{1cm}...\\
61         \hspace{2.2cm}\}
62     };
63
64     \node [code, below=3cm of foo.west,anchor=west] (bar) {
65         0x4000300\hspace{0.5cm}void bar() \{\\
66         0x4000304\hspace{1cm}int d;\\
67         0x4000308\hspace{1cm}while(1);\\
68         \hspace{2.2cm}\}
69     };
70
71     % Callstack->callstack labels
72     \path [line] (mainFP.east) [bend right=20] to (dots.east);
73     \path [line] (fooFP.east) [bend right=40] to (mainFP.east);
74     \path [line] (barFP.east) [bend right=40] to (fooFP.east);
75     \path [line] (FramePointer.east) [bend right=40] to (barFP.east);
76     \path [line] (StackPointer.east) [bend right=40] to (barFP.east);
77
78     % Right labels
79     \node [code, left=2.5cm of dots,anchor=south] (mainFO) {main\textnormal{'s}\\ Frame Object};
80     \node [code, below=.25em of mainFO] (mainFPlabel) {FP};
81     \path [line] (mainFPlabel) -- (mainFP.west);
82     \node [code, below=.25em of mainFPlabel] (mainSPlabel) {SP};
83     \path [line] (mainSPlabel) -- (mainFP.west);
84     \node [code, below=.25em of mainSPlabel] (mainRAlabel) {RA};
85     \path [line, dashed] (mainRAlabel) -- (fooRA.west);
86
87     \node [code, below=2cm of mainFO] (fooFO) {foo\textnormal{'s}\\ Frame Object};
88     \node [code, below=.25em of fooFO] (fooFPlabel) {FP};
89     \path [line] (fooFPlabel) -- (fooFP.west);
90     \node [code, below=.25em of fooFPlabel] (fooSPlabel) {SP};
91     \path [line] (fooSPlabel) -- (fooFP.west);
92     \node [code, below=.25em of fooSPlabel] (fooRAlabel) {RA};
93     \path [line, dashed] (fooRAlabel) -- (barRA.west);
94
95     \node [code, below=2cm of fooFO] (barFO) {bar\textnormal{'s}\\ Frame Object};
96     \node [code, below=.25em of barFO] (barFPlabel) {FP};
97     \path [line, dashed] (barFPlabel) -- (FramePointer.west);
98     \path [line] (barFPlabel) -- (barFP.west);
99     \node [code, below=.25em of barFPlabel] (barSPlabel) {SP};
100     \path [line, dashed] (barSPlabel) -- (StackPointer.west);
101     \path [line] (barSPlabel) -- (barFP.west);
102     \node [code, below=.25em of barSPlabel] (barRAlabel) {RA};
103     \path [line, dashed] (barRAlabel) -- (ProgramCounter.west);
104
105     % Callstack->source code labels
106     \path [line] (mainRAlabel.west) -- ($(main.south east) + (-.75cm, 2em)$);
107     \path [line] (fooRAlabel.west) -- ($(foo.south east) + (-1.5cm, 2em)$);
108     \path [line] (barRAlabel.west) -- ($(bar.south east) + (0, 2em)$);
109
110
111 \end{tikzpicture}
112
113 \begin{tikzpicture}[]
114     % Legend
115     \node [annotate] (la1) {A};
116     \node [annotate, right of=la1] (lb1) {B};
117     \path [line] (la1) -- (lb1);
118     \node [annotate, right=1cm of lb1] (l1) {A contains B's address};
119     
120     \node [annotate, below=.5cm of la1] (la2) {A};
121     \node [annotate, right of=la2] (lb2) {B};
122     \path [line, dashed] (la2) -- (lb2);
123     \node [annotate, right=1cm of lb2] (l2) {A contains the contents of B};
124
125     % Legend Box
126     \node [rectangle, draw, fit=(la1)(lb1)(l1)(la2)(lb2)(l2)] (legendBox) {};
127     \node [rectangle, label=left: \rotatebox{90}{LEGEND},fit=(legendBox)] {};
128 \end{tikzpicture}
129
130 \caption{Stack Frame and Frame Object Layout (ARMv8 Architecture)}
131 \label{fig:layout-armv8}
132
133 \end{figure}
134
135