1 /* Combine dump files, either by appending or by merging by timestamp
3 * Wireshark - Network traffic analyzer
4 * By Gerald Combs <gerald@wireshark.org>
5 * Copyright 1998 Gerald Combs
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.
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.
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.
21 * Mergecap written by Scott Renfro <scott@renfro.org> based on
22 * editcap by Richard Sharpe and Guy Harris
38 #include <zlib.h> /* to get the libz version number */
43 #include <wiretap/wtap.h>
45 #ifndef HAVE_GETOPT_LONG
46 #include <wsutil/wsgetopt.h>
49 #include <wsutil/clopts_common.h>
50 #include <wsutil/cmdarg_err.h>
51 #include <wsutil/crash_info.h>
52 #include <wsutil/file_util.h>
53 #include <wsutil/strnatcmp.h>
54 #include <wsutil/ws_diag_control.h>
55 #include <wsutil/ws_version_info.h>
57 #include <wiretap/merge.h>
58 #include <wiretap/pcap-encap.h>
61 #include <wsutil/unicode-utils.h>
68 print_usage(FILE *output)
70 fprintf(output, "\n");
71 fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
72 fprintf(output, "\n");
73 fprintf(output, "Output:\n");
74 fprintf(output, " -a concatenate rather than merge files.\n");
75 fprintf(output, " default is to merge based on frame timestamps.\n");
76 fprintf(output, " -s <snaplen> truncate packets to <snaplen> bytes of data.\n");
77 fprintf(output, " -w <outfile>|- set the output filename to <outfile> or '-' for stdout.\n");
78 fprintf(output, " -F <capture type> set the output file type; default is pcapng.\n");
79 fprintf(output, " an empty \"-F\" option will list the file types.\n");
80 fprintf(output, " -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.\n");
81 fprintf(output, " an empty \"-I\" option will list the merge modes.\n");
82 fprintf(output, "\n");
83 fprintf(output, "Miscellaneous:\n");
84 fprintf(output, " -h display this help and exit.\n");
85 fprintf(output, " -v verbose output.\n");
89 * Report an error in command-line arguments.
92 mergecap_cmdarg_err(const char *fmt, va_list ap)
94 fprintf(stderr, "mergecap: ");
95 vfprintf(stderr, fmt, ap);
96 fprintf(stderr, "\n");
100 * Report additional information for an error in command-line arguments.
103 mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
105 vfprintf(stderr, fmt, ap);
106 fprintf(stderr, "\n");
110 const char *sstr; /* The short string */
111 const char *lstr; /* The long string */
115 string_compare(gconstpointer a, gconstpointer b)
117 return strcmp(((const struct string_elem *)a)->sstr,
118 ((const struct string_elem *)b)->sstr);
122 string_elem_print(gpointer data, gpointer not_used _U_)
124 fprintf(stderr, " %s - %s\n", ((struct string_elem *)data)->sstr,
125 ((struct string_elem *)data)->lstr);
129 list_capture_types(void) {
131 struct string_elem *captypes;
134 captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
136 fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
137 for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
138 if (wtap_dump_can_open(i)) {
139 captypes[i].sstr = wtap_file_type_subtype_short_string(i);
140 captypes[i].lstr = wtap_file_type_subtype_string(i);
141 list = g_slist_insert_sorted(list, &captypes[i], string_compare);
144 g_slist_foreach(list, string_elem_print, NULL);
150 list_idb_merge_modes(void) {
153 fprintf(stderr, "mergecap: The available IDB merge modes for the \"-I\" flag are:\n");
154 for (i = 0; i < IDB_MERGE_MODE_MAX; i++) {
155 fprintf(stderr, " %s\n", merge_idb_merge_mode_to_string(i));
160 get_mergecap_compiled_info(GString *str)
163 g_string_append(str, ", ");
165 g_string_append(str, "with libz ");
167 g_string_append(str, ZLIB_VERSION);
168 #else /* ZLIB_VERSION */
169 g_string_append(str, "(version unknown)");
170 #endif /* ZLIB_VERSION */
171 #else /* HAVE_LIBZ */
172 g_string_append(str, "without libz");
173 #endif /* HAVE_LIBZ */
177 get_mergecap_runtime_info(GString *str)
180 #if defined(HAVE_LIBZ) && !defined(_WIN32)
181 g_string_append_printf(str, ", with libz %s", zlibVersion());
187 merge_callback(merge_event event, int num,
188 const merge_in_file_t in_files[], const guint in_file_count,
195 case MERGE_EVENT_INPUT_FILES_OPENED:
196 for (i = 0; i < in_file_count; i++) {
197 fprintf(stderr, "mergecap: %s is type %s.\n", in_files[i].filename,
198 wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
202 case MERGE_EVENT_FRAME_TYPE_SELECTED:
203 /* for this event, num = frame_type */
204 if (num == WTAP_ENCAP_PER_PACKET) {
206 * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
208 int first_frame_type, this_frame_type;
210 first_frame_type = wtap_file_encap(in_files[0].wth);
211 for (i = 1; i < in_file_count; i++) {
212 this_frame_type = wtap_file_encap(in_files[i].wth);
213 if (first_frame_type != this_frame_type) {
214 fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
215 fprintf(stderr, " defaulting to WTAP_ENCAP_PER_PACKET\n");
216 fprintf(stderr, " %s had type %s (%s)\n",
217 in_files[0].filename,
218 wtap_encap_string(first_frame_type),
219 wtap_encap_short_string(first_frame_type));
220 fprintf(stderr, " %s had type %s (%s)\n",
221 in_files[i].filename,
222 wtap_encap_string(this_frame_type),
223 wtap_encap_short_string(this_frame_type));
228 fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
229 wtap_encap_string(num),
230 wtap_encap_short_string(num));
233 case MERGE_EVENT_READY_TO_MERGE:
234 fprintf(stderr, "mergecap: ready to merge records\n");
237 case MERGE_EVENT_PACKET_WAS_READ:
238 /* for this event, num = count */
239 fprintf(stderr, "Record: %d\n", num);
242 case MERGE_EVENT_DONE:
243 fprintf(stderr, "mergecap: merging complete\n");
247 /* false = do not stop merging */
253 main(int argc, char *argv[])
255 GString *comp_info_str;
256 GString *runtime_info_str;
258 static const struct option long_options[] = {
259 {"help", no_argument, NULL, 'h'},
260 {"version", no_argument, NULL, 'V'},
263 gboolean do_append = FALSE;
264 gboolean verbose = FALSE;
265 int in_file_count = 0;
267 #ifdef PCAP_NG_DEFAULT
268 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
270 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
274 gchar *err_info = NULL;
276 char *out_filename = NULL;
278 idb_merge_mode mode = IDB_MERGE_MODE_MAX;
279 gboolean use_stdout = FALSE;
280 merge_progress_callback_t cb;
282 cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
285 arg_list_utf_16to8(argc, argv);
286 create_app_running_mutex();
289 /* Get the compile-time version information string */
290 comp_info_str = get_compiled_version_info(NULL, get_mergecap_compiled_info);
292 /* Get the run-time version information string */
293 runtime_info_str = get_runtime_version_info(get_mergecap_runtime_info);
295 /* Add it to the information to be reported on a crash. */
296 ws_add_crash_info("Mergecap (Wireshark) %s\n"
301 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
303 /* Process the options first */
304 while ((opt = getopt_long(argc, argv, "aF:hI:s:vVw:", long_options, NULL)) != -1) {
308 do_append = !do_append;
312 file_type = wtap_short_string_to_file_type_subtype(optarg);
314 fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
316 list_capture_types();
322 printf("Mergecap (Wireshark) %s\n"
323 "Merge two or more capture files into one.\n"
324 "See https://www.wireshark.org for more information.\n",
325 get_ws_vcs_version_info());
331 mode = merge_string_to_idb_merge_mode(optarg);
332 if (mode == IDB_MERGE_MODE_MAX) {
333 fprintf(stderr, "mergecap: \"%s\" isn't a valid IDB merge mode\n",
335 list_idb_merge_modes();
341 snaplen = get_positive_int(optarg, "snapshot length");
349 show_version("Mergecap (Wireshark)", comp_info_str, runtime_info_str);
350 g_string_free(comp_info_str, TRUE);
351 g_string_free(runtime_info_str, TRUE);
356 out_filename = optarg;
359 case '?': /* Bad options if GNU getopt */
362 list_capture_types();
365 list_idb_merge_modes();
375 cb.callback_func = merge_callback;
378 /* check for proper args; at a minimum, must have an output
379 * filename and one input file
381 in_file_count = argc - optind;
383 fprintf(stderr, "mergecap: an output filename must be set with -w\n");
384 fprintf(stderr, " run with -h for help\n");
387 if (in_file_count < 1) {
388 fprintf(stderr, "mergecap: No input files were specified\n");
392 /* setting IDB merge mode must use PCAPNG output */
393 if (mode != IDB_MERGE_MODE_MAX && file_type != WTAP_FILE_TYPE_SUBTYPE_PCAPNG) {
394 fprintf(stderr, "The IDB merge mode can only be used with PCAPNG output format\n");
398 /* if they didn't set IDB merge mode, set it to our default */
399 if (mode == IDB_MERGE_MODE_MAX) {
400 mode = IDB_MERGE_MODE_ALL_SAME;
403 /* open the outfile */
404 if (strncmp(out_filename, "-", 2) == 0) {
405 /* use stdout as the outfile */
407 out_fd = 1 /*stdout*/;
409 /* open the outfile */
410 out_fd = ws_open(out_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
412 fprintf(stderr, "mergecap: Couldn't open output file %s: %s\n",
413 out_filename, g_strerror(errno));
418 /* merge the files */
419 status = merge_files(out_fd, out_filename, file_type,
420 (const char *const *) &argv[optind], in_file_count,
421 do_append, mode, snaplen, "mergecap", verbose ? &cb : NULL,
422 &err, &err_info, &err_fileno);
428 case MERGE_USER_ABORTED:
429 /* we don't catch SIGINT/SIGTERM (yet?), so we couldn't have aborted */
433 case MERGE_ERR_CANT_OPEN_INFILE:
434 fprintf(stderr, "mergecap: Can't open %s: %s (%s)\n", argv[optind + err_fileno],
435 wtap_strerror(err), err_info ? err_info : "no more information");
438 case MERGE_ERR_CANT_OPEN_OUTFILE:
439 fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
445 case MERGE_ERR_CANT_READ_INFILE: /* fall through */
446 case MERGE_ERR_BAD_PHDR_INTERFACE_ID:
447 case MERGE_ERR_CANT_WRITE_OUTFILE:
448 case MERGE_ERR_CANT_CLOSE_OUTFILE:
450 fprintf(stderr, "mergecap: %s\n", err_info ? err_info : "unknown error");
456 return (status == MERGE_OK) ? 0 : 2;
460 * Editor modelines - http://www.wireshark.org/tools/modelines.html
465 * indent-tabs-mode: nil
468 * vi: set shiftwidth=2 tabstop=8 expandtab:
469 * :indentSize=2:tabSize=8:noTabs=true: