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

   1 #ifndef CYGONCE_MEMALLOC_MVARIMPL_HXX
   2 #define CYGONCE_MEMALLOC_MVARIMPL_HXX
   3
   4 //==========================================================================
   5 //
   6 //      mvarimpl.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 Mvarimpl class interface
  50 // Description:  Inline class for constructing a variable block allocator
  51 // Usage:        #include <cyg/memalloc/mvarimpl.hxx>
  52 //
  53 //
  54 //####DESCRIPTIONEND####
  55 //
  56 //==========================================================================
  57
  58
  59 #include <cyg/infra/cyg_type.h>
  60 #include <pkgconf/memalloc.h>
  61 #include <cyg/memalloc/common.hxx>     // Common memory allocator infra
  62
  63 class Cyg_Mempool_Variable_Implementation {
  64 protected:
  65     // these constructors are explicitly disallowed
  66     Cyg_Mempool_Variable_Implementation() {};
  67 //    Cyg_Mempool_Variable_Implementation( Cyg_Mempool_Variable_Implementation &ref )
  68 //    {};
  69     Cyg_Mempool_Variable_Implementation &
  70     operator=( Cyg_Mempool_Variable_Implementation &ref )
  71     { return ref; };
  72
  73     struct memdq {
  74         struct memdq *prev, *next;
  75         cyg_int32 size;
  76     };
  77
  78     struct memdq head;
  79     cyg_uint8  *obase;
  80     cyg_int32  osize;
  81     cyg_uint8  *bottom;
  82     cyg_uint8  *top;
  83     cyg_int32  alignment;
  84     cyg_int32  freemem;
  85
  86     // round up size passed to alloc/free to a size that will be used
  87     // for allocation
  88     cyg_int32
  89     roundup(cyg_int32 size);
  90
  91     struct memdq *
  92     addr2memdq( cyg_uint8 *addr );
  93
  94     struct memdq *
  95     alloc2memdq( cyg_uint8 *addr );
  96
  97     cyg_uint8 *
  98     memdq2alloc( struct memdq *dq );
  99
 100     void
 101     insert_free_block( struct memdq *freedq );
 102
 103 public:
 104     // THIS is the public API of memory pools generally that can have the
 105     // kernel oriented thread-safe package layer atop.
 106
 107     // Constructor: gives the base and size of the arena in which memory is
 108     // to be carved out.
 109     Cyg_Mempool_Variable_Implementation(
 110         cyg_uint8 *  /* base */,
 111         cyg_int32    /* size */,
 112         CYG_ADDRWORD /* alignment */ = 8 );
 113
 114     // Destructor
 115     ~Cyg_Mempool_Variable_Implementation();
 116
 117     // get size bytes of memory
 118     cyg_uint8 *
 119     try_alloc( cyg_int32 /* size */ );
 120
 121     // resize existing allocation, if oldsize is non-NULL, previous
 122     // allocation size is placed into it. If previous size not available,
 123     // it is set to 0. NB previous allocation size may have been rounded up.
 124     // Occasionally the allocation can be adjusted *backwards* as well as,
 125     // or instead of forwards, therefore the address of the resized
 126     // allocation is returned, or NULL if no resizing was possible.
 127     // Note that this differs from ::realloc() in that no attempt is
 128     // made to call malloc() if resizing is not possible - that is left
 129     // to higher layers. The data is copied from old to new though.
 130     // The effects of alloc_ptr==NULL or newsize==0 are undefined
 131     cyg_uint8 *
 132     resize_alloc( cyg_uint8 *alloc_ptr, cyg_int32 newsize,
 133                   cyg_int32 *oldsize );
 134
 135     // free size bytes of memory back to the pool
 136     // returns true on success
 137     cyg_bool
 138     free( cyg_uint8 * /* ptr */,
 139           cyg_int32   /* size */ );
 140
 141     // Get memory pool status
 142     // flags is a bitmask of requested fields to fill in. The flags are
 143     // defined in common.hxx
 144     void
 145     get_status( cyg_mempool_status_flag_t /* flags */,
 146                 Cyg_Mempool_Status & /* status */ );
 147
 148 };
 149
 150 #include <cyg/memalloc/mvarimpl.inl>
 151
 152 // -------------------------------------------------------------------------
 153 #endif // ifndef CYGONCE_MEMALLOC_MVARIMPL_HXX
 154 // EOF mvarimpl.hxx