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