2 * Copyright (C) 2000 WIDE Project.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the project nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $KAME: scope6.c,v 1.10 2000/07/24 13:29:31 itojun Exp $
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/malloc.h>
38 #include <sys/socket.h>
39 #include <sys/sockio.h>
40 #include <sys/systm.h>
41 #include <sys/queue.h>
42 #include <sys/sysctl.h>
43 #include <sys/syslog.h>
48 #include <netinet/in.h>
50 #include <netinet/ip6.h>
51 #include <netinet6/in6_var.h>
52 #include <netinet6/ip6_var.h>
53 #include <netinet6/scope6_var.h>
55 #ifdef ENABLE_DEFAULT_SCOPE
56 VNET_DEFINE(int, ip6_use_defzone) = 1;
58 VNET_DEFINE(int, ip6_use_defzone) = 0;
60 VNET_DEFINE(int, deembed_scopeid) = 1;
61 SYSCTL_DECL(_net_inet6_ip6);
62 SYSCTL_VNET_INT(_net_inet6_ip6, OID_AUTO, deembed_scopeid, CTLFLAG_RW,
63 &VNET_NAME(deembed_scopeid), 0,
64 "Extract embedded zone ID and set it to sin6_scope_id in sockaddr_in6.");
67 * The scope6_lock protects the global sid default stored in
70 static struct mtx scope6_lock;
71 #define SCOPE6_LOCK_INIT() mtx_init(&scope6_lock, "scope6_lock", NULL, MTX_DEF)
72 #define SCOPE6_LOCK() mtx_lock(&scope6_lock)
73 #define SCOPE6_UNLOCK() mtx_unlock(&scope6_lock)
74 #define SCOPE6_LOCK_ASSERT() mtx_assert(&scope6_lock, MA_OWNED)
76 static VNET_DEFINE(struct scope6_id, sid_default);
77 #define V_sid_default VNET(sid_default)
80 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->scope6_id)
82 static int scope6_get(struct ifnet *, struct scope6_id *);
83 static int scope6_set(struct ifnet *, struct scope6_id *);
89 bzero(&V_sid_default, sizeof(V_sid_default));
91 if (!IS_DEFAULT_VNET(curvnet))
98 scope6_ifattach(struct ifnet *ifp)
100 struct scope6_id *sid;
102 sid = (struct scope6_id *)malloc(sizeof(*sid), M_IFADDR, M_WAITOK);
103 bzero(sid, sizeof(*sid));
106 * XXX: IPV6_ADDR_SCOPE_xxx macros are not standard.
107 * Should we rather hardcode here?
109 sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = ifp->if_index;
110 sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = ifp->if_index;
112 /* by default, we don't care about scope boundary for these scopes. */
113 sid->s6id_list[IPV6_ADDR_SCOPE_SITELOCAL] = 1;
114 sid->s6id_list[IPV6_ADDR_SCOPE_ORGLOCAL] = 1;
121 scope6_ifdetach(struct scope6_id *sid)
128 scope6_ioctl(u_long cmd, caddr_t data, struct ifnet *ifp)
130 struct in6_ifreq *ifr;
132 if (ifp->if_afdata[AF_INET6] == NULL)
133 return (EPFNOSUPPORT);
135 ifr = (struct in6_ifreq *)data;
138 return (scope6_set(ifp,
139 (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
141 return (scope6_get(ifp,
142 (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
144 return (scope6_get_default(
145 (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
152 scope6_set(struct ifnet *ifp, struct scope6_id *idlist)
156 struct scope6_id *sid = NULL;
158 IF_AFDATA_WLOCK(ifp);
161 if (!sid) { /* paranoid? */
162 IF_AFDATA_WUNLOCK(ifp);
167 * XXX: We need more consistency checks of the relationship among
168 * scopes (e.g. an organization should be larger than a site).
172 * TODO(XXX): after setting, we should reflect the changes to
173 * interface addresses, routing table entries, PCB entries...
176 for (i = 0; i < 16; i++) {
177 if (idlist->s6id_list[i] &&
178 idlist->s6id_list[i] != sid->s6id_list[i]) {
180 * An interface zone ID must be the corresponding
181 * interface index by definition.
183 if (i == IPV6_ADDR_SCOPE_INTFACELOCAL &&
184 idlist->s6id_list[i] != ifp->if_index) {
185 IF_AFDATA_WUNLOCK(ifp);
189 if (i == IPV6_ADDR_SCOPE_LINKLOCAL &&
190 idlist->s6id_list[i] > V_if_index) {
192 * XXX: theoretically, there should be no
193 * relationship between link IDs and interface
194 * IDs, but we check the consistency for
195 * safety in later use.
197 IF_AFDATA_WUNLOCK(ifp);
202 * XXX: we must need lots of work in this case,
203 * but we simply set the new value in this initial
206 sid->s6id_list[i] = idlist->s6id_list[i];
209 IF_AFDATA_WUNLOCK(ifp);
215 scope6_get(struct ifnet *ifp, struct scope6_id *idlist)
217 struct scope6_id *sid;
219 /* We only need to lock the interface's afdata for SID() to work. */
220 IF_AFDATA_RLOCK(ifp);
222 if (sid == NULL) { /* paranoid? */
223 IF_AFDATA_RUNLOCK(ifp);
229 IF_AFDATA_RUNLOCK(ifp);
234 * Get a scope of the address. Node-local, link-local, site-local or global.
237 in6_addrscope(struct in6_addr *addr)
241 if (addr->s6_addr[0] == 0xfe) {
242 scope = addr->s6_addr[1] & 0xc0;
246 return IPV6_ADDR_SCOPE_LINKLOCAL;
249 return IPV6_ADDR_SCOPE_SITELOCAL;
252 return IPV6_ADDR_SCOPE_GLOBAL; /* just in case */
258 if (addr->s6_addr[0] == 0xff) {
259 scope = addr->s6_addr[1] & 0x0f;
262 * due to other scope such as reserved,
263 * return scope doesn't work.
266 case IPV6_ADDR_SCOPE_INTFACELOCAL:
267 return IPV6_ADDR_SCOPE_INTFACELOCAL;
269 case IPV6_ADDR_SCOPE_LINKLOCAL:
270 return IPV6_ADDR_SCOPE_LINKLOCAL;
272 case IPV6_ADDR_SCOPE_SITELOCAL:
273 return IPV6_ADDR_SCOPE_SITELOCAL;
276 return IPV6_ADDR_SCOPE_GLOBAL;
282 * Regard loopback and unspecified addresses as global, since
283 * they have no ambiguity.
285 if (bcmp(&in6addr_loopback, addr, sizeof(*addr) - 1) == 0) {
286 if (addr->s6_addr[15] == 1) /* loopback */
287 return IPV6_ADDR_SCOPE_LINKLOCAL;
288 if (addr->s6_addr[15] == 0) /* unspecified */
289 return IPV6_ADDR_SCOPE_GLOBAL; /* XXX: correct? */
292 return IPV6_ADDR_SCOPE_GLOBAL;
296 * ifp - note that this might be NULL
300 scope6_setdefault(struct ifnet *ifp)
304 * Currently, this function just sets the default "interfaces"
305 * and "links" according to the given interface.
306 * We might eventually have to separate the notion of "link" from
307 * "interface" and provide a user interface to set the default.
311 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] =
313 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] =
316 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = 0;
317 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = 0;
323 scope6_get_default(struct scope6_id *idlist)
327 *idlist = V_sid_default;
334 scope6_addr2default(struct in6_addr *addr)
339 * special case: The loopback address should be considered as
340 * link-local, but there's no ambiguity in the syntax.
342 if (IN6_IS_ADDR_LOOPBACK(addr))
346 * XXX: 32-bit read is atomic on all our platforms, is it OK
350 id = V_sid_default.s6id_list[in6_addrscope(addr)];
356 * Validate the specified scope zone ID in the sin6_scope_id field. If the ID
357 * is unspecified (=0), needs to be specified, and the default zone ID can be
358 * used, the default value will be used.
359 * This routine then generates the kernel-internal form: if the address scope
360 * of is interface-local or link-local, embed the interface index in the
364 sa6_embedscope(struct sockaddr_in6 *sin6, int defaultok)
368 if ((zoneid = sin6->sin6_scope_id) == 0 && defaultok)
369 zoneid = scope6_addr2default(&sin6->sin6_addr);
372 (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
373 IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr))) {
375 * At this moment, we only check interface-local and
376 * link-local scope IDs, and use interface indices as the
377 * zone IDs assuming a one-to-one mapping between interfaces
380 if (V_if_index < zoneid || ifnet_byindex(zoneid) == NULL)
383 /* XXX assignment to 16bit from 32bit variable */
384 sin6->sin6_addr.s6_addr16[1] = htons(zoneid & 0xffff);
385 sin6->sin6_scope_id = 0;
392 * generate standard sockaddr_in6 from embedded form.
395 sa6_recoverscope(struct sockaddr_in6 *sin6)
397 char ip6buf[INET6_ADDRSTRLEN];
400 if (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
401 IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr)) {
403 * KAME assumption: link id == interface id
405 zoneid = ntohs(sin6->sin6_addr.s6_addr16[1]);
408 if (V_if_index < zoneid)
411 /* XXX: Disabled due to possible deadlock. */
412 if (!ifnet_byindex(zoneid))
415 if (sin6->sin6_scope_id != 0 &&
416 zoneid != sin6->sin6_scope_id) {
418 "%s: embedded scope mismatch: %s%%%d. "
419 "sin6_scope_id was overridden.", __func__,
420 ip6_sprintf(ip6buf, &sin6->sin6_addr),
421 sin6->sin6_scope_id);
423 sin6->sin6_addr.s6_addr16[1] = 0;
424 sin6->sin6_scope_id = zoneid;
432 * Determine the appropriate scope zone ID for in6 and ifp. If ret_id is
433 * non NULL, it is set to the zone ID. If the zone ID needs to be embedded
434 * in the in6_addr structure, in6 will be modified.
436 * ret_id - unnecessary?
439 in6_setscope(struct in6_addr *in6, struct ifnet *ifp, u_int32_t *ret_id)
442 u_int32_t zoneid = 0;
443 struct scope6_id *sid;
446 * special case: the loopback address can only belong to a loopback
449 if (IN6_IS_ADDR_LOOPBACK(in6)) {
450 if (!(ifp->if_flags & IFF_LOOPBACK))
453 scope = in6_addrscope(in6);
454 if (scope == IPV6_ADDR_SCOPE_INTFACELOCAL ||
455 scope == IPV6_ADDR_SCOPE_LINKLOCAL) {
457 * Currently we use interface indeces as the
458 * zone IDs for interface-local and link-local
461 zoneid = ifp->if_index;
462 in6->s6_addr16[1] = htons(zoneid & 0xffff); /* XXX */
463 } else if (scope != IPV6_ADDR_SCOPE_GLOBAL) {
464 IF_AFDATA_RLOCK(ifp);
466 zoneid = sid->s6id_list[scope];
467 IF_AFDATA_RUNLOCK(ifp);
478 * Just clear the embedded scope identifier. Return 0 if the original address
479 * is intact; return non 0 if the address is modified.
482 in6_clearscope(struct in6_addr *in6)
486 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6)) {
487 if (in6->s6_addr16[1] != 0)
489 in6->s6_addr16[1] = 0;
496 * Return the scope identifier or zero.
499 in6_getscope(struct in6_addr *in6)
502 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6))
503 return (in6->s6_addr16[1]);