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