src/vnet/srv6/sr.h

   1 /*
   2  * Copyright (c) 2015 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 /**
  17  * @file
  18  * @brief Segment Routing data structures definitions
  19  *
  20  */
  21
  22 #ifndef included_vnet_srv6_h
  23 #define included_vnet_srv6_h
  24
  25 #include <vnet/vnet.h>
  26 #include <vnet/srv6/sr_packet.h>
  27 #include <vnet/ip/ip6_packet.h>
  28 #include <vnet/ethernet/ethernet.h>
  29
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #define IPv6_DEFAULT_HEADER_LENGTH 40
  34 #define IPv6_DEFAULT_HOP_LIMIT 64
  35 #define IPv6_DEFAULT_MAX_MASK_WIDTH 128
  36
  37 #define SR_BEHAVIOR_END 1
  38 #define SR_BEHAVIOR_X 2
  39 #define SR_BEHAVIOR_T 3
  40 #define SR_BEHAVIOR_D_FIRST 4   /* Unused. Separator in between regular and D */
  41 #define SR_BEHAVIOR_DX2 5
  42 #define SR_BEHAVIOR_DX6 6
  43 #define SR_BEHAVIOR_DX4 7
  44 #define SR_BEHAVIOR_DT6 8
  45 #define SR_BEHAVIOR_DT4 9
  46 #define SR_BEHAVIOR_LAST 10     /* Must always be the last one */
  47
  48 #define SR_STEER_L2 2
  49 #define SR_STEER_IPV4 4
  50 #define SR_STEER_IPV6 6
  51
  52 #define SR_FUNCTION_SIZE 4
  53 #define SR_ARGUMENT_SIZE 4
  54
  55 #define SR_SEGMENT_LIST_WEIGHT_DEFAULT 1
  56
  57 /**
  58  * @brief SR Segment List (SID list)
  59  */
  60 typedef struct
  61 {
  62   ip6_address_t *segments;              /**< SIDs (key) */
  63
  64   u32 weight;                                           /**< SID list weight (wECMP / UCMP) */
  65
  66   u8 *rewrite;                                  /**< Precomputed rewrite header */
  67   u8 *rewrite_bsid;                             /**< Precomputed rewrite header for bindingSID */
  68
  69   dpo_id_t bsid_dpo;                            /**< DPO for Encaps/Insert for BSID */
  70   dpo_id_t ip6_dpo;                             /**< DPO for Encaps/Insert IPv6 */
  71   dpo_id_t ip4_dpo;                             /**< DPO for Encaps IPv6 */
  72 } ip6_sr_sl_t;
  73
  74 /* SR policy types */
  75 #define SR_POLICY_TYPE_DEFAULT 0
  76 #define SR_POLICY_TYPE_SPRAY 1
  77 /**
  78  * @brief SR Policy
  79  */
  80 typedef struct
  81 {
  82   u32 *segments_lists;          /**< SID lists indexes (vector) */
  83
  84   ip6_address_t bsid;                   /**< BindingSID (key) */
  85
  86   u8 type;                                      /**< Type (default is 0) */
  87   /* SR Policy specific DPO                                       */
  88   /* IF Type = DEFAULT Then Load Balancer DPO among SID lists     */
  89   /* IF Type = SPRAY then Spray DPO with all SID lists            */
  90   dpo_id_t bsid_dpo;                    /**< SR Policy specific DPO - BSID */
  91   dpo_id_t ip4_dpo;                     /**< SR Policy specific DPO - IPv6 */
  92   dpo_id_t ip6_dpo;                     /**< SR Policy specific DPO - IPv4 */
  93
  94   u32 fib_table;                        /**< FIB table */
  95
  96   u8 is_encap;                          /**< Mode (0 is SRH insert, 1 Encaps) */
  97 } ip6_sr_policy_t;
  98
  99 /**
 100  * @brief SR LocalSID
 101  */
 102 typedef struct
 103 {
 104   ip6_address_t localsid;               /**< LocalSID IPv6 address */
 105
 106   char end_psp;                                 /**< Combined with End.PSP? */
 107
 108   u16 behavior;                                 /**< Behavior associated to this localsid */
 109
 110   union
 111   {
 112     u32 sw_if_index;                            /**< xconnect only */
 113     u32 vrf_index;                              /**< vrf only */
 114   };
 115
 116   u32 fib_table;                                /**< FIB table where localsid is registered */
 117
 118   u32 vlan_index;                               /**< VLAN tag (not an index) */
 119
 120   ip46_address_t next_hop;              /**< Next_hop for xconnect usage only */
 121
 122   u32 nh_adj;                                           /**< Next_adj for xconnect usage only */
 123
 124   void *plugin_mem;                             /**< Memory to be used by the plugin callback functions */
 125 } ip6_sr_localsid_t;
 126
 127 typedef int (sr_plugin_callback_t) (ip6_sr_localsid_t * localsid);
 128
 129 /**
 130  * @brief SR LocalSID behavior registration
 131  */
 132 typedef struct
 133 {
 134   u16 sr_localsid_function_number;                      /**< SR LocalSID plugin function (>SR_BEHAVIOR_LAST) */
 135
 136   u8 *function_name;                                                    /**< Function name. (key). */
 137
 138   u8 *keyword_str;                                                      /**< Behavior keyword (i.e. End.X) */
 139
 140   u8 *def_str;                                                          /**< Behavior definition (i.e. Endpoint with cross-connect) */
 141
 142   u8 *params_str;                                                       /**< Behavior parameters (i.e. <oif> <IP46next_hop>) */
 143
 144   dpo_type_t dpo;                                                       /**< DPO type registration */
 145
 146   format_function_t *ls_format;                         /**< LocalSID format function */
 147
 148   unformat_function_t *ls_unformat;                     /**< LocalSID unformat function */
 149
 150   sr_plugin_callback_t *creation;                       /**< Function within plugin that will be called after localsid creation*/
 151
 152   sr_plugin_callback_t *removal;                        /**< Function within plugin that will be called before localsid removal */
 153 } sr_localsid_fn_registration_t;
 154
 155 /**
 156  * @brief Steering db key
 157  *
 158  * L3 is IPv4/IPv6 + mask
 159  * L2 is sf_if_index + vlan
 160  */
 161 typedef struct
 162 {
 163   union
 164   {
 165     struct
 166     {
 167       ip46_address_t prefix;                    /**< IP address of the prefix */
 168       u32 mask_width;                                   /**< Mask width of the prefix */
 169       u32 fib_table;                                    /**< VRF of the prefix */
 170     } l3;
 171     struct
 172     {
 173       u32 sw_if_index;                                  /**< Incoming software interface */
 174     } l2;
 175   };
 176   u8 traffic_type;                                      /**< Traffic type (IPv4, IPv6, L2) */
 177   u8 padding[3];
 178 } sr_steering_key_t;
 179
 180 typedef struct
 181 {
 182   sr_steering_key_t classify;           /**< Traffic classification */
 183   u32 sr_policy;                                        /**< SR Policy index */
 184 } ip6_sr_steering_policy_t;
 185
 186 /**
 187  * @brief Segment Routing main datastructure
 188  */
 189 typedef struct
 190 {
 191   /* L2-input -> SR rewrite next index */
 192   u32 l2_sr_policy_rewrite_index;
 193
 194   /* SR SID lists */
 195   ip6_sr_sl_t *sid_lists;
 196
 197   /* SRv6 policies */
 198   ip6_sr_policy_t *sr_policies;
 199
 200   /* Hash table mapping BindingSID to SRv6 policy */
 201   mhash_t sr_policies_index_hash;
 202
 203   /* Pool of SR localsid instances */
 204   ip6_sr_localsid_t *localsids;
 205
 206   /* Hash table mapping LOC:FUNC to SR LocalSID instance */
 207   mhash_t sr_localsids_index_hash;
 208
 209   /* Pool of SR steer policies instances */
 210   ip6_sr_steering_policy_t *steer_policies;
 211
 212   /* Hash table mapping steering rules to SR steer instance */
 213   mhash_t sr_steer_policies_hash;
 214
 215   /* L2 steering ifaces - sr_policies */
 216   u32 *sw_iface_sr_policies;
 217
 218   /* Spray DPO */
 219   dpo_type_t sr_pr_spray_dpo_type;
 220
 221   /* Plugin functions */
 222   sr_localsid_fn_registration_t *plugin_functions;
 223
 224   /* Find plugin function by name */
 225   uword *plugin_functions_by_key;
 226
 227   /* Counters */
 228   vlib_combined_counter_main_t sr_ls_valid_counters;
 229   vlib_combined_counter_main_t sr_ls_invalid_counters;
 230
 231   /* SR Policies FIBs */
 232   u32 fib_table_ip6;
 233   u32 fib_table_ip4;
 234
 235   /* convenience */
 236   vlib_main_t *vlib_main;
 237   vnet_main_t *vnet_main;
 238 } ip6_sr_main_t;
 239
 240 extern ip6_sr_main_t sr_main;
 241
 242 extern vlib_node_registration_t sr_policy_rewrite_encaps_node;
 243 extern vlib_node_registration_t sr_policy_rewrite_insert_node;
 244 extern vlib_node_registration_t sr_localsid_node;
 245 extern vlib_node_registration_t sr_localsid_d_node;
 246
 247 extern void sr_dpo_lock (dpo_id_t * dpo);
 248 extern void sr_dpo_unlock (dpo_id_t * dpo);
 249
 250 extern int
 251 sr_localsid_register_function (vlib_main_t * vm, u8 * fn_name,
 252                                u8 * keyword_str, u8 * def_str,
 253                                u8 * params_str, dpo_type_t * dpo,
 254                                format_function_t * ls_format,
 255                                unformat_function_t * ls_unformat,
 256                                sr_plugin_callback_t * creation_fn,
 257                                sr_plugin_callback_t * removal_fn);
 258
 259 extern int
 260 sr_policy_add (ip6_address_t * bsid, ip6_address_t * segments,
 261                u32 weight, u8 behavior, u32 fib_table, u8 is_encap);
 262 extern int
 263 sr_policy_mod (ip6_address_t * bsid, u32 index, u32 fib_table,
 264                u8 operation, ip6_address_t * segments, u32 sl_index,
 265                u32 weight);
 266 extern int sr_policy_del (ip6_address_t * bsid, u32 index);
 267
 268 extern int
 269 sr_cli_localsid (char is_del, ip6_address_t * localsid_addr,
 270                  char end_psp, u8 behavior, u32 sw_if_index,
 271                  u32 vlan_index, u32 fib_table, ip46_address_t * nh_addr,
 272                  void *ls_plugin_mem);
 273
 274 extern int
 275 sr_steering_policy (int is_del, ip6_address_t * bsid, u32 sr_policy_index,
 276                     u32 table_id, ip46_address_t * prefix, u32 mask_width,
 277                     u32 sw_if_index, u8 traffic_type);
 278
 279 extern void sr_set_source (ip6_address_t * address);
 280
 281 extern void sr_set_hop_limit (u8 hop_limit);
 282 extern u8 sr_get_hop_limit (void);
 283
 284 /**
 285  * @brief SR rewrite string computation for SRH insertion (inline)
 286  *
 287  * @param sl is a vector of IPv6 addresses composing the Segment List
 288  *
 289  * @return precomputed rewrite string for SRH insertion
 290  */
 291 static inline u8 *
 292 ip6_sr_compute_rewrite_string_insert (ip6_address_t * sl)
 293 {
 294   ip6_sr_header_t *srh;
 295   ip6_address_t *addrp, *this_address;
 296   u32 header_length = 0;
 297   u8 *rs = NULL;
 298
 299   header_length = 0;
 300   header_length += sizeof (ip6_sr_header_t);
 301   header_length += (vec_len (sl) + 1) * sizeof (ip6_address_t);
 302
 303   vec_validate (rs, header_length - 1);
 304
 305   srh = (ip6_sr_header_t *) rs;
 306   srh->type = ROUTING_HEADER_TYPE_SR;
 307   srh->segments_left = vec_len (sl);
 308   srh->last_entry = vec_len (sl);
 309   srh->length = ((sizeof (ip6_sr_header_t) +
 310                   ((vec_len (sl) + 1) * sizeof (ip6_address_t))) / 8) - 1;
 311   srh->flags = 0x00;
 312   srh->tag = 0x0000;
 313   addrp = srh->segments + vec_len (sl);
 314   vec_foreach (this_address, sl)
 315   {
 316     clib_memcpy_fast (addrp->as_u8, this_address->as_u8,
 317                       sizeof (ip6_address_t));
 318     addrp--;
 319   }
 320   return rs;
 321 }
 322
 323
 324 #endif /* included_vnet_sr_h */
 325
 326 /*
 327  * fd.io coding-style-patch-verification: ON
 328  *
 329  * Local Variables:
 330  * eval: (c-set-style "gnu")
 331  * End:
 332  */