Ethereal-dev: [Ethereal-dev] [Patches] Wiretap support for Catapult DCT2000 .out files

Note: This archive is from the project's previous web site, ethereal.com. This list is no longer active.

From: Martin Mathieson <martin.mathieson@xxxxxxxxxxxx>
Date: Wed, 12 Apr 2006 18:14:27 +0100
Hi,

This attached patch and new files provide support for Catapult DCT2000 .out files to wiretap and ethereal.

This wiretap support (catapult_dct2000.c+h) appends a short header to each packet giving some context, and a corresponding ethereal dissector (packet-catapult-dct2000.c) parses this before passing the real payload onto an existing ethereal dissector (for ethernet, ip, lapd, ppp, frame-relay,...).

For now, there is only support for saving dct2000 files in their own format, although I may add support for converting between dct2000 and libpcap later.

I've also attached a short capture file (test.out) used to test each of the supported link-type protocols. I know some of these messages show as malformed (they are mostly taken from low-level protocol tests), but they are enough to illustrate/verify the mapping between DCT2000 protocols and ethereal dissectors.

I've tested this with quite a few test files (I work at Catapult), and reading/writing/merging works well for me. I've also done some testing with mergecap and editcap (encap string is "dct2000") which seems to work. This is the first wiretap module I've added, so any comments/suggestions are very welcome.

Best regards,
Martin

P.S. the diff file contains small, unrelated RTCP dissector changes, could these please be applied too...?


Index: epan/dissectors/Makefile.common
===================================================================
--- epan/dissectors/Makefile.common	(revision 17846)
+++ epan/dissectors/Makefile.common	(working copy)
@@ -134,6 +134,7 @@
 	packet-bvlc.c	\
 	packet-camel.c	\
 	packet-cast.c	\
+	packet-catapult-dct2000.c	\
 	packet-ccsds.c	\
 	packet-cdp.c	\
 	packet-cdt.c	\
Index: epan/dissectors/packet-atm.c
===================================================================
--- epan/dissectors/packet-atm.c	(revision 17846)
+++ epan/dissectors/packet-atm.c	(working copy)
@@ -959,6 +959,15 @@
   proto_tree_add_uint(atm_tree, hf_atm_vci, tvb, 0, 0,
 		pinfo->pseudo_header->atm.vci);
 
+  /* Also show vpi/vci in info column */
+  if (check_col(pinfo->cinfo, COL_INFO))
+  {
+      col_append_fstr(pinfo->cinfo, COL_INFO, " VPI=%u, VCI=%u",
+                      pinfo->pseudo_header->atm.vpi,
+                      pinfo->pseudo_header->atm.vci);
+  }
+
+
   next_tvb = tvb;
   if (truncated) {
     /*
@@ -1644,6 +1653,7 @@
 	    "ATM LANE", "lane");
 
 	register_dissector("lane", dissect_lane, proto_atm_lane);
+	register_dissector("atm_untruncated", dissect_atm_untruncated, proto_atm);
 }
 
 void
Index: epan/dissectors/packet-rtcp.c
===================================================================
--- epan/dissectors/packet-rtcp.c	(revision 17846)
+++ epan/dissectors/packet-rtcp.c	(working copy)
@@ -519,9 +519,11 @@
 	packet_type = tvb_get_guint8(tvb, offset + 1);
 
 	/* First packet within compound packet is supposed to be a sender
-	   or receiver report.  Also see BYE so allow this...  */
+	   or receiver report.
+       - allow BYE because this happens anyway
+       - allow APP because TBCP ("PoC1") packets aren't compound... */
 	if (!((packet_type == RTCP_SR)  || (packet_type == RTCP_RR) ||
-           packet_type == RTCP_BYE))
+           packet_type == RTCP_BYE) || (packet_type == RTCP_APP))
 	{
 		return FALSE;
 	}
@@ -2258,7 +2260,7 @@
 				"Last SR timestamp",
 				"rtcp.ssrc.lsr",
 				FT_UINT32,
-				BASE_DEC,
+				BASE_DEC_HEX,
 				NULL,
 				0x0,
 				"", HFILL
Index: wiretap/file_access.c
===================================================================
--- wiretap/file_access.c	(revision 17846)
+++ wiretap/file_access.c	(working copy)
@@ -70,6 +70,7 @@
 #include "hcidump.h"
 #include "network_instruments.h"
 #include "k12.h"
+#include "catapult_dct2000.h"
 
 /* The open_file_* routines should return:
  *
@@ -107,6 +108,7 @@
 	airopeek9_open,
 	dbs_etherwatch_open,
 	k12_open,
+	catapult_dct2000_open,
 	
 	/* Files that don't have magic bytes at a fixed location,
 	 * but that instead require a heuristic of some sort to
@@ -509,6 +511,9 @@
 	{ "IBM iSeries communications trace (UNICODE)", NULL, FALSE,
 	  NULL, NULL },
 
+	/* WTAP_FILE_CATAPULT_DCT2000 */
+	{ "Catapult DCT2000 trace (.out format)", "dct2000", FALSE,
+	  catapult_dct2000_dump_can_write_encap, catapult_dct2000_dump_open },
 };
 
 /* Name that should be somewhat descriptive. */
Index: wiretap/wtap-int.h
===================================================================
--- wiretap/wtap-int.h	(revision 17846)
+++ wiretap/wtap-int.h	(working copy)
@@ -144,6 +144,11 @@
 
 typedef struct _k12_t k12_t;
 
+typedef struct {
+	time_t	start_secs;
+	guint32	start_usecs;
+} catapult_dct2000_t;
+
 typedef gboolean (*subtype_read_func)(struct wtap*, int*, char**, long*);
 typedef gboolean (*subtype_seek_read_func)(struct wtap*, long, union wtap_pseudo_header*,
 					guint8*, int, int *, char **);
@@ -174,6 +179,7 @@
 		airopeek9_t		*airopeek9;
 		erf_t			*erf;
 		k12_t			*k12;
+		catapult_dct2000_t*	catapult_dct2000;
 		void			*generic;
 	} capture;
 
@@ -231,6 +237,10 @@
 	guint32 file_offset;
 } k12_dump_t;
 
+typedef struct {
+    gboolean           first_packet_written;
+    struct wtap_nstime start_time;
+} dct2000_dump_t;
 
 struct wtap_dumper {
 	FILE*			fh;
@@ -248,6 +258,7 @@
 		_5views_dump_t		*_5views;
 		niobserver_dump_t	*niobserver;
 		k12_dump_t		*k12;
+		dct2000_dump_t		*dct2000;
 	} dump;
 
 	subtype_write_func	subtype_write;
Index: wiretap/wtap.c
===================================================================
--- wiretap/wtap.c	(revision 17846)
+++ wiretap/wtap.c	(working copy)
@@ -357,6 +357,9 @@
 
  	/* WTAP_ENCAP_LINUX_LAPD */
  	{ "LAPD", "lapd" },
+
+	/* WTAP_ENCAP_CATAPULT_DCT2000 */
+	{ "Catapult DCT2000", "dct2000" },
 };
 
 /* Name that should be somewhat descriptive. */
Index: wiretap/wtap.h
===================================================================
--- wiretap/wtap.h	(revision 17846)
+++ wiretap/wtap.h	(working copy)
@@ -179,9 +179,10 @@
 #define WTAP_ENCAP_JUNIPER_CHDLC                87
 #define WTAP_ENCAP_JUNIPER_GGSN                 88
 #define WTAP_ENCAP_LINUX_LAPD			89
+#define WTAP_ENCAP_CATAPULT_DCT2000             90
 
 /* last WTAP_ENCAP_ value + 1 */
-#define WTAP_NUM_ENCAP_TYPES			90
+#define WTAP_NUM_ENCAP_TYPES			91
 
 /* File types that can be read by wiretap.
    We support writing some many of these file types, too, so we
@@ -230,9 +231,10 @@
 #define WTAP_FILE_K12				41
 #define WTAP_FILE_ISERIES			42
 #define WTAP_FILE_ISERIES_UNICODE		43
+#define WTAP_FILE_CATAPULT_DCT2000		44
 
 /* last WTAP_FILE_ value + 1 */
-#define WTAP_NUM_FILE_TYPES			44
+#define WTAP_NUM_FILE_TYPES			45
 
 /* timestamp precision (currently only these values are supported) */
 #define WTAP_FILE_TSPREC_SEC		0
@@ -497,6 +499,19 @@
 #define K12_PORT_DS1       0x00100008
 #define K12_PORT_ATMPVC    0x01020000
 
+struct wtap;
+struct catapult_dct2000_phdr
+{
+    long seek_off;
+    struct wtap *wth;
+    union
+    {
+        struct isdn_phdr  isdn;
+        struct atm_phdr   atm;
+        struct p2p_phdr   p2p;
+    } inner_pseudo_header;
+};
+
 struct lapd_phdr {
 	guint16 pkttype;    /* packet type */
 	guint8 we_network;
@@ -516,6 +531,7 @@
 	struct mtp2_phdr        mtp2;
 	struct k12_phdr		k12;
 	struct lapd_phdr	lapd;
+	struct catapult_dct2000_phdr dct2000;
 };
 
 struct wtap_nstime {
Index: wiretap/README
===================================================================
--- wiretap/README	(revision 17846)
+++ wiretap/README	(working copy)
@@ -163,5 +163,17 @@
 from: http://www.users.bigpond.com/dbsneddon/software.htm.
 
 
+Catapult DCT2000 (.out files)
+-----------------------------
+DCT2000 test systems produce ascii text-based .out files for ports
+that have logging enabled. When being read, the data part of the message is
+prefixed with a short header that provides some context (context+port,
+direction, original timestamp, etc).
+
+You can choose to suppress the reading of non-standard protocols
+(i.e. messages between layers rather than the well-known link-level protocols
+usually found on board ports).
+
+
 Gilbert Ramirez <gram@xxxxxxxxxxxxxxx>
 Guy Harris <guy@xxxxxxxxxxxx>
Index: wiretap/Makefile.common
===================================================================
--- wiretap/Makefile.common	(revision 17846)
+++ wiretap/Makefile.common	(working copy)
@@ -34,6 +34,7 @@
 	ascend.c		\
 	atm.c			\
 	buffer.c		\
+	catapult_dct2000.c	\
 	cosine.c		\
 	csids.c			\
 	dbs-etherwatch.c	\
/* catapult_dct2000.h
*
* $Id: k12.h 14682 2005-06-17 17:26:43Z lego $
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@xxxxxxxxxxxxxxx>
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

int catapult_dct2000_open(wtap *wth, int *err, gchar **err_info);
gboolean catapult_dct2000_dump_open(wtap_dumper *wdh, gboolean cant_seek, int *err);
int catapult_dct2000_dump_can_write_encap(int encap);

#define DCT2000_ENCAP_UNHANDLED 0
#define DCT2000_ENCAP_SSCOP     101
/* packet-catapult-dct2000.c
 * Routines for Catapult DCT2000 packet stub header disassembly
 *
 * $Id: packet-sipfrag.c 15270 2005-08-10 13:41:13Z sahlberg $
 *
 * Ethereal - Network traffic analyzer
 * By Gerald Combs <gerald@xxxxxxxxxxxx>
 * Copyright 1998 Gerald Combs
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <string.h>
#include <epan/packet.h>
#include <epan/emem.h>
#include <epan/proto.h>
#include <epan/prefs.h>

#include "../wiretap/catapult_dct2000.h"

/* Protocol and registered fields. */
static int proto_catapult_dct2000 = -1;

static int hf_catapult_dct2000_context = -1;
static int hf_catapult_dct2000_port_number = -1;
static int hf_catapult_dct2000_timestamp = -1;
static int hf_catapult_dct2000_protocol = -1;
static int hf_catapult_dct2000_direction = -1;
static int hf_catapult_dct2000_encap = -1;
static int hf_catapult_dct2000_unparsed_data = -1;

extern gboolean catapult_dct2000_board_ports_only;

/* Protocol subtree. */
static int ett_catapult_dct2000 = -1;

static const value_string direction_vals[] = {
	{ 0,   "Sent" },
	{ 1,   "Received" },
    { 0,   NULL },
};

static const value_string encap_vals[] = {
    { WTAP_ENCAP_RAW_IP,                 "Raw IP" },
    { WTAP_ENCAP_ETHERNET,               "Ethernet" },
    { WTAP_ENCAP_ISDN,                   "LAPD" },
    { WTAP_ENCAP_ATM_PDUS_UNTRUNCATED,   "ATM (PDUs untruncated)" },
    { WTAP_ENCAP_PPP,                    "PPP" },
    { DCT2000_ENCAP_SSCOP,               "SSCOP" },
    { WTAP_ENCAP_FRELAY,                 "Frame Relay" },
    { DCT2000_ENCAP_UNHANDLED,           "Unhandled Protocol" },
    { 0,                                 NULL },
};


/*****************************************/
/* Main dissection function.             */
/*****************************************/
static void
dissect_catapult_dct2000(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
{
    proto_tree	*dct2000_tree;
    proto_item	*ti;
    gint        offset = 0;
    gint        context_length;
    guint8      port_number;
    gint        protocol_start;
    gint        protocol_length;
    gint        timestamp_start;
    gint        timestamp_length;
    guint8      direction;
    tvbuff_t    *next_tvb;
    int         encap;
    union wtap_pseudo_header temp_pseudo_header;
    dissector_handle_t protocol_handle = 0;
    int sub_dissector_result = 0;

    /* Protocol name */
    if (check_col(pinfo->cinfo, COL_PROTOCOL))
    {
        col_add_str(pinfo->cinfo, COL_PROTOCOL, "DCT2000");
    }

    /* Info column */
    if (check_col(pinfo->cinfo, COL_INFO))
    {
        col_clear(pinfo->cinfo, COL_INFO);
    }

    /* Create protocol tree. */
    ti = proto_tree_add_item(tree, proto_catapult_dct2000, tvb, offset, -1, FALSE);
    dct2000_tree = proto_item_add_subtree(ti, ett_catapult_dct2000);

    /* Context Name */
    context_length = tvb_strsize(tvb, offset);
    proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_context, tvb,
                        offset, context_length, FALSE);
    offset += context_length;

    /* Context port number */
    proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_port_number, tvb,
                        offset, 1, FALSE);
    port_number = tvb_get_guint8(tvb, offset);
    offset++;

    /* Timestamp in file */
    timestamp_start = offset;
    timestamp_length = tvb_strsize(tvb, offset);
    proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_timestamp, tvb,
                        offset, timestamp_length, FALSE);
    offset += timestamp_length;


    /* Original protocol name */
    protocol_start = offset;
    protocol_length = tvb_strsize(tvb, offset);
    proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_protocol, tvb,
                        offset, protocol_length, FALSE);
    offset += protocol_length;

    /* Direction */
    direction = tvb_get_guint8(tvb, offset);
    proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_direction, tvb,
                        offset, 1, FALSE);
    offset++;

    /* Read file encap */
    proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_encap, tvb, offset, 1, FALSE);
    encap = tvb_get_guint8(tvb, offset);
    offset++;

    /* Set selection length of dct2000 tree */
    proto_item_set_len(dct2000_tree, offset);

    /* Add useful details to protocol tree label */
    proto_item_append_text(ti, "   context=%s.%u   t=%s   %c   prot=%s",
                           tvb_get_ephemeral_string(tvb, 0, context_length),
                           port_number,
                           tvb_get_ephemeral_string(tvb, timestamp_start, timestamp_length),
                           (direction == 0) ? 'S' : 'R',
                           tvb_get_ephemeral_string(tvb, protocol_start, protocol_length));



    /* Copy pseudo header info stored in dct2000 entry back up to start
       of structure. Use a temp buffer as address ranges will overlap!
    */
    memcpy(&temp_pseudo_header, &(pinfo->pseudo_header->dct2000.inner_pseudo_header),
           sizeof(pinfo->pseudo_header->dct2000.inner_pseudo_header));
    memcpy((pinfo->pseudo_header), &temp_pseudo_header,
           sizeof(pinfo->pseudo_header->dct2000.inner_pseudo_header));


    /***********************************************************************/
    /* Now hand off to the dissector of intended packet encapsulation type */

    /* Get protocol handle, and set p2p_dir where necessary.
       (packet-frame.c won't copy it from pseudo-header because it doesn't
       know about Catapult DCT2000 encap type...)
    */
    switch (encap)
    {
        case WTAP_ENCAP_RAW_IP:
            protocol_handle = find_dissector("ip");
            break;
        case WTAP_ENCAP_ETHERNET:
            protocol_handle = find_dissector("eth_withoutfcs");
            break;
        case WTAP_ENCAP_ISDN:
            protocol_handle = find_dissector("lapd");
            pinfo->p2p_dir = pinfo->pseudo_header->isdn.uton;
            break;
        case WTAP_ENCAP_ATM_PDUS_UNTRUNCATED:
            protocol_handle = find_dissector("atm_untruncated");
            break;
        case WTAP_ENCAP_PPP:
            protocol_handle = find_dissector("ppp_hdlc");
            pinfo->p2p_dir = pinfo->pseudo_header->p2p.sent;
            break;
        case DCT2000_ENCAP_SSCOP:
            protocol_handle = find_dissector("sscop");
            break;
        case WTAP_ENCAP_FRELAY:
            protocol_handle = find_dissector("fr");
            break;
        case DCT2000_ENCAP_UNHANDLED:
            protocol_handle = 0;
            break;

        default:
            /* !! If get here, there is a mismatch between
               this dissector and the wiretap module catapult_dct2000.c !!
            */
            DISSECTOR_ASSERT_NOT_REACHED();
                return;
    }


    /* Try appropriate dissector, if selected */
    if (protocol_handle != 0)
    {
        /* Dissect the remainder of the frame using chosen protocol handle */
        next_tvb = tvb_new_subset(tvb, offset, -1, tvb_reported_length(tvb)-offset);
        sub_dissector_result = call_dissector_only(protocol_handle, next_tvb, pinfo, tree);
    }


    if (protocol_handle == 0 || sub_dissector_result == 0)
    {
        /* Could get here because:
           - encap is DCT2000_ENCAP_UNHANDLED, OR
           - desired protocol is unavailable (probably disabled), OR
           - protocol rejected our data
           Show remaining bytes as unparsed data */
        proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_unparsed_data,
                            tvb, offset, -1, FALSE);
        if (check_col(pinfo->cinfo, COL_INFO))
        {
            col_add_fstr(pinfo->cinfo, COL_INFO,
                         "Unparsed protocol data (context=%s.%u   t=%s   %c   prot=%s)",
                         tvb_get_ephemeral_string(tvb, 0, context_length),
                         port_number,
                         tvb_get_ephemeral_string(tvb, timestamp_start, timestamp_length),
                         (direction == 0) ? 'S' : 'R',
                         tvb_get_ephemeral_string(tvb, protocol_start, protocol_length));
        }
    }
}



/******************************************************************************/
/* Associate this protocol with the Catapult DCT2000 file encapsulation type. */
/******************************************************************************/
void proto_reg_handoff_catapult_dct2000(void)
{
    dissector_handle_t catapult_dct2000_handle = find_dissector("dct2000");
    dissector_add("wtap_encap", WTAP_ENCAP_CATAPULT_DCT2000,
                  catapult_dct2000_handle);
}

/****************************************/
/* Register the protocol                */
/****************************************/
void proto_register_catapult_dct2000(void)
{
    static hf_register_info hf[] =
    {
        { &hf_catapult_dct2000_context,
            { "Context",
              "dct2000.context", FT_STRING, BASE_NONE, NULL, 0x0,
              "Context name", HFILL
            }
        },
        { &hf_catapult_dct2000_port_number,
            { "Context Port number",
              "dct2000.context_port", FT_UINT8, BASE_DEC, NULL, 0x0,
              "Context port number", HFILL
            }
        },
        { &hf_catapult_dct2000_timestamp,
            { "Timestamp",
              "dct2000.timestamp", FT_STRING, BASE_NONE, NULL, 0x0,
              "File timestamp", HFILL
            }
        },
        { &hf_catapult_dct2000_protocol,
            { "DCT2000 protocol",
              "dct2000.protocol", FT_STRING, BASE_NONE, NULL, 0x0,
              "Original (DCT2000) protocol name", HFILL
            }
        },
        { &hf_catapult_dct2000_direction,
            { "Direction",
              "dct2000.direction", FT_UINT8, BASE_DEC, VALS(direction_vals), 0x0,
              "Frame direction (Sent or Received)", HFILL
            }
        },
        { &hf_catapult_dct2000_encap,
            { "Ethereal encapsulation",
              "dct2000.encapsulation", FT_UINT8, BASE_DEC, VALS(encap_vals), 0x0,
              "Ethereal encapsulation used", HFILL
            }
        },
        { &hf_catapult_dct2000_unparsed_data,
            { "Unparsed protocol data",
              "dct2000.unparsed_data", FT_BYTES, BASE_NONE, NULL, 0x0,
              "Unparsed DCT2000 protocol data", HFILL
            }
        },

    };

    static gint *ett[] =
    {
        &ett_catapult_dct2000
    };

    module_t *catapult_dct2000_module;
    
    /* Register protocol. */
    proto_catapult_dct2000 = proto_register_protocol("DCT2000", "DCT2000", "dct2000");
    proto_register_field_array(proto_catapult_dct2000, hf, array_length(hf));
    proto_register_subtree_array(ett, array_length(ett));

    /* Allow dissector to find be found by name. */
    register_dissector("dct2000", dissect_catapult_dct2000, proto_catapult_dct2000);

    /* Preferences */
	catapult_dct2000_module = prefs_register_protocol(proto_catapult_dct2000,
											          proto_reg_handoff_catapult_dct2000);

    /* Determines whether non-supported protocols should be shown anyway */
	prefs_register_bool_preference(catapult_dct2000_module, "board_ports_only",
	                               "Only show known 'board-port' protocols",
	                               "Don't show other protocols, i.e. unknown board-port "
                                   "protocols and non-standard primitives between "
                                   "contexts on the same card.  The capture file "
                                   "needs to be (re)-loaded before effect will be seen",
	                               &catapult_dct2000_board_ports_only);
}

Session Transcript (format 3.1, release 10.6 on ukeng7, Linux 2.6.8-24-smp i686)
February 21, 2006     16:45:20.5185
test_ETSI.1/isdn_l3/1,12/// s tm 17.1504 l $0003030802803f621c0b91a30802010206033031320d0b93a20802010130030201019c7f0b3031323334353637383930947f0c303132333435363738393031
A.1/ppp/1/// s tm 20.1411 l $ff03c0230100000801300130
Ethernet.1/ethernet/1/// s tm 22.5695 l $ffffffffffff0010db056c80080600010800060400010010db056c80c0a80002000000000000c0a8007f
UDP.1/ip/1/// s tm 23.3926 l $4500011401fc0000ff11d280c0a8010ac0a8640113c413c401001c955349502f322e30203138302052696e67696e670d0a43616c6c2d49443a2031302d3037313235363338403139322e3136382e31312e31300d0a435365713a203120494e564954450d0a46726f6d3a207369703a39373838383830303130403139322e3136382e31312e31303a353036300d0a546f3a207369703a37303335353530303130403139322e3136382e3130302e313a353036300d0a5669613a205349502f322e302f554450203139322e3136382e31312e31303a353036300d0a5669613a205349502f322e302f554450203139322e3136382e3130302e313a353036300d0a436f6e74656e742d4c656e6774683a20300d0a0d0a
RNC.4/cfp_r5/1/// r tm 24.4017 l $0503050101
RNC_FP.1/fp_r5/1,12,2,1,0,0,/4,$008004500035// r tm 25.4032 l $0200061a9504f0df09
SSCOP.1/saalnni_sscop/2/// s tm 26.1262 l $000000040000000101000200
SSCOP.1/saalnni_sscop/2/// s tm 30.1373 l $00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff08000001
frelay_l2.2/frelay_l2/2,1,5/// r tm 31.1274 l $000e000300013132



/* catapult_dct2000.c
 *
 * $Id: netmon.c 15534 2005-08-25 21:29:54Z ulfl $
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@xxxxxxxxxxxxxxx>
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>

#include "wtap-int.h"
#include "file_wrappers.h"
#include "buffer.h"

#include "catapult_dct2000.h"

#define MAX_FIRST_LINE_LENGTH      1024
#define MAX_TIMESTAMP_LINE_LENGTH  100
#define MAX_LINE_LENGTH            32000
#define MAX_SUBSECOND_DECIMALS     4
#define MAX_CONTEXT_NAME           64
#define MAX_PROTOCOL_NAME          64
#define MAX_SECONDS_CHARS          16
#define MAX_PORT_DIGITS            2
#define AAL_HEADER_CHARS           12

/* TODO:
   - support for x.25?
*/

/* 's' or 'r' of a packet as read from .out file */
typedef enum packet_direction_t
{
    sent,
    received
} packet_direction_t;


typedef struct
{
    gchar *before_time;
    gchar *after_time;
} line_prefix_info_t;

/*******************************************************************/
/* Information stored external to a file (wtap) needed for dumping */
typedef struct dct2000_file_externals
{
    /* Buffer to hold first line, including magic and format number */
    gchar firstline[MAX_FIRST_LINE_LENGTH];
    gint  firstline_length;

    /* Buffer to hold second line with formatted file creation data/time */
    gchar secondline[MAX_TIMESTAMP_LINE_LENGTH];
    gint  secondline_length;

    /* Hash table to store text prefix data part of displayed packets.
       Records (file offset -> pre-data-prefix-string)
       N.B. This is only needed for dumping
    */
    GHashTable *line_header_prefixes_table;
} dct2000_file_externals_t;

/* This global table maps wtap -> file_external structs */
static GHashTable *file_externals_table = NULL;


/***********************************************************/
/* Transient data used for parsing                         */

/* Buffer to hold a single text line read from the file */
static gchar linebuff[MAX_LINE_LENGTH];

/* Buffer for separate AAL header */
static gchar aal_header_chars[AAL_HEADER_CHARS];

/* 'Magic number' at start of Catapult DCT2000 .out files. */
static const gchar catapult_dct2000_magic[] = "Session Transcript";

/* Context name + port that the packet was captured at */
static gchar context_name[MAX_CONTEXT_NAME];
static guint8 context_port;

/* The DCT2000 protocol name of the packet */
static gchar protocol_name[MAX_PROTOCOL_NAME];

/*************************************************/
/* Preference state (shared with stub protocol). */
/* Set to FALSE to get better use out of other   */
/* wiretap applications (mergecap, editcap)      */
gboolean catapult_dct2000_board_ports_only = FALSE;

/************************************************************/
/* Functions called from wiretap                            */
static gboolean catapult_dct2000_read(wtap *wth, int *err, gchar **err_info,
                                      long *data_offset);
static gboolean catapult_dct2000_seek_read(wtap *wth, long seek_off,
                                           union wtap_pseudo_header *pseudo_header,
                                           guchar *pd, int length,
                                           int *err, gchar **err_info);
static void catapult_dct2000_close(wtap *wth);

static gboolean catapult_dct2000_dump(wtap_dumper *wdh, const struct wtap_pkthdr *phdr,
                                      const union wtap_pseudo_header *pseudo_header,
                                      const guchar *pd, int *err);
static gboolean catapult_dct2000_dump_close(wtap_dumper *wdh, int *err);


/************************************************************/
/* Private helper functions                                 */
static gboolean read_new_line(FILE_T fh, long *offset, gint *length);
static gboolean parse_line(gint length, gint *seconds, gint *useconds,
                           long *before_time_offset, long *after_time_offset,
                           long *data_offset,
                           gint *data_chars,
                           packet_direction_t *direction,
                           int *encap,
                           gboolean seek_read);
static unsigned char hex_from_char(gchar c);
static gchar char_from_hex(unsigned char hex);

static void set_pseudo_header_info(wtap *wth,
                                   int pkt_encap,
                                   long file_offset,
                                   union wtap_pseudo_header *pseudo_header,
                                   gint length,
                                   packet_direction_t direction);
static void set_aal_info(union wtap_pseudo_header *pseudo_header, gint length,
                         packet_direction_t direction);
static void set_isdn_info(union wtap_pseudo_header *pseudo_header,
                          packet_direction_t direction);
static void set_ppp_info(union wtap_pseudo_header *pseudo_header,
                         packet_direction_t direction);


static gint prefix_equal(gconstpointer v, gconstpointer v2);
static guint prefix_hash_func(gconstpointer v);
static gboolean get_file_time_stamp(time_t *secs, guint32 *usecs);
static void free_header_prefix(void *data);



/********************************************/
/* Open file                                */
/********************************************/
int catapult_dct2000_open(wtap *wth, int *err, gchar **err_info _U_)
{
    long    offset = 0;
    time_t  timestamp;
    guint32 usecs;
    dct2000_file_externals_t *file_externals;

    /* Clear errno before reading from the file */
    errno = 0;


    /*********************************************************************/
    /* Need entry in file_externals table                                */

    /* Create file externals table if it doesn't yet exist */
    if (file_externals_table == NULL)
    {
        file_externals_table = g_hash_table_new_full(prefix_hash_func, prefix_equal, NULL, g_free);
    }

    /* Allocate a new file_externals structure */
    file_externals = g_malloc(sizeof(dct2000_file_externals_t));
    bzero((void*)file_externals, sizeof(dct2000_file_externals_t));

    /* Add an entry into the table for this wtap structure */
    g_hash_table_insert(file_externals_table,
                        (void*)wth, (void*)file_externals);


    /********************************************************************/
    /* First line needs to contain at least as many characters as magic */

    read_new_line(wth->fh, &offset, &(file_externals->firstline_length));
    if ((size_t)file_externals->firstline_length < strlen(catapult_dct2000_magic))
    {
        return 0;
    }

    /* This file is not for us if it doesn't match our signature */
    if (memcmp(catapult_dct2000_magic, linebuff, strlen(catapult_dct2000_magic)) != 0)
    {
        return 0;
    }

    /* Copy this first line into buffer so could write out later */
    strncpy(file_externals->firstline, linebuff, file_externals->firstline_length);


    /***********************************************************/
    /* Second line contains file timestamp                     */
    /* Store this offset in in wth->capture->catapult_dct2000  */

    read_new_line(wth->fh, &offset, &(file_externals->secondline_length));
    if (!get_file_time_stamp(&timestamp, &usecs))
    {
        /* Give up if time wasn't valid */
        return 0;
    }

    wth->capture.catapult_dct2000 = g_malloc(sizeof(catapult_dct2000_t));
    wth->capture.catapult_dct2000->start_secs = timestamp;
    wth->capture.catapult_dct2000->start_usecs = usecs;

    /* Copy this second line into buffer so could write out later */
    strncpy(file_externals->secondline, linebuff, file_externals->secondline_length);


    /************************************************************/
    /* File is for us. Fill in details so packets can be read   */

    /* Set our file type */
    wth->file_type = WTAP_FILE_CATAPULT_DCT2000;

    /* Use our own encapsulation to send all packets to our stub dissector */
    wth->file_encap = WTAP_ENCAP_CATAPULT_DCT2000;

    /* Callbacks for reading operations */
    wth->subtype_read = catapult_dct2000_read;
    wth->subtype_seek_read = catapult_dct2000_seek_read;
    wth->subtype_close = catapult_dct2000_close;

    /* Choose microseconds (have 4 decimal places...) */
    wth->tsprecision = WTAP_FILE_TSPREC_USEC;


    /**********************************************/
    /* (Re)-initialise line_header_prefixes_table */
  	if (file_externals->line_header_prefixes_table)
    {
		g_hash_table_destroy(file_externals->line_header_prefixes_table);
    }
    /* Values (line prefix strings) will be automatically freed... */
    file_externals->line_header_prefixes_table =
        g_hash_table_new_full(prefix_hash_func, prefix_equal, NULL, free_header_prefix);

    *err = errno;
    return 1;
}


/**************************************************/
/* Read function.                                 */
/* Look for and read the next usable packet       */
/* - return TRUE and details if found             */
/**************************************************/
gboolean catapult_dct2000_read(wtap *wth, int *err, gchar **err_info _U_,
                               long *data_offset)
{
    long offset = wth->data_offset;
    long dollar_offset, before_time_offset, after_time_offset;
    packet_direction_t direction;
    int encap;

    /* Find wtap external structure for this wtap */
    dct2000_file_externals_t *file_externals =
        (dct2000_file_externals_t*)g_hash_table_lookup(file_externals_table, wth);

    /* Search for a line containing a usable board-port frame */
    while (1)
    {
        int length, seconds, useconds, data_chars;
        long this_offset = offset;

        /* Are looking for first packet after 2nd line */
        if (wth->data_offset == 0)
        {
            this_offset += (file_externals->firstline_length+1+
                            file_externals->secondline_length+1);
        }

        /* Clear errno before reading from the file */
        errno = 0;

        /* Read a new line from file into linebuff */
        if (read_new_line(wth->fh, &offset, &length) == FALSE)
        {
            /* Get out when no more lines to be read */
            break;
        }

        /* Try to parse the line as a message */
        if (parse_line(length, &seconds, &useconds,
                       &before_time_offset, &after_time_offset,
                       &dollar_offset,
                       &data_chars, &direction, &encap, FALSE))
        {
            guchar *frame_buffer;
            int n;
            int stub_offset = 0;
            line_prefix_info_t *line_prefix_info;
            char timestamp_string[32];
            sprintf(timestamp_string, "%d.%04d", seconds, useconds/100);

            /* All packets go to Catapult DCT2000 stub dissector */
            wth->phdr.pkt_encap = WTAP_ENCAP_CATAPULT_DCT2000;

            /* Set data_offset to the beginning of the line we're returning.
               This will be the seek_off parameter when this frame is re-read.
            */
            *data_offset = this_offset;

            /* This is the position in the file where the next _read() will be called from */
            wth->data_offset = this_offset + length + 1;

            /* Fill in timestamp (capture base + packet offset) */
            wth->phdr.ts.secs = wth->capture.catapult_dct2000->start_secs + seconds;
            if ((wth->capture.catapult_dct2000->start_usecs + useconds) >= 1000000)
            {
                wth->phdr.ts.secs++;
            }
            wth->phdr.ts.nsecs =
                ((wth->capture.catapult_dct2000->start_usecs + useconds) % 1000000) *1000;

            /* Get buffer pointer ready */
            buffer_assure_space(wth->frame_buffer,
                                strlen(context_name)+1 +  /* Context name */
                                1 +                       /* port */
                                strlen(protocol_name)+1 + /* Protocol name */
                                1 +                       /* direction */
                                1 +                       /* encap */
                                (data_chars/2));
            frame_buffer = buffer_start_ptr(wth->frame_buffer);


            /*********************/
            /* Write stub header */

            /* Context name */
            strcpy(frame_buffer, context_name);
            stub_offset += (strlen(context_name) + 1);

            /* Context port number */
            frame_buffer[stub_offset] = context_port;
            stub_offset++;

            /* Timestamp within file */
            strcpy(&frame_buffer[stub_offset], timestamp_string);
            stub_offset += (strlen(timestamp_string) + 1);

            /* Protocol name */
            strcpy(&frame_buffer[stub_offset], protocol_name);
            stub_offset += (strlen(protocol_name) + 1);

            /* Direction */
            frame_buffer[stub_offset] = direction;
            stub_offset++;

            /* Encap */
            frame_buffer[stub_offset] = (guint8)encap;
            stub_offset++;

            /* Binary data length is half bytestring length + stub header */
            wth->phdr.len = data_chars/2 + stub_offset;
            wth->phdr.caplen = data_chars/2 + stub_offset;


            /*************************/
            /* Copy data into buffer */
            for (n=0; n <= data_chars; n+=2)
            {
                frame_buffer[stub_offset + n/2] =
                    (hex_from_char(linebuff[dollar_offset+n]) << 4) |
                     hex_from_char(linebuff[dollar_offset+n+1]);
            }
            
            /* Store the packet prefix in the hash table */
            line_prefix_info = g_malloc(sizeof(line_prefix_info_t));

            line_prefix_info->before_time = g_malloc(before_time_offset+1);
            strncpy(line_prefix_info->before_time, linebuff, before_time_offset);
            line_prefix_info->before_time[before_time_offset] = '\0';

            line_prefix_info->after_time = g_malloc(dollar_offset - after_time_offset);
            strncpy(line_prefix_info->after_time, linebuff+after_time_offset,
                   dollar_offset - after_time_offset);
            line_prefix_info->after_time[dollar_offset - after_time_offset-1] = '\0';

            /* Add entry into table */
            g_hash_table_insert(file_externals->line_header_prefixes_table,
                                (void*)this_offset, line_prefix_info);


            /* Set pseudo-header if necessary */
            set_pseudo_header_info(wth, encap, this_offset, &wth->pseudo_header,
                                   data_chars/2, direction);

            /* OK, we have packet details to return */
            *err = errno;
            return TRUE;
        }
    }

    /* No packet details to return... */
    *err = errno;
    return FALSE;
}


/**************************************************/
/* Read & seek function.                          */
/**************************************************/
static gboolean
catapult_dct2000_seek_read(wtap *wth, long seek_off,
                           union wtap_pseudo_header *pseudo_header, guchar *pd,
                           int length, int *err, gchar **err_info)
{
    long offset = wth->data_offset;
    long dollar_offset, before_time_offset, after_time_offset;
    packet_direction_t direction;
    int encap;
    int seconds, useconds, data_chars;

    /* Reset errno */
    *err = errno = 0;

    /* Seek to beginning of packet */
    if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
    {
        return FALSE;
    }

    /* Re-read whole line (this should succeed) */
    if (read_new_line(wth->random_fh, &offset, &length) == FALSE)
    {
        return FALSE;
    }

    /* Try to parse this line again (should succeed as re-reading...) */
    if (parse_line(length, &seconds, &useconds,
                   &before_time_offset, &after_time_offset,
                   &dollar_offset,
                   &data_chars, &direction, &encap, TRUE))
    {
        int n;
        int stub_offset = 0;
        char timestamp_string[32];
        sprintf(timestamp_string, "%d.%04d", seconds, useconds/100);

        /* Make sure all packets go to catapult dct2000 dissector */
        wth->phdr.pkt_encap = WTAP_ENCAP_CATAPULT_DCT2000;


        /*********************/
        /* Write stub header */

        strcpy(pd, context_name);
        stub_offset += (strlen(context_name) + 1);

        /* Context port number */
        pd[stub_offset] = context_port;
        stub_offset++;

        /* Timestamp within file */
        strcpy(&pd[stub_offset], timestamp_string);
        stub_offset += (strlen(timestamp_string) + 1);

        /* Protocol name */
        strcpy(&pd[stub_offset], protocol_name);
        stub_offset += (strlen(protocol_name) + 1);

        /* Direction */
        pd[stub_offset] = direction;
        stub_offset++;

        /* Encap */
        pd[stub_offset] = encap;
        stub_offset++;

        /********************************/
        /* Copy packet data into buffer */
        for (n=0; n <= data_chars; n+=2)
        {
            pd[stub_offset + n/2] = (hex_from_char(linebuff[dollar_offset+n]) << 4) |
                                     hex_from_char(linebuff[dollar_offset+n+1]);
        }

        /* Set packet pseudo-header if necessary */
        set_pseudo_header_info(wth, encap, seek_off, pseudo_header, data_chars/2, direction);

        *err = errno = 0;
        return TRUE;
    }

    /* If get here, must have failed */
    *err = errno;
    *err_info = g_strdup_printf("catapult dct2000: seek_read failed to read/parse "
                                "line at position %ld", seek_off);
    return FALSE;
}


/******************************************/
/* Free dct2000-specific capture info     */
/******************************************/
void catapult_dct2000_close(wtap *wth)
{
    /* Destroy line prefix table for this entry */
    dct2000_file_externals_t *file_externals =
        (dct2000_file_externals_t*)g_hash_table_lookup(file_externals_table, wth);
    g_hash_table_destroy(file_externals->line_header_prefixes_table);

    /* And remove the entry itself */
    g_hash_table_remove(file_externals_table, (void*)wth);

    /* Also free this capture info */
    g_free(wth->capture.catapult_dct2000);
}




/***************************/
/* Dump functions          */
/***************************/

/*****************************************************/
/* The file that we are writing to has been opened.  */
/* Set other dump callbacks.                         */
/*****************************************************/
gboolean catapult_dct2000_dump_open(wtap_dumper *wdh, gboolean cant_seek _U_, int *err _U_)
{
    /* Fill in other dump callbacks */
	wdh->subtype_write = catapult_dct2000_dump;
	wdh->subtype_close = catapult_dct2000_dump_close;

    return TRUE;
}

/*********************************************************/
/* Respond to queries about which encap types we support */
/* writing to.                                           */
/*********************************************************/
int catapult_dct2000_dump_can_write_encap(int encap)
{
    switch (encap)
    {
        case WTAP_ENCAP_CATAPULT_DCT2000:
            /* We support this */
            return 0;
        default:
            return WTAP_ERR_UNSUPPORTED_ENCAP;
    }
}


/*****************************************/
/* Write a single packet out to the file */
/*****************************************/
gboolean catapult_dct2000_dump(wtap_dumper *wdh, const struct wtap_pkthdr *phdr,
                               const union wtap_pseudo_header *pseudo_header,
                               const guchar *pd, int *err _U_)
{
    guint32 n;
    line_prefix_info_t *prefix = NULL;
    gchar time_string[16];

    /******************************************************/
    /* Look up the file_externals structure for this file */
    /* Find wtap external structure for this wtap */
    dct2000_file_externals_t *file_externals =
        (dct2000_file_externals_t*)g_hash_table_lookup(file_externals_table,
                                                       pseudo_header->dct2000.wth);

    if (wdh->dump.dct2000 == NULL)
    {
        /* Allocate the dct2000-specific dump structure */
        wdh->dump.dct2000 = g_malloc(sizeof(catapult_dct2000_t));

        /* Write out saved first line */
        fwrite(file_externals->firstline, 1, file_externals->firstline_length, wdh->fh);
        fwrite("\n", 1, 1, wdh->fh);

        /* Also write out saved second line with timestamp corresponding to the
           opening time of the log.
        */
        fwrite(file_externals->secondline, 1, file_externals->secondline_length, wdh->fh);
        fwrite("\n", 1, 1, wdh->fh);

        /* Allocate the dct2000-specific dump structure */
        wdh->dump.dct2000 = g_malloc(sizeof(catapult_dct2000_t));

        /* Copy time of beginning of file */
        wdh->dump.dct2000->start_time.secs =
            pseudo_header->dct2000.wth->capture.catapult_dct2000->start_secs;
        wdh->dump.dct2000->start_time.nsecs =
            (pseudo_header->dct2000.wth->capture.catapult_dct2000->start_usecs * 1000);

        /* Set flag do don't write header out again */
        wdh->dump.dct2000->first_packet_written = TRUE;
    }


    /******************************************************************/
    /* Write out this packet's prefix, including calculated timestamp */

    /* Look up line data prefix using stored offset */
    prefix = (line_prefix_info_t*)g_hash_table_lookup(file_externals->line_header_prefixes_table,
                                                      (void*)pseudo_header->dct2000.seek_off);

    /* Write out text before timestamp */
    fwrite(prefix->before_time, 1, strlen(prefix->before_time), wdh->fh);

    /* Calculate time of this packet to write, relative to start of dump */
    if (phdr->ts.nsecs >= wdh->dump.dct2000->start_time.nsecs)
    {
        g_snprintf(time_string, 16, "%ld.%04d",
                 phdr->ts.secs - wdh->dump.dct2000->start_time.secs,
                 (phdr->ts.nsecs - wdh->dump.dct2000->start_time.nsecs) / 100000);
    }
    else
    {
        g_snprintf(time_string, 16, "%ld.%04u",
                 phdr->ts.secs - wdh->dump.dct2000->start_time.secs-1,
                 ((1000000000 + (phdr->ts.nsecs / 100000)) - (wdh->dump.dct2000->start_time.nsecs / 100000)) % 10000);
    }

    /* Write out the calculated timestamp */
    fwrite(time_string, 1, strlen(time_string), wdh->fh);

    /* Write out text between timestamp and start of hex data */
    fwrite(prefix->after_time, 1, strlen(prefix->after_time), wdh->fh);


    /****************************************************************/
    /* Need to skip stub header at start of pd before we reach data */

    /* Context name */
    for (n=0; pd[n] != '\0'; n++);
    n++;

    /* Context port number */
    n++;

    /* Timestamp */
    for (; pd[n] != '\0'; n++);
    n++;

    /* Protocol name */
    for (; pd[n] != '\0'; n++);
    n++;

    /* Direction & encap */
    n += 2;


    /**************************************/
    /* Remainder is encapsulated protocol */
    fwrite("$", 1, 1, wdh->fh);

    /* Each binary byte is written out as 2 hex string chars */ 
    for (; n < phdr->len; n++)
    {
        char c[2];
        c[0] = char_from_hex(pd[n] >> 4);
        c[1] = char_from_hex(pd[n] & 0x0f);

        /* Write both hex chars of byte together */
        fwrite(c, 1, 2, wdh->fh);
    }

    /* End the line */
    fwrite("\n", 1, 1, wdh->fh);

    return TRUE;
}


/******************************************************/
/* Close a file we've been writing to.                */
/******************************************************/
static gboolean catapult_dct2000_dump_close(wtap_dumper *wdh _U_, int *err _U_)
{
    return TRUE;
}




/****************************/
/* Private helper functions */
/****************************/

/**********************************************************************/
/* Read a new line from the file, starting at offset.                 */
/* - writes data to static var linebuff                               */
/* - on return 'offset' will point to the next position to read from  */
/* - return TRUE if this read is successful                           */
/**********************************************************************/
gboolean read_new_line(FILE_T fh, long *offset, gint *length)
{
    char *result;

    /* Read in a line */
    result = file_gets(linebuff, MAX_LINE_LENGTH, fh);
    if (result == NULL)
    {
        /* No characters found */
        return FALSE;
    }

    /* Set length and offset.. */
    *length = strlen(linebuff);
    *offset = *offset + *length;

    /* ...but don't want to include newline in line length */
    if (linebuff[*length-1] == '\n')
    {
        linebuff[*length-1] = '\0';
        *length = *length - 1;
    }

    return TRUE;
}


/**********************************************************************/
/* Parse a line from buffer, by identifying:                          */
/* - context, port and direction of packet                            */
/* - timestamp                                                        */
/* - data position and length                                         */
/* Return TRUE if this packet looks valid and can be displayed        */
/**********************************************************************/
gboolean parse_line(gint length, gint *seconds, gint *useconds,
                    long *before_time_offset, long *after_time_offset,
                    long *data_offset, gint *data_chars,
                    packet_direction_t *direction,
                    int *encap,
                    gboolean seek_read)
{
    int  n = 0;
    int  port_digits = 0;
    char port_number_string[MAX_PORT_DIGITS+1];
    int  protocol_chars = 0;
    char seconds_buff[MAX_SECONDS_CHARS];
    int  seconds_chars;
    char subsecond_decimals_buff[MAX_SUBSECOND_DECIMALS];
    int  subsecond_decimals_chars;
    gboolean atm_header_present = FALSE;

    /* Read context name until find '.' */
    for (n=0; linebuff[n] != '.' && (n < MAX_CONTEXT_NAME); n++)
    {
        if (!isalnum(linebuff[n]) && (linebuff[n] != '_'))
        {
            return FALSE;
        }
        context_name[n] = linebuff[n];
    }

    /* '.' must follow context name */
    if (linebuff[n] != '.')
    {
        return FALSE;
    }
    context_name[n] = '\0';
    /* Skip it */
    n++;


    /* Now read port number */
    for (port_digits = 0;
         (linebuff[n] != '/') && (port_digits <= MAX_PORT_DIGITS);
         n++, port_digits++)
    {
        if (!isdigit(linebuff[n]))
        {
            return FALSE;
        }
        port_number_string[port_digits] = linebuff[n];
    }

    /* Slash char must follow port number */
    if (linebuff[n] != '/')
    {
        return FALSE;
    }
    port_number_string[port_digits] = '\0';
    context_port = atoi(port_number_string);
    /* Skip it */
    n++;


    /* Now for the protocol name */
    for (protocol_chars = 0;
         (linebuff[n] != '/') && (protocol_chars <= MAX_PROTOCOL_NAME) &&
         (n < MAX_LINE_LENGTH);
         n++, protocol_chars++)
    {
        if (!isalnum(linebuff[n]) && linebuff[n] != '_')
        {
            return FALSE;
        }
        protocol_name[protocol_chars] = linebuff[n];
    }
    protocol_name[protocol_chars] = '\0';

    /* Slash char must follow protocol name */
    if (linebuff[n] != '/')
    {
        return FALSE;
    }


    /******************************************************************/
    /* Now check whether we know how to use a packet of this protocol */

    if ((strcmp(protocol_name, "ip") == 0)  || (strcmp(protocol_name, "sctp") == 0))
    {
        *encap = WTAP_ENCAP_RAW_IP;
    }
    else

    /* For ATM protocols, we need to read the separate atm headerparse */
    if ((strcmp(protocol_name, "fp") == 0) ||
        (strcmp(protocol_name, "fp_r4") == 0) ||
        (strcmp(protocol_name, "fp_r5") == 0) ||
        (strcmp(protocol_name, "fp_r6") == 0))
    {
        *encap = WTAP_ENCAP_ATM_PDUS_UNTRUNCATED;
        atm_header_present = TRUE;
    }

    else
    if (strcmp(protocol_name, "ppp") == 0)
    {
        *encap = WTAP_ENCAP_PPP;
    }
    else
    if (strcmp(protocol_name, "isdn_l3") == 0)
    {
        /* Despite the name, this does seem to correspond to L2... */
        *encap = WTAP_ENCAP_ISDN;
    }
    else
    if (strcmp(protocol_name, "ethernet") == 0)
    {
        *encap = WTAP_ENCAP_ETHERNET;
    }
    else
    if ((strcmp(protocol_name, "saalnni_sscop") == 0) ||
        (strcmp(protocol_name, "saaluni_sscop") == 0))
    {
        *encap = DCT2000_ENCAP_SSCOP;
    }
    else
    if (strcmp(protocol_name, "frelay_l2") == 0)
    {
        *encap = WTAP_ENCAP_FRELAY;
    }

    else
    {
        /* Only reject protocol if reading for the first time and preference
           setting says board ports only.  This should not fail to read a
           non board-port protocol on re-reading because the preference setting
           has since changed...
        */
        if (catapult_dct2000_board_ports_only && !seek_read)
        {
            return FALSE;
        }
        else
        {
            /* Not a supported protocol/encap, but should show as raw data anyway */
            *encap = DCT2000_ENCAP_UNHANDLED;
        }
    }


    /* Find separate ATM header if necessary */
    if (atm_header_present)
    {
        int header_chars_seen = 0;

        /* Scan ahead to the next $ */
        for (; (linebuff[n] != '$') && (n < MAX_LINE_LENGTH); n++);
        /* Skip it */
        n++;

        /* Read consecutive hex chars into atm header buffer */
        for (;
             (isalnum(linebuff[n]) &&
              (n < MAX_LINE_LENGTH) &&
              (header_chars_seen < AAL_HEADER_CHARS));
             n++, header_chars_seen++)
        {
            aal_header_chars[header_chars_seen] = linebuff[n];
        }

        if (header_chars_seen != AAL_HEADER_CHARS)
        {
            return FALSE;
        }
    }


    /* Scan ahead to the next space */
    for (; (linebuff[n] != ' ') && (n < MAX_LINE_LENGTH); n++);
    /* Skip it */
    n++;

    /* Next character gives direction of message (must be 's' or 'r') */
    if (linebuff[n] == 's')
    {
        *direction = sent;
    }
    else
    if (linebuff[n] == 'r')
    {
        *direction = received;
    }
    else
    {
        return FALSE;
    }


    /*********************************************************************/
    /* Find and read the timestamp                                       */

    /* Now scan to the next digit, which should be the start of the timestamp */
    for (; !isdigit(linebuff[n]) && (n < MAX_LINE_LENGTH); n++);

    *before_time_offset = n;

    /* Seconds */
    for (seconds_chars = 0;
         (linebuff[n] != '.') &&
         (seconds_chars <= MAX_SECONDS_CHARS) &&
         (n < MAX_LINE_LENGTH);
         n++, seconds_chars++)
    {
        if (!isdigit(linebuff[n]))
        {
            return FALSE;
        }
        seconds_buff[seconds_chars] = linebuff[n];
    }
    /* Convert found value into number */
    seconds_buff[seconds_chars] = '\0';
    *seconds = atoi(seconds_buff);

    /* The decimal point must follow the last of the seconds digits */
    if (linebuff[n] != '.')
    {
        return FALSE;
    }
    /* Skip it */
    n++;

    /* Subsecond decimal digits (expect 4-digit accuracy) */
    for (subsecond_decimals_chars = 0;
         (linebuff[n] != ' ') &&
         (subsecond_decimals_chars <= MAX_SUBSECOND_DECIMALS) &&
         (n < MAX_LINE_LENGTH);
         n++, subsecond_decimals_chars++)
    {
        if (!isdigit(linebuff[n]))
        {
            return FALSE;
        }
        subsecond_decimals_buff[subsecond_decimals_chars] = linebuff[n];
    }
    /* Convert found value into microseconds */
    subsecond_decimals_buff[subsecond_decimals_chars] = '\0';
    *useconds = atoi(subsecond_decimals_buff) * 100;

    /* Space character must follow end of timestamp */
    if (linebuff[n] != ' ')
    {
        return FALSE;
    }

    *after_time_offset = n;

    /* Now skip ahead to find start of data (marked by '$') */
    for (; (linebuff[n] != '$') && (n < MAX_LINE_LENGTH); n++);
    /* Skip it */
    n++;

    /* Set offset to data start within line */
    *data_offset = n;

    /* Set number of chars that comprise the hex string protocol data */
    *data_chars = length - n;

    /* Need to skip first byte (2 hex string chars) from ISDN messages.
       TODO: find out what this byte means...
    */
    if (*encap == WTAP_ENCAP_ISDN)
    {
        *data_offset += 2;
        *data_chars -= 2;
    }

    return TRUE;
}


/**************************************************************/
/* Set pseudo-header info depending upon packet encapsulation */
/**************************************************************/
void set_pseudo_header_info(wtap *wth,
                            int pkt_encap,
                            long file_offset,
                            union wtap_pseudo_header *pseudo_header,
                            gint length,
                            packet_direction_t direction)
{
    pseudo_header->dct2000.seek_off = file_offset;
    pseudo_header->dct2000.wth = wth;

    switch (pkt_encap)
    {
        case WTAP_ENCAP_ATM_PDUS_UNTRUNCATED:
            set_aal_info(pseudo_header, length, direction);
            break;
        case WTAP_ENCAP_ISDN:
            set_isdn_info(pseudo_header, direction);
            break;
        case WTAP_ENCAP_PPP:
            set_ppp_info(pseudo_header, direction);
            break;

        default:
            /* Other supported types don't need to set anything here... */
            break;
    }
}


/*********************************************/
/* Fill in atm pseudo-header with known info */
/*********************************************/
void set_aal_info(union wtap_pseudo_header *pseudo_header, gint length,
                  packet_direction_t direction)
{
    /* 'aal_head_chars' has this format (for AAL2 at least):
       Global Flow Control (4 bits) | VPI (8 bits) | VCI (16 bits) |
       Payload Type (4 bits) | Padding (3 bits?) | Link? (1 bit) |
       Channel Identifier (8 bits) | ...
    */

    /* Indicate that this is a reassembled PDU */
    pseudo_header->dct2000.inner_pseudo_header.atm.flags = 0x00;

    /* Channel 0 is DTE->DCE, 1 is DCE->DTE. Always set 0 for now.
       TODO: Can we infer the correct value here?
       Meanwhile, just use the direction to make them distinguishable...
    */
    pseudo_header->dct2000.inner_pseudo_header.atm.channel = (direction == received);

    /* Assume always AAL2 for FP */
    pseudo_header->dct2000.inner_pseudo_header.atm.aal = AAL_2;

    pseudo_header->dct2000.inner_pseudo_header.atm.type = TRAF_UNKNOWN;
    pseudo_header->dct2000.inner_pseudo_header.atm.subtype = TRAF_ST_UNKNOWN;

    /* vpi is 8 bits (2nd & 3rd nibble) */
    pseudo_header->dct2000.inner_pseudo_header.atm.vpi =
        ((hex_from_char(aal_header_chars[1]) << 4) |
          hex_from_char(aal_header_chars[2]));

    /* vci is next 16 bits */
    pseudo_header->dct2000.inner_pseudo_header.atm.vci =
        ((hex_from_char(aal_header_chars[3]) << 12) |
         (hex_from_char(aal_header_chars[4]) << 8) |
         (hex_from_char(aal_header_chars[5]) << 4) |
         hex_from_char(aal_header_chars[6]));

    /* 0 means we don't know how many cells the frame comprises. */
    pseudo_header->dct2000.inner_pseudo_header.atm.cells = 0;

    pseudo_header->dct2000.inner_pseudo_header.atm.aal5t_u2u = 0;
    pseudo_header->dct2000.inner_pseudo_header.atm.aal5t_len = length;
    pseudo_header->dct2000.inner_pseudo_header.atm.aal5t_chksum = 0;
}


/**********************************************/
/* Fill in isdn pseudo-header with known info */
/**********************************************/
void set_isdn_info(union wtap_pseudo_header *pseudo_header,
                   packet_direction_t direction)
{
    /* This field is used to set the 'Source' and 'Destination' columns to
       'User' or 'Network'. If we assume that we're simulating the network,
       treat Received messages as being destined for the network.
    */
    pseudo_header->dct2000.inner_pseudo_header.isdn.uton = (direction == received);

    /* This corresponds to the circuit ID.  0 is treated as LAPD,
       everything else would be treated as a B-channel
    */
    pseudo_header->dct2000.inner_pseudo_header.isdn.channel = 0;
}


/*********************************************/
/* Fill in ppp pseudo-header with known info */
/*********************************************/
static void set_ppp_info(union wtap_pseudo_header *pseudo_header,
                         packet_direction_t direction)
{
    /* Set direction. */
    pseudo_header->dct2000.inner_pseudo_header.p2p.sent = (direction == sent);
}


/********************************************************/
/* Return hex nibble equivalent of hex string character */
/********************************************************/
unsigned char hex_from_char(gchar c)
{
    if ((c >= '0') && (c <= '9'))
    {
        return c - '0';
    }

    if ((c >= 'a') && (c <= 'f'))
    {
        return 0x0a + (c - 'a');
    }

    /* Not a valid hex string character */
    return 0xff;
}


/********************************************************/
/* Return character corresponding to hex nibble value   */
/********************************************************/
gchar char_from_hex(unsigned char hex)
{
    static char hex_lookup[16] =
    { '0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f'};

    if (hex > 15)
    {
        return '?';
    }

    return hex_lookup[hex];
}


/********************************************/
/* Equality test for line-prefix hash table */
/********************************************/
gint prefix_equal(gconstpointer v, gconstpointer v2)
{
    return (v == v2);
}


/********************************************/
/* Hash function for line-prefix hash table */
/********************************************/
guint prefix_hash_func(gconstpointer v)
{
    /* Just use pointer itself (is actually byte offset of line in file) */ 
    return (guint)v;
}


/************************************************************************/
/* Parse year, month, day, hour, minute, seconds out of formatted line. */
/* Set secs and usecs as output                                         */
/* Return FALSE if no valid time can be read                            */
/************************************************************************/
gboolean get_file_time_stamp(time_t *secs, guint32 *usecs)
{
    int n;
    struct tm tm;
    #define MAX_MONTH_LETTERS 9
    char month[MAX_MONTH_LETTERS+1];

    int day, year, hour, minute, second;
    int scan_found;

    /* If line longer than expected, file is probably not correctly formatted */
    if (strlen(linebuff) > MAX_TIMESTAMP_LINE_LENGTH)
    {
        return FALSE;
    }

    /**************************************************************/
    /* First is month. Read until get a space following the month */
    for (n=0; (linebuff[n] != ' ') && (n < MAX_MONTH_LETTERS); n++)
    {
        month[n] = linebuff[n];
    }
    month[n] = '\0';

    if      (strcmp(month, "January"  ) == 0)  tm.tm_mon = 0;
    else if (strcmp(month, "February" ) == 0)  tm.tm_mon = 1;
    else if (strcmp(month, "March"    ) == 0)  tm.tm_mon = 2;
    else if (strcmp(month, "April"    ) == 0)  tm.tm_mon = 3;
    else if (strcmp(month, "May"      ) == 0)  tm.tm_mon = 4;
    else if (strcmp(month, "June"     ) == 0)  tm.tm_mon = 5;
    else if (strcmp(month, "July"     ) == 0)  tm.tm_mon = 6;
    else if (strcmp(month, "August"   ) == 0)  tm.tm_mon = 7;
    else if (strcmp(month, "September") == 0)  tm.tm_mon = 8;
    else if (strcmp(month, "October"  ) == 0)  tm.tm_mon = 9;
    else if (strcmp(month, "November" ) == 0)  tm.tm_mon = 10;
    else if (strcmp(month, "December" ) == 0)  tm.tm_mon = 11;
    else
    {
        /* Give up if not found a properly-formatted date */
        return FALSE;
    }
    /* Skip space char */
    n++;

    /********************************************************/
    /* Scan for remaining numerical fields                  */
    scan_found = sscanf(linebuff+n, "%d, %d     %d:%d:%d.%u",
                        &day, &year, &hour, &minute, &second, usecs);
    if (scan_found != 6)
    {
        /* Give up if not all found */
        return FALSE;
    }

    /******************************************************/
    /* Fill in remaining fields and return it in a time_t */
    tm.tm_year = year - 1900;
    tm.tm_mday = day;
    tm.tm_hour = hour;
    tm.tm_min = minute;
    tm.tm_sec = second;
    tm.tm_isdst = -1;    /* daylight saving time info not known */

    /* Get seconds from this time */
    *secs = mktime(&tm);

    /* Multiply 4 digits given to get micro-seconds */
    *usecs = *usecs * 100;

    return TRUE;
}

/* Free the data allocated inside a line_prefix_info_t */
void free_header_prefix(void *data)
{
    line_prefix_info_t *info = (line_prefix_info_t*)data;

    /* Free the strings inside */
    g_free(info->before_time);
    g_free(info->after_time);

    /* And the structure itself */
    g_free(info);
}