FD.io VPP  v21.01.1
Vector Packet Processing
icmp46_packet.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * icmp46_packet.h: ip4/ip6 icmp packet format
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_vnet_icmp46_packet_h
41 #define included_vnet_icmp46_packet_h
42 
43 #include <vnet/ethernet/packet.h>
44 #include <vnet/ip/ip6_packet.h>
45 
46 #define foreach_icmp4_type \
47  _ (0, echo_reply) \
48  _ (3, destination_unreachable) \
49  _ (4, source_quench) \
50  _ (5, redirect) \
51  _ (6, alternate_host_address) \
52  _ (8, echo_request) \
53  _ (9, router_advertisement) \
54  _ (10, router_solicitation) \
55  _ (11, time_exceeded) \
56  _ (12, parameter_problem) \
57  _ (13, timestamp_request) \
58  _ (14, timestamp_reply) \
59  _ (15, information_request) \
60  _ (16, information_reply) \
61  _ (17, address_mask_request) \
62  _ (18, address_mask_reply) \
63  _ (30, traceroute) \
64  _ (31, datagram_conversion_error) \
65  _ (32, mobile_host_redirect) \
66  _ (33, ip6_where_are_you) \
67  _ (34, ip6_i_am_here) \
68  _ (35, mobile_registration_request) \
69  _ (36, mobile_registration_reply) \
70  _ (37, domain_name_request) \
71  _ (38, domain_name_reply) \
72  _ (39, skip) \
73  _ (40, photuris)
74 
75 #define icmp_no_code 0
76 
77 #define foreach_icmp4_code \
78  _ (destination_unreachable, 0, destination_unreachable_net) \
79  _ (destination_unreachable, 1, destination_unreachable_host) \
80  _ (destination_unreachable, 2, protocol_unreachable) \
81  _ (destination_unreachable, 3, port_unreachable) \
82  _ (destination_unreachable, 4, fragmentation_needed_and_dont_fragment_set) \
83  _ (destination_unreachable, 5, source_route_failed) \
84  _ (destination_unreachable, 6, destination_network_unknown) \
85  _ (destination_unreachable, 7, destination_host_unknown) \
86  _ (destination_unreachable, 8, source_host_isolated) \
87  _ (destination_unreachable, 9, network_administratively_prohibited) \
88  _ (destination_unreachable, 10, host_administratively_prohibited) \
89  _ (destination_unreachable, 11, network_unreachable_for_type_of_service) \
90  _ (destination_unreachable, 12, host_unreachable_for_type_of_service) \
91  _ (destination_unreachable, 13, communication_administratively_prohibited) \
92  _ (destination_unreachable, 14, host_precedence_violation) \
93  _ (destination_unreachable, 15, precedence_cutoff_in_effect) \
94  _ (redirect, 0, network_redirect) \
95  _ (redirect, 1, host_redirect) \
96  _ (redirect, 2, type_of_service_and_network_redirect) \
97  _ (redirect, 3, type_of_service_and_host_redirect) \
98  _ (router_advertisement, 0, normal_router_advertisement) \
99  _ (router_advertisement, 16, does_not_route_common_traffic) \
100  _ (time_exceeded, 0, ttl_exceeded_in_transit) \
101  _ (time_exceeded, 1, fragment_reassembly_time_exceeded) \
102  _ (parameter_problem, 0, pointer_indicates_error) \
103  _ (parameter_problem, 1, missing_required_option) \
104  _ (parameter_problem, 2, bad_length)
105 
106 /* ICMPv6 */
107 #define foreach_icmp6_type \
108  _ (1, destination_unreachable) \
109  _ (2, packet_too_big) \
110  _ (3, time_exceeded) \
111  _ (4, parameter_problem) \
112  _ (128, echo_request) \
113  _ (129, echo_reply) \
114  _ (130, multicast_listener_request) \
115  _ (131, multicast_listener_report) \
116  _ (132, multicast_listener_done) \
117  _ (133, router_solicitation) \
118  _ (134, router_advertisement) \
119  _ (135, neighbor_solicitation) \
120  _ (136, neighbor_advertisement) \
121  _ (137, redirect) \
122  _ (138, router_renumbering) \
123  _ (139, node_information_request) \
124  _ (140, node_information_response) \
125  _ (141, inverse_neighbor_solicitation) \
126  _ (142, inverse_neighbor_advertisement) \
127  _ (143, multicast_listener_report_v2) \
128  _ (144, home_agent_address_discovery_request) \
129  _ (145, home_agent_address_discovery_reply) \
130  _ (146, mobile_prefix_solicitation) \
131  _ (147, mobile_prefix_advertisement) \
132  _ (148, certification_path_solicitation) \
133  _ (149, certification_path_advertisement) \
134  _ (151, multicast_router_advertisement) \
135  _ (152, multicast_router_solicitation) \
136  _ (153, multicast_router_termination) \
137  _ (154, fmipv6_messages)
138 
139 #define foreach_icmp6_code \
140  _ (destination_unreachable, 0, no_route_to_destination) \
141  _ (destination_unreachable, 1, destination_administratively_prohibited) \
142  _ (destination_unreachable, 2, beyond_scope_of_source_address) \
143  _ (destination_unreachable, 3, address_unreachable) \
144  _ (destination_unreachable, 4, port_unreachable) \
145  _ (destination_unreachable, 5, source_address_failed_policy) \
146  _ (destination_unreachable, 6, reject_route_to_destination) \
147  _ (time_exceeded, 0, ttl_exceeded_in_transit) \
148  _ (time_exceeded, 1, fragment_reassembly_time_exceeded) \
149  _ (parameter_problem, 0, erroneous_header_field) \
150  _ (parameter_problem, 1, unrecognized_next_header) \
151  _ (parameter_problem, 2, unrecognized_option) \
152  _ (parameter_problem, 3, first_fragment_has_incomplete_header_chain) \
153  _ (router_renumbering, 0, command) \
154  _ (router_renumbering, 1, result) \
155  _ (node_information_request, 0, data_contains_ip6_address) \
156  _ (node_information_request, 1, data_contains_name) \
157  _ (node_information_request, 2, data_contains_ip4_address) \
158  _ (node_information_response, 0, success) \
159  _ (node_information_response, 1, failed) \
160  _ (node_information_response, 2, unknown_request)
161 
162 typedef enum
163 {
164 #define _(n,f) ICMP4_##f = n,
166 #undef _
167 } icmp4_type_t;
168 
169 typedef enum
170 {
171 #define _(t,n,f) ICMP4_##t##_##f = n,
173 #undef _
174 } icmp4_code_t;
175 
176 typedef enum
177 {
178 #define _(n,f) ICMP6_##f = n,
180 #undef _
181 } icmp6_type_t;
182 
183 typedef enum
184 {
185 #define _(t,n,f) ICMP6_##t##_##f = n,
187 #undef _
188 } icmp6_code_t;
189 
190 /* *INDENT-OFF* */
191 typedef CLIB_PACKED (struct
192 {
193  u8 type;
194  u8 code;
195  /* IP checksum of icmp header plus data which follows. */
196  u16 checksum;
197 }) icmp46_header_t;
198 /* *INDENT-ON* */
199 
200 /* ip6 neighbor discovery */
201 #define foreach_icmp6_neighbor_discovery_option \
202  _ (1, source_link_layer_address) \
203  _ (2, target_link_layer_address) \
204  _ (3, prefix_information) \
205  _ (4, redirected_header) \
206  _ (5, mtu) \
207  _ (6, nbma_shortcut_limit) \
208  _ (7, advertisement_interval) \
209  _ (8, home_agent_information) \
210  _ (9, source_address_list) \
211  _ (10, target_address_list) \
212  _ (11, cryptographically_generated_address) \
213  _ (12, rsa_signature) \
214  _ (13, timestamp) \
215  _ (14, nonce) \
216  _ (15, trust_anchor) \
217  _ (16, certificate) \
218  _ (17, ip_address_and_prefix) \
219  _ (18, new_router_prefix_information) \
220  _ (19, mobile_link_layer_address) \
221  _ (20, neighbor_advertisement_acknowledgment) \
222  _ (23, map) \
223  _ (24, route_information) \
224  _ (25, recursive_dns_server) \
225  _ (26, ra_flags_extension) \
226  _ (27, handover_key_request) \
227  _ (28, handover_key_reply) \
228  _ (29, handover_assist_information) \
229  _ (30, mobile_node_identifier) \
230  _ (31, dns_search_list) \
231  _ (138, card_request) \
232  _ (139, card_reply)
233 
235 {
236 #define _(n,f) ICMP6_NEIGHBOR_DISCOVERY_OPTION_##f = n,
238 #undef _
240 
241 /* *INDENT-OFF* */
242 typedef CLIB_PACKED (struct
243 {
244  /* Option type. */
245  u8 type;
246  /* Length of this header plus option data in 8 byte units. */
247  u8 n_data_u64s;
248  /* Option data follows. */
249  u8 data[0];
250 }) icmp6_neighbor_discovery_option_header_t;
251 
252 typedef CLIB_PACKED (struct
253 {
254  icmp6_neighbor_discovery_option_header_t header;
255  u8 dst_address_length;
256  u8 flags;
257 #define ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_FLAG_ON_LINK (1 << 7)
258 #define ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_AUTO (1 << 6)
259  u32 valid_time;
261  u32 unused; ip6_address_t dst_address;
262 }) icmp6_neighbor_discovery_prefix_information_option_t;
263 
264 typedef CLIB_PACKED (struct
265 {
266  u8 type;
267  u8 aux_data_len_u32s;
268  u16 num_sources;
269  ip6_address_t mcast_addr; ip6_address_t source_addr[0];
270 }) icmp6_multicast_address_record_t;
271 
272 typedef CLIB_PACKED (struct
273 {
274  icmp6_neighbor_discovery_option_header_t header;
275  u8 reserved[6];
276  /* IP6 header plus payload follows. */
277  u8 data[0];
278 }) icmp6_neighbor_discovery_redirected_header_option_t;
279 
280 typedef CLIB_PACKED (struct
281 {
282  icmp6_neighbor_discovery_option_header_t header;
283  u16 unused; u32 mtu;
284 }) icmp6_neighbor_discovery_mtu_option_t;
285 
286 typedef CLIB_PACKED (struct
287 {
288  icmp6_neighbor_discovery_option_header_t header;
289  u8 ethernet_address[6];
290 }) icmp6_neighbor_discovery_ethernet_link_layer_address_option_t;
291 
292 typedef CLIB_PACKED (struct
293 {
294  icmp6_neighbor_discovery_option_header_t header;
295  u8 max_l2_address[6 + 8];
296 }) icmp6_neighbor_discovery_max_link_layer_address_option_t;
297 
298 /* Generic neighbor discover header. Used for router solicitations,
299  etc. */
300 typedef CLIB_PACKED (struct
301 {
302  icmp46_header_t icmp; u32 reserved_must_be_zero;
303 }) icmp6_neighbor_discovery_header_t;
304 
305 /* Router advertisement packet formats. */
306 typedef CLIB_PACKED (struct
307 {
308  icmp46_header_t icmp;
309  /* Current hop limit to use for outgoing packets. */
310  u8 current_hop_limit;
311  u8 flags;
312 #define ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP (1 << 7)
313 #define ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP (1 << 6)
314  /* Zero means unspecified. */
315  u16 router_lifetime_in_sec;
316  /* Zero means unspecified. */
317  u32 neighbor_reachable_time_in_msec;
318  /* Zero means unspecified. */
319  u32
320  time_in_msec_between_retransmitted_neighbor_solicitations;
321  /* Options that may follow: source_link_layer_address, mtu, prefix_information. */
322 }) icmp6_router_advertisement_header_t;
323 
324 /* Neighbor solicitation/advertisement header. */
325 typedef CLIB_PACKED (struct
326 {
327  icmp46_header_t icmp;
328  /* Zero for solicitation; flags for advertisement. */
329  u32 advertisement_flags;
330  /* Set when sent by a router. */
331 #define ICMP6_NEIGHBOR_ADVERTISEMENT_FLAG_ROUTER (1 << 31)
332  /* Set when response to solicitation. */
333 #define ICMP6_NEIGHBOR_ADVERTISEMENT_FLAG_SOLICITED (1 << 30)
334 #define ICMP6_NEIGHBOR_ADVERTISEMENT_FLAG_OVERRIDE (1 << 29)
335  ip6_address_t target_address;
336  /* Options that may follow: source_link_layer_address
337  (for solicitation) target_link_layer_address (for advertisement). */
338 }) icmp6_neighbor_solicitation_or_advertisement_header_t;
339 
340 typedef CLIB_PACKED (struct
341 {
342  icmp46_header_t icmp;
343  u32 reserved_must_be_zero;
344  /* Better next hop to use for given destination. */
345  ip6_address_t better_next_hop_address;
346  ip6_address_t dst_address;
347  /* Options that may follow: target_link_layer_address,
348  redirected_header. */
349 }) icmp6_redirect_header_t;
350 
351 /* Solicitation/advertisement packet format for ethernet. */
352 typedef CLIB_PACKED (struct
353 {
355  icmp6_neighbor_solicitation_or_advertisement_header_t
356  neighbor;
357  icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
358  link_layer_option;
359 }) icmp6_neighbor_solicitation_header_t;
360 /* *INDENT-ON* */
361 
362 #endif /* included_vnet_icmp46_packet_h */
#define foreach_icmp4_code
Definition: icmp46_packet.h:77
icmp6_code_t
#define foreach_icmp6_code
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105
unsigned char u8
Definition: types.h:56
u8 data[128]
Definition: ipsec_types.api:90
unsigned int u32
Definition: types.h:88
#define foreach_icmp6_neighbor_discovery_option
vl_api_fib_path_type_t type
Definition: fib_types.api:123
icmp
Definition: map.api:387
icmp4_code_t
unsigned short u16
Definition: types.h:57
enum icmp6_neighbor_discovery_option_type icmp6_neighbor_discovery_option_type_t
typedef CLIB_PACKED(struct { u8 type;u8 code;u16 checksum;}) icmp46_header_t
u32 valid_time
Definition: dhcp.api:312
#define foreach_icmp4_type
Definition: icmp46_packet.h:46
icmp4_type_t
#define foreach_icmp6_type
icmp6_neighbor_discovery_option_type
vl_api_address_t ip
Definition: l2.api:501
icmp6_type_t
u32 preferred_time
Definition: dhcp.api:313