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     }
 163 }
 164
 165 always_inline void
 166 nat44_delete_session (snat_main_t * sm, snat_session_t * ses,
 167                       u32 thread_index)
 168 {
 169   snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
 170                                                        thread_index);
 171   clib_bihash_kv_8_8_t kv, value;
 172   snat_user_key_t u_key;
 173   snat_user_t *u;
 174
 175   nat_log_debug ("session deleted %U", format_snat_session, tsm, ses);
 176
 177   clib_dlist_remove (tsm->list_pool, ses->per_user_index);
 178   pool_put_index (tsm->list_pool, ses->per_user_index);
 179   pool_put (tsm->sessions, ses);
 180
 181   u_key.addr = ses->in2out.addr;
 182   u_key.fib_index = ses->in2out.fib_index;
 183   kv.key = u_key.as_u64;
 184   if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
 185     {
 186       u = pool_elt_at_index (tsm->users, value.value);
 187       if (snat_is_session_static (ses))
 188         u->nstaticsessions--;
 189       else
 190         u->nsessions--;
 191
 192       nat44_delete_user_with_no_session (sm, u, thread_index);
 193     }
 194 }
 195
 196 /** \brief Set TCP session state.
 197     @return 1 if session was closed, otherwise 0
 198 */
 199 always_inline int
 200 nat44_set_tcp_session_state_i2o (snat_main_t * sm, snat_session_t * ses,
 201                                  tcp_header_t * tcp, u32 thread_index)
 202 {
 203   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
 204       (ses->state & NAT44_SES_O2I_SYN))
 205     ses->state = 0;
 206   if (tcp->flags & TCP_FLAG_SYN)
 207     ses->state |= NAT44_SES_I2O_SYN;
 208   if (tcp->flags & TCP_FLAG_FIN)
 209     {
 210       ses->i2o_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
 211       ses->state |= NAT44_SES_I2O_FIN;
 212     }
 213   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_O2I_FIN))
 214     {
 215       if (clib_net_to_host_u32 (tcp->ack_number) > ses->o2i_fin_seq)
 216         ses->state |= NAT44_SES_O2I_FIN_ACK;
 217     }
 218   if (nat44_is_ses_closed (ses)
 219       && !(ses->flags & SNAT_SESSION_FLAG_OUTPUT_FEATURE))
 220     {
 221       nat_log_debug ("TCP close connection %U", format_snat_session,
 222                      &sm->per_thread_data[thread_index], ses);
 223       nat_free_session_data (sm, ses, thread_index);
 224       nat44_delete_session (sm, ses, thread_index);
 225       return 1;
 226     }
 227   return 0;
 228 }
 229
 230 always_inline int
 231 nat44_set_tcp_session_state_o2i (snat_main_t * sm, snat_session_t * ses,
 232                                  tcp_header_t * tcp, u32 thread_index)
 233 {
 234   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
 235       (ses->state & NAT44_SES_O2I_SYN))
 236     ses->state = 0;
 237   if (tcp->flags & TCP_FLAG_SYN)
 238     ses->state |= NAT44_SES_O2I_SYN;
 239   if (tcp->flags & TCP_FLAG_FIN)
 240     {
 241       ses->o2i_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
 242       ses->state |= NAT44_SES_O2I_FIN;
 243     }
 244   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_FIN))
 245     {
 246       if (clib_net_to_host_u32 (tcp->ack_number) > ses->i2o_fin_seq)
 247         ses->state |= NAT44_SES_I2O_FIN_ACK;
 248     }
 249   if (nat44_is_ses_closed (ses))
 250     {
 251       nat_log_debug ("TCP close connection %U", format_snat_session,
 252                      &sm->per_thread_data[thread_index], ses);
 253       nat_free_session_data (sm, ses, thread_index);
 254       nat44_delete_session (sm, ses, thread_index);
 255       return 1;
 256     }
 257   return 0;
 258 }
 259
 260 always_inline u32
 261 nat44_session_get_timeout (snat_main_t * sm, snat_session_t * s)
 262 {
 263   switch (s->in2out.protocol)
 264     {
 265     case SNAT_PROTOCOL_ICMP:
 266       return sm->icmp_timeout;
 267     case SNAT_PROTOCOL_UDP:
 268       return sm->udp_timeout;
 269     case SNAT_PROTOCOL_TCP:
 270       {
 271         if (s->state)
 272           return sm->tcp_transitory_timeout;
 273         else
 274           return sm->tcp_established_timeout;
 275       }
 276     default:
 277       return sm->udp_timeout;
 278     }
 279
 280   return 0;
 281 }
 282
 283 always_inline void
 284 nat44_session_update_counters (snat_session_t * s, f64 now, uword bytes)
 285 {
 286   s->last_heard = now;
 287   s->total_pkts++;
 288   s->total_bytes += bytes;
 289 }
 290
 291 /** \brief Per-user LRU list maintenance */
 292 always_inline void
 293 nat44_session_update_lru (snat_main_t * sm, snat_session_t * s,
 294                           u32 thread_index)
 295 {
 296   clib_dlist_remove (sm->per_thread_data[thread_index].list_pool,
 297                      s->per_user_index);
 298   clib_dlist_addtail (sm->per_thread_data[thread_index].list_pool,
 299                       s->per_user_list_head_index, s->per_user_index);
 300 }
 301
 302 always_inline void
 303 make_ed_kv (clib_bihash_kv_16_8_t * kv, ip4_address_t * l_addr,
 304             ip4_address_t * r_addr, u8 proto, u32 fib_index, u16 l_port,
 305             u16 r_port)
 306 {
 307   nat_ed_ses_key_t *key = (nat_ed_ses_key_t *) kv->key;
 308
 309   key->l_addr.as_u32 = l_addr->as_u32;
 310   key->r_addr.as_u32 = r_addr->as_u32;
 311   key->fib_index = fib_index;
 312   key->proto = proto;
 313   key->l_port = l_port;
 314   key->r_port = r_port;
 315
 316   kv->value = ~0ULL;
 317 }
 318
 319 always_inline void
 320 make_sm_kv (clib_bihash_kv_8_8_t * kv, ip4_address_t * addr, u8 proto,
 321             u32 fib_index, u16 port)
 322 {
 323   snat_session_key_t key;
 324
 325   key.addr.as_u32 = addr->as_u32;
 326   key.port = port;
 327   key.protocol = proto;
 328   key.fib_index = fib_index;
 329
 330   kv->key = key.as_u64;
 331   kv->value = ~0ULL;
 332 }
 333
 334 always_inline void
 335 mss_clamping (snat_main_t * sm, tcp_header_t * tcp, ip_csum_t * sum)
 336 {
 337   u8 *data;
 338   u8 opt_len, opts_len, kind;
 339   u16 mss;
 340
 341   if (!(sm->mss_clamping && tcp_syn (tcp)))
 342     return;
 343
 344   opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
 345   data = (u8 *) (tcp + 1);
 346   for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
 347     {
 348       kind = data[0];
 349
 350       if (kind == TCP_OPTION_EOL)
 351         break;
 352       else if (kind == TCP_OPTION_NOOP)
 353         {
 354           opt_len = 1;
 355           continue;
 356         }
 357       else
 358         {
 359           if (opts_len < 2)
 360             return;
 361           opt_len = data[1];
 362
 363           if (opt_len < 2 || opt_len > opts_len)
 364             return;
 365         }
 366
 367       if (kind == TCP_OPTION_MSS)
 368         {
 369           mss = *(u16 *) (data + 2);
 370           if (clib_net_to_host_u16 (mss) > sm->mss_clamping)
 371             {
 372               *sum =
 373                 ip_csum_update (*sum, mss, sm->mss_value_net, ip4_header_t,
 374                                 length);
 375               clib_memcpy_fast (data + 2, &sm->mss_value_net, 2);
 376             }
 377           return;
 378         }
 379     }
 380 }
 381
 382 /**
 383  * @brief Check if packet should be translated
 384  *
 385  * Packets aimed at outside interface and external address with active session
 386  * should be translated.
 387  *
 388  * @param sm            NAT main
 389  * @param rt            NAT runtime data
 390  * @param sw_if_index0  index of the inside interface
 391  * @param ip0           IPv4 header
 392  * @param proto0        NAT protocol
 393  * @param rx_fib_index0 RX FIB index
 394  *
 395  * @returns 0 if packet should be translated otherwise 1
 396  */
 397 static inline int
 398 snat_not_translate_fast (snat_main_t * sm, vlib_node_runtime_t * node,
 399                          u32 sw_if_index0, ip4_header_t * ip0, u32 proto0,
 400                          u32 rx_fib_index0)
 401 {
 402   if (sm->out2in_dpo)
 403     return 0;
 404
 405   fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
 406   nat_outside_fib_t *outside_fib;
 407   fib_prefix_t pfx = {
 408     .fp_proto = FIB_PROTOCOL_IP4,
 409     .fp_len = 32,
 410     .fp_addr = {
 411                 .ip4.as_u32 = ip0->dst_address.as_u32,
 412                 }
 413     ,
 414   };
 415
 416   /* Don't NAT packet aimed at the intfc address */
 417   if (PREDICT_FALSE (is_interface_addr (sm, node, sw_if_index0,
 418                                         ip0->dst_address.as_u32)))
 419     return 1;
 420
 421   fei = fib_table_lookup (rx_fib_index0, &pfx);
 422   if (FIB_NODE_INDEX_INVALID != fei)
 423     {
 424       u32 sw_if_index = fib_entry_get_resolving_interface (fei);
 425       if (sw_if_index == ~0)
 426         {
 427           vec_foreach (outside_fib, sm->outside_fibs)
 428           {
 429             fei = fib_table_lookup (outside_fib->fib_index, &pfx);
 430             if (FIB_NODE_INDEX_INVALID != fei)
 431               {
 432                 sw_if_index = fib_entry_get_resolving_interface (fei);
 433                 if (sw_if_index != ~0)
 434                   break;
 435               }
 436           }
 437         }
 438       if (sw_if_index == ~0)
 439         return 1;
 440
 441       snat_interface_t *i;
 442       pool_foreach (i, sm->interfaces, (
 443                                          {
 444                                          /* NAT packet aimed at outside interface */
 445                                          if ((nat_interface_is_outside (i))
 446                                              && (sw_if_index ==
 447                                                  i->sw_if_index)) return 0;}
 448                     ));
 449     }
 450
 451   return 1;
 452 }
 453
 454 #endif /* __included_nat_inlines_h__ */
 455
 456 /*
 457  * fd.io coding-style-patch-verification: ON
 458  *
 459  * Local Variables:
 460  * eval: (c-set-style "gnu")
 461  * End:
 462  */