bsd/netinet/ip_var.h

   1 /*
   2  * Copyright (c) 2000-2012 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 KERNEL_PRIVATE
  85 #if CONFIG_MACF_NET
  86 struct label;
  87 #endif
  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         struct  ipq *next,*prev;        /* to other reass headers */
  96         u_char  ipq_ttl;                /* time for reass q to live */
  97         u_char  ipq_p;                  /* protocol of this fragment */
  98         u_short ipq_id;                 /* sequence id for reassembly */
  99         struct mbuf *ipq_frags;         /* to ip headers of fragments */
 100         struct  in_addr ipq_src,ipq_dst;
 101         u_int32_t       ipq_nfrags;
 102         TAILQ_ENTRY(ipq) ipq_list;
 103 #if CONFIG_MACF_NET
 104         struct label *ipq_label;        /* MAC label */
 105 #endif
 106 #if IPDIVERT
 107 #ifdef IPDIVERT_44
 108         u_int32_t ipq_div_info;         /* ipfw divert port & flags */
 109 #else
 110         u_int16_t ipq_divert;           /* ipfw divert port (Maintain backward compat.) */
 111 #endif
 112         u_int16_t ipq_div_cookie;       /* ipfw divert cookie */
 113 #endif
 114 };
 115
 116 /*
 117  * Structure stored in mbuf in inpcb.ip_options
 118  * and passed to ip_output when ip options are in use.
 119  * The actual length of the options (including ipopt_dst)
 120  * is in m_len.
 121  */
 122 #endif /* KERNEL_PRIVATE */
 123 #define MAX_IPOPTLEN    40
 124 #ifdef XNU_KERNEL_PRIVATE
 125
 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
 186 #endif /* XNU_KERNEL_PRIVATE */
 187
 188 struct  ipstat {
 189         u_int32_t       ips_total;              /* total packets received */
 190         u_int32_t       ips_badsum;             /* checksum bad */
 191         u_int32_t       ips_tooshort;           /* packet too short */
 192         u_int32_t       ips_toosmall;           /* not enough data */
 193         u_int32_t       ips_badhlen;            /* ip header length < data size */
 194         u_int32_t       ips_badlen;             /* ip length < ip header length */
 195         u_int32_t       ips_fragments;          /* fragments received */
 196         u_int32_t       ips_fragdropped;        /* frags dropped (dups, out of space) */
 197         u_int32_t       ips_fragtimeout;        /* fragments timed out */
 198         u_int32_t       ips_forward;            /* packets forwarded */
 199         u_int32_t       ips_fastforward;        /* packets fast forwarded */
 200         u_int32_t       ips_cantforward;        /* packets rcvd for unreachable dest */
 201         u_int32_t       ips_redirectsent;       /* packets forwarded on same net */
 202         u_int32_t       ips_noproto;            /* unknown or unsupported protocol */
 203         u_int32_t       ips_delivered;          /* datagrams delivered to upper level*/
 204         u_int32_t       ips_localout;           /* total ip packets generated here */
 205         u_int32_t       ips_odropped;           /* lost packets due to nobufs, etc. */
 206         u_int32_t       ips_reassembled;        /* total packets reassembled ok */
 207         u_int32_t       ips_fragmented;         /* datagrams successfully fragmented */
 208         u_int32_t       ips_ofragments;         /* output fragments created */
 209         u_int32_t       ips_cantfrag;           /* don't fragment flag was set, etc. */
 210         u_int32_t       ips_badoptions;         /* error in option processing */
 211         u_int32_t       ips_noroute;            /* packets discarded due to no route */
 212         u_int32_t       ips_badvers;            /* ip version != 4 */
 213         u_int32_t       ips_rawout;             /* total raw ip packets generated */
 214         u_int32_t       ips_toolong;            /* ip length > max ip packet size */
 215         u_int32_t       ips_notmember;          /* multicasts for unregistered grps */
 216         u_int32_t       ips_nogif;              /* no match gif found */
 217         u_int32_t       ips_badaddr;            /* invalid address on header */
 218 #ifdef PRIVATE
 219         u_int32_t       ips_pktdropcntrl;               /* pkt dropped, no mbufs for control data */
 220 #endif /* PRIVATE */
 221 };
 222
 223 struct ip_linklocal_stat {
 224         u_int32_t       iplls_in_total;
 225         u_int32_t       iplls_in_badttl;
 226         u_int32_t       iplls_out_total;
 227         u_int32_t       iplls_out_badttl;
 228 };
 229
 230 #ifdef KERNEL_PRIVATE
 231 /* flags passed to ip_output as last parameter */
 232 #define IP_FORWARDING           0x1             /* most of ip header exists */
 233 #define IP_RAWOUTPUT            0x2             /* raw ip header exists */
 234 #define IP_NOIPSEC              0x4             /* No IPSec processing */
 235 #define IP_ROUTETOIF            SO_DONTROUTE    /* bypass routing tables (0x0010) */
 236 #define IP_ALLOWBROADCAST       SO_BROADCAST    /* can send broadcast packets (0x0020) */
 237 #define IP_OUTARGS              0x100           /* has ancillary output info */
 238
 239 #ifdef XNU_KERNEL_PRIVATE
 240 #define IP_HDR_ALIGNED_P(_ip)   ((((uintptr_t)(_ip)) & ((uintptr_t)3)) == 0)
 241
 242 /*
 243  * On platforms which require strict alignment (currently for anything but
 244  * i386 or x86_64), this macro checks whether the pointer to the IP header
 245  * is 32-bit aligned, and assert otherwise.
 246  */
 247 #if defined(__i386__) || defined(__x86_64__)
 248 #define IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do { } while (0)
 249 #else /* !__i386__ && !__x86_64__ */
 250 #define IP_HDR_STRICT_ALIGNMENT_CHECK(_ip) do {                         \
 251         if (!IP_HDR_ALIGNED_P(_ip)) {                                   \
 252                 panic_plain("\n%s: Unaligned IP header %p\n",           \
 253                     __func__, _ip);                                     \
 254         }                                                               \
 255 } while (0)
 256 #endif /* !__i386__ && !__x86_64__ */
 257 #endif /* XNU_KERNEL_PRIVATE */
 258
 259 struct ip;
 260 struct inpcb;
 261 struct route;
 262 struct sockopt;
 263
 264 #include <net/flowadv.h>
 265
 266 /*
 267  * Extra information passed to ip_output when IP_OUTARGS is set.
 268  */
 269 struct ip_out_args {
 270         unsigned int    ipoa_boundif;   /* boundif interface index */
 271         struct flowadv  ipoa_flowadv;   /* flow advisory code */
 272         u_int32_t       ipoa_flags;     /* IPOAF flags (see below) */
 273 #define IPOAF_SELECT_SRCIF      0x00000001      /* src interface selection */
 274 #define IPOAF_BOUND_IF          0x00000002      /* boundif value is valid */
 275 #define IPOAF_BOUND_SRCADDR     0x00000004      /* bound to src address */
 276 #define IPOAF_NO_CELLULAR       0x00000010      /* skip IFT_CELLULAR */
 277 };
 278
 279 extern struct   ipstat  ipstat;
 280 #if !defined(RANDOM_IP_ID) || RANDOM_IP_ID == 0
 281 extern u_short  ip_id;                          /* ip packet ctr, for ids */
 282 #endif
 283 extern int      ip_defttl;                      /* default IP ttl */
 284 extern int      ipforwarding;                   /* ip forwarding */
 285 extern struct protosw *ip_protox[];
 286 extern struct socket *ip_rsvpd; /* reservation protocol daemon */
 287 extern struct socket *ip_mrouter; /* multicast routing daemon */
 288 extern int      (*legal_vif_num)(int);
 289 extern u_int32_t        (*ip_mcast_src)(int);
 290 extern int rsvp_on;
 291 extern struct   pr_usrreqs rip_usrreqs;
 292 extern int      ip_doscopedroute;
 293 extern int      ip_restrictrecvif;
 294
 295 extern void ip_moptions_init(void);
 296 extern struct ip_moptions *ip_allocmoptions(int);
 297 extern int inp_getmoptions(struct inpcb *, struct sockopt *);
 298 extern int inp_setmoptions(struct inpcb *, struct sockopt *);
 299 extern void imo_addref(struct ip_moptions *, int);
 300 extern void imo_remref(struct ip_moptions *);
 301
 302 int      ip_ctloutput(struct socket *, struct sockopt *sopt);
 303 void     ip_drain(void);
 304 void     ip_init(void) __attribute__((section("__TEXT, initcode")));
 305 extern int       (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
 306                           struct ip_moptions *);
 307 extern int ip_output(struct mbuf *, struct mbuf *, struct route *, int,
 308     struct ip_moptions *, struct ip_out_args *);
 309 extern int ip_output_list(struct mbuf *, int, struct mbuf *, struct route *,
 310     int, struct ip_moptions *, struct ip_out_args *);
 311 struct in_ifaddr *ip_rtaddr(struct in_addr);
 312 int      ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
 313                 struct mbuf *);
 314 void     ip_slowtimo(void);
 315 struct mbuf *
 316          ip_srcroute(void);
 317 void     ip_stripoptions(struct mbuf *, struct mbuf *);
 318 #if RANDOM_IP_ID
 319 u_int16_t
 320          ip_randomid(void);
 321 #endif
 322 int     rip_ctloutput(struct socket *, struct sockopt *);
 323 void    rip_ctlinput(int, struct sockaddr *, void *);
 324 void    rip_init(void) __attribute__((section("__TEXT, initcode")));
 325 void    rip_input(struct mbuf *, int);
 326 int     rip_output(struct mbuf *, struct socket *, u_int32_t, struct mbuf *);
 327 int     rip_unlock(struct socket *, int, void *);
 328 void    ipip_input(struct mbuf *, int);
 329 void    rsvp_input(struct mbuf *, int);
 330 int     ip_rsvp_init(struct socket *);
 331 int     ip_rsvp_done(void);
 332 int     ip_rsvp_vif_init(struct socket *, struct sockopt *);
 333 int     ip_rsvp_vif_done(struct socket *, struct sockopt *);
 334 void    ip_rsvp_force_done(struct socket *);
 335 void    ip_proto_dispatch_in_wrapper(struct mbuf *, int, u_int8_t);
 336 void    in_delayed_cksum(struct mbuf *m);
 337
 338 extern void tcp_in_cksum_stats(u_int32_t);
 339 extern void tcp_out_cksum_stats(u_int32_t);
 340
 341 extern void udp_in_cksum_stats(u_int32_t);
 342 extern void udp_out_cksum_stats(u_int32_t);
 343
 344 int rip_send(struct socket *, int , struct mbuf *, struct sockaddr *,
 345                         struct mbuf *, struct proc *);
 346
 347 extern int ip_fragment(struct mbuf *, struct ifnet *, unsigned long, int);
 348
 349 #endif /* KERNEL_PRIVATE */
 350 #endif /* !_NETINET_IP_VAR_H_ */