Add ARM example stack to Stackwalker manual
[dyninst.git] / stackwalk / doc / fig / layout.tex
1 \begin{figure}
2 \centering
3 \tikzstyle{class} = [rectangle, draw, minimum width=3cm, minimum height=1.5em,
4 font=\ttfamily, node distance=1.5em]
5 \tikzstyle{top} = [rectangle, minimum width=3cm, 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) {main's RA};
22     \node [class, below of=mainRA] (mainFP) {main's FP};
23     \node [class, below of=mainFP] (c) {C};
24     \node [class, below of=c] (fooRA) {foo's RA};
25     \node [class, below of=fooRA] (fooFP) {foo's FP};
26     \node [class, below of=fooFP] (d) {d};
27
28     % Registers
29     \node [annotate, below=1cm of d] (registers) {Registers};
30     \node [class, below of=registers] (FramePointer) {Frame Pointer};
31     \node [class, below of=FramePointer] (ProgramCounter) {Program Counter};
32     \node [class, below of=ProgramCounter] (StackPointer) {StackPointer};
33
34     % Left labels
35     \node [code, left=6cm of dots,anchor=north] (main) {void main() \{\\
36         \hspace{1cm}int a;\\
37         \hspace{1cm}foo(0);\\
38         \hspace{1cm}...\\
39         \}
40     };
41     
42     \node [code, below=3cm of main.west,anchor=west] (foo) {void foo(int b) \{\\
43         \hspace{1cm}int c;\\
44         \hspace{1cm}bar();\\
45         \hspace{1cm}...\\
46         \}
47     };
48
49     \node [code, below=3cm of foo.west,anchor=west] (bar) {void bar() \{\\
50         \hspace{1cm}int d;\\
51         \hspace{1cm}while(1);\\
52     \}
53     };
54
55     % Callstack->callstack labels
56     \path [line] (mainFP.east) [bend right=20] to (dots.east);
57     \path [line] (fooFP.east) [bend right=40] to (mainFP.east);
58     \path [line] (FramePointer.east) [bend right=40] to (fooFP.east);
59     \path [line] (StackPointer.east) [bend right=40] to (d.east);
60
61     % Right labels
62     \node [code, left=2.5cm of dots,anchor=south] (mainFO) {main\textnormal{'s}\\ Frame Object};
63     \node [code, below=.25em of mainFO] (mainFPlabel) {FP};
64     \path [line] (mainFPlabel) -- (a.west);
65     \node [code, below=.25em of mainFPlabel] (mainRAlabel) {RA};
66     \path [line, dashed] (mainRAlabel) -- (mainRA.west);
67     \node [code, below=.25em of mainRAlabel] (mainSPlabel) {SP};
68     \path [line] (mainSPlabel) -- (mainFP.west);
69
70     \node [code, below=2.5cm of mainFO] (fooFO) {foo\textnormal{'s}\\ Frame Object};
71     \node [code, below=.25em of fooFO] (fooFPlabel) {FP};
72     \path [line] (fooFPlabel) -- (c.west);
73     \node [code, below=.25em of fooFPlabel] (fooRAlabel) {RA};
74     \path [line, dashed] (fooRAlabel) -- (fooRA.west);
75     \node [code, below=.25em of fooRAlabel] (fooSPlabel) {SP};
76     \path [line] (fooSPlabel) -- (fooFP.west);
77
78     \node [code, below=2.5cm of fooFO] (barFO) {bar\textnormal{'s}\\ Frame Object};
79     \node [code, below=.25em of barFO] (barFPlabel) {FP};
80     \path [line, dashed] (barFPlabel) -- (FramePointer.west);
81     \node [code, below=.25em of barFPlabel] (barRAlabel) {RA};
82     \path [line, dashed] (barRAlabel) -- (ProgramCounter.west);
83     \node [code, below=.25em of barRAlabel] (barSPlabel) {SP};
84     \path [line, dashed] (barSPlabel) -- (StackPointer.west);
85
86     % Callstack->source code labels
87     \path [line] (mainRAlabel.west) -- ($(main.south east) + (-.75cm, 2em)$);
88     \path [line] (fooRAlabel.west) -- ($(foo.south east) + (-1.5cm, 2em)$);
89     \path [line] (barRAlabel.west) -- ($(bar.south east) + (0, 2em)$);
90
91
92 \end{tikzpicture}
93
94 \begin{tikzpicture}[]
95     % Legend
96     \node [annotate] (la1) {A};
97     \node [annotate, right of=la1] (lb1) {B};
98     \path [line] (la1) -- (lb1);
99     \node [annotate, right=1cm of lb1] (l1) {A contains B's address};
100     
101     \node [annotate, below=.5cm of la1] (la2) {A};
102     \node [annotate, right of=la2] (lb2) {B};
103     \path [line, dashed] (la2) -- (lb2);
104     \node [annotate, right=1cm of lb2] (l2) {A contains the contents of B};
105
106     % Legend Box
107     \node [rectangle, draw, fit=(la1)(lb1)(l1)(la2)(lb2)(l2)] (legendBox) {};
108     \node [rectangle, label=left: \rotatebox{90}{LEGEND},fit=(legendBox)] {};
109 \end{tikzpicture}
110
111 \caption{Stack Frame and Frame Object Layout (x86 Architecture)}
112 \label{fig:layout}
113
114 \end{figure}
115
116