src/plugins/nat/nat_inlines.h

   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  * @brief The NAT inline functions
  17  */
  18
  19 #ifndef __included_nat_inlines_h__
  20 #define __included_nat_inlines_h__
  21
  22 #include <vnet/fib/ip4_fib.h>
  23 #include <nat/nat.h>
  24
  25 always_inline u32
  26 ip_proto_to_snat_proto (u8 ip_proto)
  27 {
  28   u32 snat_proto = ~0;
  29
  30   snat_proto = (ip_proto == IP_PROTOCOL_UDP) ? SNAT_PROTOCOL_UDP : snat_proto;
  31   snat_proto = (ip_proto == IP_PROTOCOL_TCP) ? SNAT_PROTOCOL_TCP : snat_proto;
  32   snat_proto =
  33     (ip_proto == IP_PROTOCOL_ICMP) ? SNAT_PROTOCOL_ICMP : snat_proto;
  34   snat_proto =
  35     (ip_proto == IP_PROTOCOL_ICMP6) ? SNAT_PROTOCOL_ICMP : snat_proto;
  36
  37   return snat_proto;
  38 }
  39
  40 always_inline u8
  41 snat_proto_to_ip_proto (snat_protocol_t snat_proto)
  42 {
  43   u8 ip_proto = ~0;
  44
  45   ip_proto = (snat_proto == SNAT_PROTOCOL_UDP) ? IP_PROTOCOL_UDP : ip_proto;
  46   ip_proto = (snat_proto == SNAT_PROTOCOL_TCP) ? IP_PROTOCOL_TCP : ip_proto;
  47   ip_proto = (snat_proto == SNAT_PROTOCOL_ICMP) ? IP_PROTOCOL_ICMP : ip_proto;
  48
  49   return ip_proto;
  50 }
  51
  52 static_always_inline u8
  53 icmp_is_error_message (icmp46_header_t * icmp)
  54 {
  55   switch (icmp->type)
  56     {
  57     case ICMP4_destination_unreachable:
  58     case ICMP4_time_exceeded:
  59     case ICMP4_parameter_problem:
  60     case ICMP4_source_quench:
  61     case ICMP4_redirect:
  62     case ICMP4_alternate_host_address:
  63       return 1;
  64     }
  65   return 0;
  66 }
  67
  68 always_inline u8
  69 is_interface_addr (snat_main_t * sm, vlib_node_runtime_t * node,
  70                    u32 sw_if_index0, u32 ip4_addr)
  71 {
  72   snat_runtime_t *rt = (snat_runtime_t *) node->runtime_data;
  73   ip4_address_t *first_int_addr;
  74
  75   if (PREDICT_FALSE (rt->cached_sw_if_index != sw_if_index0))
  76     {
  77       first_int_addr =
  78         ip4_interface_first_address (sm->ip4_main, sw_if_index0,
  79                                      0 /* just want the address */ );
  80       rt->cached_sw_if_index = sw_if_index0;
  81       if (first_int_addr)
  82         rt->cached_ip4_address = first_int_addr->as_u32;
  83       else
  84         rt->cached_ip4_address = 0;
  85     }
  86
  87   if (PREDICT_FALSE (ip4_addr == rt->cached_ip4_address))
  88     return 1;
  89   else
  90     return 0;
  91 }
  92
  93 always_inline u8
  94 maximum_sessions_exceeded (snat_main_t * sm, u32 thread_index)
  95 {
  96   if (pool_elts (sm->per_thread_data[thread_index].sessions) >=
  97       sm->max_translations)
  98     return 1;
  99
 100   return 0;
 101 }
 102
 103 always_inline void
 104 nat_send_all_to_node (vlib_main_t * vm, u32 * bi_vector,
 105                       vlib_node_runtime_t * node, vlib_error_t * error,
 106                       u32 next)
 107 {
 108   u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
 109
 110   from = bi_vector;
 111   n_left_from = vec_len (bi_vector);
 112   next_index = node->cached_next_index;
 113   while (n_left_from > 0)
 114     {
 115       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 116       while (n_left_from > 0 && n_left_to_next > 0)
 117         {
 118           u32 bi0 = to_next[0] = from[0];
 119           from += 1;
 120           n_left_from -= 1;
 121           to_next += 1;
 122           n_left_to_next -= 1;
 123           vlib_buffer_t *p0 = vlib_get_buffer (vm, bi0);
 124           if (error)
 125             p0->error = *error;
 126           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 127                                            n_left_to_next, bi0, next);
 128         }
 129       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 130     }
 131 }
 132
 133 always_inline void
 134 user_session_increment (snat_main_t * sm, snat_user_t * u, u8 is_static)
 135 {
 136   if (u->nsessions + u->nstaticsessions < sm->max_translations_per_user)
 137     {
 138       if (is_static)
 139         u->nstaticsessions++;
 140       else
 141         u->nsessions++;
 142     }
 143 }
 144
 145 always_inline void
 146 nat44_delete_user_with_no_session (snat_main_t * sm, snat_user_t * u,
 147                                    u32 thread_index)
 148 {
 149   clib_bihash_kv_8_8_t kv;
 150   snat_user_key_t u_key;
 151   snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
 152                                                        thread_index);
 153
 154   if (u->nstaticsessions == 0 && u->nsessions == 0)
 155     {
 156       u_key.addr.as_u32 = u->addr.as_u32;
 157       u_key.fib_index = u->fib_index;
 158       kv.key = u_key.as_u64;
 159       pool_put_index (tsm->list_pool, u->sessions_per_user_list_head_index);
 160       pool_put (tsm->users, u);
 161       clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
 162       vlib_set_simple_counter (&sm->total_users, thread_index, 0,
 163                                pool_elts (tsm->users));
 164     }
 165 }
 166
 167 always_inline void
 168 nat44_delete_session (snat_main_t * sm, snat_session_t * ses,
 169                       u32 thread_index)
 170 {
 171   snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
 172                                                        thread_index);
 173   clib_bihash_kv_8_8_t kv, value;
 174   snat_user_key_t u_key;
 175   snat_user_t *u;
 176
 177   nat_log_debug ("session deleted %U", format_snat_session, tsm, ses);
 178
 179   clib_dlist_remove (tsm->list_pool, ses->per_user_index);
 180   pool_put_index (tsm->list_pool, ses->per_user_index);
 181   pool_put (tsm->sessions, ses);
 182   vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
 183                            pool_elts (tsm->sessions));
 184
 185   u_key.addr = ses->in2out.addr;
 186   u_key.fib_index = ses->in2out.fib_index;
 187   kv.key = u_key.as_u64;
 188   if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
 189     {
 190       u = pool_elt_at_index (tsm->users, value.value);
 191       if (snat_is_session_static (ses))
 192         u->nstaticsessions--;
 193       else
 194         u->nsessions--;
 195
 196       nat44_delete_user_with_no_session (sm, u, thread_index);
 197     }
 198 }
 199
 200 /** \brief Set TCP session state.
 201     @return 1 if session was closed, otherwise 0
 202 */
 203 always_inline int
 204 nat44_set_tcp_session_state_i2o (snat_main_t * sm, snat_session_t * ses,
 205                                  tcp_header_t * tcp, u32 thread_index)
 206 {
 207   if ((ses->state == 0) && (tcp->flags & TCP_FLAG_RST))
 208     ses->state = NAT44_SES_RST;
 209   if ((ses->state == NAT44_SES_RST) && !(tcp->flags & TCP_FLAG_RST))
 210     ses->state = 0;
 211   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
 212       (ses->state & NAT44_SES_O2I_SYN))
 213     ses->state = 0;
 214   if (tcp->flags & TCP_FLAG_SYN)
 215     ses->state |= NAT44_SES_I2O_SYN;
 216   if (tcp->flags & TCP_FLAG_FIN)
 217     {
 218       ses->i2o_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
 219       ses->state |= NAT44_SES_I2O_FIN;
 220     }
 221   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_O2I_FIN))
 222     {
 223       if (clib_net_to_host_u32 (tcp->ack_number) > ses->o2i_fin_seq)
 224         ses->state |= NAT44_SES_O2I_FIN_ACK;
 225     }
 226   if (nat44_is_ses_closed (ses)
 227       && !(ses->flags & SNAT_SESSION_FLAG_OUTPUT_FEATURE))
 228     {
 229       nat_log_debug ("TCP close connection %U", format_snat_session,
 230                      &sm->per_thread_data[thread_index], ses);
 231       nat_free_session_data (sm, ses, thread_index);
 232       nat44_delete_session (sm, ses, thread_index);
 233       return 1;
 234     }
 235   return 0;
 236 }
 237
 238 always_inline int
 239 nat44_set_tcp_session_state_o2i (snat_main_t * sm, snat_session_t * ses,
 240                                  tcp_header_t * tcp, u32 thread_index)
 241 {
 242   if ((ses->state == 0) && (tcp->flags & TCP_FLAG_RST))
 243     ses->state = NAT44_SES_RST;
 244   if ((ses->state == NAT44_SES_RST) && !(tcp->flags & TCP_FLAG_RST))
 245     ses->state = 0;
 246   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
 247       (ses->state & NAT44_SES_O2I_SYN))
 248     ses->state = 0;
 249   if (tcp->flags & TCP_FLAG_SYN)
 250     ses->state |= NAT44_SES_O2I_SYN;
 251   if (tcp->flags & TCP_FLAG_FIN)
 252     {
 253       ses->o2i_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
 254       ses->state |= NAT44_SES_O2I_FIN;
 255     }
 256   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_FIN))
 257     {
 258       if (clib_net_to_host_u32 (tcp->ack_number) > ses->i2o_fin_seq)
 259         ses->state |= NAT44_SES_I2O_FIN_ACK;
 260     }
 261   if (nat44_is_ses_closed (ses))
 262     {
 263       nat_log_debug ("TCP close connection %U", format_snat_session,
 264                      &sm->per_thread_data[thread_index], ses);
 265       nat_free_session_data (sm, ses, thread_index);
 266       nat44_delete_session (sm, ses, thread_index);
 267       return 1;
 268     }
 269   return 0;
 270 }
 271
 272 always_inline u32
 273 nat44_session_get_timeout (snat_main_t * sm, snat_session_t * s)
 274 {
 275   switch (s->in2out.protocol)
 276     {
 277     case SNAT_PROTOCOL_ICMP:
 278       return sm->icmp_timeout;
 279     case SNAT_PROTOCOL_UDP:
 280       return sm->udp_timeout;
 281     case SNAT_PROTOCOL_TCP:
 282       {
 283         if (s->state)
 284           return sm->tcp_transitory_timeout;
 285         else
 286           return sm->tcp_established_timeout;
 287       }
 288     default:
 289       return sm->udp_timeout;
 290     }
 291
 292   return 0;
 293 }
 294
 295 always_inline void
 296 nat44_session_update_counters (snat_session_t * s, f64 now, uword bytes)
 297 {
 298   s->last_heard = now;
 299   s->total_pkts++;
 300   s->total_bytes += bytes;
 301 }
 302
 303 /** \brief Per-user LRU list maintenance */
 304 always_inline void
 305 nat44_session_update_lru (snat_main_t * sm, snat_session_t * s,
 306                           u32 thread_index)
 307 {
 308   clib_dlist_remove (sm->per_thread_data[thread_index].list_pool,
 309                      s->per_user_index);
 310   clib_dlist_addtail (sm->per_thread_data[thread_index].list_pool,
 311                       s->per_user_list_head_index, s->per_user_index);
 312 }
 313
 314 always_inline void
 315 make_ed_kv (clib_bihash_kv_16_8_t * kv, ip4_address_t * l_addr,
 316             ip4_address_t * r_addr, u8 proto, u32 fib_index, u16 l_port,
 317             u16 r_port)
 318 {
 319   nat_ed_ses_key_t *key = (nat_ed_ses_key_t *) kv->key;
 320
 321   key->l_addr.as_u32 = l_addr->as_u32;
 322   key->r_addr.as_u32 = r_addr->as_u32;
 323   key->fib_index = fib_index;
 324   key->proto = proto;
 325   key->l_port = l_port;
 326   key->r_port = r_port;
 327
 328   kv->value = ~0ULL;
 329 }
 330
 331 always_inline void
 332 make_sm_kv (clib_bihash_kv_8_8_t * kv, ip4_address_t * addr, u8 proto,
 333             u32 fib_index, u16 port)
 334 {
 335   snat_session_key_t key;
 336
 337   key.addr.as_u32 = addr->as_u32;
 338   key.port = port;
 339   key.protocol = proto;
 340   key.fib_index = fib_index;
 341
 342   kv->key = key.as_u64;
 343   kv->value = ~0ULL;
 344 }
 345
 346 always_inline void
 347 mss_clamping (snat_main_t * sm, tcp_header_t * tcp, ip_csum_t * sum)
 348 {
 349   u8 *data;
 350   u8 opt_len, opts_len, kind;
 351   u16 mss;
 352
 353   if (!(sm->mss_clamping && tcp_syn (tcp)))
 354     return;
 355
 356   opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
 357   data = (u8 *) (tcp + 1);
 358   for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
 359     {
 360       kind = data[0];
 361
 362       if (kind == TCP_OPTION_EOL)
 363         break;
 364       else if (kind == TCP_OPTION_NOOP)
 365         {
 366           opt_len = 1;
 367           continue;
 368         }
 369       else
 370         {
 371           if (opts_len < 2)
 372             return;
 373           opt_len = data[1];
 374
 375           if (opt_len < 2 || opt_len > opts_len)
 376             return;
 377         }
 378
 379       if (kind == TCP_OPTION_MSS)
 380         {
 381           mss = *(u16 *) (data + 2);
 382           if (clib_net_to_host_u16 (mss) > sm->mss_clamping)
 383             {
 384               *sum =
 385                 ip_csum_update (*sum, mss, sm->mss_value_net, ip4_header_t,
 386                                 length);
 387               clib_memcpy_fast (data + 2, &sm->mss_value_net, 2);
 388             }
 389           return;
 390         }
 391     }
 392 }
 393
 394 /**
 395  * @brief Check if packet should be translated
 396  *
 397  * Packets aimed at outside interface and external address with active session
 398  * should be translated.
 399  *
 400  * @param sm            NAT main
 401  * @param rt            NAT runtime data
 402  * @param sw_if_index0  index of the inside interface
 403  * @param ip0           IPv4 header
 404  * @param proto0        NAT protocol
 405  * @param rx_fib_index0 RX FIB index
 406  *
 407  * @returns 0 if packet should be translated otherwise 1
 408  */
 409 static inline int
 410 snat_not_translate_fast (snat_main_t * sm, vlib_node_runtime_t * node,
 411                          u32 sw_if_index0, ip4_header_t * ip0, u32 proto0,
 412                          u32 rx_fib_index0)
 413 {
 414   if (sm->out2in_dpo)
 415     return 0;
 416
 417   fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
 418   nat_outside_fib_t *outside_fib;
 419   fib_prefix_t pfx = {
 420     .fp_proto = FIB_PROTOCOL_IP4,
 421     .fp_len = 32,
 422     .fp_addr = {
 423                 .ip4.as_u32 = ip0->dst_address.as_u32,
 424                 }
 425     ,
 426   };
 427
 428   /* Don't NAT packet aimed at the intfc address */
 429   if (PREDICT_FALSE (is_interface_addr (sm, node, sw_if_index0,
 430                                         ip0->dst_address.as_u32)))
 431     return 1;
 432
 433   fei = fib_table_lookup (rx_fib_index0, &pfx);
 434   if (FIB_NODE_INDEX_INVALID != fei)
 435     {
 436       u32 sw_if_index = fib_entry_get_resolving_interface (fei);
 437       if (sw_if_index == ~0)
 438         {
 439           vec_foreach (outside_fib, sm->outside_fibs)
 440           {
 441             fei = fib_table_lookup (outside_fib->fib_index, &pfx);
 442             if (FIB_NODE_INDEX_INVALID != fei)
 443               {
 444                 sw_if_index = fib_entry_get_resolving_interface (fei);
 445                 if (sw_if_index != ~0)
 446                   break;
 447               }
 448           }
 449         }
 450       if (sw_if_index == ~0)
 451         return 1;
 452
 453       snat_interface_t *i;
 454       pool_foreach (i, sm->interfaces, (
 455                                          {
 456                                          /* NAT packet aimed at outside interface */
 457                                          if ((nat_interface_is_outside (i))
 458                                              && (sw_if_index ==
 459                                                  i->sw_if_index)) return 0;}
 460                     ));
 461     }
 462
 463   return 1;
 464 }
 465
 466 #endif /* __included_nat_inlines_h__ */
 467
 468 /*
 469  * fd.io coding-style-patch-verification: ON
 470  *
 471  * Local Variables:
 472  * eval: (c-set-style "gnu")
 473  * End:
 474  */