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