src/plugins/nat/nat_format.c

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /**
  16  * @file
  17  * @brief NAT formatting
  18  */
  19
  20 #include <nat/nat.h>
  21 #include <nat/nat_inlines.h>
  22
  23 uword
  24 unformat_nat_protocol (unformat_input_t * input, va_list * args)
  25 {
  26   u32 *r = va_arg (*args, u32 *);
  27
  28   if (0);
  29 #define _(N, i, n, s) else if (unformat (input, s)) *r = NAT_PROTOCOL_##N;
  30   foreach_nat_protocol
  31 #undef _
  32     else
  33     return 0;
  34   return 1;
  35 }
  36
  37 u8 *
  38 format_nat_protocol (u8 * s, va_list * args)
  39 {
  40   u32 i = va_arg (*args, u32);
  41   u8 *t = 0;
  42
  43   switch (i)
  44     {
  45 #define _(N, j, n, str) case NAT_PROTOCOL_##N: t = (u8 *) str; break;
  46       foreach_nat_protocol
  47 #undef _
  48     default:
  49       s = format (s, "unknown");
  50       return s;
  51     }
  52   s = format (s, "%s", t);
  53   return s;
  54 }
  55
  56 u8 *
  57 format_nat_addr_and_port_alloc_alg (u8 * s, va_list * args)
  58 {
  59   u32 i = va_arg (*args, u32);
  60   u8 *t = 0;
  61
  62   switch (i)
  63     {
  64 #define _(v, N, s) case NAT_ADDR_AND_PORT_ALLOC_ALG_##N: t = (u8 *) s; break;
  65       foreach_nat_addr_and_port_alloc_alg
  66 #undef _
  67     default:
  68       s = format (s, "unknown");
  69       return s;
  70     }
  71   s = format (s, "%s", t);
  72   return s;
  73 }
  74
  75 u8 *
  76 format_snat_key (u8 * s, va_list * args)
  77 {
  78   u64 key = va_arg (*args, u64);
  79
  80   ip4_address_t addr;
  81   u16 port;
  82   nat_protocol_t protocol;
  83   u32 fib_index;
  84
  85   split_nat_key (key, &addr, &port, &fib_index, &protocol);
  86
  87   s = format (s, "%U proto %U port %d fib %d",
  88               format_ip4_address, &addr,
  89               format_nat_protocol, protocol,
  90               clib_net_to_host_u16 (port), fib_index);
  91   return s;
  92 }
  93
  94 u8 *
  95 format_snat_session_state (u8 * s, va_list * args)
  96 {
  97   u32 i = va_arg (*args, u32);
  98   u8 *t = 0;
  99
 100   switch (i)
 101     {
 102 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
 103       foreach_snat_session_state
 104 #undef _
 105     default:
 106       t = format (t, "unknown");
 107     }
 108   s = format (s, "%s", t);
 109   return s;
 110 }
 111
 112 u8 *
 113 format_snat_session (u8 * s, va_list * args)
 114 {
 115   snat_main_per_thread_data_t *tsm =
 116     va_arg (*args, snat_main_per_thread_data_t *);
 117   snat_session_t *sess = va_arg (*args, snat_session_t *);
 118
 119   if (snat_is_unk_proto_session (sess))
 120     {
 121       s = format (s, "  i2o %U proto %u fib %u\n",
 122                   format_ip4_address, &sess->in2out.addr,
 123                   sess->in2out.port, sess->in2out.fib_index);
 124       s =
 125         format (s, "    o2i %U proto %u fib %u\n", format_ip4_address,
 126                 &sess->out2in.addr, sess->out2in.port, sess->out2in.fib_index);
 127     }
 128   else
 129     {
 130       s = format (s, "  i2o %U proto %U port %d fib %d\n",
 131                   format_ip4_address, &sess->in2out.addr,
 132                   format_nat_protocol, sess->nat_proto,
 133                   clib_net_to_host_u16 (sess->in2out.port),
 134                   sess->in2out.fib_index);
 135       s = format (s, "    o2i %U proto %U port %d fib %d\n",
 136                   format_ip4_address, &sess->out2in.addr, format_nat_protocol,
 137                   sess->nat_proto, clib_net_to_host_u16 (sess->out2in.port),
 138                   sess->out2in.fib_index);
 139     }
 140   if (is_ed_session (sess) || is_fwd_bypass_session (sess))
 141     {
 142       if (is_twice_nat_session (sess))
 143         {
 144           s = format (s, "       external host o2i %U:%d i2o %U:%d\n",
 145                       format_ip4_address, &sess->ext_host_addr,
 146                       clib_net_to_host_u16 (sess->ext_host_port),
 147                       format_ip4_address, &sess->ext_host_nat_addr,
 148                       clib_net_to_host_u16 (sess->ext_host_nat_port));
 149         }
 150       else
 151         {
 152           if (sess->ext_host_addr.as_u32)
 153             s = format (s, "       external host %U:%u\n",
 154                         format_ip4_address, &sess->ext_host_addr,
 155                         clib_net_to_host_u16 (sess->ext_host_port));
 156         }
 157       s = format (s, "       i2o flow: %U\n", format_nat_6t_flow, &sess->i2o);
 158       s = format (s, "       o2i flow: %U\n", format_nat_6t_flow, &sess->o2i);
 159     }
 160   s = format (s, "       index %llu\n", sess - tsm->sessions);
 161   s = format (s, "       last heard %.2f\n", sess->last_heard);
 162   s = format (s, "       total pkts %d, total bytes %lld\n",
 163               sess->total_pkts, sess->total_bytes);
 164   if (snat_is_session_static (sess))
 165     s = format (s, "       static translation\n");
 166   else
 167     s = format (s, "       dynamic translation\n");
 168   if (is_fwd_bypass_session (sess))
 169     s = format (s, "       forwarding-bypass\n");
 170   if (is_lb_session (sess))
 171     s = format (s, "       load-balancing\n");
 172   if (is_twice_nat_session (sess))
 173     s = format (s, "       twice-nat\n");
 174
 175   return s;
 176 }
 177
 178 u8 *
 179 format_snat_user (u8 * s, va_list * args)
 180 {
 181   snat_main_per_thread_data_t *tsm =
 182     va_arg (*args, snat_main_per_thread_data_t *);
 183   snat_user_t *u = va_arg (*args, snat_user_t *);
 184   int verbose = va_arg (*args, int);
 185   dlist_elt_t *head, *elt;
 186   u32 elt_index, head_index;
 187   u32 session_index;
 188   snat_session_t *sess;
 189
 190   s = format (s, "%U: %d dynamic translations, %d static translations\n",
 191               format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
 192
 193   if (verbose == 0)
 194     return s;
 195
 196   if (u->nsessions || u->nstaticsessions)
 197     {
 198       head_index = u->sessions_per_user_list_head_index;
 199       head = pool_elt_at_index (tsm->list_pool, head_index);
 200
 201       elt_index = head->next;
 202       elt = pool_elt_at_index (tsm->list_pool, elt_index);
 203       session_index = elt->value;
 204
 205       while (session_index != ~0)
 206         {
 207           sess = pool_elt_at_index (tsm->sessions, session_index);
 208
 209           s = format (s, "  %U\n", format_snat_session, tsm, sess);
 210
 211           elt_index = elt->next;
 212           elt = pool_elt_at_index (tsm->list_pool, elt_index);
 213           session_index = elt->value;
 214         }
 215     }
 216
 217   return s;
 218 }
 219
 220 u8 *
 221 format_snat_static_mapping (u8 * s, va_list * args)
 222 {
 223   snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
 224   nat44_lb_addr_port_t *local;
 225
 226   if (is_identity_static_mapping (m))
 227     {
 228       if (is_addr_only_static_mapping (m))
 229         s = format (s, "identity mapping %U",
 230                     format_ip4_address, &m->local_addr);
 231       else
 232         s = format (s, "identity mapping %U %U:%d",
 233                     format_nat_protocol, m->proto,
 234                     format_ip4_address, &m->local_addr,
 235                     clib_net_to_host_u16 (m->local_port));
 236
 237       /* *INDENT-OFF* */
 238       pool_foreach (local, m->locals)
 239        {
 240         s = format (s, " vrf %d", local->vrf_id);
 241       }
 242       /* *INDENT-ON* */
 243
 244       return s;
 245     }
 246
 247   if (is_addr_only_static_mapping (m))
 248     s = format (s, "local %U external %U vrf %d %s %s",
 249                 format_ip4_address, &m->local_addr,
 250                 format_ip4_address, &m->external_addr,
 251                 m->vrf_id,
 252                 m->twice_nat == TWICE_NAT ? "twice-nat" :
 253                 m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
 254                 is_out2in_only_static_mapping (m) ? "out2in-only" : "");
 255   else
 256     {
 257       if (is_lb_static_mapping (m))
 258         {
 259           s = format (s, "%U external %U:%d %s %s",
 260                       format_nat_protocol, m->proto,
 261                       format_ip4_address, &m->external_addr,
 262                       clib_net_to_host_u16 (m->external_port),
 263                       m->twice_nat == TWICE_NAT ? "twice-nat" :
 264                       m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
 265                       is_out2in_only_static_mapping (m) ? "out2in-only" : "");
 266
 267           /* *INDENT-OFF* */
 268           pool_foreach (local, m->locals)
 269            {
 270             s = format (s, "\n  local %U:%d vrf %d probability %d\%",
 271                         format_ip4_address, &local->addr,
 272                         clib_net_to_host_u16 (local->port),
 273                         local->vrf_id, local->probability);
 274           }
 275           /* *INDENT-ON* */
 276
 277         }
 278       else
 279         s = format (s, "%U local %U:%d external %U:%d vrf %d %s %s",
 280                     format_nat_protocol, m->proto,
 281                     format_ip4_address, &m->local_addr,
 282                     clib_net_to_host_u16 (m->local_port),
 283                     format_ip4_address, &m->external_addr,
 284                     clib_net_to_host_u16 (m->external_port),
 285                     m->vrf_id,
 286                     m->twice_nat == TWICE_NAT ? "twice-nat" :
 287                     m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
 288                     is_out2in_only_static_mapping (m) ? "out2in-only" : "");
 289     }
 290   return s;
 291 }
 292
 293 u8 *
 294 format_snat_static_map_to_resolve (u8 * s, va_list * args)
 295 {
 296   snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
 297   vnet_main_t *vnm = vnet_get_main ();
 298
 299   if (m->addr_only)
 300     s = format (s, "local %U external %U vrf %d",
 301                 format_ip4_address, &m->l_addr,
 302                 format_vnet_sw_if_index_name, vnm, m->sw_if_index, m->vrf_id);
 303   else
 304     s = format (s, "%U local %U:%d external %U:%d vrf %d",
 305                 format_nat_protocol, m->proto,
 306                 format_ip4_address, &m->l_addr,
 307                 clib_net_to_host_u16 (m->l_port),
 308                 format_vnet_sw_if_index_name, vnm, m->sw_if_index,
 309                 clib_net_to_host_u16 (m->e_port), m->vrf_id);
 310
 311   return s;
 312 }
 313
 314 /*
 315  * fd.io coding-style-patch-verification: ON
 316  *
 317  * Local Variables:
 318  * eval: (c-set-style "gnu")
 319  * End:
 320  */