source: lib/trace_parallel.c @ 9c46b65

develop
Last change on this file since 9c46b65 was 9c46b65, checked in by Shane Alcock <salcock@…>, 23 months ago

Fix bug where trace_pstop had stopped working as intended.

Bug crept in as part of Jacob's assert fixes (and also slipped
past my review).

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