ReactOS 0.4.16-dev-297-gc569aee
memp_std.h
Go to the documentation of this file.
1
9/*
10 * SETUP: Make sure we define everything we will need.
11 *
12 * We have create three types of pools:
13 * 1) MEMPOOL - standard pools
14 * 2) MALLOC_MEMPOOL - to be used by mem_malloc in mem.c
15 * 3) PBUF_MEMPOOL - a mempool of pbuf's, so include space for the pbuf struct
16 *
17 * If the include'r doesn't require any special treatment of each of the types
18 * above, then will declare #2 & #3 to be just standard mempools.
19 */
20#ifndef LWIP_MALLOC_MEMPOOL
21/* This treats "malloc pools" just like any other pool.
22 The pools are a little bigger to provide 'size' as the amount of user data. */
23#define LWIP_MALLOC_MEMPOOL(num, size) LWIP_MEMPOOL(POOL_##size, num, (size + LWIP_MEM_ALIGN_SIZE(sizeof(struct memp_malloc_helper))), "MALLOC_"#size)
24#define LWIP_MALLOC_MEMPOOL_START
25#define LWIP_MALLOC_MEMPOOL_END
26#endif /* LWIP_MALLOC_MEMPOOL */
27
28#ifndef LWIP_PBUF_MEMPOOL
29/* This treats "pbuf pools" just like any other pool.
30 * Allocates buffers for a pbuf struct AND a payload size */
31#define LWIP_PBUF_MEMPOOL(name, num, payload, desc) LWIP_MEMPOOL(name, num, (LWIP_MEM_ALIGN_SIZE(sizeof(struct pbuf)) + LWIP_MEM_ALIGN_SIZE(payload)), desc)
32#endif /* LWIP_PBUF_MEMPOOL */
33
34
35/*
36 * A list of internal pools used by LWIP.
37 *
38 * LWIP_MEMPOOL(pool_name, number_elements, element_size, pool_description)
39 * creates a pool name MEMP_pool_name. description is used in stats.c
40 */
41#if LWIP_RAW
42LWIP_MEMPOOL(RAW_PCB, MEMP_NUM_RAW_PCB, sizeof(struct raw_pcb), "RAW_PCB")
43#endif /* LWIP_RAW */
44
45#if LWIP_UDP
46LWIP_MEMPOOL(UDP_PCB, MEMP_NUM_UDP_PCB, sizeof(struct udp_pcb), "UDP_PCB")
47#endif /* LWIP_UDP */
48
49#if LWIP_TCP
50LWIP_MEMPOOL(TCP_PCB, MEMP_NUM_TCP_PCB, sizeof(struct tcp_pcb), "TCP_PCB")
51LWIP_MEMPOOL(TCP_PCB_LISTEN, MEMP_NUM_TCP_PCB_LISTEN, sizeof(struct tcp_pcb_listen), "TCP_PCB_LISTEN")
52LWIP_MEMPOOL(TCP_SEG, MEMP_NUM_TCP_SEG, sizeof(struct tcp_seg), "TCP_SEG")
53#endif /* LWIP_TCP */
54
55#if LWIP_ALTCP && LWIP_TCP
56LWIP_MEMPOOL(ALTCP_PCB, MEMP_NUM_ALTCP_PCB, sizeof(struct altcp_pcb), "ALTCP_PCB")
57#endif /* LWIP_ALTCP && LWIP_TCP */
58
59#if LWIP_IPV4 && IP_REASSEMBLY
60LWIP_MEMPOOL(REASSDATA, MEMP_NUM_REASSDATA, sizeof(struct ip_reassdata), "REASSDATA")
61#endif /* LWIP_IPV4 && IP_REASSEMBLY */
62#if (IP_FRAG && !LWIP_NETIF_TX_SINGLE_PBUF) || (LWIP_IPV6 && LWIP_IPV6_FRAG)
63LWIP_MEMPOOL(FRAG_PBUF, MEMP_NUM_FRAG_PBUF, sizeof(struct pbuf_custom_ref),"FRAG_PBUF")
64#endif /* IP_FRAG && !LWIP_NETIF_TX_SINGLE_PBUF || (LWIP_IPV6 && LWIP_IPV6_FRAG) */
65
66#if LWIP_NETCONN || LWIP_SOCKET
67LWIP_MEMPOOL(NETBUF, MEMP_NUM_NETBUF, sizeof(struct netbuf), "NETBUF")
69#endif /* LWIP_NETCONN || LWIP_SOCKET */
70
71#if NO_SYS==0
72LWIP_MEMPOOL(TCPIP_MSG_API, MEMP_NUM_TCPIP_MSG_API, sizeof(struct tcpip_msg), "TCPIP_MSG_API")
73#if LWIP_MPU_COMPATIBLE
74LWIP_MEMPOOL(API_MSG, MEMP_NUM_API_MSG, sizeof(struct api_msg), "API_MSG")
75#if LWIP_DNS
76LWIP_MEMPOOL(DNS_API_MSG, MEMP_NUM_DNS_API_MSG, sizeof(struct dns_api_msg), "DNS_API_MSG")
77#endif
78#if LWIP_SOCKET && !LWIP_TCPIP_CORE_LOCKING
79LWIP_MEMPOOL(SOCKET_SETGETSOCKOPT_DATA, MEMP_NUM_SOCKET_SETGETSOCKOPT_DATA, sizeof(struct lwip_setgetsockopt_data), "SOCKET_SETGETSOCKOPT_DATA")
80#endif
81#if LWIP_SOCKET && (LWIP_SOCKET_SELECT || LWIP_SOCKET_POLL)
82LWIP_MEMPOOL(SELECT_CB, MEMP_NUM_SELECT_CB, sizeof(struct lwip_select_cb), "SELECT_CB")
83#endif /* LWIP_SOCKET && (LWIP_SOCKET_SELECT || LWIP_SOCKET_POLL) */
84#if LWIP_NETIF_API
85LWIP_MEMPOOL(NETIFAPI_MSG, MEMP_NUM_NETIFAPI_MSG, sizeof(struct netifapi_msg), "NETIFAPI_MSG")
86#endif
87#endif /* LWIP_MPU_COMPATIBLE */
88#if !LWIP_TCPIP_CORE_LOCKING_INPUT
89LWIP_MEMPOOL(TCPIP_MSG_INPKT,MEMP_NUM_TCPIP_MSG_INPKT, sizeof(struct tcpip_msg), "TCPIP_MSG_INPKT")
90#endif /* !LWIP_TCPIP_CORE_LOCKING_INPUT */
91#endif /* NO_SYS==0 */
92
93#if LWIP_IPV4 && LWIP_ARP && ARP_QUEUEING
94LWIP_MEMPOOL(ARP_QUEUE, MEMP_NUM_ARP_QUEUE, sizeof(struct etharp_q_entry), "ARP_QUEUE")
95#endif /* LWIP_IPV4 && LWIP_ARP && ARP_QUEUEING */
96
97#if LWIP_IGMP
98LWIP_MEMPOOL(IGMP_GROUP, MEMP_NUM_IGMP_GROUP, sizeof(struct igmp_group), "IGMP_GROUP")
99#endif /* LWIP_IGMP */
100
101#if LWIP_TIMERS && !LWIP_TIMERS_CUSTOM
102LWIP_MEMPOOL(SYS_TIMEOUT, MEMP_NUM_SYS_TIMEOUT, sizeof(struct sys_timeo), "SYS_TIMEOUT")
103#endif /* LWIP_TIMERS && !LWIP_TIMERS_CUSTOM */
104
105#if LWIP_DNS && LWIP_SOCKET
106LWIP_MEMPOOL(NETDB, MEMP_NUM_NETDB, NETDB_ELEM_SIZE, "NETDB")
107#endif /* LWIP_DNS && LWIP_SOCKET */
108#if LWIP_DNS && DNS_LOCAL_HOSTLIST && DNS_LOCAL_HOSTLIST_IS_DYNAMIC
109LWIP_MEMPOOL(LOCALHOSTLIST, MEMP_NUM_LOCALHOSTLIST, LOCALHOSTLIST_ELEM_SIZE, "LOCALHOSTLIST")
110#endif /* LWIP_DNS && DNS_LOCAL_HOSTLIST && DNS_LOCAL_HOSTLIST_IS_DYNAMIC */
111
112#if LWIP_IPV6 && LWIP_ND6_QUEUEING
113LWIP_MEMPOOL(ND6_QUEUE, MEMP_NUM_ND6_QUEUE, sizeof(struct nd6_q_entry), "ND6_QUEUE")
114#endif /* LWIP_IPV6 && LWIP_ND6_QUEUEING */
115
116#if LWIP_IPV6 && LWIP_IPV6_REASS
117LWIP_MEMPOOL(IP6_REASSDATA, MEMP_NUM_REASSDATA, sizeof(struct ip6_reassdata), "IP6_REASSDATA")
118#endif /* LWIP_IPV6 && LWIP_IPV6_REASS */
119
120#if LWIP_IPV6 && LWIP_IPV6_MLD
121LWIP_MEMPOOL(MLD6_GROUP, MEMP_NUM_MLD6_GROUP, sizeof(struct mld_group), "MLD6_GROUP")
122#endif /* LWIP_IPV6 && LWIP_IPV6_MLD */
123
124
125/*
126 * A list of pools of pbuf's used by LWIP.
127 *
128 * LWIP_PBUF_MEMPOOL(pool_name, number_elements, pbuf_payload_size, pool_description)
129 * creates a pool name MEMP_pool_name. description is used in stats.c
130 * This allocates enough space for the pbuf struct and a payload.
131 * (Example: pbuf_payload_size=0 allocates only size for the struct)
132 */
133LWIP_MEMPOOL(PBUF, MEMP_NUM_PBUF, sizeof(struct pbuf), "PBUF_REF/ROM")
135
136
137/*
138 * Allow for user-defined pools; this must be explicitly set in lwipopts.h
139 * since the default is to NOT look for lwippools.h
140 */
141#if MEMP_USE_CUSTOM_POOLS
142#include "lwippools.h"
143#endif /* MEMP_USE_CUSTOM_POOLS */
144
145/*
146 * REQUIRED CLEANUP: Clear up so we don't get "multiply defined" error later
147 * (#undef is ignored for something that is not defined)
148 */
149#undef LWIP_MEMPOOL
150#undef LWIP_MALLOC_MEMPOOL
151#undef LWIP_MALLOC_MEMPOOL_START
152#undef LWIP_MALLOC_MEMPOOL_END
153#undef LWIP_PBUF_MEMPOOL
#define altcp_pcb
Definition: altcp.h:159
#define MEMP_NUM_TCP_PCB_LISTEN
Definition: opt.h:437
#define MEMP_NUM_ARP_QUEUE
Definition: opt.h:484
#define MEMP_NUM_REASSDATA
Definition: opt.h:463
#define MEMP_NUM_FRAG_PBUF
Definition: opt.h:474
#define MEMP_NUM_ALTCP_PCB
Definition: opt.h:455
#define MEMP_NUM_NETDB
Definition: opt.h:560
#define MEMP_NUM_UDP_PCB
Definition: opt.h:421
#define MEMP_NUM_RAW_PCB
Definition: opt.h:412
#define MEMP_NUM_DNS_API_MSG
Definition: opt.h:588
#define MEMP_NUM_SYS_TIMEOUT
Definition: opt.h:509
#define PBUF_POOL_SIZE
Definition: opt.h:575
#define MEMP_NUM_API_MSG
Definition: opt.h:582
#define MEMP_NUM_NETBUF
Definition: opt.h:517
#define MEMP_NUM_TCP_PCB
Definition: opt.h:429
#define MEMP_NUM_SELECT_CB
Definition: opt.h:534
#define MEMP_NUM_PBUF
Definition: opt.h:404
#define MEMP_NUM_TCP_SEG
Definition: opt.h:445
#define MEMP_NUM_LOCALHOSTLIST
Definition: opt.h:568
#define MEMP_NUM_TCPIP_MSG_INPKT
Definition: opt.h:552
#define MEMP_NUM_IGMP_GROUP
Definition: opt.h:494
#define MEMP_NUM_NETCONN
Definition: opt.h:525
#define MEMP_NUM_SOCKET_SETGETSOCKOPT_DATA
Definition: opt.h:595
#define MEMP_NUM_NETIFAPI_MSG
Definition: opt.h:602
#define MEMP_NUM_TCPIP_MSG_API
Definition: opt.h:543
#define MEMP_NUM_MLD6_GROUP
Definition: opt.h:2600
#define MEMP_NUM_ND6_QUEUE
Definition: opt.h:2623
#define PBUF_POOL_BUFSIZE
Definition: opt.h:1599
@ PBUF_POOL
Definition: pbuf.h:167
#define LWIP_MEMPOOL(name, num, size, desc)
Definition: memp.c:78
#define LWIP_PBUF_MEMPOOL(name, num, payload, desc)
Definition: memp_std.h:31
Definition: types.h:144
Definition: pbuf.h:186
@ TCPIP_MSG_INPKT
Definition: tcpip_priv.h:119
@ TCPIP_MSG_API
Definition: tcpip_priv.h:115
ActualNumberDriverObjects * sizeof(PDRIVER_OBJECT)) PDRIVER_OBJECT *DriverObjectList