/*
 * Copyright (c) 2015 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.
 */
#ifndef __included_srv6_ad_flow_h__
#define __included_srv6_ad_flow_h__

#include <vnet/vnet.h>
#include <vnet/ip/ip.h>
#include <vnet/srv6/sr.h>
#include <vnet/srv6/sr_packet.h>

#include <vppinfra/error.h>
#include <vppinfra/elog.h>

#include <vppinfra/dlist.h>
#include <vppinfra/bihash_40_8.h>

#define AD_TYPE_IP4 IP_PROTOCOL_IP_IN_IP
#define AD_TYPE_IP6 IP_PROTOCOL_IPV6

#define SRV6_AD_FLOW_DEFAULT_CACHE_SIZE 100
#define SRV6_AD_CACHE_TIMEOUT		300

/*
 * Cache entries
 */
typedef struct
{
  /* Cache key (5-tuple) */
  struct
  {
    ip46_address_t s_addr;
    ip46_address_t d_addr;
    u8 proto;
    u16 s_port;
    u16 d_port;
  } key;

  /* Cached encapsulation headers */
  u32 rw_len;
  u8 *rw_data;

  /* Index in global LRU list */
  u32 lru_index;

  /* Last update timestamp */
  f64 last_lru_update;

  /* Last heard timestamp */
  f64 last_heard;
} srv6_ad_flow_entry_t;

/*
 * This is the memory that will be stored per each localsid
 * the user instantiates
 */
typedef struct
{
  ip46_address_t nh_addr; /**< Proxied device address */
  u32 sw_if_index_out;	  /**< Outgoing iface to proxied dev. */
  u32 nh_adj;		  /**< Adjacency index for out. iface */
  u8 inner_type;

  u32 sw_if_index_in; /**< Incoming iface from proxied dev. */

  u32 cache_size;
  u32 cache_buckets;
  uword cache_memory_size;

  clib_bihash_40_8_t ftable;   /**< Flow table */
  srv6_ad_flow_entry_t *cache; /**< Cache table */
  dlist_elt_t *lru_pool;
  u32 lru_head_index;

  u32 index;
} srv6_ad_flow_localsid_t;

typedef struct
{
  u16 msg_id_base; /**< API message ID base */

  vlib_main_t *vlib_main; /**< [convenience] vlib main */
  vnet_main_t *vnet_main; /**< [convenience] vnet main */

  dpo_type_t srv6_ad_flow_dpo_type; /**< DPO type */

  u32 srv6_localsid_behavior_id; /**< SRv6 LocalSID behavior number */

  u32 *sw_iface_localsid2; /**< Retrieve local SID from iface */
  u32 *sw_iface_localsid4; /**< Retrieve local SID from iface */
  u32 *sw_iface_localsid6; /**< Retrieve local SID from iface */

  srv6_ad_flow_localsid_t **sids; /**< Pool of AD SID pointers */

  vlib_combined_counter_main_t
    sid_bypass_counters; /**< Packets/bytes bypassing NF */
  vlib_combined_counter_main_t sid_punt_counters; /**< Packets/bytes punted */
  vlib_combined_counter_main_t sid_cache_full_counters;

  vlib_combined_counter_main_t
    rw_valid_counters; /**< Valid rewrite counters */
  vlib_combined_counter_main_t
    rw_invalid_counters; /**< Invalid rewrite counters */
} srv6_ad_flow_main_t;

typedef struct
{
  srv6_ad_flow_localsid_t *ls;
  f64 now;
} srv6_ad_is_idle_entry_ctx_t;

extern srv6_ad_flow_main_t srv6_ad_flow_main;

format_function_t format_srv6_ad_flow_localsid;
unformat_function_t unformat_srv6_ad_flow_localsid;

void srv6_ad_flow_dpo_lock (dpo_id_t *dpo);
void srv6_ad_flow_dpo_unlock (dpo_id_t *dpo);

extern vlib_node_registration_t srv6_ad_flow_localsid_node;

#endif /* __included_srv6_ad_flow_h__ */

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