heap.h

Go to the documentation of this file.

/*
 Copyright (C) 2009 Sung Ho Park
 Contact: ubinos.org@gmail.com
 
 This file is part of the itf_ubinos component of the Ubinos.
 
 GNU General Public License Usage
 This file may be used under the terms of the GNU
 General Public License version 3.0 as published by the Free Software
 Foundation and appearing in the file license_gpl3.txt included in the
 packaging of this file. Please review the following information to
 ensure the GNU General Public License version 3.0 requirements will be
 met: http://www.gnu.org/copyleft/gpl.html.
 
 GNU Lesser General Public License Usage
 Alternatively, this file may be used under the terms of the GNU Lesser
 General Public License version 2.1 as published by the Free Software
 Foundation and appearing in the file license_lgpl.txt included in the
 packaging of this file. Please review the following information to
 ensure the GNU Lesser General Public License version 2.1 requirements
 will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
 Commercial Usage
 Alternatively, licensees holding valid commercial licenses may
 use this file in accordance with the commercial license agreement
 provided with the software or, alternatively, in accordance with the
 terms contained in a written agreement between you and rightful owner.
 */
 
#ifndef UBICLIB_HEAP_H_
#define UBICLIB_HEAP_H_
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
#include <ubinos_config.h>
#include <ubinos/type.h>
 
#define HEAP_ERR__POLLUTED_TOP          -21
 
#define HEAP_ERR__POLLUTED_BOTTOM       -22
 
#define HEAP_ERR__POLLUTED_HEADER       -23
 
#define HEAP_ERR__UNSUPPORTED           -24
 
typedef struct __heap_tip_t
{
    unsigned int type :8; 
    unsigned int valid :1; 
    unsigned int reserved :7; 
    unsigned int reserved2 :16; 
} _heap_tip_t;
 
typedef _heap_tip_t * heap_pt;
 
int ubiclib_heap_comp_init(unsigned int addr, unsigned int size);
 
int ubiclib_heap_comp_init_reent(void);
 
int heap_create(heap_pt * heap_p, unsigned int addr, unsigned int size);
 
int heap_create_ext(heap_pt * heap_p, unsigned int addr, unsigned int size,
        int algorithm0, int locktype0, unsigned int m0, unsigned int fblcount0,
        int algorithm1, int locktype1, unsigned int m1, unsigned int fblcount1);
 
int heap_delete(heap_pt * heap_p);
 
void * heap_malloc(heap_pt heap, unsigned int size);
 
void * heap_mallocn(heap_pt heap, unsigned int size);
 
void * heap_mallocr(heap_pt heap, unsigned int size);
 
int heap_free(heap_pt heap, void * ptr);
 
int heap_checkblockboundary(heap_pt heap, void * ptr);
 
int heap_checkblockboundaryall(heap_pt heap);
 
int heap_getblocksize(heap_pt heap, void * ptr, unsigned int * size_p);
 
void * mallocn(size_t size);
 
void * mallocr(size_t size);
 
int heap_getsize(heap_pt heap, unsigned int * size_p);
 
int heap_getrequestedsize(heap_pt heap, unsigned int * size_p);
 
int heap_getrequestedsize_ext(heap_pt heap, unsigned int * size_p,
        unsigned int * nsize_p, unsigned int * rsize_p);
 
int heap_getrequestedsizemax(heap_pt heap, unsigned int * size_p);
 
int heap_getrequestedsizemax_ext(heap_pt heap, unsigned int * size_p,
        unsigned int * nsize_p, unsigned int * rsize_p);
 
int heap_getallocatedcount(heap_pt heap, unsigned int * count_p);
 
int heap_getallocatedcount_ext(heap_pt heap, unsigned int * count_p,
        unsigned int * ncount_p, unsigned int * rcount_p);
 
int heap_getallocatedcountmax(heap_pt heap, unsigned int * count_p);
 
int heap_getallocatedcountmax_ext(heap_pt heap, unsigned int * count_p,
        unsigned int * ncount_p, unsigned int * rcount_p);
 
int heap_getallocatedsize(heap_pt heap, unsigned int * size_p);
 
int heap_getallocatedsize_ext(heap_pt heap, unsigned int * size_p,
        unsigned int * nsize_p, unsigned int * rsize_p);
 
int heap_getallocatedsizemax(heap_pt heap, unsigned int * size_p);
 
int heap_getallocatedsizemax_ext(heap_pt heap, unsigned int * size_p,
        unsigned int * nsize_p, unsigned int * rsize_p);
 
int heap_getfreeblockcount(heap_pt heap, unsigned int * count_p);
 
int heap_getfreeblockcount_ext(heap_pt heap, unsigned int * count_p,
        unsigned int * ncount_p, unsigned int * rcount_p);
 
int heap_getblockoverhead(heap_pt heap, unsigned int * overhead_p);
 
int heap_printheapinfo(heap_pt heap);
 
unsigned int heap_group_calc_fblcount(unsigned int size, unsigned int m);
 
unsigned int heap_wbuddy_calc_fblcount(unsigned int size, unsigned int m);
 
unsigned int heap_pgroup_calc_fblcount(unsigned int size, unsigned int m);
 
#ifdef  __cplusplus
}
#endif
 
#endif /* UBICLIB_HEAP_H_ */