Development/Tutorials/Debugging/How to create useful crash reports (es)

Introducción

Este documento describe cómo crear pilas de las últimas funciones ejecutadas de un casque de una aplicación KDE. Primero se muestra algo de información general y luego se describe cómo preparar KDE en varias distribuciones para obtener estas pilas. Esto debería ser bastante para la mayoría de los casos. Hay secciones adicionales sobre cómo obtener la pila de las últimas funciones ejecutas con el depurador GNU (GDB) y con Valgrind, que son útiles en algunos casos.

Cómo crear informes de fallos útiles

Un buen informe de fallos en Bugzilla consiste de dos partes:

• Una descripción de cómo reproducir el fallo, y
• una pila de las últimas funciones ejecutadas (backtrace en inglés) en el momento del fallo.

Si falla uno de estos elementos, se vuelve mucho más dificil, si no imposible, resolver el problema a los desarrolladores.

Una descripción debería consistir en algo más que "cascó". Intente describir todo lo que estaba haciendo en el momento del fallo con el KDE, por ejemplo: ¿pulsó un botón, abrió una web o un fichero en particular que causó los problemas? Recuerde que el desarrollador intentará averiguar dónde está el fallo siguiendo los pasos descritos en el informe. Cualquier detalle que le pueda parecer superfluo relacionado con el fallo podría ser la clave para el desarrollador, así que escríbalo. Más vale pecar por exceso de información que por defecto.

Hay un artículo sobre cómo escribir buenos informes de fallos en este enlace, por favor, leálo antes de informar sobre fallos.

No adjunte la pila de las últimas funciones ejecutadas al informe, simplemente péguelo en el. De este modo es mucho más fácil buscar informes duplicados, porque no se busca en los ficheros adjuntos.

Al pegar la pila de las últimas funciones ejecutadas, elimine la mayoría de las líneas

(no debugging symbols found)

excepto una o dos de cada bloque, porque lo hacen más dificil de leer.

Aunque pegar la pila de las últimas funciones ejecutadas directamente al informe se prefiere a añadirlo como adjunto, por favor, no haga lo mismo con otra información como trazas (valgrind, strace o salida del terminal) o datos de ejemplo (correos, ficheros HTML,...), utilize ficheros adjuntos para esos datos.

pila de las últimas funciones ejecutadas

La pila de las últimas funciones ejecutadas, aunque pueda parecer un galimatías, contiene información muy valiosa para los desarrolladores. Estas pilas describen qué funciones se llamaron justo en el momento del fallo, así que los desarrolladores puede saber qué funciones son las culpables del fallo. Pero tener buenas pilas tiene un lado negativo, los ejecutables y bibliotecas que se utilizan ocupan mucho más espacio en disco que sus equivalentes optimizados. Por esta razón la mayoría de las distribuciones elijen instalar ejecutables sin símbolos de depuración (stripped en inglés), que producen pilas de últimas funciones ejecutadas inservibles:

(no debugging symbols found)
Using host libthread_db library "/lib/tls/i686/cmov/libthread_db.so.1".
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
[Thread debugging using libthread_db enabled]
[New Thread -1233848624 (LWP 12212)]
[New Thread -1255081072 (LWP 12820)]
[New Thread -1240921200 (LWP 12819)]
[New Thread -1266680944 (LWP 12818)]
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
(no debugging symbols found)
0xffffe410 in __kernel_vsyscall ()
#0  0xffffe410 in __kernel_vsyscall ()
#1  0xb6a1210b in ?? () from /lib/tls/i686/cmov/libpthread.so.0
#2  0xb6a85afe in ?? () from /usr/lib/libX11.so.6
#3  0x00000003 in ?? ()
#4  0x082149c0 in ?? ()
#5  0x00003ffc in ?? ()
#6  0x00000000 in ?? ()

Pero no todo está perdido, con algunas pequeñas modificaciones se pueden crear pilas de las últimas funciones ejecutadas con toda la información necesaria para los desarrolladores de KDE.

Preparando los paquetes KDE

Si su distribución tiene paquetes de depuración (debug), instálelos.

Es fácil saber qué paquetes depuración hacen falta mirando la pila de las últimas funciones ejecutadas. Por ejemplo, de una línea como la siguiente:

#6  0xb7975bdc in ?? () from /usr/lib/libkmailprivate.so.4

El ?? indica que la biblioteca libkmailprivat.so.4 no tiene información de depuración, que puede estar disponible en paquetes de depuración separados. En este caso, es bastante fácil averiguar que necesita instalar los paquetes de depuración de KMail para obtener una pila con información útil.

A veces, necesitará instalar más de un paquete de depuración para obtener una buena pila. Esto depende de cómo su distribución divida los paquetes. Por ejemplo, en algunas distribuciones es suficiente instalar el paquete de depuración para kdepim para obtener suficiente información para un casque en KMail, para otras distribuciones hay un paquete de depuración adicional para KMail.

Aquí hay una lista de cómo obtener paquetes de depuración para algunas distribuciones:

• Debian - Debian ofrece paquetes -dbg para facilitar la tarea de crear pilas útiles. Al instalar el paquete de depuración correspondiente -dbg, por ejemplo kdepim-dbg para casques de KMail, las dependencias de los paquetes hacen que se instalen todos los paquetes necesarios y en el orden correcto (kdelibs-dbg, gdb, ...).
• FreeBSD ports - Por favor, mire en KDE las preguntas más frecuentes de FreeBSD.
• Gentoo - Gentoo tiene su propio documento (en inglés) describiendo cómo proceder.
• Mandriva - Mandriva 2007.0 y posteriores tienen paquetes adicionales de depuración para todos sus paquetes (incluyendo KDE). Sólo hay que instalar el paquete correspondiente -debug, como kdebase-debug y kdemultimedia-debug. También debería instalar kdelibs-debug.
  • Note: Los paquetes -debug están en repositorios separados. Por ejemplo, para todos los paquetes en main, encontrará los paquetes de depuración en el repositorio debug_main.
• Kubuntu/Ubuntu - Las distribuciones Ubuntu hacen estas cosas fáciles. Cada paquete oficial KDE tiene un paquete adicional en el repositorio, con el sufijo -dbg. Siempre hay que instalar kdelibs5-dbg, porque todas las aplicaciones KDE utilizan kdelibs (kdelibs-dbg para las aplicaciones KDE 3). Luego debería instalar el paquete -dbg para la aplicación que falló. Por ejemplo, si falló KOrganizer, debería instalar kdepim-dbg. Si el programa no es un módulo oficial KDE y no tiene paquete -dgb, puede instalar el paquete -dbgsym desde el repositorio listado en su página Debugging Program Crashes.
• openSUSE - Sólo hay que instlar los paquetes -debuginfo, por ejemplo: kdepimlibs4-debuginfo. Se pueden encontrar estos paquetes en los repositorios KDE. También tiene una página dedicada a la depuración.
• Fedora - Fedora has its own document describing how to proceed. (A debuginfo repository has to be enabled.)

Si su distribución no incluye paquetes de depuración para KDE, tendría que compilar KDE desde el código fuente:

• Si está usando KDE3, entonces en la etapa de configuración, debería añadir el parámetro --enable-debug=full para obtener símbolos de depuración en los ficheros resultantes.
• Si está usando KDE4, entonces en la etapa cmake, debe añadir el parámetro -DCMAKE_BUILD_TYPE=debugfull. Si quiere especificar sus propios CXXFLAGS, entonces utilize -DCMAKE_BUILD_TYPE=None CMAKE_CXX_FLAGS="-O0 -g". Puede cambiar los CMAKE_CXX_FLAGS para que se ajuste a sus necesidades.

Luego son los conocidos make y make install habituales.

Crash!

Ahora, a hacer fallar la aplicación de nuevo (una buena forma de tener una excelente descripción de cómo reproducir el fallo). El diálogo de aplicación fallida debería aparecer después del fallo, mostrando la pila de últimas funciones ejecutadas.

KDE Crash Dialog

Pulse en la pestaña Backtrace y espere un buen rato, el proceso puede ocupar muchar memoria y mucho procesador, así que el resto de procesos pueden ralentizarse mucho. Pero el resultado debe ser ahora muchísimo mejor, por ejemplo:

Using host libthread_db library "/lib/libthread_db.so.1". 
[Thread debugging using libthread_db enabled] 
[New Thread -1232783168 (LWP 7604)] 
[KCrash handler] 
#6  0x0806be76 in TreeMapItem::parent (this=0x0) 
    at /home/bram/KDE/kde3/kdeaddons/konq-plugins/fsview/treemap.h:285 
#7  0x08065fea in TreeMapItemList::compareItems (this=0xbfec04a8, item1=0x0, 
    item2=0x0) 
    at /home/bram/KDE/kde3/kdeaddons/konq-plugins/fsview/treemap.cpp:720 
#8  0xb7281619 in QGList::operator== () from /usr/qt/3/lib/libqt-mt.so.3 
#9  0x0806d498 in QPtrList<TreeMapItem>::operator== (this=0xbfec04a8, 
    list=@0xbfec0468) at /usr/qt/3/include/qptrlist.h:74 
#10 0x08062e18 in TreeMapWidget::mousePressEvent (this=0xbfec03ac, 
    e=0xbfebff1c) 
    at /home/bram/KDE/kde3/kdeaddons/konq-plugins/fsview/treemap.cpp:1840 
#11 0xb7004a63 in QWidget::event () from /usr/qt/3/lib/libqt-mt.so.3 
#12 0xb6f6bca7 in QApplication::internalNotify () 
   from /usr/qt/3/lib/libqt-mt.so.3 
#13 0xb6f6ca88 in QApplication::notify () from /usr/qt/3/lib/libqt-mt.so.3 
#14 0xb7725a84 in KApplication::notify (this=0xbfec055c, receiver=0xbfec03ac, 
    event=0xbfebff1c) 
    at /home/bram/KDE/kde3/kdelibs/kdecore/kapplication.cpp:550 
#15 0xb6f0bfd2 in QETWidget::translateMouseEvent () 
   from /usr/qt/3/lib/libqt-mt.so.3 
#16 0xb6f0b8b0 in QApplication::x11ProcessEvent () 
   from /usr/qt/3/lib/libqt-mt.so.3 
#17 0xb6f1b761 in QEventLoop::processEvents () from /usr/qt/3/lib/libqt-mt.so.3 
#18 0xb6f82831 in QEventLoop::enterLoop () from /usr/qt/3/lib/libqt-mt.so.3 
#19 0xb6f826b6 in QEventLoop::exec () from /usr/qt/3/lib/libqt-mt.so.3 
#20 0xb6f6b72f in QApplication::exec () from /usr/qt/3/lib/libqt-mt.so.3 
#21 0x0805181e in main (argc=134673960, argv=0xffffffff) 
    at /home/bram/KDE/kde3/kdeaddons/konq-plugins/fsview/main.cpp:55

Parece mucho mejor, ¿verdad? Muestra a los desarrolladores las direcciones de memoria, los ficheros fuente y los números de línea, además de los parámetros pasados a las funciones. Así es mucho más facil resolver el fallo.

Note

Se necesita tener instalado GDB para obtener las pilas de las últimas funciones ejecutadas en un fallo. Mire la siguiente sección para saber qué es GDB y como instalarlo.

Obteniendo la pila de las últimas funciones ejecutadas con GDB

En algunos casos, no es posible crear la pila de las últimas funciones ejecutadas dentro del diálogo de aplicación fallida del KDE. Esto puede ser porque una aplicacón entró en un bucle sin fin, o el diálogo de aplicación fallida no aparece por algún motivo. Siempre puede intentar obtener la instantánea de donde aparece el fallo con gdb, el depurador GNU . GDB está disponible para instalarse en la inmensa mayoría de las distribuciones en su almacén de programas.

Hay dos formas de utilizar GDB:

• iniciar una aplicación dentro de gdb, o
• depurar una aplicación que ya está funcionando, útil en el caso de una aplicación que se encuentra en un bucle sin fin.

Primero empezaremos por iniciar una aplicación dentro de gdb. Desde el terminal, ejecutamos:

$ gdb someKDEapp

La línea de comandos del GDB aparecerá. Todavía no se ha iniciado la aplicación, para ello hay que invocar el comando run:

(gdb) run

Esto iniciará la aplicación como de costumbre, y se puede trabajar con ella de forma normal (sólo consume mucha más memoria que de costumbre y puede ir un poco más lenta de lo normal). Ahora, a reproducir el fallo. Cuando se tenga éxito, la aplicación se cerrará y debería estar en la línea de comandos del GDB. Ahora a mostrar la pila (backtrace en inglés):

Note

Algunas aplicaciones KDE (como JuK y KTorrent) sólo permiten iniciar la aplicación una vez. Para estos casos, habría que escribir "run --nofork" en la línea de comandos del gdb en lugar de "run", o gdb intentará depurar el proceso incorrecto. Si no está seguro de cuándo debe utlizar --nofork, simplemente úselo. Si la aplicación dice que es una opción desconocida, entondes debe quitar el --nofork.

(gdb) thread apply all backtrace

Esto debería dar una pila de las últimas funciones ejecutadas que puede ser pegado en el Bugzilla de KDE.

En el caso de depurar una aplicación ya iniciada, ejecute el siguiente comando en el terminal:

$ gdb la_aplicación_KDE pid

donde pid es el IDentificador del proceso que se quiere depurar. Una vez que se ha enganchado, si el proceso está en bucle sin fin, después de utilizar el comando gdb 'backtrace' aparecerá una pila de las últimas funciones ejecutadas util. Después se puede utilizar el comando gdb 'continue' para dejar que la aplicación siga ejecutándose y pulsando Ctrl+C en gdb permitirá de nuevo introducir comandos.

Obteniendo la pila de las últimas funciones ejecutadas con Valgrind

Cuando se trata de fallos, Valgrind es también una herramienta muy útil para crear pilas de las últimas funciones ejecutadas. No es un sustituto del GDB, sino un suplemento.

Cuando se inicia una apliación en valgrind, cada operación de memoria del proceso se comprueba. Valgrind generará un informe de operaciones de memoria incorrectas del proceso por la salida estándard o en fichero de trazas. Como la mayoría de los fallos se deben a la lectura de la memoria del proceso incorrecta, valgrind es muy útil para rastrear dónde ocurre el fallo.

Note

Valgrind contiene varias herramientas para probar o perfilar una aplicación. Para este artículo, sólo utilizamos memcheck, la herramienta por defecto cuando valgrind se invoca.

Como GDB, Valgrind utiliza mucha más memoria y hace que la aplicación funcione mucho más despacio.

Para iniciar la aplicación con valgrind:

$ valgrind --log-file=la_aplicación_KDE_a_depurar la_aplicación_KDE_a_depurar

Ahora, el reproducir el fallo, la aplicación y valgrind acabarán. Lo que queda es un fichero llamado la_aplicación_KDE_a_depurar.pid donde pid se sustituye por el ID del proceso de valgrind. Este fichero puede contener más errores que el que causa el fallo. Aquí está el trocito que corresponde a la pila anterior obtenida con el GDB:

==23292== Invalid read of size 4
==23292==    at 0x806BD9E: TreeMapItem::parent() const (treemap.h:285)
==23292==    by 0x8065FB9: TreeMapItemList::compareItems(void*, void*) (treemap.cpp:720)
==23292==    by 0x50AC618: QGList::operator==(QGList const&) const (in /usr/qt/3/lib/libqt-mt.so.3.3.8)
==23292==    by 0x806D3BF: QPtrList<TreeMapItem>::operator==(QPtrList<TreeMapItem> const&) const (qptrlist.h:74)
==23292==    by 0x8062DE7: TreeMapWidget::mousePressEvent(QMouseEvent*) (treemap.cpp:1840)
==23292==    by 0x4E2FA62: QWidget::event(QEvent*) (in /usr/qt/3/lib/libqt-mt.so.3.3.8)
==23292==    by 0x4D96CA6: QApplication::internalNotify(QObject*, QEvent*) (in /usr/qt/3/lib/libqt-mt.so.3.3.8)
==23292==    by 0x4D97A87: QApplication::notify(QObject*, QEvent*) (in /usr/qt/3/lib/libqt-mt.so.3.3.8)
==23292==    by 0x4809AC3: KApplication::notify(QObject*, QEvent*) (kapplication.cpp:550)
==23292==    by 0x4D36FD1: QETWidget::translateMouseEvent(_XEvent const*) (in /usr/qt/3/lib/libqt-mt.so.3.3.8)
==23292==    by 0x4D368AF: QApplication::x11ProcessEvent(_XEvent*) (in /usr/qt/3/lib/libqt-mt.so.3.3.8)
==23292==    by 0x4D46760: QEventLoop::processEvents(unsigned) (in /usr/qt/3/lib/libqt-mt.so.3.3.8)
==23292==  Address 0x2C is not stack'd, malloc'd or (recently) free'd

Pero, para estar seguro, adjunte todo el fichero al informe de fallos.