/* Hey Emacs use -*- mode: C -*- */ /* * Copyright (c) 2018 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ option version = "3.2.2"; import "vnet/interface_types.api"; import "vnet/ethernet/ethernet_types.api"; import "vnet/ip/ip_types.api"; service { rpc want_interface_events returns want_interface_events_reply events sw_interface_event; }; /** \brief Set flags on the interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of the interface to set flags on @param flags - interface_status flags (only IF_STATUS_API_FLAG_ADMIN_UP used in config) */ autoreply define sw_interface_set_flags { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; vl_api_if_status_flags_t flags; }; /** \brief Set interface physical MTU @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of the interface to set MTU on @param mtu - MTU */ autoreply define hw_interface_set_mtu { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; u16 mtu; }; /** \brief Set interface L3 MTU */ autoreply define sw_interface_set_mtu { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; u32 mtu[4]; /* vl_api_mtu_proto_t 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */ }; /** \brief Set IP4 directed broadcast The directed broadcast enabled a packet sent to the interface's subnet address will be broadcast on the interface @param sw_if_index @param enable */ autoreply define sw_interface_set_ip_directed_broadcast { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; bool enable; }; /** \brief Interface Event generated by want_interface_events @param client_index - opaque cookie to identify the sender @param pid - client pid registered to receive notification @param sw_if_index - index of the interface of the event @param flags - interface_status flags @param deleted - interface was deleted */ define sw_interface_event { u32 client_index; u32 pid; vl_api_interface_index_t sw_if_index; vl_api_if_status_flags_t flags; bool deleted; }; /** \brief Register for interface events @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param enable_disable - 1 => register for events, 0 => cancel registration @param pid - sender's pid */ autoreply define want_interface_events { u32 client_index; u32 context; u32 enable_disable; u32 pid; }; /** \brief Interface details structure (fix this) @param sw_if_index - index of the interface @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index @param l2_address - the interface's l2 address @param flags - interface_status flags @param type - interface type @param link_duplex - 1 if half duplex, 2 if full duplex @param link_speed - value in kbps @param link_MTU - max. transmission unit @param sub_id - A number 0-N to uniquely identify this subif on super if @param sub_number_of_tags - Number of tags (0 - 2) @param sub_outer_vlan_id @param sub_inner_vlan_id @param sub_if_flags - sub interface flags @param vtr_op - vlan tag rewrite operation @param vtr_push_dot1q @param vtr_tag1 @param vtr_tag2 @param pbb_outer_tag - translate pbb s-tag @param pbb_b_dmac[6] - B-tag remote mac address @param pbb_b_smac[6] - B-tag local mac address @param pbb_b_vlanid - B-tag vlanid @param pbb_i_sid - I-tag service id @param interface_name - name of the interface @param interface_dev_type - device type of the interface @param tag - an ascii tag */ define sw_interface_details { u32 context; vl_api_interface_index_t sw_if_index; /* index of sup interface (e.g. hw interface). equal to sw_if_index for super hw interface. */ u32 sup_sw_if_index; /* Layer 2 address, if applicable */ vl_api_mac_address_t l2_address; vl_api_if_status_flags_t flags; vl_api_if_type_t type; /* 1 = half duplex, 2 = full duplex */ vl_api_link_duplex_t link_duplex; /* link speed in kbps */ u32 link_speed; /* MTU */ u16 link_mtu; /* Per protocol MTUs */ u32 mtu[4]; /* vl_api_mtu_proto_t 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */ /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */ u32 sub_id; /* Number of tags 0-2 */ u8 sub_number_of_tags; u16 sub_outer_vlan_id; u16 sub_inner_vlan_id; vl_api_sub_if_flags_t sub_if_flags; /* vlan tag rewrite state */ u32 vtr_op; u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad u32 vtr_tag1; // first pushed tag u32 vtr_tag2; // second pushed tag /* pbb tag rewrite info */ u16 outer_tag; vl_api_mac_address_t b_dmac; vl_api_mac_address_t b_smac; u16 b_vlanid; u32 i_sid; /* Interface name */ string interface_name[64]; string interface_dev_type[64]; string tag[64]; }; /** \brief Request all or filtered subset of sw_interface_details @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of the interface to dump info on, 0 or ~0 if on all TODO: Support selecting only index==0 when CSIT is ready. @param name_filter_valid - 1 if requesting a filtered subset of records else 0 if name filter is set as valid, sw_if_index value is ignored and all interfaces are examined @param name_filter - interface name substring filter. Eg. loop1 returns [loop1, loop10] */ define sw_interface_dump { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index [default=0xFFFFFFFF]; bool name_filter_valid; string name_filter[]; }; /** \brief Set or delete one or all ip addresses on a specified interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of the interface to add/del addresses @param is_add - add address if non-zero, else delete @param del_all - if non-zero delete all addresses on the interface @param prefix - address + a prefix length for the implied connected route */ autoreply define sw_interface_add_del_address { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; bool is_add; bool del_all; vl_api_address_with_prefix_t prefix; }; /** \brief IP interface address replace begin The use-case is that, for some unspecified reason, the control plane has a different set of interface addresses than VPP currently has. The CP would thus like to 'replace' VPP's set only by specifying what the new set shall be, i.e. it is not going to delete anything that already eixts, rather, is wants any unspecified interface addresses to be deleted implicitly. The CP declares the start of this procedure with this replace_begin API Call, and when it has populated all addresses it wants, it calls the below replace_end API. From this point on it is of course free to add and delete interface addresses as usual. The underlying mechanism by which VPP implements this replace is intentionally left unspecified. @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ autoreply define sw_interface_address_replace_begin { u32 client_index; u32 context; }; /** \brief IP interface address replace end see ip_interface_address_replace_begin description. @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ autoreply define sw_interface_address_replace_end { u32 client_index; u32 context; }; /** \brief Associate the specified interface with a fib table @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of the interface @param is_ipv6 - if non-zero ipv6, else ipv4 @param vrf_id - fib table/vrf id to associate the interface with */ autoreply define sw_interface_set_table { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; bool is_ipv6; u32 vrf_id; }; /** \brief Get VRF id assigned to interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of the interface */ define sw_interface_get_table { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; bool is_ipv6; }; /** \brief Reply to get_sw_interface_vrf @param context - sender context which was passed in the request @param vrf_id - VRF id assigned to the interface */ define sw_interface_get_table_reply { u32 context; i32 retval; u32 vrf_id; }; /** \brief Set unnumbered interface add / del request @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - interface with an IP address @param unnumbered_sw_if_index - interface which will use the address @param 
/*
 *------------------------------------------------------------------
 * l2e_api.c - layer 2 emulation api
 *
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF