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
42 #include <zlib.h> /* to get the libz version number */
48 #ifndef HAVE_GETOPT_LONG
49 #include <wsutil/wsgetopt.h>
52 #include <wsutil/clopts_common.h>
53 #include <wsutil/cmdarg_err.h>
54 #include <wsutil/crash_info.h>
55 #include <wsutil/file_util.h>
56 #include <wsutil/strnatcmp.h>
57 #include <wsutil/ws_diag_control.h>
58 #include <wsutil/ws_version_info.h>
60 #include <wiretap/merge.h>
61 #include <wiretap/pcap-encap.h>
68 #include <wsutil/unicode-utils.h>
75 print_usage(FILE *output)
77 fprintf(output, "\n");
78 fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
79 fprintf(output, "\n");
80 fprintf(output, "Output:\n");
81 fprintf(output, " -a concatenate rather than merge files.\n");
82 fprintf(output, " default is to merge based on frame timestamps.\n");
83 fprintf(output, " -s <snaplen> truncate packets to <snaplen> bytes of data.\n");
84 fprintf(output, " -w <outfile>|- set the output filename to <outfile> or '-' for stdout.\n");
85 fprintf(output, " -F <capture type> set the output file type; default is pcapng.\n");
86 fprintf(output, " an empty \"-F\" option will list the file types.\n");
87 fprintf(output, " -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.\n");
88 fprintf(output, " an empty \"-I\" option will list the merge modes.\n");
89 fprintf(output, "\n");
90 fprintf(output, "Miscellaneous:\n");
91 fprintf(output, " -h display this help and exit.\n");
92 fprintf(output, " -v verbose output.\n");
96 * Report an error in command-line arguments.
99 mergecap_cmdarg_err(const char *fmt, va_list ap)
101 fprintf(stderr, "mergecap: ");
102 vfprintf(stderr, fmt, ap);
103 fprintf(stderr, "\n");
107 * Report additional information for an error in command-line arguments.
110 mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
112 vfprintf(stderr, fmt, ap);
113 fprintf(stderr, "\n");
117 const char *sstr; /* The short string */
118 const char *lstr; /* The long string */
122 string_compare(gconstpointer a, gconstpointer b)
124 return strcmp(((const struct string_elem *)a)->sstr,
125 ((const struct string_elem *)b)->sstr);
129 string_elem_print(gpointer data, gpointer not_used _U_)
131 fprintf(stderr, " %s - %s\n", ((struct string_elem *)data)->sstr,
132 ((struct string_elem *)data)->lstr);
136 list_capture_types(void) {
138 struct string_elem *captypes;
141 captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
143 fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
144 for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
145 if (wtap_dump_can_open(i)) {
146 captypes[i].sstr = wtap_file_type_subtype_short_string(i);
147 captypes[i].lstr = wtap_file_type_subtype_string(i);
148 list = g_slist_insert_sorted(list, &captypes[i], string_compare);
151 g_slist_foreach(list, string_elem_print, NULL);
157 list_idb_merge_modes(void) {
160 fprintf(stderr, "mergecap: The available IDB merge modes for the \"-I\" flag are:\n");
161 for (i = 0; i < IDB_MERGE_MODE_MAX; i++) {
162 fprintf(stderr, " %s\n", merge_idb_merge_mode_to_string(i));
167 get_mergecap_compiled_info(GString *str)
170 g_string_append(str, ", ");
172 g_string_append(str, "with libz ");
174 g_string_append(str, ZLIB_VERSION);
175 #else /* ZLIB_VERSION */
176 g_string_append(str, "(version unknown)");
177 #endif /* ZLIB_VERSION */
178 #else /* HAVE_LIBZ */
179 g_string_append(str, "without libz");
180 #endif /* HAVE_LIBZ */
184 get_mergecap_runtime_info(GString *str)
187 #if defined(HAVE_LIBZ) && !defined(_WIN32)
188 g_string_append_printf(str, ", with libz %s", zlibVersion());
194 merge_callback(merge_event event, int num,
195 const merge_in_file_t in_files[], const guint in_file_count,
202 case MERGE_EVENT_INPUT_FILES_OPENED:
203 for (i = 0; i < in_file_count; i++) {
204 fprintf(stderr, "mergecap: %s is type %s.\n", in_files[i].filename,
205 wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
209 case MERGE_EVENT_FRAME_TYPE_SELECTED:
210 /* for this event, num = frame_type */
211 if (num == WTAP_ENCAP_PER_PACKET) {
213 * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
215 int first_frame_type, this_frame_type;
217 first_frame_type = wtap_file_encap(in_files[0].wth);
218 for (i = 1; i < in_file_count; i++) {
219 this_frame_type = wtap_file_encap(in_files[i].wth);
220 if (first_frame_type != this_frame_type) {
221 fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
222 fprintf(stderr, " defaulting to WTAP_ENCAP_PER_PACKET\n");
223 fprintf(stderr, " %s had type %s (%s)\n",
224 in_files[0].filename,
225 wtap_encap_string(first_frame_type),
226 wtap_encap_short_string(first_frame_type));
227 fprintf(stderr, " %s had type %s (%s)\n",
228 in_files[i].filename,
229 wtap_encap_string(this_frame_type),
230 wtap_encap_short_string(this_frame_type));
235 fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
236 wtap_encap_string(num),
237 wtap_encap_short_string(num));
240 case MERGE_EVENT_READY_TO_MERGE:
241 fprintf(stderr, "mergecap: ready to merge records\n");
244 case MERGE_EVENT_PACKET_WAS_READ:
245 /* for this event, num = count */
246 fprintf(stderr, "Record: %d\n", num);
249 case MERGE_EVENT_DONE:
250 fprintf(stderr, "mergecap: merging complete\n");
254 /* false = do not stop merging */
260 main(int argc, char *argv[])
262 GString *comp_info_str;
263 GString *runtime_info_str;
266 static const struct option long_options[] = {
267 {(char *)"help", no_argument, NULL, 'h'},
268 {(char *)"version", no_argument, NULL, 'V'},
272 gboolean do_append = FALSE;
273 gboolean verbose = FALSE;
274 int in_file_count = 0;
276 #ifdef PCAP_NG_DEFAULT
277 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
279 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
283 gchar *err_info = NULL;
285 char *out_filename = NULL;
287 idb_merge_mode mode = IDB_MERGE_MODE_MAX;
288 gboolean use_stdout = FALSE;
289 merge_progress_callback_t cb;
291 cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
294 arg_list_utf_16to8(argc, argv);
295 create_app_running_mutex();
298 /* Get the compile-time version information string */
299 comp_info_str = get_compiled_version_info(NULL, get_mergecap_compiled_info);
301 /* Get the run-time version information string */
302 runtime_info_str = get_runtime_version_info(get_mergecap_runtime_info);
304 /* Add it to the information to be reported on a crash. */
305 ws_add_crash_info("Mergecap (Wireshark) %s\n"
310 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
312 /* Process the options first */
313 while ((opt = getopt_long(argc, argv, "aF:hI:s:vVw:", long_options, NULL)) != -1) {
317 do_append = !do_append;
321 file_type = wtap_short_string_to_file_type_subtype(optarg);
323 fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
325 list_capture_types();
331 printf("Mergecap (Wireshark) %s\n"
332 "Merge two or more capture files into one.\n"
333 "See http://www.wireshark.org for more information.\n",
334 get_ws_vcs_version_info());
340 mode = merge_string_to_idb_merge_mode(optarg);
341 if (mode == IDB_MERGE_MODE_MAX) {
342 fprintf(stderr, "mergecap: \"%s\" isn't a valid IDB merge mode\n",
344 list_idb_merge_modes();
350 snaplen = get_positive_int(optarg, "snapshot length");
358 show_version("Mergecap (Wireshark)", comp_info_str, runtime_info_str);
359 g_string_free(comp_info_str, TRUE);
360 g_string_free(runtime_info_str, TRUE);
365 out_filename = optarg;
368 case '?': /* Bad options if GNU getopt */
371 list_capture_types();
374 list_idb_merge_modes();
384 cb.callback_func = merge_callback;
387 /* check for proper args; at a minimum, must have an output
388 * filename and one input file
390 in_file_count = argc - optind;
392 fprintf(stderr, "mergecap: an output filename must be set with -w\n");
393 fprintf(stderr, " run with -h for help\n");
396 if (in_file_count < 1) {
397 fprintf(stderr, "mergecap: No input files were specified\n");
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");
407 /* if they didn't set IDB merge mode, set it to our default */
408 if (mode == IDB_MERGE_MODE_MAX) {
409 mode = IDB_MERGE_MODE_ALL_SAME;
412 /* open the outfile */
413 if (strncmp(out_filename, "-", 2) == 0) {
414 /* use stdout as the outfile */
416 out_fd = 1 /*stdout*/;
418 /* open the outfile */
419 out_fd = ws_open(out_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
421 fprintf(stderr, "mergecap: Couldn't open output file %s: %s\n",
422 out_filename, g_strerror(errno));
427 /* merge the files */
428 status = merge_files(out_fd, out_filename, file_type,
429 (const char *const *) &argv[optind], in_file_count,
430 do_append, mode, snaplen, "mergecap", verbose ? &cb : NULL,
431 &err, &err_info, &err_fileno);
437 case MERGE_USER_ABORTED:
438 /* we don't catch SIGINT/SIGTERM (yet?), so we couldn't have aborted */
442 case MERGE_ERR_CANT_OPEN_INFILE:
443 fprintf(stderr, "mergecap: Can't open %s: %s (%s)\n", argv[optind + err_fileno],
444 wtap_strerror(err), err_info ? err_info : "no more information");
447 case MERGE_ERR_CANT_OPEN_OUTFILE:
448 fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
454 case MERGE_ERR_CANT_READ_INFILE: /* fall through */
455 case MERGE_ERR_BAD_PHDR_INTERFACE_ID:
456 case MERGE_ERR_CANT_WRITE_OUTFILE:
457 case MERGE_ERR_CANT_CLOSE_OUTFILE:
459 fprintf(stderr, "mergecap: %s\n", err_info ? err_info : "unknown error");
465 return (status == MERGE_OK) ? 0 : 2;
469 * Editor modelines - http://www.wireshark.org/tools/modelines.html
474 * indent-tabs-mode: nil
477 * vi: set shiftwidth=2 tabstop=8 expandtab:
478 * :indentSize=2:tabSize=8:noTabs=true: