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