source: lib/libtrace_int.h @ cc9c9de

cachetimestampsdevelopetsiliverc-4.0.4ringdecrementfixringperformance
Last change on this file since cc9c9de was cc9c9de, checked in by Shane Alcock <salcock@…>, 3 years ago

Add new config option for trace_event() -- REPLAY_SPEEDUP

This allows users to specify a "speedup factor" when using
trace_event() to replay trace files, i.e. all inter-packet
gaps will be divided by the speedup factor. This allows traces
to be replayed faster, while still preserving the same relative
gaps between packets.

  • Property mode set to 100644
File size: 42.7 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/** @file
27 *
28 * @brief Header file containing definitions for structures and functions that
29 * are internal
30 *
31 * @author Daniel Lawson
32 * @author Perry Lorier
33 * @author Shane Alcock
34 *
35 * @version $Id$
36 *
37 * All of the structures and functions defined in this header file are intended
38 * for internal use within Libtrace only. They should not be exported as part
39 * of the library API as we don't want users accessing things like the
40 * contents of the libtrace packet structure directly!
41 */
42#ifndef LIBTRACE_INT_H
43#define LIBTRACE_INT_H
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
49#include "config.h"
50#include "common.h"
51#include "libtrace_parallel.h"
52#include "wandio.h"
53#include "lt_bswap.h"
54
55#ifdef _MSC_VER
56// warning: deprecated function
57#pragma warning(disable:4996)
58// warning: benign redefinitions of types
59#pragma warning(disable:4142)
60#endif
61
62#ifdef HAVE_INTTYPES_H
63# include <inttypes.h>
64#else
65# include "lt_inttypes.h"
66#endif
67
68#ifdef HAVE_STDDEF_H
69# include <stddef.h>
70#else
71#ifndef WIN32
72# error "Can't find stddev.h -- do you define ptrdiff_t elsewhere?"
73#endif
74#endif
75
76
77#include "rt_protocol.h"
78       
79/* Prefer net/bpf.h over pcap-bpf.h for format_bpf.c on MacOS */
80#ifdef HAVE_NET_BPF_H
81#    include <net/bpf.h>
82#    define HAVE_BPF 1
83#else
84#ifdef HAVE_PCAP_BPF_H
85#  include <pcap-bpf.h>
86#  define HAVE_BPF 1
87#endif
88#endif
89
90#ifdef HAVE_PCAP_H
91#  include <pcap.h>
92#  ifdef HAVE_PCAP_INT_H
93#    include <pcap-int.h>
94#  endif
95#endif
96
97#ifdef HAVE_ZLIB_H
98#  include <zlib.h>
99#endif
100
101#ifndef HAVE_STRNDUP
102char *strndup(const char *s, size_t size);
103#endif
104
105#ifndef HAVE_STRNCASECMP
106# ifndef HAVE__STRNICMP
107/** A local implementation of strncasecmp (as some systems do not have it) */
108int strncasecmp(const char *str1, const char *str2, size_t n);
109# else
110# define strncasecmp _strnicmp
111# endif
112#endif
113
114#ifndef HAVE_SNPRINTF
115# ifndef HAVE_SPRINTF_S
116/** A local implementation of snprintf (as some systems do not have it) */
117int snprintf(char *str, size_t size, const char *format, ...);
118# else
119# define snprintf sprintf_s
120# endif
121#endif
122
123#include "daglegacy.h"
124       
125#ifdef HAVE_DAG_API
126#  include "dagnew.h"
127#  include "dagapi.h"
128#       if DAG_VERSION == 24
129#               include <erftypes.h>
130#       else
131#               include <daginf.h>
132#       endif
133#  include "erftypes.h"
134#else
135#  include "dagformat.h"
136#endif
137
138#ifdef HAVE_LLVM
139#include "bpf-jit/bpf-jit.h"
140#endif
141
142#include "data-struct/ring_buffer.h"
143#include "data-struct/object_cache.h"
144#include "data-struct/vector.h"
145#include "data-struct/message_queue.h"
146#include "data-struct/deque.h"
147#include "data-struct/linked_list.h"
148#include "data-struct/sliding_window.h"
149#include "data-struct/buckets.h"
150#include "pthread_spinlock.h"
151
152//#define RP_BUFSIZE 65536U
153
154#define LIBTRACE_MAX_REPLAY_SPEEDUP 1000
155
156/** Data about the most recent event from a trace file */
157struct libtrace_event_status_t {
158        /** A libtrace packet to store the packet when a PACKET event occurs */
159        libtrace_packet_t *packet;
160
161        /* The walltime when we processed the first packet from the trace */
162        double first_now;
163
164        /* The tracetime of the first packet in the trace */
165        double first_ts;
166
167        /** The size of the current PACKET event */
168        int psize;
169        /** Whether there is a packet stored in *packet above waiting for an
170         * event to occur */
171        bool waiting;
172};
173
174enum thread_types {
175        THREAD_EMPTY,
176        THREAD_HASHER,
177        THREAD_PERPKT,
178        THREAD_REPORTER,
179        THREAD_KEEPALIVE
180};
181
182enum thread_states {
183        THREAD_RUNNING,
184        THREAD_FINISHING,
185        THREAD_FINISHED,
186        THREAD_PAUSED,
187        THREAD_STATE_MAX
188};
189
190enum hash_owner {
191        HASH_OWNED_LIBTRACE,
192        HASH_OWNED_EXTERNAL,
193};
194
195/**
196 * Information of this thread
197 */
198struct libtrace_thread_t {
199        uint64_t accepted_packets; // The number of packets accepted only used if pread
200        uint64_t filtered_packets;
201        // is retreving packets
202        // Set to true once the first packet has been stored
203        bool recorded_first;
204        // For thread safety reason we actually must store this here
205        int64_t tracetime_offset_usec;
206        void* user_data; // TLS for the user to use
207        void* format_data; // TLS for the format to use
208        libtrace_message_queue_t messages; // Message handling
209        libtrace_ringbuffer_t rbuffer; // Input
210        libtrace_t * trace;
211        void* ret;
212        enum thread_types type;
213        enum thread_states state;
214        pthread_t tid;
215        int perpkt_num; // A number from 0-X that represents this perpkt threads number
216                                // in the table, intended to quickly identify this thread
217                                // -1 represents NA (such as the case this is not a perpkt thread)
218} ALIGN_STRUCT(CACHE_LINE_SIZE);
219
220/**
221 * Storage to note time value against each.
222 * Used both internally to do trace time playback
223 * and can be used externally to assist applications which need
224 * a trace starting time such as tracertstats.
225 */
226struct first_packets {
227        pthread_spinlock_t lock;
228        size_t count; // If == perpkt_thread_count threads we have all
229        size_t first; // Valid if count != 0
230        struct {
231                libtrace_packet_t * packet;
232                struct timeval tv;
233        } * packets;
234};
235
236#define TRACE_STATES \
237        X(STATE_NEW) \
238        X(STATE_RUNNING) \
239        X(STATE_PAUSING) \
240        X(STATE_PAUSED) \
241        X(STATE_FINISHED) \
242        X(STATE_FINISHING) \
243        X(STATE_DESTROYED) \
244        X(STATE_JOINED) \
245        X(STATE_ERROR)
246
247#define X(a) a,
248enum trace_state {
249        TRACE_STATES
250};
251#undef X
252
253#define X(a) case a: return #a;
254static inline char *get_trace_state_name(enum trace_state ts){
255        switch(ts) {
256                TRACE_STATES
257                default:
258                        return "UNKNOWN";
259        }
260}
261#undef X
262
263#define READ_EOF 0
264#define READ_ERROR -1
265#define READ_MESSAGE -2
266// Used for inband tick message
267#define READ_TICK -3
268
269/**
270 * Tuning the parallel sizes
271 * See the user documentation trace_set_x
272 */
273struct user_configuration {
274        size_t cache_size;
275        size_t thread_cache_size;
276        bool fixed_count;
277        size_t burst_size;
278        size_t tick_interval;
279        size_t tick_count;
280        size_t perpkt_threads;
281        size_t hasher_queue_size;
282        bool hasher_polling;
283        bool reporter_polling;
284        size_t reporter_thold;
285        bool debug_state;
286};
287#define ZERO_USER_CONFIG(config) memset(&config, 0, sizeof(struct user_configuration));
288
289struct callback_set {
290
291        fn_cb_starting message_starting;
292        fn_cb_dataless message_stopping;
293        fn_cb_dataless message_resuming;
294        fn_cb_dataless message_pausing;
295        fn_cb_packet message_packet;
296        fn_cb_result message_result;
297        fn_cb_first_packet message_first_packet;
298        fn_cb_tick message_tick_count;
299        fn_cb_tick message_tick_interval;
300        fn_cb_usermessage message_user;
301};
302
303/** A libtrace input trace
304 * @internal
305 */
306struct libtrace_t {
307        /** The capture format for the input trace */
308        struct libtrace_format_t *format; 
309        /** Details of the most recent PACKET event reported by the trace */
310        struct libtrace_event_status_t event;
311        /** Pointer to the "global" data for the capture format module */       
312        void *format_data;             
313        /** A BPF filter to be applied to all packets read by the trace -
314         * used only if the capture format does not support filters natively */
315        struct libtrace_filter_t *filter; 
316        /** The snap length to be applied to all packets read by the trace -
317         * used only if the capture format does not support snapping natively */
318        size_t snaplen;                 
319        /** Speed up the packet rate when using trace_event() to process trace
320         * files by this factor. */
321        int replayspeedup;
322        /** Count of the number of packets returned to the libtrace user */
323        uint64_t accepted_packets;
324        /** Count of the number of packets filtered by libtrace */
325        uint64_t filtered_packets;
326        /** The sequence is like accepted_packets but we don't reset this after a pause. */
327        uint64_t sequence_number;
328        /** The packet read out by the trace, backwards compatibility to allow us to finalise
329         * a packet when the trace is destroyed */
330        libtrace_packet_t *last_packet;
331        /** The filename from the uri for the trace */
332        char *uridata;
333        /** The libtrace IO reader for this trace (if applicable) */
334        io_t *io;
335        /** Error information for the trace */
336        libtrace_err_t err;
337        /** Boolean flag indicating whether the trace has been started */
338        bool started;
339        /** Synchronise writes/reads across this format object and attached threads etc */
340        pthread_mutex_t libtrace_lock;
341        /** Packet read lock, seperate from libtrace_lock as to not block while reading a burst */
342        pthread_mutex_t read_packet_lock;
343        /** State */
344        enum trace_state state;
345        /** Use to control pausing threads and finishing threads etc always used with libtrace_lock */
346        pthread_cond_t perpkt_cond;
347        /** Keeps track of counts of threads in any given state */
348        int perpkt_thread_states[THREAD_STATE_MAX]; 
349
350        /** Set to indicate a perpkt's queue is full as such the writing perpkt cannot proceed */
351        bool perpkt_queue_full;
352        /** Global storage for this trace, shared among all the threads  */
353        void* global_blob;
354        /** The actual freelist */
355        libtrace_ocache_t packet_freelist;
356        /** The hasher function */
357        enum hasher_types hasher_type;
358        /** The hasher function - NULL implies they don't care or balance */
359        fn_hasher hasher;
360        void *hasher_data;
361        enum hash_owner hasher_owner;
362        /** The pread_packet choosen path for the configuration */
363        int (*pread)(libtrace_t *, libtrace_thread_t *, libtrace_packet_t **, size_t);
364
365        libtrace_thread_t hasher_thread;
366        libtrace_thread_t reporter_thread;
367        libtrace_thread_t keepalive_thread;
368        int perpkt_thread_count;
369        libtrace_thread_t * perpkt_threads; // All our perpkt threads
370        // Used to keep track of the first packet seen on each thread
371        struct first_packets first_packets;
372        int tracetime;
373
374        /*
375         * Caches statistic counters in the case that our trace is
376         * paused or stopped before this counter is taken
377         */
378        libtrace_stat_t *stats;
379        struct user_configuration config;
380        libtrace_combine_t combiner;
381       
382        /* Set of callbacks to be executed by per packet threads in response
383         * to various messages. */
384        struct callback_set *perpkt_cbs;
385        /* Set of callbacks to be executed by the reporter thread in response
386         * to various messages. */
387        struct callback_set *reporter_cbs;
388};
389
390#define LIBTRACE_STAT_MAGIC 0x41
391
392void trace_fin_packet(libtrace_packet_t *packet);
393void libtrace_zero_thread(libtrace_thread_t * t);
394void store_first_packet(libtrace_t *libtrace, libtrace_packet_t *packet, libtrace_thread_t *t);
395libtrace_thread_t * get_thread_table(libtrace_t *libtrace);
396
397
398void send_message(libtrace_t *trace, libtrace_thread_t *target,
399                const enum libtrace_messages type,
400                libtrace_generic_t data, libtrace_thread_t *sender);
401
402/** A libtrace output trace
403 * @internal
404 */
405struct libtrace_out_t {
406        /** The capture format for the output trace */
407        struct libtrace_format_t *format;
408        /** Pointer to the "global" data for the capture format module */
409        void *format_data;             
410        /** The filename for the uri for the output trace */
411        char *uridata;                 
412        /** Error information for the output trace */
413        libtrace_err_t err;
414        /** Boolean flag indicating whether the trace has been started */
415        bool started;
416};
417
418/** Sets the error status on an input trace
419 *
420 * @param trace         The input trace to set the error status for
421 * @param errcode       The code for the error - can be a libtrace error code or a regular errno value
422 * @param msg           A message to print when reporting the error
423 */
424void trace_set_err(libtrace_t *trace, int errcode,const char *msg,...) 
425
426                                                                PRINTF(3,4);
427/** Sets the error status on an output trace
428 *
429 * @param trace         The output trace to set the error status for
430 * @param errcode       The code for the error - can be a libtrace error code or a regular errno value
431 * @param msg           A message to print when reporting the error
432 */
433void trace_set_err_out(libtrace_out_t *trace, int errcode, const char *msg,...)
434                                                                PRINTF(3,4);
435
436/** Clears the cached values for a libtrace packet
437 *
438 * @param packet        The libtrace packet that requires a cache reset
439 */
440void trace_clear_cache(libtrace_packet_t *packet);
441
442
443#ifndef PF_RULESET_NAME_SIZE
444#define PF_RULESET_NAME_SIZE 16
445#endif
446
447#ifndef IFNAMSIZ
448#define IFNAMSIZ 16
449#endif
450
451
452/** A local definition of a PFLOG header */
453typedef struct libtrace_pflog_header_t {
454        uint8_t    length;     
455        sa_family_t   af;
456        uint8_t    action;
457        uint8_t    reason;
458        char       ifname[IFNAMSIZ];
459        char       ruleset[PF_RULESET_NAME_SIZE];
460        uint32_t   rulenr;
461        uint32_t   subrulenr;
462        uint8_t    dir;
463        uint8_t    pad[3];
464} PACKED libtrace_pflog_header_t;
465
466/** A libtrace capture format module */
467/* All functions should return -1, or NULL on failure */
468struct libtrace_format_t {
469        /** The name of this module, used in the libtrace URI to identify the
470         * capture format */
471        const char *name;
472        /** The version of this module */
473        const char *version;
474        /** The RT protocol type of this module */
475        enum base_format_t type;
476
477
478        /** Given a filename, return if this is the most likely capture format
479         * (used for devices). Used to "guess" the capture format when the
480         * URI is not fully specified.
481         *
482         * @param fname         The name of the device or file to examine
483         * @return 1 if the name matches the capture format, 0 otherwise
484         */
485        int (*probe_filename)(const char *fname);
486       
487        /** Given a file, looks at the start of the file to determine if this
488         * is the capture format. Used to "guess" the capture format when the
489         * URI is not fully specified.
490         *
491         * @param io            An open libtrace IO reader for the file to check
492         * @return 1 if the file matches the capture format, 0 otherwise
493         */
494        int (*probe_magic)(io_t *io);
495
496        /** Initialises an input trace using the capture format.
497         *
498         * @param libtrace      The input trace to be initialised
499         * @return 0 if successful, -1 in the event of error
500         */
501        int (*init_input)(libtrace_t *libtrace);
502       
503        /** Applies a configuration option to an input trace.
504         *
505         * @param libtrace      The input trace to apply the option to
506         * @param option        The option that is being configured
507         * @param value         A pointer to the value that the option is to be
508         *                      set to
509         * @return 0 if successful, -1 if the option is unsupported or an error
510         * occurs
511         */
512        int (*config_input)(libtrace_t *libtrace,trace_option_t option,void *value);
513        /** Starts or unpauses an input trace - note that this function is
514         * often the one that opens the file or device for reading.
515         *
516         * @param libtrace      The input trace to be started or unpaused
517         * @return 0 if successful, -1 in the event of error */
518        int (*start_input)(libtrace_t *libtrace);
519
520        /** Pauses an input trace - this function should close or detach the
521         * file or device that is being read from.
522         *
523         * @param libtrace      The input trace to be paused
524         * @return 0 if successful, -1 in the event of error
525         */
526        int (*pause_input)(libtrace_t *libtrace);
527
528        /** Initialises an output trace using the capture format.
529         *
530         * @param libtrace      The output trace to be initialised
531         * @return 0 if successful, -1 in the event of error
532         */
533        int (*init_output)(libtrace_out_t *libtrace);
534       
535        /** Applies a configuration option to an output trace.
536         *
537         * @param libtrace      The output trace to apply the option to
538         * @param option        The option that is being configured
539         * @param value         A pointer to the value that the option is to be
540         *                      set to
541         * @return 0 if successful, -1 if the option is unsupported or an error
542         * occurs
543         * */
544        int (*config_output)(libtrace_out_t *libtrace, trace_option_output_t option, void *value);
545
546        /** Starts an output trace - note that this function is often the one
547         * that opens the file or device for writing.
548         *
549         * @param libtrace      The output trace to be started
550         * @return 0 if successful, -1 if an error occurs
551         *
552         * There is no pause for output traces, as writing is not performed
553         * asynchronously.
554         */
555        int (*start_output)(libtrace_out_t *libtrace);
556
557        /** Concludes an input trace and cleans up the capture format data.
558         *
559         * @param libtrace      The input trace to be concluded
560         * @return 0 if successful, -1 if an error occurs
561         *
562         * Libtrace will call the pause_input function if the input trace is
563         * currently active prior to calling this function.
564         */
565        int (*fin_input)(libtrace_t *libtrace);
566
567        /** Concludes an output trace and cleans up the capture format data.
568         *
569         * @param libtrace      The output trace to be concluded
570         * @return 0 if successful, -1 if an error occurs
571         */
572        int (*fin_output)(libtrace_out_t *libtrace);
573
574        /** Reads the next packet from an input trace into the provided packet
575         * structure.
576         *
577         * @param libtrace      The input trace to read from
578         * @param packet        The libtrace packet to read into
579         * @return The size of the packet read (in bytes) including the capture
580         * framing header, or -1 if an error occurs. 0 is returned in the
581         * event of an EOF or -2 in the case of interrupting the parallel API.
582         *
583         * If no packets are available for reading, this function should block
584         * until one appears or return 0 if the end of a trace file has been
585         * reached.
586         */
587        int (*read_packet)(libtrace_t *libtrace, libtrace_packet_t *packet);
588       
589        /** Converts a buffer containing a packet record into a libtrace packet
590         *
591         * @param libtrace      An input trace in the capture format for the
592         *                      packet
593         * @param packet        A libtrace packet to put the prepared packet
594         *                      into
595         * @param buffer        The buffer containing the packet record
596         *                      (including the capture format header)
597         * @param rt_type       The RT type for the packet
598         * @param flags         Flags describing properties that should be
599         *                      applied to the new packet
600         * @return 0 if successful, -1 if an error occurs.
601         *
602         * Updates internal trace and packet details, such as payload pointers,
603         * loss counters and packet types to match the packet record provided
604         * in the buffer. This is a zero-copy function.
605         *
606         * Intended (at this stage) only for internal use, particularly by
607         * RT which needs to decapsulate RT packets */
608        int (*prepare_packet)(libtrace_t *libtrace, libtrace_packet_t *packet,
609                        void *buffer, libtrace_rt_types_t rt_type, 
610                        uint32_t flags);
611       
612        /** Frees any resources allocated by the capture format module for a
613         * libtrace packet.
614         *
615         * @param The packet to be finalised
616         *       */
617        void (*fin_packet)(libtrace_packet_t *packet);
618
619        /** Write a libtrace packet to an output trace.
620         *
621         * @param libtrace      The output trace to write the packet to
622         * @param packet        The packet to be written out
623         * @return The number of bytes written, or -1 if an error occurs
624         */
625        int (*write_packet)(libtrace_out_t *libtrace, libtrace_packet_t *packet);
626        /** Returns the libtrace link type for a packet.
627         *
628         * @param packet        The packet to get the link type for
629         * @return The libtrace link type, or -1 if this link type is unknown
630         */ 
631        libtrace_linktype_t (*get_link_type)(const libtrace_packet_t *packet);
632
633        /** Returns the direction of a packet.
634         *
635         * @param packet        The packet to get the direction for
636         * @return The direction of the packet, or -1 if no direction tag is
637         * present or an error occurs
638         */ 
639        libtrace_direction_t (*get_direction)(const libtrace_packet_t *packet);
640       
641        /** Sets the direction of a packet.
642         *
643         * @param packet        The packet to set the direction for
644         * @param direction     The direction to assign to the packet
645         * @return The updated direction for the packet, or -1 if an error
646         * occurs
647         *
648         * @note Some capture formats do not feature direction tagging, so it
649         * will not make sense to implement a set_direction function for them.
650         */ 
651        libtrace_direction_t (*set_direction)(libtrace_packet_t *packet, libtrace_direction_t direction);
652       
653        /** Returns the timestamp for a packet in the ERF timestamp format.
654         *
655         * @param packet        The packet to get the timestamp from
656         * @return The 64-bit ERF timestamp
657         *
658         * @note Each format must implement at least one of the four "get
659         * timestamp" functions.
660         *
661         * If not implemented, libtrace will convert the result of one of the
662         * other timestamp functions into the appropriate format instead.
663         * This means each capture format only needs to implement the most
664         * sensible of the four and let libtrace handle any conversions.
665         *
666         */
667        uint64_t (*get_erf_timestamp)(const libtrace_packet_t *packet);
668
669        /** Returns the timestamp for a packet in the timeval format
670         *
671         * @param packet        The packet to get the timestamp from
672         * @return The timestamp from the packet as a timeval
673         *
674         * @note Each format must implement at least one of the four "get
675         * timestamp" functions.
676         *
677         * If not implemented, libtrace will convert the result of one of the
678         * other timestamp functions into the appropriate format instead.
679         * This means each capture format only needs to implement the most
680         * sensible of the four and let libtrace handle any conversions.
681         */
682        struct timeval (*get_timeval)(const libtrace_packet_t *packet);
683       
684        /** Returns the timestamp for a packet in the timespec format.
685         *
686         * @param packet        The packet to get the timestamp from
687         * @return The timestamp from the packet as a timespec
688         *
689         * @note Each format must implement at least one of the four "get
690         * timestamp" functions.
691         *
692         * If not implemented, libtrace will convert the result of one of the
693         * other timestamp functions into the appropriate format instead.
694         * This means each capture format only needs to implement the most
695         * sensible of the four and let libtrace handle any conversions.
696         */
697        struct timespec (*get_timespec)(const libtrace_packet_t *packet);
698       
699        /** Returns the timestamp for a packet in floating point seconds.
700         *
701         * @param packet        The packet to get the timestamp from
702         * @return The timestamp from the packet as a floating point number of
703         * seconds since 1970-01-01 00:00:00 UTC
704         *
705         * @note Each format must implement at least one of the four "get
706         * timestamp" functions.
707         *
708         * If not implemented, libtrace will convert the result of one of the
709         * other timestamp functions into the appropriate format instead.
710         * This means each capture format only needs to implement the most
711         * sensible of the four and let libtrace handle any conversions.
712         */
713        double (*get_seconds)(const libtrace_packet_t *packet);
714       
715        /** Moves the read pointer to a certain ERF timestamp within an input
716         * trace file.
717         *
718         * @param trace         The input trace to seek within
719         * @param timestamp     The timestamp to seek to, as an ERF timestamp
720         *
721         * @return 0 on success, -1 on failure.
722         *
723         * The next packet read from this trace will now be the first packet
724         * to have a timestamp equal to or greater than the provided timestamp.
725         *
726         * @note Each format that supports seeking must implement at least one
727         * of the seek functions.
728         *
729         * If not implemented, libtrace will convert the timestamp into the
730         * appropriate format to use a seek function that has been implemented.
731         * This means each capture format only needs to implement the seek
732         * function that matches the native timestamp format for that capture.
733         *
734         */
735        int (*seek_erf)(libtrace_t *trace, uint64_t timestamp);
736        /** Moves the read pointer to a certain timestamp represented using a
737         * timeval within an input trace file.
738         *
739         * @param trace         The input trace to seek within
740         * @param timestamp     The timestamp to seek to, as a timeval
741         *
742         * @return 0 on success, -1 on failure.
743         *
744         * The next packet read from this trace will now be the first packet
745         * to have a timestamp equal to or greater than the provided timestamp.
746         *
747         * @note Each format that supports seeking must implement at least one
748         * of the seek functions.
749         *
750         * If not implemented, libtrace will convert the timestamp into the
751         * appropriate format to use a seek function that has been implemented.
752         * This means each capture format only needs to implement the seek
753         * function that matches the native timestamp format for that capture.
754         *
755         */
756        int (*seek_timeval)(libtrace_t *trace, struct timeval tv);
757       
758        /** Moves the read pointer to a certain timestamp represented using
759         * floating point seconds within an input trace file.
760         *
761         * @param trace         The input trace to seek within
762         * @param timestamp     The timestamp to seek to, as floating point
763         *                      seconds since 1970-01-01 00:00:00 UTC
764         *
765         * @return 0 on success, -1 on failure.
766         *
767         * The next packet read from this trace will now be the first packet
768         * to have a timestamp equal to or greater than the provided timestamp.
769         *
770         * @note Each format that supports seeking must implement at least one
771         * of the seek functions.
772         *
773         * If not implemented, libtrace will convert the timestamp into the
774         * appropriate format to use a seek function that has been implemented.
775         * This means each capture format only needs to implement the seek
776         * function that matches the native timestamp format for that capture.
777         *
778         */
779        int (*seek_seconds)(libtrace_t *trace, double seconds);
780       
781        /** Returns the payload length of the captured packet record.
782         *
783         * @param packet        The packet to get the capture length from
784         * @return The capture length for the packet, or -1 if an error occurs
785         *
786         * Capture length is the current size of the packet record itself,
787         * following any truncation that may have occurred during the capture
788         * process. This length does not include the capture format framing
789         * header.
790         */
791        int (*get_capture_length)(const libtrace_packet_t *packet);
792
793        /** Returns the original length of the packet as it was on the wire.
794         *
795         * @param packet        The packet to get the wire length from
796         * @return The length of the packet on the wire at the time of capture,
797         * or -1 if an error occurs
798         *
799         * Wire length is the original size of the packet prior to any
800         * truncation that may have occurred as part of the capture process.
801         * This length does not include the capture format framing header.
802         */
803        int (*get_wire_length)(const libtrace_packet_t *packet);
804       
805        /** Returns the length of the capture format framing header
806         *
807         * @param packet        The packet to get the framing length from
808         * @return The length of the framing header, or -1 if an error occurs
809         *
810         * The framing header is the extra metadata that the capture process
811         * records about a packet.  The framing length does not include any
812         * of the packet payload itself. The total size of the packet record
813         * can be calculated be adding this value with the capture length.
814         */
815        int (*get_framing_length)(const libtrace_packet_t *packet);
816
817        /** Sets the capture length for a packet.
818         *
819         * @param packet        The packet to adjust the capture length for.
820         * @param size          The new capture length
821         * @return The new capture length of the packet, or -1 if an error
822         * occurs
823         *
824         * @note This function should only reduce the capture length. If the
825         * provided length is larger than the current capture length, -1 should
826         * be returned.
827         */
828        size_t (*set_capture_length)(struct libtrace_packet_t *packet,size_t size);
829        /** Returns the number of packets observed by an input trace.
830         *
831         * @param trace         The input trace to get the packet count for
832         * @return The number of packets observed by an input trace, or
833         * UINT64_MAX if the number is unknown
834         *
835         * This count includes packets that have been filtered and dropped.
836         */
837        uint64_t (*get_received_packets)(libtrace_t *trace);
838
839        /** Returns the number of packets filtered by an input trace.
840         *
841         * @param trace         The input trace to get the filtered count for
842         * @return The number of packets filtered by the input trace, or
843         * UINT64_MAX if the number is unknown
844         *
845         */
846        uint64_t (*get_filtered_packets)(libtrace_t *trace);
847       
848        /** Returns the number of packets dropped by an input trace.
849         *
850         * @param trace         The input trace to get the dropped count for
851         * @return The number of packets dropped by the input trace, or
852         * UINT64_MAX if the number is unknown
853         *
854         */
855        uint64_t (*get_dropped_packets)(libtrace_t *trace);
856
857        /** Returns statistics about a trace.
858         *
859         * @param trace The libtrace object
860         * @param stat [in,out] A statistics structure ready to be filled
861         *
862         * The filtered and accepted statistics will be set to the values
863         * stored in the library. All other statistics are not set.
864         *
865         * @note If filtering of packets is performed by a trace and the number
866         * of filtered packets is unknown this should be marked as invalid by
867         * the format.
868         */
869        void (*get_statistics)(libtrace_t *trace, libtrace_stat_t *stat);
870       
871        /** Returns the file descriptor used by the input trace.
872         *
873         * @param trace         The input trace to get the file descriptor for
874         * @return The file descriptor used by the input trace to read packets
875         *
876         */
877        int (*get_fd)(const libtrace_t *trace);
878       
879        /** Returns the next libtrace event for the input trace.
880         *
881         * @param trace         The input trace to get the next event from
882         * @param packet        A libtrace packet to read a packet into
883         * @return A libtrace event describing the event that occured
884         *
885         * The event API allows for non-blocking reading of packets from an
886         * input trace. If a packet is available and ready to be read, a packet
887         * event should be returned. Otherwise a sleep or fd event should be
888         * returned to indicate that the caller needs to wait. If the input
889         * trace has an error or reaches EOF, a terminate event should be
890         * returned.
891         */
892        struct libtrace_eventobj_t (*trace_event)(libtrace_t *trace, libtrace_packet_t *packet);       
893
894        /** Prints some useful help information to standard output. */
895        void (*help)(void);
896       
897        /** Next pointer, should always be NULL - used by the format module
898         * manager. */
899        struct libtrace_format_t *next;
900
901        /** Holds information about the trace format */
902        struct libtrace_info_t info;
903
904        /**
905         * Starts or unpauses an input trace in parallel mode - note that
906         * this function is often the one that opens the file or device for
907         * reading.
908         *
909         * @param libtrace      The input trace to be started or unpaused
910         * @return 0 upon success.
911         *         Otherwise in event of an error -1 is returned.
912         *
913         */
914        int (*pstart_input)(libtrace_t *trace);
915       
916        /**
917         * Read a batch of packets from the input stream related to thread.
918         * At most read nb_packets, however should return with less if packets
919         * are not waiting. However still must return at least 1, 0 still indicates
920         * EOF.
921         *
922         * @param libtrace      The input trace
923         * @param t     The thread
924         * @param packets       An array of packets
925         * @param nb_packets    The number of packets in the array (the maximum to read)
926         * @return The number of packets read, or 0 in the case of EOF or -1 in error or -2 to represent
927         * interrupted due to message waiting before packets had been read.
928         */
929        int (*pread_packets)(libtrace_t *trace, libtrace_thread_t *t, libtrace_packet_t **packets, size_t nb_packets);
930       
931        /** Pause a parallel trace
932         *
933         * @param libtrace      The input trace to be paused
934         */
935        int (*ppause_input)(libtrace_t *trace);
936       
937        /** Called after all threads have been paused, Finish (close) a parallel trace
938         *
939         * @param libtrace      The input trace to be stopped
940         */
941        int (*pfin_input)(libtrace_t *trace);
942
943        /**
944         * Register a thread for use with the format or using the packets produced
945         * by it. This is NOT only used for threads reading packets in fact all
946         * threads use this.
947         *
948         * The libtrace lock is not held by this format but can be aquired
949         * by the format.
950         *
951         * Some use cases include setting up any thread local storage required for
952         * to read packets and free packets. For DPDK we require any thread that
953         * may release or read a packet to have have an internal number associated
954         * with it.
955         *
956         * The thread type can be used to see if this thread is going to be used
957         * to read packets or otherwise.
958         *
959         * @return 0 if successful, -1 if the option is unsupported or an error
960         * occurs (such as a maximum of threads being reached)
961         */
962        int (*pregister_thread)(libtrace_t *libtrace, libtrace_thread_t *t, bool reader);
963
964        /**
965         * If needed any memory allocated with pregister_thread can be released
966         * in this function. The thread will be destroyed directly after this
967         * function is called.
968         */
969        void (*punregister_thread)(libtrace_t *libtrace, libtrace_thread_t *t);
970
971        /** Returns statistics for a single thread.
972         *
973         * @param trace The libtrace object
974         * @param t The thread to return statistics for
975         * @param stat [in,out] A statistics structure ready to be filled
976         *
977         * The filtered and accepted statistics will be set to the values
978         * stored in the library. All other statistics are not set.
979         *
980         * @note If filtering of packets is performed by a trace and the number
981         * of filtered packets is unknown this should be marked as invalid by
982         * the format.
983         */
984        void (*get_thread_statistics)(libtrace_t *libtrace,
985                                      libtrace_thread_t *t,
986                                      libtrace_stat_t *stat);
987};
988
989/** Macro to zero out a single thread format */
990#define NON_PARALLEL(live) \
991        {live, 1},              /* trace info */ \
992        NULL,                   /* pstart_input */ \
993        NULL,                   /* pread_packet */ \
994        NULL,                   /* ppause_input */ \
995        NULL,                   /* pfin_input */ \
996        NULL,                   /* pregister_thread */ \
997        NULL,                   /* punregister_thread */ \
998        NULL,                   /* get_thread_statistics */
999
1000/** The list of registered capture formats */
1001//extern struct libtrace_format_t *form;
1002
1003/** Specifies whether any blocking packet readers should cease reading
1004 * immediately
1005 */
1006extern volatile int libtrace_halt;
1007
1008/**
1009 * Used by a format to check if trace_interrupt or if a trace_pause/stop has
1010 * been called. Provides backwards compatibility with traditional read
1011 * functions when trace_read_packet() is used by the parallel API.
1012 *
1013 * Returns -1 if not halting otherwise returns the code that the read
1014 * operation should pass on.
1015 */
1016static inline int is_halted(libtrace_t *trace) {
1017        if (!(libtrace_halt || trace->state == STATE_PAUSING)) {
1018                return -1;
1019        } else if (libtrace_halt) {
1020                return READ_EOF;
1021        } else {
1022                return READ_MESSAGE;
1023        }
1024}
1025
1026/** Registers a new capture format module.
1027 *
1028 * @param format        The format module to be registered
1029 */
1030void register_format(struct libtrace_format_t *format);
1031
1032/** Converts a timeval into a timestamp in microseconds since the epoch.
1033 *
1034 * @param tv    The timeval to be converted.
1035 * @return A 64 bit timestamp in microseconds since the epoch.
1036 */
1037uint64_t tv_to_usec(const struct timeval *tv);
1038
1039/** Converts a PCAP DLT into a libtrace link type.
1040 *
1041 * @param linktype      The PCAP DLT to be converted
1042 * @return The libtrace link type that is equivalent to the provided DLT, or
1043 * -1 if the DLT is unknown
1044 */
1045libtrace_linktype_t pcap_linktype_to_libtrace(libtrace_dlt_t linktype);
1046
1047/** Converts a PCAP DLT into an RT protocol type.
1048 *
1049 * @param linktype      The PCAP DLT to be converted
1050 * @return The RT type that is equivalent to the provided DLT
1051 */
1052libtrace_rt_types_t pcap_linktype_to_rt(libtrace_dlt_t linktype);
1053
1054/** Converts a PCAP-NG DLT into an RT protocol type.
1055 *
1056 * @param linktype      The PCAP DLT to be converted
1057 * @return The RT type that is equivalent to the provided DLT
1058 */
1059libtrace_rt_types_t pcapng_linktype_to_rt(libtrace_dlt_t linktype);
1060
1061/** Converts a libtrace link type into a PCAP linktype.
1062 *
1063 * @param type          The libtrace link type to be converted
1064 * @return The PCAP linktype that is equivalent to the provided libtrace link
1065 * type, or -1 if the link type is unknown
1066 */
1067libtrace_dlt_t libtrace_to_pcap_linktype(libtrace_linktype_t type);
1068
1069/** Converts a libtrace link type into a PCAP DLT.
1070 *
1071 * @param type          The libtrace link type to be converted
1072 * @return The PCAP DLT that is equivalent to the provided libtrace link
1073 * type, or -1 if the link type is unknown
1074 */
1075libtrace_dlt_t libtrace_to_pcap_dlt(libtrace_linktype_t type);
1076
1077/** Converts an RT protocol type into a PCAP DLT.
1078 *
1079 * @param rt_type       The RT type to be converted
1080 * @return The PCAP DLT that is equivalent to the provided RT protocol
1081 */
1082libtrace_dlt_t rt_to_pcap_linktype(libtrace_rt_types_t rt_type);
1083
1084/** Converts a PCAP DLT into an RT protocol type for the BPF format.
1085 *
1086 * @param linktype      The PCAP DLT to be converted
1087 * @return The RT type that is equivalent to the provided DLT for BPF
1088 */
1089libtrace_rt_types_t bpf_linktype_to_rt(libtrace_dlt_t linktype);
1090
1091/** Converts an ERF type into a libtrace link type.
1092 *
1093 * @param erf           The ERF type to be converted
1094 * @return The libtrace link type that is equivalent to the provided ERF type,
1095 * or -1 if the ERF type is unknown
1096 */
1097libtrace_linktype_t erf_type_to_libtrace(uint8_t erf);
1098
1099/** Converts a libtrace link type into an ERF type.
1100 *
1101 * @param linktype      The libtrace link type to be converted
1102 * @return The ERF type that is equivalent to the provided libtrace link type,
1103 * or -1 if the link type cannot be matched to an ERF type.
1104 */
1105uint8_t libtrace_to_erf_type(libtrace_linktype_t linktype);
1106
1107/** Converts an ARPHRD type into a libtrace link type.
1108 *
1109 * @param arphrd        The ARPHRD type to be converted
1110 * @return The libtrace link type that is equivalent to the provided ARPHRD
1111 * type, or -1 if the ARPHRD type is unknown
1112 */
1113libtrace_linktype_t arphrd_type_to_libtrace(unsigned int arphrd);
1114
1115/** Converts a libtrace link type into an ARPHRD type.
1116 *
1117 * @param type          The libtrace link type to be converted
1118 * @return The ARPHRD type that is equivalent to the provided libtrace link
1119 * type, or -1 if the link type cannot be matched to an ARPHRD type
1120 */
1121unsigned int libtrace_to_arphrd_type(libtrace_linktype_t type);
1122
1123/** Converts a libtrace packet to the Linux SLL type.
1124 *
1125 * @param packet        The packet to be promoted
1126 *
1127 * @note This will involve memcpy() so use sparingly.
1128 *
1129 * This function prepends a Linux SLL header to a packet so that we can store
1130 * direction tagging information.
1131 */
1132void promote_packet(libtrace_packet_t *packet);
1133
1134/** Attempts to demote a packet by removing the first header.
1135 *
1136 * @param packet        The packet to be demoted
1137 * @return True if the packet was demoted, false otherwise.
1138 *
1139 * Essentially the opposite of promote_packet, except that it will also remove
1140 * an ATM header as well as Linux SLL.
1141 *
1142 */
1143bool demote_packet(libtrace_packet_t *packet);
1144
1145/** Returns a pointer to the header following a Linux SLL header.
1146 *
1147 * @param link          A pointer to the Linux SLL header to be skipped
1148 * @param[out] arphrd_type      The arp hardware type of the packet
1149 * @param[out] next_header      The ethertype of the next header
1150 * @param[in,out] remaining     Updated with the number of captured bytes
1151 *                              remaining
1152 * @return A pointer to the header following the Linux SLL header, or NULL if
1153 * no subsequent header is present.
1154 *
1155 * Remaining must point to the number of bytes captured from the Linux SLL
1156 * header and beyond.  It will be decremented by the number of bytes skipped
1157 * to find the payload.
1158 *
1159 * If the Linux SLL header is complete but there are zero bytes of payload
1160 * after the end of the header, a pointer to where the payload would be is
1161 * returned and remaining will be set to zero. If the Linux SLL header is
1162 * incomplete (truncated), then NULL is returned and remaining will be set to
1163 * 0. Therefore, it is very important to check the value of remaining after
1164 * calling this function.
1165 */     
1166void *trace_get_payload_from_linux_sll(const void *link,
1167                uint16_t *arphrd_type, 
1168                uint16_t *next_header, 
1169                uint32_t *remaining);
1170
1171/** Returns a pointer to the header following an ATM header.
1172 *
1173 * @param link          A pointer to the ATM header to be skipped
1174 * @param[out] type     The ethertype of the next header
1175 * @param[in,out] remaining     Updated with the number of captured bytes
1176 *                              remaining
1177 * @return A pointer to the header following the ATM header, or NULL if
1178 * no subsequent header is present.
1179 *
1180 * Remaining must point to the number of bytes captured from the ATM header
1181 * and beyond.  It will be decremented by the number of bytes skipped to find
1182 * the payload.
1183 *
1184 * If the ATM header is complete but there are zero bytes of payload
1185 * after the end of the header, a pointer to where the payload would be is
1186 * returned and remaining will be set to zero. If the ATM header is
1187 * incomplete (truncated), then NULL is returned and remaining will be set to
1188 * 0. Therefore, it is very important to check the value of remaining after
1189 * calling this function.
1190 */     
1191DLLEXPORT void *trace_get_payload_from_atm(void *link, uint8_t *type, 
1192                uint32_t *remaining);
1193
1194
1195#ifdef HAVE_BPF
1196/* A type encapsulating a bpf filter
1197 * This type covers the compiled bpf filter, as well as the original filter
1198 * string
1199 *
1200 */
1201
1202/** Internal representation of a BPF filter */
1203struct libtrace_filter_t {
1204        struct bpf_program filter;      /**< The BPF program itself */
1205        char * filterstring;            /**< The filter string */
1206        int flag;                       /**< Indicates if the filter is valid */
1207        struct bpf_jit_t *jitfilter;
1208};
1209#else
1210/** BPF not supported by this system, but we still need to define a structure
1211 * for the filter */
1212struct libtrace_filter_t {};
1213#endif
1214
1215/** Local definition of a PCAP header */
1216typedef struct libtrace_pcapfile_pkt_hdr_t {
1217        uint32_t ts_sec;        /* Seconds portion of the timestamp */
1218        uint32_t ts_usec;       /* Microseconds portion of the timestamp */
1219        uint32_t caplen;        /* Capture length of the packet */
1220        uint32_t wirelen;       /* The wire length of the packet */
1221} libtrace_pcapfile_pkt_hdr_t;
1222
1223#ifdef HAVE_DAG
1224/** Constructor for the DAG format module */
1225void dag_constructor(void);
1226#endif
1227/** Constructor for the ERF format module */
1228void erf_constructor(void);
1229/** Constructor for the TSH format module */
1230void tsh_constructor(void);
1231/** Constructor for the Legacy DAG format module */
1232void legacy_constructor(void);
1233/** Constructor for the Linux Native format module */
1234void linuxnative_constructor(void);
1235/** Constructor for the Linux Ring format module */
1236void linuxring_constructor(void);
1237/** Constructor for the PCAP format module */
1238void pcap_constructor(void);
1239/** Constructor for the PCAP File format module */
1240void pcapfile_constructor(void);
1241/** Constructor for the PCAP-NG File format module */
1242void pcapng_constructor(void);
1243/** Constructor for the RT format module */
1244void rt_constructor(void);
1245/** Constructor for the DUCK format module */
1246void duck_constructor(void);
1247/** Constructor for the ATM Header format module */
1248void atmhdr_constructor(void);
1249/** Constructor for the network DAG format module */
1250void ndag_constructor(void);
1251/** Constructor for the live ETSI over TCP format module */
1252void etsilive_constructor(void);
1253#ifdef HAVE_BPF
1254/** Constructor for the BPF format module */
1255void bpf_constructor(void);
1256#endif
1257#if HAVE_DPDK
1258/** Constructor for Intels DPDK format module */
1259void dpdk_constructor(void);
1260
1261/** Constructor for receiving network DAG via Intels DPDK format module */
1262void dpdkndag_constructor(void);
1263
1264#endif
1265
1266/** Extracts the RadioTap flags from a wireless link header
1267 *
1268 * @param link          A pointer to the wireless link header
1269 * @param linktype      The link type of the wireless header
1270 * @param[out] flags    Space to store the extracted flags
1271 * @return True if libtrace was able to extract flags from the link header,
1272 * false otherwise.
1273 *
1274 * This function has been left internal because it is not portable across
1275 * drivers.
1276 */
1277bool trace_get_wireless_flags(void *link, libtrace_linktype_t linktype, uint8_t *flags);
1278#define TRACE_RADIOTAP_F_FCS 0x10
1279       
1280#ifdef __cplusplus
1281}
1282#endif
1283
1284#endif /* LIBTRACE_INT_H */
Note: See TracBrowser for help on using the repository browser.