2 * Routines for calculating statistics based on protocol.
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
30 #include "proto_hier_stats.h"
31 #include "progress_dlg.h"
32 #include "simple_dialog.h"
33 #include <epan/epan_dissect.h>
40 /* Update the progress bar this many times when scanning the packet list. */
41 #define N_PROGBAR_UPDATES 100
43 #define STAT_NODE_STATS(n) ((ph_stats_node_t*)(n)->data)
44 #define STAT_NODE_HFINFO(n) (STAT_NODE_STATS(n)->hfinfo)
48 find_stat_node(GNode *parent_stat_node, header_field_info *needle_hfinfo)
50 GNode *needle_stat_node;
51 header_field_info *hfinfo;
52 ph_stats_node_t *stats;
54 needle_stat_node = g_node_first_child(parent_stat_node);
56 while (needle_stat_node) {
57 hfinfo = STAT_NODE_HFINFO(needle_stat_node);
58 if (hfinfo && hfinfo->id == needle_hfinfo->id) {
59 return needle_stat_node;
61 needle_stat_node = g_node_next_sibling(needle_stat_node);
64 /* None found. Create one. */
65 stats = g_new(ph_stats_node_t, 1);
67 /* Intialize counters */
68 stats->hfinfo = needle_hfinfo;
69 stats->num_pkts_total = 0;
70 stats->num_pkts_last = 0;
71 stats->num_bytes_total = 0;
72 stats->num_bytes_last = 0;
74 needle_stat_node = g_node_new(stats);
75 g_node_append(parent_stat_node, needle_stat_node);
76 return needle_stat_node;
81 process_node(proto_node *ptree_node, GNode *parent_stat_node, ph_stats_t *ps, guint pkt_len)
84 ph_stats_node_t *stats;
85 proto_node *proto_sibling_node;
88 finfo = PITEM_FINFO(ptree_node);
91 /* If the field info isn't related to a protocol but to a field,
92 * don't count them, as they don't belong to any protocol.
93 * (happens e.g. for toplevel tree item of desegmentation "[Reassembled TCP Segments]") */
94 if (finfo->hfinfo->parent != -1) {
95 /* Skip this element, use parent status node */
96 stat_node = parent_stat_node;
97 stats = STAT_NODE_STATS(stat_node);
99 stat_node = find_stat_node(parent_stat_node, finfo->hfinfo);
101 stats = STAT_NODE_STATS(stat_node);
102 stats->num_pkts_total++;
103 stats->num_bytes_total += pkt_len;
106 proto_sibling_node = ptree_node->next;
108 if (proto_sibling_node) {
109 /* If the name does not exist for this proto_sibling_node, then it is
110 * not a normal protocol in the top-level tree. It was instead
111 * added as a normal tree such as IPv6's Hop-by-hop Option Header and
112 * should be skipped when creating the protocol hierarchy display. */
113 if(strlen(proto_sibling_node->finfo->hfinfo->name) == 0 && ptree_node->next)
114 proto_sibling_node = proto_sibling_node->next;
116 process_node(proto_sibling_node, stat_node, ps, pkt_len);
118 stats->num_pkts_last++;
119 stats->num_bytes_last += pkt_len;
126 process_tree(proto_tree *protocol_tree, ph_stats_t* ps, guint pkt_len)
128 proto_node *ptree_node;
130 ptree_node = ((proto_node *)protocol_tree)->first_child;
135 process_node(ptree_node, ps->stats_tree, ps, pkt_len);
139 process_frame(frame_data *frame, column_info *cinfo, ph_stats_t* ps)
142 union wtap_pseudo_header phdr;
143 guint8 pd[WTAP_MAX_PACKET_SIZE];
148 /* Load the frame from the capture file */
149 if (!wtap_seek_read(cfile.wth, frame->file_off, &phdr, pd,
150 frame->cap_len, &err, &err_info)) {
151 simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
152 cf_read_error_message(err, err_info), cfile.filename);
153 return FALSE; /* failure */
156 /* Dissect the frame tree not visible */
157 edt = epan_dissect_new(TRUE, FALSE);
158 epan_dissect_run(edt, &phdr, pd, frame, cinfo);
160 /* Get stats from this protocol tree */
161 process_tree(edt->tree, ps, frame->pkt_len);
164 cur_time = nstime_to_sec(&frame->abs_ts);
165 if (cur_time < ps->first_time) {
166 ps->first_time = cur_time;
168 if (cur_time > ps->last_time){
169 ps->last_time = cur_time;
172 /* Free our memory. */
173 epan_dissect_free(edt);
175 return TRUE; /* success */
183 guint tot_packets, tot_bytes;
184 progdlg_t *progbar = NULL;
189 gchar status_str[100];
190 int progbar_nextstep;
193 /* Initialize the data */
194 ps = g_new(ph_stats_t, 1);
197 ps->stats_tree = g_node_new(NULL);
198 ps->first_time = 0.0;
201 /* Update the progress bar when it gets to this value. */
202 progbar_nextstep = 0;
203 /* When we reach the value that triggers a progress bar update,
204 bump that value by this amount. */
205 progbar_quantum = cfile.count/N_PROGBAR_UPDATES;
206 /* Count of packets at which we've looked. */
208 /* Progress so far. */
212 g_get_current_time(&start_time);
217 for (frame = cfile.plist; frame != NULL; frame = frame->next) {
218 /* Create the progress bar if necessary.
219 We check on every iteration of the loop, so that
220 it takes no longer than the standard time to create
221 it (otherwise, for a large file, we might take
222 considerably longer than that standard time in order
223 to get to the next progress bar step). */
225 progbar = delayed_create_progress_dlg(
226 "Computing", "protocol hierarchy statistics",
227 TRUE, &stop_flag, &start_time, progbar_val);
229 /* Update the progress bar, but do it only N_PROGBAR_UPDATES
230 times; when we update it, we have to run the GTK+ main
231 loop to get it to repaint what's pending, and doing so
232 may involve an "ioctl()" to see if there's any pending
233 input from an X server, and doing that for every packet
234 can be costly, especially on a big file. */
235 if (count >= progbar_nextstep) {
236 /* let's not divide by zero. I should never be started
237 * with count == 0, so let's assert that
239 g_assert(cfile.count > 0);
241 progbar_val = (gfloat) count / cfile.count;
243 if (progbar != NULL) {
244 g_snprintf(status_str, sizeof(status_str),
245 "%4u of %u frames", count, cfile.count);
246 update_progress_dlg(progbar, progbar_val, status_str);
249 progbar_nextstep += progbar_quantum;
253 /* Well, the user decided to abort the statistics.
254 computation process Just stop. */
258 /* Skip frames that are hidden due to the display filter.
259 XXX - should the progress bar count only packets that
260 passed the display filter? If so, it should
261 probably do so for other loops (see "file.c") that
262 look only at those packets. */
263 if (frame->flags.passed_dfilter) {
265 if (tot_packets == 0) {
266 double cur_time = nstime_to_sec(&frame->abs_ts);
267 ps->first_time = cur_time;
268 ps->last_time = cur_time;
271 /* we don't care about colinfo */
272 if (!process_frame(frame, NULL, ps)) {
274 * Give up, and set "stop_flag" so we
275 * just abort rather than popping up
276 * the statistics window.
283 tot_bytes += frame->pkt_len;
289 /* We're done calculating the statistics; destroy the progress bar
290 if it was created. */
292 destroy_progress_dlg(progbar);
296 * We quit in the middle; throw away the statistics
297 * and return NULL, so our caller doesn't pop up a
298 * window with the incomplete statistics.
304 ps->tot_packets = tot_packets;
305 ps->tot_bytes = tot_bytes;
311 stat_node_free(GNode *node, gpointer data _U_)
313 ph_stats_node_t *stats = node->data;
322 ph_stats_free(ph_stats_t *ps)
325 if (ps->stats_tree) {
326 g_node_traverse(ps->stats_tree, G_IN_ORDER,
328 stat_node_free, NULL);
329 g_node_destroy(ps->stats_tree);