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