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