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>
34 #include <vppinfra/bihash_16_8.h>
36 /* default session timeouts */
37 #define SNAT_UDP_TIMEOUT 300
38 #define SNAT_TCP_TRANSITORY_TIMEOUT 240
39 #define SNAT_TCP_ESTABLISHED_TIMEOUT 7440
40 #define SNAT_ICMP_TIMEOUT 60
42 /* number of worker handoff frame queue elements */
43 #define NAT_FQ_NELTS 64
45 /* NAT buffer flags */
46 #define SNAT_FLAG_HAIRPINNING (1 << 0)
54 NAT_NEXT_IN2OUT_ED_FAST_PATH,
55 NAT_NEXT_IN2OUT_ED_SLOW_PATH,
56 NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH,
57 NAT_NEXT_OUT2IN_ED_FAST_PATH,
58 NAT_NEXT_OUT2IN_ED_SLOW_PATH,
68 STATIC_ASSERT (sizeof (nat_buffer_opaque_t) <=
69 STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
70 "Custom meta-data too large for vnet_buffer_opaque_t");
72 #define nat_buffer_opaque(b) \
73 ((nat_buffer_opaque_t *)((u8 *)((b)->opaque) + \
74 STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))*/
76 /* session key (4-tuple) */
85 u16 protocol:3, fib_index:13;
91 /* endpoint-dependent session key (6-tuple) */
100 u32 proto:8, fib_index:24;
108 /* deterministic session outside key */
115 ip4_address_t ext_host_addr;
121 } snat_det_out_key_t;
123 /* user (internal host) key */
137 /* NAT API Configuration flags */
138 #define foreach_nat_config_flag \
139 _(0x01, IS_TWICE_NAT) \
140 _(0x02, IS_SELF_TWICE_NAT) \
141 _(0x04, IS_OUT2IN_ONLY) \
142 _(0x08, IS_ADDR_ONLY) \
143 _(0x10, IS_OUTSIDE) \
146 _(0x80, IS_EXT_HOST_VALID) \
148 typedef enum nat_config_flags_t_
150 #define _(n,f) NAT_API_##f = n,
151 foreach_nat_config_flag
153 } nat_config_flags_t;
155 /* External address and port allocation modes */
156 #define foreach_nat_addr_and_port_alloc_alg \
157 _(0, DEFAULT, "default") \
158 _(1, MAPE, "map-e") \
159 _(2, RANGE, "port-range")
163 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
164 foreach_nat_addr_and_port_alloc_alg
166 } nat_addr_and_port_alloc_alg_t;
169 /* Supported L4 protocols */
170 #define foreach_snat_protocol \
171 _(UDP, 0, udp, "udp") \
172 _(TCP, 1, tcp, "tcp") \
173 _(ICMP, 2, icmp, "icmp")
177 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
178 foreach_snat_protocol
184 #define foreach_snat_session_state \
185 _(0, UNKNOWN, "unknown") \
186 _(1, UDP_ACTIVE, "udp-active") \
187 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
188 _(3, TCP_ESTABLISHED, "tcp-established") \
189 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
190 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
191 _(6, TCP_CLOSING, "tcp-closing") \
192 _(7, TCP_LAST_ACK, "tcp-last-ack") \
193 _(8, TCP_CLOSED, "tcp-closed") \
194 _(9, ICMP_ACTIVE, "icmp-active")
198 #define _(v, N, s) SNAT_SESSION_##N = v,
199 foreach_snat_session_state
201 } snat_session_state_t;
203 #define foreach_nat_in2out_ed_error \
204 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
205 _(IN2OUT_PACKETS, "good in2out packets processed") \
206 _(OUT_OF_PORTS, "out of ports") \
207 _(BAD_ICMP_TYPE, "unsupported ICMP type") \
208 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
209 _(MAX_USER_SESS_EXCEEDED, "max user sessions exceeded") \
210 _(DROP_FRAGMENT, "drop fragment") \
211 _(CANNOT_CREATE_USER, "cannot create NAT user") \
212 _(NON_SYN, "non-SYN packet try to create session") \
213 _(TCP_PACKETS, "TCP packets") \
214 _(TCP_CLOSED, "drops due to TCP in transitory timeout") \
215 _(UDP_PACKETS, "UDP packets") \
216 _(ICMP_PACKETS, "ICMP packets") \
217 _(OTHER_PACKETS, "other protocol packets") \
218 _(FRAGMENTS, "fragments") \
219 _(CACHED_FRAGMENTS, "cached fragments") \
220 _(PROCESSED_FRAGMENTS, "processed fragments")
224 #define _(sym,str) NAT_IN2OUT_ED_ERROR_##sym,
225 foreach_nat_in2out_ed_error
227 NAT_IN2OUT_ED_N_ERROR,
228 } nat_in2out_ed_error_t;
230 #define foreach_nat_out2in_ed_error \
231 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
232 _(OUT2IN_PACKETS, "good out2in packets processed") \
233 _(OUT_OF_PORTS, "out of ports") \
234 _(BAD_ICMP_TYPE, "unsupported ICMP type") \
235 _(NO_TRANSLATION, "no translation") \
236 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
237 _(MAX_USER_SESS_EXCEEDED, "max user sessions exceeded") \
238 _(DROP_FRAGMENT, "drop fragment") \
239 _(CANNOT_CREATE_USER, "cannot create NAT user") \
240 _(NON_SYN, "non-SYN packet try to create session") \
241 _(TCP_PACKETS, "TCP packets") \
242 _(TCP_CLOSED, "drops due to TCP in transitory timeout") \
243 _(UDP_PACKETS, "UDP packets") \
244 _(ICMP_PACKETS, "ICMP packets") \
245 _(OTHER_PACKETS, "other protocol packets") \
246 _(FRAGMENTS, "fragments") \
247 _(CACHED_FRAGMENTS, "cached fragments") \
248 _(PROCESSED_FRAGMENTS, "processed fragments")
252 #define _(sym,str) NAT_OUT2IN_ED_ERROR_##sym,
253 foreach_nat_out2in_ed_error
255 NAT_OUT2IN_ED_N_ERROR,
256 } nat_out2in_ed_error_t;
259 /* Endpoint dependent TCP session state */
260 #define NAT44_SES_I2O_FIN 1
261 #define NAT44_SES_O2I_FIN 2
262 #define NAT44_SES_I2O_FIN_ACK 4
263 #define NAT44_SES_O2I_FIN_ACK 8
264 #define NAT44_SES_I2O_SYN 16
265 #define NAT44_SES_O2I_SYN 32
266 #define NAT44_SES_RST 64
269 #define SNAT_SESSION_FLAG_STATIC_MAPPING 1
270 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO 2
271 #define SNAT_SESSION_FLAG_LOAD_BALANCING 4
272 #define SNAT_SESSION_FLAG_TWICE_NAT 8
273 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT 16
274 #define SNAT_SESSION_FLAG_FWD_BYPASS 32
275 #define SNAT_SESSION_FLAG_AFFINITY 64
276 #define SNAT_SESSION_FLAG_OUTPUT_FEATURE 128
278 /* NAT interface flags */
279 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
280 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
282 /* Static mapping flags */
283 #define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY 1
284 #define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY 2
285 #define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4
286 #define NAT_STATIC_MAPPING_FLAG_LB 8
289 typedef CLIB_PACKED(struct
291 /* Outside network key */
292 snat_session_key_t out2in;
294 /* Inside network key */
295 snat_session_key_t in2out;
300 /* Per-user translations */
302 u32 per_user_list_head_index;
304 /* index in global LRU list */
305 u32 global_lru_index;
308 /* Last heard timer */
311 /* Last HA refresh */
312 f64 ha_last_refreshed;
318 /* External host address and port */
319 ip4_address_t ext_host_addr;
322 /* External host address and port after translation */
323 ip4_address_t ext_host_nat_addr;
324 u16 ext_host_nat_port;
326 /* TCP session state */
330 u32 tcp_close_timestamp;
342 u32 sessions_per_user_list_head_index;
352 #define _(N, i, n, s) \
353 u16 busy_##n##_ports; \
354 u16 * busy_##n##_ports_per_thread; \
355 u32 busy_##n##_port_refcounts[65535];
356 foreach_snat_protocol
369 /* Inside network port */
371 /* Outside network address and port */
372 snat_det_out_key_t out;
377 } snat_det_session_t;
381 /* inside IP address range */
382 ip4_address_t in_addr;
384 /* outside IP address range */
385 ip4_address_t out_addr;
387 /* inside IP addresses / outside IP addresses */
389 /* number of ports available to internal host */
391 /* session counter */
393 /* vector of sessions */
394 snat_det_session_t *sessions;
399 /* backend IP address */
401 /* backend port number */
403 /* probability of the backend to be randomly matched */
406 /* backend FIB table */
409 } nat44_lb_addr_port_t;
413 /* twice-nat disabled */
415 /* twice-nat enabled */
417 /* twice-nat only when src IP equals dst IP after translation */
423 /* no load-balancing */
427 /* load-balancing with affinity */
433 /* local IP address */
434 ip4_address_t local_addr;
435 /* external IP address */
436 ip4_address_t external_addr;
442 twice_nat_type_t twice_nat;
443 /* local FIB table */
447 snat_protocol_t proto;
448 /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
450 /* worker threads used by backends/local host */
452 /* opaque string tag */
454 /* backends for load-balancing mode */
455 nat44_lb_addr_port_t *locals;
456 /* affinity per service lis */
457 u32 affinity_per_service_list_head_index;
460 } snat_static_mapping_t;
470 ip4_address_t l_addr;
475 snat_protocol_t proto;
483 } snat_static_map_resolve_t;
487 /* Main lookup tables */
488 clib_bihash_8_8_t out2in;
489 clib_bihash_8_8_t in2out;
491 /* Endpoint dependent sessions lookup tables */
492 clib_bihash_16_8_t out2in_ed;
493 clib_bihash_16_8_t in2out_ed;
495 /* Find-a-user => src address lookup */
496 clib_bihash_8_8_t user_hash;
502 snat_session_t *sessions;
504 /* Pool of doubly-linked list elements */
505 dlist_elt_t *list_pool;
507 /* LRU session list - head is stale, tail is fresh */
508 dlist_elt_t *global_lru_pool;
509 u32 global_lru_head_index;
511 /* NAT thread index */
512 u32 snat_thread_index;
514 /* real thread index */
517 } snat_main_per_thread_data_t;
521 /* ICMP session match function */
522 typedef u32 (snat_icmp_match_function_t) (struct snat_main_s * sm,
523 vlib_node_runtime_t * node,
526 ip4_header_t * ip0, u8 * p_proto,
527 snat_session_key_t * p_value,
528 u8 * p_dont_translate, void *d,
531 /* Return worker thread index for given packet */
532 typedef u32 (snat_get_worker_in2out_function_t) (ip4_header_t * ip,
536 typedef u32 (snat_get_worker_out2in_function_t) (vlib_buffer_t * b,
541 /* NAT address and port allacotaion function */
542 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
546 snat_session_key_t * k,
548 u32 snat_thread_index);
551 typedef struct snat_main_s
553 /* ICMP session match functions */
554 snat_icmp_match_function_t *icmp_match_in2out_cb;
555 snat_icmp_match_function_t *icmp_match_out2in_cb;
557 /* Thread settings */
559 u32 first_worker_index;
561 snat_get_worker_in2out_function_t *worker_in2out_cb;
562 snat_get_worker_out2in_function_t *worker_out2in_cb;
566 /* Per thread data */
567 snat_main_per_thread_data_t *per_thread_data;
569 /* Find a static mapping by local */
570 clib_bihash_8_8_t static_mapping_by_local;
572 /* Find a static mapping by external */
573 clib_bihash_8_8_t static_mapping_by_external;
575 /* Static mapping pool */
576 snat_static_mapping_t *static_mappings;
579 snat_interface_t *interfaces;
580 snat_interface_t *output_feature_interfaces;
582 /* Vector of outside addresses */
583 snat_address_t *addresses;
584 /* Address and port allocation function */
585 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
586 /* Address and port allocation type */
587 nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
588 /* Port set parameters (MAP-E) */
592 /* Port range parameters */
596 /* vector of outside fibs */
597 nat_outside_fib_t *outside_fibs;
599 /* Vector of twice NAT addresses for extenal hosts */
600 snat_address_t *twice_nat_addresses;
602 /* sw_if_indices whose intfc addresses should be auto-added */
603 u32 *auto_add_sw_if_indices;
604 u32 *auto_add_sw_if_indices_twice_nat;
606 /* vector of interface address static mappings to resolve. */
607 snat_static_map_resolve_t *to_resolve;
609 /* Randomize port allocation order */
612 /* Worker handoff frame-queue index */
614 u32 fq_in2out_output_index;
618 u32 error_node_index;
620 /* handoff fq nodes */
621 u32 handoff_out2in_index;
622 u32 handoff_in2out_index;
623 u32 handoff_in2out_output_index;
625 /* respect feature arc nodes */
626 u32 pre_out2in_node_index;
627 u32 pre_in2out_node_index;
629 u32 in2out_node_index;
630 u32 in2out_output_node_index;
631 u32 in2out_fast_node_index;
632 u32 in2out_slowpath_node_index;
633 u32 in2out_slowpath_output_node_index;
634 u32 ed_in2out_node_index;
635 u32 ed_in2out_slowpath_node_index;
636 u32 out2in_node_index;
637 u32 out2in_fast_node_index;
638 u32 ed_out2in_node_index;
639 u32 ed_out2in_slowpath_node_index;
640 u32 det_in2out_node_index;
641 u32 det_out2in_node_index;
643 u32 hairpinning_node_index;
644 u32 hairpin_dst_node_index;
645 u32 hairpin_src_node_index;
646 u32 ed_hairpinning_node_index;
647 u32 ed_hairpin_dst_node_index;
648 u32 ed_hairpin_src_node_index;
651 /* Deterministic NAT mappings */
652 snat_det_map_t *det_maps;
654 /* If forwarding is enabled */
655 u8 forwarding_enabled;
657 /* Config parameters */
658 u8 static_mapping_only;
659 u8 static_mapping_connection_tracking;
662 u8 endpoint_dependent;
663 u32 translation_buckets;
664 uword translation_memory_size;
665 u32 max_translations;
667 uword user_memory_size;
668 u32 max_translations_per_user;
670 u32 outside_fib_index;
672 u32 inside_fib_index;
674 /* values of various timeouts */
677 u32 tcp_transitory_timeout;
678 u32 tcp_established_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_worker_handoff_node;
728 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
729 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
730 extern vlib_node_registration_t snat_det_in2out_node;
731 extern vlib_node_registration_t snat_det_out2in_node;
732 extern vlib_node_registration_t nat44_ed_in2out_node;
733 extern vlib_node_registration_t nat44_ed_in2out_output_node;
734 extern vlib_node_registration_t nat44_ed_out2in_node;
736 extern fib_source_t nat_fib_src_hi;
737 extern fib_source_t nat_fib_src_low;
739 /* format functions */
740 format_function_t format_snat_user;
741 format_function_t format_snat_user_v2;
742 format_function_t format_snat_static_mapping;
743 format_function_t format_snat_static_map_to_resolve;
744 format_function_t format_snat_session;
745 format_function_t format_det_map_ses;
746 format_function_t format_snat_key;
747 format_function_t format_static_mapping_key;
748 format_function_t format_snat_protocol;
749 format_function_t format_nat_addr_and_port_alloc_alg;
750 /* unformat functions */
751 unformat_function_t unformat_snat_protocol;
753 /** \brief Check if SNAT session is created from static mapping.
754 @param s SNAT session
755 @return 1 if SNAT session is created from static mapping otherwise 0
757 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
759 /** \brief Check if SNAT session for unknown protocol.
760 @param s SNAT session
761 @return 1 if SNAT session for unknown protocol otherwise 0
763 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
765 /** \brief Check if NAT session is twice NAT.
767 @return 1 if NAT session is twice NAT
769 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
771 /** \brief Check if NAT session is load-balancing.
773 @return 1 if NAT session is load-balancing
775 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
777 /** \brief Check if NAT session is forwarding bypass.
779 @return 1 if NAT session is load-balancing
781 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
783 /** \brief Check if NAT session is endpoint dependent.
785 @return 1 if NAT session is endpoint dependent
787 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
789 /** \brief Check if NAT session has affinity record.
791 @return 1 if NAT session has affinity record
793 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
795 /** \brief Check if NAT interface is inside.
796 @param i NAT interfce
797 @return 1 if inside interface
799 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
801 /** \brief Check if NAT interface is outside.
802 @param i NAT interfce
803 @return 1 if outside interface
805 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
807 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
809 @return 1 if session is closed
811 #define nat44_is_ses_closed(s) s->state == 0xf
813 /** \brief Check if NAT static mapping is address only (1:1NAT).
814 @param sm NAT static mapping
815 @return 1 if 1:1NAT, 0 if 1:1NAPT
817 #define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY)
819 /** \brief Check if NAT static mapping match only out2in direction.
820 @param sm NAT static mapping
821 @return 1 if rule match only out2in direction
823 #define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY)
825 /** \brief Check if NAT static mapping is identity NAT.
826 @param sm NAT static mapping
827 @return 1 if identity NAT
829 #define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT)
831 /** \brief Check if NAT static mapping is load-balancing.
832 @param sm NAT static mapping
833 @return 1 if load-balancing
835 #define is_lb_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_LB)
837 /** \brief Check if client initiating TCP connection (received SYN from client)
839 @return 1 if client initiating TCP connection
842 tcp_flags_is_init (u8 f)
844 return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK);
848 #define nat_log_err(...) \
849 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
850 #define nat_log_warn(...) \
851 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
852 #define nat_log_notice(...) \
853 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
854 #define nat_log_info(...) \
855 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
856 #define nat_log_debug(...)\
857 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
859 /* NAT API Logging Levels */
860 #define foreach_nat_log_level \
863 _(0x02, LOG_WARNING) \
864 _(0x03, LOG_NOTICE) \
868 typedef enum nat_log_level_t_
870 #define _(n,f) SNAT_##f = n,
871 foreach_nat_log_level
875 #define nat_elog(_level, _str) \
878 snat_main_t *sm = &snat_main; \
879 if (PREDICT_FALSE (sm->log_level >= _level)) \
881 ELOG_TYPE_DECLARE (e) = \
883 .format = "nat-msg " _str, \
886 ELOG_DATA (&sm->vlib_main->elog_main, e); \
890 #define nat_elog_addr(_level, _str, _addr) \
893 if (PREDICT_FALSE (sm->log_level >= _level)) \
895 ELOG_TYPE_DECLARE (e) = \
897 .format = "nat-msg " _str " %d.%d.%d.%d", \
898 .format_args = "i1i1i1i1", \
907 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
908 ed->oct4 = _addr >> 24; \
909 ed->oct3 = _addr >> 16; \
910 ed->oct2 = _addr >> 8; \
915 #define nat_elog_debug_handoff(_str, _tid, _fib, _src, _dst) \
918 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
920 ELOG_TYPE_DECLARE (e) = \
922 .format = "nat-msg " _str " ip src: %d.%d.%d.%d dst: %d.%d.%d.%d" \
923 " tid from: %d to: %d fib: %d", \
924 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
940 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
941 ed->src_oct1 = _src >> 24; \
942 ed->src_oct2 = _src >> 16; \
943 ed->src_oct3 = _src >> 8; \
944 ed->src_oct4 = _src; \
945 ed->dst_oct1 = _dst >> 24; \
946 ed->dst_oct2 = _dst >> 16; \
947 ed->dst_oct3 = _dst >> 8; \
948 ed->dst_oct4 = _dst; \
949 ed->ftid = vlib_get_thread_index (); \
955 #define nat_elog_debug_handoff_v2(_str, _prt, _fib, _src, _dst) \
958 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
960 ELOG_TYPE_DECLARE (e) = \
962 .format = "nat-msg " _str " ip_src:%d.%d.%d.%d ip_dst:%d.%d.%d.%d" \
963 " tid:%d prt:%d fib:%d", \
964 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
980 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
981 ed->src_oct1 = _src >> 24; \
982 ed->src_oct2 = _src >> 16; \
983 ed->src_oct3 = _src >> 8; \
984 ed->src_oct4 = _src; \
985 ed->dst_oct1 = _dst >> 24; \
986 ed->dst_oct2 = _dst >> 16; \
987 ed->dst_oct3 = _dst >> 8; \
988 ed->dst_oct4 = _dst; \
989 ed->tid = vlib_get_thread_index (); \
995 #define nat_elog_X1(_level, _fmt, _arg, _val1) \
998 snat_main_t *sm = &snat_main; \
999 if (PREDICT_FALSE (sm->log_level >= _level)) \
1001 ELOG_TYPE_DECLARE (e) = \
1003 .format = "nat-msg " _fmt, \
1004 .format_args = _arg, \
1006 CLIB_PACKED(struct \
1008 typeof (_val1) val1; \
1010 ed = ELOG_DATA (&sm->vlib_main->elog_main, e); \
1015 #define nat_elog_notice(nat_elog_str) \
1016 nat_elog(SNAT_LOG_INFO, "[notice] " nat_elog_str)
1017 #define nat_elog_warn(nat_elog_str) \
1018 nat_elog(SNAT_LOG_WARNING, "[warning] " nat_elog_str)
1019 #define nat_elog_err(nat_elog_str) \
1020 nat_elog(SNAT_LOG_ERROR, "[error] " nat_elog_str)
1021 #define nat_elog_debug(nat_elog_str) \
1022 nat_elog(SNAT_LOG_DEBUG, "[debug] " nat_elog_str)
1023 #define nat_elog_info(nat_elog_str) \
1024 nat_elog(SNAT_LOG_INFO, "[info] " nat_elog_str)
1026 #define nat_elog_notice_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1027 nat_elog_X1(SNAT_LOG_NOTICE, "[notice] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1028 #define nat_elog_warn_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1029 nat_elog_X1(SNAT_LOG_WARNING, "[warning] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1030 #define nat_elog_err_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1031 nat_elog_X1(SNAT_LOG_ERROR, "[error] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1032 #define nat_elog_debug_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1033 nat_elog_X1(SNAT_LOG_DEBUG, "[debug] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1034 #define nat_elog_info_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1035 nat_elog_X1(SNAT_LOG_INFO, "[info] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1037 /* ICMP session match functions */
1038 u32 icmp_match_in2out_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1039 u32 thread_index, vlib_buffer_t * b0,
1040 ip4_header_t * ip0, u8 * p_proto,
1041 snat_session_key_t * p_value,
1042 u8 * p_dont_translate, void *d, void *e);
1043 u32 icmp_match_in2out_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1044 u32 thread_index, vlib_buffer_t * b0,
1045 ip4_header_t * ip0, u8 * p_proto,
1046 snat_session_key_t * p_value,
1047 u8 * p_dont_translate, void *d, void *e);
1048 u32 icmp_match_out2in_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1049 u32 thread_index, vlib_buffer_t * b0,
1050 ip4_header_t * ip0, u8 * p_proto,
1051 snat_session_key_t * p_value,
1052 u8 * p_dont_translate, void *d, void *e);
1053 u32 icmp_match_out2in_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1054 u32 thread_index, vlib_buffer_t * b0,
1055 ip4_header_t * ip0, u8 * p_proto,
1056 snat_session_key_t * p_value,
1057 u8 * p_dont_translate, void *d, void *e);
1059 /* ICMP deterministic NAT session match functions */
1060 u32 icmp_match_out2in_det (snat_main_t * sm, vlib_node_runtime_t * node,
1061 u32 thread_index, vlib_buffer_t * b0,
1062 ip4_header_t * ip0, u8 * p_proto,
1063 snat_session_key_t * p_value,
1064 u8 * p_dont_translate, void *d, void *e);
1065 u32 icmp_match_in2out_det (snat_main_t * sm, vlib_node_runtime_t * node,
1066 u32 thread_index, vlib_buffer_t * b0,
1067 ip4_header_t * ip0, u8 * p_proto,
1068 snat_session_key_t * p_value,
1069 u8 * p_dont_translate, void *d, void *e);
1071 /* ICMP endpoint-dependent session match functions */
1072 u32 icmp_match_out2in_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1073 u32 thread_index, vlib_buffer_t * b0,
1074 ip4_header_t * ip0, u8 * p_proto,
1075 snat_session_key_t * p_value,
1076 u8 * p_dont_translate, void *d, void *e);
1077 u32 icmp_match_in2out_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1078 u32 thread_index, vlib_buffer_t * b0,
1079 ip4_header_t * ip0, u8 * p_proto,
1080 snat_session_key_t * p_value,
1081 u8 * p_dont_translate, void *d, void *e);
1083 u32 icmp_in2out (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1084 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1085 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1088 u32 icmp_out2in (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1089 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1090 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1093 /* hairpinning functions */
1094 u32 snat_icmp_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1095 ip4_header_t * ip0, icmp46_header_t * icmp0,
1097 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1099 void nat44_ed_hairpinning_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1101 int snat_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1102 ip4_header_t * ip0, udp_header_t * udp0,
1103 tcp_header_t * tcp0, u32 proto0, int is_ed);
1105 /* Call back functions for clib_bihash_add_or_overwrite_stale */
1106 int nat44_i2o_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1107 int nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1108 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1109 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1112 * @brief Add external address to NAT44 pool
1114 * @param addr IPv4 address
1115 * @param vrf_id VRF id of tenant, ~0 means independent of VRF
1116 * @param twice_nat 1 if twice NAT address
1118 * @return 0 on success, non-zero value otherwise
1120 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
1124 * @brief Delete external address from NAT44 pool
1126 * @param addr IPv4 address
1127 * @param delete_sm 1 if delete static mapping using address
1128 * @param twice_nat 1 if twice NAT address
1130 * @return 0 on success, non-zero value otherwise
1132 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1136 * @brief Add/delete external address to FIB DPO (out2in DPO mode)
1138 * @param addr IPv4 address
1139 * @param is_add 1 = add, 0 = delete
1141 * @return 0 on success, non-zero value otherwise
1143 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
1146 * @brief Add/delete NAT44 static mapping
1148 * @param l_addr local IPv4 address
1149 * @param e_addr external IPv4 address
1150 * @param l_port local port number
1151 * @param e_port external port number
1152 * @param vrf_id local VRF ID
1153 * @param addr_only 1 = 1:1NAT, 0 = 1:1NAPT
1154 * @param sw_if_index use interface address as external IPv4 address
1155 * @param proto L4 protocol
1156 * @param is_add 1 = add, 0 = delete
1157 * @param twice_nat twice-nat mode
1158 * @param out2in_only if 1 rule match only out2in direction
1159 * @param tag opaque string tag
1160 * @param identity_nat identity NAT
1162 * @return 0 on success, non-zero value otherwise
1164 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
1165 u16 l_port, u16 e_port, u32 vrf_id,
1166 int addr_only, u32 sw_if_index,
1167 snat_protocol_t proto, int is_add,
1168 twice_nat_type_t twice_nat, u8 out2in_only,
1169 u8 * tag, u8 identity_nat);
1172 * @brief Add/delete static mapping with load-balancing (multiple backends)
1174 * @param e_addr external IPv4 address
1175 * @param e_port external port number
1176 * @param proto L4 protocol
1177 * @param locals list of local backends
1178 * @param is_add 1 = add, 0 = delete
1179 * @param twice_nat twice-nat mode
1180 * @param out2in_only if 1 rule match only out2in direction
1181 * @param tag opaque string tag
1182 * @param affinity 0 = disabled, otherwise client IP affinity sticky time
1184 * @return 0 on success, non-zero value otherwise
1186 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1187 snat_protocol_t proto,
1188 nat44_lb_addr_port_t * locals, u8 is_add,
1189 twice_nat_type_t twice_nat,
1190 u8 out2in_only, u8 * tag, u32 affinity);
1192 int nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1193 ip4_address_t l_addr, u16 l_port,
1194 snat_protocol_t proto, u32 vrf_id,
1195 u8 probability, u8 is_add);
1197 clib_error_t *snat_api_init (vlib_main_t * vm, snat_main_t * sm);
1200 * @brief Set NAT plugin workers
1202 * @param bitmap NAT workers bitmap
1204 * @return 0 on success, non-zero value otherwise
1206 int snat_set_workers (uword * bitmap);
1209 * @brief Enable/disable NAT44 feature on the interface
1211 * @param sw_if_index software index of the interface
1212 * @param is_inside 1 = inside, 0 = outside
1213 * @param is_del 1 = delete, 0 = add
1215 * @return 0 on success, non-zero value otherwise
1217 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
1220 * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
1222 * @param sw_if_index software index of the interface
1223 * @param is_inside 1 = inside, 0 = outside
1224 * @param is_del 1 = delete, 0 = add
1226 * @return 0 on success, non-zero value otherwise
1228 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
1232 * @brief Add/delete NAT44 pool address from specific interfce
1234 * @param sw_if_index software index of the interface
1235 * @param is_del 1 = delete, 0 = add
1236 * @param twice_nat 1 = twice NAT address for extenal hosts
1238 * @return 0 on success, non-zero value otherwise
1240 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
1244 * @brief Delete NAT44 session
1246 * @param addr IPv4 address
1247 * @param port L4 port number
1248 * @param proto L4 protocol
1249 * @param vrf_id VRF ID
1250 * @param is_in 1 = inside network address and port pair, 0 = outside
1252 * @return 0 on success, non-zero value otherwise
1254 int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1255 snat_protocol_t proto, u32 vrf_id, int is_in);
1258 * @brief Delete NAT44 endpoint-dependent 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_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1269 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
1270 u32 vrf_id, int is_in);
1273 * @brief Free NAT44 session data (lookup keys, external addrres port)
1275 * @param s NAT session
1276 * @param thread_index thread index
1277 * @param is_ha is HA event
1279 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
1280 u32 thread_index, u8 is_ha);
1283 * @brief Free NAT44 ED 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
1290 nat44_free_session_data (snat_main_t * sm, snat_session_t * s,
1291 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,
1302 ip4_address_t * addr, u32 fib_index,
1306 * @brief Allocate new NAT session or recycle last used
1309 * @param thread_index thread index
1311 * @return session data structure on success otherwise zero value
1313 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
1315 u32 thread_index, f64 now);
1318 * @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, u32 thread_index,
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 int nat_global_lru_free_one (snat_main_t * sm, int thread_index, f64 now);
1438 #endif /* __included_nat_h__ */
1440 * fd.io coding-style-patch-verification: ON
1443 * eval: (c-set-style "gnu")