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 * rewrite.c: packet rewrite
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 #include <vnet/vnet.h>
41 #include <vnet/ip/lookup.h>
43 void vnet_rewrite_copy_slow_path (vnet_rewrite_data_t * p0,
44 vnet_rewrite_data_t * rw0,
46 uword most_likely_size)
48 uword n_done = round_pow2 (most_likely_size, sizeof (rw0[0])) / sizeof (rw0[0]);
53 /* As we enter the cleanup loop, p0 and rw0 point to the last chunk written
54 by the fast path. Hence, the constant 1, which the
55 vnet_rewrite_copy_one macro renders as p0[-1] = rw0[-1]. */
59 vnet_rewrite_copy_one (p0, rw0, 1);
66 u8 * format_vnet_rewrite (u8 * s, va_list * args)
68 vlib_main_t * vm = va_arg (*args, vlib_main_t *);
69 vnet_rewrite_header_t * rw = va_arg (*args, vnet_rewrite_header_t *);
70 u32 max_data_bytes = va_arg (*args, u32);
71 vnet_main_t * vnm = vnet_get_main();
75 next = vlib_get_next_node (vm, rw->node_index, rw->next_index);
77 indent = format_get_indent (s);
79 if (rw->sw_if_index != ~0)
81 vnet_sw_interface_t * si;
82 si = vnet_get_sw_interface (vnm, rw->sw_if_index);
83 s = format (s, "%U", format_vnet_sw_interface_name, vnm, si);
86 s = format (s, "%v", next->name);
88 /* Format rewrite string. */
89 if (rw->data_bytes > 0)
90 s = format (s, "\n%U%U",
91 format_white_space, indent,
92 next->format_buffer ? next->format_buffer : format_hex_bytes,
93 rw->data + max_data_bytes - rw->data_bytes,
99 u8 * format_vnet_rewrite_header (u8 * s, va_list * args)
101 vlib_main_t * vm = va_arg (*args, vlib_main_t *);
102 vnet_rewrite_header_t * rw = va_arg (*args, vnet_rewrite_header_t *);
103 u8 * packet_data = va_arg (*args, u8 *);
104 u32 packet_data_bytes = va_arg (*args, u32);
107 next = vlib_get_next_node (vm, rw->node_index, rw->next_index);
109 /* Format rewrite string. */
111 next->format_buffer ? next->format_buffer : format_hex_bytes,
112 packet_data, packet_data_bytes);
117 uword unformat_vnet_rewrite (unformat_input_t * input, va_list * args)
119 vlib_main_t * vm = va_arg (*args, vlib_main_t *);
120 vnet_rewrite_header_t * rw = va_arg (*args, vnet_rewrite_header_t *);
121 u32 max_data_bytes = va_arg (*args, u32);
122 vnet_main_t * vnm = vnet_get_main();
124 u32 next_index, sw_if_index, max_packet_bytes, error;
129 max_packet_bytes = ~0;
132 /* Parse sw interface. */
133 if (unformat (input, "%U",
134 unformat_vnet_sw_interface, vnm, &sw_if_index))
136 vnet_hw_interface_t * hi;
138 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
140 next_index = hi->output_node_index;
141 max_packet_bytes = hi->max_l3_packet_bytes[VLIB_RX];
144 else if (unformat (input, "%U",
145 unformat_vlib_node, vm, &next_index))
151 next = vlib_get_node (vm, next_index);
153 if (next->unformat_buffer
154 && unformat_user (input, next->unformat_buffer, &rw_data))
157 else if (unformat_user (input, unformat_hex_string, &rw_data)
158 || unformat (input, "0x%U", unformat_hex_string, &rw_data))
164 /* Re-write does not fit. */
165 if (vec_len (rw_data) >= max_data_bytes)
171 if (unformat (input, "mtu %d", &tmp)
172 && tmp < (1 << BITS (rw->max_l3_packet_bytes)))
173 max_packet_bytes = tmp;
177 rw->sw_if_index = sw_if_index;
178 rw->max_l3_packet_bytes = max_packet_bytes;
179 rw->next_index = vlib_node_add_next (vm, rw->node_index, next_index);
180 vnet_rewrite_set_data_internal (rw, max_data_bytes, rw_data, vec_len (rw_data));
187 void vnet_rewrite_for_sw_interface (vnet_main_t * vnm,
188 vnet_l3_packet_type_t packet_type,
192 vnet_rewrite_header_t * rw,
193 u32 max_rewrite_bytes)
195 vnet_hw_interface_t * hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
196 vnet_hw_interface_class_t * hc = vnet_get_hw_interface_class (vnm, hw->hw_class_index);
197 static u8 * rw_tmp = 0;
200 rw->sw_if_index = sw_if_index;
201 rw->node_index = node_index;
202 rw->next_index = vlib_node_add_next (vnm->vlib_main, node_index, hw->output_node_index);
203 rw->max_l3_packet_bytes = hw->max_l3_packet_bytes[VLIB_TX];
205 ASSERT (max_rewrite_bytes > 0);
206 vec_reset_length (rw_tmp);
207 vec_validate (rw_tmp, max_rewrite_bytes - 1);
209 ASSERT (hc->set_rewrite);
210 n_rw_tmp = hc->set_rewrite (vnm, sw_if_index, packet_type, dst_address, rw_tmp, max_rewrite_bytes);
212 ASSERT (n_rw_tmp >= 0 && n_rw_tmp < max_rewrite_bytes);
213 vnet_rewrite_set_data_internal (rw, max_rewrite_bytes, rw_tmp, n_rw_tmp);
216 void vnet_rewrite_for_tunnel (vnet_main_t * vnm,
218 u32 rewrite_node_index,
219 u32 post_rewrite_node_index,
220 vnet_rewrite_header_t * rw,
224 ip_adjacency_t * adj = 0;
226 * Installed into vnet_buffer(b)->sw_if_index[VLIB_TX] e.g.
227 * by ip4_rewrite_inline. If the post-rewrite node injects into
228 * ipX-forward, this will be interpreted as a FIB number.
230 rw->sw_if_index = tx_sw_if_index;
231 rw->node_index = rewrite_node_index;
232 rw->next_index = vlib_node_add_next (vnm->vlib_main, rewrite_node_index,
233 post_rewrite_node_index);
234 rw->max_l3_packet_bytes = (u16) ~0; /* we can't know at this point */
236 ASSERT (rewrite_length < sizeof (adj->rewrite_data));
237 /* Leave room for ethernet + VLAN tag */
238 vnet_rewrite_set_data_internal (rw, sizeof(adj->rewrite_data),
239 rewrite_data, rewrite_length);
242 void serialize_vnet_rewrite (serialize_main_t * m, va_list * va)
244 vnet_rewrite_header_t * rw = va_arg (*va, vnet_rewrite_header_t *);
245 u32 max_data_bytes = va_arg (*va, u32);
248 serialize_integer (m, rw->sw_if_index, sizeof (rw->sw_if_index));
249 serialize_integer (m, rw->data_bytes, sizeof (rw->data_bytes));
250 serialize_integer (m, rw->max_l3_packet_bytes, sizeof (rw->max_l3_packet_bytes));
251 p = serialize_get (m, rw->data_bytes);
252 clib_memcpy (p, vnet_rewrite_get_data_internal (rw, max_data_bytes), rw->data_bytes);
255 void unserialize_vnet_rewrite (serialize_main_t * m, va_list * va)
257 vnet_rewrite_header_t * rw = va_arg (*va, vnet_rewrite_header_t *);
258 u32 max_data_bytes = va_arg (*va, u32);
261 /* It is up to user to fill these in. */
265 unserialize_integer (m, &rw->sw_if_index, sizeof (rw->sw_if_index));
266 unserialize_integer (m, &rw->data_bytes, sizeof (rw->data_bytes));
267 unserialize_integer (m, &rw->max_l3_packet_bytes, sizeof (rw->max_l3_packet_bytes));
268 p = unserialize_get (m, rw->data_bytes);
269 clib_memcpy (vnet_rewrite_get_data_internal (rw, max_data_bytes), p, rw->data_bytes);