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