heapgetfreeinfo.c

RTEMS (Real-Time Executive for Multiprocessor Systems) is a free open source real-time operating sys

/*
 *  Heap Handler
 *
 *  COPYRIGHT (c) 1989-2004.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.com/license/LICENSE.
 *
 *  $Id: heapgetfreeinfo.c,v 1.4.2.1 2005/05/13 17:13:09 jennifer Exp $
 */


#include <rtems/system.h>
#include <rtems/score/sysstate.h>
#include <rtems/score/heap.h>

/*PAGE
 *
 *  _Heap_Get_free_information
 *
 *  This heap routine returns information about the free blocks
 *  in the specified heap.
 *
 *  Input parameters:
 *    the_heap  - pointer to heap header.
 *    info      - pointer to the free block information.
 *
 *  Output parameters:
 *    returns - free block information filled in.
 */

void _Heap_Get_free_information(
  Heap_Control        *the_heap,
  Heap_Information    *info
)
{
  Heap_Block *the_block;

  info->number  = 0;
  info->largest = 0;
  info->total   = 0;

  for ( the_block = the_heap->first ; ; the_block = the_block->next ) {
    if ( the_block == _Heap_Tail( the_heap ) )
      return;
    
    info->number++;
    info->total += the_block->front_flag;

    if ( the_block->front_flag > info->largest )
      info->largest = the_block->front_flag;
  }
}