cnat_types.c

Go to the documentation of this file.

/*
 * Copyright (c) 2020 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 <cnat/cnat_types.h>

cnat_main_t cnat_main;
fib_source_t cnat_fib_source;
cnat_timestamp_t *cnat_timestamps;
throttle_t cnat_throttle;

char *cnat_error_strings[] = {
#define cnat_error(n,s) s,
#include <cnat/cnat_error.def>
#undef cnat_error
};

u8
cnat_resolve_addr (u32 sw_if_index, ip_address_family_t af,
                   ip_address_t * addr)
{
  /* Tries to resolve IP from sw_if_index
   * returns 1 if we need to schedule DHCP */
  if (INDEX_INVALID == sw_if_index)
    return 0;
  if (af == AF_IP6)
    {
      ip6_address_t *ip6 = 0;
      ip6 = ip6_interface_first_address (&ip6_main, sw_if_index);
      if (ip6)
        {
          ip_address_set (addr, ip6, AF_IP6);
          return 0;
        }
      else
        return 1;
    }
  else
    {
      ip4_address_t *ip4 = 0;
      ip4 = ip4_interface_first_address (&ip4_main, sw_if_index, 0);
      if (ip4)
        {
          ip_address_set (addr, ip4, AF_IP4);
          return 0;
        }
      else
        return 1;
    }
}

u8
cnat_resolve_ep (cnat_endpoint_t * ep)
{
  int rv;
  rv = cnat_resolve_addr (ep->ce_sw_if_index, ep->ce_ip.version, &ep->ce_ip);
  if (0 == rv)
    ep->ce_flags |= CNAT_EP_FLAG_RESOLVED;
  return rv;
}

uword
unformat_cnat_ep (unformat_input_t * input, va_list * args)
{
  cnat_endpoint_t *a = va_arg (*args, cnat_endpoint_t *);
  vnet_main_t *vnm = vnet_get_main ();
  int port = 0;

  clib_memset (a, 0, sizeof (*a));
  a->ce_sw_if_index = INDEX_INVALID;
  if (unformat (input, "%U %d", unformat_ip_address, &a->ce_ip, &port))
    ;
  else if (unformat_user (input, unformat_ip_address, &a->ce_ip))
    ;
  else if (unformat (input, "%U v6 %d", unformat_vnet_sw_interface,
                     vnm, &a->ce_sw_if_index, &port))
    a->ce_ip.version = AF_IP6;
  else if (unformat (input, "%U v6", unformat_vnet_sw_interface,
                     vnm, &a->ce_sw_if_index))
    a->ce_ip.version = AF_IP6;
  else if (unformat (input, "%U %d", unformat_vnet_sw_interface,
                     vnm, &a->ce_sw_if_index, &port))
    a->ce_ip.version = AF_IP4;
  else if (unformat_user (input, unformat_vnet_sw_interface,
                          vnm, &a->ce_sw_if_index))
    a->ce_ip.version = AF_IP4;
  else if (unformat (input, "%d", &port))
    ;
  else
    return 0;
  a->ce_port = (u16) port;
  return 1;
}

uword
unformat_cnat_ep_tuple (unformat_input_t * input, va_list * args)
{
  cnat_endpoint_tuple_t *a = va_arg (*args, cnat_endpoint_tuple_t *);
  if (unformat (input, "%U->%U", unformat_cnat_ep, &a->src_ep,
                unformat_cnat_ep, &a->dst_ep))
    ;
  else if (unformat (input, "->%U", unformat_cnat_ep, &a->dst_ep))
    ;
  else if (unformat (input, "%U->", unformat_cnat_ep, &a->src_ep))
    ;
  else
    return 0;
  return 1;
}

u8 *
format_cnat_endpoint (u8 * s, va_list * args)
{
  cnat_endpoint_t *cep = va_arg (*args, cnat_endpoint_t *);
  vnet_main_t *vnm = vnet_get_main ();
  if (INDEX_INVALID == cep->ce_sw_if_index)
    s = format (s, "%U;%d", format_ip_address, &cep->ce_ip, cep->ce_port);
  else
    {
      if (cep->ce_flags & CNAT_EP_FLAG_RESOLVED)
        s = format (s, "%U (%U);%d", format_vnet_sw_if_index_name, vnm,
                    cep->ce_sw_if_index, format_ip_address, &cep->ce_ip,
                    cep->ce_port);
      else
        s =
          format (s, "%U (%U);%d", format_vnet_sw_if_index_name, vnm,
                  cep->ce_sw_if_index, format_ip_address_family,
                  cep->ce_ip.version, cep->ce_port);
    }
  return (s);
}

static clib_error_t *
cnat_types_init (vlib_main_t * vm)
{
  vlib_thread_main_t *tm = &vlib_thread_main;
  u32 n_vlib_mains = tm->n_vlib_mains;
  cnat_fib_source = fib_source_allocate ("cnat",
                                         CNAT_FIB_SOURCE_PRIORITY,
                                         FIB_SOURCE_BH_SIMPLE);


  clib_rwlock_init (&cnat_main.ts_lock);
  throttle_init (&cnat_throttle, n_vlib_mains, 1e-3);

  return (NULL);
}

void
cnat_enable_disable_scanner (cnat_scanner_cmd_t event_type)
{
  vlib_main_t *vm = vlib_get_main ();
  vlib_process_signal_event (vm, cnat_main.scanner_node_index, event_type, 0);
}

void
cnat_lazy_init ()
{
  cnat_main_t *cm = &cnat_main;
  if (cm->lazy_init_done)
    return;
  cnat_enable_disable_scanner (cm->default_scanner_state);
  cm->lazy_init_done = 1;
}

static clib_error_t *
cnat_config (vlib_main_t * vm, unformat_input_t * input)
{
  cnat_main_t *cm = &cnat_main;

  cm->session_hash_memory = CNAT_DEFAULT_SESSION_MEMORY;
  cm->session_hash_buckets = CNAT_DEFAULT_SESSION_BUCKETS;
  cm->translation_hash_memory = CNAT_DEFAULT_TRANSLATION_MEMORY;
  cm->translation_hash_buckets = CNAT_DEFAULT_TRANSLATION_BUCKETS;
  cm->snat_hash_memory = CNAT_DEFAULT_SNAT_MEMORY;
  cm->snat_hash_buckets = CNAT_DEFAULT_SNAT_BUCKETS;
  cm->scanner_timeout = CNAT_DEFAULT_SCANNER_TIMEOUT;
  cm->session_max_age = CNAT_DEFAULT_SESSION_MAX_AGE;
  cm->tcp_max_age = CNAT_DEFAULT_TCP_MAX_AGE;
  cm->default_scanner_state = CNAT_SCANNER_ON;
  cm->lazy_init_done = 0;

  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat
          (input, "session-db-buckets %u", &cm->session_hash_buckets))
        ;
      else if (unformat (input, "session-db-memory %U",
                         unformat_memory_size, &cm->session_hash_memory))
        ;
      else if (unformat (input, "translation-db-buckets %u",
                         &cm->translation_hash_buckets))
        ;
      else if (unformat (input, "translation-db-memory %U",
                         unformat_memory_size, &cm->translation_hash_memory))
        ;
      else if (unformat (input, "snat-db-buckets %u", &cm->snat_hash_buckets))
        ;
      else if (unformat (input, "snat-db-memory %U",
                         unformat_memory_size, &cm->snat_hash_memory))
        ;
      else if (unformat (input, "session-cleanup-timeout %f",
                         &cm->scanner_timeout))
        ;
      else if (unformat (input, "scanner off"))
        cm->default_scanner_state = CNAT_SCANNER_OFF;
      else if (unformat (input, "scanner on"))
        cm->default_scanner_state = CNAT_SCANNER_ON;
      else if (unformat (input, "session-max-age %u", &cm->session_max_age))
        ;
      else if (unformat (input, "tcp-max-age %u", &cm->tcp_max_age))
        ;
      else
        return clib_error_return (0, "unknown input '%U'",
                                  format_unformat_error, input);
    }

  return 0;
}

cnat_main_t *
cnat_get_main ()
{
  return &cnat_main;
}

VLIB_EARLY_CONFIG_FUNCTION (cnat_config, "cnat");
VLIB_INIT_FUNCTION (cnat_types_init);

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