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 <vppinfra/elog.h>
27 #include <vppinfra/bihash_8_8.h>
28 #include <vppinfra/bihash_16_8.h>
29 #include <vppinfra/dlist.h>
30 #include <vppinfra/error.h>
31 #include <vlibapi/api.h>
34 /* default session timeouts */
35 #define SNAT_UDP_TIMEOUT 300
36 #define SNAT_TCP_TRANSITORY_TIMEOUT 240
37 #define SNAT_TCP_ESTABLISHED_TIMEOUT 7440
38 #define SNAT_ICMP_TIMEOUT 60
40 /* number of worker handoff frame queue elements */
41 #define NAT_FQ_NELTS 64
43 /* NAT buffer flags */
44 #define SNAT_FLAG_HAIRPINNING (1 << 0)
49 } nat_buffer_opaque_t;
57 NAT_NEXT_IN2OUT_ED_FAST_PATH,
58 NAT_NEXT_IN2OUT_ED_SLOW_PATH,
59 NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH,
60 NAT_NEXT_IN2OUT_ED_REASS,
61 NAT_NEXT_IN2OUT_ED_OUTPUT_REASS,
62 NAT_NEXT_OUT2IN_ED_FAST_PATH,
63 NAT_NEXT_OUT2IN_ED_SLOW_PATH,
64 NAT_NEXT_OUT2IN_ED_REASS,
73 #define nat_buffer_opaque(b) \
74 ((nat_buffer_opaque_t *)((vnet_buffer_opaque2_t *)b->opaque2)->__unused2)
77 STATIC_ASSERT (sizeof (nat_buffer_opaque_t) <=
78 STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
79 "Custom meta-data too large for vnet_buffer_opaque_t");
81 #define nat_buffer_opaque(b) \
82 ((nat_buffer_opaque_t *)((u8 *)((b)->opaque) + \
83 STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))*/
85 /* session key (4-tuple) */
94 u16 protocol:3, fib_index:13;
100 /* endpoint-dependent session key (6-tuple) */
107 ip4_address_t l_addr;
108 ip4_address_t r_addr;
109 u32 proto:8, fib_index:24;
117 /* deterministic session outside key */
124 ip4_address_t ext_host_addr;
130 } snat_det_out_key_t;
132 /* user (internal host) key */
151 } nat44_reass_trace_t;
153 /* NAT API Configuration flags */
154 #define foreach_nat_config_flag \
155 _(0x01, IS_TWICE_NAT) \
156 _(0x02, IS_SELF_TWICE_NAT) \
157 _(0x04, IS_OUT2IN_ONLY) \
158 _(0x08, IS_ADDR_ONLY) \
159 _(0x10, IS_OUTSIDE) \
162 _(0x80, IS_EXT_HOST_VALID) \
164 typedef enum nat_config_flags_t_
166 #define _(n,f) NAT_API_##f = n,
167 foreach_nat_config_flag
169 } nat_config_flags_t;
171 /* External address and port allocation modes */
172 #define foreach_nat_addr_and_port_alloc_alg \
173 _(0, DEFAULT, "default") \
174 _(1, MAPE, "map-e") \
175 _(2, RANGE, "port-range")
179 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
180 foreach_nat_addr_and_port_alloc_alg
182 } nat_addr_and_port_alloc_alg_t;
185 /* Supported L4 protocols */
186 #define foreach_snat_protocol \
187 _(UDP, 0, udp, "udp") \
188 _(TCP, 1, tcp, "tcp") \
189 _(ICMP, 2, icmp, "icmp")
193 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
194 foreach_snat_protocol
200 #define foreach_snat_session_state \
201 _(0, UNKNOWN, "unknown") \
202 _(1, UDP_ACTIVE, "udp-active") \
203 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
204 _(3, TCP_ESTABLISHED, "tcp-established") \
205 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
206 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
207 _(6, TCP_CLOSING, "tcp-closing") \
208 _(7, TCP_LAST_ACK, "tcp-last-ack") \
209 _(8, TCP_CLOSED, "tcp-closed") \
210 _(9, ICMP_ACTIVE, "icmp-active")
214 #define _(v, N, s) SNAT_SESSION_##N = v,
215 foreach_snat_session_state
217 } snat_session_state_t;
219 #define foreach_nat_in2out_ed_error \
220 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
221 _(IN2OUT_PACKETS, "good in2out packets processed") \
222 _(OUT_OF_PORTS, "out of ports") \
223 _(BAD_ICMP_TYPE, "unsupported ICMP type") \
224 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
225 _(DROP_FRAGMENT, "drop fragment") \
226 _(MAX_REASS, "maximum reassemblies exceeded") \
227 _(MAX_FRAG, "maximum fragments per reassembly exceeded")\
228 _(NON_SYN, "non-SYN packet try to create session") \
229 _(TCP_PACKETS, "TCP packets") \
230 _(UDP_PACKETS, "UDP packets") \
231 _(ICMP_PACKETS, "ICMP packets") \
232 _(OTHER_PACKETS, "other protocol packets") \
233 _(FRAGMENTS, "fragments") \
234 _(CACHED_FRAGMENTS, "cached fragments") \
235 _(PROCESSED_FRAGMENTS, "processed fragments")
239 #define _(sym,str) NAT_IN2OUT_ED_ERROR_##sym,
240 foreach_nat_in2out_ed_error
242 NAT_IN2OUT_ED_N_ERROR,
243 } nat_in2out_ed_error_t;
245 #define foreach_nat_out2in_ed_error \
246 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
247 _(OUT2IN_PACKETS, "good out2in packets processed") \
248 _(OUT_OF_PORTS, "out of ports") \
249 _(BAD_ICMP_TYPE, "unsupported ICMP type") \
250 _(NO_TRANSLATION, "no translation") \
251 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
252 _(DROP_FRAGMENT, "drop fragment") \
253 _(MAX_REASS, "maximum reassemblies exceeded") \
254 _(MAX_FRAG, "maximum fragments per reassembly exceeded")\
255 _(NON_SYN, "non-SYN packet try to create session") \
256 _(TCP_PACKETS, "TCP packets") \
257 _(UDP_PACKETS, "UDP packets") \
258 _(ICMP_PACKETS, "ICMP packets") \
259 _(OTHER_PACKETS, "other protocol packets") \
260 _(FRAGMENTS, "fragments") \
261 _(CACHED_FRAGMENTS, "cached fragments") \
262 _(PROCESSED_FRAGMENTS, "processed fragments")
266 #define _(sym,str) NAT_OUT2IN_ED_ERROR_##sym,
267 foreach_nat_out2in_ed_error
269 NAT_OUT2IN_ED_N_ERROR,
270 } nat_out2in_ed_error_t;
273 /* Endpoint dependent TCP session state */
274 #define NAT44_SES_I2O_FIN 1
275 #define NAT44_SES_O2I_FIN 2
276 #define NAT44_SES_I2O_FIN_ACK 4
277 #define NAT44_SES_O2I_FIN_ACK 8
278 #define NAT44_SES_I2O_SYN 16
279 #define NAT44_SES_O2I_SYN 32
280 #define NAT44_SES_RST 64
283 #define SNAT_SESSION_FLAG_STATIC_MAPPING 1
284 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO 2
285 #define SNAT_SESSION_FLAG_LOAD_BALANCING 4
286 #define SNAT_SESSION_FLAG_TWICE_NAT 8
287 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT 16
288 #define SNAT_SESSION_FLAG_FWD_BYPASS 32
289 #define SNAT_SESSION_FLAG_AFFINITY 64
290 #define SNAT_SESSION_FLAG_OUTPUT_FEATURE 128
292 /* NAT interface flags */
293 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
294 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
296 /* Static mapping flags */
297 #define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY 1
298 #define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY 2
299 #define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4
300 #define NAT_STATIC_MAPPING_FLAG_LB 8
303 typedef CLIB_PACKED(struct
305 /* Outside network key */
306 snat_session_key_t out2in;
308 /* Inside network key */
309 snat_session_key_t in2out;
314 /* Per-user translations */
316 u32 per_user_list_head_index;
318 /* Last heard timer */
321 /* Last HA refresh */
322 f64 ha_last_refreshed;
328 /* External host address and port */
329 ip4_address_t ext_host_addr;
332 /* External host address and port after translation */
333 ip4_address_t ext_host_nat_addr;
334 u16 ext_host_nat_port;
336 /* TCP session state */
351 u32 sessions_per_user_list_head_index;
361 #define _(N, i, n, s) \
362 u16 busy_##n##_ports; \
363 u16 * busy_##n##_ports_per_thread; \
364 uword * busy_##n##_port_bitmap;
365 foreach_snat_protocol
378 /* Inside network port */
380 /* Outside network address and port */
381 snat_det_out_key_t out;
386 } snat_det_session_t;
390 /* inside IP address range */
391 ip4_address_t in_addr;
393 /* outside IP address range */
394 ip4_address_t out_addr;
396 /* inside IP addresses / outside IP addresses */
398 /* number of ports available to internal host */
400 /* session counter */
402 /* vector of sessions */
403 snat_det_session_t *sessions;
408 /* backend IP address */
410 /* backend port number */
412 /* probability of the backend to be randomly matched */
415 /* backend FIB table */
418 } nat44_lb_addr_port_t;
422 /* twice-nat disabled */
424 /* twice-nat enabled */
426 /* twice-nat only when src IP equals dst IP after translation */
432 /* no load-balancing */
436 /* load-balancing with affinity */
442 /* local IP address */
443 ip4_address_t local_addr;
444 /* external IP address */
445 ip4_address_t external_addr;
451 twice_nat_type_t twice_nat;
452 /* local FIB table */
456 snat_protocol_t proto;
457 /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
459 /* worker threads used by backends/local host */
461 /* opaque string tag */
463 /* backends for load-balancing mode */
464 nat44_lb_addr_port_t *locals;
465 /* affinity per service lis */
466 u32 affinity_per_service_list_head_index;
469 } snat_static_mapping_t;
479 ip4_address_t l_addr;
484 snat_protocol_t proto;
492 } snat_static_map_resolve_t;
496 /* Main lookup tables */
497 clib_bihash_8_8_t out2in;
498 clib_bihash_8_8_t in2out;
500 /* Endpoint dependent sessions lookup tables */
501 clib_bihash_16_8_t out2in_ed;
502 clib_bihash_16_8_t in2out_ed;
504 /* Find-a-user => src address lookup */
505 clib_bihash_8_8_t user_hash;
511 snat_session_t *sessions;
513 /* Pool of doubly-linked list elements */
514 dlist_elt_t *list_pool;
516 /* NAT thread index */
517 u32 snat_thread_index;
519 /* real thread index */
521 } snat_main_per_thread_data_t;
525 /* ICMP session match function */
526 typedef u32 (snat_icmp_match_function_t) (struct snat_main_s * sm,
527 vlib_node_runtime_t * node,
530 ip4_header_t * ip0, u8 * p_proto,
531 snat_session_key_t * p_value,
532 u8 * p_dont_translate, void *d,
535 /* Return worker thread index for given packet */
536 typedef u32 (snat_get_worker_function_t) (ip4_header_t * ip,
537 u32 rx_fib_index, u8 is_output);
539 /* NAT address and port allacotaion function */
540 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
544 snat_session_key_t * k,
546 u32 snat_thread_index);
548 typedef struct snat_main_s
550 /* ICMP session match functions */
551 snat_icmp_match_function_t *icmp_match_in2out_cb;
552 snat_icmp_match_function_t *icmp_match_out2in_cb;
554 /* Thread settings */
556 u32 first_worker_index;
558 snat_get_worker_function_t *worker_in2out_cb;
559 snat_get_worker_function_t *worker_out2in_cb;
563 /* Per thread data */
564 snat_main_per_thread_data_t *per_thread_data;
566 /* Find a static mapping by local */
567 clib_bihash_8_8_t static_mapping_by_local;
569 /* Find a static mapping by external */
570 clib_bihash_8_8_t static_mapping_by_external;
572 /* Static mapping pool */
573 snat_static_mapping_t *static_mappings;
576 snat_interface_t *interfaces;
577 snat_interface_t *output_feature_interfaces;
579 /* Vector of outside addresses */
580 snat_address_t *addresses;
581 /* Address and port allocation function */
582 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
583 /* Address and port allocation type */
584 nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
585 /* Port set parameters (MAP-E) */
589 /* Port range parameters */
593 /* vector of outside fibs */
594 nat_outside_fib_t *outside_fibs;
596 /* Vector of twice NAT addresses for extenal hosts */
597 snat_address_t *twice_nat_addresses;
599 /* sw_if_indices whose intfc addresses should be auto-added */
600 u32 *auto_add_sw_if_indices;
601 u32 *auto_add_sw_if_indices_twice_nat;
603 /* vector of interface address static mappings to resolve. */
604 snat_static_map_resolve_t *to_resolve;
606 /* Randomize port allocation order */
609 /* Worker handoff frame-queue index */
611 u32 fq_in2out_output_index;
615 u32 error_node_index;
617 /* handoff fq nodes */
618 u32 handoff_out2in_index;
619 u32 handoff_in2out_index;
620 u32 handoff_in2out_output_index;
622 /* respect feature arc nodes */
623 u32 pre_out2in_node_index;
624 u32 pre_in2out_node_index;
626 u32 in2out_node_index;
627 u32 in2out_output_node_index;
628 u32 in2out_fast_node_index;
629 u32 in2out_slowpath_node_index;
630 u32 in2out_slowpath_output_node_index;
631 u32 in2out_reass_node_index;
632 u32 ed_in2out_node_index;
633 u32 ed_in2out_slowpath_node_index;
634 u32 ed_in2out_reass_node_index;
635 u32 out2in_node_index;
636 u32 out2in_fast_node_index;
637 u32 out2in_reass_node_index;
638 u32 ed_out2in_node_index;
639 u32 ed_out2in_slowpath_node_index;
640 u32 ed_out2in_reass_node_index;
641 u32 det_in2out_node_index;
642 u32 det_out2in_node_index;
644 u32 hairpinning_node_index;
645 u32 hairpin_dst_node_index;
646 u32 hairpin_src_node_index;
647 u32 ed_hairpinning_node_index;
648 u32 ed_hairpin_dst_node_index;
649 u32 ed_hairpin_src_node_index;
652 /* Deterministic NAT mappings */
653 snat_det_map_t *det_maps;
655 /* If forwarding is enabled */
656 u8 forwarding_enabled;
658 /* Config parameters */
659 u8 static_mapping_only;
660 u8 static_mapping_connection_tracking;
663 u8 endpoint_dependent;
664 u32 translation_buckets;
665 u32 translation_memory_size;
666 u32 max_translations;
668 u32 user_memory_size;
669 u32 max_translations_per_user;
671 u32 outside_fib_index;
673 u32 inside_fib_index;
675 /* values of various timeouts */
677 u32 tcp_established_timeout;
678 u32 tcp_transitory_timeout;
681 /* TCP MSS clamping */
685 /* counters/gauges */
686 vlib_simple_counter_main_t total_users;
687 vlib_simple_counter_main_t total_sessions;
689 /* API message ID base */
693 vlib_log_class_t log_class;
698 vlib_main_t *vlib_main;
699 vnet_main_t *vnet_main;
700 ip4_main_t *ip4_main;
701 ip_lookup_main_t *ip4_lookup_main;
702 api_main_t *api_main;
709 } nat44_is_idle_session_ctx_t;
713 u32 cached_sw_if_index;
714 u32 cached_ip4_address;
717 extern snat_main_t snat_main;
719 // nat pre ed next_node feature classification
720 extern vlib_node_registration_t nat_default_node;
721 extern vlib_node_registration_t nat_pre_in2out_node;
722 extern vlib_node_registration_t nat_pre_out2in_node;
724 extern vlib_node_registration_t snat_in2out_node;
725 extern vlib_node_registration_t snat_in2out_output_node;
726 extern vlib_node_registration_t snat_out2in_node;
727 extern vlib_node_registration_t snat_in2out_fast_node;
728 extern vlib_node_registration_t snat_out2in_fast_node;
729 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
730 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
731 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
732 extern vlib_node_registration_t snat_det_in2out_node;
733 extern vlib_node_registration_t snat_det_out2in_node;
734 extern vlib_node_registration_t snat_hairpin_dst_node;
735 extern vlib_node_registration_t snat_hairpin_src_node;
736 extern vlib_node_registration_t nat44_ed_in2out_node;
737 extern vlib_node_registration_t nat44_ed_in2out_output_node;
738 extern vlib_node_registration_t nat44_ed_out2in_node;
739 extern vlib_node_registration_t nat44_ed_hairpin_dst_node;
740 extern vlib_node_registration_t nat44_ed_hairpin_src_node;
741 extern vlib_node_registration_t nat44_ed_in2out_worker_handoff_node;
742 extern vlib_node_registration_t nat44_ed_in2out_output_worker_handoff_node;
743 extern vlib_node_registration_t nat44_ed_out2in_worker_handoff_node;
745 /* format functions */
746 format_function_t format_snat_user;
747 format_function_t format_snat_static_mapping;
748 format_function_t format_snat_static_map_to_resolve;
749 format_function_t format_snat_session;
750 format_function_t format_det_map_ses;
751 format_function_t format_snat_key;
752 format_function_t format_static_mapping_key;
753 format_function_t format_snat_protocol;
754 format_function_t format_nat_addr_and_port_alloc_alg;
755 format_function_t format_nat44_reass_trace;
756 /* unformat functions */
757 unformat_function_t unformat_snat_protocol;
759 /** \brief Check if SNAT session is created from static mapping.
760 @param s SNAT session
761 @return 1 if SNAT session is created from static mapping otherwise 0
763 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
765 /** \brief Check if SNAT session for unknown protocol.
766 @param s SNAT session
767 @return 1 if SNAT session for unknown protocol otherwise 0
769 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
771 /** \brief Check if NAT session is twice NAT.
773 @return 1 if NAT session is twice NAT
775 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
777 /** \brief Check if NAT session is load-balancing.
779 @return 1 if NAT session is load-balancing
781 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
783 /** \brief Check if NAT session is forwarding bypass.
785 @return 1 if NAT session is load-balancing
787 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
789 /** \brief Check if NAT session is endpoint dependent.
791 @return 1 if NAT session is endpoint dependent
793 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
795 /** \brief Check if NAT session has affinity record.
797 @return 1 if NAT session has affinity record
799 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
801 /** \brief Check if NAT interface is inside.
802 @param i NAT interfce
803 @return 1 if inside interface
805 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
807 /** \brief Check if NAT interface is outside.
808 @param i NAT interfce
809 @return 1 if outside interface
811 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
813 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
815 @return 1 if session is closed
817 #define nat44_is_ses_closed(s) s->state == 0xf
819 /** \brief Check if NAT static mapping is address only (1:1NAT).
820 @param sm NAT static mapping
821 @return 1 if 1:1NAT, 0 if 1:1NAPT
823 #define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY)
825 /** \brief Check if NAT static mapping match only out2in direction.
826 @param sm NAT static mapping
827 @return 1 if rule match only out2in direction
829 #define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY)
831 /** \brief Check if NAT static mapping is identity NAT.
832 @param sm NAT static mapping
833 @return 1 if identity NAT
835 #define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT)
837 /** \brief Check if NAT static mapping is load-balancing.
838 @param sm NAT static mapping
839 @return 1 if load-balancing
841 #define is_lb_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_LB)
843 /** \brief Check if client initiating TCP connection (received SYN from client)
845 @return 1 if client initiating TCP connection
847 #define tcp_is_init(t) ((t->flags & TCP_FLAG_SYN) && !(t->flags & TCP_FLAG_ACK))
850 #define nat_log_err(...) \
851 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
852 #define nat_log_warn(...) \
853 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
854 #define nat_log_notice(...) \
855 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
856 #define nat_log_info(...) \
857 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
858 #define nat_log_debug(...)\
859 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
861 /* NAT API Logging Levels */
862 #define foreach_nat_log_level \
865 _(0x02, LOG_WARNING) \
866 _(0x03, LOG_NOTICE) \
870 typedef enum nat_log_level_t_
872 #define _(n,f) SNAT_##f = n,
873 foreach_nat_log_level
877 #define nat_elog(_level, _str) \
880 snat_main_t *sm = &snat_main; \
881 if (PREDICT_FALSE (sm->log_level >= _level)) \
883 ELOG_TYPE_DECLARE (e) = \
885 .format = "nat-msg " _str, \
888 ELOG_DATA (&sm->vlib_main->elog_main, e); \
892 #define nat_elog_addr(_level, _str, _addr) \
895 if (PREDICT_FALSE (sm->log_level >= _level)) \
897 ELOG_TYPE_DECLARE (e) = \
899 .format = "nat-msg " _str " %d.%d.%d.%d", \
900 .format_args = "i1i1i1i1", \
909 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
910 ed->oct4 = _addr >> 24; \
911 ed->oct3 = _addr >> 16; \
912 ed->oct2 = _addr >> 8; \
917 #define nat_elog_debug_handoff(_str, _tid, _fib, _src, _dst) \
920 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
922 ELOG_TYPE_DECLARE (e) = \
924 .format = "nat-msg " _str " ip src: %d.%d.%d.%d dst: %d.%d.%d.%d" \
925 " tid from: %d to: %d fib: %d", \
926 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
942 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
943 ed->src_oct1 = _src >> 24; \
944 ed->src_oct2 = _src >> 16; \
945 ed->src_oct3 = _src >> 8; \
946 ed->src_oct4 = _src; \
947 ed->dst_oct1 = _dst >> 24; \
948 ed->dst_oct2 = _dst >> 16; \
949 ed->dst_oct3 = _dst >> 8; \
950 ed->dst_oct4 = _dst; \
951 ed->ftid = vlib_get_thread_index (); \
957 #define nat_elog_debug_handoff_v2(_str, _prt, _fib, _src, _dst) \
960 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
962 ELOG_TYPE_DECLARE (e) = \
964 .format = "nat-msg " _str " ip_src:%d.%d.%d.%d ip_dst:%d.%d.%d.%d" \
965 " tid:%d prt:%d fib:%d", \
966 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
982 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
983 ed->src_oct1 = _src >> 24; \
984 ed->src_oct2 = _src >> 16; \
985 ed->src_oct3 = _src >> 8; \
986 ed->src_oct4 = _src; \
987 ed->dst_oct1 = _dst >> 24; \
988 ed->dst_oct2 = _dst >> 16; \
989 ed->dst_oct3 = _dst >> 8; \
990 ed->dst_oct4 = _dst; \
991 ed->tid = vlib_get_thread_index (); \
997 #define nat_elog_X1(_level, _fmt, _arg, _val1) \
1000 snat_main_t *sm = &snat_main; \
1001 if (PREDICT_FALSE (sm->log_level >= _level)) \
1003 ELOG_TYPE_DECLARE (e) = \
1005 .format = "nat-msg " _fmt, \
1006 .format_args = _arg, \
1008 CLIB_PACKED(struct \
1010 typeof (_val1) val1; \
1012 ed = ELOG_DATA (&sm->vlib_main->elog_main, e); \
1017 #define nat_elog_notice(nat_elog_str) \
1018 nat_elog(SNAT_LOG_INFO, "[notice] " nat_elog_str)
1019 #define nat_elog_warn(nat_elog_str) \
1020 nat_elog(SNAT_LOG_WARNING, "[warning] " nat_elog_str)
1021 #define nat_elog_err(nat_elog_str) \
1022 nat_elog(SNAT_LOG_ERROR, "[error] " nat_elog_str)
1023 #define nat_elog_debug(nat_elog_str) \
1024 nat_elog(SNAT_LOG_DEBUG, "[debug] " nat_elog_str)
1025 #define nat_elog_info(nat_elog_str) \
1026 nat_elog(SNAT_LOG_INFO, "[info] " nat_elog_str)
1028 #define nat_elog_notice_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1029 nat_elog_X1(SNAT_LOG_NOTICE, "[notice] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1030 #define nat_elog_warn_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1031 nat_elog_X1(SNAT_LOG_WARNING, "[warning] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1032 #define nat_elog_err_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1033 nat_elog_X1(SNAT_LOG_ERROR, "[error] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1034 #define nat_elog_debug_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1035 nat_elog_X1(SNAT_LOG_DEBUG, "[debug] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1036 #define nat_elog_info_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1037 nat_elog_X1(SNAT_LOG_INFO, "[info] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1039 /* ICMP session match functions */
1040 u32 icmp_match_in2out_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1041 u32 thread_index, vlib_buffer_t * b0,
1042 ip4_header_t * ip0, u8 * p_proto,
1043 snat_session_key_t * p_value,
1044 u8 * p_dont_translate, void *d, void *e);
1045 u32 icmp_match_in2out_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1046 u32 thread_index, vlib_buffer_t * b0,
1047 ip4_header_t * ip0, u8 * p_proto,
1048 snat_session_key_t * p_value,
1049 u8 * p_dont_translate, void *d, void *e);
1050 u32 icmp_match_out2in_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1051 u32 thread_index, vlib_buffer_t * b0,
1052 ip4_header_t * ip0, u8 * p_proto,
1053 snat_session_key_t * p_value,
1054 u8 * p_dont_translate, void *d, void *e);
1055 u32 icmp_match_out2in_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1056 u32 thread_index, vlib_buffer_t * b0,
1057 ip4_header_t * ip0, u8 * p_proto,
1058 snat_session_key_t * p_value,
1059 u8 * p_dont_translate, void *d, void *e);
1061 /* ICMP deterministic NAT session match functions */
1062 u32 icmp_match_out2in_det (snat_main_t * sm, vlib_node_runtime_t * node,
1063 u32 thread_index, vlib_buffer_t * b0,
1064 ip4_header_t * ip0, u8 * p_proto,
1065 snat_session_key_t * p_value,
1066 u8 * p_dont_translate, void *d, void *e);
1067 u32 icmp_match_in2out_det (snat_main_t * sm, vlib_node_runtime_t * node,
1068 u32 thread_index, vlib_buffer_t * b0,
1069 ip4_header_t * ip0, u8 * p_proto,
1070 snat_session_key_t * p_value,
1071 u8 * p_dont_translate, void *d, void *e);
1073 /* ICMP endpoint-dependent session match functions */
1074 u32 icmp_match_out2in_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1075 u32 thread_index, vlib_buffer_t * b0,
1076 ip4_header_t * ip0, u8 * p_proto,
1077 snat_session_key_t * p_value,
1078 u8 * p_dont_translate, void *d, void *e);
1079 u32 icmp_match_in2out_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1080 u32 thread_index, vlib_buffer_t * b0,
1081 ip4_header_t * ip0, u8 * p_proto,
1082 snat_session_key_t * p_value,
1083 u8 * p_dont_translate, void *d, void *e);
1085 u32 icmp_in2out (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1086 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1087 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1090 u32 icmp_out2in (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1091 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1092 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1095 /* hairpinning functions */
1096 u32 snat_icmp_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1097 ip4_header_t * ip0, icmp46_header_t * icmp0,
1099 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1101 void nat44_ed_hairpinning_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1103 int snat_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1104 ip4_header_t * ip0, udp_header_t * udp0,
1105 tcp_header_t * tcp0, u32 proto0, int is_ed);
1106 void nat44_reass_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1107 ip4_header_t * ip0, u16 sport, u16 dport,
1108 u32 proto0, int is_ed);
1110 /* Call back functions for clib_bihash_add_or_overwrite_stale */
1111 int nat44_i2o_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1112 int nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1113 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1114 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1117 * @brief Increment IPv4 address
1119 void increment_v4_address (ip4_address_t * a);
1122 * @brief Add external address to NAT44 pool
1124 * @param addr IPv4 address
1125 * @param vrf_id VRF id of tenant, ~0 means independent of VRF
1126 * @param twice_nat 1 if twice NAT address
1128 * @return 0 on success, non-zero value otherwise
1130 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
1134 * @brief Delete external address from NAT44 pool
1136 * @param addr IPv4 address
1137 * @param delete_sm 1 if delete static mapping using address
1138 * @param twice_nat 1 if twice NAT address
1140 * @return 0 on success, non-zero value otherwise
1142 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1146 * @brief Add/delete external address to FIB DPO (out2in DPO mode)
1148 * @param addr IPv4 address
1149 * @param is_add 1 = add, 0 = delete
1151 * @return 0 on success, non-zero value otherwise
1153 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
1156 * @brief Add/delete NAT44 static mapping
1158 * @param l_addr local IPv4 address
1159 * @param e_addr external IPv4 address
1160 * @param l_port local port number
1161 * @param e_port external port number
1162 * @param vrf_id local VRF ID
1163 * @param addr_only 1 = 1:1NAT, 0 = 1:1NAPT
1164 * @param sw_if_index use interface address as external IPv4 address
1165 * @param proto L4 protocol
1166 * @param is_add 1 = add, 0 = delete
1167 * @param twice_nat twice-nat mode
1168 * @param out2in_only if 1 rule match only out2in direction
1169 * @param tag opaque string tag
1170 * @param identity_nat identity NAT
1172 * @return 0 on success, non-zero value otherwise
1174 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
1175 u16 l_port, u16 e_port, u32 vrf_id,
1176 int addr_only, u32 sw_if_index,
1177 snat_protocol_t proto, int is_add,
1178 twice_nat_type_t twice_nat, u8 out2in_only,
1179 u8 * tag, u8 identity_nat);
1182 * @brief Add/delete static mapping with load-balancing (multiple backends)
1184 * @param e_addr external IPv4 address
1185 * @param e_port external port number
1186 * @param proto L4 protocol
1187 * @param locals list of local backends
1188 * @param is_add 1 = add, 0 = delete
1189 * @param twice_nat twice-nat mode
1190 * @param out2in_only if 1 rule match only out2in direction
1191 * @param tag opaque string tag
1192 * @param affinity 0 = disabled, otherwise client IP affinity sticky time
1194 * @return 0 on success, non-zero value otherwise
1196 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1197 snat_protocol_t proto,
1198 nat44_lb_addr_port_t * locals, u8 is_add,
1199 twice_nat_type_t twice_nat,
1200 u8 out2in_only, u8 * tag, u32 affinity);
1202 int nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1203 ip4_address_t l_addr, u16 l_port,
1204 snat_protocol_t proto, u32 vrf_id,
1205 u8 probability, u8 is_add);
1207 clib_error_t *snat_api_init (vlib_main_t * vm, snat_main_t * sm);
1210 * @brief Set NAT plugin workers
1212 * @param bitmap NAT workers bitmap
1214 * @return 0 on success, non-zero value otherwise
1216 int snat_set_workers (uword * bitmap);
1219 * @brief Enable/disable NAT44 feature on the interface
1221 * @param sw_if_index software index of the interface
1222 * @param is_inside 1 = inside, 0 = outside
1223 * @param is_del 1 = delete, 0 = add
1225 * @return 0 on success, non-zero value otherwise
1227 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
1230 * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
1232 * @param sw_if_index software index of the interface
1233 * @param is_inside 1 = inside, 0 = outside
1234 * @param is_del 1 = delete, 0 = add
1236 * @return 0 on success, non-zero value otherwise
1238 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
1242 * @brief Add/delete NAT44 pool address from specific interfce
1244 * @param sw_if_index software index of the interface
1245 * @param is_del 1 = delete, 0 = add
1246 * @param twice_nat 1 = twice NAT address for extenal hosts
1248 * @return 0 on success, non-zero value otherwise
1250 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
1254 * @brief Delete NAT44 session
1256 * @param addr IPv4 address
1257 * @param port L4 port number
1258 * @param proto L4 protocol
1259 * @param vrf_id VRF ID
1260 * @param is_in 1 = inside network address and port pair, 0 = outside
1262 * @return 0 on success, non-zero value otherwise
1264 int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1265 snat_protocol_t proto, u32 vrf_id, int is_in);
1268 * @brief Delete NAT44 endpoint-dependent session
1270 * @param addr IPv4 address
1271 * @param port L4 port number
1272 * @param proto L4 protocol
1273 * @param vrf_id VRF ID
1274 * @param is_in 1 = inside network address and port pair, 0 = outside
1276 * @return 0 on success, non-zero value otherwise
1278 int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1279 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
1280 u32 vrf_id, int is_in);
1283 * @brief Free NAT44 session data (lookup keys, external addrres port)
1285 * @param s NAT session
1286 * @param thread_index thread index
1287 * @param is_ha is HA event
1289 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
1290 u32 thread_index, u8 is_ha);
1293 * @brief Find or create NAT user
1295 * @param addr IPv4 address
1296 * @param fib_index FIB table index
1297 * @param thread_index thread index
1299 * @return NAT user data structure on success otherwise zero value
1301 snat_user_t *nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr,
1302 u32 fib_index, u32 thread_index);
1305 * @brief Allocate new NAT session or recycle last used
1308 * @param thread_index thread index
1310 * @return session data structure on success otherwise zero value
1312 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
1314 u32 thread_index, f64 now);
1317 * @brief Allocate NAT endpoint-dependent session
1320 * @param thread_index thread index
1322 * @return session data structure on success otherwise zero value
1324 snat_session_t *nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u,
1325 u32 thread_index, f64 now);
1328 * @brief Set address and port assignment algorithm for MAP-E CE
1330 * @param psid Port Set Identifier value
1331 * @param psid_offset number of offset bits
1332 * @param psid_length length of PSID
1334 void nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset,
1338 * @brief Set address and port assignment algorithm for port range
1340 * @param start_port beginning of the port range
1341 * @param end_port end of the port range
1343 void nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port);
1346 * @brief Set address and port assignment algorithm to default/standard
1348 void nat_set_alloc_addr_and_port_default (void);
1351 * @brief Free outside address and port pair
1353 * @param addresses vector of outside addresses
1354 * @param thread_index thread index
1355 * @param k address, port and protocol
1357 void snat_free_outside_address_and_port (snat_address_t * addresses,
1359 snat_session_key_t * k);
1362 * @brief Alloc outside address and port
1364 * @param addresses vector of outside addresses
1365 * @param fib_index FIB table index
1366 * @param thread_index thread index
1367 * @param k allocated address and port pair
1368 * @param port_per_thread number of ports per threead
1369 * @param snat_thread_index NAT thread index
1371 * @return 0 on success, non-zero value otherwise
1373 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
1376 snat_session_key_t * k,
1377 u16 port_per_thread,
1378 u32 snat_thread_index);
1381 * @brief Match NAT44 static mapping.
1383 * @param match address and port to match
1384 * @param mapping external/local address and port of the matched mapping
1385 * @param by_external if 0 match by local address otherwise match by external
1387 * @param is_addr_only 1 if matched mapping is address only
1388 * @param twice_nat matched mapping is twice NAT type
1389 * @param lb 1 if matched mapping is load-balanced
1390 * @param ext_host_addr external host address
1392 * @returns 0 if match found otherwise 1.
1394 int snat_static_mapping_match (snat_main_t * sm,
1395 snat_session_key_t match,
1396 snat_session_key_t * mapping,
1399 twice_nat_type_t * twice_nat,
1401 ip4_address_t * ext_host_addr,
1402 u8 * is_identity_nat);
1405 * @brief Add/del NAT address to FIB.
1407 * Add the external NAT address to the FIB as receive entries. This ensures
1408 * that VPP will reply to ARP for this address and we don't need to enable
1409 * proxy ARP on the outside interface.
1411 * @param addr IPv4 address
1412 * @param plen address prefix length
1413 * @param sw_if_index software index of the outside interface
1414 * @param is_add 0 = delete, 1 = add.
1416 void snat_add_del_addr_to_fib (ip4_address_t * addr,
1417 u8 p_len, u32 sw_if_index, int is_add);
1420 * Why is this here? Because we don't need to touch this layer to
1421 * simply reply to an icmp. We need to change id to a unique
1422 * value to NAT an echo request/reply.
1429 } icmp_echo_header_t;
1433 u16 src_port, dst_port;
1436 #endif /* __included_nat_h__ */
1439 * fd.io coding-style-patch-verification: ON
1442 * eval: (c-set-style "gnu")