3 * Modules initialization
8 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 * 3. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
33 * This file is part of the lwIP TCP/IP stack.
35 * Author: Adam Dunkels <adam@sics.se>
40 #include "lwip/init.h"
41 #include "lwip/stats.h"
44 #include "lwip/memp.h"
45 #include "lwip/pbuf.h"
46 #include "lwip/netif.h"
47 #include "lwip/sockets.h"
51 #include "lwip/priv/tcp_priv.h"
52 #include "lwip/igmp.h"
54 #include "lwip/timeouts.h"
55 #include "lwip/etharp.h"
58 #include "lwip/mld6.h"
61 #include "netif/ppp/ppp_opts.h"
62 #include "netif/ppp/ppp_impl.h"
64 #ifndef LWIP_SKIP_PACKING_CHECK
66 #ifdef PACK_STRUCT_USE_INCLUDES
67 # include "arch/bpstruct.h"
70 struct packed_struct_test
72 PACK_STRUCT_FLD_8(u8_t dummy1);
73 PACK_STRUCT_FIELD(u32_t dummy2);
76 #ifdef PACK_STRUCT_USE_INCLUDES
77 # include "arch/epstruct.h"
79 #define PACKED_STRUCT_TEST_EXPECTED_SIZE 5
83 /* Compile-time sanity checks for configuration errors.
84 * These can be done independently of LWIP_DEBUG, without penalty.
87 #error "BYTE_ORDER is not defined, you have to define it in your cc.h"
89 #if (!IP_SOF_BROADCAST && IP_SOF_BROADCAST_RECV)
90 #error "If you want to use broadcast filter per pcb on recv operations, you have to define IP_SOF_BROADCAST=1 in your lwipopts.h"
92 #if (!LWIP_UDP && LWIP_UDPLITE)
93 #error "If you want to use UDP Lite, you have to define LWIP_UDP=1 in your lwipopts.h"
95 #if (!LWIP_UDP && LWIP_DHCP)
96 #error "If you want to use DHCP, you have to define LWIP_UDP=1 in your lwipopts.h"
98 #if (!LWIP_UDP && !LWIP_RAW && LWIP_MULTICAST_TX_OPTIONS)
99 #error "If you want to use LWIP_MULTICAST_TX_OPTIONS, you have to define LWIP_UDP=1 and/or LWIP_RAW=1 in your lwipopts.h"
101 #if (!LWIP_UDP && LWIP_DNS)
102 #error "If you want to use DNS, you have to define LWIP_UDP=1 in your lwipopts.h"
104 #if !MEMP_MEM_MALLOC /* MEMP_NUM_* checks are disabled when not using the pool allocator */
105 #if (LWIP_ARP && ARP_QUEUEING && (MEMP_NUM_ARP_QUEUE<=0))
106 #error "If you want to use ARP Queueing, you have to define MEMP_NUM_ARP_QUEUE>=1 in your lwipopts.h"
108 #if (LWIP_RAW && (MEMP_NUM_RAW_PCB<=0))
109 #error "If you want to use RAW, you have to define MEMP_NUM_RAW_PCB>=1 in your lwipopts.h"
111 #if (LWIP_UDP && (MEMP_NUM_UDP_PCB<=0))
112 #error "If you want to use UDP, you have to define MEMP_NUM_UDP_PCB>=1 in your lwipopts.h"
114 #if (LWIP_TCP && (MEMP_NUM_TCP_PCB<=0))
115 #error "If you want to use TCP, you have to define MEMP_NUM_TCP_PCB>=1 in your lwipopts.h"
117 #if (LWIP_IGMP && (MEMP_NUM_IGMP_GROUP<=1))
118 #error "If you want to use IGMP, you have to define MEMP_NUM_IGMP_GROUP>1 in your lwipopts.h"
120 #if (LWIP_IGMP && !LWIP_MULTICAST_TX_OPTIONS)
121 #error "If you want to use IGMP, you have to define LWIP_MULTICAST_TX_OPTIONS==1 in your lwipopts.h"
123 #if (LWIP_IGMP && !LWIP_IPV4)
124 #error "IGMP needs LWIP_IPV4 enabled in your lwipopts.h"
126 #if ((LWIP_NETCONN || LWIP_SOCKET) && (MEMP_NUM_TCPIP_MSG_API<=0))
127 #error "If you want to use Sequential API, you have to define MEMP_NUM_TCPIP_MSG_API>=1 in your lwipopts.h"
129 /* There must be sufficient timeouts, taking into account requirements of the subsystems. */
130 #if LWIP_TIMERS && (MEMP_NUM_SYS_TIMEOUT < (LWIP_TCP + IP_REASSEMBLY + LWIP_ARP + (2*LWIP_DHCP) + LWIP_AUTOIP + LWIP_IGMP + LWIP_DNS + PPP_SUPPORT + (LWIP_IPV6 ? (1 + LWIP_IPV6_REASS + LWIP_IPV6_MLD) : 0)))
131 #error "MEMP_NUM_SYS_TIMEOUT is too low to accomodate all required timeouts"
133 #if (IP_REASSEMBLY && (MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS))
134 #error "MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS doesn't make sense since each struct ip_reassdata must hold 2 pbufs at least!"
136 #endif /* !MEMP_MEM_MALLOC */
138 #if (LWIP_TCP && (TCP_WND > 0xffffffff))
139 #error "If you want to use TCP, TCP_WND must fit in an u32_t, so, you have to reduce it in your lwipopts.h"
141 #if (LWIP_TCP && (TCP_RCV_SCALE > 14))
142 #error "The maximum valid window scale value is 14!"
144 #if (LWIP_TCP && (TCP_WND > (0xFFFFU << TCP_RCV_SCALE)))
145 #error "TCP_WND is bigger than the configured LWIP_WND_SCALE allows!"
147 #if (LWIP_TCP && ((TCP_WND >> TCP_RCV_SCALE) == 0))
148 #error "TCP_WND is too small for the configured LWIP_WND_SCALE (results in zero window)!"
150 #else /* LWIP_WND_SCALE */
151 #if (LWIP_TCP && (TCP_WND > 0xffff))
152 #error "If you want to use TCP, TCP_WND must fit in an u16_t, so, you have to reduce it in your lwipopts.h (or enable window scaling)"
154 #endif /* LWIP_WND_SCALE */
155 #if (LWIP_TCP && (TCP_SND_QUEUELEN > 0xffff))
156 #error "If you want to use TCP, TCP_SND_QUEUELEN must fit in an u16_t, so, you have to reduce it in your lwipopts.h"
158 #if (LWIP_TCP && (TCP_SND_QUEUELEN < 2))
159 #error "TCP_SND_QUEUELEN must be at least 2 for no-copy TCP writes to work"
161 #if (LWIP_TCP && ((TCP_MAXRTX > 12) || (TCP_SYNMAXRTX > 12)))
162 #error "If you want to use TCP, TCP_MAXRTX and TCP_SYNMAXRTX must less or equal to 12 (due to tcp_backoff table), so, you have to reduce them in your lwipopts.h"
164 #if (LWIP_TCP && TCP_LISTEN_BACKLOG && ((TCP_DEFAULT_LISTEN_BACKLOG < 0) || (TCP_DEFAULT_LISTEN_BACKLOG > 0xff)))
165 #error "If you want to use TCP backlog, TCP_DEFAULT_LISTEN_BACKLOG must fit into an u8_t"
167 #if (LWIP_NETIF_API && (NO_SYS==1))
168 #error "If you want to use NETIF API, you have to define NO_SYS=0 in your lwipopts.h"
170 #if ((LWIP_SOCKET || LWIP_NETCONN) && (NO_SYS==1))
171 #error "If you want to use Sequential API, you have to define NO_SYS=0 in your lwipopts.h"
173 #if (LWIP_PPP_API && (NO_SYS==1))
174 #error "If you want to use PPP API, you have to define NO_SYS=0 in your lwipopts.h"
176 #if (LWIP_PPP_API && (PPP_SUPPORT==0))
177 #error "If you want to use PPP API, you have to enable PPP_SUPPORT in your lwipopts.h"
179 #if (((!LWIP_DHCP) || (!LWIP_AUTOIP)) && LWIP_DHCP_AUTOIP_COOP)
180 #error "If you want to use DHCP/AUTOIP cooperation mode, you have to define LWIP_DHCP=1 and LWIP_AUTOIP=1 in your lwipopts.h"
182 #if (((!LWIP_DHCP) || (!LWIP_ARP)) && DHCP_DOES_ARP_CHECK)
183 #error "If you want to use DHCP ARP checking, you have to define LWIP_DHCP=1 and LWIP_ARP=1 in your lwipopts.h"
185 #if (!LWIP_ARP && LWIP_AUTOIP)
186 #error "If you want to use AUTOIP, you have to define LWIP_ARP=1 in your lwipopts.h"
188 #if (LWIP_TCP && ((LWIP_EVENT_API && LWIP_CALLBACK_API) || (!LWIP_EVENT_API && !LWIP_CALLBACK_API)))
189 #error "One and exactly one of LWIP_EVENT_API and LWIP_CALLBACK_API has to be enabled in your lwipopts.h"
191 #if (MEM_LIBC_MALLOC && MEM_USE_POOLS)
192 #error "MEM_LIBC_MALLOC and MEM_USE_POOLS may not both be simultaneously enabled in your lwipopts.h"
194 #if (MEM_USE_POOLS && !MEMP_USE_CUSTOM_POOLS)
195 #error "MEM_USE_POOLS requires custom pools (MEMP_USE_CUSTOM_POOLS) to be enabled in your lwipopts.h"
198 #if !LWIP_PBUF_FROM_CUSTOM_POOLS
199 extern int PBUFF_POOL_SIZE_TOO_SMALL[ (signed)(PBUF_POOL_BUFSIZE - MEM_ALIGNMENT - 1) ]; // error: PBUF_POOL_BUFSIZE must be greater than MEM_ALIGNMENT or the offset may take the full first pbuf
202 #if (DNS_LOCAL_HOSTLIST && !DNS_LOCAL_HOSTLIST_IS_DYNAMIC && !(defined(DNS_LOCAL_HOSTLIST_INIT)))
203 #error "you have to define define DNS_LOCAL_HOSTLIST_INIT {{'host1', 0x123}, {'host2', 0x234}} to initialize DNS_LOCAL_HOSTLIST"
205 #if PPP_SUPPORT && !PPPOS_SUPPORT && !PPPOE_SUPPORT && !PPPOL2TP_SUPPORT
206 #error "PPP_SUPPORT needs at least one of PPPOS_SUPPORT, PPPOE_SUPPORT or PPPOL2TP_SUPPORT turned on"
208 #if PPP_SUPPORT && !PPP_IPV4_SUPPORT && !PPP_IPV6_SUPPORT
209 #error "PPP_SUPPORT needs PPP_IPV4_SUPPORT and/or PPP_IPV6_SUPPORT turned on"
211 #if PPP_SUPPORT && PPP_IPV4_SUPPORT && !LWIP_IPV4
212 #error "PPP_IPV4_SUPPORT needs LWIP_IPV4 turned on"
214 #if PPP_SUPPORT && PPP_IPV6_SUPPORT && !LWIP_IPV6
215 #error "PPP_IPV6_SUPPORT needs LWIP_IPV6 turned on"
217 #if !LWIP_ETHERNET && (LWIP_ARP || PPPOE_SUPPORT)
218 #error "LWIP_ETHERNET needs to be turned on for LWIP_ARP or PPPOE_SUPPORT"
220 #if LWIP_TCPIP_CORE_LOCKING_INPUT && !LWIP_TCPIP_CORE_LOCKING
221 #error "When using LWIP_TCPIP_CORE_LOCKING_INPUT, LWIP_TCPIP_CORE_LOCKING must be enabled, too"
223 #if LWIP_TCP && LWIP_NETIF_TX_SINGLE_PBUF && !TCP_OVERSIZE
224 #error "LWIP_NETIF_TX_SINGLE_PBUF needs TCP_OVERSIZE enabled to create single-pbuf TCP packets"
226 #if LWIP_NETCONN && LWIP_TCP
227 #if NETCONN_COPY != TCP_WRITE_FLAG_COPY
228 #error "NETCONN_COPY != TCP_WRITE_FLAG_COPY"
230 #if NETCONN_MORE != TCP_WRITE_FLAG_MORE
231 #error "NETCONN_MORE != TCP_WRITE_FLAG_MORE"
233 #endif /* LWIP_NETCONN && LWIP_TCP */
235 /* Check that the SO_* socket options and SOF_* lwIP-internal flags match */
236 #if SO_REUSEADDR != SOF_REUSEADDR
237 #error "WARNING: SO_REUSEADDR != SOF_REUSEADDR"
239 #if SO_KEEPALIVE != SOF_KEEPALIVE
240 #error "WARNING: SO_KEEPALIVE != SOF_KEEPALIVE"
242 #if SO_BROADCAST != SOF_BROADCAST
243 #error "WARNING: SO_BROADCAST != SOF_BROADCAST"
245 #endif /* LWIP_SOCKET */
248 /* Compile-time checks for deprecated options.
250 #ifdef MEMP_NUM_TCPIP_MSG
251 #error "MEMP_NUM_TCPIP_MSG option is deprecated. Remove it from your lwipopts.h."
253 #ifdef TCP_REXMIT_DEBUG
254 #error "TCP_REXMIT_DEBUG option is deprecated. Remove it from your lwipopts.h."
257 #error "RAW_STATS option is deprecated. Remove it from your lwipopts.h."
259 #ifdef ETHARP_QUEUE_FIRST
260 #error "ETHARP_QUEUE_FIRST option is deprecated. Remove it from your lwipopts.h."
262 #ifdef ETHARP_ALWAYS_INSERT
263 #error "ETHARP_ALWAYS_INSERT option is deprecated. Remove it from your lwipopts.h."
265 #if !NO_SYS && LWIP_TCPIP_CORE_LOCKING && LWIP_COMPAT_MUTEX && !defined(LWIP_COMPAT_MUTEX_ALLOWED)
266 #error "LWIP_COMPAT_MUTEX cannot prevent priority inversion. It is recommended to implement priority-aware mutexes. (Define LWIP_COMPAT_MUTEX_ALLOWED to disable this error.)"
269 #ifndef LWIP_DISABLE_TCP_SANITY_CHECKS
270 #define LWIP_DISABLE_TCP_SANITY_CHECKS 0
272 #ifndef LWIP_DISABLE_MEMP_SANITY_CHECKS
273 #define LWIP_DISABLE_MEMP_SANITY_CHECKS 0
276 /* MEMP sanity checks */
278 #if !LWIP_DISABLE_MEMP_SANITY_CHECKS
279 #if LWIP_NETCONN || LWIP_SOCKET
280 #if !MEMP_NUM_NETCONN && LWIP_SOCKET
281 #error "lwip_sanity_check: WARNING: MEMP_NUM_NETCONN cannot be 0 when using sockets!"
283 #else /* MEMP_MEM_MALLOC */
284 #if MEMP_NUM_NETCONN > (MEMP_NUM_TCP_PCB+MEMP_NUM_TCP_PCB_LISTEN+MEMP_NUM_UDP_PCB+MEMP_NUM_RAW_PCB)
285 #error "lwip_sanity_check: WARNING: MEMP_NUM_NETCONN should be less than the sum of MEMP_NUM_{TCP,RAW,UDP}_PCB+MEMP_NUM_TCP_PCB_LISTEN. If you know what you are doing, define LWIP_DISABLE_MEMP_SANITY_CHECKS to 1 to disable this error."
287 #endif /* LWIP_NETCONN || LWIP_SOCKET */
288 #endif /* !LWIP_DISABLE_MEMP_SANITY_CHECKS */
290 #error "MEMP_MEM_MALLOC and MEM_USE_POOLS cannot be enabled at the same time"
292 #ifdef LWIP_HOOK_MEMP_AVAILABLE
293 #error "LWIP_HOOK_MEMP_AVAILABLE doesn't make sense with MEMP_MEM_MALLOC"
295 #endif /* MEMP_MEM_MALLOC */
297 /* TCP sanity checks */
298 #if !LWIP_DISABLE_TCP_SANITY_CHECKS
300 #if !MEMP_MEM_MALLOC && (MEMP_NUM_TCP_SEG < TCP_SND_QUEUELEN)
301 #error "lwip_sanity_check: WARNING: MEMP_NUM_TCP_SEG should be at least as big as TCP_SND_QUEUELEN. If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
303 #if TCP_SND_BUF < (2 * TCP_MSS)
304 #error "lwip_sanity_check: WARNING: TCP_SND_BUF must be at least as much as (2 * TCP_MSS) for things to work smoothly. If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
306 #if TCP_SND_QUEUELEN < (2 * (TCP_SND_BUF / TCP_MSS))
307 #error "lwip_sanity_check: WARNING: TCP_SND_QUEUELEN must be at least as much as (2 * TCP_SND_BUF/TCP_MSS) for things to work. If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
309 #if TCP_SNDLOWAT >= TCP_SND_BUF
310 #error "lwip_sanity_check: WARNING: TCP_SNDLOWAT must be less than TCP_SND_BUF. If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
312 #if TCP_SNDLOWAT >= (0xFFFF - (4 * TCP_MSS))
313 #error "lwip_sanity_check: WARNING: TCP_SNDLOWAT must at least be 4*MSS below u16_t overflow!"
315 #if TCP_SNDQUEUELOWAT >= TCP_SND_QUEUELEN
316 #error "lwip_sanity_check: WARNING: TCP_SNDQUEUELOWAT must be less than TCP_SND_QUEUELEN. If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
318 #if !MEMP_MEM_MALLOC && PBUF_POOL_SIZE && (PBUF_POOL_BUFSIZE <= (PBUF_LINK_ENCAPSULATION_HLEN + PBUF_LINK_HLEN + PBUF_IP_HLEN + PBUF_TRANSPORT_HLEN))
319 #error "lwip_sanity_check: WARNING: PBUF_POOL_BUFSIZE does not provide enough space for protocol headers. If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
321 #if !MEMP_MEM_MALLOC && PBUF_POOL_SIZE && (TCP_WND > (PBUF_POOL_SIZE * (PBUF_POOL_BUFSIZE - (PBUF_LINK_ENCAPSULATION_HLEN + PBUF_LINK_HLEN + PBUF_IP_HLEN + PBUF_TRANSPORT_HLEN))))
322 #error "lwip_sanity_check: WARNING: TCP_WND is larger than space provided by PBUF_POOL_SIZE * (PBUF_POOL_BUFSIZE - protocol headers). If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
324 #if TCP_WND < TCP_MSS
325 #error "lwip_sanity_check: WARNING: TCP_WND is smaller than MSS. If you know what you are doing, define LWIP_DISABLE_TCP_SANITY_CHECKS to 1 to disable this error."
327 #endif /* LWIP_TCP */
328 #endif /* !LWIP_DISABLE_TCP_SANITY_CHECKS */
331 * @ingroup lwip_nosys
332 * Initialize all modules.
333 * Use this in NO_SYS mode. Use tcpip_init() otherwise.
338 #ifndef LWIP_SKIP_CONST_CHECK
341 LWIP_ASSERT("LWIP_CONST_CAST not implemented correctly. Check your lwIP port.", LWIP_CONST_CAST(void*, &a) == &a);
343 #ifndef LWIP_SKIP_PACKING_CHECK
344 LWIP_ASSERT("Struct packing not implemented correctly. Check your lwIP port.", sizeof(struct packed_struct_test) == PACKED_STRUCT_TEST_EXPECTED_SIZE);
347 /* Modules initialization */
360 #endif /* LWIP_ARP */
361 #endif /* LWIP_IPV4 */
364 #endif /* LWIP_RAW */
367 #endif /* LWIP_UDP */
370 #endif /* LWIP_TCP */
373 #endif /* LWIP_IGMP */
376 #endif /* LWIP_DNS */
383 #endif /* LWIP_TIMERS */