Trivial reformatting
[obnox/wireshark/wip.git] / gtk / mcast_stream.c
1 /* mcast_stream.c
2  *
3  * Copyright 2006, Iskratel , Slovenia
4  * By Jakob Bratkovic <j.bratkovic@iskratel.si> and
5  * Miha Jemec <m.jemec@iskratel.si>
6  *
7  * $Id$
8  *
9  * based on rtp_stream.c
10  * Copyright 2003, Alcatel Business Systems
11  * By Lars Ruoff <lars.ruoff@gmx.net>
12  *
13  * Wireshark - Network traffic analyzer
14  * By Gerald Combs <gerald@wireshark.org>
15  * Copyright 1998 Gerald Combs
16  *
17  * This program is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU General Public License
19  * as published by the Free Software Foundation; either version 2
20  * of the License, or (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software
29  * Foundation,  Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
30  */
31
32 #ifdef HAVE_CONFIG_H
33 # include "config.h"
34 #endif
35 #ifdef HAVE_FCNTL_H
36 #include <fcntl.h>
37 #endif
38
39 #ifdef HAVE_SYS_TYPES_H
40 # include <sys/types.h>
41 #endif
42
43 #include <stdio.h>
44 #include <time.h>
45 #include <string.h>
46
47 #include <gtk/gtk.h>
48
49 #include <epan/epan.h>
50 #include <epan/packet.h>
51 #include <epan/tap.h>
52 #include <epan/strutil.h>
53
54 #include "../globals.h"
55 #include "../register.h"
56 #include "../alert_box.h"
57 #include "../simple_dialog.h"
58
59 #include "gtk/mcast_stream.h"
60 #include "gtk/mcast_stream_dlg.h"
61 #include "gtk/main.h"
62
63 #ifdef HAVE_WINSOCK2_H
64 #include <winsock2.h>
65 #endif
66
67 gint32 trigger=50; /* limit for triggering the burst alarm (in packets per second) */
68 gint32 bufferalarm = 10000; /* limit for triggernig the buffer alarm (in bytes) */
69 guint16 burstint = 100; /* burts interval in ms */
70 gint32 emptyspeed = 5000; /* outgoing speed for single stream (kbps)*/
71 gint32 cumulemptyspeed = 100000; /* outgoiong speed for all streams (kbps)*/
72
73 t_buffer **bufflist;
74
75 /* sliding window and buffer usage */
76 gint32 buffsize = (int)((double)MAX_SPEED * 100 / 1000) * 2;
77 guint16 comparetimes(struct timeval *t1, struct timeval *t2, guint16 burstint);
78 static void buffusagecalc(mcast_stream_info_t *strinfo, packet_info *pinfo, double emptyspeed);
79 static void slidingwindow(mcast_stream_info_t *strinfo, packet_info *pinfo);
80
81
82 /****************************************************************************/
83 /* the one and only global mcaststream_tapinfo_t structure */
84 static mcaststream_tapinfo_t the_tapinfo_struct =
85         {0, NULL, 0, NULL, 0, FALSE};
86
87
88 /****************************************************************************/
89 /* GCompareFunc style comparison function for _mcast_stream_info */
90 static gint mcast_stream_info_cmp(gconstpointer aa, gconstpointer bb)
91 {
92         const struct _mcast_stream_info* a = aa;
93         const struct _mcast_stream_info* b = bb;
94
95         if (a==b)
96                 return 0;
97         if (a==NULL || b==NULL)
98                 return 1;
99         if (ADDRESSES_EQUAL(&(a->src_addr), &(b->src_addr))
100                 && (a->src_port == b->src_port)
101                 && ADDRESSES_EQUAL(&(a->dest_addr), &(b->dest_addr))
102                 && (a->dest_port == b->dest_port))
103                 return 0;
104         else
105                 return 1;
106
107 }
108
109
110 /****************************************************************************/
111 /* when there is a [re]reading of packet's */
112 void mcaststream_reset(mcaststream_tapinfo_t *tapinfo)
113 {
114         GList* list;
115
116         /* free the data items first */
117         list = g_list_first(tapinfo->strinfo_list);
118         while (list)
119         {
120                 /* XYZ I don't know how to clean this */
121                 /*g_free(list->element.buff); */
122                 g_free(list->data);
123                 list = g_list_next(list);
124         }
125         g_list_free(tapinfo->strinfo_list);
126         tapinfo->strinfo_list = NULL;
127
128         /* XYZ and why does the line below causes a crach? */
129         /*g_free(tapinfo->allstreams->element.buff);*/
130         g_free(tapinfo->allstreams);
131         tapinfo->allstreams = NULL;
132
133         tapinfo->nstreams = 0;
134         tapinfo->npackets = 0;
135
136         ++(tapinfo->launch_count);
137
138         return;
139 }
140
141 static void mcaststream_reset_cb(void *arg)
142 {
143         mcaststream_reset(arg);
144 }
145
146 /****************************************************************************/
147 /* redraw the output */
148 static void mcaststream_draw(void *arg _U_)
149 {
150 /* XXX: see mcaststream_on_update in mcast_streams_dlg.c for comments
151         g_signal_emit_by_name(top_level, "signal_mcaststream_update");
152 */
153         mcaststream_dlg_update(the_tapinfo_struct.strinfo_list);
154         return;
155 }
156
157
158
159 /****************************************************************************/
160 /* whenever a udp packet is seen by the tap listener */
161 static int mcaststream_packet(void *arg, packet_info *pinfo, epan_dissect_t *edt _U_, const void *arg2 _U_)
162 {
163         mcaststream_tapinfo_t *tapinfo = arg;
164         mcast_stream_info_t tmp_strinfo;
165         mcast_stream_info_t *strinfo = NULL;
166         GList* list;
167         float deltatime;
168
169         /* gather infos on the stream this packet is part of */
170         COPY_ADDRESS(&(tmp_strinfo.src_addr), &(pinfo->src));
171         tmp_strinfo.src_port = pinfo->srcport;
172         COPY_ADDRESS(&(tmp_strinfo.dest_addr), &(pinfo->dst));
173         tmp_strinfo.dest_port = pinfo->destport;
174
175         /* first we ignore non multicast packets; we filter out only those ethernet packets
176          * which start with the 01:00:5E multicast address (for IPv4) and 33:33 multicast
177          * address (for IPv6).
178          */
179         if ((pinfo->dl_dst.type != AT_ETHER) ||
180             ((strncmp("01005E", bytes_to_str(pinfo->dl_dst.data, pinfo->dl_dst.len), 6) != 0) &&
181              (strncmp("3333", bytes_to_str(pinfo->dl_dst.data, pinfo->dl_dst.len), 4) != 0)) )
182                 return 0;
183
184         /* check whether we already have a stream with these parameters in the list */
185         list = g_list_first(tapinfo->strinfo_list);
186         while (list)
187         {
188                 if (mcast_stream_info_cmp(&tmp_strinfo, (mcast_stream_info_t*)(list->data))==0)
189                 {
190                         strinfo = (mcast_stream_info_t*)(list->data);  /*found!*/
191                         break;
192                 }
193                 list = g_list_next(list);
194         }
195
196         /* not in the list? then create a new entry */
197         if (!strinfo) {
198                 /*printf("nov sip %s sp %d dip %s dp %d\n", g_strdup(get_addr_name(&(pinfo->src))),
199                         pinfo->srcport, g_strdup(get_addr_name(&(pinfo->dst))), pinfo->destport);*/
200                 tmp_strinfo.npackets = 0;
201                 tmp_strinfo.apackets = 0;
202                 tmp_strinfo.first_frame_num = pinfo->fd->num;
203                 tmp_strinfo.start_sec = (guint32) pinfo->fd->abs_ts.secs;
204                 tmp_strinfo.start_usec = pinfo->fd->abs_ts.nsecs/1000;
205                 tmp_strinfo.start_rel_sec = (guint32) pinfo->fd->rel_ts.secs;
206                 tmp_strinfo.start_rel_usec = pinfo->fd->rel_ts.nsecs/1000;
207                 tmp_strinfo.vlan_id = 0;
208
209                 /* reset Mcast stats */
210                 tmp_strinfo.average_bw = 0;
211                 tmp_strinfo.total_bytes = 0;
212
213                 /* reset slidingwindow and buffer parameters */
214                 tmp_strinfo.element.buff = (struct timeval *)g_malloc(buffsize * sizeof(struct timeval));
215                 tmp_strinfo.element.first=0;
216                 tmp_strinfo.element.last=0;
217                 tmp_strinfo.element.burstsize=1;
218                 tmp_strinfo.element.topburstsize=1;
219                 tmp_strinfo.element.numbursts=0;
220                 tmp_strinfo.element.burststatus=0;
221                 tmp_strinfo.element.count=1;
222                 tmp_strinfo.element.buffusage=pinfo->fd->pkt_len;
223                 tmp_strinfo.element.topbuffusage=pinfo->fd->pkt_len;
224                 tmp_strinfo.element.numbuffalarms=0;
225                 tmp_strinfo.element.buffstatus=0;
226                 tmp_strinfo.element.maxbw=0;
227
228                 strinfo = g_malloc(sizeof(mcast_stream_info_t));
229                 *strinfo = tmp_strinfo;  /* memberwise copy of struct */
230                 tapinfo->strinfo_list = g_list_append(tapinfo->strinfo_list, strinfo);
231                 strinfo->element.buff = (struct timeval *)g_malloc(buffsize * sizeof(struct timeval));
232
233                 /* set time with the first packet */
234                 if (tapinfo->npackets == 0) {
235                         tapinfo->allstreams = g_malloc(sizeof(mcast_stream_info_t));
236                         tapinfo->allstreams->element.buff =
237                                         (struct timeval *)g_malloc(buffsize * sizeof(struct timeval));
238                         tapinfo->allstreams->start_rel_sec = (guint32) pinfo->fd->rel_ts.secs;
239                         tapinfo->allstreams->start_rel_usec = pinfo->fd->rel_ts.nsecs/1000;
240                         tapinfo->allstreams->total_bytes = 0;
241                         tapinfo->allstreams->element.first=0;
242                         tapinfo->allstreams->element.last=0;
243                         tapinfo->allstreams->element.burstsize=1;
244                         tapinfo->allstreams->element.topburstsize=1;
245                         tapinfo->allstreams->element.numbursts=0;
246                         tapinfo->allstreams->element.burststatus=0;
247                         tapinfo->allstreams->element.count=1;
248                         tapinfo->allstreams->element.buffusage=pinfo->fd->pkt_len;
249                         tapinfo->allstreams->element.topbuffusage=pinfo->fd->pkt_len;
250                         tapinfo->allstreams->element.numbuffalarms=0;
251                         tapinfo->allstreams->element.buffstatus=0;
252                         tapinfo->allstreams->element.maxbw=0;
253                 }
254         }
255
256         /* time between first and last packet in the group */
257         strinfo->stop_rel_sec = (guint32) pinfo->fd->rel_ts.secs;
258         strinfo->stop_rel_usec = pinfo->fd->rel_ts.nsecs/1000;
259         deltatime = ((float)((strinfo->stop_rel_sec * 1000000 + strinfo->stop_rel_usec)
260                                         - (strinfo->start_rel_sec*1000000 + strinfo->start_rel_usec)))/1000000;
261
262         /* calculate average bandwidth for this stream */
263         strinfo->total_bytes = strinfo->total_bytes + pinfo->fd->pkt_len;
264         if (deltatime > 0)
265                 strinfo->average_bw = (((float)(strinfo->total_bytes*8) / deltatime) / 1000000);
266
267         /* increment the packets counter for this stream and calculate average pps */
268         ++(strinfo->npackets);
269         strinfo->apackets = (guint32) (strinfo->npackets / deltatime);
270
271         /* time between first and last packet in any group */
272         tapinfo->allstreams->stop_rel_sec = (guint32) pinfo->fd->rel_ts.secs;
273         tapinfo->allstreams->stop_rel_usec = pinfo->fd->rel_ts.nsecs/1000;
274         deltatime = ((float)((tapinfo->allstreams->stop_rel_sec * 1000000 + tapinfo->allstreams->stop_rel_usec)
275                 - (tapinfo->allstreams->start_rel_sec*1000000 + tapinfo->allstreams->start_rel_usec)))/1000000;
276
277         /* increment the packets counter of all streams */
278         ++(tapinfo->npackets);
279
280         /* calculate average bandwidth for all streams */
281         tapinfo->allstreams->total_bytes = tapinfo->allstreams->total_bytes + pinfo->fd->pkt_len;
282         if (deltatime > 0)
283                 tapinfo->allstreams->average_bw = (((float)(tapinfo->allstreams->total_bytes *8) / deltatime) / 1000000);
284
285         /* sliding window and buffercalc for this group*/
286         slidingwindow(strinfo, pinfo);
287         buffusagecalc(strinfo, pinfo, emptyspeed*1000);
288         /* sliding window and buffercalc for all groups */
289         slidingwindow(tapinfo->allstreams, pinfo);
290         buffusagecalc(tapinfo->allstreams, pinfo, cumulemptyspeed*1000);
291         /* end of sliding window */
292
293         return 1;  /* refresh output */
294
295 }
296
297 /****************************************************************************/
298 /* scan for Mcast streams */
299 void mcaststream_scan(void)
300 {
301         gboolean was_registered = the_tapinfo_struct.is_registered;
302         if (!the_tapinfo_struct.is_registered)
303                 register_tap_listener_mcast_stream();
304
305         cf_retap_packets(&cfile);
306
307         if (!was_registered)
308                 remove_tap_listener_mcast_stream();
309 }
310
311
312 /****************************************************************************/
313 const mcaststream_tapinfo_t* mcaststream_get_info(void)
314 {
315         return &the_tapinfo_struct;
316 }
317
318
319 /****************************************************************************/
320 /* TAP INTERFACE */
321 /****************************************************************************/
322
323 /****************************************************************************/
324 void
325 remove_tap_listener_mcast_stream(void)
326 {
327         if (the_tapinfo_struct.is_registered) {
328                 protect_thread_critical_region();
329                 remove_tap_listener(&the_tapinfo_struct);
330                 unprotect_thread_critical_region();
331
332                 the_tapinfo_struct.is_registered = FALSE;
333         }
334 }
335
336
337 /****************************************************************************/
338 void
339 register_tap_listener_mcast_stream(void)
340 {
341         GString *error_string;
342         if (!the_tapinfo_struct.is_registered) {
343                 error_string = register_tap_listener("udp", &the_tapinfo_struct,
344                         NULL, 0, mcaststream_reset_cb, mcaststream_packet,
345                         mcaststream_draw);
346
347                 if (error_string != NULL) {
348                         simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
349                                       "%s", error_string->str);
350                         g_string_free(error_string, TRUE);
351                         exit(1);
352                 }
353
354                 the_tapinfo_struct.is_registered = TRUE;
355         }
356 }
357
358 /*******************************************************************************/
359 /* sliding window and buffer calculations */
360
361 /* compare two times */
362 guint16 comparetimes(struct timeval *t1, struct timeval *t2, guint16 burstint_lcl){
363     if(((t2->tv_sec - t1->tv_sec)*1000 + (t2->tv_usec - t1->tv_usec)/1000) > burstint_lcl){
364         return 1;
365     } else{
366         return 0;
367     }
368 }
369
370 /* calculate buffer usage */
371 void buffusagecalc(mcast_stream_info_t *strinfo, packet_info *pinfo, double emptyspeed_lcl)
372 {
373     gint32 sec=0, usec=0, cur, prev;
374     struct timeval *buffer;
375     double timeelapsed;
376
377     buffer = strinfo->element.buff;
378     cur = strinfo->element.last;
379     if(cur == 0){
380         cur = buffsize - 1;
381         prev = cur - 1;
382     } else if(cur == 1){
383         prev = buffsize - 1;
384         cur = 0;
385     } else{
386         cur=cur-1;
387         prev=cur-1;
388     }
389
390     sec = buffer[cur].tv_sec - buffer[prev].tv_sec;
391     usec = buffer[cur].tv_usec - buffer[prev].tv_usec;
392     timeelapsed = (double)usec/1000000 + (double)sec;
393
394     /* bytes added to buffer */
395     strinfo->element.buffusage+=pinfo->fd->pkt_len;
396
397     /* bytes cleared from buffer */
398     strinfo->element.buffusage-= (guint32) (timeelapsed * emptyspeed_lcl / 8);
399
400     if(strinfo->element.buffusage < 0) strinfo->element.buffusage=0;
401     if(strinfo->element.buffusage > strinfo->element.topbuffusage)
402                                 strinfo->element.topbuffusage = strinfo->element.buffusage;
403     /* check for buffer losses */
404     if((strinfo->element.buffusage >= bufferalarm) && (strinfo->element.buffstatus == 0)){
405         strinfo->element.buffstatus = 1;
406         strinfo->element.numbuffalarms++;
407     } else if(strinfo->element.buffusage < bufferalarm){
408         strinfo->element.buffstatus = 0;
409     }
410
411     return;
412 }
413
414 /* sliding window calculation */
415 void slidingwindow(mcast_stream_info_t *strinfo, packet_info *pinfo)
416 {
417     struct timeval *buffer;
418     gint32 diff;
419
420     buffer = strinfo->element.buff;
421
422     diff = strinfo->element.last - strinfo->element.first;
423     if(diff < 0) diff+=buffsize;
424
425     /* check if buffer is full */
426     if(diff >= (buffsize - 2)){
427         fprintf(stderr, "Warning: capture buffer full\n");
428         strinfo->element.first++;
429         if(strinfo->element.first >= buffsize) strinfo->element.first = strinfo->element.first % buffsize;
430     }
431
432     /* burst count */
433     buffer[strinfo->element.last].tv_sec = (guint32) pinfo->fd->rel_ts.secs;
434     buffer[strinfo->element.last].tv_usec = pinfo->fd->rel_ts.nsecs/1000;
435     while(comparetimes((struct timeval *)&(buffer[strinfo->element.first]),
436                                                 (struct timeval *)&(buffer[strinfo->element.last]), burstint)){
437         strinfo->element.first++;
438         if(strinfo->element.first >= buffsize) strinfo->element.first = strinfo->element.first % buffsize;
439         diff--;
440     }
441     strinfo->element.burstsize = diff;
442     if(strinfo->element.burstsize > strinfo->element.topburstsize) {
443         strinfo->element.topburstsize = strinfo->element.burstsize;
444         strinfo->element.maxbw = (float)(strinfo->element.topburstsize) * 1000 / burstint * pinfo->fd->pkt_len * 8 / 1000000;
445     }
446
447     strinfo->element.last++;
448     if(strinfo->element.last >= buffsize) strinfo->element.last = strinfo->element.last % buffsize;
449     /* trigger check */
450     if((strinfo->element.burstsize >= trigger) && (strinfo->element.burststatus == 0)){
451         strinfo->element.burststatus = 1;
452         strinfo->element.numbursts++;
453     } else if(strinfo->element.burstsize < trigger){
454         strinfo->element.burststatus = 0;
455     }
456
457     strinfo->element.count++;
458 }
459