src/vnet/gre/gre.c

   1 /*
   2  * gre.c: gre
   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/gre/gre.h>
  20 #include <vnet/adj/adj_midchain.h>
  21
  22 gre_main_t gre_main;
  23
  24 typedef struct {
  25   union {
  26     ip4_and_gre_header_t ip4_and_gre;
  27     u64 as_u64[3];
  28   };
  29 } ip4_and_gre_union_t;
  30
  31
  32 /* Packet trace structure */
  33 typedef struct {
  34   /* Tunnel-id / index in tunnel vector */
  35   u32 tunnel_id;
  36
  37   /* pkt length */
  38   u32 length;
  39
  40   /* tunnel ip4 addresses */
  41   ip4_address_t src;
  42   ip4_address_t dst;
  43 } gre_tx_trace_t;
  44
  45 u8 * format_gre_tx_trace (u8 * s, va_list * args)
  46 {
  47   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  48   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  49   gre_tx_trace_t * t = va_arg (*args, gre_tx_trace_t *);
  50
  51   s = format (s, "GRE: tunnel %d len %d src %U dst %U",
  52               t->tunnel_id, clib_net_to_host_u16 (t->length),
  53               format_ip4_address, &t->src.as_u8,
  54               format_ip4_address, &t->dst.as_u8);
  55   return s;
  56 }
  57
  58 u8 * format_gre_protocol (u8 * s, va_list * args)
  59 {
  60   gre_protocol_t p = va_arg (*args, u32);
  61   gre_main_t * gm = &gre_main;
  62   gre_protocol_info_t * pi = gre_get_protocol_info (gm, p);
  63
  64   if (pi)
  65     s = format (s, "%s", pi->name);
  66   else
  67     s = format (s, "0x%04x", p);
  68
  69   return s;
  70 }
  71
  72 u8 * format_gre_header_with_length (u8 * s, va_list * args)
  73 {
  74   gre_main_t * gm = &gre_main;
  75   gre_header_t * h = va_arg (*args, gre_header_t *);
  76   u32 max_header_bytes = va_arg (*args, u32);
  77   gre_protocol_t p = clib_net_to_host_u16 (h->protocol);
  78   uword indent, header_bytes;
  79
  80   header_bytes = sizeof (h[0]);
  81   if (max_header_bytes != 0 && header_bytes > max_header_bytes)
  82     return format (s, "gre header truncated");
  83
  84   indent = format_get_indent (s);
  85
  86   s = format (s, "GRE %U", format_gre_protocol, p);
  87
  88   if (max_header_bytes != 0 && header_bytes > max_header_bytes)
  89     {
  90       gre_protocol_info_t * pi = gre_get_protocol_info (gm, p);
  91       vlib_node_t * node = vlib_get_node (gm->vlib_main, pi->node_index);
  92       if (node->format_buffer)
  93         s = format (s, "\n%U%U",
  94                     format_white_space, indent,
  95                     node->format_buffer, (void *) (h + 1),
  96                     max_header_bytes - header_bytes);
  97     }
  98
  99   return s;
 100 }
 101
 102 u8 * format_gre_header (u8 * s, va_list * args)
 103 {
 104   gre_header_t * h = va_arg (*args, gre_header_t *);
 105   return format (s, "%U", format_gre_header_with_length, h, 0);
 106 }
 107
 108 /* Returns gre protocol as an int in host byte order. */
 109 uword
 110 unformat_gre_protocol_host_byte_order (unformat_input_t * input,
 111                                        va_list * args)
 112 {
 113   u16 * result = va_arg (*args, u16 *);
 114   gre_main_t * gm = &gre_main;
 115   int i;
 116
 117   /* Named type. */
 118   if (unformat_user (input, unformat_vlib_number_by_name,
 119                      gm->protocol_info_by_name, &i))
 120     {
 121       gre_protocol_info_t * pi = vec_elt_at_index (gm->protocol_infos, i);
 122       *result = pi->protocol;
 123       return 1;
 124     }
 125
 126   return 0;
 127 }
 128
 129 uword
 130 unformat_gre_protocol_net_byte_order (unformat_input_t * input,
 131                                       va_list * args)
 132 {
 133   u16 * result = va_arg (*args, u16 *);
 134   if (! unformat_user (input, unformat_gre_protocol_host_byte_order, result))
 135     return 0;
 136   *result = clib_host_to_net_u16 ((u16) *result);
 137   return 1;
 138 }
 139
 140 uword
 141 unformat_gre_header (unformat_input_t * input, va_list * args)
 142 {
 143   u8 ** result = va_arg (*args, u8 **);
 144   gre_header_t _h, * h = &_h;
 145   u16 p;
 146
 147   if (! unformat (input, "%U",
 148                   unformat_gre_protocol_host_byte_order, &p))
 149     return 0;
 150
 151   h->protocol = clib_host_to_net_u16 (p);
 152
 153   /* Add header to result. */
 154   {
 155     void * p;
 156     u32 n_bytes = sizeof (h[0]);
 157
 158     vec_add2 (*result, p, n_bytes);
 159     clib_memcpy (p, h, n_bytes);
 160   }
 161
 162   return 1;
 163 }
 164
 165 static int
 166 gre_proto_from_vnet_link (vnet_link_t link)
 167 {
 168     switch (link)
 169     {
 170     case VNET_LINK_IP4:
 171         return (GRE_PROTOCOL_ip4);
 172     case VNET_LINK_IP6:
 173         return (GRE_PROTOCOL_ip6);
 174     case VNET_LINK_MPLS:
 175         return (GRE_PROTOCOL_mpls_unicast);
 176     case VNET_LINK_ETHERNET:
 177         return (GRE_PROTOCOL_teb);
 178     case VNET_LINK_ARP:
 179         return (GRE_PROTOCOL_arp);
 180     case VNET_LINK_NSH:
 181         ASSERT(0);
 182         break;
 183     }
 184     ASSERT(0);
 185     return (GRE_PROTOCOL_ip4);
 186 }
 187
 188 static u8*
 189 gre_build_rewrite (vnet_main_t * vnm,
 190                    u32 sw_if_index,
 191                    vnet_link_t link_type,
 192                    const void *dst_address)
 193 {
 194   gre_main_t * gm = &gre_main;
 195   ip4_and_gre_header_t * h;
 196   u8* rewrite = NULL;
 197   gre_tunnel_t *t;
 198   u32 ti;
 199
 200   ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
 201
 202   if (~0 == ti)
 203       /* not one of ours */
 204       return (0);
 205
 206   t = pool_elt_at_index(gm->tunnels, ti);
 207
 208   vec_validate(rewrite, sizeof(*h)-1);
 209   h = (ip4_and_gre_header_t*)rewrite;
 210   h->gre.protocol = clib_host_to_net_u16(gre_proto_from_vnet_link(link_type));
 211
 212   h->ip4.ip_version_and_header_length = 0x45;
 213   h->ip4.ttl = 254;
 214   h->ip4.protocol = IP_PROTOCOL_GRE;
 215   /* fixup ip4 header length and checksum after-the-fact */
 216   h->ip4.src_address.as_u32 = t->tunnel_src.as_u32;
 217   h->ip4.dst_address.as_u32 = t->tunnel_dst.as_u32;
 218   h->ip4.checksum = ip4_header_checksum (&h->ip4);
 219
 220   return (rewrite);
 221 }
 222
 223 void
 224 gre_fixup (vlib_main_t *vm,
 225            ip_adjacency_t *adj,
 226            vlib_buffer_t *b0)
 227 {
 228     ip4_header_t * ip0;
 229
 230     ip0 = vlib_buffer_get_current (b0);
 231
 232     /* Fixup the checksum and len fields in the GRE tunnel encap
 233      * that was applied at the midchain node */
 234     ip0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
 235     ip0->checksum = ip4_header_checksum (ip0);
 236 }
 237
 238 void
 239 gre_update_adj (vnet_main_t * vnm,
 240                 u32 sw_if_index,
 241                 adj_index_t ai)
 242 {
 243     adj_nbr_midchain_update_rewrite (ai, gre_fixup,
 244                                      ADJ_MIDCHAIN_FLAG_NONE,
 245                                      gre_build_rewrite(vnm, sw_if_index,
 246                                                        adj_get_link_type(ai),
 247                                                        NULL));
 248
 249     gre_tunnel_stack(ai);
 250 }
 251
 252 /**
 253  * @brief TX function. Only called L2. L3 traffic uses the adj-midchains
 254  */
 255 static uword
 256 gre_interface_tx_inline (vlib_main_t * vm,
 257                          vlib_node_runtime_t * node,
 258                          vlib_frame_t * frame)
 259 {
 260   gre_main_t * gm = &gre_main;
 261   u32 next_index;
 262   u32 * from, * to_next, n_left_from, n_left_to_next;
 263   vnet_interface_output_runtime_t * rd = (void *) node->runtime_data;
 264   const gre_tunnel_t *gt = pool_elt_at_index (gm->tunnels, rd->dev_instance);
 265
 266   /* Vector of buffer / pkt indices we're supposed to process */
 267   from = vlib_frame_vector_args (frame);
 268
 269   /* Number of buffers / pkts */
 270   n_left_from = frame->n_vectors;
 271
 272   /* Speculatively send the first buffer to the last disposition we used */
 273   next_index = node->cached_next_index;
 274
 275   while (n_left_from > 0)
 276     {
 277       /* set up to enqueue to our disposition with index = next_index */
 278       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 279
 280       /*
 281        * FIXME DUAL LOOP
 282        */
 283
 284       while (n_left_from > 0 && n_left_to_next > 0)
 285         {
 286           vlib_buffer_t * b0;
 287           u32 bi0;
 288
 289           bi0 = from[0];
 290           to_next[0] = bi0;
 291           from += 1;
 292           to_next += 1;
 293           n_left_from -= 1;
 294           n_left_to_next -= 1;
 295
 296           b0 = vlib_get_buffer(vm, bi0);
 297
 298           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = gt->l2_adj_index;
 299
 300           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
 301             {
 302               gre_tx_trace_t *tr = vlib_add_trace (vm, node,
 303                                                    b0, sizeof (*tr));
 304               tr->tunnel_id = gt - gm->tunnels;
 305               tr->length = vlib_buffer_length_in_chain (vm, b0);
 306               tr->src.as_u32 = gt->tunnel_src.as_u32;
 307               tr->dst.as_u32 = gt->tunnel_src.as_u32;
 308             }
 309
 310           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 311                                            to_next, n_left_to_next,
 312                                            bi0, gt->l2_tx_arc);
 313         }
 314
 315       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 316     }
 317
 318   vlib_node_increment_counter (vm, gre_input_node.index,
 319                                GRE_ERROR_PKTS_ENCAP, frame->n_vectors);
 320
 321   return frame->n_vectors;
 322 }
 323
 324 static uword
 325 gre_interface_tx (vlib_main_t * vm,
 326                   vlib_node_runtime_t * node,
 327                   vlib_frame_t * frame)
 328 {
 329     return (gre_interface_tx_inline (vm, node, frame));
 330 }
 331
 332 static uword
 333 gre_teb_interface_tx (vlib_main_t * vm,
 334                       vlib_node_runtime_t * node,
 335                       vlib_frame_t * frame)
 336 {
 337     return (gre_interface_tx_inline (vm, node, frame));
 338 }
 339
 340 static u8 * format_gre_tunnel_name (u8 * s, va_list * args)
 341 {
 342   u32 dev_instance = va_arg (*args, u32);
 343   return format (s, "gre%d", dev_instance);
 344 }
 345
 346 static u8 * format_gre_tunnel_teb_name (u8 * s, va_list * args)
 347 {
 348   u32 dev_instance = va_arg (*args, u32);
 349   return format (s, "teb-gre%d", dev_instance);
 350 }
 351
 352 static u8 * format_gre_device (u8 * s, va_list * args)
 353 {
 354   u32 dev_instance = va_arg (*args, u32);
 355   CLIB_UNUSED (int verbose) = va_arg (*args, int);
 356
 357   s = format (s, "GRE tunnel: id %d\n", dev_instance);
 358   return s;
 359 }
 360
 361 VNET_DEVICE_CLASS (gre_device_class) = {
 362   .name = "GRE tunnel device",
 363   .format_device_name = format_gre_tunnel_name,
 364   .format_device = format_gre_device,
 365   .format_tx_trace = format_gre_tx_trace,
 366   .tx_function = gre_interface_tx,
 367   .admin_up_down_function = gre_interface_admin_up_down,
 368 #ifdef SOON
 369   .clear counter = 0;
 370 #endif
 371 };
 372
 373 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (gre_device_class,
 374                                    gre_interface_tx)
 375
 376 VNET_DEVICE_CLASS (gre_device_teb_class) = {
 377   .name = "GRE TEB tunnel device",
 378   .format_device_name = format_gre_tunnel_teb_name,
 379   .format_device = format_gre_device,
 380   .format_tx_trace = format_gre_tx_trace,
 381   .tx_function = gre_teb_interface_tx,
 382   .admin_up_down_function = gre_interface_admin_up_down,
 383 #ifdef SOON
 384   .clear counter = 0;
 385 #endif
 386 };
 387
 388 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (gre_device_teb_class,
 389                                    gre_teb_interface_tx)
 390
 391 VNET_HW_INTERFACE_CLASS (gre_hw_interface_class) = {
 392   .name = "GRE",
 393   .format_header = format_gre_header_with_length,
 394   .unformat_header = unformat_gre_header,
 395   .build_rewrite = gre_build_rewrite,
 396   .update_adjacency = gre_update_adj,
 397   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 398 };
 399
 400 static void add_protocol (gre_main_t * gm,
 401                           gre_protocol_t protocol,
 402                           char * protocol_name)
 403 {
 404   gre_protocol_info_t * pi;
 405   u32 i;
 406
 407   vec_add2 (gm->protocol_infos, pi, 1);
 408   i = pi - gm->protocol_infos;
 409
 410   pi->name = protocol_name;
 411   pi->protocol = protocol;
 412   pi->next_index = pi->node_index = ~0;
 413
 414   hash_set (gm->protocol_info_by_protocol, protocol, i);
 415   hash_set_mem (gm->protocol_info_by_name, pi->name, i);
 416 }
 417
 418 static clib_error_t * gre_init (vlib_main_t * vm)
 419 {
 420   gre_main_t * gm = &gre_main;
 421   clib_error_t * error;
 422   ip_main_t * im = &ip_main;
 423   ip_protocol_info_t * pi;
 424
 425   memset (gm, 0, sizeof (gm[0]));
 426   gm->vlib_main = vm;
 427   gm->vnet_main = vnet_get_main();
 428
 429   if ((error = vlib_call_init_function (vm, ip_main_init)))
 430     return error;
 431
 432   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
 433     return error;
 434
 435   /* Set up the ip packet generator */
 436   pi = ip_get_protocol_info (im, IP_PROTOCOL_GRE);
 437   pi->format_header = format_gre_header;
 438   pi->unformat_pg_edit = unformat_pg_gre_header;
 439
 440   gm->protocol_info_by_name = hash_create_string (0, sizeof (uword));
 441   gm->protocol_info_by_protocol = hash_create (0, sizeof (uword));
 442   gm->tunnel_by_key = hash_create (0, sizeof (uword));
 443
 444 #define _(n,s) add_protocol (gm, GRE_PROTOCOL_##s, #s);
 445   foreach_gre_protocol
 446 #undef _
 447
 448   return vlib_call_init_function (vm, gre_input_init);
 449 }
 450
 451 VLIB_INIT_FUNCTION (gre_init);
 452
 453 gre_main_t * gre_get_main (vlib_main_t * vm)
 454 {
 455   vlib_call_init_function (vm, gre_init);
 456   return &gre_main;
 457 }
 458