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/pg/pg.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/fib/ip4_fib.h>
26 #include <vnet/udp/udp.h>
27 #include <vppinfra/error.h>
29 #include <nat/nat_ipfix_logging.h>
30 #include <nat/nat_inlines.h>
31 #include <nat/nat44/inlines.h>
32 #include <nat/nat_syslog.h>
33 #include <nat/nat_ha.h>
34 #include <nat/nat44/ed_inlines.h>
36 static char *nat_out2in_ed_error_strings[] = {
37 #define _(sym,string) string,
38 foreach_nat_out2in_ed_error
48 } nat44_ed_out2in_trace_t;
51 format_nat44_ed_out2in_trace (u8 * s, va_list * args)
53 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
54 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
55 nat44_ed_out2in_trace_t *t = va_arg (*args, nat44_ed_out2in_trace_t *);
59 t->is_slow_path ? "NAT44_OUT2IN_ED_SLOW_PATH" :
60 "NAT44_OUT2IN_ED_FAST_PATH";
62 s = format (s, "%s: sw_if_index %d, next index %d, session %d", tag,
63 t->sw_if_index, t->next_index, t->session_index);
69 icmp_out2in_ed_slow_path (snat_main_t * sm, vlib_buffer_t * b0,
70 ip4_header_t * ip0, icmp46_header_t * icmp0,
71 u32 sw_if_index0, u32 rx_fib_index0,
72 vlib_node_runtime_t * node, u32 next0, f64 now,
73 u32 thread_index, snat_session_t ** p_s0)
75 vlib_main_t *vm = vlib_get_main ();
77 next0 = icmp_out2in (sm, b0, ip0, icmp0, sw_if_index0, rx_fib_index0, node,
78 next0, thread_index, p_s0, 0);
79 snat_session_t *s0 = *p_s0;
80 if (PREDICT_TRUE (next0 != NAT_NEXT_DROP && s0))
83 nat44_session_update_counters (s0, now,
84 vlib_buffer_length_in_chain
85 (vm, b0), thread_index);
86 /* Per-user LRU list maintenance */
87 nat44_session_update_lru (sm, s0, thread_index);
92 #ifndef CLIB_MARCH_VARIANT
94 nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg)
96 snat_main_t *sm = &snat_main;
97 nat44_is_idle_session_ctx_t *ctx = arg;
99 u64 sess_timeout_time;
102 ip4_address_t *l_addr, *r_addr;
104 clib_bihash_kv_16_8_t ed_kv;
107 snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
110 s = pool_elt_at_index (tsm->sessions, kv->value);
111 sess_timeout_time = s->last_heard + (f64) nat44_session_get_timeout (sm, s);
112 if (ctx->now >= sess_timeout_time)
114 l_addr = &s->in2out.addr;
115 r_addr = &s->ext_host_addr;
116 fib_index = s->in2out.fib_index;
117 if (snat_is_unk_proto_session (s))
119 proto = s->in2out.port;
125 proto = nat_proto_to_ip_proto (s->nat_proto);
126 l_port = s->in2out.port;
127 r_port = s->ext_host_port;
129 if (is_twice_nat_session (s))
131 r_addr = &s->ext_host_nat_addr;
132 r_port = s->ext_host_nat_port;
134 init_ed_k (&ed_kv, *l_addr, l_port, *r_addr, r_port, fib_index, proto);
135 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
136 nat_elog_warn ("in2out_ed key del failed");
138 if (snat_is_unk_proto_session (s))
141 snat_ipfix_logging_nat44_ses_delete (ctx->thread_index,
142 s->in2out.addr.as_u32,
143 s->out2in.addr.as_u32,
147 s->in2out.fib_index);
149 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
150 &s->in2out.addr, s->in2out.port,
151 &s->ext_host_nat_addr, s->ext_host_nat_port,
152 &s->out2in.addr, s->out2in.port,
153 &s->ext_host_addr, s->ext_host_port,
154 s->nat_proto, is_twice_nat_session (s));
156 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
157 s->ext_host_port, s->nat_proto, s->out2in.fib_index,
160 if (is_twice_nat_session (s))
162 for (i = 0; i < vec_len (sm->twice_nat_addresses); i++)
164 // FIXME TODO this is obviously wrong code ... needs fix!
165 // key.protocol = s->nat_proto;
166 // key.port = s->ext_host_nat_port;
167 // a = sm->twice_nat_addresses + i;
168 // if (a->addr.as_u32 == s->ext_host_nat_addr.as_u32)
170 // snat_free_outside_address_and_port (sm->twice_nat_addresses,
171 // ctx->thread_index,
178 if (snat_is_session_static (s))
181 snat_free_outside_address_and_port (sm->addresses, ctx->thread_index,
182 &s->out2in.addr, s->out2in.port,
185 nat_ed_session_delete (sm, s, ctx->thread_index, 1);
193 static snat_session_t *
194 create_session_for_static_mapping_ed (snat_main_t * sm,
196 ip4_address_t i2o_addr,
199 ip4_address_t o2i_addr,
202 nat_protocol_t nat_proto,
203 vlib_node_runtime_t * node,
206 twice_nat_type_t twice_nat,
207 lb_nat_type_t lb_nat, f64 now)
212 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
213 clib_bihash_kv_16_8_t kv;
214 nat44_is_idle_session_ctx_t ctx;
217 (nat44_ed_maximum_sessions_exceeded (sm, rx_fib_index, thread_index)))
219 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_SESSIONS_EXCEEDED];
220 nat_elog_notice ("maximum sessions exceeded");
224 s = nat_ed_session_alloc (sm, thread_index, now, nat_proto);
227 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_USER_SESS_EXCEEDED];
228 nat_elog_warn ("create NAT session failed");
232 ip = vlib_buffer_get_current (b);
233 udp = ip4_next_header (ip);
235 s->ext_host_addr.as_u32 = ip->src_address.as_u32;
236 s->ext_host_port = nat_proto == NAT_PROTOCOL_ICMP ? 0 : udp->src_port;
237 s->flags |= SNAT_SESSION_FLAG_STATIC_MAPPING;
239 s->flags |= SNAT_SESSION_FLAG_LOAD_BALANCING;
240 if (lb_nat == AFFINITY_LB_NAT)
241 s->flags |= SNAT_SESSION_FLAG_AFFINITY;
242 s->flags |= SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT;
243 s->out2in.addr = o2i_addr;
244 s->out2in.port = o2i_port;
245 s->out2in.fib_index = o2i_fib_index;
246 s->in2out.addr = i2o_addr;
247 s->in2out.port = i2o_port;
248 s->in2out.fib_index = i2o_fib_index;
249 s->nat_proto = nat_proto;
251 /* Add to lookup tables */
252 init_ed_kv (&kv, o2i_addr, o2i_port, s->ext_host_addr, s->ext_host_port,
253 o2i_fib_index, ip->protocol, thread_index, s - tsm->sessions);
255 ctx.thread_index = thread_index;
256 if (clib_bihash_add_or_overwrite_stale_16_8 (&sm->out2in_ed, &kv,
257 nat44_o2i_ed_is_idle_session_cb,
259 nat_elog_notice ("out2in-ed key add failed");
261 if (twice_nat == TWICE_NAT || (twice_nat == TWICE_NAT_SELF &&
262 ip->src_address.as_u32 == i2o_addr.as_u32))
264 if (snat_alloc_outside_address_and_port (sm->twice_nat_addresses, 0,
267 &s->ext_host_nat_addr,
268 &s->ext_host_nat_port,
270 tsm->snat_thread_index))
272 b->error = node->errors[NAT_OUT2IN_ED_ERROR_OUT_OF_PORTS];
273 nat_ed_session_delete (sm, s, thread_index, 1);
274 if (clib_bihash_add_del_16_8 (&sm->out2in_ed, &kv, 0))
275 nat_elog_notice ("out2in-ed key del failed");
278 s->flags |= SNAT_SESSION_FLAG_TWICE_NAT;
279 init_ed_kv (&kv, i2o_addr, i2o_port, s->ext_host_nat_addr,
280 s->ext_host_nat_port, i2o_fib_index, ip->protocol,
281 thread_index, s - tsm->sessions);
285 init_ed_kv (&kv, i2o_addr, i2o_port, s->ext_host_addr,
286 s->ext_host_port, i2o_fib_index, ip->protocol,
287 thread_index, s - tsm->sessions);
289 if (clib_bihash_add_or_overwrite_stale_16_8 (&tsm->in2out_ed, &kv,
290 nat44_i2o_ed_is_idle_session_cb,
292 nat_elog_notice ("in2out-ed key add failed");
294 snat_ipfix_logging_nat44_ses_create (thread_index,
295 s->in2out.addr.as_u32,
296 s->out2in.addr.as_u32,
299 s->out2in.port, s->in2out.fib_index);
301 nat_syslog_nat44_sadd (s->user_index, s->in2out.fib_index,
302 &s->in2out.addr, s->in2out.port,
303 &s->ext_host_nat_addr, s->ext_host_nat_port,
304 &s->out2in.addr, s->out2in.port,
305 &s->ext_host_addr, s->ext_host_port,
306 s->nat_proto, is_twice_nat_session (s));
308 nat_ha_sadd (&s->in2out.addr, s->in2out.port, &s->out2in.addr,
309 s->out2in.port, &s->ext_host_addr, s->ext_host_port,
310 &s->ext_host_nat_addr, s->ext_host_nat_port,
311 s->nat_proto, s->in2out.fib_index, s->flags, thread_index, 0);
317 next_src_nat (snat_main_t * sm, ip4_header_t * ip, u16 src_port,
318 u16 dst_port, u32 thread_index, u32 rx_fib_index)
320 clib_bihash_kv_16_8_t kv, value;
321 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
323 init_ed_k (&kv, ip->src_address, src_port, ip->dst_address, dst_port,
324 rx_fib_index, ip->protocol);
325 if (!clib_bihash_search_16_8 (&tsm->in2out_ed, &kv, &value))
332 create_bypass_for_fwd (snat_main_t * sm, vlib_buffer_t * b, ip4_header_t * ip,
333 u32 rx_fib_index, u32 thread_index)
335 clib_bihash_kv_16_8_t kv, value;
337 snat_session_t *s = 0;
338 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
339 vlib_main_t *vm = vlib_get_main ();
340 f64 now = vlib_time_now (vm);
343 if (ip->protocol == IP_PROTOCOL_ICMP)
345 if (get_icmp_o2i_ed_key
346 (b, ip, rx_fib_index, ~0, ~0, 0, &l_port, &r_port, &kv))
351 if (ip->protocol == IP_PROTOCOL_UDP || ip->protocol == IP_PROTOCOL_TCP)
353 udp = ip4_next_header (ip);
354 l_port = udp->dst_port;
355 r_port = udp->src_port;
362 init_ed_k (&kv, ip->dst_address, l_port, ip->src_address, r_port,
363 rx_fib_index, ip->protocol);
366 if (!clib_bihash_search_16_8 (&tsm->in2out_ed, &kv, &value))
368 ASSERT (thread_index == ed_value_get_thread_index (&value));
370 pool_elt_at_index (tsm->sessions,
371 ed_value_get_session_index (&value));
378 (nat44_ed_maximum_sessions_exceeded
379 (sm, rx_fib_index, thread_index)))
382 s = nat_ed_session_alloc (sm, thread_index, now, ip->protocol);
385 nat_elog_warn ("create NAT session failed");
389 proto = ip_proto_to_nat_proto (ip->protocol);
391 s->ext_host_addr = ip->src_address;
392 s->ext_host_port = r_port;
393 s->flags |= SNAT_SESSION_FLAG_FWD_BYPASS;
394 s->out2in.addr = ip->dst_address;
395 s->out2in.port = l_port;
396 s->nat_proto = proto;
397 if (proto == NAT_PROTOCOL_OTHER)
399 s->flags |= SNAT_SESSION_FLAG_UNKNOWN_PROTO;
400 s->out2in.port = ip->protocol;
402 s->out2in.fib_index = 0;
403 s->in2out.addr = s->out2in.addr;
404 s->in2out.port = s->out2in.port;
405 s->in2out.fib_index = s->out2in.fib_index;
407 kv.value = s - tsm->sessions;
408 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
409 nat_elog_notice ("in2out_ed key add failed");
412 if (ip->protocol == IP_PROTOCOL_TCP)
414 tcp_header_t *tcp = ip4_next_header (ip);
415 if (nat44_set_tcp_session_state_o2i
416 (sm, now, s, tcp->flags, tcp->ack_number, tcp->seq_number,
422 nat44_session_update_counters (s, now, 0, thread_index);
423 /* Per-user LRU list maintenance */
424 nat44_session_update_lru (sm, s, thread_index);
428 create_bypass_for_fwd_worker (snat_main_t * sm, vlib_buffer_t * b,
429 ip4_header_t * ip, u32 rx_fib_index)
431 ip4_header_t ip_wkr = {
432 .src_address = ip->dst_address,
434 u32 thread_index = sm->worker_in2out_cb (&ip_wkr, rx_fib_index, 0);
436 create_bypass_for_fwd (sm, b, ip, rx_fib_index, thread_index);
439 #ifndef CLIB_MARCH_VARIANT
441 icmp_match_out2in_ed (snat_main_t * sm, vlib_node_runtime_t * node,
442 u32 thread_index, vlib_buffer_t * b,
443 ip4_header_t * ip, ip4_address_t * addr,
444 u16 * port, u32 * fib_index, nat_protocol_t * proto,
445 void *d, void *e, u8 * dont_translate)
447 u32 next = ~0, sw_if_index, rx_fib_index;
448 clib_bihash_kv_16_8_t kv, value;
449 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
450 snat_session_t *s = 0;
451 u8 is_addr_only, identity_nat;
453 vlib_main_t *vm = vlib_get_main ();
454 ip4_address_t sm_addr;
459 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
460 rx_fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
462 if (get_icmp_o2i_ed_key
463 (b, ip, rx_fib_index, ~0, ~0, proto, &l_port, &r_port, &kv))
465 b->error = node->errors[NAT_OUT2IN_ED_ERROR_UNSUPPORTED_PROTOCOL];
466 next = NAT_NEXT_DROP;
470 if (clib_bihash_search_16_8 (&sm->out2in_ed, &kv, &value))
472 /* Try to match static mapping */
473 if (snat_static_mapping_match
474 (sm, ip->dst_address, l_port, rx_fib_index,
475 ip_proto_to_nat_proto (ip->protocol), &sm_addr, &sm_port,
476 &sm_fib_index, 1, &is_addr_only, 0, 0, 0, &identity_nat))
478 if (!sm->forwarding_enabled)
480 /* Don't NAT packet aimed at the intfc address */
481 if (PREDICT_FALSE (is_interface_addr (sm, node, sw_if_index,
482 ip->dst_address.as_u32)))
487 b->error = node->errors[NAT_OUT2IN_ED_ERROR_NO_TRANSLATION];
488 next = NAT_NEXT_DROP;
494 if (next_src_nat (sm, ip, l_port, r_port,
495 thread_index, rx_fib_index))
497 next = NAT_NEXT_IN2OUT_ED_FAST_PATH;
500 if (sm->num_workers > 1)
501 create_bypass_for_fwd_worker (sm, b, ip, rx_fib_index);
503 create_bypass_for_fwd (sm, b, ip, rx_fib_index, thread_index);
509 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags !=
511 && (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags !=
512 ICMP4_echo_request || !is_addr_only)))
514 b->error = node->errors[NAT_OUT2IN_ED_ERROR_BAD_ICMP_TYPE];
515 next = NAT_NEXT_DROP;
519 if (PREDICT_FALSE (identity_nat))
525 /* Create session initiated by host from external network */
527 create_session_for_static_mapping_ed (sm, b, sm_addr, sm_port,
528 sm_fib_index, ip->dst_address,
529 l_port, rx_fib_index, *proto,
536 next = NAT_NEXT_DROP;
543 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags !=
545 && vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags !=
547 && !icmp_type_is_error_message (vnet_buffer (b)->ip.
548 reass.icmp_type_or_tcp_flags)))
550 b->error = node->errors[NAT_OUT2IN_ED_ERROR_BAD_ICMP_TYPE];
551 next = NAT_NEXT_DROP;
555 ASSERT (thread_index == ed_value_get_thread_index (&value));
557 pool_elt_at_index (tsm->sessions,
558 ed_value_get_session_index (&value));
563 *addr = s->in2out.addr;
564 *port = s->in2out.port;
565 *fib_index = s->in2out.fib_index;
568 *(snat_session_t **) d = s;
573 static snat_session_t *
574 nat44_ed_out2in_unknown_proto (snat_main_t * sm,
580 vlib_main_t * vm, vlib_node_runtime_t * node)
582 clib_bihash_kv_8_8_t kv, value;
583 clib_bihash_kv_16_8_t s_kv, s_value;
584 snat_static_mapping_t *m;
585 u32 old_addr, new_addr;
588 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
590 old_addr = ip->dst_address.as_u32;
592 init_ed_k (&s_kv, ip->dst_address, 0, ip->src_address, 0, rx_fib_index,
595 if (!clib_bihash_search_16_8 (&sm->out2in_ed, &s_kv, &s_value))
597 ASSERT (thread_index == ed_value_get_thread_index (&s_value));
599 pool_elt_at_index (tsm->sessions,
600 ed_value_get_session_index (&s_value));
601 new_addr = ip->dst_address.as_u32 = s->in2out.addr.as_u32;
606 (nat44_ed_maximum_sessions_exceeded
607 (sm, rx_fib_index, thread_index)))
609 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_SESSIONS_EXCEEDED];
610 nat_elog_notice ("maximum sessions exceeded");
614 init_nat_k (&kv, ip->dst_address, 0, 0, 0);
615 if (clib_bihash_search_8_8
616 (&sm->static_mapping_by_external, &kv, &value))
618 b->error = node->errors[NAT_OUT2IN_ED_ERROR_NO_TRANSLATION];
622 m = pool_elt_at_index (sm->static_mappings, value.value);
624 new_addr = ip->dst_address.as_u32 = m->local_addr.as_u32;
626 /* Create a new session */
627 s = nat_ed_session_alloc (sm, thread_index, now, ip->protocol);
630 b->error = node->errors[NAT_OUT2IN_ED_ERROR_MAX_USER_SESS_EXCEEDED];
631 nat_elog_warn ("create NAT session failed");
635 s->ext_host_addr.as_u32 = ip->src_address.as_u32;
636 s->flags |= SNAT_SESSION_FLAG_UNKNOWN_PROTO;
637 s->flags |= SNAT_SESSION_FLAG_STATIC_MAPPING;
638 s->flags |= SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT;
639 s->out2in.addr.as_u32 = old_addr;
640 s->out2in.fib_index = rx_fib_index;
641 s->in2out.addr.as_u32 = new_addr;
642 s->in2out.fib_index = m->fib_index;
643 s->in2out.port = s->out2in.port = ip->protocol;
645 /* Add to lookup tables */
646 s_kv.value = s - tsm->sessions;
647 if (clib_bihash_add_del_16_8 (&sm->out2in_ed, &s_kv, 1))
648 nat_elog_notice ("out2in key add failed");
650 init_ed_kv (&s_kv, ip->dst_address, 0, ip->src_address, 0, m->fib_index,
651 ip->protocol, thread_index, s - tsm->sessions);
652 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &s_kv, 1))
653 nat_elog_notice ("in2out key add failed");
656 /* Update IP checksum */
658 sum = ip_csum_update (sum, old_addr, new_addr, ip4_header_t, dst_address);
659 ip->checksum = ip_csum_fold (sum);
661 vnet_buffer (b)->sw_if_index[VLIB_TX] = s->in2out.fib_index;
664 nat44_session_update_counters (s, now, vlib_buffer_length_in_chain (vm, b),
666 /* Per-user LRU list maintenance */
667 nat44_session_update_lru (sm, s, thread_index);
673 nat44_ed_out2in_fast_path_node_fn_inline (vlib_main_t * vm,
674 vlib_node_runtime_t * node,
675 vlib_frame_t * frame,
678 u32 n_left_from, *from, *to_next, pkts_processed = 0, stats_node_index;
679 nat_next_t next_index;
680 snat_main_t *sm = &snat_main;
681 f64 now = vlib_time_now (vm);
682 u32 thread_index = vm->thread_index;
683 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
684 u32 tcp_packets = 0, udp_packets = 0, icmp_packets = 0, other_packets =
687 stats_node_index = sm->ed_out2in_node_index;
689 from = vlib_frame_vector_args (frame);
690 n_left_from = frame->n_vectors;
691 next_index = node->cached_next_index;
693 while (n_left_from > 0)
697 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
699 while (n_left_from > 0 && n_left_to_next > 0)
703 u32 next0, sw_if_index0, rx_fib_index0, proto0, old_addr0,
705 u16 old_port0, new_port0;
709 snat_session_t *s0 = 0;
710 clib_bihash_kv_16_8_t kv0, value0;
713 /* speculatively enqueue b0 to the current next frame */
721 b0 = vlib_get_buffer (vm, bi0);
722 next0 = vnet_buffer2 (b0)->nat.arc_next;
724 vnet_buffer (b0)->snat.flags = 0;
725 ip0 = vlib_buffer_get_current (b0);
727 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
729 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
732 if (PREDICT_FALSE (ip0->ttl == 1))
734 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
735 icmp4_error_set_vnet_buffer (b0, ICMP4_time_exceeded,
736 ICMP4_time_exceeded_ttl_exceeded_in_transit,
738 next0 = NAT_NEXT_ICMP_ERROR;
742 udp0 = ip4_next_header (ip0);
743 tcp0 = (tcp_header_t *) udp0;
744 proto0 = ip_proto_to_nat_proto (ip0->protocol);
746 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_OTHER))
748 next0 = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
752 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_ICMP))
754 next0 = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
758 init_ed_k (&kv0, ip0->dst_address,
759 vnet_buffer (b0)->ip.reass.l4_dst_port, ip0->src_address,
760 vnet_buffer (b0)->ip.reass.l4_src_port, rx_fib_index0,
763 /* there is a stashed index in vnet_buffer2 from handoff node,
764 * see if we can use it */
765 if (is_multi_worker && PREDICT_TRUE
768 vnet_buffer2 (b0)->nat.ed_out2in_nat_session_index)))
770 s0 = pool_elt_at_index (tsm->sessions,
772 nat.ed_out2in_nat_session_index);
774 (s0->out2in.addr.as_u32 == ip0->dst_address.as_u32
775 && s0->out2in.port ==
776 vnet_buffer (b0)->ip.reass.l4_dst_port
777 && s0->nat_proto == ip_proto_to_nat_proto (ip0->protocol)
778 && s0->out2in.fib_index == rx_fib_index0
779 && s0->ext_host_addr.as_u32 == ip0->src_address.as_u32
780 && s0->ext_host_port ==
781 vnet_buffer (b0)->ip.reass.l4_src_port))
783 /* yes, this is the droid we're looking for */
788 if (clib_bihash_search_16_8 (&sm->out2in_ed, &kv0, &value0))
790 next0 = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
793 ASSERT (thread_index == ed_value_get_thread_index (&value0));
795 pool_elt_at_index (tsm->sessions,
796 ed_value_get_session_index (&value0));
799 if (s0->tcp_closed_timestamp)
801 if (now >= s0->tcp_closed_timestamp)
803 // session is closed, go slow path
804 next0 = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
808 // session in transitory timeout, drop
809 b0->error = node->errors[NAT_OUT2IN_ED_ERROR_TCP_CLOSED];
810 next0 = NAT_NEXT_DROP;
815 // drop if session expired
816 u64 sess_timeout_time;
817 sess_timeout_time = s0->last_heard +
818 (f64) nat44_session_get_timeout (sm, s0);
819 if (now >= sess_timeout_time)
821 // session is closed, go slow path
822 nat_free_session_data (sm, s0, thread_index, 0);
823 nat_ed_session_delete (sm, s0, thread_index, 1);
824 next0 = NAT_NEXT_OUT2IN_ED_SLOW_PATH;
829 old_addr0 = ip0->dst_address.as_u32;
830 new_addr0 = ip0->dst_address.as_u32 = s0->in2out.addr.as_u32;
831 vnet_buffer (b0)->sw_if_index[VLIB_TX] = s0->in2out.fib_index;
833 sum0 = ip0->checksum;
834 sum0 = ip_csum_update (sum0, old_addr0, new_addr0, ip4_header_t,
836 if (PREDICT_FALSE (is_twice_nat_session (s0)))
837 sum0 = ip_csum_update (sum0, ip0->src_address.as_u32,
838 s0->ext_host_nat_addr.as_u32, ip4_header_t,
840 ip0->checksum = ip_csum_fold (sum0);
842 old_port0 = vnet_buffer (b0)->ip.reass.l4_dst_port;
844 if (PREDICT_TRUE (proto0 == NAT_PROTOCOL_TCP))
846 if (!vnet_buffer (b0)->ip.reass.is_non_first_fragment)
848 new_port0 = udp0->dst_port = s0->in2out.port;
849 sum0 = tcp0->checksum;
851 ip_csum_update (sum0, old_addr0, new_addr0, ip4_header_t,
854 ip_csum_update (sum0, old_port0, new_port0, ip4_header_t,
856 if (is_twice_nat_session (s0))
858 sum0 = ip_csum_update (sum0, ip0->src_address.as_u32,
859 s0->ext_host_nat_addr.as_u32,
860 ip4_header_t, dst_address);
862 ip_csum_update (sum0,
863 vnet_buffer (b0)->ip.
865 s0->ext_host_nat_port, ip4_header_t,
867 tcp0->src_port = s0->ext_host_nat_port;
868 ip0->src_address.as_u32 = s0->ext_host_nat_addr.as_u32;
870 tcp0->checksum = ip_csum_fold (sum0);
873 if (nat44_set_tcp_session_state_o2i
875 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags,
876 vnet_buffer (b0)->ip.reass.tcp_ack_number,
877 vnet_buffer (b0)->ip.reass.tcp_seq_number, thread_index))
880 else if (!vnet_buffer (b0)->ip.reass.is_non_first_fragment
883 new_port0 = udp0->dst_port = s0->in2out.port;
884 sum0 = udp0->checksum;
885 sum0 = ip_csum_update (sum0, old_addr0, new_addr0, ip4_header_t,
887 sum0 = ip_csum_update (sum0, old_port0, new_port0, ip4_header_t,
889 if (PREDICT_FALSE (is_twice_nat_session (s0)))
891 sum0 = ip_csum_update (sum0, ip0->src_address.as_u32,
892 s0->ext_host_nat_addr.as_u32,
893 ip4_header_t, dst_address);
895 ip_csum_update (sum0,
896 vnet_buffer (b0)->ip.reass.l4_src_port,
897 s0->ext_host_nat_port, ip4_header_t,
899 udp0->src_port = s0->ext_host_nat_port;
900 ip0->src_address.as_u32 = s0->ext_host_nat_addr.as_u32;
902 udp0->checksum = ip_csum_fold (sum0);
907 if (!vnet_buffer (b0)->ip.reass.is_non_first_fragment)
909 new_port0 = udp0->dst_port = s0->in2out.port;
910 if (PREDICT_FALSE (is_twice_nat_session (s0)))
912 udp0->src_port = s0->ext_host_nat_port;
913 ip0->src_address.as_u32 = s0->ext_host_nat_addr.as_u32;
920 nat44_session_update_counters (s0, now,
921 vlib_buffer_length_in_chain (vm, b0),
923 /* Per-user LRU list maintenance */
924 nat44_session_update_lru (sm, s0, thread_index);
927 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
928 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
930 nat44_ed_out2in_trace_t *t =
931 vlib_add_trace (vm, node, b0, sizeof (*t));
932 t->sw_if_index = sw_if_index0;
933 t->next_index = next0;
937 t->session_index = s0 - tsm->sessions;
939 t->session_index = ~0;
942 pkts_processed += next0 == vnet_buffer2 (b0)->nat.arc_next;
943 /* verify speculative enqueue, maybe switch current next frame */
944 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
945 to_next, n_left_to_next,
949 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
952 vlib_node_increment_counter (vm, stats_node_index,
953 NAT_OUT2IN_ED_ERROR_OUT2IN_PACKETS,
955 vlib_node_increment_counter (vm, stats_node_index,
956 NAT_OUT2IN_ED_ERROR_TCP_PACKETS, tcp_packets);
957 vlib_node_increment_counter (vm, stats_node_index,
958 NAT_OUT2IN_ED_ERROR_UDP_PACKETS, udp_packets);
959 vlib_node_increment_counter (vm, stats_node_index,
960 NAT_OUT2IN_ED_ERROR_ICMP_PACKETS,
962 vlib_node_increment_counter (vm, stats_node_index,
963 NAT_OUT2IN_ED_ERROR_OTHER_PACKETS,
965 vlib_node_increment_counter (vm, stats_node_index,
966 NAT_OUT2IN_ED_ERROR_FRAGMENTS, fragments);
967 return frame->n_vectors;
971 nat44_ed_out2in_slow_path_node_fn_inline (vlib_main_t * vm,
972 vlib_node_runtime_t * node,
973 vlib_frame_t * frame)
975 u32 n_left_from, *from, *to_next, pkts_processed = 0, stats_node_index;
976 nat_next_t next_index;
977 snat_main_t *sm = &snat_main;
978 f64 now = vlib_time_now (vm);
979 u32 thread_index = vm->thread_index;
980 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
981 u32 tcp_packets = 0, udp_packets = 0, icmp_packets = 0, other_packets =
984 stats_node_index = sm->ed_out2in_slowpath_node_index;
986 from = vlib_frame_vector_args (frame);
987 n_left_from = frame->n_vectors;
988 next_index = node->cached_next_index;
990 while (n_left_from > 0)
994 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
996 while (n_left_from > 0 && n_left_to_next > 0)
1000 u32 next0, sw_if_index0, rx_fib_index0, proto0, old_addr0,
1002 u16 old_port0, new_port0;
1006 icmp46_header_t *icmp0;
1007 snat_session_t *s0 = 0;
1008 clib_bihash_kv_16_8_t kv0, value0;
1010 lb_nat_type_t lb_nat0;
1011 twice_nat_type_t twice_nat0;
1013 ip4_address_t sm_addr;
1017 /* speculatively enqueue b0 to the current next frame */
1023 n_left_to_next -= 1;
1025 b0 = vlib_get_buffer (vm, bi0);
1026 next0 = vnet_buffer2 (b0)->nat.arc_next;
1028 vnet_buffer (b0)->snat.flags = 0;
1029 ip0 = vlib_buffer_get_current (b0);
1031 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
1033 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1036 if (PREDICT_FALSE (ip0->ttl == 1))
1038 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1039 icmp4_error_set_vnet_buffer (b0, ICMP4_time_exceeded,
1040 ICMP4_time_exceeded_ttl_exceeded_in_transit,
1042 next0 = NAT_NEXT_ICMP_ERROR;
1046 udp0 = ip4_next_header (ip0);
1047 tcp0 = (tcp_header_t *) udp0;
1048 icmp0 = (icmp46_header_t *) udp0;
1049 proto0 = ip_proto_to_nat_proto (ip0->protocol);
1051 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_OTHER))
1054 nat44_ed_out2in_unknown_proto (sm, b0, ip0, rx_fib_index0,
1055 thread_index, now, vm, node);
1056 if (!sm->forwarding_enabled)
1059 next0 = NAT_NEXT_DROP;
1065 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_ICMP))
1067 next0 = icmp_out2in_ed_slow_path
1068 (sm, b0, ip0, icmp0, sw_if_index0, rx_fib_index0, node,
1069 next0, now, thread_index, &s0);
1074 init_ed_k (&kv0, ip0->dst_address,
1075 vnet_buffer (b0)->ip.reass.l4_dst_port, ip0->src_address,
1076 vnet_buffer (b0)->ip.reass.l4_src_port, rx_fib_index0,
1080 if (!clib_bihash_search_16_8 (&sm->out2in_ed, &kv0, &value0))
1082 ASSERT (thread_index == ed_value_get_thread_index (&value0));
1084 pool_elt_at_index (tsm->sessions,
1085 ed_value_get_session_index (&value0));
1087 if (s0->tcp_closed_timestamp && now >= s0->tcp_closed_timestamp)
1089 nat_free_session_data (sm, s0, thread_index, 0);
1090 nat_ed_session_delete (sm, s0, thread_index, 1);
1097 /* Try to match static mapping by external address and port,
1098 destination address and port in packet */
1100 if (snat_static_mapping_match
1101 (sm, ip0->dst_address,
1102 vnet_buffer (b0)->ip.reass.l4_dst_port, rx_fib_index0,
1103 proto0, &sm_addr, &sm_port, &sm_fib_index, 1, 0,
1104 &twice_nat0, &lb_nat0, &ip0->src_address, &identity_nat0))
1107 * Send DHCP packets to the ipv4 stack, or we won't
1108 * be able to use dhcp client on the outside interface
1110 if (PREDICT_FALSE (proto0 == NAT_PROTOCOL_UDP
1111 && (vnet_buffer (b0)->ip.
1112 reass.l4_dst_port ==
1113 clib_host_to_net_u16
1114 (UDP_DST_PORT_dhcp_to_client))))
1119 if (!sm->forwarding_enabled)
1122 node->errors[NAT_OUT2IN_ED_ERROR_NO_TRANSLATION];
1123 next0 = NAT_NEXT_DROP;
1128 (sm, ip0, vnet_buffer (b0)->ip.reass.l4_src_port,
1129 vnet_buffer (b0)->ip.reass.l4_dst_port,
1130 thread_index, rx_fib_index0))
1132 next0 = NAT_NEXT_IN2OUT_ED_FAST_PATH;
1135 if (sm->num_workers > 1)
1136 create_bypass_for_fwd_worker (sm, b0, ip0,
1139 create_bypass_for_fwd (sm, b0, ip0, rx_fib_index0,
1145 if (PREDICT_FALSE (identity_nat0))
1148 if ((proto0 == NAT_PROTOCOL_TCP)
1149 && !tcp_flags_is_init (vnet_buffer (b0)->ip.
1150 reass.icmp_type_or_tcp_flags))
1152 b0->error = node->errors[NAT_OUT2IN_ED_ERROR_NON_SYN];
1153 next0 = NAT_NEXT_DROP;
1157 /* Create session initiated by host from external network */
1158 s0 = create_session_for_static_mapping_ed (sm, b0,
1163 ip.reass.l4_dst_port,
1168 twice_nat0, lb_nat0,
1172 next0 = NAT_NEXT_DROP;
1177 old_addr0 = ip0->dst_address.as_u32;
1178 new_addr0 = ip0->dst_address.as_u32 = s0->in2out.addr.as_u32;
1179 vnet_buffer (b0)->sw_if_index[VLIB_TX] = s0->in2out.fib_index;
1181 sum0 = ip0->checksum;
1182 sum0 = ip_csum_update (sum0, old_addr0, new_addr0, ip4_header_t,
1184 if (PREDICT_FALSE (is_twice_nat_session (s0)))
1185 sum0 = ip_csum_update (sum0, ip0->src_address.as_u32,
1186 s0->ext_host_nat_addr.as_u32, ip4_header_t,
1188 ip0->checksum = ip_csum_fold (sum0);
1190 old_port0 = vnet_buffer (b0)->ip.reass.l4_dst_port;
1192 if (PREDICT_TRUE (proto0 == NAT_PROTOCOL_TCP))
1194 if (!vnet_buffer (b0)->ip.reass.is_non_first_fragment)
1196 new_port0 = udp0->dst_port = s0->in2out.port;
1197 sum0 = tcp0->checksum;
1199 ip_csum_update (sum0, old_addr0, new_addr0, ip4_header_t,
1202 ip_csum_update (sum0, old_port0, new_port0, ip4_header_t,
1204 if (is_twice_nat_session (s0))
1206 sum0 = ip_csum_update (sum0, ip0->src_address.as_u32,
1207 s0->ext_host_nat_addr.as_u32,
1208 ip4_header_t, dst_address);
1210 ip_csum_update (sum0,
1211 vnet_buffer (b0)->ip.
1213 s0->ext_host_nat_port, ip4_header_t,
1215 tcp0->src_port = s0->ext_host_nat_port;
1216 ip0->src_address.as_u32 = s0->ext_host_nat_addr.as_u32;
1218 tcp0->checksum = ip_csum_fold (sum0);
1221 if (nat44_set_tcp_session_state_o2i
1223 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags,
1224 vnet_buffer (b0)->ip.reass.tcp_ack_number,
1225 vnet_buffer (b0)->ip.reass.tcp_seq_number, thread_index))
1228 else if (!vnet_buffer (b0)->ip.reass.is_non_first_fragment
1231 new_port0 = udp0->dst_port = s0->in2out.port;
1232 sum0 = udp0->checksum;
1233 sum0 = ip_csum_update (sum0, old_addr0, new_addr0, ip4_header_t,
1235 sum0 = ip_csum_update (sum0, old_port0, new_port0, ip4_header_t,
1237 if (PREDICT_FALSE (is_twice_nat_session (s0)))
1239 sum0 = ip_csum_update (sum0, ip0->src_address.as_u32,
1240 s0->ext_host_nat_addr.as_u32,
1241 ip4_header_t, dst_address);
1243 ip_csum_update (sum0,
1244 vnet_buffer (b0)->ip.reass.l4_src_port,
1245 s0->ext_host_nat_port, ip4_header_t,
1247 udp0->src_port = s0->ext_host_nat_port;
1248 ip0->src_address.as_u32 = s0->ext_host_nat_addr.as_u32;
1250 udp0->checksum = ip_csum_fold (sum0);
1255 if (!vnet_buffer (b0)->ip.reass.is_non_first_fragment)
1257 new_port0 = udp0->dst_port = s0->in2out.port;
1258 if (PREDICT_FALSE (is_twice_nat_session (s0)))
1260 udp0->src_port = s0->ext_host_nat_port;
1261 ip0->src_address.as_u32 = s0->ext_host_nat_addr.as_u32;
1268 nat44_session_update_counters (s0, now,
1269 vlib_buffer_length_in_chain (vm, b0),
1271 /* Per-user LRU list maintenance */
1272 nat44_session_update_lru (sm, s0, thread_index);
1275 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
1276 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
1278 nat44_ed_out2in_trace_t *t =
1279 vlib_add_trace (vm, node, b0, sizeof (*t));
1280 t->sw_if_index = sw_if_index0;
1281 t->next_index = next0;
1282 t->is_slow_path = 1;
1285 t->session_index = s0 - tsm->sessions;
1287 t->session_index = ~0;
1290 pkts_processed += next0 == vnet_buffer2 (b0)->nat.arc_next;
1291 /* verify speculative enqueue, maybe switch current next frame */
1292 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1293 to_next, n_left_to_next,
1297 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1300 vlib_node_increment_counter (vm, stats_node_index,
1301 NAT_OUT2IN_ED_ERROR_OUT2IN_PACKETS,
1303 vlib_node_increment_counter (vm, stats_node_index,
1304 NAT_OUT2IN_ED_ERROR_TCP_PACKETS, tcp_packets);
1305 vlib_node_increment_counter (vm, stats_node_index,
1306 NAT_OUT2IN_ED_ERROR_UDP_PACKETS, udp_packets);
1307 vlib_node_increment_counter (vm, stats_node_index,
1308 NAT_OUT2IN_ED_ERROR_ICMP_PACKETS,
1310 vlib_node_increment_counter (vm, stats_node_index,
1311 NAT_OUT2IN_ED_ERROR_OTHER_PACKETS,
1313 vlib_node_increment_counter (vm, stats_node_index,
1314 NAT_OUT2IN_ED_ERROR_FRAGMENTS, fragments);
1315 return frame->n_vectors;
1318 VLIB_NODE_FN (nat44_ed_out2in_node) (vlib_main_t * vm,
1319 vlib_node_runtime_t * node,
1320 vlib_frame_t * frame)
1322 if (snat_main.num_workers > 1)
1324 return nat44_ed_out2in_fast_path_node_fn_inline (vm, node, frame, 1);
1328 return nat44_ed_out2in_fast_path_node_fn_inline (vm, node, frame, 0);
1333 VLIB_REGISTER_NODE (nat44_ed_out2in_node) = {
1334 .name = "nat44-ed-out2in",
1335 .vector_size = sizeof (u32),
1336 .sibling_of = "nat-default",
1337 .format_trace = format_nat44_ed_out2in_trace,
1338 .type = VLIB_NODE_TYPE_INTERNAL,
1339 .n_errors = ARRAY_LEN(nat_out2in_ed_error_strings),
1340 .error_strings = nat_out2in_ed_error_strings,
1341 .runtime_data_bytes = sizeof (snat_runtime_t),
1345 VLIB_NODE_FN (nat44_ed_out2in_slowpath_node) (vlib_main_t * vm,
1346 vlib_node_runtime_t * node,
1347 vlib_frame_t * frame)
1349 return nat44_ed_out2in_slow_path_node_fn_inline (vm, node, frame);
1353 VLIB_REGISTER_NODE (nat44_ed_out2in_slowpath_node) = {
1354 .name = "nat44-ed-out2in-slowpath",
1355 .vector_size = sizeof (u32),
1356 .sibling_of = "nat-default",
1357 .format_trace = format_nat44_ed_out2in_trace,
1358 .type = VLIB_NODE_TYPE_INTERNAL,
1359 .n_errors = ARRAY_LEN(nat_out2in_ed_error_strings),
1360 .error_strings = nat_out2in_ed_error_strings,
1361 .runtime_data_bytes = sizeof (snat_runtime_t),
1366 format_nat_pre_trace (u8 * s, va_list * args)
1368 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1369 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1370 nat_pre_trace_t *t = va_arg (*args, nat_pre_trace_t *);
1371 return format (s, "out2in next_index %d arc_next_index %d", t->next_index,
1375 VLIB_NODE_FN (nat_pre_out2in_node) (vlib_main_t * vm,
1376 vlib_node_runtime_t * node,
1377 vlib_frame_t * frame)
1379 return nat_pre_node_fn_inline (vm, node, frame,
1380 NAT_NEXT_OUT2IN_ED_FAST_PATH);
1384 VLIB_REGISTER_NODE (nat_pre_out2in_node) = {
1385 .name = "nat-pre-out2in",
1386 .vector_size = sizeof (u32),
1387 .sibling_of = "nat-default",
1388 .format_trace = format_nat_pre_trace,
1389 .type = VLIB_NODE_TYPE_INTERNAL,
1395 * fd.io coding-style-patch-verification: ON
1398 * eval: (c-set-style "gnu")