]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/netinet/ip_var.h
xnu-3789.1.32.tar.gz
[apple/xnu.git] / bsd / netinet / ip_var.h
index 014abb2f3dbbdad2b8ef9a16f5a35d1b0d39d5ac..cc54d85d86ad6e835e3ba7db0760b92909414ae9 100644 (file)
@@ -1,15 +1,20 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
@@ -17,8 +22,8 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * Copyright (c) 1982, 1986, 1993
  *
  *     @(#)ip_var.h    8.2 (Berkeley) 1/9/95
  */
+/*
+ * NOTICE: This file was modified by SPARTA, Inc. in 2007 to introduce
+ * support for mandatory and extensible security protections.  This notice
+ * is included in support of clause 2.2 (b) of the Apple Public License,
+ * Version 2.0.
+ */
 
 #ifndef _NETINET_IP_VAR_H_
 #define        _NETINET_IP_VAR_H_
@@ -70,7 +81,10 @@ struct ipovly {
        struct  in_addr ih_dst;         /* destination internet address */
 };
 
-#ifdef KERNEL_PRIVATE
+#ifdef BSD_KERNEL_PRIVATE
+#if CONFIG_MACF_NET
+struct label;
+#endif /* CONFIG_MACF_NET */
 /*
  * Ip reassembly queue structure.  Each fragment
  * being reassembled is attached to one of these structures.
@@ -78,23 +92,26 @@ struct ipovly {
  * be reclaimed if memory becomes tight.
  */
 struct ipq {
-       struct  ipq *next,*prev;        /* to other reass headers */
+       TAILQ_ENTRY(ipq) ipq_list;      /* to other reass headers */
+       struct mbuf *ipq_frags;         /* to ip headers of fragments */
+#if CONFIG_MACF_NET
+       struct label *ipq_label;        /* MAC label */
+#endif /* CONFIG_MACF_NET */
        u_char  ipq_ttl;                /* time for reass q to live */
        u_char  ipq_p;                  /* protocol of this fragment */
        u_short ipq_id;                 /* sequence id for reassembly */
-       struct mbuf *ipq_frags;         /* to ip headers of fragments */
-       struct  in_addr ipq_src,ipq_dst;
-       u_long  ipq_nfrags;
-       TAILQ_ENTRY(ipq) ipq_list;
-       u_long  reserved[1];            /* for future use */
+       struct  in_addr ipq_src, ipq_dst;
+       u_int32_t       ipq_nfrags;     /* # frags in this packet */
+       uint32_t ipq_csum_flags;        /* checksum flags */
+       uint32_t ipq_csum;              /* partial checksum value */
 #if IPDIVERT
 #ifdef IPDIVERT_44
        u_int32_t ipq_div_info;         /* ipfw divert port & flags */
-#else
-       u_int16_t ipq_divert;           /* ipfw divert port (Maintain backward compat.) */
-#endif
+#else /* !IPDIVERT_44 */
+       u_int16_t ipq_divert;           /* ipfw divert port (legacy) */
+#endif /* !IPDIVERT_44 */
        u_int16_t ipq_div_cookie;       /* ipfw divert cookie */
-#endif
+#endif /* IPDIVERT */
 };
 
 /*
@@ -103,10 +120,9 @@ struct ipq {
  * The actual length of the options (including ipopt_dst)
  * is in m_len.
  */
-#endif /* KERNEL_PRIVATE */
-#define MAX_IPOPTLEN   40
-#ifdef KERNEL_PRIVATE
-
+#endif /* BSD_KERNEL_PRIVATE */
+#define        MAX_IPOPTLEN    40
+#ifdef BSD_KERNEL_PRIVATE
 struct ipoption {
        struct  in_addr ipopt_dst;      /* first-hop dst if source routed */
        char    ipopt_list[MAX_IPOPTLEN];       /* options proper */
@@ -117,125 +133,245 @@ struct ipoption {
  * passed to ip_output when IP multicast options are in use.
  */
 struct ip_moptions {
+       decl_lck_mtx_data(, imo_lock);
+       uint32_t imo_refcnt;            /* ref count */
+       uint32_t imo_debug;             /* see ifa_debug flags */
        struct  ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
        u_char  imo_multicast_ttl;      /* TTL for outgoing multicasts */
        u_char  imo_multicast_loop;     /* 1 => hear sends if a member */
        u_short imo_num_memberships;    /* no. memberships this socket */
-       struct  in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
-       u_long  imo_multicast_vif;      /* vif num outgoing multicasts */
+       u_short imo_max_memberships;    /* max memberships this socket */
+       struct  in_multi **imo_membership;      /* group memberships */
+       struct  in_mfilter *imo_mfilters;       /* source filters */
+       u_int32_t imo_multicast_vif;    /* vif num outgoing multicasts */
        struct  in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
+       void (*imo_trace)               /* callback fn for tracing refs */
+           (struct ip_moptions *, int);
 };
 
+#define        IMO_LOCK_ASSERT_HELD(_imo)                                      \
+       lck_mtx_assert(&(_imo)->imo_lock, LCK_MTX_ASSERT_OWNED)
+
+#define        IMO_LOCK_ASSERT_NOTHELD(_imo)                                   \
+       lck_mtx_assert(&(_imo)->imo_lock, LCK_MTX_ASSERT_NOTOWNED)
+
+#define        IMO_LOCK(_imo)                                                  \
+       lck_mtx_lock(&(_imo)->imo_lock)
+
+#define        IMO_LOCK_SPIN(_imo)                                             \
+       lck_mtx_lock_spin(&(_imo)->imo_lock)
+
+#define        IMO_CONVERT_LOCK(_imo) do {                                     \
+       IMO_LOCK_ASSERT_HELD(_imo);                                     \
+       lck_mtx_convert_spin(&(_imo)->imo_lock);                        \
+} while (0)
+
+#define        IMO_UNLOCK(_imo)                                                \
+       lck_mtx_unlock(&(_imo)->imo_lock)
+
+#define        IMO_ADDREF(_imo)                                                \
+       imo_addref(_imo, 0)
+
+#define        IMO_ADDREF_LOCKED(_imo)                                         \
+       imo_addref(_imo, 1)
+
+#define        IMO_REMREF(_imo)                                                \
+       imo_remref(_imo)
+
 /* mbuf tag for ip_forwarding info */
 struct ip_fwd_tag {
        struct sockaddr_in *next_hop;   /* next_hop */
 };
-
-#endif /* KERNEL_PRIVATE */
+#endif /* BSD_KERNEL_PRIVATE */
 
 struct ipstat {
-       u_long  ips_total;              /* total packets received */
-       u_long  ips_badsum;             /* checksum bad */
-       u_long  ips_tooshort;           /* packet too short */
-       u_long  ips_toosmall;           /* not enough data */
-       u_long  ips_badhlen;            /* ip header length < data size */
-       u_long  ips_badlen;             /* ip length < ip header length */
-       u_long  ips_fragments;          /* fragments received */
-       u_long  ips_fragdropped;        /* frags dropped (dups, out of space) */
-       u_long  ips_fragtimeout;        /* fragments timed out */
-       u_long  ips_forward;            /* packets forwarded */
-       u_long  ips_fastforward;        /* packets fast forwarded */
-       u_long  ips_cantforward;        /* packets rcvd for unreachable dest */
-       u_long  ips_redirectsent;       /* packets forwarded on same net */
-       u_long  ips_noproto;            /* unknown or unsupported protocol */
-       u_long  ips_delivered;          /* datagrams delivered to upper level*/
-       u_long  ips_localout;           /* total ip packets generated here */
-       u_long  ips_odropped;           /* lost packets due to nobufs, etc. */
-       u_long  ips_reassembled;        /* total packets reassembled ok */
-       u_long  ips_fragmented;         /* datagrams successfully fragmented */
-       u_long  ips_ofragments;         /* output fragments created */
-       u_long  ips_cantfrag;           /* don't fragment flag was set, etc. */
-       u_long  ips_badoptions;         /* error in option processing */
-       u_long  ips_noroute;            /* packets discarded due to no route */
-       u_long  ips_badvers;            /* ip version != 4 */
-       u_long  ips_rawout;             /* total raw ip packets generated */
-       u_long  ips_toolong;            /* ip length > max ip packet size */
-       u_long  ips_notmember;          /* multicasts for unregistered grps */
-       u_long  ips_nogif;              /* no match gif found */
-       u_long  ips_badaddr;            /* invalid address on header */
+       u_int32_t ips_total;            /* total packets received */
+       u_int32_t ips_badsum;           /* checksum bad */
+       u_int32_t ips_tooshort;         /* packet too short */
+       u_int32_t ips_toosmall;         /* not enough data */
+       u_int32_t ips_badhlen;          /* ip header length < data size */
+       u_int32_t ips_badlen;           /* ip length < ip header length */
+       u_int32_t ips_fragments;        /* fragments received */
+       u_int32_t ips_fragdropped;      /* frags dropped (dups, out of space) */
+       u_int32_t ips_fragtimeout;      /* fragments timed out */
+       u_int32_t ips_forward;          /* packets forwarded */
+       u_int32_t ips_fastforward;      /* packets fast forwarded */
+       u_int32_t ips_cantforward;      /* packets rcvd for unreachable dest */
+       u_int32_t ips_redirectsent;     /* packets forwarded on same net */
+       u_int32_t ips_noproto;          /* unknown or unsupported protocol */
+       u_int32_t ips_delivered;        /* datagrams delivered to upper level */
+       u_int32_t ips_localout;         /* total ip packets generated here */
+       u_int32_t ips_odropped;         /* lost packets due to nobufs, etc. */
+       u_int32_t ips_reassembled;      /* total packets reassembled ok */
+       u_int32_t ips_fragmented;       /* datagrams successfully fragmented */
+       u_int32_t ips_ofragments;       /* output fragments created */
+       u_int32_t ips_cantfrag;         /* don't fragment flag was set, etc. */
+       u_int32_t ips_badoptions;       /* error in option processing */
+       u_int32_t ips_noroute;          /* packets discarded due to no route */
+       u_int32_t ips_badvers;          /* ip version != 4 */
+       u_int32_t ips_rawout;           /* total raw ip packets generated */
+       u_int32_t ips_toolong;          /* ip length > max ip packet size */
+       u_int32_t ips_notmember;        /* multicasts for unregistered grps */
+       u_int32_t ips_nogif;            /* no match gif found */
+       u_int32_t ips_badaddr;          /* invalid address on header */
+       u_int32_t ips_pktdropcntrl;     /* pkt dropped, no mbufs for ctl data */
+       u_int32_t ips_rcv_swcsum;       /* ip hdr swcksum (inbound), packets */
+       u_int32_t ips_rcv_swcsum_bytes; /* ip hdr swcksum (inbound), bytes */
+       u_int32_t ips_snd_swcsum;       /* ip hdr swcksum (outbound), packets */
+       u_int32_t ips_snd_swcsum_bytes; /* ip hdr swcksum (outbound), bytes */
+       u_int32_t ips_adj;              /* total packets trimmed/adjusted */
+       u_int32_t ips_adj_hwcsum_clr;   /* hwcksum discarded during adj */
+       u_int32_t ips_rxc_collisions;   /* rx chaining collisions */
+       u_int32_t ips_rxc_chained;      /* rx chains */
+       u_int32_t ips_rxc_notchain;     /* rx bypassed chaining */
+       u_int32_t ips_rxc_chainsz_gt2;  /* rx chain size greater than 2 */
+       u_int32_t ips_rxc_chainsz_gt4;  /* rx chain size greater than 4 */
+       u_int32_t ips_rxc_notlist;      /* count of pkts through ip_input */
+       u_int32_t ips_raw_sappend_fail; /* sock append failed */
+
 };
 
 struct ip_linklocal_stat {
-       u_long iplls_in_total;
-       u_long iplls_in_badttl;
-       u_long iplls_out_total;
-       u_long iplls_out_badttl;
+       u_int32_t       iplls_in_total;
+       u_int32_t       iplls_in_badttl;
+       u_int32_t       iplls_out_total;
+       u_int32_t       iplls_out_badttl;
 };
 
 #ifdef KERNEL_PRIVATE
+/* forward declarations for ip_output() */
+struct ip_out_args;
+struct ip_moptions;
+#endif /* KERNEL_PRIVATE */
+
+#ifdef BSD_KERNEL_PRIVATE
 /* flags passed to ip_output as last parameter */
-#define        IP_FORWARDING           0x1             /* most of ip header exists */
-#define        IP_RAWOUTPUT            0x2             /* raw ip header exists */
-#define        IP_NOIPSEC                      0x4             /* No IPSec processing */
-#define        IP_ROUTETOIF            SO_DONTROUTE    /* bypass routing tables (0x0010) */
-#define        IP_ALLOWBROADCAST       SO_BROADCAST    /* can send broadcast packets (0x0020) */
+#define        IP_FORWARDING   0x1             /* most of ip header exists */
+#define        IP_RAWOUTPUT    0x2             /* raw ip header exists */
+#define        IP_NOIPSEC      0x4             /* No IPSec processing */
+#define        IP_ROUTETOIF    SO_DONTROUTE    /* bypass routing tables (0x0010) */
+#define        IP_ALLOWBROADCAST SO_BROADCAST  /* can send broadcast pkts (0x0020) */
+#define        IP_OUTARGS      0x100           /* has ancillary output info */
+
+#define        IP_HDR_ALIGNED_P(_ip)   ((((uintptr_t)(_ip)) & ((uintptr_t)3)) == 0)
+
+/*
+ * On platforms which require strict alignment (currently for anything but
+ * i386 or x86_64), this macro checks whether the pointer to the IP header
+ * is 32-bit aligned, and assert otherwise.
+ */
+#if defined(__i386__) || defined(__x86_64__)
+#define        IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do { } while (0)
+#else /* !__i386__ && !__x86_64__ */
+#define        IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do {                         \
+       if (!IP_HDR_ALIGNED_P(_ip)) {                                   \
+               panic_plain("\n%s: Unaligned IP header %p\n",           \
+                   __func__, _ip);                                     \
+       }                                                               \
+} while (0)
+#endif /* !__i386__ && !__x86_64__ */
 
 struct ip;
 struct inpcb;
 struct route;
 struct sockopt;
 
-extern struct  ipstat  ipstat;
-#if !defined(RANDOM_IP_ID) || RANDOM_IP_ID == 0
-extern u_short ip_id;                          /* ip packet ctr, for ids */
-#endif
-extern int     ip_defttl;                      /* default IP ttl */
-extern int     ipforwarding;                   /* ip forwarding */
+#include <net/flowadv.h>
+
+/*
+ * Extra information passed to ip_output when IP_OUTARGS is set.
+ *
+ * Upon returning an error to the caller, ip_output may indicate through
+ * ipoa_retflags any additional information regarding the error.
+ */
+struct ip_out_args {
+       unsigned int    ipoa_boundif;   /* boundif interface index */
+       struct flowadv  ipoa_flowadv;   /* flow advisory code */
+       u_int32_t       ipoa_flags;     /* IPOAF output flags (see below) */
+#define        IPOAF_SELECT_SRCIF      0x00000001      /* src interface selection */
+#define        IPOAF_BOUND_IF          0x00000002      /* boundif value is valid */
+#define        IPOAF_BOUND_SRCADDR     0x00000004      /* bound to src address */
+#define        IPOAF_NO_CELLULAR       0x00000010      /* skip IFT_CELLULAR */
+#define        IPOAF_NO_EXPENSIVE      0x00000020      /* skip IFT_EXPENSIVE */
+#define        IPOAF_AWDL_UNRESTRICTED 0x00000040      /* can send over 
+                                                  AWDL_RESTRICTED */
+#define        IPOAF_QOSMARKING_ALLOWED        0x00000080      /* policy allows Fastlane DSCP marking */
+       u_int32_t       ipoa_retflags;  /* IPOARF return flags (see below) */
+#define        IPOARF_IFDENIED 0x00000001      /* denied access to interface */
+       int             ipoa_sotc;      /* traffic class for Fastlane DSCP mapping */
+       int             ipoa_netsvctype; /* network service type */
+};
+
+extern struct ipstat ipstat;
+extern int ip_use_randomid;
+extern u_short ip_id;                  /* ip packet ctr, for ids */
+extern int ip_defttl;                  /* default IP ttl */
+extern int ipforwarding;               /* ip forwarding */
 extern struct protosw *ip_protox[];
-extern struct socket *ip_rsvpd;        /* reservation protocol daemon */
-extern struct socket *ip_mrouter; /* multicast routing daemon */
-extern int     (*legal_vif_num)(int);
-extern u_long  (*ip_mcast_src)(int);
-extern int rsvp_on;
-extern struct  pr_usrreqs rip_usrreqs;
-
-int     ip_ctloutput(struct socket *, struct sockopt *sopt);
-void    ip_drain(void);
-void    ip_freemoptions(struct ip_moptions *);
-void    ip_init(void);
-extern int      (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
-                         struct ip_moptions *);
-int     ip_output(struct mbuf *,
-           struct mbuf *, struct route *, int, struct ip_moptions *);
-int     ip_output_list(struct mbuf *, int,
-           struct mbuf *, struct route *, int, struct ip_moptions *);
-struct in_ifaddr *
-        ip_rtaddr(struct in_addr, struct route *);
-void    ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
-               struct mbuf *);
-void    ip_slowtimo(void);
-struct mbuf *
-        ip_srcroute(void);
-void    ip_stripoptions(struct mbuf *, struct mbuf *);
-#if RANDOM_IP_ID
-u_int16_t      
-        ip_randomid(void);
-#endif
-int    rip_ctloutput(struct socket *, struct sockopt *);
-void   rip_ctlinput(int, struct sockaddr *, void *);
-void   rip_init(void);
-void   rip_input(struct mbuf *, int);
-int    rip_output(struct mbuf *, struct socket *, u_long);
-int    rip_unlock(struct socket *, int, int);
-void   ipip_input(struct mbuf *, int);
-void   rsvp_input(struct mbuf *, int);
-int    ip_rsvp_init(struct socket *);
-int    ip_rsvp_done(void);
-int    ip_rsvp_vif_init(struct socket *, struct sockopt *);
-int    ip_rsvp_vif_done(struct socket *, struct sockopt *);
-void   ip_rsvp_force_done(struct socket *);
-
-void   in_delayed_cksum(struct mbuf *m);
-
-#endif KERNEL_PRIVATE
-#endif !_NETINET_IP_VAR_H_
+extern struct pr_usrreqs rip_usrreqs;
+
+extern void ip_moptions_init(void);
+extern struct ip_moptions *ip_allocmoptions(int);
+extern int inp_getmoptions(struct inpcb *, struct sockopt *);
+extern int inp_setmoptions(struct inpcb *, struct sockopt *);
+extern void imo_addref(struct ip_moptions *, int);
+extern void imo_remref(struct ip_moptions *);
+
+struct protosw;
+struct domain;
+
+extern int ip_checkrouteralert(struct mbuf *);
+extern int ip_ctloutput(struct socket *, struct sockopt *sopt);
+extern void ip_drain(void);
+extern void ip_init(struct protosw *, struct domain *);
+extern int ip_output(struct mbuf *, struct mbuf *, struct route *, int,
+    struct ip_moptions *, struct ip_out_args *);
+extern int ip_output_list(struct mbuf *, int, struct mbuf *, struct route *,
+    int, struct ip_moptions *, struct ip_out_args *);
+extern void ip_output_checksum(struct ifnet *, struct mbuf *, int, int,
+    uint32_t *);
+extern struct in_ifaddr *ip_rtaddr(struct in_addr);
+extern int ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
+    struct mbuf *);
+extern struct mbuf *ip_srcroute(void);
+extern void  ip_stripoptions(struct mbuf *, struct mbuf *);
+extern void ip_initid(void);
+extern u_int16_t ip_randomid(void);
+extern void ip_proto_dispatch_in_wrapper(struct mbuf *, int, u_int8_t);
+extern int ip_fragment(struct mbuf *, struct ifnet *, unsigned long, int);
+
+extern void ip_setsrcifaddr_info(struct mbuf *, uint32_t, struct in_ifaddr *);
+extern void ip_setdstifaddr_info(struct mbuf *, uint32_t, struct in_ifaddr *);
+extern int ip_getsrcifaddr_info(struct mbuf *, uint32_t *, uint32_t *);
+extern int ip_getdstifaddr_info(struct mbuf *, uint32_t *, uint32_t *);
+
+extern int rip_ctloutput(struct socket *, struct sockopt *);
+extern void rip_ctlinput(int, struct sockaddr *, void *);
+extern void rip_init(struct protosw *, struct domain *);
+extern void rip_input(struct mbuf *, int);
+extern int rip_output(struct mbuf *, struct socket *, u_int32_t, struct mbuf *);
+extern int rip_unlock(struct socket *, int, void *);
+extern int rip_send(struct socket *, int, struct mbuf *, struct sockaddr *,
+    struct mbuf *, struct proc *);
+
+extern void tcp_in_cksum_stats(u_int32_t);
+extern void tcp_out_cksum_stats(u_int32_t);
+
+extern void udp_in_cksum_stats(u_int32_t);
+extern void udp_out_cksum_stats(u_int32_t);
+
+#if INET6
+extern void tcp_in6_cksum_stats(u_int32_t);
+extern void tcp_out6_cksum_stats(u_int32_t);
+
+extern void udp_in6_cksum_stats(u_int32_t);
+extern void udp_out6_cksum_stats(u_int32_t);
+#endif /* INET6 */
+#endif /* BSD_KERNEL_PRIVATE */
+#ifdef KERNEL_PRIVATE
+/* for PPP/PPTP */
+extern int ip_gre_output(struct mbuf *);
+typedef struct mbuf *(*gre_input_func_t)(struct mbuf *, int, int);
+extern int ip_gre_register_input(gre_input_func_t);
+#endif /* KERNEL_PRIVATE */
+#endif /* !_NETINET_IP_VAR_H_ */