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 * ip/ip_packet.h: packet format common between ip4 & ip6
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_ip_packet_h
41 #define included_ip_packet_h
43 #include <vppinfra/byte_order.h>
44 #include <vppinfra/error.h>
45 #include <vppinfra/format.h>
47 typedef enum ip_protocol
49 #define ip_protocol(n,s) IP_PROTOCOL_##s = n,
50 #include "protocols.def"
52 } __clib_packed ip_protocol_t;
57 #define ip_port(s,n) IP_PORT_##s = n,
62 /* Classifies protocols into UDP, ICMP or other. */
65 IP_BUILTIN_PROTOCOL_UDP,
66 IP_BUILTIN_PROTOCOL_ICMP,
67 IP_BUILTIN_PROTOCOL_UNKNOWN,
68 } ip_builtin_protocol_t;
70 #define foreach_ip_builtin_multicast_group \
71 _ (1, all_hosts_on_subnet) \
72 _ (2, all_routers_on_subnet) \
74 _ (5, ospf_all_routers) \
75 _ (6, ospf_designated_routers) \
83 #define _(n,f) IP_MULTICAST_GROUP_##f = n,
84 foreach_ip_builtin_multicast_group
86 } ip_multicast_group_t;
90 * The set of RFC defined DSCP values.
92 #define foreach_ip_dscp \
115 typedef enum ip_dscp_t_
117 #define _(n,f) IP_DSCP_##f = n,
120 } __clib_packed ip_dscp_t;
122 extern u8 *format_ip_dscp (u8 * s, va_list * va);
123 unformat_function_t unformat_ip_dscp;
127 * The ECN occupies the 2 least significant bits of the TC field
129 #define IP_PACKET_TC_FIELD_DSCP_BIT_SHIFT 2
130 #define IP_PACKET_TC_FIELD_ECN_MASK 0x03
133 * The set of RFC defined DSCP values.
135 #define foreach_ip_ecn \
141 typedef enum ip_ecn_t_
143 #define _(n,f) IP_ECN_##f = n,
146 } __clib_packed ip_ecn_t;
148 STATIC_ASSERT_SIZEOF (ip_ecn_t, 1);
150 extern u8 *format_ip_ecn (u8 * s, va_list * va);
152 /* Incremental checksum update. */
153 typedef uword ip_csum_t;
155 always_inline ip_csum_t
156 ip_csum_with_carry (ip_csum_t sum, ip_csum_t x)
158 ip_csum_t t = sum + x;
162 /* Update checksum changing field at even byte offset from x -> 0. */
163 always_inline ip_csum_t
164 ip_csum_add_even (ip_csum_t c, ip_csum_t x)
170 /* Fold in carry from high bit. */
173 ip_csum_t t = ip_csum_with_carry (d, x);
174 ASSERT ((t - c == 0) || (t - c == ~0));
179 /* Update checksum changing field at even byte offset from 0 -> x. */
180 always_inline ip_csum_t
181 ip_csum_sub_even (ip_csum_t c, ip_csum_t x)
183 return ip_csum_with_carry (c, x);
186 always_inline ip_csum_t
187 ip_csum_update_inline (ip_csum_t sum, ip_csum_t old, ip_csum_t new,
188 u32 field_byte_offset, u32 field_n_bytes)
190 /* For even 1-byte fields on big-endian and odd 1-byte fields on little endian
191 we need to shift byte into place for checksum. */
192 if ((field_n_bytes % 2)
193 && (field_byte_offset % 2) == CLIB_ARCH_IS_LITTLE_ENDIAN)
198 sum = ip_csum_sub_even (sum, old);
199 sum = ip_csum_add_even (sum, new);
203 #define ip_csum_update(sum,old,new,type,field) \
204 ip_csum_update_inline ((sum), (old), (new), \
205 STRUCT_OFFSET_OF (type, field), \
206 STRUCT_SIZE_OF (type, field))
209 ip_csum_fold (ip_csum_t c)
211 /* Reduce to 16 bits. */
212 #if defined(__x86_64__) && defined(__BMI2__)
215 /* using ADC is much faster than mov, shift, add sequence
216 * compiler produces */
217 "mov %k[sum], %k[tmp] \n\t"
218 "shr $32, %[sum] \n\t"
219 "add %k[tmp], %k[sum] \n\t"
220 "mov $16, %k[tmp] \n\t"
221 "shrx %k[tmp], %k[sum], %k[tmp] \n\t"
222 "adc %w[tmp], %w[sum] \n\t"
223 "adc $0, %w[sum] \n\t"
224 : [ sum ] "+&r"(c), [ tmp ] "=&r"(tmp));
227 c = (c & (ip_csum_t) 0xffffffff) + (c >> (ip_csum_t) 32);
228 c = (c & 0xffff) + (c >> 16);
231 c = (c & 0xffff) + (c >> 16);
232 c = (c & 0xffff) + (c >> 16);
237 extern ip_csum_t (*vnet_incremental_checksum_fp) (ip_csum_t, void *, uword);
239 /* Checksum routine. */
240 always_inline ip_csum_t
241 ip_incremental_checksum (ip_csum_t sum, void *_data, uword n_bytes)
243 return (*vnet_incremental_checksum_fp) (sum, _data, n_bytes);
247 ip_csum_and_memcpy_fold (ip_csum_t sum, void *dst)
249 return ip_csum_fold (sum);
252 #endif /* included_ip_packet_h */
255 * fd.io coding-style-patch-verification: ON
258 * eval: (c-set-style "gnu")