The Styleguide section has been moved to the Wireshark Developer's Guide.
[obnox/wireshark/wip.git] / tap-rpcstat.c
1 /* tap-rpcstat.c
2  * rpcstat   2002 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 RTT statistics to tshark.
26  * It is only used by tshark and not wireshark
27  *
28  * It serves as an example on how to use the tap api.
29  */
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <stdio.h>
36
37 #ifdef HAVE_SYS_TYPES_H
38 # include <sys/types.h>
39 #endif
40
41 #include <string.h>
42 #include "epan/packet_info.h"
43 #include <epan/tap.h>
44 #include <epan/stat_cmd_args.h>
45 #include <epan/dissectors/packet-rpc.h>
46
47 /* used to keep track of statistics for a specific procedure */
48 typedef struct _rpc_procedure_t {
49         const char *proc;
50         int num;
51         nstime_t min;
52         nstime_t max;
53         nstime_t tot;
54 } rpc_procedure_t;
55
56 /* used to keep track of the statistics for an entire program interface */
57 typedef struct _rpcstat_t {
58         const char *prog;
59         char *filter;
60         guint32 program;
61         guint32 version;
62         guint32 num_procedures;
63         rpc_procedure_t *procedures;
64 } rpcstat_t;
65
66
67
68 /* This callback is never used by tshark but it is here for completeness.
69  * When registering below, we could just have left this function as NULL.
70  *
71  * When used by wireshark, this function will be called whenever we would need
72  * to reset all state. Such as when wireshark opens a new file, when it
73  * starts a new capture, when it rescans the packetlist after some prefs have
74  * changed etc.
75  * So if your application has some state it needs to clean up in those
76  * situations, here is a good place to put that code.
77  */
78 static void
79 rpcstat_reset(void *prs)
80 {
81         rpcstat_t *rs=prs;
82         guint32 i;
83
84         for(i=0;i<rs->num_procedures;i++){
85                 rs->procedures[i].num=0;
86                 rs->procedures[i].min.secs=0;
87                 rs->procedures[i].min.nsecs=0;
88                 rs->procedures[i].max.secs=0;
89                 rs->procedures[i].max.nsecs=0;
90                 rs->procedures[i].tot.secs=0;
91                 rs->procedures[i].tot.nsecs=0;
92         }
93 }
94
95
96 /* This callback is invoked whenever the tap system has seen a packet
97  * we might be interested in.
98  * The function is to be used to only update internal state information
99  * in the *tapdata structure, and if there were state changes which requires
100  * the window to be redrawn, return 1 and (*draw) will be called sometime
101  * later.
102  *
103  * This function should be as lightweight as possible since it executes together
104  * with the normal wireshark dissectors. Try to push as much processing as
105  * possible into (*draw) instead since that function executes asynchronously
106  * and does not affect the main threads performance.
107  *
108  * If it is possible, try to do all "filtering" explicitely as we do below in
109  * this example since you will get MUCH better performance than applying
110  * a similar display-filter in the register call.
111  *
112  * The third parameter is tap dependant. Since we register this one to the "rpc"
113  * tap the third parameters type is rpc_call_info_value.
114  *
115  *
116  * The filtering we do is just to check the rpc_call_info_value struct that
117  * we were called for the proper program and version. We didnt apply a filter
118  * when we registered so we will be called for ALL rpc packets and not just
119  * the ones we are collecting stats for.
120  *
121  *
122  * function returns :
123  *  0: no updates, no need to call (*draw) later
124  * !0: state has changed, call (*draw) sometime later
125  */
126 static int
127 rpcstat_packet(void *prs, packet_info *pinfo, epan_dissect_t *edt _U_, const void *pri)
128 {
129         rpcstat_t *rs=prs;
130         const rpc_call_info_value *ri=pri;
131         nstime_t delta;
132         rpc_procedure_t *rp;
133
134         if(ri->proc>=rs->num_procedures){
135                 /* dont handle this since its outside of known table */
136                 return 0;
137         }
138         /* we are only interested in reply packets */
139         if(ri->request){
140                 return 0;
141         }
142         /* we are only interested in certain program/versions */
143         if( (ri->prog!=rs->program) || (ri->vers!=rs->version) ){
144                 return 0;
145         }
146
147         rp=&(rs->procedures[ri->proc]);
148
149         /* calculate time delta between request and reply */
150         nstime_delta(&delta, &pinfo->fd->abs_ts, &ri->req_time);
151
152         if(rp->num==0){
153                 rp->max.secs=delta.secs;
154                 rp->max.nsecs=delta.nsecs;
155         }
156
157         if(rp->num==0){
158                 rp->min.secs=delta.secs;
159                 rp->min.nsecs=delta.nsecs;
160         }
161
162         if( (delta.secs<rp->min.secs)
163         ||( (delta.secs==rp->min.secs)
164           &&(delta.nsecs<rp->min.nsecs) ) ){
165                 rp->min.secs=delta.secs;
166                 rp->min.nsecs=delta.nsecs;
167         }
168
169         if( (delta.secs>rp->max.secs)
170         ||( (delta.secs==rp->max.secs)
171           &&(delta.nsecs>rp->max.nsecs) ) ){
172                 rp->max.secs=delta.secs;
173                 rp->max.nsecs=delta.nsecs;
174         }
175
176         rp->tot.secs += delta.secs;
177         rp->tot.nsecs += delta.nsecs;
178         if(rp->tot.nsecs>1000000000){
179                 rp->tot.nsecs-=1000000000;
180                 rp->tot.secs++;
181         }
182
183         rp->num++;
184
185         return 1;
186 }
187
188 /* This callback is used when tshark wants us to draw/update our
189  * data to the output device. Since this is tshark only output is
190  * stdout.
191  * TShark will only call this callback once, which is when tshark has
192  * finished reading all packets and exists.
193  * If used with wireshark this may be called any time, perhaps once every 3
194  * seconds or so.
195  * This function may even be called in parallell with (*reset) or (*draw)
196  * so make sure there are no races. The data in the rpcstat_t can thus change
197  * beneath us. Beware.
198  */
199 static void
200 rpcstat_draw(void *prs)
201 {
202         rpcstat_t *rs=prs;
203         guint32 i;
204         guint64 td;
205         printf("\n");
206         printf("===================================================================\n");
207         printf("%s Version %d RTT Statistics:\n", rs->prog, rs->version);
208         printf("Filter: %s\n",rs->filter?rs->filter:"");
209         printf("Procedure        Calls   Min RTT   Max RTT   Avg RTT\n");
210         for(i=0;i<rs->num_procedures;i++){
211                 /* scale it to units of 10us.*/
212                 td=rs->procedures[i].tot.secs;
213                 td=td*100000+(int)rs->procedures[i].tot.nsecs/10000;
214                 if(rs->procedures[i].num){
215                         td/=rs->procedures[i].num;
216                 } else {
217                         td=0;
218                 }
219
220                 printf("%-15s %6d %3d.%05d %3d.%05d %3" G_GINT64_MODIFIER "u.%05" G_GINT64_MODIFIER "u\n",
221                         rs->procedures[i].proc,
222                         rs->procedures[i].num,
223                         (int)rs->procedures[i].min.secs,rs->procedures[i].min.nsecs/10000,
224                         (int)rs->procedures[i].max.secs,rs->procedures[i].max.nsecs/10000,
225                         td/100000, td%100000
226                 );
227         }
228         printf("===================================================================\n");
229 }
230
231 static guint32 rpc_program=0;
232 static guint32 rpc_version=0;
233 static gint32 rpc_min_proc=-1;
234 static gint32 rpc_max_proc=-1;
235
236 static void *
237 rpcstat_find_procs(gpointer *key, gpointer *value _U_, gpointer *user_data _U_)
238 {
239         rpc_proc_info_key *k=(rpc_proc_info_key *)key;
240
241         if(k->prog!=rpc_program){
242                 return NULL;
243         }
244         if(k->vers!=rpc_version){
245                 return NULL;
246         }
247         if(rpc_min_proc==-1){
248                 rpc_min_proc=k->proc;
249                 rpc_max_proc=k->proc;
250         }
251         if((gint32)k->proc<rpc_min_proc){
252                 rpc_min_proc=k->proc;
253         }
254         if((gint32)k->proc>rpc_max_proc){
255                 rpc_max_proc=k->proc;
256         }
257
258         return NULL;
259 }
260
261
262 /* When called, this function will create a new instance of rpcstat.
263  * program and version are whick onc-rpc program/version we want to
264  * collect statistics for.
265  * This function is called from tshark when it parses the -z rpc, arguments
266  * and it creates a new instance to store statistics in and registers this
267  * new instance for the rpc tap.
268  */
269 static void
270 rpcstat_init(const char *optarg, void* userdata _U_)
271 {
272         rpcstat_t *rs;
273         guint32 i;
274         int program, version;
275         int pos=0;
276         const char *filter=NULL;
277         GString *error_string;
278
279         if(sscanf(optarg,"rpc,rtt,%d,%d,%n",&program,&version,&pos)==2){
280                 if(pos){
281                         filter=optarg+pos;
282                 } else {
283                         filter=NULL;
284                 }
285         } else {
286                 fprintf(stderr, "tshark: invalid \"-z rpc,rtt,<program>,<version>[,<filter>]\" argument\n");
287                 exit(1);
288         }
289
290         rs=g_malloc(sizeof(rpcstat_t));
291         rs->prog=rpc_prog_name(program);
292         rs->program=program;
293         rs->version=version;
294         if(filter){
295                 rs->filter=g_strdup(filter);
296         } else {
297                 rs->filter=NULL;
298         }
299         rpc_program=program;
300         rpc_version=version;
301         rpc_min_proc=-1;
302         rpc_max_proc=-1;
303         g_hash_table_foreach(rpc_procs, (GHFunc)rpcstat_find_procs, NULL);
304         if(rpc_min_proc==-1){
305                 fprintf(stderr,"tshark: Invalid -z rpc,rrt,%d,%d\n",rpc_program,rpc_version);
306                 fprintf(stderr,"   Program:%d version:%d isn't supported by tshark.\n", rpc_program, rpc_version);
307                 exit(1);
308         }
309
310
311         rs->num_procedures=rpc_max_proc+1;
312         rs->procedures=g_malloc(sizeof(rpc_procedure_t)*(rs->num_procedures+1));
313         for(i=0;i<rs->num_procedures;i++){
314                 rs->procedures[i].proc=rpc_proc_name(program, version, i);
315                 rs->procedures[i].num=0;
316                 rs->procedures[i].min.secs=0;
317                 rs->procedures[i].min.nsecs=0;
318                 rs->procedures[i].max.secs=0;
319                 rs->procedures[i].max.nsecs=0;
320                 rs->procedures[i].tot.secs=0;
321                 rs->procedures[i].tot.nsecs=0;
322         }
323
324 /* It is possible to create a filter and attach it to the callbacks. Then the
325  * callbacks would only be invoked if the filter matched.
326  * Evaluating filters is expensive and if we can avoid it and not use them
327  * we gain performance.
328  * In this case we do the filtering for protocol and version inside the
329  * callback itself but use whatever filter the user provided.
330  * (Perhaps the user only want the stats for nis+ traffic for certain objects?)
331  *
332  */
333
334         error_string=register_tap_listener("rpc", rs, filter, 0, rpcstat_reset, rpcstat_packet, rpcstat_draw);
335         if(error_string){
336                 /* error, we failed to attach to the tap. clean up */
337                 g_free(rs->procedures);
338                 g_free(rs->filter);
339                 g_free(rs);
340
341                 fprintf(stderr, "tshark: Couldn't register rpc,rtt tap: %s\n",
342                     error_string->str);
343                 g_string_free(error_string, TRUE);
344                 exit(1);
345         }
346 }
347
348
349 void
350 register_tap_listener_rpcstat(void)
351 {
352         register_stat_cmd_arg("rpc,rtt,", rpcstat_init,NULL);
353 }
354