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);
113 gboolean cf_read_frame_r(capture_file *cf, frame_data *fdata,
114 union wtap_pseudo_header *pseudo_header, guint8 *pd,
115 int *err, gchar **err_info);
117 gboolean cf_read_frame(capture_file *cf, frame_data *fdata,
118 int *err, gchar **err_info);
121 * Start reading from the end of a capture file.
122 * This is used in "Update list of packets in Real-Time".
124 * @param cf the capture file to be read from
125 * @param fname the filename to be read from
126 * @param is_tempfile is this a temporary file?
127 * @param err the error code, if an error had occured
128 * @return one of cf_status_t
130 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
133 * Read packets from the "end" of a capture file.
135 * @param cf the capture file to be read from
136 * @param to_read the number of packets to read
137 * @param err the error code, if an error had occured
138 * @return one of cf_read_status_t
140 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
143 * Fake reading packets from the "end" of a capture file.
145 * @param cf the capture file to be read from
147 void cf_fake_continue_tail(capture_file *cf);
150 * Finish reading from "end" of a capture file.
152 * @param cf the capture file to be read from
153 * @param err the error code, if an error had occured
154 * @return one of cf_read_status_t
156 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
159 * Determine whether this capture file (or a range of it) can be saved
160 * (except by copying the raw file data).
162 * @param cf the capture file to check
163 * @return TRUE if it can be saved, FALSE if it can't
165 gboolean cf_can_save_as(capture_file *cf);
168 * Save a capture file (or a range of it).
170 * @param cf the capture file to save to
171 * @param fname the filename to save to
172 * @param range the range of packets to save
173 * @param save_format the format of the file to save (libpcap, ...)
174 * @param compressed whether to gzip compress the file
175 * @return one of cf_status_t
177 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed);
180 * Get a displayable name of the capture file.
182 * @param cf the capture file
183 * @return the displayable name (don't have to be g_free'd)
185 const gchar *cf_get_display_name(capture_file *cf);
188 * Set the source of the capture data for temporary files, e.g.
189 * "Interface eth0" or "Pipe from Pong"
191 * @param cf the capture file
192 * @param source the source description. this will be copied internally.
194 void cf_set_tempfile_source(capture_file *cf, gchar *source);
197 * Get the source of the capture data for temporary files. Guaranteed to
198 * return a non-null value. The returned value should not be freed.
200 * @param cf the capture file
201 * @param source the source description. this will be copied internally.
203 const gchar *cf_get_tempfile_source(capture_file *cf);
206 * Get the number of packets in the capture file.
208 * @param cf the capture file
209 * @return the number of packets in the capture file
211 int cf_get_packet_count(capture_file *cf);
214 * Set the number of packets in the capture file.
216 * @param cf the capture file
217 * @param the number of packets in the capture file
219 void cf_set_packet_count(capture_file *cf, int packet_count);
222 * Is this capture file a temporary file?
224 * @param cf the capture file
225 * @return TRUE if it's a temporary file, FALSE otherwise
227 gboolean cf_is_tempfile(capture_file *cf);
230 * Set flag, that this file is a tempfile.
232 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
235 * Set flag, if the number of packet drops while capturing are known or not.
237 * @param cf the capture file
238 * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
240 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
243 * Set the number of packet drops while capturing.
245 * @param cf the capture file
246 * @param drops the number of packet drops occured while capturing
248 void cf_set_drops(capture_file *cf, guint32 drops);
251 * Get flag state, if the number of packet drops while capturing are known or not.
253 * @param cf the capture file
254 * @return TRUE if the number of packet drops are known, FALSE otherwise
256 gboolean cf_get_drops_known(capture_file *cf);
259 * Get the number of packet drops while capturing.
261 * @param cf the capture file
262 * @return the number of packet drops occured while capturing
264 guint32 cf_get_drops(capture_file *cf);
267 * Set the read filter.
268 * @todo this shouldn't be required, remove it somehow
270 * @param cf the capture file
271 * @param rfcode the readfilter
273 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
276 * "Display Filter" packets in the capture file.
278 * @param cf the capture file
279 * @param dfilter the display filter
280 * @param force TRUE if do in any case, FALSE only if dfilter changed
281 * @return one of cf_status_t
283 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
286 * At least one "Refence Time" flag has changed, rescan all packets.
288 * @param cf the capture file
290 void cf_reftime_packets(capture_file *cf);
293 * Return the time it took to load the file
295 gulong cf_get_computed_elapsed(void);
298 * The coloring rules have changed, redo coloring
300 * @param cf the capture file
302 void cf_colorize_packets(capture_file *cf);
305 * "Something" has changed, rescan all packets.
307 * @param cf the capture file
309 void cf_redissect_packets(capture_file *cf);
312 * Rescan all packets and just run taps - don't reconstruct the display.
314 * @param cf the capture file
315 * @return one of cf_read_status_t
317 cf_read_status_t cf_retap_packets(capture_file *cf);
320 * The time format has changed, rescan all packets.
322 * @param cf the capture file
324 void cf_change_time_formats(capture_file *cf);
327 * Adjust timestamp precision if auto is selected.
329 * @param cf the capture file
331 void cf_timestamp_auto_precision(capture_file *cf);
334 * Print the capture file.
336 * @param cf the capture file
337 * @param print_args the arguments what and how to print
338 * @return one of cf_print_status_t
340 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
343 * Print (export) the capture file into PDML format.
345 * @param cf the capture file
346 * @param print_args the arguments what and how to export
347 * @return one of cf_print_status_t
349 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
352 * Print (export) the capture file into PSML format.
354 * @param cf the capture file
355 * @param print_args the arguments what and how to export
356 * @return one of cf_print_status_t
358 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
361 * Print (export) the capture file into CSV format.
363 * @param cf the capture file
364 * @param print_args the arguments what and how to export
365 * @return one of cf_print_status_t
367 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
370 * Print (export) the capture file into C Arrays format.
372 * @param cf the capture file
373 * @param print_args the arguments what and how to export
374 * @return one of cf_print_status_t
376 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
379 * Find Packet in protocol tree.
381 * @param cf the capture file
382 * @param string the string to find
383 * @return TRUE if a packet was found, FALSE otherwise
385 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
388 * Find Packet in summary line.
390 * @param cf the capture file
391 * @param string the string to find
392 * @return TRUE if a packet was found, FALSE otherwise
394 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
397 * Find Packet in packet data.
399 * @param cf the capture file
400 * @param string the string to find
401 * @param string_size the size of the string to find
402 * @return TRUE if a packet was found, FALSE otherwise
404 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
408 * Find Packet by display filter.
410 * @param cf the capture file
411 * @param sfcode the display filter to find a packet for
412 * @return TRUE if a packet was found, FALSE otherwise
414 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
417 * GoTo Packet in first row.
419 * @param cf the capture file
420 * @return TRUE if the first row exists, FALSE otherwise
422 gboolean cf_goto_top_frame(capture_file *cf);
425 * GoTo Packet in last row.
427 * @param cf the capture file
428 * @return TRUE if last row exists, FALSE otherwise
430 gboolean cf_goto_bottom_frame(capture_file *cf);
433 * GoTo Packet with the given row.
435 * @param cf the capture file
436 * @param row the row to go to
437 * @return TRUE if this row exists, FALSE otherwise
439 gboolean cf_goto_frame(capture_file *cf, guint row);
442 * Go to frame specified by currently selected protocol tree field.
443 * (Go To Corresponding Packet)
444 * @todo this is ugly and should be improved!
446 * @param cf the capture file
447 * @return TRUE if this packet exists, FALSE otherwise
449 gboolean cf_goto_framenum(capture_file *cf);
452 * Select the packet in the given row.
454 * @param cf the capture file
455 * @param row the row to select
457 void cf_select_packet(capture_file *cf, int row);
460 * Unselect all packets, if any.
462 * @param cf the capture file
463 * @param row the row to select
465 void cf_unselect_packet(capture_file *cf);
468 * Unselect all protocol tree fields, if any.
470 * @param cf the capture file
471 * @param row the row to select
473 void cf_unselect_field(capture_file *cf);
476 * Mark a particular frame in a particular capture.
478 * @param cf the capture file
479 * @param frame the frame to be marked
481 void cf_mark_frame(capture_file *cf, frame_data *frame);
484 * Unmark a particular frame in a particular capture.
486 * @param cf the capture file
487 * @param frame the frame to be unmarked
489 void cf_unmark_frame(capture_file *cf, frame_data *frame);
492 * Ignore a particular frame in a particular capture.
494 * @param cf the capture file
495 * @param frame the frame to be ignored
497 void cf_ignore_frame(capture_file *cf, frame_data *frame);
500 * Unignore a particular frame in a particular capture.
502 * @param cf the capture file
503 * @param frame the frame to be unignored
505 void cf_unignore_frame(capture_file *cf, frame_data *frame);
508 * Convert error number and info to a complete message.
510 * @param err the error number
511 * @param err_info a string with additional details about this error
512 * @return statically allocated error message
514 char *cf_read_error_message(int err, gchar *err_info);
517 * Merge two (or more) capture files into one.
518 * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
520 * @param out_filename pointer to output filename; if output filename is
521 * NULL, a temporary file name is generated and *out_filename is set
522 * to point to the generated file name
523 * @param in_file_count the number of input files to merge
524 * @param in_filnames array of input filenames
525 * @param file_type the output filetype
526 * @param do_append FALSE to merge chronologically, TRUE simply append
527 * @return one of cf_status_t
530 cf_merge_files(char **out_filename, int in_file_count,
531 char *const *in_filenames, int file_type, gboolean do_append);
533 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
534 void read_keytab_file(const char *);