GNU Linux-libre 4.19.295-gnu1
[releases.git] / 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_RAW = 255,            /* Raw IP packets                       */
78 #define IPPROTO_RAW             IPPROTO_RAW
79   IPPROTO_MAX
80 };
81 #endif
82
83 #if __UAPI_DEF_IN_ADDR
84 /* Internet address. */
85 struct in_addr {
86         __be32  s_addr;
87 };
88 #endif
89
90 #define IP_TOS          1
91 #define IP_TTL          2
92 #define IP_HDRINCL      3
93 #define IP_OPTIONS      4
94 #define IP_ROUTER_ALERT 5
95 #define IP_RECVOPTS     6
96 #define IP_RETOPTS      7
97 #define IP_PKTINFO      8
98 #define IP_PKTOPTIONS   9
99 #define IP_MTU_DISCOVER 10
100 #define IP_RECVERR      11
101 #define IP_RECVTTL      12
102 #define IP_RECVTOS      13
103 #define IP_MTU          14
104 #define IP_FREEBIND     15
105 #define IP_IPSEC_POLICY 16
106 #define IP_XFRM_POLICY  17
107 #define IP_PASSSEC      18
108 #define IP_TRANSPARENT  19
109
110 /* BSD compatibility */
111 #define IP_RECVRETOPTS  IP_RETOPTS
112
113 /* TProxy original addresses */
114 #define IP_ORIGDSTADDR       20
115 #define IP_RECVORIGDSTADDR   IP_ORIGDSTADDR
116
117 #define IP_MINTTL       21
118 #define IP_NODEFRAG     22
119 #define IP_CHECKSUM     23
120 #define IP_BIND_ADDRESS_NO_PORT 24
121 #define IP_RECVFRAGSIZE 25
122
123 /* IP_MTU_DISCOVER values */
124 #define IP_PMTUDISC_DONT                0       /* Never send DF frames */
125 #define IP_PMTUDISC_WANT                1       /* Use per route hints  */
126 #define IP_PMTUDISC_DO                  2       /* Always DF            */
127 #define IP_PMTUDISC_PROBE               3       /* Ignore dst pmtu      */
128 /* Always use interface mtu (ignores dst pmtu) but don't set DF flag.
129  * Also incoming ICMP frag_needed notifications will be ignored on
130  * this socket to prevent accepting spoofed ones.
131  */
132 #define IP_PMTUDISC_INTERFACE           4
133 /* weaker version of IP_PMTUDISC_INTERFACE, which allos packets to get
134  * fragmented if they exeed the interface mtu
135  */
136 #define IP_PMTUDISC_OMIT                5
137
138 #define IP_MULTICAST_IF                 32
139 #define IP_MULTICAST_TTL                33
140 #define IP_MULTICAST_LOOP               34
141 #define IP_ADD_MEMBERSHIP               35
142 #define IP_DROP_MEMBERSHIP              36
143 #define IP_UNBLOCK_SOURCE               37
144 #define IP_BLOCK_SOURCE                 38
145 #define IP_ADD_SOURCE_MEMBERSHIP        39
146 #define IP_DROP_SOURCE_MEMBERSHIP       40
147 #define IP_MSFILTER                     41
148 #define MCAST_JOIN_GROUP                42
149 #define MCAST_BLOCK_SOURCE              43
150 #define MCAST_UNBLOCK_SOURCE            44
151 #define MCAST_LEAVE_GROUP               45
152 #define MCAST_JOIN_SOURCE_GROUP         46
153 #define MCAST_LEAVE_SOURCE_GROUP        47
154 #define MCAST_MSFILTER                  48
155 #define IP_MULTICAST_ALL                49
156 #define IP_UNICAST_IF                   50
157 #define IP_LOCAL_PORT_RANGE             51
158 #define IP_PROTOCOL                     52
159
160 #define MCAST_EXCLUDE   0
161 #define MCAST_INCLUDE   1
162
163 /* These need to appear somewhere around here */
164 #define IP_DEFAULT_MULTICAST_TTL        1
165 #define IP_DEFAULT_MULTICAST_LOOP       1
166
167 /* Request struct for multicast socket ops */
168
169 #if __UAPI_DEF_IP_MREQ
170 struct ip_mreq  {
171         struct in_addr imr_multiaddr;   /* IP multicast address of group */
172         struct in_addr imr_interface;   /* local IP address of interface */
173 };
174
175 struct ip_mreqn {
176         struct in_addr  imr_multiaddr;          /* IP multicast address of group */
177         struct in_addr  imr_address;            /* local IP address of interface */
178         int             imr_ifindex;            /* Interface index */
179 };
180
181 struct ip_mreq_source {
182         __be32          imr_multiaddr;
183         __be32          imr_interface;
184         __be32          imr_sourceaddr;
185 };
186
187 struct ip_msfilter {
188         __be32          imsf_multiaddr;
189         __be32          imsf_interface;
190         __u32           imsf_fmode;
191         __u32           imsf_numsrc;
192         __be32          imsf_slist[1];
193 };
194
195 #define IP_MSFILTER_SIZE(numsrc) \
196         (sizeof(struct ip_msfilter) - sizeof(__u32) \
197         + (numsrc) * sizeof(__u32))
198
199 struct group_req {
200         __u32                            gr_interface;  /* interface index */
201         struct __kernel_sockaddr_storage gr_group;      /* group address */
202 };
203
204 struct group_source_req {
205         __u32                            gsr_interface; /* interface index */
206         struct __kernel_sockaddr_storage gsr_group;     /* group address */
207         struct __kernel_sockaddr_storage gsr_source;    /* source address */
208 };
209
210 struct group_filter {
211         __u32                            gf_interface;  /* interface index */
212         struct __kernel_sockaddr_storage gf_group;      /* multicast address */
213         __u32                            gf_fmode;      /* filter mode */
214         __u32                            gf_numsrc;     /* number of sources */
215         struct __kernel_sockaddr_storage gf_slist[1];   /* interface index */
216 };
217
218 #define GROUP_FILTER_SIZE(numsrc) \
219         (sizeof(struct group_filter) - sizeof(struct __kernel_sockaddr_storage) \
220         + (numsrc) * sizeof(struct __kernel_sockaddr_storage))
221 #endif
222
223 #if __UAPI_DEF_IN_PKTINFO
224 struct in_pktinfo {
225         int             ipi_ifindex;
226         struct in_addr  ipi_spec_dst;
227         struct in_addr  ipi_addr;
228 };
229 #endif
230
231 /* Structure describing an Internet (IP) socket address. */
232 #if  __UAPI_DEF_SOCKADDR_IN
233 #define __SOCK_SIZE__   16              /* sizeof(struct sockaddr)      */
234 struct sockaddr_in {
235   __kernel_sa_family_t  sin_family;     /* Address family               */
236   __be16                sin_port;       /* Port number                  */
237   struct in_addr        sin_addr;       /* Internet address             */
238
239   /* Pad to size of `struct sockaddr'. */
240   unsigned char         __pad[__SOCK_SIZE__ - sizeof(short int) -
241                         sizeof(unsigned short int) - sizeof(struct in_addr)];
242 };
243 #define sin_zero        __pad           /* for BSD UNIX comp. -FvK      */
244 #endif
245
246 #if __UAPI_DEF_IN_CLASS
247 /*
248  * Definitions of the bits in an Internet address integer.
249  * On subnets, host and network parts are found according
250  * to the subnet mask, not these masks.
251  */
252 #define IN_CLASSA(a)            ((((long int) (a)) & 0x80000000) == 0)
253 #define IN_CLASSA_NET           0xff000000
254 #define IN_CLASSA_NSHIFT        24
255 #define IN_CLASSA_HOST          (0xffffffff & ~IN_CLASSA_NET)
256 #define IN_CLASSA_MAX           128
257
258 #define IN_CLASSB(a)            ((((long int) (a)) & 0xc0000000) == 0x80000000)
259 #define IN_CLASSB_NET           0xffff0000
260 #define IN_CLASSB_NSHIFT        16
261 #define IN_CLASSB_HOST          (0xffffffff & ~IN_CLASSB_NET)
262 #define IN_CLASSB_MAX           65536
263
264 #define IN_CLASSC(a)            ((((long int) (a)) & 0xe0000000) == 0xc0000000)
265 #define IN_CLASSC_NET           0xffffff00
266 #define IN_CLASSC_NSHIFT        8
267 #define IN_CLASSC_HOST          (0xffffffff & ~IN_CLASSC_NET)
268
269 #define IN_CLASSD(a)            ((((long int) (a)) & 0xf0000000) == 0xe0000000)
270 #define IN_MULTICAST(a)         IN_CLASSD(a)
271 #define IN_MULTICAST_NET        0xF0000000
272
273 #define IN_EXPERIMENTAL(a)      ((((long int) (a)) & 0xf0000000) == 0xf0000000)
274 #define IN_BADCLASS(a)          IN_EXPERIMENTAL((a))
275
276 /* Address to accept any incoming messages. */
277 #define INADDR_ANY              ((unsigned long int) 0x00000000)
278
279 /* Address to send to all hosts. */
280 #define INADDR_BROADCAST        ((unsigned long int) 0xffffffff)
281
282 /* Address indicating an error return. */
283 #define INADDR_NONE             ((unsigned long int) 0xffffffff)
284
285 /* Dummy address for src of ICMP replies if no real address is set (RFC7600). */
286 #define INADDR_DUMMY            ((unsigned long int) 0xc0000008)
287
288 /* Network number for local host loopback. */
289 #define IN_LOOPBACKNET          127
290
291 /* Address to loopback in software to local host.  */
292 #define INADDR_LOOPBACK         0x7f000001      /* 127.0.0.1   */
293 #define IN_LOOPBACK(a)          ((((long int) (a)) & 0xff000000) == 0x7f000000)
294
295 /* Defines for Multicast INADDR */
296 #define INADDR_UNSPEC_GROUP     0xe0000000U     /* 224.0.0.0   */
297 #define INADDR_ALLHOSTS_GROUP   0xe0000001U     /* 224.0.0.1   */
298 #define INADDR_ALLRTRS_GROUP    0xe0000002U     /* 224.0.0.2 */
299 #define INADDR_MAX_LOCAL_GROUP  0xe00000ffU     /* 224.0.0.255 */
300 #endif
301
302 /* <asm/byteorder.h> contains the htonl type stuff.. */
303 #include <asm/byteorder.h> 
304
305
306 #endif /* _UAPI_LINUX_IN_H */