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,
63 cf_cb_packet_selected,
64 cf_cb_packet_unselected,
65 cf_cb_field_unselected,
66 cf_cb_file_safe_started,
67 cf_cb_file_safe_finished,
68 cf_cb_file_safe_reload_finished,
69 cf_cb_file_safe_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 * @return one of cf_read_status_t
110 cf_read_status_t cf_read(capture_file *cf);
113 * Start reading from the end of a capture file.
114 * This is used in "Update list of packets in Real-Time".
116 * @param cf the capture file to be read from
117 * @param fname the filename to be read from
118 * @param is_tempfile is this a temporary file?
119 * @param err the error code, if an error had occured
120 * @return one of cf_status_t
122 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
125 * Read packets from the "end" of a capture file.
127 * @param cf the capture file to be read from
128 * @param to_read the number of packets to read
129 * @param err the error code, if an error had occured
130 * @return one of cf_read_status_t
132 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
135 * Finish reading from "end" of a capture file.
137 * @param cf the capture file to be read from
138 * @param err the error code, if an error had occured
139 * @return one of cf_read_status_t
141 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
144 * Determine whether this capture file (or a range of it) can be saved
145 * (except by copying the raw file data).
147 * @param cf the capture file to check
148 * @return TRUE if it can be saved, FALSE if it can't
150 gboolean cf_can_save_as(capture_file *cf);
153 * Save a capture file (or a range of it).
155 * @param cf the capture file to save to
156 * @param fname the filename to save to
157 * @param range the range of packets to save
158 * @param save_format the format of the file to save (libpcap, ...)
159 * @param compressed whether to gzip compress the file
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, gboolean compressed);
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_get_packet_count(capture_file *cf);
181 * Set the number of packets in the capture file.
183 * @param cf the capture file
184 * @param the number of packets in the capture file
186 void cf_set_packet_count(capture_file *cf, int packet_count);
189 * Is this capture file a temporary file?
191 * @param cf the capture file
192 * @return TRUE if it's a temporary file, FALSE otherwise
194 gboolean cf_is_tempfile(capture_file *cf);
197 * Set flag, that this file is a tempfile.
199 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
202 * Set flag, if the number of packet drops while capturing are known or not.
204 * @param cf the capture file
205 * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
207 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
210 * Set the number of packet drops while capturing.
212 * @param cf the capture file
213 * @param drops the number of packet drops occured while capturing
215 void cf_set_drops(capture_file *cf, guint32 drops);
218 * Get flag state, if the number of packet drops while capturing are known or not.
220 * @param cf the capture file
221 * @return TRUE if the number of packet drops are known, FALSE otherwise
223 gboolean cf_get_drops_known(capture_file *cf);
226 * Get the number of packet drops while capturing.
228 * @param cf the capture file
229 * @return the number of packet drops occured while capturing
231 guint32 cf_get_drops(capture_file *cf);
234 * Set the read filter.
235 * @todo this shouldn't be required, remove it somehow
237 * @param cf the capture file
238 * @param rfcode the readfilter
240 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
243 * "Display Filter" packets in the capture file.
245 * @param cf the capture file
246 * @param dfilter the display filter
247 * @param force TRUE if do in any case, FALSE only if dfilter changed
248 * @return one of cf_status_t
250 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
253 * At least one "Refence Time" flag has changed, rescan all packets.
255 * @param cf the capture file
257 void cf_reftime_packets(capture_file *cf);
260 * Return the time it took to load the file
262 gulong cf_get_computed_elapsed(void);
265 * The coloring rules have changed, redo coloring
267 * @param cf the capture file
269 void cf_colorize_packets(capture_file *cf);
272 * "Something" has changed, rescan all packets.
274 * @param cf the capture file
276 void cf_redissect_packets(capture_file *cf);
279 * Rescan all packets and just run taps - don't reconstruct the display.
281 * @param cf the capture file
282 * @return one of cf_read_status_t
284 cf_read_status_t cf_retap_packets(capture_file *cf);
287 * The time format has changed, rescan all packets.
289 * @param cf the capture file
291 void cf_change_time_formats(capture_file *cf);
294 * Adjust timestamp precision if auto is selected.
296 * @param cf the capture file
298 void cf_timestamp_auto_precision(capture_file *cf);
301 * Print the capture file.
303 * @param cf the capture file
304 * @param print_args the arguments what and how to print
305 * @return one of cf_print_status_t
307 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
310 * Print (export) the capture file into PDML format.
312 * @param cf the capture file
313 * @param print_args the arguments what and how to export
314 * @return one of cf_print_status_t
316 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
319 * Print (export) the capture file into PSML format.
321 * @param cf the capture file
322 * @param print_args the arguments what and how to export
323 * @return one of cf_print_status_t
325 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
328 * Print (export) the capture file into CSV format.
330 * @param cf the capture file
331 * @param print_args the arguments what and how to export
332 * @return one of cf_print_status_t
334 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
337 * Print (export) the capture file into C Arrays format.
339 * @param cf the capture file
340 * @param print_args the arguments what and how to export
341 * @return one of cf_print_status_t
343 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
346 * Find Packet in protocol tree.
348 * @param cf the capture file
349 * @param string the string to find
350 * @return TRUE if a packet was found, FALSE otherwise
352 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
355 * Find Packet in summary line.
357 * @param cf the capture file
358 * @param string the string to find
359 * @return TRUE if a packet was found, FALSE otherwise
361 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
364 * Find Packet in packet data.
366 * @param cf the capture file
367 * @param string the string to find
368 * @param string_size the size of the string to find
369 * @return TRUE if a packet was found, FALSE otherwise
371 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
375 * Find Packet by display filter.
377 * @param cf the capture file
378 * @param sfcode the display filter to find a packet for
379 * @return TRUE if a packet was found, FALSE otherwise
381 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
384 * GoTo Packet in first row.
386 * @param cf the capture file
387 * @return TRUE if the first row exists, FALSE otherwise
389 gboolean cf_goto_top_frame(capture_file *cf);
392 * GoTo Packet in last row.
394 * @param cf the capture file
395 * @return TRUE if last row exists, FALSE otherwise
397 gboolean cf_goto_bottom_frame(capture_file *cf);
400 * GoTo Packet with the given row.
402 * @param cf the capture file
403 * @param row the row to go to
404 * @return TRUE if this row exists, FALSE otherwise
406 gboolean cf_goto_frame(capture_file *cf, guint row);
409 * Go to frame specified by currently selected protocol tree field.
410 * (Go To Corresponding Packet)
411 * @todo this is ugly and should be improved!
413 * @param cf the capture file
414 * @return TRUE if this packet exists, FALSE otherwise
416 gboolean cf_goto_framenum(capture_file *cf);
419 * Select the packet in the given row.
421 * @param cf the capture file
422 * @param row the row to select
424 void cf_select_packet(capture_file *cf, int row);
427 * Unselect all packets, if any.
429 * @param cf the capture file
430 * @param row the row to select
432 void cf_unselect_packet(capture_file *cf);
435 * Unselect all protocol tree fields, if any.
437 * @param cf the capture file
438 * @param row the row to select
440 void cf_unselect_field(capture_file *cf);
443 * Mark a particular frame in a particular capture.
445 * @param cf the capture file
446 * @param frame the frame to be marked
448 void cf_mark_frame(capture_file *cf, frame_data *frame);
451 * Unmark a particular frame in a particular capture.
453 * @param cf the capture file
454 * @param frame the frame to be unmarked
456 void cf_unmark_frame(capture_file *cf, frame_data *frame);
459 * Convert error number and info to a complete message.
461 * @param err the error number
462 * @param err_info a string with additional details about this error
463 * @return statically allocated error message
465 char *cf_read_error_message(int err, gchar *err_info);
468 * Merge two (or more) capture files into one.
469 * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
471 * @param out_filename pointer to output filename; if output filename is
472 * NULL, a temporary file name is generated and *out_filename is set
473 * to point to the generated file name
474 * @param in_file_count the number of input files to merge
475 * @param in_filnames array of input filenames
476 * @param file_type the output filetype
477 * @param do_append FALSE to merge chronologically, TRUE simply append
478 * @return one of cf_status_t
481 cf_merge_files(char **out_filename, int in_file_count,
482 char *const *in_filenames, int file_type, gboolean do_append);
484 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
485 void read_keytab_file(const char *);