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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #include <vnet/flow/flow_report.h>
16 #include <vnet/flow/flow_report_classify.h>
17 #include <vnet/api_errno.h>
19 /* Common prefix of tcp and udp headers
20 * containing only source and destination port fields */
23 u16 src_port, dst_port;
26 flow_report_classify_main_t flow_report_classify_main;
29 ipfix_classify_template_rewrite (flow_report_main_t * frm,
31 ip4_address_t * collector_address,
32 ip4_address_t * src_address,
35 flow_report_classify_main_t *fcm = &flow_report_classify_main;
36 vnet_classify_table_t *tblp;
37 vnet_classify_main_t *vcm = &vnet_classify_main;
38 u32 flow_table_index = fr->opaque.as_uword;
42 tcpudp_header_t *tcpudp;
44 ipfix_message_header_t *h;
45 ipfix_set_header_t *s;
46 ipfix_template_header_t *t;
47 ipfix_field_specifier_t *f;
48 ipfix_field_specifier_t *first_field;
50 ip4_ipfix_template_packet_t *tp;
53 flow_report_stream_t *stream;
55 u8 transport_protocol;
59 stream = &frm->streams[fr->stream_index];
61 ipfix_classify_table_t *table = &fcm->tables[flow_table_index];
63 ip_version = table->ip_version;
64 transport_protocol = table->transport_protocol;
66 tblp = pool_elt_at_index (vcm->tables, table->classify_table_index);
68 virt_mask = (u8 *) (tblp->mask - tblp->skip_n_vectors);
69 real_mask = (u8 *) (tblp->mask);
71 /* Determine field count */
72 ip_start = virt_mask + sizeof (ethernet_header_t);
73 #define _(field,mask,item,length) \
74 if (((u8 *)&field >= real_mask) && (memcmp(&field, &mask, length) == 0)) \
78 fr->fields_to_send = clib_bitmap_set (fr->fields_to_send, \
85 /* Add packetTotalCount manually */
88 /* $$$ enterprise fields, at some later date */
90 /* allocate rewrite space */
91 vec_validate_aligned (rewrite,
92 sizeof (ip4_ipfix_template_packet_t)
93 + field_count * sizeof (ipfix_field_specifier_t) - 1,
94 CLIB_CACHE_LINE_BYTES);
96 tp = (ip4_ipfix_template_packet_t *) rewrite;
97 ip = (ip4_header_t *) & tp->ip4;
98 udp = (udp_header_t *) (ip + 1);
99 h = (ipfix_message_header_t *) (udp + 1);
100 s = (ipfix_set_header_t *) (h + 1);
101 t = (ipfix_template_header_t *) (s + 1);
102 first_field = f = (ipfix_field_specifier_t *) (t + 1);
104 ip->ip_version_and_header_length = 0x45;
106 ip->protocol = IP_PROTOCOL_UDP;
107 ip->src_address.as_u32 = src_address->as_u32;
108 ip->dst_address.as_u32 = collector_address->as_u32;
109 udp->src_port = clib_host_to_net_u16 (stream->src_port);
110 udp->dst_port = clib_host_to_net_u16 (collector_port);
111 udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
113 /* FIXUP: message header export_time */
114 /* FIXUP: message header sequence_number */
115 h->domain_id = clib_host_to_net_u32 (stream->domain_id);
117 /* Take another trip through the mask and build the template */
118 ip_start = virt_mask + sizeof (ethernet_header_t);
119 #define _(field,mask,item,length) \
120 if (((u8 *)&field >= real_mask) && (memcmp(&field, &mask, length) == 0)) \
122 f->e_id_length = ipfix_e_id_length (0 /* enterprise */, \
129 /* Add packetTotalCount manually */
131 ipfix_e_id_length (0 /* enterprise */ , packetTotalCount, 8);
134 /* Back to the template packet... */
135 ip = (ip4_header_t *) & tp->ip4;
136 udp = (udp_header_t *) (ip + 1);
138 ASSERT (f - first_field);
139 /* Field count in this template */
140 t->id_count = ipfix_id_count (fr->template_id, f - first_field);
142 /* set length in octets */
144 ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
146 /* message length in octets */
147 h->version_length = version_length ((u8 *) f - (u8 *) h);
149 ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
150 ip->checksum = ip4_header_checksum (ip);
156 ipfix_classify_send_flows (flow_report_main_t * frm,
158 vlib_frame_t * f, u32 * to_next, u32 node_index)
160 flow_report_classify_main_t *fcm = &flow_report_classify_main;
161 vnet_classify_main_t *vcm = &vnet_classify_main;
162 u32 flow_table_index = fr->opaque.as_uword;
163 vnet_classify_table_t *t;
164 vnet_classify_bucket_t *b;
165 vnet_classify_entry_t *v, *save_v;
166 vlib_buffer_t *b0 = 0;
168 u32 record_offset = 0;
171 ip4_ipfix_template_packet_t *tp;
172 ipfix_message_header_t *h = 0;
173 ipfix_set_header_t *s = 0;
177 tcpudp_header_t *tcpudp;
180 u32 records_this_buffer;
183 vlib_main_t *vm = frm->vlib_main;
184 flow_report_stream_t *stream;
186 u8 transport_protocol;
189 stream = &frm->streams[fr->stream_index];
191 ipfix_classify_table_t *table = &fcm->tables[flow_table_index];
193 ip_version = table->ip_version;
194 transport_protocol = table->transport_protocol;
196 t = pool_elt_at_index (vcm->tables, table->classify_table_index);
198 while (__sync_lock_test_and_set (t->writer_lock, 1))
201 for (i = 0; i < t->nbuckets; i++)
207 save_v = vnet_classify_get_entry (t, b->offset);
208 for (j = 0; j < (1 << b->log2_pages); j++)
210 for (k = 0; k < t->entries_per_page; k++)
212 v = vnet_classify_entry_at_index
213 (t, save_v, j * t->entries_per_page + k);
215 if (vnet_classify_entry_is_free (v))
218 /* OK, we have something to send... */
219 if (PREDICT_FALSE (b0 == 0))
221 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
223 b0 = vlib_get_buffer (vm, bi0);
225 u32 copy_len = sizeof (ip4_header_t) +
226 sizeof (udp_header_t) + sizeof (ipfix_message_header_t);
227 clib_memcpy (b0->data, fr->rewrite, copy_len);
228 b0->current_data = 0;
229 b0->current_length = copy_len;
230 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
231 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
232 vnet_buffer (b0)->sw_if_index[VLIB_TX] = frm->fib_index;
234 tp = vlib_buffer_get_current (b0);
235 ip = (ip4_header_t *) & tp->ip4;
236 udp = (udp_header_t *) (ip + 1);
237 h = (ipfix_message_header_t *) (udp + 1);
238 s = (ipfix_set_header_t *) (h + 1);
240 /* FIXUP: message header export_time */
241 h->export_time = (u32)
242 (((f64) frm->unix_time_0) +
243 (vlib_time_now (frm->vlib_main) - frm->vlib_time_0));
244 h->export_time = clib_host_to_net_u32 (h->export_time);
246 /* FIXUP: message header sequence_number */
247 h->sequence_number = stream->sequence_number;
249 clib_host_to_net_u32 (h->sequence_number);
251 next_offset = (u32) (((u8 *) (s + 1)) - (u8 *) tp);
252 record_offset = next_offset;
253 records_this_buffer = 0;
257 virt_key = (u8 *) (v->key - t->skip_n_vectors);
258 ip_start = virt_key + sizeof (ethernet_header_t);
259 #define _(field,mask,item,length) \
260 if (clib_bitmap_get (fr->fields_to_send, field_index)) \
262 clib_memcpy (b0->data + next_offset, &field, \
264 next_offset += length; \
270 /* Add packetTotalCount manually */
272 u64 packets = clib_host_to_net_u64 (v->hits);
273 clib_memcpy (b0->data + next_offset, &packets,
275 next_offset += sizeof (packets);
277 records_this_buffer++;
278 stream->sequence_number++;
280 /* Next record will have the same size as this record */
281 u32 next_record_size = next_offset - record_offset;
282 record_offset = next_offset;
284 if (next_offset + next_record_size > frm->path_mtu)
286 s->set_id_length = ipfix_set_id_length (fr->template_id,
292 version_length (next_offset -
293 (sizeof (*ip) + sizeof (*udp)));
294 b0->current_length = next_offset;
295 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
297 tp = vlib_buffer_get_current (b0);
298 ip = (ip4_header_t *) & tp->ip4;
299 udp = (udp_header_t *) (ip + 1);
303 new_l0 = clib_host_to_net_u16 ((u16) next_offset);
305 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
306 length /* changed member */ );
308 ip->checksum = ip_csum_fold (sum0);
311 clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
313 if (frm->udp_checksum)
315 /* RFC 7011 section 10.3.2. */
317 ip4_tcp_udp_compute_checksum (vm, b0, ip);
318 if (udp->checksum == 0)
319 udp->checksum = 0xffff;
322 ASSERT (ip->checksum == ip4_header_checksum (ip));
328 if (f->n_vectors == VLIB_FRAME_SIZE)
330 vlib_put_frame_to_node (vm, node_index, f);
331 f = vlib_get_frame_to_node (vm, node_index);
333 to_next = vlib_frame_vector_args (f);
345 s->set_id_length = ipfix_set_id_length (fr->template_id,
347 (sizeof (*ip) + sizeof (*udp) +
349 h->version_length = version_length (next_offset -
350 (sizeof (*ip) + sizeof (*udp)));
351 b0->current_length = next_offset;
352 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
354 tp = vlib_buffer_get_current (b0);
355 ip = (ip4_header_t *) & tp->ip4;
356 udp = (udp_header_t *) (ip + 1);
360 new_l0 = clib_host_to_net_u16 ((u16) next_offset);
362 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
363 length /* changed member */ );
365 ip->checksum = ip_csum_fold (sum0);
367 udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
369 if (frm->udp_checksum)
371 /* RFC 7011 section 10.3.2. */
372 udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
373 if (udp->checksum == 0)
374 udp->checksum = 0xffff;
377 ASSERT (ip->checksum == ip4_header_checksum (ip));
386 *(t->writer_lock) = 0;
390 static clib_error_t *
391 ipfix_classify_table_add_del_command_fn (vlib_main_t * vm,
392 unformat_input_t * input,
393 vlib_cli_command_t * cmd)
395 flow_report_classify_main_t *fcm = &flow_report_classify_main;
396 flow_report_main_t *frm = &flow_report_main;
397 vnet_flow_report_add_del_args_t args;
398 ipfix_classify_table_t *table;
401 u32 classify_table_index = ~0;
403 u8 transport_protocol = 255;
404 clib_error_t *error = 0;
406 if (fcm->src_port == 0)
407 clib_error_return (0, "call 'set ipfix classify stream' first");
409 memset (&args, 0, sizeof (args));
411 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
413 if (unformat (input, "add"))
415 else if (unformat (input, "del"))
417 else if (unformat (input, "%d", &classify_table_index))
419 else if (unformat (input, "ip4"))
421 else if (unformat (input, "ip6"))
423 else if (unformat (input, "tcp"))
424 transport_protocol = 6;
425 else if (unformat (input, "udp"))
426 transport_protocol = 17;
428 return clib_error_return (0, "unknown input `%U'",
429 format_unformat_error, input);
433 return clib_error_return (0, "expecting: add|del");
434 if (classify_table_index == ~0)
435 return clib_error_return (0, "classifier table not specified");
437 return clib_error_return (0, "IP version not specified");
441 for (i = 0; i < vec_len (fcm->tables); i++)
442 if (ipfix_classify_table_index_valid (i))
443 if (fcm->tables[i].classify_table_index == classify_table_index)
445 table = &fcm->tables[i];
452 return clib_error_return (0,
453 "Specified classifier table already used");
454 table = ipfix_classify_add_table ();
455 table->classify_table_index = classify_table_index;
460 return clib_error_return (0,
461 "Specified classifier table not registered");
464 table->ip_version = ip_version;
465 table->transport_protocol = transport_protocol;
467 args.opaque.as_uword = table - fcm->tables;
468 args.rewrite_callback = ipfix_classify_template_rewrite;
469 args.flow_data_callback = ipfix_classify_send_flows;
470 args.is_add = is_add;
471 args.domain_id = fcm->domain_id;
472 args.src_port = fcm->src_port;
474 rv = vnet_flow_report_add_del (frm, &args, NULL);
476 error = flow_report_add_del_error_to_clib_error (rv);
478 /* If deleting, or add failed */
479 if (is_add == 0 || (rv && is_add))
480 ipfix_classify_delete_table (table - fcm->tables);
486 VLIB_CLI_COMMAND (ipfix_classify_table_add_del_command, static) = {
487 .path = "ipfix classify table",
488 .short_help = "ipfix classify table add|del <table-index>",
489 .function = ipfix_classify_table_add_del_command_fn,
493 static clib_error_t *
494 set_ipfix_classify_stream_command_fn (vlib_main_t * vm,
495 unformat_input_t * input,
496 vlib_cli_command_t * cmd)
498 flow_report_classify_main_t *fcm = &flow_report_classify_main;
499 flow_report_main_t *frm = &flow_report_main;
501 u32 src_port = UDP_DST_PORT_ipfix;
503 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
505 if (unformat (input, "domain %d", &domain_id))
507 else if (unformat (input, "src-port %d", &src_port))
510 return clib_error_return (0, "unknown input `%U'",
511 format_unformat_error, input);
514 if (fcm->src_port != 0 &&
515 (fcm->domain_id != domain_id || fcm->src_port != (u16) src_port))
517 int rv = vnet_stream_change (frm, fcm->domain_id, fcm->src_port,
518 domain_id, (u16) src_port);
522 fcm->domain_id = domain_id;
523 fcm->src_port = (u16) src_port;
529 VLIB_CLI_COMMAND (set_ipfix_classify_stream_command, static) = {
530 .path = "set ipfix classify stream",
531 .short_help = "set ipfix classify stream"
532 "[domain <domain-id>] [src-port <src-port>]",
533 .function = set_ipfix_classify_stream_command_fn,
537 static clib_error_t *
538 flow_report_classify_init (vlib_main_t * vm)
542 if ((error = vlib_call_init_function (vm, flow_report_init)))
548 VLIB_INIT_FUNCTION (flow_report_classify_init);
551 * fd.io coding-style-patch-verification: ON
554 * eval: (c-set-style "gnu")