Buscar pérdidas de memoria con la biblioteca de CRT

Artículo
11/25/2015

Las pérdidas de memoria, definidas como la incapacidad de desasignar correctamente memoria asignada previamente, se encuentran entre los errores más sutiles y difíciles de detectar en las aplicaciones de C/C++.Una pequeña pérdida de memoria puede no advertirse al principio, pero con el tiempo, una progresiva pérdida de memoria puede producir síntomas que van desde una disminución del rendimiento hasta el bloqueo cuando la aplicación se queda sin memoria.Peor aún, una aplicación con pérdida de memoria que utilice toda la memoria disponible puede hacer que se bloquee otra aplicación, creando confusión respecto a qué aplicación es la responsable.Incluso unas pérdidas de memoria aparentemente inocuas podrían ser síntomas de otros problemas que se deben corregir.

El depurador de Visual Studio y las bibliotecas en tiempo de ejecución de C (CRT) proporcionan medios para detectar e identificar las pérdidas de memoria.

Habilitar la detección de pérdidas de memoria

Las herramientas principales para detectar pérdidas de memoria son el depurador y las funciones del montón de depuración de CRT.

Para habilitar las funciones del montón de depuración, incluya las siguientes instrucciones en el programa:

#define _CRTDBG_MAP_ALLOC
#include <stdlib.h>
#include <crtdbg.h>

Para que las funciones CRT funcionen correctamente, las instrucciones #include deben seguir el orden que se muestra aquí.

Si se incluye crtdbg.h, se asignan las funciones malloc y free a sus versiones de depuración _malloc_dbg y free, que realizan un seguimiento de la asignación y desasignación de memoria.Esta asignación se produce únicamente en las compilaciones de depuración, que tienen _DEBUG.Las versiones de lanzamiento utilizan las funciones normales malloc y free.

La instrucción #define asigna una versión base de las funciones del montón de CRT a la versión de depuración correspondiente.Si omite la instrucción #define, el volcado de pérdida de memoria será menos detallado.

Después de haber habilitado las funciones del montón mediante estas instrucciones, puede realizar una llamada a _CrtDumpMemoryLeaks antes de un punto de salida de la aplicación para mostrar un informe de pérdida de memoria cuando se cierre la aplicación:

_CrtDumpMemoryLeaks();

Si su aplicación tiene varias salidas, no es necesario realizar manualmente una llamada a _CrtDumpMemoryLeaks en cada punto de salida.Una llamada a _CrtSetDbgFlag al principio de la aplicación producirá una llamada automática a _CrtDumpMemoryLeaks en cada punto de salida.Debe establecer los campos de dos bits que se muestran aquí:

_CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );

De forma predeterminada, _CrtDumpMemoryLeaks genera el informe de pérdida de memoria en el panel de Depuración de la Ventana de salida.Puede utilizar _CrtSetReportMode para redirigir el informe a otra ubicación.

Si utiliza una biblioteca, esta podría hacer que se envíen los resultados a otra ubicación.En ese caso, puede volver a establecer la ubicación de salida en la Ventana de salida, como se muestra aquí:

_CrtSetReportMode( _CRT_ERROR, _CRTDBG_MODE_DEBUG );

Interpretar el informe de pérdida de memoria

Si la aplicación no define _CRTDBG_MAP_ALLOC, _CrtDumpMemoryLeaks muestran un informe de pérdida de memoria con esta apariencia:

Detected memory leaks!
Dumping objects ->
{18} normal block at 0x00780E80, 64 bytes long.
 Data: <                > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD
Object dump complete.

Si la aplicación define _CRTDBG_MAP_ALLOC, el informe de pérdida de memoria tiene el siguiente aspecto:

Detected memory leaks!
Dumping objects ->
C:\PROGRAM FILES\VISUAL STUDIO\MyProjects\leaktest\leaktest.cpp(20) : {18} 
normal block at 0x00780E80, 64 bytes long.
 Data: <                > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD
Object dump complete.

La diferencia es que el segundo informe muestra el nombre del archivo y el número de línea en el que se asigna primero la pérdida memoria.

Tanto si define o no _CRTDBG_MAP_ALLOC, el informe de pérdida de memoria mostrará la siguiente información:

El número de asignación de memoria, que es 18 en este ejemplo
El tipo de bloque, que es normal en este ejemplo.
La ubicación de memoria hexadecimal, que es 0x00780E80 en este ejemplo.
El tamaño del bloque, 64 bytes en este ejemplo.
Los primeros 16 bytes de datos del bloque, en formato hexadecimal.

El informe de pérdida de memoria identifica un bloque de memoria como normal, cliente o CRT.Un bloque normal se compone de memoria ordinaria asignada por el programa.Un bloque cliente es un tipo de bloque de memoria especial utilizado por programas MFC para objetos que requieren un destructor.El operador new de MFC crea un bloque normal o un bloque cliente, según convenga, para el objeto que se está creando.Un bloque CRT es asignado por la biblioteca CRT para su propio uso.La biblioteca CRT controla la desasignación de estos bloques.Por consiguiente, es improbable que los vea en el informe de pérdida de memoria, a menos que exista algún problema serio, por ejemplo, que la biblioteca CRT esté dañada.

Hay otros dos tipos de bloques de memoria que no aparecen nunca en los informes de pérdida de memoria.Un bloque libre es un bloque de memoria que se ha liberado.Eso significa que no está perdida, por definición.Un bloque omitido es memoria que se ha marcado explícitamente para excluirla del informe de pérdida de memoria.

Estas técnicas funcionan para la memoria asignada mediante la función malloc de CRT estándar.Sin embargo, si el programa asigna memoria mediante el operador new de C++, deberá volver a definir new si desea ver el archivo y los números de línea en el informe de pérdida de memoria.Puede hacerlo con un bloque de código similar al siguiente:

#ifdef _DEBUG
   #ifndef DBG_NEW
      #define DBG_NEW new ( _NORMAL_BLOCK , __FILE__ , __LINE__ )
      #define new DBG_NEW
   #endif
#endif  // _DEBUG

Establecer puntos de interrupción en un número de asignación de memoria

El número de asignación de memoria le indica cuándo se asignó un bloque de pérdida de memoria.Un bloque con un número de asignación de memoria de 18, por ejemplo, es el decimoctavo bloque de memoria asignado durante la ejecución de la aplicación.El informe de CRT cuenta todas las asignaciones de bloques de memoria durante la ejecución.Esto incluye las asignaciones de la biblioteca CRT y otras bibliotecas como MFC.Por consiguiente, un bloque con un número de asignación de memoria de 18 puede no ser el decimoctavo bloque de memoria asignado por el código.Normalmente, no lo será.

Puede utilizar el número de asignación para establecer un punto de interrupción en la asignación de memoria.

Para definir un punto de interrupción de asignación de memoria mediante la ventana Inspección

Establezca un punto de interrupción cerca del inicio de la aplicación e iníciela.
Cuando la aplicación se interrumpe en el punto de interrupción, la ventana Inspección.
En la ventana Inspección, escriba _crtBreakAlloc en la columna Nombre.

Si está utilizando la versión DLL de subprocesamiento múltiple de la biblioteca CRT (la opción /MD), incluya el operador de contexto: {,,msvcr120d.dll}_crtBreakAlloc
Presione RETORNO.

El depurador evalúa la llamada y coloca el resultado en la columna Valor.Este valor será –1 si no se han definido puntos de interrupción sobre asignaciones de memoria.
En la columna Valor reemplace el valor que se muestra por el número de asignación de la ubicación de memoria donde desea realizar la interrupción.

Después de establecer un punto de interrupción en un número de asignación de memoria, puede continuar con la depuración.Debe ejecutar el programa bajo las mismas condiciones que la ejecución anterior, de modo que el orden de asignación de memoria no cambie.Cuando el programa se interrumpe en la asignación de memoria especificada, puede usar la ventana Pila de llamadas y otras ventanas de depurador para determinar las condiciones en las que se asignó la memoria.A continuación, puede continuar la ejecución para observar qué le ocurre al objeto y determinar por qué no se desasigna correctamente.

También podría resultar útil definir un punto de interrupción de datos sobre el objeto.Para obtener más información, vea Set a data change breakpoint (native C++ only).

También puede establecer puntos de interrupción de asignación de memoria en el código.Existen dos modos para hacer esto:

_crtBreakAlloc = 18;

O bien

_CrtSetBreakAlloc(18);

Comparar diferentes estados de memoria

Otra técnica para localizar pérdidas de memoria requiere tomar instantáneas del estado de la memoria de la aplicación en determinados puntos clave.Para tomar una instantánea del estado de la memoria en un punto determinado de la aplicación, cree una estructura _CrtMemState y pásela a la función _CrtMemCheckpoint.Esta función rellena la estructura con una instantánea del estado actual de la memoria:

_CrtMemState s1;
_CrtMemCheckpoint( &s1 );

_CrtMemCheckpoint rellena la estructura con una instantánea del estado actual de la memoria.

Para generar el contenido de una estructura _CrtMemState, pase la estructura a la función _ CrtMemDumpStatistics:

_CrtMemDumpStatistics( &s1 );

_ CrtMemDumpStatistics genera un volcado de memoria del estado de la memoria con esta apariencia:

0 bytes in 0 Free Blocks.
0 bytes in 0 Normal Blocks.
3071 bytes in 16 CRT Blocks.
0 bytes in 0 Ignore Blocks.
0 bytes in 0 Client Blocks.
Largest number used: 3071 bytes.
Total allocations: 3764 bytes.

Para determinar si se ha producido una pérdida de memoria en una sección de código, puede tomar instantáneas del estado de la memoria antes y después de la sección y, a continuación, utilizar _ CrtMemDifference para comparar los dos estados:

_CrtMemCheckpoint( &s1 );
// memory allocations take place here
_CrtMemCheckpoint( &s2 );

if ( _CrtMemDifference( &s3, &s1, &s2) )
   _CrtMemDumpStatistics( &s3 );

_CrtMemDifference compara los estados de la memoria s1 y s2 y devuelve un resultado en (s3) que es la diferencia de s1 y s2.

Una técnica para buscar pérdidas de memoria empieza realizando llamadas a _CrtMemCheckpoint al principio y al final de la aplicación y, a continuación, utilizando _CrtMemDifference para comparar los resultados.Si _CrtMemDifference muestra una pérdida de memoria, puede agregar más llamadas a _CrtMemCheckpoint para dividir el programa mediante una búsqueda binaria hasta que haya aislado el origen de la pérdida.

Falsos positivos

En algunos casos, _CrtDumpMemoryLeaks puede ofrecer indicaciones falsas de pérdidas de memoria.Esto podría ocurrir si se usa una biblioteca que marca las asignaciones internas como _NORMAL_BLOCK en lugar de como _CRT_BLOCK o _CLIENT_BLOCK.En tal caso, _CrtDumpMemoryLeaks no puede distinguir entre las asignaciones del usuario y las asignaciones de la biblioteca internas.Si los destructores globales de las asignaciones de biblioteca se ejecutan después del punto donde se llamó a _CrtDumpMemoryLeaks, cada asignación interna de la biblioteca se notifica como pérdida de memoria.Las versiones de la Biblioteca de plantillas estándar anteriores a Visual Studio .NET, hacían que _CrtDumpMemoryLeaks notificase pérdidas de memoria falsas, pero esto se ha solucionado en versiones más recientes.