2 * sip message counter for wireshark
5 * Copied from gtk/sip_stat.c and tap-httpstat.c
7 * Wireshark - Network traffic analyzer
8 * By Gerald Combs <gerald@wireshark.org>
9 * Copyright 1998 Gerald Combs
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
32 #ifdef HAVE_SYS_TYPES_H
33 # include <sys/types.h>
37 #include "epan/packet_info.h"
39 #include <epan/stat_cmd_args.h>
40 #include "epan/value_string.h"
41 #include <epan/dissectors/packet-sip.h>
43 /* used to keep track of the statictics for an entire program interface */
44 typedef struct _sip_stats_t {
46 guint32 packets; /* number of sip packets, including continuations */
47 guint32 resent_packets;
48 guint32 average_setup_time;
49 guint32 max_setup_time;
50 guint32 min_setup_time;
51 guint32 no_of_completed_calls;
52 guint64 total_setup_time;
53 GHashTable *hash_responses;
54 GHashTable *hash_requests;
57 /* used to keep track of the stats for a specific response code
58 * for example it can be { 3, 404, "Not Found" ,...}
59 * which means we captured 3 reply sip/1.1 404 Not Found */
60 typedef struct _sip_response_code_t {
61 guint32 packets; /* 3 */
62 guint response_code; /* 404 */
63 const gchar *name; /* Not Found */
65 } sip_response_code_t;
67 /* used to keep track of the stats for a specific request string */
68 typedef struct _sip_request_method_t {
69 gchar *response; /* eg. : INVITE */
72 } sip_request_method_t;
74 /* TODO: extra codes to be added from SIP extensions? */
75 static const value_string vals_status_code[] = {
78 { 181, "Call Is Being Forwarded"},
80 { 183, "Session Progress"},
81 { 199, "Informational - Others" },
85 { 204, "No Notification"},
86 { 299, "Success - Others"}, /* used to keep track of other Success packets */
88 { 300, "Multiple Choices"},
89 { 301, "Moved Permanently"},
90 { 302, "Moved Temporarily"},
92 { 380, "Alternative Service"},
93 { 399, "Redirection - Others"},
95 { 400, "Bad Request"},
96 { 401, "Unauthorized"},
97 { 402, "Payment Required"},
100 { 405, "Method Not Allowed"},
101 { 406, "Not Acceptable"},
102 { 407, "Proxy Authentication Required"},
103 { 408, "Request Timeout"},
105 { 412, "Conditional Request Failed"},
106 { 413, "Request Entity Too Large"},
107 { 414, "Request-URI Too Long"},
108 { 415, "Unsupported Media Type"},
109 { 416, "Unsupported URI Scheme"},
110 { 420, "Bad Extension"},
111 { 421, "Extension Required"},
112 { 422, "Session Timer Too Small"},
113 { 423, "Interval Too Brief"},
114 { 428, "Use Identity Header"},
115 { 429, "Provide Referrer Identity"},
116 { 430, "Flow Failed"},
117 { 433, "Anonymity Disallowed"},
118 { 436, "Bad Identity-Info"},
119 { 437, "Unsupported Certificate"},
120 { 438, "Invalid Identity Header"},
121 { 439, "First Hop Lacks Outbound Support"},
122 { 440, "Max-Breadth Exceeded"},
123 { 470, "Consent Needed"},
124 { 480, "Temporarily Unavailable"},
125 { 481, "Call/Transaction Does Not Exist"},
126 { 482, "Loop Detected"},
127 { 483, "Too Many Hops"},
128 { 484, "Address Incomplete"},
131 { 487, "Request Terminated"},
132 { 488, "Not Acceptable Here"},
134 { 491, "Request Pending"},
135 { 493, "Undecipherable"},
136 { 494, "Security Agreement Required"},
137 { 499, "Client Error - Others"},
139 { 500, "Server Internal Error"},
140 { 501, "Not Implemented"},
141 { 502, "Bad Gateway"},
142 { 503, "Service Unavailable"},
143 { 504, "Server Time-out"},
144 { 505, "Version Not Supported"},
145 { 513, "Message Too Large"},
146 { 599, "Server Error - Others"},
148 { 600, "Busy Everywhere"},
150 { 604, "Does Not Exist Anywhere"},
151 { 606, "Not Acceptable"},
152 { 699, "Global Failure - Others"},
157 /* Create tables for responses and requests */
159 sip_init_hash(sipstat_t *sp)
163 /* Create responses table */
164 sp->hash_responses = g_hash_table_new(g_int_hash, g_int_equal);
166 /* Add all response codes */
167 for (i=0 ; vals_status_code[i].strptr ; i++)
169 gint *key = g_malloc (sizeof(gint));
170 sip_response_code_t *sc = g_malloc (sizeof(sip_response_code_t));
171 *key = vals_status_code[i].value;
173 sc->response_code = *key;
174 sc->name=vals_status_code[i].strptr;
176 g_hash_table_insert(sc->sp->hash_responses, key, sc);
179 /* Create empty requests table */
180 sp->hash_requests = g_hash_table_new(g_str_hash, g_str_equal);
184 sip_draw_hash_requests( gchar *key _U_ , sip_request_method_t *data, gchar * format)
186 if (data->packets==0)
188 printf( format, data->response, data->packets);
192 sip_draw_hash_responses( gint * key _U_ , sip_response_code_t *data, char * format)
195 g_warning("C'est quoi ce borderl key=%d\n", *key);
198 if (data->packets==0)
200 printf(format, data->response_code, data->name, data->packets );
203 /* NOT USED at this moment */
206 sip_free_hash( gpointer key, gpointer value, gpointer user_data _U_ )
214 sip_reset_hash_responses(gchar *key _U_ , sip_response_code_t *data, gpointer ptr _U_ )
219 sip_reset_hash_requests(gchar *key _U_ , sip_request_method_t *data, gpointer ptr _U_ )
225 sipstat_reset(void *psp )
230 sp->resent_packets = 0;
231 sp->average_setup_time = 0;
232 sp->max_setup_time = 0;
233 sp->min_setup_time = 0;
234 sp->no_of_completed_calls = 0;
235 sp->total_setup_time = 0;
237 g_hash_table_foreach( sp->hash_responses, (GHFunc)sip_reset_hash_responses, NULL);
238 g_hash_table_foreach( sp->hash_requests, (GHFunc)sip_reset_hash_requests, NULL);
243 /* Main entry point to SIP tap */
245 sipstat_packet(void *psp, packet_info *pinfo _U_, epan_dissect_t *edt _U_, const void *pri)
247 const sip_info_value_t *value=pri;
248 sipstat_t *sp = (sipstat_t *)psp;
250 /* Total number of packets, including continuation packets */
253 /* Calculate average setup time */
254 if (value->setup_time){
255 sp->no_of_completed_calls++;
256 /* Check if it's the first value */
257 if ( sp->total_setup_time == 0 ){
258 sp->average_setup_time = value->setup_time;
259 sp->total_setup_time = value->setup_time;
260 sp->max_setup_time = value->setup_time;
261 sp->min_setup_time = value->setup_time;
263 sp->total_setup_time = sp->total_setup_time + value->setup_time;
264 if (sp->max_setup_time < value->setup_time){
265 sp->max_setup_time = value->setup_time;
267 if (sp->min_setup_time > value->setup_time){
268 sp->min_setup_time = value->setup_time;
270 /* Calculate average */
271 sp->average_setup_time = (guint32)(sp->total_setup_time / sp->no_of_completed_calls);
275 /* Update resent count if flag set */
278 sp->resent_packets++;
282 /* Looking at both requests and responses */
283 if (value->response_code != 0)
286 guint *key = g_malloc(sizeof(guint));
287 sip_response_code_t *sc;
289 /* Look up response code in hash table */
290 *key = value->response_code;
291 sc = g_hash_table_lookup(sp->hash_responses, key);
294 /* Non-standard status code ; we classify it as others
295 * in the relevant category
296 * (Informational,Success,Redirection,Client Error,Server Error,Global Failure)
298 int i = value->response_code;
299 if ((i<100) || (i>=700))
301 /* Forget about crazy values */
306 *key=199; /* Hopefully, this status code will never be used */
329 /* Now look up this fallback code to get its text description */
330 sc = g_hash_table_lookup(sp->hash_responses, key);
338 else if (value->request_method)
341 sip_request_method_t *sc;
343 /* Look up the request method in the table */
344 sc = g_hash_table_lookup(sp->hash_requests, value->request_method);
347 /* First of this type. Create structure and initialise */
348 sc=g_malloc(sizeof(sip_request_method_t));
349 sc->response = g_strdup(value->request_method);
352 /* Insert it into request table */
353 g_hash_table_insert(sp->hash_requests, sc->response, sc);
357 /* Already existed, just update count for that method */
360 /* g_free(value->request_method); */
364 /* No request method set. Just ignore */
372 sipstat_draw(void *psp )
376 printf("===================================================================\n");
377 if (sp->filter == NULL)
378 printf("SIP Statistics\n");
380 printf("SIP Statistics with filter %s\n", sp->filter);
382 printf("\nNumber of SIP messages: %d", sp->packets);
383 printf("\nNumber of resent SIP messages: %d\n", sp->resent_packets);
384 printf( "\n* SIP Status Codes in reply packets\n");
385 g_hash_table_foreach( sp->hash_responses, (GHFunc)sip_draw_hash_responses,
386 " SIP %3d %-15s : %5d Packets\n");
387 printf("\n* List of SIP Request methods\n");
388 g_hash_table_foreach( sp->hash_requests, (GHFunc)sip_draw_hash_requests,
389 " %-15s : %5d Packets\n");
390 printf( "\n* Average setup time %d ms\n Min %d ms\n Max %d ms\n", sp->average_setup_time, sp->min_setup_time, sp->max_setup_time);
391 printf("===================================================================\n");
395 sipstat_init(const char *optarg, void* userdata _U_)
398 const char *filter=NULL;
399 GString *error_string;
401 if (strncmp (optarg, "sip,stat,", 9) == 0){
407 sp = g_malloc( sizeof(sipstat_t) );
409 sp->filter=g_strdup(filter);
413 /*g_hash_table_foreach( sip_status, (GHFunc)sip_reset_hash_responses, NULL);*/
416 error_string = register_tap_listener(
425 /* error, we failed to attach to the tap. clean up */
428 fprintf (stderr, "tshark: Couldn't register sip,stat tap: %s\n",
430 g_string_free(error_string, TRUE);
435 sp->resent_packets = 0;
440 register_tap_listener_sipstat(void)
442 register_stat_cmd_arg("sip,stat", sipstat_init,NULL);