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 option version = "2.4.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     @param out2in_only - if 1 rule match only out2in direction
 356     @param tag - opaque string tag
 357 */
 358 autoreply define nat44_add_del_static_mapping {
 359   u32 client_index;
 360   u32 context;
 361   u8 is_add;
 362   u8 addr_only;
 363   u8 local_ip_address[4];
 364   u8 external_ip_address[4];
 365   u8 protocol;
 366   u16 local_port;
 367   u16 external_port;
 368   u32 external_sw_if_index;
 369   u32 vrf_id;
 370   u8 twice_nat;
 371   u8 out2in_only;
 372   u8 tag[64];
 373 };
 374
 375 /** \brief Dump NAT44 static mappings
 376     @param client_index - opaque cookie to identify the sender
 377     @param context - sender context, to match reply w/ request
 378 */
 379 define nat44_static_mapping_dump {
 380   u32 client_index;
 381   u32 context;
 382 };
 383
 384 /** \brief NAT44 static mapping details response
 385     @param context - sender context, to match reply w/ request
 386     @param addr_only - 1 if address only mapping
 387     @param local_ip_address - local IPv4 address
 388     @param external_ip_address - external IPv4 address
 389     @param protocol - IP protocol
 390     @param local_port - local port number
 391     @param external_port - external port number
 392     @param external_sw_if_index - external interface
 393     @param vfr_id - VRF ID
 394     @param twice_nat - if 1 translate external host address and port
 395     @param out2in_only - if 1 rule match only out2in direction
 396     @param tag - opaque string tag
 397 */
 398 define nat44_static_mapping_details {
 399   u32 context;
 400   u8 addr_only;
 401   u8 local_ip_address[4];
 402   u8 external_ip_address[4];
 403   u8 protocol;
 404   u16 local_port;
 405   u16 external_port;
 406   u32 external_sw_if_index;
 407   u32 vrf_id;
 408   u8 twice_nat;
 409   u8 out2in_only;
 410   u8 tag[64];
 411 };
 412
 413 /** \brief Add/delete NAT44 identity mapping
 414     @param client_index - opaque cookie to identify the sender
 415     @param context - sender context, to match reply w/ request
 416     @param is_add - 1 if add, 0 if delete
 417     @param addr_only - 1 if address only mapping
 418     @param ip_address - IPv4 address
 419     @param protocol - IP protocol
 420     @param port - port number
 421     @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
 422                                     used)
 423     @param vfr_id - VRF ID (if ~0 use default VRF)
 424     @param tag - opaque string tag
 425 */
 426 autoreply define nat44_add_del_identity_mapping {
 427   u32 client_index;
 428   u32 context;
 429   u8 is_add;
 430   u8 addr_only;
 431   u8 ip_address[4];
 432   u8 protocol;
 433   u16 port;
 434   u32 sw_if_index;
 435   u32 vrf_id;
 436   u8 tag[64];
 437 };
 438
 439 /** \brief Dump NAT44 identity mappings
 440     @param client_index - opaque cookie to identify the sender
 441     @param context - sender context, to match reply w/ request
 442 */
 443 define nat44_identity_mapping_dump {
 444   u32 client_index;
 445   u32 context;
 446 };
 447
 448 /** \brief NAT44 identity mapping details response
 449     @param context - sender context, to match reply w/ request
 450     @param addr_only - 1 if address only mapping
 451     @param ip_address - IPv4 address
 452     @param protocol - IP protocol
 453     @param port - port number
 454     @param sw_if_index - interface
 455     @param vfr_id - VRF ID
 456     @param tag - opaque string tag
 457 */
 458 define nat44_identity_mapping_details {
 459   u32 context;
 460   u8 addr_only;
 461   u8 ip_address[4];
 462   u8 protocol;
 463   u16 port;
 464   u32 sw_if_index;
 465   u32 vrf_id;
 466   u8 tag[64];
 467 };
 468
 469 /** \brief Add/delete NAT44 pool address from specific interfce
 470     @param client_index - opaque cookie to identify the sender
 471     @param context - sender context, to match reply w/ request
 472     @param is_add - 1 if add, 0 if delete
 473     @param twice_nat - twice NAT address for extenal hosts
 474     @param sw_if_index - software index of the interface
 475 */
 476 autoreply define nat44_add_del_interface_addr {
 477   u32 client_index;
 478   u32 context;
 479   u8 is_add;
 480   u8 twice_nat;
 481   u32 sw_if_index;
 482 };
 483
 484 /** \brief Dump NAT44 pool addresses interfaces
 485     @param client_index - opaque cookie to identify the sender
 486     @param context - sender context, to match reply w/ request
 487 */
 488 define nat44_interface_addr_dump {
 489   u32 client_index;
 490   u32 context;
 491 };
 492
 493 /** \brief NAT44 pool addresses interfaces details response
 494     @param context - sender context, to match reply w/ request
 495     @param sw_if_index - software index of the interface
 496     @param twice_nat - twice NAT address for extenal hosts
 497 */
 498 define nat44_interface_addr_details {
 499   u32 context;
 500   u32 sw_if_index;
 501   u8 twice_nat;
 502 };
 503
 504 /** \brief Dump NAT44 users
 505     @param client_index - opaque cookie to identify the sender
 506     @param context - sender context, to match reply w/ request
 507 */
 508 define nat44_user_dump {
 509   u32 client_index;
 510   u32 context;
 511 };
 512
 513 /** \brief NAT44 users response
 514     @param context - sender context, to match reply w/ request
 515     @vrf_id - VRF ID
 516     @param ip_adress - IPv4 address
 517     @param nsessions - number of dynamic sessions
 518     @param nstaticsessions - number of static sessions
 519 */
 520 define nat44_user_details {
 521   u32 context;
 522   u32 vrf_id;
 523   u8 ip_address[4];
 524   u32 nsessions;
 525   u32 nstaticsessions;
 526 };
 527
 528 /** \brief NAT44 user's sessions
 529     @param client_index - opaque cookie to identify the sender
 530     @param context - sender context, to match reply w/ request
 531     @param is_ip4 - 1 if address type is IPv4
 532     @param user_ip - IP address of the user to dump
 533     @param vrf_id - VRF_ID
 534 */
 535 define nat44_user_session_dump {
 536   u32 client_index;
 537   u32 context;
 538   u8 ip_address[4];
 539   u32 vrf_id;
 540 };
 541
 542 /** \brief NAT44 user's sessions response
 543     @param context - sender context, to match reply w/ request
 544     @param outside_ip_address - outside IPv4 address
 545     @param outside_port - outside port
 546     @param inside_ip_address - inside IPv4 address
 547     @param inside_port - inside port
 548     @param protocol - protocol
 549     @param is_static - 1 if session is static
 550     @param last_heard - last heard timer
 551     @param total_bytes - count of bytes sent through session
 552     @param total_pkts - count of pakets sent through session
 553 */
 554 define nat44_user_session_details {
 555   u32 context;
 556   u8 outside_ip_address[4];
 557   u16 outside_port;
 558   u8 inside_ip_address[4];
 559   u16 inside_port;
 560   u16 protocol;
 561   u8 is_static;
 562   u64 last_heard;
 563   u64 total_bytes;
 564   u32 total_pkts;
 565 };
 566
 567 typeonly manual_endian define nat44_lb_addr_port {
 568   u8 addr[4];
 569   u16 port;
 570   u8 probability;
 571 };
 572
 573 autoreply manual_endian define nat44_add_del_lb_static_mapping {
 574   u32 client_index;
 575   u32 context;
 576   u8 is_add;
 577   u8 external_addr[4];
 578   u16 external_port;
 579   u8 protocol;
 580   u32 vrf_id;
 581   u8 twice_nat;
 582   u8 out2in_only;
 583   u8 tag[64];
 584   u8 local_num;
 585   vl_api_nat44_lb_addr_port_t locals[local_num];
 586 };
 587
 588 define nat44_lb_static_mapping_dump {
 589   u32 client_index;
 590   u32 context;
 591 };
 592
 593 manual_endian define nat44_lb_static_mapping_details {
 594   u32 context;
 595   u8 external_addr[4];
 596   u16 external_port;
 597   u8 protocol;
 598   u32 vrf_id;
 599   u8 twice_nat;
 600   u8 out2in_only;
 601   u8 tag[64];
 602   u8 local_num;
 603   vl_api_nat44_lb_addr_port_t locals[local_num];
 604 };
 605
 606 /** \brief Delete NAT44 session
 607     @param client_index - opaque cookie to identify the sender
 608     @param context - sender context, to match reply w/ request
 609     @param is_in - 1 if inside network addres and port pari, 0 if outside
 610     @param ip_address - IPv4 address
 611     @param protocol - IP protocol
 612     @param port - port number
 613     @param vfr_id - VRF ID
 614 */
 615 autoreply define nat44_del_session {
 616   u32 client_index;
 617   u32 context;
 618   u8 is_in;
 619   u8 address[4];
 620   u8 protocol;
 621   u16 port;
 622   u32 vrf_id;
 623 };
 624
 625 /** \brief Enable/disable forwarding for NAT44
 626     Forward packets which don't match existing translation
 627     or static mapping instead of dropping them.
 628     @param client_index - opaque cookie to identify the sender
 629     @param context - sender context, to match reply w/ request
 630     @param enable - 0 for enable, 1 for disable
 631 */
 632 autoreply define nat44_forwarding_enable_disable {
 633   u32 client_index;
 634   u32 context;
 635   u8 enable;
 636 };
 637
 638 /** \brief Check if forwarding is enabled or disabled
 639     @param client_index - opaque cookie to identify the sender
 640     @param context - sender context, to match reply w/ request
 641 */
 642 define nat44_forwarding_is_enabled {
 643   u32 client_index;
 644   u32 context;
 645 };
 646
 647 /** \brief Response to check if forwarding is enabled or disabled
 648     @param context - sender context, to match reply w/ request
 649     @param enabled - 1 if enabled, 0 if disabled
 650 */
 651 define nat44_forwarding_is_enabled_reply {
 652   u32 context;
 653   u8 enabled;
 654 };
 655
 656
 657 /*
 658  * Deterministic NAT (CGN) APIs
 659  */
 660
 661 /** \brief Add/delete NAT deterministic mapping
 662     @param client_index - opaque cookie to identify the sender
 663     @param context - sender context, to match reply w/ request
 664     @param is_add - 1 if add, 0 if delete
 665     @param is_nat44 - 1 if NAT44
 666     @param in_addr - inside IP address
 667     @param in_plen - inside IP address prefix length
 668     @param out_addr - outside IPv4 address
 669     @param out_addr - outside IPv4 address prefix length
 670 */
 671 autoreply define nat_det_add_del_map {
 672   u32 client_index;
 673   u32 context;
 674   u8 is_add;
 675   u8 is_nat44;
 676   u8 addr_only;
 677   u8 in_addr[16];
 678   u8 in_plen;
 679   u8 out_addr[4];
 680   u8 out_plen;
 681 };
 682
 683 /** \brief Get outside address and port range from inside address
 684     @param client_index - opaque cookie to identify the sender
 685     @param context - sender context, to match reply w/ request
 686     @param is_nat44 - 1 if NAT44
 687     @param in_addr - inside IP address
 688 */
 689 define nat_det_forward {
 690   u32 client_index;
 691   u32 context;
 692   u8 is_nat44;
 693   u8 in_addr[16];
 694 };
 695
 696 /** \brief Get outside address and port range from inside address
 697     @param context - sender context, to match reply w/ request
 698     @param retval - return code
 699     @param out_port_lo - outside port range start
 700     @param out_port_hi - outside port range end
 701     @param out_addr - outside IPv4 address
 702 */
 703 define nat_det_forward_reply {
 704   u32 context;
 705   i32 retval;
 706   u16 out_port_lo;
 707   u16 out_port_hi;
 708   u8 out_addr[4];
 709 };
 710
 711 /** \brief Get inside address from outside address and port
 712     @param client_index - opaque cookie to identify the sender
 713     @param context - sender context, to match reply w/ request
 714     @param out_port - outside port
 715     @param out_addr - outside IPv4 address
 716 */
 717 define nat_det_reverse {
 718   u32 client_index;
 719   u32 context;
 720   u16 out_port;
 721   u8 out_addr[4];
 722 };
 723
 724 /** \brief Get inside address from outside address and port reply
 725     @param context - sender context, to match reply w/ request
 726     @param retval - return code
 727     @param is_nat44 - 1 if NAT44
 728     @param in_addr - inside IP address
 729 */
 730 define nat_det_reverse_reply {
 731   u32 context;
 732   i32 retval;
 733   u8 is_nat44;
 734   u8 in_addr[16];
 735 };
 736
 737 /** \brief Dump NAT deterministic mappings
 738     @param client_index - opaque cookie to identify the sender
 739     @param context - sender context, to match reply w/ request
 740 */
 741 define nat_det_map_dump {
 742   u32 client_index;
 743   u32 context;
 744 };
 745
 746 /** \brief NAT users response
 747     @param context - sender context, to match reply w/ request
 748     @param is_nat44 - 1 if NAT44
 749     @param in_addr - inside IP address
 750     @param in_plen - inside IP address prefix length
 751     @param out_addr - outside IPv4 address
 752     @param out_plen - outside IPv4 address prefix length
 753     @param sharing_ratio - outside to inside address sharing ratio
 754     @param ports_per_host - number of ports available to a host
 755     @param ses_num - number of sessions belonging to this mapping
 756 */
 757 define nat_det_map_details {
 758   u32 context;
 759   u8 is_nat44;
 760   u8 in_addr[16];
 761   u8 in_plen;
 762   u8 out_addr[4];
 763   u8 out_plen;
 764   u32 sharing_ratio;
 765   u16 ports_per_host;
 766   u32 ses_num;
 767 };
 768
 769 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
 770     @param client_index - opaque cookie to identify the sender
 771     @param context - sender context, to match reply w/ request
 772     @param udp - UDP timeout (default 300sec)
 773     @param tcp_established - TCP established timeout (default 7440sec)
 774     @param tcp_transitory - TCP transitory timeout (default 240sec)
 775     @param icmp - ICMP timeout (default 60sec)
 776 */
 777 autoreply define nat_det_set_timeouts {
 778   u32 client_index;
 779   u32 context;
 780   u32 udp;
 781   u32 tcp_established;
 782   u32 tcp_transitory;
 783   u32 icmp;
 784 };
 785
 786 /** \brief Get values of timeouts for deterministic NAT (seconds)
 787     @param client_index - opaque cookie to identify the sender
 788     @param context - sender context, to match reply w/ request
 789 */
 790 define nat_det_get_timeouts {
 791   u32 client_index;
 792   u32 context;
 793 };
 794
 795 /** \brief Get values of timeouts for deterministic NAT reply
 796     @param context - sender context, to match reply w/ request
 797     @param retval - return code
 798     @param udp - UDP timeout (default 300sec)
 799     @param tcp_established - TCP established timeout (default 7440sec)
 800     @param tcp_transitory - TCP transitory timeout (default 240sec)
 801     @param icmp - ICMP timeout (default 60sec)
 802 */
 803 define nat_det_get_timeouts_reply {
 804   u32 context;
 805   i32 retval;
 806   u32 udp;
 807   u32 tcp_established;
 808   u32 tcp_transitory;
 809   u32 icmp;
 810 };
 811
 812 /** \brief Close deterministic NAT session by outside address and port
 813     @param client_index - opaque cookie to identify the sender
 814     @param context - sender context, to match reply w/ request
 815     @param out_addr - outside IPv4 address
 816     @param out_port - outside port
 817     @param ext_addr - external host IPv4 address
 818     @param ext_port - external host port
 819 */
 820 autoreply define nat_det_close_session_out {
 821   u32 client_index;
 822   u32 context;
 823   u8 out_addr[4];
 824   u16 out_port;
 825   u8 ext_addr[4];
 826   u16 ext_port;
 827 };
 828
 829 /** \brief Close deterministic NAT session by inside address and port
 830     @param client_index - opaque cookie to identify the sender
 831     @param context - sender context, to match reply w/ request
 832     @param is_nat44 - 1 if NAT44
 833     @param in_addr - inside IP address
 834     @param in_port - inside port
 835     @param ext_addr - external host IP address
 836     @param ext_port - external host port
 837 */
 838 autoreply define nat_det_close_session_in {
 839   u32 client_index;
 840   u32 context;
 841   u8 is_nat44;
 842   u8 in_addr[16];
 843   u16 in_port;
 844   u8 ext_addr[16];
 845   u16 ext_port;
 846 };
 847
 848 /** \brief Dump determinstic NAT sessions
 849     @param client_index - opaque cookie to identify the sender
 850     @param context - sender context, to match reply w/ request
 851     @param is_nat44 - 1 if NAT44
 852     @param user_addr - address of an inside user whose sessions to dump
 853 */
 854 define nat_det_session_dump {
 855   u32 client_index;
 856   u32 context;
 857   u8 is_nat44;
 858   u8 user_addr[16];
 859 };
 860
 861 /** \brief Deterministic NAT sessions reply
 862     @param context - sender context, to match reply w/ request
 863     @param in_port - inside port
 864     @param ext_addr - external host address
 865     @param ext_port - external host port
 866     @param out_port - outside NAT port
 867     @param state - session state
 868     @param expire - session expiration timestamp
 869 */
 870 define nat_det_session_details {
 871   u32 client_index;
 872   u32 context;
 873   u16 in_port;
 874   u8 ext_addr[4];
 875   u16 ext_port;
 876   u16 out_port;
 877   u8 state;
 878   u32 expire;
 879 };
 880
 881 /*
 882  * NAT64 APIs
 883  */
 884
 885 /** \brief Add/delete address range to NAT64 pool
 886     @param client_index - opaque cookie to identify the sender
 887     @param context - sender context, to match reply w/ request
 888     @param start_addr - start address of the range
 889     @param end_addr - end address of the range
 890     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 891     @param is_add - 1 if add, 0 if delete
 892 */
 893 autoreply define nat64_add_del_pool_addr_range {
 894   u32 client_index;
 895   u32 context;
 896   u8 start_addr[4];
 897   u8 end_addr[4];
 898   u32 vrf_id;
 899   u8 is_add;
 900 };
 901
 902 /** \brief Dump NAT64 pool addresses
 903     @param client_index - opaque cookie to identify the sender
 904     @param context - sender context, to match reply w/ request
 905 */
 906 define nat64_pool_addr_dump {
 907   u32 client_index;
 908   u32 context;
 909 };
 910
 911 /** \brief NAT64 pool address details response
 912     @param context - sender context, to match reply w/ request
 913     @param address - IPv4 address
 914     @param vfr_id - VRF id of tenant, ~0 means independent of VRF
 915 */
 916 define nat64_pool_addr_details {
 917   u32 context;
 918   u8 address[4];
 919   u32 vrf_id;
 920 };
 921
 922 /** \brief Enable/disable NAT64 feature on the interface
 923     @param client_index - opaque cookie to identify the sender
 924     @param context - sender context, to match reply w/ request
 925     @param sw_if_index - index of the interface
 926     @param is_inside - 1 if inside, 0 if outside
 927     @param is_add - 1 if add, 0 if delete
 928 */
 929 autoreply define nat64_add_del_interface {
 930   u32 client_index;
 931   u32 context;
 932   u32 sw_if_index;
 933   u8 is_inside;
 934   u8 is_add;
 935 };
 936
 937 /** \brief Dump interfaces with NAT64 feature
 938     @param client_index - opaque cookie to identify the sender
 939     @param context - sender context, to match reply w/ request
 940 */
 941 define nat64_interface_dump {
 942   u32 client_index;
 943   u32 context;
 944 };
 945
 946 /** \brief NAT64 interface details response
 947     @param context - sender context, to match reply w/ request
 948     @param is_inside - 1 if inside, 0 if outside
 949     @param sw_if_index - index of the interface
 950 */
 951 define nat64_interface_details {
 952   u32 context;
 953   u8 is_inside;
 954   u32 sw_if_index;
 955 };
 956
 957 /** \brief Add/delete NAT64 static BIB entry
 958     @param client_index - opaque cookie to identify the sender
 959     @param context - sender context, to match reply w/ request
 960     @param i_addr - inside IPv6 address
 961     @param o_addr - outside IPv4 address
 962     @param i_port - inside port number
 963     @param o_port - outside port number
 964     @param vrf_id - VRF id of tenant
 965     @param proto - protocol number
 966     @param is_add - 1 if add, 0 if delete
 967 */
 968  autoreply define nat64_add_del_static_bib {
 969   u32 client_index;
 970   u32 context;
 971   u8 i_addr[16];
 972   u8 o_addr[4];
 973   u16 i_port;
 974   u16 o_port;
 975   u32 vrf_id;
 976   u8 proto;
 977   u8 is_add;
 978 };
 979
 980 /** \brief Dump NAT64 BIB
 981     @param client_index - opaque cookie to identify the sender
 982     @param context - sender context, to match reply w/ request
 983     @param proto - protocol of the BIB: 255 - all BIBs
 984                                         6 - TCP BIB
 985                                         17 - UDP BIB
 986                                         1/58 - ICMP BIB
 987                                         otherwise - "unknown" protocol BIB
 988 */
 989 define nat64_bib_dump {
 990   u32 client_index;
 991   u32 context;
 992   u8 proto;
 993 };
 994
 995 /** \brief NAT64 BIB details response
 996     @param context - sender context, to match reply w/ request
 997     @param i_addr - inside IPv6 address
 998     @param o_addr - outside IPv4 address
 999     @param i_port - inside port number
1000     @param o_port - outside port number
1001     @param vrf_id - VRF id of tenant
1002     @param proto - protocol number
1003     @param is_static - 1 if static BIB entry, 0 if dynamic
1004     @param ses_num - number of sessions associated with the BIB entry
1005 */
1006 define nat64_bib_details {
1007   u32 context;
1008   u8 i_addr[16];
1009   u8 o_addr[4];
1010   u16 i_port;
1011   u16 o_port;
1012   u32 vrf_id;
1013   u8 proto;
1014   u8 is_static;
1015   u32 ses_num;
1016 };
1017
1018 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1019     @param client_index - opaque cookie to identify the sender
1020     @param context - sender context, to match reply w/ request
1021     @param udp - UDP timeout (default 300sec)
1022     @param icmp - ICMP timeout (default 60sec)
1023     @param tcp_trans - TCP transitory timeout (default 240sec)
1024     @param tcp_est - TCP established timeout (default 7440sec)
1025     @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1026 */
1027 autoreply define nat64_set_timeouts {
1028   u32 client_index;
1029   u32 context;
1030   u32 udp;
1031   u32 icmp;
1032   u32 tcp_trans;
1033   u32 tcp_est;
1034   u32 tcp_incoming_syn;
1035 };
1036
1037 /** \brief Get values of timeouts for NAT64 (seconds)
1038     @param client_index - opaque cookie to identify the sender
1039     @param context - sender context, to match reply w/ request
1040 */
1041 define nat64_get_timeouts {
1042   u32 client_index;
1043   u32 context;
1044 };
1045
1046 /** \brief Get values of timeouts for NAT64 reply
1047     @param context - sender context, to match reply w/ request
1048     @param retval - return code
1049     @param udp - UDP timeout
1050     @param icmp - ICMP timeout
1051     @param tcp_trans - TCP transitory timeout
1052     @param tcp_est - TCP established timeout
1053     @param tcp_incoming_syn - TCP incoming SYN timeout
1054 */
1055 define nat64_get_timeouts_reply {
1056   u32 context;
1057   i32 retval;
1058   u32 udp;
1059   u32 icmp;
1060   u32 tcp_trans;
1061   u32 tcp_est;
1062   u32 tcp_incoming_syn;
1063 };
1064
1065 /** \brief Dump NAT64 session table
1066     @param client_index - opaque cookie to identify the sender
1067     @param context - sender context, to match reply w/ request
1068     @param proto - protocol of the session table: 255 - all STs
1069                                                   6 - TCP ST
1070                                                   17 - UDP ST
1071                                                   1/58 - ICMP ST
1072                                                   otherwise - "unknown" proto ST
1073 */
1074 define nat64_st_dump {
1075   u32 client_index;
1076   u32 context;
1077   u8 proto;
1078 };
1079
1080 /** \brief NAT64 session table details response
1081     @param context - sender context, to match reply w/ request
1082     @param il_addr - inside IPv6 address of the local host
1083     @param ol_addr - outside IPv4 address of the local host
1084     @param il_port - inside port number id of the local host/inside ICMP id
1085     @param ol_port - outside port number of the local host/outside ICMP id
1086     @param il_addr - inside IPv6 address of the remote host
1087     @param ol_addr - outside IPv4 address of the remote host
1088     @param l_port - port number of the remote host (not used for ICMP)
1089     @param vrf_id - VRF id of tenant
1090     @param proto - protocol number
1091 */
1092 define nat64_st_details {
1093   u32 context;
1094   u8 il_addr[16];
1095   u8 ol_addr[4];
1096   u16 il_port;
1097   u16 ol_port;
1098   u8 ir_addr[16];
1099   u8 or_addr[4];
1100   u16 r_port;
1101   u32 vrf_id;
1102   u8 proto;
1103 };
1104
1105 /** \brief Add/del NAT64 prefix
1106     @param client_index - opaque cookie to identify the sender
1107     @param context - sender context, to match reply w/ request
1108     @param prefix - NAT64 prefix
1109     @param prefix - NAT64 prefix length
1110     @param vrf_id - VRF id of tenant
1111     @param is_add - 1 if add, 0 if delete
1112 */
1113 autoreply define nat64_add_del_prefix {
1114   u32 client_index;
1115   u32 context;
1116   u8 prefix[16];
1117   u8 prefix_len;
1118   u32 vrf_id;
1119   u8 is_add;
1120 };
1121
1122 /** \brief Dump NAT64 prefix
1123     @param client_index - opaque cookie to identify the sender
1124     @param context - sender context, to match reply w/ request
1125 */
1126 define nat64_prefix_dump {
1127   u32 client_index;
1128   u32 context;
1129 };
1130
1131 /** \brief Dump NAT64 prefix details response
1132     @param context - sender context, to match reply w/ request
1133     @param prefix - NAT64 prefix
1134     @param prefix - NAT64 prefix length
1135     @param vrf_id - VRF id of tenant
1136 */
1137 define nat64_prefix_details {
1138   u32 context;
1139   u8 prefix[16];
1140   u8 prefix_len;
1141   u32 vrf_id;
1142 };
1143
1144 /** \brief Add/delete NAT64 pool address from specific interfce
1145     @param client_index - opaque cookie to identify the sender
1146     @param context - sender context, to match reply w/ request
1147     @param is_add - 1 if add, 0 if delete
1148     @param sw_if_index - software index of the interface
1149 */
1150 autoreply define nat64_add_del_interface_addr {
1151   u32 client_index;
1152   u32 context;
1153   u8 is_add;
1154   u8 is_inside;
1155   u32 sw_if_index;
1156 };
1157
1158
1159 /*
1160  * DS-Lite APIs
1161  */
1162
1163 /** \brief Add/delete address range to DS-Lite pool
1164     @param client_index - opaque cookie to identify the sender
1165     @param context - sender context, to match reply w/ request
1166     @param start_addr - start address of the range
1167     @param end_addr - end address of the range
1168     @param is_add - 1 if add, 0 if delete
1169 */
1170 autoreply define dslite_add_del_pool_addr_range {
1171   u32 client_index;
1172   u32 context;
1173   u8 start_addr[4];
1174   u8 end_addr[4];
1175   u8 is_add;
1176 };
1177
1178 /** \brief Set AFTR IPv6 and IPv4 addresses
1179     @param client_index - opaque cookie to identify the sender
1180     @param context - sender context, to match reply w/ request
1181     @param ip4_addr - IPv4 address
1182     @param ip6_addr - IP64 address
1183 */
1184 autoreply define dslite_set_aftr_addr {
1185   u32 client_index;
1186   u32 context;
1187   u8 ip4_addr[4];
1188   u8 ip6_addr[16];
1189 };
1190
1191 /** \brief Get AFTR IPv6 and IPv4 addresses
1192     @param client_index - opaque cookie to identify the sender
1193     @param context - sender context, to match reply w/ request
1194 */
1195 define dslite_get_aftr_addr {
1196   u32 client_index;
1197   u32 context;
1198 };
1199
1200 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1201     @param context - sender context, to match reply w/ request
1202     @param retval - return code
1203     @param ip4_addr - IPv4 address
1204     @param ip6_addr - IP64 address
1205 */
1206 define dslite_get_aftr_addr_reply {
1207   u32 context;
1208   i32 retval;
1209   u8 ip4_addr[4];
1210   u8 ip6_addr[16];
1211 };
1212
1213 /** \brief Set B4 IPv6 and IPv4 addresses
1214     @param client_index - opaque cookie to identify the sender
1215     @param context - sender context, to match reply w/ request
1216     @param ip4_addr - IPv4 address
1217     @param ip6_addr - IP64 address
1218 */
1219 autoreply define dslite_set_b4_addr {
1220   u32 client_index;
1221   u32 context;
1222   u8 ip4_addr[4];
1223   u8 ip6_addr[16];
1224 };
1225
1226 /** \brief Get B4 IPv6 and IPv4 addresses
1227     @param client_index - opaque cookie to identify the sender
1228     @param context - sender context, to match reply w/ request
1229 */
1230 define dslite_get_b4_addr {
1231   u32 client_index;
1232   u32 context;
1233 };
1234
1235 /** \brief Response to get B4 IPv6 and IPv4 addresses
1236     @param context - sender context, to match reply w/ request
1237     @param retval - return code
1238     @param ip4_addr - IPv4 address
1239     @param ip6_addr - IP64 address
1240 */
1241 define dslite_get_b4_addr_reply {
1242   u32 context;
1243   i32 retval;
1244   u8 ip4_addr[4];
1245   u8 ip6_addr[16];
1246 };