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 ip_proto_to_snat_proto (u8 ip_proto)
31 snat_proto = (ip_proto == IP_PROTOCOL_UDP) ? SNAT_PROTOCOL_UDP : snat_proto;
32 snat_proto = (ip_proto == IP_PROTOCOL_TCP) ? SNAT_PROTOCOL_TCP : snat_proto;
34 (ip_proto == IP_PROTOCOL_ICMP) ? SNAT_PROTOCOL_ICMP : snat_proto;
36 (ip_proto == IP_PROTOCOL_ICMP6) ? SNAT_PROTOCOL_ICMP : snat_proto;
42 snat_proto_to_ip_proto (snat_protocol_t snat_proto)
46 ip_proto = (snat_proto == SNAT_PROTOCOL_UDP) ? IP_PROTOCOL_UDP : ip_proto;
47 ip_proto = (snat_proto == SNAT_PROTOCOL_TCP) ? IP_PROTOCOL_TCP : ip_proto;
48 ip_proto = (snat_proto == SNAT_PROTOCOL_ICMP) ? IP_PROTOCOL_ICMP : ip_proto;
53 static_always_inline u8
54 icmp_is_error_message (icmp46_header_t * icmp)
58 case ICMP4_destination_unreachable:
59 case ICMP4_time_exceeded:
60 case ICMP4_parameter_problem:
61 case ICMP4_source_quench:
63 case ICMP4_alternate_host_address:
70 is_interface_addr (snat_main_t * sm, vlib_node_runtime_t * node,
71 u32 sw_if_index0, u32 ip4_addr)
73 snat_runtime_t *rt = (snat_runtime_t *) node->runtime_data;
74 ip4_address_t *first_int_addr;
76 if (PREDICT_FALSE (rt->cached_sw_if_index != sw_if_index0))
79 ip4_interface_first_address (sm->ip4_main, sw_if_index0,
80 0 /* just want the address */ );
81 rt->cached_sw_if_index = sw_if_index0;
83 rt->cached_ip4_address = first_int_addr->as_u32;
85 rt->cached_ip4_address = 0;
88 if (PREDICT_FALSE (ip4_addr == rt->cached_ip4_address))
95 maximum_sessions_exceeded (snat_main_t * sm, u32 thread_index)
97 if (pool_elts (sm->per_thread_data[thread_index].sessions) >=
105 nat_send_all_to_node (vlib_main_t * vm, u32 * bi_vector,
106 vlib_node_runtime_t * node, vlib_error_t * error,
109 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
112 n_left_from = vec_len (bi_vector);
113 next_index = node->cached_next_index;
114 while (n_left_from > 0)
116 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
117 while (n_left_from > 0 && n_left_to_next > 0)
119 u32 bi0 = to_next[0] = from[0];
124 vlib_buffer_t *p0 = vlib_get_buffer (vm, bi0);
127 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
128 n_left_to_next, bi0, next);
130 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
135 user_session_increment (snat_main_t * sm, snat_user_t * u, u8 is_static)
137 if (u->nsessions + u->nstaticsessions < sm->max_translations_per_user)
140 u->nstaticsessions++;
147 nat44_delete_user_with_no_session (snat_main_t * sm, snat_user_t * u,
150 clib_bihash_kv_8_8_t kv;
151 snat_user_key_t u_key;
152 snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
155 if (u->nstaticsessions == 0 && u->nsessions == 0)
157 u_key.addr.as_u32 = u->addr.as_u32;
158 u_key.fib_index = u->fib_index;
159 kv.key = u_key.as_u64;
160 pool_put_index (tsm->list_pool, u->sessions_per_user_list_head_index);
161 pool_put (tsm->users, u);
162 clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
163 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
164 pool_elts (tsm->users));
169 nat44_delete_session (snat_main_t * sm, snat_session_t * ses,
172 snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
174 clib_bihash_kv_8_8_t kv, value;
175 snat_user_key_t u_key;
178 nat_log_debug ("session deleted %U", format_snat_session, tsm, ses);
180 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
181 pool_put_index (tsm->list_pool, ses->per_user_index);
182 pool_put (tsm->sessions, ses);
183 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
184 pool_elts (tsm->sessions));
186 u_key.addr = ses->in2out.addr;
187 u_key.fib_index = ses->in2out.fib_index;
188 kv.key = u_key.as_u64;
189 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
191 u = pool_elt_at_index (tsm->users, value.value);
192 if (snat_is_session_static (ses))
193 u->nstaticsessions--;
197 nat44_delete_user_with_no_session (sm, u, thread_index);
201 /** \brief Set TCP session state.
202 @return 1 if session was closed, otherwise 0
205 nat44_set_tcp_session_state_i2o (snat_main_t * sm, snat_session_t * ses,
206 tcp_header_t * tcp, u32 thread_index)
208 if ((ses->state == 0) && (tcp->flags & TCP_FLAG_RST))
209 ses->state = NAT44_SES_RST;
210 if ((ses->state == NAT44_SES_RST) && !(tcp->flags & TCP_FLAG_RST))
212 if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
213 (ses->state & NAT44_SES_O2I_SYN))
215 if (tcp->flags & TCP_FLAG_SYN)
216 ses->state |= NAT44_SES_I2O_SYN;
217 if (tcp->flags & TCP_FLAG_FIN)
219 ses->i2o_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
220 ses->state |= NAT44_SES_I2O_FIN;
222 if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_O2I_FIN))
224 if (clib_net_to_host_u32 (tcp->ack_number) > ses->o2i_fin_seq)
225 ses->state |= NAT44_SES_O2I_FIN_ACK;
227 if (nat44_is_ses_closed (ses)
228 && !(ses->flags & SNAT_SESSION_FLAG_OUTPUT_FEATURE))
230 nat_log_debug ("TCP close connection %U", format_snat_session,
231 &sm->per_thread_data[thread_index], ses);
232 nat_free_session_data (sm, ses, thread_index, 0);
233 nat44_delete_session (sm, ses, thread_index);
240 nat44_set_tcp_session_state_o2i (snat_main_t * sm, snat_session_t * ses,
241 tcp_header_t * tcp, u32 thread_index)
243 if ((ses->state == 0) && (tcp->flags & TCP_FLAG_RST))
244 ses->state = NAT44_SES_RST;
245 if ((ses->state == NAT44_SES_RST) && !(tcp->flags & TCP_FLAG_RST))
247 if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
248 (ses->state & NAT44_SES_O2I_SYN))
250 if (tcp->flags & TCP_FLAG_SYN)
251 ses->state |= NAT44_SES_O2I_SYN;
252 if (tcp->flags & TCP_FLAG_FIN)
254 ses->o2i_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
255 ses->state |= NAT44_SES_O2I_FIN;
257 if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_FIN))
259 if (clib_net_to_host_u32 (tcp->ack_number) > ses->i2o_fin_seq)
260 ses->state |= NAT44_SES_I2O_FIN_ACK;
262 if (nat44_is_ses_closed (ses))
264 nat_log_debug ("TCP close connection %U", format_snat_session,
265 &sm->per_thread_data[thread_index], ses);
266 nat_free_session_data (sm, ses, thread_index, 0);
267 nat44_delete_session (sm, ses, thread_index);
274 nat44_session_get_timeout (snat_main_t * sm, snat_session_t * s)
276 switch (s->in2out.protocol)
278 case SNAT_PROTOCOL_ICMP:
279 return sm->icmp_timeout;
280 case SNAT_PROTOCOL_UDP:
281 return sm->udp_timeout;
282 case SNAT_PROTOCOL_TCP:
285 return sm->tcp_transitory_timeout;
287 return sm->tcp_established_timeout;
290 return sm->udp_timeout;
297 nat44_session_update_counters (snat_session_t * s, f64 now, uword bytes,
302 s->total_bytes += bytes;
303 nat_ha_sref (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
304 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
305 s->total_pkts, s->total_bytes, thread_index,
306 &s->ha_last_refreshed, now);
309 /** \brief Per-user LRU list maintenance */
311 nat44_session_update_lru (snat_main_t * sm, snat_session_t * s,
314 clib_dlist_remove (sm->per_thread_data[thread_index].list_pool,
316 clib_dlist_addtail (sm->per_thread_data[thread_index].list_pool,
317 s->per_user_list_head_index, s->per_user_index);
321 make_ed_kv (clib_bihash_kv_16_8_t * kv, ip4_address_t * l_addr,
322 ip4_address_t * r_addr, u8 proto, u32 fib_index, u16 l_port,
325 nat_ed_ses_key_t *key = (nat_ed_ses_key_t *) kv->key;
327 key->l_addr.as_u32 = l_addr->as_u32;
328 key->r_addr.as_u32 = r_addr->as_u32;
329 key->fib_index = fib_index;
331 key->l_port = l_port;
332 key->r_port = r_port;
338 make_sm_kv (clib_bihash_kv_8_8_t * kv, ip4_address_t * addr, u8 proto,
339 u32 fib_index, u16 port)
341 snat_session_key_t key;
343 key.addr.as_u32 = addr->as_u32;
345 key.protocol = proto;
346 key.fib_index = fib_index;
348 kv->key = key.as_u64;
353 mss_clamping (snat_main_t * sm, tcp_header_t * tcp, ip_csum_t * sum)
356 u8 opt_len, opts_len, kind;
359 if (!(sm->mss_clamping && tcp_syn (tcp)))
362 opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
363 data = (u8 *) (tcp + 1);
364 for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
368 if (kind == TCP_OPTION_EOL)
370 else if (kind == TCP_OPTION_NOOP)
381 if (opt_len < 2 || opt_len > opts_len)
385 if (kind == TCP_OPTION_MSS)
387 mss = *(u16 *) (data + 2);
388 if (clib_net_to_host_u16 (mss) > sm->mss_clamping)
391 ip_csum_update (*sum, mss, sm->mss_value_net, ip4_header_t,
393 clib_memcpy_fast (data + 2, &sm->mss_value_net, 2);
401 * @brief Check if packet should be translated
403 * Packets aimed at outside interface and external address with active session
404 * should be translated.
407 * @param rt NAT runtime data
408 * @param sw_if_index0 index of the inside interface
409 * @param ip0 IPv4 header
410 * @param proto0 NAT protocol
411 * @param rx_fib_index0 RX FIB index
413 * @returns 0 if packet should be translated otherwise 1
416 snat_not_translate_fast (snat_main_t * sm, vlib_node_runtime_t * node,
417 u32 sw_if_index0, ip4_header_t * ip0, u32 proto0,
423 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
424 nat_outside_fib_t *outside_fib;
426 .fp_proto = FIB_PROTOCOL_IP4,
429 .ip4.as_u32 = ip0->dst_address.as_u32,
434 /* Don't NAT packet aimed at the intfc address */
435 if (PREDICT_FALSE (is_interface_addr (sm, node, sw_if_index0,
436 ip0->dst_address.as_u32)))
439 fei = fib_table_lookup (rx_fib_index0, &pfx);
440 if (FIB_NODE_INDEX_INVALID != fei)
442 u32 sw_if_index = fib_entry_get_resolving_interface (fei);
443 if (sw_if_index == ~0)
445 vec_foreach (outside_fib, sm->outside_fibs)
447 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
448 if (FIB_NODE_INDEX_INVALID != fei)
450 sw_if_index = fib_entry_get_resolving_interface (fei);
451 if (sw_if_index != ~0)
456 if (sw_if_index == ~0)
460 pool_foreach (i, sm->interfaces, (
462 /* NAT packet aimed at outside interface */
463 if ((nat_interface_is_outside (i))
465 i->sw_if_index)) return 0;}
472 #endif /* __included_nat_inlines_h__ */
475 * fd.io coding-style-patch-verification: ON
478 * eval: (c-set-style "gnu")