source: lib/format_duck.c @ c66068d

/*
 * This file is part of libtrace
 *
 * Copyright (c) 2007,2008 The University of Waikato, Hamilton, New Zealand.
 * Authors: Daniel Lawson 
 *          Perry Lorier 
 *          
 * 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 "libtrace.h"
#include "libtrace_int.h"
#include "format_helper.h"
#include "config.h"
#include "wandio.h"
#include <stdlib.h>
#include "libtraceio.h"
#include "rt_protocol.h"

#include <errno.h>
#include <assert.h>
#include <stdio.h>
#include <fcntl.h>

#define DATA(x) ((struct duck_format_data_t *)x->format_data)
#define DATAOUT(x) ((struct duck_format_data_out_t *)x->format_data)

#define INPUT DATA(libtrace)
#define OUTPUT DATAOUT(libtrace)

struct duck_format_data_t {
        char *path;
        io_t *file;
        int dag_version;
};

struct duck_format_data_out_t {
        char *path;
        int level;
        int fileflag;
        iow_t *file;
        int dag_version;        
};

static int duck_init_input(libtrace_t *libtrace) {
        libtrace->format_data = malloc(sizeof(struct duck_format_data_t));

        INPUT->file = 0;
        INPUT->dag_version = 0;
        return 0;
}

static int duck_init_output(libtrace_out_t *libtrace) {
        libtrace->format_data = malloc(sizeof(struct duck_format_data_out_t));
        
        OUTPUT->level = 0;
        OUTPUT->fileflag = O_CREAT | O_WRONLY;
        OUTPUT->file = 0;
        OUTPUT->dag_version = 0;
        return 0;
}

static int duck_config_output(libtrace_out_t *libtrace, 
                                trace_option_output_t option,
                                void *data) {
        switch (option) {
                case TRACE_OPTION_OUTPUT_COMPRESS:
                        OUTPUT->level = *(int *)data;
                        return 0;
                case TRACE_OPTION_OUTPUT_FILEFLAGS:
                        OUTPUT->fileflag = *(int *)data;
                        return 0;
                default:
                        trace_set_err_out(libtrace, TRACE_ERR_UNKNOWN_OPTION,
                                        "Unknown option");
                        return -1;
        }
        assert(0);
}

static int duck_start_input(libtrace_t *libtrace) {
        
        if (INPUT->file)
                /* File already open */
                return 0;
        
        INPUT->file = trace_open_file(libtrace);
        if (!INPUT->file)
                return -1;

        return 0;
}

static int duck_start_output(libtrace_out_t *libtrace) {
        OUTPUT->file = trace_open_file_out(libtrace, OUTPUT->level,
                                                OUTPUT->fileflag);
        if (!OUTPUT->file) {
                return -1;
        }
        return 0;
}

static int duck_fin_input(libtrace_t *libtrace) {
        wandio_destroy(INPUT->file);
        free(libtrace->format_data);

        return 0;
}

static int duck_fin_output(libtrace_out_t *libtrace) {
        wandio_wdestroy(OUTPUT->file);
        free(libtrace->format_data);
        return 0;
}

static int duck_prepare_packet(libtrace_t *libtrace, libtrace_packet_t *packet,
                void *buffer, libtrace_rt_types_t rt_type, uint32_t flags) {

        if (packet->buffer != buffer &&
                        packet->buf_control == TRACE_CTRL_PACKET) {
                free(packet->buffer);
        }

        if ((flags & TRACE_PREP_OWN_BUFFER) == TRACE_PREP_OWN_BUFFER) {
                packet->buf_control = TRACE_CTRL_PACKET;
        } else
                packet->buf_control = TRACE_CTRL_EXTERNAL;


        packet->buffer = buffer;
        packet->header = NULL;
        packet->payload = buffer;
        packet->type = rt_type;

        if (libtrace->format_data == NULL) {
                if (duck_init_input(libtrace))
                        return -1;
        }

        return 0;
}

static int duck_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {

        int numbytes = 0;
        uint32_t version = 0;
        unsigned int duck_size;
        uint32_t flags = 0;
        
        if (!packet->buffer || packet->buf_control == TRACE_CTRL_EXTERNAL) {
                packet->buffer = malloc((size_t)LIBTRACE_PACKET_BUFSIZE);
                if (!packet->buffer) {
                        trace_set_err(libtrace, errno,
                                        "Cannot allocate memory");
                        return -1;
                }
        }

        flags |= TRACE_PREP_OWN_BUFFER;
        
        if (INPUT->dag_version == 0) {
                /* Read in the duck version from the start of the trace */
                if ((numbytes = wandio_read(INPUT->file, &version, 
                                        sizeof(version))) != sizeof(uint32_t)) {
                        trace_set_err(libtrace, errno, 
                                        "Reading DUCK version failed");
                        return -1;
                }
                if (numbytes == 0) {
                        return 0;
                }
                INPUT->dag_version = bswap_le_to_host32(version);
        }
        

        if (INPUT->dag_version == TRACE_RT_DUCK_2_4) {
                duck_size = sizeof(duck2_4_t);
                packet->type = TRACE_RT_DUCK_2_4;
        } else if (INPUT->dag_version == TRACE_RT_DUCK_2_5) {
                duck_size = sizeof(duck2_5_t);
                packet->type = TRACE_RT_DUCK_2_5;
        } else {
                trace_set_err(libtrace, TRACE_ERR_BAD_PACKET,
                                "Unrecognised DUCK version %i", 
                                INPUT->dag_version);
                return -1;
        }

        if ((numbytes = wandio_read(INPUT->file, packet->buffer,
                                        (size_t)duck_size)) != (int)duck_size) {
                if (numbytes == -1) {
                        trace_set_err(libtrace, errno, "Reading DUCK failed");
                        return -1;
                }
                else if (numbytes == 0) {
                        return 0;
                }
                else {
                        trace_set_err(libtrace, TRACE_ERR_BAD_PACKET, "Truncated DUCK packet");
                }
        }

        if (duck_prepare_packet(libtrace, packet, packet->buffer, packet->type,
                                flags)) 
                return -1;
        
        return numbytes;
}

static int duck_write_packet(libtrace_out_t *libtrace, 
                libtrace_packet_t *packet) 
{

        int numbytes = 0;
        if (packet->type != TRACE_RT_DUCK_2_4 
                        && packet->type != TRACE_RT_DUCK_2_5) {
                trace_set_err_out(libtrace, TRACE_ERR_BAD_PACKET,
                                "Only DUCK packets may be written to a DUCK file");
                return -1;
        }
        
        assert(OUTPUT->file);

        if (OUTPUT->dag_version == 0) {
        /* Writing the DUCK version will help with reading it back in later! */
                if ((numbytes = wandio_wwrite(OUTPUT->file, &packet->type,
                                sizeof(packet->type))) != sizeof(uint32_t)){
                        trace_set_err_out(libtrace, errno, 
                                        "Writing DUCK version failed");
                        return -1;
                }
                OUTPUT->dag_version = packet->type;
        }
        
        if ((numbytes = wandio_wwrite(OUTPUT->file, packet->payload, 
                                        trace_get_capture_length(packet))) !=
                                (int)trace_get_capture_length(packet)) {
                trace_set_err_out(libtrace, errno, "Writing DUCK failed");
                return -1;
        }
        return numbytes;
}

static int duck_get_capture_length(const libtrace_packet_t *packet) {
        switch(packet->type) {
                case TRACE_RT_DUCK_2_4:
                        return sizeof(duck2_4_t);
                case TRACE_RT_DUCK_2_5:
                        return sizeof(duck2_5_t);
                default:
                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
                                        "Not a duck packet");
                        return -1;
        }
        return 0;
}

static int duck_get_framing_length(const libtrace_packet_t *packet UNUSED) 
{
        return 0;
}

static int duck_get_wire_length(const libtrace_packet_t *packet UNUSED) 
{
        return 0;
}

static libtrace_linktype_t duck_get_link_type(
                                const libtrace_packet_t *packet UNUSED) 
{
        return TRACE_TYPE_DUCK;
}

static void duck_help(void) {
        printf("Endace DUCK format module\n");
        printf("Supported input uris:\n");
        printf("\tduck:/path/to/input/file\n");
        printf("Supported output uris:\n");
        printf("\tduck:/path/to/output/file\n");
        printf("\n");
        return;
}
static struct libtrace_format_t duck = {
        "duck",
        "$Id$",
        TRACE_FORMAT_DUCK,
        duck_init_input,                /* init_input */
        NULL,                           /* config_input */
        duck_start_input,               /* start_input */
        NULL,                           /* pause_input */
        duck_init_output,               /* init_output */
        duck_config_output,             /* config_output */
        duck_start_output,              /* start_output */
        duck_fin_input,                 /* fin_input */
        duck_fin_output,                /* fin_output */
        duck_read_packet,               /* read_packet */
        duck_prepare_packet,            /* prepare_packet */
        NULL,                           /* fin_packet */
        duck_write_packet,              /* write_packet */
        duck_get_link_type,             /* get_link_type */
        NULL,                           /* get_direction */
        NULL,                           /* set_direction */
        NULL,                           /* get_erf_timestamp */
        NULL,                           /* get_timeval */
        NULL,                           /* get_seconds */
        NULL,                           /* seek_erf */
        NULL,                           /* seek_timeval */
        NULL,                           /* seek_seconds */
        duck_get_capture_length,        /* get_capture_length */
        duck_get_wire_length,           /* get_wire_length */
        duck_get_framing_length,        /* get_framing_length */
        NULL,                           /* set_capture_length */
        NULL,                           /* get_received_packets */
        NULL,                           /* get_filtered_packets */
        NULL,                           /* get_dropped_packets */
        NULL,                           /* get_captured_packets */
        NULL,                           /* get_fd */
        NULL,                           /* trace_event */
        duck_help,                      /* help */
        NULL                            /* next pointer */
};

void duck_constructor(void) {
        register_format(&duck);
}