src/vnet/mpls/mpls.api

   1 /*
   2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 /** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
  17            a per-prefix label entry.
  18     @param client_index - opaque cookie to identify the sender
  19     @param context - sender context, to match reply w/ request
  20     @param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
  21     @param mb_label - The MPLS label value to bind
  22     @param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
  23     @param mb_create_table_if_needed - Create either/both tables if required.
  24     @param mb_is_bind - Bind or unbind
  25     @param mb_is_ip4 - The prefix to bind to is IPv4
  26     @param mb_address_length - Length of IP prefix
  27     @param mb_address[16] - IP prefix/
  28 */
  29 define mpls_ip_bind_unbind
  30 {
  31   u32 client_index;
  32   u32 context;
  33   u32 mb_mpls_table_id;
  34   u32 mb_label;
  35   u32 mb_ip_table_id;
  36   u8 mb_create_table_if_needed;
  37   u8 mb_is_bind;
  38   u8 mb_is_ip4;
  39   u8 mb_address_length;
  40   u8 mb_address[16];
  41 };
  42
  43 /** \brief Reply for MPLS IP bind/unbind request
  44     @param context - returned sender context, to match reply w/ request
  45     @param retval - return code
  46 */
  47 define mpls_ip_bind_unbind_reply
  48 {
  49   u32 context;
  50   i32 retval;
  51 };
  52
  53 /** \brief MPLS tunnel Add / del route
  54     @param client_index - opaque cookie to identify the sender
  55     @param context - sender context, to match reply w/ request
  56     @param mt_is_add - Is this a route add or delete
  57     @param mt_sw_if_index - The SW interface index of the tunnel to delete
  58     @param mt_is_multicast - Is the tunnel's underlying LSP multicast
  59     @param mt_next_hop_proto_is_ip4 - The next-hop is IPV4
  60     @param mt_next_hop_weight - The weight, for UCMP
  61     @param mt_next_hop[16] - the nextop address
  62     @param mt_next_hop_sw_if_index - the next-hop SW interface
  63     @param mt_next_hop_table_id - the next-hop table-id (if appropriate)
  64     @param mt_next_hop_n_out_labels - the number of next-hop output labels
  65     @param mt_next_hop_out_label_stack - the next-hop output label stack,  outer most first
  66 */
  67 define mpls_tunnel_add_del
  68 {
  69   u32 client_index;
  70   u32 context;
  71   u32 mt_sw_if_index;
  72   u8 mt_is_add;
  73   u8 mt_l2_only;
  74   u8 mt_is_multicast;
  75   u8 mt_next_hop_proto_is_ip4;
  76   u8 mt_next_hop_weight;
  77   u8 mt_next_hop[16];
  78   u8 mt_next_hop_n_out_labels;
  79   u32 mt_next_hop_sw_if_index;
  80   u32 mt_next_hop_table_id;
  81   u32 mt_next_hop_out_label_stack[mt_next_hop_n_out_labels];
  82 };
  83
  84 /** \brief Reply for MPLS tunnel add / del request
  85     @param context - returned sender context, to match reply w/ request
  86     @param retval - return code
  87     @param sw_if_index - SW interface index of the tunnel created
  88 */
  89 define mpls_tunnel_add_del_reply
  90 {
  91   u32 context;
  92   i32 retval;
  93   u32 sw_if_index;
  94 };
  95
  96 /** \brief Dump mpls eth tunnel table
  97     @param client_index - opaque cookie to identify the sender
  98     @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
  99 */
 100 define mpls_tunnel_dump
 101 {
 102   u32 client_index;
 103   u32 context;
 104   i32 tunnel_index;
 105 };
 106
 107 /** \brief FIB path
 108     @param sw_if_index - index of the interface
 109     @param weight - The weight, for UCMP
 110     @param is_local - local if non-zero, else remote
 111     @param is_drop - Drop the packet
 112     @param is_unreach - Drop the packet and rate limit send ICMP unreachable
 113     @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
 114     @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
 115     @param next_hop[16] - the next hop address
 116
 117     WARNING: this type is replicated, pending cleanup completion
 118
 119 */
 120 typeonly manual_print manual_endian define fib_path2
 121 {
 122   u32 sw_if_index;
 123   u32 weight;
 124   u8 is_local;
 125   u8 is_drop;
 126   u8 is_unreach;
 127   u8 is_prohibit;
 128   u8 afi;
 129   u8 next_hop[16];
 130   u32 labels[16];
 131 };
 132
 133 /** \brief mpls tunnel details
 134 */
 135 manual_endian manual_print define mpls_tunnel_details
 136 {
 137   u32 context;
 138   u8 mt_sw_if_index;
 139   u8 mt_tunnel_index;
 140   u8 mt_l2_only;
 141   u8 mt_is_multicast;
 142   u32 mt_count;
 143   vl_api_fib_path2_t mt_paths[mt_count];
 144 };
 145
 146 /** \brief MPLS Route Add / del route
 147     @param client_index - opaque cookie to identify the sender
 148     @param context - sender context, to match reply w/ request
 149     @param mr_label - The MPLS label value
 150     @param mr_eos - The End of stack bit
 151     @param mr_table_id - The MPLS table-id the route is added in
 152     @param mr_classify_table_index - If this is a classify route,
 153                                      this is the classify table index
 154     @param  mr_create_table_if_needed - If the MPLS or IP tables do not exist,
 155                                         create them
 156     @param mr_is_add - Is this a route add or delete
 157     @param mr_is_classify - Is this route result a classify
 158     @param mr_is_multicast - Is this a multicast route
 159     @param mr_is_multipath - Is this route update a multipath - i.e. is this
 160                              a path addition to an existing route
 161     @param mr_is_resolve_host - Recurse resolution constraint via a host prefix
 162     @param mr_is_resolve_attached - Recurse resolution constraint via attached prefix
 163     @param mr_is_interface_rx - Interface Receive path
 164     @param mr_is_interface_rx - RPF-ID Receive path. The next-hop interface
 165                                 is used as the RPF-ID
 166     @param mr_next_hop_proto_is_ip4 - The next-hop is IPV4
 167     @param mr_next_hop_weight - The weight, for UCMP
 168     @param mr_next_hop[16] - the nextop address
 169     @param mr_next_hop_sw_if_index - the next-hop SW interface
 170     @param mr_next_hop_table_id - the next-hop table-id (if appropriate)
 171     @param mr_next_hop_n_out_labels - the number of labels in the label stack
 172     @param mr_next_hop_out_label_stack - the next-hop output label stack, outer most first
 173     @param next_hop_via_label - The next-hop is a resolved via a local label
 174 */
 175 define mpls_route_add_del
 176 {
 177   u32 client_index;
 178   u32 context;
 179   u32 mr_label;
 180   u8 mr_eos;
 181   u32 mr_table_id;
 182   u32 mr_classify_table_index;
 183   u8 mr_create_table_if_needed;
 184   u8 mr_is_add;
 185   u8 mr_is_classify;
 186   u8 mr_is_multicast;
 187   u8 mr_is_multipath;
 188   u8 mr_is_resolve_host;
 189   u8 mr_is_resolve_attached;
 190   u8 mr_is_interface_rx;
 191   u8 mr_is_rpf_id;
 192   u8 mr_next_hop_proto_is_ip4;
 193   u8 mr_next_hop_weight;
 194   u8 mr_next_hop[16];
 195   u8 mr_next_hop_n_out_labels;
 196   u32 mr_next_hop_sw_if_index;
 197   u32 mr_next_hop_table_id;
 198   u32 mr_next_hop_via_label;
 199   u32 mr_next_hop_out_label_stack[mr_next_hop_n_out_labels];
 200 };
 201
 202 /** \brief Reply for MPLS route add / del request
 203     @param context - returned sender context, to match reply w/ request
 204     @param retval - return code
 205 */
 206 define mpls_route_add_del_reply
 207 {
 208   u32 context;
 209   i32 retval;
 210 };
 211
 212 /** \brief Dump MPLS fib table
 213     @param client_index - opaque cookie to identify the sender
 214 */
 215 define mpls_fib_dump
 216 {
 217   u32 client_index;
 218   u32 context;
 219 };
 220
 221 /** \brief mpls FIB table response
 222     @param table_id - MPLS fib table id
 223     @param s_bit - End-of-stack bit
 224     @param label - MPLS label value
 225     @param count - the number of fib_path in path
 226     @param path  - array of of fib_path structures
 227 */
 228 manual_endian manual_print define mpls_fib_details
 229 {
 230   u32 context;
 231   u32 table_id;
 232   u8  eos_bit;
 233   u32 label;
 234   u32 count;
 235   vl_api_fib_path2_t path[count];
 236 };
 237
 238 /*
 239  * Local Variables:
 240  * eval: (c-set-style "gnu")
 241  * End:
 242  */
 243