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 = format (s, "  o2i %U proto %u fib %u\n",
 125                   format_ip4_address, &sess->out2in.addr,
 126                   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,
 137                   format_nat_protocol, sess->nat_proto,
 138                   clib_net_to_host_u16 (sess->out2in.port),
 139                   sess->out2in.fib_index);
 140     }
 141   if (is_ed_session (sess) || is_fwd_bypass_session (sess))
 142     {
 143       if (is_twice_nat_session (sess))
 144         {
 145           s = format (s, "       external host o2i %U:%d i2o %U:%d\n",
 146                       format_ip4_address, &sess->ext_host_addr,
 147                       clib_net_to_host_u16 (sess->ext_host_port),
 148                       format_ip4_address, &sess->ext_host_nat_addr,
 149                       clib_net_to_host_u16 (sess->ext_host_nat_port));
 150         }
 151       else
 152         {
 153           if (sess->ext_host_addr.as_u32)
 154             s = format (s, "       external host %U:%u\n",
 155                         format_ip4_address, &sess->ext_host_addr,
 156                         clib_net_to_host_u16 (sess->ext_host_port));
 157         }
 158     }
 159   s = format (s, "       index %llu\n", sess - tsm->sessions);
 160   s = format (s, "       last heard %.2f\n", sess->last_heard);
 161   s = format (s, "       total pkts %d, total bytes %lld\n",
 162               sess->total_pkts, sess->total_bytes);
 163   if (snat_is_session_static (sess))
 164     s = format (s, "       static translation\n");
 165   else
 166     s = format (s, "       dynamic translation\n");
 167   if (is_fwd_bypass_session (sess))
 168     s = format (s, "       forwarding-bypass\n");
 169   if (is_lb_session (sess))
 170     s = format (s, "       load-balancing\n");
 171   if (is_twice_nat_session (sess))
 172     s = format (s, "       twice-nat\n");
 173
 174   return s;
 175 }
 176
 177 u8 *
 178 format_snat_user (u8 * s, va_list * args)
 179 {
 180   snat_main_per_thread_data_t *tsm =
 181     va_arg (*args, snat_main_per_thread_data_t *);
 182   snat_user_t *u = va_arg (*args, snat_user_t *);
 183   int verbose = va_arg (*args, int);
 184   dlist_elt_t *head, *elt;
 185   u32 elt_index, head_index;
 186   u32 session_index;
 187   snat_session_t *sess;
 188
 189   s = format (s, "%U: %d dynamic translations, %d static translations\n",
 190               format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
 191
 192   if (verbose == 0)
 193     return s;
 194
 195   if (u->nsessions || u->nstaticsessions)
 196     {
 197       head_index = u->sessions_per_user_list_head_index;
 198       head = pool_elt_at_index (tsm->list_pool, head_index);
 199
 200       elt_index = head->next;
 201       elt = pool_elt_at_index (tsm->list_pool, elt_index);
 202       session_index = elt->value;
 203
 204       while (session_index != ~0)
 205         {
 206           sess = pool_elt_at_index (tsm->sessions, session_index);
 207
 208           s = format (s, "  %U\n", format_snat_session, tsm, sess);
 209
 210           elt_index = elt->next;
 211           elt = pool_elt_at_index (tsm->list_pool, elt_index);
 212           session_index = elt->value;
 213         }
 214     }
 215
 216   return s;
 217 }
 218
 219 u8 *
 220 format_snat_static_mapping (u8 * s, va_list * args)
 221 {
 222   snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
 223   nat44_lb_addr_port_t *local;
 224
 225   if (is_identity_static_mapping (m))
 226     {
 227       if (is_addr_only_static_mapping (m))
 228         s = format (s, "identity mapping %U",
 229                     format_ip4_address, &m->local_addr);
 230       else
 231         s = format (s, "identity mapping %U %U:%d",
 232                     format_nat_protocol, m->proto,
 233                     format_ip4_address, &m->local_addr, m->local_port);
 234
 235       /* *INDENT-OFF* */
 236       pool_foreach (local, m->locals,
 237       ({
 238         s = format (s, " vrf %d", local->vrf_id);
 239       }));
 240       /* *INDENT-ON* */
 241
 242       return s;
 243     }
 244
 245   if (is_addr_only_static_mapping (m))
 246     s = format (s, "local %U external %U vrf %d %s %s",
 247                 format_ip4_address, &m->local_addr,
 248                 format_ip4_address, &m->external_addr,
 249                 m->vrf_id,
 250                 m->twice_nat == TWICE_NAT ? "twice-nat" :
 251                 m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
 252                 is_out2in_only_static_mapping (m) ? "out2in-only" : "");
 253   else
 254     {
 255       if (is_lb_static_mapping (m))
 256         {
 257           s = format (s, "%U external %U:%d %s %s",
 258                       format_nat_protocol, m->proto,
 259                       format_ip4_address, &m->external_addr, m->external_port,
 260                       m->twice_nat == TWICE_NAT ? "twice-nat" :
 261                       m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
 262                       is_out2in_only_static_mapping (m) ? "out2in-only" : "");
 263
 264           /* *INDENT-OFF* */
 265           pool_foreach (local, m->locals,
 266           ({
 267             s = format (s, "\n  local %U:%d vrf %d probability %d\%",
 268                         format_ip4_address, &local->addr, local->port,
 269                         local->vrf_id, local->probability);
 270           }));
 271           /* *INDENT-ON* */
 272
 273         }
 274       else
 275         s = format (s, "%U local %U:%d external %U:%d vrf %d %s %s",
 276                     format_nat_protocol, m->proto,
 277                     format_ip4_address, &m->local_addr, m->local_port,
 278                     format_ip4_address, &m->external_addr, m->external_port,
 279                     m->vrf_id,
 280                     m->twice_nat == TWICE_NAT ? "twice-nat" :
 281                     m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
 282                     is_out2in_only_static_mapping (m) ? "out2in-only" : "");
 283     }
 284   return s;
 285 }
 286
 287 u8 *
 288 format_snat_static_map_to_resolve (u8 * s, va_list * args)
 289 {
 290   snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
 291   vnet_main_t *vnm = vnet_get_main ();
 292
 293   if (m->addr_only)
 294     s = format (s, "local %U external %U vrf %d",
 295                 format_ip4_address, &m->l_addr,
 296                 format_vnet_sw_if_index_name, vnm, m->sw_if_index, m->vrf_id);
 297   else
 298     s = format (s, "%U local %U:%d external %U:%d vrf %d",
 299                 format_nat_protocol, m->proto,
 300                 format_ip4_address, &m->l_addr, m->l_port,
 301                 format_vnet_sw_if_index_name, vnm, m->sw_if_index,
 302                 m->e_port, m->vrf_id);
 303
 304   return s;
 305 }
 306
 307 /*
 308  * fd.io coding-style-patch-verification: ON
 309  *
 310  * Local Variables:
 311  * eval: (c-set-style "gnu")
 312  * End:
 313  */