1/* $NetBSD: ip_var.h,v 1.115 2016/08/01 10:22:53 knakahara Exp $ */
2
3/*
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 * @(#)ip_var.h 8.2 (Berkeley) 1/9/95
32 */
33
34#ifndef _NETINET_IP_VAR_H_
35#define _NETINET_IP_VAR_H_
36
37#include <sys/queue.h>
38#include <net/route.h>
39
40/*
41 * Overlay for ip header used by other protocols (tcp, udp).
42 */
43struct ipovly {
44 u_int8_t ih_x1[9]; /* (unused) */
45 u_int8_t ih_pr; /* protocol */
46 u_int16_t ih_len; /* protocol length */
47 struct in_addr ih_src; /* source internet address */
48 struct in_addr ih_dst; /* destination internet address */
49} __packed;
50
51/*
52 * IP Flow structure
53 */
54struct ipflow {
55 TAILQ_ENTRY(ipflow) ipf_list; /* next in active list */
56 TAILQ_ENTRY(ipflow) ipf_hash; /* next ipflow in bucket */
57 size_t ipf_hashidx; /* own hash index of ipflowtable[] */
58 struct in_addr ipf_dst; /* destination address */
59 struct in_addr ipf_src; /* source address */
60 uint8_t ipf_tos; /* type-of-service */
61 struct route ipf_ro; /* associated route entry */
62 u_long ipf_uses; /* number of uses in this period */
63 u_long ipf_last_uses; /* number of uses in last period */
64 u_long ipf_dropped; /* ENOBUFS retured by if_output */
65 u_long ipf_errors; /* other errors returned by if_output */
66 u_int ipf_timer; /* lifetime timer */
67};
68
69/*
70 * IP sequence queue structure.
71 *
72 * XXX -- The following explains why the ipqe_m field is here, for TCP's use:
73 * We want to avoid doing m_pullup on incoming packets but that
74 * means avoiding dtom on the tcp reassembly code. That in turn means
75 * keeping an mbuf pointer in the reassembly queue (since we might
76 * have a cluster). As a quick hack, the source & destination
77 * port numbers (which are no longer needed once we've located the
78 * tcpcb) are overlayed with an mbuf pointer.
79 */
80TAILQ_HEAD(ipqehead, ipqent);
81struct ipqent {
82 TAILQ_ENTRY(ipqent) ipqe_q;
83 union {
84 struct ip *_ip;
85 struct tcpiphdr *_tcp;
86 } _ipqe_u1;
87 struct mbuf *ipqe_m; /* point to first mbuf */
88 struct mbuf *ipre_mlast; /* point to last mbuf */
89 u_int8_t ipqe_mff; /* for IP fragmentation */
90 /*
91 * The following are used in TCP reassembly
92 */
93 TAILQ_ENTRY(ipqent) ipqe_timeq;
94 u_int32_t ipqe_seq;
95 u_int32_t ipqe_len;
96 u_int32_t ipqe_flags;
97};
98#define ipqe_tcp _ipqe_u1._tcp
99
100/*
101 * Structure stored in mbuf in inpcb.ip_options
102 * and passed to ip_output when ip options are in use.
103 * The actual length of the options (including ipopt_dst)
104 * is in m_len.
105 */
106#define MAX_IPOPTLEN 40
107
108struct ipoption {
109 struct in_addr ipopt_dst; /* first-hop dst if source routed */
110 int8_t ipopt_list[MAX_IPOPTLEN]; /* options proper */
111};
112
113/*
114 * Structure attached to inpcb.ip_moptions and
115 * passed to ip_output when IP multicast options are in use.
116 */
117struct ip_moptions {
118 if_index_t imo_multicast_if_index; /* I/F for outgoing multicasts */
119 struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
120 u_int8_t imo_multicast_ttl; /* TTL for outgoing multicasts */
121 u_int8_t imo_multicast_loop; /* 1 => hear sends if a member */
122 u_int16_t imo_num_memberships; /* no. memberships this socket */
123 struct in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
124};
125
126/*
127 * IP statistics.
128 * Each counter is an unsigned 64-bit value.
129 */
130#define IP_STAT_TOTAL 0 /* total packets received */
131#define IP_STAT_BADSUM 1 /* checksum bad */
132#define IP_STAT_TOOSHORT 2 /* packet too short */
133#define IP_STAT_TOOSMALL 3 /* not enough data */
134#define IP_STAT_BADHLEN 4 /* ip header length < data size */
135#define IP_STAT_BADLEN 5 /* ip length < ip header length */
136#define IP_STAT_FRAGMENTS 6 /* fragments received */
137#define IP_STAT_FRAGDROPPED 7 /* frags dropped (dups, out of space) */
138#define IP_STAT_FRAGTIMEOUT 8 /* fragments timed out */
139#define IP_STAT_FORWARD 9 /* packets forwarded */
140#define IP_STAT_FASTFORWARD 10 /* packets fast forwarded */
141#define IP_STAT_CANTFORWARD 11 /* packets rcvd for unreachable dest */
142#define IP_STAT_REDIRECTSENT 12 /* packets forwareded on same net */
143#define IP_STAT_NOPROTO 13 /* unknown or unsupported protocol */
144#define IP_STAT_DELIVERED 14 /* datagrams delivered to upper level */
145#define IP_STAT_LOCALOUT 15 /* total ip packets generated here */
146#define IP_STAT_ODROPPED 16 /* lost packets due to nobufs, etc. */
147#define IP_STAT_REASSEMBLED 17 /* total packets reassembled ok */
148#define IP_STAT_FRAGMENTED 18 /* datagrams successfully fragmented */
149#define IP_STAT_OFRAGMENTS 19 /* output fragments created */
150#define IP_STAT_CANTFRAG 20 /* don't fragment flag was set, etc. */
151#define IP_STAT_BADOPTIONS 21 /* error in option processing */
152#define IP_STAT_NOROUTE 22 /* packets discarded due to no route */
153#define IP_STAT_BADVERS 23 /* ip version != 4 */
154#define IP_STAT_RAWOUT 24 /* total raw ip packets generated */
155#define IP_STAT_BADFRAGS 25 /* malformed fragments (bad length) */
156#define IP_STAT_RCVMEMDROP 26 /* frags dropped for lack of memory */
157#define IP_STAT_TOOLONG 27 /* ip length > max ip packet size */
158#define IP_STAT_NOGIF 28 /* no match gif found */
159#define IP_STAT_BADADDR 29 /* invalid address on header */
160
161#define IP_NSTATS 30
162
163#ifdef _KERNEL
164
165#ifdef _KERNEL_OPT
166#include "opt_gateway.h"
167#include "opt_mbuftrace.h"
168#endif
169
170/*
171 * The following flags can be passed to ip_output() as last parameter
172 */
173#define IP_FORWARDING 0x0001 /* most of ip header exists */
174#define IP_RAWOUTPUT 0x0002 /* raw ip header exists */
175#define IP_RETURNMTU 0x0004 /* pass back mtu on EMSGSIZE */
176#define IP_NOIPNEWID 0x0008 /* don't fill in ip_id */
177__CTASSERT(SO_DONTROUTE == 0x0010);
178__CTASSERT(SO_BROADCAST == 0x0020);
179#define IP_ROUTETOIF SO_DONTROUTE /* bypass routing tables */
180#define IP_ALLOWBROADCAST SO_BROADCAST /* can send broadcast packets */
181
182#define IP_IGMP_MCAST 0x0040 /* IGMP for mcast join/leave */
183#define IP_MTUDISC 0x0400 /* Path MTU Discovery; set DF */
184
185extern struct domain inetdomain;
186extern const struct pr_usrreqs rip_usrreqs;
187
188extern int ip_defttl; /* default IP ttl */
189extern int ipforwarding; /* ip forwarding */
190extern int ip_mtudisc; /* mtu discovery */
191extern int ip_mtudisc_timeout; /* seconds to timeout mtu discovery */
192extern int anonportmin; /* minimum ephemeral port */
193extern int anonportmax; /* maximum ephemeral port */
194extern int lowportmin; /* minimum reserved port */
195extern int lowportmax; /* maximum reserved port */
196extern int ip_do_loopback_cksum; /* do IP checksum on loopback? */
197extern struct rttimer_queue *ip_mtudisc_timeout_q;
198#ifdef MBUFTRACE
199extern struct mowner ip_rx_mowner;
200extern struct mowner ip_tx_mowner;
201#endif
202struct inpcb;
203struct sockopt;
204
205void ip_init(void);
206void in_init(void);
207
208int ip_ctloutput(int, struct socket *, struct sockopt *);
209void ip_drain(void);
210void ip_drainstub(void);
211void ip_freemoptions(struct ip_moptions *);
212int ip_optcopy(struct ip *, struct ip *);
213u_int ip_optlen(struct inpcb *);
214int ip_output(struct mbuf *, struct mbuf *, struct route *, int,
215 struct ip_moptions *, struct socket *);
216int ip_fragment(struct mbuf *, struct ifnet *, u_long);
217
218void ip_reass_init(void);
219int ip_reass_packet(struct mbuf **, struct ip *);
220void ip_reass_slowtimo(void);
221void ip_reass_drain(void);
222
223void ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
224 struct mbuf *);
225void ip_slowtimo(void);
226void ip_fasttimo(void);
227struct mbuf *
228 ip_srcroute(void);
229int ip_sysctl(int *, u_int, void *, size_t *, void *, size_t);
230void ip_statinc(u_int);
231void * rip_ctlinput(int, const struct sockaddr *, void *);
232int rip_ctloutput(int, struct socket *, struct sockopt *);
233void rip_init(void);
234void rip_input(struct mbuf *, ...);
235int rip_output(struct mbuf *, struct inpcb *);
236int rip_usrreq(struct socket *,
237 int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *);
238
239int ip_setmoptions(struct ip_moptions **, const struct sockopt *sopt);
240int ip_getmoptions(struct ip_moptions *, struct sockopt *sopt);
241
242int ip_if_output(struct ifnet * const, struct mbuf * const,
243 const struct sockaddr * const, const struct rtentry *);
244
245/* IP Flow interface. */
246void ipflow_init(void);
247void ipflow_poolinit(void);
248void ipflow_create(const struct route *, struct mbuf *);
249void ipflow_slowtimo(void);
250int ipflow_invalidate_all(int);
251
252#endif /* _KERNEL */
253
254#endif /* !_NETINET_IP_VAR_H_ */
255