src/plugins/lb/cli.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 <lb/lb.h>
  17 #include <lb/util.h>
  18
  19 static clib_error_t *
  20 lb_vip_command_fn (vlib_main_t * vm,
  21               unformat_input_t * input, vlib_cli_command_t * cmd)
  22 {
  23   unformat_input_t _line_input, *line_input = &_line_input;
  24   lb_vip_add_args_t args;
  25   u8 del = 0;
  26   int ret;
  27   u32 port = 0;
  28   u32 encap = 0;
  29   u32 dscp = ~0;
  30   u32 srv_type = LB_SRV_TYPE_CLUSTERIP;
  31   u32 target_port = 0;
  32   clib_error_t *error = 0;
  33
  34   args.new_length = 1024;
  35
  36   if (!unformat_user (input, unformat_line_input, line_input))
  37     return 0;
  38
  39   if (!unformat(line_input, "%U", unformat_ip46_prefix, &(args.prefix),
  40                 &(args.plen), IP46_TYPE_ANY, &(args.plen))) {
  41     error = clib_error_return (0, "invalid vip prefix: '%U'",
  42                                format_unformat_error, line_input);
  43     goto done;
  44   }
  45
  46   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
  47   {
  48     if (unformat(line_input, "new_len %d", &(args.new_length)))
  49       ;
  50     else if (unformat(line_input, "del"))
  51       del = 1;
  52     else if (unformat(line_input, "protocol tcp"))
  53       {
  54         args.protocol = (u8)IP_PROTOCOL_TCP;
  55       }
  56     else if (unformat(line_input, "protocol udp"))
  57       {
  58         args.protocol = (u8)IP_PROTOCOL_UDP;
  59       }
  60     else if (unformat(line_input, "port %d", &port))
  61       ;
  62     else if (unformat(line_input, "encap gre4"))
  63       encap = LB_ENCAP_TYPE_GRE4;
  64     else if (unformat(line_input, "encap gre6"))
  65       encap = LB_ENCAP_TYPE_GRE6;
  66     else if (unformat(line_input, "encap l3dsr"))
  67       encap = LB_ENCAP_TYPE_L3DSR;
  68     else if (unformat(line_input, "encap nat4"))
  69       encap = LB_ENCAP_TYPE_NAT4;
  70     else if (unformat(line_input, "encap nat6"))
  71       encap = LB_ENCAP_TYPE_NAT6;
  72     else if (unformat(line_input, "dscp %d", &dscp))
  73       ;
  74     else if (unformat(line_input, "type clusterip"))
  75       srv_type = LB_SRV_TYPE_CLUSTERIP;
  76     else if (unformat(line_input, "type nodeport"))
  77       srv_type = LB_SRV_TYPE_NODEPORT;
  78     else if (unformat(line_input, "target_port %d", &target_port))
  79       ;
  80     else {
  81       error = clib_error_return (0, "parse error: '%U'",
  82                                 format_unformat_error, line_input);
  83       goto done;
  84     }
  85   }
  86
  87   /* if port == 0, it means all-port VIP */
  88   if (port == 0)
  89     {
  90       args.protocol = ~0;
  91       args.port = 0;
  92     }
  93   else
  94     {
  95       args.port = (u16)port;
  96     }
  97
  98   if ((encap != LB_ENCAP_TYPE_L3DSR) && (dscp != ~0))
  99     {
 100       error = clib_error_return(0, "lb_vip_add error: "
 101                                 "should not configure dscp for none L3DSR.");
 102       goto done;
 103     }
 104
 105   if ((encap == LB_ENCAP_TYPE_L3DSR) && (dscp >= 64))
 106     {
 107       error = clib_error_return(0, "lb_vip_add error: "
 108                                 "dscp for L3DSR should be less than 64.");
 109       goto done;
 110     }
 111
 112   if (ip46_prefix_is_ip4(&(args.prefix), (args.plen)))
 113     {
 114       if (encap == LB_ENCAP_TYPE_GRE4)
 115         args.type = LB_VIP_TYPE_IP4_GRE4;
 116       else if (encap == LB_ENCAP_TYPE_GRE6)
 117         args.type = LB_VIP_TYPE_IP4_GRE6;
 118       else if (encap == LB_ENCAP_TYPE_L3DSR)
 119         args.type = LB_VIP_TYPE_IP4_L3DSR;
 120       else if (encap == LB_ENCAP_TYPE_NAT4)
 121         args.type = LB_VIP_TYPE_IP4_NAT4;
 122       else if (encap == LB_ENCAP_TYPE_NAT6)
 123         {
 124           error = clib_error_return(0, "currently does not support NAT46");
 125           goto done;
 126         }
 127     }
 128   else
 129     {
 130       if (encap == LB_ENCAP_TYPE_GRE4)
 131         args.type = LB_VIP_TYPE_IP6_GRE4;
 132       else if (encap == LB_ENCAP_TYPE_GRE6)
 133         args.type = LB_VIP_TYPE_IP6_GRE6;
 134       else if (encap == LB_ENCAP_TYPE_NAT6)
 135         args.type = LB_VIP_TYPE_IP6_NAT6;
 136       else if (encap == LB_ENCAP_TYPE_NAT4)
 137         {
 138           error = clib_error_return(0, "currently does not support NAT64");
 139           goto done;
 140         }
 141     }
 142
 143   lb_garbage_collection();
 144
 145   u32 index;
 146   if (!del) {
 147     if (encap == LB_ENCAP_TYPE_L3DSR) {
 148         args.encap_args.dscp = (u8)(dscp & 0x3F);
 149       }
 150       else if ((encap == LB_ENCAP_TYPE_NAT4)
 151                || (encap == LB_ENCAP_TYPE_NAT6))
 152         {
 153           args.encap_args.srv_type = (u8) srv_type;
 154           args.encap_args.target_port = (u16) target_port;
 155         }
 156
 157     if ((ret = lb_vip_add(args, &index))) {
 158       error = clib_error_return (0, "lb_vip_add error %d", ret);
 159       goto done;
 160     } else {
 161       vlib_cli_output(vm, "lb_vip_add ok %d", index);
 162     }
 163   } else {
 164     if ((ret = lb_vip_find_index(&(args.prefix), args.plen,
 165                                  args.protocol, args.port, &index))) {
 166       error = clib_error_return (0, "lb_vip_find_index error %d", ret);
 167       goto done;
 168     } else if ((ret = lb_vip_del(index))) {
 169       error = clib_error_return (0, "lb_vip_del error %d", ret);
 170       goto done;
 171     }
 172   }
 173
 174 done:
 175   unformat_free (line_input);
 176
 177   return error;
 178 }
 179
 180 VLIB_CLI_COMMAND (lb_vip_command, static) =
 181 {
 182   .path = "lb vip",
 183   .short_help = "lb vip <prefix> "
 184       "[protocol (tcp|udp) port <n>] "
 185       "[encap (gre6|gre4|l3dsr|nat4|nat6)] "
 186       "[dscp <n>] "
 187       "[type (nodeport|clusterip) target_port <n>] "
 188       "[new_len <n>] [del]",
 189   .function = lb_vip_command_fn,
 190 };
 191
 192 static clib_error_t *
 193 lb_as_command_fn (vlib_main_t * vm,
 194               unformat_input_t * input, vlib_cli_command_t * cmd)
 195 {
 196   unformat_input_t _line_input, *line_input = &_line_input;
 197   ip46_address_t vip_prefix, as_addr;
 198   u8 vip_plen;
 199   ip46_address_t *as_array = 0;
 200   u32 vip_index;
 201   u32 port = 0;
 202   u8 protocol = 0;
 203   u8 del = 0;
 204   u8 flush = 0;
 205   int ret;
 206   clib_error_t *error = 0;
 207
 208   if (!unformat_user (input, unformat_line_input, line_input))
 209     return 0;
 210
 211   if (!unformat(line_input, "%U", unformat_ip46_prefix,
 212                 &vip_prefix, &vip_plen, IP46_TYPE_ANY))
 213   {
 214     error = clib_error_return (0, "invalid as address: '%U'",
 215                                format_unformat_error, line_input);
 216     goto done;
 217   }
 218
 219   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 220   {
 221     if (unformat(line_input, "%U", unformat_ip46_address,
 222                  &as_addr, IP46_TYPE_ANY))
 223       {
 224         vec_add1(as_array, as_addr);
 225       }
 226     else if (unformat(line_input, "del"))
 227       {
 228         del = 1;
 229       }
 230     else if (unformat(line_input, "flush"))
 231       {
 232         flush = 1;
 233       }
 234     else if (unformat(line_input, "protocol tcp"))
 235       {
 236           protocol = (u8)IP_PROTOCOL_TCP;
 237       }
 238     else if (unformat(line_input, "protocol udp"))
 239       {
 240           protocol = (u8)IP_PROTOCOL_UDP;
 241       }
 242     else if (unformat(line_input, "port %d", &port))
 243       ;
 244     else {
 245       error = clib_error_return (0, "parse error: '%U'",
 246                                  format_unformat_error, line_input);
 247       goto done;
 248     }
 249   }
 250
 251   /* If port == 0, it means all-port VIP */
 252   if (port == 0)
 253     {
 254       protocol = ~0;
 255     }
 256
 257   if ((ret = lb_vip_find_index(&vip_prefix, vip_plen, protocol,
 258                                (u16)port, &vip_index))){
 259     error = clib_error_return (0, "lb_vip_find_index error %d", ret);
 260     goto done;
 261   }
 262
 263   if (!vec_len(as_array)) {
 264     error = clib_error_return (0, "No AS address provided");
 265     goto done;
 266   }
 267
 268   lb_garbage_collection();
 269   clib_warning("vip index is %d", vip_index);
 270
 271   if (del) {
 272     if ((ret = lb_vip_del_ass(vip_index, as_array, vec_len(as_array), flush)))
 273     {
 274       error = clib_error_return (0, "lb_vip_del_ass error %d", ret);
 275       goto done;
 276     }
 277   } else {
 278     if ((ret = lb_vip_add_ass(vip_index, as_array, vec_len(as_array))))
 279     {
 280       error = clib_error_return (0, "lb_vip_add_ass error %d", ret);
 281       goto done;
 282     }
 283   }
 284
 285 done:
 286   unformat_free (line_input);
 287   vec_free(as_array);
 288
 289   return error;
 290 }
 291
 292 VLIB_CLI_COMMAND (lb_as_command, static) =
 293 {
 294   .path = "lb as",
 295   .short_help = "lb as <vip-prefix> [protocol (tcp|udp) port <n>]"
 296       " [<address> [<address> [...]]] [del] [flush]",
 297   .function = lb_as_command_fn,
 298 };
 299
 300 static clib_error_t *
 301 lb_conf_command_fn (vlib_main_t * vm,
 302               unformat_input_t * input, vlib_cli_command_t * cmd)
 303 {
 304   lb_main_t *lbm = &lb_main;
 305   unformat_input_t _line_input, *line_input = &_line_input;
 306   ip4_address_t ip4 = lbm->ip4_src_address;
 307   ip6_address_t ip6 = lbm->ip6_src_address;
 308   u32 per_cpu_sticky_buckets = lbm->per_cpu_sticky_buckets;
 309   u32 per_cpu_sticky_buckets_log2 = 0;
 310   u32 flow_timeout = lbm->flow_timeout;
 311   int ret;
 312   clib_error_t *error = 0;
 313
 314   if (!unformat_user (input, unformat_line_input, line_input))
 315     return 0;
 316
 317   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 318   {
 319     if (unformat(line_input, "ip4-src-address %U", unformat_ip4_address, &ip4))
 320       ;
 321     else if (unformat(line_input, "ip6-src-address %U", unformat_ip6_address, &ip6))
 322       ;
 323     else if (unformat(line_input, "buckets %d", &per_cpu_sticky_buckets))
 324       ;
 325     else if (unformat(line_input, "buckets-log2 %d", &per_cpu_sticky_buckets_log2)) {
 326       if (per_cpu_sticky_buckets_log2 >= 32)
 327         return clib_error_return (0, "buckets-log2 value is too high");
 328       per_cpu_sticky_buckets = 1 << per_cpu_sticky_buckets_log2;
 329     } else if (unformat(line_input, "timeout %d", &flow_timeout))
 330       ;
 331     else {
 332       error = clib_error_return (0, "parse error: '%U'",
 333                                  format_unformat_error, line_input);
 334       goto done;
 335     }
 336   }
 337
 338   lb_garbage_collection();
 339
 340   if ((ret = lb_conf(&ip4, &ip6, per_cpu_sticky_buckets, flow_timeout))) {
 341     error = clib_error_return (0, "lb_conf error %d", ret);
 342     goto done;
 343   }
 344
 345 done:
 346   unformat_free (line_input);
 347
 348   return error;
 349 }
 350
 351 VLIB_CLI_COMMAND (lb_conf_command, static) =
 352 {
 353   .path = "lb conf",
 354   .short_help = "lb conf [ip4-src-address <addr>] [ip6-src-address <addr>] [buckets <n>] [timeout <s>]",
 355   .function = lb_conf_command_fn,
 356 };
 357
 358 static clib_error_t *
 359 lb_show_command_fn (vlib_main_t * vm,
 360               unformat_input_t * input, vlib_cli_command_t * cmd)
 361 {
 362   vlib_cli_output(vm, "%U", format_lb_main);
 363   return NULL;
 364 }
 365
 366
 367 VLIB_CLI_COMMAND (lb_show_command, static) =
 368 {
 369   .path = "show lb",
 370   .short_help = "show lb",
 371   .function = lb_show_command_fn,
 372 };
 373
 374 static clib_error_t *
 375 lb_show_vips_command_fn (vlib_main_t * vm,
 376               unformat_input_t * input, vlib_cli_command_t * cmd)
 377 {
 378   unformat_input_t line_input;
 379   lb_main_t *lbm = &lb_main;
 380   lb_vip_t *vip;
 381   u8 verbose = 0;
 382
 383   if (!unformat_user (input, unformat_line_input, &line_input))
 384       return 0;
 385
 386   if (unformat(&line_input, "verbose"))
 387     verbose = 1;
 388
 389   /* Hide dummy VIP */
 390   pool_foreach(vip, lbm->vips, {
 391     if (vip != lbm->vips) {
 392       vlib_cli_output(vm, "%U\n", verbose?format_lb_vip_detailed:format_lb_vip, vip);
 393     }
 394   });
 395
 396   unformat_free (&line_input);
 397   return NULL;
 398 }
 399
 400 VLIB_CLI_COMMAND (lb_show_vips_command, static) =
 401 {
 402   .path = "show lb vips",
 403   .short_help = "show lb vips [verbose]",
 404   .function = lb_show_vips_command_fn,
 405 };
 406
 407 static clib_error_t *
 408 lb_set_interface_nat_command_fn (vlib_main_t * vm,
 409                                  unformat_input_t * input,
 410                                  vlib_cli_command_t * cmd,
 411                                  u8 is_nat6)
 412 {
 413   unformat_input_t _line_input, *line_input = &_line_input;
 414   vnet_main_t * vnm = vnet_get_main();
 415   clib_error_t * error = 0;
 416   u32 _sw_if_index, *sw_if_index = &_sw_if_index;
 417   u32 * inside_sw_if_indices = 0;
 418   int is_del = 0;
 419
 420   /* Get a line of input. */
 421   if (!unformat_user (input, unformat_line_input, line_input))
 422     return 0;
 423
 424   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 425     {
 426       if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
 427                     vnm, sw_if_index))
 428         vec_add1 (inside_sw_if_indices, *sw_if_index);
 429       else if (unformat (line_input, "del"))
 430         is_del = 1;
 431       else
 432         {
 433           error = clib_error_return (0, "unknown input '%U'",
 434             format_unformat_error, line_input);
 435           goto done;
 436         }
 437     }
 438
 439     vec_foreach (sw_if_index, inside_sw_if_indices)
 440     {
 441       if (!is_nat6)
 442         {
 443           if (lb_nat4_interface_add_del (*sw_if_index, is_del))
 444             {
 445               error = clib_error_return(
 446                   0, "%s %U failed", is_del ? "del" : "add",
 447                   format_vnet_sw_interface_name, vnm,
 448                   vnet_get_sw_interface (vnm, *sw_if_index));
 449               goto done;
 450             }
 451         }
 452       else
 453         {
 454           if (lb_nat6_interface_add_del (*sw_if_index, is_del))
 455             {
 456               error = clib_error_return(
 457                   0, "%s %U failed", is_del ? "del" : "add",
 458                   format_vnet_sw_interface_name, vnm,
 459                   vnet_get_sw_interface (vnm, *sw_if_index));
 460               goto done;
 461             }
 462         }
 463     }
 464
 465 done:
 466   unformat_free (line_input);
 467   vec_free (inside_sw_if_indices);
 468
 469   return error;
 470 }
 471
 472 static clib_error_t *
 473 lb_set_interface_nat4_command_fn (vlib_main_t * vm,
 474                                   unformat_input_t * input,
 475                                   vlib_cli_command_t * cmd)
 476 {
 477   return lb_set_interface_nat_command_fn(vm, input, cmd, 0);
 478 }
 479
 480 VLIB_CLI_COMMAND (lb_set_interface_nat4_command, static) = {
 481   .path = "lb set interface nat4",
 482   .function = lb_set_interface_nat4_command_fn,
 483   .short_help = "lb set interface nat4 in <intfc> [del]",
 484 };
 485
 486 static clib_error_t *
 487 lb_set_interface_nat6_command_fn (vlib_main_t * vm,
 488                                   unformat_input_t * input,
 489                                   vlib_cli_command_t * cmd)
 490 {
 491   return lb_set_interface_nat_command_fn(vm, input, cmd, 1);
 492 }
 493
 494 VLIB_CLI_COMMAND (lb_set_interface_nat6_command, static) = {
 495   .path = "lb set interface nat6",
 496   .function = lb_set_interface_nat6_command_fn,
 497   .short_help = "lb set interface nat6 in <intfc> [del]",
 498 };
 499
 500 int
 501 lb_flush_vip (u32 vip_index)
 502 {
 503   u32 thread_index;
 504   vlib_thread_main_t *tm = vlib_get_thread_main();
 505   lb_main_t *lbm = &lb_main;
 506
 507   for(thread_index = 0; thread_index < tm->n_vlib_mains; thread_index++ ) {
 508     lb_hash_t *h = lbm->per_cpu[thread_index].sticky_ht;
 509     if (h != NULL) {
 510         u32 i;
 511         lb_hash_bucket_t *b;
 512
 513         lb_hash_foreach_entry(h, b, i) {
 514           if (b->vip[i] == vip_index)
 515             {
 516               vlib_refcount_add(&lbm->as_refcount, thread_index, b->value[i], -1);
 517               vlib_refcount_add(&lbm->as_refcount, thread_index, 0, 1);
 518               b->vip[i] = ~0;
 519               b->value[i] = ~0;
 520             }
 521         }
 522     }
 523   }
 524
 525   return 0;
 526 }
 527
 528 static clib_error_t *
 529 lb_flush_vip_command_fn (vlib_main_t * vm,
 530                          unformat_input_t * input,
 531                          vlib_cli_command_t * cmd)
 532 {
 533   unformat_input_t _line_input, *line_input = &_line_input;
 534   int ret;
 535   ip46_address_t vip_prefix;
 536   u8 vip_plen;
 537   u32 vip_index;
 538   u8 protocol = 0;
 539   u32 port = 0;
 540   clib_error_t *error = 0;
 541
 542   if (!unformat_user (input, unformat_line_input, line_input))
 543     return 0;
 544
 545   if (!unformat(line_input, "%U", unformat_ip46_prefix, &vip_prefix,
 546                 &vip_plen, IP46_TYPE_ANY, &vip_plen)) {
 547     error = clib_error_return (0, "invalid vip prefix: '%U'",
 548                                format_unformat_error, line_input);
 549     goto done;
 550   }
 551
 552   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 553   {
 554     if (unformat(line_input, "protocol tcp"))
 555       {
 556         protocol = (u8)IP_PROTOCOL_TCP;
 557       }
 558     else if (unformat(line_input, "protocol udp"))
 559       {
 560         protocol = (u8)IP_PROTOCOL_UDP;
 561       }
 562     else if (unformat(line_input, "port %d", &port))
 563       ;
 564   }
 565
 566   if (port == 0)
 567     {
 568       protocol = ~0;
 569     }
 570
 571   if ((ret = lb_vip_find_index(&vip_prefix, vip_plen, protocol,
 572                                (u16)port, &vip_index))){
 573     error = clib_error_return (0, "lb_vip_find_index error %d", ret);
 574     goto done;
 575   }
 576
 577   if ((ret = lb_flush_vip(vip_index)))
 578     {
 579       error = clib_error_return (0, "lb_flush_vip error %d", ret);
 580     }
 581   else
 582     {
 583         vlib_cli_output(vm, "lb_flush_vip ok %d", vip_index);
 584     }
 585
 586 done:
 587   unformat_free (line_input);
 588
 589   return error;
 590 }
 591
 592 /*
 593  * flush lb flowtable as per vip
 594  */
 595 VLIB_CLI_COMMAND (lb_flush_vip_command, static) =
 596 {
 597   .path = "lb flush vip",
 598   .short_help = "lb flush vip <prefix> "
 599       "[protocol (tcp|udp) port <n>] exec []",
 600   .function = lb_flush_vip_command_fn,
 601 };
 602
 603 static clib_error_t *
 604 lb_flowtable_flush_command_fn (vlib_main_t * vm,
 605               unformat_input_t * input, vlib_cli_command_t * cmd)
 606 {
 607   u32 thread_index;
 608   vlib_thread_main_t *tm = vlib_get_thread_main();
 609   lb_main_t *lbm = &lb_main;
 610
 611   for(thread_index = 0; thread_index < tm->n_vlib_mains; thread_index++ ) {
 612     lb_hash_t *h = lbm->per_cpu[thread_index].sticky_ht;
 613     if (h != NULL) {
 614         u32 i;
 615         lb_hash_bucket_t *b;
 616
 617         lb_hash_foreach_entry(h, b, i) {
 618             vlib_refcount_add(&lbm->as_refcount, thread_index, b->value[i], -1);
 619             vlib_refcount_add(&lbm->as_refcount, thread_index, 0, 1);
 620         }
 621
 622         lb_hash_free(h);
 623         lbm->per_cpu[thread_index].sticky_ht = 0;
 624     }
 625   }
 626
 627   return NULL;
 628 }
 629
 630 /*
 631  * flush all lb flowtables
 632  * This is indented for debug and unit-tests purposes only
 633  */
 634 VLIB_CLI_COMMAND (lb_flowtable_flush_command, static) =
 635 {
 636   .path = "test lb flowtable flush",
 637   .short_help = "test lb flowtable flush",
 638   .function = lb_flowtable_flush_command_fn,
 639 };