src/plugins/nat/nat64.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 /**
  16  * @file
  17  * @brief NAT64 global declarations
  18  */
  19 #ifndef __included_nat64_h__
  20 #define __included_nat64_h__
  21
  22 #include <nat/nat.h>
  23 #include <nat/nat64_db.h>
  24
  25 #define foreach_nat64_tcp_ses_state            \
  26   _(0, CLOSED, "closed")                       \
  27   _(1, V4_INIT, "v4-init")                     \
  28   _(2, V6_INIT, "v6-init")                     \
  29   _(3, ESTABLISHED, "established")             \
  30   _(4, V4_FIN_RCV, "v4-fin-rcv")               \
  31   _(5, V6_FIN_RCV, "v6-fin-rcv")               \
  32   _(6, V6_FIN_V4_FIN_RCV, "v6-fin-v4-fin-rcv") \
  33   _(7, TRANS, "trans")
  34
  35 typedef enum
  36 {
  37 #define _(v, N, s) NAT64_TCP_STATE_##N = v,
  38   foreach_nat64_tcp_ses_state
  39 #undef _
  40 } nat64_tcp_ses_state_t;
  41
  42 typedef enum
  43 {
  44   NAT64_CLEANER_RESCHEDULE = 1,
  45 } nat64_cleaner_process_event_e;
  46
  47 typedef struct
  48 {
  49   ip6_address_t prefix;
  50   u8 plen;
  51   u32 vrf_id;
  52   u32 fib_index;
  53 } nat64_prefix_t;
  54
  55 typedef struct
  56 {
  57   ip6_address_t in_addr;
  58   u16 in_port;
  59   ip4_address_t out_addr;
  60   u16 out_port;
  61   u32 fib_index;
  62   u32 thread_index;
  63   u8 proto;
  64   u8 is_add;
  65   u8 done;
  66 } nat64_static_bib_to_update_t;
  67
  68 typedef struct
  69 {
  70   /** Interface pool */
  71   snat_interface_t *interfaces;
  72
  73   /** Address pool vector */
  74   snat_address_t *addr_pool;
  75
  76   /** sw_if_indices whose interface addresses should be auto-added */
  77   u32 *auto_add_sw_if_indices;
  78
  79   /** Pref64 vector */
  80   nat64_prefix_t *pref64;
  81
  82   /** BIB and session DB per thread */
  83   nat64_db_t *db;
  84
  85   /** Worker handoff */
  86   u32 fq_in2out_index;
  87   u32 fq_out2in_index;
  88
  89   /** Pool of static BIB entries to be added/deleted in worker threads */
  90   nat64_static_bib_to_update_t *static_bibs;
  91
  92   /** config parameters */
  93   u32 bib_buckets;
  94   u32 bib_memory_size;
  95   u32 st_buckets;
  96   u32 st_memory_size;
  97
  98   /** values of various timeouts */
  99   u32 udp_timeout;
 100   u32 icmp_timeout;
 101   u32 tcp_trans_timeout;
 102   u32 tcp_est_timeout;
 103
 104   /* Total count of interfaces enabled */
 105   u32 total_enabled_count;
 106   /* The process node which orcherstrates the cleanup */
 107   u32 nat64_expire_walk_node_index;
 108
 109   /* counters/gauges */
 110   vlib_simple_counter_main_t total_bibs;
 111   vlib_simple_counter_main_t total_sessions;
 112
 113   /** node index **/
 114   u32 error_node_index;
 115
 116   u32 in2out_node_index;
 117   u32 in2out_slowpath_node_index;
 118   u32 in2out_reass_node_index;
 119
 120   u32 out2in_node_index;
 121   u32 out2in_reass_node_index;
 122
 123   ip4_main_t *ip4_main;
 124   snat_main_t *sm;
 125 } nat64_main_t;
 126
 127 extern nat64_main_t nat64_main;
 128 extern vlib_node_registration_t nat64_in2out_node;
 129 extern vlib_node_registration_t nat64_out2in_node;
 130
 131 /**
 132  * @brief Add/delete address to NAT64 pool.
 133  *
 134  * @param thread_index Thread index used by ipfix nat logging (not address per thread).
 135  * @param addr   IPv4 address.
 136  * @param vrf_id VRF id of tenant, ~0 means independent of VRF.
 137  * @param is_add 1 if add, 0 if delete.
 138  *
 139  * @returns 0 on success, non-zero value otherwise.
 140  */
 141 int nat64_add_del_pool_addr (u32 thread_index,
 142                              ip4_address_t * addr, u32 vrf_id, u8 is_add);
 143
 144 /**
 145  * @brief Call back function when walking addresses in NAT64 pool, non-zero
 146  * return value stop walk.
 147  */
 148 typedef int (*nat64_pool_addr_walk_fn_t) (snat_address_t * addr, void *ctx);
 149
 150 /**
 151  * @brief Walk NAT64 pool.
 152  *
 153  * @param fn The function to invoke on each entry visited.
 154  * @param ctx A context passed in the visit function.
 155  */
 156 void nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx);
 157
 158 /**
 159  * @brief NAT64 pool address from specific (DHCP addressed) interface.
 160  *
 161  * @param sw_if_index Index of the interface.
 162  * @param is_add      1 if add, 0 if delete.
 163  *
 164  * @returns 0 on success, non-zero value otherwise.
 165  */
 166 int nat64_add_interface_address (u32 sw_if_index, int is_add);
 167
 168 /**
 169  * @brief Enable/disable NAT64 feature on the interface.
 170  *
 171  * @param sw_if_index Index of the interface.
 172  * @param is_inside   1 if inside, 0 if outside.
 173  * @param is_add      1 if add, 0 if delete.
 174  *
 175  * @returns 0 on success, non-zero value otherwise.
 176  */
 177 int nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add);
 178
 179 /**
 180  * @brief Call back function when walking interfaces with NAT64 feature,
 181  * non-zero return value stop walk.
 182  */
 183 typedef int (*nat64_interface_walk_fn_t) (snat_interface_t * i, void *ctx);
 184
 185 /**
 186  * @brief Walk NAT64 interfaces.
 187  *
 188  * @param fn The function to invoke on each entry visited.
 189  * @param ctx A context passed in the visit function.
 190  */
 191 void nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx);
 192
 193 /**
 194  * @brief Initialize NAT64.
 195  *
 196  * @param vm vlib main.
 197  *
 198  * @return error code.
 199  */
 200 clib_error_t *nat64_init (vlib_main_t * vm);
 201
 202 /**
 203  * @brief Add/delete static NAT64 BIB entry.
 204  *
 205  * @param in_addr  Inside IPv6 address.
 206  * @param out_addr Outside IPv4 address.
 207  * @param in_port  Inside port number.
 208  * @param out_port Outside port number.
 209  * @param proto    L4 protocol.
 210  * @param vrf_id   VRF id of tenant.
 211  * @param is_add   1 if add, 0 if delete.
 212  *
 213  * @returns 0 on success, non-zero value otherwise.
 214  */
 215 int nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
 216                                     ip4_address_t * out_addr, u16 in_port,
 217                                     u16 out_port, u8 proto, u32 vrf_id,
 218                                     u8 is_add);
 219
 220 /**
 221  * @brief Alloce IPv4 address and port pair from NAT64 pool.
 222  *
 223  * @param fib_index    FIB index of tenant.
 224  * @param proto        L4 protocol.
 225  * @param addr         Allocated IPv4 address.
 226  * @param port         Allocated port number.
 227  * @param thread_index Thread index.
 228  *
 229  * @returns 0 on success, non-zero value otherwise.
 230  */
 231 int nat64_alloc_out_addr_and_port (u32 fib_index, snat_protocol_t proto,
 232                                    ip4_address_t * addr, u16 * port,
 233                                    u32 thread_index);
 234
 235 /**
 236  * @brief Set UDP session timeout.
 237  *
 238  * @param timeout Timeout value in seconds (if 0 reset to default value 300sec).
 239  *
 240  * @returns 0 on success, non-zero value otherwise.
 241  */
 242 int nat64_set_udp_timeout (u32 timeout);
 243
 244 /**
 245  * @brief Get UDP session timeout.
 246  *
 247  * @returns UDP session timeout in seconds.
 248  */
 249 u32 nat64_get_udp_timeout (void);
 250
 251 /**
 252  * @brief Set ICMP session timeout.
 253  *
 254  * @param timeout Timeout value in seconds (if 0 reset to default value 60sec).
 255  *
 256  * @returns 0 on success, non-zero value otherwise.
 257  */
 258 int nat64_set_icmp_timeout (u32 timeout);
 259
 260 /**
 261  * @brief Get ICMP session timeout.
 262  *
 263  * @returns ICMP session timeout in seconds.
 264  */
 265 u32 nat64_get_icmp_timeout (void);
 266
 267 /**
 268  * @brief Set TCP session timeouts.
 269  *
 270  * @param trans Transitory timeout in seconds (if 0 reset to default value 240sec).
 271  * @param est Established timeout in seconds (if 0 reset to default value 7440sec).
 272  *
 273  * @returns 0 on success, non-zero value otherwise.
 274  */
 275 int nat64_set_tcp_timeouts (u32 trans, u32 est);
 276
 277 /**
 278  * @brief Get TCP transitory timeout.
 279  *
 280  * @returns TCP transitory timeout in seconds.
 281  */
 282 u32 nat64_get_tcp_trans_timeout (void);
 283
 284 /**
 285  * @brief Get TCP established timeout.
 286  *
 287  * @returns TCP established timeout in seconds.
 288  */
 289 u32 nat64_get_tcp_est_timeout (void);
 290
 291 /**
 292  * @brief Reset NAT64 session timeout.
 293  *
 294  * @param ste Session table entry.
 295  * @param vm VLIB main.
 296  **/
 297 void nat64_session_reset_timeout (nat64_db_st_entry_t * ste,
 298                                   vlib_main_t * vm);
 299
 300 /**
 301  * @brief Set NAT64 TCP session state.
 302  *
 303  * @param ste Session table entry.
 304  * @param tcp TCP header.
 305  * @param is_ip6 1 if IPv6 packet, 0 if IPv4.
 306  */
 307 void nat64_tcp_session_set_state (nat64_db_st_entry_t * ste,
 308                                   tcp_header_t * tcp, u8 is_ip6);
 309
 310 /**
 311  * @brief Add/delete NAT64 prefix.
 312  *
 313  * @param prefix NAT64 prefix.
 314  * @param plen Prefix length.
 315  * @param vrf_id VRF id of tenant.
 316  * @param is_add 1 if add, 0 if delete.
 317  *
 318  * @returns 0 on success, non-zero value otherwise.
 319  */
 320 int nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id,
 321                           u8 is_add);
 322
 323 /**
 324  * @brief Call back function when walking addresses in NAT64 prefixes, non-zero
 325  * return value stop walk.
 326  */
 327 typedef int (*nat64_prefix_walk_fn_t) (nat64_prefix_t * pref64, void *ctx);
 328
 329 /**
 330  * @brief Walk NAT64 prefixes.
 331  *
 332  * @param fn The function to invoke on each entry visited.
 333  * @param ctx A context passed in the visit function.
 334  */
 335 void nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx);
 336
 337 /**
 338  * Compose IPv4-embedded IPv6 addresses.
 339  * @param ip6 IPv4-embedded IPv6 addresses.
 340  * @param ip4 IPv4 address.
 341  * @param fib_index Tenant FIB index.
 342  */
 343 void nat64_compose_ip6 (ip6_address_t * ip6, ip4_address_t * ip4,
 344                         u32 fib_index);
 345
 346 /**
 347  * Extract IPv4 address from the IPv4-embedded IPv6 addresses.
 348  *
 349  * @param ip6 IPv4-embedded IPv6 addresses.
 350  * @param ip4 IPv4 address.
 351  * @param fib_index Tenant FIB index.
 352  */
 353 void nat64_extract_ip4 (ip6_address_t * ip6, ip4_address_t * ip4,
 354                         u32 fib_index);
 355
 356 /**
 357  * @brief Set NAT64 hash tables configuration.
 358  *
 359  * @param bib_buckets Number of BIB hash buckets.
 360  * @param bib_memory_size Memory size of BIB hash.
 361  * @param st_buckets Number of session table hash buckets.
 362  * @param st_memory_size Memory size of session table hash.
 363  */
 364 void nat64_set_hash (u32 bib_buckets, u32 bib_memory_size, u32 st_buckets,
 365                      u32 st_memory_size);
 366
 367 /**
 368  * @brief Get worker thread index for NAT64 in2out.
 369  *
 370  * @param addr IPv6 src address.
 371  *
 372  * @returns worker thread index.
 373  */
 374 u32 nat64_get_worker_in2out (ip6_address_t * addr);
 375
 376 /**
 377  * @brief Get worker thread index for NAT64 out2in.
 378  *
 379  * @param ip IPv4 header.
 380  *
 381  * @returns worker thread index.
 382  */
 383 u32 nat64_get_worker_out2in (ip4_header_t * ip);
 384
 385 #endif /* __included_nat64_h__ */
 386
 387 /*
 388  * fd.io coding-style-patch-verification: ON
 389  *
 390  * Local Variables:
 391  * eval: (c-set-style "gnu")
 392  * End:
 393  */