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_snat_proto (ip->protocol);
 137   udp = ip4_next_header (ip);
 138   port = udp->dst_port;
 139
 140   /* unknown protocol */
 141   if (PREDICT_FALSE (proto == ~0))
 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_snat_proto (inner_ip->protocol);
 174           void *l4_header = ip4_next_header (inner_ip);
 175           switch (proto)
 176             {
 177             case SNAT_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 SNAT_PROTOCOL_UDP:
 183             case SNAT_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_snat_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, snat_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   snat_session_key_t k;
 534   u32 worker_index = 0;
 535   int rv;
 536
 537   k.protocol = proto;
 538
 539   if (sm->num_workers > 1)
 540     worker_index = thread_index - sm->first_worker_index;
 541
 542   rv =
 543     sm->alloc_addr_and_port (nm->addr_pool, fib_index, thread_index, &k,
 544                              sm->port_per_thread, worker_index);
 545
 546   if (!rv)
 547     {
 548       *port = k.port;
 549       addr->as_u32 = k.addr.as_u32;
 550     }
 551
 552   return rv;
 553 }
 554
 555 static void
 556 nat64_free_out_addr_and_port (struct nat64_db_s *db, ip4_address_t * addr,
 557                               u16 port, u8 protocol)
 558 {
 559   nat64_main_t *nm = &nat64_main;
 560   int i;
 561   snat_address_t *a;
 562   u32 thread_index = db - nm->db;
 563   snat_protocol_t proto = ip_proto_to_snat_proto (protocol);
 564   u16 port_host_byte_order = clib_net_to_host_u16 (port);
 565
 566   for (i = 0; i < vec_len (nm->addr_pool); i++)
 567     {
 568       a = nm->addr_pool + i;
 569       if (addr->as_u32 != a->addr.as_u32)
 570         continue;
 571       switch (proto)
 572         {
 573 #define _(N, j, n, s) \
 574         case SNAT_PROTOCOL_##N: \
 575           ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
 576           --a->busy_##n##_port_refcounts[port_host_byte_order]; \
 577           a->busy_##n##_ports--; \
 578           a->busy_##n##_ports_per_thread[thread_index]--; \
 579           break;
 580           foreach_snat_protocol
 581 #undef _
 582         default:
 583           nat_elog_notice ("unknown protocol");
 584           return;
 585         }
 586       break;
 587     }
 588 }
 589
 590 /**
 591  * @brief Add/delete static BIB entry in worker thread.
 592  */
 593 static uword
 594 nat64_static_bib_worker_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
 595                             vlib_frame_t * f)
 596 {
 597   nat64_main_t *nm = &nat64_main;
 598   u32 thread_index = vm->thread_index;
 599   nat64_db_t *db = &nm->db[thread_index];
 600   nat64_static_bib_to_update_t *static_bib;
 601   nat64_db_bib_entry_t *bibe;
 602   ip46_address_t addr;
 603
 604   /* *INDENT-OFF* */
 605   pool_foreach (static_bib, nm->static_bibs,
 606   ({
 607     if ((static_bib->thread_index != thread_index) || (static_bib->done))
 608       continue;
 609
 610     if (static_bib->is_add)
 611       {
 612           (void) nat64_db_bib_entry_create (thread_index, db,
 613                                             &static_bib->in_addr,
 614                                             &static_bib->out_addr,
 615                                             static_bib->in_port,
 616                                             static_bib->out_port,
 617                                             static_bib->fib_index,
 618                                             static_bib->proto, 1);
 619           vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 620                                    db->bib.bib_entries_num);
 621       }
 622     else
 623       {
 624         addr.as_u64[0] = static_bib->in_addr.as_u64[0];
 625         addr.as_u64[1] = static_bib->in_addr.as_u64[1];
 626         bibe = nat64_db_bib_entry_find (db, &addr, static_bib->in_port,
 627                                         static_bib->proto,
 628                                         static_bib->fib_index, 1);
 629         if (bibe)
 630           {
 631             nat64_db_bib_entry_free (thread_index, db, bibe);
 632             vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 633                                      db->bib.bib_entries_num);
 634             vlib_set_simple_counter (&nm->total_sessions, thread_index, 0,
 635                                      db->st.st_entries_num);
 636           }
 637       }
 638
 639       static_bib->done = 1;
 640   }));
 641   /* *INDENT-ON* */
 642
 643   return 0;
 644 }
 645
 646 static vlib_node_registration_t nat64_static_bib_worker_node;
 647
 648 /* *INDENT-OFF* */
 649 VLIB_REGISTER_NODE (nat64_static_bib_worker_node, static) = {
 650     .function = nat64_static_bib_worker_fn,
 651     .type = VLIB_NODE_TYPE_INPUT,
 652     .state = VLIB_NODE_STATE_INTERRUPT,
 653     .name = "nat64-static-bib-worker",
 654 };
 655 /* *INDENT-ON* */
 656
 657 int
 658 nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
 659                                 ip4_address_t * out_addr, u16 in_port,
 660                                 u16 out_port, u8 proto, u32 vrf_id, u8 is_add)
 661 {
 662   nat64_main_t *nm = &nat64_main;
 663   nat64_db_bib_entry_t *bibe;
 664   u32 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id,
 665                                                      nat_fib_src_hi);
 666   snat_protocol_t p = ip_proto_to_snat_proto (proto);
 667   ip46_address_t addr;
 668   int i;
 669   snat_address_t *a;
 670   u32 thread_index = 0;
 671   nat64_db_t *db;
 672   nat64_static_bib_to_update_t *static_bib;
 673   vlib_main_t *worker_vm;
 674   u32 *to_be_free = 0, *index;
 675
 676   if (nm->sm->num_workers > 1)
 677     {
 678       thread_index = nat64_get_worker_in2out (in_addr);
 679       db = &nm->db[thread_index];
 680     }
 681   else
 682     db = &nm->db[nm->sm->num_workers];
 683
 684   addr.as_u64[0] = in_addr->as_u64[0];
 685   addr.as_u64[1] = in_addr->as_u64[1];
 686   bibe =
 687     nat64_db_bib_entry_find (db, &addr, clib_host_to_net_u16 (in_port),
 688                              proto, fib_index, 1);
 689
 690   if (is_add)
 691     {
 692       if (bibe)
 693         return VNET_API_ERROR_VALUE_EXIST;
 694
 695       /* outside port must be assigned to same thread as internall address */
 696       if ((out_port > 1024) && (nm->sm->num_workers > 1))
 697         {
 698           if (thread_index != ((out_port - 1024) / nm->sm->port_per_thread))
 699             return VNET_API_ERROR_INVALID_VALUE_2;
 700         }
 701
 702       for (i = 0; i < vec_len (nm->addr_pool); i++)
 703         {
 704           a = nm->addr_pool + i;
 705           if (out_addr->as_u32 != a->addr.as_u32)
 706             continue;
 707           switch (p)
 708             {
 709 #define _(N, j, n, s) \
 710             case SNAT_PROTOCOL_##N: \
 711               if (a->busy_##n##_port_refcounts[out_port]) \
 712                 return VNET_API_ERROR_INVALID_VALUE; \
 713               ++a->busy_##n##_port_refcounts[out_port]; \
 714               if (out_port > 1024) \
 715                 { \
 716                   a->busy_##n##_ports++; \
 717                   a->busy_##n##_ports_per_thread[thread_index]++; \
 718                 } \
 719               break;
 720               foreach_snat_protocol
 721 #undef _
 722             default:
 723               clib_memset (&addr, 0, sizeof (addr));
 724               addr.ip4.as_u32 = out_addr->as_u32;
 725               if (nat64_db_bib_entry_find (db, &addr, 0, proto, fib_index, 0))
 726                 return VNET_API_ERROR_INVALID_VALUE;
 727             }
 728           break;
 729         }
 730       if (!nm->sm->num_workers)
 731         {
 732           bibe =
 733             nat64_db_bib_entry_create (thread_index, db, in_addr, out_addr,
 734                                        clib_host_to_net_u16 (in_port),
 735                                        clib_host_to_net_u16 (out_port),
 736                                        fib_index, proto, 1);
 737           if (!bibe)
 738             return VNET_API_ERROR_UNSPECIFIED;
 739
 740           vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 741                                    db->bib.bib_entries_num);
 742         }
 743     }
 744   else
 745     {
 746       if (!bibe)
 747         return VNET_API_ERROR_NO_SUCH_ENTRY;
 748
 749       if (!nm->sm->num_workers)
 750         {
 751           nat64_db_bib_entry_free (thread_index, db, bibe);
 752           vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
 753                                    db->bib.bib_entries_num);
 754         }
 755     }
 756
 757   if (nm->sm->num_workers)
 758     {
 759       /* *INDENT-OFF* */
 760       pool_foreach (static_bib, nm->static_bibs,
 761       ({
 762         if (static_bib->done)
 763           vec_add1 (to_be_free, static_bib - nm->static_bibs);
 764       }));
 765       vec_foreach (index, to_be_free)
 766         pool_put_index (nm->static_bibs, index[0]);
 767       /* *INDENT-ON* */
 768       vec_free (to_be_free);
 769       pool_get (nm->static_bibs, static_bib);
 770       static_bib->in_addr.as_u64[0] = in_addr->as_u64[0];
 771       static_bib->in_addr.as_u64[1] = in_addr->as_u64[1];
 772       static_bib->in_port = clib_host_to_net_u16 (in_port);
 773       static_bib->out_addr.as_u32 = out_addr->as_u32;
 774       static_bib->out_port = clib_host_to_net_u16 (out_port);
 775       static_bib->fib_index = fib_index;
 776       static_bib->proto = proto;
 777       static_bib->is_add = is_add;
 778       static_bib->thread_index = thread_index;
 779       static_bib->done = 0;
 780       worker_vm = vlib_mains[thread_index];
 781       if (worker_vm)
 782         vlib_node_set_interrupt_pending (worker_vm,
 783                                          nat64_static_bib_worker_node.index);
 784       else
 785         return VNET_API_ERROR_UNSPECIFIED;
 786     }
 787
 788   return 0;
 789 }
 790
 791 int
 792 nat64_set_udp_timeout (u32 timeout)
 793 {
 794   nat64_main_t *nm = &nat64_main;
 795
 796   if (timeout == 0)
 797     nm->udp_timeout = SNAT_UDP_TIMEOUT;
 798   else
 799     nm->udp_timeout = timeout;
 800
 801   return 0;
 802 }
 803
 804 u32
 805 nat64_get_udp_timeout (void)
 806 {
 807   nat64_main_t *nm = &nat64_main;
 808
 809   return nm->udp_timeout;
 810 }
 811
 812 int
 813 nat64_set_icmp_timeout (u32 timeout)
 814 {
 815   nat64_main_t *nm = &nat64_main;
 816
 817   if (timeout == 0)
 818     nm->icmp_timeout = SNAT_ICMP_TIMEOUT;
 819   else
 820     nm->icmp_timeout = timeout;
 821
 822   return 0;
 823 }
 824
 825 u32
 826 nat64_get_icmp_timeout (void)
 827 {
 828   nat64_main_t *nm = &nat64_main;
 829
 830   return nm->icmp_timeout;
 831 }
 832
 833 int
 834 nat64_set_tcp_timeouts (u32 trans, u32 est)
 835 {
 836   nat64_main_t *nm = &nat64_main;
 837
 838   if (trans == 0)
 839     nm->tcp_trans_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
 840   else
 841     nm->tcp_trans_timeout = trans;
 842
 843   if (est == 0)
 844     nm->tcp_est_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
 845   else
 846     nm->tcp_est_timeout = est;
 847
 848   return 0;
 849 }
 850
 851 u32
 852 nat64_get_tcp_trans_timeout (void)
 853 {
 854   nat64_main_t *nm = &nat64_main;
 855
 856   return nm->tcp_trans_timeout;
 857 }
 858
 859 u32
 860 nat64_get_tcp_est_timeout (void)
 861 {
 862   nat64_main_t *nm = &nat64_main;
 863
 864   return nm->tcp_est_timeout;
 865 }
 866
 867 void
 868 nat64_session_reset_timeout (nat64_db_st_entry_t * ste, vlib_main_t * vm)
 869 {
 870   nat64_main_t *nm = &nat64_main;
 871   u32 now = (u32) vlib_time_now (vm);
 872
 873   switch (ip_proto_to_snat_proto (ste->proto))
 874     {
 875     case SNAT_PROTOCOL_ICMP:
 876       ste->expire = now + nm->icmp_timeout;
 877       return;
 878     case SNAT_PROTOCOL_TCP:
 879       {
 880         switch (ste->tcp_state)
 881           {
 882           case NAT64_TCP_STATE_V4_INIT:
 883           case NAT64_TCP_STATE_V6_INIT:
 884           case NAT64_TCP_STATE_V4_FIN_RCV:
 885           case NAT64_TCP_STATE_V6_FIN_RCV:
 886           case NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV:
 887           case NAT64_TCP_STATE_TRANS:
 888             ste->expire = now + nm->tcp_trans_timeout;
 889             return;
 890           case NAT64_TCP_STATE_ESTABLISHED:
 891             ste->expire = now + nm->tcp_est_timeout;
 892             return;
 893           default:
 894             return;
 895           }
 896       }
 897     case SNAT_PROTOCOL_UDP:
 898       ste->expire = now + nm->udp_timeout;
 899       return;
 900     default:
 901       ste->expire = now + nm->udp_timeout;
 902       return;
 903     }
 904 }
 905
 906 void
 907 nat64_tcp_session_set_state (nat64_db_st_entry_t * ste, tcp_header_t * tcp,
 908                              u8 is_ip6)
 909 {
 910   switch (ste->tcp_state)
 911     {
 912     case NAT64_TCP_STATE_CLOSED:
 913       {
 914         if (tcp->flags & TCP_FLAG_SYN)
 915           {
 916             if (is_ip6)
 917               ste->tcp_state = NAT64_TCP_STATE_V6_INIT;
 918             else
 919               ste->tcp_state = NAT64_TCP_STATE_V4_INIT;
 920           }
 921         return;
 922       }
 923     case NAT64_TCP_STATE_V4_INIT:
 924       {
 925         if (is_ip6 && (tcp->flags & TCP_FLAG_SYN))
 926           ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
 927         return;
 928       }
 929     case NAT64_TCP_STATE_V6_INIT:
 930       {
 931         if (!is_ip6 && (tcp->flags & TCP_FLAG_SYN))
 932           ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
 933         return;
 934       }
 935     case NAT64_TCP_STATE_ESTABLISHED:
 936       {
 937         if (tcp->flags & TCP_FLAG_FIN)
 938           {
 939             if (is_ip6)
 940               ste->tcp_state = NAT64_TCP_STATE_V6_FIN_RCV;
 941             else
 942               ste->tcp_state = NAT64_TCP_STATE_V4_FIN_RCV;
 943           }
 944         else if (tcp->flags & TCP_FLAG_RST)
 945           {
 946             ste->tcp_state = NAT64_TCP_STATE_TRANS;
 947           }
 948         return;
 949       }
 950     case NAT64_TCP_STATE_V4_FIN_RCV:
 951       {
 952         if (is_ip6 && (tcp->flags & TCP_FLAG_FIN))
 953           ste->tcp_state = NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV;
 954         return;
 955       }
 956     case NAT64_TCP_STATE_V6_FIN_RCV:
 957       {
 958         if (!is_ip6 && (tcp->flags & TCP_FLAG_FIN))
 959           ste->tcp_state = NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV;
 960         return;
 961       }
 962     case NAT64_TCP_STATE_TRANS:
 963       {
 964         if (!(tcp->flags & TCP_FLAG_RST))
 965           ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
 966         return;
 967       }
 968     default:
 969       return;
 970     }
 971 }
 972
 973 int
 974 nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id, u8 is_add)
 975 {
 976   nat64_main_t *nm = &nat64_main;
 977   nat64_prefix_t *p = 0;
 978   int i;
 979
 980   /* Verify prefix length */
 981   if (plen != 32 && plen != 40 && plen != 48 && plen != 56 && plen != 64
 982       && plen != 96)
 983     return VNET_API_ERROR_INVALID_VALUE;
 984
 985   /* Check if tenant already have prefix */
 986   for (i = 0; i < vec_len (nm->pref64); i++)
 987     {
 988       if (nm->pref64[i].vrf_id == vrf_id)
 989         {
 990           p = nm->pref64 + i;
 991           break;
 992         }
 993     }
 994
 995   if (is_add)
 996     {
 997       if (!p)
 998         {
 999           vec_add2 (nm->pref64, p, 1);
1000           p->fib_index =
1001             fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id,
1002                                                nat_fib_src_hi);
1003           p->vrf_id = vrf_id;
1004         }
1005
1006       p->prefix.as_u64[0] = prefix->as_u64[0];
1007       p->prefix.as_u64[1] = prefix->as_u64[1];
1008       p->plen = plen;
1009     }
1010   else
1011     {
1012       if (!p)
1013         return VNET_API_ERROR_NO_SUCH_ENTRY;
1014
1015       vec_del1 (nm->pref64, i);
1016     }
1017
1018   return 0;
1019 }
1020
1021 void
1022 nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx)
1023 {
1024   nat64_main_t *nm = &nat64_main;
1025   nat64_prefix_t *p = 0;
1026
1027   /* *INDENT-OFF* */
1028   vec_foreach (p, nm->pref64)
1029     {
1030       if (fn (p, ctx))
1031         break;
1032     };
1033   /* *INDENT-ON* */
1034 }
1035
1036 void
1037 nat64_compose_ip6 (ip6_address_t * ip6, ip4_address_t * ip4, u32 fib_index)
1038 {
1039   nat64_main_t *nm = &nat64_main;
1040   nat64_prefix_t *p, *gp = 0, *prefix = 0;
1041
1042   /* *INDENT-OFF* */
1043   vec_foreach (p, nm->pref64)
1044     {
1045       if (p->fib_index == fib_index)
1046         {
1047           prefix = p;
1048           break;
1049         }
1050
1051       if (p->fib_index == 0)
1052         gp = p;
1053     };
1054   /* *INDENT-ON* */
1055
1056   if (!prefix)
1057     prefix = gp;
1058
1059   if (prefix)
1060     {
1061       clib_memcpy_fast (ip6, &p->prefix, sizeof (ip6_address_t));
1062       switch (p->plen)
1063         {
1064         case 32:
1065           ip6->as_u32[1] = ip4->as_u32;
1066           break;
1067         case 40:
1068           ip6->as_u8[5] = ip4->as_u8[0];
1069           ip6->as_u8[6] = ip4->as_u8[1];
1070           ip6->as_u8[7] = ip4->as_u8[2];
1071           ip6->as_u8[9] = ip4->as_u8[3];
1072           break;
1073         case 48:
1074           ip6->as_u8[6] = ip4->as_u8[0];
1075           ip6->as_u8[7] = ip4->as_u8[1];
1076           ip6->as_u8[9] = ip4->as_u8[2];
1077           ip6->as_u8[10] = ip4->as_u8[3];
1078           break;
1079         case 56:
1080           ip6->as_u8[7] = ip4->as_u8[0];
1081           ip6->as_u8[9] = ip4->as_u8[1];
1082           ip6->as_u8[10] = ip4->as_u8[2];
1083           ip6->as_u8[11] = ip4->as_u8[3];
1084           break;
1085         case 64:
1086           ip6->as_u8[9] = ip4->as_u8[0];
1087           ip6->as_u8[10] = ip4->as_u8[1];
1088           ip6->as_u8[11] = ip4->as_u8[2];
1089           ip6->as_u8[12] = ip4->as_u8[3];
1090           break;
1091         case 96:
1092           ip6->as_u32[3] = ip4->as_u32;
1093           break;
1094         default:
1095           nat_elog_notice ("invalid prefix length");
1096           break;
1097         }
1098     }
1099   else
1100     {
1101       clib_memcpy_fast (ip6, well_known_prefix, sizeof (ip6_address_t));
1102       ip6->as_u32[3] = ip4->as_u32;
1103     }
1104 }
1105
1106 void
1107 nat64_extract_ip4 (ip6_address_t * ip6, ip4_address_t * ip4, u32 fib_index)
1108 {
1109   nat64_main_t *nm = &nat64_main;
1110   nat64_prefix_t *p, *gp = 0;
1111   u8 plen = 0;
1112
1113   /* *INDENT-OFF* */
1114   vec_foreach (p, nm->pref64)
1115     {
1116       if (p->fib_index == fib_index)
1117         {
1118           plen = p->plen;
1119           break;
1120         }
1121
1122       if (p->vrf_id == 0)
1123         gp = p;
1124     };
1125   /* *INDENT-ON* */
1126
1127   if (!plen)
1128     {
1129       if (gp)
1130         plen = gp->plen;
1131       else
1132         plen = 96;
1133     }
1134
1135   switch (plen)
1136     {
1137     case 32:
1138       ip4->as_u32 = ip6->as_u32[1];
1139       break;
1140     case 40:
1141       ip4->as_u8[0] = ip6->as_u8[5];
1142       ip4->as_u8[1] = ip6->as_u8[6];
1143       ip4->as_u8[2] = ip6->as_u8[7];
1144       ip4->as_u8[3] = ip6->as_u8[9];
1145       break;
1146     case 48:
1147       ip4->as_u8[0] = ip6->as_u8[6];
1148       ip4->as_u8[1] = ip6->as_u8[7];
1149       ip4->as_u8[2] = ip6->as_u8[9];
1150       ip4->as_u8[3] = ip6->as_u8[10];
1151       break;
1152     case 56:
1153       ip4->as_u8[0] = ip6->as_u8[7];
1154       ip4->as_u8[1] = ip6->as_u8[9];
1155       ip4->as_u8[2] = ip6->as_u8[10];
1156       ip4->as_u8[3] = ip6->as_u8[11];
1157       break;
1158     case 64:
1159       ip4->as_u8[0] = ip6->as_u8[9];
1160       ip4->as_u8[1] = ip6->as_u8[10];
1161       ip4->as_u8[2] = ip6->as_u8[11];
1162       ip4->as_u8[3] = ip6->as_u8[12];
1163       break;
1164     case 96:
1165       ip4->as_u32 = ip6->as_u32[3];
1166       break;
1167     default:
1168       nat_elog_notice ("invalid prefix length");
1169       break;
1170     }
1171 }
1172
1173 /**
1174  * @brief Per worker process checking expire time for NAT64 sessions.
1175  */
1176 static uword
1177 nat64_expire_worker_walk_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
1178                              vlib_frame_t * f)
1179 {
1180   nat64_main_t *nm = &nat64_main;
1181   u32 thread_index = vm->thread_index;
1182   nat64_db_t *db = &nm->db[thread_index];
1183   u32 now = (u32) vlib_time_now (vm);
1184
1185   nad64_db_st_free_expired (thread_index, db, now);
1186   vlib_set_simple_counter (&nm->total_bibs, thread_index, 0,
1187                            db->bib.bib_entries_num);
1188   vlib_set_simple_counter (&nm->total_sessions, thread_index, 0,
1189                            db->st.st_entries_num);
1190
1191   return 0;
1192 }
1193
1194 static vlib_node_registration_t nat64_expire_worker_walk_node;
1195
1196 /* *INDENT-OFF* */
1197 VLIB_REGISTER_NODE (nat64_expire_worker_walk_node, static) = {
1198     .function = nat64_expire_worker_walk_fn,
1199     .type = VLIB_NODE_TYPE_INPUT,
1200     .state = VLIB_NODE_STATE_INTERRUPT,
1201     .name = "nat64-expire-worker-walk",
1202 };
1203 /* *INDENT-ON* */
1204
1205 static vlib_node_registration_t nat64_expire_walk_node;
1206
1207 /**
1208  * @brief Centralized process to drive per worker expire walk.
1209  */
1210 static uword
1211 nat64_expire_walk_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
1212                       vlib_frame_t * f)
1213 {
1214   nat64_main_t *nm = &nat64_main;
1215   vlib_main_t **worker_vms = 0, *worker_vm;
1216   int i;
1217   uword event_type, *event_data = 0;
1218
1219   nm->nat64_expire_walk_node_index = nat64_expire_walk_node.index;
1220
1221   if (vec_len (vlib_mains) == 0)
1222     vec_add1 (worker_vms, vm);
1223   else
1224     {
1225       for (i = 0; i < vec_len (vlib_mains); i++)
1226         {
1227           worker_vm = vlib_mains[i];
1228           if (worker_vm)
1229             vec_add1 (worker_vms, worker_vm);
1230         }
1231     }
1232
1233   while (1)
1234     {
1235       if (nm->total_enabled_count)
1236         {
1237           vlib_process_wait_for_event_or_clock (vm, 10.0);
1238           event_type = vlib_process_get_events (vm, &event_data);
1239         }
1240       else
1241         {
1242           vlib_process_wait_for_event (vm);
1243           event_type = vlib_process_get_events (vm, &event_data);
1244         }
1245
1246       switch (event_type)
1247         {
1248         case ~0:
1249           break;
1250         case NAT64_CLEANER_RESCHEDULE:
1251           break;
1252         default:
1253           nat_elog_notice_X1 ("unknown event %d", "i4", event_type);
1254           break;
1255         }
1256
1257       for (i = 0; i < vec_len (worker_vms); i++)
1258         {
1259           worker_vm = worker_vms[i];
1260           vlib_node_set_interrupt_pending (worker_vm,
1261                                            nat64_expire_worker_walk_node.index);
1262         }
1263     }
1264
1265   return 0;
1266 }
1267
1268 /* *INDENT-OFF* */
1269 VLIB_REGISTER_NODE (nat64_expire_walk_node, static) = {
1270     .function = nat64_expire_walk_fn,
1271     .type = VLIB_NODE_TYPE_PROCESS,
1272     .name = "nat64-expire-walk",
1273 };
1274 /* *INDENT-ON* */
1275
1276 /*
1277  * fd.io coding-style-patch-verification: ON
1278  *
1279  * Local Variables:
1280  * eval: (c-set-style "gnu")
1281  * End:
1282  */