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