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