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.
16 * @brief The NAT inline functions
19 #ifndef __included_nat_inlines_h__
20 #define __included_nat_inlines_h__
22 #include <vnet/fib/ip4_fib.h>
24 #include <nat/nat_ha.h>
27 nat_pre_node_fn_inline (vlib_main_t * vm,
28 vlib_node_runtime_t * node,
29 vlib_frame_t * frame, u32 def_next)
31 u32 n_left_from, *from, *to_next;
34 from = vlib_frame_vector_args (frame);
35 n_left_from = frame->n_vectors;
36 next_index = node->cached_next_index;
38 while (n_left_from > 0)
42 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
44 while (n_left_from >= 4 && n_left_to_next >= 2)
47 u32 arc_next0, arc_next1;
49 vlib_buffer_t *b0, *b1;
51 /* Prefetch next iteration. */
53 vlib_buffer_t *p2, *p3;
55 p2 = vlib_get_buffer (vm, from[2]);
56 p3 = vlib_get_buffer (vm, from[3]);
58 vlib_prefetch_buffer_header (p2, LOAD);
59 vlib_prefetch_buffer_header (p3, LOAD);
61 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
62 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
65 /* speculatively enqueue b0 and b1 to the current next frame */
66 to_next[0] = bi0 = from[0];
67 to_next[1] = bi1 = from[1];
73 b0 = vlib_get_buffer (vm, bi0);
74 b1 = vlib_get_buffer (vm, bi1);
79 vnet_feature_next (&arc_next0, b0);
80 vnet_feature_next (&arc_next1, b1);
82 nat_buffer_opaque (b0)->arc_next = arc_next0;
83 nat_buffer_opaque (b1)->arc_next = arc_next1;
85 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
87 if (b0->flags & VLIB_BUFFER_IS_TRACED)
90 vlib_add_trace (vm, node, b0, sizeof (*t));
91 t->next_index = next0;
93 if (b1->flags & VLIB_BUFFER_IS_TRACED)
96 vlib_add_trace (vm, node, b0, sizeof (*t));
97 t->next_index = next0;
101 /* verify speculative enqueues, maybe switch current next frame */
102 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
103 to_next, n_left_to_next,
104 bi0, bi1, next0, next1);
107 while (n_left_from > 0 && n_left_to_next > 0)
114 /* speculatively enqueue b0 to the current next frame */
122 b0 = vlib_get_buffer (vm, bi0);
124 vnet_feature_next (&arc_next0, b0);
125 nat_buffer_opaque (b0)->arc_next = arc_next0;
127 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
128 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
130 nat_pre_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
131 t->next_index = next0;
134 /* verify speculative enqueue, maybe switch current next frame */
135 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
136 to_next, n_left_to_next,
140 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
143 return frame->n_vectors;
147 ip_proto_to_snat_proto (u8 ip_proto)
151 snat_proto = (ip_proto == IP_PROTOCOL_UDP) ? SNAT_PROTOCOL_UDP : snat_proto;
152 snat_proto = (ip_proto == IP_PROTOCOL_TCP) ? SNAT_PROTOCOL_TCP : snat_proto;
154 (ip_proto == IP_PROTOCOL_ICMP) ? SNAT_PROTOCOL_ICMP : snat_proto;
156 (ip_proto == IP_PROTOCOL_ICMP6) ? SNAT_PROTOCOL_ICMP : snat_proto;
162 snat_proto_to_ip_proto (snat_protocol_t snat_proto)
166 ip_proto = (snat_proto == SNAT_PROTOCOL_UDP) ? IP_PROTOCOL_UDP : ip_proto;
167 ip_proto = (snat_proto == SNAT_PROTOCOL_TCP) ? IP_PROTOCOL_TCP : ip_proto;
168 ip_proto = (snat_proto == SNAT_PROTOCOL_ICMP) ? IP_PROTOCOL_ICMP : ip_proto;
173 static_always_inline u8
174 icmp_type_is_error_message (u8 icmp_type)
178 case ICMP4_destination_unreachable:
179 case ICMP4_time_exceeded:
180 case ICMP4_parameter_problem:
181 case ICMP4_source_quench:
183 case ICMP4_alternate_host_address:
190 is_interface_addr (snat_main_t * sm, vlib_node_runtime_t * node,
191 u32 sw_if_index0, u32 ip4_addr)
193 snat_runtime_t *rt = (snat_runtime_t *) node->runtime_data;
194 ip4_address_t *first_int_addr;
196 if (PREDICT_FALSE (rt->cached_sw_if_index != sw_if_index0))
199 ip4_interface_first_address (sm->ip4_main, sw_if_index0,
200 0 /* just want the address */ );
201 rt->cached_sw_if_index = sw_if_index0;
203 rt->cached_ip4_address = first_int_addr->as_u32;
205 rt->cached_ip4_address = 0;
208 if (PREDICT_FALSE (ip4_addr == rt->cached_ip4_address))
215 maximum_sessions_exceeded (snat_main_t * sm, u32 thread_index)
217 if (pool_elts (sm->per_thread_data[thread_index].sessions) >=
218 sm->max_translations)
225 nat_send_all_to_node (vlib_main_t * vm, u32 * bi_vector,
226 vlib_node_runtime_t * node, vlib_error_t * error,
229 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
232 n_left_from = vec_len (bi_vector);
233 next_index = node->cached_next_index;
234 while (n_left_from > 0)
236 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
237 while (n_left_from > 0 && n_left_to_next > 0)
239 u32 bi0 = to_next[0] = from[0];
244 vlib_buffer_t *p0 = vlib_get_buffer (vm, bi0);
247 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
248 n_left_to_next, bi0, next);
250 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
255 user_session_increment (snat_main_t * sm, snat_user_t * u, u8 is_static)
257 if (u->nsessions + u->nstaticsessions < sm->max_translations_per_user)
260 u->nstaticsessions++;
267 nat44_delete_user_with_no_session (snat_main_t * sm, snat_user_t * u,
270 clib_bihash_kv_8_8_t kv;
271 snat_user_key_t u_key;
272 snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
275 if (u->nstaticsessions == 0 && u->nsessions == 0)
277 u_key.addr.as_u32 = u->addr.as_u32;
278 u_key.fib_index = u->fib_index;
279 kv.key = u_key.as_u64;
280 pool_put_index (tsm->list_pool, u->sessions_per_user_list_head_index);
281 pool_put (tsm->users, u);
282 clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
283 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
284 pool_elts (tsm->users));
289 nat44_delete_session (snat_main_t * sm, snat_session_t * ses,
292 snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
294 clib_bihash_kv_8_8_t kv, value;
296 const snat_user_key_t u_key = {
297 .addr = ses->in2out.addr,
298 .fib_index = ses->in2out.fib_index
300 const u8 u_static = snat_is_session_static (ses);
302 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
303 pool_put_index (tsm->list_pool, ses->per_user_index);
304 pool_put (tsm->sessions, ses);
305 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
306 pool_elts (tsm->sessions));
308 kv.key = u_key.as_u64;
309 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
311 u = pool_elt_at_index (tsm->users, value.value);
313 u->nstaticsessions--;
317 nat44_delete_user_with_no_session (sm, u, thread_index);
321 /** \brief Set TCP session state.
322 @return 1 if session was closed, otherwise 0
325 nat44_set_tcp_session_state_i2o (snat_main_t * sm, f64 now,
326 snat_session_t * ses, vlib_buffer_t * b,
329 u8 tcp_flags = vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags;
330 u32 tcp_ack_number = vnet_buffer (b)->ip.reass.tcp_ack_number;
331 u32 tcp_seq_number = vnet_buffer (b)->ip.reass.tcp_seq_number;
332 if ((ses->state == 0) && (tcp_flags & TCP_FLAG_RST))
333 ses->state = NAT44_SES_RST;
334 if ((ses->state == NAT44_SES_RST) && !(tcp_flags & TCP_FLAG_RST))
336 if ((tcp_flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
337 (ses->state & NAT44_SES_O2I_SYN))
339 if (tcp_flags & TCP_FLAG_SYN)
340 ses->state |= NAT44_SES_I2O_SYN;
341 if (tcp_flags & TCP_FLAG_FIN)
343 ses->i2o_fin_seq = clib_net_to_host_u32 (tcp_seq_number);
344 ses->state |= NAT44_SES_I2O_FIN;
346 if ((tcp_flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_O2I_FIN))
348 if (clib_net_to_host_u32 (tcp_ack_number) > ses->o2i_fin_seq)
350 ses->state |= NAT44_SES_O2I_FIN_ACK;
351 if (nat44_is_ses_closed (ses))
352 { // if session is now closed, save the timestamp
353 ses->tcp_close_timestamp = now + sm->tcp_transitory_timeout;
361 nat44_set_tcp_session_state_o2i (snat_main_t * sm, f64 now,
362 snat_session_t * ses, u8 tcp_flags,
363 u32 tcp_ack_number, u32 tcp_seq_number,
366 if ((ses->state == 0) && (tcp_flags & TCP_FLAG_RST))
367 ses->state = NAT44_SES_RST;
368 if ((ses->state == NAT44_SES_RST) && !(tcp_flags & TCP_FLAG_RST))
370 if ((tcp_flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
371 (ses->state & NAT44_SES_O2I_SYN))
373 if (tcp_flags & TCP_FLAG_SYN)
374 ses->state |= NAT44_SES_O2I_SYN;
375 if (tcp_flags & TCP_FLAG_FIN)
377 ses->o2i_fin_seq = clib_net_to_host_u32 (tcp_seq_number);
378 ses->state |= NAT44_SES_O2I_FIN;
380 if ((tcp_flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_FIN))
382 if (clib_net_to_host_u32 (tcp_ack_number) > ses->i2o_fin_seq)
383 ses->state |= NAT44_SES_I2O_FIN_ACK;
384 if (nat44_is_ses_closed (ses))
385 { // if session is now closed, save the timestamp
386 ses->tcp_close_timestamp = now + sm->tcp_transitory_timeout;
393 nat44_session_get_timeout (snat_main_t * sm, snat_session_t * s)
395 switch (s->in2out.protocol)
397 case SNAT_PROTOCOL_ICMP:
398 return sm->icmp_timeout;
399 case SNAT_PROTOCOL_UDP:
400 return sm->udp_timeout;
401 case SNAT_PROTOCOL_TCP:
404 return sm->tcp_transitory_timeout;
406 return sm->tcp_established_timeout;
409 return sm->udp_timeout;
416 nat44_session_update_counters (snat_session_t * s, f64 now, uword bytes,
421 s->total_bytes += bytes;
422 nat_ha_sref (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
423 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
424 s->total_pkts, s->total_bytes, thread_index,
425 &s->ha_last_refreshed, now);
428 /** \brief Per-user LRU list maintenance */
430 nat44_session_update_lru (snat_main_t * sm, snat_session_t * s,
433 clib_dlist_remove (sm->per_thread_data[thread_index].list_pool,
435 clib_dlist_addtail (sm->per_thread_data[thread_index].list_pool,
436 s->per_user_list_head_index, s->per_user_index);
440 make_ed_kv (clib_bihash_kv_16_8_t * kv, ip4_address_t * l_addr,
441 ip4_address_t * r_addr, u8 proto, u32 fib_index, u16 l_port,
444 nat_ed_ses_key_t *key = (nat_ed_ses_key_t *) kv->key;
446 key->l_addr.as_u32 = l_addr->as_u32;
447 key->r_addr.as_u32 = r_addr->as_u32;
448 key->fib_index = fib_index;
450 key->l_port = l_port;
451 key->r_port = r_port;
457 make_sm_kv (clib_bihash_kv_8_8_t * kv, ip4_address_t * addr, u8 proto,
458 u32 fib_index, u16 port)
460 snat_session_key_t key;
462 key.addr.as_u32 = addr->as_u32;
464 key.protocol = proto;
465 key.fib_index = fib_index;
467 kv->key = key.as_u64;
471 static_always_inline int
472 get_icmp_i2o_ed_key (vlib_buffer_t * b, ip4_header_t * ip0,
473 nat_ed_ses_key_t * p_key0)
475 icmp46_header_t *icmp0;
476 nat_ed_ses_key_t key0;
477 icmp_echo_header_t *echo0, *inner_echo0 = 0;
478 ip4_header_t *inner_ip0 = 0;
480 icmp46_header_t *inner_icmp0;
482 icmp0 = (icmp46_header_t *) ip4_next_header (ip0);
483 echo0 = (icmp_echo_header_t *) (icmp0 + 1);
485 if (!icmp_type_is_error_message
486 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
488 key0.proto = IP_PROTOCOL_ICMP;
489 key0.l_addr = ip0->src_address;
490 key0.r_addr = ip0->dst_address;
491 key0.l_port = vnet_buffer (b)->ip.reass.l4_src_port; // TODO should this be src or dst?
496 inner_ip0 = (ip4_header_t *) (echo0 + 1);
497 l4_header = ip4_next_header (inner_ip0);
498 key0.proto = inner_ip0->protocol;
499 key0.r_addr = inner_ip0->src_address;
500 key0.l_addr = inner_ip0->dst_address;
501 switch (ip_proto_to_snat_proto (inner_ip0->protocol))
503 case SNAT_PROTOCOL_ICMP:
504 inner_icmp0 = (icmp46_header_t *) l4_header;
505 inner_echo0 = (icmp_echo_header_t *) (inner_icmp0 + 1);
507 key0.l_port = inner_echo0->identifier;
509 case SNAT_PROTOCOL_UDP:
510 case SNAT_PROTOCOL_TCP:
511 key0.l_port = ((tcp_udp_header_t *) l4_header)->dst_port;
512 key0.r_port = ((tcp_udp_header_t *) l4_header)->src_port;
515 return NAT_IN2OUT_ED_ERROR_UNSUPPORTED_PROTOCOL;
523 static_always_inline int
524 get_icmp_o2i_ed_key (vlib_buffer_t * b, ip4_header_t * ip0,
525 nat_ed_ses_key_t * p_key0)
527 icmp46_header_t *icmp0;
528 nat_ed_ses_key_t key0;
529 icmp_echo_header_t *echo0, *inner_echo0 = 0;
530 ip4_header_t *inner_ip0;
532 icmp46_header_t *inner_icmp0;
534 icmp0 = (icmp46_header_t *) ip4_next_header (ip0);
535 echo0 = (icmp_echo_header_t *) (icmp0 + 1);
537 if (!icmp_type_is_error_message
538 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
540 key0.proto = IP_PROTOCOL_ICMP;
541 key0.l_addr = ip0->dst_address;
542 key0.r_addr = ip0->src_address;
543 key0.l_port = vnet_buffer (b)->ip.reass.l4_src_port; // TODO should this be src or dst?
548 inner_ip0 = (ip4_header_t *) (echo0 + 1);
549 l4_header = ip4_next_header (inner_ip0);
550 key0.proto = inner_ip0->protocol;
551 key0.l_addr = inner_ip0->src_address;
552 key0.r_addr = inner_ip0->dst_address;
553 switch (ip_proto_to_snat_proto (inner_ip0->protocol))
555 case SNAT_PROTOCOL_ICMP:
556 inner_icmp0 = (icmp46_header_t *) l4_header;
557 inner_echo0 = (icmp_echo_header_t *) (inner_icmp0 + 1);
558 key0.l_port = inner_echo0->identifier;
561 case SNAT_PROTOCOL_UDP:
562 case SNAT_PROTOCOL_TCP:
563 key0.l_port = ((tcp_udp_header_t *) l4_header)->src_port;
564 key0.r_port = ((tcp_udp_header_t *) l4_header)->dst_port;
575 mss_clamping (snat_main_t * sm, tcp_header_t * tcp, ip_csum_t * sum)
578 u8 opt_len, opts_len, kind;
581 if (!(sm->mss_clamping && tcp_syn (tcp)))
584 opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
585 data = (u8 *) (tcp + 1);
586 for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
590 if (kind == TCP_OPTION_EOL)
592 else if (kind == TCP_OPTION_NOOP)
603 if (opt_len < 2 || opt_len > opts_len)
607 if (kind == TCP_OPTION_MSS)
609 mss = *(u16 *) (data + 2);
610 if (clib_net_to_host_u16 (mss) > sm->mss_clamping)
613 ip_csum_update (*sum, mss, sm->mss_value_net, ip4_header_t,
615 clib_memcpy_fast (data + 2, &sm->mss_value_net, 2);
623 * @brief Check if packet should be translated
625 * Packets aimed at outside interface and external address with active session
626 * should be translated.
629 * @param rt NAT runtime data
630 * @param sw_if_index0 index of the inside interface
631 * @param ip0 IPv4 header
632 * @param proto0 NAT protocol
633 * @param rx_fib_index0 RX FIB index
635 * @returns 0 if packet should be translated otherwise 1
638 snat_not_translate_fast (snat_main_t * sm, vlib_node_runtime_t * node,
639 u32 sw_if_index0, ip4_header_t * ip0, u32 proto0,
645 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
646 nat_outside_fib_t *outside_fib;
648 .fp_proto = FIB_PROTOCOL_IP4,
651 .ip4.as_u32 = ip0->dst_address.as_u32,
656 /* Don't NAT packet aimed at the intfc address */
657 if (PREDICT_FALSE (is_interface_addr (sm, node, sw_if_index0,
658 ip0->dst_address.as_u32)))
661 fei = fib_table_lookup (rx_fib_index0, &pfx);
662 if (FIB_NODE_INDEX_INVALID != fei)
664 u32 sw_if_index = fib_entry_get_resolving_interface (fei);
665 if (sw_if_index == ~0)
667 vec_foreach (outside_fib, sm->outside_fibs)
669 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
670 if (FIB_NODE_INDEX_INVALID != fei)
672 sw_if_index = fib_entry_get_resolving_interface (fei);
673 if (sw_if_index != ~0)
678 if (sw_if_index == ~0)
683 pool_foreach (i, sm->interfaces, ({
684 /* NAT packet aimed at outside interface */
685 if ((nat_interface_is_outside (i)) && (sw_if_index == i->sw_if_index))
695 increment_v4_address (ip4_address_t * a)
699 v = clib_net_to_host_u32 (a->as_u32) + 1;
700 a->as_u32 = clib_host_to_net_u32 (v);
703 #endif /* __included_nat_inlines_h__ */
706 * fd.io coding-style-patch-verification: ON
709 * eval: (c-set-style "gnu")