1 /** 2 * @file 3 * lwIP internal memory pools (do not use in application code) 4 * This file is deliberately included multiple times: once with empty 5 * definition of LWIP_MEMPOOL() to handle all includes and multiple times 6 * to build up various lists of mem pools. 7 */ 8 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, (MEMP_ALIGN_SIZE(sizeof(struct pbuf)) + MEMP_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 42 LWIP_MEMPOOL(RAW_PCB, MEMP_NUM_RAW_PCB, sizeof(struct raw_pcb), "RAW_PCB") 43 #endif /* LWIP_RAW */ 44 45 #if LWIP_UDP 46 LWIP_MEMPOOL(UDP_PCB, MEMP_NUM_UDP_PCB, sizeof(struct udp_pcb), "UDP_PCB") 47 #endif /* LWIP_UDP */ 48 49 #if LWIP_TCP 50 LWIP_MEMPOOL(TCP_PCB, MEMP_NUM_TCP_PCB, sizeof(struct tcp_pcb), "TCP_PCB") 51 LWIP_MEMPOOL(TCP_PCB_LISTEN, MEMP_NUM_TCP_PCB_LISTEN, sizeof(struct tcp_pcb_listen), "TCP_PCB_LISTEN") 52 LWIP_MEMPOOL(TCP_SEG, MEMP_NUM_TCP_SEG, sizeof(struct tcp_seg), "TCP_SEG") 53 #endif /* LWIP_TCP */ 54 55 #if LWIP_IPV4 && IP_REASSEMBLY 56 LWIP_MEMPOOL(REASSDATA, MEMP_NUM_REASSDATA, sizeof(struct ip_reassdata), "REASSDATA") 57 #endif /* LWIP_IPV4 && IP_REASSEMBLY */ 58 #if (IP_FRAG && !LWIP_NETIF_TX_SINGLE_PBUF) || (LWIP_IPV6 && LWIP_IPV6_FRAG) 59 LWIP_MEMPOOL(FRAG_PBUF, MEMP_NUM_FRAG_PBUF, sizeof(struct pbuf_custom_ref), "FRAG_PBUF") 60 #endif /* IP_FRAG && !LWIP_NETIF_TX_SINGLE_PBUF || (LWIP_IPV6 && LWIP_IPV6_FRAG) */ 61 62 #if LWIP_NETCONN || LWIP_SOCKET 63 LWIP_MEMPOOL(NETBUF, MEMP_NUM_NETBUF, sizeof(struct netbuf), "NETBUF") 64 LWIP_MEMPOOL(NETCONN, MEMP_NUM_NETCONN, sizeof(struct netconn), "NETCONN") 65 #endif /* LWIP_NETCONN || LWIP_SOCKET */ 66 67 #if NO_SYS==0 68 LWIP_MEMPOOL(TCPIP_MSG_API, MEMP_NUM_TCPIP_MSG_API, sizeof(struct tcpip_msg), "TCPIP_MSG_API") 69 #if LWIP_MPU_COMPATIBLE 70 LWIP_MEMPOOL(API_MSG, MEMP_NUM_API_MSG, sizeof(struct api_msg), "API_MSG") 71 #if LWIP_DNS 72 LWIP_MEMPOOL(DNS_API_MSG, MEMP_NUM_DNS_API_MSG, sizeof(struct dns_api_msg), "DNS_API_MSG") 73 #endif 74 #if LWIP_SOCKET && !LWIP_TCPIP_CORE_LOCKING 75 LWIP_MEMPOOL(SOCKET_SETGETSOCKOPT_DATA, MEMP_NUM_SOCKET_SETGETSOCKOPT_DATA, sizeof(struct lwip_setgetsockopt_data), 76 "SOCKET_SETGETSOCKOPT_DATA") 77 #endif 78 #if LWIP_NETIF_API 79 LWIP_MEMPOOL(NETIFAPI_MSG, MEMP_NUM_NETIFAPI_MSG, sizeof(struct netifapi_msg), "NETIFAPI_MSG") 80 #endif 81 #endif /* LWIP_MPU_COMPATIBLE */ 82 #if !LWIP_TCPIP_CORE_LOCKING_INPUT 83 LWIP_MEMPOOL(TCPIP_MSG_INPKT, MEMP_NUM_TCPIP_MSG_INPKT, sizeof(struct tcpip_msg), "TCPIP_MSG_INPKT") 84 #endif /* !LWIP_TCPIP_CORE_LOCKING_INPUT */ 85 #endif /* NO_SYS==0 */ 86 87 #if LWIP_IPV4 && LWIP_ARP && ARP_QUEUEING 88 LWIP_MEMPOOL(ARP_QUEUE, MEMP_NUM_ARP_QUEUE, sizeof(struct etharp_q_entry), "ARP_QUEUE") 89 #endif /* LWIP_IPV4 && LWIP_ARP && ARP_QUEUEING */ 90 91 #if LWIP_IGMP 92 LWIP_MEMPOOL(IGMP_GROUP, MEMP_NUM_IGMP_GROUP, sizeof(struct igmp_group), "IGMP_GROUP") 93 #endif /* LWIP_IGMP */ 94 95 #if LWIP_TIMERS && !LWIP_TIMERS_CUSTOM 96 #if LWIP_LOWPOWER 97 LWIP_MEMPOOL(SYS_TIMEOUT, MEMP_NUM_SYS_TIMEOUT_LOW, sizeof(struct timer_entry), "SYS_TIMEOUT") 98 LWIP_MEMPOOL(TCPIP_MSG_LOWPOWER, MEMP_NUM_TCPIP_MSG_LOWPOWER, sizeof(struct tcpip_msg), "TCPIP_MSG_NA") 99 #else 100 LWIP_MEMPOOL(SYS_TIMEOUT, MEMP_NUM_SYS_TIMEOUT, sizeof(struct sys_timeo), "SYS_TIMEOUT") 101 #endif /* LWIP_LOWPOWER */ 102 #endif /* LWIP_TIMERS && !LWIP_TIMERS_CUSTOM */ 103 104 #if LWIP_L3_EVENT_MSG 105 LWIP_MEMPOOL(L3_EVENT_MSG, MEMP_NUM_L3_EVENT_MSG, sizeof(struct tcpip_msg), "L3_EVENT_MSG") 106 #endif /* LWIP_L3_EVENT_MSG */ 107 108 #if LWIP_DNS && LWIP_SOCKET 109 LWIP_MEMPOOL(NETDB, MEMP_NUM_NETDB, NETDB_ELEM_SIZE, "NETDB") 110 #endif /* LWIP_DNS && LWIP_SOCKET */ 111 #if LWIP_DNS && DNS_LOCAL_HOSTLIST && DNS_LOCAL_HOSTLIST_IS_DYNAMIC 112 LWIP_MEMPOOL(LOCALHOSTLIST, MEMP_NUM_LOCALHOSTLIST, LOCALHOSTLIST_ELEM_SIZE, "LOCALHOSTLIST") 113 #endif /* LWIP_DNS && DNS_LOCAL_HOSTLIST && DNS_LOCAL_HOSTLIST_IS_DYNAMIC */ 114 115 #if LWIP_IPV6 && LWIP_ND6_QUEUEING 116 LWIP_MEMPOOL(ND6_QUEUE, MEMP_NUM_ND6_QUEUE, sizeof(struct nd6_q_entry), "ND6_QUEUE") 117 #endif /* LWIP_IPV6 && LWIP_ND6_QUEUEING */ 118 119 #if LWIP_IPV6 && LWIP_IPV6_REASS 120 LWIP_MEMPOOL(IP6_REASSDATA, MEMP_NUM_REASSDATA, sizeof(struct ip6_reassdata), "IP6_REASSDATA") 121 #endif /* LWIP_IPV6 && LWIP_IPV6_REASS */ 122 123 #if LWIP_IPV6 && LWIP_IPV6_MLD 124 LWIP_MEMPOOL(MLD6_GROUP, MEMP_NUM_MLD6_GROUP, sizeof(struct mld_group), "MLD6_GROUP") 125 #endif /* LWIP_IPV6 && LWIP_IPV6_MLD */ 126 127 #if LWIP_RPL 128 LWIP_MEMPOOL(RPL_API_MSG, MEMP_NUM_RPL_API_MSG, sizeof(struct rplapi_msg), "RPL_API_MSG") 129 #endif 130 131 /* 132 * A list of pools of pbuf's used by LWIP. 133 * 134 * LWIP_PBUF_MEMPOOL(pool_name, number_elements, pbuf_payload_size, pool_description) 135 * creates a pool name MEMP_pool_name. description is used in stats.c 136 * This allocates enough space for the pbuf struct and a payload. 137 * (Example: pbuf_payload_size=0 allocates only size for the struct) 138 */ 139 LWIP_PBUF_MEMPOOL(PBUF, MEMP_NUM_PBUF, 0, "PBUF_REF/ROM") 140 LWIP_PBUF_MEMPOOL(PBUF_POOL, PBUF_POOL_SIZE, PBUF_POOL_BUFSIZE, "PBUF_POOL") 141 142 143 /* 144 * Allow for user-defined pools; this must be explicitly set in lwipopts.h 145 * since the default is to NOT look for lwippools.h 146 */ 147 #if MEMP_USE_CUSTOM_POOLS 148 #include "lwippools.h" 149 #endif /* MEMP_USE_CUSTOM_POOLS */ 150 151 /* 152 * REQUIRED CLEANUP: Clear up so we don't get "multiply defined" error later 153 * (#undef is ignored for something that is not defined) 154 */ 155 #undef LWIP_MEMPOOL 156 #undef LWIP_MALLOC_MEMPOOL 157 #undef LWIP_MALLOC_MEMPOOL_START 158 #undef LWIP_MALLOC_MEMPOOL_END 159 #undef LWIP_PBUF_MEMPOOL 160