MEM_guardedalloc.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef MEM_MALLOCN_H
#define MEM_MALLOCN_H

#include <stdio.h> /* needed for FILE* */
#include "MEM_sys_types.h" /* needed for uintptr_t */

#ifndef WARN_UNUSED
#  ifdef __GNUC__
#    define WARN_UNUSED  __attribute__((warn_unused_result))
#  else
#    define WARN_UNUSED
#  endif
#endif

#ifdef __cplusplus
extern "C" {
#endif

    size_t MEM_allocN_len(void *vmemh) WARN_UNUSED;

    short MEM_freeN(void *vmemh);


    short MEM_testN(void *vmemh);

    void *MEM_dupallocN(void *vmemh) WARN_UNUSED;

    void *MEM_reallocN(void *vmemh, size_t len) WARN_UNUSED;

    void *MEM_callocN(size_t len, const char * str) WARN_UNUSED;
    
    void *MEM_mallocN(size_t len, const char * str) WARN_UNUSED;
    
    void *MEM_mapallocN(size_t len, const char * str) WARN_UNUSED;

    void MEM_printmemlist_pydict(void);

    void MEM_printmemlist(void);

    void MEM_callbackmemlist(void (*func)(void*));

    void MEM_printmemlist_stats(void);
    
    void MEM_set_error_callback(void (*func)(const char *));

    int MEM_check_memory_integrity(void);

    void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
    
    void MEM_set_memory_debug(void);

    uintptr_t MEM_get_memory_in_use(void);
    uintptr_t MEM_get_mapped_memory_in_use(void);
    int MEM_get_memory_blocks_in_use(void);

    void MEM_reset_peak_memory(void);

    uintptr_t MEM_get_peak_memory(void) WARN_UNUSED;

#ifndef NDEBUG
const char *MEM_name_ptr(void *vmemh);
#endif
    
#ifdef __cplusplus
}
#endif

#endif