bsd/netinet/ip_var.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * Copyright (c) 1982, 1986, 1993
  32  *      The Regents of the University of California.  All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. All advertising materials mentioning features or use of this software
  43  *    must display the following acknowledgement:
  44  *      This product includes software developed by the University of
  45  *      California, Berkeley and its contributors.
  46  * 4. Neither the name of the University nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60  * SUCH DAMAGE.
  61  *
  62  *      @(#)ip_var.h    8.2 (Berkeley) 1/9/95
  63  */
  64
  65 #ifndef _NETINET_IP_VAR_H_
  66 #define _NETINET_IP_VAR_H_
  67 #include <sys/appleapiopts.h>
  68
  69 /*
  70  * Overlay for ip header used by other protocols (tcp, udp).
  71  */
  72 struct ipovly {
  73         u_char  ih_x1[9];               /* (unused) */
  74         u_char  ih_pr;                  /* protocol */
  75         u_short ih_len;                 /* protocol length */
  76         struct  in_addr ih_src;         /* source internet address */
  77         struct  in_addr ih_dst;         /* destination internet address */
  78 };
  79
  80 #ifdef KERNEL_PRIVATE
  81 /*
  82  * Ip reassembly queue structure.  Each fragment
  83  * being reassembled is attached to one of these structures.
  84  * They are timed out after ipq_ttl drops to 0, and may also
  85  * be reclaimed if memory becomes tight.
  86  */
  87 struct ipq {
  88         struct  ipq *next,*prev;        /* to other reass headers */
  89         u_char  ipq_ttl;                /* time for reass q to live */
  90         u_char  ipq_p;                  /* protocol of this fragment */
  91         u_short ipq_id;                 /* sequence id for reassembly */
  92         struct mbuf *ipq_frags;         /* to ip headers of fragments */
  93         struct  in_addr ipq_src,ipq_dst;
  94         u_long  ipq_nfrags;
  95         TAILQ_ENTRY(ipq) ipq_list;
  96         u_long  reserved[1];            /* for future use */
  97 #if IPDIVERT
  98 #ifdef IPDIVERT_44
  99         u_int32_t ipq_div_info;         /* ipfw divert port & flags */
 100 #else
 101         u_int16_t ipq_divert;           /* ipfw divert port (Maintain backward compat.) */
 102 #endif
 103         u_int16_t ipq_div_cookie;       /* ipfw divert cookie */
 104 #endif
 105 };
 106
 107 /*
 108  * Structure stored in mbuf in inpcb.ip_options
 109  * and passed to ip_output when ip options are in use.
 110  * The actual length of the options (including ipopt_dst)
 111  * is in m_len.
 112  */
 113 #endif /* KERNEL_PRIVATE */
 114 #define MAX_IPOPTLEN    40
 115 #ifdef KERNEL_PRIVATE
 116
 117 struct ipoption {
 118         struct  in_addr ipopt_dst;      /* first-hop dst if source routed */
 119         char    ipopt_list[MAX_IPOPTLEN];       /* options proper */
 120 };
 121
 122 /*
 123  * Structure attached to inpcb.ip_moptions and
 124  * passed to ip_output when IP multicast options are in use.
 125  */
 126 struct ip_moptions {
 127         struct  ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
 128         u_char  imo_multicast_ttl;      /* TTL for outgoing multicasts */
 129         u_char  imo_multicast_loop;     /* 1 => hear sends if a member */
 130         u_short imo_num_memberships;    /* no. memberships this socket */
 131         struct  in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
 132         u_long  imo_multicast_vif;      /* vif num outgoing multicasts */
 133         struct  in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
 134 };
 135
 136 /* mbuf tag for ip_forwarding info */
 137 struct ip_fwd_tag {
 138         struct sockaddr_in *next_hop;   /* next_hop */
 139 };
 140
 141 #endif /* KERNEL_PRIVATE */
 142
 143 struct  ipstat {
 144         u_long  ips_total;              /* total packets received */
 145         u_long  ips_badsum;             /* checksum bad */
 146         u_long  ips_tooshort;           /* packet too short */
 147         u_long  ips_toosmall;           /* not enough data */
 148         u_long  ips_badhlen;            /* ip header length < data size */
 149         u_long  ips_badlen;             /* ip length < ip header length */
 150         u_long  ips_fragments;          /* fragments received */
 151         u_long  ips_fragdropped;        /* frags dropped (dups, out of space) */
 152         u_long  ips_fragtimeout;        /* fragments timed out */
 153         u_long  ips_forward;            /* packets forwarded */
 154         u_long  ips_fastforward;        /* packets fast forwarded */
 155         u_long  ips_cantforward;        /* packets rcvd for unreachable dest */
 156         u_long  ips_redirectsent;       /* packets forwarded on same net */
 157         u_long  ips_noproto;            /* unknown or unsupported protocol */
 158         u_long  ips_delivered;          /* datagrams delivered to upper level*/
 159         u_long  ips_localout;           /* total ip packets generated here */
 160         u_long  ips_odropped;           /* lost packets due to nobufs, etc. */
 161         u_long  ips_reassembled;        /* total packets reassembled ok */
 162         u_long  ips_fragmented;         /* datagrams successfully fragmented */
 163         u_long  ips_ofragments;         /* output fragments created */
 164         u_long  ips_cantfrag;           /* don't fragment flag was set, etc. */
 165         u_long  ips_badoptions;         /* error in option processing */
 166         u_long  ips_noroute;            /* packets discarded due to no route */
 167         u_long  ips_badvers;            /* ip version != 4 */
 168         u_long  ips_rawout;             /* total raw ip packets generated */
 169         u_long  ips_toolong;            /* ip length > max ip packet size */
 170         u_long  ips_notmember;          /* multicasts for unregistered grps */
 171         u_long  ips_nogif;              /* no match gif found */
 172         u_long  ips_badaddr;            /* invalid address on header */
 173 };
 174
 175 struct ip_linklocal_stat {
 176         u_long iplls_in_total;
 177         u_long iplls_in_badttl;
 178         u_long iplls_out_total;
 179         u_long iplls_out_badttl;
 180 };
 181
 182 #ifdef KERNEL_PRIVATE
 183 /* flags passed to ip_output as last parameter */
 184 #define IP_FORWARDING           0x1             /* most of ip header exists */
 185 #define IP_RAWOUTPUT            0x2             /* raw ip header exists */
 186 #define IP_NOIPSEC                      0x4             /* No IPSec processing */
 187 #define IP_ROUTETOIF            SO_DONTROUTE    /* bypass routing tables (0x0010) */
 188 #define IP_ALLOWBROADCAST       SO_BROADCAST    /* can send broadcast packets (0x0020) */
 189
 190 struct ip;
 191 struct inpcb;
 192 struct route;
 193 struct sockopt;
 194
 195 extern struct   ipstat  ipstat;
 196 #if !defined(RANDOM_IP_ID) || RANDOM_IP_ID == 0
 197 extern u_short  ip_id;                          /* ip packet ctr, for ids */
 198 #endif
 199 extern int      ip_defttl;                      /* default IP ttl */
 200 extern int      ipforwarding;                   /* ip forwarding */
 201 extern struct protosw *ip_protox[];
 202 extern struct socket *ip_rsvpd; /* reservation protocol daemon */
 203 extern struct socket *ip_mrouter; /* multicast routing daemon */
 204 extern int      (*legal_vif_num)(int);
 205 extern u_long   (*ip_mcast_src)(int);
 206 extern int rsvp_on;
 207 extern struct   pr_usrreqs rip_usrreqs;
 208
 209 int      ip_ctloutput(struct socket *, struct sockopt *sopt);
 210 void     ip_drain(void);
 211 void     ip_freemoptions(struct ip_moptions *);
 212 void     ip_init(void);
 213 extern int       (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
 214                           struct ip_moptions *);
 215 int      ip_output(struct mbuf *,
 216             struct mbuf *, struct route *, int, struct ip_moptions *);
 217 int      ip_output_list(struct mbuf *, int,
 218             struct mbuf *, struct route *, int, struct ip_moptions *);
 219 struct in_ifaddr *
 220          ip_rtaddr(struct in_addr, struct route *);
 221 void     ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
 222                 struct mbuf *);
 223 void     ip_slowtimo(void);
 224 struct mbuf *
 225          ip_srcroute(void);
 226 void     ip_stripoptions(struct mbuf *, struct mbuf *);
 227 #if RANDOM_IP_ID
 228 u_int16_t
 229          ip_randomid(void);
 230 #endif
 231 int     rip_ctloutput(struct socket *, struct sockopt *);
 232 void    rip_ctlinput(int, struct sockaddr *, void *);
 233 void    rip_init(void);
 234 void    rip_input(struct mbuf *, int);
 235 int     rip_output(struct mbuf *, struct socket *, u_long);
 236 int     rip_unlock(struct socket *, int, int);
 237 void    ipip_input(struct mbuf *, int);
 238 void    rsvp_input(struct mbuf *, int);
 239 int     ip_rsvp_init(struct socket *);
 240 int     ip_rsvp_done(void);
 241 int     ip_rsvp_vif_init(struct socket *, struct sockopt *);
 242 int     ip_rsvp_vif_done(struct socket *, struct sockopt *);
 243 void    ip_rsvp_force_done(struct socket *);
 244
 245 void    in_delayed_cksum(struct mbuf *m);
 246
 247 #endif KERNEL_PRIVATE
 248 #endif !_NETINET_IP_VAR_H_