adamdunkels | a2f3c42 | 2004-09-12 20:24:53 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2004, Swedish Institute of Computer Science. |
| 3 | * All rights reserved. |
| 4 | * |
| 5 | * Redistribution and use in source and binary forms, with or without |
| 6 | * modification, are permitted provided that the following conditions |
| 7 | * are met: |
| 8 | * 1. Redistributions of source code must retain the above copyright |
| 9 | * notice, this list of conditions and the following disclaimer. |
| 10 | * 2. Redistributions in binary form must reproduce the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer in the |
| 12 | * documentation and/or other materials provided with the distribution. |
| 13 | * 3. Neither the name of the Institute nor the names of its contributors |
| 14 | * may be used to endorse or promote products derived from this software |
| 15 | * without specific prior written permission. |
| 16 | * |
| 17 | * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND |
| 18 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 19 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 20 | * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE |
| 21 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 22 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 23 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 24 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 25 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 26 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 27 | * SUCH DAMAGE. |
| 28 | * |
| 29 | * This file is part of the Contiki operating system. |
| 30 | * |
| 31 | * Author: Adam Dunkels <adam@sics.se> |
| 32 | * |
| 33 | * $Id: memb.h,v 1.6 2004/09/12 20:24:55 adamdunkels Exp $ |
| 34 | */ |
adamdunkels | 25adfdf | 2003-10-14 11:14:54 +0000 | [diff] [blame] | 35 | /** |
adamdunkels | 01f657c | 2004-03-18 21:07:00 +0000 | [diff] [blame] | 36 | * \addtogroup memb |
| 37 | * @{ |
| 38 | */ |
| 39 | |
| 40 | /** |
adamdunkels | 25adfdf | 2003-10-14 11:14:54 +0000 | [diff] [blame] | 41 | * \file |
| 42 | * Memory block allocation routines. |
| 43 | * \author Adam Dunkels <adam@sics.se> |
| 44 | * |
| 45 | */ |
| 46 | |
| 47 | #ifndef __MEMB_H__ |
| 48 | #define __MEMB_H__ |
| 49 | |
| 50 | /** |
| 51 | * Declare a memory block. |
| 52 | * |
adamdunkels | 01f657c | 2004-03-18 21:07:00 +0000 | [diff] [blame] | 53 | * This macro is used to staticall declare a block of memory that can |
| 54 | * be used by the block allocation functions. The macro statically |
| 55 | * declares a C array with a size that matches the specified number of |
| 56 | * blocks and their individual sizes. |
| 57 | * |
| 58 | * Example: |
| 59 | \code |
| 60 | MEMB(connections, sizeof(struct connection), 16); |
| 61 | \endcode |
| 62 | * |
adamdunkels | 25adfdf | 2003-10-14 11:14:54 +0000 | [diff] [blame] | 63 | * \param name The name of the memory block (later used with |
| 64 | * memb_init(), memb_alloc() and memb_free()). |
| 65 | * |
| 66 | * \param size The size of each memory chunk, in bytes. |
| 67 | * |
| 68 | * \param num The total number of memory chunks in the block. |
| 69 | * |
| 70 | */ |
adamdunkels | 0f41361 | 2004-02-24 09:56:06 +0000 | [diff] [blame] | 71 | #if CC_DOUBLE_HASH |
adamdunkels | 25adfdf | 2003-10-14 11:14:54 +0000 | [diff] [blame] | 72 | #define MEMB(name, size, num) \ |
adamdunkels | 9217704 | 2003-11-27 15:48:46 +0000 | [diff] [blame] | 73 | static char name##_memb_mem[(size + 1) * num]; \ |
| 74 | static struct memb_blocks name = {size, num, name##_memb_mem} |
adamdunkels | 0f41361 | 2004-02-24 09:56:06 +0000 | [diff] [blame] | 75 | #else /* CC_DOUBLE_HASH */ |
| 76 | #define MEMB(name, size, num) \ |
| 77 | static char name_memb_mem[(size + 1) * num]; \ |
| 78 | static struct memb_blocks name = {size, num, name_memb_mem} |
| 79 | #endif /* CC_DOUBLE_HASH */ |
adamdunkels | 25adfdf | 2003-10-14 11:14:54 +0000 | [diff] [blame] | 80 | |
| 81 | struct memb_blocks { |
| 82 | unsigned short size; |
| 83 | unsigned short num; |
| 84 | char *mem; |
| 85 | }; |
| 86 | |
| 87 | void memb_init(struct memb_blocks *m); |
| 88 | char *memb_alloc(struct memb_blocks *m); |
| 89 | char memb_ref(struct memb_blocks *m, char *ptr); |
adamdunkels | 01f657c | 2004-03-18 21:07:00 +0000 | [diff] [blame] | 90 | char memb_free(struct memb_blocks *m, void *ptr); |
adamdunkels | 25adfdf | 2003-10-14 11:14:54 +0000 | [diff] [blame] | 91 | |
adamdunkels | 01f657c | 2004-03-18 21:07:00 +0000 | [diff] [blame] | 92 | /** @} */ |
adamdunkels | 25adfdf | 2003-10-14 11:14:54 +0000 | [diff] [blame] | 93 | |
| 94 | #endif /* __MEMB_H__ */ |