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