minor comment additions
[obnox/wireshark/wip.git] / tap-h225rassrt.c
1 /* tap_h225rassrt.c
2  * h225 RAS Service Response Time statistics for ethereal
3  * Copyright 2003 Lars Roland
4  *
5  * $Id$
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@ethereal.com>
9  * Copyright 1998 Gerald Combs
10  *
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.
15  *
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.
20  *
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.
24  */
25
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <stdio.h>
31
32 #ifdef HAVE_SYS_TYPES_H
33 # include <sys/types.h>
34 #endif
35
36 #include <string.h>
37 #include "epan/packet_info.h"
38 #include <epan/tap.h>
39 #include "epan/value_string.h"
40 #include "register.h"
41 #include <epan/dissectors/packet-h225.h>
42 #include "timestats.h"
43
44 /* following values represent the size of their valuestring arrays */
45 #define NUM_RAS_STATS 7
46
47 static const value_string ras_message_category[] = {
48   {  0, "Gatekeeper    "},
49   {  1, "Registration  "},
50   {  2, "UnRegistration"},
51   {  3, "Admission     "},
52   {  4, "Bandwidth     "},
53   {  5, "Disengage     "},
54   {  6, "Location      "},
55   {  0, NULL }
56 };
57
58 typedef enum _ras_type {
59         RAS_REQUEST,
60         RAS_CONFIRM,
61         RAS_REJECT,
62         RAS_OTHER
63 }ras_type;
64
65 typedef enum _ras_category {
66         RAS_GATEKEEPER,
67         RAS_REGISTRATION,
68         RAS_UNREGISTRATION,
69         RAS_ADMISSION,
70         RAS_BANDWIDTH,
71         RAS_DISENGAGE,
72         RAS_LOCATION,
73         RAS_OTHERS
74 }ras_category;
75
76 /* Summary of response-time calculations*/
77 typedef struct _h225_rtd_t {
78         guint32 open_req_num;
79         guint32 disc_rsp_num;
80         guint32 req_dup_num;
81         guint32 rsp_dup_num;
82         timestat_t stats;
83 } h225_rtd_t;
84
85 /* used to keep track of the statistics for an entire program interface */
86 typedef struct _h225rassrt_t {
87         char *filter;
88         h225_rtd_t ras_rtd[NUM_RAS_STATS];
89 } h225rassrt_t;
90
91
92 static void
93 h225rassrt_reset(void *phs)
94 {
95         h225rassrt_t *hs=(h225rassrt_t *)phs;
96         int i;
97
98         for(i=0;i<NUM_RAS_STATS;i++) {
99                 hs->ras_rtd[i].stats.num = 0;
100                 hs->ras_rtd[i].stats.min_num = 0;
101                 hs->ras_rtd[i].stats.max_num = 0;
102                 hs->ras_rtd[i].stats.min.secs = 0;
103                 hs->ras_rtd[i].stats.min.nsecs = 0;
104                 hs->ras_rtd[i].stats.max.secs = 0;
105                 hs->ras_rtd[i].stats.max.nsecs = 0;
106                 hs->ras_rtd[i].stats.tot.secs = 0;
107                 hs->ras_rtd[i].stats.tot.nsecs = 0;
108                 hs->ras_rtd[i].open_req_num = 0;
109                 hs->ras_rtd[i].disc_rsp_num = 0;
110                 hs->ras_rtd[i].req_dup_num = 0;
111                 hs->ras_rtd[i].rsp_dup_num = 0;
112         }
113
114 }
115
116 static int
117 h225rassrt_packet(void *phs, packet_info *pinfo _U_, epan_dissect_t *edt _U_, const void *phi)
118 {
119         h225rassrt_t *hs=(h225rassrt_t *)phs;
120         const h225_packet_info *pi=phi;
121
122         ras_type rasmsg_type = RAS_OTHER;
123         ras_category rascategory = RAS_OTHERS;
124
125         if (pi->msg_type != H225_RAS || pi->msg_tag == -1) {
126                 /* No RAS Message or uninitialized msg_tag -> return */
127                 return 0;
128         }
129
130         if (pi->msg_tag < 21) {
131                 /* */
132                 rascategory = pi->msg_tag / 3;
133                 rasmsg_type = pi->msg_tag % 3;
134         }
135         else {
136                 /* No SRT yet (ToDo) */
137                 return 0;
138         }
139
140         switch(rasmsg_type) {
141
142         case RAS_REQUEST:
143                 if(pi->is_duplicate){
144                         hs->ras_rtd[rascategory].req_dup_num++;
145                 }
146                 else {
147                         hs->ras_rtd[rascategory].open_req_num++;
148                 }
149                 break;
150
151         case RAS_CONFIRM:
152                 /* no break - delay calculation is identical for Confirm and Reject  */
153         case RAS_REJECT:
154                 if(pi->is_duplicate){
155                         /* Duplicate is ignored */
156                         hs->ras_rtd[rascategory].rsp_dup_num++;
157                 }
158                 else if (!pi->request_available) {
159                         /* no request was seen, ignore response  */
160                         hs->ras_rtd[rascategory].disc_rsp_num++;
161                 }
162                 else {
163                         hs->ras_rtd[rascategory].open_req_num--;
164                         time_stat_update(&(hs->ras_rtd[rascategory].stats),&(pi->delta_time), pinfo);
165                 }
166                 break;
167
168         default:
169                 return 0;
170                 break;
171         }
172         return 1;
173 }
174
175 static void
176 h225rassrt_draw(void *phs)
177 {
178         h225rassrt_t *hs=(h225rassrt_t *)phs;
179         int i;
180         timestat_t *rtd_temp;
181
182         printf("======================================== H225 RAS Service Response Time ========================================\n");
183         printf("H225 RAS Service Response Time (SRT) Statistics:\n");
184         printf("RAS-Messages   | Measurements |     Min SRT    |     Max SRT    |     Avg SRT    | Min in Frame | Max in Frame |\n");
185         for(i=0;i<NUM_RAS_STATS;i++) {
186                 rtd_temp = &(hs->ras_rtd[i].stats);
187                 if(rtd_temp->num){
188                         printf("%s | %10u   | %9.2f msec | %9.2f msec | %9.2f msec |  %10u  |  %10u  |\n",
189                                 val_to_str(i,ras_message_category,"Unknown       "),rtd_temp->num,
190                                 nstime_to_msec(&(rtd_temp->min)), nstime_to_msec(&(rtd_temp->max)),
191                                 get_average(&(rtd_temp->tot), rtd_temp->num),
192                                 rtd_temp->min_num, rtd_temp->max_num
193                         );
194                 }
195         }
196         printf("================================================================================================================\n");
197         printf("RAS-Messages   |   Open REQ   |  Discarded RSP  |   Repeated REQ  |   Repeated RSP  |\n");
198         for(i=0;i<NUM_RAS_STATS;i++) {
199                 rtd_temp = &(hs->ras_rtd[i].stats);
200                 if(rtd_temp->num){
201                         printf("%s | %10u   |    %10u   |    %10u   |    %10u   |\n",
202                                 val_to_str(i,ras_message_category,"Unknown       "),
203                                 hs->ras_rtd[i].open_req_num, hs->ras_rtd[i].disc_rsp_num,
204                                 hs->ras_rtd[i].req_dup_num, hs->ras_rtd[i].rsp_dup_num
205                         );
206                 }
207         }
208         printf("================================================================================================================\n");
209
210 }
211
212
213 static void
214 h225rassrt_init(char *optarg)
215 {
216         h225rassrt_t *hs;
217         char *filter=NULL;
218         GString *error_string;
219
220         if(!strncmp(optarg,"h225,srt,",9)){
221                 filter=optarg+9;
222         } else {
223                 filter=g_malloc(1);
224                 *filter='\0';
225         }
226
227         hs = g_malloc(sizeof(h225rassrt_t));
228         hs->filter=g_malloc(strlen(filter)+1);
229         strcpy(hs->filter, filter);
230
231         h225rassrt_reset(hs);
232
233         error_string=register_tap_listener("h225", hs, filter, NULL, h225rassrt_packet, h225rassrt_draw);
234         if(error_string){
235                 /* error, we failed to attach to the tap. clean up */
236                 g_free(hs->filter);
237                 g_free(hs);
238
239                 fprintf(stderr, "tethereal: Couldn't register h225,srt tap: %s\n",
240                     error_string->str);
241                 g_string_free(error_string, TRUE);
242                 exit(1);
243         }
244 }
245
246
247 void
248 register_tap_listener_h225rassrt(void)
249 {
250         register_ethereal_tap("h225,srt", h225rassrt_init);
251 }