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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * ip4/packet.h: ip4 packet format
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_ip4_packet_h
41 #define included_ip4_packet_h
43 #include <vnet/ip/ip_packet.h> /* for ip_csum_t */
44 #include <vnet/tcp/tcp_packet.h> /* for tcp_header_t */
45 #include <vppinfra/byte_order.h> /* for clib_net_to_host_u16 */
47 /* IP4 address which can be accessed either as 4 bytes
48 or as a 32-bit number. */
61 /* IP address must be first for ip_interface_address_get_address() to work */
62 ip4_address_t ip4_addr;
67 ip4_addr_fib_init (ip4_address_fib_t * addr_fib, ip4_address_t * address,
70 clib_memcpy (&addr_fib->ip4_addr, address, sizeof (addr_fib->ip4_addr));
71 addr_fib->fib_index = fib_index;
74 /* (src,dst) pair of addresses as found in packet header. */
77 ip4_address_t src, dst;
80 /* If address is a valid netmask, return length of mask. */
82 ip4_address_netmask_length (ip4_address_t * a)
86 for (i = 0; i < ARRAY_LEN (a->as_u8); i++)
118 /* Not a valid netmask mask. */
130 /* 4 bit packet length (in 32bit units) and version VVVVLLLL.
131 e.g. for packets w/ no options ip_version_and_header_length == 0x45. */
132 u8 ip_version_and_header_length;
134 /* Type of service. */
137 /* Total layer 3 packet length including this header. */
140 /* Fragmentation ID. */
143 /* 3 bits of flags and 13 bits of fragment offset (in units
144 of 8 byte quantities). */
145 u16 flags_and_fragment_offset;
146 #define IP4_HEADER_FLAG_MORE_FRAGMENTS (1 << 13)
147 #define IP4_HEADER_FLAG_DONT_FRAGMENT (1 << 14)
148 #define IP4_HEADER_FLAG_CONGESTION (1 << 15)
150 /* Time to live decremented by router at each hop. */
153 /* Next level protocol packet. */
159 /* Source and destination address. */
164 ip4_address_t src_address, dst_address;
166 ip4_address_pair_t address_pair;
170 /* For checksumming we'll want to access IP header in word sized chunks. */
171 /* For 64 bit machines. */
173 CLIB_PACKED (struct {
174 u64 checksum_data_64[2];
175 u32 checksum_data_64_32[1];
179 /* For 32 bit machines. */
181 CLIB_PACKED (struct {
182 u32 checksum_data_32[5];
187 /* Value of ip_version_and_header_length for packets w/o options. */
188 #define IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS \
189 ((4 << 4) | (sizeof (ip4_header_t) / sizeof (u32)))
192 ip4_get_fragment_offset (ip4_header_t * i)
194 return clib_net_to_host_u16 (i->flags_and_fragment_offset) & 0x1fff;
198 ip4_get_fragment_more (ip4_header_t * i)
200 return clib_net_to_host_u16 (i->flags_and_fragment_offset) &
201 IP4_HEADER_FLAG_MORE_FRAGMENTS;
205 ip4_is_fragment (ip4_header_t * i)
207 return (i->flags_and_fragment_offset &
208 clib_net_to_host_u16 (0x1fff | IP4_HEADER_FLAG_MORE_FRAGMENTS));
212 ip4_is_first_fragment (ip4_header_t * i)
214 return (i->flags_and_fragment_offset &
215 clib_net_to_host_u16 (0x1fff | IP4_HEADER_FLAG_MORE_FRAGMENTS)) ==
216 clib_net_to_host_u16 (IP4_HEADER_FLAG_MORE_FRAGMENTS);
219 /* Fragment offset in bytes. */
221 ip4_get_fragment_offset_bytes (ip4_header_t * i)
223 return 8 * ip4_get_fragment_offset (i);
227 ip4_header_bytes (ip4_header_t * i)
229 return sizeof (u32) * (i->ip_version_and_header_length & 0xf);
233 ip4_next_header (ip4_header_t * i)
235 return (void *) i + ip4_header_bytes (i);
239 ip4_header_checksum (ip4_header_t * i)
246 sum = ip_incremental_checksum (0, i, ip4_header_bytes (i));
247 csum = ~ip_csum_fold (sum);
251 /* Make checksum agree for special case where either
252 0 or 0xffff would give same 1s complement sum. */
253 if (csum == 0 && save == 0xffff)
260 ip4_header_checksum_is_valid (ip4_header_t * i)
262 return i->checksum == ip4_header_checksum (i);
265 #define ip4_partial_header_checksum_x1(ip0,sum0) \
267 if (BITS (ip_csum_t) > 32) \
269 sum0 = ip0->checksum_data_64[0]; \
270 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64[1]); \
271 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64_32[0]); \
275 sum0 = ip0->checksum_data_32[0]; \
276 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[1]); \
277 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[2]); \
278 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[3]); \
279 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[4]); \
283 #define ip4_partial_header_checksum_x2(ip0,ip1,sum0,sum1) \
285 if (BITS (ip_csum_t) > 32) \
287 sum0 = ip0->checksum_data_64[0]; \
288 sum1 = ip1->checksum_data_64[0]; \
289 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64[1]); \
290 sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_64[1]); \
291 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64_32[0]); \
292 sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_64_32[0]); \
296 sum0 = ip0->checksum_data_32[0]; \
297 sum1 = ip1->checksum_data_32[0]; \
298 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[1]); \
299 sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[1]); \
300 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[2]); \
301 sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[2]); \
302 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[3]); \
303 sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[3]); \
304 sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[4]); \
305 sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[4]); \
310 ip4_address_is_multicast (ip4_address_t * a)
312 return (a->data[0] & 0xf0) == 0xe0;
316 ip4_multicast_address_set_for_group (ip4_address_t * a,
317 ip_multicast_group_t g)
319 ASSERT ((u32) g < (1 << 28));
320 a->as_u32 = clib_host_to_net_u32 ((0xe << 28) + g);
324 ip4_multicast_ethernet_address (u8 * ethernet_address, ip4_address_t * a)
328 ethernet_address[0] = 0x01;
329 ethernet_address[1] = 0x00;
330 ethernet_address[2] = 0x5e;
331 ethernet_address[3] = d[1] & 0x7f;
332 ethernet_address[4] = d[2];
333 ethernet_address[5] = d[3];
337 ip4_tcp_reply_x1 (ip4_header_t * ip0, tcp_header_t * tcp0)
341 src0 = ip0->src_address.data_u32;
342 dst0 = ip0->dst_address.data_u32;
343 ip0->src_address.data_u32 = dst0;
344 ip0->dst_address.data_u32 = src0;
353 ip4_tcp_reply_x2 (ip4_header_t * ip0, ip4_header_t * ip1,
354 tcp_header_t * tcp0, tcp_header_t * tcp1)
356 u32 src0, dst0, src1, dst1;
358 src0 = ip0->src_address.data_u32;
359 src1 = ip1->src_address.data_u32;
360 dst0 = ip0->dst_address.data_u32;
361 dst1 = ip1->dst_address.data_u32;
362 ip0->src_address.data_u32 = dst0;
363 ip1->src_address.data_u32 = dst1;
364 ip0->dst_address.data_u32 = src0;
365 ip1->dst_address.data_u32 = src1;
377 #endif /* included_ip4_packet_h */
380 * fd.io coding-style-patch-verification: ON
383 * eval: (c-set-style "gnu")