malloc_extras.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 The University of Manchester
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __MALLOC_EXTRAS_H__
#define __MALLOC_EXTRAS_H__
 
#include <sark.h>
#include <common-typedefs.h>
#include <debug.h>
 
typedef enum exit_states_for_user_one {
    EXITED_CLEANLY = 0,
    EXIT_FAIL = 1,
    EXIT_MALLOC = 2,
    EXIT_SWERR = 3,
    DETECTED_MALLOC_FAILURE = 4
} exit_states_for_user_one;
 
// ===========================================================================
 
void malloc_extras_turn_on_print(void);
 
void malloc_extras_turn_off_print(void);
 
void malloc_extras_terminate(uint result_code);
 
void malloc_extras_free(void *ptr);
 
void *malloc_extras_sdram_malloc(uint bytes);
 
void *malloc_extras_malloc(uint bytes);
 
uint malloc_extras_max_available_block_size(void);
 
#define MALLOC          malloc_extras_malloc
#define FREE            malloc_extras_free
#define FREE_MARKED     malloc_extras_free_marked
#define MALLOC_SDRAM    malloc_extras_sdram_malloc_wrapper
 
#endif  // __PLATFORM_H__