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