score/src/freechain.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreFreechain
0007  *
0008  * @brief This source file contains the implementation of
0009  *   _Freechain_Extend(), _Freechain_Get(), and _Freechain_Put().
0010  */
0011
0012 /*
0013  * Copyright (c) 2013 Gedare Bloom.
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifdef HAVE_CONFIG_H
0038 #include "config.h"
0039 #endif
0040
0041 #include <rtems/score/freechainimpl.h>
0042 #include <rtems/score/assert.h>
0043
0044 void *_Freechain_Extend(
0045   Freechain_Control   *freechain,
0046   Freechain_Allocator  allocator,
0047   size_t               number_nodes_to_extend,
0048   size_t               node_size
0049 )
0050 {
0051   void *starting_address;
0052
0053   starting_address = ( *allocator )( number_nodes_to_extend * node_size );
0054   number_nodes_to_extend *= ( starting_address != NULL );
0055
0056   _Chain_Initialize(
0057     &freechain->Free,
0058     starting_address,
0059     number_nodes_to_extend,
0060     node_size
0061   );
0062
0063   return starting_address;
0064 }
0065
0066 void *_Freechain_Get(
0067   Freechain_Control   *freechain,
0068   Freechain_Allocator  allocator,
0069   size_t               number_nodes_to_extend,
0070   size_t               node_size
0071 )
0072 {
0073   _Assert( node_size >= sizeof( Chain_Node ) );
0074
0075   if ( _Chain_Is_empty( &freechain->Free ) && number_nodes_to_extend > 0 ) {
0076     _Freechain_Extend(
0077       freechain,
0078       allocator,
0079       number_nodes_to_extend,
0080       node_size
0081     );
0082   }
0083
0084   return _Chain_Get_unprotected( &freechain->Free );
0085 }
0086
0087 void _Freechain_Put( Freechain_Control *freechain, void *node )
0088 {
0089   if ( node != NULL ) {
0090     _Freechain_Push( freechain, node );
0091   }
0092 }