bugfix: don't crash, if tag_save_literal == NULL
[obnox/wireshark/wip.git] / proto_hier_stats.c
index 303d14ee6fba0241092497d13b006e404184a0b1..f1e0d87ef1e387086b738dd665766ba8252be20b 100644 (file)
@@ -1,13 +1,12 @@
 /* proto_hier_stats.c
  * Routines for calculating statistics based on protocol.
  *
- * $Id: proto_hier_stats.c,v 1.1 2001/03/22 23:54:44 gram Exp $
+ * $Id$
  *
  * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * By Gerald Combs <gerald@ethereal.com>
  * 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
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  */
 
-
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
 
 #include "globals.h"
 #include "proto_hier_stats.h"
+#include "progress_dlg.h"
+#include "simple_dialog.h"
+#include <epan/epan_dissect.h>
 #include <wtap.h>
 
 #include <stdio.h>
 #include <glib.h>
 
+/* Update the progress bar this many times when scanning the packet list. */
+#define N_PROGBAR_UPDATES      100
+
+#define STAT_NODE_STATS(n)   ((ph_stats_node_t*)(n)->data)
+#define STAT_NODE_HFINFO(n)  (STAT_NODE_STATS(n)->hfinfo)
+
+
 static GNode*
-find_stat_node(GNode *parent_node, header_field_info *needle_hfinfo)
+find_stat_node(GNode *parent_stat_node, header_field_info *needle_hfinfo)
 {
-       GNode                   *needle_node;
-       field_info              *finfo;
-       ph_stats_node_t *stats;
+       GNode                   *needle_stat_node;
+       header_field_info       *hfinfo;
+       ph_stats_node_t         *stats;
 
-       needle_node = g_node_first_child(parent_node);
+       needle_stat_node = g_node_first_child(parent_stat_node);
 
-       while (needle_node) {
-               finfo = needle_node->data;
-               if (finfo && finfo->hfinfo && finfo->hfinfo->id == needle_hfinfo->id) {
-                       return needle_node;
+       while (needle_stat_node) {
+               hfinfo = STAT_NODE_HFINFO(needle_stat_node);
+               if (hfinfo &&  hfinfo->id == needle_hfinfo->id) {
+                       return needle_stat_node;
                }
-               needle_node = g_node_next_sibling(needle_node);
+               needle_stat_node = g_node_next_sibling(needle_stat_node);
        }
 
        /* None found. Create one. */
@@ -62,33 +70,41 @@ find_stat_node(GNode *parent_node, header_field_info *needle_hfinfo)
        stats->num_bytes_total = 0;
        stats->num_bytes_last = 0;
 
-       needle_node = g_node_new(stats);
-       g_node_append(parent_node, needle_node);
-       return needle_node;
+       needle_stat_node = g_node_new(stats);
+       g_node_append(parent_stat_node, needle_stat_node);
+       return needle_stat_node;
 }
 
 
 static void
-process_node(proto_item *proto_node, GNode *parent_stat_node, ph_stats_t *ps, guint pkt_len)
+process_node(proto_node *ptree_node, GNode *parent_stat_node, ph_stats_t *ps, guint pkt_len)
 {
        field_info              *finfo;
-       ph_stats_node_t *stats;
-       proto_item              *proto_sibling_node;
+       ph_stats_node_t         *stats;
+       proto_node              *proto_sibling_node;
        GNode                   *stat_node;
 
-       finfo = proto_node->data;
+       finfo = PITEM_FINFO(ptree_node);
        g_assert(finfo);
 
+       /* if the field info isn't related to a protocol but to a field, don't count them,
+     * as they don't belong to any protocol.
+     * (happens e.g. for toplevel tree item of desegmentation "[Reassembled TCP Segments]") */
+    if(finfo->hfinfo->parent != -1) {
+        /* there are some cases where helpful generated items are added
+        * to the decode tree so do not test for it any more
+         *g_assert(PROTO_ITEM_IS_GENERATED(ptree_node));
+        */
+        return;
+    }
+
        stat_node = find_stat_node(parent_stat_node, finfo->hfinfo);
-       
-       /* Assert that the finfo is related to a protocol, not a field. */
-       g_assert(finfo->hfinfo->parent == -1);
 
-       stats = stat_node->data;
+       stats = STAT_NODE_STATS(stat_node);
        stats->num_pkts_total++;
        stats->num_bytes_total += pkt_len;
 
-       proto_sibling_node = g_node_next_sibling(proto_node);
+       proto_sibling_node = ptree_node->next;
 
        if (proto_sibling_node) {
                process_node(proto_sibling_node, stat_node, ps, pkt_len);
@@ -104,42 +120,55 @@ process_node(proto_item *proto_node, GNode *parent_stat_node, ph_stats_t *ps, gu
 static void
 process_tree(proto_tree *protocol_tree, ph_stats_t* ps, guint pkt_len)
 {
-       proto_item      *proto_node;
+       proto_node      *ptree_node;
 
-       proto_node = g_node_first_child(protocol_tree);
-       if (!proto_node) {
+       ptree_node = ((proto_node *)protocol_tree)->first_child;
+       if (!ptree_node) {
                return;
        }
 
-       process_node(proto_node, ps->stats_tree, ps, pkt_len);
+       process_node(ptree_node, ps->stats_tree, ps, pkt_len);
 }
 
-static void
-process_frame(frame_data *frame, ph_stats_t* ps)
+static gboolean
+process_frame(frame_data *frame, column_info *cinfo, ph_stats_t* ps)
 {
        epan_dissect_t                  *edt;
        union wtap_pseudo_header        phdr;
-       proto_tree                      *protocol_tree;
        guint8                          pd[WTAP_MAX_PACKET_SIZE];
-
-       protocol_tree = proto_tree_create_root();
+       int                             err;
+       gchar                           *err_info;
+       double                          cur_time;
 
        /* Load the frame from the capture file */
-       wtap_seek_read(cfile.wth, frame->file_off, &phdr,
-                       pd, frame->cap_len);
+       if (!wtap_seek_read(cfile.wth, frame->file_off, &phdr, pd,
+           frame->cap_len, &err, &err_info)) {
+               simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
+                   cf_read_error_message(err, err_info), cfile.filename);
+               return FALSE;   /* failure */
+       }
 
-       /* Dissect the frame */
-       edt = epan_dissect_new(&phdr, pd, frame, protocol_tree);
+       /* Dissect the frame   tree  not visible */
+       edt = epan_dissect_new(TRUE, FALSE);
+       epan_dissect_run(edt, &phdr, pd, frame, cinfo);
 
        /* Get stats from this protocol tree */
-       process_tree(protocol_tree, ps, frame->pkt_len);
+       process_tree(edt->tree, ps, frame->pkt_len);
+
+       /* Update times */
+       cur_time = nstime_to_sec(&frame->abs_ts);
+       if (cur_time < ps->first_time) {
+         ps->first_time = cur_time;
+       }
+       if (cur_time > ps->last_time){
+         ps->last_time = cur_time;
+       }
 
        /* Free our memory. */
        epan_dissect_free(edt);
-       proto_tree_free(protocol_tree);
-}
-
 
+       return TRUE;    /* success */
+}
 
 ph_stats_t*
 ph_stats_new(void)
@@ -147,29 +176,117 @@ ph_stats_new(void)
        ph_stats_t      *ps;
        frame_data      *frame;
        guint           tot_packets, tot_bytes;
+       progdlg_t       *progbar = NULL;
+       gboolean        stop_flag;
+       int             count;
+       float           prog_val;
+       GTimeVal        start_time;
+       gchar           status_str[100];
+       int             progbar_nextstep;
+       int             progbar_quantum;
 
        /* Initialize the data */
        ps = g_new(ph_stats_t, 1);
        ps->tot_packets = 0;
        ps->tot_bytes = 0;
        ps->stats_tree = g_node_new(NULL);
+       ps->first_time = 0.0;
+       ps->last_time = 0.0;
+
+       /* Update the progress bar when it gets to this value. */
+       progbar_nextstep = 0;
+       /* When we reach the value that triggers a progress bar update,
+          bump that value by this amount. */
+       progbar_quantum = cfile.count/N_PROGBAR_UPDATES;
+       /* Count of packets at which we've looked. */
+       count = 0;
+
+       stop_flag = FALSE;
+       g_get_current_time(&start_time);
 
-       frame = cfile.plist;
        tot_packets = 0;
        tot_bytes = 0;
 
-       while (frame) {
-               /* Skip frames that are hidden due to the display filter */
-               if (!frame->flags.passed_dfilter) {
-                       continue;
+       for (frame = cfile.plist; frame != NULL; frame = frame->next) {
+               /* Update the progress bar, but do it only N_PROGBAR_UPDATES
+                  times; when we update it, we have to run the GTK+ main
+                  loop to get it to repaint what's pending, and doing so
+                  may involve an "ioctl()" to see if there's any pending
+                  input from an X server, and doing that for every packet
+                  can be costly, especially on a big file. */
+               if (count >= progbar_nextstep) {
+                       /* let's not divide by zero. I should never be started
+                        * with count == 0, so let's assert that
+                        */
+                       g_assert(cfile.count > 0);
+
+                       prog_val = (gfloat) count / cfile.count;
+
+                       if (progbar == NULL)
+                               /* Create the progress bar if necessary */
+                               progbar = delayed_create_progress_dlg(
+                                   "Computing", "protocol hierarchy statistics", 
+                                   &stop_flag, &start_time, prog_val);
+
+                       if (progbar != NULL) {
+                               g_snprintf(status_str, sizeof(status_str),
+                                       "%4u of %u frames", count, cfile.count);
+                               update_progress_dlg(progbar, prog_val, status_str);
+                       }
+
+                       progbar_nextstep += progbar_quantum;
                }
 
-               process_frame(frame, ps);
+               if (stop_flag) {
+                       /* Well, the user decided to abort the statistics.
+                          computation process  Just stop. */
+                       break;
+               }
 
-               tot_packets++;
-               tot_bytes += frame->pkt_len;
+               /* Skip frames that are hidden due to the display filter.
+                  XXX - should the progress bar count only packets that
+                  passed the display filter?  If so, it should
+                  probably do so for other loops (see "file.c") that
+                  look only at those packets. */
+               if (frame->flags.passed_dfilter) {
+
+                       if (tot_packets == 0) {
+                               double cur_time = nstime_to_sec(&frame->abs_ts);
+                               ps->first_time = cur_time;
+                               ps->last_time = cur_time;
+                       }
+                       
+                       /* we don't care about colinfo */
+                       if (!process_frame(frame, NULL, ps)) {
+                               /*
+                                * Give up, and set "stop_flag" so we
+                                * just abort rather than popping up
+                                * the statistics window.
+                                */
+                               stop_flag = TRUE;
+                               break;
+                       }
+
+                       tot_packets++;
+                       tot_bytes += frame->pkt_len;
+               }
+
+               count++;
+       }
 
-               frame = frame->next;
+       /* We're done calculating the statistics; destroy the progress bar
+           if it was created. */
+       if (progbar != NULL)
+               destroy_progress_dlg(progbar);
+
+       if (stop_flag) {
+               /*
+                * We quit in the middle; throw away the statistics
+                * and return NULL, so our caller doesn't pop up a
+                * window with the incomplete statistics.
+                */
+               ph_stats_free(ps);
+               return NULL;
        }
 
        ps->tot_packets = tot_packets;
@@ -179,13 +296,14 @@ ph_stats_new(void)
 }
 
 static gboolean
-stat_node_free(GNode *node, gpointer data)
+stat_node_free(GNode *node, gpointer data _U_)
 {
        ph_stats_node_t *stats = node->data;
 
        if (stats) {
                g_free(stats);
        }
+       return FALSE;
 }
 
 void