xref: /freebsd-11-stable/sys/netinet/sctp_bsd_addr.c (revision 447c320d98e3445864e38ecae06ee4b2b8f20faa)
1 /*-
2  * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
3  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
4  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * a) Redistributions of source code must retain the above copyright notice,
10  *    this list of conditions and the following disclaimer.
11  *
12  * b) Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the distribution.
15  *
16  * c) Neither the name of Cisco Systems, Inc. nor the names of its
17  *    contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30  * THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #include <netinet/sctp_os.h>
37 #include <netinet/sctp_var.h>
38 #include <netinet/sctp_pcb.h>
39 #include <netinet/sctp_header.h>
40 #include <netinet/sctputil.h>
41 #include <netinet/sctp_output.h>
42 #include <netinet/sctp_bsd_addr.h>
43 #include <netinet/sctp_uio.h>
44 #include <netinet/sctputil.h>
45 #include <netinet/sctp_timer.h>
46 #include <netinet/sctp_asconf.h>
47 #include <netinet/sctp_sysctl.h>
48 #include <netinet/sctp_indata.h>
49 #include <sys/unistd.h>
50 
51 /* Declare all of our malloc named types */
52 MALLOC_DEFINE(SCTP_M_MAP, "sctp_map", "sctp asoc map descriptor");
53 MALLOC_DEFINE(SCTP_M_STRMI, "sctp_stri", "sctp stream in array");
54 MALLOC_DEFINE(SCTP_M_STRMO, "sctp_stro", "sctp stream out array");
55 MALLOC_DEFINE(SCTP_M_ASC_ADDR, "sctp_aadr", "sctp asconf address");
56 MALLOC_DEFINE(SCTP_M_ASC_IT, "sctp_a_it", "sctp asconf iterator");
57 MALLOC_DEFINE(SCTP_M_AUTH_CL, "sctp_atcl", "sctp auth chunklist");
58 MALLOC_DEFINE(SCTP_M_AUTH_KY, "sctp_atky", "sctp auth key");
59 MALLOC_DEFINE(SCTP_M_AUTH_HL, "sctp_athm", "sctp auth hmac list");
60 MALLOC_DEFINE(SCTP_M_AUTH_IF, "sctp_athi", "sctp auth info");
61 MALLOC_DEFINE(SCTP_M_STRESET, "sctp_stre", "sctp stream reset");
62 MALLOC_DEFINE(SCTP_M_CMSG, "sctp_cmsg", "sctp CMSG buffer");
63 MALLOC_DEFINE(SCTP_M_COPYAL, "sctp_cpal", "sctp copy all");
64 MALLOC_DEFINE(SCTP_M_VRF, "sctp_vrf", "sctp vrf struct");
65 MALLOC_DEFINE(SCTP_M_IFA, "sctp_ifa", "sctp ifa struct");
66 MALLOC_DEFINE(SCTP_M_IFN, "sctp_ifn", "sctp ifn struct");
67 MALLOC_DEFINE(SCTP_M_TIMW, "sctp_timw", "sctp time block");
68 MALLOC_DEFINE(SCTP_M_MVRF, "sctp_mvrf", "sctp mvrf pcb list");
69 MALLOC_DEFINE(SCTP_M_ITER, "sctp_iter", "sctp iterator control");
70 MALLOC_DEFINE(SCTP_M_SOCKOPT, "sctp_socko", "sctp socket option");
71 MALLOC_DEFINE(SCTP_M_MCORE, "sctp_mcore", "sctp mcore queue");
72 
73 /* Global NON-VNET structure that controls the iterator */
74 struct iterator_control sctp_it_ctl;
75 
76 
77 void
sctp_wakeup_iterator(void)78 sctp_wakeup_iterator(void)
79 {
80 	wakeup(&sctp_it_ctl.iterator_running);
81 }
82 
83 static void
sctp_iterator_thread(void * v SCTP_UNUSED)84 sctp_iterator_thread(void *v SCTP_UNUSED)
85 {
86 	SCTP_IPI_ITERATOR_WQ_LOCK();
87 	/* In FreeBSD this thread never terminates. */
88 	for (;;) {
89 		msleep(&sctp_it_ctl.iterator_running,
90 		    &sctp_it_ctl.ipi_iterator_wq_mtx,
91 		    0, "waiting_for_work", 0);
92 		sctp_iterator_worker();
93 	}
94 }
95 
96 void
sctp_startup_iterator(void)97 sctp_startup_iterator(void)
98 {
99 	if (sctp_it_ctl.thread_proc) {
100 		/* You only get one */
101 		return;
102 	}
103 	/* Initialize global locks here, thus only once. */
104 	SCTP_ITERATOR_LOCK_INIT();
105 	SCTP_IPI_ITERATOR_WQ_INIT();
106 	TAILQ_INIT(&sctp_it_ctl.iteratorhead);
107 	kproc_create(sctp_iterator_thread,
108 	    (void *)NULL,
109 	    &sctp_it_ctl.thread_proc,
110 	    RFPROC,
111 	    SCTP_KTHREAD_PAGES,
112 	    SCTP_KTRHEAD_NAME);
113 }
114 
115 #ifdef INET6
116 
117 void
sctp_gather_internal_ifa_flags(struct sctp_ifa * ifa)118 sctp_gather_internal_ifa_flags(struct sctp_ifa *ifa)
119 {
120 	struct in6_ifaddr *ifa6;
121 
122 	ifa6 = (struct in6_ifaddr *)ifa->ifa;
123 	ifa->flags = ifa6->ia6_flags;
124 	if (!MODULE_GLOBAL(ip6_use_deprecated)) {
125 		if (ifa->flags &
126 		    IN6_IFF_DEPRECATED) {
127 			ifa->localifa_flags |= SCTP_ADDR_IFA_UNUSEABLE;
128 		} else {
129 			ifa->localifa_flags &= ~SCTP_ADDR_IFA_UNUSEABLE;
130 		}
131 	} else {
132 		ifa->localifa_flags &= ~SCTP_ADDR_IFA_UNUSEABLE;
133 	}
134 	if (ifa->flags &
135 	    (IN6_IFF_DETACHED |
136 	    IN6_IFF_ANYCAST |
137 	    IN6_IFF_NOTREADY)) {
138 		ifa->localifa_flags |= SCTP_ADDR_IFA_UNUSEABLE;
139 	} else {
140 		ifa->localifa_flags &= ~SCTP_ADDR_IFA_UNUSEABLE;
141 	}
142 }
143 #endif				/* INET6 */
144 
145 
146 static uint32_t
sctp_is_desired_interface_type(struct ifnet * ifn)147 sctp_is_desired_interface_type(struct ifnet *ifn)
148 {
149 	int result;
150 
151 	/* check the interface type to see if it's one we care about */
152 	switch (ifn->if_type) {
153 	case IFT_ETHER:
154 	case IFT_ISO88023:
155 	case IFT_ISO88024:
156 	case IFT_ISO88025:
157 	case IFT_ISO88026:
158 	case IFT_STARLAN:
159 	case IFT_P10:
160 	case IFT_P80:
161 	case IFT_HY:
162 	case IFT_FDDI:
163 	case IFT_XETHER:
164 	case IFT_ISDNBASIC:
165 	case IFT_ISDNPRIMARY:
166 	case IFT_PTPSERIAL:
167 	case IFT_OTHER:
168 	case IFT_PPP:
169 	case IFT_LOOP:
170 	case IFT_SLIP:
171 	case IFT_GIF:
172 	case IFT_L2VLAN:
173 	case IFT_STF:
174 	case IFT_IP:
175 	case IFT_IPOVERCDLC:
176 	case IFT_IPOVERCLAW:
177 	case IFT_PROPVIRTUAL:	/* NetGraph Virtual too */
178 	case IFT_VIRTUALIPADDRESS:
179 		result = 1;
180 		break;
181 	default:
182 		result = 0;
183 	}
184 
185 	return (result);
186 }
187 
188 
189 
190 
191 static void
sctp_init_ifns_for_vrf(int vrfid)192 sctp_init_ifns_for_vrf(int vrfid)
193 {
194 	/*
195 	 * Here we must apply ANY locks needed by the IFN we access and also
196 	 * make sure we lock any IFA that exists as we float through the
197 	 * list of IFA's
198 	 */
199 	struct ifnet *ifn;
200 	struct ifaddr *ifa;
201 	struct sctp_ifa *sctp_ifa;
202 	uint32_t ifa_flags;
203 #ifdef INET6
204 	struct in6_ifaddr *ifa6;
205 #endif
206 
207 	IFNET_RLOCK();
208 	TAILQ_FOREACH(ifn, &MODULE_GLOBAL(ifnet), if_list) {
209 		if (sctp_is_desired_interface_type(ifn) == 0) {
210 			/* non desired type */
211 			continue;
212 		}
213 		IF_ADDR_RLOCK(ifn);
214 		TAILQ_FOREACH(ifa, &ifn->if_addrlist, ifa_list) {
215 			if (ifa->ifa_addr == NULL) {
216 				continue;
217 			}
218 			switch (ifa->ifa_addr->sa_family) {
219 #ifdef INET
220 			case AF_INET:
221 				if (((struct sockaddr_in *)ifa->ifa_addr)->sin_addr.s_addr == 0) {
222 					continue;
223 				}
224 				break;
225 #endif
226 #ifdef INET6
227 			case AF_INET6:
228 				if (IN6_IS_ADDR_UNSPECIFIED(&((struct sockaddr_in6 *)ifa->ifa_addr)->sin6_addr)) {
229 					/* skip unspecifed addresses */
230 					continue;
231 				}
232 				break;
233 #endif
234 			default:
235 				continue;
236 			}
237 			switch (ifa->ifa_addr->sa_family) {
238 #ifdef INET
239 			case AF_INET:
240 				ifa_flags = 0;
241 				break;
242 #endif
243 #ifdef INET6
244 			case AF_INET6:
245 				ifa6 = (struct in6_ifaddr *)ifa;
246 				ifa_flags = ifa6->ia6_flags;
247 				break;
248 #endif
249 			default:
250 				ifa_flags = 0;
251 				break;
252 			}
253 			sctp_ifa = sctp_add_addr_to_vrf(vrfid,
254 			    (void *)ifn,
255 			    ifn->if_index,
256 			    ifn->if_type,
257 			    ifn->if_xname,
258 			    (void *)ifa,
259 			    ifa->ifa_addr,
260 			    ifa_flags,
261 			    0);
262 			if (sctp_ifa) {
263 				sctp_ifa->localifa_flags &= ~SCTP_ADDR_DEFER_USE;
264 			}
265 		}
266 		IF_ADDR_RUNLOCK(ifn);
267 	}
268 	IFNET_RUNLOCK();
269 }
270 
271 void
sctp_init_vrf_list(int vrfid)272 sctp_init_vrf_list(int vrfid)
273 {
274 	if (vrfid > SCTP_MAX_VRF_ID)
275 		/* can't do that */
276 		return;
277 
278 	/* Don't care about return here */
279 	(void)sctp_allocate_vrf(vrfid);
280 
281 	/*
282 	 * Now we need to build all the ifn's for this vrf and there
283 	 * addresses
284 	 */
285 	sctp_init_ifns_for_vrf(vrfid);
286 }
287 
288 void
sctp_addr_change(struct ifaddr * ifa,int cmd)289 sctp_addr_change(struct ifaddr *ifa, int cmd)
290 {
291 	uint32_t ifa_flags = 0;
292 
293 	if (SCTP_BASE_VAR(sctp_pcb_initialized) == 0) {
294 		return;
295 	}
296 	/*
297 	 * BSD only has one VRF, if this changes we will need to hook in the
298 	 * right things here to get the id to pass to the address management
299 	 * routine.
300 	 */
301 	if (SCTP_BASE_VAR(first_time) == 0) {
302 		/* Special test to see if my ::1 will showup with this */
303 		SCTP_BASE_VAR(first_time) = 1;
304 		sctp_init_ifns_for_vrf(SCTP_DEFAULT_VRFID);
305 	}
306 
307 	if ((cmd != RTM_ADD) && (cmd != RTM_DELETE)) {
308 		/* don't know what to do with this */
309 		return;
310 	}
311 
312 	if (ifa->ifa_addr == NULL) {
313 		return;
314 	}
315 	if (sctp_is_desired_interface_type(ifa->ifa_ifp) == 0) {
316 		/* non desired type */
317 		return;
318 	}
319 	switch (ifa->ifa_addr->sa_family) {
320 #ifdef INET
321 	case AF_INET:
322 		if (((struct sockaddr_in *)ifa->ifa_addr)->sin_addr.s_addr == 0) {
323 			return;
324 		}
325 		break;
326 #endif
327 #ifdef INET6
328 	case AF_INET6:
329 		ifa_flags = ((struct in6_ifaddr *)ifa)->ia6_flags;
330 		if (IN6_IS_ADDR_UNSPECIFIED(&((struct sockaddr_in6 *)ifa->ifa_addr)->sin6_addr)) {
331 			/* skip unspecifed addresses */
332 			return;
333 		}
334 		break;
335 #endif
336 	default:
337 		/* non inet/inet6 skip */
338 		return;
339 	}
340 	if (cmd == RTM_ADD) {
341 		(void)sctp_add_addr_to_vrf(SCTP_DEFAULT_VRFID, (void *)ifa->ifa_ifp,
342 		    ifa->ifa_ifp->if_index, ifa->ifa_ifp->if_type, ifa->ifa_ifp->if_xname,
343 		    (void *)ifa, ifa->ifa_addr, ifa_flags, 1);
344 	} else {
345 
346 		sctp_del_addr_from_vrf(SCTP_DEFAULT_VRFID, ifa->ifa_addr,
347 		    ifa->ifa_ifp->if_index,
348 		    ifa->ifa_ifp->if_xname);
349 
350 		/*
351 		 * We don't bump refcount here so when it completes the
352 		 * final delete will happen.
353 		 */
354 	}
355 }
356 
357 void
sctp_add_or_del_interfaces(int (* pred)(struct ifnet *),int add)358      sctp_add_or_del_interfaces(int (*pred) (struct ifnet *), int add){
359 	struct ifnet *ifn;
360 	struct ifaddr *ifa;
361 
362 	IFNET_RLOCK();
363 	TAILQ_FOREACH(ifn, &MODULE_GLOBAL(ifnet), if_list) {
364 		if (!(*pred) (ifn)) {
365 			continue;
366 		}
367 		TAILQ_FOREACH(ifa, &ifn->if_addrlist, ifa_list) {
368 			sctp_addr_change(ifa, add ? RTM_ADD : RTM_DELETE);
369 		}
370 	}
371 	IFNET_RUNLOCK();
372 }
373 
374 struct mbuf *
sctp_get_mbuf_for_msg(unsigned int space_needed,int want_header,int how,int allonebuf,int type)375 sctp_get_mbuf_for_msg(unsigned int space_needed, int want_header,
376     int how, int allonebuf, int type)
377 {
378 	struct mbuf *m = NULL;
379 
380 	m = m_getm2(NULL, space_needed, how, type, want_header ? M_PKTHDR : 0);
381 	if (m == NULL) {
382 		/* bad, no memory */
383 		return (m);
384 	}
385 	if (allonebuf) {
386 		if (SCTP_BUF_SIZE(m) < space_needed) {
387 			m_freem(m);
388 			return (NULL);
389 		}
390 		KASSERT(SCTP_BUF_NEXT(m) == NULL, ("%s: no chain allowed", __FUNCTION__));
391 	}
392 #ifdef SCTP_MBUF_LOGGING
393 	if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_MBUF_LOGGING_ENABLE) {
394 		sctp_log_mb(m, SCTP_MBUF_IALLOC);
395 	}
396 #endif
397 	return (m);
398 }
399 
400 
401 #ifdef SCTP_PACKET_LOGGING
402 void
sctp_packet_log(struct mbuf * m)403 sctp_packet_log(struct mbuf *m)
404 {
405 	int *lenat, thisone;
406 	void *copyto;
407 	uint32_t *tick_tock;
408 	int length;
409 	int total_len;
410 	int grabbed_lock = 0;
411 	int value, newval, thisend, thisbegin;
412 
413 	/*
414 	 * Buffer layout. -sizeof this entry (total_len) -previous end
415 	 * (value) -ticks of log      (ticks) o -ip packet o -as logged -
416 	 * where this started (thisbegin) x <--end points here
417 	 */
418 	length = SCTP_HEADER_LEN(m);
419 	total_len = SCTP_SIZE32((length + (4 * sizeof(int))));
420 	/* Log a packet to the buffer. */
421 	if (total_len > SCTP_PACKET_LOG_SIZE) {
422 		/* Can't log this packet I have not a buffer big enough */
423 		return;
424 	}
425 	if (length < (int)(SCTP_MIN_V4_OVERHEAD + sizeof(struct sctp_cookie_ack_chunk))) {
426 		return;
427 	}
428 	atomic_add_int(&SCTP_BASE_VAR(packet_log_writers), 1);
429 try_again:
430 	if (SCTP_BASE_VAR(packet_log_writers) > SCTP_PKTLOG_WRITERS_NEED_LOCK) {
431 		SCTP_IP_PKTLOG_LOCK();
432 		grabbed_lock = 1;
433 again_locked:
434 		value = SCTP_BASE_VAR(packet_log_end);
435 		newval = SCTP_BASE_VAR(packet_log_end) + total_len;
436 		if (newval >= SCTP_PACKET_LOG_SIZE) {
437 			/* we wrapped */
438 			thisbegin = 0;
439 			thisend = total_len;
440 		} else {
441 			thisbegin = SCTP_BASE_VAR(packet_log_end);
442 			thisend = newval;
443 		}
444 		if (!(atomic_cmpset_int(&SCTP_BASE_VAR(packet_log_end), value, thisend))) {
445 			goto again_locked;
446 		}
447 	} else {
448 		value = SCTP_BASE_VAR(packet_log_end);
449 		newval = SCTP_BASE_VAR(packet_log_end) + total_len;
450 		if (newval >= SCTP_PACKET_LOG_SIZE) {
451 			/* we wrapped */
452 			thisbegin = 0;
453 			thisend = total_len;
454 		} else {
455 			thisbegin = SCTP_BASE_VAR(packet_log_end);
456 			thisend = newval;
457 		}
458 		if (!(atomic_cmpset_int(&SCTP_BASE_VAR(packet_log_end), value, thisend))) {
459 			goto try_again;
460 		}
461 	}
462 	/* Sanity check */
463 	if (thisend >= SCTP_PACKET_LOG_SIZE) {
464 		SCTP_PRINTF("Insanity stops a log thisbegin:%d thisend:%d writers:%d lock:%d end:%d\n",
465 		    thisbegin,
466 		    thisend,
467 		    SCTP_BASE_VAR(packet_log_writers),
468 		    grabbed_lock,
469 		    SCTP_BASE_VAR(packet_log_end));
470 		SCTP_BASE_VAR(packet_log_end) = 0;
471 		goto no_log;
472 
473 	}
474 	lenat = (int *)&SCTP_BASE_VAR(packet_log_buffer)[thisbegin];
475 	*lenat = total_len;
476 	lenat++;
477 	*lenat = value;
478 	lenat++;
479 	tick_tock = (uint32_t *)lenat;
480 	lenat++;
481 	*tick_tock = sctp_get_tick_count();
482 	copyto = (void *)lenat;
483 	thisone = thisend - sizeof(int);
484 	lenat = (int *)&SCTP_BASE_VAR(packet_log_buffer)[thisone];
485 	*lenat = thisbegin;
486 	if (grabbed_lock) {
487 		SCTP_IP_PKTLOG_UNLOCK();
488 		grabbed_lock = 0;
489 	}
490 	m_copydata(m, 0, length, (caddr_t)copyto);
491 no_log:
492 	if (grabbed_lock) {
493 		SCTP_IP_PKTLOG_UNLOCK();
494 	}
495 	atomic_subtract_int(&SCTP_BASE_VAR(packet_log_writers), 1);
496 }
497 
498 
499 int
sctp_copy_out_packet_log(uint8_t * target,int length)500 sctp_copy_out_packet_log(uint8_t *target, int length)
501 {
502 	/*
503 	 * We wind through the packet log starting at start copying up to
504 	 * length bytes out. We return the number of bytes copied.
505 	 */
506 	int tocopy, this_copy;
507 	int *lenat;
508 	int did_delay = 0;
509 
510 	tocopy = length;
511 	if (length < (int)(2 * sizeof(int))) {
512 		/* not enough room */
513 		return (0);
514 	}
515 	if (SCTP_PKTLOG_WRITERS_NEED_LOCK) {
516 		atomic_add_int(&SCTP_BASE_VAR(packet_log_writers), SCTP_PKTLOG_WRITERS_NEED_LOCK);
517 again:
518 		if ((did_delay == 0) && (SCTP_BASE_VAR(packet_log_writers) != SCTP_PKTLOG_WRITERS_NEED_LOCK)) {
519 			/*
520 			 * we delay here for just a moment hoping the
521 			 * writer(s) that were present when we entered will
522 			 * have left and we only have locking ones that will
523 			 * contend with us for the lock. This does not
524 			 * assure 100% access, but its good enough for a
525 			 * logging facility like this.
526 			 */
527 			did_delay = 1;
528 			DELAY(10);
529 			goto again;
530 		}
531 	}
532 	SCTP_IP_PKTLOG_LOCK();
533 	lenat = (int *)target;
534 	*lenat = SCTP_BASE_VAR(packet_log_end);
535 	lenat++;
536 	this_copy = min((length - sizeof(int)), SCTP_PACKET_LOG_SIZE);
537 	memcpy((void *)lenat, (void *)SCTP_BASE_VAR(packet_log_buffer), this_copy);
538 	if (SCTP_PKTLOG_WRITERS_NEED_LOCK) {
539 		atomic_subtract_int(&SCTP_BASE_VAR(packet_log_writers),
540 		    SCTP_PKTLOG_WRITERS_NEED_LOCK);
541 	}
542 	SCTP_IP_PKTLOG_UNLOCK();
543 	return (this_copy + sizeof(int));
544 }
545 
546 #endif
547