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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @brief NAT44 endpoint-dependent outside to inside network translation
20 #include <vlib/vlib.h>
21 #include <vnet/vnet.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/fib/ip4_fib.h>
25 #include <vnet/udp/udp_local.h>
26 #include <vppinfra/error.h>
28 #include <nat/lib/ipfix_logging.h>
29 #include <nat/nat_inlines.h>
30 #include <nat/nat44/inlines.h>
31 #include <nat/lib/nat_syslog.h>
32 #include <nat/nat44/ed_inlines.h>
34 static char *nat_out2in_ed_error_strings[] = {
35 #define _(sym,string) string,
36 foreach_nat_out2in_ed_error
45 nat_translation_error_e translation_error;
48 clib_bihash_kv_16_8_t search_key;
50 u8 translation_via_i2of;
52 } nat44_ed_out2in_trace_t;
55 format_nat44_ed_out2in_trace (u8 * s, va_list * args)
57 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
58 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
59 nat44_ed_out2in_trace_t *t = va_arg (*args, nat44_ed_out2in_trace_t *);
63 t->is_slow_path ? "NAT44_OUT2IN_ED_SLOW_PATH" :
64 "NAT44_OUT2IN_ED_FAST_PATH";
66 s = format (s, "%s: sw_if_index %d, next index %d, session %d", tag,
67 t->sw_if_index, t->next_index, t->session_index);
68 if (~0 != t->session_index)
70 s = format (s, ", translation result '%U' via %s",
71 format_nat_ed_translation_error, t->translation_error,
72 t->translation_via_i2of ? "i2of" : "o2if");
73 s = format (s, "\n i2of %U", format_nat_6t_flow, &t->i2of);
74 s = format (s, "\n o2if %U", format_nat_6t_flow, &t->o2if);
78 if (t->lookup_skipped)
80 s = format (s, "\n lookup skipped - cached session index used");
84 s = format (s, "\n search key %U", format_ed_session_kvp,
93 next_src_nat (snat_main_t *sm, ip4_header_t *ip, u16 src_port, u16 dst_port,
94 u32 thread_index, u32 rx_fib_index)
96 clib_bihash_kv_16_8_t kv, value;
98 init_ed_k (&kv, ip->src_address, src_port, ip->dst_address, dst_port,
99 rx_fib_index, ip->protocol);
100 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv, &value))
106 static void create_bypass_for_fwd (snat_main_t *sm, vlib_buffer_t *b,
107 snat_session_t *s, ip4_header_t *ip,
108 u32 rx_fib_index, u32 thread_index);
110 static snat_session_t *create_session_for_static_mapping_ed (
111 snat_main_t *sm, vlib_buffer_t *b, ip4_address_t i2o_addr, u16 i2o_port,
112 u32 i2o_fib_index, ip4_address_t o2i_addr, u16 o2i_port, u32 o2i_fib_index,
113 nat_protocol_t nat_proto, vlib_node_runtime_t *node, u32 rx_fib_index,
114 u32 thread_index, twice_nat_type_t twice_nat, lb_nat_type_t lb_nat, f64 now,
115 snat_static_mapping_t *mapping);
118 icmp_out2in_ed_slow_path (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
119 icmp46_header_t *icmp, u32 sw_if_index,
120 u32 rx_fib_index, vlib_node_runtime_t *node,
121 u32 next, f64 now, u32 thread_index,
122 snat_session_t **s_p)
124 vlib_main_t *vm = vlib_get_main ();
129 snat_session_t *s = 0;
130 u8 is_addr_only, identity_nat;
131 ip4_address_t sm_addr;
134 snat_static_mapping_t *m;
136 ip4_address_t lookup_saddr, lookup_daddr;
137 u16 lookup_sport, lookup_dport;
139 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
140 rx_fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
142 if (nat_get_icmp_session_lookup_values (b, ip, &lookup_saddr, &lookup_sport,
143 &lookup_daddr, &lookup_dport,
146 b->error = node->errors[NAT_OUT2IN_ED_ERROR_UNSUPPORTED_PROTOCOL];
147 next = NAT_NEXT_DROP;
151 if (snat_static_mapping_match (
152 sm, ip->dst_address, lookup_sport, rx_fib_index,
153 ip_proto_to_nat_proto (ip->protocol), &sm_addr, &sm_port,
154 &sm_fib_index, 1, &is_addr_only, 0, 0, 0, &identity_nat, &m))
156 // static mapping not matched
157 if (!sm->forwarding_enabled)
159 /* Don't NAT packet aimed at the intfc address */
160 if (!is_interface_addr (sm, node, sw_if_index,
161 ip->dst_address.as_u32))
163 b->error = node->errors[NAT_OUT2IN_ED_ERROR_NO_TRANSLATION];
164 next = NAT_NEXT_DROP;
169 if (next_src_nat (sm, ip, lookup_sport, lookup_dport, thread_index,
172 next = NAT_NEXT_IN2OUT_ED_FAST_PATH;
176 create_bypass_for_fwd (sm, b, s, ip, rx_fib_index, thread_index);
182 if (PREDICT_FALSE (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags !=
184 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags !=
185 ICMP4_echo_request ||
188 b->error = node->errors[NAT_OUT2IN_ED_ERROR_BAD_ICMP_TYPE];
189 next = NAT_NEXT_DROP;
193 if (PREDICT_FALSE (identity_nat))
198 /* Create session initiated by host from external network */
199 s = create_session_for_static_mapping_ed (
200 sm, b, sm_addr, sm_port, sm_fib_index, ip->dst_address, lookup_sport,
201 rx_fib_index, ip_proto_to_nat_proto (lookup_protocol), node, rx_fib_index,
202 thread_index, 0, 0, vlib_time_now (vm), m);
204 next = NAT_NEXT_DROP;
206 if (PREDICT_TRUE (!ip4_is_fragment (ip)))
208 sum = ip_incremental_checksum_buffer (
209 vm, b, (u8 *) icmp - (u8 *) vlib_buffer_get_current (b),
210 ntohs (ip->length) - ip4_header_bytes (ip), 0);
211 checksum = ~ip_csum_fold (sum);
212 if (checksum != 0 && checksum != 0xffff)
214 next = NAT_NEXT_DROP;
219 if (PREDICT_TRUE (next != NAT_NEXT_DROP && s))
222 nat44_session_update_counters (
223 s, now, vlib_buffer_length_in_chain (vm, b), thread_index);
224 /* Per-user LRU list maintenance */
225 nat44_session_update_lru (sm, s, thread_index);
228 if (NAT_NEXT_DROP == next && s)
230 nat_ed_session_delete (sm, s, thread_index, 1);
237 // allocate exact address based on preference
238 static_always_inline int
239 nat_alloc_addr_and_port_exact (snat_address_t * a,
241 nat_protocol_t proto,
242 ip4_address_t * addr,
244 u16 port_per_thread, u32 snat_thread_index)
250 #define _(N, j, n, s) \
251 case NAT_PROTOCOL_##N: \
252 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
256 portnum = (port_per_thread * \
257 snat_thread_index) + \
258 snat_random_port(0, port_per_thread - 1) + 1024; \
259 if (a->busy_##n##_port_refcounts[portnum]) \
261 --a->busy_##n##_port_refcounts[portnum]; \
262 a->busy_##n##_ports_per_thread[thread_index]++; \
263 a->busy_##n##_ports++; \
265 *port = clib_host_to_net_u16(portnum); \
273 nat_elog_info ("unknown protocol");
277 /* Totally out of translations to use... */
278 nat_ipfix_logging_addresses_exhausted (thread_index, 0);
282 static_always_inline int
283 nat44_ed_alloc_outside_addr_and_port (snat_address_t *addresses, u32 fib_index,
284 u32 thread_index, nat_protocol_t proto,
285 ip4_address_t *addr, u16 *port,
287 u32 snat_thread_index)
290 snat_address_t *a, *ga = 0;
293 for (i = 0; i < vec_len (addresses); i++)
298 #define _(N, j, n, s) \
299 case NAT_PROTOCOL_##N: \
300 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
302 if (a->fib_index == fib_index) \
306 portnum = (port_per_thread * snat_thread_index) + \
307 snat_random_port (0, port_per_thread - 1) + 1024; \
308 if (a->busy_##n##_port_refcounts[portnum]) \
310 --a->busy_##n##_port_refcounts[portnum]; \
311 a->busy_##n##_ports_per_thread[thread_index]++; \
312 a->busy_##n##_ports++; \
314 *port = clib_host_to_net_u16 (portnum); \
318 else if (a->fib_index == ~0) \
326 default : nat_elog_info ("unknown protocol");
336 #define _(N, j, n, s) \
337 case NAT_PROTOCOL_##N: \
340 portnum = (port_per_thread * snat_thread_index) + \
341 snat_random_port (0, port_per_thread - 1) + 1024; \
342 if (a->busy_##n##_port_refcounts[portnum]) \
344 ++a->busy_##n##_port_refcounts[portnum]; \
345 a->busy_##n##_ports_per_thread[thread_index]++; \
346 a->busy_##n##_ports++; \
348 *port = clib_host_to_net_u16 (portnum); \
354 default : nat_elog_info ("unknown protocol");
359 /* Totally out of translations to use... */
360 nat_ipfix_logging_addresses_exhausted (thread_index, 0);
364 static snat_session_t *
365 create_session_for_static_mapping_ed (
366 snat_main_t *sm, vlib_buffer_t *b, ip4_address_t i2o_addr, u16 i2o_port,
367 u32 i2o_fib_index, ip4_address_t o2i_addr, u16 o2i_port, u32 o2i_fib_index,
368 nat_protocol_t nat_proto, vlib_node_runtime_t *node, u32 rx_fib_index,
369 u32 thread_index, twice_nat_type_t twice_nat, lb_nat_type_t lb_nat, f64 now,
370 snat_static_mapping_t *mapping)
375 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
378 (nat44_ed_maximum_sessions_exceeded (sm, rx_fib_index, thread_index)))
380 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_SESSIONS_EXCEEDED];
381 nat_elog_notice ("maximum sessions exceeded");
385 s = nat_ed_session_alloc (sm, thread_index, now, nat_proto);
388 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_USER_SESS_EXCEEDED];
389 nat_elog_warn ("create NAT session failed");
393 ip = vlib_buffer_get_current (b);
394 udp = ip4_next_header (ip);
396 s->ext_host_addr.as_u32 = ip->src_address.as_u32;
397 s->ext_host_port = nat_proto == NAT_PROTOCOL_ICMP ? 0 : udp->src_port;
398 s->flags |= SNAT_SESSION_FLAG_STATIC_MAPPING;
400 s->flags |= SNAT_SESSION_FLAG_LOAD_BALANCING;
401 if (lb_nat == AFFINITY_LB_NAT)
402 s->flags |= SNAT_SESSION_FLAG_AFFINITY;
403 s->flags |= SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT;
404 s->out2in.addr = o2i_addr;
405 s->out2in.port = o2i_port;
406 s->out2in.fib_index = o2i_fib_index;
407 s->in2out.addr = i2o_addr;
408 s->in2out.port = i2o_port;
409 s->in2out.fib_index = i2o_fib_index;
410 s->nat_proto = nat_proto;
412 if (NAT_PROTOCOL_ICMP == nat_proto)
414 nat_6t_o2i_flow_init (sm, thread_index, s, s->ext_host_addr, o2i_port,
415 o2i_addr, o2i_port, o2i_fib_index, ip->protocol);
416 nat_6t_flow_icmp_id_rewrite_set (&s->o2i, i2o_port);
420 nat_6t_o2i_flow_init (sm, thread_index, s, s->ext_host_addr,
421 s->ext_host_port, o2i_addr, o2i_port,
422 o2i_fib_index, ip->protocol);
423 nat_6t_flow_dport_rewrite_set (&s->o2i, i2o_port);
425 nat_6t_flow_daddr_rewrite_set (&s->o2i, i2o_addr.as_u32);
426 nat_6t_flow_txfib_rewrite_set (&s->o2i, i2o_fib_index);
428 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 1))
430 b->error = node->errors[NAT_OUT2IN_ED_ERROR_HASH_ADD_FAILED];
431 nat_ed_session_delete (sm, s, thread_index, 1);
432 nat_elog_warn ("out2in flow hash add failed");
436 if (twice_nat == TWICE_NAT || (twice_nat == TWICE_NAT_SELF &&
437 ip->src_address.as_u32 == i2o_addr.as_u32))
440 snat_address_t *filter = 0;
442 // if exact address is specified use this address
443 if (is_exact_address (mapping))
446 vec_foreach (ap, sm->twice_nat_addresses)
448 if (mapping->pool_addr.as_u32 == ap->addr.as_u32)
458 rc = nat_alloc_addr_and_port_exact (filter,
461 &s->ext_host_nat_addr,
462 &s->ext_host_nat_port,
464 tsm->snat_thread_index);
465 s->flags |= SNAT_SESSION_FLAG_EXACT_ADDRESS;
469 rc = nat44_ed_alloc_outside_addr_and_port (
470 sm->twice_nat_addresses, 0, thread_index, nat_proto,
471 &s->ext_host_nat_addr, &s->ext_host_nat_port, sm->port_per_thread,
472 tsm->snat_thread_index);
477 b->error = node->errors[NAT_OUT2IN_ED_ERROR_OUT_OF_PORTS];
478 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 0))
480 nat_elog_warn ("out2in flow hash del failed");
482 snat_free_outside_address_and_port (
483 sm->twice_nat_addresses, thread_index, &s->ext_host_nat_addr,
484 s->ext_host_nat_port, s->nat_proto);
485 nat_ed_session_delete (sm, s, thread_index, 1);
489 s->flags |= SNAT_SESSION_FLAG_TWICE_NAT;
491 nat_6t_flow_saddr_rewrite_set (&s->o2i, s->ext_host_nat_addr.as_u32);
492 if (NAT_PROTOCOL_ICMP == nat_proto)
494 nat_6t_flow_icmp_id_rewrite_set (&s->o2i, s->ext_host_nat_port);
498 nat_6t_flow_sport_rewrite_set (&s->o2i, s->ext_host_nat_port);
501 nat_6t_l3_l4_csum_calc (&s->o2i);
503 nat_6t_i2o_flow_init (sm, thread_index, s, i2o_addr, i2o_port,
504 s->ext_host_nat_addr, s->ext_host_nat_port,
505 i2o_fib_index, ip->protocol);
506 nat_6t_flow_daddr_rewrite_set (&s->i2o, s->ext_host_addr.as_u32);
507 if (NAT_PROTOCOL_ICMP == nat_proto)
509 nat_6t_flow_icmp_id_rewrite_set (&s->i2o, s->ext_host_port);
513 nat_6t_flow_dport_rewrite_set (&s->i2o, s->ext_host_port);
518 if (NAT_PROTOCOL_ICMP == nat_proto)
520 nat_6t_i2o_flow_init (sm, thread_index, s, i2o_addr, i2o_port,
521 s->ext_host_addr, i2o_port, i2o_fib_index,
526 nat_6t_i2o_flow_init (sm, thread_index, s, i2o_addr, i2o_port,
527 s->ext_host_addr, s->ext_host_port,
528 i2o_fib_index, ip->protocol);
532 nat_6t_flow_saddr_rewrite_set (&s->i2o, o2i_addr.as_u32);
533 if (NAT_PROTOCOL_ICMP == nat_proto)
535 nat_6t_flow_icmp_id_rewrite_set (&s->i2o, o2i_port);
539 nat_6t_flow_sport_rewrite_set (&s->i2o, o2i_port);
542 if (nat_ed_ses_i2o_flow_hash_add_del (sm, thread_index, s, 1))
544 nat_elog_notice ("in2out flow hash add failed");
545 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 0))
547 nat_elog_warn ("out2in flow hash del failed");
549 nat_ed_session_delete (sm, s, thread_index, 1);
553 nat_ipfix_logging_nat44_ses_create (thread_index,
554 s->in2out.addr.as_u32,
555 s->out2in.addr.as_u32,
558 s->out2in.port, s->in2out.fib_index);
560 nat_syslog_nat44_sadd (s->user_index, s->in2out.fib_index,
561 &s->in2out.addr, s->in2out.port,
562 &s->ext_host_nat_addr, s->ext_host_nat_port,
563 &s->out2in.addr, s->out2in.port,
564 &s->ext_host_addr, s->ext_host_port,
565 s->nat_proto, is_twice_nat_session (s));
567 per_vrf_sessions_register_session (s, thread_index);
573 create_bypass_for_fwd (snat_main_t *sm, vlib_buffer_t *b, snat_session_t *s,
574 ip4_header_t *ip, u32 rx_fib_index, u32 thread_index)
576 clib_bihash_kv_16_8_t kv, value;
578 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
579 vlib_main_t *vm = vlib_get_main ();
580 f64 now = vlib_time_now (vm);
581 u16 lookup_sport, lookup_dport;
583 ip4_address_t lookup_saddr, lookup_daddr;
585 if (ip->protocol == IP_PROTOCOL_ICMP)
587 if (nat_get_icmp_session_lookup_values (b, ip, &lookup_saddr,
588 &lookup_sport, &lookup_daddr,
589 &lookup_dport, &lookup_protocol))
594 if (ip->protocol == IP_PROTOCOL_UDP || ip->protocol == IP_PROTOCOL_TCP)
596 udp = ip4_next_header (ip);
597 lookup_sport = udp->dst_port;
598 lookup_dport = udp->src_port;
605 lookup_saddr.as_u32 = ip->dst_address.as_u32;
606 lookup_daddr.as_u32 = ip->src_address.as_u32;
607 lookup_protocol = ip->protocol;
610 init_ed_k (&kv, lookup_saddr, lookup_sport, lookup_daddr, lookup_dport,
611 rx_fib_index, lookup_protocol);
613 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv, &value))
615 ASSERT (thread_index == ed_value_get_thread_index (&value));
617 pool_elt_at_index (tsm->sessions,
618 ed_value_get_session_index (&value));
620 else if (ip->protocol == IP_PROTOCOL_ICMP &&
621 icmp_type_is_error_message
622 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
631 (nat44_ed_maximum_sessions_exceeded
632 (sm, rx_fib_index, thread_index)))
635 s = nat_ed_session_alloc (sm, thread_index, now, ip->protocol);
638 nat_elog_warn ("create NAT session failed");
642 proto = ip_proto_to_nat_proto (ip->protocol);
644 s->ext_host_addr = ip->src_address;
645 s->ext_host_port = lookup_dport;
646 s->flags |= SNAT_SESSION_FLAG_FWD_BYPASS;
647 s->out2in.addr = ip->dst_address;
648 s->out2in.port = lookup_sport;
649 s->nat_proto = proto;
650 if (proto == NAT_PROTOCOL_OTHER)
652 s->flags |= SNAT_SESSION_FLAG_UNKNOWN_PROTO;
653 s->out2in.port = ip->protocol;
655 s->out2in.fib_index = rx_fib_index;
656 s->in2out.addr = s->out2in.addr;
657 s->in2out.port = s->out2in.port;
658 s->in2out.fib_index = s->out2in.fib_index;
660 nat_6t_i2o_flow_init (sm, thread_index, s, ip->dst_address, lookup_sport,
661 ip->src_address, lookup_dport, rx_fib_index,
663 nat_6t_flow_txfib_rewrite_set (&s->i2o, rx_fib_index);
664 if (nat_ed_ses_i2o_flow_hash_add_del (sm, thread_index, s, 1))
666 nat_elog_notice ("in2out flow add failed");
667 nat_ed_session_delete (sm, s, thread_index, 1);
671 per_vrf_sessions_register_session (s, thread_index);
674 if (ip->protocol == IP_PROTOCOL_TCP)
676 tcp_header_t *tcp = ip4_next_header (ip);
677 nat44_set_tcp_session_state_o2i (sm, now, s, tcp->flags,
678 tcp->ack_number, tcp->seq_number,
683 nat44_session_update_counters (s, now, 0, thread_index);
684 /* Per-user LRU list maintenance */
685 nat44_session_update_lru (sm, s, thread_index);
688 static snat_session_t *
689 nat44_ed_out2in_slowpath_unknown_proto (snat_main_t *sm, vlib_buffer_t *b,
690 ip4_header_t *ip, u32 rx_fib_index,
691 u32 thread_index, f64 now,
693 vlib_node_runtime_t *node)
695 clib_bihash_kv_8_8_t kv, value;
696 snat_static_mapping_t *m;
700 nat44_ed_maximum_sessions_exceeded (sm, rx_fib_index, thread_index)))
702 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_SESSIONS_EXCEEDED];
703 nat_elog_notice ("maximum sessions exceeded");
707 init_nat_k (&kv, ip->dst_address, 0, 0, 0);
708 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
710 b->error = node->errors[NAT_OUT2IN_ED_ERROR_NO_TRANSLATION];
714 m = pool_elt_at_index (sm->static_mappings, value.value);
716 /* Create a new session */
717 s = nat_ed_session_alloc (sm, thread_index, now, ip->protocol);
720 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_USER_SESS_EXCEEDED];
721 nat_elog_warn ("create NAT session failed");
725 s->ext_host_addr.as_u32 = ip->src_address.as_u32;
726 s->flags |= SNAT_SESSION_FLAG_UNKNOWN_PROTO;
727 s->flags |= SNAT_SESSION_FLAG_STATIC_MAPPING;
728 s->flags |= SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT;
729 s->out2in.addr.as_u32 = ip->dst_address.as_u32;
730 s->out2in.fib_index = rx_fib_index;
731 s->in2out.addr.as_u32 = m->local_addr.as_u32;
732 s->in2out.fib_index = m->fib_index;
733 s->in2out.port = s->out2in.port = ip->protocol;
735 nat_6t_o2i_flow_init (sm, thread_index, s, ip->dst_address, 0,
736 ip->src_address, 0, m->fib_index, ip->protocol);
737 nat_6t_flow_saddr_rewrite_set (&s->i2o, ip->dst_address.as_u32);
738 if (nat_ed_ses_i2o_flow_hash_add_del (sm, thread_index, s, 1))
740 nat_elog_notice ("in2out key add failed");
741 nat_ed_session_delete (sm, s, thread_index, 1);
745 nat_6t_o2i_flow_init (sm, thread_index, s, ip->src_address, 0,
746 ip->dst_address, 0, rx_fib_index, ip->protocol);
747 nat_6t_flow_daddr_rewrite_set (&s->o2i, m->local_addr.as_u32);
748 nat_6t_flow_txfib_rewrite_set (&s->o2i, m->fib_index);
749 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 1))
751 nat_elog_notice ("out2in flow hash add failed");
752 nat_ed_session_delete (sm, s, thread_index, 1);
756 per_vrf_sessions_register_session (s, thread_index);
759 nat44_session_update_counters (s, now, vlib_buffer_length_in_chain (vm, b),
761 /* Per-user LRU list maintenance */
762 nat44_session_update_lru (sm, s, thread_index);
768 nat44_ed_out2in_fast_path_node_fn_inline (vlib_main_t * vm,
769 vlib_node_runtime_t * node,
770 vlib_frame_t * frame,
773 u32 n_left_from, *from;
774 snat_main_t *sm = &snat_main;
775 f64 now = vlib_time_now (vm);
776 u32 thread_index = vm->thread_index;
777 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
779 from = vlib_frame_vector_args (frame);
780 n_left_from = frame->n_vectors;
782 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
783 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
784 vlib_get_buffers (vm, from, b, n_left_from);
786 while (n_left_from > 0)
789 u32 sw_if_index0, rx_fib_index0;
790 nat_protocol_t proto0;
792 snat_session_t *s0 = 0;
793 clib_bihash_kv_16_8_t kv0, value0;
794 nat_translation_error_e translation_error = NAT_ED_TRNSL_ERR_SUCCESS;
795 nat_6t_flow_t *f = 0;
796 ip4_address_t lookup_saddr, lookup_daddr;
797 u16 lookup_sport, lookup_dport;
799 int lookup_skipped = 0;
804 lookup_sport = vnet_buffer (b0)->ip.reass.l4_src_port;
805 lookup_dport = vnet_buffer (b0)->ip.reass.l4_dst_port;
807 /* Prefetch next iteration. */
808 if (PREDICT_TRUE (n_left_from >= 2))
814 vlib_prefetch_buffer_header (p2, LOAD);
816 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
819 next[0] = vnet_buffer2 (b0)->nat.arc_next;
821 vnet_buffer (b0)->snat.flags = 0;
822 ip0 = vlib_buffer_get_current (b0);
824 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
826 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index0);
828 if (PREDICT_FALSE (ip0->ttl == 1))
830 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
831 icmp4_error_set_vnet_buffer (b0, ICMP4_time_exceeded,
832 ICMP4_time_exceeded_ttl_exceeded_in_transit,
834 next[0] = NAT_NEXT_ICMP_ERROR;
838 proto0 = ip_proto_to_nat_proto (ip0->protocol);
840 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_ICMP))
842 if (vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags !=
843 ICMP4_echo_request &&
844 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags !=
846 !icmp_type_is_error_message (
847 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags))
849 b0->error = node->errors[NAT_OUT2IN_ED_ERROR_BAD_ICMP_TYPE];
850 next[0] = NAT_NEXT_DROP;
853 int err = nat_get_icmp_session_lookup_values (
854 b0, ip0, &lookup_saddr, &lookup_sport, &lookup_daddr,
855 &lookup_dport, &lookup_protocol);
858 b0->error = node->errors[err];
859 next[0] = NAT_NEXT_DROP;
865 lookup_saddr.as_u32 = ip0->src_address.as_u32;
866 lookup_daddr.as_u32 = ip0->dst_address.as_u32;
867 lookup_protocol = ip0->protocol;
870 /* there might be a stashed index in vnet_buffer2 from handoff or
871 * classify node, see if it can be used */
872 if (!pool_is_free_index (tsm->sessions,
873 vnet_buffer2 (b0)->nat.cached_session_index))
875 s0 = pool_elt_at_index (tsm->sessions,
876 vnet_buffer2 (b0)->nat.cached_session_index);
878 nat_6t_flow_match (&s0->o2i, b0, lookup_saddr, lookup_sport,
879 lookup_daddr, lookup_dport, lookup_protocol,
881 (s0->flags & SNAT_SESSION_FLAG_TWICE_NAT &&
882 nat_6t_flow_match (&s0->i2o, b0, lookup_saddr, lookup_sport,
883 lookup_daddr, lookup_dport,
884 lookup_protocol, rx_fib_index0))))
886 /* yes, this is the droid we're looking for */
893 init_ed_k (&kv0, lookup_saddr, lookup_sport, lookup_daddr, lookup_dport,
894 rx_fib_index0, lookup_protocol);
897 if (clib_bihash_search_16_8 (&sm->flow_hash, &kv0, &value0))
899 // flow does not exist go slow path
900 next[0] = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
903 ASSERT (thread_index == ed_value_get_thread_index (&value0));
905 pool_elt_at_index (tsm->sessions,
906 ed_value_get_session_index (&value0));
909 if (PREDICT_FALSE (per_vrf_sessions_is_expired (s0, thread_index)))
911 // session is closed, go slow path
912 nat_free_session_data (sm, s0, thread_index, 0);
913 nat_ed_session_delete (sm, s0, thread_index, 1);
914 next[0] = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
918 if (s0->tcp_closed_timestamp)
920 if (now >= s0->tcp_closed_timestamp)
922 // session is closed, go slow path, freed in slow path
923 next[0] = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
927 // session in transitory timeout, drop
928 b0->error = node->errors[NAT_OUT2IN_ED_ERROR_TCP_CLOSED];
929 next[0] = NAT_NEXT_DROP;
934 // drop if session expired
935 u64 sess_timeout_time;
937 s0->last_heard + (f64) nat44_session_get_timeout (sm, s0);
938 if (now >= sess_timeout_time)
940 // session is closed, go slow path
941 nat_free_session_data (sm, s0, thread_index, 0);
942 nat_ed_session_delete (sm, s0, thread_index, 1);
943 next[0] = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
947 if (nat_6t_flow_match (&s0->o2i, b0, lookup_saddr, lookup_sport,
948 lookup_daddr, lookup_dport, lookup_protocol,
953 else if (s0->flags & SNAT_SESSION_FLAG_TWICE_NAT &&
954 nat_6t_flow_match (&s0->i2o, b0, lookup_saddr, lookup_sport,
955 lookup_daddr, lookup_dport, lookup_protocol,
963 * Send DHCP packets to the ipv4 stack, or we won't
964 * be able to use dhcp client on the outside interface
967 proto0 == NAT_PROTOCOL_UDP &&
968 (vnet_buffer (b0)->ip.reass.l4_dst_port ==
969 clib_host_to_net_u16 (UDP_DST_PORT_dhcp_to_client))))
974 if (!sm->forwarding_enabled)
976 b0->error = node->errors[NAT_OUT2IN_ED_ERROR_NO_TRANSLATION];
977 next[0] = NAT_NEXT_DROP;
982 if (nat_6t_flow_match (&s0->i2o, b0, lookup_saddr, lookup_sport,
983 lookup_daddr, lookup_dport,
984 lookup_protocol, rx_fib_index0))
990 // FIXME TODO bypass ???
991 // create_bypass_for_fwd (sm, b0, s0, ip0, rx_fib_index0,
993 translation_error = NAT_ED_TRNSL_ERR_FLOW_MISMATCH;
994 nat_free_session_data (sm, s0, thread_index, 0);
995 nat_ed_session_delete (sm, s0, thread_index, 1);
996 next[0] = NAT_NEXT_DROP;
1002 if (NAT_ED_TRNSL_ERR_SUCCESS !=
1003 (translation_error = nat_6t_flow_buf_translate (
1004 sm, b0, ip0, f, proto0, 0 /* is_output_feature */)))
1006 next[0] = NAT_NEXT_DROP;
1012 case NAT_PROTOCOL_TCP:
1013 vlib_increment_simple_counter (&sm->counters.fastpath.out2in_ed.tcp,
1014 thread_index, sw_if_index0, 1);
1015 nat44_set_tcp_session_state_o2i (sm, now, s0,
1016 vnet_buffer (b0)->ip.
1017 reass.icmp_type_or_tcp_flags,
1018 vnet_buffer (b0)->ip.
1019 reass.tcp_ack_number,
1020 vnet_buffer (b0)->ip.
1021 reass.tcp_seq_number,
1024 case NAT_PROTOCOL_UDP:
1025 vlib_increment_simple_counter (&sm->counters.fastpath.out2in_ed.udp,
1026 thread_index, sw_if_index0, 1);
1028 case NAT_PROTOCOL_ICMP:
1029 vlib_increment_simple_counter (&sm->counters.fastpath.out2in_ed.icmp,
1030 thread_index, sw_if_index0, 1);
1032 case NAT_PROTOCOL_OTHER:
1033 vlib_increment_simple_counter (
1034 &sm->counters.fastpath.out2in_ed.other, thread_index, sw_if_index0,
1040 nat44_session_update_counters (s0, now,
1041 vlib_buffer_length_in_chain (vm, b0),
1043 /* Per-user LRU list maintenance */
1044 nat44_session_update_lru (sm, s0, thread_index);
1047 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
1048 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
1050 nat44_ed_out2in_trace_t *t =
1051 vlib_add_trace (vm, node, b0, sizeof (*t));
1052 t->sw_if_index = sw_if_index0;
1053 t->next_index = next[0];
1054 t->is_slow_path = 0;
1055 t->translation_error = translation_error;
1056 clib_memcpy (&t->search_key, &kv0, sizeof (t->search_key));
1057 t->lookup_skipped = lookup_skipped;
1061 t->session_index = s0 - tsm->sessions;
1062 clib_memcpy (&t->i2of, &s0->i2o, sizeof (t->i2of));
1063 clib_memcpy (&t->o2if, &s0->o2i, sizeof (t->o2if));
1064 t->translation_via_i2of = (&s0->i2o == f);
1068 t->session_index = ~0;
1072 if (next[0] == NAT_NEXT_DROP)
1074 vlib_increment_simple_counter (&sm->counters.fastpath.
1075 out2in_ed.drops, thread_index,
1083 vlib_buffer_enqueue_to_next (vm, node, from, (u16 *) nexts,
1085 return frame->n_vectors;
1089 nat44_ed_out2in_slow_path_node_fn_inline (vlib_main_t * vm,
1090 vlib_node_runtime_t * node,
1091 vlib_frame_t * frame)
1093 u32 n_left_from, *from;
1094 snat_main_t *sm = &snat_main;
1095 f64 now = vlib_time_now (vm);
1096 u32 thread_index = vm->thread_index;
1097 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
1098 snat_static_mapping_t *m;
1100 from = vlib_frame_vector_args (frame);
1101 n_left_from = frame->n_vectors;
1103 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
1104 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
1105 vlib_get_buffers (vm, from, b, n_left_from);
1107 while (n_left_from > 0)
1110 u32 sw_if_index0, rx_fib_index0;
1111 nat_protocol_t proto0;
1114 icmp46_header_t *icmp0;
1115 snat_session_t *s0 = 0;
1116 clib_bihash_kv_16_8_t kv0, value0;
1117 lb_nat_type_t lb_nat0;
1118 twice_nat_type_t twice_nat0;
1120 ip4_address_t sm_addr;
1123 nat_translation_error_e translation_error = NAT_ED_TRNSL_ERR_SUCCESS;
1126 next[0] = vnet_buffer2 (b0)->nat.arc_next;
1128 vnet_buffer (b0)->snat.flags = 0;
1129 ip0 = vlib_buffer_get_current (b0);
1131 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
1133 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index0);
1135 if (PREDICT_FALSE (ip0->ttl == 1))
1137 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1138 icmp4_error_set_vnet_buffer (b0, ICMP4_time_exceeded,
1139 ICMP4_time_exceeded_ttl_exceeded_in_transit,
1141 next[0] = NAT_NEXT_ICMP_ERROR;
1145 udp0 = ip4_next_header (ip0);
1146 icmp0 = (icmp46_header_t *) udp0;
1147 proto0 = ip_proto_to_nat_proto (ip0->protocol);
1149 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_OTHER))
1151 s0 = nat44_ed_out2in_slowpath_unknown_proto (
1152 sm, b0, ip0, rx_fib_index0, thread_index, now, vm, node);
1153 if (!sm->forwarding_enabled)
1156 next[0] = NAT_NEXT_DROP;
1158 if (NAT_NEXT_DROP != next[0] &&
1159 NAT_ED_TRNSL_ERR_SUCCESS !=
1160 (translation_error = nat_6t_flow_buf_translate (
1161 sm, b0, ip0, &s0->o2i, proto0, 0 /* is_output_feature */)))
1166 vlib_increment_simple_counter (&sm->counters.slowpath.
1167 out2in_ed.other, thread_index,
1172 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_ICMP))
1174 next[0] = icmp_out2in_ed_slow_path
1175 (sm, b0, ip0, icmp0, sw_if_index0, rx_fib_index0, node,
1176 next[0], now, thread_index, &s0);
1178 if (NAT_NEXT_DROP != next[0] && s0 &&
1179 NAT_ED_TRNSL_ERR_SUCCESS !=
1180 (translation_error = nat_6t_flow_buf_translate (
1181 sm, b0, ip0, &s0->o2i, proto0, 0 /* is_output_feature */)))
1186 vlib_increment_simple_counter (&sm->counters.slowpath.
1187 out2in_ed.icmp, thread_index,
1192 init_ed_k (&kv0, ip0->src_address,
1193 vnet_buffer (b0)->ip.reass.l4_src_port, ip0->dst_address,
1194 vnet_buffer (b0)->ip.reass.l4_dst_port, rx_fib_index0,
1198 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv0, &value0))
1200 ASSERT (thread_index == ed_value_get_thread_index (&value0));
1202 pool_elt_at_index (tsm->sessions,
1203 ed_value_get_session_index (&value0));
1205 if (s0->tcp_closed_timestamp && now >= s0->tcp_closed_timestamp)
1207 nat_free_session_data (sm, s0, thread_index, 0);
1208 nat_ed_session_delete (sm, s0, thread_index, 1);
1215 /* Try to match static mapping by external address and port,
1216 destination address and port in packet */
1218 if (snat_static_mapping_match
1219 (sm, ip0->dst_address,
1220 vnet_buffer (b0)->ip.reass.l4_dst_port, rx_fib_index0,
1221 proto0, &sm_addr, &sm_port, &sm_fib_index, 1, 0,
1222 &twice_nat0, &lb_nat0, &ip0->src_address, &identity_nat0, &m))
1225 * Send DHCP packets to the ipv4 stack, or we won't
1226 * be able to use dhcp client on the outside interface
1228 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_UDP
1229 && (vnet_buffer (b0)->ip.reass.l4_dst_port ==
1230 clib_host_to_net_u16
1231 (UDP_DST_PORT_dhcp_to_client))))
1236 if (!sm->forwarding_enabled)
1239 node->errors[NAT_OUT2IN_ED_ERROR_NO_TRANSLATION];
1240 next[0] = NAT_NEXT_DROP;
1245 (sm, ip0, vnet_buffer (b0)->ip.reass.l4_src_port,
1246 vnet_buffer (b0)->ip.reass.l4_dst_port,
1247 thread_index, rx_fib_index0))
1249 next[0] = NAT_NEXT_IN2OUT_ED_FAST_PATH;
1253 create_bypass_for_fwd (sm, b0, s0, ip0, rx_fib_index0,
1260 if (PREDICT_FALSE (identity_nat0))
1263 if ((proto0 == NAT_PROTOCOL_TCP)
1264 && !tcp_flags_is_init (vnet_buffer (b0)->ip.
1265 reass.icmp_type_or_tcp_flags))
1267 b0->error = node->errors[NAT_OUT2IN_ED_ERROR_NON_SYN];
1268 next[0] = NAT_NEXT_DROP;
1272 /* Create session initiated by host from external network */
1273 s0 = create_session_for_static_mapping_ed (sm, b0,
1278 ip.reass.l4_dst_port,
1279 rx_fib_index0, proto0,
1280 node, rx_fib_index0,
1281 thread_index, twice_nat0,
1285 next[0] = NAT_NEXT_DROP;
1290 if (NAT_ED_TRNSL_ERR_SUCCESS !=
1291 (translation_error = nat_6t_flow_buf_translate (
1292 sm, b0, ip0, &s0->o2i, proto0, 0 /* is_output_feature */)))
1294 next[0] = NAT_NEXT_DROP;
1298 if (PREDICT_TRUE (proto0 == NAT_PROTOCOL_TCP))
1300 vlib_increment_simple_counter (&sm->counters.slowpath.out2in_ed.tcp,
1301 thread_index, sw_if_index0, 1);
1302 nat44_set_tcp_session_state_o2i (sm, now, s0,
1303 vnet_buffer (b0)->ip.
1304 reass.icmp_type_or_tcp_flags,
1305 vnet_buffer (b0)->ip.
1306 reass.tcp_ack_number,
1307 vnet_buffer (b0)->ip.
1308 reass.tcp_seq_number,
1313 vlib_increment_simple_counter (&sm->counters.slowpath.out2in_ed.udp,
1314 thread_index, sw_if_index0, 1);
1318 nat44_session_update_counters (s0, now,
1319 vlib_buffer_length_in_chain (vm, b0),
1321 /* Per-user LRU list maintenance */
1322 nat44_session_update_lru (sm, s0, thread_index);
1325 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
1326 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
1328 nat44_ed_out2in_trace_t *t =
1329 vlib_add_trace (vm, node, b0, sizeof (*t));
1330 t->sw_if_index = sw_if_index0;
1331 t->next_index = next[0];
1332 t->is_slow_path = 1;
1333 t->translation_error = translation_error;
1334 clib_memcpy (&t->search_key, &kv0, sizeof (t->search_key));
1338 t->session_index = s0 - tsm->sessions;
1339 clib_memcpy (&t->i2of, &s0->i2o, sizeof (t->i2of));
1340 clib_memcpy (&t->o2if, &s0->o2i, sizeof (t->o2if));
1344 t->session_index = ~0;
1348 if (next[0] == NAT_NEXT_DROP)
1350 vlib_increment_simple_counter (&sm->counters.slowpath.
1351 out2in_ed.drops, thread_index,
1360 vlib_buffer_enqueue_to_next (vm, node, from, (u16 *) nexts,
1363 return frame->n_vectors;
1366 VLIB_NODE_FN (nat44_ed_out2in_node) (vlib_main_t * vm,
1367 vlib_node_runtime_t * node,
1368 vlib_frame_t * frame)
1370 if (snat_main.num_workers > 1)
1372 return nat44_ed_out2in_fast_path_node_fn_inline (vm, node, frame, 1);
1376 return nat44_ed_out2in_fast_path_node_fn_inline (vm, node, frame, 0);
1381 VLIB_REGISTER_NODE (nat44_ed_out2in_node) = {
1382 .name = "nat44-ed-out2in",
1383 .vector_size = sizeof (u32),
1384 .sibling_of = "nat-default",
1385 .format_trace = format_nat44_ed_out2in_trace,
1386 .type = VLIB_NODE_TYPE_INTERNAL,
1387 .n_errors = ARRAY_LEN(nat_out2in_ed_error_strings),
1388 .error_strings = nat_out2in_ed_error_strings,
1389 .runtime_data_bytes = sizeof (snat_runtime_t),
1393 VLIB_NODE_FN (nat44_ed_out2in_slowpath_node) (vlib_main_t * vm,
1394 vlib_node_runtime_t * node,
1395 vlib_frame_t * frame)
1397 return nat44_ed_out2in_slow_path_node_fn_inline (vm, node, frame);
1401 VLIB_REGISTER_NODE (nat44_ed_out2in_slowpath_node) = {
1402 .name = "nat44-ed-out2in-slowpath",
1403 .vector_size = sizeof (u32),
1404 .sibling_of = "nat-default",
1405 .format_trace = format_nat44_ed_out2in_trace,
1406 .type = VLIB_NODE_TYPE_INTERNAL,
1407 .n_errors = ARRAY_LEN(nat_out2in_ed_error_strings),
1408 .error_strings = nat_out2in_ed_error_strings,
1409 .runtime_data_bytes = sizeof (snat_runtime_t),
1414 format_nat_pre_trace (u8 * s, va_list * args)
1416 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1417 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1418 nat_pre_trace_t *t = va_arg (*args, nat_pre_trace_t *);
1419 return format (s, "out2in next_index %d arc_next_index %d", t->next_index,
1423 VLIB_NODE_FN (nat_pre_out2in_node) (vlib_main_t * vm,
1424 vlib_node_runtime_t * node,
1425 vlib_frame_t * frame)
1427 return nat_pre_node_fn_inline (vm, node, frame,
1428 NAT_NEXT_OUT2IN_ED_FAST_PATH);
1432 VLIB_REGISTER_NODE (nat_pre_out2in_node) = {
1433 .name = "nat-pre-out2in",
1434 .vector_size = sizeof (u32),
1435 .sibling_of = "nat-default",
1436 .format_trace = format_nat_pre_trace,
1437 .type = VLIB_NODE_TYPE_INTERNAL,
1443 * fd.io coding-style-patch-verification: ON
1446 * eval: (c-set-style "gnu")