l4/pkg/ankh/lib/lwip/lib/contrib/src/core/init.c

   1 /**
   2  * @file
   3  * Modules initialization
   4  *
   5  */
   6
   7 /*
   8  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification,
  12  * are permitted provided that the following conditions are met:
  13  *
  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.
  21  *
  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
  31  * OF SUCH DAMAGE.
  32  *
  33  * This file is part of the lwIP TCP/IP stack.
  34  *
  35  * Author: Adam Dunkels <adam@sics.se>
  36  *
  37  */
  38
  39 #include "lwip/opt.h"
  40
  41 #include "lwip/init.h"
  42 #include "lwip/stats.h"
  43 #include "lwip/sys.h"
  44 #include "lwip/mem.h"
  45 #include "lwip/memp.h"
  46 #include "lwip/pbuf.h"
  47 #include "lwip/netif.h"
  48 #include "lwip/sockets.h"
  49 #include "lwip/ip.h"
  50 #include "lwip/raw.h"
  51 #include "lwip/udp.h"
  52 #include "lwip/tcp_impl.h"
  53 #include "lwip/snmp_msg.h"
  54 #include "lwip/autoip.h"
  55 #include "lwip/igmp.h"
  56 #include "lwip/dns.h"
  57 #include "lwip/timers.h"
  58 #include "netif/etharp.h"
  59 #include "lwip/ip6.h"
  60 #include "lwip/nd6.h"
  61 #include "lwip/mld6.h"
  62 #include "lwip/api.h"
  63
  64 /* Compile-time sanity checks for configuration errors.
  65  * These can be done independently of LWIP_DEBUG, without penalty.
  66  */
  67 #ifndef BYTE_ORDER
  68   #error "BYTE_ORDER is not defined, you have to define it in your cc.h"
  69 #endif
  70 #if (!IP_SOF_BROADCAST && IP_SOF_BROADCAST_RECV)
  71   #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"
  72 #endif
  73 #if (!LWIP_ARP && ARP_QUEUEING)
  74   #error "If you want to use ARP Queueing, you have to define LWIP_ARP=1 in your lwipopts.h"
  75 #endif
  76 #if (!LWIP_UDP && LWIP_UDPLITE)
  77   #error "If you want to use UDP Lite, you have to define LWIP_UDP=1 in your lwipopts.h"
  78 #endif
  79 #if (!LWIP_UDP && LWIP_SNMP)
  80   #error "If you want to use SNMP, you have to define LWIP_UDP=1 in your lwipopts.h"
  81 #endif
  82 #if (!LWIP_UDP && LWIP_DHCP)
  83   #error "If you want to use DHCP, you have to define LWIP_UDP=1 in your lwipopts.h"
  84 #endif
  85 #if (!LWIP_UDP && LWIP_IGMP)
  86   #error "If you want to use IGMP, you have to define LWIP_UDP=1 in your lwipopts.h"
  87 #endif
  88 #if (!LWIP_UDP && LWIP_SNMP)
  89   #error "If you want to use SNMP, you have to define LWIP_UDP=1 in your lwipopts.h"
  90 #endif
  91 #if (!LWIP_UDP && LWIP_DNS)
  92   #error "If you want to use DNS, you have to define LWIP_UDP=1 in your lwipopts.h"
  93 #endif
  94 #if (LWIP_ARP && ARP_QUEUEING && (MEMP_NUM_ARP_QUEUE<=0))
  95   #error "If you want to use ARP Queueing, you have to define MEMP_NUM_ARP_QUEUE>=1 in your lwipopts.h"
  96 #endif
  97 #if (LWIP_RAW && (MEMP_NUM_RAW_PCB<=0))
  98   #error "If you want to use RAW, you have to define MEMP_NUM_RAW_PCB>=1 in your lwipopts.h"
  99 #endif
 100 #if (LWIP_UDP && (MEMP_NUM_UDP_PCB<=0))
 101   #error "If you want to use UDP, you have to define MEMP_NUM_UDP_PCB>=1 in your lwipopts.h"
 102 #endif
 103 #if (LWIP_TCP && (MEMP_NUM_TCP_PCB<=0))
 104   #error "If you want to use TCP, you have to define MEMP_NUM_TCP_PCB>=1 in your lwipopts.h"
 105 #endif
 106 #if (LWIP_TCP && (TCP_WND > 0xffff))
 107   #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"
 108 #endif
 109 #if (LWIP_TCP && (TCP_SND_QUEUELEN > 0xffff))
 110   #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"
 111 #endif
 112 #if (LWIP_TCP && (TCP_SND_QUEUELEN < 2))
 113   #error "TCP_SND_QUEUELEN must be at least 2 for no-copy TCP writes to work"
 114 #endif
 115 #if (LWIP_TCP && ((TCP_MAXRTX > 12) || (TCP_SYNMAXRTX > 12)))
 116   #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"
 117 #endif
 118 #if (LWIP_TCP && TCP_LISTEN_BACKLOG && (TCP_DEFAULT_LISTEN_BACKLOG < 0) || (TCP_DEFAULT_LISTEN_BACKLOG > 0xff))
 119   #error "If you want to use TCP backlog, TCP_DEFAULT_LISTEN_BACKLOG must fit into an u8_t"
 120 #endif
 121 #if (LWIP_IGMP && (MEMP_NUM_IGMP_GROUP<=1))
 122   #error "If you want to use IGMP, you have to define MEMP_NUM_IGMP_GROUP>1 in your lwipopts.h"
 123 #endif
 124 #if (LWIP_NETIF_API && (NO_SYS==1))
 125   #error "If you want to use NETIF API, you have to define NO_SYS=0 in your lwipopts.h"
 126 #endif
 127 #if ((LWIP_SOCKET || LWIP_NETCONN) && (NO_SYS==1))
 128   #error "If you want to use Sequential API, you have to define NO_SYS=0 in your lwipopts.h"
 129 #endif
 130 #if ((LWIP_NETCONN || LWIP_SOCKET) && (MEMP_NUM_TCPIP_MSG_API<=0))
 131   #error "If you want to use Sequential API, you have to define MEMP_NUM_TCPIP_MSG_API>=1 in your lwipopts.h"
 132 #endif
 133 #if (!LWIP_NETCONN && LWIP_SOCKET)
 134   #error "If you want to use Socket API, you have to define LWIP_NETCONN=1 in your lwipopts.h"
 135 #endif
 136 #if (((!LWIP_DHCP) || (!LWIP_AUTOIP)) && LWIP_DHCP_AUTOIP_COOP)
 137   #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"
 138 #endif
 139 #if (((!LWIP_DHCP) || (!LWIP_ARP)) && DHCP_DOES_ARP_CHECK)
 140   #error "If you want to use DHCP ARP checking, you have to define LWIP_DHCP=1 and LWIP_ARP=1 in your lwipopts.h"
 141 #endif
 142 #if (!LWIP_ARP && LWIP_AUTOIP)
 143   #error "If you want to use AUTOIP, you have to define LWIP_ARP=1 in your lwipopts.h"
 144 #endif
 145 #if (LWIP_SNMP && (SNMP_CONCURRENT_REQUESTS<=0))
 146   #error "If you want to use SNMP, you have to define SNMP_CONCURRENT_REQUESTS>=1 in your lwipopts.h"
 147 #endif
 148 #if (LWIP_SNMP && (SNMP_TRAP_DESTINATIONS<=0))
 149   #error "If you want to use SNMP, you have to define SNMP_TRAP_DESTINATIONS>=1 in your lwipopts.h"
 150 #endif
 151 #if (LWIP_TCP && ((LWIP_EVENT_API && LWIP_CALLBACK_API) || (!LWIP_EVENT_API && !LWIP_CALLBACK_API)))
 152   #error "One and exactly one of LWIP_EVENT_API and LWIP_CALLBACK_API has to be enabled in your lwipopts.h"
 153 #endif
 154 /* There must be sufficient timeouts, taking into account requirements of the subsystems. */
 155 #if LWIP_TIMERS && (MEMP_NUM_SYS_TIMEOUT < (LWIP_TCP + IP_REASSEMBLY + LWIP_ARP + (2*LWIP_DHCP) + LWIP_AUTOIP + LWIP_IGMP + LWIP_DNS + PPP_SUPPORT))
 156   #error "MEMP_NUM_SYS_TIMEOUT is too low to accomodate all required timeouts"
 157 #endif
 158 #if (IP_REASSEMBLY && (MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS))
 159   #error "MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS doesn't make sense since each struct ip_reassdata must hold 2 pbufs at least!"
 160 #endif
 161 #if (MEM_LIBC_MALLOC && MEM_USE_POOLS)
 162   #error "MEM_LIBC_MALLOC and MEM_USE_POOLS may not both be simultaneously enabled in your lwipopts.h"
 163 #endif
 164 #if (MEM_USE_POOLS && !MEMP_USE_CUSTOM_POOLS)
 165   #error "MEM_USE_POOLS requires custom pools (MEMP_USE_CUSTOM_POOLS) to be enabled in your lwipopts.h"
 166 #endif
 167 #if (PBUF_POOL_BUFSIZE <= MEM_ALIGNMENT)
 168   #error "PBUF_POOL_BUFSIZE must be greater than MEM_ALIGNMENT or the offset may take the full first pbuf"
 169 #endif
 170 #if (TCP_QUEUE_OOSEQ && !LWIP_TCP)
 171   #error "TCP_QUEUE_OOSEQ requires LWIP_TCP"
 172 #endif
 173 #if (DNS_LOCAL_HOSTLIST && !DNS_LOCAL_HOSTLIST_IS_DYNAMIC && !(defined(DNS_LOCAL_HOSTLIST_INIT)))
 174   #error "you have to define define DNS_LOCAL_HOSTLIST_INIT {{'host1', 0x123}, {'host2', 0x234}} to initialize DNS_LOCAL_HOSTLIST"
 175 #endif
 176 #if PPP_SUPPORT && !PPPOS_SUPPORT & !PPPOE_SUPPORT
 177   #error "PPP_SUPPORT needs either PPPOS_SUPPORT or PPPOE_SUPPORT turned on"
 178 #endif
 179 #if !LWIP_ETHERNET && (LWIP_ARP || PPPOE_SUPPORT)
 180   #error "LWIP_ETHERNET needs to be turned on for LWIP_ARP or PPPOE_SUPPORT"
 181 #endif
 182 #if (LWIP_IGMP || LWIP_IPV6) && !defined(LWIP_RAND)
 183   #error "When using IGMP or IPv6, LWIP_RAND() needs to be defined to a random-function returning an u32_t random value"
 184 #endif
 185 #if LWIP_TCPIP_CORE_LOCKING_INPUT && !LWIP_TCPIP_CORE_LOCKING
 186   #error "When using LWIP_TCPIP_CORE_LOCKING_INPUT, LWIP_TCPIP_CORE_LOCKING must be enabled, too"
 187 #endif
 188 #if LWIP_TCP && LWIP_NETIF_TX_SINGLE_PBUF && !TCP_OVERSIZE
 189   #error "LWIP_NETIF_TX_SINGLE_PBUF needs TCP_OVERSIZE enabled to create single-pbuf TCP packets"
 190 #endif
 191 #if IP_FRAG && IP_FRAG_USES_STATIC_BUF && LWIP_NETIF_TX_SINGLE_PBUF
 192   #error "LWIP_NETIF_TX_SINGLE_PBUF does not work with IP_FRAG_USES_STATIC_BUF==1 as that creates pbuf queues"
 193 #endif
 194 #if LWIP_NETCONN && LWIP_TCP
 195 #if NETCONN_COPY != TCP_WRITE_FLAG_COPY
 196   #error "NETCONN_COPY != TCP_WRITE_FLAG_COPY"
 197 #endif
 198 #if NETCONN_MORE != TCP_WRITE_FLAG_MORE
 199   #error "NETCONN_MORE != TCP_WRITE_FLAG_MORE"
 200 #endif
 201 #endif /* LWIP_NETCONN && LWIP_TCP */
 202 #if LWIP_SOCKET
 203 /* Check that the SO_* socket options and SOF_* lwIP-internal flags match */
 204 #if SO_ACCEPTCONN != SOF_ACCEPTCONN
 205   #error "SO_ACCEPTCONN != SOF_ACCEPTCONN"
 206 #endif
 207 #if SO_REUSEADDR != SOF_REUSEADDR
 208   #error "WARNING: SO_REUSEADDR != SOF_REUSEADDR"
 209 #endif
 210 #if SO_KEEPALIVE != SOF_KEEPALIVE
 211   #error "WARNING: SO_KEEPALIVE != SOF_KEEPALIVE"
 212 #endif
 213 #if SO_BROADCAST != SOF_BROADCAST
 214   #error "WARNING: SO_BROADCAST != SOF_BROADCAST"
 215 #endif
 216 #if SO_LINGER != SOF_LINGER
 217   #error "WARNING: SO_LINGER != SOF_LINGER"
 218 #endif
 219 #endif /* LWIP_SOCKET */
 220
 221
 222 /* Compile-time checks for deprecated options.
 223  */
 224 #ifdef MEMP_NUM_TCPIP_MSG
 225   #error "MEMP_NUM_TCPIP_MSG option is deprecated. Remove it from your lwipopts.h."
 226 #endif
 227 #ifdef MEMP_NUM_API_MSG
 228   #error "MEMP_NUM_API_MSG option is deprecated. Remove it from your lwipopts.h."
 229 #endif
 230 #ifdef TCP_REXMIT_DEBUG
 231   #error "TCP_REXMIT_DEBUG option is deprecated. Remove it from your lwipopts.h."
 232 #endif
 233 #ifdef RAW_STATS
 234   #error "RAW_STATS option is deprecated. Remove it from your lwipopts.h."
 235 #endif
 236 #ifdef ETHARP_QUEUE_FIRST
 237   #error "ETHARP_QUEUE_FIRST option is deprecated. Remove it from your lwipopts.h."
 238 #endif
 239 #ifdef ETHARP_ALWAYS_INSERT
 240   #error "ETHARP_ALWAYS_INSERT option is deprecated. Remove it from your lwipopts.h."
 241 #endif
 242
 243 #ifdef LWIP_DEBUG
 244 static void
 245 lwip_sanity_check(void)
 246 {
 247   /* Warnings */
 248 #if LWIP_NETCONN
 249   if (MEMP_NUM_NETCONN > (MEMP_NUM_TCP_PCB+MEMP_NUM_TCP_PCB_LISTEN+MEMP_NUM_UDP_PCB+MEMP_NUM_RAW_PCB))
 250     LWIP_PLATFORM_DIAG(("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\n"));
 251 #endif /* LWIP_NETCONN */
 252 #if LWIP_TCP
 253   if (MEMP_NUM_TCP_SEG < TCP_SND_QUEUELEN)
 254     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: MEMP_NUM_TCP_SEG should be at least as big as TCP_SND_QUEUELEN\n"));
 255   if (TCP_SND_BUF < 2 * TCP_MSS)
 256     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SND_BUF must be at least as much as (2 * TCP_MSS) for things to work smoothly\n"));
 257   if (TCP_SND_QUEUELEN < (2 * (TCP_SND_BUF/TCP_MSS)))
 258     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SND_QUEUELEN must be at least as much as (2 * TCP_SND_BUF/TCP_MSS) for things to work\n"));
 259   if (TCP_SNDLOWAT >= TCP_SND_BUF)
 260     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SNDLOWAT must be less than TCP_SND_BUF.\n"));
 261   if (TCP_SNDQUEUELOWAT >= TCP_SND_QUEUELEN)
 262     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SNDQUEUELOWAT must be less than TCP_SND_QUEUELEN.\n"));
 263   if (TCP_WND > (PBUF_POOL_SIZE*PBUF_POOL_BUFSIZE))
 264     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_WND is larger than space provided by PBUF_POOL_SIZE*PBUF_POOL_BUFSIZE\n"));
 265   if (TCP_WND < TCP_MSS)
 266     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_WND is smaller than MSS\n"));
 267 #endif /* LWIP_TCP */
 268 }
 269 #else  /* LWIP_DEBUG */
 270 #define lwip_sanity_check()
 271 #endif /* LWIP_DEBUG */
 272
 273 /**
 274  * Perform Sanity check of user-configurable values, and initialize all modules.
 275  */
 276 void
 277 lwip_init(void)
 278 {
 279   /* Sanity check user-configurable values */
 280   lwip_sanity_check();
 281
 282   /* Modules initialization */
 283   stats_init();
 284 #if !NO_SYS
 285   sys_init();
 286 #endif /* !NO_SYS */
 287   mem_init();
 288   memp_init();
 289   pbuf_init();
 290   netif_init();
 291 #if LWIP_SOCKET
 292   lwip_socket_init();
 293 #endif /* LWIP_SOCKET */
 294   ip_init();
 295 #if LWIP_ARP
 296   etharp_init();
 297 #endif /* LWIP_ARP */
 298 #if LWIP_RAW
 299   raw_init();
 300 #endif /* LWIP_RAW */
 301 #if LWIP_UDP
 302   udp_init();
 303 #endif /* LWIP_UDP */
 304 #if LWIP_TCP
 305   tcp_init();
 306 #endif /* LWIP_TCP */
 307 #if LWIP_SNMP
 308   snmp_init();
 309 #endif /* LWIP_SNMP */
 310 #if LWIP_AUTOIP
 311   autoip_init();
 312 #endif /* LWIP_AUTOIP */
 313 #if LWIP_IGMP
 314   igmp_init();
 315 #endif /* LWIP_IGMP */
 316 #if LWIP_DNS
 317   dns_init();
 318 #endif /* LWIP_DNS */
 319 #if LWIP_IPV6
 320   ip6_init();
 321   nd6_init();
 322 #if LWIP_IPV6_MLD
 323   mld6_init();
 324 #endif /* LWIP_IPV6_MLD */
 325 #endif /* LWIP_IPV6 */
 326
 327 #if LWIP_TIMERS
 328   sys_timeouts_init();
 329 #endif /* LWIP_TIMERS */
 330 }