1 /* 2 * Copyright (c) 2000-2021 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /* 29 * Copyright (c) 1982, 1986, 1993 30 * The Regents of the University of California. All rights reserved. 31 * 32 * Redistribution and use in source and binary forms, with or without 33 * modification, are permitted provided that the following conditions 34 * are met: 35 * 1. Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * 2. Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in the 39 * documentation and/or other materials provided with the distribution. 40 * 3. All advertising materials mentioning features or use of this software 41 * must display the following acknowledgement: 42 * This product includes software developed by the University of 43 * California, Berkeley and its contributors. 44 * 4. Neither the name of the University nor the names of its contributors 45 * may be used to endorse or promote products derived from this software 46 * without specific prior written permission. 47 * 48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 58 * SUCH DAMAGE. 59 * 60 * @(#)ip_var.h 8.2 (Berkeley) 1/9/95 61 */ 62 /* 63 * NOTICE: This file was modified by SPARTA, Inc. in 2007 to introduce 64 * support for mandatory and extensible security protections. This notice 65 * is included in support of clause 2.2 (b) of the Apple Public License, 66 * Version 2.0. 67 */ 68 69 #ifndef _NETINET_IP_VAR_H_ 70 #define _NETINET_IP_VAR_H_ 71 #include <sys/appleapiopts.h> 72 73 #include <netinet/in.h> 74 #include <sys/types.h> 75 76 /* 77 * Overlay for ip header used by other protocols (tcp, udp). 78 */ 79 struct ipovly { 80 u_char ih_x1[9]; /* (unused) */ 81 u_char ih_pr; /* protocol */ 82 u_short ih_len; /* protocol length */ 83 struct in_addr ih_src; /* source internet address */ 84 struct in_addr ih_dst; /* destination internet address */ 85 }; 86 87 #ifdef BSD_KERNEL_PRIVATE 88 /* 89 * Ip reassembly queue structure. Each fragment 90 * being reassembled is attached to one of these structures. 91 * They are timed out after ipq_ttl drops to 0, and may also 92 * be reclaimed if memory becomes tight. 93 */ 94 struct ipq { 95 TAILQ_ENTRY(ipq) ipq_list; /* to other reass headers */ 96 struct mbuf *ipq_frags; /* to ip headers of fragments */ 97 u_char ipq_ttl; /* time for reass q to live */ 98 u_char ipq_p; /* protocol of this fragment */ 99 u_short ipq_id; /* sequence id for reassembly */ 100 struct in_addr ipq_src, ipq_dst; 101 u_int32_t ipq_nfrags; /* # frags in this packet */ 102 uint32_t ipq_csum_flags; /* checksum flags */ 103 uint32_t ipq_csum; /* partial checksum value */ 104 }; 105 106 /* 107 * Structure stored in mbuf in inpcb.ip_options 108 * and passed to ip_output when ip options are in use. 109 * The actual length of the options (including ipopt_dst) 110 * is in m_len. 111 */ 112 #endif /* BSD_KERNEL_PRIVATE */ 113 #define MAX_IPOPTLEN 40 114 #ifdef BSD_KERNEL_PRIVATE 115 struct ipoption { 116 struct in_addr ipopt_dst; /* first-hop dst if source routed */ 117 char ipopt_list[MAX_IPOPTLEN]; /* options proper */ 118 }; 119 120 /* 121 * Structure attached to inpcb.ip_moptions and 122 * passed to ip_output when IP multicast options are in use. 123 */ 124 struct ip_moptions { 125 decl_lck_mtx_data(, imo_lock); 126 uint32_t imo_refcnt; /* ref count */ 127 uint32_t imo_debug; /* see ifa_debug flags */ 128 struct ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */ 129 u_char imo_multicast_ttl; /* TTL for outgoing multicasts */ 130 u_char imo_multicast_loop; /* 1 => hear sends if a member */ 131 u_short imo_num_memberships; /* no. memberships this socket */ 132 u_short imo_max_memberships; /* max memberships this socket */ 133 struct in_multi **__counted_by(imo_max_memberships) imo_membership; 134 /* group memberships */ 135 struct in_mfilter *__counted_by(imo_max_memberships) imo_mfilters; 136 /* source filters */ 137 u_int32_t imo_multicast_vif; /* vif num outgoing multicasts */ 138 struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */ 139 void (*imo_trace) /* callback fn for tracing refs */ 140 (struct ip_moptions *, int); 141 }; 142 143 #define IMO_LOCK_ASSERT_HELD(_imo) \ 144 LCK_MTX_ASSERT(&(_imo)->imo_lock, LCK_MTX_ASSERT_OWNED) 145 146 #define IMO_LOCK_ASSERT_NOTHELD(_imo) \ 147 LCK_MTX_ASSERT(&(_imo)->imo_lock, LCK_MTX_ASSERT_NOTOWNED) 148 149 #define IMO_LOCK(_imo) \ 150 lck_mtx_lock(&(_imo)->imo_lock) 151 152 #define IMO_LOCK_SPIN(_imo) \ 153 lck_mtx_lock_spin(&(_imo)->imo_lock) 154 155 #define IMO_CONVERT_LOCK(_imo) do { \ 156 IMO_LOCK_ASSERT_HELD(_imo); \ 157 lck_mtx_convert_spin(&(_imo)->imo_lock); \ 158 } while (0) 159 160 #define IMO_UNLOCK(_imo) \ 161 lck_mtx_unlock(&(_imo)->imo_lock) 162 163 #define IMO_ADDREF(_imo) \ 164 imo_addref(_imo, 0) 165 166 #define IMO_ADDREF_LOCKED(_imo) \ 167 imo_addref(_imo, 1) 168 169 #define IMO_REMREF(_imo) \ 170 imo_remref(_imo) 171 172 /* mbuf tag for ip_forwarding info */ 173 struct ip_fwd_tag { 174 struct sockaddr_in *next_hop; /* next_hop */ 175 }; 176 #endif /* BSD_KERNEL_PRIVATE */ 177 178 struct ipstat { 179 u_int32_t ips_total; /* total packets received */ 180 u_int32_t ips_badsum; /* checksum bad */ 181 u_int32_t ips_tooshort; /* packet too short */ 182 u_int32_t ips_toosmall; /* not enough data */ 183 u_int32_t ips_badhlen; /* ip header length < data size */ 184 u_int32_t ips_badlen; /* ip length < ip header length */ 185 u_int32_t ips_fragments; /* fragments received */ 186 u_int32_t ips_fragdropped; /* frags dropped (dups, out of space) */ 187 u_int32_t ips_fragtimeout; /* fragments timed out */ 188 u_int32_t ips_forward; /* packets forwarded */ 189 u_int32_t ips_fastforward; /* packets fast forwarded */ 190 u_int32_t ips_cantforward; /* packets rcvd for unreachable dest */ 191 u_int32_t ips_redirectsent; /* packets forwarded on same net */ 192 u_int32_t ips_noproto; /* unknown or unsupported protocol */ 193 u_int32_t ips_delivered; /* datagrams delivered to upper level */ 194 u_int32_t ips_localout; /* total ip packets generated here */ 195 u_int32_t ips_odropped; /* lost packets due to nobufs, etc. */ 196 u_int32_t ips_reassembled; /* total packets reassembled ok */ 197 u_int32_t ips_fragmented; /* datagrams successfully fragmented */ 198 u_int32_t ips_ofragments; /* output fragments created */ 199 u_int32_t ips_cantfrag; /* don't fragment flag was set, etc. */ 200 u_int32_t ips_badoptions; /* error in option processing */ 201 u_int32_t ips_noroute; /* packets discarded due to no route */ 202 u_int32_t ips_badvers; /* ip version != 4 */ 203 u_int32_t ips_rawout; /* total raw ip packets generated */ 204 u_int32_t ips_toolong; /* ip length > max ip packet size */ 205 u_int32_t ips_notmember; /* multicasts for unregistered grps */ 206 u_int32_t ips_nogif; /* no match gif found */ 207 u_int32_t ips_badaddr; /* invalid address on header */ 208 u_int32_t ips_pktdropcntrl; /* pkt dropped, no mbufs for ctl data */ 209 u_int32_t ips_rcv_swcsum; /* ip hdr swcksum (inbound), packets */ 210 u_int32_t ips_rcv_swcsum_bytes; /* ip hdr swcksum (inbound), bytes */ 211 u_int32_t ips_snd_swcsum; /* ip hdr swcksum (outbound), packets */ 212 u_int32_t ips_snd_swcsum_bytes; /* ip hdr swcksum (outbound), bytes */ 213 u_int32_t ips_adj; /* total packets trimmed/adjusted */ 214 u_int32_t ips_adj_hwcsum_clr; /* hwcksum discarded during adj */ 215 u_int32_t ips_rxc_collisions; /* rx chaining collisions */ 216 u_int32_t ips_rxc_chained; /* rx chains */ 217 u_int32_t ips_rxc_notchain; /* rx bypassed chaining */ 218 u_int32_t ips_rxc_chainsz_gt2; /* rx chain size greater than 2 */ 219 u_int32_t ips_rxc_chainsz_gt4; /* rx chain size greater than 4 */ 220 u_int32_t ips_rxc_notlist; /* count of pkts through ip_input */ 221 u_int32_t ips_raw_sappend_fail; /* sock append failed */ 222 u_int32_t ips_necp_policy_drop; /* NECP policy related drop */ 223 u_int32_t ips_rcv_if_weak_match; /* packets whose receive interface that passed the Weak ES address check */ 224 u_int32_t ips_rcv_if_no_match; /* packets whose receive interface did not pass the address check */ 225 }; 226 227 struct ip_linklocal_stat { 228 u_int32_t iplls_in_total; 229 u_int32_t iplls_in_badttl; 230 u_int32_t iplls_out_total; 231 u_int32_t iplls_out_badttl; 232 }; 233 234 #ifdef KERNEL_PRIVATE 235 /* forward declarations for ip_output() */ 236 struct ip_out_args; 237 struct ip_moptions; 238 #endif /* KERNEL_PRIVATE */ 239 240 #ifdef BSD_KERNEL_PRIVATE 241 /* flags passed to ip_output as last parameter */ 242 #define IP_FORWARDING 0x1 /* most of ip header exists */ 243 #define IP_RAWOUTPUT 0x2 /* raw ip header exists */ 244 #define IP_NOIPSEC 0x4 /* No IPsec processing */ 245 #define IP_ROUTETOIF SO_DONTROUTE /* bypass routing tables (0x0010) */ 246 #define IP_ALLOWBROADCAST SO_BROADCAST /* can send broadcast pkts (0x0020) */ 247 #define IP_OUTARGS 0x100 /* has ancillary output info */ 248 249 #define IP_HDR_ALIGNED_P(_ip) ((((uintptr_t)(_ip)) & ((uintptr_t)3)) == 0) 250 #define IP_OFF_IS_ATOMIC(_ip_off) ((_ip_off & (IP_DF | IP_MF | IP_OFFMASK)) == IP_DF) 251 252 /* 253 * On platforms which require strict alignment (currently for anything but 254 * i386 or x86_64), this macro checks whether the pointer to the IP header 255 * is 32-bit aligned, and assert otherwise. 256 */ 257 #if defined(__i386__) || defined(__x86_64__) 258 #define IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do { } while (0) 259 #else /* !__i386__ && !__x86_64__ */ 260 #define IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do { \ 261 if (!IP_HDR_ALIGNED_P(_ip)) { \ 262 panic_plain("\n%s: Unaligned IP header %p\n", \ 263 __func__, _ip); \ 264 } \ 265 } while (0) 266 #endif /* !__i386__ && !__x86_64__ */ 267 268 struct ip; 269 struct inpcb; 270 struct route; 271 struct sockopt; 272 273 #include <kern/zalloc.h> 274 #include <net/flowadv.h> 275 276 /* 277 * Extra information passed to ip_output when IP_OUTARGS is set. 278 * 279 * Upon returning an error to the caller, ip_output may indicate through 280 * ipoa_flags any additional information regarding the error. 281 */ 282 struct ip_out_args { 283 unsigned int ipoa_boundif; /* boundif interface index */ 284 struct flowadv ipoa_flowadv; /* flow advisory code */ 285 u_int32_t ipoa_flags; /* IPOAF output flags (see below) */ 286 #define IPOAF_SELECT_SRCIF 0x00000001 /* src interface selection */ 287 #define IPOAF_BOUND_IF 0x00000002 /* boundif value is valid */ 288 #define IPOAF_BOUND_SRCADDR 0x00000004 /* bound to src address */ 289 #define IPOAF_NO_CELLULAR 0x00000010 /* skip IFT_CELLULAR */ 290 #define IPOAF_NO_EXPENSIVE 0x00000020 /* skip IFT_EXPENSIVE */ 291 #define IPOAF_AWDL_UNRESTRICTED 0x00000040 /* can send over 292 * AWDL_RESTRICTED */ 293 #define IPOAF_QOSMARKING_ALLOWED 0x00000080 /* policy allows Fastlane DSCP marking */ 294 #define IPOAF_NO_CONSTRAINED 0x00000400 /* skip IFXF_CONSTRAINED */ 295 #define IPOAF_REDO_QOSMARKING_POLICY 0x00002000 /* Re-evaluate QOS marking policy */ 296 #define IPOAF_R_IFDENIED 0x00004000 /* denied access to interface */ 297 int ipoa_sotc; /* traffic class for Fastlane DSCP mapping */ 298 int ipoa_netsvctype; /* network service type */ 299 int32_t qos_marking_gencount; 300 }; 301 302 #define IPOAF_RET_MASK (IPOAF_R_IFDENIED) 303 304 extern struct ipstat ipstat; 305 extern int ip_use_randomid; 306 extern u_short ip_id; /* ip packet ctr, for ids */ 307 extern int ip_defttl; /* default IP ttl */ 308 extern int ipforwarding; /* ip forwarding */ 309 extern int rfc6864; 310 extern struct protosw *ip_protox[]; 311 extern struct pr_usrreqs rip_usrreqs; 312 313 extern void ip_moptions_init(void); 314 extern struct ip_moptions *ip_allocmoptions(zalloc_flags_t); 315 extern int inp_getmoptions(struct inpcb *, struct sockopt *); 316 extern int inp_setmoptions(struct inpcb *, struct sockopt *); 317 extern void imo_addref(struct ip_moptions *, int); 318 extern void imo_remref(struct ip_moptions *); 319 320 struct protosw; 321 struct domain; 322 323 extern int ip_checkrouteralert(struct mbuf *); 324 extern int ip_ctloutput(struct socket *, struct sockopt *sopt); 325 extern void ip_drain(void); 326 extern void ip_init(struct protosw *, struct domain *); 327 extern int ip_output(struct mbuf *, struct mbuf *, struct route *, int, 328 struct ip_moptions *, struct ip_out_args *); 329 extern int ip_output_list(struct mbuf *, int, struct mbuf *, struct route *, 330 int, struct ip_moptions *, struct ip_out_args *); 331 extern void ip_output_checksum(struct ifnet *, struct mbuf *, int, int, 332 uint32_t *); 333 extern struct in_ifaddr *ip_rtaddr(struct in_addr); 334 extern int ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *, 335 struct mbuf *); 336 extern struct mbuf *ip_srcroute(void); 337 extern void ip_stripoptions(struct mbuf *); 338 extern u_int16_t ip_randomid(uint64_t); 339 extern int ip_fragment(struct mbuf *, struct ifnet *, uint32_t, int); 340 341 extern void ip_setsrcifaddr_info(struct mbuf *, uint16_t, struct in_ifaddr *); 342 extern void ip_setdstifaddr_info(struct mbuf *, uint16_t, struct in_ifaddr *); 343 extern int ip_getsrcifaddr_info(struct mbuf *, uint32_t *, uint32_t *); 344 extern int ip_getdstifaddr_info(struct mbuf *, uint32_t *, uint32_t *); 345 346 extern int rip_ctloutput(struct socket *, struct sockopt *); 347 extern void rip_ctlinput(int, struct sockaddr *, void *, struct ifnet *); 348 extern void rip_init(struct protosw *, struct domain *); 349 extern void rip_input(struct mbuf *, int); 350 extern int rip_output(struct mbuf *, struct socket *, u_int32_t, struct mbuf *); 351 extern int rip_unlock(struct socket *, int, void *); 352 extern int rip_send(struct socket *, int, struct mbuf *, struct sockaddr *, 353 struct mbuf *, struct proc *); 354 355 extern void tcp_in_cksum_stats(u_int32_t); 356 extern void tcp_out_cksum_stats(u_int32_t); 357 358 extern void udp_in_cksum_stats(u_int32_t); 359 extern void udp_out_cksum_stats(u_int32_t); 360 361 extern void tcp_in6_cksum_stats(u_int32_t); 362 extern void tcp_out6_cksum_stats(u_int32_t); 363 364 extern void udp_in6_cksum_stats(u_int32_t); 365 extern void udp_out6_cksum_stats(u_int32_t); 366 #endif /* BSD_KERNEL_PRIVATE */ 367 #ifdef KERNEL_PRIVATE 368 /* for PPP/PPTP */ 369 extern int ip_gre_output(struct mbuf *); 370 typedef struct mbuf *(*gre_input_func_t)(struct mbuf *, int, int); 371 extern int ip_gre_register_input(gre_input_func_t); 372 #endif /* KERNEL_PRIVATE */ 373 #endif /* !_NETINET_IP_VAR_H_ */ 374