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