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 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   u32 error_node_index;
  93
  94   /** config parameters */
  95   u32 bib_buckets;
  96   u32 bib_memory_size;
  97   u32 st_buckets;
  98   u32 st_memory_size;
  99
 100   /** values of various timeouts */
 101   u32 udp_timeout;
 102   u32 icmp_timeout;
 103   u32 tcp_trans_timeout;
 104   u32 tcp_est_timeout;
 105
 106   /* Total count of interfaces enabled */
 107   u32 total_enabled_count;
 108   /* The process node which orcherstrates the cleanup */
 109   u32 nat64_expire_walk_node_index;
 110
 111   /* counters/gauges */
 112   vlib_simple_counter_main_t total_bibs;
 113   vlib_simple_counter_main_t total_sessions;
 114
 115   ip4_main_t *ip4_main;
 116   snat_main_t *sm;
 117 } nat64_main_t;
 118
 119 extern nat64_main_t nat64_main;
 120 extern vlib_node_registration_t nat64_in2out_node;
 121 extern vlib_node_registration_t nat64_out2in_node;
 122
 123 /**
 124  * @brief Add/delete address to NAT64 pool.
 125  *
 126  * @param addr   IPv4 address.
 127  * @param vrf_id VRF id of tenant, ~0 means independent of VRF.
 128  * @param is_add 1 if add, 0 if delete.
 129  *
 130  * @returns 0 on success, non-zero value otherwise.
 131  */
 132 int nat64_add_del_pool_addr (ip4_address_t * addr, u32 vrf_id, u8 is_add);
 133
 134 /**
 135  * @brief Call back function when walking addresses in NAT64 pool, non-zero
 136  * return value stop walk.
 137  */
 138 typedef int (*nat64_pool_addr_walk_fn_t) (snat_address_t * addr, void *ctx);
 139
 140 /**
 141  * @brief Walk NAT64 pool.
 142  *
 143  * @param fn The function to invoke on each entry visited.
 144  * @param ctx A context passed in the visit function.
 145  */
 146 void nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx);
 147
 148 /**
 149  * @brief NAT64 pool address from specific (DHCP addressed) interface.
 150  *
 151  * @param sw_if_index Index of the interface.
 152  * @param is_add      1 if add, 0 if delete.
 153  *
 154  * @returns 0 on success, non-zero value otherwise.
 155  */
 156 int nat64_add_interface_address (u32 sw_if_index, int is_add);
 157
 158 /**
 159  * @brief Enable/disable NAT64 feature on the interface.
 160  *
 161  * @param sw_if_index Index of the interface.
 162  * @param is_inside   1 if inside, 0 if outside.
 163  * @param is_add      1 if add, 0 if delete.
 164  *
 165  * @returns 0 on success, non-zero value otherwise.
 166  */
 167 int nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add);
 168
 169 /**
 170  * @brief Call back function when walking interfaces with NAT64 feature,
 171  * non-zero return value stop walk.
 172  */
 173 typedef int (*nat64_interface_walk_fn_t) (snat_interface_t * i, void *ctx);
 174
 175 /**
 176  * @brief Walk NAT64 interfaces.
 177  *
 178  * @param fn The function to invoke on each entry visited.
 179  * @param ctx A context passed in the visit function.
 180  */
 181 void nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx);
 182
 183 /**
 184  * @brief Initialize NAT64.
 185  *
 186  * @param vm vlib main.
 187  *
 188  * @return error code.
 189  */
 190 clib_error_t *nat64_init (vlib_main_t * vm);
 191
 192 /**
 193  * @brief Add/delete static NAT64 BIB entry.
 194  *
 195  * @param in_addr  Inside IPv6 address.
 196  * @param out_addr Outside IPv4 address.
 197  * @param in_port  Inside port number.
 198  * @param out_port Outside port number.
 199  * @param proto    L4 protocol.
 200  * @param vrf_id   VRF id of tenant.
 201  * @param is_add   1 if add, 0 if delete.
 202  *
 203  * @returns 0 on success, non-zero value otherwise.
 204  */
 205 int nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
 206                                     ip4_address_t * out_addr, u16 in_port,
 207                                     u16 out_port, u8 proto, u32 vrf_id,
 208                                     u8 is_add);
 209
 210 /**
 211  * @brief Alloce IPv4 address and port pair from NAT64 pool.
 212  *
 213  * @param fib_index    FIB index of tenant.
 214  * @param proto        L4 protocol.
 215  * @param addr         Allocated IPv4 address.
 216  * @param port         Allocated port number.
 217  * @param thread_index Thread index.
 218  *
 219  * @returns 0 on success, non-zero value otherwise.
 220  */
 221 int nat64_alloc_out_addr_and_port (u32 fib_index, snat_protocol_t proto,
 222                                    ip4_address_t * addr, u16 * port,
 223                                    u32 thread_index);
 224
 225 /**
 226  * @brief Set UDP session timeout.
 227  *
 228  * @param timeout Timeout value in seconds (if 0 reset to default value 300sec).
 229  *
 230  * @returns 0 on success, non-zero value otherwise.
 231  */
 232 int nat64_set_udp_timeout (u32 timeout);
 233
 234 /**
 235  * @brief Get UDP session timeout.
 236  *
 237  * @returns UDP session timeout in seconds.
 238  */
 239 u32 nat64_get_udp_timeout (void);
 240
 241 /**
 242  * @brief Set ICMP session timeout.
 243  *
 244  * @param timeout Timeout value in seconds (if 0 reset to default value 60sec).
 245  *
 246  * @returns 0 on success, non-zero value otherwise.
 247  */
 248 int nat64_set_icmp_timeout (u32 timeout);
 249
 250 /**
 251  * @brief Get ICMP session timeout.
 252  *
 253  * @returns ICMP session timeout in seconds.
 254  */
 255 u32 nat64_get_icmp_timeout (void);
 256
 257 /**
 258  * @brief Set TCP session timeouts.
 259  *
 260  * @param trans Transitory timeout in seconds (if 0 reset to default value 240sec).
 261  * @param est Established timeout in seconds (if 0 reset to default value 7440sec).
 262  *
 263  * @returns 0 on success, non-zero value otherwise.
 264  */
 265 int nat64_set_tcp_timeouts (u32 trans, u32 est);
 266
 267 /**
 268  * @brief Get TCP transitory timeout.
 269  *
 270  * @returns TCP transitory timeout in seconds.
 271  */
 272 u32 nat64_get_tcp_trans_timeout (void);
 273
 274 /**
 275  * @brief Get TCP established timeout.
 276  *
 277  * @returns TCP established timeout in seconds.
 278  */
 279 u32 nat64_get_tcp_est_timeout (void);
 280
 281 /**
 282  * @brief Reset NAT64 session timeout.
 283  *
 284  * @param ste Session table entry.
 285  * @param vm VLIB main.
 286  **/
 287 void nat64_session_reset_timeout (nat64_db_st_entry_t * ste,
 288                                   vlib_main_t * vm);
 289
 290 /**
 291  * @brief Set NAT64 TCP session state.
 292  *
 293  * @param ste Session table entry.
 294  * @param tcp TCP header.
 295  * @param is_ip6 1 if IPv6 packet, 0 if IPv4.
 296  */
 297 void nat64_tcp_session_set_state (nat64_db_st_entry_t * ste,
 298                                   tcp_header_t * tcp, u8 is_ip6);
 299
 300 /**
 301  * @brief Add/delete NAT64 prefix.
 302  *
 303  * @param prefix NAT64 prefix.
 304  * @param plen Prefix length.
 305  * @param vrf_id VRF id of tenant.
 306  * @param is_add 1 if add, 0 if delete.
 307  *
 308  * @returns 0 on success, non-zero value otherwise.
 309  */
 310 int nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id,
 311                           u8 is_add);
 312
 313 /**
 314  * @brief Call back function when walking addresses in NAT64 prefixes, non-zero
 315  * return value stop walk.
 316  */
 317 typedef int (*nat64_prefix_walk_fn_t) (nat64_prefix_t * pref64, void *ctx);
 318
 319 /**
 320  * @brief Walk NAT64 prefixes.
 321  *
 322  * @param fn The function to invoke on each entry visited.
 323  * @param ctx A context passed in the visit function.
 324  */
 325 void nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx);
 326
 327 /**
 328  * Compose IPv4-embedded IPv6 addresses.
 329  * @param ip6 IPv4-embedded IPv6 addresses.
 330  * @param ip4 IPv4 address.
 331  * @param fib_index Tenant FIB index.
 332  */
 333 void nat64_compose_ip6 (ip6_address_t * ip6, ip4_address_t * ip4,
 334                         u32 fib_index);
 335
 336 /**
 337  * Extract IPv4 address from the IPv4-embedded IPv6 addresses.
 338  *
 339  * @param ip6 IPv4-embedded IPv6 addresses.
 340  * @param ip4 IPv4 address.
 341  * @param fib_index Tenant FIB index.
 342  */
 343 void nat64_extract_ip4 (ip6_address_t * ip6, ip4_address_t * ip4,
 344                         u32 fib_index);
 345
 346 /**
 347  * @brief Set NAT64 hash tables configuration.
 348  *
 349  * @param bib_buckets Number of BIB hash buckets.
 350  * @param bib_memory_size Memory size of BIB hash.
 351  * @param st_buckets Number of session table hash buckets.
 352  * @param st_memory_size Memory size of session table hash.
 353  */
 354 void nat64_set_hash (u32 bib_buckets, u32 bib_memory_size, u32 st_buckets,
 355                      u32 st_memory_size);
 356
 357 /**
 358  * @brief Get worker thread index for NAT64 in2out.
 359  *
 360  * @param addr IPv6 src address.
 361  *
 362  * @returns worker thread index.
 363  */
 364 u32 nat64_get_worker_in2out (ip6_address_t * addr);
 365
 366 /**
 367  * @brief Get worker thread index for NAT64 out2in.
 368  *
 369  * @param ip IPv4 header.
 370  *
 371  * @returns worker thread index.
 372  */
 373 u32 nat64_get_worker_out2in (ip4_header_t * ip);
 374
 375 #endif /* __included_nat64_h__ */
 376
 377 /*
 378  * fd.io coding-style-patch-verification: ON
 379  *
 380  * Local Variables:
 381  * eval: (c-set-style "gnu")
 382  * End:
 383  */