src/plugins/nat/nat.api

   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 vl_api_version 2.1.0
  17
  18 /**
  19  * @file nat.api
  20  * @brief VPP control-plane API messages.
  21  *
  22  * This file defines VPP control-plane API messages which are generally
  23  * called through a shared memory interface.
  24  */
  25
  26 /*
  27  * Common NAT plugin APIs
  28  */
  29
  30 /** \brief Control ping from client to api server request
  31     @param client_index - opaque cookie to identify the sender
  32     @param context - sender context, to match reply w/ request
  33 */
  34 define nat_control_ping
  35 {
  36   u32 client_index;
  37   u32 context;
  38 };
  39
  40 /** \brief Control ping from the client to the server response
  41     @param client_index - opaque cookie to identify the sender
  42     @param context - sender context, to match reply w/ request
  43     @param retval - return code for the request
  44     @param vpe_pid - the pid of the vpe, returned by the server
  45 */
  46 define nat_control_ping_reply
  47 {
  48   u32 context;
  49   i32 retval;
  50   u32 client_index;
  51   u32 vpe_pid;
  52 };
  53
  54 /** \brief Show NAT plugin startup config
  55     @param client_index - opaque cookie to identify the sender
  56     @param context - sender context, to match reply w/ request
  57 */
  58 define nat_show_config
  59 {
  60   u32 client_index;
  61   u32 context;
  62 };
  63
  64 /** \brief Show NAT plugin startup config reply
  65     @param context - sender context, to match reply w/ request
  66     @param retval - return code for the request
  67     @param static_mapping_only - if 1 dynamic translations disabled
  68     @param static_mapping_connection_tracking - if 1 create session data
  69     @param deterministic - if 1 deterministic mapping
  70     @param translation_buckets - number of translation hash buckets
  71     @param translation_memory_size - translation hash memory size
  72     @param user_buckets - number of user hash buckets
  73     @param user_memory_size - user hash memory size
  74     @param max_translations_per_user - maximum number of translations per user
  75     @param outside_vrf_id - outside VRF id
  76     @param inside_vrf_id - default inside VRF id
  77 */
  78 define nat_show_config_reply
  79 {
  80   u32 context;
  81   i32 retval;
  82   u8 static_mapping_only;
  83   u8 static_mapping_connection_tracking;
  84   u8 deterministic;
  85   u32 translation_buckets;
  86   u32 translation_memory_size;
  87   u32 user_buckets;
  88   u32 user_memory_size;
  89   u32 max_translations_per_user;
  90   u32 outside_vrf_id;
  91   u32 inside_vrf_id;
  92 };
  93
  94 /** \brief Set NAT workers
  95     @param client_index - opaque cookie to identify the sender
  96     @param context - sender context, to match reply w/ request
  97     @param worker_mask - NAT workers mask
  98 */
  99 autoreply define nat_set_workers {
 100   u32 client_index;
 101   u32 context;
 102   u64 worker_mask;
 103 };
 104
 105 /** \brief Dump NAT workers
 106     @param client_index - opaque cookie to identify the sender
 107     @param context - sender context, to match reply w/ request
 108 */
 109 define nat_worker_dump {
 110   u32 client_index;
 111   u32 context;
 112 };
 113
 114 /** \brief NAT workers details response
 115     @param context - sender context, to match reply w/ request
 116     @param worker_index - worker index
 117     @param lcore_id - lcore ID
 118     @param name - worker name
 119 */
 120 define nat_worker_details {
 121   u32 context;
 122   u32 worker_index;
 123   u32 lcore_id;
 124   u8 name[64];
 125 };
 126
 127 /** \brief Enable/disable NAT IPFIX logging
 128     @param client_index - opaque cookie to identify the sender
 129     @param context - sender context, to match reply w/ request
 130     @param domain_id - observation domain ID
 131     @param src_port - source port number
 132     @param enable - 1 if enable, 0 if disable
 133 */
 134 autoreply define nat_ipfix_enable_disable {
 135   u32 client_index;
 136   u32 context;
 137   u32 domain_id;
 138   u16 src_port;
 139   u8 enable;
 140 };
 141
 142 /** \brief Set NAT virtual fragmentation reassembly
 143     @param client_index - opaque cookie to identify the sender
 144     @param context - sender context, to match reply w/ request
 145     @param timeout - reassembly timeout
 146     @param max_reass - maximum number of concurrent reassemblies
 147     @param max_frag - maximum number of fragmets per reassembly
 148     @param drop_frag - if 0 translate fragments, otherwise drop fragments
 149     @param is_ip6 - 1 if IPv6, 0 if IPv4
 150 */
 151 autoreply define nat_set_reass {
 152   u32 client_index;
 153   u32 context;
 154   u32 timeout;
 155   u16 max_reass;
 156   u8  max_frag;
 157   u8  drop_frag;
 158   u8  is_ip6;
 159 };
 160
 161 /** \brief Get NAT virtual fragmentation reassembly configuration
 162     @param client_index - opaque cookie to identify the sender
 163     @param context - sender context, to match reply w/ request
 164 */
 165 define nat_get_reass {
 166   u32 client_index;
 167   u32 context;
 168 };
 169
 170 /** \brief Get NAT virtual fragmentation reassembly configuration reply
 171     @param context - sender context, to match reply w/ request
 172     @param retval - return code
 173     @param ip4_timeout - reassembly timeout
 174     @param ip4_max_reass - maximum number of concurrent reassemblies
 175     @param ip4_max_frag - maximum number of fragmets per reassembly
 176     @param ip4_drop_frag - if 0 translate fragments, otherwise drop fragments
 177     @param ip6_timeout - reassembly timeout
 178     @param ip6_max_reass - maximum number of concurrent reassemblies
 179     @param ip6_max_frag - maximum number of fragmets per reassembly
 180     @param ip6_drop_frag - if 0 translate fragments, otherwise drop fragments
 181 */
 182 define nat_get_reass_reply {
 183   u32 context;
 184   i32 retval;
 185   u32 ip4_timeout;
 186   u16 ip4_max_reass;
 187   u8  ip4_max_frag;
 188   u8  ip4_drop_frag;
 189   u32 ip6_timeout;
 190   u16 ip6_max_reass;
 191   u8  ip6_max_frag;
 192   u8  ip6_drop_frag;
 193 };
 194
 195 /** \brief Dump NAT virtual fragmentation reassemblies
 196     @param client_index - opaque cookie to identify the sender
 197     @param context - sender context, to match reply w/ request
 198 */
 199 define nat_reass_dump {
 200   u32 client_index;
 201   u32 context;
 202 };
 203
 204 /** \brief NAT virtual fragmentation reassemblies response
 205     @param context - sender context, to match reply w/ request
 206     @param is_ip4 - 1 if address type is IPv4
 207     @param src_addr - source IP address
 208     @param dst_addr - destination IP address
 209     @param frag_id - fragment ID
 210     @param proto - protocol
 211     @param frag_n - number of cached fragments
 212 */
 213 define nat_reass_details {
 214   u32 context;
 215   u8 is_ip4;
 216   u8 src_addr[16];
 217   u8 dst_addr[16];
 218   u32 frag_id;
 219   u8 proto;
 220   u8 frag_n;
 221 };
 222
 223 /*
 224  * NAT44 APIs
 225  */
 226
 227 /** \brief Add/del NAT44 address range
 228     @param client_index - opaque cookie to identify the sender
 229     @param context - sender context, to match reply w/ request
 230     @param first_ip_address - first IPv4 address
 231     @param last_ip_address - last IPv4 address
 232     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 233     @param twice_nat - twice NAT address range for extenal hosts
 234     @param is_add - 1 if add, 0 if delete
 235 */
 236 autoreply define nat44_add_del_address_range {
 237   u32 client_index;
 238   u32 context;
 239   u8 first_ip_address[4];
 240   u8 last_ip_address[4];
 241   u32 vrf_id;
 242   u8 twice_nat;
 243   u8 is_add;
 244 };
 245
 246 /** \brief Dump NAT44 addresses
 247     @param client_index - opaque cookie to identify the sender
 248     @param context - sender context, to match reply w/ request
 249 */
 250 define nat44_address_dump {
 251   u32 client_index;
 252   u32 context;
 253 };
 254
 255 /** \brief NAT44 address details response
 256     @param context - sender context, to match reply w/ request
 257     @param ip_address - IPv4 address
 258     @param twice_nat - twice NAT address range for extenal hosts
 259     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 260 */
 261 define nat44_address_details {
 262   u32 context;
 263   u8 ip_address[4];
 264   u8 twice_nat;
 265   u32 vrf_id;
 266 };
 267
 268 /** \brief Enable/disable NAT44 feature on the interface
 269     @param client_index - opaque cookie to identify the sender
 270     @param context - sender context, to match reply w/ request
 271     @param is_add - 1 if add, 0 if delete
 272     @param is_inside - 1 if inside, 0 if outside
 273     @param sw_if_index - software index of the interface
 274 */
 275 autoreply define nat44_interface_add_del_feature {
 276   u32 client_index;
 277   u32 context;
 278   u8 is_add;
 279   u8 is_inside;
 280   u32 sw_if_index;
 281 };
 282
 283 /** \brief Dump interfaces with NAT44 feature
 284     @param client_index - opaque cookie to identify the sender
 285     @param context - sender context, to match reply w/ request
 286 */
 287 define nat44_interface_dump {
 288   u32 client_index;
 289   u32 context;
 290 };
 291
 292 /** \brief NAT44 interface details response
 293     @param context - sender context, to match reply w/ request
 294     @param is_inside - 1 if inside, 0 if outside, 2 if inside and outside
 295     @param sw_if_index - software index of the interface
 296 */
 297 define nat44_interface_details {
 298   u32 context;
 299   u8 is_inside;
 300   u32 sw_if_index;
 301 };
 302
 303 /** \brief Enable/disbale NAT44 as an interface output feature (postrouting
 304            in2out translation)
 305     @param client_index - opaque cookie to identify the sender
 306     @param context - sender context, to match reply w/ request
 307     @param is_add - 1 if add, 0 if delete
 308     @param is_inside - 1 if inside, 0 if outside
 309     @param sw_if_index - software index of the interface
 310 */
 311 autoreply define nat44_interface_add_del_output_feature {
 312   u32 client_index;
 313   u32 context;
 314   u8 is_add;
 315   u8 is_inside;
 316   u32 sw_if_index;
 317 };
 318
 319 /** \brief Dump interfaces with NAT44 output feature
 320     @param client_index - opaque cookie to identify the sender
 321     @param context - sender context, to match reply w/ request
 322 */
 323 define nat44_interface_output_feature_dump {
 324   u32 client_index;
 325   u32 context;
 326 };
 327
 328 /** \brief NAT44 interface with output feature details response
 329     @param context - sender context, to match reply w/ request
 330     @param is_inside - 1 if inside, 0 if outside
 331     @param sw_if_index - software index of the interface
 332 */
 333 define nat44_interface_output_feature_details {
 334   u32 context;
 335   u8 is_inside;
 336   u32 sw_if_index;
 337 };
 338
 339 /** \brief Add/delete NAT44 static mapping
 340     @param client_index - opaque cookie to identify the sender
 341     @param context - sender context, to match reply w/ request
 342     @param is_add - 1 if add, 0 if delete
 343     @param addr_only - 1 if address only mapping
 344     @param local_ip_address - local IPv4 address
 345     @param external_ip_address - external IPv4 address
 346     @param protocol - IP protocol
 347     @param local_port - local port number
 348     @param external_port - external port number
 349     @param external_sw_if_index - external interface (if set
 350                                   external_ip_address is ignored, ~0 means not
 351                                   used)
 352     @param vfr_id - VRF ID
 353     @param twice_nat - if 1 translate external host address and port, only for
 354                        1:1 NAPT (addr_only must be 0)
 355 */
 356 autoreply define nat44_add_del_static_mapping {
 357   u32 client_index;
 358   u32 context;
 359   u8 is_add;
 360   u8 addr_only;
 361   u8 local_ip_address[4];
 362   u8 external_ip_address[4];
 363   u8 protocol;
 364   u16 local_port;
 365   u16 external_port;
 366   u32 external_sw_if_index;
 367   u32 vrf_id;
 368   u8 twice_nat;
 369 };
 370
 371 /** \brief Dump NAT44 static mappings
 372     @param client_index - opaque cookie to identify the sender
 373     @param context - sender context, to match reply w/ request
 374 */
 375 define nat44_static_mapping_dump {
 376   u32 client_index;
 377   u32 context;
 378 };
 379
 380 /** \brief NAT44 static mapping details response
 381     @param context - sender context, to match reply w/ request
 382     @param addr_only - 1 if address only mapping
 383     @param local_ip_address - local IPv4 address
 384     @param external_ip_address - external IPv4 address
 385     @param protocol - IP protocol
 386     @param local_port - local port number
 387     @param external_port - external port number
 388     @param external_sw_if_index - external interface
 389     @param vfr_id - VRF ID
 390     @param twice_nat - if 1 translate external host address and port
 391 */
 392 define nat44_static_mapping_details {
 393   u32 context;
 394   u8 addr_only;
 395   u8 local_ip_address[4];
 396   u8 external_ip_address[4];
 397   u8 protocol;
 398   u16 local_port;
 399   u16 external_port;
 400   u32 external_sw_if_index;
 401   u32 vrf_id;
 402   u8 twice_nat;
 403 };
 404
 405 /** \brief Add/delete NAT44 identity mapping
 406     @param client_index - opaque cookie to identify the sender
 407     @param context - sender context, to match reply w/ request
 408     @param is_add - 1 if add, 0 if delete
 409     @param addr_only - 1 if address only mapping
 410     @param ip_address - IPv4 address
 411     @param protocol - IP protocol
 412     @param port - port number
 413     @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
 414                                     used)
 415     @param vfr_id - VRF ID (if ~0 use default VRF)
 416 */
 417 autoreply define nat44_add_del_identity_mapping {
 418   u32 client_index;
 419   u32 context;
 420   u8 is_add;
 421   u8 addr_only;
 422   u8 ip_address[4];
 423   u8 protocol;
 424   u16 port;
 425   u32 sw_if_index;
 426   u32 vrf_id;
 427 };
 428
 429 /** \brief Dump NAT44 identity mappings
 430     @param client_index - opaque cookie to identify the sender
 431     @param context - sender context, to match reply w/ request
 432 */
 433 define nat44_identity_mapping_dump {
 434   u32 client_index;
 435   u32 context;
 436 };
 437
 438 /** \brief NAT44 identity mapping details response
 439     @param context - sender context, to match reply w/ request
 440     @param addr_only - 1 if address only mapping
 441     @param ip_address - IPv4 address
 442     @param protocol - IP protocol
 443     @param port - port number
 444     @param sw_if_index - interface
 445     @param vfr_id - VRF ID
 446 */
 447 define nat44_identity_mapping_details {
 448   u32 context;
 449   u8 addr_only;
 450   u8 ip_address[4];
 451   u8 protocol;
 452   u16 port;
 453   u32 sw_if_index;
 454   u32 vrf_id;
 455 };
 456
 457 /** \brief Add/delete NAT44 pool address from specific interfce
 458     @param client_index - opaque cookie to identify the sender
 459     @param context - sender context, to match reply w/ request
 460     @param is_add - 1 if add, 0 if delete
 461     @param twice_nat - twice NAT address for extenal hosts
 462     @param sw_if_index - software index of the interface
 463 */
 464 autoreply define nat44_add_del_interface_addr {
 465   u32 client_index;
 466   u32 context;
 467   u8 is_add;
 468   u8 twice_nat;
 469   u32 sw_if_index;
 470 };
 471
 472 /** \brief Dump NAT44 pool addresses interfaces
 473     @param client_index - opaque cookie to identify the sender
 474     @param context - sender context, to match reply w/ request
 475 */
 476 define nat44_interface_addr_dump {
 477   u32 client_index;
 478   u32 context;
 479 };
 480
 481 /** \brief NAT44 pool addresses interfaces details response
 482     @param context - sender context, to match reply w/ request
 483     @param sw_if_index - software index of the interface
 484     @param twice_nat - twice NAT address for extenal hosts
 485 */
 486 define nat44_interface_addr_details {
 487   u32 context;
 488   u32 sw_if_index;
 489   u8 twice_nat;
 490 };
 491
 492 /** \brief Dump NAT44 users
 493     @param client_index - opaque cookie to identify the sender
 494     @param context - sender context, to match reply w/ request
 495 */
 496 define nat44_user_dump {
 497   u32 client_index;
 498   u32 context;
 499 };
 500
 501 /** \brief NAT44 users response
 502     @param context - sender context, to match reply w/ request
 503     @vrf_id - VRF ID
 504     @param ip_adress - IPv4 address
 505     @param nsessions - number of dynamic sessions
 506     @param nstaticsessions - number of static sessions
 507 */
 508 define nat44_user_details {
 509   u32 context;
 510   u32 vrf_id;
 511   u8 ip_address[4];
 512   u32 nsessions;
 513   u32 nstaticsessions;
 514 };
 515
 516 /** \brief NAT44 user's sessions
 517     @param client_index - opaque cookie to identify the sender
 518     @param context - sender context, to match reply w/ request
 519     @param is_ip4 - 1 if address type is IPv4
 520     @param user_ip - IP address of the user to dump
 521     @param vrf_id - VRF_ID
 522 */
 523 define nat44_user_session_dump {
 524   u32 client_index;
 525   u32 context;
 526   u8 ip_address[4];
 527   u32 vrf_id;
 528 };
 529
 530 /** \brief NAT44 user's sessions response
 531     @param context - sender context, to match reply w/ request
 532     @param outside_ip_address - outside IPv4 address
 533     @param outside_port - outside port
 534     @param inside_ip_address - inside IPv4 address
 535     @param inside_port - inside port
 536     @param protocol - protocol
 537     @param is_static - 1 if session is static
 538     @param last_heard - last heard timer
 539     @param total_bytes - count of bytes sent through session
 540     @param total_pkts - count of pakets sent through session
 541 */
 542 define nat44_user_session_details {
 543   u32 context;
 544   u8 outside_ip_address[4];
 545   u16 outside_port;
 546   u8 inside_ip_address[4];
 547   u16 inside_port;
 548   u16 protocol;
 549   u8 is_static;
 550   u64 last_heard;
 551   u64 total_bytes;
 552   u32 total_pkts;
 553 };
 554
 555 typeonly manual_endian define nat44_lb_addr_port {
 556   u8 addr[4];
 557   u16 port;
 558   u8 probability;
 559 };
 560
 561 autoreply manual_endian define nat44_add_del_lb_static_mapping {
 562   u32 client_index;
 563   u32 context;
 564   u8 is_add;
 565   u8 external_addr[4];
 566   u16 external_port;
 567   u8 protocol;
 568   u32 vrf_id;
 569   u8 twice_nat;
 570   u8 local_num;
 571   vl_api_nat44_lb_addr_port_t locals[local_num];
 572 };
 573
 574 define nat44_lb_static_mapping_dump {
 575   u32 client_index;
 576   u32 context;
 577 };
 578
 579 manual_endian define nat44_lb_static_mapping_details {
 580   u32 context;
 581   u8 external_addr[4];
 582   u16 external_port;
 583   u8 protocol;
 584   u32 vrf_id;
 585   u8 twice_nat;
 586   u8 local_num;
 587   vl_api_nat44_lb_addr_port_t locals[local_num];
 588 };
 589
 590 /** \brief Delete NAT44 session
 591     @param client_index - opaque cookie to identify the sender
 592     @param context - sender context, to match reply w/ request
 593     @param is_in - 1 if inside network addres and port pari, 0 if outside
 594     @param ip_address - IPv4 address
 595     @param protocol - IP protocol
 596     @param port - port number
 597     @param vfr_id - VRF ID
 598 */
 599 autoreply define nat44_del_session {
 600   u32 client_index;
 601   u32 context;
 602   u8 is_in;
 603   u8 address[4];
 604   u8 protocol;
 605   u16 port;
 606   u32 vrf_id;
 607 };
 608
 609 /** \brief Enable/disable forwarding for NAT44
 610     Forward packets which don't match existing translation
 611     or static mapping instead of dropping them.
 612     @param client_index - opaque cookie to identify the sender
 613     @param context - sender context, to match reply w/ request
 614     @param enable - 0 for enable, 1 for disable
 615 */
 616 autoreply define nat44_forwarding_enable_disable {
 617   u32 client_index;
 618   u32 context;
 619   u8 enable;
 620 };
 621
 622 /** \brief Check if forwarding is enabled or disabled
 623     @param client_index - opaque cookie to identify the sender
 624     @param context - sender context, to match reply w/ request
 625 */
 626 define nat44_forwarding_is_enabled {
 627   u32 client_index;
 628   u32 context;
 629 };
 630
 631 /** \brief Response to check if forwarding is enabled or disabled
 632     @param context - sender context, to match reply w/ request
 633     @param enabled - 1 if enabled, 0 if disabled
 634 */
 635 define nat44_forwarding_is_enabled_reply {
 636   u32 context;
 637   u8 enabled;
 638 };
 639
 640
 641 /*
 642  * Deterministic NAT (CGN) APIs
 643  */
 644
 645 /** \brief Add/delete NAT deterministic mapping
 646     @param client_index - opaque cookie to identify the sender
 647     @param context - sender context, to match reply w/ request
 648     @param is_add - 1 if add, 0 if delete
 649     @param is_nat44 - 1 if NAT44
 650     @param in_addr - inside IP address
 651     @param in_plen - inside IP address prefix length
 652     @param out_addr - outside IPv4 address
 653     @param out_addr - outside IPv4 address prefix length
 654 */
 655 autoreply define nat_det_add_del_map {
 656   u32 client_index;
 657   u32 context;
 658   u8 is_add;
 659   u8 is_nat44;
 660   u8 addr_only;
 661   u8 in_addr[16];
 662   u8 in_plen;
 663   u8 out_addr[4];
 664   u8 out_plen;
 665 };
 666
 667 /** \brief Get outside address and port range from inside address
 668     @param client_index - opaque cookie to identify the sender
 669     @param context - sender context, to match reply w/ request
 670     @param is_nat44 - 1 if NAT44
 671     @param in_addr - inside IP address
 672 */
 673 define nat_det_forward {
 674   u32 client_index;
 675   u32 context;
 676   u8 is_nat44;
 677   u8 in_addr[16];
 678 };
 679
 680 /** \brief Get outside address and port range from inside address
 681     @param context - sender context, to match reply w/ request
 682     @param retval - return code
 683     @param out_port_lo - outside port range start
 684     @param out_port_hi - outside port range end
 685     @param out_addr - outside IPv4 address
 686 */
 687 define nat_det_forward_reply {
 688   u32 context;
 689   i32 retval;
 690   u16 out_port_lo;
 691   u16 out_port_hi;
 692   u8 out_addr[4];
 693 };
 694
 695 /** \brief Get inside address from outside address and port
 696     @param client_index - opaque cookie to identify the sender
 697     @param context - sender context, to match reply w/ request
 698     @param out_port - outside port
 699     @param out_addr - outside IPv4 address
 700 */
 701 define nat_det_reverse {
 702   u32 client_index;
 703   u32 context;
 704   u16 out_port;
 705   u8 out_addr[4];
 706 };
 707
 708 /** \brief Get inside address from outside address and port reply
 709     @param context - sender context, to match reply w/ request
 710     @param retval - return code
 711     @param is_nat44 - 1 if NAT44
 712     @param in_addr - inside IP address
 713 */
 714 define nat_det_reverse_reply {
 715   u32 context;
 716   i32 retval;
 717   u8 is_nat44;
 718   u8 in_addr[16];
 719 };
 720
 721 /** \brief Dump NAT deterministic mappings
 722     @param client_index - opaque cookie to identify the sender
 723     @param context - sender context, to match reply w/ request
 724 */
 725 define nat_det_map_dump {
 726   u32 client_index;
 727   u32 context;
 728 };
 729
 730 /** \brief NAT users response
 731     @param context - sender context, to match reply w/ request
 732     @param is_nat44 - 1 if NAT44
 733     @param in_addr - inside IP address
 734     @param in_plen - inside IP address prefix length
 735     @param out_addr - outside IPv4 address
 736     @param out_plen - outside IPv4 address prefix length
 737     @param sharing_ratio - outside to inside address sharing ratio
 738     @param ports_per_host - number of ports available to a host
 739     @param ses_num - number of sessions belonging to this mapping
 740 */
 741 define nat_det_map_details {
 742   u32 context;
 743   u8 is_nat44;
 744   u8 in_addr[16];
 745   u8 in_plen;
 746   u8 out_addr[4];
 747   u8 out_plen;
 748   u32 sharing_ratio;
 749   u16 ports_per_host;
 750   u32 ses_num;
 751 };
 752
 753 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
 754     @param client_index - opaque cookie to identify the sender
 755     @param context - sender context, to match reply w/ request
 756     @param udp - UDP timeout (default 300sec)
 757     @param tcp_established - TCP established timeout (default 7440sec)
 758     @param tcp_transitory - TCP transitory timeout (default 240sec)
 759     @param icmp - ICMP timeout (default 60sec)
 760 */
 761 autoreply define nat_det_set_timeouts {
 762   u32 client_index;
 763   u32 context;
 764   u32 udp;
 765   u32 tcp_established;
 766   u32 tcp_transitory;
 767   u32 icmp;
 768 };
 769
 770 /** \brief Get values of timeouts for deterministic NAT (seconds)
 771     @param client_index - opaque cookie to identify the sender
 772     @param context - sender context, to match reply w/ request
 773 */
 774 define nat_det_get_timeouts {
 775   u32 client_index;
 776   u32 context;
 777 };
 778
 779 /** \brief Get values of timeouts for deterministic NAT reply
 780     @param context - sender context, to match reply w/ request
 781     @param retval - return code
 782     @param udp - UDP timeout (default 300sec)
 783     @param tcp_established - TCP established timeout (default 7440sec)
 784     @param tcp_transitory - TCP transitory timeout (default 240sec)
 785     @param icmp - ICMP timeout (default 60sec)
 786 */
 787 define nat_det_get_timeouts_reply {
 788   u32 context;
 789   i32 retval;
 790   u32 udp;
 791   u32 tcp_established;
 792   u32 tcp_transitory;
 793   u32 icmp;
 794 };
 795
 796 /** \brief Close deterministic NAT session by outside address and port
 797     @param client_index - opaque cookie to identify the sender
 798     @param context - sender context, to match reply w/ request
 799     @param out_addr - outside IPv4 address
 800     @param out_port - outside port
 801     @param ext_addr - external host IPv4 address
 802     @param ext_port - external host port
 803 */
 804 autoreply define nat_det_close_session_out {
 805   u32 client_index;
 806   u32 context;
 807   u8 out_addr[4];
 808   u16 out_port;
 809   u8 ext_addr[4];
 810   u16 ext_port;
 811 };
 812
 813 /** \brief Close deterministic NAT session by inside address and port
 814     @param client_index - opaque cookie to identify the sender
 815     @param context - sender context, to match reply w/ request
 816     @param is_nat44 - 1 if NAT44
 817     @param in_addr - inside IP address
 818     @param in_port - inside port
 819     @param ext_addr - external host IP address
 820     @param ext_port - external host port
 821 */
 822 autoreply define nat_det_close_session_in {
 823   u32 client_index;
 824   u32 context;
 825   u8 is_nat44;
 826   u8 in_addr[16];
 827   u16 in_port;
 828   u8 ext_addr[16];
 829   u16 ext_port;
 830 };
 831
 832 /** \brief Dump determinstic NAT sessions
 833     @param client_index - opaque cookie to identify the sender
 834     @param context - sender context, to match reply w/ request
 835     @param is_nat44 - 1 if NAT44
 836     @param user_addr - address of an inside user whose sessions to dump
 837 */
 838 define nat_det_session_dump {
 839   u32 client_index;
 840   u32 context;
 841   u8 is_nat44;
 842   u8 user_addr[16];
 843 };
 844
 845 /** \brief Deterministic NAT sessions reply
 846     @param context - sender context, to match reply w/ request
 847     @param in_port - inside port
 848     @param ext_addr - external host address
 849     @param ext_port - external host port
 850     @param out_port - outside NAT port
 851     @param state - session state
 852     @param expire - session expiration timestamp
 853 */
 854 define nat_det_session_details {
 855   u32 client_index;
 856   u32 context;
 857   u16 in_port;
 858   u8 ext_addr[4];
 859   u16 ext_port;
 860   u16 out_port;
 861   u8 state;
 862   u32 expire;
 863 };
 864
 865 /*
 866  * NAT64 APIs
 867  */
 868
 869 /** \brief Add/delete address range to NAT64 pool
 870     @param client_index - opaque cookie to identify the sender
 871     @param context - sender context, to match reply w/ request
 872     @param start_addr - start address of the range
 873     @param end_addr - end address of the range
 874     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 875     @param is_add - 1 if add, 0 if delete
 876 */
 877 autoreply define nat64_add_del_pool_addr_range {
 878   u32 client_index;
 879   u32 context;
 880   u8 start_addr[4];
 881   u8 end_addr[4];
 882   u32 vrf_id;
 883   u8 is_add;
 884 };
 885
 886 /** \brief Dump NAT64 pool addresses
 887     @param client_index - opaque cookie to identify the sender
 888     @param context - sender context, to match reply w/ request
 889 */
 890 define nat64_pool_addr_dump {
 891   u32 client_index;
 892   u32 context;
 893 };
 894
 895 /** \brief NAT64 pool address details response
 896     @param context - sender context, to match reply w/ request
 897     @param address - IPv4 address
 898     @param vfr_id - VRF id of tenant, ~0 means independent of VRF
 899 */
 900 define nat64_pool_addr_details {
 901   u32 context;
 902   u8 address[4];
 903   u32 vrf_id;
 904 };
 905
 906 /** \brief Enable/disable NAT64 feature on the interface
 907     @param client_index - opaque cookie to identify the sender
 908     @param context - sender context, to match reply w/ request
 909     @param sw_if_index - index of the interface
 910     @param is_inside - 1 if inside, 0 if outside
 911     @param is_add - 1 if add, 0 if delete
 912 */
 913 autoreply define nat64_add_del_interface {
 914   u32 client_index;
 915   u32 context;
 916   u32 sw_if_index;
 917   u8 is_inside;
 918   u8 is_add;
 919 };
 920
 921 /** \brief Dump interfaces with NAT64 feature
 922     @param client_index - opaque cookie to identify the sender
 923     @param context - sender context, to match reply w/ request
 924 */
 925 define nat64_interface_dump {
 926   u32 client_index;
 927   u32 context;
 928 };
 929
 930 /** \brief NAT64 interface details response
 931     @param context - sender context, to match reply w/ request
 932     @param is_inside - 1 if inside, 0 if outside
 933     @param sw_if_index - index of the interface
 934 */
 935 define nat64_interface_details {
 936   u32 context;
 937   u8 is_inside;
 938   u32 sw_if_index;
 939 };
 940
 941 /** \brief Add/delete NAT64 static BIB entry
 942     @param client_index - opaque cookie to identify the sender
 943     @param context - sender context, to match reply w/ request
 944     @param i_addr - inside IPv6 address
 945     @param o_addr - outside IPv4 address
 946     @param i_port - inside port number
 947     @param o_port - outside port number
 948     @param vrf_id - VRF id of tenant
 949     @param proto - protocol number
 950     @param is_add - 1 if add, 0 if delete
 951 */
 952  autoreply define nat64_add_del_static_bib {
 953   u32 client_index;
 954   u32 context;
 955   u8 i_addr[16];
 956   u8 o_addr[4];
 957   u16 i_port;
 958   u16 o_port;
 959   u32 vrf_id;
 960   u8 proto;
 961   u8 is_add;
 962 };
 963
 964 /** \brief Dump NAT64 BIB
 965     @param client_index - opaque cookie to identify the sender
 966     @param context - sender context, to match reply w/ request
 967     @param proto - protocol of the BIB: 255 - all BIBs
 968                                         6 - TCP BIB
 969                                         17 - UDP BIB
 970                                         1/58 - ICMP BIB
 971                                         otherwise - "unknown" protocol BIB
 972 */
 973 define nat64_bib_dump {
 974   u32 client_index;
 975   u32 context;
 976   u8 proto;
 977 };
 978
 979 /** \brief NAT64 BIB details response
 980     @param context - sender context, to match reply w/ request
 981     @param i_addr - inside IPv6 address
 982     @param o_addr - outside IPv4 address
 983     @param i_port - inside port number
 984     @param o_port - outside port number
 985     @param vrf_id - VRF id of tenant
 986     @param proto - protocol number
 987     @param is_static - 1 if static BIB entry, 0 if dynamic
 988     @param ses_num - number of sessions associated with the BIB entry
 989 */
 990 define nat64_bib_details {
 991   u32 context;
 992   u8 i_addr[16];
 993   u8 o_addr[4];
 994   u16 i_port;
 995   u16 o_port;
 996   u32 vrf_id;
 997   u8 proto;
 998   u8 is_static;
 999   u32 ses_num;
1000 };
1001
1002 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1003     @param client_index - opaque cookie to identify the sender
1004     @param context - sender context, to match reply w/ request
1005     @param udp - UDP timeout (default 300sec)
1006     @param icmp - ICMP timeout (default 60sec)
1007     @param tcp_trans - TCP transitory timeout (default 240sec)
1008     @param tcp_est - TCP established timeout (default 7440sec)
1009     @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1010 */
1011 autoreply define nat64_set_timeouts {
1012   u32 client_index;
1013   u32 context;
1014   u32 udp;
1015   u32 icmp;
1016   u32 tcp_trans;
1017   u32 tcp_est;
1018   u32 tcp_incoming_syn;
1019 };
1020
1021 /** \brief Get values of timeouts for NAT64 (seconds)
1022     @param client_index - opaque cookie to identify the sender
1023     @param context - sender context, to match reply w/ request
1024 */
1025 define nat64_get_timeouts {
1026   u32 client_index;
1027   u32 context;
1028 };
1029
1030 /** \brief Get values of timeouts for NAT64 reply
1031     @param context - sender context, to match reply w/ request
1032     @param retval - return code
1033     @param udp - UDP timeout
1034     @param icmp - ICMP timeout
1035     @param tcp_trans - TCP transitory timeout
1036     @param tcp_est - TCP established timeout
1037     @param tcp_incoming_syn - TCP incoming SYN timeout
1038 */
1039 define nat64_get_timeouts_reply {
1040   u32 context;
1041   i32 retval;
1042   u32 udp;
1043   u32 icmp;
1044   u32 tcp_trans;
1045   u32 tcp_est;
1046   u32 tcp_incoming_syn;
1047 };
1048
1049 /** \brief Dump NAT64 session table
1050     @param client_index - opaque cookie to identify the sender
1051     @param context - sender context, to match reply w/ request
1052     @param proto - protocol of the session table: 255 - all STs
1053                                                   6 - TCP ST
1054                                                   17 - UDP ST
1055                                                   1/58 - ICMP ST
1056                                                   otherwise - "unknown" proto ST
1057 */
1058 define nat64_st_dump {
1059   u32 client_index;
1060   u32 context;
1061   u8 proto;
1062 };
1063
1064 /** \brief NAT64 session table details response
1065     @param context - sender context, to match reply w/ request
1066     @param il_addr - inside IPv6 address of the local host
1067     @param ol_addr - outside IPv4 address of the local host
1068     @param il_port - inside port number id of the local host/inside ICMP id
1069     @param ol_port - outside port number of the local host/outside ICMP id
1070     @param il_addr - inside IPv6 address of the remote host
1071     @param ol_addr - outside IPv4 address of the remote host
1072     @param l_port - port number of the remote host (not used for ICMP)
1073     @param vrf_id - VRF id of tenant
1074     @param proto - protocol number
1075 */
1076 define nat64_st_details {
1077   u32 context;
1078   u8 il_addr[16];
1079   u8 ol_addr[4];
1080   u16 il_port;
1081   u16 ol_port;
1082   u8 ir_addr[16];
1083   u8 or_addr[4];
1084   u16 r_port;
1085   u32 vrf_id;
1086   u8 proto;
1087 };
1088
1089 /** \brief Add/del NAT64 prefix
1090     @param client_index - opaque cookie to identify the sender
1091     @param context - sender context, to match reply w/ request
1092     @param prefix - NAT64 prefix
1093     @param prefix - NAT64 prefix length
1094     @param vrf_id - VRF id of tenant
1095     @param is_add - 1 if add, 0 if delete
1096 */
1097 autoreply define nat64_add_del_prefix {
1098   u32 client_index;
1099   u32 context;
1100   u8 prefix[16];
1101   u8 prefix_len;
1102   u32 vrf_id;
1103   u8 is_add;
1104 };
1105
1106 /** \brief Dump NAT64 prefix
1107     @param client_index - opaque cookie to identify the sender
1108     @param context - sender context, to match reply w/ request
1109 */
1110 define nat64_prefix_dump {
1111   u32 client_index;
1112   u32 context;
1113 };
1114
1115 /** \brief Dump NAT64 prefix details response
1116     @param context - sender context, to match reply w/ request
1117     @param prefix - NAT64 prefix
1118     @param prefix - NAT64 prefix length
1119     @param vrf_id - VRF id of tenant
1120 */
1121 define nat64_prefix_details {
1122   u32 context;
1123   u8 prefix[16];
1124   u8 prefix_len;
1125   u32 vrf_id;
1126 };
1127
1128 /** \brief Add/delete NAT64 pool address from specific interfce
1129     @param client_index - opaque cookie to identify the sender
1130     @param context - sender context, to match reply w/ request
1131     @param is_add - 1 if add, 0 if delete
1132     @param sw_if_index - software index of the interface
1133 */
1134 autoreply define nat64_add_del_interface_addr {
1135   u32 client_index;
1136   u32 context;
1137   u8 is_add;
1138   u8 is_inside;
1139   u32 sw_if_index;
1140 };
1141
1142
1143 /*
1144  * DS-Lite APIs
1145  */
1146
1147 /** \brief Add/delete address range to DS-Lite pool
1148     @param client_index - opaque cookie to identify the sender
1149     @param context - sender context, to match reply w/ request
1150     @param start_addr - start address of the range
1151     @param end_addr - end address of the range
1152     @param is_add - 1 if add, 0 if delete
1153 */
1154 autoreply define dslite_add_del_pool_addr_range {
1155   u32 client_index;
1156   u32 context;
1157   u8 start_addr[4];
1158   u8 end_addr[4];
1159   u8 is_add;
1160 };
1161
1162 autoreply define dslite_set_aftr_addr {
1163   u32 client_index;
1164   u32 context;
1165   u8 ip4_addr[4];
1166   u8 ip6_addr[16];
1167 };