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
1194 /** \brief vpe parser cli string response
1195 @param context - sender context, to match reply w/ request
1196 @param retval - return code for request
1197 @param reply_in_shmem - Reply string from cli processing if any
1205 define cli_inband_reply
1213 /** \brief Set max allowed ARP or ip6 neighbor entries request
1214 @param client_index - opaque cookie to identify the sender
1215 @param context - sender context, to match reply w/ request
1216 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1217 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1219 define set_arp_neighbor_limit
1224 u32 arp_neighbor_limit;
1227 /** \brief Set max allowed ARP or ip6 neighbor entries response
1228 @param context - sender context, to match reply w/ request
1229 @param retval - return code for request
1231 define set_arp_neighbor_limit_reply
1237 /** \brief L2 interface patch add / del request
1238 @param client_index - opaque cookie to identify the sender
1239 @param context - sender context, to match reply w/ request
1240 @param rx_sw_if_index - receive side interface
1241 @param tx_sw_if_index - transmit side interface
1242 @param is_add - if non-zero set up the interface patch, else remove it
1244 define l2_patch_add_del
1253 /** \brief L2 interface patch add / del response
1254 @param context - sender context, to match reply w/ request
1255 @param retval - return code for the request
1257 define l2_patch_add_del_reply
1263 /** \brief IPv6 segment routing tunnel add / del request
1264 @param client_index - opaque cookie to identify the sender
1265 @param context - sender context, to match reply w/ request
1266 @param is_add - add the tunnel if non-zero, else delete it
1267 @param name[] - tunnel name (len. 64)
1268 @param src_address[] -
1269 @param dst_address[] -
1270 @param dst_mask_width -
1271 @param inner_vrf_id -
1272 @param outer_vrf_id -
1273 @param flags_net_byte_order -
1276 @param segs_and_tags[] -
1277 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1279 define sr_tunnel_add_del
1290 u16 flags_net_byte_order;
1293 u8 segs_and_tags[0];
1297 /** \brief IPv6 segment routing tunnel add / del response
1298 @param context - sender context, to match reply w/ request
1299 @param retval - return value for request
1301 define sr_tunnel_add_del_reply
1307 /** \brief IPv6 segment routing policy add / del request
1308 @param client_index - opaque cookie to identify the sender
1309 @param context - sender context, to match reply w/ request
1310 @param is_add - add the tunnel if non-zero, else delete it
1311 @param name[] - policy name (len. 64)
1312 @param tunnel_names[] -
1314 define sr_policy_add_del
1323 /** \brief IPv6 segment routing policy add / del response
1324 @param context - sender context, to match reply w/ request
1325 @param retval - return value for request
1327 define sr_policy_add_del_reply
1333 /** \brief IPv6 segment routing multicast map to policy add / del request
1334 @param client_index - opaque cookie to identify the sender
1335 @param context - sender context, to match reply w/ request
1336 @param is_add - add the tunnel if non-zero, else delete it
1337 @param multicast_address[] - IP6 multicast address
1338 @param policy_name[] = policy name (len.64)
1340 define sr_multicast_map_add_del
1345 u8 multicast_address[16];
1349 /** \brief IPv6 segment routing multicast map to policy add / del response
1350 @param context - sender context, to match reply w/ request
1351 @param retval - return value for request
1353 define sr_multicast_map_add_del_reply
1359 /** \brief Interface set vpath request
1360 @param client_index - opaque cookie to identify the sender
1361 @param context - sender context, to match reply w/ request
1362 @param sw_if_index - interface used to reach neighbor
1363 @param enable - if non-zero enable, else disable
1365 define sw_interface_set_vpath
1373 /** \brief Interface set vpath response
1374 @param context - sender context, to match reply w/ request
1375 @param retval - return code for the request
1377 define sw_interface_set_vpath_reply
1383 /** \brief MPLS Ethernet add / del tunnel request
1384 @param client_index - opaque cookie to identify the sender
1385 @param context - sender context, to match reply w/ request
1386 @param vrf_id - vrf_id, only for IP4
1387 @param sw_if_index - interface used to reach neighbor
1388 @param is_add - add if set, tunnel delete if 0
1389 @param dst_mac_address -
1390 @param adj_address -
1391 @param adj_address_length -
1393 define mpls_ethernet_add_del_tunnel
1401 u8 dst_mac_address[6];
1403 u8 adj_address_length;
1406 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1407 @param context - sender context, to match reply w/ request
1408 @param retval - return code for the request
1410 define mpls_ethernet_add_del_tunnel_reply
1414 u32 tunnel_sw_if_index;
1416 /** \brief MPLS Ethernet add/ del tunnel 2
1417 @param client_index - opaque cookie to identify the sender
1418 @param context - sender context, to match reply w/ request
1419 @param inner_vrf_id -
1420 @param outer_vrf_id -
1421 @param resolve_attempts -
1422 @param resolve_opaque -
1423 @param resolve_if_needed -
1425 @param adj_address -
1426 @param adj_address_length -
1427 @param next_hop_ip4_address_in_outer_vrf -
1429 define mpls_ethernet_add_del_tunnel_2
1435 u32 resolve_attempts;
1436 u32 resolve_opaque; /* no need to set this */
1437 u8 resolve_if_needed;
1441 u8 adj_address_length;
1442 u8 next_hop_ip4_address_in_outer_vrf[4];
1445 /** \brief MPLS Ethernet add/ del tunnel 2
1446 @param context - sender context, to match reply w/ request
1447 @param retval - return code for add /del request
1449 define mpls_ethernet_add_del_tunnel_2_reply
1455 /** \brief Set L2 XConnect between two interfaces request
1456 @param client_index - opaque cookie to identify the sender
1457 @param context - sender context, to match reply w/ request
1458 @param rx_sw_if_index - Receive interface index
1459 @param tx_sw_if_index - Transmit interface index
1460 @param enable - enable xconnect if not 0, else set to L3 mode
1462 define sw_interface_set_l2_xconnect
1471 /** \brief Set L2 XConnect response
1472 @param context - sender context, to match reply w/ request
1473 @param retval - L2 XConnect request return code
1475 define sw_interface_set_l2_xconnect_reply
1481 /** \brief Interface bridge mode request
1482 @param client_index - opaque cookie to identify the sender
1483 @param context - sender context, to match reply w/ request
1484 @param rx_sw_if_index - the interface
1485 @param bd_id - bridge domain id
1486 @param bvi - Setup interface as a bvi, bridge mode only
1487 @param shg - Shared horizon group, for bridge mode only
1488 @param enable - Enable beige mode if not 0, else set to L3 mode
1490 define sw_interface_set_l2_bridge
1501 /** \brief Interface bridge mode response
1502 @param context - sender context, to match reply w/ request
1503 @param retval - Bridge mode request return code
1505 define sw_interface_set_l2_bridge_reply
1511 /** \brief L2 FIB add entry request
1512 @param client_index - opaque cookie to identify the sender
1513 @param context - sender context, to match reply w/ request
1514 @param mac - the entry's mac address
1515 @param bd_id - the entry's bridge domain id
1516 @param sw_if_index - the interface
1517 @param is_add - If non zero add the entry, else delete it
1521 define l2fib_add_del
1534 /** \brief L2 FIB add entry response
1535 @param context - sender context, to match reply w/ request
1536 @param retval - return code for the add l2fib entry request
1538 define l2fib_add_del_reply
1544 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1545 @param client_index - opaque cookie to identify the sender
1546 @param context - sender context, to match reply w/ request
1547 @param sw_if_index - interface
1548 @param is_set - if non-zero, set the bits, else clear them
1549 @param feature_bitmap - non-zero bits to set or clear
1560 /** \brief Set L2 bits response
1561 @param context - sender context, to match reply w/ request
1562 @param retval - return code for the set l2 bits request
1564 define l2_flags_reply
1568 u32 resulting_feature_bitmap;
1571 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1572 L2_UU_FLOOD, or L2_ARP_TERM) request
1573 @param client_index - opaque cookie to identify the sender
1574 @param context - sender context, to match reply w/ request
1575 @param bd_id - the bridge domain to set the flags for
1576 @param is_set - if non-zero, set the flags, else clear them
1577 @param feature_bitmap - bits that are non-zero to set or clear
1588 /** \brief Set bridge flags response
1589 @param context - sender context, to match reply w/ request
1590 @param retval - return code for the set bridge flags request
1591 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1593 define bridge_flags_reply
1597 u32 resulting_feature_bitmap;
1600 /** \brief Set bridge domain ip to mac entry request
1601 @param client_index - opaque cookie to identify the sender
1602 @param context - sender context, to match reply w/ request
1603 @param bd_id - the bridge domain to set the flags for
1604 @param is_add - if non-zero, add the entry, else clear it
1605 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1606 @param mac_address - MAC address
1609 define bd_ip_mac_add_del
1620 /** \brief Set bridge domain ip to mac entry response
1621 @param context - sender context, to match reply w/ request
1622 @param retval - return code for the set bridge flags request
1624 define bd_ip_mac_add_del_reply
1630 /** \brief Add/Delete classification table request
1631 @param client_index - opaque cookie to identify the sender
1632 @param context - sender context, to match reply w/ request
1633 @param is_add- if non-zero add the table, else delete it
1634 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1635 @param nbuckets - number of buckets when adding a table
1636 @param memory_size - memory size when adding a table
1637 @param match_n_vectors - number of match vectors
1638 @param next_table_index - index of next table
1639 @param miss_next_index - index of miss table
1640 @param mask[] - match mask
1642 define classify_add_del_table
1651 u32 match_n_vectors;
1652 u32 next_table_index;
1653 u32 miss_next_index;
1657 /** \brief Add/Delete classification table response
1658 @param context - sender context, to match reply w/ request
1659 @param retval - return code for the table add/del requst
1660 @param new_table_index - for add, returned index of the new table
1661 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1662 @param match_n_vectors -for add, returned value of match_n_vectors in table
1664 define classify_add_del_table_reply
1668 u32 new_table_index;
1670 u32 match_n_vectors;
1673 /** \brief Classify add / del session request
1674 @param client_index - opaque cookie to identify the sender
1675 @param context - sender context, to match reply w/ request
1676 @param is_add - add session if non-zero, else delete
1677 @param table_index - index of the table to add/del the session, required
1678 @param hit_next_index - for add, hit_next_index of new session, required
1679 @param opaque_index - for add, opaque_index of new session
1680 @param advance -for add, advance value for session
1681 @param match[] - for add, match value for session, required
1683 define classify_add_del_session
1695 /** \brief Classify add / del session response
1696 @param context - sender context, to match reply w/ request
1697 @param retval - return code for the add/del session request
1699 define classify_add_del_session_reply
1705 /** \brief Set/unset the classification table for an interface request
1706 @param client_index - opaque cookie to identify the sender
1707 @param context - sender context, to match reply w/ request
1708 @param is_ipv6 - ipv6 if non-zero, else ipv4
1709 @param sw_if_index - interface to associate with the table
1710 @param table_index - index of the table, if ~0 unset the table
1712 define classify_set_interface_ip_table
1718 u32 table_index; /* ~0 => off */
1721 /** \brief Set/unset interface classification table response
1722 @param context - sender context, to match reply w/ request
1723 @param retval - return code
1725 define classify_set_interface_ip_table_reply
1731 /** \brief Set/unset l2 classification tables for an interface request
1732 @param client_index - opaque cookie to identify the sender
1733 @param context - sender context, to match reply w/ request
1734 @param sw_if_index - interface to set/unset tables for
1735 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1736 @param ip6_table_index - ip6 index
1737 @param other_table_index - other index
1739 define classify_set_interface_l2_tables
1745 u32 ip4_table_index;
1746 u32 ip6_table_index;
1747 u32 other_table_index;
1751 /** \brief Set/unset l2 classification tables for an interface response
1752 @param context - sender context, to match reply w/ request
1753 @param retval - return code for the request
1755 define classify_set_interface_l2_tables_reply
1761 /** \brief Get node index using name request
1762 @param client_index - opaque cookie to identify the sender
1763 @param context - sender context, to match reply w/ request
1764 @param node_name[] - name of the node
1766 define get_node_index
1773 /** \brief Get node index using name request
1774 @param context - sender context, to match reply w/ request
1775 @param retval - return code for the request
1776 @param node_index - index of the desired node if found, else ~0
1778 define get_node_index_reply
1785 /** \brief Set the next node for a given node request
1786 @param client_index - opaque cookie to identify the sender
1787 @param context - sender context, to match reply w/ request
1788 @param node_name[] - node to add the next node to
1789 @param next_name[] - node to add as the next node
1791 define add_node_next
1799 /** \brief IP Set the next node for a given node response
1800 @param context - sender context, to match reply w/ request
1801 @param retval - return code for the add next node request
1802 @param next_index - the index of the next node if success, else ~0
1804 define add_node_next_reply
1811 /** \brief DHCP Proxy config 2 add / del request
1812 @param client_index - opaque cookie to identify the sender
1813 @param context - sender context, to match reply w/ request
1814 @param rx_vrf_id - receive vrf id
1815 @param server_vrf_id - server vrf id
1816 @param if_ipv6 - ipv6 if non-zero, else ipv4
1817 @param is_add - add the config if non-zero, else delete
1818 @param insert_circuit_id - option82 suboption 1 fib number
1819 @param dhcp_server[] - server address
1820 @param dhcp_src_address[] - <fix this, need details>
1822 define dhcp_proxy_config_2
1830 u8 insert_circuit_id;
1832 u8 dhcp_src_address[16];
1835 /** \brief DHCP Proxy config 2 add / del response
1836 @param context - sender context, to match reply w/ request
1837 @param retval - return code for request
1839 define dhcp_proxy_config_2_reply
1845 /** \brief l2tpv3 tunnel interface create request
1846 @param client_index - opaque cookie to identify the sender
1847 @param context - sender context, to match reply w/ request
1848 @param client_address - remote client tunnel ip address
1849 @param client_address - local tunnel ip address
1850 @param is_ipv6 - ipv6 if non-zero, else ipv4
1851 @param local_session_id - local tunnel session id
1852 @param remote_session_id - remote tunnel session id
1853 @param local_cookie - local tunnel cookie
1854 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1855 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1857 define l2tpv3_create_tunnel
1861 u8 client_address[16];
1864 u32 local_session_id;
1865 u32 remote_session_id;
1868 u8 l2_sublayer_present;
1872 /** \brief l2tpv3 tunnel interface create response
1873 @param context - sender context, to match reply w/ request
1874 @param retval - return code for the request
1875 @param sw_if_index - index of the new tunnel interface
1877 define l2tpv3_create_tunnel_reply
1884 define l2tpv3_set_tunnel_cookies
1889 u64 new_local_cookie;
1890 u64 new_remote_cookie;
1893 /** \brief L2TP tunnel set cookies response
1894 @param context - sender context, to match reply w/ request
1895 @param retval - return code for the request
1897 define l2tpv3_set_tunnel_cookies_reply
1903 define sw_if_l2tpv3_tunnel_details
1907 u8 interface_name[64];
1908 u8 client_address[16];
1910 u32 local_session_id;
1911 u32 remote_session_id;
1912 u64 local_cookie[2];
1914 u8 l2_sublayer_present;
1917 define sw_if_l2tpv3_tunnel_dump
1923 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1924 @param client_index - opaque cookie to identify the sender
1925 @param context - sender context, to match reply w/ request
1927 define l2_fib_clear_table
1933 /** \brief L2 fib clear table response
1934 @param context - sender context, to match reply w/ request
1935 @param retval - return code for the request
1937 define l2_fib_clear_table_reply
1943 /** \brief L2 interface ethernet flow point filtering enable/disable request
1944 @param client_index - opaque cookie to identify the sender
1945 @param context - sender context, to match reply w/ request
1946 @param sw_if_index - interface to enable/disable filtering on
1947 @param enable_disable - if non-zero enable filtering, else disable
1949 define l2_interface_efp_filter
1957 /** \brief L2 interface ethernet flow point filtering response
1958 @param context - sender context, to match reply w/ request
1959 @param retval - return code for the request
1961 define l2_interface_efp_filter_reply
1967 define l2tpv3_interface_enable_disable
1975 define l2tpv3_interface_enable_disable_reply
1981 define l2tpv3_set_lookup_key
1985 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1989 define l2tpv3_set_lookup_key_reply
1995 define vxlan_add_del_tunnel
2004 u32 decap_next_index;
2008 define vxlan_add_del_tunnel_reply
2015 define vxlan_tunnel_dump
2022 define vxlan_tunnel_details
2029 u32 decap_next_index;
2034 define gre_add_del_tunnel
2045 define gre_add_del_tunnel_reply
2052 define gre_tunnel_dump
2059 define gre_tunnel_details
2069 /** \brief L2 interface vlan tag rewrite configure request
2070 @param client_index - opaque cookie to identify the sender
2071 @param context - sender context, to match reply w/ request
2072 @param sw_if_index - interface the operation is applied to
2073 @param vtr_op - Choose from l2_vtr_op_t enum values
2074 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2075 @param tag1 - Needed for any push or translate vtr op
2076 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2078 define l2_interface_vlan_tag_rewrite
2084 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2085 u32 tag1; // first pushed tag
2086 u32 tag2; // second pushed tag
2089 /** \brief L2 interface vlan tag rewrite response
2090 @param context - sender context, to match reply w/ request
2091 @param retval - return code for the request
2093 define l2_interface_vlan_tag_rewrite_reply
2099 /** \brief vhost-user interface create request
2100 @param client_index - opaque cookie to identify the sender
2101 @param is_server - our side is socket server
2102 @param sock_filename - unix socket filename, used to speak with frontend
2103 @param use_custom_mac - enable or disable the use of the provided hardware address
2104 @param mac_address - hardware address to use if 'use_custom_mac' is set
2106 define create_vhost_user_if
2111 u8 sock_filename[256];
2113 u32 custom_dev_instance;
2118 /** \brief vhost-user interface create response
2119 @param context - sender context, to match reply w/ request
2120 @param retval - return code for the request
2121 @param sw_if_index - interface the operation is applied to
2123 define create_vhost_user_if_reply
2130 /** \brief vhost-user interface modify request
2131 @param client_index - opaque cookie to identify the sender
2132 @param is_server - our side is socket server
2133 @param sock_filename - unix socket filename, used to speak with frontend
2135 define modify_vhost_user_if
2141 u8 sock_filename[256];
2143 u32 custom_dev_instance;
2146 /** \brief vhost-user interface modify response
2147 @param context - sender context, to match reply w/ request
2148 @param retval - return code for the request
2150 define modify_vhost_user_if_reply
2156 /** \brief vhost-user interface delete request
2157 @param client_index - opaque cookie to identify the sender
2159 define delete_vhost_user_if
2166 /** \brief vhost-user interface delete response
2167 @param context - sender context, to match reply w/ request
2168 @param retval - return code for the request
2170 define delete_vhost_user_if_reply
2183 /* These fields map directly onto the subif template */
2187 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2190 u8 outer_vlan_id_any;
2191 u8 inner_vlan_id_any;
2196 define create_subif_reply
2203 /** \brief show version
2204 @param client_index - opaque cookie to identify the sender
2205 @param context - sender context, to match reply w/ request
2213 /** \brief show version response
2214 @param context - sender context, to match reply w/ request
2215 @param retval - return code for the request
2216 @param program - name of the program (vpe)
2217 @param version - version of the program
2218 @param build_directory - root of the workspace where the program was built
2220 define show_version_reply
2227 u8 build_directory[256];
2230 /** \brief Vhost-user interface details structure (fix this)
2231 @param sw_if_index - index of the interface
2232 @param interface_name - name of interface
2233 @param virtio_net_hdr_sz - net header size
2234 @param features - interface features
2235 @param is_server - vhost-user server socket
2236 @param sock_filename - socket filename
2237 @param num_regions - number of used memory regions
2239 define sw_interface_vhost_user_details
2243 u8 interface_name[64];
2244 u32 virtio_net_hdr_sz;
2247 u8 sock_filename[256];
2253 define sw_interface_vhost_user_dump
2259 define ip_address_details
2267 define ip_address_dump
2288 /** \brief l2 fib table entry structure
2289 @param bd_id - the l2 fib / bridge domain table id
2290 @param mac - the entry's mac address
2291 @param sw_if_index - index of the interface
2292 @param static_mac - the entry is statically configured.
2293 @param filter_mac - the entry is a mac filter entry.
2294 @param bvi_mac - the mac address is a bridge virtual interface
2296 define l2_fib_table_entry
2307 /** \brief Dump l2 fib (aka bridge domain) table
2308 @param client_index - opaque cookie to identify the sender
2309 @param bd_id - the l2 fib / bridge domain table identifier
2311 define l2_fib_table_dump
2318 define vxlan_gpe_add_del_tunnel
2332 define vxlan_gpe_add_del_tunnel_reply
2339 define vxlan_gpe_tunnel_dump
2346 define vxlan_gpe_tunnel_details
2359 /** \brief add or delete locator_set
2360 @param client_index - opaque cookie to identify the sender
2361 @param context - sender context, to match reply w/ request
2362 @param is_add - add address if non-zero, else delete
2363 @param locator_set_name - locator name
2364 @param locator_num - number of locators
2365 @param locators - Lisp locator data
2367 define lisp_add_del_locator_set
2372 u8 locator_set_name[64];
2374 u8 locators[locator_num];
2377 /** \brief Reply for locator_set add/del
2378 @param context - returned sender context, to match reply w/ request
2379 @param retval - return code
2380 @param ls_index - locator set index
2382 define lisp_add_del_locator_set_reply
2389 /** \brief add or delete locator for locator_set
2390 @param client_index - opaque cookie to identify the sender
2391 @param context - sender context, to match reply w/ request
2392 @param is_add - add address if non-zero, else delete
2393 @param locator_set_name - name of locator_set to add/del locator
2394 @param sw_if_index - index of the interface
2395 @param priority - priority of the lisp locator
2396 @param weight - weight of the lisp locator
2398 define lisp_add_del_locator
2403 u8 locator_set_name[64];
2409 /** \brief Reply for locator add/del
2410 @param context - returned sender context, to match reply w/ request
2411 @param retval - return code
2413 define lisp_add_del_locator_reply
2419 /** \brief add or delete lisp eid-table
2420 @param client_index - opaque cookie to identify the sender
2421 @param context - sender context, to match reply w/ request
2422 @param is_add - add address if non-zero, else delete
2427 @param eid - EID can be ip4, ip6 or mac
2428 @param prefix_len - prefix len
2429 @param locator_set_name - name of locator_set to add/del eid-table
2430 @param vni - virtual network instance
2432 define lisp_add_del_local_eid
2440 u8 locator_set_name[64];
2444 /** \brief Reply for local_eid add/del
2445 @param context - returned sender context, to match reply w/ request
2446 @param retval - return code
2448 define lisp_add_del_local_eid_reply
2454 /** \brief add or delete lisp gpe tunnel
2455 @param client_index - opaque cookie to identify the sender
2456 @param context - sender context, to match reply w/ request
2457 @param is_add - add address if non-zero, else delete
2462 @param rmt_eid - remote eid
2463 @param lcl_eid - local eid
2464 @param rmt_len - remote prefix len
2465 @param lcl_len - local prefix len
2466 @param vni - virtual network identifier
2467 @param dp_table - vrf/bridge domain id
2468 @param loc_num - number of locators
2469 @param lcl_locs - array of local locators
2470 @param rmt_locs - array of remote locators
2471 @param action - negative action when 0 locators configured
2473 define lisp_gpe_add_del_fwd_entry
2486 u8 lcl_locs[loc_num];
2487 u8 rmt_locs[loc_num];
2491 /** \brief Reply for gpe_fwd_entry add/del
2492 @param context - returned sender context, to match reply w/ request
2493 @param retval - return code
2495 define lisp_gpe_add_del_fwd_entry_reply
2501 /** \brief add or delete map-resolver
2502 @param client_index - opaque cookie to identify the sender
2503 @param context - sender context, to match reply w/ request
2504 @param is_add - add address if non-zero, else delete
2505 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2506 @param ip_address - array of address bytes
2508 define lisp_add_del_map_resolver
2517 /** \brief Reply for map_resolver add/del
2518 @param context - returned sender context, to match reply w/ request
2519 @param retval - return code
2521 define lisp_add_del_map_resolver_reply
2527 /** \brief enable or disable lisp-gpe protocol
2528 @param client_index - opaque cookie to identify the sender
2529 @param context - sender context, to match reply w/ request
2530 @param is_en - enable protocol if non-zero, else disable
2532 define lisp_gpe_enable_disable
2539 /** \brief Reply for gpe enable/disable
2540 @param context - returned sender context, to match reply w/ request
2541 @param retval - return code
2543 define lisp_gpe_enable_disable_reply
2549 /** \brief enable or disable LISP feature
2550 @param client_index - opaque cookie to identify the sender
2551 @param context - sender context, to match reply w/ request
2552 @param is_en - enable protocol if non-zero, else disable
2554 define lisp_enable_disable
2561 /** \brief Reply for gpe enable/disable
2562 @param context - returned sender context, to match reply w/ request
2563 @param retval - return code
2565 define lisp_enable_disable_reply
2571 /** \brief add or delete gpe_iface
2572 @param client_index - opaque cookie to identify the sender
2573 @param context - sender context, to match reply w/ request
2574 @param is_add - add address if non-zero, else delete
2576 define lisp_gpe_add_del_iface
2586 /** \brief Reply for gpe_iface add/del
2587 @param context - returned sender context, to match reply w/ request
2588 @param retval - return code
2590 define lisp_gpe_add_del_iface_reply
2596 /** \brief configure or disable LISP PITR node
2597 @param client_index - opaque cookie to identify the sender
2598 @param context - sender context, to match reply w/ request
2599 @param ls_name - locator set name
2600 @param is_add - add locator set if non-zero, else disable pitr
2602 define lisp_pitr_set_locator_set
2610 /** \brief Reply for lisp_pitr_set_locator_set
2611 @param context - returned sender context, to match reply w/ request
2612 @param retval - return code
2614 define lisp_pitr_set_locator_set_reply
2620 /** \brief add or delete remote static mapping
2621 @param client_index - opaque cookie to identify the sender
2622 @param context - sender context, to match reply w/ request
2623 @param is_add - add address if non-zero, else delete
2624 @param is_src_dst - flag indicating src/dst based routing policy
2625 @param del_all - if set, delete all remote mappings
2626 @param vni - virtual network instance
2627 @param action - negative map-reply action
2632 @param deid - dst EID
2633 @param seid - src EID, valid only if is_src_dst is enabled
2634 @param rloc_num - number of remote locators
2635 @param rlocs - remote locator data
2637 define lisp_add_del_remote_mapping
2655 /** \brief Reply for lisp_add_del_remote_mapping
2656 @param context - returned sender context, to match reply w/ request
2657 @param retval - return code
2659 define lisp_add_del_remote_mapping_reply
2665 /** \brief add or delete LISP adjacency adjacency
2666 @param client_index - opaque cookie to identify the sender
2667 @param context - sender context, to match reply w/ request
2668 @param is_add - add address if non-zero, else delete
2669 @param vni - virtual network instance
2674 @param deid - destination EID
2675 @param seid - source EID
2677 define lisp_add_del_adjacency
2690 /** \brief Reply for lisp_add_del_adjacency
2691 @param context - returned sender context, to match reply w/ request
2692 @param retval - return code
2694 define lisp_add_del_adjacency_reply
2700 /** \brief add or delete map request itr rlocs
2701 @param client_index - opaque cookie to identify the sender
2702 @param context - sender context, to match reply w/ request
2703 @param is_add - add address if non-zero, else delete
2704 @param locator_set_name - locator set name
2706 define lisp_add_del_map_request_itr_rlocs
2711 u8 locator_set_name[64];
2714 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2715 @param context - returned sender context, to match reply w/ request
2716 @param retval - return code
2719 define lisp_add_del_map_request_itr_rlocs_reply
2725 /** \brief map/unmap vni/bd_index to vrf
2726 @param client_index - opaque cookie to identify the sender
2727 @param context - sender context, to match reply w/ request
2728 @param is_add - add or delete mapping
2729 @param dp_table - virtual network id/bridge domain index
2732 define lisp_eid_table_add_del_map
2742 /** \brief Reply for lisp_eid_table_add_del_map
2743 @param context - returned sender context, to match reply w/ request
2744 @param retval - return code
2746 define lisp_eid_table_add_del_map_reply
2752 /** \brief Request for map lisp locator status
2753 @param client_index - opaque cookie to identify the sender
2754 @param context - sender context, to match reply w/ request
2755 @param locator_set_index - index of locator_set
2756 @param filter - filter type;
2762 define lisp_locator_dump
2766 u32 locator_set_index;
2770 /** \brief LISP locator_set status
2771 @param local - if is set, then locator is local
2772 @param locator_set_name - name of the locator_set
2773 @param sw_if_index - sw_if_index of the locator
2774 @param priority - locator priority
2775 @param weight - locator weight
2777 define lisp_locator_details
2788 /** \brief LISP locator_set status
2789 @param locator_set_name - name of the locator_set
2790 @param local - if is set, then locator_set is local
2791 @param locator_count - number of locator this stats block includes
2792 @param locator - locator data
2794 define lisp_locator_set_details
2798 u32 locator_set_index;
2799 u8 locator_set_name[64];
2802 /** \brief Request for locator_set summary status
2803 @param client_index - opaque cookie to identify the sender
2804 @param context - sender context, to match reply w/ request
2805 @param filter - filter type;
2808 1: local locator_set
2809 2: remote locator_set
2811 define lisp_locator_set_dump
2818 /** \brief Dump lisp eid-table
2819 @param client_index - opaque cookie to identify the sender
2820 @param context - sender context, to match reply w/ request
2821 @param locator_set_index - index of locator_set, if ~0 then the mapping
2823 @param action - negative map request action
2824 @param is_local - local if non-zero, else remote
2829 @param eid - EID can be ip4, ip6 or mac
2830 @param prefix_len - prefix len
2831 @param vni - virtual network instance
2832 @param ttl - time to live
2833 @param authoritative - authoritative
2836 define lisp_eid_table_details
2839 u32 locator_set_index;
2850 /** \brief Request for eid table summary status
2851 @param client_index - opaque cookie to identify the sender
2852 @param context - sender context, to match reply w/ request
2853 @param eid_set - if non-zero request info about specific mapping
2854 @param vni - virtual network instance; valid only if eid_set != 0
2855 @param prefix_length - prefix length if EID is IP address;
2856 valid only if eid_set != 0
2857 @param eid_type - EID type; valid only if eid_set != 0
2861 2: EID is ethernet address
2862 @param eid - endpoint identifier
2863 @param filter - filter type;
2869 define lisp_eid_table_dump
2881 /** \brief Shows relationship between vni and vrf/bd
2882 @param dp_table - VRF index or bridge domain index
2883 @param vni - vitual network instance
2885 define lisp_eid_table_map_details
2892 /** \brief Request for lisp_eid_table_map_details
2893 @param client_index - opaque cookie to identify the sender
2894 @param context - sender context, to match reply w/ request
2895 @param is_l2 - if set dump vni/bd mappings else vni/vrf
2897 define lisp_eid_table_map_dump
2904 /** \brief Dumps all VNIs used in mappings
2905 @param client_index - opaque cookie to identify the sender
2906 @param context - sender context, to match reply w/ request
2908 define lisp_eid_table_vni_dump
2914 /** \brief reply to lisp_eid_table_vni_dump
2915 @param client_index - opaque cookie to identify the sender
2916 @param context - sender context, to match reply w/ request
2917 @param vni - virtual network instance
2919 define lisp_eid_table_vni_details
2926 define lisp_gpe_tunnel_details
2932 u8 destination_ip[16];
2944 /** \brief Request for gpe tunnel summary status
2945 @param client_index - opaque cookie to identify the sender
2946 @param context - sender context, to match reply w/ request
2948 define lisp_gpe_tunnel_dump
2954 /** \brief LISP map resolver status
2955 @param locator_set_name - name of the locator_set
2956 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2957 @param ip_address - array of address bytes
2959 define lisp_map_resolver_details
2966 /** \brief Request for map resolver summary status
2967 @param client_index - opaque cookie to identify the sender
2968 @param context - sender context, to match reply w/ request
2970 define lisp_map_resolver_dump
2976 /** \brief Request for lisp-gpe protocol status
2977 @param client_index - opaque cookie to identify the sender
2978 @param context - sender context, to match reply w/ request
2980 define show_lisp_status
2986 /** \brief Status of lisp, enable or disable
2987 @param context - sender context, to match reply w/ request
2988 @param feature_status - lisp enable if non-zero, else disable
2989 @param gpe_status - lisp enable if non-zero, else disable
2991 define show_lisp_status_reply
2999 /** \brief Get LISP map request itr rlocs status
3000 @param context - sender context, to match reply w/ request
3001 @param locator_set_name - name of the locator_set
3003 define lisp_get_map_request_itr_rlocs
3009 /** \brief Request for map request itr rlocs summary status
3011 define lisp_get_map_request_itr_rlocs_reply
3015 u8 locator_set_name[64];
3018 /** \brief Request for lisp pitr status
3019 @param client_index - opaque cookie to identify the sender
3020 @param context - sender context, to match reply w/ request
3022 define show_lisp_pitr
3028 /** \brief Status of lisp pitr, enable or disable
3029 @param context - sender context, to match reply w/ request
3030 @param status - lisp pitr enable if non-zero, else disable
3031 @param locator_set_name - name of the locator_set
3033 define show_lisp_pitr_reply
3038 u8 locator_set_name[64];
3041 /* Gross kludge, DGMS */
3042 define interface_name_renumber
3047 u32 new_show_dev_instance;
3050 define interface_name_renumber_reply
3056 /** \brief Register for ip4 arp resolution events
3057 @param client_index - opaque cookie to identify the sender
3058 @param context - sender context, to match reply w/ request
3059 @param enable_disable - 1 => register for events, 0 => cancel registration
3060 @param pid - sender's pid
3061 @param address - the exact ip4 address of interest
3063 define want_ip4_arp_events
3072 /** \brief Reply for interface events registration
3073 @param context - returned sender context, to match reply w/ request
3074 @param retval - return code
3076 define want_ip4_arp_events_reply
3082 /** \brief Tell client about an ip4 arp resolution event
3083 @param client_index - opaque cookie to identify the sender
3084 @param context - sender context, to match reply w/ request
3085 @param address - the exact ip4 address of interest
3086 @param pid - client pid registered to receive notification
3087 @param sw_if_index - interface which received ARP packet
3088 @param new_mac - the new mac address
3089 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3091 define ip4_arp_event
3102 /** \brief Register for ip6 nd resolution events
3103 @param client_index - opaque cookie to identify the sender
3104 @param context - sender context, to match reply w/ request
3105 @param enable_disable - 1 => register for events, 0 => cancel registration
3106 @param pid - sender's pid
3107 @param address - the exact ip6 address of interest
3109 define want_ip6_nd_events
3118 /** \brief Reply for ip6 nd resolution events registration
3119 @param context - returned sender context, to match reply w/ request
3120 @param retval - return code
3122 define want_ip6_nd_events_reply
3128 /** \brief Tell client about an ip6 nd resolution or mac/ip event
3129 @param client_index - opaque cookie to identify the sender
3130 @param context - sender context, to match reply w/ request
3131 @param pid - client pid registered to receive notification
3132 @param sw_if_index - interface which received ARP packet
3133 @param address - the exact ip6 address of interest
3134 @param new_mac - the new mac address
3135 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3148 /** \brief L2 bridge domain add or delete request
3149 @param client_index - opaque cookie to identify the sender
3150 @param context - sender context, to match reply w/ request
3151 @param bd_id - the bridge domain to create
3152 @param flood - enable/disable bcast/mcast flooding in the bd
3153 @param uu_flood - enable/disable uknown unicast flood in the bd
3154 @param forward - enable/disable forwarding on all interfaces in the bd
3155 @param learn - enable/disable learning on all interfaces in the bd
3156 @param arp_term - enable/disable arp termination in the bd
3157 @param is_add - add or delete flag
3159 define bridge_domain_add_del
3172 /** \brief L2 bridge domain add or delete response
3173 @param context - sender context, to match reply w/ request
3174 @param retval - return code for the set bridge flags request
3176 define bridge_domain_add_del_reply
3182 /** \brief L2 bridge domain request operational state details
3183 @param client_index - opaque cookie to identify the sender
3184 @param context - sender context, to match reply w/ request
3185 @param bd_id - the bridge domain id desired or ~0 to request all bds
3187 define bridge_domain_dump
3194 /** \brief L2 bridge domain operational state response
3195 @param bd_id - the bridge domain id
3196 @param flood - bcast/mcast flooding state on all interfaces in the bd
3197 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3198 @param forward - forwarding state on all interfaces in the bd
3199 @param learn - learning state on all interfaces in the bd
3200 @param arp_term - arp termination state on all interfaces in the bd
3201 @param n_sw_ifs - number of sw_if_index's in the domain
3203 define bridge_domain_details
3212 u32 bvi_sw_if_index;
3216 /** \brief L2 bridge domain sw interface operational state response
3217 @param bd_id - the bridge domain id
3218 @param sw_if_index - sw_if_index in the domain
3219 @param shg - split horizon group for the interface
3221 define bridge_domain_sw_if_details
3229 /** \brief DHCP Client config add / del request
3230 @param client_index - opaque cookie to identify the sender
3231 @param context - sender context, to match reply w/ request
3232 @param sw_if_index - index of the interface for DHCP client
3233 @param hostname - hostname
3234 @param is_add - add the config if non-zero, else delete
3235 @param want_dhcp_event - DHCP event sent to the sender
3236 via dhcp_compl_event API message if non-zero
3237 @param pid - sender's pid
3239 define dhcp_client_config
3250 /** \brief DHCP Client config response
3251 @param context - sender context, to match reply w/ request
3252 @param retval - return code for the request
3254 define dhcp_client_config_reply
3260 /** \brief Set/unset input ACL interface
3261 @param client_index - opaque cookie to identify the sender
3262 @param context - sender context, to match reply w/ request
3263 @param sw_if_index - interface to set/unset input ACL
3264 @param ip4_table_index - ip4 classify table index (~0 for skip)
3265 @param ip6_table_index - ip6 classify table index (~0 for skip)
3266 @param l2_table_index - l2 classify table index (~0 for skip)
3267 @param is_add - Set input ACL if non-zero, else unset
3268 Note: User is recommeneded to use just one valid table_index per call.
3269 (ip4_table_index, ip6_table_index, or l2_table_index)
3271 define input_acl_set_interface
3276 u32 ip4_table_index;
3277 u32 ip6_table_index;
3282 /** \brief Set/unset input ACL interface response
3283 @param context - sender context, to match reply w/ request
3284 @param retval - return code for the request
3286 define input_acl_set_interface_reply
3292 /** \brief IPsec: Add/delete Security Policy Database
3293 @param client_index - opaque cookie to identify the sender
3294 @param context - sender context, to match reply w/ request
3295 @param is_add - add SPD if non-zero, else delete
3296 @param spd_id - SPD instance id (control plane allocated)
3299 define ipsec_spd_add_del
3307 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3308 @param context - returned sender context, to match reply w/ request
3309 @param retval - return code
3312 define ipsec_spd_add_del_reply
3318 /** \brief IPsec: Add/delete SPD from interface
3320 @param client_index - opaque cookie to identify the sender
3321 @param context - sender context, to match reply w/ request
3322 @param is_add - add security mode if non-zero, else delete
3323 @param sw_if_index - index of the interface
3324 @param spd_id - SPD instance id to use for lookups
3328 define ipsec_interface_add_del_spd
3338 /** \brief Reply for IPsec: Add/delete SPD from interface
3339 @param context - returned sender context, to match reply w/ request
3340 @param retval - return code
3343 define ipsec_interface_add_del_spd_reply
3349 /** \brief IPsec: Add/delete Security Policy Database entry
3351 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3353 @param client_index - opaque cookie to identify the sender
3354 @param context - sender context, to match reply w/ request
3355 @param is_add - add SPD if non-zero, else delete
3356 @param spd_id - SPD instance id (control plane allocated)
3357 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3358 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3359 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3360 @param remote_address_start - start of remote address range to match
3361 @param remote_address_stop - end of remote address range to match
3362 @param local_address_start - start of local address range to match
3363 @param local_address_stop - end of local address range to match
3364 @param protocol - protocol type to match [0 means any]
3365 @param remote_port_start - start of remote port range to match ...
3366 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3367 @param local_port_start - start of local port range to match ...
3368 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3369 @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)
3370 @param sa_id - SAD instance id (control plane allocated)
3374 define ipsec_spd_add_del_entry
3387 u8 remote_address_start[16];
3388 u8 remote_address_stop[16];
3389 u8 local_address_start[16];
3390 u8 local_address_stop[16];
3394 u16 remote_port_start;
3395 u16 remote_port_stop;
3396 u16 local_port_start;
3397 u16 local_port_stop;
3404 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3405 @param context - returned sender context, to match reply w/ request
3406 @param retval - return code
3409 define ipsec_spd_add_del_entry_reply
3415 /** \brief IPsec: Add/delete Security Association Database entry
3416 @param client_index - opaque cookie to identify the sender
3417 @param context - sender context, to match reply w/ request
3418 @param is_add - add SAD entry if non-zero, else delete
3420 @param sad_id - sad id
3422 @param spi - security parameter index
3424 @param protocol - 0 = AH, 1 = ESP
3426 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3427 @param crypto_key_length - length of crypto_key in bytes
3428 @param crypto_key - crypto keying material
3430 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3431 @param integrity_key_length - length of integrity_key in bytes
3432 @param integrity_key - integrity keying material
3434 @param use_extended_sequence_number - use ESN when non-zero
3436 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3437 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3438 @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
3439 @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
3443 IPsec tunnel address copy mode (to support GDOI)
3446 define ipsec_sad_add_del_entry
3458 u8 crypto_algorithm;
3459 u8 crypto_key_length;
3462 u8 integrity_algorithm;
3463 u8 integrity_key_length;
3464 u8 integrity_key[128];
3466 u8 use_extended_sequence_number;
3470 u8 tunnel_src_address[16];
3471 u8 tunnel_dst_address[16];
3474 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3475 @param context - returned sender context, to match reply w/ request
3476 @param retval - return code
3479 define ipsec_sad_add_del_entry_reply
3485 /** \brief IPsec: Update Security Association keys
3486 @param client_index - opaque cookie to identify the sender
3487 @param context - sender context, to match reply w/ request
3489 @param sa_id - sa id
3491 @param crypto_key_length - length of crypto_key in bytes
3492 @param crypto_key - crypto keying material
3494 @param integrity_key_length - length of integrity_key in bytes
3495 @param integrity_key - integrity keying material
3498 define ipsec_sa_set_key
3505 u8 crypto_key_length;
3508 u8 integrity_key_length;
3509 u8 integrity_key[128];
3512 /** \brief Reply for IPsec: Update Security Association keys
3513 @param context - returned sender context, to match reply w/ request
3514 @param retval - return code
3517 define ipsec_sa_set_key_reply
3523 /** \brief IKEv2: Add/delete profile
3524 @param client_index - opaque cookie to identify the sender
3525 @param context - sender context, to match reply w/ request
3527 @param name - IKEv2 profile name
3528 @param is_add - Add IKEv2 profile if non-zero, else delete
3530 define ikev2_profile_add_del
3539 /** \brief Reply for IKEv2: Add/delete profile
3540 @param context - returned sender context, to match reply w/ request
3541 @param retval - return code
3543 define ikev2_profile_add_del_reply
3549 /** \brief IKEv2: Set IKEv2 profile authentication method
3550 @param client_index - opaque cookie to identify the sender
3551 @param context - sender context, to match reply w/ request
3553 @param name - IKEv2 profile name
3554 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3555 @param is_hex - Authentication data in hex format if non-zero, else string
3556 @param data_len - Authentication data length
3557 @param data - Authentication data (for rsa-sig cert file path)
3559 define ikev2_profile_set_auth
3571 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3572 @param context - returned sender context, to match reply w/ request
3573 @param retval - return code
3575 define ikev2_profile_set_auth_reply
3581 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3582 @param client_index - opaque cookie to identify the sender
3583 @param context - sender context, to match reply w/ request
3585 @param name - IKEv2 profile name
3586 @param is_local - Identification is local if non-zero, else remote
3587 @param id_type - Identification type
3588 @param data_len - Identification data length
3589 @param data - Identification data
3591 define ikev2_profile_set_id
3603 /** \brief Reply for IKEv2:
3604 @param context - returned sender context, to match reply w/ request
3605 @param retval - return code
3607 define ikev2_profile_set_id_reply
3613 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3614 @param client_index - opaque cookie to identify the sender
3615 @param context - sender context, to match reply w/ request
3617 @param name - IKEv2 profile name
3618 @param is_local - Traffic selector is local if non-zero, else remote
3619 @param proto - Traffic selector IP protocol (if zero not relevant)
3620 @param start_port - The smallest port number allowed by traffic selector
3621 @param end_port - The largest port number allowed by traffic selector
3622 @param start_addr - The smallest address included in traffic selector
3623 @param end_addr - The largest address included in traffic selector
3625 define ikev2_profile_set_ts
3639 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3640 @param context - returned sender context, to match reply w/ request
3641 @param retval - return code
3643 define ikev2_profile_set_ts_reply
3649 /** \brief IKEv2: Set IKEv2 local RSA private key
3650 @param client_index - opaque cookie to identify the sender
3651 @param context - sender context, to match reply w/ request
3653 @param key_file - Key file absolute path
3655 define ikev2_set_local_key
3663 /** \brief Reply for IKEv2: Set IKEv2 local key
3664 @param context - returned sender context, to match reply w/ request
3665 @param retval - return code
3667 define ikev2_set_local_key_reply
3673 /** \brief Tell client about a DHCP completion event
3674 @param client_index - opaque cookie to identify the sender
3675 @param pid - client pid registered to receive notification
3676 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3677 @param host_address - Host IP address
3678 @param router_address - Router IP address
3679 @param host_mac - Host MAC address
3681 define dhcp_compl_event
3687 u8 host_address[16];
3688 u8 router_address[16];
3692 /** \brief Add MAP domains
3693 @param client_index - opaque cookie to identify the sender
3694 @param context - sender context, to match reply w/ request
3695 @param ip6_prefix - Rule IPv6 prefix
3696 @param ip4_prefix - Rule IPv4 prefix
3697 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3698 @param ip6_prefix_len - Rule IPv6 prefix length
3699 @param ip4_prefix_len - Rule IPv4 prefix length
3700 @param ea_bits_len - Embedded Address bits length
3701 @param psid_offset - Port Set Identifider (PSID) offset
3702 @param psid_length - PSID length
3703 @param is_translation - MAP-E / MAP-T
3706 define map_add_domain
3715 u8 ip6_src_prefix_len;
3723 /** \brief Reply for MAP domain add
3724 @param context - returned sender context, to match reply w/ request
3725 @param index - MAP domain index
3726 @param retval - return code
3728 define map_add_domain_reply
3735 /** \brief Delete MAP domain
3736 @param client_index - opaque cookie to identify the sender
3737 @param context - sender context, to match reply w/ request
3738 @param index - MAP Domain index
3740 define map_del_domain
3747 /** \brief Reply for MAP domain del
3748 @param context - returned sender context, to match reply w/ request
3749 @param retval - return code
3751 define map_del_domain_reply
3757 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3758 @param client_index - opaque cookie to identify the sender
3759 @param context - sender context, to match reply w/ request
3760 @param index - MAP Domain index
3761 @param is_add - If 1 add rule, if 0 delete rule
3762 @param ip6_dst - MAP CE IPv6 address
3763 @param psid - Rule PSID
3765 define map_add_del_rule
3775 /** \brief Reply for MAP rule add/del
3776 @param context - returned sender context, to match reply w/ request
3777 @param retval - return code
3779 define map_add_del_rule_reply
3785 /** \brief Get list of map domains
3786 @param client_index - opaque cookie to identify the sender
3788 define map_domain_dump
3794 define map_domain_details
3812 define map_rule_dump
3819 define map_rule_details
3826 /** \brief Request for a single block of summary stats
3827 @param client_index - opaque cookie to identify the sender
3828 @param context - sender context, to match reply w/ request
3830 define map_summary_stats
3836 /** \brief Reply for map_summary_stats request
3837 @param context - sender context, to match reply w/ request
3838 @param retval - return code for request
3839 @param total_bindings -
3841 @param total_ip4_fragments -
3842 @param total_security_check -
3844 define map_summary_stats_reply
3851 u64 total_ip4_fragments;
3852 u64 total_security_check[2];
3855 /** \brief cop: enable/disable junk filtration features on an interface
3856 @param client_index - opaque cookie to identify the sender
3857 @param context - sender context, to match reply w/ request
3858 @param sw_if_inded - desired interface
3859 @param enable_disable - 1 => enable, 0 => disable
3862 define cop_interface_enable_disable
3870 /** \brief cop: interface enable/disable junk filtration reply
3871 @param context - returned sender context, to match reply w/ request
3872 @param retval - return code
3875 define cop_interface_enable_disable_reply
3881 /** \brief cop: enable/disable whitelist filtration features on an interface
3882 Note: the supplied fib_id must match in order to remove the feature!
3884 @param client_index - opaque cookie to identify the sender
3885 @param context - sender context, to match reply w/ request
3886 @param sw_if_index - interface handle, physical interfaces only
3887 @param fib_id - fib identifier for the whitelist / blacklist fib
3888 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3889 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3890 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3893 define cop_whitelist_enable_disable
3904 /** \brief cop: interface enable/disable junk filtration reply
3905 @param context - returned sender context, to match reply w/ request
3906 @param retval - return code
3909 define cop_whitelist_enable_disable_reply
3915 /** \brief get_node_graph - get a copy of the vpp node graph
3916 including the current set of graph arcs.
3918 @param client_index - opaque cookie to identify the sender
3919 @param context - sender context, to match reply w/ request
3922 define get_node_graph
3928 /** \brief get_node_graph_reply
3929 @param context - returned sender context, to match reply w/ request
3930 @param retval - return code
3931 @param reply_in_shmem - result from vlib_node_serialize, in shared
3932 memory. Process with vlib_node_unserialize, remember to switch
3933 heaps and free the result.
3936 define get_node_graph_reply
3943 /** \brief Clear interface statistics
3944 @param client_index - opaque cookie to identify the sender
3945 @param context - sender context, to match reply w/ request
3946 @param sw_if_index - index of the interface to clear statistics
3948 define sw_interface_clear_stats
3955 /** \brief Reply to sw_interface_clear_stats
3956 @param context - sender context which was passed in the request
3957 @param retval - return code of the set flags request
3959 define sw_interface_clear_stats_reply
3965 /** \brief IOAM Trace : Set TRACE profile
3966 @param id - profile id
3967 @param trace_type - Trace type
3968 @param trace_num_elt - Number of nodes in trace path
3969 @param trace_ppc - Trace PPC (none/encap/decap)
3970 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3971 @param trace_app_data - Trace application data, can be any 4 bytes
3972 @param pow_enable - Proof of Work enabled or not flag
3973 @param node_id - Id of this node
3975 define trace_profile_add
3989 /** \brief Trace profile add / del response
3990 @param context - sender context, to match reply w/ request
3991 @param retval - return value for request
3993 define trace_profile_add_reply
3999 /** \brief IOAM Trace enable trace profile for a flow
4000 @param id - id of the trace profile to be applied
4001 @param dest_ipv6 - Destination IPv6 address
4002 @param prefix_length - prefix mask
4003 @param vrf_id - VRF ID
4004 @param trace_op - Trace operation (add/mod/del)
4005 @param enable - apply/remove the trace profile for the flow
4007 define trace_profile_apply
4019 /** \brief Trace profile apply response
4020 @param context - sender context, to match reply w/ request
4021 @param retval - return value for request
4023 define trace_profile_apply_reply
4029 /** \brief Delete Trace Profile
4030 @param client_index - opaque cookie to identify the sender
4031 @param context - sender context, to match reply w/ request
4032 @param index - MAP Domain index
4034 define trace_profile_del
4041 /** \brief Trace profile add / del response
4042 @param context - sender context, to match reply w/ request
4043 @param retval - return value for request
4045 define trace_profile_del_reply
4051 /** \brief Create host-interface
4052 @param client_index - opaque cookie to identify the sender
4053 @param context - sender context, to match reply w/ request
4054 @param host_if_name - interface name
4055 @param hw_addr - interface MAC
4056 @param use_random_hw_addr - use random generated MAC
4058 define af_packet_create
4063 u8 host_if_name[64];
4065 u8 use_random_hw_addr;
4068 /** \brief Create host-interface response
4069 @param context - sender context, to match reply w/ request
4070 @param retval - return value for request
4072 define af_packet_create_reply
4079 /** \brief Delete host-interface
4080 @param client_index - opaque cookie to identify the sender
4081 @param context - sender context, to match reply w/ request
4082 @param host_if_name - interface name
4084 define af_packet_delete
4089 u8 host_if_name[64];
4092 /** \brief Delete host-interface response
4093 @param context - sender context, to match reply w/ request
4094 @param retval - return value for request
4096 define af_packet_delete_reply
4102 /** \brief Add/del policer
4103 @param client_index - opaque cookie to identify the sender
4104 @param context - sender context, to match reply w/ request
4105 @param is_add - add policer if non-zero, else delete
4106 @param name - policer name
4109 @param cb - Committed Burst
4110 @param eb - Excess or Peak Burst
4111 @param rate_type - rate type
4112 @param round_type - rounding type
4113 @param type - policer algorithm
4114 @param color_aware - 0=color-blind, 1=color-aware
4115 @param conform_action_type - conform action type
4116 @param conform_dscp - DSCP for conform mar-and-transmit action
4117 @param exceed_action_type - exceed action type
4118 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4119 @param violate_action_type - violate action type
4120 @param violate_dscp - DSCP for violate mar-and-transmit action
4122 define policer_add_del
4137 u8 conform_action_type;
4139 u8 exceed_action_type;
4141 u8 violate_action_type;
4145 /** \brief Add/del policer response
4146 @param context - sender context, to match reply w/ request
4147 @param retval - return value for request
4148 @param policer_index - for add, returned index of the new policer
4150 define policer_add_del_reply
4157 /** \brief Get list of policers
4158 @param client_index - opaque cookie to identify the sender
4159 @param context - sender context, to match reply w/ request
4160 @param match_name_valid - if 0 request all policers otherwise use match_name
4161 @param match_name - policer name
4168 u8 match_name_valid;
4172 /** \brief Policer operational state response.
4173 @param context - sender context, to match reply w/ request
4174 @param name - policer name
4177 @param cb - Committed Burst
4178 @param eb - Excess or Peak Burst
4179 @param rate_type - rate type
4180 @param round_type - rounding type
4181 @param type - policer algorithm
4182 @param conform_action_type - conform action type
4183 @param conform_dscp - DSCP for conform mar-and-transmit action
4184 @param exceed_action_type - exceed action type
4185 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4186 @param violate_action_type - violate action type
4187 @param violate_dscp - DSCP for violate mar-and-transmit action
4188 @param single_rate - 1 = single rate policer, 0 = two rate policer
4189 @param color_aware - for hierarchical policing
4190 @param scale - power-of-2 shift amount for lower rates
4191 @param cir_tokens_per_period - number of tokens for each period
4192 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4193 @param current_limit - current limit
4194 @param current_bucket - current bucket
4195 @param extended_limit - extended limit
4196 @param extended_bucket - extended bucket
4197 @param last_update_time - last update time
4199 define policer_details
4211 u8 conform_action_type;
4213 u8 exceed_action_type;
4215 u8 violate_action_type;
4220 u32 cir_tokens_per_period;
4221 u32 pir_tokens_per_period;
4225 u32 extended_bucket;
4226 u64 last_update_time;
4229 /** \brief Set/unset policer classify interface
4230 @param client_index - opaque cookie to identify the sender
4231 @param context - sender context, to match reply w/ request
4232 @param sw_if_index - interface to set/unset policer classify
4233 @param ip4_table_index - ip4 classify table index (~0 for skip)
4234 @param ip6_table_index - ip6 classify table index (~0 for skip)
4235 @param l2_table_index - l2 classify table index (~0 for skip)
4236 @param is_add - Set if non-zero, else unset
4237 Note: User is recommeneded to use just one valid table_index per call.
4238 (ip4_table_index, ip6_table_index, or l2_table_index)
4240 define policer_classify_set_interface
4245 u32 ip4_table_index;
4246 u32 ip6_table_index;
4251 /** \brief Set/unset policer classify interface response
4252 @param context - sender context, to match reply w/ request
4253 @param retval - return value for request
4255 define policer_classify_set_interface_reply
4261 /** \brief Get list of policer classify interfaces and tables
4262 @param client_index - opaque cookie to identify the sender
4263 @param context - sender context, to match reply w/ request
4264 @param type - classify table type
4266 define policer_classify_dump
4273 /** \brief Policer iclassify operational state response.
4274 @param context - sender context, to match reply w/ request
4275 @param sw_if_index - software interface index
4276 @param table_index - classify table index
4278 define policer_classify_details
4285 /** \brief Create netmap
4286 @param client_index - opaque cookie to identify the sender
4287 @param context - sender context, to match reply w/ request
4288 @param netmap_if_name - interface name
4289 @param hw_addr - interface MAC
4290 @param use_random_hw_addr - use random generated MAC
4291 @param is_pipe - is pipe
4292 @param is_master - 0=slave, 1=master
4294 define netmap_create
4299 u8 netmap_if_name[64];
4301 u8 use_random_hw_addr;
4306 /** \brief Create netmap response
4307 @param context - sender context, to match reply w/ request
4308 @param retval - return value for request
4310 define netmap_create_reply
4316 /** \brief Delete netmap
4317 @param client_index - opaque cookie to identify the sender
4318 @param context - sender context, to match reply w/ request
4319 @param netmap_if_name - interface name
4321 define netmap_delete
4326 u8 netmap_if_name[64];
4329 /** \brief Delete netmap response
4330 @param context - sender context, to match reply w/ request
4331 @param retval - return value for request
4333 define netmap_delete_reply
4339 /** \brief Dump mpls gre tunnel table
4340 @param client_index - opaque cookie to identify the sender
4341 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4343 define mpls_gre_tunnel_dump
4350 /** \brief mpls gre tunnel operational state response
4351 @param tunnel_index - gre tunnel identifier
4352 @param intfc_address - interface ipv4 addr
4353 @param mask_width - interface ipv4 addr mask
4354 @param hw_if_index - interface id
4356 @param tunnel_src - tunnel source ipv4 addr
4357 @param tunnel_dst - tunnel destination ipv4 addr
4358 @param outer_fib_index - gre tunnel identifier
4359 @param encap_index - reference to mpls label table
4360 @param nlabels - number of resolved labels
4361 @param labels - resolved labels
4363 define mpls_gre_tunnel_details
4369 u32 inner_fib_index;
4376 u32 outer_fib_index;
4378 u32 labels[nlabels];
4381 /** \brief Dump mpls eth tunnel table
4382 @param client_index - opaque cookie to identify the sender
4383 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
4385 define mpls_eth_tunnel_dump
4392 /** \brief mpls eth tunnel operational state response
4393 @param tunnel_index - eth tunnel identifier
4394 @param intfc_address - interface ipv4 addr
4395 @param mask_width - interface ipv4 addr mask
4396 @param hw_if_index - interface id
4398 @param tunnel_dst_mac -
4399 @param tx_sw_if_index -
4400 @param encap_index - reference to mpls label table
4401 @param nlabels - number of resolved labels
4402 @param labels - resolved labels
4404 define mpls_eth_tunnel_details
4410 u32 inner_fib_index;
4415 u8 tunnel_dst_mac[6];
4418 u32 labels[nlabels];
4421 /** \brief Dump mpls fib table
4422 @param client_index - opaque cookie to identify the sender
4423 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4425 define mpls_fib_encap_dump
4431 /** \brief mpls fib encap table response
4432 @param fib_index - fib table id
4433 @param dest - destination ipv4 addr
4435 @param entry_index - reference to mpls label table
4436 @param nlabels - number of resolved labels
4437 @param labels - resolved labels
4439 define mpls_fib_encap_details
4448 u32 labels[nlabels];
4451 /** \brief Dump mpls fib decap table
4452 @param client_index - opaque cookie to identify the sender
4453 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4455 define mpls_fib_decap_dump
4461 /** \brief mpls fib decap table response
4462 @param fib_index - fib table id
4463 @param entry_index - reference to mpls label table
4464 @param dest - destination ipv4 addr
4466 @param label - mpls labels
4467 @param rx_table_id - rx fib id
4468 @param tx_table_id - tx fib id
4471 define mpls_fib_decap_details
4485 /** \brief Classify get table IDs request
4486 @param client_index - opaque cookie to identify the sender
4487 @param context - sender context, to match reply w/ request
4489 define classify_table_ids
4495 /** \brief Reply for classify get table IDs request
4496 @param context - sender context which was passed in the request
4497 @param count - number of ids returned in response
4498 @param ids - array of classify table ids
4500 define classify_table_ids_reply
4508 /** \brief Classify table ids by interface index request
4509 @param client_index - opaque cookie to identify the sender
4510 @param context - sender context, to match reply w/ request
4511 @param sw_if_index - index of the interface
4513 define classify_table_by_interface
4520 /** \brief Reply for classify table id by interface index request
4521 @param context - sender context which was passed in the request
4522 @param count - number of ids returned in response
4523 @param sw_if_index - index of the interface
4524 @param l2_table_id - l2 classify table index
4525 @param ip4_table_id - ip4 classify table index
4526 @param ip6_table_id - ip6 classify table index
4528 define classify_table_by_interface_reply
4538 /** \brief Classify table info
4539 @param client_index - opaque cookie to identify the sender
4540 @param context - sender context, to match reply w/ request
4541 @param table_id - classify table index
4543 define classify_table_info
4550 /** \brief Reply for classify table info request
4551 @param context - sender context which was passed in the request
4552 @param count - number of ids returned in response
4553 @param table_id - classify table index
4554 @param nbuckets - number of buckets when adding a table
4555 @param match_n_vectors - number of match vectors
4556 @param skip_n_vectors - number of skip_n_vectors
4557 @param active_sessions - number of sessions (active entries)
4558 @param next_table_index - index of next table
4559 @param miss_next_index - index of miss table
4560 @param mask[] - match mask
4562 define classify_table_info_reply
4568 u32 match_n_vectors;
4570 u32 active_sessions;
4571 u32 next_table_index;
4572 u32 miss_next_index;
4574 u8 mask[mask_length];
4577 /** \brief Classify sessions dump request
4578 @param client_index - opaque cookie to identify the sender
4579 @param context - sender context, to match reply w/ request
4580 @param table_id - classify table index
4582 define classify_session_dump
4589 /** \brief Reply for classify table session dump request
4590 @param context - sender context which was passed in the request
4591 @param count - number of ids returned in response
4592 @param table_id - classify table index
4593 @param hit_next_index - hit_next_index of session
4594 @param opaque_index - for add, opaque_index of session
4595 @param advance - advance value of session
4596 @param match[] - match value for session
4598 define classify_session_details
4607 u8 match[match_length];
4610 /** \brief Enable and configure IPFIX exporter process request
4611 @param client_index - opaque cookie to identify the sender
4612 @param context - sender context, to match reply w/ request
4613 @param collector_address - address of IPFIX collector
4614 @param collector_port - port of IPFIX IPFIX collector
4615 @param src_address - address of IPFIX exporter
4616 @param vrf_id - VRF / fib table ID
4617 @param path_mtu - Path MTU between exporter and collector
4618 @param template_interval - number of seconds after which to resend template
4624 u8 collector_address[16];
4629 u32 template_interval;
4632 /** \brief Reply to IPFIX enable and configure request
4633 @param context - sender context which was passed in the request
4635 define ipfix_enable_reply
4641 /** \brief IPFIX dump request
4642 @param client_index - opaque cookie to identify the sender
4643 @param context - sender context, to match reply w/ request
4651 /** \brief Reply to IPFIX dump request
4652 @param context - sender context which was passed in the request
4653 @param collector_address - address of IPFIX collector
4654 @param collector_port - port of IPFIX IPFIX collector
4655 @param src_address - address of IPFIX exporter
4656 @param fib_index - fib table index
4657 @param path_mtu - Path MTU between exporter and collector
4658 @param template_interval - number of seconds after which to resend template
4660 define ipfix_details
4663 u8 collector_address[16];
4668 u32 template_interval;
4671 /** \brief Query relative index via node names
4672 @param client_index - opaque cookie to identify the sender
4673 @param context - sender context, to match reply w/ request
4674 @param node_name - name of node to find relative index from
4675 @param next_name - next node from node_name to find relative index of
4677 define get_next_index
4685 /** \brief Reply for get next node index
4686 @param context - sender context which was passed in the request
4687 @param retval - return value
4688 @param next_index - index of the next_node
4690 define get_next_index_reply
4697 /** \brief PacketGenerator create interface request
4698 @param client_index - opaque cookie to identify the sender
4699 @param context - sender context, to match reply w/ request
4700 @param interface_id - interface index
4702 define pg_create_interface
4709 /** \brief PacketGenerator create interface response
4710 @param context - sender context, to match reply w/ request
4711 @param retval - return value for request
4713 define pg_create_interface_reply
4720 /** \brief PacketGenerator capture packets on given interface request
4721 @param client_index - opaque cookie to identify the sender
4722 @param context - sender context, to match reply w/ request
4723 @param interface_id - pg interface index
4724 @param is_enabled - 1 if enabling streams, 0 if disabling
4725 @param count - number of packets to be captured
4726 @param pcap_file - pacp file name to store captured packets
4735 u32 pcap_name_length;
4736 u8 pcap_file_name[pcap_name_length];
4739 /** \brief PacketGenerator capture packets response
4740 @param context - sender context, to match reply w/ request
4741 @param retval - return value for request
4743 define pg_capture_reply
4749 /** \brief Enable / disable packet generator request
4750 @param client_index - opaque cookie to identify the sender
4751 @param context - sender context, to match reply w/ request
4752 @param is_enabled - 1 if enabling streams, 0 if disabling
4753 @param stream - stream name to be enable/disabled, if not specified handle all streams
4755 define pg_enable_disable
4760 u32 stream_name_length;
4761 u8 stream_name[stream_name_length];
4764 /** \brief Reply for enable / disable packet generator
4765 @param context - returned sender context, to match reply w/ request
4766 @param retval - return code
4768 define pg_enable_disable_reply
4774 /** \brief Configure IP source and L4 port-range check
4775 @param client_index - opaque cookie to identify the sender
4776 @param context - sender context, to match reply w/ request
4777 @param is_ip6 - 1 if source address type is IPv6
4778 @param is_add - 1 if add, 0 if delete
4779 @param mask_length - mask length for address entry
4780 @param address - array of address bytes
4781 @param number_of_ranges - length of low_port and high_port arrays (must match)
4782 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
4783 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
4784 @param vrf_id - fib table/vrf id to associate the source and port-range check with
4785 @note To specify a single port set low_port and high_port entry the same
4787 define ip_source_and_port_range_check_add_del
4795 u8 number_of_ranges;
4801 /** \brief Configure IP source and L4 port-range check reply
4802 @param context - returned sender context, to match reply w/ request
4803 @param retval - return code
4805 define ip_source_and_port_range_check_add_del_reply
4811 /** \brief Set interface source and L4 port-range request
4812 @param client_index - opaque cookie to identify the sender
4813 @param context - sender context, to match reply w/ request
4814 @param interface_id - interface index
4815 @param tcp_vrf_id - VRF associated with source and TCP port-range check
4816 @param udp_vrf_id - VRF associated with source and TCP port-range check
4818 define ip_source_and_port_range_check_interface_add_del
4830 /** \brief Set interface source and L4 port-range response
4831 @param context - sender context, to match reply w/ request
4832 @param retval - return value for request
4834 define ip_source_and_port_range_check_interface_add_del_reply
4840 /** \brief Add / del ipsec gre tunnel request
4841 @param client_index - opaque cookie to identify the sender
4842 @param context - sender context, to match reply w/ request
4843 @param local_sa_id - local SA id
4844 @param remote_sa_id - remote SA id
4845 @param is_add - 1 if adding the tunnel, 0 if deleting
4846 @param src_address - tunnel source address
4847 @param dst_address - tunnel destination address
4849 define ipsec_gre_add_del_tunnel {
4859 /** \brief Reply for add / del ipsec gre tunnel request
4860 @param context - returned sender context, to match reply w/ request
4861 @param retval - return code
4862 @param sw_if_index - software index of the new ipsec gre tunnel
4864 define ipsec_gre_add_del_tunnel_reply {
4870 /** \brief Dump ipsec gre tunnel table
4871 @param client_index - opaque cookie to identify the sender
4872 @param context - sender context, to match reply w/ request
4873 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4875 define ipsec_gre_tunnel_dump {
4881 /** \brief mpls gre tunnel operational state response
4882 @param context - returned sender context, to match reply w/ request
4883 @param sw_if_index - software index of the ipsec gre tunnel
4884 @param local_sa_id - local SA id
4885 @param remote_sa_id - remote SA id
4886 @param src_address - tunnel source address
4887 @param dst_address - tunnel destination address
4889 define ipsec_gre_tunnel_details {
4898 /** \brief Delete sub interface request
4899 @param client_index - opaque cookie to identify the sender
4900 @param context - sender context, to match reply w/ request
4901 @param sw_if_index - sw index of the interface that was created by create_subif
4903 define delete_subif {
4909 /** \brief Delete sub interface response
4910 @param context - sender context, to match reply w/ request
4911 @param retval - return code for the request
4913 define delete_subif_reply {