This file defines vpp BIER control-plane API messages which are generally
called through a shared memory interface.
*/
-vl_api_version 1.0.0
+option version = "1.1.0";
+import "vnet/fib/fib_types.api";
/** \brief BIER Table Indentifier
- @param bt_set
- @param bt_sub_domain
- @param bt_bit_header_length
+ @param bt_set - The BIER set
+ @param bt_sub_domain - the sud-domain
+ @param bt_bit_header_length - the number of bits in the header length
*/
typeonly define bier_table_id
{
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param bt_tbl_id - The BIER table-id the route is added in
- @param bt_mpls_label - The MPLS label for the table
+ @param bt_label - The MPLS label for the table (0 or all ones means not set)
+ If the label is not set, then it is assumed that non-MPLS
+ encoding is used.
@param bt_is_add - Is this a route add or delete
*/
autoreply define bier_table_add_del
vl_api_bier_table_id_t bt_tbl_id;
};
-/** \brief FIB path
- @param sw_if_index - index of the interface
- @param weight - The weight, for UCMP
- @param preference - The preference of the path. lowest preference is prefered
- @param is_local - local if non-zero, else remote
- @param is_drop - Drop the packet
- @param is_unreach - Drop the packet and rate limit send ICMP unreachable
- @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
- @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
- @param next_hop[16] - the next hop address
-
- WARNING: this type is replicated, pending cleanup completion
-*/
-typeonly define fib_path3
-{
- u32 sw_if_index;
- u32 table_id;
- u8 weight;
- u8 preference;
- u8 is_local;
- u8 is_drop;
- u8 is_unreach;
- u8 is_prohibit;
- u8 afi;
- u8 next_hop[16];
- u32 rpf_id;
- u8 n_labels;
- u32 label_stack[16];
-};
-
/** \brief BIER Route Add / del route
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
{
u32 client_index;
u32 context;
- u16 br_bp;
+ u32 br_bp;
u8 br_is_add;
u8 br_is_replace;
vl_api_bier_table_id_t br_tbl_id;
u8 br_n_paths;
- vl_api_fib_path3_t br_paths[br_n_paths];
+ vl_api_fib_path_t br_paths[br_n_paths];
};
define bier_route_dump
define bier_route_details
{
- u32 client_index;
u32 context;
u16 br_bp;
vl_api_bier_table_id_t br_tbl_id;
u32 br_n_paths;
- vl_api_fib_path3_t br_paths[br_n_paths];
+ vl_api_fib_path_t br_paths[br_n_paths];
};
/** \brief BIER Imposition Add
@param context - sender context, to match reply w/ request
@param bi_tbl_id - The BIER table-id used to forward post encap
@param bi_src - The source Bit-position in the encap.
- @param bi_is_add - Is this a route add or delete
- @param bi_n_bytes - The number of bytes in the following bit-string
- @param bi_bytes - The bit-string represented as a byte array
+ @param bi_n_bytes - The number of bytes in the following bit-string.
+ VPP only supports BSL of 1024 and less, so this is
+ a u8 field.
+ @param bi_bytes - The bit-string represented as a byte array (MSB first)
*/
define bier_imp_add
{
u32 context;
vl_api_bier_table_id_t bi_tbl_id;
u16 bi_src;
- u8 bi_is_add;
u8 bi_n_bytes;
u8 bi_bytes[bi_n_bytes];
};
define bier_imp_details
{
- u32 client_index;
u32 context;
vl_api_bier_table_id_t bi_tbl_id;
u16 bi_src;
/** \brief BIER Disposition Entry Add / del
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param bde_bp - The Bit-position value for the entry
+ @param bde_bp - The Bit-position value for the entry, i.e. the sender's
+ Use 0 for the default (match any source) entry.
@param bde_tbl_id - The BIER dispositiontable-id the route is added in
@param bde_next_hop_sw_if_index - the nextop interface
@param bde_is_add - Is this a route add or delete
@param bde_payload_proto - The payload protocol for which the next-hop
is added
- @param bde_next_hop_table_id - The table ID for the next-hop
- @param bde_next_hop_proto_is_ip4 - The next-hop is IPV4
- @param bde_next_hop[16] - the nextop address.
- Set this to all 0s for dispostion.
+ @param bde_paths - The outgoing paths for the entry
*/
autoreply define bier_disp_entry_add_del
{
u8 bde_is_add;
u8 bde_payload_proto;
u8 bde_n_paths;
- vl_api_fib_path3_t bde_paths[bde_n_paths];
+ vl_api_fib_path_t bde_paths[bde_n_paths];
};
define bier_disp_entry_dump
u8 bde_is_add;
u8 bde_payload_proto;
u8 bde_n_paths;
- vl_api_fib_path3_t bde_paths[bde_n_paths];
+ vl_api_fib_path_t bde_paths[bde_n_paths];
};
/*
Code Review / vpp.git / blobdiff