malloc.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2026, Johannes Fetz (johannesfetz@gmail.com)
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the Johannes Fetz nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef __JO_MALLOC_H__
# define __JO_MALLOC_H__

#define JO_MALLOC_MAX_MEMORY_ZONE       (9)

typedef enum
{
    CART_NONE,
    CART_8MBits,
    CART_32MBits
}               jo_extended_ram_cartridge_type;

typedef enum
{
    JO_FAST_ALLOCATION,
    JO_MALLOC_TRY_REUSE_BLOCK,
    JO_MALLOC_TRY_REUSE_SAME_BLOCK_SIZE
}       jo_malloc_behaviour;

void            *jo_malloc_with_behaviour(unsigned int n, const jo_malloc_behaviour behaviour);

static  __jo_force_inline void  *jo_malloc(unsigned int n)
{
    return jo_malloc_with_behaviour(n, JO_FAST_ALLOCATION);
}

void            jo_free(const void * const p);

void            jo_reduce_memory_fragmentation(void);

void            jo_add_memory_zone(unsigned char *ptr, const unsigned int size_in_bytes);
 
#ifdef JO_COMPILE_WITH_RAM_CARD_SUPPORT

static  __jo_force_inline jo_extended_ram_cartridge_type      jo_get_extended_ram_cartridge_type(void)
{
    return (JO_RAM_CARTRIDGE_ID == JO_RAM_CARTRIDGE_ID_8MBITS ? CART_8MBits :
            JO_RAM_CARTRIDGE_ID == JO_RAM_CARTRIDGE_ID_32MBITS ? CART_32MBits : CART_NONE);
}
 
#endif
 
#ifdef JO_DEBUG

int             jo_memory_usage_percent(void);

int             jo_memory_fragmentation(void);
 
#endif
 
#endif /* !__JO_MALLOC_H__ */
 
/*
** END OF FILE
*/