Mercurial > ecos
diff packages/services/memalloc/common/current/include/memfixed.hxx @ 115:6ed91473a1cd ecos-sw-2000-08-21
Merge from eCos master repository on 2000-08-21-22:40:54-BST
| author | jlarmour |
|---|---|
| date | Fri, 25 Aug 2000 17:32:38 +0000 |
| parents | |
| children | d63db767121d |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/packages/services/memalloc/common/current/include/memfixed.hxx @@ -0,0 +1,137 @@ +#ifndef CYGONCE_MEMALLOC_MEMFIXED_HXX +#define CYGONCE_MEMALLOC_MEMFIXED_HXX + +//========================================================================== +// +// memfixed.hxx +// +// Memory pool with fixed block class declarations +// +//========================================================================== +//####COPYRIGHTBEGIN#### +// +// ------------------------------------------- +// The contents of this file are subject to the Red Hat eCos Public License +// Version 1.1 (the "License"); you may not use this file except in +// compliance with the License. You may obtain a copy of the License at +// http://www.redhat.com/ +// +// Software distributed under the License is distributed on an "AS IS" +// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the +// License for the specific language governing rights and limitations under +// the License. +// +// The Original Code is eCos - Embedded Configurable Operating System, +// released September 30, 1998. +// +// The Initial Developer of the Original Code is Red Hat. +// Portions created by Red Hat are +// Copyright (C) 1998, 1999, 2000 Red Hat, Inc. +// All Rights Reserved. +// ------------------------------------------- +// +//####COPYRIGHTEND#### +//========================================================================== +//#####DESCRIPTIONBEGIN#### +// +// Author(s): hmt +// Contributors: jlarmour +// Date: 2000-06-12 +// Purpose: Define Memfixed class interface +// Description: Inline class for constructing a fixed block allocator +// Usage: #include <cyg/memalloc/memfixed.hxx> +// +// +//####DESCRIPTIONEND#### +// +//========================================================================== + +// CONFIGURATION + +#include <pkgconf/memalloc.h> +#ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE +# include <pkgconf/system.h> +# ifdef CYGPKG_KERNEL +# include <pkgconf/kernel.h> +# endif +#endif + + +// INCLUDES + +#include <cyg/infra/cyg_type.h> // types +#include <cyg/infra/cyg_ass.h> // assertion macros + +#ifdef CYGFUN_KERNEL_THREADS_TIMER +# include <cyg/kernel/ktypes.h> // cyg_tick_count +#endif + +#ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE +# include <cyg/memalloc/mempolt2.hxx> // kernel safe mempool template +#endif + +#include <cyg/memalloc/mfiximpl.hxx> // implementation of a fixed mem pool +#include <cyg/memalloc/common.hxx> // Common memory allocator infra + + +// TYPE DEFINITIONS + +class Cyg_Mempool_Fixed +{ +protected: +#ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE + Cyg_Mempolt2<Cyg_Mempool_Fixed_Implementation> mypool; +#else + Cyg_Mempool_Fixed_Implementation mypool; +#endif + +public: + // this API makes concrete a class which implements a thread-safe + // kernel-savvy memory pool which manages fixed size blocks. + + // Constructor: gives the base and size of the arena in which memory is + // to be carved out, note that management structures are taken from the + // same arena. Alloc_unit is the blocksize allocated. + Cyg_Mempool_Fixed( + cyg_uint8 *base, + cyg_int32 size, + CYG_ADDRWORD alloc_unit ); + + // Destructor + ~Cyg_Mempool_Fixed(); + +#ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE + // get some memory; wait if none available + cyg_uint8 *alloc(); + +# ifdef CYGFUN_KERNEL_THREADS_TIMER + // get some memory with a timeout + cyg_uint8 *alloc( cyg_tick_count delay_timeout ); +# endif +#endif + + // get some memory, return NULL if none available + cyg_uint8 *try_alloc(); + + // supposedly resize existing allocation. This is defined in the + // fixed block allocator purely for API consistency. It will return + // an error (false) for all values, except for the blocksize + // returns true on success + cyg_uint8 * + resize_alloc( cyg_uint8 *alloc_ptr, cyg_int32 newsize, + cyg_int32 *oldsize=NULL ); + + // free the memory back to the pool + cyg_bool free( cyg_uint8 *p ); + + // Get memory pool status + // flags is a bitmask of requested fields to fill in. The flags are + // defined in common.hxx + void get_status( cyg_mempool_status_flag_t /* flags */, + Cyg_Mempool_Status & /* status */ ); + + CYGDBG_DEFINE_CHECK_THIS +}; + +#endif // ifndef CYGONCE_MEMALLOC_MEMFIXED_HXX +// EOF memfixed.hxx
