From Ian Schorr: capinfo - provides capture file information.
[obnox/wireshark/wip.git] / capinfo.c
1 /* capinfo.c\r
2  * Reports capture file information including # of packets, duration, others\r
3  *\r
4  * Copyright 2004 Ian Schorr\r
5  *\r
6  * $Id: $\r
7  *\r
8  * Ethereal - Network traffic analyzer\r
9  * By Gerald Combs <gerald@ethereal.com>\r
10  * Copyright 1998 Gerald Combs\r
11  *\r
12  * This program is free software; you can redistribute it and/or\r
13  * modify it under the terms of the GNU General Public License\r
14  * as published by the Free Software Foundation; either version 2\r
15  * of the License, or (at your option) any later version.\r
16  *\r
17  * This program is distributed in the hope that it will be useful,\r
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
20  * GNU General Public License for more details.\r
21  *\r
22  * You should have received a copy of the GNU General Public License\r
23  * along with this program; if not, write to the Free Software\r
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
25  */\r
26 \r
27 #ifdef HAVE_CONFIG_H\r
28 #include "config.h"\r
29 #endif\r
30 \r
31 #include <stdio.h>\r
32 #include <stdlib.h>\r
33 #include <glib.h>\r
34 #include <string.h>\r
35 \r
36 #ifdef HAVE_UNISTD_H\r
37 #include <unistd.h>\r
38 #endif\r
39 \r
40 #ifdef HAVE_SYS_TIME_H\r
41 #include <sys/time.h>\r
42 #endif\r
43 \r
44 #include <string.h>\r
45 #include <epan/packet.h>\r
46 #include "wtap.h"\r
47 \r
48 #ifdef NEED_GETOPT_H\r
49 #include "getopt.h"\r
50 #endif\r
51 \r
52 #ifdef HAVE_SYS_STAT_H\r
53 #include <sys/stat.h>\r
54 #endif\r
55 \r
56 \r
57 static gboolean cap_file_type = FALSE;      /* Do not report capture type     */\r
58 static gboolean cap_packet_count = FALSE;   /* Do not produce packet count    */\r
59 static gboolean cap_file_size = FALSE;      /* Do not report file size        */\r
60 static gboolean cap_data_size = FALSE;      /* Do not report packet byte size */\r
61 static gboolean cap_duration = FALSE;       /* Do not report capture duration */\r
62 static gboolean cap_start_time = FALSE;\r
63 static gboolean cap_end_time = FALSE;\r
64 \r
65 static gboolean cap_data_rate_byte = FALSE;\r
66 static gboolean cap_data_rate_bit = FALSE;\r
67 static gboolean cap_packet_size = FALSE;\r
68 \r
69 \r
70 typedef struct _capture_info {\r
71         const char              *filename;\r
72         guint16                 file_type;\r
73         guint64                 filesize;\r
74         guint64                 packet_bytes;\r
75         double                  start_time;\r
76         double                  stop_time;\r
77         guint32                 packet_count;\r
78         gboolean                snap_set;\r
79         guint32                 snaplen;\r
80         gboolean                drops_known;\r
81         guint32                 drop_count;\r
82         \r
83         double                  duration;\r
84         double                  packet_rate;\r
85         double                  packet_size;\r
86         double                  data_rate;              /* in bytes */\r
87 } capture_info;\r
88 \r
89 static double\r
90 secs_usecs(guint32 s, guint32 us)\r
91 {\r
92   return (us / 1000000.0) + (double)s;\r
93 }\r
94 \r
95 static void\r
96 print_stats(capture_info *cf_info)\r
97 {\r
98   gchar                 *file_type_string;\r
99   time_t                start_time_t;\r
100   struct tm             *start_time_tm;\r
101   time_t                stop_time_t;\r
102   struct tm             *stop_time_tm;\r
103 \r
104   /* Build printable strings for various stats */\r
105   file_type_string = wtap_file_type_string(cf_info->file_type);\r
106   start_time_t = (long)cf_info->start_time;\r
107   stop_time_t = (long)cf_info->stop_time;\r
108   start_time_tm = localtime (&start_time_t);\r
109   stop_time_tm = localtime (&stop_time_t);\r
110 \r
111   if (cap_file_type) printf("File Type: %s\n", file_type_string);\r
112   if (cap_packet_count) printf("Number of packets: %u \n", cf_info->packet_count);\r
113   if (cap_file_size) printf("File Size: %" PRIu64 " bytes\n", cf_info->filesize);\r
114   if (cap_data_size) printf("Data Size: %" PRIu64 " bytes\n", cf_info->packet_bytes);\r
115   if (cap_duration) printf("Capture duration: %f seconds\n", cf_info->duration);\r
116   if (cap_start_time) printf("Start time: %s", asctime (start_time_tm));\r
117   if (cap_end_time) printf("End time: %s", asctime (stop_time_tm));\r
118   if (cap_data_rate_byte) printf("Data rate: %.2f bytes/s\n", cf_info->data_rate);\r
119   if (cap_data_rate_bit) printf("Data rate: %.2f bits/s\n", cf_info->data_rate*8);\r
120   if (cap_packet_size) printf("Average packet size: %.2f bytes\n", cf_info->packet_size);\r
121 \r
122 }\r
123 \r
124 static int \r
125 process_cap_file(wtap *wth)\r
126 {\r
127   int                   err;\r
128   gchar                 *err_info;\r
129   struct stat   cf_stat;\r
130   long                  data_offset;\r
131   \r
132   guint32               packet = 0;\r
133   gint64                bytes = 0;\r
134   const struct wtap_pkthdr *phdr;\r
135   capture_info  cf_info;\r
136   double                start_time = 0;\r
137   double                stop_time = 0;\r
138   double                cur_time = 0;\r
139   \r
140   /* Tally up data that we need to parse through the file to find */\r
141   while (wtap_read(wth, &err, &err_info, &data_offset))  {\r
142     phdr = wtap_phdr(wth);\r
143         cur_time = secs_usecs(phdr->ts.tv_sec, phdr->ts.tv_usec);\r
144         if(packet==0) {\r
145           start_time = cur_time;\r
146           stop_time = cur_time;\r
147         }\r
148         if (cur_time < start_time) {\r
149           start_time = cur_time;\r
150         }\r
151         if (cur_time > stop_time) {\r
152           stop_time = cur_time;\r
153         }\r
154         bytes+=phdr->len;\r
155     packet++;\r
156   }\r
157   \r
158   if (err != 0) {\r
159     fprintf(stderr, "Error after reading %i packets\n", packet);\r
160         exit(1);\r
161   }\r
162 \r
163   /* File size */\r
164   if (fstat(wtap_fd(wth), &cf_stat) < 0) {\r
165     wtap_close(wth);\r
166         return 1;\r
167   }\r
168   \r
169   cf_info.filesize = cf_stat.st_size;\r
170   \r
171   /* File Type */\r
172   cf_info.file_type = wtap_file_type(wth);\r
173   \r
174   /* # of packets */\r
175   cf_info.packet_count = packet;\r
176   \r
177   /* File Times */\r
178   cf_info.start_time = start_time;\r
179   cf_info.stop_time = stop_time;\r
180   cf_info.duration = stop_time-start_time;\r
181         \r
182   /* Number of packet bytes */\r
183   cf_info.packet_bytes = bytes;\r
184   \r
185   /* Data rate per second */\r
186   cf_info.data_rate = (double)bytes / (stop_time-start_time);\r
187   \r
188   /* Avg packet size */\r
189   cf_info.packet_size = (double)bytes/packet;\r
190   \r
191   print_stats(&cf_info);\r
192 \r
193 return 0;\r
194 }\r
195 \r
196 static void usage(gboolean is_error)\r
197 {\r
198   FILE *output;\r
199   \r
200   if (!is_error) {\r
201     output = stdout;\r
202         /* XXX - add capinfo header info here */\r
203   }\r
204   else {\r
205     output = stderr;\r
206   }\r
207 \r
208 \r
209   fprintf(output, "Usage: capinfo [-t] [-c] [-s] [-d] [-u] [-a] [-e] [-y]\n");\r
210   fprintf(output, "               [-i] [-z] [-h] <capfile>\n");\r
211   fprintf(output, "  where\t-t display the capture type of <capfile>\n");\r
212   fprintf(output, "       \t-c count the number of packets\n");\r
213   fprintf(output, "       \t-s display the size of the file \n");\r
214   fprintf(output, "       \t-d display the total length of all packets in the file\n");\r
215   fprintf(output, "       \t   (in bytes)\n");\r
216   fprintf(output, "       \t-u display the capture duration (in seconds) \n");\r
217   fprintf(output, "       \t-a display the capture start time\n");\r
218   fprintf(output, "       \t-e display the capture end time\n");\r
219   fprintf(output, "       \t-y display average data rate (in bytes)\n");\r
220   fprintf(output, "       \t-i display average data rate (in bits)\n");\r
221   fprintf(output, "       \t-z display average packet size (in bytes)\n");\r
222   fprintf(output, "       \t-h produces this help listing.\n");\r
223   fprintf(output, "\n      \t    If no data flags are given, default is to display all statistics\n");\r
224 }\r
225 \r
226 int main(int argc, char *argv[])\r
227 {\r
228   wtap *wth;\r
229   int err;\r
230   gchar *err_info;\r
231   extern char *optarg;\r
232   extern int optind;\r
233   int opt;\r
234   int status = 0;\r
235 \r
236   /* Process the options first */\r
237 \r
238   while ((opt = getopt(argc, argv, "tcsduaeyizvh")) !=-1) {\r
239 \r
240     switch (opt) {\r
241 \r
242         case 't':\r
243           cap_file_type = TRUE;\r
244           break;\r
245 \r
246         case 'c':\r
247           cap_packet_count = TRUE;\r
248           break;\r
249 \r
250         case 's':\r
251           cap_file_size = TRUE;\r
252           break;\r
253 \r
254         case 'd':\r
255           cap_data_size = TRUE;\r
256           break;\r
257 \r
258         case 'u':\r
259           cap_duration = TRUE;\r
260           break;\r
261 \r
262         case 'a':\r
263           cap_start_time = TRUE;\r
264           break;\r
265 \r
266         case 'e':\r
267           cap_end_time = TRUE;\r
268           break;\r
269 \r
270         case 'y':\r
271           cap_data_rate_byte = TRUE;\r
272           break;\r
273 \r
274         case 'i':\r
275           cap_data_rate_bit = TRUE;\r
276           break;\r
277 \r
278         case 'z':\r
279           cap_packet_size = TRUE;\r
280           break;\r
281 \r
282     case 'h':\r
283       usage(FALSE);\r
284       exit(1);\r
285       break;\r
286 \r
287     case '?':              /* Bad flag - print usage message */\r
288       usage(TRUE);\r
289       exit(1);\r
290       break;\r
291 \r
292     }\r
293 \r
294   }\r
295 \r
296   if (optind < 2) {\r
297 \r
298     /* If no arguments were given, by default display all statistics */\r
299     cap_file_type = TRUE;      \r
300     cap_packet_count = TRUE;   \r
301     cap_file_size = TRUE;      \r
302     cap_data_size = TRUE;      \r
303     cap_duration = TRUE;       \r
304     cap_start_time = TRUE;\r
305     cap_end_time = TRUE;\r
306 \r
307     cap_data_rate_byte = TRUE;\r
308     cap_data_rate_bit = TRUE;\r
309     cap_packet_size = TRUE;\r
310 \r
311   }\r
312   \r
313   if ((argc - optind) < 1) {\r
314     usage(TRUE);\r
315         exit(1);\r
316   }\r
317   \r
318   wth = wtap_open_offline(argv[optind], &err, &err_info, FALSE);\r
319 \r
320   if (!wth) {\r
321     fprintf(stderr, "editcap: Can't open %s: %s\n", argv[optind],\r
322         wtap_strerror(err));\r
323     switch (err) {\r
324 \r
325     case WTAP_ERR_UNSUPPORTED:\r
326     case WTAP_ERR_UNSUPPORTED_ENCAP:\r
327     case WTAP_ERR_BAD_RECORD:\r
328       fprintf(stderr, "(%s)\n", err_info);\r
329       g_free(err_info);\r
330       break;\r
331     }\r
332     exit(1);\r
333 \r
334   }\r
335 \r
336   status = process_cap_file(wth);\r
337   \r
338   wtap_close(wth);\r
339   return status;\r
340 }\r
341 \r