69ef70887d671ae407345528b2c6b96bbec41e71
[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 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 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 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 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 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_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_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 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 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 define control_ping_reply {
1070     u32 context;
1071     i32 retval;
1072     u32 client_index;
1073     u32 vpe_pid;
1074 };
1075
1076 /** \brief Process a vpe parser cli string request
1077     @param client_index - opaque cookie to identify the sender
1078     @param context - sender context, to match reply w/ request
1079     @param cmd_in_shmem - pointer to cli command string
1080 */
1081 define cli_request {
1082     u32 client_index;
1083     u32 context;
1084     u64 cmd_in_shmem;
1085 };
1086
1087 /** \brief vpe parser cli string response
1088     @param context - sender context, to match reply w/ request
1089     @param retval - return code for request
1090     @param reply_in_shmem - Reply string from cli processing if any
1091 */
1092 define cli_reply {
1093     u32 context;
1094     i32 retval;
1095     u64 reply_in_shmem;
1096 };
1097
1098 /** \brief Set max allowed ARP or ip6 neighbor entries request
1099     @param client_index - opaque cookie to identify the sender
1100     @param context - sender context, to match reply w/ request
1101     @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1102     @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1103 */
1104 define set_arp_neighbor_limit {
1105     u32 client_index;
1106     u32 context;
1107     u8  is_ipv6;
1108     u32 arp_neighbor_limit;
1109 }; 
1110
1111 /** \brief Set max allowed ARP or ip6 neighbor entries response
1112     @param context - sender context, to match reply w/ request
1113     @param retval - return code for request
1114 */
1115 define set_arp_neighbor_limit_reply {
1116     u32 context;
1117     i32 retval;
1118 };
1119
1120 /** \brief L2 interface patch add / del request
1121     @param client_index - opaque cookie to identify the sender
1122     @param context - sender context, to match reply w/ request
1123     @param rx_sw_if_index - receive side interface 
1124     @param tx_sw_if_index - transmit side interface
1125     @param is_add - if non-zero set up the interface patch, else remove it
1126 */
1127 define l2_patch_add_del {
1128     u32 client_index;
1129     u32 context;
1130     u32 rx_sw_if_index;
1131     u32 tx_sw_if_index;
1132     u8 is_add;
1133 };
1134
1135 /** \brief L2 interface patch add / del response
1136     @param context - sender context, to match reply w/ request
1137     @param retval - return code for the request
1138 */
1139 define l2_patch_add_del_reply {
1140     u32 context;
1141     i32 retval;
1142 };
1143
1144 /** \brief IPv6 segment routing tunnel add / del request
1145     @param client_index - opaque cookie to identify the sender
1146     @param context - sender context, to match reply w/ request
1147     @param is_add - add the tunnel if non-zero, else delete it
1148     @param name[] - tunnel name (len. 64)
1149     @param src_address[] -
1150     @param dst_address[] -
1151     @param dst_mask_width -
1152     @param inner_vrf_id -
1153     @param outer_vrf_id -
1154     @param flags_net_byte_order -
1155     @param n_segments -
1156     @param n_tags -
1157     @param segs_and_tags[] -
1158     @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1159 */
1160 define sr_tunnel_add_del {
1161     u32 client_index;
1162     u32 context;
1163     u8 is_add;
1164     u8 name[64];
1165     u8 src_address[16];
1166     u8 dst_address[16];
1167     u8 dst_mask_width;
1168     u32 inner_vrf_id;
1169     u32 outer_vrf_id;
1170     u16 flags_net_byte_order;
1171     u8 n_segments;
1172     u8 n_tags;
1173     u8 segs_and_tags[0];
1174     u8 policy_name[64];
1175 };
1176
1177 /** \brief IPv6 segment routing tunnel add / del response
1178     @param context - sender context, to match reply w/ request
1179     @param retval - return value for request
1180 */
1181 define sr_tunnel_add_del_reply {
1182     u32 context;
1183     i32 retval;
1184 };
1185
1186 /** \brief IPv6 segment routing policy add / del request
1187     @param client_index - opaque cookie to identify the sender
1188     @param context - sender context, to match reply w/ request
1189     @param is_add - add the tunnel if non-zero, else delete it
1190     @param name[] - policy name (len. 64)
1191     @param tunnel_names[] -
1192 */
1193 define sr_policy_add_del {
1194     u32 client_index;
1195     u32 context;
1196     u8 is_add;
1197     u8 name[64];
1198     u8 tunnel_names[0];
1199 };
1200
1201 /** \brief IPv6 segment routing policy add / del response
1202     @param context - sender context, to match reply w/ request
1203     @param retval - return value for request
1204 */
1205 define sr_policy_add_del_reply {
1206     u32 context;
1207     i32 retval;
1208 };
1209
1210 /** \brief IPv6 segment routing multicast map to policy add / del request
1211     @param client_index - opaque cookie to identify the sender
1212     @param context - sender context, to match reply w/ request
1213     @param is_add - add the tunnel if non-zero, else delete it
1214     @param multicast_address[] - IP6 multicast address
1215     @param policy_name[] = policy name (len.64)
1216 */
1217 define sr_multicast_map_add_del {
1218     u32 client_index;
1219     u32 context;
1220     u8 is_add;
1221     u8 multicast_address[16];
1222     u8 policy_name[64];
1223 };
1224
1225 /** \brief IPv6 segment routing multicast map to policy add / del response
1226     @param context - sender context, to match reply w/ request
1227     @param retval - return value for request
1228 */
1229 define sr_multicast_map_add_del_reply {
1230     u32 context;
1231     i32 retval;
1232 };
1233
1234 /** \brief Interface set vpath request
1235     @param client_index - opaque cookie to identify the sender
1236     @param context - sender context, to match reply w/ request
1237     @param sw_if_index - interface used to reach neighbor
1238     @param enable - if non-zero enable, else disable
1239 */
1240 define sw_interface_set_vpath {
1241     u32 client_index;
1242     u32 context;
1243     u32 sw_if_index;
1244     u8  enable;
1245 };
1246
1247 /** \brief Interface set vpath response
1248     @param context - sender context, to match reply w/ request
1249     @param retval - return code for the request
1250 */
1251 define sw_interface_set_vpath_reply {
1252     u32 context;
1253     i32 retval;
1254 };
1255
1256 /** \brief MPLS Ethernet add / del tunnel request
1257     @param client_index - opaque cookie to identify the sender
1258     @param context - sender context, to match reply w/ request
1259     @param vrf_id - vrf_id, only for IP4
1260     @param sw_if_index - interface used to reach neighbor
1261     @param is_add - add if set, tunnel delete if 0
1262     @param dst_mac_address - 
1263     @param adj_address - 
1264     @param adj_address_length -
1265 */
1266 define mpls_ethernet_add_del_tunnel {
1267     u32 client_index;
1268     u32 context;
1269     u32 vrf_id;
1270     u32 tx_sw_if_index;
1271     u8 is_add;
1272     u8 l2_only;
1273     u8 dst_mac_address[6];
1274     u8 adj_address[4];
1275     u8 adj_address_length;
1276 };
1277
1278 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1279     @param context - sender context, to match reply w/ request
1280     @param retval - return code for the request
1281 */
1282 define mpls_ethernet_add_del_tunnel_reply {
1283     u32 context;
1284     i32 retval;
1285     u32 tunnel_sw_if_index;
1286 };
1287 /** \brief MPLS Ethernet add/ del tunnel 2
1288     @param client_index - opaque cookie to identify the sender
1289     @param context - sender context, to match reply w/ request
1290     @param inner_vrf_id - 
1291     @param outer_vrf_id - 
1292     @param resolve_attempts - 
1293     @param resolve_opaque - 
1294     @param resolve_if_needed -
1295     @param is_add -
1296     @param adj_address -
1297     @param adj_address_length -
1298     @param next_hop_ip4_address_in_outer_vrf -
1299 */
1300 define mpls_ethernet_add_del_tunnel_2 {
1301    u32 client_index;
1302    u32 context;
1303    u32 inner_vrf_id;
1304    u32 outer_vrf_id;
1305    u32 resolve_attempts;
1306    u32 resolve_opaque;          /* no need to set this */
1307    u8 resolve_if_needed;
1308    u8 is_add;
1309    u8 l2_only;
1310    u8 adj_address[4];
1311    u8 adj_address_length;
1312    u8 next_hop_ip4_address_in_outer_vrf [4];
1313 };
1314
1315 /** \brief MPLS Ethernet add/ del tunnel 2
1316     @param context - sender context, to match reply w/ request
1317     @param retval - return code for add /del request
1318 */
1319 define mpls_ethernet_add_del_tunnel_2_reply {
1320     u32 context;
1321     i32 retval;
1322 };
1323
1324 /** \brief Set L2 XConnect between two interfaces request
1325     @param client_index - opaque cookie to identify the sender
1326     @param context - sender context, to match reply w/ request
1327     @param rx_sw_if_index - Receive interface index
1328     @param tx_sw_if_index - Transmit interface index
1329     @param enable - enable xconnect if not 0, else set to L3 mode
1330 */
1331 define sw_interface_set_l2_xconnect {
1332     u32 client_index;
1333     u32 context;
1334     u32 rx_sw_if_index;
1335     u32 tx_sw_if_index;
1336     u8 enable;
1337 };
1338
1339 /** \brief Set L2 XConnect response
1340     @param context - sender context, to match reply w/ request
1341     @param retval - L2 XConnect request return code
1342 */
1343 define sw_interface_set_l2_xconnect_reply {
1344     u32 context;
1345     i32 retval;
1346 };
1347
1348 /** \brief Interface bridge mode request
1349     @param client_index - opaque cookie to identify the sender
1350     @param context - sender context, to match reply w/ request
1351     @param rx_sw_if_index - the interface
1352     @param bd_id - bridge domain id
1353     @param bvi - Setup interface as a bvi, bridge mode only
1354     @param shg - Shared horizon group, for bridge mode only
1355     @param enable - Enable beige mode if not 0, else set to L3 mode
1356 */
1357 define sw_interface_set_l2_bridge {
1358     u32 client_index;
1359     u32 context;
1360     u32 rx_sw_if_index;
1361     u32 bd_id;
1362     u8 shg;
1363     u8 bvi;
1364     u8 enable;
1365 };
1366
1367 /** \brief Interface bridge mode response
1368     @param context - sender context, to match reply w/ request
1369     @param retval - Bridge mode request return code
1370 */
1371 define sw_interface_set_l2_bridge_reply {
1372     u32 context;
1373     i32 retval;
1374 };
1375
1376 /** \brief L2 FIB add entry request
1377     @param client_index - opaque cookie to identify the sender
1378     @param context - sender context, to match reply w/ request
1379     @param mac - the entry's mac address
1380     @param bd_id - the entry's bridge domain id
1381     @param sw_if_index - the interface
1382     @param is_add - If non zero add the entry, else delete it
1383     @param static_mac - 
1384     @param filter_mac -
1385 */
1386 define l2fib_add_del {
1387     u32 client_index;
1388     u32 context;
1389     u64 mac;
1390     u32 bd_id;
1391     u32 sw_if_index;
1392     u8 is_add;
1393     u8 static_mac;
1394     u8 filter_mac;
1395     u8 bvi_mac;
1396 };
1397
1398 /** \brief L2 FIB add entry response
1399     @param context - sender context, to match reply w/ request
1400     @param retval - return code for the add l2fib entry request
1401 */
1402 define l2fib_add_del_reply {
1403     u32 context;
1404     i32 retval;
1405 };
1406
1407 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1408     @param client_index - opaque cookie to identify the sender
1409     @param context - sender context, to match reply w/ request
1410     @param sw_if_index - interface 
1411     @param is_set - if non-zero, set the bits, else clear them
1412     @param feature_bitmap - non-zero bits to set or clear
1413 */
1414 define l2_flags {
1415     u32 client_index;
1416     u32 context;
1417     u32 sw_if_index;
1418     u8 is_set;
1419     u32 feature_bitmap;
1420 };
1421
1422 /** \brief Set L2 bits response
1423     @param context - sender context, to match reply w/ request
1424     @param retval - return code for the set l2 bits request
1425 */
1426 define l2_flags_reply {
1427     u32 context;
1428     i32 retval;
1429     u32 resulting_feature_bitmap;
1430 };
1431
1432 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD, 
1433     L2_UU_FLOOD, or L2_ARP_TERM) request
1434     @param client_index - opaque cookie to identify the sender
1435     @param context - sender context, to match reply w/ request
1436     @param bd_id - the bridge domain to set the flags for
1437     @param is_set - if non-zero, set the flags, else clear them
1438     @param feature_bitmap - bits that are non-zero to set or clear
1439 */
1440 define bridge_flags {
1441     u32 client_index;
1442     u32 context;
1443     u32 bd_id;
1444     u8 is_set;
1445     u32 feature_bitmap;
1446 };
1447
1448 /** \brief Set bridge flags response
1449     @param context - sender context, to match reply w/ request
1450     @param retval - return code for the set bridge flags request
1451     @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1452 */
1453 define bridge_flags_reply {
1454     u32 context;
1455     i32 retval;
1456     u32 resulting_feature_bitmap;
1457 };
1458
1459 /** \brief Set bridge domain ip to mac entry request
1460     @param client_index - opaque cookie to identify the sender
1461     @param context - sender context, to match reply w/ request
1462     @param bd_id - the bridge domain to set the flags for
1463     @param is_add - if non-zero, add the entry, else clear it
1464     @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1465     @param mac_address - MAC address
1466     @param 
1467 */
1468 define bd_ip_mac_add_del {
1469     u32 client_index;
1470     u32 context;
1471     u32 bd_id;
1472     u8 is_add;
1473     u8 is_ipv6;
1474     u8 ip_address[16];
1475     u8 mac_address[6];
1476 };
1477
1478 /** \brief Set bridge domain ip to mac entry response
1479     @param context - sender context, to match reply w/ request
1480     @param retval - return code for the set bridge flags request
1481 */
1482 define bd_ip_mac_add_del_reply {
1483     u32 context;
1484     i32 retval;
1485 };
1486
1487 /** \brief Add/Delete classification table request
1488     @param client_index - opaque cookie to identify the sender
1489     @param context - sender context, to match reply w/ request
1490     @param is_add- if non-zero add the table, else delete it
1491     @param table_index - if add, reuturns index of the created table, else specifies the table to delete  
1492     @param nbuckets - number of buckets when adding a table
1493     @param memory_size - memory size when adding a table
1494     @param match_n_vectors - number of match vectors
1495     @param next_table_index - index of next table
1496     @param miss_next_index - index of miss table
1497     @param mask[] - match mask
1498 */
1499 define classify_add_del_table {
1500     u32 client_index;
1501     u32 context;
1502     u8  is_add;
1503     u32 table_index;
1504     u32 nbuckets;
1505     u32 memory_size;
1506     u32 skip_n_vectors;
1507     u32 match_n_vectors;
1508     u32 next_table_index;
1509     u32 miss_next_index;
1510     u8 mask[0];
1511 };
1512
1513 /** \brief Add/Delete classification table response
1514     @param context - sender context, to match reply w/ request
1515     @param retval - return code for the table add/del requst
1516     @param new_table_index - for add, returned index of the new table
1517     @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1518     @param match_n_vectors -for add, returned value of match_n_vectors in table
1519 */
1520 define classify_add_del_table_reply {
1521     u32 context;
1522     i32 retval;
1523     u32 new_table_index;
1524     u32 skip_n_vectors;
1525     u32 match_n_vectors;
1526 };
1527
1528 /** \brief Classify add / del session request
1529     @param client_index - opaque cookie to identify the sender
1530     @param context - sender context, to match reply w/ request
1531     @param is_add - add session if non-zero, else delete
1532     @param table_index - index of the table to add/del the session, required
1533     @param hit_next_index - for add, hit_next_index of new session, required
1534     @param opaque_index - for add, opaque_index of new session
1535     @param advance -for add, advance value for session
1536     @param match[] - for add, match value for session, required
1537 */
1538 define classify_add_del_session {
1539     u32 client_index;
1540     u32 context;
1541     u8  is_add;
1542     u32 table_index;
1543     u32 hit_next_index;
1544     u32 opaque_index;
1545     i32 advance;
1546     u8 match[0];
1547 };
1548
1549 /** \brief Classify add / del session response
1550     @param context - sender context, to match reply w/ request
1551     @param retval - return code for the add/del session request
1552 */
1553 define classify_add_del_session_reply {
1554     u32 context;
1555     i32 retval;
1556 };
1557
1558 /** \brief Set/unset the classification table for an interface request 
1559     @param client_index - opaque cookie to identify the sender
1560     @param context - sender context, to match reply w/ request
1561     @param is_ipv6 - ipv6 if non-zero, else ipv4
1562     @param sw_if_index - interface to associate with the table
1563     @param table_index - index of the table, if ~0 unset the table
1564 */
1565 define classify_set_interface_ip_table {
1566     u32 client_index;
1567     u32 context;
1568     u8 is_ipv6;
1569     u32 sw_if_index;
1570     u32 table_index;            /* ~0 => off */
1571 };
1572
1573 /** \brief Set/unset interface classification table response 
1574     @param context - sender context, to match reply w/ request
1575     @param retval - return code
1576 */
1577 define classify_set_interface_ip_table_reply {
1578     u32 context;
1579     i32 retval;
1580 };
1581
1582 /** \brief Set/unset l2 classification tables for an interface request
1583     @param client_index - opaque cookie to identify the sender
1584     @param context - sender context, to match reply w/ request
1585     @param sw_if_index - interface to set/unset tables for
1586     @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1587     @param ip6_table_index - ip6 index
1588     @param other_table_index - other index
1589 */
1590 define classify_set_interface_l2_tables {
1591     u32 client_index;
1592     u32 context;
1593     u32 sw_if_index;
1594     /* 3 x ~0 => off */
1595     u32 ip4_table_index;
1596     u32 ip6_table_index;
1597     u32 other_table_index;
1598 };
1599
1600 /** \brief Set/unset l2 classification tables for an interface response
1601     @param context - sender context, to match reply w/ request
1602     @param retval - return code for the request
1603 */
1604 define classify_set_interface_l2_tables_reply {
1605     u32 context;
1606     i32 retval;
1607 };
1608
1609 /** \brief Get node index using name request
1610     @param client_index - opaque cookie to identify the sender
1611     @param context - sender context, to match reply w/ request
1612     @param node_name[] - name of the node
1613 */
1614 define get_node_index {
1615     u32 client_index;
1616     u32 context;
1617     u8 node_name[64];
1618 };
1619
1620 /** \brief Get node index using name request
1621     @param context - sender context, to match reply w/ request
1622     @param retval - return code for the request
1623     @param node_index - index of the desired node if found, else ~0
1624 */
1625 define get_node_index_reply {
1626     u32 context;
1627     i32 retval;
1628     u32 node_index;
1629 };
1630
1631 /** \brief Set the next node for a given node request
1632     @param client_index - opaque cookie to identify the sender
1633     @param context - sender context, to match reply w/ request
1634     @param node_name[] - node to add the next node to
1635     @param next_name[] - node to add as the next node
1636 */
1637 define add_node_next {
1638     u32 client_index;
1639     u32 context;
1640     u8 node_name[64];
1641     u8 next_name[64];
1642 };
1643
1644 /** \brief IP Set the next node for a given node response
1645     @param context - sender context, to match reply w/ request
1646     @param retval - return code for the add next node request
1647     @param next_index - the index of the next node if success, else ~0
1648 */
1649 define add_node_next_reply {
1650     u32 context;
1651     i32 retval;
1652     u32 next_index;
1653 };
1654
1655 /** \brief DHCP Proxy config 2 add / del request
1656     @param client_index - opaque cookie to identify the sender
1657     @param context - sender context, to match reply w/ request
1658     @param rx_vrf_id - receive vrf id
1659     @param server_vrf_id - server vrf id
1660     @param if_ipv6 - ipv6 if non-zero, else ipv4
1661     @param is_add - add the config if non-zero, else delete
1662     @param insert_circuit_id - option82 suboption 1 fib number
1663     @param dhcp_server[] - server address
1664     @param dhcp_src_address[] - <fix this, need details>
1665 */
1666 define dhcp_proxy_config_2 {
1667     u32 client_index;
1668     u32 context;
1669     u32 rx_vrf_id;
1670     u32 server_vrf_id;
1671     u8 is_ipv6;
1672     u8 is_add;
1673     u8 insert_circuit_id;
1674     u8 dhcp_server[16];
1675     u8 dhcp_src_address[16];
1676 };
1677
1678 /** \brief DHCP Proxy config 2 add / del response
1679     @param context - sender context, to match reply w/ request
1680     @param retval - return code for request
1681 */
1682 define dhcp_proxy_config_2_reply {
1683     u32 context;
1684     i32 retval;
1685 };
1686
1687 /** \brief l2tpv3 tunnel interface create request
1688     @param client_index - opaque cookie to identify the sender
1689     @param context - sender context, to match reply w/ request
1690     @param client_address - remote client tunnel ip address
1691     @param client_address - local tunnel ip address
1692     @param is_ipv6 - ipv6 if non-zero, else ipv4
1693     @param local_session_id - local tunnel session id
1694     @param remote_session_id - remote tunnel session id
1695     @param local_cookie - local tunnel cookie
1696     @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1697     @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1698 */
1699 define l2tpv3_create_tunnel {
1700     u32 client_index;
1701     u32 context;
1702     u8 client_address [16];
1703     u8 our_address [16];
1704     u8 is_ipv6;
1705     u32 local_session_id;
1706     u32 remote_session_id;
1707     u64 local_cookie;
1708     u64 remote_cookie;
1709     u8 l2_sublayer_present;
1710     u32 encap_vrf_id;
1711 };
1712
1713 /** \brief l2tpv3 tunnel interface create response
1714     @param context - sender context, to match reply w/ request
1715     @param retval - return code for the request
1716     @param sw_if_index - index of the new tunnel interface
1717 */
1718 define l2tpv3_create_tunnel_reply {
1719     u32 context;
1720     i32 retval;
1721     u32 sw_if_index;
1722 };
1723
1724 define l2tpv3_set_tunnel_cookies {
1725     u32 client_index;
1726     u32 context;
1727     u32 sw_if_index;
1728     u64 new_local_cookie;
1729     u64 new_remote_cookie;
1730 };
1731
1732 /** \brief L2TP tunnel set cookies response
1733     @param context - sender context, to match reply w/ request
1734     @param retval - return code for the request
1735 */
1736 define l2tpv3_set_tunnel_cookies_reply {
1737     u32 context;
1738     i32 retval;
1739 };
1740
1741 define sw_if_l2tpv3_tunnel_details {
1742     u32 context;
1743     u32 sw_if_index;
1744     u8 interface_name[64];
1745     u8 client_address [16];
1746     u8 our_address [16];
1747     u32 local_session_id;
1748     u32 remote_session_id;
1749     u64 local_cookie[2];
1750     u64 remote_cookie;
1751     u8 l2_sublayer_present;
1752 };
1753
1754 define sw_if_l2tpv3_tunnel_dump {
1755     u32 client_index;
1756     u32 context;
1757 };
1758
1759 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1760     @param client_index - opaque cookie to identify the sender
1761     @param context - sender context, to match reply w/ request
1762 */
1763 define l2_fib_clear_table {
1764     u32 client_index;
1765     u32 context;
1766 };
1767
1768 /** \brief L2 fib clear table response
1769     @param context - sender context, to match reply w/ request
1770     @param retval - return code for the request
1771 */
1772 define l2_fib_clear_table_reply {
1773     u32 context;
1774     i32 retval;
1775 };
1776
1777 /** \brief L2 interface ethernet flow point filtering enable/disable request
1778     @param client_index - opaque cookie to identify the sender
1779     @param context - sender context, to match reply w/ request
1780     @param sw_if_index - interface to enable/disable filtering on
1781     @param enable_disable - if non-zero enable filtering, else disable
1782 */
1783 define l2_interface_efp_filter {
1784     u32 client_index;
1785     u32 context;
1786     u32 sw_if_index;
1787     u32 enable_disable;
1788 };
1789
1790 /** \brief L2 interface ethernet flow point filtering response
1791     @param context - sender context, to match reply w/ request
1792     @param retval - return code for the request
1793 */
1794 define l2_interface_efp_filter_reply {
1795     u32 context;
1796     i32 retval;
1797 };
1798
1799 define l2tpv3_interface_enable_disable {
1800     u32 client_index;
1801     u32 context;
1802     u8 enable_disable;
1803     u32 sw_if_index;
1804 }; 
1805
1806 define l2tpv3_interface_enable_disable_reply {
1807     u32 context;
1808     i32 retval;
1809 };
1810
1811 define l2tpv3_set_lookup_key {
1812     u32 client_index;
1813     u32 context;
1814     /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1815     u8 key;
1816 }; 
1817
1818 define l2tpv3_set_lookup_key_reply {
1819     u32 context;
1820     i32 retval;
1821 };
1822
1823 define vxlan_add_del_tunnel {
1824     u32 client_index;
1825     u32 context;
1826     u8 is_add;
1827     u8 is_ipv6;
1828     u8 src_address[16];
1829     u8 dst_address[16];
1830     u32 encap_vrf_id;
1831     u32 decap_next_index;
1832     u32 vni;
1833 };
1834
1835 define vxlan_add_del_tunnel_reply {
1836     u32 context;
1837     i32 retval;
1838     u32 sw_if_index;
1839 };
1840
1841 define vxlan_tunnel_dump {
1842     u32 client_index;
1843     u32 context;
1844     u32 sw_if_index;
1845 };
1846
1847 define vxlan_tunnel_details {
1848     u32 context;
1849     u32 sw_if_index;
1850     u8 src_address[16];
1851     u8 dst_address[16];
1852     u32 encap_vrf_id;
1853     u32 decap_next_index;
1854     u32 vni;
1855     u8 is_ipv6;
1856 };
1857
1858 define gre_add_del_tunnel {
1859     u32 client_index;
1860     u32 context;
1861     u8 is_add;
1862     u32 src_address;
1863     u32 dst_address;
1864     u32 outer_table_id;
1865 };
1866
1867 define gre_add_del_tunnel_reply {
1868     u32 context;
1869     i32 retval;
1870     u32 sw_if_index;
1871 };
1872
1873 define gre_tunnel_dump {
1874     u32 client_index;
1875     u32 context;
1876     u32 sw_if_index;
1877 };
1878
1879 define gre_tunnel_details {
1880     u32 context;
1881     u32 sw_if_index;
1882     u32 src_address;
1883     u32 dst_address;
1884     u32 outer_table_id;
1885 };
1886   
1887 /** \brief L2 interface vlan tag rewrite configure request
1888     @param client_index - opaque cookie to identify the sender
1889     @param context - sender context, to match reply w/ request
1890     @param sw_if_index - interface the operation is applied to
1891     @param vtr_op - Choose from l2_vtr_op_t enum values
1892     @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1893     @param tag1 - Needed for any push or translate vtr op
1894     @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1895 */
1896 define l2_interface_vlan_tag_rewrite {
1897     u32 client_index;
1898     u32 context;
1899     u32 sw_if_index;
1900     u32 vtr_op;
1901     u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1902     u32 tag1;  // first pushed tag
1903     u32 tag2;  // second pushed tag
1904 };
1905
1906 /** \brief L2 interface vlan tag rewrite response
1907     @param context - sender context, to match reply w/ request
1908     @param retval - return code for the request
1909 */
1910 define l2_interface_vlan_tag_rewrite_reply {
1911     u32 context;
1912     i32 retval;
1913 };
1914
1915 /** \brief vhost-user interface create request
1916     @param client_index - opaque cookie to identify the sender
1917     @param is_server - our side is socket server
1918     @param sock_filename - unix socket filename, used to speak with frontend
1919     @param use_custom_mac - enable or disable the use of the provided hardware address
1920     @param mac_address - hardware address to use if 'use_custom_mac' is set
1921 */
1922 define create_vhost_user_if {
1923    u32 client_index;
1924    u32 context;
1925    u8 is_server;
1926    u8 sock_filename[256];
1927    u8 renumber;
1928    u32 custom_dev_instance;
1929    u8 use_custom_mac;
1930    u8 mac_address[6];
1931 };
1932
1933 /** \brief vhost-user interface create response
1934     @param context - sender context, to match reply w/ request
1935     @param retval - return code for the request
1936     @param sw_if_index - interface the operation is applied to
1937 */
1938 define create_vhost_user_if_reply {
1939    u32 context;
1940    i32 retval;
1941    u32 sw_if_index;
1942 };
1943
1944 /** \brief vhost-user interface modify request
1945     @param client_index - opaque cookie to identify the sender
1946     @param is_server - our side is socket server
1947     @param sock_filename - unix socket filename, used to speak with frontend
1948 */
1949 define modify_vhost_user_if {
1950    u32 client_index;
1951    u32 context;
1952    u32 sw_if_index;
1953    u8 is_server;
1954    u8 sock_filename[256];
1955    u8 renumber;
1956    u32 custom_dev_instance;
1957 };
1958
1959 /** \brief vhost-user interface modify response
1960     @param context - sender context, to match reply w/ request
1961     @param retval - return code for the request
1962 */
1963 define modify_vhost_user_if_reply {
1964    u32 context;
1965    i32 retval;
1966 };
1967
1968 /** \brief vhost-user interface delete request
1969     @param client_index - opaque cookie to identify the sender
1970 */
1971 define delete_vhost_user_if {
1972    u32 client_index;
1973    u32 context;
1974    u32 sw_if_index;
1975 };
1976
1977 /** \brief vhost-user interface delete response
1978     @param context - sender context, to match reply w/ request
1979     @param retval - return code for the request
1980 */
1981 define delete_vhost_user_if_reply {
1982    u32 context;
1983    i32 retval;
1984 };
1985
1986 define create_subif {
1987     u32 client_index;
1988     u32 context;
1989     u32 sw_if_index;
1990     u32 sub_id;
1991
1992     /* These fields map directly onto the subif template */
1993     u8 no_tags;
1994     u8 one_tag;
1995     u8 two_tags;
1996     u8 dot1ad;   // 0 = dot1q, 1=dot1ad
1997     u8 exact_match;
1998     u8 default_sub;
1999     u8 outer_vlan_id_any;
2000     u8 inner_vlan_id_any;
2001     u16 outer_vlan_id;
2002     u16 inner_vlan_id;
2003 };
2004
2005 define create_subif_reply {
2006     u32 context;
2007     i32 retval;
2008     u32 sw_if_index;
2009 };
2010
2011 /** \brief show version
2012     @param client_index - opaque cookie to identify the sender
2013     @param context - sender context, to match reply w/ request
2014 */
2015 define show_version {
2016    u32 client_index;
2017    u32 context;
2018 };
2019
2020 /** \brief show version response
2021     @param context - sender context, to match reply w/ request
2022     @param retval - return code for the request
2023     @param program - name of the program (vpe)
2024     @param version  - version of the program
2025     @param build_directory - root of the workspace where the program was built
2026 */
2027 define show_version_reply {
2028    u32 context;
2029    i32 retval;
2030    u8 program[32];
2031    u8 version[32];
2032    u8 build_date[32];
2033    u8 build_directory[256];
2034 };
2035
2036 /** \brief Vhost-user interface details structure (fix this)
2037     @param sw_if_index - index of the interface
2038     @param interface_name - name of interface
2039     @param virtio_net_hdr_sz - net header size
2040     @param features - interface features
2041     @param is_server - vhost-user server socket
2042     @param sock_filename - socket filename
2043     @param num_regions - number of used memory regions
2044 */
2045 define sw_interface_vhost_user_details {
2046     u32 context;
2047     u32 sw_if_index;
2048     u8 interface_name[64];
2049     u32 virtio_net_hdr_sz;
2050     u64 features;
2051     u8 is_server;
2052     u8 sock_filename[256];
2053     u32 num_regions;
2054     i32 sock_errno;
2055 };
2056
2057 /* works */
2058 define sw_interface_vhost_user_dump {
2059     u32 client_index;
2060     u32 context;
2061 };
2062
2063 define ip_address_details {
2064     u32 client_index;
2065     u32 context;
2066     u8 ip[16];
2067     u8 prefix_length;
2068 };
2069
2070 define ip_address_dump {
2071     u32 client_index;
2072     u32 context;
2073     u32 sw_if_index;
2074     u8 is_ipv6;
2075 };
2076
2077 define ip_details {
2078     u32 sw_if_index;
2079     u32 context;
2080 };
2081
2082 define ip_dump {
2083     u32 client_index;
2084     u32 context;
2085     u8 is_ipv6;
2086 };
2087
2088 /** \brief l2 fib table entry structure
2089     @param bd_id - the l2 fib / bridge domain table id
2090     @param mac - the entry's mac address
2091     @param sw_if_index - index of the interface
2092     @param static_mac - the entry is statically configured.
2093     @param filter_mac - the entry is a mac filter entry.
2094     @param bvi_mac - the mac address is a bridge virtual interface
2095 */
2096 define l2_fib_table_entry {
2097     u32 context;
2098     u32 bd_id;
2099     u64 mac;
2100     u32 sw_if_index;
2101     u8 static_mac;
2102     u8 filter_mac;
2103     u8 bvi_mac;
2104 };
2105
2106 /** \brief Dump l2 fib (aka bridge domain) table
2107     @param client_index - opaque cookie to identify the sender
2108     @param bd_id - the l2 fib / bridge domain table identifier
2109 */
2110 define l2_fib_table_dump {
2111     u32 client_index;
2112     u32 context;
2113     u32 bd_id;
2114 };
2115
2116 define vxlan_gpe_add_del_tunnel {
2117     u32 client_index;
2118     u32 context;
2119     u8 is_ipv6;
2120     u8 local[16];
2121     u8 remote[16];
2122     u32 encap_vrf_id;
2123     u32 decap_vrf_id;
2124     u8 protocol;
2125     u32 vni;
2126     u8 is_add;
2127 };
2128
2129 define vxlan_gpe_add_del_tunnel_reply {
2130     u32 context;
2131     i32 retval;
2132     u32 sw_if_index;
2133 };
2134
2135 define vxlan_gpe_tunnel_dump {
2136     u32 client_index;
2137     u32 context;
2138     u32 sw_if_index;
2139 };
2140
2141 define vxlan_gpe_tunnel_details {
2142     u32 context;
2143     u32 sw_if_index;
2144     u8 local[16];
2145     u8 remote[16];
2146     u32 vni;
2147     u8 protocol;
2148     u32 encap_vrf_id;
2149     u32 decap_vrf_id;
2150     u8 is_ipv6;
2151 };
2152
2153 /** \brief add or delete locator_set
2154     @param client_index - opaque cookie to identify the sender
2155     @param context - sender context, to match reply w/ request
2156     @param is_add - add address if non-zero, else delete
2157     @param locator_set_name - locator name
2158 */
2159 define lisp_add_del_locator_set {
2160     u32 client_index;
2161     u32 context;
2162     u8  is_add;
2163     u8  locator_set_name[64];
2164 };
2165
2166 /** \brief Reply for locator_set add/del
2167     @param context - returned sender context, to match reply w/ request
2168     @param retval - return code
2169 */
2170 define lisp_add_del_locator_set_reply {
2171     u32 context;
2172     i32 retval;
2173 };
2174
2175 /** \brief add or delete locator for locator_set
2176     @param client_index - opaque cookie to identify the sender
2177     @param context - sender context, to match reply w/ request
2178     @param is_add - add address if non-zero, else delete
2179     @param locator_set_name - name of locator_set to add/del locator
2180     @param sw_if_index - index of the interface
2181     @param priority - priority of the lisp locator
2182     @param weight - weight of the lisp locator
2183 */
2184 define lisp_add_del_locator {
2185     u32 client_index;
2186     u32 context;
2187     u8  is_add;
2188     u8  locator_set_name[64];
2189     u32 sw_if_index;
2190     u8  priority;
2191     u8  weight;
2192 };
2193
2194 /** \brief Reply for locator add/del
2195     @param context - returned sender context, to match reply w/ request
2196     @param retval - return code
2197 */
2198 define lisp_add_del_locator_reply {
2199     u32 context;
2200     i32 retval;
2201 };
2202
2203 /** \brief add or delete lisp eid-table
2204     @param client_index - opaque cookie to identify the sender
2205     @param context - sender context, to match reply w/ request
2206     @param is_add - add address if non-zero, else delete
2207     @param eid_type:
2208       0 : ipv4
2209       1 : ipv6
2210       2 : mac
2211     @param eid - EID can be ip4, ip6 or mac
2212     @param prefix_len - prefix len
2213     @param locator_set_name - name of locator_set to add/del eid-table
2214     @param vni - virtual network instance
2215 */
2216 define lisp_add_del_local_eid {
2217     u32 client_index;
2218     u32 context;
2219     u8  is_add;
2220     u8  eid_type;
2221     u8  eid[16];
2222     u8  prefix_len;
2223     u8  locator_set_name[64];
2224     u32 vni;
2225 };
2226
2227 /** \brief Reply for local_eid add/del
2228     @param context - returned sender context, to match reply w/ request
2229     @param retval - return code
2230 */
2231 define lisp_add_del_local_eid_reply {
2232     u32 context;
2233     i32 retval;
2234 };
2235
2236 /** \brief add or delete lisp gpe maptunel
2237     @param client_index - opaque cookie to identify the sender
2238     @param context - sender context, to match reply w/ request
2239     @param is_add - add address if non-zero, else delete
2240     @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2241     @param eid_ip_address - array of address bytes
2242     @param eid_prefix_len - prefix len
2243     @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2244     @param source_ip_address - array of address bytes
2245     @param destination_ip_address - array of address bytes
2246 */
2247 define lisp_gpe_add_del_fwd_entry {
2248     u32 client_index;
2249     u32 context;
2250     u8  is_add;
2251     u8  eid_is_ipv6;
2252     u8  eid_ip_address[16];
2253     u8  eid_prefix_len;
2254     u8  address_is_ipv6;
2255     u8  source_ip_address[16];
2256     u8  destination_ip_address[16];
2257 };
2258
2259 /** \brief Reply for gpe_fwd_entry add/del
2260     @param context - returned sender context, to match reply w/ request
2261     @param retval - return code
2262 */
2263 define lisp_gpe_add_del_fwd_entry_reply {
2264     u32 context;
2265     i32 retval;
2266 };
2267
2268 /** \brief add or delete map-resolver
2269     @param client_index - opaque cookie to identify the sender
2270     @param context - sender context, to match reply w/ request
2271     @param is_add - add address if non-zero, else delete
2272     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2273     @param ip_address - array of address bytes
2274 */
2275 define lisp_add_del_map_resolver {
2276     u32 client_index;
2277     u32 context;
2278     u8  is_add;
2279     u8  is_ipv6;
2280     u8  ip_address[16];
2281 };
2282
2283 /** \brief Reply for map_resolver add/del
2284     @param context - returned sender context, to match reply w/ request
2285     @param retval - return code
2286 */
2287 define lisp_add_del_map_resolver_reply {
2288     u32 context;
2289     i32 retval;
2290 };
2291
2292 /** \brief enable or disable lisp-gpe protocol
2293     @param client_index - opaque cookie to identify the sender
2294     @param context - sender context, to match reply w/ request
2295     @param is_en - enable protocol if non-zero, else disable
2296 */
2297 define lisp_gpe_enable_disable {
2298     u32 client_index;
2299     u32 context;
2300     u8  is_en;
2301 };
2302
2303 /** \brief Reply for gpe enable/disable
2304     @param context - returned sender context, to match reply w/ request
2305     @param retval - return code
2306 */
2307 define lisp_gpe_enable_disable_reply {
2308     u32 context;
2309     i32 retval;
2310 };
2311
2312 /** \brief enable or disable LISP feature
2313     @param client_index - opaque cookie to identify the sender
2314     @param context - sender context, to match reply w/ request
2315     @param is_en - enable protocol if non-zero, else disable
2316 */
2317 define lisp_enable_disable {
2318     u32 client_index;
2319     u32 context;
2320     u8  is_en;
2321 };
2322
2323 /** \brief Reply for gpe enable/disable
2324     @param context - returned sender context, to match reply w/ request
2325     @param retval - return code
2326 */
2327 define lisp_enable_disable_reply {
2328     u32 context;
2329     i32 retval;
2330 };
2331
2332 /** \brief add or delete gpe_iface
2333     @param client_index - opaque cookie to identify the sender
2334     @param context - sender context, to match reply w/ request
2335     @param is_add - add address if non-zero, else delete
2336 */
2337 define lisp_gpe_add_del_iface {
2338     u32 client_index;
2339     u32 context;
2340     u8  is_add;
2341     u32 table_id;
2342     u32 vni;
2343 };
2344
2345 /** \brief Reply for gpe_iface add/del
2346     @param context - returned sender context, to match reply w/ request
2347     @param retval - return code
2348 */
2349 define lisp_gpe_add_del_iface_reply {
2350     u32 context;
2351     i32 retval;
2352 };
2353
2354 /** \brief configure or disable LISP PITR node
2355     @param client_index - opaque cookie to identify the sender
2356     @param context - sender context, to match reply w/ request
2357     @param ls_name - locator set name
2358     @param is_add - add locator set if non-zero, else disable pitr
2359 */
2360 define lisp_pitr_set_locator_set {
2361     u32 client_index;
2362     u32 context;
2363     u8 is_add;
2364     u8 ls_name[64];
2365 };
2366
2367 /** \brief Reply for lisp_pitr_set_locator_set
2368     @param context - returned sender context, to match reply w/ request
2369     @param retval - return code
2370 */
2371 define lisp_pitr_set_locator_set_reply {
2372     u32 context;
2373     i32 retval;
2374 };
2375
2376 /** \brief add or delete remote static mapping
2377     @param client_index - opaque cookie to identify the sender
2378     @param context - sender context, to match reply w/ request
2379     @param is_add - add address if non-zero, else delete
2380     @param del_all - if set, delete all remote mappings
2381     @param vni - virtual network instance
2382     @param action - negative map-reply action
2383     @param eid_type -
2384       0 : ipv4
2385       1 : ipv6
2386       2 : mac
2387     @param deid - destination EID
2388     @param seid - source EID
2389     @param rloc_num - number of remote locators
2390     @param rlocs - remote locator data
2391 */
2392 define lisp_add_del_remote_mapping {
2393     u32 client_index;
2394     u32 context;
2395     u8  is_add;
2396     u8 del_all;
2397     u32 vni;
2398     u8 action;
2399     u8 eid_type;
2400     u8 deid[16];
2401     u8 seid[16];
2402     u8 deid_len;
2403     u8 seid_len;
2404     u32 rloc_num;
2405     u8 rlocs[0];
2406 };
2407
2408 /** \brief Reply for lisp_add_del_remote_mapping
2409     @param context - returned sender context, to match reply w/ request
2410     @param retval - return code
2411 */
2412 define lisp_add_del_remote_mapping_reply {
2413     u32 context;
2414     i32 retval;
2415 };
2416
2417 /** \brief add or delete LISP adjacency adjacency
2418     @param client_index - opaque cookie to identify the sender
2419     @param context - sender context, to match reply w/ request
2420     @param is_add - add address if non-zero, else delete
2421     @param vni - virtual network instance
2422     @param eid_type -
2423       0 : ipv4
2424       1 : ipv6
2425       2 : mac
2426     @param deid - destination EID
2427     @param seid - source EID
2428 */
2429 define lisp_add_del_adjacency {
2430     u32 client_index;
2431     u32 context;
2432     u8  is_add;
2433     u32 vni;
2434     u8 eid_type;
2435     u8 deid[16];
2436     u8 seid[16];
2437     u8 deid_len;
2438     u8 seid_len;
2439 };
2440
2441 /** \brief Reply for lisp_add_del_adjacency
2442     @param context - returned sender context, to match reply w/ request
2443     @param retval - return code
2444 */
2445 define lisp_add_del_adjacency_reply {
2446     u32 context;
2447     i32 retval;
2448 };
2449
2450 /** \brief add or delete map request itr rlocs
2451     @param client_index - opaque cookie to identify the sender
2452     @param context - sender context, to match reply w/ request
2453     @param is_add - add address if non-zero, else delete
2454     @param locator_set_name - locator set name
2455 */
2456 define lisp_add_del_map_request_itr_rlocs {
2457     u32 client_index;
2458     u32 context;
2459     u8 is_add;
2460     u8 locator_set_name[64];
2461 };
2462
2463 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2464     @param context - returned sender context, to match reply w/ request
2465     @param retval - return code
2466 */
2467
2468 define lisp_add_del_map_request_itr_rlocs_reply {
2469     u32 context;
2470     i32 retval;
2471 };
2472
2473 /** \brief map/unmap vni to vrf
2474     @param client_index - opaque cookie to identify the sender
2475     @param context - sender context, to match reply w/ request
2476     @param is_add - add or delete mapping
2477     @param vni - virtual network id
2478     @param vrf - vrf
2479 */
2480 define lisp_eid_table_add_del_map {
2481     u32 client_index;
2482     u32 context;
2483     u8 is_add;
2484     u32 vni;
2485     u32 vrf;
2486 };
2487
2488 /** \brief Reply for lisp_eid_table_add_del_map
2489     @param context - returned sender context, to match reply w/ request
2490     @param retval - return code
2491 */
2492 define lisp_eid_table_add_del_map_reply {
2493     u32 context;
2494     i32 retval;
2495 };
2496
2497 /** \brief LISP locator_set status
2498     @param locator_set_name - name of the locator_set
2499     @param sw_if_index - sw_if_index of the locator
2500     @param priority - locator priority
2501     @param weight - locator weight
2502  */
2503 define lisp_locator_set_details {
2504     u32 context;
2505     u8  local;
2506     u8  locator_set_name[64];
2507     u32 sw_if_index;
2508     u8  is_ipv6;
2509     u8  ip_address[16];
2510     u8  prefix_len;
2511     u8  priority;
2512     u8  weight;
2513 };
2514
2515 /** \brief Request for locator_set summary status
2516     @param client_index - opaque cookie to identify the sender
2517     @param context - sender context, to match reply w/ request
2518  */
2519 define lisp_locator_set_dump {
2520     u32 client_index;
2521     u32 context;
2522 };
2523
2524 /** \brief LISP local eid table status
2525     @param locator_set_name - name of the locator_set
2526     @param eid_type - ip4, ip6 or l2 mac address
2527     @param eid - array of address bytes
2528     @param eid_prefix_len - prefix len
2529  */
2530 define lisp_local_eid_table_details {
2531     u32 context;
2532     u8  locator_set_name[64];
2533     u8  eid_type;
2534     u32 vni;
2535     u8  eid[16];
2536     u8  eid_prefix_len;
2537 };
2538
2539 /** \brief Request for local eid table summary status
2540     @param client_index - opaque cookie to identify the sender
2541     @param context - sender context, to match reply w/ request
2542     @param eid_set - if non-zero request info about specific mapping
2543     @param vni - virtual network instance; valid only if eid_set != 0
2544     @param prefix_length - prefix length if EID is IP address;
2545       valid only if eid_set != 0
2546     @param eid_type - EID type; valid only if eid_set != 0
2547       Supported values:
2548         0: EID is IPv4
2549         1: EID is IPv6
2550         2: EID is ethernet address
2551     @param eid - endpoint identifier
2552  */
2553 define lisp_local_eid_table_dump {
2554     u32 client_index;
2555     u32 context;
2556     u8  eid_set;
2557     u8  prefix_length;
2558     u32 vni;
2559     u8  eid_type;
2560     u8  eid[16];
2561 };
2562
2563 /** \brief Shows relationship between vni and vrf
2564     @param vrf - VRF index
2565     @param vni - vitual network instance
2566   */
2567 define lisp_eid_table_map_details {
2568     u32 context;
2569     u32 vni;
2570     u32 vrf;
2571 };
2572
2573 /** \brief Request for lisp_eid_table_map_details
2574     @param client_index - opaque cookie to identify the sender
2575     @param context - sender context, to match reply w/ request
2576  */
2577 define lisp_eid_table_map_dump {
2578     u32 client_index;
2579     u32 context;
2580 };
2581
2582 define lisp_gpe_tunnel_details {
2583     u32 context;
2584     u32 tunnels;
2585     u8  is_ipv6;
2586     u8  source_ip[16];
2587     u8  destination_ip[16];
2588     u32 encap_fib_id;
2589     u32 decap_fib_id;
2590     u32 dcap_next;
2591     u8  lisp_ver;
2592     u8  next_protocol;
2593     u8  flags;
2594     u8  ver_res;
2595     u8  res;
2596     u32 iid;
2597 };
2598
2599 /** \brief Request for gpe tunnel summary status
2600     @param client_index - opaque cookie to identify the sender
2601     @param context - sender context, to match reply w/ request
2602  */
2603 define lisp_gpe_tunnel_dump {
2604     u32 client_index;
2605     u32 context;
2606 };
2607
2608 /** \brief LISP map resolver status
2609     @param locator_set_name - name of the locator_set
2610     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2611     @param ip_address - array of address bytes
2612  */
2613 define lisp_map_resolver_details {
2614     u32 context;
2615     u8  is_ipv6;
2616     u8  ip_address[16];
2617 };
2618
2619 /** \brief Request for map resolver summary status
2620     @param client_index - opaque cookie to identify the sender
2621     @param context - sender context, to match reply w/ request
2622  */
2623 define lisp_map_resolver_dump {
2624     u32 client_index;
2625     u32 context;
2626 };
2627
2628 /** \brief Status of lisp-gpe protocol, enable or disable
2629     @param context - sender context, to match reply w/ request
2630     @param is_en - enable protocol if non-zero, else disable
2631 */
2632 define lisp_enable_disable_status_details {
2633     u32 context;
2634     u8 feature_status;
2635     u8 gpe_status;
2636 };
2637
2638 /** \brief Request for lisp-gpe protocol status
2639     @param client_index - opaque cookie to identify the sender
2640     @param context - sender context, to match reply w/ request
2641 */
2642 define lisp_enable_disable_status_dump {
2643     u32 client_index;
2644     u32 context;
2645 };
2646
2647 /** \brief Get LISP map request itr rlocs status
2648     @param context - sender context, to match reply w/ request
2649     @param locator_set_name - name of the locator_set
2650  */
2651 define lisp_get_map_request_itr_rlocs {
2652     u32 client_index;
2653     u32 context;
2654 };
2655
2656 /** \brief Request for map request itr rlocs summary status
2657  */
2658 define lisp_get_map_request_itr_rlocs_reply {
2659     u32 context;
2660     i32 retval;
2661     u8 locator_set_name[64];
2662 };
2663
2664 /** \brief Request for lisp pitr status
2665     @param client_index - opaque cookie to identify the sender
2666     @param context - sender context, to match reply w/ request
2667 */
2668 define show_lisp_pitr {
2669     u32 client_index;
2670     u32 context;
2671 };
2672
2673 /** \brief Status of lisp pitr, enable or disable
2674     @param context - sender context, to match reply w/ request
2675     @param status - lisp pitr enable if non-zero, else disable
2676     @param locator_set_name -  name of the locator_set
2677 */
2678 define show_lisp_pitr_reply {
2679     u32 context;
2680     i32 retval;
2681     u8  status;
2682     u8  locator_set_name[64];
2683 };
2684
2685 /* Gross kludge, DGMS */
2686 define interface_name_renumber {
2687     u32 client_index;
2688     u32 context;
2689     u32 sw_if_index;
2690     u32 new_show_dev_instance;
2691 };
2692
2693 define interface_name_renumber_reply {
2694     u32 context;
2695     i32 retval;
2696 };
2697
2698 /** \brief Register for ip4 arp resolution events
2699     @param client_index - opaque cookie to identify the sender
2700     @param context - sender context, to match reply w/ request
2701     @param enable_disable - 1 => register for events, 0 => cancel registration
2702     @param pid - sender's pid
2703     @param address - the exact ip4 address of interest
2704 */
2705 define want_ip4_arp_events {
2706     u32 client_index;
2707     u32 context;
2708     u8 enable_disable;
2709     u32 pid;
2710     u32 address;
2711 };
2712
2713 /** \brief Reply for interface events registration
2714     @param context - returned sender context, to match reply w/ request
2715     @param retval - return code
2716 */
2717 define want_ip4_arp_events_reply {
2718     u32 context;
2719     i32 retval;
2720 };
2721
2722 /** \brief Tell client about an ip4 arp resolution event
2723     @param client_index - opaque cookie to identify the sender
2724     @param context - sender context, to match reply w/ request
2725     @param address - the exact ip4 address of interest
2726     @param pid - client pid registered to receive notification
2727     @param sw_if_index - interface which received ARP packet
2728     @param new_mac - the new mac address 
2729 */
2730 define ip4_arp_event {
2731     u32 client_index;
2732     u32 context;
2733     u32 address;
2734     u32 pid;
2735     u32 sw_if_index;
2736     u8 new_mac[6];
2737 };
2738     
2739 /** \brief L2 bridge domain add or delete request
2740     @param client_index - opaque cookie to identify the sender
2741     @param context - sender context, to match reply w/ request
2742     @param bd_id - the bridge domain to create
2743     @param flood - enable/disable bcast/mcast flooding in the bd
2744     @param uu_flood - enable/disable uknown unicast flood in the bd
2745     @param forward - enable/disable forwarding on all interfaces in the bd
2746     @param learn - enable/disable learning on all interfaces in the bd
2747     @param arp_term - enable/disable arp termination in the bd
2748     @param is_add - add or delete flag
2749 */
2750 define bridge_domain_add_del {
2751     u32 client_index;
2752     u32 context;
2753     u32 bd_id;
2754     u8 flood;
2755     u8 uu_flood;
2756     u8 forward;
2757     u8 learn;
2758     u8 arp_term;
2759     u8 is_add;
2760 };
2761
2762 /** \brief L2 bridge domain add or delete response
2763     @param context - sender context, to match reply w/ request
2764     @param retval - return code for the set bridge flags request
2765 */
2766 define bridge_domain_add_del_reply {
2767     u32 context;
2768     i32 retval;
2769 };
2770
2771 /** \brief L2 bridge domain request operational state details
2772     @param client_index - opaque cookie to identify the sender
2773     @param context - sender context, to match reply w/ request
2774     @param bd_id - the bridge domain id desired or ~0 to request all bds
2775 */
2776 define bridge_domain_dump {
2777     u32 client_index;
2778     u32 context;
2779     u32 bd_id;
2780 };
2781
2782 /** \brief L2 bridge domain operational state response
2783     @param bd_id - the bridge domain id
2784     @param flood - bcast/mcast flooding state on all interfaces in the bd
2785     @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2786     @param forward - forwarding state on all interfaces in the bd
2787     @param learn - learning state on all interfaces in the bd
2788     @param arp_term - arp termination state on all interfaces in the bd
2789     @param n_sw_ifs - number of sw_if_index's in the domain
2790 */
2791 define bridge_domain_details {
2792     u32 context;
2793     u32 bd_id;
2794     u8 flood;
2795     u8 uu_flood;
2796     u8 forward;
2797     u8 learn;
2798     u8 arp_term;
2799     u32 bvi_sw_if_index;
2800     u32 n_sw_ifs;
2801 };
2802
2803 /** \brief L2 bridge domain sw interface operational state response
2804     @param bd_id - the bridge domain id
2805     @param sw_if_index - sw_if_index in the domain
2806     @param shg - split horizon group for the interface
2807 */
2808 define bridge_domain_sw_if_details {
2809     u32 context;
2810     u32 bd_id;
2811     u32 sw_if_index;
2812     u8 shg;
2813 };
2814
2815 /** \brief DHCP Client config add / del request
2816     @param client_index - opaque cookie to identify the sender
2817     @param context - sender context, to match reply w/ request
2818     @param sw_if_index - index of the interface for DHCP client
2819     @param hostname - hostname
2820     @param is_add - add the config if non-zero, else delete
2821     @param want_dhcp_event - DHCP event sent to the sender
2822            via dhcp_compl_event API message if non-zero
2823     @param pid - sender's pid
2824 */
2825 define dhcp_client_config {
2826     u32 client_index;
2827     u32 context;
2828     u32 sw_if_index;
2829     u8 hostname[64];
2830     u8 is_add;
2831     u8 want_dhcp_event;
2832     u32 pid;
2833 };
2834
2835 /** \brief DHCP Client config response
2836     @param context - sender context, to match reply w/ request
2837     @param retval - return code for the request
2838 */
2839 define dhcp_client_config_reply {
2840     u32 context;
2841     i32 retval;
2842 };
2843
2844 /** \brief Set/unset input ACL interface
2845     @param client_index - opaque cookie to identify the sender
2846     @param context - sender context, to match reply w/ request
2847     @param sw_if_index - interface to set/unset input ACL
2848     @param ip4_table_index - ip4 classify table index (~0 for skip)
2849     @param ip6_table_index - ip6 classify table index (~0 for skip)
2850     @param l2_table_index  -  l2 classify table index (~0 for skip)
2851     @param is_add - Set input ACL if non-zero, else unset
2852     Note: User is recommeneded to use just one valid table_index per call.
2853           (ip4_table_index, ip6_table_index, or l2_table_index)
2854 */
2855 define input_acl_set_interface {
2856     u32 client_index;
2857     u32 context;
2858     u32 sw_if_index;
2859     u32 ip4_table_index;
2860     u32 ip6_table_index;
2861     u32 l2_table_index;
2862     u8  is_add;
2863 };
2864
2865 /** \brief Set/unset input ACL interface response
2866     @param context - sender context, to match reply w/ request
2867     @param retval - return code for the request
2868 */
2869 define input_acl_set_interface_reply {
2870     u32 context;
2871     i32 retval;
2872 };
2873
2874 /** \brief IPsec: Add/delete Security Policy Database
2875     @param client_index - opaque cookie to identify the sender
2876     @param context - sender context, to match reply w/ request
2877     @param is_add - add SPD if non-zero, else delete
2878     @param spd_id - SPD instance id (control plane allocated)
2879 */
2880
2881 define ipsec_spd_add_del {
2882     u32 client_index;
2883     u32 context;
2884     u8 is_add;
2885     u32 spd_id;
2886 };
2887
2888 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2889     @param context - returned sender context, to match reply w/ request
2890     @param retval - return code
2891 */
2892
2893 define ipsec_spd_add_del_reply {
2894     u32 context;
2895     i32 retval;
2896 };
2897
2898 /** \brief IPsec: Add/delete SPD from interface
2899
2900     @param client_index - opaque cookie to identify the sender
2901     @param context - sender context, to match reply w/ request
2902     @param is_add - add security mode if non-zero, else delete
2903     @param sw_if_index - index of the interface
2904     @param spd_id - SPD instance id to use for lookups
2905 */
2906
2907
2908 define ipsec_interface_add_del_spd {
2909     u32 client_index;
2910     u32 context;
2911
2912     u8 is_add;
2913     u32 sw_if_index;
2914     u32 spd_id;
2915 };
2916
2917 /** \brief Reply for IPsec: Add/delete SPD from interface
2918     @param context - returned sender context, to match reply w/ request
2919     @param retval - return code
2920 */
2921
2922 define ipsec_interface_add_del_spd_reply {
2923     u32 context;
2924     i32 retval;
2925 };
2926
2927 /** \brief IPsec: Add/delete Security Policy Database entry
2928
2929     See RFC 4301, 4.4.1.1 on how to match packet to selectors
2930
2931     @param client_index - opaque cookie to identify the sender
2932     @param context - sender context, to match reply w/ request
2933     @param is_add - add SPD if non-zero, else delete
2934     @param spd_id - SPD instance id (control plane allocated)
2935     @param priority - priority of SPD entry (non-unique value).  Used to order SPD matching - higher priorities match before lower
2936     @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2937     @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2938     @param remote_address_start - start of remote address range to match
2939     @param remote_address_stop - end of remote address range to match
2940     @param local_address_start - start of local address range to match
2941     @param local_address_stop - end of local address range to match
2942     @param protocol - protocol type to match [0 means any]
2943     @param remote_port_start - start of remote port range to match ...
2944     @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2945     @param local_port_start - start of local port range to match ...
2946     @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2947     @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)
2948     @param sa_id - SAD instance id (control plane allocated)
2949
2950 */
2951
2952 define ipsec_spd_add_del_entry {
2953     u32 client_index;
2954     u32 context;
2955     u8 is_add;
2956
2957     u32 spd_id;
2958     i32 priority;
2959     u8 is_outbound;
2960
2961     // Selector
2962     u8 is_ipv6;
2963     u8 is_ip_any;
2964     u8 remote_address_start[16];
2965     u8 remote_address_stop[16];
2966     u8 local_address_start[16];
2967     u8 local_address_stop[16];
2968
2969     u8 protocol;
2970
2971     u16 remote_port_start;
2972     u16 remote_port_stop;
2973     u16 local_port_start;
2974     u16 local_port_stop;
2975
2976     // Policy
2977     u8 policy;
2978     u32 sa_id;
2979 };
2980
2981 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2982     @param context - returned sender context, to match reply w/ request
2983     @param retval - return code
2984 */
2985
2986 define ipsec_spd_add_del_entry_reply {
2987     u32 context;
2988     i32 retval;
2989 };
2990
2991 /** \brief IPsec: Add/delete Security Association Database entry
2992     @param client_index - opaque cookie to identify the sender
2993     @param context - sender context, to match reply w/ request
2994     @param is_add - add SAD entry if non-zero, else delete
2995
2996     @param sad_id - sad id
2997
2998     @param spi - security parameter index
2999
3000     @param protocol - 0 = AH, 1 = ESP
3001
3002     @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3003     @param crypto_key_length - length of crypto_key in bytes
3004     @param crypto_key - crypto keying material
3005
3006     @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3007     @param integrity_key_length - length of integrity_key in bytes
3008     @param integrity_key - integrity keying material
3009
3010     @param use_extended_sequence_number - use ESN when non-zero
3011
3012     @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3013     @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3014     @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
3015     @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
3016
3017     To be added:
3018      Anti-replay
3019      IPsec tunnel address copy mode (to support GDOI)
3020  */
3021
3022 define ipsec_sad_add_del_entry {
3023     u32 client_index;
3024     u32 context;
3025     u8 is_add;
3026
3027     u32 sad_id;
3028
3029     u32 spi;
3030
3031     u8 protocol;
3032
3033     u8 crypto_algorithm;
3034     u8 crypto_key_length;
3035     u8 crypto_key[128];
3036
3037     u8 integrity_algorithm;
3038     u8 integrity_key_length;
3039     u8 integrity_key[128];
3040
3041     u8 use_extended_sequence_number;
3042
3043     u8 is_tunnel;
3044     u8 is_tunnel_ipv6;
3045     u8 tunnel_src_address[16];
3046     u8 tunnel_dst_address[16];
3047 };
3048
3049 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3050     @param context - returned sender context, to match reply w/ request
3051     @param retval - return code
3052 */
3053
3054 define ipsec_sad_add_del_entry_reply {
3055     u32 context;
3056     i32 retval;
3057 };
3058
3059 /** \brief IPsec: Update Security Association keys
3060     @param client_index - opaque cookie to identify the sender
3061     @param context - sender context, to match reply w/ request
3062
3063     @param sa_id - sa id
3064
3065     @param crypto_key_length - length of crypto_key in bytes
3066     @param crypto_key - crypto keying material
3067
3068     @param integrity_key_length - length of integrity_key in bytes
3069     @param integrity_key - integrity keying material
3070 */
3071
3072 define ipsec_sa_set_key {
3073     u32 client_index;
3074     u32 context;
3075
3076     u32 sa_id;
3077
3078     u8 crypto_key_length;
3079     u8 crypto_key[128];
3080
3081     u8 integrity_key_length;
3082     u8 integrity_key[128];
3083 };
3084
3085 /** \brief Reply for IPsec: Update Security Association keys
3086     @param context - returned sender context, to match reply w/ request
3087     @param retval - return code
3088 */
3089
3090 define ipsec_sa_set_key_reply {
3091     u32 context;
3092     i32 retval;
3093 };
3094
3095 /** \brief IKEv2: Add/delete profile
3096     @param client_index - opaque cookie to identify the sender
3097     @param context - sender context, to match reply w/ request
3098
3099     @param name - IKEv2 profile name
3100     @param is_add - Add IKEv2 profile if non-zero, else delete
3101 */
3102 define ikev2_profile_add_del {
3103     u32 client_index;
3104     u32 context;
3105
3106     u8 name[64];
3107     u8 is_add;
3108 };
3109
3110 /** \brief Reply for IKEv2: Add/delete profile
3111     @param context - returned sender context, to match reply w/ request
3112     @param retval - return code
3113 */
3114 define ikev2_profile_add_del_reply {
3115     u32 context;
3116     i32 retval;
3117 };
3118
3119 /** \brief IKEv2: Set IKEv2 profile authentication method
3120     @param client_index - opaque cookie to identify the sender
3121     @param context - sender context, to match reply w/ request
3122
3123     @param name - IKEv2 profile name
3124     @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3125     @param is_hex - Authentication data in hex format if non-zero, else string
3126     @param data_len - Authentication data length
3127     @param data - Authentication data (for rsa-sig cert file path)
3128 */
3129 define ikev2_profile_set_auth {
3130     u32 client_index;
3131     u32 context;
3132
3133     u8 name[64];
3134     u8 auth_method;
3135     u8 is_hex;
3136     u32 data_len;
3137     u8 data[0];
3138 };
3139
3140 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3141     @param context - returned sender context, to match reply w/ request
3142     @param retval - return code
3143 */
3144 define ikev2_profile_set_auth_reply {
3145     u32 context;
3146     i32 retval;
3147 };
3148
3149 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3150     @param client_index - opaque cookie to identify the sender
3151     @param context - sender context, to match reply w/ request
3152
3153     @param name - IKEv2 profile name
3154     @param is_local - Identification is local if non-zero, else remote
3155     @param id_type - Identification type
3156     @param data_len - Identification data length
3157     @param data - Identification data
3158 */
3159 define ikev2_profile_set_id {
3160     u32 client_index;
3161     u32 context;
3162
3163     u8 name[64];
3164     u8 is_local;
3165     u8 id_type;
3166     u32 data_len;
3167     u8 data[0];
3168 };
3169
3170 /** \brief Reply for IKEv2:
3171     @param context - returned sender context, to match reply w/ request
3172     @param retval - return code
3173 */
3174 define ikev2_profile_set_id_reply {
3175     u32 context;
3176     i32 retval;
3177 };
3178
3179 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3180     @param client_index - opaque cookie to identify the sender
3181     @param context - sender context, to match reply w/ request
3182
3183     @param name - IKEv2 profile name
3184     @param is_local - Traffic selector is local if non-zero, else remote
3185     @param proto - Traffic selector IP protocol (if zero not relevant)
3186     @param start_port - The smallest port number allowed by traffic selector
3187     @param end_port - The largest port number allowed by traffic selector
3188     @param start_addr - The smallest address included in traffic selector
3189     @param end_addr - The largest address included in traffic selector
3190 */
3191 define ikev2_profile_set_ts {
3192     u32 client_index;
3193     u32 context;
3194
3195     u8 name[64];
3196     u8 is_local;
3197     u8 proto;
3198     u16 start_port;
3199     u16 end_port;
3200     u32 start_addr;
3201     u32 end_addr;
3202 };
3203
3204 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3205     @param context - returned sender context, to match reply w/ request
3206     @param retval - return code
3207 */
3208 define ikev2_profile_set_ts_reply {
3209     u32 context;
3210     i32 retval;
3211 };
3212
3213 /** \brief IKEv2: Set IKEv2 local RSA private key
3214     @param client_index - opaque cookie to identify the sender
3215     @param context - sender context, to match reply w/ request
3216
3217     @param key_file - Key file absolute path
3218 */
3219 define ikev2_set_local_key {
3220     u32 client_index;
3221     u32 context;
3222
3223     u8 key_file[256];
3224 };
3225
3226 /** \brief Reply for IKEv2: Set IKEv2 local key
3227     @param context - returned sender context, to match reply w/ request
3228     @param retval - return code
3229 */
3230 define ikev2_set_local_key_reply {
3231     u32 context;
3232     i32 retval;
3233 };
3234
3235 /** \brief Tell client about a DHCP completion event
3236     @param client_index - opaque cookie to identify the sender
3237     @param pid - client pid registered to receive notification
3238     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3239     @param host_address - Host IP address
3240     @param router_address - Router IP address
3241     @param host_mac - Host MAC address
3242 */
3243 define dhcp_compl_event {
3244     u32 client_index;
3245     u32 pid;
3246     u8 hostname[64];
3247     u8 is_ipv6;
3248     u8 host_address[16];
3249     u8 router_address[16];
3250     u8 host_mac[6];
3251 };
3252
3253 /** \brief Add MAP domains
3254     @param client_index - opaque cookie to identify the sender
3255     @param context - sender context, to match reply w/ request
3256     @param ip6_prefix - Rule IPv6 prefix
3257     @param ip4_prefix - Rule IPv4 prefix
3258     @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3259     @param ip6_prefix_len - Rule IPv6 prefix length
3260     @param ip4_prefix_len - Rule IPv4 prefix length
3261     @param ea_bits_len - Embedded Address bits length
3262     @param psid_offset - Port Set Identifider (PSID) offset
3263     @param psid_length - PSID length
3264     @param is_translation - MAP-E / MAP-T
3265     @param mtu - MTU
3266 */
3267 define map_add_domain {
3268   u32 client_index;
3269   u32 context;
3270   u8 ip6_prefix[16];
3271   u8 ip4_prefix[4];
3272   u8 ip6_src[16];
3273   u8 ip6_prefix_len;
3274   u8 ip4_prefix_len;
3275   u8 ip6_src_prefix_len;
3276   u8 ea_bits_len;
3277   u8 psid_offset;
3278   u8 psid_length;
3279   u8 is_translation;
3280   u16 mtu;
3281 };
3282
3283 /** \brief Reply for MAP domain add
3284     @param context - returned sender context, to match reply w/ request
3285     @param index - MAP domain index
3286     @param retval - return code
3287 */
3288 define map_add_domain_reply {
3289   u32 context;
3290   u32 index;
3291   i32 retval;
3292 };
3293
3294 /** \brief Delete MAP domain
3295     @param client_index - opaque cookie to identify the sender
3296     @param context - sender context, to match reply w/ request
3297     @param index - MAP Domain index
3298 */
3299 define map_del_domain {
3300   u32 client_index;
3301   u32 context;
3302   u32 index;
3303 };
3304
3305 /** \brief Reply for MAP domain del
3306     @param context - returned sender context, to match reply w/ request
3307     @param retval - return code
3308 */
3309 define map_del_domain_reply {
3310   u32 context;
3311   i32 retval;
3312 };
3313
3314 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3315     @param client_index - opaque cookie to identify the sender
3316     @param context - sender context, to match reply w/ request
3317     @param index - MAP Domain index
3318     @param is_add - If 1 add rule, if 0 delete rule
3319     @param ip6_dst - MAP CE IPv6 address
3320     @param psid - Rule PSID
3321 */
3322 define map_add_del_rule {
3323   u32 client_index;
3324   u32 context;
3325   u32 index;
3326   u32 is_add;
3327   u8 ip6_dst[16];
3328   u16 psid;
3329 };
3330
3331 /** \brief Reply for MAP rule add/del
3332     @param context - returned sender context, to match reply w/ request
3333     @param retval - return code
3334 */
3335 define map_add_del_rule_reply {
3336   u32 context;
3337   i32 retval;
3338 };
3339
3340 /** \brief Get list of map domains
3341     @param client_index - opaque cookie to identify the sender
3342 */
3343 define map_domain_dump {
3344   u32 client_index;
3345   u32 context;
3346 };
3347
3348 define map_domain_details {
3349   u32 context;
3350   u32 domain_index;
3351   u8 ip6_prefix[16];
3352   u8 ip4_prefix[4];
3353   u8 ip6_src[16];
3354   u8 ip6_prefix_len;
3355   u8 ip4_prefix_len;
3356   u8 ip6_src_len;
3357   u8 ea_bits_len;
3358   u8 psid_offset;
3359   u8 psid_length;
3360   u8 flags;
3361   u16 mtu;
3362   u8 is_translation;
3363 };
3364
3365 define map_rule_dump {
3366   u32 client_index;
3367   u32 context;
3368   u32 domain_index;
3369 };
3370
3371 define map_rule_details {
3372   u32 context;
3373   u8 ip6_dst[16];
3374   u16 psid;
3375 };
3376
3377 /** \brief Request for a single block of summary stats
3378     @param client_index - opaque cookie to identify the sender
3379     @param context - sender context, to match reply w/ request
3380 */
3381 define map_summary_stats {
3382     u32 client_index;
3383     u32 context;
3384 };
3385
3386 /** \brief Reply for map_summary_stats request
3387     @param context - sender context, to match reply w/ request
3388     @param retval - return code for request
3389     @param total_bindings -  
3390     @param total_pkts -  
3391     @param total_ip4_fragments -
3392     @param total_security_check - 
3393 */
3394 define map_summary_stats_reply {
3395     u32 context;
3396     i32 retval;
3397     u64 total_bindings;
3398     u64 total_pkts[2];
3399     u64 total_bytes[2];
3400     u64 total_ip4_fragments;
3401     u64 total_security_check[2];
3402 };
3403
3404 /** \brief cop: enable/disable junk filtration features on an interface
3405     @param client_index - opaque cookie to identify the sender
3406     @param context - sender context, to match reply w/ request
3407     @param sw_if_inded - desired interface
3408     @param enable_disable - 1 => enable, 0 => disable
3409 */
3410
3411 define cop_interface_enable_disable {
3412     u32 client_index;
3413     u32 context;
3414     u32 sw_if_index;
3415     u8 enable_disable;
3416 };
3417
3418 /** \brief cop: interface enable/disable junk filtration reply
3419     @param context - returned sender context, to match reply w/ request
3420     @param retval - return code
3421 */
3422
3423 define cop_interface_enable_disable_reply {
3424     u32 context;
3425     i32 retval;
3426 };
3427
3428 /** \brief cop: enable/disable whitelist filtration features on an interface
3429     Note: the supplied fib_id must match in order to remove the feature!
3430     
3431     @param client_index - opaque cookie to identify the sender
3432     @param context - sender context, to match reply w/ request
3433     @param sw_if_index - interface handle, physical interfaces only
3434     @param fib_id - fib identifier for the whitelist / blacklist fib
3435     @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3436     @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3437     @param default_cop -  1 => enable non-ip4, non-ip6 filtration 0=> disable it
3438 */
3439
3440 define cop_whitelist_enable_disable {
3441     u32 client_index;
3442     u32 context;
3443     u32 sw_if_index;
3444     u32 fib_id;
3445     u8 ip4;
3446     u8 ip6;
3447     u8 default_cop;
3448 };
3449
3450 /** \brief cop: interface enable/disable junk filtration reply
3451     @param context - returned sender context, to match reply w/ request
3452     @param retval - return code
3453 */
3454
3455 define cop_whitelist_enable_disable_reply {
3456     u32 context;
3457     i32 retval;
3458 };
3459
3460 /** \brief get_node_graph - get a copy of the vpp node graph
3461     including the current set of graph arcs.
3462
3463     @param client_index - opaque cookie to identify the sender
3464     @param context - sender context, to match reply w/ request
3465 */
3466
3467 define get_node_graph {
3468     u32 client_index;
3469     u32 context;
3470 };
3471
3472 /** \brief get_node_graph_reply
3473     @param context - returned sender context, to match reply w/ request
3474     @param retval - return code
3475     @param reply_in_shmem - result from vlib_node_serialize, in shared
3476     memory. Process with vlib_node_unserialize, remember to switch
3477     heaps and free the result.
3478 */
3479
3480 define get_node_graph_reply {
3481     u32 context;
3482     i32 retval;
3483     u64 reply_in_shmem;
3484 };
3485
3486 /** \brief Clear interface statistics
3487     @param client_index - opaque cookie to identify the sender
3488     @param context - sender context, to match reply w/ request
3489     @param sw_if_index - index of the interface to clear statistics
3490 */
3491 define sw_interface_clear_stats {
3492     u32 client_index;
3493     u32 context;
3494     u32 sw_if_index;
3495 };
3496
3497 /** \brief Reply to sw_interface_clear_stats 
3498     @param context - sender context which was passed in the request
3499     @param retval - return code of the set flags request
3500 */
3501 define sw_interface_clear_stats_reply {
3502     u32 context;
3503     i32 retval;
3504 };
3505
3506 /** \brief IOAM Trace : Set TRACE profile
3507     @param id - profile id
3508     @param trace_type - Trace type
3509     @param trace_num_elt - Number of nodes in trace path
3510     @param trace_ppc - Trace PPC (none/encap/decap)
3511     @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3512     @param trace_app_data - Trace application data, can be any 4 bytes
3513     @param pow_enable - Proof of Work enabled or not flag
3514     @param node_id - Id of this node
3515 */
3516 define trace_profile_add {
3517   u32 client_index;
3518   u32 context;
3519   u16 id;
3520   u8  trace_type;
3521   u8  trace_num_elt;
3522   u8  trace_ppc;
3523   u8  trace_tsp;
3524   u32 trace_app_data;
3525   u8  pow_enable;
3526   u32 node_id;
3527 };
3528
3529 /** \brief Trace profile add / del response
3530     @param context - sender context, to match reply w/ request
3531     @param retval - return value for request
3532 */
3533 define trace_profile_add_reply {
3534     u32 context;
3535     i32 retval;
3536 };
3537
3538 /** \brief IOAM Trace enable trace profile for a flow
3539     @param id - id of the trace profile to be applied
3540     @param dest_ipv6 - Destination IPv6 address
3541     @param prefix_length - prefix mask
3542     @param vrf_id - VRF ID
3543     @param trace_op - Trace operation (add/mod/del)
3544     @param enable - apply/remove the trace profile for the flow
3545 */
3546 define trace_profile_apply {
3547   u32 client_index;
3548   u32 context;
3549   u16 id;
3550   u8 dest_ipv6[16];
3551   u32 prefix_length;
3552   u32 vrf_id;
3553   u8 trace_op;
3554   u8 enable;
3555 };
3556
3557 /** \brief Trace profile apply response
3558     @param context - sender context, to match reply w/ request   
3559     @param retval - return value for request
3560 */
3561 define trace_profile_apply_reply {
3562   u32 context;
3563   i32 retval;
3564 };
3565
3566 /** \brief Delete Trace Profile 
3567     @param client_index - opaque cookie to identify the sender
3568     @param context - sender context, to match reply w/ request
3569     @param index - MAP Domain index
3570 */
3571 define trace_profile_del {
3572   u32 client_index;
3573   u32 context;
3574   u16 id;
3575 };
3576
3577 /** \brief Trace profile add / del response
3578     @param context - sender context, to match reply w/ request
3579     @param retval - return value for request
3580 */
3581 define trace_profile_del_reply {
3582     u32 context;
3583     i32 retval;
3584 };
3585
3586 /** \brief Create host-interface
3587     @param client_index - opaque cookie to identify the sender
3588     @param context - sender context, to match reply w/ request
3589     @param host_if_name - interface name
3590     @param hw_addr - interface MAC
3591     @param use_random_hw_addr - use random generated MAC
3592 */
3593 define af_packet_create {
3594     u32 client_index;
3595     u32 context;
3596
3597     u8 host_if_name[64];
3598     u8 hw_addr[6];
3599     u8 use_random_hw_addr;
3600 };
3601
3602 /** \brief Create host-interface response
3603     @param context - sender context, to match reply w/ request
3604     @param retval - return value for request
3605 */
3606 define af_packet_create_reply {
3607     u32 context;
3608     i32 retval;
3609     u32 sw_if_index;
3610 };
3611
3612 /** \brief Delete host-interface
3613     @param client_index - opaque cookie to identify the sender
3614     @param context - sender context, to match reply w/ request
3615     @param host_if_name - interface name
3616 */
3617 define af_packet_delete {
3618     u32 client_index;
3619     u32 context;
3620
3621     u8 host_if_name[64];
3622 };
3623
3624 /** \brief Delete host-interface response
3625     @param context - sender context, to match reply w/ request
3626     @param retval - return value for request
3627 */
3628 define af_packet_delete_reply {
3629     u32 context;
3630     i32 retval;
3631 };
3632
3633 /** \brief Add/del policer
3634     @param client_index - opaque cookie to identify the sender
3635     @param context - sender context, to match reply w/ request
3636     @param is_add - add policer if non-zero, else delete
3637     @param name - policer name
3638     @param cir - CIR
3639     @param eir - EIR
3640     @param cb - Committed Burst
3641     @param eb - Excess or Peak Burst
3642     @param rate_type - rate type
3643     @param round_type - rounding type
3644     @param type - policer algorithm
3645     @param conform_action_type - conform action type
3646     @param conform_dscp - DSCP for conform mar-and-transmit action
3647     @param exceed_action_type - exceed action type
3648     @param exceed_dscp - DSCP for exceed mar-and-transmit action
3649     @param violate_action_type - violate action type
3650     @param violate_dscp - DSCP for violate mar-and-transmit action
3651 */
3652 define policer_add_del {
3653     u32 client_index;
3654     u32 context;
3655
3656     u8 is_add;
3657     u8 name[64];
3658     u32 cir;
3659     u32 eir;
3660     u64 cb;
3661     u64 eb;
3662     u8 rate_type;
3663     u8 round_type;
3664     u8 type;
3665     u8 conform_action_type;
3666     u8 conform_dscp;
3667     u8 exceed_action_type;
3668     u8 exceed_dscp;
3669     u8 violate_action_type;
3670     u8 violate_dscp;
3671 };
3672
3673 /** \brief Add/del policer response
3674     @param context - sender context, to match reply w/ request
3675     @param retval - return value for request
3676 */
3677 define policer_add_del_reply {
3678     u32 context;
3679     i32 retval;
3680 };
3681
3682 /** \brief Get list of policers
3683     @param client_index - opaque cookie to identify the sender
3684     @param context - sender context, to match reply w/ request
3685     @param match_name_valid - if 0 request all policers otherwise use match_name
3686     @param match_name - policer name
3687 */
3688 define policer_dump {
3689     u32 client_index;
3690     u32 context;
3691
3692     u8 match_name_valid;
3693     u8 match_name[64];
3694 };
3695
3696 /** \brief Policer operational state response.
3697     @param context - sender context, to match reply w/ request
3698     @param name - policer name
3699     @param cir - CIR
3700     @param eir - EIR
3701     @param cb - Committed Burst
3702     @param eb - Excess or Peak Burst
3703     @param rate_type - rate type
3704     @param round_type - rounding type
3705     @param type - policer algorithm
3706     @param conform_action_type - conform action type
3707     @param conform_dscp - DSCP for conform mar-and-transmit action
3708     @param exceed_action_type - exceed action type
3709     @param exceed_dscp - DSCP for exceed mar-and-transmit action
3710     @param violate_action_type - violate action type
3711     @param violate_dscp - DSCP for violate mar-and-transmit action
3712     @param single_rate - 1 = single rate policer, 0 = two rate policer
3713     @param color_aware - for hierarchical policing
3714     @param scale - power-of-2 shift amount for lower rates
3715     @param cir_tokens_per_period - number of tokens for each period
3716     @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3717     @param current_limit - current limit
3718     @param current_bucket - current bucket
3719     @param extended_limit - extended limit
3720     @param extended_bucket - extended bucket
3721     @param last_update_time - last update time
3722 */
3723 define policer_details {
3724     u32 context;
3725
3726     u8 name[64];
3727     u32 cir;
3728     u32 eir;
3729     u64 cb;
3730     u64 eb;
3731     u8 rate_type;
3732     u8 round_type;
3733     u8 type;
3734     u8 conform_action_type;
3735     u8 conform_dscp;
3736     u8 exceed_action_type;
3737     u8 exceed_dscp;
3738     u8 violate_action_type;
3739     u8 violate_dscp;
3740     u8 single_rate;
3741     u8 color_aware;
3742     u32 scale;
3743     u32 cir_tokens_per_period;
3744     u32 pir_tokens_per_period;
3745     u32 current_limit;
3746     u32 current_bucket;
3747     u32 extended_limit;
3748     u32 extended_bucket;
3749     u64 last_update_time;
3750 };
3751
3752 /** \brief Create netmap
3753     @param client_index - opaque cookie to identify the sender
3754     @param context - sender context, to match reply w/ request
3755     @param netmap_if_name - interface name
3756     @param hw_addr - interface MAC
3757     @param use_random_hw_addr - use random generated MAC
3758     @param is_pipe - is pipe
3759     @param is_master - 0=slave, 1=master
3760 */
3761 define netmap_create {
3762     u32 client_index;
3763     u32 context;
3764
3765     u8 netmap_if_name[64];
3766     u8 hw_addr[6];
3767     u8 use_random_hw_addr;
3768     u8 is_pipe;
3769     u8 is_master;
3770 };
3771
3772 /** \brief Create netmap response
3773     @param context - sender context, to match reply w/ request
3774     @param retval - return value for request
3775 */
3776 define netmap_create_reply {
3777     u32 context;
3778     i32 retval;
3779 };
3780
3781 /** \brief Delete netmap
3782     @param client_index - opaque cookie to identify the sender
3783     @param context - sender context, to match reply w/ request
3784     @param netmap_if_name - interface name
3785 */
3786 define netmap_delete {
3787     u32 client_index;
3788     u32 context;
3789
3790     u8 netmap_if_name[64];
3791 };
3792
3793 /** \brief Delete netmap response
3794     @param context - sender context, to match reply w/ request
3795     @param retval - return value for request
3796 */
3797 define netmap_delete_reply {
3798     u32 context;
3799     i32 retval;
3800 };
3801
3802 /** \brief Dump mpls gre tunnel table
3803     @param client_index - opaque cookie to identify the sender
3804     @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
3805 */
3806 define mpls_gre_tunnel_dump {
3807     u32 client_index;
3808     u32 context;
3809     i32 tunnel_index;
3810 };
3811
3812 /** \brief mpls gre tunnel operational state response
3813     @param tunnel_index - gre tunnel identifier
3814     @param intfc_address - interface ipv4 addr
3815     @param mask_width - interface ipv4 addr mask
3816     @param hw_if_index - interface id
3817     @param l2_only -
3818     @param tunnel_src - tunnel source ipv4 addr
3819     @param tunnel_dst - tunnel destination ipv4 addr
3820     @param outer_fib_index - gre tunnel identifier
3821     @param encap_index - reference to mpls label table
3822     @param nlabels - number of resolved labels
3823     @param labels - resolved labels
3824 */
3825 define mpls_gre_tunnel_details {
3826     u32 context;
3827     u32 tunnel_index;
3828
3829     u32 intfc_address;
3830     u32 inner_fib_index;
3831     u32 mask_width;
3832     u32 encap_index;
3833     u32 hw_if_index;
3834     u8  l2_only;
3835     u32 tunnel_src;
3836     u32 tunnel_dst;
3837     u32 outer_fib_index;
3838     u32 nlabels;
3839     u32 labels[0];
3840 };
3841
3842 /** \brief Dump mpls eth tunnel table
3843     @param client_index - opaque cookie to identify the sender
3844     @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
3845 */
3846 define mpls_eth_tunnel_dump {
3847     u32 client_index;
3848     u32 context;
3849     i32 tunnel_index;
3850 };
3851
3852 /** \brief mpls eth tunnel operational state response
3853     @param tunnel_index - eth tunnel identifier
3854     @param intfc_address - interface ipv4 addr
3855     @param mask_width - interface ipv4 addr mask
3856     @param hw_if_index - interface id
3857     @param l2_only -
3858     @param tunnel_dst_mac -
3859     @param tx_sw_if_index -
3860     @param encap_index - reference to mpls label table
3861     @param nlabels - number of resolved labels
3862     @param labels - resolved labels
3863 */
3864 define mpls_eth_tunnel_details {
3865     u32 context;
3866     u32 tunnel_index;
3867
3868     u32 intfc_address;
3869     u32 inner_fib_index;
3870     u32 mask_width;
3871     u32 encap_index;
3872     u32 hw_if_index;
3873     u8  l2_only;
3874     u8  tunnel_dst_mac[6];
3875     u32 tx_sw_if_index;
3876     u32 nlabels;
3877     u32 labels[0];
3878 };
3879
3880 /** \brief Dump mpls fib table
3881     @param client_index - opaque cookie to identify the sender
3882     @param fib_index    - mpls fib entry identifier or -1 in case of all entries
3883 */
3884 define mpls_fib_encap_dump {
3885     u32 client_index;
3886     u32 context;
3887 };
3888
3889 /** \brief mpls fib encap table response
3890     @param fib_index - fib table id
3891     @param dest - destination ipv4 addr
3892     @param s_bit -
3893     @param entry_index - reference to mpls label table
3894     @param nlabels - number of resolved labels
3895     @param labels - resolved labels
3896 */
3897 define mpls_fib_encap_details {
3898     u32 context;
3899
3900     u32 fib_index;
3901     u32 entry_index;
3902     u32 dest;
3903     u32 s_bit;
3904     u32 nlabels;
3905     u32 labels[0];
3906 };
3907
3908 /** \brief Dump mpls fib decap table
3909     @param client_index - opaque cookie to identify the sender
3910     @param fib_index    - mpls fib entry identifier or -1 in case of all entries
3911 */
3912 define mpls_fib_decap_dump {
3913     u32 client_index;
3914     u32 context;
3915 };
3916
3917 /** \brief mpls fib decap table response
3918     @param fib_index - fib table id
3919     @param entry_index - reference to mpls label table
3920     @param dest - destination ipv4 addr
3921     @param s_bit -
3922     @param label - mpls labels
3923     @param rx_table_id - rx fib id
3924     @param tx_table_id - tx fib id
3925     @param swif_tag -
3926 */
3927 define mpls_fib_decap_details {
3928     u32 context;
3929
3930     u32 fib_index;
3931     u32 entry_index;
3932     u32 dest;
3933     u32 s_bit;
3934     u32 label;
3935     u32 rx_table_id;
3936     u32 tx_table_id;
3937     u8  swif_tag[8];
3938 };
3939
3940 /** \brief Classify get table IDs request
3941     @param client_index - opaque cookie to identify the sender
3942     @param context - sender context, to match reply w/ request
3943 */
3944 define classify_table_ids {
3945     u32 client_index;
3946     u32 context;
3947 };
3948
3949 /** \brief Reply for classify get table IDs request
3950     @param context - sender context which was passed in the request
3951     @param count - number of ids returned in response
3952     @param ids - array of classify table ids
3953 */
3954 define classify_table_ids_reply {
3955     u32 context;
3956     i32 retval;
3957     u32 count;
3958     u32 ids[count];
3959 };
3960
3961 /** \brief Classify table ids by interface index request
3962     @param client_index - opaque cookie to identify the sender
3963     @param context - sender context, to match reply w/ request
3964     @param sw_if_index - index of the interface
3965 */
3966 define classify_table_by_interface {
3967     u32 client_index;
3968     u32 context;
3969     u32 sw_if_index;
3970 };
3971
3972 /** \brief Reply for classify table id by interface index request
3973     @param context - sender context which was passed in the request
3974     @param count - number of ids returned in response
3975     @param sw_if_index - index of the interface
3976     @param l2_table_id - l2 classify table index
3977     @param ip4_table_id - ip4 classify table index
3978     @param ip6_table_id - ip6 classify table index
3979 */
3980 define classify_table_by_interface_reply {
3981     u32 context;
3982     i32 retval;
3983     u32 sw_if_index;
3984     u32 l2_table_id;
3985     u32 ip4_table_id;
3986     u32 ip6_table_id;
3987 };
3988
3989 /** \brief Classify table info
3990     @param client_index - opaque cookie to identify the sender
3991     @param context - sender context, to match reply w/ request
3992     @param table_id - classify table index
3993 */
3994 define classify_table_info {
3995     u32 client_index;
3996     u32 context;
3997     u32 table_id;
3998 };
3999
4000 /** \brief Reply for classify table info request
4001     @param context - sender context which was passed in the request
4002     @param count - number of ids returned in response
4003     @param table_id - classify table index
4004     @param nbuckets - number of buckets when adding a table
4005     @param match_n_vectors - number of match vectors
4006     @param skip_n_vectors - number of skip_n_vectors
4007     @param active_sessions - number of sessions (active entries)
4008     @param next_table_index - index of next table
4009     @param miss_next_index - index of miss table
4010     @param mask[] - match mask
4011 */
4012 define classify_table_info_reply {
4013     u32 context;
4014     i32 retval;
4015     u32 table_id;
4016     u32 nbuckets;
4017     u32 match_n_vectors;
4018     u32 skip_n_vectors;
4019     u32 active_sessions;
4020     u32 next_table_index;
4021     u32 miss_next_index;
4022     u32 mask_length;
4023     u8  mask[mask_length];
4024 };
4025
4026 /** \brief Classify sessions dump request
4027     @param client_index - opaque cookie to identify the sender
4028     @param context - sender context, to match reply w/ request
4029     @param table_id - classify table index
4030 */
4031 define classify_session_dump {
4032     u32 client_index;
4033     u32 context;
4034     u32 table_id;
4035 };
4036
4037 /** \brief Reply for classify table session dump request
4038     @param context - sender context which was passed in the request
4039     @param count - number of ids returned in response
4040     @param table_id - classify table index
4041     @param hit_next_index - hit_next_index of session
4042     @param opaque_index - for add, opaque_index of session
4043     @param advance - advance value of session
4044     @param match[] - match value for session
4045 */ 
4046 define classify_session_details {
4047     u32 context;
4048     i32 retval;
4049     u32 table_id;
4050     u32 hit_next_index;
4051     i32 advance;
4052     u32 opaque_index;
4053     u32 match_length;
4054     u8 match[match_length];
4055 };
4056
4057 /** \brief Enable and configure IPFIX exporter process request
4058     @param client_index - opaque cookie to identify the sender
4059     @param context - sender context, to match reply w/ request
4060     @param collector_address - address of IPFIX collector
4061     @param collector_port - port of IPFIX IPFIX collector
4062     @param src_address - address of IPFIX exporter
4063     @param vrf_id - VRF / fib table ID
4064     @param path_mtu - Path MTU between exporter and collector
4065     @param template_interval - number of seconds after which to resend template
4066 */
4067 define ipfix_enable {
4068     u32 client_index;
4069     u32 context;
4070     u8 collector_address[16];
4071     u16 collector_port;
4072     u8 src_address[16];
4073     u32 vrf_id;
4074     u32 path_mtu;
4075     u32 template_interval;
4076 };
4077
4078 /** \brief Reply to IPFIX enable and configure request
4079     @param context - sender context which was passed in the request
4080 */
4081 define ipfix_enable_reply {
4082     u32 context;
4083     i32 retval;
4084 };
4085
4086 /** \brief IPFIX dump request
4087     @param client_index - opaque cookie to identify the sender
4088     @param context - sender context, to match reply w/ request
4089 */
4090 define ipfix_dump {
4091     u32 client_index;
4092     u32 context;
4093 };
4094
4095 /** \brief Reply to IPFIX dump request
4096     @param context - sender context which was passed in the request
4097     @param collector_address - address of IPFIX collector
4098     @param collector_port - port of IPFIX IPFIX collector
4099     @param src_address - address of IPFIX exporter
4100     @param fib_index - fib table index
4101     @param path_mtu - Path MTU between exporter and collector
4102     @param template_interval - number of seconds after which to resend template
4103 */
4104 define ipfix_details {
4105     u32 context;
4106     u8 collector_address[16];
4107     u16 collector_port;
4108     u8 src_address[16];
4109     u32 fib_index;
4110     u32 path_mtu;
4111     u32 template_interval;
4112 };
4113
4114 /** \brief Query relative index via node names
4115     @param client_index - opaque cookie to identify the sender
4116     @param context - sender context, to match reply w/ request
4117     @param node_name - name of node to find relative index from
4118     @param next_name - next node from node_name to find relative index of
4119 */
4120 define get_next_index {
4121     u32 client_index;
4122     u32 context;
4123     u8 node_name[64];
4124     u8 next_name[64];
4125 };
4126
4127 /** \brief Reply for get next node index
4128     @param context - sender context which was passed in the request
4129     @param retval - return value
4130     @param next_index - index of the next_node
4131 */
4132 define get_next_index_reply {
4133     u32 context;
4134     i32 retval;
4135     u32 next_index;
4136 };