2 * Copyright (c) 2016 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 * @file NAT plugin global declarations
18 #ifndef __included_nat_h__
19 #define __included_nat_h__
21 #include <vnet/vnet.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/ip/icmp46_packet.h>
25 #include <vnet/api_errno.h>
26 #include <vnet/fib/fib_source.h>
27 #include <vppinfra/elog.h>
28 #include <vppinfra/bihash_8_8.h>
29 #include <vppinfra/bihash_16_8.h>
30 #include <vppinfra/dlist.h>
31 #include <vppinfra/error.h>
32 #include <vlibapi/api.h>
35 /* default session timeouts */
36 #define SNAT_UDP_TIMEOUT 300
37 #define SNAT_TCP_TRANSITORY_TIMEOUT 240
38 #define SNAT_TCP_ESTABLISHED_TIMEOUT 7440
39 #define SNAT_ICMP_TIMEOUT 60
41 /* number of worker handoff frame queue elements */
42 #define NAT_FQ_NELTS 64
44 /* NAT buffer flags */
45 #define SNAT_FLAG_HAIRPINNING (1 << 0)
50 } nat_buffer_opaque_t;
58 NAT_NEXT_IN2OUT_ED_FAST_PATH,
59 NAT_NEXT_IN2OUT_ED_SLOW_PATH,
60 NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH,
61 NAT_NEXT_OUT2IN_ED_FAST_PATH,
62 NAT_NEXT_OUT2IN_ED_SLOW_PATH,
71 #define nat_buffer_opaque(b) \
72 ((nat_buffer_opaque_t *)((vnet_buffer_opaque2_t *)b->opaque2)->__unused2)
75 STATIC_ASSERT (sizeof (nat_buffer_opaque_t) <=
76 STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
77 "Custom meta-data too large for vnet_buffer_opaque_t");
79 #define nat_buffer_opaque(b) \
80 ((nat_buffer_opaque_t *)((u8 *)((b)->opaque) + \
81 STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))*/
83 /* session key (4-tuple) */
92 u16 protocol:3, fib_index:13;
98 /* endpoint-dependent session key (6-tuple) */
105 ip4_address_t l_addr;
106 ip4_address_t r_addr;
107 u32 proto:8, fib_index:24;
115 /* deterministic session outside key */
122 ip4_address_t ext_host_addr;
128 } snat_det_out_key_t;
130 /* user (internal host) key */
149 } nat44_reass_trace_t;
151 /* NAT API Configuration flags */
152 #define foreach_nat_config_flag \
153 _(0x01, IS_TWICE_NAT) \
154 _(0x02, IS_SELF_TWICE_NAT) \
155 _(0x04, IS_OUT2IN_ONLY) \
156 _(0x08, IS_ADDR_ONLY) \
157 _(0x10, IS_OUTSIDE) \
160 _(0x80, IS_EXT_HOST_VALID) \
162 typedef enum nat_config_flags_t_
164 #define _(n,f) NAT_API_##f = n,
165 foreach_nat_config_flag
167 } nat_config_flags_t;
169 /* External address and port allocation modes */
170 #define foreach_nat_addr_and_port_alloc_alg \
171 _(0, DEFAULT, "default") \
172 _(1, MAPE, "map-e") \
173 _(2, RANGE, "port-range")
177 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
178 foreach_nat_addr_and_port_alloc_alg
180 } nat_addr_and_port_alloc_alg_t;
183 /* Supported L4 protocols */
184 #define foreach_snat_protocol \
185 _(UDP, 0, udp, "udp") \
186 _(TCP, 1, tcp, "tcp") \
187 _(ICMP, 2, icmp, "icmp")
191 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
192 foreach_snat_protocol
198 #define foreach_snat_session_state \
199 _(0, UNKNOWN, "unknown") \
200 _(1, UDP_ACTIVE, "udp-active") \
201 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
202 _(3, TCP_ESTABLISHED, "tcp-established") \
203 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
204 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
205 _(6, TCP_CLOSING, "tcp-closing") \
206 _(7, TCP_LAST_ACK, "tcp-last-ack") \
207 _(8, TCP_CLOSED, "tcp-closed") \
208 _(9, ICMP_ACTIVE, "icmp-active")
212 #define _(v, N, s) SNAT_SESSION_##N = v,
213 foreach_snat_session_state
215 } snat_session_state_t;
217 #define foreach_nat_in2out_ed_error \
218 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
219 _(IN2OUT_PACKETS, "good in2out packets processed") \
220 _(OUT_OF_PORTS, "out of ports") \
221 _(BAD_ICMP_TYPE, "unsupported ICMP type") \
222 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
223 _(DROP_FRAGMENT, "drop fragment") \
224 _(MAX_REASS, "maximum reassemblies exceeded") \
225 _(MAX_FRAG, "maximum fragments per reassembly exceeded")\
226 _(NON_SYN, "non-SYN packet try to create session") \
227 _(TCP_PACKETS, "TCP packets") \
228 _(UDP_PACKETS, "UDP packets") \
229 _(ICMP_PACKETS, "ICMP packets") \
230 _(OTHER_PACKETS, "other protocol packets") \
231 _(FRAGMENTS, "fragments") \
232 _(CACHED_FRAGMENTS, "cached fragments") \
233 _(PROCESSED_FRAGMENTS, "processed fragments")
237 #define _(sym,str) NAT_IN2OUT_ED_ERROR_##sym,
238 foreach_nat_in2out_ed_error
240 NAT_IN2OUT_ED_N_ERROR,
241 } nat_in2out_ed_error_t;
243 #define foreach_nat_out2in_ed_error \
244 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
245 _(OUT2IN_PACKETS, "good out2in packets processed") \
246 _(OUT_OF_PORTS, "out of ports") \
247 _(BAD_ICMP_TYPE, "unsupported ICMP type") \
248 _(NO_TRANSLATION, "no translation") \
249 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
250 _(DROP_FRAGMENT, "drop fragment") \
251 _(MAX_REASS, "maximum reassemblies exceeded") \
252 _(MAX_FRAG, "maximum fragments per reassembly exceeded")\
253 _(NON_SYN, "non-SYN packet try to create session") \
254 _(TCP_PACKETS, "TCP packets") \
255 _(UDP_PACKETS, "UDP packets") \
256 _(ICMP_PACKETS, "ICMP packets") \
257 _(OTHER_PACKETS, "other protocol packets") \
258 _(FRAGMENTS, "fragments") \
259 _(CACHED_FRAGMENTS, "cached fragments") \
260 _(PROCESSED_FRAGMENTS, "processed fragments")
264 #define _(sym,str) NAT_OUT2IN_ED_ERROR_##sym,
265 foreach_nat_out2in_ed_error
267 NAT_OUT2IN_ED_N_ERROR,
268 } nat_out2in_ed_error_t;
271 /* Endpoint dependent TCP session state */
272 #define NAT44_SES_I2O_FIN 1
273 #define NAT44_SES_O2I_FIN 2
274 #define NAT44_SES_I2O_FIN_ACK 4
275 #define NAT44_SES_O2I_FIN_ACK 8
276 #define NAT44_SES_I2O_SYN 16
277 #define NAT44_SES_O2I_SYN 32
278 #define NAT44_SES_RST 64
281 #define SNAT_SESSION_FLAG_STATIC_MAPPING 1
282 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO 2
283 #define SNAT_SESSION_FLAG_LOAD_BALANCING 4
284 #define SNAT_SESSION_FLAG_TWICE_NAT 8
285 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT 16
286 #define SNAT_SESSION_FLAG_FWD_BYPASS 32
287 #define SNAT_SESSION_FLAG_AFFINITY 64
288 #define SNAT_SESSION_FLAG_OUTPUT_FEATURE 128
290 /* NAT interface flags */
291 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
292 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
294 /* Static mapping flags */
295 #define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY 1
296 #define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY 2
297 #define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4
298 #define NAT_STATIC_MAPPING_FLAG_LB 8
301 typedef CLIB_PACKED(struct
303 /* Outside network key */
304 snat_session_key_t out2in;
306 /* Inside network key */
307 snat_session_key_t in2out;
312 /* Per-user translations */
314 u32 per_user_list_head_index;
316 /* Last heard timer */
319 /* Last HA refresh */
320 f64 ha_last_refreshed;
326 /* External host address and port */
327 ip4_address_t ext_host_addr;
330 /* External host address and port after translation */
331 ip4_address_t ext_host_nat_addr;
332 u16 ext_host_nat_port;
334 /* TCP session state */
349 u32 sessions_per_user_list_head_index;
359 #define _(N, i, n, s) \
360 u16 busy_##n##_ports; \
361 u16 * busy_##n##_ports_per_thread; \
362 uword * busy_##n##_port_bitmap;
363 foreach_snat_protocol
376 /* Inside network port */
378 /* Outside network address and port */
379 snat_det_out_key_t out;
384 } snat_det_session_t;
388 /* inside IP address range */
389 ip4_address_t in_addr;
391 /* outside IP address range */
392 ip4_address_t out_addr;
394 /* inside IP addresses / outside IP addresses */
396 /* number of ports available to internal host */
398 /* session counter */
400 /* vector of sessions */
401 snat_det_session_t *sessions;
406 /* backend IP address */
408 /* backend port number */
410 /* probability of the backend to be randomly matched */
413 /* backend FIB table */
416 } nat44_lb_addr_port_t;
420 /* twice-nat disabled */
422 /* twice-nat enabled */
424 /* twice-nat only when src IP equals dst IP after translation */
430 /* no load-balancing */
434 /* load-balancing with affinity */
440 /* local IP address */
441 ip4_address_t local_addr;
442 /* external IP address */
443 ip4_address_t external_addr;
449 twice_nat_type_t twice_nat;
450 /* local FIB table */
454 snat_protocol_t proto;
455 /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
457 /* worker threads used by backends/local host */
459 /* opaque string tag */
461 /* backends for load-balancing mode */
462 nat44_lb_addr_port_t *locals;
463 /* affinity per service lis */
464 u32 affinity_per_service_list_head_index;
467 } snat_static_mapping_t;
477 ip4_address_t l_addr;
482 snat_protocol_t proto;
490 } snat_static_map_resolve_t;
494 /* Main lookup tables */
495 clib_bihash_8_8_t out2in;
496 clib_bihash_8_8_t in2out;
498 /* Endpoint dependent sessions lookup tables */
499 clib_bihash_16_8_t out2in_ed;
500 clib_bihash_16_8_t in2out_ed;
502 /* Find-a-user => src address lookup */
503 clib_bihash_8_8_t user_hash;
509 snat_session_t *sessions;
511 /* Pool of doubly-linked list elements */
512 dlist_elt_t *list_pool;
514 /* NAT thread index */
515 u32 snat_thread_index;
517 /* real thread index */
520 /* discovered minimum session timeout time */
521 u64 min_session_timeout;
522 } snat_main_per_thread_data_t;
526 /* ICMP session match function */
527 typedef u32 (snat_icmp_match_function_t) (struct snat_main_s * sm,
528 vlib_node_runtime_t * node,
531 ip4_header_t * ip0, u8 * p_proto,
532 snat_session_key_t * p_value,
533 u8 * p_dont_translate, void *d,
536 /* Return worker thread index for given packet */
537 typedef u32 (snat_get_worker_in2out_function_t) (ip4_header_t * ip,
541 typedef u32 (snat_get_worker_out2in_function_t) (vlib_buffer_t * b,
546 /* NAT address and port allacotaion function */
547 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
551 snat_session_key_t * k,
553 u32 snat_thread_index);
555 typedef struct snat_main_s
557 /* ICMP session match functions */
558 snat_icmp_match_function_t *icmp_match_in2out_cb;
559 snat_icmp_match_function_t *icmp_match_out2in_cb;
561 /* Thread settings */
563 u32 first_worker_index;
565 snat_get_worker_in2out_function_t *worker_in2out_cb;
566 snat_get_worker_out2in_function_t *worker_out2in_cb;
570 /* Per thread data */
571 snat_main_per_thread_data_t *per_thread_data;
573 /* Find a static mapping by local */
574 clib_bihash_8_8_t static_mapping_by_local;
576 /* Find a static mapping by external */
577 clib_bihash_8_8_t static_mapping_by_external;
579 /* Static mapping pool */
580 snat_static_mapping_t *static_mappings;
583 snat_interface_t *interfaces;
584 snat_interface_t *output_feature_interfaces;
586 /* Vector of outside addresses */
587 snat_address_t *addresses;
588 /* Address and port allocation function */
589 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
590 /* Address and port allocation type */
591 nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
592 /* Port set parameters (MAP-E) */
596 /* Port range parameters */
600 /* vector of outside fibs */
601 nat_outside_fib_t *outside_fibs;
603 /* Vector of twice NAT addresses for extenal hosts */
604 snat_address_t *twice_nat_addresses;
606 /* sw_if_indices whose intfc addresses should be auto-added */
607 u32 *auto_add_sw_if_indices;
608 u32 *auto_add_sw_if_indices_twice_nat;
610 /* vector of interface address static mappings to resolve. */
611 snat_static_map_resolve_t *to_resolve;
613 /* Randomize port allocation order */
616 /* Worker handoff frame-queue index */
618 u32 fq_in2out_output_index;
622 u32 error_node_index;
624 /* handoff fq nodes */
625 u32 handoff_out2in_index;
626 u32 handoff_in2out_index;
627 u32 handoff_in2out_output_index;
629 /* respect feature arc nodes */
630 u32 pre_out2in_node_index;
631 u32 pre_in2out_node_index;
633 u32 in2out_node_index;
634 u32 in2out_output_node_index;
635 u32 in2out_fast_node_index;
636 u32 in2out_slowpath_node_index;
637 u32 in2out_slowpath_output_node_index;
638 u32 ed_in2out_node_index;
639 u32 ed_in2out_slowpath_node_index;
640 u32 out2in_node_index;
641 u32 out2in_fast_node_index;
642 u32 ed_out2in_node_index;
643 u32 ed_out2in_slowpath_node_index;
644 u32 det_in2out_node_index;
645 u32 det_out2in_node_index;
647 u32 hairpinning_node_index;
648 u32 hairpin_dst_node_index;
649 u32 hairpin_src_node_index;
650 u32 ed_hairpinning_node_index;
651 u32 ed_hairpin_dst_node_index;
652 u32 ed_hairpin_src_node_index;
655 /* Deterministic NAT mappings */
656 snat_det_map_t *det_maps;
658 /* If forwarding is enabled */
659 u8 forwarding_enabled;
661 /* Config parameters */
662 u8 static_mapping_only;
663 u8 static_mapping_connection_tracking;
666 u8 endpoint_dependent;
667 u32 translation_buckets;
668 u32 translation_memory_size;
669 u32 max_translations;
671 u32 user_memory_size;
672 u32 max_translations_per_user;
674 u32 outside_fib_index;
676 u32 inside_fib_index;
678 /* values of various timeouts */
681 u32 tcp_transitory_timeout;
682 u32 tcp_established_timeout;
684 /* TCP MSS clamping */
688 /* counters/gauges */
689 vlib_simple_counter_main_t total_users;
690 vlib_simple_counter_main_t total_sessions;
692 /* API message ID base */
696 vlib_log_class_t log_class;
701 vlib_main_t *vlib_main;
702 vnet_main_t *vnet_main;
703 ip4_main_t *ip4_main;
704 ip_lookup_main_t *ip4_lookup_main;
705 api_main_t *api_main;
712 } nat44_is_idle_session_ctx_t;
716 u32 cached_sw_if_index;
717 u32 cached_ip4_address;
720 extern snat_main_t snat_main;
722 // nat pre ed next_node feature classification
723 extern vlib_node_registration_t nat_default_node;
724 extern vlib_node_registration_t nat_pre_in2out_node;
725 extern vlib_node_registration_t nat_pre_out2in_node;
727 extern vlib_node_registration_t snat_in2out_node;
728 extern vlib_node_registration_t snat_in2out_output_node;
729 extern vlib_node_registration_t snat_out2in_node;
730 extern vlib_node_registration_t snat_in2out_fast_node;
731 extern vlib_node_registration_t snat_out2in_fast_node;
732 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
733 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
734 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
735 extern vlib_node_registration_t snat_det_in2out_node;
736 extern vlib_node_registration_t snat_det_out2in_node;
737 extern vlib_node_registration_t snat_hairpin_dst_node;
738 extern vlib_node_registration_t snat_hairpin_src_node;
739 extern vlib_node_registration_t nat44_ed_in2out_node;
740 extern vlib_node_registration_t nat44_ed_in2out_output_node;
741 extern vlib_node_registration_t nat44_ed_out2in_node;
742 extern vlib_node_registration_t nat44_ed_hairpin_dst_node;
743 extern vlib_node_registration_t nat44_ed_hairpin_src_node;
744 extern vlib_node_registration_t nat44_ed_in2out_worker_handoff_node;
745 extern vlib_node_registration_t nat44_ed_in2out_output_worker_handoff_node;
746 extern vlib_node_registration_t nat44_ed_out2in_worker_handoff_node;
748 extern fib_source_t nat_fib_src_hi;
749 extern fib_source_t nat_fib_src_low;
751 /* format functions */
752 format_function_t format_snat_user;
753 format_function_t format_snat_static_mapping;
754 format_function_t format_snat_static_map_to_resolve;
755 format_function_t format_snat_session;
756 format_function_t format_det_map_ses;
757 format_function_t format_snat_key;
758 format_function_t format_static_mapping_key;
759 format_function_t format_snat_protocol;
760 format_function_t format_nat_addr_and_port_alloc_alg;
761 /* unformat functions */
762 unformat_function_t unformat_snat_protocol;
764 /** \brief Check if SNAT session is created from static mapping.
765 @param s SNAT session
766 @return 1 if SNAT session is created from static mapping otherwise 0
768 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
770 /** \brief Check if SNAT session for unknown protocol.
771 @param s SNAT session
772 @return 1 if SNAT session for unknown protocol otherwise 0
774 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
776 /** \brief Check if NAT session is twice NAT.
778 @return 1 if NAT session is twice NAT
780 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
782 /** \brief Check if NAT session is load-balancing.
784 @return 1 if NAT session is load-balancing
786 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
788 /** \brief Check if NAT session is forwarding bypass.
790 @return 1 if NAT session is load-balancing
792 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
794 /** \brief Check if NAT session is endpoint dependent.
796 @return 1 if NAT session is endpoint dependent
798 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
800 /** \brief Check if NAT session has affinity record.
802 @return 1 if NAT session has affinity record
804 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
806 /** \brief Check if NAT interface is inside.
807 @param i NAT interfce
808 @return 1 if inside interface
810 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
812 /** \brief Check if NAT interface is outside.
813 @param i NAT interfce
814 @return 1 if outside interface
816 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
818 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
820 @return 1 if session is closed
822 #define nat44_is_ses_closed(s) s->state == 0xf
824 /** \brief Check if NAT static mapping is address only (1:1NAT).
825 @param sm NAT static mapping
826 @return 1 if 1:1NAT, 0 if 1:1NAPT
828 #define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY)
830 /** \brief Check if NAT static mapping match only out2in direction.
831 @param sm NAT static mapping
832 @return 1 if rule match only out2in direction
834 #define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY)
836 /** \brief Check if NAT static mapping is identity NAT.
837 @param sm NAT static mapping
838 @return 1 if identity NAT
840 #define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT)
842 /** \brief Check if NAT static mapping is load-balancing.
843 @param sm NAT static mapping
844 @return 1 if load-balancing
846 #define is_lb_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_LB)
848 /** \brief Check if client initiating TCP connection (received SYN from client)
850 @return 1 if client initiating TCP connection
853 tcp_flags_is_init (u8 f)
855 return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK);
859 #define nat_log_err(...) \
860 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
861 #define nat_log_warn(...) \
862 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
863 #define nat_log_notice(...) \
864 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
865 #define nat_log_info(...) \
866 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
867 #define nat_log_debug(...)\
868 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
870 /* NAT API Logging Levels */
871 #define foreach_nat_log_level \
874 _(0x02, LOG_WARNING) \
875 _(0x03, LOG_NOTICE) \
879 typedef enum nat_log_level_t_
881 #define _(n,f) SNAT_##f = n,
882 foreach_nat_log_level
886 #define nat_elog(_level, _str) \
889 snat_main_t *sm = &snat_main; \
890 if (PREDICT_FALSE (sm->log_level >= _level)) \
892 ELOG_TYPE_DECLARE (e) = \
894 .format = "nat-msg " _str, \
897 ELOG_DATA (&sm->vlib_main->elog_main, e); \
901 #define nat_elog_addr(_level, _str, _addr) \
904 if (PREDICT_FALSE (sm->log_level >= _level)) \
906 ELOG_TYPE_DECLARE (e) = \
908 .format = "nat-msg " _str " %d.%d.%d.%d", \
909 .format_args = "i1i1i1i1", \
918 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
919 ed->oct4 = _addr >> 24; \
920 ed->oct3 = _addr >> 16; \
921 ed->oct2 = _addr >> 8; \
926 #define nat_elog_debug_handoff(_str, _tid, _fib, _src, _dst) \
929 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
931 ELOG_TYPE_DECLARE (e) = \
933 .format = "nat-msg " _str " ip src: %d.%d.%d.%d dst: %d.%d.%d.%d" \
934 " tid from: %d to: %d fib: %d", \
935 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
951 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
952 ed->src_oct1 = _src >> 24; \
953 ed->src_oct2 = _src >> 16; \
954 ed->src_oct3 = _src >> 8; \
955 ed->src_oct4 = _src; \
956 ed->dst_oct1 = _dst >> 24; \
957 ed->dst_oct2 = _dst >> 16; \
958 ed->dst_oct3 = _dst >> 8; \
959 ed->dst_oct4 = _dst; \
960 ed->ftid = vlib_get_thread_index (); \
966 #define nat_elog_debug_handoff_v2(_str, _prt, _fib, _src, _dst) \
969 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
971 ELOG_TYPE_DECLARE (e) = \
973 .format = "nat-msg " _str " ip_src:%d.%d.%d.%d ip_dst:%d.%d.%d.%d" \
974 " tid:%d prt:%d fib:%d", \
975 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
991 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
992 ed->src_oct1 = _src >> 24; \
993 ed->src_oct2 = _src >> 16; \
994 ed->src_oct3 = _src >> 8; \
995 ed->src_oct4 = _src; \
996 ed->dst_oct1 = _dst >> 24; \
997 ed->dst_oct2 = _dst >> 16; \
998 ed->dst_oct3 = _dst >> 8; \
999 ed->dst_oct4 = _dst; \
1000 ed->tid = vlib_get_thread_index (); \
1006 #define nat_elog_X1(_level, _fmt, _arg, _val1) \
1009 snat_main_t *sm = &snat_main; \
1010 if (PREDICT_FALSE (sm->log_level >= _level)) \
1012 ELOG_TYPE_DECLARE (e) = \
1014 .format = "nat-msg " _fmt, \
1015 .format_args = _arg, \
1017 CLIB_PACKED(struct \
1019 typeof (_val1) val1; \
1021 ed = ELOG_DATA (&sm->vlib_main->elog_main, e); \
1026 #define nat_elog_notice(nat_elog_str) \
1027 nat_elog(SNAT_LOG_INFO, "[notice] " nat_elog_str)
1028 #define nat_elog_warn(nat_elog_str) \
1029 nat_elog(SNAT_LOG_WARNING, "[warning] " nat_elog_str)
1030 #define nat_elog_err(nat_elog_str) \
1031 nat_elog(SNAT_LOG_ERROR, "[error] " nat_elog_str)
1032 #define nat_elog_debug(nat_elog_str) \
1033 nat_elog(SNAT_LOG_DEBUG, "[debug] " nat_elog_str)
1034 #define nat_elog_info(nat_elog_str) \
1035 nat_elog(SNAT_LOG_INFO, "[info] " nat_elog_str)
1037 #define nat_elog_notice_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1038 nat_elog_X1(SNAT_LOG_NOTICE, "[notice] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1039 #define nat_elog_warn_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1040 nat_elog_X1(SNAT_LOG_WARNING, "[warning] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1041 #define nat_elog_err_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1042 nat_elog_X1(SNAT_LOG_ERROR, "[error] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1043 #define nat_elog_debug_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1044 nat_elog_X1(SNAT_LOG_DEBUG, "[debug] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1045 #define nat_elog_info_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1046 nat_elog_X1(SNAT_LOG_INFO, "[info] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1048 /* ICMP session match functions */
1049 u32 icmp_match_in2out_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1050 u32 thread_index, vlib_buffer_t * b0,
1051 ip4_header_t * ip0, u8 * p_proto,
1052 snat_session_key_t * p_value,
1053 u8 * p_dont_translate, void *d, void *e);
1054 u32 icmp_match_in2out_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1055 u32 thread_index, vlib_buffer_t * b0,
1056 ip4_header_t * ip0, u8 * p_proto,
1057 snat_session_key_t * p_value,
1058 u8 * p_dont_translate, void *d, void *e);
1059 u32 icmp_match_out2in_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1060 u32 thread_index, vlib_buffer_t * b0,
1061 ip4_header_t * ip0, u8 * p_proto,
1062 snat_session_key_t * p_value,
1063 u8 * p_dont_translate, void *d, void *e);
1064 u32 icmp_match_out2in_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1065 u32 thread_index, vlib_buffer_t * b0,
1066 ip4_header_t * ip0, u8 * p_proto,
1067 snat_session_key_t * p_value,
1068 u8 * p_dont_translate, void *d, void *e);
1070 /* ICMP deterministic NAT session match functions */
1071 u32 icmp_match_out2in_det (snat_main_t * sm, vlib_node_runtime_t * node,
1072 u32 thread_index, vlib_buffer_t * b0,
1073 ip4_header_t * ip0, u8 * p_proto,
1074 snat_session_key_t * p_value,
1075 u8 * p_dont_translate, void *d, void *e);
1076 u32 icmp_match_in2out_det (snat_main_t * sm, vlib_node_runtime_t * node,
1077 u32 thread_index, vlib_buffer_t * b0,
1078 ip4_header_t * ip0, u8 * p_proto,
1079 snat_session_key_t * p_value,
1080 u8 * p_dont_translate, void *d, void *e);
1082 /* ICMP endpoint-dependent session match functions */
1083 u32 icmp_match_out2in_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1084 u32 thread_index, vlib_buffer_t * b0,
1085 ip4_header_t * ip0, u8 * p_proto,
1086 snat_session_key_t * p_value,
1087 u8 * p_dont_translate, void *d, void *e);
1088 u32 icmp_match_in2out_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1089 u32 thread_index, vlib_buffer_t * b0,
1090 ip4_header_t * ip0, u8 * p_proto,
1091 snat_session_key_t * p_value,
1092 u8 * p_dont_translate, void *d, void *e);
1094 u32 icmp_in2out (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1095 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1096 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1099 u32 icmp_out2in (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1100 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1101 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1104 /* hairpinning functions */
1105 u32 snat_icmp_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1106 ip4_header_t * ip0, icmp46_header_t * icmp0,
1108 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1110 void nat44_ed_hairpinning_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1112 int snat_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1113 ip4_header_t * ip0, udp_header_t * udp0,
1114 tcp_header_t * tcp0, u32 proto0, int is_ed);
1115 void nat44_reass_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1116 ip4_header_t * ip0, u16 sport, u16 dport,
1117 u32 proto0, int is_ed);
1119 /* Call back functions for clib_bihash_add_or_overwrite_stale */
1120 int nat44_i2o_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1121 int nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1122 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1123 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1126 * @brief Add external address to NAT44 pool
1128 * @param addr IPv4 address
1129 * @param vrf_id VRF id of tenant, ~0 means independent of VRF
1130 * @param twice_nat 1 if twice NAT address
1132 * @return 0 on success, non-zero value otherwise
1134 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
1138 * @brief Delete external address from NAT44 pool
1140 * @param addr IPv4 address
1141 * @param delete_sm 1 if delete static mapping using address
1142 * @param twice_nat 1 if twice NAT address
1144 * @return 0 on success, non-zero value otherwise
1146 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1150 * @brief Add/delete external address to FIB DPO (out2in DPO mode)
1152 * @param addr IPv4 address
1153 * @param is_add 1 = add, 0 = delete
1155 * @return 0 on success, non-zero value otherwise
1157 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
1160 * @brief Add/delete NAT44 static mapping
1162 * @param l_addr local IPv4 address
1163 * @param e_addr external IPv4 address
1164 * @param l_port local port number
1165 * @param e_port external port number
1166 * @param vrf_id local VRF ID
1167 * @param addr_only 1 = 1:1NAT, 0 = 1:1NAPT
1168 * @param sw_if_index use interface address as external IPv4 address
1169 * @param proto L4 protocol
1170 * @param is_add 1 = add, 0 = delete
1171 * @param twice_nat twice-nat mode
1172 * @param out2in_only if 1 rule match only out2in direction
1173 * @param tag opaque string tag
1174 * @param identity_nat identity NAT
1176 * @return 0 on success, non-zero value otherwise
1178 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
1179 u16 l_port, u16 e_port, u32 vrf_id,
1180 int addr_only, u32 sw_if_index,
1181 snat_protocol_t proto, int is_add,
1182 twice_nat_type_t twice_nat, u8 out2in_only,
1183 u8 * tag, u8 identity_nat);
1186 * @brief Add/delete static mapping with load-balancing (multiple backends)
1188 * @param e_addr external IPv4 address
1189 * @param e_port external port number
1190 * @param proto L4 protocol
1191 * @param locals list of local backends
1192 * @param is_add 1 = add, 0 = delete
1193 * @param twice_nat twice-nat mode
1194 * @param out2in_only if 1 rule match only out2in direction
1195 * @param tag opaque string tag
1196 * @param affinity 0 = disabled, otherwise client IP affinity sticky time
1198 * @return 0 on success, non-zero value otherwise
1200 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1201 snat_protocol_t proto,
1202 nat44_lb_addr_port_t * locals, u8 is_add,
1203 twice_nat_type_t twice_nat,
1204 u8 out2in_only, u8 * tag, u32 affinity);
1206 int nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1207 ip4_address_t l_addr, u16 l_port,
1208 snat_protocol_t proto, u32 vrf_id,
1209 u8 probability, u8 is_add);
1211 clib_error_t *snat_api_init (vlib_main_t * vm, snat_main_t * sm);
1214 * @brief Set NAT plugin workers
1216 * @param bitmap NAT workers bitmap
1218 * @return 0 on success, non-zero value otherwise
1220 int snat_set_workers (uword * bitmap);
1223 * @brief Enable/disable NAT44 feature on the interface
1225 * @param sw_if_index software index of the interface
1226 * @param is_inside 1 = inside, 0 = outside
1227 * @param is_del 1 = delete, 0 = add
1229 * @return 0 on success, non-zero value otherwise
1231 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
1234 * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
1236 * @param sw_if_index software index of the interface
1237 * @param is_inside 1 = inside, 0 = outside
1238 * @param is_del 1 = delete, 0 = add
1240 * @return 0 on success, non-zero value otherwise
1242 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
1246 * @brief Add/delete NAT44 pool address from specific interfce
1248 * @param sw_if_index software index of the interface
1249 * @param is_del 1 = delete, 0 = add
1250 * @param twice_nat 1 = twice NAT address for extenal hosts
1252 * @return 0 on success, non-zero value otherwise
1254 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
1258 * @brief Delete NAT44 session
1260 * @param addr IPv4 address
1261 * @param port L4 port number
1262 * @param proto L4 protocol
1263 * @param vrf_id VRF ID
1264 * @param is_in 1 = inside network address and port pair, 0 = outside
1266 * @return 0 on success, non-zero value otherwise
1268 int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1269 snat_protocol_t proto, u32 vrf_id, int is_in);
1272 * @brief Delete NAT44 endpoint-dependent session
1274 * @param addr IPv4 address
1275 * @param port L4 port number
1276 * @param proto L4 protocol
1277 * @param vrf_id VRF ID
1278 * @param is_in 1 = inside network address and port pair, 0 = outside
1280 * @return 0 on success, non-zero value otherwise
1282 int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1283 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
1284 u32 vrf_id, int is_in);
1287 * @brief Free NAT44 session data (lookup keys, external addrres port)
1289 * @param s NAT session
1290 * @param thread_index thread index
1291 * @param is_ha is HA event
1293 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
1294 u32 thread_index, u8 is_ha);
1297 * @brief Find or create NAT user
1299 * @param addr IPv4 address
1300 * @param fib_index FIB table index
1301 * @param thread_index thread index
1303 * @return NAT user data structure on success otherwise zero value
1305 snat_user_t *nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr,
1306 u32 fib_index, u32 thread_index);
1309 * @brief Allocate new NAT session or recycle last used
1312 * @param thread_index thread index
1314 * @return session data structure on success otherwise zero value
1316 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
1318 u32 thread_index, f64 now);
1321 * @brief Allocate NAT endpoint-dependent session
1324 * @param thread_index thread index
1326 * @return session data structure on success otherwise zero value
1328 snat_session_t *nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u,
1329 u32 thread_index, f64 now);
1332 * @brief Set address and port assignment algorithm for MAP-E CE
1334 * @param psid Port Set Identifier value
1335 * @param psid_offset number of offset bits
1336 * @param psid_length length of PSID
1338 void nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset,
1342 * @brief Set address and port assignment algorithm for port range
1344 * @param start_port beginning of the port range
1345 * @param end_port end of the port range
1347 void nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port);
1350 * @brief Set address and port assignment algorithm to default/standard
1352 void nat_set_alloc_addr_and_port_default (void);
1355 * @brief Free outside address and port pair
1357 * @param addresses vector of outside addresses
1358 * @param thread_index thread index
1359 * @param k address, port and protocol
1361 void snat_free_outside_address_and_port (snat_address_t * addresses,
1363 snat_session_key_t * k);
1366 * @brief Alloc outside address and port
1368 * @param addresses vector of outside addresses
1369 * @param fib_index FIB table index
1370 * @param thread_index thread index
1371 * @param k allocated address and port pair
1372 * @param port_per_thread number of ports per threead
1373 * @param snat_thread_index NAT thread index
1375 * @return 0 on success, non-zero value otherwise
1377 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
1380 snat_session_key_t * k,
1381 u16 port_per_thread,
1382 u32 snat_thread_index);
1385 * @brief Match NAT44 static mapping.
1387 * @param match address and port to match
1388 * @param mapping external/local address and port of the matched mapping
1389 * @param by_external if 0 match by local address otherwise match by external
1391 * @param is_addr_only 1 if matched mapping is address only
1392 * @param twice_nat matched mapping is twice NAT type
1393 * @param lb 1 if matched mapping is load-balanced
1394 * @param ext_host_addr external host address
1396 * @returns 0 if match found otherwise 1.
1398 int snat_static_mapping_match (snat_main_t * sm,
1399 snat_session_key_t match,
1400 snat_session_key_t * mapping,
1403 twice_nat_type_t * twice_nat,
1405 ip4_address_t * ext_host_addr,
1406 u8 * is_identity_nat);
1409 * @brief Add/del NAT address to FIB.
1411 * Add the external NAT address to the FIB as receive entries. This ensures
1412 * that VPP will reply to ARP for this address and we don't need to enable
1413 * proxy ARP on the outside interface.
1415 * @param addr IPv4 address
1416 * @param plen address prefix length
1417 * @param sw_if_index software index of the outside interface
1418 * @param is_add 0 = delete, 1 = add.
1420 void snat_add_del_addr_to_fib (ip4_address_t * addr,
1421 u8 p_len, u32 sw_if_index, int is_add);
1424 * Why is this here? Because we don't need to touch this layer to
1425 * simply reply to an icmp. We need to change id to a unique
1426 * value to NAT an echo request/reply.
1433 } icmp_echo_header_t;
1437 u16 src_port, dst_port;
1440 #endif /* __included_nat_h__ */
1443 * fd.io coding-style-patch-verification: ON
1446 * eval: (c-set-style "gnu")