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