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/bihash_8_8.h>
27 #include <vppinfra/bihash_16_8.h>
28 #include <vppinfra/dlist.h>
29 #include <vppinfra/error.h>
30 #include <vlibapi/api.h>
33 /* default session timeouts */
34 #define SNAT_UDP_TIMEOUT 300
35 #define SNAT_TCP_TRANSITORY_TIMEOUT 240
36 #define SNAT_TCP_ESTABLISHED_TIMEOUT 7440
37 #define SNAT_ICMP_TIMEOUT 60
39 /* number of worker handoff frame queue elements */
40 #define NAT_FQ_NELTS 64
42 /* NAT buffer flags */
43 #define SNAT_FLAG_HAIRPINNING (1 << 0)
45 /* session key (4-tuple) */
54 u16 protocol:3, fib_index:13;
60 /* endpoint-dependent session key (6-tuple) */
69 u32 proto:8, fib_index:24;
77 /* deterministic session outside key */
84 ip4_address_t ext_host_addr;
92 /* user (internal host) key */
111 } nat44_reass_trace_t;
113 /* External address and port allocation modes */
114 #define foreach_nat_addr_and_port_alloc_alg \
115 _(0, DEFAULT, "default") \
116 _(1, MAPE, "map-e") \
117 _(2, RANGE, "port-range")
121 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
122 foreach_nat_addr_and_port_alloc_alg
124 } nat_addr_and_port_alloc_alg_t;
127 /* Supported L4 protocols */
128 #define foreach_snat_protocol \
129 _(UDP, 0, udp, "udp") \
130 _(TCP, 1, tcp, "tcp") \
131 _(ICMP, 2, icmp, "icmp")
135 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
136 foreach_snat_protocol
142 #define foreach_snat_session_state \
143 _(0, UNKNOWN, "unknown") \
144 _(1, UDP_ACTIVE, "udp-active") \
145 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
146 _(3, TCP_ESTABLISHED, "tcp-established") \
147 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
148 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
149 _(6, TCP_CLOSING, "tcp-closing") \
150 _(7, TCP_LAST_ACK, "tcp-last-ack") \
151 _(8, TCP_CLOSED, "tcp-closed") \
152 _(9, ICMP_ACTIVE, "icmp-active")
156 #define _(v, N, s) SNAT_SESSION_##N = v,
157 foreach_snat_session_state
159 } snat_session_state_t;
161 /* Endpoint dependent TCP session state */
162 #define NAT44_SES_I2O_FIN 1
163 #define NAT44_SES_O2I_FIN 2
164 #define NAT44_SES_I2O_FIN_ACK 4
165 #define NAT44_SES_O2I_FIN_ACK 8
166 #define NAT44_SES_I2O_SYN 16
167 #define NAT44_SES_O2I_SYN 32
170 #define SNAT_SESSION_FLAG_STATIC_MAPPING 1
171 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO 2
172 #define SNAT_SESSION_FLAG_LOAD_BALANCING 4
173 #define SNAT_SESSION_FLAG_TWICE_NAT 8
174 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT 16
175 #define SNAT_SESSION_FLAG_FWD_BYPASS 32
176 #define SNAT_SESSION_FLAG_AFFINITY 64
178 /* NAT interface flags */
179 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
180 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
182 /* Static mapping flags */
183 #define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY 1
184 #define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY 2
185 #define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4
188 typedef CLIB_PACKED(struct
190 /* Outside network key */
191 snat_session_key_t out2in;
193 /* Inside network key */
194 snat_session_key_t in2out;
199 /* Per-user translations */
201 u32 per_user_list_head_index;
203 /* Last heard timer */
210 /* External host address and port */
211 ip4_address_t ext_host_addr;
214 /* External host address and port after translation */
215 ip4_address_t ext_host_nat_addr;
216 u16 ext_host_nat_port;
218 /* TCP session state */
230 u32 sessions_per_user_list_head_index;
240 #define _(N, i, n, s) \
241 u16 busy_##n##_ports; \
242 u16 * busy_##n##_ports_per_thread; \
243 uword * busy_##n##_port_bitmap;
244 foreach_snat_protocol
257 /* Inside network port */
259 /* Outside network address and port */
260 snat_det_out_key_t out;
265 } snat_det_session_t;
269 /* inside IP address range */
270 ip4_address_t in_addr;
272 /* outside IP address range */
273 ip4_address_t out_addr;
275 /* inside IP addresses / outside IP addresses */
277 /* number of ports available to internal host */
279 /* session counter */
281 /* vector of sessions */
282 snat_det_session_t *sessions;
287 /* backend IP address */
289 /* backend port number */
291 /* probability of the backend to be randomly matched */
294 /* backend FIB table */
297 } nat44_lb_addr_port_t;
301 /* twice-nat disabled */
303 /* twice-nat enabled */
305 /* twice-nat only when src IP equals dst IP after translation */
311 /* no load-balancing */
315 /* load-balancing with affinity */
321 /* local IP address */
322 ip4_address_t local_addr;
323 /* external IP address */
324 ip4_address_t external_addr;
330 twice_nat_type_t twice_nat;
331 /* local FIB table */
335 snat_protocol_t proto;
336 /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
338 /* worker threads used by backends/local host */
340 /* opaque string tag */
342 /* backends for load-balancing mode */
343 nat44_lb_addr_port_t *locals;
344 /* affinity per service lis */
345 u32 affinity_per_service_list_head_index;
348 } snat_static_mapping_t;
358 ip4_address_t l_addr;
363 snat_protocol_t proto;
371 } snat_static_map_resolve_t;
375 /* Main lookup tables */
376 clib_bihash_8_8_t out2in;
377 clib_bihash_8_8_t in2out;
379 /* Endpoint dependent sessions lookup tables */
380 clib_bihash_16_8_t out2in_ed;
381 clib_bihash_16_8_t in2out_ed;
383 /* Find-a-user => src address lookup */
384 clib_bihash_8_8_t user_hash;
390 snat_session_t *sessions;
392 /* Pool of doubly-linked list elements */
393 dlist_elt_t *list_pool;
395 /* NAT thread index */
396 u32 snat_thread_index;
397 } snat_main_per_thread_data_t;
401 /* ICMP session match function */
402 typedef u32 (snat_icmp_match_function_t) (struct snat_main_s * sm,
403 vlib_node_runtime_t * node,
406 ip4_header_t * ip0, u8 * p_proto,
407 snat_session_key_t * p_value,
408 u8 * p_dont_translate, void *d,
411 /* Return worker thread index for given packet */
412 typedef u32 (snat_get_worker_function_t) (ip4_header_t * ip,
415 /* NAT address and port allacotaion function */
416 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
420 snat_session_key_t * k,
422 u32 snat_thread_index);
424 typedef struct snat_main_s
426 /* ICMP session match functions */
427 snat_icmp_match_function_t *icmp_match_in2out_cb;
428 snat_icmp_match_function_t *icmp_match_out2in_cb;
430 /* Thread settings */
432 u32 first_worker_index;
434 snat_get_worker_function_t *worker_in2out_cb;
435 snat_get_worker_function_t *worker_out2in_cb;
439 /* Per thread data */
440 snat_main_per_thread_data_t *per_thread_data;
442 /* Find a static mapping by local */
443 clib_bihash_8_8_t static_mapping_by_local;
445 /* Find a static mapping by external */
446 clib_bihash_8_8_t static_mapping_by_external;
448 /* Static mapping pool */
449 snat_static_mapping_t *static_mappings;
452 snat_interface_t *interfaces;
453 snat_interface_t *output_feature_interfaces;
455 /* Vector of outside addresses */
456 snat_address_t *addresses;
457 /* Address and port allocation function */
458 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
459 /* Address and port allocation type */
460 nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
461 /* Port set parameters (MAP-E) */
465 /* Port range parameters */
469 /* vector of outside fibs */
470 nat_outside_fib_t *outside_fibs;
472 /* Vector of twice NAT addresses for extenal hosts */
473 snat_address_t *twice_nat_addresses;
475 /* sw_if_indices whose intfc addresses should be auto-added */
476 u32 *auto_add_sw_if_indices;
477 u32 *auto_add_sw_if_indices_twice_nat;
479 /* vector of interface address static mappings to resolve. */
480 snat_static_map_resolve_t *to_resolve;
482 /* Randomize port allocation order */
485 /* Worker handoff frame-queue index */
487 u32 fq_in2out_output_index;
490 /* in2out and out2in node index */
491 u32 in2out_node_index;
492 u32 in2out_output_node_index;
493 u32 out2in_node_index;
494 u32 error_node_index;
496 /* Deterministic NAT mappings */
497 snat_det_map_t *det_maps;
499 /* If forwarding is enabled */
500 u8 forwarding_enabled;
502 /* Config parameters */
503 u8 static_mapping_only;
504 u8 static_mapping_connection_tracking;
507 u8 endpoint_dependent;
508 u32 translation_buckets;
509 u32 translation_memory_size;
510 u32 max_translations;
512 u32 user_memory_size;
513 u32 max_translations_per_user;
515 u32 outside_fib_index;
517 u32 inside_fib_index;
519 /* values of various timeouts */
521 u32 tcp_established_timeout;
522 u32 tcp_transitory_timeout;
525 /* TCP MSS clamping */
529 /* API message ID base */
533 vlib_log_class_t log_class;
536 vlib_main_t *vlib_main;
537 vnet_main_t *vnet_main;
538 ip4_main_t *ip4_main;
539 ip_lookup_main_t *ip4_lookup_main;
540 api_main_t *api_main;
547 } nat44_is_idle_session_ctx_t;
551 u32 cached_sw_if_index;
552 u32 cached_ip4_address;
555 extern snat_main_t snat_main;
556 extern vlib_node_registration_t snat_in2out_node;
557 extern vlib_node_registration_t snat_in2out_output_node;
558 extern vlib_node_registration_t snat_out2in_node;
559 extern vlib_node_registration_t snat_in2out_fast_node;
560 extern vlib_node_registration_t snat_out2in_fast_node;
561 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
562 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
563 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
564 extern vlib_node_registration_t snat_det_in2out_node;
565 extern vlib_node_registration_t snat_det_out2in_node;
566 extern vlib_node_registration_t snat_hairpin_dst_node;
567 extern vlib_node_registration_t snat_hairpin_src_node;
568 extern vlib_node_registration_t nat44_ed_in2out_node;
569 extern vlib_node_registration_t nat44_ed_in2out_output_node;
570 extern vlib_node_registration_t nat44_ed_out2in_node;
571 extern vlib_node_registration_t nat44_ed_hairpin_dst_node;
572 extern vlib_node_registration_t nat44_ed_hairpin_src_node;
573 extern vlib_node_registration_t nat44_ed_in2out_worker_handoff_node;
574 extern vlib_node_registration_t nat44_ed_in2out_output_worker_handoff_node;
575 extern vlib_node_registration_t nat44_ed_out2in_worker_handoff_node;
577 /* format functions */
578 format_function_t format_snat_user;
579 format_function_t format_snat_static_mapping;
580 format_function_t format_snat_static_map_to_resolve;
581 format_function_t format_snat_session;
582 format_function_t format_det_map_ses;
583 format_function_t format_snat_key;
584 format_function_t format_static_mapping_key;
585 format_function_t format_snat_protocol;
586 format_function_t format_nat_addr_and_port_alloc_alg;
587 format_function_t format_nat44_reass_trace;
588 /* unformat functions */
589 unformat_function_t unformat_snat_protocol;
591 /** \brief Check if SNAT session is created from static mapping.
592 @param s SNAT session
593 @return 1 if SNAT session is created from static mapping otherwise 0
595 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
597 /** \brief Check if SNAT session for unknown protocol.
598 @param s SNAT session
599 @return 1 if SNAT session for unknown protocol otherwise 0
601 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
603 /** \brief Check if NAT session is twice NAT.
605 @return 1 if NAT session is twice NAT
607 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
609 /** \brief Check if NAT session is load-balancing.
611 @return 1 if NAT session is load-balancing
613 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
615 /** \brief Check if NAT session is forwarding bypass.
617 @return 1 if NAT session is load-balancing
619 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
621 /** \brief Check if NAT session is endpoint dependent.
623 @return 1 if NAT session is endpoint dependent
625 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
627 /** \brief Check if NAT session has affinity record.
629 @return 1 if NAT session has affinity record
631 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
633 /** \brief Check if NAT interface is inside.
634 @param i NAT interfce
635 @return 1 if inside interface
637 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
639 /** \brief Check if NAT interface is outside.
640 @param i NAT interfce
641 @return 1 if outside interface
643 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
645 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
647 @return 1 if session is closed
649 #define nat44_is_ses_closed(s) s->state == 0xf
651 /** \brief Check if NAT static mapping is address only (1:1NAT).
652 @param sm NAT static mapping
653 @return 1 if 1:1NAT, 0 if 1:1NAPT
655 #define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY)
657 /** \brief Check if NAT static mapping match only out2in direction.
658 @param sm NAT static mapping
659 @return 1 if rule match only out2in direction
661 #define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY)
663 /** \brief Check if NAT static mapping is identity NAT.
664 @param sm NAT static mapping
665 @return 1 if identity NAT
667 #define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT)
670 #define nat_log_err(...) \
671 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
672 #define nat_log_warn(...) \
673 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
674 #define nat_log_notice(...) \
675 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
676 #define nat_log_info(...) \
677 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
678 #define nat_log_debug(...)\
679 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
681 /* ICMP session match functions */
682 u32 icmp_match_in2out_fast (snat_main_t * sm, vlib_node_runtime_t * node,
683 u32 thread_index, vlib_buffer_t * b0,
684 ip4_header_t * ip0, u8 * p_proto,
685 snat_session_key_t * p_value,
686 u8 * p_dont_translate, void *d, void *e);
687 u32 icmp_match_in2out_slow (snat_main_t * sm, vlib_node_runtime_t * node,
688 u32 thread_index, vlib_buffer_t * b0,
689 ip4_header_t * ip0, u8 * p_proto,
690 snat_session_key_t * p_value,
691 u8 * p_dont_translate, void *d, void *e);
692 u32 icmp_match_out2in_fast (snat_main_t * sm, vlib_node_runtime_t * node,
693 u32 thread_index, vlib_buffer_t * b0,
694 ip4_header_t * ip0, u8 * p_proto,
695 snat_session_key_t * p_value,
696 u8 * p_dont_translate, void *d, void *e);
697 u32 icmp_match_out2in_slow (snat_main_t * sm, vlib_node_runtime_t * node,
698 u32 thread_index, vlib_buffer_t * b0,
699 ip4_header_t * ip0, u8 * p_proto,
700 snat_session_key_t * p_value,
701 u8 * p_dont_translate, void *d, void *e);
703 /* ICMP deterministic NAT session match functions */
704 u32 icmp_match_out2in_det (snat_main_t * sm, vlib_node_runtime_t * node,
705 u32 thread_index, vlib_buffer_t * b0,
706 ip4_header_t * ip0, u8 * p_proto,
707 snat_session_key_t * p_value,
708 u8 * p_dont_translate, void *d, void *e);
709 u32 icmp_match_in2out_det (snat_main_t * sm, vlib_node_runtime_t * node,
710 u32 thread_index, vlib_buffer_t * b0,
711 ip4_header_t * ip0, u8 * p_proto,
712 snat_session_key_t * p_value,
713 u8 * p_dont_translate, void *d, void *e);
715 /* ICMP endpoint-dependent session match functions */
716 u32 icmp_match_out2in_ed (snat_main_t * sm, vlib_node_runtime_t * node,
717 u32 thread_index, vlib_buffer_t * b0,
718 ip4_header_t * ip0, u8 * p_proto,
719 snat_session_key_t * p_value,
720 u8 * p_dont_translate, void *d, void *e);
721 u32 icmp_match_in2out_ed (snat_main_t * sm, vlib_node_runtime_t * node,
722 u32 thread_index, vlib_buffer_t * b0,
723 ip4_header_t * ip0, u8 * p_proto,
724 snat_session_key_t * p_value,
725 u8 * p_dont_translate, void *d, void *e);
727 u32 icmp_in2out (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
728 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
729 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
732 u32 icmp_out2in (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
733 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
734 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
737 /* hairpinning functions */
738 u32 snat_icmp_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
739 ip4_header_t * ip0, icmp46_header_t * icmp0,
741 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
743 void nat44_ed_hairpinning_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
745 int snat_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
746 ip4_header_t * ip0, udp_header_t * udp0,
747 tcp_header_t * tcp0, u32 proto0, int is_ed);
748 void nat44_reass_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
749 ip4_header_t * ip0, u16 sport, u16 dport,
750 u32 proto0, int is_ed);
752 /* Call back functions for clib_bihash_add_or_overwrite_stale */
753 int nat44_i2o_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
754 int nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
755 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
756 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
759 * @brief Increment IPv4 address
761 void increment_v4_address (ip4_address_t * a);
764 * @brief Add external address to NAT44 pool
766 * @param addr IPv4 address
767 * @param vrf_id VRF id of tenant, ~0 means independent of VRF
768 * @param twice_nat 1 if twice NAT address
770 * @return 0 on success, non-zero value otherwise
772 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
776 * @brief Delete external address from NAT44 pool
778 * @param addr IPv4 address
779 * @param delete_sm 1 if delete static mapping using address
780 * @param twice_nat 1 if twice NAT address
782 * @return 0 on success, non-zero value otherwise
784 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
788 * @brief Add/delete external address to FIB DPO (out2in DPO mode)
790 * @param addr IPv4 address
791 * @param is_add 1 = add, 0 = delete
793 * @return 0 on success, non-zero value otherwise
795 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
798 * @brief Add/delete NAT44 static mapping
800 * @param l_addr local IPv4 address
801 * @param e_addr external IPv4 address
802 * @param l_port local port number
803 * @param e_port external port number
804 * @param vrf_id local VRF ID
805 * @param addr_only 1 = 1:1NAT, 0 = 1:1NAPT
806 * @param sw_if_index use interface address as external IPv4 address
807 * @param proto L4 protocol
808 * @param is_add 1 = add, 0 = delete
809 * @param twice_nat twice-nat mode
810 * @param out2in_only if 1 rule match only out2in direction
811 * @param tag opaque string tag
812 * @param identity_nat identity NAT
814 * @return 0 on success, non-zero value otherwise
816 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
817 u16 l_port, u16 e_port, u32 vrf_id,
818 int addr_only, u32 sw_if_index,
819 snat_protocol_t proto, int is_add,
820 twice_nat_type_t twice_nat, u8 out2in_only,
821 u8 * tag, u8 identity_nat);
824 * @brief Add/delete static mapping with load-balancing (multiple backends)
826 * @param e_addr external IPv4 address
827 * @param e_port external port number
828 * @param proto L4 protocol
829 * @param locals list of local backends
830 * @param is_add 1 = add, 0 = delete
831 * @param twice_nat twice-nat mode
832 * @param out2in_only if 1 rule match only out2in direction
833 * @param tag opaque string tag
834 * @param affinity 0 = disabled, otherwise client IP affinity sticky time
836 * @return 0 on success, non-zero value otherwise
838 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
839 snat_protocol_t proto,
840 nat44_lb_addr_port_t * locals, u8 is_add,
841 twice_nat_type_t twice_nat,
842 u8 out2in_only, u8 * tag, u32 affinity);
844 clib_error_t *snat_api_init (vlib_main_t * vm, snat_main_t * sm);
847 * @brief Set NAT plugin workers
849 * @param bitmap NAT workers bitmap
851 * @return 0 on success, non-zero value otherwise
853 int snat_set_workers (uword * bitmap);
856 * @brief Enable/disable NAT44 feature on the interface
858 * @param sw_if_index software index of the interface
859 * @param is_inside 1 = inside, 0 = outside
860 * @param is_del 1 = delete, 0 = add
862 * @return 0 on success, non-zero value otherwise
864 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
867 * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
869 * @param sw_if_index software index of the interface
870 * @param is_inside 1 = inside, 0 = outside
871 * @param is_del 1 = delete, 0 = add
873 * @return 0 on success, non-zero value otherwise
875 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
879 * @brief Add/delete NAT44 pool address from specific interfce
881 * @param sw_if_index software index of the interface
882 * @param is_del 1 = delete, 0 = add
883 * @param twice_nat 1 = twice NAT address for extenal hosts
885 * @return 0 on success, non-zero value otherwise
887 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
891 * @brief Delete NAT44 session
893 * @param addr IPv4 address
894 * @param port L4 port number
895 * @param proto L4 protocol
896 * @param vrf_id VRF ID
897 * @param is_in 1 = inside network addres and por pair, 0 = outside
899 * @return 0 on success, non-zero value otherwise
901 int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
902 snat_protocol_t proto, u32 vrf_id, int is_in);
905 * @brief Delete NAT44 endpoint-dependent session
907 * @param addr IPv4 address
908 * @param port L4 port number
909 * @param proto L4 protocol
910 * @param vrf_id VRF ID
911 * @param is_in 1 = inside network addres and por pair, 0 = outside
913 * @return 0 on success, non-zero value otherwise
915 int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
916 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
917 u32 vrf_id, int is_in);
920 * @brief Free NAT44 session data (lookup keys, external addrres port)
922 * @param s NAT session
923 * @param thread_index thread index
925 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
929 * @brief Find or create NAT user
931 * @param addr IPv4 address
932 * @param fib_index FIB table index
933 * @param thread_index thread index
935 * @return NAT user data structure on success otherwise zero value
937 snat_user_t *nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr,
938 u32 fib_index, u32 thread_index);
941 * @brief Allocate new NAT session or recycle last used
944 * @param thread_index thread index
946 * @return session data structure on success otherwise zero value
948 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
953 * @brief Allocate NAT endpoint-dependent session
956 * @param thread_index thread index
958 * @return session data structure on success otherwise zero value
960 snat_session_t *nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u,
961 u32 thread_index, f64 now);
964 * @brief Set address and port assignment algorithm for MAP-E CE
966 * @param psid Port Set Identifier value
967 * @param psid_offset number of offset bits
968 * @param psid_length length of PSID
970 void nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset,
974 * @brief Set address and port assignment algorithm for port range
976 * @param start_port beginning of the port range
977 * @param end_port end of the port range
979 void nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port);
982 * @brief Set address and port assignment algorithm to default/standard
984 void nat_set_alloc_addr_and_port_default (void);
987 * @brief Free outside address and port pair
989 * @param addresses vector of outside addresses
990 * @param thread_index thread index
991 * @param k adddress, port and protocol
993 void snat_free_outside_address_and_port (snat_address_t * addresses,
995 snat_session_key_t * k);
998 * @brief Alloc outside address and port
1000 * @param addresses vector of outside addresses
1001 * @param fib_index FIB table index
1002 * @param thread_index thread index
1003 * @param k allocated address and port pair
1004 * @param port_per_thread number of ports per threead
1005 * @param snat_thread_index NAT thread index
1007 * @return 0 on success, non-zero value otherwise
1009 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
1012 snat_session_key_t * k,
1013 u16 port_per_thread,
1014 u32 snat_thread_index);
1017 * @brief Match NAT44 static mapping.
1019 * @param match address and port to match
1020 * @param mapping external/local address and port of the matched mapping
1021 * @param by_external if 0 match by local address otherwise match by external
1023 * @param is_addr_only 1 if matched mapping is address only
1024 * @param twice_nat matched mapping is twice NAT type
1025 * @param lb 1 if matched mapping is load-balanced
1026 * @param ext_host_addr external host address
1028 * @returns 0 if match found otherwise 1.
1030 int snat_static_mapping_match (snat_main_t * sm,
1031 snat_session_key_t match,
1032 snat_session_key_t * mapping,
1035 twice_nat_type_t * twice_nat,
1037 ip4_address_t * ext_host_addr,
1038 u8 * is_identity_nat);
1041 * @brief Add/del NAT address to FIB.
1043 * Add the external NAT address to the FIB as receive entries. This ensures
1044 * that VPP will reply to ARP for this address and we don't need to enable
1045 * proxy ARP on the outside interface.
1047 * @param addr IPv4 address
1048 * @param plen address prefix length
1049 * @param sw_if_index software index of the outside interface
1050 * @param is_add 0 = delete, 1 = add.
1052 void snat_add_del_addr_to_fib (ip4_address_t * addr,
1053 u8 p_len, u32 sw_if_index, int is_add);
1057 * Why is this here? Because we don't need to touch this layer to
1058 * simply reply to an icmp. We need to change id to a unique
1059 * value to NAT an echo request/reply.
1066 } icmp_echo_header_t;
1070 u16 src_port, dst_port;
1073 #endif /* __included_nat_h__ */
1076 * fd.io coding-style-patch-verification: ON
1079 * eval: (c-set-style "gnu")