ui/gtk/rpc_stat.c

   1 /* rpc_stat.c
   2  * rpc_stat   2002 Ronnie Sahlberg
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /* This module provides rpc call/reply SRT (Server Response Time) statistics
  24  * to Wireshark.
  25  *
  26  * It serves as an example on how to use the tap api.
  27  */
  28
  29 #include "config.h"
  30
  31 #include <stdlib.h>
  32
  33 #include <gtk/gtk.h>
  34
  35 #include <epan/packet_info.h>
  36 #include <epan/stat_tap_ui.h>
  37 #include <epan/tap.h>
  38 #include <epan/dissectors/packet-rpc.h>
  39
  40 #include "ui/simple_dialog.h"
  41
  42 #include "ui/gtk/gui_stat_menu.h"
  43 #include "ui/gtk/gui_utils.h"
  44 #include "ui/gtk/dlg_utils.h"
  45 #include "ui/gtk/main.h"
  46 #include "ui/gtk/filter_dlg.h"
  47 #include "ui/gtk/stock_icons.h"
  48 #include "ui/gtk/service_response_time_table.h"
  49 #include "ui/gtk/gtkglobals.h"
  50 #include "ui/gtk/filter_autocomplete.h"
  51
  52
  53 void register_tap_listener_gtkrpcstat(void);
  54
  55 /* used to keep track of the statistics for an entire program interface */
  56 typedef struct _rpcstat_t {
  57         const char *prog;
  58         guint32 version;
  59         gtk_srt_t gtk_data;
  60         register_srt_t* srt;
  61         srt_data_t data;
  62 } rpcstat_t;
  63
  64 static char *
  65 rpcstat_gen_title(rpcstat_t *rs)
  66 {
  67         char *display_name;
  68         char *title;
  69
  70         display_name = cf_get_display_name(&cfile);
  71         title = g_strdup_printf("ONC-RPC Service Response Time statistics for %s version %d: %s",
  72             rs->prog, rs->version, display_name);
  73         g_free(display_name);
  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->gtk_data.win), title);
  84         g_free(title);
  85 }
  86
  87 static void
  88 rpcstat_reset(void *arg)
  89 {
  90         srt_data_t *srt = (srt_data_t*)arg;
  91         rpcstat_t *rs = (rpcstat_t *)srt->user_data;
  92
  93         reset_srt_table(rs->data.srt_array, reset_table_data, &rs->gtk_data);
  94
  95         rpcstat_set_title(rs);
  96 }
  97
  98 static void
  99 rpcstat_draw(void *arg)
 100 {
 101         guint i = 0;
 102         srt_stat_table *srt_table;
 103         srt_data_t *srt = (srt_data_t*)arg;
 104         rpcstat_t *rs = (rpcstat_t *)srt->user_data;
 105
 106         for (i = 0; i < srt->srt_array->len; i++)
 107         {
 108                 srt_table = g_array_index(srt->srt_array, srt_stat_table*, i);
 109                 draw_srt_table_data(srt_table, &rs->gtk_data);
 110         }
 111 }
 112
 113
 114
 115 static guint32 rpc_program=0;
 116 static guint32 rpc_version=0;
 117 static gint32 rpc_min_vers=-1;
 118 static gint32 rpc_max_vers=-1;
 119 static gint32 rpc_min_proc=-1;
 120 static gint32 rpc_max_proc=-1;
 121
 122 static void
 123 rpcstat_find_procs(const gchar *table_name _U_, ftenum_t selector_type _U_, gpointer key, gpointer value _U_, gpointer user_data _U_)
 124 {
 125         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
 126
 127         if(k->prog!=rpc_program){
 128                 return;
 129         }
 130         if(k->vers!=rpc_version){
 131                 return;
 132         }
 133         if(rpc_min_proc==-1){
 134                 rpc_min_proc=k->proc;
 135                 rpc_max_proc=k->proc;
 136         }
 137         if((gint32)k->proc<rpc_min_proc){
 138                 rpc_min_proc=k->proc;
 139         }
 140         if((gint32)k->proc>rpc_max_proc){
 141                 rpc_max_proc=k->proc;
 142         }
 143
 144         return;
 145 }
 146
 147 static void
 148 rpcstat_find_vers(const gchar *table_name _U_, ftenum_t selector_type _U_, gpointer key, gpointer value _U_, gpointer user_data _U_)
 149 {
 150         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
 151
 152         if(k->prog!=rpc_program){
 153                 return;
 154         }
 155         if(rpc_min_vers==-1){
 156                 rpc_min_vers=k->vers;
 157                 rpc_max_vers=k->vers;
 158         }
 159         if((gint32)k->vers<rpc_min_vers){
 160                 rpc_min_vers=k->vers;
 161         }
 162         if((gint32)k->vers>rpc_max_vers){
 163                 rpc_max_vers=k->vers;
 164         }
 165
 166         return;
 167 }
 168
 169 static void
 170 win_destroy_cb(GtkWindow *win _U_, gpointer data)
 171 {
 172         rpcstat_t *rs=(rpcstat_t *)data;
 173
 174         remove_tap_listener(&rs->data);
 175
 176         free_srt_table(rs->srt, rs->data.srt_array, free_table_data, &rs->gtk_data);
 177         g_free(rs);
 178 }
 179
 180 /* When called, this function will create a new instance of gtk2-rpcstat.
 181  */
 182 static void
 183 gtk_rpcstat_init(const char *opt_arg, void* userdata _U_)
 184 {
 185         rpcstat_t *rs;
 186         char *title_string;
 187         char *filter_string;
 188         GtkWidget *stat_label;
 189         GtkWidget *filter_label;
 190         GtkWidget *bbox;
 191         GtkWidget *close_bt;
 192         int program, version, pos;
 193         const char *filter=NULL;
 194         gchar *error_string;
 195         rpcstat_tap_data_t* tap_data;
 196
 197         pos=0;
 198         if(sscanf(opt_arg,"rpc,srt,%d,%d,%n",&program,&version,&pos)==2){
 199                 if(pos){
 200                         filter=opt_arg+pos;
 201                 } else {
 202                         filter=NULL;
 203                 }
 204         } else {
 205                 fprintf(stderr, "wireshark: invalid \"-z rpc,srt,<program>,<version>[,<filter>]\" argument\n");
 206                 exit(1);
 207         }
 208
 209         rpc_program=program;
 210         rpc_version=version;
 211
 212         rs=(rpcstat_t *)g_malloc0(sizeof(rpcstat_t));
 213         rs->prog = rpc_prog_name(program);
 214         rs->version = version;
 215
 216         rs->gtk_data.win = dlg_window_new("rpc-stat");  /* transient_for top_level */
 217         gtk_window_set_destroy_with_parent (GTK_WINDOW(rs->gtk_data.win), TRUE);
 218         gtk_window_set_default_size(GTK_WINDOW(rs->gtk_data.win), SRT_PREFERRED_WIDTH, SRT_PREFERRED_HEIGHT);
 219         rpcstat_set_title(rs);
 220
 221         rs->gtk_data.vbox=ws_gtk_box_new(GTK_ORIENTATION_VERTICAL, 3, FALSE);
 222         gtk_container_add(GTK_CONTAINER(rs->gtk_data.win), rs->gtk_data.vbox);
 223         gtk_container_set_border_width(GTK_CONTAINER(rs->gtk_data.vbox), 12);
 224
 225         title_string = rpcstat_gen_title(rs);
 226         stat_label=gtk_label_new(title_string);
 227         g_free(title_string);
 228         gtk_box_pack_start(GTK_BOX(rs->gtk_data.vbox), stat_label, FALSE, FALSE, 0);
 229
 230         filter_string = g_strdup_printf("Filter: %s", filter ? filter : "");
 231         filter_label=gtk_label_new(filter_string);
 232         g_free(filter_string);
 233         gtk_label_set_line_wrap(GTK_LABEL(filter_label), TRUE);
 234         gtk_box_pack_start(GTK_BOX(rs->gtk_data.vbox), filter_label, FALSE, FALSE, 0);
 235
 236         rpc_min_proc=-1;
 237         rpc_max_proc=-1;
 238
 239         /* Need to run over both dissector tables */
 240         dissector_table_foreach ("rpc.call", rpcstat_find_procs, NULL);
 241         dissector_table_foreach ("rpc.reply", rpcstat_find_procs, NULL);
 242
 243         /* We must display TOP LEVEL Widget before calling init_gtk_srt_table() */
 244         gtk_widget_show_all(rs->gtk_data.win);
 245
 246         rs->srt = get_srt_table_by_name("rpc");
 247
 248         /* Setup the tap data */
 249         tap_data = g_new0(rpcstat_tap_data_t, 1);
 250
 251         tap_data->prog    = rpc_prog_name(program);
 252         tap_data->program = program;
 253         tap_data->version = version;
 254         tap_data->num_procedures = rpc_max_proc+1;
 255
 256         set_srt_table_param_data(rs->srt, tap_data);
 257
 258         rs->gtk_data.gtk_srt_array = g_array_new(FALSE, TRUE, sizeof(gtk_srt_table_t*));
 259         rs->data.srt_array = g_array_new(FALSE, TRUE, sizeof(srt_stat_table*));
 260         rs->data.user_data = rs;
 261
 262         srt_table_dissector_init(rs->srt, rs->data.srt_array, init_gtk_srt_table, &rs->gtk_data);
 263
 264         error_string=register_tap_listener("rpc", &rs->data, filter, 0, rpcstat_reset, get_srt_packet_func(rs->srt), rpcstat_draw);
 265         if(error_string){
 266                 simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s", error_string);
 267                 wmem_free(NULL, error_string);
 268                 free_srt_table(rs->srt, rs->data.srt_array, NULL, NULL);
 269                 g_free(rs);
 270                 return;
 271         }
 272
 273         /* Button row. */
 274         bbox = dlg_button_row_new(GTK_STOCK_CLOSE, NULL);
 275         gtk_box_pack_end(GTK_BOX(rs->gtk_data.vbox), bbox, FALSE, FALSE, 0);
 276
 277         close_bt = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CLOSE);
 278         window_set_cancel_button(rs->gtk_data.win, close_bt, window_cancel_button_cb);
 279
 280         g_signal_connect(rs->gtk_data.win, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);
 281         g_signal_connect(rs->gtk_data.win, "destroy", G_CALLBACK(win_destroy_cb), rs);
 282
 283         gtk_widget_show_all(rs->gtk_data.win);
 284         window_present(rs->gtk_data.win);
 285
 286         cf_retap_packets(&cfile);
 287         gdk_window_raise(gtk_widget_get_window(rs->gtk_data.win));
 288 }
 289
 290
 291
 292
 293 static GtkWidget *dlg=NULL;
 294 static GtkWidget *filter_entry;
 295
 296 static void
 297 rpcstat_start_button_clicked(GtkWidget *item _U_, gpointer data _U_)
 298 {
 299         GString *str;
 300         const char *filter;
 301
 302         str = g_string_new("rpc,srt");
 303         g_string_append_printf(str, ",%d,%d", rpc_program, rpc_version);
 304         filter=gtk_entry_get_text(GTK_ENTRY(filter_entry));
 305         if(filter[0]!=0){
 306                 g_string_append_printf(str, ",%s", filter);
 307         }
 308
 309         gtk_rpcstat_init(str->str,NULL);
 310         g_string_free(str, TRUE);
 311 }
 312
 313
 314 static void
 315 rpcstat_version_select(GtkWidget *vers_combo_box, gpointer user_data _U_)
 316 {
 317         gpointer ptr;
 318
 319         if (! ws_combo_box_get_active_pointer(GTK_COMBO_BOX(vers_combo_box), &ptr)) {
 320                 g_assert_not_reached();  /* Programming error: somehow no active item */
 321         }
 322
 323         rpc_version=GPOINTER_TO_INT(ptr);
 324 }
 325
 326
 327 static void
 328 rpcstat_program_select(GtkWidget *prog_combo_box, gpointer user_data)
 329 {
 330         guint32 k;
 331         GtkWidget *vers_combo_box;
 332         int i;
 333
 334         vers_combo_box = (GtkWidget *)user_data;
 335
 336         if (! ws_combo_box_get_active_pointer(GTK_COMBO_BOX(prog_combo_box), (gpointer *)&k)) {
 337                 g_assert_not_reached();  /* Programming error: somehow no active item */
 338         }
 339         rpc_program=k;
 340
 341         /* re-create version menu */
 342         rpc_version=0;
 343         g_signal_handlers_disconnect_by_func(vers_combo_box, G_CALLBACK(rpcstat_version_select), NULL );
 344         ws_combo_box_clear_text_and_pointer(GTK_COMBO_BOX(vers_combo_box));
 345         rpc_min_vers=-1;
 346         rpc_max_vers=-1;
 347         dissector_table_foreach ("rpc.call", rpcstat_find_vers, NULL);
 348         dissector_table_foreach ("rpc.reply", rpcstat_find_vers, NULL);
 349         for(i=rpc_min_vers;i<=rpc_max_vers;i++){
 350                 char vs[5];
 351                 g_snprintf(vs, sizeof(vs), "%d",i);
 352                 ws_combo_box_append_text_and_pointer(GTK_COMBO_BOX(vers_combo_box),
 353                                                      vs, GINT_TO_POINTER(i));
 354         }
 355         g_signal_connect(vers_combo_box, "changed", G_CALLBACK(rpcstat_version_select), NULL);
 356         ws_combo_box_set_active(GTK_COMBO_BOX(vers_combo_box), 0); /* default: will trigger rpcstat_version_select callback */
 357 }
 358
 359
 360
 361 static void
 362 rpcstat_list_programs(gpointer *key, gpointer *value, gpointer user_data)
 363 {
 364         guint32 k=GPOINTER_TO_UINT(key);
 365         rpc_prog_info_value *v=(rpc_prog_info_value *)value;
 366         GtkComboBox *prog_combo_box = (GtkComboBox *)user_data;
 367
 368         ws_combo_box_append_text_and_pointer(prog_combo_box, v->progname, GUINT_TO_POINTER(k));
 369
 370         if(!rpc_program){
 371                 rpc_program=k;
 372         }
 373 }
 374
 375 static void
 376 dlg_destroy_cb(GtkWidget *w _U_, gpointer user_data _U_)
 377 {
 378         dlg=NULL;
 379 }
 380
 381 void
 382 gtk_rpcstat_cb(GtkAction *action _U_, gpointer user_data _U_)
 383 {
 384         GtkWidget *dlg_box;
 385         GtkWidget *prog_box, *prog_label;
 386         GtkWidget *vers_label;
 387         GtkWidget *prog_combo_box, *vers_combo_box;
 388         GtkWidget *filter_box, *filter_bt;
 389         GtkWidget *bbox, *start_button, *cancel_button;
 390         const char *filter;
 391         static construct_args_t args = {
 392           "Service Response Time Statistics Filter",
 393           TRUE,
 394           FALSE,
 395           FALSE
 396         };
 397
 398         /* if the window is already open, bring it to front */
 399         if(dlg){
 400                 gdk_window_raise(gtk_widget_get_window(dlg));
 401                 return;
 402         }
 403
 404         dlg=dlg_window_new("Wireshark: Compute ONC-RPC SRT statistics");
 405         gtk_window_set_default_size(GTK_WINDOW(dlg), 300, -1);
 406
 407         dlg_box=ws_gtk_box_new(GTK_ORIENTATION_VERTICAL, 10, FALSE);
 408         gtk_container_set_border_width(GTK_CONTAINER(dlg_box), 10);
 409         gtk_container_add(GTK_CONTAINER(dlg), dlg_box);
 410         gtk_widget_show(dlg_box);
 411
 412         /* Program box */
 413         prog_box=ws_gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 10, FALSE);
 414
 415         /* Program label */
 416         gtk_container_set_border_width(GTK_CONTAINER(prog_box), 10);
 417         prog_label=gtk_label_new("Program:");
 418         gtk_box_pack_start(GTK_BOX(prog_box), prog_label, FALSE, FALSE, 0);
 419         gtk_widget_show(prog_label);
 420
 421         /* Program menu */
 422         prog_combo_box=ws_combo_box_new_text_and_pointer();
 423         g_hash_table_foreach(rpc_progs, (GHFunc)rpcstat_list_programs, prog_combo_box);
 424         gtk_box_pack_start(GTK_BOX(prog_box), prog_combo_box, TRUE, TRUE, 0);
 425         gtk_widget_show(prog_combo_box);
 426
 427         /* Version label */
 428         gtk_container_set_border_width(GTK_CONTAINER(prog_box), 10);
 429         vers_label=gtk_label_new("Version:");
 430         gtk_box_pack_start(GTK_BOX(prog_box), vers_label, FALSE, FALSE, 0);
 431         gtk_widget_show(vers_label);
 432
 433         /* Note: version combo box rows set when rpcstat_program_select callback invoked below */
 434         vers_combo_box=ws_combo_box_new_text_and_pointer();
 435         gtk_box_pack_start(GTK_BOX(prog_box), vers_combo_box, TRUE, TRUE, 0);
 436         gtk_widget_show(vers_combo_box);
 437
 438         gtk_box_pack_start(GTK_BOX(dlg_box), prog_box, TRUE, TRUE, 0);
 439
 440         g_signal_connect(prog_combo_box, "changed", G_CALLBACK(rpcstat_program_select), vers_combo_box);
 441         ws_combo_box_set_active(GTK_COMBO_BOX(prog_combo_box), 0); /* invokes rpcstat_program_select callback */
 442
 443         gtk_widget_show(prog_box);
 444
 445         /* Filter box */
 446         filter_box=ws_gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 3, FALSE);
 447
 448         /* Filter label */
 449         filter_bt=ws_gtk_button_new_from_stock(WIRESHARK_STOCK_DISPLAY_FILTER_ENTRY);
 450         g_signal_connect(filter_bt, "clicked", G_CALLBACK(display_filter_construct_cb), &args);
 451         gtk_box_pack_start(GTK_BOX(filter_box), filter_bt, FALSE, FALSE, 0);
 452         gtk_widget_show(filter_bt);
 453
 454         /* Filter entry */
 455         filter_entry=gtk_entry_new();
 456         g_signal_connect(filter_entry, "changed", G_CALLBACK(filter_te_syntax_check_cb), NULL);
 457         g_object_set_data(G_OBJECT(filter_box), E_FILT_AUTOCOMP_PTR_KEY, NULL);
 458         g_signal_connect(filter_entry, "key-press-event", G_CALLBACK (filter_string_te_key_pressed_cb), NULL);
 459         g_signal_connect(dlg, "key-press-event", G_CALLBACK (filter_parent_dlg_key_pressed_cb), NULL);
 460
 461         /* filter prefs dialog */
 462         g_object_set_data(G_OBJECT(filter_bt), E_FILT_TE_PTR_KEY, filter_entry);
 463         /* filter prefs dialog */
 464
 465         gtk_box_pack_start(GTK_BOX(filter_box), filter_entry, TRUE, TRUE, 0);
 466         filter=gtk_entry_get_text(GTK_ENTRY(main_display_filter_widget));
 467         if(filter){
 468                 gtk_entry_set_text(GTK_ENTRY(filter_entry), filter);
 469         } else {
 470                 colorize_filter_te_as_empty(filter_entry);
 471         }
 472         gtk_widget_show(filter_entry);
 473
 474         gtk_box_pack_start(GTK_BOX(dlg_box), filter_box, TRUE, TRUE, 0);
 475         gtk_widget_show(filter_box);
 476
 477         /* button box */
 478         bbox = dlg_button_row_new(WIRESHARK_STOCK_CREATE_STAT, GTK_STOCK_CANCEL, NULL);
 479         gtk_box_pack_start(GTK_BOX(dlg_box), bbox, FALSE, FALSE, 0);
 480         gtk_widget_show(bbox);
 481
 482         start_button = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), WIRESHARK_STOCK_CREATE_STAT);
 483         g_signal_connect_swapped(start_button, "clicked",
 484                                  G_CALLBACK(rpcstat_start_button_clicked), NULL);
 485
 486         cancel_button = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CANCEL);
 487         window_set_cancel_button(dlg, cancel_button, window_cancel_button_cb);
 488
 489         /* Give the initial focus to the "Filter" entry box. */
 490         gtk_widget_grab_focus(filter_entry);
 491
 492         gtk_widget_grab_default(start_button );
 493
 494         g_signal_connect(dlg, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);
 495         g_signal_connect(dlg, "destroy", G_CALLBACK(dlg_destroy_cb), NULL);
 496
 497         gtk_widget_show_all(dlg);
 498         window_present(dlg);
 499 }
 500
 501
 502 static stat_tap_ui rpcstat_ui = {
 503         REGISTER_STAT_GROUP_RESPONSE_TIME,
 504         NULL,
 505         "rpc,srt",
 506         gtk_rpcstat_init,
 507         0,
 508         NULL
 509 };
 510
 511 void
 512 register_tap_listener_gtkrpcstat(void)
 513 {
 514         register_stat_tap_ui(&rpcstat_ui, NULL);
 515 }
 516
 517
 518 /*
 519  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 520  *
 521  * Local variables:
 522  * c-basic-offset: 8
 523  * tab-width: 8
 524  * indent-tabs-mode: t
 525  * End:
 526  *
 527  * vi: set shiftwidth=8 tabstop=8 noexpandtab:
 528  * :indentSize=8:tabSize=8:noTabs=false:
 529  */