src/vnet/ipfix-export/flow_report_classify.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 #include <vnet/ipfix-export/flow_report.h>
  16 #include <vnet/ipfix-export/flow_report_classify.h>
  17 #include <vnet/api_errno.h>
  18
  19 /* Common prefix of tcp and udp headers
  20  * containing only source and destination port fields */
  21 typedef struct
  22 {
  23   u16 src_port, dst_port;
  24 } tcpudp_header_t;
  25
  26 flow_report_classify_main_t flow_report_classify_main;
  27
  28 u8 *
  29 ipfix_classify_template_rewrite (flow_report_main_t * frm,
  30                                  flow_report_t * fr,
  31                                  ip4_address_t * collector_address,
  32                                  ip4_address_t * src_address,
  33                                  u16 collector_port,
  34                                  ipfix_report_element_t * elts,
  35                                  u32 n_elts, u32 * stream_index)
  36 {
  37   flow_report_classify_main_t *fcm = &flow_report_classify_main;
  38   vnet_classify_table_t *tblp;
  39   vnet_classify_main_t *vcm = &vnet_classify_main;
  40   u32 flow_table_index = fr->opaque.as_uword;
  41   u8 *ip_start;
  42   ip4_header_t *ip;
  43   ip6_header_t *ip6;
  44   tcpudp_header_t *tcpudp;
  45   udp_header_t *udp;
  46   ipfix_message_header_t *h;
  47   ipfix_set_header_t *s;
  48   ipfix_template_header_t *t;
  49   ipfix_field_specifier_t *f;
  50   ipfix_field_specifier_t *first_field;
  51   u8 *rewrite = 0;
  52   ip4_ipfix_template_packet_t *tp;
  53   u32 field_count = 0;
  54   u32 field_index = 0;
  55   flow_report_stream_t *stream;
  56   u8 ip_version;
  57   u8 transport_protocol;
  58   u8 *virt_mask;
  59   u8 *real_mask;
  60
  61   stream = &frm->streams[fr->stream_index];
  62
  63   ipfix_classify_table_t *table = &fcm->tables[flow_table_index];
  64
  65   ip_version = table->ip_version;
  66   transport_protocol = table->transport_protocol;
  67
  68   tblp = pool_elt_at_index (vcm->tables, table->classify_table_index);
  69
  70   virt_mask = (u8 *) (tblp->mask - tblp->skip_n_vectors);
  71   real_mask = (u8 *) (tblp->mask);
  72
  73   /* Determine field count */
  74   ip_start = virt_mask + sizeof (ethernet_header_t);
  75 #define _(field,mask,item,length)                                             \
  76   if (((u8 *)&field >= real_mask) && (memcmp(&field, &mask, length) == 0))    \
  77     {                                                                         \
  78       field_count++;                                                          \
  79                                                                               \
  80       fr->fields_to_send = clib_bitmap_set (fr->fields_to_send,               \
  81                                             field_index, 1);                  \
  82     }                                                                         \
  83   field_index++;
  84   foreach_ipfix_field;
  85 #undef _
  86
  87   /* Add packetTotalCount manually */
  88   field_count += 1;
  89
  90   /* $$$ enterprise fields, at some later date */
  91
  92   /* allocate rewrite space */
  93   vec_validate_aligned (rewrite,
  94                         sizeof (ip4_ipfix_template_packet_t)
  95                         + field_count * sizeof (ipfix_field_specifier_t) - 1,
  96                         CLIB_CACHE_LINE_BYTES);
  97
  98   tp = (ip4_ipfix_template_packet_t *) rewrite;
  99   ip = (ip4_header_t *) & tp->ip4;
 100   udp = (udp_header_t *) (ip + 1);
 101   h = (ipfix_message_header_t *) (udp + 1);
 102   s = (ipfix_set_header_t *) (h + 1);
 103   t = (ipfix_template_header_t *) (s + 1);
 104   first_field = f = (ipfix_field_specifier_t *) (t + 1);
 105
 106   ip->ip_version_and_header_length = 0x45;
 107   ip->ttl = 254;
 108   ip->protocol = IP_PROTOCOL_UDP;
 109   ip->src_address.as_u32 = src_address->as_u32;
 110   ip->dst_address.as_u32 = collector_address->as_u32;
 111   udp->src_port = clib_host_to_net_u16 (stream->src_port);
 112   udp->dst_port = clib_host_to_net_u16 (collector_port);
 113   udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
 114
 115   /* FIXUP: message header export_time */
 116   /* FIXUP: message header sequence_number */
 117   h->domain_id = clib_host_to_net_u32 (stream->domain_id);
 118
 119   /* Take another trip through the mask and build the template */
 120   ip_start = virt_mask + sizeof (ethernet_header_t);
 121 #define _(field,mask,item,length)                                             \
 122   if (((u8 *)&field >= real_mask) && (memcmp(&field, &mask, length) == 0))    \
 123     {                                                                         \
 124       f->e_id_length = ipfix_e_id_length (0 /* enterprise */,                 \
 125                                           item, length);                      \
 126       f++;                                                                    \
 127     }
 128   foreach_ipfix_field;
 129 #undef _
 130
 131   /* Add packetTotalCount manually */
 132   f->e_id_length =
 133     ipfix_e_id_length (0 /* enterprise */ , packetTotalCount, 8);
 134   f++;
 135
 136   /* Back to the template packet... */
 137   ip = (ip4_header_t *) & tp->ip4;
 138   udp = (udp_header_t *) (ip + 1);
 139
 140   ASSERT (f - first_field);
 141   /* Field count in this template */
 142   t->id_count = ipfix_id_count (fr->template_id, f - first_field);
 143
 144   /* set length in octets */
 145   s->set_id_length =
 146     ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
 147
 148   /* message length in octets */
 149   h->version_length = version_length ((u8 *) f - (u8 *) h);
 150
 151   ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
 152   ip->checksum = ip4_header_checksum (ip);
 153
 154   return rewrite;
 155 }
 156
 157 vlib_frame_t *
 158 ipfix_classify_send_flows (flow_report_main_t * frm,
 159                            flow_report_t * fr,
 160                            vlib_frame_t * f, u32 * to_next, u32 node_index)
 161 {
 162   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 163   vnet_classify_main_t *vcm = &vnet_classify_main;
 164   u32 flow_table_index = fr->opaque.as_uword;
 165   vnet_classify_table_t *t;
 166   vnet_classify_bucket_t *b;
 167   vnet_classify_entry_t *v, *save_v;
 168   vlib_buffer_t *b0 = 0;
 169   u32 next_offset = 0;
 170   u32 record_offset = 0;
 171   u32 bi0 = ~0;
 172   int i, j, k;
 173   ip4_ipfix_template_packet_t *tp;
 174   ipfix_message_header_t *h = 0;
 175   ipfix_set_header_t *s = 0;
 176   u8 *ip_start;
 177   ip4_header_t *ip;
 178   ip6_header_t *ip6;
 179   tcpudp_header_t *tcpudp;
 180   udp_header_t *udp;
 181   int field_index;
 182   u32 records_this_buffer;
 183   u16 new_l0, old_l0;
 184   ip_csum_t sum0;
 185   vlib_main_t *vm = frm->vlib_main;
 186   flow_report_stream_t *stream;
 187   u8 ip_version;
 188   u8 transport_protocol;
 189   u8 *virt_key;
 190
 191   stream = &frm->streams[fr->stream_index];
 192
 193   ipfix_classify_table_t *table = &fcm->tables[flow_table_index];
 194
 195   ip_version = table->ip_version;
 196   transport_protocol = table->transport_protocol;
 197
 198   t = pool_elt_at_index (vcm->tables, table->classify_table_index);
 199
 200   while (clib_atomic_test_and_set (t->writer_lock))
 201     ;
 202
 203   for (i = 0; i < t->nbuckets; i++)
 204     {
 205       b = &t->buckets[i];
 206       if (b->offset == 0)
 207         continue;
 208
 209       save_v = vnet_classify_get_entry (t, b->offset);
 210       for (j = 0; j < (1 << b->log2_pages); j++)
 211         {
 212           for (k = 0; k < t->entries_per_page; k++)
 213             {
 214               v = vnet_classify_entry_at_index
 215                 (t, save_v, j * t->entries_per_page + k);
 216
 217               if (vnet_classify_entry_is_free (v))
 218                 continue;
 219
 220               /* OK, we have something to send... */
 221               if (PREDICT_FALSE (b0 == 0))
 222                 {
 223                   if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
 224                     goto flush;
 225                   b0 = vlib_get_buffer (vm, bi0);
 226
 227                   u32 copy_len = sizeof (ip4_header_t) +
 228                     sizeof (udp_header_t) + sizeof (ipfix_message_header_t);
 229                   clib_memcpy (b0->data, fr->rewrite, copy_len);
 230                   b0->current_data = 0;
 231                   b0->current_length = copy_len;
 232                   b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 233                   vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
 234                   vnet_buffer (b0)->sw_if_index[VLIB_TX] = frm->fib_index;
 235
 236                   tp = vlib_buffer_get_current (b0);
 237                   ip = (ip4_header_t *) & tp->ip4;
 238                   udp = (udp_header_t *) (ip + 1);
 239                   h = (ipfix_message_header_t *) (udp + 1);
 240                   s = (ipfix_set_header_t *) (h + 1);
 241
 242                   /* FIXUP: message header export_time */
 243                   h->export_time = (u32)
 244                     (((f64) frm->unix_time_0) +
 245                      (vlib_time_now (frm->vlib_main) - frm->vlib_time_0));
 246                   h->export_time = clib_host_to_net_u32 (h->export_time);
 247
 248                   /* FIXUP: message header sequence_number */
 249                   h->sequence_number = stream->sequence_number;
 250                   h->sequence_number =
 251                     clib_host_to_net_u32 (h->sequence_number);
 252
 253                   next_offset = (u32) (((u8 *) (s + 1)) - (u8 *) tp);
 254                   record_offset = next_offset;
 255                   records_this_buffer = 0;
 256                 }
 257
 258               field_index = 0;
 259               virt_key = (u8 *) (v->key - t->skip_n_vectors);
 260               ip_start = virt_key + sizeof (ethernet_header_t);
 261 #define _(field,mask,item,length)                                       \
 262               if (clib_bitmap_get (fr->fields_to_send, field_index))    \
 263                 {                                                       \
 264                   clib_memcpy (b0->data + next_offset, &field,          \
 265                           length);                                      \
 266                   next_offset += length;                                \
 267                 }                                                       \
 268               field_index++;
 269               foreach_ipfix_field;
 270 #undef _
 271
 272               /* Add packetTotalCount manually */
 273               {
 274                 u64 packets = clib_host_to_net_u64 (v->hits);
 275                 clib_memcpy (b0->data + next_offset, &packets,
 276                              sizeof (packets));
 277                 next_offset += sizeof (packets);
 278               }
 279               records_this_buffer++;
 280               stream->sequence_number++;
 281
 282               /* Next record will have the same size as this record */
 283               u32 next_record_size = next_offset - record_offset;
 284               record_offset = next_offset;
 285
 286               if (next_offset + next_record_size > frm->path_mtu)
 287                 {
 288                   s->set_id_length = ipfix_set_id_length (fr->template_id,
 289                                                           next_offset -
 290                                                           (sizeof (*ip) +
 291                                                            sizeof (*udp) +
 292                                                            sizeof (*h)));
 293                   h->version_length =
 294                     version_length (next_offset -
 295                                     (sizeof (*ip) + sizeof (*udp)));
 296                   b0->current_length = next_offset;
 297                   b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 298
 299                   tp = vlib_buffer_get_current (b0);
 300                   ip = (ip4_header_t *) & tp->ip4;
 301                   udp = (udp_header_t *) (ip + 1);
 302
 303                   sum0 = ip->checksum;
 304                   old_l0 = ip->length;
 305                   new_l0 = clib_host_to_net_u16 ((u16) next_offset);
 306
 307                   sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
 308                                          length /* changed member */ );
 309
 310                   ip->checksum = ip_csum_fold (sum0);
 311                   ip->length = new_l0;
 312                   udp->length =
 313                     clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
 314
 315                   if (frm->udp_checksum)
 316                     {
 317                       /* RFC 7011 section 10.3.2. */
 318                       udp->checksum =
 319                         ip4_tcp_udp_compute_checksum (vm, b0, ip);
 320                       if (udp->checksum == 0)
 321                         udp->checksum = 0xffff;
 322                     }
 323
 324                   ASSERT (ip->checksum == ip4_header_checksum (ip));
 325
 326                   to_next[0] = bi0;
 327                   f->n_vectors++;
 328                   to_next++;
 329
 330                   if (f->n_vectors == VLIB_FRAME_SIZE)
 331                     {
 332                       vlib_put_frame_to_node (vm, node_index, f);
 333                       f = vlib_get_frame_to_node (vm, node_index);
 334                       f->n_vectors = 0;
 335                       to_next = vlib_frame_vector_args (f);
 336                     }
 337                   b0 = 0;
 338                   bi0 = ~0;
 339                 }
 340             }
 341         }
 342     }
 343
 344 flush:
 345   if (b0)
 346     {
 347       s->set_id_length = ipfix_set_id_length (fr->template_id,
 348                                               next_offset -
 349                                               (sizeof (*ip) + sizeof (*udp) +
 350                                                sizeof (*h)));
 351       h->version_length = version_length (next_offset -
 352                                           (sizeof (*ip) + sizeof (*udp)));
 353       b0->current_length = next_offset;
 354       b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 355
 356       tp = vlib_buffer_get_current (b0);
 357       ip = (ip4_header_t *) & tp->ip4;
 358       udp = (udp_header_t *) (ip + 1);
 359
 360       sum0 = ip->checksum;
 361       old_l0 = ip->length;
 362       new_l0 = clib_host_to_net_u16 ((u16) next_offset);
 363
 364       sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
 365                              length /* changed member */ );
 366
 367       ip->checksum = ip_csum_fold (sum0);
 368       ip->length = new_l0;
 369       udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
 370
 371       if (frm->udp_checksum)
 372         {
 373           /* RFC 7011 section 10.3.2. */
 374           udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
 375           if (udp->checksum == 0)
 376             udp->checksum = 0xffff;
 377         }
 378
 379       ASSERT (ip->checksum == ip4_header_checksum (ip));
 380
 381       to_next[0] = bi0;
 382       f->n_vectors++;
 383
 384       b0 = 0;
 385       bi0 = ~0;
 386     }
 387
 388   clib_atomic_release (t->writer_lock);
 389   return f;
 390 }
 391
 392 static clib_error_t *
 393 ipfix_classify_table_add_del_command_fn (vlib_main_t * vm,
 394                                          unformat_input_t * input,
 395                                          vlib_cli_command_t * cmd)
 396 {
 397   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 398   flow_report_main_t *frm = &flow_report_main;
 399   vnet_flow_report_add_del_args_t args;
 400   ipfix_classify_table_t *table;
 401   int rv;
 402   int is_add = -1;
 403   u32 classify_table_index = ~0;
 404   u8 ip_version = 0;
 405   u8 transport_protocol = 255;
 406   clib_error_t *error = 0;
 407
 408   if (fcm->src_port == 0)
 409     clib_error_return (0, "call 'set ipfix classify stream' first");
 410
 411   clib_memset (&args, 0, sizeof (args));
 412
 413   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 414     {
 415       if (unformat (input, "add"))
 416         is_add = 1;
 417       else if (unformat (input, "del"))
 418         is_add = 0;
 419       else if (unformat (input, "%d", &classify_table_index))
 420         ;
 421       else if (unformat (input, "ip4"))
 422         ip_version = 4;
 423       else if (unformat (input, "ip6"))
 424         ip_version = 6;
 425       else if (unformat (input, "tcp"))
 426         transport_protocol = 6;
 427       else if (unformat (input, "udp"))
 428         transport_protocol = 17;
 429       else
 430         return clib_error_return (0, "unknown input `%U'",
 431                                   format_unformat_error, input);
 432     }
 433
 434   if (is_add == -1)
 435     return clib_error_return (0, "expecting: add|del");
 436   if (classify_table_index == ~0)
 437     return clib_error_return (0, "classifier table not specified");
 438   if (ip_version == 0)
 439     return clib_error_return (0, "IP version not specified");
 440
 441   table = 0;
 442   int i;
 443   for (i = 0; i < vec_len (fcm->tables); i++)
 444     if (ipfix_classify_table_index_valid (i))
 445       if (fcm->tables[i].classify_table_index == classify_table_index)
 446         {
 447           table = &fcm->tables[i];
 448           break;
 449         }
 450
 451   if (is_add)
 452     {
 453       if (table)
 454         return clib_error_return (0,
 455                                   "Specified classifier table already used");
 456       table = ipfix_classify_add_table ();
 457       table->classify_table_index = classify_table_index;
 458     }
 459   else
 460     {
 461       if (!table)
 462         return clib_error_return (0,
 463                                   "Specified classifier table not registered");
 464     }
 465
 466   table->ip_version = ip_version;
 467   table->transport_protocol = transport_protocol;
 468
 469   args.opaque.as_uword = table - fcm->tables;
 470   args.rewrite_callback = ipfix_classify_template_rewrite;
 471   args.flow_data_callback = ipfix_classify_send_flows;
 472   args.is_add = is_add;
 473   args.domain_id = fcm->domain_id;
 474   args.src_port = fcm->src_port;
 475
 476   rv = vnet_flow_report_add_del (frm, &args, NULL);
 477
 478   error = flow_report_add_del_error_to_clib_error (rv);
 479
 480   /* If deleting, or add failed */
 481   if (is_add == 0 || (rv && is_add))
 482     ipfix_classify_delete_table (table - fcm->tables);
 483
 484   return error;
 485 }
 486
 487 /* *INDENT-OFF* */
 488 VLIB_CLI_COMMAND (ipfix_classify_table_add_del_command, static) = {
 489   .path = "ipfix classify table",
 490   .short_help = "ipfix classify table add|del <table-index>",
 491   .function = ipfix_classify_table_add_del_command_fn,
 492 };
 493 /* *INDENT-ON* */
 494
 495 static clib_error_t *
 496 set_ipfix_classify_stream_command_fn (vlib_main_t * vm,
 497                                       unformat_input_t * input,
 498                                       vlib_cli_command_t * cmd)
 499 {
 500   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 501   flow_report_main_t *frm = &flow_report_main;
 502   u32 domain_id = 1;
 503   u32 src_port = UDP_DST_PORT_ipfix;
 504
 505   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 506     {
 507       if (unformat (input, "domain %d", &domain_id))
 508         ;
 509       else if (unformat (input, "src-port %d", &src_port))
 510         ;
 511       else
 512         return clib_error_return (0, "unknown input `%U'",
 513                                   format_unformat_error, input);
 514     }
 515
 516   if (fcm->src_port != 0 &&
 517       (fcm->domain_id != domain_id || fcm->src_port != (u16) src_port))
 518     {
 519       int rv = vnet_stream_change (frm, fcm->domain_id, fcm->src_port,
 520                                    domain_id, (u16) src_port);
 521       ASSERT (rv == 0);
 522     }
 523
 524   fcm->domain_id = domain_id;
 525   fcm->src_port = (u16) src_port;
 526
 527   return 0;
 528 }
 529
 530 /* *INDENT-OFF* */
 531 VLIB_CLI_COMMAND (set_ipfix_classify_stream_command, static) = {
 532   .path = "set ipfix classify stream",
 533   .short_help = "set ipfix classify stream"
 534                 "[domain <domain-id>] [src-port <src-port>]",
 535   .function = set_ipfix_classify_stream_command_fn,
 536 };
 537 /* *INDENT-ON* */
 538
 539 static clib_error_t *
 540 flow_report_classify_init (vlib_main_t * vm)
 541 {
 542   clib_error_t *error;
 543
 544   if ((error = vlib_call_init_function (vm, flow_report_init)))
 545     return error;
 546
 547   return 0;
 548 }
 549
 550 VLIB_INIT_FUNCTION (flow_report_classify_init);
 551
 552 /*
 553  * fd.io coding-style-patch-verification: ON
 554  *
 555  * Local Variables:
 556  * eval: (c-set-style "gnu")
 557  * End:
 558  */