In ICMP taps, don't use g_slist_insert_sorted (which results in
[metze/wireshark/wip.git] / ui / cli / tap-icmpstat.c
1 /* tap-icmpstat.c
2  * icmpstat   2011 Christopher Maynard
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
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.
14  *
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.
19  *
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.
23  */
24
25 /* This module provides icmp echo request/reply SRT statistics to tshark.
26  * It is only used by tshark and not wireshark
27  *
28  * It was based on tap-rpcstat.c and doc/README.tapping.
29  */
30
31 #include "config.h"
32
33 #include <stdio.h>
34
35 #include <string.h>
36 #include "epan/packet_info.h"
37 #include <epan/tap.h>
38 #include <epan/stat_cmd_args.h>
39 #include <epan/dissectors/packet-icmp.h>
40 #include <math.h>
41
42 /* used to keep track of the ICMP statistics */
43 typedef struct _icmpstat_t {
44     char *filter;
45     GSList *rt_list;
46     guint num_rqsts;
47     guint num_resps;
48     guint min_frame;
49     guint max_frame;
50     double min_msecs;
51     double max_msecs;
52     double tot_msecs;
53 } icmpstat_t;
54
55
56 /* This callback is never used by tshark but it is here for completeness.  When
57  * registering below, we could just have left this function as NULL.
58  *
59  * When used by wireshark, this function will be called whenever we would need
60  * to reset all state, such as when wireshark opens a new file, when it starts
61  * a new capture, when it rescans the packetlist after some prefs have changed,
62  * etc.
63  *
64  * So if your application has some state it needs to clean up in those
65  * situations, here is a good place to put that code.
66  */
67 static void
68 icmpstat_reset(void *tapdata)
69 {
70     icmpstat_t *icmpstat = (icmpstat_t *)tapdata;
71
72     g_slist_free(icmpstat->rt_list);
73     memset(icmpstat, 0, sizeof(icmpstat_t));
74     icmpstat->min_msecs = 1.0 * G_MAXUINT;
75 }
76
77
78 static gint compare_doubles(gconstpointer a, gconstpointer b)
79 {
80     double ad, bd;
81
82     ad = *(double *)a;
83     bd = *(double *)b;
84
85     if (ad < bd)
86         return -1;
87     if (ad > bd)
88         return 1;
89     return 0;
90 }
91
92
93 /* This callback is invoked whenever the tap system has seen a packet we might
94  * be interested in.  The function is to be used to only update internal state
95  * information in the *tapdata structure, and if there were state changes which
96  * requires the window to be redrawn, return 1 and (*draw) will be called
97  * sometime later.
98  *
99  * This function should be as lightweight as possible since it executes
100  * together with the normal wireshark dissectors.  Try to push as much
101  * processing as possible into (*draw) instead since that function executes
102  * asynchronously and does not affect the main thread's performance.
103  *
104  * If it is possible, try to do all "filtering" explicitly since you will get
105  * MUCH better performance than applying a similar display-filter in the
106  * register call.
107  *
108  * The third parameter is tap dependent.  Since we register this one to the
109  * "icmp" tap, the third parameter type is icmp_transaction_t.
110  *
111  * function returns :
112  *  0: no updates, no need to call (*draw) later
113  * !0: state has changed, call (*draw) sometime later
114  */
115 static int
116 icmpstat_packet(void *tapdata, packet_info *pinfo _U_, epan_dissect_t *edt _U_, const void *data)
117 {
118     icmpstat_t *icmpstat = (icmpstat_t *)tapdata;
119     const icmp_transaction_t *trans = (const icmp_transaction_t *)data;
120     double resp_time, *rt;
121
122     if (trans == NULL)
123         return 0;
124
125     if (trans->resp_frame) {
126         resp_time = nstime_to_msec(&trans->resp_time);
127         rt = g_new(double,1);
128         if (rt == NULL)
129             return 0;
130         *rt = resp_time;
131         icmpstat->rt_list = g_slist_prepend(icmpstat->rt_list, rt);
132         icmpstat->num_resps++;
133         if (icmpstat->min_msecs > resp_time) {
134             icmpstat->min_frame = trans->resp_frame;
135             icmpstat->min_msecs = resp_time;
136         }
137         if (icmpstat->max_msecs < resp_time) {
138             icmpstat->max_frame = trans->resp_frame;
139             icmpstat->max_msecs = resp_time;
140         }
141         icmpstat->tot_msecs += resp_time;
142     } else if (trans->rqst_frame)
143         icmpstat->num_rqsts++;
144     else
145         return 0;
146
147     return 1;
148 }
149
150
151 /*
152  * Compute the mean, median and standard deviation.
153  */
154 static void compute_stats(icmpstat_t *icmpstat, double *mean, double *med, double *sdev)
155 {
156     GSList *slist;
157     double diff;
158     double sq_diff_sum = 0.0;
159
160     icmpstat->rt_list = g_slist_sort(icmpstat->rt_list, compare_doubles);
161     slist = icmpstat->rt_list;
162
163     if (icmpstat->num_resps == 0 || slist == NULL) {
164         *mean = 0.0;
165         *med = 0.0;
166         *sdev = 0.0;
167         return;
168     }
169
170     /* (arithmetic) mean */
171     *mean = icmpstat->tot_msecs / icmpstat->num_resps;
172
173     /* median: If we have an odd number of elements in our list, then the
174      * median is simply the middle element, otherwise the median is computed by
175      * averaging the 2 elements on either side of the mid-point. */
176     if (icmpstat->num_resps & 1)
177         *med = *(double *)g_slist_nth_data(slist, icmpstat->num_resps / 2);
178     else {
179         *med =
180             (*(double *)g_slist_nth_data(slist, (icmpstat->num_resps - 1) / 2) +
181             *(double *)g_slist_nth_data(slist, icmpstat->num_resps / 2)) / 2;
182     }
183
184     /* (sample) standard deviation */
185     for ( ; slist; slist = g_slist_next(slist)) {
186         diff = *(double *)slist->data - *mean;
187         sq_diff_sum += diff * diff;
188     }
189     if (icmpstat->num_resps > 1)
190         *sdev = sqrt(sq_diff_sum / (icmpstat->num_resps - 1));
191     else
192         *sdev = 0.0;
193 }
194
195
196 /* This callback is used when tshark wants us to draw/update our data to the
197  * output device.  Since this is tshark, the only output is stdout.
198  * TShark will only call this callback once, which is when tshark has finished
199  * reading all packets and exits.
200  * If used with wireshark this may be called any time, perhaps once every 3
201  * seconds or so.
202  * This function may even be called in parallel with (*reset) or (*draw), so
203  * make sure there are no races.  The data in the icmpstat_t can thus change
204  * beneath us.  Beware!
205  *
206  * How best to display the data?  For now, following other tap statistics
207  * output, but here are a few other alternatives we might choose from:
208  *
209  * -> Windows ping output:
210  *      Ping statistics for <IP>:
211  *          Packets: Sent = <S>, Received = <R>, Lost = <L> (<LP>% loss),
212  *      Approximate round trip times in milli-seconds:
213  *          Minimum = <m>ms, Maximum = <M>ms, Average = <A>ms
214  *
215  * -> Cygwin ping output:
216  *      ----<HOST> PING Statistics----
217  *      <S> packets transmitted, <R> packets received, <LP>% packet loss
218  *      round-trip (ms)  min/avg/max/med = <m>/<M>/<A>/<D>
219  *
220  * -> Linux ping output:
221  *      --- <HOST> ping statistics ---
222  *      <S> packets transmitted, <R> received, <LP>% packet loss, time <T>ms
223  *      rtt min/avg/max/mdev = <m>/<A>/<M>/<D> ms
224  */
225 static void
226 icmpstat_draw(void *tapdata)
227 {
228     icmpstat_t *icmpstat = (icmpstat_t *)tapdata;
229     unsigned int lost;
230     double mean, sdev, med;
231
232     printf("\n");
233     printf("==========================================================================\n");
234     printf("ICMP Service Response Time (SRT) Statistics (all times in ms):\n");
235     printf("Filter: %s\n", icmpstat->filter ? icmpstat->filter : "<none>");
236     printf("\nRequests  Replies   Lost      %% Loss\n");
237
238     if (icmpstat->num_rqsts) {
239         lost =  icmpstat->num_rqsts - icmpstat->num_resps;
240         compute_stats(icmpstat, &mean, &med, &sdev);
241
242         printf("%-10u%-10u%-10u%5.1f%%\n\n",
243             icmpstat->num_rqsts, icmpstat->num_resps, lost,
244             100.0 * lost / icmpstat->num_rqsts);
245         printf("Minimum   Maximum   Mean      Median    SDeviation     Min Frame Max Frame\n");
246         printf("%-10.3f%-10.3f%-10.3f%-10.3f%-10.3f     %-10u%-10u\n",
247             icmpstat->min_msecs >= G_MAXUINT ? 0.0 : icmpstat->min_msecs,
248             icmpstat->max_msecs, mean, med, sdev,
249             icmpstat->min_frame, icmpstat->max_frame);
250     } else {
251         printf("0         0         0           0.0%%\n\n");
252         printf("Minimum   Maximum   Mean      Median    SDeviation     Min Frame Max Frame\n");
253         printf("0.000     0.000     0.000     0.000     0.000          0         0\n");
254     }
255     printf("==========================================================================\n");
256 }
257
258
259 /* When called, this function will create a new instance of icmpstat.
260  *
261  * This function is called from tshark when it parses the -z icmp, arguments
262  * and it creates a new instance to store statistics in and registers this new
263  * instance for the icmp tap.
264  */
265 static void
266 icmpstat_init(const char *optarg, void* userdata _U_)
267 {
268     icmpstat_t *icmpstat;
269     const char *filter = NULL;
270     GString *error_string;
271
272     if (strstr(optarg, "icmp,srt,"))
273         filter = optarg + strlen("icmp,srt,");
274
275     icmpstat = (icmpstat_t *)g_try_malloc(sizeof(icmpstat_t));
276     if (icmpstat == NULL) {
277         fprintf(stderr, "tshark: g_try_malloc() fatal error.\n");
278         exit(1);
279     }
280     memset(icmpstat, 0, sizeof(icmpstat_t));
281     icmpstat->min_msecs = 1.0 * G_MAXUINT;
282
283     if (filter)
284         icmpstat->filter = g_strdup(filter);
285
286 /* It is possible to create a filter and attach it to the callbacks.  Then the
287  * callbacks would only be invoked if the filter matched.
288  *
289  * Evaluating filters is expensive and if we can avoid it and not use them,
290  * then we gain performance.
291  *
292  * In this case we do the filtering for protocol and version inside the
293  * callback itself but use whatever filter the user provided.
294  */
295
296     error_string = register_tap_listener("icmp", icmpstat, icmpstat->filter,
297         TL_REQUIRES_NOTHING, icmpstat_reset, icmpstat_packet, icmpstat_draw);
298     if (error_string) {
299         /* error, we failed to attach to the tap. clean up */
300         if (icmpstat->filter)
301             g_free(icmpstat->filter);
302         g_free(icmpstat);
303
304         fprintf(stderr, "tshark: Couldn't register icmp,srt tap: %s\n",
305             error_string->str);
306         g_string_free(error_string, TRUE);
307         exit(1);
308     }
309 }
310
311
312 void
313 register_tap_listener_icmpstat(void)
314 {
315     register_stat_cmd_arg("icmp,srt", icmpstat_init, NULL);
316 }
317