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[0];
 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[0];
 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 surpress -
 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 surpress;
 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     u32 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 };
1396
1397 /** \brief L2 FIB add entry response
1398     @param context - sender context, to match reply w/ request
1399     @param retval - return code for the add l2fib entry request
1400 */
1401 define l2fib_add_del_reply {
1402     u32 context;
1403     i32 retval;
1404 };
1405
1406 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1407     @param client_index - opaque cookie to identify the sender
1408     @param context - sender context, to match reply w/ request
1409     @param sw_if_index - interface
1410     @param is_set - if non-zero, set the bits, else clear them
1411     @param feature_bitmap - non-zero bits to set or clear
1412 */
1413 define l2_flags {
1414     u32 client_index;
1415     u32 context;
1416     u32 sw_if_index;
1417     u8 is_set;
1418     u32 feature_bitmap;
1419 };
1420
1421 /** \brief Set L2 bits response
1422     @param context - sender context, to match reply w/ request
1423     @param retval - return code for the set l2 bits request
1424 */
1425 define l2_flags_reply {
1426     u32 context;
1427     u32 retval;
1428     u32 resulting_feature_bitmap;
1429 };
1430
1431 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1432     L2_UU_FLOOD, or L2_ARP_TERM) request
1433     @param client_index - opaque cookie to identify the sender
1434     @param context - sender context, to match reply w/ request
1435     @param bd_id - the bridge domain to set the flags for
1436     @param is_set - if non-zero, set the flags, else clear them
1437     @param feature_bitmap - bits that are non-zero to set or clear
1438 */
1439 define bridge_flags {
1440     u32 client_index;
1441     u32 context;
1442     u32 bd_id;
1443     u8 is_set;
1444     u32 feature_bitmap;
1445 };
1446
1447 /** \brief Set bridge flags response
1448     @param context - sender context, to match reply w/ request
1449     @param retval - return code for the set bridge flags request
1450     @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1451 */
1452 define bridge_flags_reply {
1453     u32 context;
1454     u32 retval;
1455     u32 resulting_feature_bitmap;
1456 };
1457
1458 /** \brief Set bridge domain ip to mac entry request
1459     @param client_index - opaque cookie to identify the sender
1460     @param context - sender context, to match reply w/ request
1461     @param bd_id - the bridge domain to set the flags for
1462     @param is_add - if non-zero, add the entry, else clear it
1463     @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1464     @param mac_address - MAC address
1465     @param
1466 */
1467 define bd_ip_mac_add_del {
1468     u32 client_index;
1469     u32 context;
1470     u32 bd_id;
1471     u8 is_add;
1472     u8 is_ipv6;
1473     u8 ip_address[16];
1474     u8 mac_address[6];
1475 };
1476
1477 /** \brief Set bridge domain ip to mac entry response
1478     @param context - sender context, to match reply w/ request
1479     @param retval - return code for the set bridge flags request
1480 */
1481 define bd_ip_mac_add_del_reply {
1482     u32 context;
1483     u32 retval;
1484 };
1485
1486 /** \brief Add/Delete classification table request
1487     @param client_index - opaque cookie to identify the sender
1488     @param context - sender context, to match reply w/ request
1489     @param is_add- if non-zero add the table, else delete it
1490     @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1491     @param nbuckets - number of buckets when adding a table
1492     @param memory_size - memory size when adding a table
1493     @param match_n_vectors - number of match vectors
1494     @param next_table_index - index of next table
1495     @param miss_next_index - index of miss table
1496     @param mask[] - match mask
1497 */
1498 define classify_add_del_table {
1499     u32 client_index;
1500     u32 context;
1501     u8  is_add;
1502     u32 table_index;
1503     u32 nbuckets;
1504     u32 memory_size;
1505     u32 skip_n_vectors;
1506     u32 match_n_vectors;
1507     u32 next_table_index;
1508     u32 miss_next_index;
1509     u8 mask[0];
1510 };
1511
1512 /** \brief Add/Delete classification table response
1513     @param context - sender context, to match reply w/ request
1514     @param retval - return code for the table add/del requst
1515     @param new_table_index - for add, returned index of the new table
1516     @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1517     @param match_n_vectors -for add, returned value of match_n_vectors in table
1518 */
1519 define classify_add_del_table_reply {
1520     u32 context;
1521     i32 retval;
1522     u32 new_table_index;
1523     u32 skip_n_vectors;
1524     u32 match_n_vectors;
1525 };
1526
1527 /** \brief Classify add / del session request
1528     @param client_index - opaque cookie to identify the sender
1529     @param context - sender context, to match reply w/ request
1530     @param is_add - add session if non-zero, else delete
1531     @param table_index - index of the table to add/del the session, required
1532     @param hit_next_index - for add, hit_next_index of new session, required
1533     @param opaque_index - for add, opaque_index of new session
1534     @param advance -for add, advance value for session
1535     @param match[] - for add, match value for session, required
1536 */
1537 define classify_add_del_session {
1538     u32 client_index;
1539     u32 context;
1540     u8  is_add;
1541     u32 table_index;
1542     u32 hit_next_index;
1543     u32 opaque_index;
1544     i32 advance;
1545     u8 match[0];
1546 };
1547
1548 /** \brief Classify add / del session response
1549     @param context - sender context, to match reply w/ request
1550     @param retval - return code for the add/del session request
1551 */
1552 define classify_add_del_session_reply {
1553     u32 context;
1554     i32 retval;
1555 };
1556
1557 /** \brief Set/unset the classification table for an interface request
1558     @param client_index - opaque cookie to identify the sender
1559     @param context - sender context, to match reply w/ request
1560     @param is_ipv6 - ipv6 if non-zero, else ipv4
1561     @param sw_if_index - interface to associate with the table
1562     @param table_index - index of the table, if ~0 unset the table
1563 */
1564 define classify_set_interface_ip_table {
1565     u32 client_index;
1566     u32 context;
1567     u8 is_ipv6;
1568     u32 sw_if_index;
1569     u32 table_index;            /* ~0 => off */
1570 };
1571
1572 /** \brief Set/unset interface classification table response
1573     @param context - sender context, to match reply w/ request
1574     @param retval - return code
1575 */
1576 define classify_set_interface_ip_table_reply {
1577     u32 context;
1578     i32 retval;
1579 };
1580
1581 /** \brief Set/unset l2 classification tables for an interface request
1582     @param client_index - opaque cookie to identify the sender
1583     @param context - sender context, to match reply w/ request
1584     @param sw_if_index - interface to set/unset tables for
1585     @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1586     @param ip6_table_index - ip6 index
1587     @param other_table_index - other index
1588 */
1589 define classify_set_interface_l2_tables {
1590     u32 client_index;
1591     u32 context;
1592     u32 sw_if_index;
1593     /* 3 x ~0 => off */
1594     u32 ip4_table_index;
1595     u32 ip6_table_index;
1596     u32 other_table_index;
1597 };
1598
1599 /** \brief Set/unset l2 classification tables for an interface response
1600     @param context - sender context, to match reply w/ request
1601     @param retval - return code for the request
1602 */
1603 define classify_set_interface_l2_tables_reply {
1604     u32 context;
1605     i32 retval;
1606 };
1607
1608 /** \brief Get node index using name request
1609     @param client_index - opaque cookie to identify the sender
1610     @param context - sender context, to match reply w/ request
1611     @param node_name[] - name of the node
1612 */
1613 define get_node_index {
1614     u32 client_index;
1615     u32 context;
1616     u8 node_name[64];
1617 };
1618
1619 /** \brief Get node index using name request
1620     @param context - sender context, to match reply w/ request
1621     @param retval - return code for the request
1622     @param node_index - index of the desired node if found, else ~0
1623 */
1624 define get_node_index_reply {
1625     u32 context;
1626     i32 retval;
1627     u32 node_index;
1628 };
1629
1630 /** \brief Set the next node for a given node request
1631     @param client_index - opaque cookie to identify the sender
1632     @param context - sender context, to match reply w/ request
1633     @param node_name[] - node to add the next node to
1634     @param next_name[] - node to add as the next node
1635 */
1636 define add_node_next {
1637     u32 client_index;
1638     u32 context;
1639     u8 node_name[64];
1640     u8 next_name[64];
1641 };
1642
1643 /** \brief IP Set the next node for a given node response
1644     @param context - sender context, to match reply w/ request
1645     @param retval - return code for the add next node request
1646     @param next_index - the index of the next node if success, else ~0
1647 */
1648 define add_node_next_reply {
1649     u32 context;
1650     i32 retval;
1651     u32 next_index;
1652 };
1653
1654 /** \brief DHCP Proxy config 2 add / del request
1655     @param client_index - opaque cookie to identify the sender
1656     @param context - sender context, to match reply w/ request
1657     @param rx_vrf_id - receive vrf id
1658     @param server_vrf_id - server vrf id
1659     @param if_ipv6 - ipv6 if non-zero, else ipv4
1660     @param is_add - add the config if non-zero, else delete
1661     @param insert_circuit_id - option82 suboption 1 fib number
1662     @param dhcp_server[] - server address
1663     @param dhcp_src_address[] - <fix this, need details>
1664 */
1665 define dhcp_proxy_config_2 {
1666     u32 client_index;
1667     u32 context;
1668     u32 rx_vrf_id;
1669     u32 server_vrf_id;
1670     u8 is_ipv6;
1671     u8 is_add;
1672     u8 insert_circuit_id;
1673     u8 dhcp_server[16];
1674     u8 dhcp_src_address[16];
1675 };
1676
1677 /** \brief DHCP Proxy config 2 add / del response
1678     @param context - sender context, to match reply w/ request
1679     @param retval - return code for request
1680 */
1681 define dhcp_proxy_config_2_reply {
1682     u32 context;
1683     i32 retval;
1684 };
1685
1686 /** \brief l2tpv3 tunnel interface create request
1687     @param client_index - opaque cookie to identify the sender
1688     @param context - sender context, to match reply w/ request
1689     @param client_address - remote client tunnel ip address
1690     @param client_address - local tunnel ip address
1691     @param is_ipv6 - ipv6 if non-zero, else ipv4
1692     @param local_session_id - local tunnel session id
1693     @param remote_session_id - remote tunnel session id
1694     @param local_cookie - local tunnel cookie
1695     @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1696 */
1697 define l2tpv3_create_tunnel {
1698     u32 client_index;
1699     u32 context;
1700     u8 client_address [16];
1701     u8 our_address [16];
1702     u8 is_ipv6;
1703     u32 local_session_id;
1704     u32 remote_session_id;
1705     u64 local_cookie;
1706     u64 remote_cookie;
1707     u8 l2_sublayer_present;
1708 };
1709
1710 /** \brief l2tpv3 tunnel interface create response
1711     @param context - sender context, to match reply w/ request
1712     @param retval - return code for the request
1713     @param sw_if_index - index of the new tunnel interface
1714 */
1715 define l2tpv3_create_tunnel_reply {
1716     u32 context;
1717     i32 retval;
1718     u32 sw_if_index;
1719 };
1720
1721 define l2tpv3_set_tunnel_cookies {
1722     u32 client_index;
1723     u32 context;
1724     u32 sw_if_index;
1725     u64 new_local_cookie;
1726     u64 new_remote_cookie;
1727 };
1728
1729 /** \brief L2TP tunnel set cookies response
1730     @param context - sender context, to match reply w/ request
1731     @param retval - return code for the request
1732 */
1733 define l2tpv3_set_tunnel_cookies_reply {
1734     u32 context;
1735     i32 retval;
1736 };
1737
1738 manual_java define sw_if_l2tpv3_tunnel_details {
1739     u32 context;
1740     u32 sw_if_index;
1741     u8 interface_name[64];
1742     u8 client_address [16];
1743     u8 our_address [16];
1744     u32 local_session_id;
1745     u32 remote_session_id;
1746     u64 local_cookie[2];
1747     u64 remote_cookie;
1748     u8 l2_sublayer_present;
1749 };
1750
1751 define sw_if_l2tpv3_tunnel_dump {
1752     u32 client_index;
1753     u32 context;
1754 };
1755
1756 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1757     @param client_index - opaque cookie to identify the sender
1758     @param context - sender context, to match reply w/ request
1759 */
1760 define l2_fib_clear_table {
1761     u32 client_index;
1762     u32 context;
1763 };
1764
1765 /** \brief L2 fib clear table response
1766     @param context - sender context, to match reply w/ request
1767     @param retval - return code for the request
1768 */
1769 define l2_fib_clear_table_reply {
1770     u32 context;
1771     i32 retval;
1772 };
1773
1774 /** \brief L2 interface ethernet flow point filtering enable/disable request
1775     @param client_index - opaque cookie to identify the sender
1776     @param context - sender context, to match reply w/ request
1777     @param sw_if_index - interface to enable/disable filtering on
1778     @param enable_disable - if non-zero enable filtering, else disable
1779 */
1780 define l2_interface_efp_filter {
1781     u32 client_index;
1782     u32 context;
1783     u32 sw_if_index;
1784     u32 enable_disable;
1785 };
1786
1787 /** \brief L2 interface ethernet flow point filtering response
1788     @param context - sender context, to match reply w/ request
1789     @param retval - return code for the request
1790 */
1791 define l2_interface_efp_filter_reply {
1792     u32 context;
1793     i32 retval;
1794 };
1795
1796 define l2tpv3_interface_enable_disable {
1797     u32 client_index;
1798     u32 context;
1799     u8 enable_disable;
1800     u32 sw_if_index;
1801 };
1802
1803 define l2tpv3_interface_enable_disable_reply {
1804     u32 context;
1805     i32 retval;
1806 };
1807
1808 define l2tpv3_set_lookup_key {
1809     u32 client_index;
1810     u32 context;
1811     /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1812     u8 key;
1813 };
1814
1815 define l2tpv3_set_lookup_key_reply {
1816     u32 context;
1817     i32 retval;
1818 };
1819
1820 define vxlan_add_del_tunnel {
1821     u32 client_index;
1822     u32 context;
1823     u8 is_add;
1824     u8 is_ipv6;
1825     u8 src_address[16];
1826     u8 dst_address[16];
1827     u32 encap_vrf_id;
1828     u32 decap_next_index;
1829     u32 vni;
1830 };
1831
1832 define vxlan_add_del_tunnel_reply {
1833     u32 context;
1834     i32 retval;
1835     u32 sw_if_index;
1836 };
1837
1838 manual_java define vxlan_tunnel_dump {
1839     u32 client_index;
1840     u32 context;
1841     u32 sw_if_index;
1842 };
1843
1844 manual_java define vxlan_tunnel_details {
1845     u32 context;
1846     u32 sw_if_index;
1847     u8 src_address[16];
1848     u8 dst_address[16];
1849     u32 encap_vrf_id;
1850     u32 decap_next_index;
1851     u32 vni;
1852     u8 is_ipv6;
1853 };
1854
1855 define gre_add_del_tunnel {
1856     u32 client_index;
1857     u32 context;
1858     u8 is_add;
1859     u32 src_address;
1860     u32 dst_address;
1861     u32 outer_table_id;
1862 };
1863
1864 define gre_add_del_tunnel_reply {
1865     u32 context;
1866     i32 retval;
1867     u32 sw_if_index;
1868 };
1869
1870 manual_java define gre_tunnel_dump {
1871     u32 client_index;
1872     u32 context;
1873     u32 sw_if_index;
1874 };
1875
1876 manual_java define gre_tunnel_details {
1877     u32 context;
1878     u32 sw_if_index;
1879     u32 src_address;
1880     u32 dst_address;
1881     u32 outer_table_id;
1882 };
1883
1884 /** \brief L2 interface vlan tag rewrite configure request
1885     @param client_index - opaque cookie to identify the sender
1886     @param context - sender context, to match reply w/ request
1887     @param sw_if_index - interface the operation is applied to
1888     @param vtr_op - Choose from l2_vtr_op_t enum values
1889     @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1890     @param tag1 - Needed for any push or translate vtr op
1891     @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1892 */
1893 define l2_interface_vlan_tag_rewrite {
1894     u32 client_index;
1895     u32 context;
1896     u32 sw_if_index;
1897     u32 vtr_op;
1898     u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1899     u32 tag1;  // first pushed tag
1900     u32 tag2;  // second pushed tag
1901 };
1902
1903 /** \brief L2 interface vlan tag rewrite response
1904     @param context - sender context, to match reply w/ request
1905     @param retval - return code for the request
1906 */
1907 define l2_interface_vlan_tag_rewrite_reply {
1908     u32 context;
1909     i32 retval;
1910 };
1911
1912 /** \brief vhost-user interface create request
1913     @param client_index - opaque cookie to identify the sender
1914     @param is_server - our side is socket server
1915     @param sock_filename - unix socket filename, used to speak with frontend
1916     @param use_custom_mac - enable or disable the use of the provided hardware address
1917     @param mac_address - hardware address to use if 'use_custom_mac' is set
1918 */
1919 define create_vhost_user_if {
1920    u32 client_index;
1921    u32 context;
1922    u8 is_server;
1923    u8 sock_filename[256];
1924    u8 renumber;
1925    u32 custom_dev_instance;
1926    u8 use_custom_mac;
1927    u8 mac_address[6];
1928 };
1929
1930 /** \brief vhost-user interface create response
1931     @param context - sender context, to match reply w/ request
1932     @param retval - return code for the request
1933     @param sw_if_index - interface the operation is applied to
1934 */
1935 define create_vhost_user_if_reply {
1936    u32 context;
1937    i32 retval;
1938    u32 sw_if_index;
1939 };
1940
1941 /** \brief vhost-user interface modify request
1942     @param client_index - opaque cookie to identify the sender
1943     @param is_server - our side is socket server
1944     @param sock_filename - unix socket filename, used to speak with frontend
1945 */
1946 define modify_vhost_user_if {
1947    u32 client_index;
1948    u32 context;
1949    u32 sw_if_index;
1950    u8 is_server;
1951    u8 sock_filename[256];
1952    u8 renumber;
1953    u32 custom_dev_instance;
1954 };
1955
1956 /** \brief vhost-user interface modify response
1957     @param context - sender context, to match reply w/ request
1958     @param retval - return code for the request
1959 */
1960 define modify_vhost_user_if_reply {
1961    u32 context;
1962    i32 retval;
1963 };
1964
1965 /** \brief vhost-user interface delete request
1966     @param client_index - opaque cookie to identify the sender
1967 */
1968 define delete_vhost_user_if {
1969    u32 client_index;
1970    u32 context;
1971    u32 sw_if_index;
1972 };
1973
1974 /** \brief vhost-user interface delete response
1975     @param context - sender context, to match reply w/ request
1976     @param retval - return code for the request
1977 */
1978 define delete_vhost_user_if_reply {
1979    u32 context;
1980    i32 retval;
1981 };
1982
1983 define create_subif {
1984     u32 client_index;
1985     u32 context;
1986     u32 sw_if_index;
1987     u32 sub_id;
1988
1989     /* These fields map directly onto the subif template */
1990     u8 no_tags;
1991     u8 one_tag;
1992     u8 two_tags;
1993     u8 dot1ad;   // 0 = dot1q, 1=dot1ad
1994     u8 exact_match;
1995     u8 default_sub;
1996     u8 outer_vlan_id_any;
1997     u8 inner_vlan_id_any;
1998     u16 outer_vlan_id;
1999     u16 inner_vlan_id;
2000 };
2001
2002 define create_subif_reply {
2003     u32 context;
2004     i32 retval;
2005     u32 sw_if_index;
2006 };
2007
2008 /** \brief show version
2009     @param client_index - opaque cookie to identify the sender
2010     @param context - sender context, to match reply w/ request
2011 */
2012 define show_version {
2013    u32 client_index;
2014    u32 context;
2015 };
2016
2017 /** \brief show version response
2018     @param context - sender context, to match reply w/ request
2019     @param retval - return code for the request
2020     @param program - name of the program (vpe)
2021     @param version  - version of the program
2022     @param build_directory - root of the workspace where the program was built
2023 */
2024 manual_java define show_version_reply {
2025    u32 context;
2026    i32 retval;
2027    u8 program[32];
2028    u8 version[32];
2029    u8 build_date[32];
2030    u8 build_directory[256];
2031 };
2032
2033 /** \brief Vhost-user interface details structure (fix this)
2034     @param sw_if_index - index of the interface
2035     @param interface_name - name of interface
2036     @param virtio_net_hdr_sz - net header size
2037     @param features - interface features
2038     @param is_server - vhost-user server socket
2039     @param sock_filename - socket filename
2040     @param num_regions - number of used memory regions
2041 */
2042 manual_java define sw_interface_vhost_user_details {
2043     u32 context;
2044     u32 sw_if_index;
2045     u8 interface_name[64];
2046     u32 virtio_net_hdr_sz;
2047     u64 features;
2048     u8 is_server;
2049     u8 sock_filename[256];
2050     u32 num_regions;
2051     i32 sock_errno;
2052 };
2053
2054 /* works */
2055 define sw_interface_vhost_user_dump {
2056     u32 client_index;
2057     u32 context;
2058 };
2059
2060 manual_java define ip_address_details {
2061     u32 client_index;
2062     u32 context;
2063     u8 ip[16];
2064     u8 prefix_length;
2065 };
2066
2067 manual_java define ip_address_dump {
2068     u32 client_index;
2069     u32 context;
2070     u32 sw_if_index;
2071     u8 is_ipv6;
2072 };
2073
2074 manual_java define ip_details {
2075     u32 sw_if_index;
2076     u32 context;
2077 };
2078
2079 define ip_dump {
2080     u32 client_index;
2081     u32 context;
2082     u8 is_ipv6;
2083 };
2084
2085 /** \brief l2 fib table entry structure
2086     @param bd_id - the l2 fib / bridge domain table id
2087     @param mac - the entry's mac address
2088     @param sw_if_index - index of the interface
2089     @param static_mac - the entry is statically configured.
2090     @param filter_mac - the entry is a mac filter entry.
2091     @param bvi_mac - the mac address is a bridge virtual interface
2092 */
2093 manual_java define l2_fib_table_entry {
2094     u32 context;
2095     u32 bd_id;
2096     u64 mac;
2097     u32 sw_if_index;
2098     u8 static_mac;
2099     u8 filter_mac;
2100     u8 bvi_mac;
2101 };
2102
2103 /** \brief Dump l2 fib (aka bridge domain) table
2104     @param client_index - opaque cookie to identify the sender
2105     @param bd_id - the l2 fib / bridge domain table identifier
2106 */
2107 manual_java define l2_fib_table_dump {
2108     u32 client_index;
2109     u32 context;
2110     u32 bd_id;
2111 };
2112
2113 define vxlan_gpe_add_del_tunnel {
2114     u32 client_index;
2115     u32 context;
2116     u8 is_ipv6;
2117     u8 local[16];
2118     u8 remote[16];
2119     u32 encap_vrf_id;
2120     u32 decap_vrf_id;
2121     u8 protocol;
2122     u32 vni;
2123     u8 is_add;
2124 };
2125
2126 define vxlan_gpe_add_del_tunnel_reply {
2127     u32 context;
2128     i32 retval;
2129     u32 sw_if_index;
2130 };
2131
2132 manual_java define vxlan_gpe_tunnel_dump {
2133     u32 client_index;
2134     u32 context;
2135     u32 sw_if_index;
2136 };
2137
2138 manual_java define vxlan_gpe_tunnel_details {
2139     u32 context;
2140     u32 sw_if_index;
2141     u8 local[16];
2142     u8 remote[16];
2143     u32 vni;
2144     u8 protocol;
2145     u32 encap_vrf_id;
2146     u32 decap_vrf_id;
2147     u8 is_ipv6;
2148 };
2149
2150 /** \brief add or delete locator_set
2151     @param client_index - opaque cookie to identify the sender
2152     @param context - sender context, to match reply w/ request
2153     @param is_add - add address if non-zero, else delete
2154     @param locator_set_name - locator name
2155 */
2156 define lisp_add_del_locator_set {
2157     u32 client_index;
2158     u32 context;
2159     u8  is_add;
2160     u8  locator_set_name[64];
2161 };
2162
2163 /** \brief Reply for locator_set add/del
2164     @param context - returned sender context, to match reply w/ request
2165     @param retval - return code
2166 */
2167 define lisp_add_del_locator_set_reply {
2168     u32 context;
2169     i32 retval;
2170 };
2171
2172 /** \brief add or delete locator for locator_set
2173     @param client_index - opaque cookie to identify the sender
2174     @param context - sender context, to match reply w/ request
2175     @param is_add - add address if non-zero, else delete
2176     @param locator_set_name - name of locator_set to add/del locator
2177     @param sw_if_index - index of the interface
2178     @param priority - priority of the lisp locator
2179     @param weight - weight of the lisp locator
2180 */
2181 define lisp_add_del_locator {
2182     u32 client_index;
2183     u32 context;
2184     u8  is_add;
2185     u8  locator_set_name[64];
2186     u32 sw_if_index;
2187     u8  priority;
2188     u8  weight;
2189 };
2190
2191 /** \brief Reply for locator add/del
2192     @param context - returned sender context, to match reply w/ request
2193     @param retval - return code
2194 */
2195 define lisp_add_del_locator_reply {
2196     u32 context;
2197     i32 retval;
2198 };
2199
2200 /** \brief add or delete lisp eid-table
2201     @param client_index - opaque cookie to identify the sender
2202     @param context - sender context, to match reply w/ request
2203     @param is_add - add address if non-zero, else delete
2204     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2205     @param ip_address - array of address bytes
2206     @param prefix_len - prefix len
2207     @param locator_set_name - name of locator_set to add/del eid-table
2208 */
2209 define lisp_add_del_local_eid {
2210     u32 client_index;
2211     u32 context;
2212     u8  is_add;
2213     u8  is_ipv6;
2214     u8  ip_address[16];
2215     u8  prefix_len;
2216     u8  locator_set_name[64];
2217 };
2218
2219 /** \brief Reply for local_eid add/del
2220     @param context - returned sender context, to match reply w/ request
2221     @param retval - return code
2222 */
2223 define lisp_add_del_local_eid_reply {
2224     u32 context;
2225     i32 retval;
2226 };
2227
2228 /** \brief add or delete lisp gpe maptunel
2229     @param client_index - opaque cookie to identify the sender
2230     @param context - sender context, to match reply w/ request
2231     @param is_add - add address if non-zero, else delete
2232     @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2233     @param eid_ip_address - array of address bytes
2234     @param eid_prefix_len - prefix len
2235     @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2236     @param source_ip_address - array of address bytes
2237     @param destination_ip_address - array of address bytes
2238 */
2239 define lisp_gpe_add_del_fwd_entry {
2240     u32 client_index;
2241     u32 context;
2242     u8  is_add;
2243     u8  eid_is_ipv6;
2244     u8  eid_ip_address[16];
2245     u8  eid_prefix_len;
2246     u8  address_is_ipv6;
2247     u8  source_ip_address[16];
2248     u8  destination_ip_address[16];
2249 };
2250
2251 /** \brief Reply for gpe_fwd_entry add/del
2252     @param context - returned sender context, to match reply w/ request
2253     @param retval - return code
2254 */
2255 define lisp_gpe_add_del_fwd_entry_reply {
2256     u32 context;
2257     i32 retval;
2258 };
2259
2260 /** \brief add or delete map-resolver
2261     @param client_index - opaque cookie to identify the sender
2262     @param context - sender context, to match reply w/ request
2263     @param is_add - add address if non-zero, else delete
2264     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2265     @param ip_address - array of address bytes
2266 */
2267 define lisp_add_del_map_resolver {
2268     u32 client_index;
2269     u32 context;
2270     u8  is_add;
2271     u8  is_ipv6;
2272     u8  ip_address[16];
2273 };
2274
2275 /** \brief Reply for map_resolver add/del
2276     @param context - returned sender context, to match reply w/ request
2277     @param retval - return code
2278 */
2279 define lisp_add_del_map_resolver_reply {
2280     u32 context;
2281     i32 retval;
2282 };
2283
2284 /** \brief enable or disable lisp-gpe protocol
2285     @param client_index - opaque cookie to identify the sender
2286     @param context - sender context, to match reply w/ request
2287     @param is_en - enable protocol if non-zero, else disable
2288 */
2289 define lisp_gpe_enable_disable {
2290     u32 client_index;
2291     u32 context;
2292     u8  is_en;
2293 };
2294
2295 /** \brief Reply for gpe enable/disable
2296     @param context - returned sender context, to match reply w/ request
2297     @param retval - return code
2298 */
2299 define lisp_gpe_enable_disable_reply {
2300     u32 context;
2301     i32 retval;
2302 };
2303
2304 /** \brief enable or disable LISP feature
2305     @param client_index - opaque cookie to identify the sender
2306     @param context - sender context, to match reply w/ request
2307     @param is_en - enable protocol if non-zero, else disable
2308 */
2309 define lisp_enable_disable {
2310     u32 client_index;
2311     u32 context;
2312     u8  is_en;
2313 };
2314
2315 /** \brief Reply for gpe enable/disable
2316     @param context - returned sender context, to match reply w/ request
2317     @param retval - return code
2318 */
2319 define lisp_enable_disable_reply {
2320     u32 context;
2321     i32 retval;
2322 };
2323
2324 /** \brief add or delete gpe_iface
2325     @param client_index - opaque cookie to identify the sender
2326     @param context - sender context, to match reply w/ request
2327     @param is_add - add address if non-zero, else delete
2328 */
2329 define lisp_gpe_add_del_iface {
2330     u32 client_index;
2331     u32 context;
2332     u8  is_add;
2333     u32 table_id;
2334     u32 vni;
2335 };
2336
2337 /** \brief Reply for gpe_iface add/del
2338     @param context - returned sender context, to match reply w/ request
2339     @param retval - return code
2340 */
2341 define lisp_gpe_add_del_iface_reply {
2342     u32 context;
2343     i32 retval;
2344 };
2345
2346 /** \brief configure or disable LISP PITR node
2347     @param client_index - opaque cookie to identify the sender
2348     @param context - sender context, to match reply w/ request
2349     @param ls_name - locator set name
2350     @param is_add - add locator set if non-zero, else disable pitr
2351 */
2352 define lisp_pitr_set_locator_set {
2353     u32 client_index;
2354     u32 context;
2355     u8 is_add;
2356     u8 ls_name[64];
2357 };
2358
2359 /** \brief Reply for lisp_pitr_set_locator_set
2360     @param context - returned sender context, to match reply w/ request
2361     @param retval - return code
2362 */
2363 define lisp_pitr_set_locator_set_reply {
2364     u32 context;
2365     i32 retval;
2366 };
2367
2368 /** \brief add or delete remote static mapping
2369     @param client_index - opaque cookie to identify the sender
2370     @param context - sender context, to match reply w/ request
2371     @param is_add - add address if non-zero, else delete
2372     @param del_all - if set, delete all remote mappings
2373     @param vni - virtual network instance
2374     @param action - negative map-reply action
2375     @param eid_is_ip4 - ipv4/6 of source and destination EIDs
2376     @param deid - destination EID
2377     @param seid - source EID
2378     @param rloc_num - number of remote locators
2379     @param rlocs - remote locator data
2380 */
2381 define lisp_add_del_remote_mapping {
2382     u32 client_index;
2383     u32 context;
2384     u8  is_add;
2385     u8 del_all;
2386     u32 vni;
2387     u8 action;
2388     u8 eid_is_ip4;
2389     u8 deid[16];
2390     u8 seid[16];
2391     u8 deid_len;
2392     u8 seid_len;
2393     u32 rloc_num;
2394     u8 rlocs[0];
2395 };
2396
2397 /** \brief Reply for lisp_add_del_remote_mapping
2398     @param context - returned sender context, to match reply w/ request
2399     @param retval - return code
2400 */
2401
2402 define lisp_add_del_remote_mapping_reply {
2403     u32 context;
2404     i32 retval;
2405 };
2406
2407 /** \brief add or delete map request itr rlocs
2408     @param client_index - opaque cookie to identify the sender
2409     @param context - sender context, to match reply w/ request
2410     @param is_add - add address if non-zero, else delete
2411     @param locator_set_name - locator set name
2412 */
2413 define lisp_add_del_map_request_itr_rlocs {
2414     u32 client_index;
2415     u32 context;
2416     u8 is_add;
2417     u8 locator_set_name[64];
2418 };
2419
2420 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2421     @param context - returned sender context, to match reply w/ request
2422     @param retval - return code
2423 */
2424
2425 define lisp_add_del_map_request_itr_rlocs_reply {
2426     u32 context;
2427     i32 retval;
2428 };
2429
2430 /** \brief LISP locator_set status
2431     @param locator_set_name - name of the locator_set
2432     @param sw_if_index - sw_if_index of the locator
2433     @param priority - locator priority
2434     @param weight - locator weight
2435  */
2436 manual_java define lisp_locator_set_details {
2437     u32 context;
2438     u8  local;
2439     u8  locator_set_name[64];
2440     u32 sw_if_index;
2441     u8  is_ipv6;
2442     u8  ip_address[16];
2443     u8  prefix_len;
2444     u8  priority;
2445     u8  weight;
2446 };
2447
2448 /** \brief Request for locator_set summary status
2449     @param client_index - opaque cookie to identify the sender
2450     @param context - sender context, to match reply w/ request
2451  */
2452 define lisp_locator_set_dump {
2453     u32 client_index;
2454     u32 context;
2455 };
2456
2457 /** \brief LISP local eid table status
2458     @param locator_set_name - name of the locator_set
2459     @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2460     @param eid_ip_address - array of address bytes
2461     @param eid_prefix_len - prefix len
2462  */
2463 manual_java define lisp_local_eid_table_details {
2464     u32 context;
2465     u8  locator_set_name[64];
2466     u8  eid_is_ipv6;
2467     u8  eid_ip_address[16];
2468     u8  eid_prefix_len;
2469 };
2470
2471 /** \brief Request for local eid table summary status
2472     @param client_index - opaque cookie to identify the sender
2473     @param context - sender context, to match reply w/ request
2474  */
2475 define lisp_local_eid_table_dump {
2476     u32 client_index;
2477     u32 context;
2478 };
2479
2480 manual_java define lisp_gpe_tunnel_details {
2481     u32 context;
2482     u32 tunnels;
2483     u8  is_ipv6;
2484     u8  source_ip[16];
2485     u8  destination_ip[16];
2486     u32 encap_fib_id;
2487     u32 decap_fib_id;
2488     u32 dcap_next;
2489     u8  lisp_ver;
2490     u8  next_protocol;
2491     u8  flags;
2492     u8  ver_res;
2493     u8  res;
2494     u32 iid;
2495 };
2496
2497 /** \brief Request for gpe tunnel summary status
2498     @param client_index - opaque cookie to identify the sender
2499     @param context - sender context, to match reply w/ request
2500  */
2501 define lisp_gpe_tunnel_dump {
2502     u32 client_index;
2503     u32 context;
2504 };
2505
2506 /** \brief LISP map resolver status
2507     @param locator_set_name - name of the locator_set
2508     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2509     @param ip_address - array of address bytes
2510  */
2511 manual_java define lisp_map_resolver_details {
2512     u32 context;
2513     u8  is_ipv6;
2514     u8  ip_address[16];
2515 };
2516
2517 /** \brief Request for map resolver summary status
2518     @param client_index - opaque cookie to identify the sender
2519     @param context - sender context, to match reply w/ request
2520  */
2521 define lisp_map_resolver_dump {
2522     u32 client_index;
2523     u32 context;
2524 };
2525
2526 /** \brief Status of lisp-gpe protocol, enable or disable
2527     @param context - sender context, to match reply w/ request
2528     @param is_en - enable protocol if non-zero, else disable
2529 */
2530 manual_java define lisp_enable_disable_status_details {
2531     u32 context;
2532     u8 feature_status;
2533     u8 gpe_status;
2534 };
2535
2536 /** \brief Request for lisp-gpe protocol status
2537     @param client_index - opaque cookie to identify the sender
2538     @param context - sender context, to match reply w/ request
2539 */
2540 define lisp_enable_disable_status_dump {
2541     u32 client_index;
2542     u32 context;
2543 };
2544
2545 /** \brief Get LISP map request itr rlocs status
2546     @param context - sender context, to match reply w/ request
2547     @param locator_set_name - name of the locator_set
2548  */
2549 define lisp_get_map_request_itr_rlocs {
2550     u32 client_index;
2551     u32 context;
2552 };
2553
2554 /** \brief Request for map request itr rlocs summary status
2555  */
2556 define lisp_get_map_request_itr_rlocs_reply {
2557     u32 context;
2558     i32 retval;
2559     u8 locator_set_name[64];
2560 };
2561
2562 /* Gross kludge, DGMS */
2563 define interface_name_renumber {
2564     u32 client_index;
2565     u32 context;
2566     u32 sw_if_index;
2567     u32 new_show_dev_instance;
2568 };
2569
2570 define interface_name_renumber_reply {
2571     u32 context;
2572     i32 retval;
2573 };
2574
2575 /** \brief Register for ip4 arp resolution events
2576     @param client_index - opaque cookie to identify the sender
2577     @param context - sender context, to match reply w/ request
2578     @param enable_disable - 1 => register for events, 0 => cancel registration
2579     @param pid - sender's pid
2580     @param address - the exact ip4 address of interest
2581 */
2582 define want_ip4_arp_events {
2583     u32 client_index;
2584     u32 context;
2585     u8 enable_disable;
2586     u32 pid;
2587     u32 address;
2588 };
2589
2590 /** \brief Reply for interface events registration
2591     @param context - returned sender context, to match reply w/ request
2592     @param retval - return code
2593 */
2594 define want_ip4_arp_events_reply {
2595     u32 context;
2596     i32 retval;
2597 };
2598
2599 /** \brief Tell client about an ip4 arp resolution event
2600     @param client_index - opaque cookie to identify the sender
2601     @param context - sender context, to match reply w/ request
2602     @param address - the exact ip4 address of interest
2603     @param pid - client pid registered to receive notification
2604     @param sw_if_index - interface which received ARP packet
2605     @param new_mac - the new mac address
2606 */
2607 define ip4_arp_event {
2608     u32 client_index;
2609     u32 context;
2610     u32 address;
2611     u32 pid;
2612     u32 sw_if_index;
2613     u8 new_mac[6];
2614 };
2615
2616 /** \brief L2 bridge domain add or delete request
2617     @param client_index - opaque cookie to identify the sender
2618     @param context - sender context, to match reply w/ request
2619     @param bd_id - the bridge domain to create
2620     @param flood - enable/disable bcast/mcast flooding in the bd
2621     @param uu_flood - enable/disable uknown unicast flood in the bd
2622     @param forward - enable/disable forwarding on all interfaces in the bd
2623     @param learn - enable/disable learning on all interfaces in the bd
2624     @param arp_term - enable/disable arp termination in the bd
2625     @param is_add - add or delete flag
2626 */
2627 define bridge_domain_add_del {
2628     u32 client_index;
2629     u32 context;
2630     u32 bd_id;
2631     u8 flood;
2632     u8 uu_flood;
2633     u8 forward;
2634     u8 learn;
2635     u8 arp_term;
2636     u8 is_add;
2637 };
2638
2639 /** \brief L2 bridge domain add or delete response
2640     @param context - sender context, to match reply w/ request
2641     @param retval - return code for the set bridge flags request
2642 */
2643 define bridge_domain_add_del_reply {
2644     u32 context;
2645     u32 retval;
2646 };
2647
2648 /** \brief L2 bridge domain request operational state details
2649     @param client_index - opaque cookie to identify the sender
2650     @param context - sender context, to match reply w/ request
2651     @param bd_id - the bridge domain id desired or ~0 to request all bds
2652 */
2653 manual_java define bridge_domain_dump {
2654     u32 client_index;
2655     u32 context;
2656     u32 bd_id;
2657 };
2658
2659 /** \brief L2 bridge domain operational state response
2660     @param bd_id - the bridge domain id
2661     @param flood - bcast/mcast flooding state on all interfaces in the bd
2662     @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2663     @param forward - forwarding state on all interfaces in the bd
2664     @param learn - learning state on all interfaces in the bd
2665     @param arp_term - arp termination state on all interfaces in the bd
2666     @param n_sw_ifs - number of sw_if_index's in the domain
2667 */
2668 manual_java define bridge_domain_details {
2669     u32 context;
2670     u32 bd_id;
2671     u8 flood;
2672     u8 uu_flood;
2673     u8 forward;
2674     u8 learn;
2675     u8 arp_term;
2676     u32 bvi_sw_if_index;
2677     u32 n_sw_ifs;
2678 };
2679
2680 /** \brief L2 bridge domain sw interface operational state response
2681     @param bd_id - the bridge domain id
2682     @param sw_if_index - sw_if_index in the domain
2683     @param shg - split horizon group for the interface
2684 */
2685 manual_java define bridge_domain_sw_if_details {
2686     u32 context;
2687     u32 bd_id;
2688     u32 sw_if_index;
2689     u8 shg;
2690 };
2691
2692 /** \brief DHCP Client config add / del request
2693     @param client_index - opaque cookie to identify the sender
2694     @param context - sender context, to match reply w/ request
2695     @param sw_if_index - index of the interface for DHCP client
2696     @param hostname - hostname
2697     @param is_add - add the config if non-zero, else delete
2698     @param want_dhcp_event - DHCP event sent to the sender
2699            via dhcp_compl_event API message if non-zero
2700     @param pid - sender's pid
2701 */
2702 define dhcp_client_config {
2703     u32 client_index;
2704     u32 context;
2705     u32 sw_if_index;
2706     u8 hostname[64];
2707     u8 is_add;
2708     u8 want_dhcp_event;
2709     u32 pid;
2710 };
2711
2712 /** \brief DHCP Client config response
2713     @param context - sender context, to match reply w/ request
2714     @param retval - return code for the request
2715 */
2716 define dhcp_client_config_reply {
2717     u32 context;
2718     i32 retval;
2719 };
2720
2721 /** \brief Set/unset input ACL interface
2722     @param client_index - opaque cookie to identify the sender
2723     @param context - sender context, to match reply w/ request
2724     @param sw_if_index - interface to set/unset input ACL
2725     @param ip4_table_index - ip4 classify table index (~0 for skip)
2726     @param ip6_table_index - ip6 classify table index (~0 for skip)
2727     @param l2_table_index  -  l2 classify table index (~0 for skip)
2728     @param is_add - Set input ACL if non-zero, else unset
2729     Note: User is recommeneded to use just one valid table_index per call.
2730           (ip4_table_index, ip6_table_index, or l2_table_index)
2731 */
2732 define input_acl_set_interface {
2733     u32 client_index;
2734     u32 context;
2735     u32 sw_if_index;
2736     u32 ip4_table_index;
2737     u32 ip6_table_index;
2738     u32 l2_table_index;
2739     u8  is_add;
2740 };
2741
2742 /** \brief Set/unset input ACL interface response
2743     @param context - sender context, to match reply w/ request
2744     @param retval - return code for the request
2745 */
2746 define input_acl_set_interface_reply {
2747     u32 context;
2748     i32 retval;
2749 };
2750
2751 /** \brief IPsec: Add/delete Security Policy Database
2752     @param client_index - opaque cookie to identify the sender
2753     @param context - sender context, to match reply w/ request
2754     @param is_add - add SPD if non-zero, else delete
2755     @param spd_id - SPD instance id (control plane allocated)
2756 */
2757
2758 define ipsec_spd_add_del {
2759     u32 client_index;
2760     u32 context;
2761     u8 is_add;
2762     u32 spd_id;
2763 };
2764
2765 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2766     @param context - returned sender context, to match reply w/ request
2767     @param retval - return code
2768 */
2769
2770 define ipsec_spd_add_del_reply {
2771     u32 context;
2772     i32 retval;
2773 };
2774
2775 /** \brief IPsec: Add/delete SPD from interface
2776
2777     @param client_index - opaque cookie to identify the sender
2778     @param context - sender context, to match reply w/ request
2779     @param is_add - add security mode if non-zero, else delete
2780     @param sw_if_index - index of the interface
2781     @param spd_id - SPD instance id to use for lookups
2782 */
2783
2784
2785 define ipsec_interface_add_del_spd {
2786     u32 client_index;
2787     u32 context;
2788
2789     u8 is_add;
2790     u32 sw_if_index;
2791     u32 spd_id;
2792 };
2793
2794 /** \brief Reply for IPsec: Add/delete SPD from interface
2795     @param context - returned sender context, to match reply w/ request
2796     @param retval - return code
2797 */
2798
2799 define ipsec_interface_add_del_spd_reply {
2800     u32 context;
2801     i32 retval;
2802 };
2803
2804 /** \brief IPsec: Add/delete Security Policy Database entry
2805
2806     See RFC 4301, 4.4.1.1 on how to match packet to selectors
2807
2808     @param client_index - opaque cookie to identify the sender
2809     @param context - sender context, to match reply w/ request
2810     @param is_add - add SPD if non-zero, else delete
2811     @param spd_id - SPD instance id (control plane allocated)
2812     @param priority - priority of SPD entry (non-unique value).  Used to order SPD matching - higher priorities match before lower
2813     @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2814     @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2815     @param remote_address_start - start of remote address range to match
2816     @param remote_address_stop - end of remote address range to match
2817     @param local_address_start - start of local address range to match
2818     @param local_address_stop - end of local address range to match
2819     @param protocol - protocol type to match [0 means any]
2820     @param remote_port_start - start of remote port range to match ...
2821     @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2822     @param local_port_start - start of local port range to match ...
2823     @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2824     @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)
2825     @param sa_id - SAD instance id (control plane allocated)
2826
2827 */
2828
2829 define ipsec_spd_add_del_entry {
2830     u32 client_index;
2831     u32 context;
2832     u8 is_add;
2833
2834     u32 spd_id;
2835     i32 priority;
2836     u8 is_outbound;
2837
2838     // Selector
2839     u8 is_ipv6;
2840     u8 is_ip_any;
2841     u8 remote_address_start[16];
2842     u8 remote_address_stop[16];
2843     u8 local_address_start[16];
2844     u8 local_address_stop[16];
2845
2846     u8 protocol;
2847
2848     u16 remote_port_start;
2849     u16 remote_port_stop;
2850     u16 local_port_start;
2851     u16 local_port_stop;
2852
2853     // Policy
2854     u8 policy;
2855     u32 sa_id;
2856 };
2857
2858 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2859     @param context - returned sender context, to match reply w/ request
2860     @param retval - return code
2861 */
2862
2863 define ipsec_spd_add_del_entry_reply {
2864     u32 context;
2865     i32 retval;
2866 };
2867
2868 /** \brief IPsec: Add/delete Security Association Database entry
2869     @param client_index - opaque cookie to identify the sender
2870     @param context - sender context, to match reply w/ request
2871     @param is_add - add SAD entry if non-zero, else delete
2872
2873     @param sad_id - sad id
2874
2875     @param spi - security parameter index
2876
2877     @param protocol - 0 = AH, 1 = ESP
2878
2879     @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2880     @param crypto_key_length - length of crypto_key in bytes
2881     @param crypto_key - crypto keying material
2882
2883     @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2884     @param integrity_key_length - length of integrity_key in bytes
2885     @param integrity_key - integrity keying material
2886
2887     @param use_extended_sequence_number - use ESN when non-zero
2888
2889     @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2890     @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2891     @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
2892     @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
2893
2894     To be added:
2895      Anti-replay
2896      IPsec tunnel address copy mode (to support GDOI)
2897  */
2898
2899 define ipsec_sad_add_del_entry {
2900     u32 client_index;
2901     u32 context;
2902     u8 is_add;
2903
2904     u32 sad_id;
2905
2906     u32 spi;
2907
2908     u8 protocol;
2909
2910     u8 crypto_algorithm;
2911     u8 crypto_key_length;
2912     u8 crypto_key[128];
2913
2914     u8 integrity_algorithm;
2915     u8 integrity_key_length;
2916     u8 integrity_key[128];
2917
2918     u8 use_extended_sequence_number;
2919
2920     u8 is_tunnel;
2921     u8 is_tunnel_ipv6;
2922     u8 tunnel_src_address[16];
2923     u8 tunnel_dst_address[16];
2924 };
2925
2926 /** \brief Reply for IPsec: Add/delete Security Association Database entry
2927     @param context - returned sender context, to match reply w/ request
2928     @param retval - return code
2929 */
2930
2931 define ipsec_sad_add_del_entry_reply {
2932     u32 context;
2933     i32 retval;
2934 };
2935
2936 /** \brief IPsec: Update Security Association keys
2937     @param client_index - opaque cookie to identify the sender
2938     @param context - sender context, to match reply w/ request
2939
2940     @param sa_id - sa id
2941
2942     @param crypto_key_length - length of crypto_key in bytes
2943     @param crypto_key - crypto keying material
2944
2945     @param integrity_key_length - length of integrity_key in bytes
2946     @param integrity_key - integrity keying material
2947 */
2948
2949 define ipsec_sa_set_key {
2950     u32 client_index;
2951     u32 context;
2952
2953     u32 sa_id;
2954
2955     u8 crypto_key_length;
2956     u8 crypto_key[128];
2957
2958     u8 integrity_key_length;
2959     u8 integrity_key[128];
2960 };
2961
2962 /** \brief Reply for IPsec: Update Security Association keys
2963     @param context - returned sender context, to match reply w/ request
2964     @param retval - return code
2965 */
2966
2967 define ipsec_sa_set_key_reply {
2968     u32 context;
2969     i32 retval;
2970 };
2971
2972 /** \brief IKEv2: Add/delete profile
2973     @param client_index - opaque cookie to identify the sender
2974     @param context - sender context, to match reply w/ request
2975
2976     @param name - IKEv2 profile name
2977     @param is_add - Add IKEv2 profile if non-zero, else delete
2978 */
2979 define ikev2_profile_add_del {
2980     u32 client_index;
2981     u32 context;
2982
2983     u8 name[64];
2984     u8 is_add;
2985 };
2986
2987 /** \brief Reply for IKEv2: Add/delete profile
2988     @param context - returned sender context, to match reply w/ request
2989     @param retval - return code
2990 */
2991 define ikev2_profile_add_del_reply {
2992     u32 context;
2993     i32 retval;
2994 };
2995
2996 /** \brief IKEv2: Set IKEv2 profile authentication method
2997     @param client_index - opaque cookie to identify the sender
2998     @param context - sender context, to match reply w/ request
2999
3000     @param name - IKEv2 profile name
3001     @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3002     @param is_hex - Authentication data in hex format if non-zero, else string
3003     @param data_len - Authentication data length
3004     @param data - Authentication data (for rsa-sig cert file path)
3005 */
3006 define ikev2_profile_set_auth {
3007     u32 client_index;
3008     u32 context;
3009
3010     u8 name[64];
3011     u8 auth_method;
3012     u8 is_hex;
3013     u32 data_len;
3014     u8 data[0];
3015 };
3016
3017 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3018     @param context - returned sender context, to match reply w/ request
3019     @param retval - return code
3020 */
3021 define ikev2_profile_set_auth_reply {
3022     u32 context;
3023     i32 retval;
3024 };
3025
3026 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3027     @param client_index - opaque cookie to identify the sender
3028     @param context - sender context, to match reply w/ request
3029
3030     @param name - IKEv2 profile name
3031     @param is_local - Identification is local if non-zero, else remote
3032     @param id_type - Identification type
3033     @param data_len - Identification data length
3034     @param data - Identification data
3035 */
3036 define ikev2_profile_set_id {
3037     u32 client_index;
3038     u32 context;
3039
3040     u8 name[64];
3041     u8 is_local;
3042     u8 id_type;
3043     u32 data_len;
3044     u8 data[0];
3045 };
3046
3047 /** \brief Reply for IKEv2:
3048     @param context - returned sender context, to match reply w/ request
3049     @param retval - return code
3050 */
3051 define ikev2_profile_set_id_reply {
3052     u32 context;
3053     i32 retval;
3054 };
3055
3056 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3057     @param client_index - opaque cookie to identify the sender
3058     @param context - sender context, to match reply w/ request
3059
3060     @param name - IKEv2 profile name
3061     @param is_local - Traffic selector is local if non-zero, else remote
3062     @param proto - Traffic selector IP protocol (if zero not relevant)
3063     @param start_port - The smallest port number allowed by traffic selector
3064     @param end_port - The largest port number allowed by traffic selector
3065     @param start_addr - The smallest address included in traffic selector
3066     @param end_addr - The largest address included in traffic selector
3067 */
3068 define ikev2_profile_set_ts {
3069     u32 client_index;
3070     u32 context;
3071
3072     u8 name[64];
3073     u8 is_local;
3074     u8 proto;
3075     u16 start_port;
3076     u16 end_port;
3077     u32 start_addr;
3078     u32 end_addr;
3079 };
3080
3081 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3082     @param context - returned sender context, to match reply w/ request
3083     @param retval - return code
3084 */
3085 define ikev2_profile_set_ts_reply {
3086     u32 context;
3087     i32 retval;
3088 };
3089
3090 /** \brief IKEv2: Set IKEv2 local RSA private key
3091     @param client_index - opaque cookie to identify the sender
3092     @param context - sender context, to match reply w/ request
3093
3094     @param key_file - Key file absolute path
3095 */
3096 define ikev2_set_local_key {
3097     u32 client_index;
3098     u32 context;
3099
3100     u8 key_file[256];
3101 };
3102
3103 /** \brief Reply for IKEv2: Set IKEv2 local key
3104     @param context - returned sender context, to match reply w/ request
3105     @param retval - return code
3106 */
3107 define ikev2_set_local_key_reply {
3108     u32 context;
3109     i32 retval;
3110 };
3111
3112 /** \brief Tell client about a DHCP completion event
3113     @param client_index - opaque cookie to identify the sender
3114     @param pid - client pid registered to receive notification
3115     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3116     @param host_address - Host IP address
3117     @param router_address - Router IP address
3118     @param host_mac - Host MAC address
3119 */
3120 manual_java define dhcp_compl_event {
3121     u32 client_index;
3122     u32 pid;
3123     u8 hostname[64];
3124     u8 is_ipv6;
3125     u8 host_address[16];
3126     u8 router_address[16];
3127     u8 host_mac[6];
3128 };
3129
3130 /** \brief Add MAP domains
3131     @param client_index - opaque cookie to identify the sender
3132     @param context - sender context, to match reply w/ request
3133     @param ip6_prefix - Rule IPv6 prefix
3134     @param ip4_prefix - Rule IPv4 prefix
3135     @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3136     @param ip6_prefix_len - Rule IPv6 prefix length
3137     @param ip4_prefix_len - Rule IPv4 prefix length
3138     @param ea_bits_len - Embedded Address bits length
3139     @param psid_offset - Port Set Identifider (PSID) offset
3140     @param psid_length - PSID length
3141     @param is_translation - MAP-E / MAP-T
3142     @param mtu - MTU
3143 */
3144 define map_add_domain {
3145   u32 client_index;
3146   u32 context;
3147   u8 ip6_prefix[16];
3148   u8 ip4_prefix[4];
3149   u8 ip6_src[16];
3150   u8 ip6_prefix_len;
3151   u8 ip4_prefix_len;
3152   u8 ip6_src_prefix_len;
3153   u8 ea_bits_len;
3154   u8 psid_offset;
3155   u8 psid_length;
3156   u8 is_translation;
3157   u16 mtu;
3158 };
3159
3160 /** \brief Reply for MAP domain add
3161     @param context - returned sender context, to match reply w/ request
3162     @param index - MAP domain index
3163     @param retval - return code
3164 */
3165 define map_add_domain_reply {
3166   u32 context;
3167   u32 index;
3168   i32 retval;
3169 };
3170
3171 /** \brief Delete MAP domain
3172     @param client_index - opaque cookie to identify the sender
3173     @param context - sender context, to match reply w/ request
3174     @param index - MAP Domain index
3175 */
3176 define map_del_domain {
3177   u32 client_index;
3178   u32 context;
3179   u32 index;
3180 };
3181
3182 /** \brief Reply for MAP domain del
3183     @param context - returned sender context, to match reply w/ request
3184     @param retval - return code
3185 */
3186 define map_del_domain_reply {
3187   u32 context;
3188   i32 retval;
3189 };
3190
3191 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3192     @param client_index - opaque cookie to identify the sender
3193     @param context - sender context, to match reply w/ request
3194     @param index - MAP Domain index
3195     @param is_add - If 1 add rule, if 0 delete rule
3196     @param ip6_dst - MAP CE IPv6 address
3197     @param psid - Rule PSID
3198 */
3199 define map_add_del_rule {
3200   u32 client_index;
3201   u32 context;
3202   u32 index;
3203   u32 is_add;
3204   u8 ip6_dst[16];
3205   u16 psid;
3206 };
3207
3208 /** \brief Reply for MAP rule add/del
3209     @param context - returned sender context, to match reply w/ request
3210     @param retval - return code
3211 */
3212 define map_add_del_rule_reply {
3213   u32 context;
3214   i32 retval;
3215 };
3216
3217 /** \brief Get list of map domains
3218     @param client_index - opaque cookie to identify the sender
3219 */
3220 define map_domain_dump {
3221   u32 client_index;
3222   u32 context;
3223 };
3224
3225 manual_java define map_domain_details {
3226   u32 context;
3227   u32 domain_index;
3228   u8 ip6_prefix[16];
3229   u8 ip4_prefix[4];
3230   u8 ip6_src[16];
3231   u8 ip6_prefix_len;
3232   u8 ip4_prefix_len;
3233   u8 ip6_src_len;
3234   u8 ea_bits_len;
3235   u8 psid_offset;
3236   u8 psid_length;
3237   u8 flags;
3238   u16 mtu;
3239   u8 is_translation;
3240 };
3241
3242 define map_rule_dump {
3243   u32 client_index;
3244   u32 context;
3245   u32 domain_index;
3246 };
3247
3248 manual_java define map_rule_details {
3249   u32 context;
3250   u8 ip6_dst[16];
3251   u16 psid;
3252 };
3253
3254 /** \brief Request for a single block of summary stats
3255     @param client_index - opaque cookie to identify the sender
3256     @param context - sender context, to match reply w/ request
3257 */
3258 define map_summary_stats {
3259     u32 client_index;
3260     u32 context;
3261 };
3262
3263 /** \brief Reply for map_summary_stats request
3264     @param context - sender context, to match reply w/ request
3265     @param retval - return code for request
3266     @param total_bindings -
3267     @param total_pkts -
3268     @param total_ip4_fragments -
3269     @param total_security_check -
3270 */
3271 define map_summary_stats_reply {
3272     u32 context;
3273     i32 retval;
3274     u64 total_bindings;
3275     u64 total_pkts[2];
3276     u64 total_bytes[2];
3277     u64 total_ip4_fragments;
3278     u64 total_security_check[2];
3279 };
3280
3281 /** \brief cop: enable/disable junk filtration features on an interface
3282     @param client_index - opaque cookie to identify the sender
3283     @param context - sender context, to match reply w/ request
3284     @param sw_if_inded - desired interface
3285     @param enable_disable - 1 => enable, 0 => disable
3286 */
3287
3288 define cop_interface_enable_disable {
3289     u32 client_index;
3290     u32 context;
3291     u32 sw_if_index;
3292     u8 enable_disable;
3293 };
3294
3295 /** \brief cop: interface enable/disable junk filtration reply
3296     @param context - returned sender context, to match reply w/ request
3297     @param retval - return code
3298 */
3299
3300 define cop_interface_enable_disable_reply {
3301     u32 context;
3302     i32 retval;
3303 };
3304
3305 /** \brief cop: enable/disable whitelist filtration features on an interface
3306     Note: the supplied fib_id must match in order to remove the feature!
3307
3308     @param client_index - opaque cookie to identify the sender
3309     @param context - sender context, to match reply w/ request
3310     @param sw_if_index - interface handle, physical interfaces only
3311     @param fib_id - fib identifier for the whitelist / blacklist fib
3312     @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3313     @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3314     @param default_cop -  1 => enable non-ip4, non-ip6 filtration 0=> disable it
3315 */
3316
3317 define cop_whitelist_enable_disable {
3318     u32 client_index;
3319     u32 context;
3320     u32 sw_if_index;
3321     u32 fib_id;
3322     u8 ip4;
3323     u8 ip6;
3324     u8 default_cop;
3325 };
3326
3327 /** \brief cop: interface enable/disable junk filtration reply
3328     @param context - returned sender context, to match reply w/ request
3329     @param retval - return code
3330 */
3331
3332 define cop_whitelist_enable_disable_reply {
3333     u32 context;
3334     i32 retval;
3335 };
3336
3337 /** \brief get_node_graph - get a copy of the vpp node graph
3338     including the current set of graph arcs.
3339
3340     @param client_index - opaque cookie to identify the sender
3341     @param context - sender context, to match reply w/ request
3342 */
3343
3344 define get_node_graph {
3345     u32 client_index;
3346     u32 context;
3347 };
3348
3349 /** \brief get_node_graph_reply
3350     @param context - returned sender context, to match reply w/ request
3351     @param retval - return code
3352     @param reply_in_shmem - result from vlib_node_serialize, in shared
3353     memory. Process with vlib_node_unserialize, remember to switch
3354     heaps and free the result.
3355 */
3356
3357 define get_node_graph_reply {
3358     u32 context;
3359     i32 retval;
3360     u64 reply_in_shmem;
3361 };
3362
3363 /** \brief Clear interface statistics
3364     @param client_index - opaque cookie to identify the sender
3365     @param context - sender context, to match reply w/ request
3366     @param sw_if_index - index of the interface to clear statistics
3367 */
3368 define sw_interface_clear_stats {
3369     u32 client_index;
3370     u32 context;
3371     u32 sw_if_index;
3372 };
3373
3374 /** \brief Reply to sw_interface_clear_stats
3375     @param context - sender context which was passed in the request
3376     @param retval - return code of the set flags request
3377 */
3378 define sw_interface_clear_stats_reply {
3379     u32 context;
3380     i32 retval;
3381 };
3382
3383 /** \brief IOAM Trace : Set TRACE profile
3384     @param id - profile id
3385     @param trace_type - Trace type
3386     @param trace_num_elt - Number of nodes in trace path
3387     @param trace_ppc - Trace PPC (none/encap/decap)
3388     @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3389     @param trace_app_data - Trace application data, can be any 4 bytes
3390     @param pow_enable - Proof of Work enabled or not flag
3391     @param node_id - Id of this node
3392 */
3393 define trace_profile_add {
3394   u32 client_index;
3395   u32 context;
3396   u16 id;
3397   u8  trace_type;
3398   u8  trace_num_elt;
3399   u8  trace_ppc;
3400   u8  trace_tsp;
3401   u32 trace_app_data;
3402   u8  pow_enable;
3403   u32 node_id;
3404 };
3405
3406 /** \brief Trace profile add / del response
3407     @param context - sender context, to match reply w/ request
3408     @param retval - return value for request
3409 */
3410 define trace_profile_add_reply {
3411     u32 context;
3412     i32 retval;
3413 };
3414
3415 /** \brief IOAM Trace enable trace profile for a flow
3416     @param id - id of the trace profile to be applied
3417     @param dest_ipv6 - Destination IPv6 address
3418     @param prefix_length - prefix mask
3419     @param vrf_id - VRF ID
3420     @param trace_op - Trace operation (add/mod/del)
3421     @param enable - apply/remove the trace profile for the flow
3422 */
3423 define trace_profile_apply {
3424   u32 client_index;
3425   u32 context;
3426   u16 id;
3427   u8 dest_ipv6[16];
3428   u32 prefix_length;
3429   u32 vrf_id;
3430   u8 trace_op;
3431   u8 enable;
3432 };
3433
3434 /** \brief Trace profile apply response
3435     @param context - sender context, to match reply w/ request
3436     @param retval - return value for request
3437 */
3438 define trace_profile_apply_reply {
3439   u32 context;
3440   i32 retval;
3441 };
3442
3443 /** \brief Delete Trace Profile
3444     @param client_index - opaque cookie to identify the sender
3445     @param context - sender context, to match reply w/ request
3446     @param index - MAP Domain index
3447 */
3448 define trace_profile_del {
3449   u32 client_index;
3450   u32 context;
3451   u16 id;
3452 };
3453
3454 /** \brief Trace profile add / del response
3455     @param context - sender context, to match reply w/ request
3456     @param retval - return value for request
3457 */
3458 define trace_profile_del_reply {
3459     u32 context;
3460     i32 retval;
3461 };
3462
3463 /** \brief Create host-interface
3464     @param client_index - opaque cookie to identify the sender
3465     @param context - sender context, to match reply w/ request
3466     @param host_if_name - interface name
3467     @param hw_addr - interface MAC
3468     @param use_random_hw_addr - use random generated MAC
3469 */
3470 define af_packet_create {
3471     u32 client_index;
3472     u32 context;
3473
3474     u8 host_if_name[64];
3475     u8 hw_addr[6];
3476     u8 use_random_hw_addr;
3477 };
3478
3479 /** \brief Create host-interface response
3480     @param context - sender context, to match reply w/ request
3481     @param retval - return value for request
3482 */
3483 define af_packet_create_reply {
3484     u32 context;
3485     i32 retval;
3486     u32 sw_if_index;
3487 };
3488
3489 /** \brief Delete host-interface
3490     @param client_index - opaque cookie to identify the sender
3491     @param context - sender context, to match reply w/ request
3492     @param host_if_name - interface name
3493 */
3494 define af_packet_delete {
3495     u32 client_index;
3496     u32 context;
3497
3498     u8 host_if_name[64];
3499 };
3500
3501 /** \brief Delete host-interface response
3502     @param context - sender context, to match reply w/ request
3503     @param retval - return value for request
3504 */
3505 define af_packet_delete_reply {
3506     u32 context;
3507     i32 retval;
3508 };
3509
3510 /** \brief Add/del policer
3511     @param client_index - opaque cookie to identify the sender
3512     @param context - sender context, to match reply w/ request
3513     @param is_add - add policer if non-zero, else delete
3514     @param name - policer name
3515     @param cir - CIR
3516     @param eir - EIR
3517     @param cb - Committed Burst
3518     @param eb - Excess or Peak Burst
3519     @param rate_type - rate type
3520     @param round_type - rounding type
3521     @param type - policer algorithm
3522 */
3523 define policer_add_del {
3524     u32 client_index;
3525     u32 context;
3526
3527     u8 is_add;
3528     u8 name[64];
3529     u32 cir;
3530     u32 eir;
3531     u64 cb;
3532     u64 eb;
3533     u8 rate_type;
3534     u8 round_type;
3535     u8 type;
3536 };
3537
3538 /** \brief Add/del policer response
3539     @param context - sender context, to match reply w/ request
3540     @param retval - return value for request
3541 */
3542 define policer_add_del_reply {
3543     u32 context;
3544     i32 retval;
3545 };
3546
3547 /** \brief Get list of policers
3548     @param client_index - opaque cookie to identify the sender
3549     @param context - sender context, to match reply w/ request
3550     @param match_name_valid - if 0 request all policers otherwise use match_name
3551     @param match_name - policer name
3552 */
3553 define policer_dump {
3554     u32 client_index;
3555     u32 context;
3556
3557     u8 match_name_valid;
3558     u8 match_name[64];
3559 };
3560
3561 /** \brief Policer operational state response.
3562     @param context - sender context, to match reply w/ request
3563     @param name - policer name
3564     @param cir - CIR
3565     @param eir - EIR
3566     @param cb - Committed Burst
3567     @param eb - Excess or Peak Burst
3568     @param rate_type - rate type
3569     @param round_type - rounding type
3570     @param type - policer algorithm
3571     @param single_rate - 1 = single rate policer, 0 = two rate policer
3572     @param color_aware - for hierarchical policing
3573     @param scale - power-of-2 shift amount for lower rates
3574     @param cir_tokens_per_period - number of tokens for each period
3575     @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3576     @param current_limit - current limit
3577     @param current_bucket - current bucket
3578     @param extended_limit - extended limit
3579     @param extended_bucket - extended bucket
3580     @param last_update_time - last update time
3581 */
3582 manual_java define policer_details {
3583     u32 context;
3584
3585     u8 name[64];
3586     u32 cir;
3587     u32 eir;
3588     u64 cb;
3589     u64 eb;
3590     u8 rate_type;
3591     u8 round_type;
3592     u8 type;
3593     u8 single_rate;
3594     u8 color_aware;
3595     u32 scale;
3596     u32 cir_tokens_per_period;
3597     u32 pir_tokens_per_period;
3598     u32 current_limit;
3599     u32 current_bucket;
3600     u32 extended_limit;
3601     u32 extended_bucket;
3602     u64 last_update_time;
3603 };
3604
3605 /** \brief Create netmap
3606     @param client_index - opaque cookie to identify the sender
3607     @param context - sender context, to match reply w/ request
3608     @param netmap_if_name - interface name
3609     @param hw_addr - interface MAC
3610     @param use_random_hw_addr - use random generated MAC
3611     @param is_pipe - is pipe
3612     @param is_master - 0=slave, 1=master
3613 */
3614 define netmap_create {
3615     u32 client_index;
3616     u32 context;
3617
3618     u8 netmap_if_name[64];
3619     u8 hw_addr[6];
3620     u8 use_random_hw_addr;
3621     u8 is_pipe;
3622     u8 is_master;
3623 };
3624
3625 /** \brief Create netmap response
3626     @param context - sender context, to match reply w/ request
3627     @param retval - return value for request
3628 */
3629 define netmap_create_reply {
3630     u32 context;
3631     i32 retval;
3632 };
3633
3634 /** \brief Delete netmap
3635     @param client_index - opaque cookie to identify the sender
3636     @param context - sender context, to match reply w/ request
3637     @param netmap_if_name - interface name
3638 */
3639 define netmap_delete {
3640     u32 client_index;
3641     u32 context;
3642
3643     u8 netmap_if_name[64];
3644 };
3645
3646 /** \brief Delete netmap response
3647     @param context - sender context, to match reply w/ request
3648     @param retval - return value for request
3649 */
3650 define netmap_delete_reply {
3651     u32 context;
3652     i32 retval;
3653 };