1 /* vi: set sw=4 ts=4: */
3 * RFC3927 ZeroConf IPv4 Link-Local addressing
4 * (see <http://www.zeroconf.org/>)
6 * Copyright (C) 2003 by Arthur van Hoff (avh@strangeberry.com)
7 * Copyright (C) 2004 by David Brownell
9 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
13 * ZCIP just manages the 169.254.*.* addresses. That network is not
14 * routed at the IP level, though various proxies or bridges can
15 * certainly be used. Its naming is built over multicast DNS.
21 // - more real-world usage/testing, especially daemon mode
22 // - kernel packet filters to reduce scheduling noise
23 // - avoid silent script failures, especially under load...
24 // - link status monitoring (restart on link-up; stop on link-down)
29 #include <netinet/ether.h>
30 #include <net/ethernet.h>
32 #include <net/if_arp.h>
33 #include <linux/if_packet.h>
34 #include <linux/sockios.h>
38 /* We don't need more than 32 bits of the counter */
39 #define MONOTONIC_US() ((unsigned)monotonic_us())
42 struct ether_header hdr;
48 LINKLOCAL_ADDR = 0xa9fe0000,
50 /* protocol timeout parameters, specified in seconds */
56 RATE_LIMIT_INTERVAL = 60,
59 ANNOUNCE_INTERVAL = 2,
63 /* States during the configuration process. */
72 #define VDBG(fmt,args...) \
76 * Pick a random link local IP address on 169.254/16, except that
77 * the first and last 256 addresses are reserved.
79 static void pick(struct in_addr *ip)
84 tmp = rand() & IN_CLASSB_HOST;
85 } while (tmp > (IN_CLASSB_HOST - 0x0200));
86 ip->s_addr = htonl((LINKLOCAL_ADDR + 0x0100) + tmp);
90 * Broadcast an ARP packet.
92 static void arp(int fd, struct sockaddr *saddr, int op,
93 const struct ether_addr *source_addr, struct in_addr source_ip,
94 const struct ether_addr *target_addr, struct in_addr target_ip)
97 memset(&p, 0, sizeof(p));
100 p.hdr.ether_type = htons(ETHERTYPE_ARP);
101 memcpy(p.hdr.ether_shost, source_addr, ETH_ALEN);
102 memset(p.hdr.ether_dhost, 0xff, ETH_ALEN);
105 p.arp.arp_hrd = htons(ARPHRD_ETHER);
106 p.arp.arp_pro = htons(ETHERTYPE_IP);
107 p.arp.arp_hln = ETH_ALEN;
109 p.arp.arp_op = htons(op);
110 memcpy(&p.arp.arp_sha, source_addr, ETH_ALEN);
111 memcpy(&p.arp.arp_spa, &source_ip, sizeof(p.arp.arp_spa));
112 memcpy(&p.arp.arp_tha, target_addr, ETH_ALEN);
113 memcpy(&p.arp.arp_tpa, &target_ip, sizeof(p.arp.arp_tpa));
116 xsendto(fd, &p, sizeof(p), saddr, sizeof(*saddr));
118 // Currently all callers ignore errors, that's why returns are
124 * Run a script. argv[2] is already NULL.
126 static int run(char *argv[3], const char *intf, struct in_addr *ip)
130 VDBG("%s run %s %s\n", intf, argv[0], argv[1]);
133 char *addr = inet_ntoa(*ip);
134 setenv("ip", addr, 1);
135 bb_info_msg("%s %s %s", argv[1], intf, addr);
138 status = wait4pid(spawn(argv));
140 bb_perror_msg("%s %s", argv[1], intf);
144 bb_error_msg("script %s %s failed, exitcode=%d", argv[0], argv[1], status);
149 * Return milliseconds of random delay, up to "secs" seconds.
151 static unsigned ALWAYS_INLINE ms_rdelay(unsigned secs)
153 return rand() % (secs * 1000);
159 int zcip_main(int argc, char **argv);
160 int zcip_main(int argc, char **argv)
163 /* Prevent unaligned traps for ARM (see srand() below) */
164 struct ether_addr eth_addr __attribute__(( aligned(sizeof(unsigned)) ));
170 /* Ugly trick, but I want these zeroed in one go */
172 const struct in_addr null_ip;
173 const struct ether_addr null_addr;
174 struct sockaddr saddr;
179 int timeout_ms; /* must be signed */
186 #define null_ip (L.null_ip )
187 #define null_addr (L.null_addr )
188 #define saddr (L.saddr )
191 #define intf (L.intf )
192 #define script_av (L.script_av )
193 #define timeout_ms (L.timeout_ms)
194 #define conflicts (L.conflicts )
195 #define nprobes (L.nprobes )
196 #define nclaims (L.nclaims )
197 #define ready (L.ready )
198 #define verbose (L.verbose )
200 memset(&L, 0, sizeof(L));
202 #define FOREGROUND (opts & 1)
203 #define QUIT (opts & 2)
204 // parse commandline: prog [options] ifname script
205 // exactly 2 args; -v accumulates and implies -f
206 opt_complementary = "=2:vv:vf";
207 opts = getopt32(argv, "fqr:v", &r_opt, &verbose);
209 /* Do it early, before all bb_xx_msg calls */
210 openlog(applet_name, 0, LOG_DAEMON);
211 logmode |= LOGMODE_SYSLOG;
213 if (opts & 4) { // -r n.n.n.n
214 if (inet_aton(r_opt, &ip) == 0
215 || (ntohl(ip.s_addr) & IN_CLASSB_NET) != LINKLOCAL_ADDR
217 bb_error_msg_and_die("invalid link address");
220 // On NOMMU reexec early (or else we will rerun things twice)
223 bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv);
229 script_av[0] = argv[1];
230 setenv("interface", intf, 1);
232 // initialize the interface (modprobe, ifup, etc)
233 script_av[1] = (char*)"init";
234 if (run(script_av, intf, NULL))
238 //memset(&saddr, 0, sizeof(saddr));
239 safe_strncpy(saddr.sa_data, intf, sizeof(saddr.sa_data));
241 // open an ARP socket
242 fd = xsocket(PF_PACKET, SOCK_PACKET, htons(ETH_P_ARP));
243 // bind to the interface's ARP socket
244 xbind(fd, &saddr, sizeof(saddr));
246 // get the interface's ethernet address
247 //memset(&ifr, 0, sizeof(ifr));
248 strncpy(ifr.ifr_name, intf, sizeof(ifr.ifr_name));
249 xioctl(fd, SIOCGIFHWADDR, &ifr);
250 memcpy(ð_addr, &ifr.ifr_hwaddr.sa_data, ETH_ALEN);
252 // start with some stable ip address, either a function of
253 // the hardware address or else the last address we used.
254 // NOTE: the sequence of addresses we try changes only
255 // depending on when we detect conflicts.
256 srand(*(unsigned*)ð_addr);
260 // FIXME cases to handle:
261 // - zcip already running!
262 // - link already has local address... just defend/update
264 // daemonize now; don't delay system startup
267 bb_daemonize(DAEMON_CHDIR_ROOT);
269 bb_info_msg("start, interface %s", intf);
272 // run the dynamic address negotiation protocol,
273 // restarting after address conflicts:
274 // - start with some address we want to try
275 // - short random delay
276 // - arp probes to see if another host else uses it
277 // - arp announcements that we're claiming it
279 // - defend it, within limits
281 struct pollfd fds[1];
282 unsigned deadline_us;
285 int source_ip_conflict = 0;
286 int target_ip_conflict = 0;
289 fds[0].events = POLLIN;
292 // poll, being ready to adjust current timeout
294 timeout_ms = ms_rdelay(PROBE_WAIT);
295 // FIXME setsockopt(fd, SO_ATTACH_FILTER, ...) to
296 // make the kernel filter out all packets except
297 // ones we'd care about.
299 // set deadline_us to the point in time when we timeout
300 deadline_us = MONOTONIC_US() + timeout_ms * 1000;
302 VDBG("...wait %d %s nprobes=%u, nclaims=%u\n",
303 timeout_ms, intf, nprobes, nclaims);
305 switch (safe_poll(fds, 1, timeout_ms)) {
308 /*bb_perror_msg("poll"); - done in safe_poll */
313 VDBG("state = %d\n", state);
316 // timeouts in the PROBE state mean no conflicting ARP packets
317 // have been received, so we can progress through the states
318 if (nprobes < PROBE_NUM) {
320 VDBG("probe/%u %s@%s\n",
321 nprobes, intf, inet_ntoa(ip));
322 arp(fd, &saddr, ARPOP_REQUEST,
325 timeout_ms = PROBE_MIN * 1000;
326 timeout_ms += ms_rdelay(PROBE_MAX - PROBE_MIN);
329 // Switch to announce state.
332 VDBG("announce/%u %s@%s\n",
333 nclaims, intf, inet_ntoa(ip));
334 arp(fd, &saddr, ARPOP_REQUEST,
337 timeout_ms = ANNOUNCE_INTERVAL * 1000;
340 case RATE_LIMIT_PROBE:
341 // timeouts in the RATE_LIMIT_PROBE state mean no conflicting ARP packets
342 // have been received, so we can move immediately to the announce state
345 VDBG("announce/%u %s@%s\n",
346 nclaims, intf, inet_ntoa(ip));
347 arp(fd, &saddr, ARPOP_REQUEST,
350 timeout_ms = ANNOUNCE_INTERVAL * 1000;
353 // timeouts in the ANNOUNCE state mean no conflicting ARP packets
354 // have been received, so we can progress through the states
355 if (nclaims < ANNOUNCE_NUM) {
357 VDBG("announce/%u %s@%s\n",
358 nclaims, intf, inet_ntoa(ip));
359 arp(fd, &saddr, ARPOP_REQUEST,
362 timeout_ms = ANNOUNCE_INTERVAL * 1000;
365 // Switch to monitor state.
367 // link is ok to use earlier
368 // FIXME update filters
369 script_av[1] = (char*)"config";
370 run(script_av, intf, &ip);
373 timeout_ms = -1; // Never timeout in the monitor state.
375 // NOTE: all other exit paths
376 // should deconfig ...
382 // We won! No ARP replies, so just go back to monitor.
388 // Invalid, should never happen. Restart the whole protocol.
396 break; // case 0 (timeout)
400 // We need to adjust the timeout in case we didn't receive
401 // a conflicting packet.
402 if (timeout_ms > 0) {
403 unsigned diff = deadline_us - MONOTONIC_US();
404 if ((int)(diff) < 0) {
405 // Current time is greater than the expected timeout time.
406 // Should never happen.
407 VDBG("missed an expected timeout\n");
410 VDBG("adjusting timeout\n");
411 timeout_ms = diff / 1000;
412 if (!timeout_ms) timeout_ms = 1;
416 if ((fds[0].revents & POLLIN) == 0) {
417 if (fds[0].revents & POLLERR) {
418 // FIXME: links routinely go down;
419 // this shouldn't necessarily exit.
420 bb_error_msg("%s: poll error", intf);
422 script_av[1] = (char*)"deconfig";
423 run(script_av, intf, &ip);
431 if (recv(fd, &p, sizeof(p), 0) < 0) {
435 if (p.hdr.ether_type != htons(ETHERTYPE_ARP))
440 struct ether_addr * sha = (struct ether_addr *) p.arp.arp_sha;
441 struct ether_addr * tha = (struct ether_addr *) p.arp.arp_tha;
442 struct in_addr * spa = (struct in_addr *) p.arp.arp_spa;
443 struct in_addr * tpa = (struct in_addr *) p.arp.arp_tpa;
444 VDBG("%s recv arp type=%d, op=%d,\n",
445 intf, ntohs(p.hdr.ether_type),
446 ntohs(p.arp.arp_op));
447 VDBG("\tsource=%s %s\n",
450 VDBG("\ttarget=%s %s\n",
455 if (p.arp.arp_op != htons(ARPOP_REQUEST)
456 && p.arp.arp_op != htons(ARPOP_REPLY))
459 if (memcmp(p.arp.arp_spa, &ip.s_addr, sizeof(struct in_addr)) == 0 &&
460 memcmp(ð_addr, &p.arp.arp_sha, ETH_ALEN) != 0) {
461 source_ip_conflict = 1;
463 if (memcmp(p.arp.arp_tpa, &ip.s_addr, sizeof(struct in_addr)) == 0 &&
464 p.arp.arp_op == htons(ARPOP_REQUEST) &&
465 memcmp(ð_addr, &p.arp.arp_tha, ETH_ALEN) != 0) {
466 target_ip_conflict = 1;
469 VDBG("state = %d, source ip conflict = %d, target ip conflict = %d\n",
470 state, source_ip_conflict, target_ip_conflict);
474 // When probing or announcing, check for source IP conflicts
475 // and other hosts doing ARP probes (target IP conflicts).
476 if (source_ip_conflict || target_ip_conflict) {
478 if (conflicts >= MAX_CONFLICTS) {
479 VDBG("%s ratelimit\n", intf);
480 timeout_ms = RATE_LIMIT_INTERVAL * 1000;
481 state = RATE_LIMIT_PROBE;
484 // restart the whole protocol
492 // If a conflict, we try to defend with a single ARP probe.
493 if (source_ip_conflict) {
494 VDBG("monitor conflict -- defending\n");
496 timeout_ms = DEFEND_INTERVAL * 1000;
504 // Well, we tried. Start over (on conflict).
505 if (source_ip_conflict) {
507 VDBG("defend conflict -- starting over\n");
509 script_av[1] = (char*)"deconfig";
510 run(script_av, intf, &ip);
512 // restart the whole protocol
520 // Invalid, should never happen. Restart the whole protocol.
521 VDBG("invalid state -- starting over\n");
529 break; // case 1 (packets arriving)
533 bb_perror_msg("%s, %s", intf, why);