fib: Always honour flow hash flag
[vpp.git] / 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 #include <vnet/tunnel/tunnel_dp.h>
22
23 extern gre_main_t gre_main;
24
25 #ifndef CLIB_MARCH_VARIANT
26 gre_main_t gre_main;
27
28 typedef struct
29 {
30   union
31   {
32     ip4_and_gre_header_t ip4_and_gre;
33     u64 as_u64[3];
34   };
35 } ip4_and_gre_union_t;
36
37 typedef struct
38 {
39   union
40   {
41     ip6_and_gre_header_t ip6_and_gre;
42     u64 as_u64[3];
43   };
44 } ip6_and_gre_union_t;
45 #endif /* CLIB_MARCH_VARIANT */
46
47
48 /* Packet trace structure */
49 typedef struct
50 {
51   /* Tunnel-id / index in tunnel vector */
52   u32 tunnel_id;
53
54   /* pkt length */
55   u32 length;
56
57   /* tunnel ip addresses */
58   ip46_address_t src;
59   ip46_address_t dst;
60 } gre_tx_trace_t;
61
62 extern u8 *format_gre_tx_trace (u8 * s, va_list * args);
63
64 #ifndef CLIB_MARCH_VARIANT
65 u8 *
66 format_gre_tx_trace (u8 * s, va_list * args)
67 {
68   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
69   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
70   gre_tx_trace_t *t = va_arg (*args, gre_tx_trace_t *);
71
72   s = format (s, "GRE: tunnel %d len %d src %U dst %U",
73               t->tunnel_id, t->length,
74               format_ip46_address, &t->src, IP46_TYPE_ANY,
75               format_ip46_address, &t->dst, IP46_TYPE_ANY);
76   return s;
77 }
78
79 u8 *
80 format_gre_protocol (u8 * s, va_list * args)
81 {
82   gre_protocol_t p = va_arg (*args, u32);
83   gre_main_t *gm = &gre_main;
84   gre_protocol_info_t *pi = gre_get_protocol_info (gm, p);
85
86   if (pi)
87     s = format (s, "%s", pi->name);
88   else
89     s = format (s, "0x%04x", p);
90
91   return s;
92 }
93
94 u8 *
95 format_gre_header_with_length (u8 * s, va_list * args)
96 {
97   gre_main_t *gm = &gre_main;
98   gre_header_t *h = va_arg (*args, gre_header_t *);
99   u32 max_header_bytes = va_arg (*args, u32);
100   gre_protocol_t p = clib_net_to_host_u16 (h->protocol);
101   u32 indent, header_bytes;
102
103   header_bytes = sizeof (h[0]);
104   if (max_header_bytes != 0 && header_bytes > max_header_bytes)
105     return format (s, "gre header truncated");
106
107   indent = format_get_indent (s);
108
109   s = format (s, "GRE %U", format_gre_protocol, p);
110
111   if (max_header_bytes != 0 && header_bytes < max_header_bytes)
112     {
113       gre_protocol_info_t *pi = gre_get_protocol_info (gm, p);
114       vlib_node_t *node = vlib_get_node (gm->vlib_main, pi->node_index);
115       if (node->format_buffer)
116         s = format (s, "\n%U%U",
117                     format_white_space, indent,
118                     node->format_buffer, (void *) (h + 1),
119                     max_header_bytes - header_bytes);
120     }
121
122   return s;
123 }
124
125 u8 *
126 format_gre_header (u8 * s, va_list * args)
127 {
128   gre_header_t *h = va_arg (*args, gre_header_t *);
129   return format (s, "%U", format_gre_header_with_length, h, 0);
130 }
131
132 /* Returns gre protocol as an int in host byte order. */
133 uword
134 unformat_gre_protocol_host_byte_order (unformat_input_t * input,
135                                        va_list * args)
136 {
137   u16 *result = va_arg (*args, u16 *);
138   gre_main_t *gm = &gre_main;
139   int i;
140
141   /* Named type. */
142   if (unformat_user (input, unformat_vlib_number_by_name,
143                      gm->protocol_info_by_name, &i))
144     {
145       gre_protocol_info_t *pi = vec_elt_at_index (gm->protocol_infos, i);
146       *result = pi->protocol;
147       return 1;
148     }
149
150   return 0;
151 }
152
153 uword
154 unformat_gre_protocol_net_byte_order (unformat_input_t * input,
155                                       va_list * args)
156 {
157   u16 *result = va_arg (*args, u16 *);
158   if (!unformat_user (input, unformat_gre_protocol_host_byte_order, result))
159     return 0;
160   *result = clib_host_to_net_u16 ((u16) * result);
161   return 1;
162 }
163
164 uword
165 unformat_gre_header (unformat_input_t * input, va_list * args)
166 {
167   u8 **result = va_arg (*args, u8 **);
168   gre_header_t _h, *h = &_h;
169   u16 p;
170
171   if (!unformat (input, "%U", unformat_gre_protocol_host_byte_order, &p))
172     return 0;
173
174   h->protocol = clib_host_to_net_u16 (p);
175
176   /* Add header to result. */
177   {
178     void *p;
179     u32 n_bytes = sizeof (h[0]);
180
181     vec_add2 (*result, p, n_bytes);
182     clib_memcpy (p, h, n_bytes);
183   }
184
185   return 1;
186 }
187
188 static int
189 gre_proto_from_vnet_link (vnet_link_t link)
190 {
191   switch (link)
192     {
193     case VNET_LINK_IP4:
194       return (GRE_PROTOCOL_ip4);
195     case VNET_LINK_IP6:
196       return (GRE_PROTOCOL_ip6);
197     case VNET_LINK_MPLS:
198       return (GRE_PROTOCOL_mpls_unicast);
199     case VNET_LINK_ETHERNET:
200       return (GRE_PROTOCOL_teb);
201     case VNET_LINK_ARP:
202       return (GRE_PROTOCOL_arp);
203     case VNET_LINK_NSH:
204       ASSERT (0);
205       break;
206     }
207   ASSERT (0);
208   return (GRE_PROTOCOL_ip4);
209 }
210
211 static u8 *
212 gre_build_rewrite (vnet_main_t * vnm,
213                    u32 sw_if_index,
214                    vnet_link_t link_type, const void *dst_address)
215 {
216   gre_main_t *gm = &gre_main;
217   const ip46_address_t *dst;
218   ip4_and_gre_header_t *h4;
219   ip6_and_gre_header_t *h6;
220   gre_header_t *gre;
221   u8 *rewrite = NULL;
222   gre_tunnel_t *t;
223   u32 ti;
224   u8 is_ipv6;
225
226   dst = dst_address;
227   ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
228
229   if (~0 == ti)
230     /* not one of ours */
231     return (0);
232
233   t = pool_elt_at_index (gm->tunnels, ti);
234
235   is_ipv6 = t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6 ? 1 : 0;
236
237   if (!is_ipv6)
238     {
239       vec_validate (rewrite, sizeof (*h4) - 1);
240       h4 = (ip4_and_gre_header_t *) rewrite;
241       gre = &h4->gre;
242       h4->ip4.ip_version_and_header_length = 0x45;
243       h4->ip4.ttl = 254;
244       h4->ip4.protocol = IP_PROTOCOL_GRE;
245       /* fixup ip4 header length and checksum after-the-fact */
246       h4->ip4.src_address.as_u32 = t->tunnel_src.ip4.as_u32;
247       h4->ip4.dst_address.as_u32 = dst->ip4.as_u32;
248       h4->ip4.checksum = ip4_header_checksum (&h4->ip4);
249     }
250   else
251     {
252       vec_validate (rewrite, sizeof (*h6) - 1);
253       h6 = (ip6_and_gre_header_t *) rewrite;
254       gre = &h6->gre;
255       h6->ip6.ip_version_traffic_class_and_flow_label =
256         clib_host_to_net_u32 (6 << 28);
257       h6->ip6.hop_limit = 255;
258       h6->ip6.protocol = IP_PROTOCOL_GRE;
259       /* fixup ip6 header length and checksum after-the-fact */
260       h6->ip6.src_address.as_u64[0] = t->tunnel_src.ip6.as_u64[0];
261       h6->ip6.src_address.as_u64[1] = t->tunnel_src.ip6.as_u64[1];
262       h6->ip6.dst_address.as_u64[0] = dst->ip6.as_u64[0];
263       h6->ip6.dst_address.as_u64[1] = dst->ip6.as_u64[1];
264     }
265
266   if (PREDICT_FALSE (t->type == GRE_TUNNEL_TYPE_ERSPAN))
267     {
268       gre->protocol = clib_host_to_net_u16 (GRE_PROTOCOL_erspan);
269       gre->flags_and_version = clib_host_to_net_u16 (GRE_FLAGS_SEQUENCE);
270     }
271   else
272     gre->protocol =
273       clib_host_to_net_u16 (gre_proto_from_vnet_link (link_type));
274
275   return (rewrite);
276 }
277
278 static void
279 gre44_fixup (vlib_main_t * vm,
280              const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
281 {
282   tunnel_encap_decap_flags_t flags;
283   ip4_and_gre_header_t *ip0;
284
285   ip0 = vlib_buffer_get_current (b0);
286   flags = pointer_to_uword (data);
287
288   /* Fixup the checksum and len fields in the GRE tunnel encap
289    * that was applied at the midchain node */
290   ip0->ip4.length =
291     clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
292   tunnel_encap_fixup_4o4 (flags, (ip4_header_t *) (ip0 + 1), &ip0->ip4);
293   ip0->ip4.checksum = ip4_header_checksum (&ip0->ip4);
294 }
295
296 static void
297 gre64_fixup (vlib_main_t * vm,
298              const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
299 {
300   tunnel_encap_decap_flags_t flags;
301   ip4_and_gre_header_t *ip0;
302
303   ip0 = vlib_buffer_get_current (b0);
304   flags = pointer_to_uword (data);
305
306   /* Fixup the checksum and len fields in the GRE tunnel encap
307    * that was applied at the midchain node */
308   ip0->ip4.length =
309     clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
310   tunnel_encap_fixup_6o4 (flags, (ip6_header_t *) (ip0 + 1), &ip0->ip4);
311   ip0->ip4.checksum = ip4_header_checksum (&ip0->ip4);
312 }
313
314 static void
315 grex4_fixup (vlib_main_t * vm,
316              const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
317 {
318   ip4_header_t *ip0;
319
320   ip0 = vlib_buffer_get_current (b0);
321
322   /* Fixup the checksum and len fields in the GRE tunnel encap
323    * that was applied at the midchain node */
324   ip0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
325   ip0->checksum = ip4_header_checksum (ip0);
326 }
327
328 static void
329 gre46_fixup (vlib_main_t * vm,
330              const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
331 {
332   tunnel_encap_decap_flags_t flags;
333   ip6_and_gre_header_t *ip0;
334
335   ip0 = vlib_buffer_get_current (b0);
336   flags = pointer_to_uword (data);
337
338   /* Fixup the payload length field in the GRE tunnel encap that was applied
339    * at the midchain node */
340   ip0->ip6.payload_length =
341     clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
342                           sizeof (ip0->ip6));
343   tunnel_encap_fixup_4o6 (flags, b0, (ip4_header_t *) (ip0 + 1), &ip0->ip6);
344 }
345
346 static void
347 gre66_fixup (vlib_main_t * vm,
348              const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
349 {
350   tunnel_encap_decap_flags_t flags;
351   ip6_and_gre_header_t *ip0;
352
353   ip0 = vlib_buffer_get_current (b0);
354   flags = pointer_to_uword (data);
355
356   /* Fixup the payload length field in the GRE tunnel encap that was applied
357    * at the midchain node */
358   ip0->ip6.payload_length =
359     clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
360                           sizeof (ip0->ip6));
361   tunnel_encap_fixup_6o6 (flags, (ip6_header_t *) (ip0 + 1), &ip0->ip6);
362 }
363
364 static void
365 grex6_fixup (vlib_main_t * vm,
366              const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
367 {
368   ip6_and_gre_header_t *ip0;
369
370   ip0 = vlib_buffer_get_current (b0);
371
372   /* Fixup the payload length field in the GRE tunnel encap that was applied
373    * at the midchain node */
374   ip0->ip6.payload_length =
375     clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
376                           sizeof (ip0->ip6));
377 }
378
379 /**
380  * return the appropriate fixup function given the overlay (link-type) and
381  * underlay (fproto) combination
382  */
383 static adj_midchain_fixup_t
384 gre_get_fixup (fib_protocol_t fproto, vnet_link_t lt)
385 {
386   if (fproto == FIB_PROTOCOL_IP6 && lt == VNET_LINK_IP6)
387     return (gre66_fixup);
388   if (fproto == FIB_PROTOCOL_IP6 && lt == VNET_LINK_IP4)
389     return (gre46_fixup);
390   if (fproto == FIB_PROTOCOL_IP4 && lt == VNET_LINK_IP6)
391     return (gre64_fixup);
392   if (fproto == FIB_PROTOCOL_IP4 && lt == VNET_LINK_IP4)
393     return (gre44_fixup);
394   if (fproto == FIB_PROTOCOL_IP6)
395     return (grex6_fixup);
396   if (fproto == FIB_PROTOCOL_IP4)
397     return (grex4_fixup);
398
399   ASSERT (0);
400   return (gre44_fixup);
401 }
402
403 void
404 gre_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
405 {
406   gre_main_t *gm = &gre_main;
407   gre_tunnel_t *t;
408   adj_flags_t af;
409   u32 ti;
410
411   ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
412   t = pool_elt_at_index (gm->tunnels, ti);
413   af = ADJ_FLAG_NONE;
414
415   /*
416    * the user has not requested that the load-balancing be based on
417    * a flow hash of the inner packet. so use the stacking to choose
418    * a path.
419    */
420   if (!(t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_INNER_HASH))
421     af |= ADJ_FLAG_MIDCHAIN_IP_STACK;
422
423   if (VNET_LINK_ETHERNET == adj_get_link_type (ai))
424     af |= ADJ_FLAG_MIDCHAIN_NO_COUNT;
425
426   adj_nbr_midchain_update_rewrite
427     (ai, gre_get_fixup (t->tunnel_dst.fp_proto,
428                         adj_get_link_type (ai)),
429      uword_to_pointer (t->flags, void *), af,
430      gre_build_rewrite (vnm, sw_if_index, adj_get_link_type (ai),
431                         &t->tunnel_dst.fp_addr));
432
433   gre_tunnel_stack (ai);
434 }
435
436 adj_walk_rc_t
437 mgre_mk_complete_walk (adj_index_t ai, void *data)
438 {
439   mgre_walk_ctx_t *ctx = data;
440   adj_flags_t af;
441
442   af = ADJ_FLAG_NONE;
443
444   /*
445    * the user has not requested that the load-balancing be based on
446    * a flow hash of the inner packet. so use the stacking to choose
447    * a path.
448    */
449   if (!(ctx->t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_INNER_HASH))
450     af |= ADJ_FLAG_MIDCHAIN_IP_STACK;
451
452   adj_nbr_midchain_update_rewrite
453     (ai, gre_get_fixup (ctx->t->tunnel_dst.fp_proto,
454                         adj_get_link_type (ai)),
455      uword_to_pointer (ctx->t->flags, void *),
456      af,
457      gre_build_rewrite (vnet_get_main (),
458                         ctx->t->sw_if_index,
459                         adj_get_link_type (ai),
460                         &teib_entry_get_nh (ctx->ne)->fp_addr));
461
462   teib_entry_adj_stack (ctx->ne, ai);
463
464   return (ADJ_WALK_RC_CONTINUE);
465 }
466
467 adj_walk_rc_t
468 mgre_mk_incomplete_walk (adj_index_t ai, void *data)
469 {
470   gre_tunnel_t *t = data;
471
472   adj_nbr_midchain_update_rewrite (ai, gre_get_fixup (t->tunnel_dst.fp_proto,
473                                                       adj_get_link_type (ai)),
474                                    NULL, ADJ_FLAG_NONE, NULL);
475
476   adj_midchain_delegate_unstack (ai);
477
478   return (ADJ_WALK_RC_CONTINUE);
479 }
480
481 void
482 mgre_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
483 {
484   gre_main_t *gm = &gre_main;
485   ip_adjacency_t *adj;
486   teib_entry_t *ne;
487   gre_tunnel_t *t;
488   u32 ti;
489
490   adj = adj_get (ai);
491   ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
492   t = pool_elt_at_index (gm->tunnels, ti);
493
494   ne = teib_entry_find_46 (sw_if_index,
495                            adj->ia_nh_proto, &adj->sub_type.nbr.next_hop);
496
497   if (NULL == ne)
498     // no NHRP entry to provide the next-hop
499     return;
500
501   mgre_walk_ctx_t ctx = {
502     .t = t,
503     .ne = ne
504   };
505   adj_nbr_walk_nh (sw_if_index,
506                    adj->ia_nh_proto,
507                    &adj->sub_type.nbr.next_hop, mgre_mk_complete_walk, &ctx);
508 }
509 #endif /* CLIB_MARCH_VARIANT */
510
511 typedef enum
512 {
513   GRE_ENCAP_NEXT_L2_MIDCHAIN,
514   GRE_ENCAP_N_NEXT,
515 } gre_encap_next_t;
516
517 /**
518  * @brief TX function. Only called for L2 payload including TEB or ERSPAN.
519  *        L3 traffic uses the adj-midchains.
520  */
521 static_always_inline u32
522 gre_encap_inline (vlib_main_t * vm,
523                   vlib_node_runtime_t * node,
524                   vlib_frame_t * frame, gre_tunnel_type_t type)
525 {
526   gre_main_t *gm = &gre_main;
527   u32 *from, n_left_from;
528   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
529   u32 sw_if_index[2] = { ~0, ~0 };
530   const gre_tunnel_t *gt[2] = { 0 };
531   adj_index_t adj_index[2] = { ADJ_INDEX_INVALID, ADJ_INDEX_INVALID };
532
533   from = vlib_frame_vector_args (frame);
534   n_left_from = frame->n_vectors;
535   vlib_get_buffers (vm, from, bufs, n_left_from);
536
537   while (n_left_from >= 2)
538     {
539
540       if (PREDICT_FALSE
541           (sw_if_index[0] != vnet_buffer (b[0])->sw_if_index[VLIB_TX]))
542         {
543           const vnet_hw_interface_t *hi;
544           sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
545           hi = vnet_get_sup_hw_interface (gm->vnet_main, sw_if_index[0]);
546           gt[0] = &gm->tunnels[hi->dev_instance];
547           adj_index[0] = gt[0]->l2_adj_index;
548         }
549       if (PREDICT_FALSE
550           (sw_if_index[1] != vnet_buffer (b[1])->sw_if_index[VLIB_TX]))
551         {
552           const vnet_hw_interface_t *hi;
553           sw_if_index[1] = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
554           hi = vnet_get_sup_hw_interface (gm->vnet_main, sw_if_index[1]);
555           gt[1] = &gm->tunnels[hi->dev_instance];
556           adj_index[1] = gt[1]->l2_adj_index;
557         }
558
559       vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = adj_index[0];
560       vnet_buffer (b[1])->ip.adj_index[VLIB_TX] = adj_index[1];
561
562       if (type == GRE_TUNNEL_TYPE_ERSPAN)
563         {
564           /* Encap GRE seq# and ERSPAN type II header */
565           erspan_t2_t *h0;
566           u32 seq_num;
567           u64 hdr;
568           vlib_buffer_advance (b[0], -sizeof (erspan_t2_t));
569           h0 = vlib_buffer_get_current (b[0]);
570           seq_num = clib_atomic_fetch_add (&gt[0]->gre_sn->seq_num, 1);
571           hdr = clib_host_to_net_u64 (ERSPAN_HDR2);
572           h0->seq_num = clib_host_to_net_u32 (seq_num);
573           h0->t2_u64 = hdr;
574           h0->t2.cos_en_t_session |= clib_host_to_net_u16 (gt[0]->session_id);
575         }
576       if (type == GRE_TUNNEL_TYPE_ERSPAN)
577         {
578           /* Encap GRE seq# and ERSPAN type II header */
579           erspan_t2_t *h0;
580           u32 seq_num;
581           u64 hdr;
582           vlib_buffer_advance (b[1], -sizeof (erspan_t2_t));
583           h0 = vlib_buffer_get_current (b[1]);
584           seq_num = clib_atomic_fetch_add (&gt[1]->gre_sn->seq_num, 1);
585           hdr = clib_host_to_net_u64 (ERSPAN_HDR2);
586           h0->seq_num = clib_host_to_net_u32 (seq_num);
587           h0->t2_u64 = hdr;
588           h0->t2.cos_en_t_session |= clib_host_to_net_u16 (gt[1]->session_id);
589         }
590
591       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
592         {
593           gre_tx_trace_t *tr = vlib_add_trace (vm, node,
594                                                b[0], sizeof (*tr));
595           tr->tunnel_id = gt[0] - gm->tunnels;
596           tr->src = gt[0]->tunnel_src;
597           tr->dst = gt[0]->tunnel_dst.fp_addr;
598           tr->length = vlib_buffer_length_in_chain (vm, b[0]);
599         }
600       if (PREDICT_FALSE (b[1]->flags & VLIB_BUFFER_IS_TRACED))
601         {
602           gre_tx_trace_t *tr = vlib_add_trace (vm, node,
603                                                b[1], sizeof (*tr));
604           tr->tunnel_id = gt[1] - gm->tunnels;
605           tr->src = gt[1]->tunnel_src;
606           tr->dst = gt[1]->tunnel_dst.fp_addr;
607           tr->length = vlib_buffer_length_in_chain (vm, b[1]);
608         }
609
610       b += 2;
611       n_left_from -= 2;
612     }
613
614   while (n_left_from >= 1)
615     {
616
617       if (PREDICT_FALSE
618           (sw_if_index[0] != vnet_buffer (b[0])->sw_if_index[VLIB_TX]))
619         {
620           const vnet_hw_interface_t *hi;
621           sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
622           hi = vnet_get_sup_hw_interface (gm->vnet_main, sw_if_index[0]);
623           gt[0] = &gm->tunnels[hi->dev_instance];
624           adj_index[0] = gt[0]->l2_adj_index;
625         }
626
627       vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = adj_index[0];
628
629       if (type == GRE_TUNNEL_TYPE_ERSPAN)
630         {
631           /* Encap GRE seq# and ERSPAN type II header */
632           erspan_t2_t *h0;
633           u32 seq_num;
634           u64 hdr;
635           ASSERT (gt[0]->type == GRE_TUNNEL_TYPE_ERSPAN);
636           vlib_buffer_advance (b[0], -sizeof (erspan_t2_t));
637           h0 = vlib_buffer_get_current (b[0]);
638           seq_num = clib_atomic_fetch_add (&gt[0]->gre_sn->seq_num, 1);
639           hdr = clib_host_to_net_u64 (ERSPAN_HDR2);
640           h0->seq_num = clib_host_to_net_u32 (seq_num);
641           h0->t2_u64 = hdr;
642           h0->t2.cos_en_t_session |= clib_host_to_net_u16 (gt[0]->session_id);
643         }
644
645       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
646         {
647           gre_tx_trace_t *tr = vlib_add_trace (vm, node,
648                                                b[0], sizeof (*tr));
649           tr->tunnel_id = gt[0] - gm->tunnels;
650           tr->src = gt[0]->tunnel_src;
651           tr->dst = gt[0]->tunnel_dst.fp_addr;
652           tr->length = vlib_buffer_length_in_chain (vm, b[0]);
653         }
654
655       b += 1;
656       n_left_from -= 1;
657     }
658
659   vlib_buffer_enqueue_to_single_next (vm, node, from,
660                                       GRE_ENCAP_NEXT_L2_MIDCHAIN,
661                                       frame->n_vectors);
662
663   vlib_node_increment_counter (vm, node->node_index,
664                                GRE_ERROR_PKTS_ENCAP, frame->n_vectors);
665
666   return frame->n_vectors;
667 }
668
669 static char *gre_error_strings[] = {
670 #define gre_error(n,s) s,
671 #include "error.def"
672 #undef gre_error
673 };
674
675 VLIB_NODE_FN (gre_teb_encap_node) (vlib_main_t * vm,
676                                    vlib_node_runtime_t * node,
677                                    vlib_frame_t * frame)
678 {
679   return (gre_encap_inline (vm, node, frame, GRE_TUNNEL_TYPE_TEB));
680 }
681
682 VLIB_NODE_FN (gre_erspan_encap_node) (vlib_main_t * vm,
683                                       vlib_node_runtime_t * node,
684                                       vlib_frame_t * frame)
685 {
686   return (gre_encap_inline (vm, node, frame, GRE_TUNNEL_TYPE_ERSPAN));
687 }
688
689 /* *INDENT-OFF* */
690 VLIB_REGISTER_NODE (gre_teb_encap_node) =
691 {
692   .name = "gre-teb-encap",
693   .vector_size = sizeof (u32),
694   .format_trace = format_gre_tx_trace,
695   .type = VLIB_NODE_TYPE_INTERNAL,
696   .n_errors = GRE_N_ERROR,
697   .error_strings = gre_error_strings,
698   .n_next_nodes = GRE_ENCAP_N_NEXT,
699   .next_nodes = {
700     [GRE_ENCAP_NEXT_L2_MIDCHAIN] = "adj-l2-midchain",
701   },
702 };
703 VLIB_REGISTER_NODE (gre_erspan_encap_node) =
704 {
705   .name = "gre-erspan-encap",
706   .vector_size = sizeof (u32),
707   .format_trace = format_gre_tx_trace,
708   .type = VLIB_NODE_TYPE_INTERNAL,
709   .n_errors = GRE_N_ERROR,
710   .error_strings = gre_error_strings,
711   .n_next_nodes = GRE_ENCAP_N_NEXT,
712   .next_nodes = {
713     [GRE_ENCAP_NEXT_L2_MIDCHAIN] = "adj-l2-midchain",
714   },
715 };
716 /* *INDENT-ON* */
717
718 #ifndef CLIB_MARCH_VARIANT
719 static u8 *
720 format_gre_tunnel_name (u8 * s, va_list * args)
721 {
722   u32 dev_instance = va_arg (*args, u32);
723   gre_main_t *gm = &gre_main;
724   gre_tunnel_t *t;
725
726   if (dev_instance >= vec_len (gm->tunnels))
727     return format (s, "<improperly-referenced>");
728
729   t = pool_elt_at_index (gm->tunnels, dev_instance);
730   return format (s, "gre%d", t->user_instance);
731 }
732
733 static u8 *
734 format_gre_device (u8 * s, va_list * args)
735 {
736   u32 dev_instance = va_arg (*args, u32);
737   CLIB_UNUSED (int verbose) = va_arg (*args, int);
738
739   s = format (s, "GRE tunnel: id %d\n", dev_instance);
740   return s;
741 }
742
743 static int
744 gre_tunnel_desc (u32 sw_if_index,
745                  ip46_address_t * src, ip46_address_t * dst, u8 * is_l2)
746 {
747   gre_main_t *gm = &gre_main;
748   gre_tunnel_t *t;
749   u32 ti;
750
751   ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
752
753   if (~0 == ti)
754     /* not one of ours */
755     return -1;
756
757   t = pool_elt_at_index (gm->tunnels, ti);
758
759   *src = t->tunnel_src;
760   *dst = t->tunnel_dst.fp_addr;
761   *is_l2 = t->type == GRE_TUNNEL_TYPE_TEB;
762
763   return (0);
764 }
765
766 /* *INDENT-OFF* */
767 VNET_DEVICE_CLASS (gre_device_class) = {
768   .name = "GRE tunnel device",
769   .format_device_name = format_gre_tunnel_name,
770   .format_device = format_gre_device,
771   .format_tx_trace = format_gre_tx_trace,
772   .admin_up_down_function = gre_interface_admin_up_down,
773   .ip_tun_desc = gre_tunnel_desc,
774 #ifdef SOON
775   .clear counter = 0;
776 #endif
777 };
778
779 VNET_HW_INTERFACE_CLASS (gre_hw_interface_class) = {
780   .name = "GRE",
781   .format_header = format_gre_header_with_length,
782   .unformat_header = unformat_gre_header,
783   .build_rewrite = gre_build_rewrite,
784   .update_adjacency = gre_update_adj,
785   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
786 };
787
788 VNET_HW_INTERFACE_CLASS (mgre_hw_interface_class) = {
789   .name = "mGRE",
790   .format_header = format_gre_header_with_length,
791   .unformat_header = unformat_gre_header,
792   .build_rewrite = gre_build_rewrite,
793   .update_adjacency = mgre_update_adj,
794   .flags = VNET_HW_INTERFACE_CLASS_FLAG_NBMA,
795 };
796 /* *INDENT-ON* */
797 #endif /* CLIB_MARCH_VARIANT */
798
799 static void
800 add_protocol (gre_main_t * gm, gre_protocol_t protocol, char *protocol_name)
801 {
802   gre_protocol_info_t *pi;
803   u32 i;
804
805   vec_add2 (gm->protocol_infos, pi, 1);
806   i = pi - gm->protocol_infos;
807
808   pi->name = protocol_name;
809   pi->protocol = protocol;
810   pi->next_index = pi->node_index = ~0;
811
812   hash_set (gm->protocol_info_by_protocol, protocol, i);
813   hash_set_mem (gm->protocol_info_by_name, pi->name, i);
814 }
815
816 static clib_error_t *
817 gre_init (vlib_main_t * vm)
818 {
819   gre_main_t *gm = &gre_main;
820   clib_error_t *error;
821   ip_main_t *im = &ip_main;
822   ip_protocol_info_t *pi;
823
824   clib_memset (gm, 0, sizeof (gm[0]));
825   gm->vlib_main = vm;
826   gm->vnet_main = vnet_get_main ();
827
828   if ((error = vlib_call_init_function (vm, ip_main_init)))
829     return error;
830
831   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
832     return error;
833
834   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
835     return error;
836
837   /* Set up the ip packet generator */
838   pi = ip_get_protocol_info (im, IP_PROTOCOL_GRE);
839   pi->format_header = format_gre_header;
840   pi->unformat_pg_edit = unformat_pg_gre_header;
841
842   gm->protocol_info_by_name = hash_create_string (0, sizeof (uword));
843   gm->protocol_info_by_protocol = hash_create (0, sizeof (uword));
844   gm->tunnel_by_key4 =
845     hash_create_mem (0, sizeof (gre_tunnel_key4_t), sizeof (uword));
846   gm->tunnel_by_key6 =
847     hash_create_mem (0, sizeof (gre_tunnel_key6_t), sizeof (uword));
848   gm->seq_num_by_key =
849     hash_create_mem (0, sizeof (gre_sn_key_t), sizeof (uword));
850
851 #define _(n,s) add_protocol (gm, GRE_PROTOCOL_##s, #s);
852   foreach_gre_protocol
853 #undef _
854     return vlib_call_init_function (vm, gre_input_init);
855 }
856
857 VLIB_INIT_FUNCTION (gre_init);
858
859 /*
860  * fd.io coding-style-patch-verification: ON
861  *
862  * Local Variables:
863  * eval: (c-set-style "gnu")
864  * End:
865  */