src/plugins/cnat/cnat_types.h

   1 /*
   2  * Copyright (c) 2020 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 #ifndef __CNAT_TYPES_H__
  17 #define __CNAT_TYPES_H__
  18
  19 #include <vppinfra/bihash_24_8.h>
  20 #include <vnet/fib/fib_node.h>
  21 #include <vnet/fib/fib_source.h>
  22 #include <vnet/ip/ip_types.h>
  23 #include <vnet/ip/ip.h>
  24 #include <vnet/util/throttle.h>
  25
  26 /* only in the default table for v4 and v6 */
  27 #define CNAT_FIB_TABLE 0
  28
  29 /* default lifetime of NAT sessions (seconds) */
  30 #define CNAT_DEFAULT_SESSION_MAX_AGE 30
  31 /* lifetime of TCP conn NAT sessions after SYNACK (seconds) */
  32 #define CNAT_DEFAULT_TCP_MAX_AGE 3600
  33 /* lifetime of TCP conn NAT sessions after RST/FIN (seconds) */
  34 #define CNAT_DEFAULT_TCP_RST_TIMEOUT 5
  35 #define CNAT_DEFAULT_SCANNER_TIMEOUT (1.0)
  36
  37 #define CNAT_DEFAULT_SESSION_BUCKETS     1024
  38 #define CNAT_DEFAULT_TRANSLATION_BUCKETS 1024
  39 #define CNAT_DEFAULT_SNAT_BUCKETS        1024
  40 #define CNAT_DEFAULT_SNAT_IF_MAP_LEN     4096
  41
  42 #define CNAT_DEFAULT_SESSION_MEMORY      (1 << 20)
  43 #define CNAT_DEFAULT_TRANSLATION_MEMORY  (256 << 10)
  44 #define CNAT_DEFAULT_SNAT_MEMORY         (64 << 20)
  45
  46 /* Should be prime >~ 100 * numBackends */
  47 #define CNAT_DEFAULT_MAGLEV_LEN 1009
  48
  49 /* This should be strictly lower than FIB_SOURCE_INTERFACE
  50  * from fib_source.h */
  51 #define CNAT_FIB_SOURCE_PRIORITY  0x02
  52
  53 /* Initial refcnt for timestamps (2 : session & rsession) */
  54 #define CNAT_TIMESTAMP_INIT_REFCNT 2
  55
  56 #define MIN_SRC_PORT ((u16) 0xC000)
  57
  58 typedef enum cnat_trk_flag_t_
  59 {
  60   /* Endpoint is active (static or dhcp resolved) */
  61   CNAT_TRK_ACTIVE = (1 << 0),
  62   /* Don't translate this endpoint, but still
  63    * forward. Used by maglev for DSR */
  64   CNAT_TRK_FLAG_NO_NAT = (1 << 1),
  65   /* */
  66   CNAT_TRK_FLAG_TEST_DISABLED = (1 << 7),
  67 } cnat_trk_flag_t;
  68
  69 typedef enum
  70 {
  71   /* Endpoint addr has been resolved */
  72   CNAT_EP_FLAG_RESOLVED = (1 << 0),
  73 } cnat_ep_flag_t;
  74
  75 typedef struct cnat_endpoint_t_
  76 {
  77   ip_address_t ce_ip;
  78   u32 ce_sw_if_index;
  79   u16 ce_port;
  80   u8 ce_flags;
  81 } cnat_endpoint_t;
  82
  83 typedef struct cnat_endpoint_tuple_t_
  84 {
  85   cnat_endpoint_t dst_ep;
  86   cnat_endpoint_t src_ep;
  87   u8 ep_flags; /* cnat_trk_flag_t */
  88 } cnat_endpoint_tuple_t;
  89
  90 typedef struct
  91 {
  92   u16 identifier;
  93   u16 sequence;
  94 } cnat_echo_header_t;
  95
  96 typedef struct cnat_main_
  97 {
  98   /* Memory size of the session bihash */
  99   uword session_hash_memory;
 100
 101   /* Number of buckets of the  session bihash */
 102   u32 session_hash_buckets;
 103
 104   /* Memory size of the translation bihash */
 105   uword translation_hash_memory;
 106
 107   /* Number of buckets of the  translation bihash */
 108   u32 translation_hash_buckets;
 109
 110   /* Memory size of the source NAT prefix bihash */
 111   uword snat_hash_memory;
 112
 113   /* Number of buckets of the  source NAT prefix bihash */
 114   u32 snat_hash_buckets;
 115
 116   /* Bit map for include / exclude sw_if_index
 117    * so max number of expected interfaces */
 118   u32 snat_if_map_length;
 119
 120   /* Timeout after which to clear sessions (in seconds) */
 121   u32 session_max_age;
 122
 123   /* Timeout after which to clear an established TCP
 124    * session (in seconds) */
 125   u32 tcp_max_age;
 126
 127   /* delay in seconds between two scans of session/clients tables */
 128   f64 scanner_timeout;
 129
 130   /* Lock for the timestamp pool */
 131   clib_rwlock_t ts_lock;
 132
 133   /* Index of the scanner process node */
 134   uword scanner_node_index;
 135
 136   /* Did we do lazy init ? */
 137   u8 lazy_init_done;
 138
 139   /* Enable or Disable the scanner on startup */
 140   u8 default_scanner_state;
 141
 142   /* Number of buckets for maglev, should be a
 143    * prime >= 100 * max num bakends */
 144   u32 maglev_len;
 145 } cnat_main_t;
 146
 147 typedef struct cnat_timestamp_t_
 148 {
 149   /* Last time said session was seen */
 150   f64 last_seen;
 151   /* expire after N seconds */
 152   u16 lifetime;
 153   /* Users refcount, initially 3 (session, rsession, dpo) */
 154   u16 refcnt;
 155 } cnat_timestamp_t;
 156
 157 typedef struct cnat_node_ctx_
 158 {
 159   f64 now;
 160   u32 thread_index;
 161   ip_address_family_t af;
 162   u8 do_trace;
 163 } cnat_node_ctx_t;
 164
 165 cnat_main_t *cnat_get_main ();
 166 extern u8 *format_cnat_endpoint (u8 * s, va_list * args);
 167 extern uword unformat_cnat_ep_tuple (unformat_input_t * input,
 168                                      va_list * args);
 169 extern uword unformat_cnat_ep (unformat_input_t * input, va_list * args);
 170 extern cnat_timestamp_t *cnat_timestamps;
 171 extern fib_source_t cnat_fib_source;
 172 extern cnat_main_t cnat_main;
 173
 174 extern char *cnat_error_strings[];
 175
 176 typedef enum
 177 {
 178 #define cnat_error(n,s) CNAT_ERROR_##n,
 179 #include <cnat/cnat_error.def>
 180 #undef cnat_error
 181   CNAT_N_ERROR,
 182 } cnat_error_t;
 183
 184 typedef enum cnat_scanner_cmd_t_
 185 {
 186   CNAT_SCANNER_OFF,
 187   CNAT_SCANNER_ON,
 188 } cnat_scanner_cmd_t;
 189
 190 /**
 191  * Lazy initialization when first adding a translation
 192  * or using snat
 193  */
 194 extern void cnat_lazy_init ();
 195
 196 /**
 197  * Enable/Disable session cleanup
 198  */
 199 extern void cnat_enable_disable_scanner (cnat_scanner_cmd_t event_type);
 200
 201 /**
 202  * Resolve endpoint address
 203  */
 204 extern u8 cnat_resolve_ep (cnat_endpoint_t * ep);
 205 extern u8 cnat_resolve_addr (u32 sw_if_index, ip_address_family_t af,
 206                              ip_address_t * addr);
 207
 208
 209 /*
 210  * fd.io coding-style-patch-verification: ON
 211  *
 212  * Local Variables:
 213  * eval: (c-set-style "gnu")
 214  * End:
 215  */
 216
 217 #endif