src/plugins/snat/snat.c

   1 /*
   2  * snat.c - simple nat plugin
   3  *
   4  * Copyright (c) 2016 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/ip/ip.h>
  20 #include <vnet/ip/ip4.h>
  21 #include <vnet/plugin/plugin.h>
  22 #include <snat/snat.h>
  23 #include <snat/snat_ipfix_logging.h>
  24 #include <snat/snat_det.h>
  25 #include <vnet/fib/fib_table.h>
  26 #include <vnet/fib/ip4_fib.h>
  27
  28 #include <vlibapi/api.h>
  29 #include <vlibmemory/api.h>
  30 #include <vlibsocket/api.h>
  31 #include <vpp/app/version.h>
  32
  33 snat_main_t snat_main;
  34
  35 /* define message IDs */
  36 #include <snat/snat_msg_enum.h>
  37
  38 /* define message structures */
  39 #define vl_typedefs
  40 #include <snat/snat_all_api_h.h>
  41 #undef vl_typedefs
  42
  43 /* define generated endian-swappers */
  44 #define vl_endianfun
  45 #include <snat/snat_all_api_h.h>
  46 #undef vl_endianfun
  47
  48 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  49
  50 #define REPLY_MSG_ID_BASE sm->msg_id_base
  51 #include <vlibapi/api_helper_macros.h>
  52
  53 /* Get the API version number */
  54 #define vl_api_version(n,v) static u32 api_version=(v);
  55 #include <snat/snat_all_api_h.h>
  56 #undef vl_api_version
  57
  58 /* Macro to finish up custom dump fns */
  59 #define FINISH                                  \
  60     vec_add1 (s, 0);                            \
  61     vl_print (handle, (char *)s);               \
  62     vec_free (s);                               \
  63     return handle;
  64
  65 /* Hook up input features */
  66 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
  67   .arc_name = "ip4-unicast",
  68   .node_name = "snat-in2out",
  69   .runs_before = VNET_FEATURES ("snat-out2in"),
  70 };
  71 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
  72   .arc_name = "ip4-unicast",
  73   .node_name = "snat-out2in",
  74   .runs_before = VNET_FEATURES ("ip4-lookup"),
  75 };
  76 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
  77   .arc_name = "ip4-unicast",
  78   .node_name = "snat-det-in2out",
  79   .runs_before = VNET_FEATURES ("snat-det-out2in"),
  80 };
  81 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
  82   .arc_name = "ip4-unicast",
  83   .node_name = "snat-det-out2in",
  84   .runs_before = VNET_FEATURES ("ip4-lookup"),
  85 };
  86 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
  87   .arc_name = "ip4-unicast",
  88   .node_name = "snat-in2out-worker-handoff",
  89   .runs_before = VNET_FEATURES ("snat-out2in-worker-handoff"),
  90 };
  91 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
  92   .arc_name = "ip4-unicast",
  93   .node_name = "snat-out2in-worker-handoff",
  94   .runs_before = VNET_FEATURES ("ip4-lookup"),
  95 };
  96 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
  97   .arc_name = "ip4-unicast",
  98   .node_name = "snat-in2out-fast",
  99   .runs_before = VNET_FEATURES ("snat-out2in-fast"),
 100 };
 101 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
 102   .arc_name = "ip4-unicast",
 103   .node_name = "snat-out2in-fast",
 104   .runs_before = VNET_FEATURES ("ip4-lookup"),
 105 };
 106
 107 /* *INDENT-OFF* */
 108 VLIB_PLUGIN_REGISTER () = {
 109     .version = VPP_BUILD_VER,
 110     .description = "Network Address Translation",
 111 };
 112 /* *INDENT-ON* */
 113
 114 /**
 115  * @brief Add/del NAT address to FIB.
 116  *
 117  * Add the external NAT address to the FIB as receive entries. This ensures
 118  * that VPP will reply to ARP for this address and we don't need to enable
 119  * proxy ARP on the outside interface.
 120  *
 121  * @param addr IPv4 address.
 122  * @param plen address prefix length
 123  * @param sw_if_index Interface.
 124  * @param is_add If 0 delete, otherwise add.
 125  */
 126 void
 127 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
 128                           int is_add)
 129 {
 130   fib_prefix_t prefix = {
 131     .fp_len = p_len,
 132     .fp_proto = FIB_PROTOCOL_IP4,
 133     .fp_addr = {
 134         .ip4.as_u32 = addr->as_u32,
 135     },
 136   };
 137   u32 fib_index = ip4_fib_table_get_index_for_sw_if_index(sw_if_index);
 138
 139   if (is_add)
 140     fib_table_entry_update_one_path(fib_index,
 141                                     &prefix,
 142                                     FIB_SOURCE_PLUGIN_HI,
 143                                     (FIB_ENTRY_FLAG_CONNECTED |
 144                                      FIB_ENTRY_FLAG_LOCAL |
 145                                      FIB_ENTRY_FLAG_EXCLUSIVE),
 146                                     FIB_PROTOCOL_IP4,
 147                                     NULL,
 148                                     sw_if_index,
 149                                     ~0,
 150                                     1,
 151                                     NULL,
 152                                     FIB_ROUTE_PATH_FLAG_NONE);
 153   else
 154     fib_table_entry_delete(fib_index,
 155                            &prefix,
 156                            FIB_SOURCE_PLUGIN_HI);
 157 }
 158
 159 void snat_add_address (snat_main_t *sm, ip4_address_t *addr, u32 vrf_id)
 160 {
 161   snat_address_t * ap;
 162   snat_interface_t *i;
 163
 164   if (vrf_id != ~0)
 165     sm->vrf_mode = 1;
 166
 167   /* Check if address already exists */
 168   vec_foreach (ap, sm->addresses)
 169     {
 170       if (ap->addr.as_u32 == addr->as_u32)
 171         return;
 172     }
 173
 174   vec_add2 (sm->addresses, ap, 1);
 175   ap->addr = *addr;
 176   ap->fib_index = ip4_fib_index_from_table_id(vrf_id);
 177 #define _(N, i, n, s) \
 178   clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535);
 179   foreach_snat_protocol
 180 #undef _
 181
 182   /* Add external address to FIB */
 183   pool_foreach (i, sm->interfaces,
 184   ({
 185     if (i->is_inside)
 186       continue;
 187
 188     snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
 189     break;
 190   }));
 191 }
 192
 193 static int is_snat_address_used_in_static_mapping (snat_main_t *sm,
 194                                                    ip4_address_t addr)
 195 {
 196   snat_static_mapping_t *m;
 197   pool_foreach (m, sm->static_mappings,
 198   ({
 199       if (m->external_addr.as_u32 == addr.as_u32)
 200         return 1;
 201   }));
 202
 203   return 0;
 204 }
 205
 206 static void increment_v4_address (ip4_address_t * a)
 207 {
 208   u32 v;
 209
 210   v = clib_net_to_host_u32(a->as_u32) + 1;
 211   a->as_u32 = clib_host_to_net_u32(v);
 212 }
 213
 214 static void
 215 snat_add_static_mapping_when_resolved (snat_main_t * sm,
 216                                        ip4_address_t l_addr,
 217                                        u16 l_port,
 218                                        u32 sw_if_index,
 219                                        u16 e_port,
 220                                        u32 vrf_id,
 221                                        snat_protocol_t proto,
 222                                        int addr_only,
 223                                        int is_add)
 224 {
 225   snat_static_map_resolve_t *rp;
 226
 227   vec_add2 (sm->to_resolve, rp, 1);
 228   rp->l_addr.as_u32 = l_addr.as_u32;
 229   rp->l_port = l_port;
 230   rp->sw_if_index = sw_if_index;
 231   rp->e_port = e_port;
 232   rp->vrf_id = vrf_id;
 233   rp->proto = proto;
 234   rp->addr_only = addr_only;
 235   rp->is_add = is_add;
 236 }
 237
 238 /**
 239  * @brief Add static mapping.
 240  *
 241  * Create static mapping between local addr+port and external addr+port.
 242  *
 243  * @param l_addr Local IPv4 address.
 244  * @param e_addr External IPv4 address.
 245  * @param l_port Local port number.
 246  * @param e_port External port number.
 247  * @param vrf_id VRF ID.
 248  * @param addr_only If 0 address port and pair mapping, otherwise address only.
 249  * @param sw_if_index External port instead of specific IP address.
 250  * @param is_add If 0 delete static mapping, otherwise add.
 251  *
 252  * @returns
 253  */
 254 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
 255                             u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
 256                             u32 sw_if_index, snat_protocol_t proto, int is_add)
 257 {
 258   snat_main_t * sm = &snat_main;
 259   snat_static_mapping_t *m;
 260   snat_session_key_t m_key;
 261   clib_bihash_kv_8_8_t kv, value;
 262   snat_address_t *a = 0;
 263   u32 fib_index = ~0;
 264   uword * p;
 265   snat_interface_t *interface;
 266   int i;
 267
 268   /* If the external address is a specific interface address */
 269   if (sw_if_index != ~0)
 270     {
 271       ip4_address_t * first_int_addr;
 272
 273       /* Might be already set... */
 274       first_int_addr = ip4_interface_first_address
 275         (sm->ip4_main, sw_if_index, 0 /* just want the address*/);
 276
 277       /* DHCP resolution required? */
 278       if (first_int_addr == 0)
 279         {
 280           snat_add_static_mapping_when_resolved
 281             (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
 282              addr_only,  is_add);
 283           return 0;
 284         }
 285         else
 286           e_addr.as_u32 = first_int_addr->as_u32;
 287     }
 288
 289   m_key.addr = e_addr;
 290   m_key.port = addr_only ? 0 : e_port;
 291   m_key.protocol = addr_only ? 0 : proto;
 292   m_key.fib_index = sm->outside_fib_index;
 293   kv.key = m_key.as_u64;
 294   if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
 295     m = 0;
 296   else
 297     m = pool_elt_at_index (sm->static_mappings, value.value);
 298
 299   if (is_add)
 300     {
 301       if (m)
 302         return VNET_API_ERROR_VALUE_EXIST;
 303
 304       /* Convert VRF id to FIB index */
 305       if (vrf_id != ~0)
 306         {
 307           p = hash_get (sm->ip4_main->fib_index_by_table_id, vrf_id);
 308           if (!p)
 309             return VNET_API_ERROR_NO_SUCH_FIB;
 310           fib_index = p[0];
 311         }
 312       /* If not specified use inside VRF id from SNAT plugin startup config */
 313       else
 314         {
 315           fib_index = sm->inside_fib_index;
 316           vrf_id = sm->inside_vrf_id;
 317         }
 318
 319       /* Find external address in allocated addresses and reserve port for
 320          address and port pair mapping when dynamic translations enabled */
 321       if (!addr_only && !(sm->static_mapping_only))
 322         {
 323           for (i = 0; i < vec_len (sm->addresses); i++)
 324             {
 325               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
 326                 {
 327                   a = sm->addresses + i;
 328                   /* External port must be unused */
 329                   switch (proto)
 330                     {
 331 #define _(N, j, n, s) \
 332                     case SNAT_PROTOCOL_##N: \
 333                       if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
 334                         return VNET_API_ERROR_INVALID_VALUE; \
 335                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
 336                       if (e_port > 1024) \
 337                         a->busy_##n##_ports++; \
 338                       break;
 339                       foreach_snat_protocol
 340 #undef _
 341                     default:
 342                       clib_warning("unknown_protocol");
 343                       return VNET_API_ERROR_INVALID_VALUE_2;
 344                     }
 345                   break;
 346                 }
 347             }
 348           /* External address must be allocated */
 349           if (!a)
 350             return VNET_API_ERROR_NO_SUCH_ENTRY;
 351         }
 352
 353       pool_get (sm->static_mappings, m);
 354       memset (m, 0, sizeof (*m));
 355       m->local_addr = l_addr;
 356       m->external_addr = e_addr;
 357       m->addr_only = addr_only;
 358       m->vrf_id = vrf_id;
 359       m->fib_index = fib_index;
 360       if (!addr_only)
 361         {
 362           m->local_port = l_port;
 363           m->external_port = e_port;
 364           m->proto = proto;
 365         }
 366
 367       m_key.addr = m->local_addr;
 368       m_key.port = m->local_port;
 369       m_key.protocol = m->proto;
 370       m_key.fib_index = m->fib_index;
 371       kv.key = m_key.as_u64;
 372       kv.value = m - sm->static_mappings;
 373       clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
 374
 375       m_key.addr = m->external_addr;
 376       m_key.port = m->external_port;
 377       m_key.fib_index = sm->outside_fib_index;
 378       kv.key = m_key.as_u64;
 379       kv.value = m - sm->static_mappings;
 380       clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1);
 381
 382       /* Assign worker */
 383       if (sm->workers)
 384         {
 385           snat_user_key_t w_key0;
 386           snat_worker_key_t w_key1;
 387
 388           w_key0.addr = m->local_addr;
 389           w_key0.fib_index = m->fib_index;
 390           kv.key = w_key0.as_u64;
 391
 392           if (clib_bihash_search_8_8 (&sm->worker_by_in, &kv, &value))
 393             {
 394               kv.value = sm->first_worker_index +
 395                 sm->workers[sm->next_worker++ % vec_len (sm->workers)];
 396
 397               clib_bihash_add_del_8_8 (&sm->worker_by_in, &kv, 1);
 398             }
 399           else
 400             {
 401               kv.value = value.value;
 402             }
 403
 404           w_key1.addr = m->external_addr;
 405           w_key1.port = clib_host_to_net_u16 (m->external_port);
 406           w_key1.fib_index = sm->outside_fib_index;
 407           kv.key = w_key1.as_u64;
 408           clib_bihash_add_del_8_8 (&sm->worker_by_out, &kv, 1);
 409         }
 410     }
 411   else
 412     {
 413       if (!m)
 414         return VNET_API_ERROR_NO_SUCH_ENTRY;
 415
 416       /* Free external address port */
 417       if (!addr_only && !(sm->static_mapping_only))
 418         {
 419           for (i = 0; i < vec_len (sm->addresses); i++)
 420             {
 421               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
 422                 {
 423                   a = sm->addresses + i;
 424                   switch (proto)
 425                     {
 426 #define _(N, j, n, s) \
 427                     case SNAT_PROTOCOL_##N: \
 428                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
 429                       if (e_port > 1024) \
 430                         a->busy_##n##_ports--; \
 431                       break;
 432                       foreach_snat_protocol
 433 #undef _
 434                     default:
 435                       clib_warning("unknown_protocol");
 436                       return VNET_API_ERROR_INVALID_VALUE_2;
 437                     }
 438                   break;
 439                 }
 440             }
 441         }
 442
 443       m_key.addr = m->local_addr;
 444       m_key.port = m->local_port;
 445       m_key.protocol = m->proto;
 446       m_key.fib_index = m->fib_index;
 447       kv.key = m_key.as_u64;
 448       clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0);
 449
 450       m_key.addr = m->external_addr;
 451       m_key.port = m->external_port;
 452       m_key.fib_index = sm->outside_fib_index;
 453       kv.key = m_key.as_u64;
 454       clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0);
 455
 456       /* Delete session(s) for static mapping if exist */
 457       if (!(sm->static_mapping_only) ||
 458           (sm->static_mapping_only && sm->static_mapping_connection_tracking))
 459         {
 460           snat_user_key_t u_key;
 461           snat_user_t *u;
 462           dlist_elt_t * head, * elt;
 463           u32 elt_index, head_index, del_elt_index;
 464           u32 ses_index;
 465           u64 user_index;
 466           snat_session_t * s;
 467           snat_main_per_thread_data_t *tsm;
 468
 469           u_key.addr = m->local_addr;
 470           u_key.fib_index = m->fib_index;
 471           kv.key = u_key.as_u64;
 472           if (!clib_bihash_search_8_8 (&sm->user_hash, &kv, &value))
 473             {
 474               user_index = value.value;
 475               if (!clib_bihash_search_8_8 (&sm->worker_by_in, &kv, &value))
 476                 tsm = vec_elt_at_index (sm->per_thread_data, value.value);
 477               else
 478                 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
 479               u = pool_elt_at_index (tsm->users, user_index);
 480               if (u->nstaticsessions)
 481                 {
 482                   head_index = u->sessions_per_user_list_head_index;
 483                   head = pool_elt_at_index (tsm->list_pool, head_index);
 484                   elt_index = head->next;
 485                   elt = pool_elt_at_index (tsm->list_pool, elt_index);
 486                   ses_index = elt->value;
 487                   while (ses_index != ~0)
 488                     {
 489                       s =  pool_elt_at_index (tsm->sessions, ses_index);
 490                       del_elt_index = elt_index;
 491                       elt_index = elt->next;
 492                       elt = pool_elt_at_index (tsm->list_pool, elt_index);
 493                       ses_index = elt->value;
 494
 495                       if (!addr_only)
 496                         {
 497                           if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
 498                               (clib_net_to_host_u16 (s->out2in.port) != e_port))
 499                             continue;
 500                         }
 501
 502                       /* log NAT event */
 503                       snat_ipfix_logging_nat44_ses_delete(s->in2out.addr.as_u32,
 504                                                           s->out2in.addr.as_u32,
 505                                                           s->in2out.protocol,
 506                                                           s->in2out.port,
 507                                                           s->out2in.port,
 508                                                           s->in2out.fib_index);
 509
 510                       value.key = s->in2out.as_u64;
 511                       clib_bihash_add_del_8_8 (&sm->in2out, &value, 0);
 512                       value.key = s->out2in.as_u64;
 513                       clib_bihash_add_del_8_8 (&sm->out2in, &value, 0);
 514                       pool_put (tsm->sessions, s);
 515
 516                       clib_dlist_remove (tsm->list_pool, del_elt_index);
 517                       pool_put_index (tsm->list_pool, del_elt_index);
 518                       u->nstaticsessions--;
 519
 520                       if (!addr_only)
 521                         break;
 522                     }
 523                   if (addr_only)
 524                     {
 525                       pool_put (tsm->users, u);
 526                       clib_bihash_add_del_8_8 (&sm->user_hash, &kv, 0);
 527                     }
 528                 }
 529             }
 530         }
 531
 532       /* Delete static mapping from pool */
 533       pool_put (sm->static_mappings, m);
 534     }
 535
 536   if (!addr_only)
 537     return 0;
 538
 539   /* Add/delete external address to FIB */
 540   pool_foreach (interface, sm->interfaces,
 541   ({
 542     if (interface->is_inside)
 543       continue;
 544
 545     snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
 546     break;
 547   }));
 548
 549   return 0;
 550 }
 551
 552 int snat_del_address (snat_main_t *sm, ip4_address_t addr, u8 delete_sm)
 553 {
 554   snat_address_t *a = 0;
 555   snat_session_t *ses;
 556   u32 *ses_to_be_removed = 0, *ses_index;
 557   clib_bihash_kv_8_8_t kv, value;
 558   snat_user_key_t user_key;
 559   snat_user_t *u;
 560   snat_main_per_thread_data_t *tsm;
 561   snat_static_mapping_t *m;
 562   snat_interface_t *interface;
 563   int i;
 564
 565   /* Find SNAT address */
 566   for (i=0; i < vec_len (sm->addresses); i++)
 567     {
 568       if (sm->addresses[i].addr.as_u32 == addr.as_u32)
 569         {
 570           a = sm->addresses + i;
 571           break;
 572         }
 573     }
 574   if (!a)
 575     return VNET_API_ERROR_NO_SUCH_ENTRY;
 576
 577   if (delete_sm)
 578     {
 579       pool_foreach (m, sm->static_mappings,
 580       ({
 581           if (m->external_addr.as_u32 == addr.as_u32)
 582             (void) snat_add_static_mapping (m->local_addr, m->external_addr,
 583                                             m->local_port, m->external_port,
 584                                             m->vrf_id, m->addr_only, ~0,
 585                                             m->proto, 0);
 586       }));
 587     }
 588   else
 589     {
 590       /* Check if address is used in some static mapping */
 591       if (is_snat_address_used_in_static_mapping(sm, addr))
 592         {
 593           clib_warning ("address used in static mapping");
 594           return VNET_API_ERROR_UNSPECIFIED;
 595         }
 596     }
 597
 598   /* Delete sessions using address */
 599   if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
 600     {
 601       vec_foreach (tsm, sm->per_thread_data)
 602         {
 603           pool_foreach (ses, tsm->sessions, ({
 604             if (ses->out2in.addr.as_u32 == addr.as_u32)
 605               {
 606                 /* log NAT event */
 607                 snat_ipfix_logging_nat44_ses_delete(ses->in2out.addr.as_u32,
 608                                                     ses->out2in.addr.as_u32,
 609                                                     ses->in2out.protocol,
 610                                                     ses->in2out.port,
 611                                                     ses->out2in.port,
 612                                                     ses->in2out.fib_index);
 613                 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
 614                 kv.key = ses->in2out.as_u64;
 615                 clib_bihash_add_del_8_8 (&sm->in2out, &kv, 0);
 616                 kv.key = ses->out2in.as_u64;
 617                 clib_bihash_add_del_8_8 (&sm->out2in, &kv, 0);
 618                 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
 619                 user_key.addr = ses->in2out.addr;
 620                 user_key.fib_index = ses->in2out.fib_index;
 621                 kv.key = user_key.as_u64;
 622                 if (!clib_bihash_search_8_8 (&sm->user_hash, &kv, &value))
 623                   {
 624                     u = pool_elt_at_index (tsm->users, value.value);
 625                     u->nsessions--;
 626                   }
 627               }
 628           }));
 629
 630           vec_foreach (ses_index, ses_to_be_removed)
 631             pool_put_index (tsm->sessions, ses_index[0]);
 632
 633           vec_free (ses_to_be_removed);
 634        }
 635     }
 636
 637   vec_del1 (sm->addresses, i);
 638
 639   /* Delete external address from FIB */
 640   pool_foreach (interface, sm->interfaces,
 641   ({
 642     if (interface->is_inside)
 643       continue;
 644
 645     snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
 646     break;
 647   }));
 648
 649   return 0;
 650 }
 651
 652 static int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
 653 {
 654   snat_main_t *sm = &snat_main;
 655   snat_interface_t *i;
 656   const char * feature_name;
 657   snat_address_t * ap;
 658   snat_static_mapping_t * m;
 659   snat_det_map_t * dm;
 660
 661   if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
 662     feature_name = is_inside ?  "snat-in2out-fast" : "snat-out2in-fast";
 663   else
 664     {
 665       if (sm->num_workers > 1 && !sm->deterministic)
 666         feature_name = is_inside ?  "snat-in2out-worker-handoff" : "snat-out2in-worker-handoff";
 667       else if (sm->deterministic)
 668         feature_name = is_inside ?  "snat-det-in2out" : "snat-det-out2in";
 669       else
 670         feature_name = is_inside ?  "snat-in2out" : "snat-out2in";
 671     }
 672
 673   vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index,
 674                                !is_del, 0, 0);
 675
 676   if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
 677     sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index, 0);
 678
 679   if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
 680     sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
 681
 682   pool_foreach (i, sm->interfaces,
 683   ({
 684     if (i->sw_if_index == sw_if_index)
 685       {
 686         if (is_del)
 687           pool_put (sm->interfaces, i);
 688         else
 689           return VNET_API_ERROR_VALUE_EXIST;
 690
 691         goto fib;
 692       }
 693   }));
 694
 695   if (is_del)
 696     return VNET_API_ERROR_NO_SUCH_ENTRY;
 697
 698   pool_get (sm->interfaces, i);
 699   i->sw_if_index = sw_if_index;
 700   i->is_inside = is_inside;
 701
 702   /* Add/delete external addresses to FIB */
 703 fib:
 704   if (is_inside)
 705     return 0;
 706
 707   vec_foreach (ap, sm->addresses)
 708     snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
 709
 710   pool_foreach (m, sm->static_mappings,
 711   ({
 712     if (!(m->addr_only))
 713       continue;
 714
 715     snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
 716   }));
 717
 718   pool_foreach (dm, sm->det_maps,
 719   ({
 720     snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
 721   }));
 722
 723   return 0;
 724 }
 725
 726 static int snat_set_workers (uword * bitmap)
 727 {
 728   snat_main_t *sm = &snat_main;
 729   int i;
 730
 731   if (sm->num_workers < 2)
 732     return VNET_API_ERROR_FEATURE_DISABLED;
 733
 734   if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
 735     return VNET_API_ERROR_INVALID_WORKER;
 736
 737   vec_free (sm->workers);
 738   clib_bitmap_foreach (i, bitmap,
 739     ({
 740       vec_add1(sm->workers, i);
 741     }));
 742
 743   return 0;
 744 }
 745
 746 static void
 747 vl_api_snat_add_address_range_t_handler
 748 (vl_api_snat_add_address_range_t * mp)
 749 {
 750   snat_main_t * sm = &snat_main;
 751   vl_api_snat_add_address_range_reply_t * rmp;
 752   ip4_address_t this_addr;
 753   u32 start_host_order, end_host_order;
 754   u32 vrf_id;
 755   int i, count;
 756   int rv = 0;
 757   u32 * tmp;
 758
 759   if (mp->is_ip4 != 1)
 760     {
 761       rv = VNET_API_ERROR_UNIMPLEMENTED;
 762       goto send_reply;
 763     }
 764
 765   if (sm->static_mapping_only)
 766     {
 767       rv = VNET_API_ERROR_FEATURE_DISABLED;
 768       goto send_reply;
 769     }
 770
 771   tmp = (u32 *) mp->first_ip_address;
 772   start_host_order = clib_host_to_net_u32 (tmp[0]);
 773   tmp = (u32 *) mp->last_ip_address;
 774   end_host_order = clib_host_to_net_u32 (tmp[0]);
 775
 776   count = (end_host_order - start_host_order) + 1;
 777
 778   vrf_id = clib_host_to_net_u32 (mp->vrf_id);
 779
 780   if (count > 1024)
 781     clib_warning ("%U - %U, %d addresses...",
 782                   format_ip4_address, mp->first_ip_address,
 783                   format_ip4_address, mp->last_ip_address,
 784                   count);
 785
 786   memcpy (&this_addr.as_u8, mp->first_ip_address, 4);
 787
 788   for (i = 0; i < count; i++)
 789     {
 790       if (mp->is_add)
 791         snat_add_address (sm, &this_addr, vrf_id);
 792       else
 793         rv = snat_del_address (sm, this_addr, 0);
 794
 795       if (rv)
 796         goto send_reply;
 797
 798       increment_v4_address (&this_addr);
 799     }
 800
 801  send_reply:
 802   REPLY_MACRO (VL_API_SNAT_ADD_ADDRESS_RANGE_REPLY);
 803 }
 804
 805 static void *vl_api_snat_add_address_range_t_print
 806 (vl_api_snat_add_address_range_t *mp, void * handle)
 807 {
 808   u8 * s;
 809
 810   s = format (0, "SCRIPT: snat_add_address_range ");
 811   s = format (s, "%U ", format_ip4_address, mp->first_ip_address);
 812   if (memcmp (mp->first_ip_address, mp->last_ip_address, 4))
 813     {
 814       s = format (s, " - %U ", format_ip4_address, mp->last_ip_address);
 815     }
 816   FINISH;
 817 }
 818
 819 static void
 820 send_snat_address_details
 821 (snat_address_t * a, unix_shared_memory_queue_t * q, u32 context)
 822 {
 823   vl_api_snat_address_details_t *rmp;
 824   snat_main_t * sm = &snat_main;
 825
 826   rmp = vl_msg_api_alloc (sizeof (*rmp));
 827   memset (rmp, 0, sizeof (*rmp));
 828   rmp->_vl_msg_id = ntohs (VL_API_SNAT_ADDRESS_DETAILS+sm->msg_id_base);
 829   rmp->is_ip4 = 1;
 830   clib_memcpy (rmp->ip_address, &(a->addr), 4);
 831   if (a->fib_index != ~0)
 832     rmp->vrf_id = ntohl(ip4_fib_get(a->fib_index)->table_id);
 833   else
 834     rmp->vrf_id = ~0;
 835   rmp->context = context;
 836
 837   vl_msg_api_send_shmem (q, (u8 *) & rmp);
 838 }
 839
 840 static void
 841 vl_api_snat_address_dump_t_handler
 842 (vl_api_snat_address_dump_t * mp)
 843 {
 844   unix_shared_memory_queue_t *q;
 845   snat_main_t * sm = &snat_main;
 846   snat_address_t * a;
 847
 848   q = vl_api_client_index_to_input_queue (mp->client_index);
 849   if (q == 0)
 850     return;
 851
 852   vec_foreach (a, sm->addresses)
 853     send_snat_address_details (a, q, mp->context);
 854 }
 855
 856 static void *vl_api_snat_address_dump_t_print
 857 (vl_api_snat_address_dump_t *mp, void * handle)
 858 {
 859   u8 *s;
 860
 861   s = format (0, "SCRIPT: snat_address_dump ");
 862
 863   FINISH;
 864 }
 865
 866 static void
 867 vl_api_snat_interface_add_del_feature_t_handler
 868 (vl_api_snat_interface_add_del_feature_t * mp)
 869 {
 870   snat_main_t * sm = &snat_main;
 871   vl_api_snat_interface_add_del_feature_reply_t * rmp;
 872   u8 is_del = mp->is_add == 0;
 873   u32 sw_if_index = ntohl(mp->sw_if_index);
 874   int rv = 0;
 875
 876   VALIDATE_SW_IF_INDEX(mp);
 877
 878   rv = snat_interface_add_del (sw_if_index, mp->is_inside, is_del);
 879
 880   BAD_SW_IF_INDEX_LABEL;
 881
 882   REPLY_MACRO(VL_API_SNAT_INTERFACE_ADD_DEL_FEATURE_REPLY);
 883 }
 884
 885 static void *vl_api_snat_interface_add_del_feature_t_print
 886 (vl_api_snat_interface_add_del_feature_t * mp, void *handle)
 887 {
 888   u8 * s;
 889
 890   s = format (0, "SCRIPT: snat_interface_add_del_feature ");
 891   s = format (s, "sw_if_index %d %s %s",
 892               clib_host_to_net_u32(mp->sw_if_index),
 893               mp->is_inside ? "in":"out",
 894               mp->is_add ? "" : "del");
 895
 896   FINISH;
 897 }
 898
 899 static void
 900 send_snat_interface_details
 901 (snat_interface_t * i, unix_shared_memory_queue_t * q, u32 context)
 902 {
 903   vl_api_snat_interface_details_t *rmp;
 904   snat_main_t * sm = &snat_main;
 905
 906   rmp = vl_msg_api_alloc (sizeof (*rmp));
 907   memset (rmp, 0, sizeof (*rmp));
 908   rmp->_vl_msg_id = ntohs (VL_API_SNAT_INTERFACE_DETAILS+sm->msg_id_base);
 909   rmp->sw_if_index = ntohl (i->sw_if_index);
 910   rmp->is_inside = i->is_inside;
 911   rmp->context = context;
 912
 913   vl_msg_api_send_shmem (q, (u8 *) & rmp);
 914 }
 915
 916 static void
 917 vl_api_snat_interface_dump_t_handler
 918 (vl_api_snat_interface_dump_t * mp)
 919 {
 920   unix_shared_memory_queue_t *q;
 921   snat_main_t * sm = &snat_main;
 922   snat_interface_t * i;
 923
 924   q = vl_api_client_index_to_input_queue (mp->client_index);
 925   if (q == 0)
 926     return;
 927
 928   pool_foreach (i, sm->interfaces,
 929   ({
 930     send_snat_interface_details(i, q, mp->context);
 931   }));
 932 }
 933
 934 static void *vl_api_snat_interface_dump_t_print
 935 (vl_api_snat_interface_dump_t *mp, void * handle)
 936 {
 937   u8 *s;
 938
 939   s = format (0, "SCRIPT: snat_interface_dump ");
 940
 941   FINISH;
 942 }static void
 943
 944 vl_api_snat_add_static_mapping_t_handler
 945 (vl_api_snat_add_static_mapping_t * mp)
 946 {
 947   snat_main_t * sm = &snat_main;
 948   vl_api_snat_add_static_mapping_reply_t * rmp;
 949   ip4_address_t local_addr, external_addr;
 950   u16 local_port = 0, external_port = 0;
 951   u32 vrf_id, external_sw_if_index;
 952   int rv = 0;
 953   snat_protocol_t proto;
 954
 955   if (mp->is_ip4 != 1)
 956     {
 957       rv = VNET_API_ERROR_UNIMPLEMENTED;
 958       goto send_reply;
 959     }
 960
 961   memcpy (&local_addr.as_u8, mp->local_ip_address, 4);
 962   memcpy (&external_addr.as_u8, mp->external_ip_address, 4);
 963   if (mp->addr_only == 0)
 964     {
 965       local_port = clib_net_to_host_u16 (mp->local_port);
 966       external_port = clib_net_to_host_u16 (mp->external_port);
 967     }
 968   vrf_id = clib_net_to_host_u32 (mp->vrf_id);
 969   external_sw_if_index = clib_net_to_host_u32 (mp->external_sw_if_index);
 970   proto = ip_proto_to_snat_proto (mp->protocol);
 971
 972   rv = snat_add_static_mapping(local_addr, external_addr, local_port,
 973                                external_port, vrf_id, mp->addr_only,
 974                                external_sw_if_index, proto, mp->is_add);
 975
 976  send_reply:
 977   REPLY_MACRO (VL_API_SNAT_ADD_ADDRESS_RANGE_REPLY);
 978 }
 979
 980 static void *vl_api_snat_add_static_mapping_t_print
 981 (vl_api_snat_add_static_mapping_t *mp, void * handle)
 982 {
 983   u8 * s;
 984
 985   s = format (0, "SCRIPT: snat_add_static_mapping ");
 986   s = format (s, "protocol %d local_addr %U external_addr %U ",
 987               mp->protocol,
 988               format_ip4_address, mp->local_ip_address,
 989               format_ip4_address, mp->external_ip_address);
 990
 991   if (mp->addr_only == 0)
 992     s = format (s, "local_port %d external_port %d ",
 993                 clib_net_to_host_u16 (mp->local_port),
 994                 clib_net_to_host_u16 (mp->external_port));
 995
 996   if (mp->vrf_id != ~0)
 997     s = format (s, "vrf %d", clib_net_to_host_u32 (mp->vrf_id));
 998
 999   if (mp->external_sw_if_index != ~0)
1000     s = format (s, "external_sw_if_index %d",
1001                 clib_net_to_host_u32 (mp->external_sw_if_index));
1002   FINISH;
1003 }
1004
1005 static void
1006 send_snat_static_mapping_details
1007 (snat_static_mapping_t * m, unix_shared_memory_queue_t * q, u32 context)
1008 {
1009   vl_api_snat_static_mapping_details_t *rmp;
1010   snat_main_t * sm = &snat_main;
1011
1012   rmp = vl_msg_api_alloc (sizeof (*rmp));
1013   memset (rmp, 0, sizeof (*rmp));
1014   rmp->_vl_msg_id = ntohs (VL_API_SNAT_STATIC_MAPPING_DETAILS+sm->msg_id_base);
1015   rmp->is_ip4 = 1;
1016   rmp->addr_only = m->addr_only;
1017   clib_memcpy (rmp->local_ip_address, &(m->local_addr), 4);
1018   clib_memcpy (rmp->external_ip_address, &(m->external_addr), 4);
1019   rmp->local_port = htons (m->local_port);
1020   rmp->external_port = htons (m->external_port);
1021   rmp->external_sw_if_index = ~0;
1022   rmp->vrf_id = htonl (m->vrf_id);
1023   rmp->protocol = snat_proto_to_ip_proto (m->proto);
1024   rmp->context = context;
1025
1026   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1027 }
1028
1029 static void
1030 send_snat_static_map_resolve_details
1031 (snat_static_map_resolve_t * m, unix_shared_memory_queue_t * q, u32 context)
1032 {
1033   vl_api_snat_static_mapping_details_t *rmp;
1034   snat_main_t * sm = &snat_main;
1035
1036   rmp = vl_msg_api_alloc (sizeof (*rmp));
1037   memset (rmp, 0, sizeof (*rmp));
1038   rmp->_vl_msg_id = ntohs (VL_API_SNAT_STATIC_MAPPING_DETAILS+sm->msg_id_base);
1039   rmp->is_ip4 = 1;
1040   rmp->addr_only = m->addr_only;
1041   clib_memcpy (rmp->local_ip_address, &(m->l_addr), 4);
1042   rmp->local_port = htons (m->l_port);
1043   rmp->external_port = htons (m->e_port);
1044   rmp->external_sw_if_index = htonl (m->sw_if_index);
1045   rmp->vrf_id = htonl (m->vrf_id);
1046   rmp->protocol = snat_proto_to_ip_proto (m->proto);
1047   rmp->context = context;
1048
1049   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1050 }
1051
1052 static void
1053 vl_api_snat_static_mapping_dump_t_handler
1054 (vl_api_snat_static_mapping_dump_t * mp)
1055 {
1056   unix_shared_memory_queue_t *q;
1057   snat_main_t * sm = &snat_main;
1058   snat_static_mapping_t * m;
1059   snat_static_map_resolve_t *rp;
1060   int j;
1061
1062   q = vl_api_client_index_to_input_queue (mp->client_index);
1063   if (q == 0)
1064     return;
1065
1066   pool_foreach (m, sm->static_mappings,
1067   ({
1068       send_snat_static_mapping_details (m, q, mp->context);
1069   }));
1070
1071   for (j = 0; j < vec_len (sm->to_resolve); j++)
1072    {
1073      rp = sm->to_resolve + j;
1074      send_snat_static_map_resolve_details (rp, q, mp->context);
1075    }
1076 }
1077
1078 static void *vl_api_snat_static_mapping_dump_t_print
1079 (vl_api_snat_static_mapping_dump_t *mp, void * handle)
1080 {
1081   u8 *s;
1082
1083   s = format (0, "SCRIPT: snat_static_mapping_dump ");
1084
1085   FINISH;
1086 }
1087
1088 static void
1089 vl_api_snat_control_ping_t_handler
1090 (vl_api_snat_control_ping_t * mp)
1091 {
1092   vl_api_snat_control_ping_reply_t *rmp;
1093   snat_main_t * sm = &snat_main;
1094   int rv = 0;
1095
1096   REPLY_MACRO2(VL_API_SNAT_CONTROL_PING_REPLY,
1097   ({
1098     rmp->vpe_pid = ntohl (getpid());
1099   }));
1100 }
1101
1102 static void *vl_api_snat_control_ping_t_print
1103 (vl_api_snat_control_ping_t *mp, void * handle)
1104 {
1105   u8 *s;
1106
1107   s = format (0, "SCRIPT: snat_control_ping ");
1108
1109   FINISH;
1110 }
1111
1112 static void
1113 vl_api_snat_show_config_t_handler
1114 (vl_api_snat_show_config_t * mp)
1115 {
1116   vl_api_snat_show_config_reply_t *rmp;
1117   snat_main_t * sm = &snat_main;
1118   int rv = 0;
1119
1120   REPLY_MACRO2(VL_API_SNAT_SHOW_CONFIG_REPLY,
1121   ({
1122     rmp->translation_buckets = htonl (sm->translation_buckets);
1123     rmp->translation_memory_size = htonl (sm->translation_memory_size);
1124     rmp->user_buckets = htonl (sm->user_buckets);
1125     rmp->user_memory_size = htonl (sm->user_memory_size);
1126     rmp->max_translations_per_user = htonl (sm->max_translations_per_user);
1127     rmp->outside_vrf_id = htonl (sm->outside_vrf_id);
1128     rmp->inside_vrf_id = htonl (sm->inside_vrf_id);
1129     rmp->static_mapping_only = sm->static_mapping_only;
1130     rmp->static_mapping_connection_tracking =
1131       sm->static_mapping_connection_tracking;
1132     rmp->deterministic = sm->deterministic;
1133   }));
1134 }
1135
1136 static void *vl_api_snat_show_config_t_print
1137 (vl_api_snat_show_config_t *mp, void * handle)
1138 {
1139   u8 *s;
1140
1141   s = format (0, "SCRIPT: snat_show_config ");
1142
1143   FINISH;
1144 }
1145
1146 static void
1147 vl_api_snat_set_workers_t_handler
1148 (vl_api_snat_set_workers_t * mp)
1149 {
1150   snat_main_t * sm = &snat_main;
1151   vl_api_snat_set_workers_reply_t * rmp;
1152   int rv = 0;
1153   uword *bitmap = 0;
1154   u64 mask = clib_net_to_host_u64 (mp->worker_mask);
1155
1156   if (sm->num_workers < 2)
1157     {
1158       rv = VNET_API_ERROR_FEATURE_DISABLED;
1159       goto send_reply;
1160     }
1161
1162   bitmap = clib_bitmap_set_multiple (bitmap, 0, mask, BITS (mask));
1163   rv = snat_set_workers(bitmap);
1164   clib_bitmap_free (bitmap);
1165
1166  send_reply:
1167   REPLY_MACRO (VL_API_SNAT_SET_WORKERS_REPLY);
1168 }
1169
1170 static void *vl_api_snat_set_workers_t_print
1171 (vl_api_snat_set_workers_t *mp, void * handle)
1172 {
1173   u8 * s;
1174   uword *bitmap = 0;
1175   u8 first = 1;
1176   int i;
1177   u64 mask = clib_net_to_host_u64 (mp->worker_mask);
1178
1179   s = format (0, "SCRIPT: snat_set_workers ");
1180   bitmap = clib_bitmap_set_multiple (bitmap, 0, mask, BITS (mask));
1181   clib_bitmap_foreach (i, bitmap,
1182     ({
1183       if (first)
1184         s = format (s, "%d", i);
1185       else
1186         s = format (s, ",%d", i);
1187       first = 0;
1188     }));
1189   clib_bitmap_free (bitmap);
1190   FINISH;
1191 }
1192
1193 static void
1194 send_snat_worker_details
1195 (u32 worker_index, unix_shared_memory_queue_t * q, u32 context)
1196 {
1197   vl_api_snat_worker_details_t *rmp;
1198   snat_main_t * sm = &snat_main;
1199   vlib_worker_thread_t *w =
1200     vlib_worker_threads + worker_index + sm->first_worker_index;
1201
1202   rmp = vl_msg_api_alloc (sizeof (*rmp));
1203   memset (rmp, 0, sizeof (*rmp));
1204   rmp->_vl_msg_id = ntohs (VL_API_SNAT_WORKER_DETAILS+sm->msg_id_base);
1205   rmp->context = context;
1206   rmp->worker_index = htonl (worker_index);
1207   rmp->lcore_id = htonl (w->lcore_id);
1208   strncpy ((char *) rmp->name, (char *) w->name, ARRAY_LEN (rmp->name) - 1);
1209
1210   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1211 }
1212
1213 static void
1214 vl_api_snat_worker_dump_t_handler
1215 (vl_api_snat_worker_dump_t * mp)
1216 {
1217   unix_shared_memory_queue_t *q;
1218   snat_main_t * sm = &snat_main;
1219   u32 * worker_index;
1220
1221   q = vl_api_client_index_to_input_queue (mp->client_index);
1222   if (q == 0)
1223     return;
1224
1225   vec_foreach (worker_index, sm->workers)
1226     {
1227       send_snat_worker_details(*worker_index, q, mp->context);
1228     }
1229 }
1230
1231 static void *vl_api_snat_worker_dump_t_print
1232 (vl_api_snat_worker_dump_t *mp, void * handle)
1233 {
1234   u8 *s;
1235
1236   s = format (0, "SCRIPT: snat_worker_dump ");
1237
1238   FINISH;
1239 }
1240
1241 static int snat_add_interface_address(snat_main_t *sm,
1242                                       u32 sw_if_index,
1243                                       int is_del);
1244
1245 static void
1246 vl_api_snat_add_del_interface_addr_t_handler
1247 (vl_api_snat_add_del_interface_addr_t * mp)
1248 {
1249   snat_main_t * sm = &snat_main;
1250   vl_api_snat_add_del_interface_addr_reply_t * rmp;
1251   u8 is_del = mp->is_add == 0;
1252   u32 sw_if_index = ntohl(mp->sw_if_index);
1253   int rv = 0;
1254
1255   VALIDATE_SW_IF_INDEX(mp);
1256
1257   rv = snat_add_interface_address (sm, sw_if_index, is_del);
1258
1259   BAD_SW_IF_INDEX_LABEL;
1260
1261   REPLY_MACRO(VL_API_SNAT_ADD_DEL_INTERFACE_ADDR_REPLY);
1262 }
1263
1264 static void *vl_api_snat_add_del_interface_addr_t_print
1265 (vl_api_snat_add_del_interface_addr_t * mp, void *handle)
1266 {
1267   u8 * s;
1268
1269   s = format (0, "SCRIPT: snat_add_del_interface_addr ");
1270   s = format (s, "sw_if_index %d %s",
1271               clib_host_to_net_u32(mp->sw_if_index),
1272               mp->is_add ? "" : "del");
1273
1274   FINISH;
1275 }
1276
1277 static void
1278 send_snat_interface_addr_details
1279 (u32 sw_if_index, unix_shared_memory_queue_t * q, u32 context)
1280 {
1281   vl_api_snat_interface_addr_details_t *rmp;
1282   snat_main_t * sm = &snat_main;
1283
1284   rmp = vl_msg_api_alloc (sizeof (*rmp));
1285   memset (rmp, 0, sizeof (*rmp));
1286   rmp->_vl_msg_id = ntohs (VL_API_SNAT_INTERFACE_ADDR_DETAILS+sm->msg_id_base);
1287   rmp->sw_if_index = ntohl (sw_if_index);
1288   rmp->context = context;
1289
1290   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1291 }
1292
1293 static void
1294 vl_api_snat_interface_addr_dump_t_handler
1295 (vl_api_snat_interface_addr_dump_t * mp)
1296 {
1297   unix_shared_memory_queue_t *q;
1298   snat_main_t * sm = &snat_main;
1299   u32 * i;
1300
1301   q = vl_api_client_index_to_input_queue (mp->client_index);
1302   if (q == 0)
1303     return;
1304
1305   vec_foreach (i, sm->auto_add_sw_if_indices)
1306     send_snat_interface_addr_details(*i, q, mp->context);
1307 }
1308
1309 static void *vl_api_snat_interface_addr_dump_t_print
1310 (vl_api_snat_interface_addr_dump_t *mp, void * handle)
1311 {
1312   u8 *s;
1313
1314   s = format (0, "SCRIPT: snat_interface_addr_dump ");
1315
1316   FINISH;
1317 }
1318
1319 static void
1320 vl_api_snat_ipfix_enable_disable_t_handler
1321 (vl_api_snat_ipfix_enable_disable_t * mp)
1322 {
1323   snat_main_t * sm = &snat_main;
1324   vl_api_snat_ipfix_enable_disable_reply_t * rmp;
1325   int rv = 0;
1326
1327   rv = snat_ipfix_logging_enable_disable(mp->enable,
1328                                          clib_host_to_net_u32 (mp->domain_id),
1329                                          clib_host_to_net_u16 (mp->src_port));
1330
1331   REPLY_MACRO (VL_API_SNAT_IPFIX_ENABLE_DISABLE_REPLY);
1332 }
1333
1334 static void *vl_api_snat_ipfix_enable_disable_t_print
1335 (vl_api_snat_ipfix_enable_disable_t *mp, void * handle)
1336 {
1337   u8 * s;
1338
1339   s = format (0, "SCRIPT: snat_ipfix_enable_disable ");
1340   if (mp->domain_id)
1341     s = format (s, "domain %d ", clib_net_to_host_u32 (mp->domain_id));
1342   if (mp->src_port)
1343     s = format (s, "src_port %d ", clib_net_to_host_u16 (mp->src_port));
1344   if (!mp->enable)
1345     s = format (s, "disable ");
1346
1347   FINISH;
1348 }
1349
1350 static void
1351 send_snat_user_details
1352 (snat_user_t * u, unix_shared_memory_queue_t * q, u32 context)
1353 {
1354   vl_api_snat_user_details_t * rmp;
1355   snat_main_t * sm = &snat_main;
1356   ip4_fib_t * fib_table;
1357
1358   rmp = vl_msg_api_alloc (sizeof (*rmp));
1359   memset (rmp, 0, sizeof (*rmp));
1360   rmp->_vl_msg_id = ntohs (VL_API_SNAT_USER_DETAILS+sm->msg_id_base);
1361
1362   fib_table = ip4_fib_get(u->fib_index);
1363   rmp->vrf_id = ntohl (fib_table->table_id);
1364
1365   rmp->is_ip4 = 1;
1366   clib_memcpy(rmp->ip_address, &(u->addr), 4);
1367   rmp->nsessions = ntohl (u->nsessions);
1368   rmp->nstaticsessions = ntohl (u->nstaticsessions);
1369   rmp->context = context;
1370
1371   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1372 }
1373
1374 static void
1375 vl_api_snat_user_dump_t_handler
1376 (vl_api_snat_user_dump_t * mp)
1377 {
1378   unix_shared_memory_queue_t *q;
1379   snat_main_t * sm = &snat_main;
1380   snat_main_per_thread_data_t * tsm;
1381   snat_user_t * u;
1382
1383   q = vl_api_client_index_to_input_queue (mp->client_index);
1384   if (q == 0)
1385     return;
1386
1387   vec_foreach (tsm, sm->per_thread_data)
1388     vec_foreach (u, tsm->users)
1389       send_snat_user_details (u, q, mp->context);
1390 }
1391
1392 static void *vl_api_snat_user_dump_t_print
1393 (vl_api_snat_user_dump_t *mp, void * handle)
1394 {
1395   u8 *s;
1396
1397   s = format (0, "SCRIPT: snat_user_dump ");
1398
1399   FINISH;
1400 }
1401
1402 static void
1403 send_snat_user_session_details
1404 (snat_session_t * s, unix_shared_memory_queue_t * q, u32 context)
1405 {
1406   vl_api_snat_user_session_details_t * rmp;
1407   snat_main_t * sm = &snat_main;
1408
1409   rmp = vl_msg_api_alloc (sizeof(*rmp));
1410   memset (rmp, 0, sizeof (*rmp));
1411   rmp->_vl_msg_id = ntohs (VL_API_SNAT_USER_SESSION_DETAILS+sm->msg_id_base);
1412   rmp->is_ip4 = 1;
1413   clib_memcpy(rmp->outside_ip_address, (&s->out2in.addr), 4);
1414   rmp->outside_port = s->out2in.port;
1415   clib_memcpy(rmp->inside_ip_address, (&s->in2out.addr), 4);
1416   rmp->inside_port = s->in2out.port;
1417   rmp->protocol = ntohs(snat_proto_to_ip_proto(s->in2out.protocol));
1418   rmp->is_static = s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING ? 1 : 0;
1419   rmp->last_heard = clib_host_to_net_u64((u64)s->last_heard);
1420   rmp->total_bytes = clib_host_to_net_u64(s->total_bytes);
1421   rmp->total_pkts = ntohl(s->total_pkts);
1422   rmp->context = context;
1423
1424   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1425 }
1426
1427 static void
1428 vl_api_snat_user_session_dump_t_handler
1429 (vl_api_snat_user_session_dump_t * mp)
1430 {
1431   unix_shared_memory_queue_t *q;
1432   snat_main_t * sm = &snat_main;
1433   snat_main_per_thread_data_t *tsm;
1434   snat_session_t * s;
1435   clib_bihash_kv_8_8_t key, value;
1436   snat_user_key_t ukey;
1437   snat_user_t * u;
1438   u32 session_index, head_index, elt_index;
1439   dlist_elt_t * head, * elt;
1440
1441   q = vl_api_client_index_to_input_queue (mp->client_index);
1442   if (q == 0)
1443     return;
1444   if (!mp->is_ip4)
1445     return;
1446
1447   clib_memcpy (&ukey.addr, mp->ip_address, 4);
1448   ukey.fib_index = ip4_fib_index_from_table_id (ntohl(mp->vrf_id));
1449   key.key = ukey.as_u64;
1450   if (!clib_bihash_search_8_8 (&sm->worker_by_in, &key, &value))
1451     tsm = vec_elt_at_index (sm->per_thread_data, value.value);
1452   else
1453     tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1454   if (clib_bihash_search_8_8 (&sm->user_hash, &key, &value))
1455     return;
1456   u = pool_elt_at_index (tsm->users, value.value);
1457   if (!u->nsessions && !u->nstaticsessions)
1458     return;
1459
1460   head_index = u->sessions_per_user_list_head_index;
1461   head = pool_elt_at_index (tsm->list_pool, head_index);
1462   elt_index = head->next;
1463   elt = pool_elt_at_index (tsm->list_pool, elt_index);
1464   session_index = elt->value;
1465   while (session_index != ~0)
1466     {
1467       s = pool_elt_at_index (tsm->sessions, session_index);
1468
1469       send_snat_user_session_details (s, q, mp->context);
1470
1471       elt_index = elt->next;
1472       elt = pool_elt_at_index (tsm->list_pool, elt_index);
1473       session_index = elt->value;
1474     }
1475 }
1476
1477 static void *vl_api_snat_user_session_dump_t_print
1478 (vl_api_snat_user_session_dump_t *mp, void * handle)
1479 {
1480   u8 *s;
1481
1482   s = format (0, "SCRIPT: snat_user_session_dump ");
1483   s = format (s, "ip_address %U vrf_id %d\n",
1484               format_ip4_address, mp->ip_address,
1485               clib_net_to_host_u32 (mp->vrf_id));
1486
1487   FINISH;
1488 }
1489
1490 static void
1491 vl_api_snat_add_det_map_t_handler
1492 (vl_api_snat_add_det_map_t * mp)
1493 {
1494   snat_main_t * sm = &snat_main;
1495   vl_api_snat_add_det_map_reply_t * rmp;
1496   int rv = 0;
1497   ip4_address_t in_addr, out_addr;
1498
1499   clib_memcpy(&in_addr, mp->in_addr, 4);
1500   clib_memcpy(&out_addr, mp->out_addr, 4);
1501   rv = snat_det_add_map(sm, &in_addr, mp->in_plen, &out_addr,
1502                         mp->out_plen, mp->is_add);
1503
1504   REPLY_MACRO (VL_API_SNAT_ADD_DET_MAP_REPLY);
1505 }
1506
1507 static void *vl_api_snat_add_det_map_t_print
1508 (vl_api_snat_add_det_map_t *mp, void * handle)
1509 {
1510   u8 * s;
1511
1512   s = format (0, "SCRIPT: snat_add_det_map ");
1513   s = format (s, "inside address %U/%d outside address %U/%d\n",
1514               format_ip4_address, mp->in_addr, mp->in_plen,
1515               format_ip4_address, mp->out_addr, mp->out_plen);
1516
1517   FINISH;
1518 }
1519
1520 static void
1521 vl_api_snat_det_forward_t_handler
1522 (vl_api_snat_det_forward_t * mp)
1523 {
1524   snat_main_t * sm = &snat_main;
1525   vl_api_snat_det_forward_reply_t * rmp;
1526   int rv = 0;
1527   u16 lo_port = 0, hi_port = 0;
1528   snat_det_map_t * dm;
1529   ip4_address_t in_addr, out_addr;
1530
1531   out_addr.as_u32 = 0;
1532   clib_memcpy(&in_addr, mp->in_addr, 4);
1533   dm = snat_det_map_by_user(sm, &in_addr);
1534   if (!dm)
1535     {
1536       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1537       goto send_reply;
1538     }
1539
1540   snat_det_forward(dm, &in_addr, &out_addr, &lo_port);
1541   hi_port = lo_port + dm->ports_per_host - 1;
1542
1543 send_reply:
1544   REPLY_MACRO2(VL_API_SNAT_DET_FORWARD_REPLY,
1545   ({
1546     rmp->out_port_lo = ntohs(lo_port);
1547     rmp->out_port_hi = ntohs(hi_port);
1548     rmp->is_ip4 = 1;
1549     memset(rmp->out_addr, 0, 16);
1550     clib_memcpy(rmp->out_addr, &out_addr, 4);
1551   }))
1552 }
1553
1554 static void *vl_api_snat_det_forward_t_print
1555 (vl_api_snat_det_forward_t * mp, void * handle)
1556 {
1557   u8 * s;
1558
1559   s = format (0, "SCRIPT: smat_det_forward_t");
1560   s = format (s, "inside ip address %U\n",
1561               format_ip4_address, mp->in_addr);
1562
1563   FINISH;
1564 }
1565
1566 static void
1567 vl_api_snat_det_reverse_t_handler
1568 (vl_api_snat_det_reverse_t * mp)
1569 {
1570   snat_main_t * sm = &snat_main;
1571   vl_api_snat_det_reverse_reply_t * rmp;
1572   int rv = 0;
1573   ip4_address_t out_addr, in_addr;
1574   snat_det_map_t * dm;
1575
1576   in_addr.as_u32 = 0;
1577   clib_memcpy(&out_addr, mp->out_addr, 4);
1578   dm = snat_det_map_by_out(sm, &out_addr);
1579   if (!dm)
1580     {
1581       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1582       goto send_reply;
1583     }
1584
1585   snat_det_reverse(dm, &out_addr, htons(mp->out_port), &in_addr);
1586
1587  send_reply:
1588   REPLY_MACRO2(VL_API_SNAT_DET_REVERSE_REPLY,
1589   ({
1590     rmp->is_ip4 = 1;
1591     memset(rmp->in_addr, 0, 16);
1592     clib_memcpy(rmp->in_addr, &in_addr, 4);
1593   }))
1594 }
1595
1596 static void *vl_api_snat_det_reverse_t_print
1597 (vl_api_snat_det_reverse_t * mp, void * handle)
1598 {
1599   u8 * s;
1600
1601   s = format(0, "SCRIPT: smat_det_reverse_t");
1602   s = format(s, "outside ip address %U outside port %d",
1603              format_ip4_address, mp->out_addr, ntohs(mp->out_port));
1604
1605   FINISH;
1606 }
1607
1608 static void
1609 sent_snat_det_map_details
1610 (snat_det_map_t * m, unix_shared_memory_queue_t * q, u32 context)
1611 {
1612   vl_api_snat_det_map_details_t *rmp;
1613   snat_main_t * sm = &snat_main;
1614
1615   rmp = vl_msg_api_alloc (sizeof (*rmp));
1616   memset (rmp, 0, sizeof (*rmp));
1617   rmp->_vl_msg_id = ntohs (VL_API_SNAT_DET_MAP_DETAILS+sm->msg_id_base);
1618   rmp->is_ip4 = 1;
1619   clib_memcpy (rmp->in_addr, &m->in_addr, 4);
1620   rmp->in_plen = m->in_plen;
1621   clib_memcpy (rmp->out_addr, &m->out_addr, 4);
1622   rmp->out_plen = m->out_plen;
1623   rmp->sharing_ratio = htonl (m->sharing_ratio);
1624   rmp->ports_per_host = htons (m->ports_per_host);
1625   rmp->ses_num = htonl (m->ses_num);
1626   rmp->context = context;
1627
1628   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1629 }
1630
1631 static void
1632 vl_api_snat_det_map_dump_t_handler
1633 (vl_api_snat_det_map_dump_t * mp)
1634 {
1635   unix_shared_memory_queue_t *q;
1636   snat_main_t * sm = &snat_main;
1637   snat_det_map_t * m;
1638
1639   q = vl_api_client_index_to_input_queue (mp->client_index);
1640   if (q == 0)
1641     return;
1642
1643   vec_foreach(m, sm->det_maps)
1644     sent_snat_det_map_details(m, q, mp->context);
1645 }
1646
1647 static void * vl_api_snat_det_map_dump_t_print
1648 (vl_api_snat_det_map_dump_t *mp, void * handle)
1649 {
1650   u8 * s;
1651
1652   s = format (0, "SCRIPT: snat_det_map_dump ");
1653
1654   FINISH;
1655 }
1656
1657 /* List of message types that this plugin understands */
1658 #define foreach_snat_plugin_api_msg                                     \
1659 _(SNAT_ADD_ADDRESS_RANGE, snat_add_address_range)                       \
1660 _(SNAT_INTERFACE_ADD_DEL_FEATURE, snat_interface_add_del_feature)       \
1661 _(SNAT_ADD_STATIC_MAPPING, snat_add_static_mapping)                     \
1662 _(SNAT_CONTROL_PING, snat_control_ping)                                 \
1663 _(SNAT_STATIC_MAPPING_DUMP, snat_static_mapping_dump)                   \
1664 _(SNAT_SHOW_CONFIG, snat_show_config)                                   \
1665 _(SNAT_ADDRESS_DUMP, snat_address_dump)                                 \
1666 _(SNAT_INTERFACE_DUMP, snat_interface_dump)                             \
1667 _(SNAT_SET_WORKERS, snat_set_workers)                                   \
1668 _(SNAT_WORKER_DUMP, snat_worker_dump)                                   \
1669 _(SNAT_ADD_DEL_INTERFACE_ADDR, snat_add_del_interface_addr)             \
1670 _(SNAT_INTERFACE_ADDR_DUMP, snat_interface_addr_dump)                   \
1671 _(SNAT_IPFIX_ENABLE_DISABLE, snat_ipfix_enable_disable)                 \
1672 _(SNAT_USER_DUMP, snat_user_dump)                                       \
1673 _(SNAT_USER_SESSION_DUMP, snat_user_session_dump)                       \
1674 _(SNAT_ADD_DET_MAP, snat_add_det_map)                                   \
1675 _(SNAT_DET_FORWARD, snat_det_forward)                                   \
1676 _(SNAT_DET_REVERSE, snat_det_reverse)                                   \
1677 _(SNAT_DET_MAP_DUMP, snat_det_map_dump)
1678
1679 /* Set up the API message handling tables */
1680 static clib_error_t *
1681 snat_plugin_api_hookup (vlib_main_t *vm)
1682 {
1683    snat_main_t * sm __attribute__ ((unused)) = &snat_main;
1684 #define _(N,n)                                                  \
1685     vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
1686                            #n,                                  \
1687                            vl_api_##n##_t_handler,              \
1688                            vl_noop_handler,                     \
1689                            vl_api_##n##_t_endian,               \
1690                            vl_api_##n##_t_print,                \
1691                            sizeof(vl_api_##n##_t), 1);
1692     foreach_snat_plugin_api_msg;
1693 #undef _
1694
1695     return 0;
1696 }
1697
1698 #define vl_msg_name_crc_list
1699 #include <snat/snat_all_api_h.h>
1700 #undef vl_msg_name_crc_list
1701
1702 static void
1703 setup_message_id_table (snat_main_t * sm, api_main_t * am)
1704 {
1705 #define _(id,n,crc) \
1706   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
1707   foreach_vl_msg_name_crc_snat;
1708 #undef _
1709 }
1710
1711 static void plugin_custom_dump_configure (snat_main_t * sm)
1712 {
1713 #define _(n,f) sm->api_main->msg_print_handlers \
1714   [VL_API_##n + sm->msg_id_base]                \
1715     = (void *) vl_api_##f##_t_print;
1716   foreach_snat_plugin_api_msg;
1717 #undef _
1718 }
1719
1720
1721 static void
1722 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1723                                        uword opaque,
1724                                        u32 sw_if_index,
1725                                        ip4_address_t * address,
1726                                        u32 address_length,
1727                                        u32 if_address_index,
1728                                        u32 is_delete);
1729
1730 static clib_error_t * snat_init (vlib_main_t * vm)
1731 {
1732   snat_main_t * sm = &snat_main;
1733   clib_error_t * error = 0;
1734   ip4_main_t * im = &ip4_main;
1735   ip_lookup_main_t * lm = &im->lookup_main;
1736   u8 * name;
1737   uword *p;
1738   vlib_thread_registration_t *tr;
1739   vlib_thread_main_t *tm = vlib_get_thread_main ();
1740   uword *bitmap = 0;
1741   u32 i;
1742   ip4_add_del_interface_address_callback_t cb4;
1743
1744   name = format (0, "snat_%08x%c", api_version, 0);
1745
1746   /* Ask for a correctly-sized block of API message decode slots */
1747   sm->msg_id_base = vl_msg_api_get_msg_ids
1748       ((char *) name, VL_MSG_FIRST_AVAILABLE);
1749
1750   sm->vlib_main = vm;
1751   sm->vnet_main = vnet_get_main();
1752   sm->ip4_main = im;
1753   sm->ip4_lookup_main = lm;
1754   sm->api_main = &api_main;
1755   sm->first_worker_index = 0;
1756   sm->next_worker = 0;
1757   sm->num_workers = 0;
1758   sm->workers = 0;
1759   sm->fq_in2out_index = ~0;
1760   sm->fq_out2in_index = ~0;
1761
1762   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1763   if (p)
1764     {
1765       tr = (vlib_thread_registration_t *) p[0];
1766       if (tr)
1767         {
1768           sm->num_workers = tr->count;
1769           sm->first_worker_index = tr->first_index;
1770         }
1771     }
1772
1773   /* Use all available workers by default */
1774   if (sm->num_workers > 1)
1775     {
1776       for (i=0; i < sm->num_workers; i++)
1777         bitmap = clib_bitmap_set (bitmap, i, 1);
1778       snat_set_workers(bitmap);
1779       clib_bitmap_free (bitmap);
1780     }
1781
1782   error = snat_plugin_api_hookup (vm);
1783
1784   /* Add our API messages to the global name_crc hash table */
1785   setup_message_id_table (sm, &api_main);
1786
1787   plugin_custom_dump_configure (sm);
1788   vec_free(name);
1789
1790   /* Set up the interface address add/del callback */
1791   cb4.function = snat_ip4_add_del_interface_address_cb;
1792   cb4.function_opaque = 0;
1793
1794   vec_add1 (im->add_del_interface_address_callbacks, cb4);
1795
1796   /* Init IPFIX logging */
1797   snat_ipfix_logging_init(vm);
1798
1799   return error;
1800 }
1801
1802 VLIB_INIT_FUNCTION (snat_init);
1803
1804 void snat_free_outside_address_and_port (snat_main_t * sm,
1805                                          snat_session_key_t * k,
1806                                          u32 address_index)
1807 {
1808   snat_address_t *a;
1809   u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
1810
1811   ASSERT (address_index < vec_len (sm->addresses));
1812
1813   a = sm->addresses + address_index;
1814
1815   switch (k->protocol)
1816     {
1817 #define _(N, i, n, s) \
1818     case SNAT_PROTOCOL_##N: \
1819       ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
1820         port_host_byte_order) == 1); \
1821       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
1822         port_host_byte_order, 0); \
1823       a->busy_##n##_ports--; \
1824       break;
1825       foreach_snat_protocol
1826 #undef _
1827     default:
1828       clib_warning("unknown_protocol");
1829       return;
1830     }
1831 }
1832
1833 /**
1834  * @brief Match SNAT static mapping.
1835  *
1836  * @param sm          SNAT main.
1837  * @param match       Address and port to match.
1838  * @param mapping     External or local address and port of the matched mapping.
1839  * @param by_external If 0 match by local address otherwise match by external
1840  *                    address.
1841  *
1842  * @returns 0 if match found otherwise 1.
1843  */
1844 int snat_static_mapping_match (snat_main_t * sm,
1845                                snat_session_key_t match,
1846                                snat_session_key_t * mapping,
1847                                u8 by_external)
1848 {
1849   clib_bihash_kv_8_8_t kv, value;
1850   snat_static_mapping_t *m;
1851   snat_session_key_t m_key;
1852   clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
1853
1854   if (by_external)
1855     mapping_hash = &sm->static_mapping_by_external;
1856
1857   m_key.addr = match.addr;
1858   m_key.port = clib_net_to_host_u16 (match.port);
1859   m_key.protocol = match.protocol;
1860   m_key.fib_index = match.fib_index;
1861
1862   kv.key = m_key.as_u64;
1863
1864   if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1865     {
1866       /* Try address only mapping */
1867       m_key.port = 0;
1868       m_key.protocol = 0;
1869       kv.key = m_key.as_u64;
1870       if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1871         return 1;
1872     }
1873
1874   m = pool_elt_at_index (sm->static_mappings, value.value);
1875
1876   if (by_external)
1877     {
1878       mapping->addr = m->local_addr;
1879       /* Address only mapping doesn't change port */
1880       mapping->port = m->addr_only ? match.port
1881         : clib_host_to_net_u16 (m->local_port);
1882       mapping->fib_index = m->fib_index;
1883     }
1884   else
1885     {
1886       mapping->addr = m->external_addr;
1887       /* Address only mapping doesn't change port */
1888       mapping->port = m->addr_only ? match.port
1889         : clib_host_to_net_u16 (m->external_port);
1890       mapping->fib_index = sm->outside_fib_index;
1891     }
1892
1893   return 0;
1894 }
1895
1896 int snat_alloc_outside_address_and_port (snat_main_t * sm,
1897                                          u32 fib_index,
1898                                          snat_session_key_t * k,
1899                                          u32 * address_indexp)
1900 {
1901   int i;
1902   snat_address_t *a;
1903   u32 portnum;
1904
1905   for (i = 0; i < vec_len (sm->addresses); i++)
1906     {
1907       a = sm->addresses + i;
1908       if (sm->vrf_mode && a->fib_index != ~0 && a->fib_index != fib_index)
1909         continue;
1910       switch (k->protocol)
1911         {
1912 #define _(N, j, n, s) \
1913         case SNAT_PROTOCOL_##N: \
1914           if (a->busy_##n##_ports < (65535-1024)) \
1915             { \
1916               while (1) \
1917                 { \
1918                   portnum = random_u32 (&sm->random_seed); \
1919                   portnum &= 0xFFFF; \
1920                   if (portnum < 1024) \
1921                     continue; \
1922                   if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
1923                     continue; \
1924                   clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
1925                   a->busy_##n##_ports++; \
1926                   k->addr = a->addr; \
1927                   k->port = clib_host_to_net_u16(portnum); \
1928                   *address_indexp = i; \
1929                   return 0; \
1930                 } \
1931             } \
1932           break;
1933           foreach_snat_protocol
1934 #undef _
1935         default:
1936           clib_warning("unknown protocol");
1937           return 1;
1938         }
1939
1940     }
1941   /* Totally out of translations to use... */
1942   snat_ipfix_logging_addresses_exhausted(0);
1943   return 1;
1944 }
1945
1946
1947 static clib_error_t *
1948 add_address_command_fn (vlib_main_t * vm,
1949                         unformat_input_t * input,
1950                         vlib_cli_command_t * cmd)
1951 {
1952   unformat_input_t _line_input, *line_input = &_line_input;
1953   snat_main_t * sm = &snat_main;
1954   ip4_address_t start_addr, end_addr, this_addr;
1955   u32 start_host_order, end_host_order;
1956   u32 vrf_id = ~0;
1957   int i, count;
1958   int is_add = 1;
1959   int rv = 0;
1960   clib_error_t *error = 0;
1961
1962   /* Get a line of input. */
1963   if (!unformat_user (input, unformat_line_input, line_input))
1964     return 0;
1965
1966   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1967     {
1968       if (unformat (line_input, "%U - %U",
1969                     unformat_ip4_address, &start_addr,
1970                     unformat_ip4_address, &end_addr))
1971         ;
1972       else if (unformat (line_input, "tenant-vrf %u", &vrf_id))
1973         ;
1974       else if (unformat (line_input, "%U", unformat_ip4_address, &start_addr))
1975         end_addr = start_addr;
1976       else if (unformat (line_input, "del"))
1977         is_add = 0;
1978       else
1979         {
1980           error = clib_error_return (0, "unknown input '%U'",
1981             format_unformat_error, line_input);
1982           goto done;
1983         }
1984      }
1985
1986   if (sm->static_mapping_only)
1987     {
1988       error = clib_error_return (0, "static mapping only mode");
1989       goto done;
1990     }
1991
1992   start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
1993   end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
1994
1995   if (end_host_order < start_host_order)
1996     {
1997       error = clib_error_return (0, "end address less than start address");
1998       goto done;
1999     }
2000
2001   count = (end_host_order - start_host_order) + 1;
2002
2003   if (count > 1024)
2004     clib_warning ("%U - %U, %d addresses...",
2005                   format_ip4_address, &start_addr,
2006                   format_ip4_address, &end_addr,
2007                   count);
2008
2009   this_addr = start_addr;
2010
2011   for (i = 0; i < count; i++)
2012     {
2013       if (is_add)
2014         snat_add_address (sm, &this_addr, vrf_id);
2015       else
2016         rv = snat_del_address (sm, this_addr, 0);
2017
2018       switch (rv)
2019         {
2020         case VNET_API_ERROR_NO_SUCH_ENTRY:
2021           error = clib_error_return (0, "S-NAT address not exist.");
2022           goto done;
2023         case VNET_API_ERROR_UNSPECIFIED:
2024           error = clib_error_return (0, "S-NAT address used in static mapping.");
2025           goto done;
2026         default:
2027           break;
2028         }
2029
2030       increment_v4_address (&this_addr);
2031     }
2032
2033 done:
2034   unformat_free (line_input);
2035
2036   return error;
2037 }
2038
2039 VLIB_CLI_COMMAND (add_address_command, static) = {
2040   .path = "snat add address",
2041   .short_help = "snat add addresses <ip4-range-start> [- <ip4-range-end>] "
2042                 "[tenant-vrf <vrf-id>] [del]",
2043   .function = add_address_command_fn,
2044 };
2045
2046 static clib_error_t *
2047 snat_feature_command_fn (vlib_main_t * vm,
2048                           unformat_input_t * input,
2049                           vlib_cli_command_t * cmd)
2050 {
2051   unformat_input_t _line_input, *line_input = &_line_input;
2052   vnet_main_t * vnm = vnet_get_main();
2053   clib_error_t * error = 0;
2054   u32 sw_if_index;
2055   u32 * inside_sw_if_indices = 0;
2056   u32 * outside_sw_if_indices = 0;
2057   int is_del = 0;
2058   int i;
2059
2060   sw_if_index = ~0;
2061
2062   /* Get a line of input. */
2063   if (!unformat_user (input, unformat_line_input, line_input))
2064     return 0;
2065
2066   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2067     {
2068       if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
2069                     vnm, &sw_if_index))
2070         vec_add1 (inside_sw_if_indices, sw_if_index);
2071       else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
2072                          vnm, &sw_if_index))
2073         vec_add1 (outside_sw_if_indices, sw_if_index);
2074       else if (unformat (line_input, "del"))
2075         is_del = 1;
2076       else
2077         {
2078           error = clib_error_return (0, "unknown input '%U'",
2079             format_unformat_error, line_input);
2080           goto done;
2081         }
2082     }
2083
2084   if (vec_len (inside_sw_if_indices))
2085     {
2086       for (i = 0; i < vec_len(inside_sw_if_indices); i++)
2087         {
2088           sw_if_index = inside_sw_if_indices[i];
2089           snat_interface_add_del (sw_if_index, 1, is_del);
2090         }
2091     }
2092
2093   if (vec_len (outside_sw_if_indices))
2094     {
2095       for (i = 0; i < vec_len(outside_sw_if_indices); i++)
2096         {
2097           sw_if_index = outside_sw_if_indices[i];
2098           snat_interface_add_del (sw_if_index, 0, is_del);
2099         }
2100     }
2101
2102 done:
2103   unformat_free (line_input);
2104   vec_free (inside_sw_if_indices);
2105   vec_free (outside_sw_if_indices);
2106
2107   return error;
2108 }
2109
2110 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
2111   .path = "set interface snat",
2112   .function = snat_feature_command_fn,
2113   .short_help = "set interface snat in <intfc> out <intfc> [del]",
2114 };
2115
2116 uword
2117 unformat_snat_protocol (unformat_input_t * input, va_list * args)
2118 {
2119   u32 *r = va_arg (*args, u32 *);
2120
2121   if (0);
2122 #define _(N, i, n, s) else if (unformat (input, s)) *r = SNAT_PROTOCOL_##N;
2123   foreach_snat_protocol
2124 #undef _
2125   else
2126     return 0;
2127   return 1;
2128 }
2129
2130 u8 *
2131 format_snat_protocol (u8 * s, va_list * args)
2132 {
2133   u32 i = va_arg (*args, u32);
2134   u8 *t = 0;
2135
2136   switch (i)
2137     {
2138 #define _(N, j, n, str) case SNAT_PROTOCOL_##N: t = (u8 *) str; break;
2139       foreach_snat_protocol
2140 #undef _
2141     default:
2142       s = format (s, "unknown");
2143     }
2144   s = format (s, "%s", t);
2145   return s;
2146 }
2147
2148 static clib_error_t *
2149 add_static_mapping_command_fn (vlib_main_t * vm,
2150                                unformat_input_t * input,
2151                                vlib_cli_command_t * cmd)
2152 {
2153   unformat_input_t _line_input, *line_input = &_line_input;
2154   clib_error_t * error = 0;
2155   ip4_address_t l_addr, e_addr;
2156   u32 l_port = 0, e_port = 0, vrf_id = ~0;
2157   int is_add = 1;
2158   int addr_only = 1;
2159   u32 sw_if_index = ~0;
2160   vnet_main_t * vnm = vnet_get_main();
2161   int rv;
2162   snat_protocol_t proto;
2163   u8 proto_set = 0;
2164
2165   /* Get a line of input. */
2166   if (!unformat_user (input, unformat_line_input, line_input))
2167     return 0;
2168
2169   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2170     {
2171       if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
2172                     &l_port))
2173         addr_only = 0;
2174       else if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
2175         ;
2176       else if (unformat (line_input, "external %U %u", unformat_ip4_address,
2177                          &e_addr, &e_port))
2178         addr_only = 0;
2179       else if (unformat (line_input, "external %U", unformat_ip4_address,
2180                          &e_addr))
2181         ;
2182       else if (unformat (line_input, "external %U %u",
2183                          unformat_vnet_sw_interface, vnm, &sw_if_index,
2184                          &e_port))
2185         addr_only = 0;
2186
2187       else if (unformat (line_input, "external %U",
2188                          unformat_vnet_sw_interface, vnm, &sw_if_index))
2189         ;
2190       else if (unformat (line_input, "vrf %u", &vrf_id))
2191         ;
2192       else if (unformat (line_input, "%U", unformat_snat_protocol, &proto))
2193         proto_set = 1;
2194       else if (unformat (line_input, "del"))
2195         is_add = 0;
2196       else
2197         {
2198           error = clib_error_return (0, "unknown input: '%U'",
2199             format_unformat_error, line_input);
2200           goto done;
2201         }
2202     }
2203
2204   if (!addr_only && !proto_set)
2205     {
2206       error = clib_error_return (0, "missing protocol");
2207       goto done;
2208     }
2209
2210   rv = snat_add_static_mapping(l_addr, e_addr, (u16) l_port, (u16) e_port,
2211                                vrf_id, addr_only, sw_if_index, proto, is_add);
2212
2213   switch (rv)
2214     {
2215     case VNET_API_ERROR_INVALID_VALUE:
2216       error = clib_error_return (0, "External port already in use.");
2217       goto done;
2218     case VNET_API_ERROR_NO_SUCH_ENTRY:
2219       if (is_add)
2220         error = clib_error_return (0, "External addres must be allocated.");
2221       else
2222         error = clib_error_return (0, "Mapping not exist.");
2223       goto done;
2224     case VNET_API_ERROR_NO_SUCH_FIB:
2225       error = clib_error_return (0, "No such VRF id.");
2226       goto done;
2227     case VNET_API_ERROR_VALUE_EXIST:
2228       error = clib_error_return (0, "Mapping already exist.");
2229       goto done;
2230     default:
2231       break;
2232     }
2233
2234 done:
2235   unformat_free (line_input);
2236
2237   return error;
2238 }
2239
2240 /*?
2241  * @cliexpar
2242  * @cliexstart{snat add static mapping}
2243  * Static mapping allows hosts on the external network to initiate connection
2244  * to to the local network host.
2245  * To create static mapping between local host address 10.0.0.3 port 6303 and
2246  * external address 4.4.4.4 port 3606 for TCP protocol use:
2247  *  vpp# snat add static mapping local tcp 10.0.0.3 6303 external 4.4.4.4 3606
2248  * If not runnig "static mapping only" S-NAT plugin mode use before:
2249  *  vpp# snat add address 4.4.4.4
2250  * To create static mapping between local and external address use:
2251  *  vpp# snat add static mapping local 10.0.0.3 external 4.4.4.4
2252  * @cliexend
2253 ?*/
2254 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
2255   .path = "snat add static mapping",
2256   .function = add_static_mapping_command_fn,
2257   .short_help =
2258     "snat add static mapping local tcp|udp|icmp <addr> [<port>] external <addr> [<port>] [vrf <table-id>] [del]",
2259 };
2260
2261 static clib_error_t *
2262 set_workers_command_fn (vlib_main_t * vm,
2263                         unformat_input_t * input,
2264                         vlib_cli_command_t * cmd)
2265 {
2266   unformat_input_t _line_input, *line_input = &_line_input;
2267   uword *bitmap = 0;
2268   int rv = 0;
2269   clib_error_t *error = 0;
2270
2271   /* Get a line of input. */
2272   if (!unformat_user (input, unformat_line_input, line_input))
2273     return 0;
2274
2275   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2276     {
2277       if (unformat (line_input, "%U", unformat_bitmap_list, &bitmap))
2278         ;
2279       else
2280         {
2281           error = clib_error_return (0, "unknown input '%U'",
2282             format_unformat_error, line_input);
2283           goto done;
2284         }
2285      }
2286
2287   if (bitmap == 0)
2288     {
2289       error = clib_error_return (0, "List of workers must be specified.");
2290       goto done;
2291     }
2292
2293   rv = snat_set_workers(bitmap);
2294
2295   clib_bitmap_free (bitmap);
2296
2297   switch (rv)
2298     {
2299     case VNET_API_ERROR_INVALID_WORKER:
2300       error = clib_error_return (0, "Invalid worker(s).");
2301       goto done;
2302     case VNET_API_ERROR_FEATURE_DISABLED:
2303       error = clib_error_return (0,
2304         "Supported only if 2 or more workes available.");
2305       goto done;
2306     default:
2307       break;
2308     }
2309
2310 done:
2311   unformat_free (line_input);
2312
2313   return error;
2314 }
2315
2316 /*?
2317  * @cliexpar
2318  * @cliexstart{set snat workers}
2319  * Set SNAT workers if 2 or more workers available, use:
2320  *  vpp# set snat workers 0-2,5
2321  * @cliexend
2322 ?*/
2323 VLIB_CLI_COMMAND (set_workers_command, static) = {
2324   .path = "set snat workers",
2325   .function = set_workers_command_fn,
2326   .short_help =
2327     "set snat workers <workers-list>",
2328 };
2329
2330 static clib_error_t *
2331 snat_ipfix_logging_enable_disable_command_fn (vlib_main_t * vm,
2332                                               unformat_input_t * input,
2333                                               vlib_cli_command_t * cmd)
2334 {
2335   unformat_input_t _line_input, *line_input = &_line_input;
2336   u32 domain_id = 0;
2337   u32 src_port = 0;
2338   u8 enable = 1;
2339   int rv = 0;
2340   clib_error_t *error = 0;
2341
2342   /* Get a line of input. */
2343   if (!unformat_user (input, unformat_line_input, line_input))
2344     return 0;
2345
2346   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2347     {
2348       if (unformat (line_input, "domain %d", &domain_id))
2349         ;
2350       else if (unformat (line_input, "src-port %d", &src_port))
2351         ;
2352       else if (unformat (line_input, "disable"))
2353         enable = 0;
2354       else
2355         {
2356           error = clib_error_return (0, "unknown input '%U'",
2357             format_unformat_error, line_input);
2358           goto done;
2359         }
2360      }
2361
2362   rv = snat_ipfix_logging_enable_disable (enable, domain_id, (u16) src_port);
2363
2364   if (rv)
2365     {
2366       error = clib_error_return (0, "ipfix logging enable failed");
2367       goto done;
2368     }
2369
2370 done:
2371   unformat_free (line_input);
2372
2373   return error;
2374 }
2375
2376 /*?
2377  * @cliexpar
2378  * @cliexstart{snat ipfix logging}
2379  * To enable SNAT IPFIX logging use:
2380  *  vpp# snat ipfix logging
2381  * To set IPFIX exporter use:
2382  *  vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
2383  * @cliexend
2384 ?*/
2385 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
2386   .path = "snat ipfix logging",
2387   .function = snat_ipfix_logging_enable_disable_command_fn,
2388   .short_help = "snat ipfix logging [domain <domain-id>] [src-port <port>] [disable]",
2389 };
2390
2391 static u32
2392 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2393 {
2394   snat_main_t *sm = &snat_main;
2395   snat_user_key_t key0;
2396   clib_bihash_kv_8_8_t kv0, value0;
2397   u32 next_worker_index = 0;
2398
2399   key0.addr = ip0->src_address;
2400   key0.fib_index = rx_fib_index0;
2401
2402   kv0.key = key0.as_u64;
2403
2404   /* Ever heard of of the "user" before? */
2405   if (clib_bihash_search_8_8 (&sm->worker_by_in, &kv0, &value0))
2406     {
2407       /* No, assign next available worker (RR) */
2408       next_worker_index = sm->first_worker_index;
2409       if (vec_len (sm->workers))
2410         {
2411           next_worker_index +=
2412             sm->workers[sm->next_worker++ % _vec_len (sm->workers)];
2413         }
2414
2415       /* add non-traslated packets worker lookup */
2416       kv0.value = next_worker_index;
2417       clib_bihash_add_del_8_8 (&sm->worker_by_in, &kv0, 1);
2418     }
2419   else
2420     next_worker_index = value0.value;
2421
2422   return next_worker_index;
2423 }
2424
2425 static u32
2426 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2427 {
2428   snat_main_t *sm = &snat_main;
2429   snat_worker_key_t key0;
2430   clib_bihash_kv_8_8_t kv0, value0;
2431   udp_header_t * udp0;
2432   u32 next_worker_index = 0;
2433
2434   udp0 = ip4_next_header (ip0);
2435
2436   key0.addr = ip0->dst_address;
2437   key0.port = udp0->dst_port;
2438   key0.fib_index = rx_fib_index0;
2439
2440   if (PREDICT_FALSE(ip0->protocol == IP_PROTOCOL_ICMP))
2441     {
2442       icmp46_header_t * icmp0 = (icmp46_header_t *) udp0;
2443       icmp_echo_header_t *echo0 = (icmp_echo_header_t *)(icmp0+1);
2444       key0.port = echo0->identifier;
2445     }
2446
2447   kv0.key = key0.as_u64;
2448
2449   /* Ever heard of of the "user" before? */
2450   if (clib_bihash_search_8_8 (&sm->worker_by_out, &kv0, &value0))
2451     {
2452       key0.port = 0;
2453       kv0.key = key0.as_u64;
2454
2455       if (clib_bihash_search_8_8 (&sm->worker_by_out, &kv0, &value0))
2456         {
2457           /* No, assign next available worker (RR) */
2458           next_worker_index = sm->first_worker_index;
2459           if (vec_len (sm->workers))
2460             {
2461               next_worker_index +=
2462                 sm->workers[sm->next_worker++ % _vec_len (sm->workers)];
2463             }
2464         }
2465       else
2466         {
2467           /* Static mapping without port */
2468           next_worker_index = value0.value;
2469         }
2470
2471       /* Add to translated packets worker lookup */
2472       kv0.value = next_worker_index;
2473       clib_bihash_add_del_8_8 (&sm->worker_by_out, &kv0, 1);
2474     }
2475   else
2476     next_worker_index = value0.value;
2477
2478   return next_worker_index;
2479 }
2480
2481 static clib_error_t *
2482 snat_config (vlib_main_t * vm, unformat_input_t * input)
2483 {
2484   snat_main_t * sm = &snat_main;
2485   u32 translation_buckets = 1024;
2486   u32 translation_memory_size = 128<<20;
2487   u32 user_buckets = 128;
2488   u32 user_memory_size = 64<<20;
2489   u32 max_translations_per_user = 100;
2490   u32 outside_vrf_id = 0;
2491   u32 inside_vrf_id = 0;
2492   u32 static_mapping_buckets = 1024;
2493   u32 static_mapping_memory_size = 64<<20;
2494   u8 static_mapping_only = 0;
2495   u8 static_mapping_connection_tracking = 0;
2496   vlib_thread_main_t *tm = vlib_get_thread_main ();
2497
2498   sm->deterministic = 0;
2499
2500   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2501     {
2502       if (unformat (input, "translation hash buckets %d", &translation_buckets))
2503         ;
2504       else if (unformat (input, "translation hash memory %d",
2505                          &translation_memory_size));
2506       else if (unformat (input, "user hash buckets %d", &user_buckets))
2507         ;
2508       else if (unformat (input, "user hash memory %d",
2509                          &user_memory_size))
2510         ;
2511       else if (unformat (input, "max translations per user %d",
2512                          &max_translations_per_user))
2513         ;
2514       else if (unformat (input, "outside VRF id %d",
2515                          &outside_vrf_id))
2516         ;
2517       else if (unformat (input, "inside VRF id %d",
2518                          &inside_vrf_id))
2519         ;
2520       else if (unformat (input, "static mapping only"))
2521         {
2522           static_mapping_only = 1;
2523           if (unformat (input, "connection tracking"))
2524             static_mapping_connection_tracking = 1;
2525         }
2526       else if (unformat (input, "deterministic"))
2527         sm->deterministic = 1;
2528       else
2529         return clib_error_return (0, "unknown input '%U'",
2530                                   format_unformat_error, input);
2531     }
2532
2533   /* for show commands, etc. */
2534   sm->translation_buckets = translation_buckets;
2535   sm->translation_memory_size = translation_memory_size;
2536   sm->user_buckets = user_buckets;
2537   sm->user_memory_size = user_memory_size;
2538   sm->max_translations_per_user = max_translations_per_user;
2539   sm->outside_vrf_id = outside_vrf_id;
2540   sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2541                                                              outside_vrf_id);
2542   sm->inside_vrf_id = inside_vrf_id;
2543   sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2544                                                             inside_vrf_id);
2545   sm->static_mapping_only = static_mapping_only;
2546   sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
2547
2548   if (sm->deterministic)
2549     {
2550       sm->in2out_node_index = snat_det_in2out_node.index;
2551       sm->out2in_node_index = snat_det_out2in_node.index;
2552     }
2553   else
2554     {
2555       sm->worker_in2out_cb = snat_get_worker_in2out_cb;
2556       sm->worker_out2in_cb = snat_get_worker_out2in_cb;
2557       sm->in2out_node_index = snat_in2out_node.index;
2558       sm->out2in_node_index = snat_out2in_node.index;
2559       if (!static_mapping_only ||
2560           (static_mapping_only && static_mapping_connection_tracking))
2561         {
2562           sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
2563           sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
2564
2565           clib_bihash_init_8_8 (&sm->worker_by_in, "worker-by-in", user_buckets,
2566                                 user_memory_size);
2567
2568           clib_bihash_init_8_8 (&sm->worker_by_out, "worker-by-out", user_buckets,
2569                                 user_memory_size);
2570
2571           vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2572
2573           clib_bihash_init_8_8 (&sm->in2out, "in2out", translation_buckets,
2574                                 translation_memory_size);
2575
2576           clib_bihash_init_8_8 (&sm->out2in, "out2in", translation_buckets,
2577                                 translation_memory_size);
2578
2579           clib_bihash_init_8_8 (&sm->user_hash, "users", user_buckets,
2580                                 user_memory_size);
2581         }
2582       else
2583         {
2584           sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
2585           sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
2586         }
2587       clib_bihash_init_8_8 (&sm->static_mapping_by_local,
2588                             "static_mapping_by_local", static_mapping_buckets,
2589                             static_mapping_memory_size);
2590
2591       clib_bihash_init_8_8 (&sm->static_mapping_by_external,
2592                             "static_mapping_by_external", static_mapping_buckets,
2593                             static_mapping_memory_size);
2594     }
2595
2596   return 0;
2597 }
2598
2599 VLIB_CONFIG_FUNCTION (snat_config, "snat");
2600
2601 u8 * format_snat_session_state (u8 * s, va_list * args)
2602 {
2603   u32 i = va_arg (*args, u32);
2604   u8 *t = 0;
2605
2606   switch (i)
2607     {
2608 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
2609     foreach_snat_session_state
2610 #undef _
2611     default:
2612       t = format (t, "unknown");
2613     }
2614   s = format (s, "%s", t);
2615   return s;
2616 }
2617
2618 u8 * format_snat_key (u8 * s, va_list * args)
2619 {
2620   snat_session_key_t * key = va_arg (*args, snat_session_key_t *);
2621   char * protocol_string = "unknown";
2622   static char *protocol_strings[] = {
2623       "UDP",
2624       "TCP",
2625       "ICMP",
2626   };
2627
2628   if (key->protocol < ARRAY_LEN(protocol_strings))
2629       protocol_string = protocol_strings[key->protocol];
2630
2631   s = format (s, "%U proto %s port %d fib %d",
2632               format_ip4_address, &key->addr, protocol_string,
2633               clib_net_to_host_u16 (key->port), key->fib_index);
2634   return s;
2635 }
2636
2637 u8 * format_snat_session (u8 * s, va_list * args)
2638 {
2639   snat_main_t * sm __attribute__((unused)) = va_arg (*args, snat_main_t *);
2640   snat_session_t * sess = va_arg (*args, snat_session_t *);
2641
2642   s = format (s, "  i2o %U\n", format_snat_key, &sess->in2out);
2643   s = format (s, "    o2i %U\n", format_snat_key, &sess->out2in);
2644   s = format (s, "       last heard %.2f\n", sess->last_heard);
2645   s = format (s, "       total pkts %d, total bytes %lld\n",
2646               sess->total_pkts, sess->total_bytes);
2647   if (snat_is_session_static (sess))
2648     s = format (s, "       static translation\n");
2649   else
2650     s = format (s, "       dynamic translation\n");
2651
2652   return s;
2653 }
2654
2655 u8 * format_snat_user (u8 * s, va_list * args)
2656 {
2657   snat_main_per_thread_data_t * sm = va_arg (*args, snat_main_per_thread_data_t *);
2658   snat_user_t * u = va_arg (*args, snat_user_t *);
2659   int verbose = va_arg (*args, int);
2660   dlist_elt_t * head, * elt;
2661   u32 elt_index, head_index;
2662   u32 session_index;
2663   snat_session_t * sess;
2664
2665   s = format (s, "%U: %d dynamic translations, %d static translations\n",
2666               format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
2667
2668   if (verbose == 0)
2669     return s;
2670
2671   if (u->nsessions || u->nstaticsessions)
2672     {
2673       head_index = u->sessions_per_user_list_head_index;
2674       head = pool_elt_at_index (sm->list_pool, head_index);
2675
2676       elt_index = head->next;
2677       elt = pool_elt_at_index (sm->list_pool, elt_index);
2678       session_index = elt->value;
2679
2680       while (session_index != ~0)
2681         {
2682           sess = pool_elt_at_index (sm->sessions, session_index);
2683
2684           s = format (s, "  %U\n", format_snat_session, sm, sess);
2685
2686           elt_index = elt->next;
2687           elt = pool_elt_at_index (sm->list_pool, elt_index);
2688           session_index = elt->value;
2689         }
2690     }
2691
2692   return s;
2693 }
2694
2695 u8 * format_snat_static_mapping (u8 * s, va_list * args)
2696 {
2697   snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
2698
2699   if (m->addr_only)
2700       s = format (s, "local %U external %U vrf %d",
2701                   format_ip4_address, &m->local_addr,
2702                   format_ip4_address, &m->external_addr,
2703                   m->vrf_id);
2704   else
2705       s = format (s, "%U local %U:%d external %U:%d vrf %d",
2706                   format_snat_protocol, m->proto,
2707                   format_ip4_address, &m->local_addr, m->local_port,
2708                   format_ip4_address, &m->external_addr, m->external_port,
2709                   m->vrf_id);
2710
2711   return s;
2712 }
2713
2714 u8 * format_snat_static_map_to_resolve (u8 * s, va_list * args)
2715 {
2716   snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
2717   vnet_main_t *vnm = vnet_get_main();
2718
2719   if (m->addr_only)
2720       s = format (s, "local %U external %U vrf %d",
2721                   format_ip4_address, &m->l_addr,
2722                   format_vnet_sw_interface_name, vnm,
2723                   vnet_get_sw_interface (vnm, m->sw_if_index),
2724                   m->vrf_id);
2725   else
2726       s = format (s, "%U local %U:%d external %U:%d vrf %d",
2727                   format_snat_protocol, m->proto,
2728                   format_ip4_address, &m->l_addr, m->l_port,
2729                   format_vnet_sw_interface_name, vnm,
2730                   vnet_get_sw_interface (vnm, m->sw_if_index), m->e_port,
2731                   m->vrf_id);
2732
2733   return s;
2734 }
2735
2736 u8 * format_det_map_ses (u8 * s, va_list * args)
2737 {
2738   snat_det_map_t * det_map = va_arg (*args, snat_det_map_t *);
2739   ip4_address_t in_addr, out_addr;
2740   u32 in_offset, out_offset;
2741   snat_det_session_t * ses = va_arg (*args, snat_det_session_t *);
2742   u32 * i = va_arg (*args, u32 *);
2743
2744   u32 user_index = *i / SNAT_DET_SES_PER_USER;
2745   in_addr.as_u32 = clib_host_to_net_u32 (
2746     clib_net_to_host_u32(det_map->in_addr.as_u32) + user_index);
2747   in_offset = clib_net_to_host_u32(in_addr.as_u32) -
2748     clib_net_to_host_u32(det_map->in_addr.as_u32);
2749   out_offset = in_offset / det_map->sharing_ratio;
2750   out_addr.as_u32 = clib_host_to_net_u32(
2751     clib_net_to_host_u32(det_map->out_addr.as_u32) + out_offset);
2752   s = format (s, "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
2753               format_ip4_address, &in_addr,
2754               clib_net_to_host_u16 (ses->in_port),
2755               format_ip4_address, &out_addr,
2756               clib_net_to_host_u16 (ses->out.out_port),
2757               format_ip4_address, &ses->out.ext_host_addr,
2758               clib_net_to_host_u16 (ses->out.ext_host_port),
2759               format_snat_session_state, ses->state,
2760               ses->expire);
2761
2762   return s;
2763 }
2764
2765 static clib_error_t *
2766 show_snat_command_fn (vlib_main_t * vm,
2767                  unformat_input_t * input,
2768                  vlib_cli_command_t * cmd)
2769 {
2770   int verbose = 0;
2771   snat_main_t * sm = &snat_main;
2772   snat_user_t * u;
2773   snat_static_mapping_t *m;
2774   snat_interface_t *i;
2775   snat_address_t * ap;
2776   vnet_main_t *vnm = vnet_get_main();
2777   snat_main_per_thread_data_t *tsm;
2778   u32 users_num = 0, sessions_num = 0, *worker, *sw_if_index;
2779   uword j = 0;
2780   snat_static_map_resolve_t *rp;
2781   snat_det_map_t * dm;
2782   snat_det_session_t * ses;
2783
2784   if (unformat (input, "detail"))
2785     verbose = 1;
2786   else if (unformat (input, "verbose"))
2787     verbose = 2;
2788
2789   if (sm->static_mapping_only)
2790     {
2791       if (sm->static_mapping_connection_tracking)
2792         vlib_cli_output (vm, "SNAT mode: static mapping only connection "
2793                          "tracking");
2794       else
2795         vlib_cli_output (vm, "SNAT mode: static mapping only");
2796     }
2797   else if (sm->deterministic)
2798     {
2799       vlib_cli_output (vm, "SNAT mode: deterministic mapping");
2800     }
2801   else
2802     {
2803       vlib_cli_output (vm, "SNAT mode: dynamic translations enabled");
2804     }
2805
2806   if (verbose > 0)
2807     {
2808       pool_foreach (i, sm->interfaces,
2809       ({
2810         vlib_cli_output (vm, "%U %s", format_vnet_sw_interface_name, vnm,
2811                          vnet_get_sw_interface (vnm, i->sw_if_index),
2812                          i->is_inside ? "in" : "out");
2813       }));
2814
2815       if (vec_len (sm->auto_add_sw_if_indices))
2816         {
2817           vlib_cli_output (vm, "SNAT pool addresses interfaces:");
2818           vec_foreach (sw_if_index, sm->auto_add_sw_if_indices)
2819             {
2820               vlib_cli_output (vm, "%U", format_vnet_sw_interface_name, vnm,
2821                                vnet_get_sw_interface (vnm, *sw_if_index));
2822             }
2823         }
2824
2825       vec_foreach (ap, sm->addresses)
2826         {
2827           vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
2828           if (ap->fib_index != ~0)
2829               vlib_cli_output (vm, "  tenant VRF: %u",
2830                                ip4_fib_get(ap->fib_index)->table_id);
2831           else
2832             vlib_cli_output (vm, "  tenant VRF independent");
2833 #define _(N, i, n, s) \
2834           vlib_cli_output (vm, "  %d busy %s ports", ap->busy_##n##_ports, s);
2835           foreach_snat_protocol
2836 #undef _
2837         }
2838     }
2839
2840   if (sm->num_workers > 1)
2841     {
2842       vlib_cli_output (vm, "%d workers", vec_len (sm->workers));
2843       if (verbose > 0)
2844         {
2845           vec_foreach (worker, sm->workers)
2846             {
2847               vlib_worker_thread_t *w =
2848                 vlib_worker_threads + *worker + sm->first_worker_index;
2849               vlib_cli_output (vm, "  %s", w->name);
2850             }
2851         }
2852     }
2853
2854   if (sm->deterministic)
2855     {
2856       vlib_cli_output (vm, "%d deterministic mappings",
2857                        pool_elts (sm->det_maps));
2858       if (verbose > 0)
2859         {
2860           pool_foreach (dm, sm->det_maps,
2861           ({
2862             vlib_cli_output (vm, "in %U/%d out %U/%d\n",
2863                              format_ip4_address, &dm->in_addr, dm->in_plen,
2864                              format_ip4_address, &dm->out_addr, dm->out_plen);
2865             vlib_cli_output (vm, " outside address sharing ratio: %d\n",
2866                              dm->sharing_ratio);
2867             vlib_cli_output (vm, " number of ports per inside host: %d\n",
2868                              dm->ports_per_host);
2869             vlib_cli_output (vm, " sessions number: %d\n", dm->ses_num);
2870             if (verbose > 1)
2871               {
2872                 vec_foreach_index (j, dm->sessions)
2873                   {
2874                     ses = vec_elt_at_index (dm->sessions, j);
2875                     if (ses->in_port)
2876                       vlib_cli_output (vm, "  %U", format_det_map_ses, dm, ses,
2877                                        &j);
2878                   }
2879               }
2880           }));
2881         }
2882     }
2883   else
2884     {
2885       if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
2886         {
2887           vlib_cli_output (vm, "%d static mappings",
2888                            pool_elts (sm->static_mappings));
2889
2890           if (verbose > 0)
2891             {
2892               pool_foreach (m, sm->static_mappings,
2893               ({
2894                 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
2895               }));
2896             }
2897         }
2898       else
2899         {
2900           vec_foreach (tsm, sm->per_thread_data)
2901             {
2902               users_num += pool_elts (tsm->users);
2903               sessions_num += pool_elts (tsm->sessions);
2904             }
2905
2906           vlib_cli_output (vm, "%d users, %d outside addresses, %d active sessions,"
2907                            " %d static mappings",
2908                            users_num,
2909                            vec_len (sm->addresses),
2910                            sessions_num,
2911                            pool_elts (sm->static_mappings));
2912
2913           if (verbose > 0)
2914             {
2915               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->in2out,
2916                                verbose - 1);
2917               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->out2in,
2918                                verbose - 1);
2919               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->worker_by_in,
2920                                verbose - 1);
2921               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->worker_by_out,
2922                                verbose - 1);
2923               vec_foreach_index (j, sm->per_thread_data)
2924                 {
2925                   tsm = vec_elt_at_index (sm->per_thread_data, j);
2926
2927                   if (pool_elts (tsm->users) == 0)
2928                     continue;
2929
2930                   vlib_worker_thread_t *w = vlib_worker_threads + j;
2931                   vlib_cli_output (vm, "Thread %d (%s at lcore %u):", j, w->name,
2932                                    w->lcore_id);
2933                   vlib_cli_output (vm, "  %d list pool elements",
2934                                    pool_elts (tsm->list_pool));
2935
2936                   pool_foreach (u, tsm->users,
2937                   ({
2938                     vlib_cli_output (vm, "  %U", format_snat_user, tsm, u,
2939                                      verbose - 1);
2940                   }));
2941                 }
2942
2943               if (pool_elts (sm->static_mappings))
2944                 {
2945                   vlib_cli_output (vm, "static mappings:");
2946                   pool_foreach (m, sm->static_mappings,
2947                   ({
2948                     vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
2949                   }));
2950                   for (j = 0; j < vec_len (sm->to_resolve); j++)
2951                     {
2952                       rp = sm->to_resolve + j;
2953                       vlib_cli_output (vm, "%U",
2954                                        format_snat_static_map_to_resolve, rp);
2955                     }
2956                 }
2957             }
2958         }
2959     }
2960   return 0;
2961 }
2962
2963 VLIB_CLI_COMMAND (show_snat_command, static) = {
2964     .path = "show snat",
2965     .short_help = "show snat",
2966     .function = show_snat_command_fn,
2967 };
2968
2969
2970 static void
2971 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2972                                        uword opaque,
2973                                        u32 sw_if_index,
2974                                        ip4_address_t * address,
2975                                        u32 address_length,
2976                                        u32 if_address_index,
2977                                        u32 is_delete)
2978 {
2979   snat_main_t *sm = &snat_main;
2980   snat_static_map_resolve_t *rp;
2981   u32 *indices_to_delete = 0;
2982   int i, j;
2983   int rv;
2984
2985   for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
2986     {
2987       if (sw_if_index == sm->auto_add_sw_if_indices[i])
2988         {
2989           if (!is_delete)
2990             {
2991               /* Don't trip over lease renewal, static config */
2992               for (j = 0; j < vec_len(sm->addresses); j++)
2993                 if (sm->addresses[j].addr.as_u32 == address->as_u32)
2994                   return;
2995
2996               snat_add_address (sm, address, ~0);
2997               /* Scan static map resolution vector */
2998               for (j = 0; j < vec_len (sm->to_resolve); j++)
2999                 {
3000                   rp = sm->to_resolve + j;
3001                   /* On this interface? */
3002                   if (rp->sw_if_index == sw_if_index)
3003                     {
3004                       /* Add the static mapping */
3005                       rv = snat_add_static_mapping (rp->l_addr,
3006                                                     address[0],
3007                                                     rp->l_port,
3008                                                     rp->e_port,
3009                                                     rp->vrf_id,
3010                                                     rp->addr_only,
3011                                                     ~0 /* sw_if_index */,
3012                                                     rp->proto,
3013                                                     rp->is_add);
3014                       if (rv)
3015                         clib_warning ("snat_add_static_mapping returned %d",
3016                                       rv);
3017                       vec_add1 (indices_to_delete, j);
3018                     }
3019                 }
3020               /* If we resolved any of the outstanding static mappings */
3021               if (vec_len(indices_to_delete))
3022                 {
3023                   /* Delete them */
3024                   for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3025                     vec_delete(sm->to_resolve, 1, j);
3026                   vec_free(indices_to_delete);
3027                 }
3028               return;
3029             }
3030           else
3031             {
3032               (void) snat_del_address(sm, address[0], 1);
3033               return;
3034             }
3035         }
3036     }
3037 }
3038
3039
3040 static int snat_add_interface_address (snat_main_t *sm,
3041                                        u32 sw_if_index,
3042                                        int is_del)
3043 {
3044   ip4_main_t * ip4_main = sm->ip4_main;
3045   ip4_address_t * first_int_addr;
3046   snat_static_map_resolve_t *rp;
3047   u32 *indices_to_delete = 0;
3048   int i, j;
3049
3050   first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index,
3051                                                 0 /* just want the address*/);
3052
3053   for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
3054     {
3055       if (sm->auto_add_sw_if_indices[i] == sw_if_index)
3056         {
3057           if (is_del)
3058             {
3059               /* if have address remove it */
3060               if (first_int_addr)
3061                   (void) snat_del_address (sm, first_int_addr[0], 1);
3062               else
3063                 {
3064                   for (j = 0; j < vec_len (sm->to_resolve); j++)
3065                     {
3066                       rp = sm->to_resolve + j;
3067                       if (rp->sw_if_index == sw_if_index)
3068                         vec_add1 (indices_to_delete, j);
3069                     }
3070                   if (vec_len(indices_to_delete))
3071                     {
3072                       for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3073                         vec_del1(sm->to_resolve, j);
3074                       vec_free(indices_to_delete);
3075                     }
3076                 }
3077               vec_del1(sm->auto_add_sw_if_indices, i);
3078             }
3079           else
3080             return VNET_API_ERROR_VALUE_EXIST;
3081
3082           return 0;
3083         }
3084     }
3085
3086   if (is_del)
3087     return VNET_API_ERROR_NO_SUCH_ENTRY;
3088
3089   /* add to the auto-address list */
3090   vec_add1(sm->auto_add_sw_if_indices, sw_if_index);
3091
3092   /* If the address is already bound - or static - add it now */
3093   if (first_int_addr)
3094       snat_add_address (sm, first_int_addr, ~0);
3095
3096   return 0;
3097 }
3098
3099 static clib_error_t *
3100 snat_add_interface_address_command_fn (vlib_main_t * vm,
3101                                        unformat_input_t * input,
3102                                        vlib_cli_command_t * cmd)
3103 {
3104   snat_main_t *sm = &snat_main;
3105   unformat_input_t _line_input, *line_input = &_line_input;
3106   u32 sw_if_index;
3107   int rv;
3108   int is_del = 0;
3109   clib_error_t *error = 0;
3110
3111   /* Get a line of input. */
3112   if (!unformat_user (input, unformat_line_input, line_input))
3113     return 0;
3114
3115   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3116     {
3117       if (unformat (line_input, "%U", unformat_vnet_sw_interface,
3118                     sm->vnet_main, &sw_if_index))
3119         ;
3120       else if (unformat (line_input, "del"))
3121         is_del = 1;
3122       else
3123         {
3124           error = clib_error_return (0, "unknown input '%U'",
3125                                      format_unformat_error, line_input);
3126           goto done;
3127         }
3128     }
3129
3130   rv = snat_add_interface_address (sm, sw_if_index, is_del);
3131
3132   switch (rv)
3133     {
3134     case 0:
3135       break;
3136
3137     default:
3138       error = clib_error_return (0, "snat_add_interface_address returned %d",
3139                                  rv);
3140       goto done;
3141     }
3142
3143 done:
3144   unformat_free (line_input);
3145
3146   return error;
3147 }
3148
3149 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
3150     .path = "snat add interface address",
3151     .short_help = "snat add interface address <interface> [del]",
3152     .function = snat_add_interface_address_command_fn,
3153 };
3154
3155 static clib_error_t *
3156 snat_det_map_command_fn (vlib_main_t * vm,
3157                          unformat_input_t * input,
3158                          vlib_cli_command_t * cmd)
3159 {
3160   snat_main_t *sm = &snat_main;
3161   unformat_input_t _line_input, *line_input = &_line_input;
3162   ip4_address_t in_addr, out_addr;
3163   u32 in_plen, out_plen;
3164   int is_add = 1, rv;
3165   clib_error_t *error = 0;
3166
3167   /* Get a line of input. */
3168   if (!unformat_user (input, unformat_line_input, line_input))
3169     return 0;
3170
3171   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3172     {
3173       if (unformat (line_input, "in %U/%u", unformat_ip4_address, &in_addr, &in_plen))
3174         ;
3175       else if (unformat (line_input, "out %U/%u", unformat_ip4_address, &out_addr, &out_plen))
3176         ;
3177       else if (unformat (line_input, "del"))
3178         is_add = 0;
3179       else
3180         {
3181           error = clib_error_return (0, "unknown input '%U'",
3182                                      format_unformat_error, line_input);
3183           goto done;
3184         }
3185     }
3186
3187   unformat_free (line_input);
3188
3189   rv = snat_det_add_map(sm, &in_addr, (u8) in_plen, &out_addr, (u8)out_plen,
3190                         is_add);
3191
3192   if (rv)
3193     {
3194       error = clib_error_return (0, "snat_det_add_map return %d", rv);
3195       goto done;
3196     }
3197
3198 done:
3199   unformat_free (line_input);
3200
3201   return error;
3202 }
3203
3204 /*?
3205  * @cliexpar
3206  * @cliexstart{snat deterministic add}
3207  * Create bijective mapping of inside address to outside address and port range
3208  * pairs, with the purpose of enabling deterministic NAT to reduce logging in
3209  * CGN deployments.
3210  * To create deterministic mapping between inside network 10.0.0.0/18 and
3211  * outside network 1.1.1.0/30 use:
3212  * # vpp# snat deterministic add in 10.0.0.0/18 out 1.1.1.0/30
3213  * @cliexend
3214 ?*/
3215 VLIB_CLI_COMMAND (snat_det_map_command, static) = {
3216     .path = "snat deterministic add",
3217     .short_help = "snat deterministic add in <addr>/<plen> out <addr>/<plen> [del]",
3218     .function = snat_det_map_command_fn,
3219 };
3220
3221 static clib_error_t *
3222 snat_det_forward_command_fn (vlib_main_t * vm,
3223                              unformat_input_t * input,
3224                              vlib_cli_command_t * cmd)
3225 {
3226   snat_main_t *sm = &snat_main;
3227   unformat_input_t _line_input, *line_input = &_line_input;
3228   ip4_address_t in_addr, out_addr;
3229   u16 lo_port;
3230   snat_det_map_t * dm;
3231   clib_error_t *error = 0;
3232
3233   /* Get a line of input. */
3234   if (!unformat_user (input, unformat_line_input, line_input))
3235     return 0;
3236
3237   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3238     {
3239       if (unformat (line_input, "%U", unformat_ip4_address, &in_addr))
3240         ;
3241       else
3242         {
3243           error = clib_error_return (0, "unknown input '%U'",
3244                                      format_unformat_error, line_input);
3245           goto done;
3246         }
3247     }
3248
3249   unformat_free (line_input);
3250
3251   dm = snat_det_map_by_user(sm, &in_addr);
3252   if (!dm)
3253     vlib_cli_output (vm, "no match");
3254   else
3255     {
3256       snat_det_forward (dm, &in_addr, &out_addr, &lo_port);
3257       vlib_cli_output (vm, "%U:<%d-%d>", format_ip4_address, &out_addr,
3258                        lo_port, lo_port + dm->ports_per_host - 1);
3259     }
3260
3261 done:
3262   unformat_free (line_input);
3263
3264   return error;
3265 }
3266
3267 /*?
3268  * @cliexpar
3269  * @cliexstart{snat deterministic forward}
3270  * Return outside address and port range from inside address for deterministic
3271  * NAT.
3272  * To obtain outside address and port of inside host use:
3273  *  vpp# snat deterministic forward 10.0.0.2
3274  *  1.1.1.0:<1054-1068>
3275  * @cliexend
3276 ?*/
3277 VLIB_CLI_COMMAND (snat_det_forward_command, static) = {
3278     .path = "snat deterministic forward",
3279     .short_help = "snat deterministic forward <addr>",
3280     .function = snat_det_forward_command_fn,
3281 };
3282
3283 static clib_error_t *
3284 snat_det_reverse_command_fn (vlib_main_t * vm,
3285                              unformat_input_t * input,
3286                              vlib_cli_command_t * cmd)
3287 {
3288   snat_main_t *sm = &snat_main;
3289   unformat_input_t _line_input, *line_input = &_line_input;
3290   ip4_address_t in_addr, out_addr;
3291   u32 out_port;
3292   snat_det_map_t * dm;
3293   clib_error_t *error = 0;
3294
3295   /* Get a line of input. */
3296   if (!unformat_user (input, unformat_line_input, line_input))
3297     return 0;
3298
3299   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3300     {
3301       if (unformat (line_input, "%U:%d", unformat_ip4_address, &out_addr, &out_port))
3302         ;
3303       else
3304         {
3305           error =  clib_error_return (0, "unknown input '%U'",
3306                                       format_unformat_error, line_input);
3307         }
3308     }
3309
3310   unformat_free (line_input);
3311
3312   if (out_port < 1024 || out_port > 65535)
3313     {
3314       error = clib_error_return (0, "wrong port, must be <1024-65535>");
3315       goto done;
3316     }
3317
3318   dm = snat_det_map_by_out(sm, &out_addr);
3319   if (!dm)
3320     vlib_cli_output (vm, "no match");
3321   else
3322     {
3323       snat_det_reverse (dm, &out_addr, (u16) out_port, &in_addr);
3324       vlib_cli_output (vm, "%U", format_ip4_address, &in_addr);
3325     }
3326
3327 done:
3328   unformat_free (line_input);
3329
3330   return error;
3331 }
3332
3333 /*?
3334  * @cliexpar
3335  * @cliexstart{snat deterministic reverse}
3336  * Return inside address from outside address and port for deterministic NAT.
3337  * To obtain inside host address from outside address and port use:
3338  *  #vpp snat deterministic reverse 1.1.1.1:1276
3339  *  10.0.16.16
3340  * @cliexend
3341 ?*/
3342 VLIB_CLI_COMMAND (snat_det_reverse_command, static) = {
3343     .path = "snat deterministic reverse",
3344     .short_help = "snat deterministic reverse <addr>:<port>",
3345     .function = snat_det_reverse_command_fn,
3346 };