FD.io VPP  v17.07-30-g839fa73
Vector Packet Processing
mpls.c
Go to the documentation of this file.
1 /*
2  * mpls.c: mpls
3  *
4  * Copyright (c) 2012 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #include <vnet/vnet.h>
19 #include <vnet/mpls/mpls.h>
20 #include <vnet/fib/ip4_fib.h>
21 #include <vnet/fib/mpls_fib.h>
22 
23 const static char* mpls_eos_bit_names[] = MPLS_EOS_BITS;
24 
26 
27 u8 * format_mpls_unicast_label (u8 * s, va_list * args)
28 {
29  mpls_label_t label = va_arg (*args, mpls_label_t);
30 
31  switch (label) {
34  break;
37  break;
40  break;
43  break;
45  s = format (s, "%s", MPLS_IETF_ELI_STRING);
46  break;
48  s = format (s, "%s", MPLS_IETF_GAL_STRING);
49  break;
50  default:
51  s = format (s, "%d", label);
52  break;
53  }
54  return s;
55 }
56 
58 {
59  mpls_label_t *label = va_arg (*args, mpls_label_t*);
60 
65  else if (unformat (input, MPLS_IETF_ROUTER_ALERT_STRING))
67  else if (unformat (input, MPLS_IETF_IMPLICIT_NULL_STRING))
69  else if (unformat (input, "%d", label))
70  ;
71 
72  return (1);
73 }
74 
75 u8 * format_mpls_eos_bit (u8 * s, va_list * args)
76 {
77  mpls_eos_bit_t eb = va_arg (*args, mpls_eos_bit_t);
78 
79  ASSERT(eb <= MPLS_EOS);
80 
81  s = format(s, "%s", mpls_eos_bit_names[eb]);
82 
83  return (s);
84 }
85 
86 u8 * format_mpls_header (u8 * s, va_list * args)
87 {
88  mpls_unicast_header_t hdr = va_arg (*args, mpls_unicast_header_t);
89 
90  return (format(s, "[%U:%d:%d:%U]",
97 }
98 
99 uword
100 unformat_mpls_header (unformat_input_t * input, va_list * args)
101 {
102  u8 ** result = va_arg (*args, u8 **);
103  mpls_unicast_header_t _h, * h = &_h;
104  u32 label, label_exp_s_ttl;
105 
106  if (! unformat (input, "MPLS %d", &label))
107  return 0;
108 
109  label_exp_s_ttl = (label<<12) | (1<<8) /* s-bit */ | 0xFF;
110  h->label_exp_s_ttl = clib_host_to_net_u32 (label_exp_s_ttl);
111 
112  /* Add gre, mpls headers to result. */
113  {
114  void * p;
115  u32 h_n_bytes = sizeof (h[0]);
116 
117  vec_add2 (*result, p, h_n_bytes);
118  clib_memcpy (p, h, h_n_bytes);
119  }
120 
121  return 1;
122 }
123 
124 uword
126  va_list * args)
127 {
128  u32 * result = va_arg (*args, u32 *);
129  u32 label;
130 
131  if (!unformat (input, "MPLS: label %d", &label))
132  return 0;
133 
134  label = (label<<12) | (1<<8) /* s-bit set */ | 0xFF /* ttl */;
135 
136  *result = clib_host_to_net_u32 (label);
137  return 1;
138 }
139 
141 {
142  mpls_unicast_header_t *h = va_arg(*args, mpls_unicast_header_t *);
143  u32 label = h->label_exp_s_ttl;
144 
145  s = format (s, "label %d exp %d, s %d, ttl %d",
146  vnet_mpls_uc_get_label (label),
147  vnet_mpls_uc_get_exp (label),
148  vnet_mpls_uc_get_s (label),
149  vnet_mpls_uc_get_ttl (label));
150  return s;
151 }
152 
154 {
155  mpls_unicast_header_t *h = va_arg(*args, mpls_unicast_header_t *);
156  mpls_unicast_header_t h_host;
157 
158  h_host.label_exp_s_ttl = clib_net_to_host_u32 (h->label_exp_s_ttl);
159 
161  &h_host);
162 }
163 
164 typedef struct {
171 
172 int
173 mpls_dest_cmp(void * a1, void * a2)
174 {
175  show_mpls_fib_t * r1 = a1;
176  show_mpls_fib_t * r2 = a2;
177 
178  return clib_net_to_host_u32(r1->dest) - clib_net_to_host_u32(r2->dest);
179 }
180 
181 int
182 mpls_fib_index_cmp(void * a1, void * a2)
183 {
184  show_mpls_fib_t * r1 = a1;
185  show_mpls_fib_t * r2 = a2;
186 
187  return r1->fib_index - r2->fib_index;
188 }
189 
190 int
191 mpls_label_cmp(void * a1, void * a2)
192 {
193  show_mpls_fib_t * r1 = a1;
194  show_mpls_fib_t * r2 = a2;
195 
196  return r1->label - r2->label;
197 }
198 
199 static clib_error_t *
201  unformat_input_t * input,
202  vlib_cli_command_t * cmd)
203 {
204  unformat_input_t _line_input, * line_input = &_line_input;
205  fib_route_path_t *rpaths = NULL, rpath;
206  u32 table_id, is_del, is_ip;
207  mpls_label_t local_label;
208  mpls_label_t out_label;
209  clib_error_t * error;
210  mpls_eos_bit_t eos;
211  vnet_main_t * vnm;
212  fib_prefix_t pfx;
213 
214  vnm = vnet_get_main();
215  error = NULL;
216  is_ip = 0;
217  table_id = 0;
218  eos = MPLS_EOS;
219  is_del = 0;
220  local_label = MPLS_LABEL_INVALID;
221  memset(&pfx, 0, sizeof(pfx));
222 
223  /* Get a line of input. */
224  if (! unformat_user (input, unformat_line_input, line_input))
225  return 0;
226 
227  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
228  {
229  memset(&rpath, 0, sizeof(rpath));
230 
231  if (unformat (line_input, "table %d", &table_id))
232  ;
233  else if (unformat (line_input, "del"))
234  is_del = 1;
235  else if (unformat (line_input, "add"))
236  is_del = 0;
237  else if (unformat (line_input, "eos"))
238  pfx.fp_eos = MPLS_EOS;
239  else if (unformat (line_input, "non-eos"))
240  pfx.fp_eos = MPLS_NON_EOS;
241  else if (unformat (line_input, "%U/%d",
243  &pfx.fp_addr.ip4,
244  &pfx.fp_len))
245  {
247  is_ip = 1;
248  }
249  else if (unformat (line_input, "%U/%d",
251  &pfx.fp_addr.ip6,
252  &pfx.fp_len))
253  {
255  is_ip = 1;
256  }
257  else if (unformat (line_input, "via %U %U weight %u",
259  &rpath.frp_addr.ip4,
261  &rpath.frp_sw_if_index,
262  &rpath.frp_weight))
263  {
264  rpath.frp_proto = FIB_PROTOCOL_IP4;
265  vec_add1(rpaths, rpath);
266  }
267 
268  else if (unformat (line_input, "via %U %U weight %u",
270  &rpath.frp_addr.ip6,
272  &rpath.frp_sw_if_index,
273  &rpath.frp_weight))
274  {
275  rpath.frp_proto = FIB_PROTOCOL_IP6;
276  vec_add1(rpaths, rpath);
277  }
278 
279  else if (unformat (line_input, "via %U %U",
281  &rpath.frp_addr.ip4,
283  &rpath.frp_sw_if_index))
284  {
285  rpath.frp_weight = 1;
286  rpath.frp_proto = FIB_PROTOCOL_IP4;
287  vec_add1(rpaths, rpath);
288  }
289  else if (unformat (line_input, "rx-ip4 %U",
291  &rpath.frp_sw_if_index))
292  {
293  rpath.frp_weight = 1;
294  rpath.frp_proto = FIB_PROTOCOL_IP4;
295  rpath.frp_flags = FIB_ROUTE_PATH_INTF_RX;
296  vec_add1(rpaths, rpath);
297  }
298  else if (unformat (line_input, "via %U %U",
300  &rpath.frp_addr.ip6,
302  &rpath.frp_sw_if_index))
303  {
304  rpath.frp_weight = 1;
305  rpath.frp_proto = FIB_PROTOCOL_IP6;
306  vec_add1(rpaths, rpath);
307  }
308  else if (unformat (line_input, "via %U next-hop-table %d",
310  &rpath.frp_addr.ip4,
311  &rpath.frp_fib_index))
312  {
313  rpath.frp_weight = 1;
314  rpath.frp_sw_if_index = ~0;
315  rpath.frp_proto = FIB_PROTOCOL_IP4;
316  vec_add1(rpaths, rpath);
317  }
318  else if (unformat (line_input, "via %U next-hop-table %d",
320  &rpath.frp_addr.ip6,
321  &rpath.frp_fib_index))
322  {
323  rpath.frp_weight = 1;
324  rpath.frp_sw_if_index = ~0;
325  rpath.frp_proto = FIB_PROTOCOL_IP6;
326  vec_add1(rpaths, rpath);
327  }
328  else if (unformat (line_input, "via %U",
330  &rpath.frp_addr.ip4))
331  {
332  /*
333  * the recursive next-hops are by default in the same table
334  * as the prefix
335  */
336  rpath.frp_fib_index = table_id;
337  rpath.frp_weight = 1;
338  rpath.frp_sw_if_index = ~0;
339  rpath.frp_proto = FIB_PROTOCOL_IP4;
340  vec_add1(rpaths, rpath);
341  }
342  else if (unformat (line_input, "via %U",
344  &rpath.frp_addr.ip6))
345  {
346  rpath.frp_fib_index = table_id;
347  rpath.frp_weight = 1;
348  rpath.frp_sw_if_index = ~0;
349  rpath.frp_proto = FIB_PROTOCOL_IP6;
350  vec_add1(rpaths, rpath);
351  }
352  else if (unformat (line_input, "%d", &local_label))
353  ;
354  else if (unformat (line_input,
355  "ip4-lookup-in-table %d",
356  &rpath.frp_fib_index))
357  {
358  rpath.frp_proto = FIB_PROTOCOL_IP4;
359  rpath.frp_sw_if_index = FIB_NODE_INDEX_INVALID;
361  vec_add1(rpaths, rpath);
362  }
363  else if (unformat (line_input,
364  "ip6-lookup-in-table %d",
365  &rpath.frp_fib_index))
366  {
367  rpath.frp_proto = FIB_PROTOCOL_IP6;
368  rpath.frp_sw_if_index = FIB_NODE_INDEX_INVALID;
369  vec_add1(rpaths, rpath);
371  }
372  else if (unformat (line_input,
373  "mpls-lookup-in-table %d",
374  &rpath.frp_fib_index))
375  {
376  rpath.frp_proto = FIB_PROTOCOL_MPLS;
377  rpath.frp_sw_if_index = FIB_NODE_INDEX_INVALID;
379  vec_add1(rpaths, rpath);
380  }
381  else if (unformat (line_input, "out-label %U",
383  &out_label))
384  {
385  if (vec_len(rpaths) == 0)
386  {
387  error = clib_error_return(0 , "Paths then labels");
388  goto done;
389  }
390  vec_add1(rpaths[vec_len(rpaths)-1].frp_label_stack, out_label);
391  }
392  else
393  {
394  error = clib_error_return (0, "unkown input: %U",
395  format_unformat_error, line_input);
396  goto done;
397  }
398 
399  }
400 
401  if (MPLS_LABEL_INVALID == local_label)
402  {
403  error = clib_error_return (0, "local-label required: %U",
404  format_unformat_error, input);
405  goto done;
406  }
407 
408 
409  if (is_ip)
410  {
411  u32 fib_index = fib_table_find(pfx.fp_proto, table_id);
412 
413  if (FIB_NODE_INDEX_INVALID == fib_index)
414  {
415  error = clib_error_return (0, "%U table-id %d does not exist",
416  format_fib_protocol, pfx.fp_proto, table_id);
417  goto done;
418  }
419 
420  if (is_del)
421  {
422  fib_table_entry_local_label_remove(fib_index, &pfx, local_label);
423  }
424  else
425  {
426  fib_table_entry_local_label_add(fib_index, &pfx, local_label);
427  }
428  }
429  else
430  {
431  fib_node_index_t fib_index;
432  u32 fi;
433 
434  if (NULL == rpaths)
435  {
436  error = clib_error_return(0 , "no paths");
437  goto done;
438  }
439 
441  pfx.fp_len = 21;
442  pfx.fp_label = local_label;
443  pfx.fp_payload_proto = fib_proto_to_dpo(rpaths[0].frp_proto);
444 
445  /*
446  * the CLI parsing stored table Ids, swap to FIB indicies
447  */
448  if (FIB_NODE_INDEX_INVALID == rpath.frp_sw_if_index)
449  {
451  rpaths[0].frp_fib_index);
452 
453  if (~0 == fi)
454  {
455  error = clib_error_return(0 , "%U Via table %d does not exist",
457  rpaths[0].frp_fib_index);
458  goto done;
459  }
460  rpaths[0].frp_fib_index = fi;
461  }
462 
463  fib_index = mpls_fib_index_from_table_id(table_id);
464 
465  if (FIB_NODE_INDEX_INVALID == fib_index)
466  {
467  error = clib_error_return (0, "MPLS table-id %d does not exist",
468  table_id);
469  goto done;
470  }
471 
472  if (is_del)
473  {
475  &pfx,
477  rpaths);
478  }
479  else
480  {
481  fib_node_index_t lfe;
482 
483  lfe = fib_table_entry_path_add2(fib_index,
484  &pfx,
487  rpaths);
488 
489  if (FIB_NODE_INDEX_INVALID == lfe)
490  {
491  error = clib_error_return (0, "Failed to create %U-%U in MPLS table-id %d",
492  format_mpls_unicast_label, local_label,
493  format_mpls_eos_bit, eos,
494  table_id);
495  goto done;
496  }
497  }
498  }
499 
500 done:
501  unformat_free (line_input);
502 
503  return error;
504 }
505 
506 VLIB_CLI_COMMAND (mpls_local_label_command, static) = {
507  .path = "mpls local-label",
508  .function = vnet_mpls_local_label,
509  .short_help = "Create/Delete MPL local labels",
510 };
511 
512 int
514 {
515  // FIXME
516  return 0;
517 }
518 
519 static clib_error_t *
521 {
522  mpls_main_t * mm = &mpls_main;
523  clib_error_t * error;
524 
525  mm->vlib_main = vm;
526  mm->vnet_main = vnet_get_main();
527 
528  if ((error = vlib_call_init_function (vm, ip_main_init)))
529  return error;
530 
532 }
533 
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:169
uword unformat_mpls_unicast_label(unformat_input_t *input, va_list *args)
Definition: mpls.c:57
A representation of a path as described by a route producer.
Definition: fib_types.h:336
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
#define NULL
Definition: clib.h:55
fib_node_index_t fib_table_entry_path_add2(u32 fib_index, const fib_prefix_t *prefix, fib_source_t source, fib_entry_flag_t flags, fib_route_path_t *rpath)
Add n paths to an entry (aka route) in the FIB.
Definition: fib_table.c:538
u32 mpls_label_t
A label value only, i.e.
Definition: packet.h:24
#define MPLS_IETF_IMPLICIT_NULL_LABEL
Definition: mpls_types.h:30
From the CLI.
Definition: fib_entry.h:66
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:522
#define MPLS_IETF_ROUTER_ALERT_LABEL
Definition: mpls_types.h:28
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:561
u8 * format_mpls_unicast_label(u8 *s, va_list *args)
Definition: mpls.c:27
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
u8 * format_mpls_unicast_header_host_byte_order(u8 *s, va_list *args)
Definition: mpls.c:140
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
unformat_function_t unformat_vnet_sw_interface
int mpls_dest_cmp(void *a1, void *a2)
Definition: mpls.c:173
A path that result in received traffic being recieved/recirculated so that it appears to have arrived...
Definition: fib_types.h:301
void fib_table_entry_local_label_remove(u32 fib_index, const fib_prefix_t *prefix, mpls_label_t label)
remove a MPLS local label for the prefix/route.
Definition: fib_table.c:897
dpo_proto_t fp_payload_proto
This protocol determines the payload protocol of packets that will be forwarded by this entry once th...
Definition: fib_types.h:193
unformat_function_t unformat_ip4_address
Definition: format.h:76
#define MPLS_IETF_ROUTER_ALERT_STRING
Definition: mpls_types.h:39
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
int mpls_fib_reset_labels(u32 fib_id)
Definition: mpls.c:513
Aggregrate type for a prefix.
Definition: fib_types.h:160
#define clib_error_return(e, args...)
Definition: error.h:99
static const char * mpls_eos_bit_names[]
Definition: mpls.c:23
static u32 vnet_mpls_uc_get_ttl(mpls_label_t label_exp_s_ttl)
Definition: packet.h:92
#define MPLS_EOS_BITS
Definition: packet.h:40
u32 fib_table_find(fib_protocol_t proto, u32 table_id)
Get the index of the FIB for a Table-ID.
Definition: fib_table.c:1025
fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto)
Definition: fib_types.c:227
u16 fp_len
The mask length.
Definition: fib_types.h:164
#define vlib_call_init_function(vm, x)
Definition: init.h:162
Definition: fib_entry.h:233
unformat_function_t unformat_line_input
Definition: format.h:281
#define MPLS_IETF_GAL_STRING
Definition: mpls_types.h:45
#define MPLS_IETF_ELI_LABEL
Definition: mpls_types.h:31
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:183
u32 entry_index
Definition: mpls.c:166
struct _unformat_input_t unformat_input_t
void fib_table_entry_path_remove2(u32 fib_index, const fib_prefix_t *prefix, fib_source_t source, fib_route_path_t *rpath)
Remove n paths to an entry (aka route) in the FIB.
Definition: fib_table.c:582
static u32 vnet_mpls_uc_get_label(mpls_label_t label_exp_s_ttl)
Definition: packet.h:77
vnet_main_t * vnet_main
Definition: mpls.h:62
uword unformat_mpls_header(unformat_input_t *input, va_list *args)
Definition: mpls.c:100
#define MPLS_IETF_IPV4_EXPLICIT_NULL_STRING
Definition: mpls_types.h:35
unformat_function_t unformat_ip6_address
Definition: format.h:94
clib_error_t * ip_main_init(vlib_main_t *vm)
Definition: ip_init.c:45
#define UNFORMAT_END_OF_INPUT
Definition: format.h:143
fib_node_index_t fib_table_entry_local_label_add(u32 fib_index, const fib_prefix_t *prefix, mpls_label_t label)
Add a MPLS local label for the prefix/route.
Definition: fib_table.c:870
mpls_main_t mpls_main
Definition: mpls.c:25
#define MPLS_LABEL_INVALID
Definition: mpls_types.h:48
#define MPLS_IETF_IPV4_EXPLICIT_NULL_LABEL
Definition: mpls_types.h:27
#define clib_memcpy(a, b, c)
Definition: string.h:69
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:28
u32 mpls_fib_index_from_table_id(u32 table_id)
Definition: mpls_fib.c:73
mpls_label_t fp_label
Definition: fib_types.h:186
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
static clib_error_t * mpls_input_init(vlib_main_t *vm)
Definition: mpls_input.c:298
u32 fib_index
Definition: mpls.c:165
#define MPLS_IETF_IPV6_EXPLICIT_NULL_STRING
Definition: mpls_types.h:41
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
static clib_error_t * vnet_mpls_local_label(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: mpls.c:200
#define MPLS_IETF_GAL_LABEL
Definition: mpls_types.h:32
uword unformat_mpls_label_net_byte_order(unformat_input_t *input, va_list *args)
Definition: mpls.c:125
#define MPLS_IETF_ELI_STRING
Definition: mpls_types.h:43
mpls_label_t label_exp_s_ttl
Definition: packet.h:31
dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto)
Definition: fib_types.c:211
#define MPLS_IETF_IMPLICIT_NULL_STRING
Definition: mpls_types.h:37
u8 * format_fib_protocol(u8 *s, va_list ap)
Definition: fib_types.c:30
u64 uword
Definition: types.h:112
static clib_error_t * mpls_init(vlib_main_t *vm)
Definition: mpls.c:520
u8 * format_mpls_unicast_header_net_byte_order(u8 *s, va_list *args)
Definition: mpls.c:153
#define FIB_NODE_INDEX_INVALID
Definition: fib_types.h:29
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static u32 vnet_mpls_uc_get_s(mpls_label_t label_exp_s_ttl)
Definition: packet.h:87
unsigned char u8
Definition: types.h:56
static void unformat_free(unformat_input_t *i)
Definition: format.h:161
#define MPLS_IETF_IPV6_EXPLICIT_NULL_LABEL
Definition: mpls_types.h:29
u8 * format_dpo_proto(u8 *s, va_list *args)
format a DPO protocol
Definition: dpo.c:151
vlib_main_t * vlib_main
Definition: mpls.h:61
u8 * format_mpls_eos_bit(u8 *s, va_list *args)
Definition: mpls.c:75
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
int mpls_label_cmp(void *a1, void *a2)
Definition: mpls.c:191
static u32 vnet_mpls_uc_get_exp(mpls_label_t label_exp_s_ttl)
Definition: packet.h:82
u32 frp_fib_index
The FIB index to lookup the nexthop Only valid for recursive paths.
Definition: fib_types.h:379
int mpls_fib_index_cmp(void *a1, void *a2)
Definition: mpls.c:182
u8 * format_mpls_header(u8 *s, va_list *args)
Definition: mpls.c:86
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:169
mpls_eos_bit_t fp_eos
Definition: fib_types.h:187
enum mpls_eos_bit_t_ mpls_eos_bit_t