src/vnet/ipfix-export/flow_report.c

   1 /*
   2  * Copyright (c) 2015 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  * flow_report.c
  17  */
  18 #include <vnet/ipfix-export/flow_report.h>
  19 #include <vnet/api_errno.h>
  20 #include <vnet/udp/udp.h>
  21
  22 flow_report_main_t flow_report_main;
  23
  24 static_always_inline u8
  25 stream_index_valid (ipfix_exporter_t *exp, u32 index)
  26 {
  27   return index < vec_len (exp->streams) && exp->streams[index].domain_id != ~0;
  28 }
  29
  30 static_always_inline flow_report_stream_t *
  31 add_stream (ipfix_exporter_t *exp)
  32 {
  33   u32 i;
  34   for (i = 0; i < vec_len (exp->streams); i++)
  35     if (!stream_index_valid (exp, i))
  36       return &exp->streams[i];
  37   u32 index = vec_len (exp->streams);
  38   vec_validate (exp->streams, index);
  39   return &exp->streams[index];
  40 }
  41
  42 static_always_inline void
  43 delete_stream (ipfix_exporter_t *exp, u32 index)
  44 {
  45   ASSERT (index < vec_len (exp->streams));
  46   ASSERT (exp->streams[index].domain_id != ~0);
  47   exp->streams[index].domain_id = ~0;
  48 }
  49
  50 static i32
  51 find_stream (ipfix_exporter_t *exp, u32 domain_id, u16 src_port)
  52 {
  53   flow_report_stream_t *stream;
  54   u32 i;
  55   for (i = 0; i < vec_len (exp->streams); i++)
  56     if (stream_index_valid (exp, i))
  57       {
  58         stream = &exp->streams[i];
  59         if (domain_id == stream->domain_id)
  60           {
  61             if (src_port != stream->src_port)
  62               return -2;
  63             return i;
  64           }
  65         else if (src_port == stream->src_port)
  66           {
  67             return -2;
  68           }
  69       }
  70   return -1;
  71 }
  72
  73 int
  74 send_template_packet (flow_report_main_t * frm,
  75                       flow_report_t * fr, u32 * buffer_indexp)
  76 {
  77   u32 bi0;
  78   vlib_buffer_t *b0;
  79   ip4_ipfix_template_packet_t *tp;
  80   ipfix_message_header_t *h;
  81   ip4_header_t *ip;
  82   udp_header_t *udp;
  83   vlib_main_t *vm = frm->vlib_main;
  84   flow_report_stream_t *stream;
  85   ipfix_exporter_t *exp = pool_elt_at_index (frm->exporters, 0);
  86
  87   ASSERT (buffer_indexp);
  88
  89   if (fr->update_rewrite || fr->rewrite == 0)
  90     {
  91       if (exp->ipfix_collector.as_u32 == 0 || exp->src_address.as_u32 == 0)
  92         {
  93           vlib_node_set_state (frm->vlib_main, flow_report_process_node.index,
  94                                VLIB_NODE_STATE_DISABLED);
  95           return -1;
  96         }
  97       vec_free (fr->rewrite);
  98       fr->update_rewrite = 1;
  99     }
 100
 101   if (fr->update_rewrite)
 102     {
 103       fr->rewrite = fr->rewrite_callback (
 104         exp, fr, &exp->ipfix_collector, &exp->src_address, exp->collector_port,
 105         fr->report_elements, fr->n_report_elements, fr->stream_indexp);
 106       fr->update_rewrite = 0;
 107     }
 108
 109   if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
 110     return -1;
 111
 112   b0 = vlib_get_buffer (vm, bi0);
 113
 114   ASSERT (vec_len (fr->rewrite) < vlib_buffer_get_default_data_size (vm));
 115
 116   clib_memcpy_fast (b0->data, fr->rewrite, vec_len (fr->rewrite));
 117   b0->current_data = 0;
 118   b0->current_length = vec_len (fr->rewrite);
 119   b0->flags |= (VLIB_BUFFER_TOTAL_LENGTH_VALID | VNET_BUFFER_F_FLOW_REPORT);
 120   vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
 121   vnet_buffer (b0)->sw_if_index[VLIB_TX] = exp->fib_index;
 122
 123   tp = vlib_buffer_get_current (b0);
 124   ip = (ip4_header_t *) & tp->ip4;
 125   udp = (udp_header_t *) (ip + 1);
 126   h = (ipfix_message_header_t *) (udp + 1);
 127
 128   /* FIXUP: message header export_time */
 129   h->export_time = (u32)
 130     (((f64) frm->unix_time_0) +
 131      (vlib_time_now (frm->vlib_main) - frm->vlib_time_0));
 132   h->export_time = clib_host_to_net_u32 (h->export_time);
 133
 134   stream = &exp->streams[fr->stream_index];
 135
 136   /* FIXUP: message header sequence_number. Templates do not increase it */
 137   h->sequence_number = clib_host_to_net_u32 (stream->sequence_number);
 138
 139   /* FIXUP: udp length */
 140   udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
 141
 142   if (exp->udp_checksum)
 143     {
 144       /* RFC 7011 section 10.3.2. */
 145       udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
 146       if (udp->checksum == 0)
 147         udp->checksum = 0xffff;
 148     }
 149
 150   *buffer_indexp = bi0;
 151
 152   fr->last_template_sent = vlib_time_now (vm);
 153
 154   return 0;
 155 }
 156
 157 u8 *
 158 vnet_flow_rewrite_generic_callback (ipfix_exporter_t *exp, flow_report_t *fr,
 159                                     ip4_address_t *collector_address,
 160                                     ip4_address_t *src_address,
 161                                     u16 collector_port,
 162                                     ipfix_report_element_t *report_elts,
 163                                     u32 n_elts, u32 *stream_indexp)
 164 {
 165   ip4_header_t *ip;
 166   udp_header_t *udp;
 167   ipfix_message_header_t *h;
 168   ipfix_set_header_t *s;
 169   ipfix_template_header_t *t;
 170   ipfix_field_specifier_t *f;
 171   ipfix_field_specifier_t *first_field;
 172   u8 *rewrite = 0;
 173   ip4_ipfix_template_packet_t *tp;
 174   flow_report_stream_t *stream;
 175   int i;
 176   ipfix_report_element_t *ep;
 177
 178   ASSERT (stream_indexp);
 179   ASSERT (n_elts);
 180   ASSERT (report_elts);
 181
 182   stream = &exp->streams[fr->stream_index];
 183   *stream_indexp = fr->stream_index;
 184
 185   /* allocate rewrite space */
 186   vec_validate_aligned (rewrite,
 187                         sizeof (ip4_ipfix_template_packet_t)
 188                         + n_elts * sizeof (ipfix_field_specifier_t) - 1,
 189                         CLIB_CACHE_LINE_BYTES);
 190
 191   /* create the packet rewrite string */
 192   tp = (ip4_ipfix_template_packet_t *) rewrite;
 193   ip = (ip4_header_t *) & tp->ip4;
 194   udp = (udp_header_t *) (ip + 1);
 195   h = (ipfix_message_header_t *) (udp + 1);
 196   s = (ipfix_set_header_t *) (h + 1);
 197   t = (ipfix_template_header_t *) (s + 1);
 198   first_field = f = (ipfix_field_specifier_t *) (t + 1);
 199
 200   ip->ip_version_and_header_length = 0x45;
 201   ip->ttl = 254;
 202   ip->protocol = IP_PROTOCOL_UDP;
 203   ip->src_address.as_u32 = src_address->as_u32;
 204   ip->dst_address.as_u32 = collector_address->as_u32;
 205   udp->src_port = clib_host_to_net_u16 (stream->src_port);
 206   udp->dst_port = clib_host_to_net_u16 (collector_port);
 207   udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
 208
 209   /* FIXUP LATER: message header export_time */
 210   h->domain_id = clib_host_to_net_u32 (stream->domain_id);
 211
 212   ep = report_elts;
 213
 214   for (i = 0; i < n_elts; i++)
 215     {
 216       f->e_id_length = ipfix_e_id_length (0, ep->info_element, ep->size);
 217       f++;
 218       ep++;
 219     }
 220
 221   /* Back to the template packet... */
 222   ip = (ip4_header_t *) & tp->ip4;
 223   udp = (udp_header_t *) (ip + 1);
 224
 225   ASSERT (f - first_field);
 226   /* Field count in this template */
 227   t->id_count = ipfix_id_count (fr->template_id, f - first_field);
 228
 229   /* set length in octets */
 230   s->set_id_length =
 231     ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
 232
 233   /* message length in octets */
 234   h->version_length = version_length ((u8 *) f - (u8 *) h);
 235
 236   ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
 237   ip->checksum = ip4_header_checksum (ip);
 238
 239   return rewrite;
 240 }
 241
 242 static uword
 243 flow_report_process (vlib_main_t * vm,
 244                      vlib_node_runtime_t * rt, vlib_frame_t * f)
 245 {
 246   flow_report_main_t *frm = &flow_report_main;
 247   flow_report_t *fr;
 248   u32 ip4_lookup_node_index;
 249   vlib_node_t *ip4_lookup_node;
 250   vlib_frame_t *nf = 0;
 251   u32 template_bi;
 252   u32 *to_next;
 253   int send_template;
 254   f64 now, wait_time;
 255   f64 def_wait_time = 5.0;
 256   int rv;
 257   uword event_type;
 258   uword *event_data = 0;
 259
 260   /* Wait for Godot... */
 261   vlib_process_wait_for_event_or_clock (vm, 1e9);
 262   event_type = vlib_process_get_events (vm, &event_data);
 263   if (event_type != 1)
 264     clib_warning ("bogus kickoff event received, %d", event_type);
 265   vec_reset_length (event_data);
 266
 267   /* Enqueue pkts to ip4-lookup */
 268   ip4_lookup_node = vlib_get_node_by_name (vm, (u8 *) "ip4-lookup");
 269   ip4_lookup_node_index = ip4_lookup_node->index;
 270
 271   wait_time = def_wait_time;
 272
 273   while (1)
 274     {
 275       vlib_process_wait_for_event_or_clock (vm, wait_time);
 276       event_type = vlib_process_get_events (vm, &event_data);
 277       vec_reset_length (event_data);
 278       ipfix_exporter_t *exp = pool_elt_at_index (frm->exporters, 0);
 279
 280       /* 5s delay by default, possibly reduced by template intervals */
 281       wait_time = def_wait_time;
 282
 283       vec_foreach (fr, exp->reports)
 284         {
 285           f64 next_template;
 286           now = vlib_time_now (vm);
 287
 288           /* Need to send a template packet? */
 289           send_template =
 290             now > (fr->last_template_sent + exp->template_interval);
 291           send_template += fr->last_template_sent == 0;
 292           template_bi = ~0;
 293           rv = 0;
 294
 295           if (send_template)
 296             rv = send_template_packet (frm, fr, &template_bi);
 297
 298           if (rv < 0)
 299             continue;
 300
 301           /* decide if template should be sent sooner than current wait time */
 302           next_template =
 303             (fr->last_template_sent + exp->template_interval) - now;
 304           wait_time = clib_min (wait_time, next_template);
 305
 306           nf = vlib_get_frame_to_node (vm, ip4_lookup_node_index);
 307           nf->n_vectors = 0;
 308           to_next = vlib_frame_vector_args (nf);
 309
 310           if (template_bi != ~0)
 311             {
 312               to_next[0] = template_bi;
 313               to_next++;
 314               nf->n_vectors++;
 315             }
 316
 317           nf = fr->flow_data_callback (frm, exp, fr, nf, to_next,
 318                                        ip4_lookup_node_index);
 319           if (nf)
 320             vlib_put_frame_to_node (vm, ip4_lookup_node_index, nf);
 321         }
 322     }
 323
 324   return 0;                     /* not so much */
 325 }
 326
 327 /* *INDENT-OFF* */
 328 VLIB_REGISTER_NODE (flow_report_process_node) = {
 329     .function = flow_report_process,
 330     .type = VLIB_NODE_TYPE_PROCESS,
 331     .name = "flow-report-process",
 332 };
 333 /* *INDENT-ON* */
 334
 335 int
 336 vnet_flow_report_add_del (ipfix_exporter_t *exp,
 337                           vnet_flow_report_add_del_args_t *a, u16 *template_id)
 338 {
 339   int i;
 340   int found_index = ~0;
 341   flow_report_t *fr;
 342   flow_report_stream_t *stream;
 343   u32 si;
 344
 345   si = find_stream (exp, a->domain_id, a->src_port);
 346   if (si == -2)
 347     return VNET_API_ERROR_INVALID_VALUE;
 348   if (si == -1 && a->is_add == 0)
 349     return VNET_API_ERROR_NO_SUCH_ENTRY;
 350
 351   for (i = 0; i < vec_len (exp->reports); i++)
 352     {
 353       fr = vec_elt_at_index (exp->reports, i);
 354       if (fr->opaque.as_uword == a->opaque.as_uword
 355           && fr->rewrite_callback == a->rewrite_callback
 356           && fr->flow_data_callback == a->flow_data_callback)
 357         {
 358           found_index = i;
 359           if (template_id)
 360             *template_id = fr->template_id;
 361           break;
 362         }
 363     }
 364
 365   if (a->is_add == 0)
 366     {
 367       if (found_index != ~0)
 368         {
 369           vec_delete (exp->reports, 1, found_index);
 370           stream = &exp->streams[si];
 371           stream->n_reports--;
 372           if (stream->n_reports == 0)
 373             delete_stream (exp, si);
 374           return 0;
 375         }
 376       return VNET_API_ERROR_NO_SUCH_ENTRY;
 377     }
 378
 379   if (found_index != ~0)
 380     return VNET_API_ERROR_VALUE_EXIST;
 381
 382   if (si == -1)
 383     {
 384       stream = add_stream (exp);
 385       stream->domain_id = a->domain_id;
 386       stream->src_port = a->src_port;
 387       stream->sequence_number = 0;
 388       stream->n_reports = 0;
 389       si = stream - exp->streams;
 390     }
 391   else
 392     stream = &exp->streams[si];
 393
 394   stream->n_reports++;
 395
 396   vec_add2 (exp->reports, fr, 1);
 397
 398   fr->stream_index = si;
 399   fr->template_id = 256 + stream->next_template_no;
 400   stream->next_template_no = (stream->next_template_no + 1) % (65536 - 256);
 401   fr->update_rewrite = 1;
 402   fr->opaque = a->opaque;
 403   fr->rewrite_callback = a->rewrite_callback;
 404   fr->flow_data_callback = a->flow_data_callback;
 405   fr->report_elements = a->report_elements;
 406   fr->n_report_elements = a->n_report_elements;
 407   fr->stream_indexp = a->stream_indexp;
 408   if (template_id)
 409     *template_id = fr->template_id;
 410
 411   return 0;
 412 }
 413
 414 clib_error_t *
 415 flow_report_add_del_error_to_clib_error (int error)
 416 {
 417   switch (error)
 418     {
 419     case 0:
 420       return 0;
 421     case VNET_API_ERROR_NO_SUCH_ENTRY:
 422       return clib_error_return (0, "Flow report not found");
 423     case VNET_API_ERROR_VALUE_EXIST:
 424       return clib_error_return (0, "Flow report already exists");
 425     case VNET_API_ERROR_INVALID_VALUE:
 426       return clib_error_return (0, "Expecting either still unused values "
 427                                 "for both domain_id and src_port "
 428                                 "or already used values for both fields");
 429     default:
 430       return clib_error_return (0, "vnet_flow_report_add_del returned %d",
 431                                 error);
 432     }
 433 }
 434
 435 void
 436 vnet_flow_reports_reset (ipfix_exporter_t *exp)
 437 {
 438   flow_report_t *fr;
 439   u32 i;
 440
 441   for (i = 0; i < vec_len (exp->streams); i++)
 442     if (stream_index_valid (exp, i))
 443       exp->streams[i].sequence_number = 0;
 444
 445   vec_foreach (fr, exp->reports)
 446     {
 447       fr->update_rewrite = 1;
 448       fr->last_template_sent = 0;
 449     }
 450 }
 451
 452 void
 453 vnet_stream_reset (ipfix_exporter_t *exp, u32 stream_index)
 454 {
 455   flow_report_t *fr;
 456
 457   exp->streams[stream_index].sequence_number = 0;
 458
 459   vec_foreach (fr, exp->reports)
 460     if (exp->reports->stream_index == stream_index)
 461       {
 462         fr->update_rewrite = 1;
 463         fr->last_template_sent = 0;
 464       }
 465 }
 466
 467 int
 468 vnet_stream_change (ipfix_exporter_t *exp, u32 old_domain_id, u16 old_src_port,
 469                     u32 new_domain_id, u16 new_src_port)
 470 {
 471   i32 stream_index = find_stream (exp, old_domain_id, old_src_port);
 472
 473   if (stream_index < 0)
 474     return 1;
 475   flow_report_stream_t *stream = &exp->streams[stream_index];
 476   stream->domain_id = new_domain_id;
 477   stream->src_port = new_src_port;
 478   if (old_domain_id != new_domain_id || old_src_port != new_src_port)
 479     vnet_stream_reset (exp, stream_index);
 480   return 0;
 481 }
 482
 483 static clib_error_t *
 484 set_ipfix_exporter_command_fn (vlib_main_t * vm,
 485                                unformat_input_t * input,
 486                                vlib_cli_command_t * cmd)
 487 {
 488   flow_report_main_t *frm = &flow_report_main;
 489   ip4_address_t collector, src;
 490   u16 collector_port = UDP_DST_PORT_ipfix;
 491   u32 fib_id;
 492   u32 fib_index = ~0;
 493
 494   collector.as_u32 = 0;
 495   src.as_u32 = 0;
 496   u32 path_mtu = 512;           // RFC 7011 section 10.3.3.
 497   u32 template_interval = 20;
 498   u8 udp_checksum = 0;
 499   ipfix_exporter_t *exp = pool_elt_at_index (frm->exporters, 0);
 500
 501   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 502     {
 503       if (unformat (input, "collector %U", unformat_ip4_address, &collector))
 504         ;
 505       else if (unformat (input, "port %U", unformat_udp_port,
 506                          &collector_port))
 507         ;
 508       else if (unformat (input, "src %U", unformat_ip4_address, &src))
 509         ;
 510       else if (unformat (input, "fib-id %u", &fib_id))
 511         {
 512           ip4_main_t *im = &ip4_main;
 513           uword *p = hash_get (im->fib_index_by_table_id, fib_id);
 514           if (!p)
 515             return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
 516           fib_index = p[0];
 517         }
 518       else if (unformat (input, "path-mtu %u", &path_mtu))
 519         ;
 520       else if (unformat (input, "template-interval %u", &template_interval))
 521         ;
 522       else if (unformat (input, "udp-checksum"))
 523         udp_checksum = 1;
 524       else
 525         break;
 526     }
 527
 528   if (collector.as_u32 != 0 && src.as_u32 == 0)
 529     return clib_error_return (0, "src address required");
 530
 531   if (path_mtu > 1450 /* vpp does not support fragmentation */ )
 532     return clib_error_return (0, "too big path-mtu value, maximum is 1450");
 533
 534   if (path_mtu < 68)
 535     return clib_error_return (0, "too small path-mtu value, minimum is 68");
 536
 537   /* Reset report streams if we are reconfiguring IP addresses */
 538   if (exp->ipfix_collector.as_u32 != collector.as_u32 ||
 539       exp->src_address.as_u32 != src.as_u32 ||
 540       exp->collector_port != collector_port)
 541     vnet_flow_reports_reset (exp);
 542
 543   exp->ipfix_collector.as_u32 = collector.as_u32;
 544   exp->collector_port = collector_port;
 545   exp->src_address.as_u32 = src.as_u32;
 546   exp->fib_index = fib_index;
 547   exp->path_mtu = path_mtu;
 548   exp->template_interval = template_interval;
 549   exp->udp_checksum = udp_checksum;
 550
 551   if (collector.as_u32)
 552     vlib_cli_output (vm,
 553                      "Collector %U, src address %U, "
 554                      "fib index %d, path MTU %u, "
 555                      "template resend interval %us, "
 556                      "udp checksum %s",
 557                      format_ip4_address, exp->ipfix_collector,
 558                      format_ip4_address, exp->src_address, fib_index, path_mtu,
 559                      template_interval, udp_checksum ? "enabled" : "disabled");
 560   else
 561     vlib_cli_output (vm, "IPFIX Collector is disabled");
 562
 563   /* Turn on the flow reporting process */
 564   vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
 565   return 0;
 566 }
 567
 568 /* *INDENT-OFF* */
 569 VLIB_CLI_COMMAND (set_ipfix_exporter_command, static) = {
 570     .path = "set ipfix exporter",
 571     .short_help = "set ipfix exporter "
 572                   "collector <ip4-address> [port <port>] "
 573                   "src <ip4-address> [fib-id <fib-id>] "
 574                   "[path-mtu <path-mtu>] "
 575                   "[template-interval <template-interval>] "
 576                   "[udp-checksum]",
 577     .function = set_ipfix_exporter_command_fn,
 578 };
 579 /* *INDENT-ON* */
 580
 581
 582 static clib_error_t *
 583 ipfix_flush_command_fn (vlib_main_t * vm,
 584                         unformat_input_t * input, vlib_cli_command_t * cmd)
 585 {
 586   /* poke the flow reporting process */
 587   vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
 588   return 0;
 589 }
 590
 591 /* *INDENT-OFF* */
 592 VLIB_CLI_COMMAND (ipfix_flush_command, static) = {
 593     .path = "ipfix flush",
 594     .short_help = "flush the current ipfix data [for make test]",
 595     .function = ipfix_flush_command_fn,
 596 };
 597 /* *INDENT-ON* */
 598
 599 static clib_error_t *
 600 flow_report_init (vlib_main_t * vm)
 601 {
 602   flow_report_main_t *frm = &flow_report_main;
 603   ipfix_exporter_t *exp;
 604
 605   frm->vlib_main = vm;
 606   frm->vnet_main = vnet_get_main ();
 607   frm->unix_time_0 = time (0);
 608   frm->vlib_time_0 = vlib_time_now (frm->vlib_main);
 609   /*
 610    * Make sure that we can always access the first exporter for
 611    * backwards compatibility reasons.
 612    */
 613   pool_alloc (frm->exporters, IPFIX_EXPORTERS_MAX);
 614   pool_get (frm->exporters, exp);
 615   /* Verify that this is at index 0 */
 616   ASSERT (frm->exporters == exp);
 617   exp->fib_index = ~0;
 618   return 0;
 619 }
 620
 621 VLIB_INIT_FUNCTION (flow_report_init);
 622 /*
 623  * fd.io coding-style-patch-verification: ON
 624  *
 625  * Local Variables:
 626  * eval: (c-set-style "gnu")
 627  * End:
 628  */