source: lib/trace_parallel.c @ f625817

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivelibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since f625817 was f625817, checked in by Shane Alcock <salcock@…>, 6 years ago

Reworked callback API and removed old per_msg and reporter functions

Updated tracertstats to use the new callback API.

Extended the callback approach to the reporter thread as well as the per
packet threads.

Added libtrace_callback_set_t structure, which is used to register the
user callback functions.

Added callback functionality for MESSAGE_RESULT (needed now that reporter
threads also do callbacks) and MESSAGE_USER (for user-defined messages). The
MESSAGE_USER callback is essentially the same as the old per_msg function
style.

Updated combiners to use send_message to pass results to the reporter thread.
send_message itself is now no longer static, so that combiners can use it.

Disabled building of tracestats_parallel as it was using the older version
of the callback API. Will update in a future commit.

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