1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1982, 1986, 1990, 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 *	@(#)in.h	8.3 (Berkeley) 1/3/94
32 * $FreeBSD$
33 */
34
35#ifndef _NETINET_IN_H_
36#define	_NETINET_IN_H_
37
38#include <sys/cdefs.h>
39#include <sys/_types.h>
40#include <machine/endian.h>
41
42/* Protocols common to RFC 1700, POSIX, and X/Open. */
43#define	IPPROTO_IP		0		/* dummy for IP */
44#define	IPPROTO_ICMP		1		/* control message protocol */
45#define	IPPROTO_TCP		6		/* tcp */
46#define	IPPROTO_UDP		17		/* user datagram protocol */
47
48#define	INADDR_ANY		((in_addr_t)0x00000000)
49#define	INADDR_BROADCAST	((in_addr_t)0xffffffff)	/* must be masked */
50
51#ifndef _UINT8_T_DECLARED
52typedef	__uint8_t		uint8_t;
53#define	_UINT8_T_DECLARED
54#endif
55
56#ifndef _UINT16_T_DECLARED
57typedef	__uint16_t		uint16_t;
58#define	_UINT16_T_DECLARED
59#endif
60
61#ifndef _UINT32_T_DECLARED
62typedef	__uint32_t		uint32_t;
63#define	_UINT32_T_DECLARED
64#endif
65
66#ifndef _IN_ADDR_T_DECLARED
67typedef	uint32_t		in_addr_t;
68#define	_IN_ADDR_T_DECLARED
69#endif
70
71#ifndef _IN_PORT_T_DECLARED
72typedef	uint16_t		in_port_t;
73#define	_IN_PORT_T_DECLARED
74#endif
75
76#ifndef _SA_FAMILY_T_DECLARED
77typedef	__sa_family_t		sa_family_t;
78#define	_SA_FAMILY_T_DECLARED
79#endif
80
81/* Internet address (a structure for historical reasons). */
82#ifndef	_STRUCT_IN_ADDR_DECLARED
83struct in_addr {
84	in_addr_t s_addr;
85};
86#define	_STRUCT_IN_ADDR_DECLARED
87#endif
88
89#ifndef	_SOCKLEN_T_DECLARED
90typedef	__socklen_t	socklen_t;
91#define	_SOCKLEN_T_DECLARED
92#endif
93
94#include <sys/_sockaddr_storage.h>
95
96/* Socket address, internet style. */
97struct sockaddr_in {
98	uint8_t	sin_len;
99	sa_family_t	sin_family;
100	in_port_t	sin_port;
101	struct	in_addr sin_addr;
102	char	sin_zero[8];
103};
104
105#if !defined(_KERNEL) && __POSIX_VISIBLE >= 200112
106
107#ifndef _BYTEORDER_PROTOTYPED
108#define	_BYTEORDER_PROTOTYPED
109__BEGIN_DECLS
110uint32_t	htonl(uint32_t);
111uint16_t	htons(uint16_t);
112uint32_t	ntohl(uint32_t);
113uint16_t	ntohs(uint16_t);
114__END_DECLS
115#endif
116
117#ifndef _BYTEORDER_FUNC_DEFINED
118#define	_BYTEORDER_FUNC_DEFINED
119#define	htonl(x)	__htonl(x)
120#define	htons(x)	__htons(x)
121#define	ntohl(x)	__ntohl(x)
122#define	ntohs(x)	__ntohs(x)
123#endif
124
125#endif /* !_KERNEL && __POSIX_VISIBLE >= 200112 */
126
127#if __POSIX_VISIBLE >= 200112
128#define	IPPROTO_IPV6		41		/* IP6 header */
129#define	IPPROTO_RAW		255		/* raw IP packet */
130#define	INET_ADDRSTRLEN		16
131#endif
132
133#if __BSD_VISIBLE
134/*
135 * Constants and structures defined by the internet system,
136 * Per RFC 790, September 1981, and numerous additions.
137 */
138
139/*
140 * Protocols (RFC 1700)
141 */
142#define	IPPROTO_HOPOPTS		0		/* IP6 hop-by-hop options */
143#define	IPPROTO_IGMP		2		/* group mgmt protocol */
144#define	IPPROTO_GGP		3		/* gateway^2 (deprecated) */
145#define	IPPROTO_IPV4		4		/* IPv4 encapsulation */
146#define	IPPROTO_IPIP		IPPROTO_IPV4	/* for compatibility */
147#define	IPPROTO_ST		7		/* Stream protocol II */
148#define	IPPROTO_EGP		8		/* exterior gateway protocol */
149#define	IPPROTO_PIGP		9		/* private interior gateway */
150#define	IPPROTO_RCCMON		10		/* BBN RCC Monitoring */
151#define	IPPROTO_NVPII		11		/* network voice protocol*/
152#define	IPPROTO_PUP		12		/* pup */
153#define	IPPROTO_ARGUS		13		/* Argus */
154#define	IPPROTO_EMCON		14		/* EMCON */
155#define	IPPROTO_XNET		15		/* Cross Net Debugger */
156#define	IPPROTO_CHAOS		16		/* Chaos*/
157#define	IPPROTO_MUX		18		/* Multiplexing */
158#define	IPPROTO_MEAS		19		/* DCN Measurement Subsystems */
159#define	IPPROTO_HMP		20		/* Host Monitoring */
160#define	IPPROTO_PRM		21		/* Packet Radio Measurement */
161#define	IPPROTO_IDP		22		/* xns idp */
162#define	IPPROTO_TRUNK1		23		/* Trunk-1 */
163#define	IPPROTO_TRUNK2		24		/* Trunk-2 */
164#define	IPPROTO_LEAF1		25		/* Leaf-1 */
165#define	IPPROTO_LEAF2		26		/* Leaf-2 */
166#define	IPPROTO_RDP		27		/* Reliable Data */
167#define	IPPROTO_IRTP		28		/* Reliable Transaction */
168#define	IPPROTO_TP		29		/* tp-4 w/ class negotiation */
169#define	IPPROTO_BLT		30		/* Bulk Data Transfer */
170#define	IPPROTO_NSP		31		/* Network Services */
171#define	IPPROTO_INP		32		/* Merit Internodal */
172#define	IPPROTO_DCCP		33		/* Datagram Congestion Control Protocol */
173#define	IPPROTO_3PC		34		/* Third Party Connect */
174#define	IPPROTO_IDPR		35		/* InterDomain Policy Routing */
175#define	IPPROTO_XTP		36		/* XTP */
176#define	IPPROTO_DDP		37		/* Datagram Delivery */
177#define	IPPROTO_CMTP		38		/* Control Message Transport */
178#define	IPPROTO_TPXX		39		/* TP++ Transport */
179#define	IPPROTO_IL		40		/* IL transport protocol */
180#define	IPPROTO_SDRP		42		/* Source Demand Routing */
181#define	IPPROTO_ROUTING		43		/* IP6 routing header */
182#define	IPPROTO_FRAGMENT	44		/* IP6 fragmentation header */
183#define	IPPROTO_IDRP		45		/* InterDomain Routing*/
184#define	IPPROTO_RSVP		46		/* resource reservation */
185#define	IPPROTO_GRE		47		/* General Routing Encap. */
186#define	IPPROTO_MHRP		48		/* Mobile Host Routing */
187#define	IPPROTO_BHA		49		/* BHA */
188#define	IPPROTO_ESP		50		/* IP6 Encap Sec. Payload */
189#define	IPPROTO_AH		51		/* IP6 Auth Header */
190#define	IPPROTO_INLSP		52		/* Integ. Net Layer Security */
191#define	IPPROTO_SWIPE		53		/* IP with encryption */
192#define	IPPROTO_NHRP		54		/* Next Hop Resolution */
193#define	IPPROTO_MOBILE		55		/* IP Mobility */
194#define	IPPROTO_TLSP		56		/* Transport Layer Security */
195#define	IPPROTO_SKIP		57		/* SKIP */
196#define	IPPROTO_ICMPV6		58		/* ICMP6 */
197#define	IPPROTO_NONE		59		/* IP6 no next header */
198#define	IPPROTO_DSTOPTS		60		/* IP6 destination option */
199#define	IPPROTO_AHIP		61		/* any host internal protocol */
200#define	IPPROTO_CFTP		62		/* CFTP */
201#define	IPPROTO_HELLO		63		/* "hello" routing protocol */
202#define	IPPROTO_SATEXPAK	64		/* SATNET/Backroom EXPAK */
203#define	IPPROTO_KRYPTOLAN	65		/* Kryptolan */
204#define	IPPROTO_RVD		66		/* Remote Virtual Disk */
205#define	IPPROTO_IPPC		67		/* Pluribus Packet Core */
206#define	IPPROTO_ADFS		68		/* Any distributed FS */
207#define	IPPROTO_SATMON		69		/* Satnet Monitoring */
208#define	IPPROTO_VISA		70		/* VISA Protocol */
209#define	IPPROTO_IPCV		71		/* Packet Core Utility */
210#define	IPPROTO_CPNX		72		/* Comp. Prot. Net. Executive */
211#define	IPPROTO_CPHB		73		/* Comp. Prot. HeartBeat */
212#define	IPPROTO_WSN		74		/* Wang Span Network */
213#define	IPPROTO_PVP		75		/* Packet Video Protocol */
214#define	IPPROTO_BRSATMON	76		/* BackRoom SATNET Monitoring */
215#define	IPPROTO_ND		77		/* Sun net disk proto (temp.) */
216#define	IPPROTO_WBMON		78		/* WIDEBAND Monitoring */
217#define	IPPROTO_WBEXPAK		79		/* WIDEBAND EXPAK */
218#define	IPPROTO_EON		80		/* ISO cnlp */
219#define	IPPROTO_VMTP		81		/* VMTP */
220#define	IPPROTO_SVMTP		82		/* Secure VMTP */
221#define	IPPROTO_VINES		83		/* Banyon VINES */
222#define	IPPROTO_TTP		84		/* TTP */
223#define	IPPROTO_IGP		85		/* NSFNET-IGP */
224#define	IPPROTO_DGP		86		/* dissimilar gateway prot. */
225#define	IPPROTO_TCF		87		/* TCF */
226#define	IPPROTO_IGRP		88		/* Cisco/GXS IGRP */
227#define	IPPROTO_OSPFIGP		89		/* OSPFIGP */
228#define	IPPROTO_SRPC		90		/* Strite RPC protocol */
229#define	IPPROTO_LARP		91		/* Locus Address Resoloution */
230#define	IPPROTO_MTP		92		/* Multicast Transport */
231#define	IPPROTO_AX25		93		/* AX.25 Frames */
232#define	IPPROTO_IPEIP		94		/* IP encapsulated in IP */
233#define	IPPROTO_MICP		95		/* Mobile Int.ing control */
234#define	IPPROTO_SCCSP		96		/* Semaphore Comm. security */
235#define	IPPROTO_ETHERIP		97		/* Ethernet IP encapsulation */
236#define	IPPROTO_ENCAP		98		/* encapsulation header */
237#define	IPPROTO_APES		99		/* any private encr. scheme */
238#define	IPPROTO_GMTP		100		/* GMTP*/
239#define	IPPROTO_IPCOMP		108		/* payload compression (IPComp) */
240#define	IPPROTO_SCTP		132		/* SCTP */
241#define	IPPROTO_MH		135		/* IPv6 Mobility Header */
242#define	IPPROTO_UDPLITE		136		/* UDP-Lite */
243#define	IPPROTO_HIP		139		/* IP6 Host Identity Protocol */
244#define	IPPROTO_SHIM6		140		/* IP6 Shim6 Protocol */
245/* 101-254: Partly Unassigned */
246#define	IPPROTO_PIM		103		/* Protocol Independent Mcast */
247#define	IPPROTO_CARP		112		/* CARP */
248#define	IPPROTO_PGM		113		/* PGM */
249#define	IPPROTO_MPLS		137		/* MPLS-in-IP */
250#define	IPPROTO_PFSYNC		240		/* PFSYNC */
251#define	IPPROTO_RESERVED_253	253		/* Reserved */
252#define	IPPROTO_RESERVED_254	254		/* Reserved */
253/* 255: Reserved */
254/* BSD Private, local use, namespace incursion, no longer used */
255#define	IPPROTO_OLD_DIVERT	254		/* OLD divert pseudo-proto */
256#define	IPPROTO_MAX		256
257
258/* last return value of *_input(), meaning "all job for this pkt is done".  */
259#define	IPPROTO_DONE		257
260
261/* Only used internally, so can be outside the range of valid IP protocols. */
262#define	IPPROTO_DIVERT		258		/* divert pseudo-protocol */
263#define	IPPROTO_SEND		259		/* SeND pseudo-protocol */
264
265/*
266 * Defined to avoid confusion.  The master value is defined by
267 * PROTO_SPACER in sys/protosw.h.
268 */
269#define	IPPROTO_SPACER		32767		/* spacer for loadable protos */
270
271/*
272 * Local port number conventions:
273 *
274 * When a user does a bind(2) or connect(2) with a port number of zero,
275 * a non-conflicting local port address is chosen.
276 * The default range is IPPORT_HIFIRSTAUTO through
277 * IPPORT_HILASTAUTO, although that is settable by sysctl.
278 *
279 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
280 * default assignment range.
281 *
282 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
283 *
284 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
285 * into the "high" range.  These are reserved for client outbound connections
286 * which do not want to be filtered by any firewalls.
287 *
288 * The value IP_PORTRANGE_LOW changes the range to the "low" are
289 * that is (by convention) restricted to privileged processes.  This
290 * convention is based on "vouchsafe" principles only.  It is only secure
291 * if you trust the remote host to restrict these ports.
292 *
293 * The default range of ports and the high range can be changed by
294 * sysctl(3).  (net.inet.ip.portrange.{hi,low,}{first,last})
295 *
296 * Changing those values has bad security implications if you are
297 * using a stateless firewall that is allowing packets outside of that
298 * range in order to allow transparent outgoing connections.
299 *
300 * Such a firewall configuration will generally depend on the use of these
301 * default values.  If you change them, you may find your Security
302 * Administrator looking for you with a heavy object.
303 *
304 * For a slightly more orthodox text view on this:
305 *
306 *            ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
307 *
308 *    port numbers are divided into three ranges:
309 *
310 *                0 -  1023 Well Known Ports
311 *             1024 - 49151 Registered Ports
312 *            49152 - 65535 Dynamic and/or Private Ports
313 *
314 */
315
316/*
317 * Ports < IPPORT_RESERVED are reserved for
318 * privileged processes (e.g. root).         (IP_PORTRANGE_LOW)
319 */
320#define	IPPORT_RESERVED		1024
321
322/*
323 * Default local port range, used by IP_PORTRANGE_DEFAULT
324 */
325#define IPPORT_EPHEMERALFIRST	10000
326#define IPPORT_EPHEMERALLAST	65535
327
328/*
329 * Dynamic port range, used by IP_PORTRANGE_HIGH.
330 */
331#define	IPPORT_HIFIRSTAUTO	49152
332#define	IPPORT_HILASTAUTO	65535
333
334/*
335 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
336 * but higher than IPPORT_RESERVEDSTART.  Traditionally the start value was
337 * 512, but that conflicts with some well-known-services that firewalls may
338 * have a fit if we use.
339 */
340#define	IPPORT_RESERVEDSTART	600
341
342#define	IPPORT_MAX		65535
343
344/*
345 * Definitions of bits in internet address integers.
346 * On subnets, the decomposition of addresses to host and net parts
347 * is done according to subnet mask, not the masks here.
348 */
349#define	IN_CLASSA(i)		(((in_addr_t)(i) & 0x80000000) == 0)
350#define	IN_CLASSA_NET		0xff000000
351#define	IN_CLASSA_NSHIFT	24
352#define	IN_CLASSA_HOST		0x00ffffff
353#define	IN_CLASSA_MAX		128
354
355#define	IN_CLASSB(i)		(((in_addr_t)(i) & 0xc0000000) == 0x80000000)
356#define	IN_CLASSB_NET		0xffff0000
357#define	IN_CLASSB_NSHIFT	16
358#define	IN_CLASSB_HOST		0x0000ffff
359#define	IN_CLASSB_MAX		65536
360
361#define	IN_CLASSC(i)		(((in_addr_t)(i) & 0xe0000000) == 0xc0000000)
362#define	IN_CLASSC_NET		0xffffff00
363#define	IN_CLASSC_NSHIFT	8
364#define	IN_CLASSC_HOST		0x000000ff
365
366#define	IN_CLASSD(i)		(((in_addr_t)(i) & 0xf0000000) == 0xe0000000)
367#define	IN_CLASSD_NET		0xf0000000	/* These ones aren't really */
368#define	IN_CLASSD_NSHIFT	28		/* net and host fields, but */
369#define	IN_CLASSD_HOST		0x0fffffff	/* routing needn't know.    */
370#define	IN_MULTICAST(i)		IN_CLASSD(i)
371
372#define	IN_EXPERIMENTAL(i)	(((in_addr_t)(i) & 0xf0000000) == 0xf0000000)
373#define	IN_BADCLASS(i)		(((in_addr_t)(i) & 0xf0000000) == 0xf0000000)
374
375#define IN_LINKLOCAL(i)		(((in_addr_t)(i) & 0xffff0000) == 0xa9fe0000)
376#define IN_LOOPBACK(i)		(((in_addr_t)(i) & 0xff000000) == 0x7f000000)
377#define IN_ZERONET(i)		(((in_addr_t)(i) & 0xff000000) == 0)
378
379#define	IN_PRIVATE(i)	((((in_addr_t)(i) & 0xff000000) == 0x0a000000) || \
380			 (((in_addr_t)(i) & 0xfff00000) == 0xac100000) || \
381			 (((in_addr_t)(i) & 0xffff0000) == 0xc0a80000))
382
383#define	IN_LOCAL_GROUP(i)	(((in_addr_t)(i) & 0xffffff00) == 0xe0000000)
384
385#define	IN_ANY_LOCAL(i)		(IN_LINKLOCAL(i) || IN_LOCAL_GROUP(i))
386
387#define	INADDR_LOOPBACK		((in_addr_t)0x7f000001)
388#ifndef _KERNEL
389#define	INADDR_NONE		((in_addr_t)0xffffffff)	/* -1 return */
390#endif
391
392#define	INADDR_UNSPEC_GROUP	((in_addr_t)0xe0000000)	/* 224.0.0.0 */
393#define	INADDR_ALLHOSTS_GROUP	((in_addr_t)0xe0000001)	/* 224.0.0.1 */
394#define	INADDR_ALLRTRS_GROUP	((in_addr_t)0xe0000002)	/* 224.0.0.2 */
395#define	INADDR_ALLRPTS_GROUP	((in_addr_t)0xe0000016)	/* 224.0.0.22, IGMPv3 */
396#define	INADDR_CARP_GROUP	((in_addr_t)0xe0000012)	/* 224.0.0.18 */
397#define	INADDR_PFSYNC_GROUP	((in_addr_t)0xe00000f0)	/* 224.0.0.240 */
398#define	INADDR_ALLMDNS_GROUP	((in_addr_t)0xe00000fb)	/* 224.0.0.251 */
399#define	INADDR_MAX_LOCAL_GROUP	((in_addr_t)0xe00000ff)	/* 224.0.0.255 */
400
401#define	IN_LOOPBACKNET		127			/* official! */
402
403#define	IN_RFC3021_MASK		((in_addr_t)0xfffffffe)
404
405/*
406 * Options for use with [gs]etsockopt at the IP level.
407 * First word of comment is data type; bool is stored in int.
408 */
409#define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
410#define	IP_HDRINCL		2    /* int; header is included with data */
411#define	IP_TOS			3    /* int; IP type of service and preced. */
412#define	IP_TTL			4    /* int; IP time to live */
413#define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
414#define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
415#define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
416#define	IP_SENDSRCADDR		IP_RECVDSTADDR /* cmsg_type to set src addr */
417#define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
418#define	IP_MULTICAST_IF		9    /* struct in_addr *or* struct ip_mreqn;
419				      * set/get IP multicast i/f  */
420#define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
421#define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
422#define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
423#define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
424#define	IP_MULTICAST_VIF	14   /* set/get IP mcast virt. iface */
425#define	IP_RSVP_ON		15   /* enable RSVP in kernel */
426#define	IP_RSVP_OFF		16   /* disable RSVP in kernel */
427#define	IP_RSVP_VIF_ON		17   /* set RSVP per-vif socket */
428#define	IP_RSVP_VIF_OFF		18   /* unset RSVP per-vif socket */
429#define	IP_PORTRANGE		19   /* int; range to choose for unspec port */
430#define	IP_RECVIF		20   /* bool; receive reception if w/dgram */
431/* for IPSEC */
432#define	IP_IPSEC_POLICY		21   /* int; set/get security policy */
433				     /* unused; was IP_FAITH */
434#define	IP_ONESBCAST		23   /* bool: send all-ones broadcast */
435#define	IP_BINDANY		24   /* bool: allow bind to any address */
436#define	IP_BINDMULTI		25   /* bool: allow multiple listeners on a tuple */
437#define	IP_RSS_LISTEN_BUCKET	26   /* int; set RSS listen bucket */
438#define	IP_ORIGDSTADDR		27   /* bool: receive IP dst addr/port w/dgram */
439#define	IP_RECVORIGDSTADDR      IP_ORIGDSTADDR
440
441/*
442 * Options for controlling the firewall and dummynet.
443 * Historical options (from 40 to 64) will eventually be
444 * replaced by only two options, IP_FW3 and IP_DUMMYNET3.
445 */
446#define	IP_FW_TABLE_ADD		40   /* add entry */
447#define	IP_FW_TABLE_DEL		41   /* delete entry */
448#define	IP_FW_TABLE_FLUSH	42   /* flush table */
449#define	IP_FW_TABLE_GETSIZE	43   /* get table size */
450#define	IP_FW_TABLE_LIST	44   /* list table contents */
451
452#define	IP_FW3			48   /* generic ipfw v.3 sockopts */
453#define	IP_DUMMYNET3		49   /* generic dummynet v.3 sockopts */
454
455#define	IP_FW_ADD		50   /* add a firewall rule to chain */
456#define	IP_FW_DEL		51   /* delete a firewall rule from chain */
457#define	IP_FW_FLUSH		52   /* flush firewall rule chain */
458#define	IP_FW_ZERO		53   /* clear single/all firewall counter(s) */
459#define	IP_FW_GET		54   /* get entire firewall rule chain */
460#define	IP_FW_RESETLOG		55   /* reset logging counters */
461
462#define IP_FW_NAT_CFG           56   /* add/config a nat rule */
463#define IP_FW_NAT_DEL           57   /* delete a nat rule */
464#define IP_FW_NAT_GET_CONFIG    58   /* get configuration of a nat rule */
465#define IP_FW_NAT_GET_LOG       59   /* get log of a nat rule */
466
467#define	IP_DUMMYNET_CONFIGURE	60   /* add/configure a dummynet pipe */
468#define	IP_DUMMYNET_DEL		61   /* delete a dummynet pipe from chain */
469#define	IP_DUMMYNET_FLUSH	62   /* flush dummynet */
470#define	IP_DUMMYNET_GET		64   /* get entire dummynet pipes */
471
472#define	IP_RECVTTL		65   /* bool; receive IP TTL w/dgram */
473#define	IP_MINTTL		66   /* minimum TTL for packet or drop */
474#define	IP_DONTFRAG		67   /* don't fragment packet */
475#define	IP_RECVTOS		68   /* bool; receive IP TOS w/dgram */
476
477/* IPv4 Source Filter Multicast API [RFC3678] */
478#define	IP_ADD_SOURCE_MEMBERSHIP	70   /* join a source-specific group */
479#define	IP_DROP_SOURCE_MEMBERSHIP	71   /* drop a single source */
480#define	IP_BLOCK_SOURCE			72   /* block a source */
481#define	IP_UNBLOCK_SOURCE		73   /* unblock a source */
482
483/* The following option is private; do not use it from user applications. */
484#define	IP_MSFILTER			74   /* set/get filter list */
485
486/* Protocol Independent Multicast API [RFC3678] */
487#define	MCAST_JOIN_GROUP		80   /* join an any-source group */
488#define	MCAST_LEAVE_GROUP		81   /* leave all sources for group */
489#define	MCAST_JOIN_SOURCE_GROUP		82   /* join a source-specific group */
490#define	MCAST_LEAVE_SOURCE_GROUP	83   /* leave a single source */
491#define	MCAST_BLOCK_SOURCE		84   /* block a source */
492#define	MCAST_UNBLOCK_SOURCE		85   /* unblock a source */
493
494/* Flow and RSS definitions */
495#define	IP_FLOWID		90   /* get flow id for the given socket/inp */
496#define	IP_FLOWTYPE		91   /* get flow type (M_HASHTYPE) */
497#define	IP_RSSBUCKETID		92   /* get RSS flowid -> bucket mapping */
498#define	IP_RECVFLOWID		93   /* bool; receive IP flowid/flowtype w/ datagram */
499#define	IP_RECVRSSBUCKETID	94   /* bool; receive IP RSS bucket id w/ datagram */
500
501/*
502 * Defaults and limits for options
503 */
504#define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
505#define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
506
507/*
508 * Limit for IPv4 multicast memberships
509 */
510#define	IP_MAX_MEMBERSHIPS	4095
511
512/*
513 * Default resource limits for IPv4 multicast source filtering.
514 * These may be modified by sysctl.
515 */
516#define	IP_MAX_GROUP_SRC_FILTER		512	/* sources per group */
517#define	IP_MAX_SOCK_SRC_FILTER		128	/* sources per socket/group */
518#define	IP_MAX_SOCK_MUTE_FILTER		128	/* XXX no longer used */
519
520/*
521 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
522 */
523struct ip_mreq {
524	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
525	struct	in_addr imr_interface;	/* local IP address of interface */
526};
527
528/*
529 * Modified argument structure for IP_MULTICAST_IF, obtained from Linux.
530 * This is used to specify an interface index for multicast sends, as
531 * the IPv4 legacy APIs do not support this (unless IP_SENDIF is available).
532 */
533struct ip_mreqn {
534	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
535	struct	in_addr imr_address;	/* local IP address of interface */
536	int		imr_ifindex;	/* Interface index; cast to uint32_t */
537};
538
539/*
540 * Argument structure for IPv4 Multicast Source Filter APIs. [RFC3678]
541 */
542struct ip_mreq_source {
543	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
544	struct	in_addr imr_sourceaddr;	/* IP address of source */
545	struct	in_addr imr_interface;	/* local IP address of interface */
546};
547
548/*
549 * Argument structures for Protocol-Independent Multicast Source
550 * Filter APIs. [RFC3678]
551 */
552struct group_req {
553	uint32_t		gr_interface;	/* interface index */
554	struct sockaddr_storage	gr_group;	/* group address */
555};
556
557struct group_source_req {
558	uint32_t		gsr_interface;	/* interface index */
559	struct sockaddr_storage	gsr_group;	/* group address */
560	struct sockaddr_storage	gsr_source;	/* source address */
561};
562
563#ifndef __MSFILTERREQ_DEFINED
564#define __MSFILTERREQ_DEFINED
565/*
566 * The following structure is private; do not use it from user applications.
567 * It is used to communicate IP_MSFILTER/IPV6_MSFILTER information between
568 * the RFC 3678 libc functions and the kernel.
569 */
570struct __msfilterreq {
571	uint32_t		 msfr_ifindex;	/* interface index */
572	uint32_t		 msfr_fmode;	/* filter mode for group */
573	uint32_t		 msfr_nsrcs;	/* # of sources in msfr_srcs */
574	struct sockaddr_storage	 msfr_group;	/* group address */
575	struct sockaddr_storage	*msfr_srcs;	/* pointer to the first member
576						 * of a contiguous array of
577						 * sources to filter in full.
578						 */
579};
580#endif
581
582struct sockaddr;
583
584/*
585 * Advanced (Full-state) APIs [RFC3678]
586 * The RFC specifies uint_t for the 6th argument to [sg]etsourcefilter().
587 * We use uint32_t here to be consistent.
588 */
589int	setipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t,
590	    uint32_t, struct in_addr *);
591int	getipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t *,
592	    uint32_t *, struct in_addr *);
593int	setsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
594	    uint32_t, uint32_t, struct sockaddr_storage *);
595int	getsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
596	    uint32_t *, uint32_t *, struct sockaddr_storage *);
597
598/*
599 * Filter modes; also used to represent per-socket filter mode internally.
600 */
601#define	MCAST_UNDEFINED	0	/* fmode: not yet defined */
602#define	MCAST_INCLUDE	1	/* fmode: include these source(s) */
603#define	MCAST_EXCLUDE	2	/* fmode: exclude these source(s) */
604
605/*
606 * Argument for IP_PORTRANGE:
607 * - which range to search when port is unspecified at bind() or connect()
608 */
609#define	IP_PORTRANGE_DEFAULT	0	/* default range */
610#define	IP_PORTRANGE_HIGH	1	/* "high" - request firewall bypass */
611#define	IP_PORTRANGE_LOW	2	/* "low" - vouchsafe security */
612
613/*
614 * Identifiers for IP sysctl nodes
615 */
616#define	IPCTL_FORWARDING	1	/* act as router */
617#define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
618#define	IPCTL_DEFTTL		3	/* default TTL */
619#ifdef notyet
620#define	IPCTL_DEFMTU		4	/* default MTU */
621#endif
622/*	IPCTL_RTEXPIRE		5	deprecated */
623/*	IPCTL_RTMINEXPIRE	6	deprecated */
624/*	IPCTL_RTMAXCACHE	7	deprecated */
625#define	IPCTL_SOURCEROUTE	8	/* may perform source routes */
626#define	IPCTL_DIRECTEDBROADCAST	9	/* may re-broadcast received packets */
627#define	IPCTL_INTRQMAXLEN	10	/* max length of netisr queue */
628#define	IPCTL_INTRQDROPS	11	/* number of netisr q drops */
629#define	IPCTL_STATS		12	/* ipstat structure */
630#define	IPCTL_ACCEPTSOURCEROUTE	13	/* may accept source routed packets */
631#define	IPCTL_FASTFORWARDING	14	/* use fast IP forwarding code */
632					/* 15, unused, was: IPCTL_KEEPFAITH  */
633#define	IPCTL_GIF_TTL		16	/* default TTL for gif encap packet */
634#define	IPCTL_INTRDQMAXLEN	17	/* max length of direct netisr queue */
635#define	IPCTL_INTRDQDROPS	18	/* number of direct netisr q drops */
636
637#endif /* __BSD_VISIBLE */
638
639#ifdef _KERNEL
640
641struct ifnet; struct mbuf;	/* forward declarations for Standard C */
642struct in_ifaddr;
643
644int	 in_broadcast(struct in_addr, struct ifnet *);
645int	 in_ifaddr_broadcast(struct in_addr, struct in_ifaddr *);
646int	 in_canforward(struct in_addr);
647int	 in_localaddr(struct in_addr);
648int	 in_localip(struct in_addr);
649int	 in_ifhasaddr(struct ifnet *, struct in_addr);
650int	 inet_aton(const char *, struct in_addr *); /* in libkern */
651char	*inet_ntoa_r(struct in_addr ina, char *buf); /* in libkern */
652char	*inet_ntop(int, const void *, char *, socklen_t); /* in libkern */
653int	 inet_pton(int af, const char *, void *); /* in libkern */
654void	 in_ifdetach(struct ifnet *);
655
656#define	in_hosteq(s, t)	((s).s_addr == (t).s_addr)
657#define	in_nullhost(x)	((x).s_addr == INADDR_ANY)
658#define	in_allhosts(x)	((x).s_addr == htonl(INADDR_ALLHOSTS_GROUP))
659
660#define	satosin(sa)	((struct sockaddr_in *)(sa))
661#define	sintosa(sin)	((struct sockaddr *)(sin))
662#define	ifatoia(ifa)	((struct in_ifaddr *)(ifa))
663#endif /* _KERNEL */
664
665/* INET6 stuff */
666#if __POSIX_VISIBLE >= 200112
667#define	__KAME_NETINET_IN_H_INCLUDED_
668#include <netinet6/in6.h>
669#undef __KAME_NETINET_IN_H_INCLUDED_
670#endif
671
672#endif /* !_NETINET_IN_H_*/
673