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