2 * Copyright (c) 1982, 1986, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 * 4. 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.
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
29 * @(#)in.h 8.3 (Berkeley) 1/3/94
32 * Dec 2010: Modified for ROS by Barret Rhoden <brho@cs.berkeley.edu>. Took out
33 * the structs we don't need yet, leaving the bits and some macros behind.
36 #ifndef ROS_KERN_BITS_NETINET_H
37 #define ROS_KERN_BITS_NETINET_H
39 #include <ros/common.h>
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 */
50 /* modified to be consistent with linux and our user space tool chain
51 * we need to make our mind up about bsd/linux structs
53 #define INADDR_ANY (struct in_addr) {0x00000000}
54 #define INADDR_BROADCAST (struct in_addr) {0xffffffff} /* must be masked */
57 #define IPADDR_ANY ((uint32_t)0x00000000UL)
58 /** 255.255.255.255 */
59 #define IPADDR_BROADCAST ((uint32_t)0xffffffffUL)
61 #define htonl(x) cpu_to_be32(x)
62 #define htons(x) cpu_to_be16(x)
63 #define ntohl(x) be32_to_cpu(x)
64 #define ntohs(x) be16_to_cpu(x)
66 #define IPPROTO_RAW 255 /* raw IP packet */
67 #define INET_ADDRSTRLEN 16
70 * Constants and structures defined by the internet system,
71 * Per RFC 790, September 1981, and numerous additions.
75 * Protocols (RFC 1700)
77 #define IPPROTO_HOPOPTS 0 /* IP6 hop-by-hop options */
78 #define IPPROTO_IGMP 2 /* group mgmt protocol */
79 #define IPPROTO_GGP 3 /* gateway^2 (deprecated) */
80 #define IPPROTO_IPV4 4 /* IPv4 encapsulation */
81 #define IPPROTO_IPIP IPPROTO_IPV4 /* for compatibility */
82 #define IPPROTO_ST 7 /* Stream protocol II */
83 #define IPPROTO_EGP 8 /* exterior gateway protocol */
84 #define IPPROTO_PIGP 9 /* private interior gateway */
85 #define IPPROTO_RCCMON 10 /* BBN RCC Monitoring */
86 #define IPPROTO_NVPII 11 /* network voice protocol*/
87 #define IPPROTO_PUP 12 /* pup */
88 #define IPPROTO_ARGUS 13 /* Argus */
89 #define IPPROTO_EMCON 14 /* EMCON */
90 #define IPPROTO_XNET 15 /* Cross Net Debugger */
91 #define IPPROTO_CHAOS 16 /* Chaos*/
92 #define IPPROTO_MUX 18 /* Multiplexing */
93 #define IPPROTO_MEAS 19 /* DCN Measurement Subsystems */
94 #define IPPROTO_HMP 20 /* Host Monitoring */
95 #define IPPROTO_PRM 21 /* Packet Radio Measurement */
96 #define IPPROTO_IDP 22 /* xns idp */
97 #define IPPROTO_TRUNK1 23 /* Trunk-1 */
98 #define IPPROTO_TRUNK2 24 /* Trunk-2 */
99 #define IPPROTO_LEAF1 25 /* Leaf-1 */
100 #define IPPROTO_LEAF2 26 /* Leaf-2 */
101 #define IPPROTO_RDP 27 /* Reliable Data */
102 #define IPPROTO_IRTP 28 /* Reliable Transaction */
103 #define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
104 #define IPPROTO_BLT 30 /* Bulk Data Transfer */
105 #define IPPROTO_NSP 31 /* Network Services */
106 #define IPPROTO_INP 32 /* Merit Internodal */
107 #define IPPROTO_SEP 33 /* Sequential Exchange */
108 #define IPPROTO_3PC 34 /* Third Party Connect */
109 #define IPPROTO_IDPR 35 /* InterDomain Policy Routing */
110 #define IPPROTO_XTP 36 /* XTP */
111 #define IPPROTO_DDP 37 /* Datagram Delivery */
112 #define IPPROTO_CMTP 38 /* Control Message Transport */
113 #define IPPROTO_TPXX 39 /* TP++ Transport */
114 #define IPPROTO_IL 40 /* IL transport protocol */
115 #define IPPROTO_IPV6 41 /* IP6 header */
116 #define IPPROTO_SDRP 42 /* Source Demand Routing */
117 #define IPPROTO_ROUTING 43 /* IP6 routing header */
118 #define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */
119 #define IPPROTO_IDRP 45 /* InterDomain Routing*/
120 #define IPPROTO_RSVP 46 /* resource reservation */
121 #define IPPROTO_GRE 47 /* General Routing Encap. */
122 #define IPPROTO_MHRP 48 /* Mobile Host Routing */
123 #define IPPROTO_BHA 49 /* BHA */
124 #define IPPROTO_ESP 50 /* IP6 Encap Sec. Payload */
125 #define IPPROTO_AH 51 /* IP6 Auth Header */
126 #define IPPROTO_INLSP 52 /* Integ. Net Layer Security */
127 #define IPPROTO_SWIPE 53 /* IP with encryption */
128 #define IPPROTO_NHRP 54 /* Next Hop Resolution */
129 #define IPPROTO_MOBILE 55 /* IP Mobility */
130 #define IPPROTO_TLSP 56 /* Transport Layer Security */
131 #define IPPROTO_SKIP 57 /* SKIP */
132 #define IPPROTO_ICMPV6 58 /* ICMP6 */
133 #define IPPROTO_NONE 59 /* IP6 no next header */
134 #define IPPROTO_DSTOPTS 60 /* IP6 destination option */
135 #define IPPROTO_AHIP 61 /* any host internal protocol */
136 #define IPPROTO_CFTP 62 /* CFTP */
137 #define IPPROTO_HELLO 63 /* "hello" routing protocol */
138 #define IPPROTO_SATEXPAK 64 /* SATNET/Backroom EXPAK */
139 #define IPPROTO_KRYPTOLAN 65 /* Kryptolan */
140 #define IPPROTO_RVD 66 /* Remote Virtual Disk */
141 #define IPPROTO_IPPC 67 /* Pluribus Packet Core */
142 #define IPPROTO_ADFS 68 /* Any distributed FS */
143 #define IPPROTO_SATMON 69 /* Satnet Monitoring */
144 #define IPPROTO_VISA 70 /* VISA Protocol */
145 #define IPPROTO_IPCV 71 /* Packet Core Utility */
146 #define IPPROTO_CPNX 72 /* Comp. Prot. Net. Executive */
147 #define IPPROTO_CPHB 73 /* Comp. Prot. HeartBeat */
148 #define IPPROTO_WSN 74 /* Wang Span Network */
149 #define IPPROTO_PVP 75 /* Packet Video Protocol */
150 #define IPPROTO_BRSATMON 76 /* BackRoom SATNET Monitoring */
151 #define IPPROTO_ND 77 /* Sun net disk proto (temp.) */
152 #define IPPROTO_WBMON 78 /* WIDEBAND Monitoring */
153 #define IPPROTO_WBEXPAK 79 /* WIDEBAND EXPAK */
154 #define IPPROTO_EON 80 /* ISO cnlp */
155 #define IPPROTO_VMTP 81 /* VMTP */
156 #define IPPROTO_SVMTP 82 /* Secure VMTP */
157 #define IPPROTO_VINES 83 /* Banyon VINES */
158 #define IPPROTO_TTP 84 /* TTP */
159 #define IPPROTO_IGP 85 /* NSFNET-IGP */
160 #define IPPROTO_DGP 86 /* dissimilar gateway prot. */
161 #define IPPROTO_TCF 87 /* TCF */
162 #define IPPROTO_IGRP 88 /* Cisco/GXS IGRP */
163 #define IPPROTO_OSPFIGP 89 /* OSPFIGP */
164 #define IPPROTO_SRPC 90 /* Strite RPC protocol */
165 #define IPPROTO_LARP 91 /* Locus Address Resoloution */
166 #define IPPROTO_MTP 92 /* Multicast Transport */
167 #define IPPROTO_AX25 93 /* AX.25 Frames */
168 #define IPPROTO_IPEIP 94 /* IP encapsulated in IP */
169 #define IPPROTO_MICP 95 /* Mobile Int.ing control */
170 #define IPPROTO_SCCSP 96 /* Semaphore Comm. security */
171 #define IPPROTO_ETHERIP 97 /* Ethernet IP encapsulation */
172 #define IPPROTO_ENCAP 98 /* encapsulation header */
173 #define IPPROTO_APES 99 /* any private encr. scheme */
174 #define IPPROTO_GMTP 100 /* GMTP*/
175 #define IPPROTO_IPCOMP 108 /* payload compression (IPComp) */
176 #define IPPROTO_SCTP 132 /* SCTP */
177 #define IPPROTO_MH 135 /* IPv6 Mobility Header */
178 /* 101-254: Partly Unassigned */
179 #define IPPROTO_PIM 103 /* Protocol Independent Mcast */
180 #define IPPROTO_CARP 112 /* CARP */
181 #define IPPROTO_PGM 113 /* PGM */
182 #define IPPROTO_PFSYNC 240 /* PFSYNC */
186 * Defined to avoid confusion. The master value is defined by
187 * PROTO_SPACER in sys/protosw.h.
189 #define IPPROTO_SPACER 32767 /* spacer for loadable protos */
192 * Local port number conventions:
194 * When a user does a bind(2) or connect(2) with a port number of zero,
195 * a non-conflicting local port address is chosen.
196 * The default range is IPPORT_HIFIRSTAUTO through
197 * IPPORT_HILASTAUTO, although that is settable by sysctl.
199 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
200 * default assignment range.
202 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
204 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
205 * into the "high" range. These are reserved for client outbound connections
206 * which do not want to be filtered by any firewalls.
208 * The value IP_PORTRANGE_LOW changes the range to the "low" are
209 * that is (by convention) restricted to privileged processes. This
210 * convention is based on "vouchsafe" principles only. It is only secure
211 * if you trust the remote host to restrict these ports.
213 * The default range of ports and the high range can be changed by
214 * sysctl(3). (net.inet.ip.port{hi,low}{first,last}_auto)
216 * Changing those values has bad security implications if you are
217 * using a stateless firewall that is allowing packets outside of that
218 * range in order to allow transparent outgoing connections.
220 * Such a firewall configuration will generally depend on the use of these
221 * default values. If you change them, you may find your Security
222 * Administrator looking for you with a heavy object.
224 * For a slightly more orthodox text view on this:
226 * ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
228 * port numbers are divided into three ranges:
230 * 0 - 1023 Well Known Ports
231 * 1024 - 49151 Registered Ports
232 * 49152 - 65535 Dynamic and/or Private Ports
237 * Ports < IPPORT_RESERVED are reserved for
238 * privileged processes (e.g. root). (IP_PORTRANGE_LOW)
240 #define IPPORT_RESERVED 1024
243 * Default local port range, used by IP_PORTRANGE_DEFAULT
245 #define IPPORT_EPHEMERALFIRST 10000
246 #define IPPORT_EPHEMERALLAST 65535
249 * Dynamic port range, used by IP_PORTRANGE_HIGH.
251 #define IPPORT_HIFIRSTAUTO 49152
252 #define IPPORT_HILASTAUTO 65535
255 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
256 * but higher than IPPORT_RESERVEDSTART. Traditionally the start value was
257 * 512, but that conflicts with some well-known-services that firewalls may
258 * have a fit if we use.
260 #define IPPORT_RESERVEDSTART 600
262 #define IPPORT_MAX 65535
265 * Definitions of bits in internet address integers.
266 * On subnets, the decomposition of addresses to host and net parts
267 * is done according to subnet mask, not the masks here.
269 #define IN_CLASSA(i) (((uint32_t)(i) & 0x80000000) == 0)
270 #define IN_CLASSA_NET 0xff000000
271 #define IN_CLASSA_NSHIFT 24
272 #define IN_CLASSA_HOST 0x00ffffff
273 #define IN_CLASSA_MAX 128
275 #define IN_CLASSB(i) (((uint32_t)(i) & 0xc0000000) == 0x80000000)
276 #define IN_CLASSB_NET 0xffff0000
277 #define IN_CLASSB_NSHIFT 16
278 #define IN_CLASSB_HOST 0x0000ffff
279 #define IN_CLASSB_MAX 65536
281 #define IN_CLASSC(i) (((uint32_t)(i) & 0xe0000000) == 0xc0000000)
282 #define IN_CLASSC_NET 0xffffff00
283 #define IN_CLASSC_NSHIFT 8
284 #define IN_CLASSC_HOST 0x000000ff
286 #define IN_CLASSD(i) (((uint32_t)(i) & 0xf0000000) == 0xe0000000)
287 #define IN_CLASSD_NET 0xf0000000 /* These ones aren't really */
288 #define IN_CLASSD_NSHIFT 28 /* net and host fields, but */
289 #define IN_CLASSD_HOST 0x0fffffff /* routing needn't know. */
290 #define IN_MULTICAST(i) IN_CLASSD(i)
292 #define IN_EXPERIMENTAL(i) (((uint32_t)(i) & 0xf0000000) == 0xf0000000)
293 #define IN_BADCLASS(i) (((uint32_t)(i) & 0xf0000000) == 0xf0000000)
295 #define IN_LINKLOCAL(i) (((uint32_t)(i) & 0xffff0000) == 0xa9fe0000)
296 #define IN_LOOPBACK(i) (((uint32_t)(i) & 0xff000000) == 0x7f000000)
297 #define IN_ZERONET(i) (((uint32_t)(i) & 0xff000000) == 0)
299 #define IN_PRIVATE(i) ((((uint32_t)(i) & 0xff000000) == 0x0a000000) || \
300 (((uint32_t)(i) & 0xfff00000) == 0xac100000) || \
301 (((uint32_t)(i) & 0xffff0000) == 0xc0a80000))
303 #define IN_LOCAL_GROUP(i) (((uint32_t)(i) & 0xffffff00) == 0xe0000000)
305 #define IN_ANY_LOCAL(i) (IN_LINKLOCAL(i) || IN_LOCAL_GROUP(i))
307 #define INADDR_LOOPBACK (uint32_t)0x7f000001
309 #define INADDR_UNSPEC_GROUP (uint32_t)0xe0000000 /* 224.0.0.0 */
310 #define INADDR_ALLHOSTS_GROUP (uint32_t)0xe0000001 /* 224.0.0.1 */
311 #define INADDR_ALLRTRS_GROUP (uint32_t)0xe0000002 /* 224.0.0.2 */
312 #define INADDR_ALLRPTS_GROUP (uint32_t)0xe0000016 /* 224.0.0.22, IGMPv3 */
313 #define INADDR_CARP_GROUP (uint32_t)0xe0000012 /* 224.0.0.18 */
314 #define INADDR_PFSYNC_GROUP (uint32_t)0xe00000f0 /* 224.0.0.240 */
315 #define INADDR_ALLMDNS_GROUP (uint32_t)0xe00000fb /* 224.0.0.251 */
316 #define INADDR_MAX_LOCAL_GROUP (uint32_t)0xe00000ff /* 224.0.0.255 */
318 #define IN_LOOPBACKNET 127 /* official! */
321 * Options for use with [gs]etsockopt at the IP level.
322 * First word of comment is data type; bool is stored in int.
324 #define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
325 #define IP_HDRINCL 2 /* int; header is included with data */
326 #define IP_TOS 3 /* int; IP type of service and preced. */
327 #define IP_TTL 4 /* int; IP time to live */
328 #define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
329 #define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
330 #define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
331 #define IP_SENDSRCADDR IP_RECVDSTADDR /* cmsg_type to set src addr */
332 #define IP_RETOPTS 8 /* ip_opts; set/get IP options */
333 #define IP_MULTICAST_IF 9 /* struct in_addr *or* struct ip_mreqn;
334 * set/get IP multicast i/f */
335 #define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
336 #define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
337 #define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
338 #define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
339 #define IP_MULTICAST_VIF 14 /* set/get IP mcast virt. iface */
340 #define IP_RSVP_ON 15 /* enable RSVP in kernel */
341 #define IP_RSVP_OFF 16 /* disable RSVP in kernel */
342 #define IP_RSVP_VIF_ON 17 /* set RSVP per-vif socket */
343 #define IP_RSVP_VIF_OFF 18 /* unset RSVP per-vif socket */
344 #define IP_PORTRANGE 19 /* int; range to choose for unspec port */
345 #define IP_RECVIF 20 /* bool; receive reception if w/dgram */
347 #define IP_IPSEC_POLICY 21 /* int; set/get security policy */
348 #define IP_FAITH 22 /* bool; accept FAITH'ed connections */
350 #define IP_ONESBCAST 23 /* bool: send all-ones broadcast */
351 #define IP_BINDANY 24 /* bool: allow bind to any address */
354 * Options for controlling the firewall and dummynet.
355 * Historical options (from 40 to 64) will eventually be
356 * replaced by only two options, IP_FW3 and IP_DUMMYNET3.
358 #define IP_FW_TABLE_ADD 40 /* add entry */
359 #define IP_FW_TABLE_DEL 41 /* delete entry */
360 #define IP_FW_TABLE_FLUSH 42 /* flush table */
361 #define IP_FW_TABLE_GETSIZE 43 /* get table size */
362 #define IP_FW_TABLE_LIST 44 /* list table contents */
364 #define IP_FW3 48 /* generic ipfw v.3 sockopts */
365 #define IP_DUMMYNET3 49 /* generic dummynet v.3 sockopts */
367 #define IP_FW_ADD 50 /* add a firewall rule to chain */
368 #define IP_FW_DEL 51 /* delete a firewall rule from chain */
369 #define IP_FW_FLUSH 52 /* flush firewall rule chain */
370 #define IP_FW_ZERO 53 /* clear single/all firewall counter(s) */
371 #define IP_FW_GET 54 /* get entire firewall rule chain */
372 #define IP_FW_RESETLOG 55 /* reset logging counters */
374 #define IP_FW_NAT_CFG 56 /* add/config a nat rule */
375 #define IP_FW_NAT_DEL 57 /* delete a nat rule */
376 #define IP_FW_NAT_GET_CONFIG 58 /* get configuration of a nat rule */
377 #define IP_FW_NAT_GET_LOG 59 /* get log of a nat rule */
379 #define IP_DUMMYNET_CONFIGURE 60 /* add/configure a dummynet pipe */
380 #define IP_DUMMYNET_DEL 61 /* delete a dummynet pipe from chain */
381 #define IP_DUMMYNET_FLUSH 62 /* flush dummynet */
382 #define IP_DUMMYNET_GET 64 /* get entire dummynet pipes */
384 #define IP_RECVTTL 65 /* bool; receive IP TTL w/dgram */
385 #define IP_MINTTL 66 /* minimum TTL for packet or drop */
386 #define IP_DONTFRAG 67 /* don't fragment packet */
388 /* IPv4 Source Filter Multicast API [RFC3678] */
389 #define IP_ADD_SOURCE_MEMBERSHIP 70 /* join a source-specific group */
390 #define IP_DROP_SOURCE_MEMBERSHIP 71 /* drop a single source */
391 #define IP_BLOCK_SOURCE 72 /* block a source */
392 #define IP_UNBLOCK_SOURCE 73 /* unblock a source */
394 /* The following option is private; do not use it from user applications. */
395 #define IP_MSFILTER 74 /* set/get filter list */
397 /* Protocol Independent Multicast API [RFC3678] */
398 #define MCAST_JOIN_GROUP 80 /* join an any-source group */
399 #define MCAST_LEAVE_GROUP 81 /* leave all sources for group */
400 #define MCAST_JOIN_SOURCE_GROUP 82 /* join a source-specific group */
401 #define MCAST_LEAVE_SOURCE_GROUP 83 /* leave a single source */
402 #define MCAST_BLOCK_SOURCE 84 /* block a source */
403 #define MCAST_UNBLOCK_SOURCE 85 /* unblock a source */
406 * Defaults and limits for options
408 #define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
409 #define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
412 * The imo_membership vector for each socket is now dynamically allocated at
413 * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
414 * according to a power-of-two increment.
416 #define IP_MIN_MEMBERSHIPS 31
417 #define IP_MAX_MEMBERSHIPS 4095
420 * Default resource limits for IPv4 multicast source filtering.
421 * These may be modified by sysctl.
423 #define IP_MAX_GROUP_SRC_FILTER 512 /* sources per group */
424 #define IP_MAX_SOCK_SRC_FILTER 128 /* sources per socket/group */
426 #endif /* ROS_KERN_BITS_NETINET_H */