src/plugins/lb/api.c

   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 <vnet/vnet.h>
  17 #include <vnet/plugin/plugin.h>
  18 #include <lb/lb.h>
  19
  20 #include <vppinfra/byte_order.h>
  21 #include <vppinfra/string.h>
  22 #include <vpp/api/types.h>
  23 #include <vlibapi/api.h>
  24 #include <vlibmemory/api.h>
  25 #include <vpp/app/version.h>
  26 #include <vnet/format_fns.h>
  27 #include <vnet/ip/ip_types_api.h>
  28
  29 /* define message IDs */
  30 #include <lb/lb.api_enum.h>
  31 #include <lb/lb.api_types.h>
  32
  33 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  34
  35 #define REPLY_MSG_ID_BASE lbm->msg_id_base
  36 #include <vlibapi/api_helper_macros.h>
  37
  38 /* Macro to finish up custom dump fns */
  39 #define FINISH                                  \
  40     vec_add1 (s, 0);                            \
  41     vl_print (handle, (char *)s);               \
  42     vec_free (s);                               \
  43     return handle;
  44
  45 static void
  46 vl_api_lb_conf_t_handler
  47 (vl_api_lb_conf_t * mp)
  48 {
  49   lb_main_t *lbm = &lb_main;
  50   vl_api_lb_conf_reply_t * rmp;
  51   u32 sticky_buckets_per_core, flow_timeout;
  52   int rv = 0;
  53
  54   sticky_buckets_per_core = mp->sticky_buckets_per_core == ~0
  55                             ? lbm->per_cpu_sticky_buckets
  56                             : ntohl(mp->sticky_buckets_per_core);
  57   flow_timeout = mp->flow_timeout == ~0
  58                  ? lbm->flow_timeout
  59                  : ntohl(mp->flow_timeout);
  60
  61   rv = lb_conf((ip4_address_t *)&mp->ip4_src_address,
  62                (ip6_address_t *)&mp->ip6_src_address,
  63                sticky_buckets_per_core, flow_timeout);
  64
  65  REPLY_MACRO (VL_API_LB_CONF_REPLY);
  66 }
  67
  68 static void *vl_api_lb_conf_t_print
  69 (vl_api_lb_conf_t *mp, void * handle)
  70 {
  71   u8 * s;
  72   s = format (0, "SCRIPT: lb_conf ");
  73   s = format (s, "%U ", format_ip4_address, (ip4_address_t *)&mp->ip4_src_address);
  74   s = format (s, "%U ", format_ip6_address, (ip6_address_t *)&mp->ip6_src_address);
  75   s = format (s, "%u ", mp->sticky_buckets_per_core);
  76   s = format (s, "%u ", mp->flow_timeout);
  77   FINISH;
  78 }
  79
  80
  81 static void
  82 vl_api_lb_add_del_vip_t_handler
  83 (vl_api_lb_add_del_vip_t * mp)
  84 {
  85   lb_main_t *lbm = &lb_main;
  86   vl_api_lb_conf_reply_t * rmp;
  87   int rv = 0;
  88   lb_vip_add_args_t args;
  89
  90   /* if port == 0, it means all-port VIP */
  91   if (mp->port == 0)
  92     {
  93       mp->protocol = ~0;
  94     }
  95
  96   ip_address_decode (&mp->pfx.address, &(args.prefix));
  97
  98   if (mp->is_del) {
  99     u32 vip_index;
 100     if (!(rv = lb_vip_find_index(&(args.prefix), mp->pfx.len,
 101                                  mp->protocol, ntohs(mp->port), &vip_index)))
 102       rv = lb_vip_del(vip_index);
 103   } else {
 104     u32 vip_index;
 105     lb_vip_type_t type = 0;
 106
 107     if (ip46_prefix_is_ip4(&(args.prefix), mp->pfx.len)) {
 108         if (mp->encap == LB_API_ENCAP_TYPE_GRE4)
 109             type = LB_VIP_TYPE_IP4_GRE4;
 110         else if (mp->encap == LB_API_ENCAP_TYPE_GRE6)
 111             type = LB_VIP_TYPE_IP4_GRE6;
 112         else if (mp->encap == LB_API_ENCAP_TYPE_L3DSR)
 113             type = LB_VIP_TYPE_IP4_L3DSR;
 114         else if (mp->encap == LB_API_ENCAP_TYPE_NAT4)
 115             type = LB_VIP_TYPE_IP4_NAT4;
 116     } else {
 117         if (mp->encap == LB_API_ENCAP_TYPE_GRE4)
 118             type = LB_VIP_TYPE_IP6_GRE4;
 119         else if (mp->encap == LB_API_ENCAP_TYPE_GRE6)
 120             type = LB_VIP_TYPE_IP6_GRE6;
 121         else if (mp->encap == LB_API_ENCAP_TYPE_NAT6)
 122             type = LB_VIP_TYPE_IP6_NAT6;
 123     }
 124
 125     args.plen = mp->pfx.len;
 126     args.protocol = mp->protocol;
 127     args.port = ntohs(mp->port);
 128     args.type = type;
 129     args.new_length = ntohl(mp->new_flows_table_length);
 130
 131     if (mp->encap == LB_API_ENCAP_TYPE_L3DSR) {
 132         args.encap_args.dscp = (u8)(mp->dscp & 0x3F);
 133       }
 134     else if ((mp->encap == LB_API_ENCAP_TYPE_NAT4)
 135             ||(mp->encap == LB_API_ENCAP_TYPE_NAT6)) {
 136         args.encap_args.srv_type = mp->type;
 137         args.encap_args.target_port = ntohs(mp->target_port);
 138       }
 139
 140     rv = lb_vip_add(args, &vip_index);
 141   }
 142  REPLY_MACRO (VL_API_LB_ADD_DEL_VIP_REPLY);
 143 }
 144
 145 static void *vl_api_lb_add_del_vip_t_print
 146 (vl_api_lb_add_del_vip_t *mp, void * handle)
 147 {
 148   u8 * s;
 149   s = format (0, "SCRIPT: lb_add_del_vip ");
 150   s = format (s, "%U", format_vl_api_prefix,
 151        &mp->pfx);
 152
 153   s = format (s, "%s ", (mp->encap == LB_API_ENCAP_TYPE_GRE4)? "gre4"
 154               : (mp->encap == LB_API_ENCAP_TYPE_GRE6)? "gre6"
 155               : (mp->encap == LB_API_ENCAP_TYPE_NAT4)? "nat4"
 156               : (mp->encap == LB_API_ENCAP_TYPE_NAT6)? "nat6"
 157               : "l3dsr");
 158
 159   if (mp->encap==LB_API_ENCAP_TYPE_L3DSR)
 160     {
 161       s = format (s, "dscp %u ", mp->dscp);
 162     }
 163
 164   if ((mp->encap==LB_API_ENCAP_TYPE_NAT4)
 165       || (mp->encap==LB_API_ENCAP_TYPE_NAT6))
 166     {
 167       s = format (s, "type %u ", mp->type);
 168       s = format (s, "port %u ", mp->port);
 169       s = format (s, "target_port %u ", mp->target_port);
 170     }
 171
 172   s = format (s, "%u ", mp->new_flows_table_length);
 173   s = format (s, "%s ", mp->is_del?"del":"add");
 174   FINISH;
 175 }
 176
 177 static void
 178 vl_api_lb_add_del_as_t_handler
 179 (vl_api_lb_add_del_as_t * mp)
 180 {
 181   lb_main_t *lbm = &lb_main;
 182   vl_api_lb_conf_reply_t * rmp;
 183   int rv = 0;
 184   u32 vip_index;
 185   ip46_address_t vip_ip_prefix;
 186   ip46_address_t as_address;
 187
 188   /* if port == 0, it means all-port VIP */
 189   if (mp->port == 0)
 190     {
 191       mp->protocol = ~0;
 192     }
 193   ip_address_decode (&mp->pfx.address, &vip_ip_prefix);
 194   ip_address_decode (&mp->as_address, &as_address);
 195
 196   if ((rv = lb_vip_find_index(&vip_ip_prefix, mp->pfx.len,
 197                               mp->protocol, ntohs(mp->port), &vip_index)))
 198     goto done;
 199
 200   if (mp->is_del)
 201     rv = lb_vip_del_ass(vip_index, &as_address, 1, mp->is_flush);
 202   else
 203     rv = lb_vip_add_ass(vip_index, &as_address, 1);
 204
 205 done:
 206  REPLY_MACRO (VL_API_LB_ADD_DEL_AS_REPLY);
 207 }
 208
 209 static void *vl_api_lb_add_del_as_t_print
 210 (vl_api_lb_add_del_as_t *mp, void * handle)
 211 {
 212   u8 * s;
 213   ip46_address_t address;
 214   s = format (0, "SCRIPT: lb_add_del_as ");
 215   s = format (s, "%U ", format_vl_api_prefix,
 216        &mp->pfx);
 217   s = format(s, "%u ", mp->protocol);
 218   if (ip_address_decode (&mp->as_address, &address) == IP46_TYPE_IP6)
 219   s = format (s, "%U ", format_ip6_address,
 220                 (ip6_address_t *) & address.ip6);
 221   else
 222   s = format (s, "%U ", format_ip4_address,
 223                 (ip6_address_t *) & address.ip4);
 224   s = format (s, "%s ", mp->is_del?"del":"add");
 225   FINISH;
 226 }
 227
 228 static void
 229 vl_api_lb_vip_dump_t_handler
 230 (vl_api_lb_vip_dump_t * mp)
 231 {
 232
 233   vl_api_registration_t *reg;
 234   reg = vl_api_client_index_to_registration (mp->client_index);
 235   if (!reg)
 236     return;
 237
 238   lb_main_t *lbm = &lb_main;
 239   vl_api_lb_vip_details_t * rmp;
 240   int msg_size = 0;
 241   lb_vip_t *vip = 0;
 242
 243   /* construct vip list */
 244   pool_foreach(vip, lbm->vips, {
 245       /* Hide dummy VIP */
 246       if (vip != lbm->vips) {
 247         msg_size = sizeof (*rmp);
 248         rmp = vl_msg_api_alloc (msg_size);
 249         memset (rmp, 0, msg_size);
 250         rmp->_vl_msg_id =
 251         htons (VL_API_LB_VIP_DETAILS + lbm->msg_id_base);
 252         rmp->context = mp->context;
 253
 254         ip_address_encode(&vip->prefix, IP46_TYPE_ANY, &rmp->vip.pfx.address);
 255         rmp->vip.pfx.len = vip->plen;
 256         rmp->vip.protocol = htonl (vip->protocol);
 257         rmp->vip.port = htons(vip->port);
 258         rmp->encap = htonl(vip->type);
 259         rmp->dscp = vip->encap_args.dscp;
 260         rmp->srv_type = vip->encap_args.srv_type;
 261         rmp->target_port = htons(vip->encap_args.target_port);
 262         rmp->flow_table_length = htonl(vip->new_flow_table_mask + 1);
 263
 264         vl_api_send_msg (reg, (u8 *) rmp);
 265       }
 266   });
 267
 268
 269 }
 270
 271 static void send_lb_as_details
 272   (vl_api_registration_t * reg, u32 context, lb_vip_t * vip)
 273 {
 274   vl_api_lb_as_details_t *rmp;
 275   lb_main_t *lbm = &lb_main;
 276   int msg_size = 0;
 277   u32 *as_index;
 278   u32 asindex = 0;
 279
 280   /* construct as list under this vip */
 281   lb_as_t *as;
 282
 283   pool_foreach(as_index, vip->as_indexes, {
 284       /* Hide dummy As for specific VIP */
 285       if (*as_index != 0) {
 286         as = &lbm->ass[*as_index];
 287         msg_size = sizeof (*rmp);
 288         rmp = vl_msg_api_alloc (msg_size);
 289         memset (rmp, 0, msg_size);
 290         rmp->_vl_msg_id =
 291           htons (VL_API_LB_AS_DETAILS + lbm->msg_id_base);
 292         rmp->context = context;
 293         ip_address_encode(&vip->prefix, IP46_TYPE_ANY, (vl_api_address_t *)&rmp->vip.pfx.address);
 294         rmp->vip.pfx.len = vip->plen;
 295         rmp->vip.protocol = htonl (vip->protocol);
 296         rmp->vip.port = htons(vip->port);
 297         ip_address_encode(&as->address, IP46_TYPE_ANY, &rmp->app_srv);
 298         rmp->flags = as->flags;
 299         rmp->in_use_since = htonl(as->last_used);
 300
 301         vl_api_send_msg (reg, (u8 *) rmp);
 302         asindex++;
 303       }
 304   });
 305
 306
 307 }
 308
 309 static void
 310 vl_api_lb_as_dump_t_handler
 311 (vl_api_lb_as_dump_t * mp)
 312 {
 313   lb_main_t *lbm = &lb_main;
 314   lb_vip_t *vip = 0;
 315   u8 dump_all = 0;
 316   ip46_address_t prefix;
 317
 318   vl_api_registration_t *reg;
 319   reg = vl_api_client_index_to_registration (mp->client_index);
 320   if (!reg)
 321     return;
 322
 323   clib_memcpy(&prefix.ip6, mp->pfx.address.un.ip6, sizeof(mp->pfx.address.un.ip6));
 324
 325   dump_all = (prefix.ip6.as_u64[0] == 0) && (prefix.ip6.as_u64[1] == 0);
 326
 327   /* *INDENT-OFF* */
 328   pool_foreach(vip, lbm->vips,
 329   ({
 330     if ( dump_all
 331         || ((prefix.as_u64[0] == vip->prefix.as_u64[0])
 332         && (prefix.as_u64[1] == vip->prefix.as_u64[1])
 333         && (mp->protocol == vip->protocol)
 334         && (mp->port == vip->port)) )
 335       {
 336         send_lb_as_details(reg, mp->context, vip);
 337       }
 338   }));
 339   /* *INDENT-ON* */
 340 }
 341
 342 static void
 343 vl_api_lb_flush_vip_t_handler
 344 (vl_api_lb_flush_vip_t * mp)
 345 {
 346   lb_main_t *lbm = &lb_main;
 347   int rv = 0;
 348   ip46_address_t vip_prefix;
 349   u8 vip_plen;
 350   u32 vip_index;
 351   vl_api_lb_flush_vip_reply_t * rmp;
 352
 353   if (mp->port == 0)
 354     {
 355       mp->protocol = ~0;
 356     }
 357
 358   memcpy (&(vip_prefix.ip6), mp->pfx.address.un.ip6, sizeof(vip_prefix.ip6));
 359
 360   vip_plen = mp->pfx.len;
 361
 362   rv = lb_vip_find_index(&vip_prefix, vip_plen, mp->protocol,
 363                          ntohs(mp->port), &vip_index);
 364
 365   rv = lb_flush_vip_as(vip_index, ~0);
 366
 367  REPLY_MACRO (VL_API_LB_FLUSH_VIP_REPLY);
 368 }
 369
 370 static void vl_api_lb_add_del_intf_nat4_t_handler
 371   (vl_api_lb_add_del_intf_nat4_t * mp)
 372 {
 373   lb_main_t *lbm = &lb_main;
 374   vl_api_lb_add_del_intf_nat4_reply_t *rmp;
 375   u32 sw_if_index = ntohl (mp->sw_if_index);
 376   u8 is_del;
 377   int rv = 0;
 378
 379   is_del = !mp->is_add;
 380
 381   VALIDATE_SW_IF_INDEX (mp);
 382
 383   rv = lb_nat4_interface_add_del(sw_if_index, is_del);
 384
 385   BAD_SW_IF_INDEX_LABEL;
 386
 387   REPLY_MACRO (VL_API_LB_ADD_DEL_INTF_NAT4_REPLY);
 388 }
 389
 390 static void vl_api_lb_add_del_intf_nat6_t_handler
 391   (vl_api_lb_add_del_intf_nat6_t * mp)
 392 {
 393   lb_main_t *lbm = &lb_main;
 394   vl_api_lb_add_del_intf_nat6_reply_t *rmp;
 395   u32 sw_if_index = ntohl (mp->sw_if_index);
 396   u8 is_del;
 397   int rv = 0;
 398
 399   is_del = !mp->is_add;
 400
 401   VALIDATE_SW_IF_INDEX (mp);
 402
 403   rv = lb_nat6_interface_add_del(sw_if_index, is_del);
 404
 405   BAD_SW_IF_INDEX_LABEL;
 406
 407   REPLY_MACRO (VL_API_LB_ADD_DEL_INTF_NAT6_REPLY);
 408 }
 409
 410 static void *vl_api_lb_flush_vip_t_print
 411 (vl_api_lb_flush_vip_t *mp, void * handle)
 412 {
 413   u8 * s;
 414   s = format (0, "SCRIPT: lb_add_del_vip ");
 415   s = format (s, "%U/%d", format_vl_api_address,
 416        &mp->pfx.address, mp->pfx.len);
 417   s = format (s, "protocol %u ", mp->protocol);
 418   s = format (s, "port %u ", mp->port);
 419
 420   FINISH;
 421 }
 422
 423 #include <lb/lb.api.c>
 424 static clib_error_t * lb_api_init (vlib_main_t * vm)
 425 {
 426   lb_main_t * lbm = &lb_main;
 427
 428   lbm->vlib_main = vm;
 429   lbm->vnet_main = vnet_get_main();
 430
 431   /* Ask for a correctly-sized block of API message decode slots */
 432   lbm->msg_id_base = setup_message_id_table ();
 433
 434   return 0;
 435 }
 436
 437 VLIB_INIT_FUNCTION (lb_api_init);