src/plugins/nat/nat.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 /**
  16  * @file NAT plugin global declarations
  17  */
  18 #ifndef __included_nat_h__
  19 #define __included_nat_h__
  20
  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>
  33 #include <vlib/log.h>
  34 #include <vppinfra/bihash_16_8.h>
  35
  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
  41
  42 /* number of worker handoff frame queue elements */
  43 #define NAT_FQ_NELTS 64
  44
  45 /* NAT buffer flags */
  46 #define SNAT_FLAG_HAIRPINNING (1 << 0)
  47
  48 typedef enum
  49 {
  50   NAT_NEXT_DROP,
  51   NAT_NEXT_ICMP_ERROR,
  52   NAT_NEXT_IN2OUT_PRE,
  53   NAT_NEXT_OUT2IN_PRE,
  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,
  59   NAT_N_NEXT,
  60 } nat_next_t;
  61
  62 typedef struct
  63 {
  64   u32 next_index;
  65 } nat_pre_trace_t;
  66
  67 /* session key (4-tuple) */
  68 typedef struct
  69 {
  70   union
  71   {
  72     struct
  73     {
  74       ip4_address_t addr;
  75       u16 port;
  76       u16 protocol:3, fib_index:13;
  77     };
  78     u64 as_u64;
  79   };
  80 } snat_session_key_t;
  81
  82 /* deterministic session outside key */
  83 typedef struct
  84 {
  85   union
  86   {
  87     struct
  88     {
  89       ip4_address_t ext_host_addr;
  90       u16 ext_host_port;
  91       u16 out_port;
  92     };
  93     u64 as_u64;
  94   };
  95 } snat_det_out_key_t;
  96
  97 /* user (internal host) key */
  98 typedef struct
  99 {
 100   union
 101   {
 102     struct
 103     {
 104       ip4_address_t addr;
 105       u32 fib_index;
 106     };
 107     u64 as_u64;
 108   };
 109 } snat_user_key_t;
 110
 111 /* NAT API Configuration flags */
 112 #define foreach_nat_config_flag \
 113   _(0x01, IS_TWICE_NAT)         \
 114   _(0x02, IS_SELF_TWICE_NAT)    \
 115   _(0x04, IS_OUT2IN_ONLY)       \
 116   _(0x08, IS_ADDR_ONLY)         \
 117   _(0x10, IS_OUTSIDE)           \
 118   _(0x20, IS_INSIDE)            \
 119   _(0x40, IS_STATIC)            \
 120   _(0x80, IS_EXT_HOST_VALID)    \
 121
 122 typedef enum nat_config_flags_t_
 123 {
 124 #define _(n,f) NAT_API_##f = n,
 125   foreach_nat_config_flag
 126 #undef _
 127 } nat_config_flags_t;
 128
 129 /* External address and port allocation modes */
 130 #define foreach_nat_addr_and_port_alloc_alg \
 131   _(0, DEFAULT, "default")         \
 132   _(1, MAPE, "map-e")              \
 133   _(2, RANGE, "port-range")
 134
 135 typedef enum
 136 {
 137 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
 138   foreach_nat_addr_and_port_alloc_alg
 139 #undef _
 140 } nat_addr_and_port_alloc_alg_t;
 141
 142
 143 /* Supported L4 protocols */
 144 #define foreach_snat_protocol \
 145   _(UDP, 0, udp, "udp")       \
 146   _(TCP, 1, tcp, "tcp")       \
 147   _(ICMP, 2, icmp, "icmp")
 148
 149 typedef enum
 150 {
 151 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
 152   foreach_snat_protocol
 153 #undef _
 154 } snat_protocol_t;
 155
 156
 157 /* Session state */
 158 #define foreach_snat_session_state          \
 159   _(0, UNKNOWN, "unknown")                 \
 160   _(1, UDP_ACTIVE, "udp-active")           \
 161   _(2, TCP_SYN_SENT, "tcp-syn-sent")       \
 162   _(3, TCP_ESTABLISHED, "tcp-established") \
 163   _(4, TCP_FIN_WAIT, "tcp-fin-wait")       \
 164   _(5, TCP_CLOSE_WAIT, "tcp-close-wait")   \
 165   _(6, TCP_CLOSING, "tcp-closing")         \
 166   _(7, TCP_LAST_ACK, "tcp-last-ack")       \
 167   _(8, TCP_CLOSED, "tcp-closed")           \
 168   _(9, ICMP_ACTIVE, "icmp-active")
 169
 170 typedef enum
 171 {
 172 #define _(v, N, s) SNAT_SESSION_##N = v,
 173   foreach_snat_session_state
 174 #undef _
 175 } snat_session_state_t;
 176
 177 #define foreach_nat_in2out_ed_error                     \
 178 _(UNSUPPORTED_PROTOCOL, "unsupported protocol")         \
 179 _(IN2OUT_PACKETS, "good in2out packets processed")      \
 180 _(OUT_OF_PORTS, "out of ports")                         \
 181 _(BAD_ICMP_TYPE, "unsupported ICMP type")               \
 182 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded")   \
 183 _(MAX_USER_SESS_EXCEEDED, "max user sessions exceeded") \
 184 _(DROP_FRAGMENT, "drop fragment")                       \
 185 _(CANNOT_CREATE_USER, "cannot create NAT user")         \
 186 _(NON_SYN, "non-SYN packet try to create session")      \
 187 _(TCP_PACKETS, "TCP packets")                           \
 188 _(TCP_CLOSED, "drops due to TCP in transitory timeout") \
 189 _(UDP_PACKETS, "UDP packets")                           \
 190 _(ICMP_PACKETS, "ICMP packets")                         \
 191 _(OTHER_PACKETS, "other protocol packets")              \
 192 _(FRAGMENTS, "fragments")                               \
 193 _(CACHED_FRAGMENTS, "cached fragments")                 \
 194 _(PROCESSED_FRAGMENTS, "processed fragments")
 195
 196 typedef enum
 197 {
 198 #define _(sym,str) NAT_IN2OUT_ED_ERROR_##sym,
 199   foreach_nat_in2out_ed_error
 200 #undef _
 201     NAT_IN2OUT_ED_N_ERROR,
 202 } nat_in2out_ed_error_t;
 203
 204 #define foreach_nat_out2in_ed_error                     \
 205 _(UNSUPPORTED_PROTOCOL, "unsupported protocol")         \
 206 _(OUT2IN_PACKETS, "good out2in packets processed")      \
 207 _(OUT_OF_PORTS, "out of ports")                         \
 208 _(BAD_ICMP_TYPE, "unsupported ICMP type")               \
 209 _(NO_TRANSLATION, "no translation")                     \
 210 _(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded")   \
 211 _(MAX_USER_SESS_EXCEEDED, "max user sessions exceeded") \
 212 _(DROP_FRAGMENT, "drop fragment")                       \
 213 _(CANNOT_CREATE_USER, "cannot create NAT user")         \
 214 _(NON_SYN, "non-SYN packet try to create session")      \
 215 _(TCP_PACKETS, "TCP packets")                           \
 216 _(TCP_CLOSED, "drops due to TCP in transitory timeout") \
 217 _(UDP_PACKETS, "UDP packets")                           \
 218 _(ICMP_PACKETS, "ICMP packets")                         \
 219 _(OTHER_PACKETS, "other protocol packets")              \
 220 _(FRAGMENTS, "fragments")                               \
 221 _(CACHED_FRAGMENTS, "cached fragments")                 \
 222 _(PROCESSED_FRAGMENTS, "processed fragments")
 223
 224 typedef enum
 225 {
 226 #define _(sym,str) NAT_OUT2IN_ED_ERROR_##sym,
 227   foreach_nat_out2in_ed_error
 228 #undef _
 229     NAT_OUT2IN_ED_N_ERROR,
 230 } nat_out2in_ed_error_t;
 231
 232
 233 /* Endpoint dependent TCP session state */
 234 #define NAT44_SES_I2O_FIN 1
 235 #define NAT44_SES_O2I_FIN 2
 236 #define NAT44_SES_I2O_FIN_ACK 4
 237 #define NAT44_SES_O2I_FIN_ACK 8
 238 #define NAT44_SES_I2O_SYN 16
 239 #define NAT44_SES_O2I_SYN 32
 240 #define NAT44_SES_RST     64
 241
 242 /* Session flags */
 243 #define SNAT_SESSION_FLAG_STATIC_MAPPING       1
 244 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO        2
 245 #define SNAT_SESSION_FLAG_LOAD_BALANCING       4
 246 #define SNAT_SESSION_FLAG_TWICE_NAT            8
 247 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT   16
 248 #define SNAT_SESSION_FLAG_FWD_BYPASS           32
 249 #define SNAT_SESSION_FLAG_AFFINITY             64
 250 #define SNAT_SESSION_FLAG_OUTPUT_FEATURE       128
 251
 252 /* NAT interface flags */
 253 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
 254 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
 255
 256 /* Static mapping flags */
 257 #define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY    1
 258 #define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY  2
 259 #define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4
 260 #define NAT_STATIC_MAPPING_FLAG_LB           8
 261
 262 /* *INDENT-OFF* */
 263 typedef CLIB_PACKED(struct
 264 {
 265   /* Outside network key */
 266   snat_session_key_t out2in;
 267
 268   /* Inside network key */
 269   snat_session_key_t in2out;
 270
 271   /* Flags */
 272   u32 flags;
 273
 274   /* Per-user translations */
 275   u32 per_user_index;
 276   u32 per_user_list_head_index;
 277
 278   /* index in global LRU list */
 279   u32 global_lru_index;
 280   f64 last_lru_update;
 281
 282   /* Last heard timer */
 283   f64 last_heard;
 284
 285   /* Last HA refresh */
 286   f64 ha_last_refreshed;
 287
 288   /* Counters */
 289   u64 total_bytes;
 290   u32 total_pkts;
 291
 292   /* External host address and port */
 293   ip4_address_t ext_host_addr;
 294   u16 ext_host_port;
 295
 296   /* External host address and port after translation */
 297   ip4_address_t ext_host_nat_addr;
 298   u16 ext_host_nat_port;
 299
 300   /* TCP session state */
 301   u8 state;
 302   u32 i2o_fin_seq;
 303   u32 o2i_fin_seq;
 304   u32 tcp_close_timestamp;
 305
 306   /* user index */
 307   u32 user_index;
 308 }) snat_session_t;
 309 /* *INDENT-ON* */
 310
 311
 312 typedef struct
 313 {
 314   ip4_address_t addr;
 315   u32 fib_index;
 316   u32 sessions_per_user_list_head_index;
 317   u32 nsessions;
 318   u32 nstaticsessions;
 319 } snat_user_t;
 320
 321 typedef struct
 322 {
 323   ip4_address_t addr;
 324   u32 fib_index;
 325 /* *INDENT-OFF* */
 326 #define _(N, i, n, s) \
 327   u16 busy_##n##_ports; \
 328   u16 * busy_##n##_ports_per_thread; \
 329   u32 busy_##n##_port_refcounts[65535];
 330   foreach_snat_protocol
 331 #undef _
 332 /* *INDENT-ON* */
 333 } snat_address_t;
 334
 335 typedef struct
 336 {
 337   u32 fib_index;
 338   u32 refcount;
 339 } nat_outside_fib_t;
 340
 341 typedef struct
 342 {
 343   /* Inside network port */
 344   u16 in_port;
 345   /* Outside network address and port */
 346   snat_det_out_key_t out;
 347   /* Session state */
 348   u8 state;
 349   /* Expire timeout */
 350   u32 expire;
 351 } snat_det_session_t;
 352
 353 typedef struct
 354 {
 355   /* inside IP address range */
 356   ip4_address_t in_addr;
 357   u8 in_plen;
 358   /* outside IP address range */
 359   ip4_address_t out_addr;
 360   u8 out_plen;
 361   /* inside IP addresses / outside IP addresses */
 362   u32 sharing_ratio;
 363   /* number of ports available to internal host */
 364   u16 ports_per_host;
 365   /* session counter */
 366   u32 ses_num;
 367   /* vector of sessions */
 368   snat_det_session_t *sessions;
 369 } snat_det_map_t;
 370
 371 typedef struct
 372 {
 373   /* backend IP address */
 374   ip4_address_t addr;
 375   /* backend port number */
 376   u16 port;
 377   /* probability of the backend to be randomly matched */
 378   u8 probability;
 379   u8 prefix;
 380   /* backend FIB table */
 381   u32 vrf_id;
 382   u32 fib_index;
 383 } nat44_lb_addr_port_t;
 384
 385 typedef enum
 386 {
 387   /* twice-nat disabled */
 388   TWICE_NAT_DISABLED,
 389   /* twice-nat enabled */
 390   TWICE_NAT,
 391   /* twice-nat only when src IP equals dst IP after translation */
 392   TWICE_NAT_SELF,
 393 } twice_nat_type_t;
 394
 395 typedef enum
 396 {
 397   /* no load-balancing */
 398   NO_LB_NAT,
 399   /* load-balancing */
 400   LB_NAT,
 401   /* load-balancing with affinity */
 402   AFFINITY_LB_NAT,
 403 } lb_nat_type_t;
 404
 405 typedef struct
 406 {
 407   /* local IP address */
 408   ip4_address_t local_addr;
 409   /* external IP address */
 410   ip4_address_t external_addr;
 411   /* local port */
 412   u16 local_port;
 413   /* external port */
 414   u16 external_port;
 415   /* is twice-nat */
 416   twice_nat_type_t twice_nat;
 417   /* local FIB table */
 418   u32 vrf_id;
 419   u32 fib_index;
 420   /* protocol */
 421   snat_protocol_t proto;
 422   /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
 423   u32 affinity;
 424   /* worker threads used by backends/local host */
 425   u32 *workers;
 426   /* opaque string tag */
 427   u8 *tag;
 428   /* backends for load-balancing mode */
 429   nat44_lb_addr_port_t *locals;
 430   /* affinity per service lis */
 431   u32 affinity_per_service_list_head_index;
 432   /* flags */
 433   u32 flags;
 434 } snat_static_mapping_t;
 435
 436 typedef struct
 437 {
 438   u32 sw_if_index;
 439   u8 flags;
 440 } snat_interface_t;
 441
 442 typedef struct
 443 {
 444   ip4_address_t l_addr;
 445   u16 l_port;
 446   u16 e_port;
 447   u32 sw_if_index;
 448   u32 vrf_id;
 449   snat_protocol_t proto;
 450   u32 flags;
 451   int addr_only;
 452   int twice_nat;
 453   int is_add;
 454   int out2in_only;
 455   int identity_nat;
 456   u8 *tag;
 457 } snat_static_map_resolve_t;
 458
 459 typedef struct
 460 {
 461   /* Main lookup tables */
 462   clib_bihash_8_8_t out2in;
 463   clib_bihash_8_8_t in2out;
 464
 465   /* Endpoint dependent sessions lookup tables */
 466   clib_bihash_16_8_t out2in_ed;
 467   clib_bihash_16_8_t in2out_ed;
 468
 469   /* Find-a-user => src address lookup */
 470   clib_bihash_8_8_t user_hash;
 471
 472   /* User pool */
 473   snat_user_t *users;
 474
 475   /* Session pool */
 476   snat_session_t *sessions;
 477
 478   /* Pool of doubly-linked list elements */
 479   dlist_elt_t *list_pool;
 480
 481   /* LRU session list - head is stale, tail is fresh */
 482   dlist_elt_t *global_lru_pool;
 483   u32 global_lru_head_index;
 484
 485   /* NAT thread index */
 486   u32 snat_thread_index;
 487
 488   /* real thread index */
 489   u32 thread_index;
 490
 491 } snat_main_per_thread_data_t;
 492
 493 struct snat_main_s;
 494
 495 /* ICMP session match function */
 496 typedef u32 (snat_icmp_match_function_t) (struct snat_main_s * sm,
 497                                           vlib_node_runtime_t * node,
 498                                           u32 thread_index,
 499                                           vlib_buffer_t * b0,
 500                                           ip4_header_t * ip0, u8 * p_proto,
 501                                           snat_session_key_t * p_value,
 502                                           u8 * p_dont_translate, void *d,
 503                                           void *e);
 504
 505 /* Return worker thread index for given packet */
 506 typedef u32 (snat_get_worker_in2out_function_t) (ip4_header_t * ip,
 507                                                  u32 rx_fib_index,
 508                                                  u8 is_output);
 509
 510 typedef u32 (snat_get_worker_out2in_function_t) (vlib_buffer_t * b,
 511                                                  ip4_header_t * ip,
 512                                                  u32 rx_fib_index,
 513                                                  u8 is_output);
 514
 515 /* NAT address and port allacotaion function */
 516 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
 517                                                       addresses,
 518                                                       u32 fib_index,
 519                                                       u32 thread_index,
 520                                                       snat_session_key_t * k,
 521                                                       u16 port_per_thread,
 522                                                       u32 snat_thread_index);
 523
 524
 525 typedef struct snat_main_s
 526 {
 527   /* ICMP session match functions */
 528   snat_icmp_match_function_t *icmp_match_in2out_cb;
 529   snat_icmp_match_function_t *icmp_match_out2in_cb;
 530
 531   /* Thread settings */
 532   u32 num_workers;
 533   u32 first_worker_index;
 534   u32 *workers;
 535   snat_get_worker_in2out_function_t *worker_in2out_cb;
 536   snat_get_worker_out2in_function_t *worker_out2in_cb;
 537   u16 port_per_thread;
 538   u32 num_snat_thread;
 539
 540   /* Per thread data */
 541   snat_main_per_thread_data_t *per_thread_data;
 542
 543   /* Find a static mapping by local */
 544   clib_bihash_8_8_t static_mapping_by_local;
 545
 546   /* Find a static mapping by external */
 547   clib_bihash_8_8_t static_mapping_by_external;
 548
 549   /* Static mapping pool */
 550   snat_static_mapping_t *static_mappings;
 551
 552   /* Interface pool */
 553   snat_interface_t *interfaces;
 554   snat_interface_t *output_feature_interfaces;
 555
 556   /* Vector of outside addresses */
 557   snat_address_t *addresses;
 558   /* Address and port allocation function */
 559   nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
 560   /* Address and port allocation type */
 561   nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
 562   /* Port set parameters (MAP-E) */
 563   u8 psid_offset;
 564   u8 psid_length;
 565   u16 psid;
 566   /* Port range parameters */
 567   u16 start_port;
 568   u16 end_port;
 569
 570   /* vector of outside fibs */
 571   nat_outside_fib_t *outside_fibs;
 572
 573   /* Vector of twice NAT addresses for extenal hosts */
 574   snat_address_t *twice_nat_addresses;
 575
 576   /* sw_if_indices whose intfc addresses should be auto-added */
 577   u32 *auto_add_sw_if_indices;
 578   u32 *auto_add_sw_if_indices_twice_nat;
 579
 580   /* vector of interface address static mappings to resolve. */
 581   snat_static_map_resolve_t *to_resolve;
 582
 583   /* Randomize port allocation order */
 584   u32 random_seed;
 585
 586   /* Worker handoff frame-queue index */
 587   u32 fq_in2out_index;
 588   u32 fq_in2out_output_index;
 589   u32 fq_out2in_index;
 590
 591   /* node indexes */
 592   u32 error_node_index;
 593
 594   /* handoff fq nodes  */
 595   u32 handoff_out2in_index;
 596   u32 handoff_in2out_index;
 597   u32 handoff_in2out_output_index;
 598
 599   /* respect feature arc nodes */
 600   u32 pre_out2in_node_index;
 601   u32 pre_in2out_node_index;
 602
 603   u32 in2out_node_index;
 604   u32 in2out_output_node_index;
 605   u32 in2out_fast_node_index;
 606   u32 in2out_slowpath_node_index;
 607   u32 in2out_slowpath_output_node_index;
 608   u32 ed_in2out_node_index;
 609   u32 ed_in2out_slowpath_node_index;
 610   u32 out2in_node_index;
 611   u32 out2in_fast_node_index;
 612   u32 ed_out2in_node_index;
 613   u32 ed_out2in_slowpath_node_index;
 614   u32 det_in2out_node_index;
 615   u32 det_out2in_node_index;
 616
 617   u32 hairpinning_node_index;
 618   u32 hairpin_dst_node_index;
 619   u32 hairpin_src_node_index;
 620   u32 ed_hairpinning_node_index;
 621   u32 ed_hairpin_dst_node_index;
 622   u32 ed_hairpin_src_node_index;
 623
 624
 625   /* Deterministic NAT mappings */
 626   snat_det_map_t *det_maps;
 627
 628   /* If forwarding is enabled */
 629   u8 forwarding_enabled;
 630
 631   /* Config parameters */
 632   u8 static_mapping_only;
 633   u8 static_mapping_connection_tracking;
 634   u8 deterministic;
 635   u8 out2in_dpo;
 636   u8 endpoint_dependent;
 637
 638   u32 translation_buckets;
 639   uword translation_memory_size;
 640   u32 max_translations;
 641   u32 *max_translations_per_fib;
 642
 643   u32 user_buckets;
 644   uword user_memory_size;
 645   u32 max_translations_per_user;
 646
 647   u32 outside_vrf_id;
 648   u32 outside_fib_index;
 649   u32 inside_vrf_id;
 650   u32 inside_fib_index;
 651
 652   /* values of various timeouts */
 653   // proto timeouts
 654   u32 udp_timeout;
 655   u32 tcp_transitory_timeout;
 656   u32 tcp_established_timeout;
 657   u32 icmp_timeout;
 658
 659   /* TCP MSS clamping */
 660   u16 mss_clamping;
 661   u16 mss_value_net;
 662
 663   /* counters/gauges */
 664   vlib_simple_counter_main_t total_users;
 665   vlib_simple_counter_main_t total_sessions;
 666
 667   /* API message ID base */
 668   u16 msg_id_base;
 669
 670   /* log class */
 671   vlib_log_class_t log_class;
 672   /* logging level */
 673   u8 log_level;
 674
 675   /* convenience */
 676   vlib_main_t *vlib_main;
 677   vnet_main_t *vnet_main;
 678   ip4_main_t *ip4_main;
 679   ip_lookup_main_t *ip4_lookup_main;
 680   api_main_t *api_main;
 681 } snat_main_t;
 682
 683 typedef struct
 684 {
 685   u32 thread_index;
 686   f64 now;
 687 } nat44_is_idle_session_ctx_t;
 688
 689 typedef struct
 690 {
 691   u32 cached_sw_if_index;
 692   u32 cached_ip4_address;
 693 } snat_runtime_t;
 694
 695 extern snat_main_t snat_main;
 696
 697 // nat pre ed next_node feature classification
 698 extern vlib_node_registration_t nat_default_node;
 699 extern vlib_node_registration_t nat_pre_in2out_node;
 700 extern vlib_node_registration_t nat_pre_out2in_node;
 701
 702 extern vlib_node_registration_t snat_in2out_node;
 703 extern vlib_node_registration_t snat_in2out_output_node;
 704 extern vlib_node_registration_t snat_out2in_node;
 705 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
 706 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
 707 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
 708 extern vlib_node_registration_t snat_det_in2out_node;
 709 extern vlib_node_registration_t snat_det_out2in_node;
 710 extern vlib_node_registration_t nat44_ed_in2out_node;
 711 extern vlib_node_registration_t nat44_ed_in2out_output_node;
 712 extern vlib_node_registration_t nat44_ed_out2in_node;
 713
 714 extern fib_source_t nat_fib_src_hi;
 715 extern fib_source_t nat_fib_src_low;
 716
 717 /* format functions */
 718 format_function_t format_snat_user;
 719 format_function_t format_snat_static_mapping;
 720 format_function_t format_snat_static_map_to_resolve;
 721 format_function_t format_snat_session;
 722 format_function_t format_det_map_ses;
 723 format_function_t format_snat_key;
 724 format_function_t format_static_mapping_key;
 725 format_function_t format_snat_protocol;
 726 format_function_t format_nat_addr_and_port_alloc_alg;
 727 /* unformat functions */
 728 unformat_function_t unformat_snat_protocol;
 729
 730 /** \brief Check if SNAT session is created from static mapping.
 731     @param s SNAT session
 732     @return 1 if SNAT session is created from static mapping otherwise 0
 733 */
 734 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
 735
 736 /** \brief Check if SNAT session for unknown protocol.
 737     @param s SNAT session
 738     @return 1 if SNAT session for unknown protocol otherwise 0
 739 */
 740 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
 741
 742 /** \brief Check if NAT session is twice NAT.
 743     @param s NAT session
 744     @return 1 if NAT session is twice NAT
 745 */
 746 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
 747
 748 /** \brief Check if NAT session is load-balancing.
 749     @param s NAT session
 750     @return 1 if NAT session is load-balancing
 751 */
 752 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
 753
 754 /** \brief Check if NAT session is forwarding bypass.
 755     @param s NAT session
 756     @return 1 if NAT session is load-balancing
 757 */
 758 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
 759
 760 /** \brief Check if NAT session is endpoint dependent.
 761     @param s NAT session
 762     @return 1 if NAT session is endpoint dependent
 763 */
 764 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
 765
 766 /** \brief Check if NAT session has affinity record.
 767     @param s NAT session
 768     @return 1 if NAT session has affinity record
 769 */
 770 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
 771
 772 /** \brief Check if NAT interface is inside.
 773     @param i NAT interfce
 774     @return 1 if inside interface
 775 */
 776 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
 777
 778 /** \brief Check if NAT interface is outside.
 779     @param i NAT interfce
 780     @return 1 if outside interface
 781 */
 782 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
 783
 784 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
 785     @param s NAT session
 786     @return 1 if session is closed
 787 */
 788 #define nat44_is_ses_closed(s) s->state == 0xf
 789
 790 /** \brief Check if NAT static mapping is address only (1:1NAT).
 791     @param sm NAT static mapping
 792     @return 1 if 1:1NAT, 0 if 1:1NAPT
 793 */
 794 #define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY)
 795
 796 /** \brief Check if NAT static mapping match only out2in direction.
 797     @param sm NAT static mapping
 798     @return 1 if rule match only out2in direction
 799 */
 800 #define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY)
 801
 802 /** \brief Check if NAT static mapping is identity NAT.
 803     @param sm NAT static mapping
 804     @return 1 if identity NAT
 805 */
 806 #define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT)
 807
 808 /** \brief Check if NAT static mapping is load-balancing.
 809     @param sm NAT static mapping
 810     @return 1 if load-balancing
 811 */
 812 #define is_lb_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_LB)
 813
 814 /** \brief Check if client initiating TCP connection (received SYN from client)
 815     @param t TCP header
 816     @return 1 if client initiating TCP connection
 817 */
 818 always_inline bool
 819 tcp_flags_is_init (u8 f)
 820 {
 821   return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK);
 822 }
 823
 824 /* logging */
 825 #define nat_log_err(...) \
 826   vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
 827 #define nat_log_warn(...) \
 828   vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
 829 #define nat_log_notice(...) \
 830   vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
 831 #define nat_log_info(...) \
 832   vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
 833 #define nat_log_debug(...)\
 834   vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
 835
 836 /* NAT API Logging Levels */
 837 #define foreach_nat_log_level \
 838   _(0x00, LOG_NONE)           \
 839   _(0x01, LOG_ERROR)          \
 840   _(0x02, LOG_WARNING)        \
 841   _(0x03, LOG_NOTICE)         \
 842   _(0x04, LOG_INFO)           \
 843   _(0x05, LOG_DEBUG)
 844
 845 typedef enum nat_log_level_t_
 846 {
 847 #define _(n,f) SNAT_##f = n,
 848   foreach_nat_log_level
 849 #undef _
 850 } nat_log_level_t;
 851
 852 #define nat_elog(_level, _str)                    \
 853 do                                                \
 854   {                                               \
 855     snat_main_t *sm = &snat_main;                 \
 856     if (PREDICT_FALSE (sm->log_level >= _level))  \
 857       {                                           \
 858         ELOG_TYPE_DECLARE (e) =                   \
 859           {                                       \
 860             .format = "nat-msg " _str,            \
 861             .format_args = "",                    \
 862           };                                      \
 863         ELOG_DATA (&sm->vlib_main->elog_main, e); \
 864       }                                           \
 865   } while (0);
 866
 867 #define nat_elog_addr(_level, _str, _addr)               \
 868 do                                                       \
 869   {                                                      \
 870     if (PREDICT_FALSE (sm->log_level >= _level))         \
 871       {                                                  \
 872         ELOG_TYPE_DECLARE (e) =                          \
 873           {                                              \
 874             .format = "nat-msg " _str " %d.%d.%d.%d",    \
 875             .format_args = "i1i1i1i1",                   \
 876           };                                             \
 877         CLIB_PACKED(struct                               \
 878           {                                              \
 879             u8 oct1;                                     \
 880             u8 oct2;                                     \
 881             u8 oct3;                                     \
 882             u8 oct4;                                     \
 883           }) *ed;                                        \
 884         ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
 885         ed->oct4 = _addr >> 24;                          \
 886         ed->oct3 = _addr >> 16;                          \
 887         ed->oct2 = _addr >> 8;                           \
 888         ed->oct1 = _addr;                                \
 889     }                                                    \
 890   } while (0);
 891
 892 #define nat_elog_debug_handoff(_str, _tid, _fib, _src, _dst)                \
 893 do                                                                          \
 894   {                                                                         \
 895   if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG))                      \
 896     {                                                                       \
 897       ELOG_TYPE_DECLARE (e) =                                               \
 898         {                                                                   \
 899           .format = "nat-msg " _str " ip src: %d.%d.%d.%d dst: %d.%d.%d.%d" \
 900                                     " tid from: %d to: %d fib: %d",         \
 901         .format_args = "i1i1i1i1i1i1i1i1i4i4i4",                            \
 902       };                                                                    \
 903       CLIB_PACKED(struct                                                    \
 904         {                                                                   \
 905           u8 src_oct1;                                                      \
 906           u8 src_oct2;                                                      \
 907           u8 src_oct3;                                                      \
 908           u8 src_oct4;                                                      \
 909           u8 dst_oct1;                                                      \
 910           u8 dst_oct2;                                                      \
 911           u8 dst_oct3;                                                      \
 912           u8 dst_oct4;                                                      \
 913           u32 ftid;                                                         \
 914           u32 ttid;                                                         \
 915           u32 fib;                                                          \
 916         }) *ed;                                                             \
 917       ed = ELOG_DATA (&vlib_global_main.elog_main, e);                      \
 918       ed->src_oct1 = _src >> 24;                                            \
 919       ed->src_oct2 = _src >> 16;                                            \
 920       ed->src_oct3 = _src >> 8;                                             \
 921       ed->src_oct4 = _src;                                                  \
 922       ed->dst_oct1 = _dst >> 24;                                            \
 923       ed->dst_oct2 = _dst >> 16;                                            \
 924       ed->dst_oct3 = _dst >> 8;                                             \
 925       ed->dst_oct4 = _dst;                                                  \
 926       ed->ftid = vlib_get_thread_index ();                                  \
 927       ed->ttid = _tid;                                                      \
 928       ed->fib = _fib;                                                       \
 929     }                                                                       \
 930   } while (0);
 931
 932 #define nat_elog_debug_handoff_v2(_str, _prt, _fib, _src, _dst)              \
 933 do                                                                           \
 934   {                                                                          \
 935   if (PREDICT_FALSE (sm->log_level >= SNAT_LOG_DEBUG))                       \
 936     {                                                                        \
 937       ELOG_TYPE_DECLARE (e) =                                                \
 938         {                                                                    \
 939           .format = "nat-msg " _str " ip_src:%d.%d.%d.%d ip_dst:%d.%d.%d.%d" \
 940                                     " tid:%d prt:%d fib:%d",                 \
 941         .format_args = "i1i1i1i1i1i1i1i1i4i4i4",                             \
 942       };                                                                     \
 943       CLIB_PACKED(struct                                                     \
 944         {                                                                    \
 945           u8 src_oct1;                                                       \
 946           u8 src_oct2;                                                       \
 947           u8 src_oct3;                                                       \
 948           u8 src_oct4;                                                       \
 949           u8 dst_oct1;                                                       \
 950           u8 dst_oct2;                                                       \
 951           u8 dst_oct3;                                                       \
 952           u8 dst_oct4;                                                       \
 953           u32 tid;                                                           \
 954           u32 prt;                                                           \
 955           u32 fib;                                                           \
 956         }) *ed;                                                              \
 957       ed = ELOG_DATA (&vlib_global_main.elog_main, e);                       \
 958       ed->src_oct1 = _src >> 24;                                             \
 959       ed->src_oct2 = _src >> 16;                                             \
 960       ed->src_oct3 = _src >> 8;                                              \
 961       ed->src_oct4 = _src;                                                   \
 962       ed->dst_oct1 = _dst >> 24;                                             \
 963       ed->dst_oct2 = _dst >> 16;                                             \
 964       ed->dst_oct3 = _dst >> 8;                                              \
 965       ed->dst_oct4 = _dst;                                                   \
 966       ed->tid = vlib_get_thread_index ();                                    \
 967       ed->prt = _prt;                                                        \
 968       ed->fib = _fib;                                                        \
 969     }                                                                        \
 970   } while (0);
 971
 972 #define nat_elog_X1(_level, _fmt, _arg, _val1)         \
 973 do                                                     \
 974   {                                                    \
 975     snat_main_t *sm = &snat_main;                      \
 976     if (PREDICT_FALSE (sm->log_level >= _level))       \
 977       {                                                \
 978         ELOG_TYPE_DECLARE (e) =                        \
 979           {                                            \
 980             .format = "nat-msg " _fmt,                 \
 981             .format_args = _arg,                       \
 982           };                                           \
 983         CLIB_PACKED(struct                             \
 984           {                                            \
 985             typeof (_val1) val1;                       \
 986           }) *ed;                                      \
 987         ed = ELOG_DATA (&sm->vlib_main->elog_main, e); \
 988         ed->val1 = _val1;                              \
 989       }                                                \
 990   } while (0);
 991
 992 #define nat_elog_notice(nat_elog_str) \
 993   nat_elog(SNAT_LOG_INFO, "[notice] " nat_elog_str)
 994 #define nat_elog_warn(nat_elog_str) \
 995   nat_elog(SNAT_LOG_WARNING, "[warning] " nat_elog_str)
 996 #define nat_elog_err(nat_elog_str) \
 997   nat_elog(SNAT_LOG_ERROR, "[error] " nat_elog_str)
 998 #define nat_elog_debug(nat_elog_str) \
 999   nat_elog(SNAT_LOG_DEBUG, "[debug] " nat_elog_str)
1000 #define nat_elog_info(nat_elog_str) \
1001   nat_elog(SNAT_LOG_INFO, "[info] " nat_elog_str)
1002
1003 #define nat_elog_notice_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1004   nat_elog_X1(SNAT_LOG_NOTICE, "[notice] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1005 #define nat_elog_warn_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1006   nat_elog_X1(SNAT_LOG_WARNING, "[warning] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1007 #define nat_elog_err_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1008   nat_elog_X1(SNAT_LOG_ERROR, "[error] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1009 #define nat_elog_debug_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1010   nat_elog_X1(SNAT_LOG_DEBUG, "[debug] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1011 #define nat_elog_info_X1(nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1) \
1012   nat_elog_X1(SNAT_LOG_INFO, "[info] " nat_elog_fmt_str, nat_elog_fmt_arg, nat_elog_val1)
1013
1014 /* ICMP session match functions */
1015 u32 icmp_match_in2out_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1016                             u32 thread_index, vlib_buffer_t * b0,
1017                             ip4_header_t * ip0, u8 * p_proto,
1018                             snat_session_key_t * p_value,
1019                             u8 * p_dont_translate, void *d, void *e);
1020 u32 icmp_match_in2out_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1021                             u32 thread_index, vlib_buffer_t * b0,
1022                             ip4_header_t * ip0, u8 * p_proto,
1023                             snat_session_key_t * p_value,
1024                             u8 * p_dont_translate, void *d, void *e);
1025 u32 icmp_match_out2in_fast (snat_main_t * sm, vlib_node_runtime_t * node,
1026                             u32 thread_index, vlib_buffer_t * b0,
1027                             ip4_header_t * ip0, u8 * p_proto,
1028                             snat_session_key_t * p_value,
1029                             u8 * p_dont_translate, void *d, void *e);
1030 u32 icmp_match_out2in_slow (snat_main_t * sm, vlib_node_runtime_t * node,
1031                             u32 thread_index, vlib_buffer_t * b0,
1032                             ip4_header_t * ip0, u8 * p_proto,
1033                             snat_session_key_t * p_value,
1034                             u8 * p_dont_translate, void *d, void *e);
1035
1036 /* ICMP deterministic NAT session match functions */
1037 u32 icmp_match_out2in_det (snat_main_t * sm, vlib_node_runtime_t * node,
1038                            u32 thread_index, vlib_buffer_t * b0,
1039                            ip4_header_t * ip0, u8 * p_proto,
1040                            snat_session_key_t * p_value,
1041                            u8 * p_dont_translate, void *d, void *e);
1042 u32 icmp_match_in2out_det (snat_main_t * sm, vlib_node_runtime_t * node,
1043                            u32 thread_index, vlib_buffer_t * b0,
1044                            ip4_header_t * ip0, u8 * p_proto,
1045                            snat_session_key_t * p_value,
1046                            u8 * p_dont_translate, void *d, void *e);
1047
1048 /* ICMP endpoint-dependent session match functions */
1049 u32 icmp_match_out2in_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1050                           u32 thread_index, vlib_buffer_t * b0,
1051                           ip4_header_t * ip0, u8 * p_proto,
1052                           snat_session_key_t * p_value,
1053                           u8 * p_dont_translate, void *d, void *e);
1054 u32 icmp_match_in2out_ed (snat_main_t * sm, vlib_node_runtime_t * node,
1055                           u32 thread_index, vlib_buffer_t * b0,
1056                           ip4_header_t * ip0, u8 * p_proto,
1057                           snat_session_key_t * p_value,
1058                           u8 * p_dont_translate, void *d, void *e);
1059
1060 u32 icmp_in2out (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1061                  icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1062                  vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1063                  void *d, void *e);
1064
1065 u32 icmp_out2in (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
1066                  icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
1067                  vlib_node_runtime_t * node, u32 next0, u32 thread_index,
1068                  void *d, void *e);
1069
1070 /* hairpinning functions */
1071 u32 snat_icmp_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1072                            ip4_header_t * ip0, icmp46_header_t * icmp0,
1073                            int is_ed);
1074 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1075                                        ip4_header_t * ip);
1076 void nat44_ed_hairpinning_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
1077                                          ip4_header_t * ip);
1078 int snat_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
1079                       ip4_header_t * ip0, udp_header_t * udp0,
1080                       tcp_header_t * tcp0, u32 proto0, int is_ed);
1081
1082 /* Call back functions for clib_bihash_add_or_overwrite_stale */
1083 int nat44_i2o_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1084 int nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
1085 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1086 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
1087
1088 /**
1089  * @brief Add external address to NAT44 pool
1090  *
1091  * @param addr      IPv4 address
1092  * @param vrf_id    VRF id of tenant, ~0 means independent of VRF
1093  * @param twice_nat 1 if twice NAT address
1094  *
1095  * @return 0 on success, non-zero value otherwise
1096  */
1097 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
1098                       u8 twice_nat);
1099
1100 /**
1101  * @brief Delete external address from NAT44 pool
1102  *
1103  * @param addr      IPv4 address
1104  * @param delete_sm 1 if delete static mapping using address
1105  * @param twice_nat 1 if twice NAT address
1106  *
1107  * @return 0 on success, non-zero value otherwise
1108  */
1109 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1110                       u8 twice_nat);
1111
1112 /**
1113  * @brief Add/delete external address to FIB DPO (out2in DPO mode)
1114  *
1115  * @param addr   IPv4 address
1116  * @param is_add 1 = add, 0 = delete
1117  *
1118  * @return 0 on success, non-zero value otherwise
1119  */
1120 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
1121
1122 /**
1123  * @brief Add/delete NAT44 static mapping
1124  *
1125  * @param l_addr       local IPv4 address
1126  * @param e_addr       external IPv4 address
1127  * @param l_port       local port number
1128  * @param e_port       external port number
1129  * @param vrf_id       local VRF ID
1130  * @param addr_only    1 = 1:1NAT, 0 = 1:1NAPT
1131  * @param sw_if_index  use interface address as external IPv4 address
1132  * @param proto        L4 protocol
1133  * @param is_add       1 = add, 0 = delete
1134  * @param twice_nat    twice-nat mode
1135  * @param out2in_only  if 1 rule match only out2in direction
1136  * @param tag          opaque string tag
1137  * @param identity_nat identity NAT
1138  *
1139  * @return 0 on success, non-zero value otherwise
1140  */
1141 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
1142                              u16 l_port, u16 e_port, u32 vrf_id,
1143                              int addr_only, u32 sw_if_index,
1144                              snat_protocol_t proto, int is_add,
1145                              twice_nat_type_t twice_nat, u8 out2in_only,
1146                              u8 * tag, u8 identity_nat);
1147
1148 /**
1149  * @brief Add/delete static mapping with load-balancing (multiple backends)
1150  *
1151  * @param e_addr      external IPv4 address
1152  * @param e_port      external port number
1153  * @param proto       L4 protocol
1154  * @param locals      list of local backends
1155  * @param is_add      1 = add, 0 = delete
1156  * @param twice_nat   twice-nat mode
1157  * @param out2in_only if 1 rule match only out2in direction
1158  * @param tag         opaque string tag
1159  * @param affinity    0 = disabled, otherwise client IP affinity sticky time
1160  *
1161  * @return 0 on success, non-zero value otherwise
1162  */
1163 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1164                                      snat_protocol_t proto,
1165                                      nat44_lb_addr_port_t * locals, u8 is_add,
1166                                      twice_nat_type_t twice_nat,
1167                                      u8 out2in_only, u8 * tag, u32 affinity);
1168
1169 int nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1170                                            ip4_address_t l_addr, u16 l_port,
1171                                            snat_protocol_t proto, u32 vrf_id,
1172                                            u8 probability, u8 is_add);
1173
1174 clib_error_t *snat_api_init (vlib_main_t * vm, snat_main_t * sm);
1175
1176 /**
1177  * @brief Set NAT plugin workers
1178  *
1179  * @param bitmap NAT workers bitmap
1180  *
1181  * @return 0 on success, non-zero value otherwise
1182  */
1183 int snat_set_workers (uword * bitmap);
1184
1185 /**
1186  * @brief Enable/disable NAT44 feature on the interface
1187  *
1188  * @param sw_if_index software index of the interface
1189  * @param is_inside   1 = inside, 0 = outside
1190  * @param is_del      1 = delete, 0 = add
1191  *
1192  * @return 0 on success, non-zero value otherwise
1193  */
1194 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
1195
1196 /**
1197  * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
1198  *
1199  * @param sw_if_index software index of the interface
1200  * @param is_inside   1 = inside, 0 = outside
1201  * @param is_del      1 = delete, 0 = add
1202  *
1203  * @return 0 on success, non-zero value otherwise
1204  */
1205 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
1206                                            int is_del);
1207
1208 /**
1209  * @brief Add/delete NAT44 pool address from specific interfce
1210  *
1211  * @param sw_if_index software index of the interface
1212  * @param is_del      1 = delete, 0 = add
1213  * @param twice_nat   1 = twice NAT address for extenal hosts
1214  *
1215  * @return 0 on success, non-zero value otherwise
1216  */
1217 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
1218                                 u8 twice_nat);
1219
1220 /**
1221  * @brief Delete NAT44 session
1222  *
1223  * @param addr   IPv4 address
1224  * @param port   L4 port number
1225  * @param proto  L4 protocol
1226  * @param vrf_id VRF ID
1227  * @param is_in  1 = inside network address and port pair, 0 = outside
1228  *
1229  * @return 0 on success, non-zero value otherwise
1230  */
1231 int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1232                        snat_protocol_t proto, u32 vrf_id, int is_in);
1233
1234 /**
1235  * @brief Delete NAT44 endpoint-dependent session
1236  *
1237  * @param addr   IPv4 address
1238  * @param port   L4 port number
1239  * @param proto  L4 protocol
1240  * @param vrf_id VRF ID
1241  * @param is_in  1 = inside network address and port pair, 0 = outside
1242  *
1243  * @return 0 on success, non-zero value otherwise
1244  */
1245 int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
1246                           ip4_address_t * eh_addr, u16 eh_port, u8 proto,
1247                           u32 vrf_id, int is_in);
1248
1249 /**
1250  * @brief Free NAT44 session data (lookup keys, external addrres port)
1251  *
1252  * @param s            NAT session
1253  * @param thread_index thread index
1254  * @param is_ha        is HA event
1255  */
1256 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
1257                             u32 thread_index, u8 is_ha);
1258
1259 /**
1260  * @brief Set NAT44 session limit (session limit, vrf id)
1261  *
1262  * @param session_limit Session limit
1263  * @param vrf_id        VRF id
1264  * @return 0 on success, non-zero value otherwise
1265  */
1266 int nat44_set_session_limit (u32 session_limit, u32 vrf_id);
1267
1268 /**
1269  * @brief Free NAT44 ED session data (lookup keys, external addrres port)
1270  *
1271  * @param s            NAT session
1272  * @param thread_index thread index
1273  * @param is_ha        is HA event
1274  */
1275 void
1276 nat44_free_session_data (snat_main_t * sm, snat_session_t * s,
1277                          u32 thread_index, u8 is_ha);
1278
1279 /**
1280  * @brief Initialize NAT44 data
1281  *
1282  * @param tsm          per thread data
1283  */
1284 void nat44_db_init (snat_main_per_thread_data_t * tsm);
1285
1286 /**
1287  * @brief Free NAT44 data
1288  *
1289  * @param tsm          per thread data
1290  */
1291 void nat44_db_free (snat_main_per_thread_data_t * tsm);
1292
1293 /**
1294  * @brief Find or create NAT user
1295  *
1296  * @param addr         IPv4 address
1297  * @param fib_index    FIB table index
1298  * @param thread_index thread index
1299  *
1300  * @return NAT user data structure on success otherwise zero value
1301  */
1302 snat_user_t *nat_user_get_or_create (snat_main_t * sm,
1303                                      ip4_address_t * addr, u32 fib_index,
1304                                      u32 thread_index);
1305
1306 /**
1307  * @brief Allocate new NAT session or recycle last used
1308  *
1309  * @param u            NAT user
1310  * @param thread_index thread index
1311  *
1312  * @return session data structure on success otherwise zero value
1313  */
1314 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
1315                                               snat_user_t * u,
1316                                               u32 thread_index, f64 now);
1317
1318 /**
1319  * @brief Allocate NAT endpoint-dependent session
1320  *
1321  * @param thread_index thread index
1322  *
1323  * @return session data structure on success otherwise zero value
1324  */
1325 snat_session_t *nat_ed_session_alloc (snat_main_t * sm, u32 thread_index,
1326                                       f64 now);
1327
1328 /**
1329  * @brief Set address and port assignment algorithm for MAP-E CE
1330  *
1331  * @param psid        Port Set Identifier value
1332  * @param psid_offset number of offset bits
1333  * @param psid_length length of PSID
1334  */
1335 void nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset,
1336                                        u16 psid_length);
1337
1338 /**
1339  * @brief Set address and port assignment algorithm for port range
1340  *
1341  * @param start_port beginning of the port range
1342  * @param end_port   end of the port range
1343  */
1344 void nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port);
1345
1346 /**
1347  * @brief Set address and port assignment algorithm to default/standard
1348  */
1349 void nat_set_alloc_addr_and_port_default (void);
1350
1351 /**
1352  * @brief Free outside address and port pair
1353  *
1354  * @param addresses    vector of outside addresses
1355  * @param thread_index thread index
1356  * @param k            address, port and protocol
1357  */
1358 void snat_free_outside_address_and_port (snat_address_t * addresses,
1359                                          u32 thread_index,
1360                                          snat_session_key_t * k);
1361
1362 /**
1363  * @brief Alloc outside address and port
1364  *
1365  * @param addresses         vector of outside addresses
1366  * @param fib_index         FIB table index
1367  * @param thread_index      thread index
1368  * @param k                 allocated address and port pair
1369  * @param port_per_thread   number of ports per threead
1370  * @param snat_thread_index NAT thread index
1371  *
1372  * @return 0 on success, non-zero value otherwise
1373  */
1374 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
1375                                          u32 fib_index,
1376                                          u32 thread_index,
1377                                          snat_session_key_t * k,
1378                                          u16 port_per_thread,
1379                                          u32 snat_thread_index);
1380
1381 /**
1382  * @brief Match NAT44 static mapping.
1383  *
1384  * @param match         address and port to match
1385  * @param mapping       external/local address and port of the matched mapping
1386  * @param by_external   if 0 match by local address otherwise match by external
1387  *                      address
1388  * @param is_addr_only  1 if matched mapping is address only
1389  * @param twice_nat     matched mapping is twice NAT type
1390  * @param lb            1 if matched mapping is load-balanced
1391  * @param ext_host_addr external host address
1392  *
1393  * @returns 0 if match found otherwise 1.
1394  */
1395 int snat_static_mapping_match (snat_main_t * sm,
1396                                snat_session_key_t match,
1397                                snat_session_key_t * mapping,
1398                                u8 by_external,
1399                                u8 * is_addr_only,
1400                                twice_nat_type_t * twice_nat,
1401                                lb_nat_type_t * lb,
1402                                ip4_address_t * ext_host_addr,
1403                                u8 * is_identity_nat);
1404
1405 /**
1406  * @brief Add/del NAT address to FIB.
1407  *
1408  * Add the external NAT address to the FIB as receive entries. This ensures
1409  * that VPP will reply to ARP for this address and we don't need to enable
1410  * proxy ARP on the outside interface.
1411  *
1412  * @param addr        IPv4 address
1413  * @param plen        address prefix length
1414  * @param sw_if_index software index of the outside interface
1415  * @param is_add      0 = delete, 1 = add.
1416  */
1417 void snat_add_del_addr_to_fib (ip4_address_t * addr,
1418                                u8 p_len, u32 sw_if_index, int is_add);
1419
1420 /*
1421  * Why is this here? Because we don't need to touch this layer to
1422  * simply reply to an icmp. We need to change id to a unique
1423  * value to NAT an echo request/reply.
1424  */
1425
1426 typedef struct
1427 {
1428   u16 identifier;
1429   u16 sequence;
1430 } icmp_echo_header_t;
1431
1432 typedef struct
1433 {
1434   u16 src_port, dst_port;
1435 } tcp_udp_header_t;
1436
1437 int nat_global_lru_free_one (snat_main_t * sm, int thread_index, f64 now);
1438
1439 #endif /* __included_nat_h__ */
1440 /*
1441  * fd.io coding-style-patch-verification: ON
1442  *
1443  * Local Variables:
1444  * eval: (c-set-style "gnu")
1445  * End:
1446  */