src/vnet/srmpls/sr_mpls.api

   1 /*
   2  * Copyright (c) 2015-2016 Cisco and/or its affiliates. Licensed under the
   3  * Apache License, Version 2.0 (the "License"); you may not use this file
   4  * except in compliance with the License. You may obtain a copy of the
   5  * 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, WITHOUT
  11  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12  * License for the specific language governing permissions and limitations
  13  * under the License.
  14  */
  15
  16 option version = "1.0.0";
  17
  18 /** \brief MPLS SR policy add
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param bsid is the bindingSID of the SR Policy. MPLS label (20bit)
  22     @param weight is the weight of the sid list. optional.
  23     @param type is the type of the SR policy. (0.Default // 1.Spray)
  24     @param segments vector of labels (20bit) composing the segment list
  25 */
  26 autoreply define sr_mpls_policy_add
  27 {
  28   u32 client_index;
  29   u32 context;
  30   u32 bsid;
  31   u32 weight;
  32   u8 type;
  33   u8 n_segments;
  34   u32 segments[n_segments];
  35 };
  36
  37 /** \brief MPLS SR policy modification
  38     @param client_index - opaque cookie to identify the sender
  39     @param context - sender context, to match reply w/ request
  40     @param bsid is the bindingSID of the SR Policy. MPLS label (20bit)
  41     @param sr_policy_index is the index of the SR policy
  42     @param fib_table is the VRF where to install the FIB entry for the BSID
  43     @param operation is the operation to perform (among the top ones)
  44     @param segments is a vector of MPLS labels composing the segment list
  45     @param sl_index is the index of the Segment List to modify/delete
  46     @param weight is the weight of the sid list. optional.
  47     @param is_encap Mode. Encapsulation or SRH insertion.
  48 */
  49 autoreply define sr_mpls_policy_mod
  50 {
  51   u32 client_index;
  52   u32 context;
  53   u32 bsid;
  54   u8 operation;
  55   u32 sl_index;
  56   u32 weight;
  57   u8 n_segments;
  58   u32 segments[n_segments];
  59 };
  60
  61 /** \brief MPLS SR policy deletion
  62     @param client_index - opaque cookie to identify the sender
  63     @param context - sender context, to match reply w/ request
  64     @param bsid is the bindingSID of the SR Policy. MPLS label (20bit)
  65 */
  66 autoreply define sr_mpls_policy_del
  67 {
  68   u32 client_index;
  69   u32 context;
  70   u32 bsid;
  71 };
  72
  73 /** \brief MPLS SR steering add/del
  74     @param client_index - opaque cookie to identify the sender
  75     @param context - sender context, to match reply w/ request
  76     @param is_del
  77     @param bsid is the bindingSID of the SR Policy (~0 is no bsid)
  78     @param table_id is the VRF where to install the FIB entry for the BSID
  79     @param prefix is the IPv4/v6 address for L3 traffic type. If IPv4 (first 4B).
  80     @param mask_width is the mask for L3 traffic type
  81     @param sw_if_index is the incoming interface for L2 traffic
  82     @param traffic_type describes the type of traffic
  83     @param next_hop describes the next_hop (in case no BSID)
  84     @param nh_type describes type of NH (IPv4=4, IPv6=6)
  85     @param color describes the color
  86     @param co_bits are the CO_bits of the steering policy
  87     @param vpn_label is an additonal last VPN label. (~0 is no label)
  88 */
  89 autoreply define sr_mpls_steering_add_del
  90 {
  91   u32 client_index;
  92   u32 context;
  93   u8 is_del;
  94   u32 bsid;
  95   u32 table_id;
  96   u8 prefix_addr[16];
  97   u32 mask_width;
  98   u8 traffic_type;
  99   u8 next_hop[16];
 100   u8 nh_type;
 101   u32 color;
 102   u8 co_bits;
 103   u32 vpn_label;
 104 };
 105
 106 /** \brief MPLS SR steering add/del
 107     @param client_index - opaque cookie to identify the sender
 108     @param context - sender context, to match reply w/ request
 109     @param bsid is the bindingSID of the SR Policy
 110     @param endpoint is the endpoint of the SR policy
 111     @param endpoint_type describes type of NH (IPv4=4, IPv6=6)
 112     @param color is the color of the sr policy
 113 */
 114 autoreply define sr_mpls_policy_assign_endpoint_color
 115 {
 116   u32 client_index;
 117   u32 context;
 118   u32 bsid;
 119   u8 endpoint[16];
 120   u8 endpoint_type;
 121   u32 color;
 122 };
 123
 124 /*
 125  * fd.io coding-style-patch-verification: ON Local Variables: eval:
 126  * (c-set-style "gnu") End:
 127  */