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

   1 #ifndef CYGONCE_MEMALLOC_MEMVAR_HXX
   2 #define CYGONCE_MEMALLOC_MEMVAR_HXX
   3
   4 //==========================================================================
   5 //
   6 //      memvar.hxx
   7 //
   8 //      Memory pool with variable 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):    dsm, jlarmour
  47 // Contributors:
  48 // Date:         2000-06-12
  49 // Purpose:      Define Memvar class interface
  50 // Description:  Inline class for constructing a variable block allocator
  51 // Usage:        #include <cyg/memalloc/memvar.hxx>
  52 //
  53 //
  54 //####DESCRIPTIONEND####
  55 //
  56 //==========================================================================
  57
  58 // CONFIGURATION
  59
  60 #include <pkgconf/memalloc.h>
  61 #ifdef CYGSEM_MEMALLOC_ALLOCATOR_VARIABLE_THREADAWARE
  62 # include <pkgconf/system.h>
  63 # ifdef CYGPKG_KERNEL
  64 #  include <pkgconf/kernel.h>
  65 # endif
  66 #endif
  67
  68 // when used as an implementation for malloc, we need the following
  69 // to let the system know the name of the class
  70 #define CYGCLS_MEMALLOC_MALLOC_IMPL Cyg_Mempool_Variable
  71
  72 // if the implementation is all that's required, don't output anything else
  73 #ifndef __MALLOC_IMPL_WANTED
  74 // INCLUDES
  75
  76 #include <cyg/infra/cyg_type.h>        // types
  77 #include <cyg/infra/cyg_ass.h>         // assertion macros
  78
  79 #ifdef CYGFUN_KERNEL_THREADS_TIMER
  80 # include <cyg/kernel/ktypes.h>        // cyg_tick_count
  81 #endif
  82
  83 #ifdef CYGSEM_MEMALLOC_ALLOCATOR_VARIABLE_THREADAWARE
  84 # include <cyg/memalloc/mempolt2.hxx>  // kernel safe mempool template
  85 #endif
  86
  87 #include <cyg/memalloc/mvarimpl.hxx>   // implementation of a variable mem pool
  88 #include <cyg/memalloc/common.hxx>     // Common memory allocator infra
  89
  90
  91 // TYPE DEFINITIONS
  92
  93 class Cyg_Mempool_Variable
  94 {
  95 protected:
  96 #ifdef CYGSEM_MEMALLOC_ALLOCATOR_VARIABLE_THREADAWARE
  97     Cyg_Mempolt2<Cyg_Mempool_Variable_Implementation> mypool;
  98 #else
  99     Cyg_Mempool_Variable_Implementation mypool;
 100 #endif
 101
 102 public:
 103     // This API makes concrete a class which implements a thread-safe
 104     // kernel-savvy memory pool which manages variable size blocks.
 105
 106     // Constructor: gives the base and size of the arena in which memory is
 107     // to be carved out, note that management structures are taken from the
 108     // same arena.
 109     Cyg_Mempool_Variable( cyg_uint8 * /* base */, cyg_int32  /* size */,
 110                           cyg_int32 /* alignment */=8);
 111
 112     // Destructor
 113     ~Cyg_Mempool_Variable();
 114
 115     // get some memory; wait if none available
 116     // if we aren't configured to be thread-aware this is irrelevant
 117 #ifdef CYGSEM_MEMALLOC_ALLOCATOR_VARIABLE_THREADAWARE
 118     cyg_uint8 *
 119     alloc( cyg_int32 /* size */ );
 120
 121 # ifdef CYGFUN_KERNEL_THREADS_TIMER
 122     // get some memory with a timeout
 123     cyg_uint8 *
 124     alloc( cyg_int32 /* size */, cyg_tick_count /* delay_timeout */ );
 125 # endif
 126 #endif
 127
 128     // get some memory, return NULL if none available
 129     cyg_uint8 *
 130     try_alloc( cyg_int32 /* size */ );
 131
 132     // resize existing allocation, if oldsize is non-NULL, previous
 133     // allocation size is placed into it. If previous size not available,
 134     // it is set to 0. NB previous allocation size may have been rounded up.
 135     // Occasionally the allocation can be adjusted *backwards* as well as,
 136     // or instead of forwards, therefore the address of the resized
 137     // allocation is returned, or NULL if no resizing was possible.
 138     // Note that this differs from ::realloc() in that no attempt is
 139     // made to call malloc() if resizing is not possible - that is left
 140     // to higher layers. The data is copied from old to new though.
 141     // The effects of alloc_ptr==NULL or newsize==0 are undefined
 142     cyg_uint8 *
 143     resize_alloc( cyg_uint8 * /* alloc_ptr */, cyg_int32 /* newsize */,
 144                   cyg_int32 * /* oldsize */ =NULL );
 145
 146     // free the memory back to the pool
 147     // returns true on success
 148     cyg_bool
 149     free( cyg_uint8 * /* ptr */, cyg_int32 /* size */ =0 );
 150
 151     // Get memory pool status
 152     // flags is a bitmask of requested fields to fill in. The flags are
 153     // defined in common.hxx
 154     void
 155     get_status( cyg_mempool_status_flag_t /* flags */,
 156                 Cyg_Mempool_Status & /* status */ );
 157
 158     CYGDBG_DEFINE_CHECK_THIS
 159 };
 160
 161 #endif // ifndef __MALLOC_IMPL_WANTED
 162
 163 #endif // ifndef CYGONCE_MEMALLOC_MEMVAR_HXX
 164 // EOF memvar.hxx