src/plugins/nat/nat64.c

   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 implementation
  18  */
  19
  20 #include <nat/nat64.h>
  21 #include <nat/nat64_db.h>
  22 #include <nat/nat_inlines.h>
  23 #include <vnet/fib/ip4_fib.h>
  24 #include <vppinfra/crc32.h>
  25 #include <vnet/ip/reass/ip4_sv_reass.h>
  26 #include <vnet/ip/reass/ip6_sv_reass.h>
  27
  28
  29 nat64_main_t nat64_main;
  30
  31 /* *INDENT-OFF* */
  32
  33 /* Hook up input features */
  34 VNET_FEATURE_INIT (nat64_in2out, static) = {
  35   .arc_name = "ip6-unicast",
  36   .node_name = "nat64-in2out",
  37   .runs_before = VNET_FEATURES ("ip6-lookup"),
  38   .runs_after = VNET_FEATURES ("ip6-sv-reassembly-feature"),
  39 };
  40 VNET_FEATURE_INIT (nat64_out2in, static) = {
  41   .arc_name = "ip4-unicast",
  42   .node_name = "nat64-out2in",
  43   .runs_before = VNET_FEATURES ("ip4-lookup"),
  44   .runs_after = VNET_FEATURES ("ip4-sv-reassembly-feature"),
  45 };
  46 VNET_FEATURE_INIT (nat64_in2out_handoff, static) = {
  47   .arc_name = "ip6-unicast",
  48   .node_name = "nat64-in2out-handoff",
  49   .runs_before = VNET_FEATURES ("ip6-lookup"),
  50   .runs_after = VNET_FEATURES ("ip6-sv-reassembly-feature"),
  51 };
  52 VNET_FEATURE_INIT (nat64_out2in_handoff, static) = {
  53   .arc_name = "ip4-unicast",
  54   .node_name = "nat64-out2in-handoff",
  55   .runs_before = VNET_FEATURES ("ip4-lookup"),
  56   .runs_after = VNET_FEATURES ("ip4-sv-reassembly-feature"),
  57 };
  58
  59
  60 static u8 well_known_prefix[] = {
  61   0x00, 0x64, 0xff, 0x9b,
  62   0x00, 0x00, 0x00, 0x00,
  63   0x00, 0x00, 0x00, 0x00,
  64   0x00, 0x00, 0x00, 0x00
  65 };
  66
  67 /* *INDENT-ON* */
  68
  69 static void
  70 nat64_ip4_add_del_interface_address_cb (ip4_main_t * im, uword opaque,
  71                                         u32 sw_if_index,
  72                                         ip4_address_t * address,
  73                                         u32 address_length,
  74                                         u32 if_address_index, u32 is_delete)
  75 {
  76   nat64_main_t *nm = &nat64_main;
  77   int i, j;
  78
  79   for (i = 0; i < vec_len (nm->auto_add_sw_if_indices); i++)
  80     {
  81       if (sw_if_index == nm->auto_add_sw_if_indices[i])
  82         {
  83           if (!is_delete)
  84             {
  85               /* Don't trip over lease renewal, static config */
  86               for (j = 0; j < vec_len (nm->addr_pool); j++)
  87                 if (nm->addr_pool[j].addr.as_u32 == address->as_u32)
  88                   return;
  89
  90               (void) nat64_add_del_pool_addr (vlib_get_thread_index (),
  91                                               address, ~0, 1);
  92               return;
  93             }
  94           else
  95             {
  96               (void) nat64_add_del_pool_addr (vlib_get_thread_index (),
  97                                               address, ~0, 0);
  98               return;
  99             }
 100         }
 101     }
 102 }
 103
 104 u32
 105 nat64_get_worker_in2out (ip6_address_t * addr)
 106 {
 107   nat64_main_t *nm = &nat64_main;
 108   snat_main_t *sm = nm->sm;
 109   u32 next_worker_index = nm->sm->first_worker_index;
 110   u32 hash;
 111
 112 #ifdef clib_crc32c_uses_intrinsics
 113   hash = clib_crc32c ((u8 *) addr->as_u32, 16);
 114 #else
 115   u64 tmp = addr->as_u64[0] ^ addr->as_u64[1];
 116   hash = clib_xxhash (tmp);
 117 #endif
 118
 119   if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
 120     next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
 121   else
 122     next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
 123
 124   return next_worker_index;
 125 }
 126
 127 u32
 128 nat64_get_worker_out2in (vlib_buffer_t * b, ip4_header_t * ip)
 129 {
 130   nat64_main_t *nm = &nat64_main;
 131   snat_main_t *sm = nm->sm;
 132   udp_header_t *udp;
 133   u16 port;
 134   u32 proto;
 135
 136   proto = ip_proto_to_nat_proto (ip->protocol);
 137   udp = ip4_next_header (ip);
 138   port = udp->dst_port;
 139
 140   /* unknown protocol */
 141   if (PREDICT_FALSE (proto == NAT_PROTOCOL_OTHER))
 142     {
 143       nat64_db_t *db;
 144       ip46_address_t daddr;
 145       nat64_db_bib_entry_t *bibe;
 146
 147       clib_memset (&daddr, 0, sizeof (daddr));
 148       daddr.ip4.as_u32 = ip->dst_address.as_u32;
 149
 150       /* *INDENT-OFF* */
 151       vec_foreach (db, nm->db)
 152         {
 153           bibe = nat64_db_bib_entry_find (db, &daddr, 0, ip->protocol, 0, 0);
 154           if (bibe)
 155             return (u32) (db - nm->db);
 156         }
 157       /* *INDENT-ON* */
 158       return vlib_get_thread_index ();
 159     }
 160
 161   /* ICMP */
 162   if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
 163     {
 164       icmp46_header_t *icmp = (icmp46_header_t *) udp;
 165       icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
 166       if (!icmp_type_is_error_message
 167           (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
 168         port = vnet_buffer (b)->ip.reass.l4_src_port;
 169       else
 170         {
 171           /* if error message, then it's not fragmented and we can access it */
 172           ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
 173           proto = ip_proto_to_nat_proto (inner_ip->protocol);
 174           void *l4_header = ip4_next_header (inner_ip);
 175           switch (proto)
 176             {
 177             case NAT_PROTOCOL_ICMP:
 178               icmp = (icmp46_header_t *) l4_header;
 179               echo = (icmp_echo_header_t *) (icmp + 1);
 180               port = echo->identifier;
 181               break;
 182             case NAT_PROTOCOL_UDP:
 183             case NAT_PROTOCOL_TCP:
 184               port = ((tcp_udp_header_t *) l4_header)->src_port;
 185               break;
 186             default:
 187               return vlib_get_thread_index ();
 188             }
 189         }
 190     }
 191
 192   /* worker by outside port  (TCP/UDP) */
 193   port = clib_net_to_host_u16 (port);
 194   if (port > 1024)
 195     return nm->sm->first_worker_index + ((port - 1024) / sm->port_per_thread);
 196
 197   return vlib_get_thread_index ();
 198 }
 199
 200 clib_error_t *
 201 nat64_init (vlib_main_t * vm)
 202 {
 203   nat64_main_t *nm = &nat64_main;
 204   vlib_thread_main_t *tm = vlib_get_thread_main ();
 205   ip4_add_del_interface_address_callback_t cb4;
 206   ip4_main_t *im = &ip4_main;
 207   nm->sm = &snat_main;
 208   vlib_node_t *node;
 209
 210   vec_validate (nm->db, tm->n_vlib_mains - 1);
 211
 212   nm->fq_in2out_index = ~0;
 213   nm->fq_out2in_index = ~0;
 214
 215   node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
 216   nm->error_node_index = node->index;
 217
 218   node = vlib_get_node_by_name (vm, (u8 *) "nat64-in2out");
 219   nm->in2out_node_index = node->index;
 220
 221   node = vlib_get_node_by_name (vm, (u8 *) "nat64-in2out-slowpath");
 222   nm->in2out_slowpath_node_index = node->index;
 223
 224   node = vlib_get_node_by_name (vm, (u8 *) "nat64-out2in");
 225   nm->out2in_node_index = node->index;
 226
 227   /* set session timeouts to default values */
 228   nm->udp_timeout = SNAT_UDP_TIMEOUT;
 229   nm->icmp_timeout = SNAT_ICMP_TIMEOUT;
 230   nm->tcp_trans_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
 231   nm->tcp_est_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
 232
 233   nm->total_enabled_count = 0;
 234
 235   /* Set up the interface address add/del callback */
 236   cb4.function = nat64_ip4_add_del_interface_address_cb;
 237   cb4.function_opaque = 0;
 238   vec_add1 (im->add_del_interface_address_callbacks, cb4);
 239   nm->ip4_main = im;
 240
 241   /* Init counters */
 242   nm->total_bibs.name = "total-bibs";
 243   nm->total_bibs.stat_segment_name = "/nat64/total-bibs";
 244   vlib_validate_simple_counter (&nm->total_bibs, 0);
 245   vlib_zero_simple_counter (&nm->total_bibs, 0);
 246   nm->total_sessions.name = "total-sessions";
 247   nm->total_sessions.stat_segment_name = "/nat64/total-sessions";
 248   vlib_validate_simple_counter (&nm->total_sessions, 0);
 249   vlib_zero_simple_counter (&nm->total_sessions, 0);
 250
 251   return 0;
 252 }
 253
 254 static void nat64_free_out_addr_and_port (struct nat64_db_s *db,
 255                                           ip4_address_t * addr, u16 port,
 256                                           u8 protocol);
 257
 258 void
 259 nat64_set_hash (u32 bib_buckets, uword bib_memory_size, u32 st_buckets,
 260                 uword st_memory_size)
 261 {
 262   nat64_main_t *nm = &nat64_main;
 263   nat64_db_t *db;
 264
 265   nm->bib_buckets = bib_buckets;
 266   nm->bib_memory_size = bib_memory_size;
 267   nm->st_buckets = st_buckets;
 268   nm->st_memory_size = st_memory_size;
 269
 270   /* *INDENT-OFF* */
 271   vec_foreach (db, nm->db)
 272     {
 273       if (nat64_db_init (db, bib_buckets, bib_memory_size, st_buckets,
 274                          st_memory_size, nat64_free_out_addr_and_port))
 275         nat_elog_err ("NAT64 DB init failed");
 276     }
 277   /* *INDENT-ON* */
 278 }
 279
 280 int
 281 nat64_add_del_pool_addr (u32 thread_index,
 282                          ip4_address_t * addr, u32 vrf_id, u8 is_add)
 283 {
 284   nat64_main_t *nm = &nat64_main;
 285   snat_address_t *a = 0;
 286   snat_interface_t *interface;
 287   int i;
 288   nat64_db_t *db;
 289   vlib_thread_main_t *tm = vlib_get_thread_main ();
 290
 291   /* Check if address already exists */
 292   for (i = 0; i < vec_len (nm->addr_pool); i++)
 293     {
 294       if (nm->addr_pool[i].addr.as_u32 == addr->as_u32)
 295         {
 296           a = nm->addr_pool + i;
 297           break;
 298         }
 299     }
 300
 301   if (is_add)
 302     {
 303       if (a)
 304         return VNET_API_ERROR_VALUE_EXIST;
 305
 306       vec_add2 (nm->addr_pool, a, 1);
 307       a->addr = *addr;
 308       a->fib_index = ~0;
 309       if (vrf_id != ~0)
 310         a->fib_index =
 311           fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id,
 312                                              nat_fib_src_hi);
 313 #define _(N, id, n, s) \
 314       clib_memset (a->busy_##n##_port_refcounts, 0, sizeof(a->busy_##n##_port_refcounts)); \
 315       a->busy_##n##_ports = 0; \
 316       vec_validate_init_empty (a->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
 317       foreach_nat_protocol
 318 #undef _
 319     }
 320   else
 321     {
 322       if (!a)
 323         return VNET_API_ERROR_NO_SUCH_ENTRY;
 324
 325       if (a->fib_index != ~0)
 326         fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP6, nat_fib_src_hi);
 327       /* Delete sessions using address */
 328         /* *INDENT-OFF* */
 329         vec_foreach (db, nm->db)
 330           {
 331             nat64_db_free_out_addr (thread_index, db, &a->addr);
 332             vlib_set_simple_counter (&nm->total_bibs, db - nm->db, 0,
 333                                      db->bib.bib_entries_num);
 334             vlib_set_simple_counter (&nm->total_sessions, db - nm->db, 0,
 335                                      db->st.st_entries_num);
 336           }
 337         /* *INDENT-ON* */
 338       vec_del1 (nm->addr_pool, i);
 339     }
 340
 341   /* Add/del external address to FIB */
 342   /* *INDENT-OFF* */
 343   pool_foreach (interface, nm->interfaces,
 344   ({
 345     if (nat_interface_is_inside(interface))
 346       continue;
 347
 348     snat_add_del_addr_to_fib (addr, 32, interface->sw_if_index, is_add);
 349     break;
 350   }));
 351   /* *INDENT-ON* */
 352
 353   return 0;
 354 }
 355
 356 void
 357 nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx)
 358 {
 359   nat64_main_t *nm = &nat64_main;
 360   snat_address_t *a = 0;
 361
 362   /* *INDENT-OFF* */
 363   vec_foreach (a, nm->addr_pool)
 364     {
 365       if (fn (a, ctx))
 366         break;
 367     };
 368   /* *INDENT-ON* */
 369 }
 370
 371 int
 372 nat64_add_interface_address (u32 sw_if_index, int is_add)
 373 {
 374   nat64_main_t *nm = &nat64_main;
 375   ip4_main_t *ip4_main = nm->ip4_main;
 376   ip4_address_t *first_int_addr;
 377   int i;
 378
 379   first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0);
 380
 381   for (i = 0; i < vec_len (nm->auto_add_sw_if_indices); i++)
 382     {
 383       if (nm->auto_add_sw_if_indices[i] == sw_if_index)
 384         {
 385           if (is_add)
 386             return VNET_API_ERROR_VALUE_EXIST;
 387           else
 388             {
 389               /* if have address remove it */
 390               if (first_int_addr)
 391                 (void) nat64_add_del_pool_addr (vlib_get_thread_index (),
 392                                                 first_int_addr, ~0, 0);
 393               vec_del1 (nm->auto_add_sw_if_indices, i);
 394               return 0;
 395             }
 396         }
 397     }
 398
 399   if (!is_add)
 400     return VNET_API_ERROR_NO_SUCH_ENTRY;
 401
 402   /* add to the auto-address list */
 403   vec_add1 (nm->auto_add_sw_if_indices, sw_if_index);
 404
 405   /* If the address is already bound - or static - add it now */
 406   if (first_int_addr)
 407     (void) nat64_add_del_pool_addr (vlib_get_thread_index (),
 408                                     first_int_addr, ~0, 1);
 409
 410   return 0;
 411 }
 412
 413 int
 414 nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add)
 415 {
 416   vlib_main_t *vm = vlib_get_main ();
 417   nat64_main_t *nm = &nat64_main;
 418   snat_interface_t *interface = 0, *i;
 419   snat_address_t *ap;
 420   const char *feature_name, *arc_name;
 421
 422   /* Check if interface already exists */
 423   /* *INDENT-OFF* */
 424   pool_foreach (i, nm->interfaces,
 425   ({
 426     if (i->sw_if_index == sw_if_index)
 427       {
 428         interface = i;
 429         break;
 430       }
 431   }));
 432   /* *INDENT-ON* */
 433
 434   if (is_add)
 435     {
 436       if (interface)
 437         goto set_flags;
 438
 439       pool_get (nm->interfaces, interface);
 440       interface->sw_if_index = sw_if_index;
 441       interface->flags = 0;
 442     set_flags:
 443       if (is_inside)
 444         interface->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
 445       else
 446         interface->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
 447
 448       nm->total_enabled_count++;
 449       vlib_process_signal_event (vm,
 450                                  nm->nat64_expire_walk_node_index,
 451                                  NAT64_CLEANER_RESCHEDULE, 0);
 452
 453     }
 454   else
 455     {
 456       if (!interface)
 457         return VNET_API_ERROR_NO_SUCH_ENTRY;
 458
 459       if ((nat_interface_is_inside (interface)
 460            && nat_interface_is_outside (interface)))
 461         interface->flags &=
 462           is_inside ? ~NAT_INTERFACE_FLAG_IS_INSIDE :
 463           ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
 464       else
 465         pool_put (nm->interfaces, interface);
 466
 467       nm->total_enabled_count--;
 468     }
 469
 470   if (!is_inside)
 471     {
 472       /* *INDENT-OFF* */
 473       vec_foreach (ap, nm->addr_pool)
 474         snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, is_add);
 475       /* *INDENT-ON* */
 476     }
 477
 478   if (nm->sm->num_workers > 1)
 479     {
 480       feature_name =
 481         is_inside ? "nat64-in2out-handoff" : "nat64-out2in-handoff";
 482       if (nm->fq_in2out_index == ~0)
 483         nm->fq_in2out_index =
 484           vlib_frame_queue_main_init (nat64_in2out_node.index, 0);
 485       if (nm->fq_out2in_index == ~0)
 486         nm->fq_out2in_index =
 487           vlib_frame_queue_main_init (nat64_out2in_node.index, 0);
 488     }
 489   else
 490     feature_name = is_inside ? "nat64-in2out" : "nat64-out2in";
 491
 492   arc_name = is_inside ? "ip6-unicast" : "ip4-unicast";
 493
 494   if (is_inside)
 495     {
 496       int rv = ip6_sv_reass_enable_disable_with_refcnt (sw_if_index, is_add);
 497       if (rv)
 498         return rv;
 499     }
 500   else
 501     {
 502       int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, is_add);
 503       if (rv)
 504         return rv;
 505     }
 506
 507   return vnet_feature_enable_disable (arc_name, feature_name, sw_if_index,
 508                                       is_add, 0, 0);
 509 }
 510
 511 void
 512 nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx)
 513 {
 514   nat64_main_t *nm = &nat64_main;
 515   snat_interface_t *i = 0;
 516
 517   /* *INDENT-OFF* */
 518   pool_foreach (i, nm->interfaces,
 519   ({
 520     if (fn (i, ctx))
 521       break;
 522   }));
 523   /* *INDENT-ON* */
 524 }
 525
 526 int
 527 nat64_alloc_out_addr_and_port (u32 fib_index, nat_protocol_t proto,
 528                                ip4_address_t * addr, u16 * port,
 529                                u32 thread_index)
 530 {
 531   nat64_main_t *nm = &nat64_main;
 532   snat_main_t *sm = nm->sm;
 533   u32 worker_index = 0;
 534   int rv;
 535
 536   if (sm->num_workers > 1)
 537     worker_index = thread_index - sm->first_worker_index;
 538
 539   rv =
 540     sm->alloc_addr_and_port (nm->addr_pool, fib_index, thread_index,
 541                              proto, addr, port, sm->port_per_thread,
 542                              worker_index);
 543
 544   return rv;
 545 }
 546
 547 static void
 548 nat64_free_out_addr_and_port (struct nat64_db_s *db, ip4_address_t * addr,
 549                               u16 port, u8 protocol)
 550 {
 551   nat64_main_t *nm = &nat64_main;
 552   int i;
 553   snat_address_t *a;
 554   u32 thread_index = db - nm->db;
 555   nat_protocol_t proto = ip_proto_to_nat_proto (protocol);
 556   u16 port_host_byte_order = clib_net_to_host_u16 (port);
 557
 558   for (i = 0; i < vec_len (nm->addr_pool); i++)
 559     {
 560       a = nm->addr_pool + i;
 561       if (addr->as_u32 != a->addr.as_u32)
 562         continue;
 563       switch (proto)
 564         {
 565 #define _(N, j, n, s) \
 566         case NAT_PROTOCOL_##N: \
 567           ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
 568           --a->busy_##n##_port_refcounts[port_host_byte_order]; \
 569           a->busy_##n##_ports--; \
 570           a->busy_##n##_ports_per_thread[thread_index]--; \
 571           break;
 572           foreach_nat_protocol
 573 #undef _
 574         default:
 575           nat_elog_notice ("unknown protocol");
 576           return;
 577         }
 578       break;
 579     }
 580 }
 581
 582 /**
 583  * @brief Add/delete static BIB entry in worker thread.
 584  */
 585 static uword
 586 nat64_static_bib_worker_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
 587                             vlib_frame_t * f)
 588 {
 589   nat64_main_t *nm = &nat64_main;
 590   u32 thread_index = vm->thread_index;
 591   nat64_db_t *db = &nm->db[thread_index];
 592   nat64_static_bib_to_update_t *static_bib;
 593   nat64_db_bib_entry_t *bibe;
 594   ip46_address_t addr;
 595
 596   /* *INDENT-OFF* */
 597   pool_foreach (static_bib, nm->static_bibs,
 598   ({
 599     if ((static_bib->thread_index != thread_index) || (static_bib->done))
 600       continue;
 601
 602     if (static_bib->is_add)
 603       {
 604           (void) nat64_db_bib_entry_create (thread_index, db,
 605                                             &static_bib->in_addr,
 606                                             &static_bib->out_addr,
 607                                             static_bib->in_port,
 608                                             static_bib->out_port,
 609                                             static_bib->fib_index,
 610                                             static_bib->proto, 1);
 611           vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 612                                    db->bib.bib_entries_num);
 613       }
 614     else
 615       {
 616         addr.as_u64[0] = static_bib->in_addr.as_u64[0];
 617         addr.as_u64[1] = static_bib->in_addr.as_u64[1];
 618         bibe = nat64_db_bib_entry_find (db, &addr, static_bib->in_port,
 619                                         static_bib->proto,
 620                                         static_bib->fib_index, 1);
 621         if (bibe)
 622           {
 623             nat64_db_bib_entry_free (thread_index, db, bibe);
 624             vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 625                                      db->bib.bib_entries_num);
 626             vlib_set_simple_counter (&nm->total_sessions, thread_index, 0,
 627                                      db->st.st_entries_num);
 628           }
 629       }
 630
 631       static_bib->done = 1;
 632   }));
 633   /* *INDENT-ON* */
 634
 635   return 0;
 636 }
 637
 638 static vlib_node_registration_t nat64_static_bib_worker_node;
 639
 640 /* *INDENT-OFF* */
 641 VLIB_REGISTER_NODE (nat64_static_bib_worker_node, static) = {
 642     .function = nat64_static_bib_worker_fn,
 643     .type = VLIB_NODE_TYPE_INPUT,
 644     .state = VLIB_NODE_STATE_INTERRUPT,
 645     .name = "nat64-static-bib-worker",
 646 };
 647 /* *INDENT-ON* */
 648
 649 int
 650 nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
 651                                 ip4_address_t * out_addr, u16 in_port,
 652                                 u16 out_port, u8 proto, u32 vrf_id, u8 is_add)
 653 {
 654   nat64_main_t *nm = &nat64_main;
 655   nat64_db_bib_entry_t *bibe;
 656   u32 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id,
 657                                                      nat_fib_src_hi);
 658   nat_protocol_t p = ip_proto_to_nat_proto (proto);
 659   ip46_address_t addr;
 660   int i;
 661   snat_address_t *a;
 662   u32 thread_index = 0;
 663   nat64_db_t *db;
 664   nat64_static_bib_to_update_t *static_bib;
 665   vlib_main_t *worker_vm;
 666   u32 *to_be_free = 0, *index;
 667
 668   if (nm->sm->num_workers > 1)
 669     {
 670       thread_index = nat64_get_worker_in2out (in_addr);
 671       db = &nm->db[thread_index];
 672     }
 673   else
 674     db = &nm->db[nm->sm->num_workers];
 675
 676   addr.as_u64[0] = in_addr->as_u64[0];
 677   addr.as_u64[1] = in_addr->as_u64[1];
 678   bibe =
 679     nat64_db_bib_entry_find (db, &addr, clib_host_to_net_u16 (in_port),
 680                              proto, fib_index, 1);
 681
 682   if (is_add)
 683     {
 684       if (bibe)
 685         return VNET_API_ERROR_VALUE_EXIST;
 686
 687       /* outside port must be assigned to same thread as internall address */
 688       if ((out_port > 1024) && (nm->sm->num_workers > 1))
 689         {
 690           if (thread_index != ((out_port - 1024) / nm->sm->port_per_thread))
 691             return VNET_API_ERROR_INVALID_VALUE_2;
 692         }
 693
 694       for (i = 0; i < vec_len (nm->addr_pool); i++)
 695         {
 696           a = nm->addr_pool + i;
 697           if (out_addr->as_u32 != a->addr.as_u32)
 698             continue;
 699           switch (p)
 700             {
 701 #define _(N, j, n, s) \
 702             case NAT_PROTOCOL_##N: \
 703               if (a->busy_##n##_port_refcounts[out_port]) \
 704                 return VNET_API_ERROR_INVALID_VALUE; \
 705               ++a->busy_##n##_port_refcounts[out_port]; \
 706               if (out_port > 1024) \
 707                 { \
 708                   a->busy_##n##_ports++; \
 709                   a->busy_##n##_ports_per_thread[thread_index]++; \
 710                 } \
 711               break;
 712               foreach_nat_protocol
 713 #undef _
 714             default:
 715               clib_memset (&addr, 0, sizeof (addr));
 716               addr.ip4.as_u32 = out_addr->as_u32;
 717               if (nat64_db_bib_entry_find (db, &addr, 0, proto, fib_index, 0))
 718                 return VNET_API_ERROR_INVALID_VALUE;
 719             }
 720           break;
 721         }
 722       if (!nm->sm->num_workers)
 723         {
 724           bibe =
 725             nat64_db_bib_entry_create (thread_index, db, in_addr, out_addr,
 726                                        clib_host_to_net_u16 (in_port),
 727                                        clib_host_to_net_u16 (out_port),
 728                                        fib_index, proto, 1);
 729           if (!bibe)
 730             return VNET_API_ERROR_UNSPECIFIED;
 731
 732           vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 733                                    db->bib.bib_entries_num);
 734         }
 735     }
 736   else
 737     {
 738       if (!bibe)
 739         return VNET_API_ERROR_NO_SUCH_ENTRY;
 740
 741       if (!nm->sm->num_workers)
 742         {
 743           nat64_db_bib_entry_free (thread_index, db, bibe);
 744           vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 745                                    db->bib.bib_entries_num);
 746         }
 747     }
 748
 749   if (nm->sm->num_workers)
 750     {
 751       /* *INDENT-OFF* */
 752       pool_foreach (static_bib, nm->static_bibs,
 753       ({
 754         if (static_bib->done)
 755           vec_add1 (to_be_free, static_bib - nm->static_bibs);
 756       }));
 757       vec_foreach (index, to_be_free)
 758         pool_put_index (nm->static_bibs, index[0]);
 759       /* *INDENT-ON* */
 760       vec_free (to_be_free);
 761       pool_get (nm->static_bibs, static_bib);
 762       static_bib->in_addr.as_u64[0] = in_addr->as_u64[0];
 763       static_bib->in_addr.as_u64[1] = in_addr->as_u64[1];
 764       static_bib->in_port = clib_host_to_net_u16 (in_port);
 765       static_bib->out_addr.as_u32 = out_addr->as_u32;
 766       static_bib->out_port = clib_host_to_net_u16 (out_port);
 767       static_bib->fib_index = fib_index;
 768       static_bib->proto = proto;
 769       static_bib->is_add = is_add;
 770       static_bib->thread_index = thread_index;
 771       static_bib->done = 0;
 772       worker_vm = vlib_mains[thread_index];
 773       if (worker_vm)
 774         vlib_node_set_interrupt_pending (worker_vm,
 775                                          nat64_static_bib_worker_node.index);
 776       else
 777         return VNET_API_ERROR_UNSPECIFIED;
 778     }
 779
 780   return 0;
 781 }
 782
 783 int
 784 nat64_set_udp_timeout (u32 timeout)
 785 {
 786   nat64_main_t *nm = &nat64_main;
 787
 788   if (timeout == 0)
 789     nm->udp_timeout = SNAT_UDP_TIMEOUT;
 790   else
 791     nm->udp_timeout = timeout;
 792
 793   return 0;
 794 }
 795
 796 u32
 797 nat64_get_udp_timeout (void)
 798 {
 799   nat64_main_t *nm = &nat64_main;
 800
 801   return nm->udp_timeout;
 802 }
 803
 804 int
 805 nat64_set_icmp_timeout (u32 timeout)
 806 {
 807   nat64_main_t *nm = &nat64_main;
 808
 809   if (timeout == 0)
 810     nm->icmp_timeout = SNAT_ICMP_TIMEOUT;
 811   else
 812     nm->icmp_timeout = timeout;
 813
 814   return 0;
 815 }
 816
 817 u32
 818 nat64_get_icmp_timeout (void)
 819 {
 820   nat64_main_t *nm = &nat64_main;
 821
 822   return nm->icmp_timeout;
 823 }
 824
 825 int
 826 nat64_set_tcp_timeouts (u32 trans, u32 est)
 827 {
 828   nat64_main_t *nm = &nat64_main;
 829
 830   if (trans == 0)
 831     nm->tcp_trans_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
 832   else
 833     nm->tcp_trans_timeout = trans;
 834
 835   if (est == 0)
 836     nm->tcp_est_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
 837   else
 838     nm->tcp_est_timeout = est;
 839
 840   return 0;
 841 }
 842
 843 u32
 844 nat64_get_tcp_trans_timeout (void)
 845 {
 846   nat64_main_t *nm = &nat64_main;
 847
 848   return nm->tcp_trans_timeout;
 849 }
 850
 851 u32
 852 nat64_get_tcp_est_timeout (void)
 853 {
 854   nat64_main_t *nm = &nat64_main;
 855
 856   return nm->tcp_est_timeout;
 857 }
 858
 859 void
 860 nat64_session_reset_timeout (nat64_db_st_entry_t * ste, vlib_main_t * vm)
 861 {
 862   nat64_main_t *nm = &nat64_main;
 863   u32 now = (u32) vlib_time_now (vm);
 864
 865   switch (ip_proto_to_nat_proto (ste->proto))
 866     {
 867     case NAT_PROTOCOL_ICMP:
 868       ste->expire = now + nm->icmp_timeout;
 869       return;
 870     case NAT_PROTOCOL_TCP:
 871       {
 872         switch (ste->tcp_state)
 873           {
 874           case NAT64_TCP_STATE_V4_INIT:
 875           case NAT64_TCP_STATE_V6_INIT:
 876           case NAT64_TCP_STATE_V4_FIN_RCV:
 877           case NAT64_TCP_STATE_V6_FIN_RCV:
 878           case NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV:
 879           case NAT64_TCP_STATE_TRANS:
 880             ste->expire = now + nm->tcp_trans_timeout;
 881             return;
 882           case NAT64_TCP_STATE_ESTABLISHED:
 883             ste->expire = now + nm->tcp_est_timeout;
 884             return;
 885           default:
 886             return;
 887           }
 888       }
 889     case NAT_PROTOCOL_UDP:
 890       ste->expire = now + nm->udp_timeout;
 891       return;
 892     default:
 893       ste->expire = now + nm->udp_timeout;
 894       return;
 895     }
 896 }
 897
 898 void
 899 nat64_tcp_session_set_state (nat64_db_st_entry_t * ste, tcp_header_t * tcp,
 900                              u8 is_ip6)
 901 {
 902   switch (ste->tcp_state)
 903     {
 904     case NAT64_TCP_STATE_CLOSED:
 905       {
 906         if (tcp->flags & TCP_FLAG_SYN)
 907           {
 908             if (is_ip6)
 909               ste->tcp_state = NAT64_TCP_STATE_V6_INIT;
 910             else
 911               ste->tcp_state = NAT64_TCP_STATE_V4_INIT;
 912           }
 913         return;
 914       }
 915     case NAT64_TCP_STATE_V4_INIT:
 916       {
 917         if (is_ip6 && (tcp->flags & TCP_FLAG_SYN))
 918           ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
 919         return;
 920       }
 921     case NAT64_TCP_STATE_V6_INIT:
 922       {
 923         if (!is_ip6 && (tcp->flags & TCP_FLAG_SYN))
 924           ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
 925         return;
 926       }
 927     case NAT64_TCP_STATE_ESTABLISHED:
 928       {
 929         if (tcp->flags & TCP_FLAG_FIN)
 930           {
 931             if (is_ip6)
 932               ste->tcp_state = NAT64_TCP_STATE_V6_FIN_RCV;
 933             else
 934               ste->tcp_state = NAT64_TCP_STATE_V4_FIN_RCV;
 935           }
 936         else if (tcp->flags & TCP_FLAG_RST)
 937           {
 938             ste->tcp_state = NAT64_TCP_STATE_TRANS;
 939           }
 940         return;
 941       }
 942     case NAT64_TCP_STATE_V4_FIN_RCV:
 943       {
 944         if (is_ip6 && (tcp->flags & TCP_FLAG_FIN))
 945           ste->tcp_state = NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV;
 946         return;
 947       }
 948     case NAT64_TCP_STATE_V6_FIN_RCV:
 949       {
 950         if (!is_ip6 && (tcp->flags & TCP_FLAG_FIN))
 951           ste->tcp_state = NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV;
 952         return;
 953       }
 954     case NAT64_TCP_STATE_TRANS:
 955       {
 956         if (!(tcp->flags & TCP_FLAG_RST))
 957           ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
 958         return;
 959       }
 960     default:
 961       return;
 962     }
 963 }
 964
 965 int
 966 nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id, u8 is_add)
 967 {
 968   nat64_main_t *nm = &nat64_main;
 969   nat64_prefix_t *p = 0;
 970   int i;
 971
 972   /* Verify prefix length */
 973   if (plen != 32 && plen != 40 && plen != 48 && plen != 56 && plen != 64
 974       && plen != 96)
 975     return VNET_API_ERROR_INVALID_VALUE;
 976
 977   /* Check if tenant already have prefix */
 978   for (i = 0; i < vec_len (nm->pref64); i++)
 979     {
 980       if (nm->pref64[i].vrf_id == vrf_id)
 981         {
 982           p = nm->pref64 + i;
 983           break;
 984         }
 985     }
 986
 987   if (is_add)
 988     {
 989       if (!p)
 990         {
 991           vec_add2 (nm->pref64, p, 1);
 992           p->fib_index =
 993             fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id,
 994                                                nat_fib_src_hi);
 995           p->vrf_id = vrf_id;
 996         }
 997
 998       p->prefix.as_u64[0] = prefix->as_u64[0];
 999       p->prefix.as_u64[1] = prefix->as_u64[1];
1000       p->plen = plen;
1001     }
1002   else
1003     {
1004       if (!p)
1005         return VNET_API_ERROR_NO_SUCH_ENTRY;
1006
1007       vec_del1 (nm->pref64, i);
1008     }
1009
1010   return 0;
1011 }
1012
1013 void
1014 nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx)
1015 {
1016   nat64_main_t *nm = &nat64_main;
1017   nat64_prefix_t *p = 0;
1018
1019   /* *INDENT-OFF* */
1020   vec_foreach (p, nm->pref64)
1021     {
1022       if (fn (p, ctx))
1023         break;
1024     };
1025   /* *INDENT-ON* */
1026 }
1027
1028 void
1029 nat64_compose_ip6 (ip6_address_t * ip6, ip4_address_t * ip4, u32 fib_index)
1030 {
1031   nat64_main_t *nm = &nat64_main;
1032   nat64_prefix_t *p, *gp = 0, *prefix = 0;
1033
1034   /* *INDENT-OFF* */
1035   vec_foreach (p, nm->pref64)
1036     {
1037       if (p->fib_index == fib_index)
1038         {
1039           prefix = p;
1040           break;
1041         }
1042
1043       if (p->fib_index == 0)
1044         gp = p;
1045     };
1046   /* *INDENT-ON* */
1047
1048   if (!prefix)
1049     prefix = gp;
1050
1051   if (prefix)
1052     {
1053       clib_memcpy_fast (ip6, &p->prefix, sizeof (ip6_address_t));
1054       switch (p->plen)
1055         {
1056         case 32:
1057           ip6->as_u32[1] = ip4->as_u32;
1058           break;
1059         case 40:
1060           ip6->as_u8[5] = ip4->as_u8[0];
1061           ip6->as_u8[6] = ip4->as_u8[1];
1062           ip6->as_u8[7] = ip4->as_u8[2];
1063           ip6->as_u8[9] = ip4->as_u8[3];
1064           break;
1065         case 48:
1066           ip6->as_u8[6] = ip4->as_u8[0];
1067           ip6->as_u8[7] = ip4->as_u8[1];
1068           ip6->as_u8[9] = ip4->as_u8[2];
1069           ip6->as_u8[10] = ip4->as_u8[3];
1070           break;
1071         case 56:
1072           ip6->as_u8[7] = ip4->as_u8[0];
1073           ip6->as_u8[9] = ip4->as_u8[1];
1074           ip6->as_u8[10] = ip4->as_u8[2];
1075           ip6->as_u8[11] = ip4->as_u8[3];
1076           break;
1077         case 64:
1078           ip6->as_u8[9] = ip4->as_u8[0];
1079           ip6->as_u8[10] = ip4->as_u8[1];
1080           ip6->as_u8[11] = ip4->as_u8[2];
1081           ip6->as_u8[12] = ip4->as_u8[3];
1082           break;
1083         case 96:
1084           ip6->as_u32[3] = ip4->as_u32;
1085           break;
1086         default:
1087           nat_elog_notice ("invalid prefix length");
1088           break;
1089         }
1090     }
1091   else
1092     {
1093       clib_memcpy_fast (ip6, well_known_prefix, sizeof (ip6_address_t));
1094       ip6->as_u32[3] = ip4->as_u32;
1095     }
1096 }
1097
1098 void
1099 nat64_extract_ip4 (ip6_address_t * ip6, ip4_address_t * ip4, u32 fib_index)
1100 {
1101   nat64_main_t *nm = &nat64_main;
1102   nat64_prefix_t *p, *gp = 0;
1103   u8 plen = 0;
1104
1105   /* *INDENT-OFF* */
1106   vec_foreach (p, nm->pref64)
1107     {
1108       if (p->fib_index == fib_index)
1109         {
1110           plen = p->plen;
1111           break;
1112         }
1113
1114       if (p->vrf_id == 0)
1115         gp = p;
1116     };
1117   /* *INDENT-ON* */
1118
1119   if (!plen)
1120     {
1121       if (gp)
1122         plen = gp->plen;
1123       else
1124         plen = 96;
1125     }
1126
1127   switch (plen)
1128     {
1129     case 32:
1130       ip4->as_u32 = ip6->as_u32[1];
1131       break;
1132     case 40:
1133       ip4->as_u8[0] = ip6->as_u8[5];
1134       ip4->as_u8[1] = ip6->as_u8[6];
1135       ip4->as_u8[2] = ip6->as_u8[7];
1136       ip4->as_u8[3] = ip6->as_u8[9];
1137       break;
1138     case 48:
1139       ip4->as_u8[0] = ip6->as_u8[6];
1140       ip4->as_u8[1] = ip6->as_u8[7];
1141       ip4->as_u8[2] = ip6->as_u8[9];
1142       ip4->as_u8[3] = ip6->as_u8[10];
1143       break;
1144     case 56:
1145       ip4->as_u8[0] = ip6->as_u8[7];
1146       ip4->as_u8[1] = ip6->as_u8[9];
1147       ip4->as_u8[2] = ip6->as_u8[10];
1148       ip4->as_u8[3] = ip6->as_u8[11];
1149       break;
1150     case 64:
1151       ip4->as_u8[0] = ip6->as_u8[9];
1152       ip4->as_u8[1] = ip6->as_u8[10];
1153       ip4->as_u8[2] = ip6->as_u8[11];
1154       ip4->as_u8[3] = ip6->as_u8[12];
1155       break;
1156     case 96:
1157       ip4->as_u32 = ip6->as_u32[3];
1158       break;
1159     default:
1160       nat_elog_notice ("invalid prefix length");
1161       break;
1162     }
1163 }
1164
1165 /**
1166  * @brief Per worker process checking expire time for NAT64 sessions.
1167  */
1168 static uword
1169 nat64_expire_worker_walk_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
1170                              vlib_frame_t * f)
1171 {
1172   nat64_main_t *nm = &nat64_main;
1173   u32 thread_index = vm->thread_index;
1174   nat64_db_t *db = &nm->db[thread_index];
1175   u32 now = (u32) vlib_time_now (vm);
1176
1177   nad64_db_st_free_expired (thread_index, db, now);
1178   vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
1179                            db->bib.bib_entries_num);
1180   vlib_set_simple_counter (&nm->total_sessions, thread_index, 0,
1181                            db->st.st_entries_num);
1182
1183   return 0;
1184 }
1185
1186 static vlib_node_registration_t nat64_expire_worker_walk_node;
1187
1188 /* *INDENT-OFF* */
1189 VLIB_REGISTER_NODE (nat64_expire_worker_walk_node, static) = {
1190     .function = nat64_expire_worker_walk_fn,
1191     .type = VLIB_NODE_TYPE_INPUT,
1192     .state = VLIB_NODE_STATE_INTERRUPT,
1193     .name = "nat64-expire-worker-walk",
1194 };
1195 /* *INDENT-ON* */
1196
1197 static vlib_node_registration_t nat64_expire_walk_node;
1198
1199 /**
1200  * @brief Centralized process to drive per worker expire walk.
1201  */
1202 static uword
1203 nat64_expire_walk_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
1204                       vlib_frame_t * f)
1205 {
1206   nat64_main_t *nm = &nat64_main;
1207   vlib_main_t **worker_vms = 0, *worker_vm;
1208   int i;
1209   uword event_type, *event_data = 0;
1210
1211   nm->nat64_expire_walk_node_index = nat64_expire_walk_node.index;
1212
1213   if (vec_len (vlib_mains) == 0)
1214     vec_add1 (worker_vms, vm);
1215   else
1216     {
1217       for (i = 0; i < vec_len (vlib_mains); i++)
1218         {
1219           worker_vm = vlib_mains[i];
1220           if (worker_vm)
1221             vec_add1 (worker_vms, worker_vm);
1222         }
1223     }
1224
1225   while (1)
1226     {
1227       if (nm->total_enabled_count)
1228         {
1229           vlib_process_wait_for_event_or_clock (vm, 10.0);
1230           event_type = vlib_process_get_events (vm, &event_data);
1231         }
1232       else
1233         {
1234           vlib_process_wait_for_event (vm);
1235           event_type = vlib_process_get_events (vm, &event_data);
1236         }
1237
1238       switch (event_type)
1239         {
1240         case ~0:
1241           break;
1242         case NAT64_CLEANER_RESCHEDULE:
1243           break;
1244         default:
1245           nat_elog_notice_X1 ("unknown event %d", "i4", event_type);
1246           break;
1247         }
1248
1249       for (i = 0; i < vec_len (worker_vms); i++)
1250         {
1251           worker_vm = worker_vms[i];
1252           vlib_node_set_interrupt_pending (worker_vm,
1253                                            nat64_expire_worker_walk_node.index);
1254         }
1255     }
1256
1257   return 0;
1258 }
1259
1260 /* *INDENT-OFF* */
1261 VLIB_REGISTER_NODE (nat64_expire_walk_node, static) = {
1262     .function = nat64_expire_walk_fn,
1263     .type = VLIB_NODE_TYPE_PROCESS,
1264     .name = "nat64-expire-walk",
1265 };
1266 /* *INDENT-ON* */
1267
1268 /*
1269  * fd.io coding-style-patch-verification: ON
1270  *
1271  * Local Variables:
1272  * eval: (c-set-style "gnu")
1273  * End:
1274  */