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 for the ICMP protocol.
8  *
9  * Version:	@(#)icmp.h	1.0.3	04/28/93
10  *
11  * Author:	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 _UAPI_LINUX_ICMP_H
19 #define _UAPI_LINUX_ICMP_H
20 
21 #include <linux/types.h>
22 #include <asm/byteorder.h>
23 #include <linux/in.h>
24 #include <linux/if.h>
25 #include <linux/in6.h>
26 
27 #define ICMP_ECHOREPLY		0	/* Echo Reply			*/
28 #define ICMP_DEST_UNREACH	3	/* Destination Unreachable	*/
29 #define ICMP_SOURCE_QUENCH	4	/* Source Quench		*/
30 #define ICMP_REDIRECT		5	/* Redirect (change route)	*/
31 #define ICMP_ECHO		8	/* Echo Request			*/
32 #define ICMP_TIME_EXCEEDED	11	/* Time Exceeded		*/
33 #define ICMP_PARAMETERPROB	12	/* Parameter Problem		*/
34 #define ICMP_TIMESTAMP		13	/* Timestamp Request		*/
35 #define ICMP_TIMESTAMPREPLY	14	/* Timestamp Reply		*/
36 #define ICMP_INFO_REQUEST	15	/* Information Request		*/
37 #define ICMP_INFO_REPLY		16	/* Information Reply		*/
38 #define ICMP_ADDRESS		17	/* Address Mask Request		*/
39 #define ICMP_ADDRESSREPLY	18	/* Address Mask Reply		*/
40 #define NR_ICMP_TYPES		18
41 
42 
43 /* Codes for UNREACH. */
44 #define ICMP_NET_UNREACH	0	/* Network Unreachable		*/
45 #define ICMP_HOST_UNREACH	1	/* Host Unreachable		*/
46 #define ICMP_PROT_UNREACH	2	/* Protocol Unreachable		*/
47 #define ICMP_PORT_UNREACH	3	/* Port Unreachable		*/
48 #define ICMP_FRAG_NEEDED	4	/* Fragmentation Needed/DF set	*/
49 #define ICMP_SR_FAILED		5	/* Source Route failed		*/
50 #define ICMP_NET_UNKNOWN	6
51 #define ICMP_HOST_UNKNOWN	7
52 #define ICMP_HOST_ISOLATED	8
53 #define ICMP_NET_ANO		9
54 #define ICMP_HOST_ANO		10
55 #define ICMP_NET_UNR_TOS	11
56 #define ICMP_HOST_UNR_TOS	12
57 #define ICMP_PKT_FILTERED	13	/* Packet filtered */
58 #define ICMP_PREC_VIOLATION	14	/* Precedence violation */
59 #define ICMP_PREC_CUTOFF	15	/* Precedence cut off */
60 #define NR_ICMP_UNREACH		15	/* instead of hardcoding immediate value */
61 
62 /* Codes for REDIRECT. */
63 #define ICMP_REDIR_NET		0	/* Redirect Net			*/
64 #define ICMP_REDIR_HOST		1	/* Redirect Host		*/
65 #define ICMP_REDIR_NETTOS	2	/* Redirect Net for TOS		*/
66 #define ICMP_REDIR_HOSTTOS	3	/* Redirect Host for TOS	*/
67 
68 /* Codes for TIME_EXCEEDED. */
69 #define ICMP_EXC_TTL		0	/* TTL count exceeded		*/
70 #define ICMP_EXC_FRAGTIME	1	/* Fragment Reass time exceeded	*/
71 
72 /* Codes for EXT_ECHO (PROBE) */
73 #define ICMP_EXT_ECHO			42
74 #define ICMP_EXT_ECHOREPLY		43
75 #define ICMP_EXT_CODE_MAL_QUERY		1	/* Malformed Query */
76 #define ICMP_EXT_CODE_NO_IF		2	/* No such Interface */
77 #define ICMP_EXT_CODE_NO_TABLE_ENT	3	/* No such Table Entry */
78 #define ICMP_EXT_CODE_MULT_IFS		4	/* Multiple Interfaces Satisfy Query */
79 
80 /* Constants for EXT_ECHO (PROBE) */
81 #define ICMP_EXT_ECHOREPLY_ACTIVE	(1 << 2)/* active bit in reply message */
82 #define ICMP_EXT_ECHOREPLY_IPV4		(1 << 1)/* ipv4 bit in reply message */
83 #define ICMP_EXT_ECHOREPLY_IPV6		1	/* ipv6 bit in reply message */
84 #define ICMP_EXT_ECHO_CTYPE_NAME	1
85 #define ICMP_EXT_ECHO_CTYPE_INDEX	2
86 #define ICMP_EXT_ECHO_CTYPE_ADDR	3
87 #define ICMP_AFI_IP			1	/* Address Family Identifier for ipv4 */
88 #define ICMP_AFI_IP6			2	/* Address Family Identifier for ipv6 */
89 
90 struct icmphdr {
91   uint8_t		type;
92   uint8_t		code;
93   __sum16	checksum;
94   union {
95 	struct {
96 		uint16_t	id;
97 		uint16_t	sequence;
98 	} echo;
99 	uint32_t	gateway;
100 	struct {
101 		uint16_t	__unused;
102 		uint16_t	mtu;
103 	} frag;
104 	uint8_t	reserved[4];
105   } un;
106 };
107 
108 
109 /*
110  *	constants for (set|get)sockopt
111  */
112 
113 #define ICMP_FILTER			1
114 
115 struct icmp_filter {
116 	uint32_t		data;
117 };
118 
119 /* RFC 4884 extension struct: one per message */
120 struct icmp_ext_hdr {
121 #if defined(__LITTLE_ENDIAN_BITFIELD)
122 	uint8_t		reserved1:4,
123 			version:4;
124 #elif defined(__BIG_ENDIAN_BITFIELD)
125 	uint8_t		version:4,
126 			reserved1:4;
127 #else
128 #error	"Please fix <asm/byteorder.h>"
129 #endif
130 	uint8_t		reserved2;
131 	__sum16		checksum;
132 };
133 
134 /* RFC 4884 extension object header: one for each object */
135 struct icmp_extobj_hdr {
136 	uint16_t		length;
137 	uint8_t		class_num;
138 	uint8_t		class_type;
139 };
140 
141 /* RFC 8335: 2.1 Header for c-type 3 payload */
142 struct icmp_ext_echo_ctype3_hdr {
143 	uint16_t		afi;
144 	uint8_t		addrlen;
145 	uint8_t		reserved;
146 };
147 
148 /* RFC 8335: 2.1 Interface Identification Object */
149 struct icmp_ext_echo_iio {
150 	struct icmp_extobj_hdr extobj_hdr;
151 	union {
152 		char name[IFNAMSIZ];
153 		uint32_t ifindex;
154 		struct {
155 			struct icmp_ext_echo_ctype3_hdr ctype3_hdr;
156 			union {
157 				struct in_addr	ipv4_addr;
158 				struct in6_addr	ipv6_addr;
159 			} ip_addr;
160 		} addr;
161 	} ident;
162 };
163 #endif /* _UAPI_LINUX_ICMP_H */
164