source: lib/trace_parallel.c @ b54e2da

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

Fix bug in pausing trace

Packets were incorrectly being sent in tracetime in some cases.

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