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

   1 #ifndef CYGONCE_MEMALLOC_MEMPOLT2_HXX
   2 #define CYGONCE_MEMALLOC_MEMPOLT2_HXX
   3
   4 //==========================================================================
   5 //
   6 //      mempolt2.hxx
   7 //
   8 //      Mempolt2 (Memory pool template) 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 Mempolt2 class interface
  50 // Description:  The class defined here provides the APIs for thread-safe,
  51 //               kernel-savvy memory managers; make a class with the
  52 //               underlying allocator as the template parameter.
  53 // Usage:        #include <cyg/memalloc/mempolt2.hxx>
  54 //
  55 //
  56 //####DESCRIPTIONEND####
  57 //
  58 //==========================================================================
  59
  60 // It is assumed that implementations using this file have already mandated
  61 // that the kernel is present. So we just go ahead and use it
  62
  63 #include <pkgconf/memalloc.h>
  64 #include <cyg/kernel/ktypes.h>
  65 #include <cyg/infra/cyg_ass.h>         // assertion macros
  66 #include <cyg/kernel/thread.hxx>
  67 #include <cyg/memalloc/common.hxx>     // Common memory allocator infra
  68
  69 template <class T>
  70 class Cyg_Mempolt2
  71 {
  72 private:
  73     T pool;                             // underlying memory manager
  74     Cyg_ThreadQueue queue;              // queue of waiting threads
  75
  76     class Mempolt2WaitInfo {
  77     private:
  78         Mempolt2WaitInfo() {}
  79     public:
  80         cyg_int32 size;
  81         cyg_uint8 *addr;
  82         Mempolt2WaitInfo( cyg_int32 allocsize )
  83         { size = allocsize; addr = 0; }
  84     };
  85
  86 public:
  87
  88     Cyg_Mempolt2(
  89         cyg_uint8 *base,
  90         cyg_int32 size,
  91         CYG_ADDRWORD arg_thru );        // Constructor
  92     ~Cyg_Mempolt2();                    // Destructor
  93
  94     // get some memory; wait if none available; return NULL if failed
  95     // due to interrupt
  96     cyg_uint8 *alloc( cyg_int32 size );
  97
  98 #ifdef CYGFUN_KERNEL_THREADS_TIMER
  99     // get some memory with a timeout; return NULL if failed
 100     // due to interrupt or timeout
 101     cyg_uint8 *alloc( cyg_int32 size, cyg_tick_count abs_timeout );
 102 #endif
 103
 104     // get some memory, return NULL if none available
 105     cyg_uint8 *try_alloc( cyg_int32 size );
 106
 107     // resize existing allocation, if oldsize is non-NULL, previous
 108     // allocation size is placed into it. If previous size not available,
 109     // it is set to 0. NB previous allocation size may have been rounded up.
 110     // Occasionally the allocation can be adjusted *backwards* as well as,
 111     // or instead of forwards, therefore the address of the resized
 112     // allocation is returned, or NULL if no resizing was possible.
 113     // Note that this differs from ::realloc() in that no attempt is
 114     // made to call malloc() if resizing is not possible - that is left
 115     // to higher layers. The data is copied from old to new though.
 116     // The effects of alloc_ptr==NULL or newsize==0 are undefined
 117     cyg_uint8 *
 118     resize_alloc( cyg_uint8 *alloc_ptr, cyg_int32 newsize,
 119                   cyg_int32 *oldsize );
 120
 121     // free the memory back to the pool
 122     // returns true on success
 123     cyg_bool free( cyg_uint8 *p, cyg_int32 size );
 124
 125     // Get memory pool status
 126     // flags is a bitmask of requested fields to fill in. The flags are
 127     // defined in common.hxx
 128     void get_status( cyg_mempool_status_flag_t flags,
 129                      Cyg_Mempool_Status &status );
 130
 131     CYGDBG_DEFINE_CHECK_THIS
 132
 133 };
 134
 135 #include <cyg/memalloc/mempolt2.inl>
 136
 137 // -------------------------------------------------------------------------
 138 #endif // ifndef CYGONCE_MEMALLOC_MEMPOLT2_HXX
 139 // EOF mempolt2.hxx