vpp/vpp-api/vpe.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2015 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /** \file
  18
  19     This file defines vpe control-plane API messages which are generally
  20     called through a shared memory interface.
  21 */
  22
  23
  24 /** \brief Register for interface events
  25     @param client_index - opaque cookie to identify the sender
  26     @param context - sender context, to match reply w/ request
  27     @param enable_disable - 1 => register for events, 0 => cancel registration
  28     @param pid - sender's pid
  29 */
  30 define want_interface_events {
  31     u32 client_index;
  32     u32 context;
  33     u32 enable_disable;
  34     u32 pid;
  35 };
  36
  37 /** \brief Reply for interface events registration
  38     @param context - returned sender context, to match reply w/ request
  39     @param retval - return code
  40 */
  41 define want_interface_events_reply {
  42     u32 context;
  43     i32 retval;
  44 };
  45
  46 /** \brief Interface details structure (fix this)
  47     @param sw_if_index - index of the interface
  48     @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
  49     @param l2_address_length - length of the interface's l2 address
  50     @param pid - the interface's l2 address
  51     @param interface_name - name of the interface
  52     @param link_duplex - 1 if half duplex, 2 if full duplex
  53     @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
  54     @param link_MTU - max. transmittion unit
  55     @param sub_if_id - A number 0-N to uniquely identify this subif on super if
  56     @param sub_dot1ad -  0 = dot1q, 1=dot1ad
  57     @param sub_number_of_tags - Number of tags (0 - 2)
  58     @param sub_outer_vlan_id
  59     @param sub_inner_vlan_id
  60     @param sub_exact_match
  61     @param sub_default
  62     @param sub_outer_vlan_id_any
  63     @param sub_inner_vlan_id_any
  64     @param vtr_op - vlan tag rewrite operation
  65     @param vtr_push_dot1q
  66     @param vtr_tag1
  67     @param vtr_tag2
  68 */
  69 manual_java define sw_interface_details {
  70     u32 context;
  71     u32 sw_if_index;
  72
  73     /* index of sup interface (e.g. hw interface).
  74        equal to sw_if_index for super hw interface. */
  75     u32 sup_sw_if_index;
  76
  77     /* Layer 2 address, if applicable */
  78     u32 l2_address_length;
  79     u8 l2_address[8];
  80
  81     /* Interface name */
  82     u8 interface_name[64];
  83
  84     /* 1 = up, 0 = down */
  85     u8 admin_up_down;
  86     u8 link_up_down;
  87
  88     /* 1 = half duplex, 2 = full duplex */
  89     u8 link_duplex;
  90
  91     /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
  92     u8 link_speed;
  93
  94     /* MTU */
  95     u16 link_mtu;
  96
  97     /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface*/
  98     u32 sub_id;
  99
 100     /* 0 = dot1q, 1=dot1ad */
 101     u8 sub_dot1ad;
 102
 103     /* Number of tags 0-2 */
 104     u8 sub_number_of_tags;
 105     u16 sub_outer_vlan_id;
 106     u16 sub_inner_vlan_id;
 107     u8 sub_exact_match;
 108     u8 sub_default;
 109     u8 sub_outer_vlan_id_any;
 110     u8 sub_inner_vlan_id_any;
 111
 112     /* vlan tag rewrite state */
 113     u32 vtr_op;
 114     u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
 115     u32 vtr_tag1;       // first pushed tag
 116     u32 vtr_tag2;       // second pushed tag
 117 };
 118
 119 /** \brief Set flags on the interface
 120     @param client_index - opaque cookie to identify the sender
 121     @param context - sender context, to match reply w/ request
 122     @param sw_if_index - index of the interface to set flags on
 123     @param admin_up_down - set the admin state, 1 = up, 0 = down
 124     @param link_up_down - Oper state sent on change event, not used in config.
 125     @param deleted - interface was deleted
 126 */
 127 define sw_interface_set_flags {
 128     u32 client_index;
 129     u32 context;
 130     u32 sw_if_index;
 131     /* 1 = up, 0 = down */
 132     u8 admin_up_down;
 133     u8 link_up_down;
 134     u8 deleted;
 135 };
 136
 137 /** \brief Reply to sw_interface_set_flags
 138     @param context - sender context which was passed in the request
 139     @param retval - return code of the set flags request
 140 */
 141 define sw_interface_set_flags_reply {
 142     u32 context;
 143     i32 retval;
 144 };
 145
 146 /* works */
 147 manual_java define sw_interface_dump {
 148     u32 client_index;
 149     u32 context;
 150     u8 name_filter_valid;
 151     u8 name_filter[49];
 152 };
 153
 154 /** \brief Set or delete one or all ip addresses on a specified interface
 155     @param client_index - opaque cookie to identify the sender
 156     @param context - sender context, to match reply w/ request
 157     @param sw_if_index - index of the interface to add/del addresses
 158     @param is_add - add address if non-zero, else delete
 159     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
 160     @param del_all - if non-zero delete all addresses on the interface
 161     @param address_length - address length in bytes, 4 for ip4, 16 for ip6
 162     @param address - array of address bytes
 163 */
 164 define sw_interface_add_del_address {
 165     u32 client_index;
 166     u32 context;
 167     u32 sw_if_index;
 168     u8 is_add;
 169     u8 is_ipv6;
 170     u8 del_all;
 171     u8 address_length;
 172     u8 address[16];
 173 };
 174
 175 /** \brief Reply for interface events registration
 176     @param context - returned sender context, to match reply w/ request
 177     @param retval - return code
 178 */
 179 define sw_interface_add_del_address_reply {
 180     u32 context;
 181     i32 retval;
 182 };
 183
 184 /** \brief Associate the specified interface with a fib table
 185     @param client_index - opaque cookie to identify the sender
 186     @param context - sender context, to match reply w/ request
 187     @param sw_if_index - index of the interface
 188     @param is_ipv6 - if non-zero ipv6, else ipv4
 189     @param vrf_id - fib table/vrd id to associate the interface with
 190 */
 191 define sw_interface_set_table {
 192     u32 client_index;
 193     u32 context;
 194     u32 sw_if_index;
 195     u8 is_ipv6;
 196     u32 vrf_id;
 197 };
 198
 199 /** \brief Reply for interface events registration
 200     @param context - returned sender context, to match reply w/ request
 201     @param retval - return code
 202 */
 203 define sw_interface_set_table_reply {
 204     u32 context;
 205     i32 retval;
 206 };
 207
 208 /** \brief Initialize a new tap interface with the given paramters
 209     @param client_index - opaque cookie to identify the sender
 210     @param context - sender context, to match reply w/ request
 211     @param use_random_mac - let the system generate a unique mac address
 212     @param tap_name - name to associate with the new interface
 213     @param mac_address - mac addr to assign to the interface if use_radom not set
 214 */
 215 define tap_connect {
 216     u32 client_index;
 217     u32 context;
 218     u8 use_random_mac;
 219     u8 tap_name [64];
 220     u8 mac_address[6];
 221     u8 renumber;
 222     u32 custom_dev_instance;
 223 };
 224
 225 /** \brief Reply for tap connect request
 226     @param context - returned sender context, to match reply w/ request
 227     @param retval - return code
 228     @param sw_if_index - software index allocated for the new tap interface
 229 */
 230 define tap_connect_reply {
 231     u32 context;
 232     i32 retval;
 233     u32 sw_if_index;
 234 };
 235
 236 /** \brief Modify a tap interface with the given paramters
 237     @param client_index - opaque cookie to identify the sender
 238     @param context - sender context, to match reply w/ request
 239     @param sw_if_index - interface index of existing tap interface
 240     @param use_random_mac - let the system generate a unique mac address
 241     @param tap_name - name to associate with the new interface
 242     @param mac_address - mac addr to assign to the interface if use_radom not set
 243 */
 244 define tap_modify {
 245     u32 client_index;
 246     u32 context;
 247     u32 sw_if_index;
 248     u8 use_random_mac;
 249     u8 tap_name [64];
 250     u8 mac_address[6];
 251     u8 renumber;
 252     u32 custom_dev_instance;
 253 };
 254
 255 /** \brief Reply for tap modify request
 256     @param context - returned sender context, to match reply w/ request
 257     @param retval - return code
 258     @param sw_if_index - software index if the modified tap interface
 259 */
 260 define tap_modify_reply {
 261     u32 context;
 262     i32 retval;
 263     u32 sw_if_index;
 264 };
 265
 266 /** \brief Delete tap interface
 267     @param client_index - opaque cookie to identify the sender
 268     @param context - sender context, to match reply w/ request
 269     @param sw_if_index - interface index of existing tap interface
 270 */
 271 define tap_delete {
 272     u32 client_index;
 273     u32 context;
 274     u32 sw_if_index;
 275 };
 276
 277 /** \brief Reply for tap delete request
 278     @param context - returned sender context, to match reply w/ request
 279     @param retval - return code
 280 */
 281 define tap_delete_reply {
 282     u32 context;
 283     i32 retval;
 284 };
 285
 286 /** \brief Dump tap interfaces request */
 287 define sw_interface_tap_dump {
 288     u32 client_index;
 289     u32 context;
 290 };
 291
 292 /** \brief Reply for tap dump request
 293     @param sw_if_index - software index of tap interface
 294     @param dev_name - Linux tap device name
 295 */
 296 manual_java define sw_interface_tap_details {
 297     u32 context;
 298     u32 sw_if_index;
 299     u8 dev_name[64];
 300 };
 301
 302 /** \brief Create a new subinterface with the given vlan id
 303     @param client_index - opaque cookie to identify the sender
 304     @param context - sender context, to match reply w/ request
 305     @param sw_if_index - software index of the new vlan's parent interface
 306     @param vlan_id - vlan tag of the new interface
 307 */
 308 define create_vlan_subif {
 309     u32 client_index;
 310     u32 context;
 311     u32 sw_if_index;
 312     u32 vlan_id;
 313 };
 314
 315 /** \brief Reply for the vlan subinterface create request
 316     @param context - returned sender context, to match reply w/ request
 317     @param retval - return code
 318     @param sw_if_index - software index allocated for the new subinterface
 319 */
 320 define create_vlan_subif_reply {
 321     u32 context;
 322     i32 retval;
 323     u32 sw_if_index;
 324 };
 325
 326 /** \brief Add / del route request
 327     @param client_index - opaque cookie to identify the sender
 328     @param context - sender context, to match reply w/ request
 329     @param sw_if_index - software index of the new vlan's parent interface
 330     @param vrf_id - fib table /vrf associated with the route
 331     @param lookup_in_vrf -
 332     @param resolve_attempts -
 333     @param classify_table_index -
 334     @param create_vrf_if_needed -
 335     @param resolve_if_needed -
 336     @param is_add - 1 if adding the route, 0 if deleting
 337     @param is_drop -
 338     @param is_ipv6 - 0 if an ip4 route, else ip6
 339     @param is_local -
 340     @param is_classify -
 341     @param is_multipath - Set to 1 if this is a multipath route, else 0
 342     @param not_last - Is last or not last msg in group of multiple add/del msgs
 343     @param next_hop_weight -
 344     @param dst_address_length -
 345     @param dst_address[16] -
 346     @param next_hop_address[16] -
 347 */
 348 define ip_add_del_route {
 349     u32 client_index;
 350     u32 context;
 351     u32 next_hop_sw_if_index;
 352     u32 vrf_id;
 353     u32 lookup_in_vrf;
 354     u32 resolve_attempts;
 355     u32 classify_table_index;
 356     u8 create_vrf_if_needed;
 357     u8 resolve_if_needed;
 358     u8 is_add;
 359     u8 is_drop;
 360     u8 is_ipv6;
 361     u8 is_local;
 362     u8 is_classify;
 363     /* Is last/not-last message in group of multiple add/del messages. */
 364     u8 is_multipath;
 365     u8 not_last;
 366     u8 next_hop_weight;
 367     u8 dst_address_length;
 368     u8 dst_address[16];
 369     u8 next_hop_address[16];
 370 };
 371
 372 /** \brief Reply for add / del route request
 373     @param context - returned sender context, to match reply w/ request
 374     @param retval - return code
 375 */
 376 define ip_add_del_route_reply {
 377     u32 context;
 378     i32 retval;
 379 };
 380
 381 /* works */
 382 /** \brief Add / del gre tunnel request
 383     @param client_index - opaque cookie to identify the sender
 384     @param context - sender context, to match reply w/ request
 385     @param sw_if_index - software index of the new vlan's parent interface
 386     @param inner_vrf_id -
 387     @param outer_vrf_id -
 388     @param is_add - 1 if adding the tunnel, 0 if deleting
 389     @param src_address[4] - tunnel source address
 390     @param dst_address[4] - tunnel destination address
 391     @param intf_address -
 392     @param intf_address_length -
 393 */
 394 define mpls_gre_add_del_tunnel {
 395     u32 client_index;
 396     u32 context;
 397     u32 inner_vrf_id;
 398     u32 outer_vrf_id;
 399     u8 is_add;
 400     u8 l2_only;
 401     u8 src_address[4];
 402     u8 dst_address[4];
 403     u8 intfc_address[4];
 404     u8 intfc_address_length;
 405 };
 406
 407 /** \brief Reply for add / del tunnel request
 408     @param context - returned sender context, to match reply w/ request
 409     @param retval - return code
 410 */
 411 define mpls_gre_add_del_tunnel_reply {
 412     u32 context;
 413     i32 retval;
 414     u32 tunnel_sw_if_index;
 415 };
 416
 417 /** \brief Add / del MPLS encapsulation request
 418     @param client_index - opaque cookie to identify the sender
 419     @param context - sender context, to match reply w/ request
 420     @param vrf_id - vrf id
 421     @param dst_address[4] -
 422     @param is_add - 1 if adding the encap, 0 if deleting
 423     @param nlabels - number of labels
 424     @param labels - array of labels
 425 */
 426 define mpls_add_del_encap {
 427     u32 client_index;
 428     u32 context;
 429     u32 vrf_id;
 430     u8 dst_address[4];
 431     /* 1 = add, 0 = delete */
 432     u8 is_add;
 433     u8 nlabels;
 434     u32 labels[0];
 435 };
 436
 437 /** \brief Reply for add / del encapsulation request
 438     @param context - returned sender context, to match reply w/ request
 439     @param retval - return code
 440 */
 441 define mpls_add_del_encap_reply {
 442     u32 context;
 443     i32 retval;
 444 };
 445
 446 /** \brief Add / del MPLS decapsulation request
 447     @param client_index - opaque cookie to identify the sender
 448     @param context - sender context, to match reply w/ request
 449     @param rx_vrf_id - receive vrf
 450     @param tx_vrf_id - transmit vrf
 451     @param label -
 452     @param next_index -
 453     @param s_bit -
 454     @param is_add - 1 if adding the encap, 0 if deleting
 455 */
 456 define mpls_add_del_decap {
 457     u32 client_index;
 458     u32 context;
 459     u32 rx_vrf_id;
 460     u32 tx_vrf_id;
 461     u32 label;
 462     u32 next_index;
 463     u8 s_bit;
 464     u8 is_add;
 465 };
 466
 467 /** \brief Reply for MPLS decap add / del request
 468     @param context - returned sender context, to match reply w/ request
 469     @param retval - return code
 470 */
 471 define mpls_add_del_decap_reply {
 472     u32 context;
 473     i32 retval;
 474 };
 475
 476 /** \brief Proxy ARP add / del request
 477     @param client_index - opaque cookie to identify the sender
 478     @param context - sender context, to match reply w/ request
 479     @param vrf_id - VRF / Fib table ID
 480     @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
 481     @param low_address[4] - Low address of the Proxy ARP range
 482     @param hi_address[4] - High address of the Proxy ARP range
 483 */
 484 define proxy_arp_add_del {
 485     u32 client_index;
 486     u32 context;
 487     u32 vrf_id;
 488     u8 is_add;
 489     u8 low_address[4];
 490     u8 hi_address[4];
 491 };
 492
 493 /** \brief Reply for proxy arp add / del request
 494     @param context - returned sender context, to match reply w/ request
 495     @param retval - return code
 496 */
 497 define proxy_arp_add_del_reply {
 498     u32 context;
 499     i32 retval;
 500 };
 501
 502 /** \brief Proxy ARP add / del request
 503     @param client_index - opaque cookie to identify the sender
 504     @param context - sender context, to match reply w/ request
 505     @param sw_if_index - Which interface to enable / disable Proxy Arp on
 506     @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
 507 */
 508 define proxy_arp_intfc_enable_disable {
 509     u32 client_index;
 510     u32 context;
 511     u32 sw_if_index;
 512     /* 1 = on, 0 = off */
 513     u8 enable_disable;
 514 };
 515
 516 /** \brief Reply for Proxy ARP interface enable / disable request
 517     @param context - returned sender context, to match reply w/ request
 518     @param retval - return code
 519 */
 520 define proxy_arp_intfc_enable_disable_reply {
 521     u32 context;
 522     i32 retval;
 523 };
 524
 525 /** \brief IP neighbor add / del request
 526     @param client_index - opaque cookie to identify the sender
 527     @param context - sender context, to match reply w/ request
 528     @param vrf_id - vrf_id, only for IP4
 529     @param sw_if_index - interface used to reach neighbor
 530     @param is_add - 1 to add neighbor, 0 to delete
 531     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 532     @param is_static -
 533     @param mac_address - l2 address of the neighbor
 534     @param dst_address - ip4 or ip6 address of the neighbor
 535 */
 536 define ip_neighbor_add_del {
 537     u32 client_index;
 538     u32 context;
 539     u32 vrf_id;                 /* only makes sense for ip4 */
 540     u32 sw_if_index;
 541     /* 1 = add, 0 = delete */
 542     u8 is_add;
 543     u8 is_ipv6;
 544     u8 is_static;
 545     u8 mac_address[6];
 546     u8 dst_address[16];
 547 };
 548
 549 /** \brief Reply for IP Neighbor add / delete request
 550     @param context - returned sender context, to match reply w/ request
 551     @param retval - return code
 552 */
 553 define ip_neighbor_add_del_reply {
 554     u32 context;
 555     i32 retval;
 556 };
 557
 558 /** \brief Reset VRF (remove all routes etc) request
 559     @param client_index - opaque cookie to identify the sender
 560     @param context - sender context, to match reply w/ request
 561     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 562     @param vrf_id - ID of th FIB table / VRF to reset
 563 */
 564 define reset_vrf {
 565     u32 client_index;
 566     u32 context;
 567     u8 is_ipv6;
 568     u32 vrf_id;
 569 };
 570
 571 /** \brief Reply for Reset VRF request
 572     @param context - returned sender context, to match reply w/ request
 573     @param retval - return code
 574 */
 575 define reset_vrf_reply {
 576     u32 context;
 577     i32 retval;
 578 };
 579
 580 /** \brief Is Address Reachable request - DISABLED
 581     @param client_index - opaque cookie to identify the sender
 582     @param context - sender context, to match reply w/ request
 583     @param next_hop_sw_if_index - index of interface used to get to next hop
 584     @param is_ipv6 - 1 for IPv6, 0 for IPv4
 585     @param is_error - address not found or does not match intf
 586     @param address[] - Address in question
 587 */
 588 define is_address_reachable {
 589     u32 client_index;           /* (api_main_t *) am->my_client_index */
 590     u32 context;
 591     u32 next_hop_sw_if_index;
 592     u8 is_known;                /* on reply, this is the answer */
 593     u8 is_ipv6;
 594     u8 is_error;                /* address not found or does not match intf */
 595     u8 address[16];
 596 };
 597
 598 /** \brief Want Stats, register for stats updates
 599     @param client_index - opaque cookie to identify the sender
 600     @param context - sender context, to match reply w/ request
 601     @param enable_disable - 1 = enable stats, 0 = disable
 602     @param pid - pid of process requesting stats updates
 603 */
 604 define want_stats {
 605     u32 client_index;
 606     u32 context;
 607     u32 enable_disable;
 608     u32 pid;
 609 };
 610
 611 /** \brief Reply for Want Stats request
 612     @param context - returned sender context, to match reply w/ request
 613     @param retval - return code
 614 */
 615 manual_java define want_stats_reply {
 616     u32 context;
 617     i32 retval;
 618 };
 619
 620 /** \brief Want stats counters structure
 621     @param vnet_counter_type- such as ip4, ip6, punts, etc
 622     @param is_combined - rx & tx total (all types) counts
 623     @param first_sw_if_index - first sw index in block of index, counts
 624     @param count - number of interfaces this stats block includes counters for
 625     @param data - contiguous block of vlib_counter_t structures
 626 */
 627 manual_java define vnet_interface_counters {
 628     /* enums - plural - in vnet/interface.h */
 629     u8 vnet_counter_type;
 630     u8 is_combined;
 631     u32 first_sw_if_index;
 632     u32 count;
 633     u8 data[0];
 634 };
 635
 636 typeonly manual_print manual_endian define ip4_fib_counter {
 637     u32 address;
 638     u8 address_length;
 639     u64 packets;
 640     u64 bytes;
 641 };
 642
 643 manual_java manual_print manual_endian define vnet_ip4_fib_counters {
 644     u32 vrf_id;
 645     u32 count;
 646     vl_api_ip4_fib_counter_t c[count];
 647 };
 648
 649 typeonly manual_print manual_endian define ip6_fib_counter {
 650     u64 address[2];
 651     u8 address_length;
 652     u64 packets;
 653     u64 bytes;
 654 };
 655
 656 manual_java manual_print manual_endian define vnet_ip6_fib_counters {
 657     u32 vrf_id;
 658     u32 count;
 659     vl_api_ip6_fib_counter_t c[count];
 660 };
 661
 662 /** \brief Request for a single block of summary stats
 663     @param client_index - opaque cookie to identify the sender
 664     @param context - sender context, to match reply w/ request
 665 */
 666 define vnet_get_summary_stats {
 667     u32 client_index;
 668     u32 context;
 669 };
 670
 671 /** \brief Reply for vnet_get_summary_stats request
 672     @param context - sender context, to match reply w/ request
 673     @param retval - return code for request
 674     @param total_pkts -
 675     @param total_bytes -
 676     @param vector_rate -
 677 */
 678 define vnet_summary_stats_reply {
 679     u32 context;
 680     i32 retval;
 681     u64 total_pkts[2];
 682     u64 total_bytes[2];
 683     f64 vector_rate;
 684 };
 685
 686 /** \brief OAM event structure
 687     @param dst_address[] -
 688     @param state
 689 */
 690 manual_java define oam_event {
 691     u8 dst_address[4];
 692     u8 state;
 693 };
 694
 695 /** \brief Want OAM events request
 696     @param client_index - opaque cookie to identify the sender
 697     @param context - sender context, to match reply w/ request
 698     @param enable_disable- enable if non-zero, else disable
 699     @param pid - pid of the requesting process
 700 */
 701 define want_oam_events {
 702     u32 client_index;
 703     u32 context;
 704     u32 enable_disable;
 705     u32 pid;
 706 };
 707
 708 /** \brief Want OAM events response
 709     @param context - sender context, to match reply w/ request
 710     @param retval - return code for the want oam stats request
 711 */
 712 define want_oam_events_reply {
 713     u32 context;
 714     i32 retval;
 715 };
 716
 717 /** \brief OAM add / del target request
 718     @param client_index - opaque cookie to identify the sender
 719     @param context - sender context, to match reply w/ request
 720     @param vrf_id - vrf_id of the target
 721     @param src_address[] - source address to use for the updates
 722     @param dst_address[] - destination address of the target
 723     @param is_add - add target if non-zero, else delete
 724 */
 725 define oam_add_del {
 726     u32 client_index;
 727     u32 context;
 728     u32 vrf_id;
 729     u8 src_address[4];
 730     u8 dst_address[4];
 731     u8 is_add;
 732 };
 733
 734 /** \brief OAM add / del target response
 735     @param context - sender context, to match reply w/ request
 736     @param retval - return code of the request
 737 */
 738 define oam_add_del_reply {
 739     u32 context;
 740     i32 retval;
 741 };
 742
 743 /** \brief Reset fib table request
 744     @param client_index - opaque cookie to identify the sender
 745     @param context - sender context, to match reply w/ request
 746     @param vrf_id - vrf/table id of the fib table to reset
 747     @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
 748 */
 749 define reset_fib {
 750     u32 client_index;
 751     u32 context;
 752     u32 vrf_id;
 753     u8 is_ipv6;
 754 };
 755
 756 /** \brief Reset fib response
 757     @param context - sender context, to match reply w/ request
 758     @param retval - return code for the reset bfib request
 759 */
 760 define reset_fib_reply {
 761     u32 context;
 762     i32 retval;
 763 };
 764
 765 /** \brief DHCP Proxy config add / del request
 766     @param client_index - opaque cookie to identify the sender
 767     @param context - sender context, to match reply w/ request
 768     @param vrf_id - vrf id
 769     @param if_ipv6 - ipv6 if non-zero, else ipv4
 770     @param is_add - add the config if non-zero, else delete
 771     @param insert_circuit_id - option82 suboption 1 fib number
 772     @param dhcp_server[] - server address
 773     @param dhcp_src_address[] - <fix this, need details>
 774 */
 775 define dhcp_proxy_config {
 776     u32 client_index;
 777     u32 context;
 778     u32 vrf_id;
 779     u8 is_ipv6;
 780     u8 is_add;
 781     u8 insert_circuit_id;
 782     u8 dhcp_server[16];
 783     u8 dhcp_src_address[16];
 784 };
 785
 786 /** \brief DHCP Proxy config response
 787     @param context - sender context, to match reply w/ request
 788     @param retval - return code for the request
 789 */
 790 define dhcp_proxy_config_reply {
 791     u32 context;
 792     i32 retval;
 793 };
 794
 795 /** \brief DHCP Proxy set / unset vss request
 796     @param client_index - opaque cookie to identify the sender
 797     @param context - sender context, to match reply w/ request
 798     @param tbl_id - table id
 799     @param oui - first part of vpn id
 800     @param fib_id - second part of vpn id
 801     @param is_ipv6 - ip6 if non-zero, else ip4
 802     @param is_add - set vss if non-zero, else delete
 803 */
 804 define dhcp_proxy_set_vss {
 805     u32 client_index;
 806     u32 context;
 807     u32 tbl_id;
 808     u32 oui;
 809     u32 fib_id;
 810     u8 is_ipv6;
 811     u8 is_add;
 812 };
 813
 814 /** \brief DHCP proxy set / unset vss response
 815     @param context - sender context, to match reply w/ request
 816     @param retval - return code for the request
 817 */
 818 define dhcp_proxy_set_vss_reply {
 819     u32 context;
 820     i32 retval;
 821 };
 822
 823 /** \brief Set the ip flow hash config for a fib request
 824     @param client_index - opaque cookie to identify the sender
 825     @param context - sender context, to match reply w/ request
 826     @param vrf_id - vrf/fib id
 827     @param is_ipv6 - if non-zero the fib is ip6, else ip4
 828     @param src - if non-zero include src in flow hash
 829     @param dst - if non-zero include dst in flow hash
 830     @param sport - if non-zero include sport in flow hash
 831     @param dport - if non-zero include dport in flow hash
 832     @param proto -if non-zero include proto in flow hash
 833     @param reverse - if non-zero include reverse in flow hash
 834 */
 835 define set_ip_flow_hash {
 836     u32 client_index;
 837     u32 context;
 838     u32 vrf_id;
 839     u8 is_ipv6;
 840     u8 src;
 841     u8 dst;
 842     u8 sport;
 843     u8 dport;
 844     u8 proto;
 845     u8 reverse;
 846 };
 847
 848 /** \brief Set the ip flow hash config for a fib response
 849     @param context - sender context, to match reply w/ request
 850     @param retval - return code for the request
 851 */
 852 define set_ip_flow_hash_reply {
 853     u32 context;
 854     i32 retval;
 855 };
 856
 857 /** \brief IPv6 router advertisement config request
 858     @param client_index - opaque cookie to identify the sender
 859     @param context - sender context, to match reply w/ request
 860     @param suppress -
 861     @param managed -
 862     @param other -
 863     @param ll_option -
 864     @param send_unicast -
 865     @param cease -
 866     @param is_no -
 867     @param default_router -
 868     @param max_interval -
 869     @param min_interval -
 870     @param lifetime -
 871     @param initial_count -
 872     @param initial_interval -
 873 */
 874 define sw_interface_ip6nd_ra_config {
 875     u32 client_index;
 876     u32 context;
 877     u32 sw_if_index;
 878     u8 suppress;
 879     u8  managed;
 880     u8 other;
 881     u8 ll_option;
 882     u8 send_unicast;
 883     u8 cease;
 884     u8 is_no;
 885     u8 default_router;
 886     u32 max_interval;
 887     u32 min_interval;
 888     u32 lifetime;
 889     u32 initial_count;
 890     u32 initial_interval;
 891 };
 892
 893 /** \brief IPv6 router advertisement config response
 894     @param context - sender context, to match reply w/ request
 895     @param retval - return code for the request
 896 */
 897 define sw_interface_ip6nd_ra_config_reply {
 898     u32 context;
 899     i32 retval;
 900 };
 901
 902 /** \brief IPv6 router advertisement prefix config request
 903     @param client_index - opaque cookie to identify the sender
 904     @param context - sender context, to match reply w/ request
 905     @param sw_if_index -
 906     @param address[] -
 907     @param address_length -
 908     @param use_default -
 909     @param no_advertise -
 910     @param off_link -
 911     @param no_autoconfig -
 912     @param no_onlink -
 913     @param is_no -
 914     @param val_lifetime -
 915     @param pref_lifetime -
 916 */
 917 define sw_interface_ip6nd_ra_prefix {
 918     u32 client_index;
 919     u32 context;
 920     u32 sw_if_index;
 921     u8 address[16];
 922     u8 address_length;
 923     u8 use_default;
 924     u8 no_advertise;
 925     u8 off_link;
 926     u8 no_autoconfig;
 927     u8 no_onlink;
 928     u8 is_no;
 929     u32 val_lifetime;
 930     u32 pref_lifetime;
 931 };
 932
 933 /** \brief IPv6 router advertisement prefix config response
 934     @param context - sender context, to match reply w/ request
 935     @param retval - return code for the request
 936 */
 937 define sw_interface_ip6nd_ra_prefix_reply {
 938     u32 context;
 939     i32 retval;
 940 };
 941
 942 /** \brief IPv6 interface enable / disable request
 943     @param client_index - opaque cookie to identify the sender
 944     @param context - sender context, to match reply w/ request
 945     @param sw_if_index - interface used to reach neighbor
 946     @param enable - if non-zero enable ip6 on interface, else disable
 947 */
 948 define sw_interface_ip6_enable_disable  {
 949     u32 client_index;
 950     u32 context;
 951     u32 sw_if_index;
 952     u8 enable;                        /* set to true if enable*/
 953 };
 954
 955 /** \brief IPv6 interface enable / disable response
 956     @param context - sender context, to match reply w/ request
 957     @param retval - return code for the request
 958 */
 959 define  sw_interface_ip6_enable_disable_reply {
 960     u32 context;
 961     i32 retval;
 962 };
 963
 964 /** \brief IPv6 set link local address on interface request
 965     @param client_index - opaque cookie to identify the sender
 966     @param context - sender context, to match reply w/ request
 967     @param sw_if_index - interface to set link local on
 968     @param address[] - the new link local address
 969     @param address_length - link local address length
 970 */
 971 define sw_interface_ip6_set_link_local_address  {
 972     u32 client_index;
 973     u32 context;
 974     u32 sw_if_index;
 975     u8 address[16];
 976     u8 address_length;
 977 };
 978
 979 /** \brief IPv6 set link local address on interface response
 980     @param context - sender context, to match reply w/ request
 981     @param retval - error code for the request
 982 */
 983 define  sw_interface_ip6_set_link_local_address_reply {
 984     u32 context;
 985     i32 retval;
 986 };
 987
 988 /** \brief Set unnumbered interface add / del request
 989     @param client_index - opaque cookie to identify the sender
 990     @param context - sender context, to match reply w/ request
 991     @param sw_if_index - interface with an IP address
 992     @param unnumbered_sw_if_index - interface which will use the address
 993     @param is_add - if non-zero set the association, else unset it
 994 */
 995 define sw_interface_set_unnumbered {
 996     u32 client_index;
 997     u32 context;
 998     u32 sw_if_index;            /* use this intfc address */
 999     u32 unnumbered_sw_if_index; /* on this interface */
1000     u8 is_add;
1001 };
1002
1003 /** \brief Set unnumbered interface add / del response
1004     @param context - sender context, to match reply w/ request
1005     @param retval - return code for the request
1006 */
1007 define  sw_interface_set_unnumbered_reply {
1008     u32 context;
1009     i32 retval;
1010 };
1011
1012 /** \brief Create loopback interface request
1013     @param client_index - opaque cookie to identify the sender
1014     @param context - sender context, to match reply w/ request
1015     @param mac_address - mac addr to assign to the interface if none-zero
1016 */
1017 define create_loopback {
1018     u32 client_index;
1019     u32 context;
1020     u8  mac_address[6];
1021 };
1022
1023 /** \brief Create loopback interface response
1024     @param context - sender context, to match reply w/ request
1025     @param sw_if_index - sw index of the interface that was created
1026     @param retval - return code for the request
1027 */
1028 define create_loopback_reply {
1029     u32 context;
1030     i32 retval;
1031     u32 sw_if_index;
1032 };
1033
1034 /** \brief Delete loopback interface request
1035     @param client_index - opaque cookie to identify the sender
1036     @param context - sender context, to match reply w/ request
1037     @param sw_if_index - sw index of the interface that was created
1038 */
1039 define delete_loopback {
1040     u32 client_index;
1041     u32 context;
1042     u32 sw_if_index;
1043 };
1044
1045 /** \brief Delete loopback interface response
1046     @param context - sender context, to match reply w/ request
1047     @param retval - return code for the request
1048 */
1049 define delete_loopback_reply {
1050     u32 context;
1051     i32 retval;
1052 };
1053
1054 /** \brief Control ping from client to api server request
1055     @param client_index - opaque cookie to identify the sender
1056     @param context - sender context, to match reply w/ request
1057 */
1058 manual_java define control_ping {
1059     u32 client_index;
1060     u32 context;
1061 };
1062
1063 /** \brief Control ping from the client to the server response
1064     @param client_index - opaque cookie to identify the sender
1065     @param context - sender context, to match reply w/ request
1066     @param retval - return code for the request
1067     @param vpe_pid - the pid of the vpe, returned by the server
1068 */
1069 manual_java define control_ping_reply {
1070     u32 context;
1071     i32 retval;
1072     u32 client_index;
1073     u32 vpe_pid;
1074 };
1075
1076 /** \brief Process a vpe parser cli string request
1077     @param client_index - opaque cookie to identify the sender
1078     @param context - sender context, to match reply w/ request
1079     @param cmd_in_shmem - pointer to cli command string
1080 */
1081 define cli_request {
1082     u32 client_index;
1083     u32 context;
1084     u64 cmd_in_shmem;
1085 };
1086
1087 /** \brief vpe parser cli string response
1088     @param context - sender context, to match reply w/ request
1089     @param retval - return code for request
1090     @param reply_in_shmem - Reply string from cli processing if any
1091 */
1092 define cli_reply {
1093     u32 context;
1094     i32 retval;
1095     u64 reply_in_shmem;
1096 };
1097
1098 /** \brief Set max allowed ARP or ip6 neighbor entries request
1099     @param client_index - opaque cookie to identify the sender
1100     @param context - sender context, to match reply w/ request
1101     @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1102     @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1103 */
1104 define set_arp_neighbor_limit {
1105     u32 client_index;
1106     u32 context;
1107     u8  is_ipv6;
1108     u32 arp_neighbor_limit;
1109 };
1110
1111 /** \brief Set max allowed ARP or ip6 neighbor entries response
1112     @param context - sender context, to match reply w/ request
1113     @param retval - return code for request
1114 */
1115 define set_arp_neighbor_limit_reply {
1116     u32 context;
1117     i32 retval;
1118 };
1119
1120 /** \brief L2 interface patch add / del request
1121     @param client_index - opaque cookie to identify the sender
1122     @param context - sender context, to match reply w/ request
1123     @param rx_sw_if_index - receive side interface
1124     @param tx_sw_if_index - transmit side interface
1125     @param is_add - if non-zero set up the interface patch, else remove it
1126 */
1127 define l2_patch_add_del {
1128     u32 client_index;
1129     u32 context;
1130     u32 rx_sw_if_index;
1131     u32 tx_sw_if_index;
1132     u8 is_add;
1133 };
1134
1135 /** \brief L2 interface patch add / del response
1136     @param context - sender context, to match reply w/ request
1137     @param retval - return code for the request
1138 */
1139 define l2_patch_add_del_reply {
1140     u32 context;
1141     i32 retval;
1142 };
1143
1144 /** \brief IPv6 segment routing tunnel add / del request
1145     @param client_index - opaque cookie to identify the sender
1146     @param context - sender context, to match reply w/ request
1147     @param is_add - add the tunnel if non-zero, else delete it
1148     @param name[] - tunnel name (len. 64)
1149     @param src_address[] -
1150     @param dst_address[] -
1151     @param dst_mask_width -
1152     @param inner_vrf_id -
1153     @param outer_vrf_id -
1154     @param flags_net_byte_order -
1155     @param n_segments -
1156     @param n_tags -
1157     @param segs_and_tags[] -
1158     @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1159 */
1160 define sr_tunnel_add_del {
1161     u32 client_index;
1162     u32 context;
1163     u8 is_add;
1164     u8 name[64];
1165     u8 src_address[16];
1166     u8 dst_address[16];
1167     u8 dst_mask_width;
1168     u32 inner_vrf_id;
1169     u32 outer_vrf_id;
1170     u16 flags_net_byte_order;
1171     u8 n_segments;
1172     u8 n_tags;
1173     u8 segs_and_tags[0];
1174     u8 policy_name[64];
1175 };
1176
1177 /** \brief IPv6 segment routing tunnel add / del response
1178     @param context - sender context, to match reply w/ request
1179     @param retval - return value for request
1180 */
1181 define sr_tunnel_add_del_reply {
1182     u32 context;
1183     i32 retval;
1184 };
1185
1186 /** \brief IPv6 segment routing policy add / del request
1187     @param client_index - opaque cookie to identify the sender
1188     @param context - sender context, to match reply w/ request
1189     @param is_add - add the tunnel if non-zero, else delete it
1190     @param name[] - policy name (len. 64)
1191     @param tunnel_names[] -
1192 */
1193 define sr_policy_add_del {
1194     u32 client_index;
1195     u32 context;
1196     u8 is_add;
1197     u8 name[64];
1198     u8 tunnel_names[0];
1199 };
1200
1201 /** \brief IPv6 segment routing policy add / del response
1202     @param context - sender context, to match reply w/ request
1203     @param retval - return value for request
1204 */
1205 define sr_policy_add_del_reply {
1206     u32 context;
1207     i32 retval;
1208 };
1209
1210 /** \brief IPv6 segment routing multicast map to policy add / del request
1211     @param client_index - opaque cookie to identify the sender
1212     @param context - sender context, to match reply w/ request
1213     @param is_add - add the tunnel if non-zero, else delete it
1214     @param multicast_address[] - IP6 multicast address
1215     @param policy_name[] = policy name (len.64)
1216 */
1217 define sr_multicast_map_add_del {
1218     u32 client_index;
1219     u32 context;
1220     u8 is_add;
1221     u8 multicast_address[16];
1222     u8 policy_name[64];
1223 };
1224
1225 /** \brief IPv6 segment routing multicast map to policy add / del response
1226     @param context - sender context, to match reply w/ request
1227     @param retval - return value for request
1228 */
1229 define sr_multicast_map_add_del_reply {
1230     u32 context;
1231     i32 retval;
1232 };
1233
1234 /** \brief Interface set vpath request
1235     @param client_index - opaque cookie to identify the sender
1236     @param context - sender context, to match reply w/ request
1237     @param sw_if_index - interface used to reach neighbor
1238     @param enable - if non-zero enable, else disable
1239 */
1240 define sw_interface_set_vpath {
1241     u32 client_index;
1242     u32 context;
1243     u32 sw_if_index;
1244     u8  enable;
1245 };
1246
1247 /** \brief Interface set vpath response
1248     @param context - sender context, to match reply w/ request
1249     @param retval - return code for the request
1250 */
1251 define sw_interface_set_vpath_reply {
1252     u32 context;
1253     i32 retval;
1254 };
1255
1256 /** \brief MPLS Ethernet add / del tunnel request
1257     @param client_index - opaque cookie to identify the sender
1258     @param context - sender context, to match reply w/ request
1259     @param vrf_id - vrf_id, only for IP4
1260     @param sw_if_index - interface used to reach neighbor
1261     @param is_add - add if set, tunnel delete if 0
1262     @param dst_mac_address -
1263     @param adj_address -
1264     @param adj_address_length -
1265 */
1266 define mpls_ethernet_add_del_tunnel {
1267     u32 client_index;
1268     u32 context;
1269     u32 vrf_id;
1270     u32 tx_sw_if_index;
1271     u8 is_add;
1272     u8 l2_only;
1273     u8 dst_mac_address[6];
1274     u8 adj_address[4];
1275     u8 adj_address_length;
1276 };
1277
1278 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1279     @param context - sender context, to match reply w/ request
1280     @param retval - return code for the request
1281 */
1282 define mpls_ethernet_add_del_tunnel_reply {
1283     u32 context;
1284     i32 retval;
1285     u32 tunnel_sw_if_index;
1286 };
1287 /** \brief MPLS Ethernet add/ del tunnel 2
1288     @param client_index - opaque cookie to identify the sender
1289     @param context - sender context, to match reply w/ request
1290     @param inner_vrf_id -
1291     @param outer_vrf_id -
1292     @param resolve_attempts -
1293     @param resolve_opaque -
1294     @param resolve_if_needed -
1295     @param is_add -
1296     @param adj_address -
1297     @param adj_address_length -
1298     @param next_hop_ip4_address_in_outer_vrf -
1299 */
1300 define mpls_ethernet_add_del_tunnel_2 {
1301    u32 client_index;
1302    u32 context;
1303    u32 inner_vrf_id;
1304    u32 outer_vrf_id;
1305    u32 resolve_attempts;
1306    u32 resolve_opaque;          /* no need to set this */
1307    u8 resolve_if_needed;
1308    u8 is_add;
1309    u8 l2_only;
1310    u8 adj_address[4];
1311    u8 adj_address_length;
1312    u8 next_hop_ip4_address_in_outer_vrf [4];
1313 };
1314
1315 /** \brief MPLS Ethernet add/ del tunnel 2
1316     @param context - sender context, to match reply w/ request
1317     @param retval - return code for add /del request
1318 */
1319 define mpls_ethernet_add_del_tunnel_2_reply {
1320     u32 context;
1321     i32 retval;
1322 };
1323
1324 /** \brief Set L2 XConnect between two interfaces request
1325     @param client_index - opaque cookie to identify the sender
1326     @param context - sender context, to match reply w/ request
1327     @param rx_sw_if_index - Receive interface index
1328     @param tx_sw_if_index - Transmit interface index
1329     @param enable - enable xconnect if not 0, else set to L3 mode
1330 */
1331 define sw_interface_set_l2_xconnect {
1332     u32 client_index;
1333     u32 context;
1334     u32 rx_sw_if_index;
1335     u32 tx_sw_if_index;
1336     u8 enable;
1337 };
1338
1339 /** \brief Set L2 XConnect response
1340     @param context - sender context, to match reply w/ request
1341     @param retval - L2 XConnect request return code
1342 */
1343 define sw_interface_set_l2_xconnect_reply {
1344     u32 context;
1345     i32 retval;
1346 };
1347
1348 /** \brief Interface bridge mode request
1349     @param client_index - opaque cookie to identify the sender
1350     @param context - sender context, to match reply w/ request
1351     @param rx_sw_if_index - the interface
1352     @param bd_id - bridge domain id
1353     @param bvi - Setup interface as a bvi, bridge mode only
1354     @param shg - Shared horizon group, for bridge mode only
1355     @param enable - Enable beige mode if not 0, else set to L3 mode
1356 */
1357 define sw_interface_set_l2_bridge {
1358     u32 client_index;
1359     u32 context;
1360     u32 rx_sw_if_index;
1361     u32 bd_id;
1362     u8 shg;
1363     u8 bvi;
1364     u8 enable;
1365 };
1366
1367 /** \brief Interface bridge mode response
1368     @param context - sender context, to match reply w/ request
1369     @param retval - Bridge mode request return code
1370 */
1371 define sw_interface_set_l2_bridge_reply {
1372     u32 context;
1373     i32 retval;
1374 };
1375
1376 /** \brief L2 FIB add entry request
1377     @param client_index - opaque cookie to identify the sender
1378     @param context - sender context, to match reply w/ request
1379     @param mac - the entry's mac address
1380     @param bd_id - the entry's bridge domain id
1381     @param sw_if_index - the interface
1382     @param is_add - If non zero add the entry, else delete it
1383     @param static_mac -
1384     @param filter_mac -
1385 */
1386 define l2fib_add_del {
1387     u32 client_index;
1388     u32 context;
1389     u64 mac;
1390     u32 bd_id;
1391     u32 sw_if_index;
1392     u8 is_add;
1393     u8 static_mac;
1394     u8 filter_mac;
1395     u8 bvi_mac;
1396 };
1397
1398 /** \brief L2 FIB add entry response
1399     @param context - sender context, to match reply w/ request
1400     @param retval - return code for the add l2fib entry request
1401 */
1402 define l2fib_add_del_reply {
1403     u32 context;
1404     i32 retval;
1405 };
1406
1407 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1408     @param client_index - opaque cookie to identify the sender
1409     @param context - sender context, to match reply w/ request
1410     @param sw_if_index - interface
1411     @param is_set - if non-zero, set the bits, else clear them
1412     @param feature_bitmap - non-zero bits to set or clear
1413 */
1414 define l2_flags {
1415     u32 client_index;
1416     u32 context;
1417     u32 sw_if_index;
1418     u8 is_set;
1419     u32 feature_bitmap;
1420 };
1421
1422 /** \brief Set L2 bits response
1423     @param context - sender context, to match reply w/ request
1424     @param retval - return code for the set l2 bits request
1425 */
1426 define l2_flags_reply {
1427     u32 context;
1428     i32 retval;
1429     u32 resulting_feature_bitmap;
1430 };
1431
1432 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1433     L2_UU_FLOOD, or L2_ARP_TERM) request
1434     @param client_index - opaque cookie to identify the sender
1435     @param context - sender context, to match reply w/ request
1436     @param bd_id - the bridge domain to set the flags for
1437     @param is_set - if non-zero, set the flags, else clear them
1438     @param feature_bitmap - bits that are non-zero to set or clear
1439 */
1440 define bridge_flags {
1441     u32 client_index;
1442     u32 context;
1443     u32 bd_id;
1444     u8 is_set;
1445     u32 feature_bitmap;
1446 };
1447
1448 /** \brief Set bridge flags response
1449     @param context - sender context, to match reply w/ request
1450     @param retval - return code for the set bridge flags request
1451     @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1452 */
1453 define bridge_flags_reply {
1454     u32 context;
1455     i32 retval;
1456     u32 resulting_feature_bitmap;
1457 };
1458
1459 /** \brief Set bridge domain ip to mac entry request
1460     @param client_index - opaque cookie to identify the sender
1461     @param context - sender context, to match reply w/ request
1462     @param bd_id - the bridge domain to set the flags for
1463     @param is_add - if non-zero, add the entry, else clear it
1464     @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1465     @param mac_address - MAC address
1466     @param
1467 */
1468 define bd_ip_mac_add_del {
1469     u32 client_index;
1470     u32 context;
1471     u32 bd_id;
1472     u8 is_add;
1473     u8 is_ipv6;
1474     u8 ip_address[16];
1475     u8 mac_address[6];
1476 };
1477
1478 /** \brief Set bridge domain ip to mac entry response
1479     @param context - sender context, to match reply w/ request
1480     @param retval - return code for the set bridge flags request
1481 */
1482 define bd_ip_mac_add_del_reply {
1483     u32 context;
1484     i32 retval;
1485 };
1486
1487 /** \brief Add/Delete classification table request
1488     @param client_index - opaque cookie to identify the sender
1489     @param context - sender context, to match reply w/ request
1490     @param is_add- if non-zero add the table, else delete it
1491     @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1492     @param nbuckets - number of buckets when adding a table
1493     @param memory_size - memory size when adding a table
1494     @param match_n_vectors - number of match vectors
1495     @param next_table_index - index of next table
1496     @param miss_next_index - index of miss table
1497     @param mask[] - match mask
1498 */
1499 define classify_add_del_table {
1500     u32 client_index;
1501     u32 context;
1502     u8  is_add;
1503     u32 table_index;
1504     u32 nbuckets;
1505     u32 memory_size;
1506     u32 skip_n_vectors;
1507     u32 match_n_vectors;
1508     u32 next_table_index;
1509     u32 miss_next_index;
1510     u8 mask[0];
1511 };
1512
1513 /** \brief Add/Delete classification table response
1514     @param context - sender context, to match reply w/ request
1515     @param retval - return code for the table add/del requst
1516     @param new_table_index - for add, returned index of the new table
1517     @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1518     @param match_n_vectors -for add, returned value of match_n_vectors in table
1519 */
1520 define classify_add_del_table_reply {
1521     u32 context;
1522     i32 retval;
1523     u32 new_table_index;
1524     u32 skip_n_vectors;
1525     u32 match_n_vectors;
1526 };
1527
1528 /** \brief Classify add / del session request
1529     @param client_index - opaque cookie to identify the sender
1530     @param context - sender context, to match reply w/ request
1531     @param is_add - add session if non-zero, else delete
1532     @param table_index - index of the table to add/del the session, required
1533     @param hit_next_index - for add, hit_next_index of new session, required
1534     @param opaque_index - for add, opaque_index of new session
1535     @param advance -for add, advance value for session
1536     @param match[] - for add, match value for session, required
1537 */
1538 define classify_add_del_session {
1539     u32 client_index;
1540     u32 context;
1541     u8  is_add;
1542     u32 table_index;
1543     u32 hit_next_index;
1544     u32 opaque_index;
1545     i32 advance;
1546     u8 match[0];
1547 };
1548
1549 /** \brief Classify add / del session response
1550     @param context - sender context, to match reply w/ request
1551     @param retval - return code for the add/del session request
1552 */
1553 define classify_add_del_session_reply {
1554     u32 context;
1555     i32 retval;
1556 };
1557
1558 /** \brief Set/unset the classification table for an interface request
1559     @param client_index - opaque cookie to identify the sender
1560     @param context - sender context, to match reply w/ request
1561     @param is_ipv6 - ipv6 if non-zero, else ipv4
1562     @param sw_if_index - interface to associate with the table
1563     @param table_index - index of the table, if ~0 unset the table
1564 */
1565 define classify_set_interface_ip_table {
1566     u32 client_index;
1567     u32 context;
1568     u8 is_ipv6;
1569     u32 sw_if_index;
1570     u32 table_index;            /* ~0 => off */
1571 };
1572
1573 /** \brief Set/unset interface classification table response
1574     @param context - sender context, to match reply w/ request
1575     @param retval - return code
1576 */
1577 define classify_set_interface_ip_table_reply {
1578     u32 context;
1579     i32 retval;
1580 };
1581
1582 /** \brief Set/unset l2 classification tables for an interface request
1583     @param client_index - opaque cookie to identify the sender
1584     @param context - sender context, to match reply w/ request
1585     @param sw_if_index - interface to set/unset tables for
1586     @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1587     @param ip6_table_index - ip6 index
1588     @param other_table_index - other index
1589 */
1590 define classify_set_interface_l2_tables {
1591     u32 client_index;
1592     u32 context;
1593     u32 sw_if_index;
1594     /* 3 x ~0 => off */
1595     u32 ip4_table_index;
1596     u32 ip6_table_index;
1597     u32 other_table_index;
1598 };
1599
1600 /** \brief Set/unset l2 classification tables for an interface response
1601     @param context - sender context, to match reply w/ request
1602     @param retval - return code for the request
1603 */
1604 define classify_set_interface_l2_tables_reply {
1605     u32 context;
1606     i32 retval;
1607 };
1608
1609 /** \brief Get node index using name request
1610     @param client_index - opaque cookie to identify the sender
1611     @param context - sender context, to match reply w/ request
1612     @param node_name[] - name of the node
1613 */
1614 define get_node_index {
1615     u32 client_index;
1616     u32 context;
1617     u8 node_name[64];
1618 };
1619
1620 /** \brief Get node index using name request
1621     @param context - sender context, to match reply w/ request
1622     @param retval - return code for the request
1623     @param node_index - index of the desired node if found, else ~0
1624 */
1625 define get_node_index_reply {
1626     u32 context;
1627     i32 retval;
1628     u32 node_index;
1629 };
1630
1631 /** \brief Set the next node for a given node request
1632     @param client_index - opaque cookie to identify the sender
1633     @param context - sender context, to match reply w/ request
1634     @param node_name[] - node to add the next node to
1635     @param next_name[] - node to add as the next node
1636 */
1637 define add_node_next {
1638     u32 client_index;
1639     u32 context;
1640     u8 node_name[64];
1641     u8 next_name[64];
1642 };
1643
1644 /** \brief IP Set the next node for a given node response
1645     @param context - sender context, to match reply w/ request
1646     @param retval - return code for the add next node request
1647     @param next_index - the index of the next node if success, else ~0
1648 */
1649 define add_node_next_reply {
1650     u32 context;
1651     i32 retval;
1652     u32 next_index;
1653 };
1654
1655 /** \brief DHCP Proxy config 2 add / del request
1656     @param client_index - opaque cookie to identify the sender
1657     @param context - sender context, to match reply w/ request
1658     @param rx_vrf_id - receive vrf id
1659     @param server_vrf_id - server vrf id
1660     @param if_ipv6 - ipv6 if non-zero, else ipv4
1661     @param is_add - add the config if non-zero, else delete
1662     @param insert_circuit_id - option82 suboption 1 fib number
1663     @param dhcp_server[] - server address
1664     @param dhcp_src_address[] - <fix this, need details>
1665 */
1666 define dhcp_proxy_config_2 {
1667     u32 client_index;
1668     u32 context;
1669     u32 rx_vrf_id;
1670     u32 server_vrf_id;
1671     u8 is_ipv6;
1672     u8 is_add;
1673     u8 insert_circuit_id;
1674     u8 dhcp_server[16];
1675     u8 dhcp_src_address[16];
1676 };
1677
1678 /** \brief DHCP Proxy config 2 add / del response
1679     @param context - sender context, to match reply w/ request
1680     @param retval - return code for request
1681 */
1682 define dhcp_proxy_config_2_reply {
1683     u32 context;
1684     i32 retval;
1685 };
1686
1687 /** \brief l2tpv3 tunnel interface create request
1688     @param client_index - opaque cookie to identify the sender
1689     @param context - sender context, to match reply w/ request
1690     @param client_address - remote client tunnel ip address
1691     @param client_address - local tunnel ip address
1692     @param is_ipv6 - ipv6 if non-zero, else ipv4
1693     @param local_session_id - local tunnel session id
1694     @param remote_session_id - remote tunnel session id
1695     @param local_cookie - local tunnel cookie
1696     @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1697 */
1698 define l2tpv3_create_tunnel {
1699     u32 client_index;
1700     u32 context;
1701     u8 client_address [16];
1702     u8 our_address [16];
1703     u8 is_ipv6;
1704     u32 local_session_id;
1705     u32 remote_session_id;
1706     u64 local_cookie;
1707     u64 remote_cookie;
1708     u8 l2_sublayer_present;
1709 };
1710
1711 /** \brief l2tpv3 tunnel interface create response
1712     @param context - sender context, to match reply w/ request
1713     @param retval - return code for the request
1714     @param sw_if_index - index of the new tunnel interface
1715 */
1716 define l2tpv3_create_tunnel_reply {
1717     u32 context;
1718     i32 retval;
1719     u32 sw_if_index;
1720 };
1721
1722 define l2tpv3_set_tunnel_cookies {
1723     u32 client_index;
1724     u32 context;
1725     u32 sw_if_index;
1726     u64 new_local_cookie;
1727     u64 new_remote_cookie;
1728 };
1729
1730 /** \brief L2TP tunnel set cookies response
1731     @param context - sender context, to match reply w/ request
1732     @param retval - return code for the request
1733 */
1734 define l2tpv3_set_tunnel_cookies_reply {
1735     u32 context;
1736     i32 retval;
1737 };
1738
1739 manual_java define sw_if_l2tpv3_tunnel_details {
1740     u32 context;
1741     u32 sw_if_index;
1742     u8 interface_name[64];
1743     u8 client_address [16];
1744     u8 our_address [16];
1745     u32 local_session_id;
1746     u32 remote_session_id;
1747     u64 local_cookie[2];
1748     u64 remote_cookie;
1749     u8 l2_sublayer_present;
1750 };
1751
1752 define sw_if_l2tpv3_tunnel_dump {
1753     u32 client_index;
1754     u32 context;
1755 };
1756
1757 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1758     @param client_index - opaque cookie to identify the sender
1759     @param context - sender context, to match reply w/ request
1760 */
1761 define l2_fib_clear_table {
1762     u32 client_index;
1763     u32 context;
1764 };
1765
1766 /** \brief L2 fib clear table response
1767     @param context - sender context, to match reply w/ request
1768     @param retval - return code for the request
1769 */
1770 define l2_fib_clear_table_reply {
1771     u32 context;
1772     i32 retval;
1773 };
1774
1775 /** \brief L2 interface ethernet flow point filtering enable/disable request
1776     @param client_index - opaque cookie to identify the sender
1777     @param context - sender context, to match reply w/ request
1778     @param sw_if_index - interface to enable/disable filtering on
1779     @param enable_disable - if non-zero enable filtering, else disable
1780 */
1781 define l2_interface_efp_filter {
1782     u32 client_index;
1783     u32 context;
1784     u32 sw_if_index;
1785     u32 enable_disable;
1786 };
1787
1788 /** \brief L2 interface ethernet flow point filtering response
1789     @param context - sender context, to match reply w/ request
1790     @param retval - return code for the request
1791 */
1792 define l2_interface_efp_filter_reply {
1793     u32 context;
1794     i32 retval;
1795 };
1796
1797 define l2tpv3_interface_enable_disable {
1798     u32 client_index;
1799     u32 context;
1800     u8 enable_disable;
1801     u32 sw_if_index;
1802 };
1803
1804 define l2tpv3_interface_enable_disable_reply {
1805     u32 context;
1806     i32 retval;
1807 };
1808
1809 define l2tpv3_set_lookup_key {
1810     u32 client_index;
1811     u32 context;
1812     /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1813     u8 key;
1814 };
1815
1816 define l2tpv3_set_lookup_key_reply {
1817     u32 context;
1818     i32 retval;
1819 };
1820
1821 define vxlan_add_del_tunnel {
1822     u32 client_index;
1823     u32 context;
1824     u8 is_add;
1825     u8 is_ipv6;
1826     u8 src_address[16];
1827     u8 dst_address[16];
1828     u32 encap_vrf_id;
1829     u32 decap_next_index;
1830     u32 vni;
1831 };
1832
1833 define vxlan_add_del_tunnel_reply {
1834     u32 context;
1835     i32 retval;
1836     u32 sw_if_index;
1837 };
1838
1839 manual_java define vxlan_tunnel_dump {
1840     u32 client_index;
1841     u32 context;
1842     u32 sw_if_index;
1843 };
1844
1845 manual_java define vxlan_tunnel_details {
1846     u32 context;
1847     u32 sw_if_index;
1848     u8 src_address[16];
1849     u8 dst_address[16];
1850     u32 encap_vrf_id;
1851     u32 decap_next_index;
1852     u32 vni;
1853     u8 is_ipv6;
1854 };
1855
1856 define gre_add_del_tunnel {
1857     u32 client_index;
1858     u32 context;
1859     u8 is_add;
1860     u32 src_address;
1861     u32 dst_address;
1862     u32 outer_table_id;
1863 };
1864
1865 define gre_add_del_tunnel_reply {
1866     u32 context;
1867     i32 retval;
1868     u32 sw_if_index;
1869 };
1870
1871 manual_java define gre_tunnel_dump {
1872     u32 client_index;
1873     u32 context;
1874     u32 sw_if_index;
1875 };
1876
1877 manual_java define gre_tunnel_details {
1878     u32 context;
1879     u32 sw_if_index;
1880     u32 src_address;
1881     u32 dst_address;
1882     u32 outer_table_id;
1883 };
1884
1885 /** \brief L2 interface vlan tag rewrite configure request
1886     @param client_index - opaque cookie to identify the sender
1887     @param context - sender context, to match reply w/ request
1888     @param sw_if_index - interface the operation is applied to
1889     @param vtr_op - Choose from l2_vtr_op_t enum values
1890     @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1891     @param tag1 - Needed for any push or translate vtr op
1892     @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1893 */
1894 define l2_interface_vlan_tag_rewrite {
1895     u32 client_index;
1896     u32 context;
1897     u32 sw_if_index;
1898     u32 vtr_op;
1899     u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1900     u32 tag1;  // first pushed tag
1901     u32 tag2;  // second pushed tag
1902 };
1903
1904 /** \brief L2 interface vlan tag rewrite response
1905     @param context - sender context, to match reply w/ request
1906     @param retval - return code for the request
1907 */
1908 define l2_interface_vlan_tag_rewrite_reply {
1909     u32 context;
1910     i32 retval;
1911 };
1912
1913 /** \brief vhost-user interface create request
1914     @param client_index - opaque cookie to identify the sender
1915     @param is_server - our side is socket server
1916     @param sock_filename - unix socket filename, used to speak with frontend
1917     @param use_custom_mac - enable or disable the use of the provided hardware address
1918     @param mac_address - hardware address to use if 'use_custom_mac' is set
1919 */
1920 define create_vhost_user_if {
1921    u32 client_index;
1922    u32 context;
1923    u8 is_server;
1924    u8 sock_filename[256];
1925    u8 renumber;
1926    u32 custom_dev_instance;
1927    u8 use_custom_mac;
1928    u8 mac_address[6];
1929 };
1930
1931 /** \brief vhost-user interface create response
1932     @param context - sender context, to match reply w/ request
1933     @param retval - return code for the request
1934     @param sw_if_index - interface the operation is applied to
1935 */
1936 define create_vhost_user_if_reply {
1937    u32 context;
1938    i32 retval;
1939    u32 sw_if_index;
1940 };
1941
1942 /** \brief vhost-user interface modify request
1943     @param client_index - opaque cookie to identify the sender
1944     @param is_server - our side is socket server
1945     @param sock_filename - unix socket filename, used to speak with frontend
1946 */
1947 define modify_vhost_user_if {
1948    u32 client_index;
1949    u32 context;
1950    u32 sw_if_index;
1951    u8 is_server;
1952    u8 sock_filename[256];
1953    u8 renumber;
1954    u32 custom_dev_instance;
1955 };
1956
1957 /** \brief vhost-user interface modify response
1958     @param context - sender context, to match reply w/ request
1959     @param retval - return code for the request
1960 */
1961 define modify_vhost_user_if_reply {
1962    u32 context;
1963    i32 retval;
1964 };
1965
1966 /** \brief vhost-user interface delete request
1967     @param client_index - opaque cookie to identify the sender
1968 */
1969 define delete_vhost_user_if {
1970    u32 client_index;
1971    u32 context;
1972    u32 sw_if_index;
1973 };
1974
1975 /** \brief vhost-user interface delete response
1976     @param context - sender context, to match reply w/ request
1977     @param retval - return code for the request
1978 */
1979 define delete_vhost_user_if_reply {
1980    u32 context;
1981    i32 retval;
1982 };
1983
1984 define create_subif {
1985     u32 client_index;
1986     u32 context;
1987     u32 sw_if_index;
1988     u32 sub_id;
1989
1990     /* These fields map directly onto the subif template */
1991     u8 no_tags;
1992     u8 one_tag;
1993     u8 two_tags;
1994     u8 dot1ad;   // 0 = dot1q, 1=dot1ad
1995     u8 exact_match;
1996     u8 default_sub;
1997     u8 outer_vlan_id_any;
1998     u8 inner_vlan_id_any;
1999     u16 outer_vlan_id;
2000     u16 inner_vlan_id;
2001 };
2002
2003 define create_subif_reply {
2004     u32 context;
2005     i32 retval;
2006     u32 sw_if_index;
2007 };
2008
2009 /** \brief show version
2010     @param client_index - opaque cookie to identify the sender
2011     @param context - sender context, to match reply w/ request
2012 */
2013 define show_version {
2014    u32 client_index;
2015    u32 context;
2016 };
2017
2018 /** \brief show version response
2019     @param context - sender context, to match reply w/ request
2020     @param retval - return code for the request
2021     @param program - name of the program (vpe)
2022     @param version  - version of the program
2023     @param build_directory - root of the workspace where the program was built
2024 */
2025 manual_java define show_version_reply {
2026    u32 context;
2027    i32 retval;
2028    u8 program[32];
2029    u8 version[32];
2030    u8 build_date[32];
2031    u8 build_directory[256];
2032 };
2033
2034 /** \brief Vhost-user interface details structure (fix this)
2035     @param sw_if_index - index of the interface
2036     @param interface_name - name of interface
2037     @param virtio_net_hdr_sz - net header size
2038     @param features - interface features
2039     @param is_server - vhost-user server socket
2040     @param sock_filename - socket filename
2041     @param num_regions - number of used memory regions
2042 */
2043 manual_java define sw_interface_vhost_user_details {
2044     u32 context;
2045     u32 sw_if_index;
2046     u8 interface_name[64];
2047     u32 virtio_net_hdr_sz;
2048     u64 features;
2049     u8 is_server;
2050     u8 sock_filename[256];
2051     u32 num_regions;
2052     i32 sock_errno;
2053 };
2054
2055 /* works */
2056 define sw_interface_vhost_user_dump {
2057     u32 client_index;
2058     u32 context;
2059 };
2060
2061 manual_java define ip_address_details {
2062     u32 client_index;
2063     u32 context;
2064     u8 ip[16];
2065     u8 prefix_length;
2066 };
2067
2068 manual_java define ip_address_dump {
2069     u32 client_index;
2070     u32 context;
2071     u32 sw_if_index;
2072     u8 is_ipv6;
2073 };
2074
2075 manual_java define ip_details {
2076     u32 sw_if_index;
2077     u32 context;
2078 };
2079
2080 define ip_dump {
2081     u32 client_index;
2082     u32 context;
2083     u8 is_ipv6;
2084 };
2085
2086 /** \brief l2 fib table entry structure
2087     @param bd_id - the l2 fib / bridge domain table id
2088     @param mac - the entry's mac address
2089     @param sw_if_index - index of the interface
2090     @param static_mac - the entry is statically configured.
2091     @param filter_mac - the entry is a mac filter entry.
2092     @param bvi_mac - the mac address is a bridge virtual interface
2093 */
2094 manual_java define l2_fib_table_entry {
2095     u32 context;
2096     u32 bd_id;
2097     u64 mac;
2098     u32 sw_if_index;
2099     u8 static_mac;
2100     u8 filter_mac;
2101     u8 bvi_mac;
2102 };
2103
2104 /** \brief Dump l2 fib (aka bridge domain) table
2105     @param client_index - opaque cookie to identify the sender
2106     @param bd_id - the l2 fib / bridge domain table identifier
2107 */
2108 manual_java define l2_fib_table_dump {
2109     u32 client_index;
2110     u32 context;
2111     u32 bd_id;
2112 };
2113
2114 define vxlan_gpe_add_del_tunnel {
2115     u32 client_index;
2116     u32 context;
2117     u8 is_ipv6;
2118     u8 local[16];
2119     u8 remote[16];
2120     u32 encap_vrf_id;
2121     u32 decap_vrf_id;
2122     u8 protocol;
2123     u32 vni;
2124     u8 is_add;
2125 };
2126
2127 define vxlan_gpe_add_del_tunnel_reply {
2128     u32 context;
2129     i32 retval;
2130     u32 sw_if_index;
2131 };
2132
2133 manual_java define vxlan_gpe_tunnel_dump {
2134     u32 client_index;
2135     u32 context;
2136     u32 sw_if_index;
2137 };
2138
2139 manual_java define vxlan_gpe_tunnel_details {
2140     u32 context;
2141     u32 sw_if_index;
2142     u8 local[16];
2143     u8 remote[16];
2144     u32 vni;
2145     u8 protocol;
2146     u32 encap_vrf_id;
2147     u32 decap_vrf_id;
2148     u8 is_ipv6;
2149 };
2150
2151 /** \brief add or delete locator_set
2152     @param client_index - opaque cookie to identify the sender
2153     @param context - sender context, to match reply w/ request
2154     @param is_add - add address if non-zero, else delete
2155     @param locator_set_name - locator name
2156 */
2157 define lisp_add_del_locator_set {
2158     u32 client_index;
2159     u32 context;
2160     u8  is_add;
2161     u8  locator_set_name[64];
2162 };
2163
2164 /** \brief Reply for locator_set add/del
2165     @param context - returned sender context, to match reply w/ request
2166     @param retval - return code
2167 */
2168 define lisp_add_del_locator_set_reply {
2169     u32 context;
2170     i32 retval;
2171 };
2172
2173 /** \brief add or delete locator for locator_set
2174     @param client_index - opaque cookie to identify the sender
2175     @param context - sender context, to match reply w/ request
2176     @param is_add - add address if non-zero, else delete
2177     @param locator_set_name - name of locator_set to add/del locator
2178     @param sw_if_index - index of the interface
2179     @param priority - priority of the lisp locator
2180     @param weight - weight of the lisp locator
2181 */
2182 define lisp_add_del_locator {
2183     u32 client_index;
2184     u32 context;
2185     u8  is_add;
2186     u8  locator_set_name[64];
2187     u32 sw_if_index;
2188     u8  priority;
2189     u8  weight;
2190 };
2191
2192 /** \brief Reply for locator add/del
2193     @param context - returned sender context, to match reply w/ request
2194     @param retval - return code
2195 */
2196 define lisp_add_del_locator_reply {
2197     u32 context;
2198     i32 retval;
2199 };
2200
2201 /** \brief add or delete lisp eid-table
2202     @param client_index - opaque cookie to identify the sender
2203     @param context - sender context, to match reply w/ request
2204     @param is_add - add address if non-zero, else delete
2205     @param eid_type:
2206       0 : ipv4
2207       1 : ipv6
2208       2 : mac
2209     @param eid - EID can be ip4, ip6 or mac
2210     @param prefix_len - prefix len
2211     @param locator_set_name - name of locator_set to add/del eid-table
2212     @param vni - virtual network instance
2213 */
2214 define lisp_add_del_local_eid {
2215     u32 client_index;
2216     u32 context;
2217     u8  is_add;
2218     u8  eid_type;
2219     u8  eid[16];
2220     u8  prefix_len;
2221     u8  locator_set_name[64];
2222     u32 vni;
2223 };
2224
2225 /** \brief Reply for local_eid add/del
2226     @param context - returned sender context, to match reply w/ request
2227     @param retval - return code
2228 */
2229 define lisp_add_del_local_eid_reply {
2230     u32 context;
2231     i32 retval;
2232 };
2233
2234 /** \brief add or delete lisp gpe maptunel
2235     @param client_index - opaque cookie to identify the sender
2236     @param context - sender context, to match reply w/ request
2237     @param is_add - add address if non-zero, else delete
2238     @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2239     @param eid_ip_address - array of address bytes
2240     @param eid_prefix_len - prefix len
2241     @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2242     @param source_ip_address - array of address bytes
2243     @param destination_ip_address - array of address bytes
2244 */
2245 define lisp_gpe_add_del_fwd_entry {
2246     u32 client_index;
2247     u32 context;
2248     u8  is_add;
2249     u8  eid_is_ipv6;
2250     u8  eid_ip_address[16];
2251     u8  eid_prefix_len;
2252     u8  address_is_ipv6;
2253     u8  source_ip_address[16];
2254     u8  destination_ip_address[16];
2255 };
2256
2257 /** \brief Reply for gpe_fwd_entry add/del
2258     @param context - returned sender context, to match reply w/ request
2259     @param retval - return code
2260 */
2261 define lisp_gpe_add_del_fwd_entry_reply {
2262     u32 context;
2263     i32 retval;
2264 };
2265
2266 /** \brief add or delete map-resolver
2267     @param client_index - opaque cookie to identify the sender
2268     @param context - sender context, to match reply w/ request
2269     @param is_add - add address if non-zero, else delete
2270     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2271     @param ip_address - array of address bytes
2272 */
2273 define lisp_add_del_map_resolver {
2274     u32 client_index;
2275     u32 context;
2276     u8  is_add;
2277     u8  is_ipv6;
2278     u8  ip_address[16];
2279 };
2280
2281 /** \brief Reply for map_resolver add/del
2282     @param context - returned sender context, to match reply w/ request
2283     @param retval - return code
2284 */
2285 define lisp_add_del_map_resolver_reply {
2286     u32 context;
2287     i32 retval;
2288 };
2289
2290 /** \brief enable or disable lisp-gpe protocol
2291     @param client_index - opaque cookie to identify the sender
2292     @param context - sender context, to match reply w/ request
2293     @param is_en - enable protocol if non-zero, else disable
2294 */
2295 define lisp_gpe_enable_disable {
2296     u32 client_index;
2297     u32 context;
2298     u8  is_en;
2299 };
2300
2301 /** \brief Reply for gpe enable/disable
2302     @param context - returned sender context, to match reply w/ request
2303     @param retval - return code
2304 */
2305 define lisp_gpe_enable_disable_reply {
2306     u32 context;
2307     i32 retval;
2308 };
2309
2310 /** \brief enable or disable LISP feature
2311     @param client_index - opaque cookie to identify the sender
2312     @param context - sender context, to match reply w/ request
2313     @param is_en - enable protocol if non-zero, else disable
2314 */
2315 define lisp_enable_disable {
2316     u32 client_index;
2317     u32 context;
2318     u8  is_en;
2319 };
2320
2321 /** \brief Reply for gpe enable/disable
2322     @param context - returned sender context, to match reply w/ request
2323     @param retval - return code
2324 */
2325 define lisp_enable_disable_reply {
2326     u32 context;
2327     i32 retval;
2328 };
2329
2330 /** \brief add or delete gpe_iface
2331     @param client_index - opaque cookie to identify the sender
2332     @param context - sender context, to match reply w/ request
2333     @param is_add - add address if non-zero, else delete
2334 */
2335 define lisp_gpe_add_del_iface {
2336     u32 client_index;
2337     u32 context;
2338     u8  is_add;
2339     u32 table_id;
2340     u32 vni;
2341 };
2342
2343 /** \brief Reply for gpe_iface add/del
2344     @param context - returned sender context, to match reply w/ request
2345     @param retval - return code
2346 */
2347 define lisp_gpe_add_del_iface_reply {
2348     u32 context;
2349     i32 retval;
2350 };
2351
2352 /** \brief configure or disable LISP PITR node
2353     @param client_index - opaque cookie to identify the sender
2354     @param context - sender context, to match reply w/ request
2355     @param ls_name - locator set name
2356     @param is_add - add locator set if non-zero, else disable pitr
2357 */
2358 define lisp_pitr_set_locator_set {
2359     u32 client_index;
2360     u32 context;
2361     u8 is_add;
2362     u8 ls_name[64];
2363 };
2364
2365 /** \brief Reply for lisp_pitr_set_locator_set
2366     @param context - returned sender context, to match reply w/ request
2367     @param retval - return code
2368 */
2369 define lisp_pitr_set_locator_set_reply {
2370     u32 context;
2371     i32 retval;
2372 };
2373
2374 /** \brief add or delete remote static mapping
2375     @param client_index - opaque cookie to identify the sender
2376     @param context - sender context, to match reply w/ request
2377     @param is_add - add address if non-zero, else delete
2378     @param del_all - if set, delete all remote mappings
2379     @param vni - virtual network instance
2380     @param action - negative map-reply action
2381     @param eid_type -
2382       0 : ipv4
2383       1 : ipv6
2384       2 : mac
2385     @param deid - destination EID
2386     @param seid - source EID
2387     @param rloc_num - number of remote locators
2388     @param rlocs - remote locator data
2389 */
2390 define lisp_add_del_remote_mapping {
2391     u32 client_index;
2392     u32 context;
2393     u8  is_add;
2394     u8 del_all;
2395     u32 vni;
2396     u8 action;
2397     u8 eid_type;
2398     u8 deid[16];
2399     u8 seid[16];
2400     u8 deid_len;
2401     u8 seid_len;
2402     u32 rloc_num;
2403     u8 rlocs[0];
2404 };
2405
2406 /** \brief Reply for lisp_add_del_remote_mapping
2407     @param context - returned sender context, to match reply w/ request
2408     @param retval - return code
2409 */
2410 define lisp_add_del_remote_mapping_reply {
2411     u32 context;
2412     i32 retval;
2413 };
2414
2415 /** \brief add or delete LISP adjacency adjacency
2416     @param client_index - opaque cookie to identify the sender
2417     @param context - sender context, to match reply w/ request
2418     @param is_add - add address if non-zero, else delete
2419     @param vni - virtual network instance
2420     @param eid_type -
2421       0 : ipv4
2422       1 : ipv6
2423       2 : mac
2424     @param deid - destination EID
2425     @param seid - source EID
2426 */
2427 define lisp_add_del_adjacency {
2428     u32 client_index;
2429     u32 context;
2430     u8  is_add;
2431     u32 vni;
2432     u8 eid_type;
2433     u8 deid[16];
2434     u8 seid[16];
2435     u8 deid_len;
2436     u8 seid_len;
2437 };
2438
2439 /** \brief Reply for lisp_add_del_adjacency
2440     @param context - returned sender context, to match reply w/ request
2441     @param retval - return code
2442 */
2443 define lisp_add_del_adjacency_reply {
2444     u32 context;
2445     i32 retval;
2446 };
2447
2448 /** \brief add or delete map request itr rlocs
2449     @param client_index - opaque cookie to identify the sender
2450     @param context - sender context, to match reply w/ request
2451     @param is_add - add address if non-zero, else delete
2452     @param locator_set_name - locator set name
2453 */
2454 define lisp_add_del_map_request_itr_rlocs {
2455     u32 client_index;
2456     u32 context;
2457     u8 is_add;
2458     u8 locator_set_name[64];
2459 };
2460
2461 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2462     @param context - returned sender context, to match reply w/ request
2463     @param retval - return code
2464 */
2465
2466 define lisp_add_del_map_request_itr_rlocs_reply {
2467     u32 context;
2468     i32 retval;
2469 };
2470
2471 /** \brief map/unmap vni to vrf
2472     @param client_index - opaque cookie to identify the sender
2473     @param context - sender context, to match reply w/ request
2474     @param is_add - add or delete mapping
2475     @param vni - virtual network id
2476     @param vrf - vrf
2477 */
2478 define lisp_eid_table_add_del_map {
2479     u32 client_index;
2480     u32 context;
2481     u8 is_add;
2482     u32 vni;
2483     u32 vrf;
2484 };
2485
2486 /** \brief Reply for lisp_eid_table_add_del_map
2487     @param context - returned sender context, to match reply w/ request
2488     @param retval - return code
2489 */
2490 define lisp_eid_table_add_del_map_reply {
2491     u32 context;
2492     i32 retval;
2493 };
2494
2495 /** \brief LISP locator_set status
2496     @param locator_set_name - name of the locator_set
2497     @param sw_if_index - sw_if_index of the locator
2498     @param priority - locator priority
2499     @param weight - locator weight
2500  */
2501 manual_java define lisp_locator_set_details {
2502     u32 context;
2503     u8  local;
2504     u8  locator_set_name[64];
2505     u32 sw_if_index;
2506     u8  is_ipv6;
2507     u8  ip_address[16];
2508     u8  prefix_len;
2509     u8  priority;
2510     u8  weight;
2511 };
2512
2513 /** \brief Request for locator_set summary status
2514     @param client_index - opaque cookie to identify the sender
2515     @param context - sender context, to match reply w/ request
2516  */
2517 define lisp_locator_set_dump {
2518     u32 client_index;
2519     u32 context;
2520 };
2521
2522 /** \brief LISP local eid table status
2523     @param locator_set_name - name of the locator_set
2524     @param eid_type - ip4, ip6 or l2 mac address
2525     @param eid - array of address bytes
2526     @param eid_prefix_len - prefix len
2527  */
2528 manual_java define lisp_local_eid_table_details {
2529     u32 context;
2530     u8  locator_set_name[64];
2531     u8  eid_type;
2532     u32 vni;
2533     u8  eid[16];
2534     u8  eid_prefix_len;
2535 };
2536
2537 /** \brief Request for local eid table summary status
2538     @param client_index - opaque cookie to identify the sender
2539     @param context - sender context, to match reply w/ request
2540     @param eid_set - if non-zero request info about specific mapping
2541     @param vni - virtual network instance; valid only if eid_set != 0
2542     @param prefix_length - prefix length if EID is IP address;
2543       valid only if eid_set != 0
2544     @param eid_type - EID type; valid only if eid_set != 0
2545       Supported values:
2546         0: EID is IPv4
2547         1: EID is IPv6
2548         2: EID is ethernet address
2549     @param eid - endpoint identifier
2550  */
2551 define lisp_local_eid_table_dump {
2552     u32 client_index;
2553     u32 context;
2554     u8  eid_set;
2555     u8  prefix_length;
2556     u32 vni;
2557     u8  eid_type;
2558     u8  eid[16];
2559 };
2560
2561 /** \brief Shows relationship between vni and vrf
2562     @param vrf - VRF index
2563     @param vni - vitual network instance
2564   */
2565 manual_java define lisp_eid_table_map_details {
2566     u32 context;
2567     u32 vni;
2568     u32 vrf;
2569 };
2570
2571 /** \brief Request for lisp_eid_table_map_details
2572     @param client_index - opaque cookie to identify the sender
2573     @param context - sender context, to match reply w/ request
2574  */
2575 define lisp_eid_table_map_dump {
2576     u32 client_index;
2577     u32 context;
2578 };
2579
2580 manual_java define lisp_gpe_tunnel_details {
2581     u32 context;
2582     u32 tunnels;
2583     u8  is_ipv6;
2584     u8  source_ip[16];
2585     u8  destination_ip[16];
2586     u32 encap_fib_id;
2587     u32 decap_fib_id;
2588     u32 dcap_next;
2589     u8  lisp_ver;
2590     u8  next_protocol;
2591     u8  flags;
2592     u8  ver_res;
2593     u8  res;
2594     u32 iid;
2595 };
2596
2597 /** \brief Request for gpe tunnel summary status
2598     @param client_index - opaque cookie to identify the sender
2599     @param context - sender context, to match reply w/ request
2600  */
2601 define lisp_gpe_tunnel_dump {
2602     u32 client_index;
2603     u32 context;
2604 };
2605
2606 /** \brief LISP map resolver status
2607     @param locator_set_name - name of the locator_set
2608     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2609     @param ip_address - array of address bytes
2610  */
2611 manual_java define lisp_map_resolver_details {
2612     u32 context;
2613     u8  is_ipv6;
2614     u8  ip_address[16];
2615 };
2616
2617 /** \brief Request for map resolver summary status
2618     @param client_index - opaque cookie to identify the sender
2619     @param context - sender context, to match reply w/ request
2620  */
2621 define lisp_map_resolver_dump {
2622     u32 client_index;
2623     u32 context;
2624 };
2625
2626 /** \brief Status of lisp-gpe protocol, enable or disable
2627     @param context - sender context, to match reply w/ request
2628     @param is_en - enable protocol if non-zero, else disable
2629 */
2630 manual_java define lisp_enable_disable_status_details {
2631     u32 context;
2632     u8 feature_status;
2633     u8 gpe_status;
2634 };
2635
2636 /** \brief Request for lisp-gpe protocol status
2637     @param client_index - opaque cookie to identify the sender
2638     @param context - sender context, to match reply w/ request
2639 */
2640 define lisp_enable_disable_status_dump {
2641     u32 client_index;
2642     u32 context;
2643 };
2644
2645 /** \brief Get LISP map request itr rlocs status
2646     @param context - sender context, to match reply w/ request
2647     @param locator_set_name - name of the locator_set
2648  */
2649 define lisp_get_map_request_itr_rlocs {
2650     u32 client_index;
2651     u32 context;
2652 };
2653
2654 /** \brief Request for map request itr rlocs summary status
2655  */
2656 define lisp_get_map_request_itr_rlocs_reply {
2657     u32 context;
2658     i32 retval;
2659     u8 locator_set_name[64];
2660 };
2661
2662 /* Gross kludge, DGMS */
2663 define interface_name_renumber {
2664     u32 client_index;
2665     u32 context;
2666     u32 sw_if_index;
2667     u32 new_show_dev_instance;
2668 };
2669
2670 define interface_name_renumber_reply {
2671     u32 context;
2672     i32 retval;
2673 };
2674
2675 /** \brief Register for ip4 arp resolution events
2676     @param client_index - opaque cookie to identify the sender
2677     @param context - sender context, to match reply w/ request
2678     @param enable_disable - 1 => register for events, 0 => cancel registration
2679     @param pid - sender's pid
2680     @param address - the exact ip4 address of interest
2681 */
2682 define want_ip4_arp_events {
2683     u32 client_index;
2684     u32 context;
2685     u8 enable_disable;
2686     u32 pid;
2687     u32 address;
2688 };
2689
2690 /** \brief Reply for interface events registration
2691     @param context - returned sender context, to match reply w/ request
2692     @param retval - return code
2693 */
2694 define want_ip4_arp_events_reply {
2695     u32 context;
2696     i32 retval;
2697 };
2698
2699 /** \brief Tell client about an ip4 arp resolution event
2700     @param client_index - opaque cookie to identify the sender
2701     @param context - sender context, to match reply w/ request
2702     @param address - the exact ip4 address of interest
2703     @param pid - client pid registered to receive notification
2704     @param sw_if_index - interface which received ARP packet
2705     @param new_mac - the new mac address
2706 */
2707 define ip4_arp_event {
2708     u32 client_index;
2709     u32 context;
2710     u32 address;
2711     u32 pid;
2712     u32 sw_if_index;
2713     u8 new_mac[6];
2714 };
2715
2716 /** \brief L2 bridge domain add or delete request
2717     @param client_index - opaque cookie to identify the sender
2718     @param context - sender context, to match reply w/ request
2719     @param bd_id - the bridge domain to create
2720     @param flood - enable/disable bcast/mcast flooding in the bd
2721     @param uu_flood - enable/disable uknown unicast flood in the bd
2722     @param forward - enable/disable forwarding on all interfaces in the bd
2723     @param learn - enable/disable learning on all interfaces in the bd
2724     @param arp_term - enable/disable arp termination in the bd
2725     @param is_add - add or delete flag
2726 */
2727 define bridge_domain_add_del {
2728     u32 client_index;
2729     u32 context;
2730     u32 bd_id;
2731     u8 flood;
2732     u8 uu_flood;
2733     u8 forward;
2734     u8 learn;
2735     u8 arp_term;
2736     u8 is_add;
2737 };
2738
2739 /** \brief L2 bridge domain add or delete response
2740     @param context - sender context, to match reply w/ request
2741     @param retval - return code for the set bridge flags request
2742 */
2743 define bridge_domain_add_del_reply {
2744     u32 context;
2745     i32 retval;
2746 };
2747
2748 /** \brief L2 bridge domain request operational state details
2749     @param client_index - opaque cookie to identify the sender
2750     @param context - sender context, to match reply w/ request
2751     @param bd_id - the bridge domain id desired or ~0 to request all bds
2752 */
2753 manual_java define bridge_domain_dump {
2754     u32 client_index;
2755     u32 context;
2756     u32 bd_id;
2757 };
2758
2759 /** \brief L2 bridge domain operational state response
2760     @param bd_id - the bridge domain id
2761     @param flood - bcast/mcast flooding state on all interfaces in the bd
2762     @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2763     @param forward - forwarding state on all interfaces in the bd
2764     @param learn - learning state on all interfaces in the bd
2765     @param arp_term - arp termination state on all interfaces in the bd
2766     @param n_sw_ifs - number of sw_if_index's in the domain
2767 */
2768 manual_java define bridge_domain_details {
2769     u32 context;
2770     u32 bd_id;
2771     u8 flood;
2772     u8 uu_flood;
2773     u8 forward;
2774     u8 learn;
2775     u8 arp_term;
2776     u32 bvi_sw_if_index;
2777     u32 n_sw_ifs;
2778 };
2779
2780 /** \brief L2 bridge domain sw interface operational state response
2781     @param bd_id - the bridge domain id
2782     @param sw_if_index - sw_if_index in the domain
2783     @param shg - split horizon group for the interface
2784 */
2785 manual_java define bridge_domain_sw_if_details {
2786     u32 context;
2787     u32 bd_id;
2788     u32 sw_if_index;
2789     u8 shg;
2790 };
2791
2792 /** \brief DHCP Client config add / del request
2793     @param client_index - opaque cookie to identify the sender
2794     @param context - sender context, to match reply w/ request
2795     @param sw_if_index - index of the interface for DHCP client
2796     @param hostname - hostname
2797     @param is_add - add the config if non-zero, else delete
2798     @param want_dhcp_event - DHCP event sent to the sender
2799            via dhcp_compl_event API message if non-zero
2800     @param pid - sender's pid
2801 */
2802 define dhcp_client_config {
2803     u32 client_index;
2804     u32 context;
2805     u32 sw_if_index;
2806     u8 hostname[64];
2807     u8 is_add;
2808     u8 want_dhcp_event;
2809     u32 pid;
2810 };
2811
2812 /** \brief DHCP Client config response
2813     @param context - sender context, to match reply w/ request
2814     @param retval - return code for the request
2815 */
2816 define dhcp_client_config_reply {
2817     u32 context;
2818     i32 retval;
2819 };
2820
2821 /** \brief Set/unset input ACL interface
2822     @param client_index - opaque cookie to identify the sender
2823     @param context - sender context, to match reply w/ request
2824     @param sw_if_index - interface to set/unset input ACL
2825     @param ip4_table_index - ip4 classify table index (~0 for skip)
2826     @param ip6_table_index - ip6 classify table index (~0 for skip)
2827     @param l2_table_index  -  l2 classify table index (~0 for skip)
2828     @param is_add - Set input ACL if non-zero, else unset
2829     Note: User is recommeneded to use just one valid table_index per call.
2830           (ip4_table_index, ip6_table_index, or l2_table_index)
2831 */
2832 define input_acl_set_interface {
2833     u32 client_index;
2834     u32 context;
2835     u32 sw_if_index;
2836     u32 ip4_table_index;
2837     u32 ip6_table_index;
2838     u32 l2_table_index;
2839     u8  is_add;
2840 };
2841
2842 /** \brief Set/unset input ACL interface response
2843     @param context - sender context, to match reply w/ request
2844     @param retval - return code for the request
2845 */
2846 define input_acl_set_interface_reply {
2847     u32 context;
2848     i32 retval;
2849 };
2850
2851 /** \brief IPsec: Add/delete Security Policy Database
2852     @param client_index - opaque cookie to identify the sender
2853     @param context - sender context, to match reply w/ request
2854     @param is_add - add SPD if non-zero, else delete
2855     @param spd_id - SPD instance id (control plane allocated)
2856 */
2857
2858 define ipsec_spd_add_del {
2859     u32 client_index;
2860     u32 context;
2861     u8 is_add;
2862     u32 spd_id;
2863 };
2864
2865 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2866     @param context - returned sender context, to match reply w/ request
2867     @param retval - return code
2868 */
2869
2870 define ipsec_spd_add_del_reply {
2871     u32 context;
2872     i32 retval;
2873 };
2874
2875 /** \brief IPsec: Add/delete SPD from interface
2876
2877     @param client_index - opaque cookie to identify the sender
2878     @param context - sender context, to match reply w/ request
2879     @param is_add - add security mode if non-zero, else delete
2880     @param sw_if_index - index of the interface
2881     @param spd_id - SPD instance id to use for lookups
2882 */
2883
2884
2885 define ipsec_interface_add_del_spd {
2886     u32 client_index;
2887     u32 context;
2888
2889     u8 is_add;
2890     u32 sw_if_index;
2891     u32 spd_id;
2892 };
2893
2894 /** \brief Reply for IPsec: Add/delete SPD from interface
2895     @param context - returned sender context, to match reply w/ request
2896     @param retval - return code
2897 */
2898
2899 define ipsec_interface_add_del_spd_reply {
2900     u32 context;
2901     i32 retval;
2902 };
2903
2904 /** \brief IPsec: Add/delete Security Policy Database entry
2905
2906     See RFC 4301, 4.4.1.1 on how to match packet to selectors
2907
2908     @param client_index - opaque cookie to identify the sender
2909     @param context - sender context, to match reply w/ request
2910     @param is_add - add SPD if non-zero, else delete
2911     @param spd_id - SPD instance id (control plane allocated)
2912     @param priority - priority of SPD entry (non-unique value).  Used to order SPD matching - higher priorities match before lower
2913     @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2914     @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2915     @param remote_address_start - start of remote address range to match
2916     @param remote_address_stop - end of remote address range to match
2917     @param local_address_start - start of local address range to match
2918     @param local_address_stop - end of local address range to match
2919     @param protocol - protocol type to match [0 means any]
2920     @param remote_port_start - start of remote port range to match ...
2921     @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2922     @param local_port_start - start of local port range to match ...
2923     @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2924     @param policy - 0 = bypass (no IPsec processing), 1 = discard (discard packet with ICMP processing), 2 = resolve (send request to control plane for SA resolving, and discard without ICMP processing), 3 = protect (apply IPsec policy using following parameters)
2925     @param sa_id - SAD instance id (control plane allocated)
2926
2927 */
2928
2929 define ipsec_spd_add_del_entry {
2930     u32 client_index;
2931     u32 context;
2932     u8 is_add;
2933
2934     u32 spd_id;
2935     i32 priority;
2936     u8 is_outbound;
2937
2938     // Selector
2939     u8 is_ipv6;
2940     u8 is_ip_any;
2941     u8 remote_address_start[16];
2942     u8 remote_address_stop[16];
2943     u8 local_address_start[16];
2944     u8 local_address_stop[16];
2945
2946     u8 protocol;
2947
2948     u16 remote_port_start;
2949     u16 remote_port_stop;
2950     u16 local_port_start;
2951     u16 local_port_stop;
2952
2953     // Policy
2954     u8 policy;
2955     u32 sa_id;
2956 };
2957
2958 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2959     @param context - returned sender context, to match reply w/ request
2960     @param retval - return code
2961 */
2962
2963 define ipsec_spd_add_del_entry_reply {
2964     u32 context;
2965     i32 retval;
2966 };
2967
2968 /** \brief IPsec: Add/delete Security Association Database entry
2969     @param client_index - opaque cookie to identify the sender
2970     @param context - sender context, to match reply w/ request
2971     @param is_add - add SAD entry if non-zero, else delete
2972
2973     @param sad_id - sad id
2974
2975     @param spi - security parameter index
2976
2977     @param protocol - 0 = AH, 1 = ESP
2978
2979     @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2980     @param crypto_key_length - length of crypto_key in bytes
2981     @param crypto_key - crypto keying material
2982
2983     @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2984     @param integrity_key_length - length of integrity_key in bytes
2985     @param integrity_key - integrity keying material
2986
2987     @param use_extended_sequence_number - use ESN when non-zero
2988
2989     @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2990     @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2991     @param tunnel_src_address - IPsec tunnel source address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
2992     @param tunnel_dst_address - IPsec tunnel destination address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
2993
2994     To be added:
2995      Anti-replay
2996      IPsec tunnel address copy mode (to support GDOI)
2997  */
2998
2999 define ipsec_sad_add_del_entry {
3000     u32 client_index;
3001     u32 context;
3002     u8 is_add;
3003
3004     u32 sad_id;
3005
3006     u32 spi;
3007
3008     u8 protocol;
3009
3010     u8 crypto_algorithm;
3011     u8 crypto_key_length;
3012     u8 crypto_key[128];
3013
3014     u8 integrity_algorithm;
3015     u8 integrity_key_length;
3016     u8 integrity_key[128];
3017
3018     u8 use_extended_sequence_number;
3019
3020     u8 is_tunnel;
3021     u8 is_tunnel_ipv6;
3022     u8 tunnel_src_address[16];
3023     u8 tunnel_dst_address[16];
3024 };
3025
3026 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3027     @param context - returned sender context, to match reply w/ request
3028     @param retval - return code
3029 */
3030
3031 define ipsec_sad_add_del_entry_reply {
3032     u32 context;
3033     i32 retval;
3034 };
3035
3036 /** \brief IPsec: Update Security Association keys
3037     @param client_index - opaque cookie to identify the sender
3038     @param context - sender context, to match reply w/ request
3039
3040     @param sa_id - sa id
3041
3042     @param crypto_key_length - length of crypto_key in bytes
3043     @param crypto_key - crypto keying material
3044
3045     @param integrity_key_length - length of integrity_key in bytes
3046     @param integrity_key - integrity keying material
3047 */
3048
3049 define ipsec_sa_set_key {
3050     u32 client_index;
3051     u32 context;
3052
3053     u32 sa_id;
3054
3055     u8 crypto_key_length;
3056     u8 crypto_key[128];
3057
3058     u8 integrity_key_length;
3059     u8 integrity_key[128];
3060 };
3061
3062 /** \brief Reply for IPsec: Update Security Association keys
3063     @param context - returned sender context, to match reply w/ request
3064     @param retval - return code
3065 */
3066
3067 define ipsec_sa_set_key_reply {
3068     u32 context;
3069     i32 retval;
3070 };
3071
3072 /** \brief IKEv2: Add/delete profile
3073     @param client_index - opaque cookie to identify the sender
3074     @param context - sender context, to match reply w/ request
3075
3076     @param name - IKEv2 profile name
3077     @param is_add - Add IKEv2 profile if non-zero, else delete
3078 */
3079 define ikev2_profile_add_del {
3080     u32 client_index;
3081     u32 context;
3082
3083     u8 name[64];
3084     u8 is_add;
3085 };
3086
3087 /** \brief Reply for IKEv2: Add/delete profile
3088     @param context - returned sender context, to match reply w/ request
3089     @param retval - return code
3090 */
3091 define ikev2_profile_add_del_reply {
3092     u32 context;
3093     i32 retval;
3094 };
3095
3096 /** \brief IKEv2: Set IKEv2 profile authentication method
3097     @param client_index - opaque cookie to identify the sender
3098     @param context - sender context, to match reply w/ request
3099
3100     @param name - IKEv2 profile name
3101     @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3102     @param is_hex - Authentication data in hex format if non-zero, else string
3103     @param data_len - Authentication data length
3104     @param data - Authentication data (for rsa-sig cert file path)
3105 */
3106 define ikev2_profile_set_auth {
3107     u32 client_index;
3108     u32 context;
3109
3110     u8 name[64];
3111     u8 auth_method;
3112     u8 is_hex;
3113     u32 data_len;
3114     u8 data[0];
3115 };
3116
3117 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3118     @param context - returned sender context, to match reply w/ request
3119     @param retval - return code
3120 */
3121 define ikev2_profile_set_auth_reply {
3122     u32 context;
3123     i32 retval;
3124 };
3125
3126 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3127     @param client_index - opaque cookie to identify the sender
3128     @param context - sender context, to match reply w/ request
3129
3130     @param name - IKEv2 profile name
3131     @param is_local - Identification is local if non-zero, else remote
3132     @param id_type - Identification type
3133     @param data_len - Identification data length
3134     @param data - Identification data
3135 */
3136 define ikev2_profile_set_id {
3137     u32 client_index;
3138     u32 context;
3139
3140     u8 name[64];
3141     u8 is_local;
3142     u8 id_type;
3143     u32 data_len;
3144     u8 data[0];
3145 };
3146
3147 /** \brief Reply for IKEv2:
3148     @param context - returned sender context, to match reply w/ request
3149     @param retval - return code
3150 */
3151 define ikev2_profile_set_id_reply {
3152     u32 context;
3153     i32 retval;
3154 };
3155
3156 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3157     @param client_index - opaque cookie to identify the sender
3158     @param context - sender context, to match reply w/ request
3159
3160     @param name - IKEv2 profile name
3161     @param is_local - Traffic selector is local if non-zero, else remote
3162     @param proto - Traffic selector IP protocol (if zero not relevant)
3163     @param start_port - The smallest port number allowed by traffic selector
3164     @param end_port - The largest port number allowed by traffic selector
3165     @param start_addr - The smallest address included in traffic selector
3166     @param end_addr - The largest address included in traffic selector
3167 */
3168 define ikev2_profile_set_ts {
3169     u32 client_index;
3170     u32 context;
3171
3172     u8 name[64];
3173     u8 is_local;
3174     u8 proto;
3175     u16 start_port;
3176     u16 end_port;
3177     u32 start_addr;
3178     u32 end_addr;
3179 };
3180
3181 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3182     @param context - returned sender context, to match reply w/ request
3183     @param retval - return code
3184 */
3185 define ikev2_profile_set_ts_reply {
3186     u32 context;
3187     i32 retval;
3188 };
3189
3190 /** \brief IKEv2: Set IKEv2 local RSA private key
3191     @param client_index - opaque cookie to identify the sender
3192     @param context - sender context, to match reply w/ request
3193
3194     @param key_file - Key file absolute path
3195 */
3196 define ikev2_set_local_key {
3197     u32 client_index;
3198     u32 context;
3199
3200     u8 key_file[256];
3201 };
3202
3203 /** \brief Reply for IKEv2: Set IKEv2 local key
3204     @param context - returned sender context, to match reply w/ request
3205     @param retval - return code
3206 */
3207 define ikev2_set_local_key_reply {
3208     u32 context;
3209     i32 retval;
3210 };
3211
3212 /** \brief Tell client about a DHCP completion event
3213     @param client_index - opaque cookie to identify the sender
3214     @param pid - client pid registered to receive notification
3215     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3216     @param host_address - Host IP address
3217     @param router_address - Router IP address
3218     @param host_mac - Host MAC address
3219 */
3220 manual_java define dhcp_compl_event {
3221     u32 client_index;
3222     u32 pid;
3223     u8 hostname[64];
3224     u8 is_ipv6;
3225     u8 host_address[16];
3226     u8 router_address[16];
3227     u8 host_mac[6];
3228 };
3229
3230 /** \brief Add MAP domains
3231     @param client_index - opaque cookie to identify the sender
3232     @param context - sender context, to match reply w/ request
3233     @param ip6_prefix - Rule IPv6 prefix
3234     @param ip4_prefix - Rule IPv4 prefix
3235     @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3236     @param ip6_prefix_len - Rule IPv6 prefix length
3237     @param ip4_prefix_len - Rule IPv4 prefix length
3238     @param ea_bits_len - Embedded Address bits length
3239     @param psid_offset - Port Set Identifider (PSID) offset
3240     @param psid_length - PSID length
3241     @param is_translation - MAP-E / MAP-T
3242     @param mtu - MTU
3243 */
3244 define map_add_domain {
3245   u32 client_index;
3246   u32 context;
3247   u8 ip6_prefix[16];
3248   u8 ip4_prefix[4];
3249   u8 ip6_src[16];
3250   u8 ip6_prefix_len;
3251   u8 ip4_prefix_len;
3252   u8 ip6_src_prefix_len;
3253   u8 ea_bits_len;
3254   u8 psid_offset;
3255   u8 psid_length;
3256   u8 is_translation;
3257   u16 mtu;
3258 };
3259
3260 /** \brief Reply for MAP domain add
3261     @param context - returned sender context, to match reply w/ request
3262     @param index - MAP domain index
3263     @param retval - return code
3264 */
3265 define map_add_domain_reply {
3266   u32 context;
3267   u32 index;
3268   i32 retval;
3269 };
3270
3271 /** \brief Delete MAP domain
3272     @param client_index - opaque cookie to identify the sender
3273     @param context - sender context, to match reply w/ request
3274     @param index - MAP Domain index
3275 */
3276 define map_del_domain {
3277   u32 client_index;
3278   u32 context;
3279   u32 index;
3280 };
3281
3282 /** \brief Reply for MAP domain del
3283     @param context - returned sender context, to match reply w/ request
3284     @param retval - return code
3285 */
3286 define map_del_domain_reply {
3287   u32 context;
3288   i32 retval;
3289 };
3290
3291 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3292     @param client_index - opaque cookie to identify the sender
3293     @param context - sender context, to match reply w/ request
3294     @param index - MAP Domain index
3295     @param is_add - If 1 add rule, if 0 delete rule
3296     @param ip6_dst - MAP CE IPv6 address
3297     @param psid - Rule PSID
3298 */
3299 define map_add_del_rule {
3300   u32 client_index;
3301   u32 context;
3302   u32 index;
3303   u32 is_add;
3304   u8 ip6_dst[16];
3305   u16 psid;
3306 };
3307
3308 /** \brief Reply for MAP rule add/del
3309     @param context - returned sender context, to match reply w/ request
3310     @param retval - return code
3311 */
3312 define map_add_del_rule_reply {
3313   u32 context;
3314   i32 retval;
3315 };
3316
3317 /** \brief Get list of map domains
3318     @param client_index - opaque cookie to identify the sender
3319 */
3320 define map_domain_dump {
3321   u32 client_index;
3322   u32 context;
3323 };
3324
3325 manual_java define map_domain_details {
3326   u32 context;
3327   u32 domain_index;
3328   u8 ip6_prefix[16];
3329   u8 ip4_prefix[4];
3330   u8 ip6_src[16];
3331   u8 ip6_prefix_len;
3332   u8 ip4_prefix_len;
3333   u8 ip6_src_len;
3334   u8 ea_bits_len;
3335   u8 psid_offset;
3336   u8 psid_length;
3337   u8 flags;
3338   u16 mtu;
3339   u8 is_translation;
3340 };
3341
3342 define map_rule_dump {
3343   u32 client_index;
3344   u32 context;
3345   u32 domain_index;
3346 };
3347
3348 manual_java define map_rule_details {
3349   u32 context;
3350   u8 ip6_dst[16];
3351   u16 psid;
3352 };
3353
3354 /** \brief Request for a single block of summary stats
3355     @param client_index - opaque cookie to identify the sender
3356     @param context - sender context, to match reply w/ request
3357 */
3358 define map_summary_stats {
3359     u32 client_index;
3360     u32 context;
3361 };
3362
3363 /** \brief Reply for map_summary_stats request
3364     @param context - sender context, to match reply w/ request
3365     @param retval - return code for request
3366     @param total_bindings -
3367     @param total_pkts -
3368     @param total_ip4_fragments -
3369     @param total_security_check -
3370 */
3371 define map_summary_stats_reply {
3372     u32 context;
3373     i32 retval;
3374     u64 total_bindings;
3375     u64 total_pkts[2];
3376     u64 total_bytes[2];
3377     u64 total_ip4_fragments;
3378     u64 total_security_check[2];
3379 };
3380
3381 /** \brief cop: enable/disable junk filtration features on an interface
3382     @param client_index - opaque cookie to identify the sender
3383     @param context - sender context, to match reply w/ request
3384     @param sw_if_inded - desired interface
3385     @param enable_disable - 1 => enable, 0 => disable
3386 */
3387
3388 define cop_interface_enable_disable {
3389     u32 client_index;
3390     u32 context;
3391     u32 sw_if_index;
3392     u8 enable_disable;
3393 };
3394
3395 /** \brief cop: interface enable/disable junk filtration reply
3396     @param context - returned sender context, to match reply w/ request
3397     @param retval - return code
3398 */
3399
3400 define cop_interface_enable_disable_reply {
3401     u32 context;
3402     i32 retval;
3403 };
3404
3405 /** \brief cop: enable/disable whitelist filtration features on an interface
3406     Note: the supplied fib_id must match in order to remove the feature!
3407
3408     @param client_index - opaque cookie to identify the sender
3409     @param context - sender context, to match reply w/ request
3410     @param sw_if_index - interface handle, physical interfaces only
3411     @param fib_id - fib identifier for the whitelist / blacklist fib
3412     @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3413     @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3414     @param default_cop -  1 => enable non-ip4, non-ip6 filtration 0=> disable it
3415 */
3416
3417 define cop_whitelist_enable_disable {
3418     u32 client_index;
3419     u32 context;
3420     u32 sw_if_index;
3421     u32 fib_id;
3422     u8 ip4;
3423     u8 ip6;
3424     u8 default_cop;
3425 };
3426
3427 /** \brief cop: interface enable/disable junk filtration reply
3428     @param context - returned sender context, to match reply w/ request
3429     @param retval - return code
3430 */
3431
3432 define cop_whitelist_enable_disable_reply {
3433     u32 context;
3434     i32 retval;
3435 };
3436
3437 /** \brief get_node_graph - get a copy of the vpp node graph
3438     including the current set of graph arcs.
3439
3440     @param client_index - opaque cookie to identify the sender
3441     @param context - sender context, to match reply w/ request
3442 */
3443
3444 define get_node_graph {
3445     u32 client_index;
3446     u32 context;
3447 };
3448
3449 /** \brief get_node_graph_reply
3450     @param context - returned sender context, to match reply w/ request
3451     @param retval - return code
3452     @param reply_in_shmem - result from vlib_node_serialize, in shared
3453     memory. Process with vlib_node_unserialize, remember to switch
3454     heaps and free the result.
3455 */
3456
3457 define get_node_graph_reply {
3458     u32 context;
3459     i32 retval;
3460     u64 reply_in_shmem;
3461 };
3462
3463 /** \brief Clear interface statistics
3464     @param client_index - opaque cookie to identify the sender
3465     @param context - sender context, to match reply w/ request
3466     @param sw_if_index - index of the interface to clear statistics
3467 */
3468 define sw_interface_clear_stats {
3469     u32 client_index;
3470     u32 context;
3471     u32 sw_if_index;
3472 };
3473
3474 /** \brief Reply to sw_interface_clear_stats
3475     @param context - sender context which was passed in the request
3476     @param retval - return code of the set flags request
3477 */
3478 define sw_interface_clear_stats_reply {
3479     u32 context;
3480     i32 retval;
3481 };
3482
3483 /** \brief IOAM Trace : Set TRACE profile
3484     @param id - profile id
3485     @param trace_type - Trace type
3486     @param trace_num_elt - Number of nodes in trace path
3487     @param trace_ppc - Trace PPC (none/encap/decap)
3488     @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3489     @param trace_app_data - Trace application data, can be any 4 bytes
3490     @param pow_enable - Proof of Work enabled or not flag
3491     @param node_id - Id of this node
3492 */
3493 define trace_profile_add {
3494   u32 client_index;
3495   u32 context;
3496   u16 id;
3497   u8  trace_type;
3498   u8  trace_num_elt;
3499   u8  trace_ppc;
3500   u8  trace_tsp;
3501   u32 trace_app_data;
3502   u8  pow_enable;
3503   u32 node_id;
3504 };
3505
3506 /** \brief Trace profile add / del response
3507     @param context - sender context, to match reply w/ request
3508     @param retval - return value for request
3509 */
3510 define trace_profile_add_reply {
3511     u32 context;
3512     i32 retval;
3513 };
3514
3515 /** \brief IOAM Trace enable trace profile for a flow
3516     @param id - id of the trace profile to be applied
3517     @param dest_ipv6 - Destination IPv6 address
3518     @param prefix_length - prefix mask
3519     @param vrf_id - VRF ID
3520     @param trace_op - Trace operation (add/mod/del)
3521     @param enable - apply/remove the trace profile for the flow
3522 */
3523 define trace_profile_apply {
3524   u32 client_index;
3525   u32 context;
3526   u16 id;
3527   u8 dest_ipv6[16];
3528   u32 prefix_length;
3529   u32 vrf_id;
3530   u8 trace_op;
3531   u8 enable;
3532 };
3533
3534 /** \brief Trace profile apply response
3535     @param context - sender context, to match reply w/ request
3536     @param retval - return value for request
3537 */
3538 define trace_profile_apply_reply {
3539   u32 context;
3540   i32 retval;
3541 };
3542
3543 /** \brief Delete Trace Profile
3544     @param client_index - opaque cookie to identify the sender
3545     @param context - sender context, to match reply w/ request
3546     @param index - MAP Domain index
3547 */
3548 define trace_profile_del {
3549   u32 client_index;
3550   u32 context;
3551   u16 id;
3552 };
3553
3554 /** \brief Trace profile add / del response
3555     @param context - sender context, to match reply w/ request
3556     @param retval - return value for request
3557 */
3558 define trace_profile_del_reply {
3559     u32 context;
3560     i32 retval;
3561 };
3562
3563 /** \brief Create host-interface
3564     @param client_index - opaque cookie to identify the sender
3565     @param context - sender context, to match reply w/ request
3566     @param host_if_name - interface name
3567     @param hw_addr - interface MAC
3568     @param use_random_hw_addr - use random generated MAC
3569 */
3570 define af_packet_create {
3571     u32 client_index;
3572     u32 context;
3573
3574     u8 host_if_name[64];
3575     u8 hw_addr[6];
3576     u8 use_random_hw_addr;
3577 };
3578
3579 /** \brief Create host-interface response
3580     @param context - sender context, to match reply w/ request
3581     @param retval - return value for request
3582 */
3583 define af_packet_create_reply {
3584     u32 context;
3585     i32 retval;
3586     u32 sw_if_index;
3587 };
3588
3589 /** \brief Delete host-interface
3590     @param client_index - opaque cookie to identify the sender
3591     @param context - sender context, to match reply w/ request
3592     @param host_if_name - interface name
3593 */
3594 define af_packet_delete {
3595     u32 client_index;
3596     u32 context;
3597
3598     u8 host_if_name[64];
3599 };
3600
3601 /** \brief Delete host-interface response
3602     @param context - sender context, to match reply w/ request
3603     @param retval - return value for request
3604 */
3605 define af_packet_delete_reply {
3606     u32 context;
3607     i32 retval;
3608 };
3609
3610 /** \brief Add/del policer
3611     @param client_index - opaque cookie to identify the sender
3612     @param context - sender context, to match reply w/ request
3613     @param is_add - add policer if non-zero, else delete
3614     @param name - policer name
3615     @param cir - CIR
3616     @param eir - EIR
3617     @param cb - Committed Burst
3618     @param eb - Excess or Peak Burst
3619     @param rate_type - rate type
3620     @param round_type - rounding type
3621     @param type - policer algorithm
3622     @param conform_action_type - conform action type
3623     @param conform_dscp - DSCP for conform mar-and-transmit action
3624     @param exceed_action_type - exceed action type
3625     @param exceed_dscp - DSCP for exceed mar-and-transmit action
3626     @param violate_action_type - violate action type
3627     @param violate_dscp - DSCP for violate mar-and-transmit action
3628 */
3629 define policer_add_del {
3630     u32 client_index;
3631     u32 context;
3632
3633     u8 is_add;
3634     u8 name[64];
3635     u32 cir;
3636     u32 eir;
3637     u64 cb;
3638     u64 eb;
3639     u8 rate_type;
3640     u8 round_type;
3641     u8 type;
3642     u8 conform_action_type;
3643     u8 conform_dscp;
3644     u8 exceed_action_type;
3645     u8 exceed_dscp;
3646     u8 violate_action_type;
3647     u8 violate_dscp;
3648 };
3649
3650 /** \brief Add/del policer response
3651     @param context - sender context, to match reply w/ request
3652     @param retval - return value for request
3653 */
3654 define policer_add_del_reply {
3655     u32 context;
3656     i32 retval;
3657 };
3658
3659 /** \brief Get list of policers
3660     @param client_index - opaque cookie to identify the sender
3661     @param context - sender context, to match reply w/ request
3662     @param match_name_valid - if 0 request all policers otherwise use match_name
3663     @param match_name - policer name
3664 */
3665 define policer_dump {
3666     u32 client_index;
3667     u32 context;
3668
3669     u8 match_name_valid;
3670     u8 match_name[64];
3671 };
3672
3673 /** \brief Policer operational state response.
3674     @param context - sender context, to match reply w/ request
3675     @param name - policer name
3676     @param cir - CIR
3677     @param eir - EIR
3678     @param cb - Committed Burst
3679     @param eb - Excess or Peak Burst
3680     @param rate_type - rate type
3681     @param round_type - rounding type
3682     @param type - policer algorithm
3683     @param conform_action_type - conform action type
3684     @param conform_dscp - DSCP for conform mar-and-transmit action
3685     @param exceed_action_type - exceed action type
3686     @param exceed_dscp - DSCP for exceed mar-and-transmit action
3687     @param violate_action_type - violate action type
3688     @param violate_dscp - DSCP for violate mar-and-transmit action
3689     @param single_rate - 1 = single rate policer, 0 = two rate policer
3690     @param color_aware - for hierarchical policing
3691     @param scale - power-of-2 shift amount for lower rates
3692     @param cir_tokens_per_period - number of tokens for each period
3693     @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3694     @param current_limit - current limit
3695     @param current_bucket - current bucket
3696     @param extended_limit - extended limit
3697     @param extended_bucket - extended bucket
3698     @param last_update_time - last update time
3699 */
3700 manual_java define policer_details {
3701     u32 context;
3702
3703     u8 name[64];
3704     u32 cir;
3705     u32 eir;
3706     u64 cb;
3707     u64 eb;
3708     u8 rate_type;
3709     u8 round_type;
3710     u8 type;
3711     u8 conform_action_type;
3712     u8 conform_dscp;
3713     u8 exceed_action_type;
3714     u8 exceed_dscp;
3715     u8 violate_action_type;
3716     u8 violate_dscp;
3717     u8 single_rate;
3718     u8 color_aware;
3719     u32 scale;
3720     u32 cir_tokens_per_period;
3721     u32 pir_tokens_per_period;
3722     u32 current_limit;
3723     u32 current_bucket;
3724     u32 extended_limit;
3725     u32 extended_bucket;
3726     u64 last_update_time;
3727 };
3728
3729 /** \brief Create netmap
3730     @param client_index - opaque cookie to identify the sender
3731     @param context - sender context, to match reply w/ request
3732     @param netmap_if_name - interface name
3733     @param hw_addr - interface MAC
3734     @param use_random_hw_addr - use random generated MAC
3735     @param is_pipe - is pipe
3736     @param is_master - 0=slave, 1=master
3737 */
3738 define netmap_create {
3739     u32 client_index;
3740     u32 context;
3741
3742     u8 netmap_if_name[64];
3743     u8 hw_addr[6];
3744     u8 use_random_hw_addr;
3745     u8 is_pipe;
3746     u8 is_master;
3747 };
3748
3749 /** \brief Create netmap response
3750     @param context - sender context, to match reply w/ request
3751     @param retval - return value for request
3752 */
3753 define netmap_create_reply {
3754     u32 context;
3755     i32 retval;
3756 };
3757
3758 /** \brief Delete netmap
3759     @param client_index - opaque cookie to identify the sender
3760     @param context - sender context, to match reply w/ request
3761     @param netmap_if_name - interface name
3762 */
3763 define netmap_delete {
3764     u32 client_index;
3765     u32 context;
3766
3767     u8 netmap_if_name[64];
3768 };
3769
3770 /** \brief Delete netmap response
3771     @param context - sender context, to match reply w/ request
3772     @param retval - return value for request
3773 */
3774 define netmap_delete_reply {
3775     u32 context;
3776     i32 retval;
3777 };
3778
3779 /** \brief Dump mpls gre tunnel table
3780     @param client_index - opaque cookie to identify the sender
3781     @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
3782 */
3783 define mpls_gre_tunnel_dump {
3784     u32 client_index;
3785     u32 context;
3786     i32 tunnel_index;
3787 };
3788
3789 /** \brief mpls gre tunnel operational state response
3790     @param tunnel_index - gre tunnel identifier
3791     @param intfc_address - interface ipv4 addr
3792     @param mask_width - interface ipv4 addr mask
3793     @param hw_if_index - interface id
3794     @param l2_only -
3795     @param tunnel_src - tunnel source ipv4 addr
3796     @param tunnel_dst - tunnel destination ipv4 addr
3797     @param outer_fib_index - gre tunnel identifier
3798     @param encap_index - reference to mpls label table
3799     @param nlabels - number of resolved labels
3800     @param labels - resolved labels
3801 */
3802 manual_java define mpls_gre_tunnel_details {
3803     u32 context;
3804     u32 tunnel_index;
3805
3806     u32 intfc_address;
3807     u32 inner_fib_index;
3808     u32 mask_width;
3809     u32 encap_index;
3810     u32 hw_if_index;
3811     u8  l2_only;
3812     u32 tunnel_src;
3813     u32 tunnel_dst;
3814     u32 outer_fib_index;
3815     u32 nlabels;
3816     u32 labels[0];
3817 };
3818
3819 /** \brief Dump mpls eth tunnel table
3820     @param client_index - opaque cookie to identify the sender
3821     @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
3822 */
3823 define mpls_eth_tunnel_dump {
3824     u32 client_index;
3825     u32 context;
3826     i32 tunnel_index;
3827 };
3828
3829 /** \brief mpls eth tunnel operational state response
3830     @param tunnel_index - eth tunnel identifier
3831     @param intfc_address - interface ipv4 addr
3832     @param mask_width - interface ipv4 addr mask
3833     @param hw_if_index - interface id
3834     @param l2_only -
3835     @param tunnel_dst_mac -
3836     @param tx_sw_if_index -
3837     @param encap_index - reference to mpls label table
3838     @param nlabels - number of resolved labels
3839     @param labels - resolved labels
3840 */
3841 manual_java define mpls_eth_tunnel_details {
3842     u32 context;
3843     u32 tunnel_index;
3844
3845     u32 intfc_address;
3846     u32 inner_fib_index;
3847     u32 mask_width;
3848     u32 encap_index;
3849     u32 hw_if_index;
3850     u8  l2_only;
3851     u8  tunnel_dst_mac[6];
3852     u32 tx_sw_if_index;
3853     u32 nlabels;
3854     u32 labels[0];
3855 };
3856
3857 /** \brief Dump mpls fib table
3858     @param client_index - opaque cookie to identify the sender
3859     @param fib_index    - mpls fib entry identifier or -1 in case of all entries
3860 */
3861 define mpls_fib_encap_dump {
3862     u32 client_index;
3863     u32 context;
3864 };
3865
3866 /** \brief mpls fib encap table response
3867     @param fib_index - fib table id
3868     @param dest - destination ipv4 addr
3869     @param s_bit -
3870     @param entry_index - reference to mpls label table
3871     @param nlabels - number of resolved labels
3872     @param labels - resolved labels
3873 */
3874 manual_java define mpls_fib_encap_details {
3875     u32 context;
3876
3877     u32 fib_index;
3878     u32 entry_index;
3879     u32 dest;
3880     u32 s_bit;
3881     u32 nlabels;
3882     u32 labels[0];
3883 };
3884
3885 /** \brief Dump mpls fib decap table
3886     @param client_index - opaque cookie to identify the sender
3887     @param fib_index    - mpls fib entry identifier or -1 in case of all entries
3888 */
3889 define mpls_fib_decap_dump {
3890     u32 client_index;
3891     u32 context;
3892 };
3893
3894 /** \brief mpls fib decap table response
3895     @param fib_index - fib table id
3896     @param entry_index - reference to mpls label table
3897     @param dest - destination ipv4 addr
3898     @param s_bit -
3899     @param label - mpls labels
3900     @param rx_table_id - rx fib id
3901     @param tx_table_id - tx fib id
3902     @param swif_tag -
3903 */
3904 manual_java define mpls_fib_decap_details {
3905     u32 context;
3906
3907     u32 fib_index;
3908     u32 entry_index;
3909     u32 dest;
3910     u32 s_bit;
3911     u32 label;
3912     u32 rx_table_id;
3913     u32 tx_table_id;
3914     u8  swif_tag[8];
3915 };
3916
3917 /** \brief Classify get table IDs request
3918     @param client_index - opaque cookie to identify the sender
3919     @param context - sender context, to match reply w/ request
3920 */
3921 define classify_table_ids {
3922     u32 client_index;
3923     u32 context;
3924 };
3925
3926 /** \brief Reply for classify get table IDs request
3927     @param context - sender context which was passed in the request
3928     @param count - number of ids returned in response
3929     @param ids - array of classify table ids
3930 */
3931 manual_java define classify_table_ids_reply {
3932     u32 context;
3933     i32 retval;
3934     u32 count;
3935     u32 ids[count];
3936 };
3937
3938 /** \brief Classify table ids by interface index request
3939     @param client_index - opaque cookie to identify the sender
3940     @param context - sender context, to match reply w/ request
3941     @param sw_if_index - index of the interface
3942 */
3943 define classify_table_by_interface {
3944     u32 client_index;
3945     u32 context;
3946     u32 sw_if_index;
3947 };
3948
3949 /** \brief Reply for classify table id by interface index request
3950     @param context - sender context which was passed in the request
3951     @param count - number of ids returned in response
3952     @param sw_if_index - index of the interface
3953     @param l2_table_id - l2 classify table index
3954     @param ip4_table_id - ip4 classify table index
3955     @param ip6_table_id - ip6 classify table index
3956 */
3957 manual_java define classify_table_by_interface_reply {
3958     u32 context;
3959     i32 retval;
3960     u32 sw_if_index;
3961     u32 l2_table_id;
3962     u32 ip4_table_id;
3963     u32 ip6_table_id;
3964 };
3965
3966 /** \brief Classify table info
3967     @param client_index - opaque cookie to identify the sender
3968     @param context - sender context, to match reply w/ request
3969     @param table_id - classify table index
3970 */
3971 define classify_table_info {
3972     u32 client_index;
3973     u32 context;
3974     u32 table_id;
3975 };
3976
3977 /** \brief Reply for classify table info request
3978     @param context - sender context which was passed in the request
3979     @param count - number of ids returned in response
3980     @param table_id - classify table index
3981     @param nbuckets - number of buckets when adding a table
3982     @param match_n_vectors - number of match vectors
3983     @param skip_n_vectors - number of skip_n_vectors
3984     @param active_sessions - number of sessions (active entries)
3985     @param next_table_index - index of next table
3986     @param miss_next_index - index of miss table
3987     @param mask[] - match mask
3988 */
3989 manual_java define classify_table_info_reply {
3990     u32 context;
3991     i32 retval;
3992     u32 table_id;
3993     u32 nbuckets;
3994     u32 match_n_vectors;
3995     u32 skip_n_vectors;
3996     u32 active_sessions;
3997     u32 next_table_index;
3998     u32 miss_next_index;
3999     u32 mask_length;
4000     u8  mask[mask_length];
4001 };
4002
4003 /** \brief Classify sessions dump request
4004     @param client_index - opaque cookie to identify the sender
4005     @param context - sender context, to match reply w/ request
4006     @param table_id - classify table index
4007 */
4008 define classify_session_dump {
4009     u32 client_index;
4010     u32 context;
4011     u32 table_id;
4012 };
4013
4014 /** \brief Reply for classify table session dump request
4015     @param context - sender context which was passed in the request
4016     @param count - number of ids returned in response
4017     @param table_id - classify table index
4018     @param hit_next_index - hit_next_index of session
4019     @param opaque_index - for add, opaque_index of session
4020     @param advance - advance value of session
4021     @param match[] - match value for session
4022 */
4023 manual_java define classify_session_details {
4024     u32 context;
4025     i32 retval;
4026     u32 table_id;
4027     u32 hit_next_index;
4028     i32 advance;
4029     u32 opaque_index;
4030     u32 match_length;
4031     u8 match[match_length];
4032 };
4033
4034 /** \brief Enable and configure IPFIX exporter process request
4035     @param client_index - opaque cookie to identify the sender
4036     @param context - sender context, to match reply w/ request
4037     @param collector_address - address of IPFIX collector
4038     @param collector_port - port of IPFIX IPFIX collector
4039     @param src_address - address of IPFIX exporter
4040     @param vrf_id - VRF / fib table ID
4041     @param path_mtu - Path MTU between exporter and collector
4042     @param template_interval - number of seconds after which to resend template
4043 */
4044 define ipfix_enable {
4045     u32 client_index;
4046     u32 context;
4047     u8 collector_address[16];
4048     u16 collector_port;
4049     u8 src_address[16];
4050     u32 vrf_id;
4051     u32 path_mtu;
4052     u32 template_interval;
4053 };
4054
4055 /** \brief Reply to IPFIX enable and configure request
4056     @param context - sender context which was passed in the request
4057 */
4058 define ipfix_enable_reply {
4059     u32 context;
4060     i32 retval;
4061 };
4062
4063 /** \brief IPFIX dump request
4064     @param client_index - opaque cookie to identify the sender
4065     @param context - sender context, to match reply w/ request
4066 */
4067 define ipfix_dump {
4068     u32 client_index;
4069     u32 context;
4070 };
4071
4072 /** \brief Reply to IPFIX dump request
4073     @param context - sender context which was passed in the request
4074     @param collector_address - address of IPFIX collector
4075     @param collector_port - port of IPFIX IPFIX collector
4076     @param src_address - address of IPFIX exporter
4077     @param fib_index - fib table index
4078     @param path_mtu - Path MTU between exporter and collector
4079     @param template_interval - number of seconds after which to resend template
4080 */
4081 manual_java define ipfix_details {
4082     u32 context;
4083     u8 collector_address[16];
4084     u16 collector_port;
4085     u8 src_address[16];
4086     u32 fib_index;
4087     u32 path_mtu;
4088     u32 template_interval;
4089 };
4090
4091 /** \brief Query relative index via node names
4092     @param client_index - opaque cookie to identify the sender
4093     @param context - sender context, to match reply w/ request
4094     @param node_name - name of node to find relative index from
4095     @param next_name - next node from node_name to find relative index of
4096 */
4097 define get_next_index {
4098     u32 client_index;
4099     u32 context;
4100     u8 node_name[64];
4101     u8 next_name[64];
4102 };
4103
4104 /** \brief Reply for get next node index
4105     @param context - sender context which was passed in the request
4106     @param retval - return value
4107     @param next_index - index of the next_node
4108 */
4109 define get_next_index_reply {
4110     u32 context;
4111     i32 retval;
4112     u32 next_index;
4113 };