source: lib/trace_parallel.c @ 6a6e6a8

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivelibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 6a6e6a8 was 6a6e6a8, checked in by Richard Sanger <rsangerarj@…>, 6 years ago

More documentation, including some renaming and modifications to behaviour

  • Removes accessor functions for libtrace_result_t, instead directly access the structure
  • Documentation for most functions
  • Split tick into interval and count messages for the two modes of operation
  • Normalise interval and packet order to use the erf timestamp format
  • Rename trace_send_message_to_XXX to trace trace_message_XXX
  • Property mode set to 100644
File size: 73.8 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton,
5 * New Zealand.
6 *
7 * All rights reserved.
8 *
9 * This code has been developed by the University of Waikato WAND
10 * research group. For further information please see http://www.wand.net.nz/
11 *
12 * libtrace is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * libtrace is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with libtrace; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25 *
26 * $Id$
27 *
28 */
29
30
31#define _GNU_SOURCE
32#include "common.h"
33#include "config.h"
34#include <assert.h>
35#include <errno.h>
36#include <fcntl.h>
37#include <stdio.h>
38#include <stdlib.h>
39#include <string.h>
40#include <sys/stat.h>
41#include <sys/types.h>
42#ifndef WIN32
43#include <sys/socket.h>
44#endif
45#include <stdarg.h>
46#include <sys/param.h>
47
48#ifdef HAVE_LIMITS_H
49#  include <limits.h>
50#endif
51
52#ifdef HAVE_SYS_LIMITS_H
53#  include <sys/limits.h>
54#endif
55
56#ifdef HAVE_NET_IF_ARP_H
57#  include <net/if_arp.h>
58#endif
59
60#ifdef HAVE_NET_IF_H
61#  include <net/if.h>
62#endif
63
64#ifdef HAVE_NETINET_IN_H
65#  include <netinet/in.h>
66#endif
67
68#ifdef HAVE_NET_ETHERNET_H
69#  include <net/ethernet.h>
70#endif
71
72#ifdef HAVE_NETINET_IF_ETHER_H
73#  include <netinet/if_ether.h>
74#endif
75
76#include <time.h>
77#ifdef WIN32
78#include <sys/timeb.h>
79#endif
80
81#include "libtrace.h"
82#include "libtrace_int.h"
83
84#ifdef HAVE_PCAP_BPF_H
85#  include <pcap-bpf.h>
86#else
87#  ifdef HAVE_NET_BPF_H
88#    include <net/bpf.h>
89#  endif
90#endif
91
92
93#include "libtrace_int.h"
94#include "format_helper.h"
95#include "rt_protocol.h"
96#include "hash_toeplitz.h"
97#include "combiners.h"
98
99#include <pthread.h>
100#include <signal.h>
101#include <unistd.h>
102#include <ctype.h>
103
104static inline int delay_tracetime(libtrace_t *libtrace, libtrace_packet_t *packet, libtrace_thread_t *t);
105extern int libtrace_parallel;
106
107struct mem_stats {
108        struct memfail {
109           uint64_t cache_hit;
110           uint64_t ring_hit;
111           uint64_t miss;
112           uint64_t recycled;
113        } readbulk, read, write, writebulk;
114};
115
116// Grrr gcc wants this spelt out
117__thread struct mem_stats mem_hits = {{0},{0},{0},{0}};
118
119static void print_memory_stats() {
120#if 0
121        char t_name[50];
122        uint64_t total;
123        pthread_getname_np(pthread_self(), t_name, sizeof(t_name));
124
125        fprintf(stderr, "Thread ID#%d - %s\n", (int) pthread_self(), t_name);
126
127        total = mem_hits.read.cache_hit + mem_hits.read.ring_hit + mem_hits.read.miss;
128        if (total) {
129                fprintf(stderr, "\tRead:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
130                                mem_hits.read.cache_hit, mem_hits.read.ring_hit, mem_hits.read.miss, mem_hits.read.recycled);
131                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
132                                total, (double) mem_hits.read.miss / (double) total * 100.0);
133        }
134
135        total = mem_hits.readbulk.cache_hit + mem_hits.readbulk.ring_hit + mem_hits.readbulk.miss;
136        if (total) {
137                fprintf(stderr, "\tReadbulk:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
138                                mem_hits.readbulk.cache_hit, mem_hits.readbulk.ring_hit, mem_hits.readbulk.miss, mem_hits.readbulk.recycled);
139
140
141                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
142                                total, (double) mem_hits.readbulk.miss / (double) total * 100.0);
143        }
144
145        total = mem_hits.write.cache_hit + mem_hits.write.ring_hit + mem_hits.write.miss;
146        if (total) {
147                fprintf(stderr, "\tWrite:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
148                                mem_hits.write.cache_hit, mem_hits.write.ring_hit, mem_hits.write.miss, mem_hits.write.recycled);
149
150                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
151                                total, (double) mem_hits.write.miss / (double) total * 100.0);
152        }
153
154        total = mem_hits.writebulk.cache_hit + mem_hits.writebulk.ring_hit + mem_hits.writebulk.miss;
155        if (total) {
156                fprintf(stderr, "\tWritebulk:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
157                                mem_hits.writebulk.cache_hit, mem_hits.writebulk.ring_hit, mem_hits.writebulk.miss, mem_hits.writebulk.recycled);
158
159                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
160                                total, (double) mem_hits.writebulk.miss / (double) total * 100.0);
161        }
162#endif
163}
164
165/*
166 * This can be used once the hasher thread has been started and internally after
167 * verfiy_configuration.
168 */
169DLLEXPORT bool trace_has_dedicated_hasher(libtrace_t * libtrace)
170{
171        return libtrace->hasher_thread.type == THREAD_HASHER;
172}
173
174DLLEXPORT bool trace_has_reporter(libtrace_t * libtrace)
175{
176        assert(libtrace->state != STATE_NEW);
177        return libtrace->reporter_thread.type == THREAD_REPORTER && libtrace->reporter;
178}
179
180/**
181 * When running the number of perpkt threads in use.
182 * TODO what if the trace is not running yet, or has finished??
183 *
184 * @brief libtrace_perpkt_thread_nb
185 * @param t The trace
186 * @return
187 */
188DLLEXPORT int libtrace_get_perpkt_count(libtrace_t * t) {
189        return t->perpkt_thread_count;
190}
191
192/**
193 * Changes the overall traces state and signals the condition.
194 *
195 * @param trace A pointer to the trace
196 * @param new_state The new state of the trace
197 * @param need_lock Set to true if libtrace_lock is not held, otherwise
198 *        false in the case the lock is currently held by this thread.
199 */
200static inline void libtrace_change_state(libtrace_t *trace,
201        const enum trace_state new_state, const bool need_lock)
202{
203        UNUSED enum trace_state prev_state;
204        if (need_lock)
205                pthread_mutex_lock(&trace->libtrace_lock);
206        prev_state = trace->state;
207        trace->state = new_state;
208
209        if (trace->config.debug_state)
210                fprintf(stderr, "Trace(%s) state changed from %s to %s\n",
211                        trace->uridata, get_trace_state_name(prev_state),
212                        get_trace_state_name(trace->state));
213
214        pthread_cond_broadcast(&trace->perpkt_cond);
215        if (need_lock)
216                pthread_mutex_unlock(&trace->libtrace_lock);
217}
218
219/**
220 * Changes a thread's state and broadcasts the condition variable. This
221 * should always be done when the lock is held.
222 *
223 * Additionally for perpkt threads the state counts are updated.
224 *
225 * @param trace A pointer to the trace
226 * @param t A pointer to the thread to modify
227 * @param new_state The new state of the thread
228 * @param need_lock Set to true if libtrace_lock is not held, otherwise
229 *        false in the case the lock is currently held by this thread.
230 */
231static inline void thread_change_state(libtrace_t *trace, libtrace_thread_t *t,
232        const enum thread_states new_state, const bool need_lock)
233{
234        enum thread_states prev_state;
235        if (need_lock)
236                pthread_mutex_lock(&trace->libtrace_lock);
237        prev_state = t->state;
238        t->state = new_state;
239        if (t->type == THREAD_PERPKT) {
240                --trace->perpkt_thread_states[prev_state];
241                ++trace->perpkt_thread_states[new_state];
242        }
243
244        if (trace->config.debug_state)
245                fprintf(stderr, "Thread %d state changed from %d to %d\n",
246                        (int) t->tid, prev_state, t->state);
247
248        if (trace->perpkt_thread_states[THREAD_FINISHED] == trace->perpkt_thread_count)
249                libtrace_change_state(trace, STATE_FINSHED, false);
250
251        pthread_cond_broadcast(&trace->perpkt_cond);
252        if (need_lock)
253                pthread_mutex_unlock(&trace->libtrace_lock);
254}
255
256/**
257 * This is valid once a trace is initialised
258 *
259 * @return True if the format supports parallel threads.
260 */
261static inline bool trace_supports_parallel(libtrace_t *trace)
262{
263        assert(trace);
264        assert(trace->format);
265        if (trace->format->pstart_input)
266                return true;
267        else
268                return false;
269}
270
271void libtrace_zero_thread(libtrace_thread_t * t) {
272        t->accepted_packets = 0;
273        t->filtered_packets = 0;
274        t->recorded_first = false;
275        t->tracetime_offset_usec = 0;
276        t->user_data = 0;
277        t->format_data = 0;
278        libtrace_zero_ringbuffer(&t->rbuffer);
279        t->trace = NULL;
280        t->ret = NULL;
281        t->type = THREAD_EMPTY;
282        t->perpkt_num = -1;
283}
284
285// Ints are aligned int is atomic so safe to read and write at same time
286// However write must be locked, read doesn't (We never try read before written to table)
287libtrace_thread_t * get_thread_table(libtrace_t *libtrace) {
288        int i = 0;
289        pthread_t tid = pthread_self();
290
291        for (;i<libtrace->perpkt_thread_count ;++i) {
292                if (pthread_equal(tid, libtrace->perpkt_threads[i].tid))
293                        return &libtrace->perpkt_threads[i];
294        }
295        return NULL;
296}
297
298int get_thread_table_num(libtrace_t *libtrace) {
299        int i = 0;
300        pthread_t tid = pthread_self();
301        for (;i<libtrace->perpkt_thread_count; ++i) {
302                if (pthread_equal(tid, libtrace->perpkt_threads[i].tid))
303                        return i;
304        }
305        return -1;
306}
307
308static libtrace_thread_t * get_thread_descriptor(libtrace_t *libtrace) {
309        libtrace_thread_t *ret;
310        if (!(ret = get_thread_table(libtrace))) {
311                pthread_t tid = pthread_self();
312                // Check if we are reporter or something else
313                if (pthread_equal(tid, libtrace->reporter_thread.tid))
314                        ret = &libtrace->reporter_thread;
315                else if (pthread_equal(tid, libtrace->hasher_thread.tid))
316                        ret = &libtrace->hasher_thread;
317                else
318                        ret = NULL;
319        }
320        return ret;
321}
322
323DLLEXPORT void libtrace_make_packet_safe(libtrace_packet_t *pkt) {
324        // Duplicate the packet in standard malloc'd memory and free the
325        // original, This is a 1:1 exchange so is ocache count remains unchanged.
326        if (pkt->buf_control != TRACE_CTRL_PACKET) {
327                libtrace_packet_t *dup;
328                dup = trace_copy_packet(pkt);
329                /* Release the external buffer */
330                trace_fin_packet(pkt);
331                /* Copy the duplicated packet over the existing */
332                memcpy(pkt, dup, sizeof(libtrace_packet_t));
333        }
334}
335
336/**
337 * Makes a libtrace_result_t safe, used when pausing a trace.
338 * This will call libtrace_make_packet_safe if the result is
339 * a packet.
340 */
341DLLEXPORT void libtrace_make_result_safe(libtrace_result_t *res) {
342        if (res->type == RESULT_PACKET) {
343                libtrace_make_packet_safe(res->value.pkt);
344        }
345}
346
347/**
348 * Holds threads in a paused state, until released by broadcasting
349 * the condition mutex.
350 */
351static void trace_thread_pause(libtrace_t *trace, libtrace_thread_t *t) {
352        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
353        thread_change_state(trace, t, THREAD_PAUSED, false);
354        while (trace->state == STATE_PAUSED || trace->state == STATE_PAUSING) {
355                ASSERT_RET(pthread_cond_wait(&trace->perpkt_cond, &trace->libtrace_lock), == 0);
356        }
357        thread_change_state(trace, t, THREAD_RUNNING, false);
358        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
359}
360
361/**
362 * Sends a packet to the user, expects either a valid packet or a TICK packet.
363 *
364 * @param trace The trace
365 * @param t The current thread
366 * @param packet A pointer to the packet storage, which may be set to null upon
367 *               return, or a packet to be finished.
368 * @param tracetime If true packets are delayed to match with tracetime
369 * @return 0 is successful, otherwise if playing back in tracetime
370 *         READ_MESSAGE(-2) can be returned in which case the packet is not sent.
371 *
372 * @note READ_MESSAGE will only be returned if tracetime is true.
373 */
374static inline int dispatch_packet(libtrace_t *trace,
375                                  libtrace_thread_t *t,
376                                  libtrace_packet_t **packet,
377                                  bool tracetime) {
378
379        if ((*packet)->error > 0) {
380                if (tracetime) {
381                        if (delay_tracetime(trace, packet[0], t) == READ_MESSAGE)
382                                return READ_MESSAGE;
383                }
384                t->accepted_packets++;
385                libtrace_generic_t data = {.pkt = *packet};
386                *packet = (*trace->per_pkt)(trace, t, MESSAGE_PACKET, data, t);
387                trace_fin_packet(*packet);
388        } else {
389                assert((*packet)->error == READ_TICK);
390                libtrace_generic_t data = {.uint64 = trace_packet_get_order(*packet)};
391                (*trace->per_pkt)(trace, t, MESSAGE_TICK_COUNT, data, t);
392        }
393        return 0;
394}
395
396/**
397 * Sends a batch of packets to the user, expects either a valid packet or a
398 * TICK packet.
399 *
400 * @param trace The trace
401 * @param t The current thread
402 * @param packets [in,out] An array of packets, these may be null upon return
403 * @param nb_packets The total number of packets in the list
404 * @param empty [in,out] A pointer to an integer storing the first empty slot,
405 * upon return this is updated
406 * @param offset [in,out] The offset into the array, upon return this is updated
407 * @param tracetime If true packets are delayed to match with tracetime
408 * @return 0 is successful, otherwise if playing back in tracetime
409 *         READ_MESSAGE(-2) can be returned in which case the packet is not sent.
410 *
411 * @note READ_MESSAGE will only be returned if tracetime is true.
412 */
413static inline int dispatch_packets(libtrace_t *trace,
414                                  libtrace_thread_t *t,
415                                  libtrace_packet_t *packets[],
416                                  int nb_packets, int *empty, int *offset,
417                                  bool tracetime) {
418        for (;*offset < nb_packets; ++*offset) {
419                int ret;
420                ret = dispatch_packet(trace, t, &packets[*offset], tracetime);
421                if (ret == 0) {
422                        /* Move full slots to front as we go */
423                        if (packets[*offset]) {
424                                if (*empty != *offset) {
425                                        packets[*empty] = packets[*offset];
426                                        packets[*offset] = NULL;
427                                }
428                                ++*empty;
429                        }
430                } else {
431                        /* Break early */
432                        assert(ret == READ_MESSAGE);
433                        return READ_MESSAGE;
434                }
435        }
436
437        return 0;
438}
439
440/**
441 * Pauses a per packet thread, messages will not be processed when the thread
442 * is paused.
443 *
444 * This process involves reading packets if a hasher thread is used. As such
445 * this function can fail to pause due to errors when reading in which case
446 * the thread should be stopped instead.
447 *
448 *
449 * @brief trace_perpkt_thread_pause
450 * @return READ_ERROR(-1) or READ_EOF(0) or 1 if successfull
451 */
452static int trace_perpkt_thread_pause(libtrace_t *trace, libtrace_thread_t *t,
453                                     libtrace_packet_t *packets[],
454                                     int nb_packets, int *empty, int *offset) {
455        libtrace_packet_t * packet = NULL;
456
457        /* Let the user thread know we are going to pause */
458        (*trace->per_pkt)(trace, t, MESSAGE_PAUSING, (libtrace_generic_t){0}, t);
459
460        /* Send through any remaining packets (or messages) without delay */
461
462        /* First send those packets already read, as fast as possible
463         * This should never fail or check for messages etc. */
464        ASSERT_RET(dispatch_packets(trace, t, packets, nb_packets, empty,
465                                    offset, false), == 0);
466
467        libtrace_ocache_alloc(&trace->packet_freelist, (void **) &packet, 1, 1);
468        /* If a hasher thread is running, empty input queues so we don't lose data */
469        if (trace_has_dedicated_hasher(trace)) {
470                fprintf(stderr, "Trace is using a hasher thread emptying queues\n");
471                // The hasher has stopped by this point, so the queue shouldn't be filling
472                while(!libtrace_ringbuffer_is_empty(&t->rbuffer) || t->format_data) {
473                        int ret = trace->pread(trace, t, &packet, 1);
474                        if (ret == 1) {
475                                if (packet->error > 0) {
476                                        store_first_packet(trace, packet, t);
477                                }
478                                ASSERT_RET(dispatch_packet(trace, t, &packet, false), == 0);
479                                if (packet == NULL)
480                                        libtrace_ocache_alloc(&trace->packet_freelist, (void **) &packet, 1, 1);
481                        } else if (ret != READ_MESSAGE) {
482                                /* Ignore messages we pick these up next loop */
483                                assert (ret == READ_EOF || ret == READ_ERROR);
484                                /* Verify no packets are remaining */
485                                /* TODO refactor this sanity check out!! */
486                                while (!libtrace_ringbuffer_is_empty(&t->rbuffer)) {
487                                        ASSERT_RET(trace->pread(trace, t, &packet, 1), <= 0);
488                                        // No packets after this should have any data in them
489                                        assert(packet->error <= 0);
490                                }
491                                fprintf(stderr, "PREAD_FAILED %d\n", ret);
492                                libtrace_ocache_free(&trace->packet_freelist, (void **) &packet, 1, 1);
493                                return -1;
494                        }
495                }
496        }
497        libtrace_ocache_free(&trace->packet_freelist, (void **) &packet, 1, 1);
498
499        /* Now we do the actual pause, this returns when we resumed */
500        trace_thread_pause(trace, t);
501        (*trace->per_pkt)(trace, t, MESSAGE_RESUMING, (libtrace_generic_t){0}, t);
502        return 1;
503}
504
505/**
506 * The is the entry point for our packet processing threads.
507 */
508static void* perpkt_threads_entry(void *data) {
509        libtrace_t *trace = (libtrace_t *)data;
510        libtrace_thread_t *t;
511        libtrace_message_t message = {0};
512        libtrace_packet_t *packets[trace->config.burst_size];
513        size_t i;
514        //int ret;
515        /* The current reading position into the packets */
516        int offset = 0;
517        /* The number of packets last read */
518        int nb_packets = 0;
519        /* The offset to the first NULL packet upto offset */
520        int empty = 0;
521
522        /* Wait until trace_pstart has been completed */
523        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
524        t = get_thread_table(trace);
525        assert(t);
526        if (trace->state == STATE_ERROR) {
527                thread_change_state(trace, t, THREAD_FINISHED, false);
528                ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
529                pthread_exit(NULL);
530        }
531        //printf("Yay Started perpkt thread #%d\n", (int) get_thread_table_num(trace));
532        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
533
534        if (trace->format->pregister_thread) {
535                trace->format->pregister_thread(trace, t, !trace_has_dedicated_hasher(trace));
536        }
537
538        /* Fill our buffer with empty packets */
539        memset(&packets, 0, sizeof(void*) * trace->config.burst_size);
540        libtrace_ocache_alloc(&trace->packet_freelist, (void **) packets,
541                              trace->config.burst_size,
542                              trace->config.burst_size);
543
544        /* ~~~~~~~~~~~ Setup complete now we loop ~~~~~~~~~~~~~~~ */
545
546        /* Let the per_packet function know we have started */
547        (*trace->per_pkt)(trace, t, MESSAGE_STARTING, (libtrace_generic_t){0}, t);
548        (*trace->per_pkt)(trace, t, MESSAGE_RESUMING, (libtrace_generic_t){0}, t);
549
550        for (;;) {
551
552                if (libtrace_message_queue_try_get(&t->messages, &message) != LIBTRACE_MQ_FAILED) {
553                        int ret;
554                        switch (message.code) {
555                                case MESSAGE_DO_PAUSE: // This is internal
556                                        ret = trace_perpkt_thread_pause(trace, t,
557                                              packets, nb_packets, &empty, &offset);
558                                        if (ret == READ_EOF) {
559                                                goto eof;
560                                        } else if (ret == READ_ERROR) {
561                                                goto error;
562                                        }
563                                        assert(ret == 1);
564                                        continue;
565                                case MESSAGE_DO_STOP: // This is internal
566                                        fprintf(stderr, "DO_STOP stop!!\n");
567                                        goto eof;
568                        }
569                        (*trace->per_pkt)(trace, t, message.code, message.data, message.sender);
570                        /* Continue and the empty messages out before packets */
571                        continue;
572                }
573
574
575                /* Do we need to read a new set of packets MOST LIKELY we do */
576                if (offset == nb_packets) {
577                        /* Refill the packet buffer */
578                        if (empty != nb_packets) {
579                                // Refill the empty packets
580                                libtrace_ocache_alloc(&trace->packet_freelist,
581                                                      (void **) &packets[empty],
582                                                      nb_packets - empty,
583                                                      nb_packets - empty);
584                        }
585                        if (!trace->pread) {
586                                assert(packets[0]);
587                                nb_packets = trace_read_packet(trace, packets[0]);
588                                packets[0]->error = nb_packets;
589                                if (nb_packets > 0)
590                                        nb_packets = 1;
591                        } else {
592                                nb_packets = trace->pread(trace, t, packets, trace->config.burst_size);
593                        }
594                        offset = 0;
595                        empty = 0;
596                }
597
598                /* Handle error/message cases */
599                if (nb_packets > 0) {
600                        /* Store the first packet */
601                        if (packets[0]->error > 0) {
602                                store_first_packet(trace, packets[0], t);
603                        }
604                        dispatch_packets(trace, t, packets, nb_packets, &empty,
605                                         &offset, trace->tracetime);
606                } else {
607                        switch (nb_packets) {
608                        case READ_EOF:
609                                goto eof;
610                        case READ_ERROR:
611                                goto error;
612                        case READ_MESSAGE:
613                                nb_packets = 0;
614                                continue;
615                        default:
616                                fprintf(stderr, "Unexpected error %d!!\n", nb_packets);
617                                goto error;
618                        }
619                }
620
621        }
622
623error:
624        message.code = MESSAGE_DO_STOP;
625        message.sender = t;
626        message.data.uint64 = 0;
627        trace_message_perpkts(trace, &message);
628eof:
629        /* ~~~~~~~~~~~~~~ Trace is finished do tear down ~~~~~~~~~~~~~~~~~~~~~ */
630
631        // Let the per_packet function know we have stopped
632        (*trace->per_pkt)(trace, t, MESSAGE_PAUSING, (libtrace_generic_t){0}, t);
633        (*trace->per_pkt)(trace, t, MESSAGE_STOPPING, (libtrace_generic_t){0}, t);
634
635        // Free any remaining packets
636        for (i = 0; i < trace->config.burst_size; i++) {
637                if (packets[i]) {
638                        libtrace_ocache_free(&trace->packet_freelist, (void **) &packets[i], 1, 1);
639                        packets[i] = NULL;
640                }
641        }
642
643        thread_change_state(trace, t, THREAD_FINISHED, true);
644
645        /* Make sure the reporter sees we have finished */
646        if (trace_has_reporter(trace))
647                trace_post_reporter(trace);
648
649        // Release all ocache memory before unregistering with the format
650        // because this might(it does in DPDK) unlink the formats mempool
651        // causing destroy/finish packet to fail.
652        libtrace_ocache_unregister_thread(&trace->packet_freelist);
653        if (trace->format->punregister_thread) {
654                trace->format->punregister_thread(trace, t);
655        }
656        print_memory_stats();
657
658        pthread_exit(NULL);
659};
660
661/**
662 * The start point for our single threaded hasher thread, this will read
663 * and hash a packet from a data source and queue it against the correct
664 * core to process it.
665 */
666static void* hasher_entry(void *data) {
667        libtrace_t *trace = (libtrace_t *)data;
668        libtrace_thread_t * t;
669        int i;
670        libtrace_packet_t * packet;
671        libtrace_message_t message = {0};
672        int pkt_skipped = 0;
673
674        assert(trace_has_dedicated_hasher(trace));
675        /* Wait until all threads are started and objects are initialised (ring buffers) */
676        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
677        t = &trace->hasher_thread;
678        assert(t->type == THREAD_HASHER && pthread_equal(pthread_self(), t->tid));
679        if (trace->state == STATE_ERROR) {
680                thread_change_state(trace, t, THREAD_FINISHED, false);
681                ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
682                pthread_exit(NULL);
683        }
684
685        printf("Hasher Thread started\n");
686        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
687
688        /* We are reading but it is not the parallel API */
689        if (trace->format->pregister_thread) {
690                trace->format->pregister_thread(trace, t, true);
691        }
692
693        /* Read all packets in then hash and queue against the correct thread */
694        while (1) {
695                int thread;
696                if (!pkt_skipped)
697                        libtrace_ocache_alloc(&trace->packet_freelist, (void **) &packet, 1, 1);
698                assert(packet);
699
700                if (libtrace_halt) {
701                        packet->error = 0;
702                        break;
703                }
704
705                // Check for messages that we expect MESSAGE_DO_PAUSE, (internal messages only)
706                if (libtrace_message_queue_try_get(&t->messages, &message) != LIBTRACE_MQ_FAILED) {
707                        switch(message.code) {
708                                case MESSAGE_DO_PAUSE:
709                                        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
710                                        thread_change_state(trace, t, THREAD_PAUSED, false);
711                                        pthread_cond_broadcast(&trace->perpkt_cond);
712                                        while (trace->state == STATE_PAUSED || trace->state == STATE_PAUSING) {
713                                                ASSERT_RET(pthread_cond_wait(&trace->perpkt_cond, &trace->libtrace_lock), == 0);
714                                        }
715                                        thread_change_state(trace, t, THREAD_RUNNING, false);
716                                        pthread_cond_broadcast(&trace->perpkt_cond);
717                                        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
718                                        break;
719                                case MESSAGE_DO_STOP:
720                                        assert(trace->started == false);
721                                        assert(trace->state == STATE_FINSHED);
722                                        /* Mark the current packet as EOF */
723                                        packet->error = 0;
724                                        break;
725                                default:
726                                        fprintf(stderr, "Hasher thread didn't expect message code=%d\n", message.code);
727                        }
728                        pkt_skipped = 1;
729                        continue;
730                }
731
732                if ((packet->error = trace_read_packet(trace, packet)) <1) {
733                        break; /* We are EOF or error'd either way we stop  */
734                }
735
736                /* We are guaranteed to have a hash function i.e. != NULL */
737                trace_packet_set_hash(packet, (*trace->hasher)(packet, trace->hasher_data));
738                thread = trace_packet_get_hash(packet) % trace->perpkt_thread_count;
739                /* Blocking write to the correct queue - I'm the only writer */
740                if (trace->perpkt_threads[thread].state != THREAD_FINISHED) {
741                        uint64_t order = trace_packet_get_order(packet);
742                        libtrace_ringbuffer_write(&trace->perpkt_threads[thread].rbuffer, packet);
743                        if (trace->config.tick_count && order % trace->config.tick_count == 0) {
744                                // Write ticks to everyone else
745                                libtrace_packet_t * pkts[trace->perpkt_thread_count];
746                                memset(pkts, 0, sizeof(void *) * trace->perpkt_thread_count);
747                                libtrace_ocache_alloc(&trace->packet_freelist, (void **) pkts, trace->perpkt_thread_count, trace->perpkt_thread_count);
748                                for (i = 0; i < trace->perpkt_thread_count; i++) {
749                                        pkts[i]->error = READ_TICK;
750                                        trace_packet_set_order(pkts[i], order);
751                                        libtrace_ringbuffer_write(&trace->perpkt_threads[i].rbuffer, pkts[i]);
752                                }
753                        }
754                        pkt_skipped = 0;
755                } else {
756                        assert(!"Dropping a packet!!");
757                        pkt_skipped = 1; // Reuse that packet no one read it
758                }
759        }
760
761        /* Broadcast our last failed read to all threads */
762        for (i = 0; i < trace->perpkt_thread_count; i++) {
763                libtrace_packet_t * bcast;
764                fprintf(stderr, "Broadcasting error/EOF now the trace is over\n");
765                if (i == trace->perpkt_thread_count - 1) {
766                        bcast = packet;
767                } else {
768                        libtrace_ocache_alloc(&trace->packet_freelist, (void **) &bcast, 1, 1);
769                        bcast->error = packet->error;
770                }
771                ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
772                if (trace->perpkt_threads[i].state != THREAD_FINISHED) {
773                        // Unlock early otherwise we could deadlock
774                        libtrace_ringbuffer_write(&trace->perpkt_threads[i].rbuffer, bcast);
775                } else {
776                        fprintf(stderr, "SKIPPING THREAD !!!%d!!!/n", (int) i);
777                }
778                ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
779        }
780
781        // We don't need to free the packet
782        thread_change_state(trace, t, THREAD_FINISHED, true);
783
784        libtrace_ocache_unregister_thread(&trace->packet_freelist);
785        if (trace->format->punregister_thread) {
786                trace->format->punregister_thread(trace, t);
787        }
788        print_memory_stats();
789
790        // TODO remove from TTABLE t sometime
791        pthread_exit(NULL);
792}
793
794/* Our simplest case when a thread becomes ready it can obtain an exclusive
795 * lock to read packets from the underlying trace.
796 */
797static int trace_pread_packet_first_in_first_served(libtrace_t *libtrace,
798                                                    libtrace_thread_t *t,
799                                                    libtrace_packet_t *packets[],
800                                                    size_t nb_packets) {
801        size_t i = 0;
802        //bool tick_hit = false;
803
804        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
805        /* Read nb_packets */
806        for (i = 0; i < nb_packets; ++i) {
807                if (libtrace_halt) {
808                        break;
809                }
810                packets[i]->error = trace_read_packet(libtrace, packets[i]);
811
812                if (packets[i]->error <= 0) {
813                        /* We'll catch this next time if we have already got packets */
814                        if ( i==0 ) {
815                                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
816                                return packets[i]->error;
817                        } else {
818                                break;
819                        }
820                }
821                /*
822                if (libtrace->config.tick_count && trace_packet_get_order(packets[i]) % libtrace->config.tick_count == 0) {
823                        tick_hit = true;
824                }*/
825        }
826        // Doing this inside the lock ensures the first packet is always
827        // recorded first
828        if (packets[0]->error > 0) {
829                store_first_packet(libtrace, packets[0], t);
830        }
831        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
832        /* XXX TODO this needs to be inband with packets, or we don't bother in this case
833        if (tick_hit) {
834                libtrace_message_t tick;
835                tick.additional.uint64 = trace_packet_get_order(packets[i]);
836                tick.code = MESSAGE_TICK;
837                trace_send_message_to_perpkts(libtrace, &tick);
838        } */
839        return i;
840}
841
842/**
843 * For the case that we have a dedicated hasher thread
844 * 1. We read a packet from our buffer
845 * 2. Move that into the packet provided (packet)
846 */
847inline static int trace_pread_packet_hasher_thread(libtrace_t *libtrace,
848                                                   libtrace_thread_t *t,
849                                                   libtrace_packet_t *packets[],
850                                                   size_t nb_packets) {
851        size_t i;
852
853        /* We store the last error message here */
854        if (t->format_data) {
855                fprintf(stderr, "Hit me, ohh yeah got error %d\n",
856                        ((libtrace_packet_t *)t->format_data)->error);
857                return ((libtrace_packet_t *)t->format_data)->error;
858        }
859
860        // Always grab at least one
861        if (packets[0]) // Recycle the old get the new
862                libtrace_ocache_free(&libtrace->packet_freelist, (void **) packets, 1, 1);
863        packets[0] = libtrace_ringbuffer_read(&t->rbuffer);
864
865        if (packets[0]->error <= 0 && packets[0]->error != READ_TICK) {
866                fprintf(stderr, "Hit me, ohh yeah returning error %d\n", packets[0]->error);
867                return packets[0]->error;
868        }
869
870        for (i = 1; i < nb_packets; i++) {
871                if (packets[i]) // Recycle the old get the new
872                        libtrace_ocache_free(&libtrace->packet_freelist, (void **) &packets[i], 1, 1);
873                if (!libtrace_ringbuffer_try_read(&t->rbuffer, (void **) &packets[i])) {
874                        packets[i] = NULL;
875                        break;
876                }
877
878                /* We will return an error or EOF the next time around */
879                if (packets[i]->error <= 0 && packets[0]->error != READ_TICK) {
880                        /* The message case will be checked automatically -
881                           However other cases like EOF and error will only be
882                           sent once*/
883                        if (packets[i]->error != READ_MESSAGE) {
884                                assert(t->format_data == NULL);
885                                t->format_data = packets[i];
886                                fprintf(stderr, "Hit me, ohh yeah set error %d\n",
887                                        ((libtrace_packet_t *)t->format_data)->error);
888                        }
889                        break;
890                }
891        }
892
893        return i;
894}
895
896/**
897 * For the first packet of each queue we keep a copy and note the system
898 * time it was received at.
899 *
900 * This is used for finding the first packet when playing back a trace
901 * in trace time. And can be used by real time applications to print
902 * results out every XXX seconds.
903 */
904void store_first_packet(libtrace_t *libtrace, libtrace_packet_t *packet, libtrace_thread_t *t)
905{
906        if (!t->recorded_first) {
907                libtrace_message_t mesg = {0};
908                struct timeval tv;
909                libtrace_packet_t * dup;
910
911                /* We mark system time against a copy of the packet */
912                gettimeofday(&tv, NULL);
913                dup = trace_copy_packet(packet);
914
915                ASSERT_RET(pthread_spin_lock(&libtrace->first_packets.lock), == 0);
916                libtrace->first_packets.packets[t->perpkt_num].packet = dup;
917                memcpy(&libtrace->first_packets.packets[t->perpkt_num].tv, &tv, sizeof(tv));
918                libtrace->first_packets.count++;
919
920                /* Now update the first */
921                if (libtrace->first_packets.count == 1) {
922                        /* We the first entry hence also the first known packet */
923                        libtrace->first_packets.first = t->perpkt_num;
924                } else {
925                        /* Check if we are newer than the previous 'first' packet */
926                        size_t first = libtrace->first_packets.first;
927                        if (trace_get_seconds(dup) <
928                                trace_get_seconds(libtrace->first_packets.packets[first].packet))
929                                libtrace->first_packets.first = t->perpkt_num;
930                }
931                ASSERT_RET(pthread_spin_unlock(&libtrace->first_packets.lock), == 0);
932
933                mesg.code = MESSAGE_FIRST_PACKET;
934                trace_message_reporter(libtrace, &mesg);
935                trace_message_perpkts(libtrace, &mesg);
936                t->recorded_first = true;
937        }
938}
939
940DLLEXPORT int trace_get_first_packet(libtrace_t *libtrace,
941                                     libtrace_thread_t *t,
942                                     libtrace_packet_t **packet,
943                                     struct timeval **tv)
944{
945        void * tmp;
946        int ret = 0;
947
948        if (t) {
949                if (t->type != THREAD_PERPKT || t->trace != libtrace)
950                        return -1;
951        }
952
953        /* Throw away these which we don't use */
954        if (!packet)
955                packet = (libtrace_packet_t **) &tmp;
956        if (!tv)
957                tv = (struct timeval **) &tmp;
958
959        ASSERT_RET(pthread_spin_lock(&libtrace->first_packets.lock), == 0);
960        if (t) {
961                /* Get the requested thread */
962                *packet = libtrace->first_packets.packets[t->perpkt_num].packet;
963                *tv = &libtrace->first_packets.packets[t->perpkt_num].tv;
964        } else if (libtrace->first_packets.count) {
965                /* Get the first packet across all threads */
966                *packet = libtrace->first_packets.packets[libtrace->first_packets.first].packet;
967                *tv = &libtrace->first_packets.packets[libtrace->first_packets.first].tv;
968                if (libtrace->first_packets.count == (size_t) libtrace->perpkt_thread_count) {
969                        ret = 1;
970                } else {
971                        struct timeval curr_tv;
972                        // If a second has passed since the first entry we will assume this is the very first packet
973                        gettimeofday(&curr_tv, NULL);
974                        if (curr_tv.tv_sec > (*tv)->tv_sec) {
975                                if(curr_tv.tv_usec > (*tv)->tv_usec || curr_tv.tv_sec - (*tv)->tv_sec > 1) {
976                                        ret = 1;
977                                }
978                        }
979                }
980        } else {
981                *packet = NULL;
982                *tv = NULL;
983        }
984        ASSERT_RET(pthread_spin_unlock(&libtrace->first_packets.lock), == 0);
985        return ret;
986}
987
988
989DLLEXPORT uint64_t tv_to_usec(struct timeval *tv)
990{
991        return (uint64_t) tv->tv_sec*1000000ull + (uint64_t) tv->tv_usec;
992}
993
994inline static struct timeval usec_to_tv(uint64_t usec)
995{
996        struct timeval tv;
997        tv.tv_sec = usec / 1000000;
998        tv.tv_usec = usec % 1000000;
999        return tv;
1000}
1001
1002/** Similar to delay_tracetime but send messages to all threads periodically */
1003static void* reporter_entry(void *data) {
1004        libtrace_message_t message = {0};
1005        libtrace_t *trace = (libtrace_t *)data;
1006        libtrace_thread_t *t = &trace->reporter_thread;
1007
1008        fprintf(stderr, "Reporter thread starting\n");
1009
1010        /* Wait until all threads are started */
1011        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
1012        if (trace->state == STATE_ERROR) {
1013                thread_change_state(trace, t, THREAD_FINISHED, false);
1014                ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
1015                pthread_exit(NULL);
1016        }
1017        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
1018
1019        if (trace->format->pregister_thread) {
1020                trace->format->pregister_thread(trace, t, false);
1021        }
1022
1023        (*trace->reporter)(trace, MESSAGE_STARTING, (libtrace_generic_t) {0}, t);
1024        (*trace->reporter)(trace, MESSAGE_RESUMING, (libtrace_generic_t) {0}, t);
1025
1026        while (!trace_has_finished(trace)) {
1027                if (trace->config.reporter_polling) {
1028                        if (libtrace_message_queue_try_get(&t->messages, &message) == LIBTRACE_MQ_FAILED)
1029                                message.code = MESSAGE_POST_REPORTER;
1030                } else {
1031                        libtrace_message_queue_get(&t->messages, &message);
1032                }
1033                switch (message.code) {
1034                        // Check for results
1035                        case MESSAGE_POST_REPORTER:
1036                                trace->combiner.read(trace, &trace->combiner);
1037                                break;
1038                        case MESSAGE_DO_PAUSE:
1039                                assert(trace->combiner.pause);
1040                                trace->combiner.pause(trace, &trace->combiner);
1041                                (*trace->reporter)(trace, MESSAGE_PAUSING, (libtrace_generic_t) {0}, t);
1042                                trace_thread_pause(trace, t);
1043                                (*trace->reporter)(trace, MESSAGE_RESUMING, (libtrace_generic_t) {0}, t);
1044                                break;
1045                default:
1046                        (*trace->reporter)(trace, message.code, message.data, message.sender);
1047                }
1048        }
1049
1050        // Flush out whats left now all our threads have finished
1051        trace->combiner.read_final(trace, &trace->combiner);
1052
1053        // GOODBYE
1054        (*trace->reporter)(trace, MESSAGE_PAUSING, (libtrace_generic_t) {0}, t);
1055        (*trace->reporter)(trace, MESSAGE_STOPPING, (libtrace_generic_t) {0}, t);
1056
1057        thread_change_state(trace, &trace->reporter_thread, THREAD_FINISHED, true);
1058        print_memory_stats();
1059        return NULL;
1060}
1061
1062/** Similar to delay_tracetime but send messages to all threads periodically */
1063static void* keepalive_entry(void *data) {
1064        struct timeval prev, next;
1065        libtrace_message_t message = {0};
1066        libtrace_t *trace = (libtrace_t *)data;
1067        uint64_t next_release;
1068        libtrace_thread_t *t = &trace->keepalive_thread;
1069
1070        fprintf(stderr, "keepalive thread is starting\n");
1071
1072        /* Wait until all threads are started */
1073        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
1074        if (trace->state == STATE_ERROR) {
1075                thread_change_state(trace, t, THREAD_FINISHED, false);
1076                ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
1077                pthread_exit(NULL);
1078        }
1079        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
1080
1081        gettimeofday(&prev, NULL);
1082        message.code = MESSAGE_TICK_INTERVAL;
1083
1084        while (trace->state != STATE_FINSHED) {
1085                fd_set rfds;
1086                next_release = tv_to_usec(&prev) + (trace->config.tick_interval * 1000);
1087                gettimeofday(&next, NULL);
1088                if (next_release > tv_to_usec(&next)) {
1089                        next = usec_to_tv(next_release - tv_to_usec(&next));
1090                        // Wait for timeout or a message
1091                        FD_ZERO(&rfds);
1092                        FD_SET(libtrace_message_queue_get_fd(&t->messages), &rfds);
1093                        if (select(libtrace_message_queue_get_fd(&t->messages)+1, &rfds, NULL, NULL, &next) == 1) {
1094                                libtrace_message_t msg;
1095                                libtrace_message_queue_get(&t->messages, &msg);
1096                                assert(msg.code == MESSAGE_DO_STOP);
1097                                goto done;
1098                        }
1099                }
1100                prev = usec_to_tv(next_release);
1101                if (trace->state == STATE_RUNNING) {
1102                        message.data.uint64 = ((((uint64_t)prev.tv_sec) << 32) +
1103                                               (((uint64_t)prev.tv_usec << 32)/1000000));
1104                        trace_message_perpkts(trace, &message);
1105                }
1106        }
1107done:
1108
1109        thread_change_state(trace, t, THREAD_FINISHED, true);
1110        return NULL;
1111}
1112
1113/**
1114 * Delays a packets playback so the playback will be in trace time.
1115 * This may break early if a message becomes available.
1116 *
1117 * Requires the first packet for this thread to be received.
1118 * @param libtrace  The trace
1119 * @param packet    The packet to delay
1120 * @param t         The current thread
1121 * @return Either READ_MESSAGE(-2) or 0 is successful
1122 */
1123static inline int delay_tracetime(libtrace_t *libtrace, libtrace_packet_t *packet, libtrace_thread_t *t) {
1124        struct timeval curr_tv, pkt_tv;
1125        uint64_t next_release = t->tracetime_offset_usec;
1126        uint64_t curr_usec;
1127
1128        if (!t->tracetime_offset_usec) {
1129                libtrace_packet_t *first_pkt;
1130                struct timeval *sys_tv;
1131                int64_t initial_offset;
1132                int stable = trace_get_first_packet(libtrace, NULL, &first_pkt, &sys_tv);
1133                assert(first_pkt);
1134                pkt_tv = trace_get_timeval(first_pkt);
1135                initial_offset = (int64_t)tv_to_usec(sys_tv) - (int64_t)tv_to_usec(&pkt_tv);
1136                /* In the unlikely case offset is 0, change it to 1 */
1137                if (stable)
1138                        t->tracetime_offset_usec = initial_offset ? initial_offset: 1;
1139                next_release = initial_offset;
1140        }
1141        /* next_release == offset */
1142        pkt_tv = trace_get_timeval(packet);
1143        next_release += tv_to_usec(&pkt_tv);
1144        gettimeofday(&curr_tv, NULL);
1145        curr_usec = tv_to_usec(&curr_tv);
1146        if (next_release > curr_usec) {
1147                int ret, mesg_fd = libtrace_message_queue_get_fd(&t->messages);
1148                struct timeval delay_tv = usec_to_tv(next_release-curr_usec);
1149                fd_set rfds;
1150                FD_ZERO(&rfds);
1151                FD_SET(mesg_fd, &rfds);
1152                // We need to wait
1153
1154                //printf("WAITING for %d.%d next=%"PRIu64" curr=%"PRIu64" seconds packettime %f\n", delay_tv.tv_sec, delay_tv.tv_usec, next_release, curr_usec, trace_get_seconds(packet));
1155                ret = select(mesg_fd+1, &rfds, NULL, NULL, &delay_tv);
1156                if (ret == 0) {
1157                        return 0;
1158                } else if (ret > 0) {
1159                        return READ_MESSAGE;
1160                } else {
1161                        fprintf(stderr, "I thnik we broke select\n");
1162                }
1163        }
1164        return 0;
1165}
1166
1167/* Discards packets that don't match the filter.
1168 * Discarded packets are emptied and then moved to the end of the packet list.
1169 *
1170 * @param trace       The trace format, containing the filter
1171 * @param packets     An array of packets
1172 * @param nb_packets  The number of valid items in packets
1173 *
1174 * @return The number of packets that passed the filter, which are moved to
1175 *          the start of the packets array
1176 */
1177static inline size_t filter_packets(libtrace_t *trace,
1178                                    libtrace_packet_t **packets,
1179                                    size_t nb_packets) {
1180        size_t offset = 0;
1181        size_t i;
1182
1183        for (i = 0; i < nb_packets; ++i) {
1184                // The filter needs the trace attached to receive the link type
1185                packets[i]->trace = trace;
1186                if (trace_apply_filter(trace->filter, packets[i])) {
1187                        libtrace_packet_t *tmp;
1188                        tmp = packets[offset];
1189                        packets[offset++] = packets[i];
1190                        packets[i] = tmp;
1191                } else {
1192                        trace_fin_packet(packets[i]);
1193                }
1194        }
1195
1196        return offset;
1197}
1198
1199/* Read a batch of packets from the trace into a buffer.
1200 * Note that this function will block until a packet is read (or EOF is reached)
1201 *
1202 * @param libtrace    The trace
1203 * @param t           The thread
1204 * @param packets     An array of packets
1205 * @param nb_packets  The number of empty packets in packets
1206 * @return The number of packets read, 0 on EOF (or an error/message -1,-2).
1207 */
1208static int trace_pread_packet_wrapper(libtrace_t *libtrace,
1209                                      libtrace_thread_t *t,
1210                                      libtrace_packet_t *packets[],
1211                                      size_t nb_packets) {
1212        int i;
1213        assert(nb_packets);
1214        assert(libtrace && "libtrace is NULL in trace_read_packet()");
1215        if (trace_is_err(libtrace))
1216                return -1;
1217        if (!libtrace->started) {
1218                trace_set_err(libtrace, TRACE_ERR_BAD_STATE,
1219                              "You must call libtrace_start() before trace_read_packet()\n");
1220                return -1;
1221        }
1222
1223        if (libtrace->format->pread_packets) {
1224                int ret;
1225                for (i = 0; i < (int) nb_packets; ++i) {
1226                        assert(i[packets]);
1227                        if (!(packets[i]->buf_control==TRACE_CTRL_PACKET ||
1228                              packets[i]->buf_control==TRACE_CTRL_EXTERNAL)) {
1229                                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,
1230                                              "Packet passed to trace_read_packet() is invalid\n");
1231                                return -1;
1232                        }
1233                }
1234                do {
1235                        ret=libtrace->format->pread_packets(libtrace, t,
1236                                                            packets,
1237                                                            nb_packets);
1238                        /* Error, EOF or message? */
1239                        if (ret <= 0) {
1240                                return ret;
1241                        }
1242
1243                        if (libtrace->filter) {
1244                                int remaining;
1245                                remaining = filter_packets(libtrace,
1246                                                           packets, ret);
1247                                t->filtered_packets += ret - remaining;
1248                                ret = remaining;
1249                        }
1250                        for (i = 0; i < ret; ++i) {
1251                                /* We do not mark the packet against the trace,
1252                                 * before hand or after. After breaks DAG meta
1253                                 * packets and before is inefficient */
1254                                //packets[i]->trace = libtrace;
1255                                /* TODO IN FORMAT?? Like traditional libtrace */
1256                                if (libtrace->snaplen>0)
1257                                        trace_set_capture_length(packets[i],
1258                                                        libtrace->snaplen);
1259                                trace_packet_set_order(packets[i], trace_get_erf_timestamp(packets[i]));
1260                        }
1261                } while(ret == 0);
1262                return ret;
1263        }
1264        trace_set_err(libtrace, TRACE_ERR_UNSUPPORTED,
1265                      "This format does not support reading packets\n");
1266        return ~0U;
1267}
1268
1269/* Restarts a parallel trace, this is called from trace_pstart.
1270 * The libtrace lock is held upon calling this function.
1271 * Typically with a parallel trace the threads are not
1272 * killed rather.
1273 */
1274static int trace_prestart(libtrace_t * libtrace, void *global_blob,
1275                          fn_per_pkt per_pkt, fn_reporter reporter) {
1276        int err = 0;
1277        if (libtrace->state != STATE_PAUSED) {
1278                trace_set_err(libtrace, TRACE_ERR_BAD_STATE,
1279                        "trace(%s) is not currently paused",
1280                              libtrace->uridata);
1281                return -1;
1282        }
1283
1284        /* Update functions if requested */
1285        if (per_pkt)
1286                libtrace->per_pkt = per_pkt;
1287        if (reporter)
1288                libtrace->reporter = reporter;
1289        if(global_blob)
1290                libtrace->global_blob = global_blob;
1291
1292        assert(libtrace_parallel);
1293        assert(!libtrace->perpkt_thread_states[THREAD_RUNNING]);
1294        assert(libtrace->per_pkt);
1295
1296        if (libtrace->perpkt_thread_count > 1 &&
1297            trace_supports_parallel(libtrace) &&
1298            !trace_has_dedicated_hasher(libtrace)) {
1299                fprintf(stderr, "Restarting trace pstart_input()\n");
1300                err = libtrace->format->pstart_input(libtrace);
1301        } else {
1302                if (libtrace->format->start_input) {
1303                        fprintf(stderr, "Restarting trace start_input()\n");
1304                        err = libtrace->format->start_input(libtrace);
1305                }
1306        }
1307
1308        if (err == 0) {
1309                libtrace->started = true;
1310                libtrace_change_state(libtrace, STATE_RUNNING, false);
1311        }
1312        return err;
1313}
1314
1315/**
1316 * Verifies the configuration and sets default values for any values not
1317 * specified by the user.
1318 */
1319static void verify_configuration(libtrace_t *libtrace) {
1320        bool require_hasher = false;
1321
1322        /* Might we need a dedicated hasher thread? */
1323        if (libtrace->hasher && libtrace->hasher_type != HASHER_HARDWARE) {
1324                require_hasher = true;
1325        }
1326
1327        if (libtrace->config.hasher_queue_size <= 0)
1328                libtrace->config.hasher_queue_size = 1000;
1329
1330        if (libtrace->config.perpkt_threads <= 0) {
1331                // TODO add BSD support
1332                libtrace->perpkt_thread_count = sysconf(_SC_NPROCESSORS_ONLN);
1333                if (libtrace->perpkt_thread_count <= 0)
1334                        // Lets just use one
1335                        libtrace->perpkt_thread_count = 1;
1336        } else {
1337                libtrace->perpkt_thread_count = libtrace->config.perpkt_threads;
1338        }
1339
1340        if (libtrace->config.reporter_thold <= 0)
1341                libtrace->config.reporter_thold = 100;
1342        if (libtrace->config.burst_size <= 0)
1343                libtrace->config.burst_size = 10;
1344        if (libtrace->config.packet_thread_cache_size <= 0)
1345                libtrace->config.packet_thread_cache_size = 20;
1346        if (libtrace->config.packet_cache_size <= 0)
1347                libtrace->config.packet_cache_size = (libtrace->config.hasher_queue_size + 1) * libtrace->perpkt_thread_count;
1348
1349        if (libtrace->config.packet_cache_size <
1350                (libtrace->config.hasher_queue_size + 1) * libtrace->perpkt_thread_count)
1351                fprintf(stderr, "WARNING deadlocks may occur and extra memory allocating buffer sizes (packet_freelist_size) mismatched\n");
1352
1353        if (libtrace->combiner.initialise == NULL && libtrace->combiner.publish == NULL)
1354                libtrace->combiner = combiner_unordered;
1355
1356
1357        /* Figure out if we are using a dedicated hasher thread? */
1358        if (require_hasher && libtrace->perpkt_thread_count > 1) {
1359                libtrace->hasher_thread.type = THREAD_HASHER;
1360        }
1361}
1362
1363/**
1364 * Starts a libtrace_thread, including allocating memory for messaging.
1365 * Threads are expected to wait until the libtrace look is released.
1366 * Hence why we don't init structures until later.
1367 *
1368 * @param trace The trace the thread is associated with
1369 * @param t The thread that is filled when the thread is started
1370 * @param type The type of thread
1371 * @param start_routine The entry location of the thread
1372 * @param perpkt_num The perpkt thread number (should be set -1 if not perpkt)
1373 * @param name For debugging purposes set the threads name (Optional)
1374 *
1375 * @return 0 on success or -1 upon error in which case the libtrace error is set.
1376 *         In this situation the thread structure is zeroed.
1377 */
1378static int trace_start_thread(libtrace_t *trace,
1379                       libtrace_thread_t *t,
1380                       enum thread_types type,
1381                       void *(*start_routine) (void *),
1382                       int perpkt_num,
1383                       const char *name) {
1384        int ret;
1385        assert(t->type == THREAD_EMPTY);
1386        t->trace = trace;
1387        t->ret = NULL;
1388        t->user_data = NULL;
1389        t->type = type;
1390        t->state = THREAD_RUNNING;
1391        ret = pthread_create(&t->tid, NULL, start_routine, (void *) trace);
1392        if (ret != 0) {
1393                libtrace_zero_thread(t);
1394                trace_set_err(trace, ret, "Failed to create a thread");
1395                return -1;
1396        }
1397        libtrace_message_queue_init(&t->messages, sizeof(libtrace_message_t));
1398        if (trace_has_dedicated_hasher(trace) && type == THREAD_PERPKT) {
1399                libtrace_ringbuffer_init(&t->rbuffer,
1400                                         trace->config.hasher_queue_size,
1401                                         trace->config.hasher_polling?
1402                                                 LIBTRACE_RINGBUFFER_POLLING:
1403                                                 LIBTRACE_RINGBUFFER_BLOCKING);
1404        }
1405        if(name)
1406                pthread_setname_np(t->tid, name);
1407        t->perpkt_num = perpkt_num;
1408        return 0;
1409}
1410
1411/** Parses the environment variable LIBTRACE_CONF into the supplied
1412 * configuration structure.
1413 *
1414 * @param libtrace The trace from which we determine the URI
1415 * @param uc A configuration structure to be configured.
1416 *
1417 * We search for 3 environment variables and apply them to the config in the
1418 * following order. Such that the first has the lowest priority.
1419 *
1420 * 1. LIBTRACE_CONF, The global environment configuration
1421 * 2. LIBTRACE_CONF_<FORMAT>, Applied to a given format
1422 * 3. LIBTRACE_CONF_<FORMAT_URI>, Applied the specified trace
1423 *
1424 * E.g.
1425 * - int:eth0 would match LIBTRACE_CONF, LIBTRACE_CONF_INT, LIBTRACE_CONF_INT_ETH0
1426 * - dag:/dev/dag0,0 would match LIBTRACE_CONF, LIBTRACE_CONF_DAG, LIBTRACE_CONF_DAG__DEV_DAG0_0
1427 * - test.erf would match LIBTRACE_CONF, LIBTRACE_CONF_ERF, LIBTRACE_CONF_ERF_TEST_ERF
1428 *
1429 * @note All enironment variables names MUST only contian
1430 * [A-Z], [0-9] and [_] (underscore) and not start with a number. Any characters
1431 * outside of this range should be captilised if possible or replaced with an
1432 * underscore.
1433 */
1434static void parse_env_config (libtrace_t *libtrace, struct user_configuration* uc) {
1435        char env_name[1024] = "LIBTRACE_CONF_";
1436        size_t len = strlen(env_name);
1437        size_t mark = 0;
1438        size_t i;
1439        char * env;
1440
1441        /* Make our compound string */
1442        strncpy(&env_name[len], libtrace->format->name, sizeof(env_name) - len);
1443        len += strlen(libtrace->format->name);
1444        strncpy(&env_name[len], ":", sizeof(env_name) - len);
1445        len += 1;
1446        strncpy(&env_name[len], libtrace->uridata, sizeof(env_name) - len);
1447
1448        /* env names are allowed to be A-Z (CAPS) 0-9 and _ */
1449        for (i = 0; env_name[i] != 0; ++i) {
1450                env_name[i] = toupper(env_name[i]);
1451                if(env_name[i] == ':') {
1452                        mark = i;
1453                }
1454                if (!( (env_name[i] >= 'A' && env_name[i] <= 'Z') ||
1455                       (env_name[i] >= '0' && env_name[i] <= '9') )) {
1456                        env_name[i] = '_';
1457                }
1458        }
1459
1460        /* First apply global env settings LIBTRACE_CONF */
1461        env = getenv("LIBTRACE_CONF");
1462        if (env)
1463        {
1464                printf("Got env %s", env);
1465                parse_user_config(uc, env);
1466        }
1467
1468        /* Then format settings LIBTRACE_CONF_<FORMAT> */
1469        if (mark != 0) {
1470                env_name[mark] = 0;
1471                env = getenv(env_name);
1472                if (env) {
1473                        printf("Got %s=%s", env_name, env);
1474                        parse_user_config(uc, env);
1475                }
1476                env_name[mark] = '_';
1477        }
1478
1479        /* Finally this specific trace LIBTRACE_CONF_<FORMAT_URI> */
1480        env = getenv(env_name);
1481        if (env) {
1482                printf("Got %s=%s", env_name, env);
1483                parse_user_config(uc, env);
1484        }
1485}
1486
1487DLLEXPORT int trace_pstart(libtrace_t *libtrace, void* global_blob,
1488                           fn_per_pkt per_pkt, fn_reporter reporter) {
1489        int i;
1490        int ret = -1;
1491        char name[16];
1492        sigset_t sig_before, sig_block_all;
1493        assert(libtrace);
1494
1495        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
1496        if (trace_is_err(libtrace)) {
1497                goto cleanup_none;
1498        }
1499
1500        if (libtrace->state == STATE_PAUSED) {
1501                ret = trace_prestart(libtrace, global_blob, per_pkt, reporter);
1502                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1503                return ret;
1504        }
1505
1506        if (libtrace->state != STATE_NEW) {
1507                trace_set_err(libtrace, TRACE_ERR_BAD_STATE, "trace_pstart "
1508                              "should be called on a NEW or PAUSED trace but "
1509                              "instead was called from %s",
1510                              get_trace_state_name(libtrace->state));
1511                goto cleanup_none;
1512        }
1513
1514        /* Store the user defined things against the trace */
1515        libtrace->global_blob = global_blob;
1516        libtrace->per_pkt = per_pkt;
1517        libtrace->reporter = reporter;
1518        /* And zero other fields */
1519        for (i = 0; i < THREAD_STATE_MAX; ++i) {
1520                libtrace->perpkt_thread_states[i] = 0;
1521        }
1522        libtrace->first_packets.first = 0;
1523        libtrace->first_packets.count = 0;
1524        libtrace->first_packets.packets = NULL;
1525        libtrace->perpkt_threads = NULL;
1526        /* Set a global which says we are using a parallel trace. This is
1527         * for backwards compatability due to changes when destroying packets */
1528        libtrace_parallel = 1;
1529
1530        /* Parses configuration passed through environment variables */
1531        parse_env_config(libtrace, &libtrace->config);
1532        verify_configuration(libtrace);
1533
1534        /* Try start the format - we prefer parallel over single threaded, as
1535         * these formats should support messages better */
1536        if (trace_supports_parallel(libtrace) &&
1537            !trace_has_dedicated_hasher(libtrace)) {
1538                printf("Using the parallel trace format\n");
1539                ret = libtrace->format->pstart_input(libtrace);
1540                libtrace->pread = trace_pread_packet_wrapper;
1541        } else {
1542                printf("Using single threaded interface\n");
1543                if (libtrace->format->start_input) {
1544                        ret = libtrace->format->start_input(libtrace);
1545                }
1546                if (libtrace->perpkt_thread_count > 1)
1547                        libtrace->pread = trace_pread_packet_first_in_first_served;
1548                else
1549                        /* Use standard read_packet */
1550                        libtrace->pread = NULL;
1551        }
1552
1553        if (ret != 0) {
1554                goto cleanup_none;
1555        }
1556
1557        /* --- Start all the threads we need --- */
1558        /* Disable signals because it is inherited by the threads we start */
1559        sigemptyset(&sig_block_all);
1560        ASSERT_RET(pthread_sigmask(SIG_SETMASK, &sig_block_all, &sig_before), == 0);
1561
1562        /* If we need a hasher thread start it
1563         * Special Case: If single threaded we don't need a hasher
1564         */
1565        if (trace_has_dedicated_hasher(libtrace)) {
1566                libtrace->hasher_thread.type = THREAD_EMPTY;
1567                ret = trace_start_thread(libtrace, &libtrace->hasher_thread,
1568                                   THREAD_HASHER, hasher_entry, -1,
1569                                   "hasher-thread");
1570                if (ret != 0) {
1571                        trace_set_err(libtrace, errno, "trace_pstart "
1572                                      "failed to start a hasher thread.");
1573                        goto cleanup_started;
1574                }
1575                libtrace->pread = trace_pread_packet_hasher_thread;
1576        } else {
1577                libtrace->hasher_thread.type = THREAD_EMPTY;
1578        }
1579
1580        /* Start up our perpkt threads */
1581        libtrace->perpkt_threads = calloc(sizeof(libtrace_thread_t),
1582                                          libtrace->perpkt_thread_count);
1583        if (!libtrace->perpkt_threads) {
1584                trace_set_err(libtrace, errno, "trace_pstart "
1585                              "failed to allocate memory.");
1586                goto cleanup_threads;
1587        }
1588        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
1589                snprintf(name, sizeof(name), "perpkt-%d", i);
1590                libtrace_zero_thread(&libtrace->perpkt_threads[i]);
1591                ret = trace_start_thread(libtrace, &libtrace->perpkt_threads[i],
1592                                   THREAD_PERPKT, perpkt_threads_entry, i,
1593                                   name);
1594                if (ret != 0) {
1595                        trace_set_err(libtrace, errno, "trace_pstart "
1596                                      "failed to start a perpkt thread.");
1597                        goto cleanup_threads;
1598                }
1599        }
1600
1601        /* Start the reporter thread */
1602        if (reporter) {
1603                if (libtrace->combiner.initialise)
1604                        libtrace->combiner.initialise(libtrace, &libtrace->combiner);
1605                ret = trace_start_thread(libtrace, &libtrace->reporter_thread,
1606                                   THREAD_REPORTER, reporter_entry, -1,
1607                                   "reporter_thread");
1608                if (ret != 0) {
1609                        trace_set_err(libtrace, errno, "trace_pstart "
1610                                      "failed to start reporter thread.");
1611                        goto cleanup_threads;
1612                }
1613        }
1614
1615        /* Start the keepalive thread */
1616        if (libtrace->config.tick_interval > 0) {
1617                ret = trace_start_thread(libtrace, &libtrace->keepalive_thread,
1618                                   THREAD_KEEPALIVE, keepalive_entry, -1,
1619                                   "keepalive_thread");
1620                if (ret != 0) {
1621                        trace_set_err(libtrace, errno, "trace_pstart "
1622                                      "failed to start keepalive thread.");
1623                        goto cleanup_threads;
1624                }
1625        }
1626
1627        /* Init other data structures */
1628        libtrace->perpkt_thread_states[THREAD_RUNNING] = libtrace->perpkt_thread_count;
1629        ASSERT_RET(pthread_spin_init(&libtrace->first_packets.lock, 0), == 0);
1630        libtrace->first_packets.packets = calloc(libtrace->perpkt_thread_count,
1631                                                 sizeof(*libtrace->first_packets.packets));
1632        if (libtrace->first_packets.packets == NULL) {
1633                trace_set_err(libtrace, errno, "trace_pstart "
1634                              "failed to allocate memory.");
1635                goto cleanup_threads;
1636        }
1637
1638        if (libtrace_ocache_init(&libtrace->packet_freelist,
1639                             (void* (*)()) trace_create_packet,
1640                             (void (*)(void *))trace_destroy_packet,
1641                             libtrace->config.packet_thread_cache_size,
1642                             libtrace->config.packet_cache_size * 4,
1643                             libtrace->config.fixed_packet_count) != 0) {
1644                trace_set_err(libtrace, TRACE_ERR_INIT_FAILED, "trace_pstart "
1645                              "failed to allocate ocache.");
1646                goto cleanup_threads;
1647        }
1648
1649        /* Threads don't start */
1650        libtrace->started = true;
1651        libtrace_change_state(libtrace, STATE_RUNNING, false);
1652
1653        ret = 0;
1654        goto success;
1655cleanup_threads:
1656        if (libtrace->first_packets.packets) {
1657                free(libtrace->first_packets.packets);
1658                libtrace->first_packets.packets = NULL;
1659        }
1660        libtrace_change_state(libtrace, STATE_ERROR, false);
1661        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1662        if (libtrace->hasher_thread.type == THREAD_HASHER) {
1663                pthread_join(libtrace->hasher_thread.tid, NULL);
1664                libtrace_zero_thread(&libtrace->hasher_thread);
1665        }
1666
1667        if (libtrace->perpkt_threads) {
1668                for (i = 0; i < libtrace->perpkt_thread_count; i++) {
1669                        if (libtrace->perpkt_threads[i].type == THREAD_PERPKT) {
1670                                pthread_join(libtrace->perpkt_threads[i].tid, NULL);
1671                                libtrace_zero_thread(&libtrace->perpkt_threads[i]);
1672                        } else break;
1673                }
1674                free(libtrace->perpkt_threads);
1675                libtrace->perpkt_threads = NULL;
1676        }
1677
1678        if (libtrace->reporter_thread.type == THREAD_REPORTER) {
1679                pthread_join(libtrace->reporter_thread.tid, NULL);
1680                libtrace_zero_thread(&libtrace->reporter_thread);
1681        }
1682
1683        if (libtrace->keepalive_thread.type == THREAD_KEEPALIVE) {
1684                pthread_join(libtrace->keepalive_thread.tid, NULL);
1685                libtrace_zero_thread(&libtrace->keepalive_thread);
1686        }
1687        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
1688        libtrace_change_state(libtrace, STATE_NEW, false);
1689        assert(libtrace->perpkt_thread_states[THREAD_RUNNING] == 0);
1690        libtrace->perpkt_thread_states[THREAD_FINISHED] = 0;
1691cleanup_started:
1692        if (trace_supports_parallel(libtrace) &&
1693            !trace_has_dedicated_hasher(libtrace)
1694            && libtrace->perpkt_thread_count > 1) {
1695                if (libtrace->format->ppause_input)
1696                        libtrace->format->ppause_input(libtrace);
1697        } else {
1698                if (libtrace->format->pause_input)
1699                        libtrace->format->pause_input(libtrace);
1700        }
1701        ret = -1;
1702success:
1703        ASSERT_RET(pthread_sigmask(SIG_SETMASK, &sig_before, NULL), == 0);
1704cleanup_none:
1705        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1706        return ret;
1707}
1708
1709/*
1710 * Pauses a trace, this should only be called by the main thread
1711 * 1. Set started = false
1712 * 2. All perpkt threads are paused waiting on a condition var
1713 * 3. Then call ppause on the underlying format if found
1714 * 4. The traces state is paused
1715 *
1716 * Once done you should be able to modify the trace setup and call pstart again
1717 * TODO handle changing thread numbers
1718 */
1719DLLEXPORT int trace_ppause(libtrace_t *libtrace)
1720{
1721        libtrace_thread_t *t;
1722        int i;
1723        assert(libtrace);
1724
1725        t = get_thread_table(libtrace);
1726        // Check state from within the lock if we are going to change it
1727        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
1728        if (!libtrace->started || libtrace->state != STATE_RUNNING) {
1729                fprintf(stderr, "pause failed started=%d state=%s (%d)\n", libtrace->started, get_trace_state_name(libtrace->state), libtrace->state);
1730                trace_set_err(libtrace,TRACE_ERR_BAD_STATE, "You must call trace_start() before calling trace_ppause()");
1731                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1732                return -1;
1733        }
1734
1735        libtrace_change_state(libtrace, STATE_PAUSING, false);
1736        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1737
1738        // Special case handle the hasher thread case
1739        if (trace_has_dedicated_hasher(libtrace)) {
1740                if (libtrace->config.debug_state)
1741                        fprintf(stderr, "Hasher thread is running, asking it to pause ...");
1742                libtrace_message_t message = {0};
1743                message.code = MESSAGE_DO_PAUSE;
1744                trace_message_thread(libtrace, &libtrace->hasher_thread, &message);
1745                // Wait for it to pause
1746                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
1747                while (libtrace->hasher_thread.state == THREAD_RUNNING) {
1748                        ASSERT_RET(pthread_cond_wait(&libtrace->perpkt_cond, &libtrace->libtrace_lock), == 0);
1749                }
1750                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1751                if (libtrace->config.debug_state)
1752                        fprintf(stderr, " DONE\n");
1753        }
1754
1755        if (libtrace->config.debug_state)
1756                fprintf(stderr, "Asking perpkt threads to pause ...");
1757        // Stop threads, skip this one if it's a perpkt
1758        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
1759                if (&libtrace->perpkt_threads[i] != t) {
1760                        libtrace_message_t message = {0};
1761                        message.code = MESSAGE_DO_PAUSE;
1762                        trace_message_thread(libtrace, &libtrace->perpkt_threads[i], &message);
1763                        if(trace_has_dedicated_hasher(libtrace)) {
1764                                // The hasher has stopped and other threads have messages waiting therefore
1765                                // If the queues are empty the other threads would have no data
1766                                // So send some message packets to simply ask the threads to check
1767                                // We are the only writer since hasher has paused
1768                                libtrace_packet_t *pkt;
1769                                libtrace_ocache_alloc(&libtrace->packet_freelist, (void **) &pkt, 1, 1);
1770                                pkt->error = READ_MESSAGE;
1771                                libtrace_ringbuffer_write(&libtrace->perpkt_threads[i].rbuffer, pkt);
1772                        }
1773                } else {
1774                        fprintf(stderr, "Mapper threads should not be used to pause a trace this could cause any number of problems!!\n");
1775                }
1776        }
1777
1778        if (t) {
1779                // A perpkt is doing the pausing, interesting, fake an extra thread paused
1780                // We rely on the user to *not* return before starting the trace again
1781                thread_change_state(libtrace, t, THREAD_PAUSED, true);
1782        }
1783
1784        // Wait for all threads to pause
1785        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
1786        while(libtrace->perpkt_thread_states[THREAD_RUNNING]) {
1787                ASSERT_RET(pthread_cond_wait(&libtrace->perpkt_cond, &libtrace->libtrace_lock), == 0);
1788        }
1789        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1790
1791        if (libtrace->config.debug_state)
1792                fprintf(stderr, " DONE\n");
1793
1794        // Deal with the reporter
1795        if (trace_has_reporter(libtrace)) {
1796                if (libtrace->config.debug_state)
1797                        fprintf(stderr, "Reporter thread is running, asking it to pause ...");
1798                libtrace_message_t message = {0};
1799                message.code = MESSAGE_DO_PAUSE;
1800                trace_message_thread(libtrace, &libtrace->reporter_thread, &message);
1801                // Wait for it to pause
1802                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
1803                while (libtrace->reporter_thread.state == THREAD_RUNNING) {
1804                        ASSERT_RET(pthread_cond_wait(&libtrace->perpkt_cond, &libtrace->libtrace_lock), == 0);
1805                }
1806                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
1807                if (libtrace->config.debug_state)
1808                        fprintf(stderr, " DONE\n");
1809        }
1810
1811        /* Cache values before we pause */
1812        if (libtrace->stats == NULL)
1813                libtrace->stats = trace_create_statistics();
1814        // Save the statistics against the trace
1815        trace_get_statistics(libtrace, NULL);
1816        if (trace_supports_parallel(libtrace) && !trace_has_dedicated_hasher(libtrace) && libtrace->perpkt_thread_count > 1) {
1817                libtrace->started = false;
1818                if (libtrace->format->ppause_input)
1819                        libtrace->format->ppause_input(libtrace);
1820                // TODO What happens if we don't have pause input??
1821        } else {
1822                int err;
1823                fprintf(stderr, "Trace is not parallel so we are doing a normal pause %s\n", libtrace->uridata);
1824                err = trace_pause(libtrace);
1825                // We should handle this a bit better
1826                if (err)
1827                        return err;
1828        }
1829
1830        // Only set as paused after the pause has been called on the trace
1831        libtrace_change_state(libtrace, STATE_PAUSED, true);
1832        return 0;
1833}
1834
1835/**
1836 * Stop trace finish prematurely as though it meet an EOF
1837 * This should only be called by the main thread
1838 * 1. Calls ppause
1839 * 2. Sends a message asking for threads to finish
1840 * 3. Releases threads which will pause
1841 */
1842DLLEXPORT int trace_pstop(libtrace_t *libtrace)
1843{
1844        int i, err;
1845        libtrace_message_t message = {0};
1846        assert(libtrace);
1847
1848        // Ensure all threads have paused and the underlying trace format has
1849        // been closed and all packets associated are cleaned up
1850        // Pause will do any state checks for us
1851        err = trace_ppause(libtrace);
1852        if (err)
1853                return err;
1854
1855        // Now send a message asking the threads to stop
1856        // This will be retrieved before trying to read another packet
1857
1858        message.code = MESSAGE_DO_STOP;
1859        trace_message_perpkts(libtrace, &message);
1860        if (trace_has_dedicated_hasher(libtrace))
1861                trace_message_thread(libtrace, &libtrace->hasher_thread, &message);
1862
1863        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
1864                trace_message_thread(libtrace, &libtrace->perpkt_threads[i], &message);
1865        }
1866
1867        // Now release the threads and let them stop
1868        libtrace_change_state(libtrace, STATE_FINSHED, true);
1869        return 0;
1870}
1871
1872/**
1873 * Set the hasher type along with a selected function, if hardware supports
1874 * that generic type of hashing it will be used otherwise the supplied
1875 * hasher function will be used and passed data when called.
1876 *
1877 * @return 0 if successful otherwise -1 on error
1878 */
1879DLLEXPORT int trace_set_hasher(libtrace_t *trace, enum hasher_types type, fn_hasher hasher, void *data) {
1880        int ret = -1;
1881        if (type == HASHER_HARDWARE || (type == HASHER_CUSTOM && !hasher) || (type == HASHER_BALANCE && hasher)) {
1882                return -1;
1883        }
1884
1885        // Save the requirements
1886        trace->hasher_type = type;
1887        if (hasher) {
1888                trace->hasher = hasher;
1889                trace->hasher_data = data;
1890        } else {
1891                trace->hasher = NULL;
1892                trace->hasher_data = NULL;
1893        }
1894
1895        // Try push this to hardware - NOTE hardware could do custom if
1896        // there is a more efficient way to apply it, in this case
1897        // it will simply grab the function out of libtrace_t
1898        if (trace->format->pconfig_input)
1899                ret = trace->format->pconfig_input(trace, TRACE_OPTION_SET_HASHER, &type);
1900
1901        if (ret == -1) {
1902                // We have to deal with this ourself
1903                // This most likely means single threaded reading of the trace
1904                if (!hasher) {
1905                        switch (type)
1906                        {
1907                                case HASHER_CUSTOM:
1908                                case HASHER_BALANCE:
1909                                        return 0;
1910                                case HASHER_BIDIRECTIONAL:
1911                                        trace->hasher = (fn_hasher) toeplitz_hash_packet;
1912                                        trace->hasher_data = calloc(1, sizeof(toeplitz_conf_t));
1913                                        toeplitz_init_config(trace->hasher_data, 1);
1914                                        return 0;
1915                                case HASHER_UNIDIRECTIONAL:
1916                                        trace->hasher = (fn_hasher) toeplitz_hash_packet;
1917                                        trace->hasher_data = calloc(1, sizeof(toeplitz_conf_t));
1918                                        toeplitz_init_config(trace->hasher_data, 0);
1919                                        return 0;
1920                                case HASHER_HARDWARE:
1921                                        return -1;
1922                        }
1923                        return -1;
1924                }
1925        } else {
1926                // The hardware is dealing with this yay
1927                trace->hasher_type = HASHER_HARDWARE;
1928        }
1929
1930        return 0;
1931}
1932
1933// Waits for all threads to finish
1934DLLEXPORT void trace_join(libtrace_t *libtrace) {
1935        int i;
1936
1937        /* Firstly wait for the perpkt threads to finish, since these are
1938         * user controlled */
1939        for (i=0; i< libtrace->perpkt_thread_count; i++) {
1940                //printf("Waiting to join with perpkt #%d\n", i);
1941                ASSERT_RET(pthread_join(libtrace->perpkt_threads[i].tid, NULL), == 0);
1942                //printf("Joined with perpkt #%d\n", i);
1943                // So we must do our best effort to empty the queue - so
1944                // the producer (or any other threads) don't block.
1945                libtrace_packet_t * packet;
1946                assert(libtrace->perpkt_threads[i].state == THREAD_FINISHED);
1947                while(libtrace_ringbuffer_try_read(&libtrace->perpkt_threads[i].rbuffer, (void **) &packet))
1948                        if (packet) // This could be NULL iff the perpkt finishes early
1949                                trace_destroy_packet(packet);
1950        }
1951
1952        /* Now the hasher */
1953        if (trace_has_dedicated_hasher(libtrace)) {
1954                pthread_join(libtrace->hasher_thread.tid, NULL);
1955                assert(libtrace->hasher_thread.state == THREAD_FINISHED);
1956        }
1957
1958        // Now that everything is finished nothing can be touching our
1959        // buffers so clean them up
1960        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
1961                // Its possible 1 packet got added by the reporter (or 1 per any other thread) since we cleaned up
1962                // if they lost timeslice before-during a write
1963                libtrace_packet_t * packet;
1964                while(libtrace_ringbuffer_try_read(&libtrace->perpkt_threads[i].rbuffer, (void **) &packet))
1965                        trace_destroy_packet(packet);
1966                if (libtrace->hasher) {
1967                        assert(libtrace_ringbuffer_is_empty(&libtrace->perpkt_threads[i].rbuffer));
1968                        libtrace_ringbuffer_destroy(&libtrace->perpkt_threads[i].rbuffer);
1969                }
1970                // Cannot destroy vector yet, this happens with trace_destroy
1971        }
1972
1973        if (trace_has_reporter(libtrace)) {
1974                pthread_join(libtrace->reporter_thread.tid, NULL);
1975                assert(libtrace->reporter_thread.state == THREAD_FINISHED);
1976        }
1977
1978        // Wait for the tick (keepalive) thread if it has been started
1979        if (libtrace->keepalive_thread.type == THREAD_KEEPALIVE) {
1980                libtrace_message_t msg = {0};
1981                msg.code = MESSAGE_DO_STOP;
1982                trace_message_thread(libtrace, &libtrace->keepalive_thread, &msg);
1983                pthread_join(libtrace->keepalive_thread.tid, NULL);
1984        }
1985
1986        libtrace_change_state(libtrace, STATE_JOINED, true);
1987        print_memory_stats();
1988}
1989
1990DLLEXPORT int libtrace_thread_get_message_count(libtrace_t * libtrace,
1991                                                libtrace_thread_t *t)
1992{
1993        int ret;
1994        if (t == NULL)
1995                t = get_thread_descriptor(libtrace);
1996        if (t == NULL)
1997                return -1;
1998        ret = libtrace_message_queue_count(&t->messages);
1999        return ret < 0 ? 0 : ret;
2000}
2001
2002DLLEXPORT int libtrace_thread_get_message(libtrace_t * libtrace,
2003                                          libtrace_thread_t *t,
2004                                          libtrace_message_t * message)
2005{
2006        int ret;
2007        if (t == NULL)
2008                t = get_thread_descriptor(libtrace);
2009        if (t == NULL)
2010                return -1;
2011        ret = libtrace_message_queue_get(&t->messages, message);
2012        return ret < 0 ? 0 : ret;
2013}
2014
2015DLLEXPORT int libtrace_thread_try_get_message(libtrace_t * libtrace,
2016                                              libtrace_thread_t *t,
2017                                              libtrace_message_t * message)
2018{
2019        if (t == NULL)
2020                t = get_thread_descriptor(libtrace);
2021        if (t == NULL)
2022                return -1;
2023        if (libtrace_message_queue_try_get(&t->messages, message) != LIBTRACE_MQ_FAILED)
2024                return 0;
2025        else
2026                return -1;
2027}
2028
2029DLLEXPORT int trace_message_thread(libtrace_t * libtrace, libtrace_thread_t *t, libtrace_message_t * message)
2030{
2031        int ret;
2032        if (!message->sender)
2033                message->sender = get_thread_descriptor(libtrace);
2034
2035        ret = libtrace_message_queue_put(&t->messages, message);
2036        return ret < 0 ? 0 : ret;
2037}
2038
2039DLLEXPORT int trace_message_reporter(libtrace_t * libtrace, libtrace_message_t * message)
2040{
2041        if (!trace_has_reporter(libtrace) ||
2042            !(libtrace->reporter_thread.state == THREAD_RUNNING
2043              || libtrace->reporter_thread.state == THREAD_PAUSED))
2044                return -1;
2045
2046        return trace_message_thread(libtrace, &libtrace->reporter_thread, message);
2047}
2048
2049DLLEXPORT int trace_post_reporter(libtrace_t *libtrace)
2050{
2051        libtrace_message_t message = {0};
2052        message.code = MESSAGE_POST_REPORTER;
2053        return trace_message_reporter(libtrace, (void *) &message);
2054}
2055
2056DLLEXPORT int trace_message_perpkts(libtrace_t * libtrace, libtrace_message_t * message)
2057{
2058        int i;
2059        int missed;
2060        if (message->sender == NULL)
2061                message->sender = get_thread_descriptor(libtrace);
2062        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
2063                if (libtrace->perpkt_threads[i].state == THREAD_RUNNING ||
2064                    libtrace->perpkt_threads[i].state == THREAD_PAUSED) {
2065                        libtrace_message_queue_put(&libtrace->perpkt_threads[i].messages, message);
2066                } else {
2067                        missed += 1;
2068                }
2069        }
2070        return -missed;
2071}
2072
2073DLLEXPORT void * trace_get_local(libtrace_t *trace)
2074{
2075        return trace->global_blob;
2076}
2077
2078DLLEXPORT void * trace_set_local(libtrace_t *trace, void * data)
2079{
2080        void *ret;
2081        pthread_mutex_lock(&trace->libtrace_lock);
2082        ret = trace->global_blob;
2083        trace->global_blob = data;
2084        pthread_mutex_unlock(&trace->libtrace_lock);
2085        return ret;
2086}
2087
2088DLLEXPORT void * trace_get_tls(libtrace_thread_t *t)
2089{
2090        return t->user_data;
2091}
2092
2093DLLEXPORT void * trace_set_tls(libtrace_thread_t *t, void * data)
2094{
2095        void *ret = t->user_data;
2096        t->user_data = data;
2097        return ret;
2098}
2099
2100/**
2101 * Publishes a result to the reduce queue
2102 * Should only be called by a perpkt thread, i.e. from a perpkt handler
2103 */
2104DLLEXPORT void trace_publish_result(libtrace_t *libtrace, libtrace_thread_t *t, uint64_t key, libtrace_generic_t value, int type) {
2105        libtrace_result_t res;
2106        res.type = type;
2107        res.key = key;
2108        res.value = value;
2109        assert(libtrace->combiner.publish);
2110        libtrace->combiner.publish(libtrace, t->perpkt_num, &libtrace->combiner, &res);
2111        return;
2112}
2113
2114DLLEXPORT void trace_set_combiner(libtrace_t *trace, const libtrace_combine_t *combiner, libtrace_generic_t config){
2115        if (combiner) {
2116                trace->combiner = *combiner;
2117                trace->combiner.configuration = config;
2118        } else {
2119                // No combiner, so don't try use it
2120                memset(&trace->combiner, 0, sizeof(trace->combiner));
2121        }
2122}
2123
2124DLLEXPORT uint64_t trace_packet_get_order(libtrace_packet_t * packet) {
2125        return packet->order;
2126}
2127
2128DLLEXPORT uint64_t trace_packet_get_hash(libtrace_packet_t * packet) {
2129        return packet->hash;
2130}
2131
2132DLLEXPORT void trace_packet_set_order(libtrace_packet_t * packet, uint64_t order) {
2133        packet->order = order;
2134}
2135
2136DLLEXPORT void trace_packet_set_hash(libtrace_packet_t * packet, uint64_t hash) {
2137        packet->hash = hash;
2138}
2139
2140DLLEXPORT bool trace_has_finished(libtrace_t * libtrace) {
2141        return libtrace->state == STATE_FINSHED || libtrace->state == STATE_JOINED;
2142}
2143
2144DLLEXPORT int trace_parallel_config(libtrace_t *libtrace, trace_parallel_option_t option, void *value)
2145{
2146        UNUSED int ret = -1;
2147        switch (option) {
2148                case TRACE_OPTION_TICK_INTERVAL:
2149                        libtrace->config.tick_interval = *((int *) value);
2150                        return 1;
2151                case TRACE_OPTION_SET_HASHER:
2152                        return trace_set_hasher(libtrace, (enum hasher_types) *((int *) value), NULL, NULL);
2153                case TRACE_OPTION_SET_PERPKT_THREAD_COUNT:
2154                        libtrace->config.perpkt_threads = *((int *) value);
2155                        return 1;
2156                case TRACE_OPTION_TRACETIME:
2157                        if(*((int *) value))
2158                                libtrace->tracetime = 1;
2159                        else
2160                                libtrace->tracetime = 0;
2161                        return 0;
2162                case TRACE_OPTION_SET_CONFIG:
2163                        libtrace->config = *((struct user_configuration *) value);
2164                case TRACE_OPTION_GET_CONFIG:
2165                        *((struct user_configuration *) value) = libtrace->config;
2166        }
2167        return 0;
2168}
2169
2170static bool config_bool_parse(char *value, size_t nvalue) {
2171        if (strncmp(value, "true", nvalue) == 0)
2172                return true;
2173        else if (strncmp(value, "false", nvalue) == 0)
2174                return false;
2175        else
2176                return strtoll(value, NULL, 10) != 0;
2177}
2178
2179static void config_string(struct user_configuration *uc, char *key, size_t nkey, char *value, size_t nvalue) {
2180        assert(key);
2181        assert(value);
2182        assert(uc);
2183        if (strncmp(key, "packet_cache_size", nkey) == 0
2184            || strncmp(key, "pcs", nkey) == 0) {
2185                uc->packet_cache_size = strtoll(value, NULL, 10);
2186        } else if (strncmp(key, "packet_thread_cache_size", nkey) == 0
2187                   || strncmp(key, "ptcs", nkey) == 0) {
2188                uc->packet_thread_cache_size = strtoll(value, NULL, 10);
2189        } else if (strncmp(key, "fixed_packet_count", nkey) == 0
2190                   || strncmp(key, "fpc", nkey) == 0) {
2191                uc->fixed_packet_count = config_bool_parse(value, nvalue);
2192        } else if (strncmp(key, "burst_size", nkey) == 0
2193                   || strncmp(key, "bs", nkey) == 0) {
2194                uc->burst_size = strtoll(value, NULL, 10);
2195        } else if (strncmp(key, "tick_interval", nkey) == 0
2196                   || strncmp(key, "ti", nkey) == 0) {
2197                uc->tick_interval = strtoll(value, NULL, 10);
2198        } else if (strncmp(key, "tick_count", nkey) == 0
2199                   || strncmp(key, "tc", nkey) == 0) {
2200                uc->tick_count = strtoll(value, NULL, 10);
2201        } else if (strncmp(key, "perpkt_threads", nkey) == 0
2202                   || strncmp(key, "pt", nkey) == 0) {
2203                uc->perpkt_threads = strtoll(value, NULL, 10);
2204        } else if (strncmp(key, "hasher_queue_size", nkey) == 0
2205                   || strncmp(key, "hqs", nkey) == 0) {
2206                uc->hasher_queue_size = strtoll(value, NULL, 10);
2207        } else if (strncmp(key, "hasher_polling", nkey) == 0
2208                   || strncmp(key, "hp", nkey) == 0) {
2209                uc->hasher_polling = config_bool_parse(value, nvalue);
2210        } else if (strncmp(key, "reporter_polling", nkey) == 0
2211                   || strncmp(key, "rp", nkey) == 0) {
2212                uc->reporter_polling = config_bool_parse(value, nvalue);
2213        } else if (strncmp(key, "reporter_thold", nkey) == 0
2214                   || strncmp(key, "rt", nkey) == 0) {
2215                uc->reporter_thold = strtoll(value, NULL, 10);
2216        } else if (strncmp(key, "debug_state", nkey) == 0
2217                   || strncmp(key, "ds", nkey) == 0) {
2218                uc->debug_state = config_bool_parse(value, nvalue);
2219        } else {
2220                fprintf(stderr, "No matching value %s(=%s)\n", key, value);
2221        }
2222}
2223
2224DLLEXPORT void parse_user_config(struct user_configuration* uc, char * str) {
2225        char *pch;
2226        char key[100];
2227        char value[100];
2228        assert(str);
2229        assert(uc);
2230        pch = strtok (str," ,.-");
2231        while (pch != NULL)
2232        {
2233                if (sscanf(pch, "%99[^=]=%99s", key, value) == 2) {
2234                        config_string(uc, key, sizeof(key), value, sizeof(value));
2235                } else {
2236                        fprintf(stderr, "Error parsing %s\n", pch);
2237                }
2238                pch = strtok (NULL," ,.-");
2239        }
2240}
2241
2242DLLEXPORT void parse_user_config_file(struct user_configuration* uc, FILE *file) {
2243        char line[1024];
2244        while (fgets(line, sizeof(line), file) != NULL)
2245        {
2246                parse_user_config(uc, line);
2247        }
2248}
2249
2250DLLEXPORT void trace_free_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
2251        assert(packet);
2252        /* Always release any resources this might be holding */
2253        trace_fin_packet(packet);
2254        libtrace_ocache_free(&libtrace->packet_freelist, (void **) &packet, 1, 1);
2255}
2256
2257DLLEXPORT libtrace_info_t *trace_get_information(libtrace_t * libtrace) {
2258        if (libtrace->format)
2259                return &libtrace->format->info;
2260        else
2261                return NULL;
2262}
Note: See TracBrowser for help on using the repository browser.