source: trunk/lib/format_helper.c @ 1700

/*
 * This file is part of libtrace
 *
 * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton, 
 * New Zealand.
 *
 * Authors: Daniel Lawson 
 *          Perry Lorier
 *          Shane Alcock 
 *          
 * All rights reserved.
 *
 * This code has been developed by the University of Waikato WAND 
 * research group. For further information please see http://www.wand.net.nz/
 *
 * libtrace is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * libtrace is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libtrace; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * $Id$
 *
 */

#include "config.h"
#include <sys/types.h>
#include <fcntl.h> /* for O_LARGEFILE */
#include <math.h>
#include "libtrace.h"
#include "libtrace_int.h"
#include "wandio.h"

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <time.h>
#include "format_helper.h"

#include <assert.h>
#include <stdarg.h>

#ifdef WIN32
#  include <io.h>
#  include <share.h>
#  include <sys/timeb.h>

struct libtrace_eventobj_t trace_event_device(struct libtrace_t *trace, struct libtrace_packet_t *packet) {
    struct libtrace_eventobj_t event = {0,0,0.0,0};

    trace_set_err(trace,TRACE_ERR_OPTION_UNAVAIL, "trace_event() is not "
            "supported on devices under windows in this version");

    event.type = TRACE_EVENT_TERMINATE;
    return event;
}
#else
#  include <sys/ioctl.h>

/* Generic event function for live capture devices / interfaces */
struct libtrace_eventobj_t trace_event_device(struct libtrace_t *trace, 
                                        struct libtrace_packet_t *packet) {
        struct libtrace_eventobj_t event = {0,0,0.0,0};

        fd_set rfds, rfds_param;
        int ret;
        int max_fd;
        struct timeval tv;

        assert(trace != NULL);
        assert(packet != NULL);
        
        FD_ZERO(&rfds);
        FD_ZERO(&rfds_param);

        if (trace->format->get_fd) {
                event.fd = trace->format->get_fd(trace);
                FD_SET(event.fd, &rfds);
                max_fd = event.fd;
        } else {
                event.fd = 0;
                max_fd = -1;
        }

        /* Use select() to perform a quick poll to check that there is data
         * available - we used to use FIONREAD here but that does not work
         * for mmapped pcap sockets. As recent pcap on linux (e.g. Ubuntu 9.04)
         * uses mmapped sockets by default, I've switched over to this 
         * solution. */

        do {
                tv.tv_sec = 0;
                tv.tv_usec = 0;
                rfds_param = rfds;

                ret = select(max_fd + 1, &rfds_param, NULL, NULL, &tv);
                if (ret == -1 && errno != EINTR) {
                        event.type = TRACE_EVENT_TERMINATE;
                        return event;
                }
        } while (ret == -1);

        if (FD_ISSET(event.fd, &rfds_param)) {
                event.size = trace_read_packet(trace,packet);
                
                if (event.size < 1) {
                        /* Covers error and EOF events - terminate rather 
                         * than report a packet as available */
                        if (trace_is_err(trace)) {
                                trace_perror(trace, "read packet");
                        }
                        event.type = TRACE_EVENT_TERMINATE;
                } else {

                        event.type = TRACE_EVENT_PACKET;
                }
                return event;
        }
        event.type= TRACE_EVENT_IOWAIT;
        return event;
}
#endif

/* Generic event function for trace files */ 
struct libtrace_eventobj_t trace_event_trace(struct libtrace_t *trace, struct libtrace_packet_t *packet) {
        struct libtrace_eventobj_t event = {0,0,0.0,0};
        double ts;
        double now;
#ifdef WIN32
        struct __timeb64 tstruct;
#else
        struct timeval stv;
#endif

        if (!trace->event.packet) {
                trace->event.packet = trace_create_packet();
        }

        if (!trace->event.waiting) {
                /* There is no packet event waiting for us, so create a new
                 * libtrace packet in the event structure and read the next
                 * packet into that.
                 *
                 * If a SLEEP event is reported this time around, the read
                 * packet can therefore be saved until the next time this
                 * function is called. */

                trace->event.psize=
                        trace_read_packet(trace,trace->event.packet);
                if (trace->event.psize<1) {
                        /* Return here, the test for event.size will sort out 
                         * the error  */
                        if (trace_is_err(trace)) {
                                trace_perror(trace, "read packet");
                        }
                        event.type = TRACE_EVENT_TERMINATE;
                        trace_destroy_packet(trace->event.packet);
                        trace->event.packet = NULL;
                        packet->buffer = NULL;
                        packet->header = NULL;
                        packet->payload = NULL;
                        packet->buf_control = TRACE_CTRL_EXTERNAL;
                        return event;
                }
        }

        /* The goal here is to replicate the inter-packet gaps that are
         * present in the trace. */

        ts=trace_get_seconds(trace->event.packet);

        /* Get the current walltime */
#ifdef WIN32
        _ftime64(&tstruct);
        now = tstruct.time + 
                ((double)tstruct.millitm / 1000.0);
#else
        gettimeofday(&stv, NULL);
        now = stv.tv_sec + 
                ((double)stv.tv_usec / 1000000.0);
#endif

        
        if (fabs(trace->event.tdelta)>1e-9) {
                /* Subtract the tdelta from the walltime to get a suitable
                 * "relative" time */
                now -= trace->event.tdelta; 

                /* If the trace timestamp is still in the future, return a 
                 * SLEEP event, otherwise return the packet */
                if (ts > now) {
                        event.seconds = ts - 
                                trace->event.trace_last_ts;
                        trace->event.trace_last_ts = ts;
                        event.type = TRACE_EVENT_SLEEP;
                        trace->event.waiting = true;
                        return event;
                }
        } else {
                /* Work out the difference between the walltime at the start 
                 * of the trace replay and the timestamp of the first packet 
                 * in the trace. This will be used to convert the walltime
                 * into a timeline that is relative to the timestamps in the
                 * trace file.
                 */
                trace->event.tdelta = now - ts;
        }

        /* This is the first packet, so just fire away. */
        /* TODO: finalise packet */
        
        /* XXX: Could we do this more efficiently? */

        /* We do a lot of freeing and creating of packet buffers with this
         * method, but at least it works unlike what was here previously */
        //if (packet->buf_control == TRACE_CTRL_PACKET) {
        //      free(packet->buffer);
        //}
        
        /* The packet that we had read earlier is now ready to be returned
         * to the user - switch all the pointers etc. over */   
        packet->type = trace->event.packet->type;
        packet->trace = trace->event.packet->trace;
        packet->header = trace->event.packet->header;
        packet->payload = trace->event.packet->payload;
        
        packet->buffer = trace->event.packet->buffer;
        packet->buf_control = trace->event.packet->buf_control;

        //trace->event.packet->buffer = NULL;
        //trace->event.packet->buf_control = TRACE_CTRL_EXTERNAL;
        
        //trace_destroy_packet(trace->event.packet);
        //trace->event.packet = NULL;

        event.type = TRACE_EVENT_PACKET;

        trace->event.trace_last_ts = ts;
        trace->event.waiting = false;

        return event;
}

/* Catch undefined O_LARGEFILE on *BSD etc */
#ifndef O_LARGEFILE
#  define O_LARGEFILE 0
#endif 

/* Catching O_BINARY on all sane OS's */
#ifndef O_BINARY
#  define O_BINARY 0
#endif

/* Open a file for reading using the new Libtrace IO system */
io_t *trace_open_file(libtrace_t *trace)
{
        io_t *io=wandio_create(trace->uridata);
        if (!io) {
                trace_set_err(trace,errno,"Unable to open %s",trace->uridata);
        }
        return io;
}

/* Open a file for writing using the new Libtrace IO system */ 
iow_t *trace_open_file_out(libtrace_out_t *trace, int compress_type, int level, int fileflag)
{
        assert(level<10);
        assert(level>=0);

        return wandio_wcreate(trace->uridata, compress_type, level, fileflag);
}


/** Sets the error status for an input trace
 * @param errcode either an Econstant from libc, or a LIBTRACE_ERROR
 * @param msg a plaintext error message
 * @internal
 */
void trace_set_err(libtrace_t *trace,int errcode,const char *msg,...)
{
        char buf[256];
        va_list va;
        va_start(va,msg);
        assert(errcode != 0 && "An error occurred, but it is unknown what it is");
        trace->err.err_num=errcode;
        if (errcode>0) {
                vsnprintf(buf,sizeof(buf),msg,va);
                snprintf(trace->err.problem,sizeof(trace->err.problem),
                                "%s: %s",buf,strerror(errcode));
        } else {
                vsnprintf(trace->err.problem,sizeof(trace->err.problem),
                                msg,va);
        }
        va_end(va);
}

/** Sets the error status for an output trace
 * @param errcode either an Econstant from libc, or a LIBTRACE_ERROR
 * @param msg a plaintext error message
 * @internal
 */
void trace_set_err_out(libtrace_out_t *trace,int errcode,const char *msg,...)
{
        char buf[256];
        va_list va;
        va_start(va,msg);
        assert(errcode != 0 && "An error occurred, but it is unknown what it is");
        trace->err.err_num=errcode;
        if (errcode>0) {
                vsnprintf(buf,sizeof(buf),msg,va);
                snprintf(trace->err.problem,sizeof(trace->err.problem),
                                "%s: %s",buf,strerror(errno));
        } else {
                vsnprintf(trace->err.problem,sizeof(trace->err.problem),
                                msg,va);
        }
        va_end(va);
}

/* Byte swapping functions for various inttypes */
uint64_t byteswap64(uint64_t num)
{
        return (byteswap32((num&0xFFFFFFFF00000000ULL)>>32))
              |((uint64_t)byteswap32(num&0x00000000FFFFFFFFULL)<<32);
}

uint32_t byteswap32(uint32_t num)
{
        return ((num&0x000000FFU)<<24)
                | ((num&0x0000FF00U)<<8)
                | ((num&0x00FF0000U)>>8)
                | ((num&0xFF000000U)>>24);
}

uint16_t byteswap16(uint16_t num)
{
        return ((num<<8)&0xFF00)|((num>>8)&0x00FF);
}