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 */
80 u32 egress_fib_table; /**< Egress FIB table for encap packet */
82 dpo_id_t bsid_dpo; /**< DPO for Encaps/Insert for BSID */
83 dpo_id_t ip6_dpo; /**< DPO for Encaps/Insert IPv6 */
84 dpo_id_t ip4_dpo; /**< DPO for Encaps IPv6 */
91 #define SR_POLICY_TYPE_DEFAULT 0
92 #define SR_POLICY_TYPE_SPRAY 1
98 u32 *segments_lists; /**< SID lists indexes (vector) */
100 ip6_address_t bsid; /**< BindingSID (key) */
102 u8 type; /**< Type (default is 0) */
103 /* SR Policy specific DPO */
104 /* IF Type = DEFAULT Then Load Balancer DPO among SID lists */
105 /* IF Type = SPRAY then Spray DPO with all SID lists */
106 dpo_id_t bsid_dpo; /**< SR Policy specific DPO - BSID */
107 dpo_id_t ip4_dpo; /**< SR Policy specific DPO - IPv6 */
108 dpo_id_t ip6_dpo; /**< SR Policy specific DPO - IPv4 */
110 u32 fib_table; /**< FIB table */
112 u8 is_encap; /**< Mode (0 is SRH insert, 1 Encaps) */
118 typedef int (sr_p_plugin_callback_t) (ip6_sr_policy_t * sr);
125 ip6_address_t localsid; /**< LocalSID IPv6 address */
127 u16 localsid_prefix_len;
129 char end_psp; /**< Combined with End.PSP? */
131 u16 behavior; /**< Behavior associated to this localsid */
135 u32 sw_if_index; /**< xconnect only */
136 u32 vrf_index; /**< vrf only */
139 u32 fib_table; /**< FIB table where localsid is registered */
141 u32 vlan_index; /**< VLAN tag (not an index) */
143 ip46_address_t next_hop; /**< Next_hop for xconnect usage only */
145 u32 nh_adj; /**< Next_adj for xconnect usage only */
147 ip6_address_t usid_block;
148 ip6_address_t usid_block_mask;
156 void *plugin_mem; /**< Memory to be used by the plugin callback functions */
159 typedef int (sr_plugin_callback_t) (ip6_sr_localsid_t * localsid);
162 * @brief SR LocalSID behavior registration
166 u16 sr_localsid_function_number; /**< SR LocalSID plugin function (>SR_BEHAVIOR_LAST) */
168 u8 *function_name; /**< Function name. (key). */
170 u8 *keyword_str; /**< Behavior keyword (i.e. End.X) */
172 u8 *def_str; /**< Behavior definition (i.e. Endpoint with cross-connect) */
174 u8 *params_str; /**< Behavior parameters (i.e. <oif> <IP46next_hop>) */
178 dpo_type_t dpo; /**< DPO type registration */
180 format_function_t *ls_format; /**< LocalSID format function */
182 unformat_function_t *ls_unformat; /**< LocalSID unformat function */
184 sr_plugin_callback_t *creation; /**< Function within plugin that will be called after localsid creation*/
186 sr_plugin_callback_t *removal; /**< Function within plugin that will be called before localsid removal */
187 } sr_localsid_fn_registration_t;
190 * @brief SR Policy behavior registration
194 u16 sr_policy_function_number; /**< SR Policy plugin function */
196 u8 *function_name; /**< Function name. (key). */
198 u8 *keyword_str; /**< Behavior keyword (i.e. End.X) */
200 u8 *def_str; /**< Behavior definition (i.e. Endpoint with cross-connect) */
202 u8 *params_str; /**< Behavior parameters (i.e. <oif> <IP46next_hop>) */
206 dpo_type_t dpo; /**< DPO type registration */
208 format_function_t *ls_format; /**< LocalSID format function */
210 unformat_function_t *ls_unformat; /**< LocalSID unformat function */
212 sr_p_plugin_callback_t *creation; /**< Function within plugin that will be called after localsid creation*/
214 sr_p_plugin_callback_t *removal; /**< Function within plugin that will be called before localsid removal */
215 } sr_policy_fn_registration_t;
218 * @brief Steering db key
220 * L3 is IPv4/IPv6 + mask
221 * L2 is sf_if_index + vlan
229 ip46_address_t prefix; /**< IP address of the prefix */
230 u32 mask_width; /**< Mask width of the prefix */
231 u32 fib_table; /**< VRF of the prefix */
235 u32 sw_if_index; /**< Incoming software interface */
238 u8 traffic_type; /**< Traffic type (IPv4, IPv6, L2) */
244 sr_steering_key_t classify; /**< Traffic classification */
245 u32 sr_policy; /**< SR Policy index */
246 } ip6_sr_steering_policy_t;
250 ip6_address_t address;
256 * @brief Segment Routing main datastructure
260 /* L2-input -> SR rewrite next index */
261 u32 l2_sr_policy_rewrite_index;
264 ip6_sr_sl_t *sid_lists;
267 ip6_sr_policy_t *sr_policies;
269 /* Hash table mapping BindingSID to SRv6 policy */
270 mhash_t sr_policies_index_hash;
272 /* Pool of SR localsid instances */
273 ip6_sr_localsid_t *localsids;
275 /* Hash table mapping LOC:FUNC to SR LocalSID instance */
276 mhash_t sr_localsids_index_hash;
278 /* Pool of SR steer policies instances */
279 ip6_sr_steering_policy_t *steer_policies;
281 /* Hash table mapping steering rules to SR steer instance */
282 mhash_t sr_steer_policies_hash;
284 /* L2 steering ifaces - sr_policies */
285 u32 *sw_iface_sr_policies;
288 dpo_type_t sr_pr_spray_dpo_type;
290 /* Plugin functions */
291 sr_localsid_fn_registration_t *plugin_functions;
293 /* Find plugin function by name */
294 uword *plugin_functions_by_key;
296 /* Plugin functions for Policy */
297 sr_policy_fn_registration_t *policy_plugin_functions;
299 /* Find plugin function by name */
300 uword *policy_plugin_functions_by_key;
303 vlib_combined_counter_main_t sr_ls_valid_counters;
304 vlib_combined_counter_main_t sr_ls_invalid_counters;
306 /* SR Policies FIBs */
311 vlib_main_t *vlib_main;
312 vnet_main_t *vnet_main;
316 extern ip6_sr_main_t sr_main;
318 extern vlib_node_registration_t sr_policy_rewrite_encaps_node;
319 extern vlib_node_registration_t sr_policy_rewrite_insert_node;
320 extern vlib_node_registration_t sr_localsid_node;
321 extern vlib_node_registration_t sr_localsid_d_node;
323 extern void sr_dpo_lock (dpo_id_t * dpo);
324 extern void sr_dpo_unlock (dpo_id_t * dpo);
327 sr_localsid_register_function (vlib_main_t * vm, u8 * fn_name,
328 u8 * keyword_str, u8 * def_str,
329 u8 * params_str, u8 prefix_length,
331 format_function_t * ls_format,
332 unformat_function_t * ls_unformat,
333 sr_plugin_callback_t * creation_fn,
334 sr_plugin_callback_t * removal_fn);
337 sr_policy_register_function (vlib_main_t * vm, u8 * fn_name,
338 u8 * keyword_str, u8 * def_str,
339 u8 * params_str, u8 prefix_length,
341 format_function_t * ls_format,
342 unformat_function_t * ls_unformat,
343 sr_p_plugin_callback_t * creation_fn,
344 sr_p_plugin_callback_t * removal_fn);
346 extern int sr_policy_add (ip6_address_t *bsid, ip6_address_t *segments,
347 u32 weight, u8 type, u32 fib_table, u8 is_encap,
348 u16 plugin, void *plugin_mem);
349 extern int sr_policy_mod (ip6_address_t * bsid, u32 index, u32 fib_table,
350 u8 operation, ip6_address_t * segments,
351 u32 sl_index, u32 weight);
352 extern int sr_policy_del (ip6_address_t * bsid, u32 index);
355 sr_cli_localsid (char is_del, ip6_address_t * localsid_addr,
356 u16 localsid_prefix_len, char end_psp, u8 behavior,
357 u32 sw_if_index, u32 vlan_index, u32 fib_table,
358 ip46_address_t * nh_addr, int usid_len, void *ls_plugin_mem);
361 sr_steering_policy (int is_del, ip6_address_t * bsid, u32 sr_policy_index,
362 u32 table_id, ip46_address_t * prefix, u32 mask_width,
363 u32 sw_if_index, u8 traffic_type);
365 extern void sr_set_source (ip6_address_t * address);
366 extern ip6_address_t *sr_get_encaps_source ();
368 extern void sr_set_hop_limit (u8 hop_limit);
369 extern u8 sr_get_hop_limit (void);
372 * @brief SR rewrite string computation for SRH insertion (inline)
374 * @param sl is a vector of IPv6 addresses composing the Segment List
376 * @return precomputed rewrite string for SRH insertion
379 ip6_sr_compute_rewrite_string_insert (ip6_address_t * sl)
381 ip6_sr_header_t *srh;
382 ip6_address_t *addrp, *this_address;
383 u32 header_length = 0;
387 header_length += sizeof (ip6_sr_header_t);
388 header_length += (vec_len (sl) + 1) * sizeof (ip6_address_t);
390 vec_validate (rs, header_length - 1);
392 srh = (ip6_sr_header_t *) rs;
393 srh->type = ROUTING_HEADER_TYPE_SR;
394 srh->segments_left = vec_len (sl);
395 srh->last_entry = vec_len (sl);
396 srh->length = ((sizeof (ip6_sr_header_t) +
397 ((vec_len (sl) + 1) * sizeof (ip6_address_t))) / 8) - 1;
400 addrp = srh->segments + vec_len (sl);
401 vec_foreach (this_address, sl)
403 clib_memcpy_fast (addrp->as_u8, this_address->as_u8,
404 sizeof (ip6_address_t));
410 #endif /* included_vnet_sr_h */
413 * fd.io coding-style-patch-verification: ON
416 * eval: (c-set-style "gnu")