blob: b832c0fc3653bcf495ed589cb5104ad69a923f3a [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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 */
Pablo Camarillofb380952016-12-07 18:34:18 +010015
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -070016/**
17 * @file
Pablo Camarillofb380952016-12-07 18:34:18 +010018 * @brief Segment Routing data structures definitions
19 *
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -070020 */
Pablo Camarillofb380952016-12-07 18:34:18 +010021
Ed Warnickecb9cada2015-12-08 15:45:58 -070022#ifndef included_vnet_sr_h
23#define included_vnet_sr_h
24
25#include <vnet/vnet.h>
26#include <vnet/sr/sr_packet.h>
27#include <vnet/ip/ip6_packet.h>
Pablo Camarillofb380952016-12-07 18:34:18 +010028#include <vnet/ethernet/ethernet.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070029
Ed Warnickecb9cada2015-12-08 15:45:58 -070030#include <stdlib.h>
31#include <string.h>
32
Pablo Camarillofb380952016-12-07 18:34:18 +010033#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_D_FIRST 3 /* Unused. Separator in between regular and D */
40#define SR_BEHAVIOR_DX2 4
41#define SR_BEHAVIOR_DX6 5
42#define SR_BEHAVIOR_DX4 6
43#define SR_BEHAVIOR_DT6 7
44#define SR_BEHAVIOR_DT4 8
45#define SR_BEHAVIOR_LAST 9 /* Must always be the last one */
46
47#define SR_STEER_L2 2
48#define SR_STEER_IPV4 4
49#define SR_STEER_IPV6 6
50
51#define SR_FUNCTION_SIZE 4
52#define SR_ARGUMENT_SIZE 4
53
54#define SR_SEGMENT_LIST_WEIGHT_DEFAULT 1
Ed Warnickecb9cada2015-12-08 15:45:58 -070055
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -070056/**
Pablo Camarillofb380952016-12-07 18:34:18 +010057 * @brief SR Segment List (SID list)
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -070058 */
Keith Burns (alagalah)06c5ffd2016-08-06 08:32:45 -070059typedef struct
60{
Pablo Camarillofb380952016-12-07 18:34:18 +010061 ip6_address_t *segments; /**< SIDs (key) */
Ed Warnickecb9cada2015-12-08 15:45:58 -070062
Pablo Camarillofb380952016-12-07 18:34:18 +010063 u32 weight; /**< SID list weight (wECMP / UCMP) */
64
65 u8 *rewrite; /**< Precomputed rewrite header */
66 u8 *rewrite_bsid; /**< Precomputed rewrite header for bindingSID */
67
68 dpo_id_t bsid_dpo; /**< DPO for Encaps/Insert for BSID */
69 dpo_id_t ip6_dpo; /**< DPO for Encaps/Insert IPv6 */
70 dpo_id_t ip4_dpo; /**< DPO for Encaps IPv6 */
71} ip6_sr_sl_t;
72
73/* SR policy types */
74#define SR_POLICY_TYPE_DEFAULT 0
75#define SR_POLICY_TYPE_SPRAY 1
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -070076/**
Pablo Camarillofb380952016-12-07 18:34:18 +010077 * @brief SR Policy
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -070078 */
Keith Burns (alagalah)06c5ffd2016-08-06 08:32:45 -070079typedef struct
80{
Pablo Camarillofb380952016-12-07 18:34:18 +010081 u32 *segments_lists; /**< SID lists indexes (vector) */
Ed Warnickecb9cada2015-12-08 15:45:58 -070082
Pablo Camarillofb380952016-12-07 18:34:18 +010083 ip6_address_t bsid; /**< BindingSID (key) */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -070084
Pablo Camarillofb380952016-12-07 18:34:18 +010085 u8 type; /**< Type (default is 0) */
Pablo Camarillofb380952016-12-07 18:34:18 +010086 /* SR Policy specific DPO */
87 /* IF Type = DEFAULT Then Load Balancer DPO among SID lists */
88 /* IF Type = SPRAY then Spray DPO with all SID lists */
89 dpo_id_t bsid_dpo; /**< SR Policy specific DPO - BSID */
90 dpo_id_t ip4_dpo; /**< SR Policy specific DPO - IPv6 */
91 dpo_id_t ip6_dpo; /**< SR Policy specific DPO - IPv4 */
Ed Warnickecb9cada2015-12-08 15:45:58 -070092
Pablo Camarillofb380952016-12-07 18:34:18 +010093 u32 fib_table; /**< FIB table */
Ed Warnickecb9cada2015-12-08 15:45:58 -070094
Pablo Camarillofb380952016-12-07 18:34:18 +010095 u8 is_encap; /**< Mode (0 is SRH insert, 1 Encaps) */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -070096} ip6_sr_policy_t;
97
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -070098/**
Pablo Camarillofb380952016-12-07 18:34:18 +010099 * @brief SR LocalSID
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -0700100 */
Keith Burns (alagalah)06c5ffd2016-08-06 08:32:45 -0700101typedef struct
102{
Pablo Camarillofb380952016-12-07 18:34:18 +0100103 ip6_address_t localsid; /**< LocalSID IPv6 address */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700104
Pablo Camarillofb380952016-12-07 18:34:18 +0100105 char end_psp; /**< Combined with End.PSP? */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700106
Pablo Camarillofb380952016-12-07 18:34:18 +0100107 u16 behavior; /**< Behavior associated to this localsid */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700108
Pablo Camarillofb380952016-12-07 18:34:18 +0100109 union
110 {
111 u32 sw_if_index; /**< xconnect only */
112 u32 vrf_index; /**< vrf only */
113 };
114
115 u32 fib_table; /**< FIB table where localsid is registered */
116
117 u32 vlan_index; /**< VLAN tag (not an index) */
118
119 ip46_address_t next_hop; /**< Next_hop for xconnect usage only */
120
121 u32 nh_adj; /**< Next_adj for xconnect usage only */
122
123 void *plugin_mem; /**< Memory to be used by the plugin callback functions */
124} ip6_sr_localsid_t;
125
126typedef int (sr_plugin_callback_t) (ip6_sr_localsid_t * localsid);
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700127
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -0700128/**
Pablo Camarillofb380952016-12-07 18:34:18 +0100129 * @brief SR LocalSID behavior registration
Keith Burns (alagalah)7214cf12016-08-08 15:56:50 -0700130 */
Keith Burns (alagalah)06c5ffd2016-08-06 08:32:45 -0700131typedef struct
132{
Pablo Camarillofb380952016-12-07 18:34:18 +0100133 u16 sr_localsid_function_number; /**< SR LocalSID plugin function (>SR_BEHAVIOR_LAST) */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700134
Pablo Camarillofb380952016-12-07 18:34:18 +0100135 u8 *function_name; /**< Function name. (key). */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700136
Pablo Camarillofb380952016-12-07 18:34:18 +0100137 u8 *keyword_str; /**< Behavior keyword (i.e. End.X) */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700138
Pablo Camarillofb380952016-12-07 18:34:18 +0100139 u8 *def_str; /**< Behavior definition (i.e. Endpoint with cross-connect) */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700140
Pablo Camarillofb380952016-12-07 18:34:18 +0100141 u8 *params_str; /**< Behavior parameters (i.e. <oif> <IP46next_hop>) */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700142
Pablo Camarillofb380952016-12-07 18:34:18 +0100143 dpo_type_t dpo; /**< DPO type registration */
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700144
Pablo Camarillofb380952016-12-07 18:34:18 +0100145 format_function_t *ls_format; /**< LocalSID format function */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700146
Pablo Camarillofb380952016-12-07 18:34:18 +0100147 unformat_function_t *ls_unformat; /**< LocalSID unformat function */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148
Pablo Camarillofb380952016-12-07 18:34:18 +0100149 sr_plugin_callback_t *creation; /**< Function within plugin that will be called after localsid creation*/
Ed Warnickecb9cada2015-12-08 15:45:58 -0700150
Pablo Camarillofb380952016-12-07 18:34:18 +0100151 sr_plugin_callback_t *removal; /**< Function within plugin that will be called before localsid removal */
152} sr_localsid_fn_registration_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700153
Pablo Camarillofb380952016-12-07 18:34:18 +0100154/**
155 * @brief Steering db key
156 *
157 * L3 is IPv4/IPv6 + mask
158 * L2 is sf_if_index + vlan
159 */
160typedef struct
161{
162 union
163 {
164 struct
165 {
166 ip46_address_t prefix; /**< IP address of the prefix */
167 u32 mask_width; /**< Mask width of the prefix */
168 u32 fib_table; /**< VRF of the prefix */
169 } l3;
170 struct
171 {
172 u32 sw_if_index; /**< Incoming software interface */
173 } l2;
174 };
175 u8 traffic_type; /**< Traffic type (IPv4, IPv6, L2) */
Pablo Camarillo4521afa2017-03-16 10:43:05 +0100176 u8 padding[3];
Pablo Camarillofb380952016-12-07 18:34:18 +0100177} sr_steering_key_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700178
Pablo Camarillofb380952016-12-07 18:34:18 +0100179typedef struct
180{
181 sr_steering_key_t classify; /**< Traffic classification */
182 u32 sr_policy; /**< SR Policy index */
183} ip6_sr_steering_policy_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700184
Pablo Camarillofb380952016-12-07 18:34:18 +0100185/**
186 * @brief Segment Routing main datastructure
187 */
188typedef struct
189{
Pablo Camarillofb380952016-12-07 18:34:18 +0100190 /* L2-input -> SR rewrite next index */
191 u32 l2_sr_policy_rewrite_index;
192
Pablo Camarillofb380952016-12-07 18:34:18 +0100193 /* SR SID lists */
194 ip6_sr_sl_t *sid_lists;
195
196 /* SR policies */
197 ip6_sr_policy_t *sr_policies;
198
Pablo Camarillo4521afa2017-03-16 10:43:05 +0100199 /* Hash table mapping BindingSID to SR policy */
200 mhash_t sr_policies_index_hash;
Pablo Camarillofb380952016-12-07 18:34:18 +0100201
202 /* Pool of SR localsid instances */
203 ip6_sr_localsid_t *localsids;
204
Pablo Camarillo4521afa2017-03-16 10:43:05 +0100205 /* Hash table mapping LOC:FUNC to SR LocalSID instance */
206 mhash_t sr_localsids_index_hash;
Pablo Camarillofb380952016-12-07 18:34:18 +0100207
208 /* Pool of SR steer policies instances */
209 ip6_sr_steering_policy_t *steer_policies;
210
Pablo Camarillo4521afa2017-03-16 10:43:05 +0100211 /* Hash table mapping steering rules to SR steer instance */
212 mhash_t sr_steer_policies_hash;
Pablo Camarillofb380952016-12-07 18:34:18 +0100213
214 /* L2 steering ifaces - sr_policies */
215 u32 *sw_iface_sr_policies;
216
217 /* Spray DPO */
218 dpo_type_t sr_pr_spray_dpo_type;
219
220 /* Plugin functions */
221 sr_localsid_fn_registration_t *plugin_functions;
222
223 /* Find plugin function by name */
224 uword *plugin_functions_by_key;
225
226 /* Counters */
227 vlib_combined_counter_main_t sr_ls_valid_counters;
228 vlib_combined_counter_main_t sr_ls_invalid_counters;
229
230 /* SR Policies FIBs */
231 u32 fib_table_ip6;
232 u32 fib_table_ip4;
233
234 /* convenience */
Keith Burns (alagalah)06c5ffd2016-08-06 08:32:45 -0700235 vlib_main_t *vlib_main;
236 vnet_main_t *vnet_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700237} ip6_sr_main_t;
238
239ip6_sr_main_t sr_main;
240
Pablo Camarillofb380952016-12-07 18:34:18 +0100241extern vlib_node_registration_t sr_policy_rewrite_encaps_node;
242extern vlib_node_registration_t sr_policy_rewrite_insert_node;
243extern vlib_node_registration_t sr_localsid_node;
244extern vlib_node_registration_t sr_localsid_d_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700245
Pablo Camarillofb380952016-12-07 18:34:18 +0100246void sr_dpo_lock (dpo_id_t * dpo);
247void sr_dpo_unlock (dpo_id_t * dpo);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248
Pablo Camarillofb380952016-12-07 18:34:18 +0100249int sr_localsid_register_function (vlib_main_t * vm, u8 * fn_name,
250 u8 * keyword_str, u8 * def_str,
251 u8 * params_str, dpo_type_t * dpo,
252 format_function_t * ls_format,
253 unformat_function_t * ls_unformat,
254 sr_plugin_callback_t * creation_fn,
255 sr_plugin_callback_t * removal_fn);
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700256
Pablo Camarillofb380952016-12-07 18:34:18 +0100257int
258sr_policy_add (ip6_address_t * bsid, ip6_address_t * segments,
259 u32 weight, u8 behavior, u32 fib_table, u8 is_encap);
260int
261sr_policy_mod (ip6_address_t * bsid, u32 index, u32 fib_table,
262 u8 operation, ip6_address_t * segments, u32 sl_index,
263 u32 weight);
264int sr_policy_del (ip6_address_t * bsid, u32 index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700265
Pablo Camarillofb380952016-12-07 18:34:18 +0100266int sr_cli_localsid (char is_del, ip6_address_t * localsid_addr,
267 char end_psp, u8 behavior, u32 sw_if_index,
268 u32 vlan_index, u32 fib_table, ip46_address_t * nh_addr,
269 void *ls_plugin_mem);
270
271int
272sr_steering_policy (int is_del, ip6_address_t * bsid, u32 sr_policy_index,
273 u32 table_id, ip46_address_t * prefix, u32 mask_width,
274 u32 sw_if_index, u8 traffic_type);
Keith Burns (alagalah)52fc44d2016-03-25 09:38:50 -0700275
Shwetha Bhandari78372a92017-01-18 12:43:54 +0530276/**
277 * @brief SR rewrite string computation for SRH insertion (inline)
278 *
279 * @param sl is a vector of IPv6 addresses composing the Segment List
280 *
281 * @return precomputed rewrite string for SRH insertion
282 */
283static inline u8 *
shwethabe146f132017-03-09 16:58:26 +0000284ip6_sr_compute_rewrite_string_insert (ip6_address_t * sl)
Shwetha Bhandari78372a92017-01-18 12:43:54 +0530285{
286 ip6_sr_header_t *srh;
287 ip6_address_t *addrp, *this_address;
288 u32 header_length = 0;
289 u8 *rs = NULL;
290
291 header_length = 0;
292 header_length += sizeof (ip6_sr_header_t);
293 header_length += (vec_len (sl) + 1) * sizeof (ip6_address_t);
294
295 vec_validate (rs, header_length - 1);
296
297 srh = (ip6_sr_header_t *) rs;
298 srh->type = ROUTING_HEADER_TYPE_SR;
299 srh->segments_left = vec_len (sl);
300 srh->first_segment = vec_len (sl);
301 srh->length = ((sizeof (ip6_sr_header_t) +
302 ((vec_len (sl) + 1) * sizeof (ip6_address_t))) / 8) - 1;
303 srh->flags = 0x00;
304 srh->reserved = 0x0000;
305 addrp = srh->segments + vec_len (sl);
306 vec_foreach (this_address, sl)
307 {
308 clib_memcpy (addrp->as_u8, this_address->as_u8, sizeof (ip6_address_t));
309 addrp--;
310 }
311 return rs;
312}
313
314
Ed Warnickecb9cada2015-12-08 15:45:58 -0700315#endif /* included_vnet_sr_h */
Keith Burns (alagalah)06c5ffd2016-08-06 08:32:45 -0700316
317/*
318 * fd.io coding-style-patch-verification: ON
319 *
320 * Local Variables:
321 * eval: (c-set-style "gnu")
322 * End:
323 */