gtk/rpc_stat.c

   1 /* rpc_stat.c
   2  * rpc_stat   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 (Server Response Time) statistics
  26  * to 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 <gtk/gtk.h>
  36
  37 #include <epan/packet_info.h>
  38 #include <epan/epan.h>
  39
  40 #include <epan/stat_cmd_args.h>
  41 #include "stat_menu.h"
  42 #include "gui_stat_menu.h"
  43 #include "simple_dialog.h"
  44 #include "gui_utils.h"
  45 #include "dlg_utils.h"
  46 #include <epan/tap.h>
  47 #include "register.h"
  48 #include <epan/dissectors/packet-rpc.h>
  49 #include "main.h"
  50 #include "globals.h"
  51 #include "filter_dlg.h"
  52 #include "compat_macros.h"
  53 #include "service_response_time_table.h"
  54 #include "gtkglobals.h"
  55
  56
  57 /* used to keep track of the statistics for an entire program interface */
  58 typedef struct _rpcstat_t {
  59         GtkWidget *win;
  60         srt_stat_table srt_table;
  61         const char *prog;
  62         guint32 program;
  63         guint32 version;
  64         guint32 num_procedures;
  65 } rpcstat_t;
  66
  67 static char *
  68 rpcstat_gen_title(rpcstat_t *rs)
  69 {
  70         char *title;
  71
  72         title = g_strdup_printf("ONC-RPC Service Response Time statistics for %s version %d: %s",
  73             rs->prog, rs->version, cf_get_display_name(&cfile));
  74         return title;
  75 }
  76
  77 static void
  78 rpcstat_set_title(rpcstat_t *rs)
  79 {
  80         char *title;
  81
  82         title = rpcstat_gen_title(rs);
  83         gtk_window_set_title(GTK_WINDOW(rs->win), title);
  84         g_free(title);
  85 }
  86
  87 static void
  88 rpcstat_reset(void *arg)
  89 {
  90         rpcstat_t *rs = arg;
  91
  92         reset_srt_table_data(&rs->srt_table);
  93         rpcstat_set_title(rs);
  94 }
  95
  96
  97 static int
  98 rpcstat_packet(void *arg, packet_info *pinfo, epan_dissect_t *edt _U_, const void *arg2)
  99 {
 100         rpcstat_t *rs = arg;
 101         const rpc_call_info_value *ri = arg2;
 102
 103         /* we are only interested in reply packets */
 104         if(ri->request){
 105                 return 0;
 106         }
 107         /* we are only interested in certain program/versions */
 108         if( (ri->prog!=rs->program) || (ri->vers!=rs->version) ){
 109                 return 0;
 110         }
 111         /* maybe we have discovered a new procedure?
 112          * then we might need to extend our tables
 113          */
 114         if(ri->proc>=rs->num_procedures){
 115                 guint32 i;
 116                 if(ri->proc>256){
 117                         /* no program have probably ever more than this many
 118                          * procedures anyway and it prevent us from allocating
 119                          * infinite memory if passed a garbage procedure id
 120                          */
 121                         return 0;
 122                 }
 123                 for(i=rs->num_procedures;i<=ri->proc;i++){
 124                         init_srt_table_row(&rs->srt_table, i, rpc_proc_name(rs->program, rs->version, i));
 125                 }
 126                 rs->num_procedures=ri->proc+1;
 127         }
 128         add_srt_table_data(&rs->srt_table, ri->proc, &ri->req_time, pinfo);
 129
 130         return 1;
 131 }
 132
 133 static void
 134 rpcstat_draw(void *arg)
 135 {
 136         rpcstat_t *rs = arg;
 137
 138         draw_srt_table_data(&rs->srt_table);
 139 }
 140
 141
 142
 143 static guint32 rpc_program=0;
 144 static guint32 rpc_version=0;
 145 static gint32 rpc_min_vers=-1;
 146 static gint32 rpc_max_vers=-1;
 147 static gint32 rpc_min_proc=-1;
 148 static gint32 rpc_max_proc=-1;
 149
 150 static void *
 151 rpcstat_find_procs(gpointer *key, gpointer *value _U_, gpointer *user_data _U_)
 152 {
 153         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
 154
 155         if(k->prog!=rpc_program){
 156                 return NULL;
 157         }
 158         if(k->vers!=rpc_version){
 159                 return NULL;
 160         }
 161         if(rpc_min_proc==-1){
 162                 rpc_min_proc=k->proc;
 163                 rpc_max_proc=k->proc;
 164         }
 165         if((gint32)k->proc<rpc_min_proc){
 166                 rpc_min_proc=k->proc;
 167         }
 168         if((gint32)k->proc>rpc_max_proc){
 169                 rpc_max_proc=k->proc;
 170         }
 171
 172         return NULL;
 173 }
 174
 175 static void *
 176 rpcstat_find_vers(gpointer *key, gpointer *value _U_, gpointer *user_data _U_)
 177 {
 178         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
 179
 180         if(k->prog!=rpc_program){
 181                 return NULL;
 182         }
 183         if(rpc_min_vers==-1){
 184                 rpc_min_vers=k->vers;
 185                 rpc_max_vers=k->vers;
 186         }
 187         if((gint32)k->vers<rpc_min_vers){
 188                 rpc_min_vers=k->vers;
 189         }
 190         if((gint32)k->vers>rpc_max_vers){
 191                 rpc_max_vers=k->vers;
 192         }
 193
 194         return NULL;
 195 }
 196
 197 /* since the gtk2 implementation of tap is multithreaded we must protect
 198  * remove_tap_listener() from modifying the list while draw_tap_listener()
 199  * is running.  the other protected block is in main.c
 200  *
 201  * there should not be any other critical regions in gtk2
 202  */
 203 static void
 204 win_destroy_cb(GtkWindow *win _U_, gpointer data)
 205 {
 206         rpcstat_t *rs=(rpcstat_t *)data;
 207
 208         protect_thread_critical_region();
 209         remove_tap_listener(rs);
 210         unprotect_thread_critical_region();
 211
 212         free_srt_table_data(&rs->srt_table);
 213         g_free(rs);
 214 }
 215
 216 /* When called, this function will create a new instance of gtk2-rpcstat.
 217  */
 218 static void
 219 gtk_rpcstat_init(const char *optarg, void* userdata _U_)
 220 {
 221         rpcstat_t *rs;
 222         guint32 i;
 223         char *title_string;
 224         char filter_string[256];
 225         GtkWidget *vbox;
 226         GtkWidget *stat_label;
 227         GtkWidget *filter_label;
 228         GtkWidget *bbox;
 229         GtkWidget *close_bt;
 230         int program, version, pos;
 231         const char *filter=NULL;
 232         GString *error_string;
 233         int hf_index;
 234         header_field_info *hfi;
 235
 236         pos=0;
 237         if(sscanf(optarg,"rpc,srt,%d,%d,%n",&program,&version,&pos)==2){
 238                 if(pos){
 239                         filter=optarg+pos;
 240                 } else {
 241                         filter=NULL;
 242                 }
 243         } else {
 244                 fprintf(stderr, "wireshark: invalid \"-z rpc,srt,<program>,<version>[,<filter>]\" argument\n");
 245                 exit(1);
 246         }
 247
 248         rpc_program=program;
 249         rpc_version=version;
 250         rs=g_malloc(sizeof(rpcstat_t));
 251         rs->prog=rpc_prog_name(rpc_program);
 252         rs->program=rpc_program;
 253         rs->version=rpc_version;
 254         hf_index=rpc_prog_hf(rpc_program, rpc_version);
 255         hfi=proto_registrar_get_nth(hf_index);
 256
 257         rs->win=window_new(GTK_WINDOW_TOPLEVEL, "rpc-stat");
 258         gtk_window_set_default_size(GTK_WINDOW(rs->win), 550, 400);
 259         rpcstat_set_title(rs);
 260
 261         vbox=gtk_vbox_new(FALSE, 3);
 262         gtk_container_add(GTK_CONTAINER(rs->win), vbox);
 263         gtk_container_set_border_width(GTK_CONTAINER(vbox), 12);
 264
 265         title_string = rpcstat_gen_title(rs);
 266         stat_label=gtk_label_new(title_string);
 267         g_free(title_string);
 268         gtk_box_pack_start(GTK_BOX(vbox), stat_label, FALSE, FALSE, 0);
 269
 270         g_snprintf(filter_string,255,"Filter:%s",filter?filter:"");
 271         filter_label=gtk_label_new(filter_string);
 272         gtk_box_pack_start(GTK_BOX(vbox), filter_label, FALSE, FALSE, 0);
 273
 274         rpc_min_proc=-1;
 275         rpc_max_proc=-1;
 276         g_hash_table_foreach(rpc_procs, (GHFunc)rpcstat_find_procs, NULL);
 277         rs->num_procedures=rpc_max_proc+1;
 278
 279         /* We must display TOP LEVEL Widget before calling init_srt_table() */
 280         gtk_widget_show_all(rs->win);
 281
 282         init_srt_table(&rs->srt_table, rpc_max_proc+1, vbox, hfi->abbrev);
 283
 284         for(i=0;i<rs->num_procedures;i++){
 285                 init_srt_table_row(&rs->srt_table, i, rpc_proc_name(rpc_program, rpc_version, i));
 286         }
 287
 288
 289         error_string=register_tap_listener("rpc", rs, filter, rpcstat_reset, rpcstat_packet, rpcstat_draw);
 290         if(error_string){
 291                 simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, error_string->str);
 292                 g_string_free(error_string, TRUE);
 293                 free_srt_table_data(&rs->srt_table);
 294                 g_free(rs);
 295                 return;
 296         }
 297
 298         /* Button row. */
 299         bbox = dlg_button_row_new(GTK_STOCK_CLOSE, NULL);
 300         gtk_box_pack_end(GTK_BOX(vbox), bbox, FALSE, FALSE, 0);
 301
 302         close_bt = OBJECT_GET_DATA(bbox, GTK_STOCK_CLOSE);
 303         window_set_cancel_button(rs->win, close_bt, window_cancel_button_cb);
 304
 305         SIGNAL_CONNECT(rs->win, "delete_event", window_delete_event_cb, NULL);
 306         SIGNAL_CONNECT(rs->win, "destroy", win_destroy_cb, rs);
 307
 308         gtk_widget_show_all(rs->win);
 309         window_present(rs->win);
 310
 311         cf_retap_packets(&cfile, FALSE);
 312 }
 313
 314
 315
 316
 317 static GtkWidget *dlg=NULL;
 318 static GtkWidget *prog_menu;
 319 static GtkWidget *vers_opt, *vers_menu;
 320 static GtkWidget *filter_entry;
 321
 322
 323 static void
 324 rpcstat_start_button_clicked(GtkWidget *item _U_, gpointer data _U_)
 325 {
 326         GString *str;
 327         const char *filter;
 328
 329         str = g_string_new("rpc,srt");
 330         g_string_sprintfa(str, ",%d,%d", rpc_program, rpc_version);
 331         filter=gtk_entry_get_text(GTK_ENTRY(filter_entry));
 332         if(filter[0]!=0){
 333                 g_string_sprintfa(str, ",%s", filter);
 334         }
 335
 336         gtk_rpcstat_init(str->str,NULL);
 337         g_string_free(str, TRUE);
 338 }
 339
 340
 341 static void
 342 rpcstat_version_select(GtkWidget *item _U_, gpointer key)
 343 {
 344         int vers=(int)key;
 345
 346         rpc_version=vers;
 347 }
 348
 349
 350
 351 static void
 352 rpcstat_program_select(GtkWidget *item _U_, gpointer key)
 353 {
 354         rpc_prog_info_key *k=(rpc_prog_info_key *)key;
 355         int i;
 356
 357         rpc_program=k->prog;
 358
 359         /* change version menu */
 360         rpc_version=0;
 361         gtk_object_destroy(GTK_OBJECT(vers_menu));
 362         vers_menu=gtk_menu_new();
 363         rpc_min_vers=-1;
 364         rpc_max_vers=-1;
 365         g_hash_table_foreach(rpc_procs, (GHFunc)rpcstat_find_vers, NULL);
 366         rpc_version=rpc_min_vers;
 367         for(i=rpc_min_vers;i<=rpc_max_vers;i++){
 368                 GtkWidget *menu_item;
 369                 char vs[5];
 370                 g_snprintf(vs, 5, "%d",i);
 371                 menu_item=gtk_menu_item_new_with_label(vs);
 372                 SIGNAL_CONNECT(menu_item, "activate", rpcstat_version_select,
 373                                i);
 374
 375                 gtk_widget_show(menu_item);
 376                 gtk_menu_append(GTK_MENU(vers_menu), menu_item);
 377         }
 378         gtk_option_menu_set_menu(GTK_OPTION_MENU(vers_opt), vers_menu);
 379 }
 380
 381 static void *
 382 rpcstat_list_programs(gpointer *key, gpointer *value, gpointer *user_data _U_)
 383 {
 384         rpc_prog_info_key *k=(rpc_prog_info_key *)key;
 385         rpc_prog_info_value *v=(rpc_prog_info_value *)value;
 386         GtkWidget *menu_item;
 387
 388         menu_item=gtk_menu_item_new_with_label(v->progname);
 389         SIGNAL_CONNECT(menu_item, "activate", rpcstat_program_select, k);
 390
 391         gtk_widget_show(menu_item);
 392         gtk_menu_append(GTK_MENU(prog_menu), menu_item);
 393
 394         if(!rpc_program){
 395                 rpc_program=k->prog;
 396         }
 397
 398         return NULL;
 399 }
 400
 401 static void
 402 dlg_destroy_cb(void)
 403 {
 404         dlg=NULL;
 405 }
 406
 407 static void
 408 gtk_rpcstat_cb(GtkWidget *w _U_, gpointer d _U_)
 409 {
 410         GtkWidget *dlg_box;
 411         GtkWidget *prog_box, *prog_label, *prog_opt;
 412         GtkWidget *vers_label;
 413         GtkWidget *filter_box, *filter_bt;
 414         GtkWidget *bbox, *start_button, *cancel_button;
 415         int i;
 416         const char *filter;
 417         static construct_args_t args = {
 418           "Service Response Time Statistics Filter",
 419           TRUE,
 420           FALSE,
 421       FALSE
 422         };
 423
 424         /* if the window is already open, bring it to front */
 425         if(dlg){
 426                 gdk_window_raise(dlg->window);
 427                 return;
 428         }
 429
 430         dlg=dlg_window_new("Wireshark: Compute ONC-RPC SRT statistics");
 431         gtk_window_set_default_size(GTK_WINDOW(dlg), 300, -1);
 432
 433         dlg_box=gtk_vbox_new(FALSE, 10);
 434         gtk_container_border_width(GTK_CONTAINER(dlg_box), 10);
 435         gtk_container_add(GTK_CONTAINER(dlg), dlg_box);
 436         gtk_widget_show(dlg_box);
 437
 438         /* Program box */
 439         prog_box=gtk_hbox_new(FALSE, 10);
 440
 441         /* Program label */
 442         gtk_container_set_border_width(GTK_CONTAINER(prog_box), 10);
 443         prog_label=gtk_label_new("Program:");
 444         gtk_box_pack_start(GTK_BOX(prog_box), prog_label, FALSE, FALSE, 0);
 445         gtk_widget_show(prog_label);
 446
 447         /* Program menu */
 448         prog_opt=gtk_option_menu_new();
 449         prog_menu=gtk_menu_new();
 450         g_hash_table_foreach(rpc_progs, (GHFunc)rpcstat_list_programs, NULL);
 451         gtk_option_menu_set_menu(GTK_OPTION_MENU(prog_opt), prog_menu);
 452         gtk_box_pack_start(GTK_BOX(prog_box), prog_opt, TRUE, TRUE, 0);
 453         gtk_widget_show(prog_opt);
 454
 455         /* Version label */
 456         gtk_container_set_border_width(GTK_CONTAINER(prog_box), 10);
 457         vers_label=gtk_label_new("Version:");
 458         gtk_box_pack_start(GTK_BOX(prog_box), vers_label, FALSE, FALSE, 0);
 459         gtk_widget_show(vers_label);
 460
 461         /* Version menu */
 462         vers_opt=gtk_option_menu_new();
 463         vers_menu=gtk_menu_new();
 464         rpc_min_vers=-1;
 465         rpc_max_vers=-1;
 466         g_hash_table_foreach(rpc_procs, (GHFunc)rpcstat_find_vers, NULL);
 467         rpc_version=rpc_min_vers;
 468         for(i=rpc_min_vers;i<=rpc_max_vers;i++){
 469                 GtkWidget *menu_item;
 470                 char vs[5];
 471                 g_snprintf(vs, 5, "%d",i);
 472                 menu_item=gtk_menu_item_new_with_label(vs);
 473                 SIGNAL_CONNECT(menu_item, "activate", rpcstat_version_select,
 474                                i);
 475
 476                 gtk_widget_show(menu_item);
 477                 gtk_menu_append(GTK_MENU(vers_menu), menu_item);
 478         }
 479         gtk_option_menu_set_menu(GTK_OPTION_MENU(vers_opt), vers_menu);
 480         gtk_box_pack_start(GTK_BOX(prog_box), vers_opt, TRUE, TRUE, 0);
 481         gtk_widget_show(vers_opt);
 482
 483         gtk_box_pack_start(GTK_BOX(dlg_box), prog_box, TRUE, TRUE, 0);
 484         gtk_widget_show(prog_box);
 485
 486         /* Filter box */
 487         filter_box=gtk_hbox_new(FALSE, 3);
 488
 489         /* Filter label */
 490         filter_bt=BUTTON_NEW_FROM_STOCK(WIRESHARK_STOCK_DISPLAY_FILTER_ENTRY);
 491         SIGNAL_CONNECT(filter_bt, "clicked", display_filter_construct_cb, &args);
 492         gtk_box_pack_start(GTK_BOX(filter_box), filter_bt, FALSE, FALSE, 0);
 493         gtk_widget_show(filter_bt);
 494
 495         /* Filter entry */
 496         filter_entry=gtk_entry_new();
 497     SIGNAL_CONNECT(filter_entry, "changed", filter_te_syntax_check_cb, NULL);
 498
 499         /* filter prefs dialog */
 500         OBJECT_SET_DATA(filter_bt, E_FILT_TE_PTR_KEY, filter_entry);
 501         /* filter prefs dialog */
 502
 503         gtk_box_pack_start(GTK_BOX(filter_box), filter_entry, TRUE, TRUE, 0);
 504         filter=gtk_entry_get_text(GTK_ENTRY(main_display_filter_widget));
 505         if(filter){
 506                 gtk_entry_set_text(GTK_ENTRY(filter_entry), filter);
 507         }
 508         gtk_widget_show(filter_entry);
 509
 510         gtk_box_pack_start(GTK_BOX(dlg_box), filter_box, TRUE, TRUE, 0);
 511         gtk_widget_show(filter_box);
 512
 513         /* button box */
 514     bbox = dlg_button_row_new(WIRESHARK_STOCK_CREATE_STAT, GTK_STOCK_CANCEL, NULL);
 515         gtk_box_pack_start(GTK_BOX(dlg_box), bbox, FALSE, FALSE, 0);
 516     gtk_widget_show(bbox);
 517
 518     start_button = OBJECT_GET_DATA(bbox, WIRESHARK_STOCK_CREATE_STAT);
 519     SIGNAL_CONNECT_OBJECT(start_button, "clicked",
 520                               rpcstat_start_button_clicked, NULL);
 521
 522     cancel_button = OBJECT_GET_DATA(bbox, GTK_STOCK_CANCEL);
 523     window_set_cancel_button(dlg, cancel_button, window_cancel_button_cb);
 524
 525         /* Give the initial focus to the "Filter" entry box. */
 526         gtk_widget_grab_focus(filter_entry);
 527
 528     gtk_widget_grab_default(start_button );
 529
 530     SIGNAL_CONNECT(dlg, "delete_event", window_delete_event_cb, NULL);
 531         SIGNAL_CONNECT(dlg, "destroy", dlg_destroy_cb, NULL);
 532
 533     gtk_widget_show_all(dlg);
 534     window_present(dlg);
 535 }
 536
 537
 538 void
 539 register_tap_listener_gtkrpcstat(void)
 540 {
 541         register_stat_cmd_arg("rpc,srt,", gtk_rpcstat_init, NULL);
 542
 543         register_stat_menu_item("ONC-RPC...", REGISTER_STAT_GROUP_RESPONSE_TIME,
 544             gtk_rpcstat_cb, NULL, NULL, NULL);
 545 }