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_started,
62 cf_cb_file_read_finished,
63 cf_cb_packet_selected,
64 cf_cb_packet_unselected,
65 cf_cb_field_unselected,
66 cf_cb_file_save_started,
67 cf_cb_file_save_finished,
68 cf_cb_file_save_reload_finished,
69 cf_cb_file_save_failed
72 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
75 cf_callback_add(cf_callback_t func, gpointer user_data);
78 cf_callback_remove(cf_callback_t func);
81 * Open a capture file.
83 * @param cf the capture file to be opened
84 * @param fname the filename to be opened
85 * @param is_tempfile is this a temporary file?
86 * @return one of cf_status_t
88 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
91 * Close a capture file.
93 * @param cf the capture file to be closed
95 void cf_close(capture_file *cf);
98 * Reload a capture file.
100 * @param cf the capture file to be reloaded
102 void cf_reload(capture_file *cf);
105 * Read all packets of a capture file into the internal structures.
107 * @param cf the capture file to be read
108 * @param from_save reread asked from cf_save
109 * @return one of cf_read_status_t
111 cf_read_status_t cf_read(capture_file *cf, gboolean from_save);
114 * Start reading from the end of a capture file.
115 * This is used in "Update list of packets in Real-Time".
117 * @param cf the capture file to be read from
118 * @param fname the filename to be read from
119 * @param is_tempfile is this a temporary file?
120 * @param err the error code, if an error had occured
121 * @return one of cf_status_t
123 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
126 * Read packets from the "end" of a capture file.
128 * @param cf the capture file to be read from
129 * @param to_read the number of packets to read
130 * @param err the error code, if an error had occured
131 * @return one of cf_read_status_t
133 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
136 * Finish reading from "end" of a capture file.
138 * @param cf the capture file to be read from
139 * @param err the error code, if an error had occured
140 * @return one of cf_read_status_t
142 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
145 * Determine whether this capture file (or a range of it) can be saved
146 * (except by copying the raw file data).
148 * @param cf the capture file to check
149 * @return TRUE if it can be saved, FALSE if it can't
151 gboolean cf_can_save_as(capture_file *cf);
154 * Save a capture file (or a range of it).
156 * @param cf the capture file to save to
157 * @param fname the filename to save to
158 * @param range the range of packets to save
159 * @param save_format the format of the file to save (libpcap, ...)
160 * @param compressed whether to gzip compress the file
161 * @return one of cf_status_t
163 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed);
166 * Get a displayable name of the capture file.
168 * @param cf the capture file
169 * @return the displayable name (don't have to be g_free'd)
171 const gchar *cf_get_display_name(capture_file *cf);
174 * Get the number of packets in the capture file.
176 * @param cf the capture file
177 * @return the number of packets in the capture file
179 int cf_get_packet_count(capture_file *cf);
182 * Set the number of packets in the capture file.
184 * @param cf the capture file
185 * @param the number of packets in the capture file
187 void cf_set_packet_count(capture_file *cf, int packet_count);
190 * Is this capture file a temporary file?
192 * @param cf the capture file
193 * @return TRUE if it's a temporary file, FALSE otherwise
195 gboolean cf_is_tempfile(capture_file *cf);
198 * Set flag, that this file is a tempfile.
200 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
203 * Set flag, if the number of packet drops while capturing are known or not.
205 * @param cf the capture file
206 * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
208 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
211 * Set the number of packet drops while capturing.
213 * @param cf the capture file
214 * @param drops the number of packet drops occured while capturing
216 void cf_set_drops(capture_file *cf, guint32 drops);
219 * Get flag state, if the number of packet drops while capturing are known or not.
221 * @param cf the capture file
222 * @return TRUE if the number of packet drops are known, FALSE otherwise
224 gboolean cf_get_drops_known(capture_file *cf);
227 * Get the number of packet drops while capturing.
229 * @param cf the capture file
230 * @return the number of packet drops occured while capturing
232 guint32 cf_get_drops(capture_file *cf);
235 * Set the read filter.
236 * @todo this shouldn't be required, remove it somehow
238 * @param cf the capture file
239 * @param rfcode the readfilter
241 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
244 * "Display Filter" packets in the capture file.
246 * @param cf the capture file
247 * @param dfilter the display filter
248 * @param force TRUE if do in any case, FALSE only if dfilter changed
249 * @return one of cf_status_t
251 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
254 * At least one "Refence Time" flag has changed, rescan all packets.
256 * @param cf the capture file
258 void cf_reftime_packets(capture_file *cf);
261 * Return the time it took to load the file
263 gulong cf_get_computed_elapsed(void);
266 * The coloring rules have changed, redo coloring
268 * @param cf the capture file
270 void cf_colorize_packets(capture_file *cf);
273 * "Something" has changed, rescan all packets.
275 * @param cf the capture file
277 void cf_redissect_packets(capture_file *cf);
280 * Rescan all packets and just run taps - don't reconstruct the display.
282 * @param cf the capture file
283 * @return one of cf_read_status_t
285 cf_read_status_t cf_retap_packets(capture_file *cf);
288 * The time format has changed, rescan all packets.
290 * @param cf the capture file
292 void cf_change_time_formats(capture_file *cf);
295 * Adjust timestamp precision if auto is selected.
297 * @param cf the capture file
299 void cf_timestamp_auto_precision(capture_file *cf);
302 * Print the capture file.
304 * @param cf the capture file
305 * @param print_args the arguments what and how to print
306 * @return one of cf_print_status_t
308 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
311 * Print (export) the capture file into PDML format.
313 * @param cf the capture file
314 * @param print_args the arguments what and how to export
315 * @return one of cf_print_status_t
317 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
320 * Print (export) the capture file into PSML format.
322 * @param cf the capture file
323 * @param print_args the arguments what and how to export
324 * @return one of cf_print_status_t
326 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
329 * Print (export) the capture file into CSV format.
331 * @param cf the capture file
332 * @param print_args the arguments what and how to export
333 * @return one of cf_print_status_t
335 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
338 * Print (export) the capture file into C Arrays format.
340 * @param cf the capture file
341 * @param print_args the arguments what and how to export
342 * @return one of cf_print_status_t
344 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
347 * Find Packet in protocol tree.
349 * @param cf the capture file
350 * @param string the string to find
351 * @return TRUE if a packet was found, FALSE otherwise
353 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
356 * Find Packet in summary line.
358 * @param cf the capture file
359 * @param string the string to find
360 * @return TRUE if a packet was found, FALSE otherwise
362 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
365 * Find Packet in packet data.
367 * @param cf the capture file
368 * @param string the string to find
369 * @param string_size the size of the string to find
370 * @return TRUE if a packet was found, FALSE otherwise
372 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
376 * Find Packet by display filter.
378 * @param cf the capture file
379 * @param sfcode the display filter to find a packet for
380 * @return TRUE if a packet was found, FALSE otherwise
382 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
385 * GoTo Packet in first row.
387 * @param cf the capture file
388 * @return TRUE if the first row exists, FALSE otherwise
390 gboolean cf_goto_top_frame(capture_file *cf);
393 * GoTo Packet in last row.
395 * @param cf the capture file
396 * @return TRUE if last row exists, FALSE otherwise
398 gboolean cf_goto_bottom_frame(capture_file *cf);
401 * GoTo Packet with the given row.
403 * @param cf the capture file
404 * @param row the row to go to
405 * @return TRUE if this row exists, FALSE otherwise
407 gboolean cf_goto_frame(capture_file *cf, guint row);
410 * Go to frame specified by currently selected protocol tree field.
411 * (Go To Corresponding Packet)
412 * @todo this is ugly and should be improved!
414 * @param cf the capture file
415 * @return TRUE if this packet exists, FALSE otherwise
417 gboolean cf_goto_framenum(capture_file *cf);
420 * Select the packet in the given row.
422 * @param cf the capture file
423 * @param row the row to select
425 void cf_select_packet(capture_file *cf, int row);
428 * Unselect all packets, if any.
430 * @param cf the capture file
431 * @param row the row to select
433 void cf_unselect_packet(capture_file *cf);
436 * Unselect all protocol tree fields, if any.
438 * @param cf the capture file
439 * @param row the row to select
441 void cf_unselect_field(capture_file *cf);
444 * Mark a particular frame in a particular capture.
446 * @param cf the capture file
447 * @param frame the frame to be marked
449 void cf_mark_frame(capture_file *cf, frame_data *frame);
452 * Unmark a particular frame in a particular capture.
454 * @param cf the capture file
455 * @param frame the frame to be unmarked
457 void cf_unmark_frame(capture_file *cf, frame_data *frame);
460 * Ignore a particular frame in a particular capture.
462 * @param cf the capture file
463 * @param frame the frame to be ignored
465 void cf_ignore_frame(capture_file *cf, frame_data *frame);
468 * Unignore a particular frame in a particular capture.
470 * @param cf the capture file
471 * @param frame the frame to be unignored
473 void cf_unignore_frame(capture_file *cf, frame_data *frame);
476 * Convert error number and info to a complete message.
478 * @param err the error number
479 * @param err_info a string with additional details about this error
480 * @return statically allocated error message
482 char *cf_read_error_message(int err, gchar *err_info);
485 * Merge two (or more) capture files into one.
486 * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
488 * @param out_filename pointer to output filename; if output filename is
489 * NULL, a temporary file name is generated and *out_filename is set
490 * to point to the generated file name
491 * @param in_file_count the number of input files to merge
492 * @param in_filnames array of input filenames
493 * @param file_type the output filetype
494 * @param do_append FALSE to merge chronologically, TRUE simply append
495 * @return one of cf_status_t
498 cf_merge_files(char **out_filename, int in_file_count,
499 char *const *in_filenames, int file_type, gboolean do_append);
501 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
502 void read_keytab_file(const char *);