tap-rpcstat.c

   1 /* tap-rpcstat.c
   2  * rpcstat   2002 Ronnie Sahlberg
   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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 /* This module provides rpc call/reply SRT statistics to tshark.
  26  * It is only used by tshark and not wireshark
  27  *
  28  * It serves as an example on how to use the tap api.
  29  */
  30
  31 #ifdef HAVE_CONFIG_H
  32 # include "config.h"
  33 #endif
  34
  35 #include <stdio.h>
  36
  37 #ifdef HAVE_SYS_TYPES_H
  38 # include <sys/types.h>
  39 #endif
  40
  41 #include <string.h>
  42 #include "epan/packet_info.h"
  43 #include <epan/tap.h>
  44 #include <epan/stat_cmd_args.h>
  45 #include <epan/dissectors/packet-rpc.h>
  46
  47 #define MICROSECS_PER_SEC   1000000
  48 #define NANOSECS_PER_SEC    1000000000
  49
  50 /* used to keep track of statistics for a specific procedure */
  51 typedef struct _rpc_procedure_t {
  52         const char *proc;
  53         int num;
  54         nstime_t min;
  55         nstime_t max;
  56         nstime_t tot;
  57 } rpc_procedure_t;
  58
  59 /* used to keep track of the statistics for an entire program interface */
  60 typedef struct _rpcstat_t {
  61         const char *prog;
  62         char *filter;
  63         guint32 program;
  64         guint32 version;
  65         guint32 num_procedures;
  66         rpc_procedure_t *procedures;
  67 } rpcstat_t;
  68
  69
  70
  71 /* This callback is never used by tshark but it is here for completeness.
  72  * When registering below, we could just have left this function as NULL.
  73  *
  74  * When used by wireshark, this function will be called whenever we would need
  75  * to reset all state. Such as when wireshark opens a new file, when it
  76  * starts a new capture, when it rescans the packetlist after some prefs have
  77  * changed etc.
  78  * So if your application has some state it needs to clean up in those
  79  * situations, here is a good place to put that code.
  80  */
  81 static void
  82 rpcstat_reset(void *prs)
  83 {
  84         rpcstat_t *rs=prs;
  85         guint32 i;
  86
  87         for(i=0;i<rs->num_procedures;i++){
  88                 rs->procedures[i].num=0;
  89                 rs->procedures[i].min.secs=0;
  90                 rs->procedures[i].min.nsecs=0;
  91                 rs->procedures[i].max.secs=0;
  92                 rs->procedures[i].max.nsecs=0;
  93                 rs->procedures[i].tot.secs=0;
  94                 rs->procedures[i].tot.nsecs=0;
  95         }
  96 }
  97
  98
  99 /* This callback is invoked whenever the tap system has seen a packet
 100  * we might be interested in.
 101  * The function is to be used to only update internal state information
 102  * in the *tapdata structure, and if there were state changes which requires
 103  * the window to be redrawn, return 1 and (*draw) will be called sometime
 104  * later.
 105  *
 106  * This function should be as lightweight as possible since it executes together
 107  * with the normal wireshark dissectors. Try to push as much processing as
 108  * possible into (*draw) instead since that function executes asynchronously
 109  * and does not affect the main threads performance.
 110  *
 111  * If it is possible, try to do all "filtering" explicitly as we do below in
 112  * this example since you will get MUCH better performance than applying
 113  * a similar display-filter in the register call.
 114  *
 115  * The third parameter is tap dependant. Since we register this one to the "rpc"
 116  * tap the third parameter type is rpc_call_info_value.
 117  *
 118  * The filtering we do is just to check the rpc_call_info_value struct that
 119  * we were called for the proper program and version. We didn't apply a filter
 120  * when we registered so we will be called for ALL rpc packets and not just
 121  * the ones we are collecting stats for.
 122  *
 123  * function returns :
 124  *  0: no updates, no need to call (*draw) later
 125  * !0: state has changed, call (*draw) sometime later
 126  */
 127 static int
 128 rpcstat_packet(void *prs, packet_info *pinfo, epan_dissect_t *edt _U_, const void *pri)
 129 {
 130         rpcstat_t *rs=prs;
 131         const rpc_call_info_value *ri=pri;
 132         nstime_t delta;
 133         rpc_procedure_t *rp;
 134
 135         if(ri->proc>=rs->num_procedures){
 136                 /* dont handle this since its outside of known table */
 137                 return 0;
 138         }
 139         /* we are only interested in reply packets */
 140         if(ri->request){
 141                 return 0;
 142         }
 143         /* we are only interested in certain program/versions */
 144         if( (ri->prog!=rs->program) || (ri->vers!=rs->version) ){
 145                 return 0;
 146         }
 147
 148         rp=&(rs->procedures[ri->proc]);
 149
 150         /* calculate time delta between request and reply */
 151         nstime_delta(&delta, &pinfo->fd->abs_ts, &ri->req_time);
 152
 153         if(rp->num==0){
 154                 rp->max.secs=delta.secs;
 155                 rp->max.nsecs=delta.nsecs;
 156         }
 157
 158         if(rp->num==0){
 159                 rp->min.secs=delta.secs;
 160                 rp->min.nsecs=delta.nsecs;
 161         }
 162
 163         if( (delta.secs<rp->min.secs)
 164         ||( (delta.secs==rp->min.secs)
 165           &&(delta.nsecs<rp->min.nsecs) ) ){
 166                 rp->min.secs=delta.secs;
 167                 rp->min.nsecs=delta.nsecs;
 168         }
 169
 170         if( (delta.secs>rp->max.secs)
 171         ||( (delta.secs==rp->max.secs)
 172           &&(delta.nsecs>rp->max.nsecs) ) ){
 173                 rp->max.secs=delta.secs;
 174                 rp->max.nsecs=delta.nsecs;
 175         }
 176
 177         rp->tot.secs += delta.secs;
 178         rp->tot.nsecs += delta.nsecs;
 179         if(rp->tot.nsecs > NANOSECS_PER_SEC){
 180                 rp->tot.nsecs -= NANOSECS_PER_SEC;
 181                 rp->tot.secs++;
 182         }
 183
 184         rp->num++;
 185
 186         return 1;
 187 }
 188
 189 /* This callback is used when tshark wants us to draw/update our
 190  * data to the output device. Since this is tshark only output is
 191  * stdout.
 192  * TShark will only call this callback once, which is when tshark has
 193  * finished reading all packets and exits.
 194  * If used with wireshark this may be called any time, perhaps once every 3
 195  * seconds or so.
 196  * This function may even be called in parallell with (*reset) or (*draw)
 197  * so make sure there are no races. The data in the rpcstat_t can thus change
 198  * beneath us. Beware.
 199  */
 200 static void
 201 rpcstat_draw(void *prs)
 202 {
 203         rpcstat_t *rs=prs;
 204         guint32 i;
 205         guint64 td;
 206         printf("\n");
 207         printf("=======================================================\n");
 208         printf("%s Version %d SRT Statistics:\n", rs->prog, rs->version);
 209         printf("Filter: %s\n",rs->filter?rs->filter:"");
 210         printf("Procedure        Calls    Min SRT    Max SRT    Avg SRT\n");
 211         for(i=0;i<rs->num_procedures;i++){
 212                 if(rs->procedures[i].num==0){
 213                         continue;
 214                 }
 215                 /* Scale the average SRT in units of 1us and round to the nearest us. */
 216                 td = ((guint64)(rs->procedures[i].tot.secs)) * NANOSECS_PER_SEC + rs->procedures[i].tot.nsecs;
 217                 td = ((td / rs->procedures[i].num) + 500) / 1000;
 218
 219                 printf("%-15s %6d %3d.%06d %3d.%06d %3" G_GINT64_MODIFIER "u.%06" G_GINT64_MODIFIER "u\n",
 220                         rs->procedures[i].proc,
 221                         rs->procedures[i].num,
 222                         (int)(rs->procedures[i].min.secs),(rs->procedures[i].min.nsecs+500)/1000,
 223                         (int)(rs->procedures[i].max.secs),(rs->procedures[i].max.nsecs+500)/1000,
 224                         td/MICROSECS_PER_SEC, td%MICROSECS_PER_SEC
 225                 );
 226         }
 227         printf("=======================================================\n");
 228 }
 229
 230 static guint32 rpc_program=0;
 231 static guint32 rpc_version=0;
 232 static gint32 rpc_min_proc=-1;
 233 static gint32 rpc_max_proc=-1;
 234
 235 static void *
 236 rpcstat_find_procs(gpointer *key, gpointer *value _U_, gpointer *user_data _U_)
 237 {
 238         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
 239
 240         if(k->prog!=rpc_program){
 241                 return NULL;
 242         }
 243         if(k->vers!=rpc_version){
 244                 return NULL;
 245         }
 246         if(rpc_min_proc==-1){
 247                 rpc_min_proc=k->proc;
 248                 rpc_max_proc=k->proc;
 249         }
 250         if((gint32)k->proc<rpc_min_proc){
 251                 rpc_min_proc=k->proc;
 252         }
 253         if((gint32)k->proc>rpc_max_proc){
 254                 rpc_max_proc=k->proc;
 255         }
 256
 257         return NULL;
 258 }
 259
 260
 261 /* When called, this function will create a new instance of rpcstat.
 262  * program and version are which onc-rpc program/version we want to
 263  * collect statistics for.
 264  * This function is called from tshark when it parses the -z rpc, arguments
 265  * and it creates a new instance to store statistics in and registers this
 266  * new instance for the rpc tap.
 267  */
 268 static void
 269 rpcstat_init(const char *optarg, void* userdata _U_)
 270 {
 271         rpcstat_t *rs;
 272         guint32 i;
 273         int program, version;
 274         int pos=0;
 275         const char *filter=NULL;
 276         GString *error_string;
 277
 278         if(sscanf(optarg,"rpc,srt,%d,%d,%n",&program,&version,&pos)==2){
 279                 if(pos){
 280                         filter=optarg+pos;
 281                 } else {
 282                         filter=NULL;
 283                 }
 284         } else {
 285                 fprintf(stderr, "tshark: invalid \"-z rpc,srt,<program>,<version>[,<filter>]\" argument\n");
 286                 exit(1);
 287         }
 288
 289         rs=g_malloc(sizeof(rpcstat_t));
 290         rs->prog=rpc_prog_name(program);
 291         rs->program=program;
 292         rs->version=version;
 293         if(filter){
 294                 rs->filter=g_strdup(filter);
 295         } else {
 296                 rs->filter=NULL;
 297         }
 298         rpc_program=program;
 299         rpc_version=version;
 300         rpc_min_proc=-1;
 301         rpc_max_proc=-1;
 302         g_hash_table_foreach(rpc_procs, (GHFunc)rpcstat_find_procs, NULL);
 303         if(rpc_min_proc==-1){
 304                 fprintf(stderr,"tshark: Invalid -z rpc,srt,%d,%d\n",rpc_program,rpc_version);
 305                 fprintf(stderr,"   Program:%d version:%d isn't supported by tshark.\n", rpc_program, rpc_version);
 306                 exit(1);
 307         }
 308
 309
 310         rs->num_procedures=rpc_max_proc+1;
 311         rs->procedures=g_malloc(sizeof(rpc_procedure_t)*(rs->num_procedures+1));
 312         for(i=0;i<rs->num_procedures;i++){
 313                 rs->procedures[i].proc=rpc_proc_name(program, version, i);
 314                 rs->procedures[i].num=0;
 315                 rs->procedures[i].min.secs=0;
 316                 rs->procedures[i].min.nsecs=0;
 317                 rs->procedures[i].max.secs=0;
 318                 rs->procedures[i].max.nsecs=0;
 319                 rs->procedures[i].tot.secs=0;
 320                 rs->procedures[i].tot.nsecs=0;
 321         }
 322
 323 /* It is possible to create a filter and attach it to the callbacks. Then the
 324  * callbacks would only be invoked if the filter matched.
 325  * Evaluating filters is expensive and if we can avoid it and not use them
 326  * we gain performance.
 327  * In this case we do the filtering for protocol and version inside the
 328  * callback itself but use whatever filter the user provided.
 329  * (Perhaps the user only wants the stats for nis+ traffic for certain objects?)
 330  *
 331  */
 332
 333         error_string=register_tap_listener("rpc", rs, filter, 0, rpcstat_reset, rpcstat_packet, rpcstat_draw);
 334         if(error_string){
 335                 /* error, we failed to attach to the tap. clean up */
 336                 g_free(rs->procedures);
 337                 g_free(rs->filter);
 338                 g_free(rs);
 339
 340                 fprintf(stderr, "tshark: Couldn't register rpc,srt tap: %s\n",
 341                     error_string->str);
 342                 g_string_free(error_string, TRUE);
 343                 exit(1);
 344         }
 345 }
 346
 347
 348 void
 349 register_tap_listener_rpcstat(void)
 350 {
 351         register_stat_cmd_arg("rpc,srt,", rpcstat_init,NULL);
 352 }
 353