2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 * @(#)ip_var.h 8.2 (Berkeley) 1/9/95
35 #ifndef _NETINET_IP_VAR_H_
36 #define _NETINET_IP_VAR_H_
38 #include <sys/epoch.h>
39 #include <sys/queue.h>
40 #include <sys/types.h>
42 #include <netinet/in.h>
45 * Overlay for ip header used by other protocols (tcp, udp).
48 u_char ih_x1[9]; /* (unused) */
49 u_char ih_pr; /* protocol */
50 u_short ih_len; /* protocol length */
51 struct in_addr ih_src; /* source internet address */
52 struct in_addr ih_dst; /* destination internet address */
57 * Ip reassembly queue structure. Each fragment
58 * being reassembled is attached to one of these structures.
59 * They are timed out after net.inet.ip.fragttl seconds, and may also be
60 * reclaimed if memory becomes tight.
63 TAILQ_ENTRY(ipq) ipq_list; /* to other reass headers */
64 time_t ipq_expire; /* time_uptime when ipq expires */
65 u_char ipq_nfrags; /* # frags in this packet */
66 u_char ipq_p; /* protocol of this fragment */
67 u_short ipq_id; /* sequence id for reassembly */
68 int ipq_maxoff; /* total length of packet */
69 struct mbuf *ipq_frags; /* to ip headers of fragments */
70 struct in_addr ipq_src,ipq_dst;
71 struct label *ipq_label; /* MAC label */
76 * Structure stored in mbuf in inpcb.ip_options
77 * and passed to ip_output when ip options are in use.
78 * The actual length of the options (including ipopt_dst)
81 #define MAX_IPOPTLEN 40
84 struct in_addr ipopt_dst; /* first-hop dst if source routed */
85 char ipopt_list[MAX_IPOPTLEN]; /* options proper */
88 #if defined(_NETINET_IN_VAR_H_) && defined(_KERNEL)
90 * Structure attached to inpcb.ip_moptions and
91 * passed to ip_output when IP multicast options are in use.
92 * This structure is lazy-allocated.
95 struct ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
96 struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
97 u_long imo_multicast_vif; /* vif num outgoing multicasts */
98 u_char imo_multicast_ttl; /* TTL for outgoing multicasts */
99 u_char imo_multicast_loop; /* 1 => hear sends if a member */
100 struct ip_mfilter_head imo_head; /* group membership list */
107 uint64_t ips_total; /* total packets received */
108 uint64_t ips_badsum; /* checksum bad */
109 uint64_t ips_tooshort; /* packet too short */
110 uint64_t ips_toosmall; /* not enough data */
111 uint64_t ips_badhlen; /* ip header length < data size */
112 uint64_t ips_badlen; /* ip length < ip header length */
113 uint64_t ips_fragments; /* fragments received */
114 uint64_t ips_fragdropped; /* frags dropped (dups, out of space) */
115 uint64_t ips_fragtimeout; /* fragments timed out */
116 uint64_t ips_forward; /* packets forwarded */
117 uint64_t ips_fastforward; /* packets fast forwarded */
118 uint64_t ips_cantforward; /* packets rcvd for unreachable dest */
119 uint64_t ips_redirectsent; /* packets forwarded on same net */
120 uint64_t ips_noproto; /* unknown or unsupported protocol */
121 uint64_t ips_delivered; /* datagrams delivered to upper level*/
122 uint64_t ips_localout; /* total ip packets generated here */
123 uint64_t ips_odropped; /* lost packets due to nobufs, etc. */
124 uint64_t ips_reassembled; /* total packets reassembled ok */
125 uint64_t ips_fragmented; /* datagrams successfully fragmented */
126 uint64_t ips_ofragments; /* output fragments created */
127 uint64_t ips_cantfrag; /* don't fragment flag was set, etc. */
128 uint64_t ips_badoptions; /* error in option processing */
129 uint64_t ips_noroute; /* packets discarded due to no route */
130 uint64_t ips_badvers; /* ip version != 4 */
131 uint64_t ips_rawout; /* total raw ip packets generated */
132 uint64_t ips_toolong; /* ip length > max ip packet size */
133 uint64_t ips_notmember; /* multicasts for unregistered grps */
134 uint64_t ips_nogif; /* no match gif found */
135 uint64_t ips_badaddr; /* invalid address on header */
140 #include <sys/counter.h>
141 #include <net/vnet.h>
143 VNET_PCPUSTAT_DECLARE(struct ipstat, ipstat);
145 * In-kernel consumers can use these accessor macros directly to update
148 #define IPSTAT_ADD(name, val) \
149 VNET_PCPUSTAT_ADD(struct ipstat, ipstat, name, (val))
150 #define IPSTAT_SUB(name, val) IPSTAT_ADD(name, -(val))
151 #define IPSTAT_INC(name) IPSTAT_ADD(name, 1)
152 #define IPSTAT_DEC(name) IPSTAT_SUB(name, 1)
155 * Kernel module consumers must use this accessor macro.
157 void kmod_ipstat_inc(int statnum);
158 #define KMOD_IPSTAT_INC(name) \
159 kmod_ipstat_inc(offsetof(struct ipstat, name) / sizeof(uint64_t))
160 void kmod_ipstat_dec(int statnum);
161 #define KMOD_IPSTAT_DEC(name) \
162 kmod_ipstat_dec(offsetof(struct ipstat, name) / sizeof(uint64_t))
164 /* flags passed to ip_output as last parameter */
165 #define IP_FORWARDING 0x1 /* most of ip header exists */
166 #define IP_RAWOUTPUT 0x2 /* raw ip header exists */
167 #define IP_SENDONES 0x4 /* send all-ones broadcast */
168 #define IP_SENDTOIF 0x8 /* send on specific ifnet */
169 #define IP_ROUTETOIF SO_DONTROUTE /* 0x10 bypass routing tables */
170 #define IP_ALLOWBROADCAST SO_BROADCAST /* 0x20 can send broadcast packets */
171 #define IP_NODEFAULTFLOWID 0x40 /* Don't set the flowid from inp */
172 #define IP_NO_SND_TAG_RL 0x80 /* Don't send down the ratelimit tag */
174 #ifdef __NO_STRICT_ALIGNMENT
175 #define IP_HDR_ALIGNED_P(ip) 1
177 #define IP_HDR_ALIGNED_P(ip) ((((intptr_t) (ip)) & 3) == 0)
186 VNET_DECLARE(int, ip_defttl); /* default IP ttl */
187 VNET_DECLARE(int, ipforwarding); /* ip forwarding */
188 VNET_DECLARE(int, ipsendredirects);
190 VNET_DECLARE(int, ipstealth); /* stealth forwarding */
192 VNET_DECLARE(struct socket *, ip_rsvpd); /* reservation protocol daemon*/
193 VNET_DECLARE(struct socket *, ip_mrouter); /* multicast routing daemon */
194 extern int (*legal_vif_num)(int);
195 extern u_long (*ip_mcast_src)(int);
196 VNET_DECLARE(int, rsvp_on);
197 VNET_DECLARE(int, drop_redirect);
199 #define V_ip_id VNET(ip_id)
200 #define V_ip_defttl VNET(ip_defttl)
201 #define V_ipforwarding VNET(ipforwarding)
202 #define V_ipsendredirects VNET(ipsendredirects)
204 #define V_ipstealth VNET(ipstealth)
206 #define V_ip_rsvpd VNET(ip_rsvpd)
207 #define V_ip_mrouter VNET(ip_mrouter)
208 #define V_rsvp_on VNET(rsvp_on)
209 #define V_drop_redirect VNET(drop_redirect)
211 void inp_freemoptions(struct ip_moptions *);
212 int inp_getmoptions(struct inpcb *, struct sockopt *);
213 int inp_setmoptions(struct inpcb *, struct sockopt *);
215 int ip_ctloutput(struct socket *, struct sockopt *sopt);
216 int ip_fragment(struct ip *ip, struct mbuf **m_frag, int mtu,
217 u_long if_hwassist_flags);
218 void ip_forward(struct mbuf *m, int srcrt);
220 (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
221 struct ip_moptions *);
222 int ip_output(struct mbuf *,
223 struct mbuf *, struct route *, int, struct ip_moptions *,
226 ip_reass(struct mbuf *);
227 void ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
229 void ip_fillid(struct ip *);
230 int rip_ctloutput(struct socket *, struct sockopt *);
231 void rip_ctlinput(int, struct sockaddr *, void *);
232 int rip_input(struct mbuf **, int *, int);
233 int ipip_input(struct mbuf **, int *, int);
234 int rsvp_input(struct mbuf **, int *, int);
236 int ip_rsvp_init(struct socket *);
237 int ip_rsvp_done(void);
238 extern int (*ip_rsvp_vif)(struct socket *, struct sockopt *);
239 extern void (*ip_rsvp_force_done)(struct socket *);
240 extern int (*rsvp_input_p)(struct mbuf **, int *, int);
242 typedef int ipproto_input_t(struct mbuf **, int *, int);
243 typedef void ipproto_ctlinput_t(int, struct sockaddr *, void *);
244 int ipproto_register(uint8_t, ipproto_input_t, ipproto_ctlinput_t);
245 int ipproto_unregister(uint8_t);
246 #define IPPROTO_REGISTER(prot, input, ctl) do { \
247 int error __diagused; \
248 error = ipproto_register(prot, input, ctl); \
252 VNET_DECLARE(struct pfil_head *, inet_pfil_head);
253 #define V_inet_pfil_head VNET(inet_pfil_head)
254 #define PFIL_INET_NAME "inet"
256 void in_delayed_cksum(struct mbuf *m);
258 /* Hooks for ipfw, dummynet, divert etc. Most are declared in raw_ip.c */
260 * Reference to an ipfw or packet filter rule that can be carried
261 * outside critical sections.
262 * A rule is identified by rulenum:rule_id which is ordered.
263 * In version chain_id the rule can be found in slot 'slot', so
264 * we don't need a lookup if chain_id == chain->id.
266 * On exit from the firewall this structure refers to the rule after
267 * the matching one (slot points to the new rule; rulenum:rule_id-1
268 * is the matching rule), and additional info (e.g. info often contains
269 * the insn argument or tablearg in the low 16 bits, in host format).
270 * On entry, the structure is valid if slot>0, and refers to the starting
271 * rules. 'info' contains the reason for reinject, e.g. divert port,
272 * divert direction, and so on.
274 struct ipfw_rule_ref {
275 uint32_t slot; /* slot for matching rule */
276 uint32_t rulenum; /* matching rule number */
277 uint32_t rule_id; /* matching rule id */
278 uint32_t chain_id; /* ruleset id */
279 uint32_t info; /* see below */
283 IPFW_INFO_MASK = 0x0000ffff,
284 IPFW_INFO_OUT = 0x00000000, /* outgoing, just for convenience */
285 IPFW_INFO_IN = 0x80000000, /* incoming, overloads dir */
286 IPFW_ONEPASS = 0x40000000, /* One-pass, do not reinject */
287 IPFW_IS_MASK = 0x30000000, /* which source ? */
288 IPFW_IS_DIVERT = 0x20000000,
289 IPFW_IS_DUMMYNET =0x10000000,
290 IPFW_IS_PIPE = 0x08000000, /* pipe=1, queue = 0 */
292 #define MTAG_IPFW 1148380143 /* IPFW-tagged cookie */
293 #define MTAG_IPFW_RULE 1262273568 /* rule reference */
294 #define MTAG_IPFW_CALL 1308397630 /* call stack */
297 typedef int (*ip_fw_chk_ptr_t)(struct ip_fw_args *args);
298 typedef int (*ip_fw_ctl_ptr_t)(struct sockopt *);
299 VNET_DECLARE(ip_fw_ctl_ptr_t, ip_fw_ctl_ptr);
300 #define V_ip_fw_ctl_ptr VNET(ip_fw_ctl_ptr)
303 extern void (*ip_divert_ptr)(struct mbuf *m, bool incoming);
304 /* ng_ipfw hooks -- XXX make it the same as divert and dummynet */
305 extern int (*ng_ipfw_input_p)(struct mbuf **, struct ip_fw_args *, bool);
306 extern int (*ip_dn_ctl_ptr)(struct sockopt *);
307 extern int (*ip_dn_io_ptr)(struct mbuf **, struct ip_fw_args *);
310 #endif /* !_NETINET_IP_VAR_H_ */