malloc.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * COPYRIGHT (c) 1989-2011.
 * On-Line Applications Research Corporation (OAR).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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 _RTEMS_MALLOC_H
#define _RTEMS_MALLOC_H
 
#include <rtems.h>
#include <rtems/bspIo.h>
#include <rtems/libcsupport.h> /* for malloc_walk() */
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern Heap_Control *RTEMS_Malloc_Heap;
 
void _Malloc_Initialize( void );
 
typedef void *(*rtems_heap_extend_handler)(
  Heap_Control *heap,
  size_t alloc_size
);
 
void *rtems_heap_extend_via_sbrk(
  Heap_Control *heap,
  size_t alloc_size
);
 
void *rtems_heap_null_extend(
  Heap_Control *heap,
  size_t alloc_size
);
 
extern const rtems_heap_extend_handler rtems_malloc_extend_handler;
 
/*
 * Malloc Plugin to Dirty Memory at Allocation Time
 */
typedef void (*rtems_malloc_dirtier_t)(void *, size_t);
extern rtems_malloc_dirtier_t rtems_malloc_dirty_helper;
 
void rtems_heap_set_sbrk_amount( ptrdiff_t sbrk_amount );
 
void rtems_heap_sbrk_greedy_allocate(
  Heap_Control *heap,
  size_t alloc_size
);
 
void rtems_malloc_dirty_memory(
  void   *start,
  size_t  size
);
 
int rtems_memalign(
  void   **pointer,
  size_t   alignment,
  size_t   size
);
 
void *rtems_heap_allocate_aligned_with_boundary(
  size_t size,
  uintptr_t alignment,
  uintptr_t boundary
) RTEMS_MALLOCLIKE RTEMS_ALLOC_SIZE(1) RTEMS_ALLOC_ALIGN(2)
  RTEMS_WARN_UNUSED_RESULT;
 
void *rtems_malloc(size_t size)
  RTEMS_MALLOCLIKE RTEMS_ALLOC_SIZE(1) RTEMS_WARN_UNUSED_RESULT;
 
void *rtems_calloc(size_t nelem, size_t elsize)
  RTEMS_MALLOCLIKE RTEMS_ALLOC_SIZE_2(1, 2) RTEMS_WARN_UNUSED_RESULT;
 
rtems_status_code rtems_heap_extend(
  void *area_begin,
  uintptr_t area_size
);
 
void *rtems_heap_greedy_allocate(
  const uintptr_t *block_sizes,
  size_t block_count
);
 
void *rtems_heap_greedy_allocate_all_except_largest(
  uintptr_t *allocatable_size
);
 
void rtems_heap_greedy_free( void *opaque );
 
#ifdef __cplusplus
}
#endif
 
#endif