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