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
183 typedef CLIB_PACKED(struct
185 /* Outside network key */
186 snat_session_key_t out2in;
188 /* Inside network key */
189 snat_session_key_t in2out;
194 /* Per-user translations */
196 u32 per_user_list_head_index;
198 /* Last heard timer */
205 /* External host address and port */
206 ip4_address_t ext_host_addr;
209 /* External host address and port after translation */
210 ip4_address_t ext_host_nat_addr;
211 u16 ext_host_nat_port;
213 /* TCP session state */
225 u32 sessions_per_user_list_head_index;
235 #define _(N, i, n, s) \
236 u16 busy_##n##_ports; \
237 u16 * busy_##n##_ports_per_thread; \
238 uword * busy_##n##_port_bitmap;
239 foreach_snat_protocol
252 /* Inside network port */
254 /* Outside network address and port */
255 snat_det_out_key_t out;
260 } snat_det_session_t;
264 /* inside IP address range */
265 ip4_address_t in_addr;
267 /* outside IP address range */
268 ip4_address_t out_addr;
270 /* inside IP addresses / outside IP addresses */
272 /* number of ports available to internal host */
274 /* session counter */
276 /* vector of sessions */
277 snat_det_session_t *sessions;
282 /* backend IP address */
284 /* backend port number */
286 /* probability of the backend to be randomly matched */
289 /* backend FIB table */
292 } nat44_lb_addr_port_t;
296 /* twice-nat disabled */
298 /* twice-nat enabled */
300 /* twice-nat only when src IP equals dst IP after translation */
306 /* no load-balancing */
310 /* load-balancing with affinity */
316 /* local IP address */
317 ip4_address_t local_addr;
318 /* external IP address */
319 ip4_address_t external_addr;
324 /* 1 = 1:1NAT, 0 = 1:1NAPT */
327 twice_nat_type_t twice_nat;
328 /* 1 = rule match only out2in direction */
330 /* local FIB table */
334 snat_protocol_t proto;
335 /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
337 /* worker threads used by backends/local host */
339 /* opaque string tag */
341 /* backends for load-balancing mode */
342 nat44_lb_addr_port_t *locals;
343 /* affinity per service lis */
344 u32 affinity_per_service_list_head_index;
345 } snat_static_mapping_t;
355 ip4_address_t l_addr;
360 snat_protocol_t proto;
365 } snat_static_map_resolve_t;
369 /* Main lookup tables */
370 clib_bihash_8_8_t out2in;
371 clib_bihash_8_8_t in2out;
373 /* Endpoint dependent sessions lookup tables */
374 clib_bihash_16_8_t out2in_ed;
375 clib_bihash_16_8_t in2out_ed;
377 /* Find-a-user => src address lookup */
378 clib_bihash_8_8_t user_hash;
384 snat_session_t *sessions;
386 /* Pool of doubly-linked list elements */
387 dlist_elt_t *list_pool;
389 /* NAT thread index */
390 u32 snat_thread_index;
391 } snat_main_per_thread_data_t;
395 /* ICMP session match function */
396 typedef u32 (snat_icmp_match_function_t) (struct snat_main_s * sm,
397 vlib_node_runtime_t * node,
400 ip4_header_t * ip0, u8 * p_proto,
401 snat_session_key_t * p_value,
402 u8 * p_dont_translate, void *d,
405 /* Return worker thread index for given packet */
406 typedef u32 (snat_get_worker_function_t) (ip4_header_t * ip,
409 /* NAT address and port allacotaion function */
410 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
414 snat_session_key_t * k,
416 u32 snat_thread_index);
418 typedef struct snat_main_s
420 /* ICMP session match functions */
421 snat_icmp_match_function_t *icmp_match_in2out_cb;
422 snat_icmp_match_function_t *icmp_match_out2in_cb;
424 /* Thread settings */
426 u32 first_worker_index;
428 snat_get_worker_function_t *worker_in2out_cb;
429 snat_get_worker_function_t *worker_out2in_cb;
433 /* Per thread data */
434 snat_main_per_thread_data_t *per_thread_data;
436 /* Find a static mapping by local */
437 clib_bihash_8_8_t static_mapping_by_local;
439 /* Find a static mapping by external */
440 clib_bihash_8_8_t static_mapping_by_external;
442 /* Static mapping pool */
443 snat_static_mapping_t *static_mappings;
446 snat_interface_t *interfaces;
447 snat_interface_t *output_feature_interfaces;
449 /* Vector of outside addresses */
450 snat_address_t *addresses;
451 /* Address and port allocation function */
452 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
453 /* Address and port allocation type */
454 nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
455 /* Port set parameters (MAP-E) */
459 /* Port range parameters */
463 /* vector of outside fibs */
464 nat_outside_fib_t *outside_fibs;
466 /* Vector of twice NAT addresses for extenal hosts */
467 snat_address_t *twice_nat_addresses;
469 /* sw_if_indices whose intfc addresses should be auto-added */
470 u32 *auto_add_sw_if_indices;
471 u32 *auto_add_sw_if_indices_twice_nat;
473 /* vector of interface address static mappings to resolve. */
474 snat_static_map_resolve_t *to_resolve;
476 /* Randomize port allocation order */
479 /* Worker handoff frame-queue index */
481 u32 fq_in2out_output_index;
484 /* in2out and out2in node index */
485 u32 in2out_node_index;
486 u32 in2out_output_node_index;
487 u32 out2in_node_index;
488 u32 error_node_index;
490 /* Deterministic NAT mappings */
491 snat_det_map_t *det_maps;
493 /* If forwarding is enabled */
494 u8 forwarding_enabled;
496 /* Config parameters */
497 u8 static_mapping_only;
498 u8 static_mapping_connection_tracking;
501 u8 endpoint_dependent;
502 u32 translation_buckets;
503 u32 translation_memory_size;
504 u32 max_translations;
506 u32 user_memory_size;
507 u32 max_translations_per_user;
509 u32 outside_fib_index;
511 u32 inside_fib_index;
513 /* values of various timeouts */
515 u32 tcp_established_timeout;
516 u32 tcp_transitory_timeout;
519 /* TCP MSS clamping */
523 /* API message ID base */
527 vlib_log_class_t log_class;
530 vlib_main_t *vlib_main;
531 vnet_main_t *vnet_main;
532 ip4_main_t *ip4_main;
533 ip_lookup_main_t *ip4_lookup_main;
534 api_main_t *api_main;
541 } nat44_is_idle_session_ctx_t;
545 u32 cached_sw_if_index;
546 u32 cached_ip4_address;
549 extern snat_main_t snat_main;
550 extern vlib_node_registration_t snat_in2out_node;
551 extern vlib_node_registration_t snat_in2out_output_node;
552 extern vlib_node_registration_t snat_out2in_node;
553 extern vlib_node_registration_t snat_in2out_fast_node;
554 extern vlib_node_registration_t snat_out2in_fast_node;
555 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
556 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
557 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
558 extern vlib_node_registration_t snat_det_in2out_node;
559 extern vlib_node_registration_t snat_det_out2in_node;
560 extern vlib_node_registration_t snat_hairpin_dst_node;
561 extern vlib_node_registration_t snat_hairpin_src_node;
562 extern vlib_node_registration_t nat44_ed_in2out_node;
563 extern vlib_node_registration_t nat44_ed_in2out_output_node;
564 extern vlib_node_registration_t nat44_ed_out2in_node;
565 extern vlib_node_registration_t nat44_ed_hairpin_dst_node;
566 extern vlib_node_registration_t nat44_ed_hairpin_src_node;
567 extern vlib_node_registration_t nat44_ed_in2out_worker_handoff_node;
568 extern vlib_node_registration_t nat44_ed_in2out_output_worker_handoff_node;
569 extern vlib_node_registration_t nat44_ed_out2in_worker_handoff_node;
571 /* format functions */
572 format_function_t format_snat_user;
573 format_function_t format_snat_static_mapping;
574 format_function_t format_snat_static_map_to_resolve;
575 format_function_t format_snat_session;
576 format_function_t format_det_map_ses;
577 format_function_t format_snat_key;
578 format_function_t format_static_mapping_key;
579 format_function_t format_snat_protocol;
580 format_function_t format_nat_addr_and_port_alloc_alg;
581 format_function_t format_nat44_reass_trace;
582 /* unformat functions */
583 unformat_function_t unformat_snat_protocol;
585 /** \brief Check if SNAT session is created from static mapping.
586 @param s SNAT session
587 @return 1 if SNAT session is created from static mapping otherwise 0
589 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
591 /** \brief Check if SNAT session for unknown protocol.
592 @param s SNAT session
593 @return 1 if SNAT session for unknown protocol otherwise 0
595 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
597 /** \brief Check if NAT session is twice NAT.
599 @return 1 if NAT session is twice NAT
601 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
603 /** \brief Check if NAT session is load-balancing.
605 @return 1 if NAT session is load-balancing
607 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
609 /** \brief Check if NAT session is forwarding bypass.
611 @return 1 if NAT session is load-balancing
613 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
615 /** \brief Check if NAT session is endpoint dependent.
617 @return 1 if NAT session is endpoint dependent
619 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
621 /** \brief Check if NAT session has affinity record.
623 @return 1 if NAT session has affinity record
625 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
627 /** \brief Check if NAT interface is inside.
628 @param i NAT interfce
629 @return 1 if inside interface
631 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
633 /** \brief Check if NAT interface is outside.
634 @param i NAT interfce
635 @return 1 if outside interface
637 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
639 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
641 @return 1 if session is closed
643 #define nat44_is_ses_closed(s) s->state == 0xf
646 #define nat_log_err(...) \
647 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
648 #define nat_log_warn(...) \
649 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
650 #define nat_log_notice(...) \
651 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
652 #define nat_log_info(...) \
653 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
654 #define nat_log_debug(...)\
655 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
657 /* ICMP session match functions */
658 u32 icmp_match_in2out_fast (snat_main_t * sm, vlib_node_runtime_t * node,
659 u32 thread_index, vlib_buffer_t * b0,
660 ip4_header_t * ip0, u8 * p_proto,
661 snat_session_key_t * p_value,
662 u8 * p_dont_translate, void *d, void *e);
663 u32 icmp_match_in2out_slow (snat_main_t * sm, vlib_node_runtime_t * node,
664 u32 thread_index, vlib_buffer_t * b0,
665 ip4_header_t * ip0, u8 * p_proto,
666 snat_session_key_t * p_value,
667 u8 * p_dont_translate, void *d, void *e);
668 u32 icmp_match_out2in_fast (snat_main_t * sm, vlib_node_runtime_t * node,
669 u32 thread_index, vlib_buffer_t * b0,
670 ip4_header_t * ip0, u8 * p_proto,
671 snat_session_key_t * p_value,
672 u8 * p_dont_translate, void *d, void *e);
673 u32 icmp_match_out2in_slow (snat_main_t * sm, vlib_node_runtime_t * node,
674 u32 thread_index, vlib_buffer_t * b0,
675 ip4_header_t * ip0, u8 * p_proto,
676 snat_session_key_t * p_value,
677 u8 * p_dont_translate, void *d, void *e);
679 /* ICMP deterministic NAT session match functions */
680 u32 icmp_match_out2in_det (snat_main_t * sm, vlib_node_runtime_t * node,
681 u32 thread_index, vlib_buffer_t * b0,
682 ip4_header_t * ip0, u8 * p_proto,
683 snat_session_key_t * p_value,
684 u8 * p_dont_translate, void *d, void *e);
685 u32 icmp_match_in2out_det (snat_main_t * sm, vlib_node_runtime_t * node,
686 u32 thread_index, vlib_buffer_t * b0,
687 ip4_header_t * ip0, u8 * p_proto,
688 snat_session_key_t * p_value,
689 u8 * p_dont_translate, void *d, void *e);
691 /* ICMP endpoint-dependent session match functions */
692 u32 icmp_match_out2in_ed (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_in2out_ed (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 u32 icmp_in2out (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
704 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
705 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
708 u32 icmp_out2in (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
709 icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
710 vlib_node_runtime_t * node, u32 next0, u32 thread_index,
713 /* hairpinning functions */
714 u32 snat_icmp_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
715 ip4_header_t * ip0, icmp46_header_t * icmp0,
717 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
719 void nat44_ed_hairpinning_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
721 int snat_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
722 ip4_header_t * ip0, udp_header_t * udp0,
723 tcp_header_t * tcp0, u32 proto0, int is_ed);
724 void nat44_reass_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
725 ip4_header_t * ip0, u16 sport, u16 dport,
726 u32 proto0, int is_ed);
728 /* Call back functions for clib_bihash_add_or_overwrite_stale */
729 int nat44_i2o_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
730 int nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
731 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
732 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
735 * @brief Increment IPv4 address
737 void increment_v4_address (ip4_address_t * a);
740 * @brief Add external address to NAT44 pool
742 * @param addr IPv4 address
743 * @param vrf_id VRF id of tenant, ~0 means independent of VRF
744 * @param twice_nat 1 if twice NAT address
746 * @return 0 on success, non-zero value otherwise
748 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
752 * @brief Delete external address from NAT44 pool
754 * @param addr IPv4 address
755 * @param delete_sm 1 if delete static mapping using address
756 * @param twice_nat 1 if twice NAT address
758 * @return 0 on success, non-zero value otherwise
760 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
764 * @brief Add/delete external address to FIB DPO (out2in DPO mode)
766 * @param addr IPv4 address
767 * @param is_add 1 = add, 0 = delete
769 * @return 0 on success, non-zero value otherwise
771 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
774 * @brief Add/delete NAT44 static mapping
776 * @param l_addr local IPv4 address
777 * @param e_addr external IPv4 address
778 * @param l_port local port number
779 * @param e_port external port number
780 * @param vrf_id local VRF ID
781 * @param addr_only 1 = 1:1NAT, 0 = 1:1NAPT
782 * @param sw_if_index use interface address as external IPv4 address
783 * @param proto L4 protocol
784 * @param is_add 1 = add, 0 = delete
785 * @param twice_nat twice-nat mode
786 * @param out2in_only if 1 rule match only out2in direction
787 * @param tagi opaque string tag
789 * @return 0 on success, non-zero value otherwise
791 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
792 u16 l_port, u16 e_port, u32 vrf_id,
793 int addr_only, u32 sw_if_index,
794 snat_protocol_t proto, int is_add,
795 twice_nat_type_t twice_nat, u8 out2in_only,
799 * @brief Add/delete static mapping with load-balancing (multiple backends)
801 * @param e_addr external IPv4 address
802 * @param e_port external port number
803 * @param proto L4 protocol
804 * @param locals list of local backends
805 * @param is_add 1 = add, 0 = delete
806 * @param twice_nat twice-nat mode
807 * @param out2in_only if 1 rule match only out2in direction
808 * @param tag opaque string tag
809 * @param affinity 0 = disabled, otherwise client IP affinity sticky time
811 * @return 0 on success, non-zero value otherwise
813 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
814 snat_protocol_t proto,
815 nat44_lb_addr_port_t * locals, u8 is_add,
816 twice_nat_type_t twice_nat,
817 u8 out2in_only, u8 * tag, u32 affinity);
819 clib_error_t *snat_api_init (vlib_main_t * vm, snat_main_t * sm);
822 * @brief Set NAT plugin workers
824 * @param bitmap NAT workers bitmap
826 * @return 0 on success, non-zero value otherwise
828 int snat_set_workers (uword * bitmap);
831 * @brief Enable/disable NAT44 feature on the interface
833 * @param sw_if_index software index of the interface
834 * @param is_inside 1 = inside, 0 = outside
835 * @param is_del 1 = delete, 0 = add
837 * @return 0 on success, non-zero value otherwise
839 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
842 * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
844 * @param sw_if_index software index of the interface
845 * @param is_inside 1 = inside, 0 = outside
846 * @param is_del 1 = delete, 0 = add
848 * @return 0 on success, non-zero value otherwise
850 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
854 * @brief Add/delete NAT44 pool address from specific interfce
856 * @param sw_if_index software index of the interface
857 * @param is_del 1 = delete, 0 = add
858 * @param twice_nat 1 = twice NAT address for extenal hosts
860 * @return 0 on success, non-zero value otherwise
862 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
866 * @brief Delete NAT44 session
868 * @param addr IPv4 address
869 * @param port L4 port number
870 * @param proto L4 protocol
871 * @param vrf_id VRF ID
872 * @param is_in 1 = inside network addres and por pair, 0 = outside
874 * @return 0 on success, non-zero value otherwise
876 int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
877 snat_protocol_t proto, u32 vrf_id, int is_in);
880 * @brief Delete NAT44 endpoint-dependent session
882 * @param addr IPv4 address
883 * @param port L4 port number
884 * @param proto L4 protocol
885 * @param vrf_id VRF ID
886 * @param is_in 1 = inside network addres and por pair, 0 = outside
888 * @return 0 on success, non-zero value otherwise
890 int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
891 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
892 u32 vrf_id, int is_in);
895 * @brief Free NAT44 session data (lookup keys, external addrres port)
897 * @param s NAT session
898 * @param thread_index thread index
900 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
904 * @brief Find or create NAT user
906 * @param addr IPv4 address
907 * @param fib_index FIB table index
908 * @param thread_index thread index
910 * @return NAT user data structure on success otherwise zero value
912 snat_user_t *nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr,
913 u32 fib_index, u32 thread_index);
916 * @brief Allocate new NAT session or recycle last used
919 * @param thread_index thread index
921 * @return session data structure on success otherwise zero value
923 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
928 * @brief Allocate NAT endpoint-dependent session
931 * @param thread_index thread index
933 * @return session data structure on success otherwise zero value
935 snat_session_t *nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u,
936 u32 thread_index, f64 now);
939 * @brief Set address and port assignment algorithm for MAP-E CE
941 * @param psid Port Set Identifier value
942 * @param psid_offset number of offset bits
943 * @param psid_length length of PSID
945 void nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset,
949 * @brief Set address and port assignment algorithm for port range
951 * @param start_port beginning of the port range
952 * @param end_port end of the port range
954 void nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port);
957 * @brief Set address and port assignment algorithm to default/standard
959 void nat_set_alloc_addr_and_port_default (void);
962 * @brief Free outside address and port pair
964 * @param addresses vector of outside addresses
965 * @param thread_index thread index
966 * @param k adddress, port and protocol
968 void snat_free_outside_address_and_port (snat_address_t * addresses,
970 snat_session_key_t * k);
973 * @brief Alloc outside address and port
975 * @param addresses vector of outside addresses
976 * @param fib_index FIB table index
977 * @param thread_index thread index
978 * @param k allocated address and port pair
979 * @param port_per_thread number of ports per threead
980 * @param snat_thread_index NAT thread index
982 * @return 0 on success, non-zero value otherwise
984 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
987 snat_session_key_t * k,
989 u32 snat_thread_index);
992 * @brief Match NAT44 static mapping.
994 * @param match address and port to match
995 * @param mapping external/local address and port of the matched mapping
996 * @param by_external if 0 match by local address otherwise match by external
998 * @param is_addr_only 1 if matched mapping is address only
999 * @param twice_nat matched mapping is twice NAT type
1000 * @param lb 1 if matched mapping is load-balanced
1001 * @param ext_host_addr external host address
1003 * @returns 0 if match found otherwise 1.
1005 int snat_static_mapping_match (snat_main_t * sm,
1006 snat_session_key_t match,
1007 snat_session_key_t * mapping,
1010 twice_nat_type_t * twice_nat,
1012 ip4_address_t * ext_host_addr);
1015 * @brief Add/del NAT address to FIB.
1017 * Add the external NAT address to the FIB as receive entries. This ensures
1018 * that VPP will reply to ARP for this address and we don't need to enable
1019 * proxy ARP on the outside interface.
1021 * @param addr IPv4 address
1022 * @param plen address prefix length
1023 * @param sw_if_index software index of the outside interface
1024 * @param is_add 0 = delete, 1 = add.
1026 void snat_add_del_addr_to_fib (ip4_address_t * addr,
1027 u8 p_len, u32 sw_if_index, int is_add);
1031 * Why is this here? Because we don't need to touch this layer to
1032 * simply reply to an icmp. We need to change id to a unique
1033 * value to NAT an echo request/reply.
1040 } icmp_echo_header_t;
1044 u16 src_port, dst_port;
1047 #endif /* __included_nat_h__ */
1050 * fd.io coding-style-patch-verification: ON
1053 * eval: (c-set-style "gnu")