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