First run at integrating LWIP into the tree (again)
[akaros.git] / user / lwip / include / lwip / memp_std.h
1 /*
2  * SETUP: Make sure we define everything we will need.
3  *
4  * We have create three types of pools:
5  *   1) MEMPOOL - standard pools
6  *   2) MALLOC_MEMPOOL - to be used by mem_malloc in mem.c
7  *   3) PBUF_MEMPOOL - a mempool of pbuf's, so include space for the pbuf struct
8  *
9  * If the include'r doesn't require any special treatment of each of the types
10  * above, then will declare #2 & #3 to be just standard mempools.
11  */
12 #ifndef LWIP_MALLOC_MEMPOOL
13 /* This treats "malloc pools" just like any other pool.
14    The pools are a little bigger to provide 'size' as the amount of user data. */
15 #define LWIP_MALLOC_MEMPOOL(num, size) LWIP_MEMPOOL(POOL_##size, num, (size + sizeof(struct memp_malloc_helper)), "MALLOC_"#size)
16 #define LWIP_MALLOC_MEMPOOL_START
17 #define LWIP_MALLOC_MEMPOOL_END
18 #endif /* LWIP_MALLOC_MEMPOOL */ 
19
20 #ifndef LWIP_PBUF_MEMPOOL
21 /* This treats "pbuf pools" just like any other pool.
22  * Allocates buffers for a pbuf struct AND a payload size */
23 #define LWIP_PBUF_MEMPOOL(name, num, payload, desc) LWIP_MEMPOOL(name, num, (MEMP_ALIGN_SIZE(sizeof(struct pbuf)) + MEMP_ALIGN_SIZE(payload)), desc)
24 #endif /* LWIP_PBUF_MEMPOOL */
25
26
27 /*
28  * A list of internal pools used by LWIP.
29  *
30  * LWIP_MEMPOOL(pool_name, number_elements, element_size, pool_description)
31  *     creates a pool name MEMP_pool_name. description is used in stats.c
32  */
33 #if LWIP_RAW
34 LWIP_MEMPOOL(RAW_PCB,        MEMP_NUM_RAW_PCB,         sizeof(struct raw_pcb),        "RAW_PCB")
35 #endif /* LWIP_RAW */
36
37 #if LWIP_UDP
38 LWIP_MEMPOOL(UDP_PCB,        MEMP_NUM_UDP_PCB,         sizeof(struct udp_pcb),        "UDP_PCB")
39 #endif /* LWIP_UDP */
40
41 #if LWIP_TCP
42 LWIP_MEMPOOL(TCP_PCB,        MEMP_NUM_TCP_PCB,         sizeof(struct tcp_pcb),        "TCP_PCB")
43 LWIP_MEMPOOL(TCP_PCB_LISTEN, MEMP_NUM_TCP_PCB_LISTEN,  sizeof(struct tcp_pcb_listen), "TCP_PCB_LISTEN")
44 LWIP_MEMPOOL(TCP_SEG,        MEMP_NUM_TCP_SEG,         sizeof(struct tcp_seg),        "TCP_SEG")
45 #endif /* LWIP_TCP */
46
47 #if IP_REASSEMBLY
48 LWIP_MEMPOOL(REASSDATA,      MEMP_NUM_REASSDATA,       sizeof(struct ip_reassdata),   "REASSDATA")
49 #endif /* IP_REASSEMBLY */
50
51 #if LWIP_NETCONN
52 LWIP_MEMPOOL(NETBUF,         MEMP_NUM_NETBUF,          sizeof(struct netbuf),         "NETBUF")
53 LWIP_MEMPOOL(NETCONN,        MEMP_NUM_NETCONN,         sizeof(struct netconn),        "NETCONN")
54 #endif /* LWIP_NETCONN */
55
56 #if NO_SYS==0
57 LWIP_MEMPOOL(TCPIP_MSG_API,  MEMP_NUM_TCPIP_MSG_API,   sizeof(struct tcpip_msg),      "TCPIP_MSG_API")
58 LWIP_MEMPOOL(TCPIP_MSG_INPKT,MEMP_NUM_TCPIP_MSG_INPKT, sizeof(struct tcpip_msg),      "TCPIP_MSG_INPKT")
59 #endif /* NO_SYS==0 */
60
61 #if ARP_QUEUEING
62 LWIP_MEMPOOL(ARP_QUEUE,      MEMP_NUM_ARP_QUEUE,       sizeof(struct etharp_q_entry), "ARP_QUEUE")
63 #endif /* ARP_QUEUEING */
64
65 #if LWIP_IGMP
66 LWIP_MEMPOOL(IGMP_GROUP,     MEMP_NUM_IGMP_GROUP,      sizeof(struct igmp_group),     "IGMP_GROUP")
67 #endif /* LWIP_IGMP */
68
69 #if NO_SYS==0
70 LWIP_MEMPOOL(SYS_TIMEOUT,    MEMP_NUM_SYS_TIMEOUT,     sizeof(struct sys_timeo),      "SYS_TIMEOUT")
71 #endif /* NO_SYS==0 */
72
73
74 /*
75  * A list of pools of pbuf's used by LWIP.
76  *
77  * LWIP_PBUF_MEMPOOL(pool_name, number_elements, pbuf_payload_size, pool_description)
78  *     creates a pool name MEMP_pool_name. description is used in stats.c
79  *     This allocates enough space for the pbuf struct and a payload.
80  *     (Example: pbuf_payload_size=0 allocates only size for the struct)
81  */
82 LWIP_PBUF_MEMPOOL(PBUF,      MEMP_NUM_PBUF,            0,                             "PBUF_REF/ROM")
83 LWIP_PBUF_MEMPOOL(PBUF_POOL, PBUF_POOL_SIZE,           PBUF_POOL_BUFSIZE,             "PBUF_POOL")
84
85
86 /*
87  * Allow for user-defined pools; this must be explicitly set in lwipopts.h
88  * since the default is to NOT look for lwippools.h
89  */
90 #if MEMP_USE_CUSTOM_POOLS
91 #include "lwippools.h"
92 #endif /* MEMP_USE_CUSTOM_POOLS */
93
94 /*
95  * REQUIRED CLEANUP: Clear up so we don't get "multiply defined" error later
96  * (#undef is ignored for something that is not defined)
97  */
98 #undef LWIP_MEMPOOL
99 #undef LWIP_MALLOC_MEMPOOL
100 #undef LWIP_MALLOC_MEMPOOL_START
101 #undef LWIP_MALLOC_MEMPOOL_END
102 #undef LWIP_PBUF_MEMPOOL