tools/include/uapi/linux/in.h

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