source: lib/trace_parallel.c @ 2193905

develop
Last change on this file since 2193905 was 2193905, checked in by Jacob Van Walraven <jcv9@…>, 2 years ago

Apply changes required for pull request #81

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