FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
rewrite.c
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  * rewrite.c: packet rewrite
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 #include <vnet/vnet.h>
41 #include <vnet/ip/lookup.h>
42 
43 void
45  vnet_rewrite_data_t * rw0,
46  word n_left, uword most_likely_size)
47 {
48  uword n_done =
49  round_pow2 (most_likely_size, sizeof (rw0[0])) / sizeof (rw0[0]);
50 
51  p0 -= n_done;
52  rw0 -= n_done;
53 
54  /* As we enter the cleanup loop, p0 and rw0 point to the last chunk written
55  by the fast path. Hence, the constant 1, which the
56  vnet_rewrite_copy_one macro renders as p0[-1] = rw0[-1]. */
57 
58  while (n_left > 0)
59  {
60  vnet_rewrite_copy_one (p0, rw0, 1);
61  p0--;
62  rw0--;
63  n_left--;
64  }
65 }
66 
67 u8 *
68 format_vnet_rewrite (u8 * s, va_list * args)
69 {
70  vlib_main_t *vm = va_arg (*args, vlib_main_t *);
71  vnet_rewrite_header_t *rw = va_arg (*args, vnet_rewrite_header_t *);
72  u32 max_data_bytes = va_arg (*args, u32);
73  CLIB_UNUSED (uword indent) = va_arg (*args, u32);
74  vnet_main_t *vnm = vnet_get_main ();
75  vlib_node_t *next;
76 
77  next = vlib_get_next_node (vm, rw->node_index, rw->next_index);
78 
79  if (rw->sw_if_index != ~0)
80  {
82  si = vnet_get_sw_interface (vnm, rw->sw_if_index);
83  s = format (s, "%U: ", format_vnet_sw_interface_name, vnm, si);
84  }
85  else
86  s = format (s, "%v: ", next->name);
87 
88  /* Format rewrite string. */
89  if (rw->data_bytes > 0)
90 
91  s = format (s, "%U",
93  rw->data + max_data_bytes - rw->data_bytes, rw->data_bytes);
94 
95  return s;
96 }
97 
98 u8 *
99 format_vnet_rewrite_header (u8 * s, va_list * args)
100 {
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);
105  vlib_node_t *next;
106 
107  next = vlib_get_next_node (vm, rw->node_index, rw->next_index);
108 
109  /* Format rewrite string. */
110  s = format (s, "%U",
112  packet_data, packet_data_bytes);
113 
114  return s;
115 }
116 
117 uword
118 unformat_vnet_rewrite (unformat_input_t * input, va_list * args)
119 {
120  vlib_main_t *vm = va_arg (*args, vlib_main_t *);
121  vnet_rewrite_header_t *rw = va_arg (*args, vnet_rewrite_header_t *);
122  u32 max_data_bytes = va_arg (*args, u32);
123  vnet_main_t *vnm = vnet_get_main ();
124  vlib_node_t *next;
125  u32 next_index, sw_if_index, max_packet_bytes, error;
126  u8 *rw_data;
127 
128  rw_data = 0;
129  sw_if_index = ~0;
130  max_packet_bytes = ~0;
131  error = 1;
132 
133  /* Parse sw interface. */
134  if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
135  {
137 
138  hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
139 
140  next_index = hi->output_node_index;
141  max_packet_bytes = hi->max_l3_packet_bytes[VLIB_RX];
142  }
143 
144  else if (unformat (input, "%U", unformat_vlib_node, vm, &next_index))
145  ;
146 
147  else
148  goto done;
149 
150  next = vlib_get_node (vm, next_index);
151 
152  if (next->unformat_buffer
153  && unformat_user (input, next->unformat_buffer, &rw_data))
154  ;
155 
156  else if (unformat_user (input, unformat_hex_string, &rw_data)
157  || unformat (input, "0x%U", unformat_hex_string, &rw_data))
158  ;
159 
160  else
161  goto done;
162 
163  /* Re-write does not fit. */
164  if (vec_len (rw_data) >= max_data_bytes)
165  goto done;
166 
167  {
168  u32 tmp;
169 
170  if (unformat (input, "mtu %d", &tmp)
171  && tmp < (1 << BITS (rw->max_l3_packet_bytes)))
172  max_packet_bytes = tmp;
173  }
174 
175  error = 0;
176  rw->sw_if_index = sw_if_index;
177  rw->max_l3_packet_bytes = max_packet_bytes;
178  rw->next_index = vlib_node_add_next (vm, rw->node_index, next_index);
179  vnet_rewrite_set_data_internal (rw, max_data_bytes, rw_data,
180  vec_len (rw_data));
181 
182 done:
183  vec_free (rw_data);
184  return error == 0;
185 }
186 
187 u32
189 {
190  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
191  return (hw->output_node_index);
192 }
193 
194 void
196  u32 sw_if_index,
197  u32 this_node, u32 next_node, vnet_rewrite_header_t * rw)
198 {
199  rw->sw_if_index = sw_if_index;
200  rw->node_index = this_node;
201  rw->next_index = vlib_node_add_next (vnm->vlib_main, this_node, next_node);
202  rw->max_l3_packet_bytes =
203  vnet_sw_interface_get_mtu (vnm, sw_if_index, VLIB_TX);
204 }
205 
206 void
208  vnet_link_t link_type,
209  u32 sw_if_index,
210  u32 node_index,
211  void *dst_address,
212  vnet_rewrite_header_t * rw,
213  u32 max_rewrite_bytes)
214 {
215 
216  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
219  u8 *rewrite = NULL;
220 
221  vnet_rewrite_init (vnm, sw_if_index, node_index,
222  vnet_tx_node_index_for_sw_interface (vnm, sw_if_index),
223  rw);
224 
225  ASSERT (hc->build_rewrite);
226  rewrite = hc->build_rewrite (vnm, sw_if_index, link_type, dst_address);
227 
228  ASSERT (vec_len (rewrite) < max_rewrite_bytes);
229  vnet_rewrite_set_data_internal (rw, max_rewrite_bytes, rewrite,
230  vec_len (rewrite));
231  vec_free (rewrite);
232 }
233 
234 void
236  u32 tx_sw_if_index,
237  u32 rewrite_node_index,
238  u32 post_rewrite_node_index,
239  vnet_rewrite_header_t * rw,
240  u8 * rewrite_data, u32 rewrite_length)
241 {
242  ip_adjacency_t *adj = 0;
243  /*
244  * Installed into vnet_buffer(b)->sw_if_index[VLIB_TX] e.g.
245  * by ip4_rewrite_inline. If the post-rewrite node injects into
246  * ipX-forward, this will be interpreted as a FIB number.
247  */
248  rw->sw_if_index = tx_sw_if_index;
249  rw->node_index = rewrite_node_index;
250  rw->next_index = vlib_node_add_next (vnm->vlib_main, rewrite_node_index,
251  post_rewrite_node_index);
252  rw->max_l3_packet_bytes = (u16) ~ 0; /* we can't know at this point */
253 
254  ASSERT (rewrite_length < sizeof (adj->rewrite_data));
255  /* Leave room for ethernet + VLAN tag */
256  vnet_rewrite_set_data_internal (rw, sizeof (adj->rewrite_data),
257  rewrite_data, rewrite_length);
258 }
259 
260 void
262 {
263  vnet_rewrite_header_t *rw = va_arg (*va, vnet_rewrite_header_t *);
264  u32 max_data_bytes = va_arg (*va, u32);
265  u8 *p;
266 
267  serialize_integer (m, rw->sw_if_index, sizeof (rw->sw_if_index));
268  serialize_integer (m, rw->data_bytes, sizeof (rw->data_bytes));
269  serialize_integer (m, rw->max_l3_packet_bytes,
270  sizeof (rw->max_l3_packet_bytes));
271  p = serialize_get (m, rw->data_bytes);
272  clib_memcpy (p, vnet_rewrite_get_data_internal (rw, max_data_bytes),
273  rw->data_bytes);
274 }
275 
276 void
278 {
279  vnet_rewrite_header_t *rw = va_arg (*va, vnet_rewrite_header_t *);
280  u32 max_data_bytes = va_arg (*va, u32);
281  u8 *p;
282 
283  /* It is up to user to fill these in. */
284  rw->node_index = ~0;
285  rw->next_index = ~0;
286 
287  unserialize_integer (m, &rw->sw_if_index, sizeof (rw->sw_if_index));
288  unserialize_integer (m, &rw->data_bytes, sizeof (rw->data_bytes));
289  unserialize_integer (m, &rw->max_l3_packet_bytes,
290  sizeof (rw->max_l3_packet_bytes));
291  p = unserialize_get (m, rw->data_bytes);
292  clib_memcpy (vnet_rewrite_get_data_internal (rw, max_data_bytes), p,
293  rw->data_bytes);
294 }
295 
296 u8 *
298  u32 sw_if_index,
299  vnet_link_t link_type,
300  const void *dst_address)
301 {
302  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
305 
306  ASSERT (hc->build_rewrite);
307  return (hc->build_rewrite (vnm, sw_if_index, link_type, dst_address));
308 }
309 
310 
311 void
313  u32 sw_if_index, u32 ai)
314 {
315  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
318 
319  ASSERT (hc->update_adjacency);
320  hc->update_adjacency (vnm, sw_if_index, ai);
321 }
322 
323 /*
324  * fd.io coding-style-patch-verification: ON
325  *
326  * Local Variables:
327  * eval: (c-set-style "gnu")
328  * End:
329  */
vmrglw vmrglh hi
void vnet_rewrite_init(vnet_main_t *vnm, u32 sw_if_index, u32 this_node, u32 next_node, vnet_rewrite_header_t *rw)
Definition: rewrite.c:195
#define CLIB_UNUSED(x)
Definition: clib.h:79
uword unformat(unformat_input_t *i, char *fmt,...)
Definition: unformat.c:966
static uword vnet_sw_interface_get_mtu(vnet_main_t *vnm, u32 sw_if_index, vlib_rx_or_tx_t dir)
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definitions for all things IP (v4|v6) unicast and multicast lookup related.
uword vnet_rewrite_data_t
Definition: rewrite.h:47
#define NULL
Definition: clib.h:55
IP unicast adjacency.
Definition: lookup.h:188
void vnet_rewrite_for_sw_interface(vnet_main_t *vnm, vnet_link_t link_type, u32 sw_if_index, u32 node_index, void *dst_address, vnet_rewrite_header_t *rw, u32 max_rewrite_bytes)
Deprecated.
Definition: rewrite.c:207
static vnet_sw_interface_t * vnet_get_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
unformat_function_t unformat_vnet_sw_interface
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1063
void serialize_vnet_rewrite(serialize_main_t *m, va_list *va)
Definition: rewrite.c:261
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
void unserialize_vnet_rewrite(serialize_main_t *m, va_list *va)
Definition: rewrite.c:277
unformat_function_t unformat_hex_string
Definition: format.h:287
static void * serialize_get(serialize_main_t *m, uword n_bytes)
Definition: serialize.h:178
u8 * format_hex_bytes(u8 *s, va_list *va)
Definition: std-formats.c:84
static void vnet_rewrite_copy_one(vnet_rewrite_data_t *p0, vnet_rewrite_data_t *rw0, int i)
Definition: rewrite.h:131
void vnet_update_adjacency_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index, u32 ai)
Definition: rewrite.c:312
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:977
u8 * format_vnet_rewrite_header(u8 *s, va_list *args)
Definition: rewrite.c:99
format_function_t format_vnet_sw_interface_name
vlib_main_t * vlib_main
Definition: vnet.h:79
uword unformat_vnet_rewrite(unformat_input_t *input, va_list *args)
Definition: rewrite.c:118
void vnet_rewrite_copy_slow_path(vnet_rewrite_data_t *p0, vnet_rewrite_data_t *rw0, word n_left, uword most_likely_size)
Definition: rewrite.c:44
static void * vnet_rewrite_get_data_internal(vnet_rewrite_header_t *rw, int max_size)
Definition: rewrite.h:121
u8 * vnet_build_rewrite_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index, vnet_link_t link_type, const void *dst_address)
Definition: rewrite.c:297
static void * unserialize_get(serialize_main_t *m, uword n_bytes)
Definition: serialize.h:171
format_function_t * format_buffer
Definition: node.h:311
void vnet_rewrite_for_tunnel(vnet_main_t *vnm, u32 tx_sw_if_index, u32 rewrite_node_index, u32 post_rewrite_node_index, vnet_rewrite_header_t *rw, u8 *rewrite_data, u32 rewrite_length)
Definition: rewrite.c:235
u8 * name
Definition: node.h:221
u8 * format_vnet_rewrite(u8 *s, va_list *args)
Definition: rewrite.c:68
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:300
u32 vnet_tx_node_index_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: rewrite.c:188
static void vnet_rewrite_set_data_internal(vnet_rewrite_header_t *rw, int max_size, void *data, int data_bytes)
Definition: rewrite.h:102
#define clib_memcpy(a, b, c)
Definition: string.h:69
unformat_function_t * unformat_buffer
Definition: node.h:312
static void unserialize_integer(serialize_main_t *m, void *x, u32 n_bytes)
Definition: serialize.h:201
static void serialize_integer(serialize_main_t *m, u64 x, u32 n_bytes)
Definition: serialize.h:185
static uword round_pow2(uword x, uword pow2)
Definition: clib.h:272
u32 max_l3_packet_bytes[VLIB_N_RX_TX]
Definition: interface.h:449
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
static vnet_hw_interface_class_t * vnet_get_hw_interface_class(vnet_main_t *vnm, u32 hw_class_index)
u64 uword
Definition: types.h:112
Definition: defs.h:47
static vlib_node_t * vlib_get_next_node(vlib_main_t *vm, u32 node_index, u32 next_index)
Get vlib node by graph arc (next) index.
Definition: node_funcs.h:71
unsigned short u16
Definition: types.h:57
i64 word
Definition: types.h:111
struct _vnet_hw_interface_class vnet_hw_interface_class_t
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
unformat_function_t unformat_vlib_node
Definition: node_funcs.h:1110
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:418
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:58
struct _unformat_input_t unformat_input_t
#define BITS(x)
Definition: clib.h:58
Definition: defs.h:46