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:
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 #ifndef __included_ioam_export_h__
16 #define __included_ioam_export_h__
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ip/ip_packet.h>
21 #include <vnet/ip/ip4_packet.h>
22 #include <vnet/ip/ip6_packet.h>
23 #include <vnet/ip/ip6_hop_by_hop.h>
24 #include <vnet/udp/udp.h>
25 #include <vnet/ipfix-export/ipfix_packet.h>
27 #include <vppinfra/pool.h>
28 #include <vppinfra/hash.h>
29 #include <vppinfra/error.h>
30 #include <vppinfra/elog.h>
31 #include <vppinfra/lock.h>
33 #include <vlib/threads.h>
35 typedef struct ioam_export_buffer
37 /** Required for pool_get_aligned */
38 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
39 /* Allocated buffer */
42 u8 records_in_this_buffer;
43 } ioam_export_buffer_t;
48 /* API message ID base */
52 /* TODO: to support multiple collectors all this has to be grouped and create a vector here */
57 /* ipfix collector, our ip address */
58 ip4_address_t ipfix_collector;
59 ip4_address_t src_address;
61 /* Pool of ioam_export_buffer_t */
62 ioam_export_buffer_t *buffer_pool;
63 /* Vector of per thread ioam_export_buffer_t to buffer pool index */
64 u32 *buffer_per_thread;
65 /* Lock per thread to swap buffers between worker and timer process */
66 clib_spinlock_t *lockp;
68 /* time scale transform */
73 vlib_main_t *vlib_main;
74 vnet_main_t *vnet_main;
75 ethernet_main_t *ethernet_main;
79 u32 export_process_node_index;
83 #define DEFAULT_EXPORT_SIZE (3 * CLIB_CACHE_LINE_BYTES)
85 * Number of records in a buffer
86 * ~(MTU (1500) - [ip hdr(40) + UDP(8) + ipfix (24)]) / DEFAULT_EXPORT_SIZE
88 #define DEFAULT_EXPORT_RECORDS 7
91 ioam_export_set_next_node (ioam_export_main_t * em, u8 * next_node_name)
93 vlib_node_t *next_node;
95 next_node = vlib_get_node_by_name (em->vlib_main, next_node_name);
96 em->next_node_index = next_node->index;
100 ioam_export_reset_next_node (ioam_export_main_t * em)
102 vlib_node_t *next_node;
104 next_node = vlib_get_node_by_name (em->vlib_main, (u8 *) "ip4-lookup");
105 em->next_node_index = next_node->index;
108 always_inline ioam_export_buffer_t *
109 ioam_export_get_my_buffer (ioam_export_main_t * em, u32 thread_id)
112 if (vec_len (em->buffer_per_thread) > thread_id)
113 return (pool_elt_at_index
114 (em->buffer_pool, em->buffer_per_thread[thread_id]));
119 ioam_export_buffer_add_header (ioam_export_main_t * em, vlib_buffer_t * b0)
121 clib_memcpy_fast (b0->data, em->record_header, vec_len (em->record_header));
122 b0->current_data = 0;
123 b0->current_length = vec_len (em->record_header);
124 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
129 ioam_export_init_buffer (ioam_export_main_t * em, vlib_main_t * vm,
130 ioam_export_buffer_t * eb)
132 vlib_buffer_t *b = 0;
136 /* TODO: Perhaps buffer init from template here */
137 if (vlib_buffer_alloc (vm, &(eb->buffer_index), 1) != 1)
139 eb->records_in_this_buffer = 0;
140 eb->touched_at = vlib_time_now (vm);
141 b = vlib_get_buffer (vm, eb->buffer_index);
142 (void) ioam_export_buffer_add_header (em, b);
143 vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
144 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
149 ioam_export_thread_buffer_free (ioam_export_main_t * em)
151 vlib_main_t *vm = em->vlib_main;
152 ioam_export_buffer_t *eb = 0;
154 for (i = 0; i < vec_len (em->buffer_per_thread); i++)
156 eb = pool_elt_at_index (em->buffer_pool, em->buffer_per_thread[i]);
158 vlib_buffer_free (vm, &(eb->buffer_index), 1);
160 for (i = 0; i < vec_len (em->lockp); i++)
161 clib_mem_free ((void *) em->lockp[i]);
162 vec_free (em->buffer_per_thread);
163 pool_free (em->buffer_pool);
164 vec_free (em->lockp);
165 em->buffer_per_thread = 0;
171 ioam_export_thread_buffer_init (ioam_export_main_t * em, vlib_main_t * vm)
173 int no_of_threads = vec_len (vlib_worker_threads);
175 ioam_export_buffer_t *eb = 0;
177 pool_alloc_aligned (em->buffer_pool,
178 no_of_threads - 1, CLIB_CACHE_LINE_BYTES);
179 vec_validate_aligned (em->buffer_per_thread,
180 no_of_threads - 1, CLIB_CACHE_LINE_BYTES);
181 vec_validate_aligned (em->lockp, no_of_threads - 1, CLIB_CACHE_LINE_BYTES);
183 if (!em->buffer_per_thread || !em->buffer_pool || !em->lockp)
187 for (i = 0; i < no_of_threads; i++)
190 pool_get_aligned (em->buffer_pool, eb, CLIB_CACHE_LINE_BYTES);
191 clib_memset (eb, 0, sizeof (*eb));
192 em->buffer_per_thread[i] = eb - em->buffer_pool;
193 if (ioam_export_init_buffer (em, vm, eb) != 1)
195 ioam_export_thread_buffer_free (em);
198 clib_spinlock_init (&em->lockp[i]);
203 #define IPFIX_IOAM_EXPORT_ID 272
204 #define IPFIX_VXLAN_IOAM_EXPORT_ID 273
206 /* Used to build the rewrite */
207 /* data set packet */
210 ipfix_message_header_t h;
211 ipfix_set_header_t s;
212 } ipfix_data_packet_t;
218 ipfix_data_packet_t ipfix;
219 } ip4_ipfix_data_packet_t;
223 ioam_export_header_cleanup (ioam_export_main_t * em,
224 ip4_address_t * collector_address,
225 ip4_address_t * src_address)
227 vec_free (em->record_header);
228 em->record_header = 0;
232 ioam_export_header_create (ioam_export_main_t * em,
233 ip4_address_t * collector_address,
234 ip4_address_t * src_address)
238 ipfix_message_header_t *h;
239 ipfix_set_header_t *s;
241 ip4_ipfix_data_packet_t *tp;
244 /* allocate rewrite space */
245 vec_validate_aligned (rewrite,
246 sizeof (ip4_ipfix_data_packet_t) - 1,
247 CLIB_CACHE_LINE_BYTES);
249 tp = (ip4_ipfix_data_packet_t *) rewrite;
250 ip = (ip4_header_t *) & tp->ip4;
251 udp = (udp_header_t *) (ip + 1);
252 h = (ipfix_message_header_t *) (udp + 1);
253 s = (ipfix_set_header_t *) (h + 1);
255 ip->ip_version_and_header_length = 0x45;
257 ip->protocol = IP_PROTOCOL_UDP;
258 ip->src_address.as_u32 = src_address->as_u32;
259 ip->dst_address.as_u32 = collector_address->as_u32;
260 udp->src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipfix);
261 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipfix);
262 /* FIXUP: UDP length */
263 udp->length = clib_host_to_net_u16 (vec_len (rewrite) +
264 (DEFAULT_EXPORT_RECORDS *
265 DEFAULT_EXPORT_SIZE) - sizeof (*ip));
267 /* FIXUP: message header export_time */
268 /* FIXUP: message header sequence_number */
269 h->domain_id = clib_host_to_net_u32 (em->domain_id);
271 /*FIXUP: Setid length in octets if records exported are not default */
272 s->set_id_length = ipfix_set_id_length (em->set_id,
274 (DEFAULT_EXPORT_RECORDS *
275 DEFAULT_EXPORT_SIZE)));
277 /* FIXUP: h version and length length in octets if records exported are not default */
278 h->version_length = version_length (sizeof (*h) +
280 (DEFAULT_EXPORT_RECORDS *
281 DEFAULT_EXPORT_SIZE)));
283 /* FIXUP: ip length if records exported are not default */
284 /* FIXUP: ip checksum if records exported are not default */
285 ip->length = clib_host_to_net_u16 (vec_len (rewrite) +
286 (DEFAULT_EXPORT_RECORDS *
287 DEFAULT_EXPORT_SIZE));
288 ip->checksum = ip4_header_checksum (ip);
289 _vec_len (rewrite) = sizeof (ip4_ipfix_data_packet_t);
290 em->record_header = rewrite;
295 ioam_export_send_buffer (ioam_export_main_t * em, vlib_main_t * vm,
296 ioam_export_buffer_t * eb)
300 ipfix_message_header_t *h;
301 ipfix_set_header_t *s;
302 ip4_ipfix_data_packet_t *tp;
306 vlib_frame_t *nf = 0;
309 b0 = vlib_get_buffer (vm, eb->buffer_index);
310 tp = vlib_buffer_get_current (b0);
311 ip = (ip4_header_t *) & tp->ip4;
312 udp = (udp_header_t *) (ip + 1);
313 h = (ipfix_message_header_t *) (udp + 1);
314 s = (ipfix_set_header_t *) (h + 1);
316 /* FIXUP: message header export_time */
317 h->export_time = clib_host_to_net_u32 ((u32)
318 (((f64) em->unix_time_0) +
319 (vlib_time_now (em->vlib_main) -
322 /* FIXUP: message header sequence_number */
323 h->sequence_number = clib_host_to_net_u32 (em->sequence_number++);
325 /* FIXUP: lengths if different from default */
326 if (PREDICT_FALSE (eb->records_in_this_buffer != DEFAULT_EXPORT_RECORDS))
328 s->set_id_length = ipfix_set_id_length (em->set_id /* set_id */ ,
330 (sizeof (*ip) + sizeof (*udp) +
333 version_length (b0->current_length - (sizeof (*ip) + sizeof (*udp)));
336 new_l0 = clib_host_to_net_u16 ((u16) b0->current_length);
337 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
338 length /* changed member */ );
339 ip->checksum = ip_csum_fold (sum0);
341 udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
344 /* Enqueue pkts to ip4-lookup */
346 nf = vlib_get_frame_to_node (vm, em->next_node_index);
348 to_next = vlib_frame_vector_args (nf);
350 to_next[0] = eb->buffer_index;
351 vlib_put_frame_to_node (vm, em->next_node_index, nf);
356 #define EXPORT_TIMEOUT (20.0)
357 #define THREAD_PERIOD (30.0)
359 ioam_export_process_common (ioam_export_main_t * em, vlib_main_t * vm,
360 vlib_node_runtime_t * rt, vlib_frame_t * f,
366 uword *event_data = 0;
368 ioam_export_buffer_t *eb = 0, *new_eb = 0;
369 u32 *vec_buffer_indices = 0;
370 u32 *vec_buffer_to_be_sent = 0;
371 u32 *thread_index = 0;
372 u32 new_pool_index = 0;
374 em->export_process_node_index = index;
375 /* Wait for Godot... */
376 vlib_process_wait_for_event_or_clock (vm, 1e9);
377 event_type = vlib_process_get_events (vm, &event_data);
379 clib_warning ("bogus kickoff event received, %d", event_type);
380 vec_reset_length (event_data);
384 vlib_process_wait_for_event_or_clock (vm, timeout);
385 event_type = vlib_process_get_events (vm, &event_data);
388 case 2: /* Stop and Wait for kickoff again */
391 case 1: /* kickoff : Check for unsent buffers */
392 timeout = THREAD_PERIOD;
394 case ~0: /* timeout */
397 vec_reset_length (event_data);
398 now = vlib_time_now (vm);
400 * Create buffers for threads that are not active enough
401 * to send out the export records
403 for (i = 0; i < vec_len (em->buffer_per_thread); i++)
405 /* If the worker thread is processing export records ignore further checks */
406 if (CLIB_SPINLOCK_IS_LOCKED (&em->lockp[i]))
408 eb = pool_elt_at_index (em->buffer_pool, em->buffer_per_thread[i]);
409 if (eb->records_in_this_buffer > 0
410 && now > (eb->touched_at + EXPORT_TIMEOUT))
412 pool_get_aligned (em->buffer_pool, new_eb,
413 CLIB_CACHE_LINE_BYTES);
414 clib_memset (new_eb, 0, sizeof (*new_eb));
415 if (ioam_export_init_buffer (em, vm, new_eb) == 1)
417 new_pool_index = new_eb - em->buffer_pool;
418 vec_add (vec_buffer_indices, &new_pool_index, 1);
419 vec_add (vec_buffer_to_be_sent, &em->buffer_per_thread[i],
421 vec_add (thread_index, &i, 1);
425 pool_put (em->buffer_pool, new_eb);
431 if (vec_len (thread_index) != 0)
434 * Now swap the buffers out
436 for (i = 0; i < vec_len (thread_index); i++)
438 clib_spinlock_lock (&em->lockp[thread_index[i]]);
439 em->buffer_per_thread[thread_index[i]] =
440 vec_pop (vec_buffer_indices);
441 clib_spinlock_unlock (&em->lockp[thread_index[i]]);
444 /* Send the buffers */
445 for (i = 0; i < vec_len (vec_buffer_to_be_sent); i++)
448 pool_elt_at_index (em->buffer_pool, vec_buffer_to_be_sent[i]);
449 ioam_export_send_buffer (em, vm, eb);
450 pool_put (em->buffer_pool, eb);
455 /* Free any leftover/unused buffers and everything that was allocated */
456 for (i = 0; i < vec_len (vec_buffer_indices); i++)
458 new_eb = pool_elt_at_index (em->buffer_pool, vec_buffer_indices[i]);
459 vlib_buffer_free (vm, &new_eb->buffer_index, 1);
460 pool_put (em->buffer_pool, new_eb);
462 vec_free (vec_buffer_indices);
463 vec_free (vec_buffer_to_be_sent);
464 vec_free (thread_index);
466 return 0; /* not so much */
469 #define ioam_export_node_common(EM, VM, N, F, HTYPE, L, V, NEXT, FIXUP_FUNC) \
471 u32 n_left_from, *from, *to_next; \
472 export_next_t next_index; \
473 u32 pkts_recorded = 0; \
474 ioam_export_buffer_t *my_buf = 0; \
475 vlib_buffer_t *eb0 = 0; \
477 from = vlib_frame_vector_args (F); \
478 n_left_from = (F)->n_vectors; \
479 next_index = (N)->cached_next_index; \
480 clib_spinlock_lock (&(EM)->lockp[(VM)->thread_index]); \
481 my_buf = ioam_export_get_my_buffer (EM, (VM)->thread_index); \
482 my_buf->touched_at = vlib_time_now (VM); \
483 while (n_left_from > 0) \
485 u32 n_left_to_next; \
486 vlib_get_next_frame (VM, N, next_index, to_next, n_left_to_next); \
487 while (n_left_from >= 4 && n_left_to_next >= 2) \
493 vlib_buffer_t *p0, *p1; \
494 u32 ip_len0, ip_len1; \
496 vlib_buffer_t *p2, *p3; \
497 p2 = vlib_get_buffer (VM, from[2]); \
498 p3 = vlib_get_buffer (VM, from[3]); \
499 vlib_prefetch_buffer_header (p2, LOAD); \
500 vlib_prefetch_buffer_header (p3, LOAD); \
501 CLIB_PREFETCH (p2->data, 3 * CLIB_CACHE_LINE_BYTES, LOAD); \
502 CLIB_PREFETCH (p3->data, 3 * CLIB_CACHE_LINE_BYTES, LOAD); \
504 to_next[0] = bi0 = from[0]; \
505 to_next[1] = bi1 = from[1]; \
509 n_left_to_next -= 2; \
510 p0 = vlib_get_buffer (VM, bi0); \
511 p1 = vlib_get_buffer (VM, bi1); \
512 ip0 = vlib_buffer_get_current (p0); \
513 ip1 = vlib_buffer_get_current (p1); \
515 clib_net_to_host_u16 (ip0->L) + sizeof (HTYPE); \
517 clib_net_to_host_u16 (ip1->L) + sizeof (HTYPE); \
518 ebi0 = my_buf->buffer_index; \
519 eb0 = vlib_get_buffer (VM, ebi0); \
520 if (PREDICT_FALSE (eb0 == 0)) \
523 ip_len0 > DEFAULT_EXPORT_SIZE ? DEFAULT_EXPORT_SIZE : ip_len0; \
525 ip_len1 > DEFAULT_EXPORT_SIZE ? DEFAULT_EXPORT_SIZE : ip_len1; \
526 copy3cachelines (eb0->data + eb0->current_length, ip0, ip_len0); \
527 FIXUP_FUNC(eb0, p0); \
528 eb0->current_length += DEFAULT_EXPORT_SIZE; \
529 my_buf->records_in_this_buffer++; \
530 if (my_buf->records_in_this_buffer >= DEFAULT_EXPORT_RECORDS) \
532 ioam_export_send_buffer (EM, VM, my_buf); \
533 ioam_export_init_buffer (EM, VM, my_buf); \
535 ebi0 = my_buf->buffer_index; \
536 eb0 = vlib_get_buffer (VM, ebi0); \
537 if (PREDICT_FALSE (eb0 == 0)) \
539 copy3cachelines (eb0->data + eb0->current_length, ip1, ip_len1); \
540 FIXUP_FUNC(eb0, p1); \
541 eb0->current_length += DEFAULT_EXPORT_SIZE; \
542 my_buf->records_in_this_buffer++; \
543 if (my_buf->records_in_this_buffer >= DEFAULT_EXPORT_RECORDS) \
545 ioam_export_send_buffer (EM, VM, my_buf); \
546 ioam_export_init_buffer (EM, VM, my_buf); \
548 pkts_recorded += 2; \
549 if (PREDICT_FALSE (((node)->flags & VLIB_NODE_FLAG_TRACE))) \
551 if (p0->flags & VLIB_BUFFER_IS_TRACED) \
553 export_trace_t *t = \
554 vlib_add_trace (VM, node, p0, sizeof (*t)); \
556 clib_net_to_host_u32 (ip0->V); \
557 t->next_index = next0; \
559 if (p1->flags & VLIB_BUFFER_IS_TRACED) \
561 export_trace_t *t = \
562 vlib_add_trace (VM, N, p1, sizeof (*t)); \
564 clib_net_to_host_u32 (ip1->V); \
565 t->next_index = next1; \
569 vlib_validate_buffer_enqueue_x2 (VM, N, next_index, \
570 to_next, n_left_to_next, \
571 bi0, bi1, next0, next1); \
573 while (n_left_from > 0 && n_left_to_next > 0) \
585 n_left_to_next -= 1; \
586 p0 = vlib_get_buffer (VM, bi0); \
587 ip0 = vlib_buffer_get_current (p0); \
589 clib_net_to_host_u16 (ip0->L) + sizeof (HTYPE); \
590 ebi0 = my_buf->buffer_index; \
591 eb0 = vlib_get_buffer (VM, ebi0); \
592 if (PREDICT_FALSE (eb0 == 0)) \
595 ip_len0 > DEFAULT_EXPORT_SIZE ? DEFAULT_EXPORT_SIZE : ip_len0; \
596 copy3cachelines (eb0->data + eb0->current_length, ip0, ip_len0); \
597 FIXUP_FUNC(eb0, p0); \
598 eb0->current_length += DEFAULT_EXPORT_SIZE; \
599 my_buf->records_in_this_buffer++; \
600 if (my_buf->records_in_this_buffer >= DEFAULT_EXPORT_RECORDS) \
602 ioam_export_send_buffer (EM, VM, my_buf); \
603 ioam_export_init_buffer (EM, VM, my_buf); \
605 if (PREDICT_FALSE (((N)->flags & VLIB_NODE_FLAG_TRACE) \
606 && (p0->flags & VLIB_BUFFER_IS_TRACED))) \
608 export_trace_t *t = vlib_add_trace (VM, (N), p0, sizeof (*t)); \
610 clib_net_to_host_u32 (ip0->V); \
611 t->next_index = next0; \
613 pkts_recorded += 1; \
615 vlib_validate_buffer_enqueue_x1 (VM, N, next_index, \
616 to_next, n_left_to_next, \
619 vlib_put_next_frame (VM, N, next_index, n_left_to_next); \
621 vlib_node_increment_counter (VM, export_node.index, \
622 EXPORT_ERROR_RECORDED, pkts_recorded); \
623 clib_spinlock_unlock (&(EM)->lockp[(VM)->thread_index]); \
626 #endif /* __included_ioam_export_h__ */
629 * fd.io coding-style-patch-verification: ON
632 * eval: (c-set-style "gnu")