Changeset 143eaba for lib

Timestamp:

02/03/10 14:00:32 (12 years ago)

Author:

Shane Alcock <salcock@…>

Branches:

4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes

Children:

e56be6d

Parents:

cce868c

Message:

• Updated the documentation and licensing on dagformat.h
• Most notably, removed the duck_inf structure as we do not really support DUCK reading and anyone wanting to write DUCK will already have the real DAG headers available defining the DUCK structure

File:

• lib/dagformat.h (modified) (6 diffs)

lib/dagformat.h

@@ +1 @@
+/*
+ * 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$
+ *
+ */
+
+/** @file
+ *
+ * @brief Header file containing definitions required to process DAG / ERF
+ * traces
+ *
+ * @author Daniel Lawson
+ * @author Perry Lorier
+ * @author Shane Alcock
+ *
+ * @version $Id$
+ *
+ * Most of the structures defined in here are already defined in the Endace DAG
+ * libraries, but we need to re-define them ourselves here so that we can
+ * process ERF traces without requiring the user to buy a DAG card :)
+ */
 #ifndef _DAGFORMAT_H_
 #define _DAGFORMAT_H_
@@ -4 +52 @@
 #include "libtrace.h"
 #include "erftypes.h"
-
-
 
 #ifdef WIN32
@@ -14 +60 @@
 /** GPP Type 1 */
 typedef struct pos_rec {
-        uint32_t  hdlc;
-        uint8_t   pload[1];             /**< payload */
+        uint32_t  hdlc;                 /**< The HDLC header */ 
+        uint8_t   pload[1];             /**< First byte of payload */
 }  PACKED pos_rec_t;
 
 /** GPP Type 2 */
 typedef struct eth_rec {
-        uint8_t   offset;
-        uint8_t   pad;
-        uint8_t   dst[6];
-        uint8_t   src[6];
-        uint16_t  etype;                /**< ether type (?) */
-        uint8_t   pload[1];             /**< payload */
+        uint8_t   offset;               /**< Ethernet record offset */
+        uint8_t   pad;                  /**< Padding */
+        uint8_t   dst[6];               /**< Destination MAC address */ 
+        uint8_t   src[6];               /**< Source MAC address */
+        uint16_t  etype;                /**< Ethertype */
+        uint8_t   pload[1];             /**< First byte of payload */
 }  PACKED eth_rec_t;
 
 /** GPP Type 3 */
 typedef struct atm_rec {
-        uint32_t  header; 
-        uint8_t   pload[1];             /**< payload */
+        uint32_t  header;               /**< The ATM header */ 
+        uint8_t   pload[1];             /**< First byte of payload */
 }  PACKED atm_rec_t;
 
 /** GPP Type 4 */
 typedef struct aal5_rec {
-        uint32_t  header; 
-        uint8_t   pload[1];             /**< payload */
+        uint32_t  header;               /**< The AAL5 header */
+        uint8_t   pload[1];             /**< First byte of payload */
 }  PACKED aal5_rec_t;
 
@@ -43 +89 @@
 typedef struct flags {
         LT_BITFIELD8  iface:2;          /**< Interface (direction) */
-        LT_BITFIELD8  vlen:1;   
-        LT_BITFIELD8  trunc:1;          /**< Trunacted */
-        LT_BITFIELD8  rxerror:1;        /**< RX Error in this packet/before
-                                          * this packet
-                                          */
+        LT_BITFIELD8  vlen:1;           /**< Varying Record Lengths Present */
+        LT_BITFIELD8  trunc:1;          /**< Truncated Record */
+        LT_BITFIELD8  rxerror:1;        /**< RX Error detected */
         LT_BITFIELD8  dserror:1;        /**< Data stream error */
         LT_BITFIELD8  pad:2;            /**< Unused */
@@ -54 +98 @@
 /** GPP Global type */
 typedef struct dag_record {
-        uint64_t  ts;           /**< erf timestamp */
+        uint64_t  ts;           /**< ERF timestamp */
         uint8_t   type;         /**< GPP record type */
-        flags_t   flags;        /**< flags */
-        uint16_t  rlen;         /**< record len (capture+framing) */
-        uint16_t  lctr;         /**< loss counter */
-        uint16_t  wlen;         /**< wire length */
+        flags_t   flags;        /**< Flags */
+        uint16_t  rlen;         /**< Record len (capture+framing) */
+        uint16_t  lctr;         /**< Loss counter */
+        uint16_t  wlen;         /**< Wire length */
         union {
-                pos_rec_t       pos;    
+                pos_rec_t       pos;            
                 eth_rec_t       eth;
                 atm_rec_t       atm;
                 aal5_rec_t      aal5;
-        } rec;
+        } rec;                  /**< The captured record itself */
 } PACKED dag_record_t;
-
-/** Dynamic(?) Universal Clock Kit Information packet */
-typedef struct duck_inf_pkt {
-        uint32_t  command;
-        uint32_t  config;
-        uint32_t  clock_inc;
-        uint32_t  clock_wrap;
-        uint32_t  DDS_rate;
-        uint32_t  crystal_freq;
-        uint32_t  synth_freq;
-        uint32_t  sync_rate;
-        uint64_t  last_ticks;
-        uint32_t  resyncs;
-        uint32_t  bad_diffs, bad_offs, bad_pulses;
-        uint32_t  worst_error, worst_off;
-        uint32_t  off_limit, off_damp;
-        uint32_t  pulses, single_pulses_missing, longest_pulse_missing;
-        uint32_t  health; 
-        uint32_t  sickness;
-        int32_t   error;
-        int32_t   offset;
-        int32_t   stat_start, stat_end;  
-        uint32_t  set_duck_field;
-} duck_inf;
 
 #ifdef WIN32
@@ -96 +116 @@
 #endif
 
-/** sizeof(dag_record_t) without the payload helpers */
+/** The size of the ERF record header, without the rec field */
 #define dag_record_size         16U