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  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <stdio.h>
  29
  30 #ifdef HAVE_SYS_TYPES_H
  31 # include <sys/types.h>
  32 #endif
  33
  34 #include <string.h>
  35 #include "epan/packet_info.h"
  36 #include <epan/tap.h>
  37 #include "epan/value_string.h"
  38 #include "register.h"
  39 #include "epan/dissectors/packet-camel.h"
  40 #include "epan/camel-persistentdata.h"
  41 #include "timestats.h"
  42 #include "epan/stat_cmd_args.h"
  43
  44 #undef  MIN
  45 #define MIN(x,y) ((x) < (y) ? (x) : (y))
  46
  47 void register_tap_listener_camelsrt(void);
  48
  49 /* Save the the first NUM_RAS_STATS stats in the array to calculate percentile */
  50 #define NUM_RAS_STATS 500000
  51
  52 /* Number of couple message Request/Response to analyze*/
  53 #define NB_CRITERIA 7
  54
  55 /* used to keep track of the statistics for an entire program interface */
  56 struct camelsrt_t {
  57   char *filter;
  58   guint32 count[NB_CAMELSRT_CATEGORY];
  59   timestat_t stats[NB_CAMELSRT_CATEGORY];
  60   nstime_t delta_time[NB_CAMELSRT_CATEGORY][NUM_RAS_STATS];
  61 };
  62
  63 /* Reset the counter */
  64 static void camelsrt_reset(void *phs)
  65 {
  66   struct camelsrt_t *hs=(struct camelsrt_t *)phs;
  67   memset(hs,0,sizeof(struct camelsrt_t));
  68 }
  69
  70
  71 static int camelsrt_packet(void *phs,
  72                            packet_info *pinfo _U_,
  73                            epan_dissect_t *edt _U_,
  74                            const void *phi)
  75 {
  76   struct camelsrt_t *hs=(struct camelsrt_t *)phs;
  77   const struct camelsrt_info_t * pi=phi;
  78   int i;
  79
  80   for (i=0; i<NB_CAMELSRT_CATEGORY; i++) {
  81     if (pi->bool_msginfo[i] &&
  82         pi->msginfo[i].is_delta_time
  83         && pi->msginfo[i].request_available
  84         && !pi->msginfo[i].is_duplicate ) {
  85
  86       time_stat_update(&(hs->stats[i]),
  87                        &(pi->msginfo[i].delta_time),
  88                        pinfo);
  89
  90       if (hs->count[i] < NUM_RAS_STATS) {
  91         hs->delta_time[i][hs->count[i]++]
  92           = pi->msginfo[i].delta_time;
  93       }
  94     }
  95   }
  96   return 1;
  97 }
  98
  99
 100 static void camelsrt_draw(void *phs)
 101 {
 102   struct camelsrt_t *hs=(struct camelsrt_t *)phs;
 103   guint j,z;
 104   guint32 li;
 105   int somme,iteration=0;
 106   timestat_t *rtd_temp;
 107   double x,delay,delay_max,delay_min,delta;
 108   double criteria[NB_CRITERIA]={ 5.0, 10.0, 75.0, 90.0, 95.0,99.0,99.90 };
 109   double delay_criteria[NB_CRITERIA];
 110
 111   printf("\n");
 112   printf("Camel Service Response Time (SRT) Statistics:\n");
 113   printf("=================================================================================================\n");
 114   printf("|        Category         | Measure |  Min SRT  |  Max SRT  |  Avg SRT  | Min frame | Max frame |\n");
 115   printf("|-------------------------|---------|-----------|-----------|-----------|-----------|-----------|\n");
 116
 117   j=1;
 118   printf("|%24s |%8u |%8.2f s |%8.2f s |%8.2f s |%10u |%10u |\n",
 119          val_to_str(j,camelSRTtype_naming,"Unknown Message 0x%02x"),
 120          hs->stats[j].num,
 121          nstime_to_sec(&(hs->stats[j].min)),
 122          nstime_to_sec(&(hs->stats[j].max)),
 123          get_average(&(hs->stats[j].tot),hs->stats[j].num)/1000.0,
 124          hs->stats[j].min_num,
 125          hs->stats[j].max_num
 126          );
 127   for(j=2; j<NB_CAMELSRT_CATEGORY; j++) {
 128     if(hs->stats[j].num==0){
 129       printf("|%24s |%8u |%8.2f ms|%8.2f ms|%8.2f ms|%10u |%10u |\n",
 130              val_to_str(j,camelSRTtype_naming,"Unknown Message 0x%02x"),
 131              0, 0.0, 0.0, 0.0, 0, 0);
 132       continue;
 133     }
 134
 135     printf("|%24s |%8u |%8.2f ms|%8.2f ms|%8.2f ms|%10u |%10u |\n",
 136            val_to_str(j,camelSRTtype_naming,"Unknown Message 0x%02x"),
 137            hs->stats[j].num,
 138            MIN(9999,nstime_to_msec(&(hs->stats[j].min))),
 139            MIN(9999,nstime_to_msec(&(hs->stats[j].max))),
 140            MIN(9999,get_average(&(hs->stats[j].tot),hs->stats[j].num)),
 141            hs->stats[j].min_num,
 142            hs->stats[j].max_num
 143            );
 144   } /* j category */
 145
 146   printf("=================================================================================================\n");
 147   /*
 148    * Display 95%
 149    */
 150
 151   printf("|   Category/Criteria     |");
 152   for(z=0; z<NB_CRITERIA; z++) printf("%7.2f%% |", criteria[z]);
 153   printf("\n");
 154
 155   printf("|-------------------------|");
 156   for(z=0; z<NB_CRITERIA; z++) printf("---------|");
 157   printf("\n");
 158   /* calculate the delay max to have a given number of messages (in percentage) */
 159   for(j=2;j<NB_CAMELSRT_CATEGORY;j++) {
 160
 161     rtd_temp = &(hs->stats[j]);
 162
 163     if (hs->count[j]>0) {
 164       /* Calculate the delay to answer to p% of the MS */
 165       for(z=0; z<NB_CRITERIA; z++) {
 166         iteration=0;
 167         delay_max=(double)rtd_temp->max.secs*1000 +(double)rtd_temp->max.nsecs/1000000;
 168         delay_min=(double)rtd_temp->min.secs*1000 +(double)rtd_temp->min.nsecs/1000000;
 169         delay=delay_min;
 170         delta=delay_max-delay_min;
 171         while( (delta > 0.001) && (iteration < 10000) ) {
 172           somme=0;
 173           iteration++;
 174
 175           for(li=0;li<hs->count[j];li++) {
 176             x=hs->delta_time[j][li].secs*1000
 177               + (double)hs->delta_time[j][li].nsecs/1000000;
 178             if (x <= delay) somme++;
 179           }
 180           if ( somme*100 > hs->count[j]*criteria[z] ) { /* trop grand */
 181             delay_max=delay;
 182             delay=(delay_max+delay_min)/2;
 183             delta=delay_max-delay_min;
 184           } else { /* trop petit */
 185             delay_min=delay;
 186             delay=(delay_max+delay_min)/2;
 187             delta=delay_max-delay_min;
 188           }
 189         } /* while */
 190         delay_criteria[z]=delay;
 191       } /* z criteria */
 192       /* Append the result to the table */
 193       printf("X%24s |", val_to_str(j, camelSRTtype_naming, "Unknown") );
 194       for(z=0; z<NB_CRITERIA; z++) printf("%8.2f |", MIN(9999,delay_criteria[z]));
 195       printf("\n");
 196     } else { /* count */
 197       printf("X%24s |", val_to_str(j, camelSRTtype_naming, "Unknown") );
 198       for(z=0; z<NB_CRITERIA; z++) printf("%8.2f |", 0.0);
 199       printf("\n");
 200     } /* count */
 201   }/* j category */
 202   printf("===========================");
 203   for(z=0; z<NB_CRITERIA; z++) printf("==========");
 204   printf("\n");
 205 }
 206
 207 static void camelsrt_init(const char *optarg, void* userdata _U_)
 208 {
 209   struct camelsrt_t *p_camelsrt;
 210   const char *filter=NULL;
 211   const char *emptyfilter="";
 212
 213   GString *error_string;
 214
 215   if(!strncmp(optarg,"camel,srt,",9)){
 216     filter=optarg+9;
 217   } else {
 218     filter=NULL;
 219   }
 220
 221   p_camelsrt = g_malloc(sizeof(struct camelsrt_t));
 222   if(filter){
 223     p_camelsrt->filter=g_malloc(strlen(filter)+1);
 224     strcpy(p_camelsrt->filter,filter);
 225   } else {
 226     p_camelsrt->filter=NULL;
 227   }
 228   camelsrt_reset(p_camelsrt);
 229
 230   if (filter) {
 231     error_string=register_tap_listener("CAMEL",
 232                                        p_camelsrt,
 233                                        filter,
 234                                        NULL,
 235                                        camelsrt_packet,
 236                                        camelsrt_draw);
 237   } else {
 238     error_string=register_tap_listener("CAMEL",
 239                                        p_camelsrt,
 240                                        emptyfilter,
 241                                        NULL,
 242                                        camelsrt_packet,
 243                                        camelsrt_draw);
 244   }
 245
 246   if(error_string){
 247     /* error, we failed to attach to the tap. clean up */
 248     g_free(p_camelsrt->filter);
 249     g_free(p_camelsrt);
 250
 251     fprintf(stderr, "tshark: Couldn't register camel,srt tap: %s\n",
 252             error_string->str);
 253     g_string_free(error_string, TRUE);
 254     exit(1);
 255   }
 256
 257   /*
 258    * If we are using tshark, we have to display the stats, even if the stats are not persistent
 259    * As the frame are proceeded in the chronological order, we do not need persistent stats
 260    * Whereas, with wireshark, it is not possible to have the correct display, if the stats are
 261    * not saved along the analyze
 262    */
 263   gtcap_StatSRT=TRUE;
 264   gcamel_StatSRT=TRUE;
 265 }
 266
 267
 268 void /* Next line mandatory */
 269 register_tap_listener_camelsrt(void)
 270 {
 271   register_stat_cmd_arg("camel,srt", camelsrt_init, NULL);
 272 }