Bugs melden
Da es für die Haiku-Entwickler unmöglich ist, jede denkbare Hardware-Kombination oder jede mögliche Anwendungsweise eines Programms zu testen, ist es eine große Hilfe, wenn Fehler gemeldet werden. Da Haiku noch recht jung ist, sind Bugs nicht ungewöhnlich. Wir sind dankbar für die Zeit, die Sie sich nehmen, um Fehler zu melden. Nur mit Hilfe der Anwender können wir Haiku Stück für Stück verbessern.
Damit unser "Bugtracker" - also die Liste aller gefundenen Fehler - effektiv funktioniert, ist es von grundlegender Bedeutung, sich an die Bug Tracker Etiquette zu halten.
Zugang zu Trac
Um ein Fehler-Ticket aufzugeben, muss man sich beim Bugtracker registrieren.
Dafür ist eine gültige E-Mail Adresse notwendig. Sollte nach dem Registrieren keine Bestätigungsmail ankommen, sollte man mal seinen Spam-Ordner überprüfen.
Bugreport erstellen
Bevor man einen Fehler meldet, sollte man sich sicher sein, dass das nicht schon geschehen ist. Hierzu nutzt man die Suchfunktion.
Nach dieser Überprüfung sollte man so genau wie möglich den Fehler beschreiben:
Der Fehler sollte mit einer aktuellen Version von Haiku reproduzierbar sein. Zum Testen gibt es installierbare Nightly Images.
Wie wurde Haiku verwendet (auf echter Hardware oder virtualisiert unter VMWare, QEMU oder ähnlichem)?
Welche Haiku-Versionsnummer wurde verwendet? Die Version ist unter im Deskbar Menü zu finden. Wie genau Haiku kompiliert wurde (x86_gcc2, x86_64), ist ebenfalls von Interesse. Die runterladbaren Images sind entsprechend benannt. Bei selbst gebauten Haiku-Images, sollte man wissen, wie das gemacht wurde.
Der Fehler sollte so präzise wie möglich beschrieben werden. Welches Verhalten wurde erwartet und was wurde stattdessen beobachtet?
Wann tritt der Fehler auf? Nur mit einer Schritt-für-Schritt Anleitung können die Entwickler den Bug nachstellen und beheben.
An den Fehlerbericht sollten so viele Informationen wie möglich angehängt werden. Handelt es sich um einen Bug in der grafischen Oberfläche oder einer der Anwendungen, ist ein Bildschirmfoto mittels der DRUCK Taste hilfreich.
Bugs in Anwendungen
Stürzt eine Anwendung ab, kann man entweder einen 'Bericht' speichern oder eine 'Core-Datei' schreiben (beides erscheint auf dem Desktop). Diese kann man dann an einen Bugreport hängen. Alternativ ruft man den Debugger auf. Siehe dazu das Kapitel Debugger.
Führt ein Bug nicht zu einen Crash, kann man manchmal wertvolle Informationen sammeln, indem man die Anwendung vom Terminal aus startet. Einige Programme bieten Logging oder andere Optionen an, wenn sie mit entsprechenden Parametern gestartet werden. Einfach mal -h or --help probieren, um zu sehen ob das der Fall ist. Ein Beispiel für verschiedene Logging-Stufen ist HaikuDepot.
Bugs in Servern
Stürzen lebenswichtige Server wie der App Server, der Registrar oder der Input Server ab, bekommt man nicht den gewöhnlichen Crash-Hinweis zu sehen. Stattdessen wird der gesamte Bildschirm weiß und der Debugger wird im Textmodus gestartet, der seine Ausgabe direkt auf den Bildschirm schreibt. Unter Umständen kann man immer noch die Maus bewegen, die daraufhin das Weiß und die Debugger Ausgabe übermalt. Noch laufende Anwendungen, wie ProcessController oder die Uhr in der Deskbar, tun das vielleicht auch noch.
Außer dass alles etwas unansehnlicher und unbequemer ist, gilt eigentlich das gleiche wie für Bugs in Anwendungen. Am wichtigsten ist das sichern eines "backtrace" mittels bt. Weil man den Text ja nicht mehr irgendwohin kopieren kann, müsste man die Ausgabe per Kamera festhalten.
Je nachdem was genau abgestürzt ist, kann man auch probieren mit dem Befehl save-report einen 'Crash-Bericht' oder per write-core eine 'Core-Datei' auf dem Desktop zu speichern. Danach sollte man einmal auf den Powerknopf drücken, um zu versuchen den Rechner sauber herunterzufahren. Funktioniert der Powerknopf nicht, gibt es noch die Befehle shutdown und reboot zum Ausschalten bzw. für einen Neustart.
Bugs im Kernel
Fehler im Kernel haben normalerweise die schwersten Auswirkungen und sind zugleich am schwierigsten zu debuggen. Es gibt unterschiedliche Symptome, die auf ein Problem von Kernel oder Treiber hindeuten:
Das System betritt selbständig das Kernel Debugging Land (KDL) . Der obere Teil des Bildschirms wird weiß und einige Zeilen Text erscheinen. Die zweite Zeile verkündet "Welcome to Kernel Debugging Land...", die darüber beschreibt den unmittelbaren Grund für die Reise ins KDL.
Das System führt einen spontanen Neustart aus.
Das System friert komplett ein. Die Maus lässt sich nicht mehr bewegen und Anwendungen aktualisieren ihre Oberfläche nicht mehr. Ein wichtiger Test in so einer Situation ist, ob man das KDL noch mit der Tastenkombination ALT SysReq D (SysReq ist dabei meist die DRUCK Taste) erreichen kann. Man sollte zumindest eine Minute warten, ob sich was tut.
Das System fährt nicht mehr richtig hoch. Unter Umständen führt es spontan einen Neustart durch oder bleibt an einer Stelle stecken, vielleicht bei einem bestimmten Symbol des Boot-Bildschirms. In letzterem Falle sollte man auch mal ein ALT SysReq D versuchen.
Das ganze System oder eine bestimmte Hardwarekomponente funktioniert nicht richtig. Es könnte beispielsweise nur sehr langsam laufen, Fehler könnten auftreten oder etwas funktioniert überhaupt nicht. Verweigert eine Hardwarekomponente die Arbeit komplett, sollte man natürlich erst mal checken, ob Haiku sie momentan überhaupt treibermäßig unterstützt, indem man zum Beispiel auf der Mainlingliste oder im Forum nachfragt.
Während nur der letzte Punkt explizit auf eine Hardware-Ursache eingeht, können auch alle anderen Symptome auf Fehler in einem Hardware Treiber hindeuten. Hat man einen Verdacht welche Hardware oder entsprechender Treiber mit dem Problem zu tun haben könnte, sollte man prüfen ob das Entfernen oder Deaktivieren von Hardware oder Treiber Abhilfe schafft. Wenn man das Problem beispielsweise beim WLAN vermutet, könnte diese Funktion vielleicht im BIOS ausgeschaltet werden. Wenn nicht, kann man auch den entsprechenden Treiber auf eine "Schwarze Liste" setzen und so im System deaktivieren (siehe Boot Loader).
Kernel Debugging Land - KDL
Stürzt das System nicht von selbst ins KDL, kann man das auch absichtlich mit der Tastenkombination ALTSysReqD erreichen (SysReq ist normalerweise die Druck Taste).
Im KDL kann es passieren, dass die Tastatur nicht mehr funktioniert. PS/2-Tastaturen gehen immer, bei USB-Tastaturen kommt es auf die Art des USB-Controllers an (UHCI/EHCI). Generell sollte die Tastatur direkt an einem Port hängen, nicht über einen Hub. In bestimmten Fällen kann es sein, dass die Tastatur nur funktioniert, wenn man vorher schonmal per Tastenkombination das KDL betreten hat. USB per OHCI wird zur Zeit noch gar nicht unterstützt.
Das KDL ist eine Art Konsole. Es lassen sich Befehle eingeben, die Informationen über das System ausgeben. Folgende Befehle sind von besonderen Interesse:
| bt (auch sc) | Zeigt einen "backtrace" (oder auch "stackcrawl") wo genau der Fehler aufgetreten ist. Ist das System von selbst ins KDL gefallen, wird so ein backtrace automatisch ausgegeben. Der Befehl ist einzugeben, wenn das nicht geschehen oder ein Teil nicht zu sehen ist. Das ist beispielsweise bei sehr langen Ausgaben der Fall. Die einzige Möglichkeit, die Information an die Entwickler zu senden, ist dann ein Foto. | |
| ints | Zeigt die unbenutzten und verwendeten Interrupts. | |
| co (auch "continue") | Verlässt den Kernel Debugger und das System läuft - soweit möglich - normal weiter. | |
| reboot | Führt einen unmittelbaren Neustart durch. Alle nicht gespeicherten Daten gehen verloren und selbst das, was man gespeichert hat, aber noch nicht auf die Platte geschrieben wurde, ist weg. |
Weitere Infos gibt es im Artikel Welcome to Kernel Debugging Land (Englisch).
Die Ausgaben im KDL werden zum seriellen Port geschickt. Falls man einen hat und ein entsprechendes Nullmodemkabel samt zweiten Rechner angeschlossen hat. Dort kann man die Ausgaben in einem Terminalprogramm aufnehmen. Außerdem werden sie ins Syslog geschrieben. Wenn man das KDL allerdings nicht verlassen kann, wird auch nichts ins Syslog geschrieben. Es gibt aber eine Debug-Option im Bootloader, die das trotzdem möglich macht (siehe weiter unten).
Von Ausgaben im KDL lassen sich auch QR-Codes erzeugen, die dann mit einem Smartphone oder ähnlichem zu Text konvertiert werden können. Der Blogpost QR Encode your KDL Output (Englisch) erklärt, wie man mit diesem Feature Daten aus dem Kernel Debugging Land herausbekommt.
Syslog
Das ist die beste Methode, um Informationen über ein nicht-bootendes System zu gewinnen.
Das Syslog (kurz für System Log) enthält wertvolle Infos darüber, was im System abläuft, einschließlich der Ausgaben einer KDL Sitzung. Man sollte es immer an einen Trac Ticket hängen, wenn es etwas mit dem Kernel zu tun haben könnte. Das Syslog befindet sich in der Datei /boot/common/var/log/syslog. Um in eine Datei schreiben zu können, braucht man ein funktionierendes System. Tritt ein Problem im Kernel auf (insbesondere bei spontanen Neustarts und nicht-fortsetzbaren KDL-Sitzungen), kann es passieren, dass es die letzten Ausgaben nicht mehr ins Syslog schaffen.
Durch die Option im des Bootloaders wird das Syslog im Speicher gehalten.
Ist die Einstellung in den Bootloader Optionen aktiviert (wie es standardmäßig der Fall ist), findet man das Syslog der letzten Sitzung unter /boot/system/var/log/previous_syslog.
Gelingt das Booten nicht, um an das previous_syslog zu kommen, muss man beim Neustart das Bootloader Menü mittels gedrückter SHIFT Taste (bzw. LEERTASTE wenn per UEFI gebootet wird) aufrufen.
Dort sollte man im die Einträge und sehen. Ersterer zeigt das Syslog direkt auf dem Bildschirm an, mit letzterem lässt es sich speichern. Momentan geht das nur auf FAT32 formatierten Medien. Möchte man dafür einen USB-Stick benutzen, den man allerdings erst zu spät reingesteckt hat und der deswegen nicht erkannt wurde, kann man den Rechner nochmals resetten und das Bootloader-Menü erneut aufrufen. Es gilt aber immer noch: Bootet man aus Versehen ein Betriebssystem, sind die Syslog-Daten weg.
Debug Ausgabe auf den Bildschirm
Die Ausgabe auf dem Bildschirm ist nur bei ganz bestimmten Situationen sinnvoll und hat bekanntermaßen Timing-Probleme. Es sollte also wirklich nur im Notfall benutzt werden.
Das ist zum Beispiel der Fall, wenn Haiku nicht ganz hochfährt und die im Bootloader irgendwie nicht funktioniert. Noch bevor das Haiku-Bootlogo erscheint, die SHIFT Taste (bzw. LEERTASTE wenn per UEFI gebootet wird) gedrückt halten, um das Bootloader-Menü aufzurufen. Von hier in das Menü wechseln und dort weiter unten aktivieren. (Die anderen Optionen kann man auch mal probieren, um zu versuchen, Haiku erfolgreich zu booten. Wenn Haiku nur mit einer oder mehreren aktivierten Optionen hochfahren kann, sollte man natürlich erwähnen, welche das sind.)
Abschließend geht man auf und dann .
Auf dem Bildschirm werden einige Seiten Text ausgegeben, von denen aber nur die letzten paar für einen Bugreport interessant sind. Der Userguide hat noch weitere Infos zum Boot Loader.
Bugs von Hardware/Treiber
Wenn ein Fehler gemeldet wird, der Hardware oder Treiber betrifft, sollten folgende Informationen als Textdateien an den Fehlerbericht angehängt werden:
| - listdev | Eine detaillierte Auflistung aller vorhandener Hardware inklusive "vendor id" und "pci id"; ähnlich den Befehlen lshw und lspci unter Linux. | |
| - listusb -v | Bei Fehlern im Zusammenhang mit USB, ähnlich dem Befehlt lsusb unter Linux. | |
| - open /var/log/syslog | Die zentrale Log-Datei von Haiku, siehe Syslog weiter oben, entspricht der Debug Bildschirmausgabe. Mit dem Befehl open kann das Log im Texteditor auf eine sinnvolle Länge gekürzt werden. | |
| - listimage | grep drivers/ | Eine Auflistung aller verwendeten Treiber. | |
| - usb_hid_report | Sind USB-Eingabegeräte betroffen, sollte man die Datei /tmp/usb_hid_report_descriptor_*.bin an den Fehlerbericht hängen. | |
| - ints | Nur im Kernel Debugging Land (siehe weiter oben). Es zeigt eine Liste aller verwendeter "Interrupts". Wenn sich mehrere Geräte zuviele von ihnen teilen, ist das schlecht. | |
| - "On screen debug output" (die Bootloader Debug Option zur Ausgabe auf dem Bildschirm, siehe weiter oben). | ||
Die ersten vier dieser Befehle sind im Terminal einzugeben. Mit dem Zusatz " > output.txt" an den Befehl wird dessen Ausgabe in die Datei "output.txt" gespeichert, die dann an den Fehlerbericht angehängt werden kann.
Bug gemeldet. Und dann?
Nachdem ein Fehler gemeldet wurde, wird sich ein Entwickler ihm annehmen und bewerten. Da es sich bei allen Entwicklern um Freiwillige handelt, die in ihrer Freizeit programmieren, kann es durchaus etwas dauern, bis man eine Rückmeldung erhält. Je mehr Informationen man einer Fehlermeldung beifügt oder nachreicht, um so leichter ist es für den Programmierer, diesen zu beheben.
Wenn man einen Fehler gemeldet hat, ist es damit nicht abgeschlossen. Eigentlich ist es erst der Anfang. Man wird Teil des Entwicklungs-Prozesses von Haiku. Es ist durchaus möglich und eigentlich auch zu erwarten, dass sich ein Entwickler meldet, um näheres zu den Umständen des Fehler-Reports zu erfahren. Hier gilt wieder: Je mehr man dem Entwickler helfen kann, um so leichter tut er sich mit der Fehlerbehebung. Erst wenn der Fehler als 'fixed' - also behoben - markiert ist, kann man sich zurücklehnen, mit dem guten Gefühl etwas beigetragen zu haben.