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 */
59 * Open a capture file.
61 * @param cf the capture file to be opened
62 * @param fname the filename to be opened
63 * @param is_tempfile is this a temporary file?
64 * @return one of cf_status_t
66 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
69 * Close a capture file.
71 * @param cf the capture file to be closed
73 void cf_close(capture_file *cf);
76 * Reload a capture file.
78 * @param cf the capture file to be reloaded
80 void cf_reload(capture_file *cf);
83 * Read all packets of a capture file into the internal structures.
85 * @param cf the capture file to be read
86 * @return one of cf_read_status_t
88 cf_read_status_t cf_read(capture_file *cf);
91 * Start reading from the end of a capture file.
92 * This is used in "Update list of packets in Real-Time".
94 * @param cf the capture file to be read from
95 * @param fname the filename to be read from
96 * @param is_tempfile is this a temporary file?
97 * @param err the error code, if an error had occured
98 * @return one of cf_status_t
100 cf_status_t cf_start_tail(capture_file *cf, const char *fname, const char *iface, gboolean is_tempfile, int *err);
103 * Read packets from the "end" of a capture file.
105 * @param cf the capture file to be read from
106 * @param to_read the number of packets to read
107 * @param err the error code, if an error had occured
108 * @return one of cf_read_status_t
110 cf_read_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
113 * Finish reading from "end" of a capture file.
115 * @param cf the capture file to be read from
116 * @param err the error code, if an error had occured
117 * @return one of cf_read_status_t
119 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
122 * Save a capture file (or a range of it).
124 * @param cf the capture file to save to
125 * @param fname the filename to save to
126 * @param range the range of packets to save
127 * @param save_format the format of the file to save (libpcap, ...)
128 * @return one of cf_status_t
130 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format);
133 * Get a displayable name of the capture file.
135 * @param cf the capture file
136 * @return the displayable name (don't have to be g_free'd)
138 const gchar *cf_get_display_name(capture_file *cf);
141 * Get the number of packets in the capture file.
143 * @param cf the capture file
144 * @return the number of packets in the capture file
146 int cf_packet_count(capture_file *cf);
149 * Is this capture file a temporary file?
151 * @param cf the capture file
152 * @return TRUE if it's a temporary file, FALSE otherwise
154 gboolean cf_is_tempfile(capture_file *cf);
157 * Set flag, if the number of packet drops while capturing are known or not.
159 * @param cf the capture file
160 * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
162 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
165 * Set the number of packet drops while capturing.
167 * @param cf the capture file
168 * @param drops the number of packet drops occured while capturing
170 void cf_set_drops(capture_file *cf, guint32 drops);
173 * Set the read filter.
174 * @todo this shouldn't be required, remove it somehow
176 * @param cf the capture file
177 * @param rfcode the readfilter
179 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
182 * "Display Filter" packets in the capture file.
184 * @param cf the capture file
185 * @param dfilter the display filter
186 * @param force TRUE if do in any case, FALSE only if dfilter changed
187 * @return one of cf_status_t
189 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
192 * At least one "Refence Time" flag has changed, rescan all packets.
194 * @param cf the capture file
196 void cf_reftime_packets(capture_file *cf);
199 * At least one "Refence Time" flag has changed, rescan all packets.
201 * @param cf the capture file
203 void cf_colorize_packets(capture_file *cf);
206 * "Something" has changed, rescan all packets.
208 * @param cf the capture file
210 void cf_redissect_packets(capture_file *cf);
213 * Rescan all packets and just run taps - don't reconstruct the display.
215 * @param cf the capture file
216 * @return one of cf_read_status_t
218 cf_read_status_t cf_retap_packets(capture_file *cf);
221 * The time format has changed, rescan all packets.
223 * @param cf the capture file
225 void cf_change_time_formats(capture_file *cf);
228 * Print the capture file.
230 * @param cf the capture file
231 * @param print_args the arguments what and how to print
232 * @return one of cf_print_status_t
234 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
237 * Print (export) the capture file into PDML format.
239 * @param cf the capture file
240 * @param print_args the arguments what and how to export
241 * @return one of cf_print_status_t
243 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
246 * Print (export) the capture file into PSML format.
248 * @param cf the capture file
249 * @param print_args the arguments what and how to export
250 * @return one of cf_print_status_t
252 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
255 * Find Packet in protocol tree.
257 * @param cf the capture file
258 * @param string the string to find
259 * @return TRUE if a packet was found, FALSE otherwise
261 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
264 * Find Packet in summary line.
266 * @param cf the capture file
267 * @param string the string to find
268 * @return TRUE if a packet was found, FALSE otherwise
270 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
273 * Find Packet in packet data.
275 * @param cf the capture file
276 * @param string the string to find
277 * @param string_size the size of the string to find
278 * @return TRUE if a packet was found, FALSE otherwise
280 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
284 * Find Packet by display filter.
286 * @param cf the capture file
287 * @param sfcode the display filter to find a packet for
288 * @return TRUE if a packet was found, FALSE otherwise
290 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
293 * GoTo Packet in first row.
295 * @param cf the capture file
296 * @return TRUE if the first row exists, FALSE otherwise
298 gboolean cf_goto_top_frame(capture_file *cf);
301 * GoTo Packet in last row.
303 * @param cf the capture file
304 * @return TRUE if last row exists, FALSE otherwise
306 gboolean cf_goto_bottom_frame(capture_file *cf);
309 * GoTo Packet with the given row.
311 * @param cf the capture file
312 * @param row the row to go to
313 * @return TRUE if this row exists, FALSE otherwise
315 gboolean cf_goto_frame(capture_file *cf, guint row);
318 * Go to frame specified by currently selected protocol tree field.
319 * (Go To Corresponding Packet)
320 * @todo this is ugly and should be improved!
322 * @param cf the capture file
323 * @return TRUE if this packet exists, FALSE otherwise
325 gboolean cf_goto_framenum(capture_file *cf);
328 * Select the packet in the given row.
330 * @param cf the capture file
331 * @param row the row to select
333 void cf_select_packet(capture_file *cf, int row);
336 * Unselect all packets, if any.
338 * @param cf the capture file
339 * @param row the row to select
341 void cf_unselect_packet(capture_file *cf);
344 * Unselect all protocol tree fields, if any.
346 * @param cf the capture file
347 * @param row the row to select
349 void cf_unselect_field(capture_file *cf);
352 * Mark a particular frame in a particular capture.
354 * @param cf the capture file
355 * @param frame the frame to be marked
357 void cf_mark_frame(capture_file *cf, frame_data *frame);
360 * Unmark a particular frame in a particular capture.
362 * @param cf the capture file
363 * @param frame the frame to be unmarked
365 void cf_unmark_frame(capture_file *cf, frame_data *frame);
368 * Convert error number and info to a complete message.
370 * @param err the error number
371 * @param err_info the additional info about this error (e.g. filename)
372 * @return statically allocated error message
374 char *cf_read_error_message(int err, const gchar *err_info);
377 * Merge two (or more) capture files into one.
378 * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
380 * @param out_filename output filename
381 * @param out_fd output file descriptor
382 * @param in_file_count the number of input files to merge
383 * @param in_filnames array of input filenames
384 * @param file_type the output filetype
385 * @param do_append FALSE to merge chronologically, TRUE simply append
386 * @return one of cf_status_t
389 cf_merge_files(const char *out_filename, int out_fd, int in_file_count,
390 char *const *in_filenames, int file_type, gboolean do_append);