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