path: root/hicn-plugin/src/interest_hitpit_node.c

/*
 * Copyright (c) 2021 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <vnet/ip/ip6_packet.h>

#include "interest_hitpit.h"
#include "mgmt.h"
#include "parser.h"
#include "data_fwd.h"
#include "infra.h"
#include "strategy.h"
#include "strategy_dpo_ctx.h"
#include "strategy_dpo_manager.h"
#include "state.h"
#include "error.h"

/* packet trace format function */
static u8 *hicn_interest_hitpit_format_trace (u8 *s, va_list *args);

/* Stats string values */
static char *hicn_interest_hitpit_error_strings[] = {
#define _(sym, string) string,
  foreach_hicnfwd_error
#undef _
};

vlib_node_registration_t hicn_interest_hitpit_node;

always_inline void drop_packet (u32 *next0);

/*
 * hICN forwarder node for interests hitting the PIT
 */
static uword
hicn_interest_hitpit_node_fn (vlib_main_t *vm, vlib_node_runtime_t *node,
			      vlib_frame_t *frame)
{
  int ret;
  u32 n_left_from, *from, *to_next;
  hicn_interest_hitpit_next_t next_index;
  hicn_interest_hitpit_runtime_t *rt;
  vl_api_hicn_api_node_stats_get_reply_t stats = { 0 };
  f64 tnow;
  u32 n_left_to_next;
  vlib_buffer_t *b0;
  u8 isv6;
  u32 bi0;
  u32 next0 = HICN_INTEREST_HITPIT_NEXT_ERROR_DROP;
  const hicn_strategy_vft_t *strategy_vft0;
  const hicn_dpo_vft_t *dpo_vft0;
  u8 dpo_ctx_id0;
  u8 found = 0;
  hicn_face_id_t outfaces[MAX_OUT_FACES];
  u32 clones[MAX_OUT_FACES];
  u16 outfaces_len;
  u32 pit_entry_index;
  hicn_pcs_entry_t *pcs_entry = NULL;
  hicn_buffer_t *hicnb0;

  rt = vlib_node_get_runtime_data (vm, hicn_interest_hitpit_node.index);

  if (PREDICT_FALSE (rt->pitcs == NULL))
    {
      rt->pitcs = &hicn_main.pitcs;
    }
  from = vlib_frame_vector_args (frame);
  n_left_from = frame->n_vectors;
  next_index = node->cached_next_index;

  /* Capture time in vpp terms */
  tnow = vlib_time_now (vm);

  while (n_left_from > 0)
    {
      vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
      while (n_left_from > 0 && n_left_to_next > 0)
	{
	  /* Prefetch for next iteration. */
	  if (n_left_from > 1)
	    {
	      vlib_buffer_t *b1;
	      b1 = vlib_get_buffer (vm, from[1]);
	      CLIB_PREFETCH (b1, CLIB_CACHE_LINE_BYTES, LOAD);
	    }

	  /* Dequeue a packet buffer */
	  bi0 = from[0];
	  from += 1;
	  n_left_from -= 1;
	  to_next[0] = bi0;
	  to_next += 1;
	  n_left_to_next -= 1;

	  b0 = vlib_get_buffer (vm, bi0);

	  /* Get hicn buffer and state */
	  hicnb0 = hicn_get_buffer (b0);
	  hicn_get_internal_state (hicnb0, &pit_entry_index, &strategy_vft0,
				   &dpo_vft0, &dpo_ctx_id0);

	  // Retrieve PIT entry
	  pcs_entry =
	    hicn_pcs_entry_get_entry_from_index (rt->pitcs, pit_entry_index);

	  isv6 = hicn_buffer_is_v6 (b0);

	  // Increment packet counter
	  stats.pkts_processed += 1;

	  // If the entry is expired, remove it no matter of the possible
	  // cases.
	  if (tnow > hicn_pcs_entry_get_expire_time (pcs_entry))
	    {
	      // Notify strategy
	      strategy_vft0->hicn_on_interest_timeout (dpo_ctx_id0);

	      // Release lock on entry - this MUST delete the entry
	      hicn_pcs_entry_remove_lock (rt->pitcs, pcs_entry);

	      stats.pit_expired_count++;

	      // Forward to strategy node
	      // TODO this can be simplified by checking directly in the
	      // pcslookup node!
	      next0 = HICN_INTEREST_HITPIT_NEXT_STRATEGY;
	    }
	  else
	    {
	      // A data packet may have arrived in the time between the pcs
	      // lookup and now. Check again to make sure the entry is CS or
	      // PIT
	      if (hicn_pcs_entry_is_cs (pcs_entry))
		{
		  next0 = HICN_INTEREST_HITPIT_NEXT_INTEREST_HITCS;
		}
	      else
		{
		  // Distinguish between aggregation or retransmission
		  found =
		    hicn_pcs_entry_pit_search (pcs_entry, hicnb0->face_id);

		  if (found && hicnb0->payload_type != HPT_MANIFEST)
		    {
		      // Retransmission
		      strategy_vft0->hicn_select_next_hop (
			dpo_ctx_id0, outfaces, &outfaces_len);

		      // Prepare the packet for the forwarding
		      next0 = isv6 ? HICN_INTEREST_HITPIT_NEXT_FACE6_OUTPUT :
					   HICN_INTEREST_HITPIT_NEXT_FACE4_OUTPUT;

		      // Update stats
		      stats.interests_retx += outfaces_len;

		      // Clone interest if needed
		      if (outfaces_len > 1)
			{
			  ret = vlib_buffer_clone (vm, bi0, clones,
						   (u16) outfaces_len,
						   CLIB_CACHE_LINE_BYTES * 2);
			  ASSERT (ret == outfaces_len);
			}
		      else
			{
			  clones[0] = bi0;
			}

		      // We need to clone the packet over multiple output
		      // faces

		      // Restore pointers
		      to_next -= 1;
		      n_left_to_next += 1;

		      for (u32 nh = 0; nh < outfaces_len; nh++)
			{
			  vlib_buffer_t *local_b0 =
			    vlib_get_buffer (vm, clones[nh]);
			  to_next[0] = clones[nh];
			  to_next += 1;
			  n_left_to_next -= 1;

			  vnet_buffer (local_b0)->ip.adj_index[VLIB_TX] =
			    outfaces[nh];

			  /* Maybe trace */
			  if (PREDICT_FALSE (
				(node->flags & VLIB_NODE_FLAG_TRACE) &&
				(local_b0->flags & VLIB_BUFFER_IS_TRACED)))
			    {
			      hicn_interest_hitpit_trace_t *t =
				vlib_add_trace (vm, node, local_b0,
						sizeof (*t));
			      t->pkt_type = HICN_PACKET_TYPE_INTEREST;
			      t->sw_if_index =
				vnet_buffer (local_b0)->sw_if_index[VLIB_RX];
			      t->next_index = next0;
			    }

			  /*
			   * Verify speculative enqueue, maybe switch
			   * current next frame
			   */
			  vlib_validate_buffer_enqueue_x1 (
			    vm, node, next_index, to_next, n_left_to_next,
			    clones[nh], next0);
			}
		      continue;
		    }
		  else
		    {
		      // Aggregation
		      hicn_pcs_entry_pit_add_face (pcs_entry, hicnb0->face_id);

		      /* Aggregation */
		      drop_packet (&next0);
		      stats.interests_aggregated++;

		      /* Maybe trace */
		      if (PREDICT_FALSE (
			    (node->flags & VLIB_NODE_FLAG_TRACE) &&
			    (b0->flags & VLIB_BUFFER_IS_TRACED)))
			{
			  hicn_interest_hitpit_trace_t *t =
			    vlib_add_trace (vm, node, b0, sizeof (*t));
			  t->pkt_type = HICN_PACKET_TYPE_INTEREST;
			  t->sw_if_index =
			    vnet_buffer (b0)->sw_if_index[VLIB_RX];
			  t->next_index = next0;
			}
		    }
		}
	    }

	  /*
	   * Verify speculative enqueue, maybe switch current
	   * next frame
	   */
	  vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
					   n_left_to_next, bi0, next0);
	}
      vlib_put_next_frame (vm, node, next_index, n_left_to_next);
    }
  u32 pit_int_count = hicn_pcs_get_pit_count (rt->pitcs);

  vlib_node_increment_counter (vm, hicn_interest_hitpit_node.index,
			       HICNFWD_ERROR_PROCESSED, stats.pkts_processed);
  vlib_node_increment_counter (vm, hicn_interest_hitpit_node.index,
			       HICNFWD_ERROR_INTEREST_AGG,
			       stats.interests_aggregated);
  vlib_node_increment_counter (vm, hicn_interest_hitpit_node.index,
			       HICNFWD_ERROR_INT_RETRANS,
			       stats.interests_retx);
  vlib_node_increment_counter (vm, hicn_interest_hitpit_node.index,
			       HICNFWD_ERROR_PIT_EXPIRED,
			       stats.pit_expired_count);
  vlib_node_increment_counter (vm, hicn_interest_hitpit_node.index,
			       HICNFWD_ERROR_HASH_COLL_HASHTB_COUNT,
			       stats.interests_hash_collision);

  update_node_counter (vm, hicn_interest_hitpit_node.index,
		       HICNFWD_ERROR_INT_COUNT, pit_int_count);

  return (frame->n_vectors);
}

/* packet trace format function */
static u8 *
hicn_interest_hitpit_format_trace (u8 *s, va_list *args)
{
  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  hicn_interest_hitpit_trace_t *t =
    va_arg (*args, hicn_interest_hitpit_trace_t *);

  s = format (s, "INTEREST-HITPIT: pkt: %d, sw_if_index %d, next index %d",
	      (int) t->pkt_type, t->sw_if_index, t->next_index);
  return (s);
}

void
drop_packet (u32 *next0)
{
  *next0 = HICN_INTEREST_HITPIT_NEXT_ERROR_DROP;
}

/*
 * Node registration for the interest forwarder node
 */
VLIB_REGISTER_NODE(hicn_interest_hitpit_node) =
{
  .function = hicn_interest_hitpit_node_fn,
  .name = "hicn-interest-hitpit",
  .vector_size = sizeof(u32),
  .runtime_data_bytes = sizeof(hicn_interest_hitpit_runtime_t),
  .format_trace = hicn_interest_hitpit_format_trace,
  .type = VLIB_NODE_TYPE_INTERNAL,
  .n_errors = ARRAY_LEN(hicn_interest_hitpit_error_strings),
  .error_strings = hicn_interest_hitpit_error_strings,
  .n_next_nodes = HICN_INTEREST_HITPIT_N_NEXT,
  /* edit / add dispositions here */
  .next_nodes =
  {
    [HICN_INTEREST_HITPIT_NEXT_INTEREST_HITCS] = "hicn-interest-hitcs",
    [HICN_INTEREST_HITPIT_NEXT_STRATEGY] = "hicn-strategy",
    [HICN_INTEREST_HITPIT_NEXT_FACE4_OUTPUT] = "hicn4-face-output",
    [HICN_INTEREST_HITPIT_NEXT_FACE6_OUTPUT] = "hicn6-face-output",
    [HICN_INTEREST_HITPIT_NEXT_ERROR_DROP] = "error-drop",
  },
};

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables: eval: (c-set-style "gnu") End:
 */