source: SVN/cambria/redboot/packages/services/memalloc/common/current/include/sepmeta.hxx @ 1

Last change on this file since 1 was 1, checked in by Tim Harvey, 2 years ago

restored latest version of files from server backup

Signed-off-by: Tim Harvey <tharvey@…>

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