src/vnet/fib/fib_types.api

   1 /*
   2  * Copyright (c) 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 MPLS label
  17 */
  18 typeonly define fib_mpls_label
  19 {
  20   u8 is_uniform;
  21   u32 label;
  22   u8 ttl;
  23   u8 exp;
  24 };
  25
  26 /** \brief FIB path
  27     @param sw_if_index - index of the interface
  28     @param weight - The weight, for UCMP
  29     @param preference - The preference of the path. lowest preference
  30     is prefered
  31     @param is_local - local if non-zero, else remote
  32     @param is_drop - Drop the packet
  33     @param is_unreach - Drop the packet and rate limit send ICMP unreachable
  34     @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
  35     @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
  36     @param is_dvr - Does the route resolve via a DVR interface.
  37     @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup
  38                               in another table) is the lookup on the packet's
  39                               source address or destination.
  40     @param afi - dpo_proto_t protocol that describes the next-hop address
  41     @param via_label - The next-hop is a resolved via a local label
  42     @param next_hop[16] - the next hop address
  43     @param next_hop_id - Used when the path resolves via an object
  44                          that has a unique identifier. e.g. the UDP
  45                          encap object
  46 */
  47 typeonly define fib_path
  48 {
  49   u32 sw_if_index;
  50   u32 table_id;
  51   u8 weight;
  52   u8 preference;
  53   u8 is_local;
  54   u8 is_drop;
  55   u8 is_udp_encap;
  56   u8 is_unreach;
  57   u8 is_prohibit;
  58   u8 is_resolve_host;
  59   u8 is_resolve_attached;
  60   u8 is_dvr;
  61   u8 is_source_lookup;
  62   u8 is_interface_rx;
  63   u8 afi;
  64   u8 next_hop[16];
  65   u32 next_hop_id;
  66   u32 rpf_id;
  67   u32 via_label;
  68   u8 n_labels;
  69   vl_api_fib_mpls_label_t label_stack[16];
  70 };