_heapwalk

Выполняет обход кучи и возвращает сведения о следующей записи.

Важно!

Этот API нельзя использовать в приложениях, выполняемых в среде выполнения Windows, за исключением отладочных сборок. Дополнительные сведения: Функции CRT, которые не поддерживаются в приложениях универсальной платформы Windows.

Синтаксис

int _heapwalk( _HEAPINFO *entryinfo );

Параметры

ентринфо
Буфер, который будет содержать данные кучи.

Возвращаемое значение

_heapwalk возвращает одну из следующих целочисленных констант манифеста, определенных в malloc. h.

Возвращаемое значение Значение
_HEAPBADBEGIN Начальные сведения о заголовке недопустимы или не найдены.
_HEAPBADNODE Куча повреждена или обнаружен плохой узел.
_HEAPBADPTR Поле _pentry структуры _HEAPINFO не содержит допустимого указателя на кучу, или ентринфо является пустым указателем.
_HEAPEND Успешно достигнут конец кучи.
_HEAPEMPTY Куча еще не инициализирована.
_HEAPOK Нет ошибок на данный момент; ентринфо обновляется информацией о следующей записи кучи.

Кроме того, при возникновении ошибки _heapwalkустанавливает значениееносис.

Remarks

Функция _heapwalk помогает отлаживать проблемы, связанные с кучей, в программах. Функция проходит через кучу, просматривает одну запись на вызов и возвращает указатель на структуру типа _HEAPINFO , содержащую сведения о следующей записи кучи. Тип _HEAPINFO , определенный в malloc. h, содержит следующие элементы.

Поле Значение
int *_pentry Указатель записи кучи.
size_t _size Размер записи кучи.
int _useflag Флаг, указывающий, используется ли запись кучи.

Вызов _heapwalk , который возвращает _HEAPOK сохраняет размер записи в поле _size и задает для поля _useflag значение _FREEENTRY или _USEDENTRY (оба являются константами, определенными в malloc. h). Чтобы получить эти сведения о первой записи в куче, передайте _heapwalk указатель на структуру _HEAPINFO , для которой элемент _pentry имеет значение NULL. если операционная система не поддерживает _heapwalk(например, Windows 98), функция возвращает _HEAPENDи устанавливает дляеносис.

Эта функция проверяет свои параметры. Если ентринфо является пустым указателем, вызывается обработчик недопустимых параметров, как описано в разделе Проверка параметров. Если выполнение может быть продолжено, параметру еинвалприсваивается значение, а функция возвращает _HEAPBADPTR.

Требования

Подпрограмма Обязательный заголовок Необязательный заголовок
_heapwalk <malloc.h> <о. з. h>

Дополнительные сведения о совместимости см. в разделе Compatibility.

Пример

// crt_heapwalk.c

// This program "walks" the heap, starting
// at the beginning (_pentry = NULL). It prints out each
// heap entry's use, location, and size. It also prints
// out information about the overall state of the heap as
// soon as _heapwalk returns a value other than _HEAPOK
// or if the loop has iterated 100 times.

#include <stdio.h>
#include <malloc.h>

void heapdump(void);

int main(void)
{
    char *buffer;

    heapdump();
    if((buffer = (char *)malloc(59)) != NULL)
    {
        heapdump();
        free(buffer);
    }
    heapdump();
}

void heapdump(void)
{
    _HEAPINFO hinfo;
    int heapstatus;
    int numLoops;
    hinfo._pentry = NULL;
    numLoops = 0;
    while((heapstatus = _heapwalk(&hinfo)) == _HEAPOK &&
          numLoops < 100)
    {
        printf("%8s block at %Fp of size %4.4X\n",
               (hinfo._useflag == _USEDENTRY ? "USED" : "FREE"),
               hinfo._pentry, hinfo._size);
        numLoops++;
    }

    switch(heapstatus)
    {
    case _HEAPEMPTY:
        printf("OK - empty heap\n");
        break;
    case _HEAPEND:
        printf("OK - end of heap\n");
        break;
    case _HEAPBADPTR:
        printf("ERROR - bad pointer to heap\n");
        break;
    case _HEAPBADBEGIN:
        printf("ERROR - bad start of heap\n");
        break;
    case _HEAPBADNODE:
        printf("ERROR - bad node in heap\n");
        break;
    }
}
    USED block at 00310650 of size 0100
    USED block at 00310758 of size 0800
    USED block at 00310F60 of size 0080
    FREE block at 00310FF0 of size 0398
    USED block at 00311390 of size 000D
    USED block at 003113A8 of size 00B4
    USED block at 00311468 of size 0034
    USED block at 003114A8 of size 0039
...
    USED block at 00312228 of size 0010
    USED block at 00312240 of size 1000
    FREE block at 00313250 of size 1DB0
OK - end of heap

См. также раздел

Выделение памяти
_heapadd
_heapchk
_heapmin
_heapset