ui/summary.h

   1 /** @file
   2  *
   3  * Definitions for capture file summary data
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __SUMMARY_H__
  13 #define __SUMMARY_H__
  14
  15 #ifdef HAVE_LIBPCAP
  16 #include "ui/capture.h"
  17 #endif
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif /* __cplusplus */
  22
  23 typedef struct iface_summary_info_tag {
  24     char     *name;
  25     char     *descr;
  26     char     *cfilter;
  27     char     *isb_comment;
  28     uint64_t  drops;                 /**< number of packet drops */
  29     bool      drops_known;           /**< true if number of packet drops is known */
  30     int       snap;                  /**< Maximum captured packet length; 0 if not known */
  31     int       encap_type;            /**< wiretap encapsulation type */
  32 } iface_summary_info;
  33
  34 #define HASH_STR_SIZE (65) /* Max hash size * 2 + '\0' */
  35
  36 typedef struct _summary_tally {
  37     uint64_t              bytes;              /**< total bytes */
  38     double                start_time;         /**< seconds, with msec resolution */
  39     double                stop_time;          /**< seconds, with msec resolution */
  40     double                elapsed_time;       /**< seconds, with msec resolution,
  41                                                 includes time before first packet
  42                                                 and after last packet */
  43     uint32_t              marked_count;       /**< number of marked packets */
  44     uint32_t              marked_count_ts;    /**< number of time-stamped marked packets */
  45     uint64_t              marked_bytes;       /**< total bytes in the marked packets */
  46     double                marked_start;       /**< time in seconds, with msec resolution */
  47     double                marked_stop;        /**< time in seconds, with msec resolution */
  48     uint32_t              ignored_count;      /**< number of ignored packets */
  49     uint32_t              packet_count;       /**< total number of packets in trace */
  50     uint32_t              packet_count_ts;    /**< total number of time-stamped packets in trace */
  51     uint32_t              filtered_count;     /**< number of filtered packets */
  52     uint32_t              filtered_count_ts;  /**< number of time-stamped filtered packets */
  53     uint64_t              filtered_bytes;     /**< total bytes in the filtered packets */
  54     double                filtered_start;     /**< time in seconds, with msec resolution */
  55     double                filtered_stop;      /**< time in seconds, with msec resolution */
  56     const char           *filename;           /**< path of capture file */
  57     int64_t               file_length;        /**< file length in bytes */
  58     char                  file_sha256[HASH_STR_SIZE];  /**< SHA256 hash of capture file */
  59     char                  file_sha1[HASH_STR_SIZE];    /**< SHA1 hash of capture file */
  60     int                   file_type;          /**< wiretap file type */
  61     wtap_compression_type compression_type;   /**< compression type of file, or uncompressed */
  62     int                   file_encap_type;    /**< wiretap encapsulation type for file */
  63     GArray               *packet_encap_types; /**< wiretap encapsulation types for packets */
  64     int                   snap;               /**< Maximum captured packet length; 0 if not known */
  65     bool                  drops_known;        /**< true if number of packet drops is known */
  66     uint64_t              drops;              /**< number of packet drops */
  67     const char           *dfilter;            /**< display filter */
  68     bool                  is_tempfile;
  69     /* capture related, use summary_fill_in_capture() to get values */
  70     GArray               *ifaces;
  71     bool                  legacy;
  72 } summary_tally;
  73
  74 extern void
  75 summary_fill_in(capture_file *cf, summary_tally *st);
  76
  77 #ifdef HAVE_LIBPCAP
  78 extern void
  79 summary_fill_in_capture(capture_file *cf, capture_options *capture_opts, summary_tally *st);
  80 #endif
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif /* __cplusplus */
  85
  86 #endif /* summary.h */