init.c

00001 /**
00002  * @file
00003  * Modules initialization
00004  *
00005  */
00006 
00007 /*
00008  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00009  * All rights reserved. 
00010  * 
00011  * Redistribution and use in source and binary forms, with or without modification, 
00012  * are permitted provided that the following conditions are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright notice,
00015  *    this list of conditions and the following disclaimer.
00016  * 2. Redistributions in binary form must reproduce the above copyright notice,
00017  *    this list of conditions and the following disclaimer in the documentation
00018  *    and/or other materials provided with the distribution.
00019  * 3. The name of the author may not be used to endorse or promote products
00020  *    derived from this software without specific prior written permission. 
00021  *
00022  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
00023  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00024  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00025  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00026  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00027  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00030  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00031  * OF SUCH DAMAGE.
00032  *
00033  * This file is part of the lwIP TCP/IP stack.
00034  * 
00035  * Author: Adam Dunkels <adam@sics.se>
00036  *
00037  */
00038 
00039 #include "lwip/opt.h"
00040 
00041 #include "lwip/init.h"
00042 #include "lwip/stats.h"
00043 #include "lwip/sys.h"
00044 #include "lwip/mem.h"
00045 #include "lwip/memp.h"
00046 #include "lwip/pbuf.h"
00047 #include "lwip/netif.h"
00048 #include "lwip/sockets.h"
00049 #include "lwip/ip.h"
00050 #include "lwip/raw.h"
00051 #include "lwip/udp.h"
00052 #include "lwip/tcp.h"
00053 #include "lwip/snmp_msg.h"
00054 #include "lwip/autoip.h"
00055 #include "lwip/igmp.h"
00056 #include "lwip/dns.h"
00057 #include "netif/etharp.h"
00058 
00059 /* Compile-time sanity checks for configuration errors.
00060  * These can be done independently of LWIP_DEBUG, without penalty.
00061  */
00062 #ifndef BYTE_ORDER
00063   #error "BYTE_ORDER is not defined, you have to define it in your cc.h"
00064 #endif
00065 #if (!IP_SOF_BROADCAST && IP_SOF_BROADCAST_RECV)
00066   #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"
00067 #endif
00068 #if (!LWIP_ARP && ARP_QUEUEING)
00069   #error "If you want to use ARP Queueing, you have to define LWIP_ARP=1 in your lwipopts.h"
00070 #endif
00071 #if (!LWIP_UDP && LWIP_UDPLITE)
00072   #error "If you want to use UDP Lite, you have to define LWIP_UDP=1 in your lwipopts.h"
00073 #endif
00074 #if (!LWIP_UDP && LWIP_SNMP)
00075   #error "If you want to use SNMP, you have to define LWIP_UDP=1 in your lwipopts.h"
00076 #endif
00077 #if (!LWIP_UDP && LWIP_DHCP)
00078   #error "If you want to use DHCP, you have to define LWIP_UDP=1 in your lwipopts.h"
00079 #endif
00080 #if (!LWIP_UDP && LWIP_IGMP)
00081   #error "If you want to use IGMP, you have to define LWIP_UDP=1 in your lwipopts.h"
00082 #endif
00083 #if (!LWIP_UDP && LWIP_DNS)
00084   #error "If you want to use DNS, you have to define LWIP_UDP=1 in your lwipopts.h"
00085 #endif
00086 #if (LWIP_ARP && (ARP_TABLE_SIZE > 0x7f))
00087   #error "If you want to use ARP, ARP_TABLE_SIZE must fit in an s8_t, so, you have to reduce it in your lwipopts.h"
00088 #endif
00089 #if (LWIP_ARP && ARP_QUEUEING && (MEMP_NUM_ARP_QUEUE<=0))
00090   #error "If you want to use ARP Queueing, you have to define MEMP_NUM_ARP_QUEUE>=1 in your lwipopts.h"
00091 #endif
00092 #if (LWIP_RAW && (MEMP_NUM_RAW_PCB<=0))
00093   #error "If you want to use RAW, you have to define MEMP_NUM_RAW_PCB>=1 in your lwipopts.h"
00094 #endif
00095 #if (LWIP_UDP && (MEMP_NUM_UDP_PCB<=0))
00096   #error "If you want to use UDP, you have to define MEMP_NUM_UDP_PCB>=1 in your lwipopts.h"
00097 #endif
00098 #if (LWIP_TCP && (MEMP_NUM_TCP_PCB<=0))
00099   #error "If you want to use TCP, you have to define MEMP_NUM_TCP_PCB>=1 in your lwipopts.h"
00100 #endif
00101 #if (LWIP_TCP && (TCP_WND > 0xffff))
00102   #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"
00103 #endif
00104 #if (LWIP_TCP && (TCP_SND_QUEUELEN > 0xffff))
00105   #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"
00106 #endif
00107 #if (LWIP_TCP && ((TCP_MAXRTX > 12) || (TCP_SYNMAXRTX > 12)))
00108   #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"
00109 #endif
00110 #if (LWIP_TCP && TCP_LISTEN_BACKLOG && (TCP_DEFAULT_LISTEN_BACKLOG < 0) || (TCP_DEFAULT_LISTEN_BACKLOG > 0xff))
00111   #error "If you want to use TCP backlog, TCP_DEFAULT_LISTEN_BACKLOG must fit into an u8_t"
00112 #endif
00113 #if (LWIP_IGMP && (MEMP_NUM_IGMP_GROUP<=1))
00114   #error "If you want to use IGMP, you have to define MEMP_NUM_IGMP_GROUP>1 in your lwipopts.h"
00115 #endif
00116 #if (PPP_SUPPORT && (NO_SYS==1))
00117   #error "If you want to use PPP, you have to define NO_SYS=0 in your lwipopts.h"
00118 #endif 
00119 #if (LWIP_NETIF_API && (NO_SYS==1))
00120   #error "If you want to use NETIF API, you have to define NO_SYS=0 in your lwipopts.h"
00121 #endif
00122 #if ((LWIP_SOCKET || LWIP_NETCONN) && (NO_SYS==1))
00123   #error "If you want to use Sequential API, you have to define NO_SYS=0 in your lwipopts.h"
00124 #endif
00125 #if ((LWIP_NETCONN || LWIP_SOCKET) && (MEMP_NUM_TCPIP_MSG_API<=0))
00126   #error "If you want to use Sequential API, you have to define MEMP_NUM_TCPIP_MSG_API>=1 in your lwipopts.h"
00127 #endif
00128 #if (!LWIP_NETCONN && LWIP_SOCKET)
00129   #error "If you want to use Socket API, you have to define LWIP_NETCONN=1 in your lwipopts.h"
00130 #endif
00131 #if (((!LWIP_DHCP) || (!LWIP_AUTOIP)) && LWIP_DHCP_AUTOIP_COOP)
00132   #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"
00133 #endif
00134 #if (((!LWIP_DHCP) || (!LWIP_ARP)) && DHCP_DOES_ARP_CHECK)
00135   #error "If you want to use DHCP ARP checking, you have to define LWIP_DHCP=1 and LWIP_ARP=1 in your lwipopts.h"
00136 #endif
00137 #if (!LWIP_ARP && LWIP_AUTOIP)
00138   #error "If you want to use AUTOIP, you have to define LWIP_ARP=1 in your lwipopts.h"
00139 #endif
00140 #if (LWIP_SNMP && (SNMP_CONCURRENT_REQUESTS<=0))
00141   #error "If you want to use SNMP, you have to define SNMP_CONCURRENT_REQUESTS>=1 in your lwipopts.h"
00142 #endif
00143 #if (LWIP_SNMP && (SNMP_TRAP_DESTINATIONS<=0))
00144   #error "If you want to use SNMP, you have to define SNMP_TRAP_DESTINATIONS>=1 in your lwipopts.h"
00145 #endif
00146 #if (LWIP_TCP && ((LWIP_EVENT_API && LWIP_CALLBACK_API) || (!LWIP_EVENT_API && !LWIP_CALLBACK_API)))
00147   #error "One and exactly one of LWIP_EVENT_API and LWIP_CALLBACK_API has to be enabled in your lwipopts.h"
00148 #endif
00149 /* There must be sufficient timeouts, taking into account requirements of the subsystems. */
00150 #if ((NO_SYS==0) && (MEMP_NUM_SYS_TIMEOUT < (LWIP_TCP + IP_REASSEMBLY + LWIP_ARP + (2*LWIP_DHCP) + LWIP_AUTOIP + LWIP_IGMP + LWIP_DNS + PPP_SUPPORT)))
00151   #error "MEMP_NUM_SYS_TIMEOUT is too low to accomodate all required timeouts"
00152 #endif
00153 #if (IP_REASSEMBLY && (MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS))
00154   #error "MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS doesn't make sense since each struct ip_reassdata must hold 2 pbufs at least!"
00155 #endif
00156 #if (MEM_LIBC_MALLOC && MEM_USE_POOLS)
00157   #error "MEM_LIBC_MALLOC and MEM_USE_POOLS may not both be simultaneously enabled in your lwipopts.h"
00158 #endif
00159 #if (MEM_USE_POOLS && !MEMP_USE_CUSTOM_POOLS)
00160   #error "MEM_USE_POOLS requires custom pools (MEMP_USE_CUSTOM_POOLS) to be enabled in your lwipopts.h"
00161 #endif
00162 #if (PBUF_POOL_BUFSIZE <= MEM_ALIGNMENT)
00163   #error "PBUF_POOL_BUFSIZE must be greater than MEM_ALIGNMENT or the offset may take the full first pbuf"
00164 #endif
00165 #if (TCP_QUEUE_OOSEQ && !LWIP_TCP)
00166   #error "TCP_QUEUE_OOSEQ requires LWIP_TCP"
00167 #endif
00168 #if (DNS_LOCAL_HOSTLIST && !DNS_LOCAL_HOSTLIST_IS_DYNAMIC && !(defined(DNS_LOCAL_HOSTLIST_INIT)))
00169   #error "you have to define define DNS_LOCAL_HOSTLIST_INIT {{'host1', 0x123}, {'host2', 0x234}} to initialize DNS_LOCAL_HOSTLIST"
00170 #endif
00171 
00172 
00173 /* Compile-time checks for deprecated options.
00174  */
00175 #ifdef MEMP_NUM_TCPIP_MSG
00176   #error "MEMP_NUM_TCPIP_MSG option is deprecated. Remove it from your lwipopts.h."
00177 #endif
00178 #ifdef MEMP_NUM_API_MSG
00179   #error "MEMP_NUM_API_MSG option is deprecated. Remove it from your lwipopts.h."
00180 #endif
00181 #ifdef TCP_REXMIT_DEBUG
00182   #error "TCP_REXMIT_DEBUG option is deprecated. Remove it from your lwipopts.h."
00183 #endif
00184 #ifdef RAW_STATS
00185   #error "RAW_STATS option is deprecated. Remove it from your lwipopts.h."
00186 #endif
00187 #ifdef ETHARP_QUEUE_FIRST
00188   #error "ETHARP_QUEUE_FIRST option is deprecated. Remove it from your lwipopts.h."
00189 #endif
00190 #ifdef ETHARP_ALWAYS_INSERT
00191   #error "ETHARP_ALWAYS_INSERT option is deprecated. Remove it from your lwipopts.h."
00192 #endif
00193 #if SO_REUSE
00194 /* I removed the lot since this was an ugly hack. It broke the raw-API.
00195    It also came with many ugly goto's, Christiaan Simons. */
00196   #error "SO_REUSE currently unavailable, this was a hack"
00197 #endif
00198 
00199 #ifdef LWIP_DEBUG
00200 static void
00201 lwip_sanity_check(void)
00202 {
00203   /* Warnings */
00204 #if LWIP_NETCONN
00205   if (MEMP_NUM_NETCONN > (MEMP_NUM_TCP_PCB+MEMP_NUM_TCP_PCB_LISTEN+MEMP_NUM_UDP_PCB+MEMP_NUM_RAW_PCB))
00206     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"));
00207 #endif /* LWIP_NETCONN */
00208 #if LWIP_TCP
00209   if (MEMP_NUM_TCP_SEG < TCP_SND_QUEUELEN)
00210     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: MEMP_NUM_TCP_SEG should be at least as big as TCP_SND_QUEUELEN\n"));
00211   if (TCP_SND_BUF < 2 * TCP_MSS)
00212     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"));
00213   if (TCP_SND_QUEUELEN < (2 * (TCP_SND_BUF/TCP_MSS)))
00214     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"));
00215   if (TCP_SNDLOWAT > TCP_SND_BUF)
00216     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SNDLOWAT must be less than or equal to TCP_SND_BUF.\n"));
00217   if (TCP_WND > (PBUF_POOL_SIZE*PBUF_POOL_BUFSIZE))
00218     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_WND is larger than space provided by PBUF_POOL_SIZE*PBUF_POOL_BUFSIZE\n"));
00219   if (TCP_WND < TCP_MSS)
00220     LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_WND is smaller than MSS\n"));
00221 #endif /* LWIP_TCP */
00222 }
00223 #else  /* LWIP_DEBUG */
00224 #define lwip_sanity_check()
00225 #endif /* LWIP_DEBUG */
00226 
00227 /**
00228  * Perform Sanity check of user-configurable values, and initialize all modules.
00229  */
00230 void
00231 lwip_init(void)
00232 {
00233   /* Sanity check user-configurable values */
00234   lwip_sanity_check();
00235 
00236   /* Modules initialization */
00237   stats_init();
00238   sys_init();
00239   mem_init();
00240   memp_init();
00241   pbuf_init();
00242   netif_init();
00243 #if LWIP_SOCKET
00244   lwip_socket_init();
00245 #endif /* LWIP_SOCKET */
00246   ip_init();
00247 #if LWIP_ARP
00248   etharp_init();
00249 #endif /* LWIP_ARP */
00250 #if LWIP_RAW
00251   raw_init();
00252 #endif /* LWIP_RAW */
00253 #if LWIP_UDP
00254   udp_init();
00255 #endif /* LWIP_UDP */
00256 #if LWIP_TCP
00257   tcp_init();
00258 #endif /* LWIP_TCP */
00259 #if LWIP_SNMP
00260   snmp_init();
00261 #endif /* LWIP_SNMP */
00262 #if LWIP_AUTOIP
00263   autoip_init();
00264 #endif /* LWIP_AUTOIP */
00265 #if LWIP_IGMP
00266   igmp_init();
00267 #endif /* LWIP_IGMP */
00268 #if LWIP_DNS
00269   dns_init();
00270 #endif /* LWIP_DNS */
00271 }