FD.io VPP  v18.04-17-g3a0d853
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_DEL, sr_policy_del) \
49 _(SR_STEERING_ADD_DEL, sr_steering_add_del) \
50 _(SR_SET_ENCAP_SOURCE, sr_set_encap_source) \
51 _(SR_LOCALSIDS_DUMP, sr_localsids_dump)
52 //_(SR_LOCALSID_BEHAVIORS, sr_localsid_behaviors_dump)
53 
56 {
57  vl_api_sr_localsid_add_del_reply_t *rmp;
58  int rv = 0;
59 /*
60  * int sr_cli_localsid (char is_del, ip6_address_t *localsid_addr,
61  * char end_psp, u8 behavior, u32 sw_if_index, u32 vlan_index, u32 fib_table,
62  * ip46_address_t *nh_addr, void *ls_plugin_mem)
63  */
64 
66 
67  rv = sr_cli_localsid (mp->is_del,
68  (ip6_address_t *) & mp->localsid_addr,
69  mp->end_psp,
70  mp->behavior,
71  ntohl (mp->sw_if_index),
72  ntohl (mp->vlan_index),
73  ntohl (mp->fib_table),
74  (ip46_address_t *) & mp->nh_addr, NULL);
75 
77 
78  REPLY_MACRO (VL_API_SR_LOCALSID_ADD_DEL_REPLY);
79 }
80 
81 static void
83 {
84  vl_api_sr_policy_add_reply_t *rmp;
85  ip6_address_t *segments = 0, *seg;
86  ip6_address_t *this_address = (ip6_address_t *) mp->segments;
87 
88  int i;
89  for (i = 0; i < mp->n_segments; i++)
90  {
91  vec_add2 (segments, seg, 1);
92  clib_memcpy (seg->as_u8, this_address->as_u8, sizeof (*this_address));
93  this_address++;
94  }
95 
96 /*
97  * sr_policy_add (ip6_address_t *bsid, ip6_address_t *segments,
98  * u32 weight, u8 behavior, u32 fib_table, u8 is_encap)
99  */
100  int rv = 0;
101  rv = sr_policy_add ((ip6_address_t *) & mp->bsid_addr,
102  segments,
103  ntohl (mp->weight),
104  mp->type, ntohl (mp->fib_table), mp->is_encap);
105 
106  REPLY_MACRO (VL_API_SR_POLICY_ADD_REPLY);
107 }
108 
109 static void
111 {
112  vl_api_sr_policy_mod_reply_t *rmp;
113 
114  ip6_address_t *segments = 0, *seg;
115  ip6_address_t *this_address = (ip6_address_t *) mp->segments;
116 
117  int i;
118  for (i = 0; i < mp->n_segments; i++)
119  {
120  vec_add2 (segments, seg, 1);
121  clib_memcpy (seg->as_u8, this_address->as_u8, sizeof (*this_address));
122  this_address++;
123  }
124 
125  int rv = 0;
126 /*
127  * int
128  * sr_policy_mod(ip6_address_t *bsid, u32 index, u32 fib_table,
129  * u8 operation, ip6_address_t *segments, u32 sl_index,
130  * u32 weight, u8 is_encap)
131  */
132  rv = sr_policy_mod ((ip6_address_t *) & mp->bsid_addr,
133  ntohl (mp->sr_policy_index),
134  ntohl (mp->fib_table),
135  mp->operation,
136  segments, ntohl (mp->sl_index), ntohl (mp->weight));
137 
138  REPLY_MACRO (VL_API_SR_POLICY_MOD_REPLY);
139 }
140 
141 static void
143 {
144  vl_api_sr_policy_del_reply_t *rmp;
145  int rv = 0;
146 /*
147  * int
148  * sr_policy_del (ip6_address_t *bsid, u32 index)
149  */
150  rv = sr_policy_del ((ip6_address_t *) & mp->bsid_addr,
151  ntohl (mp->sr_policy_index));
152 
153  REPLY_MACRO (VL_API_SR_POLICY_DEL_REPLY);
154 }
155 
156 static void
158 {
159  vl_api_sr_set_encap_source_reply_t *rmp;
160  int rv = 0;
162 
163  REPLY_MACRO (VL_API_SR_POLICY_DEL_REPLY);
164 }
165 
168 {
169  vl_api_sr_steering_add_del_reply_t *rmp;
170  int rv = 0;
171 /*
172  * int
173  * sr_steering_policy(int is_del, ip6_address_t *bsid, u32 sr_policy_index,
174  * u32 table_id, ip46_address_t *prefix, u32 mask_width, u32 sw_if_index,
175  * u8 traffic_type)
176  */
177 
179 
180  rv = sr_steering_policy (mp->is_del,
181  (ip6_address_t *) & mp->bsid_addr,
182  ntohl (mp->sr_policy_index),
183  ntohl (mp->table_id),
184  (ip46_address_t *) & mp->prefix_addr,
185  ntohl (mp->mask_width),
186  ntohl (mp->sw_if_index), mp->traffic_type);
187 
189 
190  REPLY_MACRO (VL_API_SR_STEERING_ADD_DEL_REPLY);
191 }
192 
193 static void send_sr_localsid_details
195 {
197 
198  rmp = vl_msg_api_alloc (sizeof (*rmp));
199  memset (rmp, 0, sizeof (*rmp));
200  rmp->_vl_msg_id = ntohs (VL_API_SR_LOCALSIDS_DETAILS);
201  memcpy (rmp->address, &t->localsid, sizeof (ip6_address_t));
202  rmp->end_psp = t->end_psp;
203  rmp->behavior = htons (t->behavior);
204  rmp->fib_table = htonl (t->fib_table);
205  memcpy (rmp->xconnect_next_hop, &t->next_hop, sizeof (ip6_address_t));
206  rmp->xconnect_iface_or_vrf_table = htonl (t->sw_if_index);
207  rmp->context = context;
208 
209  vl_api_send_msg (reg, (u8 *) rmp);
210 }
211 
214 {
216  ip6_sr_main_t *sm = &sr_main;
218 
220  if (!reg)
221  return;
222 
223  /* *INDENT-OFF* */
224  pool_foreach (t, sm->localsids,
225  ({
226  send_sr_localsid_details(t, reg, mp->context);
227  }));
228  /* *INDENT-ON* */
229 }
230 
231 
232 /*
233  * sr_api_hookup
234  * Add vpe's API message handlers to the table.
235  * vlib has alread mapped shared memory and
236  * added the client registration handlers.
237  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
238  */
239 #define vl_msg_name_crc_list
240 #include <vnet/vnet_all_api_h.h>
241 #undef vl_msg_name_crc_list
242 
243 static void
245 {
246 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
247  foreach_vl_msg_name_crc_sr;
248 #undef _
249 }
250 
251 static clib_error_t *
253 {
254  api_main_t *am = &api_main;
255 
256 #define _(N,n) \
257  vl_msg_api_set_handlers(VL_API_##N, #n, \
258  vl_api_##n##_t_handler, \
259  vl_noop_handler, \
260  vl_api_##n##_t_endian, \
261  vl_api_##n##_t_print, \
262  sizeof(vl_api_##n##_t), 1);
264 #undef _
265 
266  /*
267  * Manually register the sr policy add msg, so we trace
268  * enough bytes to capture a typical segment list
269  */
270  vl_msg_api_set_handlers (VL_API_SR_POLICY_ADD,
271  "sr_policy_add",
274  vl_api_sr_policy_add_t_endian,
276 
277  /*
278  * Manually register the sr policy mod msg, so we trace
279  * enough bytes to capture a typical segment list
280  */
281  vl_msg_api_set_handlers (VL_API_SR_POLICY_MOD,
282  "sr_policy_mod",
285  vl_api_sr_policy_mod_t_endian,
287 
288  /*
289  * Set up the (msg_name, crc, message-id) table
290  */
292 
293  return 0;
294 }
295 
297 
298 /*
299  * fd.io coding-style-patch-verification: ON
300  *
301  * Local Variables:
302  * eval: (c-set-style "gnu")
303  * End:
304  */
ip6_sr_main_t sr_main
Definition: sr.c:31
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
SR LocalSID.
Definition: sr.h:102
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:55
void vl_noop_handler(void *mp)
Definition: api_shared.c:780
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
u8 bsid_addr[16]
Definition: sr.api:85
u8 bsid_addr[16]
Definition: sr.api:60
static void vl_api_sr_policy_add_t_handler(vl_api_sr_policy_add_t *mp)
Definition: sr_api.c:82
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:559
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)
static void vl_api_sr_steering_add_del_t_handler(vl_api_sr_steering_add_del_t *mp)
Definition: sr_api.c:167
static void * vl_api_sr_policy_add_t_print(vl_api_sr_policy_add_t *mp, void *handle)
Definition: custom_dump.c:1306
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:440
static void vl_api_sr_policy_mod_t_handler(vl_api_sr_policy_mod_t *mp)
Definition: sr_api.c:110
static void send_sr_localsid_details(ip6_sr_localsid_t *t, vl_api_registration_t *reg, u32 context)
Definition: sr_api.c:194
static void vl_api_sr_localsids_dump_t_handler(vl_api_sr_localsids_dump_t *mp)
Definition: sr_api.c:213
static void setup_message_id_table(api_main_t *am)
Definition: sr_api.c:244
char end_psp
Combined with End.PSP?
Definition: sr.h:106
#define REPLY_MACRO(t)
void vl_msg_api_set_handlers(int msg_id, char *msg_name, void *handler, void *cleanup, void *endian, void *print, int msg_size, int traced)
Definition: api_shared.c:713
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:199
An API client registration, only in vpp/vlib.
Definition: api_common.h:44
ip6_sr_localsid_t * localsids
Definition: sr.h:204
#define BAD_SW_IF_INDEX_LABEL
VLIB_API_INIT_FUNCTION(sr_api_hookup)
vlib_main_t * vm
Definition: buffer.c:294
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.
#define clib_memcpy(a, b, c)
Definition: string.h:75
IPv6 SR Set SRv6 encapsulation source.
Definition: sr.api:115
IPv6 SR steering add/del.
Definition: sr.api:134
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
unsigned int u32
Definition: types.h:88
IPv6 SR policy deletion.
Definition: sr.api:101
#define foreach_vpe_api_msg
Definition: sr_api.c:46
u32 fib_table
FIB table where localsid is registered.
Definition: sr.h:116
static void * vl_api_sr_policy_mod_t_print(vl_api_sr_policy_mod_t *mp, void *handle)
Definition: custom_dump.c:1348
IPv6 SR policy add.
Definition: sr.api:56
unsigned char u8
Definition: types.h:56
static void vl_api_sr_policy_del_t_handler(vl_api_sr_policy_del_t *mp)
Definition: sr_api.c:142
static clib_error_t * sr_api_hookup(vlib_main_t *vm)
Definition: sr_api.c:252
Segment Routing data structures definitions.
Segment Routing main datastructure.
Definition: sr.h:189
IPv6 SR policy modification.
Definition: sr.api:81
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:55
u32 sw_if_index
xconnect only
Definition: sr.h:112
IPv6 SR LocalSID add/del request.
Definition: sr.api:32
api_main_t api_main
Definition: api_shared.c:35
ip6_address_t localsid
LocalSID IPv6 address.
Definition: sr.h:104
static void vl_api_sr_set_encap_source_t_handler(vl_api_sr_set_encap_source_t *mp)
Definition: sr_api.c:157
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.
#define VALIDATE_SW_IF_INDEX(mp)
Dump the list of SR LocalSIDs.
Definition: sr.api:152