bsd/netinet/ip_var.h

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