bsd/netinet/ip_var.h

   1 /*
   2  * Copyright (c) 2000-2008 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 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         struct  ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
 137         u_char  imo_multicast_ttl;      /* TTL for outgoing multicasts */
 138         u_char  imo_multicast_loop;     /* 1 => hear sends if a member */
 139         u_short imo_num_memberships;    /* no. memberships this socket */
 140         struct  in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
 141         u_int32_t       imo_multicast_vif;      /* vif num outgoing multicasts */
 142         struct  in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
 143 };
 144
 145 /* mbuf tag for ip_forwarding info */
 146 struct ip_fwd_tag {
 147         struct sockaddr_in *next_hop;   /* next_hop */
 148 };
 149
 150 #endif /* KERNEL_PRIVATE */
 151
 152 struct  ipstat {
 153         u_int32_t       ips_total;              /* total packets received */
 154         u_int32_t       ips_badsum;             /* checksum bad */
 155         u_int32_t       ips_tooshort;           /* packet too short */
 156         u_int32_t       ips_toosmall;           /* not enough data */
 157         u_int32_t       ips_badhlen;            /* ip header length < data size */
 158         u_int32_t       ips_badlen;             /* ip length < ip header length */
 159         u_int32_t       ips_fragments;          /* fragments received */
 160         u_int32_t       ips_fragdropped;        /* frags dropped (dups, out of space) */
 161         u_int32_t       ips_fragtimeout;        /* fragments timed out */
 162         u_int32_t       ips_forward;            /* packets forwarded */
 163         u_int32_t       ips_fastforward;        /* packets fast forwarded */
 164         u_int32_t       ips_cantforward;        /* packets rcvd for unreachable dest */
 165         u_int32_t       ips_redirectsent;       /* packets forwarded on same net */
 166         u_int32_t       ips_noproto;            /* unknown or unsupported protocol */
 167         u_int32_t       ips_delivered;          /* datagrams delivered to upper level*/
 168         u_int32_t       ips_localout;           /* total ip packets generated here */
 169         u_int32_t       ips_odropped;           /* lost packets due to nobufs, etc. */
 170         u_int32_t       ips_reassembled;        /* total packets reassembled ok */
 171         u_int32_t       ips_fragmented;         /* datagrams successfully fragmented */
 172         u_int32_t       ips_ofragments;         /* output fragments created */
 173         u_int32_t       ips_cantfrag;           /* don't fragment flag was set, etc. */
 174         u_int32_t       ips_badoptions;         /* error in option processing */
 175         u_int32_t       ips_noroute;            /* packets discarded due to no route */
 176         u_int32_t       ips_badvers;            /* ip version != 4 */
 177         u_int32_t       ips_rawout;             /* total raw ip packets generated */
 178         u_int32_t       ips_toolong;            /* ip length > max ip packet size */
 179         u_int32_t       ips_notmember;          /* multicasts for unregistered grps */
 180         u_int32_t       ips_nogif;              /* no match gif found */
 181         u_int32_t       ips_badaddr;            /* invalid address on header */
 182 };
 183
 184 struct ip_linklocal_stat {
 185         u_int32_t       iplls_in_total;
 186         u_int32_t       iplls_in_badttl;
 187         u_int32_t       iplls_out_total;
 188         u_int32_t       iplls_out_badttl;
 189 };
 190
 191 #ifdef KERNEL_PRIVATE
 192 /* flags passed to ip_output as last parameter */
 193 #define IP_FORWARDING           0x1             /* most of ip header exists */
 194 #define IP_RAWOUTPUT            0x2             /* raw ip header exists */
 195 #define IP_NOIPSEC              0x4             /* No IPSec processing */
 196 #define IP_ROUTETOIF            SO_DONTROUTE    /* bypass routing tables (0x0010) */
 197 #define IP_ALLOWBROADCAST       SO_BROADCAST    /* can send broadcast packets (0x0020) */
 198 #define IP_OUTARGS              0x100           /* has ancillary output info */
 199
 200 struct ip;
 201 struct inpcb;
 202 struct route;
 203 struct sockopt;
 204
 205 /*
 206  * Extra information passed to ip_output when IP_OUTARGS is set.
 207  */
 208 struct ip_out_args {
 209         unsigned int    ipoa_ifscope;   /* interface scope */
 210 };
 211
 212 extern struct   ipstat  ipstat;
 213 #if !defined(RANDOM_IP_ID) || RANDOM_IP_ID == 0
 214 extern u_short  ip_id;                          /* ip packet ctr, for ids */
 215 #endif
 216 extern int      ip_defttl;                      /* default IP ttl */
 217 extern int      ipforwarding;                   /* ip forwarding */
 218 extern struct protosw *ip_protox[];
 219 extern struct socket *ip_rsvpd; /* reservation protocol daemon */
 220 extern struct socket *ip_mrouter; /* multicast routing daemon */
 221 extern int      (*legal_vif_num)(int);
 222 extern u_int32_t        (*ip_mcast_src)(int);
 223 extern int rsvp_on;
 224 extern struct   pr_usrreqs rip_usrreqs;
 225 extern int      ip_doscopedroute;
 226
 227 int      ip_ctloutput(struct socket *, struct sockopt *sopt);
 228 void     ip_drain(void);
 229 void     ip_freemoptions(struct ip_moptions *);
 230 void     ip_init(void) __attribute__((section("__TEXT, initcode")));
 231 extern int       (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
 232                           struct ip_moptions *);
 233 extern int ip_output(struct mbuf *, struct mbuf *, struct route *, int,
 234     struct ip_moptions *, struct ip_out_args *);
 235 extern int ip_output_list(struct mbuf *, int, struct mbuf *, struct route *,
 236     int, struct ip_moptions *, struct ip_out_args *);
 237 struct in_ifaddr *ip_rtaddr(struct in_addr);
 238 void     ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
 239                 struct mbuf *);
 240 void     ip_slowtimo(void);
 241 struct mbuf *
 242          ip_srcroute(void);
 243 void     ip_stripoptions(struct mbuf *, struct mbuf *);
 244 #if RANDOM_IP_ID
 245 u_int16_t
 246          ip_randomid(void);
 247 #endif
 248 int     rip_ctloutput(struct socket *, struct sockopt *);
 249 void    rip_ctlinput(int, struct sockaddr *, void *);
 250 void    rip_init(void) __attribute__((section("__TEXT, initcode")));
 251 void    rip_input(struct mbuf *, int);
 252 int     rip_output(struct mbuf *, struct socket *, u_int32_t);
 253 int     rip_unlock(struct socket *, int, void *);
 254 void    ipip_input(struct mbuf *, int);
 255 void    rsvp_input(struct mbuf *, int);
 256 int     ip_rsvp_init(struct socket *);
 257 int     ip_rsvp_done(void);
 258 int     ip_rsvp_vif_init(struct socket *, struct sockopt *);
 259 int     ip_rsvp_vif_done(struct socket *, struct sockopt *);
 260 void    ip_rsvp_force_done(struct socket *);
 261
 262 void    in_delayed_cksum(struct mbuf *m);
 263
 264 extern void tcp_in_cksum_stats(u_int32_t);
 265 extern void tcp_out_cksum_stats(u_int32_t);
 266
 267 extern void udp_in_cksum_stats(u_int32_t);
 268 extern void udp_out_cksum_stats(u_int32_t);
 269
 270 int rip_send(struct socket *, int , struct mbuf *, struct sockaddr *,
 271                         struct mbuf *, struct proc *);
 272
 273 extern int ip_fragment(struct mbuf *, struct ifnet *, unsigned long, int);
 274
 275 #endif /* KERNEL_PRIVATE */
 276 #endif /* !_NETINET_IP_VAR_H_ */