bsd/netinet/ip_var.h

   1 /*
   2  * Copyright (c) 2000-2020 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 /*
  74  * Overlay for ip header used by other protocols (tcp, udp).
  75  */
  76 struct ipovly {
  77         u_char  ih_x1[9];               /* (unused) */
  78         u_char  ih_pr;                  /* protocol */
  79         u_short ih_len;                 /* protocol length */
  80         struct  in_addr ih_src;         /* source internet address */
  81         struct  in_addr ih_dst;         /* destination internet address */
  82 };
  83
  84 #ifdef BSD_KERNEL_PRIVATE
  85 /*
  86  * Ip reassembly queue structure.  Each fragment
  87  * being reassembled is attached to one of these structures.
  88  * They are timed out after ipq_ttl drops to 0, and may also
  89  * be reclaimed if memory becomes tight.
  90  */
  91 struct ipq {
  92         TAILQ_ENTRY(ipq) ipq_list;      /* to other reass headers */
  93         struct mbuf *ipq_frags;         /* to ip headers of fragments */
  94         u_char  ipq_ttl;                /* time for reass q to live */
  95         u_char  ipq_p;                  /* protocol of this fragment */
  96         u_short ipq_id;                 /* sequence id for reassembly */
  97         struct  in_addr ipq_src, ipq_dst;
  98         u_int32_t       ipq_nfrags;     /* # frags in this packet */
  99         uint32_t ipq_csum_flags;        /* checksum flags */
 100         uint32_t ipq_csum;              /* partial checksum value */
 101 };
 102
 103 /*
 104  * Structure stored in mbuf in inpcb.ip_options
 105  * and passed to ip_output when ip options are in use.
 106  * The actual length of the options (including ipopt_dst)
 107  * is in m_len.
 108  */
 109 #endif /* BSD_KERNEL_PRIVATE */
 110 #define MAX_IPOPTLEN    40
 111 #ifdef BSD_KERNEL_PRIVATE
 112 struct ipoption {
 113         struct  in_addr ipopt_dst;      /* first-hop dst if source routed */
 114         char    ipopt_list[MAX_IPOPTLEN];       /* options proper */
 115 };
 116
 117 /*
 118  * Structure attached to inpcb.ip_moptions and
 119  * passed to ip_output when IP multicast options are in use.
 120  */
 121 struct ip_moptions {
 122         decl_lck_mtx_data(, imo_lock);
 123         uint32_t imo_refcnt;            /* ref count */
 124         uint32_t imo_debug;             /* see ifa_debug flags */
 125         struct  ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
 126         u_char  imo_multicast_ttl;      /* TTL for outgoing multicasts */
 127         u_char  imo_multicast_loop;     /* 1 => hear sends if a member */
 128         u_short imo_num_memberships;    /* no. memberships this socket */
 129         u_short imo_max_memberships;    /* max memberships this socket */
 130         struct  in_multi **imo_membership;      /* group memberships */
 131         struct  in_mfilter *imo_mfilters;       /* source filters */
 132         u_int32_t imo_multicast_vif;    /* vif num outgoing multicasts */
 133         struct  in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
 134         void (*imo_trace)               /* callback fn for tracing refs */
 135         (struct ip_moptions *, int);
 136 };
 137
 138 #define IMO_LOCK_ASSERT_HELD(_imo)                                      \
 139         LCK_MTX_ASSERT(&(_imo)->imo_lock, LCK_MTX_ASSERT_OWNED)
 140
 141 #define IMO_LOCK_ASSERT_NOTHELD(_imo)                                   \
 142         LCK_MTX_ASSERT(&(_imo)->imo_lock, LCK_MTX_ASSERT_NOTOWNED)
 143
 144 #define IMO_LOCK(_imo)                                                  \
 145         lck_mtx_lock(&(_imo)->imo_lock)
 146
 147 #define IMO_LOCK_SPIN(_imo)                                             \
 148         lck_mtx_lock_spin(&(_imo)->imo_lock)
 149
 150 #define IMO_CONVERT_LOCK(_imo) do {                                     \
 151         IMO_LOCK_ASSERT_HELD(_imo);                                     \
 152         lck_mtx_convert_spin(&(_imo)->imo_lock);                        \
 153 } while (0)
 154
 155 #define IMO_UNLOCK(_imo)                                                \
 156         lck_mtx_unlock(&(_imo)->imo_lock)
 157
 158 #define IMO_ADDREF(_imo)                                                \
 159         imo_addref(_imo, 0)
 160
 161 #define IMO_ADDREF_LOCKED(_imo)                                         \
 162         imo_addref(_imo, 1)
 163
 164 #define IMO_REMREF(_imo)                                                \
 165         imo_remref(_imo)
 166
 167 /* mbuf tag for ip_forwarding info */
 168 struct ip_fwd_tag {
 169         struct sockaddr_in *next_hop;   /* next_hop */
 170 };
 171 #endif /* BSD_KERNEL_PRIVATE */
 172
 173 struct  ipstat {
 174         u_int32_t ips_total;            /* total packets received */
 175         u_int32_t ips_badsum;           /* checksum bad */
 176         u_int32_t ips_tooshort;         /* packet too short */
 177         u_int32_t ips_toosmall;         /* not enough data */
 178         u_int32_t ips_badhlen;          /* ip header length < data size */
 179         u_int32_t ips_badlen;           /* ip length < ip header length */
 180         u_int32_t ips_fragments;        /* fragments received */
 181         u_int32_t ips_fragdropped;      /* frags dropped (dups, out of space) */
 182         u_int32_t ips_fragtimeout;      /* fragments timed out */
 183         u_int32_t ips_forward;          /* packets forwarded */
 184         u_int32_t ips_fastforward;      /* packets fast forwarded */
 185         u_int32_t ips_cantforward;      /* packets rcvd for unreachable dest */
 186         u_int32_t ips_redirectsent;     /* packets forwarded on same net */
 187         u_int32_t ips_noproto;          /* unknown or unsupported protocol */
 188         u_int32_t ips_delivered;        /* datagrams delivered to upper level */
 189         u_int32_t ips_localout;         /* total ip packets generated here */
 190         u_int32_t ips_odropped;         /* lost packets due to nobufs, etc. */
 191         u_int32_t ips_reassembled;      /* total packets reassembled ok */
 192         u_int32_t ips_fragmented;       /* datagrams successfully fragmented */
 193         u_int32_t ips_ofragments;       /* output fragments created */
 194         u_int32_t ips_cantfrag;         /* don't fragment flag was set, etc. */
 195         u_int32_t ips_badoptions;       /* error in option processing */
 196         u_int32_t ips_noroute;          /* packets discarded due to no route */
 197         u_int32_t ips_badvers;          /* ip version != 4 */
 198         u_int32_t ips_rawout;           /* total raw ip packets generated */
 199         u_int32_t ips_toolong;          /* ip length > max ip packet size */
 200         u_int32_t ips_notmember;        /* multicasts for unregistered grps */
 201         u_int32_t ips_nogif;            /* no match gif found */
 202         u_int32_t ips_badaddr;          /* invalid address on header */
 203         u_int32_t ips_pktdropcntrl;     /* pkt dropped, no mbufs for ctl data */
 204         u_int32_t ips_rcv_swcsum;       /* ip hdr swcksum (inbound), packets */
 205         u_int32_t ips_rcv_swcsum_bytes; /* ip hdr swcksum (inbound), bytes */
 206         u_int32_t ips_snd_swcsum;       /* ip hdr swcksum (outbound), packets */
 207         u_int32_t ips_snd_swcsum_bytes; /* ip hdr swcksum (outbound), bytes */
 208         u_int32_t ips_adj;              /* total packets trimmed/adjusted */
 209         u_int32_t ips_adj_hwcsum_clr;   /* hwcksum discarded during adj */
 210         u_int32_t ips_rxc_collisions;   /* rx chaining collisions */
 211         u_int32_t ips_rxc_chained;      /* rx chains */
 212         u_int32_t ips_rxc_notchain;     /* rx bypassed chaining */
 213         u_int32_t ips_rxc_chainsz_gt2;  /* rx chain size greater than 2 */
 214         u_int32_t ips_rxc_chainsz_gt4;  /* rx chain size greater than 4 */
 215         u_int32_t ips_rxc_notlist;      /* count of pkts through ip_input */
 216         u_int32_t ips_raw_sappend_fail; /* sock append failed */
 217         u_int32_t ips_necp_policy_drop; /* NECP policy related drop */
 218         u_int32_t ips_rcv_if_weak_match; /* packets whose receive interface that passed the Weak ES address check */
 219         u_int32_t ips_rcv_if_no_match;  /* packets whose receive interface did not pass the address check */
 220 };
 221
 222 struct ip_linklocal_stat {
 223         u_int32_t       iplls_in_total;
 224         u_int32_t       iplls_in_badttl;
 225         u_int32_t       iplls_out_total;
 226         u_int32_t       iplls_out_badttl;
 227 };
 228
 229 #ifdef KERNEL_PRIVATE
 230 /* forward declarations for ip_output() */
 231 struct ip_out_args;
 232 struct ip_moptions;
 233 #endif /* KERNEL_PRIVATE */
 234
 235 #ifdef BSD_KERNEL_PRIVATE
 236 /* flags passed to ip_output as last parameter */
 237 #define IP_FORWARDING   0x1             /* most of ip header exists */
 238 #define IP_RAWOUTPUT    0x2             /* raw ip header exists */
 239 #define IP_NOIPSEC      0x4             /* No IPsec processing */
 240 #define IP_ROUTETOIF    SO_DONTROUTE    /* bypass routing tables (0x0010) */
 241 #define IP_ALLOWBROADCAST SO_BROADCAST  /* can send broadcast pkts (0x0020) */
 242 #define IP_OUTARGS      0x100           /* has ancillary output info */
 243
 244 #define IP_HDR_ALIGNED_P(_ip)   ((((uintptr_t)(_ip)) & ((uintptr_t)3)) == 0)
 245 #define IP_OFF_IS_ATOMIC(_ip_off) ((_ip_off & (IP_DF | IP_MF | IP_OFFMASK)) == IP_DF)
 246
 247 /*
 248  * On platforms which require strict alignment (currently for anything but
 249  * i386 or x86_64), this macro checks whether the pointer to the IP header
 250  * is 32-bit aligned, and assert otherwise.
 251  */
 252 #if defined(__i386__) || defined(__x86_64__)
 253 #define IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do { } while (0)
 254 #else /* !__i386__ && !__x86_64__ */
 255 #define IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do {                         \
 256         if (!IP_HDR_ALIGNED_P(_ip)) {                                   \
 257                 panic_plain("\n%s: Unaligned IP header %p\n",           \
 258                     __func__, _ip);                                     \
 259         }                                                               \
 260 } while (0)
 261 #endif /* !__i386__ && !__x86_64__ */
 262
 263 struct ip;
 264 struct inpcb;
 265 struct route;
 266 struct sockopt;
 267
 268 #include <kern/zalloc.h>
 269 #include <net/flowadv.h>
 270
 271 /*
 272  * Extra information passed to ip_output when IP_OUTARGS is set.
 273  *
 274  * Upon returning an error to the caller, ip_output may indicate through
 275  * ipoa_retflags any additional information regarding the error.
 276  */
 277 struct ip_out_args {
 278         unsigned int    ipoa_boundif;   /* boundif interface index */
 279         struct flowadv  ipoa_flowadv;   /* flow advisory code */
 280         u_int32_t       ipoa_flags;     /* IPOAF output flags (see below) */
 281 #define IPOAF_SELECT_SRCIF      0x00000001      /* src interface selection */
 282 #define IPOAF_BOUND_IF          0x00000002      /* boundif value is valid */
 283 #define IPOAF_BOUND_SRCADDR     0x00000004      /* bound to src address */
 284 #define IPOAF_NO_CELLULAR       0x00000010      /* skip IFT_CELLULAR */
 285 #define IPOAF_NO_EXPENSIVE      0x00000020      /* skip IFT_EXPENSIVE */
 286 #define IPOAF_AWDL_UNRESTRICTED 0x00000040      /* can send over
 287                                                  *  AWDL_RESTRICTED */
 288 #define IPOAF_QOSMARKING_ALLOWED        0x00000080      /* policy allows Fastlane DSCP marking */
 289 #define IPOAF_NO_CONSTRAINED    0x00000100      /* skip IFXF_CONSTRAINED */
 290 #define IPOAF_REDO_QOSMARKING_POLICY    0x00000200      /* Re-evaluate QOS marking policy */
 291         u_int32_t       ipoa_retflags;  /* IPOARF return flags (see below) */
 292 #define IPOARF_IFDENIED 0x00000001      /* denied access to interface */
 293         int             ipoa_sotc;      /* traffic class for Fastlane DSCP mapping */
 294         int             ipoa_netsvctype; /* network service type */
 295         int32_t         qos_marking_gencount;
 296 };
 297
 298 extern struct ipstat ipstat;
 299 extern int ip_use_randomid;
 300 extern u_short ip_id;                   /* ip packet ctr, for ids */
 301 extern int ip_defttl;                   /* default IP ttl */
 302 extern int ipforwarding;                /* ip forwarding */
 303 extern int rfc6864;
 304 extern struct protosw *ip_protox[];
 305 extern struct pr_usrreqs rip_usrreqs;
 306
 307 extern void ip_moptions_init(void);
 308 extern struct ip_moptions *ip_allocmoptions(zalloc_flags_t);
 309 extern int inp_getmoptions(struct inpcb *, struct sockopt *);
 310 extern int inp_setmoptions(struct inpcb *, struct sockopt *);
 311 extern void imo_addref(struct ip_moptions *, int);
 312 extern void imo_remref(struct ip_moptions *);
 313
 314 struct protosw;
 315 struct domain;
 316
 317 extern int ip_checkrouteralert(struct mbuf *);
 318 extern int ip_ctloutput(struct socket *, struct sockopt *sopt);
 319 extern void ip_drain(void);
 320 extern void ip_init(struct protosw *, struct domain *);
 321 extern int ip_output(struct mbuf *, struct mbuf *, struct route *, int,
 322     struct ip_moptions *, struct ip_out_args *);
 323 extern int ip_output_list(struct mbuf *, int, struct mbuf *, struct route *,
 324     int, struct ip_moptions *, struct ip_out_args *);
 325 extern void ip_output_checksum(struct ifnet *, struct mbuf *, int, int,
 326     uint32_t *);
 327 extern struct in_ifaddr *ip_rtaddr(struct in_addr);
 328 extern int ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
 329     struct mbuf *);
 330 extern struct mbuf *ip_srcroute(void);
 331 extern void  ip_stripoptions(struct mbuf *);
 332 extern void ip_initid(void);
 333 extern u_int16_t ip_randomid(void);
 334 extern int ip_fragment(struct mbuf *, struct ifnet *, uint32_t, int);
 335
 336 extern void ip_setsrcifaddr_info(struct mbuf *, uint32_t, struct in_ifaddr *);
 337 extern void ip_setdstifaddr_info(struct mbuf *, uint32_t, struct in_ifaddr *);
 338 extern int ip_getsrcifaddr_info(struct mbuf *, uint32_t *, uint32_t *);
 339 extern int ip_getdstifaddr_info(struct mbuf *, uint32_t *, uint32_t *);
 340
 341 extern int rip_ctloutput(struct socket *, struct sockopt *);
 342 extern void rip_ctlinput(int, struct sockaddr *, void *, struct ifnet *);
 343 extern void rip_init(struct protosw *, struct domain *);
 344 extern void rip_input(struct mbuf *, int);
 345 extern int rip_output(struct mbuf *, struct socket *, u_int32_t, struct mbuf *);
 346 extern int rip_unlock(struct socket *, int, void *);
 347 extern int rip_send(struct socket *, int, struct mbuf *, struct sockaddr *,
 348     struct mbuf *, struct proc *);
 349
 350 extern void tcp_in_cksum_stats(u_int32_t);
 351 extern void tcp_out_cksum_stats(u_int32_t);
 352
 353 extern void udp_in_cksum_stats(u_int32_t);
 354 extern void udp_out_cksum_stats(u_int32_t);
 355
 356 extern void tcp_in6_cksum_stats(u_int32_t);
 357 extern void tcp_out6_cksum_stats(u_int32_t);
 358
 359 extern void udp_in6_cksum_stats(u_int32_t);
 360 extern void udp_out6_cksum_stats(u_int32_t);
 361 #endif /* BSD_KERNEL_PRIVATE */
 362 #ifdef KERNEL_PRIVATE
 363 /* for PPP/PPTP */
 364 extern int ip_gre_output(struct mbuf *);
 365 typedef struct mbuf *(*gre_input_func_t)(struct mbuf *, int, int);
 366 extern int ip_gre_register_input(gre_input_func_t);
 367 #endif /* KERNEL_PRIVATE */
 368 #endif /* !_NETINET_IP_VAR_H_ */