Die LogTrace-Bibliothek

Transkript

1 Die LogTrace-Bibliothek Debugging-Hilfsmittel

2 Weiteres Beispiel Motivation void Func() { FunktionLog var( Func );... Func2();... Ausgabe sollte hier sein: >Func > Func2 < Func2 < Func void Func2() { FunktionLog var( Func2 );... Es wird eine Funktionalität gewünscht, die am Anfang einer Funktion schreibt Funktion XXX betreten und beim Verlassen Funktion XXX verlassen. V 4.01; Hon. Prof. Helmke 2

3 Weiteres Beispiel FunktionLog class FunktionLog { enum { MAX_LEN=50, BLANCS=3 ; char FuncName[MAX_LEN];... // weiteres wie mi_aufrufebene... public: // Gibt den Namen FuncName aus FunktionLog(const char Name[]); ; // Gibt beim Verlassen der Funktion FuncName aus. ~FunktionLog(); V 4.01; Hon. Prof. Helmke 3

4 Klasse FunktionLog, Teil 2 FunktionLog::FunktionLog(const char Name[]) { strncpy(funcname, Name, MAX_LEN -1); FuncName[MAX_LEN -1] = '\0'; for (int i=0; i < mi_aufrufebene; ++i) { cout << setw(blancs) << " "; ++mi_aufrufebene; cout << " > << FuncName; cout << endl; FunktionLog::~FunktionLog() { --mi_aufrufebene; for (int i=0; i < mi_aufrufebene; ++i) { cout << setw(blancs) << " "; cout << "< << FuncName << endl; V 4.01; Hon. Prof. Helmke 4

5 FunktionLog, Anwendungsbeispiel Ausgabe: int main() { FunktionLog xxx("main"); { FunktionLog xxx("schleife 1"); for (int i=0; i < 3; ++i) { FunktionLog xxx("i-schleife "); for (int j=0; j < 2; ++j) { FunktionLog xxx("j-schleife"); > main > Schleife 1 > i-schleife > j-schleife < j-schleife > j-schleife < j-schleife < i-schleife > i-schleife > j-schleife < j-schleife... < i-schleife < Schleife 1 < main V 4.01; Hon. Prof. Helmke 5

6 Siehe Buch Abschn bis Und Abschn Die LogTrace-Bibliothek Nun die etwas professionellere Variante

7 Beschreibung der Makros von LogTrace LOGTRACE_INIT("firma.trc","firma.id"); Dieser Makro steht am Anfang des Programms, meist als erste Anweisung des main-programms. In die Datei firma.trc wird die Ausgabe von LogTrace geschrieben. Die Datei firma.id steuert den Umfang und die Art der Ausgaben in die Datei firma.trc. V 4.01; Hon. Prof. Helmke 7

8 Beschreibung der Makros von LogTrace (2) LOG_FUNCTION("MA", "DeleteDR", vn << " " << nam); wird üblicherweise in Funktionen als erste Anweisung zur Protokollierung des Aufrufes dieser Funktion verwendet. Bei jedem Aufruf der Funktion wird der MA::DeleteDR sowie der Inhalt der Variablen vn und nam ausgegeben. Weitere Variablenwerte können mit << entsprechend angehängt werden. Bei Verlassen der Funktion wird entsprechend ebenfalls MA::DeleteDR gefolgt von den (ursprünglichen) Werten von vn und nam ausgegeben. Diese Ausgabe erfolgt allerdings nur, wenn die Steuerdatei, z.b. trace.id mindestens einen der beiden Strings MA bzw. DeleteDR enthält. MA ist normalerweise der Namensraum, in dem die Funktion liegt und DeleteDR der Name der Funktion. V 4.01; Hon. Prof. Helmke 8

9 Beschreibung der Makros von LogTrace (3) LOG_METHOD("MA","Mitarbeiter", "DeleteDR", vn << " " << nam); wird üblicherweise in Methode als erste Anweisung zur Protokollierung des Aufrufes dieser Methode verwendet. Im Wesentlichen entspricht der Makro LOG_FUNCTION. Hier erfolgt die Ausgabe allerdings, wenn einer der drei Strings MA,Mitarbeiter bzw. DeleteDR in der Steuerdatei vorhanden ist. Mitarbeiter hat hier die Bedeutung des Klassennamens. V 4.01; Hon. Prof. Helmke 9

10 Beschreibung der Makros von LogTrace (4) LOG_CONSTRUCTOR("MA","Mitarbeiter", v << " " << n); wird üblicherweise als erste Anweisung im Konstruktor verwendet. Die Semantik entspricht sonst dem bei LOG_FUNCTION bzw. LOG_METHOD Beschriebenen. Die Ausgabe erfolgt nur, wenn in der Steuerdatei einer der Strings MA bzw. Mitarbeiter enthalten ist. Zusätzlich muss aber noch der String Constructor enthalten sein. V 4.01; Hon. Prof. Helmke 10

11 Beschreibung der Makros von LogTrace (5) LOG_DESTRUCTOR("MA","Mitarbeiter"); wird üblicherweise als erste Anweisung im Destruktor verwendet. Die Semantik entspricht sonst dem bei LOG_CONSTRUTOR Beschriebenen. Die Ausgabe erfolgt nur, wenn in der Steuerdatei einer der Strings MA bzw. Mitarbeiter enthalten ist. Zusätzlich muss aber noch der String Destructor enthalten sein. Zusätzliche Parameter können hier nicht mehr mit << angehängt werden. V 4.01; Hon. Prof. Helmke 11

12 Beschreibung der Makros von LogTrace (6) TRACE("i=" << i << " Name ist " << name); Der Makro entspricht im Wesentlichen der Ausgabe über z.b. cout. Vor der Ausgabe des ersten Parameter wird allerdings << weggelassen. Ansonsten können beliebig viele Werte mit << angehängt und ausgegeben werden. Die Ausgabe erfolgt allerdings nur in die Trace-Datei, z.b. firma.trc, wenn bei letzten Makro-Aufruf von LOG_FUNCTION bzw. LOG_METHOD bzw. LOG_CONSTRUCTOR bzw. LOG_DESTRUCTOR eine Ausgabe erfolgte. V 4.01; Hon. Prof. Helmke 12

13 Beschreibung der Makros von LogTrace (7) TRACE_ID("ID", "i=" << i << " Name ist " << name); Der Makro entspricht dem Makro TRACE. Die Ausgabe ist hier allerdings unabhängig von dem letzten Makro-Aufruf von LOG_FUNCTION bzw. LOG_METHOD bzw. LOG_CONSTRUCTOR bzw. LOG_DESTRUCTOR. Die Ausgabe erfolgt stattdessen nur, wenn der String ID in der Steuerdatei, z.b. firma.id, vorhanden ist. V 4.01; Hon. Prof. Helmke 13

14 Beispiel LOGTRACE_INIT("demo.log","demo.id"); int main(int argc,char** argv) { LOG_FUNCTION("","main", argc << ',' << (void*)argv); TRACE("formatting test"); TRACE(setw(5) << 10 << setw(15) << << setw(7) << "hallo"); /** This macro produces some output in the logfile, iff the ID "i" has been found in the ID file. */ TRACE_ID("i","cos(0)=" << cos(0.0)); TRACE_ID(ALWAYS_ID, "output independent from " "contents of demo.id"); int sum=0; for (int i=0;i<2;++i) { TRACE("2+"<<i<<"=" << add(2,i)); TRACE("x=" << sum); g(); void g() { LOG_FUNCTION("","g",""); f(); void f() { LOG_FUNCTION("","f",""); V 4.01; Hon. Prof. Helmke 14

15 Sonder-ID LINESTAMP Enthält die ID-Datei den Eintrag LINESTAMP=1 so erscheinen Zeilennummer vor den eigentlichen Ausgaben. Ein XML-Parser versteht die Ausgabe dann allerdings nicht mehr. <?xml version="1.0" encoding="iso "?> <LogTrace xml:space='preserve'> <l 1> #### Eingabedatei: e:\gentrag\src\gentrag\test\daten\tpiinput <l 2> #### Suchstrategie: simple <l 3> #### Estimateinstanz: fast <l 4> #### TPI-Version: tpi2 <l 5> #### Navigationsdatenbank $(GENTRAG_HOME)/data/Nav.db <l 6> <method name="wpf::cseg_el_tromb::init_inter2()"> <l 7> head= 160 <l 8> <!-- name="wpf::cseg_el_tromb::init_inter2()" --></method> <l 9> <method name="wpf::cseg_el_tromb::init_inter2()"> <l 10> head= 160 <l 11> <!-- name="wpf::cseg_el_tromb::init_inter2()" --></method> <l 12> <method name="common::c_aircraft::setallsegmentnames()"> V 4.01; Hon. Prof. Helmke 15

16 Sonder-ID TIMESTAMP Enthält die ID-Datei den Eintrag TIMESTAMP=1 so erscheinen Uhrzeiten in Sekunden (keine Rechenzeiten) vor den eigentlichen Ausgaben. Ein XML-Parser versteht die Ausgabe dann nicht mehr. <?xml version="1.0" encoding="iso "?> <LogTrace xml:space='preserve'> <t > #### Eingabedatei: e:\gentrag\src\gentrag\test\daten\tpiinput <t > #### Suchstrategie: simple <t > #### Estimateinstanz: fast <t > #### TPI-Version: tpi2 <t > #### Navigationsdatenbank $(GENTRAG_HOME)/data/Nav.db <t > <method name="wpf::cseg_el_tromb::init_inter2()"> <t > head= 160 <t > <!-- name="wpf::cseg_el_tromb::init_inter2()" --></method> <t > <method name="wpf::cseg_el_tromb::init_inter2()"> <t > head= 160 <t > <!-- name="wpf::cseg_el_tromb::init_inter2()" --></method> <t > <method name="common::c_aircraft::setallsegmentnames()"> V 4.01; Hon. Prof. Helmke 16

17 Sonder-ID HISTORY und Kommentar Enthält die ID-Datei den Eintrag HISTORY=10 so wird ein Ringpuffer für die Ausgaben von 10 KByte verwendet, der wie bei Ringpuffer üblich, überschrieben, wenn 10 KByte überschritten sind. Der Ringpuffer wird erst dann in die Datei ausgeben, wenn ein Fehler oder eine Warnung auftritt (Aufruf von ERROR, WARNUNG oder INVARIANT). Außerdem wird der Ringpufferinhalt am Ende des Programms ausgegeben. Statt 10 kann auch eine andere ganzzahlige Konstante verwendet werden. Steht ein # (Gartenzaun) vor einem Eintrag, so wird die Zeile bis zum Zeilenende als Kommentar überlesen. Dieses ist ganz nützlich, um IDs aus- und einschalten zu können. V 4.01; Hon. Prof. Helmke 17

18 Sonder-IDs ALWAYS_ID, NEVER_ID Die IDs ALWAYS_ID und NEVER_ID können in TRACE_ID verwendet werden. Zu erzeugen unabhängig vom Inhalt der ID-Datei immer oder nie eine Ausgabe. TRACE_ID(ALWAYS_ID, "Hallo " << i << " x = " << x); ALWAYS_ID wird somit nicht in Anführungsstriche gesetzt. Es ist eine globale Variable, die über logtrace.h definiert ist. V 4.01; Hon. Prof. Helmke 18

19 Makros COND_SET_ID, COND_DEL_ID, COND_READ_IDS This set of macros can be used to change the list of active IDs. If the condition (1st parameter) is evaluated to true, the specified ID (in case of COND_[SET DEL]_ID) is added or removed from the list or the content of the specified ID file (in case of COND_READ_IDS) added. Changing the ID list makes sense only in debug level >= 2 (because below level 2 the output does not depend on the list of IDs). Beispiel: COND_SET_ID(timetick==36455, "SearchTraj ); V 4.01; Hon. Prof. Helmke 19

20 Makro CONSTR_DESTR_CNT_OK Es wird geprüft, ob die Trace-Datei genauso viele Destruktor- wie Konstruktor-Aufrufe enthält. Es geht hierbei nicht wirklich um die Anzahl der Einträge, sondern lediglich, um die Anzahl der Aufrufe von LOG_DESTRUCTOR und LOG_CONSTRUCTOR, unabhängig davon, ob diese Aufrufe wirklich eine Ausgabe produzieren. if (CONSTR_DESTR_CNT_OK == false) { cout << "Konstruktur- ungleich Destruktoraufrufanzahl!!!" << endl; V 4.01; Hon. Prof. Helmke 20