packages/services/memalloc/common/v2_0/src/memfixed.cxx

   1 //==========================================================================
   2 //
   3 //      memfixed.cxx
   4 //
   5 //      Memory pool with fixed block class declarations
   6 //
   7 //==========================================================================
   8 //####ECOSGPLCOPYRIGHTBEGIN####
   9 // -------------------------------------------
  10 // This file is part of eCos, the Embedded Configurable Operating System.
  11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  12 //
  13 // eCos is free software; you can redistribute it and/or modify it under
  14 // the terms of the GNU General Public License as published by the Free
  15 // Software Foundation; either version 2 or (at your option) any later version.
  16 //
  17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 // for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License along
  23 // with eCos; if not, write to the Free Software Foundation, Inc.,
  24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 //
  26 // As a special exception, if other files instantiate templates or use macros
  27 // or inline functions from this file, or you compile this file and link it
  28 // with other works to produce a work based on this file, this file does not
  29 // by itself cause the resulting work to be covered by the GNU General Public
  30 // License. However the source code for this file must still be made available
  31 // in accordance with section (3) of the GNU General Public License.
  32 //
  33 // This exception does not invalidate any other reasons why a work based on
  34 // this file might be covered by the GNU General Public License.
  35 //
  36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 // at http://sources.redhat.com/ecos/ecos-license/
  38 // -------------------------------------------
  39 //####ECOSGPLCOPYRIGHTEND####
  40 //==========================================================================
  41 //#####DESCRIPTIONBEGIN####
  42 //
  43 // Author(s):    hmt
  44 // Contributors: jlarmour
  45 // Date:         2000-06-16
  46 // Purpose:      Define Memfixed class interface
  47 // Description:  Inline class for constructing a fixed block allocator
  48 // Usage:        #include <cyg/memalloc/memfixed.hxx>
  49 //
  50 //
  51 //####DESCRIPTIONEND####
  52 //
  53 //==========================================================================
  54
  55 // CONFIGURATION
  56
  57 #include <pkgconf/memalloc.h>
  58 #include <pkgconf/system.h>
  59 #ifdef CYGPKG_KERNEL
  60 # include <pkgconf/kernel.h>
  61 #endif
  62
  63
  64 // INCLUDES
  65
  66 #include <cyg/infra/cyg_type.h>        // types
  67 #include <cyg/infra/cyg_ass.h>         // assertion macros
  68 #include <cyg/infra/cyg_trac.h>        // tracing macros
  69
  70 #ifdef CYGFUN_KERNEL_THREADS_TIMER
  71 # include <cyg/kernel/ktypes.h>        // cyg_tick_count
  72 #endif
  73
  74 #ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE
  75 // tell it to optimize for the fixed block one-to-one case
  76 # define CYGIMP_MEM_T_ONEFREE_TO_ONEALLOC
  77 # include <cyg/memalloc/mempolt2.hxx>  // kernel safe mempool template
  78 #endif
  79
  80 #include <cyg/memalloc/memfixed.hxx>
  81 #include <cyg/memalloc/mfiximpl.hxx>   // implementation of a fixed mem pool
  82 #include <cyg/memalloc/common.hxx>     // Common memory allocator infra
  83
  84 // -------------------------------------------------------------------------
  85 // debugging/assert function
  86
  87 #ifdef CYGDBG_USE_ASSERTS
  88 cyg_bool
  89 Cyg_Mempool_Fixed::check_this(cyg_assert_class_zeal zeal) const
  90 {
  91     CYG_REPORT_FUNCTION();
  92     // check that we have a non-NULL pointer first
  93     if( this == NULL ) return false;
  94 #ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE
  95     return mypool.check_this( zeal );
  96 #else
  97     return true;
  98 #endif
  99 }
 100 #endif
 101
 102 // -------------------------------------------------------------------------
 103 // Constructor: gives the base and size of the arena in which memory is
 104 // to be carved out, note that management structures are taken from the
 105 // same arena.  Alloc_unit is the blocksize allocated.
 106 Cyg_Mempool_Fixed::Cyg_Mempool_Fixed(
 107     cyg_uint8 *base,
 108     cyg_int32 size,
 109     CYG_ADDRWORD alloc_unit )
 110     : mypool( base, size, alloc_unit )
 111 {
 112 }
 113
 114 // Destructor
 115 Cyg_Mempool_Fixed::~Cyg_Mempool_Fixed()
 116 {
 117 }
 118
 119 // -------------------------------------------------------------------------
 120 // get some memory; wait if none available
 121 #ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE
 122 cyg_uint8 *
 123 Cyg_Mempool_Fixed::alloc()
 124 {
 125     return mypool.alloc( 0 );
 126 }
 127
 128 # ifdef CYGFUN_KERNEL_THREADS_TIMER
 129 // get some memory with a timeout
 130 cyg_uint8 *
 131 Cyg_Mempool_Fixed::alloc(cyg_tick_count delay_timeout )
 132 {
 133     return mypool.alloc( 0, delay_timeout );
 134 }
 135 # endif
 136 #endif
 137
 138 // get some memory, return NULL if none available
 139 cyg_uint8 *
 140 Cyg_Mempool_Fixed::try_alloc()
 141 {
 142     return mypool.try_alloc( 0 );
 143 }
 144
 145 // free the memory back to the pool
 146 cyg_bool
 147 Cyg_Mempool_Fixed::free( cyg_uint8 *p )
 148 {
 149     return mypool.free( p, 0 );
 150 }
 151
 152 // supposedly resize existing allocation. This is defined in the
 153 // fixed block allocator purely for API consistency. It will return
 154 // an error (false) for all values, except for the blocksize
 155 // returns true on success
 156 cyg_uint8 *
 157 Cyg_Mempool_Fixed::resize_alloc( cyg_uint8 *alloc_ptr, cyg_int32 newsize,
 158                                  cyg_int32 *oldsize )
 159 {
 160     return mypool.resize_alloc( alloc_ptr, newsize, oldsize );
 161 }
 162
 163 // Get memory pool status
 164 void
 165 Cyg_Mempool_Fixed::get_status( cyg_mempool_status_flag_t flags,
 166                                Cyg_Mempool_Status &status )
 167 {
 168     // set to 0 - if there's anything really waiting, it will be set to
 169     // 1 later
 170     status.waiting = 0;
 171
 172     return mypool.get_status( flags, status );
 173 }
 174
 175 // -------------------------------------------------------------------------
 176
 177 // End of memfixed.cxx