/* sip_stat.c * sip_stat 2004 Martin Mathieson * * $Id$ * Copied from http_stat.c * * Ethereal - Network traffic analyzer * By Gerald Combs * Copyright 1998 Gerald Combs * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include #include #include #include #include "simple_dialog.h" #include "gui_utils.h" #include "dlg_utils.h" #include #include "../register.h" #include #include "../globals.h" #include "compat_macros.h" #include "../stat_menu.h" #include "../tap_dfilter_dlg.h" #define SUM_STR_MAX 1024 /* Used to keep track of the statistics for an entire program interface */ typedef struct _sip_stats_t { char *filter; GtkWidget *win; GHashTable *hash_responses; GHashTable *hash_requests; guint32 packets; /* number of sip packets, including continuations */ guint32 resent_packets; GtkWidget *packets_label; GtkWidget *resent_label; GtkWidget *request_box; /* container for INVITE, ... */ GtkWidget *informational_table; /* Status code between 100 and 199 */ GtkWidget *success_table; /* 200 and 299 */ GtkWidget *redirection_table; /* 300 and 399 */ GtkWidget *client_error_table; /* 400 and 499 */ GtkWidget *server_errors_table; /* 500 and 599 */ GtkWidget *global_failures_table; /* 600 and 699 */ } sipstat_t; /* Used to keep track of the stats for a specific response code * for example it can be { 3, 404, "Not Found" ,...} * which means we captured 3 reply sip/1.1 404 Not Found */ typedef struct _sip_response_code_t { guint32 packets; /* 3 */ guint response_code; /* 404 */ const gchar *name; /* "Not Found" */ GtkWidget *widget; /* Label where we display it */ GtkWidget *table; /* Table in which we put it, e.g. client_error_table */ sipstat_t *sp; /* Pointer back to main struct */ } sip_response_code_t; /* Used to keep track of the stats for a specific request string */ typedef struct _sip_request_method_t { gchar *response; /* eg. : INVITE */ guint32 packets; GtkWidget *widget; sipstat_t *sp; /* Pointer back to main struct */ } sip_request_method_t; /* TODO: extra codes to be added from SIP extensions? */ static const value_string vals_status_code[] = { { 100, "Trying"}, { 180, "Ringing"}, { 181, "Call Is Being Forwarded"}, { 182, "Queued"}, { 183, "Session Progress"}, { 199, "Informational - Others" }, { 200, "OK"}, { 202, "Accepted"}, { 299, "Success - Others"}, /* used to keep track of other Success packets */ { 300, "Multiple Choices"}, { 301, "Moved Permanently"}, { 302, "Moved Temporarily"}, { 305, "Use Proxy"}, { 380, "Alternative Service"}, { 399, "Redirection - Others"}, { 400, "Bad Request"}, { 401, "Unauthorized"}, { 402, "Payment Required"}, { 403, "Forbidden"}, { 404, "Not Found"}, { 405, "Method Not Allowed"}, { 406, "Not Acceptable"}, { 407, "Proxy Authentication Required"}, { 408, "Request Timeout"}, { 410, "Gone"}, { 412, "Conditional Request Failed"}, { 413, "Request Entity Too Large"}, { 414, "Request-URI Too Long"}, { 415, "Unsupported Media Type"}, { 416, "Unsupported URI Scheme"}, { 420, "Bad Extension"}, { 421, "Extension Required"}, { 423, "Interval Too Brief"}, { 480, "Temporarily Unavailable"}, { 481, "Call/Transaction Does Not Exist"}, { 482, "Loop Detected"}, { 483, "Too Many Hops"}, { 484, "Address Incomplete"}, { 485, "Ambiguous"}, { 486, "Busy Here"}, { 487, "Request Terminated"}, { 488, "Not Acceptable Here"}, { 489, "Bad Event"}, { 491, "Request Pending"}, { 493, "Undecipherable"}, { 499, "Client Error - Others"}, { 500, "Server Internal Error"}, { 501, "Not Implemented"}, { 502, "Bad Gateway"}, { 503, "Service Unavailable"}, { 504, "Server Time-out"}, { 505, "Version Not Supported"}, { 513, "Message Too Large"}, { 599, "Server Error - Others"}, { 600, "Busy Everywhere"}, { 603, "Decline"}, { 604, "Does Not Exist Anywhere"}, { 606, "Not Acceptable"}, { 699, "Global Failure - Others"}, { 0, NULL} }; /* Create tables for responses and requests */ static void sip_init_hash(sipstat_t *sp) { int i; /* Create responses table */ sp->hash_responses = g_hash_table_new(g_int_hash, g_int_equal); /* Add all response codes */ for (i=0 ; vals_status_code[i].strptr ; i++) { gint *key = g_malloc (sizeof(gint)); sip_response_code_t *sc = g_malloc (sizeof(sip_response_code_t)); *key = vals_status_code[i].value; sc->packets=0; sc->response_code = *key; sc->name=vals_status_code[i].strptr; sc->widget=NULL; sc->table=NULL; sc->sp = sp; g_hash_table_insert(sc->sp->hash_responses, key, sc); } /* Create empty requests table */ sp->hash_requests = g_hash_table_new(g_str_hash, g_str_equal); } /* Draw the entry for an individual request message */ static void sip_draw_hash_requests(gchar *key _U_ , sip_request_method_t *data, gchar * unused _U_) { gchar string_buff[SUM_STR_MAX]; g_assert(data!=NULL); if (data->packets==0) { return; } /* Build string showing method and count */ g_snprintf(string_buff, sizeof(string_buff), " %-11s : %3d packets", data->response, data->packets); if (data->widget==NULL) { /* Create new label */ data->widget=gtk_label_new(string_buff); gtk_misc_set_alignment(GTK_MISC(data->widget), 0.0, 0.5); gtk_box_pack_start(GTK_BOX(data->sp->request_box), data->widget,FALSE,FALSE, 0); gtk_widget_show(data->widget); } else { /* Update existing label */ gtk_label_set(GTK_LABEL(data->widget), string_buff); } } /* Draw an individual response entry */ static void sip_draw_hash_responses(gint * key _U_ , sip_response_code_t *data, gchar * unused _U_) { gchar string_buff[SUM_STR_MAX]; g_assert(data!=NULL); if (data->packets==0) { return; } /* Create an entry in the relevant box of the window */ if (data->widget==NULL) { guint16 x; GtkWidget *tmp; guint i = data->response_code; /* Out of valid range - ignore */ if ((i<100)||(i>=700)) { return; } /* Find the table matching the code */ if (i<200) { data->table = data->sp->informational_table; } else if (i<300) { data->table = data->sp->success_table; } else if (i<400) { data->table = data->sp->redirection_table; } else if (i<500) { data->table = data->sp->client_error_table; } else if (i < 600) { data->table = data->sp->server_errors_table; } else { data->table = data->sp->global_failures_table; } /* Get number of rows in table */ x = GTK_TABLE(data->table)->nrows; /* Create a new label with this response, e.g. "SIP 180 Ringing" */ g_snprintf(string_buff, sizeof(string_buff), "SIP %3d %s ", data->response_code, data->name); tmp = gtk_label_new(string_buff); /* Insert the label in the correct place in the table */ gtk_table_attach_defaults(GTK_TABLE(data->table), tmp, 0, 1, x, x+1); gtk_label_set_justify(GTK_LABEL(tmp), GTK_JUSTIFY_LEFT); gtk_widget_show(tmp); /* Show number of packets */ g_snprintf(string_buff, sizeof(string_buff), "%9d", data->packets); data->widget=gtk_label_new(string_buff); /* Show this widget in the right place */ gtk_table_attach_defaults(GTK_TABLE(data->table), data->widget, 1, 2,x,x+1); gtk_label_set_justify(GTK_LABEL(data->widget), GTK_JUSTIFY_RIGHT); gtk_widget_show(data->widget); gtk_table_resize(GTK_TABLE(data->table), x+1, 4); } else { /* Just update the existing label string */ g_snprintf(string_buff, sizeof(string_buff), "%9d", data->packets); gtk_label_set(GTK_LABEL(data->widget), string_buff); } } static void sip_free_hash(gpointer key, gpointer value, gpointer user_data _U_) { g_free(key); g_free(value); } static void sip_reset_hash_responses(gchar *key _U_ , sip_response_code_t *data, gpointer ptr _U_) { data->packets = 0; } static void sip_reset_hash_requests(gchar *key _U_ , sip_request_method_t *data, gpointer ptr _U_) { data->packets = 0; } static void sipstat_reset(void *psp) { sipstat_t *sp = psp; if (sp) { sp->packets = 0; sp->resent_packets = 0; g_hash_table_foreach(sp->hash_responses, (GHFunc)sip_reset_hash_responses, NULL); g_hash_table_foreach(sp->hash_requests, (GHFunc)sip_reset_hash_requests, NULL); } } /* Main entry point to SIP tap */ static int sipstat_packet(void *psp, packet_info *pinfo _U_, epan_dissect_t *edt _U_, const void *pri) { const sip_info_value_t *value=pri; sipstat_t *sp = (sipstat_t *)psp; /* Total number of packets, including continuation packets */ sp->packets++; /* Update resent count if flag set */ if (value->resend) { sp->resent_packets++; } /* Looking at both requests and responses */ if (value->response_code != 0) { /* Responses */ guint *key = g_malloc(sizeof(guint)); sip_response_code_t *sc; /* Look up response code in hash table */ *key = value->response_code; sc = g_hash_table_lookup(sp->hash_responses, key); if (sc==NULL) { /* Non-standard status code ; we classify it as others * in the relevant category * (Informational,Success,Redirection,Client Error,Server Error,Global Failure) */ int i = value->response_code; if ((i<100) || (i>=700)) { /* Forget about crazy values */ return 0; } else if (i<200) { *key=199; /* Hopefully, this status code will never be used */ } else if (i<300) { *key=299; } else if (i<400) { *key=399; } else if (i<500) { *key=499; } else if (i<600) { *key=599; } else { *key = 699; } /* Now look up this fallback code to get its text description */ sc = g_hash_table_lookup(sp->hash_responses, key); if (sc==NULL) { return 0; } } sc->packets++; } else if (value->request_method) { /* Requests */ sip_request_method_t *sc; /* Look up the request method in the table */ sc = g_hash_table_lookup(sp->hash_requests, value->request_method); if (sc == NULL) { /* First of this type. Create structure and initialise */ sc=g_malloc(sizeof(sip_request_method_t)); sc->response = g_strdup(value->request_method); sc->packets = 1; sc->widget = NULL; sc->sp = sp; /* Insert it into request table */ g_hash_table_insert(sp->hash_requests, sc->response, sc); } else { /* Already existed, just update count for that method */ sc->packets++; } /* g_free(value->request_method); */ } else { /* No request method set. Just ignore */ return 0; } return 1; } /* Redraw the whole stats window */ static void sipstat_draw(void *psp) { gchar string_buff[SUM_STR_MAX]; sipstat_t *sp=psp; /* Set summary label */ g_snprintf(string_buff, sizeof(string_buff), "SIP stats (%d packets)", sp->packets); gtk_label_set(GTK_LABEL(sp->packets_label), string_buff); /* Set resend count label */ g_snprintf(string_buff, sizeof(string_buff), "(%d resent packets)", sp->resent_packets); gtk_label_set(GTK_LABEL(sp->resent_label), string_buff); /* Draw responses and requests from their tables */ g_hash_table_foreach(sp->hash_responses, (GHFunc)sip_draw_hash_responses, NULL); g_hash_table_foreach(sp->hash_requests, (GHFunc)sip_draw_hash_requests, NULL); gtk_widget_show_all(sp->win); } /* since the gtk2 implementation of tap is multithreaded we must protect * remove_tap_listener() from modifying the list while draw_tap_listener() * is running. the other protected block is in main.c * * there should not be any other critical regions in gtk2 */ void protect_thread_critical_region(void); void unprotect_thread_critical_region(void); /* When window is destroyed, clean up */ static void win_destroy_cb(GtkWindow *win _U_, gpointer data) { sipstat_t *sp=(sipstat_t *)data; protect_thread_critical_region(); remove_tap_listener(sp); unprotect_thread_critical_region(); g_hash_table_foreach(sp->hash_responses, (GHFunc)sip_free_hash, NULL); g_hash_table_destroy(sp->hash_responses); g_hash_table_foreach(sp->hash_requests, (GHFunc)sip_free_hash, NULL); g_hash_table_destroy(sp->hash_requests); g_free(sp->filter); g_free(sp); } /* Create a new instance of gtk_sipstat. */ static void gtk_sipstat_init(const char *optarg, void *userdata _U_) { sipstat_t *sp; const char *filter = NULL; GString *error_string; char *title = NULL; GtkWidget *main_vb, *separator, *informational_fr, *success_fr, *redirection_fr, *client_errors_fr, *server_errors_fr, *global_failures_fr, *request_fr; GtkWidget *bt_close; GtkWidget *bbox; if (strncmp (optarg, "sip,stat,", 9) == 0) { /* Skip those characters from filter to display */ filter=optarg + 9; } else { /* No filter */ filter = NULL; } /* Create sip stats window structure */ sp = g_malloc(sizeof(sipstat_t)); sp->win = window_new(GTK_WINDOW_TOPLEVEL, "sip-stat"); /* Set title to include any filter given */ if (filter) { sp->filter = g_strdup(filter); title = g_strdup_printf("SIP statistics with filter: %s", filter); } else { sp->filter = NULL; title = g_strdup("SIP statistics"); } gtk_window_set_title(GTK_WINDOW(sp->win), title); g_free(title); /* Create container for all widgets */ main_vb = gtk_vbox_new(FALSE, 12); gtk_container_border_width(GTK_CONTAINER(main_vb), 12); gtk_container_add(GTK_CONTAINER(sp->win), main_vb); /* Initialise & show number of packets */ sp->packets = 0; sp->packets_label = gtk_label_new("SIP stats (0 SIP packets)"); gtk_container_add(GTK_CONTAINER(main_vb), sp->packets_label); sp->resent_packets = 0; sp->resent_label = gtk_label_new("(0 resent packets)"); gtk_container_add(GTK_CONTAINER(main_vb), sp->resent_label); gtk_widget_show(sp->resent_label); /* Informational response frame */ informational_fr = gtk_frame_new("Informational SIP 1xx"); gtk_container_add(GTK_CONTAINER(main_vb), informational_fr); /* Information table (within that frame) */ sp->informational_table = gtk_table_new(0, 2, FALSE); gtk_container_add(GTK_CONTAINER(informational_fr), sp->informational_table); /* Success table and frame */ success_fr = gtk_frame_new ("Success SIP 2xx"); gtk_container_add(GTK_CONTAINER(main_vb), success_fr); sp->success_table = gtk_table_new(0, 2, FALSE); gtk_container_add(GTK_CONTAINER(success_fr), sp->success_table); /* Redirection table and frame */ redirection_fr = gtk_frame_new ("Redirection SIP 3xx"); gtk_container_add(GTK_CONTAINER(main_vb), redirection_fr); sp->redirection_table = gtk_table_new(0, 2, FALSE); gtk_container_add(GTK_CONTAINER(redirection_fr), sp->redirection_table); /* Client Errors table and frame */ client_errors_fr = gtk_frame_new("Client errors SIP 4xx"); gtk_container_add(GTK_CONTAINER(main_vb), client_errors_fr); sp->client_error_table = gtk_table_new(0, 2, FALSE); gtk_container_add(GTK_CONTAINER(client_errors_fr), sp->client_error_table); /* Server Errors table and frame */ server_errors_fr = gtk_frame_new("Server errors SIP 5xx"); gtk_container_add(GTK_CONTAINER(main_vb), server_errors_fr); sp->server_errors_table = gtk_table_new(0, 2, FALSE); gtk_container_add(GTK_CONTAINER(server_errors_fr), sp->server_errors_table); /* Global Failures table and frame */ global_failures_fr = gtk_frame_new("Global failures SIP 6xx"); gtk_container_add(GTK_CONTAINER(main_vb), global_failures_fr); sp->global_failures_table = gtk_table_new(0, 2, FALSE); gtk_container_add(GTK_CONTAINER(global_failures_fr), sp->global_failures_table); /* Separator between requests and responses */ separator = gtk_hseparator_new(); gtk_container_add(GTK_CONTAINER(main_vb), separator); /* Request table and frame */ request_fr = gtk_frame_new("List of request methods"); gtk_container_add(GTK_CONTAINER(main_vb), request_fr); gtk_container_border_width(GTK_CONTAINER(request_fr), 0); sp->request_box = gtk_vbox_new(FALSE, 10); gtk_container_add(GTK_CONTAINER(request_fr), sp->request_box); /* Register this tap listener now */ error_string = register_tap_listener("sip", sp, filter, sipstat_reset, sipstat_packet, sipstat_draw); if (error_string) { /* Error. We failed to attach to the tap. Clean up */ simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, error_string->str); g_free(sp->filter); g_free(sp); g_string_free(error_string, TRUE); return; } /* Button row. */ bbox = dlg_button_row_new(GTK_STOCK_CLOSE, NULL); gtk_box_pack_start(GTK_BOX(main_vb), bbox, FALSE, FALSE, 0); bt_close = OBJECT_GET_DATA(bbox, GTK_STOCK_CLOSE); window_set_cancel_button(sp->win, bt_close, window_cancel_button_cb); SIGNAL_CONNECT(sp->win, "delete_event", window_delete_event_cb, NULL); SIGNAL_CONNECT(sp->win, "destroy", win_destroy_cb, sp); /* Display up-to-date contents */ gtk_widget_show_all(sp->win); window_present(sp->win); sip_init_hash(sp); cf_retap_packets(&cfile, FALSE); } static tap_dfilter_dlg sip_stat_dlg = { "SIP Packet Counter", "sip,stat", gtk_sipstat_init, -1 }; /* Register this tap listener and add menu item. */ void register_tap_listener_gtksipstat(void) { register_dfilter_stat(&sip_stat_dlg, "SIP", REGISTER_STAT_GROUP_TELEPHONY); }