1 /* $NetBSD: in.h,v 1.55 2001/06/02 16:17:09 thorpej Exp $ */ 2 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. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by the University of 18 * California, Berkeley and its contributors. 19 * 4. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * @(#)in.h 8.3 (Berkeley) 1/3/94 36 */ 37 38 /* 39 * Constants and structures defined by the internet system, 40 * Per RFC 790, September 1981, and numerous additions. 41 */ 42 43 #ifndef _NETINET_IN_H_ 44 #define _NETINET_IN_H_ 45 46 #include <sys/ansi.h> 47 48 #ifndef sa_family_t 49 typedef __sa_family_t sa_family_t; 50 #define sa_family_t __sa_family_t 51 #endif 52 53 /* 54 * Protocols 55 */ 56 #define IPPROTO_IP 0 /* dummy for IP */ 57 #define IPPROTO_HOPOPTS 0 /* IP6 hop-by-hop options */ 58 #define IPPROTO_ICMP 1 /* control message protocol */ 59 #define IPPROTO_IGMP 2 /* group mgmt protocol */ 60 #define IPPROTO_GGP 3 /* gateway^2 (deprecated) */ 61 #define IPPROTO_IPV4 4 /* IP header */ 62 #define IPPROTO_IPIP 4 /* IP inside IP */ 63 #define IPPROTO_TCP 6 /* tcp */ 64 #define IPPROTO_EGP 8 /* exterior gateway protocol */ 65 #define IPPROTO_PUP 12 /* pup */ 66 #define IPPROTO_UDP 17 /* user datagram protocol */ 67 #define IPPROTO_IDP 22 /* xns idp */ 68 #define IPPROTO_TP 29 /* tp-4 w/ class negotiation */ 69 #define IPPROTO_IPV6 41 /* IP6 header */ 70 #define IPPROTO_ROUTING 43 /* IP6 routing header */ 71 #define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */ 72 #define IPPROTO_RSVP 46 /* resource reservation */ 73 #define IPPROTO_GRE 47 /* GRE encaps RFC 1701 */ 74 #define IPPROTO_ESP 50 /* encap. security payload */ 75 #define IPPROTO_AH 51 /* authentication header */ 76 #define IPPROTO_MOBILE 55 /* IP Mobility RFC 2004 */ 77 #define IPPROTO_IPV6_ICMP 58 /* IPv6 ICMP */ 78 #define IPPROTO_ICMPV6 58 /* ICMP6 */ 79 #define IPPROTO_NONE 59 /* IP6 no next header */ 80 #define IPPROTO_DSTOPTS 60 /* IP6 destination option */ 81 #define IPPROTO_EON 80 /* ISO cnlp */ 82 #define IPPROTO_ENCAP 98 /* encapsulation header */ 83 #define IPPROTO_PIM 103 /* Protocol indep. multicast */ 84 #define IPPROTO_IPCOMP 108 /* IP Payload Comp. Protocol */ 85 #define IPPROTO_VRRP 112 /* VRRP RFC 2338 */ 86 87 #define IPPROTO_RAW 255 /* raw IP packet */ 88 #define IPPROTO_MAX 256 89 90 /* last return value of *_input(), meaning "all job for this pkt is done". */ 91 #define IPPROTO_DONE 257 92 93 94 /* 95 * Local port number conventions: 96 * 97 * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root), 98 * unless a kernel is compiled with IPNOPRIVPORTS defined. 99 * 100 * When a user does a bind(2) or connect(2) with a port number of zero, 101 * a non-conflicting local port address is chosen. 102 * 103 * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although 104 * that is settable by sysctl(3); net.inet.ip.anonportmin and 105 * net.inet.ip.anonportmax respectively. 106 * 107 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this 108 * default assignment range. 109 * 110 * The value IP_PORTRANGE_DEFAULT causes the default behavior. 111 * 112 * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT, 113 * and exists only for FreeBSD compatibility purposes. 114 * 115 * The value IP_PORTRANGE_LOW changes the range to the "low" are 116 * that is (by convention) restricted to privileged processes. 117 * This convention is based on "vouchsafe" principles only. 118 * It is only secure if you trust the remote host to restrict these ports. 119 * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX. 120 */ 121 122 #define IPPORT_RESERVED 1024 123 #define IPPORT_ANONMIN 49152 124 #define IPPORT_ANONMAX 65535 125 #define IPPORT_RESERVEDMIN 600 126 #define IPPORT_RESERVEDMAX (IPPORT_RESERVED-1) 127 128 /* 129 * Internet address (a structure for historical reasons) 130 */ 131 struct in_addr { 132 u_int32_t s_addr; 133 } __attribute__((__packed__)); 134 135 /* 136 * Definitions of bits in internet address integers. 137 * On subnets, the decomposition of addresses to host and net parts 138 * is done according to subnet mask, not the masks here. 139 * 140 * By byte-swapping the constants, we avoid ever having to byte-swap IP 141 * addresses inside the kernel. Unfortunately, user-level programs rely 142 * on these macros not doing byte-swapping. 143 */ 144 #ifdef _KERNEL 145 #define __IPADDR(x) ((u_int32_t) htonl((u_int32_t)(x))) 146 #else 147 #define __IPADDR(x) ((u_int32_t)(x)) 148 #endif 149 150 #define IN_CLASSA(i) (((u_int32_t)(i) & __IPADDR(0x80000000)) == \ 151 __IPADDR(0x00000000)) 152 #define IN_CLASSA_NET __IPADDR(0xff000000) 153 #define IN_CLASSA_NSHIFT 24 154 #define IN_CLASSA_HOST __IPADDR(0x00ffffff) 155 #define IN_CLASSA_MAX 128 156 157 #define IN_CLASSB(i) (((u_int32_t)(i) & __IPADDR(0xc0000000)) == \ 158 __IPADDR(0x80000000)) 159 #define IN_CLASSB_NET __IPADDR(0xffff0000) 160 #define IN_CLASSB_NSHIFT 16 161 #define IN_CLASSB_HOST __IPADDR(0x0000ffff) 162 #define IN_CLASSB_MAX 65536 163 164 #define IN_CLASSC(i) (((u_int32_t)(i) & __IPADDR(0xe0000000)) == \ 165 __IPADDR(0xc0000000)) 166 #define IN_CLASSC_NET __IPADDR(0xffffff00) 167 #define IN_CLASSC_NSHIFT 8 168 #define IN_CLASSC_HOST __IPADDR(0x000000ff) 169 170 #define IN_CLASSD(i) (((u_int32_t)(i) & __IPADDR(0xf0000000)) == \ 171 __IPADDR(0xe0000000)) 172 /* These ones aren't really net and host fields, but routing needn't know. */ 173 #define IN_CLASSD_NET __IPADDR(0xf0000000) 174 #define IN_CLASSD_NSHIFT 28 175 #define IN_CLASSD_HOST __IPADDR(0x0fffffff) 176 #define IN_MULTICAST(i) IN_CLASSD(i) 177 178 #define IN_EXPERIMENTAL(i) (((u_int32_t)(i) & __IPADDR(0xf0000000)) == \ 179 __IPADDR(0xf0000000)) 180 #define IN_BADCLASS(i) (((u_int32_t)(i) & __IPADDR(0xf0000000)) == \ 181 __IPADDR(0xf0000000)) 182 183 #define IN_LOCAL_GROUP(i) (((u_int32_t)(i) & __IPADDR(0xffffff00)) == \ 184 __IPADDR(0xe0000000)) 185 186 #define INADDR_ANY __IPADDR(0x00000000) 187 #define INADDR_LOOPBACK __IPADDR(0x7f000001) 188 #define INADDR_BROADCAST __IPADDR(0xffffffff) /* must be masked */ 189 #ifndef _KERNEL 190 #define INADDR_NONE __IPADDR(0xffffffff) /* -1 return */ 191 #endif 192 193 #define INADDR_UNSPEC_GROUP __IPADDR(0xe0000000) /* 224.0.0.0 */ 194 #define INADDR_ALLHOSTS_GROUP __IPADDR(0xe0000001) /* 224.0.0.1 */ 195 #define INADDR_ALLRTRS_GROUP __IPADDR(0xe0000002) /* 224.0.0.2 */ 196 #define INADDR_MAX_LOCAL_GROUP __IPADDR(0xe00000ff) /* 224.0.0.255 */ 197 198 #define IN_LOOPBACKNET 127 /* official! */ 199 200 /* 201 * Socket address, internet style. 202 */ 203 struct sockaddr_in { 204 u_int8_t sin_len; 205 sa_family_t sin_family; 206 u_int16_t sin_port; 207 struct in_addr sin_addr; 208 int8_t sin_zero[8]; 209 }; 210 211 #define INET_ADDRSTRLEN 16 212 213 /* 214 * Structure used to describe IP options. 215 * Used to store options internally, to pass them to a process, 216 * or to restore options retrieved earlier. 217 * The ip_dst is used for the first-hop gateway when using a source route 218 * (this gets put into the header proper). 219 */ 220 struct ip_opts { 221 struct in_addr ip_dst; /* first hop, 0 w/o src rt */ 222 int8_t ip_opts[40]; /* actually variable in size */ 223 }; 224 225 /* 226 * Options for use with [gs]etsockopt at the IP level. 227 * First word of comment is data type; bool is stored in int. 228 */ 229 #define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */ 230 #define IP_HDRINCL 2 /* int; header is included with data */ 231 #define IP_TOS 3 /* int; IP type of service and preced. */ 232 #define IP_TTL 4 /* int; IP time to live */ 233 #define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */ 234 #define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */ 235 #define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */ 236 #define IP_RETOPTS 8 /* ip_opts; set/get IP options */ 237 #define IP_MULTICAST_IF 9 /* in_addr; set/get IP multicast i/f */ 238 #define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */ 239 #define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */ 240 #define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */ 241 #define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */ 242 #define IP_PORTRANGE 19 /* int; range to use for ephemeral port */ 243 #define IP_RECVIF 20 /* bool; receive reception if w/dgram */ 244 #define IP_ERRORMTU 21 /* int; get MTU of last xmit = EMSGSIZE */ 245 #if 1 /*IPSEC*/ 246 #define IP_IPSEC_POLICY 22 /* struct; get/set security policy */ 247 #endif 248 249 /* 250 * Defaults and limits for options 251 */ 252 #define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */ 253 #define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */ 254 #define IP_MAX_MEMBERSHIPS 20 /* per socket; must fit in one mbuf */ 255 256 /* 257 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP. 258 */ 259 struct ip_mreq { 260 struct in_addr imr_multiaddr; /* IP multicast address of group */ 261 struct in_addr imr_interface; /* local IP address of interface */ 262 }; 263 264 /* 265 * Argument for IP_PORTRANGE: 266 * - which range to search when port is unspecified at bind() or connect() 267 */ 268 #define IP_PORTRANGE_DEFAULT 0 /* default range */ 269 #define IP_PORTRANGE_HIGH 1 /* same as DEFAULT (FreeBSD compat) */ 270 #define IP_PORTRANGE_LOW 2 /* use privileged range */ 271 272 #if !defined(_XOPEN_SOURCE) 273 /* 274 * Definitions for inet sysctl operations. 275 * 276 * Third level is protocol number. 277 * Fourth level is desired variable within that protocol. 278 */ 279 #define IPPROTO_MAXID (IPPROTO_AH + 1) /* don't list to IPPROTO_MAX */ 280 281 #define CTL_IPPROTO_NAMES { \ 282 { "ip", CTLTYPE_NODE }, \ 283 { "icmp", CTLTYPE_NODE }, \ 284 { "igmp", CTLTYPE_NODE }, \ 285 { "ggp", CTLTYPE_NODE }, \ 286 { 0, 0 }, \ 287 { 0, 0 }, \ 288 { "tcp", CTLTYPE_NODE }, \ 289 { 0, 0 }, \ 290 { "egp", CTLTYPE_NODE }, \ 291 { 0, 0 }, \ 292 { 0, 0 }, \ 293 { 0, 0 }, \ 294 { "pup", CTLTYPE_NODE }, \ 295 { 0, 0 }, \ 296 { 0, 0 }, \ 297 { 0, 0 }, \ 298 { 0, 0 }, \ 299 { "udp", CTLTYPE_NODE }, \ 300 { 0, 0 }, \ 301 { 0, 0 }, \ 302 { 0, 0 }, \ 303 { 0, 0 }, \ 304 { "idp", CTLTYPE_NODE }, \ 305 { 0, 0 }, \ 306 { 0, 0 }, \ 307 { 0, 0 }, \ 308 { 0, 0 }, \ 309 { 0, 0 }, \ 310 { 0, 0 }, \ 311 { 0, 0 }, \ 312 { 0, 0 }, \ 313 { 0, 0 }, \ 314 { 0, 0 }, \ 315 { 0, 0 }, \ 316 { 0, 0 }, \ 317 { 0, 0 }, \ 318 { 0, 0 }, \ 319 { 0, 0 }, \ 320 { 0, 0 }, \ 321 { 0, 0 }, \ 322 { 0, 0 }, \ 323 { 0, 0 }, \ 324 { 0, 0 }, \ 325 { 0, 0 }, \ 326 { 0, 0 }, \ 327 { 0, 0 }, \ 328 { 0, 0 }, \ 329 { 0, 0 }, \ 330 { 0, 0 }, \ 331 { 0, 0 }, \ 332 { 0, 0 }, \ 333 { "ipsec", CTLTYPE_NODE }, \ 334 } 335 336 /* 337 * Names for IP sysctl objects 338 */ 339 #define IPCTL_FORWARDING 1 /* act as router */ 340 #define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */ 341 #define IPCTL_DEFTTL 3 /* default TTL */ 342 #ifdef notyet 343 #define IPCTL_DEFMTU 4 /* default MTU */ 344 #endif 345 #define IPCTL_FORWSRCRT 5 /* forward source-routed packets */ 346 #define IPCTL_DIRECTEDBCAST 6 /* default broadcast behavior */ 347 #define IPCTL_ALLOWSRCRT 7 /* allow/drop all source-routed pkts */ 348 #define IPCTL_SUBNETSARELOCAL 8 /* treat subnets as local addresses */ 349 #define IPCTL_MTUDISC 9 /* allow path MTU discovery */ 350 #define IPCTL_ANONPORTMIN 10 /* minimum ephemeral port */ 351 #define IPCTL_ANONPORTMAX 11 /* maximum ephemeral port */ 352 #define IPCTL_MTUDISCTIMEOUT 12 /* allow path MTU discovery */ 353 #define IPCTL_MAXFLOWS 13 /* maximum ip flows allowed */ 354 #define IPCTL_HOSTZEROBROADCAST 14 /* is host zero a broadcast addr? */ 355 #define IPCTL_GIF_TTL 15 /* default TTL for gif encap packet */ 356 #define IPCTL_LOWPORTMIN 16 /* minimum reserved port */ 357 #define IPCTL_LOWPORTMAX 17 /* maximum reserved port */ 358 #define IPCTL_MAXFRAGPACKETS 18 /* max packets reassembly queue */ 359 #define IPCTL_MAXID 19 360 361 #define IPCTL_NAMES { \ 362 { 0, 0 }, \ 363 { "forwarding", CTLTYPE_INT }, \ 364 { "redirect", CTLTYPE_INT }, \ 365 { "ttl", CTLTYPE_INT }, \ 366 { "mtu", CTLTYPE_INT }, \ 367 { "forwsrcrt", CTLTYPE_INT }, \ 368 { "directed-broadcast", CTLTYPE_INT }, \ 369 { "allowsrcrt", CTLTYPE_INT }, \ 370 { "subnetsarelocal", CTLTYPE_INT }, \ 371 { "mtudisc", CTLTYPE_INT }, \ 372 { "anonportmin", CTLTYPE_INT }, \ 373 { "anonportmax", CTLTYPE_INT }, \ 374 { "mtudisctimeout", CTLTYPE_INT }, \ 375 { "maxflows", CTLTYPE_INT }, \ 376 { "hostzerobroadcast", CTLTYPE_INT }, \ 377 { "gifttl", CTLTYPE_INT }, \ 378 { "lowportmin", CTLTYPE_INT }, \ 379 { "lowportmax", CTLTYPE_INT }, \ 380 { "maxfragpackets", CTLTYPE_INT }, \ 381 } 382 #endif /* !_XOPEN_SOURCE */ 383 384 /* INET6 stuff */ 385 #define __KAME_NETINET_IN_H_INCLUDED_ 386 #include <netinet6/in6.h> 387 #undef __KAME_NETINET_IN_H_INCLUDED_ 388 389 #ifdef _KERNEL 390 /* 391 * in_cksum_phdr: 392 * 393 * Compute significant parts of the IPv4 checksum pseudo-header 394 * for use in a delayed TCP/UDP checksum calculation. 395 * 396 * Args: 397 * 398 * src Source IP address 399 * dst Destination IP address 400 * lenproto htons(proto-hdr-len + proto-number) 401 */ 402 static __inline u_int16_t __attribute__((__unused__)) 403 in_cksum_phdr(u_int32_t src, u_int32_t dst, u_int32_t lenproto) 404 { 405 u_int32_t sum; 406 407 sum = lenproto + 408 (u_int16_t)(src >> 16) + 409 (u_int16_t)(src /*& 0xffff*/) + 410 (u_int16_t)(dst >> 16) + 411 (u_int16_t)(dst /*& 0xffff*/); 412 413 sum = (u_int16_t)(sum >> 16) + (u_int16_t)(sum /*& 0xffff*/); 414 415 if (sum > 0xffff) 416 sum -= 0xffff; 417 418 return (sum); 419 } 420 421 /* 422 * in_cksum_addword: 423 * 424 * Add the two 16-bit network-order values, carry, and return. 425 */ 426 static __inline u_int16_t __attribute__((__unused__)) 427 in_cksum_addword(u_int16_t a, u_int16_t b) 428 { 429 u_int32_t sum = a + b; 430 431 if (sum > 0xffff) 432 sum -= 0xffff; 433 434 return (sum); 435 } 436 437 extern struct in_addr zeroin_addr; 438 extern u_char ip_protox[]; 439 440 int in_broadcast __P((struct in_addr, struct ifnet *)); 441 int in_canforward __P((struct in_addr)); 442 int in_cksum __P((struct mbuf *, int)); 443 int in4_cksum __P((struct mbuf *, u_int8_t, int, int)); 444 void in_delayed_cksum __P((struct mbuf *)); 445 int in_localaddr __P((struct in_addr)); 446 void in_socktrim __P((struct sockaddr_in *)); 447 448 #define in_hosteq(s,t) ((s).s_addr == (t).s_addr) 449 #define in_nullhost(x) ((x).s_addr == INADDR_ANY) 450 451 #define satosin(sa) ((struct sockaddr_in *)(sa)) 452 #define sintosa(sin) ((struct sockaddr *)(sin)) 453 #define ifatoia(ifa) ((struct in_ifaddr *)(ifa)) 454 #endif /* _KERNEL */ 455 456 #endif /* !_NETINET_IN_H_ */ 457