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