src/vnet/udp/udp_encap.c

   1 /*
   2  * Copyright (c) 2017-2019 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 #include <vnet/udp/udp_encap.h>
  17 #include <vnet/fib/fib_entry.h>
  18 #include <vnet/fib/fib_entry_track.h>
  19 #include <vnet/fib/fib_table.h>
  20 #include <vnet/dpo/drop_dpo.h>
  21
  22 /**
  23  * Registered DPO types for the IP header encapsulated, v4 or v6.
  24  */
  25 dpo_type_t udp_encap_dpo_types[FIB_PROTOCOL_MAX];
  26
  27 /**
  28  * Pool of encaps
  29  */
  30 udp_encap_t *udp_encap_pool;
  31
  32 /**
  33  * Stats for each UDP encap object
  34  */
  35 vlib_combined_counter_main_t udp_encap_counters = {
  36   /**
  37    * The counter collection's name.
  38    */
  39   .name = "udp-encap",
  40   /**
  41    * Name in stat segment directory
  42    */
  43   .stat_segment_name = "/net/udp-encap",
  44 };
  45
  46 static void
  47 udp_encap_restack (udp_encap_t * ue)
  48 {
  49   dpo_stack (udp_encap_dpo_types[ue->ue_ip_proto],
  50              fib_proto_to_dpo (ue->ue_ip_proto), &ue->ue_dpo,
  51              fib_entry_contribute_ip_forwarding (ue->ue_fib_entry_index));
  52 }
  53
  54 index_t
  55 udp_encap_add_and_lock (fib_protocol_t proto,
  56                         index_t fib_index,
  57                         const ip46_address_t * src_ip,
  58                         const ip46_address_t * dst_ip,
  59                         u16 src_port,
  60                         u16 dst_port, udp_encap_fixup_flags_t flags)
  61 {
  62   udp_encap_t *ue;
  63   u8 pfx_len = 0;
  64   index_t uei;
  65
  66   pool_get_aligned_zero (udp_encap_pool, ue, CLIB_CACHE_LINE_BYTES);
  67   uei = ue - udp_encap_pool;
  68
  69   vlib_validate_combined_counter (&(udp_encap_counters), uei);
  70   vlib_zero_combined_counter (&(udp_encap_counters), uei);
  71
  72   fib_node_init (&ue->ue_fib_node, FIB_NODE_TYPE_UDP_ENCAP);
  73   fib_node_lock (&ue->ue_fib_node);
  74   ue->ue_fib_index = fib_index;
  75   ue->ue_flags = flags;
  76   ue->ue_ip_proto = proto;
  77
  78   switch (proto)
  79     {
  80     case FIB_PROTOCOL_IP4:
  81       pfx_len = 32;
  82       ue->ue_hdrs.ip4.ue_ip4.ip_version_and_header_length = 0x45;
  83       ue->ue_hdrs.ip4.ue_ip4.ttl = 254;
  84       ue->ue_hdrs.ip4.ue_ip4.protocol = IP_PROTOCOL_UDP;
  85       ue->ue_hdrs.ip4.ue_ip4.src_address.as_u32 = src_ip->ip4.as_u32;
  86       ue->ue_hdrs.ip4.ue_ip4.dst_address.as_u32 = dst_ip->ip4.as_u32;
  87       ue->ue_hdrs.ip4.ue_ip4.checksum =
  88         ip4_header_checksum (&ue->ue_hdrs.ip4.ue_ip4);
  89       ue->ue_hdrs.ip4.ue_udp.src_port = clib_host_to_net_u16 (src_port);
  90       ue->ue_hdrs.ip4.ue_udp.dst_port = clib_host_to_net_u16 (dst_port);
  91
  92       break;
  93     case FIB_PROTOCOL_IP6:
  94       pfx_len = 128;
  95       ue->ue_hdrs.ip6.ue_ip6.ip_version_traffic_class_and_flow_label =
  96         clib_host_to_net_u32 (6 << 28);
  97       ue->ue_hdrs.ip6.ue_ip6.hop_limit = 255;
  98       ue->ue_hdrs.ip6.ue_ip6.protocol = IP_PROTOCOL_UDP;
  99       ue->ue_hdrs.ip6.ue_ip6.src_address.as_u64[0] = src_ip->ip6.as_u64[0];
 100       ue->ue_hdrs.ip6.ue_ip6.src_address.as_u64[1] = src_ip->ip6.as_u64[1];
 101       ue->ue_hdrs.ip6.ue_ip6.dst_address.as_u64[0] = dst_ip->ip6.as_u64[0];
 102       ue->ue_hdrs.ip6.ue_ip6.dst_address.as_u64[1] = dst_ip->ip6.as_u64[1];
 103       ue->ue_hdrs.ip6.ue_udp.src_port = clib_host_to_net_u16 (src_port);
 104       ue->ue_hdrs.ip6.ue_udp.dst_port = clib_host_to_net_u16 (dst_port);
 105
 106       break;
 107     default:
 108       ASSERT (0);
 109     }
 110
 111   /*
 112    * track the destination address
 113    */
 114   fib_prefix_t dst_pfx = {
 115     .fp_proto = proto,
 116     .fp_len = pfx_len,
 117     .fp_addr = *dst_ip,
 118   };
 119
 120   ue->ue_fib_entry_index = fib_entry_track (fib_index,
 121                                             &dst_pfx,
 122                                             FIB_NODE_TYPE_UDP_ENCAP,
 123                                             uei, &ue->ue_fib_sibling);
 124   udp_encap_restack (ue);
 125
 126   return (uei);
 127 }
 128
 129 void
 130 udp_encap_contribute_forwarding (index_t uei, dpo_proto_t proto,
 131                                  dpo_id_t * dpo)
 132 {
 133   if (INDEX_INVALID == uei)
 134     {
 135       dpo_copy (dpo, drop_dpo_get (proto));
 136     }
 137   else
 138     {
 139       udp_encap_t *ue;
 140
 141       ue = udp_encap_get (uei);
 142
 143       dpo_set (dpo, udp_encap_dpo_types[ue->ue_ip_proto], proto, uei);
 144     }
 145 }
 146
 147 void
 148 udp_encap_lock (index_t uei)
 149 {
 150   udp_encap_t *ue;
 151
 152   ue = udp_encap_get (uei);
 153
 154   if (NULL != ue)
 155     {
 156       fib_node_lock (&ue->ue_fib_node);
 157     }
 158 }
 159
 160 void
 161 udp_encap_unlock (index_t uei)
 162 {
 163   udp_encap_t *ue;
 164
 165   if (INDEX_INVALID == uei)
 166     {
 167       return;
 168     }
 169
 170   ue = udp_encap_get (uei);
 171
 172   if (NULL != ue)
 173     {
 174       fib_node_unlock (&ue->ue_fib_node);
 175     }
 176 }
 177
 178 static void
 179 udp_encap_dpo_lock (dpo_id_t * dpo)
 180 {
 181   udp_encap_t *ue;
 182
 183   ue = udp_encap_get (dpo->dpoi_index);
 184
 185   fib_node_lock (&ue->ue_fib_node);
 186 }
 187
 188 static void
 189 udp_encap_dpo_unlock (dpo_id_t * dpo)
 190 {
 191   udp_encap_t *ue;
 192
 193   ue = udp_encap_get (dpo->dpoi_index);
 194
 195   fib_node_unlock (&ue->ue_fib_node);
 196 }
 197
 198 static u8 *
 199 format_udp_encap_i (u8 * s, va_list * args)
 200 {
 201   index_t uei = va_arg (*args, index_t);
 202   u32 indent = va_arg (*args, u32);
 203   u32 details = va_arg (*args, u32);
 204   vlib_counter_t to;
 205   udp_encap_t *ue;
 206
 207   ue = udp_encap_get (uei);
 208
 209   // FIXME
 210   s = format (s, "udp-encap:[%d]: ip-fib-index:%d ", uei, ue->ue_fib_index);
 211   if (FIB_PROTOCOL_IP4 == ue->ue_ip_proto)
 212     {
 213       s = format (s, "ip:[src:%U, dst:%U] udp:[src:%d, dst:%d]",
 214                   format_ip4_address,
 215                   &ue->ue_hdrs.ip4.ue_ip4.src_address,
 216                   format_ip4_address,
 217                   &ue->ue_hdrs.ip4.ue_ip4.dst_address,
 218                   clib_net_to_host_u16 (ue->ue_hdrs.ip4.ue_udp.src_port),
 219                   clib_net_to_host_u16 (ue->ue_hdrs.ip4.ue_udp.dst_port));
 220     }
 221   else
 222     {
 223       s = format (s, "ip:[src:%U, dst:%U] udp:[src:%d dst:%d]",
 224                   format_ip6_address,
 225                   &ue->ue_hdrs.ip6.ue_ip6.src_address,
 226                   format_ip6_address,
 227                   &ue->ue_hdrs.ip6.ue_ip6.dst_address,
 228                   clib_net_to_host_u16 (ue->ue_hdrs.ip6.ue_udp.src_port),
 229                   clib_net_to_host_u16 (ue->ue_hdrs.ip6.ue_udp.dst_port));
 230     }
 231   vlib_get_combined_counter (&(udp_encap_counters), uei, &to);
 232   s = format (s, " to:[%Ld:%Ld]]", to.packets, to.bytes);
 233
 234   if (details)
 235     {
 236       s = format (s, " locks:%d", ue->ue_fib_node.fn_locks);
 237       s = format (s, "\n%UStacked on:", format_white_space, indent + 1);
 238       s = format (s, "\n%U%U",
 239                   format_white_space, indent + 2,
 240                   format_dpo_id, &ue->ue_dpo, indent + 3);
 241     }
 242   return (s);
 243 }
 244
 245 void
 246 udp_encap_get_stats (index_t uei, u64 * packets, u64 * bytes)
 247 {
 248   vlib_counter_t to;
 249
 250   vlib_get_combined_counter (&(udp_encap_counters), uei, &to);
 251
 252   *packets = to.packets;
 253   *bytes = to.bytes;
 254 }
 255
 256 static u8 *
 257 format_udp_encap_dpo (u8 * s, va_list * args)
 258 {
 259   index_t uei = va_arg (*args, index_t);
 260   u32 indent = va_arg (*args, u32);
 261
 262   return (format (s, "%U", format_udp_encap_i, uei, indent, 1));
 263 }
 264
 265 u8 *
 266 format_udp_encap (u8 * s, va_list * args)
 267 {
 268   index_t uei = va_arg (*args, u32);
 269   u32 details = va_arg (*args, u32);
 270
 271   return (format (s, "%U", format_udp_encap_i, uei, 0, details));
 272 }
 273
 274 static udp_encap_t *
 275 udp_encap_from_fib_node (fib_node_t * node)
 276 {
 277   ASSERT (FIB_NODE_TYPE_UDP_ENCAP == node->fn_type);
 278   return ((udp_encap_t *) (((char *) node) -
 279                            STRUCT_OFFSET_OF (udp_encap_t, ue_fib_node)));
 280 }
 281
 282 /**
 283  * Function definition to backwalk a FIB node
 284  */
 285 static fib_node_back_walk_rc_t
 286 udp_encap_fib_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
 287 {
 288   udp_encap_restack (udp_encap_from_fib_node (node));
 289
 290   return (FIB_NODE_BACK_WALK_CONTINUE);
 291 }
 292
 293 /**
 294  * Function definition to get a FIB node from its index
 295  */
 296 static fib_node_t *
 297 udp_encap_fib_node_get (fib_node_index_t index)
 298 {
 299   udp_encap_t *ue;
 300
 301   ue = pool_elt_at_index (udp_encap_pool, index);
 302
 303   return (&ue->ue_fib_node);
 304 }
 305
 306 /**
 307  * Function definition to inform the FIB node that its last lock has gone.
 308  */
 309 static void
 310 udp_encap_fib_last_lock_gone (fib_node_t * node)
 311 {
 312   udp_encap_t *ue;
 313
 314   ue = udp_encap_from_fib_node (node);
 315
 316     /**
 317      * reset the stacked DPO to unlock it
 318      */
 319   dpo_reset (&ue->ue_dpo);
 320
 321   fib_entry_untrack (ue->ue_fib_entry_index, ue->ue_fib_sibling);
 322
 323   pool_put (udp_encap_pool, ue);
 324 }
 325
 326 const static char *const udp4_encap_ip4_nodes[] = {
 327   "udp4o4-encap",
 328   NULL,
 329 };
 330
 331 const static char *const udp4_encap_ip6_nodes[] = {
 332   "udp6o4-encap",
 333   NULL,
 334 };
 335
 336 const static char *const udp4_encap_mpls_nodes[] = {
 337   "udp4-encap",
 338   NULL,
 339 };
 340
 341 const static char *const udp4_encap_bier_nodes[] = {
 342   "udp4-encap",
 343   NULL,
 344 };
 345
 346 const static char *const udp6_encap_ip4_nodes[] = {
 347   "udp4o6-encap",
 348   NULL,
 349 };
 350
 351 const static char *const udp6_encap_ip6_nodes[] = {
 352   "udp6o6-encap",
 353   NULL,
 354 };
 355
 356 const static char *const udp6_encap_mpls_nodes[] = {
 357   "udp6-encap",
 358   NULL,
 359 };
 360
 361 const static char *const udp6_encap_bier_nodes[] = {
 362   "udp6-encap",
 363   NULL,
 364 };
 365
 366 const static char *const *const udp4_encap_nodes[DPO_PROTO_NUM] = {
 367   [DPO_PROTO_IP4] = udp4_encap_ip4_nodes,
 368   [DPO_PROTO_IP6] = udp4_encap_ip6_nodes,
 369   [DPO_PROTO_MPLS] = udp4_encap_mpls_nodes,
 370   [DPO_PROTO_BIER] = udp4_encap_bier_nodes,
 371 };
 372
 373 const static char *const *const udp6_encap_nodes[DPO_PROTO_NUM] = {
 374   [DPO_PROTO_IP4] = udp6_encap_ip4_nodes,
 375   [DPO_PROTO_IP6] = udp6_encap_ip6_nodes,
 376   [DPO_PROTO_MPLS] = udp6_encap_mpls_nodes,
 377   [DPO_PROTO_BIER] = udp6_encap_bier_nodes,
 378 };
 379
 380 /*
 381  * Virtual function table registered by UDP encaps
 382  * for participation in the FIB object graph.
 383  */
 384 const static fib_node_vft_t udp_encap_fib_vft = {
 385   .fnv_get = udp_encap_fib_node_get,
 386   .fnv_last_lock = udp_encap_fib_last_lock_gone,
 387   .fnv_back_walk = udp_encap_fib_back_walk,
 388 };
 389
 390 const static dpo_vft_t udp_encap_dpo_vft = {
 391   .dv_lock = udp_encap_dpo_lock,
 392   .dv_unlock = udp_encap_dpo_unlock,
 393   .dv_format = format_udp_encap_dpo,
 394 };
 395
 396 clib_error_t *
 397 udp_encap_init (vlib_main_t * vm)
 398 {
 399   fib_node_register_type (FIB_NODE_TYPE_UDP_ENCAP, &udp_encap_fib_vft);
 400
 401   udp_encap_dpo_types[FIB_PROTOCOL_IP4] =
 402     dpo_register_new_type (&udp_encap_dpo_vft, udp4_encap_nodes);
 403   udp_encap_dpo_types[FIB_PROTOCOL_IP6] =
 404     dpo_register_new_type (&udp_encap_dpo_vft, udp6_encap_nodes);
 405
 406   return (NULL);
 407 }
 408
 409 VLIB_INIT_FUNCTION (udp_encap_init);
 410
 411 clib_error_t *
 412 udp_encap_cli (vlib_main_t * vm,
 413                unformat_input_t * main_input, vlib_cli_command_t * cmd)
 414 {
 415   unformat_input_t _line_input, *line_input = &_line_input;
 416   clib_error_t *error = NULL;
 417   ip46_address_t src_ip, dst_ip;
 418   u32 table_id, src_port, dst_port;
 419   udp_encap_fixup_flags_t flags;
 420   fib_protocol_t fproto;
 421   index_t uei;
 422   u8 is_del;
 423
 424   is_del = 0;
 425   table_id = 0;
 426   flags = UDP_ENCAP_FIXUP_NONE;
 427   fproto = FIB_PROTOCOL_MAX;
 428   dst_port = 0;
 429   uei = ~0;
 430
 431   /* Get a line of input. */
 432   if (!unformat_user (main_input, unformat_line_input, line_input))
 433     return 0;
 434
 435   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 436     {
 437       if (unformat (line_input, "index %d", &uei))
 438         ;
 439       else if (unformat (line_input, "add"))
 440         is_del = 0;
 441       else if (unformat (line_input, "del"))
 442         is_del = 1;
 443       else if (unformat (line_input, "%U %U",
 444                          unformat_ip4_address,
 445                          &src_ip.ip4, unformat_ip4_address, &dst_ip.ip4))
 446         fproto = FIB_PROTOCOL_IP4;
 447       else if (unformat (line_input, "%U %U",
 448                          unformat_ip6_address,
 449                          &src_ip.ip6, unformat_ip6_address, &dst_ip.ip6))
 450         fproto = FIB_PROTOCOL_IP6;
 451       else if (unformat (line_input, "%d %d", &src_port, &dst_port))
 452         ;
 453       else if (unformat (line_input, "%d", &dst_port))
 454         ;
 455       else if (unformat (line_input, "table-id %d", &table_id))
 456         ;
 457       else if (unformat (line_input, "src-port-is-entropy"))
 458         flags |= UDP_ENCAP_FIXUP_UDP_SRC_PORT_ENTROPY;
 459       else
 460         {
 461           error = unformat_parse_error (line_input);
 462           goto done;
 463         }
 464     }
 465
 466   if (!is_del && fproto != FIB_PROTOCOL_MAX)
 467     {
 468       u32 fib_index;
 469       index_t uei;
 470
 471       fib_index = fib_table_find (fproto, table_id);
 472
 473       if (~0 == fib_index)
 474         {
 475           error = clib_error_return (0, "Nonexistent table id %d", table_id);
 476           goto done;
 477         }
 478
 479       uei = udp_encap_add_and_lock (fproto, fib_index,
 480                                     &src_ip, &dst_ip,
 481                                     src_port, dst_port, flags);
 482
 483       vlib_cli_output (vm, "udp-encap: %d\n", uei);
 484     }
 485   else if (is_del)
 486     {
 487       if (INDEX_INVALID == uei)
 488         {
 489           error = clib_error_return (0, "specify udp-encap object index");
 490           goto done;
 491         }
 492       udp_encap_unlock (uei);
 493     }
 494   else
 495     {
 496       error = clib_error_return (0, "specify some IP addresses");
 497     }
 498
 499 done:
 500   unformat_free (line_input);
 501   return error;
 502 }
 503
 504 void
 505 udp_encap_walk (udp_encap_walk_cb_t cb, void *ctx)
 506 {
 507   index_t uei;
 508
 509   /* *INDENT-OFF* */
 510   pool_foreach_index (uei, udp_encap_pool)
 511    {
 512     if (WALK_STOP == cb(uei, ctx))
 513       break;
 514   }
 515   /* *INDENT-ON* */
 516 }
 517
 518 clib_error_t *
 519 udp_encap_show (vlib_main_t * vm,
 520                 unformat_input_t * input, vlib_cli_command_t * cmd)
 521 {
 522   index_t uei;
 523
 524   uei = INDEX_INVALID;
 525
 526   /* Get a line of input. */
 527   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 528     {
 529       if (unformat (input, "%d", &uei))
 530         ;
 531       else
 532         return clib_error_return (0, "unknown input `%U'",
 533                                   format_unformat_error, input);
 534     }
 535
 536   if (INDEX_INVALID == uei)
 537     {
 538       /* *INDENT-OFF* */
 539       pool_foreach_index (uei, udp_encap_pool)
 540        {
 541         vlib_cli_output(vm, "%U", format_udp_encap, uei, 0);
 542       }
 543       /* *INDENT-ON* */
 544     }
 545   else
 546     {
 547       vlib_cli_output (vm, "%U", format_udp_encap, uei, 1);
 548     }
 549
 550   return NULL;
 551 }
 552
 553 /* *INDENT-OFF* */
 554 VLIB_CLI_COMMAND (udp_encap_add_command, static) = {
 555   .path = "udp encap",
 556   .short_help = "udp encap [add|del] <id ID> <src-ip> <dst-ip> [<src-port>] <dst-port>  [src-port-is-entropy] [table-id <table>]",
 557   .function = udp_encap_cli,
 558   .is_mp_safe = 1,
 559 };
 560 VLIB_CLI_COMMAND (udp_encap_show_command, static) = {
 561   .path = "show udp encap",
 562   .short_help = "show udp encap [ID]",
 563   .function = udp_encap_show,
 564   .is_mp_safe = 1,
 565 };
 566 /* *INDENT-ON* */
 567
 568 /*
 569  * fd.io coding-style-patch-verification: ON
 570  *
 571  * Local Variables:
 572  * eval: (c-set-style "gnu")
 573  * End:
 574  */