rkhmempool.h

Go to the documentation of this file.

/*
 *  --------------------------------------------------------------------------
 *
 *                                Framework RKH
 *                                -------------
 *
 *            State-machine framework for reactive embedded systems
 *
 *                      Copyright (C) 2010 Leandro Francucci.
 *          All rights reserved. Protected by international copyright laws.
 *
 *
 *  RKH 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 3 of the License, or (at your option) any
 *  later version.
 *
 *  RKH 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 RKH, see copying.txt file.
 *
 *  Contact information:
 *  RKH web site:   http://sourceforge.net/projects/rkh-reactivesys/
 *  e-mail:         francuccilea@gmail.com
 *  ---------------------------------------------------------------------------
 */

/* -------------------------- Development history -------------------------- */
/*
 *  2015.10.24  LeFr  v2.4.05  Initial version
 */

/* -------------------------------- Authors -------------------------------- */
/*
 *  LeFr  Leandro Francucci  francuccilea@gmail.com
 */

/* --------------------------------- Notes --------------------------------- */
/* --------------------------------- Module -------------------------------- */
#ifndef __RKHMEMPOOL_H__
#define __RKHMEMPOOL_H__

/* ----------------------------- Include files ----------------------------- */
#include "rkhtype.h"
#include "rkhcfg.h"

/* ---------------------- External C language linkage ---------------------- */
#ifdef __cplusplus
extern "C" {
#endif

/* --------------------------------- Macros -------------------------------- */
/* -------------------------------- Constants ------------------------------ */
/* ------------------------------- Data types ------------------------------ */
#if RKH_CFG_MP_SIZEOF_NBLOCK == 8
typedef rui8_t RKH_MPNB_T;
#elif RKH_CFG_MP_SIZEOF_NBLOCK == 16
typedef rui16_t RKH_MPNB_T;
#elif RKH_CFG_MP_SIZEOF_NBLOCK == 32
typedef rui32_t RKH_MPNB_T;
#else
typedef rui8_t RKH_MPNB_T;
#endif

#if RKH_CFG_MP_SIZEOF_BSIZE == 8
typedef rui8_t RKH_MPBS_T;
#elif RKH_CFG_MP_SIZEOF_BSIZE == 16
typedef rui16_t RKH_MPBS_T;
#elif RKH_CFG_MP_SIZEOF_BSIZE == 32
typedef rui32_t RKH_MPBS_T;
#else
typedef rui8_t RKH_MPBS_T;
#endif

typedef struct
{
    rui8_t inits;

    rui8_t gets;

    rui8_t puts;

    rui8_t free;

    rui8_t full;
} RKH_MPI_T;

typedef struct RKH_MEMPOOL_T
{
    void *free;

    RKH_MPNB_T nfree;

    RKH_MPNB_T nblocks;

    RKH_MPBS_T bsize;

#if RKH_CFG_MP_REDUCED_EN == RKH_DISABLED

    void *start;

    void *end;

#if RKH_CFG_MP_GET_LWM_EN == RKH_ENABLED
    RKH_MPNB_T nmin;
#endif

#endif

#if RKH_CFG_MP_GET_INFO_EN == RKH_ENABLED
    RKH_MPI_T mpi;
#endif
} RKH_MEMPOOL_T;

/* -------------------------- External variables --------------------------- */
/* -------------------------- Function prototypes -------------------------- */
void rkh_memPool_init(RKH_MEMPOOL_T *mp, void *sstart, rui16_t ssize,
                 RKH_MPBS_T bsize);

void *rkh_memPool_get(RKH_MEMPOOL_T *mp);

void rkh_memPool_put(RKH_MEMPOOL_T *mp, void *blk);

RKH_MPBS_T rkh_memPool_get_bsize(RKH_MEMPOOL_T *mp);

RKH_MPNB_T rkh_memPool_get_nfree(RKH_MEMPOOL_T *mp);

RKH_MPNB_T rkh_memPool_get_low_wmark(RKH_MEMPOOL_T *mp);

void rkh_memPool_get_info(RKH_MEMPOOL_T *mp, RKH_MPI_T *mpi);

void rkh_memPool_clear_info(RKH_MEMPOOL_T *mp);

/* -------------------- External C language linkage end -------------------- */
#ifdef __cplusplus
}
#endif

/* ------------------------------ Module end ------------------------------- */
#endif

/* ------------------------------ End of file ------------------------------ */