Get rid of -Wshadow warning - I guess we're including something that
[metze/wireshark/wip.git] / ui / cli / tap-camelsrt.c
1 /* tap_camelsrt.c
2  * CAMEL Service Response Time statistics for tshark
3  * Copyright 2006 Florent Drouin (based on tap_h225rassrt.c from Lars Roland)
4  *
5  * $Id$
6  *
7  * Wireshark - Network traffic analyzer
8  * By Gerald Combs <gerald@wireshark.org>
9  * Copyright 1998 Gerald Combs
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24  */
25
26 #include "config.h"
27
28 #include <stdio.h>
29
30 #include <string.h>
31 #include "epan/packet.h"
32 #include "epan/packet_info.h"
33 #include <epan/tap.h>
34 #include "epan/value_string.h"
35 #include "epan/asn1.h"
36 #include "epan/dissectors/packet-camel.h"
37 #include "epan/camel-persistentdata.h"
38 #include "epan/timestats.h"
39 #include "epan/stat_cmd_args.h"
40
41
42 void register_tap_listener_camelsrt(void);
43
44 /* Save the the first NUM_RAS_STATS stats in the array to calculate percentile */
45 #define NUM_RAS_STATS 500000
46
47 /* Number of couple message Request/Response to analyze*/
48 #define NB_CRITERIA 7
49
50 /* used to keep track of the statistics for an entire program interface */
51 struct camelsrt_t {
52   char *filter;
53   guint32 count[NB_CAMELSRT_CATEGORY];
54   timestat_t stats[NB_CAMELSRT_CATEGORY];
55   nstime_t delta_time[NB_CAMELSRT_CATEGORY][NUM_RAS_STATS];
56 };
57
58 /* Reset the counter */
59 static void camelsrt_reset(void *phs)
60 {
61   struct camelsrt_t *hs=(struct camelsrt_t *)phs;
62   memset(hs,0,sizeof(struct camelsrt_t));
63 }
64
65
66 static int camelsrt_packet(void *phs,
67                            packet_info *pinfo _U_,
68                            epan_dissect_t *edt _U_,
69                            const void *phi)
70 {
71   struct camelsrt_t *hs=(struct camelsrt_t *)phs;
72   const struct camelsrt_info_t * pi=(const struct camelsrt_info_t *)phi;
73   int i;
74
75   for (i=0; i<NB_CAMELSRT_CATEGORY; i++) {
76     if (pi->bool_msginfo[i] &&
77         pi->msginfo[i].is_delta_time
78         && pi->msginfo[i].request_available
79         && !pi->msginfo[i].is_duplicate ) {
80
81       time_stat_update(&(hs->stats[i]),
82                        &(pi->msginfo[i].delta_time),
83                        pinfo);
84
85       if (hs->count[i] < NUM_RAS_STATS) {
86         hs->delta_time[i][hs->count[i]++]
87           = pi->msginfo[i].delta_time;
88       }
89     }
90   }
91   return 1;
92 }
93
94
95 static void camelsrt_draw(void *phs)
96 {
97   struct camelsrt_t *hs=(struct camelsrt_t *)phs;
98   guint j,z;
99   guint32 li;
100   int somme,iteration=0;
101   timestat_t *rtd_temp;
102   double x,delay,delay_max,delay_min,delta;
103   double criteria[NB_CRITERIA]={ 5.0, 10.0, 75.0, 90.0, 95.0,99.0,99.90 };
104   double delay_criteria[NB_CRITERIA];
105
106   printf("\n");
107   printf("Camel Service Response Time (SRT) Statistics:\n");
108   printf("=================================================================================================\n");
109   printf("|        Category         | Measure |  Min SRT  |  Max SRT  |  Avg SRT  | Min frame | Max frame |\n");
110   printf("|-------------------------|---------|-----------|-----------|-----------|-----------|-----------|\n");
111
112   j=1;
113   printf("|%24s |%8u |%8.2f s |%8.2f s |%8.2f s |%10u |%10u |\n",
114          val_to_str(j,camelSRTtype_naming,"Unknown Message 0x%02x"),
115          hs->stats[j].num,
116          nstime_to_sec(&(hs->stats[j].min)),
117          nstime_to_sec(&(hs->stats[j].max)),
118          get_average(&(hs->stats[j].tot),hs->stats[j].num)/1000.0,
119          hs->stats[j].min_num,
120          hs->stats[j].max_num
121          );
122   for(j=2; j<NB_CAMELSRT_CATEGORY; j++) {
123     if(hs->stats[j].num==0){
124       printf("|%24s |%8u |%8.2f ms|%8.2f ms|%8.2f ms|%10u |%10u |\n",
125              val_to_str(j,camelSRTtype_naming,"Unknown Message 0x%02x"),
126              0, 0.0, 0.0, 0.0, 0, 0);
127       continue;
128     }
129
130     printf("|%24s |%8u |%8.2f ms|%8.2f ms|%8.2f ms|%10u |%10u |\n",
131            val_to_str(j,camelSRTtype_naming,"Unknown Message 0x%02x"),
132            hs->stats[j].num,
133            MIN(9999,nstime_to_msec(&(hs->stats[j].min))),
134            MIN(9999,nstime_to_msec(&(hs->stats[j].max))),
135            MIN(9999,get_average(&(hs->stats[j].tot),hs->stats[j].num)),
136            hs->stats[j].min_num,
137            hs->stats[j].max_num
138            );
139   } /* j category */
140
141   printf("=================================================================================================\n");
142   /*
143    * Display 95%
144    */
145
146   printf("|   Category/Criteria     |");
147   for(z=0; z<NB_CRITERIA; z++) printf("%7.2f%% |", criteria[z]);
148   printf("\n");
149
150   printf("|-------------------------|");
151   for(z=0; z<NB_CRITERIA; z++) printf("---------|");
152   printf("\n");
153   /* calculate the delay max to have a given number of messages (in percentage) */
154   for(j=2;j<NB_CAMELSRT_CATEGORY;j++) {
155
156     rtd_temp = &(hs->stats[j]);
157
158     if (hs->count[j]>0) {
159       /* Calculate the delay to answer to p% of the MS */
160       for(z=0; z<NB_CRITERIA; z++) {
161         iteration=0;
162         delay_max=(double)rtd_temp->max.secs*1000 +(double)rtd_temp->max.nsecs/1000000;
163         delay_min=(double)rtd_temp->min.secs*1000 +(double)rtd_temp->min.nsecs/1000000;
164         delay=delay_min;
165         delta=delay_max-delay_min;
166         while( (delta > 0.001) && (iteration < 10000) ) {
167           somme=0;
168           iteration++;
169
170           for(li=0;li<hs->count[j];li++) {
171             x=hs->delta_time[j][li].secs*1000
172               + (double)hs->delta_time[j][li].nsecs/1000000;
173             if (x <= delay) somme++;
174           }
175           if ( somme*100 > hs->count[j]*criteria[z] ) { /* trop grand */
176             delay_max=delay;
177             delay=(delay_max+delay_min)/2;
178             delta=delay_max-delay_min;
179           } else { /* trop petit */
180             delay_min=delay;
181             delay=(delay_max+delay_min)/2;
182             delta=delay_max-delay_min;
183           }
184         } /* while */
185         delay_criteria[z]=delay;
186       } /* z criteria */
187       /* Append the result to the table */
188       printf("X%24s |", val_to_str(j, camelSRTtype_naming, "Unknown") );
189       for(z=0; z<NB_CRITERIA; z++) printf("%8.2f |", MIN(9999,delay_criteria[z]));
190       printf("\n");
191     } else { /* count */
192       printf("X%24s |", val_to_str(j, camelSRTtype_naming, "Unknown") );
193       for(z=0; z<NB_CRITERIA; z++) printf("%8.2f |", 0.0);
194       printf("\n");
195     } /* count */
196   }/* j category */
197   printf("===========================");
198   for(z=0; z<NB_CRITERIA; z++) printf("==========");
199   printf("\n");
200 }
201
202 static void camelsrt_init(const char *opt_arg, void* userdata _U_)
203 {
204   struct camelsrt_t *p_camelsrt;
205   GString *error_string;
206
207   p_camelsrt = g_new(struct camelsrt_t,1);
208   if(!strncmp(opt_arg,"camel,srt,",9)){
209     p_camelsrt->filter=g_strdup(opt_arg+9);
210   } else {
211     p_camelsrt->filter=NULL;
212   }
213   camelsrt_reset(p_camelsrt);
214
215   error_string=register_tap_listener("CAMEL",
216                                      p_camelsrt,
217                                      p_camelsrt->filter,
218                                      0,
219                                      NULL,
220                                      camelsrt_packet,
221                                      camelsrt_draw);
222
223   if(error_string){
224     /* error, we failed to attach to the tap. clean up */
225     g_free(p_camelsrt->filter);
226     g_free(p_camelsrt);
227
228     fprintf(stderr, "tshark: Couldn't register camel,srt tap: %s\n",
229             error_string->str);
230     g_string_free(error_string, TRUE);
231     exit(1);
232   }
233
234   /*
235    * If we are using tshark, we have to display the stats, even if the stats are not persistent
236    * As the frame are proceeded in the chronological order, we do not need persistent stats
237    * Whereas, with wireshark, it is not possible to have the correct display, if the stats are
238    * not saved along the analyze
239    */
240   gtcap_StatSRT=TRUE;
241   gcamel_StatSRT=TRUE;
242 }
243
244
245 void /* Next line mandatory */
246 register_tap_listener_camelsrt(void)
247 {
248   register_stat_cmd_arg("camel,srt", camelsrt_init, NULL);
249 }