FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
sr_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * sr_api.c - ipv6 segment routing api
4  *
5  * Copyright (c) 2016 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #include <vnet/vnet.h>
21 #include <vnet/srv6/sr.h>
22 #include <vlibmemory/api.h>
23 
24 #include <vnet/interface.h>
25 #include <vnet/api_errno.h>
26 #include <vnet/feature/feature.h>
27 
28 #include <vnet/vnet_msg_enum.h>
29 
30 #define vl_typedefs /* define message structures */
31 #include <vnet/vnet_all_api_h.h>
32 #undef vl_typedefs
33 
34 #define vl_endianfun /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
36 #undef vl_endianfun
37 
38 /* instantiate all the print functions we know about */
39 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
40 #define vl_printfun
41 #include <vnet/vnet_all_api_h.h>
42 #undef vl_printfun
43 
45 
46 #define foreach_vpe_api_msg \
47 _(SR_LOCALSID_ADD_DEL, sr_localsid_add_del) \
48 _(SR_POLICY_ADD, sr_policy_add) \
49 _(SR_POLICY_MOD, sr_policy_mod) \
50 _(SR_POLICY_DEL, sr_policy_del) \
51 _(SR_STEERING_ADD_DEL, sr_steering_add_del) \
52 _(SR_SET_ENCAP_SOURCE, sr_set_encap_source) \
53 _(SR_LOCALSIDS_DUMP, sr_localsids_dump) \
54 _(SR_POLICIES_DUMP, sr_policies_dump) \
55 _(SR_STEERING_POL_DUMP, sr_steering_pol_dump)
56 
59 {
60  vl_api_sr_localsid_add_del_reply_t *rmp;
61  int rv = 0;
62 /*
63  * int sr_cli_localsid (char is_del, ip6_address_t *localsid_addr,
64  * char end_psp, u8 behavior, u32 sw_if_index, u32 vlan_index, u32 fib_table,
65  * ip46_address_t *nh_addr, void *ls_plugin_mem)
66  */
67  if (mp->behavior == SR_BEHAVIOR_X ||
68  mp->behavior == SR_BEHAVIOR_DX6 ||
71 
72  ip46_address_t prefix;
73 
74  clib_memset (&prefix, 0, sizeof (ip46_address_t));
75  if ((mp->nh_addr4[0] | mp->nh_addr4[1] | mp->
76  nh_addr4[2] | mp->nh_addr4[3]) != 0)
77  memcpy (&prefix.ip4, mp->nh_addr4, sizeof (prefix.ip4));
78  else
79  memcpy (&prefix.ip6, mp->nh_addr6, sizeof (prefix.ip6));
80 
81  rv = sr_cli_localsid (mp->is_del,
82  (ip6_address_t *) & mp->localsid,
83  mp->end_psp,
84  mp->behavior,
85  ntohl (mp->sw_if_index),
86  ntohl (mp->vlan_index),
87  ntohl (mp->fib_table), &prefix, NULL);
88 
90  REPLY_MACRO (VL_API_SR_LOCALSID_ADD_DEL_REPLY);
91 }
92 
93 static void
95 {
96  vl_api_sr_policy_add_reply_t *rmp;
97  ip6_address_t *segments = 0, *seg;
98  ip6_address_t *this_address = (ip6_address_t *) mp->sids.sids;
99 
100  int i;
101  for (i = 0; i < mp->sids.num_sids; i++)
102  {
103  vec_add2 (segments, seg, 1);
104  clib_memcpy (seg->as_u8, this_address->as_u8, sizeof (*this_address));
105  this_address++;
106  }
107 
108 /*
109  * sr_policy_add (ip6_address_t *bsid, ip6_address_t *segments,
110  * u32 weight, u8 behavior, u32 fib_table, u8 is_encap)
111  */
112  int rv = 0;
113  rv = sr_policy_add ((ip6_address_t *) & mp->bsid_addr,
114  segments,
115  ntohl (mp->sids.weight),
116  mp->type, ntohl (mp->fib_table), mp->is_encap);
117  vec_free (segments);
118 
119  REPLY_MACRO (VL_API_SR_POLICY_ADD_REPLY);
120 }
121 
122 static void
124 {
125  vl_api_sr_policy_mod_reply_t *rmp;
126 
127  ip6_address_t *segments = 0, *seg;
128  ip6_address_t *this_address = (ip6_address_t *) mp->sids.sids;
129 
130  int i;
131  for (i = 0; i < mp->sids.num_sids; i++)
132  {
133  vec_add2 (segments, seg, 1);
134  clib_memcpy (seg->as_u8, this_address->as_u8, sizeof (*this_address));
135  this_address++;
136  }
137 
138  int rv = 0;
139 /*
140  * int
141  * sr_policy_mod(ip6_address_t *bsid, u32 index, u32 fib_table,
142  * u8 operation, ip6_address_t *segments, u32 sl_index,
143  * u32 weight, u8 is_encap)
144  */
145  rv = sr_policy_mod ((ip6_address_t *) & mp->bsid_addr,
146  ntohl (mp->sr_policy_index),
147  ntohl (mp->fib_table),
148  mp->operation,
149  segments, ntohl (mp->sl_index),
150  ntohl (mp->sids.weight));
151  vec_free (segments);
152 
153  REPLY_MACRO (VL_API_SR_POLICY_MOD_REPLY);
154 }
155 
156 static void
158 {
159  vl_api_sr_policy_del_reply_t *rmp;
160  int rv = 0;
161 /*
162  * int
163  * sr_policy_del (ip6_address_t *bsid, u32 index)
164  */
165  rv = sr_policy_del ((ip6_address_t *) & mp->bsid_addr,
166  ntohl (mp->sr_policy_index));
167 
168  REPLY_MACRO (VL_API_SR_POLICY_DEL_REPLY);
169 }
170 
171 static void
173 {
174  vl_api_sr_set_encap_source_reply_t *rmp;
175  int rv = 0;
177 
178  REPLY_MACRO (VL_API_SR_POLICY_DEL_REPLY);
179 }
180 
183 {
184  vl_api_sr_steering_add_del_reply_t *rmp;
185  int rv = 0;
186 /*
187  * int
188  * sr_steering_policy(int is_del, ip6_address_t *bsid, u32 sr_policy_index,
189  * u32 table_id, ip46_address_t *prefix, u32 mask_width, u32 sw_if_index,
190  * u8 traffic_type)
191  */
192  if (mp->traffic_type == SR_STEER_L2)
194 
195  rv = sr_steering_policy (mp->is_del,
196  (ip6_address_t *) & mp->bsid_addr,
197  ntohl (mp->sr_policy_index),
198  ntohl (mp->table_id),
199  (ip46_address_t *) & mp->prefix_addr,
200  ntohl (mp->mask_width),
201  ntohl (mp->sw_if_index), mp->traffic_type);
202 
204  REPLY_MACRO (VL_API_SR_STEERING_ADD_DEL_REPLY);
205 }
206 
207 static void send_sr_localsid_details
209 {
211 
212  rmp = vl_msg_api_alloc (sizeof (*rmp));
213  clib_memset (rmp, 0, sizeof (*rmp));
214  rmp->_vl_msg_id = ntohs (VL_API_SR_LOCALSIDS_DETAILS);
215  clib_memcpy (rmp->addr.addr, &t->localsid, sizeof (ip6_address_t));
216  rmp->end_psp = t->end_psp;
217  rmp->behavior = htons (t->behavior);
218  rmp->fib_table = htonl (t->fib_table);
219  rmp->vlan_index = htonl (t->vlan_index);
220  if (ip46_address_is_ip4 (&t->next_hop))
221  clib_memcpy (rmp->xconnect_nh_addr4, &t->next_hop.ip4,
222  sizeof (ip4_address_t));
223  else
224  clib_memcpy (rmp->xconnect_nh_addr6, &t->next_hop.ip6,
225  sizeof (ip6_address_t));
226  rmp->xconnect_iface_or_vrf_table = htonl (t->sw_if_index);
227  rmp->context = context;
228 
229  vl_api_send_msg (reg, (u8 *) rmp);
230 }
231 
234 {
236  ip6_sr_main_t *sm = &sr_main;
238 
240  if (!reg)
241  return;
242 
243  /* *INDENT-OFF* */
244  pool_foreach (t, sm->localsids,
245  ({
246  send_sr_localsid_details(t, reg, mp->context);
247  }));
248  /* *INDENT-ON* */
249 }
250 
251 static void send_sr_policies_details
253 {
255  ip6_sr_main_t *sm = &sr_main;
256 
257  u32 *sl_index;
258  ip6_sr_sl_t *segment_list = 0;
259  vl_api_srv6_sid_list_t *write_sid_list;
260 
261  rmp = vl_msg_api_alloc (sizeof (*rmp) +
262  vec_len (t->segments_lists) *
263  sizeof (vl_api_srv6_sid_list_t));
264  clib_memset (rmp, 0,
265  (sizeof (*rmp) +
266  vec_len (t->segments_lists) *
267  sizeof (vl_api_srv6_sid_list_t)));
268 
269  rmp->_vl_msg_id = ntohs (VL_API_SR_POLICIES_DETAILS);
270  clib_memcpy (rmp->bsid.addr, &t->bsid, sizeof (ip6_address_t));
271  rmp->is_encap = t->is_encap;
272  rmp->type = t->type;
273  rmp->fib_table = htonl (t->fib_table);
275 
276  /* Fill in all the segments lists */
277  vec_foreach (sl_index, t->segments_lists)
278  {
279  segment_list = pool_elt_at_index (sm->sid_lists, *sl_index);
280  write_sid_list = &rmp->sid_lists[sl_index - t->segments_lists];
281  write_sid_list->num_sids = vec_len (segment_list->segments);
282  write_sid_list->weight = htonl (segment_list->weight);
283  clib_memcpy (write_sid_list->sids, segment_list->segments,
284  vec_len (segment_list->segments) * sizeof (ip6_address_t));
285  }
286 
287  rmp->context = context;
288  vl_api_send_msg (reg, (u8 *) rmp);
289 }
290 
291 static void
293 {
295  ip6_sr_main_t *sm = &sr_main;
296  ip6_sr_policy_t *t;
297 
299  if (!reg)
300  return;
301 
302  /* *INDENT-OFF* */
303  pool_foreach (t, sm->sr_policies,
304  ({
305  send_sr_policies_details(t, reg, mp->context);
306  }));
307  /* *INDENT-ON* */
308 }
309 
312 {
314  ip6_sr_main_t *sm = &sr_main;
315 
316  rmp = vl_msg_api_alloc (sizeof (*rmp));
317  clib_memset (rmp, 0, sizeof (*rmp));
318  rmp->_vl_msg_id = ntohs (VL_API_SR_STEERING_POL_DETAILS);
319 
320  //Get the SR policy BSID
321  ip6_sr_policy_t *p;
323  clib_memcpy (rmp->bsid.addr, &p->bsid, sizeof (ip6_address_t));
324 
325  //Get the steering
327  rmp->fib_table = htonl (t->classify.l3.fib_table);
328  rmp->mask_width = htonl (t->classify.l3.mask_width);
329  if (ip46_address_is_ip4 (&t->classify.l3.prefix))
330  clib_memcpy (rmp->prefix_addr, &t->classify.l3.prefix.ip4,
331  sizeof (ip4_address_t));
332  else
333  clib_memcpy (rmp->prefix_addr, &t->classify.l3.prefix.ip6,
334  sizeof (ip6_address_t));
335 
336  rmp->sw_if_index = htonl (t->classify.l2.sw_if_index);
337 
338  rmp->context = context;
339  vl_api_send_msg (reg, (u8 *) rmp);
340 }
341 
344 {
346  ip6_sr_main_t *sm = &sr_main;
348 
350  if (!reg)
351  return;
352 
353  /* *INDENT-OFF* */
355  ({
356  send_sr_steering_pol_details(t, reg, mp->context);
357  }));
358  /* *INDENT-ON* */
359 }
360 
361 /*
362  * sr_api_hookup
363  * Add vpe's API message handlers to the table.
364  * vlib has alread mapped shared memory and
365  * added the client registration handlers.
366  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
367  */
368 #define vl_msg_name_crc_list
369 #include <vnet/vnet_all_api_h.h>
370 #undef vl_msg_name_crc_list
371 
372 static void
374 {
375 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
376  foreach_vl_msg_name_crc_sr;
377 #undef _
378 }
379 
380 static clib_error_t *
382 {
383  api_main_t *am = &api_main;
384 
385 #define _(N,n) \
386  vl_msg_api_set_handlers(VL_API_##N, #n, \
387  vl_api_##n##_t_handler, \
388  vl_noop_handler, \
389  vl_api_##n##_t_endian, \
390  vl_api_##n##_t_print, \
391  sizeof(vl_api_##n##_t), 1);
393 #undef _
394 
395  /*
396  * Set up the (msg_name, crc, message-id) table
397  */
399 
400  return 0;
401 }
402 
404 
405 /*
406  * fd.io coding-style-patch-verification: ON
407  *
408  * Local Variables:
409  * eval: (c-set-style "gnu")
410  * End:
411  */
ip6_sr_main_t sr_main
Definition: sr.c:31
u8 type
Type (default is 0)
Definition: sr.h:86
u32 vlan_index
VLAN tag (not an index)
Definition: sr.h:118
void sr_set_source(ip6_address_t *address)
int sr_cli_localsid(char is_del, ip6_address_t *localsid_addr, char end_psp, u8 behavior, u32 sw_if_index, u32 vlan_index, u32 fib_table, ip46_address_t *nh_addr, void *ls_plugin_mem)
SR localsid add/del.
Definition: sr_localsid.c:66
#define SR_BEHAVIOR_X
Definition: sr.h:38
struct sr_steering_key_t::@328::@330 l3
SR LocalSID.
Definition: sr.h:102
u32 fib_table
FIB table.
Definition: sr.h:94
u8 as_u8[16]
Definition: ip6_packet.h:48
int sr_steering_policy(int is_del, ip6_address_t *bsid, u32 sr_policy_index, u32 table_id, ip46_address_t *prefix, u32 mask_width, u32 sw_if_index, u8 traffic_type)
Steer traffic L2 and L3 traffic through a given SR policy.
Definition: sr_steering.c:60
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static void send_sr_policies_details(ip6_sr_policy_t *t, vl_api_registration_t *reg, u32 context)
Definition: sr_api.c:252
vl_api_srv6_sid_t bsid
Definition: sr.api:228
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
ip6_address_t * segments
SIDs (key)
Definition: sr.h:62
u8 bsid_addr[16]
Definition: sr.api:81
static void vl_api_sr_policy_add_t_handler(vl_api_sr_policy_add_t *mp)
Definition: sr_api.c:94
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:564
for(i=1;i<=collision_buckets;i++)
int i
u16 behavior
Behavior associated to this localsid.
Definition: sr.h:108
void * vl_msg_api_alloc(int nbytes)
ip6_sr_steering_policy_t * steer_policies
Definition: sr.h:210
unsigned char u8
Definition: types.h:56
vl_api_srv6_sid_list_t sids
Definition: sr.api:110
#define clib_memcpy(d, s, n)
Definition: string.h:180
static void vl_api_sr_steering_add_del_t_handler(vl_api_sr_steering_add_del_t *mp)
Definition: sr_api.c:182
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:490
vl_api_srv6_sid_list_t sids
Definition: sr.api:86
static void vl_api_sr_policy_mod_t_handler(vl_api_sr_policy_mod_t *mp)
Definition: sr_api.c:123
SR Segment List (SID list)
Definition: sr.h:60
unsigned int u32
Definition: types.h:88
vl_api_srv6_sid_t addr
Definition: sr.api:179
static void send_sr_localsid_details(ip6_sr_localsid_t *t, vl_api_registration_t *reg, u32 context)
Definition: sr_api.c:208
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:511
static void vl_api_sr_localsids_dump_t_handler(vl_api_sr_localsids_dump_t *mp)
Definition: sr_api.c:233
static void setup_message_id_table(api_main_t *am)
Definition: sr_api.c:373
static void send_sr_steering_pol_details(ip6_sr_steering_policy_t *t, vl_api_registration_t *reg, u32 context)
Definition: sr_api.c:311
char end_psp
Combined with End.PSP?
Definition: sr.h:106
sr_steering_key_t classify
Traffic classification.
Definition: sr.h:182
#define REPLY_MACRO(t)
#define SR_BEHAVIOR_DX4
Definition: sr.h:43
vl_api_srv6_sid_t bsid
Definition: sr.api:202
static void vl_api_sr_steering_pol_dump_t_handler(vl_api_sr_policies_dump_t *mp)
Definition: sr_api.c:343
u8 is_encap
Mode (0 is SRH insert, 1 Encaps)
Definition: sr.h:96
u32 sr_policy
SR Policy index.
Definition: sr.h:183
u32 weight
SID list weight (wECMP / UCMP)
Definition: sr.h:64
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
#define ip46_address_is_ip4(ip46)
Definition: ip6_packet.h:88
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
ip6_sr_localsid_t * localsids
Definition: sr.h:204
#define BAD_SW_IF_INDEX_LABEL
vl_api_srv6_sid_t localsid
Definition: sr.api:52
VLIB_API_INIT_FUNCTION(sr_api_hookup)
vl_api_srv6_sid_list_t sid_lists[num_sid_lists]
Definition: sr.api:207
vlib_main_t * vm
Definition: buffer.c:301
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
int sr_policy_del(ip6_address_t *bsid, u32 index)
Delete a SR policy.
int sr_policy_add(ip6_address_t *bsid, ip6_address_t *segments, u32 weight, u8 behavior, u32 fib_table, u8 is_encap)
Create a new SR policy.
u32 * segments_lists
SID lists indexes (vector)
Definition: sr.h:82
IPv6 SR Set SRv6 encapsulation source.
Definition: sr.api:133
static void vl_api_sr_policies_dump_t_handler(vl_api_sr_policies_dump_t *mp)
Definition: sr_api.c:292
IPv6 SR steering add/del.
Definition: sr.api:152
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
IPv6 SR policy deletion.
Definition: sr.api:119
vl_api_srv6_sid_t bsid_addr
Definition: sr.api:123
#define foreach_vpe_api_msg
Definition: sr_api.c:46
u32 fib_table
FIB table where localsid is registered.
Definition: sr.h:116
#define SR_BEHAVIOR_DX2
Definition: sr.h:41
vl_api_srv6_sid_t sids[16]
Definition: sr.api:30
IPv6 SR policy add.
Definition: sr.api:77
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
ip6_sr_policy_t * sr_policies
Definition: sr.h:198
SR Policy.
Definition: sr.h:80
struct sr_steering_key_t::@328::@331 l2
static void vl_api_sr_policy_del_t_handler(vl_api_sr_policy_del_t *mp)
Definition: sr_api.c:157
static clib_error_t * sr_api_hookup(vlib_main_t *vm)
Definition: sr_api.c:381
typedef prefix
Definition: ip_types.api:35
ip6_sr_sl_t * sid_lists
Definition: sr.h:195
Segment Routing data structures definitions.
Segment Routing main datastructure.
Definition: sr.h:189
IPv6 SR policy modification.
Definition: sr.api:100
#define vec_foreach(var, vec)
Vector iterator.
u8 traffic_type
Traffic type (IPv4, IPv6, L2)
Definition: sr.h:176
ip46_address_t next_hop
Next_hop for xconnect usage only.
Definition: sr.h:120
static void vl_api_sr_localsid_add_del_t_handler(vl_api_sr_localsid_add_del_t *mp)
Definition: sr_api.c:58
Dump the list of SR policies.
Definition: sr.api:193
#define SR_STEER_L2
Definition: sr.h:48
u32 sw_if_index
xconnect only
Definition: sr.h:112
IPv6 SR LocalSID add/del request.
Definition: sr.api:47
api_main_t api_main
Definition: api_shared.c:35
ip6_address_t localsid
LocalSID IPv6 address.
Definition: sr.h:104
u8 addr[16]
Definition: sr.api:23
static void vl_api_sr_set_encap_source_t_handler(vl_api_sr_set_encap_source_t *mp)
Definition: sr_api.c:172
int sr_policy_mod(ip6_address_t *bsid, u32 index, u32 fib_table, u8 operation, ip6_address_t *segments, u32 sl_index, u32 weight)
Modify an existing SR policy.
ip6_address_t bsid
BindingSID (key)
Definition: sr.h:84
#define SR_BEHAVIOR_DX6
Definition: sr.h:42
#define VALIDATE_SW_IF_INDEX(mp)
Dump the list of SR LocalSIDs.
Definition: sr.api:170