source: rtems/cpukit/libnetworking/netinet/in.h @ ef6d9efb

4.104.114.84.95
Last change on this file since ef6d9efb was ef6d9efb, checked in by Chris Johns <chrisj@…>, on 05/15/03 at 09:27:03

PR406 - Added INET_ADDRSTRLEN per the SUSv3 standard.

  • Property mode set to 100644
File size: 16.8 KB
Line 
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. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *      This product includes software developed by the University of
16 *      California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *      @(#)in.h        8.3 (Berkeley) 1/3/94
34 * $Id$
35 */
36
37#ifndef _NETINET_IN_H_
38#define _NETINET_IN_H_
39
40#include <machine/endian.h>  /* for ntohx routines */
41
42/*
43 * Constants and structures defined by the internet system,
44 * Per RFC 790, September 1981, and numerous additions.
45 */
46
47/*
48 * Protocols (RFC 1700)
49 */
50#define IPPROTO_IP              0               /* dummy for IP */
51#define IPPROTO_ICMP            1               /* control message protocol */
52#define IPPROTO_IGMP            2               /* group mgmt protocol */
53#define IPPROTO_GGP             3               /* gateway^2 (deprecated) */
54#define IPPROTO_IPIP            4               /* IP encapsulation in IP */
55#define IPPROTO_TCP             6               /* tcp */
56#define IPPROTO_ST              7               /* Stream protocol II */
57#define IPPROTO_EGP             8               /* exterior gateway protocol */
58#define IPPROTO_PIGP            9               /* private interior gateway */
59#define IPPROTO_RCCMON          10              /* BBN RCC Monitoring */
60#define IPPROTO_NVPII           11              /* network voice protocol*/
61#define IPPROTO_PUP             12              /* pup */
62#define IPPROTO_ARGUS           13              /* Argus */
63#define IPPROTO_EMCON           14              /* EMCON */
64#define IPPROTO_XNET            15              /* Cross Net Debugger */
65#define IPPROTO_CHAOS           16              /* Chaos*/
66#define IPPROTO_UDP             17              /* user datagram protocol */
67#define IPPROTO_MUX             18              /* Multiplexing */
68#define IPPROTO_MEAS            19              /* DCN Measurement Subsystems */
69#define IPPROTO_HMP             20              /* Host Monitoring */
70#define IPPROTO_PRM             21              /* Packet Radio Measurement */
71#define IPPROTO_IDP             22              /* xns idp */
72#define IPPROTO_TRUNK1          23              /* Trunk-1 */
73#define IPPROTO_TRUNK2          24              /* Trunk-2 */
74#define IPPROTO_LEAF1           25              /* Leaf-1 */
75#define IPPROTO_LEAF2           26              /* Leaf-2 */
76#define IPPROTO_RDP             27              /* Reliable Data */
77#define IPPROTO_IRTP            28              /* Reliable Transaction */
78#define IPPROTO_TP              29              /* tp-4 w/ class negotiation */
79#define IPPROTO_BLT             30              /* Bulk Data Transfer */
80#define IPPROTO_NSP             31              /* Network Services */
81#define IPPROTO_INP             32              /* Merit Internodal */
82#define IPPROTO_SEP             33              /* Sequential Exchange */
83#define IPPROTO_3PC             34              /* Third Party Connect */
84#define IPPROTO_IDPR            35              /* InterDomain Policy Routing */
85#define IPPROTO_XTP             36              /* XTP */
86#define IPPROTO_DDP             37              /* Datagram Delivery */
87#define IPPROTO_CMTP            38              /* Control Message Transport */
88#define IPPROTO_TPXX            39              /* TP++ Transport */
89#define IPPROTO_IL              40              /* IL transport protocol */
90#define IPPROTO_SIP             41              /* Simple Internet Protocol */
91#define IPPROTO_SDRP            42              /* Source Demand Routing */
92#define IPPROTO_SIPSR           43              /* SIP Source Route */
93#define IPPROTO_SIPFRAG         44              /* SIP Fragment */
94#define IPPROTO_IDRP            45              /* InterDomain Routing*/
95#define IPPROTO_RSVP            46              /* resource reservation */
96#define IPPROTO_GRE             47              /* General Routing Encap. */
97#define IPPROTO_MHRP            48              /* Mobile Host Routing */
98#define IPPROTO_BHA             49              /* BHA */
99#define IPPROTO_ESP             50              /* SIPP Encap Sec. Payload */
100#define IPPROTO_AH              51              /* SIPP Auth Header */
101#define IPPROTO_INLSP           52              /* Integ. Net Layer Security */
102#define IPPROTO_SWIPE           53              /* IP with encryption */
103#define IPPROTO_NHRP            54              /* Next Hop Resolution */
104/* 55-60: Unassigned */
105#define IPPROTO_AHIP            61              /* any host internal protocol */
106#define IPPROTO_CFTP            62              /* CFTP */
107#define IPPROTO_HELLO           63              /* "hello" routing protocol */
108#define IPPROTO_SATEXPAK        64              /* SATNET/Backroom EXPAK */
109#define IPPROTO_KRYPTOLAN       65              /* Kryptolan */
110#define IPPROTO_RVD             66              /* Remote Virtual Disk */
111#define IPPROTO_IPPC            67              /* Pluribus Packet Core */
112#define IPPROTO_ADFS            68              /* Any distributed FS */
113#define IPPROTO_SATMON          69              /* Satnet Monitoring */
114#define IPPROTO_VISA            70              /* VISA Protocol */
115#define IPPROTO_IPCV            71              /* Packet Core Utility */
116#define IPPROTO_CPNX            72              /* Comp. Prot. Net. Executive */
117#define IPPROTO_CPHB            73              /* Comp. Prot. HeartBeat */
118#define IPPROTO_WSN             74              /* Wang Span Network */
119#define IPPROTO_PVP             75              /* Packet Video Protocol */
120#define IPPROTO_BRSATMON        76              /* BackRoom SATNET Monitoring */
121#define IPPROTO_ND              77              /* Sun net disk proto (temp.) */
122#define IPPROTO_WBMON           78              /* WIDEBAND Monitoring */
123#define IPPROTO_WBEXPAK         79              /* WIDEBAND EXPAK */
124#define IPPROTO_EON             80              /* ISO cnlp */
125#define IPPROTO_VMTP            81              /* VMTP */
126#define IPPROTO_SVMTP           82              /* Secure VMTP */
127#define IPPROTO_VINES           83              /* Banyon VINES */
128#define IPPROTO_TTP             84              /* TTP */
129#define IPPROTO_IGP             85              /* NSFNET-IGP */
130#define IPPROTO_DGP             86              /* dissimilar gateway prot. */
131#define IPPROTO_TCF             87              /* TCF */
132#define IPPROTO_IGRP            88              /* Cisco/GXS IGRP */
133#define IPPROTO_OSPFIGP         89              /* OSPFIGP */
134#define IPPROTO_SRPC            90              /* Strite RPC protocol */
135#define IPPROTO_LARP            91              /* Locus Address Resoloution */
136#define IPPROTO_MTP             92              /* Multicast Transport */
137#define IPPROTO_AX25            93              /* AX.25 Frames */
138#define IPPROTO_IPEIP           94              /* IP encapsulated in IP */
139#define IPPROTO_MICP            95              /* Mobile Int.ing control */
140#define IPPROTO_SCCSP           96              /* Semaphore Comm. security */
141#define IPPROTO_ETHERIP         97              /* Ethernet IP encapsulation */
142#define IPPROTO_ENCAP           98              /* encapsulation header */
143#define IPPROTO_APES            99              /* any private encr. scheme */
144#define IPPROTO_GMTP            100             /* GMTP*/
145/* 101-254: Unassigned */
146/* 255: Reserved */
147/* BSD Private, local use, namespace incursion */
148#define IPPROTO_DIVERT          254             /* divert pseudo-protocol */
149#define IPPROTO_RAW             255             /* raw IP packet */
150#define IPPROTO_MAX             256
151
152/*
153 * Merged from FreeBSD 1.78 of this file so Python compiles.
154 * This is a size value for functions such as inet_ntop().
155 */
156#define INET_ADDRSTRLEN         16
157
158/*
159 * Local port number conventions:
160 *
161 * When a user does a bind(2) or connect(2) with a port number of zero,
162 * a non-conflicting local port address is chosen.
163 * The default range is IPPORT_RESERVED through
164 * IPPORT_USERRESERVED, although that is settable by sysctl.
165 *
166 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
167 * default assignment range.
168 *
169 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
170 *
171 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
172 * into the "high" range.  These are reserved for client outbound connections
173 * which do not want to be filtered by any firewalls.
174 *
175 * The value IP_PORTRANGE_LOW changes the range to the "low" are
176 * that is (by convention) restricted to privileged processes.  This
177 * convention is based on "vouchsafe" principles only.  It is only secure
178 * if you trust the remote host to restrict these ports.
179 *
180 * The default range of ports and the high range can be changed by
181 * sysctl(3).  (net.inet.ip.port{hi,low}{first,last}_auto)
182 *
183 * Changing those values has bad security implications if you are
184 * using a a stateless firewall that is allowing packets outside of that
185 * range in order to allow transparent outgoing connections.
186 *
187 * Such a firewall configuration will generally depend on the use of these
188 * default values.  If you change them, you may find your Security
189 * Administrator looking for you with a heavy object.
190 */
191
192/*
193 * Ports < IPPORT_RESERVED are reserved for
194 * privileged processes (e.g. root).         (IP_PORTRANGE_LOW)
195 * Ports > IPPORT_USERRESERVED are reserved
196 * for servers, not necessarily privileged.  (IP_PORTRANGE_DEFAULT)
197 */
198#define IPPORT_RESERVED         1024
199#define IPPORT_USERRESERVED     5000
200
201/*
202 * Default local port range to use by setting IP_PORTRANGE_HIGH
203 */
204#define IPPORT_HIFIRSTAUTO      40000
205#define IPPORT_HILASTAUTO       44999
206
207/*
208 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
209 * but higher than IPPORT_RESERVEDSTART.  Traditionally the start value was
210 * 512, but that conflicts with some well-known-services that firewalls may
211 * have a fit if we use.
212 */
213#define IPPORT_RESERVEDSTART    600
214#define BYTE_PACK __attribute__((packed))
215/*
216 * Internet address (a structure for historical reasons)
217 */
218struct in_addr {
219        u_long s_addr BYTE_PACK;
220};
221
222/*
223 * Definitions of bits in internet address integers.
224 * On subnets, the decomposition of addresses to host and net parts
225 * is done according to subnet mask, not the masks here.
226 */
227#define IN_CLASSA(i)            (((long)(i) & 0x80000000) == 0)
228#define IN_CLASSA_NET           0xff000000
229#define IN_CLASSA_NSHIFT        24
230#define IN_CLASSA_HOST          0x00ffffff
231#define IN_CLASSA_MAX           128
232
233#define IN_CLASSB(i)            (((long)(i) & 0xc0000000) == 0x80000000)
234#define IN_CLASSB_NET           0xffff0000
235#define IN_CLASSB_NSHIFT        16
236#define IN_CLASSB_HOST          0x0000ffff
237#define IN_CLASSB_MAX           65536
238
239#define IN_CLASSC(i)            (((long)(i) & 0xe0000000) == 0xc0000000)
240#define IN_CLASSC_NET           0xffffff00
241#define IN_CLASSC_NSHIFT        8
242#define IN_CLASSC_HOST          0x000000ff
243
244#define IN_CLASSD(i)            (((long)(i) & 0xf0000000) == 0xe0000000)
245#define IN_CLASSD_NET           0xf0000000      /* These ones aren't really */
246#define IN_CLASSD_NSHIFT        28              /* net and host fields, but */
247#define IN_CLASSD_HOST          0x0fffffff      /* routing needn't know.    */
248#define IN_MULTICAST(i)         IN_CLASSD(i)
249
250#define IN_EXPERIMENTAL(i)      (((long)(i) & 0xf0000000) == 0xf0000000)
251#define IN_BADCLASS(i)          (((long)(i) & 0xf0000000) == 0xf0000000)
252
253#define INADDR_ANY              (u_long)0x00000000
254#define INADDR_BROADCAST        (u_long)0xffffffff      /* must be masked */
255#ifndef KERNEL
256#define INADDR_NONE             0xffffffff              /* -1 return */
257#endif
258
259#define INADDR_UNSPEC_GROUP     (u_long)0xe0000000      /* 224.0.0.0 */
260#define INADDR_ALLHOSTS_GROUP   (u_long)0xe0000001      /* 224.0.0.1 */
261#define INADDR_ALLRTRS_GROUP    (u_long)0xe0000002      /* 224.0.0.2 */
262#define INADDR_MAX_LOCAL_GROUP  (u_long)0xe00000ff      /* 224.0.0.255 */
263
264#define IN_LOOPBACKNET          127                     /* official! */
265#ifndef INADDR_LOOPBACK
266#define INADDR_LOOPBACK         (u_long)0x7F000001      /* 127.0.0.1 */
267#endif
268
269/*
270 * Socket address, internet style.
271 */
272struct sockaddr_in {
273        u_char  sin_len;
274        u_char  sin_family;
275        u_short sin_port;
276        struct  in_addr sin_addr;
277        char    sin_zero[8];
278};
279
280/*
281 * Structure used to describe IP options.
282 * Used to store options internally, to pass them to a process,
283 * or to restore options retrieved earlier.
284 * The ip_dst is used for the first-hop gateway when using a source route
285 * (this gets put into the header proper).
286 */
287struct ip_opts {
288        struct  in_addr ip_dst;         /* first hop, 0 w/o src rt */
289        char    ip_opts[40];            /* actually variable in size */
290};
291
292/*
293 * Options for use with [gs]etsockopt at the IP level.
294 * First word of comment is data type; bool is stored in int.
295 */
296#define IP_OPTIONS              1    /* buf/ip_opts; set/get IP options */
297#define IP_HDRINCL              2    /* int; header is included with data */
298#define IP_TOS                  3    /* int; IP type of service and preced. */
299#define IP_TTL                  4    /* int; IP time to live */
300#define IP_RECVOPTS             5    /* bool; receive all IP opts w/dgram */
301#define IP_RECVRETOPTS          6    /* bool; receive IP opts for response */
302#define IP_RECVDSTADDR          7    /* bool; receive IP dst addr w/dgram */
303#define IP_RETOPTS              8    /* ip_opts; set/get IP options */
304#define IP_MULTICAST_IF         9    /* u_char; set/get IP multicast i/f  */
305#define IP_MULTICAST_TTL        10   /* u_char; set/get IP multicast ttl */
306#define IP_MULTICAST_LOOP       11   /* u_char; set/get IP multicast loopback */
307#define IP_ADD_MEMBERSHIP       12   /* ip_mreq; add an IP group membership */
308#define IP_DROP_MEMBERSHIP      13   /* ip_mreq; drop an IP group membership */
309#define IP_MULTICAST_VIF        14   /* set/get IP mcast virt. iface */
310#define IP_RSVP_ON              15   /* enable RSVP in kernel */
311#define IP_RSVP_OFF             16   /* disable RSVP in kernel */
312#define IP_RSVP_VIF_ON          17   /* set RSVP per-vif socket */
313#define IP_RSVP_VIF_OFF         18   /* unset RSVP per-vif socket */
314#define IP_PORTRANGE            19   /* int; range to choose for unspec port */
315#define IP_RECVIF               20   /* bool; receive reception if w/dgram */
316
317#define IP_FW_ADD               50   /* add a firewall rule to chain */
318#define IP_FW_DEL               51   /* delete a firewall rule from chain */
319#define IP_FW_FLUSH             52   /* flush firewall rule chain */
320#define IP_FW_ZERO              53   /* clear single/all firewall counter(s) */
321#define IP_FW_GET               54   /* get entire firewall rule chain */
322#define IP_NAT                  55   /* set/get NAT opts */
323
324/*
325 * Defaults and limits for options
326 */
327#define IP_DEFAULT_MULTICAST_TTL  1     /* normally limit m'casts to 1 hop  */
328#define IP_DEFAULT_MULTICAST_LOOP 1     /* normally hear sends if a member  */
329#define IP_MAX_MEMBERSHIPS      20      /* per socket */
330
331/*
332 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
333 */
334struct ip_mreq {
335        struct  in_addr imr_multiaddr;  /* IP multicast address of group */
336        struct  in_addr imr_interface;  /* local IP address of interface */
337};
338
339/*
340 * Argument for IP_PORTRANGE:
341 * - which range to search when port is unspecified at bind() or connect()
342 */
343#define IP_PORTRANGE_DEFAULT    0       /* default range */
344#define IP_PORTRANGE_HIGH       1       /* "high" - request firewall bypass */
345#define IP_PORTRANGE_LOW        2       /* "low" - vouchsafe security */
346
347/*
348 * Definitions for inet sysctl operations.
349 *
350 * Third level is protocol number.
351 * Fourth level is desired variable within that protocol.
352 */
353#define IPPROTO_MAXID   (IPPROTO_IDP + 1)       /* don't list to IPPROTO_MAX */
354
355#define CTL_IPPROTO_NAMES { \
356        { "ip", CTLTYPE_NODE }, \
357        { "icmp", CTLTYPE_NODE }, \
358        { "igmp", CTLTYPE_NODE }, \
359        { "ggp", CTLTYPE_NODE }, \
360        { 0, 0 }, \
361        { 0, 0 }, \
362        { "tcp", CTLTYPE_NODE }, \
363        { 0, 0 }, \
364        { "egp", CTLTYPE_NODE }, \
365        { 0, 0 }, \
366        { 0, 0 }, \
367        { 0, 0 }, \
368        { "pup", CTLTYPE_NODE }, \
369        { 0, 0 }, \
370        { 0, 0 }, \
371        { 0, 0 }, \
372        { 0, 0 }, \
373        { "udp", CTLTYPE_NODE }, \
374        { 0, 0 }, \
375        { 0, 0 }, \
376        { 0, 0 }, \
377        { 0, 0 }, \
378        { "idp", CTLTYPE_NODE }, \
379}
380
381/*
382 * Names for IP sysctl objects
383 */
384#define IPCTL_FORWARDING        1       /* act as router */
385#define IPCTL_SENDREDIRECTS     2       /* may send redirects when forwarding */
386#define IPCTL_DEFTTL            3       /* default TTL */
387#ifdef notyet
388#define IPCTL_DEFMTU            4       /* default MTU */
389#endif
390#define IPCTL_RTEXPIRE          5       /* cloned route expiration time */
391#define IPCTL_RTMINEXPIRE       6       /* min value for expiration time */
392#define IPCTL_RTMAXCACHE        7       /* trigger level for dynamic expire */
393#define IPCTL_SOURCEROUTE       8       /* may perform source routes */
394#define IPCTL_DIRECTEDBROADCAST 9       /* may re-broadcast received packets */
395#define IPCTL_INTRQMAXLEN       10      /* max length of netisr queue */
396#define IPCTL_INTRQDROPS        11      /* number of netisr q drops */
397#define IPCTL_ACCEPTSOURCEROUTE 13      /* may accept source routed packets */
398#define IPCTL_MAXID             13
399
400#define IPCTL_NAMES { \
401        { 0, 0 }, \
402        { "forwarding", CTLTYPE_INT }, \
403        { "redirect", CTLTYPE_INT }, \
404        { "ttl", CTLTYPE_INT }, \
405        { "mtu", CTLTYPE_INT }, \
406        { "rtexpire", CTLTYPE_INT }, \
407        { "rtminexpire", CTLTYPE_INT }, \
408        { "rtmaxcache", CTLTYPE_INT }, \
409        { "sourceroute", CTLTYPE_INT }, \
410        { "directed-broadcast", CTLTYPE_INT }, \
411        { "intr-queue-maxlen", CTLTYPE_INT }, \
412        { "intr-queue-drops", CTLTYPE_INT }, \
413        { "accept_sourceroute", CTLTYPE_INT }, \
414}
415
416
417#ifdef KERNEL
418struct ifnet; struct mbuf;      /* forward declarations for Standard C */
419
420int      in_broadcast __P((struct in_addr, struct ifnet *));
421int      in_canforward __P((struct in_addr));
422int      in_cksum __P((struct mbuf *, int));
423int      in_localaddr __P((struct in_addr));
424char    *inet_ntoa __P((struct in_addr)); /* in libkern */
425
426/* Firewall hooks */
427struct ip;
428typedef int ip_fw_chk_t __P((struct ip**, int, struct ifnet*, int, struct mbuf**));
429typedef int ip_fw_ctl_t __P((int, struct mbuf**));
430extern  ip_fw_chk_t *ip_fw_chk_ptr;
431extern  ip_fw_ctl_t *ip_fw_ctl_ptr;
432
433/* IP NAT hooks */
434typedef int ip_nat_t __P((struct ip**, struct mbuf**, struct ifnet*, int));
435typedef int ip_nat_ctl_t __P((int, struct mbuf**));
436extern  ip_nat_t *ip_nat_ptr;
437extern  ip_nat_ctl_t *ip_nat_ctl_ptr;
438#define IP_NAT_IN       0x00000001
439#define IP_NAT_OUT      0x00000002
440
441#endif /* KERNEL */
442
443#endif
Note: See TracBrowser for help on using the repository browser.