Michael Spencer / Smoothie

Fork of Smoothie to port to mbed non-LPC targets.

Dependencies:   mbed

Fork of Smoothie by Stéphane Cachat

libs/Network/uip/lib/memb.h@2:1df0b61d3b5a, 2014-02-28 (annotated)

Committer:
Michael J. Spencer
Date:
Fri Feb 28 18:52:52 2014 -0800
Revision:
2:1df0b61d3b5a
Update to latest Smoothie.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michael J. Spencer 2:1df0b61d3b5a 1 /*
Michael J. Spencer 2:1df0b61d3b5a 2 * Copyright (c) 2004, Swedish Institute of Computer Science.
Michael J. Spencer 2:1df0b61d3b5a 3 * All rights reserved.
Michael J. Spencer 2:1df0b61d3b5a 4 *
Michael J. Spencer 2:1df0b61d3b5a 5 * Redistribution and use in source and binary forms, with or without
Michael J. Spencer 2:1df0b61d3b5a 6 * modification, are permitted provided that the following conditions
Michael J. Spencer 2:1df0b61d3b5a 7 * are met:
Michael J. Spencer 2:1df0b61d3b5a 8 * 1. Redistributions of source code must retain the above copyright
Michael J. Spencer 2:1df0b61d3b5a 9 * notice, this list of conditions and the following disclaimer.
Michael J. Spencer 2:1df0b61d3b5a 10 * 2. Redistributions in binary form must reproduce the above copyright
Michael J. Spencer 2:1df0b61d3b5a 11 * notice, this list of conditions and the following disclaimer in the
Michael J. Spencer 2:1df0b61d3b5a 12 * documentation and/or other materials provided with the distribution.
Michael J. Spencer 2:1df0b61d3b5a 13 * 3. Neither the name of the Institute nor the names of its contributors
Michael J. Spencer 2:1df0b61d3b5a 14 * may be used to endorse or promote products derived from this software
Michael J. Spencer 2:1df0b61d3b5a 15 * without specific prior written permission.
Michael J. Spencer 2:1df0b61d3b5a 16 *
Michael J. Spencer 2:1df0b61d3b5a 17 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
Michael J. Spencer 2:1df0b61d3b5a 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Michael J. Spencer 2:1df0b61d3b5a 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Michael J. Spencer 2:1df0b61d3b5a 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
Michael J. Spencer 2:1df0b61d3b5a 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Michael J. Spencer 2:1df0b61d3b5a 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
Michael J. Spencer 2:1df0b61d3b5a 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
Michael J. Spencer 2:1df0b61d3b5a 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
Michael J. Spencer 2:1df0b61d3b5a 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
Michael J. Spencer 2:1df0b61d3b5a 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
Michael J. Spencer 2:1df0b61d3b5a 27 * SUCH DAMAGE.
Michael J. Spencer 2:1df0b61d3b5a 28 *
Michael J. Spencer 2:1df0b61d3b5a 29 * This file is part of the uIP TCP/IP stack
Michael J. Spencer 2:1df0b61d3b5a 30 *
Michael J. Spencer 2:1df0b61d3b5a 31 * Author: Adam Dunkels <adam@sics.se>
Michael J. Spencer 2:1df0b61d3b5a 32 *
Michael J. Spencer 2:1df0b61d3b5a 33 * $Id: memb.h,v 1.1 2006/06/12 08:21:43 adam Exp $
Michael J. Spencer 2:1df0b61d3b5a 34 */
Michael J. Spencer 2:1df0b61d3b5a 35
Michael J. Spencer 2:1df0b61d3b5a 36 /**
Michael J. Spencer 2:1df0b61d3b5a 37 * \defgroup memb Memory block management functions
Michael J. Spencer 2:1df0b61d3b5a 38 *
Michael J. Spencer 2:1df0b61d3b5a 39 * The memory block allocation routines provide a simple yet powerful
Michael J. Spencer 2:1df0b61d3b5a 40 * set of functions for managing a set of memory blocks of fixed
Michael J. Spencer 2:1df0b61d3b5a 41 * size. A set of memory blocks is statically declared with the
Michael J. Spencer 2:1df0b61d3b5a 42 * MEMB() macro. Memory blocks are allocated from the declared
Michael J. Spencer 2:1df0b61d3b5a 43 * memory by the memb_alloc() function, and are deallocated with the
Michael J. Spencer 2:1df0b61d3b5a 44 * memb_free() function.
Michael J. Spencer 2:1df0b61d3b5a 45 *
Michael J. Spencer 2:1df0b61d3b5a 46 * \note Because of namespace clashes only one MEMB() can be
Michael J. Spencer 2:1df0b61d3b5a 47 * declared per C module, and the name scope of a MEMB() memory
Michael J. Spencer 2:1df0b61d3b5a 48 * block is local to each C module.
Michael J. Spencer 2:1df0b61d3b5a 49 *
Michael J. Spencer 2:1df0b61d3b5a 50 * The following example shows how to declare and use a memory block
Michael J. Spencer 2:1df0b61d3b5a 51 * called "cmem" which has 8 chunks of memory with each memory chunk
Michael J. Spencer 2:1df0b61d3b5a 52 * being 20 bytes large.
Michael J. Spencer 2:1df0b61d3b5a 53 *
Michael J. Spencer 2:1df0b61d3b5a 54 * @{
Michael J. Spencer 2:1df0b61d3b5a 55 */
Michael J. Spencer 2:1df0b61d3b5a 56
Michael J. Spencer 2:1df0b61d3b5a 57
Michael J. Spencer 2:1df0b61d3b5a 58 /**
Michael J. Spencer 2:1df0b61d3b5a 59 * \file
Michael J. Spencer 2:1df0b61d3b5a 60 * Memory block allocation routines.
Michael J. Spencer 2:1df0b61d3b5a 61 * \author
Michael J. Spencer 2:1df0b61d3b5a 62 * Adam Dunkels <adam@sics.se>
Michael J. Spencer 2:1df0b61d3b5a 63 *
Michael J. Spencer 2:1df0b61d3b5a 64 */
Michael J. Spencer 2:1df0b61d3b5a 65
Michael J. Spencer 2:1df0b61d3b5a 66 #ifndef __MEMB_H__
Michael J. Spencer 2:1df0b61d3b5a 67 #define __MEMB_H__
Michael J. Spencer 2:1df0b61d3b5a 68
Michael J. Spencer 2:1df0b61d3b5a 69 /*
Michael J. Spencer 2:1df0b61d3b5a 70 * Here we define a C preprocessing macro for concatenating to
Michael J. Spencer 2:1df0b61d3b5a 71 * strings. We need use two macros in order to allow concatenation of
Michael J. Spencer 2:1df0b61d3b5a 72 * two #defined macros.
Michael J. Spencer 2:1df0b61d3b5a 73 */
Michael J. Spencer 2:1df0b61d3b5a 74 #define MEMB_CONCAT2(s1, s2) s1##s2
Michael J. Spencer 2:1df0b61d3b5a 75 #define MEMB_CONCAT(s1, s2) MEMB_CONCAT2(s1, s2)
Michael J. Spencer 2:1df0b61d3b5a 76
Michael J. Spencer 2:1df0b61d3b5a 77 /**
Michael J. Spencer 2:1df0b61d3b5a 78 * Declare a memory block.
Michael J. Spencer 2:1df0b61d3b5a 79 *
Michael J. Spencer 2:1df0b61d3b5a 80 * This macro is used to staticall declare a block of memory that can
Michael J. Spencer 2:1df0b61d3b5a 81 * be used by the block allocation functions. The macro statically
Michael J. Spencer 2:1df0b61d3b5a 82 * declares a C array with a size that matches the specified number of
Michael J. Spencer 2:1df0b61d3b5a 83 * blocks and their individual sizes.
Michael J. Spencer 2:1df0b61d3b5a 84 *
Michael J. Spencer 2:1df0b61d3b5a 85 * Example:
Michael J. Spencer 2:1df0b61d3b5a 86 \code
Michael J. Spencer 2:1df0b61d3b5a 87 MEMB(connections, sizeof(struct connection), 16);
Michael J. Spencer 2:1df0b61d3b5a 88 \endcode
Michael J. Spencer 2:1df0b61d3b5a 89 *
Michael J. Spencer 2:1df0b61d3b5a 90 * \param name The name of the memory block (later used with
Michael J. Spencer 2:1df0b61d3b5a 91 * memb_init(), memb_alloc() and memb_free()).
Michael J. Spencer 2:1df0b61d3b5a 92 *
Michael J. Spencer 2:1df0b61d3b5a 93 * \param size The size of each memory chunk, in bytes.
Michael J. Spencer 2:1df0b61d3b5a 94 *
Michael J. Spencer 2:1df0b61d3b5a 95 * \param num The total number of memory chunks in the block.
Michael J. Spencer 2:1df0b61d3b5a 96 *
Michael J. Spencer 2:1df0b61d3b5a 97 */
Michael J. Spencer 2:1df0b61d3b5a 98 #define MEMB(name, structure, num) static char MEMB_CONCAT(name,_memb_count)[num]; \
Michael J. Spencer 2:1df0b61d3b5a 99 static structure MEMB_CONCAT(name,_memb_mem)[num]; \
Michael J. Spencer 2:1df0b61d3b5a 100 static struct memb_blocks name = {sizeof(structure), num, MEMB_CONCAT(name,_memb_count), (void *)MEMB_CONCAT(name,_memb_mem) }
Michael J. Spencer 2:1df0b61d3b5a 101
Michael J. Spencer 2:1df0b61d3b5a 102
Michael J. Spencer 2:1df0b61d3b5a 103
Michael J. Spencer 2:1df0b61d3b5a 104 struct memb_blocks {
Michael J. Spencer 2:1df0b61d3b5a 105 unsigned short size;
Michael J. Spencer 2:1df0b61d3b5a 106 unsigned short num;
Michael J. Spencer 2:1df0b61d3b5a 107 char *count;
Michael J. Spencer 2:1df0b61d3b5a 108 void *mem;
Michael J. Spencer 2:1df0b61d3b5a 109 };
Michael J. Spencer 2:1df0b61d3b5a 110
Michael J. Spencer 2:1df0b61d3b5a 111 /**
Michael J. Spencer 2:1df0b61d3b5a 112 * Initialize a memory block that was declared with MEMB().
Michael J. Spencer 2:1df0b61d3b5a 113 *
Michael J. Spencer 2:1df0b61d3b5a 114 * \param m A memory block previosly declared with MEMB().
Michael J. Spencer 2:1df0b61d3b5a 115 */
Michael J. Spencer 2:1df0b61d3b5a 116 void memb_init(struct memb_blocks *m);
Michael J. Spencer 2:1df0b61d3b5a 117
Michael J. Spencer 2:1df0b61d3b5a 118 /**
Michael J. Spencer 2:1df0b61d3b5a 119 * Allocate a memory block from a block of memory declared with MEMB().
Michael J. Spencer 2:1df0b61d3b5a 120 *
Michael J. Spencer 2:1df0b61d3b5a 121 * \param m A memory block previosly declared with MEMB().
Michael J. Spencer 2:1df0b61d3b5a 122 */
Michael J. Spencer 2:1df0b61d3b5a 123 void *memb_alloc(struct memb_blocks *m);
Michael J. Spencer 2:1df0b61d3b5a 124
Michael J. Spencer 2:1df0b61d3b5a 125 /**
Michael J. Spencer 2:1df0b61d3b5a 126 * Deallocate a memory block from a memory block previously declared
Michael J. Spencer 2:1df0b61d3b5a 127 * with MEMB().
Michael J. Spencer 2:1df0b61d3b5a 128 *
Michael J. Spencer 2:1df0b61d3b5a 129 * \param m m A memory block previosly declared with MEMB().
Michael J. Spencer 2:1df0b61d3b5a 130 *
Michael J. Spencer 2:1df0b61d3b5a 131 * \param ptr A pointer to the memory block that is to be deallocated.
Michael J. Spencer 2:1df0b61d3b5a 132 *
Michael J. Spencer 2:1df0b61d3b5a 133 * \return The new reference count for the memory block (should be 0
Michael J. Spencer 2:1df0b61d3b5a 134 * if successfully deallocated) or -1 if the pointer "ptr" did not
Michael J. Spencer 2:1df0b61d3b5a 135 * point to a legal memory block.
Michael J. Spencer 2:1df0b61d3b5a 136 */
Michael J. Spencer 2:1df0b61d3b5a 137 char memb_free(struct memb_blocks *m, void *ptr);
Michael J. Spencer 2:1df0b61d3b5a 138
Michael J. Spencer 2:1df0b61d3b5a 139 /** @} */
Michael J. Spencer 2:1df0b61d3b5a 140
Michael J. Spencer 2:1df0b61d3b5a 141 #endif /* __MEMB_H__ */