C:/asm/STM32-ethernet/ENC28J60prj/uip-master/lib/memb.h

См. документацию.

/*
 * Copyright (c) 2004, Swedish Institute of Computer Science.
 * Все права зарезервированы. *
 * Повторное распространение, использование в исходном и двоичном виде,
 * с модификацией или без - разрешается, если выполняются следующие
 * условия:
 * 1. Распространение исходного кода должно сохранить вышеуказанную пометку
 *    копирайта, этот список условий и следующую правовую оговорку.
 * 2. Распространение исходного кода должно сохранить вышеуказанную пометку
 *    копирайта, этот список условий и следующую правовую оговорку в
 *    документации и/или других материалах, которые будут предоставлены
 *    вместе с распространяемыми материалами.
 * 3. Имя автора не может использоваться, чтобы подтвердить или продвинуть
 *    продукты, написанные с использованием этого программного обеспечения
 *    без специального на то разрешения.
 *
 * ЭТО ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ АВТОРОМ ``КАК ЕСТЬ'', БЕЗ
 * КАКОЙ-ЛИБО ЛЮБОЙ РАСШИРЕННОЙ ИЛИ ПОДРАЗУМЕВАЕМОЙ ГАРАНТИИ, ВКЛЮЧАЯ,
 * НО НЕ ОГРАНИЧИВАЯСЬ ЭТИМ, ГАРАНТИИ ВЫСОКОГО СПРОСА И ПРИГОДНОСТИ
 * ДЛЯ КОНКРЕТНОЙ ЦЕЛИ. АВТОР НИ ПРИ КАКИХ УСЛОВИЯХ НЕ ОТВЕТСТВЕНЕН
 * ЗА ЛЮБЫЕ УБЫТКИ - ПРЯМЫЕ, КОСВЕННЫЕ, СЛУЧАЙНЫЕ, СПЕЦИАЛЬНЫЕ, ОБРАЗЦОВЫЕ
 * ИЛИ ПОСЛЕДОВАТЕЛЬНЫЕ (ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ЭТИМ, ТРЕБОВАНИЯ
 * ЗАМЕНЫ ТОВАРА ИЛИ СЕРВИСА; ПОТЕРИ ИСПОЛЬЗОВАНИЯ, ДАННЫХ ИЛИ ВЫГОДЫ;
 * ИЛИ ПРЕКРАЩЕНИЕ БИЗНЕСА), ОДНАКО ВЫЗВАННЫЕ ПО ЛЮБОЙ ТЕОРИИ ОТВЕТСТВЕННОСТИ,
 * ЛИБО В КОНТРАКТЕ, ПРЯМОЙ ОТВЕТСТВЕННОСТИ, ЛИБО В НАРУШЕНИИ ЗАКОННЫХ ПРАВ
 * (ВКЛЮЧАЯ ТАК ИЛИ ИНАЧЕ НЕБРЕЖНОСТЬ), ВОЗНИКАЮЩИЕ ВСЕГДА ИЗ ИСПОЛЬЗОВАНИЯ
 * ЭТОГО ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ, ДАЖЕ ЕСЛИ БЫЛО ПРЕДУПРЕЖДЕНИЕ О ВОЗМОЖНОСТИ
 * ТАКОГО ПОВРЕЖДЕНИЯ.
 *
 * Этот файл является частью стека uIP TCP/IP.
 *
 * Author: Adam Dunkels <adam@sics.se>
 *
 * $Id: memb.h,v 1.1 2006/06/12 08:21:43 adam Exp $
 */

/**
 * \defgroup memb Функции управления блоками памяти
 *
 * Подпрограммы выделения блока памяти предоставляют простой, но мощный
 * набор фукнций для управления блоками памяти фиксированного размера.
 * Набор блоков памяти статически декларируется маросом MEMB(). Блоки
 * памяти выделяются из декларированной памяти функцией memb_alloc(),
 * и освобождаются функцией memb_free().
 *
 * \note Из-за конфликта имен только один MEMB() может быть декларирован
 * на один модуль C, и область действия имен блоков памяти MEMB() локальна
 * для каждого модуля C.
 *
 * Следующий пример показывает, как декларировать и использовать блок
 * памяти, названный "cmem", который имеет 8 кусков памяти, каждый кусок
 * по 20 байт.
 *
 \code
MEMB(cmem, 20, 8);
 \endcode
 * @{
 */


/**
 * \file
 *         Подпрограммы выделения блока памяти.
 * \author
 *         Adam Dunkels <adam@sics.se>
 *
 */

#ifndef __MEMB_H__
#define __MEMB_H__

/*
 * Здесь мы определим макрос препроцессора C для связывания строк. 
 * Нам нужно 2 макроса, чтобы можно было связывать два макроса
 * #заданных (#defined) макроса.
 */
#define MEMB_CONCAT2(s1, s2) s1##s2
#define MEMB_CONCAT(s1, s2) MEMB_CONCAT2(s1, s2)

/**
 * Декларирование блока памяти.
 *
 * Этот макрос используется для статического декларирования блока
 * памяти, который может использоваться в фукнциях выделения блока.
 * Макрос статически декларирует массив C, размер которого
 * соответствует указанному кличеству блоков и их индивидуальным
 * размерам.
 *
 * Пример:
 \code
MEMB(connections, sizeof(struct connection), 16);
 \endcode
 *
 * \param name Имя блока памяти (которое позднее используется с
 * memb_init(), memb_alloc() и memb_free()).
 *
 * \param size Размер каждого куска памяти, в байтах.
 *
 * \param num Общее количество кусков памяти в блоке.
 *
 */
#define MEMB(name, structure, num) \
        static char MEMB_CONCAT(name,_memb_count)[num]; \
        static structure MEMB_CONCAT(name,_memb_mem)[num]; \
        static struct memb_blocks name = {sizeof(structure), num, \
                                          MEMB_CONCAT(name,_memb_count), \
                                          (void *)MEMB_CONCAT(name,_memb_mem)}

struct memb_blocks {
  unsigned short size;
  unsigned short num;
  char *count;
  void *mem;
};

/**
 * Инициализирует блок памяти, который был декларирован через MEMB().
 *
 * \param m Блок памяти, ранее декларированный через MEMB().
 */
void  memb_init(struct memb_blocks *m);

/**
 * Выделение блока памяти из блока, который был декларирован через MEMB().
 *
 * \param m Блок памяти, ранее декларированный через MEMB().
 */
void *memb_alloc(struct memb_blocks *m);

/**
 * Освобождение блока памяти из блока, который был ранее декларирован
 * через MEMB().
 *
 * \param m m Блок памяти, ранее декларированный через MEMB().
 *
 * \param ptr Указатель на блок памяти, который освобождается.
 *
 * \return Новый счетчик ссылки для блока памяти (должен быть 0,
 * если блок успешно освобожден, или -1, если указатель "ptr"
 * не указывает на правильный блок памяти).
 */
char  memb_free(struct memb_blocks *m, void *ptr);

/** @} */

#endif /* __MEMB_H__ */