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 #define IP_MINTTL       21
  88 #define IP_NODEFRAG     22
  89
  90 /* IP_MTU_DISCOVER values */
  91 #define IP_PMTUDISC_DONT                0       /* Never send DF frames */
  92 #define IP_PMTUDISC_WANT                1       /* Use per route hints  */
  93 #define IP_PMTUDISC_DO                  2       /* Always DF            */
  94 #define IP_PMTUDISC_PROBE               3       /* Ignore dst pmtu      */
  95
  96 #define IP_MULTICAST_IF                 32
  97 #define IP_MULTICAST_TTL                33
  98 #define IP_MULTICAST_LOOP               34
  99 #define IP_ADD_MEMBERSHIP               35
 100 #define IP_DROP_MEMBERSHIP              36
 101 #define IP_UNBLOCK_SOURCE               37
 102 #define IP_BLOCK_SOURCE                 38
 103 #define IP_ADD_SOURCE_MEMBERSHIP        39
 104 #define IP_DROP_SOURCE_MEMBERSHIP       40
 105 #define IP_MSFILTER                     41
 106 #define MCAST_JOIN_GROUP                42
 107 #define MCAST_BLOCK_SOURCE              43
 108 #define MCAST_UNBLOCK_SOURCE            44
 109 #define MCAST_LEAVE_GROUP               45
 110 #define MCAST_JOIN_SOURCE_GROUP         46
 111 #define MCAST_LEAVE_SOURCE_GROUP        47
 112 #define MCAST_MSFILTER                  48
 113 #define IP_MULTICAST_ALL                49
 114 #define IP_UNICAST_IF                   50
 115
 116 #define MCAST_EXCLUDE   0
 117 #define MCAST_INCLUDE   1
 118
 119 /* These need to appear somewhere around here */
 120 #define IP_DEFAULT_MULTICAST_TTL        1
 121 #define IP_DEFAULT_MULTICAST_LOOP       1
 122
 123 /* Request struct for multicast socket ops */
 124
 125 struct ip_mreq  {
 126         struct in_addr imr_multiaddr;   /* IP multicast address of group */
 127         struct in_addr imr_interface;   /* local IP address of interface */
 128 };
 129
 130 struct ip_mreqn {
 131         struct in_addr  imr_multiaddr;          /* IP multicast address of group */
 132         struct in_addr  imr_address;            /* local IP address of interface */
 133         int             imr_ifindex;            /* Interface index */
 134 };
 135
 136 struct ip_mreq_source {
 137         __be32          imr_multiaddr;
 138         __be32          imr_interface;
 139         __be32          imr_sourceaddr;
 140 };
 141
 142 struct ip_msfilter {
 143         __be32          imsf_multiaddr;
 144         __be32          imsf_interface;
 145         __u32           imsf_fmode;
 146         __u32           imsf_numsrc;
 147         __be32          imsf_slist[1];
 148 };
 149
 150 #define IP_MSFILTER_SIZE(numsrc) \
 151         (sizeof(struct ip_msfilter) - sizeof(__u32) \
 152         + (numsrc) * sizeof(__u32))
 153
 154 struct group_req {
 155         __u32                            gr_interface;  /* interface index */
 156         struct __kernel_sockaddr_storage gr_group;      /* group address */
 157 };
 158
 159 struct group_source_req {
 160         __u32                            gsr_interface; /* interface index */
 161         struct __kernel_sockaddr_storage gsr_group;     /* group address */
 162         struct __kernel_sockaddr_storage gsr_source;    /* source address */
 163 };
 164
 165 struct group_filter {
 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         int             ipi_ifindex;
 179         struct in_addr  ipi_spec_dst;
 180         struct in_addr  ipi_addr;
 181 };
 182
 183 /* Structure describing an Internet (IP) socket address. */
 184 #define __SOCK_SIZE__   16              /* sizeof(struct sockaddr)      */
 185 struct sockaddr_in {
 186   __kernel_sa_family_t  sin_family;     /* Address family               */
 187   __be16                sin_port;       /* Port number                  */
 188   struct in_addr        sin_addr;       /* Internet address             */
 189
 190   /* Pad to size of `struct sockaddr'. */
 191   unsigned char         __pad[__SOCK_SIZE__ - sizeof(short int) -
 192                         sizeof(unsigned short int) - sizeof(struct in_addr)];
 193 };
 194 #define sin_zero        __pad           /* for BSD UNIX comp. -FvK      */
 195
 196
 197 /*
 198  * Definitions of the bits in an Internet address integer.
 199  * On subnets, host and network parts are found according
 200  * to the subnet mask, not these masks.
 201  */
 202 #define IN_CLASSA(a)            ((((long int) (a)) & 0x80000000) == 0)
 203 #define IN_CLASSA_NET           0xff000000
 204 #define IN_CLASSA_NSHIFT        24
 205 #define IN_CLASSA_HOST          (0xffffffff & ~IN_CLASSA_NET)
 206 #define IN_CLASSA_MAX           128
 207
 208 #define IN_CLASSB(a)            ((((long int) (a)) & 0xc0000000) == 0x80000000)
 209 #define IN_CLASSB_NET           0xffff0000
 210 #define IN_CLASSB_NSHIFT        16
 211 #define IN_CLASSB_HOST          (0xffffffff & ~IN_CLASSB_NET)
 212 #define IN_CLASSB_MAX           65536
 213
 214 #define IN_CLASSC(a)            ((((long int) (a)) & 0xe0000000) == 0xc0000000)
 215 #define IN_CLASSC_NET           0xffffff00
 216 #define IN_CLASSC_NSHIFT        8
 217 #define IN_CLASSC_HOST          (0xffffffff & ~IN_CLASSC_NET)
 218
 219 #define IN_CLASSD(a)            ((((long int) (a)) & 0xf0000000) == 0xe0000000)
 220 #define IN_MULTICAST(a)         IN_CLASSD(a)
 221 #define IN_MULTICAST_NET        0xF0000000
 222
 223 #define IN_EXPERIMENTAL(a)      ((((long int) (a)) & 0xf0000000) == 0xf0000000)
 224 #define IN_BADCLASS(a)          IN_EXPERIMENTAL((a))
 225
 226 /* Address to accept any incoming messages. */
 227 #define INADDR_ANY              ((unsigned long int) 0x00000000)
 228
 229 /* Address to send to all hosts. */
 230 #define INADDR_BROADCAST        ((unsigned long int) 0xffffffff)
 231
 232 /* Address indicating an error return. */
 233 #define INADDR_NONE             ((unsigned long int) 0xffffffff)
 234
 235 /* Network number for local host loopback. */
 236 #define IN_LOOPBACKNET          127
 237
 238 /* Address to loopback in software to local host.  */
 239 #define INADDR_LOOPBACK         0x7f000001      /* 127.0.0.1   */
 240 #define IN_LOOPBACK(a)          ((((long int) (a)) & 0xff000000) == 0x7f000000)
 241
 242 /* Defines for Multicast INADDR */
 243 #define INADDR_UNSPEC_GROUP     0xe0000000U     /* 224.0.0.0   */
 244 #define INADDR_ALLHOSTS_GROUP   0xe0000001U     /* 224.0.0.1   */
 245 #define INADDR_ALLRTRS_GROUP    0xe0000002U     /* 224.0.0.2 */
 246 #define INADDR_MAX_LOCAL_GROUP  0xe00000ffU     /* 224.0.0.255 */
 247
 248
 249 /* <asm/byteorder.h> contains the htonl type stuff.. */
 250 #include <asm/byteorder.h>
 251
 252 #ifdef __KERNEL__
 253
 254 #include <linux/errno.h>
 255
 256 static inline int proto_ports_offset(int proto)
 257 {
 258         switch (proto) {
 259         case IPPROTO_TCP:
 260         case IPPROTO_UDP:
 261         case IPPROTO_DCCP:
 262         case IPPROTO_ESP:       /* SPI */
 263         case IPPROTO_SCTP:
 264         case IPPROTO_UDPLITE:
 265                 return 0;
 266         case IPPROTO_AH:        /* SPI */
 267                 return 4;
 268         default:
 269                 return -EINVAL;
 270         }
 271 }
 272
 273 static inline bool ipv4_is_loopback(__be32 addr)
 274 {
 275         return (addr & htonl(0xff000000)) == htonl(0x7f000000);
 276 }
 277
 278 static inline bool ipv4_is_multicast(__be32 addr)
 279 {
 280         return (addr & htonl(0xf0000000)) == htonl(0xe0000000);
 281 }
 282
 283 static inline bool ipv4_is_local_multicast(__be32 addr)
 284 {
 285         return (addr & htonl(0xffffff00)) == htonl(0xe0000000);
 286 }
 287
 288 static inline bool ipv4_is_lbcast(__be32 addr)
 289 {
 290         /* limited broadcast */
 291         return addr == htonl(INADDR_BROADCAST);
 292 }
 293
 294 static inline bool ipv4_is_zeronet(__be32 addr)
 295 {
 296         return (addr & htonl(0xff000000)) == htonl(0x00000000);
 297 }
 298
 299 /* Special-Use IPv4 Addresses (RFC3330) */
 300
 301 static inline bool ipv4_is_private_10(__be32 addr)
 302 {
 303         return (addr & htonl(0xff000000)) == htonl(0x0a000000);
 304 }
 305
 306 static inline bool ipv4_is_private_172(__be32 addr)
 307 {
 308         return (addr & htonl(0xfff00000)) == htonl(0xac100000);
 309 }
 310
 311 static inline bool ipv4_is_private_192(__be32 addr)
 312 {
 313         return (addr & htonl(0xffff0000)) == htonl(0xc0a80000);
 314 }
 315
 316 static inline bool ipv4_is_linklocal_169(__be32 addr)
 317 {
 318         return (addr & htonl(0xffff0000)) == htonl(0xa9fe0000);
 319 }
 320
 321 static inline bool ipv4_is_anycast_6to4(__be32 addr)
 322 {
 323         return (addr & htonl(0xffffff00)) == htonl(0xc0586300);
 324 }
 325
 326 static inline bool ipv4_is_test_192(__be32 addr)
 327 {
 328         return (addr & htonl(0xffffff00)) == htonl(0xc0000200);
 329 }
 330
 331 static inline bool ipv4_is_test_198(__be32 addr)
 332 {
 333         return (addr & htonl(0xfffe0000)) == htonl(0xc6120000);
 334 }
 335 #endif
 336
 337 #endif  /* _LINUX_IN_H */