Remove useless belt and suspenders include guards in some of our headers.
[dragonfly.git] / sys / netinet / ip_var.h
1 /*
2  * Copyright (c) 1982, 1986, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)ip_var.h    8.2 (Berkeley) 1/9/95
34  * $FreeBSD: src/sys/netinet/ip_var.h,v 1.50.2.13 2003/08/24 08:24:38 hsu Exp $
35  */
36
37 #ifndef _NETINET_IP_VAR_H_
38 #define _NETINET_IP_VAR_H_
39
40 #ifndef _SYS_TYPES_H_
41 #include <sys/types.h>
42 #endif
43 #ifndef _SYS_QUEUE_H_
44 #include <sys/queue.h>
45 #endif
46 #ifndef _NETINET_IN_H_
47 #include <netinet/in.h>
48 #endif
49
50 #ifdef _KERNEL
51
52 #include <machine/endian.h>
53 #ifndef _MACHINE_PARAM_H_
54 #include <machine/param.h>
55 #endif
56 #ifndef _NET_ROUTE_H
57 #include <net/route.h>
58 #endif
59
60 #endif
61
62 /*
63  * Overlay for ip header used by other protocols (tcp, udp).
64  */
65 struct ipovly {
66         u_char  ih_x1[9];               /* (unused) */
67         u_char  ih_pr;                  /* protocol */
68         u_short ih_len;                 /* protocol length */
69         struct  in_addr ih_src;         /* source internet address */
70         struct  in_addr ih_dst;         /* destination internet address */
71 };
72
73 /*
74  * Ip reassembly queue structure.  Each fragment
75  * being reassembled is attached to one of these structures.
76  * They are timed out after ipq_ttl drops to 0, and may also
77  * be reclaimed if memory becomes tight.
78  */
79 struct ipq {
80         struct  ipq *next,*prev;        /* to other reass headers */
81         u_char  ipq_ttl;                /* time for reass q to live */
82         u_char  ipq_p;                  /* protocol of this fragment */
83         u_short ipq_id;                 /* sequence id for reassembly */
84         struct mbuf *ipq_frags;         /* to ip headers of fragments */
85         struct  in_addr ipq_src,ipq_dst;
86         u_char  ipq_nfrags;             /* # frags in this packet */
87 };
88
89 /*
90  * Structure stored in mbuf in inpcb.ip_options
91  * and passed to ip_output when ip options are in use.
92  * The actual length of the options (including ipopt_dst)
93  * is in m_len.
94  */
95 #define MAX_IPOPTLEN    40
96
97 struct ipoption {
98         struct  in_addr ipopt_dst;      /* first-hop dst if source routed */
99         char    ipopt_list[MAX_IPOPTLEN];       /* options proper */
100 };
101
102 /*
103  * Structure attached to inpcb.ip_moptions and
104  * passed to ip_output when IP multicast options are in use.
105  */
106 struct ip_moptions {
107         struct  ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
108         struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
109         u_char  imo_multicast_ttl;      /* TTL for outgoing multicasts */
110         u_char  imo_multicast_loop;     /* 1 => hear sends if a member */
111         u_short imo_num_memberships;    /* no. memberships this socket */
112         u_short imo_max_memberships;    /* max memberships this socket */
113         struct  in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
114         u_long  imo_multicast_vif;      /* vif num outgoing multicasts */
115 };
116
117 /*
118  * IP Statistics.
119  */
120 struct  ip_stats {
121         u_long  ips_total;              /* total packets received */
122         u_long  ips_badsum;             /* checksum bad */
123         u_long  ips_tooshort;           /* packet too short */
124         u_long  ips_toosmall;           /* not enough data */
125         u_long  ips_badhlen;            /* ip header length < data size */
126         u_long  ips_badlen;             /* ip length < ip header length */
127         u_long  ips_fragments;          /* fragments received */
128         u_long  ips_fragdropped;        /* frags dropped (dups, out of space) */
129         u_long  ips_fragtimeout;        /* fragments timed out */
130         u_long  ips_forward;            /* packets forwarded */
131         u_long  ips_fastforward;        /* packets fast forwarded */
132         u_long  ips_cantforward;        /* packets rcvd for unreachable dest */
133         u_long  ips_redirectsent;       /* packets forwarded on same net */
134         u_long  ips_noproto;            /* unknown or unsupported protocol */
135         u_long  ips_delivered;          /* datagrams delivered to upper level*/
136         u_long  ips_localout;           /* total ip packets generated here */
137         u_long  ips_odropped;           /* lost packets due to nobufs, etc. */
138         u_long  ips_reassembled;        /* total packets reassembled ok */
139         u_long  ips_fragmented;         /* datagrams successfully fragmented */
140         u_long  ips_ofragments;         /* output fragments created */
141         u_long  ips_cantfrag;           /* don't fragment flag was set, etc. */
142         u_long  ips_badoptions;         /* error in option processing */
143         u_long  ips_noroute;            /* packets discarded due to no route */
144         u_long  ips_badvers;            /* ip version != 4 */
145         u_long  ips_rawout;             /* total raw ip packets generated */
146         u_long  ips_toolong;            /* ip length > max ip packet size */
147         u_long  ips_notmember;          /* multicasts for unregistered grps */
148         u_long  ips_nogif;              /* no match gif found */
149         u_long  ips_badaddr;            /* invalid address on header */
150 };
151
152 #ifdef _KERNEL
153
154 #if defined(SMP)
155 #define ipstat  ipstats_percpu[mycpuid]
156 #else /* !SMP */
157 #define ipstat  ipstats_percpu[0]
158 #endif
159
160 extern struct ip_stats  ipstats_percpu[MAXCPU];
161
162 /* flags passed to ip_output as last parameter */
163 #define IP_FORWARDING           0x1             /* most of ip header exists */
164 #define IP_RAWOUTPUT            0x2             /* raw ip header exists */
165 #define IP_ROUTETOIF            SO_DONTROUTE    /* bypass routing tables */
166 #define IP_ALLOWBROADCAST       SO_BROADCAST    /* can send broadcast packets */
167 #define IP_DEBUGROUTE           0x10000         /* debug route */
168
169 /* direction passed to ip_cpufn as last parameter */
170 #define IP_MPORT_IN             0 /* Find lwkt port for incoming packets */
171 #define IP_MPORT_OUT            1 /* Find lwkt port for outgoing packets */
172
173 struct ip;
174 struct inpcb;
175 struct route;
176 struct sockopt;
177 struct lwkt_port;
178 struct pktinfo;
179 union netmsg;
180
181 extern u_short  ip_id;                          /* ip packet ctr, for ids */
182 extern int      ip_defttl;                      /* default IP ttl */
183 extern int      ipforwarding;                   /* ip forwarding */
184 extern u_char   ip_protox[];
185 extern struct socket *ip_rsvpd;         /* reservation protocol daemon */
186 extern struct socket *ip_mrouter;       /* multicast routing daemon */
187 extern int      (*legal_vif_num)(int);
188 extern u_long   (*ip_mcast_src)(int);
189 extern int rsvp_on;
190 extern struct   pr_usrreqs rip_usrreqs;
191
192 void     ip_ctloutput(union netmsg *);
193 void     ip_drain(void);
194 int      ip_fragment(struct ip *ip, struct mbuf **m_frag, int mtu,
195             u_long if_hwassist_flags, int sw_csum);
196 struct mbuf *
197          ip_reass(struct mbuf *);
198 void     ip_freemoptions(struct ip_moptions *);
199 void     ip_init(void);
200 extern int       (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
201                           struct ip_moptions *);
202
203 void    ip_cpufn(struct mbuf **, int, int);
204 void    ip_cpufn_in(struct mbuf **, int);
205
206 boolean_t
207          ip_lengthcheck(struct mbuf **, int);
208 int      ip_output(struct mbuf *,
209             struct mbuf *, struct route *, int, struct ip_moptions *,
210             struct inpcb *);
211 struct in_ifaddr *
212          ip_rtaddr(struct in_addr, struct route *);
213 void     ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
214                 struct mbuf *);
215 void     ip_slowtimo(void);
216 struct mbuf *
217          ip_srcroute(struct mbuf *);
218 void     ip_stripoptions(struct mbuf *);
219 u_int16_t ip_randomid(void);
220 void    rip_ctloutput(union netmsg *);
221 void    rip_ctlinput(union netmsg *);
222 void    rip_init(void);
223 int     rip_input(struct mbuf **, int *, int);
224 int     rip_output(struct mbuf *, struct socket *, ...);
225 extern int (*ipip_input)(struct mbuf **, int *, int);
226 int     rsvp_input(struct mbuf **, int *, int);
227 int     ip_rsvp_init(struct socket *);
228 int     ip_rsvp_done(void);
229 extern int      (*ip_rsvp_vif)(struct socket *, struct sockopt *);
230 extern void     (*ip_rsvp_force_done)(struct socket *);
231 extern int      (*rsvp_input_p)(struct mbuf **, int *, int);
232
233 extern  struct pfil_head inet_pfil_hook;
234
235 void    in_delayed_cksum(struct mbuf *m);
236
237 static __inline uint16_t ip_newid(void);
238 extern int ip_do_randomid;
239
240 static __inline uint16_t
241 ip_newid(void)
242 {
243     if (ip_do_randomid)
244         return ip_randomid();
245     else
246         return __htons(ip_id++);
247 }
248
249 #endif /* _KERNEL */
250
251 #endif /* !_NETINET_IP_VAR_H_ */