packages/services/memalloc/common/v2_0/include/memfixed.hxx

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