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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 #include "proto_hier_stats.h"
31 #include "ui/progress_dlg.h"
32 #include <epan/epan_dissect.h>
39 /* Update the progress bar this many times when scanning the packet list. */
40 #define N_PROGBAR_UPDATES 100
42 #define STAT_NODE_STATS(n) ((ph_stats_node_t*)(n)->data)
43 #define STAT_NODE_HFINFO(n) (STAT_NODE_STATS(n)->hfinfo)
47 find_stat_node(GNode *parent_stat_node, header_field_info *needle_hfinfo)
49 GNode *needle_stat_node;
50 header_field_info *hfinfo;
51 ph_stats_node_t *stats;
53 needle_stat_node = g_node_first_child(parent_stat_node);
55 while (needle_stat_node) {
56 hfinfo = STAT_NODE_HFINFO(needle_stat_node);
57 if (hfinfo && hfinfo->id == needle_hfinfo->id) {
58 return needle_stat_node;
60 needle_stat_node = g_node_next_sibling(needle_stat_node);
63 /* None found. Create one. */
64 stats = g_new(ph_stats_node_t, 1);
66 /* Intialize counters */
67 stats->hfinfo = needle_hfinfo;
68 stats->num_pkts_total = 0;
69 stats->num_pkts_last = 0;
70 stats->num_bytes_total = 0;
71 stats->num_bytes_last = 0;
73 needle_stat_node = g_node_new(stats);
74 g_node_append(parent_stat_node, needle_stat_node);
75 return needle_stat_node;
80 process_node(proto_node *ptree_node, GNode *parent_stat_node, ph_stats_t *ps, guint pkt_len)
83 ph_stats_node_t *stats;
84 proto_node *proto_sibling_node;
87 finfo = PNODE_FINFO(ptree_node);
88 /* We don't fake protocol nodes we expect them to have a field_info.
89 * Dissection with faked proto tree? */
92 /* If the field info isn't related to a protocol but to a field,
93 * don't count them, as they don't belong to any protocol.
94 * (happens e.g. for toplevel tree item of desegmentation "[Reassembled TCP Segments]") */
95 if (finfo->hfinfo->parent != -1) {
96 /* Skip this element, use parent status node */
97 stat_node = parent_stat_node;
98 stats = STAT_NODE_STATS(stat_node);
100 stat_node = find_stat_node(parent_stat_node, finfo->hfinfo);
102 stats = STAT_NODE_STATS(stat_node);
103 stats->num_pkts_total++;
104 stats->num_bytes_total += pkt_len;
107 proto_sibling_node = ptree_node->next;
109 if (proto_sibling_node) {
110 /* If the name does not exist for this proto_sibling_node, then it is
111 * not a normal protocol in the top-level tree. It was instead
112 * added as a normal tree such as IPv6's Hop-by-hop Option Header and
113 * should be skipped when creating the protocol hierarchy display. */
114 if(strlen(PNODE_FINFO(proto_sibling_node)->hfinfo->name) == 0 && ptree_node->next)
115 proto_sibling_node = proto_sibling_node->next;
117 process_node(proto_sibling_node, stat_node, ps, pkt_len);
119 stats->num_pkts_last++;
120 stats->num_bytes_last += pkt_len;
127 process_tree(proto_tree *protocol_tree, ph_stats_t* ps, guint pkt_len)
129 proto_node *ptree_node;
131 ptree_node = ((proto_node *)protocol_tree)->first_child;
136 process_node(ptree_node, ps->stats_tree, ps, pkt_len);
140 process_frame(frame_data *frame, column_info *cinfo, ph_stats_t* ps)
143 struct wtap_pkthdr phdr;
144 guint8 pd[WTAP_MAX_PACKET_SIZE];
147 /* Load the frame from the capture file */
148 if (!cf_read_frame_r(&cfile, frame, &phdr, pd))
149 return FALSE; /* failure */
151 /* Dissect the frame tree not visible */
152 epan_dissect_init(&edt, TRUE, FALSE);
153 /* Don't fake protocols. We need them for the protocol hierarchy */
154 epan_dissect_fake_protocols(&edt, FALSE);
155 epan_dissect_run(&edt, &phdr, pd, frame, cinfo);
157 /* Get stats from this protocol tree */
158 process_tree(edt.tree, ps, frame->pkt_len);
161 cur_time = nstime_to_sec(&frame->abs_ts);
162 if (cur_time < ps->first_time) {
163 ps->first_time = cur_time;
165 if (cur_time > ps->last_time){
166 ps->last_time = cur_time;
169 /* Free our memory. */
170 epan_dissect_cleanup(&edt);
172 return TRUE; /* success */
181 guint tot_packets, tot_bytes;
182 progdlg_t *progbar = NULL;
187 gchar status_str[100];
188 int progbar_nextstep;
191 /* Initialize the data */
192 ps = g_new(ph_stats_t, 1);
195 ps->stats_tree = g_node_new(NULL);
196 ps->first_time = 0.0;
199 /* Update the progress bar when it gets to this value. */
200 progbar_nextstep = 0;
201 /* When we reach the value that triggers a progress bar update,
202 bump that value by this amount. */
203 progbar_quantum = cfile.count/N_PROGBAR_UPDATES;
204 /* Count of packets at which we've looked. */
206 /* Progress so far. */
210 g_get_current_time(&start_time);
215 for (framenum = 1; framenum <= cfile.count; framenum++) {
216 frame = frame_data_sequence_find(cfile.frames, framenum);
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 cfile.window, "Computing",
227 "protocol hierarchy statistics",
228 TRUE, &stop_flag, &start_time, progbar_val);
230 /* Update the progress bar, but do it only N_PROGBAR_UPDATES
231 times; when we update it, we have to run the GTK+ main
232 loop to get it to repaint what's pending, and doing so
233 may involve an "ioctl()" to see if there's any pending
234 input from an X server, and doing that for every packet
235 can be costly, especially on a big file. */
236 if (count >= progbar_nextstep) {
237 /* let's not divide by zero. I should never be started
238 * with count == 0, so let's assert that
240 g_assert(cfile.count > 0);
242 progbar_val = (gfloat) count / cfile.count;
244 if (progbar != NULL) {
245 g_snprintf(status_str, sizeof(status_str),
246 "%4u of %u frames", count, cfile.count);
247 update_progress_dlg(progbar, progbar_val, status_str);
250 progbar_nextstep += progbar_quantum;
254 /* Well, the user decided to abort the statistics.
255 computation process Just stop. */
259 /* Skip frames that are hidden due to the display filter.
260 XXX - should the progress bar count only packets that
261 passed the display filter? If so, it should
262 probably do so for other loops (see "file.c") that
263 look only at those packets. */
264 if (frame->flags.passed_dfilter) {
266 if (tot_packets == 0) {
267 double cur_time = nstime_to_sec(&frame->abs_ts);
268 ps->first_time = cur_time;
269 ps->last_time = cur_time;
272 /* we don't care about colinfo */
273 if (!process_frame(frame, NULL, ps)) {
275 * Give up, and set "stop_flag" so we
276 * just abort rather than popping up
277 * the statistics window.
284 tot_bytes += frame->pkt_len;
290 /* We're done calculating the statistics; destroy the progress bar
291 if it was created. */
293 destroy_progress_dlg(progbar);
297 * We quit in the middle; throw away the statistics
298 * and return NULL, so our caller doesn't pop up a
299 * window with the incomplete statistics.
305 ps->tot_packets = tot_packets;
306 ps->tot_bytes = tot_bytes;
312 stat_node_free(GNode *node, gpointer data _U_)
314 ph_stats_node_t *stats = (ph_stats_node_t *)node->data;
323 ph_stats_free(ph_stats_t *ps)
326 if (ps->stats_tree) {
327 g_node_traverse(ps->stats_tree, G_IN_ORDER,
329 stat_node_free, NULL);
330 g_node_destroy(ps->stats_tree);