Add an option to dump details about specific LISP EID in API/CLI
[vpp.git] / vpp / vpp-api / vpe.api
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2015 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /** \file
18
19     This file defines vpe control-plane API messages which are generally
20     called through a shared memory interface. 
21 */
22
23
24 /** \brief Register for interface events
25     @param client_index - opaque cookie to identify the sender
26     @param context - sender context, to match reply w/ request
27     @param enable_disable - 1 => register for events, 0 => cancel registration
28     @param pid - sender's pid
29 */
30 define want_interface_events {
31     u32 client_index;
32     u32 context;
33     u32 enable_disable;
34     u32 pid;
35 };
36
37 /** \brief Reply for interface events registration
38     @param context - returned sender context, to match reply w/ request
39     @param retval - return code
40 */
41 define want_interface_events_reply {
42     u32 context;
43     i32 retval;
44 };
45
46 /** \brief Interface details structure (fix this) 
47     @param sw_if_index - index of the interface
48     @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index  
49     @param l2_address_length - length of the interface's l2 address
50     @param pid - the interface's l2 address
51     @param interface_name - name of the interface
52     @param link_duplex - 1 if half duplex, 2 if full duplex
53     @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
54     @param link_MTU - max. transmittion unit 
55     @param sub_if_id - A number 0-N to uniquely identify this subif on super if
56     @param sub_dot1ad -  0 = dot1q, 1=dot1ad
57     @param sub_number_of_tags - Number of tags (0 - 2)
58     @param sub_outer_vlan_id
59     @param sub_inner_vlan_id
60     @param sub_exact_match
61     @param sub_default
62     @param sub_outer_vlan_id_any
63     @param sub_inner_vlan_id_any
64     @param vtr_op - vlan tag rewrite operation
65     @param vtr_push_dot1q
66     @param vtr_tag1
67     @param vtr_tag2
68 */
69 manual_java define sw_interface_details {
70     u32 context;
71     u32 sw_if_index;
72
73     /* index of sup interface (e.g. hw interface).
74        equal to sw_if_index for super hw interface. */
75     u32 sup_sw_if_index;
76
77     /* Layer 2 address, if applicable */
78     u32 l2_address_length;
79     u8 l2_address[8];
80     
81     /* Interface name */
82     u8 interface_name[64];
83
84     /* 1 = up, 0 = down */
85     u8 admin_up_down;
86     u8 link_up_down;
87
88     /* 1 = half duplex, 2 = full duplex */
89     u8 link_duplex;
90
91     /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
92     u8 link_speed;
93     
94     /* MTU */
95     u16 link_mtu;
96
97     /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface*/
98     u32 sub_id;
99
100     /* 0 = dot1q, 1=dot1ad */
101     u8 sub_dot1ad;
102
103     /* Number of tags 0-2 */
104     u8 sub_number_of_tags;
105     u16 sub_outer_vlan_id;
106     u16 sub_inner_vlan_id;
107     u8 sub_exact_match;
108     u8 sub_default;
109     u8 sub_outer_vlan_id_any;
110     u8 sub_inner_vlan_id_any;
111
112     /* vlan tag rewrite state */
113     u32 vtr_op;
114     u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
115     u32 vtr_tag1;       // first pushed tag
116     u32 vtr_tag2;       // second pushed tag
117 };
118
119 /** \brief Set flags on the interface
120     @param client_index - opaque cookie to identify the sender
121     @param context - sender context, to match reply w/ request
122     @param sw_if_index - index of the interface to set flags on
123     @param admin_up_down - set the admin state, 1 = up, 0 = down
124     @param link_up_down - Oper state sent on change event, not used in config.
125     @param deleted - interface was deleted
126 */
127 define sw_interface_set_flags {
128     u32 client_index;
129     u32 context;
130     u32 sw_if_index;
131     /* 1 = up, 0 = down */
132     u8 admin_up_down;
133     u8 link_up_down;
134     u8 deleted;
135 };
136
137 /** \brief Reply to sw_interface_set_flags 
138     @param context - sender context which was passed in the request
139     @param retval - return code of the set flags request
140 */
141 define sw_interface_set_flags_reply {
142     u32 context;
143     i32 retval;
144 };
145
146 /* works */
147 manual_java define sw_interface_dump {
148     u32 client_index;
149     u32 context;
150     u8 name_filter_valid;
151     u8 name_filter[49];
152 };
153
154 /** \brief Set or delete one or all ip addresses on a specified interface
155     @param client_index - opaque cookie to identify the sender
156     @param context - sender context, to match reply w/ request
157     @param sw_if_index - index of the interface to add/del addresses 
158     @param is_add - add address if non-zero, else delete
159     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
160     @param del_all - if non-zero delete all addresses on the interface
161     @param address_length - address length in bytes, 4 for ip4, 16 for ip6
162     @param address - array of address bytes
163 */
164 define sw_interface_add_del_address {
165     u32 client_index;
166     u32 context;
167     u32 sw_if_index;
168     u8 is_add;
169     u8 is_ipv6;
170     u8 del_all;
171     u8 address_length;
172     u8 address[16];
173 };
174
175 /** \brief Reply for interface events registration
176     @param context - returned sender context, to match reply w/ request
177     @param retval - return code
178 */
179 define sw_interface_add_del_address_reply {
180     u32 context;
181     i32 retval;
182 };
183
184 /** \brief Associate the specified interface with a fib table
185     @param client_index - opaque cookie to identify the sender
186     @param context - sender context, to match reply w/ request
187     @param sw_if_index - index of the interface
188     @param is_ipv6 - if non-zero ipv6, else ipv4
189     @param vrf_id - fib table/vrd id to associate the interface with
190 */
191 define sw_interface_set_table {
192     u32 client_index;
193     u32 context;
194     u32 sw_if_index;
195     u8 is_ipv6;
196     u32 vrf_id;
197 };
198
199 /** \brief Reply for interface events registration
200     @param context - returned sender context, to match reply w/ request
201     @param retval - return code
202 */
203 define sw_interface_set_table_reply {
204     u32 context;
205     i32 retval;
206 };
207
208 /** \brief Initialize a new tap interface with the given paramters 
209     @param client_index - opaque cookie to identify the sender
210     @param context - sender context, to match reply w/ request
211     @param use_random_mac - let the system generate a unique mac address
212     @param tap_name - name to associate with the new interface
213     @param mac_address - mac addr to assign to the interface if use_radom not set
214 */
215 define tap_connect {
216     u32 client_index;
217     u32 context;
218     u8 use_random_mac;
219     u8 tap_name [64];
220     u8 mac_address[6];
221     u8 renumber;
222     u32 custom_dev_instance;
223 };
224
225 /** \brief Reply for tap connect request
226     @param context - returned sender context, to match reply w/ request
227     @param retval - return code
228     @param sw_if_index - software index allocated for the new tap interface
229 */
230 define tap_connect_reply {
231     u32 context;
232     i32 retval;
233     u32 sw_if_index;
234 };
235
236 /** \brief Modify a tap interface with the given paramters 
237     @param client_index - opaque cookie to identify the sender
238     @param context - sender context, to match reply w/ request
239     @param sw_if_index - interface index of existing tap interface
240     @param use_random_mac - let the system generate a unique mac address
241     @param tap_name - name to associate with the new interface
242     @param mac_address - mac addr to assign to the interface if use_radom not set
243 */
244 define tap_modify {
245     u32 client_index;
246     u32 context;
247     u32 sw_if_index;
248     u8 use_random_mac;
249     u8 tap_name [64];
250     u8 mac_address[6];
251     u8 renumber;
252     u32 custom_dev_instance;
253 };
254
255 /** \brief Reply for tap modify request
256     @param context - returned sender context, to match reply w/ request
257     @param retval - return code
258     @param sw_if_index - software index if the modified tap interface
259 */
260 define tap_modify_reply {
261     u32 context;
262     i32 retval;
263     u32 sw_if_index;
264 };
265
266 /** \brief Delete tap interface
267     @param client_index - opaque cookie to identify the sender
268     @param context - sender context, to match reply w/ request
269     @param sw_if_index - interface index of existing tap interface
270 */
271 define tap_delete {
272     u32 client_index;
273     u32 context;
274     u32 sw_if_index;
275 };
276
277 /** \brief Reply for tap delete request
278     @param context - returned sender context, to match reply w/ request
279     @param retval - return code
280 */
281 define tap_delete_reply {
282     u32 context;
283     i32 retval;
284 };
285
286 /** \brief Dump tap interfaces request */
287 define sw_interface_tap_dump {
288     u32 client_index;
289     u32 context;
290 };
291
292 /** \brief Reply for tap dump request
293     @param sw_if_index - software index of tap interface
294     @param dev_name - Linux tap device name
295 */
296 manual_java define sw_interface_tap_details {
297     u32 context;
298     u32 sw_if_index;
299     u8 dev_name[64];
300 };
301
302 /** \brief Create a new subinterface with the given vlan id
303     @param client_index - opaque cookie to identify the sender
304     @param context - sender context, to match reply w/ request
305     @param sw_if_index - software index of the new vlan's parent interface
306     @param vlan_id - vlan tag of the new interface
307 */
308 define create_vlan_subif {
309     u32 client_index;
310     u32 context;
311     u32 sw_if_index;
312     u32 vlan_id;
313 };
314
315 /** \brief Reply for the vlan subinterface create request
316     @param context - returned sender context, to match reply w/ request
317     @param retval - return code
318     @param sw_if_index - software index allocated for the new subinterface
319 */
320 define create_vlan_subif_reply {
321     u32 context;
322     i32 retval;
323     u32 sw_if_index;
324 };
325
326 /** \brief Add / del route request
327     @param client_index - opaque cookie to identify the sender
328     @param context - sender context, to match reply w/ request
329     @param sw_if_index - software index of the new vlan's parent interface
330     @param vrf_id - fib table /vrf associated with the route
331     @param lookup_in_vrf - 
332     @param resolve_attempts - 
333     @param classify_table_index - 
334     @param create_vrf_if_needed - 
335     @param resolve_if_needed - 
336     @param is_add - 1 if adding the route, 0 if deleting
337     @param is_drop - 
338     @param is_ipv6 - 0 if an ip4 route, else ip6
339     @param is_local - 
340     @param is_classify - 
341     @param is_multipath - Set to 1 if this is a multipath route, else 0
342     @param not_last - Is last or not last msg in group of multiple add/del msgs
343     @param next_hop_weight - 
344     @param dst_address_length - 
345     @param dst_address[16] - 
346     @param next_hop_address[16] - 
347 */
348 define ip_add_del_route {
349     u32 client_index;
350     u32 context;
351     u32 next_hop_sw_if_index;
352     u32 vrf_id;
353     u32 lookup_in_vrf;
354     u32 resolve_attempts;
355     u32 classify_table_index;
356     u8 create_vrf_if_needed;
357     u8 resolve_if_needed;
358     u8 is_add;
359     u8 is_drop;
360     u8 is_ipv6;
361     u8 is_local;
362     u8 is_classify;
363     /* Is last/not-last message in group of multiple add/del messages. */
364     u8 is_multipath;
365     u8 not_last;
366     u8 next_hop_weight;
367     u8 dst_address_length;
368     u8 dst_address[16];
369     u8 next_hop_address[16];
370 };
371
372 /** \brief Reply for add / del route request
373     @param context - returned sender context, to match reply w/ request
374     @param retval - return code
375 */
376 define ip_add_del_route_reply {
377     u32 context;
378     i32 retval;
379 };
380
381 /* works */
382 /** \brief Add / del gre tunnel request
383     @param client_index - opaque cookie to identify the sender
384     @param context - sender context, to match reply w/ request
385     @param sw_if_index - software index of the new vlan's parent interface
386     @param inner_vrf_id -
387     @param outer_vrf_id - 
388     @param is_add - 1 if adding the tunnel, 0 if deleting
389     @param src_address[4] - tunnel source address
390     @param dst_address[4] - tunnel destination address
391     @param intf_address - 
392     @param intf_address_length - 
393 */
394 define mpls_gre_add_del_tunnel {
395     u32 client_index;
396     u32 context;
397     u32 inner_vrf_id;
398     u32 outer_vrf_id;
399     u8 is_add;
400     u8 l2_only;
401     u8 src_address[4];
402     u8 dst_address[4];
403     u8 intfc_address[4];
404     u8 intfc_address_length;
405 };
406
407 /** \brief Reply for add / del tunnel request
408     @param context - returned sender context, to match reply w/ request
409     @param retval - return code
410 */
411 define mpls_gre_add_del_tunnel_reply {
412     u32 context;
413     i32 retval;
414     u32 tunnel_sw_if_index;
415 };
416
417 /** \brief Add / del MPLS encapsulation request
418     @param client_index - opaque cookie to identify the sender
419     @param context - sender context, to match reply w/ request
420     @param vrf_id - vrf id
421     @param dst_address[4] - 
422     @param is_add - 1 if adding the encap, 0 if deleting
423     @param nlabels - number of labels 
424     @param labels - array of labels
425 */
426 define mpls_add_del_encap {
427     u32 client_index;
428     u32 context;
429     u32 vrf_id;
430     u8 dst_address[4];
431     /* 1 = add, 0 = delete */
432     u8 is_add;
433     u8 nlabels;
434     u32 labels[0];
435 }; 
436
437 /** \brief Reply for add / del encapsulation request
438     @param context - returned sender context, to match reply w/ request
439     @param retval - return code
440 */
441 define mpls_add_del_encap_reply {
442     u32 context;
443     i32 retval;
444 };
445
446 /** \brief Add / del MPLS decapsulation request
447     @param client_index - opaque cookie to identify the sender
448     @param context - sender context, to match reply w/ request
449     @param rx_vrf_id - receive vrf
450     @param tx_vrf_id - transmit vrf
451     @param label - 
452     @param next_index - 
453     @param s_bit - 
454     @param is_add - 1 if adding the encap, 0 if deleting
455 */
456 define mpls_add_del_decap {
457     u32 client_index;
458     u32 context;
459     u32 rx_vrf_id;
460     u32 tx_vrf_id;
461     u32 label;
462     u32 next_index;
463     u8 s_bit;
464     u8 is_add;
465 }; 
466
467 /** \brief Reply for MPLS decap add / del request
468     @param context - returned sender context, to match reply w/ request
469     @param retval - return code
470 */
471 define mpls_add_del_decap_reply {
472     u32 context;
473     i32 retval;
474 };
475
476 /** \brief Proxy ARP add / del request
477     @param client_index - opaque cookie to identify the sender
478     @param context - sender context, to match reply w/ request
479     @param vrf_id - VRF / Fib table ID
480     @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
481     @param low_address[4] - Low address of the Proxy ARP range
482     @param hi_address[4] - High address of the Proxy ARP range
483 */
484 define proxy_arp_add_del {
485     u32 client_index;
486     u32 context;
487     u32 vrf_id;
488     u8 is_add;
489     u8 low_address[4];
490     u8 hi_address[4];
491 };
492
493 /** \brief Reply for proxy arp add / del request
494     @param context - returned sender context, to match reply w/ request
495     @param retval - return code
496 */
497 define proxy_arp_add_del_reply {
498     u32 context;
499     i32 retval;
500 };
501
502 /** \brief Proxy ARP add / del request
503     @param client_index - opaque cookie to identify the sender
504     @param context - sender context, to match reply w/ request
505     @param sw_if_index - Which interface to enable / disable Proxy Arp on
506     @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
507 */
508 define proxy_arp_intfc_enable_disable {
509     u32 client_index;
510     u32 context;
511     u32 sw_if_index;
512     /* 1 = on, 0 = off */
513     u8 enable_disable;
514 };
515
516 /** \brief Reply for Proxy ARP interface enable / disable request
517     @param context - returned sender context, to match reply w/ request
518     @param retval - return code
519 */
520 define proxy_arp_intfc_enable_disable_reply {
521     u32 context;
522     i32 retval;
523 };
524
525 /** \brief IP neighbor add / del request
526     @param client_index - opaque cookie to identify the sender
527     @param context - sender context, to match reply w/ request
528     @param vrf_id - vrf_id, only for IP4
529     @param sw_if_index - interface used to reach neighbor
530     @param is_add - 1 to add neighbor, 0 to delete
531     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
532     @param is_static - 
533     @param mac_address - l2 address of the neighbor
534     @param dst_address - ip4 or ip6 address of the neighbor
535 */
536 define ip_neighbor_add_del {
537     u32 client_index;
538     u32 context;
539     u32 vrf_id;                 /* only makes sense for ip4 */
540     u32 sw_if_index;
541     /* 1 = add, 0 = delete */
542     u8 is_add;
543     u8 is_ipv6;
544     u8 is_static;
545     u8 mac_address[6];
546     u8 dst_address[16];
547 };
548
549 /** \brief Reply for IP Neighbor add / delete request
550     @param context - returned sender context, to match reply w/ request
551     @param retval - return code
552 */
553 define ip_neighbor_add_del_reply {
554     u32 context;
555     i32 retval;
556 };
557
558 /** \brief Reset VRF (remove all routes etc) request
559     @param client_index - opaque cookie to identify the sender
560     @param context - sender context, to match reply w/ request
561     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
562     @param vrf_id - ID of th FIB table / VRF to reset
563 */
564 define reset_vrf {
565     u32 client_index;
566     u32 context;
567     u8 is_ipv6;
568     u32 vrf_id;
569 }; 
570
571 /** \brief Reply for Reset VRF request
572     @param context - returned sender context, to match reply w/ request
573     @param retval - return code
574 */
575 define reset_vrf_reply {
576     u32 context;
577     i32 retval;
578 };
579
580 /** \brief Is Address Reachable request - DISABLED
581     @param client_index - opaque cookie to identify the sender
582     @param context - sender context, to match reply w/ request
583     @param next_hop_sw_if_index - index of interface used to get to next hop
584     @param is_ipv6 - 1 for IPv6, 0 for IPv4
585     @param is_error - address not found or does not match intf
586     @param address[] - Address in question 
587 */
588 define is_address_reachable {
589     u32 client_index;           /* (api_main_t *) am->my_client_index */
590     u32 context;
591     u32 next_hop_sw_if_index;
592     u8 is_known;                /* on reply, this is the answer */
593     u8 is_ipv6;
594     u8 is_error;                /* address not found or does not match intf */
595     u8 address[16];
596 };
597
598 /** \brief Want Stats, register for stats updates
599     @param client_index - opaque cookie to identify the sender
600     @param context - sender context, to match reply w/ request
601     @param enable_disable - 1 = enable stats, 0 = disable
602     @param pid - pid of process requesting stats updates
603 */
604 define want_stats {
605     u32 client_index;
606     u32 context;
607     u32 enable_disable;
608     u32 pid;
609 };
610
611 /** \brief Reply for Want Stats request
612     @param context - returned sender context, to match reply w/ request
613     @param retval - return code
614 */
615 manual_java define want_stats_reply {
616     u32 context;
617     i32 retval;
618 };
619
620 /** \brief Want stats counters structure 
621     @param vnet_counter_type- such as ip4, ip6, punts, etc
622     @param is_combined - rx & tx total (all types) counts   
623     @param first_sw_if_index - first sw index in block of index, counts
624     @param count - number of interfaces this stats block includes counters for
625     @param data - contiguous block of vlib_counter_t structures 
626 */
627 manual_java define vnet_interface_counters {
628     /* enums - plural - in vnet/interface.h */
629     u8 vnet_counter_type;
630     u8 is_combined;
631     u32 first_sw_if_index;
632     u32 count;
633     u8 data[0];
634 };
635
636 typeonly manual_print manual_endian define ip4_fib_counter {
637     u32 address;
638     u8 address_length;
639     u64 packets;
640     u64 bytes;
641 };
642
643 manual_java manual_print manual_endian define vnet_ip4_fib_counters {
644     u32 vrf_id;
645     u32 count;
646     vl_api_ip4_fib_counter_t c[count];
647 };
648
649 typeonly manual_print manual_endian define ip6_fib_counter {
650     u64 address[2];
651     u8 address_length;
652     u64 packets;
653     u64 bytes;
654 };
655
656 manual_java manual_print manual_endian define vnet_ip6_fib_counters {
657     u32 vrf_id;
658     u32 count;
659     vl_api_ip6_fib_counter_t c[count];
660 };
661
662 /** \brief Request for a single block of summary stats
663     @param client_index - opaque cookie to identify the sender
664     @param context - sender context, to match reply w/ request
665 */
666 define vnet_get_summary_stats {
667     u32 client_index;
668     u32 context;
669 };
670
671 /** \brief Reply for vnet_get_summary_stats request
672     @param context - sender context, to match reply w/ request
673     @param retval - return code for request
674     @param total_pkts -  
675     @param total_bytes -
676     @param vector_rate - 
677 */
678 define vnet_summary_stats_reply {
679     u32 context;
680     i32 retval;
681     u64 total_pkts[2];
682     u64 total_bytes[2];
683     f64 vector_rate; 
684 };
685
686 /** \brief OAM event structure
687     @param dst_address[] - 
688     @param state
689 */
690 manual_java define oam_event {
691     u8 dst_address[4];
692     u8 state;
693 };
694
695 /** \brief Want OAM events request
696     @param client_index - opaque cookie to identify the sender
697     @param context - sender context, to match reply w/ request
698     @param enable_disable- enable if non-zero, else disable
699     @param pid - pid of the requesting process
700 */
701 define want_oam_events {
702     u32 client_index;
703     u32 context;
704     u32 enable_disable;
705     u32 pid;
706 };
707
708 /** \brief Want OAM events response
709     @param context - sender context, to match reply w/ request
710     @param retval - return code for the want oam stats request
711 */
712 define want_oam_events_reply {
713     u32 context;
714     i32 retval;
715 };
716
717 /** \brief OAM add / del target request
718     @param client_index - opaque cookie to identify the sender
719     @param context - sender context, to match reply w/ request
720     @param vrf_id - vrf_id of the target
721     @param src_address[] - source address to use for the updates 
722     @param dst_address[] - destination address of the target
723     @param is_add - add target if non-zero, else delete
724 */
725 define oam_add_del {
726     u32 client_index;
727     u32 context;
728     u32 vrf_id;
729     u8 src_address[4];
730     u8 dst_address[4];
731     u8 is_add;
732 };
733
734 /** \brief OAM add / del target response
735     @param context - sender context, to match reply w/ request
736     @param retval - return code of the request
737 */
738 define oam_add_del_reply {
739     u32 context;
740     i32 retval;
741 };
742
743 /** \brief Reset fib table request
744     @param client_index - opaque cookie to identify the sender
745     @param context - sender context, to match reply w/ request
746     @param vrf_id - vrf/table id of the fib table to reset
747     @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
748 */
749 define reset_fib {
750     u32 client_index;
751     u32 context;
752     u32 vrf_id;
753     u8 is_ipv6;
754 };
755
756 /** \brief Reset fib response
757     @param context - sender context, to match reply w/ request
758     @param retval - return code for the reset bfib request
759 */
760 define reset_fib_reply {
761     u32 context;
762     i32 retval;
763 };
764
765 /** \brief DHCP Proxy config add / del request
766     @param client_index - opaque cookie to identify the sender
767     @param context - sender context, to match reply w/ request
768     @param vrf_id - vrf id
769     @param if_ipv6 - ipv6 if non-zero, else ipv4
770     @param is_add - add the config if non-zero, else delete
771     @param insert_circuit_id - option82 suboption 1 fib number
772     @param dhcp_server[] - server address
773     @param dhcp_src_address[] - <fix this, need details>
774 */
775 define dhcp_proxy_config {
776     u32 client_index;
777     u32 context;
778     u32 vrf_id;
779     u8 is_ipv6;
780     u8 is_add;
781     u8 insert_circuit_id;
782     u8 dhcp_server[16];
783     u8 dhcp_src_address[16];
784 };
785
786 /** \brief DHCP Proxy config response
787     @param context - sender context, to match reply w/ request
788     @param retval - return code for the request
789 */
790 define dhcp_proxy_config_reply {
791     u32 context;
792     i32 retval;
793 };
794
795 /** \brief DHCP Proxy set / unset vss request
796     @param client_index - opaque cookie to identify the sender
797     @param context - sender context, to match reply w/ request
798     @param tbl_id - table id
799     @param oui - first part of vpn id
800     @param fib_id - second part of vpn id
801     @param is_ipv6 - ip6 if non-zero, else ip4
802     @param is_add - set vss if non-zero, else delete
803 */
804 define dhcp_proxy_set_vss {
805     u32 client_index;
806     u32 context;
807     u32 tbl_id;
808     u32 oui;
809     u32 fib_id;
810     u8 is_ipv6;
811     u8 is_add;
812 };
813
814 /** \brief DHCP proxy set / unset vss response
815     @param context - sender context, to match reply w/ request
816     @param retval - return code for the request
817 */
818 define dhcp_proxy_set_vss_reply {
819     u32 context;
820     i32 retval;
821 };
822
823 /** \brief Set the ip flow hash config for a fib request
824     @param client_index - opaque cookie to identify the sender
825     @param context - sender context, to match reply w/ request
826     @param vrf_id - vrf/fib id
827     @param is_ipv6 - if non-zero the fib is ip6, else ip4
828     @param src - if non-zero include src in flow hash
829     @param dst - if non-zero include dst in flow hash
830     @param sport - if non-zero include sport in flow hash
831     @param dport - if non-zero include dport in flow hash
832     @param proto -if non-zero include proto in flow hash
833     @param reverse - if non-zero include reverse in flow hash
834 */
835 define set_ip_flow_hash {
836     u32 client_index;
837     u32 context;
838     u32 vrf_id;
839     u8 is_ipv6;
840     u8 src;
841     u8 dst;
842     u8 sport;
843     u8 dport;
844     u8 proto;
845     u8 reverse;
846 };
847
848 /** \brief Set the ip flow hash config for a fib response
849     @param context - sender context, to match reply w/ request
850     @param retval - return code for the request
851 */
852 define set_ip_flow_hash_reply {
853     u32 context;
854     i32 retval;
855 };
856
857 /** \brief IPv6 router advertisement config request
858     @param client_index - opaque cookie to identify the sender
859     @param context - sender context, to match reply w/ request
860     @param suppress -
861     @param managed -
862     @param other -
863     @param ll_option -
864     @param send_unicast -
865     @param cease -
866     @param is_no -
867     @param default_router -
868     @param max_interval -
869     @param min_interval -
870     @param lifetime -
871     @param initial_count -
872     @param initial_interval -
873 */
874 define sw_interface_ip6nd_ra_config {
875     u32 client_index;
876     u32 context;
877     u32 sw_if_index;
878     u8 suppress;
879     u8  managed;
880     u8 other;
881     u8 ll_option;
882     u8 send_unicast;
883     u8 cease;
884     u8 is_no;
885     u8 default_router;
886     u32 max_interval;
887     u32 min_interval;
888     u32 lifetime;
889     u32 initial_count;
890     u32 initial_interval;
891 };
892
893 /** \brief IPv6 router advertisement config response
894     @param context - sender context, to match reply w/ request
895     @param retval - return code for the request
896 */
897 define sw_interface_ip6nd_ra_config_reply {
898     u32 context;
899     i32 retval;
900 };
901
902 /** \brief IPv6 router advertisement prefix config request
903     @param client_index - opaque cookie to identify the sender
904     @param context - sender context, to match reply w/ request
905     @param sw_if_index - 
906     @param address[] -
907     @param address_length -
908     @param use_default -
909     @param no_advertise -
910     @param off_link -
911     @param no_autoconfig -
912     @param no_onlink -
913     @param is_no -
914     @param val_lifetime -
915     @param pref_lifetime -
916 */
917 define sw_interface_ip6nd_ra_prefix {
918     u32 client_index;
919     u32 context;
920     u32 sw_if_index;
921     u8 address[16];
922     u8 address_length;
923     u8 use_default;
924     u8 no_advertise;
925     u8 off_link;
926     u8 no_autoconfig;
927     u8 no_onlink;
928     u8 is_no;
929     u32 val_lifetime;
930     u32 pref_lifetime;
931 };
932
933 /** \brief IPv6 router advertisement prefix config response
934     @param context - sender context, to match reply w/ request
935     @param retval - return code for the request
936 */
937 define sw_interface_ip6nd_ra_prefix_reply {
938     u32 context;
939     i32 retval;
940 };
941
942 /** \brief IPv6 interface enable / disable request
943     @param client_index - opaque cookie to identify the sender
944     @param context - sender context, to match reply w/ request
945     @param sw_if_index - interface used to reach neighbor
946     @param enable - if non-zero enable ip6 on interface, else disable
947 */
948 define sw_interface_ip6_enable_disable  {
949     u32 client_index;
950     u32 context;
951     u32 sw_if_index;
952     u8 enable;                        /* set to true if enable*/
953 };
954
955 /** \brief IPv6 interface enable / disable response
956     @param context - sender context, to match reply w/ request
957     @param retval - return code for the request
958 */
959 define  sw_interface_ip6_enable_disable_reply {
960     u32 context;
961     i32 retval;
962 };
963
964 /** \brief IPv6 set link local address on interface request
965     @param client_index - opaque cookie to identify the sender
966     @param context - sender context, to match reply w/ request
967     @param sw_if_index - interface to set link local on
968     @param address[] - the new link local address
969     @param address_length - link local address length
970 */
971 define sw_interface_ip6_set_link_local_address  {
972     u32 client_index;
973     u32 context;
974     u32 sw_if_index;
975     u8 address[16];
976     u8 address_length;
977 };
978
979 /** \brief IPv6 set link local address on interface response
980     @param context - sender context, to match reply w/ request
981     @param retval - error code for the request
982 */
983 define  sw_interface_ip6_set_link_local_address_reply {
984     u32 context;
985     i32 retval;
986 };
987
988 /** \brief Set unnumbered interface add / del request
989     @param client_index - opaque cookie to identify the sender
990     @param context - sender context, to match reply w/ request
991     @param sw_if_index - interface with an IP address
992     @param unnumbered_sw_if_index - interface which will use the address
993     @param is_add - if non-zero set the association, else unset it
994 */
995 define sw_interface_set_unnumbered {
996     u32 client_index;
997     u32 context;
998     u32 sw_if_index;            /* use this intfc address */
999     u32 unnumbered_sw_if_index; /* on this interface */
1000     u8 is_add;
1001 };
1002
1003 /** \brief Set unnumbered interface add / del response
1004     @param context - sender context, to match reply w/ request
1005     @param retval - return code for the request
1006 */
1007 define  sw_interface_set_unnumbered_reply {
1008     u32 context;
1009     i32 retval;
1010 };
1011
1012 /** \brief Create loopback interface request
1013     @param client_index - opaque cookie to identify the sender
1014     @param context - sender context, to match reply w/ request
1015     @param mac_address - mac addr to assign to the interface if none-zero
1016 */
1017 define create_loopback {
1018     u32 client_index;
1019     u32 context;
1020     u8  mac_address[6];
1021 };
1022
1023 /** \brief Create loopback interface response
1024     @param context - sender context, to match reply w/ request
1025     @param sw_if_index - sw index of the interface that was created
1026     @param retval - return code for the request
1027 */
1028 define create_loopback_reply {
1029     u32 context;
1030     i32 retval;
1031     u32 sw_if_index;
1032 };
1033
1034 /** \brief Delete loopback interface request
1035     @param client_index - opaque cookie to identify the sender
1036     @param context - sender context, to match reply w/ request
1037     @param sw_if_index - sw index of the interface that was created
1038 */
1039 define delete_loopback {
1040     u32 client_index;
1041     u32 context;
1042     u32 sw_if_index;
1043 };
1044
1045 /** \brief Delete loopback interface response
1046     @param context - sender context, to match reply w/ request
1047     @param retval - return code for the request
1048 */
1049 define delete_loopback_reply {
1050     u32 context;
1051     i32 retval;
1052 };
1053
1054 /** \brief Control ping from client to api server request
1055     @param client_index - opaque cookie to identify the sender
1056     @param context - sender context, to match reply w/ request
1057 */
1058 manual_java define control_ping {
1059     u32 client_index;
1060     u32 context;
1061 };
1062
1063 /** \brief Control ping from the client to the server response
1064     @param client_index - opaque cookie to identify the sender
1065     @param context - sender context, to match reply w/ request
1066     @param retval - return code for the request
1067     @param vpe_pid - the pid of the vpe, returned by the server
1068 */
1069 manual_java define control_ping_reply {
1070     u32 context;
1071     i32 retval;
1072     u32 client_index;
1073     u32 vpe_pid;
1074 };
1075
1076 /** \brief Process a vpe parser cli string request
1077     @param client_index - opaque cookie to identify the sender
1078     @param context - sender context, to match reply w/ request
1079     @param cmd_in_shmem - pointer to cli command string
1080 */
1081 define cli_request {
1082     u32 client_index;
1083     u32 context;
1084     u64 cmd_in_shmem;
1085 };
1086
1087 /** \brief vpe parser cli string response
1088     @param context - sender context, to match reply w/ request
1089     @param retval - return code for request
1090     @param reply_in_shmem - Reply string from cli processing if any
1091 */
1092 define cli_reply {
1093     u32 context;
1094     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 eid_type:
2205       0 : ipv4
2206       1 : ipv6
2207       2 : mac
2208     @param eid - EID can be ip4, ip6 or mac
2209     @param prefix_len - prefix len
2210     @param locator_set_name - name of locator_set to add/del eid-table
2211     @param vni - virtual network instance
2212 */
2213 define lisp_add_del_local_eid {
2214     u32 client_index;
2215     u32 context;
2216     u8  is_add;
2217     u8  eid_type;
2218     u8  eid[16];
2219     u8  prefix_len;
2220     u8  locator_set_name[64];
2221     u32 vni;
2222 };
2223
2224 /** \brief Reply for local_eid add/del
2225     @param context - returned sender context, to match reply w/ request
2226     @param retval - return code
2227 */
2228 define lisp_add_del_local_eid_reply {
2229     u32 context;
2230     i32 retval;
2231 };
2232
2233 /** \brief add or delete lisp gpe maptunel
2234     @param client_index - opaque cookie to identify the sender
2235     @param context - sender context, to match reply w/ request
2236     @param is_add - add address if non-zero, else delete
2237     @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2238     @param eid_ip_address - array of address bytes
2239     @param eid_prefix_len - prefix len
2240     @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2241     @param source_ip_address - array of address bytes
2242     @param destination_ip_address - array of address bytes
2243 */
2244 define lisp_gpe_add_del_fwd_entry {
2245     u32 client_index;
2246     u32 context;
2247     u8  is_add;
2248     u8  eid_is_ipv6;
2249     u8  eid_ip_address[16];
2250     u8  eid_prefix_len;
2251     u8  address_is_ipv6;
2252     u8  source_ip_address[16];
2253     u8  destination_ip_address[16];
2254 };
2255
2256 /** \brief Reply for gpe_fwd_entry add/del
2257     @param context - returned sender context, to match reply w/ request
2258     @param retval - return code
2259 */
2260 define lisp_gpe_add_del_fwd_entry_reply {
2261     u32 context;
2262     i32 retval;
2263 };
2264
2265 /** \brief add or delete map-resolver
2266     @param client_index - opaque cookie to identify the sender
2267     @param context - sender context, to match reply w/ request
2268     @param is_add - add address if non-zero, else delete
2269     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2270     @param ip_address - array of address bytes
2271 */
2272 define lisp_add_del_map_resolver {
2273     u32 client_index;
2274     u32 context;
2275     u8  is_add;
2276     u8  is_ipv6;
2277     u8  ip_address[16];
2278 };
2279
2280 /** \brief Reply for map_resolver add/del
2281     @param context - returned sender context, to match reply w/ request
2282     @param retval - return code
2283 */
2284 define lisp_add_del_map_resolver_reply {
2285     u32 context;
2286     i32 retval;
2287 };
2288
2289 /** \brief enable or disable lisp-gpe protocol
2290     @param client_index - opaque cookie to identify the sender
2291     @param context - sender context, to match reply w/ request
2292     @param is_en - enable protocol if non-zero, else disable
2293 */
2294 define lisp_gpe_enable_disable {
2295     u32 client_index;
2296     u32 context;
2297     u8  is_en;
2298 };
2299
2300 /** \brief Reply for gpe enable/disable
2301     @param context - returned sender context, to match reply w/ request
2302     @param retval - return code
2303 */
2304 define lisp_gpe_enable_disable_reply {
2305     u32 context;
2306     i32 retval;
2307 };
2308
2309 /** \brief enable or disable LISP feature
2310     @param client_index - opaque cookie to identify the sender
2311     @param context - sender context, to match reply w/ request
2312     @param is_en - enable protocol if non-zero, else disable
2313 */
2314 define lisp_enable_disable {
2315     u32 client_index;
2316     u32 context;
2317     u8  is_en;
2318 };
2319
2320 /** \brief Reply for gpe enable/disable
2321     @param context - returned sender context, to match reply w/ request
2322     @param retval - return code
2323 */
2324 define lisp_enable_disable_reply {
2325     u32 context;
2326     i32 retval;
2327 };
2328
2329 /** \brief add or delete gpe_iface
2330     @param client_index - opaque cookie to identify the sender
2331     @param context - sender context, to match reply w/ request
2332     @param is_add - add address if non-zero, else delete
2333 */
2334 define lisp_gpe_add_del_iface {
2335     u32 client_index;
2336     u32 context;
2337     u8  is_add;
2338     u32 table_id;
2339     u32 vni;
2340 };
2341
2342 /** \brief Reply for gpe_iface add/del
2343     @param context - returned sender context, to match reply w/ request
2344     @param retval - return code
2345 */
2346 define lisp_gpe_add_del_iface_reply {
2347     u32 context;
2348     i32 retval;
2349 };
2350
2351 /** \brief configure or disable LISP PITR node
2352     @param client_index - opaque cookie to identify the sender
2353     @param context - sender context, to match reply w/ request
2354     @param ls_name - locator set name
2355     @param is_add - add locator set if non-zero, else disable pitr
2356 */
2357 define lisp_pitr_set_locator_set {
2358     u32 client_index;
2359     u32 context;
2360     u8 is_add;
2361     u8 ls_name[64];
2362 };
2363
2364 /** \brief Reply for lisp_pitr_set_locator_set
2365     @param context - returned sender context, to match reply w/ request
2366     @param retval - return code
2367 */
2368 define lisp_pitr_set_locator_set_reply {
2369     u32 context;
2370     i32 retval;
2371 };
2372
2373 /** \brief add or delete remote static mapping
2374     @param client_index - opaque cookie to identify the sender
2375     @param context - sender context, to match reply w/ request
2376     @param is_add - add address if non-zero, else delete
2377     @param del_all - if set, delete all remote mappings
2378     @param vni - virtual network instance
2379     @param action - negative map-reply action
2380     @param eid_type -
2381       0 : ipv4
2382       1 : ipv6
2383       2 : mac
2384     @param deid - destination EID
2385     @param seid - source EID
2386     @param rloc_num - number of remote locators
2387     @param rlocs - remote locator data
2388 */
2389 define lisp_add_del_remote_mapping {
2390     u32 client_index;
2391     u32 context;
2392     u8  is_add;
2393     u8 del_all;
2394     u32 vni;
2395     u8 action;
2396     u8 eid_type;
2397     u8 deid[16];
2398     u8 seid[16];
2399     u8 deid_len;
2400     u8 seid_len;
2401     u32 rloc_num;
2402     u8 rlocs[0];
2403 };
2404
2405 /** \brief Reply for lisp_add_del_remote_mapping
2406     @param context - returned sender context, to match reply w/ request
2407     @param retval - return code
2408 */
2409 define lisp_add_del_remote_mapping_reply {
2410     u32 context;
2411     i32 retval;
2412 };
2413
2414 /** \brief add or delete LISP adjacency adjacency
2415     @param client_index - opaque cookie to identify the sender
2416     @param context - sender context, to match reply w/ request
2417     @param is_add - add address if non-zero, else delete
2418     @param vni - virtual network instance
2419     @param action - negative mapping action
2420     @param eid_type -
2421       0 : ipv4
2422       1 : ipv6
2423       2 : mac
2424     @param deid - destination EID
2425     @param seid - source EID
2426     @param rloc_num - number of remote locators
2427     @param rlocs - remote locator data
2428 */
2429 define lisp_add_del_adjacency {
2430     u32 client_index;
2431     u32 context;
2432     u8  is_add;
2433     u32 vni;
2434     u8 action;
2435     u8 eid_type;
2436     u8 deid[16];
2437     u8 seid[16];
2438     u8 deid_len;
2439     u8 seid_len;
2440     u32 rloc_num;
2441     u8 rlocs[0];
2442 };
2443
2444 /** \brief Reply for lisp_add_del_adjacency
2445     @param context - returned sender context, to match reply w/ request
2446     @param retval - return code
2447 */
2448 define lisp_add_del_adjacency_reply {
2449     u32 context;
2450     i32 retval;
2451 };
2452
2453 /** \brief add or delete map request itr rlocs
2454     @param client_index - opaque cookie to identify the sender
2455     @param context - sender context, to match reply w/ request
2456     @param is_add - add address if non-zero, else delete
2457     @param locator_set_name - locator set name
2458 */
2459 define lisp_add_del_map_request_itr_rlocs {
2460     u32 client_index;
2461     u32 context;
2462     u8 is_add;
2463     u8 locator_set_name[64];
2464 };
2465
2466 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2467     @param context - returned sender context, to match reply w/ request
2468     @param retval - return code
2469 */
2470
2471 define lisp_add_del_map_request_itr_rlocs_reply {
2472     u32 context;
2473     i32 retval;
2474 };
2475
2476 /** \brief map/unmap vni to vrf
2477     @param client_index - opaque cookie to identify the sender
2478     @param context - sender context, to match reply w/ request
2479     @param is_add - add or delete mapping
2480     @param vni - virtual network id
2481     @param vrf - vrf
2482 */
2483 define lisp_eid_table_add_del_map {
2484     u32 client_index;
2485     u32 context;
2486     u8 is_add;
2487     u32 vni;
2488     u32 vrf;
2489 };
2490
2491 /** \brief Reply for lisp_eid_table_add_del_map
2492     @param context - returned sender context, to match reply w/ request
2493     @param retval - return code
2494 */
2495 define lisp_eid_table_add_del_map_reply {
2496     u32 context;
2497     i32 retval;
2498 };
2499
2500 /** \brief LISP locator_set status
2501     @param locator_set_name - name of the locator_set
2502     @param sw_if_index - sw_if_index of the locator
2503     @param priority - locator priority
2504     @param weight - locator weight
2505  */
2506 manual_java define lisp_locator_set_details {
2507     u32 context;
2508     u8  local;
2509     u8  locator_set_name[64];
2510     u32 sw_if_index;
2511     u8  is_ipv6;
2512     u8  ip_address[16];
2513     u8  prefix_len;
2514     u8  priority;
2515     u8  weight;
2516 };
2517
2518 /** \brief Request for locator_set summary status
2519     @param client_index - opaque cookie to identify the sender
2520     @param context - sender context, to match reply w/ request
2521  */
2522 define lisp_locator_set_dump {
2523     u32 client_index;
2524     u32 context;
2525 };
2526
2527 /** \brief LISP local eid table status
2528     @param locator_set_name - name of the locator_set
2529     @param eid_type - ip4, ip6 or l2 mac address
2530     @param eid - array of address bytes
2531     @param eid_prefix_len - prefix len
2532  */
2533 manual_java define lisp_local_eid_table_details {
2534     u32 context;
2535     u8  locator_set_name[64];
2536     u8  eid_type;
2537     u32 vni;
2538     u8  eid[16];
2539     u8  eid_prefix_len;
2540 };
2541
2542 /** \brief Request for local eid table summary status
2543     @param client_index - opaque cookie to identify the sender
2544     @param context - sender context, to match reply w/ request
2545     @param eid_set - if non-zero request info about specific mapping
2546     @param vni - virtual network instance; valid only if eid_set != 0
2547     @param prefix_length - prefix length if EID is IP address;
2548       valid only if eid_set != 0
2549     @param eid_type - EID type; valid only if eid_set != 0
2550       Supported values:
2551         0: EID is IPv4
2552         1: EID is IPv6
2553         2: EID is ethernet address
2554     @param eid - endpoint identifier
2555  */
2556 define lisp_local_eid_table_dump {
2557     u32 client_index;
2558     u32 context;
2559     u8  eid_set;
2560     u8  prefix_length;
2561     u32 vni;
2562     u8  eid_type;
2563     u8  eid[16];
2564 };
2565
2566 /** \brief Shows relationship between vni and vrf
2567     @param vrf - VRF index
2568     @param vni - vitual network instance
2569   */
2570 manual_java define lisp_eid_table_map_details {
2571     u32 context;
2572     u32 vni;
2573     u32 vrf;
2574 };
2575
2576 /** \brief Request for lisp_eid_table_map_details
2577     @param client_index - opaque cookie to identify the sender
2578     @param context - sender context, to match reply w/ request
2579  */
2580 define lisp_eid_table_map_dump {
2581     u32 client_index;
2582     u32 context;
2583 };
2584
2585 manual_java define lisp_gpe_tunnel_details {
2586     u32 context;
2587     u32 tunnels;
2588     u8  is_ipv6;
2589     u8  source_ip[16];
2590     u8  destination_ip[16];
2591     u32 encap_fib_id;
2592     u32 decap_fib_id;
2593     u32 dcap_next;
2594     u8  lisp_ver;
2595     u8  next_protocol;
2596     u8  flags;
2597     u8  ver_res;
2598     u8  res;
2599     u32 iid;
2600 };
2601
2602 /** \brief Request for gpe tunnel summary status
2603     @param client_index - opaque cookie to identify the sender
2604     @param context - sender context, to match reply w/ request
2605  */
2606 define lisp_gpe_tunnel_dump {
2607     u32 client_index;
2608     u32 context;
2609 };
2610
2611 /** \brief LISP map resolver status
2612     @param locator_set_name - name of the locator_set
2613     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2614     @param ip_address - array of address bytes
2615  */
2616 manual_java define lisp_map_resolver_details {
2617     u32 context;
2618     u8  is_ipv6;
2619     u8  ip_address[16];
2620 };
2621
2622 /** \brief Request for map resolver summary status
2623     @param client_index - opaque cookie to identify the sender
2624     @param context - sender context, to match reply w/ request
2625  */
2626 define lisp_map_resolver_dump {
2627     u32 client_index;
2628     u32 context;
2629 };
2630
2631 /** \brief Status of lisp-gpe protocol, enable or disable
2632     @param context - sender context, to match reply w/ request
2633     @param is_en - enable protocol if non-zero, else disable
2634 */
2635 manual_java define lisp_enable_disable_status_details {
2636     u32 context;
2637     u8 feature_status;
2638     u8 gpe_status;
2639 };
2640
2641 /** \brief Request for lisp-gpe protocol status
2642     @param client_index - opaque cookie to identify the sender
2643     @param context - sender context, to match reply w/ request
2644 */
2645 define lisp_enable_disable_status_dump {
2646     u32 client_index;
2647     u32 context;
2648 };
2649
2650 /** \brief Get LISP map request itr rlocs status
2651     @param context - sender context, to match reply w/ request
2652     @param locator_set_name - name of the locator_set
2653  */
2654 define lisp_get_map_request_itr_rlocs {
2655     u32 client_index;
2656     u32 context;
2657 };
2658
2659 /** \brief Request for map request itr rlocs summary status
2660  */
2661 define lisp_get_map_request_itr_rlocs_reply {
2662     u32 context;
2663     i32 retval;
2664     u8 locator_set_name[64];
2665 };
2666
2667 /* Gross kludge, DGMS */
2668 define interface_name_renumber {
2669     u32 client_index;
2670     u32 context;
2671     u32 sw_if_index;
2672     u32 new_show_dev_instance;
2673 };
2674
2675 define interface_name_renumber_reply {
2676     u32 context;
2677     i32 retval;
2678 };
2679
2680 /** \brief Register for ip4 arp resolution events
2681     @param client_index - opaque cookie to identify the sender
2682     @param context - sender context, to match reply w/ request
2683     @param enable_disable - 1 => register for events, 0 => cancel registration
2684     @param pid - sender's pid
2685     @param address - the exact ip4 address of interest
2686 */
2687 define want_ip4_arp_events {
2688     u32 client_index;
2689     u32 context;
2690     u8 enable_disable;
2691     u32 pid;
2692     u32 address;
2693 };
2694
2695 /** \brief Reply for interface events registration
2696     @param context - returned sender context, to match reply w/ request
2697     @param retval - return code
2698 */
2699 define want_ip4_arp_events_reply {
2700     u32 context;
2701     i32 retval;
2702 };
2703
2704 /** \brief Tell client about an ip4 arp resolution event
2705     @param client_index - opaque cookie to identify the sender
2706     @param context - sender context, to match reply w/ request
2707     @param address - the exact ip4 address of interest
2708     @param pid - client pid registered to receive notification
2709     @param sw_if_index - interface which received ARP packet
2710     @param new_mac - the new mac address 
2711 */
2712 define ip4_arp_event {
2713     u32 client_index;
2714     u32 context;
2715     u32 address;
2716     u32 pid;
2717     u32 sw_if_index;
2718     u8 new_mac[6];
2719 };
2720     
2721 /** \brief L2 bridge domain add or delete request
2722     @param client_index - opaque cookie to identify the sender
2723     @param context - sender context, to match reply w/ request
2724     @param bd_id - the bridge domain to create
2725     @param flood - enable/disable bcast/mcast flooding in the bd
2726     @param uu_flood - enable/disable uknown unicast flood in the bd
2727     @param forward - enable/disable forwarding on all interfaces in the bd
2728     @param learn - enable/disable learning on all interfaces in the bd
2729     @param arp_term - enable/disable arp termination in the bd
2730     @param is_add - add or delete flag
2731 */
2732 define bridge_domain_add_del {
2733     u32 client_index;
2734     u32 context;
2735     u32 bd_id;
2736     u8 flood;
2737     u8 uu_flood;
2738     u8 forward;
2739     u8 learn;
2740     u8 arp_term;
2741     u8 is_add;
2742 };
2743
2744 /** \brief L2 bridge domain add or delete response
2745     @param context - sender context, to match reply w/ request
2746     @param retval - return code for the set bridge flags request
2747 */
2748 define bridge_domain_add_del_reply {
2749     u32 context;
2750     u32 retval;
2751 };
2752
2753 /** \brief L2 bridge domain request operational state details
2754     @param client_index - opaque cookie to identify the sender
2755     @param context - sender context, to match reply w/ request
2756     @param bd_id - the bridge domain id desired or ~0 to request all bds
2757 */
2758 manual_java define bridge_domain_dump {
2759     u32 client_index;
2760     u32 context;
2761     u32 bd_id;
2762 };
2763
2764 /** \brief L2 bridge domain operational state response
2765     @param bd_id - the bridge domain id
2766     @param flood - bcast/mcast flooding state on all interfaces in the bd
2767     @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2768     @param forward - forwarding state on all interfaces in the bd
2769     @param learn - learning state on all interfaces in the bd
2770     @param arp_term - arp termination state on all interfaces in the bd
2771     @param n_sw_ifs - number of sw_if_index's in the domain
2772 */
2773 manual_java define bridge_domain_details {
2774     u32 context;
2775     u32 bd_id;
2776     u8 flood;
2777     u8 uu_flood;
2778     u8 forward;
2779     u8 learn;
2780     u8 arp_term;
2781     u32 bvi_sw_if_index;
2782     u32 n_sw_ifs;
2783 };
2784
2785 /** \brief L2 bridge domain sw interface operational state response
2786     @param bd_id - the bridge domain id
2787     @param sw_if_index - sw_if_index in the domain
2788     @param shg - split horizon group for the interface
2789 */
2790 manual_java define bridge_domain_sw_if_details {
2791     u32 context;
2792     u32 bd_id;
2793     u32 sw_if_index;
2794     u8 shg;
2795 };
2796
2797 /** \brief DHCP Client config add / del request
2798     @param client_index - opaque cookie to identify the sender
2799     @param context - sender context, to match reply w/ request
2800     @param sw_if_index - index of the interface for DHCP client
2801     @param hostname - hostname
2802     @param is_add - add the config if non-zero, else delete
2803     @param want_dhcp_event - DHCP event sent to the sender
2804            via dhcp_compl_event API message if non-zero
2805     @param pid - sender's pid
2806 */
2807 define dhcp_client_config {
2808     u32 client_index;
2809     u32 context;
2810     u32 sw_if_index;
2811     u8 hostname[64];
2812     u8 is_add;
2813     u8 want_dhcp_event;
2814     u32 pid;
2815 };
2816
2817 /** \brief DHCP Client config response
2818     @param context - sender context, to match reply w/ request
2819     @param retval - return code for the request
2820 */
2821 define dhcp_client_config_reply {
2822     u32 context;
2823     i32 retval;
2824 };
2825
2826 /** \brief Set/unset input ACL interface
2827     @param client_index - opaque cookie to identify the sender
2828     @param context - sender context, to match reply w/ request
2829     @param sw_if_index - interface to set/unset input ACL
2830     @param ip4_table_index - ip4 classify table index (~0 for skip)
2831     @param ip6_table_index - ip6 classify table index (~0 for skip)
2832     @param l2_table_index  -  l2 classify table index (~0 for skip)
2833     @param is_add - Set input ACL if non-zero, else unset
2834     Note: User is recommeneded to use just one valid table_index per call.
2835           (ip4_table_index, ip6_table_index, or l2_table_index)
2836 */
2837 define input_acl_set_interface {
2838     u32 client_index;
2839     u32 context;
2840     u32 sw_if_index;
2841     u32 ip4_table_index;
2842     u32 ip6_table_index;
2843     u32 l2_table_index;
2844     u8  is_add;
2845 };
2846
2847 /** \brief Set/unset input ACL interface response
2848     @param context - sender context, to match reply w/ request
2849     @param retval - return code for the request
2850 */
2851 define input_acl_set_interface_reply {
2852     u32 context;
2853     i32 retval;
2854 };
2855
2856 /** \brief IPsec: Add/delete Security Policy Database
2857     @param client_index - opaque cookie to identify the sender
2858     @param context - sender context, to match reply w/ request
2859     @param is_add - add SPD if non-zero, else delete
2860     @param spd_id - SPD instance id (control plane allocated)
2861 */
2862
2863 define ipsec_spd_add_del {
2864     u32 client_index;
2865     u32 context;
2866     u8 is_add;
2867     u32 spd_id;
2868 };
2869
2870 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2871     @param context - returned sender context, to match reply w/ request
2872     @param retval - return code
2873 */
2874
2875 define ipsec_spd_add_del_reply {
2876     u32 context;
2877     i32 retval;
2878 };
2879
2880 /** \brief IPsec: Add/delete SPD from interface
2881
2882     @param client_index - opaque cookie to identify the sender
2883     @param context - sender context, to match reply w/ request
2884     @param is_add - add security mode if non-zero, else delete
2885     @param sw_if_index - index of the interface
2886     @param spd_id - SPD instance id to use for lookups
2887 */
2888
2889
2890 define ipsec_interface_add_del_spd {
2891     u32 client_index;
2892     u32 context;
2893
2894     u8 is_add;
2895     u32 sw_if_index;
2896     u32 spd_id;
2897 };
2898
2899 /** \brief Reply for IPsec: Add/delete SPD from interface
2900     @param context - returned sender context, to match reply w/ request
2901     @param retval - return code
2902 */
2903
2904 define ipsec_interface_add_del_spd_reply {
2905     u32 context;
2906     i32 retval;
2907 };
2908
2909 /** \brief IPsec: Add/delete Security Policy Database entry
2910
2911     See RFC 4301, 4.4.1.1 on how to match packet to selectors
2912
2913     @param client_index - opaque cookie to identify the sender
2914     @param context - sender context, to match reply w/ request
2915     @param is_add - add SPD if non-zero, else delete
2916     @param spd_id - SPD instance id (control plane allocated)
2917     @param priority - priority of SPD entry (non-unique value).  Used to order SPD matching - higher priorities match before lower
2918     @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2919     @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2920     @param remote_address_start - start of remote address range to match
2921     @param remote_address_stop - end of remote address range to match
2922     @param local_address_start - start of local address range to match
2923     @param local_address_stop - end of local address range to match
2924     @param protocol - protocol type to match [0 means any]
2925     @param remote_port_start - start of remote port range to match ...
2926     @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2927     @param local_port_start - start of local port range to match ...
2928     @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2929     @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)
2930     @param sa_id - SAD instance id (control plane allocated)
2931
2932 */
2933
2934 define ipsec_spd_add_del_entry {
2935     u32 client_index;
2936     u32 context;
2937     u8 is_add;
2938
2939     u32 spd_id;
2940     i32 priority;
2941     u8 is_outbound;
2942
2943     // Selector
2944     u8 is_ipv6;
2945     u8 is_ip_any;
2946     u8 remote_address_start[16];
2947     u8 remote_address_stop[16];
2948     u8 local_address_start[16];
2949     u8 local_address_stop[16];
2950
2951     u8 protocol;
2952
2953     u16 remote_port_start;
2954     u16 remote_port_stop;
2955     u16 local_port_start;
2956     u16 local_port_stop;
2957
2958     // Policy
2959     u8 policy;
2960     u32 sa_id;
2961 };
2962
2963 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2964     @param context - returned sender context, to match reply w/ request
2965     @param retval - return code
2966 */
2967
2968 define ipsec_spd_add_del_entry_reply {
2969     u32 context;
2970     i32 retval;
2971 };
2972
2973 /** \brief IPsec: Add/delete Security Association Database entry
2974     @param client_index - opaque cookie to identify the sender
2975     @param context - sender context, to match reply w/ request
2976     @param is_add - add SAD entry if non-zero, else delete
2977
2978     @param sad_id - sad id
2979
2980     @param spi - security parameter index
2981
2982     @param protocol - 0 = AH, 1 = ESP
2983
2984     @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2985     @param crypto_key_length - length of crypto_key in bytes
2986     @param crypto_key - crypto keying material
2987
2988     @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2989     @param integrity_key_length - length of integrity_key in bytes
2990     @param integrity_key - integrity keying material
2991
2992     @param use_extended_sequence_number - use ESN when non-zero
2993
2994     @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2995     @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2996     @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
2997     @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
2998
2999     To be added:
3000      Anti-replay
3001      IPsec tunnel address copy mode (to support GDOI)
3002  */
3003
3004 define ipsec_sad_add_del_entry {
3005     u32 client_index;
3006     u32 context;
3007     u8 is_add;
3008
3009     u32 sad_id;
3010
3011     u32 spi;
3012
3013     u8 protocol;
3014
3015     u8 crypto_algorithm;
3016     u8 crypto_key_length;
3017     u8 crypto_key[128];
3018
3019     u8 integrity_algorithm;
3020     u8 integrity_key_length;
3021     u8 integrity_key[128];
3022
3023     u8 use_extended_sequence_number;
3024
3025     u8 is_tunnel;
3026     u8 is_tunnel_ipv6;
3027     u8 tunnel_src_address[16];
3028     u8 tunnel_dst_address[16];
3029 };
3030
3031 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3032     @param context - returned sender context, to match reply w/ request
3033     @param retval - return code
3034 */
3035
3036 define ipsec_sad_add_del_entry_reply {
3037     u32 context;
3038     i32 retval;
3039 };
3040
3041 /** \brief IPsec: Update Security Association keys
3042     @param client_index - opaque cookie to identify the sender
3043     @param context - sender context, to match reply w/ request
3044
3045     @param sa_id - sa id
3046
3047     @param crypto_key_length - length of crypto_key in bytes
3048     @param crypto_key - crypto keying material
3049
3050     @param integrity_key_length - length of integrity_key in bytes
3051     @param integrity_key - integrity keying material
3052 */
3053
3054 define ipsec_sa_set_key {
3055     u32 client_index;
3056     u32 context;
3057
3058     u32 sa_id;
3059
3060     u8 crypto_key_length;
3061     u8 crypto_key[128];
3062
3063     u8 integrity_key_length;
3064     u8 integrity_key[128];
3065 };
3066
3067 /** \brief Reply for IPsec: Update Security Association keys
3068     @param context - returned sender context, to match reply w/ request
3069     @param retval - return code
3070 */
3071
3072 define ipsec_sa_set_key_reply {
3073     u32 context;
3074     i32 retval;
3075 };
3076
3077 /** \brief IKEv2: Add/delete profile
3078     @param client_index - opaque cookie to identify the sender
3079     @param context - sender context, to match reply w/ request
3080
3081     @param name - IKEv2 profile name
3082     @param is_add - Add IKEv2 profile if non-zero, else delete
3083 */
3084 define ikev2_profile_add_del {
3085     u32 client_index;
3086     u32 context;
3087
3088     u8 name[64];
3089     u8 is_add;
3090 };
3091
3092 /** \brief Reply for IKEv2: Add/delete profile
3093     @param context - returned sender context, to match reply w/ request
3094     @param retval - return code
3095 */
3096 define ikev2_profile_add_del_reply {
3097     u32 context;
3098     i32 retval;
3099 };
3100
3101 /** \brief IKEv2: Set IKEv2 profile authentication method
3102     @param client_index - opaque cookie to identify the sender
3103     @param context - sender context, to match reply w/ request
3104
3105     @param name - IKEv2 profile name
3106     @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3107     @param is_hex - Authentication data in hex format if non-zero, else string
3108     @param data_len - Authentication data length
3109     @param data - Authentication data (for rsa-sig cert file path)
3110 */
3111 define ikev2_profile_set_auth {
3112     u32 client_index;
3113     u32 context;
3114
3115     u8 name[64];
3116     u8 auth_method;
3117     u8 is_hex;
3118     u32 data_len;
3119     u8 data[0];
3120 };
3121
3122 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3123     @param context - returned sender context, to match reply w/ request
3124     @param retval - return code
3125 */
3126 define ikev2_profile_set_auth_reply {
3127     u32 context;
3128     i32 retval;
3129 };
3130
3131 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3132     @param client_index - opaque cookie to identify the sender
3133     @param context - sender context, to match reply w/ request
3134
3135     @param name - IKEv2 profile name
3136     @param is_local - Identification is local if non-zero, else remote
3137     @param id_type - Identification type
3138     @param data_len - Identification data length
3139     @param data - Identification data
3140 */
3141 define ikev2_profile_set_id {
3142     u32 client_index;
3143     u32 context;
3144
3145     u8 name[64];
3146     u8 is_local;
3147     u8 id_type;
3148     u32 data_len;
3149     u8 data[0];
3150 };
3151
3152 /** \brief Reply for IKEv2:
3153     @param context - returned sender context, to match reply w/ request
3154     @param retval - return code
3155 */
3156 define ikev2_profile_set_id_reply {
3157     u32 context;
3158     i32 retval;
3159 };
3160
3161 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3162     @param client_index - opaque cookie to identify the sender
3163     @param context - sender context, to match reply w/ request
3164
3165     @param name - IKEv2 profile name
3166     @param is_local - Traffic selector is local if non-zero, else remote
3167     @param proto - Traffic selector IP protocol (if zero not relevant)
3168     @param start_port - The smallest port number allowed by traffic selector
3169     @param end_port - The largest port number allowed by traffic selector
3170     @param start_addr - The smallest address included in traffic selector
3171     @param end_addr - The largest address included in traffic selector
3172 */
3173 define ikev2_profile_set_ts {
3174     u32 client_index;
3175     u32 context;
3176
3177     u8 name[64];
3178     u8 is_local;
3179     u8 proto;
3180     u16 start_port;
3181     u16 end_port;
3182     u32 start_addr;
3183     u32 end_addr;
3184 };
3185
3186 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3187     @param context - returned sender context, to match reply w/ request
3188     @param retval - return code
3189 */
3190 define ikev2_profile_set_ts_reply {
3191     u32 context;
3192     i32 retval;
3193 };
3194
3195 /** \brief IKEv2: Set IKEv2 local RSA private key
3196     @param client_index - opaque cookie to identify the sender
3197     @param context - sender context, to match reply w/ request
3198
3199     @param key_file - Key file absolute path
3200 */
3201 define ikev2_set_local_key {
3202     u32 client_index;
3203     u32 context;
3204
3205     u8 key_file[256];
3206 };
3207
3208 /** \brief Reply for IKEv2: Set IKEv2 local key
3209     @param context - returned sender context, to match reply w/ request
3210     @param retval - return code
3211 */
3212 define ikev2_set_local_key_reply {
3213     u32 context;
3214     i32 retval;
3215 };
3216
3217 /** \brief Tell client about a DHCP completion event
3218     @param client_index - opaque cookie to identify the sender
3219     @param pid - client pid registered to receive notification
3220     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3221     @param host_address - Host IP address
3222     @param router_address - Router IP address
3223     @param host_mac - Host MAC address
3224 */
3225 manual_java define dhcp_compl_event {
3226     u32 client_index;
3227     u32 pid;
3228     u8 hostname[64];
3229     u8 is_ipv6;
3230     u8 host_address[16];
3231     u8 router_address[16];
3232     u8 host_mac[6];
3233 };
3234
3235 /** \brief Add MAP domains
3236     @param client_index - opaque cookie to identify the sender
3237     @param context - sender context, to match reply w/ request
3238     @param ip6_prefix - Rule IPv6 prefix
3239     @param ip4_prefix - Rule IPv4 prefix
3240     @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3241     @param ip6_prefix_len - Rule IPv6 prefix length
3242     @param ip4_prefix_len - Rule IPv4 prefix length
3243     @param ea_bits_len - Embedded Address bits length
3244     @param psid_offset - Port Set Identifider (PSID) offset
3245     @param psid_length - PSID length
3246     @param is_translation - MAP-E / MAP-T
3247     @param mtu - MTU
3248 */
3249 define map_add_domain {
3250   u32 client_index;
3251   u32 context;
3252   u8 ip6_prefix[16];
3253   u8 ip4_prefix[4];
3254   u8 ip6_src[16];
3255   u8 ip6_prefix_len;
3256   u8 ip4_prefix_len;
3257   u8 ip6_src_prefix_len;
3258   u8 ea_bits_len;
3259   u8 psid_offset;
3260   u8 psid_length;
3261   u8 is_translation;
3262   u16 mtu;
3263 };
3264
3265 /** \brief Reply for MAP domain add
3266     @param context - returned sender context, to match reply w/ request
3267     @param index - MAP domain index
3268     @param retval - return code
3269 */
3270 define map_add_domain_reply {
3271   u32 context;
3272   u32 index;
3273   i32 retval;
3274 };
3275
3276 /** \brief Delete MAP domain
3277     @param client_index - opaque cookie to identify the sender
3278     @param context - sender context, to match reply w/ request
3279     @param index - MAP Domain index
3280 */
3281 define map_del_domain {
3282   u32 client_index;
3283   u32 context;
3284   u32 index;
3285 };
3286
3287 /** \brief Reply for MAP domain del
3288     @param context - returned sender context, to match reply w/ request
3289     @param retval - return code
3290 */
3291 define map_del_domain_reply {
3292   u32 context;
3293   i32 retval;
3294 };
3295
3296 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3297     @param client_index - opaque cookie to identify the sender
3298     @param context - sender context, to match reply w/ request
3299     @param index - MAP Domain index
3300     @param is_add - If 1 add rule, if 0 delete rule
3301     @param ip6_dst - MAP CE IPv6 address
3302     @param psid - Rule PSID
3303 */
3304 define map_add_del_rule {
3305   u32 client_index;
3306   u32 context;
3307   u32 index;
3308   u32 is_add;
3309   u8 ip6_dst[16];
3310   u16 psid;
3311 };
3312
3313 /** \brief Reply for MAP rule add/del
3314     @param context - returned sender context, to match reply w/ request
3315     @param retval - return code
3316 */
3317 define map_add_del_rule_reply {
3318   u32 context;
3319   i32 retval;
3320 };
3321
3322 /** \brief Get list of map domains
3323     @param client_index - opaque cookie to identify the sender
3324 */
3325 define map_domain_dump {
3326   u32 client_index;
3327   u32 context;
3328 };
3329
3330 manual_java define map_domain_details {
3331   u32 context;
3332   u32 domain_index;
3333   u8 ip6_prefix[16];
3334   u8 ip4_prefix[4];
3335   u8 ip6_src[16];
3336   u8 ip6_prefix_len;
3337   u8 ip4_prefix_len;
3338   u8 ip6_src_len;
3339   u8 ea_bits_len;
3340   u8 psid_offset;
3341   u8 psid_length;
3342   u8 flags;
3343   u16 mtu;
3344   u8 is_translation;
3345 };
3346
3347 define map_rule_dump {
3348   u32 client_index;
3349   u32 context;
3350   u32 domain_index;
3351 };
3352
3353 manual_java define map_rule_details {
3354   u32 context;
3355   u8 ip6_dst[16];
3356   u16 psid;
3357 };
3358
3359 /** \brief Request for a single block of summary stats
3360     @param client_index - opaque cookie to identify the sender
3361     @param context - sender context, to match reply w/ request
3362 */
3363 define map_summary_stats {
3364     u32 client_index;
3365     u32 context;
3366 };
3367
3368 /** \brief Reply for map_summary_stats request
3369     @param context - sender context, to match reply w/ request
3370     @param retval - return code for request
3371     @param total_bindings -  
3372     @param total_pkts -  
3373     @param total_ip4_fragments -
3374     @param total_security_check - 
3375 */
3376 define map_summary_stats_reply {
3377     u32 context;
3378     i32 retval;
3379     u64 total_bindings;
3380     u64 total_pkts[2];
3381     u64 total_bytes[2];
3382     u64 total_ip4_fragments;
3383     u64 total_security_check[2];
3384 };
3385
3386 /** \brief cop: enable/disable junk filtration features on an interface
3387     @param client_index - opaque cookie to identify the sender
3388     @param context - sender context, to match reply w/ request
3389     @param sw_if_inded - desired interface
3390     @param enable_disable - 1 => enable, 0 => disable
3391 */
3392
3393 define cop_interface_enable_disable {
3394     u32 client_index;
3395     u32 context;
3396     u32 sw_if_index;
3397     u8 enable_disable;
3398 };
3399
3400 /** \brief cop: interface enable/disable junk filtration reply
3401     @param context - returned sender context, to match reply w/ request
3402     @param retval - return code
3403 */
3404
3405 define cop_interface_enable_disable_reply {
3406     u32 context;
3407     i32 retval;
3408 };
3409
3410 /** \brief cop: enable/disable whitelist filtration features on an interface
3411     Note: the supplied fib_id must match in order to remove the feature!
3412     
3413     @param client_index - opaque cookie to identify the sender
3414     @param context - sender context, to match reply w/ request
3415     @param sw_if_index - interface handle, physical interfaces only
3416     @param fib_id - fib identifier for the whitelist / blacklist fib
3417     @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3418     @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3419     @param default_cop -  1 => enable non-ip4, non-ip6 filtration 0=> disable it
3420 */
3421
3422 define cop_whitelist_enable_disable {
3423     u32 client_index;
3424     u32 context;
3425     u32 sw_if_index;
3426     u32 fib_id;
3427     u8 ip4;
3428     u8 ip6;
3429     u8 default_cop;
3430 };
3431
3432 /** \brief cop: interface enable/disable junk filtration reply
3433     @param context - returned sender context, to match reply w/ request
3434     @param retval - return code
3435 */
3436
3437 define cop_whitelist_enable_disable_reply {
3438     u32 context;
3439     i32 retval;
3440 };
3441
3442 /** \brief get_node_graph - get a copy of the vpp node graph
3443     including the current set of graph arcs.
3444
3445     @param client_index - opaque cookie to identify the sender
3446     @param context - sender context, to match reply w/ request
3447 */
3448
3449 define get_node_graph {
3450     u32 client_index;
3451     u32 context;
3452 };
3453
3454 /** \brief get_node_graph_reply
3455     @param context - returned sender context, to match reply w/ request
3456     @param retval - return code
3457     @param reply_in_shmem - result from vlib_node_serialize, in shared
3458     memory. Process with vlib_node_unserialize, remember to switch
3459     heaps and free the result.
3460 */
3461
3462 define get_node_graph_reply {
3463     u32 context;
3464     i32 retval;
3465     u64 reply_in_shmem;
3466 };
3467
3468 /** \brief Clear interface statistics
3469     @param client_index - opaque cookie to identify the sender
3470     @param context - sender context, to match reply w/ request
3471     @param sw_if_index - index of the interface to clear statistics
3472 */
3473 define sw_interface_clear_stats {
3474     u32 client_index;
3475     u32 context;
3476     u32 sw_if_index;
3477 };
3478
3479 /** \brief Reply to sw_interface_clear_stats 
3480     @param context - sender context which was passed in the request
3481     @param retval - return code of the set flags request
3482 */
3483 define sw_interface_clear_stats_reply {
3484     u32 context;
3485     i32 retval;
3486 };
3487
3488 /** \brief IOAM Trace : Set TRACE profile
3489     @param id - profile id
3490     @param trace_type - Trace type
3491     @param trace_num_elt - Number of nodes in trace path
3492     @param trace_ppc - Trace PPC (none/encap/decap)
3493     @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3494     @param trace_app_data - Trace application data, can be any 4 bytes
3495     @param pow_enable - Proof of Work enabled or not flag
3496     @param node_id - Id of this node
3497 */
3498 define trace_profile_add {
3499   u32 client_index;
3500   u32 context;
3501   u16 id;
3502   u8  trace_type;
3503   u8  trace_num_elt;
3504   u8  trace_ppc;
3505   u8  trace_tsp;
3506   u32 trace_app_data;
3507   u8  pow_enable;
3508   u32 node_id;
3509 };
3510
3511 /** \brief Trace profile add / del response
3512     @param context - sender context, to match reply w/ request
3513     @param retval - return value for request
3514 */
3515 define trace_profile_add_reply {
3516     u32 context;
3517     i32 retval;
3518 };
3519
3520 /** \brief IOAM Trace enable trace profile for a flow
3521     @param id - id of the trace profile to be applied
3522     @param dest_ipv6 - Destination IPv6 address
3523     @param prefix_length - prefix mask
3524     @param vrf_id - VRF ID
3525     @param trace_op - Trace operation (add/mod/del)
3526     @param enable - apply/remove the trace profile for the flow
3527 */
3528 define trace_profile_apply {
3529   u32 client_index;
3530   u32 context;
3531   u16 id;
3532   u8 dest_ipv6[16];
3533   u32 prefix_length;
3534   u32 vrf_id;
3535   u8 trace_op;
3536   u8 enable;
3537 };
3538
3539 /** \brief Trace profile apply response
3540     @param context - sender context, to match reply w/ request   
3541     @param retval - return value for request
3542 */
3543 define trace_profile_apply_reply {
3544   u32 context;
3545   i32 retval;
3546 };
3547
3548 /** \brief Delete Trace Profile 
3549     @param client_index - opaque cookie to identify the sender
3550     @param context - sender context, to match reply w/ request
3551     @param index - MAP Domain index
3552 */
3553 define trace_profile_del {
3554   u32 client_index;
3555   u32 context;
3556   u16 id;
3557 };
3558
3559 /** \brief Trace profile add / del response
3560     @param context - sender context, to match reply w/ request
3561     @param retval - return value for request
3562 */
3563 define trace_profile_del_reply {
3564     u32 context;
3565     i32 retval;
3566 };
3567
3568 /** \brief Create host-interface
3569     @param client_index - opaque cookie to identify the sender
3570     @param context - sender context, to match reply w/ request
3571     @param host_if_name - interface name
3572     @param hw_addr - interface MAC
3573     @param use_random_hw_addr - use random generated MAC
3574 */
3575 define af_packet_create {
3576     u32 client_index;
3577     u32 context;
3578
3579     u8 host_if_name[64];
3580     u8 hw_addr[6];
3581     u8 use_random_hw_addr;
3582 };
3583
3584 /** \brief Create host-interface response
3585     @param context - sender context, to match reply w/ request
3586     @param retval - return value for request
3587 */
3588 define af_packet_create_reply {
3589     u32 context;
3590     i32 retval;
3591     u32 sw_if_index;
3592 };
3593
3594 /** \brief Delete host-interface
3595     @param client_index - opaque cookie to identify the sender
3596     @param context - sender context, to match reply w/ request
3597     @param host_if_name - interface name
3598 */
3599 define af_packet_delete {
3600     u32 client_index;
3601     u32 context;
3602
3603     u8 host_if_name[64];
3604 };
3605
3606 /** \brief Delete host-interface response
3607     @param context - sender context, to match reply w/ request
3608     @param retval - return value for request
3609 */
3610 define af_packet_delete_reply {
3611     u32 context;
3612     i32 retval;
3613 };
3614
3615 /** \brief Add/del policer
3616     @param client_index - opaque cookie to identify the sender
3617     @param context - sender context, to match reply w/ request
3618     @param is_add - add policer if non-zero, else delete
3619     @param name - policer name
3620     @param cir - CIR
3621     @param eir - EIR
3622     @param cb - Committed Burst
3623     @param eb - Excess or Peak Burst
3624     @param rate_type - rate type
3625     @param round_type - rounding type
3626     @param type - policer algorithm
3627 */
3628 define policer_add_del {
3629     u32 client_index;
3630     u32 context;
3631
3632     u8 is_add;
3633     u8 name[64];
3634     u32 cir;
3635     u32 eir;
3636     u64 cb;
3637     u64 eb;
3638     u8 rate_type;
3639     u8 round_type;
3640     u8 type;
3641 };
3642
3643 /** \brief Add/del policer response
3644     @param context - sender context, to match reply w/ request
3645     @param retval - return value for request
3646 */
3647 define policer_add_del_reply {
3648     u32 context;
3649     i32 retval;
3650 };
3651
3652 /** \brief Get list of policers
3653     @param client_index - opaque cookie to identify the sender
3654     @param context - sender context, to match reply w/ request
3655     @param match_name_valid - if 0 request all policers otherwise use match_name
3656     @param match_name - policer name
3657 */
3658 define policer_dump {
3659     u32 client_index;
3660     u32 context;
3661
3662     u8 match_name_valid;
3663     u8 match_name[64];
3664 };
3665
3666 /** \brief Policer operational state response.
3667     @param context - sender context, to match reply w/ request
3668     @param name - policer name
3669     @param cir - CIR
3670     @param eir - EIR
3671     @param cb - Committed Burst
3672     @param eb - Excess or Peak Burst
3673     @param rate_type - rate type
3674     @param round_type - rounding type
3675     @param type - policer algorithm
3676     @param single_rate - 1 = single rate policer, 0 = two rate policer
3677     @param color_aware - for hierarchical policing
3678     @param scale - power-of-2 shift amount for lower rates
3679     @param cir_tokens_per_period - number of tokens for each period
3680     @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3681     @param current_limit - current limit
3682     @param current_bucket - current bucket
3683     @param extended_limit - extended limit
3684     @param extended_bucket - extended bucket
3685     @param last_update_time - last update time
3686 */
3687 manual_java define policer_details {
3688     u32 context;
3689
3690     u8 name[64];
3691     u32 cir;
3692     u32 eir;
3693     u64 cb;
3694     u64 eb;
3695     u8 rate_type;
3696     u8 round_type;
3697     u8 type;
3698     u8 single_rate;
3699     u8 color_aware;
3700     u32 scale;
3701     u32 cir_tokens_per_period;
3702     u32 pir_tokens_per_period;
3703     u32 current_limit;
3704     u32 current_bucket;
3705     u32 extended_limit;
3706     u32 extended_bucket;
3707     u64 last_update_time;
3708 };
3709
3710 /** \brief Create netmap
3711     @param client_index - opaque cookie to identify the sender
3712     @param context - sender context, to match reply w/ request
3713     @param netmap_if_name - interface name
3714     @param hw_addr - interface MAC
3715     @param use_random_hw_addr - use random generated MAC
3716     @param is_pipe - is pipe
3717     @param is_master - 0=slave, 1=master
3718 */
3719 define netmap_create {
3720     u32 client_index;
3721     u32 context;
3722
3723     u8 netmap_if_name[64];
3724     u8 hw_addr[6];
3725     u8 use_random_hw_addr;
3726     u8 is_pipe;
3727     u8 is_master;
3728 };
3729
3730 /** \brief Create netmap response
3731     @param context - sender context, to match reply w/ request
3732     @param retval - return value for request
3733 */
3734 define netmap_create_reply {
3735     u32 context;
3736     i32 retval;
3737 };
3738
3739 /** \brief Delete netmap
3740     @param client_index - opaque cookie to identify the sender
3741     @param context - sender context, to match reply w/ request
3742     @param netmap_if_name - interface name
3743 */
3744 define netmap_delete {
3745     u32 client_index;
3746     u32 context;
3747
3748     u8 netmap_if_name[64];
3749 };
3750
3751 /** \brief Delete netmap response
3752     @param context - sender context, to match reply w/ request
3753     @param retval - return value for request
3754 */
3755 define netmap_delete_reply {
3756     u32 context;
3757     i32 retval;
3758 };
3759
3760 /** \brief Dump mpls gre tunnel table
3761     @param client_index - opaque cookie to identify the sender
3762     @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
3763 */
3764 define mpls_gre_tunnel_dump {
3765     u32 client_index;
3766     u32 context;
3767     i32 tunnel_index;
3768 };
3769
3770 /** \brief mpls gre tunnel operational state response
3771     @param tunnel_index - gre tunnel identifier
3772     @param intfc_address - interface ipv4 addr
3773     @param mask_width - interface ipv4 addr mask
3774     @param hw_if_index - interface id
3775     @param l2_only -
3776     @param tunnel_src - tunnel source ipv4 addr
3777     @param tunnel_dst - tunnel destination ipv4 addr
3778     @param outer_fib_index - gre tunnel identifier
3779     @param encap_index - reference to mpls label table
3780     @param nlabels - number of resolved labels
3781     @param labels - resolved labels
3782 */
3783 manual_java define mpls_gre_tunnel_details {
3784     u32 context;
3785     u32 tunnel_index;
3786
3787     u32 intfc_address;
3788     u32 inner_fib_index;
3789     u32 mask_width;
3790     u32 encap_index;
3791     u32 hw_if_index;
3792     u8  l2_only;
3793     u32 tunnel_src;
3794     u32 tunnel_dst;
3795     u32 outer_fib_index;
3796     u32 nlabels;
3797     u32 labels[0];
3798 };
3799
3800 /** \brief Dump mpls eth tunnel table
3801     @param client_index - opaque cookie to identify the sender
3802     @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
3803 */
3804 define mpls_eth_tunnel_dump {
3805     u32 client_index;
3806     u32 context;
3807     i32 tunnel_index;
3808 };
3809
3810 /** \brief mpls eth tunnel operational state response
3811     @param tunnel_index - eth tunnel identifier
3812     @param intfc_address - interface ipv4 addr
3813     @param mask_width - interface ipv4 addr mask
3814     @param hw_if_index - interface id
3815     @param l2_only -
3816     @param tunnel_dst_mac -
3817     @param tx_sw_if_index -
3818     @param encap_index - reference to mpls label table
3819     @param nlabels - number of resolved labels
3820     @param labels - resolved labels
3821 */
3822 manual_java define mpls_eth_tunnel_details {
3823     u32 context;
3824     u32 tunnel_index;
3825
3826     u32 intfc_address;
3827     u32 inner_fib_index;
3828     u32 mask_width;
3829     u32 encap_index;
3830     u32 hw_if_index;
3831     u8  l2_only;
3832     u8  tunnel_dst_mac[6];
3833     u32 tx_sw_if_index;
3834     u32 nlabels;
3835     u32 labels[0];
3836 };
3837
3838 /** \brief Dump mpls fib table
3839     @param client_index - opaque cookie to identify the sender
3840     @param fib_index    - mpls fib entry identifier or -1 in case of all entries
3841 */
3842 define mpls_fib_encap_dump {
3843     u32 client_index;
3844     u32 context;
3845 };
3846
3847 /** \brief mpls fib encap table response
3848     @param fib_index - fib table id
3849     @param dest - destination ipv4 addr
3850     @param s_bit -
3851     @param entry_index - reference to mpls label table
3852     @param nlabels - number of resolved labels
3853     @param labels - resolved labels
3854 */
3855 manual_java define mpls_fib_encap_details {
3856     u32 context;
3857
3858     u32 fib_index;
3859     u32 entry_index;
3860     u32 dest;
3861     u32 s_bit;
3862     u32 nlabels;
3863     u32 labels[0];
3864 };
3865
3866 /** \brief Dump mpls fib decap table
3867     @param client_index - opaque cookie to identify the sender
3868     @param fib_index    - mpls fib entry identifier or -1 in case of all entries
3869 */
3870 define mpls_fib_decap_dump {
3871     u32 client_index;
3872     u32 context;
3873 };
3874
3875 /** \brief mpls fib decap table response
3876     @param fib_index - fib table id
3877     @param entry_index - reference to mpls label table
3878     @param dest - destination ipv4 addr
3879     @param s_bit -
3880     @param label - mpls labels
3881     @param rx_table_id - rx fib id
3882     @param tx_table_id - tx fib id
3883     @param swif_tag -
3884 */
3885 manual_java define mpls_fib_decap_details {
3886     u32 context;
3887
3888     u32 fib_index;
3889     u32 entry_index;
3890     u32 dest;
3891     u32 s_bit;
3892     u32 label;
3893     u32 rx_table_id;
3894     u32 tx_table_id;
3895     u8  swif_tag[8];
3896 };
3897
3898 /** \brief Classify get table IDs request
3899     @param client_index - opaque cookie to identify the sender
3900     @param context - sender context, to match reply w/ request
3901 */
3902 define classify_table_ids {
3903     u32 client_index;
3904     u32 context;
3905 };
3906
3907 /** \brief Reply for classify get table IDs request
3908     @param context - sender context which was passed in the request
3909     @param count - number of ids returned in response
3910     @param ids - array of classify table ids
3911 */
3912 manual_java define classify_table_ids_reply {
3913     u32 context;
3914     u32 retval;
3915     u32 count;
3916     u32 ids[count];
3917 };
3918
3919 /** \brief Classify table ids by interface index request
3920     @param client_index - opaque cookie to identify the sender
3921     @param context - sender context, to match reply w/ request
3922     @param sw_if_index - index of the interface
3923 */
3924 define classify_table_by_interface {
3925     u32 client_index;
3926     u32 context;
3927     u32 sw_if_index;
3928 };
3929
3930 /** \brief Reply for classify table id by interface index request
3931     @param context - sender context which was passed in the request
3932     @param count - number of ids returned in response
3933     @param sw_if_index - index of the interface
3934     @param l2_table_id - l2 classify table index
3935     @param ip4_table_id - ip4 classify table index
3936     @param ip6_table_id - ip6 classify table index
3937 */
3938 manual_java define classify_table_by_interface_reply {
3939     u32 context;
3940     u32 retval;
3941     u32 sw_if_index;
3942     u32 l2_table_id;
3943     u32 ip4_table_id;
3944     u32 ip6_table_id;
3945 };
3946
3947 /** \brief Classify table info
3948     @param client_index - opaque cookie to identify the sender
3949     @param context - sender context, to match reply w/ request
3950     @param table_id - classify table index
3951 */
3952 define classify_table_info {
3953     u32 client_index;
3954     u32 context;
3955     u32 table_id;
3956 };
3957
3958 /** \brief Reply for classify table info request
3959     @param context - sender context which was passed in the request
3960     @param count - number of ids returned in response
3961     @param table_id - classify table index
3962     @param nbuckets - number of buckets when adding a table
3963     @param match_n_vectors - number of match vectors
3964     @param skip_n_vectors - number of skip_n_vectors
3965     @param active_sessions - number of sessions (active entries)
3966     @param next_table_index - index of next table
3967     @param miss_next_index - index of miss table
3968     @param mask[] - match mask
3969 */
3970 manual_java define classify_table_info_reply {
3971     u32 context;
3972     i32 retval;
3973     u32 table_id;
3974     u32 nbuckets;
3975     u32 match_n_vectors;
3976     u32 skip_n_vectors;
3977     u32 active_sessions;
3978     u32 next_table_index;
3979     u32 miss_next_index;
3980     u32 mask_length;
3981     u8  mask[mask_length];
3982 };
3983
3984 /** \brief Classify sessions dump request
3985     @param client_index - opaque cookie to identify the sender
3986     @param context - sender context, to match reply w/ request
3987     @param table_id - classify table index
3988 */
3989 define classify_session_dump {
3990     u32 client_index;
3991     u32 context;
3992     u32 table_id;
3993 };
3994
3995 /** \brief Reply for classify table session dump request
3996     @param context - sender context which was passed in the request
3997     @param count - number of ids returned in response
3998     @param table_id - classify table index
3999     @param hit_next_index - hit_next_index of session
4000     @param opaque_index - for add, opaque_index of session
4001     @param advance - advance value of session
4002     @param match[] - match value for session
4003 */ 
4004 manual_java define classify_session_details {
4005     u32 context;
4006     i32 retval;
4007     u32 table_id;
4008     u32 hit_next_index;
4009     i32 advance;
4010     u32 opaque_index;
4011     u32 match_length;
4012     u8 match[match_length];
4013 };