source: lib/trace_parallel.c @ 69ae5a9

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

Refactor duplicated code into a seperate function
Fixes a bug where packets could be lost when pausing a delayed trace.

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