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