rbheap.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (c) 2012 embedded brains GmbH & Co. KG
 *
 * 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_RBHEAP_H
#define _RTEMS_RBHEAP_H
 
#include <rtems.h>
#include <rtems/chain.h>
#include <rtems/rbtree.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
  rtems_chain_node chain_node;
 
  rtems_rbtree_node tree_node;
 
  uintptr_t begin;
 
  uintptr_t size;
} rtems_rbheap_chunk;
 
typedef struct rtems_rbheap_control rtems_rbheap_control;
 
typedef void (*rtems_rbheap_extend_descriptors)(rtems_rbheap_control *control);
 
struct rtems_rbheap_control {
  rtems_chain_control free_chunk_chain;
 
  rtems_chain_control spare_descriptor_chain;
 
  rtems_rbtree_control chunk_tree;
 
  uintptr_t alignment;
 
  rtems_rbheap_extend_descriptors extend_descriptors;
 
  void *handler_arg;
};
 
rtems_status_code rtems_rbheap_initialize(
  rtems_rbheap_control *control,
  void *area_begin,
  uintptr_t area_size,
  uintptr_t alignment,
  rtems_rbheap_extend_descriptors extend_descriptors,
  void *handler_arg
);
 
void *rtems_rbheap_allocate(rtems_rbheap_control *control, size_t size);
 
rtems_status_code rtems_rbheap_free(rtems_rbheap_control *control, void *ptr);
 
static inline rtems_chain_control *rtems_rbheap_get_spare_descriptor_chain(
  rtems_rbheap_control *control
)
{
  return &control->spare_descriptor_chain;
}
 
static inline void rtems_rbheap_add_to_spare_descriptor_chain(
  rtems_rbheap_control *control,
  rtems_rbheap_chunk *chunk
)
{
  rtems_chain_control *chain =
    rtems_rbheap_get_spare_descriptor_chain(control);
 
  rtems_chain_initialize_node(&chunk->chain_node);
  rtems_chain_prepend_unprotected(chain, &chunk->chain_node);
}
 
static inline void rtems_rbheap_set_extend_descriptors(
  rtems_rbheap_control *control,
  rtems_rbheap_extend_descriptors extend_descriptors
)
{
  control->extend_descriptors = extend_descriptors;
}
 
static inline void *rtems_rbheap_get_handler_arg(
  const rtems_rbheap_control *control
)
{
  return control->handler_arg;
}
 
static inline void rtems_rbheap_set_handler_arg(
  rtems_rbheap_control *control,
  void *handler_arg
)
{
  control->handler_arg = handler_arg;
}
 
void rtems_rbheap_extend_descriptors_never(rtems_rbheap_control *control);
 
void rtems_rbheap_extend_descriptors_with_malloc(
  rtems_rbheap_control *control
);
 
/* Private API */
 
#define rtems_rbheap_chunk_of_node(node) \
  RTEMS_CONTAINER_OF(node, rtems_rbheap_chunk, tree_node)
 
static inline bool rtems_rbheap_is_chunk_free(const rtems_rbheap_chunk *chunk)
{
  return !rtems_chain_is_node_off_chain(&chunk->chain_node);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTEMS_RBHEAP_H */