Pascal Nysten / lwip

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   DebugLib

Dependents:   LoRaWAN-lmic-app LoRaWAN-lmic-app LoRaWAN-test-10secs LoRaPersonalizedDeviceForEverynet ... more

Fork of lwip_ppp_ethernet by Donatien Garnier

src/core/ipv4/autoip.c@0:8e01dca41002, 2012-05-24 (annotated)

Committer:
donatien
Date:
Thu May 24 15:53:48 2012 +0000
Revision:
0:8e01dca41002
Merge with Emilio's LwIp

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:8e01dca41002 1 /**
donatien 0:8e01dca41002 2 * @file
donatien 0:8e01dca41002 3 * AutoIP Automatic LinkLocal IP Configuration
donatien 0:8e01dca41002 4 *
donatien 0:8e01dca41002 5 */
donatien 0:8e01dca41002 6
donatien 0:8e01dca41002 7 /*
donatien 0:8e01dca41002 8 *
donatien 0:8e01dca41002 9 * Copyright (c) 2007 Dominik Spies <kontakt@dspies.de>
donatien 0:8e01dca41002 10 * All rights reserved.
donatien 0:8e01dca41002 11 *
donatien 0:8e01dca41002 12 * Redistribution and use in source and binary forms, with or without modification,
donatien 0:8e01dca41002 13 * are permitted provided that the following conditions are met:
donatien 0:8e01dca41002 14 *
donatien 0:8e01dca41002 15 * 1. Redistributions of source code must retain the above copyright notice,
donatien 0:8e01dca41002 16 * this list of conditions and the following disclaimer.
donatien 0:8e01dca41002 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
donatien 0:8e01dca41002 18 * this list of conditions and the following disclaimer in the documentation
donatien 0:8e01dca41002 19 * and/or other materials provided with the distribution.
donatien 0:8e01dca41002 20 * 3. The name of the author may not be used to endorse or promote products
donatien 0:8e01dca41002 21 * derived from this software without specific prior written permission.
donatien 0:8e01dca41002 22 *
donatien 0:8e01dca41002 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
donatien 0:8e01dca41002 24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
donatien 0:8e01dca41002 25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
donatien 0:8e01dca41002 26 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
donatien 0:8e01dca41002 27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
donatien 0:8e01dca41002 28 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
donatien 0:8e01dca41002 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
donatien 0:8e01dca41002 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
donatien 0:8e01dca41002 31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
donatien 0:8e01dca41002 32 * OF SUCH DAMAGE.
donatien 0:8e01dca41002 33 *
donatien 0:8e01dca41002 34 * Author: Dominik Spies <kontakt@dspies.de>
donatien 0:8e01dca41002 35 *
donatien 0:8e01dca41002 36 * This is a AutoIP implementation for the lwIP TCP/IP stack. It aims to conform
donatien 0:8e01dca41002 37 * with RFC 3927.
donatien 0:8e01dca41002 38 *
donatien 0:8e01dca41002 39 *
donatien 0:8e01dca41002 40 * Please coordinate changes and requests with Dominik Spies
donatien 0:8e01dca41002 41 * <kontakt@dspies.de>
donatien 0:8e01dca41002 42 */
donatien 0:8e01dca41002 43
donatien 0:8e01dca41002 44 /*******************************************************************************
donatien 0:8e01dca41002 45 * USAGE:
donatien 0:8e01dca41002 46 *
donatien 0:8e01dca41002 47 * define LWIP_AUTOIP 1 in your lwipopts.h
donatien 0:8e01dca41002 48 *
donatien 0:8e01dca41002 49 * If you don't use tcpip.c (so, don't call, you don't call tcpip_init):
donatien 0:8e01dca41002 50 * - First, call autoip_init().
donatien 0:8e01dca41002 51 * - call autoip_tmr() all AUTOIP_TMR_INTERVAL msces,
donatien 0:8e01dca41002 52 * that should be defined in autoip.h.
donatien 0:8e01dca41002 53 * I recommend a value of 100. The value must divide 1000 with a remainder almost 0.
donatien 0:8e01dca41002 54 * Possible values are 1000, 500, 333, 250, 200, 166, 142, 125, 111, 100 ....
donatien 0:8e01dca41002 55 *
donatien 0:8e01dca41002 56 * Without DHCP:
donatien 0:8e01dca41002 57 * - Call autoip_start() after netif_add().
donatien 0:8e01dca41002 58 *
donatien 0:8e01dca41002 59 * With DHCP:
donatien 0:8e01dca41002 60 * - define LWIP_DHCP_AUTOIP_COOP 1 in your lwipopts.h.
donatien 0:8e01dca41002 61 * - Configure your DHCP Client.
donatien 0:8e01dca41002 62 *
donatien 0:8e01dca41002 63 */
donatien 0:8e01dca41002 64
donatien 0:8e01dca41002 65 #include "lwip/opt.h"
donatien 0:8e01dca41002 66
donatien 0:8e01dca41002 67 #if LWIP_AUTOIP /* don't build if not configured for use in lwipopts.h */
donatien 0:8e01dca41002 68
donatien 0:8e01dca41002 69 #include "lwip/mem.h"
donatien 0:8e01dca41002 70 #include "lwip/udp.h"
donatien 0:8e01dca41002 71 #include "lwip/ip_addr.h"
donatien 0:8e01dca41002 72 #include "lwip/netif.h"
donatien 0:8e01dca41002 73 #include "lwip/autoip.h"
donatien 0:8e01dca41002 74 #include "netif/etharp.h"
donatien 0:8e01dca41002 75
donatien 0:8e01dca41002 76 #include <stdlib.h>
donatien 0:8e01dca41002 77 #include <string.h>
donatien 0:8e01dca41002 78
donatien 0:8e01dca41002 79 /* 169.254.0.0 */
donatien 0:8e01dca41002 80 #define AUTOIP_NET 0xA9FE0000
donatien 0:8e01dca41002 81 /* 169.254.1.0 */
donatien 0:8e01dca41002 82 #define AUTOIP_RANGE_START (AUTOIP_NET | 0x0100)
donatien 0:8e01dca41002 83 /* 169.254.254.255 */
donatien 0:8e01dca41002 84 #define AUTOIP_RANGE_END (AUTOIP_NET | 0xFEFF)
donatien 0:8e01dca41002 85
donatien 0:8e01dca41002 86
donatien 0:8e01dca41002 87 /** Pseudo random macro based on netif informations.
donatien 0:8e01dca41002 88 * You could use "rand()" from the C Library if you define LWIP_AUTOIP_RAND in lwipopts.h */
donatien 0:8e01dca41002 89 #ifndef LWIP_AUTOIP_RAND
donatien 0:8e01dca41002 90 #define LWIP_AUTOIP_RAND(netif) ( (((u32_t)((netif->hwaddr[5]) & 0xff) << 24) | \
donatien 0:8e01dca41002 91 ((u32_t)((netif->hwaddr[3]) & 0xff) << 16) | \
donatien 0:8e01dca41002 92 ((u32_t)((netif->hwaddr[2]) & 0xff) << 8) | \
donatien 0:8e01dca41002 93 ((u32_t)((netif->hwaddr[4]) & 0xff))) + \
donatien 0:8e01dca41002 94 (netif->autoip?netif->autoip->tried_llipaddr:0))
donatien 0:8e01dca41002 95 #endif /* LWIP_AUTOIP_RAND */
donatien 0:8e01dca41002 96
donatien 0:8e01dca41002 97 /**
donatien 0:8e01dca41002 98 * Macro that generates the initial IP address to be tried by AUTOIP.
donatien 0:8e01dca41002 99 * If you want to override this, define it to something else in lwipopts.h.
donatien 0:8e01dca41002 100 */
donatien 0:8e01dca41002 101 #ifndef LWIP_AUTOIP_CREATE_SEED_ADDR
donatien 0:8e01dca41002 102 #define LWIP_AUTOIP_CREATE_SEED_ADDR(netif) \
donatien 0:8e01dca41002 103 htonl(AUTOIP_RANGE_START + ((u32_t)(((u8_t)(netif->hwaddr[4])) | \
donatien 0:8e01dca41002 104 ((u32_t)((u8_t)(netif->hwaddr[5]))) << 8)))
donatien 0:8e01dca41002 105 #endif /* LWIP_AUTOIP_CREATE_SEED_ADDR */
donatien 0:8e01dca41002 106
donatien 0:8e01dca41002 107 /* static functions */
donatien 0:8e01dca41002 108 static void autoip_handle_arp_conflict(struct netif *netif);
donatien 0:8e01dca41002 109
donatien 0:8e01dca41002 110 /* creates a pseudo random LL IP-Address for a network interface */
donatien 0:8e01dca41002 111 static void autoip_create_addr(struct netif *netif, ip_addr_t *ipaddr);
donatien 0:8e01dca41002 112
donatien 0:8e01dca41002 113 /* sends an ARP probe */
donatien 0:8e01dca41002 114 static err_t autoip_arp_probe(struct netif *netif);
donatien 0:8e01dca41002 115
donatien 0:8e01dca41002 116 /* sends an ARP announce */
donatien 0:8e01dca41002 117 static err_t autoip_arp_announce(struct netif *netif);
donatien 0:8e01dca41002 118
donatien 0:8e01dca41002 119 /* configure interface for use with current LL IP-Address */
donatien 0:8e01dca41002 120 static err_t autoip_bind(struct netif *netif);
donatien 0:8e01dca41002 121
donatien 0:8e01dca41002 122 /* start sending probes for llipaddr */
donatien 0:8e01dca41002 123 static void autoip_start_probing(struct netif *netif);
donatien 0:8e01dca41002 124
donatien 0:8e01dca41002 125 /**
donatien 0:8e01dca41002 126 * Initialize this module
donatien 0:8e01dca41002 127 */
donatien 0:8e01dca41002 128 void
donatien 0:8e01dca41002 129 autoip_init(void)
donatien 0:8e01dca41002 130 {
donatien 0:8e01dca41002 131 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE, ("autoip_init()\n"));
donatien 0:8e01dca41002 132 }
donatien 0:8e01dca41002 133
donatien 0:8e01dca41002 134 /** Set a statically allocated struct autoip to work with.
donatien 0:8e01dca41002 135 * Using this prevents autoip_start to allocate it using mem_malloc.
donatien 0:8e01dca41002 136 *
donatien 0:8e01dca41002 137 * @param netif the netif for which to set the struct autoip
donatien 0:8e01dca41002 138 * @param dhcp (uninitialised) dhcp struct allocated by the application
donatien 0:8e01dca41002 139 */
donatien 0:8e01dca41002 140 void
donatien 0:8e01dca41002 141 autoip_set_struct(struct netif *netif, struct autoip *autoip)
donatien 0:8e01dca41002 142 {
donatien 0:8e01dca41002 143 LWIP_ASSERT("netif != NULL", netif != NULL);
donatien 0:8e01dca41002 144 LWIP_ASSERT("autoip != NULL", autoip != NULL);
donatien 0:8e01dca41002 145 LWIP_ASSERT("netif already has a struct autoip set", netif->autoip == NULL);
donatien 0:8e01dca41002 146
donatien 0:8e01dca41002 147 /* clear data structure */
donatien 0:8e01dca41002 148 memset(autoip, 0, sizeof(struct autoip));
donatien 0:8e01dca41002 149 /* autoip->state = AUTOIP_STATE_OFF; */
donatien 0:8e01dca41002 150 netif->autoip = autoip;
donatien 0:8e01dca41002 151 }
donatien 0:8e01dca41002 152
donatien 0:8e01dca41002 153 /** Restart AutoIP client and check the next address (conflict detected)
donatien 0:8e01dca41002 154 *
donatien 0:8e01dca41002 155 * @param netif The netif under AutoIP control
donatien 0:8e01dca41002 156 */
donatien 0:8e01dca41002 157 static void
donatien 0:8e01dca41002 158 autoip_restart(struct netif *netif)
donatien 0:8e01dca41002 159 {
donatien 0:8e01dca41002 160 netif->autoip->tried_llipaddr++;
donatien 0:8e01dca41002 161 autoip_start(netif);
donatien 0:8e01dca41002 162 }
donatien 0:8e01dca41002 163
donatien 0:8e01dca41002 164 /**
donatien 0:8e01dca41002 165 * Handle a IP address conflict after an ARP conflict detection
donatien 0:8e01dca41002 166 */
donatien 0:8e01dca41002 167 static void
donatien 0:8e01dca41002 168 autoip_handle_arp_conflict(struct netif *netif)
donatien 0:8e01dca41002 169 {
donatien 0:8e01dca41002 170 /* Somehow detect if we are defending or retreating */
donatien 0:8e01dca41002 171 unsigned char defend = 1; /* tbd */
donatien 0:8e01dca41002 172
donatien 0:8e01dca41002 173 if(defend) {
donatien 0:8e01dca41002 174 if(netif->autoip->lastconflict > 0) {
donatien 0:8e01dca41002 175 /* retreat, there was a conflicting ARP in the last
donatien 0:8e01dca41002 176 * DEFEND_INTERVAL seconds
donatien 0:8e01dca41002 177 */
donatien 0:8e01dca41002 178 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 179 ("autoip_handle_arp_conflict(): we are defending, but in DEFEND_INTERVAL, retreating\n"));
donatien 0:8e01dca41002 180
donatien 0:8e01dca41002 181 /* TODO: close all TCP sessions */
donatien 0:8e01dca41002 182 autoip_restart(netif);
donatien 0:8e01dca41002 183 } else {
donatien 0:8e01dca41002 184 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 185 ("autoip_handle_arp_conflict(): we are defend, send ARP Announce\n"));
donatien 0:8e01dca41002 186 autoip_arp_announce(netif);
donatien 0:8e01dca41002 187 netif->autoip->lastconflict = DEFEND_INTERVAL * AUTOIP_TICKS_PER_SECOND;
donatien 0:8e01dca41002 188 }
donatien 0:8e01dca41002 189 } else {
donatien 0:8e01dca41002 190 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 191 ("autoip_handle_arp_conflict(): we do not defend, retreating\n"));
donatien 0:8e01dca41002 192 /* TODO: close all TCP sessions */
donatien 0:8e01dca41002 193 autoip_restart(netif);
donatien 0:8e01dca41002 194 }
donatien 0:8e01dca41002 195 }
donatien 0:8e01dca41002 196
donatien 0:8e01dca41002 197 /**
donatien 0:8e01dca41002 198 * Create an IP-Address out of range 169.254.1.0 to 169.254.254.255
donatien 0:8e01dca41002 199 *
donatien 0:8e01dca41002 200 * @param netif network interface on which create the IP-Address
donatien 0:8e01dca41002 201 * @param ipaddr ip address to initialize
donatien 0:8e01dca41002 202 */
donatien 0:8e01dca41002 203 static void
donatien 0:8e01dca41002 204 autoip_create_addr(struct netif *netif, ip_addr_t *ipaddr)
donatien 0:8e01dca41002 205 {
donatien 0:8e01dca41002 206 /* Here we create an IP-Address out of range 169.254.1.0 to 169.254.254.255
donatien 0:8e01dca41002 207 * compliant to RFC 3927 Section 2.1
donatien 0:8e01dca41002 208 * We have 254 * 256 possibilities */
donatien 0:8e01dca41002 209
donatien 0:8e01dca41002 210 u32_t addr = ntohl(LWIP_AUTOIP_CREATE_SEED_ADDR(netif));
donatien 0:8e01dca41002 211 addr += netif->autoip->tried_llipaddr;
donatien 0:8e01dca41002 212 addr = AUTOIP_NET | (addr & 0xffff);
donatien 0:8e01dca41002 213 /* Now, 169.254.0.0 <= addr <= 169.254.255.255 */
donatien 0:8e01dca41002 214
donatien 0:8e01dca41002 215 if (addr < AUTOIP_RANGE_START) {
donatien 0:8e01dca41002 216 addr += AUTOIP_RANGE_END - AUTOIP_RANGE_START + 1;
donatien 0:8e01dca41002 217 }
donatien 0:8e01dca41002 218 if (addr > AUTOIP_RANGE_END) {
donatien 0:8e01dca41002 219 addr -= AUTOIP_RANGE_END - AUTOIP_RANGE_START + 1;
donatien 0:8e01dca41002 220 }
donatien 0:8e01dca41002 221 LWIP_ASSERT("AUTOIP address not in range", (addr >= AUTOIP_RANGE_START) &&
donatien 0:8e01dca41002 222 (addr <= AUTOIP_RANGE_END));
donatien 0:8e01dca41002 223 ip4_addr_set_u32(ipaddr, htonl(addr));
donatien 0:8e01dca41002 224
donatien 0:8e01dca41002 225 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 226 ("autoip_create_addr(): tried_llipaddr=%"U16_F", %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:8e01dca41002 227 (u16_t)(netif->autoip->tried_llipaddr), ip4_addr1_16(ipaddr), ip4_addr2_16(ipaddr),
donatien 0:8e01dca41002 228 ip4_addr3_16(ipaddr), ip4_addr4_16(ipaddr)));
donatien 0:8e01dca41002 229 }
donatien 0:8e01dca41002 230
donatien 0:8e01dca41002 231 /**
donatien 0:8e01dca41002 232 * Sends an ARP probe from a network interface
donatien 0:8e01dca41002 233 *
donatien 0:8e01dca41002 234 * @param netif network interface used to send the probe
donatien 0:8e01dca41002 235 */
donatien 0:8e01dca41002 236 static err_t
donatien 0:8e01dca41002 237 autoip_arp_probe(struct netif *netif)
donatien 0:8e01dca41002 238 {
donatien 0:8e01dca41002 239 return etharp_raw(netif, (struct eth_addr *)netif->hwaddr, &ethbroadcast,
donatien 0:8e01dca41002 240 (struct eth_addr *)netif->hwaddr, IP_ADDR_ANY, &ethzero,
donatien 0:8e01dca41002 241 &netif->autoip->llipaddr, ARP_REQUEST);
donatien 0:8e01dca41002 242 }
donatien 0:8e01dca41002 243
donatien 0:8e01dca41002 244 /**
donatien 0:8e01dca41002 245 * Sends an ARP announce from a network interface
donatien 0:8e01dca41002 246 *
donatien 0:8e01dca41002 247 * @param netif network interface used to send the announce
donatien 0:8e01dca41002 248 */
donatien 0:8e01dca41002 249 static err_t
donatien 0:8e01dca41002 250 autoip_arp_announce(struct netif *netif)
donatien 0:8e01dca41002 251 {
donatien 0:8e01dca41002 252 return etharp_raw(netif, (struct eth_addr *)netif->hwaddr, &ethbroadcast,
donatien 0:8e01dca41002 253 (struct eth_addr *)netif->hwaddr, &netif->autoip->llipaddr, &ethzero,
donatien 0:8e01dca41002 254 &netif->autoip->llipaddr, ARP_REQUEST);
donatien 0:8e01dca41002 255 }
donatien 0:8e01dca41002 256
donatien 0:8e01dca41002 257 /**
donatien 0:8e01dca41002 258 * Configure interface for use with current LL IP-Address
donatien 0:8e01dca41002 259 *
donatien 0:8e01dca41002 260 * @param netif network interface to configure with current LL IP-Address
donatien 0:8e01dca41002 261 */
donatien 0:8e01dca41002 262 static err_t
donatien 0:8e01dca41002 263 autoip_bind(struct netif *netif)
donatien 0:8e01dca41002 264 {
donatien 0:8e01dca41002 265 struct autoip *autoip = netif->autoip;
donatien 0:8e01dca41002 266 ip_addr_t sn_mask, gw_addr;
donatien 0:8e01dca41002 267
donatien 0:8e01dca41002 268 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:8e01dca41002 269 ("autoip_bind(netif=%p) %c%c%"U16_F" %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:8e01dca41002 270 (void*)netif, netif->name[0], netif->name[1], (u16_t)netif->num,
donatien 0:8e01dca41002 271 ip4_addr1_16(&autoip->llipaddr), ip4_addr2_16(&autoip->llipaddr),
donatien 0:8e01dca41002 272 ip4_addr3_16(&autoip->llipaddr), ip4_addr4_16(&autoip->llipaddr)));
donatien 0:8e01dca41002 273
donatien 0:8e01dca41002 274 IP4_ADDR(&sn_mask, 255, 255, 0, 0);
donatien 0:8e01dca41002 275 IP4_ADDR(&gw_addr, 0, 0, 0, 0);
donatien 0:8e01dca41002 276
donatien 0:8e01dca41002 277 netif_set_ipaddr(netif, &autoip->llipaddr);
donatien 0:8e01dca41002 278 netif_set_netmask(netif, &sn_mask);
donatien 0:8e01dca41002 279 netif_set_gw(netif, &gw_addr);
donatien 0:8e01dca41002 280
donatien 0:8e01dca41002 281 /* bring the interface up */
donatien 0:8e01dca41002 282 netif_set_up(netif);
donatien 0:8e01dca41002 283
donatien 0:8e01dca41002 284 return ERR_OK;
donatien 0:8e01dca41002 285 }
donatien 0:8e01dca41002 286
donatien 0:8e01dca41002 287 /**
donatien 0:8e01dca41002 288 * Start AutoIP client
donatien 0:8e01dca41002 289 *
donatien 0:8e01dca41002 290 * @param netif network interface on which start the AutoIP client
donatien 0:8e01dca41002 291 */
donatien 0:8e01dca41002 292 err_t
donatien 0:8e01dca41002 293 autoip_start(struct netif *netif)
donatien 0:8e01dca41002 294 {
donatien 0:8e01dca41002 295 struct autoip *autoip = netif->autoip;
donatien 0:8e01dca41002 296 err_t result = ERR_OK;
donatien 0:8e01dca41002 297
donatien 0:8e01dca41002 298 if(netif_is_up(netif)) {
donatien 0:8e01dca41002 299 netif_set_down(netif);
donatien 0:8e01dca41002 300 }
donatien 0:8e01dca41002 301
donatien 0:8e01dca41002 302 /* Set IP-Address, Netmask and Gateway to 0 to make sure that
donatien 0:8e01dca41002 303 * ARP Packets are formed correctly
donatien 0:8e01dca41002 304 */
donatien 0:8e01dca41002 305 ip_addr_set_zero(&netif->ip_addr);
donatien 0:8e01dca41002 306 ip_addr_set_zero(&netif->netmask);
donatien 0:8e01dca41002 307 ip_addr_set_zero(&netif->gw);
donatien 0:8e01dca41002 308
donatien 0:8e01dca41002 309 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 310 ("autoip_start(netif=%p) %c%c%"U16_F"\n", (void*)netif, netif->name[0],
donatien 0:8e01dca41002 311 netif->name[1], (u16_t)netif->num));
donatien 0:8e01dca41002 312 if(autoip == NULL) {
donatien 0:8e01dca41002 313 /* no AutoIP client attached yet? */
donatien 0:8e01dca41002 314 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:8e01dca41002 315 ("autoip_start(): starting new AUTOIP client\n"));
donatien 0:8e01dca41002 316 autoip = (struct autoip *)mem_malloc(sizeof(struct autoip));
donatien 0:8e01dca41002 317 if(autoip == NULL) {
donatien 0:8e01dca41002 318 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:8e01dca41002 319 ("autoip_start(): could not allocate autoip\n"));
donatien 0:8e01dca41002 320 return ERR_MEM;
donatien 0:8e01dca41002 321 }
donatien 0:8e01dca41002 322 memset(autoip, 0, sizeof(struct autoip));
donatien 0:8e01dca41002 323 /* store this AutoIP client in the netif */
donatien 0:8e01dca41002 324 netif->autoip = autoip;
donatien 0:8e01dca41002 325 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE, ("autoip_start(): allocated autoip"));
donatien 0:8e01dca41002 326 } else {
donatien 0:8e01dca41002 327 autoip->state = AUTOIP_STATE_OFF;
donatien 0:8e01dca41002 328 autoip->ttw = 0;
donatien 0:8e01dca41002 329 autoip->sent_num = 0;
donatien 0:8e01dca41002 330 ip_addr_set_zero(&autoip->llipaddr);
donatien 0:8e01dca41002 331 autoip->lastconflict = 0;
donatien 0:8e01dca41002 332 }
donatien 0:8e01dca41002 333
donatien 0:8e01dca41002 334 autoip_create_addr(netif, &(autoip->llipaddr));
donatien 0:8e01dca41002 335 autoip_start_probing(netif);
donatien 0:8e01dca41002 336
donatien 0:8e01dca41002 337 return result;
donatien 0:8e01dca41002 338 }
donatien 0:8e01dca41002 339
donatien 0:8e01dca41002 340 static void
donatien 0:8e01dca41002 341 autoip_start_probing(struct netif *netif)
donatien 0:8e01dca41002 342 {
donatien 0:8e01dca41002 343 struct autoip *autoip = netif->autoip;
donatien 0:8e01dca41002 344
donatien 0:8e01dca41002 345 autoip->state = AUTOIP_STATE_PROBING;
donatien 0:8e01dca41002 346 autoip->sent_num = 0;
donatien 0:8e01dca41002 347 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 348 ("autoip_start_probing(): changing state to PROBING: %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:8e01dca41002 349 ip4_addr1_16(&netif->autoip->llipaddr), ip4_addr2_16(&netif->autoip->llipaddr),
donatien 0:8e01dca41002 350 ip4_addr3_16(&netif->autoip->llipaddr), ip4_addr4_16(&netif->autoip->llipaddr)));
donatien 0:8e01dca41002 351
donatien 0:8e01dca41002 352 /* time to wait to first probe, this is randomly
donatien 0:8e01dca41002 353 * choosen out of 0 to PROBE_WAIT seconds.
donatien 0:8e01dca41002 354 * compliant to RFC 3927 Section 2.2.1
donatien 0:8e01dca41002 355 */
donatien 0:8e01dca41002 356 autoip->ttw = (u16_t)(LWIP_AUTOIP_RAND(netif) % (PROBE_WAIT * AUTOIP_TICKS_PER_SECOND));
donatien 0:8e01dca41002 357
donatien 0:8e01dca41002 358 /*
donatien 0:8e01dca41002 359 * if we tried more then MAX_CONFLICTS we must limit our rate for
donatien 0:8e01dca41002 360 * accquiring and probing address
donatien 0:8e01dca41002 361 * compliant to RFC 3927 Section 2.2.1
donatien 0:8e01dca41002 362 */
donatien 0:8e01dca41002 363 if(autoip->tried_llipaddr > MAX_CONFLICTS) {
donatien 0:8e01dca41002 364 autoip->ttw = RATE_LIMIT_INTERVAL * AUTOIP_TICKS_PER_SECOND;
donatien 0:8e01dca41002 365 }
donatien 0:8e01dca41002 366 }
donatien 0:8e01dca41002 367
donatien 0:8e01dca41002 368 /**
donatien 0:8e01dca41002 369 * Handle a possible change in the network configuration.
donatien 0:8e01dca41002 370 *
donatien 0:8e01dca41002 371 * If there is an AutoIP address configured, take the interface down
donatien 0:8e01dca41002 372 * and begin probing with the same address.
donatien 0:8e01dca41002 373 */
donatien 0:8e01dca41002 374 void
donatien 0:8e01dca41002 375 autoip_network_changed(struct netif *netif)
donatien 0:8e01dca41002 376 {
donatien 0:8e01dca41002 377 if (netif->autoip && netif->autoip->state != AUTOIP_STATE_OFF) {
donatien 0:8e01dca41002 378 netif_set_down(netif);
donatien 0:8e01dca41002 379 autoip_start_probing(netif);
donatien 0:8e01dca41002 380 }
donatien 0:8e01dca41002 381 }
donatien 0:8e01dca41002 382
donatien 0:8e01dca41002 383 /**
donatien 0:8e01dca41002 384 * Stop AutoIP client
donatien 0:8e01dca41002 385 *
donatien 0:8e01dca41002 386 * @param netif network interface on which stop the AutoIP client
donatien 0:8e01dca41002 387 */
donatien 0:8e01dca41002 388 err_t
donatien 0:8e01dca41002 389 autoip_stop(struct netif *netif)
donatien 0:8e01dca41002 390 {
donatien 0:8e01dca41002 391 netif->autoip->state = AUTOIP_STATE_OFF;
donatien 0:8e01dca41002 392 netif_set_down(netif);
donatien 0:8e01dca41002 393 return ERR_OK;
donatien 0:8e01dca41002 394 }
donatien 0:8e01dca41002 395
donatien 0:8e01dca41002 396 /**
donatien 0:8e01dca41002 397 * Has to be called in loop every AUTOIP_TMR_INTERVAL milliseconds
donatien 0:8e01dca41002 398 */
donatien 0:8e01dca41002 399 void
donatien 0:8e01dca41002 400 autoip_tmr()
donatien 0:8e01dca41002 401 {
donatien 0:8e01dca41002 402 struct netif *netif = netif_list;
donatien 0:8e01dca41002 403 /* loop through netif's */
donatien 0:8e01dca41002 404 while (netif != NULL) {
donatien 0:8e01dca41002 405 /* only act on AutoIP configured interfaces */
donatien 0:8e01dca41002 406 if (netif->autoip != NULL) {
donatien 0:8e01dca41002 407 if(netif->autoip->lastconflict > 0) {
donatien 0:8e01dca41002 408 netif->autoip->lastconflict--;
donatien 0:8e01dca41002 409 }
donatien 0:8e01dca41002 410
donatien 0:8e01dca41002 411 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:8e01dca41002 412 ("autoip_tmr() AutoIP-State: %"U16_F", ttw=%"U16_F"\n",
donatien 0:8e01dca41002 413 (u16_t)(netif->autoip->state), netif->autoip->ttw));
donatien 0:8e01dca41002 414
donatien 0:8e01dca41002 415 switch(netif->autoip->state) {
donatien 0:8e01dca41002 416 case AUTOIP_STATE_PROBING:
donatien 0:8e01dca41002 417 if(netif->autoip->ttw > 0) {
donatien 0:8e01dca41002 418 netif->autoip->ttw--;
donatien 0:8e01dca41002 419 } else {
donatien 0:8e01dca41002 420 if(netif->autoip->sent_num >= PROBE_NUM) {
donatien 0:8e01dca41002 421 netif->autoip->state = AUTOIP_STATE_ANNOUNCING;
donatien 0:8e01dca41002 422 netif->autoip->sent_num = 0;
donatien 0:8e01dca41002 423 netif->autoip->ttw = ANNOUNCE_WAIT * AUTOIP_TICKS_PER_SECOND;
donatien 0:8e01dca41002 424 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 425 ("autoip_tmr(): changing state to ANNOUNCING: %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:8e01dca41002 426 ip4_addr1_16(&netif->autoip->llipaddr), ip4_addr2_16(&netif->autoip->llipaddr),
donatien 0:8e01dca41002 427 ip4_addr3_16(&netif->autoip->llipaddr), ip4_addr4_16(&netif->autoip->llipaddr)));
donatien 0:8e01dca41002 428 } else {
donatien 0:8e01dca41002 429 autoip_arp_probe(netif);
donatien 0:8e01dca41002 430 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:8e01dca41002 431 ("autoip_tmr() PROBING Sent Probe\n"));
donatien 0:8e01dca41002 432 netif->autoip->sent_num++;
donatien 0:8e01dca41002 433 /* calculate time to wait to next probe */
donatien 0:8e01dca41002 434 netif->autoip->ttw = (u16_t)((LWIP_AUTOIP_RAND(netif) %
donatien 0:8e01dca41002 435 ((PROBE_MAX - PROBE_MIN) * AUTOIP_TICKS_PER_SECOND) ) +
donatien 0:8e01dca41002 436 PROBE_MIN * AUTOIP_TICKS_PER_SECOND);
donatien 0:8e01dca41002 437 }
donatien 0:8e01dca41002 438 }
donatien 0:8e01dca41002 439 break;
donatien 0:8e01dca41002 440
donatien 0:8e01dca41002 441 case AUTOIP_STATE_ANNOUNCING:
donatien 0:8e01dca41002 442 if(netif->autoip->ttw > 0) {
donatien 0:8e01dca41002 443 netif->autoip->ttw--;
donatien 0:8e01dca41002 444 } else {
donatien 0:8e01dca41002 445 if(netif->autoip->sent_num == 0) {
donatien 0:8e01dca41002 446 /* We are here the first time, so we waited ANNOUNCE_WAIT seconds
donatien 0:8e01dca41002 447 * Now we can bind to an IP address and use it.
donatien 0:8e01dca41002 448 *
donatien 0:8e01dca41002 449 * autoip_bind calls netif_set_up. This triggers a gratuitous ARP
donatien 0:8e01dca41002 450 * which counts as an announcement.
donatien 0:8e01dca41002 451 */
donatien 0:8e01dca41002 452 autoip_bind(netif);
donatien 0:8e01dca41002 453 } else {
donatien 0:8e01dca41002 454 autoip_arp_announce(netif);
donatien 0:8e01dca41002 455 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:8e01dca41002 456 ("autoip_tmr() ANNOUNCING Sent Announce\n"));
donatien 0:8e01dca41002 457 }
donatien 0:8e01dca41002 458 netif->autoip->ttw = ANNOUNCE_INTERVAL * AUTOIP_TICKS_PER_SECOND;
donatien 0:8e01dca41002 459 netif->autoip->sent_num++;
donatien 0:8e01dca41002 460
donatien 0:8e01dca41002 461 if(netif->autoip->sent_num >= ANNOUNCE_NUM) {
donatien 0:8e01dca41002 462 netif->autoip->state = AUTOIP_STATE_BOUND;
donatien 0:8e01dca41002 463 netif->autoip->sent_num = 0;
donatien 0:8e01dca41002 464 netif->autoip->ttw = 0;
donatien 0:8e01dca41002 465 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:8e01dca41002 466 ("autoip_tmr(): changing state to BOUND: %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:8e01dca41002 467 ip4_addr1_16(&netif->autoip->llipaddr), ip4_addr2_16(&netif->autoip->llipaddr),
donatien 0:8e01dca41002 468 ip4_addr3_16(&netif->autoip->llipaddr), ip4_addr4_16(&netif->autoip->llipaddr)));
donatien 0:8e01dca41002 469 }
donatien 0:8e01dca41002 470 }
donatien 0:8e01dca41002 471 break;
donatien 0:8e01dca41002 472 }
donatien 0:8e01dca41002 473 }
donatien 0:8e01dca41002 474 /* proceed to next network interface */
donatien 0:8e01dca41002 475 netif = netif->next;
donatien 0:8e01dca41002 476 }
donatien 0:8e01dca41002 477 }
donatien 0:8e01dca41002 478
donatien 0:8e01dca41002 479 /**
donatien 0:8e01dca41002 480 * Handles every incoming ARP Packet, called by etharp_arp_input.
donatien 0:8e01dca41002 481 *
donatien 0:8e01dca41002 482 * @param netif network interface to use for autoip processing
donatien 0:8e01dca41002 483 * @param hdr Incoming ARP packet
donatien 0:8e01dca41002 484 */
donatien 0:8e01dca41002 485 void
donatien 0:8e01dca41002 486 autoip_arp_reply(struct netif *netif, struct etharp_hdr *hdr)
donatien 0:8e01dca41002 487 {
donatien 0:8e01dca41002 488 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE, ("autoip_arp_reply()\n"));
donatien 0:8e01dca41002 489 if ((netif->autoip != NULL) && (netif->autoip->state != AUTOIP_STATE_OFF)) {
donatien 0:8e01dca41002 490 /* when ip.src == llipaddr && hw.src != netif->hwaddr
donatien 0:8e01dca41002 491 *
donatien 0:8e01dca41002 492 * when probing ip.dst == llipaddr && hw.src != netif->hwaddr
donatien 0:8e01dca41002 493 * we have a conflict and must solve it
donatien 0:8e01dca41002 494 */
donatien 0:8e01dca41002 495 ip_addr_t sipaddr, dipaddr;
donatien 0:8e01dca41002 496 struct eth_addr netifaddr;
donatien 0:8e01dca41002 497 ETHADDR16_COPY(netifaddr.addr, netif->hwaddr);
donatien 0:8e01dca41002 498
donatien 0:8e01dca41002 499 /* Copy struct ip_addr2 to aligned ip_addr, to support compilers without
donatien 0:8e01dca41002 500 * structure packing (not using structure copy which breaks strict-aliasing rules).
donatien 0:8e01dca41002 501 */
donatien 0:8e01dca41002 502 IPADDR2_COPY(&sipaddr, &hdr->sipaddr);
donatien 0:8e01dca41002 503 IPADDR2_COPY(&dipaddr, &hdr->dipaddr);
donatien 0:8e01dca41002 504
donatien 0:8e01dca41002 505 if ((netif->autoip->state == AUTOIP_STATE_PROBING) ||
donatien 0:8e01dca41002 506 ((netif->autoip->state == AUTOIP_STATE_ANNOUNCING) &&
donatien 0:8e01dca41002 507 (netif->autoip->sent_num == 0))) {
donatien 0:8e01dca41002 508 /* RFC 3927 Section 2.2.1:
donatien 0:8e01dca41002 509 * from beginning to after ANNOUNCE_WAIT
donatien 0:8e01dca41002 510 * seconds we have a conflict if
donatien 0:8e01dca41002 511 * ip.src == llipaddr OR
donatien 0:8e01dca41002 512 * ip.dst == llipaddr && hw.src != own hwaddr
donatien 0:8e01dca41002 513 */
donatien 0:8e01dca41002 514 if ((ip_addr_cmp(&sipaddr, &netif->autoip->llipaddr)) ||
donatien 0:8e01dca41002 515 (ip_addr_cmp(&dipaddr, &netif->autoip->llipaddr) &&
donatien 0:8e01dca41002 516 !eth_addr_cmp(&netifaddr, &hdr->shwaddr))) {
donatien 0:8e01dca41002 517 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE | LWIP_DBG_LEVEL_WARNING,
donatien 0:8e01dca41002 518 ("autoip_arp_reply(): Probe Conflict detected\n"));
donatien 0:8e01dca41002 519 autoip_restart(netif);
donatien 0:8e01dca41002 520 }
donatien 0:8e01dca41002 521 } else {
donatien 0:8e01dca41002 522 /* RFC 3927 Section 2.5:
donatien 0:8e01dca41002 523 * in any state we have a conflict if
donatien 0:8e01dca41002 524 * ip.src == llipaddr && hw.src != own hwaddr
donatien 0:8e01dca41002 525 */
donatien 0:8e01dca41002 526 if (ip_addr_cmp(&sipaddr, &netif->autoip->llipaddr) &&
donatien 0:8e01dca41002 527 !eth_addr_cmp(&netifaddr, &hdr->shwaddr)) {
donatien 0:8e01dca41002 528 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE | LWIP_DBG_LEVEL_WARNING,
donatien 0:8e01dca41002 529 ("autoip_arp_reply(): Conflicting ARP-Packet detected\n"));
donatien 0:8e01dca41002 530 autoip_handle_arp_conflict(netif);
donatien 0:8e01dca41002 531 }
donatien 0:8e01dca41002 532 }
donatien 0:8e01dca41002 533 }
donatien 0:8e01dca41002 534 }
donatien 0:8e01dca41002 535
donatien 0:8e01dca41002 536 #endif /* LWIP_AUTOIP */