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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @brief Segment Routing data structures definitions
22 #ifndef included_vnet_srv6_h
23 #define included_vnet_srv6_h
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>
33 #define IPv6_DEFAULT_HEADER_LENGTH 40
34 #define IPv6_DEFAULT_HOP_LIMIT 64
35 #define IPv6_DEFAULT_MAX_MASK_WIDTH 128
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_END_UN_PERF 10
47 #define SR_BEHAVIOR_END_UN 11
48 #define SR_BEHAVIOR_LAST 12 /* Must always be the last one */
51 #define SR_STEER_IPV4 4
52 #define SR_STEER_IPV6 6
54 #define SR_FUNCTION_SIZE 4
55 #define SR_ARGUMENT_SIZE 4
57 #define SR_SEGMENT_LIST_WEIGHT_DEFAULT 1
64 } __attribute__ ((packed)) ip6srv_combo_header_t;
68 * @brief SR Segment List (SID list)
72 ip6_address_t *segments; /**< SIDs (key) */
74 u32 weight; /**< SID list weight (wECMP / UCMP) */
76 u8 *rewrite; /**< Precomputed rewrite header */
77 u8 *rewrite_bsid; /**< Precomputed rewrite header for bindingSID */
79 dpo_id_t bsid_dpo; /**< DPO for Encaps/Insert for BSID */
80 dpo_id_t ip6_dpo; /**< DPO for Encaps/Insert IPv6 */
81 dpo_id_t ip4_dpo; /**< DPO for Encaps IPv6 */
88 #define SR_POLICY_TYPE_DEFAULT 0
89 #define SR_POLICY_TYPE_SPRAY 1
95 u32 *segments_lists; /**< SID lists indexes (vector) */
97 ip6_address_t bsid; /**< BindingSID (key) */
99 u8 type; /**< Type (default is 0) */
100 /* SR Policy specific DPO */
101 /* IF Type = DEFAULT Then Load Balancer DPO among SID lists */
102 /* IF Type = SPRAY then Spray DPO with all SID lists */
103 dpo_id_t bsid_dpo; /**< SR Policy specific DPO - BSID */
104 dpo_id_t ip4_dpo; /**< SR Policy specific DPO - IPv6 */
105 dpo_id_t ip6_dpo; /**< SR Policy specific DPO - IPv4 */
107 u32 fib_table; /**< FIB table */
109 u8 is_encap; /**< Mode (0 is SRH insert, 1 Encaps) */
115 typedef int (sr_p_plugin_callback_t) (ip6_sr_policy_t * sr);
122 ip6_address_t localsid; /**< LocalSID IPv6 address */
124 u16 localsid_prefix_len;
126 char end_psp; /**< Combined with End.PSP? */
128 u16 behavior; /**< Behavior associated to this localsid */
132 u32 sw_if_index; /**< xconnect only */
133 u32 vrf_index; /**< vrf only */
136 u32 fib_table; /**< FIB table where localsid is registered */
138 u32 vlan_index; /**< VLAN tag (not an index) */
140 ip46_address_t next_hop; /**< Next_hop for xconnect usage only */
142 u32 nh_adj; /**< Next_adj for xconnect usage only */
144 ip6_address_t usid_block;
145 ip6_address_t usid_block_mask;
153 void *plugin_mem; /**< Memory to be used by the plugin callback functions */
156 typedef int (sr_plugin_callback_t) (ip6_sr_localsid_t * localsid);
159 * @brief SR LocalSID behavior registration
163 u16 sr_localsid_function_number; /**< SR LocalSID plugin function (>SR_BEHAVIOR_LAST) */
165 u8 *function_name; /**< Function name. (key). */
167 u8 *keyword_str; /**< Behavior keyword (i.e. End.X) */
169 u8 *def_str; /**< Behavior definition (i.e. Endpoint with cross-connect) */
171 u8 *params_str; /**< Behavior parameters (i.e. <oif> <IP46next_hop>) */
175 dpo_type_t dpo; /**< DPO type registration */
177 format_function_t *ls_format; /**< LocalSID format function */
179 unformat_function_t *ls_unformat; /**< LocalSID unformat function */
181 sr_plugin_callback_t *creation; /**< Function within plugin that will be called after localsid creation*/
183 sr_plugin_callback_t *removal; /**< Function within plugin that will be called before localsid removal */
184 } sr_localsid_fn_registration_t;
187 * @brief SR Policy behavior registration
191 u16 sr_policy_function_number; /**< SR Policy plugin function */
193 u8 *function_name; /**< Function name. (key). */
195 u8 *keyword_str; /**< Behavior keyword (i.e. End.X) */
197 u8 *def_str; /**< Behavior definition (i.e. Endpoint with cross-connect) */
199 u8 *params_str; /**< Behavior parameters (i.e. <oif> <IP46next_hop>) */
203 dpo_type_t dpo; /**< DPO type registration */
205 format_function_t *ls_format; /**< LocalSID format function */
207 unformat_function_t *ls_unformat; /**< LocalSID unformat function */
209 sr_p_plugin_callback_t *creation; /**< Function within plugin that will be called after localsid creation*/
211 sr_p_plugin_callback_t *removal; /**< Function within plugin that will be called before localsid removal */
212 } sr_policy_fn_registration_t;
215 * @brief Steering db key
217 * L3 is IPv4/IPv6 + mask
218 * L2 is sf_if_index + vlan
226 ip46_address_t prefix; /**< IP address of the prefix */
227 u32 mask_width; /**< Mask width of the prefix */
228 u32 fib_table; /**< VRF of the prefix */
232 u32 sw_if_index; /**< Incoming software interface */
235 u8 traffic_type; /**< Traffic type (IPv4, IPv6, L2) */
241 sr_steering_key_t classify; /**< Traffic classification */
242 u32 sr_policy; /**< SR Policy index */
243 } ip6_sr_steering_policy_t;
247 ip6_address_t address;
253 * @brief Segment Routing main datastructure
257 /* L2-input -> SR rewrite next index */
258 u32 l2_sr_policy_rewrite_index;
261 ip6_sr_sl_t *sid_lists;
264 ip6_sr_policy_t *sr_policies;
266 /* Hash table mapping BindingSID to SRv6 policy */
267 mhash_t sr_policies_index_hash;
269 /* Pool of SR localsid instances */
270 ip6_sr_localsid_t *localsids;
272 /* Hash table mapping LOC:FUNC to SR LocalSID instance */
273 mhash_t sr_localsids_index_hash;
275 /* Pool of SR steer policies instances */
276 ip6_sr_steering_policy_t *steer_policies;
278 /* Hash table mapping steering rules to SR steer instance */
279 mhash_t sr_steer_policies_hash;
281 /* L2 steering ifaces - sr_policies */
282 u32 *sw_iface_sr_policies;
285 dpo_type_t sr_pr_spray_dpo_type;
287 /* Plugin functions */
288 sr_localsid_fn_registration_t *plugin_functions;
290 /* Find plugin function by name */
291 uword *plugin_functions_by_key;
293 /* Plugin functions for Policy */
294 sr_policy_fn_registration_t *policy_plugin_functions;
296 /* Find plugin function by name */
297 uword *policy_plugin_functions_by_key;
300 vlib_combined_counter_main_t sr_ls_valid_counters;
301 vlib_combined_counter_main_t sr_ls_invalid_counters;
303 /* SR Policies FIBs */
308 vlib_main_t *vlib_main;
309 vnet_main_t *vnet_main;
312 extern ip6_sr_main_t sr_main;
314 extern vlib_node_registration_t sr_policy_rewrite_encaps_node;
315 extern vlib_node_registration_t sr_policy_rewrite_insert_node;
316 extern vlib_node_registration_t sr_localsid_node;
317 extern vlib_node_registration_t sr_localsid_d_node;
319 extern void sr_dpo_lock (dpo_id_t * dpo);
320 extern void sr_dpo_unlock (dpo_id_t * dpo);
323 sr_localsid_register_function (vlib_main_t * vm, u8 * fn_name,
324 u8 * keyword_str, u8 * def_str,
325 u8 * params_str, u8 prefix_length,
327 format_function_t * ls_format,
328 unformat_function_t * ls_unformat,
329 sr_plugin_callback_t * creation_fn,
330 sr_plugin_callback_t * removal_fn);
333 sr_policy_register_function (vlib_main_t * vm, u8 * fn_name,
334 u8 * keyword_str, u8 * def_str,
335 u8 * params_str, u8 prefix_length,
337 format_function_t * ls_format,
338 unformat_function_t * ls_unformat,
339 sr_p_plugin_callback_t * creation_fn,
340 sr_p_plugin_callback_t * removal_fn);
343 sr_policy_add (ip6_address_t * bsid, ip6_address_t * segments,
344 u32 weight, u8 behavior, u32 fib_table, u8 is_encap,
345 u16 plugin, void *plugin_mem);
346 extern int sr_policy_mod (ip6_address_t * bsid, u32 index, u32 fib_table,
347 u8 operation, ip6_address_t * segments,
348 u32 sl_index, u32 weight);
349 extern int sr_policy_del (ip6_address_t * bsid, u32 index);
352 sr_cli_localsid (char is_del, ip6_address_t * localsid_addr,
353 u16 localsid_prefix_len, char end_psp, u8 behavior,
354 u32 sw_if_index, u32 vlan_index, u32 fib_table,
355 ip46_address_t * nh_addr, int usid_len, void *ls_plugin_mem);
358 sr_steering_policy (int is_del, ip6_address_t * bsid, u32 sr_policy_index,
359 u32 table_id, ip46_address_t * prefix, u32 mask_width,
360 u32 sw_if_index, u8 traffic_type);
362 extern void sr_set_source (ip6_address_t * address);
364 extern void sr_set_hop_limit (u8 hop_limit);
365 extern u8 sr_get_hop_limit (void);
368 * @brief SR rewrite string computation for SRH insertion (inline)
370 * @param sl is a vector of IPv6 addresses composing the Segment List
372 * @return precomputed rewrite string for SRH insertion
375 ip6_sr_compute_rewrite_string_insert (ip6_address_t * sl)
377 ip6_sr_header_t *srh;
378 ip6_address_t *addrp, *this_address;
379 u32 header_length = 0;
383 header_length += sizeof (ip6_sr_header_t);
384 header_length += (vec_len (sl) + 1) * sizeof (ip6_address_t);
386 vec_validate (rs, header_length - 1);
388 srh = (ip6_sr_header_t *) rs;
389 srh->type = ROUTING_HEADER_TYPE_SR;
390 srh->segments_left = vec_len (sl);
391 srh->last_entry = vec_len (sl);
392 srh->length = ((sizeof (ip6_sr_header_t) +
393 ((vec_len (sl) + 1) * sizeof (ip6_address_t))) / 8) - 1;
396 addrp = srh->segments + vec_len (sl);
397 vec_foreach (this_address, sl)
399 clib_memcpy_fast (addrp->as_u8, this_address->as_u8,
400 sizeof (ip6_address_t));
407 #endif /* included_vnet_sr_h */
410 * fd.io coding-style-patch-verification: ON
413 * eval: (c-set-style "gnu")