source: lib/trace_parallel.c @ d994324

/*
 * This file is part of libtrace
 *
 * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton,
 * New Zealand.
 *
 * All rights reserved.
 *
 * This code has been developed by the University of Waikato WAND
 * research group. For further information please see http://www.wand.net.nz/
 *
 * libtrace is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * libtrace is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libtrace; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * $Id$
 *
 */


#define _GNU_SOURCE
#include "common.h"
#include "config.h"
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#ifndef WIN32
#include <sys/socket.h>
#endif
#include <stdarg.h>
#include <sys/param.h>

#ifdef HAVE_LIMITS_H
#  include <limits.h>
#endif

#ifdef HAVE_SYS_LIMITS_H
#  include <sys/limits.h>
#endif

#ifdef HAVE_NET_IF_ARP_H
#  include <net/if_arp.h>
#endif

#ifdef HAVE_NET_IF_H
#  include <net/if.h>
#endif

#ifdef HAVE_NETINET_IN_H
#  include <netinet/in.h>
#endif

#ifdef HAVE_NET_ETHERNET_H
#  include <net/ethernet.h>
#endif

#ifdef HAVE_NETINET_IF_ETHER_H
#  include <netinet/if_ether.h>
#endif

#include <time.h>
#ifdef WIN32
#include <sys/timeb.h>
#endif

#include "libtrace.h"
#include "libtrace_int.h"

#ifdef HAVE_PCAP_BPF_H
#  include <pcap-bpf.h>
#else
#  ifdef HAVE_NET_BPF_H
#    include <net/bpf.h>
#  endif
#endif


#include "libtrace_int.h"
#include "format_helper.h"
#include "rt_protocol.h"
#include "hash_toeplitz.h"
#include "combiners.h"

#include <pthread.h>
#include <signal.h>
#include <unistd.h>


static size_t trace_pread_packet(libtrace_t *libtrace, libtrace_thread_t *t, libtrace_packet_t *packets[], size_t nb_packets);

extern int libtrace_parallel;

struct multithreading_stats {
        uint64_t full_queue_hits;
        uint64_t wait_for_fill_complete_hits;
} contention_stats[1024];

struct mem_stats {
        struct memfail {
           uint64_t cache_hit;
           uint64_t ring_hit;
           uint64_t miss;
           uint64_t recycled;
        } readbulk, read, write, writebulk;
};

// Grrr gcc wants this spelt out
__thread struct mem_stats mem_hits = {{0},{0},{0},{0}};

static void print_memory_stats() {
        char t_name[50];
        uint64_t total;
        pthread_getname_np(pthread_self(), t_name, sizeof(t_name));

        fprintf(stderr, "Thread ID#%d - %s\n", (int) pthread_self(), t_name);

        total = mem_hits.read.cache_hit + mem_hits.read.ring_hit + mem_hits.read.miss;
        if (total) {
                fprintf(stderr, "\tRead:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
                                mem_hits.read.cache_hit, mem_hits.read.ring_hit, mem_hits.read.miss, mem_hits.read.recycled);
                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
                                total, (double) mem_hits.read.miss / (double) total * 100.0);
        }

        total = mem_hits.readbulk.cache_hit + mem_hits.readbulk.ring_hit + mem_hits.readbulk.miss;
        if (total) {
                fprintf(stderr, "\tReadbulk:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
                                mem_hits.readbulk.cache_hit, mem_hits.readbulk.ring_hit, mem_hits.readbulk.miss, mem_hits.readbulk.recycled);


                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
                                total, (double) mem_hits.readbulk.miss / (double) total * 100.0);
        }

        total = mem_hits.write.cache_hit + mem_hits.write.ring_hit + mem_hits.write.miss;
        if (total) {
                fprintf(stderr, "\tWrite:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
                                mem_hits.write.cache_hit, mem_hits.write.ring_hit, mem_hits.write.miss, mem_hits.write.recycled);

                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
                                total, (double) mem_hits.write.miss / (double) total * 100.0);
        }

        total = mem_hits.writebulk.cache_hit + mem_hits.writebulk.ring_hit + mem_hits.writebulk.miss;
        if (total) {
                fprintf(stderr, "\tWritebulk:\n\t---CHits=%"PRIu64"\n\t---RHits=%"PRIu64"\n\t---Misses=%"PRIu64"\n\t---Recycled=%"PRIu64"\n",
                                mem_hits.writebulk.cache_hit, mem_hits.writebulk.ring_hit, mem_hits.writebulk.miss, mem_hits.writebulk.recycled);

                fprintf(stderr, "\t---Total=%"PRIu64"\n\t---Miss %%=%f\n",
                                total, (double) mem_hits.writebulk.miss / (double) total * 100.0);
        }

}

/**
 * True if the trace has dedicated hasher thread otherwise false,
 * to be used after the trace is running
 */
static inline int trace_has_dedicated_hasher(libtrace_t * libtrace)
{
        assert(libtrace->state != STATE_NEW);
        return libtrace->hasher_thread.type == THREAD_HASHER;
}

/**
 * True if the trace has dedicated hasher thread otherwise false,
 * to be used after the trace is running
 */
static inline int trace_has_dedicated_reporter(libtrace_t * libtrace)
{
        assert(libtrace->state != STATE_NEW);
        return libtrace->reporter_thread.type == THREAD_REPORTER && libtrace->reporter;
}

/**
 * When running the number of perpkt threads in use.
 * TODO what if the trace is not running yet, or has finished??
 *
 * @brief libtrace_perpkt_thread_nb
 * @param t The trace
 * @return
 */
DLLEXPORT int libtrace_get_perpkt_count(libtrace_t * t) {
        return t->perpkt_thread_count;
}

/**
 * Changes a thread's state and broadcasts the condition variable. This
 * should always be done when the lock is held. 
 *
 * Additionally for perpkt threads the state counts are updated.
 *
 * @param trace A pointer to the trace
 * @param t A pointer to the thread to modify
 * @param new_state The new state of the thread
 * @param need_lock Set to true if libtrace_lock is not held, otherwise
 *        false in the case the lock is currently held by this thread.
 */
static inline void thread_change_state(libtrace_t *trace, libtrace_thread_t *t,
        const enum thread_states new_state, const bool need_lock)
{
        enum thread_states prev_state;
        if (need_lock)
                pthread_mutex_lock(&trace->libtrace_lock);
        prev_state = t->state;
        t->state = new_state;
        if (t->type == THREAD_PERPKT) {
                --trace->perpkt_thread_states[prev_state];
                ++trace->perpkt_thread_states[new_state];
        }

        if (trace->config.debug_state)
                fprintf(stderr, "Thread %d state changed from %d to %d\n", (int) t->tid,
                        prev_state, t->state);

        if (need_lock)
                pthread_mutex_unlock(&trace->libtrace_lock);
        pthread_cond_broadcast(&trace->perpkt_cond);
}

/**
 * Changes the overall traces state and signals the condition.
 * 
 * @param trace A pointer to the trace
 * @param new_state The new state of the trace
 * @param need_lock Set to true if libtrace_lock is not held, otherwise
 *        false in the case the lock is currently held by this thread.
 */
static inline void libtrace_change_state(libtrace_t *trace, 
        const enum trace_state new_state, const bool need_lock)
{
        UNUSED enum trace_state prev_state;
        if (need_lock)
                pthread_mutex_lock(&trace->libtrace_lock);
        prev_state = trace->state;
        trace->state = new_state;

        if (trace->config.debug_state)
                fprintf(stderr, "Trace(%s) state changed from %s to %s\n",
                        trace->uridata, get_trace_state_name(prev_state),
                        get_trace_state_name(trace->state));

        if (need_lock)
                pthread_mutex_unlock(&trace->libtrace_lock);
        pthread_cond_broadcast(&trace->perpkt_cond);
}

/**
 * @return True if the format supports parallel threads.
 */
static inline bool trace_supports_parallel(libtrace_t *trace)
{
        assert(trace);
        assert(trace->format);
        if (trace->format->pstart_input)
                return true;
        else
                return false;
}

DLLEXPORT void print_contention_stats(libtrace_t *libtrace) {
        int i;
        struct multithreading_stats totals = {0};
        for (i = 0; i < libtrace->perpkt_thread_count ; i++) {
                fprintf(stderr, "\nStats for perpkt thread#%d\n", i);
                fprintf(stderr, "\tfull_queue_hits: %"PRIu64"\n", contention_stats[i].full_queue_hits);
                totals.full_queue_hits += contention_stats[i].full_queue_hits;
                fprintf(stderr, "\twait_for_fill_complete_hits: %"PRIu64"\n", contention_stats[i].wait_for_fill_complete_hits);
                totals.wait_for_fill_complete_hits += contention_stats[i].wait_for_fill_complete_hits;
        }
        fprintf(stderr, "\nTotals for perpkt threads\n");
        fprintf(stderr, "\tfull_queue_hits: %"PRIu64"\n", totals.full_queue_hits);
        fprintf(stderr, "\twait_for_fill_complete_hits: %"PRIu64"\n", totals.wait_for_fill_complete_hits);

        return;
}

void libtrace_zero_thread(libtrace_thread_t * t) {
        t->trace = NULL;
        t->ret = NULL;
        t->type = THREAD_EMPTY;
        libtrace_zero_ringbuffer(&t->rbuffer);
        t->recorded_first = false;
        t->perpkt_num = -1;
        t->accepted_packets = 0;
}

// Ints are aligned int is atomic so safe to read and write at same time
// However write must be locked, read doesn't (We never try read before written to table)
libtrace_thread_t * get_thread_table(libtrace_t *libtrace) {
        int i = 0;
        pthread_t tid = pthread_self();

        for (;i<libtrace->perpkt_thread_count ;++i) {
                if (pthread_equal(tid, libtrace->perpkt_threads[i].tid))
                        return &libtrace->perpkt_threads[i];
        }
        return NULL;
}

int get_thread_table_num(libtrace_t *libtrace) {
        int i = 0;
        pthread_t tid = pthread_self();
        for (;i<libtrace->perpkt_thread_count; ++i) {
                if (pthread_equal(tid, libtrace->perpkt_threads[i].tid))
                        return i;
        }
        return -1;
}

static libtrace_thread_t * get_thread_descriptor(libtrace_t *libtrace) {
        libtrace_thread_t *ret;
        if (!(ret = get_thread_table(libtrace))) {
                pthread_t tid = pthread_self();
                // Check if we are reporter or something else
                if (pthread_equal(tid, libtrace->reporter_thread.tid))
                        ret = &libtrace->reporter_thread;
                else if (pthread_equal(tid, libtrace->hasher_thread.tid))
                        ret = &libtrace->hasher_thread;
                else
                        ret = NULL;
        }
        return ret;
}

/** Makes a packet safe, a packet may become invaild after a
 * pause (or stop/destroy) of a trace. This copies a packet
 * in such a way that it will be able to survive a pause.
 *
 * However this will not allow the packet to be used after
 * the format is destroyed. Or while the trace is still paused.
 */
DLLEXPORT void libtrace_make_packet_safe(libtrace_packet_t *pkt) {
        // Duplicate the packet in standard malloc'd memory and free the
        // original, This is a 1:1 exchange so is ocache count remains unchanged.
        if (pkt->buf_control != TRACE_CTRL_PACKET) {
                libtrace_packet_t *dup;
                dup = trace_copy_packet(pkt);
                /* Release the external buffer */
                trace_fin_packet(pkt);
                /* Copy the duplicated packet over the existing */
                memcpy(pkt, dup, sizeof(libtrace_packet_t));
        }
}

/**
 * Makes a libtrace_result_t safe, used when pausing a trace.
 * This will call libtrace_make_packet_safe if the result is
 * a packet.
 */
DLLEXPORT void libtrace_make_result_safe(libtrace_result_t *res) {
        if (res->type == RESULT_PACKET) {
                libtrace_make_packet_safe(res->value.pkt);
        }
}

/**
 * Holds threads in a paused state, until released by broadcasting
 * the condition mutex.
 */
static void trace_thread_pause(libtrace_t *trace, libtrace_thread_t *t) {
        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
        thread_change_state(trace, t, THREAD_PAUSED, false);
        while (trace->state == STATE_PAUSED || trace->state == STATE_PAUSING) {
                ASSERT_RET(pthread_cond_wait(&trace->perpkt_cond, &trace->libtrace_lock), == 0);
        }
        thread_change_state(trace, t, THREAD_RUNNING, false);
        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
}



/**
 * Dispatches packets to their correct place and applies any translations
 * as needed
 * @param trace
 * @param t
 * @param packet (in, out) this will be set to NULL if the user doesn't return the packet for reuse
 * @return -1 if an error or EOF has occured and the trace should end otherwise 0 to continue as normal
 */
static inline int dispatch_packets(libtrace_t *trace, libtrace_thread_t *t, libtrace_packet_t **packets,
                                   size_t nb_packets) {
        libtrace_message_t message;
        size_t i;
        for (i = 0; i < nb_packets; ++i) {
                if (packets[i]->error > 0) {
                        packets[i] = (*trace->per_pkt)(trace, packets[i], NULL, t);
                } else if (packets[i]->error == READ_TICK) {
                        message.code = MESSAGE_TICK;
                        message.additional.uint64 = trace_packet_get_order(packets[i]);
                        message.sender = t;
                        (*trace->per_pkt)(trace, NULL, &message, t);
                } else if (packets[i]->error != READ_MESSAGE) {
                        // An error this should be the last packet we read
                        size_t z;
                        // We could have an eof or error and a message such as pause
                        for (z = i ; z < nb_packets; ++z) {
                                fprintf(stderr, "i=%d nb_packet=%d err=%d\n", (int) z, (int) nb_packets, packets[z]->error);
                                assert (packets[z]->error <= 0);
                        }
                        return -1;
                }
                // -2 is a message its not worth checking now just finish this lot and we'll check
                // when we loop next
        }
        return 0;
}

/**
 * The is the entry point for our packet processing threads.
 */
static void* perpkt_threads_entry(void *data) {
        libtrace_t *trace = (libtrace_t *)data;
        libtrace_thread_t * t;
        libtrace_message_t message = {0};
        libtrace_packet_t *packets[trace->config.burst_size];
        size_t nb_packets;
        size_t i;

        memset(&packets, 0, sizeof(void*) * trace->config.burst_size);
        // Force this thread to wait until trace_pstart has been completed
        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
        t = get_thread_table(trace);
        assert(t);
        //printf("Yay Started perpkt thread #%d\n", (int) get_thread_table_num(trace));
        if (trace->format->pregister_thread) {
                trace->format->pregister_thread(trace, t, !trace_has_dedicated_hasher(trace));
        }
        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);

        /* ~~~~~~~~~~~ Setup complete now we loop ~~~~~~~~~~~~~~~ */
        // Send a message to say we've started

        // Let the per_packet function know we have started
        message.code = MESSAGE_STARTING;
        message.sender = t;
        (*trace->per_pkt)(trace, NULL, &message, t);
        message.code = MESSAGE_RESUMING;
        (*trace->per_pkt)(trace, NULL, &message, t);


        for (;;) {

                if (libtrace_message_queue_try_get(&t->messages, &message) != LIBTRACE_MQ_FAILED) {
                        switch (message.code) {
                                case MESSAGE_DO_PAUSE: // This is internal
                                        // Send message to say we are pausing, TODO consider sender
                                        message.code = MESSAGE_PAUSING;
                                        message.sender = t;
                                        (*trace->per_pkt)(trace, NULL, &message, t);
                                        // If a hasher thread is running empty input queues so we don't lose data
                                        if (trace_has_dedicated_hasher(trace)) {
                                                fprintf(stderr, "Trace is using a hasher thread emptying queues\n");
                                                // The hasher has stopped by this point, so the queue shouldn't be filling
                                                while(!libtrace_ringbuffer_is_empty(&t->rbuffer)) {
                                                        ASSERT_RET(trace_pread_packet(trace, t, packets, 1), == 1);
                                                        if (dispatch_packets(trace, t, packets, 1) == -1) {
                                                                // EOF or error, either way we'll stop
                                                                while (!libtrace_ringbuffer_is_empty(&t->rbuffer)) {
                                                                        ASSERT_RET(trace_pread_packet(trace, t, packets, 1), == 1);
                                                                        // No packets after this should have any data in them
                                                                        assert(packets[0]->error <= 0);
                                                                }
                                                                goto stop;
                                                        }
                                                }
                                        }
                                        // Now we do the actual pause, this returns when we are done
                                        trace_thread_pause(trace, t);
                                        message.code = MESSAGE_RESUMING;
                                        (*trace->per_pkt)(trace, NULL, &message, t);
                                        // Check for new messages as soon as we return
                                        continue;
                                case MESSAGE_DO_STOP: // This is internal
                                        goto stop;
                        }
                        (*trace->per_pkt)(trace, NULL, &message, t);
                        continue;
                }

                if (trace->perpkt_thread_count == 1) {
                        if (!packets[0]) {
                                libtrace_ocache_alloc(&trace->packet_freelist, (void **) &packets[0], 1, 1);
                        }
                        assert(packets[0]);
                        packets[0]->error = trace_read_packet(trace, packets[0]);
                        nb_packets = 1;
                } else {
                        nb_packets = trace_pread_packet(trace, t, packets, trace->config.burst_size);
                }
                // Loop through the packets we just read
                if (dispatch_packets(trace, t, packets, nb_packets) == -1)
                        break;
        }


stop:
        /* ~~~~~~~~~~~~~~ Trace is finished do tear down ~~~~~~~~~~~~~~~~~~~~~ */

        // Let the per_packet function know we have stopped
        message.code = MESSAGE_PAUSING;
        message.sender = t;
        (*trace->per_pkt)(trace, NULL, &message, t);
        message.code = MESSAGE_STOPPING;
        message.additional.uint64 = 0;
        (*trace->per_pkt)(trace, NULL, &message, t);

        // Free any remaining packets
        for (i = 0; i < trace->config.burst_size; i++) {
                if (packets[i]) {
                        libtrace_ocache_free(&trace->packet_freelist, (void **) &packets[i], 1, 1);
                        packets[i] = NULL;
                }
        }

        
        thread_change_state(trace, t, THREAD_FINISHED, true);

        // Notify only after we've defiantly set the state to finished
        message.code = MESSAGE_PERPKT_ENDED;
        message.additional.uint64 = 0;
        trace_send_message_to_reporter(trace, &message);

        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
        if (trace->format->punregister_thread) {
                trace->format->punregister_thread(trace, t);
        }
        print_memory_stats();

        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);

        pthread_exit(NULL);
};

/**
 * The start point for our single threaded hasher thread, this will read
 * and hash a packet from a data source and queue it against the correct
 * core to process it.
 */
static void* hasher_entry(void *data) {
        libtrace_t *trace = (libtrace_t *)data;
        libtrace_thread_t * t;
        int i;
        libtrace_packet_t * packet;
        libtrace_message_t message = {0};

        assert(trace_has_dedicated_hasher(trace));
        /* Wait until all threads are started and objects are initialised (ring buffers) */
        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
        t = &trace->hasher_thread;
        assert(t->type == THREAD_HASHER && pthread_equal(pthread_self(), t->tid));
        printf("Hasher Thread started\n");
        if (trace->format->pregister_thread) {
                trace->format->pregister_thread(trace, t, true);
        }
        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
        int pkt_skipped = 0;
        /* Read all packets in then hash and queue against the correct thread */
        while (1) {
                int thread;
                if (!pkt_skipped)
                        libtrace_ocache_alloc(&trace->packet_freelist, (void **) &packet, 1, 1);
                assert(packet);

                if (libtrace_halt) // Signal to die has been sent - TODO
                        break;

                // Check for messages that we expect MESSAGE_DO_PAUSE, (internal messages only)
                if (libtrace_message_queue_try_get(&t->messages, &message) != LIBTRACE_MQ_FAILED) {
                        switch(message.code) {
                                case MESSAGE_DO_PAUSE:
                                        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
                                        thread_change_state(trace, t, THREAD_PAUSED, false);
                                        pthread_cond_broadcast(&trace->perpkt_cond);
                                        while (trace->state == STATE_PAUSED || trace->state == STATE_PAUSING) {
                                                ASSERT_RET(pthread_cond_wait(&trace->perpkt_cond, &trace->libtrace_lock), == 0);
                                        }
                                        thread_change_state(trace, t, THREAD_RUNNING, false);
                                        pthread_cond_broadcast(&trace->perpkt_cond);
                                        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
                                        break;
                                case MESSAGE_DO_STOP:
                                        // Stop called after pause
                                        assert(trace->started == false);
                                        assert(trace->state == STATE_FINSHED);
                                        break;
                                default:
                                        fprintf(stderr, "Hasher thread didn't expect message code=%d\n", message.code);
                        }
                        pkt_skipped = 1;
                        continue;
                }

                if ((packet->error = trace_read_packet(trace, packet)) <1 /*&& psize != LIBTRACE_MESSAGE_WAITING*/) {
                        break; /* We are EOF or error'd either way we stop  */
                }

                /* We are guaranteed to have a hash function i.e. != NULL */
                trace_packet_set_hash(packet, (*trace->hasher)(packet, trace->hasher_data));
                thread = trace_packet_get_hash(packet) % trace->perpkt_thread_count;
                /* Blocking write to the correct queue - I'm the only writer */
                if (trace->perpkt_threads[thread].state != THREAD_FINISHED) {
                        uint64_t order = trace_packet_get_order(packet);
                        libtrace_ringbuffer_write(&trace->perpkt_threads[thread].rbuffer, packet);
                        if (trace->config.tick_count && order % trace->config.tick_count == 0) {
                                // Write ticks to everyone else
                                libtrace_packet_t * pkts[trace->perpkt_thread_count];
                                memset(pkts, 0, sizeof(void *) * trace->perpkt_thread_count);
                                libtrace_ocache_alloc(&trace->packet_freelist, (void **) pkts, trace->perpkt_thread_count, trace->perpkt_thread_count);
                                for (i = 0; i < trace->perpkt_thread_count; i++) {
                                        pkts[i]->error = READ_TICK;
                                        trace_packet_set_order(pkts[i], order);
                                        libtrace_ringbuffer_write(&trace->perpkt_threads[i].rbuffer, pkts[i]);
                                }
                        }
                        pkt_skipped = 0;
                } else {
                        assert(!"Dropping a packet!!");
                        pkt_skipped = 1; // Reuse that packet no one read it
                }
        }

        /* Broadcast our last failed read to all threads */
        for (i = 0; i < trace->perpkt_thread_count; i++) {
                libtrace_packet_t * bcast;
                fprintf(stderr, "Broadcasting error/EOF now the trace is over\n");
                if (i == trace->perpkt_thread_count - 1) {
                        bcast = packet;
                } else {
                        libtrace_ocache_alloc(&trace->packet_freelist, (void **) &bcast, 1, 1);
                        bcast->error = packet->error;
                }
                ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
                if (trace->perpkt_threads[i].state != THREAD_FINISHED) {
                        // Unlock early otherwise we could deadlock
                        libtrace_ringbuffer_write(&trace->perpkt_threads[i].rbuffer, bcast);
                        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
                } else {
                        fprintf(stderr, "SKIPPING THREAD !!!%d!!!/n", (int) i);
                        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);
                }
        }

        // We don't need to free the packet
        thread_change_state(trace, t, THREAD_FINISHED, true);

        // Notify only after we've defiantly set the state to finished
        message.code = MESSAGE_PERPKT_ENDED;
        message.additional.uint64 = 0;
        trace_send_message_to_reporter(trace, &message);
        ASSERT_RET(pthread_mutex_lock(&trace->libtrace_lock), == 0);
        if (trace->format->punregister_thread) {
                trace->format->punregister_thread(trace, t);
        }
        print_memory_stats();
        ASSERT_RET(pthread_mutex_unlock(&trace->libtrace_lock), == 0);

        // TODO remove from TTABLE t sometime
        pthread_exit(NULL);
};

/**
 * Moves src into dest(Complete copy) and copies the memory buffer and
 * its flags from dest into src ready for reuse without needing extra mallocs.
 */
static inline void swap_packets(libtrace_packet_t *dest, libtrace_packet_t *src) {
        // Save the passed in buffer status
        assert(dest->trace == NULL); // Must be a empty packet
        void * temp_buf = dest->buffer;
        buf_control_t temp_buf_control = dest->buf_control;
        // Completely copy StoredPacket into packet
        memcpy(dest, src, sizeof(libtrace_packet_t));
        // Set the buffer settings on the returned packet
        src->buffer = temp_buf;
        src->buf_control = temp_buf_control;
        src->trace = NULL;
}

/**
 * @brief Move NULLs to the end of an array.
 * @param values
 * @param len
 * @return The location the first NULL, aka the number of non NULL elements
 */
static inline size_t move_nulls_back(void *arr[], size_t len) {
        size_t fr=0, en = len-1;
        // Shift all non NULL elements to the front of the array, and NULLs to the
        // end, traverses every element at most once
        for (;fr < en; ++fr) {
                if (arr[fr] == NULL) {
                        for (;en > fr; --en) {
                                if(arr[en]) {
                                        arr[fr] = arr[en];
                                        arr[en] = NULL;
                                        break;
                                }
                        }
                }
        }
        // This is the index of the first NULL
        en = MIN(fr, en);
        // Or the end of the array if this special case
        if (arr[en])
                en++;
        return en;
}

/** returns the number of packets successfully allocated in the final array
 these will all be at the front of the array */
inline static size_t fill_array_with_empty_packets(libtrace_t *libtrace, libtrace_packet_t *packets[], size_t nb_packets) {
        size_t nb;
        nb = move_nulls_back((void **) packets, nb_packets);
        mem_hits.read.recycled += nb;
        nb += libtrace_ocache_alloc(&libtrace->packet_freelist, (void **) &packets[nb], nb_packets - nb, nb_packets - nb);
        assert(nb_packets == nb);
        return nb;
}


inline static size_t empty_array_of_packets(libtrace_t *libtrace, libtrace_packet_t *packets[], size_t nb_packets) {
        size_t nb;
        nb = move_nulls_back((void **) packets, nb_packets);
        mem_hits.write.recycled += nb_packets - nb;
        nb += nb_packets - libtrace_ocache_free(&libtrace->packet_freelist, (void **)packets, nb, nb);
        memset(packets, 0, nb); // XXX make better, maybe do this in ocache??
        return nb;
}

/* Our simplest case when a thread becomes ready it can obtain an exclusive
 * lock to read packets from the underlying trace.
 */
inline static size_t trace_pread_packet_first_in_first_served(libtrace_t *libtrace, libtrace_thread_t *t, libtrace_packet_t *packets[], size_t nb_packets)
{
        size_t i = 0;
        bool tick_hit = false;

        nb_packets = fill_array_with_empty_packets(libtrace, packets, nb_packets);

        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
        /* Read nb_packets */
        for (i = 0; i < nb_packets; ++i) {
                packets[i]->error = trace_read_packet(libtrace, packets[i]);
                if (packets[i]->error <= 0) {
                        ++i;
                        break;
                }
                /*
                if (libtrace->config.tick_count && trace_packet_get_order(packets[i]) % libtrace->config.tick_count == 0) {
                        tick_hit = true;
                }*/
        }
        // Doing this inside the lock ensures the first packet is always
        // recorded first
        if (packets[0]->error > 0) {
                store_first_packet(libtrace, packets[0], t);
        }
        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
        /* XXX TODO this needs to be inband with packets, or we don't bother in this case
        if (tick_hit) {
                libtrace_message_t tick;
                tick.additional.uint64 = trace_packet_get_order(packets[i]);
                tick.code = MESSAGE_TICK;
                trace_send_message_to_perpkts(libtrace, &tick);
        } */
        return i;
}

/**
 * For the case that we have a dedicated hasher thread
 * 1. We read a packet from our buffer
 * 2. Move that into the packet provided (packet)
 */
inline static size_t trace_pread_packet_hasher_thread(libtrace_t *libtrace, libtrace_thread_t *t, libtrace_packet_t **packets, size_t nb_packets)
{
        size_t i;

        // Always grab at least one
        if (packets[0]) // Recycle the old get the new
                libtrace_ocache_free(&libtrace->packet_freelist, (void **) packets, 1, 1);
        packets[0] = libtrace_ringbuffer_read(&t->rbuffer);

        if (packets[0]->error < 0)
                return 1;

        for (i = 1; i < nb_packets; i++) {
                if (packets[i]) // Recycle the old get the new
                        libtrace_ocache_free(&libtrace->packet_freelist, (void **) &packets[i], 1, 1);
                if (!libtrace_ringbuffer_try_read(&t->rbuffer, (void **) &packets[i])) {
                        packets[i] = NULL;
                        break;
                }
                // These are typically urgent
                if (packets[i]->error < 0)
                        break;
        }
        
        return i;
}

/**
 * Tries to read from our queue and returns 1 if a packet was retrieved
 */
static inline int try_waiting_queue(libtrace_t *libtrace, libtrace_thread_t * t, libtrace_packet_t **packet, int * ret)
{
        libtrace_packet_t* retrived_packet;

        /* Lets see if we have one waiting */
        if (libtrace_ringbuffer_try_read(&t->rbuffer, (void **) &retrived_packet)) {
                /* Copy paste from trace_pread_packet_hasher_thread() except that we try read (non-blocking) */
                assert(retrived_packet);

                if (*packet) // Recycle the old get the new
                        libtrace_ocache_free(&libtrace->packet_freelist, (void **) packet, 1, 1);
                *packet = retrived_packet;
                *ret = (*packet)->error;
                return 1;
        }
        return 0;
}

/**
 * Allows us to ensure all threads are finished writing to our threads ring_buffer
 * before returning EOF/error.
 */
inline static int trace_handle_finishing_perpkt(libtrace_t *libtrace, libtrace_packet_t **packet, libtrace_thread_t * t)
{
        /* We are waiting for the condition that another thread ends to check
         * our queue for new data, once all threads end we can go to finished */
        bool complete = false;
        int ret;

        do {
                // Wait for a thread to end
                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);

                // Check before
                if (libtrace->perpkt_thread_states[THREAD_FINISHING] == libtrace->perpkt_thread_count) {
                        complete = true;
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        continue;
                }

                ASSERT_RET(pthread_cond_wait(&libtrace->perpkt_cond, &libtrace->libtrace_lock), == 0);

                // Check after
                if (libtrace->perpkt_thread_states[THREAD_FINISHING] == libtrace->perpkt_thread_count) {
                        complete = true;
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        continue;
                }

                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);

                // Always trying to keep our buffer empty for the unlikely case more threads than buffer space want to write into our queue
                if(try_waiting_queue(libtrace, t, packet, &ret))
                        return ret;
        } while (!complete);

        // We can only end up here once all threads complete
        try_waiting_queue(libtrace, t, packet, &ret);

        return ret;
        // TODO rethink this logic fix bug here
}

/**
 * Expects the libtrace_lock to not be held
 */
inline static int trace_finish_perpkt(libtrace_t *libtrace, libtrace_packet_t **packet, libtrace_thread_t * t)
{
        thread_change_state(libtrace, t, THREAD_FINISHING, true);
        return trace_handle_finishing_perpkt(libtrace, packet, t);
}

/**
 * This case is much like the dedicated hasher, except that we will become
 * hasher if we don't have a a packet waiting.
 *
 * Note: This is only every used if we have are doing hashing.
 *
 * TODO: Can block on zero copy formats such as ring: and dpdk: if the
 * queue sizes in total are larger than the ring size.
 *
 * 1. We read a packet from our buffer
 * 2. Move that into the packet provided (packet)
 */
inline static int trace_pread_packet_hash_locked(libtrace_t *libtrace, libtrace_thread_t *t, libtrace_packet_t **packet)
{
        int thread, ret/*, psize*/;

        while (1) {
                if(try_waiting_queue(libtrace, t, packet, &ret))
                        return ret;
                // Can still block here if another thread is writing to a full queue
                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);

                // Its impossible for our own queue to overfill, because no one can write
                // when we are in the lock
                if(try_waiting_queue(libtrace, t, packet, &ret)) {
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        return ret;
                }

                // Another thread cannot write a packet because a queue has filled up. Is it ours?
                if (libtrace->perpkt_queue_full) {
                        contention_stats[t->perpkt_num].wait_for_fill_complete_hits++;
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        continue;
                }

                if (!*packet)
                        libtrace_ocache_alloc(&libtrace->packet_freelist, (void **) packet, 1, 1);
                assert(*packet);

                // If we fail here we can guarantee that our queue is empty (and no new data will be added because we hold the lock)
                if (libtrace_halt || ((*packet)->error = trace_read_packet(libtrace, *packet)) <1 /*&& psize != LIBTRACE_MESSAGE_WAITING*/) {
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        if (libtrace_halt)
                                return 0;
                        else
                                return (*packet)->error;
                }

                trace_packet_set_hash(*packet, (*libtrace->hasher)(*packet, libtrace->hasher_data));
                thread = trace_packet_get_hash(*packet) % libtrace->perpkt_thread_count;
                if (thread == t->perpkt_num) {
                        // If it's this thread we must be in order because we checked the buffer once we got the lock
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        return (*packet)->error;
                }

                if (libtrace->perpkt_threads[thread].state != THREAD_FINISHED) {
                        while (!libtrace_ringbuffer_try_swrite_bl(&libtrace->perpkt_threads[thread].rbuffer, *packet)) {
                                libtrace->perpkt_queue_full = true;
                                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                                contention_stats[t->perpkt_num].full_queue_hits++;
                                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
                        }
                        *packet = NULL;
                        libtrace->perpkt_queue_full = false;
                } else {
                        /* We can get here if the user closes the thread before natural completion/or error */
                        assert (!"packet_hash_locked() The user terminated the trace in a abnormal manner");
                }
                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
        }
}

/**
 * This case is much like the dedicated hasher, except that we will become
 * hasher if we don't have a packet waiting.
 *
 * TODO: You can lose the tail of a trace if the final thread
 * fills its own queue and therefore breaks early and doesn't empty the sliding window.
 *
 * TODO: Can block on zero copy formats such as ring: and dpdk: if the
 * queue sizes in total are larger than the ring size.
 *
 * 1. We read a packet from our buffer
 * 2. Move that into the packet provided (packet)
 */
inline static int trace_pread_packet_sliding_window(libtrace_t *libtrace, libtrace_thread_t *t, libtrace_packet_t **packet)
{
        int ret, i, thread/*, psize*/;

        if (t->state == THREAD_FINISHING)
                return trace_handle_finishing_perpkt(libtrace, packet, t);

        while (1) {
                // Check if we have packets ready
                if(try_waiting_queue(libtrace, t, packet, &ret))
                        return ret;

                // We limit the number of packets we get to the size of the sliding window
                // such that it is impossible for any given thread to fail to store a packet
                ASSERT_RET(sem_wait(&libtrace->sem), == 0);
                /*~~~~Single threaded read of a packet~~~~*/
                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);

                /* Re-check our queue things we might have data waiting */
                if(try_waiting_queue(libtrace, t, packet, &ret)) {
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        ASSERT_RET(sem_post(&libtrace->sem), == 0);
                        return ret;
                }

                // TODO put on *proper* condition variable
                if (libtrace->perpkt_queue_full) {
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        ASSERT_RET(sem_post(&libtrace->sem), == 0);
                        contention_stats[t->perpkt_num].wait_for_fill_complete_hits++;
                        continue;
                }

                if (!*packet)
                        libtrace_ocache_alloc(&libtrace->packet_freelist, (void **) packet, 1, 1);
                assert(*packet);

                if (libtrace_halt || ((*packet)->error = trace_read_packet(libtrace, *packet)) <1 /*&& psize != LIBTRACE_MESSAGE_WAITING*/) {
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        ASSERT_RET(sem_post(&libtrace->sem), == 0);
                        // Finish this thread ensuring that any data written later by another thread is retrieved also
                        if (libtrace_halt)
                                return 0;
                        else
                                return trace_finish_perpkt(libtrace, packet, t);
                }
                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);

                /* ~~~~Multiple threads can run the hasher~~~~ */
                trace_packet_set_hash(*packet, (*libtrace->hasher)(*packet, libtrace->hasher_data));

                /* Yes this is correct opposite read lock for a write operation */
                ASSERT_RET(pthread_rwlock_rdlock(&libtrace->window_lock), == 0);
                if (!libtrace_slidingwindow_try_write(&libtrace->sliding_window, trace_packet_get_order(*packet), *packet))
                        assert(!"Semaphore should stop us from ever overfilling the sliding window");
                ASSERT_RET(pthread_rwlock_unlock(&libtrace->window_lock), == 0);
                *packet = NULL;

                // Always try read any data from the sliding window
                while (libtrace_slidingwindow_read_ready(&libtrace->sliding_window)) {
                        ASSERT_RET(pthread_rwlock_wrlock(&libtrace->window_lock), == 0);
                        if (libtrace->perpkt_queue_full) {
                                // I might be the holdup in which case if I can read my queue I should do that and return
                                if(try_waiting_queue(libtrace, t, packet, &ret)) {
                                        ASSERT_RET(pthread_rwlock_unlock(&libtrace->window_lock), == 0);
                                        return ret;
                                }
                                ASSERT_RET(pthread_rwlock_unlock(&libtrace->window_lock), == 0);
                                continue;
                        }
                        // Read greedily as many as we can
                        while (libtrace_slidingwindow_try_read(&libtrace->sliding_window, (void **) packet, NULL)) {
                                thread = trace_packet_get_hash(*packet) % libtrace->perpkt_thread_count;
                                if (libtrace->perpkt_threads[thread].state != THREAD_FINISHED) {
                                        while (!libtrace_ringbuffer_try_swrite_bl(&libtrace->perpkt_threads[thread].rbuffer, *packet)) {
                                                if (t->perpkt_num == thread)
                                                {
                                                        // TODO think about this case more because we have to stop early if this were to happen on the last read
                                                        // before EOF/error we might not have emptied the sliding window
                                                        printf("!~!~!~!~!~!~In this Code~!~!~!~!\n");
                                                        // Its our queue we must have a packet to read out
                                                        if(try_waiting_queue(libtrace, t, packet, &ret)) {
                                                                // We must be able to write this now 100% without fail
                                                                libtrace_ringbuffer_write(&libtrace->perpkt_threads[thread].rbuffer, *packet);
                                                                ASSERT_RET(sem_post(&libtrace->sem), == 0);
                                                                ASSERT_RET(pthread_rwlock_unlock(&libtrace->window_lock), == 0);
                                                                return ret;
                                                        } else {
                                                                assert(!"Our queue is full but I cannot read from it??");
                                                        }
                                                }
                                                // Not us we have to give the other threads a chance to write there packets then
                                                libtrace->perpkt_queue_full = true;
                                                ASSERT_RET(pthread_rwlock_unlock(&libtrace->window_lock), == 0);
                                                for (i = 0; i < libtrace->perpkt_thread_count-1; i++) // Release all other threads to read there packets
                                                        ASSERT_RET(sem_post(&libtrace->sem), == 0);

                                                contention_stats[t->perpkt_num].full_queue_hits++;
                                                ASSERT_RET(pthread_rwlock_wrlock(&libtrace->window_lock), == 0);
                                                // Grab these back
                                                for (i = 0; i < libtrace->perpkt_thread_count-1; i++) // Release all other threads to read there packets
                                                        ASSERT_RET(sem_wait(&libtrace->sem), == 0);
                                                libtrace->perpkt_queue_full = false;
                                        }
                                        ASSERT_RET(sem_post(&libtrace->sem), == 0);
                                        *packet = NULL;
                                } else {
                                        // Cannot write to a queue if no ones waiting (I think this is unreachable)
                                        // in the general case (unless the user ends early without proper clean up).
                                        assert (!"unreachable code??");
                                }
                        }
                        ASSERT_RET(pthread_rwlock_unlock(&libtrace->window_lock), == 0);
                }
                // Now we go back to checking our queue anyways
        }
}


/**
 * For the first packet of each queue we keep a copy and note the system
 * time it was received at.
 *
 * This is used for finding the first packet when playing back a trace
 * in trace time. And can be used by real time applications to print
 * results out every XXX seconds.
 */
void store_first_packet(libtrace_t *libtrace, libtrace_packet_t *packet, libtrace_thread_t *t)
{
        if (!t->recorded_first) {
                struct timeval tv;
                libtrace_packet_t * dup;
                // For what it's worth we can call these outside of the lock
                gettimeofday(&tv, NULL);
                dup = trace_copy_packet(packet);
                ASSERT_RET(pthread_spin_lock(&libtrace->first_packets.lock), == 0);
                libtrace->first_packets.packets[t->perpkt_num].packet = dup;
                //printf("Stored first packet time=%f\n", trace_get_seconds(dup));
                memcpy(&libtrace->first_packets.packets[t->perpkt_num].tv, &tv, sizeof(tv));
                // Now update the first
                libtrace->first_packets.count++;
                if (libtrace->first_packets.count == 1) {
                        // We the first entry hence also the first known packet
                        libtrace->first_packets.first = t->perpkt_num;
                } else {
                        // Check if we are newer than the previous 'first' packet
                        size_t first = libtrace->first_packets.first;
                        if (trace_get_seconds(dup) <
                                trace_get_seconds(libtrace->first_packets.packets[first].packet))
                                libtrace->first_packets.first = t->perpkt_num;
                }
                ASSERT_RET(pthread_spin_unlock(&libtrace->first_packets.lock), == 0);
                libtrace_message_t mesg = {0};
                mesg.code = MESSAGE_FIRST_PACKET;
                trace_send_message_to_reporter(libtrace, &mesg);
                t->recorded_first = true;
        }
}

/**
 * Returns 1 if it's certain that the first packet is truly the first packet
 * rather than a best guess based upon threads that have published so far.
 * Otherwise 0 is returned.
 * It's recommended that this result is stored rather than calling this
 * function again.
 */
DLLEXPORT int retrive_first_packet(libtrace_t *libtrace, libtrace_packet_t **packet, struct timeval **tv)
{
        int ret = 0;
        ASSERT_RET(pthread_spin_lock(&libtrace->first_packets.lock), == 0);
        if (libtrace->first_packets.count) {
                *packet = libtrace->first_packets.packets[libtrace->first_packets.first].packet;
                *tv = &libtrace->first_packets.packets[libtrace->first_packets.first].tv;
                if (libtrace->first_packets.count == (size_t) libtrace->perpkt_thread_count) {
                        ret = 1;
                } else {
                        struct timeval curr_tv;
                        // If a second has passed since the first entry we will assume this is the very first packet
                        gettimeofday(&curr_tv, NULL);
                        if (curr_tv.tv_sec > (*tv)->tv_sec) {
                                if(curr_tv.tv_usec > (*tv)->tv_usec || curr_tv.tv_sec - (*tv)->tv_sec > 1) {
                                        ret = 1;
                                }
                        }
                }
        } else {
                *packet = NULL;
                *tv = NULL;
        }
        ASSERT_RET(pthread_spin_unlock(&libtrace->first_packets.lock), == 0);
        return ret;
}


DLLEXPORT uint64_t tv_to_usec(struct timeval *tv)
{
        return (uint64_t) tv->tv_sec*1000000ull + (uint64_t) tv->tv_usec;
}

inline static struct timeval usec_to_tv(uint64_t usec)
{
        struct timeval tv;
        tv.tv_sec = usec / 1000000;
        tv.tv_usec = usec % 1000000;
        return tv;
}

/** Similar to delay_tracetime but send messages to all threads periodically */
static void* reporter_entry(void *data) {
        libtrace_message_t message = {0};
        libtrace_t *trace = (libtrace_t *)data;
        libtrace_thread_t *t = &trace->reporter_thread;
        libtrace_vector_t results;
        libtrace_vector_init(&results, sizeof(libtrace_result_t));
        fprintf(stderr, "Reporter thread starting\n");

        message.code = MESSAGE_STARTING;
        message.sender = t;
        (*trace->reporter)(trace, NULL, &message);
        message.code = MESSAGE_RESUMING;
        (*trace->reporter)(trace, NULL, &message);

        while (!trace_finished(trace)) {
                if (trace->config.reporter_polling) {
                        if (libtrace_message_queue_try_get(&t->messages, &message) == LIBTRACE_MQ_FAILED)
                                message.code = MESSAGE_POST_REPORTER;
                } else {
                        libtrace_message_queue_get(&t->messages, &message);
                }
                switch (message.code) {
                        // Check for results
                        case MESSAGE_POST_REPORTER:
                                trace->combiner.read(trace, &trace->combiner);
                                break;
                        case MESSAGE_DO_PAUSE:
                                assert(trace->combiner.pause);
                                trace->combiner.pause(trace, &trace->combiner);
                                message.code = MESSAGE_PAUSING;
                                message.sender = t;
                                (*trace->reporter)(trace, NULL, &message);
                                trace_thread_pause(trace, t);
                                message.code = MESSAGE_RESUMING;
                                (*trace->reporter)(trace, NULL, &message);
                                break;
                        default:
                                (*trace->reporter)(trace, NULL, &message);
                }
        }

        // Flush out whats left now all our threads have finished
        trace->combiner.read_final(trace, &trace->combiner);

        // GOODBYE
        message.code = MESSAGE_PAUSING;
        message.sender = t;
        (*trace->reporter)(trace, NULL, &message);
        message.code = MESSAGE_STOPPING;
        (*trace->reporter)(trace, NULL, &message);

        thread_change_state(trace, &trace->reporter_thread, THREAD_FINISHED, true);
        print_memory_stats();
        return NULL;
}

/** Similar to delay_tracetime but send messages to all threads periodically */
static void* keepalive_entry(void *data) {
        struct timeval prev, next;
        libtrace_message_t message = {0};
        libtrace_t *trace = (libtrace_t *)data;
        uint64_t next_release;
        fprintf(stderr, "keepalive thread is starting\n");

        gettimeofday(&prev, NULL);
        message.code = MESSAGE_TICK;
        while (trace->state != STATE_FINSHED) {
                fd_set rfds;
                next_release = tv_to_usec(&prev) + (trace->config.tick_interval * 1000);
                gettimeofday(&next, NULL);
                if (next_release > tv_to_usec(&next)) {
                        next = usec_to_tv(next_release - tv_to_usec(&next));
                        // Wait for timeout or a message
                        FD_ZERO(&rfds);
                FD_SET(libtrace_message_queue_get_fd(&trace->keepalive_thread.messages), &rfds);
                        if (select(libtrace_message_queue_get_fd(&trace->keepalive_thread.messages)+1, &rfds, NULL, NULL, &next) == 1) {
                                libtrace_message_t msg;
                                libtrace_message_queue_get(&trace->keepalive_thread.messages, &msg);
                                assert(msg.code == MESSAGE_DO_STOP);
                                goto done;
                        }
                }
                prev = usec_to_tv(next_release);
                if (trace->state == STATE_RUNNING) {
                        message.additional.uint64 = tv_to_usec(&prev);
                        trace_send_message_to_perpkts(trace, &message);
                }
        }
done:

        thread_change_state(trace, &trace->keepalive_thread, THREAD_FINISHED, true);
        return NULL;
}

/**
 * Delays a packets playback so the playback will be in trace time
 */
static inline void delay_tracetime(libtrace_t *libtrace, libtrace_packet_t *packet, libtrace_thread_t *t) {
        struct timeval curr_tv, pkt_tv;
        uint64_t next_release = t->tracetime_offset_usec; // Time at which to release the packet
        uint64_t curr_usec;
        /* Tracetime we might delay releasing this packet */
        if (!t->tracetime_offset_usec) {
                libtrace_packet_t * first_pkt;
                struct timeval *sys_tv;
                int64_t initial_offset;
                int stable = retrive_first_packet(libtrace, &first_pkt, &sys_tv);
                assert(first_pkt);
                pkt_tv = trace_get_timeval(first_pkt);
                initial_offset = (int64_t)tv_to_usec(sys_tv) - (int64_t)tv_to_usec(&pkt_tv);
                if (stable)
                        // 0->1 because 0 is used to mean unset
                        t->tracetime_offset_usec = initial_offset ? initial_offset: 1;
                next_release = initial_offset;
        }
        /* next_release == offset */
        pkt_tv = trace_get_timeval(packet);
        next_release += tv_to_usec(&pkt_tv);
        gettimeofday(&curr_tv, NULL);
        curr_usec = tv_to_usec(&curr_tv);
        if (next_release > curr_usec) {
                // We need to wait
                struct timeval delay_tv = usec_to_tv(next_release-curr_usec);
                //printf("WAITING for %d.%d next=%"PRIu64" curr=%"PRIu64" seconds packettime %f\n", delay_tv.tv_sec, delay_tv.tv_usec, next_release, curr_usec, trace_get_seconds(packet));
                select(0, NULL, NULL, NULL, &delay_tv);
        }
}

/* Read one packet from the trace into a buffer. Note that this function will
 * block until a packet is read (or EOF is reached).
 *
 * @param libtrace      the libtrace opaque pointer
 * @param packet        the packet opaque pointer
 * @returns 0 on EOF, negative value on error
 *
 * Note this is identical to read_packet but calls pread_packet instead of
 * read packet in the format.
 *
 */
static inline int trace_pread_packet_wrapper(libtrace_t *libtrace, libtrace_thread_t *t, libtrace_packet_t *packet) {

        assert(libtrace && "You called trace_read_packet() with a NULL libtrace parameter!\n");
        if (trace_is_err(libtrace))
                return -1;
        if (!libtrace->started) {
                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"You must call libtrace_start() before trace_read_packet()\n");
                return -1;
        }
        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid\n");
                return -1;
        }
        assert(packet);

        if (libtrace->format->read_packet) {
                do {
                        size_t ret;
                        /* Finalise the packet, freeing any resources the format module
                         * may have allocated it and zeroing all data associated with it.
                         */
                        trace_fin_packet(packet);
                        /* Store the trace we are reading from into the packet opaque
                         * structure */
                        packet->trace = libtrace;
                        ret=libtrace->format->pread_packet(libtrace, t, packet);
                        if (ret <= 0) {
                                return ret;
                        }
                        if (libtrace->filter) {
                                /* If the filter doesn't match, read another
                                 * packet
                                 */
                                if (!trace_apply_filter(libtrace->filter,packet)){
                                        ++libtrace->filtered_packets;
                                        continue;
                                }
                        }
                        if (libtrace->snaplen>0) {
                                /* Snap the packet */
                                trace_set_capture_length(packet,
                                                libtrace->snaplen);
                        }
                        
                        ++t->accepted_packets;
                        // TODO look into this better
                        trace_packet_set_order(packet, trace_get_erf_timestamp(packet));
                        //trace_packet_set_order(packet, libtrace->accepted_packets);
                        //++libtrace->accepted_packets;
                        return ret;
                } while(1);
        }
        trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,"This format does not support reading packets\n");
        return ~0U;
}

/**
 * Read packets from the parallel trace
 * @return the number of packets read, null packets indicate messages. Check packet->error before
 * assuming a packet is valid.
 */
static size_t trace_pread_packet(libtrace_t *libtrace, libtrace_thread_t *t, libtrace_packet_t *packets[], size_t nb_packets)
{
        size_t ret;
        size_t i;
        assert(nb_packets);

        for (i = 0; i < nb_packets; i++) {
                // Cleanup the packet passed back
                if (packets[i])
                        trace_fin_packet(packets[i]);
        }

        if (trace_supports_parallel(libtrace) && !trace_has_dedicated_hasher(libtrace)) {
                if (!packets[0])
                        libtrace_ocache_alloc(&libtrace->packet_freelist, (void **)packets, 1, 1);
                packets[0]->error = trace_pread_packet_wrapper(libtrace, t, *packets);
                ret = 1;
        } else if (trace_has_dedicated_hasher(libtrace)) {
                ret = trace_pread_packet_hasher_thread(libtrace, t, packets, nb_packets);
        } else if (!trace_has_dedicated_hasher(libtrace)) {
                /* We don't care about which core a packet goes to */
                ret = trace_pread_packet_first_in_first_served(libtrace, t, packets, nb_packets);
        } /* else {
                ret = trace_pread_packet_hash_locked(libtrace, packet);
        }*/

        // Formats can also optionally do this internally to ensure the first
        // packet is always reported correctly
        assert(ret);
        assert(ret <= nb_packets);
        if (packets[0]->error > 0) {
                store_first_packet(libtrace, packets[0], t);
                if (libtrace->tracetime)
                        delay_tracetime(libtrace, packets[0], t);
        }

        return ret;
}

/* Starts perpkt threads
 * @return threads_started
 */
static inline int trace_start_perpkt_threads (libtrace_t *libtrace) {
        int i;
        char name[16];
        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
                libtrace_thread_t *t = &libtrace->perpkt_threads[i];
                ASSERT_RET(pthread_create(&t->tid, NULL, perpkt_threads_entry, (void *) libtrace), == 0);
                snprintf(name, 16, "perpkt-%d", i);
                pthread_setname_np(t->tid, name);
        }
        return libtrace->perpkt_thread_count;
}

/* Start an input trace in a parallel fashion, or restart a paused trace.
 *
 * NOTE: libtrace lock is held for the majority of this function
 *
 * @param libtrace the input trace to start
 * @param global_blob some global data you can share with the new perpkt threads
 * @returns 0 on success
 */
DLLEXPORT int trace_pstart(libtrace_t *libtrace, void* global_blob, fn_per_pkt per_pkt, fn_reporter reporter)
{
        int i;
        char name[16];
        sigset_t sig_before, sig_block_all;
        assert(libtrace);
        if (trace_is_err(libtrace)) {
                return -1;
        }
        
        // NOTE: Until the trace is started we wont have a libtrace_lock initialised
        if (libtrace->state != STATE_NEW) {
                int err = 0;
                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
                if (libtrace->state != STATE_PAUSED) {
                        trace_set_err(libtrace, TRACE_ERR_BAD_STATE,
                                "The trace(%s) has already been started and is not paused!!", libtrace->uridata);
                        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                        return -1;
                }
                
                // Update the per_pkt function, or reuse the old one
                if (per_pkt)
                        libtrace->per_pkt = per_pkt;

                if (reporter)
                        libtrace->reporter = reporter;

                assert(libtrace_parallel);
                assert(!libtrace->perpkt_thread_states[THREAD_RUNNING]);
                assert(libtrace->per_pkt);
                
                if (libtrace->perpkt_thread_count > 1 && trace_supports_parallel(libtrace) && !trace_has_dedicated_hasher(libtrace)) {
                        fprintf(stderr, "Restarting trace pstart_input()\n");
                        err = libtrace->format->pstart_input(libtrace);
                } else {
                        if (libtrace->format->start_input) {
                                fprintf(stderr, "Restarting trace start_input()\n");
                                err = libtrace->format->start_input(libtrace);
                        }
                }
                
                if (err == 0) {
                        libtrace->started = true;
                        libtrace_change_state(libtrace, STATE_RUNNING, false);
                }
                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                return err;
        }

        assert(libtrace->state == STATE_NEW);
        libtrace_parallel = 1;

        // Store the user defined things against the trace
        libtrace->global_blob = global_blob;
        libtrace->per_pkt = per_pkt;
        libtrace->reporter = reporter;

        ASSERT_RET(pthread_mutex_init(&libtrace->libtrace_lock, NULL), == 0);
        ASSERT_RET(pthread_cond_init(&libtrace->perpkt_cond, NULL), == 0);
        ASSERT_RET(pthread_rwlock_init(&libtrace->window_lock, NULL), == 0);
        // Grab the lock
        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);

        // Set default buffer sizes
        if (libtrace->config.hasher_queue_size <= 0)
                libtrace->config.hasher_queue_size = 1000;

        if (libtrace->config.perpkt_threads <= 0) {
                // TODO add BSD support
                libtrace->perpkt_thread_count = sysconf(_SC_NPROCESSORS_ONLN);
                if (libtrace->perpkt_thread_count <= 0)
                        // Lets just use one
                        libtrace->perpkt_thread_count = 1;
        } else {
                libtrace->perpkt_thread_count = libtrace->config.perpkt_threads;
        }

        if (libtrace->config.reporter_thold <= 0)
                libtrace->config.reporter_thold = 100;
        if (libtrace->config.burst_size <= 0)
                libtrace->config.burst_size = 10;
        if (libtrace->config.packet_thread_cache_size <= 0)
                libtrace->config.packet_thread_cache_size = 20;
        if (libtrace->config.packet_cache_size <= 0)
                libtrace->config.packet_cache_size = (libtrace->config.hasher_queue_size + 1) * libtrace->perpkt_thread_count;

        if (libtrace->config.packet_cache_size <
                (libtrace->config.hasher_queue_size + 1) * libtrace->perpkt_thread_count)
                fprintf(stderr, "WARNING deadlocks may occur and extra memory allocating buffer sizes (packet_freelist_size) mismatched\n");

        libtrace->started = true; // Before we start the threads otherwise we could have issues
        libtrace_change_state(libtrace, STATE_RUNNING, false);
        /* Disable signals - Pthread signal handling */

        sigemptyset(&sig_block_all);

        ASSERT_RET(pthread_sigmask(SIG_SETMASK, &sig_block_all, &sig_before), == 0);

        // If we are using a hasher start it
        // If single threaded we don't need a hasher
        if (libtrace->perpkt_thread_count > 1 && libtrace->hasher && libtrace->hasher_type != HASHER_HARDWARE) {
                libtrace_thread_t *t = &libtrace->hasher_thread;
                t->trace = libtrace;
                t->ret = NULL;
                t->type = THREAD_HASHER;
                t->state = THREAD_RUNNING;
                libtrace_message_queue_init(&t->messages, sizeof(libtrace_message_t));
                ASSERT_RET(pthread_create(&t->tid, NULL, hasher_entry, (void *) libtrace), == 0);
                snprintf(name, sizeof(name), "hasher-thread");
                pthread_setname_np(t->tid, name);
        } else {
                libtrace->hasher_thread.type = THREAD_EMPTY;
        }

        libtrace_ocache_init(&libtrace->packet_freelist,
                                                 (void* (*)()) trace_create_packet,
                                                 (void (*)(void *))trace_destroy_packet,
                                                 libtrace->config.packet_thread_cache_size,
                                                 libtrace->config.packet_cache_size * 4,
                                                 libtrace->config.fixed_packet_count);
        // Unused slidingwindow code
        //libtrace_slidingwindow_init(&libtrace->sliding_window, libtrace->packet_freelist_size, 0);
        //ASSERT_RET(sem_init(&libtrace->sem, 0, libtrace->packet_freelist_size), == 0);

        // This will be applied to every new thread that starts, i.e. they will block all signals
        // Lets start a fixed number of reading threads

        /* Ready some storages */
        libtrace->first_packets.first = 0;
        libtrace->first_packets.count = 0;
        ASSERT_RET(pthread_spin_init(&libtrace->first_packets.lock, 0), == 0);
        libtrace->first_packets.packets = calloc(libtrace->perpkt_thread_count, sizeof(struct  __packet_storage_magic_type));


        /* Ready all of our perpkt threads - they are started later */
        libtrace->perpkt_threads = calloc(sizeof(libtrace_thread_t), libtrace->perpkt_thread_count);
        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
                libtrace_thread_t *t = &libtrace->perpkt_threads[i];
                t->trace = libtrace;
                t->ret = NULL;
                t->type = THREAD_PERPKT;
                t->state = THREAD_RUNNING;
                t->user_data = NULL;
                // t->tid DONE on create
                t->perpkt_num = i;
                if (libtrace->hasher)
                        libtrace_ringbuffer_init(&t->rbuffer, libtrace->config.hasher_queue_size,
                                                 libtrace->config.hasher_polling?LIBTRACE_RINGBUFFER_POLLING:0);
                libtrace_message_queue_init(&t->messages, sizeof(libtrace_message_t));
                t->recorded_first = false;
                t->tracetime_offset_usec = 0;;
        }

        int threads_started = 0;
        /* Setup the trace and start our threads */
        if (libtrace->perpkt_thread_count > 1 && trace_supports_parallel(libtrace) && !trace_has_dedicated_hasher(libtrace)) {
                printf("This format has direct support for p's\n");
                threads_started = libtrace->format->pstart_input(libtrace);
        } else {
                if (libtrace->format->start_input) {
                        threads_started=libtrace->format->start_input(libtrace);
                }
        }
        if (threads_started == 0)
                threads_started = trace_start_perpkt_threads(libtrace);

        // No combiner set, use a default to reduce the chance of this breaking
        if (libtrace->combiner.initialise == NULL && libtrace->combiner.publish == NULL)
                libtrace->combiner = combiner_unordered;

        if (libtrace->combiner.initialise)
                libtrace->combiner.initialise(libtrace, &libtrace->combiner);

        libtrace->reporter_thread.type = THREAD_REPORTER;
        libtrace->reporter_thread.state = THREAD_RUNNING;
        libtrace_message_queue_init(&libtrace->reporter_thread.messages, sizeof(libtrace_message_t));
        if (reporter) {
                // Got a real reporter
                ASSERT_RET(pthread_create(&libtrace->reporter_thread.tid, NULL, reporter_entry, (void *) libtrace), == 0);
        } else {
                // Main thread is reporter
                libtrace->reporter_thread.tid = pthread_self();
        }

        if (libtrace->config.tick_interval > 0) {
                libtrace->keepalive_thread.type = THREAD_KEEPALIVE;
                libtrace->keepalive_thread.state = THREAD_RUNNING;
                libtrace_message_queue_init(&libtrace->keepalive_thread.messages, sizeof(libtrace_message_t));
                ASSERT_RET(pthread_create(&libtrace->keepalive_thread.tid, NULL, keepalive_entry, (void *) libtrace), == 0);
        }

        for (i = 0; i < THREAD_STATE_MAX; ++i) {
                libtrace->perpkt_thread_states[i] = 0;
        }
        libtrace->perpkt_thread_states[THREAD_RUNNING] = threads_started;

        // Revert back - Allow signals again
        ASSERT_RET(pthread_sigmask(SIG_SETMASK, &sig_before, NULL), == 0);
        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);

        if (threads_started < 0)
                // Error
                return threads_started;

        // TODO fix these leaks etc
        if (libtrace->perpkt_thread_count != threads_started)
                fprintf(stderr, "Warning started threads not equal requested s=%d r=%d", threads_started, libtrace->perpkt_thread_count);


        return 0;
}

/**
 * Pauses a trace, this should only be called by the main thread
 * 1. Set started = false 
 * 2. All perpkt threads are paused waiting on a condition var
 * 3. Then call ppause on the underlying format if found
 * 4. The traces state is paused
 *
 * Once done you should be able to modify the trace setup and call pstart again
 * TODO handle changing thread numbers
 */
DLLEXPORT int trace_ppause(libtrace_t *libtrace)
{
        libtrace_thread_t *t;
        int i;
        assert(libtrace);
        
        t = get_thread_table(libtrace);
        // Check state from within the lock if we are going to change it
        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
        if (!libtrace->started || libtrace->state != STATE_RUNNING) {
                fprintf(stderr, "pause failed started=%d state=%s (%d)\n", libtrace->started, get_trace_state_name(libtrace->state), libtrace->state);
                trace_set_err(libtrace,TRACE_ERR_BAD_STATE, "You must call trace_start() before calling trace_ppause()");
                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                return -1;
        }

        libtrace_change_state(libtrace, STATE_PAUSING, false);
        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);

        // Special case handle the hasher thread case
        if (trace_has_dedicated_hasher(libtrace)) {
                if (libtrace->config.debug_state)
                        fprintf(stderr, "Hasher thread is running, asking it to pause ...");
                libtrace_message_t message = {0};
                message.code = MESSAGE_DO_PAUSE;
                trace_send_message_to_thread(libtrace, &libtrace->hasher_thread, &message);
                // Wait for it to pause
                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
                while (libtrace->hasher_thread.state == THREAD_RUNNING) {
                        ASSERT_RET(pthread_cond_wait(&libtrace->perpkt_cond, &libtrace->libtrace_lock), == 0);
                }
                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                if (libtrace->config.debug_state)
                        fprintf(stderr, " DONE\n");
        }

        if (libtrace->config.debug_state)
                fprintf(stderr, "Asking perpkt threads to pause ...");
        // Stop threads, skip this one if it's a perpkt
        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
                if (&libtrace->perpkt_threads[i] != t) {
                        libtrace_message_t message = {0};
                        message.code = MESSAGE_DO_PAUSE;
                        trace_send_message_to_thread(libtrace, &libtrace->perpkt_threads[i], &message);
                        if(trace_has_dedicated_hasher(libtrace)) {
                                // The hasher has stopped and other threads have messages waiting therefore
                                // If the queues are empty the other threads would have no data
                                // So send some message packets to simply ask the threads to check
                                // We are the only writer since hasher has paused
                                libtrace_packet_t *pkt;
                                libtrace_ocache_alloc(&libtrace->packet_freelist, (void **) &pkt, 1, 1);
                                pkt->error = READ_MESSAGE;
                                libtrace_ringbuffer_write(&libtrace->perpkt_threads[i].rbuffer, pkt);
                        }
                } else {
                        fprintf(stderr, "Mapper threads should not be used to pause a trace this could cause any number of problems!!\n");
                }
        }

        if (t) {
                // A perpkt is doing the pausing, interesting, fake an extra thread paused
                // We rely on the user to *not* return before starting the trace again
                thread_change_state(libtrace, t, THREAD_PAUSED, true);
        }

        // Wait for all threads to pause
        ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
        while(libtrace->perpkt_thread_states[THREAD_RUNNING]) {
                ASSERT_RET(pthread_cond_wait(&libtrace->perpkt_cond, &libtrace->libtrace_lock), == 0);
        }
        ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);

        if (libtrace->config.debug_state)
                fprintf(stderr, " DONE\n");

        // Deal with the reporter
        if (trace_has_dedicated_reporter(libtrace)) {
                if (libtrace->config.debug_state)
                        fprintf(stderr, "Reporter thread is running, asking it to pause ...");
                libtrace_message_t message = {0};
                message.code = MESSAGE_DO_PAUSE;
                trace_send_message_to_thread(libtrace, &libtrace->reporter_thread, &message);
                // Wait for it to pause
                ASSERT_RET(pthread_mutex_lock(&libtrace->libtrace_lock), == 0);
                while (libtrace->reporter_thread.state == THREAD_RUNNING) {
                        ASSERT_RET(pthread_cond_wait(&libtrace->perpkt_cond, &libtrace->libtrace_lock), == 0);
                }
                ASSERT_RET(pthread_mutex_unlock(&libtrace->libtrace_lock), == 0);
                if (libtrace->config.debug_state)
                        fprintf(stderr, " DONE\n");
        }

        if (trace_supports_parallel(libtrace) && !trace_has_dedicated_hasher(libtrace)) {
                uint64_t tmp_stats;
                libtrace->dropped_packets = trace_get_dropped_packets(libtrace);
                libtrace->received_packets = trace_get_received_packets(libtrace);
                if (libtrace->format->get_filtered_packets) {
                        if ((tmp_stats = libtrace->format->get_filtered_packets(libtrace)) != UINT64_MAX) {
                                libtrace->filtered_packets += tmp_stats;
                        }
                }
                libtrace->started = false;
                if (libtrace->format->ppause_input)
                        libtrace->format->ppause_input(libtrace);
                // TODO What happens if we don't have pause input??
        } else {
                int err;
                fprintf(stderr, "Trace is not parallel so we are doing a normal pause %s\n", libtrace->uridata);
                err = trace_pause(libtrace);
                // We should handle this a bit better
                if (err)
                        return err;
        }

        // Only set as paused after the pause has been called on the trace
        libtrace_change_state(libtrace, STATE_PAUSED, true);
        return 0;
}

/**
 * Stop trace finish prematurely as though it meet an EOF
 * This should only be called by the main thread
 * 1. Calls ppause
 * 2. Sends a message asking for threads to finish
 * 3. Releases threads which will pause
 */
DLLEXPORT int trace_pstop(libtrace_t *libtrace)
{
        int i, err;
        libtrace_message_t message = {0};
        assert(libtrace);

        // Ensure all threads have paused and the underlying trace format has
        // been closed and all packets associated are cleaned up
        // Pause will do any state checks for us
        err = trace_ppause(libtrace);
        if (err)
                return err;

        // Now send a message asking the threads to stop
        // This will be retrieved before trying to read another packet
        
        message.code = MESSAGE_DO_STOP;
        trace_send_message_to_perpkts(libtrace, &message);
        if (trace_has_dedicated_hasher(libtrace))
                trace_send_message_to_thread(libtrace, &libtrace->hasher_thread, &message);
        
        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
                trace_send_message_to_thread(libtrace, &libtrace->perpkt_threads[i], &message);
        }

        // Now release the threads and let them stop
        libtrace_change_state(libtrace, STATE_FINSHED, true);
        return 0;
}

/**
 * Set the hasher type along with a selected function, if hardware supports
 * that generic type of hashing it will be used otherwise the supplied
 * hasher function will be used and passed data when called.
 *
 * @return 0 if successful otherwise -1 on error
 */
DLLEXPORT int trace_set_hasher(libtrace_t *trace, enum hasher_types type, fn_hasher hasher, void *data) {
        int ret = -1;
        if (type == HASHER_HARDWARE || (type == HASHER_CUSTOM && !hasher) || (type == HASHER_BALANCE && hasher)) {
                return -1;
        }

        // Save the requirements
        trace->hasher_type = type;
        if (hasher) {
                trace->hasher = hasher;
                trace->hasher_data = data;
        } else {
                trace->hasher = NULL;
                // TODO consider how to handle freeing this
                trace->hasher_data = NULL;
        }

        // Try push this to hardware - NOTE hardware could do custom if
        // there is a more efficient way to apply it, in this case
        // it will simply grab the function out of libtrace_t
        if (trace->format->pconfig_input)
                ret = trace->format->pconfig_input(trace, TRACE_OPTION_SET_HASHER, &type);

        if (ret == -1) {
                // We have to deal with this ourself
                // This most likely means single threaded reading of the trace
                if (!hasher) {
                        switch (type)
                        {
                                case HASHER_CUSTOM:
                                case HASHER_BALANCE:
                                        return 0;
                                case HASHER_BIDIRECTIONAL:
                                        trace->hasher = (fn_hasher) toeplitz_hash_packet;
                                        trace->hasher_data = calloc(1, sizeof(toeplitz_conf_t));
                                        toeplitz_init_config(trace->hasher_data, 1);
                                        return 0;
                                case HASHER_UNIDIRECTIONAL:
                                        trace->hasher = (fn_hasher) toeplitz_hash_packet;
                                        trace->hasher_data = calloc(1, sizeof(toeplitz_conf_t));
                                        toeplitz_init_config(trace->hasher_data, 0);
                                        return 0;
                                case HASHER_HARDWARE:
                                        return -1;
                        }
                        return -1;
                }
        } else {
                // The hardware is dealing with this yay
                trace->hasher_type = HASHER_HARDWARE;
        }

        return 0;
}

// Waits for all threads to finish
DLLEXPORT void trace_join(libtrace_t *libtrace) {
        int i;

        /* Firstly wait for the perpkt threads to finish, since these are
         * user controlled */
        for (i=0; i< libtrace->perpkt_thread_count; i++) {
                //printf("Waiting to join with perpkt #%d\n", i);
                ASSERT_RET(pthread_join(libtrace->perpkt_threads[i].tid, NULL), == 0);
                //printf("Joined with perpkt #%d\n", i);
                // So we must do our best effort to empty the queue - so
                // the producer (or any other threads) don't block.
                libtrace_packet_t * packet;
                assert(libtrace->perpkt_threads[i].state == THREAD_FINISHED);
                while(libtrace_ringbuffer_try_read(&libtrace->perpkt_threads[i].rbuffer, (void **) &packet))
                        if (packet) // This could be NULL iff the perpkt finishes early
                                trace_destroy_packet(packet);
        }

        /* Now the hasher */
        if (trace_has_dedicated_hasher(libtrace)) {
                pthread_join(libtrace->hasher_thread.tid, NULL);
                assert(libtrace->hasher_thread.state == THREAD_FINISHED);
        }

        // Now that everything is finished nothing can be touching our
        // buffers so clean them up
        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
                // Its possible 1 packet got added by the reporter (or 1 per any other thread) since we cleaned up
                // if they lost timeslice before-during a write
                libtrace_packet_t * packet;
                while(libtrace_ringbuffer_try_read(&libtrace->perpkt_threads[i].rbuffer, (void **) &packet))
                        trace_destroy_packet(packet);
                if (libtrace->hasher) {
                        assert(libtrace_ringbuffer_is_empty(&libtrace->perpkt_threads[i].rbuffer));
                        libtrace_ringbuffer_destroy(&libtrace->perpkt_threads[i].rbuffer);
                }
                // Cannot destroy vector yet, this happens with trace_destroy
        }
        // TODO consider perpkt threads marking trace as finished before join is called
        libtrace_change_state(libtrace, STATE_FINSHED, true);

        if (trace_has_dedicated_reporter(libtrace)) {
                pthread_join(libtrace->reporter_thread.tid, NULL);
                assert(libtrace->reporter_thread.state == THREAD_FINISHED);
        }
        
        // Wait for the tick (keepalive) thread if it has been started
        if (libtrace->keepalive_thread.type == THREAD_KEEPALIVE) {
                libtrace_message_t msg = {0};
                msg.code = MESSAGE_DO_STOP;
                trace_send_message_to_thread(libtrace, &libtrace->keepalive_thread, &msg);
                pthread_join(libtrace->keepalive_thread.tid, NULL);
        }
        
        libtrace_change_state(libtrace, STATE_JOINED, true);
        print_memory_stats();
}

DLLEXPORT int libtrace_thread_get_message_count(libtrace_t * libtrace)
{
        libtrace_thread_t * t = get_thread_descriptor(libtrace);
        assert(t);
        return libtrace_message_queue_count(&t->messages);
}

DLLEXPORT int libtrace_thread_get_message(libtrace_t * libtrace, libtrace_message_t * message)
{
        libtrace_thread_t * t = get_thread_descriptor(libtrace);
        assert(t);
        return libtrace_message_queue_get(&t->messages, message);
}

DLLEXPORT int libtrace_thread_try_get_message(libtrace_t * libtrace, libtrace_message_t * message)
{
        libtrace_thread_t * t = get_thread_descriptor(libtrace);
        assert(t);
        return libtrace_message_queue_try_get(&t->messages, message);
}

/**
 * Return backlog indicator
 */
DLLEXPORT int trace_post_reporter(libtrace_t *libtrace)
{
        libtrace_message_t message = {0};
        message.code = MESSAGE_POST_REPORTER;
        message.sender = get_thread_descriptor(libtrace);
        return libtrace_message_queue_put(&libtrace->reporter_thread.messages, (void *) &message);
}

/**
 * Return backlog indicator
 */
DLLEXPORT int trace_send_message_to_reporter(libtrace_t * libtrace, libtrace_message_t * message)
{
        //printf("Sending message code=%d to reporter\n", message->code);
        message->sender = get_thread_descriptor(libtrace);
        return libtrace_message_queue_put(&libtrace->reporter_thread.messages, message);
}

/**
 *
 */
DLLEXPORT int trace_send_message_to_thread(libtrace_t * libtrace, libtrace_thread_t *t, libtrace_message_t * message)
{
        //printf("Sending message code=%d to reporter\n", message->code);
        message->sender = get_thread_descriptor(libtrace);
        return libtrace_message_queue_put(&t->messages, message);
}

DLLEXPORT int trace_send_message_to_perpkts(libtrace_t * libtrace, libtrace_message_t * message)
{
        int i;
        message->sender = get_thread_descriptor(libtrace);
        for (i = 0; i < libtrace->perpkt_thread_count; i++) {
                libtrace_message_queue_put(&libtrace->perpkt_threads[i].messages, message);
        }
        //printf("Sending message code=%d to reporter\n", message->code);
        return 0;
}

DLLEXPORT void libtrace_result_set_key(libtrace_result_t * result, uint64_t key) {
        result->key = key;
}
DLLEXPORT uint64_t libtrace_result_get_key(libtrace_result_t * result) {
        return result->key;
}
DLLEXPORT void libtrace_result_set_value(libtrace_result_t * result, libtrace_generic_types_t value) {
        result->value = value;
}
DLLEXPORT libtrace_generic_types_t libtrace_result_get_value(libtrace_result_t * result) {
        return result->value;
}
DLLEXPORT void libtrace_result_set_key_value(libtrace_result_t * result, uint64_t key, libtrace_generic_types_t value) {
        result->key = key;
        result->value = value;
}
DLLEXPORT void trace_destroy_result(libtrace_result_t ** result) {
        free(*result);
        result = NULL;
        // TODO automatically back with a free list!!
}

DLLEXPORT void * trace_get_global(libtrace_t *trace)
{
        return trace->global_blob;
}

DLLEXPORT void * trace_set_global(libtrace_t *trace, void * data)
{
        if (trace->global_blob && trace->global_blob != data) {
                void * ret = trace->global_blob;
                trace->global_blob = data;
                return ret;
        } else {
                trace->global_blob = data;
                return NULL;
        }
}

DLLEXPORT void * trace_get_tls(libtrace_thread_t *t)
{
        return t->user_data;
}

DLLEXPORT void * trace_set_tls(libtrace_thread_t *t, void * data)
{
        if(t->user_data && t->user_data != data) {
                void *ret = t->user_data;
                t->user_data = data;
                return ret;
        } else {
                t->user_data = data;
                return NULL;
        }
}

/**
 * Publishes a result to the reduce queue
 * Should only be called by a perpkt thread, i.e. from a perpkt handler
 */
DLLEXPORT void trace_publish_result(libtrace_t *libtrace, libtrace_thread_t *t, uint64_t key, libtrace_generic_types_t value, int type) {
        libtrace_result_t res;
        res.type = type;
        res.key = key;
        res.value = value;
        assert(libtrace->combiner.publish);
        libtrace->combiner.publish(libtrace, t->perpkt_num, &libtrace->combiner, &res);
        return;
}

/**
 * Sets a combiner function against the trace.
 */
DLLEXPORT void trace_set_combiner(libtrace_t *trace, const libtrace_combine_t *combiner, libtrace_generic_types_t config){
        if (combiner) {
                trace->combiner = *combiner;
                trace->combiner.configuration = config;
        } else {
                // No combiner, so don't try use it
                memset(&trace->combiner, 0, sizeof(trace->combiner));
        }
}

DLLEXPORT uint64_t trace_packet_get_order(libtrace_packet_t * packet) {
        return packet->order;
}

DLLEXPORT uint64_t trace_packet_get_hash(libtrace_packet_t * packet) {
        return packet->hash;
}

DLLEXPORT void trace_packet_set_order(libtrace_packet_t * packet, uint64_t order) {
        packet->order = order;
}

DLLEXPORT void trace_packet_set_hash(libtrace_packet_t * packet, uint64_t hash) {
        packet->hash = hash;
}

DLLEXPORT int trace_finished(libtrace_t * libtrace) {
        // TODO I don't like using this so much, we could use state!!!
        return libtrace->perpkt_thread_states[THREAD_FINISHED] == libtrace->perpkt_thread_count;
}

DLLEXPORT int trace_parallel_config(libtrace_t *libtrace, trace_parallel_option_t option, void *value)
{
        UNUSED int ret = -1;
        switch (option) {
                case TRACE_OPTION_TICK_INTERVAL:
                        libtrace->config.tick_interval = *((int *) value);
                        return 1;
                case TRACE_OPTION_SET_HASHER:
                        return trace_set_hasher(libtrace, (enum hasher_types) *((int *) value), NULL, NULL);
                case TRACE_OPTION_SET_PERPKT_THREAD_COUNT:
                        libtrace->config.perpkt_threads = *((int *) value);
                        return 1;
                case TRACE_OPTION_TRACETIME:
                        if(*((int *) value))
                                libtrace->tracetime = 1;
                        else
                                libtrace->tracetime = 0;
                        return 0;
                case TRACE_OPTION_SET_CONFIG:
                        libtrace->config = *((struct user_configuration *) value);
                case TRACE_OPTION_GET_CONFIG:
                        *((struct user_configuration *) value) = libtrace->config;
        }
        return 0;
}

static bool config_bool_parse(char *value, size_t nvalue) {
        if (strncmp(value, "true", nvalue) == 0)
                return true;
        else if (strncmp(value, "false", nvalue) == 0)
                return false;
        else
                return strtoll(value, NULL, 10) != 0;
}

static void config_string(struct user_configuration *uc, char *key, size_t nkey, char *value, size_t nvalue) {
        assert(key);
        assert(value);
        assert(uc);
        if (strncmp(key, "packet_cache_size", nkey) == 0
                || strncmp(key, "pcs", nkey) == 0) {
                uc->packet_cache_size = strtoll(value, NULL, 10);
        } else if (strncmp(key, "packet_thread_cache_size", nkey) == 0
                           || strncmp(key, "ptcs", nkey) == 0) {
                uc->packet_thread_cache_size = strtoll(value, NULL, 10);
        } else if (strncmp(key, "fixed_packet_count", nkey) == 0
                  || strncmp(key, "fpc", nkey) == 0) {
                uc->fixed_packet_count = config_bool_parse(value, nvalue);
        } else if (strncmp(key, "burst_size", nkey) == 0
                   || strncmp(key, "bs", nkey) == 0) {
                uc->burst_size = strtoll(value, NULL, 10);
        } else if (strncmp(key, "tick_interval", nkey) == 0
                   || strncmp(key, "ti", nkey) == 0) {
                uc->tick_interval = strtoll(value, NULL, 10);
        } else if (strncmp(key, "tick_count", nkey) == 0
                   || strncmp(key, "tc", nkey) == 0) {
                uc->tick_count = strtoll(value, NULL, 10);
        } else if (strncmp(key, "perpkt_threads", nkey) == 0
                   || strncmp(key, "pt", nkey) == 0) {
                uc->perpkt_threads = strtoll(value, NULL, 10);
        } else if (strncmp(key, "hasher_queue_size", nkey) == 0
                   || strncmp(key, "hqs", nkey) == 0) {
                uc->hasher_queue_size = strtoll(value, NULL, 10);
        } else if (strncmp(key, "hasher_polling", nkey) == 0
                   || strncmp(key, "hp", nkey) == 0) {
                uc->hasher_polling = config_bool_parse(value, nvalue);
        } else if (strncmp(key, "reporter_polling", nkey) == 0
                   || strncmp(key, "rp", nkey) == 0) {
                uc->reporter_polling = config_bool_parse(value, nvalue);
        } else if (strncmp(key, "reporter_thold", nkey) == 0
                   || strncmp(key, "rt", nkey) == 0) {
                uc->reporter_thold = strtoll(value, NULL, 10);
        } else if (strncmp(key, "debug_state", nkey) == 0
                   || strncmp(key, "ds", nkey) == 0) {
                uc->debug_state = config_bool_parse(value, nvalue);
        } else {
                fprintf(stderr, "No matching value %s(=%s)\n", key, value);
        }
}

DLLEXPORT void parse_user_config(struct user_configuration* uc, char * str) {
        char *pch;
        char key[100];
        char value[100];
        assert(str);
        assert(uc);
        printf ("Splitting string \"%s\" into tokens:\n",str);
        pch = strtok (str," ,.-");
        while (pch != NULL)
        {
                if (sscanf(pch, "%99[^=]=%99s", key, value) == 2) {
                        config_string(uc, key, sizeof(key), value, sizeof(value));
                } else {
                        fprintf(stderr, "Error parsing %s\n", pch);
                }
                pch = strtok (NULL," ,.-");
        }
}

DLLEXPORT void parse_user_config_file(struct user_configuration* uc, FILE *file) {
        char line[1024];
        while (fgets(line, sizeof(line), file) != NULL)
        {
                parse_user_config(uc, line);
        }
}

DLLEXPORT libtrace_packet_t* trace_result_packet(libtrace_t * libtrace, libtrace_packet_t * packet) {
        libtrace_packet_t* result;
        libtrace_ocache_alloc(&libtrace->packet_freelist, (void **) &result, 1, 1);
        assert(result);
        swap_packets(result, packet); // Move the current packet into our copy
        return result;
}

DLLEXPORT void trace_free_result_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
        // Try write back the packet
        assert(packet);
        // Always release any resources this might be holding such as a slot in a ringbuffer
        trace_fin_packet(packet);
        libtrace_ocache_free(&libtrace->packet_freelist, (void **) &packet, 1, 1);
}

DLLEXPORT libtrace_info_t *trace_get_information(libtrace_t * libtrace) {
        if (libtrace->format)
                return &libtrace->format->info;
        else
                return NULL;
}