1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY tdecachegrind '<application>KCachegrind</application>'>
<!ENTITY cachegrind "<application>Cachegrind</application>">
<!ENTITY valgrind "<application>Valgrind</application>">
<!ENTITY kappname "&tdecachegrind;">
<!ENTITY package "tdesdk">
<!ENTITY % addindex "IGNORE">
<!ENTITY % German "INCLUDE">
]>
<!-- ................................................................ -->
<book lang="&language;">
<bookinfo>
<title>Das &tdecachegrind; Handbuch</title>
<authorgroup>
<author><firstname>Josef</firstname> <surname>Weidendorfer</surname> <affiliation> <address><email>Josef.Weidendorfer@gmx.de</email></address>
</affiliation>
</author>
</authorgroup>
<copyright>
<year>2002</year>
<holder>Josef Weidendorfer</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2003-09-18</date>
<releaseinfo>0.4.3</releaseinfo>
<abstract>
<para>&tdecachegrind; ist eine &kde; Oberfläche für &cachegrind;, ein Teil von&valgrind;. </para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>tdesdk</keyword>
<keyword>Cachegrind</keyword>
<keyword>Valgrind</keyword>
<keyword>Profiling</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Einleitung</title>
<para>Wenn man ein Programm entwickelt, dann ist einer der letzten Schritte es so schnell wie möglich (aber immer noch korrekt!) zu machen. Man will keine Zeit mit der Optimierung selten genutzter Funktionen verschwenden. Deshalb muss man wissen, in welchen Programmteilen dies meiste Zeit verbracht wird. </para>
<para>Diesen Vorgang nennt man Profiling. Das Programm wird dabei unter Kontrolle eines Profiling Werkzeuges ausgeführt, das ein Ablaufprotokoll erstellt. Nach der Auswertung des Ablaufprotokolls sollte man wissen, wo man optimieren muss. Man prüft den Optimierungserfolg mit einem weiteren Profiling Durchgang. </para>
<para>Sehr bekannt ist das GCC Profiling Werkzeug <application>gprof</application>: Dazu muss man das Programm mit der Option <option>-pg</option> kompilieren. Während der Ausführung erstellt das Programm eine Datei <filename>gmon.out</filename>, die mittels <command>gprof</command> in ein von Menschen lesbares Format umgewandelt werden kann. Der Nachteil dieser Methode ist, dass eine extra Kompilierung zur Erzeugung der vorbereiteten und statisch gelinkten ausführbaren Datei nötig ist. </para>
<para>Ein weiteres Profiling Werkzeug ist &cachegrind;, ein Teil von &valgrind;. Es benutzt die Prozessor Emulation von &valgrind; um die Datei auszuführen und protokolliert alle Speicherzugriffe im Ablaufprotokoll. Das Programm muss nicht neukompiliert werden. Man kann Shared Libraries und Plugins nutzen. Weiterhin hat der Profiling Vorgang keinen Einfluß auf das als Ergebnis des Profiling Vorgang entstehende Ablaufprotokoll. Das Ablaufprotokoll enthält die Anzahl von Instruktionen sowie Speicherzugriffe und die First/Second Level Cache Misses. Es findet eine Zuordnung auf die entsprechenden Quelltextzeilen und Funktionen des ausgeführten Programmes statt. Ein Nachteil ist die Verlangsamung um den Faktor 50 durch die Prozessor Emulation. </para>
<para>Ein Patch für die &valgrind; 1.0.x Quellen fügt die Protokollierung der Aufruffolge hinzu, z.B. welche Funktion welche aufgerufen hat und wieviel Ereignisse während der Abarbeitung einer Funktion auftreten. </para>
<para>&tdecachegrind; ist ein Darstellungswerkzeug für das mit &cachegrind; erzeugte Ablaufprotokoll. Man sollte unbedingt die Unterstützung für die Aufruffolge in &cachegrind; hinzufügen, denn &tdecachegrind; ist so wesentlich nützlicher. </para>
</chapter>
<chapter id="using-tdecachegrind">
<title>Nutzung von &tdecachegrind;</title>
<note>
<para>Jedes Bildschirmelement in &tdecachegrind; verfügt über eine <quote>Was ist das?</quote> Hilfe. Möchte man nicht in dieser Dokumentation nachlesen, sollte man diese benutzen! </para>
</note>
<sect1>
<title>Beispiel zum Schnelleinstieg</title>
<para>Einfach ausführen!</para>
</sect1>
<sect1 id="features">
<title>Funktionen von &tdecachegrind;</title>
<para>Unterstützung von: beliebige Ereignisse, Gruppierung von Funktionen</para>
</sect1>
<sect1 id="guidelines">
<title>Allgemeine Richtlinien</title>
<para>Effektives Profiling...</para>
</sect1>
<sect1 id="tutorial">
<title>Tutorial</title>
<para>Eine Profiling Sitzung mit &tdecachegrind;</para>
</sect1>
</chapter>
<chapter id="commands">
<title>Kommando Referenz</title>
<sect1 id="tdecachegrind-mainwindow">
<title>Hauptfenster &tdecachegrind;</title>
<para></para>
<sect2>
<title>Das <guimenu>Datei</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice><shortcut> <keycombo>&Ctrl;<keycap>N</keycap></keycombo> </shortcut> <guimenu>Datei</guimenu> <guimenuitem>Neu</guimenuitem> </menuchoice></term>
<listitem><para><action>Erstellt ein neues Dokument</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut> <keycombo>&Ctrl;<keycap>S</keycap></keycombo> </shortcut> <guimenu>Datei</guimenu> <guimenuitem>Speichern</guimenuitem> </menuchoice></term>
<listitem><para><action>Speichert das Dokument</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut> <keycombo>&Ctrl;<keycap>Q</keycap></keycombo> </shortcut> <guimenu>Datei</guimenu> <guimenuitem>Beenden</guimenuitem> </menuchoice></term>
<listitem><para><action>Beendet</action> &tdecachegrind;</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
</sect1>
</chapter>
<chapter id="faq">
<title>Fragen und Antworten</title>
&reporting.bugs; &updating.documentation; <qandaset id="faqlist">
<qandaentry>
<question>
<para>&tdecachegrind; sieht toll aus. Aber ich verstehe es nicht. Wozu ist es nützlich?</para>
</question>
<answer>
<para>&tdecachegrind; ist nützlich für die späte Software Entwicklungs Etappe Profiling. Wenn man keine Anwendungen entwickelt, dann braucht man &tdecachegrind; nicht. </para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>Ich bekomme Fehler beim Kompilieren. Was ist das Problem?</para>
</question>
<answer>
<para>Oftmals hat die &Qt; Installation keine &kde; Unterstützung. </para>
</answer>
</qandaentry>
</qandaset>
</chapter>
<chapter id="credits">
<title>Credits und Lizenz</title>
<para>&tdecachegrind; </para>
<para>Dank an Julian Seward für seine einzigartige Anwendung &valgrind; und Nicholas Nethercote für den &cachegrind; Zusatz. Ohne diese Programme würde weder der Patch zur Aufruffolge (call tree) für &valgrind; noch <application>&tdecachegrind;</application> existieren. Viele Ideen für die Benutzeroberfläche stammen ebenfalls von ihnen. </para>
<para>Dank für die vielen Fehlerberichte/Vorschläge von verschiedenen Nutzern. Zum Schluß noch Dank an <itemizedlist>
<listitem><para>&kde;, das wundervolle Framework,</para>
</listitem>
<listitem><para>&Qt;, der perfekten Benutzerschnittstellen Werkzeugkasten</para>
</listitem>
<listitem><para>&Linux;, das definitive Betriebssystem</para>
</listitem>
</itemizedlist>
</para>
&underFDL; </chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-tdecachegrind">
<title>Bezugsquellen von &tdecachegrind;</title>
<para>Die Homepage von &tdecachegrind; findet man unter <ulink url="http://www.weidendorfers.de/tdecachegrind">http://www.weidendorfers.de/tdecachegrind</ulink>. Dort gibt es weitere Installations- und Kompilierungshinweise. </para>
</sect1>
<sect1 id="requirements">
<title>Anforderungen</title>
<para>Um &tdecachegrind; erfolgreich einsetzen zu können, benötigt man &kde; 3.x. Um die Ablaufprotokolle zu erzeugen, braucht man &cachegrind;. Um die sehr interessanten Visualisierungsmöglichkeiten von &tdecachegrind; ausschöpfen zu können, sollte man den Aufruffolge Patch von der &tdecachegrind; Homepage auf die Quellen von &valgrind; anwenden. </para>
</sect1>
<sect1 id="compilation">
<title>Kompilierung und Installation</title>
&install.compile.documentation; </sect1>
<sect1 id="configuration">
<title>Einstellung</title>
<para>Alle Einstellungsmöglichkeiten sind entweder im Einstellungsfenster oder in den Kontextfenster der Graphen zu finden. </para>
</sect1>
</appendix>
&documentation.index;
</book>
|
