2 * Definitions for file structures and routines
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
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 */
60 cf_cb_file_read_start,
61 cf_cb_file_read_finished,
63 cf_cb_live_capture_prepared,
64 cf_cb_live_capture_update_started,
65 cf_cb_live_capture_update_continue,
66 cf_cb_live_capture_update_finished,
67 cf_cb_live_capture_fixed_started,
68 cf_cb_live_capture_fixed_finished,
70 cf_cb_packet_selected,
71 cf_cb_packet_unselected,
72 cf_cb_field_unselected,
73 cf_cb_file_safe_started,
74 cf_cb_file_safe_finished,
75 cf_cb_file_safe_reload_finished,
76 cf_cb_file_safe_failed
79 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
82 cf_callback_invoke(int event, gpointer data);
85 cf_callback_add(cf_callback_t func, gpointer user_data);
88 cf_callback_remove(cf_callback_t func);
91 * Open a capture file.
93 * @param cf the capture file to be opened
94 * @param fname the filename to be opened
95 * @param is_tempfile is this a temporary file?
96 * @return one of cf_status_t
98 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
101 * Close a capture file.
103 * @param cf the capture file to be closed
105 void cf_close(capture_file *cf);
108 * Reload a capture file.
110 * @param cf the capture file to be reloaded
112 void cf_reload(capture_file *cf);
115 * Read all packets of a capture file into the internal structures.
117 * @param cf the capture file to be read
118 * @return one of cf_read_status_t
120 cf_read_status_t cf_read(capture_file *cf);
123 * Start reading from the end of a capture file.
124 * This is used in "Update list of packets in Real-Time".
126 * @param cf the capture file to be read from
127 * @param fname the filename to be read from
128 * @param is_tempfile is this a temporary file?
129 * @param err the error code, if an error had occured
130 * @return one of cf_status_t
132 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
135 * Read packets from the "end" of a capture file.
137 * @param cf the capture file to be read from
138 * @param to_read the number of packets to read
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_continue_tail(capture_file *cf, int to_read, int *err);
145 * Finish reading from "end" of a capture file.
147 * @param cf the capture file to be read from
148 * @param err the error code, if an error had occured
149 * @return one of cf_read_status_t
151 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
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 * @return one of cf_status_t
162 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format);
165 * Get a displayable name of the capture file.
167 * @param cf the capture file
168 * @return the displayable name (don't have to be g_free'd)
170 const gchar *cf_get_display_name(capture_file *cf);
173 * Get the number of packets in the capture file.
175 * @param cf the capture file
176 * @return the number of packets in the capture file
178 int cf_packet_count(capture_file *cf);
181 * Is this capture file a temporary file?
183 * @param cf the capture file
184 * @return TRUE if it's a temporary file, FALSE otherwise
186 gboolean cf_is_tempfile(capture_file *cf);
189 * Set flag, that this file is a tempfile.
191 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
194 * Set flag, if the number of packet drops while capturing are known or not.
196 * @param cf the capture file
197 * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
199 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
202 * Set the number of packet drops while capturing.
204 * @param cf the capture file
205 * @param drops the number of packet drops occured while capturing
207 void cf_set_drops(capture_file *cf, guint32 drops);
210 * Get flag state, if the number of packet drops while capturing are known or not.
212 * @param cf the capture file
213 * @return TRUE if the number of packet drops are known, FALSE otherwise
215 gboolean cf_get_drops_known(capture_file *cf);
218 * Get the number of packet drops while capturing.
220 * @param cf the capture file
221 * @return the number of packet drops occured while capturing
223 guint32 cf_get_drops(capture_file *cf);
226 * Set the read filter.
227 * @todo this shouldn't be required, remove it somehow
229 * @param cf the capture file
230 * @param rfcode the readfilter
232 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
235 * "Display Filter" packets in the capture file.
237 * @param cf the capture file
238 * @param dfilter the display filter
239 * @param force TRUE if do in any case, FALSE only if dfilter changed
240 * @return one of cf_status_t
242 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
245 * At least one "Refence Time" flag has changed, rescan all packets.
247 * @param cf the capture file
249 void cf_reftime_packets(capture_file *cf);
252 * At least one "Refence Time" flag has changed, rescan all packets.
254 * @param cf the capture file
256 void cf_colorize_packets(capture_file *cf);
259 * "Something" has changed, rescan all packets.
261 * @param cf the capture file
263 void cf_redissect_packets(capture_file *cf);
266 * Rescan all packets and just run taps - don't reconstruct the display.
268 * @param cf the capture file
269 * @return one of cf_read_status_t
271 cf_read_status_t cf_retap_packets(capture_file *cf);
274 * The time format has changed, rescan all packets.
276 * @param cf the capture file
278 void cf_change_time_formats(capture_file *cf);
281 * Print the capture file.
283 * @param cf the capture file
284 * @param print_args the arguments what and how to print
285 * @return one of cf_print_status_t
287 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
290 * Print (export) the capture file into PDML format.
292 * @param cf the capture file
293 * @param print_args the arguments what and how to export
294 * @return one of cf_print_status_t
296 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
299 * Print (export) the capture file into PSML format.
301 * @param cf the capture file
302 * @param print_args the arguments what and how to export
303 * @return one of cf_print_status_t
305 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
308 * Print (export) the capture file into CSV format.
310 * @param cf the capture file
311 * @param print_args the arguments what and how to export
312 * @return one of cf_print_status_t
314 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
317 * Find Packet in protocol tree.
319 * @param cf the capture file
320 * @param string the string to find
321 * @return TRUE if a packet was found, FALSE otherwise
323 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
326 * Find Packet in summary line.
328 * @param cf the capture file
329 * @param string the string to find
330 * @return TRUE if a packet was found, FALSE otherwise
332 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
335 * Find Packet in packet data.
337 * @param cf the capture file
338 * @param string the string to find
339 * @param string_size the size of the string to find
340 * @return TRUE if a packet was found, FALSE otherwise
342 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
346 * Find Packet by display filter.
348 * @param cf the capture file
349 * @param sfcode the display filter to find a packet for
350 * @return TRUE if a packet was found, FALSE otherwise
352 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
355 * GoTo Packet in first row.
357 * @param cf the capture file
358 * @return TRUE if the first row exists, FALSE otherwise
360 gboolean cf_goto_top_frame(capture_file *cf);
363 * GoTo Packet in last row.
365 * @param cf the capture file
366 * @return TRUE if last row exists, FALSE otherwise
368 gboolean cf_goto_bottom_frame(capture_file *cf);
371 * GoTo Packet with the given row.
373 * @param cf the capture file
374 * @param row the row to go to
375 * @return TRUE if this row exists, FALSE otherwise
377 gboolean cf_goto_frame(capture_file *cf, guint row);
380 * Go to frame specified by currently selected protocol tree field.
381 * (Go To Corresponding Packet)
382 * @todo this is ugly and should be improved!
384 * @param cf the capture file
385 * @return TRUE if this packet exists, FALSE otherwise
387 gboolean cf_goto_framenum(capture_file *cf);
390 * Select the packet in the given row.
392 * @param cf the capture file
393 * @param row the row to select
395 void cf_select_packet(capture_file *cf, int row);
398 * Unselect all packets, if any.
400 * @param cf the capture file
401 * @param row the row to select
403 void cf_unselect_packet(capture_file *cf);
406 * Unselect all protocol tree fields, if any.
408 * @param cf the capture file
409 * @param row the row to select
411 void cf_unselect_field(capture_file *cf);
414 * Mark a particular frame in a particular capture.
416 * @param cf the capture file
417 * @param frame the frame to be marked
419 void cf_mark_frame(capture_file *cf, frame_data *frame);
422 * Unmark a particular frame in a particular capture.
424 * @param cf the capture file
425 * @param frame the frame to be unmarked
427 void cf_unmark_frame(capture_file *cf, frame_data *frame);
430 * Convert error number and info to a complete message.
432 * @param err the error number
433 * @param err_info the additional info about this error (e.g. filename)
434 * @return statically allocated error message
436 char *cf_read_error_message(int err, const gchar *err_info);
439 * Merge two (or more) capture files into one.
440 * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
442 * @param out_filename pointer to output filename; if output filename is
443 * NULL, a temporary file name is generated and *out_filename is set
444 * to point to the generated file name
445 * @param in_file_count the number of input files to merge
446 * @param in_filnames array of input filenames
447 * @param file_type the output filetype
448 * @param do_append FALSE to merge chronologically, TRUE simply append
449 * @return one of cf_status_t
452 cf_merge_files(char **out_filename, int in_file_count,
453 char *const *in_filenames, int file_type, gboolean do_append);