2 * rpcstat 2002 Ronnie Sahlberg
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
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.
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.
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.
25 /* This module provides rpc call/reply RTT statistics to tshark.
26 * It is only used by tshark and not wireshark
28 * It serves as an example on how to use the tap api.
37 #ifdef HAVE_SYS_TYPES_H
38 # include <sys/types.h>
42 #include "epan/packet_info.h"
44 #include <epan/stat_cmd_args.h>
45 #include <epan/dissectors/packet-rpc.h>
48 /* used to keep track of statistics for a specific procedure */
49 typedef struct _rpc_procedure_t {
57 /* used to keep track of the statistics for an entire program interface */
58 typedef struct _rpcstat_t {
63 guint32 num_procedures;
64 rpc_procedure_t *procedures;
69 /* This callback is never used by tshark but it is here for completeness.
70 * When registering below, we could just have left this function as NULL.
72 * When used by wireshark, this function will be called whenever we would need
73 * to reset all state. Such as when wireshark opens a new file, when it
74 * starts a new capture, when it rescans the packetlist after some prefs have
76 * So if your aplication has some state it needs to clean up in those
77 * situations, here is a good place to put that code.
80 rpcstat_reset(void *prs)
85 for(i=0;i<rs->num_procedures;i++){
86 rs->procedures[i].num=0;
87 rs->procedures[i].min.secs=0;
88 rs->procedures[i].min.nsecs=0;
89 rs->procedures[i].max.secs=0;
90 rs->procedures[i].max.nsecs=0;
91 rs->procedures[i].tot.secs=0;
92 rs->procedures[i].tot.nsecs=0;
97 /* This callback is invoked whenever the tap system has seen a packet
98 * we might be interested in.
99 * The function is to be used to only update internal state information
100 * in the *tapdata structure, and if there were state changes which requires
101 * the window to be redrawn, return 1 and (*draw) will be called sometime
104 * This function should be as lightweight as possible since it executes together
105 * with the normal wireshark dissectors. Try to push as much processing as
106 * possible into (*draw) instead since that function executes asynchronously
107 * and does not affect the main threads performance.
109 * If it is possible, try to do all "filtering" explicitely as we do below in
110 * this example since you will get MUCH better performance than applying
111 * a similar display-filter in the register call.
113 * The third parameter is tap dependant. Since we register this one to the "rpc"
114 * tap the third parameters type is rpc_call_info_value.
117 * The filtering we do is just to check the rpc_call_info_value struct that
118 * we were called for the proper program and version. We didnt apply a filter
119 * when we registered so we will be called for ALL rpc packets and not just
120 * the ones we are collecting stats for.
124 * 0: no updates, no need to call (*draw) later
125 * !0: state has changed, call (*draw) sometime later
128 rpcstat_packet(void *prs, packet_info *pinfo, epan_dissect_t *edt _U_, const void *pri)
131 const rpc_call_info_value *ri=pri;
135 if(ri->proc>=rs->num_procedures){
136 /* dont handle this since its outside of known table */
139 /* we are only interested in reply packets */
143 /* we are only interested in certain program/versions */
144 if( (ri->prog!=rs->program) || (ri->vers!=rs->version) ){
148 rp=&(rs->procedures[ri->proc]);
150 /* calculate time delta between request and reply */
151 nstime_delta(&delta, &pinfo->fd->abs_ts, &ri->req_time);
154 rp->max.secs=delta.secs;
155 rp->max.nsecs=delta.nsecs;
159 rp->min.secs=delta.secs;
160 rp->min.nsecs=delta.nsecs;
163 if( (delta.secs<rp->min.secs)
164 ||( (delta.secs==rp->min.secs)
165 &&(delta.nsecs<rp->min.nsecs) ) ){
166 rp->min.secs=delta.secs;
167 rp->min.nsecs=delta.nsecs;
170 if( (delta.secs>rp->max.secs)
171 ||( (delta.secs==rp->max.secs)
172 &&(delta.nsecs>rp->max.nsecs) ) ){
173 rp->max.secs=delta.secs;
174 rp->max.nsecs=delta.nsecs;
177 rp->tot.secs += delta.secs;
178 rp->tot.nsecs += delta.nsecs;
179 if(rp->tot.nsecs>1000000000){
180 rp->tot.nsecs-=1000000000;
189 /* This callback is used when tshark wants us to draw/update our
190 * data to the output device. Since this is tshark only output is
192 * TShark will only call this callback once, which is when tshark has
193 * finished reading all packets and exists.
194 * If used with wireshark this may be called any time, perhaps once every 3
196 * This function may even be called in parallell with (*reset) or (*draw)
197 * so make sure there are no races. The data in the rpcstat_t can thus change
198 * beneath us. Beware.
201 rpcstat_draw(void *prs)
207 printf("===================================================================\n");
208 printf("%s Version %d RTT Statistics:\n", rs->prog, rs->version);
209 printf("Filter: %s\n",rs->filter?rs->filter:"");
210 printf("Procedure Calls Min RTT Max RTT Avg RTT\n");
211 for(i=0;i<rs->num_procedures;i++){
212 /* scale it to units of 10us.*/
213 td=rs->procedures[i].tot.secs;
214 td=td*100000+(int)rs->procedures[i].tot.nsecs/10000;
215 if(rs->procedures[i].num){
216 td/=rs->procedures[i].num;
221 printf("%-15s %6d %3d.%05d %3d.%05d %3" G_GINT64_MODIFIER "u.%05" G_GINT64_MODIFIER "u\n",
222 rs->procedures[i].proc,
223 rs->procedures[i].num,
224 (int)rs->procedures[i].min.secs,rs->procedures[i].min.nsecs/10000,
225 (int)rs->procedures[i].max.secs,rs->procedures[i].max.nsecs/10000,
229 printf("===================================================================\n");
232 static guint32 rpc_program=0;
233 static guint32 rpc_version=0;
234 static gint32 rpc_min_proc=-1;
235 static gint32 rpc_max_proc=-1;
238 rpcstat_find_procs(gpointer *key, gpointer *value _U_, gpointer *user_data _U_)
240 rpc_proc_info_key *k=(rpc_proc_info_key *)key;
242 if(k->prog!=rpc_program){
245 if(k->vers!=rpc_version){
248 if(rpc_min_proc==-1){
249 rpc_min_proc=k->proc;
250 rpc_max_proc=k->proc;
252 if((gint32)k->proc<rpc_min_proc){
253 rpc_min_proc=k->proc;
255 if((gint32)k->proc>rpc_max_proc){
256 rpc_max_proc=k->proc;
263 /* When called, this function will create a new instance of rpcstat.
264 * program and version are whick onc-rpc program/version we want to
265 * collect statistics for.
266 * This function is called from tshark when it parses the -z rpc, arguments
267 * and it creates a new instance to store statistics in and registers this
268 * new instance for the rpc tap.
271 rpcstat_init(const char *optarg, void* userdata _U_)
275 int program, version;
277 const char *filter=NULL;
278 GString *error_string;
280 if(sscanf(optarg,"rpc,rtt,%d,%d,%n",&program,&version,&pos)==2){
287 fprintf(stderr, "tshark: invalid \"-z rpc,rtt,<program>,<version>[,<filter>]\" argument\n");
291 rs=g_malloc(sizeof(rpcstat_t));
292 rs->prog=rpc_prog_name(program);
296 rs->filter=g_strdup(filter);
304 g_hash_table_foreach(rpc_procs, (GHFunc)rpcstat_find_procs, NULL);
305 if(rpc_min_proc==-1){
306 fprintf(stderr,"tshark: Invalid -z rpc,rrt,%d,%d\n",rpc_program,rpc_version);
307 fprintf(stderr," Program:%d version:%d isn't supported by tshark.\n", rpc_program, rpc_version);
312 rs->num_procedures=rpc_max_proc+1;
313 rs->procedures=g_malloc(sizeof(rpc_procedure_t)*(rs->num_procedures+1));
314 for(i=0;i<rs->num_procedures;i++){
315 rs->procedures[i].proc=rpc_proc_name(program, version, i);
316 rs->procedures[i].num=0;
317 rs->procedures[i].min.secs=0;
318 rs->procedures[i].min.nsecs=0;
319 rs->procedures[i].max.secs=0;
320 rs->procedures[i].max.nsecs=0;
321 rs->procedures[i].tot.secs=0;
322 rs->procedures[i].tot.nsecs=0;
325 /* It is possible to create a filter and attach it to the callbacks. Then the
326 * callbacks would only be invoked if the filter matched.
327 * Evaluating filters is expensive and if we can avoid it and not use them
328 * we gain performance.
329 * In this case we do the filtering for protocol and version inside the
330 * callback itself but use whatever filter the user provided.
331 * (Perhaps the user only want the stats for nis+ traffic for certain objects?)
335 error_string=register_tap_listener("rpc", rs, filter, rpcstat_reset, rpcstat_packet, rpcstat_draw);
337 /* error, we failed to attach to the tap. clean up */
338 g_free(rs->procedures);
342 fprintf(stderr, "tshark: Couldn't register rpc,rtt tap: %s\n",
344 g_string_free(error_string, TRUE);
351 register_tap_listener_rpcstat(void)
353 register_stat_cmd_arg("rpc,rtt,", rpcstat_init,NULL);