src/plugins/nat/nat66/nat66.h

   1 /*
   2  * Copyright (c) 2018 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  * @file
  17  * @brief NAT66 global declarations
  18  */
  19 #ifndef __included_nat66_h__
  20 #define __included_nat66_h__
  21
  22 #include <vnet/ip/ip.h>
  23 #include <vnet/fib/fib_table.h>
  24 #include <vppinfra/bihash_24_8.h>
  25
  26 typedef struct
  27 {
  28   ip6_address_t l_addr;
  29   ip6_address_t e_addr;
  30   u32 fib_index;
  31 } nat66_static_mapping_t;
  32
  33 typedef struct
  34 {
  35   union
  36   {
  37     struct
  38     {
  39       ip6_address_t addr;
  40       u32 fib_index;
  41       u32 rsvd;
  42     };
  43     u64 as_u64[3];
  44   };
  45 } nat66_sm_key_t;
  46
  47 typedef struct
  48 {
  49   u32 sw_if_index;
  50   u8 flags;
  51 } nat66_interface_t;
  52
  53 #define NAT66_INTERFACE_FLAG_IS_INSIDE 1
  54 #define NAT66_INTERFACE_FLAG_IS_OUTSIDE 2
  55 #define nat66_interface_is_inside(i) i->flags & NAT66_INTERFACE_FLAG_IS_INSIDE
  56 #define nat66_interface_is_outside(i) i->flags & NAT66_INTERFACE_FLAG_IS_OUTSIDE
  57
  58 typedef struct
  59 {
  60   /** Interface pool */
  61   nat66_interface_t *interfaces;
  62   /** Static mapping pool */
  63   nat66_static_mapping_t *sm;
  64   /** Static mapping by local address lookup table */
  65   clib_bihash_24_8_t sm_l;
  66   /** Static mapping by external address lookup table */
  67   clib_bihash_24_8_t sm_e;
  68   /** Session counters */
  69   vlib_combined_counter_main_t session_counters;
  70
  71   u32 outside_vrf_id;
  72   u32 outside_fib_index;
  73   fib_source_t nat_fib_src_hi;
  74
  75   u16 msg_id_base;
  76   u8 log_level;
  77
  78   u8 enabled;
  79
  80   vlib_simple_counter_main_t in2out_packets;
  81   vlib_simple_counter_main_t out2in_packets;;
  82 } nat66_main_t;
  83
  84 #define nat66_elog(_level, _str)                         \
  85 do                                                       \
  86   {                                                      \
  87     nat66_main_t *nm = &nat66_main;                      \
  88     if (PREDICT_FALSE (nm->log_level >= _level))         \
  89       {                                                  \
  90         ELOG_TYPE_DECLARE (e) =                          \
  91           {                                              \
  92             .format = "nat66-msg " _str,                 \
  93             .format_args = "",                           \
  94           };                                             \
  95         ELOG_DATA (&vlib_global_main.elog_main, e);      \
  96       }                                                  \
  97   } while (0);
  98
  99 #define nat66_elog_warn(nat_elog_str) \
 100   nat66_elog(0x02, "[warning] " nat_elog_str)
 101
 102
 103 extern nat66_main_t nat66_main;
 104 extern vlib_node_registration_t nat66_in2out_node;
 105 extern vlib_node_registration_t nat66_out2in_node;
 106
 107 typedef int (*nat66_interface_walk_fn_t) (nat66_interface_t * i, void *ctx);
 108 void nat66_interfaces_walk (nat66_interface_walk_fn_t fn, void *ctx);
 109 int nat66_interface_add_del (u32 sw_if_index, u8 is_inside, u8 is_add);
 110 typedef int (*nat66_static_mapping_walk_fn_t) (nat66_static_mapping_t * sm,
 111                                                void *ctx);
 112 void nat66_static_mappings_walk (nat66_static_mapping_walk_fn_t fn,
 113                                  void *ctx);
 114 nat66_static_mapping_t *nat66_static_mapping_get (ip6_address_t * addr,
 115                                                   u32 fib_index, u8 is_local);
 116 int nat66_static_mapping_add_del (ip6_address_t * l_addr,
 117                                   ip6_address_t * e_addr, u32 vrf_id,
 118                                   u8 is_add);
 119 int nat66_plugin_enable (u32 outside_vrf);
 120 int nat66_plugin_disable ();
 121
 122 #endif /* __included_nat66_h__ */
 123
 124 /*
 125  * fd.io coding-style-patch-verification: ON
 126  *
 127  * Local Variables:
 128  * eval: (c-set-style "gnu")
 129  * End:
 130  */