FD.io VPP  v18.04-17-g3a0d853
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 *
92 {
93  ethernet_pbb_header_packed_t *ph =
94  va_arg (*args, ethernet_pbb_header_packed_t *);
96  u32 max_header_bytes = va_arg (*args, u32);
98  ethernet_header_t *e = &m->ethernet;
100  ethernet_type_t type = clib_net_to_host_u16 (e->type);
101  ethernet_type_t vlan_type[ARRAY_LEN (m->vlan)];
102  u32 n_vlan = 0, i, header_bytes;
103  u32 indent;
104 
105  while ((type == ETHERNET_TYPE_VLAN || type == ETHERNET_TYPE_DOT1AD
106  || type == ETHERNET_TYPE_DOT1AH) && n_vlan < ARRAY_LEN (m->vlan))
107  {
108  vlan_type[n_vlan] = type;
109  if (type != ETHERNET_TYPE_DOT1AH)
110  {
111  v = m->vlan + n_vlan;
112  type = clib_net_to_host_u16 (v->type);
113  }
114  n_vlan++;
115  }
116 
117  header_bytes = sizeof (e[0]) + n_vlan * sizeof (v[0]);
118  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
119  return format (s, "ethernet header truncated");
120 
121  indent = format_get_indent (s);
122 
123  s = format (s, "%U: %U -> %U",
124  format_ethernet_type, type,
127 
128  if (type != ETHERNET_TYPE_DOT1AH)
129  {
130  for (i = 0; i < n_vlan; i++)
131  {
132  u32 v = clib_net_to_host_u16 (m->vlan[i].priority_cfi_and_id);
133  if (*vlan_type == ETHERNET_TYPE_VLAN)
134  s = format (s, " 802.1q vlan %U", format_ethernet_vlan_tci, v);
135  else
136  s = format (s, " 802.1ad vlan %U", format_ethernet_vlan_tci, v);
137  }
138 
139  if (max_header_bytes != 0 && header_bytes < max_header_bytes)
140  {
142  vlib_node_t *node = 0;
143 
144  ti = ethernet_get_type_info (em, type);
145  if (ti && ti->node_index != ~0)
146  node = vlib_get_node (em->vlib_main, ti->node_index);
147  if (node && node->format_buffer)
148  s = format (s, "\n%U%U",
149  format_white_space, indent,
150  node->format_buffer, (void *) m + header_bytes,
151  max_header_bytes - header_bytes);
152  }
153  }
154  else
155  {
156  s =
157  format (s, " %s b-tag %04X",
158  (clib_net_to_host_u16 (ph->b_type) ==
159  ETHERNET_TYPE_DOT1AD) ? "802.1ad" : "",
160  clib_net_to_host_u16 (ph->priority_dei_id));
161  s =
162  format (s, " %s i-tag %08X",
163  (clib_net_to_host_u16 (ph->i_type) ==
164  ETHERNET_TYPE_DOT1AH) ? "802.1ah" : "",
165  clib_net_to_host_u32 (ph->priority_dei_uca_res_sid));
166  }
167 
168  return s;
169 }
170 
171 u8 *
172 format_ethernet_header (u8 * s, va_list * args)
173 {
174  ethernet_max_header_t *m = va_arg (*args, ethernet_max_header_t *);
175  return format (s, "%U", format_ethernet_header_with_length, m, 0);
176 }
177 
178 /* Parse X:X:X:X:X:X unix style ethernet address. */
179 static uword
181 {
182  u8 *result = va_arg (*args, u8 *);
183  u32 i, a[6];
184 
185  if (!unformat (input, "%_%x:%x:%x:%x:%x:%x%_",
186  &a[0], &a[1], &a[2], &a[3], &a[4], &a[5]))
187  return 0;
188 
189  /* Check range. */
190  for (i = 0; i < ARRAY_LEN (a); i++)
191  if (a[i] >= (1 << 8))
192  return 0;
193 
194  for (i = 0; i < ARRAY_LEN (a); i++)
195  result[i] = a[i];
196 
197  return 1;
198 }
199 
200 /* Parse X.X.X cisco style ethernet address. */
201 static uword
203 {
204  u8 *result = va_arg (*args, u8 *);
205  u32 i, a[3];
206 
207  if (!unformat (input, "%_%x.%x.%x%_", &a[0], &a[1], &a[2]))
208  return 0;
209 
210  /* Check range. */
211  for (i = 0; i < ARRAY_LEN (a); i++)
212  if (a[i] >= (1 << 16))
213  return 0;
214 
215  result[0] = (a[0] >> 8) & 0xff;
216  result[1] = (a[0] >> 0) & 0xff;
217  result[2] = (a[1] >> 8) & 0xff;
218  result[3] = (a[1] >> 0) & 0xff;
219  result[4] = (a[2] >> 8) & 0xff;
220  result[5] = (a[2] >> 0) & 0xff;
221 
222  return 1;
223 }
224 
225 /* Parse ethernet address; accept either unix or style addresses. */
226 uword
228 {
229  u8 *result = va_arg (*args, u8 *);
230  return (unformat_user (input, unformat_ethernet_address_unix, result)
231  || unformat_user (input, unformat_ethernet_address_cisco, result));
232 }
233 
234 /* Returns ethernet type as an int in host byte order. */
235 uword
237  va_list * args)
238 {
239  u16 *result = va_arg (*args, u16 *);
241  int type, i;
242 
243  /* Numeric type. */
244  if (unformat (input, "0x%x", &type) || unformat (input, "%d", &type))
245  {
246  if (type >= (1 << 16))
247  return 0;
248  *result = type;
249  return 1;
250  }
251 
252  /* Named type. */
254  em->type_info_by_name, &i))
255  {
257  *result = ti->type;
258  return 1;
259  }
260 
261  return 0;
262 }
263 
264 uword
266  va_list * args)
267 {
268  u16 *result = va_arg (*args, u16 *);
270  return 0;
271 
272  *result = clib_host_to_net_u16 ((u16) * result);
273  return 1;
274 }
275 
276 uword
278 {
279  u8 **result = va_arg (*args, u8 **);
280  ethernet_max_header_t _m, *m = &_m;
281  ethernet_header_t *e = &m->ethernet;
282  u16 type;
283  u32 n_vlan;
284 
285  if (!unformat (input, "%U: %U -> %U",
289  return 0;
290 
291  n_vlan = 0;
292  while (unformat (input, "vlan"))
293  {
294  u32 id, priority;
295 
296  if (!unformat_user (input, unformat_vlib_number, &id)
297  || id >= ETHERNET_N_VLAN)
298  return 0;
299 
300  if (unformat (input, "priority %d", &priority))
301  {
302  if (priority >= 8)
303  return 0;
304  id |= priority << 13;
305  }
306 
307  if (unformat (input, "cfi"))
308  id |= 1 << 12;
309 
310  /* Too many vlans given. */
311  if (n_vlan >= ARRAY_LEN (m->vlan))
312  return 0;
313 
314  m->vlan[n_vlan].priority_cfi_and_id = clib_host_to_net_u16 (id);
315  n_vlan++;
316  }
317 
318  if (n_vlan == 0)
319  e->type = clib_host_to_net_u16 (type);
320  else
321  {
322  int i;
323 
324  e->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
325  for (i = 0; i < n_vlan - 1; i++)
326  m->vlan[i].type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
327  m->vlan[n_vlan - 1].type = clib_host_to_net_u16 (type);
328  }
329 
330  /* Add header to result. */
331  {
332  void *p;
333  u32 n_bytes = sizeof (e[0]) + n_vlan * sizeof (m->vlan[0]);
334 
335  vec_add2 (*result, p, n_bytes);
336  clib_memcpy (p, m, n_bytes);
337  }
338 
339  return 1;
340 }
341 
342 /*
343  * fd.io coding-style-patch-verification: ON
344  *
345  * Local Variables:
346  * eval: (c-set-style "gnu")
347  * End:
348  */
#define ETHERNET_N_VLAN
Definition: packet.h:133
a
Definition: bitmap.h:516
vlib_main_t * vlib_main
Definition: ethernet.h:265
ethernet_type_t
Definition: packet.h:45
u8 src_address[6]
Definition: packet.h:56
uword unformat_ethernet_type_net_byte_order(unformat_input_t *input, va_list *args)
Definition: format.c:265
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:559
int i
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
static u32 format_get_indent(u8 *s)
Definition: format.h:72
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
uword * type_info_by_name
Definition: ethernet.h:283
uword unformat_vlib_number(unformat_input_t *input, va_list *args)
Definition: format.c:148
ethernet_main_t ethernet_main
Definition: init.c:45
u8 dst_address[6]
Definition: packet.h:55
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:113
u8 * format_ethernet_header(u8 *s, va_list *args)
Definition: format.c:172
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
u8 * format_ethernet_header_with_length(u8 *s, va_list *args)
Definition: format.c:91
int format_ethernet_address_16bit
Definition: ethernet.h:296
static ethernet_type_info_t * ethernet_get_type_info(ethernet_main_t *em, ethernet_type_t type)
Definition: ethernet.h:311
#define v
Definition: acl.c:495
struct _unformat_input_t unformat_input_t
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:180
#define clib_memcpy(a, b, c)
Definition: string.h:75
ethernet_vlan_header_t vlan[2]
Definition: ethernet.h:131
#define ARRAY_LEN(x)
Definition: clib.h:59
unsigned int u32
Definition: types.h:88
ethernet_type_t type
Definition: ethernet.h:173
uword unformat_vlib_number_by_name(unformat_input_t *input, va_list *args)
Definition: format.c:157
u64 uword
Definition: types.h:112
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
static uword unformat_ethernet_address_cisco(unformat_input_t *input, va_list *args)
Definition: format.c:202
ethernet_header_t ethernet
Definition: ethernet.h:128
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
uword unformat_ethernet_address(unformat_input_t *input, va_list *args)
Definition: format.c:227
u8 * format_ethernet_type(u8 *s, va_list *args)
Definition: format.c:58
uword unformat_ethernet_type_host_byte_order(unformat_input_t *input, va_list *args)
Definition: format.c:236
uword unformat_ethernet_header(unformat_input_t *input, va_list *args)
Definition: format.c:277
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
u8 * format_ethernet_address(u8 *s, va_list *args)
Definition: format.c:44
u8 * format_ethernet_vlan_tci(u8 *s, va_list *va)
Definition: format.c:73
ethernet_type_info_t * type_infos
Definition: ethernet.h:280