2 * Copyright (c) 2020 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.
17 * NAT plugin global declarations
19 #ifndef __included_nat_h__
20 #define __included_nat_h__
22 #include <vnet/vnet.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/ip/icmp46_packet.h>
26 #include <vnet/api_errno.h>
27 #include <vnet/fib/fib_source.h>
28 #include <vppinfra/elog.h>
29 #include <vppinfra/bihash_8_8.h>
30 #include <vppinfra/bihash_16_8.h>
31 #include <vppinfra/dlist.h>
32 #include <vppinfra/error.h>
33 #include <vlibapi/api.h>
35 #include <vppinfra/bihash_16_8.h>
36 #include <nat/lib/lib.h>
37 #include <nat/lib/inlines.h>
39 /* default number of worker handoff frame queue elements */
40 #define NAT_FQ_NELTS_DEFAULT 64
42 /* NAT buffer flags */
43 #define SNAT_FLAG_HAIRPINNING (1 << 0)
45 /* NAT44 API Configuration flags */
46 #define foreach_nat44_config_flag \
47 _(0x00, IS_ENDPOINT_INDEPENDENT) \
48 _(0x01, IS_ENDPOINT_DEPENDENT) \
49 _(0x02, IS_STATIC_MAPPING_ONLY) \
50 _(0x04, IS_CONNECTION_TRACKING) \
51 _(0x08, IS_OUT2IN_DPO)
53 typedef enum nat44_config_flags_t_
55 #define _(n,f) NAT44_API_##f = n,
56 foreach_nat44_config_flag
58 } nat44_config_flags_t;
62 /* nat44 plugin features */
63 u8 static_mapping_only;
64 u8 connection_tracking;
65 u8 endpoint_dependent;
71 /* maximum number of users */
74 /* maximum number of sessions */
77 /* maximum number of ssessions per user */
85 NAT_NEXT_IN2OUT_ED_FAST_PATH,
86 NAT_NEXT_IN2OUT_ED_SLOW_PATH,
87 NAT_NEXT_IN2OUT_ED_OUTPUT_FAST_PATH,
88 NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH,
89 NAT_NEXT_OUT2IN_ED_FAST_PATH,
90 NAT_NEXT_OUT2IN_ED_SLOW_PATH,
91 NAT_NEXT_IN2OUT_CLASSIFY,
92 NAT_NEXT_OUT2IN_CLASSIFY,
102 /* user (internal host) key */
116 /* External address and port allocation modes */
117 #define foreach_nat_addr_and_port_alloc_alg \
118 _(0, DEFAULT, "default") \
119 _(1, MAPE, "map-e") \
120 _(2, RANGE, "port-range")
124 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
125 foreach_nat_addr_and_port_alloc_alg
127 } nat_addr_and_port_alloc_alg_t;
130 #define foreach_snat_session_state \
131 _(0, UNKNOWN, "unknown") \
132 _(1, UDP_ACTIVE, "udp-active") \
133 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
134 _(3, TCP_ESTABLISHED, "tcp-established") \
135 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
136 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
137 _(6, TCP_CLOSING, "tcp-closing") \
138 _(7, TCP_LAST_ACK, "tcp-last-ack") \
139 _(8, TCP_CLOSED, "tcp-closed") \
140 _(9, ICMP_ACTIVE, "icmp-active")
144 #define _(v, N, s) SNAT_SESSION_##N = v,
145 foreach_snat_session_state
147 } snat_session_state_t;
149 #define foreach_nat_in2out_ed_error \
150 _(UNSUPPORTED_PROTOCOL, "unsupported protocol") \
151 _(OUT_OF_PORTS, "out of ports") \
152 _(BAD_ICMP_TYPE, "unsupported ICMP type") \
153 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
154 _(NON_SYN, "non-SYN packet try to create session") \
155 _(TCP_CLOSED, "drops due to TCP in transitory timeout")
159 #define _(sym,str) NAT_IN2OUT_ED_ERROR_##sym,
160 foreach_nat_in2out_ed_error
162 NAT_IN2OUT_ED_N_ERROR,
163 } nat_in2out_ed_error_t;
165 #define foreach_nat_out2in_ed_error \
166 _ (UNSUPPORTED_PROTOCOL, "unsupported protocol") \
167 _ (OUT_OF_PORTS, "out of ports") \
168 _ (BAD_ICMP_TYPE, "unsupported ICMP type") \
169 _ (NO_TRANSLATION, "no translation") \
170 _ (MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
171 _ (MAX_USER_SESS_EXCEEDED, "max user sessions exceeded") \
172 _ (CANNOT_CREATE_USER, "cannot create NAT user") \
173 _ (NON_SYN, "non-SYN packet try to create session") \
174 _ (TCP_CLOSED, "drops due to TCP in transitory timeout") \
175 _ (HASH_ADD_FAILED, "hash table add failed")
179 #define _(sym,str) NAT_OUT2IN_ED_ERROR_##sym,
180 foreach_nat_out2in_ed_error
182 NAT_OUT2IN_ED_N_ERROR,
183 } nat_out2in_ed_error_t;
186 /* Endpoint dependent TCP session state */
187 #define NAT44_SES_I2O_FIN 1
188 #define NAT44_SES_O2I_FIN 2
189 #define NAT44_SES_I2O_FIN_ACK 4
190 #define NAT44_SES_O2I_FIN_ACK 8
191 #define NAT44_SES_I2O_SYN 16
192 #define NAT44_SES_O2I_SYN 32
193 #define NAT44_SES_RST 64
196 #define SNAT_SESSION_FLAG_STATIC_MAPPING (1 << 0)
197 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO (1 << 1)
198 #define SNAT_SESSION_FLAG_LOAD_BALANCING (1 << 2)
199 #define SNAT_SESSION_FLAG_TWICE_NAT (1 << 3)
200 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT (1 << 4)
201 #define SNAT_SESSION_FLAG_FWD_BYPASS (1 << 5)
202 #define SNAT_SESSION_FLAG_AFFINITY (1 << 6)
203 #define SNAT_SESSION_FLAG_EXACT_ADDRESS (1 << 7)
204 #define SNAT_SESSION_FLAG_HAIRPINNING (1 << 8)
206 /* NAT interface flags */
207 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
208 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
210 /* Static mapping flags */
211 #define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY 1
212 #define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY 2
213 #define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4
214 #define NAT_STATIC_MAPPING_FLAG_LB 8
215 #define NAT_STATIC_MAPPING_FLAG_EXACT_ADDRESS 16
218 typedef CLIB_PACKED(struct
220 // number of sessions in this vrf
226 // is this vrf expired
228 }) per_vrf_sessions_t;
233 ip4_address_t saddr, daddr;
242 #define NAT_FLOW_OP_SADDR_REWRITE (1 << 1)
243 #define NAT_FLOW_OP_SPORT_REWRITE (1 << 2)
244 #define NAT_FLOW_OP_DADDR_REWRITE (1 << 3)
245 #define NAT_FLOW_OP_DPORT_REWRITE (1 << 4)
246 #define NAT_FLOW_OP_ICMP_ID_REWRITE (1 << 5)
247 #define NAT_FLOW_OP_TXFIB_REWRITE (1 << 6)
256 nat_6t_flow_saddr_rewrite_set (nat_6t_flow_t *f, u32 saddr)
258 f->ops |= NAT_FLOW_OP_SADDR_REWRITE;
259 f->rewrite.saddr.as_u32 = saddr;
263 nat_6t_flow_daddr_rewrite_set (nat_6t_flow_t *f, u32 daddr)
265 f->ops |= NAT_FLOW_OP_DADDR_REWRITE;
266 f->rewrite.daddr.as_u32 = daddr;
270 nat_6t_flow_sport_rewrite_set (nat_6t_flow_t *f, u32 sport)
272 f->ops |= NAT_FLOW_OP_SPORT_REWRITE;
273 f->rewrite.sport = sport;
277 nat_6t_flow_dport_rewrite_set (nat_6t_flow_t *f, u32 dport)
279 f->ops |= NAT_FLOW_OP_DPORT_REWRITE;
280 f->rewrite.dport = dport;
284 nat_6t_flow_txfib_rewrite_set (nat_6t_flow_t *f, u32 tx_fib_index)
286 f->ops |= NAT_FLOW_OP_TXFIB_REWRITE;
287 f->rewrite.fib_index = tx_fib_index;
291 nat_6t_flow_icmp_id_rewrite_set (nat_6t_flow_t *f, u16 id)
293 f->ops |= NAT_FLOW_OP_ICMP_ID_REWRITE;
294 f->rewrite.icmp_id = id;
298 typedef CLIB_PACKED(struct
300 /* Outside network tuple */
308 /* Inside network tuple */
316 nat_protocol_t nat_proto;
324 /* Per-user translations */
326 u32 per_user_list_head_index;
328 /* head of LRU list in which this session is tracked */
330 /* index in global LRU list */
334 /* Last heard timer */
337 /* Last HA refresh */
338 f64 ha_last_refreshed;
344 /* External host address and port */
345 ip4_address_t ext_host_addr;
348 /* External host address and port after translation */
349 ip4_address_t ext_host_nat_addr;
350 u16 ext_host_nat_port;
352 /* TCP session state */
356 u64 tcp_closed_timestamp;
361 /* per vrf sessions index */
362 u32 per_vrf_sessions_index;
371 u32 sessions_per_user_list_head_index;
381 #define _(N, i, n, s) \
382 u32 busy_##n##_ports; \
383 u32 * busy_##n##_ports_per_thread; \
384 u32 busy_##n##_port_refcounts[65535];
404 /* backend IP address */
406 /* backend port number */
408 /* probability of the backend to be randomly matched */
411 /* backend FIB table */
414 } nat44_lb_addr_port_t;
418 /* twice-nat disabled */
420 /* twice-nat enabled */
422 /* twice-nat only when src IP equals dst IP after translation */
428 /* no load-balancing */
432 /* load-balancing with affinity */
438 /* prefered pool address */
439 ip4_address_t pool_addr;
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 nat_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;
478 ip4_address_t pool_addr;
483 nat_protocol_t proto;
491 } snat_static_map_resolve_t;
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 *lru_pool;
509 u32 tcp_trans_lru_head_index;
510 u32 tcp_estab_lru_head_index;
511 u32 udp_lru_head_index;
512 u32 icmp_lru_head_index;
513 u32 unk_proto_lru_head_index;
515 /* NAT thread index */
516 u32 snat_thread_index;
518 /* real thread index */
521 per_vrf_sessions_t *per_vrf_sessions_vec;
523 } snat_main_per_thread_data_t;
527 /* ICMP session match function */
528 typedef u32 (snat_icmp_match_function_t) (
529 struct snat_main_s *sm, vlib_node_runtime_t *node, u32 thread_index,
530 vlib_buffer_t *b0, ip4_header_t *ip0, ip4_address_t *addr, u16 *port,
531 u32 *fib_index, nat_protocol_t *proto, snat_session_t **s_out,
534 /* Return worker thread index for given packet */
535 typedef u32 (snat_get_worker_in2out_function_t) (ip4_header_t * ip,
539 typedef u32 (snat_get_worker_out2in_function_t) (vlib_buffer_t * b,
544 /* NAT address and port allocation function */
545 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
549 nat_protocol_t proto,
550 ip4_address_t * addr,
553 u32 snat_thread_index);
555 #define foreach_nat_counter _ (tcp) _ (udp) _ (icmp) _ (other) _ (drops)
557 typedef struct snat_main_s
559 /* ICMP session match functions */
560 snat_icmp_match_function_t *icmp_match_in2out_cb;
561 snat_icmp_match_function_t *icmp_match_out2in_cb;
563 /* Thread settings */
565 u32 first_worker_index;
567 snat_get_worker_in2out_function_t *worker_in2out_cb;
568 snat_get_worker_out2in_function_t *worker_out2in_cb;
571 /* Per thread data */
572 snat_main_per_thread_data_t *per_thread_data;
574 /* Find a static mapping by local */
575 clib_bihash_8_8_t static_mapping_by_local;
577 /* Find a static mapping by external */
578 clib_bihash_8_8_t static_mapping_by_external;
580 /* Static mapping pool */
581 snat_static_mapping_t *static_mappings;
583 /* Endpoint independent lookup tables */
584 clib_bihash_8_8_t in2out;
585 clib_bihash_8_8_t out2in;
587 /* Endpoint dependent lookup table */
588 clib_bihash_16_8_t flow_hash;
591 snat_interface_t *interfaces;
592 snat_interface_t *output_feature_interfaces;
594 /* Vector of outside addresses */
595 snat_address_t *addresses;
596 /* Address and port allocation function */
597 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
598 /* Address and port allocation type */
599 nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
600 /* Port set parameters (MAP-E) */
604 /* Port range parameters */
611 /* vector of outside fibs */
612 nat_outside_fib_t *outside_fibs;
614 /* Vector of twice NAT addresses for external hosts */
615 snat_address_t *twice_nat_addresses;
617 /* sw_if_indices whose intfc addresses should be auto-added */
618 u32 *auto_add_sw_if_indices;
619 u32 *auto_add_sw_if_indices_twice_nat;
621 /* vector of interface address static mappings to resolve. */
622 snat_static_map_resolve_t *to_resolve;
624 /* Randomize port allocation order */
627 /* Worker handoff frame-queue index */
629 u32 fq_in2out_output_index;
633 u32 error_node_index;
635 /* handoff fq nodes */
636 u32 handoff_out2in_index;
637 u32 handoff_in2out_index;
638 u32 handoff_in2out_output_index;
640 /* respect feature arc nodes */
641 u32 pre_out2in_node_index;
642 u32 pre_in2out_node_index;
644 u32 out2in_node_index;
645 u32 in2out_node_index;
646 u32 in2out_output_node_index;
648 u32 in2out_fast_node_index;
649 u32 in2out_slowpath_node_index;
650 u32 in2out_slowpath_output_node_index;
651 u32 out2in_fast_node_index;
653 u32 ei_out2in_node_index;
654 u32 ei_in2out_node_index;
655 u32 ei_in2out_output_node_index;
657 u32 ed_out2in_node_index;
658 u32 ed_in2out_node_index;
659 u32 ed_in2out_output_node_index;
661 u32 ed_in2out_slowpath_node_index;
662 u32 ed_out2in_slowpath_node_index;
664 u32 hairpinning_node_index;
665 u32 hairpin_dst_node_index;
666 u32 hairpin_src_node_index;
668 nat44_config_t rconfig;
669 //nat44_config_t cconfig;
671 /* If forwarding is enabled */
672 u8 forwarding_enabled;
674 /* Config parameters */
675 u8 endpoint_dependent;
678 /* static mapping config */
679 u8 static_mapping_only;
680 u8 static_mapping_connection_tracking;
682 /* Is translation memory size calculated or user defined */
683 u8 translation_memory_size_set;
685 u32 translation_buckets;
686 u32 max_translations_per_thread;
687 u32 *max_translations_per_fib;
688 u32 max_users_per_thread;
690 u32 max_translations_per_user;
693 u32 outside_fib_index;
695 u32 inside_fib_index;
697 nat_timeouts_t timeouts;
699 /* TCP MSS clamping */
703 vlib_simple_counter_main_t total_users;
704 vlib_simple_counter_main_t total_sessions;
705 vlib_simple_counter_main_t user_limit_reached;
707 #define _(x) vlib_simple_counter_main_t x;
756 vlib_simple_counter_main_t hairpinning;
760 /* API message ID base */
764 vlib_log_class_t log_class;
769 api_main_t *api_main;
770 ip4_main_t *ip4_main;
771 ip_lookup_main_t *ip4_lookup_main;
773 fib_source_t fib_src_hi;
774 fib_source_t fib_src_low;
776 /* pat - dynamic mapping enabled or conneciton tracking */
779 /* number of worker handoff frame queue elements */
780 u32 frame_queue_nelts;
782 /* nat44 plugin enabled */
785 vnet_main_t *vnet_main;
792 } nat44_is_idle_session_ctx_t;
796 u32 cached_sw_if_index;
797 u32 cached_ip4_address;
800 extern snat_main_t snat_main;
802 // nat pre ed next_node feature classification
803 extern vlib_node_registration_t nat_default_node;
804 extern vlib_node_registration_t nat_pre_in2out_node;
805 extern vlib_node_registration_t nat_pre_out2in_node;
807 extern vlib_node_registration_t snat_in2out_node;
808 extern vlib_node_registration_t snat_in2out_output_node;
809 extern vlib_node_registration_t snat_out2in_node;
810 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
811 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
812 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
813 extern vlib_node_registration_t nat44_ed_in2out_node;
814 extern vlib_node_registration_t nat44_ed_in2out_output_node;
815 extern vlib_node_registration_t nat44_ed_out2in_node;
817 extern fib_source_t nat_fib_src_hi;
818 extern fib_source_t nat_fib_src_low;
820 /* format functions */
821 format_function_t format_snat_user;
822 format_function_t format_snat_static_mapping;
823 format_function_t format_snat_static_map_to_resolve;
824 format_function_t format_snat_session;
825 format_function_t format_snat_key;
826 format_function_t format_static_mapping_key;
827 format_function_t format_nat_protocol;
828 format_function_t format_nat_addr_and_port_alloc_alg;
829 /* unformat functions */
830 unformat_function_t unformat_nat_protocol;
832 /** \brief Check if SNAT session is created from static mapping.
833 @param s SNAT session
834 @return 1 if SNAT session is created from static mapping otherwise 0
836 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
838 /** \brief Check if SNAT session for unknown protocol.
839 @param s SNAT session
840 @return 1 if SNAT session for unknown protocol otherwise 0
842 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
844 /** \brief Check if NAT session is twice NAT.
846 @return 1 if NAT session is twice NAT
848 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
850 /** \brief Check if NAT session is load-balancing.
852 @return 1 if NAT session is load-balancing
854 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
856 /** \brief Check if NAT session is forwarding bypass.
858 @return 1 if NAT session is load-balancing
860 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
862 /** \brief Check if NAT session is endpoint dependent.
864 @return 1 if NAT session is endpoint dependent
866 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
868 /** \brief Check if NAT session has affinity record.
870 @return 1 if NAT session has affinity record
872 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
874 /** \brief Check if exact pool address should be used.
875 @param s SNAT session
876 @return 1 if exact pool address or 0
878 #define is_exact_address_session(s) (s->flags & SNAT_SESSION_FLAG_EXACT_ADDRESS)
880 /** \brief Check if NAT interface is inside.
881 @param i NAT interface
882 @return 1 if inside interface
884 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
886 /** \brief Check if NAT interface is outside.
887 @param i NAT interface
888 @return 1 if outside interface
890 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
892 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
894 @return 1 if session is closed
896 #define nat44_is_ses_closed(s) s->state == 0xf
898 /** \brief Check if NAT static mapping is address only (1:1NAT).
899 @param sm NAT static mapping
900 @return 1 if 1:1NAT, 0 if 1:1NAPT
902 #define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY)
904 /** \brief Check if NAT static mapping match only out2in direction.
905 @param sm NAT static mapping
906 @return 1 if rule match only out2in direction
908 #define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY)
910 /** \brief Check if NAT static mapping is identity NAT.
911 @param sm NAT static mapping
912 @return 1 if identity NAT
914 #define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT)
916 /** \brief Check if NAT static mapping is load-balancing.
917 @param sm NAT static mapping
918 @return 1 if load-balancing
920 #define is_lb_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_LB)
922 /** \brief Check if exact pool address should be used.
923 @param s SNAT session
924 @return 1 if exact pool address or 0
926 #define is_exact_address(s) (s->flags & NAT_STATIC_MAPPING_FLAG_EXACT_ADDRESS)
928 /** \brief Check if client initiating TCP connection (received SYN from client)
930 @return 1 if client initiating TCP connection
933 tcp_flags_is_init (u8 f)
935 return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK);
939 #define nat_log_err(...) \
940 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
941 #define nat_log_warn(...) \
942 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
943 #define nat_log_notice(...) \
944 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
945 #define nat_log_info(...) \
946 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
947 #define nat_log_debug(...)\
948 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
950 /* NAT API Logging Levels */
951 #define foreach_nat_log_level \
954 _(0x02, LOG_WARNING) \
955 _(0x03, LOG_NOTICE) \
959 typedef enum nat_log_level_t_
961 #define _(n,f) SNAT_##f = n,
962 foreach_nat_log_level
966 #define nat_elog(_level, _str) \
969 snat_main_t *sm = &snat_main; \
970 if (PREDICT_FALSE (sm->log_level >= _level)) \
972 ELOG_TYPE_DECLARE (e) = \
974 .format = "nat-msg " _str, \
977 ELOG_DATA (&vlib_global_main.elog_main, e); \
981 #define nat_elog_addr(_level, _str, _addr) \
984 if (PREDICT_FALSE (sm->log_level >= _level)) \
986 ELOG_TYPE_DECLARE (e) = \
988 .format = "nat-msg " _str " %d.%d.%d.%d", \
989 .format_args = "i1i1i1i1", \
998 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
999 ed->oct4 = _addr >> 24; \
1000 ed->oct3 = _addr >> 16; \
1001 ed->oct2 = _addr >> 8; \
1006 #define nat_elog_debug_handoff(_str, _tid, _fib, _src, _dst) \
1009 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
1011 ELOG_TYPE_DECLARE (e) = \
1013 .format = "nat-msg " _str " ip src: %d.%d.%d.%d dst: %d.%d.%d.%d" \
1014 " tid from: %d to: %d fib: %d", \
1015 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
1017 CLIB_PACKED(struct \
1031 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
1032 ed->src_oct1 = _src >> 24; \
1033 ed->src_oct2 = _src >> 16; \
1034 ed->src_oct3 = _src >> 8; \
1035 ed->src_oct4 = _src; \
1036 ed->dst_oct1 = _dst >> 24; \
1037 ed->dst_oct2 = _dst >> 16; \
1038 ed->dst_oct3 = _dst >> 8; \
1039 ed->dst_oct4 = _dst; \
1040 ed->ftid = vlib_get_thread_index (); \
1046 #define nat_elog_debug_handoff_v2(_str, _prt, _fib, _src, _dst) \
1049 if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG)) \
1051 ELOG_TYPE_DECLARE (e) = \
1053 .format = "nat-msg " _str " ip_src:%d.%d.%d.%d ip_dst:%d.%d.%d.%d" \
1054 " tid:%d prt:%d fib:%d", \
1055 .format_args = "i1i1i1i1i1i1i1i1i4i4i4", \
1057 CLIB_PACKED(struct \
1071 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
1072 ed->src_oct1 = _src >> 24; \
1073 ed->src_oct2 = _src >> 16; \
1074 ed->src_oct3 = _src >> 8; \
1075 ed->src_oct4 = _src; \
1076 ed->dst_oct1 = _dst >> 24; \
1077 ed->dst_oct2 = _dst >> 16; \
1078 ed->dst_oct3 = _dst >> 8; \
1079 ed->dst_oct4 = _dst; \
1080 ed->tid = vlib_get_thread_index (); \
1086 #define nat_elog_X1(_level, _fmt, _arg, _val1) \
1089 snat_main_t *sm = &snat_main; \
1090 if (PREDICT_FALSE (sm->log_level >= _level)) \
1092 ELOG_TYPE_DECLARE (e) = \
1094 .format = "nat-msg " _fmt, \
1095 .format_args = _arg, \
1097 CLIB_PACKED(struct \
1099 typeof (_val1) val1; \
1101 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
1106 #define nat_elog_notice(nat_elog_str) \
1107 nat_elog(SNAT_LOG_INFO, "[notice] " nat_elog_str)
1108 #define nat_elog_warn(nat_elog_str) \
1109 nat_elog(SNAT_LOG_WARNING, "[warning] " nat_elog_str)
1110 #define nat_elog_err(nat_elog_str) \
1111 nat_elog(SNAT_LOG_ERROR, "[error] " nat_elog_str)
1112 #define nat_elog_debug(nat_elog_str) \
1113 nat_elog(SNAT_LOG_DEBUG, "[debug] " nat_elog_str)
1114 #define nat_elog_info(nat_elog_str) \
1115 nat_elog(SNAT_LOG_INFO, "[info] " nat_elog_str)
1117 #define nat_elog_notice_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1118 nat_elog_X1(SNAT_LOG_NOTICE, "[notice] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1119 #define nat_elog_warn_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1120 nat_elog_X1(SNAT_LOG_WARNING, "[warning] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1121 #define nat_elog_err_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1122 nat_elog_X1(SNAT_LOG_ERROR, "[error] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1123 #define nat_elog_debug_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1124 nat_elog_X1(SNAT_LOG_DEBUG, "[debug] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1125 #define nat_elog_info_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1126 nat_elog_X1(SNAT_LOG_INFO, "[info] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1128 /* ICMP session match functions */
1129 u32 icmp_match_in2out_fast (snat_main_t *sm, vlib_node_runtime_t *node,
1130 u32 thread_index, vlib_buffer_t *b0,
1131 ip4_header_t *ip0, ip4_address_t *addr, u16 *port,
1132 u32 *fib_index, nat_protocol_t *proto,
1133 snat_session_t **s0, u8 *dont_translate);
1134 u32 icmp_match_in2out_slow (snat_main_t *sm, vlib_node_runtime_t *node,
1135 u32 thread_index, vlib_buffer_t *b0,
1136 ip4_header_t *ip0, ip4_address_t *addr, u16 *port,
1137 u32 *fib_index, nat_protocol_t *proto,
1138 snat_session_t **s0, u8 *dont_translate);
1139 u32 icmp_match_out2in_fast (snat_main_t *sm, vlib_node_runtime_t *node,
1140 u32 thread_index, vlib_buffer_t *b0,
1141 ip4_header_t *ip0, ip4_address_t *addr, u16 *port,
1142 u32 *fib_index, nat_protocol_t *proto,
1143 snat_session_t **s0, u8 *dont_translate);
1144 u32 icmp_match_out2in_slow (snat_main_t *sm, vlib_node_runtime_t *node,
1145 u32 thread_index, vlib_buffer_t *b0,
1146 ip4_header_t *ip0, ip4_address_t *addr, u16 *port,
1147 u32 *fib_index, nat_protocol_t *proto,
1148 snat_session_t **s0, u8 *dont_translate);
1150 /* hairpinning functions */
1151 u32 snat_icmp_hairpinning (snat_main_t *sm, vlib_buffer_t *b0,
1152 ip4_header_t *ip0, icmp46_header_t *icmp0);
1154 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1156 int snat_hairpinning (vlib_main_t *vm, vlib_node_runtime_t *node,
1157 snat_main_t *sm, vlib_buffer_t *b0, ip4_header_t *ip0,
1158 udp_header_t *udp0, tcp_header_t *tcp0, u32 proto0,
1161 /* Call back functions for clib_bihash_add_or_overwrite_stale */
1162 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1163 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1167 * @brief Enable NAT44 plugin
1169 * @param c nat44_config_t
1171 * @return 0 on success, non-zero value otherwise
1173 int nat44_plugin_enable (nat44_config_t c);
1176 * @brief Disable NAT44 plugin
1178 * @return 0 on success, non-zero value otherwise
1180 int nat44_plugin_disable ();
1183 * @brief Add external address to NAT44 pool
1185 * @param sm snat global configuration data
1186 * @param addr IPv4 address
1187 * @param vrf_id VRF id of tenant, ~0 means independent of VRF
1188 * @param twice_nat 1 if twice NAT address
1190 * @return 0 on success, non-zero value otherwise
1192 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
1196 * @brief Delete external address from NAT44 pool
1198 * @param sm snat global configuration data
1199 * @param addr IPv4 address
1200 * @param delete_sm 1 if delete static mapping using address
1201 * @param twice_nat 1 if twice NAT address
1203 * @return 0 on success, non-zero value otherwise
1205 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1209 * @brief Add/delete external address to FIB DPO (out2in DPO mode)
1211 * @param addr IPv4 address
1212 * @param is_add 1 = add, 0 = delete
1214 * @return 0 on success, non-zero value otherwise
1216 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
1219 * @brief Add/delete NAT44 static mapping
1221 * @param l_addr local IPv4 address
1222 * @param e_addr external IPv4 address
1223 * @param l_port local port number
1224 * @param e_port external port number
1225 * @param vrf_id local VRF ID
1226 * @param addr_only 1 = 1:1NAT, 0 = 1:1NAPT
1227 * @param sw_if_index use interface address as external IPv4 address
1228 * @param proto L4 protocol
1229 * @param is_add 1 = add, 0 = delete
1230 * @param twice_nat twice-nat mode
1231 * @param out2in_only if 1 rule match only out2in direction
1232 * @param tag opaque string tag
1233 * @param identity_nat identity NAT
1234 * @param pool_addr pool IPv4 address
1235 * @param exact 1 = exact pool address
1237 * @return 0 on success, non-zero value otherwise
1239 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
1240 u16 l_port, u16 e_port, u32 vrf_id,
1241 int addr_only, u32 sw_if_index,
1242 nat_protocol_t proto, int is_add,
1243 twice_nat_type_t twice_nat, u8 out2in_only,
1244 u8 * tag, u8 identity_nat,
1245 ip4_address_t pool_addr, int exact);
1248 * @brief Add/delete static mapping with load-balancing (multiple backends)
1250 * @param e_addr external IPv4 address
1251 * @param e_port external port number
1252 * @param proto L4 protocol
1253 * @param locals list of local backends
1254 * @param is_add 1 = add, 0 = delete
1255 * @param twice_nat twice-nat mode
1256 * @param out2in_only if 1 rule match only out2in direction
1257 * @param tag opaque string tag
1258 * @param affinity 0 = disabled, otherwise client IP affinity sticky time
1260 * @return 0 on success, non-zero value otherwise
1262 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1263 nat_protocol_t proto,
1264 nat44_lb_addr_port_t * locals, u8 is_add,
1265 twice_nat_type_t twice_nat,
1266 u8 out2in_only, u8 * tag, u32 affinity);
1268 int nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1269 ip4_address_t l_addr, u16 l_port,
1270 nat_protocol_t proto, u32 vrf_id,
1271 u8 probability, u8 is_add);
1273 clib_error_t *nat44_api_hookup (vlib_main_t * vm);
1276 * @brief Set NAT plugin workers
1278 * @param bitmap NAT workers bitmap
1280 * @return 0 on success, non-zero value otherwise
1282 int snat_set_workers (uword * bitmap);
1285 * @brief Set NAT plugin number of frame queue elements
1287 * @param frame_queue_nelts number of worker handoff frame queue elements
1289 * @return 0 on success, non-zero value otherwise
1291 int snat_set_frame_queue_nelts (u32 frame_queue_nelts);
1294 * @brief Enable/disable NAT44 feature on the interface
1296 * @param sw_if_index software index of the interface
1297 * @param is_inside 1 = inside, 0 = outside
1298 * @param is_del 1 = delete, 0 = add
1300 * @return 0 on success, non-zero value otherwise
1302 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
1305 * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
1307 * @param sw_if_index software index of the interface
1308 * @param is_inside 1 = inside, 0 = outside
1309 * @param is_del 1 = delete, 0 = add
1311 * @return 0 on success, non-zero value otherwise
1313 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
1317 * @brief Add/delete NAT44 pool address from specific interface
1319 * @param sw_if_index software index of the interface
1320 * @param is_del 1 = delete, 0 = add
1321 * @param twice_nat 1 = twice NAT address for external hosts
1323 * @return 0 on success, non-zero value otherwise
1325 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
1329 * @brief Delete NAT44 endpoint-dependent session
1331 * @param sm snat global configuration data
1332 * @param addr IPv4 address
1333 * @param port L4 port number
1334 * @param proto L4 protocol
1335 * @param vrf_id VRF ID
1336 * @param is_in 1 = inside network address and port pair, 0 = outside
1338 * @return 0 on success, non-zero value otherwise
1340 int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1341 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
1342 u32 vrf_id, int is_in);
1345 * @brief Free NAT44 session data (lookup keys, external address port)
1347 * @param sm snat global configuration data
1348 * @param s NAT session
1349 * @param thread_index thread index
1350 * @param is_ha is HA event
1352 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
1353 u32 thread_index, u8 is_ha);
1356 * @brief Set NAT44 session limit (session limit, vrf id)
1358 * @param session_limit Session limit
1359 * @param vrf_id VRF id
1360 * @return 0 on success, non-zero value otherwise
1362 int nat44_set_session_limit (u32 session_limit, u32 vrf_id);
1365 * @brief Update NAT44 session limit flushing all data (session limit, vrf id)
1367 * @param session_limit Session limit
1368 * @param vrf_id VRF id
1369 * @return 0 on success, non-zero value otherwise
1371 int nat44_update_session_limit (u32 session_limit, u32 vrf_id);
1374 * @brief Free all NAT44 sessions
1376 void nat44_sessions_clear ();
1379 * @brief Find or create NAT user
1381 * @param sm snat global configuration data
1382 * @param addr IPv4 address
1383 * @param fib_index FIB table index
1384 * @param thread_index thread index
1386 * @return NAT user data structure on success otherwise zero value
1388 snat_user_t *nat_user_get_or_create (snat_main_t * sm,
1389 ip4_address_t * addr, u32 fib_index,
1393 * @brief Allocate new NAT session or recycle last used
1395 * @param sm snat global configuration data
1397 * @param thread_index thread index
1398 * @param now time now
1400 * @return session data structure on success otherwise zero value
1402 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
1404 u32 thread_index, f64 now);
1407 * @brief Free outside address and port pair
1409 * @param addresses vector of outside addresses
1410 * @param thread_index thread index
1411 * @param key address, port and protocol
1414 snat_free_outside_address_and_port (snat_address_t * addresses,
1416 ip4_address_t * addr,
1417 u16 port, nat_protocol_t protocol);
1419 void expire_per_vrf_sessions (u32 fib_index);
1422 * @brief Match NAT44 static mapping.
1424 * @param key address and port to match
1425 * @param addr external/local address of the matched mapping
1426 * @param port port of the matched mapping
1427 * @param fib_index fib index of the matched mapping
1428 * @param by_external if 0 match by local address otherwise match by external
1430 * @param is_addr_only 1 if matched mapping is address only
1431 * @param twice_nat matched mapping is twice NAT type
1432 * @param lb 1 if matched mapping is load-balanced
1433 * @param ext_host_addr external host address
1434 * @param is_identity_nat 1 if indentity mapping
1435 * @param out if !=0 set to pointer of the mapping structure
1437 * @returns 0 if match found otherwise 1.
1439 int snat_static_mapping_match (snat_main_t * sm,
1440 ip4_address_t match_addr,
1442 u32 match_fib_index,
1443 nat_protocol_t match_protocol,
1444 ip4_address_t * mapping_addr,
1446 u32 * mapping_fib_index,
1449 twice_nat_type_t * twice_nat,
1451 ip4_address_t * ext_host_addr,
1452 u8 * is_identity_nat,
1453 snat_static_mapping_t ** out);
1456 * @brief Add/del NAT address to FIB.
1458 * Add the external NAT address to the FIB as receive entries. This ensures
1459 * that VPP will reply to ARP for this address and we don't need to enable
1460 * proxy ARP on the outside interface.
1462 * @param addr IPv4 address
1463 * @param plen address prefix length
1464 * @param sw_if_index software index of the outside interface
1465 * @param is_add 0 = delete, 1 = add.
1467 void snat_add_del_addr_to_fib (ip4_address_t * addr,
1468 u8 p_len, u32 sw_if_index, int is_add);
1472 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
1473 ip4_address_t * out_addr, u16 out_port,
1474 ip4_address_t * eh_addr, u16 eh_port,
1475 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
1476 u32 fib_index, u16 flags, u32 thread_index);
1479 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
1480 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
1481 u32 fib_index, u32 ti);
1484 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
1485 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
1486 u32 fib_index, u32 total_pkts, u64 total_bytes,
1490 int nat_set_outside_address_and_port (snat_address_t *addresses,
1491 u32 thread_index, ip4_address_t addr,
1492 u16 port, nat_protocol_t protocol);
1495 * Why is this here? Because we don't need to touch this layer to
1496 * simply reply to an icmp. We need to change id to a unique
1497 * value to NAT an echo request/reply.
1504 } icmp_echo_header_t;
1508 u16 src_port, dst_port;
1511 u8 *format_user_kvp (u8 * s, va_list * args);
1513 u32 get_thread_idx_by_port (u16 e_port);
1515 u8 *format_static_mapping_kvp (u8 *s, va_list *args);
1517 u8 *format_session_kvp (u8 *s, va_list *args);
1519 u8 *format_user_kvp (u8 *s, va_list *args);
1521 u32 nat_calc_bihash_buckets (u32 n_elts);
1523 void nat44_addresses_free (snat_address_t **addresses);
1527 NAT_ED_TRNSL_ERR_SUCCESS = 0,
1528 NAT_ED_TRNSL_ERR_TRANSLATION_FAILED = 1,
1529 NAT_ED_TRNSL_ERR_FLOW_MISMATCH = 2,
1530 } nat_translation_error_e;
1532 nat_translation_error_e
1533 nat_6t_flow_buf_translate (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
1534 nat_6t_flow_t *f, nat_protocol_t proto,
1535 int is_output_feature);
1537 void nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f);
1539 format_function_t format_nat_ed_translation_error;
1540 format_function_t format_nat_6t_flow;
1541 format_function_t format_ed_session_kvp;
1543 #endif /* __included_nat_h__ */
1545 * fd.io coding-style-patch-verification: ON
1548 * eval: (c-set-style "gnu")