Give the code that computes protocol statistics a progress dialog box,
[obnox/wireshark/wip.git] / proto_hier_stats.c
1 /* proto_hier_stats.c
2  * Routines for calculating statistics based on protocol.
3  *
4  * $Id: proto_hier_stats.c,v 1.3 2001/03/24 02:07:20 guy Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@zing.org>
8  * Copyright 1998 Gerald Combs
9  *
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  */
25
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include "globals.h"
32 #include "proto_hier_stats.h"
33 #include "progress_dlg.h"
34 #include <wtap.h>
35
36 #include <stdio.h>
37 #include <glib.h>
38
39 /* Update the progress bar this many times when scanning the packet list. */
40 #define N_PROGBAR_UPDATES       100
41
42 static GNode*
43 find_stat_node(GNode *parent_node, header_field_info *needle_hfinfo)
44 {
45         GNode                   *needle_node;
46         field_info              *finfo;
47         ph_stats_node_t *stats;
48
49         needle_node = g_node_first_child(parent_node);
50
51         while (needle_node) {
52                 finfo = needle_node->data;
53                 if (finfo && finfo->hfinfo && finfo->hfinfo->id == needle_hfinfo->id) {
54                         return needle_node;
55                 }
56                 needle_node = g_node_next_sibling(needle_node);
57         }
58
59         /* None found. Create one. */
60         stats = g_new(ph_stats_node_t, 1);
61
62         /* Intialize counters */
63         stats->hfinfo = needle_hfinfo;
64         stats->num_pkts_total = 0;
65         stats->num_pkts_last = 0;
66         stats->num_bytes_total = 0;
67         stats->num_bytes_last = 0;
68
69         needle_node = g_node_new(stats);
70         g_node_append(parent_node, needle_node);
71         return needle_node;
72 }
73
74
75 static void
76 process_node(proto_item *proto_node, GNode *parent_stat_node, ph_stats_t *ps, guint pkt_len)
77 {
78         field_info              *finfo;
79         ph_stats_node_t *stats;
80         proto_item              *proto_sibling_node;
81         GNode                   *stat_node;
82
83         finfo = proto_node->data;
84         g_assert(finfo);
85
86         stat_node = find_stat_node(parent_stat_node, finfo->hfinfo);
87         
88         /* Assert that the finfo is related to a protocol, not a field. */
89         g_assert(finfo->hfinfo->parent == -1);
90
91         stats = stat_node->data;
92         stats->num_pkts_total++;
93         stats->num_bytes_total += pkt_len;
94
95         proto_sibling_node = g_node_next_sibling(proto_node);
96
97         if (proto_sibling_node) {
98                 process_node(proto_sibling_node, stat_node, ps, pkt_len);
99         }
100         else {
101                 stats->num_pkts_last++;
102                 stats->num_bytes_last += pkt_len;
103         }
104 }
105
106
107
108 static void
109 process_tree(proto_tree *protocol_tree, ph_stats_t* ps, guint pkt_len)
110 {
111         proto_item      *proto_node;
112
113         proto_node = g_node_first_child(protocol_tree);
114         if (!proto_node) {
115                 return;
116         }
117
118         process_node(proto_node, ps->stats_tree, ps, pkt_len);
119 }
120
121 static void
122 process_frame(frame_data *frame, ph_stats_t* ps)
123 {
124         epan_dissect_t                  *edt;
125         union wtap_pseudo_header        phdr;
126         proto_tree                      *protocol_tree;
127         guint8                          pd[WTAP_MAX_PACKET_SIZE];
128
129         protocol_tree = proto_tree_create_root();
130
131         /* Load the frame from the capture file */
132         wtap_seek_read(cfile.wth, frame->file_off, &phdr,
133                         pd, frame->cap_len);
134
135         /* Dissect the frame */
136         edt = epan_dissect_new(&phdr, pd, frame, protocol_tree);
137
138         /* Get stats from this protocol tree */
139         process_tree(protocol_tree, ps, frame->pkt_len);
140
141         /* Free our memory. */
142         epan_dissect_free(edt);
143         proto_tree_free(protocol_tree);
144 }
145
146
147
148 ph_stats_t*
149 ph_stats_new(void)
150 {
151         ph_stats_t      *ps;
152         frame_data      *frame;
153         guint           tot_packets, tot_bytes;
154         progdlg_t       *progbar;
155         gboolean        stop_flag;
156         guint32         progbar_quantum;
157         guint32         progbar_nextstep;
158         int             count;
159
160         /* Initialize the data */
161         ps = g_new(ph_stats_t, 1);
162         ps->tot_packets = 0;
163         ps->tot_bytes = 0;
164         ps->stats_tree = g_node_new(NULL);
165
166         /* Update the progress bar when it gets to this value. */
167         progbar_nextstep = 0;
168         /* When we reach the value that triggers a progress bar update,
169            bump that value by this amount. */
170         progbar_quantum = cfile.count/N_PROGBAR_UPDATES;
171         /* Count of packets at which we've looked. */
172         count = 0;
173
174         stop_flag = FALSE;
175         progbar = create_progress_dlg("Computing protocol statistics", "Stop",
176             &stop_flag);
177
178         tot_packets = 0;
179         tot_bytes = 0;
180
181         for (frame = cfile.plist; frame != NULL; frame = frame->next) {
182                 /* Update the progress bar, but do it only N_PROGBAR_UPDATES
183                    times; when we update it, we have to run the GTK+ main
184                    loop to get it to repaint what's pending, and doing so
185                    may involve an "ioctl()" to see if there's any pending
186                    input from an X server, and doing that for every packet
187                    can be costly, especially on a big file. */
188                 if (count >= progbar_nextstep) {
189                         /* let's not divide by zero. I should never be started
190                          * with count == 0, so let's assert that
191                          */
192                         g_assert(cfile.count > 0);
193
194                         update_progress_dlg(progbar,
195                             (gfloat) count / cfile.count);
196
197                         progbar_nextstep += progbar_quantum;
198                 }
199
200                 if (stop_flag) {
201                         /* Well, the user decided to abort the statistics.
202                            computation process  Just stop. */
203                         break;
204                 }
205
206                 /* Skip frames that are hidden due to the display filter.
207                    XXX - should the progress bar count only packets that
208                    passed the display filter?  If so, it should
209                    probably do so for other loops (see "file.c") that
210                    look only at those packets. */
211                 if (frame->flags.passed_dfilter) {
212                         process_frame(frame, ps);
213
214                         tot_packets++;
215                         tot_bytes += frame->pkt_len;
216                 }
217
218                 count++;
219         }
220
221         /* We're done calculating the statistics; destroy the progress bar. */
222         destroy_progress_dlg(progbar);
223
224         if (stop_flag) {
225                 /*
226                  * We quit in the middle; throw away the statistics
227                  * and return NULL, so our caller doesn't pop up a
228                  * window with the incomplete statistics.
229                  */
230                 ph_stats_free(ps);
231                 return NULL;
232         }
233
234         ps->tot_packets = tot_packets;
235         ps->tot_bytes = tot_bytes;
236
237         return ps;
238 }
239
240 static gboolean
241 stat_node_free(GNode *node, gpointer data)
242 {
243         ph_stats_node_t *stats = node->data;
244
245         if (stats) {
246                 g_free(stats);
247         }
248         return FALSE;
249 }
250
251 void
252 ph_stats_free(ph_stats_t *ps)
253 {
254
255         if (ps->stats_tree) {
256                 g_node_traverse(ps->stats_tree, G_IN_ORDER,
257                                 G_TRAVERSE_ALL, -1,
258                                 stat_node_free, NULL);
259                 g_node_destroy(ps->stats_tree);
260         }
261
262         g_free(ps);
263 }