Subversion Repositories openrisc

#ifndef CYGONCE_MEMALLOC_MEMFIXED_HXX

#define CYGONCE_MEMALLOC_MEMFIXED_HXX

//==========================================================================

//

//      memfixed.hxx

//

//      Memory pool with fixed block class declarations

//

//==========================================================================

// ####ECOSGPLCOPYRIGHTBEGIN####

// -------------------------------------------

// This file is part of eCos, the Embedded Configurable Operating System.

// Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.

//

// eCos is free software; you can redistribute it and/or modify it under

// the terms of the GNU General Public License as published by the Free

// Software Foundation; either version 2 or (at your option) any later

// version.

//

// eCos is distributed in the hope that it will be useful, but WITHOUT

// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

// for more details.

//

// You should have received a copy of the GNU General Public License

// along with eCos; if not, write to the Free Software Foundation, Inc.,

// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

//

// As a special exception, if other files instantiate templates or use

// macros or inline functions from this file, or you compile this file

// and link it with other works to produce a work based on this file,

// this file does not by itself cause the resulting work to be covered by

// the GNU General Public License. However the source code for this file

// must still be made available in accordance with section (3) of the GNU

// General Public License v2.

//

// This exception does not invalidate any other reasons why a work based

// on this file might be covered by the GNU General Public License.

// -------------------------------------------

// ####ECOSGPLCOPYRIGHTEND####

//==========================================================================

//#####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 

//

//

//####DESCRIPTIONEND####

//

//==========================================================================

// CONFIGURATION

#include 

#ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE

# include 

# ifdef CYGPKG_KERNEL

#  include 

# endif

#endif

// INCLUDES

#include         // types

#include          // assertion macros

#ifdef CYGFUN_KERNEL_THREADS_TIMER

# include         // cyg_tick_count

#endif

#ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE

# include   // kernel safe mempool template

#endif

#include    // implementation of a fixed mem pool

#include      // Common memory allocator infra

// TYPE DEFINITIONS

class Cyg_Mempool_Fixed

{

protected:

#ifdef CYGSEM_MEMALLOC_ALLOCATOR_FIXED_THREADAWARE

    Cyg_Mempolt2 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