FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
sr_mpls_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. Licensed under the Apache
6  * License, Version 2.0 (the "License"); you may not use this file except in
7  * compliance with the License. You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14  * License for the specific language governing permissions and limitations
15  * under the License.
16  * ------------------------------------------------------------------
17  */
18 
19 #include <vnet/vnet.h>
20 #include <vnet/srmpls/sr_mpls.h>
21 #include <vlibmemory/api.h>
22 
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/feature/feature.h>
26 
27 #include <vnet/ip/ip_types_api.h>
28 
29 #include <vnet/vnet_msg_enum.h>
30 
31 #define vl_typedefs /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
33 #undef vl_typedefs
34 
35 #define vl_endianfun /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
37 #undef vl_endianfun
38 
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
41 #define vl_printfun
42 #include <vnet/vnet_all_api_h.h>
43 #undef vl_printfun
44 
46 
47 #define foreach_vpe_api_msg \
48 _(SR_MPLS_POLICY_DEL, sr_mpls_policy_del) \
49 _(SR_MPLS_STEERING_ADD_DEL, sr_mpls_steering_add_del) \
50 _(SR_MPLS_POLICY_ASSIGN_ENDPOINT_COLOR, sr_mpls_policy_assign_endpoint_color)
51 
52 
53 static void
55 {
56  vl_api_sr_mpls_policy_add_reply_t *rmp;
57 
58  mpls_label_t *segments = 0, *seg;
59  mpls_label_t this_address = 0;
60 
61  int i;
62  for (i = 0; i < mp->n_segments; i++)
63  {
64  vec_add2 (segments, seg, 1);
65  this_address = ntohl (mp->segments[i]);
66  clib_memcpy (seg, &this_address, sizeof (this_address));
67  }
68 
69  int rv = 0;
70  rv = sr_mpls_policy_add (ntohl (mp->bsid),
71  segments, mp->is_spray, ntohl (mp->weight));
72  vec_free (segments);
73 
74  REPLY_MACRO (VL_API_SR_MPLS_POLICY_ADD_REPLY);
75 }
76 
77 static void
79 {
80  vl_api_sr_mpls_policy_mod_reply_t *rmp;
81 
82  mpls_label_t *segments = 0, *seg;
83  mpls_label_t this_address = 0;
84 
85  int i;
86  for (i = 0; i < mp->n_segments; i++)
87  {
88  vec_add2 (segments, seg, 1);
89  this_address = ntohl (mp->segments[i]);
90  clib_memcpy (seg, &this_address, sizeof (this_address));
91  }
92 
93  int rv = 0;
94  rv = sr_mpls_policy_mod (ntohl (mp->bsid),
95  ntohl (mp->operation), segments,
96  ntohl (mp->sl_index), ntohl (mp->weight));
97  vec_free (segments);
98 
99  REPLY_MACRO (VL_API_SR_MPLS_POLICY_MOD_REPLY);
100 }
101 
102 static void
104 {
105  vl_api_sr_mpls_policy_del_reply_t *rmp;
106  int rv = 0;
107  rv = sr_mpls_policy_del (ntohl (mp->bsid));
108 
109  REPLY_MACRO (VL_API_SR_MPLS_POLICY_DEL_REPLY);
110 }
111 
114 {
115  vl_api_sr_mpls_steering_add_del_reply_t *rmp;
117  ip46_address_t next_hop;
118  clib_memset (&prefix, 0, sizeof (ip46_address_t));
119 
120  ip_prefix_decode (&mp->prefix, &prefix);
121  ip_address_decode (&mp->next_hop, &next_hop);
122 
123  int rv = 0;
124  if (mp->is_del)
126  prefix.fp_len,
127  ip46_address_is_ip4 (&prefix.fp_addr) ?
129  ntohl (mp->table_id),
130  ntohl (mp->color));
131  else
132  rv = sr_mpls_steering_policy_add (ntohl (mp->bsid),
133  ntohl (mp->table_id),
134  &prefix.fp_addr,
135  prefix.fp_len,
136  ip46_address_is_ip4 (&prefix.fp_addr) ?
138  &next_hop,
139  ip46_address_is_ip4 (&next_hop) ?
141  ntohl (mp->color), mp->co_bits,
142  ntohl (mp->vpn_label));
143 
144  REPLY_MACRO (VL_API_SR_MPLS_STEERING_ADD_DEL_REPLY);
145 }
146 
149 {
150  vl_api_sr_mpls_policy_assign_endpoint_color_reply_t *rmp;
151  int rv = 0;
152 
153  ip46_address_t endpoint;
154  clib_memset (&endpoint, 0, sizeof (ip46_address_t));
156 
158  &endpoint,
161  ntohl (mp->color));
162 
163  REPLY_MACRO (VL_API_SR_MPLS_POLICY_ASSIGN_ENDPOINT_COLOR_REPLY);
164 }
165 
166 /*
167  * sr_mpls_api_hookup Add vpe's API message handlers to the table. vlib has
168  * already mapped shared memory and added the client registration handlers.
169  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
170  */
171 #define vl_msg_name_crc_list
172 #include <vnet/vnet_all_api_h.h>
173 #undef vl_msg_name_crc_list
174 
175 static void
177 {
178 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
179  foreach_vl_msg_name_crc_sr_mpls;
180 #undef _
181 }
182 
183 static clib_error_t *
185 {
187 
188 #define _(N,n) \
189  vl_msg_api_set_handlers(VL_API_##N, #n, \
190  vl_api_##n##_t_handler, \
191  vl_noop_handler, \
192  vl_api_##n##_t_endian, \
193  vl_api_##n##_t_print, \
194  sizeof(vl_api_##n##_t), 1);
196 #undef _
197 
198  /*
199  * Manually register the sr policy add msg, so we trace enough bytes
200  * to capture a typical segment list
201  */
202  vl_msg_api_set_handlers (VL_API_SR_MPLS_POLICY_ADD,
203  "sr_mpls_policy_add",
206  vl_api_sr_mpls_policy_add_t_endian,
208 
209  /*
210  * Manually register the sr policy mod msg, so we trace enough bytes
211  * to capture a typical segment list
212  */
213  vl_msg_api_set_handlers (VL_API_SR_MPLS_POLICY_MOD,
214  "sr_mpls_policy_mod",
217  vl_api_sr_mpls_policy_mod_t_endian,
218  vl_api_sr_mpls_policy_mod_t_print, 256, 1);
219 
220  /*
221  * Set up the (msg_name, crc, message-id) table
222  */
224 
225  return 0;
226 }
227 
229 
230 /*
231  * fd.io coding-style-patch-verification: ON
232  *
233  * Local Variables: eval: (c-set-style "gnu") End:
234  */
vl_api_sr_mpls_policy_add_t::segments
u32 segments[n_segments]
Definition: sr_mpls.api:38
vl_api_sr_mpls_steering_add_del_t::is_del
bool is_del[default=false]
Definition: sr_mpls.api:94
api.h
sr_mpls_policy_assign_endpoint_color
int sr_mpls_policy_assign_endpoint_color(mpls_label_t bsid, ip46_address_t *endpoint, u8 endpoint_type, u32 color)
Update the Endpoint,Color tuple of an SR policy.
Definition: sr_mpls_policy.c:671
vl_api_sr_mpls_policy_add_t
MPLS SR policy add.
Definition: sr_mpls.api:30
clib_memcpy
#define clib_memcpy(d, s, n)
Definition: string.h:197
vl_api_sr_mpls_steering_add_del_t::table_id
u32 table_id
Definition: sr_mpls.api:96
vl_api_sr_mpls_steering_add_del_t_handler
static void vl_api_sr_mpls_steering_add_del_t_handler(vl_api_sr_mpls_steering_add_del_t *mp)
Definition: sr_mpls_api.c:113
vl_api_sr_mpls_policy_add_t::weight
u32 weight
Definition: sr_mpls.api:35
vl_api_sr_mpls_policy_del_t::bsid
u32 bsid
Definition: sr_mpls.api:74
ip46_address_is_ip4
static u8 ip46_address_is_ip4(const ip46_address_t *ip46)
Definition: ip46_address.h:55
sr_mpls.h
Segment Routing MPLS data structures definitions.
am
app_main_t * am
Definition: application.c:489
vl_api_sr_mpls_policy_assign_endpoint_color_t
MPLS SR steering add/del.
Definition: sr_mpls.api:112
vl_api_sr_mpls_policy_mod_t_handler
static void vl_api_sr_mpls_policy_mod_t_handler(vl_api_sr_mpls_policy_mod_t *mp)
Definition: sr_mpls_api.c:78
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
vl_api_sr_mpls_policy_mod_t::n_segments
u8 n_segments
Definition: sr_mpls.api:61
ip_address_decode
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Decode/Encode for struct/union types.
Definition: ip_types_api.c:186
vl_api_sr_mpls_policy_assign_endpoint_color_t::endpoint
vl_api_address_t endpoint
Definition: sr_mpls.api:117
vl_api_sr_mpls_policy_mod_t::sl_index
u32 sl_index
Definition: sr_mpls.api:59
vl_api_sr_mpls_steering_add_del_t::next_hop
vl_api_address_t next_hop
Definition: sr_mpls.api:99
vl_api_sr_mpls_steering_add_del_t
MPLS SR steering add/del.
Definition: sr_mpls.api:90
feature.h
vec_add2
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:644
vl_api_sr_mpls_policy_mod_t::weight
u32 weight
Definition: sr_mpls.api:60
sr_mpls_policy_add
int sr_mpls_policy_add(mpls_label_t bsid, mpls_label_t *segments, u8 behavior, u32 weight)
Create a new SR policy.
Definition: sr_mpls_policy.c:152
vnet_msg_enum.h
vl_api_sr_mpls_steering_add_del_t::co_bits
u8 co_bits
Definition: sr_mpls.api:101
REPLY_MACRO
#define REPLY_MACRO(t)
Definition: api_helper_macros.h:30
setup_message_id_table
static void setup_message_id_table(api_main_t *am)
Definition: sr_mpls_api.c:176
sr_mpls_api_hookup
static clib_error_t * sr_mpls_api_hookup(vlib_main_t *vm)
Definition: sr_mpls_api.c:184
ip_prefix_decode
void ip_prefix_decode(const vl_api_prefix_t *in, fib_prefix_t *out)
Definition: ip_types_api.c:259
vl_api_sr_mpls_steering_add_del_t::bsid
u32 bsid
Definition: sr_mpls.api:95
vl_api_sr_mpls_policy_add_t::n_segments
u8 n_segments
Definition: sr_mpls.api:37
vl_api_sr_mpls_steering_add_del_t::color
u32 color
Definition: sr_mpls.api:100
vlibapi_get_main
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:390
SR_STEER_IPV4
#define SR_STEER_IPV4
Definition: sr_mpls.h:41
interface.h
vl_api_sr_mpls_policy_del_t_handler
static void vl_api_sr_mpls_policy_del_t_handler(vl_api_sr_mpls_policy_del_t *mp)
Definition: sr_mpls_api.c:103
i
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:261
vl_api_sr_mpls_policy_assign_endpoint_color_t::bsid
u32 bsid
Definition: sr_mpls.api:116
vl_api_sr_mpls_steering_add_del_t::vpn_label
u32 vpn_label
Definition: sr_mpls.api:102
vl_api_sr_mpls_policy_add_t::bsid
u32 bsid
Definition: sr_mpls.api:34
sr_mpls_steering_policy_add
int sr_mpls_steering_policy_add(mpls_label_t bsid, u32 table_id, ip46_address_t *prefix, u32 mask_width, u8 traffic_type, ip46_address_t *next_hop, u8 nh_type, u32 color, char co_bits, mpls_label_t vpn_label)
Steer traffic L3 traffic through a given SR-MPLS policy.
Definition: sr_mpls_steering.c:380
vl_api_sr_mpls_policy_mod_t::bsid
u32 bsid
Definition: sr_mpls.api:57
vl_msg_api_set_handlers
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:872
vl_api_sr_mpls_policy_assign_endpoint_color_t_handler
static void vl_api_sr_mpls_policy_assign_endpoint_color_t_handler(vl_api_sr_mpls_policy_assign_endpoint_color_t *mp)
Definition: sr_mpls_api.c:148
api_main_t
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:228
vl_api_sr_mpls_policy_assign_endpoint_color_t::color
u32 color
Definition: sr_mpls.api:118
vec_free
#define vec_free(V)
Free vector's memory (no header).
Definition: vec.h:395
SR_STEER_IPV6
#define SR_STEER_IPV6
Definition: sr_mpls.h:42
vl_api_sr_mpls_policy_add_t_print
static void * vl_api_sr_mpls_policy_add_t_print(vl_api_sr_mpls_policy_add_t *mp, void *handle)
Definition: custom_dump.c:905
vl_noop_handler
void vl_noop_handler(void *mp)
Definition: api_shared.c:955
vl_api_sr_mpls_policy_mod_t::operation
vl_api_sr_policy_op_t operation
Definition: sr_mpls.api:58
endpoint
vl_api_address_t endpoint
Definition: wireguard.api:103
vl_api_sr_mpls_policy_add_t_handler
static void vl_api_sr_mpls_policy_add_t_handler(vl_api_sr_mpls_policy_add_t *mp)
Definition: sr_mpls_api.c:54
foreach_vpe_api_msg
#define foreach_vpe_api_msg
Definition: sr_mpls_api.c:47
vl_api_sr_mpls_policy_del_t
MPLS SR policy deletion.
Definition: sr_mpls.api:70
api_helper_macros.h
sr_mpls_steering_policy_del
int sr_mpls_steering_policy_del(ip46_address_t *prefix, u32 mask_width, u8 traffic_type, u32 table_id, u32 color)
Delete steering rule for an SR-MPLS policy.
Definition: sr_mpls_steering.c:547
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
vlib_main_t
Definition: main.h:102
clib_error_t
Definition: clib_error.h:21
vnet_all_api_h.h
vl_api_sr_mpls_policy_add_t::is_spray
bool is_spray
Definition: sr_mpls.api:36
mpls_label_t
u32 mpls_label_t
A label value only, i.e.
Definition: packet.h:26
rv
int __clib_unused rv
Definition: application.c:491
sr_mpls_policy_del
int sr_mpls_policy_del(mpls_label_t bsid)
Delete a SR policy.
Definition: sr_mpls_policy.c:207
vnet.h
api_errno.h
vl_api_sr_mpls_policy_mod_t::segments
u32 segments[n_segments]
Definition: sr_mpls.api:62
VLIB_API_INIT_FUNCTION
VLIB_API_INIT_FUNCTION(sr_mpls_api_hookup)
vl_api_sr_mpls_steering_add_del_t::prefix
vl_api_prefix_t prefix
Definition: sr_mpls.api:97
ip_types_api.h
fib_prefix_t_
Aggregate type for a prefix.
Definition: fib_types.h:202
vl_api_sr_mpls_policy_mod_t
MPLS SR policy modification.
Definition: sr_mpls.api:53
prefix
vl_api_prefix_t prefix
Definition: ip.api:146
sr_mpls_policy_mod
int sr_mpls_policy_mod(mpls_label_t bsid, u8 operation, mpls_label_t *segments, u32 sl_index, u32 weight)
Modify an existing SR policy.
Definition: sr_mpls_policy.c:299