src/plugins/nat/dslite.h

   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 #ifndef __included_dslite_h__
  16 #define __included_dslite_h__
  17
  18 #include <vppinfra/bihash_8_8.h>
  19 #include <vppinfra/bihash_16_8.h>
  20 #include <vppinfra/bihash_24_8.h>
  21 #include <nat/nat.h>
  22
  23 typedef struct
  24 {
  25   union
  26   {
  27     struct
  28     {
  29       ip6_address_t softwire_id;
  30       ip4_address_t addr;
  31       u16 port;
  32       u8 proto;
  33       u8 pad;
  34     };
  35     u64 as_u64[3];
  36   };
  37 } dslite_session_key_t;
  38
  39 /* *INDENT-OFF* */
  40 typedef CLIB_PACKED (struct
  41 {
  42   snat_session_key_t out2in;
  43   dslite_session_key_t in2out;
  44   u32 per_b4_index;
  45   u32 per_b4_list_head_index;
  46   f64 last_heard;
  47   u64 total_bytes;
  48   u32 total_pkts;
  49 }) dslite_session_t;
  50 /* *INDENT-ON* */
  51
  52 typedef struct
  53 {
  54   ip6_address_t addr;
  55   u32 sessions_per_b4_list_head_index;
  56   u32 nsessions;
  57 } dslite_b4_t;
  58
  59 typedef struct
  60 {
  61   /* Main lookup tables */
  62   clib_bihash_8_8_t out2in;
  63   clib_bihash_24_8_t in2out;
  64
  65   /* Find a B4 */
  66   clib_bihash_16_8_t b4_hash;
  67
  68   /* B4 pool */
  69   dslite_b4_t *b4s;
  70
  71   /* Session pool */
  72   dslite_session_t *sessions;
  73
  74   /* Pool of doubly-linked list elements */
  75   dlist_elt_t *list_pool;
  76 } dslite_per_thread_data_t;
  77
  78 typedef struct
  79 {
  80   ip6_address_t aftr_ip6_addr;
  81   ip4_address_t aftr_ip4_addr;
  82   ip6_address_t b4_ip6_addr;
  83   ip4_address_t b4_ip4_addr;
  84   dslite_per_thread_data_t *per_thread_data;
  85   snat_address_t *addr_pool;
  86   u32 num_workers;
  87   u32 first_worker_index;
  88   u16 port_per_thread;
  89
  90   /* counters/gauges */
  91   vlib_simple_counter_main_t total_b4s;
  92   vlib_simple_counter_main_t total_sessions;
  93
  94   /* If set then the DSLite component behaves as CPE/B4
  95    * otherwise it behaves as AFTR */
  96   u8 is_ce;
  97 } dslite_main_t;
  98
  99 typedef struct
 100 {
 101   u32 next_index;
 102   u32 session_index;
 103 } dslite_trace_t;
 104
 105 typedef struct
 106 {
 107   u32 next_index;
 108 } dslite_ce_trace_t;
 109
 110 #define foreach_dslite_error                    \
 111 _(IN2OUT, "valid in2out DS-Lite packets")       \
 112 _(OUT2IN, "valid out2in DS-Lite packets")       \
 113 _(CE_ENCAP, "valid CE encap DS-Lite packets")   \
 114 _(CE_DECAP, "valid CE decap DS-Lite packets")   \
 115 _(NO_TRANSLATION, "no translation")             \
 116 _(BAD_IP6_PROTOCOL, "bad ip6 protocol")         \
 117 _(OUT_OF_PORTS, "out of ports")                 \
 118 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
 119 _(BAD_ICMP_TYPE, "unsupported icmp type")       \
 120 _(UNKNOWN, "unknown")
 121
 122 typedef enum
 123 {
 124 #define _(sym,str) DSLITE_ERROR_##sym,
 125   foreach_dslite_error
 126 #undef _
 127     DSLITE_N_ERROR,
 128 } dslite_error_t;
 129
 130 extern dslite_main_t dslite_main;
 131 extern vlib_node_registration_t dslite_in2out_node;
 132 extern vlib_node_registration_t dslite_in2out_slowpath_node;
 133 extern vlib_node_registration_t dslite_out2in_node;
 134 extern vlib_node_registration_t dslite_ce_encap_node;
 135 extern vlib_node_registration_t dslite_ce_decap_node;
 136
 137 void dslite_init (vlib_main_t * vm);
 138 void dslite_set_ce (dslite_main_t * dm, u8 set);
 139 int dslite_set_aftr_ip6_addr (dslite_main_t * dm, ip6_address_t * addr);
 140 int dslite_set_b4_ip6_addr (dslite_main_t * dm, ip6_address_t * addr);
 141 int dslite_set_aftr_ip4_addr (dslite_main_t * dm, ip4_address_t * addr);
 142 int dslite_set_b4_ip4_addr (dslite_main_t * dm, ip4_address_t * addr);
 143 int dslite_add_del_pool_addr (dslite_main_t * dm, ip4_address_t * addr,
 144                               u8 is_add);
 145 u8 *format_dslite_trace (u8 * s, va_list * args);
 146 u8 *format_dslite_ce_trace (u8 * s, va_list * args);
 147
 148 #endif /* __included_dslite_h__ */
 149
 150 /*
 151  * fd.io coding-style-patch-verification: ON
 152  *
 153  * Local Variables:
 154  * eval: (c-set-style "gnu")
 155  * End:
 156  */