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