gtk/rpc_stat.c

   1 /* rpc_stat.c
   2  * rpc_stat   2002 Ronnie Sahlberg
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   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 ethereal.
  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 "../stat.h"
  41 #include "stat_menu.h"
  42 #include "simple_dialog.h"
  43 #include "ui_util.h"
  44 #include "dlg_utils.h"
  45 #include <epan/tap.h>
  46 #include "../register.h"
  47 #include <epan/dissectors/packet-rpc.h>
  48 #include "../globals.h"
  49 #include "filter_dlg.h"
  50 #include "compat_macros.h"
  51 #include "service_response_time_table.h"
  52 #include "gtkglobals.h"
  53
  54
  55 /* used to keep track of the statistics for an entire program interface */
  56 typedef struct _rpcstat_t {
  57         GtkWidget *win;
  58         srt_stat_table srt_table;
  59         const char *prog;
  60         guint32 program;
  61         guint32 version;
  62         guint32 num_procedures;
  63 } rpcstat_t;
  64
  65 static char *
  66 rpcstat_gen_title(rpcstat_t *rs)
  67 {
  68         char *title;
  69
  70         title = g_strdup_printf("ONC-RPC Service Response Time statistics for %s version %d: %s",
  71             rs->prog, rs->version, cf_get_display_name(&cfile));
  72         return title;
  73 }
  74
  75 static void
  76 rpcstat_set_title(rpcstat_t *rs)
  77 {
  78         char *title;
  79
  80         title = rpcstat_gen_title(rs);
  81         gtk_window_set_title(GTK_WINDOW(rs->win), title);
  82         g_free(title);
  83 }
  84
  85 static void
  86 rpcstat_reset(void *arg)
  87 {
  88         rpcstat_t *rs = arg;
  89
  90         reset_srt_table_data(&rs->srt_table);
  91         rpcstat_set_title(rs);
  92 }
  93
  94
  95 static int
  96 rpcstat_packet(void *arg, packet_info *pinfo, epan_dissect_t *edt _U_, const void *arg2)
  97 {
  98         rpcstat_t *rs = arg;
  99         const rpc_call_info_value *ri = arg2;
 100
 101         /* we are only interested in reply packets */
 102         if(ri->request){
 103                 return 0;
 104         }
 105         /* we are only interested in certain program/versions */
 106         if( (ri->prog!=rs->program) || (ri->vers!=rs->version) ){
 107                 return 0;
 108         }
 109         /* maybe we have discovered a new procedure?
 110          * then we might need to extend our tables
 111          */
 112         if(ri->proc>=rs->num_procedures){
 113                 guint32 i;
 114                 if(ri->proc>256){
 115                         /* no program have probably ever more than this many
 116                          * procedures anyway and it prevent us from allocating
 117                          * infinite memory if passed a garbage procedure id
 118                          */
 119                         return 0;
 120                 }
 121                 for(i=rs->num_procedures;i<=ri->proc;i++){
 122                         init_srt_table_row(&rs->srt_table, i, rpc_proc_name(rs->program, rs->version, i));
 123                 }
 124                 rs->num_procedures=ri->proc+1;
 125         }
 126         add_srt_table_data(&rs->srt_table, ri->proc, &ri->req_time, pinfo);
 127
 128         return 1;
 129 }
 130
 131 static void
 132 rpcstat_draw(void *arg)
 133 {
 134         rpcstat_t *rs = arg;
 135
 136         draw_srt_table_data(&rs->srt_table);
 137 }
 138
 139
 140
 141 static guint32 rpc_program=0;
 142 static guint32 rpc_version=0;
 143 static gint32 rpc_min_vers=-1;
 144 static gint32 rpc_max_vers=-1;
 145 static gint32 rpc_min_proc=-1;
 146 static gint32 rpc_max_proc=-1;
 147
 148 static void *
 149 rpcstat_find_procs(gpointer *key, gpointer *value _U_, gpointer *user_data _U_)
 150 {
 151         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
 152
 153         if(k->prog!=rpc_program){
 154                 return NULL;
 155         }
 156         if(k->vers!=rpc_version){
 157                 return NULL;
 158         }
 159         if(rpc_min_proc==-1){
 160                 rpc_min_proc=k->proc;
 161                 rpc_max_proc=k->proc;
 162         }
 163         if((gint32)k->proc<rpc_min_proc){
 164                 rpc_min_proc=k->proc;
 165         }
 166         if((gint32)k->proc>rpc_max_proc){
 167                 rpc_max_proc=k->proc;
 168         }
 169
 170         return NULL;
 171 }
 172
 173 static void *
 174 rpcstat_find_vers(gpointer *key, gpointer *value _U_, gpointer *user_data _U_)
 175 {
 176         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
 177
 178         if(k->prog!=rpc_program){
 179                 return NULL;
 180         }
 181         if(rpc_min_vers==-1){
 182                 rpc_min_vers=k->vers;
 183                 rpc_max_vers=k->vers;
 184         }
 185         if((gint32)k->vers<rpc_min_vers){
 186                 rpc_min_vers=k->vers;
 187         }
 188         if((gint32)k->vers>rpc_max_vers){
 189                 rpc_max_vers=k->vers;
 190         }
 191
 192         return NULL;
 193 }
 194
 195 /* since the gtk2 implementation of tap is multithreaded we must protect
 196  * remove_tap_listener() from modifying the list while draw_tap_listener()
 197  * is running.  the other protected block is in main.c
 198  *
 199  * there should not be any other critical regions in gtk2
 200  */
 201 void protect_thread_critical_region(void);
 202 void unprotect_thread_critical_region(void);
 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)
 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, "ethereal: 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);
 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);
 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         };
 422
 423         /* if the window is already open, bring it to front */
 424         if(dlg){
 425                 gdk_window_raise(dlg->window);
 426                 return;
 427         }
 428
 429         dlg=dlg_window_new("Ethereal: Compute ONC-RPC SRT statistics");
 430         gtk_window_set_default_size(GTK_WINDOW(dlg), 300, -1);
 431
 432         dlg_box=gtk_vbox_new(FALSE, 10);
 433         gtk_container_border_width(GTK_CONTAINER(dlg_box), 10);
 434         gtk_container_add(GTK_CONTAINER(dlg), dlg_box);
 435         gtk_widget_show(dlg_box);
 436
 437         /* Program box */
 438         prog_box=gtk_hbox_new(FALSE, 10);
 439
 440         /* Program label */
 441         gtk_container_set_border_width(GTK_CONTAINER(prog_box), 10);
 442         prog_label=gtk_label_new("Program:");
 443         gtk_box_pack_start(GTK_BOX(prog_box), prog_label, FALSE, FALSE, 0);
 444         gtk_widget_show(prog_label);
 445
 446         /* Program menu */
 447         prog_opt=gtk_option_menu_new();
 448         prog_menu=gtk_menu_new();
 449         g_hash_table_foreach(rpc_progs, (GHFunc)rpcstat_list_programs, NULL);
 450         gtk_option_menu_set_menu(GTK_OPTION_MENU(prog_opt), prog_menu);
 451         gtk_box_pack_start(GTK_BOX(prog_box), prog_opt, TRUE, TRUE, 0);
 452         gtk_widget_show(prog_opt);
 453
 454         /* Version label */
 455         gtk_container_set_border_width(GTK_CONTAINER(prog_box), 10);
 456         vers_label=gtk_label_new("Version:");
 457         gtk_box_pack_start(GTK_BOX(prog_box), vers_label, FALSE, FALSE, 0);
 458         gtk_widget_show(vers_label);
 459
 460         /* Version menu */
 461         vers_opt=gtk_option_menu_new();
 462         vers_menu=gtk_menu_new();
 463         rpc_min_vers=-1;
 464         rpc_max_vers=-1;
 465         g_hash_table_foreach(rpc_procs, (GHFunc)rpcstat_find_vers, NULL);
 466         rpc_version=rpc_min_vers;
 467         for(i=rpc_min_vers;i<=rpc_max_vers;i++){
 468                 GtkWidget *menu_item;
 469                 char vs[5];
 470                 g_snprintf(vs, 5, "%d",i);
 471                 menu_item=gtk_menu_item_new_with_label(vs);
 472                 SIGNAL_CONNECT(menu_item, "activate", rpcstat_version_select,
 473                                i);
 474
 475                 gtk_widget_show(menu_item);
 476                 gtk_menu_append(GTK_MENU(vers_menu), menu_item);
 477         }
 478         gtk_option_menu_set_menu(GTK_OPTION_MENU(vers_opt), vers_menu);
 479         gtk_box_pack_start(GTK_BOX(prog_box), vers_opt, TRUE, TRUE, 0);
 480         gtk_widget_show(vers_opt);
 481
 482         gtk_box_pack_start(GTK_BOX(dlg_box), prog_box, TRUE, TRUE, 0);
 483         gtk_widget_show(prog_box);
 484
 485         /* Filter box */
 486         filter_box=gtk_hbox_new(FALSE, 3);
 487
 488         /* Filter label */
 489         filter_bt=BUTTON_NEW_FROM_STOCK(ETHEREAL_STOCK_DISPLAY_FILTER_ENTRY);
 490         SIGNAL_CONNECT(filter_bt, "clicked", display_filter_construct_cb, &args);
 491         gtk_box_pack_start(GTK_BOX(filter_box), filter_bt, FALSE, FALSE, 0);
 492         gtk_widget_show(filter_bt);
 493
 494         /* Filter entry */
 495         filter_entry=gtk_entry_new();
 496     SIGNAL_CONNECT(filter_entry, "changed", filter_te_syntax_check_cb, NULL);
 497
 498         /* filter prefs dialog */
 499         OBJECT_SET_DATA(filter_bt, E_FILT_TE_PTR_KEY, filter_entry);
 500         /* filter prefs dialog */
 501
 502         gtk_box_pack_start(GTK_BOX(filter_box), filter_entry, TRUE, TRUE, 0);
 503         filter=gtk_entry_get_text(GTK_ENTRY(main_display_filter_widget));
 504         if(filter){
 505                 gtk_entry_set_text(GTK_ENTRY(filter_entry), filter);
 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(ETHEREAL_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 = OBJECT_GET_DATA(bbox, ETHEREAL_STOCK_CREATE_STAT);
 518     SIGNAL_CONNECT_OBJECT(start_button, "clicked",
 519                               rpcstat_start_button_clicked, NULL);
 520
 521     cancel_button = OBJECT_GET_DATA(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     SIGNAL_CONNECT(dlg, "delete_event", window_delete_event_cb, NULL);
 530         SIGNAL_CONNECT(dlg, "destroy", 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);
 541
 542         register_stat_menu_item("ONC-RPC...", REGISTER_STAT_GROUP_RESPONSE_TIME,
 543             gtk_rpcstat_cb, NULL, NULL, NULL);
 544 }