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 struct ether_addr eth_addr;
169 /* Ugly trick, but I want these zeroed in one go */
171 const struct in_addr null_ip;
172 const struct ether_addr null_addr;
173 struct sockaddr saddr;
178 int timeout_ms; /* must be signed */
185 #define null_ip (L.null_ip )
186 #define null_addr (L.null_addr )
187 #define saddr (L.saddr )
190 #define intf (L.intf )
191 #define script_av (L.script_av )
192 #define timeout_ms (L.timeout_ms)
193 #define conflicts (L.conflicts )
194 #define nprobes (L.nprobes )
195 #define nclaims (L.nclaims )
196 #define ready (L.ready )
197 #define verbose (L.verbose )
199 memset(&L, 0, sizeof(L));
201 #define FOREGROUND (opts & 1)
202 #define QUIT (opts & 2)
203 // parse commandline: prog [options] ifname script
204 // exactly 2 args; -v accumulates and implies -f
205 opt_complementary = "=2:vv:vf";
206 opts = getopt32(argv, "fqr:v", &r_opt, &verbose);
208 /* Do it early, before all bb_xx_msg calls */
209 openlog(applet_name, 0, LOG_DAEMON);
210 logmode |= LOGMODE_SYSLOG;
212 if (opts & 4) { // -r n.n.n.n
213 if (inet_aton(r_opt, &ip) == 0
214 || (ntohl(ip.s_addr) & IN_CLASSB_NET) != LINKLOCAL_ADDR
216 bb_error_msg_and_die("invalid link address");
219 // On NOMMU reexec early (or else we will rerun things twice)
222 bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv);
228 script_av[0] = argv[1];
229 setenv("interface", intf, 1);
231 // initialize the interface (modprobe, ifup, etc)
232 script_av[1] = (char*)"init";
233 if (run(script_av, intf, NULL))
237 //memset(&saddr, 0, sizeof(saddr));
238 safe_strncpy(saddr.sa_data, intf, sizeof(saddr.sa_data));
240 // open an ARP socket
241 fd = xsocket(PF_PACKET, SOCK_PACKET, htons(ETH_P_ARP));
242 // bind to the interface's ARP socket
243 xbind(fd, &saddr, sizeof(saddr));
245 // get the interface's ethernet address
246 //memset(&ifr, 0, sizeof(ifr));
247 strncpy(ifr.ifr_name, intf, sizeof(ifr.ifr_name));
248 xioctl(fd, SIOCGIFHWADDR, &ifr);
249 memcpy(ð_addr, &ifr.ifr_hwaddr.sa_data, ETH_ALEN);
251 // start with some stable ip address, either a function of
252 // the hardware address or else the last address we used.
253 // NOTE: the sequence of addresses we try changes only
254 // depending on when we detect conflicts.
255 srand(*(unsigned*)&ifr.ifr_hwaddr.sa_data);
259 // FIXME cases to handle:
260 // - zcip already running!
261 // - link already has local address... just defend/update
263 // daemonize now; don't delay system startup
266 bb_daemonize(DAEMON_CHDIR_ROOT);
268 bb_info_msg("start, interface %s", intf);
271 // run the dynamic address negotiation protocol,
272 // restarting after address conflicts:
273 // - start with some address we want to try
274 // - short random delay
275 // - arp probes to see if another host else uses it
276 // - arp announcements that we're claiming it
278 // - defend it, within limits
280 struct pollfd fds[1];
281 unsigned deadline_us;
284 int source_ip_conflict = 0;
285 int target_ip_conflict = 0;
288 fds[0].events = POLLIN;
291 // poll, being ready to adjust current timeout
293 timeout_ms = ms_rdelay(PROBE_WAIT);
294 // FIXME setsockopt(fd, SO_ATTACH_FILTER, ...) to
295 // make the kernel filter out all packets except
296 // ones we'd care about.
298 // set deadline_us to the point in time when we timeout
299 deadline_us = MONOTONIC_US() + timeout_ms * 1000;
301 VDBG("...wait %d %s nprobes=%u, nclaims=%u\n",
302 timeout_ms, intf, nprobes, nclaims);
303 switch (poll(fds, 1, timeout_ms)) {
307 VDBG("state = %d\n", state);
310 // timeouts in the PROBE state mean no conflicting ARP packets
311 // have been received, so we can progress through the states
312 if (nprobes < PROBE_NUM) {
314 VDBG("probe/%u %s@%s\n",
315 nprobes, intf, inet_ntoa(ip));
316 arp(fd, &saddr, ARPOP_REQUEST,
319 timeout_ms = PROBE_MIN * 1000;
320 timeout_ms += ms_rdelay(PROBE_MAX - PROBE_MIN);
323 // Switch to announce state.
326 VDBG("announce/%u %s@%s\n",
327 nclaims, intf, inet_ntoa(ip));
328 arp(fd, &saddr, ARPOP_REQUEST,
331 timeout_ms = ANNOUNCE_INTERVAL * 1000;
334 case RATE_LIMIT_PROBE:
335 // timeouts in the RATE_LIMIT_PROBE state mean no conflicting ARP packets
336 // have been received, so we can move immediately to the announce state
339 VDBG("announce/%u %s@%s\n",
340 nclaims, intf, inet_ntoa(ip));
341 arp(fd, &saddr, ARPOP_REQUEST,
344 timeout_ms = ANNOUNCE_INTERVAL * 1000;
347 // timeouts in the ANNOUNCE state mean no conflicting ARP packets
348 // have been received, so we can progress through the states
349 if (nclaims < ANNOUNCE_NUM) {
351 VDBG("announce/%u %s@%s\n",
352 nclaims, intf, inet_ntoa(ip));
353 arp(fd, &saddr, ARPOP_REQUEST,
356 timeout_ms = ANNOUNCE_INTERVAL * 1000;
359 // Switch to monitor state.
361 // link is ok to use earlier
362 // FIXME update filters
363 script_av[1] = (char*)"config";
364 run(script_av, intf, &ip);
367 timeout_ms = -1; // Never timeout in the monitor state.
369 // NOTE: all other exit paths
370 // should deconfig ...
376 // We won! No ARP replies, so just go back to monitor.
382 // Invalid, should never happen. Restart the whole protocol.
390 break; // case 0 (timeout)
393 // We need to adjust the timeout in case we didn't receive
394 // a conflicting packet.
395 if (timeout_ms > 0) {
396 unsigned diff = deadline_us - MONOTONIC_US();
397 if ((int)(diff) < 0) {
398 // Current time is greater than the expected timeout time.
399 // Should never happen.
400 VDBG("missed an expected timeout\n");
403 VDBG("adjusting timeout\n");
404 timeout_ms = diff / 1000;
405 if (!timeout_ms) timeout_ms = 1;
409 if ((fds[0].revents & POLLIN) == 0) {
410 if (fds[0].revents & POLLERR) {
411 // FIXME: links routinely go down;
412 // this shouldn't necessarily exit.
413 bb_error_msg("%s: poll error", intf);
415 script_av[1] = (char*)"deconfig";
416 run(script_av, intf, &ip);
424 if (recv(fd, &p, sizeof(p), 0) < 0) {
428 if (p.hdr.ether_type != htons(ETHERTYPE_ARP))
433 struct ether_addr * sha = (struct ether_addr *) p.arp.arp_sha;
434 struct ether_addr * tha = (struct ether_addr *) p.arp.arp_tha;
435 struct in_addr * spa = (struct in_addr *) p.arp.arp_spa;
436 struct in_addr * tpa = (struct in_addr *) p.arp.arp_tpa;
437 VDBG("%s recv arp type=%d, op=%d,\n",
438 intf, ntohs(p.hdr.ether_type),
439 ntohs(p.arp.arp_op));
440 VDBG("\tsource=%s %s\n",
443 VDBG("\ttarget=%s %s\n",
448 if (p.arp.arp_op != htons(ARPOP_REQUEST)
449 && p.arp.arp_op != htons(ARPOP_REPLY))
452 if (memcmp(p.arp.arp_spa, &ip.s_addr, sizeof(struct in_addr)) == 0 &&
453 memcmp(ð_addr, &p.arp.arp_sha, ETH_ALEN) != 0) {
454 source_ip_conflict = 1;
456 if (memcmp(p.arp.arp_tpa, &ip.s_addr, sizeof(struct in_addr)) == 0 &&
457 p.arp.arp_op == htons(ARPOP_REQUEST) &&
458 memcmp(ð_addr, &p.arp.arp_tha, ETH_ALEN) != 0) {
459 target_ip_conflict = 1;
462 VDBG("state = %d, source ip conflict = %d, target ip conflict = %d\n",
463 state, source_ip_conflict, target_ip_conflict);
467 // When probing or announcing, check for source IP conflicts
468 // and other hosts doing ARP probes (target IP conflicts).
469 if (source_ip_conflict || target_ip_conflict) {
471 if (conflicts >= MAX_CONFLICTS) {
472 VDBG("%s ratelimit\n", intf);
473 timeout_ms = RATE_LIMIT_INTERVAL * 1000;
474 state = RATE_LIMIT_PROBE;
477 // restart the whole protocol
485 // If a conflict, we try to defend with a single ARP probe.
486 if (source_ip_conflict) {
487 VDBG("monitor conflict -- defending\n");
489 timeout_ms = DEFEND_INTERVAL * 1000;
497 // Well, we tried. Start over (on conflict).
498 if (source_ip_conflict) {
500 VDBG("defend conflict -- starting over\n");
502 script_av[1] = (char*)"deconfig";
503 run(script_av, intf, &ip);
505 // restart the whole protocol
513 // Invalid, should never happen. Restart the whole protocol.
514 VDBG("invalid state -- starting over\n");
523 break; // case 1 (packets arriving)
530 bb_perror_msg("%s, %s", intf, why);