src/plugins/nat/nat44-ed/nat44_ed.h

   1 /*
   2  * Copyright (c) 2020 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 #ifndef __included_nat44_ed_h__
  17 #define __included_nat44_ed_h__
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <vnet/ip/icmp46_packet.h>
  23 #include <vnet/api_errno.h>
  24 #include <vnet/fib/fib_source.h>
  25 #include <vppinfra/elog.h>
  26 #include <vppinfra/bihash_8_8.h>
  27 #include <vppinfra/bihash_16_8.h>
  28 #include <vppinfra/hash.h>
  29 #include <vppinfra/dlist.h>
  30 #include <vppinfra/error.h>
  31 #include <vlibapi/api.h>
  32
  33 #include <nat/lib/lib.h>
  34 #include <nat/lib/inlines.h>
  35
  36 /* default number of worker handoff frame queue elements */
  37 #define NAT_FQ_NELTS_DEFAULT 64
  38
  39 /* number of attempts to get a port for ED overloading algorithm, if rolling
  40  * a dice this many times doesn't produce a free port, it's treated
  41  * as if there were no free ports available to conserve resources */
  42 #define ED_PORT_ALLOC_ATTEMPTS (10)
  43
  44 /* system ports range is 0-1023, first user port is 1024 per
  45  * https://www.rfc-editor.org/rfc/rfc6335#section-6
  46  */
  47 #define ED_USER_PORT_OFFSET 1024
  48
  49 /* NAT buffer flags */
  50 #define SNAT_FLAG_HAIRPINNING (1 << 0)
  51
  52 /* NAT44 API Configuration flags */
  53 #define foreach_nat44_config_flag                                             \
  54   _ (0x00, IS_ENDPOINT_INDEPENDENT)                                           \
  55   _ (0x01, IS_ENDPOINT_DEPENDENT)                                             \
  56   _ (0x02, IS_STATIC_MAPPING_ONLY)                                            \
  57   _ (0x04, IS_CONNECTION_TRACKING)
  58
  59 typedef enum nat44_config_flags_t_
  60 {
  61 #define _(n,f) NAT44_API_##f = n,
  62   foreach_nat44_config_flag
  63 #undef _
  64 } nat44_config_flags_t;
  65
  66 typedef struct
  67 {
  68   u32 inside_vrf;
  69   u32 outside_vrf;
  70   u32 sessions;
  71 } nat44_config_t;
  72
  73 typedef enum
  74 {
  75   NAT_NEXT_DROP,
  76   NAT_NEXT_ICMP_ERROR,
  77   NAT_NEXT_IN2OUT_ED_FAST_PATH,
  78   NAT_NEXT_IN2OUT_ED_SLOW_PATH,
  79   NAT_NEXT_IN2OUT_ED_OUTPUT_FAST_PATH,
  80   NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH,
  81   NAT_NEXT_OUT2IN_ED_FAST_PATH,
  82   NAT_NEXT_OUT2IN_ED_SLOW_PATH,
  83   NAT_NEXT_IN2OUT_CLASSIFY,
  84   NAT_NEXT_OUT2IN_CLASSIFY,
  85   NAT_N_NEXT,
  86 } nat_next_t;
  87
  88 typedef struct
  89 {
  90   u32 next_index;
  91   u32 arc_next_index;
  92 } nat_pre_trace_t;
  93
  94 #define foreach_nat_in2out_ed_error                                           \
  95   _ (UNSUPPORTED_PROTOCOL, "unsupported protocol")                            \
  96   _ (OUT_OF_PORTS, "out of ports")                                            \
  97   _ (BAD_ICMP_TYPE, "unsupported ICMP type")                                  \
  98   _ (MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded")                      \
  99   _ (NON_SYN, "non-SYN packet try to create session")                         \
 100   _ (TRNSL_FAILED, "couldn't translate packet")
 101
 102 typedef enum
 103 {
 104 #define _(sym,str) NAT_IN2OUT_ED_ERROR_##sym,
 105   foreach_nat_in2out_ed_error
 106 #undef _
 107     NAT_IN2OUT_ED_N_ERROR,
 108 } nat_in2out_ed_error_t;
 109
 110 #define foreach_nat_out2in_ed_error                                           \
 111   _ (UNSUPPORTED_PROTOCOL, "unsupported protocol")                            \
 112   _ (OUT_OF_PORTS, "out of ports")                                            \
 113   _ (BAD_ICMP_TYPE, "unsupported ICMP type")                                  \
 114   _ (NO_TRANSLATION, "no translation")                                        \
 115   _ (MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded")                      \
 116   _ (NON_SYN, "non-SYN packet try to create session")                         \
 117   _ (TCP_CLOSED, "drops due to TCP in transitory timeout")                    \
 118   _ (HASH_ADD_FAILED, "hash table add failed")                                \
 119   _ (TRNSL_FAILED, "couldn't translate packet")
 120
 121 typedef enum
 122 {
 123 #define _(sym,str) NAT_OUT2IN_ED_ERROR_##sym,
 124   foreach_nat_out2in_ed_error
 125 #undef _
 126     NAT_OUT2IN_ED_N_ERROR,
 127 } nat_out2in_ed_error_t;
 128
 129 typedef enum
 130 {
 131   NAT44_ED_TCP_FLAG_FIN = 0,
 132   NAT44_ED_TCP_FLAG_SYN,
 133   NAT44_ED_TCP_FLAG_RST,
 134   NAT44_ED_TCP_FLAG_ACK,
 135   NAT44_ED_TCP_N_FLAG,
 136 } nat44_ed_tcp_flag_e;
 137
 138 typedef enum
 139 {
 140   NAT44_ED_DIR_I2O = 0,
 141   NAT44_ED_DIR_O2I,
 142   NAT44_ED_N_DIR,
 143 } nat44_ed_dir_e;
 144
 145 /* Endpoint dependent TCP session state */
 146 typedef enum
 147 {
 148   NAT44_ED_TCP_STATE_CLOSED = 0,
 149   NAT44_ED_TCP_STATE_ESTABLISHED,
 150   NAT44_ED_TCP_STATE_CLOSING,
 151   NAT44_ED_TCP_N_STATE,
 152 } nat44_ed_tcp_state_e;
 153
 154 format_function_t format_ed_session_kvp;
 155 format_function_t format_snat_session;
 156 format_function_t format_snat_static_mapping;
 157 format_function_t format_snat_static_map_to_resolve;
 158 format_function_t format_nat_ed_translation_error;
 159 format_function_t format_nat_6t_flow;
 160 format_function_t format_nat_6t;
 161 format_function_t format_nat44_ed_tcp_state;
 162
 163 /* Session flags */
 164 #define SNAT_SESSION_FLAG_STATIC_MAPPING     (1 << 0)
 165 #define SNAT_SESSION_FLAG_LOAD_BALANCING     (1 << 2)
 166 #define SNAT_SESSION_FLAG_TWICE_NAT          (1 << 3)
 167 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT (1 << 4)
 168 #define SNAT_SESSION_FLAG_FWD_BYPASS         (1 << 5)
 169 #define SNAT_SESSION_FLAG_AFFINITY           (1 << 6)
 170 #define SNAT_SESSION_FLAG_EXACT_ADDRESS      (1 << 7)
 171 #define SNAT_SESSION_FLAG_HAIRPINNING        (1 << 8)
 172
 173 /* NAT interface flags */
 174 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
 175 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
 176
 177 /* Static mapping flags */
 178 #define NAT_SM_FLAG_SELF_TWICE_NAT (1 << 1)
 179 #define NAT_SM_FLAG_TWICE_NAT      (1 << 2)
 180 #define NAT_SM_FLAG_IDENTITY_NAT   (1 << 3)
 181 #define NAT_SM_FLAG_ADDR_ONLY      (1 << 4)
 182 #define NAT_SM_FLAG_EXACT_ADDRESS  (1 << 5)
 183 #define NAT_SM_FLAG_OUT2IN_ONLY    (1 << 6)
 184 #define NAT_SM_FLAG_LB             (1 << 7)
 185 #define NAT_SM_FLAG_SWITCH_ADDRESS (1 << 8)
 186
 187 typedef CLIB_PACKED(struct
 188 {
 189   // number of sessions in this vrf
 190   u32 ses_count;
 191
 192   u32 rx_fib_index;
 193   u32 tx_fib_index;
 194
 195   // is this vrf expired
 196   u8 expired;
 197 }) per_vrf_sessions_t;
 198
 199 typedef union
 200 {
 201   struct
 202   {
 203     ip4_address_t saddr, daddr;
 204     u16 sport; // ICMP id for ICMP case
 205     u16 dport;
 206     u32 fib_index : 24;
 207     u8 proto;
 208   };
 209   u64 as_u64[2];
 210   u64x2u as_u128;
 211 } nat_6t_t;
 212
 213 STATIC_ASSERT_SIZEOF (nat_6t_t, 2 * sizeof (u64));
 214
 215 typedef struct
 216 {
 217 #define NAT_FLOW_OP_SADDR_REWRITE   (1 << 1)
 218 #define NAT_FLOW_OP_SPORT_REWRITE   (1 << 2)
 219 #define NAT_FLOW_OP_DADDR_REWRITE   (1 << 3)
 220 #define NAT_FLOW_OP_DPORT_REWRITE   (1 << 4)
 221 #define NAT_FLOW_OP_ICMP_ID_REWRITE (1 << 5)
 222 #define NAT_FLOW_OP_TXFIB_REWRITE   (1 << 6)
 223   int ops;
 224   nat_6t_t match;
 225   struct
 226   {
 227     ip4_address_t saddr, daddr;
 228     u16 sport;
 229     u16 dport;
 230     u32 fib_index;
 231     u8 proto;
 232     u16 icmp_id;
 233   } rewrite;
 234   uword l3_csum_delta;
 235   uword l4_csum_delta;
 236 } nat_6t_flow_t;
 237
 238 void nat44_ed_forwarding_enable_disable (u8 is_enable);
 239
 240 always_inline void
 241 nat_6t_flow_saddr_rewrite_set (nat_6t_flow_t *f, u32 saddr)
 242 {
 243   f->ops |= NAT_FLOW_OP_SADDR_REWRITE;
 244   f->rewrite.saddr.as_u32 = saddr;
 245 }
 246
 247 always_inline void
 248 nat_6t_flow_daddr_rewrite_set (nat_6t_flow_t *f, u32 daddr)
 249 {
 250   f->ops |= NAT_FLOW_OP_DADDR_REWRITE;
 251   f->rewrite.daddr.as_u32 = daddr;
 252 }
 253
 254 always_inline void
 255 nat_6t_flow_sport_rewrite_set (nat_6t_flow_t *f, u32 sport)
 256 {
 257   f->ops |= NAT_FLOW_OP_SPORT_REWRITE;
 258   f->rewrite.sport = sport;
 259 }
 260
 261 always_inline void
 262 nat_6t_flow_dport_rewrite_set (nat_6t_flow_t *f, u32 dport)
 263 {
 264   f->ops |= NAT_FLOW_OP_DPORT_REWRITE;
 265   f->rewrite.dport = dport;
 266 }
 267
 268 always_inline void
 269 nat_6t_flow_txfib_rewrite_set (nat_6t_flow_t *f, u32 tx_fib_index)
 270 {
 271   f->ops |= NAT_FLOW_OP_TXFIB_REWRITE;
 272   f->rewrite.fib_index = tx_fib_index;
 273 }
 274
 275 always_inline void
 276 nat_6t_flow_icmp_id_rewrite_set (nat_6t_flow_t *f, u16 id)
 277 {
 278   f->ops |= NAT_FLOW_OP_ICMP_ID_REWRITE;
 279   f->rewrite.icmp_id = id;
 280 }
 281
 282 typedef CLIB_PACKED(struct
 283 {
 284   /* Outside network tuple */
 285   struct
 286   {
 287     ip4_address_t addr;
 288     u32 fib_index;
 289     u16 port;
 290   } out2in;
 291
 292   /* Inside network tuple */
 293   struct
 294   {
 295     ip4_address_t addr;
 296     u32 fib_index;
 297     u16 port;
 298   } in2out;
 299
 300   ip_protocol_t proto;
 301
 302   nat_6t_flow_t i2o;
 303   nat_6t_flow_t o2i;
 304
 305   /* Flags */
 306   u32 flags;
 307
 308   /* head of LRU list in which this session is tracked */
 309   u32 lru_head_index;
 310   /* index in global LRU list */
 311   u32 lru_index;
 312   f64 last_lru_update;
 313
 314   /* Last heard timer */
 315   f64 last_heard;
 316
 317   /* Last HA refresh */
 318   f64 ha_last_refreshed;
 319
 320   /* Counters */
 321   u64 total_bytes;
 322   u32 total_pkts;
 323
 324   /* External host address and port */
 325   ip4_address_t ext_host_addr;
 326   u16 ext_host_port;
 327
 328   /* External host address and port after translation */
 329   ip4_address_t ext_host_nat_addr;
 330   u16 ext_host_nat_port;
 331
 332   /* TCP session state */
 333   u8 tcp_flags[NAT44_ED_N_DIR];
 334   nat44_ed_tcp_state_e tcp_state;
 335
 336   /* per vrf sessions index */
 337   u32 per_vrf_sessions_index;
 338
 339   u32 thread_index;
 340 }) snat_session_t;
 341
 342 typedef struct
 343 {
 344   ip4_address_t addr;
 345   ip4_address_t net;
 346   u32 sw_if_index;
 347   u32 fib_index;
 348   u32 addr_len;
 349 } snat_address_t;
 350
 351 typedef struct
 352 {
 353   /* backend IP address */
 354   ip4_address_t addr;
 355   /* backend port number */
 356   u16 port;
 357   /* probability of the backend to be randomly matched */
 358   u8 probability;
 359   u8 prefix;
 360   /* backend FIB table */
 361   u32 vrf_id;
 362   u32 fib_index;
 363 } nat44_lb_addr_port_t;
 364
 365 typedef enum
 366 {
 367   /* twice-nat disabled */
 368   TWICE_NAT_DISABLED,
 369   /* twice-nat enabled */
 370   TWICE_NAT,
 371   /* twice-nat only when src IP equals dst IP after translation */
 372   TWICE_NAT_SELF,
 373 } twice_nat_type_t;
 374
 375 typedef enum
 376 {
 377   /* no load-balancing */
 378   NO_LB_NAT,
 379   /* load-balancing */
 380   LB_NAT,
 381   /* load-balancing with affinity */
 382   AFFINITY_LB_NAT,
 383 } lb_nat_type_t;
 384
 385 typedef struct
 386 {
 387   /* preferred pool address */
 388   ip4_address_t pool_addr;
 389   /* local IP address */
 390   ip4_address_t local_addr;
 391   /* external IP address */
 392   ip4_address_t external_addr;
 393   /* local port */
 394   u16 local_port;
 395   /* external port */
 396   u16 external_port;
 397   /* local FIB table */
 398   u32 vrf_id;
 399   u32 fib_index;
 400   /* protocol */
 401   ip_protocol_t proto;
 402   /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
 403   u32 affinity;
 404   /* worker threads used by backends/local host */
 405   u32 *workers;
 406   /* opaque string tag */
 407   u8 *tag;
 408   /* backends for load-balancing mode */
 409   nat44_lb_addr_port_t *locals;
 410   /* affinity per service lis */
 411   u32 affinity_per_service_list_head_index;
 412   /* flags */
 413   u32 flags;
 414 } snat_static_mapping_t;
 415
 416 typedef struct
 417 {
 418   u32 sw_if_index;
 419   u8 flags;
 420 } snat_interface_t;
 421
 422 typedef struct
 423 {
 424   u8 is_resolved;
 425   ip4_address_t l_addr;
 426   ip4_address_t pool_addr;
 427   u16 l_port;
 428   u16 e_port;
 429   u32 sw_if_index;
 430   u32 vrf_id;
 431   ip_protocol_t proto;
 432   u32 flags;
 433   u8 *tag;
 434 } snat_static_mapping_resolve_t;
 435
 436 typedef struct
 437 {
 438   u8 is_resolved;
 439   u8 is_twice_nat;
 440   u32 sw_if_index;
 441 } snat_address_resolve_t;
 442
 443 typedef struct
 444 {
 445   u32 count;
 446   u32 sw_if_index;
 447   ip4_address_t addr;
 448 } snat_fib_entry_reg_t;
 449
 450 typedef struct
 451 {
 452   /* Session pool */
 453   snat_session_t *sessions;
 454
 455   /* Pool of doubly-linked list elements */
 456   dlist_elt_t *list_pool;
 457
 458   /* LRU session list - head is stale, tail is fresh */
 459   dlist_elt_t *lru_pool;
 460   u32 tcp_trans_lru_head_index;
 461   u32 tcp_estab_lru_head_index;
 462   u32 udp_lru_head_index;
 463   u32 icmp_lru_head_index;
 464   u32 unk_proto_lru_head_index;
 465
 466   /* NAT thread index */
 467   u32 snat_thread_index;
 468
 469   /* real thread index */
 470   u32 thread_index;
 471
 472   per_vrf_sessions_t *per_vrf_sessions_vec;
 473
 474 } snat_main_per_thread_data_t;
 475
 476 struct snat_main_s;
 477
 478 u32 nat44_ed_get_in2out_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
 479                                       u32 rx_fib_index, u8 is_output);
 480 u32 nat44_ed_get_out2in_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
 481                                       u32 rx_fib_index, u8 is_output);
 482
 483 /* Return worker thread index for given packet */
 484 /* NAT address and port allocation function */
 485 typedef int (nat_alloc_out_addr_and_port_function_t) (
 486   snat_address_t *addresses, u32 fib_index, u32 thread_index,
 487   ip_protocol_t proto, ip4_address_t *addr, u16 *port, u16 port_per_thread,
 488   u32 snat_thread_index);
 489
 490 typedef struct nat_fib_s
 491 {
 492   u32 fib_index;
 493   u32 ref_count;
 494 } nat_fib_t;
 495
 496 typedef struct vrf_route_s
 497 {
 498   u32 vrf_id;
 499   u32 fib_index;
 500 } vrf_route_t;
 501
 502 typedef struct vrf_table_s
 503 {
 504   u32 table_vrf_id;
 505   u32 table_fib_index;
 506   vrf_route_t *routes;
 507 } vrf_table_t;
 508
 509 typedef struct snat_main_s
 510 {
 511   /* Thread settings */
 512   u32 num_workers;
 513   u32 first_worker_index;
 514   u32 *workers;
 515   u16 port_per_thread;
 516
 517   /* Per thread data */
 518   snat_main_per_thread_data_t *per_thread_data;
 519
 520   /* Static mapping pool */
 521   snat_static_mapping_t *static_mappings;
 522
 523   /* Endpoint independent lookup tables */
 524   clib_bihash_8_8_t in2out;
 525   clib_bihash_8_8_t out2in;
 526
 527   /* Endpoint dependent lookup table */
 528   clib_bihash_16_8_t flow_hash;
 529
 530   // vector of fibs
 531   nat_fib_t *fibs;
 532
 533   u32 inside_vrf_id;
 534   u32 inside_fib_index;
 535
 536   u32 outside_vrf_id;
 537   u32 outside_fib_index;
 538
 539   // vector of outside fibs
 540   nat_fib_t *outside_fibs;
 541
 542   // VRF routing table for dynamic sessions
 543   vrf_table_t *vrf_tables;
 544
 545   /* Interface pool */
 546   snat_interface_t *interfaces;
 547   snat_interface_t *output_feature_interfaces;
 548   // broken api backward compatibility
 549   snat_interface_t *output_feature_dummy_interfaces;
 550
 551   /* Vector of outside addresses */
 552   snat_address_t *addresses;
 553   /* Vector of twice NAT addresses for external hosts */
 554   snat_address_t *twice_nat_addresses;
 555
 556   /* first interface address should be auto-added */
 557   snat_address_resolve_t *addr_to_resolve;
 558
 559   /* vector of fib entries */
 560   snat_fib_entry_reg_t *fib_entry_reg;
 561
 562   /* vector of interface address static mappings to resolve. */
 563   snat_static_mapping_resolve_t *sm_to_resolve;
 564
 565   /* Randomize port allocation order */
 566   u32 random_seed;
 567
 568   /* Worker handoff frame-queue index */
 569   u32 fq_in2out_index;
 570   u32 fq_in2out_output_index;
 571   u32 fq_out2in_index;
 572
 573   nat44_config_t rconfig;
 574
 575   /* If forwarding is enabled */
 576   u8 forwarding_enabled;
 577
 578   /* Is translation memory size calculated or user defined */
 579   u8 translation_memory_size_set;
 580
 581   u32 translation_buckets;
 582   u32 max_translations_per_thread;
 583   u32 *max_translations_per_fib;
 584
 585   nat_timeouts_t timeouts;
 586
 587   /* TCP MSS clamping */
 588   u16 mss_clamping;
 589
 590   /* counters */
 591   vlib_simple_counter_main_t total_sessions;
 592   u32 max_cfg_sessions_gauge; /* Index of max configured sessions gauge in
 593                                  stats */
 594
 595 #define _(x) vlib_simple_counter_main_t x;
 596   struct
 597   {
 598     struct
 599     {
 600       struct
 601       {
 602         foreach_nat_counter;
 603       } in2out;
 604
 605       struct
 606       {
 607         foreach_nat_counter;
 608       } out2in;
 609     } fastpath;
 610
 611     struct
 612     {
 613       struct
 614       {
 615         foreach_nat_counter;
 616       } in2out;
 617
 618       struct
 619       {
 620         foreach_nat_counter;
 621       } out2in;
 622     } slowpath;
 623
 624     vlib_simple_counter_main_t hairpinning;
 625   } counters;
 626 #undef _
 627
 628   /* API message ID base */
 629   u16 msg_id_base;
 630
 631   /* log class */
 632   vlib_log_class_t log_class;
 633   /* logging level */
 634   u8 log_level;
 635
 636   /* convenience */
 637   ip4_main_t *ip4_main;
 638
 639   fib_source_t fib_src_hi;
 640   fib_source_t fib_src_low;
 641
 642   /* number of worker handoff frame queue elements */
 643   u32 frame_queue_nelts;
 644
 645   /* nat44 plugin enabled */
 646   u8 enabled;
 647
 648   /* TCP session state machine table:
 649    *   first dimension is possible states
 650    *   second dimension is direction (in2out/out2in)
 651    *   third dimension is TCP flag (SYN, RST, FIN)
 652    *
 653    *   value is next state to change to
 654    */
 655   nat44_ed_tcp_state_e tcp_state_change_table[NAT44_ED_TCP_N_STATE]
 656                                              [NAT44_ED_N_DIR]
 657                                              [NAT44_ED_TCP_N_FLAG];
 658 } snat_main_t;
 659
 660 typedef struct
 661 {
 662   u32 thread_index;
 663   f64 now;
 664 } nat44_is_idle_session_ctx_t;
 665
 666 typedef struct
 667 {
 668   u32 cached_sw_if_index;
 669   uword *cached_presence_by_ip4_address;
 670 } snat_runtime_t;
 671
 672 /*
 673  * Why is this here? Because we don't need to touch this layer to
 674  * simply reply to an icmp. We need to change id to a unique
 675  * value to NAT an echo request/reply.
 676  */
 677
 678 extern snat_main_t snat_main;
 679
 680 extern vlib_node_registration_t nat_default_node;
 681 extern vlib_node_registration_t nat_pre_in2out_node;
 682 extern vlib_node_registration_t nat_pre_out2in_node;
 683
 684 extern vlib_node_registration_t nat44_ed_in2out_node;
 685 extern vlib_node_registration_t nat44_ed_in2out_output_node;
 686 extern vlib_node_registration_t nat44_ed_out2in_node;
 687
 688 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
 689 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
 690 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
 691
 692 /** \brief Check if SNAT session is created from static mapping.
 693     @param s SNAT session
 694     @return true if SNAT session is created from static mapping otherwise 0
 695 */
 696 always_inline bool
 697 nat44_ed_is_session_static (snat_session_t *s)
 698 {
 699   return s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING;
 700 }
 701
 702 /** \brief Check if NAT session is twice NAT.
 703     @param s NAT session
 704     @return true if NAT session is twice NAT
 705 */
 706 always_inline bool
 707 nat44_ed_is_twice_nat_session (snat_session_t *s)
 708 {
 709   return s->flags & SNAT_SESSION_FLAG_TWICE_NAT;
 710 }
 711
 712 /** \brief Check if NAT session is load-balancing.
 713     @param s NAT session
 714     @return true if NAT session is load-balancing
 715 */
 716 always_inline bool
 717 nat44_ed_is_lb_session (snat_session_t *s)
 718 {
 719   return s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING;
 720 }
 721
 722 /** \brief Check if NAT session is forwarding bypass.
 723     @param s NAT session
 724     @return true if NAT session is load-balancing
 725 */
 726 always_inline bool
 727 na44_ed_is_fwd_bypass_session (snat_session_t *s)
 728 {
 729   return s->flags & SNAT_SESSION_FLAG_FWD_BYPASS;
 730 }
 731
 732 /** \brief Check if NAT session has affinity record.
 733     @param s NAT session
 734     @return true if NAT session has affinity record
 735 */
 736 always_inline bool
 737 nat44_ed_is_affinity_session (snat_session_t *s)
 738 {
 739   return s->flags & SNAT_SESSION_FLAG_AFFINITY;
 740 }
 741
 742 /** \brief Check if exact pool address should be used.
 743     @param s SNAT session
 744     @return true if exact pool address
 745 */
 746 always_inline bool
 747 nat44_ed_is_exact_address_session (snat_session_t *s)
 748 {
 749   return s->flags & SNAT_SESSION_FLAG_EXACT_ADDRESS;
 750 }
 751
 752 /** \brief Check if NAT interface is inside.
 753     @param i NAT interface
 754     @return true if inside interface
 755 */
 756 always_inline bool
 757 nat44_ed_is_interface_inside (snat_interface_t *i)
 758 {
 759   return i->flags & NAT_INTERFACE_FLAG_IS_INSIDE;
 760 }
 761
 762 /** \brief Check if NAT interface is outside.
 763     @param i NAT interface
 764     @return true if outside interface
 765 */
 766 always_inline bool
 767 nat44_ed_is_interface_outside (snat_interface_t *i)
 768 {
 769   return i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE;
 770 }
 771
 772 /** \brief Check if client initiating TCP connection (received SYN from client)
 773     @param t TCP header
 774     @return true if client initiating TCP connection
 775 */
 776 always_inline bool
 777 tcp_flags_is_init (u8 f)
 778 {
 779   return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK);
 780 }
 781
 782 always_inline bool
 783 is_sm_addr_only (u32 f)
 784 {
 785   return (f & NAT_SM_FLAG_ADDR_ONLY);
 786 }
 787
 788 always_inline bool
 789 is_sm_out2in_only (u32 f)
 790 {
 791   return (f & NAT_SM_FLAG_OUT2IN_ONLY);
 792 }
 793
 794 always_inline bool
 795 is_sm_identity_nat (u32 f)
 796 {
 797   return (f & NAT_SM_FLAG_IDENTITY_NAT);
 798 }
 799
 800 always_inline bool
 801 is_sm_lb (u32 f)
 802 {
 803   return (f & NAT_SM_FLAG_LB);
 804 }
 805
 806 always_inline bool
 807 is_sm_exact_address (u32 f)
 808 {
 809   return (f & NAT_SM_FLAG_EXACT_ADDRESS);
 810 }
 811
 812 always_inline bool
 813 is_sm_self_twice_nat (u32 f)
 814 {
 815   return (f & NAT_SM_FLAG_SELF_TWICE_NAT);
 816 }
 817
 818 always_inline bool
 819 is_sm_twice_nat (u32 f)
 820 {
 821   return (f & NAT_SM_FLAG_TWICE_NAT);
 822 }
 823
 824 always_inline bool
 825 is_sm_switch_address (u32 f)
 826 {
 827   return (f & NAT_SM_FLAG_SWITCH_ADDRESS);
 828 }
 829
 830 #define nat_log_err(...) \
 831   vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
 832 #define nat_log_warn(...) \
 833   vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
 834 #define nat_log_info(...) \
 835   vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
 836 #define nat_log_debug(...)\
 837   vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
 838
 839 clib_error_t *nat44_api_hookup (vlib_main_t *vm);
 840
 841 int snat_set_workers (uword *bitmap);
 842
 843 int nat44_plugin_enable (nat44_config_t c);
 844 int nat44_plugin_disable ();
 845
 846 int nat44_ed_add_interface (u32 sw_if_index, u8 is_inside);
 847 int nat44_ed_del_interface (u32 sw_if_index, u8 is_inside);
 848 int nat44_ed_add_output_interface (u32 sw_if_index);
 849 int nat44_ed_del_output_interface (u32 sw_if_index);
 850
 851 int nat44_ed_add_address (ip4_address_t *addr, u32 vrf_id, u8 twice_nat);
 852 int nat44_ed_del_address (ip4_address_t addr, u8 twice_nat);
 853 int nat44_ed_add_interface_address (u32 sw_if_index, u8 twice_nat);
 854 int nat44_ed_del_interface_address (u32 sw_if_index, u8 twice_nat);
 855
 856 int nat44_ed_add_del_vrf_table (u32 table_vrf_id, bool is_add);
 857 int nat44_ed_add_del_vrf_route (u32 table_vrf_id, u32 vrf_id, bool is_add);
 858 void nat44_ed_del_vrf_tables ();
 859
 860 int nat44_ed_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
 861                                  u16 l_port, u16 e_port, ip_protocol_t proto,
 862                                  u32 vrf_id, u32 sw_if_index, u32 flags,
 863                                  ip4_address_t pool_addr, u8 *tag);
 864
 865 int nat44_ed_del_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
 866                                  u16 l_port, u16 e_port, ip_protocol_t proto,
 867                                  u32 vrf_id, u32 sw_if_index, u32 flags);
 868
 869 int nat44_ed_add_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
 870                                     ip_protocol_t proto,
 871                                     nat44_lb_addr_port_t *locals, u32 flags,
 872                                     u8 *tag, u32 affinity);
 873
 874 int nat44_ed_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
 875                                     ip_protocol_t proto, u32 flags);
 876
 877 int nat44_ed_add_del_lb_static_mapping_local (ip4_address_t e_addr, u16 e_port,
 878                                               ip4_address_t l_addr, u16 l_port,
 879                                               ip_protocol_t proto, u32 vrf_id,
 880                                               u8 probability, u8 is_add);
 881
 882 /**
 883  * @brief Delete NAT44 endpoint-dependent session
 884  *
 885  * @param sm     snat global configuration data
 886  * @param addr   IPv4 address
 887  * @param port   L4 port number
 888  * @param proto  L4 protocol
 889  * @param vrf_id VRF ID
 890  * @param is_in  1 = inside network address and port pair, 0 = outside
 891  *
 892  * @return 0 on success, non-zero value otherwise
 893  */
 894 int nat44_ed_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
 895                           ip4_address_t *eh_addr, u16 eh_port, u8 proto,
 896                           u32 vrf_id, int is_in);
 897
 898 void nat44_ed_free_session_data (snat_main_t *sm, snat_session_t *s,
 899                                  u32 thread_index, u8 is_ha);
 900
 901 /**
 902  * @brief Set NAT44 session limit (session limit, vrf id)
 903  *
 904  * @param session_limit Session limit
 905  * @param vrf_id        VRF id
 906  * @return 0 on success, non-zero value otherwise
 907  */
 908 int nat44_set_session_limit (u32 session_limit, u32 vrf_id);
 909
 910 /**
 911  * @brief Update NAT44 session limit flushing all data (session limit, vrf id)
 912  *
 913  * @param session_limit Session limit
 914  * @param vrf_id        VRF id
 915  * @return 0 on success, non-zero value otherwise
 916  */
 917 int nat44_update_session_limit (u32 session_limit, u32 vrf_id);
 918
 919 void expire_per_vrf_sessions (u32 fib_index);
 920
 921 int snat_static_mapping_match (vlib_main_t *vm, ip4_address_t match_addr,
 922                                u16 match_port, u32 match_fib_index,
 923                                ip_protocol_t match_protocol,
 924                                ip4_address_t *mapping_addr, u16 *mapping_port,
 925                                u32 *mapping_fib_index, int by_external,
 926                                u8 *is_addr_only, twice_nat_type_t *twice_nat,
 927                                lb_nat_type_t *lb, ip4_address_t *ext_host_addr,
 928                                u8 *is_identity_nat,
 929                                snat_static_mapping_t **out);
 930
 931 u32 get_thread_idx_by_port (u16 e_port);
 932
 933 u32 nat_calc_bihash_buckets (u32 n_elts);
 934
 935 void nat44_addresses_free (snat_address_t **addresses);
 936
 937 void nat44_ed_sessions_clear ();
 938
 939 int nat44_ed_set_frame_queue_nelts (u32 frame_queue_nelts);
 940
 941 void nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f);
 942
 943 snat_static_mapping_t *nat44_ed_sm_i2o_lookup (snat_main_t *sm,
 944                                                ip4_address_t addr, u16 port,
 945                                                u32 fib_index, u8 proto);
 946
 947 snat_static_mapping_t *nat44_ed_sm_o2i_lookup (snat_main_t *sm,
 948                                                ip4_address_t addr, u16 port,
 949                                                u32 fib_index, u8 proto);
 950
 951 void nat_syslog_nat44_sadd (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
 952                             u16 isport, ip4_address_t *idaddr, u16 idport,
 953                             ip4_address_t *xsaddr, u16 xsport,
 954                             ip4_address_t *xdaddr, u16 xdport, u8 proto,
 955                             u8 is_twicenat);
 956
 957 void nat_syslog_nat44_sdel (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
 958                             u16 isport, ip4_address_t *idaddr, u16 idport,
 959                             ip4_address_t *xsaddr, u16 xsport,
 960                             ip4_address_t *xdaddr, u16 xdport, u8 proto,
 961                             u8 is_twicenat);
 962
 963 typedef enum
 964 {
 965   NAT_ED_TRNSL_ERR_SUCCESS = 0,
 966   NAT_ED_TRNSL_ERR_TRANSLATION_FAILED = 1,
 967   NAT_ED_TRNSL_ERR_FLOW_MISMATCH = 2,
 968   NAT_ED_TRNSL_ERR_PACKET_TRUNCATED = 3,
 969   NAT_ED_TRNSL_ERR_INNER_IP_CORRUPT = 4,
 970   NAT_ED_TRNSL_ERR_INVALID_CSUM = 5,
 971 } nat_translation_error_e;
 972
 973 nat_translation_error_e nat_6t_flow_buf_translate_i2o (
 974   vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
 975   nat_6t_flow_t *f, ip_protocol_t proto, int is_output_feature);
 976
 977 nat_translation_error_e nat_6t_flow_buf_translate_o2i (
 978   vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
 979   nat_6t_flow_t *f, ip_protocol_t proto, int is_output_feature);
 980
 981 #endif /* __included_nat44_ed_h__ */
 982 /*
 983  * fd.io coding-style-patch-verification: ON
 984  *
 985  * Local Variables:
 986  * eval: (c-set-style "gnu")
 987  * End:
 988  */