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/systm.h>
40 #include <sys/queue.h>
41 #include <sys/syslog.h>
46 #include <netinet/in.h>
48 #include <netinet/ip6.h>
49 #include <netinet6/in6_var.h>
50 #include <netinet6/ip6_var.h>
51 #include <netinet6/scope6_var.h>
55 * The scope6_lock protects the global sid default stored in
58 static struct mtx scope6_lock;
59 #define SCOPE6_LOCK_INIT() mtx_init(&scope6_lock, "scope6_lock", NULL, MTX_DEF)
60 #define SCOPE6_LOCK() mtx_lock(&scope6_lock)
61 #define SCOPE6_UNLOCK() mtx_unlock(&scope6_lock)
62 #define SCOPE6_LOCK_ASSERT() mtx_assert(&scope6_lock, MA_OWNED)
64 static VNET_DEFINE(struct scope6_id, sid_default);
65 VNET_DEFINE(int, ip6_use_defzone);
67 #define V_sid_default VNET(sid_default)
70 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->scope6_id)
76 #ifdef ENABLE_DEFAULT_SCOPE
77 V_ip6_use_defzone = 1;
79 V_ip6_use_defzone = 0;
81 bzero(&V_sid_default, sizeof(V_sid_default));
83 if (!IS_DEFAULT_VNET(curvnet))
90 scope6_ifattach(struct ifnet *ifp)
92 struct scope6_id *sid;
94 sid = (struct scope6_id *)malloc(sizeof(*sid), M_IFADDR, M_WAITOK);
95 bzero(sid, sizeof(*sid));
98 * XXX: IPV6_ADDR_SCOPE_xxx macros are not standard.
99 * Should we rather hardcode here?
101 sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = ifp->if_index;
102 sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = ifp->if_index;
104 /* by default, we don't care about scope boundary for these scopes. */
105 sid->s6id_list[IPV6_ADDR_SCOPE_SITELOCAL] = 1;
106 sid->s6id_list[IPV6_ADDR_SCOPE_ORGLOCAL] = 1;
113 scope6_ifdetach(struct scope6_id *sid)
120 scope6_set(struct ifnet *ifp, struct scope6_id *idlist)
124 struct scope6_id *sid = NULL;
129 if (!sid) { /* paranoid? */
130 IF_AFDATA_UNLOCK(ifp);
135 * XXX: We need more consistency checks of the relationship among
136 * scopes (e.g. an organization should be larger than a site).
140 * TODO(XXX): after setting, we should reflect the changes to
141 * interface addresses, routing table entries, PCB entries...
145 for (i = 0; i < 16; i++) {
146 if (idlist->s6id_list[i] &&
147 idlist->s6id_list[i] != sid->s6id_list[i]) {
149 * An interface zone ID must be the corresponding
150 * interface index by definition.
152 if (i == IPV6_ADDR_SCOPE_INTFACELOCAL &&
153 idlist->s6id_list[i] != ifp->if_index) {
154 IF_AFDATA_UNLOCK(ifp);
159 if (i == IPV6_ADDR_SCOPE_LINKLOCAL &&
160 idlist->s6id_list[i] > V_if_index) {
162 * XXX: theoretically, there should be no
163 * relationship between link IDs and interface
164 * IDs, but we check the consistency for
165 * safety in later use.
167 IF_AFDATA_UNLOCK(ifp);
173 * XXX: we must need lots of work in this case,
174 * but we simply set the new value in this initial
177 sid->s6id_list[i] = idlist->s6id_list[i];
181 IF_AFDATA_UNLOCK(ifp);
187 scope6_get(struct ifnet *ifp, struct scope6_id *idlist)
189 /* We only need to lock the interface's afdata for SID() to work. */
191 struct scope6_id *sid = SID(ifp);
193 if (sid == NULL) { /* paranoid? */
194 IF_AFDATA_UNLOCK(ifp);
202 IF_AFDATA_UNLOCK(ifp);
208 * Get a scope of the address. Node-local, link-local, site-local or global.
211 in6_addrscope(struct in6_addr *addr)
215 if (addr->s6_addr[0] == 0xfe) {
216 scope = addr->s6_addr[1] & 0xc0;
220 return IPV6_ADDR_SCOPE_LINKLOCAL;
223 return IPV6_ADDR_SCOPE_SITELOCAL;
226 return IPV6_ADDR_SCOPE_GLOBAL; /* just in case */
232 if (addr->s6_addr[0] == 0xff) {
233 scope = addr->s6_addr[1] & 0x0f;
236 * due to other scope such as reserved,
237 * return scope doesn't work.
240 case IPV6_ADDR_SCOPE_INTFACELOCAL:
241 return IPV6_ADDR_SCOPE_INTFACELOCAL;
243 case IPV6_ADDR_SCOPE_LINKLOCAL:
244 return IPV6_ADDR_SCOPE_LINKLOCAL;
246 case IPV6_ADDR_SCOPE_SITELOCAL:
247 return IPV6_ADDR_SCOPE_SITELOCAL;
250 return IPV6_ADDR_SCOPE_GLOBAL;
256 * Regard loopback and unspecified addresses as global, since
257 * they have no ambiguity.
259 if (bcmp(&in6addr_loopback, addr, sizeof(*addr) - 1) == 0) {
260 if (addr->s6_addr[15] == 1) /* loopback */
261 return IPV6_ADDR_SCOPE_LINKLOCAL;
262 if (addr->s6_addr[15] == 0) /* unspecified */
263 return IPV6_ADDR_SCOPE_GLOBAL; /* XXX: correct? */
266 return IPV6_ADDR_SCOPE_GLOBAL;
270 * ifp - note that this might be NULL
274 scope6_setdefault(struct ifnet *ifp)
278 * Currently, this function just sets the default "interfaces"
279 * and "links" according to the given interface.
280 * We might eventually have to separate the notion of "link" from
281 * "interface" and provide a user interface to set the default.
285 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] =
287 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] =
290 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = 0;
291 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = 0;
297 scope6_get_default(struct scope6_id *idlist)
301 *idlist = V_sid_default;
308 scope6_addr2default(struct in6_addr *addr)
313 * special case: The loopback address should be considered as
314 * link-local, but there's no ambiguity in the syntax.
316 if (IN6_IS_ADDR_LOOPBACK(addr))
320 * XXX: 32-bit read is atomic on all our platforms, is it OK
324 id = V_sid_default.s6id_list[in6_addrscope(addr)];
330 * Validate the specified scope zone ID in the sin6_scope_id field. If the ID
331 * is unspecified (=0), needs to be specified, and the default zone ID can be
332 * used, the default value will be used.
333 * This routine then generates the kernel-internal form: if the address scope
334 * of is interface-local or link-local, embed the interface index in the
338 sa6_embedscope(struct sockaddr_in6 *sin6, int defaultok)
343 if ((zoneid = sin6->sin6_scope_id) == 0 && defaultok)
344 zoneid = scope6_addr2default(&sin6->sin6_addr);
347 (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
348 IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr))) {
350 * At this moment, we only check interface-local and
351 * link-local scope IDs, and use interface indices as the
352 * zone IDs assuming a one-to-one mapping between interfaces
355 if (V_if_index < zoneid)
357 ifp = ifnet_byindex(zoneid);
358 if (ifp == NULL) /* XXX: this can happen for some OS */
361 /* XXX assignment to 16bit from 32bit variable */
362 sin6->sin6_addr.s6_addr16[1] = htons(zoneid & 0xffff);
364 sin6->sin6_scope_id = 0;
371 * generate standard sockaddr_in6 from embedded form.
374 sa6_recoverscope(struct sockaddr_in6 *sin6)
376 char ip6buf[INET6_ADDRSTRLEN];
379 if (sin6->sin6_scope_id != 0) {
381 "sa6_recoverscope: assumption failure (non 0 ID): %s%%%d\n",
382 ip6_sprintf(ip6buf, &sin6->sin6_addr), sin6->sin6_scope_id);
383 /* XXX: proceed anyway... */
385 if (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
386 IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr)) {
388 * KAME assumption: link id == interface id
390 zoneid = ntohs(sin6->sin6_addr.s6_addr16[1]);
393 if (zoneid < 0 || V_if_index < zoneid)
395 if (!ifnet_byindex(zoneid))
397 sin6->sin6_addr.s6_addr16[1] = 0;
398 sin6->sin6_scope_id = zoneid;
406 * Determine the appropriate scope zone ID for in6 and ifp. If ret_id is
407 * non NULL, it is set to the zone ID. If the zone ID needs to be embedded
408 * in the in6_addr structure, in6 will be modified.
410 * ret_id - unnecessary?
413 in6_setscope(struct in6_addr *in6, struct ifnet *ifp, u_int32_t *ret_id)
416 u_int32_t zoneid = 0;
417 struct scope6_id *sid;
424 if (sid == NULL) { /* should not happen */
425 panic("in6_setscope: scope array is NULL");
431 * special case: the loopback address can only belong to a loopback
434 if (IN6_IS_ADDR_LOOPBACK(in6)) {
435 if (!(ifp->if_flags & IFF_LOOPBACK)) {
436 IF_AFDATA_UNLOCK(ifp);
440 *ret_id = 0; /* there's no ambiguity */
441 IF_AFDATA_UNLOCK(ifp);
446 scope = in6_addrscope(in6);
450 case IPV6_ADDR_SCOPE_INTFACELOCAL: /* should be interface index */
451 zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL];
454 case IPV6_ADDR_SCOPE_LINKLOCAL:
455 zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL];
458 case IPV6_ADDR_SCOPE_SITELOCAL:
459 zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_SITELOCAL];
462 case IPV6_ADDR_SCOPE_ORGLOCAL:
463 zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_ORGLOCAL];
467 zoneid = 0; /* XXX: treat as global. */
471 IF_AFDATA_UNLOCK(ifp);
476 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6))
477 in6->s6_addr16[1] = htons(zoneid & 0xffff); /* XXX */
483 * Just clear the embedded scope identifier. Return 0 if the original address
484 * is intact; return non 0 if the address is modified.
487 in6_clearscope(struct in6_addr *in6)
491 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6)) {
492 if (in6->s6_addr16[1] != 0)
494 in6->s6_addr16[1] = 0;