tinySA/os/kernel/src/chmempools.c

/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT 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.

    ChibiOS/RT 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 this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file chmempools.c
 * @brief Memory Pools code.
 * @addtogroup pools
 * @{
 */

#include <ch.h>

#if CH_USE_MEMPOOLS
/**
 * @brief Initializes an empty memory pool.
 *
 * @param[out] mp pointer to a @p MemoryPool structure
 * @param[in] size the size of the objects contained in this memory pool,
 *                 the minimum accepted size is the size of a pointer to void.
 * @param[in] provider memory provider function for the memory pool or
 *                     @p NULL if the pool is not allowed to grow automatically
 *
 * @note The size is internally aligned to be a multiple of the @p align_t
 *       type size.
 */
void chPoolInit(MemoryPool *mp, size_t size, memgetfunc_t provider) {

  chDbgCheck((mp != NULL) && (size >= sizeof(void *)), "chPoolInit");

  mp->mp_next = NULL;
  mp->mp_object_size = MEM_ALIGN_SIZE(size);
  mp->mp_provider = provider;
}

/**
 * @brief Allocates an object from a memory pool.
 *
 * @param[in] mp pointer to a @p MemoryPool structure
 * @return The pointer to the allocated object.
 * @retval NULL if pool is empty.
 */
void *chPoolAllocI(MemoryPool *mp) {
  void *objp;

  chDbgCheck(mp != NULL, "chPoolAllocI");

  if ((objp = mp->mp_next) != NULL)
    mp->mp_next = mp->mp_next->ph_next;
#if CH_USE_MEMCORE
  else if (mp->mp_provider != NULL)
    objp = mp->mp_provider(mp->mp_object_size);
#endif
  return objp;
}

/**
 * @brief Allocates an object from a memory pool.
 *
 * @param[in] mp pointer to a @p MemoryPool structure
 * @return The pointer to the allocated object.
 * @retval NULL if pool is empty.
 */
void *chPoolAlloc(MemoryPool *mp) {
  void *objp;

  chSysLock();
  objp = chPoolAllocI(mp);
  chSysUnlock();
  return objp;
}

/**
 * @brief Releases (or adds) an object into (to) a memory pool.
 *
 * @param[in] mp pointer to a @p MemoryPool structure
 * @param[in] objp the pointer to the object to be released or added
 *
 * @note The object is assumed to be of the right size for the specified
 *       memory pool.
 * @note The object is assumed to be memory aligned to the size of @p align_t
 *       type.
 */
void chPoolFreeI(MemoryPool *mp, void *objp) {
  struct pool_header *php = objp;

  chDbgCheck((mp != NULL) && (objp != NULL) && MEM_IS_ALIGNED(objp),
             "chPoolFreeI");

  php->ph_next = mp->mp_next;
  mp->mp_next = php;
}

/**
 * @brief Releases (or adds) an object into (to) a memory pool.
 *
 * @param[in] mp pointer to a @p MemoryPool structure
 * @param[in] objp the pointer to the object to be released or added
 * @note the object is assumed to be of the right size for the specified
 *       memory pool.
 */
void chPoolFree(MemoryPool *mp, void *objp) {

  chSysLock();
  chPoolFreeI(mp, objp);
  chSysUnlock();
}
#endif /* CH_USE_MEMPOOLS */

/** @} */