2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2002 Michael Shalayeff.
5 * Copyright (c) 2003 Ryan McBride.
6 * Copyright (c) 2011 Gleb Smirnoff <glebius@FreeBSD.org>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR OR HIS RELATIVES BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF MIND, USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28 * THE POSSIBILITY OF SUCH DAMAGE.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
36 #include "opt_inet6.h"
38 #include <sys/param.h>
39 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
46 #include <sys/module.h>
49 #include <sys/protosw.h>
50 #include <sys/socket.h>
51 #include <sys/sockio.h>
52 #include <sys/sysctl.h>
53 #include <sys/syslog.h>
54 #include <sys/taskqueue.h>
55 #include <sys/counter.h>
57 #include <net/ethernet.h>
59 #include <net/if_var.h>
60 #include <net/if_dl.h>
61 #include <net/if_llatbl.h>
62 #include <net/if_types.h>
63 #include <net/route.h>
66 #if defined(INET) || defined(INET6)
67 #include <netinet/in.h>
68 #include <netinet/in_var.h>
69 #include <netinet/ip_carp.h>
70 #include <netinet/ip.h>
71 #include <machine/in_cksum.h>
74 #include <netinet/ip_var.h>
75 #include <netinet/if_ether.h>
79 #include <netinet/icmp6.h>
80 #include <netinet/ip6.h>
81 #include <netinet6/in6_var.h>
82 #include <netinet6/ip6_var.h>
83 #include <netinet6/scope6_var.h>
84 #include <netinet6/nd6.h>
87 #include <crypto/sha1.h>
89 static MALLOC_DEFINE(M_CARP, "CARP", "CARP addresses");
92 struct ifnet *sc_carpdev; /* Pointer to parent ifnet. */
93 struct ifaddr **sc_ifas; /* Our ifaddrs. */
94 struct sockaddr_dl sc_addr; /* Our link level address. */
95 struct callout sc_ad_tmo; /* Advertising timeout. */
97 struct callout sc_md_tmo; /* Master down timeout. */
100 struct callout sc_md6_tmo; /* XXX: Master down timeout. */
111 enum { INIT = 0, BACKUP, MASTER } sc_state;
113 int sc_sendad_errors;
114 #define CARP_SENDAD_MAX_ERRORS 3
115 int sc_sendad_success;
116 #define CARP_SENDAD_MIN_SUCCESS 3
122 #define CARP_HMAC_PAD 64
123 unsigned char sc_key[CARP_KEY_LEN];
124 unsigned char sc_pad[CARP_HMAC_PAD];
127 TAILQ_ENTRY(carp_softc) sc_list; /* On the carp_if list. */
128 LIST_ENTRY(carp_softc) sc_next; /* On the global list. */
138 TAILQ_HEAD(, carp_softc) cif_vrs;
140 struct ip_moptions cif_imo;
143 struct ip6_moptions cif_im6o;
145 struct ifnet *cif_ifp;
148 #define CIF_PROMISC 0x00000001
153 static int proto_reg[] = {-1, -1};
156 * Brief design of carp(4).
158 * Any carp-capable ifnet may have a list of carp softcs hanging off
159 * its ifp->if_carp pointer. Each softc represents one unique virtual
160 * host id, or vhid. The softc has a back pointer to the ifnet. All
161 * softcs are joined in a global list, which has quite limited use.
163 * Any interface address that takes part in CARP negotiation has a
164 * pointer to the softc of its vhid, ifa->ifa_carp. That could be either
165 * AF_INET or AF_INET6 address.
167 * Although, one can get the softc's backpointer to ifnet and traverse
168 * through its ifp->if_addrhead queue to find all interface addresses
169 * involved in CARP, we keep a growable array of ifaddr pointers. This
170 * allows us to avoid grabbing the IF_ADDR_LOCK() in many traversals that
171 * do calls into the network stack, thus avoiding LORs.
175 * Each softc has a lock sc_mtx. It is used to synchronise carp_input_c(),
176 * callout-driven events and ioctl()s.
178 * To traverse the list of softcs on an ifnet we use CIF_LOCK() or carp_sx.
179 * To traverse the global list we use the mutex carp_mtx.
181 * Known issues with locking:
183 * - Sending ad, we put the pointer to the softc in an mtag, and no reference
184 * counting is done on the softc.
185 * - On module unload we may race (?) with packet processing thread
186 * dereferencing our function pointers.
189 /* Accept incoming CARP packets. */
190 VNET_DEFINE_STATIC(int, carp_allow) = 1;
191 #define V_carp_allow VNET(carp_allow)
193 /* Set DSCP in outgoing CARP packets. */
194 VNET_DEFINE_STATIC(int, carp_dscp) = 56;
195 #define V_carp_dscp VNET(carp_dscp)
197 /* Preempt slower nodes. */
198 VNET_DEFINE_STATIC(int, carp_preempt) = 0;
199 #define V_carp_preempt VNET(carp_preempt)
202 VNET_DEFINE_STATIC(int, carp_log) = 1;
203 #define V_carp_log VNET(carp_log)
205 /* Global advskew demotion. */
206 VNET_DEFINE_STATIC(int, carp_demotion) = 0;
207 #define V_carp_demotion VNET(carp_demotion)
209 /* Send error demotion factor. */
210 VNET_DEFINE_STATIC(int, carp_senderr_adj) = CARP_MAXSKEW;
211 #define V_carp_senderr_adj VNET(carp_senderr_adj)
213 /* Iface down demotion factor. */
214 VNET_DEFINE_STATIC(int, carp_ifdown_adj) = CARP_MAXSKEW;
215 #define V_carp_ifdown_adj VNET(carp_ifdown_adj)
217 static int carp_allow_sysctl(SYSCTL_HANDLER_ARGS);
218 static int carp_dscp_sysctl(SYSCTL_HANDLER_ARGS);
219 static int carp_demote_adj_sysctl(SYSCTL_HANDLER_ARGS);
221 SYSCTL_NODE(_net_inet, IPPROTO_CARP, carp, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
223 SYSCTL_PROC(_net_inet_carp, OID_AUTO, allow,
224 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
225 0, 0, carp_allow_sysctl, "I",
226 "Accept incoming CARP packets");
227 SYSCTL_PROC(_net_inet_carp, OID_AUTO, dscp,
228 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
229 0, 0, carp_dscp_sysctl, "I",
230 "DSCP value for carp packets");
231 SYSCTL_INT(_net_inet_carp, OID_AUTO, preempt, CTLFLAG_VNET | CTLFLAG_RW,
232 &VNET_NAME(carp_preempt), 0, "High-priority backup preemption mode");
233 SYSCTL_INT(_net_inet_carp, OID_AUTO, log, CTLFLAG_VNET | CTLFLAG_RW,
234 &VNET_NAME(carp_log), 0, "CARP log level");
235 SYSCTL_PROC(_net_inet_carp, OID_AUTO, demotion,
236 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
237 0, 0, carp_demote_adj_sysctl, "I",
238 "Adjust demotion factor (skew of advskew)");
239 SYSCTL_INT(_net_inet_carp, OID_AUTO, senderr_demotion_factor,
240 CTLFLAG_VNET | CTLFLAG_RW,
241 &VNET_NAME(carp_senderr_adj), 0, "Send error demotion factor adjustment");
242 SYSCTL_INT(_net_inet_carp, OID_AUTO, ifdown_demotion_factor,
243 CTLFLAG_VNET | CTLFLAG_RW,
244 &VNET_NAME(carp_ifdown_adj), 0,
245 "Interface down demotion factor adjustment");
247 VNET_PCPUSTAT_DEFINE(struct carpstats, carpstats);
248 VNET_PCPUSTAT_SYSINIT(carpstats);
249 VNET_PCPUSTAT_SYSUNINIT(carpstats);
251 #define CARPSTATS_ADD(name, val) \
252 counter_u64_add(VNET(carpstats)[offsetof(struct carpstats, name) / \
253 sizeof(uint64_t)], (val))
254 #define CARPSTATS_INC(name) CARPSTATS_ADD(name, 1)
256 SYSCTL_VNET_PCPUSTAT(_net_inet_carp, OID_AUTO, stats, struct carpstats,
257 carpstats, "CARP statistics (struct carpstats, netinet/ip_carp.h)");
259 #define CARP_LOCK_INIT(sc) mtx_init(&(sc)->sc_mtx, "carp_softc", \
261 #define CARP_LOCK_DESTROY(sc) mtx_destroy(&(sc)->sc_mtx)
262 #define CARP_LOCK_ASSERT(sc) mtx_assert(&(sc)->sc_mtx, MA_OWNED)
263 #define CARP_LOCK(sc) mtx_lock(&(sc)->sc_mtx)
264 #define CARP_UNLOCK(sc) mtx_unlock(&(sc)->sc_mtx)
265 #define CIF_LOCK_INIT(cif) mtx_init(&(cif)->cif_mtx, "carp_if", \
267 #define CIF_LOCK_DESTROY(cif) mtx_destroy(&(cif)->cif_mtx)
268 #define CIF_LOCK_ASSERT(cif) mtx_assert(&(cif)->cif_mtx, MA_OWNED)
269 #define CIF_LOCK(cif) mtx_lock(&(cif)->cif_mtx)
270 #define CIF_UNLOCK(cif) mtx_unlock(&(cif)->cif_mtx)
271 #define CIF_FREE(cif) do { \
273 if (TAILQ_EMPTY(&(cif)->cif_vrs)) \
279 #define CARP_LOG(...) do { \
280 if (V_carp_log > 0) \
281 log(LOG_INFO, "carp: " __VA_ARGS__); \
284 #define CARP_DEBUG(...) do { \
285 if (V_carp_log > 1) \
286 log(LOG_DEBUG, __VA_ARGS__); \
289 #define IFNET_FOREACH_IFA(ifp, ifa) \
290 CK_STAILQ_FOREACH((ifa), &(ifp)->if_addrhead, ifa_link) \
291 if ((ifa)->ifa_carp != NULL)
293 #define CARP_FOREACH_IFA(sc, ifa) \
294 CARP_LOCK_ASSERT(sc); \
296 _i < (sc)->sc_naddrs + (sc)->sc_naddrs6 && \
297 ((ifa) = sc->sc_ifas[_i]) != NULL; \
300 #define IFNET_FOREACH_CARP(ifp, sc) \
301 KASSERT(mtx_owned(&ifp->if_carp->cif_mtx) || \
302 sx_xlocked(&carp_sx), ("cif_vrs not locked")); \
303 TAILQ_FOREACH((sc), &(ifp)->if_carp->cif_vrs, sc_list)
305 #define DEMOTE_ADVSKEW(sc) \
306 (((sc)->sc_advskew + V_carp_demotion > CARP_MAXSKEW) ? \
307 CARP_MAXSKEW : ((sc)->sc_advskew + V_carp_demotion))
309 static void carp_input_c(struct mbuf *, struct carp_header *, sa_family_t);
310 static struct carp_softc
311 *carp_alloc(struct ifnet *);
312 static void carp_destroy(struct carp_softc *);
313 static struct carp_if
314 *carp_alloc_if(struct ifnet *);
315 static void carp_free_if(struct carp_if *);
316 static void carp_set_state(struct carp_softc *, int, const char* reason);
317 static void carp_sc_state(struct carp_softc *);
318 static void carp_setrun(struct carp_softc *, sa_family_t);
319 static void carp_master_down(void *);
320 static void carp_master_down_locked(struct carp_softc *,
322 static void carp_send_ad(void *);
323 static void carp_send_ad_locked(struct carp_softc *);
324 static void carp_addroute(struct carp_softc *);
325 static void carp_ifa_addroute(struct ifaddr *);
326 static void carp_delroute(struct carp_softc *);
327 static void carp_ifa_delroute(struct ifaddr *);
328 static void carp_send_ad_all(void *, int);
329 static void carp_demote_adj(int, char *);
331 static LIST_HEAD(, carp_softc) carp_list;
332 static struct mtx carp_mtx;
333 static struct sx carp_sx;
334 static struct task carp_sendall_task =
335 TASK_INITIALIZER(0, carp_send_ad_all, NULL);
338 carp_hmac_prepare(struct carp_softc *sc)
340 uint8_t version = CARP_VERSION, type = CARP_ADVERTISEMENT;
341 uint8_t vhid = sc->sc_vhid & 0xff;
345 struct in_addr last, cur, in;
348 struct in6_addr last6, cur6, in6;
351 CARP_LOCK_ASSERT(sc);
353 /* Compute ipad from key. */
354 bzero(sc->sc_pad, sizeof(sc->sc_pad));
355 bcopy(sc->sc_key, sc->sc_pad, sizeof(sc->sc_key));
356 for (i = 0; i < sizeof(sc->sc_pad); i++)
357 sc->sc_pad[i] ^= 0x36;
359 /* Precompute first part of inner hash. */
360 SHA1Init(&sc->sc_sha1);
361 SHA1Update(&sc->sc_sha1, sc->sc_pad, sizeof(sc->sc_pad));
362 SHA1Update(&sc->sc_sha1, (void *)&version, sizeof(version));
363 SHA1Update(&sc->sc_sha1, (void *)&type, sizeof(type));
364 SHA1Update(&sc->sc_sha1, (void *)&vhid, sizeof(vhid));
370 cur.s_addr = 0xffffffff;
371 CARP_FOREACH_IFA(sc, ifa) {
372 in.s_addr = ifatoia(ifa)->ia_addr.sin_addr.s_addr;
373 if (ifa->ifa_addr->sa_family == AF_INET &&
374 ntohl(in.s_addr) > ntohl(last.s_addr) &&
375 ntohl(in.s_addr) < ntohl(cur.s_addr)) {
376 cur.s_addr = in.s_addr;
381 SHA1Update(&sc->sc_sha1, (void *)&cur, sizeof(cur));
385 memset(&cur6, 0, sizeof(cur6));
389 memset(&cur6, 0xff, sizeof(cur6));
390 CARP_FOREACH_IFA(sc, ifa) {
391 in6 = ifatoia6(ifa)->ia_addr.sin6_addr;
392 if (IN6_IS_SCOPE_EMBED(&in6))
393 in6.s6_addr16[1] = 0;
394 if (ifa->ifa_addr->sa_family == AF_INET6 &&
395 memcmp(&in6, &last6, sizeof(in6)) > 0 &&
396 memcmp(&in6, &cur6, sizeof(in6)) < 0) {
402 SHA1Update(&sc->sc_sha1, (void *)&cur6, sizeof(cur6));
406 /* convert ipad to opad */
407 for (i = 0; i < sizeof(sc->sc_pad); i++)
408 sc->sc_pad[i] ^= 0x36 ^ 0x5c;
412 carp_hmac_generate(struct carp_softc *sc, uint32_t counter[2],
413 unsigned char md[20])
417 CARP_LOCK_ASSERT(sc);
419 /* fetch first half of inner hash */
420 bcopy(&sc->sc_sha1, &sha1ctx, sizeof(sha1ctx));
422 SHA1Update(&sha1ctx, (void *)counter, sizeof(sc->sc_counter));
423 SHA1Final(md, &sha1ctx);
427 SHA1Update(&sha1ctx, sc->sc_pad, sizeof(sc->sc_pad));
428 SHA1Update(&sha1ctx, md, 20);
429 SHA1Final(md, &sha1ctx);
433 carp_hmac_verify(struct carp_softc *sc, uint32_t counter[2],
434 unsigned char md[20])
436 unsigned char md2[20];
438 CARP_LOCK_ASSERT(sc);
440 carp_hmac_generate(sc, counter, md2);
442 return (bcmp(md, md2, sizeof(md2)));
446 * process input packet.
447 * we have rearranged checks order compared to the rfc,
448 * but it seems more efficient this way or not possible otherwise.
452 carp_input(struct mbuf **mp, int *offp, int proto)
454 struct mbuf *m = *mp;
455 struct ip *ip = mtod(m, struct ip *);
456 struct carp_header *ch;
462 CARPSTATS_INC(carps_ipackets);
466 return (IPPROTO_DONE);
469 /* verify that the IP TTL is 255. */
470 if (ip->ip_ttl != CARP_DFLTTL) {
471 CARPSTATS_INC(carps_badttl);
472 CARP_DEBUG("%s: received ttl %d != 255 on %s\n", __func__,
474 m->m_pkthdr.rcvif->if_xname);
476 return (IPPROTO_DONE);
479 iplen = ip->ip_hl << 2;
481 if (m->m_pkthdr.len < iplen + sizeof(*ch)) {
482 CARPSTATS_INC(carps_badlen);
483 CARP_DEBUG("%s: received len %zd < sizeof(struct carp_header) "
484 "on %s\n", __func__, m->m_len - sizeof(struct ip),
485 m->m_pkthdr.rcvif->if_xname);
487 return (IPPROTO_DONE);
490 if (iplen + sizeof(*ch) < m->m_len) {
491 if ((m = m_pullup(m, iplen + sizeof(*ch))) == NULL) {
492 CARPSTATS_INC(carps_hdrops);
493 CARP_DEBUG("%s: pullup failed\n", __func__);
494 return (IPPROTO_DONE);
496 ip = mtod(m, struct ip *);
498 ch = (struct carp_header *)((char *)ip + iplen);
501 * verify that the received packet length is
502 * equal to the CARP header
504 len = iplen + sizeof(*ch);
505 if (len > m->m_pkthdr.len) {
506 CARPSTATS_INC(carps_badlen);
507 CARP_DEBUG("%s: packet too short %d on %s\n", __func__,
509 m->m_pkthdr.rcvif->if_xname);
511 return (IPPROTO_DONE);
514 if ((m = m_pullup(m, len)) == NULL) {
515 CARPSTATS_INC(carps_hdrops);
516 return (IPPROTO_DONE);
518 ip = mtod(m, struct ip *);
519 ch = (struct carp_header *)((char *)ip + iplen);
521 /* verify the CARP checksum */
523 if (in_cksum(m, len - iplen)) {
524 CARPSTATS_INC(carps_badsum);
525 CARP_DEBUG("%s: checksum failed on %s\n", __func__,
526 m->m_pkthdr.rcvif->if_xname);
528 return (IPPROTO_DONE);
532 carp_input_c(m, ch, AF_INET);
533 return (IPPROTO_DONE);
539 carp6_input(struct mbuf **mp, int *offp, int proto)
541 struct mbuf *m = *mp;
542 struct ip6_hdr *ip6 = mtod(m, struct ip6_hdr *);
543 struct carp_header *ch;
546 CARPSTATS_INC(carps_ipackets6);
550 return (IPPROTO_DONE);
553 /* check if received on a valid carp interface */
554 if (m->m_pkthdr.rcvif->if_carp == NULL) {
555 CARPSTATS_INC(carps_badif);
556 CARP_DEBUG("%s: packet received on non-carp interface: %s\n",
557 __func__, m->m_pkthdr.rcvif->if_xname);
559 return (IPPROTO_DONE);
562 /* verify that the IP TTL is 255 */
563 if (ip6->ip6_hlim != CARP_DFLTTL) {
564 CARPSTATS_INC(carps_badttl);
565 CARP_DEBUG("%s: received ttl %d != 255 on %s\n", __func__,
566 ip6->ip6_hlim, m->m_pkthdr.rcvif->if_xname);
568 return (IPPROTO_DONE);
571 /* verify that we have a complete carp packet */
572 if (m->m_len < *offp + sizeof(*ch)) {
574 m = m_pullup(m, *offp + sizeof(*ch));
576 CARPSTATS_INC(carps_badlen);
577 CARP_DEBUG("%s: packet size %u too small\n", __func__, len);
578 return (IPPROTO_DONE);
581 ch = (struct carp_header *)(mtod(m, char *) + *offp);
584 /* verify the CARP checksum */
586 if (in_cksum(m, sizeof(*ch))) {
587 CARPSTATS_INC(carps_badsum);
588 CARP_DEBUG("%s: checksum failed, on %s\n", __func__,
589 m->m_pkthdr.rcvif->if_xname);
591 return (IPPROTO_DONE);
595 carp_input_c(m, ch, AF_INET6);
596 return (IPPROTO_DONE);
601 * This routine should not be necessary at all, but some switches
602 * (VMWare ESX vswitches) can echo our own packets back at us,
603 * and we must ignore them or they will cause us to drop out of
606 * We cannot catch all cases of network loops. Instead, what we
607 * do here is catch any packet that arrives with a carp header
608 * with a VHID of 0, that comes from an address that is our own.
609 * These packets are by definition "from us" (even if they are from
610 * a misconfigured host that is pretending to be us).
612 * The VHID test is outside this mini-function.
615 carp_source_is_self(struct mbuf *m, struct ifaddr *ifa, sa_family_t af)
629 ip4 = mtod(m, struct ip *);
630 in4 = ifatoia(ifa)->ia_addr.sin_addr;
631 return (in4.s_addr == ip4->ip_src.s_addr);
635 ip6 = mtod(m, struct ip6_hdr *);
636 in6 = ifatoia6(ifa)->ia_addr.sin6_addr;
637 return (memcmp(&in6, &ip6->ip6_src, sizeof(in6)) == 0);
646 carp_input_c(struct mbuf *m, struct carp_header *ch, sa_family_t af)
648 struct ifnet *ifp = m->m_pkthdr.rcvif;
649 struct ifaddr *ifa, *match;
650 struct carp_softc *sc;
651 uint64_t tmp_counter;
652 struct timeval sc_tv, ch_tv;
658 * Verify that the VHID is valid on the receiving interface.
660 * There should be just one match. If there are none
661 * the VHID is not valid and we drop the packet. If
662 * there are multiple VHID matches, take just the first
663 * one, for compatibility with previous code. While we're
664 * scanning, check for obvious loops in the network topology
665 * (these should never happen, and as noted above, we may
666 * miss real loops; this is just a double-check).
670 IFNET_FOREACH_IFA(ifp, ifa) {
671 if (match == NULL && ifa->ifa_carp != NULL &&
672 ifa->ifa_addr->sa_family == af &&
673 ifa->ifa_carp->sc_vhid == ch->carp_vhid)
675 if (ch->carp_vhid == 0 && carp_source_is_self(m, ifa, af))
678 ifa = error ? NULL : match;
683 if (error == ELOOP) {
684 CARP_DEBUG("dropping looped packet on interface %s\n",
686 CARPSTATS_INC(carps_badif); /* ??? */
688 CARPSTATS_INC(carps_badvhid);
694 /* verify the CARP version. */
695 if (ch->carp_version != CARP_VERSION) {
696 CARPSTATS_INC(carps_badver);
697 CARP_DEBUG("%s: invalid version %d\n", ifp->if_xname,
708 if (carp_hmac_verify(sc, ch->carp_counter, ch->carp_md)) {
709 CARPSTATS_INC(carps_badauth);
710 CARP_DEBUG("%s: incorrect hash for VHID %u@%s\n", __func__,
711 sc->sc_vhid, ifp->if_xname);
715 tmp_counter = ntohl(ch->carp_counter[0]);
716 tmp_counter = tmp_counter<<32;
717 tmp_counter += ntohl(ch->carp_counter[1]);
719 /* XXX Replay protection goes here */
721 sc->sc_init_counter = 0;
722 sc->sc_counter = tmp_counter;
724 sc_tv.tv_sec = sc->sc_advbase;
725 sc_tv.tv_usec = DEMOTE_ADVSKEW(sc) * 1000000 / 256;
726 ch_tv.tv_sec = ch->carp_advbase;
727 ch_tv.tv_usec = ch->carp_advskew * 1000000 / 256;
729 switch (sc->sc_state) {
734 * If we receive an advertisement from a master who's going to
735 * be more frequent than us, go into BACKUP state.
737 if (timevalcmp(&sc_tv, &ch_tv, >) ||
738 timevalcmp(&sc_tv, &ch_tv, ==)) {
739 callout_stop(&sc->sc_ad_tmo);
740 carp_set_state(sc, BACKUP,
741 "more frequent advertisement received");
748 * If we're pre-empting masters who advertise slower than us,
749 * and this one claims to be slower, treat him as down.
751 if (V_carp_preempt && timevalcmp(&sc_tv, &ch_tv, <)) {
752 carp_master_down_locked(sc,
753 "preempting a slower master");
758 * If the master is going to advertise at such a low frequency
759 * that he's guaranteed to time out, we'd might as well just
760 * treat him as timed out now.
762 sc_tv.tv_sec = sc->sc_advbase * 3;
763 if (timevalcmp(&sc_tv, &ch_tv, <)) {
764 carp_master_down_locked(sc, "master will time out");
769 * Otherwise, we reset the counter and wait for the next
782 carp_prepare_ad(struct mbuf *m, struct carp_softc *sc, struct carp_header *ch)
786 if (sc->sc_init_counter) {
787 /* this could also be seconds since unix epoch */
788 sc->sc_counter = arc4random();
789 sc->sc_counter = sc->sc_counter << 32;
790 sc->sc_counter += arc4random();
794 ch->carp_counter[0] = htonl((sc->sc_counter>>32)&0xffffffff);
795 ch->carp_counter[1] = htonl(sc->sc_counter&0xffffffff);
797 carp_hmac_generate(sc, ch->carp_counter, ch->carp_md);
799 /* Tag packet for carp_output */
800 if ((mtag = m_tag_get(PACKET_TAG_CARP, sizeof(struct carp_softc *),
801 M_NOWAIT)) == NULL) {
803 CARPSTATS_INC(carps_onomem);
806 bcopy(&sc, mtag + 1, sizeof(sc));
807 m_tag_prepend(m, mtag);
813 * To avoid LORs and possible recursions this function shouldn't
814 * be called directly, but scheduled via taskqueue.
817 carp_send_ad_all(void *ctx __unused, int pending __unused)
819 struct carp_softc *sc;
820 struct epoch_tracker et;
824 LIST_FOREACH(sc, &carp_list, sc_next)
825 if (sc->sc_state == MASTER) {
827 CURVNET_SET(sc->sc_carpdev->if_vnet);
828 carp_send_ad_locked(sc);
832 mtx_unlock(&carp_mtx);
836 /* Send a periodic advertisement, executed in callout context. */
838 carp_send_ad(void *v)
840 struct carp_softc *sc = v;
841 struct epoch_tracker et;
844 CARP_LOCK_ASSERT(sc);
845 CURVNET_SET(sc->sc_carpdev->if_vnet);
846 carp_send_ad_locked(sc);
853 carp_send_ad_error(struct carp_softc *sc, int error)
857 if (sc->sc_sendad_errors < INT_MAX)
858 sc->sc_sendad_errors++;
859 if (sc->sc_sendad_errors == CARP_SENDAD_MAX_ERRORS) {
860 static const char fmt[] = "send error %d on %s";
861 char msg[sizeof(fmt) + IFNAMSIZ];
863 sprintf(msg, fmt, error, sc->sc_carpdev->if_xname);
864 carp_demote_adj(V_carp_senderr_adj, msg);
866 sc->sc_sendad_success = 0;
868 if (sc->sc_sendad_errors >= CARP_SENDAD_MAX_ERRORS &&
869 ++sc->sc_sendad_success >= CARP_SENDAD_MIN_SUCCESS) {
870 static const char fmt[] = "send ok on %s";
871 char msg[sizeof(fmt) + IFNAMSIZ];
873 sprintf(msg, fmt, sc->sc_carpdev->if_xname);
874 carp_demote_adj(-V_carp_senderr_adj, msg);
875 sc->sc_sendad_errors = 0;
877 sc->sc_sendad_errors = 0;
882 * Pick the best ifaddr on the given ifp for sending CARP
885 * "Best" here is defined by ifa_preferred(). This function is much
886 * much like ifaof_ifpforaddr() except that we just use ifa_preferred().
888 * (This could be simplified to return the actual address, except that
889 * it has a different format in AF_INET and AF_INET6.)
891 static struct ifaddr *
892 carp_best_ifa(int af, struct ifnet *ifp)
894 struct ifaddr *ifa, *best;
901 CK_STAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
902 if (ifa->ifa_addr->sa_family == af &&
903 (best == NULL || ifa_preferred(best, ifa)))
912 carp_send_ad_locked(struct carp_softc *sc)
914 struct carp_header ch;
917 struct carp_header *ch_ptr;
922 CARP_LOCK_ASSERT(sc);
924 advskew = DEMOTE_ADVSKEW(sc);
925 tv.tv_sec = sc->sc_advbase;
926 tv.tv_usec = advskew * 1000000 / 256;
928 ch.carp_version = CARP_VERSION;
929 ch.carp_type = CARP_ADVERTISEMENT;
930 ch.carp_vhid = sc->sc_vhid;
931 ch.carp_advbase = sc->sc_advbase;
932 ch.carp_advskew = advskew;
933 ch.carp_authlen = 7; /* XXX DEFINE */
934 ch.carp_pad1 = 0; /* must be zero */
937 /* XXXGL: OpenBSD picks first ifaddr with needed family. */
943 m = m_gethdr(M_NOWAIT, MT_DATA);
945 CARPSTATS_INC(carps_onomem);
948 len = sizeof(*ip) + sizeof(ch);
949 m->m_pkthdr.len = len;
950 m->m_pkthdr.rcvif = NULL;
952 M_ALIGN(m, m->m_len);
953 m->m_flags |= M_MCAST;
954 ip = mtod(m, struct ip *);
955 ip->ip_v = IPVERSION;
956 ip->ip_hl = sizeof(*ip) >> 2;
957 ip->ip_tos = V_carp_dscp << IPTOS_DSCP_OFFSET;
958 ip->ip_len = htons(len);
959 ip->ip_off = htons(IP_DF);
960 ip->ip_ttl = CARP_DFLTTL;
961 ip->ip_p = IPPROTO_CARP;
965 ifa = carp_best_ifa(AF_INET, sc->sc_carpdev);
968 ifatoia(ifa)->ia_addr.sin_addr.s_addr;
971 ip->ip_src.s_addr = 0;
972 ip->ip_dst.s_addr = htonl(INADDR_CARP_GROUP);
974 ch_ptr = (struct carp_header *)(&ip[1]);
975 bcopy(&ch, ch_ptr, sizeof(ch));
976 if (carp_prepare_ad(m, sc, ch_ptr))
979 m->m_data += sizeof(*ip);
980 ch_ptr->carp_cksum = in_cksum(m, len - sizeof(*ip));
981 m->m_data -= sizeof(*ip);
983 CARPSTATS_INC(carps_opackets);
985 carp_send_ad_error(sc, ip_output(m, NULL, NULL, IP_RAWOUTPUT,
986 &sc->sc_carpdev->if_carp->cif_imo, NULL));
990 if (sc->sc_naddrs6) {
993 m = m_gethdr(M_NOWAIT, MT_DATA);
995 CARPSTATS_INC(carps_onomem);
998 len = sizeof(*ip6) + sizeof(ch);
999 m->m_pkthdr.len = len;
1000 m->m_pkthdr.rcvif = NULL;
1002 M_ALIGN(m, m->m_len);
1003 m->m_flags |= M_MCAST;
1004 ip6 = mtod(m, struct ip6_hdr *);
1005 bzero(ip6, sizeof(*ip6));
1006 ip6->ip6_vfc |= IPV6_VERSION;
1007 /* Traffic class isn't defined in ip6 struct instead
1008 * it gets offset into flowid field */
1009 ip6->ip6_flow |= htonl(V_carp_dscp << (IPV6_FLOWLABEL_LEN +
1010 IPTOS_DSCP_OFFSET));
1011 ip6->ip6_hlim = CARP_DFLTTL;
1012 ip6->ip6_nxt = IPPROTO_CARP;
1014 /* set the source address */
1015 ifa = carp_best_ifa(AF_INET6, sc->sc_carpdev);
1017 bcopy(IFA_IN6(ifa), &ip6->ip6_src,
1018 sizeof(struct in6_addr));
1021 /* This should never happen with IPv6. */
1022 bzero(&ip6->ip6_src, sizeof(struct in6_addr));
1024 /* Set the multicast destination. */
1025 ip6->ip6_dst.s6_addr16[0] = htons(0xff02);
1026 ip6->ip6_dst.s6_addr8[15] = 0x12;
1027 if (in6_setscope(&ip6->ip6_dst, sc->sc_carpdev, NULL) != 0) {
1029 CARP_DEBUG("%s: in6_setscope failed\n", __func__);
1033 ch_ptr = (struct carp_header *)(&ip6[1]);
1034 bcopy(&ch, ch_ptr, sizeof(ch));
1035 if (carp_prepare_ad(m, sc, ch_ptr))
1038 m->m_data += sizeof(*ip6);
1039 ch_ptr->carp_cksum = in_cksum(m, len - sizeof(*ip6));
1040 m->m_data -= sizeof(*ip6);
1042 CARPSTATS_INC(carps_opackets6);
1044 carp_send_ad_error(sc, ip6_output(m, NULL, NULL, 0,
1045 &sc->sc_carpdev->if_carp->cif_im6o, NULL, NULL));
1050 callout_reset(&sc->sc_ad_tmo, tvtohz(&tv), carp_send_ad, sc);
1054 carp_addroute(struct carp_softc *sc)
1058 CARP_FOREACH_IFA(sc, ifa)
1059 carp_ifa_addroute(ifa);
1063 carp_ifa_addroute(struct ifaddr *ifa)
1066 switch (ifa->ifa_addr->sa_family) {
1069 in_addprefix(ifatoia(ifa), RTF_UP);
1070 ifa_add_loopback_route(ifa,
1071 (struct sockaddr *)&ifatoia(ifa)->ia_addr);
1076 ifa_add_loopback_route(ifa,
1077 (struct sockaddr *)&ifatoia6(ifa)->ia_addr);
1078 nd6_add_ifa_lle(ifatoia6(ifa));
1085 carp_delroute(struct carp_softc *sc)
1089 CARP_FOREACH_IFA(sc, ifa)
1090 carp_ifa_delroute(ifa);
1094 carp_ifa_delroute(struct ifaddr *ifa)
1097 switch (ifa->ifa_addr->sa_family) {
1100 ifa_del_loopback_route(ifa,
1101 (struct sockaddr *)&ifatoia(ifa)->ia_addr);
1102 in_scrubprefix(ifatoia(ifa), LLE_STATIC);
1107 ifa_del_loopback_route(ifa,
1108 (struct sockaddr *)&ifatoia6(ifa)->ia_addr);
1109 nd6_rem_ifa_lle(ifatoia6(ifa), 1);
1116 carp_master(struct ifaddr *ifa)
1118 struct carp_softc *sc = ifa->ifa_carp;
1120 return (sc->sc_state == MASTER);
1125 * Broadcast a gratuitous ARP request containing
1126 * the virtual router MAC address for each IP address
1127 * associated with the virtual router.
1130 carp_send_arp(struct carp_softc *sc)
1133 struct in_addr addr;
1137 CARP_FOREACH_IFA(sc, ifa) {
1138 if (ifa->ifa_addr->sa_family != AF_INET)
1140 addr = ((struct sockaddr_in *)ifa->ifa_addr)->sin_addr;
1141 arp_announce_ifaddr(sc->sc_carpdev, addr, LLADDR(&sc->sc_addr));
1146 carp_iamatch(struct ifaddr *ifa, uint8_t **enaddr)
1148 struct carp_softc *sc = ifa->ifa_carp;
1150 if (sc->sc_state == MASTER) {
1151 *enaddr = LLADDR(&sc->sc_addr);
1161 carp_send_na(struct carp_softc *sc)
1163 static struct in6_addr mcast = IN6ADDR_LINKLOCAL_ALLNODES_INIT;
1165 struct in6_addr *in6;
1167 CARP_FOREACH_IFA(sc, ifa) {
1168 if (ifa->ifa_addr->sa_family != AF_INET6)
1172 nd6_na_output(sc->sc_carpdev, &mcast, in6,
1173 ND_NA_FLAG_OVERRIDE, 1, NULL);
1174 DELAY(1000); /* XXX */
1179 * Returns ifa in case it's a carp address and it is MASTER, or if the address
1180 * matches and is not a carp address. Returns NULL otherwise.
1183 carp_iamatch6(struct ifnet *ifp, struct in6_addr *taddr)
1190 CK_STAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
1191 if (ifa->ifa_addr->sa_family != AF_INET6)
1193 if (!IN6_ARE_ADDR_EQUAL(taddr, IFA_IN6(ifa)))
1195 if (ifa->ifa_carp && ifa->ifa_carp->sc_state != MASTER)
1206 carp_macmatch6(struct ifnet *ifp, struct mbuf *m, const struct in6_addr *taddr)
1212 IFNET_FOREACH_IFA(ifp, ifa)
1213 if (ifa->ifa_addr->sa_family == AF_INET6 &&
1214 IN6_ARE_ADDR_EQUAL(taddr, IFA_IN6(ifa))) {
1215 struct carp_softc *sc = ifa->ifa_carp;
1218 mtag = m_tag_get(PACKET_TAG_CARP,
1219 sizeof(struct carp_softc *), M_NOWAIT);
1221 /* Better a bit than nothing. */
1222 return (LLADDR(&sc->sc_addr));
1224 bcopy(&sc, mtag + 1, sizeof(sc));
1225 m_tag_prepend(m, mtag);
1227 return (LLADDR(&sc->sc_addr));
1235 carp_forus(struct ifnet *ifp, u_char *dhost)
1237 struct carp_softc *sc;
1238 uint8_t *ena = dhost;
1240 if (ena[0] || ena[1] || ena[2] != 0x5e || ena[3] || ena[4] != 1)
1243 CIF_LOCK(ifp->if_carp);
1244 IFNET_FOREACH_CARP(ifp, sc) {
1246 * CARP_LOCK() is not here, since would protect nothing, but
1247 * cause deadlock with if_bridge, calling this under its lock.
1249 if (sc->sc_state == MASTER && !bcmp(dhost, LLADDR(&sc->sc_addr),
1251 CIF_UNLOCK(ifp->if_carp);
1255 CIF_UNLOCK(ifp->if_carp);
1260 /* Master down timeout event, executed in callout context. */
1262 carp_master_down(void *v)
1264 struct carp_softc *sc = v;
1265 struct epoch_tracker et;
1267 NET_EPOCH_ENTER(et);
1268 CARP_LOCK_ASSERT(sc);
1270 CURVNET_SET(sc->sc_carpdev->if_vnet);
1271 if (sc->sc_state == BACKUP) {
1272 carp_master_down_locked(sc, "master timed out");
1281 carp_master_down_locked(struct carp_softc *sc, const char *reason)
1285 CARP_LOCK_ASSERT(sc);
1287 switch (sc->sc_state) {
1289 carp_set_state(sc, MASTER, reason);
1290 carp_send_ad_locked(sc);
1303 panic("carp: VHID %u@%s: master_down event in %s state\n",
1305 sc->sc_carpdev->if_xname,
1306 sc->sc_state ? "MASTER" : "INIT");
1313 * When in backup state, af indicates whether to reset the master down timer
1314 * for v4 or v6. If it's set to zero, reset the ones which are already pending.
1317 carp_setrun(struct carp_softc *sc, sa_family_t af)
1321 CARP_LOCK_ASSERT(sc);
1323 if ((sc->sc_carpdev->if_flags & IFF_UP) == 0 ||
1324 sc->sc_carpdev->if_link_state != LINK_STATE_UP ||
1325 (sc->sc_naddrs == 0 && sc->sc_naddrs6 == 0) ||
1329 switch (sc->sc_state) {
1331 carp_set_state(sc, BACKUP, "initialization complete");
1335 callout_stop(&sc->sc_ad_tmo);
1336 tv.tv_sec = 3 * sc->sc_advbase;
1337 tv.tv_usec = sc->sc_advskew * 1000000 / 256;
1341 callout_reset(&sc->sc_md_tmo, tvtohz(&tv),
1342 carp_master_down, sc);
1347 callout_reset(&sc->sc_md6_tmo, tvtohz(&tv),
1348 carp_master_down, sc);
1354 callout_reset(&sc->sc_md_tmo, tvtohz(&tv),
1355 carp_master_down, sc);
1359 callout_reset(&sc->sc_md6_tmo, tvtohz(&tv),
1360 carp_master_down, sc);
1366 tv.tv_sec = sc->sc_advbase;
1367 tv.tv_usec = sc->sc_advskew * 1000000 / 256;
1368 callout_reset(&sc->sc_ad_tmo, tvtohz(&tv),
1375 * Setup multicast structures.
1378 carp_multicast_setup(struct carp_if *cif, sa_family_t sa)
1380 struct ifnet *ifp = cif->cif_ifp;
1387 struct ip_moptions *imo = &cif->cif_imo;
1388 struct in_mfilter *imf;
1389 struct in_addr addr;
1391 if (ip_mfilter_first(&imo->imo_head) != NULL)
1394 imf = ip_mfilter_alloc(M_WAITOK, 0, 0);
1395 ip_mfilter_init(&imo->imo_head);
1396 imo->imo_multicast_vif = -1;
1398 addr.s_addr = htonl(INADDR_CARP_GROUP);
1399 if ((error = in_joingroup(ifp, &addr, NULL,
1400 &imf->imf_inm)) != 0) {
1401 ip_mfilter_free(imf);
1405 ip_mfilter_insert(&imo->imo_head, imf);
1406 imo->imo_multicast_ifp = ifp;
1407 imo->imo_multicast_ttl = CARP_DFLTTL;
1408 imo->imo_multicast_loop = 0;
1415 struct ip6_moptions *im6o = &cif->cif_im6o;
1416 struct in6_mfilter *im6f[2];
1417 struct in6_addr in6;
1419 if (ip6_mfilter_first(&im6o->im6o_head))
1422 im6f[0] = ip6_mfilter_alloc(M_WAITOK, 0, 0);
1423 im6f[1] = ip6_mfilter_alloc(M_WAITOK, 0, 0);
1425 ip6_mfilter_init(&im6o->im6o_head);
1426 im6o->im6o_multicast_hlim = CARP_DFLTTL;
1427 im6o->im6o_multicast_ifp = ifp;
1429 /* Join IPv6 CARP multicast group. */
1430 bzero(&in6, sizeof(in6));
1431 in6.s6_addr16[0] = htons(0xff02);
1432 in6.s6_addr8[15] = 0x12;
1433 if ((error = in6_setscope(&in6, ifp, NULL)) != 0) {
1434 ip6_mfilter_free(im6f[0]);
1435 ip6_mfilter_free(im6f[1]);
1438 if ((error = in6_joingroup(ifp, &in6, NULL, &im6f[0]->im6f_in6m, 0)) != 0) {
1439 ip6_mfilter_free(im6f[0]);
1440 ip6_mfilter_free(im6f[1]);
1444 /* Join solicited multicast address. */
1445 bzero(&in6, sizeof(in6));
1446 in6.s6_addr16[0] = htons(0xff02);
1447 in6.s6_addr32[1] = 0;
1448 in6.s6_addr32[2] = htonl(1);
1449 in6.s6_addr32[3] = 0;
1450 in6.s6_addr8[12] = 0xff;
1452 if ((error = in6_setscope(&in6, ifp, NULL)) != 0) {
1453 ip6_mfilter_free(im6f[0]);
1454 ip6_mfilter_free(im6f[1]);
1458 if ((error = in6_joingroup(ifp, &in6, NULL, &im6f[1]->im6f_in6m, 0)) != 0) {
1459 in6_leavegroup(im6f[0]->im6f_in6m, NULL);
1460 ip6_mfilter_free(im6f[0]);
1461 ip6_mfilter_free(im6f[1]);
1464 ip6_mfilter_insert(&im6o->im6o_head, im6f[0]);
1465 ip6_mfilter_insert(&im6o->im6o_head, im6f[1]);
1475 * Free multicast structures.
1478 carp_multicast_cleanup(struct carp_if *cif, sa_family_t sa)
1481 struct ip_moptions *imo = &cif->cif_imo;
1482 struct in_mfilter *imf;
1485 struct ip6_moptions *im6o = &cif->cif_im6o;
1486 struct in6_mfilter *im6f;
1488 sx_assert(&carp_sx, SA_XLOCKED);
1493 if (cif->cif_naddrs != 0)
1496 while ((imf = ip_mfilter_first(&imo->imo_head)) != NULL) {
1497 ip_mfilter_remove(&imo->imo_head, imf);
1498 in_leavegroup(imf->imf_inm, NULL);
1499 ip_mfilter_free(imf);
1505 if (cif->cif_naddrs6 != 0)
1508 while ((im6f = ip6_mfilter_first(&im6o->im6o_head)) != NULL) {
1509 ip6_mfilter_remove(&im6o->im6o_head, im6f);
1510 in6_leavegroup(im6f->im6f_in6m, NULL);
1511 ip6_mfilter_free(im6f);
1519 carp_output(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *sa)
1522 struct carp_softc *sc;
1527 switch (sa->sa_family) {
1540 mtag = m_tag_find(m, PACKET_TAG_CARP, NULL);
1544 bcopy(mtag + 1, &sc, sizeof(sc));
1546 /* Set the source MAC address to the Virtual Router MAC Address. */
1547 switch (ifp->if_type) {
1551 struct ether_header *eh;
1553 eh = mtod(m, struct ether_header *);
1554 eh->ether_shost[0] = 0;
1555 eh->ether_shost[1] = 0;
1556 eh->ether_shost[2] = 0x5e;
1557 eh->ether_shost[3] = 0;
1558 eh->ether_shost[4] = 1;
1559 eh->ether_shost[5] = sc->sc_vhid;
1563 printf("%s: carp is not supported for the %d interface type\n",
1564 ifp->if_xname, ifp->if_type);
1565 return (EOPNOTSUPP);
1571 static struct carp_softc*
1572 carp_alloc(struct ifnet *ifp)
1574 struct carp_softc *sc;
1575 struct carp_if *cif;
1577 sx_assert(&carp_sx, SA_XLOCKED);
1579 if ((cif = ifp->if_carp) == NULL)
1580 cif = carp_alloc_if(ifp);
1582 sc = malloc(sizeof(*sc), M_CARP, M_WAITOK|M_ZERO);
1584 sc->sc_advbase = CARP_DFLTINTV;
1585 sc->sc_vhid = -1; /* required setting */
1586 sc->sc_init_counter = 1;
1587 sc->sc_state = INIT;
1589 sc->sc_ifasiz = sizeof(struct ifaddr *);
1590 sc->sc_ifas = malloc(sc->sc_ifasiz, M_CARP, M_WAITOK|M_ZERO);
1591 sc->sc_carpdev = ifp;
1595 callout_init_mtx(&sc->sc_md_tmo, &sc->sc_mtx, CALLOUT_RETURNUNLOCKED);
1598 callout_init_mtx(&sc->sc_md6_tmo, &sc->sc_mtx, CALLOUT_RETURNUNLOCKED);
1600 callout_init_mtx(&sc->sc_ad_tmo, &sc->sc_mtx, CALLOUT_RETURNUNLOCKED);
1603 TAILQ_INSERT_TAIL(&cif->cif_vrs, sc, sc_list);
1606 mtx_lock(&carp_mtx);
1607 LIST_INSERT_HEAD(&carp_list, sc, sc_next);
1608 mtx_unlock(&carp_mtx);
1614 carp_grow_ifas(struct carp_softc *sc)
1616 struct ifaddr **new;
1618 new = malloc(sc->sc_ifasiz * 2, M_CARP, M_WAITOK | M_ZERO);
1620 bcopy(sc->sc_ifas, new, sc->sc_ifasiz);
1621 free(sc->sc_ifas, M_CARP);
1628 carp_destroy(struct carp_softc *sc)
1630 struct ifnet *ifp = sc->sc_carpdev;
1631 struct carp_if *cif = ifp->if_carp;
1633 sx_assert(&carp_sx, SA_XLOCKED);
1635 if (sc->sc_suppress)
1636 carp_demote_adj(-V_carp_ifdown_adj, "vhid removed");
1640 TAILQ_REMOVE(&cif->cif_vrs, sc, sc_list);
1643 mtx_lock(&carp_mtx);
1644 LIST_REMOVE(sc, sc_next);
1645 mtx_unlock(&carp_mtx);
1647 callout_drain(&sc->sc_ad_tmo);
1649 callout_drain(&sc->sc_md_tmo);
1652 callout_drain(&sc->sc_md6_tmo);
1654 CARP_LOCK_DESTROY(sc);
1656 free(sc->sc_ifas, M_CARP);
1660 static struct carp_if*
1661 carp_alloc_if(struct ifnet *ifp)
1663 struct carp_if *cif;
1666 cif = malloc(sizeof(*cif), M_CARP, M_WAITOK|M_ZERO);
1668 if ((error = ifpromisc(ifp, 1)) != 0)
1669 printf("%s: ifpromisc(%s) failed: %d\n",
1670 __func__, ifp->if_xname, error);
1672 cif->cif_flags |= CIF_PROMISC;
1676 TAILQ_INIT(&cif->cif_vrs);
1681 IF_ADDR_WUNLOCK(ifp);
1687 carp_free_if(struct carp_if *cif)
1689 struct ifnet *ifp = cif->cif_ifp;
1691 CIF_LOCK_ASSERT(cif);
1692 KASSERT(TAILQ_EMPTY(&cif->cif_vrs), ("%s: softc list not empty",
1696 ifp->if_carp = NULL;
1697 IF_ADDR_WUNLOCK(ifp);
1699 CIF_LOCK_DESTROY(cif);
1701 if (cif->cif_flags & CIF_PROMISC)
1709 carp_carprcp(struct carpreq *carpr, struct carp_softc *sc, int priv)
1713 carpr->carpr_state = sc->sc_state;
1714 carpr->carpr_vhid = sc->sc_vhid;
1715 carpr->carpr_advbase = sc->sc_advbase;
1716 carpr->carpr_advskew = sc->sc_advskew;
1718 bcopy(sc->sc_key, carpr->carpr_key, sizeof(carpr->carpr_key));
1720 bzero(carpr->carpr_key, sizeof(carpr->carpr_key));
1725 carp_ioctl(struct ifreq *ifr, u_long cmd, struct thread *td)
1727 struct carpreq carpr;
1729 struct carp_softc *sc = NULL;
1730 int error = 0, locked = 0;
1732 if ((error = copyin(ifr_data_get_ptr(ifr), &carpr, sizeof carpr)))
1735 ifp = ifunit_ref(ifr->ifr_name);
1739 switch (ifp->if_type) {
1749 if ((ifp->if_flags & IFF_MULTICAST) == 0) {
1750 error = EADDRNOTAVAIL;
1757 if ((error = priv_check(td, PRIV_NETINET_CARP)))
1759 if (carpr.carpr_vhid <= 0 || carpr.carpr_vhid > CARP_MAXVHID ||
1760 carpr.carpr_advbase < 0 || carpr.carpr_advskew < 0) {
1766 IFNET_FOREACH_CARP(ifp, sc)
1767 if (sc->sc_vhid == carpr.carpr_vhid)
1771 sc = carp_alloc(ifp);
1773 sc->sc_vhid = carpr.carpr_vhid;
1774 LLADDR(&sc->sc_addr)[0] = 0;
1775 LLADDR(&sc->sc_addr)[1] = 0;
1776 LLADDR(&sc->sc_addr)[2] = 0x5e;
1777 LLADDR(&sc->sc_addr)[3] = 0;
1778 LLADDR(&sc->sc_addr)[4] = 1;
1779 LLADDR(&sc->sc_addr)[5] = sc->sc_vhid;
1783 if (carpr.carpr_advbase > 0) {
1784 if (carpr.carpr_advbase > 255 ||
1785 carpr.carpr_advbase < CARP_DFLTINTV) {
1789 sc->sc_advbase = carpr.carpr_advbase;
1791 if (carpr.carpr_advskew >= 255) {
1795 sc->sc_advskew = carpr.carpr_advskew;
1796 if (carpr.carpr_key[0] != '\0') {
1797 bcopy(carpr.carpr_key, sc->sc_key, sizeof(sc->sc_key));
1798 carp_hmac_prepare(sc);
1800 if (sc->sc_state != INIT &&
1801 carpr.carpr_state != sc->sc_state) {
1802 switch (carpr.carpr_state) {
1804 callout_stop(&sc->sc_ad_tmo);
1805 carp_set_state(sc, BACKUP,
1806 "user requested via ifconfig");
1811 carp_master_down_locked(sc,
1812 "user requested via ifconfig");
1824 if (carpr.carpr_vhid < 0 || carpr.carpr_vhid > CARP_MAXVHID) {
1828 if (carpr.carpr_count < 1) {
1832 if (ifp->if_carp == NULL) {
1837 priveleged = (priv_check(td, PRIV_NETINET_CARP) == 0);
1838 if (carpr.carpr_vhid != 0) {
1839 IFNET_FOREACH_CARP(ifp, sc)
1840 if (sc->sc_vhid == carpr.carpr_vhid)
1846 carp_carprcp(&carpr, sc, priveleged);
1847 error = copyout(&carpr, ifr_data_get_ptr(ifr),
1853 IFNET_FOREACH_CARP(ifp, sc)
1856 if (count > carpr.carpr_count) {
1857 CIF_UNLOCK(ifp->if_carp);
1863 IFNET_FOREACH_CARP(ifp, sc) {
1864 carp_carprcp(&carpr, sc, priveleged);
1865 carpr.carpr_count = count;
1866 error = copyout(&carpr,
1867 (char *)ifr_data_get_ptr(ifr) +
1868 (i * sizeof(carpr)), sizeof(carpr));
1870 CIF_UNLOCK(ifp->if_carp);
1881 sx_xunlock(&carp_sx);
1892 carp_get_vhid(struct ifaddr *ifa)
1895 if (ifa == NULL || ifa->ifa_carp == NULL)
1898 return (ifa->ifa_carp->sc_vhid);
1902 carp_attach(struct ifaddr *ifa, int vhid)
1904 struct ifnet *ifp = ifa->ifa_ifp;
1905 struct carp_if *cif = ifp->if_carp;
1906 struct carp_softc *sc;
1909 KASSERT(ifa->ifa_carp == NULL, ("%s: ifa %p attached", __func__, ifa));
1911 switch (ifa->ifa_addr->sa_family) {
1920 return (EPROTOTYPE);
1924 if (ifp->if_carp == NULL) {
1925 sx_xunlock(&carp_sx);
1926 return (ENOPROTOOPT);
1929 IFNET_FOREACH_CARP(ifp, sc)
1930 if (sc->sc_vhid == vhid)
1933 sx_xunlock(&carp_sx);
1937 error = carp_multicast_setup(cif, ifa->ifa_addr->sa_family);
1940 sx_xunlock(&carp_sx);
1944 index = sc->sc_naddrs + sc->sc_naddrs6 + 1;
1945 if (index > sc->sc_ifasiz / sizeof(struct ifaddr *))
1948 switch (ifa->ifa_addr->sa_family) {
1966 sc->sc_ifas[index - 1] = ifa;
1968 carp_hmac_prepare(sc);
1972 sx_xunlock(&carp_sx);
1978 carp_detach(struct ifaddr *ifa, bool keep_cif)
1980 struct ifnet *ifp = ifa->ifa_ifp;
1981 struct carp_if *cif = ifp->if_carp;
1982 struct carp_softc *sc = ifa->ifa_carp;
1985 KASSERT(sc != NULL, ("%s: %p not attached", __func__, ifa));
1991 index = sc->sc_naddrs + sc->sc_naddrs6;
1992 for (i = 0; i < index; i++)
1993 if (sc->sc_ifas[i] == ifa)
1995 KASSERT(i < index, ("%s: %p no backref", __func__, ifa));
1996 for (; i < index - 1; i++)
1997 sc->sc_ifas[i] = sc->sc_ifas[i+1];
1998 sc->sc_ifas[index - 1] = NULL;
2000 switch (ifa->ifa_addr->sa_family) {
2015 carp_ifa_delroute(ifa);
2016 carp_multicast_cleanup(cif, ifa->ifa_addr->sa_family);
2018 ifa->ifa_carp = NULL;
2021 carp_hmac_prepare(sc);
2024 if (!keep_cif && sc->sc_naddrs == 0 && sc->sc_naddrs6 == 0)
2032 sx_xunlock(&carp_sx);
2036 carp_set_state(struct carp_softc *sc, int state, const char *reason)
2039 CARP_LOCK_ASSERT(sc);
2041 if (sc->sc_state != state) {
2042 const char *carp_states[] = { CARP_STATES };
2043 char subsys[IFNAMSIZ+5];
2045 snprintf(subsys, IFNAMSIZ+5, "%u@%s", sc->sc_vhid,
2046 sc->sc_carpdev->if_xname);
2048 CARP_LOG("%s: %s -> %s (%s)\n", subsys,
2049 carp_states[sc->sc_state], carp_states[state], reason);
2051 sc->sc_state = state;
2053 devctl_notify("CARP", subsys, carp_states[state], NULL);
2058 carp_linkstate(struct ifnet *ifp)
2060 struct carp_softc *sc;
2062 CIF_LOCK(ifp->if_carp);
2063 IFNET_FOREACH_CARP(ifp, sc) {
2068 CIF_UNLOCK(ifp->if_carp);
2072 carp_sc_state(struct carp_softc *sc)
2075 CARP_LOCK_ASSERT(sc);
2077 if (sc->sc_carpdev->if_link_state != LINK_STATE_UP ||
2078 !(sc->sc_carpdev->if_flags & IFF_UP) ||
2080 callout_stop(&sc->sc_ad_tmo);
2082 callout_stop(&sc->sc_md_tmo);
2085 callout_stop(&sc->sc_md6_tmo);
2087 carp_set_state(sc, INIT, "hardware interface down");
2089 if (!sc->sc_suppress)
2090 carp_demote_adj(V_carp_ifdown_adj, "interface down");
2091 sc->sc_suppress = 1;
2093 carp_set_state(sc, INIT, "hardware interface up");
2095 if (sc->sc_suppress)
2096 carp_demote_adj(-V_carp_ifdown_adj, "interface up");
2097 sc->sc_suppress = 0;
2102 carp_demote_adj(int adj, char *reason)
2104 atomic_add_int(&V_carp_demotion, adj);
2105 CARP_LOG("demoted by %d to %d (%s)\n", adj, V_carp_demotion, reason);
2106 taskqueue_enqueue(taskqueue_swi, &carp_sendall_task);
2110 carp_allow_sysctl(SYSCTL_HANDLER_ARGS)
2113 struct carp_softc *sc;
2116 error = sysctl_handle_int(oidp, &new, 0, req);
2117 if (error || !req->newptr)
2120 if (V_carp_allow != new) {
2123 mtx_lock(&carp_mtx);
2124 LIST_FOREACH(sc, &carp_list, sc_next) {
2126 if (curvnet == sc->sc_carpdev->if_vnet)
2130 mtx_unlock(&carp_mtx);
2137 carp_dscp_sysctl(SYSCTL_HANDLER_ARGS)
2142 error = sysctl_handle_int(oidp, &new, 0, req);
2143 if (error || !req->newptr)
2146 if (new < 0 || new > 63)
2155 carp_demote_adj_sysctl(SYSCTL_HANDLER_ARGS)
2159 new = V_carp_demotion;
2160 error = sysctl_handle_int(oidp, &new, 0, req);
2161 if (error || !req->newptr)
2164 carp_demote_adj(new, "sysctl");
2170 extern struct domain inetdomain;
2171 static struct protosw in_carp_protosw = {
2172 .pr_type = SOCK_RAW,
2173 .pr_domain = &inetdomain,
2174 .pr_protocol = IPPROTO_CARP,
2175 .pr_flags = PR_ATOMIC|PR_ADDR,
2176 .pr_input = carp_input,
2177 .pr_output = rip_output,
2178 .pr_ctloutput = rip_ctloutput,
2179 .pr_usrreqs = &rip_usrreqs
2184 extern struct domain inet6domain;
2185 static struct protosw in6_carp_protosw = {
2186 .pr_type = SOCK_RAW,
2187 .pr_domain = &inet6domain,
2188 .pr_protocol = IPPROTO_CARP,
2189 .pr_flags = PR_ATOMIC|PR_ADDR,
2190 .pr_input = carp6_input,
2191 .pr_output = rip6_output,
2192 .pr_ctloutput = rip6_ctloutput,
2193 .pr_usrreqs = &rip6_usrreqs
2198 carp_mod_cleanup(void)
2202 if (proto_reg[CARP_INET] == 0) {
2203 (void)ipproto_unregister(IPPROTO_CARP);
2204 pf_proto_unregister(PF_INET, IPPROTO_CARP, SOCK_RAW);
2205 proto_reg[CARP_INET] = -1;
2207 carp_iamatch_p = NULL;
2210 if (proto_reg[CARP_INET6] == 0) {
2211 (void)ip6proto_unregister(IPPROTO_CARP);
2212 pf_proto_unregister(PF_INET6, IPPROTO_CARP, SOCK_RAW);
2213 proto_reg[CARP_INET6] = -1;
2215 carp_iamatch6_p = NULL;
2216 carp_macmatch6_p = NULL;
2218 carp_ioctl_p = NULL;
2219 carp_attach_p = NULL;
2220 carp_detach_p = NULL;
2221 carp_get_vhid_p = NULL;
2222 carp_linkstate_p = NULL;
2223 carp_forus_p = NULL;
2224 carp_output_p = NULL;
2225 carp_demote_adj_p = NULL;
2226 carp_master_p = NULL;
2227 mtx_unlock(&carp_mtx);
2228 taskqueue_drain(taskqueue_swi, &carp_sendall_task);
2229 mtx_destroy(&carp_mtx);
2230 sx_destroy(&carp_sx);
2238 mtx_init(&carp_mtx, "carp_mtx", NULL, MTX_DEF);
2239 sx_init(&carp_sx, "carp_sx");
2240 LIST_INIT(&carp_list);
2241 carp_get_vhid_p = carp_get_vhid;
2242 carp_forus_p = carp_forus;
2243 carp_output_p = carp_output;
2244 carp_linkstate_p = carp_linkstate;
2245 carp_ioctl_p = carp_ioctl;
2246 carp_attach_p = carp_attach;
2247 carp_detach_p = carp_detach;
2248 carp_demote_adj_p = carp_demote_adj;
2249 carp_master_p = carp_master;
2251 carp_iamatch6_p = carp_iamatch6;
2252 carp_macmatch6_p = carp_macmatch6;
2253 proto_reg[CARP_INET6] = pf_proto_register(PF_INET6,
2254 (struct protosw *)&in6_carp_protosw);
2255 if (proto_reg[CARP_INET6]) {
2256 printf("carp: error %d attaching to PF_INET6\n",
2257 proto_reg[CARP_INET6]);
2259 return (proto_reg[CARP_INET6]);
2261 err = ip6proto_register(IPPROTO_CARP);
2263 printf("carp: error %d registering with INET6\n", err);
2269 carp_iamatch_p = carp_iamatch;
2270 proto_reg[CARP_INET] = pf_proto_register(PF_INET, &in_carp_protosw);
2271 if (proto_reg[CARP_INET]) {
2272 printf("carp: error %d attaching to PF_INET\n",
2273 proto_reg[CARP_INET]);
2275 return (proto_reg[CARP_INET]);
2277 err = ipproto_register(IPPROTO_CARP);
2279 printf("carp: error %d registering with INET\n", err);
2288 carp_modevent(module_t mod, int type, void *data)
2292 return carp_mod_load();
2295 mtx_lock(&carp_mtx);
2296 if (LIST_EMPTY(&carp_list))
2299 mtx_unlock(&carp_mtx);
2311 static moduledata_t carp_mod = {
2317 DECLARE_MODULE(carp, carp_mod, SI_SUB_PROTO_DOMAIN, SI_ORDER_ANY);