source: lib/trace_parallel.c @ 2adc1d0

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

Remove unused hash lock code which was never finished

Due to the complexity of threading this code was never finished.
And did not show a significant performance improvement over
alternatives.

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