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