gtk/scsi_stat.c

   1 /* scsi_stat.c
   2  * scsi_stat   2006 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
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <gtk/gtk.h>
  34
  35 #include <epan/packet_info.h>
  36 #include <epan/epan.h>
  37 #include <epan/stat_cmd_args.h>
  38 #include <epan/tap.h>
  39 #include <epan/conversation.h>
  40 #include <epan/dissectors/packet-scsi.h>
  41 #include <epan/dissectors/packet-fc.h>
  42 #include <epan/dissectors/packet-scsi-sbc.h>
  43 #include <epan/dissectors/packet-scsi-ssc.h>
  44 #include <epan/dissectors/packet-scsi-smc.h>
  45 #include <epan/dissectors/packet-scsi-osd.h>
  46
  47 #include "../simple_dialog.h"
  48 #include "../globals.h"
  49 #include "../stat_menu.h"
  50 #include "../register.h"
  51
  52 #include "gtk/gui_stat_menu.h"
  53 #include "gtk/gui_utils.h"
  54 #include "gtk/dlg_utils.h"
  55 #include "gtk/main.h"
  56 #include "gtk/filter_dlg.h"
  57 #include "gtk/stock_icons.h"
  58 #include "gtk/service_response_time_table.h"
  59 #include "gtk/gtkglobals.h"
  60 #include "gtk/filter_autocomplete.h"
  61
  62
  63 static GtkWidget *dlg=NULL;
  64
  65 /* used to keep track of the statistics for an entire scsi command set */
  66 typedef struct _scsistat_t {
  67         GtkWidget *win;
  68         srt_stat_table srt_table;
  69         guint8 cmdset;
  70         const value_string *cdbnames;
  71         const char *prog;
  72 } scsistat_t;
  73
  74 static guint8 scsi_program=0;
  75 static GtkWidget *filter_entry;
  76
  77 static char *
  78 scsistat_gen_title(scsistat_t *rs)
  79 {
  80         char *title;
  81
  82         title = g_strdup_printf("SCSI Service Response Time statistics for %s: %s",
  83             rs->prog, cf_get_display_name(&cfile));
  84         return title;
  85 }
  86
  87 static void
  88 scsistat_set_title(scsistat_t *rs)
  89 {
  90         char *title;
  91
  92         title = scsistat_gen_title(rs);
  93         gtk_window_set_title(GTK_WINDOW(rs->win), title);
  94         g_free(title);
  95 }
  96
  97 static void
  98 scsistat_reset(void *arg)
  99 {
 100         scsistat_t *rs = arg;
 101
 102         reset_srt_table_data(&rs->srt_table);
 103         scsistat_set_title(rs);
 104 }
 105
 106
 107 static void
 108 dlg_destroy_cb(void)
 109 {
 110         dlg=NULL;
 111 }
 112
 113
 114 static void
 115 scsistat_program_select(GtkWidget *item _U_, gpointer key)
 116 {
 117         int k=(long)key;
 118
 119         scsi_program=k;
 120 }
 121
 122 static int
 123 scsistat_packet(void *arg, packet_info *pinfo, epan_dissect_t *edt _U_, const void *arg2)
 124 {
 125         scsistat_t *rs = arg;
 126         const scsi_task_data_t *ri = arg2;
 127
 128         /* we are only interested in response packets */
 129         if(ri->type!=SCSI_PDU_TYPE_RSP){
 130                 return 0;
 131         }
 132         /* we are only interested in a specific commandset */
 133         if( (!ri->itl) || ((ri->itl->cmdset&SCSI_CMDSET_MASK)!=rs->cmdset) ){
 134                 return 0;
 135         }
 136         /* check that the opcode looks sane */
 137         if( (!ri->itlq) || (ri->itlq->scsi_opcode>255) ){
 138                 return 0;
 139         }
 140
 141         add_srt_table_data(&rs->srt_table, ri->itlq->scsi_opcode, &ri->itlq->fc_time, pinfo);
 142
 143         return 1;
 144 }
 145
 146 static void
 147 scsistat_draw(void *arg)
 148 {
 149         scsistat_t *rs = arg;
 150
 151         draw_srt_table_data(&rs->srt_table);
 152 }
 153
 154
 155
 156 /* since the gtk2 implementation of tap is multithreaded we must protect
 157  * remove_tap_listener() from modifying the list while draw_tap_listener()
 158  * is running.  the other protected block is in main.c
 159  *
 160  * there should not be any other critical regions in gtk2
 161  */
 162 static void
 163 win_destroy_cb(GtkWindow *win _U_, gpointer data)
 164 {
 165         scsistat_t *rs=(scsistat_t *)data;
 166
 167         protect_thread_critical_region();
 168         remove_tap_listener(rs);
 169         unprotect_thread_critical_region();
 170
 171         free_srt_table_data(&rs->srt_table);
 172         g_free(rs);
 173 }
 174
 175
 176 /* When called, this function will create a new instance of gtk2-scsistat.
 177  */
 178 static void
 179 gtk_scsistat_init(const char *optarg, void* userdata _U_)
 180 {
 181         scsistat_t *rs;
 182         guint32 i;
 183         char *title_string;
 184         char *filter_string;
 185         GtkWidget *vbox;
 186         GtkWidget *stat_label;
 187         GtkWidget *filter_label;
 188         GtkWidget *bbox;
 189         GtkWidget *close_bt;
 190         int program, pos;
 191         const char *filter=NULL;
 192         GString *error_string;
 193         char *hf_name=NULL;
 194
 195         pos=0;
 196         if(sscanf(optarg,"scsi,srt,%d,%n",&program,&pos)==1){
 197                 if(pos){
 198                         filter=optarg+pos;
 199                 } else {
 200                         filter=NULL;
 201                 }
 202         } else {
 203                 fprintf(stderr, "wireshark: invalid \"-z scsi,srt,<cmdset>[,<filter>]\" argument\n");
 204                 exit(1);
 205         }
 206
 207         scsi_program=program;
 208         rs=g_malloc(sizeof(scsistat_t));
 209         rs->cmdset=program;
 210         switch(program){
 211         case SCSI_DEV_SBC:
 212                 rs->prog="SBC (disk)";
 213                 rs->cdbnames=scsi_sbc_vals;
 214                 hf_name="scsi.sbc.opcode";
 215                 break;
 216         case SCSI_DEV_SSC:
 217                 rs->prog="SSC (tape)";
 218                 rs->cdbnames=scsi_ssc_vals;
 219                 hf_name="scsi.ssc.opcode";
 220                 break;
 221         case SCSI_DEV_CDROM:
 222                 rs->prog="MMC (cd/dvd)";
 223                 rs->cdbnames=scsi_mmc_vals;
 224                 hf_name="scsi.mmc.opcode";
 225                 break;
 226         case SCSI_DEV_SMC:
 227                 rs->prog="SMC (tape robot)";
 228                 rs->cdbnames=scsi_smc_vals;
 229                 hf_name="scsi.smc.opcode";
 230                 break;
 231         case SCSI_DEV_OSD:
 232                 rs->prog="OSD (object based)";
 233                 rs->cdbnames=scsi_osd_vals;
 234                 hf_name="scsi.osd.opcode";
 235                 break;
 236         }
 237
 238         rs->win=window_new(GTK_WINDOW_TOPLEVEL, "scsi-stat");
 239         gtk_window_set_default_size(GTK_WINDOW(rs->win), 550, 400);
 240         scsistat_set_title(rs);
 241
 242         vbox=gtk_vbox_new(FALSE, 3);
 243         gtk_container_add(GTK_CONTAINER(rs->win), vbox);
 244         gtk_container_set_border_width(GTK_CONTAINER(vbox), 12);
 245
 246         title_string = scsistat_gen_title(rs);
 247         stat_label=gtk_label_new(title_string);
 248         g_free(title_string);
 249         gtk_box_pack_start(GTK_BOX(vbox), stat_label, FALSE, FALSE, 0);
 250
 251         filter_string = g_strdup_printf("Filter: %s", filter ? filter : "");
 252         filter_label=gtk_label_new(filter_string);
 253         g_free(filter_string);
 254         gtk_label_set_line_wrap(GTK_LABEL(filter_label), TRUE);
 255         gtk_box_pack_start(GTK_BOX(vbox), filter_label, FALSE, FALSE, 0);
 256
 257         /* We must display TOP LEVEL Widget before calling init_srt_table() */
 258         gtk_widget_show_all(rs->win);
 259
 260         init_srt_table(&rs->srt_table, 256, vbox, hf_name);
 261
 262         for(i=0;i<256;i++){
 263                 init_srt_table_row(&rs->srt_table, i, val_to_str(i, rs->cdbnames, "Unknown-0x%02x"));
 264         }
 265
 266
 267         error_string=register_tap_listener("scsi", rs, filter, 0, scsistat_reset, scsistat_packet, scsistat_draw);
 268         if(error_string){
 269                 simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s", error_string->str);
 270                 g_string_free(error_string, TRUE);
 271                 free_srt_table_data(&rs->srt_table);
 272                 g_free(rs);
 273                 return;
 274         }
 275
 276         /* Button row. */
 277         bbox = dlg_button_row_new(GTK_STOCK_CLOSE, NULL);
 278         gtk_box_pack_end(GTK_BOX(vbox), bbox, FALSE, FALSE, 0);
 279
 280         close_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CLOSE);
 281         window_set_cancel_button(rs->win, close_bt, window_cancel_button_cb);
 282
 283         g_signal_connect(rs->win, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);
 284         g_signal_connect(rs->win, "destroy", G_CALLBACK(win_destroy_cb), rs);
 285
 286         gtk_widget_show_all(rs->win);
 287         window_present(rs->win);
 288
 289         cf_retap_packets(&cfile);
 290         gdk_window_raise(rs->win->window);
 291 }
 292
 293
 294
 295 static void
 296 scsistat_start_button_clicked(GtkWidget *item _U_, gpointer data _U_)
 297 {
 298         GString *str;
 299         const char *filter;
 300
 301         str = g_string_new("scsi,srt");
 302         g_string_append_printf(str, ",%d", scsi_program);
 303         filter=gtk_entry_get_text(GTK_ENTRY(filter_entry));
 304         if(filter[0]!=0){
 305                 g_string_append_printf(str, ",%s", filter);
 306         }
 307
 308         gtk_scsistat_init(str->str,NULL);
 309         g_string_free(str, TRUE);
 310 }
 311
 312
 313 static void
 314 gtk_scsistat_cb(GtkWidget *w _U_, gpointer d _U_)
 315 {
 316         GtkWidget *prog_menu;
 317         GtkWidget *dlg_box;
 318         GtkWidget *prog_box, *prog_label, *prog_opt;
 319         GtkWidget *filter_box, *filter_bt;
 320         GtkWidget *menu_item;
 321         GtkWidget *bbox, *start_button, *cancel_button;
 322         const char *filter;
 323         static construct_args_t args = {
 324           "Service Response Time Statistics Filter",
 325           TRUE,
 326           FALSE,
 327       FALSE
 328         };
 329
 330         /* if the window is already open, bring it to front */
 331         if(dlg){
 332                 gdk_window_raise(dlg->window);
 333                 return;
 334         }
 335
 336         dlg=dlg_window_new("Wireshark: Compute SCSI SRT statistics");
 337         gtk_window_set_default_size(GTK_WINDOW(dlg), 300, -1);
 338
 339         dlg_box=gtk_vbox_new(FALSE, 10);
 340         gtk_container_set_border_width(GTK_CONTAINER(dlg_box), 10);
 341         gtk_container_add(GTK_CONTAINER(dlg), dlg_box);
 342         gtk_widget_show(dlg_box);
 343
 344         /* Program box */
 345         prog_box=gtk_hbox_new(FALSE, 10);
 346
 347         /* Program label */
 348         gtk_container_set_border_width(GTK_CONTAINER(prog_box), 10);
 349         prog_label=gtk_label_new("Commandset:");
 350         gtk_box_pack_start(GTK_BOX(prog_box), prog_label, FALSE, FALSE, 0);
 351         gtk_widget_show(prog_label);
 352
 353         /* Program menu */
 354         prog_opt=gtk_option_menu_new();
 355         prog_menu=gtk_menu_new();
 356
 357         /* SBC */
 358         menu_item=gtk_menu_item_new_with_label("SBC (disk)");
 359         g_signal_connect(menu_item, "activate", G_CALLBACK(scsistat_program_select), SCSI_DEV_SBC);
 360         gtk_widget_show(menu_item);
 361         gtk_menu_shell_append(GTK_MENU_SHELL(prog_menu), menu_item);
 362
 363
 364         /* SSC */
 365         menu_item=gtk_menu_item_new_with_label("SSC (tape)");
 366         g_signal_connect(menu_item, "activate", G_CALLBACK(scsistat_program_select), (gpointer)SCSI_DEV_SSC);
 367         gtk_widget_show(menu_item);
 368         gtk_menu_shell_append(GTK_MENU_SHELL(prog_menu), menu_item);
 369
 370         /* MMC */
 371         menu_item=gtk_menu_item_new_with_label("MMC (cd/dvd)");
 372         g_signal_connect(menu_item, "activate", G_CALLBACK(scsistat_program_select), (gpointer)SCSI_DEV_CDROM);
 373         gtk_widget_show(menu_item);
 374         gtk_menu_shell_append(GTK_MENU_SHELL(prog_menu), menu_item);
 375
 376
 377         gtk_option_menu_set_menu(GTK_OPTION_MENU(prog_opt), prog_menu);
 378         gtk_box_pack_start(GTK_BOX(prog_box), prog_opt, TRUE, TRUE, 0);
 379         gtk_widget_show(prog_opt);
 380
 381         gtk_box_pack_start(GTK_BOX(dlg_box), prog_box, TRUE, TRUE, 0);
 382         gtk_widget_show(prog_box);
 383
 384         /* Filter box */
 385         filter_box=gtk_hbox_new(FALSE, 3);
 386
 387         /* Filter label */
 388         filter_bt=gtk_button_new_from_stock(WIRESHARK_STOCK_DISPLAY_FILTER_ENTRY);
 389         g_signal_connect(filter_bt, "clicked", G_CALLBACK(display_filter_construct_cb), &args);
 390         gtk_box_pack_start(GTK_BOX(filter_box), filter_bt, FALSE, FALSE, 0);
 391         gtk_widget_show(filter_bt);
 392
 393         /* Filter entry */
 394         filter_entry=gtk_entry_new();
 395         g_signal_connect(filter_entry, "changed", G_CALLBACK(filter_te_syntax_check_cb), NULL);
 396         g_object_set_data(G_OBJECT(filter_box), E_FILT_AUTOCOMP_PTR_KEY, NULL);
 397         g_signal_connect(filter_entry, "key-press-event", G_CALLBACK (filter_string_te_key_pressed_cb), NULL);
 398         g_signal_connect(dlg, "key-press-event", G_CALLBACK (filter_parent_dlg_key_pressed_cb), NULL);
 399
 400         /* filter prefs dialog */
 401         g_object_set_data(G_OBJECT(filter_bt), E_FILT_TE_PTR_KEY, filter_entry);
 402         /* filter prefs dialog */
 403
 404         gtk_box_pack_start(GTK_BOX(filter_box), filter_entry, TRUE, TRUE, 0);
 405         filter=gtk_entry_get_text(GTK_ENTRY(main_display_filter_widget));
 406         if(filter){
 407                 gtk_entry_set_text(GTK_ENTRY(filter_entry), filter);
 408         } else {
 409                 colorize_filter_te_as_empty(filter_entry);
 410         }
 411         gtk_widget_show(filter_entry);
 412
 413         gtk_box_pack_start(GTK_BOX(dlg_box), filter_box, TRUE, TRUE, 0);
 414         gtk_widget_show(filter_box);
 415
 416         /* button box */
 417         bbox = dlg_button_row_new(WIRESHARK_STOCK_CREATE_STAT, GTK_STOCK_CANCEL, NULL);
 418         gtk_box_pack_start(GTK_BOX(dlg_box), bbox, FALSE, FALSE, 0);
 419         gtk_widget_show(bbox);
 420
 421         start_button = g_object_get_data(G_OBJECT(bbox), WIRESHARK_STOCK_CREATE_STAT);
 422         g_signal_connect_swapped(start_button, "clicked",
 423                              G_CALLBACK(scsistat_start_button_clicked), NULL);
 424
 425         cancel_button = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CANCEL);
 426         window_set_cancel_button(dlg, cancel_button, window_cancel_button_cb);
 427
 428         /* Give the initial focus to the "Filter" entry box. */
 429         gtk_widget_grab_focus(filter_entry);
 430
 431         gtk_widget_grab_default(start_button );
 432
 433         g_signal_connect(dlg, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);
 434         g_signal_connect(dlg, "destroy", G_CALLBACK(dlg_destroy_cb), NULL);
 435
 436         gtk_widget_show_all(dlg);
 437         window_present(dlg);
 438 }
 439
 440
 441 void
 442 register_tap_listener_gtkscsistat(void)
 443 {
 444         register_stat_cmd_arg("scsi,srt,", gtk_scsistat_init, NULL);
 445
 446         register_stat_menu_item("SCSI...", REGISTER_STAT_GROUP_RESPONSE_TIME,
 447             gtk_scsistat_cb, NULL, NULL, NULL);
 448
 449 }
 450