branch tracer: Fix for enabling branch profiling makes sparse unusable
[linux-2.6] / include / linux / in.h
1 /*
2  * INET         An implementation of the TCP/IP protocol suite for the LINUX
3  *              operating system.  INET is implemented using the  BSD Socket
4  *              interface as the means of communication with the user level.
5  *
6  *              Definitions of the Internet Protocol.
7  *
8  * Version:     @(#)in.h        1.0.1   04/21/93
9  *
10  * Authors:     Original taken from the GNU Project <netinet/in.h> file.
11  *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12  *
13  *              This program is free software; you can redistribute it and/or
14  *              modify it under the terms of the GNU General Public License
15  *              as published by the Free Software Foundation; either version
16  *              2 of the License, or (at your option) any later version.
17  */
18 #ifndef _LINUX_IN_H
19 #define _LINUX_IN_H
20
21 #include <linux/types.h>
22 #include <linux/socket.h>
23
24 /* Standard well-defined IP protocols.  */
25 enum {
26   IPPROTO_IP = 0,               /* Dummy protocol for TCP               */
27   IPPROTO_ICMP = 1,             /* Internet Control Message Protocol    */
28   IPPROTO_IGMP = 2,             /* Internet Group Management Protocol   */
29   IPPROTO_IPIP = 4,             /* IPIP tunnels (older KA9Q tunnels use 94) */
30   IPPROTO_TCP = 6,              /* Transmission Control Protocol        */
31   IPPROTO_EGP = 8,              /* Exterior Gateway Protocol            */
32   IPPROTO_PUP = 12,             /* PUP protocol                         */
33   IPPROTO_UDP = 17,             /* User Datagram Protocol               */
34   IPPROTO_IDP = 22,             /* XNS IDP protocol                     */
35   IPPROTO_DCCP = 33,            /* Datagram Congestion Control Protocol */
36   IPPROTO_RSVP = 46,            /* RSVP protocol                        */
37   IPPROTO_GRE = 47,             /* Cisco GRE tunnels (rfc 1701,1702)    */
38
39   IPPROTO_IPV6   = 41,          /* IPv6-in-IPv4 tunnelling              */
40
41   IPPROTO_ESP = 50,            /* Encapsulation Security Payload protocol */
42   IPPROTO_AH = 51,             /* Authentication Header protocol       */
43   IPPROTO_BEETPH = 94,         /* IP option pseudo header for BEET */
44   IPPROTO_PIM    = 103,         /* Protocol Independent Multicast       */
45
46   IPPROTO_COMP   = 108,                /* Compression Header protocol */
47   IPPROTO_SCTP   = 132,         /* Stream Control Transport Protocol    */
48   IPPROTO_UDPLITE = 136,        /* UDP-Lite (RFC 3828)                  */
49
50   IPPROTO_RAW    = 255,         /* Raw IP packets                       */
51   IPPROTO_MAX
52 };
53
54
55 /* Internet address. */
56 struct in_addr {
57         __be32  s_addr;
58 };
59
60 #define IP_TOS          1
61 #define IP_TTL          2
62 #define IP_HDRINCL      3
63 #define IP_OPTIONS      4
64 #define IP_ROUTER_ALERT 5
65 #define IP_RECVOPTS     6
66 #define IP_RETOPTS      7
67 #define IP_PKTINFO      8
68 #define IP_PKTOPTIONS   9
69 #define IP_MTU_DISCOVER 10
70 #define IP_RECVERR      11
71 #define IP_RECVTTL      12
72 #define IP_RECVTOS      13
73 #define IP_MTU          14
74 #define IP_FREEBIND     15
75 #define IP_IPSEC_POLICY 16
76 #define IP_XFRM_POLICY  17
77 #define IP_PASSSEC      18
78 #define IP_TRANSPARENT  19
79
80 /* BSD compatibility */
81 #define IP_RECVRETOPTS  IP_RETOPTS
82
83 /* TProxy original addresses */
84 #define IP_ORIGDSTADDR       20
85 #define IP_RECVORIGDSTADDR   IP_ORIGDSTADDR
86
87 /* IP_MTU_DISCOVER values */
88 #define IP_PMTUDISC_DONT                0       /* Never send DF frames */
89 #define IP_PMTUDISC_WANT                1       /* Use per route hints  */
90 #define IP_PMTUDISC_DO                  2       /* Always DF            */
91 #define IP_PMTUDISC_PROBE               3       /* Ignore dst pmtu      */
92
93 #define IP_MULTICAST_IF                 32
94 #define IP_MULTICAST_TTL                33
95 #define IP_MULTICAST_LOOP               34
96 #define IP_ADD_MEMBERSHIP               35
97 #define IP_DROP_MEMBERSHIP              36
98 #define IP_UNBLOCK_SOURCE               37
99 #define IP_BLOCK_SOURCE                 38
100 #define IP_ADD_SOURCE_MEMBERSHIP        39
101 #define IP_DROP_SOURCE_MEMBERSHIP       40
102 #define IP_MSFILTER                     41
103 #define MCAST_JOIN_GROUP                42
104 #define MCAST_BLOCK_SOURCE              43
105 #define MCAST_UNBLOCK_SOURCE            44
106 #define MCAST_LEAVE_GROUP               45
107 #define MCAST_JOIN_SOURCE_GROUP         46
108 #define MCAST_LEAVE_SOURCE_GROUP        47
109 #define MCAST_MSFILTER                  48
110
111 #define MCAST_EXCLUDE   0
112 #define MCAST_INCLUDE   1
113
114 /* These need to appear somewhere around here */
115 #define IP_DEFAULT_MULTICAST_TTL        1
116 #define IP_DEFAULT_MULTICAST_LOOP       1
117
118 /* Request struct for multicast socket ops */
119
120 struct ip_mreq 
121 {
122         struct in_addr imr_multiaddr;   /* IP multicast address of group */
123         struct in_addr imr_interface;   /* local IP address of interface */
124 };
125
126 struct ip_mreqn
127 {
128         struct in_addr  imr_multiaddr;          /* IP multicast address of group */
129         struct in_addr  imr_address;            /* local IP address of interface */
130         int             imr_ifindex;            /* Interface index */
131 };
132
133 struct ip_mreq_source {
134         __be32          imr_multiaddr;
135         __be32          imr_interface;
136         __be32          imr_sourceaddr;
137 };
138
139 struct ip_msfilter {
140         __be32          imsf_multiaddr;
141         __be32          imsf_interface;
142         __u32           imsf_fmode;
143         __u32           imsf_numsrc;
144         __be32          imsf_slist[1];
145 };
146
147 #define IP_MSFILTER_SIZE(numsrc) \
148         (sizeof(struct ip_msfilter) - sizeof(__u32) \
149         + (numsrc) * sizeof(__u32))
150
151 struct group_req
152 {
153         __u32                            gr_interface;  /* interface index */
154         struct __kernel_sockaddr_storage gr_group;      /* group address */
155 };
156
157 struct group_source_req
158 {
159         __u32                            gsr_interface; /* interface index */
160         struct __kernel_sockaddr_storage gsr_group;     /* group address */
161         struct __kernel_sockaddr_storage gsr_source;    /* source address */
162 };
163
164 struct group_filter
165 {
166         __u32                            gf_interface;  /* interface index */
167         struct __kernel_sockaddr_storage gf_group;      /* multicast address */
168         __u32                            gf_fmode;      /* filter mode */
169         __u32                            gf_numsrc;     /* number of sources */
170         struct __kernel_sockaddr_storage gf_slist[1];   /* interface index */
171 };
172
173 #define GROUP_FILTER_SIZE(numsrc) \
174         (sizeof(struct group_filter) - sizeof(struct __kernel_sockaddr_storage) \
175         + (numsrc) * sizeof(struct __kernel_sockaddr_storage))
176
177 struct in_pktinfo
178 {
179         int             ipi_ifindex;
180         struct in_addr  ipi_spec_dst;
181         struct in_addr  ipi_addr;
182 };
183
184 /* Structure describing an Internet (IP) socket address. */
185 #define __SOCK_SIZE__   16              /* sizeof(struct sockaddr)      */
186 struct sockaddr_in {
187   sa_family_t           sin_family;     /* Address family               */
188   __be16                sin_port;       /* Port number                  */
189   struct in_addr        sin_addr;       /* Internet address             */
190
191   /* Pad to size of `struct sockaddr'. */
192   unsigned char         __pad[__SOCK_SIZE__ - sizeof(short int) -
193                         sizeof(unsigned short int) - sizeof(struct in_addr)];
194 };
195 #define sin_zero        __pad           /* for BSD UNIX comp. -FvK      */
196
197
198 /*
199  * Definitions of the bits in an Internet address integer.
200  * On subnets, host and network parts are found according
201  * to the subnet mask, not these masks.
202  */
203 #define IN_CLASSA(a)            ((((long int) (a)) & 0x80000000) == 0)
204 #define IN_CLASSA_NET           0xff000000
205 #define IN_CLASSA_NSHIFT        24
206 #define IN_CLASSA_HOST          (0xffffffff & ~IN_CLASSA_NET)
207 #define IN_CLASSA_MAX           128
208
209 #define IN_CLASSB(a)            ((((long int) (a)) & 0xc0000000) == 0x80000000)
210 #define IN_CLASSB_NET           0xffff0000
211 #define IN_CLASSB_NSHIFT        16
212 #define IN_CLASSB_HOST          (0xffffffff & ~IN_CLASSB_NET)
213 #define IN_CLASSB_MAX           65536
214
215 #define IN_CLASSC(a)            ((((long int) (a)) & 0xe0000000) == 0xc0000000)
216 #define IN_CLASSC_NET           0xffffff00
217 #define IN_CLASSC_NSHIFT        8
218 #define IN_CLASSC_HOST          (0xffffffff & ~IN_CLASSC_NET)
219
220 #define IN_CLASSD(a)            ((((long int) (a)) & 0xf0000000) == 0xe0000000)
221 #define IN_MULTICAST(a)         IN_CLASSD(a)
222 #define IN_MULTICAST_NET        0xF0000000
223
224 #define IN_EXPERIMENTAL(a)      ((((long int) (a)) & 0xf0000000) == 0xf0000000)
225 #define IN_BADCLASS(a)          IN_EXPERIMENTAL((a))
226
227 /* Address to accept any incoming messages. */
228 #define INADDR_ANY              ((unsigned long int) 0x00000000)
229
230 /* Address to send to all hosts. */
231 #define INADDR_BROADCAST        ((unsigned long int) 0xffffffff)
232
233 /* Address indicating an error return. */
234 #define INADDR_NONE             ((unsigned long int) 0xffffffff)
235
236 /* Network number for local host loopback. */
237 #define IN_LOOPBACKNET          127
238
239 /* Address to loopback in software to local host.  */
240 #define INADDR_LOOPBACK         0x7f000001      /* 127.0.0.1   */
241 #define IN_LOOPBACK(a)          ((((long int) (a)) & 0xff000000) == 0x7f000000)
242
243 /* Defines for Multicast INADDR */
244 #define INADDR_UNSPEC_GROUP     0xe0000000U     /* 224.0.0.0   */
245 #define INADDR_ALLHOSTS_GROUP   0xe0000001U     /* 224.0.0.1   */
246 #define INADDR_ALLRTRS_GROUP    0xe0000002U     /* 224.0.0.2 */
247 #define INADDR_MAX_LOCAL_GROUP  0xe00000ffU     /* 224.0.0.255 */
248
249
250 /* <asm/byteorder.h> contains the htonl type stuff.. */
251 #include <asm/byteorder.h> 
252
253 #ifdef __KERNEL__
254
255 static inline bool ipv4_is_loopback(__be32 addr)
256 {
257         return (addr & htonl(0xff000000)) == htonl(0x7f000000);
258 }
259
260 static inline bool ipv4_is_multicast(__be32 addr)
261 {
262         return (addr & htonl(0xf0000000)) == htonl(0xe0000000);
263 }
264
265 static inline bool ipv4_is_local_multicast(__be32 addr)
266 {
267         return (addr & htonl(0xffffff00)) == htonl(0xe0000000);
268 }
269
270 static inline bool ipv4_is_lbcast(__be32 addr)
271 {
272         /* limited broadcast */
273         return addr == htonl(INADDR_BROADCAST);
274 }
275
276 static inline bool ipv4_is_zeronet(__be32 addr)
277 {
278         return (addr & htonl(0xff000000)) == htonl(0x00000000);
279 }
280
281 /* Special-Use IPv4 Addresses (RFC3330) */
282
283 static inline bool ipv4_is_private_10(__be32 addr)
284 {
285         return (addr & htonl(0xff000000)) == htonl(0x0a000000);
286 }
287
288 static inline bool ipv4_is_private_172(__be32 addr)
289 {
290         return (addr & htonl(0xfff00000)) == htonl(0xac100000);
291 }
292
293 static inline bool ipv4_is_private_192(__be32 addr)
294 {
295         return (addr & htonl(0xffff0000)) == htonl(0xc0a80000);
296 }
297
298 static inline bool ipv4_is_linklocal_169(__be32 addr)
299 {
300         return (addr & htonl(0xffff0000)) == htonl(0xa9fe0000);
301 }
302
303 static inline bool ipv4_is_anycast_6to4(__be32 addr)
304 {
305         return (addr & htonl(0xffffff00)) == htonl(0xc0586300);
306 }
307
308 static inline bool ipv4_is_test_192(__be32 addr)
309 {
310         return (addr & htonl(0xffffff00)) == htonl(0xc0000200);
311 }
312
313 static inline bool ipv4_is_test_198(__be32 addr)
314 {
315         return (addr & htonl(0xfffe0000)) == htonl(0xc6120000);
316 }
317 #endif
318
319 #endif  /* _LINUX_IN_H */