6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
44 #include <epan/epan.h>
45 #include <epan/filesystem.h>
48 #include "color_filters.h"
50 #include <epan/column.h>
51 #include <epan/packet.h>
52 #include <epan/column-utils.h>
53 #include "packet-range.h"
60 #include <epan/prefs.h>
61 #include <epan/dfilter/dfilter.h>
62 #include <epan/epan_dissect.h>
64 #include <epan/dissectors/packet-data.h>
65 #include <epan/dissectors/packet-ber.h>
66 #include <epan/timestamp.h>
67 #include <epan/dfilter/dfilter-macro.h>
68 #include <wsutil/file_util.h>
69 #include <epan/strutil.h>
70 #include <epan/addr_resolv.h>
72 #include "ui/alert_box.h"
73 #include "ui/simple_dialog.h"
74 #include "ui/main_statusbar.h"
75 #include "ui/progress_dlg.h"
76 #include "ui/ui_util.h"
78 /* Needed for addrinfo */
79 #ifdef HAVE_SYS_TYPES_H
80 # include <sys/types.h>
83 #ifdef HAVE_SYS_SOCKET_H
84 #include <sys/socket.h>
87 #ifdef HAVE_NETINET_IN_H
88 # include <netinet/in.h>
95 #ifdef HAVE_WINSOCK2_H
96 # include <winsock2.h>
99 #if defined(_WIN32) && defined(INET6)
100 # include <ws2tcpip.h>
104 gboolean auto_scroll_live;
107 static guint32 cum_bytes;
108 static nstime_t first_ts;
109 static frame_data *prev_dis;
110 static frame_data *prev_cap;
112 static gulong computed_elapsed;
114 static void cf_reset_state(capture_file *cf);
116 static int read_packet(capture_file *cf, dfilter_t *dfcode,
117 gboolean create_proto_tree, column_info *cinfo, gint64 offset);
119 static void rescan_packets(capture_file *cf, const char *action, const char *action_item, gboolean redissect);
126 static match_result match_protocol_tree(capture_file *cf, frame_data *fdata,
128 static void match_subtree_text(proto_node *node, gpointer data);
129 static match_result match_summary_line(capture_file *cf, frame_data *fdata,
131 static match_result match_narrow_and_wide(capture_file *cf, frame_data *fdata,
133 static match_result match_narrow(capture_file *cf, frame_data *fdata,
135 static match_result match_wide(capture_file *cf, frame_data *fdata,
137 static match_result match_binary(capture_file *cf, frame_data *fdata,
139 static match_result match_dfilter(capture_file *cf, frame_data *fdata,
141 static match_result match_marked(capture_file *cf, frame_data *fdata,
143 static match_result match_time_reference(capture_file *cf, frame_data *fdata,
145 static gboolean find_packet(capture_file *cf,
146 match_result (*match_function)(capture_file *, frame_data *, void *),
147 void *criterion, search_direction dir);
149 static void cf_open_failure_alert_box(const char *filename, int err,
150 gchar *err_info, gboolean for_writing,
152 static void cf_rename_failure_alert_box(const char *filename, int err);
153 static void cf_close_failure_alert_box(const char *filename, int err);
154 static void ref_time_packets(capture_file *cf);
155 /* Update the progress bar this many times when reading a file. */
156 #define N_PROGBAR_UPDATES 100
157 /* We read around 200k/100ms don't update the progress bar more often than that */
158 #define MIN_QUANTUM 200000
159 #define MIN_NUMBER_OF_PACKET 1500
162 * We could probably use g_signal_...() instead of the callbacks below but that
163 * would require linking our CLI programs to libgobject and creating an object
164 * instance for the signals.
167 cf_callback_t cb_fct;
169 } cf_callback_data_t;
171 static GList *cf_callbacks = NULL;
174 cf_callback_invoke(int event, gpointer data)
176 cf_callback_data_t *cb;
177 GList *cb_item = cf_callbacks;
179 /* there should be at least one interested */
180 g_assert(cb_item != NULL);
182 while (cb_item != NULL) {
183 cb = (cf_callback_data_t *)cb_item->data;
184 cb->cb_fct(event, data, cb->user_data);
185 cb_item = g_list_next(cb_item);
191 cf_callback_add(cf_callback_t func, gpointer user_data)
193 cf_callback_data_t *cb;
195 cb = g_new(cf_callback_data_t,1);
197 cb->user_data = user_data;
199 cf_callbacks = g_list_append(cf_callbacks, cb);
203 cf_callback_remove(cf_callback_t func)
205 cf_callback_data_t *cb;
206 GList *cb_item = cf_callbacks;
208 while (cb_item != NULL) {
209 cb = (cf_callback_data_t *)cb_item->data;
210 if (cb->cb_fct == func) {
211 cf_callbacks = g_list_remove(cf_callbacks, cb);
215 cb_item = g_list_next(cb_item);
218 g_assert_not_reached();
222 cf_timestamp_auto_precision(capture_file *cf)
225 int prec = timestamp_get_precision();
228 /* don't try to get the file's precision if none is opened */
229 if (cf->state == FILE_CLOSED) {
233 /* if we are in auto mode, set precision of current file */
234 if (prec == TS_PREC_AUTO ||
235 prec == TS_PREC_AUTO_SEC ||
236 prec == TS_PREC_AUTO_DSEC ||
237 prec == TS_PREC_AUTO_CSEC ||
238 prec == TS_PREC_AUTO_MSEC ||
239 prec == TS_PREC_AUTO_USEC ||
240 prec == TS_PREC_AUTO_NSEC)
242 switch(wtap_file_tsprecision(cf->wth)) {
243 case(WTAP_FILE_TSPREC_SEC):
244 timestamp_set_precision(TS_PREC_AUTO_SEC);
246 case(WTAP_FILE_TSPREC_DSEC):
247 timestamp_set_precision(TS_PREC_AUTO_DSEC);
249 case(WTAP_FILE_TSPREC_CSEC):
250 timestamp_set_precision(TS_PREC_AUTO_CSEC);
252 case(WTAP_FILE_TSPREC_MSEC):
253 timestamp_set_precision(TS_PREC_AUTO_MSEC);
255 case(WTAP_FILE_TSPREC_USEC):
256 timestamp_set_precision(TS_PREC_AUTO_USEC);
258 case(WTAP_FILE_TSPREC_NSEC):
259 timestamp_set_precision(TS_PREC_AUTO_NSEC);
262 g_assert_not_reached();
265 /* Set the column widths of those columns that show the time in
266 "command-line-specified" format. */
267 for (i = 0; i < cf->cinfo.num_cols; i++) {
268 if (col_has_time_fmt(&cf->cinfo, i)) {
269 packet_list_resize_column(i);
275 cf_get_computed_elapsed(void)
277 return computed_elapsed;
280 static void reset_elapsed(void)
282 computed_elapsed = 0;
286 * GLIB_CHECK_VERSION(2,28,0) adds g_get_real_time which could minimize or
289 static void compute_elapsed(GTimeVal *start_time)
294 g_get_current_time(&time_now);
296 delta_time = (time_now.tv_sec - start_time->tv_sec) * 1e6 +
297 time_now.tv_usec - start_time->tv_usec;
299 computed_elapsed = (gulong) (delta_time / 1000); /* ms */
303 cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err)
308 wth = wtap_open_offline(fname, err, &err_info, TRUE);
312 /* The open succeeded. Close whatever capture file we had open,
313 and fill in the information for this file. */
316 /* XXX - we really want to initialize this after we've read all
317 the packets, so we know how much we'll ultimately need. */
318 buffer_init(&cf->buf, 1500);
320 /* Cleanup all data structures used for dissection. */
321 cleanup_dissection();
322 /* Initialize all data structures used for dissection. */
325 /* We're about to start reading the file. */
326 cf->state = FILE_READ_IN_PROGRESS;
331 /* Set the file name because we need it to set the follow stream filter.
332 XXX - is that still true? We need it for other reasons, though,
334 cf->filename = g_strdup(fname);
336 /* Indicate whether it's a permanent or temporary file. */
337 cf->is_tempfile = is_tempfile;
339 /* No user changes yet. */
340 cf->unsaved_changes = FALSE;
344 cf->cd_t = wtap_file_type(cf->wth);
345 cf->linktypes = g_array_sized_new(FALSE, FALSE, (guint) sizeof(int), 1);
347 cf->packet_comment_count = 0;
348 cf->displayed_count = 0;
349 cf->marked_count = 0;
350 cf->ignored_count = 0;
351 cf->ref_time_count = 0;
352 cf->drops_known = FALSE;
354 cf->snap = wtap_snapshot_length(cf->wth);
356 /* Snapshot length not known. */
357 cf->has_snap = FALSE;
358 cf->snap = WTAP_MAX_PACKET_SIZE;
362 /* Allocate a frame_data_sequence for the frames in this file */
363 cf->frames = new_frame_data_sequence();
365 nstime_set_zero(&cf->elapsed_time);
366 nstime_set_unset(&first_ts);
371 /* Adjust timestamp precision if auto is selected, col width will be adjusted */
372 cf_timestamp_auto_precision(cf);
374 packet_list_queue_draw();
375 cf_callback_invoke(cf_cb_file_opened, cf);
377 if (cf->cd_t == WTAP_FILE_BER) {
378 /* tell the BER dissector the file name */
379 ber_set_filename(cf->filename);
382 wtap_set_cb_new_ipv4(cf->wth, add_ipv4_name);
383 wtap_set_cb_new_ipv6(cf->wth, (wtap_new_ipv6_callback_t) add_ipv6_name);
388 cf_open_failure_alert_box(fname, *err, err_info, FALSE, 0);
393 * Add an encapsulation type to cf->linktypes.
396 cf_add_encapsulation_type(capture_file *cf, int encap)
400 for (i = 0; i < cf->linktypes->len; i++) {
401 if (g_array_index(cf->linktypes, gint, i) == encap)
402 return; /* it's already there */
404 /* It's not already there - add it. */
405 g_array_append_val(cf->linktypes, encap);
409 * Reset the state for the currently closed file, but don't do the
410 * UI callbacks; this is for use in "cf_open()", where we don't
411 * want the UI to go from "file open" to "file closed" back to
412 * "file open", we want it to go from "old file open" to "new file
413 * open and being read".
415 * XXX - currently, cf_open() calls cf_close(), rather than
419 cf_reset_state(capture_file *cf)
421 /* Die if we're in the middle of reading a file. */
422 g_assert(cf->state != FILE_READ_IN_PROGRESS);
428 /* We have no file open... */
429 if (cf->filename != NULL) {
430 /* If it's a temporary file, remove it. */
432 ws_unlink(cf->filename);
433 g_free(cf->filename);
436 /* ...which means we have no changes to that file to save. */
437 cf->unsaved_changes = FALSE;
439 /* Free up the packet buffer. */
440 buffer_free(&cf->buf);
442 dfilter_free(cf->rfcode);
444 if (cf->frames != NULL) {
445 free_frame_data_sequence(cf->frames);
448 #ifdef WANT_PACKET_EDITOR
449 if (cf->edited_frames) {
450 g_tree_destroy(cf->edited_frames);
451 cf->edited_frames = NULL;
454 cf_unselect_packet(cf); /* nothing to select */
455 cf->first_displayed = 0;
456 cf->last_displayed = 0;
458 /* No frames, no frame selected, no field in that frame selected. */
460 cf->current_frame = 0;
462 cf->finfo_selected = NULL;
464 /* No frame link-layer types, either. */
465 g_array_free(cf->linktypes, TRUE);
466 cf->linktypes = NULL;
468 /* Clear the packet list. */
469 packet_list_freeze();
474 nstime_set_zero(&cf->elapsed_time);
476 reset_tap_listeners();
478 /* We have no file open. */
479 cf->state = FILE_CLOSED;
482 /* Reset everything to a pristine state */
484 cf_close(capture_file *cf)
486 if (cf->state != FILE_CLOSED) {
487 cf_callback_invoke(cf_cb_file_closing, cf);
489 /* close things, if not already closed before */
490 color_filters_cleanup();
492 cleanup_dissection();
494 cf_callback_invoke(cf_cb_file_closed, cf);
499 calc_progbar_val(capture_file *cf, gint64 size, gint64 file_pos, gchar *status_str, gulong status_size)
503 progbar_val = (gfloat) file_pos / (gfloat) size;
504 if (progbar_val > 1.0) {
506 /* The file probably grew while we were reading it.
507 * Update file size, and try again.
509 size = wtap_file_size(cf->wth, NULL);
512 progbar_val = (gfloat) file_pos / (gfloat) size;
514 /* If it's still > 1, either "wtap_file_size()" failed (in which
515 * case there's not much we can do about it), or the file
516 * *shrank* (in which case there's not much we can do about
517 * it); just clip the progress value at 1.0.
519 if (progbar_val > 1.0f)
523 g_snprintf(status_str, status_size,
524 "%" G_GINT64_MODIFIER "dKB of %" G_GINT64_MODIFIER "dKB",
525 file_pos / 1024, size / 1024);
531 cf_read(capture_file *cf, gboolean reloading)
536 progdlg_t *progbar = NULL;
540 volatile gboolean create_proto_tree;
544 /* Compile the current display filter.
545 * We assume this will not fail since cf->dfilter is only set in
546 * cf_filter IFF the filter was valid.
548 compiled = dfilter_compile(cf->dfilter, &dfcode);
549 g_assert(!cf->dfilter || (compiled && dfcode));
551 /* Get the union of the flags for all tap listeners. */
552 tap_flags = union_of_tap_listener_flags();
554 (dfcode != NULL || have_filtering_tap_listeners() || (tap_flags & TL_REQUIRES_PROTO_TREE));
556 reset_tap_listeners();
558 name_ptr = g_filename_display_basename(cf->filename);
561 cf_callback_invoke(cf_cb_file_reload_started, cf);
563 cf_callback_invoke(cf_cb_file_read_started, cf);
565 /* Record whether the file is compressed.
566 XXX - do we know this at open time? */
567 cf->iscompressed = wtap_iscompressed(cf->wth);
569 /* The packet list window will be empty until the file is completly loaded */
570 packet_list_freeze();
573 g_get_current_time(&start_time);
577 int displayed_once = 0;
585 gint64 progbar_quantum;
586 gint64 progbar_nextstep;
588 gchar status_str[100];
592 cinfo = (tap_flags & TL_REQUIRES_COLUMNS) ? &cf->cinfo : NULL;
594 /* Find the size of the file. */
595 size = wtap_file_size(cf->wth, NULL);
597 /* Update the progress bar when it gets to this value. */
598 progbar_nextstep = 0;
599 /* When we reach the value that triggers a progress bar update,
600 bump that value by this amount. */
602 progbar_quantum = size/N_PROGBAR_UPDATES;
603 if (progbar_quantum < MIN_QUANTUM)
604 progbar_quantum = MIN_QUANTUM;
607 /* Progress so far. */
610 while ((wtap_read(cf->wth, &err, &err_info, &data_offset))) {
613 file_pos = wtap_read_so_far(cf->wth);
615 /* Create the progress bar if necessary.
616 * Check whether it should be created or not every MIN_NUMBER_OF_PACKET
618 if ((progbar == NULL) && !(count % MIN_NUMBER_OF_PACKET)) {
619 progbar_val = calc_progbar_val(cf, size, file_pos, status_str, sizeof(status_str));
621 progbar = delayed_create_progress_dlg(cf->window, "Reloading", name_ptr,
622 TRUE, &stop_flag, &start_time, progbar_val);
624 progbar = delayed_create_progress_dlg(cf->window, "Loading", name_ptr,
625 TRUE, &stop_flag, &start_time, progbar_val);
628 /* Update the progress bar, but do it only N_PROGBAR_UPDATES times;
629 when we update it, we have to run the GTK+ main loop to get it
630 to repaint what's pending, and doing so may involve an "ioctl()"
631 to see if there's any pending input from an X server, and doing
632 that for every packet can be costly, especially on a big file. */
633 if (file_pos >= progbar_nextstep) {
634 if (progbar != NULL) {
635 progbar_val = calc_progbar_val(cf, size, file_pos, status_str, sizeof(status_str));
636 /* update the packet bar content on the first run or frequently on very large files */
638 if (progbar_quantum > 500000 || displayed_once == 0) {
639 if ((auto_scroll_live || displayed_once == 0 || cf->displayed_count < 1000) && cf->count != 0) {
641 packets_bar_update();
644 #endif /* HAVE_LIBPCAP */
645 update_progress_dlg(progbar, progbar_val, status_str);
647 progbar_nextstep += progbar_quantum;
652 /* Well, the user decided to abort the read. He/She will be warned and
653 it might be enough for him/her to work with the already loaded
655 This is especially true for very large capture files, where you don't
656 want to wait loading the whole file (which may last minutes or even
657 hours even on fast machines) just to see that it was the wrong file. */
660 read_packet(cf, dfcode, create_proto_tree, cinfo, data_offset);
663 CATCH(OutOfMemoryError) {
664 simple_message_box(ESD_TYPE_ERROR, NULL,
665 "Some infos / workarounds can be found at:\n"
666 "http://wiki.wireshark.org/KnownBugs/OutOfMemory",
667 "Sorry, but Wireshark has run out of memory and has to terminate now!");
669 /* Could we close the current capture and free up memory from that? */
671 /* we have to terminate, as we cannot recover from the memory error */
677 /* Free the display name */
680 /* Cleanup and release all dfilter resources */
681 if (dfcode != NULL) {
682 dfilter_free(dfcode);
685 /* We're done reading the file; destroy the progress bar if it was created. */
687 destroy_progress_dlg(progbar);
689 /* We're done reading sequentially through the file. */
690 cf->state = FILE_READ_DONE;
692 /* Close the sequential I/O side, to free up memory it requires. */
693 wtap_sequential_close(cf->wth);
695 /* Allow the protocol dissectors to free up memory that they
696 * don't need after the sequential run-through of the packets. */
697 postseq_cleanup_all_protocols();
699 /* compute the time it took to load the file */
700 compute_elapsed(&start_time);
702 /* Set the file encapsulation type now; we don't know what it is until
703 we've looked at all the packets, as we don't know until then whether
704 there's more than one type (and thus whether it's
705 WTAP_ENCAP_PER_PACKET). */
706 cf->lnk_t = wtap_file_encap(cf->wth);
708 cf->current_frame = frame_data_sequence_find(cf->frames, cf->first_displayed);
713 cf_callback_invoke(cf_cb_file_reload_finished, cf);
715 cf_callback_invoke(cf_cb_file_read_finished, cf);
717 /* If we have any displayed packets to select, select the first of those
718 packets by making the first row the selected row. */
719 if (cf->first_displayed != 0) {
720 packet_list_select_first_row();
724 simple_message_box(ESD_TYPE_WARN, NULL,
725 "The remaining packets in the file were discarded.\n"
727 "As a lot of packets from the original file will be missing,\n"
728 "remember to be careful when saving the current content to a file.\n",
729 "File loading was cancelled!");
730 return CF_READ_ERROR;
734 /* Put up a message box noting that the read failed somewhere along
735 the line. Don't throw out the stuff we managed to read, though,
739 case WTAP_ERR_UNSUPPORTED:
740 simple_error_message_box(
741 "The capture file contains record data that Wireshark doesn't support.\n(%s)",
746 case WTAP_ERR_UNSUPPORTED_ENCAP:
747 simple_error_message_box(
748 "The capture file has a packet with a network type that Wireshark doesn't support.\n(%s)",
753 case WTAP_ERR_CANT_READ:
754 simple_error_message_box(
755 "An attempt to read from the capture file failed for"
756 " some unknown reason.");
759 case WTAP_ERR_SHORT_READ:
760 simple_error_message_box(
761 "The capture file appears to have been cut short"
762 " in the middle of a packet.");
765 case WTAP_ERR_BAD_FILE:
766 simple_error_message_box(
767 "The capture file appears to be damaged or corrupt.\n(%s)",
772 case WTAP_ERR_DECOMPRESS:
773 simple_error_message_box(
774 "The compressed capture file appears to be damaged or corrupt.\n"
780 simple_error_message_box(
781 "An error occurred while reading the"
782 " capture file: %s.", wtap_strerror(err));
785 return CF_READ_ERROR;
792 cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err)
794 cf_status_t cf_status;
796 cf_status = cf_open(cf, fname, is_tempfile, err);
801 cf_continue_tail(capture_file *cf, volatile int to_read, int *err)
804 int newly_displayed_packets = 0;
806 volatile gboolean create_proto_tree;
810 /* Compile the current display filter.
811 * We assume this will not fail since cf->dfilter is only set in
812 * cf_filter IFF the filter was valid.
814 compiled = dfilter_compile(cf->dfilter, &dfcode);
815 g_assert(!cf->dfilter || (compiled && dfcode));
817 /* Get the union of the flags for all tap listeners. */
818 tap_flags = union_of_tap_listener_flags();
820 (dfcode != NULL || have_filtering_tap_listeners() || (tap_flags & TL_REQUIRES_PROTO_TREE));
824 packet_list_check_end();
825 /* Don't freeze/thaw the list when doing live capture */
826 /*packet_list_freeze();*/
828 /*g_log(NULL, G_LOG_LEVEL_MESSAGE, "cf_continue_tail: %u new: %u", cf->count, to_read);*/
831 gint64 data_offset = 0;
834 cinfo = (tap_flags & TL_REQUIRES_COLUMNS) ? &cf->cinfo : NULL;
836 while (to_read != 0) {
837 wtap_cleareof(cf->wth);
838 if (!wtap_read(cf->wth, err, &err_info, &data_offset)) {
841 if (cf->state == FILE_READ_ABORTED) {
842 /* Well, the user decided to exit Wireshark. Break out of the
843 loop, and let the code below (which is called even if there
844 aren't any packets left to read) exit. */
847 if (read_packet(cf, dfcode, create_proto_tree, (column_info *) cinfo, data_offset) != -1) {
848 newly_displayed_packets++;
853 CATCH(OutOfMemoryError) {
854 simple_message_box(ESD_TYPE_ERROR, NULL,
855 "Some infos / workarounds can be found at:\n"
856 "http://wiki.wireshark.org/KnownBugs/OutOfMemory",
857 "Sorry, but Wireshark has run out of memory and has to terminate now!");
859 /* Could we close the current capture and free up memory from that? */
860 return CF_READ_ABORTED;
862 /* we have to terminate, as we cannot recover from the memory error */
868 /* Update the file encapsulation; it might have changed based on the
869 packets we've read. */
870 cf->lnk_t = wtap_file_encap(cf->wth);
872 /* Cleanup and release all dfilter resources */
873 if (dfcode != NULL) {
874 dfilter_free(dfcode);
877 /*g_log(NULL, G_LOG_LEVEL_MESSAGE, "cf_continue_tail: count %u state: %u err: %u",
878 cf->count, cf->state, *err);*/
880 /* Don't freeze/thaw the list when doing live capture */
881 /*packet_list_thaw();*/
882 /* With the new packet list the first packet
883 * isn't automatically selected.
885 if (!cf->current_frame)
886 packet_list_select_first_row();
888 /* moving to the end of the packet list - if the user requested so and
889 we have some new packets. */
890 if (newly_displayed_packets && auto_scroll_live && cf->count != 0)
891 packet_list_moveto_end();
893 if (cf->state == FILE_READ_ABORTED) {
894 /* Well, the user decided to exit Wireshark. Return CF_READ_ABORTED
895 so that our caller can kill off the capture child process;
896 this will cause an EOF on the pipe from the child, so
897 "cf_finish_tail()" will be called, and it will clean up
899 return CF_READ_ABORTED;
900 } else if (*err != 0) {
901 /* We got an error reading the capture file.
902 XXX - pop up a dialog box instead? */
903 g_warning("Error \"%s\" while reading: \"%s\" (\"%s\")",
904 wtap_strerror(*err), err_info, cf->filename);
907 return CF_READ_ERROR;
913 cf_fake_continue_tail(capture_file *cf) {
914 cf->state = FILE_READ_DONE;
918 cf_finish_tail(capture_file *cf, int *err)
924 gboolean create_proto_tree;
928 /* Compile the current display filter.
929 * We assume this will not fail since cf->dfilter is only set in
930 * cf_filter IFF the filter was valid.
932 compiled = dfilter_compile(cf->dfilter, &dfcode);
933 g_assert(!cf->dfilter || (compiled && dfcode));
935 /* Get the union of the flags for all tap listeners. */
936 tap_flags = union_of_tap_listener_flags();
937 cinfo = (tap_flags & TL_REQUIRES_COLUMNS) ? &cf->cinfo : NULL;
939 (dfcode != NULL || have_filtering_tap_listeners() || (tap_flags & TL_REQUIRES_PROTO_TREE));
941 if (cf->wth == NULL) {
943 return CF_READ_ERROR;
946 packet_list_check_end();
947 /* Don't freeze/thaw the list when doing live capture */
948 /*packet_list_freeze();*/
950 while ((wtap_read(cf->wth, err, &err_info, &data_offset))) {
951 if (cf->state == FILE_READ_ABORTED) {
952 /* Well, the user decided to abort the read. Break out of the
953 loop, and let the code below (which is called even if there
954 aren't any packets left to read) exit. */
957 read_packet(cf, dfcode, create_proto_tree, cinfo, data_offset);
960 /* Cleanup and release all dfilter resources */
961 if (dfcode != NULL) {
962 dfilter_free(dfcode);
965 /* Don't freeze/thaw the list when doing live capture */
966 /*packet_list_thaw();*/
968 if (cf->state == FILE_READ_ABORTED) {
969 /* Well, the user decided to abort the read. We're only called
970 when the child capture process closes the pipe to us (meaning
971 it's probably exited), so we can just close the capture
972 file; we return CF_READ_ABORTED so our caller can do whatever
973 is appropriate when that happens. */
975 return CF_READ_ABORTED;
978 if (auto_scroll_live && cf->count != 0)
979 packet_list_moveto_end();
981 /* We're done reading sequentially through the file. */
982 cf->state = FILE_READ_DONE;
984 /* We're done reading sequentially through the file; close the
985 sequential I/O side, to free up memory it requires. */
986 wtap_sequential_close(cf->wth);
988 /* Allow the protocol dissectors to free up memory that they
989 * don't need after the sequential run-through of the packets. */
990 postseq_cleanup_all_protocols();
992 /* Update the file encapsulation; it might have changed based on the
993 packets we've read. */
994 cf->lnk_t = wtap_file_encap(cf->wth);
996 /* Update the details in the file-set dialog, as the capture file
997 * has likely grown since we first stat-ed it */
998 fileset_update_file(cf->filename);
1001 /* We got an error reading the capture file.
1002 XXX - pop up a dialog box? */
1004 g_warning("Error \"%s\" while reading: \"%s\" (\"%s\")",
1005 wtap_strerror(*err), err_info, cf->filename);
1007 return CF_READ_ERROR;
1012 #endif /* HAVE_LIBPCAP */
1015 cf_get_display_name(capture_file *cf)
1019 /* Return a name to use in displays */
1020 if (!cf->is_tempfile) {
1021 /* Get the last component of the file name, and use that. */
1023 displayname = g_filename_display_basename(cf->filename);
1025 displayname=g_strdup("(No file)");
1028 /* The file we read is a temporary file from a live capture or
1029 a merge operation; we don't mention its name, but, if it's
1030 from a capture, give the source of the capture. */
1032 displayname = g_strdup(cf->source);
1034 displayname = g_strdup("(Untitled)");
1040 void cf_set_tempfile_source(capture_file *cf, gchar *source) {
1046 cf->source = g_strdup(source);
1048 cf->source = g_strdup("");
1052 const gchar *cf_get_tempfile_source(capture_file *cf) {
1060 /* XXX - use a macro instead? */
1062 cf_get_packet_count(capture_file *cf)
1067 /* XXX - use a macro instead? */
1069 cf_set_packet_count(capture_file *cf, int packet_count)
1071 cf->count = packet_count;
1074 /* XXX - use a macro instead? */
1076 cf_is_tempfile(capture_file *cf)
1078 return cf->is_tempfile;
1081 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile)
1083 cf->is_tempfile = is_tempfile;
1087 /* XXX - use a macro instead? */
1088 void cf_set_drops_known(capture_file *cf, gboolean drops_known)
1090 cf->drops_known = drops_known;
1093 /* XXX - use a macro instead? */
1094 void cf_set_drops(capture_file *cf, guint32 drops)
1099 /* XXX - use a macro instead? */
1100 gboolean cf_get_drops_known(capture_file *cf)
1102 return cf->drops_known;
1105 /* XXX - use a macro instead? */
1106 guint32 cf_get_drops(capture_file *cf)
1111 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode)
1113 cf->rfcode = rfcode;
1117 add_packet_to_packet_list(frame_data *fdata, capture_file *cf,
1118 dfilter_t *dfcode, gboolean create_proto_tree, column_info *cinfo,
1119 struct wtap_pkthdr *phdr, const guint8 *buf, gboolean add_to_packet_list)
1124 frame_data_set_before_dissect(fdata, &cf->elapsed_time,
1125 &first_ts, prev_dis, prev_cap);
1128 /* Dissect the frame. */
1129 epan_dissect_init(&edt, create_proto_tree, FALSE);
1131 if (dfcode != NULL) {
1132 epan_dissect_prime_dfilter(&edt, dfcode);
1135 epan_dissect_run_with_taps(&edt, phdr, buf, fdata, cinfo);
1137 /* If we don't have a display filter, set "passed_dfilter" to 1. */
1138 if (dfcode != NULL) {
1139 fdata->flags.passed_dfilter = dfilter_apply_edt(dfcode, &edt) ? 1 : 0;
1141 if (fdata->flags.passed_dfilter) {
1142 /* This frame passed the display filter but it may depend on other
1143 * (potentially not displayed) frames. Find those frames and mark them
1146 g_slist_foreach(edt.pi.dependent_frames, find_and_mark_frame_depended_upon, cf->frames);
1149 fdata->flags.passed_dfilter = 1;
1151 if (fdata->flags.passed_dfilter || fdata->flags.ref_time)
1152 cf->displayed_count++;
1154 if (add_to_packet_list) {
1155 /* We fill the needed columns from new_packet_list */
1156 row = packet_list_append(cinfo, fdata, &edt.pi);
1159 if (fdata->flags.passed_dfilter || fdata->flags.ref_time)
1161 frame_data_set_after_dissect(fdata, &cum_bytes);
1164 /* If we haven't yet seen the first frame, this is it.
1166 XXX - we must do this before we add the row to the display,
1167 as, if the display's GtkCList's selection mode is
1168 GTK_SELECTION_BROWSE, when the first entry is added to it,
1169 "cf_select_packet()" will be called, and it will fetch the row
1170 data for the 0th row, and will get a null pointer rather than
1171 "fdata", as "gtk_clist_append()" won't yet have returned and
1172 thus "gtk_clist_set_row_data()" won't yet have been called.
1174 We thus need to leave behind bread crumbs so that
1175 "cf_select_packet()" can find this frame. See the comment
1176 in "cf_select_packet()". */
1177 if (cf->first_displayed == 0)
1178 cf->first_displayed = fdata->num;
1180 /* This is the last frame we've seen so far. */
1181 cf->last_displayed = fdata->num;
1184 epan_dissect_cleanup(&edt);
1188 /* read in a new packet */
1189 /* returns the row of the new packet in the packet list or -1 if not displayed */
1191 read_packet(capture_file *cf, dfilter_t *dfcode,
1192 gboolean create_proto_tree, column_info *cinfo, gint64 offset)
1194 struct wtap_pkthdr *phdr = wtap_phdr(cf->wth);
1195 const guint8 *buf = wtap_buf_ptr(cf->wth);
1202 /* Add this packet's link-layer encapsulation type to cf->linktypes, if
1203 it's not already there.
1204 XXX - yes, this is O(N), so if every packet had a different
1205 link-layer encapsulation type, it'd be O(N^2) to read the file, but
1206 there are probably going to be a small number of encapsulation types
1208 cf_add_encapsulation_type(cf, phdr->pkt_encap);
1210 /* The frame number of this packet is one more than the count of
1211 frames in the file so far. */
1212 framenum = cf->count + 1;
1214 frame_data_init(&fdlocal, framenum, phdr, offset, cum_bytes);
1219 epan_dissect_init(&edt, TRUE, FALSE);
1220 epan_dissect_prime_dfilter(&edt, cf->rfcode);
1221 epan_dissect_run(&edt, phdr, buf, &fdlocal, NULL);
1222 passed = dfilter_apply_edt(cf->rfcode, &edt);
1223 epan_dissect_cleanup(&edt);
1227 /* This does a shallow copy of fdlocal, which is good enough. */
1228 fdata = frame_data_sequence_add(cf->frames, &fdlocal);
1231 if (fdlocal.opt_comment != NULL)
1232 cf->packet_comment_count++;
1233 cf->f_datalen = offset + fdlocal.cap_len;
1235 if (!cf->redissecting) {
1236 row = add_packet_to_packet_list(fdata, cf, dfcode,
1237 create_proto_tree, cinfo,
1246 cf_merge_files(char **out_filenamep, int in_file_count,
1247 char *const *in_filenames, int file_type, gboolean do_append)
1249 merge_in_file_t *in_files, *in_file;
1254 int open_err, read_err, write_err, close_err;
1258 gboolean got_read_error = FALSE, got_write_error = FALSE;
1260 progdlg_t *progbar = NULL;
1262 gint64 f_len, file_pos;
1264 GTimeVal start_time;
1265 gchar status_str[100];
1266 gint64 progbar_nextstep;
1267 gint64 progbar_quantum;
1268 gchar *display_basename;
1269 int selected_frame_type;
1270 gboolean fake_interface_ids = FALSE;
1272 /* open the input files */
1273 if (!merge_open_in_files(in_file_count, in_filenames, &in_files,
1274 &open_err, &err_info, &err_fileno)) {
1276 cf_open_failure_alert_box(in_filenames[err_fileno], open_err, err_info,
1281 if (*out_filenamep != NULL) {
1282 out_filename = *out_filenamep;
1283 out_fd = ws_open(out_filename, O_CREAT|O_TRUNC|O_BINARY, 0600);
1287 out_fd = create_tempfile(&tmpname, "wireshark");
1290 out_filename = g_strdup(tmpname);
1291 *out_filenamep = out_filename;
1295 merge_close_in_files(in_file_count, in_files);
1297 cf_open_failure_alert_box(out_filename, open_err, NULL, TRUE, file_type);
1301 selected_frame_type = merge_select_frame_type(in_file_count, in_files);
1303 /* If we are trying to merge a number of libpcap files with different encapsulation types
1304 * change the output file type to pcapng and create SHB and IDB:s for the new file use the
1305 * interface index stored in in_files per file to change the phdr before writing the datablock.
1306 * XXX should it be an option to convert to pcapng?
1308 * We need something similar when merging pcapng files possibly with an option to say
1309 * the same interface(s) used in all in files. SHBs comments should be merged together.
1311 if ((selected_frame_type == WTAP_ENCAP_PER_PACKET)&&(file_type == WTAP_FILE_PCAP)) {
1312 /* Write output in pcapng format */
1313 wtapng_section_t *shb_hdr;
1314 wtapng_iface_descriptions_t *idb_inf, *idb_inf_merge_file;
1315 wtapng_if_descr_t int_data, *file_int_data;
1316 GString *comment_gstr;
1318 fake_interface_ids = TRUE;
1319 /* Create SHB info */
1320 shb_hdr = wtap_file_get_shb_info(in_files[0].wth);
1321 comment_gstr = g_string_new("");
1322 g_string_append_printf(comment_gstr, "%s \n",shb_hdr->opt_comment);
1323 g_string_append_printf(comment_gstr, "File created by merging: \n");
1324 file_type = WTAP_FILE_PCAPNG;
1326 for (i = 0; i < in_file_count; i++) {
1327 g_string_append_printf(comment_gstr, "File%d: %s \n",i+1,in_files[i].filename);
1329 shb_hdr->section_length = -1;
1331 shb_hdr->opt_comment = g_string_free(comment_gstr, FALSE); /* NULL if not available */
1332 shb_hdr->shb_hardware = NULL; /* NULL if not available, UTF-8 string containing the */
1333 /* description of the hardware used to create this section. */
1334 shb_hdr->shb_os = NULL; /* NULL if not available, UTF-8 string containing the name */
1335 /* of the operating system used to create this section. */
1336 shb_hdr->shb_user_appl = "Wireshark"; /* NULL if not available, UTF-8 string containing the name */
1337 /* of the application used to create this section. */
1339 /* create fake IDB info */
1340 idb_inf = g_new(wtapng_iface_descriptions_t,1);
1341 idb_inf->number_of_interfaces = in_file_count; /* TODO make this the number of DIFFERENT encapsulation types
1342 * check that snaplength is the same too?
1344 idb_inf->interface_data = g_array_new(FALSE, FALSE, sizeof(wtapng_if_descr_t));
1346 for (i = 0; i < in_file_count; i++) {
1347 idb_inf_merge_file = wtap_file_get_idb_info(in_files[i].wth);
1348 /* read the interface data from the in file to our combined interfca data */
1349 file_int_data = &g_array_index (idb_inf_merge_file->interface_data, wtapng_if_descr_t, 0);
1350 int_data.wtap_encap = file_int_data->wtap_encap;
1351 int_data.time_units_per_second = file_int_data->time_units_per_second;
1352 int_data.link_type = file_int_data->link_type;
1353 int_data.snap_len = file_int_data->snap_len;
1354 int_data.if_name = g_strdup(file_int_data->if_name);
1355 int_data.opt_comment = NULL;
1356 int_data.if_description = NULL;
1357 int_data.if_speed = 0;
1358 int_data.if_tsresol = 6;
1359 int_data.if_filter_str = NULL;
1360 int_data.bpf_filter_len = 0;
1361 int_data.if_filter_bpf_bytes = NULL;
1362 int_data.if_os = NULL;
1363 int_data.if_fcslen = -1;
1364 int_data.num_stat_entries = 0; /* Number of ISB:s */
1365 int_data.interface_statistics = NULL;
1367 g_array_append_val(idb_inf->interface_data, int_data);
1368 g_free(idb_inf_merge_file);
1370 /* Set fake interface Id in per file data */
1371 in_files[i].interface_id = i;
1374 pdh = wtap_dump_fdopen_ng(out_fd, file_type,
1375 selected_frame_type,
1376 merge_max_snapshot_length(in_file_count, in_files),
1377 FALSE /* compressed */, shb_hdr, idb_inf /* wtapng_iface_descriptions_t *idb_inf */, &open_err);
1381 merge_close_in_files(in_file_count, in_files);
1383 cf_open_failure_alert_box(out_filename, open_err, err_info, TRUE,
1390 pdh = wtap_dump_fdopen(out_fd, file_type,
1391 selected_frame_type,
1392 merge_max_snapshot_length(in_file_count, in_files),
1393 FALSE /* compressed */, &open_err);
1396 merge_close_in_files(in_file_count, in_files);
1398 cf_open_failure_alert_box(out_filename, open_err, err_info, TRUE,
1404 /* Get the sum of the sizes of all the files. */
1406 for (i = 0; i < in_file_count; i++)
1407 f_len += in_files[i].size;
1409 /* Update the progress bar when it gets to this value. */
1410 progbar_nextstep = 0;
1411 /* When we reach the value that triggers a progress bar update,
1412 bump that value by this amount. */
1413 progbar_quantum = f_len/N_PROGBAR_UPDATES;
1414 /* Progress so far. */
1418 g_get_current_time(&start_time);
1420 /* do the merge (or append) */
1423 in_file = merge_append_read_packet(in_file_count, in_files, &read_err,
1426 in_file = merge_read_packet(in_file_count, in_files, &read_err,
1428 if (in_file == NULL) {
1433 if (read_err != 0) {
1434 /* I/O error reading from in_file */
1435 got_read_error = TRUE;
1439 /* Get the sum of the data offsets in all of the files. */
1441 for (i = 0; i < in_file_count; i++)
1442 data_offset += in_files[i].data_offset;
1444 /* Create the progress bar if necessary.
1445 We check on every iteration of the loop, so that it takes no
1446 longer than the standard time to create it (otherwise, for a
1447 large file, we might take considerably longer than that standard
1448 time in order to get to the next progress bar step). */
1449 if (progbar == NULL) {
1450 progbar = delayed_create_progress_dlg(NULL, "Merging", "files",
1451 FALSE, &stop_flag, &start_time, progbar_val);
1454 /* Update the progress bar, but do it only N_PROGBAR_UPDATES times;
1455 when we update it, we have to run the GTK+ main loop to get it
1456 to repaint what's pending, and doing so may involve an "ioctl()"
1457 to see if there's any pending input from an X server, and doing
1458 that for every packet can be costly, especially on a big file. */
1459 if (data_offset >= progbar_nextstep) {
1460 /* Get the sum of the seek positions in all of the files. */
1462 for (i = 0; i < in_file_count; i++)
1463 file_pos += wtap_read_so_far(in_files[i].wth);
1464 progbar_val = (gfloat) file_pos / (gfloat) f_len;
1465 if (progbar_val > 1.0f) {
1466 /* Some file probably grew while we were reading it.
1467 That "shouldn't happen", so we'll just clip the progress
1471 if (progbar != NULL) {
1472 g_snprintf(status_str, sizeof(status_str),
1473 "%" G_GINT64_MODIFIER "dKB of %" G_GINT64_MODIFIER "dKB",
1474 file_pos / 1024, f_len / 1024);
1475 update_progress_dlg(progbar, progbar_val, status_str);
1477 progbar_nextstep += progbar_quantum;
1481 /* Well, the user decided to abort the merge. */
1485 /* If we have WTAP_ENCAP_PER_PACKETend the infiles are of type WTAP_FILE_PCAP
1486 * we need to set the interface id in the paket header = the interface index we used
1487 * in the IDBs interface description for this file(encapsulation type).
1489 if (fake_interface_ids) {
1490 struct wtap_pkthdr *phdr;
1492 phdr = wtap_phdr(in_file->wth);
1493 phdr->interface_id = in_file->interface_id;
1494 phdr->presence_flags = phdr->presence_flags | WTAP_HAS_INTERFACE_ID;
1496 if (!wtap_dump(pdh, wtap_phdr(in_file->wth),
1497 wtap_buf_ptr(in_file->wth), &write_err)) {
1498 got_write_error = TRUE;
1503 /* We're done merging the files; destroy the progress bar if it was created. */
1504 if (progbar != NULL)
1505 destroy_progress_dlg(progbar);
1507 merge_close_in_files(in_file_count, in_files);
1508 if (!got_read_error && !got_write_error) {
1509 if (!wtap_dump_close(pdh, &write_err))
1510 got_write_error = TRUE;
1512 wtap_dump_close(pdh, &close_err);
1514 if (got_read_error) {
1516 * Find the file on which we got the error, and report the error.
1518 for (i = 0; i < in_file_count; i++) {
1519 if (in_files[i].state == GOT_ERROR) {
1520 /* Put up a message box noting that a read failed somewhere along
1522 display_basename = g_filename_display_basename(in_files[i].filename);
1525 case WTAP_ERR_UNSUPPORTED_ENCAP:
1526 simple_error_message_box(
1527 "The capture file %s has a packet with a network type that Wireshark doesn't support.\n(%s)",
1528 display_basename, err_info);
1532 case WTAP_ERR_CANT_READ:
1533 simple_error_message_box(
1534 "An attempt to read from the capture file %s failed for"
1535 " some unknown reason.", display_basename);
1538 case WTAP_ERR_SHORT_READ:
1539 simple_error_message_box(
1540 "The capture file %s appears to have been cut short"
1541 " in the middle of a packet.", display_basename);
1544 case WTAP_ERR_BAD_FILE:
1545 simple_error_message_box(
1546 "The capture file %s appears to be damaged or corrupt.\n(%s)",
1547 display_basename, err_info);
1551 case WTAP_ERR_DECOMPRESS:
1552 simple_error_message_box(
1553 "The compressed capture file %s appears to be damaged or corrupt.\n"
1554 "(%s)", display_basename, err_info);
1559 simple_error_message_box(
1560 "An error occurred while reading the"
1561 " capture file %s: %s.",
1562 display_basename, wtap_strerror(read_err));
1565 g_free(display_basename);
1570 if (got_write_error) {
1571 /* Put up an alert box for the write error. */
1572 if (write_err < 0) {
1573 /* Wiretap error. */
1574 switch (write_err) {
1576 case WTAP_ERR_UNSUPPORTED_ENCAP:
1578 * This is a problem with the particular frame we're writing;
1579 * note that, and give the frame number.
1581 display_basename = g_filename_display_basename(in_file->filename);
1582 simple_error_message_box(
1583 "Frame %u of \"%s\" has a network type that can't be saved in a \"%s\" file.",
1584 in_file->packet_num, display_basename,
1585 wtap_file_type_string(file_type));
1586 g_free(display_basename);
1590 display_basename = g_filename_display_basename(out_filename);
1591 simple_error_message_box(
1592 "An error occurred while writing to the file \"%s\": %s.",
1593 out_filename, wtap_strerror(write_err));
1594 g_free(display_basename);
1599 write_failure_alert_box(out_filename, write_err);
1603 if (got_read_error || got_write_error || stop_flag) {
1604 /* Callers aren't expected to treat an error or an explicit abort
1605 differently - we put up error dialogs ourselves, so they don't
1613 cf_filter_packets(capture_file *cf, gchar *dftext, gboolean force)
1615 const char *filter_new = dftext ? dftext : "";
1616 const char *filter_old = cf->dfilter ? cf->dfilter : "";
1618 GTimeVal start_time;
1620 /* if new filter equals old one, do nothing unless told to do so */
1621 if (!force && strcmp(filter_new, filter_old) == 0) {
1627 if (dftext == NULL) {
1628 /* The new filter is an empty filter (i.e., display all packets).
1629 * so leave dfcode==NULL
1633 * We have a filter; make a copy of it (as we'll be saving it),
1634 * and try to compile it.
1636 dftext = g_strdup(dftext);
1637 if (!dfilter_compile(dftext, &dfcode)) {
1638 /* The attempt failed; report an error. */
1639 simple_message_box(ESD_TYPE_ERROR, NULL,
1640 "See the help for a description of the display filter syntax.",
1641 "\"%s\" isn't a valid display filter: %s",
1642 dftext, dfilter_error_msg);
1648 if (dfcode == NULL) {
1649 /* Yes - free the filter text, and set it to null. */
1655 /* We have a valid filter. Replace the current filter. */
1656 g_free(cf->dfilter);
1657 cf->dfilter = dftext;
1658 g_get_current_time(&start_time);
1661 /* Now rescan the packet list, applying the new filter, but not
1662 throwing away information constructed on a previous pass. */
1663 if (dftext == NULL) {
1664 rescan_packets(cf, "Resetting", "Filter", FALSE);
1666 rescan_packets(cf, "Filtering", dftext, FALSE);
1669 /* Cleanup and release all dfilter resources */
1670 dfilter_free(dfcode);
1676 cf_reftime_packets(capture_file *cf)
1678 ref_time_packets(cf);
1682 cf_redissect_packets(capture_file *cf)
1684 rescan_packets(cf, "Reprocessing", "all packets", TRUE);
1688 cf_read_frame_r(capture_file *cf, frame_data *fdata,
1689 struct wtap_pkthdr *phdr, Buffer *buf)
1693 gchar *display_basename;
1695 #ifdef WANT_PACKET_EDITOR
1696 /* if fdata->file_off == -1 it means packet was edited, and we must find data inside edited_frames tree */
1697 if (G_UNLIKELY(fdata->file_off == -1)) {
1698 const modified_frame_data *frame = (const modified_frame_data *) g_tree_lookup(cf->edited_frames, GINT_TO_POINTER(fdata->num));
1701 simple_error_message_box("fdata->file_off == -1, but can't find modified frame!");
1705 *phdr = frame->phdr;
1706 memcpy(pd, frame->pd, fdata->cap_len);
1711 if (!wtap_seek_read(cf->wth, fdata->file_off, phdr, buf,
1712 fdata->cap_len, &err, &err_info)) {
1713 display_basename = g_filename_display_basename(cf->filename);
1716 case WTAP_ERR_UNSUPPORTED_ENCAP:
1717 simple_error_message_box("The file \"%s\" has a packet with a network type that Wireshark doesn't support.\n(%s)",
1718 display_basename, err_info);
1722 case WTAP_ERR_BAD_FILE:
1723 simple_error_message_box("An error occurred while reading from the file \"%s\": %s.\n(%s)",
1724 display_basename, wtap_strerror(err), err_info);
1729 simple_error_message_box(
1730 "An error occurred while reading from the file \"%s\": %s.",
1731 display_basename, wtap_strerror(err));
1734 g_free(display_basename);
1741 cf_read_frame(capture_file *cf, frame_data *fdata)
1743 return cf_read_frame_r(cf, fdata, &cf->phdr, &cf->buf);
1746 /* Rescan the list of packets, reconstructing the CList.
1748 "action" describes why we're doing this; it's used in the progress
1751 "action_item" describes what we're doing; it's used in the progress
1754 "redissect" is TRUE if we need to make the dissectors reconstruct
1755 any state information they have (because a preference that affects
1756 some dissector has changed, meaning some dissector might construct
1757 its state differently from the way it was constructed the last time). */
1759 rescan_packets(capture_file *cf, const char *action, const char *action_item, gboolean redissect)
1761 /* Rescan packets new packet list */
1764 progdlg_t *progbar = NULL;
1767 frame_data *selected_frame, *preceding_frame, *following_frame, *prev_frame;
1768 int selected_frame_num, preceding_frame_num, following_frame_num, prev_frame_num;
1769 gboolean selected_frame_seen;
1771 GTimeVal start_time;
1772 gchar status_str[100];
1773 int progbar_nextstep;
1774 int progbar_quantum;
1777 gboolean create_proto_tree;
1779 gboolean add_to_packet_list = FALSE;
1781 guint32 frames_count;
1783 /* Compile the current display filter.
1784 * We assume this will not fail since cf->dfilter is only set in
1785 * cf_filter IFF the filter was valid.
1787 compiled = dfilter_compile(cf->dfilter, &dfcode);
1788 g_assert(!cf->dfilter || (compiled && dfcode));
1790 /* Get the union of the flags for all tap listeners. */
1791 tap_flags = union_of_tap_listener_flags();
1792 cinfo = (tap_flags & TL_REQUIRES_COLUMNS) ? &cf->cinfo : NULL;
1794 (dfcode != NULL || have_filtering_tap_listeners() || (tap_flags & TL_REQUIRES_PROTO_TREE));
1796 reset_tap_listeners();
1797 /* Which frame, if any, is the currently selected frame?
1798 XXX - should the selected frame or the focus frame be the "current"
1799 frame, that frame being the one from which "Find Frame" searches
1801 selected_frame = cf->current_frame;
1803 /* Mark frame num as not found */
1804 selected_frame_num = -1;
1806 /* Freeze the packet list while we redo it, so we don't get any
1807 screen updates while it happens. */
1808 packet_list_freeze();
1811 /* We need to re-initialize all the state information that protocols
1812 keep, because some preference that controls a dissector has changed,
1813 which might cause the state information to be constructed differently
1814 by that dissector. */
1816 /* We might receive new packets while redissecting, and we don't
1817 want to dissect those before their time. */
1818 cf->redissecting = TRUE;
1820 /* Cleanup all data structures used for dissection. */
1821 cleanup_dissection();
1822 /* Initialize all data structures used for dissection. */
1825 /* We need to redissect the packets so we have to discard our old
1826 * packet list store. */
1827 packet_list_clear();
1828 add_to_packet_list = TRUE;
1831 /* We don't yet know which will be the first and last frames displayed. */
1832 cf->first_displayed = 0;
1833 cf->last_displayed = 0;
1835 /* We currently don't display any packets */
1836 cf->displayed_count = 0;
1838 /* Iterate through the list of frames. Call a routine for each frame
1839 to check whether it should be displayed and, if so, add it to
1840 the display list. */
1841 nstime_set_unset(&first_ts);
1846 /* Update the progress bar when it gets to this value. */
1847 progbar_nextstep = 0;
1848 /* When we reach the value that triggers a progress bar update,
1849 bump that value by this amount. */
1850 progbar_quantum = cf->count/N_PROGBAR_UPDATES;
1851 /* Count of packets at which we've looked. */
1853 /* Progress so far. */
1857 g_get_current_time(&start_time);
1859 /* no previous row yet */
1860 prev_frame_num = -1;
1863 preceding_frame_num = -1;
1864 preceding_frame = NULL;
1865 following_frame_num = -1;
1866 following_frame = NULL;
1868 selected_frame_seen = FALSE;
1870 frames_count = cf->count;
1871 for (framenum = 1; framenum <= frames_count; framenum++) {
1872 fdata = frame_data_sequence_find(cf->frames, framenum);
1874 /* Create the progress bar if necessary.
1875 We check on every iteration of the loop, so that it takes no
1876 longer than the standard time to create it (otherwise, for a
1877 large file, we might take considerably longer than that standard
1878 time in order to get to the next progress bar step). */
1879 if (progbar == NULL)
1880 progbar = delayed_create_progress_dlg(cf->window, action, action_item, TRUE,
1881 &stop_flag, &start_time,
1884 /* Update the progress bar, but do it only N_PROGBAR_UPDATES times;
1885 when we update it, we have to run the GTK+ main loop to get it
1886 to repaint what's pending, and doing so may involve an "ioctl()"
1887 to see if there's any pending input from an X server, and doing
1888 that for every packet can be costly, especially on a big file. */
1889 if (count >= progbar_nextstep) {
1890 /* let's not divide by zero. I should never be started
1891 * with count == 0, so let's assert that
1893 g_assert(cf->count > 0);
1894 progbar_val = (gfloat) count / frames_count;
1896 if (progbar != NULL) {
1897 g_snprintf(status_str, sizeof(status_str),
1898 "%4u of %u frames", count, frames_count);
1899 update_progress_dlg(progbar, progbar_val, status_str);
1902 progbar_nextstep += progbar_quantum;
1906 /* Well, the user decided to abort the filtering. Just stop.
1908 XXX - go back to the previous filter? Users probably just
1909 want not to wait for a filtering operation to finish;
1910 unless we cancel by having no filter, reverting to the
1911 previous filter will probably be even more expensive than
1912 continuing the filtering, as it involves going back to the
1913 beginning and filtering, and even with no filter we currently
1914 have to re-generate the entire clist, which is also expensive.
1916 I'm not sure what Network Monitor does, but it doesn't appear
1917 to give you an unfiltered display if you cancel. */
1924 /* Since all state for the frame was destroyed, mark the frame
1925 * as not visited, free the GSList referring to the state
1926 * data (the per-frame data itself was freed by
1927 * "init_dissection()"), and null out the GSList pointer. */
1928 frame_data_reset(fdata);
1929 frames_count = cf->count;
1932 /* Frame dependencies from the previous dissection/filtering are no longer valid. */
1933 fdata->flags.dependent_of_displayed = 0;
1935 if (!cf_read_frame(cf, fdata))
1936 break; /* error reading the frame */
1938 /* If the previous frame is displayed, and we haven't yet seen the
1939 selected frame, remember that frame - it's the closest one we've
1940 yet seen before the selected frame. */
1941 if (prev_frame_num != -1 && !selected_frame_seen && prev_frame->flags.passed_dfilter) {
1942 preceding_frame_num = prev_frame_num;
1943 preceding_frame = prev_frame;
1945 add_packet_to_packet_list(fdata, cf, dfcode, create_proto_tree,
1947 buffer_start_ptr(&cf->buf),
1948 add_to_packet_list);
1950 /* If this frame is displayed, and this is the first frame we've
1951 seen displayed after the selected frame, remember this frame -
1952 it's the closest one we've yet seen at or after the selected
1954 if (fdata->flags.passed_dfilter && selected_frame_seen && following_frame_num == -1) {
1955 following_frame_num = fdata->num;
1956 following_frame = fdata;
1958 if (fdata == selected_frame) {
1959 selected_frame_seen = TRUE;
1960 if (fdata->flags.passed_dfilter)
1961 selected_frame_num = fdata->num;
1964 /* Remember this frame - it'll be the previous frame
1965 on the next pass through the loop. */
1966 prev_frame_num = fdata->num;
1970 /* We are done redissecting the packet list. */
1971 cf->redissecting = FALSE;
1974 frames_count = cf->count;
1975 /* Clear out what remains of the visited flags and per-frame data
1978 XXX - that may cause various forms of bogosity when dissecting
1979 these frames, as they won't have been seen by this sequential
1980 pass, but the only alternative I see is to keep scanning them
1981 even though the user requested that the scan stop, and that
1982 would leave the user stuck with an Wireshark grinding on
1983 until it finishes. Should we just stick them with that? */
1984 for (; framenum <= frames_count; framenum++) {
1985 fdata = frame_data_sequence_find(cf->frames, framenum);
1986 frame_data_reset(fdata);
1990 /* We're done filtering the packets; destroy the progress bar if it
1992 if (progbar != NULL)
1993 destroy_progress_dlg(progbar);
1995 /* Unfreeze the packet list. */
1996 if (!add_to_packet_list)
1997 packet_list_recreate_visible_rows();
1999 /* Compute the time it took to filter the file */
2000 compute_elapsed(&start_time);
2004 if (selected_frame_num == -1) {
2005 /* The selected frame didn't pass the filter. */
2006 if (selected_frame == NULL) {
2007 /* That's because there *was* no selected frame. Make the first
2008 displayed frame the current frame. */
2009 selected_frame_num = 0;
2011 /* Find the nearest displayed frame to the selected frame (whether
2012 it's before or after that frame) and make that the current frame.
2013 If the next and previous displayed frames are equidistant from the
2014 selected frame, choose the next one. */
2015 g_assert(following_frame == NULL ||
2016 following_frame->num >= selected_frame->num);
2017 g_assert(preceding_frame == NULL ||
2018 preceding_frame->num <= selected_frame->num);
2019 if (following_frame == NULL) {
2020 /* No frame after the selected frame passed the filter, so we
2021 have to select the last displayed frame before the selected
2023 selected_frame_num = preceding_frame_num;
2024 selected_frame = preceding_frame;
2025 } else if (preceding_frame == NULL) {
2026 /* No frame before the selected frame passed the filter, so we
2027 have to select the first displayed frame after the selected
2029 selected_frame_num = following_frame_num;
2030 selected_frame = following_frame;
2032 /* Frames before and after the selected frame passed the filter, so
2033 we'll select the previous frame */
2034 selected_frame_num = preceding_frame_num;
2035 selected_frame = preceding_frame;
2040 if (selected_frame_num == -1) {
2041 /* There are no frames displayed at all. */
2042 cf_unselect_packet(cf);
2044 /* Either the frame that was selected passed the filter, or we've
2045 found the nearest displayed frame to that frame. Select it, make
2046 it the focus row, and make it visible. */
2047 /* Set to invalid to force update of packet list and packet details */
2048 cf->current_row = -1;
2049 if (selected_frame_num == 0) {
2050 packet_list_select_first_row();
2052 if (!packet_list_select_row_from_data(selected_frame)) {
2053 /* We didn't find a row corresponding to this frame.
2054 This means that the frame isn't being displayed currently,
2055 so we can't select it. */
2056 simple_message_box(ESD_TYPE_INFO, NULL,
2057 "The capture file is probably not fully dissected.",
2058 "End of capture exceeded!");
2063 /* Cleanup and release all dfilter resources */
2064 dfilter_free(dfcode);
2069 * Scan trough all frame data and recalculate the ref time
2070 * without rereading the file.
2071 * XXX - do we need a progres bar or is this fast enough?
2074 ref_time_packets(capture_file *cf)
2079 nstime_set_unset(&first_ts);
2083 for (framenum = 1; framenum <= cf->count; framenum++) {
2084 fdata = frame_data_sequence_find(cf->frames, framenum);
2086 /* just add some value here until we know if it is being displayed or not */
2087 fdata->cum_bytes = cum_bytes + fdata->pkt_len;
2093 /* If we don't have the time stamp of the first packet in the
2094 capture, it's because this is the first packet. Save the time
2095 stamp of this packet as the time stamp of the first packet. */
2096 if (nstime_is_unset(&first_ts)) {
2097 first_ts = fdata->abs_ts;
2099 /* if this frames is marked as a reference time frame, reset
2100 firstsec and firstusec to this frame */
2101 if (fdata->flags.ref_time) {
2102 first_ts = fdata->abs_ts;
2105 /* If we don't have the time stamp of the previous displayed packet,
2106 it's because this is the first displayed packet. Save the time
2107 stamp of this packet as the time stamp of the previous displayed
2109 if (prev_dis == NULL) {
2113 /* Get the time elapsed between the first packet and this packet. */
2114 nstime_delta(&fdata->rel_ts, &fdata->abs_ts, &first_ts);
2116 /* If it's greater than the current elapsed time, set the elapsed time
2117 to it (we check for "greater than" so as not to be confused by
2118 time moving backwards). */
2119 if ((gint32)cf->elapsed_time.secs < fdata->rel_ts.secs
2120 || ((gint32)cf->elapsed_time.secs == fdata->rel_ts.secs && (gint32)cf->elapsed_time.nsecs < fdata->rel_ts.nsecs)) {
2121 cf->elapsed_time = fdata->rel_ts;
2124 /* If this frame is displayed, get the time elapsed between the
2125 previous displayed packet and this packet. */
2126 if ( fdata->flags.passed_dfilter ) {
2127 fdata->prev_dis = prev_dis;
2134 if ( (fdata->flags.passed_dfilter) || (fdata->flags.ref_time) ) {
2135 /* This frame either passed the display filter list or is marked as
2136 a time reference frame. All time reference frames are displayed
2137 even if they dont pass the display filter */
2138 if (fdata->flags.ref_time) {
2139 /* if this was a TIME REF frame we should reset the cum_bytes field */
2140 cum_bytes = fdata->pkt_len;
2141 fdata->cum_bytes = cum_bytes;
2143 /* increase cum_bytes with this packets length */
2144 cum_bytes += fdata->pkt_len;
2157 process_specified_packets(capture_file *cf, packet_range_t *range,
2158 const char *string1, const char *string2, gboolean terminate_is_stop,
2159 gboolean (*callback)(capture_file *, frame_data *,
2160 struct wtap_pkthdr *, const guint8 *, void *),
2161 void *callback_args)
2166 psp_return_t ret = PSP_FINISHED;
2168 progdlg_t *progbar = NULL;
2171 gboolean progbar_stop_flag;
2172 GTimeVal progbar_start_time;
2173 gchar progbar_status_str[100];
2174 int progbar_nextstep;
2175 int progbar_quantum;
2176 range_process_e process_this;
2177 struct wtap_pkthdr phdr;
2179 buffer_init(&buf, 1500);
2181 /* Update the progress bar when it gets to this value. */
2182 progbar_nextstep = 0;
2183 /* When we reach the value that triggers a progress bar update,
2184 bump that value by this amount. */
2185 progbar_quantum = cf->count/N_PROGBAR_UPDATES;
2186 /* Count of packets at which we've looked. */
2188 /* Progress so far. */
2191 progbar_stop_flag = FALSE;
2192 g_get_current_time(&progbar_start_time);
2195 packet_range_process_init(range);
2197 /* Iterate through all the packets, printing the packets that
2198 were selected by the current display filter. */
2199 for (framenum = 1; framenum <= cf->count; framenum++) {
2200 fdata = frame_data_sequence_find(cf->frames, framenum);
2202 /* Create the progress bar if necessary.
2203 We check on every iteration of the loop, so that it takes no
2204 longer than the standard time to create it (otherwise, for a
2205 large file, we might take considerably longer than that standard
2206 time in order to get to the next progress bar step). */
2207 if (progbar == NULL)
2208 progbar = delayed_create_progress_dlg(cf->window, string1, string2,
2211 &progbar_start_time,
2214 /* Update the progress bar, but do it only N_PROGBAR_UPDATES times;
2215 when we update it, we have to run the GTK+ main loop to get it
2216 to repaint what's pending, and doing so may involve an "ioctl()"
2217 to see if there's any pending input from an X server, and doing
2218 that for every packet can be costly, especially on a big file. */
2219 if (progbar_count >= progbar_nextstep) {
2220 /* let's not divide by zero. I should never be started
2221 * with count == 0, so let's assert that
2223 g_assert(cf->count > 0);
2224 progbar_val = (gfloat) progbar_count / cf->count;
2226 if (progbar != NULL) {
2227 g_snprintf(progbar_status_str, sizeof(progbar_status_str),
2228 "%4u of %u packets", progbar_count, cf->count);
2229 update_progress_dlg(progbar, progbar_val, progbar_status_str);
2232 progbar_nextstep += progbar_quantum;
2235 if (progbar_stop_flag) {
2236 /* Well, the user decided to abort the operation. Just stop,
2237 and arrange to return PSP_STOPPED to our caller, so they know
2238 it was stopped explicitly. */
2245 if (range != NULL) {
2246 /* do we have to process this packet? */
2247 process_this = packet_range_process_packet(range, fdata);
2248 if (process_this == range_process_next) {
2249 /* this packet uninteresting, continue with next one */
2251 } else if (process_this == range_processing_finished) {
2252 /* all interesting packets processed, stop the loop */
2257 /* Get the packet */
2258 if (!cf_read_frame_r(cf, fdata, &phdr, &buf)) {
2259 /* Attempt to get the packet failed. */
2263 /* Process the packet */
2264 if (!callback(cf, fdata, &phdr, buffer_start_ptr(&buf), callback_args)) {
2265 /* Callback failed. We assume it reported the error appropriately. */
2271 /* We're done printing the packets; destroy the progress bar if
2273 if (progbar != NULL)
2274 destroy_progress_dlg(progbar);
2282 gboolean construct_protocol_tree;
2284 } retap_callback_args_t;
2287 retap_packet(capture_file *cf _U_, frame_data *fdata,
2288 struct wtap_pkthdr *phdr, const guint8 *pd,
2291 retap_callback_args_t *args = (retap_callback_args_t *)argsp;
2294 epan_dissect_init(&edt, args->construct_protocol_tree, FALSE);
2295 epan_dissect_run_with_taps(&edt, phdr, pd, fdata, args->cinfo);
2296 epan_dissect_cleanup(&edt);
2302 cf_retap_packets(capture_file *cf)
2304 packet_range_t range;
2305 retap_callback_args_t callback_args;
2306 gboolean filtering_tap_listeners;
2309 /* Do we have any tap listeners with filters? */
2310 filtering_tap_listeners = have_filtering_tap_listeners();
2312 tap_flags = union_of_tap_listener_flags();
2314 /* If any tap listeners have filters, or require the protocol tree,
2315 construct the protocol tree. */
2316 callback_args.construct_protocol_tree = filtering_tap_listeners ||
2317 (tap_flags & TL_REQUIRES_PROTO_TREE);
2319 /* If any tap listeners require the columns, construct them. */
2320 callback_args.cinfo = (tap_flags & TL_REQUIRES_COLUMNS) ? &cf->cinfo : NULL;
2322 /* Reset the tap listeners. */
2323 reset_tap_listeners();
2325 /* Iterate through the list of packets, dissecting all packets and
2326 re-running the taps. */
2327 packet_range_init(&range, cf);
2328 packet_range_process_init(&range);
2329 switch (process_specified_packets(cf, &range, "Recalculating statistics on",
2330 "all packets", TRUE, retap_packet,
2333 /* Completed successfully. */
2337 /* Well, the user decided to abort the refiltering.
2338 Return CF_READ_ABORTED so our caller knows they did that. */
2339 return CF_READ_ABORTED;
2342 /* Error while retapping. */
2343 return CF_READ_ERROR;
2346 g_assert_not_reached();
2351 print_args_t *print_args;
2352 gboolean print_header_line;
2353 char *header_line_buf;
2354 int header_line_buf_len;
2355 gboolean print_formfeed;
2356 gboolean print_separator;
2360 int num_visible_cols;
2362 } print_callback_args_t;
2365 print_packet(capture_file *cf, frame_data *fdata,
2366 struct wtap_pkthdr *phdr, const guint8 *pd,
2369 print_callback_args_t *args = (print_callback_args_t *)argsp;
2376 gboolean proto_tree_needed;
2377 char bookmark_name[9+10+1]; /* "__frameNNNNNNNNNN__\0" */
2378 char bookmark_title[6+10+1]; /* "Frame NNNNNNNNNN__\0" */
2380 /* Create the protocol tree, and make it visible, if we're printing
2381 the dissection or the hex data.
2382 XXX - do we need it if we're just printing the hex data? */
2384 args->print_args->print_dissections != print_dissections_none || args->print_args->print_hex || have_custom_cols(&cf->cinfo);
2385 epan_dissect_init(&edt, proto_tree_needed, proto_tree_needed);
2387 /* Fill in the column information if we're printing the summary
2389 if (args->print_args->print_summary) {
2390 col_custom_prime_edt(&edt, &cf->cinfo);
2391 epan_dissect_run(&edt, phdr, pd, fdata, &cf->cinfo);
2392 epan_dissect_fill_in_columns(&edt, FALSE, TRUE);
2394 epan_dissect_run(&edt, phdr, pd, fdata, NULL);
2396 if (args->print_formfeed) {
2397 if (!new_page(args->print_args->stream))
2400 if (args->print_separator) {
2401 if (!print_line(args->print_args->stream, 0, ""))
2407 * We generate bookmarks, if the output format supports them.
2408 * The name is "__frameN__".
2410 g_snprintf(bookmark_name, sizeof bookmark_name, "__frame%u__", fdata->num);
2412 if (args->print_args->print_summary) {
2413 if (!args->print_args->print_col_headings)
2414 args->print_header_line = FALSE;
2415 if (args->print_header_line) {
2416 if (!print_line(args->print_args->stream, 0, args->header_line_buf))
2418 args->print_header_line = FALSE; /* we might not need to print any more */
2420 cp = &args->line_buf[0];
2422 for (i = 0; i < args->num_visible_cols; i++) {
2423 /* Find the length of the string for this column. */
2424 column_len = (int) strlen(cf->cinfo.col_data[args->visible_cols[i]]);
2425 if (args->col_widths[i] > column_len)
2426 column_len = args->col_widths[i];
2428 /* Make sure there's room in the line buffer for the column; if not,
2429 double its length. */
2430 line_len += column_len + 1; /* "+1" for space */
2431 if (line_len > args->line_buf_len) {
2432 cp_off = (int) (cp - args->line_buf);
2433 args->line_buf_len = 2 * line_len;
2434 args->line_buf = (char *)g_realloc(args->line_buf, args->line_buf_len + 1);
2435 cp = args->line_buf + cp_off;
2438 /* Right-justify the packet number column. */
2439 if (cf->cinfo.col_fmt[args->visible_cols[i]] == COL_NUMBER)
2440 g_snprintf(cp, column_len+1, "%*s", args->col_widths[i], cf->cinfo.col_data[args->visible_cols[i]]);
2442 g_snprintf(cp, column_len+1, "%-*s", args->col_widths[i], cf->cinfo.col_data[args->visible_cols[i]]);
2444 if (i != args->num_visible_cols - 1)
2450 * Generate a bookmark, using the summary line as the title.
2452 if (!print_bookmark(args->print_args->stream, bookmark_name,
2456 if (!print_line(args->print_args->stream, 0, args->line_buf))
2460 * Generate a bookmark, using "Frame N" as the title, as we're not
2461 * printing the summary line.
2463 g_snprintf(bookmark_title, sizeof bookmark_title, "Frame %u", fdata->num);
2464 if (!print_bookmark(args->print_args->stream, bookmark_name,
2467 } /* if (print_summary) */
2469 if (args->print_args->print_dissections != print_dissections_none) {
2470 if (args->print_args->print_summary) {
2471 /* Separate the summary line from the tree with a blank line. */
2472 if (!print_line(args->print_args->stream, 0, ""))
2476 /* Print the information in that tree. */
2477 if (!proto_tree_print(args->print_args, &edt, args->print_args->stream))
2480 /* Print a blank line if we print anything after this (aka more than one packet). */
2481 args->print_separator = TRUE;
2483 /* Print a header line if we print any more packet summaries */
2484 if (args->print_args->print_col_headings)
2485 args->print_header_line = TRUE;
2488 if (args->print_args->print_hex) {
2489 if (args->print_args->print_summary || (args->print_args->print_dissections != print_dissections_none)) {
2490 if (!print_line(args->print_args->stream, 0, ""))
2493 /* Print the full packet data as hex. */
2494 if (!print_hex_data(args->print_args->stream, &edt))
2497 /* Print a blank line if we print anything after this (aka more than one packet). */
2498 args->print_separator = TRUE;
2500 /* Print a header line if we print any more packet summaries */
2501 if (args->print_args->print_col_headings)
2502 args->print_header_line = TRUE;
2503 } /* if (args->print_args->print_dissections != print_dissections_none) */
2505 epan_dissect_cleanup(&edt);
2507 /* do we want to have a formfeed between each packet from now on? */
2508 if (args->print_args->print_formfeed) {
2509 args->print_formfeed = TRUE;
2515 epan_dissect_cleanup(&edt);
2520 cf_print_packets(capture_file *cf, print_args_t *print_args)
2522 print_callback_args_t callback_args;
2525 int i, cp_off, column_len, line_len;
2526 int num_visible_col = 0, last_visible_col = 0, visible_col_count;
2531 callback_args.print_args = print_args;
2532 callback_args.print_header_line = print_args->print_col_headings;
2533 callback_args.header_line_buf = NULL;
2534 callback_args.header_line_buf_len = 256;
2535 callback_args.print_formfeed = FALSE;
2536 callback_args.print_separator = FALSE;
2537 callback_args.line_buf = NULL;
2538 callback_args.line_buf_len = 256;
2539 callback_args.col_widths = NULL;
2540 callback_args.num_visible_cols = 0;
2541 callback_args.visible_cols = NULL;
2543 if (!print_preamble(print_args->stream, cf->filename)) {
2544 destroy_print_stream(print_args->stream);
2545 return CF_PRINT_WRITE_ERROR;
2548 if (print_args->print_summary) {
2549 /* We're printing packet summaries. Allocate the header line buffer
2550 and get the column widths. */
2551 callback_args.header_line_buf = (char *)g_malloc(callback_args.header_line_buf_len + 1);
2553 /* Find the number of visible columns and the last visible column */
2554 for (i = 0; i < prefs.num_cols; i++) {
2556 clp = g_list_nth(prefs.col_list, i);
2557 if (clp == NULL) /* Sanity check, Invalid column requested */
2560 cfmt = (fmt_data *) clp->data;
2561 if (cfmt->visible) {
2563 last_visible_col = i;
2567 /* Find the widths for each of the columns - maximum of the
2568 width of the title and the width of the data - and construct
2569 a buffer with a line containing the column titles. */
2570 callback_args.num_visible_cols = num_visible_col;
2571 callback_args.col_widths = (gint *) g_malloc(sizeof(gint) * num_visible_col);
2572 callback_args.visible_cols = (gint *) g_malloc(sizeof(gint) * num_visible_col);
2573 cp = &callback_args.header_line_buf[0];
2575 visible_col_count = 0;
2576 for (i = 0; i < cf->cinfo.num_cols; i++) {
2578 clp = g_list_nth(prefs.col_list, i);
2579 if (clp == NULL) /* Sanity check, Invalid column requested */
2582 cfmt = (fmt_data *) clp->data;
2583 if (cfmt->visible == FALSE)
2586 /* Save the order of visible columns */
2587 callback_args.visible_cols[visible_col_count] = i;
2589 /* Don't pad the last column. */
2590 if (i == last_visible_col)
2591 callback_args.col_widths[visible_col_count] = 0;
2593 callback_args.col_widths[visible_col_count] = (gint) strlen(cf->cinfo.col_title[i]);
2594 data_width = get_column_char_width(get_column_format(i));
2595 if (data_width > callback_args.col_widths[visible_col_count])
2596 callback_args.col_widths[visible_col_count] = data_width;
2599 /* Find the length of the string for this column. */
2600 column_len = (int) strlen(cf->cinfo.col_title[i]);
2601 if (callback_args.col_widths[i] > column_len)
2602 column_len = callback_args.col_widths[visible_col_count];
2604 /* Make sure there's room in the line buffer for the column; if not,
2605 double its length. */
2606 line_len += column_len + 1; /* "+1" for space */
2607 if (line_len > callback_args.header_line_buf_len) {
2608 cp_off = (int) (cp - callback_args.header_line_buf);
2609 callback_args.header_line_buf_len = 2 * line_len;
2610 callback_args.header_line_buf = (char *)g_realloc(callback_args.header_line_buf,
2611 callback_args.header_line_buf_len + 1);
2612 cp = callback_args.header_line_buf + cp_off;
2615 /* Right-justify the packet number column. */
2616 /* if (cf->cinfo.col_fmt[i] == COL_NUMBER)
2617 g_snprintf(cp, column_len+1, "%*s", callback_args.col_widths[visible_col_count], cf->cinfo.col_title[i]);
2619 g_snprintf(cp, column_len+1, "%-*s", callback_args.col_widths[visible_col_count], cf->cinfo.col_title[i]);
2621 if (i != cf->cinfo.num_cols - 1)
2624 visible_col_count++;
2628 /* Now start out the main line buffer with the same length as the
2629 header line buffer. */
2630 callback_args.line_buf_len = callback_args.header_line_buf_len;
2631 callback_args.line_buf = (char *)g_malloc(callback_args.line_buf_len + 1);
2632 } /* if (print_summary) */
2634 /* Iterate through the list of packets, printing the packets we were
2636 ret = process_specified_packets(cf, &print_args->range, "Printing",
2637 "selected packets", TRUE, print_packet,
2640 g_free(callback_args.header_line_buf);
2641 g_free(callback_args.line_buf);
2642 g_free(callback_args.col_widths);
2643 g_free(callback_args.visible_cols);
2648 /* Completed successfully. */
2652 /* Well, the user decided to abort the printing.
2654 XXX - note that what got generated before they did that
2655 will get printed if we're piping to a print program; we'd
2656 have to write to a file and then hand that to the print
2657 program to make it actually not print anything. */
2661 /* Error while printing.
2663 XXX - note that what got generated before they did that
2664 will get printed if we're piping to a print program; we'd
2665 have to write to a file and then hand that to the print
2666 program to make it actually not print anything. */
2667 destroy_print_stream(print_args->stream);
2668 return CF_PRINT_WRITE_ERROR;
2671 if (!print_finale(print_args->stream)) {
2672 destroy_print_stream(print_args->stream);
2673 return CF_PRINT_WRITE_ERROR;
2676 if (!destroy_print_stream(print_args->stream))
2677 return CF_PRINT_WRITE_ERROR;
2683 write_pdml_packet(capture_file *cf _U_, frame_data *fdata,
2684 struct wtap_pkthdr *phdr, const guint8 *pd,
2687 FILE *fh = (FILE *)argsp;
2690 /* Create the protocol tree, but don't fill in the column information. */
2691 epan_dissect_init(&edt, TRUE, TRUE);
2692 epan_dissect_run(&edt, phdr, pd, fdata, NULL);
2694 /* Write out the information in that tree. */
2695 proto_tree_write_pdml(&edt, fh);
2697 epan_dissect_cleanup(&edt);
2703 cf_write_pdml_packets(capture_file *cf, print_args_t *print_args)
2708 fh = ws_fopen(print_args->file, "w");
2710 return CF_PRINT_OPEN_ERROR; /* attempt to open destination failed */
2712 write_pdml_preamble(fh, cf->filename);
2715 return CF_PRINT_WRITE_ERROR;
2718 /* Iterate through the list of packets, printing the packets we were
2720 ret = process_specified_packets(cf, &print_args->range, "Writing PDML",
2721 "selected packets", TRUE,
2722 write_pdml_packet, fh);
2727 /* Completed successfully. */
2731 /* Well, the user decided to abort the printing. */
2735 /* Error while printing. */
2737 return CF_PRINT_WRITE_ERROR;
2740 write_pdml_finale(fh);
2743 return CF_PRINT_WRITE_ERROR;
2746 /* XXX - check for an error */
2753 write_psml_packet(capture_file *cf, frame_data *fdata,
2754 struct wtap_pkthdr *phdr, const guint8 *pd,
2757 FILE *fh = (FILE *)argsp;
2759 gboolean proto_tree_needed;
2761 /* Fill in the column information, only create the protocol tree
2762 if having custom columns. */
2763 proto_tree_needed = have_custom_cols(&cf->cinfo);
2764 epan_dissect_init(&edt, proto_tree_needed, proto_tree_needed);
2765 col_custom_prime_edt(&edt, &cf->cinfo);
2766 epan_dissect_run(&edt, phdr, pd, fdata, &cf->cinfo);
2767 epan_dissect_fill_in_columns(&edt, FALSE, TRUE);
2769 /* Write out the information in that tree. */
2770 proto_tree_write_psml(&edt, fh);
2772 epan_dissect_cleanup(&edt);
2778 cf_write_psml_packets(capture_file *cf, print_args_t *print_args)
2783 fh = ws_fopen(print_args->file, "w");
2785 return CF_PRINT_OPEN_ERROR; /* attempt to open destination failed */
2787 write_psml_preamble(fh);
2790 return CF_PRINT_WRITE_ERROR;
2793 /* Iterate through the list of packets, printing the packets we were
2795 ret = process_specified_packets(cf, &print_args->range, "Writing PSML",
2796 "selected packets", TRUE,
2797 write_psml_packet, fh);
2802 /* Completed successfully. */
2806 /* Well, the user decided to abort the printing. */
2810 /* Error while printing. */
2812 return CF_PRINT_WRITE_ERROR;
2815 write_psml_finale(fh);
2818 return CF_PRINT_WRITE_ERROR;
2821 /* XXX - check for an error */
2828 write_csv_packet(capture_file *cf, frame_data *fdata,
2829 struct wtap_pkthdr *phdr, const guint8 *pd,
2832 FILE *fh = (FILE *)argsp;
2834 gboolean proto_tree_needed;
2836 /* Fill in the column information, only create the protocol tree
2837 if having custom columns. */
2838 proto_tree_needed = have_custom_cols(&cf->cinfo);
2839 epan_dissect_init(&edt, proto_tree_needed, proto_tree_needed);
2840 col_custom_prime_edt(&edt, &cf->cinfo);
2841 epan_dissect_run(&edt, phdr, pd, fdata, &cf->cinfo);
2842 epan_dissect_fill_in_columns(&edt, FALSE, TRUE);
2844 /* Write out the information in that tree. */
2845 proto_tree_write_csv(&edt, fh);
2847 epan_dissect_cleanup(&edt);
2853 cf_write_csv_packets(capture_file *cf, print_args_t *print_args)
2858 fh = ws_fopen(print_args->file, "w");
2860 return CF_PRINT_OPEN_ERROR; /* attempt to open destination failed */
2862 write_csv_preamble(fh);
2865 return CF_PRINT_WRITE_ERROR;
2868 /* Iterate through the list of packets, printing the packets we were
2870 ret = process_specified_packets(cf, &print_args->range, "Writing CSV",
2871 "selected packets", TRUE,
2872 write_csv_packet, fh);
2877 /* Completed successfully. */
2881 /* Well, the user decided to abort the printing. */
2885 /* Error while printing. */
2887 return CF_PRINT_WRITE_ERROR;
2890 write_csv_finale(fh);
2893 return CF_PRINT_WRITE_ERROR;
2896 /* XXX - check for an error */
2903 write_carrays_packet(capture_file *cf _U_, frame_data *fdata,
2904 struct wtap_pkthdr *phdr,
2905 const guint8 *pd, void *argsp)
2907 FILE *fh = (FILE *)argsp;
2910 epan_dissect_init(&edt, TRUE, TRUE);
2911 epan_dissect_run(&edt, phdr, pd, fdata, NULL);
2912 proto_tree_write_carrays(fdata->num, fh, &edt);
2913 epan_dissect_cleanup(&edt);
2919 cf_write_carrays_packets(capture_file *cf, print_args_t *print_args)
2924 fh = ws_fopen(print_args->file, "w");
2927 return CF_PRINT_OPEN_ERROR; /* attempt to open destination failed */
2929 write_carrays_preamble(fh);
2933 return CF_PRINT_WRITE_ERROR;
2936 /* Iterate through the list of packets, printing the packets we were
2938 ret = process_specified_packets(cf, &print_args->range,
2940 "selected packets", TRUE,
2941 write_carrays_packet, fh);
2944 /* Completed successfully. */
2947 /* Well, the user decided to abort the printing. */
2950 /* Error while printing. */
2952 return CF_PRINT_WRITE_ERROR;
2955 write_carrays_finale(fh);
2959 return CF_PRINT_WRITE_ERROR;
2967 cf_find_packet_protocol_tree(capture_file *cf, const char *string,
2968 search_direction dir)
2972 mdata.string = string;
2973 mdata.string_len = strlen(string);
2974 return find_packet(cf, match_protocol_tree, &mdata, dir);
2978 cf_find_string_protocol_tree(capture_file *cf, proto_tree *tree, match_data *mdata)
2980 mdata->frame_matched = FALSE;
2981 mdata->string = convert_string_case(cf->sfilter, cf->case_type);
2982 mdata->string_len = strlen(mdata->string);
2984 /* Iterate through all the nodes looking for matching text */
2985 proto_tree_children_foreach(tree, match_subtree_text, mdata);
2986 return mdata->frame_matched ? MR_MATCHED : MR_NOTMATCHED;
2990 match_protocol_tree(capture_file *cf, frame_data *fdata, void *criterion)
2992 match_data *mdata = (match_data *)criterion;
2995 /* Load the frame's data. */
2996 if (!cf_read_frame(cf, fdata)) {
2997 /* Attempt to get the packet failed. */
3001 /* Construct the protocol tree, including the displayed text */
3002 epan_dissect_init(&edt, TRUE, TRUE);
3003 /* We don't need the column information */
3004 epan_dissect_run(&edt, &cf->phdr, buffer_start_ptr(&cf->buf), fdata, NULL);
3006 /* Iterate through all the nodes, seeing if they have text that matches. */
3008 mdata->frame_matched = FALSE;
3009 proto_tree_children_foreach(edt.tree, match_subtree_text, mdata);
3010 epan_dissect_cleanup(&edt);
3011 return mdata->frame_matched ? MR_MATCHED : MR_NOTMATCHED;
3015 match_subtree_text(proto_node *node, gpointer data)
3017 match_data *mdata = (match_data *) data;
3018 const gchar *string = mdata->string;
3019 size_t string_len = mdata->string_len;
3020 capture_file *cf = mdata->cf;
3021 field_info *fi = PNODE_FINFO(node);
3022 gchar label_str[ITEM_LABEL_LENGTH];
3029 /* dissection with an invisible proto tree? */
3032 if (mdata->frame_matched) {
3033 /* We already had a match; don't bother doing any more work. */
3037 /* Don't match invisible entries. */
3038 if (PROTO_ITEM_IS_HIDDEN(node))
3041 /* was a free format label produced? */
3043 label_ptr = fi->rep->representation;
3045 /* no, make a generic label */
3046 label_ptr = label_str;
3047 proto_item_fill_label(fi, label_str);
3050 /* Does that label match? */
3051 label_len = strlen(label_ptr);
3052 for (i = 0; i < label_len; i++) {
3053 c_char = label_ptr[i];
3055 c_char = toupper(c_char);
3056 if (c_char == string[c_match]) {
3058 if (c_match == string_len) {
3059 /* No need to look further; we have a match */
3060 mdata->frame_matched = TRUE;
3068 /* Recurse into the subtree, if it exists */
3069 if (node->first_child != NULL)
3070 proto_tree_children_foreach(node, match_subtree_text, mdata);
3074 cf_find_packet_summary_line(capture_file *cf, const char *string,
3075 search_direction dir)
3079 mdata.string = string;
3080 mdata.string_len = strlen(string);
3081 return find_packet(cf, match_summary_line, &mdata, dir);
3085 match_summary_line(capture_file *cf, frame_data *fdata, void *criterion)
3087 match_data *mdata = (match_data *)criterion;
3088 const gchar *string = mdata->string;
3089 size_t string_len = mdata->string_len;
3091 const char *info_column;
3092 size_t info_column_len;
3093 match_result result = MR_NOTMATCHED;
3099 /* Load the frame's data. */
3100 if (!cf_read_frame(cf, fdata)) {
3101 /* Attempt to get the packet failed. */
3105 /* Don't bother constructing the protocol tree */
3106 epan_dissect_init(&edt, FALSE, FALSE);
3107 /* Get the column information */
3108 epan_dissect_run(&edt, &cf->phdr, buffer_start_ptr(&cf->buf), fdata,
3111 /* Find the Info column */
3112 for (colx = 0; colx < cf->cinfo.num_cols; colx++) {
3113 if (cf->cinfo.fmt_matx[colx][COL_INFO]) {
3114 /* Found it. See if we match. */
3115 info_column = edt.pi.cinfo->col_data[colx];
3116 info_column_len = strlen(info_column);
3117 for (i = 0; i < info_column_len; i++) {
3118 c_char = info_column[i];
3120 c_char = toupper(c_char);
3121 if (c_char == string[c_match]) {
3123 if (c_match == string_len) {
3124 result = MR_MATCHED;
3133 epan_dissect_cleanup(&edt);
3140 } cbs_t; /* "Counted byte string" */
3144 * The current match_* routines only support ASCII case insensitivity and don't
3145 * convert UTF-8 inputs to UTF-16 for matching.
3147 * We could modify them to use the GLib Unicode routines or the International
3148 * Components for Unicode library but it's not apparent that we could do so
3149 * without consuming a lot more CPU and memory or that searching would be
3150 * significantly better.
3154 cf_find_packet_data(capture_file *cf, const guint8 *string, size_t string_size,
3155 search_direction dir)
3160 info.data_len = string_size;
3162 /* String or hex search? */
3164 /* String search - what type of string? */
3165 switch (cf->scs_type) {
3167 case SCS_NARROW_AND_WIDE:
3168 return find_packet(cf, match_narrow_and_wide, &info, dir);
3171 return find_packet(cf, match_narrow, &info, dir);
3174 return find_packet(cf, match_wide, &info, dir);
3177 g_assert_not_reached();
3181 return find_packet(cf, match_binary, &info, dir);
3185 match_narrow_and_wide(capture_file *cf, frame_data *fdata, void *criterion)
3187 cbs_t *info = (cbs_t *)criterion;
3188 const guint8 *ascii_text = info->data;
3189 size_t textlen = info->data_len;
3190 match_result result;
3197 /* Load the frame's data. */
3198 if (!cf_read_frame(cf, fdata)) {
3199 /* Attempt to get the packet failed. */
3203 result = MR_NOTMATCHED;
3204 buf_len = fdata->cap_len;
3205 pd = buffer_start_ptr(&cf->buf);
3207 while (i < buf_len) {
3210 c_char = toupper(c_char);
3211 if (c_char != '\0') {
3212 if (c_char == ascii_text[c_match]) {
3214 if (c_match == textlen) {
3215 result = MR_MATCHED;
3216 cf->search_pos = i; /* Save the position of the last character
3217 for highlighting the field. */
3222 g_assert(i>=c_match);
3223 i -= (guint32)c_match;
3233 match_narrow(capture_file *cf, frame_data *fdata, void *criterion)
3236 cbs_t *info = (cbs_t *)criterion;
3237 const guint8 *ascii_text = info->data;
3238 size_t textlen = info->data_len;
3239 match_result result;
3245 /* Load the frame's data. */
3246 if (!cf_read_frame(cf, fdata)) {
3247 /* Attempt to get the packet failed. */
3251 result = MR_NOTMATCHED;
3252 buf_len = fdata->cap_len;
3253 pd = buffer_start_ptr(&cf->buf);
3255 while (i < buf_len) {
3258 c_char = toupper(c_char);
3259 if (c_char == ascii_text[c_match]) {
3261 if (c_match == textlen) {
3262 result = MR_MATCHED;
3263 cf->search_pos = i; /* Save the position of the last character
3264 for highlighting the field. */
3269 g_assert(i>=c_match);
3270 i -= (guint32)c_match;
3280 match_wide(capture_file *cf, frame_data *fdata, void *criterion)
3282 cbs_t *info = (cbs_t *)criterion;
3283 const guint8 *ascii_text = info->data;
3284 size_t textlen = info->data_len;
3285 match_result result;
3292 /* Load the frame's data. */
3293 if (!cf_read_frame(cf, fdata)) {
3294 /* Attempt to get the packet failed. */
3298 result = MR_NOTMATCHED;
3299 buf_len = fdata->cap_len;
3300 pd = buffer_start_ptr(&cf->buf);
3302 while (i < buf_len) {
3305 c_char = toupper(c_char);
3306 if (c_char == ascii_text[c_match]) {
3308 if (c_match == textlen) {
3309 result = MR_MATCHED;
3310 cf->search_pos = i; /* Save the position of the last character
3311 for highlighting the field. */
3317 g_assert(i>=(c_match*2));
3318 i -= (guint32)c_match*2;
3327 match_binary(capture_file *cf, frame_data *fdata, void *criterion)
3329 cbs_t *info = (cbs_t *)criterion;
3330 const guint8 *binary_data = info->data;
3331 size_t datalen = info->data_len;
3332 match_result result;
3338 /* Load the frame's data. */
3339 if (!cf_read_frame(cf, fdata)) {
3340 /* Attempt to get the packet failed. */
3344 result = MR_NOTMATCHED;
3345 buf_len = fdata->cap_len;
3346 pd = buffer_start_ptr(&cf->buf);
3348 while (i < buf_len) {
3349 if (pd[i] == binary_data[c_match]) {
3351 if (c_match == datalen) {
3352 result = MR_MATCHED;
3353 cf->search_pos = i; /* Save the position of the last character
3354 for highlighting the field. */
3359 g_assert(i>=c_match);
3360 i -= (guint32)c_match;
3369 cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode,
3370 search_direction dir)
3372 return find_packet(cf, match_dfilter, sfcode, dir);
3376 cf_find_packet_dfilter_string(capture_file *cf, const char *filter,
3377 search_direction dir)
3382 if (!dfilter_compile(filter, &sfcode)) {
3384 * XXX - this shouldn't happen, as the filter string is machine
3389 if (sfcode == NULL) {
3391 * XXX - this shouldn't happen, as the filter string is machine
3396 result = find_packet(cf, match_dfilter, sfcode, dir);
3397 dfilter_free(sfcode);
3402 match_dfilter(capture_file *cf, frame_data *fdata, void *criterion)
3404 dfilter_t *sfcode = (dfilter_t *)criterion;
3406 match_result result;
3408 /* Load the frame's data. */
3409 if (!cf_read_frame(cf, fdata)) {
3410 /* Attempt to get the packet failed. */
3414 epan_dissect_init(&edt, TRUE, FALSE);
3415 epan_dissect_prime_dfilter(&edt, sfcode);
3416 epan_dissect_run(&edt, &cf->phdr, buffer_start_ptr(&cf->buf), fdata, NULL);
3417 result = dfilter_apply_edt(sfcode, &edt) ? MR_MATCHED : MR_NOTMATCHED;
3418 epan_dissect_cleanup(&edt);
3423 cf_find_packet_marked(capture_file *cf, search_direction dir)
3425 return find_packet(cf, match_marked, NULL, dir);
3429 match_marked(capture_file *cf _U_, frame_data *fdata, void *criterion _U_)
3431 return fdata->flags.marked ? MR_MATCHED : MR_NOTMATCHED;
3435 cf_find_packet_time_reference(capture_file *cf, search_direction dir)
3437 return find_packet(cf, match_time_reference, NULL, dir);
3441 match_time_reference(capture_file *cf _U_, frame_data *fdata, void *criterion _U_)
3443 return fdata->flags.ref_time ? MR_MATCHED : MR_NOTMATCHED;
3447 find_packet(capture_file *cf,
3448 match_result (*match_function)(capture_file *, frame_data *, void *),
3449 void *criterion, search_direction dir)
3451 frame_data *start_fd;
3454 frame_data *new_fd = NULL;
3455 progdlg_t *progbar = NULL;
3460 GTimeVal start_time;
3461 gchar status_str[100];
3462 int progbar_nextstep;
3463 int progbar_quantum;
3465 match_result result;
3467 start_fd = cf->current_frame;
3468 if (start_fd != NULL) {
3469 /* Iterate through the list of packets, starting at the packet we've
3470 picked, calling a routine to run the filter on the packet, see if
3471 it matches, and stop if so. */
3473 framenum = start_fd->num;
3475 /* Update the progress bar when it gets to this value. */
3476 progbar_nextstep = 0;
3477 /* When we reach the value that triggers a progress bar update,
3478 bump that value by this amount. */
3479 progbar_quantum = cf->count/N_PROGBAR_UPDATES;
3480 /* Progress so far. */
3484 g_get_current_time(&start_time);
3486 title = cf->sfilter?cf->sfilter:"";
3488 /* Create the progress bar if necessary.
3489 We check on every iteration of the loop, so that it takes no
3490 longer than the standard time to create it (otherwise, for a
3491 large file, we might take considerably longer than that standard
3492 time in order to get to the next progress bar step). */
3493 if (progbar == NULL)
3494 progbar = delayed_create_progress_dlg(cf->window, "Searching", title,
3495 FALSE, &stop_flag, &start_time, progbar_val);
3497 /* Update the progress bar, but do it only N_PROGBAR_UPDATES times;
3498 when we update it, we have to run the GTK+ main loop to get it
3499 to repaint what's pending, and doing so may involve an "ioctl()"
3500 to see if there's any pending input from an X server, and doing
3501 that for every packet can be costly, especially on a big file. */
3502 if (count >= progbar_nextstep) {
3503 /* let's not divide by zero. I should never be started
3504 * with count == 0, so let's assert that
3506 g_assert(cf->count > 0);
3508 progbar_val = (gfloat) count / cf->count;
3510 if (progbar != NULL) {
3511 g_snprintf(status_str, sizeof(status_str),
3512 "%4u of %u packets", count, cf->count);
3513 update_progress_dlg(progbar, progbar_val, status_str);
3516 progbar_nextstep += progbar_quantum;
3520 /* Well, the user decided to abort the search. Go back to the
3521 frame where we started. */
3526 /* Go past the current frame. */
3527 if (dir == SD_BACKWARD) {
3528 /* Go on to the previous frame. */
3529 if (framenum == 1) {
3531 * XXX - other apps have a bit more of a detailed message
3532 * for this, and instead of offering "OK" and "Cancel",
3533 * they offer things such as "Continue" and "Cancel";
3534 * we need an API for popping up alert boxes with
3535 * {Verb} and "Cancel".
3538 if (prefs.gui_find_wrap)
3540 statusbar_push_temporary_msg("Search reached the beginning. Continuing at end.");
3541 framenum = cf->count; /* wrap around */
3545 statusbar_push_temporary_msg("Search reached the beginning.");
3546 framenum = start_fd->num; /* stay on previous packet */
3551 /* Go on to the next frame. */
3552 if (framenum == cf->count) {
3553 if (prefs.gui_find_wrap)
3555 statusbar_push_temporary_msg("Search reached the end. Continuing at beginning.");
3556 framenum = 1; /* wrap around */
3560 statusbar_push_temporary_msg("Search reached the end.");
3561 framenum = start_fd->num; /* stay on previous packet */
3566 fdata = frame_data_sequence_find(cf->frames, framenum);
3570 /* Is this packet in the display? */
3571 if (fdata->flags.passed_dfilter) {
3572 /* Yes. Does it match the search criterion? */
3573 result = (*match_function)(cf, fdata, criterion);
3574 if (result == MR_ERROR) {
3575 /* Error; our caller has reported the error. Go back to the frame
3576 where we started. */
3579 } else if (result == MR_MATCHED) {
3580 /* Yes. Go to the new frame. */
3586 if (fdata == start_fd) {
3587 /* We're back to the frame we were on originally, and that frame
3588 doesn't match the search filter. The search failed. */
3593 /* We're done scanning the packets; destroy the progress bar if it
3595 if (progbar != NULL)
3596 destroy_progress_dlg(progbar);
3599 if (new_fd != NULL) {
3600 /* Find and select */
3601 cf->search_in_progress = TRUE;
3602 found = packet_list_select_row_from_data(new_fd);
3603 cf->search_in_progress = FALSE;
3604 cf->search_pos = 0; /* Reset the position */
3606 /* We didn't find a row corresponding to this frame.
3607 This means that the frame isn't being displayed currently,
3608 so we can't select it. */
3609 simple_message_box(ESD_TYPE_INFO, NULL,
3610 "The capture file is probably not fully dissected.",
3611 "End of capture exceeded!");
3614 return TRUE; /* success */
3616 return FALSE; /* failure */
3620 cf_goto_frame(capture_file *cf, guint fnumber)
3624 fdata = frame_data_sequence_find(cf->frames, fnumber);
3626 if (fdata == NULL) {
3627 /* we didn't find a packet with that packet number */
3628 statusbar_push_temporary_msg("There is no packet number %u.", fnumber);
3629 return FALSE; /* we failed to go to that packet */
3631 if (!fdata->flags.passed_dfilter) {
3632 /* that packet currently isn't displayed */
3633 /* XXX - add it to the set of displayed packets? */
3634 statusbar_push_temporary_msg("Packet number %u isn't displayed.", fnumber);
3635 return FALSE; /* we failed to go to that packet */
3638 if (!packet_list_select_row_from_data(fdata)) {
3639 /* We didn't find a row corresponding to this frame.
3640 This means that the frame isn't being displayed currently,
3641 so we can't select it. */
3642 simple_message_box(ESD_TYPE_INFO, NULL,
3643 "The capture file is probably not fully dissected.",
3644 "End of capture exceeded!");
3647 return TRUE; /* we got to that packet */
3651 cf_goto_top_frame(void)
3653 /* Find and select */
3654 packet_list_select_first_row();
3655 return TRUE; /* we got to that packet */
3659 cf_goto_bottom_frame(void)
3661 /* Find and select */
3662 packet_list_select_last_row();
3663 return TRUE; /* we got to that packet */
3667 * Go to frame specified by currently selected protocol tree item.
3670 cf_goto_framenum(capture_file *cf)
3672 header_field_info *hfinfo;
3675 if (cf->finfo_selected) {
3676 hfinfo = cf->finfo_selected->hfinfo;
3678 if (hfinfo->type == FT_FRAMENUM) {
3679 framenum = fvalue_get_uinteger(&cf->finfo_selected->value);
3681 return cf_goto_frame(cf, framenum);
3688 /* Select the packet on a given row. */
3690 cf_select_packet(capture_file *cf, int row)
3692 epan_dissect_t *old_edt;
3695 /* Get the frame data struct pointer for this frame */
3696 fdata = packet_list_get_row_data(row);
3698 if (fdata == NULL) {
3699 /* XXX - if a GtkCList's selection mode is GTK_SELECTION_BROWSE, when
3700 the first entry is added to it by "real_insert_row()", that row
3701 is selected (see "real_insert_row()", in "ui/gtk/gtkclist.c", in both
3702 our version and the vanilla GTK+ version).
3704 This means that a "select-row" signal is emitted; this causes
3705 "packet_list_select_cb()" to be called, which causes "cf_select_packet()"
3708 "cf_select_packet()" fetches, above, the data associated with the
3709 row that was selected; however, as "gtk_clist_append()", which
3710 called "real_insert_row()", hasn't yet returned, we haven't yet
3711 associated any data with that row, so we get back a null pointer.
3713 We can't assume that there's only one frame in the frame list,
3714 either, as we may be filtering the display.
3716 We therefore assume that, if "row" is 0, i.e. the first row
3717 is being selected, and "cf->first_displayed" equals
3718 "cf->last_displayed", i.e. there's only one frame being
3719 displayed, that frame is the frame we want.
3721 This means we have to set "cf->first_displayed" and
3722 "cf->last_displayed" before adding the row to the
3723 GtkCList; see the comment in "add_packet_to_packet_list()". */
3725 if (row == 0 && cf->first_displayed == cf->last_displayed)
3726 fdata = frame_data_sequence_find(cf->frames, cf->first_displayed);
3729 /* If fdata _still_ isn't set simply give up. */
3730 if (fdata == NULL) {
3734 /* Get the data in that frame. */
3735 if (!cf_read_frame (cf, fdata)) {
3739 /* Record that this frame is the current frame. */
3740 cf->current_frame = fdata;
3741 cf->current_row = row;
3744 /* Create the logical protocol tree. */
3745 /* We don't need the columns here. */
3746 cf->edt = epan_dissect_new(TRUE, TRUE);
3748 tap_build_interesting(cf->edt);
3749 epan_dissect_run(cf->edt, &cf->phdr, buffer_start_ptr(&cf->buf),
3750 cf->current_frame, NULL);
3752 dfilter_macro_build_ftv_cache(cf->edt->tree);
3754 cf_callback_invoke(cf_cb_packet_selected, cf);
3756 if (old_edt != NULL)
3757 epan_dissect_free(old_edt);
3761 /* Unselect the selected packet, if any. */
3763 cf_unselect_packet(capture_file *cf)
3765 epan_dissect_t *old_edt = cf->edt;
3769 /* No packet is selected. */
3770 cf->current_frame = NULL;
3771 cf->current_row = 0;
3773 cf_callback_invoke(cf_cb_packet_unselected, cf);
3775 /* No protocol tree means no selected field. */
3776 cf_unselect_field(cf);
3778 /* Destroy the epan_dissect_t for the unselected packet. */
3779 if (old_edt != NULL)
3780 epan_dissect_free(old_edt);
3783 /* Unset the selected protocol tree field, if any. */
3785 cf_unselect_field(capture_file *cf)
3787 cf->finfo_selected = NULL;
3789 cf_callback_invoke(cf_cb_field_unselected, cf);
3793 * Mark a particular frame.
3796 cf_mark_frame(capture_file *cf, frame_data *frame)
3798 if (! frame->flags.marked) {
3799 frame->flags.marked = TRUE;
3800 if (cf->count > cf->marked_count)
3806 * Unmark a particular frame.
3809 cf_unmark_frame(capture_file *cf, frame_data *frame)
3811 if (frame->flags.marked) {
3812 frame->flags.marked = FALSE;
3813 if (cf->marked_count > 0)
3819 * Ignore a particular frame.
3822 cf_ignore_frame(capture_file *cf, frame_data *frame)
3824 if (! frame->flags.ignored) {
3825 frame->flags.ignored = TRUE;
3826 if (cf->count > cf->ignored_count)
3827 cf->ignored_count++;
3832 * Un-ignore a particular frame.
3835 cf_unignore_frame(capture_file *cf, frame_data *frame)
3837 if (frame->flags.ignored) {
3838 frame->flags.ignored = FALSE;
3839 if (cf->ignored_count > 0)
3840 cf->ignored_count--;
3845 * Read the comment in SHB block
3849 cf_read_shb_comment(capture_file *cf)
3851 wtapng_section_t *shb_inf;
3852 const gchar *temp_str;
3854 /* Get info from SHB */
3855 shb_inf = wtap_file_get_shb_info(cf->wth);
3856 if (shb_inf == NULL)
3858 temp_str = shb_inf->opt_comment;
3866 cf_update_capture_comment(capture_file *cf, gchar *comment)
3868 wtapng_section_t *shb_inf;
3870 /* Get info from SHB */
3871 shb_inf = wtap_file_get_shb_info(cf->wth);
3873 /* See if the comment has changed or not */
3874 if (shb_inf && shb_inf->opt_comment) {
3875 if (strcmp(shb_inf->opt_comment, comment) == 0) {
3884 /* The comment has changed, let's update it */
3885 wtap_write_shb_comment(cf->wth, comment);
3886 /* Mark the file as having unsaved changes */
3887 cf->unsaved_changes = TRUE;
3891 cf_update_packet_comment(capture_file *cf, frame_data *fdata, gchar *comment)
3893 if (fdata->opt_comment != NULL) {
3894 /* OK, remove the old comment. */
3895 g_free(fdata->opt_comment);
3896 fdata->opt_comment = NULL;
3897 cf->packet_comment_count--;
3899 if (comment != NULL) {
3900 /* Add the new comment. */
3901 fdata->opt_comment = comment;
3902 cf->packet_comment_count++;
3905 /* OK, we have unsaved changes. */
3906 cf->unsaved_changes = TRUE;
3910 * What types of comments does this capture file have?
3913 cf_comment_types(capture_file *cf)
3915 guint32 comment_types = 0;
3917 if (cf_read_shb_comment(cf) != NULL)
3918 comment_types |= WTAP_COMMENT_PER_SECTION;
3919 if (cf->packet_comment_count != 0)
3920 comment_types |= WTAP_COMMENT_PER_PACKET;
3921 return comment_types;
3928 } save_callback_args_t;
3931 * Save a capture to a file, in a particular format, saving either
3932 * all packets, all currently-displayed packets, or all marked packets.
3934 * Returns TRUE if it succeeds, FALSE otherwise; if it fails, it pops
3935 * up a message box for the failure.
3938 save_packet(capture_file *cf _U_, frame_data *fdata,
3939 struct wtap_pkthdr *phdr, const guint8 *pd,
3942 save_callback_args_t *args = (save_callback_args_t *)argsp;
3943 struct wtap_pkthdr hdr;
3945 gchar *display_basename;
3947 /* init the wtap header for saving */
3948 /* TODO: reuse phdr */
3949 /* XXX - these are the only flags that correspond to data that we have
3950 in the frame_data structure and that matter on a per-packet basis.
3952 For WTAP_HAS_CAP_LEN, either the file format has separate "captured"
3953 and "on the wire" lengths, or it doesn't.
3955 For WTAP_HAS_DROP_COUNT, Wiretap doesn't actually supply the value
3958 For WTAP_HAS_PACK_FLAGS, we currently don't save the FCS length
3959 from the packet flags. */
3960 hdr.presence_flags = 0;
3961 if (fdata->flags.has_ts)
3962 hdr.presence_flags |= WTAP_HAS_TS;
3963 if (fdata->flags.has_if_id)
3964 hdr.presence_flags |= WTAP_HAS_INTERFACE_ID;
3965 if (fdata->flags.has_pack_flags)
3966 hdr.presence_flags |= WTAP_HAS_PACK_FLAGS;
3967 hdr.ts.secs = fdata->abs_ts.secs;
3968 hdr.ts.nsecs = fdata->abs_ts.nsecs;
3969 hdr.caplen = fdata->cap_len;
3970 hdr.len = fdata->pkt_len;
3971 hdr.pkt_encap = fdata->lnk_t;
3973 hdr.interface_id = fdata->interface_id; /* identifier of the interface. */
3975 hdr.pack_flags = fdata->pack_flags;
3976 hdr.opt_comment = fdata->opt_comment; /* NULL if not available */
3978 hdr.pseudo_header = phdr->pseudo_header;
3981 hdr.pack_flags = /* XXX - 0 for now (any value for "we don't have it"?) */
3983 /* and save the packet */
3984 if (!wtap_dump(args->pdh, &hdr, pd, &err)) {
3986 /* Wiretap error. */
3989 case WTAP_ERR_UNSUPPORTED_ENCAP:
3991 * This is a problem with the particular frame we're writing;
3992 * note that, and give the frame number.
3994 simple_error_message_box(
3995 "Frame %u has a network type that can't be saved in a \"%s\" file.",
3996 fdata->num, wtap_file_type_string(args->file_type));
4000 display_basename = g_filename_display_basename(args->fname);
4001 simple_error_message_box(
4002 "An error occurred while writing to the file \"%s\": %s.",
4003 display_basename, wtap_strerror(err));
4004 g_free(display_basename);
4009 write_failure_alert_box(args->fname, err);
4017 * Can this capture file be written out in any format using Wiretap
4018 * rather than by copying the raw data?
4021 cf_can_write_with_wiretap(capture_file *cf)
4023 /* We don't care whether we support the comments in this file or not;
4024 if we can't, we'll offer the user the option of discarding the
4026 return wtap_dump_can_write(cf->linktypes, 0);
4030 * Should we let the user do a save?
4034 * the file has unsaved changes, and we can save it in some
4035 * format through Wiretap
4039 * the file is a temporary file and has no unsaved changes (so
4040 * that "saving" it just means copying it).
4042 * XXX - we shouldn't allow files to be edited if they can't be saved,
4043 * so cf->unsaved_changes should be true only if the file can be saved.
4045 * We don't care whether we support the comments in this file or not;
4046 * if we can't, we'll offer the user the option of discarding the
4050 cf_can_save(capture_file *cf)
4052 if (cf->unsaved_changes && wtap_dump_can_write(cf->linktypes, 0)) {
4053 /* Saved changes, and we can write it out with Wiretap. */
4057 if (cf->is_tempfile && !cf->unsaved_changes) {
4059 * Temporary file with no unsaved changes, so we can just do a
4065 /* Nothing to save. */
4070 * Should we let the user do a "save as"?
4074 * we can save it in some format through Wiretap
4078 * the file is a temporary file and has no unsaved changes (so
4079 * that "saving" it just means copying it).
4081 * XXX - we shouldn't allow files to be edited if they can't be saved,
4082 * so cf->unsaved_changes should be true only if the file can be saved.
4084 * We don't care whether we support the comments in this file or not;
4085 * if we can't, we'll offer the user the option of discarding the
4089 cf_can_save_as(capture_file *cf)
4091 if (wtap_dump_can_write(cf->linktypes, 0)) {
4092 /* We can write it out with Wiretap. */
4096 if (cf->is_tempfile && !cf->unsaved_changes) {
4098 * Temporary file with no unsaved changes, so we can just do a
4104 /* Nothing to save. */
4109 * Does this file have unsaved data?
4112 cf_has_unsaved_data(capture_file *cf)
4115 * If this is a temporary file, or a file with unsaved changes, it
4118 return cf->is_tempfile || cf->unsaved_changes;
4122 * Quick scan to find packet offsets.
4124 static cf_read_status_t
4125 rescan_file(capture_file *cf, const char *fname, gboolean is_tempfile, int *err)
4127 const struct wtap_pkthdr *phdr;
4132 progdlg_t *progbar = NULL;
4136 GTimeVal start_time;
4137 gchar status_str[100];
4138 gint64 progbar_nextstep;
4139 gint64 progbar_quantum;
4144 int displayed_once = 0;
4147 /* Close the old handle. */
4148 wtap_close(cf->wth);
4150 /* Open the new file. */
4151 cf->wth = wtap_open_offline(fname, err, &err_info, TRUE);
4152 if (cf->wth == NULL) {
4153 cf_open_failure_alert_box(fname, *err, err_info, FALSE, 0);
4154 return CF_READ_ERROR;
4157 /* We're scanning a file whose contents should be the same as what
4158 we had before, so we don't discard dissection state etc.. */
4161 /* Set the file name because we need it to set the follow stream filter.
4162 XXX - is that still true? We need it for other reasons, though,
4164 cf->filename = g_strdup(fname);
4166 /* Indicate whether it's a permanent or temporary file. */
4167 cf->is_tempfile = is_tempfile;
4169 /* No user changes yet. */
4170 cf->unsaved_changes = FALSE;
4172 cf->cd_t = wtap_file_type(cf->wth);
4173 cf->linktypes = g_array_sized_new(FALSE, FALSE, (guint) sizeof(int), 1);
4175 cf->snap = wtap_snapshot_length(cf->wth);
4176 if (cf->snap == 0) {
4177 /* Snapshot length not known. */
4178 cf->has_snap = FALSE;
4179 cf->snap = WTAP_MAX_PACKET_SIZE;
4181 cf->has_snap = TRUE;
4183 name_ptr = g_filename_display_basename(cf->filename);
4185 cf_callback_invoke(cf_cb_file_rescan_started, cf);
4187 /* Record whether the file is compressed.
4188 XXX - do we know this at open time? */
4189 cf->iscompressed = wtap_iscompressed(cf->wth);
4191 /* Find the size of the file. */
4192 size = wtap_file_size(cf->wth, NULL);
4194 /* Update the progress bar when it gets to this value. */
4195 progbar_nextstep = 0;
4196 /* When we reach the value that triggers a progress bar update,
4197 bump that value by this amount. */
4199 progbar_quantum = size/N_PROGBAR_UPDATES;
4200 if (progbar_quantum < MIN_QUANTUM)
4201 progbar_quantum = MIN_QUANTUM;
4203 progbar_quantum = 0;
4204 /* Progress so far. */
4208 g_get_current_time(&start_time);
4211 phdr = wtap_phdr(cf->wth);
4212 while ((wtap_read(cf->wth, err, &err_info, &data_offset))) {
4214 fdata = frame_data_sequence_find(cf->frames, framenum);
4215 fdata->file_off = data_offset;
4218 file_pos = wtap_read_so_far(cf->wth);
4220 /* Create the progress bar if necessary.
4221 * Check whether it should be created or not every MIN_NUMBER_OF_PACKET
4223 if ((progbar == NULL) && !(count % MIN_NUMBER_OF_PACKET)) {
4224 progbar_val = calc_progbar_val(cf, size, file_pos, status_str, sizeof(status_str));
4225 progbar = delayed_create_progress_dlg(cf->window, "Rescanning", name_ptr,
4226 TRUE, &stop_flag, &start_time, progbar_val);
4229 /* Update the progress bar, but do it only N_PROGBAR_UPDATES times;
4230 when we update it, we have to run the GTK+ main loop to get it
4231 to repaint what's pending, and doing so may involve an "ioctl()"
4232 to see if there's any pending input from an X server, and doing
4233 that for every packet can be costly, especially on a big file. */
4234 if (file_pos >= progbar_nextstep) {
4235 if (progbar != NULL) {
4236 progbar_val = calc_progbar_val(cf, size, file_pos, status_str, sizeof(status_str));
4237 /* update the packet bar content on the first run or frequently on very large files */
4239 if (progbar_quantum > 500000 || displayed_once == 0) {
4240 if ((auto_scroll_live || displayed_once == 0 || cf->displayed_count < 1000) && cf->count != 0) {
4242 packets_bar_update();
4245 #endif /* HAVE_LIBPCAP */
4246 update_progress_dlg(progbar, progbar_val, status_str);
4248 progbar_nextstep += progbar_quantum;
4253 /* Well, the user decided to abort the rescan. Sadly, as this
4254 isn't a reread, recovering is difficult, so we'll just
4255 close the current capture. */
4259 /* Add this packet's link-layer encapsulation type to cf->linktypes, if
4260 it's not already there.
4261 XXX - yes, this is O(N), so if every packet had a different
4262 link-layer encapsulation type, it'd be O(N^2) to read the file, but
4263 there are probably going to be a small number of encapsulation types
4265 cf_add_encapsulation_type(cf, phdr->pkt_encap);
4268 /* Free the display name */
4271 /* We're done reading the file; destroy the progress bar if it was created. */
4272 if (progbar != NULL)
4273 destroy_progress_dlg(progbar);
4275 /* We're done reading sequentially through the file. */
4276 cf->state = FILE_READ_DONE;
4278 /* Close the sequential I/O side, to free up memory it requires. */
4279 wtap_sequential_close(cf->wth);
4281 /* compute the time it took to load the file */
4282 compute_elapsed(&start_time);
4284 /* Set the file encapsulation type now; we don't know what it is until
4285 we've looked at all the packets, as we don't know until then whether
4286 there's more than one type (and thus whether it's
4287 WTAP_ENCAP_PER_PACKET). */
4288 cf->lnk_t = wtap_file_encap(cf->wth);
4290 cf_callback_invoke(cf_cb_file_rescan_finished, cf);
4293 /* Our caller will give up at this point. */
4294 return CF_READ_ABORTED;
4298 /* Put up a message box noting that the read failed somewhere along
4299 the line. Don't throw out the stuff we managed to read, though,
4303 case WTAP_ERR_UNSUPPORTED:
4304 simple_error_message_box(
4305 "The capture file contains record data that Wireshark doesn't support.\n(%s)",
4310 case WTAP_ERR_UNSUPPORTED_ENCAP:
4311 simple_error_message_box(
4312 "The capture file has a packet with a network type that Wireshark doesn't support.\n(%s)",
4317 case WTAP_ERR_CANT_READ:
4318 simple_error_message_box(
4319 "An attempt to read from the capture file failed for"
4320 " some unknown reason.");
4323 case WTAP_ERR_SHORT_READ:
4324 simple_error_message_box(
4325 "The capture file appears to have been cut short"
4326 " in the middle of a packet.");
4329 case WTAP_ERR_BAD_FILE:
4330 simple_error_message_box(
4331 "The capture file appears to be damaged or corrupt.\n(%s)",
4336 case WTAP_ERR_DECOMPRESS:
4337 simple_error_message_box(
4338 "The compressed capture file appears to be damaged or corrupt.\n"
4344 simple_error_message_box(
4345 "An error occurred while reading the"
4346 " capture file: %s.", wtap_strerror(*err));
4349 return CF_READ_ERROR;
4355 cf_save_packets(capture_file *cf, const char *fname, guint save_format,
4356 gboolean compressed, gboolean discard_comments,
4357 gboolean dont_reopen)
4360 gchar *fname_new = NULL;
4363 struct addrinfo *addrs;
4367 gchar *display_basename;
4374 save_callback_args_t callback_args;
4376 cf_callback_invoke(cf_cb_file_save_started, (gpointer)fname);
4378 addrs = get_addrinfo_list();
4380 if (save_format == cf->cd_t && compressed == cf->iscompressed
4381 && !discard_comments && !cf->unsaved_changes
4382 && !(addrs && addrs->ai_next &&
4383 wtap_dump_has_name_resolution(save_format))) {
4384 /* We're saving in the format it's already in, and we're
4385 not discarding comments, and there are no changes we have
4386 in memory that aren't saved to the file, and we have no name
4387 resolution blocks to write, so we can just move or copy the raw data. */
4389 if (cf->is_tempfile) {
4390 /* The file being saved is a temporary file from a live
4391 capture, so it doesn't need to stay around under that name;
4392 first, try renaming the capture buffer file to the new name.
4393 This acts as a "safe save", in that, if the file already
4394 exists, the existing file will be removed only if the rename
4397 Sadly, on Windows, as we have the current capture file
4398 open, even MoveFileEx() with MOVEFILE_REPLACE_EXISTING
4399 (to cause the rename to remove an existing target), as
4400 done by ws_stdio_rename() (ws_rename() is #defined to
4401 be ws_stdio_rename() on Windows) will fail.
4403 According to the MSDN documentation for CreateFile(), if,
4404 when we open a capture file, we were to directly do a CreateFile(),
4405 opening with FILE_SHARE_DELETE|FILE_SHARE_READ, and then
4406 convert it to a file descriptor with _open_osfhandle(),
4407 that would allow the file to be renamed out from under us.
4409 However, that doesn't work in practice. Perhaps the problem
4410 is that the process doing the rename is the process that
4411 has the file open. */
4413 if (ws_rename(cf->filename, fname) == 0) {
4414 /* That succeeded - there's no need to copy the source file. */
4415 how_to_save = SAVE_WITH_MOVE;
4417 if (errno == EXDEV) {
4418 /* They're on different file systems, so we have to copy the
4420 how_to_save = SAVE_WITH_COPY;
4422 /* The rename failed, but not because they're on different
4423 file systems - put up an error message. (Or should we
4424 just punt and try to copy? The only reason why I'd
4425 expect the rename to fail and the copy to succeed would
4426 be if we didn't have permission to remove the file from
4427 the temporary directory, and that might be fixable - but
4428 is it worth requiring the user to go off and fix it?) */
4429 cf_rename_failure_alert_box(fname, errno);
4434 how_to_save = SAVE_WITH_COPY;
4437 /* It's a permanent file, so we should copy it, and not remove the
4439 how_to_save = SAVE_WITH_COPY;
4442 if (how_to_save == SAVE_WITH_COPY) {
4443 /* Copy the file, if we haven't moved it. If we're overwriting
4444 an existing file, we do it with a "safe save", by writing
4445 to a new file and, if the write succeeds, renaming the
4446 new file on top of the old file. */
4447 if (file_exists(fname)) {
4448 fname_new = g_strdup_printf("%s~", fname);
4449 if (!copy_file_binary_mode(cf->filename, fname_new))
4452 if (!copy_file_binary_mode(cf->filename, fname))
4457 /* Either we're saving in a different format or we're saving changes,
4458 such as added, modified, or removed comments, that haven't yet
4459 been written to the underlying file; we can't do that by copying
4460 or moving the capture file, we have to do it by writing the packets
4463 wtapng_section_t *shb_hdr = NULL;
4464 wtapng_iface_descriptions_t *idb_inf = NULL;
4467 shb_hdr = wtap_file_get_shb_info(cf->wth);
4468 idb_inf = wtap_file_get_idb_info(cf->wth);
4470 /* Determine what file encapsulation type we should use. */
4471 encap = wtap_dump_file_encap_type(cf->linktypes);
4473 if (file_exists(fname)) {
4474 /* We're overwriting an existing file; write out to a new file,
4475 and, if that succeeds, rename the new file on top of the
4476 old file. That makes this a "safe save", so that we don't
4477 lose the old file if we have a problem writing out the new
4478 file. (If the existing file is the current capture file,
4479 we *HAVE* to do that, otherwise we're overwriting the file
4480 from which we're reading the packets that we're writing!) */
4481 fname_new = g_strdup_printf("%s~", fname);
4482 pdh = wtap_dump_open_ng(fname_new, save_format, encap, cf->snap,
4483 compressed, shb_hdr, idb_inf, &err);
4485 pdh = wtap_dump_open_ng(fname, save_format, encap, cf->snap,
4486 compressed, shb_hdr, idb_inf, &err);
4492 cf_open_failure_alert_box(fname, err, NULL, TRUE, save_format);
4496 /* Add address resolution */
4497 wtap_dump_set_addrinfo_list(pdh, addrs);
4499 /* Iterate through the list of packets, processing all the packets. */
4500 callback_args.pdh = pdh;
4501 callback_args.fname = fname;
4502 callback_args.file_type = save_format;
4503 switch (process_specified_packets(cf, NULL, "Saving", "packets",
4504 TRUE, save_packet, &callback_args)) {
4507 /* Completed successfully. */
4511 /* The user decided to abort the saving.
4512 If we're writing to a temporary file, remove it.
4513 XXX - should we do so even if we're not writing to a
4515 wtap_dump_close(pdh, &err);
4516 if (fname_new != NULL)
4517 ws_unlink(fname_new);
4518 cf_callback_invoke(cf_cb_file_save_stopped, NULL);
4519 return CF_WRITE_ABORTED;
4522 /* Error while saving.
4523 If we're writing to a temporary file, remove it. */
4524 if (fname_new != NULL)
4525 ws_unlink(fname_new);
4526 wtap_dump_close(pdh, &err);
4530 if (!wtap_dump_close(pdh, &err)) {
4531 cf_close_failure_alert_box(fname, err);
4535 how_to_save = SAVE_WITH_WTAP;
4538 if (fname_new != NULL) {
4539 /* We wrote out to fname_new, and should rename it on top of
4540 fname. fname_new is now closed, so that should be possible even
4541 on Windows. However, on Windows, we first need to close whatever
4542 file descriptors we have open for fname. */
4544 wtap_fdclose(cf->wth);
4546 /* Now do the rename. */
4547 if (ws_rename(fname_new, fname) == -1) {
4548 /* Well, the rename failed. */
4549 cf_rename_failure_alert_box(fname, errno);
4551 /* Attempt to reopen the random file descriptor using the
4552 current file's filename. (At this point, the sequential
4553 file descriptor is closed.) */
4554 if (!wtap_fdreopen(cf->wth, cf->filename, &err)) {
4555 /* Oh, well, we're screwed. */
4556 display_basename = g_filename_display_basename(cf->filename);
4557 simple_error_message_box(
4558 file_open_error_message(err, FALSE), display_basename);
4559 g_free(display_basename);
4566 cf_callback_invoke(cf_cb_file_save_finished, NULL);
4567 cf->unsaved_changes = FALSE;
4570 switch (how_to_save) {
4572 case SAVE_WITH_MOVE:
4573 /* We just moved the file, so the wtap structure refers to the
4574 new file, and all the information other than the filename
4575 and the "is temporary" status applies to the new file; just
4577 g_free(cf->filename);
4578 cf->filename = g_strdup(fname);
4579 cf->is_tempfile = FALSE;
4580 cf_callback_invoke(cf_cb_file_fast_save_finished, cf);
4583 case SAVE_WITH_COPY:
4584 /* We just copied the file, s all the information other than
4585 the wtap structure, the filename, and the "is temporary"
4586 status applies to the new file; just update that. */
4587 wtap_close(cf->wth);
4588 cf->wth = wtap_open_offline(fname, &err, &err_info, TRUE);
4589 if (cf->wth == NULL) {
4590 cf_open_failure_alert_box(fname, err, err_info, FALSE, 0);
4593 g_free(cf->filename);
4594 cf->filename = g_strdup(fname);
4595 cf->is_tempfile = FALSE;
4597 cf_callback_invoke(cf_cb_file_fast_save_finished, cf);
4600 case SAVE_WITH_WTAP:
4601 /* Open and read the file we saved to.
4603 XXX - this is somewhat of a waste; we already have the
4604 packets, all this gets us is updated file type information
4605 (which we could just stuff into "cf"), and having the new
4606 file be the one we have opened and from which we're reading
4607 the data, and it means we have to spend time opening and
4608 reading the file, which could be a significant amount of
4609 time if the file is large.
4611 If the capture-file-writing code were to return the
4612 seek offset of each packet it writes, we could save that
4613 in the frame_data structure for the frame, and just open
4614 the file without reading it again...
4616 ...as long as, for gzipped files, the process of writing
4617 out the file *also* generates the information needed to
4618 support fast random access to the compressed file. */
4619 if (rescan_file(cf, fname, FALSE, &err) != CF_READ_OK) {
4620 /* The rescan failed; just close the file. Either
4621 a dialog was popped up for the failure, so the
4622 user knows what happened, or they stopped the
4623 rescan, in which case they know what happened. */
4629 /* If we were told to discard the comments, do so. */
4630 if (discard_comments) {
4631 /* Remove SHB comment, if any. */
4632 wtap_write_shb_comment(cf->wth, NULL);
4634 /* Remove packet comments. */
4635 for (framenum = 1; framenum <= cf->count; framenum++) {
4636 fdata = frame_data_sequence_find(cf->frames, framenum);
4637 if (fdata->opt_comment) {
4638 g_free(fdata->opt_comment);
4639 fdata->opt_comment = NULL;
4640 cf->packet_comment_count--;
4648 if (fname_new != NULL) {
4649 /* We were trying to write to a temporary file; get rid of it if it
4650 exists. (We don't care whether this fails, as, if it fails,
4651 there's not much we can do about it. I guess if it failed for
4652 a reason other than "it doesn't exist", we could report an
4653 error, so the user knows there's a junk file that they might
4654 want to clean up.) */
4655 ws_unlink(fname_new);
4658 cf_callback_invoke(cf_cb_file_save_failed, NULL);
4659 return CF_WRITE_ERROR;
4663 cf_export_specified_packets(capture_file *cf, const char *fname,
4664 packet_range_t *range, guint save_format,
4665 gboolean compressed)
4667 gchar *fname_new = NULL;
4670 save_callback_args_t callback_args;
4671 wtapng_section_t *shb_hdr;
4672 wtapng_iface_descriptions_t *idb_inf;
4675 cf_callback_invoke(cf_cb_file_export_specified_packets_started, (gpointer)fname);
4677 packet_range_process_init(range);
4679 /* We're writing out specified packets from the specified capture
4680 file to another file. Even if all captured packets are to be
4681 written, don't special-case the operation - read each packet
4682 and then write it out if it's one of the specified ones. */
4684 shb_hdr = wtap_file_get_shb_info(cf->wth);
4685 idb_inf = wtap_file_get_idb_info(cf->wth);
4687 /* Determine what file encapsulation type we should use. */
4688 encap = wtap_dump_file_encap_type(cf->linktypes);
4690 if (file_exists(fname)) {
4691 /* We're overwriting an existing file; write out to a new file,
4692 and, if that succeeds, rename the new file on top of the
4693 old file. That makes this a "safe save", so that we don't
4694 lose the old file if we have a problem writing out the new
4695 file. (If the existing file is the current capture file,
4696 we *HAVE* to do that, otherwise we're overwriting the file
4697 from which we're reading the packets that we're writing!) */
4698 fname_new = g_strdup_printf("%s~", fname);
4699 pdh = wtap_dump_open_ng(fname_new, save_format, encap, cf->snap,
4700 compressed, shb_hdr, idb_inf, &err);
4702 pdh = wtap_dump_open_ng(fname, save_format, encap, cf->snap,
4703 compressed, shb_hdr, idb_inf, &err);
4709 cf_open_failure_alert_box(fname, err, NULL, TRUE, save_format);
4713 /* Add address resolution */
4714 wtap_dump_set_addrinfo_list(pdh, get_addrinfo_list());
4716 /* Iterate through the list of packets, processing the packets we were
4719 XXX - we've already called "packet_range_process_init(range)", but
4720 "process_specified_packets()" will do it again. Fortunately,
4721 that's harmless in this case, as we haven't done anything to
4722 "range" since we initialized it. */
4723 callback_args.pdh = pdh;
4724 callback_args.fname = fname;
4725 callback_args.file_type = save_format;
4726 switch (process_specified_packets(cf, range, "Writing", "specified packets",
4727 TRUE, save_packet, &callback_args)) {
4730 /* Completed successfully. */
4734 /* The user decided to abort the saving.
4735 If we're writing to a temporary file, remove it.
4736 XXX - should we do so even if we're not writing to a
4738 wtap_dump_close(pdh, &err);
4739 if (fname_new != NULL)
4740 ws_unlink(fname_new);
4741 cf_callback_invoke(cf_cb_file_export_specified_packets_stopped, NULL);
4742 return CF_WRITE_ABORTED;
4746 /* Error while saving.
4747 If we're writing to a temporary file, remove it. */
4748 if (fname_new != NULL)
4749 ws_unlink(fname_new);
4750 wtap_dump_close(pdh, &err);
4754 if (!wtap_dump_close(pdh, &err)) {
4755 cf_close_failure_alert_box(fname, err);
4759 if (fname_new != NULL) {
4760 /* We wrote out to fname_new, and should rename it on top of
4761 fname; fname is now closed, so that should be possible even
4762 on Windows. Do the rename. */
4763 if (ws_rename(fname_new, fname) == -1) {
4764 /* Well, the rename failed. */
4765 cf_rename_failure_alert_box(fname, errno);
4770 cf_callback_invoke(cf_cb_file_export_specified_packets_finished, NULL);
4774 if (fname_new != NULL) {
4775 /* We were trying to write to a temporary file; get rid of it if it
4776 exists. (We don't care whether this fails, as, if it fails,
4777 there's not much we can do about it. I guess if it failed for
4778 a reason other than "it doesn't exist", we could report an
4779 error, so the user knows there's a junk file that they might
4780 want to clean up.) */
4781 ws_unlink(fname_new);
4784 cf_callback_invoke(cf_cb_file_export_specified_packets_failed, NULL);
4785 return CF_WRITE_ERROR;
4789 cf_open_failure_alert_box(const char *filename, int err, gchar *err_info,
4790 gboolean for_writing, int file_type)
4792 gchar *display_basename;
4795 /* Wiretap error. */
4796 display_basename = g_filename_display_basename(filename);
4799 case WTAP_ERR_NOT_REGULAR_FILE:
4800 simple_error_message_box(
4801 "The file \"%s\" is a \"special file\" or socket or other non-regular file.",
4805 case WTAP_ERR_RANDOM_OPEN_PIPE:
4806 /* Seen only when opening a capture file for reading. */
4807 simple_error_message_box(
4808 "The file \"%s\" is a pipe or FIFO; Wireshark can't read pipe or FIFO files.\n"
4809 "To capture from a pipe or FIFO use wireshark -i -",
4813 case WTAP_ERR_FILE_UNKNOWN_FORMAT:
4814 /* Seen only when opening a capture file for reading. */
4815 simple_error_message_box(
4816 "The file \"%s\" isn't a capture file in a format Wireshark understands.",
4820 case WTAP_ERR_UNSUPPORTED:
4821 /* Seen only when opening a capture file for reading. */
4822 simple_error_message_box(
4823 "The file \"%s\" isn't a capture file in a format Wireshark understands.\n"
4825 display_basename, err_info);
4829 case WTAP_ERR_CANT_WRITE_TO_PIPE:
4830 /* Seen only when opening a capture file for writing. */
4831 simple_error_message_box(
4832 "The file \"%s\" is a pipe, and %s capture files can't be "
4833 "written to a pipe.",
4834 display_basename, wtap_file_type_string(file_type));
4837 case WTAP_ERR_UNSUPPORTED_FILE_TYPE:
4838 /* Seen only when opening a capture file for writing. */
4839 simple_error_message_box(
4840 "Wireshark doesn't support writing capture files in that format.");
4843 case WTAP_ERR_UNSUPPORTED_ENCAP:
4845 simple_error_message_box("Wireshark can't save this capture in that format.");
4847 simple_error_message_box(
4848 "The file \"%s\" is a capture for a network type that Wireshark doesn't support.\n"
4850 display_basename, err_info);
4855 case WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED:
4857 simple_error_message_box(
4858 "Wireshark can't save this capture in that format.");
4860 simple_error_message_box(
4861 "The file \"%s\" is a capture for a network type that Wireshark doesn't support.",
4866 case WTAP_ERR_BAD_FILE:
4867 /* Seen only when opening a capture file for reading. */
4868 simple_error_message_box(
4869 "The file \"%s\" appears to be damaged or corrupt.\n"
4871 display_basename, err_info);
4875 case WTAP_ERR_CANT_OPEN:
4877 simple_error_message_box(
4878 "The file \"%s\" could not be created for some unknown reason.",
4881 simple_error_message_box(
4882 "The file \"%s\" could not be opened for some unknown reason.",
4887 case WTAP_ERR_SHORT_READ:
4888 simple_error_message_box(
4889 "The file \"%s\" appears to have been cut short"
4890 " in the middle of a packet or other data.",
4894 case WTAP_ERR_SHORT_WRITE:
4895 simple_error_message_box(
4896 "A full header couldn't be written to the file \"%s\".",
4900 case WTAP_ERR_COMPRESSION_NOT_SUPPORTED:
4901 simple_error_message_box(
4902 "This file type cannot be written as a compressed file.");
4905 case WTAP_ERR_DECOMPRESS:
4906 simple_error_message_box(
4907 "The compressed file \"%s\" appears to be damaged or corrupt.\n"
4908 "(%s)", display_basename, err_info);
4913 simple_error_message_box(
4914 "The file \"%s\" could not be %s: %s.",
4916 for_writing ? "created" : "opened",
4917 wtap_strerror(err));
4920 g_free(display_basename);
4923 open_failure_alert_box(filename, err, for_writing);
4928 * XXX - whether we mention the source pathname, the target pathname,
4929 * or both depends on the error and on what we find if we look for
4930 * one or both of them.
4933 cf_rename_failure_alert_box(const char *filename, int err)
4935 gchar *display_basename;
4937 display_basename = g_filename_display_basename(filename);
4941 /* XXX - should check whether the source exists and, if not,
4942 report it as the problem and, if so, report the destination
4944 simple_error_message_box("The path to the file \"%s\" doesn't exist.",
4949 /* XXX - if we're doing a rename after a safe save, we should
4950 probably say something else. */
4951 simple_error_message_box("You don't have permission to move the capture file to \"%s\".",
4956 /* XXX - this should probably mention both the source and destination
4958 simple_error_message_box("The file \"%s\" could not be moved: %s.",
4959 display_basename, wtap_strerror(err));
4962 g_free(display_basename);
4965 /* Check for write errors - if the file is being written to an NFS server,
4966 a write error may not show up until the file is closed, as NFS clients
4967 might not send writes to the server until the "write()" call finishes,
4968 so that the write may fail on the server but the "write()" may succeed. */
4970 cf_close_failure_alert_box(const char *filename, int err)
4972 gchar *display_basename;
4975 /* Wiretap error. */
4976 display_basename = g_filename_display_basename(filename);
4979 case WTAP_ERR_CANT_CLOSE:
4980 simple_error_message_box(
4981 "The file \"%s\" couldn't be closed for some unknown reason.",
4985 case WTAP_ERR_SHORT_WRITE:
4986 simple_error_message_box(
4987 "Not all the packets could be written to the file \"%s\".",
4992 simple_error_message_box(
4993 "An error occurred while closing the file \"%s\": %s.",
4994 display_basename, wtap_strerror(err));
4997 g_free(display_basename);
5000 We assume that a close error from the OS is really a write error. */
5001 write_failure_alert_box(filename, err);
5005 /* Reload the current capture file. */
5007 cf_reload(capture_file *cf) {
5009 gboolean is_tempfile;
5012 /* If the file could be opened, "cf_open()" calls "cf_close()"
5013 to get rid of state for the old capture file before filling in state
5014 for the new capture file. "cf_close()" will remove the file if
5015 it's a temporary file; we don't want that to happen (for one thing,
5016 it'd prevent subsequent reopens from working). Remember whether it's
5017 a temporary file, mark it as not being a temporary file, and then
5018 reopen it as the type of file it was.
5020 Also, "cf_close()" will free "cf->filename", so we must make
5021 a copy of it first. */
5022 filename = g_strdup(cf->filename);
5023 is_tempfile = cf->is_tempfile;
5024 cf->is_tempfile = FALSE;
5025 if (cf_open(cf, filename, is_tempfile, &err) == CF_OK) {
5026 switch (cf_read(cf, TRUE)) {
5030 /* Just because we got an error, that doesn't mean we were unable
5031 to read any of the file; we handle what we could get from the
5035 case CF_READ_ABORTED:
5036 /* The user bailed out of re-reading the capture file; the
5037 capture file has been closed - just free the capture file name
5038 string and return (without changing the last containing
5044 /* The open failed, so "cf->is_tempfile" wasn't set to "is_tempfile".
5045 Instead, the file was left open, so we should restore "cf->is_tempfile"
5048 XXX - change the menu? Presumably "cf_open()" will do that;
5049 make sure it does! */
5050 cf->is_tempfile = is_tempfile;
5052 /* "cf_open()" made a copy of the file name we handed it, so
5053 we should free up our copy. */
5063 * indent-tabs-mode: nil
5066 * ex: set shiftwidth=2 tabstop=8 expandtab:
5067 * :indentSize=2:tabSize=8:noTabs=true: