wiretap: add cleanup routine.
[metze/wireshark/wip.git] / mergecap.c
1 /* Combine dump files, either by appending or by merging by timestamp
2  *
3  * Wireshark - Network traffic analyzer
4  * By Gerald Combs <gerald@wireshark.org>
5  * Copyright 1998 Gerald Combs
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Mergecap written by Scott Renfro <scott@renfro.org> based on
22  * editcap by Richard Sharpe and Guy Harris
23  *
24  */
25
26 #include <config.h>
27
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <errno.h>
31 #include <glib.h>
32
33 #ifdef HAVE_GETOPT_H
34 #include <getopt.h>
35 #endif
36
37 #include <string.h>
38
39 #include <wiretap/wtap.h>
40
41 #ifndef HAVE_GETOPT_LONG
42 #include <wsutil/wsgetopt.h>
43 #endif
44
45 #include <wsutil/clopts_common.h>
46 #include <wsutil/cmdarg_err.h>
47 #include <wsutil/crash_info.h>
48 #include <wsutil/filesystem.h>
49 #include <wsutil/file_util.h>
50 #include <wsutil/privileges.h>
51 #include <wsutil/strnatcmp.h>
52 #include <ws_version_info.h>
53
54 #ifdef HAVE_PLUGINS
55 #include <wsutil/plugins.h>
56 #endif
57
58 #include <wsutil/report_err.h>
59
60 #include <wiretap/merge.h>
61
62 #ifdef _WIN32
63 #include <wsutil/unicode-utils.h>
64 #endif /* _WIN32 */
65
66 /*
67  * Show the usage
68  */
69 static void
70 print_usage(FILE *output)
71 {
72   fprintf(output, "\n");
73   fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
74   fprintf(output, "\n");
75   fprintf(output, "Output:\n");
76   fprintf(output, "  -a                concatenate rather than merge files.\n");
77   fprintf(output, "                    default is to merge based on frame timestamps.\n");
78   fprintf(output, "  -s <snaplen>      truncate packets to <snaplen> bytes of data.\n");
79   fprintf(output, "  -w <outfile>|-    set the output filename to <outfile> or '-' for stdout.\n");
80   fprintf(output, "  -F <capture type> set the output file type; default is pcapng.\n");
81   fprintf(output, "                    an empty \"-F\" option will list the file types.\n");
82   fprintf(output, "  -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.\n");
83   fprintf(output, "                    an empty \"-I\" option will list the merge modes.\n");
84   fprintf(output, "\n");
85   fprintf(output, "Miscellaneous:\n");
86   fprintf(output, "  -h                display this help and exit.\n");
87   fprintf(output, "  -v                verbose output.\n");
88 }
89
90 /*
91  * Report an error in command-line arguments.
92  */
93 static void
94 mergecap_cmdarg_err(const char *fmt, va_list ap)
95 {
96   fprintf(stderr, "mergecap: ");
97   vfprintf(stderr, fmt, ap);
98   fprintf(stderr, "\n");
99 }
100
101 /*
102  * Report additional information for an error in command-line arguments.
103  */
104 static void
105 mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
106 {
107   vfprintf(stderr, fmt, ap);
108   fprintf(stderr, "\n");
109 }
110
111 struct string_elem {
112   const char *sstr;     /* The short string */
113   const char *lstr;     /* The long string */
114 };
115
116 static gint
117 string_compare(gconstpointer a, gconstpointer b)
118 {
119   return strcmp(((const struct string_elem *)a)->sstr,
120                 ((const struct string_elem *)b)->sstr);
121 }
122
123 static void
124 string_elem_print(gpointer data, gpointer not_used _U_)
125 {
126   fprintf(stderr, "    %s - %s\n", ((struct string_elem *)data)->sstr,
127           ((struct string_elem *)data)->lstr);
128 }
129
130 #ifdef HAVE_PLUGINS
131 /*
132  * General errors are reported with an console message in mergecap.
133  */
134 static void
135 failure_message(const char *msg_format, va_list ap)
136 {
137   fprintf(stderr, "mergecap: ");
138   vfprintf(stderr, msg_format, ap);
139   fprintf(stderr, "\n");
140 }
141 #endif
142
143 static void
144 list_capture_types(void) {
145   int i;
146   struct string_elem *captypes;
147   GSList *list = NULL;
148
149   captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
150
151   fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
152   for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
153     if (wtap_dump_can_open(i)) {
154       captypes[i].sstr = wtap_file_type_subtype_short_string(i);
155       captypes[i].lstr = wtap_file_type_subtype_string(i);
156       list = g_slist_insert_sorted(list, &captypes[i], string_compare);
157     }
158   }
159   g_slist_foreach(list, string_elem_print, NULL);
160   g_slist_free(list);
161   g_free(captypes);
162 }
163
164 static void
165 list_idb_merge_modes(void) {
166   int i;
167
168   fprintf(stderr, "mergecap: The available IDB merge modes for the \"-I\" flag are:\n");
169   for (i = 0; i < IDB_MERGE_MODE_MAX; i++) {
170     fprintf(stderr, "    %s\n", merge_idb_merge_mode_to_string(i));
171   }
172 }
173
174 static gboolean
175 merge_callback(merge_event event, int num,
176                const merge_in_file_t in_files[], const guint in_file_count,
177                void *data _U_)
178 {
179   guint i;
180
181   switch (event) {
182
183     case MERGE_EVENT_INPUT_FILES_OPENED:
184       for (i = 0; i < in_file_count; i++) {
185         fprintf(stderr, "mergecap: %s is type %s.\n", in_files[i].filename,
186                 wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
187       }
188       break;
189
190     case MERGE_EVENT_FRAME_TYPE_SELECTED:
191       /* for this event, num = frame_type */
192       if (num == WTAP_ENCAP_PER_PACKET) {
193         /*
194          * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
195          */
196         int first_frame_type, this_frame_type;
197
198         first_frame_type = wtap_file_encap(in_files[0].wth);
199         for (i = 1; i < in_file_count; i++) {
200           this_frame_type = wtap_file_encap(in_files[i].wth);
201           if (first_frame_type != this_frame_type) {
202             fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
203             fprintf(stderr, "          defaulting to WTAP_ENCAP_PER_PACKET\n");
204             fprintf(stderr, "          %s had type %s (%s)\n",
205                     in_files[0].filename,
206                     wtap_encap_string(first_frame_type),
207                     wtap_encap_short_string(first_frame_type));
208             fprintf(stderr, "          %s had type %s (%s)\n",
209                     in_files[i].filename,
210                     wtap_encap_string(this_frame_type),
211                     wtap_encap_short_string(this_frame_type));
212             break;
213           }
214         }
215       }
216       fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
217               wtap_encap_string(num),
218               wtap_encap_short_string(num));
219       break;
220
221     case MERGE_EVENT_READY_TO_MERGE:
222       fprintf(stderr, "mergecap: ready to merge records\n");
223       break;
224
225     case MERGE_EVENT_PACKET_WAS_READ:
226       /* for this event, num = count */
227       fprintf(stderr, "Record: %d\n", num);
228       break;
229
230     case MERGE_EVENT_DONE:
231       fprintf(stderr, "mergecap: merging complete\n");
232       break;
233   }
234
235   /* false = do not stop merging */
236   return FALSE;
237 }
238
239
240 int
241 main(int argc, char *argv[])
242 {
243   GString            *comp_info_str;
244   GString            *runtime_info_str;
245   char               *init_progfile_dir_error;
246   int                 opt;
247   static const struct option long_options[] = {
248       {"help", no_argument, NULL, 'h'},
249       {"version", no_argument, NULL, 'V'},
250       {0, 0, 0, 0 }
251   };
252   gboolean            do_append          = FALSE;
253   gboolean            verbose            = FALSE;
254   int                 in_file_count      = 0;
255   guint32             snaplen            = 0;
256 #ifdef PCAP_NG_DEFAULT
257   int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
258 #else
259   int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
260 #endif
261   int                 err                = 0;
262   gchar              *err_info           = NULL;
263   int                 err_fileno;
264   char               *out_filename       = NULL;
265   merge_result        status             = MERGE_OK;
266   idb_merge_mode      mode               = IDB_MERGE_MODE_MAX;
267   gboolean            use_stdout         = FALSE;
268   merge_progress_callback_t cb;
269
270   cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
271
272 #ifdef _WIN32
273   arg_list_utf_16to8(argc, argv);
274   create_app_running_mutex();
275 #endif /* _WIN32 */
276
277   /* Get the compile-time version information string */
278   comp_info_str = get_compiled_version_info(NULL, NULL);
279
280   /* Get the run-time version information string */
281   runtime_info_str = get_runtime_version_info(NULL);
282
283   /* Add it to the information to be reported on a crash. */
284   ws_add_crash_info("Mergecap (Wireshark) %s\n"
285        "\n"
286        "%s"
287        "\n"
288        "%s",
289     get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
290   g_string_free(comp_info_str, TRUE);
291   g_string_free(runtime_info_str, TRUE);
292
293   /*
294    * Get credential information for later use.
295    */
296   init_process_policies();
297
298   /*
299    * Attempt to get the pathname of the directory containing the
300    * executable file.
301    */
302   init_progfile_dir_error = init_progfile_dir(argv[0], main);
303   if (init_progfile_dir_error != NULL) {
304     fprintf(stderr,
305             "mergecap: Can't get pathname of directory containing the mergecap program: %s.\n",
306             init_progfile_dir_error);
307     g_free(init_progfile_dir_error);
308   }
309
310   wtap_init();
311
312 #ifdef HAVE_PLUGINS
313   init_report_err(failure_message,NULL,NULL,NULL);
314
315   /* Scan for plugins.  This does *not* call their registration routines;
316      that's done later.
317
318      Don't report failures to load plugins because most (non-wiretap)
319      plugins *should* fail to load (because we're not linked against
320      libwireshark and dissector plugins need libwireshark).*/
321   scan_plugins(DONT_REPORT_LOAD_FAILURE);
322
323   /* Register all libwiretap plugin modules. */
324   register_all_wiretap_modules();
325 #endif
326
327   /* Process the options first */
328   while ((opt = getopt_long(argc, argv, "aF:hI:s:vVw:", long_options, NULL)) != -1) {
329
330     switch (opt) {
331     case 'a':
332       do_append = !do_append;
333       break;
334
335     case 'F':
336       file_type = wtap_short_string_to_file_type_subtype(optarg);
337       if (file_type < 0) {
338         fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
339                 optarg);
340         list_capture_types();
341         status = MERGE_ERR_INVALID_OPTION;
342         goto clean_exit;
343       }
344       break;
345
346     case 'h':
347       printf("Mergecap (Wireshark) %s\n"
348              "Merge two or more capture files into one.\n"
349              "See https://www.wireshark.org for more information.\n",
350              get_ws_vcs_version_info());
351       print_usage(stdout);
352       goto clean_exit;
353       break;
354
355     case 'I':
356       mode = merge_string_to_idb_merge_mode(optarg);
357       if (mode == IDB_MERGE_MODE_MAX) {
358         fprintf(stderr, "mergecap: \"%s\" isn't a valid IDB merge mode\n",
359                 optarg);
360         list_idb_merge_modes();
361         status = MERGE_ERR_INVALID_OPTION;
362         goto clean_exit;
363       }
364       break;
365
366     case 's':
367       snaplen = get_nonzero_guint32(optarg, "snapshot length");
368       break;
369
370     case 'v':
371       verbose = TRUE;
372       break;
373
374     case 'V':
375       comp_info_str = get_compiled_version_info(NULL, NULL);
376       runtime_info_str = get_runtime_version_info(NULL);
377       show_version("Mergecap (Wireshark)", comp_info_str, runtime_info_str);
378       g_string_free(comp_info_str, TRUE);
379       g_string_free(runtime_info_str, TRUE);
380       goto clean_exit;
381       break;
382
383     case 'w':
384       out_filename = optarg;
385       break;
386
387     case '?':              /* Bad options if GNU getopt */
388       switch(optopt) {
389       case'F':
390         list_capture_types();
391         break;
392       case'I':
393         list_idb_merge_modes();
394         break;
395       default:
396         print_usage(stderr);
397       }
398       status = MERGE_ERR_INVALID_OPTION;
399       goto clean_exit;
400       break;
401     }
402   }
403
404   cb.callback_func = merge_callback;
405   cb.data = NULL;
406
407   /* check for proper args; at a minimum, must have an output
408    * filename and one input file
409    */
410   in_file_count = argc - optind;
411   if (!out_filename) {
412     fprintf(stderr, "mergecap: an output filename must be set with -w\n");
413     fprintf(stderr, "          run with -h for help\n");
414     status = MERGE_ERR_INVALID_OPTION;
415     goto clean_exit;
416   }
417   if (in_file_count < 1) {
418     fprintf(stderr, "mergecap: No input files were specified\n");
419     return 1;
420   }
421
422   /* setting IDB merge mode must use PCAPNG output */
423   if (mode != IDB_MERGE_MODE_MAX && file_type != WTAP_FILE_TYPE_SUBTYPE_PCAPNG) {
424     fprintf(stderr, "The IDB merge mode can only be used with PCAPNG output format\n");
425     status = MERGE_ERR_INVALID_OPTION;
426     goto clean_exit;
427   }
428
429   /* if they didn't set IDB merge mode, set it to our default */
430   if (mode == IDB_MERGE_MODE_MAX) {
431     mode = IDB_MERGE_MODE_ALL_SAME;
432   }
433
434   /* open the outfile */
435   if (strcmp(out_filename, "-") == 0) {
436     /* merge the files to the standard output */
437     use_stdout = TRUE;
438     status = merge_files_to_stdout(file_type,
439                                    (const char *const *) &argv[optind],
440                                    in_file_count, do_append, mode, snaplen,
441                                    "mergecap", verbose ? &cb : NULL,
442                                    &err, &err_info, &err_fileno);
443   } else {
444     /* merge the files to the outfile */
445     status = merge_files(out_filename, file_type,
446                          (const char *const *) &argv[optind], in_file_count,
447                          do_append, mode, snaplen, "mergecap", verbose ? &cb : NULL,
448                          &err, &err_info, &err_fileno);
449   }
450
451   switch (status) {
452     case MERGE_OK:
453       break;
454
455     case MERGE_USER_ABORTED:
456       /* we don't catch SIGINT/SIGTERM (yet?), so we couldn't have aborted */
457       g_assert(FALSE);
458       break;
459
460     case MERGE_ERR_CANT_OPEN_INFILE:
461       fprintf(stderr, "mergecap: Can't open %s: %s (%s)\n", argv[optind + err_fileno],
462               wtap_strerror(err), err_info ? err_info : "no more information");
463       break;
464
465     case MERGE_ERR_CANT_OPEN_OUTFILE:
466       if (use_stdout) {
467         fprintf(stderr, "mergecap: Can't set up the standard output: %s\n",
468                     wtap_strerror(err));
469       } else {
470         fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
471                     wtap_strerror(err));
472       }
473       break;
474
475     case MERGE_ERR_CANT_READ_INFILE:      /* fall through */
476     case MERGE_ERR_BAD_PHDR_INTERFACE_ID:
477     case MERGE_ERR_CANT_WRITE_OUTFILE:
478     case MERGE_ERR_CANT_CLOSE_OUTFILE:
479     default:
480       fprintf(stderr, "mergecap: %s\n", err_info ? err_info : "unknown error");
481       break;
482   }
483
484   g_free(err_info);
485
486 clean_exit:
487   wtap_cleanup();
488   return (status == MERGE_OK) ? 0 : 2;
489 }
490
491 /*
492  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
493  *
494  * Local variables:
495  * c-basic-offset: 2
496  * tab-width: 8
497  * indent-tabs-mode: nil
498  * End:
499  *
500  * vi: set shiftwidth=2 tabstop=8 expandtab:
501  * :indentSize=2:tabSize=8:noTabs=true:
502  */
503