2 * Definitions for file structures and routines
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 #include "packet-range.h"
29 #include "wiretap/wtap.h"
30 #include <epan/dfilter/dfilter.h>
33 #include <epan/epan.h>
38 /** Return values from functions that only can succeed or fail. */
40 CF_OK, /**< operation succeeded */
41 CF_ERROR /**< operation got an error (function may provide err with details) */
44 /** Return values from functions that read capture files. */
46 CF_READ_OK, /**< operation succeeded */
47 CF_READ_ERROR, /**< operation got an error (function may provide err with details) */
48 CF_READ_ABORTED /**< operation aborted by user */
51 /** Return values from functions that print sets of packets. */
53 CF_PRINT_OK, /**< print operation succeeded */
54 CF_PRINT_OPEN_ERROR, /**< print operation failed while opening printer */
55 CF_PRINT_WRITE_ERROR /**< print operation failed while writing to the printer */
61 cf_cb_file_read_start,
62 cf_cb_file_read_finished,
64 cf_cb_live_capture_prepared,
65 cf_cb_live_capture_update_started,
66 cf_cb_live_capture_update_continue,
67 cf_cb_live_capture_update_finished,
68 cf_cb_live_capture_fixed_started,
69 cf_cb_live_capture_fixed_continue,
70 cf_cb_live_capture_fixed_finished,
71 cf_cb_live_capture_stopping,
73 cf_cb_packet_selected,
74 cf_cb_packet_unselected,
75 cf_cb_field_unselected,
76 cf_cb_file_safe_started,
77 cf_cb_file_safe_finished,
78 cf_cb_file_safe_reload_finished,
79 cf_cb_file_safe_failed
82 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
85 cf_callback_invoke(int event, gpointer data);
88 cf_callback_add(cf_callback_t func, gpointer user_data);
91 cf_callback_remove(cf_callback_t func);
94 * Open a capture file.
96 * @param cf the capture file to be opened
97 * @param fname the filename to be opened
98 * @param is_tempfile is this a temporary file?
99 * @return one of cf_status_t
101 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
104 * Close a capture file.
106 * @param cf the capture file to be closed
108 void cf_close(capture_file *cf);
111 * Reload a capture file.
113 * @param cf the capture file to be reloaded
115 void cf_reload(capture_file *cf);
118 * Read all packets of a capture file into the internal structures.
120 * @param cf the capture file to be read
121 * @return one of cf_read_status_t
123 cf_read_status_t cf_read(capture_file *cf);
126 * Start reading from the end of a capture file.
127 * This is used in "Update list of packets in Real-Time".
129 * @param cf the capture file to be read from
130 * @param fname the filename to be read from
131 * @param is_tempfile is this a temporary file?
132 * @param err the error code, if an error had occured
133 * @return one of cf_status_t
135 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
138 * Read packets from the "end" of a capture file.
140 * @param cf the capture file to be read from
141 * @param to_read the number of packets to read
142 * @param err the error code, if an error had occured
143 * @return one of cf_read_status_t
145 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
148 * Finish reading from "end" of a capture file.
150 * @param cf the capture file to be read from
151 * @param err the error code, if an error had occured
152 * @return one of cf_read_status_t
154 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
157 * Determine whether this capture file (or a range of it) can be saved
158 * (except by copying the raw file data).
160 * @param cf the capture file to check
161 * @return TRUE if it can be saved, FALSE if it can't
163 gboolean cf_can_save_as(capture_file *cf);
166 * Save a capture file (or a range of it).
168 * @param cf the capture file to save to
169 * @param fname the filename to save to
170 * @param range the range of packets to save
171 * @param save_format the format of the file to save (libpcap, ...)
172 * @param compressed wether to gzip compress the file
173 * @return one of cf_status_t
175 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed);
178 * Get a displayable name of the capture file.
180 * @param cf the capture file
181 * @return the displayable name (don't have to be g_free'd)
183 const gchar *cf_get_display_name(capture_file *cf);
186 * Get the number of packets in the capture file.
188 * @param cf the capture file
189 * @return the number of packets in the capture file
191 int cf_get_packet_count(capture_file *cf);
194 * Set the number of packets in the capture file.
196 * @param cf the capture file
197 * @param the number of packets in the capture file
199 void cf_set_packet_count(capture_file *cf, int packet_count);
202 * Is this capture file a temporary file?
204 * @param cf the capture file
205 * @return TRUE if it's a temporary file, FALSE otherwise
207 gboolean cf_is_tempfile(capture_file *cf);
210 * Set flag, that this file is a tempfile.
212 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
215 * Set flag, if the number of packet drops while capturing are known or not.
217 * @param cf the capture file
218 * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
220 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
223 * Set the number of packet drops while capturing.
225 * @param cf the capture file
226 * @param drops the number of packet drops occured while capturing
228 void cf_set_drops(capture_file *cf, guint32 drops);
231 * Get flag state, if the number of packet drops while capturing are known or not.
233 * @param cf the capture file
234 * @return TRUE if the number of packet drops are known, FALSE otherwise
236 gboolean cf_get_drops_known(capture_file *cf);
239 * Get the number of packet drops while capturing.
241 * @param cf the capture file
242 * @return the number of packet drops occured while capturing
244 guint32 cf_get_drops(capture_file *cf);
247 * Set the read filter.
248 * @todo this shouldn't be required, remove it somehow
250 * @param cf the capture file
251 * @param rfcode the readfilter
253 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
256 * "Display Filter" packets in the capture file.
258 * @param cf the capture file
259 * @param dfilter the display filter
260 * @param force TRUE if do in any case, FALSE only if dfilter changed
261 * @return one of cf_status_t
263 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
266 * At least one "Refence Time" flag has changed, rescan all packets.
268 * @param cf the capture file
270 void cf_reftime_packets(capture_file *cf);
273 * At least one "Refence Time" flag has changed, rescan all packets.
275 * @param cf the capture file
277 void cf_colorize_packets(capture_file *cf);
280 * "Something" has changed, rescan all packets.
282 * @param cf the capture file
284 void cf_redissect_packets(capture_file *cf);
287 * Rescan all packets and just run taps - don't reconstruct the display.
289 * @param cf the capture file
290 * @param do_columns TRUE if columns are to be generated, FALSE otherwise
291 * @return one of cf_read_status_t
293 cf_read_status_t cf_retap_packets(capture_file *cf, gboolean do_columns);
296 * The time format has changed, rescan all packets.
298 * @param cf the capture file
300 void cf_change_time_formats(capture_file *cf);
303 * Print the capture file.
305 * @param cf the capture file
306 * @param print_args the arguments what and how to print
307 * @return one of cf_print_status_t
309 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
312 * Print (export) the capture file into PDML format.
314 * @param cf the capture file
315 * @param print_args the arguments what and how to export
316 * @return one of cf_print_status_t
318 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
321 * Print (export) the capture file into PSML format.
323 * @param cf the capture file
324 * @param print_args the arguments what and how to export
325 * @return one of cf_print_status_t
327 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
330 * Print (export) the capture file into CSV format.
332 * @param cf the capture file
333 * @param print_args the arguments what and how to export
334 * @return one of cf_print_status_t
336 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
339 * Print (export) the capture file into C Arrays format.
341 * @param cf the capture file
342 * @param print_args the arguments what and how to export
343 * @return one of cf_print_status_t
345 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
348 * Find Packet in protocol tree.
350 * @param cf the capture file
351 * @param string the string to find
352 * @return TRUE if a packet was found, FALSE otherwise
354 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
357 * Find Packet in summary line.
359 * @param cf the capture file
360 * @param string the string to find
361 * @return TRUE if a packet was found, FALSE otherwise
363 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
366 * Find Packet in packet data.
368 * @param cf the capture file
369 * @param string the string to find
370 * @param string_size the size of the string to find
371 * @return TRUE if a packet was found, FALSE otherwise
373 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
377 * Find Packet by display filter.
379 * @param cf the capture file
380 * @param sfcode the display filter to find a packet for
381 * @return TRUE if a packet was found, FALSE otherwise
383 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
386 * GoTo Packet in first row.
388 * @param cf the capture file
389 * @return TRUE if the first row exists, FALSE otherwise
391 gboolean cf_goto_top_frame(capture_file *cf);
394 * GoTo Packet in last row.
396 * @param cf the capture file
397 * @return TRUE if last row exists, FALSE otherwise
399 gboolean cf_goto_bottom_frame(capture_file *cf);
402 * GoTo Packet with the given row.
404 * @param cf the capture file
405 * @param row the row to go to
406 * @return TRUE if this row exists, FALSE otherwise
408 gboolean cf_goto_frame(capture_file *cf, guint row);
411 * Go to frame specified by currently selected protocol tree field.
412 * (Go To Corresponding Packet)
413 * @todo this is ugly and should be improved!
415 * @param cf the capture file
416 * @return TRUE if this packet exists, FALSE otherwise
418 gboolean cf_goto_framenum(capture_file *cf);
421 * Select the packet in the given row.
423 * @param cf the capture file
424 * @param row the row to select
426 void cf_select_packet(capture_file *cf, int row);
429 * Unselect all packets, if any.
431 * @param cf the capture file
432 * @param row the row to select
434 void cf_unselect_packet(capture_file *cf);
437 * Unselect all protocol tree fields, if any.
439 * @param cf the capture file
440 * @param row the row to select
442 void cf_unselect_field(capture_file *cf);
445 * Mark a particular frame in a particular capture.
447 * @param cf the capture file
448 * @param frame the frame to be marked
450 void cf_mark_frame(capture_file *cf, frame_data *frame);
453 * Unmark a particular frame in a particular capture.
455 * @param cf the capture file
456 * @param frame the frame to be unmarked
458 void cf_unmark_frame(capture_file *cf, frame_data *frame);
461 * Convert error number and info to a complete message.
463 * @param err the error number
464 * @param err_info a string with additional details about this error
465 * @return statically allocated error message
467 char *cf_read_error_message(int err, gchar *err_info);
470 * Merge two (or more) capture files into one.
471 * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
473 * @param out_filename pointer to output filename; if output filename is
474 * NULL, a temporary file name is generated and *out_filename is set
475 * to point to the generated file name
476 * @param in_file_count the number of input files to merge
477 * @param in_filnames array of input filenames
478 * @param file_type the output filetype
479 * @param do_append FALSE to merge chronologically, TRUE simply append
480 * @return one of cf_status_t
483 cf_merge_files(char **out_filename, int in_file_count,
484 char *const *in_filenames, int file_type, gboolean do_append);