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