1 /* Hey Emacs use -*- mode: C -*- */
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 This file defines vpe control-plane API messages which are generally
20 called through a shared memory interface.
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
30 define want_interface_events
38 /** \brief Reply for interface events registration
39 @param context - returned sender context, to match reply w/ request
40 @param retval - return code
42 define want_interface_events_reply
48 /** \brief Interface details structure (fix this)
49 @param sw_if_index - index of the interface
50 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
51 @param l2_address_length - length of the interface's l2 address
52 @param pid - the interface's l2 address
53 @param interface_name - name of the interface
54 @param link_duplex - 1 if half duplex, 2 if full duplex
55 @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
56 @param link_MTU - max. transmittion unit
57 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
58 @param sub_dot1ad - 0 = dot1q, 1=dot1ad
59 @param sub_number_of_tags - Number of tags (0 - 2)
60 @param sub_outer_vlan_id
61 @param sub_inner_vlan_id
62 @param sub_exact_match
64 @param sub_outer_vlan_id_any
65 @param sub_inner_vlan_id_any
66 @param vtr_op - vlan tag rewrite operation
71 define sw_interface_details
76 /* index of sup interface (e.g. hw interface).
77 equal to sw_if_index for super hw interface. */
80 /* Layer 2 address, if applicable */
81 u32 l2_address_length;
85 u8 interface_name[64];
87 /* 1 = up, 0 = down */
91 /* 1 = half duplex, 2 = full duplex */
94 /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
100 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
103 /* 0 = dot1q, 1=dot1ad */
106 /* Number of tags 0-2 */
107 u8 sub_number_of_tags;
108 u16 sub_outer_vlan_id;
109 u16 sub_inner_vlan_id;
112 u8 sub_outer_vlan_id_any;
113 u8 sub_inner_vlan_id_any;
115 /* vlan tag rewrite state */
117 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
118 u32 vtr_tag1; // first pushed tag
119 u32 vtr_tag2; // second pushed tag
122 /** \brief Set flags on the interface
123 @param client_index - opaque cookie to identify the sender
124 @param context - sender context, to match reply w/ request
125 @param sw_if_index - index of the interface to set flags on
126 @param admin_up_down - set the admin state, 1 = up, 0 = down
127 @param link_up_down - Oper state sent on change event, not used in config.
128 @param deleted - interface was deleted
130 define sw_interface_set_flags
135 /* 1 = up, 0 = down */
141 /** \brief Reply to sw_interface_set_flags
142 @param context - sender context which was passed in the request
143 @param retval - return code of the set flags request
145 define sw_interface_set_flags_reply
152 define sw_interface_dump
156 u8 name_filter_valid;
160 /** \brief Set or delete one or all ip addresses on a specified interface
161 @param client_index - opaque cookie to identify the sender
162 @param context - sender context, to match reply w/ request
163 @param sw_if_index - index of the interface to add/del addresses
164 @param is_add - add address if non-zero, else delete
165 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
166 @param del_all - if non-zero delete all addresses on the interface
167 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
168 @param address - array of address bytes
170 define sw_interface_add_del_address
182 /** \brief Reply for interface events registration
183 @param context - returned sender context, to match reply w/ request
184 @param retval - return code
186 define sw_interface_add_del_address_reply
192 /** \brief Associate the specified interface with a fib table
193 @param client_index - opaque cookie to identify the sender
194 @param context - sender context, to match reply w/ request
195 @param sw_if_index - index of the interface
196 @param is_ipv6 - if non-zero ipv6, else ipv4
197 @param vrf_id - fib table/vrd id to associate the interface with
199 define sw_interface_set_table
208 /** \brief Reply for interface events registration
209 @param context - returned sender context, to match reply w/ request
210 @param retval - return code
212 define sw_interface_set_table_reply
218 /** \brief Initialize a new tap interface with the given paramters
219 @param client_index - opaque cookie to identify the sender
220 @param context - sender context, to match reply w/ request
221 @param use_random_mac - let the system generate a unique mac address
222 @param tap_name - name to associate with the new interface
223 @param mac_address - mac addr to assign to the interface if use_radom not set
233 u32 custom_dev_instance;
236 /** \brief Reply for tap connect request
237 @param context - returned sender context, to match reply w/ request
238 @param retval - return code
239 @param sw_if_index - software index allocated for the new tap interface
241 define tap_connect_reply
248 /** \brief Modify a tap interface with the given paramters
249 @param client_index - opaque cookie to identify the sender
250 @param context - sender context, to match reply w/ request
251 @param sw_if_index - interface index of existing tap interface
252 @param use_random_mac - let the system generate a unique mac address
253 @param tap_name - name to associate with the new interface
254 @param mac_address - mac addr to assign to the interface if use_radom not set
265 u32 custom_dev_instance;
268 /** \brief Reply for tap modify request
269 @param context - returned sender context, to match reply w/ request
270 @param retval - return code
271 @param sw_if_index - software index if the modified tap interface
273 define tap_modify_reply
280 /** \brief Delete tap interface
281 @param client_index - opaque cookie to identify the sender
282 @param context - sender context, to match reply w/ request
283 @param sw_if_index - interface index of existing tap interface
292 /** \brief Reply for tap delete request
293 @param context - returned sender context, to match reply w/ request
294 @param retval - return code
296 define tap_delete_reply
302 /** \brief Dump tap interfaces request */
303 define sw_interface_tap_dump
309 /** \brief Reply for tap dump request
310 @param sw_if_index - software index of tap interface
311 @param dev_name - Linux tap device name
313 define sw_interface_tap_details
320 /** \brief Create a new subinterface with the given vlan id
321 @param client_index - opaque cookie to identify the sender
322 @param context - sender context, to match reply w/ request
323 @param sw_if_index - software index of the new vlan's parent interface
324 @param vlan_id - vlan tag of the new interface
326 define create_vlan_subif
334 /** \brief Reply for the vlan subinterface create request
335 @param context - returned sender context, to match reply w/ request
336 @param retval - return code
337 @param sw_if_index - software index allocated for the new subinterface
339 define create_vlan_subif_reply
346 /** \brief Add / del route request
347 @param client_index - opaque cookie to identify the sender
348 @param context - sender context, to match reply w/ request
349 @param sw_if_index - software index of the new vlan's parent interface
350 @param vrf_id - fib table /vrf associated with the route
351 @param lookup_in_vrf -
352 @param resolve_attempts -
353 @param classify_table_index -
354 @param create_vrf_if_needed -
355 @param resolve_if_needed -
356 @param is_add - 1 if adding the route, 0 if deleting
358 @param is_ipv6 - 0 if an ip4 route, else ip6
361 @param is_multipath - Set to 1 if this is a multipath route, else 0
362 @param not_last - Is last or not last msg in group of multiple add/del msgs
363 @param next_hop_weight -
364 @param dst_address_length -
365 @param dst_address[16] -
366 @param next_hop_address[16] -
368 define ip_add_del_route
372 u32 next_hop_sw_if_index;
375 u32 resolve_attempts;
376 u32 classify_table_index;
377 u8 create_vrf_if_needed;
378 u8 resolve_if_needed;
384 /* Is last/not-last message in group of multiple add/del messages. */
388 u8 dst_address_length;
390 u8 next_hop_address[16];
393 /** \brief Reply for add / del route request
394 @param context - returned sender context, to match reply w/ request
395 @param retval - return code
397 define ip_add_del_route_reply
404 /** \brief Add / del gre tunnel request
405 @param client_index - opaque cookie to identify the sender
406 @param context - sender context, to match reply w/ request
407 @param sw_if_index - software index of the new vlan's parent interface
408 @param inner_vrf_id -
409 @param outer_vrf_id -
410 @param is_add - 1 if adding the tunnel, 0 if deleting
411 @param src_address[4] - tunnel source address
412 @param dst_address[4] - tunnel destination address
413 @param intf_address -
414 @param intf_address_length -
416 define mpls_gre_add_del_tunnel
427 u8 intfc_address_length;
430 /** \brief Reply for add / del tunnel request
431 @param context - returned sender context, to match reply w/ request
432 @param retval - return code
434 define mpls_gre_add_del_tunnel_reply
438 u32 tunnel_sw_if_index;
441 /** \brief Add / del MPLS encapsulation request
442 @param client_index - opaque cookie to identify the sender
443 @param context - sender context, to match reply w/ request
444 @param vrf_id - vrf id
445 @param dst_address[4] -
446 @param is_add - 1 if adding the encap, 0 if deleting
447 @param nlabels - number of labels
448 @param labels - array of labels
450 define mpls_add_del_encap
456 /* 1 = add, 0 = delete */
462 /** \brief Reply for add / del encapsulation request
463 @param context - returned sender context, to match reply w/ request
464 @param retval - return code
466 define mpls_add_del_encap_reply
472 /** \brief Add / del MPLS decapsulation request
473 @param client_index - opaque cookie to identify the sender
474 @param context - sender context, to match reply w/ request
475 @param rx_vrf_id - receive vrf
476 @param tx_vrf_id - transmit vrf
480 @param is_add - 1 if adding the encap, 0 if deleting
482 define mpls_add_del_decap
494 /** \brief Reply for MPLS decap add / del request
495 @param context - returned sender context, to match reply w/ request
496 @param retval - return code
498 define mpls_add_del_decap_reply
504 /** \brief Proxy ARP add / del request
505 @param client_index - opaque cookie to identify the sender
506 @param context - sender context, to match reply w/ request
507 @param vrf_id - VRF / Fib table ID
508 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
509 @param low_address[4] - Low address of the Proxy ARP range
510 @param hi_address[4] - High address of the Proxy ARP range
512 define proxy_arp_add_del
522 /** \brief Reply for proxy arp add / del request
523 @param context - returned sender context, to match reply w/ request
524 @param retval - return code
526 define proxy_arp_add_del_reply
532 /** \brief Proxy ARP add / del request
533 @param client_index - opaque cookie to identify the sender
534 @param context - sender context, to match reply w/ request
535 @param sw_if_index - Which interface to enable / disable Proxy Arp on
536 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
538 define proxy_arp_intfc_enable_disable
543 /* 1 = on, 0 = off */
547 /** \brief Reply for Proxy ARP interface enable / disable request
548 @param context - returned sender context, to match reply w/ request
549 @param retval - return code
551 define proxy_arp_intfc_enable_disable_reply
557 /** \brief IP neighbor add / del request
558 @param client_index - opaque cookie to identify the sender
559 @param context - sender context, to match reply w/ request
560 @param vrf_id - vrf_id, only for IP4
561 @param sw_if_index - interface used to reach neighbor
562 @param is_add - 1 to add neighbor, 0 to delete
563 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
565 @param mac_address - l2 address of the neighbor
566 @param dst_address - ip4 or ip6 address of the neighbor
568 define ip_neighbor_add_del
572 u32 vrf_id; /* only makes sense for ip4 */
574 /* 1 = add, 0 = delete */
582 /** \brief Reply for IP Neighbor add / delete request
583 @param context - returned sender context, to match reply w/ request
584 @param retval - return code
586 define ip_neighbor_add_del_reply
592 /** \brief Reset VRF (remove all routes etc) request
593 @param client_index - opaque cookie to identify the sender
594 @param context - sender context, to match reply w/ request
595 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
596 @param vrf_id - ID of th FIB table / VRF to reset
606 /** \brief Reply for Reset VRF request
607 @param context - returned sender context, to match reply w/ request
608 @param retval - return code
610 define reset_vrf_reply
616 /** \brief Is Address Reachable request - DISABLED
617 @param client_index - opaque cookie to identify the sender
618 @param context - sender context, to match reply w/ request
619 @param next_hop_sw_if_index - index of interface used to get to next hop
620 @param is_ipv6 - 1 for IPv6, 0 for IPv4
621 @param is_error - address not found or does not match intf
622 @param address[] - Address in question
624 define is_address_reachable
626 u32 client_index; /* (api_main_t *) am->my_client_index */
628 u32 next_hop_sw_if_index;
629 u8 is_known; /* on reply, this is the answer */
631 u8 is_error; /* address not found or does not match intf */
635 /** \brief Want Stats, register for stats updates
636 @param client_index - opaque cookie to identify the sender
637 @param context - sender context, to match reply w/ request
638 @param enable_disable - 1 = enable stats, 0 = disable
639 @param pid - pid of process requesting stats updates
649 /** \brief Reply for Want Stats request
650 @param context - returned sender context, to match reply w/ request
651 @param retval - return code
653 define want_stats_reply
659 /** \brief Want stats counters structure
660 @param vnet_counter_type- such as ip4, ip6, punts, etc
661 @param is_combined - rx & tx total (all types) counts
662 @param first_sw_if_index - first sw index in block of index, counts
663 @param count - number of interfaces this stats block includes counters for
664 @param data - contiguous block of vlib_counter_t structures
666 define vnet_interface_counters
668 /* enums - plural - in vnet/interface.h */
669 u8 vnet_counter_type;
671 u32 first_sw_if_index;
676 typeonly manual_print manual_endian define ip4_fib_counter
684 manual_print manual_endian define vnet_ip4_fib_counters
688 vl_api_ip4_fib_counter_t c[count];
691 typeonly manual_print manual_endian define ip6_fib_counter
699 manual_print manual_endian define vnet_ip6_fib_counters
703 vl_api_ip6_fib_counter_t c[count];
706 /** \brief Request for a single block of summary stats
707 @param client_index - opaque cookie to identify the sender
708 @param context - sender context, to match reply w/ request
710 define vnet_get_summary_stats
716 /** \brief Reply for vnet_get_summary_stats request
717 @param context - sender context, to match reply w/ request
718 @param retval - return code for request
723 define vnet_summary_stats_reply
732 /** \brief OAM event structure
733 @param dst_address[] -
742 /** \brief Want OAM events request
743 @param client_index - opaque cookie to identify the sender
744 @param context - sender context, to match reply w/ request
745 @param enable_disable- enable if non-zero, else disable
746 @param pid - pid of the requesting process
748 define want_oam_events
756 /** \brief Want OAM events response
757 @param context - sender context, to match reply w/ request
758 @param retval - return code for the want oam stats request
760 define want_oam_events_reply
766 /** \brief OAM add / del target request
767 @param client_index - opaque cookie to identify the sender
768 @param context - sender context, to match reply w/ request
769 @param vrf_id - vrf_id of the target
770 @param src_address[] - source address to use for the updates
771 @param dst_address[] - destination address of the target
772 @param is_add - add target if non-zero, else delete
784 /** \brief OAM add / del target response
785 @param context - sender context, to match reply w/ request
786 @param retval - return code of the request
788 define oam_add_del_reply
794 /** \brief Reset fib table request
795 @param client_index - opaque cookie to identify the sender
796 @param context - sender context, to match reply w/ request
797 @param vrf_id - vrf/table id of the fib table to reset
798 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
808 /** \brief Reset fib response
809 @param context - sender context, to match reply w/ request
810 @param retval - return code for the reset bfib request
812 define reset_fib_reply
818 /** \brief DHCP Proxy config add / del request
819 @param client_index - opaque cookie to identify the sender
820 @param context - sender context, to match reply w/ request
821 @param vrf_id - vrf id
822 @param if_ipv6 - ipv6 if non-zero, else ipv4
823 @param is_add - add the config if non-zero, else delete
824 @param insert_circuit_id - option82 suboption 1 fib number
825 @param dhcp_server[] - server address
826 @param dhcp_src_address[] - <fix this, need details>
828 define dhcp_proxy_config
835 u8 insert_circuit_id;
837 u8 dhcp_src_address[16];
840 /** \brief DHCP Proxy config response
841 @param context - sender context, to match reply w/ request
842 @param retval - return code for the request
844 define dhcp_proxy_config_reply
850 /** \brief DHCP Proxy set / unset vss request
851 @param client_index - opaque cookie to identify the sender
852 @param context - sender context, to match reply w/ request
853 @param tbl_id - table id
854 @param oui - first part of vpn id
855 @param fib_id - second part of vpn id
856 @param is_ipv6 - ip6 if non-zero, else ip4
857 @param is_add - set vss if non-zero, else delete
859 define dhcp_proxy_set_vss
870 /** \brief DHCP proxy set / unset vss response
871 @param context - sender context, to match reply w/ request
872 @param retval - return code for the request
874 define dhcp_proxy_set_vss_reply
880 /** \brief Set the ip flow hash config for a fib request
881 @param client_index - opaque cookie to identify the sender
882 @param context - sender context, to match reply w/ request
883 @param vrf_id - vrf/fib id
884 @param is_ipv6 - if non-zero the fib is ip6, else ip4
885 @param src - if non-zero include src in flow hash
886 @param dst - if non-zero include dst in flow hash
887 @param sport - if non-zero include sport in flow hash
888 @param dport - if non-zero include dport in flow hash
889 @param proto -if non-zero include proto in flow hash
890 @param reverse - if non-zero include reverse in flow hash
892 define set_ip_flow_hash
906 /** \brief Set the ip flow hash config for a fib response
907 @param context - sender context, to match reply w/ request
908 @param retval - return code for the request
910 define set_ip_flow_hash_reply
916 /** \brief IPv6 router advertisement config request
917 @param client_index - opaque cookie to identify the sender
918 @param context - sender context, to match reply w/ request
923 @param send_unicast -
926 @param default_router -
927 @param max_interval -
928 @param min_interval -
930 @param initial_count -
931 @param initial_interval -
933 define sw_interface_ip6nd_ra_config
950 u32 initial_interval;
953 /** \brief IPv6 router advertisement config response
954 @param context - sender context, to match reply w/ request
955 @param retval - return code for the request
957 define sw_interface_ip6nd_ra_config_reply
963 /** \brief IPv6 router advertisement prefix config request
964 @param client_index - opaque cookie to identify the sender
965 @param context - sender context, to match reply w/ request
968 @param address_length -
970 @param no_advertise -
972 @param no_autoconfig -
975 @param val_lifetime -
976 @param pref_lifetime -
978 define sw_interface_ip6nd_ra_prefix
995 /** \brief IPv6 router advertisement prefix config response
996 @param context - sender context, to match reply w/ request
997 @param retval - return code for the request
999 define sw_interface_ip6nd_ra_prefix_reply
1005 /** \brief IPv6 interface enable / disable request
1006 @param client_index - opaque cookie to identify the sender
1007 @param context - sender context, to match reply w/ request
1008 @param sw_if_index - interface used to reach neighbor
1009 @param enable - if non-zero enable ip6 on interface, else disable
1011 define sw_interface_ip6_enable_disable
1016 u8 enable; /* set to true if enable */
1019 /** \brief IPv6 interface enable / disable response
1020 @param context - sender context, to match reply w/ request
1021 @param retval - return code for the request
1023 define sw_interface_ip6_enable_disable_reply
1029 /** \brief IPv6 set link local address on interface request
1030 @param client_index - opaque cookie to identify the sender
1031 @param context - sender context, to match reply w/ request
1032 @param sw_if_index - interface to set link local on
1033 @param address[] - the new link local address
1034 @param address_length - link local address length
1036 define sw_interface_ip6_set_link_local_address
1045 /** \brief IPv6 set link local address on interface response
1046 @param context - sender context, to match reply w/ request
1047 @param retval - error code for the request
1049 define sw_interface_ip6_set_link_local_address_reply
1055 /** \brief Set unnumbered interface add / del request
1056 @param client_index - opaque cookie to identify the sender
1057 @param context - sender context, to match reply w/ request
1058 @param sw_if_index - interface with an IP address
1059 @param unnumbered_sw_if_index - interface which will use the address
1060 @param is_add - if non-zero set the association, else unset it
1062 define sw_interface_set_unnumbered
1066 u32 sw_if_index; /* use this intfc address */
1067 u32 unnumbered_sw_if_index; /* on this interface */
1071 /** \brief Set unnumbered interface add / del response
1072 @param context - sender context, to match reply w/ request
1073 @param retval - return code for the request
1075 define sw_interface_set_unnumbered_reply
1081 /** \brief Create loopback interface request
1082 @param client_index - opaque cookie to identify the sender
1083 @param context - sender context, to match reply w/ request
1084 @param mac_address - mac addr to assign to the interface if none-zero
1086 define create_loopback
1093 /** \brief Create loopback interface response
1094 @param context - sender context, to match reply w/ request
1095 @param sw_if_index - sw index of the interface that was created
1096 @param retval - return code for the request
1098 define create_loopback_reply
1105 /** \brief Delete loopback interface request
1106 @param client_index - opaque cookie to identify the sender
1107 @param context - sender context, to match reply w/ request
1108 @param sw_if_index - sw index of the interface that was created
1110 define delete_loopback
1117 /** \brief Delete loopback interface response
1118 @param context - sender context, to match reply w/ request
1119 @param retval - return code for the request
1121 define delete_loopback_reply
1127 /** \brief Control ping from client to api server request
1128 @param client_index - opaque cookie to identify the sender
1129 @param context - sender context, to match reply w/ request
1137 /** \brief Control ping from the client to the server response
1138 @param client_index - opaque cookie to identify the sender
1139 @param context - sender context, to match reply w/ request
1140 @param retval - return code for the request
1141 @param vpe_pid - the pid of the vpe, returned by the server
1143 define control_ping_reply
1151 /** \brief Control ping from client to api server request, no print json output
1152 @param client_index - opaque cookie to identify the sender
1153 @param context - sender context, to match reply w/ request
1155 define noprint_control_ping
1161 /** \brief Control ping from the client to the server response
1162 @param client_index - opaque cookie to identify the sender
1163 @param context - sender context, to match reply w/ request
1164 @param retval - return code for the request
1165 @param vpe_pid - the pid of the vpe, returned by the server
1167 define noprint_control_ping_reply
1175 /** \brief Process a vpe parser cli string request
1176 @param client_index - opaque cookie to identify the sender
1177 @param context - sender context, to match reply w/ request
1178 @param cmd_in_shmem - pointer to cli command string
1187 /** \brief vpe parser cli string response
1188 @param context - sender context, to match reply w/ request
1189 @param retval - return code for request
1190 @param reply_in_shmem - Reply string from cli processing if any
1199 /** \brief Set max allowed ARP or ip6 neighbor entries request
1200 @param client_index - opaque cookie to identify the sender
1201 @param context - sender context, to match reply w/ request
1202 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1203 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1205 define set_arp_neighbor_limit
1210 u32 arp_neighbor_limit;
1213 /** \brief Set max allowed ARP or ip6 neighbor entries response
1214 @param context - sender context, to match reply w/ request
1215 @param retval - return code for request
1217 define set_arp_neighbor_limit_reply
1223 /** \brief L2 interface patch add / del request
1224 @param client_index - opaque cookie to identify the sender
1225 @param context - sender context, to match reply w/ request
1226 @param rx_sw_if_index - receive side interface
1227 @param tx_sw_if_index - transmit side interface
1228 @param is_add - if non-zero set up the interface patch, else remove it
1230 define l2_patch_add_del
1239 /** \brief L2 interface patch add / del response
1240 @param context - sender context, to match reply w/ request
1241 @param retval - return code for the request
1243 define l2_patch_add_del_reply
1249 /** \brief IPv6 segment routing tunnel add / del request
1250 @param client_index - opaque cookie to identify the sender
1251 @param context - sender context, to match reply w/ request
1252 @param is_add - add the tunnel if non-zero, else delete it
1253 @param name[] - tunnel name (len. 64)
1254 @param src_address[] -
1255 @param dst_address[] -
1256 @param dst_mask_width -
1257 @param inner_vrf_id -
1258 @param outer_vrf_id -
1259 @param flags_net_byte_order -
1262 @param segs_and_tags[] -
1263 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1265 define sr_tunnel_add_del
1276 u16 flags_net_byte_order;
1279 u8 segs_and_tags[0];
1283 /** \brief IPv6 segment routing tunnel add / del response
1284 @param context - sender context, to match reply w/ request
1285 @param retval - return value for request
1287 define sr_tunnel_add_del_reply
1293 /** \brief IPv6 segment routing policy add / del request
1294 @param client_index - opaque cookie to identify the sender
1295 @param context - sender context, to match reply w/ request
1296 @param is_add - add the tunnel if non-zero, else delete it
1297 @param name[] - policy name (len. 64)
1298 @param tunnel_names[] -
1300 define sr_policy_add_del
1309 /** \brief IPv6 segment routing policy add / del response
1310 @param context - sender context, to match reply w/ request
1311 @param retval - return value for request
1313 define sr_policy_add_del_reply
1319 /** \brief IPv6 segment routing multicast map to policy add / del request
1320 @param client_index - opaque cookie to identify the sender
1321 @param context - sender context, to match reply w/ request
1322 @param is_add - add the tunnel if non-zero, else delete it
1323 @param multicast_address[] - IP6 multicast address
1324 @param policy_name[] = policy name (len.64)
1326 define sr_multicast_map_add_del
1331 u8 multicast_address[16];
1335 /** \brief IPv6 segment routing multicast map to policy add / del response
1336 @param context - sender context, to match reply w/ request
1337 @param retval - return value for request
1339 define sr_multicast_map_add_del_reply
1345 /** \brief Interface set vpath request
1346 @param client_index - opaque cookie to identify the sender
1347 @param context - sender context, to match reply w/ request
1348 @param sw_if_index - interface used to reach neighbor
1349 @param enable - if non-zero enable, else disable
1351 define sw_interface_set_vpath
1359 /** \brief Interface set vpath response
1360 @param context - sender context, to match reply w/ request
1361 @param retval - return code for the request
1363 define sw_interface_set_vpath_reply
1369 /** \brief MPLS Ethernet add / del tunnel request
1370 @param client_index - opaque cookie to identify the sender
1371 @param context - sender context, to match reply w/ request
1372 @param vrf_id - vrf_id, only for IP4
1373 @param sw_if_index - interface used to reach neighbor
1374 @param is_add - add if set, tunnel delete if 0
1375 @param dst_mac_address -
1376 @param adj_address -
1377 @param adj_address_length -
1379 define mpls_ethernet_add_del_tunnel
1387 u8 dst_mac_address[6];
1389 u8 adj_address_length;
1392 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1393 @param context - sender context, to match reply w/ request
1394 @param retval - return code for the request
1396 define mpls_ethernet_add_del_tunnel_reply
1400 u32 tunnel_sw_if_index;
1402 /** \brief MPLS Ethernet add/ del tunnel 2
1403 @param client_index - opaque cookie to identify the sender
1404 @param context - sender context, to match reply w/ request
1405 @param inner_vrf_id -
1406 @param outer_vrf_id -
1407 @param resolve_attempts -
1408 @param resolve_opaque -
1409 @param resolve_if_needed -
1411 @param adj_address -
1412 @param adj_address_length -
1413 @param next_hop_ip4_address_in_outer_vrf -
1415 define mpls_ethernet_add_del_tunnel_2
1421 u32 resolve_attempts;
1422 u32 resolve_opaque; /* no need to set this */
1423 u8 resolve_if_needed;
1427 u8 adj_address_length;
1428 u8 next_hop_ip4_address_in_outer_vrf[4];
1431 /** \brief MPLS Ethernet add/ del tunnel 2
1432 @param context - sender context, to match reply w/ request
1433 @param retval - return code for add /del request
1435 define mpls_ethernet_add_del_tunnel_2_reply
1441 /** \brief Set L2 XConnect between two interfaces request
1442 @param client_index - opaque cookie to identify the sender
1443 @param context - sender context, to match reply w/ request
1444 @param rx_sw_if_index - Receive interface index
1445 @param tx_sw_if_index - Transmit interface index
1446 @param enable - enable xconnect if not 0, else set to L3 mode
1448 define sw_interface_set_l2_xconnect
1457 /** \brief Set L2 XConnect response
1458 @param context - sender context, to match reply w/ request
1459 @param retval - L2 XConnect request return code
1461 define sw_interface_set_l2_xconnect_reply
1467 /** \brief Interface bridge mode request
1468 @param client_index - opaque cookie to identify the sender
1469 @param context - sender context, to match reply w/ request
1470 @param rx_sw_if_index - the interface
1471 @param bd_id - bridge domain id
1472 @param bvi - Setup interface as a bvi, bridge mode only
1473 @param shg - Shared horizon group, for bridge mode only
1474 @param enable - Enable beige mode if not 0, else set to L3 mode
1476 define sw_interface_set_l2_bridge
1487 /** \brief Interface bridge mode response
1488 @param context - sender context, to match reply w/ request
1489 @param retval - Bridge mode request return code
1491 define sw_interface_set_l2_bridge_reply
1497 /** \brief L2 FIB add entry request
1498 @param client_index - opaque cookie to identify the sender
1499 @param context - sender context, to match reply w/ request
1500 @param mac - the entry's mac address
1501 @param bd_id - the entry's bridge domain id
1502 @param sw_if_index - the interface
1503 @param is_add - If non zero add the entry, else delete it
1507 define l2fib_add_del
1520 /** \brief L2 FIB add entry response
1521 @param context - sender context, to match reply w/ request
1522 @param retval - return code for the add l2fib entry request
1524 define l2fib_add_del_reply
1530 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1531 @param client_index - opaque cookie to identify the sender
1532 @param context - sender context, to match reply w/ request
1533 @param sw_if_index - interface
1534 @param is_set - if non-zero, set the bits, else clear them
1535 @param feature_bitmap - non-zero bits to set or clear
1546 /** \brief Set L2 bits response
1547 @param context - sender context, to match reply w/ request
1548 @param retval - return code for the set l2 bits request
1550 define l2_flags_reply
1554 u32 resulting_feature_bitmap;
1557 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1558 L2_UU_FLOOD, or L2_ARP_TERM) request
1559 @param client_index - opaque cookie to identify the sender
1560 @param context - sender context, to match reply w/ request
1561 @param bd_id - the bridge domain to set the flags for
1562 @param is_set - if non-zero, set the flags, else clear them
1563 @param feature_bitmap - bits that are non-zero to set or clear
1574 /** \brief Set bridge flags response
1575 @param context - sender context, to match reply w/ request
1576 @param retval - return code for the set bridge flags request
1577 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1579 define bridge_flags_reply
1583 u32 resulting_feature_bitmap;
1586 /** \brief Set bridge domain ip to mac entry request
1587 @param client_index - opaque cookie to identify the sender
1588 @param context - sender context, to match reply w/ request
1589 @param bd_id - the bridge domain to set the flags for
1590 @param is_add - if non-zero, add the entry, else clear it
1591 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1592 @param mac_address - MAC address
1595 define bd_ip_mac_add_del
1606 /** \brief Set bridge domain ip to mac entry response
1607 @param context - sender context, to match reply w/ request
1608 @param retval - return code for the set bridge flags request
1610 define bd_ip_mac_add_del_reply
1616 /** \brief Add/Delete classification table request
1617 @param client_index - opaque cookie to identify the sender
1618 @param context - sender context, to match reply w/ request
1619 @param is_add- if non-zero add the table, else delete it
1620 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1621 @param nbuckets - number of buckets when adding a table
1622 @param memory_size - memory size when adding a table
1623 @param match_n_vectors - number of match vectors
1624 @param next_table_index - index of next table
1625 @param miss_next_index - index of miss table
1626 @param mask[] - match mask
1628 define classify_add_del_table
1637 u32 match_n_vectors;
1638 u32 next_table_index;
1639 u32 miss_next_index;
1643 /** \brief Add/Delete classification table response
1644 @param context - sender context, to match reply w/ request
1645 @param retval - return code for the table add/del requst
1646 @param new_table_index - for add, returned index of the new table
1647 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1648 @param match_n_vectors -for add, returned value of match_n_vectors in table
1650 define classify_add_del_table_reply
1654 u32 new_table_index;
1656 u32 match_n_vectors;
1659 /** \brief Classify add / del session request
1660 @param client_index - opaque cookie to identify the sender
1661 @param context - sender context, to match reply w/ request
1662 @param is_add - add session if non-zero, else delete
1663 @param table_index - index of the table to add/del the session, required
1664 @param hit_next_index - for add, hit_next_index of new session, required
1665 @param opaque_index - for add, opaque_index of new session
1666 @param advance -for add, advance value for session
1667 @param match[] - for add, match value for session, required
1669 define classify_add_del_session
1681 /** \brief Classify add / del session response
1682 @param context - sender context, to match reply w/ request
1683 @param retval - return code for the add/del session request
1685 define classify_add_del_session_reply
1691 /** \brief Set/unset the classification table for an interface request
1692 @param client_index - opaque cookie to identify the sender
1693 @param context - sender context, to match reply w/ request
1694 @param is_ipv6 - ipv6 if non-zero, else ipv4
1695 @param sw_if_index - interface to associate with the table
1696 @param table_index - index of the table, if ~0 unset the table
1698 define classify_set_interface_ip_table
1704 u32 table_index; /* ~0 => off */
1707 /** \brief Set/unset interface classification table response
1708 @param context - sender context, to match reply w/ request
1709 @param retval - return code
1711 define classify_set_interface_ip_table_reply
1717 /** \brief Set/unset l2 classification tables for an interface request
1718 @param client_index - opaque cookie to identify the sender
1719 @param context - sender context, to match reply w/ request
1720 @param sw_if_index - interface to set/unset tables for
1721 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1722 @param ip6_table_index - ip6 index
1723 @param other_table_index - other index
1725 define classify_set_interface_l2_tables
1731 u32 ip4_table_index;
1732 u32 ip6_table_index;
1733 u32 other_table_index;
1737 /** \brief Set/unset l2 classification tables for an interface response
1738 @param context - sender context, to match reply w/ request
1739 @param retval - return code for the request
1741 define classify_set_interface_l2_tables_reply
1747 /** \brief Get node index using name request
1748 @param client_index - opaque cookie to identify the sender
1749 @param context - sender context, to match reply w/ request
1750 @param node_name[] - name of the node
1752 define get_node_index
1759 /** \brief Get node index using name request
1760 @param context - sender context, to match reply w/ request
1761 @param retval - return code for the request
1762 @param node_index - index of the desired node if found, else ~0
1764 define get_node_index_reply
1771 /** \brief Set the next node for a given node request
1772 @param client_index - opaque cookie to identify the sender
1773 @param context - sender context, to match reply w/ request
1774 @param node_name[] - node to add the next node to
1775 @param next_name[] - node to add as the next node
1777 define add_node_next
1785 /** \brief IP Set the next node for a given node response
1786 @param context - sender context, to match reply w/ request
1787 @param retval - return code for the add next node request
1788 @param next_index - the index of the next node if success, else ~0
1790 define add_node_next_reply
1797 /** \brief DHCP Proxy config 2 add / del request
1798 @param client_index - opaque cookie to identify the sender
1799 @param context - sender context, to match reply w/ request
1800 @param rx_vrf_id - receive vrf id
1801 @param server_vrf_id - server vrf id
1802 @param if_ipv6 - ipv6 if non-zero, else ipv4
1803 @param is_add - add the config if non-zero, else delete
1804 @param insert_circuit_id - option82 suboption 1 fib number
1805 @param dhcp_server[] - server address
1806 @param dhcp_src_address[] - <fix this, need details>
1808 define dhcp_proxy_config_2
1816 u8 insert_circuit_id;
1818 u8 dhcp_src_address[16];
1821 /** \brief DHCP Proxy config 2 add / del response
1822 @param context - sender context, to match reply w/ request
1823 @param retval - return code for request
1825 define dhcp_proxy_config_2_reply
1831 /** \brief l2tpv3 tunnel interface create request
1832 @param client_index - opaque cookie to identify the sender
1833 @param context - sender context, to match reply w/ request
1834 @param client_address - remote client tunnel ip address
1835 @param client_address - local tunnel ip address
1836 @param is_ipv6 - ipv6 if non-zero, else ipv4
1837 @param local_session_id - local tunnel session id
1838 @param remote_session_id - remote tunnel session id
1839 @param local_cookie - local tunnel cookie
1840 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1841 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1843 define l2tpv3_create_tunnel
1847 u8 client_address[16];
1850 u32 local_session_id;
1851 u32 remote_session_id;
1854 u8 l2_sublayer_present;
1858 /** \brief l2tpv3 tunnel interface create response
1859 @param context - sender context, to match reply w/ request
1860 @param retval - return code for the request
1861 @param sw_if_index - index of the new tunnel interface
1863 define l2tpv3_create_tunnel_reply
1870 define l2tpv3_set_tunnel_cookies
1875 u64 new_local_cookie;
1876 u64 new_remote_cookie;
1879 /** \brief L2TP tunnel set cookies response
1880 @param context - sender context, to match reply w/ request
1881 @param retval - return code for the request
1883 define l2tpv3_set_tunnel_cookies_reply
1889 define sw_if_l2tpv3_tunnel_details
1893 u8 interface_name[64];
1894 u8 client_address[16];
1896 u32 local_session_id;
1897 u32 remote_session_id;
1898 u64 local_cookie[2];
1900 u8 l2_sublayer_present;
1903 define sw_if_l2tpv3_tunnel_dump
1909 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1910 @param client_index - opaque cookie to identify the sender
1911 @param context - sender context, to match reply w/ request
1913 define l2_fib_clear_table
1919 /** \brief L2 fib clear table response
1920 @param context - sender context, to match reply w/ request
1921 @param retval - return code for the request
1923 define l2_fib_clear_table_reply
1929 /** \brief L2 interface ethernet flow point filtering enable/disable request
1930 @param client_index - opaque cookie to identify the sender
1931 @param context - sender context, to match reply w/ request
1932 @param sw_if_index - interface to enable/disable filtering on
1933 @param enable_disable - if non-zero enable filtering, else disable
1935 define l2_interface_efp_filter
1943 /** \brief L2 interface ethernet flow point filtering response
1944 @param context - sender context, to match reply w/ request
1945 @param retval - return code for the request
1947 define l2_interface_efp_filter_reply
1953 define l2tpv3_interface_enable_disable
1961 define l2tpv3_interface_enable_disable_reply
1967 define l2tpv3_set_lookup_key
1971 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1975 define l2tpv3_set_lookup_key_reply
1981 define vxlan_add_del_tunnel
1990 u32 decap_next_index;
1994 define vxlan_add_del_tunnel_reply
2001 define vxlan_tunnel_dump
2008 define vxlan_tunnel_details
2015 u32 decap_next_index;
2020 define gre_add_del_tunnel
2031 define gre_add_del_tunnel_reply
2038 define gre_tunnel_dump
2045 define gre_tunnel_details
2055 /** \brief L2 interface vlan tag rewrite configure request
2056 @param client_index - opaque cookie to identify the sender
2057 @param context - sender context, to match reply w/ request
2058 @param sw_if_index - interface the operation is applied to
2059 @param vtr_op - Choose from l2_vtr_op_t enum values
2060 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2061 @param tag1 - Needed for any push or translate vtr op
2062 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2064 define l2_interface_vlan_tag_rewrite
2070 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2071 u32 tag1; // first pushed tag
2072 u32 tag2; // second pushed tag
2075 /** \brief L2 interface vlan tag rewrite response
2076 @param context - sender context, to match reply w/ request
2077 @param retval - return code for the request
2079 define l2_interface_vlan_tag_rewrite_reply
2085 /** \brief vhost-user interface create request
2086 @param client_index - opaque cookie to identify the sender
2087 @param is_server - our side is socket server
2088 @param sock_filename - unix socket filename, used to speak with frontend
2089 @param use_custom_mac - enable or disable the use of the provided hardware address
2090 @param mac_address - hardware address to use if 'use_custom_mac' is set
2092 define create_vhost_user_if
2097 u8 sock_filename[256];
2099 u32 custom_dev_instance;
2104 /** \brief vhost-user interface create response
2105 @param context - sender context, to match reply w/ request
2106 @param retval - return code for the request
2107 @param sw_if_index - interface the operation is applied to
2109 define create_vhost_user_if_reply
2116 /** \brief vhost-user interface modify request
2117 @param client_index - opaque cookie to identify the sender
2118 @param is_server - our side is socket server
2119 @param sock_filename - unix socket filename, used to speak with frontend
2121 define modify_vhost_user_if
2127 u8 sock_filename[256];
2129 u32 custom_dev_instance;
2132 /** \brief vhost-user interface modify response
2133 @param context - sender context, to match reply w/ request
2134 @param retval - return code for the request
2136 define modify_vhost_user_if_reply
2142 /** \brief vhost-user interface delete request
2143 @param client_index - opaque cookie to identify the sender
2145 define delete_vhost_user_if
2152 /** \brief vhost-user interface delete response
2153 @param context - sender context, to match reply w/ request
2154 @param retval - return code for the request
2156 define delete_vhost_user_if_reply
2169 /* These fields map directly onto the subif template */
2173 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2176 u8 outer_vlan_id_any;
2177 u8 inner_vlan_id_any;
2182 define create_subif_reply
2189 /** \brief show version
2190 @param client_index - opaque cookie to identify the sender
2191 @param context - sender context, to match reply w/ request
2199 /** \brief show version response
2200 @param context - sender context, to match reply w/ request
2201 @param retval - return code for the request
2202 @param program - name of the program (vpe)
2203 @param version - version of the program
2204 @param build_directory - root of the workspace where the program was built
2206 define show_version_reply
2213 u8 build_directory[256];
2216 /** \brief Vhost-user interface details structure (fix this)
2217 @param sw_if_index - index of the interface
2218 @param interface_name - name of interface
2219 @param virtio_net_hdr_sz - net header size
2220 @param features - interface features
2221 @param is_server - vhost-user server socket
2222 @param sock_filename - socket filename
2223 @param num_regions - number of used memory regions
2225 define sw_interface_vhost_user_details
2229 u8 interface_name[64];
2230 u32 virtio_net_hdr_sz;
2233 u8 sock_filename[256];
2239 define sw_interface_vhost_user_dump
2245 define ip_address_details
2253 define ip_address_dump
2274 /** \brief l2 fib table entry structure
2275 @param bd_id - the l2 fib / bridge domain table id
2276 @param mac - the entry's mac address
2277 @param sw_if_index - index of the interface
2278 @param static_mac - the entry is statically configured.
2279 @param filter_mac - the entry is a mac filter entry.
2280 @param bvi_mac - the mac address is a bridge virtual interface
2282 define l2_fib_table_entry
2293 /** \brief Dump l2 fib (aka bridge domain) table
2294 @param client_index - opaque cookie to identify the sender
2295 @param bd_id - the l2 fib / bridge domain table identifier
2297 define l2_fib_table_dump
2304 define vxlan_gpe_add_del_tunnel
2318 define vxlan_gpe_add_del_tunnel_reply
2325 define vxlan_gpe_tunnel_dump
2332 define vxlan_gpe_tunnel_details
2345 /** \brief add or delete locator_set
2346 @param client_index - opaque cookie to identify the sender
2347 @param context - sender context, to match reply w/ request
2348 @param is_add - add address if non-zero, else delete
2349 @param locator_set_name - locator name
2350 @param locator_num - number of locators
2351 @param locators - Lisp locator data
2353 define lisp_add_del_locator_set
2358 u8 locator_set_name[64];
2360 u8 locators[locator_num];
2363 /** \brief Reply for locator_set add/del
2364 @param context - returned sender context, to match reply w/ request
2365 @param retval - return code
2366 @param ls_index - locator set index
2368 define lisp_add_del_locator_set_reply
2375 /** \brief add or delete locator for locator_set
2376 @param client_index - opaque cookie to identify the sender
2377 @param context - sender context, to match reply w/ request
2378 @param is_add - add address if non-zero, else delete
2379 @param locator_set_name - name of locator_set to add/del locator
2380 @param sw_if_index - index of the interface
2381 @param priority - priority of the lisp locator
2382 @param weight - weight of the lisp locator
2384 define lisp_add_del_locator
2389 u8 locator_set_name[64];
2395 /** \brief Reply for locator add/del
2396 @param context - returned sender context, to match reply w/ request
2397 @param retval - return code
2399 define lisp_add_del_locator_reply
2405 /** \brief add or delete lisp eid-table
2406 @param client_index - opaque cookie to identify the sender
2407 @param context - sender context, to match reply w/ request
2408 @param is_add - add address if non-zero, else delete
2413 @param eid - EID can be ip4, ip6 or mac
2414 @param prefix_len - prefix len
2415 @param locator_set_name - name of locator_set to add/del eid-table
2416 @param vni - virtual network instance
2418 define lisp_add_del_local_eid
2426 u8 locator_set_name[64];
2430 /** \brief Reply for local_eid add/del
2431 @param context - returned sender context, to match reply w/ request
2432 @param retval - return code
2434 define lisp_add_del_local_eid_reply
2440 /** \brief add or delete lisp gpe tunnel
2441 @param client_index - opaque cookie to identify the sender
2442 @param context - sender context, to match reply w/ request
2443 @param is_add - add address if non-zero, else delete
2448 @param rmt_eid - remote eid
2449 @param lcl_eid - local eid
2450 @param rmt_len - remote prefix len
2451 @param lcl_len - local prefix len
2452 @param vni - virtual network identifier
2453 @param dp_table - vrf/bridge domain id
2454 @param loc_num - number of locators
2455 @param lcl_locs - array of local locators
2456 @param rmt_locs - array of remote locators
2457 @param action - negative action when 0 locators configured
2459 define lisp_gpe_add_del_fwd_entry
2472 u8 lcl_locs[loc_num];
2473 u8 rmt_locs[loc_num];
2477 /** \brief Reply for gpe_fwd_entry add/del
2478 @param context - returned sender context, to match reply w/ request
2479 @param retval - return code
2481 define lisp_gpe_add_del_fwd_entry_reply
2487 /** \brief add or delete map-resolver
2488 @param client_index - opaque cookie to identify the sender
2489 @param context - sender context, to match reply w/ request
2490 @param is_add - add address if non-zero, else delete
2491 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2492 @param ip_address - array of address bytes
2494 define lisp_add_del_map_resolver
2503 /** \brief Reply for map_resolver add/del
2504 @param context - returned sender context, to match reply w/ request
2505 @param retval - return code
2507 define lisp_add_del_map_resolver_reply
2513 /** \brief enable or disable lisp-gpe protocol
2514 @param client_index - opaque cookie to identify the sender
2515 @param context - sender context, to match reply w/ request
2516 @param is_en - enable protocol if non-zero, else disable
2518 define lisp_gpe_enable_disable
2525 /** \brief Reply for gpe enable/disable
2526 @param context - returned sender context, to match reply w/ request
2527 @param retval - return code
2529 define lisp_gpe_enable_disable_reply
2535 /** \brief enable or disable LISP feature
2536 @param client_index - opaque cookie to identify the sender
2537 @param context - sender context, to match reply w/ request
2538 @param is_en - enable protocol if non-zero, else disable
2540 define lisp_enable_disable
2547 /** \brief Reply for gpe enable/disable
2548 @param context - returned sender context, to match reply w/ request
2549 @param retval - return code
2551 define lisp_enable_disable_reply
2557 /** \brief add or delete gpe_iface
2558 @param client_index - opaque cookie to identify the sender
2559 @param context - sender context, to match reply w/ request
2560 @param is_add - add address if non-zero, else delete
2562 define lisp_gpe_add_del_iface
2572 /** \brief Reply for gpe_iface add/del
2573 @param context - returned sender context, to match reply w/ request
2574 @param retval - return code
2576 define lisp_gpe_add_del_iface_reply
2582 /** \brief configure or disable LISP PITR node
2583 @param client_index - opaque cookie to identify the sender
2584 @param context - sender context, to match reply w/ request
2585 @param ls_name - locator set name
2586 @param is_add - add locator set if non-zero, else disable pitr
2588 define lisp_pitr_set_locator_set
2596 /** \brief Reply for lisp_pitr_set_locator_set
2597 @param context - returned sender context, to match reply w/ request
2598 @param retval - return code
2600 define lisp_pitr_set_locator_set_reply
2606 /** \brief add or delete remote static mapping
2607 @param client_index - opaque cookie to identify the sender
2608 @param context - sender context, to match reply w/ request
2609 @param is_add - add address if non-zero, else delete
2610 @param is_src_dst - flag indicating src/dst based routing policy
2611 @param del_all - if set, delete all remote mappings
2612 @param vni - virtual network instance
2613 @param action - negative map-reply action
2618 @param deid - dst EID
2619 @param seid - src EID, valid only if is_src_dst is enabled
2620 @param rloc_num - number of remote locators
2621 @param rlocs - remote locator data
2623 define lisp_add_del_remote_mapping
2641 /** \brief Reply for lisp_add_del_remote_mapping
2642 @param context - returned sender context, to match reply w/ request
2643 @param retval - return code
2645 define lisp_add_del_remote_mapping_reply
2651 /** \brief add or delete LISP adjacency adjacency
2652 @param client_index - opaque cookie to identify the sender
2653 @param context - sender context, to match reply w/ request
2654 @param is_add - add address if non-zero, else delete
2655 @param vni - virtual network instance
2660 @param deid - destination EID
2661 @param seid - source EID
2663 define lisp_add_del_adjacency
2676 /** \brief Reply for lisp_add_del_adjacency
2677 @param context - returned sender context, to match reply w/ request
2678 @param retval - return code
2680 define lisp_add_del_adjacency_reply
2686 /** \brief add or delete map request itr rlocs
2687 @param client_index - opaque cookie to identify the sender
2688 @param context - sender context, to match reply w/ request
2689 @param is_add - add address if non-zero, else delete
2690 @param locator_set_name - locator set name
2692 define lisp_add_del_map_request_itr_rlocs
2697 u8 locator_set_name[64];
2700 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2701 @param context - returned sender context, to match reply w/ request
2702 @param retval - return code
2705 define lisp_add_del_map_request_itr_rlocs_reply
2711 /** \brief map/unmap vni/bd_index to vrf
2712 @param client_index - opaque cookie to identify the sender
2713 @param context - sender context, to match reply w/ request
2714 @param is_add - add or delete mapping
2715 @param dp_table - virtual network id/bridge domain index
2718 define lisp_eid_table_add_del_map
2728 /** \brief Reply for lisp_eid_table_add_del_map
2729 @param context - returned sender context, to match reply w/ request
2730 @param retval - return code
2732 define lisp_eid_table_add_del_map_reply
2738 /** \brief Request for map lisp locator status
2739 @param client_index - opaque cookie to identify the sender
2740 @param context - sender context, to match reply w/ request
2741 @param locator_set_index - index of locator_set
2742 @param filter - filter type;
2748 define lisp_locator_dump
2752 u32 locator_set_index;
2756 /** \brief LISP locator_set status
2757 @param local - if is set, then locator is local
2758 @param locator_set_name - name of the locator_set
2759 @param sw_if_index - sw_if_index of the locator
2760 @param priority - locator priority
2761 @param weight - locator weight
2763 define lisp_locator_details
2774 /** \brief LISP locator_set status
2775 @param locator_set_name - name of the locator_set
2776 @param local - if is set, then locator_set is local
2777 @param locator_count - number of locator this stats block includes
2778 @param locator - locator data
2780 define lisp_locator_set_details
2784 u32 locator_set_index;
2785 u8 locator_set_name[64];
2788 /** \brief Request for locator_set summary status
2789 @param client_index - opaque cookie to identify the sender
2790 @param context - sender context, to match reply w/ request
2791 @param filter - filter type;
2794 1: local locator_set
2795 2: remote locator_set
2797 define lisp_locator_set_dump
2804 /** \brief Dump lisp eid-table
2805 @param client_index - opaque cookie to identify the sender
2806 @param context - sender context, to match reply w/ request
2807 @param locator_set_index - index of locator_set, if ~0 then the mapping
2809 @param action - negative map request action
2810 @param is_local - local if non-zero, else remote
2815 @param eid - EID can be ip4, ip6 or mac
2816 @param prefix_len - prefix len
2817 @param vni - virtual network instance
2818 @param ttl - time to live
2819 @param authoritative - authoritative
2822 define lisp_eid_table_details
2825 u32 locator_set_index;
2836 /** \brief Request for eid table summary status
2837 @param client_index - opaque cookie to identify the sender
2838 @param context - sender context, to match reply w/ request
2839 @param eid_set - if non-zero request info about specific mapping
2840 @param vni - virtual network instance; valid only if eid_set != 0
2841 @param prefix_length - prefix length if EID is IP address;
2842 valid only if eid_set != 0
2843 @param eid_type - EID type; valid only if eid_set != 0
2847 2: EID is ethernet address
2848 @param eid - endpoint identifier
2849 @param filter - filter type;
2855 define lisp_eid_table_dump
2867 /** \brief Shows relationship between vni and vrf/bd
2868 @param dp_table - VRF index or bridge domain index
2869 @param vni - vitual network instance
2871 define lisp_eid_table_map_details
2878 /** \brief Request for lisp_eid_table_map_details
2879 @param client_index - opaque cookie to identify the sender
2880 @param context - sender context, to match reply w/ request
2881 @param is_l2 - if set dump vni/bd mappings else vni/vrf
2883 define lisp_eid_table_map_dump
2890 /** \brief Dumps all VNIs used in mappings
2891 @param client_index - opaque cookie to identify the sender
2892 @param context - sender context, to match reply w/ request
2894 define lisp_eid_table_vni_dump
2900 /** \brief reply to lisp_eid_table_vni_dump
2901 @param client_index - opaque cookie to identify the sender
2902 @param context - sender context, to match reply w/ request
2903 @param vni - virtual network instance
2905 define lisp_eid_table_vni_details
2912 define lisp_gpe_tunnel_details
2918 u8 destination_ip[16];
2930 /** \brief Request for gpe tunnel summary status
2931 @param client_index - opaque cookie to identify the sender
2932 @param context - sender context, to match reply w/ request
2934 define lisp_gpe_tunnel_dump
2940 /** \brief LISP map resolver status
2941 @param locator_set_name - name of the locator_set
2942 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2943 @param ip_address - array of address bytes
2945 define lisp_map_resolver_details
2952 /** \brief Request for map resolver summary status
2953 @param client_index - opaque cookie to identify the sender
2954 @param context - sender context, to match reply w/ request
2956 define lisp_map_resolver_dump
2962 /** \brief Request for lisp-gpe protocol status
2963 @param client_index - opaque cookie to identify the sender
2964 @param context - sender context, to match reply w/ request
2966 define show_lisp_status
2972 /** \brief Status of lisp, enable or disable
2973 @param context - sender context, to match reply w/ request
2974 @param feature_status - lisp enable if non-zero, else disable
2975 @param gpe_status - lisp enable if non-zero, else disable
2977 define show_lisp_status_reply
2985 /** \brief Get LISP map request itr rlocs status
2986 @param context - sender context, to match reply w/ request
2987 @param locator_set_name - name of the locator_set
2989 define lisp_get_map_request_itr_rlocs
2995 /** \brief Request for map request itr rlocs summary status
2997 define lisp_get_map_request_itr_rlocs_reply
3001 u8 locator_set_name[64];
3004 /** \brief Request for lisp pitr status
3005 @param client_index - opaque cookie to identify the sender
3006 @param context - sender context, to match reply w/ request
3008 define show_lisp_pitr
3014 /** \brief Status of lisp pitr, enable or disable
3015 @param context - sender context, to match reply w/ request
3016 @param status - lisp pitr enable if non-zero, else disable
3017 @param locator_set_name - name of the locator_set
3019 define show_lisp_pitr_reply
3024 u8 locator_set_name[64];
3027 /* Gross kludge, DGMS */
3028 define interface_name_renumber
3033 u32 new_show_dev_instance;
3036 define interface_name_renumber_reply
3042 /** \brief Register for ip4 arp resolution events
3043 @param client_index - opaque cookie to identify the sender
3044 @param context - sender context, to match reply w/ request
3045 @param enable_disable - 1 => register for events, 0 => cancel registration
3046 @param pid - sender's pid
3047 @param address - the exact ip4 address of interest
3049 define want_ip4_arp_events
3058 /** \brief Reply for interface events registration
3059 @param context - returned sender context, to match reply w/ request
3060 @param retval - return code
3062 define want_ip4_arp_events_reply
3068 /** \brief Tell client about an ip4 arp resolution event
3069 @param client_index - opaque cookie to identify the sender
3070 @param context - sender context, to match reply w/ request
3071 @param address - the exact ip4 address of interest
3072 @param pid - client pid registered to receive notification
3073 @param sw_if_index - interface which received ARP packet
3074 @param new_mac - the new mac address
3075 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3077 define ip4_arp_event
3088 /** \brief Register for ip6 nd resolution events
3089 @param client_index - opaque cookie to identify the sender
3090 @param context - sender context, to match reply w/ request
3091 @param enable_disable - 1 => register for events, 0 => cancel registration
3092 @param pid - sender's pid
3093 @param address - the exact ip6 address of interest
3095 define want_ip6_nd_events
3104 /** \brief Reply for ip6 nd resolution events registration
3105 @param context - returned sender context, to match reply w/ request
3106 @param retval - return code
3108 define want_ip6_nd_events_reply
3114 /** \brief Tell client about an ip6 nd resolution or mac/ip event
3115 @param client_index - opaque cookie to identify the sender
3116 @param context - sender context, to match reply w/ request
3117 @param pid - client pid registered to receive notification
3118 @param sw_if_index - interface which received ARP packet
3119 @param address - the exact ip6 address of interest
3120 @param new_mac - the new mac address
3121 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3134 /** \brief L2 bridge domain add or delete request
3135 @param client_index - opaque cookie to identify the sender
3136 @param context - sender context, to match reply w/ request
3137 @param bd_id - the bridge domain to create
3138 @param flood - enable/disable bcast/mcast flooding in the bd
3139 @param uu_flood - enable/disable uknown unicast flood in the bd
3140 @param forward - enable/disable forwarding on all interfaces in the bd
3141 @param learn - enable/disable learning on all interfaces in the bd
3142 @param arp_term - enable/disable arp termination in the bd
3143 @param is_add - add or delete flag
3145 define bridge_domain_add_del
3158 /** \brief L2 bridge domain add or delete response
3159 @param context - sender context, to match reply w/ request
3160 @param retval - return code for the set bridge flags request
3162 define bridge_domain_add_del_reply
3168 /** \brief L2 bridge domain request operational state details
3169 @param client_index - opaque cookie to identify the sender
3170 @param context - sender context, to match reply w/ request
3171 @param bd_id - the bridge domain id desired or ~0 to request all bds
3173 define bridge_domain_dump
3180 /** \brief L2 bridge domain operational state response
3181 @param bd_id - the bridge domain id
3182 @param flood - bcast/mcast flooding state on all interfaces in the bd
3183 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3184 @param forward - forwarding state on all interfaces in the bd
3185 @param learn - learning state on all interfaces in the bd
3186 @param arp_term - arp termination state on all interfaces in the bd
3187 @param n_sw_ifs - number of sw_if_index's in the domain
3189 define bridge_domain_details
3198 u32 bvi_sw_if_index;
3202 /** \brief L2 bridge domain sw interface operational state response
3203 @param bd_id - the bridge domain id
3204 @param sw_if_index - sw_if_index in the domain
3205 @param shg - split horizon group for the interface
3207 define bridge_domain_sw_if_details
3215 /** \brief DHCP Client config add / del request
3216 @param client_index - opaque cookie to identify the sender
3217 @param context - sender context, to match reply w/ request
3218 @param sw_if_index - index of the interface for DHCP client
3219 @param hostname - hostname
3220 @param is_add - add the config if non-zero, else delete
3221 @param want_dhcp_event - DHCP event sent to the sender
3222 via dhcp_compl_event API message if non-zero
3223 @param pid - sender's pid
3225 define dhcp_client_config
3236 /** \brief DHCP Client config response
3237 @param context - sender context, to match reply w/ request
3238 @param retval - return code for the request
3240 define dhcp_client_config_reply
3246 /** \brief Set/unset input ACL interface
3247 @param client_index - opaque cookie to identify the sender
3248 @param context - sender context, to match reply w/ request
3249 @param sw_if_index - interface to set/unset input ACL
3250 @param ip4_table_index - ip4 classify table index (~0 for skip)
3251 @param ip6_table_index - ip6 classify table index (~0 for skip)
3252 @param l2_table_index - l2 classify table index (~0 for skip)
3253 @param is_add - Set input ACL if non-zero, else unset
3254 Note: User is recommeneded to use just one valid table_index per call.
3255 (ip4_table_index, ip6_table_index, or l2_table_index)
3257 define input_acl_set_interface
3262 u32 ip4_table_index;
3263 u32 ip6_table_index;
3268 /** \brief Set/unset input ACL interface response
3269 @param context - sender context, to match reply w/ request
3270 @param retval - return code for the request
3272 define input_acl_set_interface_reply
3278 /** \brief IPsec: Add/delete Security Policy Database
3279 @param client_index - opaque cookie to identify the sender
3280 @param context - sender context, to match reply w/ request
3281 @param is_add - add SPD if non-zero, else delete
3282 @param spd_id - SPD instance id (control plane allocated)
3285 define ipsec_spd_add_del
3293 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3294 @param context - returned sender context, to match reply w/ request
3295 @param retval - return code
3298 define ipsec_spd_add_del_reply
3304 /** \brief IPsec: Add/delete SPD from interface
3306 @param client_index - opaque cookie to identify the sender
3307 @param context - sender context, to match reply w/ request
3308 @param is_add - add security mode if non-zero, else delete
3309 @param sw_if_index - index of the interface
3310 @param spd_id - SPD instance id to use for lookups
3314 define ipsec_interface_add_del_spd
3324 /** \brief Reply for IPsec: Add/delete SPD from interface
3325 @param context - returned sender context, to match reply w/ request
3326 @param retval - return code
3329 define ipsec_interface_add_del_spd_reply
3335 /** \brief IPsec: Add/delete Security Policy Database entry
3337 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3339 @param client_index - opaque cookie to identify the sender
3340 @param context - sender context, to match reply w/ request
3341 @param is_add - add SPD if non-zero, else delete
3342 @param spd_id - SPD instance id (control plane allocated)
3343 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3344 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3345 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3346 @param remote_address_start - start of remote address range to match
3347 @param remote_address_stop - end of remote address range to match
3348 @param local_address_start - start of local address range to match
3349 @param local_address_stop - end of local address range to match
3350 @param protocol - protocol type to match [0 means any]
3351 @param remote_port_start - start of remote port range to match ...
3352 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3353 @param local_port_start - start of local port range to match ...
3354 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3355 @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)
3356 @param sa_id - SAD instance id (control plane allocated)
3360 define ipsec_spd_add_del_entry
3373 u8 remote_address_start[16];
3374 u8 remote_address_stop[16];
3375 u8 local_address_start[16];
3376 u8 local_address_stop[16];
3380 u16 remote_port_start;
3381 u16 remote_port_stop;
3382 u16 local_port_start;
3383 u16 local_port_stop;
3390 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3391 @param context - returned sender context, to match reply w/ request
3392 @param retval - return code
3395 define ipsec_spd_add_del_entry_reply
3401 /** \brief IPsec: Add/delete Security Association Database entry
3402 @param client_index - opaque cookie to identify the sender
3403 @param context - sender context, to match reply w/ request
3404 @param is_add - add SAD entry if non-zero, else delete
3406 @param sad_id - sad id
3408 @param spi - security parameter index
3410 @param protocol - 0 = AH, 1 = ESP
3412 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3413 @param crypto_key_length - length of crypto_key in bytes
3414 @param crypto_key - crypto keying material
3416 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3417 @param integrity_key_length - length of integrity_key in bytes
3418 @param integrity_key - integrity keying material
3420 @param use_extended_sequence_number - use ESN when non-zero
3422 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3423 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3424 @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
3425 @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
3429 IPsec tunnel address copy mode (to support GDOI)
3432 define ipsec_sad_add_del_entry
3444 u8 crypto_algorithm;
3445 u8 crypto_key_length;
3448 u8 integrity_algorithm;
3449 u8 integrity_key_length;
3450 u8 integrity_key[128];
3452 u8 use_extended_sequence_number;
3456 u8 tunnel_src_address[16];
3457 u8 tunnel_dst_address[16];
3460 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3461 @param context - returned sender context, to match reply w/ request
3462 @param retval - return code
3465 define ipsec_sad_add_del_entry_reply
3471 /** \brief IPsec: Update Security Association keys
3472 @param client_index - opaque cookie to identify the sender
3473 @param context - sender context, to match reply w/ request
3475 @param sa_id - sa id
3477 @param crypto_key_length - length of crypto_key in bytes
3478 @param crypto_key - crypto keying material
3480 @param integrity_key_length - length of integrity_key in bytes
3481 @param integrity_key - integrity keying material
3484 define ipsec_sa_set_key
3491 u8 crypto_key_length;
3494 u8 integrity_key_length;
3495 u8 integrity_key[128];
3498 /** \brief Reply for IPsec: Update Security Association keys
3499 @param context - returned sender context, to match reply w/ request
3500 @param retval - return code
3503 define ipsec_sa_set_key_reply
3509 /** \brief IKEv2: Add/delete profile
3510 @param client_index - opaque cookie to identify the sender
3511 @param context - sender context, to match reply w/ request
3513 @param name - IKEv2 profile name
3514 @param is_add - Add IKEv2 profile if non-zero, else delete
3516 define ikev2_profile_add_del
3525 /** \brief Reply for IKEv2: Add/delete profile
3526 @param context - returned sender context, to match reply w/ request
3527 @param retval - return code
3529 define ikev2_profile_add_del_reply
3535 /** \brief IKEv2: Set IKEv2 profile authentication method
3536 @param client_index - opaque cookie to identify the sender
3537 @param context - sender context, to match reply w/ request
3539 @param name - IKEv2 profile name
3540 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3541 @param is_hex - Authentication data in hex format if non-zero, else string
3542 @param data_len - Authentication data length
3543 @param data - Authentication data (for rsa-sig cert file path)
3545 define ikev2_profile_set_auth
3557 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3558 @param context - returned sender context, to match reply w/ request
3559 @param retval - return code
3561 define ikev2_profile_set_auth_reply
3567 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3568 @param client_index - opaque cookie to identify the sender
3569 @param context - sender context, to match reply w/ request
3571 @param name - IKEv2 profile name
3572 @param is_local - Identification is local if non-zero, else remote
3573 @param id_type - Identification type
3574 @param data_len - Identification data length
3575 @param data - Identification data
3577 define ikev2_profile_set_id
3589 /** \brief Reply for IKEv2:
3590 @param context - returned sender context, to match reply w/ request
3591 @param retval - return code
3593 define ikev2_profile_set_id_reply
3599 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3600 @param client_index - opaque cookie to identify the sender
3601 @param context - sender context, to match reply w/ request
3603 @param name - IKEv2 profile name
3604 @param is_local - Traffic selector is local if non-zero, else remote
3605 @param proto - Traffic selector IP protocol (if zero not relevant)
3606 @param start_port - The smallest port number allowed by traffic selector
3607 @param end_port - The largest port number allowed by traffic selector
3608 @param start_addr - The smallest address included in traffic selector
3609 @param end_addr - The largest address included in traffic selector
3611 define ikev2_profile_set_ts
3625 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3626 @param context - returned sender context, to match reply w/ request
3627 @param retval - return code
3629 define ikev2_profile_set_ts_reply
3635 /** \brief IKEv2: Set IKEv2 local RSA private key
3636 @param client_index - opaque cookie to identify the sender
3637 @param context - sender context, to match reply w/ request
3639 @param key_file - Key file absolute path
3641 define ikev2_set_local_key
3649 /** \brief Reply for IKEv2: Set IKEv2 local key
3650 @param context - returned sender context, to match reply w/ request
3651 @param retval - return code
3653 define ikev2_set_local_key_reply
3659 /** \brief Tell client about a DHCP completion event
3660 @param client_index - opaque cookie to identify the sender
3661 @param pid - client pid registered to receive notification
3662 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3663 @param host_address - Host IP address
3664 @param router_address - Router IP address
3665 @param host_mac - Host MAC address
3667 define dhcp_compl_event
3673 u8 host_address[16];
3674 u8 router_address[16];
3678 /** \brief Add MAP domains
3679 @param client_index - opaque cookie to identify the sender
3680 @param context - sender context, to match reply w/ request
3681 @param ip6_prefix - Rule IPv6 prefix
3682 @param ip4_prefix - Rule IPv4 prefix
3683 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3684 @param ip6_prefix_len - Rule IPv6 prefix length
3685 @param ip4_prefix_len - Rule IPv4 prefix length
3686 @param ea_bits_len - Embedded Address bits length
3687 @param psid_offset - Port Set Identifider (PSID) offset
3688 @param psid_length - PSID length
3689 @param is_translation - MAP-E / MAP-T
3692 define map_add_domain
3701 u8 ip6_src_prefix_len;
3709 /** \brief Reply for MAP domain add
3710 @param context - returned sender context, to match reply w/ request
3711 @param index - MAP domain index
3712 @param retval - return code
3714 define map_add_domain_reply
3721 /** \brief Delete MAP domain
3722 @param client_index - opaque cookie to identify the sender
3723 @param context - sender context, to match reply w/ request
3724 @param index - MAP Domain index
3726 define map_del_domain
3733 /** \brief Reply for MAP domain del
3734 @param context - returned sender context, to match reply w/ request
3735 @param retval - return code
3737 define map_del_domain_reply
3743 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3744 @param client_index - opaque cookie to identify the sender
3745 @param context - sender context, to match reply w/ request
3746 @param index - MAP Domain index
3747 @param is_add - If 1 add rule, if 0 delete rule
3748 @param ip6_dst - MAP CE IPv6 address
3749 @param psid - Rule PSID
3751 define map_add_del_rule
3761 /** \brief Reply for MAP rule add/del
3762 @param context - returned sender context, to match reply w/ request
3763 @param retval - return code
3765 define map_add_del_rule_reply
3771 /** \brief Get list of map domains
3772 @param client_index - opaque cookie to identify the sender
3774 define map_domain_dump
3780 define map_domain_details
3798 define map_rule_dump
3805 define map_rule_details
3812 /** \brief Request for a single block of summary stats
3813 @param client_index - opaque cookie to identify the sender
3814 @param context - sender context, to match reply w/ request
3816 define map_summary_stats
3822 /** \brief Reply for map_summary_stats request
3823 @param context - sender context, to match reply w/ request
3824 @param retval - return code for request
3825 @param total_bindings -
3827 @param total_ip4_fragments -
3828 @param total_security_check -
3830 define map_summary_stats_reply
3837 u64 total_ip4_fragments;
3838 u64 total_security_check[2];
3841 /** \brief cop: enable/disable junk filtration features on an interface
3842 @param client_index - opaque cookie to identify the sender
3843 @param context - sender context, to match reply w/ request
3844 @param sw_if_inded - desired interface
3845 @param enable_disable - 1 => enable, 0 => disable
3848 define cop_interface_enable_disable
3856 /** \brief cop: interface enable/disable junk filtration reply
3857 @param context - returned sender context, to match reply w/ request
3858 @param retval - return code
3861 define cop_interface_enable_disable_reply
3867 /** \brief cop: enable/disable whitelist filtration features on an interface
3868 Note: the supplied fib_id must match in order to remove the feature!
3870 @param client_index - opaque cookie to identify the sender
3871 @param context - sender context, to match reply w/ request
3872 @param sw_if_index - interface handle, physical interfaces only
3873 @param fib_id - fib identifier for the whitelist / blacklist fib
3874 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3875 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3876 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3879 define cop_whitelist_enable_disable
3890 /** \brief cop: interface enable/disable junk filtration reply
3891 @param context - returned sender context, to match reply w/ request
3892 @param retval - return code
3895 define cop_whitelist_enable_disable_reply
3901 /** \brief get_node_graph - get a copy of the vpp node graph
3902 including the current set of graph arcs.
3904 @param client_index - opaque cookie to identify the sender
3905 @param context - sender context, to match reply w/ request
3908 define get_node_graph
3914 /** \brief get_node_graph_reply
3915 @param context - returned sender context, to match reply w/ request
3916 @param retval - return code
3917 @param reply_in_shmem - result from vlib_node_serialize, in shared
3918 memory. Process with vlib_node_unserialize, remember to switch
3919 heaps and free the result.
3922 define get_node_graph_reply
3929 /** \brief Clear interface statistics
3930 @param client_index - opaque cookie to identify the sender
3931 @param context - sender context, to match reply w/ request
3932 @param sw_if_index - index of the interface to clear statistics
3934 define sw_interface_clear_stats
3941 /** \brief Reply to sw_interface_clear_stats
3942 @param context - sender context which was passed in the request
3943 @param retval - return code of the set flags request
3945 define sw_interface_clear_stats_reply
3951 /** \brief IOAM Trace : Set TRACE profile
3952 @param id - profile id
3953 @param trace_type - Trace type
3954 @param trace_num_elt - Number of nodes in trace path
3955 @param trace_ppc - Trace PPC (none/encap/decap)
3956 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3957 @param trace_app_data - Trace application data, can be any 4 bytes
3958 @param pow_enable - Proof of Work enabled or not flag
3959 @param node_id - Id of this node
3961 define trace_profile_add
3975 /** \brief Trace profile add / del response
3976 @param context - sender context, to match reply w/ request
3977 @param retval - return value for request
3979 define trace_profile_add_reply
3985 /** \brief IOAM Trace enable trace profile for a flow
3986 @param id - id of the trace profile to be applied
3987 @param dest_ipv6 - Destination IPv6 address
3988 @param prefix_length - prefix mask
3989 @param vrf_id - VRF ID
3990 @param trace_op - Trace operation (add/mod/del)
3991 @param enable - apply/remove the trace profile for the flow
3993 define trace_profile_apply
4005 /** \brief Trace profile apply response
4006 @param context - sender context, to match reply w/ request
4007 @param retval - return value for request
4009 define trace_profile_apply_reply
4015 /** \brief Delete Trace Profile
4016 @param client_index - opaque cookie to identify the sender
4017 @param context - sender context, to match reply w/ request
4018 @param index - MAP Domain index
4020 define trace_profile_del
4027 /** \brief Trace profile add / del response
4028 @param context - sender context, to match reply w/ request
4029 @param retval - return value for request
4031 define trace_profile_del_reply
4037 /** \brief Create host-interface
4038 @param client_index - opaque cookie to identify the sender
4039 @param context - sender context, to match reply w/ request
4040 @param host_if_name - interface name
4041 @param hw_addr - interface MAC
4042 @param use_random_hw_addr - use random generated MAC
4044 define af_packet_create
4049 u8 host_if_name[64];
4051 u8 use_random_hw_addr;
4054 /** \brief Create host-interface response
4055 @param context - sender context, to match reply w/ request
4056 @param retval - return value for request
4058 define af_packet_create_reply
4065 /** \brief Delete host-interface
4066 @param client_index - opaque cookie to identify the sender
4067 @param context - sender context, to match reply w/ request
4068 @param host_if_name - interface name
4070 define af_packet_delete
4075 u8 host_if_name[64];
4078 /** \brief Delete host-interface response
4079 @param context - sender context, to match reply w/ request
4080 @param retval - return value for request
4082 define af_packet_delete_reply
4088 /** \brief Add/del policer
4089 @param client_index - opaque cookie to identify the sender
4090 @param context - sender context, to match reply w/ request
4091 @param is_add - add policer if non-zero, else delete
4092 @param name - policer name
4095 @param cb - Committed Burst
4096 @param eb - Excess or Peak Burst
4097 @param rate_type - rate type
4098 @param round_type - rounding type
4099 @param type - policer algorithm
4100 @param color_aware - 0=color-blind, 1=color-aware
4101 @param conform_action_type - conform action type
4102 @param conform_dscp - DSCP for conform mar-and-transmit action
4103 @param exceed_action_type - exceed action type
4104 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4105 @param violate_action_type - violate action type
4106 @param violate_dscp - DSCP for violate mar-and-transmit action
4108 define policer_add_del
4123 u8 conform_action_type;
4125 u8 exceed_action_type;
4127 u8 violate_action_type;
4131 /** \brief Add/del policer response
4132 @param context - sender context, to match reply w/ request
4133 @param retval - return value for request
4134 @param policer_index - for add, returned index of the new policer
4136 define policer_add_del_reply
4143 /** \brief Get list of policers
4144 @param client_index - opaque cookie to identify the sender
4145 @param context - sender context, to match reply w/ request
4146 @param match_name_valid - if 0 request all policers otherwise use match_name
4147 @param match_name - policer name
4154 u8 match_name_valid;
4158 /** \brief Policer operational state response.
4159 @param context - sender context, to match reply w/ request
4160 @param name - policer name
4163 @param cb - Committed Burst
4164 @param eb - Excess or Peak Burst
4165 @param rate_type - rate type
4166 @param round_type - rounding type
4167 @param type - policer algorithm
4168 @param conform_action_type - conform action type
4169 @param conform_dscp - DSCP for conform mar-and-transmit action
4170 @param exceed_action_type - exceed action type
4171 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4172 @param violate_action_type - violate action type
4173 @param violate_dscp - DSCP for violate mar-and-transmit action
4174 @param single_rate - 1 = single rate policer, 0 = two rate policer
4175 @param color_aware - for hierarchical policing
4176 @param scale - power-of-2 shift amount for lower rates
4177 @param cir_tokens_per_period - number of tokens for each period
4178 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4179 @param current_limit - current limit
4180 @param current_bucket - current bucket
4181 @param extended_limit - extended limit
4182 @param extended_bucket - extended bucket
4183 @param last_update_time - last update time
4185 define policer_details
4197 u8 conform_action_type;
4199 u8 exceed_action_type;
4201 u8 violate_action_type;
4206 u32 cir_tokens_per_period;
4207 u32 pir_tokens_per_period;
4211 u32 extended_bucket;
4212 u64 last_update_time;
4215 /** \brief Set/unset policer classify interface
4216 @param client_index - opaque cookie to identify the sender
4217 @param context - sender context, to match reply w/ request
4218 @param sw_if_index - interface to set/unset policer classify
4219 @param ip4_table_index - ip4 classify table index (~0 for skip)
4220 @param ip6_table_index - ip6 classify table index (~0 for skip)
4221 @param l2_table_index - l2 classify table index (~0 for skip)
4222 @param is_add - Set if non-zero, else unset
4223 Note: User is recommeneded to use just one valid table_index per call.
4224 (ip4_table_index, ip6_table_index, or l2_table_index)
4226 define policer_classify_set_interface
4231 u32 ip4_table_index;
4232 u32 ip6_table_index;
4237 /** \brief Set/unset policer classify interface response
4238 @param context - sender context, to match reply w/ request
4239 @param retval - return value for request
4241 define policer_classify_set_interface_reply
4247 /** \brief Get list of policer classify interfaces and tables
4248 @param client_index - opaque cookie to identify the sender
4249 @param context - sender context, to match reply w/ request
4250 @param type - classify table type
4252 define policer_classify_dump
4259 /** \brief Policer iclassify operational state response.
4260 @param context - sender context, to match reply w/ request
4261 @param sw_if_index - software interface index
4262 @param table_index - classify table index
4264 define policer_classify_details
4271 /** \brief Create netmap
4272 @param client_index - opaque cookie to identify the sender
4273 @param context - sender context, to match reply w/ request
4274 @param netmap_if_name - interface name
4275 @param hw_addr - interface MAC
4276 @param use_random_hw_addr - use random generated MAC
4277 @param is_pipe - is pipe
4278 @param is_master - 0=slave, 1=master
4280 define netmap_create
4285 u8 netmap_if_name[64];
4287 u8 use_random_hw_addr;
4292 /** \brief Create netmap response
4293 @param context - sender context, to match reply w/ request
4294 @param retval - return value for request
4296 define netmap_create_reply
4302 /** \brief Delete netmap
4303 @param client_index - opaque cookie to identify the sender
4304 @param context - sender context, to match reply w/ request
4305 @param netmap_if_name - interface name
4307 define netmap_delete
4312 u8 netmap_if_name[64];
4315 /** \brief Delete netmap response
4316 @param context - sender context, to match reply w/ request
4317 @param retval - return value for request
4319 define netmap_delete_reply
4325 /** \brief Dump mpls gre tunnel table
4326 @param client_index - opaque cookie to identify the sender
4327 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4329 define mpls_gre_tunnel_dump
4336 /** \brief mpls gre tunnel operational state response
4337 @param tunnel_index - gre tunnel identifier
4338 @param intfc_address - interface ipv4 addr
4339 @param mask_width - interface ipv4 addr mask
4340 @param hw_if_index - interface id
4342 @param tunnel_src - tunnel source ipv4 addr
4343 @param tunnel_dst - tunnel destination ipv4 addr
4344 @param outer_fib_index - gre tunnel identifier
4345 @param encap_index - reference to mpls label table
4346 @param nlabels - number of resolved labels
4347 @param labels - resolved labels
4349 define mpls_gre_tunnel_details
4355 u32 inner_fib_index;
4362 u32 outer_fib_index;
4364 u32 labels[nlabels];
4367 /** \brief Dump mpls eth tunnel table
4368 @param client_index - opaque cookie to identify the sender
4369 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
4371 define mpls_eth_tunnel_dump
4378 /** \brief mpls eth tunnel operational state response
4379 @param tunnel_index - eth tunnel identifier
4380 @param intfc_address - interface ipv4 addr
4381 @param mask_width - interface ipv4 addr mask
4382 @param hw_if_index - interface id
4384 @param tunnel_dst_mac -
4385 @param tx_sw_if_index -
4386 @param encap_index - reference to mpls label table
4387 @param nlabels - number of resolved labels
4388 @param labels - resolved labels
4390 define mpls_eth_tunnel_details
4396 u32 inner_fib_index;
4401 u8 tunnel_dst_mac[6];
4404 u32 labels[nlabels];
4407 /** \brief Dump mpls fib table
4408 @param client_index - opaque cookie to identify the sender
4409 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4411 define mpls_fib_encap_dump
4417 /** \brief mpls fib encap table response
4418 @param fib_index - fib table id
4419 @param dest - destination ipv4 addr
4421 @param entry_index - reference to mpls label table
4422 @param nlabels - number of resolved labels
4423 @param labels - resolved labels
4425 define mpls_fib_encap_details
4434 u32 labels[nlabels];
4437 /** \brief Dump mpls fib decap table
4438 @param client_index - opaque cookie to identify the sender
4439 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4441 define mpls_fib_decap_dump
4447 /** \brief mpls fib decap table response
4448 @param fib_index - fib table id
4449 @param entry_index - reference to mpls label table
4450 @param dest - destination ipv4 addr
4452 @param label - mpls labels
4453 @param rx_table_id - rx fib id
4454 @param tx_table_id - tx fib id
4457 define mpls_fib_decap_details
4471 /** \brief Classify get table IDs request
4472 @param client_index - opaque cookie to identify the sender
4473 @param context - sender context, to match reply w/ request
4475 define classify_table_ids
4481 /** \brief Reply for classify get table IDs request
4482 @param context - sender context which was passed in the request
4483 @param count - number of ids returned in response
4484 @param ids - array of classify table ids
4486 define classify_table_ids_reply
4494 /** \brief Classify table ids by interface index request
4495 @param client_index - opaque cookie to identify the sender
4496 @param context - sender context, to match reply w/ request
4497 @param sw_if_index - index of the interface
4499 define classify_table_by_interface
4506 /** \brief Reply for classify table id by interface index request
4507 @param context - sender context which was passed in the request
4508 @param count - number of ids returned in response
4509 @param sw_if_index - index of the interface
4510 @param l2_table_id - l2 classify table index
4511 @param ip4_table_id - ip4 classify table index
4512 @param ip6_table_id - ip6 classify table index
4514 define classify_table_by_interface_reply
4524 /** \brief Classify table info
4525 @param client_index - opaque cookie to identify the sender
4526 @param context - sender context, to match reply w/ request
4527 @param table_id - classify table index
4529 define classify_table_info
4536 /** \brief Reply for classify table info request
4537 @param context - sender context which was passed in the request
4538 @param count - number of ids returned in response
4539 @param table_id - classify table index
4540 @param nbuckets - number of buckets when adding a table
4541 @param match_n_vectors - number of match vectors
4542 @param skip_n_vectors - number of skip_n_vectors
4543 @param active_sessions - number of sessions (active entries)
4544 @param next_table_index - index of next table
4545 @param miss_next_index - index of miss table
4546 @param mask[] - match mask
4548 define classify_table_info_reply
4554 u32 match_n_vectors;
4556 u32 active_sessions;
4557 u32 next_table_index;
4558 u32 miss_next_index;
4560 u8 mask[mask_length];
4563 /** \brief Classify sessions dump request
4564 @param client_index - opaque cookie to identify the sender
4565 @param context - sender context, to match reply w/ request
4566 @param table_id - classify table index
4568 define classify_session_dump
4575 /** \brief Reply for classify table session dump request
4576 @param context - sender context which was passed in the request
4577 @param count - number of ids returned in response
4578 @param table_id - classify table index
4579 @param hit_next_index - hit_next_index of session
4580 @param opaque_index - for add, opaque_index of session
4581 @param advance - advance value of session
4582 @param match[] - match value for session
4584 define classify_session_details
4593 u8 match[match_length];
4596 /** \brief Enable and configure IPFIX exporter process request
4597 @param client_index - opaque cookie to identify the sender
4598 @param context - sender context, to match reply w/ request
4599 @param collector_address - address of IPFIX collector
4600 @param collector_port - port of IPFIX IPFIX collector
4601 @param src_address - address of IPFIX exporter
4602 @param vrf_id - VRF / fib table ID
4603 @param path_mtu - Path MTU between exporter and collector
4604 @param template_interval - number of seconds after which to resend template
4610 u8 collector_address[16];
4615 u32 template_interval;
4618 /** \brief Reply to IPFIX enable and configure request
4619 @param context - sender context which was passed in the request
4621 define ipfix_enable_reply
4627 /** \brief IPFIX dump request
4628 @param client_index - opaque cookie to identify the sender
4629 @param context - sender context, to match reply w/ request
4637 /** \brief Reply to IPFIX dump request
4638 @param context - sender context which was passed in the request
4639 @param collector_address - address of IPFIX collector
4640 @param collector_port - port of IPFIX IPFIX collector
4641 @param src_address - address of IPFIX exporter
4642 @param fib_index - fib table index
4643 @param path_mtu - Path MTU between exporter and collector
4644 @param template_interval - number of seconds after which to resend template
4646 define ipfix_details
4649 u8 collector_address[16];
4654 u32 template_interval;
4657 /** \brief Query relative index via node names
4658 @param client_index - opaque cookie to identify the sender
4659 @param context - sender context, to match reply w/ request
4660 @param node_name - name of node to find relative index from
4661 @param next_name - next node from node_name to find relative index of
4663 define get_next_index
4671 /** \brief Reply for get next node index
4672 @param context - sender context which was passed in the request
4673 @param retval - return value
4674 @param next_index - index of the next_node
4676 define get_next_index_reply
4683 /** \brief PacketGenerator create interface request
4684 @param client_index - opaque cookie to identify the sender
4685 @param context - sender context, to match reply w/ request
4686 @param interface_id - interface index
4688 define pg_create_interface
4695 /** \brief PacketGenerator create interface response
4696 @param context - sender context, to match reply w/ request
4697 @param retval - return value for request
4699 define pg_create_interface_reply
4706 /** \brief PacketGenerator capture packets on given interface request
4707 @param client_index - opaque cookie to identify the sender
4708 @param context - sender context, to match reply w/ request
4709 @param interface_id - pg interface index
4710 @param is_enabled - 1 if enabling streams, 0 if disabling
4711 @param count - number of packets to be captured
4712 @param pcap_file - pacp file name to store captured packets
4721 u32 pcap_name_length;
4722 u8 pcap_file_name[pcap_name_length];
4725 /** \brief PacketGenerator capture packets response
4726 @param context - sender context, to match reply w/ request
4727 @param retval - return value for request
4729 define pg_capture_reply
4735 /** \brief Enable / disable packet generator request
4736 @param client_index - opaque cookie to identify the sender
4737 @param context - sender context, to match reply w/ request
4738 @param is_enabled - 1 if enabling streams, 0 if disabling
4739 @param stream - stream name to be enable/disabled, if not specified handle all streams
4741 define pg_enable_disable
4746 u32 stream_name_length;
4747 u8 stream_name[stream_name_length];
4750 /** \brief Reply for enable / disable packet generator
4751 @param context - returned sender context, to match reply w/ request
4752 @param retval - return code
4754 define pg_enable_disable_reply
4760 /** \brief Configure IP source and L4 port-range check
4761 @param client_index - opaque cookie to identify the sender
4762 @param context - sender context, to match reply w/ request
4763 @param is_ip6 - 1 if source address type is IPv6
4764 @param is_add - 1 if add, 0 if delete
4765 @param mask_length - mask length for address entry
4766 @param address - array of address bytes
4767 @param number_of_ranges - length of low_port and high_port arrays (must match)
4768 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
4769 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
4770 @param vrf_id - fib table/vrf id to associate the source and port-range check with
4771 @note To specify a single port set low_port and high_port entry the same
4773 define ip_source_and_port_range_check_add_del
4781 u8 number_of_ranges;
4787 /** \brief Configure IP source and L4 port-range check reply
4788 @param context - returned sender context, to match reply w/ request
4789 @param retval - return code
4791 define ip_source_and_port_range_check_add_del_reply
4797 /** \brief Set interface source and L4 port-range request
4798 @param client_index - opaque cookie to identify the sender
4799 @param context - sender context, to match reply w/ request
4800 @param interface_id - interface index
4801 @param tcp_vrf_id - VRF associated with source and TCP port-range check
4802 @param udp_vrf_id - VRF associated with source and TCP port-range check
4804 define ip_source_and_port_range_check_interface_add_del
4816 /** \brief Set interface source and L4 port-range response
4817 @param context - sender context, to match reply w/ request
4818 @param retval - return value for request
4820 define ip_source_and_port_range_check_interface_add_del_reply
4826 /** \brief Add / del ipsec gre tunnel request
4827 @param client_index - opaque cookie to identify the sender
4828 @param context - sender context, to match reply w/ request
4829 @param local_sa_id - local SA id
4830 @param remote_sa_id - remote SA id
4831 @param is_add - 1 if adding the tunnel, 0 if deleting
4832 @param src_address - tunnel source address
4833 @param dst_address - tunnel destination address
4835 define ipsec_gre_add_del_tunnel {
4845 /** \brief Reply for add / del ipsec gre tunnel request
4846 @param context - returned sender context, to match reply w/ request
4847 @param retval - return code
4848 @param sw_if_index - software index of the new ipsec gre tunnel
4850 define ipsec_gre_add_del_tunnel_reply {
4856 /** \brief Dump ipsec gre tunnel table
4857 @param client_index - opaque cookie to identify the sender
4858 @param context - sender context, to match reply w/ request
4859 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4861 define ipsec_gre_tunnel_dump {
4867 /** \brief mpls gre tunnel operational state response
4868 @param context - returned sender context, to match reply w/ request
4869 @param sw_if_index - software index of the ipsec gre tunnel
4870 @param local_sa_id - local SA id
4871 @param remote_sa_id - remote SA id
4872 @param src_address - tunnel source address
4873 @param dst_address - tunnel destination address
4875 define ipsec_gre_tunnel_details {
4884 /** \brief Delete sub interface request
4885 @param client_index - opaque cookie to identify the sender
4886 @param context - sender context, to match reply w/ request
4887 @param sw_if_index - sw index of the interface that was created by create_subif
4889 define delete_subif {
4895 /** \brief Delete sub interface response
4896 @param context - sender context, to match reply w/ request
4897 @param retval - return code for the request
4899 define delete_subif_reply {