FD.io VPP  v18.07.1-19-g511ce25
Vector Packet Processing
api.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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  */
15 
16 #include <lb/lb.h>
17 
18 #include <vppinfra/byte_order.h>
19 #include <vlibapi/api.h>
20 #include <vlibapi/api.h>
21 #include <vlibmemory/api.h>
22 
23 
24 #define vl_msg_id(n,h) n,
25 typedef enum {
26 #include <lb/lb.api.h>
27  /* We'll want to know how many messages IDs we need... */
29 } vl_msg_id_t;
30 #undef vl_msg_id
31 
32 
33 /* define message structures */
34 #define vl_typedefs
35 #include <lb/lb.api.h>
36 #undef vl_typedefs
37 
38 /* define generated endian-swappers */
39 #define vl_endianfun
40 #include <lb/lb.api.h>
41 #undef vl_endianfun
42 
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
44 
45 /* Get the API version number */
46 #define vl_api_version(n,v) static u32 api_version=(v);
47 #include <lb/lb.api.h>
48 #undef vl_api_version
49 
50 #define vl_msg_name_crc_list
51 #include <lb/lb.api.h>
52 #undef vl_msg_name_crc_list
53 
54 
55 #define REPLY_MSG_ID_BASE lbm->msg_id_base
57 
58 static void
60 {
61 #define _(id,n,crc) \
62  vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + lbm->msg_id_base);
63  foreach_vl_msg_name_crc_lb;
64 #undef _
65 }
66 
67 /* Macro to finish up custom dump fns */
68 #define FINISH \
69  vec_add1 (s, 0); \
70  vl_print (handle, (char *)s); \
71  vec_free (s); \
72  return handle;
73 
74 static void
77 {
78  lb_main_t *lbm = &lb_main;
79  vl_api_lb_conf_reply_t * rmp;
80  int rv = 0;
81 
85  mp->flow_timeout);
86 
87  REPLY_MACRO (VL_API_LB_CONF_REPLY);
88 }
89 
90 static void *vl_api_lb_conf_t_print
91 (vl_api_lb_conf_t *mp, void * handle)
92 {
93  u8 * s;
94  s = format (0, "SCRIPT: lb_conf ");
95  s = format (s, "%U ", format_ip4_address, (ip4_address_t *)&mp->ip4_src_address);
97  s = format (s, "%u ", mp->sticky_buckets_per_core);
98  s = format (s, "%u ", mp->flow_timeout);
99  FINISH;
100 }
101 
102 
103 static void
106 {
107  lb_main_t *lbm = &lb_main;
108  vl_api_lb_conf_reply_t * rmp;
109  int rv = 0;
110  lb_vip_add_args_t args;
111 
112  memcpy (&(args.prefix.ip6), mp->ip_prefix, sizeof(args.prefix.ip6));
113 
114  if (mp->is_del) {
115  u32 vip_index;
116  if (!(rv = lb_vip_find_index(&(args.prefix), mp->prefix_length, &vip_index)))
117  rv = lb_vip_del(vip_index);
118  } else {
119  u32 vip_index;
120  lb_vip_type_t type = 0;
121 
122  if (ip46_prefix_is_ip4(&(args.prefix), mp->prefix_length)) {
123  if (mp->encap == LB_ENCAP_TYPE_GRE4)
124  type = LB_VIP_TYPE_IP4_GRE4;
125  else if (mp->encap == LB_ENCAP_TYPE_GRE6)
126  type = LB_VIP_TYPE_IP4_GRE6;
127  else if (mp->encap == LB_ENCAP_TYPE_L3DSR)
128  type = LB_VIP_TYPE_IP4_L3DSR;
129  else if (mp->encap == LB_ENCAP_TYPE_NAT4)
130  type = LB_VIP_TYPE_IP4_NAT4;
131  } else {
132  if (mp->encap == LB_ENCAP_TYPE_GRE4)
133  type = LB_VIP_TYPE_IP6_GRE4;
134  else if (mp->encap == LB_ENCAP_TYPE_GRE6)
135  type = LB_VIP_TYPE_IP6_GRE6;
136  else if (mp->encap == LB_ENCAP_TYPE_NAT6)
137  type = LB_VIP_TYPE_IP6_NAT6;
138  }
139 
140  args.plen = mp->prefix_length;
141  args.type = type;
142  args.new_length = ntohl(mp->new_flows_table_length);
143 
144  if (mp->encap == LB_ENCAP_TYPE_L3DSR) {
145  args.encap_args.dscp = (u8)(mp->dscp & 0x3F);
146  }
147  else if ((mp->encap == LB_ENCAP_TYPE_NAT4)
148  ||(mp->encap == LB_ENCAP_TYPE_NAT6)) {
149  args.encap_args.srv_type = mp->type;
150  args.encap_args.port = ntohs(mp->port);
151  args.encap_args.target_port = ntohs(mp->target_port);
152  args.encap_args.node_port = ntohs(mp->node_port);
153  }
154 
155  rv = lb_vip_add(args, &vip_index);
156  }
157  REPLY_MACRO (VL_API_LB_ADD_DEL_VIP_REPLY);
158 }
159 
161 (vl_api_lb_add_del_vip_t *mp, void * handle)
162 {
163  u8 * s;
164  s = format (0, "SCRIPT: lb_add_del_vip ");
165  s = format (s, "%U ", format_ip46_prefix,
166  (ip46_address_t *)mp->ip_prefix, mp->prefix_length, IP46_TYPE_ANY);
167 
168  s = format (s, "%s ", (mp->encap == LB_ENCAP_TYPE_GRE4)? "gre4"
169  : (mp->encap == LB_ENCAP_TYPE_GRE6)? "gre6"
170  : (mp->encap == LB_ENCAP_TYPE_NAT4)? "nat4"
171  : (mp->encap == LB_ENCAP_TYPE_NAT6)? "nat6"
172  : "l3dsr");
173 
174  if (mp->encap==LB_ENCAP_TYPE_L3DSR)
175  {
176  s = format (s, "dscp %u ", mp->dscp);
177  }
178 
179  if ((mp->encap==LB_ENCAP_TYPE_NAT4)
180  || (mp->encap==LB_ENCAP_TYPE_NAT6))
181  {
182  s = format (s, "type %u ", mp->type);
183  s = format (s, "port %u ", mp->port);
184  s = format (s, "target_port %u ", mp->target_port);
185  s = format (s, "node_port %u ", mp->node_port);
186  }
187 
188  s = format (s, "%u ", mp->new_flows_table_length);
189  s = format (s, "%s ", mp->is_del?"del":"add");
190  FINISH;
191 }
192 
193 static void
196 {
197  lb_main_t *lbm = &lb_main;
198  vl_api_lb_conf_reply_t * rmp;
199  int rv = 0;
200  u32 vip_index;
201  ip46_address_t vip_ip_prefix;
202 
203  memcpy(&vip_ip_prefix.ip6, mp->vip_ip_prefix,
204  sizeof(vip_ip_prefix.ip6));
205 
206  ip46_address_t as_address;
207 
208  memcpy(&as_address.ip6, mp->as_address,
209  sizeof(as_address.ip6));
210 
211  if ((rv = lb_vip_find_index(&vip_ip_prefix, mp->vip_prefix_length, &vip_index)))
212  goto done;
213 
214  if (mp->is_del)
215  rv = lb_vip_del_ass(vip_index, &as_address, 1);
216  else
217  rv = lb_vip_add_ass(vip_index, &as_address, 1);
218 
219 done:
220  REPLY_MACRO (VL_API_LB_ADD_DEL_AS_REPLY);
221 }
222 
223 static void *vl_api_lb_add_del_as_t_print
224 (vl_api_lb_add_del_as_t *mp, void * handle)
225 {
226  u8 * s;
227  s = format (0, "SCRIPT: lb_add_del_as ");
228  s = format (s, "%U ", format_ip46_prefix,
229  (ip46_address_t *)mp->vip_ip_prefix, mp->vip_prefix_length, IP46_TYPE_ANY);
230  s = format (s, "%U ", format_ip46_address,
231  (ip46_address_t *)mp->as_address, IP46_TYPE_ANY);
232  s = format (s, "%s ", mp->is_del?"del":"add");
233  FINISH;
234 }
235 
236 /* List of message types that this plugin understands */
237 #define foreach_lb_plugin_api_msg \
238 _(LB_CONF, lb_conf) \
239 _(LB_ADD_DEL_VIP, lb_add_del_vip) \
240 _(LB_ADD_DEL_AS, lb_add_del_as)
241 
243 {
244  lb_main_t *lbm = &lb_main;
245  u8 *name = format (0, "lb_%08x%c", api_version, 0);
247  ((char *) name, VL_MSG_FIRST_AVAILABLE);
248 
249 #define _(N,n) \
250  vl_msg_api_set_handlers((VL_API_##N + lbm->msg_id_base), \
251  #n, \
252  vl_api_##n##_t_handler, \
253  vl_noop_handler, \
254  vl_api_##n##_t_endian, \
255  vl_api_##n##_t_print, \
256  sizeof(vl_api_##n##_t), 1);
258 #undef _
259 
260  /* Add our API messages to the global name_crc hash table */
262 
263  return 0;
264 }
265 
static void vl_api_lb_conf_t_handler(vl_api_lb_conf_t *mp)
Definition: api.c:76
u32 flow_timeout
Definition: lb.api:20
static void * vl_api_lb_add_del_vip_t_print(vl_api_lb_add_del_vip_t *mp, void *handle)
Definition: api.c:161
u16 msg_id_base
API dynamically registered base ID.
Definition: lb.h:501
int lb_conf(ip4_address_t *ip4_address, ip6_address_t *ip6_address, u32 per_cpu_sticky_buckets, u32 flow_timeout)
Fix global load-balancer parameters.
Definition: lb.c:464
u8 * format_ip46_prefix(u8 *s, va_list *args)
Definition: util.c:54
int lb_vip_add_ass(u32 vip_index, ip46_address_t *addresses, u32 n)
Definition: lb.c:527
format_function_t format_ip46_address
Definition: format.h:61
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
static void * vl_api_lb_conf_t_print(vl_api_lb_conf_t *mp, void *handle)
Definition: api.c:91
u8 ip6_src_address[16]
Definition: lb.api:18
unsigned char u8
Definition: types.h:56
static void * vl_api_lb_add_del_as_t_print(vl_api_lb_add_del_as_t *mp, void *handle)
Definition: api.c:224
vl_msg_id_t
Definition: api.c:25
format_function_t format_ip4_address
Definition: format.h:81
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:156
lb_main_t lb_main
Definition: lb.c:28
Definition: lb.h:418
unsigned int u32
Definition: types.h:88
#define FINISH
Definition: api.c:68
int lb_vip_del(u32 vip_index)
Definition: lb.c:936
#define foreach_lb_plugin_api_msg
Definition: api.c:237
#define REPLY_MACRO(t)
Add an application server for a given VIP.
Definition: lb.api:61
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:201
u32 new_length
Definition: lb.h:515
u8 vip_ip_prefix[16]
Definition: lb.api:64
#define ip46_prefix_is_ip4(ip46, len)
Definition: util.h:27
format_function_t format_ip6_address
Definition: format.h:99
vlib_main_t * vm
Definition: buffer.c:294
u32 new_flows_table_length
Definition: lb.api:49
int lb_vip_del_ass(u32 vip_index, ip46_address_t *addresses, u32 n)
Definition: lb.c:755
u32 sticky_buckets_per_core
Definition: lb.api:19
Add a virtual address (or prefix)
Definition: lb.api:38
lb_vip_type_t
The load balancer supports IPv4 and IPv6 traffic and GRE4, GRE6, L3DSR and NAT4, NAT6 encap...
Definition: lb.h:193
u8 as_address[16]
Definition: lb.api:66
int lb_vip_find_index(ip46_address_t *prefix, u8 plen, u32 *vip_index)
Definition: lb.c:500
ip46_address_t prefix
Definition: lb.h:512
lb_vip_encap_args_t encap_args
Definition: lb.h:516
u16 target_port
Definition: lb.h:221
Configure Load-Balancer global parameters.
Definition: lb.api:13
int lb_vip_add(lb_vip_add_args_t args, u32 *vip_index)
Definition: lb.c:823
u32 ip4_src_address
Definition: lb.api:17
static void vl_api_lb_add_del_vip_t_handler(vl_api_lb_add_del_vip_t *mp)
Definition: api.c:105
static void vl_api_lb_add_del_as_t_handler(vl_api_lb_add_del_as_t *mp)
Definition: api.c:195
static void setup_message_id_table(lb_main_t *lbm, api_main_t *am)
Definition: api.c:59
lb_vip_type_t type
Definition: lb.h:514
api_main_t api_main
Definition: api_shared.c:35
static clib_error_t * lb_api_init(vlib_main_t *vm)
Definition: api.c:242
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:872