LCOV - code coverage report
Current view: top level - plugins/ioam/ip6 - ioam_cache_node.c (source / functions) Hit Total Coverage
Test: coverage-filtered.info Lines: 3 127 2.4 %
Date: 2023-10-26 01:39:38 Functions: 8 15 53.3 %

          Line data    Source code
       1             : /*
       2             :  * Copyright (c) 2017 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             :  * This file implements caching of ioam header and reattaching
      17             :  * it in response message by performing request-response matching.
      18             :  *  Works for TCP SYN/SYN-ACK.
      19             :  * This feature is used for anycast server selection.
      20             :  * ioam data thus cached is used to measure and get complete round trip
      21             :  * network path to help in server selection.
      22             :  * There are 2 graph nodes defined to :
      23             :  * 1. process packets that contain iOAM header and cache it
      24             :  * 2. process TCP SYN-ACKs and reattach ioam header from the
      25             :  *    cache corresponding to TCP-SYN
      26             :  * These graph nodes are attached to the vnet graph based on
      27             :  * ioam cache and classifier configs.
      28             :  * e.g.
      29             :  * If db06::06 is the anycast service IP6 address:
      30             :  *
      31             :  * set ioam ip6 cache
      32             :  *
      33             :  * Apply this classifier on interface where requests for anycast service are received:
      34             :  * classify session acl-hit-next ip6-node ip6-lookup table-index 0 match l3 ip6 dst db06::06
      35             :  *    ioam-decap anycast <<< ioam-decap is hooked to cache when set ioam ip6 cache is enabled
      36             :  *
      37             :  * Apply this classifier on interface where responses from anycast service are received:
      38             :  * classify session acl-hit-next ip6-node ip6-add-from-cache-hop-by-hop table-index 0 match l3
      39             :  *    ip6 src db06::06 ioam-encap anycast-response
      40             :  *
      41             :  */
      42             : #include <vlib/vlib.h>
      43             : #include <vnet/vnet.h>
      44             : #include <vppinfra/error.h>
      45             : #include <vnet/ip/ip.h>
      46             : #include <ioam/ip6/ioam_cache.h>
      47             : #include <vnet/ip/ip6_hop_by_hop.h>
      48             : #include <vnet/ip/ip6_hop_by_hop_packet.h>
      49             : #include <vnet/ip/ip6_inlines.h>
      50             : 
      51             : typedef struct
      52             : {
      53             :   u32 next_index;
      54             :   u32 flow_label;
      55             : } cache_trace_t;
      56             : 
      57             : /* packet trace format function */
      58             : static u8 *
      59           0 : format_cache_trace (u8 * s, va_list * args)
      60             : {
      61           0 :   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
      62           0 :   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
      63           0 :   cache_trace_t *t = va_arg (*args, cache_trace_t *);
      64             : 
      65           0 :   s = format (s, "CACHE: flow_label %d, next index %d",
      66             :               t->flow_label, t->next_index);
      67           0 :   return s;
      68             : }
      69             : 
      70             : #define foreach_cache_error \
      71             : _(RECORDED, "ip6 iOAM headers cached")
      72             : 
      73             : typedef enum
      74             : {
      75             : #define _(sym,str) CACHE_ERROR_##sym,
      76             :   foreach_cache_error
      77             : #undef _
      78             :     CACHE_N_ERROR,
      79             : } cache_error_t;
      80             : 
      81             : static char *cache_error_strings[] = {
      82             : #define _(sym,string) string,
      83             :   foreach_cache_error
      84             : #undef _
      85             : };
      86             : 
      87             : typedef enum
      88             : {
      89             :   IOAM_CACHE_NEXT_POP_HBYH,
      90             :   IOAM_CACHE_N_NEXT,
      91             : } cache_next_t;
      92             : 
      93             : static uword
      94           0 : ip6_ioam_cache_node_fn (vlib_main_t * vm,
      95             :                         vlib_node_runtime_t * node, vlib_frame_t * frame)
      96             : {
      97             :   u32 n_left_from, *from, *to_next;
      98             :   cache_next_t next_index;
      99           0 :   u32 recorded = 0;
     100             : 
     101           0 :   from = vlib_frame_vector_args (frame);
     102           0 :   n_left_from = frame->n_vectors;
     103           0 :   next_index = node->cached_next_index;
     104             : 
     105           0 :   while (n_left_from > 0)
     106             :     {
     107             :       u32 n_left_to_next;
     108             : 
     109           0 :       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
     110             :       // TODO: Dual loop
     111           0 :       while (n_left_from > 0 && n_left_to_next > 0)
     112             :         {
     113             :           u32 bi0;
     114             :           vlib_buffer_t *p0;
     115           0 :           u32 next0 = IOAM_CACHE_NEXT_POP_HBYH;
     116             :           ip6_header_t *ip0;
     117             :           ip6_hop_by_hop_header_t *hbh0;
     118             :           tcp_header_t *tcp0;
     119             :           u32 tcp_offset0;
     120             : 
     121             :           /* speculatively enqueue p0 to the current next frame */
     122           0 :           bi0 = from[0];
     123           0 :           to_next[0] = bi0;
     124           0 :           from += 1;
     125           0 :           to_next += 1;
     126           0 :           n_left_from -= 1;
     127           0 :           n_left_to_next -= 1;
     128             : 
     129           0 :           p0 = vlib_get_buffer (vm, bi0);
     130           0 :           ip0 = vlib_buffer_get_current (p0);
     131           0 :           if (IP_PROTOCOL_TCP ==
     132           0 :               ip6_locate_header (p0, ip0, IP_PROTOCOL_TCP, &tcp_offset0))
     133             :             {
     134           0 :               tcp0 = (tcp_header_t *) ((u8 *) ip0 + tcp_offset0);
     135           0 :               if ((tcp0->flags & TCP_FLAG_SYN) == TCP_FLAG_SYN &&
     136           0 :                   (tcp0->flags & TCP_FLAG_ACK) == 0)
     137             :                 {
     138             :                   /* Cache the ioam hbh header */
     139           0 :                   hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
     140           0 :                   if (0 == ioam_cache_add (p0,
     141             :                                            ip0,
     142           0 :                                            clib_net_to_host_u16
     143           0 :                                            (tcp0->src_port),
     144           0 :                                            clib_net_to_host_u16
     145           0 :                                            (tcp0->dst_port), hbh0,
     146           0 :                                            clib_net_to_host_u32
     147             :                                            (tcp0->seq_number) + 1))
     148             :                     {
     149           0 :                       recorded++;
     150             :                     }
     151             :                 }
     152             :             }
     153           0 :           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
     154             :             {
     155           0 :               if (p0->flags & VLIB_BUFFER_IS_TRACED)
     156             :                 {
     157             :                   cache_trace_t *t =
     158           0 :                     vlib_add_trace (vm, node, p0, sizeof (*t));
     159           0 :                   t->flow_label =
     160           0 :                     clib_net_to_host_u32
     161             :                     (ip0->ip_version_traffic_class_and_flow_label);
     162           0 :                   t->next_index = next0;
     163             :                 }
     164             :             }
     165             :           /* verify speculative enqueue, maybe switch current next frame */
     166           0 :           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
     167             :                                            to_next, n_left_to_next,
     168             :                                            bi0, next0);
     169             :         }
     170             : 
     171           0 :       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
     172             :     }
     173             : 
     174           0 :   vlib_node_increment_counter (vm, ioam_cache_node.index,
     175             :                                CACHE_ERROR_RECORDED, recorded);
     176           0 :   return frame->n_vectors;
     177             : }
     178             : 
     179             : /*
     180             :  * Node for IP6 iOAM header cache
     181             :  */
     182             : /* *INDENT-OFF* */
     183      114668 : VLIB_REGISTER_NODE (ioam_cache_node) =
     184             : {
     185             :   .function = ip6_ioam_cache_node_fn,
     186             :   .name = "ip6-ioam-cache",
     187             :   .vector_size = sizeof (u32),
     188             :   .format_trace = format_cache_trace,
     189             :   .type = VLIB_NODE_TYPE_INTERNAL,
     190             :   .n_errors = ARRAY_LEN (cache_error_strings),
     191             :   .error_strings = cache_error_strings,
     192             :   .n_next_nodes = IOAM_CACHE_N_NEXT,
     193             :   /* edit / add dispositions here */
     194             :   .next_nodes =
     195             :   {
     196             :     [IOAM_CACHE_NEXT_POP_HBYH] = "ip6-pop-hop-by-hop"
     197             :   },
     198             : };
     199             : /* *INDENT-ON* */
     200             : 
     201             : typedef struct
     202             : {
     203             :   u32 next_index;
     204             : } ip6_add_from_cache_hbh_trace_t;
     205             : 
     206             : /* packet trace format function */
     207             : static u8 *
     208           0 : format_ip6_add_from_cache_hbh_trace (u8 * s, va_list * args)
     209             : {
     210           0 :   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
     211           0 :   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
     212           0 :   ip6_add_from_cache_hbh_trace_t *t = va_arg (*args,
     213             :                                               ip6_add_from_cache_hbh_trace_t
     214             :                                               *);
     215             : 
     216           0 :   s = format (s, "IP6_ADD_FROM_CACHE_HBH: next index %d", t->next_index);
     217           0 :   return s;
     218             : }
     219             : 
     220             : #define foreach_ip6_add_from_cache_hbh_error \
     221             : _(PROCESSED, "Pkts w/ added ip6 hop-by-hop options")
     222             : 
     223             : typedef enum
     224             : {
     225             : #define _(sym,str) IP6_ADD_FROM_CACHE_HBH_ERROR_##sym,
     226             :   foreach_ip6_add_from_cache_hbh_error
     227             : #undef _
     228             :     IP6_ADD_FROM_CACHE_HBH_N_ERROR,
     229             : } ip6_add_from_cache_hbh_error_t;
     230             : 
     231             : static char *ip6_add_from_cache_hbh_error_strings[] = {
     232             : #define _(sym,string) string,
     233             :   foreach_ip6_add_from_cache_hbh_error
     234             : #undef _
     235             : };
     236             : 
     237             : #define foreach_ip6_ioam_cache_input_next        \
     238             :   _(IP6_LOOKUP, "ip6-lookup")                   \
     239             :   _(DROP, "error-drop")
     240             : 
     241             : typedef enum
     242             : {
     243             : #define _(s,n) IP6_IOAM_CACHE_INPUT_NEXT_##s,
     244             :   foreach_ip6_ioam_cache_input_next
     245             : #undef _
     246             :     IP6_IOAM_CACHE_INPUT_N_NEXT,
     247             : } ip6_ioam_cache_input_next_t;
     248             : 
     249             : 
     250        2300 : VLIB_NODE_FN (ip6_add_from_cache_hbh_node) (vlib_main_t * vm,
     251             :                                             vlib_node_runtime_t * node,
     252             :                                             vlib_frame_t * frame)
     253             : {
     254           0 :   ioam_cache_main_t *cm = &ioam_cache_main;
     255             :   u32 n_left_from, *from, *to_next;
     256             :   ip_lookup_next_t next_index;
     257           0 :   u32 processed = 0;
     258           0 :   u8 *rewrite = 0;
     259           0 :   u32 rewrite_len = 0;
     260           0 :   u32 sr_rewrite_len = vec_len (cm->sr_rewrite_template);
     261             : 
     262           0 :   from = vlib_frame_vector_args (frame);
     263           0 :   n_left_from = frame->n_vectors;
     264           0 :   next_index = node->cached_next_index;
     265             : 
     266           0 :   while (n_left_from > 0)
     267             :     {
     268             :       u32 n_left_to_next;
     269             : 
     270           0 :       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
     271             :       // TODO: Dual loop
     272           0 :       while (n_left_from > 0 && n_left_to_next > 0)
     273             :         {
     274             :           u32 bi0;
     275             :           vlib_buffer_t *b0;
     276             :           u32 next0;
     277             :           ip6_header_t *ip0;
     278             :           ip6_hop_by_hop_header_t *hbh0;
     279           0 :           ip6_sr_header_t *srh0 = 0;
     280             :           u64 *copy_src0, *copy_dst0;
     281             :           u16 new_l0;
     282             :           tcp_header_t *tcp0;
     283             :           u32 tcp_offset0;
     284           0 :           ioam_cache_entry_t *entry = 0;
     285             : 
     286           0 :           next0 = IP6_IOAM_CACHE_INPUT_NEXT_IP6_LOOKUP;
     287             :           /* speculatively enqueue b0 to the current next frame */
     288           0 :           bi0 = from[0];
     289           0 :           to_next[0] = bi0;
     290           0 :           from += 1;
     291           0 :           to_next += 1;
     292           0 :           n_left_from -= 1;
     293           0 :           n_left_to_next -= 1;
     294             : 
     295           0 :           b0 = vlib_get_buffer (vm, bi0);
     296             : 
     297           0 :           ip0 = vlib_buffer_get_current (b0);
     298           0 :           if (IP_PROTOCOL_TCP !=
     299           0 :               ip6_locate_header (b0, ip0, IP_PROTOCOL_TCP, &tcp_offset0))
     300             :             {
     301           0 :               goto TRACE0;
     302             :             }
     303           0 :           tcp0 = (tcp_header_t *) ((u8 *) ip0 + tcp_offset0);
     304           0 :           if (((tcp0->flags & TCP_FLAG_SYN) == TCP_FLAG_SYN &&
     305           0 :                (tcp0->flags & TCP_FLAG_ACK) == TCP_FLAG_ACK) ||
     306           0 :               (tcp0->flags & TCP_FLAG_RST) == TCP_FLAG_RST)
     307             :             {
     308           0 :               if (0 != (entry = ioam_cache_lookup (ip0,
     309           0 :                                                    clib_net_to_host_u16
     310           0 :                                                    (tcp0->src_port),
     311           0 :                                                    clib_net_to_host_u16
     312           0 :                                                    (tcp0->dst_port),
     313             :                                                    clib_net_to_host_u32
     314             :                                                    (tcp0->ack_number))))
     315             :                 {
     316           0 :                   rewrite = entry->ioam_rewrite_string;
     317           0 :                   rewrite_len = vec_len (rewrite);
     318             :                 }
     319             :               else
     320             :                 {
     321           0 :                   next0 = IP6_IOAM_CACHE_INPUT_NEXT_DROP;
     322           0 :                   goto TRACE0;
     323             :                 }
     324             :             }
     325             :           else
     326           0 :             goto TRACE0;
     327             : 
     328             : 
     329             :           /* Copy the ip header left by the required amount */
     330           0 :           copy_dst0 = (u64 *) (((u8 *) ip0) - (rewrite_len + sr_rewrite_len));
     331           0 :           copy_src0 = (u64 *) ip0;
     332             : 
     333           0 :           copy_dst0[0] = copy_src0[0];
     334           0 :           copy_dst0[1] = copy_src0[1];
     335           0 :           copy_dst0[2] = copy_src0[2];
     336           0 :           copy_dst0[3] = copy_src0[3];
     337           0 :           copy_dst0[4] = copy_src0[4];
     338           0 :           vlib_buffer_advance (b0, -(word) (rewrite_len + sr_rewrite_len));
     339           0 :           ip0 = vlib_buffer_get_current (b0);
     340             : 
     341           0 :           hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
     342           0 :           srh0 = (ip6_sr_header_t *) ((u8 *) hbh0 + rewrite_len);
     343             :           /* $$$ tune, rewrite_len is a multiple of 8 */
     344           0 :           clib_memcpy_fast (hbh0, rewrite, rewrite_len);
     345           0 :           clib_memcpy_fast (srh0, cm->sr_rewrite_template, sr_rewrite_len);
     346             :           /* Copy dst address into the DA slot in the segment list */
     347           0 :           clib_memcpy_fast (srh0->segments, ip0->dst_address.as_u64,
     348             :                             sizeof (ip6_address_t));
     349             :           /* Rewrite the ip6 dst address with the first hop */
     350           0 :           clib_memcpy_fast (ip0->dst_address.as_u64, entry->next_hop.as_u64,
     351             :                             sizeof (ip6_address_t));
     352           0 :           clib_memcpy_fast (&srh0->segments[1],
     353           0 :                             (u8 *) hbh0 + entry->my_address_offset,
     354             :                             sizeof (ip6_address_t));
     355           0 :           ioam_cache_entry_free (entry);
     356             : 
     357             :           /* Patch the protocol chain, insert the h-b-h (type 0) header */
     358           0 :           srh0->protocol = ip0->protocol;
     359           0 :           hbh0->protocol = IPPROTO_IPV6_ROUTE;
     360           0 :           ip0->protocol = 0;
     361           0 :           new_l0 =
     362           0 :             clib_net_to_host_u16 (ip0->payload_length) + rewrite_len +
     363             :             sr_rewrite_len;
     364           0 :           ip0->payload_length = clib_host_to_net_u16 (new_l0);
     365           0 :           processed++;
     366           0 :         TRACE0:
     367           0 :           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
     368             :                              && (b0->flags & VLIB_BUFFER_IS_TRACED)))
     369             :             {
     370             :               ip6_add_from_cache_hbh_trace_t *t =
     371           0 :                 vlib_add_trace (vm, node, b0, sizeof (*t));
     372           0 :               t->next_index = next0;
     373             :             }
     374             : 
     375             :           /* verify speculative enqueue, maybe switch current next frame */
     376           0 :           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
     377             :                                            to_next, n_left_to_next,
     378             :                                            bi0, next0);
     379             :         }
     380             : 
     381           0 :       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
     382             :     }
     383             : 
     384           0 :   vlib_node_increment_counter (vm, cm->ip6_add_from_cache_hbh_node_index,
     385             :                                IP6_ADD_FROM_CACHE_HBH_ERROR_PROCESSED,
     386             :                                processed);
     387           0 :   return frame->n_vectors;
     388             : }
     389             : /* *INDENT-OFF* */
     390      114668 : VLIB_REGISTER_NODE (ip6_add_from_cache_hbh_node) =
     391             : {
     392             :   .name = "ip6-add-from-cache-hop-by-hop",
     393             :   .vector_size = sizeof (u32),
     394             :   .format_trace = format_ip6_add_from_cache_hbh_trace,
     395             :   .type = VLIB_NODE_TYPE_INTERNAL,
     396             :   .n_errors = ARRAY_LEN (ip6_add_from_cache_hbh_error_strings),
     397             :   .error_strings =  ip6_add_from_cache_hbh_error_strings,
     398             :   /* See ip/lookup.h */
     399             :   .n_next_nodes = IP6_IOAM_CACHE_INPUT_N_NEXT,
     400             :   .next_nodes =
     401             :   {
     402             : #define _(s,n) [IP6_IOAM_CACHE_INPUT_NEXT_##s] = n,
     403             :     foreach_ip6_ioam_cache_input_next
     404             : #undef _
     405             :   },
     406             : };
     407             : /* *INDENT-ON* */
     408             : 
     409             : /*
     410             :  * fd.io coding-style-patch-verification: ON
     411             :  *
     412             :  * Local Variables:
     413             :  * eval: (c-set-style "gnu")
     414             :  * End:
     415             :  */

Generated by: LCOV version 1.14