From 354c2b50a3d707bbdf8d5b553869062cdedaf4fb Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Wed, 8 Apr 2020 11:30:32 +0200
Subject: score: Add <rtems/score/freechainimpl.h>

Hide implementation details.

Update #3959.
---
 cpukit/include/rtems/score/freechain.h | 124 +--------------------------------
 1 file changed, 1 insertion(+), 123 deletions(-)

(limited to 'cpukit/include/rtems/score/freechain.h')

diff --git a/cpukit/include/rtems/score/freechain.h b/cpukit/include/rtems/score/freechain.h
index ab1e8150da..7db1101cff 100644
--- a/cpukit/include/rtems/score/freechain.h
+++ b/cpukit/include/rtems/score/freechain.h
@@ -16,8 +16,7 @@
 #ifndef _RTEMS_SCORE_FREECHAIN_H
 #define _RTEMS_SCORE_FREECHAIN_H
 
-#include <rtems/score/basedefs.h>
-#include <rtems/score/chainimpl.h>
+#include <rtems/score/chain.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -37,11 +36,6 @@ extern "C" {
  * @{
  */
 
-/**
- * @brief Allocator function.
- */
-typedef void *( *Freechain_Allocator )( size_t size );
-
 /**
  * @brief The freechain control.
  */
@@ -52,122 +46,6 @@ typedef struct {
   Chain_Control Free;
 } Freechain_Control;
 
-/**
- * @brief Initializes a freechain.
- *
- * This routine initializes the freechain control structure to manage a chain
- * of nodes.  In the case the freechain is empty the extend handler is called to
- * get more nodes.
- *
- * @param[out] freechain The freechain control to initialize.
- * @param[out] initial_nodes Array with the initial nodes.
- * @param number_nodes The initial number of nodes.
- * @param node_size The node size.
- */
-RTEMS_INLINE_ROUTINE void _Freechain_Initialize(
-  Freechain_Control   *freechain,
-  void                *initial_nodes,
-  size_t               number_nodes,
-  size_t               node_size
-)
-{
-  _Chain_Initialize(
-    &freechain->Free,
-    initial_nodes,
-    number_nodes,
-    node_size
-  );
-}
-
-/**
- * @brief Return true if the freechain is empty, otherwise false
- *
- * @param freechain The freechain control.
- */
-RTEMS_INLINE_ROUTINE bool _Freechain_Is_empty(
-  const Freechain_Control *freechain
-)
-{
-  return _Chain_Is_empty( &freechain->Free );
-}
-
-/**
- * @brief Pops a node from the freechain.
- *
- * The freechain shall not be empty.
- *
- * @param freechain The freechain control.
- */
-RTEMS_INLINE_ROUTINE void *_Freechain_Pop( Freechain_Control *freechain )
-{
-  return _Chain_Get_first_unprotected( &freechain->Free );
-}
-
-/**
- * @brief Pushes a node back to the freechain.
- *
- * @param freechain The freechain control.
- * @param node The node to push back.  The node shall not be @c NULL.
- */
-void RTEMS_INLINE_ROUTINE _Freechain_Push(
-  Freechain_Control *freechain,
-  void              *node
-)
-{
-  _Chain_Initialize_node( node );
-  _Chain_Prepend_unprotected( &freechain->Free, node );
-}
-
-/**
- * @brief Extend the freechain with new nodes.
- *
- * @param freechain The freechain control.
- * @param allocator The allocator function.
- * @param number_nodes_to_extend The number of nodes to extend.
- * @param node_size The node size.
- *
- * @retval NULL The extend operation failed.
- * @retval nodes Pointer to the new nodes.
- */
-void *_Freechain_Extend(
-  Freechain_Control   *freechain,
-  Freechain_Allocator  allocator,
-  size_t               number_nodes_to_extend,
-  size_t               node_size
-);
-
-/**
- * @brief Gets a node from the freechain.
- *
- * @param[in, out] freechain The freechain control.
- * @param allocator The allocator function.
- * @param number_nodes_to_extend The number of nodes in the case an extend is
- *   necessary due to an empty freechain.
- * @param[in] node_size The node size.
- *
- * @retval NULL The freechain is empty and the extend operation failed.
- * @retval pointer Pointer to a node.  The node ownership passes to the
- * caller.
- */
-void *_Freechain_Get(
-  Freechain_Control   *freechain,
-  Freechain_Allocator  allocator,
-  size_t               number_nodes_to_extend,
-  size_t               node_size
-);
-
-/**
- * @brief Puts a node back onto the freechain.
- *
- * @param[in, out] freechain The freechain control.
- * @param[out] node The node to put back.  The node may be @c NULL, in this case
- *   the function does nothing.
- */
-void _Freechain_Put(
-  Freechain_Control *freechain,
-  void              *node
-);
-
 /** @} */
 
 #ifdef __cplusplus
-- 
cgit v1.2.3