FD.io VPP  v17.01-9-ge7dcee4
Vector Packet Processing
format.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  * ethernet_format.c: ethernet formatting/parsing.
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 <vlib/vlib.h>
41 #include <vnet/ethernet/ethernet.h>
42 
43 u8 *
44 format_ethernet_address (u8 * s, va_list * args)
45 {
47  u8 *a = va_arg (*args, u8 *);
48 
50  return format (s, "%02x%02x.%02x%02x.%02x%02x",
51  a[0], a[1], a[2], a[3], a[4], a[5]);
52  else
53  return format (s, "%02x:%02x:%02x:%02x:%02x:%02x",
54  a[0], a[1], a[2], a[3], a[4], a[5]);
55 }
56 
57 u8 *
58 format_ethernet_type (u8 * s, va_list * args)
59 {
60  ethernet_type_t type = va_arg (*args, u32);
63 
64  if (t)
65  s = format (s, "%s", t->name);
66  else
67  s = format (s, "0x%04x", type);
68 
69  return s;
70 }
71 
72 u8 *
73 format_ethernet_vlan_tci (u8 * s, va_list * va)
74 {
75  u32 vlan_tci = va_arg (*va, u32);
76 
77  u32 vid = (vlan_tci & 0xfff);
78  u32 cfi = (vlan_tci >> 12) & 1;
79  u32 pri = (vlan_tci >> 13);
80 
81  s = format (s, "%d", vid);
82  if (pri != 0)
83  s = format (s, " priority %d", pri);
84  if (cfi != 0)
85  s = format (s, " cfi");
86 
87  return s;
88 }
89 
90 u8 *
91 format_ethernet_pbb (u8 * s, va_list * va)
92 {
93  u32 b_tag = va_arg (*va, u32);
94  u32 i_tag = va_arg (*va, u32);
95  u32 vid = (b_tag & 0xfff);
96  u32 bdei = (b_tag >> 12) & 1;
97  u32 bpcp = (b_tag >> 13);
98  u32 sid = (i_tag & 0xffffff);
99  u8 ires = (i_tag >> 24) & 3;
100  u8 iuca = (i_tag >> 27) & 1;
101  u8 idei = (i_tag >> 28) & 1;
102  u8 ipcp = (i_tag >> 29);
103 
104  s =
105  format (s, "B_tag %04X (vid %d, dei %d, pcp %d), ", b_tag, vid, bdei,
106  bpcp);
107  s =
108  format (s, "I_tag %08X (sid %d, res %d, dei %d, pcp %d)", i_tag, sid,
109  ires, iuca, idei, ipcp);
110 
111  return s;
112 }
113 
114 u8 *
116 {
117  ethernet_pbb_header_packed_t *ph =
118  va_arg (*args, ethernet_pbb_header_packed_t *);
120  u32 max_header_bytes = va_arg (*args, u32);
122  ethernet_header_t *e = &m->ethernet;
124  ethernet_type_t type = clib_net_to_host_u16 (e->type);
125  ethernet_type_t vlan_type[ARRAY_LEN (m->vlan)];
126  u32 n_vlan = 0, i, header_bytes;
127  uword indent;
128 
129  while ((type == ETHERNET_TYPE_VLAN || type == ETHERNET_TYPE_DOT1AD
130  || type == ETHERNET_TYPE_DOT1AH) && n_vlan < ARRAY_LEN (m->vlan))
131  {
132  vlan_type[n_vlan] = type;
133  if (type != ETHERNET_TYPE_DOT1AH)
134  {
135  v = m->vlan + n_vlan;
136  type = clib_net_to_host_u16 (v->type);
137  }
138  n_vlan++;
139  }
140 
141  header_bytes = sizeof (e[0]) + n_vlan * sizeof (v[0]);
142  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
143  return format (s, "ethernet header truncated");
144 
145  indent = format_get_indent (s);
146 
147  s = format (s, "%U: %U -> %U",
148  format_ethernet_type, type,
151 
152  if (type != ETHERNET_TYPE_DOT1AH)
153  {
154  for (i = 0; i < n_vlan; i++)
155  {
156  u32 v = clib_net_to_host_u16 (m->vlan[i].priority_cfi_and_id);
157  if (*vlan_type == ETHERNET_TYPE_VLAN)
158  s = format (s, " 802.1q vlan %U", format_ethernet_vlan_tci, v);
159  else
160  s = format (s, " 802.1ad vlan %U", format_ethernet_vlan_tci, v);
161  }
162 
163  if (max_header_bytes != 0 && header_bytes < max_header_bytes)
164  {
166  vlib_node_t *node = 0;
167 
168  ti = ethernet_get_type_info (em, type);
169  if (ti && ti->node_index != ~0)
170  node = vlib_get_node (em->vlib_main, ti->node_index);
171  if (node && node->format_buffer)
172  s = format (s, "\n%U%U",
173  format_white_space, indent,
174  node->format_buffer, (void *) m + header_bytes,
175  max_header_bytes - header_bytes);
176  }
177  }
178  else
179  {
180  s = format (s, "\n%UPBB header : %U", format_white_space, indent,
182  clib_net_to_host_u16 (ph->priority_dei_id),
183  clib_net_to_host_u32 (ph->priority_dei_uca_res_sid));
184  }
185 
186  return s;
187 }
188 
189 u8 *
190 format_ethernet_header (u8 * s, va_list * args)
191 {
192  ethernet_max_header_t *m = va_arg (*args, ethernet_max_header_t *);
193  return format (s, "%U", format_ethernet_header_with_length, m, 0);
194 }
195 
196 /* Parse X:X:X:X:X:X unix style ethernet address. */
197 static uword
199 {
200  u8 *result = va_arg (*args, u8 *);
201  u32 i, a[6];
202 
203  if (!unformat (input, "%_%x:%x:%x:%x:%x:%x%_",
204  &a[0], &a[1], &a[2], &a[3], &a[4], &a[5]))
205  return 0;
206 
207  /* Check range. */
208  for (i = 0; i < ARRAY_LEN (a); i++)
209  if (a[i] >= (1 << 8))
210  return 0;
211 
212  for (i = 0; i < ARRAY_LEN (a); i++)
213  result[i] = a[i];
214 
215  return 1;
216 }
217 
218 /* Parse X.X.X cisco style ethernet address. */
219 static uword
221 {
222  u8 *result = va_arg (*args, u8 *);
223  u32 i, a[3];
224 
225  if (!unformat (input, "%_%x.%x.%x%_", &a[0], &a[1], &a[2]))
226  return 0;
227 
228  /* Check range. */
229  for (i = 0; i < ARRAY_LEN (a); i++)
230  if (a[i] >= (1 << 16))
231  return 0;
232 
233  result[0] = (a[0] >> 8) & 0xff;
234  result[1] = (a[0] >> 0) & 0xff;
235  result[2] = (a[1] >> 8) & 0xff;
236  result[3] = (a[1] >> 0) & 0xff;
237  result[4] = (a[2] >> 8) & 0xff;
238  result[5] = (a[2] >> 0) & 0xff;
239 
240  return 1;
241 }
242 
243 /* Parse ethernet address; accept either unix or style addresses. */
244 uword
246 {
247  u8 *result = va_arg (*args, u8 *);
248  return (unformat_user (input, unformat_ethernet_address_unix, result)
249  || unformat_user (input, unformat_ethernet_address_cisco, result));
250 }
251 
252 /* Returns ethernet type as an int in host byte order. */
253 uword
255  va_list * args)
256 {
257  u16 *result = va_arg (*args, u16 *);
259  int type, i;
260 
261  /* Numeric type. */
262  if (unformat (input, "0x%x", &type) || unformat (input, "%d", &type))
263  {
264  if (type >= (1 << 16))
265  return 0;
266  *result = type;
267  return 1;
268  }
269 
270  /* Named type. */
272  em->type_info_by_name, &i))
273  {
275  *result = ti->type;
276  return 1;
277  }
278 
279  return 0;
280 }
281 
282 uword
284  va_list * args)
285 {
286  u16 *result = va_arg (*args, u16 *);
288  return 0;
289 
290  *result = clib_host_to_net_u16 ((u16) * result);
291  return 1;
292 }
293 
294 uword
296 {
297  u8 **result = va_arg (*args, u8 **);
298  ethernet_max_header_t _m, *m = &_m;
299  ethernet_header_t *e = &m->ethernet;
300  u16 type;
301  u32 n_vlan;
302 
303  if (!unformat (input, "%U: %U -> %U",
307  return 0;
308 
309  n_vlan = 0;
310  while (unformat (input, "vlan"))
311  {
312  u32 id, priority;
313 
314  if (!unformat_user (input, unformat_vlib_number, &id)
315  || id >= ETHERNET_N_VLAN)
316  return 0;
317 
318  if (unformat (input, "priority %d", &priority))
319  {
320  if (priority >= 8)
321  return 0;
322  id |= priority << 13;
323  }
324 
325  if (unformat (input, "cfi"))
326  id |= 1 << 12;
327 
328  /* Too many vlans given. */
329  if (n_vlan >= ARRAY_LEN (m->vlan))
330  return 0;
331 
332  m->vlan[n_vlan].priority_cfi_and_id = clib_host_to_net_u16 (id);
333  n_vlan++;
334  }
335 
336  if (n_vlan == 0)
337  e->type = clib_host_to_net_u16 (type);
338  else
339  {
340  int i;
341 
342  e->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
343  for (i = 0; i < n_vlan - 1; i++)
344  m->vlan[i].type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
345  m->vlan[n_vlan - 1].type = clib_host_to_net_u16 (type);
346  }
347 
348  /* Add header to result. */
349  {
350  void *p;
351  u32 n_bytes = sizeof (e[0]) + n_vlan * sizeof (m->vlan[0]);
352 
353  vec_add2 (*result, p, n_bytes);
354  clib_memcpy (p, m, n_bytes);
355  }
356 
357  return 1;
358 }
359 
360 /*
361  * fd.io coding-style-patch-verification: ON
362  *
363  * Local Variables:
364  * eval: (c-set-style "gnu")
365  * End:
366  */
uword unformat_vlib_number(unformat_input_t *input, va_list *args)
Definition: format.c:148
uword unformat_ethernet_header(unformat_input_t *input, va_list *args)
Definition: format.c:295
u8 * format_ethernet_address(u8 *s, va_list *args)
Definition: format.c:44
#define ETHERNET_N_VLAN
Definition: packet.h:88
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:343
uword unformat(unformat_input_t *i, char *fmt,...)
Definition: unformat.c:966
a
Definition: bitmap.h:516
vlib_main_t * vlib_main
Definition: ethernet.h:230
bad routing header type(not 4)") sr_error (NO_MORE_SEGMENTS
ethernet_type_t
Definition: packet.h:43
u8 src_address[6]
Definition: packet.h:54
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:521
uword * type_info_by_name
Definition: ethernet.h:248
u8 * format_ethernet_vlan_tci(u8 *s, va_list *va)
Definition: format.c:73
u8 * format_ethernet_header_with_length(u8 *s, va_list *args)
Definition: format.c:115
ethernet_main_t ethernet_main
Definition: ethernet.h:270
u8 dst_address[6]
Definition: packet.h:53
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:113
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
int format_ethernet_address_16bit
Definition: ethernet.h:261
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:977
u8 * format_ethernet_pbb(u8 *s, va_list *va)
Definition: format.c:91
static uword format_get_indent(u8 *s)
Definition: format.h:72
uword unformat_ethernet_type_net_byte_order(unformat_input_t *input, va_list *args)
Definition: format.c:283
static ethernet_type_info_t * ethernet_get_type_info(ethernet_main_t *em, ethernet_type_t type)
Definition: ethernet.h:273
#define v
Definition: acl.c:314
uword unformat_ethernet_address(unformat_input_t *input, va_list *args)
Definition: format.c:245
format_function_t * format_buffer
Definition: node.h:311
static uword unformat_ethernet_address_unix(unformat_input_t *input, va_list *args)
Definition: format.c:198
#define clib_memcpy(a, b, c)
Definition: string.h:69
uword unformat_vlib_number_by_name(unformat_input_t *input, va_list *args)
Definition: format.c:157
ethernet_vlan_header_t vlan[2]
Definition: ethernet.h:97
#define ARRAY_LEN(x)
Definition: clib.h:59
u8 * format_ethernet_header(u8 *s, va_list *args)
Definition: format.c:190
unsigned int u32
Definition: types.h:88
ethernet_type_t type
Definition: ethernet.h:139
static uword unformat_ethernet_address_cisco(unformat_input_t *input, va_list *args)
Definition: format.c:220
u64 uword
Definition: types.h:112
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
ethernet_header_t ethernet
Definition: ethernet.h:94
uword unformat_ethernet_type_host_byte_order(unformat_input_t *input, va_list *args)
Definition: format.c:254
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
u8 * format_ethernet_type(u8 *s, va_list *args)
Definition: format.c:58
ethernet_type_info_t * type_infos
Definition: ethernet.h:245