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 GPLv2 or later, see file LICENSE in this source tree.
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)
26 //usage:#define zcip_trivial_usage
27 //usage: "[OPTIONS] IFACE SCRIPT"
28 //usage:#define zcip_full_usage "\n\n"
29 //usage: "Manage a ZeroConf IPv4 link-local address\n"
31 //usage: "\n -f Run in foreground"
32 //usage: "\n -q Quit after obtaining address"
33 //usage: "\n -r 169.254.x.x Request this address first"
34 //usage: "\n -v Verbose"
36 //usage: "\nWith no -q, runs continuously monitoring for ARP conflicts,"
37 //usage: "\nexits only on I/O errors (link down etc)"
39 #include <netinet/ether.h>
40 #include <net/ethernet.h>
42 #include <net/if_arp.h>
43 #include <linux/if_packet.h>
44 #include <linux/sockios.h>
49 /* We don't need more than 32 bits of the counter */
50 #define MONOTONIC_US() ((unsigned)monotonic_us())
53 struct ether_header eth;
59 LINKLOCAL_ADDR = 0xa9fe0000,
61 /* protocol timeout parameters, specified in seconds */
67 RATE_LIMIT_INTERVAL = 60,
70 ANNOUNCE_INTERVAL = 2,
74 /* States during the configuration process. */
83 #define VDBG(...) do { } while (0)
91 struct sockaddr saddr;
92 struct ether_addr eth_addr;
94 #define G (*(struct globals*)&bb_common_bufsiz1)
95 #define saddr (G.saddr )
96 #define eth_addr (G.eth_addr)
100 * Pick a random link local IP address on 169.254/16, except that
101 * the first and last 256 addresses are reserved.
103 static uint32_t pick(void)
108 tmp = rand() & IN_CLASSB_HOST;
109 } while (tmp > (IN_CLASSB_HOST - 0x0200));
110 return htonl((LINKLOCAL_ADDR + 0x0100) + tmp);
114 * Broadcast an ARP packet.
117 /* int op, - always ARPOP_REQUEST */
118 /* const struct ether_addr *source_eth, - always ð_addr */
119 struct in_addr source_ip,
120 const struct ether_addr *target_eth, struct in_addr target_ip)
122 enum { op = ARPOP_REQUEST };
123 #define source_eth (ð_addr)
126 memset(&p, 0, sizeof(p));
129 p.eth.ether_type = htons(ETHERTYPE_ARP);
130 memcpy(p.eth.ether_shost, source_eth, ETH_ALEN);
131 memset(p.eth.ether_dhost, 0xff, ETH_ALEN);
134 p.arp.arp_hrd = htons(ARPHRD_ETHER);
135 p.arp.arp_pro = htons(ETHERTYPE_IP);
136 p.arp.arp_hln = ETH_ALEN;
138 p.arp.arp_op = htons(op);
139 memcpy(&p.arp.arp_sha, source_eth, ETH_ALEN);
140 memcpy(&p.arp.arp_spa, &source_ip, sizeof(p.arp.arp_spa));
141 memcpy(&p.arp.arp_tha, target_eth, ETH_ALEN);
142 memcpy(&p.arp.arp_tpa, &target_ip, sizeof(p.arp.arp_tpa));
145 // Even though sock_fd is already bound to saddr, just send()
146 // won't work, because "socket is not connected"
147 // (and connect() won't fix that, "operation not supported").
148 // Thus we sendto() to saddr. I wonder which sockaddr
149 // (from bind() or from sendto()?) kernel actually uses
150 // to determine iface to emit the packet from...
151 xsendto(sock_fd, &p, sizeof(p), &saddr, sizeof(saddr));
157 * argv[0]:intf argv[1]:script_name argv[2]:junk argv[3]:NULL
159 static int run(char *argv[3], const char *param, struct in_addr *ip)
162 char *addr = addr; /* for gcc */
163 const char *fmt = "%s %s %s" + 3;
165 argv[2] = (char*)param;
167 VDBG("%s run %s %s\n", argv[0], argv[1], argv[2]);
170 addr = inet_ntoa(*ip);
174 bb_info_msg(fmt, argv[2], argv[0], addr);
176 status = spawn_and_wait(argv + 1);
178 bb_perror_msg("%s %s %s" + 3, argv[2], argv[0]);
182 bb_error_msg("script %s %s failed, exitcode=%d", argv[1], argv[2], status & 0xff);
187 * Return milliseconds of random delay, up to "secs" seconds.
189 static ALWAYS_INLINE unsigned random_delay_ms(unsigned secs)
191 return rand() % (secs * 1000);
197 int zcip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
198 int zcip_main(int argc UNUSED_PARAM, char **argv)
204 // ugly trick, but I want these zeroed in one go
206 const struct in_addr null_ip;
207 const struct ether_addr null_addr;
210 int timeout_ms; /* must be signed */
217 #define null_ip (L.null_ip )
218 #define null_addr (L.null_addr )
221 #define timeout_ms (L.timeout_ms)
222 #define conflicts (L.conflicts )
223 #define nprobes (L.nprobes )
224 #define nclaims (L.nclaims )
225 #define ready (L.ready )
226 #define verbose (L.verbose )
228 memset(&L, 0, sizeof(L));
230 #define FOREGROUND (opts & 1)
231 #define QUIT (opts & 2)
232 // parse commandline: prog [options] ifname script
233 // exactly 2 args; -v accumulates and implies -f
234 opt_complementary = "=2:vv:vf";
235 opts = getopt32(argv, "fqr:v", &r_opt, &verbose);
237 // on NOMMU reexec early (or else we will rerun things twice)
239 bb_daemonize_or_rexec(0 /*was: DAEMON_CHDIR_ROOT*/, argv);
241 // open an ARP socket
242 // (need to do it before openlog to prevent openlog from taking
243 // fd 3 (sock_fd==3))
244 xmove_fd(xsocket(AF_PACKET, SOCK_PACKET, htons(ETH_P_ARP)), sock_fd);
246 // do it before all bb_xx_msg calls
247 openlog(applet_name, 0, LOG_DAEMON);
248 logmode |= LOGMODE_SYSLOG;
250 if (opts & 4) { // -r n.n.n.n
251 if (inet_aton(r_opt, &ip) == 0
252 || (ntohl(ip.s_addr) & IN_CLASSB_NET) != LINKLOCAL_ADDR
254 bb_error_msg_and_die("invalid link address");
259 /* Now: argv[0]:junk argv[1]:intf argv[2]:script argv[3]:NULL */
260 /* We need to make space for script argument: */
263 /* Now: argv[0]:intf argv[1]:script argv[2]:junk argv[3]:NULL */
264 #define argv_intf (argv[0])
266 xsetenv("interface", argv_intf);
268 // initialize the interface (modprobe, ifup, etc)
269 if (run(argv, "init", NULL))
273 // saddr is: { u16 sa_family; u8 sa_data[14]; }
274 //memset(&saddr, 0, sizeof(saddr));
275 //TODO: are we leaving sa_family == 0 (AF_UNSPEC)?!
276 safe_strncpy(saddr.sa_data, argv_intf, sizeof(saddr.sa_data));
278 // bind to the interface's ARP socket
279 xbind(sock_fd, &saddr, sizeof(saddr));
281 // get the interface's ethernet address
282 //memset(&ifr, 0, sizeof(ifr));
283 strncpy_IFNAMSIZ(ifr.ifr_name, argv_intf);
284 xioctl(sock_fd, SIOCGIFHWADDR, &ifr);
285 memcpy(ð_addr, &ifr.ifr_hwaddr.sa_data, ETH_ALEN);
287 // start with some stable ip address, either a function of
288 // the hardware address or else the last address we used.
289 // we are taking low-order four bytes, as top-order ones
290 // aren't random enough.
291 // NOTE: the sequence of addresses we try changes only
292 // depending on when we detect conflicts.
295 move_from_unaligned32(t, ((char *)ð_addr + 2));
301 // FIXME cases to handle:
302 // - zcip already running!
303 // - link already has local address... just defend/update
305 // daemonize now; don't delay system startup
308 bb_daemonize(0 /*was: DAEMON_CHDIR_ROOT*/);
310 bb_info_msg("start, interface %s", argv_intf);
313 // run the dynamic address negotiation protocol,
314 // restarting after address conflicts:
315 // - start with some address we want to try
316 // - short random delay
317 // - arp probes to see if another host uses it
318 // - arp announcements that we're claiming it
320 // - defend it, within limits
322 // - address is successfully obtained and -q was given:
323 // run "<script> config", then exit with exitcode 0
324 // - poll error (when does this happen?)
325 // - read error (when does this happen?)
326 // - sendto error (in arp()) (when does this happen?)
327 // - revents & POLLERR (link down). run "<script> deconfig" first
330 struct pollfd fds[1];
331 unsigned deadline_us;
333 int source_ip_conflict;
334 int target_ip_conflict;
337 fds[0].events = POLLIN;
340 // poll, being ready to adjust current timeout
342 timeout_ms = random_delay_ms(PROBE_WAIT);
343 // FIXME setsockopt(sock_fd, SO_ATTACH_FILTER, ...) to
344 // make the kernel filter out all packets except
345 // ones we'd care about.
347 // set deadline_us to the point in time when we timeout
348 deadline_us = MONOTONIC_US() + timeout_ms * 1000;
350 VDBG("...wait %d %s nprobes=%u, nclaims=%u\n",
351 timeout_ms, argv_intf, nprobes, nclaims);
353 switch (safe_poll(fds, 1, timeout_ms)) {
356 //bb_perror_msg("poll"); - done in safe_poll
361 VDBG("state = %d\n", state);
364 // timeouts in the PROBE state mean no conflicting ARP packets
365 // have been received, so we can progress through the states
366 if (nprobes < PROBE_NUM) {
368 VDBG("probe/%u %s@%s\n",
369 nprobes, argv_intf, inet_ntoa(ip));
370 arp(/* ARPOP_REQUEST, */
371 /* ð_addr, */ null_ip,
373 timeout_ms = PROBE_MIN * 1000;
374 timeout_ms += random_delay_ms(PROBE_MAX - PROBE_MIN);
377 // Switch to announce state.
380 VDBG("announce/%u %s@%s\n",
381 nclaims, argv_intf, inet_ntoa(ip));
382 arp(/* ARPOP_REQUEST, */
385 timeout_ms = ANNOUNCE_INTERVAL * 1000;
388 case RATE_LIMIT_PROBE:
389 // timeouts in the RATE_LIMIT_PROBE state mean no conflicting ARP packets
390 // have been received, so we can move immediately to the announce state
393 VDBG("announce/%u %s@%s\n",
394 nclaims, argv_intf, inet_ntoa(ip));
395 arp(/* ARPOP_REQUEST, */
398 timeout_ms = ANNOUNCE_INTERVAL * 1000;
401 // timeouts in the ANNOUNCE state mean no conflicting ARP packets
402 // have been received, so we can progress through the states
403 if (nclaims < ANNOUNCE_NUM) {
405 VDBG("announce/%u %s@%s\n",
406 nclaims, argv_intf, inet_ntoa(ip));
407 arp(/* ARPOP_REQUEST, */
410 timeout_ms = ANNOUNCE_INTERVAL * 1000;
413 // Switch to monitor state.
415 // link is ok to use earlier
416 // FIXME update filters
417 run(argv, "config", &ip);
420 timeout_ms = -1; // Never timeout in the monitor state.
422 // NOTE: all other exit paths
423 // should deconfig ...
429 // We won! No ARP replies, so just go back to monitor.
435 // Invalid, should never happen. Restart the whole protocol.
443 break; // case 0 (timeout)
445 // packets arriving, or link went down
447 // We need to adjust the timeout in case we didn't receive
448 // a conflicting packet.
449 if (timeout_ms > 0) {
450 unsigned diff = deadline_us - MONOTONIC_US();
451 if ((int)(diff) < 0) {
452 // Current time is greater than the expected timeout time.
453 // Should never happen.
454 VDBG("missed an expected timeout\n");
457 VDBG("adjusting timeout\n");
458 timeout_ms = (diff / 1000) | 1; /* never 0 */
462 if ((fds[0].revents & POLLIN) == 0) {
463 if (fds[0].revents & POLLERR) {
464 // FIXME: links routinely go down;
465 // this shouldn't necessarily exit.
466 bb_error_msg("iface %s is down", argv_intf);
468 run(argv, "deconfig", &ip);
476 if (safe_read(sock_fd, &p, sizeof(p)) < 0) {
477 bb_perror_msg_and_die(bb_msg_read_error);
479 if (p.eth.ether_type != htons(ETHERTYPE_ARP))
483 struct ether_addr *sha = (struct ether_addr *) p.arp.arp_sha;
484 struct ether_addr *tha = (struct ether_addr *) p.arp.arp_tha;
485 struct in_addr *spa = (struct in_addr *) p.arp.arp_spa;
486 struct in_addr *tpa = (struct in_addr *) p.arp.arp_tpa;
487 VDBG("%s recv arp type=%d, op=%d,\n",
488 argv_intf, ntohs(p.eth.ether_type),
489 ntohs(p.arp.arp_op));
490 VDBG("\tsource=%s %s\n",
493 VDBG("\ttarget=%s %s\n",
498 if (p.arp.arp_op != htons(ARPOP_REQUEST)
499 && p.arp.arp_op != htons(ARPOP_REPLY))
502 source_ip_conflict = 0;
503 target_ip_conflict = 0;
505 if (memcmp(p.arp.arp_spa, &ip.s_addr, sizeof(struct in_addr)) == 0
506 && memcmp(&p.arp.arp_sha, ð_addr, ETH_ALEN) != 0
508 source_ip_conflict = 1;
510 if (p.arp.arp_op == htons(ARPOP_REQUEST)
511 && memcmp(p.arp.arp_tpa, &ip.s_addr, sizeof(struct in_addr)) == 0
512 && memcmp(&p.arp.arp_tha, ð_addr, ETH_ALEN) != 0
514 target_ip_conflict = 1;
517 VDBG("state = %d, source ip conflict = %d, target ip conflict = %d\n",
518 state, source_ip_conflict, target_ip_conflict);
522 // When probing or announcing, check for source IP conflicts
523 // and other hosts doing ARP probes (target IP conflicts).
524 if (source_ip_conflict || target_ip_conflict) {
526 if (conflicts >= MAX_CONFLICTS) {
527 VDBG("%s ratelimit\n", argv_intf);
528 timeout_ms = RATE_LIMIT_INTERVAL * 1000;
529 state = RATE_LIMIT_PROBE;
532 // restart the whole protocol
540 // If a conflict, we try to defend with a single ARP probe.
541 if (source_ip_conflict) {
542 VDBG("monitor conflict -- defending\n");
544 timeout_ms = DEFEND_INTERVAL * 1000;
545 arp(/* ARPOP_REQUEST, */
551 // Well, we tried. Start over (on conflict).
552 if (source_ip_conflict) {
554 VDBG("defend conflict -- starting over\n");
556 run(argv, "deconfig", &ip);
558 // restart the whole protocol
566 // Invalid, should never happen. Restart the whole protocol.
567 VDBG("invalid state -- starting over\n");
575 break; // case 1 (packets arriving)