3 * Text-mode variant of Fileshark, based off of TShark,
5 * Wireshark - Network traffic analyzer
6 * By Gerald Combs <gerald@wireshark.org>
7 * Copyright 1998 Gerald Combs
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
38 #ifndef HAVE_GETOPT_LONG
39 #include "wsutil/wsgetopt.h"
44 #include <epan/exceptions.h>
45 #include <epan/epan-int.h>
46 #include <epan/epan.h>
48 #include <wsutil/clopts_common.h>
49 #include <wsutil/cmdarg_err.h>
50 #include <wsutil/crash_info.h>
51 #include <wsutil/filesystem.h>
52 #include <wsutil/file_util.h>
53 #include <wsutil/privileges.h>
54 #include <wsutil/report_err.h>
55 #include <ws_version_info.h>
58 #include <epan/timestamp.h>
59 #include <epan/packet.h>
61 #include <epan/wslua/init_wslua.h>
64 #include "frame_tvbuff.h"
65 #include <epan/disabled_protos.h>
66 #include <epan/prefs.h>
67 #include <epan/column.h>
68 #include <epan/print.h>
69 #include <epan/addr_resolv.h>
72 #include <epan/epan_dissect.h>
74 #include <epan/stat_tap_ui.h>
75 #include <epan/ex-opt.h>
77 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
78 #include <epan/asn1.h>
79 #include <epan/dissectors/packet-kerberos.h>
82 #include <wiretap/wtap-int.h>
83 #include <wiretap/file_wrappers.h>
86 #include <wsutil/unicode-utils.h>
90 #include <epan/funnel.h>
93 #include <wsutil/plugins.h>
97 * This is the template for the decode as option; it is shared between the
98 * various functions that output the usage for this parameter.
100 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
102 static guint32 cum_bytes;
103 static const frame_data *ref;
104 static frame_data ref_frame;
105 static frame_data *prev_dis;
106 static frame_data prev_dis_frame;
107 static frame_data *prev_cap;
108 static frame_data prev_cap_frame;
110 static const char* prev_display_dissector_name = NULL;
112 static gboolean perform_two_pass_analysis;
115 * The way the packet decode is to be written.
118 WRITE_TEXT, /* summary or detail text */
119 WRITE_XML, /* PDML or PSML */
120 WRITE_FIELDS /* User defined list of fields */
121 /* Add CSV and the like here */
124 static output_action_e output_action;
125 static gboolean do_dissection; /* TRUE if we have to dissect each packet */
126 static gboolean print_packet_info; /* TRUE if we're to print packet information */
127 static gint print_summary = -1; /* TRUE if we're to print packet summary information */
128 static gboolean print_details; /* TRUE if we're to print packet details information */
129 static gboolean print_hex; /* TRUE if we're to print hex/ascci information */
130 static gboolean line_buffered;
131 static gboolean really_quiet = FALSE;
133 static print_format_e print_format = PR_FMT_TEXT;
134 static print_stream_t *print_stream;
136 static output_fields_t* output_fields = NULL;
138 /* The line separator used between packets, changeable via the -S option */
139 static const char *separator = "";
141 static int load_cap_file(capture_file *, int, gint64);
142 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
143 struct wtap_pkthdr *whdr, const guchar *pd, guint tap_flags);
144 static void show_print_file_io_error(int err);
145 static gboolean write_preamble(capture_file *cf);
146 static gboolean print_packet(capture_file *cf, epan_dissect_t *edt);
147 static gboolean write_finale(void);
148 static const char *cf_open_error_message(int err, gchar *err_info,
149 gboolean for_writing, int file_type);
151 static void open_failure_message(const char *filename, int err,
152 gboolean for_writing);
153 static void failure_message(const char *msg_format, va_list ap);
154 static void read_failure_message(const char *filename, int err);
155 static void write_failure_message(const char *filename, int err);
156 static void failure_message_cont(const char *msg_format, va_list ap);
160 static GHashTable *output_only_tables = NULL;
164 const char *sstr; /* The short string */
165 const char *lstr; /* The long string */
169 string_compare(gconstpointer a, gconstpointer b)
171 return strcmp(((const struct string_elem *)a)->sstr,
172 ((const struct string_elem *)b)->sstr);
176 string_elem_print(gpointer data, gpointer not_used _U_)
178 fprintf(stderr, " %s - %s\n",
179 ((struct string_elem *)data)->sstr,
180 ((struct string_elem *)data)->lstr);
185 print_usage(FILE *output)
187 fprintf(output, "\n");
188 fprintf(output, "Usage: tfshark [options] ...\n");
189 fprintf(output, "\n");
191 /*fprintf(output, "\n");*/
192 fprintf(output, "Input file:\n");
193 fprintf(output, " -r <infile> set the filename to read from (no pipes or stdin!)\n");
195 fprintf(output, "\n");
196 fprintf(output, "Processing:\n");
197 fprintf(output, " -2 perform a two-pass analysis\n");
198 fprintf(output, " -R <read filter> packet Read filter in Wireshark display filter syntax\n");
199 fprintf(output, " -Y <display filter> packet displaY filter in Wireshark display filter\n");
200 fprintf(output, " syntax\n");
201 fprintf(output, " -d %s ...\n", decode_as_arg_template);
202 fprintf(output, " \"Decode As\", see the man page for details\n");
203 fprintf(output, " Example: tcp.port==8888,http\n");
205 /*fprintf(output, "\n");*/
206 fprintf(output, "Output:\n");
207 fprintf(output, " -C <config profile> start with specified configuration profile\n");
208 fprintf(output, " -V add output of packet tree (Packet Details)\n");
209 fprintf(output, " -O <protocols> Only show packet details of these protocols, comma\n");
210 fprintf(output, " separated\n");
211 fprintf(output, " -S <separator> the line separator to print between packets\n");
212 fprintf(output, " -x add output of hex and ASCII dump (Packet Bytes)\n");
213 fprintf(output, " -T pdml|ps|psml|text|fields\n");
214 fprintf(output, " format of text output (def: text)\n");
215 fprintf(output, " -e <field> field to print if -Tfields selected (e.g. tcp.port,\n");
216 fprintf(output, " _ws.col.Info)\n");
217 fprintf(output, " this option can be repeated to print multiple fields\n");
218 fprintf(output, " -E<fieldsoption>=<value> set options for output when -Tfields selected:\n");
219 fprintf(output, " header=y|n switch headers on and off\n");
220 fprintf(output, " separator=/t|/s|<char> select tab, space, printable character as separator\n");
221 fprintf(output, " occurrence=f|l|a print first, last or all occurrences of each field\n");
222 fprintf(output, " aggregator=,|/s|<char> select comma, space, printable character as\n");
223 fprintf(output, " aggregator\n");
224 fprintf(output, " quote=d|s|n select double, single, no quotes for values\n");
225 fprintf(output, " -t a|ad|d|dd|e|r|u|ud output format of time stamps (def: r: rel. to first)\n");
226 fprintf(output, " -u s|hms output format of seconds (def: s: seconds)\n");
227 fprintf(output, " -l flush standard output after each packet\n");
228 fprintf(output, " -q be more quiet on stdout (e.g. when using statistics)\n");
229 fprintf(output, " -Q only log true errors to stderr (quieter than -q)\n");
230 fprintf(output, " -X <key>:<value> eXtension options, see the man page for details\n");
231 fprintf(output, " -z <statistics> various statistics, see the man page for details\n");
233 fprintf(output, "\n");
234 fprintf(output, "Miscellaneous:\n");
235 fprintf(output, " -h display this help and exit\n");
236 fprintf(output, " -v display version info and exit\n");
237 fprintf(output, " -o <name>:<value> ... override preference setting\n");
238 fprintf(output, " -K <keytab> keytab file to use for kerberos decryption\n");
239 fprintf(output, " -G [report] dump one of several available reports and exit\n");
240 fprintf(output, " default report=\"fields\"\n");
241 fprintf(output, " use \"-G ?\" for more help\n");
245 glossary_option_help(void)
251 fprintf(output, "TFShark (Wireshark) %s\n", get_ws_vcs_version_info());
253 fprintf(output, "\n");
254 fprintf(output, "Usage: tfshark -G [report]\n");
255 fprintf(output, "\n");
256 fprintf(output, "Glossary table reports:\n");
257 fprintf(output, " -G column-formats dump column format codes and exit\n");
258 fprintf(output, " -G decodes dump \"layer type\"/\"decode as\" associations and exit\n");
259 fprintf(output, " -G dissector-tables dump dissector table names, types, and properties\n");
260 fprintf(output, " -G fields dump fields glossary and exit\n");
261 fprintf(output, " -G ftypes dump field type basic and descriptive names\n");
262 fprintf(output, " -G heuristic-decodes dump heuristic dissector tables\n");
263 fprintf(output, " -G plugins dump installed plugins and exit\n");
264 fprintf(output, " -G protocols dump protocols in registration database and exit\n");
265 fprintf(output, " -G values dump value, range, true/false strings and exit\n");
266 fprintf(output, "\n");
267 fprintf(output, "Preference reports:\n");
268 fprintf(output, " -G currentprefs dump current preferences and exit\n");
269 fprintf(output, " -G defaultprefs dump default preferences and exit\n");
270 fprintf(output, "\n");
274 * For a dissector table, print on the stream described by output,
275 * its short name (which is what's used in the "-d" option) and its
279 display_dissector_table_names(const char *table_name, const char *ui_name,
282 if ((prev_display_dissector_name == NULL) ||
283 (strcmp(prev_display_dissector_name, table_name) != 0)) {
284 fprintf((FILE *)output, "\t%s (%s)\n", table_name, ui_name);
285 prev_display_dissector_name = table_name;
290 * For a dissector handle, print on the stream described by output,
291 * the filter name (which is what's used in the "-d" option) and the full
292 * name for the protocol that corresponds to this handle.
295 display_dissector_names(const gchar *table _U_, gpointer handle, gpointer output)
298 const gchar *proto_filter_name;
299 const gchar *proto_ui_name;
301 proto_id = dissector_handle_get_protocol_index((dissector_handle_t)handle);
303 if (proto_id != -1) {
304 proto_filter_name = proto_get_protocol_filter_name(proto_id);
305 proto_ui_name = proto_get_protocol_name(proto_id);
306 g_assert(proto_filter_name != NULL);
307 g_assert(proto_ui_name != NULL);
309 if ((prev_display_dissector_name == NULL) ||
310 (strcmp(prev_display_dissector_name, proto_filter_name) != 0)) {
311 fprintf((FILE *)output, "\t%s (%s)\n",
314 prev_display_dissector_name = proto_filter_name;
320 * The protocol_name_search structure is used by find_protocol_name_func()
321 * to pass parameters and store results
323 struct protocol_name_search{
324 gchar *searched_name; /* Protocol filter name we are looking for */
325 dissector_handle_t matched_handle; /* Handle for a dissector whose protocol has the specified filter name */
326 guint nb_match; /* How many dissectors matched searched_name */
328 typedef struct protocol_name_search *protocol_name_search_t;
331 * This function parses all dissectors associated with a table to find the
332 * one whose protocol has the specified filter name. It is called
333 * as a reference function in a call to dissector_table_foreach_handle.
334 * The name we are looking for, as well as the results, are stored in the
335 * protocol_name_search struct pointed to by user_data.
336 * If called using dissector_table_foreach_handle, we actually parse the
337 * whole list of dissectors.
340 find_protocol_name_func(const gchar *table _U_, gpointer handle, gpointer user_data)
344 const gchar *protocol_filter_name;
345 protocol_name_search_t search_info;
349 search_info = (protocol_name_search_t)user_data;
351 proto_id = dissector_handle_get_protocol_index((dissector_handle_t)handle);
352 if (proto_id != -1) {
353 protocol_filter_name = proto_get_protocol_filter_name(proto_id);
354 g_assert(protocol_filter_name != NULL);
355 if (strcmp(protocol_filter_name, search_info->searched_name) == 0) {
357 if (search_info->nb_match == 0) {
358 /* Record this handle only if this is the first match */
359 search_info->matched_handle = (dissector_handle_t)handle; /* Record the handle for this matching dissector */
361 search_info->nb_match++;
367 * Allow dissector key names to be sorted alphabetically
371 compare_dissector_key_name(gconstpointer dissector_a, gconstpointer dissector_b)
373 return strcmp((const char*)dissector_a, (const char*)dissector_b);
377 * Print all layer type names supported.
378 * We send the output to the stream described by the handle output.
382 fprint_all_layer_types(FILE *output)
385 prev_display_dissector_name = NULL;
386 dissector_all_tables_foreach_table(display_dissector_table_names, (gpointer)output, (GCompareFunc)compare_dissector_key_name);
390 * Print all protocol names supported for a specific layer type.
391 * table_name contains the layer type name in which the search is performed.
392 * We send the output to the stream described by the handle output.
396 fprint_all_protocols_for_layer_types(FILE *output, gchar *table_name)
399 prev_display_dissector_name = NULL;
400 dissector_table_foreach_handle(table_name,
401 display_dissector_names,
406 * The function below parses the command-line parameters for the decode as
407 * feature (a string pointer by cl_param).
408 * It checks the format of the command-line, searches for a matching table
409 * and dissector. If a table/dissector match is not found, we display a
410 * summary of the available tables/dissectors (on stderr) and return FALSE.
411 * If everything is fine, we get the "Decode as" preference activated,
412 * then we return TRUE.
415 add_decode_as(const gchar *cl_param)
418 guint32 selector, selector2;
419 gchar *decoded_param;
420 gchar *remaining_param;
422 gchar *dissector_str;
423 dissector_handle_t dissector_matching;
424 dissector_table_t table_matching;
425 ftenum_t dissector_table_selector_type;
426 struct protocol_name_search user_protocol_name;
430 /* The following code will allocate and copy the command-line options in a string pointed by decoded_param */
433 decoded_param = g_strdup(cl_param);
434 g_assert(decoded_param);
437 /* The lines below will parse this string (modifying it) to extract all
438 necessary information. Note that decoded_param is still needed since
439 strings are not copied - we just save pointers. */
441 /* This section extracts a layer type (table_name) from decoded_param */
442 table_name = decoded_param; /* Layer type string starts from beginning */
444 remaining_param = strchr(table_name, '=');
445 if (remaining_param == NULL) {
446 cmdarg_err("Parameter \"%s\" doesn't follow the template \"%s\"", cl_param, decode_as_arg_template);
447 /* If the argument does not follow the template, carry on anyway to check
448 if the table name is at least correct. If remaining_param is NULL,
449 we'll exit anyway further down */
452 *remaining_param = '\0'; /* Terminate the layer type string (table_name) where '=' was detected */
455 /* Remove leading and trailing spaces from the table name */
456 while ( table_name[0] == ' ' )
458 while ( table_name[strlen(table_name) - 1] == ' ' )
459 table_name[strlen(table_name) - 1] = '\0'; /* Note: if empty string, while loop will eventually exit */
461 /* The following part searches a table matching with the layer type specified */
462 table_matching = NULL;
464 /* Look for the requested table */
465 if ( !(*(table_name)) ) { /* Is the table name empty, if so, don't even search for anything, display a message */
466 cmdarg_err("No layer type specified"); /* Note, we don't exit here, but table_matching will remain NULL, so we exit below */
469 table_matching = find_dissector_table(table_name);
470 if (!table_matching) {
471 cmdarg_err("Unknown layer type -- %s", table_name); /* Note, we don't exit here, but table_matching will remain NULL, so we exit below */
475 if (!table_matching) {
476 /* Display a list of supported layer types to help the user, if the
477 specified layer type was not found */
478 cmdarg_err("Valid layer types are:");
479 fprint_all_layer_types(stderr);
481 if (remaining_param == NULL || !table_matching) {
482 /* Exit if the layer type was not found, or if no '=' separator was found
484 g_free(decoded_param);
488 if (*(remaining_param + 1) != '=') { /* Check for "==" and not only '=' */
489 cmdarg_err("WARNING: -d requires \"==\" instead of \"=\". Option will be treated as \"%s==%s\"", table_name, remaining_param + 1);
492 remaining_param++; /* Move to the second '=' */
493 *remaining_param = '\0'; /* Remove the second '=' */
495 remaining_param++; /* Position after the layer type string */
497 /* This section extracts a selector value (selector_str) from decoded_param */
499 selector_str = remaining_param; /* Next part starts with the selector number */
501 remaining_param = strchr(selector_str, ',');
502 if (remaining_param == NULL) {
503 cmdarg_err("Parameter \"%s\" doesn't follow the template \"%s\"", cl_param, decode_as_arg_template);
504 /* If the argument does not follow the template, carry on anyway to check
505 if the selector value is at least correct. If remaining_param is NULL,
506 we'll exit anyway further down */
509 *remaining_param = '\0'; /* Terminate the selector number string (selector_str) where ',' was detected */
512 dissector_table_selector_type = get_dissector_table_selector_type(table_name);
514 switch (dissector_table_selector_type) {
520 /* The selector for this table is an unsigned number. Parse it as such.
521 There's no need to remove leading and trailing spaces from the
522 selector number string, because sscanf will do that for us. */
523 switch (sscanf(selector_str, "%u%c%u", &selector, &op, &selector2)) {
528 if (op != ':' && op != '-') {
529 cmdarg_err("Invalid selector numeric range \"%s\"", selector_str);
530 g_free(decoded_param);
534 if ((selector2 == 0) || ((guint64)selector + selector2 - 1) > G_MAXUINT32) {
535 cmdarg_err("Invalid selector numeric range \"%s\"", selector_str);
536 g_free(decoded_param);
540 else if (selector2 < selector) {
541 /* We could swap them for the user, but maybe it's better to call
542 * this out as an error in case it's not what was intended? */
543 cmdarg_err("Invalid selector numeric range \"%s\"", selector_str);
544 g_free(decoded_param);
549 cmdarg_err("Invalid selector number \"%s\"", selector_str);
550 g_free(decoded_param);
559 /* The selector for this table is a string. */
563 /* There are currently no dissector tables with any types other
564 than the ones listed above. */
565 g_assert_not_reached();
568 if (remaining_param == NULL) {
569 /* Exit if no ',' separator was found (see above) */
570 cmdarg_err("Valid protocols for layer type \"%s\" are:", table_name);
571 fprint_all_protocols_for_layer_types(stderr, table_name);
572 g_free(decoded_param);
576 remaining_param++; /* Position after the selector number string */
578 /* This section extracts a protocol filter name (dissector_str) from decoded_param */
580 dissector_str = remaining_param; /* All the rest of the string is the dissector (decode as protocol) name */
582 /* Remove leading and trailing spaces from the dissector name */
583 while ( dissector_str[0] == ' ' )
585 while ( dissector_str[strlen(dissector_str) - 1] == ' ' )
586 dissector_str[strlen(dissector_str) - 1] = '\0'; /* Note: if empty string, while loop will eventually exit */
588 dissector_matching = NULL;
590 /* We now have a pointer to the handle for the requested table inside the variable table_matching */
591 if ( ! (*dissector_str) ) { /* Is the dissector name empty, if so, don't even search for a matching dissector and display all dissectors found for the selected table */
592 cmdarg_err("No protocol name specified"); /* Note, we don't exit here, but dissector_matching will remain NULL, so we exit below */
595 user_protocol_name.nb_match = 0;
596 user_protocol_name.searched_name = dissector_str;
597 user_protocol_name.matched_handle = NULL;
599 dissector_table_foreach_handle(table_name, find_protocol_name_func, &user_protocol_name); /* Go and perform the search for this dissector in the this table's dissectors' names and shortnames */
601 if (user_protocol_name.nb_match != 0) {
602 dissector_matching = user_protocol_name.matched_handle;
603 if (user_protocol_name.nb_match > 1) {
604 cmdarg_err("WARNING: Protocol \"%s\" matched %u dissectors, first one will be used", dissector_str, user_protocol_name.nb_match);
608 /* OK, check whether the problem is that there isn't any such
609 protocol, or that there is but it's not specified as a protocol
610 that's valid for that dissector table.
611 Note, we don't exit here, but dissector_matching will remain NULL,
613 if (proto_get_id_by_filter_name(dissector_str) == -1) {
614 /* No such protocol */
615 cmdarg_err("Unknown protocol -- \"%s\"", dissector_str);
617 cmdarg_err("Protocol \"%s\" isn't valid for layer type \"%s\"",
618 dissector_str, table_name);
623 if (!dissector_matching) {
624 cmdarg_err("Valid protocols for layer type \"%s\" are:", table_name);
625 fprint_all_protocols_for_layer_types(stderr, table_name);
626 g_free(decoded_param);
630 /* This is the end of the code that parses the command-line options.
631 All information is now stored in the variables:
635 The above variables that are strings are still pointing to areas within
636 decoded_parm. decoded_parm thus still needs to be kept allocated in
637 until we stop needing these variables
638 decoded_param will be deallocated at each exit point of this function */
641 /* We now have a pointer to the handle for the requested dissector
642 (requested protocol) inside the variable dissector_matching */
643 switch (dissector_table_selector_type) {
649 /* The selector for this table is an unsigned number. */
651 dissector_change_uint(table_name, selector, dissector_matching);
652 } else if (op == ':') {
653 for (i = selector; i < (guint64)selector + selector2; i++) {
654 dissector_change_uint(table_name, (guint32)i, dissector_matching);
656 } else { /* op == '-' */
657 for (i = selector; i <= selector2; i++) {
658 dissector_change_uint(table_name, (guint32)i, dissector_matching);
667 /* The selector for this table is a string. */
668 dissector_change_string(table_name, selector_str, dissector_matching);
672 /* There are currently no dissector tables with any types other
673 than the ones listed above. */
674 g_assert_not_reached();
676 g_free(decoded_param); /* "Decode As" rule has been successfully added */
681 tfshark_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
682 const gchar *message, gpointer user_data)
684 /* ignore log message, if log_level isn't interesting based
685 upon the console log preferences.
686 If the preferences haven't been loaded loaded yet, display the
689 The default console_log_level preference value is such that only
690 ERROR, CRITICAL and WARNING level messages are processed;
691 MESSAGE, INFO and DEBUG level messages are ignored.
693 XXX: Aug 07, 2009: Prior tshark g_log code was hardwired to process only
694 ERROR and CRITICAL level messages so the current code is a behavioral
695 change. The current behavior is the same as in Wireshark.
697 if ((log_level & G_LOG_LEVEL_MASK & prefs.console_log_level) == 0 &&
698 prefs.console_log_level != 0) {
702 g_log_default_handler(log_domain, log_level, message, user_data);
707 print_current_user(void) {
708 gchar *cur_user, *cur_group;
710 if (started_with_special_privs()) {
711 cur_user = get_cur_username();
712 cur_group = get_cur_groupname();
713 fprintf(stderr, "Running as user \"%s\" and group \"%s\".",
714 cur_user, cur_group);
717 if (running_with_special_privs()) {
718 fprintf(stderr, " This could be dangerous.");
720 fprintf(stderr, "\n");
725 get_tfshark_runtime_version_info(GString *str)
727 /* stuff used by libwireshark */
728 epan_get_runtime_version_info(str);
732 main(int argc, char *argv[])
734 GString *comp_info_str;
735 GString *runtime_info_str;
736 char *init_progfile_dir_error;
738 static const struct option long_options[] = {
739 {"help", no_argument, NULL, 'h'},
740 {"version", no_argument, NULL, 'v'},
743 gboolean arg_error = FALSE;
745 char *gpf_path, *pf_path;
746 char *gdp_path, *dp_path;
747 int gpf_open_errno, gpf_read_errno;
748 int pf_open_errno, pf_read_errno;
749 int gdp_open_errno, gdp_read_errno;
750 int dp_open_errno, dp_read_errno;
752 volatile int exit_status = 0;
753 gboolean quiet = FALSE;
754 gchar *volatile cf_name = NULL;
755 gchar *rfilter = NULL;
756 gchar *dfilter = NULL;
757 dfilter_t *rfcode = NULL;
758 dfilter_t *dfcode = NULL;
762 gchar *output_only = NULL;
765 * The leading + ensures that getopt_long() does not permute the argv[]
768 * We have to make sure that the first getopt_long() preserves the content
769 * of argv[] for the subsequent getopt_long() call.
771 * We use getopt_long() in both cases to ensure that we're using a routine
772 * whose permutation behavior we can control in the same fashion on all
773 * platforms, and so that, if we ever need to process a long argument before
774 * doing further initialization, we can do so.
776 * Glibc and Solaris libc document that a leading + disables permutation
777 * of options, regardless of whether POSIXLY_CORRECT is set or not; *BSD
778 * and OS X don't document it, but do so anyway.
780 * We do *not* use a leading - because the behavior of a leading - is
781 * platform-dependent.
783 #define OPTSTRING "+2C:d:e:E:hK:lo:O:qQr:R:S:t:T:u:vVxX:Y:z:"
785 static const char optstring[] = OPTSTRING;
787 /* Set the C-language locale to the native environment. */
788 setlocale(LC_ALL, "");
790 cmdarg_err_init(failure_message, failure_message_cont);
793 arg_list_utf_16to8(argc, argv);
794 create_app_running_mutex();
795 #if !GLIB_CHECK_VERSION(2,31,0)
801 * Get credential information for later use, and drop privileges
802 * before doing anything else.
803 * Let the user know if anything happened.
805 init_process_policies();
806 relinquish_special_privs_perm();
807 print_current_user();
810 * Attempt to get the pathname of the executable file.
812 init_progfile_dir_error = init_progfile_dir(argv[0], main);
813 if (init_progfile_dir_error != NULL) {
814 fprintf(stderr, "tfshark: Can't get pathname of tfshark program: %s.\n",
815 init_progfile_dir_error);
818 initialize_funnel_ops();
820 /* Get the compile-time version information string */
821 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
823 /* Get the run-time version information string */
824 runtime_info_str = get_runtime_version_info(get_tfshark_runtime_version_info);
826 /* Add it to the information to be reported on a crash. */
827 ws_add_crash_info("TFShark (Wireshark) %s\n"
832 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
835 * In order to have the -X opts assigned before the wslua machine starts
836 * we need to call getopts before epan_init() gets called.
838 * In order to handle, for example, -o options, we also need to call it
839 * *after* epan_init() gets called, so that the dissectors have had a
840 * chance to register their preferences.
842 * XXX - can we do this all with one getopt_long() call, saving the
843 * arguments we can't handle until after initializing libwireshark,
844 * and then process them after initializing libwireshark?
848 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
850 case 'C': /* Configuration Profile */
851 if (profile_exists (optarg, FALSE)) {
852 set_profile_name (optarg);
854 cmdarg_err("Configuration Profile \"%s\" does not exist", optarg);
858 case 'O': /* Only output these protocols */
859 output_only = g_strdup(optarg);
861 case 'V': /* Verbose */
862 print_details = TRUE;
863 print_packet_info = TRUE;
865 case 'x': /* Print packet data in hex (and ASCII) */
867 /* The user asked for hex output, so let's ensure they get it,
868 * even if they're writing to a file.
870 print_packet_info = TRUE;
881 * Print packet summary information is the default, unless either -V or -x
882 * were specified. Note that this is new behavior, which
883 * allows for the possibility of printing only hex/ascii output without
884 * necessarily requiring that either the summary or details be printed too.
886 if (print_summary == -1)
887 print_summary = (print_details || print_hex) ? FALSE : TRUE;
889 /** Send All g_log messages to our own handler **/
893 G_LOG_LEVEL_CRITICAL|
898 G_LOG_FLAG_FATAL|G_LOG_FLAG_RECURSION;
900 g_log_set_handler(NULL,
901 (GLogLevelFlags)log_flags,
902 tfshark_log_handler, NULL /* user_data */);
903 g_log_set_handler(LOG_DOMAIN_MAIN,
904 (GLogLevelFlags)log_flags,
905 tfshark_log_handler, NULL /* user_data */);
907 init_report_err(failure_message, open_failure_message, read_failure_message,
908 write_failure_message);
910 timestamp_set_type(TS_RELATIVE);
911 timestamp_set_precision(TS_PREC_AUTO);
912 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
914 init_open_routines();
917 /* Register all the plugin types we have. */
918 epan_register_plugin_types(); /* Types known to libwireshark */
920 /* Scan for plugins. This does *not* call their registration routines;
921 that's done later. */
926 /* Register all dissectors; we must do this before checking for the
927 "-G" flag, as the "-G" flag dumps information registered by the
928 dissectors, and we must do it before we read the preferences, in
929 case any dissectors register preferences. */
930 if (!epan_init(register_all_protocols, register_all_protocol_handoffs, NULL,
934 /* Register all tap listeners; we do this before we parse the arguments,
935 as the "-z" argument can specify a registered tap. */
937 /* we register the plugin taps before the other taps because
938 stats_tree taps plugins will be registered as tap listeners
939 by stats_tree_stat.c and need to registered before that */
941 /* XXX Disable tap registration for now until we can get tfshark set up with
942 * its own set of taps and the necessary registration function etc.
944 register_all_plugin_tap_listeners();
946 register_all_tap_listeners();
949 /* If invoked with the "-G" flag, we dump out information based on
950 the argument to the "-G" flag; if no argument is specified,
951 for backwards compatibility we dump out a glossary of display
954 XXX - we do this here, for now, to support "-G" with no arguments.
955 If none of our build or other processes uses "-G" with no arguments,
956 we can just process it with the other arguments. */
957 if (argc >= 2 && strcmp(argv[1], "-G") == 0) {
958 proto_initialize_all_prefixes();
961 proto_registrar_dump_fields();
963 if (strcmp(argv[2], "column-formats") == 0)
964 column_dump_column_formats();
965 else if (strcmp(argv[2], "currentprefs") == 0) {
966 read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
967 &pf_open_errno, &pf_read_errno, &pf_path);
970 else if (strcmp(argv[2], "decodes") == 0)
971 dissector_dump_decodes();
972 else if (strcmp(argv[2], "defaultprefs") == 0)
974 else if (strcmp(argv[2], "dissector-tables") == 0)
975 dissector_dump_dissector_tables();
976 else if (strcmp(argv[2], "fields") == 0)
977 proto_registrar_dump_fields();
978 else if (strcmp(argv[2], "ftypes") == 0)
979 proto_registrar_dump_ftypes();
980 else if (strcmp(argv[2], "heuristic-decodes") == 0)
981 dissector_dump_heur_decodes();
982 else if (strcmp(argv[2], "plugins") == 0) {
987 wslua_plugins_dump_all();
990 else if (strcmp(argv[2], "protocols") == 0)
991 proto_registrar_dump_protocols();
992 else if (strcmp(argv[2], "values") == 0)
993 proto_registrar_dump_values();
994 else if (strcmp(argv[2], "?") == 0)
995 glossary_option_help();
996 else if (strcmp(argv[2], "-?") == 0)
997 glossary_option_help();
999 cmdarg_err("Invalid \"%s\" option for -G flag, enter -G ? for more help.", argv[2]);
1006 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
1007 &pf_open_errno, &pf_read_errno, &pf_path);
1008 if (gpf_path != NULL) {
1009 if (gpf_open_errno != 0) {
1010 cmdarg_err("Can't open global preferences file \"%s\": %s.",
1011 pf_path, g_strerror(gpf_open_errno));
1013 if (gpf_read_errno != 0) {
1014 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
1015 pf_path, g_strerror(gpf_read_errno));
1018 if (pf_path != NULL) {
1019 if (pf_open_errno != 0) {
1020 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
1021 g_strerror(pf_open_errno));
1023 if (pf_read_errno != 0) {
1024 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
1025 pf_path, g_strerror(pf_read_errno));
1031 /* Read the disabled protocols file. */
1032 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
1033 &dp_path, &dp_open_errno, &dp_read_errno);
1034 read_disabled_heur_dissector_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
1035 &dp_path, &dp_open_errno, &dp_read_errno);
1036 if (gdp_path != NULL) {
1037 if (gdp_open_errno != 0) {
1038 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
1039 gdp_path, g_strerror(gdp_open_errno));
1041 if (gdp_read_errno != 0) {
1042 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
1043 gdp_path, g_strerror(gdp_read_errno));
1047 if (dp_path != NULL) {
1048 if (dp_open_errno != 0) {
1050 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
1051 g_strerror(dp_open_errno));
1053 if (dp_read_errno != 0) {
1055 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
1056 g_strerror(dp_read_errno));
1061 cap_file_init(&cfile);
1063 /* Print format defaults to this. */
1064 print_format = PR_FMT_TEXT;
1066 output_fields = output_fields_new();
1069 * To reset the options parser, set optreset to 1 on platforms that
1070 * have optreset (documented in *BSD and OS X, apparently present but
1071 * not documented in Solaris - the Illumos repository seems to
1072 * suggest that the first Solaris getopt_long(), at least as of 2004,
1073 * was based on the NetBSD one, it had optreset) and set optind to 1,
1074 * and set optind to 0 otherwise (documented as working in the GNU
1075 * getopt_long(). Setting optind to 0 didn't originally work in the
1076 * NetBSD one, but that was added later - we don't want to depend on
1077 * it if we have optreset).
1079 * Also reset opterr to 1, so that error messages are printed by
1082 #ifdef HAVE_OPTRESET
1090 /* Now get our args */
1091 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
1093 case '2': /* Perform two pass analysis */
1094 perform_two_pass_analysis = TRUE;
1097 /* already processed; just ignore it now */
1099 case 'd': /* Decode as rule */
1100 if (!add_decode_as(optarg))
1103 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
1104 case 'K': /* Kerberos keytab file */
1105 read_keytab_file(optarg);
1110 output_fields_add(output_fields, optarg);
1114 if (!output_fields_set_option(output_fields, optarg)) {
1115 cmdarg_err("\"%s\" is not a valid field output option=value pair.", optarg);
1116 output_fields_list_options(stderr);
1121 case 'h': /* Print help and exit */
1122 printf("TFShark (Wireshark) %s\n"
1123 "Dump and analyze network traffic.\n"
1124 "See https://www.wireshark.org for more information.\n",
1125 get_ws_vcs_version_info());
1126 print_usage(stdout);
1129 case 'l': /* "Line-buffer" standard output */
1130 /* This isn't line-buffering, strictly speaking, it's just
1131 flushing the standard output after the information for
1132 each packet is printed; however, that should be good
1133 enough for all the purposes to which "-l" is put (and
1134 is probably actually better for "-V", as it does fewer
1137 See the comment in "process_packet()" for an explanation of
1138 why we do that, and why we don't just use "setvbuf()" to
1139 make the standard output line-buffered (short version: in
1140 Windows, "line-buffered" is the same as "fully-buffered",
1141 and the output buffer is only flushed when it fills up). */
1142 line_buffered = TRUE;
1144 case 'o': /* Override preference from command line */
1145 switch (prefs_set_pref(optarg)) {
1150 case PREFS_SET_SYNTAX_ERR:
1151 cmdarg_err("Invalid -o flag \"%s\"", optarg);
1155 case PREFS_SET_NO_SUCH_PREF:
1156 case PREFS_SET_OBSOLETE:
1157 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
1162 case 'q': /* Quiet */
1165 case 'Q': /* Really quiet */
1167 really_quiet = TRUE;
1169 case 'r': /* Read capture file x */
1170 cf_name = g_strdup(optarg);
1172 case 'R': /* Read file filter */
1175 case 'S': /* Set the line Separator to be printed between packets */
1176 separator = g_strdup(optarg);
1178 case 't': /* Time stamp type */
1179 if (strcmp(optarg, "r") == 0)
1180 timestamp_set_type(TS_RELATIVE);
1181 else if (strcmp(optarg, "a") == 0)
1182 timestamp_set_type(TS_ABSOLUTE);
1183 else if (strcmp(optarg, "ad") == 0)
1184 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
1185 else if (strcmp(optarg, "adoy") == 0)
1186 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
1187 else if (strcmp(optarg, "d") == 0)
1188 timestamp_set_type(TS_DELTA);
1189 else if (strcmp(optarg, "dd") == 0)
1190 timestamp_set_type(TS_DELTA_DIS);
1191 else if (strcmp(optarg, "e") == 0)
1192 timestamp_set_type(TS_EPOCH);
1193 else if (strcmp(optarg, "u") == 0)
1194 timestamp_set_type(TS_UTC);
1195 else if (strcmp(optarg, "ud") == 0)
1196 timestamp_set_type(TS_UTC_WITH_YMD);
1197 else if (strcmp(optarg, "udoy") == 0)
1198 timestamp_set_type(TS_UTC_WITH_YDOY);
1200 cmdarg_err("Invalid time stamp type \"%s\"; it must be one of:", optarg);
1201 cmdarg_err_cont("\t\"a\" for absolute\n"
1202 "\t\"ad\" for absolute with YYYY-MM-DD date\n"
1203 "\t\"adoy\" for absolute with YYYY/DOY date\n"
1204 "\t\"d\" for delta\n"
1205 "\t\"dd\" for delta displayed\n"
1206 "\t\"e\" for epoch\n"
1207 "\t\"r\" for relative\n"
1208 "\t\"u\" for absolute UTC\n"
1209 "\t\"ud\" for absolute UTC with YYYY-MM-DD date\n"
1210 "\t\"udoy\" for absolute UTC with YYYY/DOY date");
1214 case 'T': /* printing Type */
1215 if (strcmp(optarg, "text") == 0) {
1216 output_action = WRITE_TEXT;
1217 print_format = PR_FMT_TEXT;
1218 } else if (strcmp(optarg, "ps") == 0) {
1219 output_action = WRITE_TEXT;
1220 print_format = PR_FMT_PS;
1221 } else if (strcmp(optarg, "pdml") == 0) {
1222 output_action = WRITE_XML;
1223 print_details = TRUE; /* Need details */
1224 print_summary = FALSE; /* Don't allow summary */
1225 } else if (strcmp(optarg, "psml") == 0) {
1226 output_action = WRITE_XML;
1227 print_details = FALSE; /* Don't allow details */
1228 print_summary = TRUE; /* Need summary */
1229 } else if (strcmp(optarg, "fields") == 0) {
1230 output_action = WRITE_FIELDS;
1231 print_details = TRUE; /* Need full tree info */
1232 print_summary = FALSE; /* Don't allow summary */
1234 cmdarg_err("Invalid -T parameter \"%s\"; it must be one of:", optarg); /* x */
1235 cmdarg_err_cont("\t\"fields\" The values of fields specified with the -e option, in a form\n"
1236 "\t specified by the -E option.\n"
1237 "\t\"pdml\" Packet Details Markup Language, an XML-based format for the\n"
1238 "\t details of a decoded packet. This information is equivalent to\n"
1239 "\t the packet details printed with the -V flag.\n"
1240 "\t\"ps\" PostScript for a human-readable one-line summary of each of\n"
1241 "\t the packets, or a multi-line view of the details of each of\n"
1242 "\t the packets, depending on whether the -V flag was specified.\n"
1243 "\t\"psml\" Packet Summary Markup Language, an XML-based format for the\n"
1244 "\t summary information of a decoded packet. This information is\n"
1245 "\t equivalent to the information shown in the one-line summary\n"
1246 "\t printed by default.\n"
1247 "\t\"text\" Text of a human-readable one-line summary of each of the\n"
1248 "\t packets, or a multi-line view of the details of each of the\n"
1249 "\t packets, depending on whether the -V flag was specified.\n"
1250 "\t This is the default.");
1254 case 'u': /* Seconds type */
1255 if (strcmp(optarg, "s") == 0)
1256 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
1257 else if (strcmp(optarg, "hms") == 0)
1258 timestamp_set_seconds_type(TS_SECONDS_HOUR_MIN_SEC);
1260 cmdarg_err("Invalid seconds type \"%s\"; it must be one of:", optarg);
1261 cmdarg_err_cont("\t\"s\" for seconds\n"
1262 "\t\"hms\" for hours, minutes and seconds");
1266 case 'v': /* Show version and exit */
1268 show_version("TFShark (Wireshark)", comp_info_str, runtime_info_str);
1269 g_string_free(comp_info_str, TRUE);
1270 g_string_free(runtime_info_str, TRUE);
1271 /* We don't really have to cleanup here, but it's a convenient way to test
1272 * start-up and shut-down of the epan library without any UI-specific
1273 * cruft getting in the way. Makes the results of running
1274 * $ ./tools/valgrind-wireshark -n
1275 * much more useful. */
1279 case 'O': /* Only output these protocols */
1280 /* already processed; just ignore it now */
1282 case 'V': /* Verbose */
1283 /* already processed; just ignore it now */
1285 case 'x': /* Print packet data in hex (and ASCII) */
1286 /* already processed; just ignore it now */
1289 /* already processed; just ignore it now */
1295 /* We won't call the init function for the stat this soon
1296 as it would disallow MATE's fields (which are registered
1297 by the preferences set callback) from being used as
1298 part of a tap filter. Instead, we just add the argument
1299 to a list of stat arguments. */
1300 if (strcmp("help", optarg) == 0) {
1301 fprintf(stderr, "tfshark: The available statistics for the \"-z\" option are:\n");
1302 list_stat_cmd_args();
1305 if (!process_stat_cmd_arg(optarg)) {
1306 cmdarg_err("Invalid -z argument \"%s\"; it must be one of:", optarg);
1307 list_stat_cmd_args();
1312 case '?': /* Bad flag - print usage message */
1313 print_usage(stderr);
1319 /* If we specified output fields, but not the output field type... */
1320 if (WRITE_FIELDS != output_action && 0 != output_fields_num_fields(output_fields)) {
1321 cmdarg_err("Output fields were specified with \"-e\", "
1322 "but \"-Tfields\" was not specified.");
1324 } else if (WRITE_FIELDS == output_action && 0 == output_fields_num_fields(output_fields)) {
1325 cmdarg_err("\"-Tfields\" was specified, but no fields were "
1326 "specified with \"-e\".");
1331 /* If no capture filter or display filter has been specified, and there are
1332 still command-line arguments, treat them as the tokens of a capture
1333 filter (if no "-r" flag was specified) or a display filter (if a "-r"
1334 flag was specified. */
1335 if (optind < argc) {
1336 if (cf_name != NULL) {
1337 if (dfilter != NULL) {
1338 cmdarg_err("Display filters were specified both with \"-d\" "
1339 "and with additional command-line arguments.");
1342 dfilter = get_args_as_string(argc, argv, optind);
1346 /* if "-q" wasn't specified, we should print packet information */
1348 print_packet_info = TRUE;
1351 print_usage(stderr);
1356 if (output_action != WRITE_TEXT) {
1357 cmdarg_err("Raw packet hex data can only be printed as text or PostScript");
1362 if (output_only != NULL) {
1365 if (!print_details) {
1366 cmdarg_err("-O requires -V");
1370 output_only_tables = g_hash_table_new (g_str_hash, g_str_equal);
1371 for (ps = strtok (output_only, ","); ps; ps = strtok (NULL, ",")) {
1372 g_hash_table_insert(output_only_tables, (gpointer)ps, (gpointer)ps);
1376 if (rfilter != NULL && !perform_two_pass_analysis) {
1377 cmdarg_err("-R without -2 is deprecated. For single-pass filtering use -Y.");
1381 /* Notify all registered modules that have had any of their preferences
1382 changed either from one of the preferences file or from the command
1383 line that their preferences have changed. */
1386 /* At this point MATE will have registered its field array so we can
1387 have a tap filter with one of MATE's late-registered fields as part
1388 of the filter. We can now process all the "-z" arguments. */
1389 start_requested_stats();
1391 /* disabled protocols as per configuration file */
1392 if (gdp_path == NULL && dp_path == NULL) {
1393 set_disabled_protos_list();
1394 set_disabled_heur_dissector_list();
1397 /* Build the column format array */
1398 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
1400 if (rfilter != NULL) {
1401 if (!dfilter_compile(rfilter, &rfcode, &err_msg)) {
1402 cmdarg_err("%s", err_msg);
1408 cfile.rfcode = rfcode;
1410 if (dfilter != NULL) {
1411 if (!dfilter_compile(dfilter, &dfcode, &err_msg)) {
1412 cmdarg_err("%s", err_msg);
1418 cfile.dfcode = dfcode;
1420 if (print_packet_info) {
1421 /* If we're printing as text or PostScript, we have
1422 to create a print stream. */
1423 if (output_action == WRITE_TEXT) {
1424 switch (print_format) {
1427 print_stream = print_stream_text_stdio_new(stdout);
1431 print_stream = print_stream_ps_stdio_new(stdout);
1435 g_assert_not_reached();
1440 /* We have to dissect each packet if:
1442 we're printing information about each packet;
1444 we're using a read filter on the packets;
1446 we're using a display filter on the packets;
1448 we're using any taps that need dissection. */
1449 do_dissection = print_packet_info || rfcode || dfcode || tap_listeners_require_dissection();
1453 * We're reading a capture file.
1456 /* TODO: if tfshark is ever changed to give the user a choice of which
1457 open_routine reader to use, then the following needs to change. */
1458 if (cf_open(&cfile, cf_name, WTAP_TYPE_AUTO, FALSE, &err) != CF_OK) {
1463 /* Process the packets in the file */
1465 /* XXX - for now there is only 1 packet */
1466 err = load_cap_file(&cfile, 1, 0);
1468 CATCH(OutOfMemoryError) {
1472 "Sorry, but TFShark has to terminate now!\n"
1474 "Some infos / workarounds can be found at:\n"
1475 "https://wiki.wireshark.org/KnownBugs/OutOfMemory\n");
1481 /* We still dump out the results of taps, etc., as we might have
1482 read some packets; however, we exit with an error status. */
1489 if (cfile.frames != NULL) {
1490 free_frame_data_sequence(cfile.frames);
1491 cfile.frames = NULL;
1494 draw_tap_listeners(TRUE);
1495 funnel_dump_all_text_windows();
1496 epan_free(cfile.epan);
1499 output_fields_free(output_fields);
1500 output_fields = NULL;
1505 static const nstime_t *
1506 tfshark_get_frame_ts(void *data, guint32 frame_num)
1508 capture_file *cf = (capture_file *) data;
1510 if (ref && ref->num == frame_num)
1511 return &ref->abs_ts;
1513 if (prev_dis && prev_dis->num == frame_num)
1514 return &prev_dis->abs_ts;
1516 if (prev_cap && prev_cap->num == frame_num)
1517 return &prev_cap->abs_ts;
1520 frame_data *fd = frame_data_sequence_find(cf->frames, frame_num);
1522 return (fd) ? &fd->abs_ts : NULL;
1529 no_interface_name(void *data _U_, guint32 interface_id _U_)
1535 tfshark_epan_new(capture_file *cf)
1537 epan_t *epan = epan_new();
1540 epan->get_frame_ts = tfshark_get_frame_ts;
1541 epan->get_interface_name = no_interface_name;
1542 epan->get_user_comment = NULL;
1548 process_packet_first_pass(capture_file *cf, epan_dissect_t *edt,
1549 gint64 offset, struct wtap_pkthdr *whdr,
1556 /* The frame number of this packet is one more than the count of
1557 frames in this packet. */
1558 framenum = cf->count + 1;
1560 /* If we're not running a display filter and we're not printing any
1561 packet information, we don't need to do a dissection. This means
1562 that all packets can be marked as 'passed'. */
1565 frame_data_init(&fdlocal, framenum, whdr, offset, cum_bytes);
1567 /* If we're going to print packet information, or we're going to
1568 run a read filter, or display filter, or we're going to process taps, set up to
1569 do a dissection and do so. */
1571 /* If we're running a read filter, prime the epan_dissect_t with that
1574 epan_dissect_prime_dfilter(edt, cf->rfcode);
1576 frame_data_set_before_dissect(&fdlocal, &cf->elapsed_time,
1578 if (ref == &fdlocal) {
1579 ref_frame = fdlocal;
1583 epan_dissect_file_run(edt, whdr, file_tvbuff_new(&fdlocal, pd), &fdlocal, NULL);
1585 /* Run the read filter if we have one. */
1587 passed = dfilter_apply_edt(cf->rfcode, edt);
1591 frame_data_set_after_dissect(&fdlocal, &cum_bytes);
1592 prev_cap = prev_dis = frame_data_sequence_add(cf->frames, &fdlocal);
1594 /* If we're not doing dissection then there won't be any dependent frames.
1595 * More importantly, edt.pi.dependent_frames won't be initialized because
1596 * epan hasn't been initialized.
1599 g_slist_foreach(edt->pi.dependent_frames, find_and_mark_frame_depended_upon, cf->frames);
1604 /* if we don't add it to the frame_data_sequence, clean it up right now
1606 frame_data_destroy(&fdlocal);
1610 epan_dissect_reset(edt);
1616 process_packet_second_pass(capture_file *cf, epan_dissect_t *edt, frame_data *fdata,
1617 struct wtap_pkthdr *phdr, Buffer *buf,
1623 /* If we're not running a display filter and we're not printing any
1624 packet information, we don't need to do a dissection. This means
1625 that all packets can be marked as 'passed'. */
1628 /* If we're going to print packet information, or we're going to
1629 run a read filter, or we're going to process taps, set up to
1630 do a dissection and do so. */
1633 /* If we're running a display filter, prime the epan_dissect_t with that
1636 epan_dissect_prime_dfilter(edt, cf->dfcode);
1638 col_custom_prime_edt(edt, &cf->cinfo);
1640 /* We only need the columns if either
1641 1) some tap needs the columns
1643 2) we're printing packet info but we're *not* verbose; in verbose
1644 mode, we print the protocol tree, not the protocol summary.
1646 if ((tap_flags & TL_REQUIRES_COLUMNS) || (print_packet_info && print_summary))
1651 frame_data_set_before_dissect(fdata, &cf->elapsed_time,
1658 epan_dissect_file_run_with_taps(edt, phdr, file_tvbuff_new_buffer(fdata, buf), fdata, cinfo);
1660 /* Run the read/display filter if we have one. */
1662 passed = dfilter_apply_edt(cf->dfcode, edt);
1666 frame_data_set_after_dissect(fdata, &cum_bytes);
1667 /* Process this packet. */
1668 if (print_packet_info) {
1669 /* We're printing packet information; print the information for
1671 print_packet(cf, edt);
1673 /* The ANSI C standard does not appear to *require* that a line-buffered
1674 stream be flushed to the host environment whenever a newline is
1675 written, it just says that, on such a stream, characters "are
1676 intended to be transmitted to or from the host environment as a
1677 block when a new-line character is encountered".
1679 The Visual C++ 6.0 C implementation doesn't do what is intended;
1680 even if you set a stream to be line-buffered, it still doesn't
1681 flush the buffer at the end of every line.
1683 So, if the "-l" flag was specified, we flush the standard output
1684 at the end of a packet. This will do the right thing if we're
1685 printing packet summary lines, and, as we print the entire protocol
1686 tree for a single packet without waiting for anything to happen,
1687 it should be as good as line-buffered mode if we're printing
1688 protocol trees. (The whole reason for the "-l" flag in either
1689 tcpdump or TShark is to allow the output of a live capture to
1690 be piped to a program or script and to have that script see the
1691 information for the packet as soon as it's printed, rather than
1692 having to wait until a standard I/O buffer fills up. */
1696 if (ferror(stdout)) {
1697 show_print_file_io_error(errno);
1706 epan_dissect_reset(edt);
1708 return passed || fdata->flags.dependent_of_displayed;
1712 local_wtap_read(capture_file *cf, struct wtap_pkthdr* file_phdr _U_, int *err, gchar **err_info _U_, gint64 *data_offset _U_, guint8** data_buffer)
1714 /* int bytes_read; */
1715 gint64 packet_size = wtap_file_size(cf->wth, err);
1717 *data_buffer = (guint8*)g_malloc((gsize)packet_size);
1718 /* bytes_read =*/ file_read(*data_buffer, (unsigned int)packet_size, cf->wth->fh);
1720 #if 0 /* no more filetap */
1721 if (bytes_read < 0) {
1722 *err = file_error(cf->wth->fh, err_info);
1724 *err = FTAP_ERR_SHORT_READ;
1726 } else if (bytes_read == 0) {
1727 /* Done with file, no error */
1732 /* XXX - SET FRAME SIZE EQUAL TO TOTAL FILE SIZE */
1733 file_phdr->caplen = (guint32)packet_size;
1734 file_phdr->len = (guint32)packet_size;
1737 * Set the packet encapsulation to the file's encapsulation
1738 * value; if that's not WTAP_ENCAP_PER_PACKET, it's the
1739 * right answer (and means that the read routine for this
1740 * capture file type doesn't have to set it), and if it
1741 * *is* WTAP_ENCAP_PER_PACKET, the caller needs to set it
1744 wth->phdr.pkt_encap = wth->file_encap;
1746 if (!wth->subtype_read(wth, err, err_info, data_offset)) {
1748 * If we didn't get an error indication, we read
1749 * the last packet. See if there's any deferred
1750 * error, as might, for example, occur if we're
1751 * reading a compressed file, and we got an error
1752 * reading compressed data from the file, but
1753 * got enough compressed data to decompress the
1754 * last packet of the file.
1757 *err = file_error(wth->fh, err_info);
1758 return FALSE; /* failure */
1762 * It makes no sense for the captured data length to be bigger
1763 * than the actual data length.
1765 if (wth->phdr.caplen > wth->phdr.len)
1766 wth->phdr.caplen = wth->phdr.len;
1769 * Make sure that it's not WTAP_ENCAP_PER_PACKET, as that
1770 * probably means the file has that encapsulation type
1771 * but the read routine didn't set this packet's
1772 * encapsulation type.
1774 g_assert(wth->phdr.pkt_encap != WTAP_ENCAP_PER_PACKET);
1777 return TRUE; /* success */
1781 load_cap_file(capture_file *cf, int max_packet_count, gint64 max_byte_count)
1785 gchar *err_info = NULL;
1786 gint64 data_offset = 0;
1787 gboolean filtering_tap_listeners;
1790 epan_dissect_t *edt = NULL;
1791 struct wtap_pkthdr file_phdr;
1794 if (print_packet_info) {
1795 if (!write_preamble(cf)) {
1797 show_print_file_io_error(err);
1802 /* Do we have any tap listeners with filters? */
1803 filtering_tap_listeners = have_filtering_tap_listeners();
1805 /* Get the union of the flags for all tap listeners. */
1806 tap_flags = union_of_tap_listener_flags();
1808 wtap_phdr_init(&file_phdr);
1810 /* XXX - TEMPORARY HACK TO ELF DISSECTOR */
1811 file_phdr.pkt_encap = 1234;
1813 if (perform_two_pass_analysis) {
1816 /* Allocate a frame_data_sequence for all the frames. */
1817 cf->frames = new_frame_data_sequence();
1819 if (do_dissection) {
1820 gboolean create_proto_tree = FALSE;
1822 /* If we're going to be applying a filter, we'll need to
1823 create a protocol tree against which to apply the filter. */
1825 create_proto_tree = TRUE;
1827 /* We're not going to display the protocol tree on this pass,
1828 so it's not going to be "visible". */
1829 edt = epan_dissect_new(cf->epan, create_proto_tree, FALSE);
1831 while (local_wtap_read(cf, &file_phdr, &err, &err_info, &data_offset, &raw_data)) {
1832 if (process_packet_first_pass(cf, edt, data_offset, &file_phdr/*wtap_phdr(cf->wth)*/,
1833 wtap_buf_ptr(cf->wth))) {
1835 /* Stop reading if we have the maximum number of packets;
1836 * When the -c option has not been used, max_packet_count
1837 * starts at 0, which practically means, never stop reading.
1838 * (unless we roll over max_packet_count ?)
1840 if ( (--max_packet_count == 0) || (max_byte_count != 0 && data_offset >= max_byte_count)) {
1841 err = 0; /* This is not an error */
1848 epan_dissect_free(edt);
1853 /* Close the sequential I/O side, to free up memory it requires. */
1854 wtap_sequential_close(cf->wth);
1857 /* Allow the protocol dissectors to free up memory that they
1858 * don't need after the sequential run-through of the packets. */
1859 postseq_cleanup_all_protocols();
1863 ws_buffer_init(&buf, 1500);
1865 if (do_dissection) {
1866 gboolean create_proto_tree;
1868 if (cf->dfcode || print_details || filtering_tap_listeners ||
1869 (tap_flags & TL_REQUIRES_PROTO_TREE) || have_custom_cols(&cf->cinfo))
1870 create_proto_tree = TRUE;
1872 create_proto_tree = FALSE;
1874 /* The protocol tree will be "visible", i.e., printed, only if we're
1875 printing packet details, which is true if we're printing stuff
1876 ("print_packet_info" is true) and we're in verbose mode
1877 ("packet_details" is true). */
1878 edt = epan_dissect_new(cf->epan, create_proto_tree, print_packet_info && print_details);
1881 for (framenum = 1; err == 0 && framenum <= cf->count; framenum++) {
1882 fdata = frame_data_sequence_find(cf->frames, framenum);
1884 if (wtap_seek_read(cf->wth, fdata->file_off,
1885 &buf, fdata->cap_len, &err, &err_info)) {
1886 process_packet_second_pass(cf, edt, fdata, &cf->phdr, &buf, tap_flags);
1889 process_packet_second_pass(cf, edt, fdata, &cf->phdr, &buf, tap_flags);
1894 epan_dissect_free(edt);
1898 ws_buffer_free(&buf);
1903 if (do_dissection) {
1904 gboolean create_proto_tree;
1906 if (cf->rfcode || cf->dfcode || print_details || filtering_tap_listeners ||
1907 (tap_flags & TL_REQUIRES_PROTO_TREE) || have_custom_cols(&cf->cinfo))
1908 create_proto_tree = TRUE;
1910 create_proto_tree = FALSE;
1912 /* The protocol tree will be "visible", i.e., printed, only if we're
1913 printing packet details, which is true if we're printing stuff
1914 ("print_packet_info" is true) and we're in verbose mode
1915 ("packet_details" is true). */
1916 edt = epan_dissect_new(cf->epan, create_proto_tree, print_packet_info && print_details);
1919 while (local_wtap_read(cf, &file_phdr, &err, &err_info, &data_offset, &raw_data)) {
1923 process_packet(cf, edt, data_offset, &file_phdr/*wtap_phdr(cf->wth)*/,
1924 raw_data, tap_flags);
1926 /* Stop reading if we have the maximum number of packets;
1927 * When the -c option has not been used, max_packet_count
1928 * starts at 0, which practically means, never stop reading.
1929 * (unless we roll over max_packet_count ?)
1931 if ( (--max_packet_count == 0) || (max_byte_count != 0 && data_offset >= max_byte_count)) {
1932 err = 0; /* This is not an error */
1938 epan_dissect_free(edt);
1943 wtap_phdr_cleanup(&file_phdr);
1947 * Print a message noting that the read failed somewhere along the line.
1949 * If we're printing packet data, and the standard output and error are
1950 * going to the same place, flush the standard output, so everything
1951 * buffered up is written, and then print a newline to the standard error
1952 * before printing the error message, to separate it from the packet
1953 * data. (Alas, that only works on UN*X; st_dev is meaningless, and
1954 * the _fstat() documentation at Microsoft doesn't indicate whether
1955 * st_ino is even supported.)
1958 if (print_packet_info) {
1959 ws_statb64 stat_stdout, stat_stderr;
1961 if (ws_fstat64(1, &stat_stdout) == 0 && ws_fstat64(2, &stat_stderr) == 0) {
1962 if (stat_stdout.st_dev == stat_stderr.st_dev &&
1963 stat_stdout.st_ino == stat_stderr.st_ino) {
1965 fprintf(stderr, "\n");
1973 case FTAP_ERR_UNSUPPORTED:
1974 cmdarg_err("The file \"%s\" contains record data that TFShark doesn't support.\n(%s)",
1975 cf->filename, err_info);
1979 case FTAP_ERR_UNSUPPORTED_ENCAP:
1980 cmdarg_err("The file \"%s\" has a packet with a network type that TFShark doesn't support.\n(%s)",
1981 cf->filename, err_info);
1985 case FTAP_ERR_CANT_READ:
1986 cmdarg_err("An attempt to read from the file \"%s\" failed for some unknown reason.",
1990 case FTAP_ERR_SHORT_READ:
1991 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1995 case FTAP_ERR_BAD_FILE:
1996 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1997 cf->filename, err_info);
2001 case FTAP_ERR_DECOMPRESS:
2002 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n"
2003 "(%s)", cf->filename, err_info);
2007 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
2008 cf->filename, ftap_strerror(err));
2013 if (print_packet_info) {
2014 if (!write_finale()) {
2016 show_print_file_io_error(err);
2022 wtap_close(cf->wth);
2029 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
2030 struct wtap_pkthdr *whdr, const guchar *pd, guint tap_flags)
2036 /* Count this packet. */
2039 /* If we're not running a display filter and we're not printing any
2040 packet information, we don't need to do a dissection. This means
2041 that all packets can be marked as 'passed'. */
2044 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
2046 /* If we're going to print packet information, or we're going to
2047 run a read filter, or we're going to process taps, set up to
2048 do a dissection and do so. */
2050 /* If we're running a filter, prime the epan_dissect_t with that
2053 epan_dissect_prime_dfilter(edt, cf->dfcode);
2055 col_custom_prime_edt(edt, &cf->cinfo);
2057 /* We only need the columns if either
2058 1) some tap needs the columns
2060 2) we're printing packet info but we're *not* verbose; in verbose
2061 mode, we print the protocol tree, not the protocol summary.
2063 3) there is a column mapped as an individual field */
2064 if ((tap_flags & TL_REQUIRES_COLUMNS) || (print_packet_info && print_summary) || output_fields_has_cols(output_fields))
2069 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
2071 if (ref == &fdata) {
2076 epan_dissect_file_run_with_taps(edt, whdr, frame_tvbuff_new(&fdata, pd), &fdata, cinfo);
2078 /* Run the filter if we have it. */
2080 passed = dfilter_apply_edt(cf->dfcode, edt);
2084 frame_data_set_after_dissect(&fdata, &cum_bytes);
2086 /* Process this packet. */
2087 if (print_packet_info) {
2088 /* We're printing packet information; print the information for
2090 print_packet(cf, edt);
2092 /* The ANSI C standard does not appear to *require* that a line-buffered
2093 stream be flushed to the host environment whenever a newline is
2094 written, it just says that, on such a stream, characters "are
2095 intended to be transmitted to or from the host environment as a
2096 block when a new-line character is encountered".
2098 The Visual C++ 6.0 C implementation doesn't do what is intended;
2099 even if you set a stream to be line-buffered, it still doesn't
2100 flush the buffer at the end of every line.
2102 So, if the "-l" flag was specified, we flush the standard output
2103 at the end of a packet. This will do the right thing if we're
2104 printing packet summary lines, and, as we print the entire protocol
2105 tree for a single packet without waiting for anything to happen,
2106 it should be as good as line-buffered mode if we're printing
2107 protocol trees. (The whole reason for the "-l" flag in either
2108 tcpdump or TShark is to allow the output of a live capture to
2109 be piped to a program or script and to have that script see the
2110 information for the packet as soon as it's printed, rather than
2111 having to wait until a standard I/O buffer fills up. */
2115 if (ferror(stdout)) {
2116 show_print_file_io_error(errno);
2121 /* this must be set after print_packet() [bug #8160] */
2122 prev_dis_frame = fdata;
2123 prev_dis = &prev_dis_frame;
2126 prev_cap_frame = fdata;
2127 prev_cap = &prev_cap_frame;
2130 epan_dissect_reset(edt);
2131 frame_data_destroy(&fdata);
2137 write_preamble(capture_file *cf)
2139 switch (output_action) {
2142 return print_preamble(print_stream, cf->filename, get_ws_vcs_version_info());
2146 write_pdml_preamble(stdout, cf->filename);
2148 write_psml_preamble(&cf->cinfo, stdout);
2149 return !ferror(stdout);
2152 write_fields_preamble(output_fields, stdout);
2153 return !ferror(stdout);
2156 g_assert_not_reached();
2162 get_line_buf(size_t len)
2164 static char *line_bufp = NULL;
2165 static size_t line_buf_len = 256;
2166 size_t new_line_buf_len;
2168 for (new_line_buf_len = line_buf_len; len > new_line_buf_len;
2169 new_line_buf_len *= 2)
2171 if (line_bufp == NULL) {
2172 line_buf_len = new_line_buf_len;
2173 line_bufp = (char *)g_malloc(line_buf_len + 1);
2175 if (new_line_buf_len > line_buf_len) {
2176 line_buf_len = new_line_buf_len;
2177 line_bufp = (char *)g_realloc(line_bufp, line_buf_len + 1);
2184 put_string(char *dest, const char *str, size_t str_len)
2186 memcpy(dest, str, str_len);
2187 dest[str_len] = '\0';
2191 put_spaces_string(char *dest, const char *str, size_t str_len, size_t str_with_spaces)
2195 for (i = str_len; i < str_with_spaces; i++)
2198 put_string(dest, str, str_len);
2202 put_string_spaces(char *dest, const char *str, size_t str_len, size_t str_with_spaces)
2206 memcpy(dest, str, str_len);
2207 for (i = str_len; i < str_with_spaces; i++)
2210 dest[str_with_spaces] = '\0';
2214 print_columns(capture_file *cf)
2221 col_item_t* col_item;
2223 line_bufp = get_line_buf(256);
2226 for (i = 0; i < cf->cinfo.num_cols; i++) {
2227 col_item = &cf->cinfo.columns[i];
2228 /* Skip columns not marked as visible. */
2229 if (!get_column_visible(i))
2231 switch (col_item->col_fmt) {
2233 column_len = col_len = strlen(col_item->col_data);
2236 line_bufp = get_line_buf(buf_offset + column_len);
2237 put_spaces_string(line_bufp + buf_offset, col_item->col_data, col_len, column_len);
2243 case COL_ABS_YMD_TIME: /* XXX - wider */
2244 case COL_ABS_YDOY_TIME: /* XXX - wider */
2246 case COL_UTC_YMD_TIME: /* XXX - wider */
2247 case COL_UTC_YDOY_TIME: /* XXX - wider */
2248 column_len = col_len = strlen(col_item->col_data);
2249 if (column_len < 10)
2251 line_bufp = get_line_buf(buf_offset + column_len);
2252 put_spaces_string(line_bufp + buf_offset, col_item->col_data, col_len, column_len);
2258 case COL_DEF_DL_SRC:
2259 case COL_RES_DL_SRC:
2260 case COL_UNRES_DL_SRC:
2261 case COL_DEF_NET_SRC:
2262 case COL_RES_NET_SRC:
2263 case COL_UNRES_NET_SRC:
2264 column_len = col_len = strlen(col_item->col_data);
2265 if (column_len < 12)
2267 line_bufp = get_line_buf(buf_offset + column_len);
2268 put_spaces_string(line_bufp + buf_offset, col_item->col_data, col_len, column_len);
2274 case COL_DEF_DL_DST:
2275 case COL_RES_DL_DST:
2276 case COL_UNRES_DL_DST:
2277 case COL_DEF_NET_DST:
2278 case COL_RES_NET_DST:
2279 case COL_UNRES_NET_DST:
2280 column_len = col_len = strlen(col_item->col_data);
2281 if (column_len < 12)
2283 line_bufp = get_line_buf(buf_offset + column_len);
2284 put_string_spaces(line_bufp + buf_offset, col_item->col_data, col_len, column_len);
2288 column_len = strlen(col_item->col_data);
2289 line_bufp = get_line_buf(buf_offset + column_len);
2290 put_string(line_bufp + buf_offset, col_item->col_data, column_len);
2293 buf_offset += column_len;
2294 if (i != cf->cinfo.num_cols - 1) {
2296 * This isn't the last column, so we need to print a
2297 * separator between this column and the next.
2299 * If we printed a network source and are printing a
2300 * network destination of the same type next, separate
2301 * them with " -> "; if we printed a network destination
2302 * and are printing a network source of the same type
2303 * next, separate them with " <- "; otherwise separate them
2306 * We add enough space to the buffer for " <- " or " -> ",
2307 * even if we're only adding " ".
2309 line_bufp = get_line_buf(buf_offset + 4);
2310 switch (col_item->col_fmt) {
2315 switch (cf->cinfo.columns[i+1].col_fmt) {
2320 put_string(line_bufp + buf_offset, " -> ", 4);
2325 put_string(line_bufp + buf_offset, " ", 1);
2331 case COL_DEF_DL_SRC:
2332 case COL_RES_DL_SRC:
2333 case COL_UNRES_DL_SRC:
2334 switch (cf->cinfo.columns[i+1].col_fmt) {
2336 case COL_DEF_DL_DST:
2337 case COL_RES_DL_DST:
2338 case COL_UNRES_DL_DST:
2339 put_string(line_bufp + buf_offset, " -> ", 4);
2344 put_string(line_bufp + buf_offset, " ", 1);
2350 case COL_DEF_NET_SRC:
2351 case COL_RES_NET_SRC:
2352 case COL_UNRES_NET_SRC:
2353 switch (cf->cinfo.columns[i+1].col_fmt) {
2355 case COL_DEF_NET_DST:
2356 case COL_RES_NET_DST:
2357 case COL_UNRES_NET_DST:
2358 put_string(line_bufp + buf_offset, " -> ", 4);
2363 put_string(line_bufp + buf_offset, " ", 1);
2372 switch (cf->cinfo.columns[i+1].col_fmt) {
2377 put_string(line_bufp + buf_offset, " <- ", 4);
2382 put_string(line_bufp + buf_offset, " ", 1);
2388 case COL_DEF_DL_DST:
2389 case COL_RES_DL_DST:
2390 case COL_UNRES_DL_DST:
2391 switch (cf->cinfo.columns[i+1].col_fmt) {
2393 case COL_DEF_DL_SRC:
2394 case COL_RES_DL_SRC:
2395 case COL_UNRES_DL_SRC:
2396 put_string(line_bufp + buf_offset, " <- ", 4);
2401 put_string(line_bufp + buf_offset, " ", 1);
2407 case COL_DEF_NET_DST:
2408 case COL_RES_NET_DST:
2409 case COL_UNRES_NET_DST:
2410 switch (cf->cinfo.columns[i+1].col_fmt) {
2412 case COL_DEF_NET_SRC:
2413 case COL_RES_NET_SRC:
2414 case COL_UNRES_NET_SRC:
2415 put_string(line_bufp + buf_offset, " <- ", 4);
2420 put_string(line_bufp + buf_offset, " ", 1);
2427 put_string(line_bufp + buf_offset, " ", 1);
2433 return print_line(print_stream, 0, line_bufp);
2437 print_packet(capture_file *cf, epan_dissect_t *edt)
2439 print_args_t print_args;
2441 if (print_summary || output_fields_has_cols(output_fields)) {
2442 /* Just fill in the columns. */
2443 epan_dissect_fill_in_columns(edt, FALSE, TRUE);
2445 if (print_summary) {
2446 /* Now print them. */
2447 switch (output_action) {
2450 if (!print_columns(cf))
2455 write_psml_columns(edt, stdout);
2456 return !ferror(stdout);
2457 case WRITE_FIELDS: /*No non-verbose "fields" format */
2458 g_assert_not_reached();
2463 if (print_details) {
2464 /* Print the information in the protocol tree. */
2465 switch (output_action) {
2468 /* Only initialize the fields that are actually used in proto_tree_print.
2469 * This is particularly important for .range, as that's heap memory which
2470 * we would otherwise have to g_free().
2471 print_args.to_file = TRUE;
2472 print_args.format = print_format;
2473 print_args.print_summary = print_summary;
2474 print_args.print_formfeed = FALSE;
2475 packet_range_init(&print_args.range, &cfile);
2477 print_args.print_hex = print_hex;
2478 print_args.print_dissections = print_details ? print_dissections_expanded : print_dissections_none;
2480 if (!proto_tree_print(&print_args, edt, output_only_tables, print_stream))
2483 if (!print_line(print_stream, 0, separator))
2489 write_pdml_proto_tree(edt, stdout);
2491 return !ferror(stdout);
2493 write_fields_proto_tree(output_fields, edt, &cf->cinfo, stdout);
2495 return !ferror(stdout);
2499 if (print_summary || print_details) {
2500 if (!print_line(print_stream, 0, ""))
2503 if (!print_hex_data(print_stream, edt))
2505 if (!print_line(print_stream, 0, separator))
2514 switch (output_action) {
2517 return print_finale(print_stream);
2521 write_pdml_finale(stdout);
2523 write_psml_finale(stdout);
2524 return !ferror(stdout);
2527 write_fields_finale(output_fields, stdout);
2528 return !ferror(stdout);
2531 g_assert_not_reached();
2537 cf_open(capture_file *cf, const char *fname, unsigned int type, gboolean is_tempfile, int *err)
2540 char err_msg[2048+1];
2542 /* The open isn't implemented yet. Fill in the information for this file. */
2544 /* Create new epan session for dissection. */
2545 epan_free(cf->epan);
2546 cf->epan = tfshark_epan_new(cf);
2548 cf->wth = NULL; /**** XXX - DOESN'T WORK RIGHT NOW!!!! */
2549 cf->f_datalen = 0; /* not used, but set it anyway */
2551 /* Set the file name because we need it to set the follow stream filter.
2552 XXX - is that still true? We need it for other reasons, though,
2554 cf->filename = g_strdup(fname);
2556 /* Indicate whether it's a permanent or temporary file. */
2557 cf->is_tempfile = is_tempfile;
2559 /* No user changes yet. */
2560 cf->unsaved_changes = FALSE;
2562 cf->cd_t = 0; /**** XXX - DOESN'T WORK RIGHT NOW!!!! */
2563 cf->open_type = type;
2565 cf->drops_known = FALSE;
2567 cf->snap = 0; /**** XXX - DOESN'T WORK RIGHT NOW!!!! */
2568 if (cf->snap == 0) {
2569 /* Snapshot length not known. */
2570 cf->has_snap = FALSE;
2573 cf->has_snap = TRUE;
2574 nstime_set_zero(&cf->elapsed_time);
2579 cf->state = FILE_READ_IN_PROGRESS;
2584 g_snprintf(err_msg, sizeof err_msg,
2585 cf_open_error_message(*err, err_info, FALSE, cf->cd_t), fname);
2586 cmdarg_err("%s", err_msg);
2591 show_print_file_io_error(int err)
2596 cmdarg_err("Not all the packets could be printed because there is "
2597 "no space left on the file system.");
2602 cmdarg_err("Not all the packets could be printed because you are "
2603 "too close to, or over your disk quota.");
2608 cmdarg_err("An error occurred while printing packets: %s.",
2615 cf_open_error_message(int err, gchar *err_info _U_, gboolean for_writing,
2619 /* static char errmsg_errno[1024+1]; */
2623 /* Wiretap error. */
2626 case FTAP_ERR_NOT_REGULAR_FILE:
2627 errmsg = "The file \"%s\" is a \"special file\" or socket or other non-regular file.";
2630 case FTAP_ERR_RANDOM_OPEN_PIPE:
2631 /* Seen only when opening a capture file for reading. */
2632 errmsg = "The file \"%s\" is a pipe or FIFO; TFShark can't read pipe or FIFO files in two-pass mode.";
2635 case FTAP_ERR_FILE_UNKNOWN_FORMAT:
2636 /* Seen only when opening a capture file for reading. */
2637 errmsg = "The file \"%s\" isn't a capture file in a format TFShark understands.";
2640 case FTAP_ERR_UNSUPPORTED:
2641 /* Seen only when opening a capture file for reading. */
2642 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2643 "The file \"%%s\" isn't a capture file in a format TFShark understands.\n"
2646 errmsg = errmsg_errno;
2649 case FTAP_ERR_CANT_WRITE_TO_PIPE:
2650 /* Seen only when opening a capture file for writing. */
2651 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2652 "The file \"%%s\" is a pipe, and \"%s\" capture files can't be "
2653 "written to a pipe.", ftap_file_type_subtype_short_string(file_type));
2654 errmsg = errmsg_errno;
2657 case FTAP_ERR_UNSUPPORTED_FILE_TYPE:
2658 /* Seen only when opening a capture file for writing. */
2659 errmsg = "TFShark doesn't support writing capture files in that format.";
2662 case FTAP_ERR_UNSUPPORTED_ENCAP:
2664 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2665 "TFShark can't save this capture as a \"%s\" file.",
2666 ftap_file_type_subtype_short_string(file_type));
2668 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2669 "The file \"%%s\" is a capture for a network type that TFShark doesn't support.\n"
2673 errmsg = errmsg_errno;
2676 case FTAP_ERR_ENCAP_PER_RECORD_UNSUPPORTED:
2678 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2679 "TFShark can't save this capture as a \"%s\" file.",
2680 ftap_file_type_subtype_short_string(file_type));
2681 errmsg = errmsg_errno;
2683 errmsg = "The file \"%s\" is a capture for a network type that TFShark doesn't support.";
2686 case FTAP_ERR_BAD_FILE:
2687 /* Seen only when opening a capture file for reading. */
2688 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2689 "The file \"%%s\" appears to be damaged or corrupt.\n"
2692 errmsg = errmsg_errno;
2695 case FTAP_ERR_CANT_OPEN:
2697 errmsg = "The file \"%s\" could not be created for some unknown reason.";
2699 errmsg = "The file \"%s\" could not be opened for some unknown reason.";
2702 case FTAP_ERR_SHORT_READ:
2703 errmsg = "The file \"%s\" appears to have been cut short"
2704 " in the middle of a packet or other data.";
2707 case FTAP_ERR_SHORT_WRITE:
2708 errmsg = "A full header couldn't be written to the file \"%s\".";
2711 case FTAP_ERR_COMPRESSION_NOT_SUPPORTED:
2712 errmsg = "This file type cannot be written as a compressed file.";
2715 case FTAP_ERR_DECOMPRESS:
2716 /* Seen only when opening a capture file for reading. */
2717 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2718 "The compressed file \"%%s\" appears to be damaged or corrupt.\n"
2721 errmsg = errmsg_errno;
2725 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
2726 "The file \"%%s\" could not be %s: %s.",
2727 for_writing ? "created" : "opened",
2728 ftap_strerror(err));
2729 errmsg = errmsg_errno;
2734 errmsg = file_open_error_message(err, for_writing);
2739 * Open/create errors are reported with an console message in TFShark.
2742 open_failure_message(const char *filename, int err, gboolean for_writing)
2744 fprintf(stderr, "tfshark: ");
2745 fprintf(stderr, file_open_error_message(err, for_writing), filename);
2746 fprintf(stderr, "\n");
2751 * General errors are reported with an console message in TFShark.
2754 failure_message(const char *msg_format, va_list ap)
2756 fprintf(stderr, "tfshark: ");
2757 vfprintf(stderr, msg_format, ap);
2758 fprintf(stderr, "\n");
2762 * Read errors are reported with an console message in TFShark.
2765 read_failure_message(const char *filename, int err)
2767 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
2768 filename, g_strerror(err));
2772 * Write errors are reported with an console message in TFShark.
2775 write_failure_message(const char *filename, int err)
2777 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
2778 filename, g_strerror(err));
2782 * Report additional information for an error in command-line arguments.
2785 failure_message_cont(const char *msg_format, va_list ap)
2787 vfprintf(stderr, msg_format, ap);
2788 fprintf(stderr, "\n");
2792 * Editor modelines - https://www.wireshark.org/tools/modelines.html
2797 * indent-tabs-mode: nil
2800 * vi: set shiftwidth=2 tabstop=8 expandtab:
2801 * :indentSize=2:tabSize=8:noTabs=true: