file.h

   1 /* file.h
   2  * Definitions for file structures and routines
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25 #ifndef __FILE_H__
  26 #define __FILE_H__
  27
  28 #include "packet-range.h"
  29 #include "wiretap/wtap.h"
  30 #include <epan/dfilter/dfilter.h>
  31 #include "print.h"
  32 #include <errno.h>
  33 #include <epan/epan.h>
  34
  35 #include "cfile.h"
  36
  37
  38 /** Return values from functions that only can succeed or fail. */
  39 typedef enum {
  40         CF_OK,                      /**< operation succeeded */
  41         CF_ERROR        /**< operation got an error (function may provide err with details) */
  42 } cf_status_t;
  43
  44 /** Return values from functions that read capture files. */
  45 typedef enum {
  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 */
  49 } cf_read_status_t;
  50
  51 /** Return values from functions that print sets of packets. */
  52 typedef enum {
  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 */
  56 } cf_print_status_t;
  57
  58 typedef enum {
  59     cf_cb_file_closed,
  60     cf_cb_file_read_start,
  61     cf_cb_file_read_finished,
  62 #ifdef HAVE_LIBPCAP
  63     cf_cb_live_capture_prepare,
  64     cf_cb_live_capture_started,
  65     cf_cb_live_capture_finished,
  66 #endif
  67     cf_cb_packet_selected,
  68     cf_cb_packet_unselected,
  69     cf_cb_field_unselected,
  70     cf_cb_file_safe_started,
  71     cf_cb_file_safe_finished,
  72     cf_cb_file_safe_reload_finished,
  73     cf_cb_file_safe_failed
  74 } cf_cbs;
  75
  76 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
  77
  78 extern void
  79 cf_callback_invoke(int event, gpointer data);
  80
  81 extern void
  82 cf_callback_add(cf_callback_t func, gpointer user_data);
  83
  84 extern void
  85 cf_callback_remove(cf_callback_t func);
  86
  87 /**
  88  * Open a capture file.
  89  *
  90  * @param cf the capture file to be opened
  91  * @param fname the filename to be opened
  92  * @param is_tempfile is this a temporary file?
  93  * @return one of cf_status_t
  94  */
  95 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
  96
  97 /**
  98  * Close a capture file.
  99  *
 100  * @param cf the capture file to be closed
 101  */
 102 void cf_close(capture_file *cf);
 103
 104 /**
 105  * Reload a capture file.
 106  *
 107  * @param cf the capture file to be reloaded
 108  */
 109 void cf_reload(capture_file *cf);
 110
 111 /**
 112  * Read all packets of a capture file into the internal structures.
 113  *
 114  * @param cf the capture file to be read
 115  * @return one of cf_read_status_t
 116  */
 117 cf_read_status_t cf_read(capture_file *cf);
 118
 119 /**
 120  * Start reading from the end of a capture file.
 121  * This is used in "Update list of packets in Real-Time".
 122  *
 123  * @param cf the capture file to be read from
 124  * @param fname the filename to be read from
 125  * @param is_tempfile is this a temporary file?
 126  * @param err the error code, if an error had occured
 127  * @return one of cf_status_t
 128  */
 129 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 130
 131 /**
 132  * Read packets from the "end" of a capture file.
 133  *
 134  * @param cf the capture file to be read from
 135  * @param to_read the number of packets to read
 136  * @param err the error code, if an error had occured
 137  * @return one of cf_read_status_t
 138  */
 139 cf_read_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
 140
 141 /**
 142  * Finish reading from "end" of a capture file.
 143  *
 144  * @param cf the capture file to be read from
 145  * @param err the error code, if an error had occured
 146  * @return one of cf_read_status_t
 147  */
 148 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
 149
 150 /**
 151  * Save a capture file (or a range of it).
 152  *
 153  * @param cf the capture file to save to
 154  * @param fname the filename to save to
 155  * @param range the range of packets to save
 156  * @param save_format the format of the file to save (libpcap, ...)
 157  * @return one of cf_status_t
 158  */
 159 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format);
 160
 161 /**
 162  * Get a displayable name of the capture file.
 163  *
 164  * @param cf the capture file
 165  * @return the displayable name (don't have to be g_free'd)
 166  */
 167 const gchar *cf_get_display_name(capture_file *cf);
 168
 169 /**
 170  * Get the number of packets in the capture file.
 171  *
 172  * @param cf the capture file
 173  * @return the number of packets in the capture file
 174  */
 175 int cf_packet_count(capture_file *cf);
 176
 177 /**
 178  * Is this capture file a temporary file?
 179  *
 180  * @param cf the capture file
 181  * @return TRUE if it's a temporary file, FALSE otherwise
 182  */
 183 gboolean cf_is_tempfile(capture_file *cf);
 184
 185 /**
 186  * Set flag, if the number of packet drops while capturing are known or not.
 187  *
 188  * @param cf the capture file
 189  * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
 190  */
 191 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
 192
 193 /**
 194  * Set the number of packet drops while capturing.
 195  *
 196  * @param cf the capture file
 197  * @param drops the number of packet drops occured while capturing
 198  */
 199 void cf_set_drops(capture_file *cf, guint32 drops);
 200
 201 /**
 202  * Get flag state, if the number of packet drops while capturing are known or not.
 203  *
 204  * @param cf the capture file
 205  * @return TRUE if the number of packet drops are known, FALSE otherwise
 206  */
 207 gboolean cf_get_drops_known(capture_file *cf);
 208
 209 /**
 210  * Get the number of packet drops while capturing.
 211  *
 212  * @param cf the capture file
 213  * @return the number of packet drops occured while capturing
 214  */
 215 guint32 cf_get_drops(capture_file *cf);
 216
 217 /**
 218  * Set the read filter.
 219  * @todo this shouldn't be required, remove it somehow
 220  *
 221  * @param cf the capture file
 222  * @param rfcode the readfilter
 223  */
 224 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 225
 226 /**
 227  * "Display Filter" packets in the capture file.
 228  *
 229  * @param cf the capture file
 230  * @param dfilter the display filter
 231  * @param force TRUE if do in any case, FALSE only if dfilter changed
 232  * @return one of cf_status_t
 233  */
 234 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
 235
 236 /**
 237  * At least one "Refence Time" flag has changed, rescan all packets.
 238  *
 239  * @param cf the capture file
 240  */
 241 void cf_reftime_packets(capture_file *cf);
 242
 243 /**
 244  * At least one "Refence Time" flag has changed, rescan all packets.
 245  *
 246  * @param cf the capture file
 247  */
 248 void cf_colorize_packets(capture_file *cf);
 249
 250 /**
 251  * "Something" has changed, rescan all packets.
 252  *
 253  * @param cf the capture file
 254  */
 255 void cf_redissect_packets(capture_file *cf);
 256
 257 /**
 258  * Rescan all packets and just run taps - don't reconstruct the display.
 259  *
 260  * @param cf the capture file
 261  * @return one of cf_read_status_t
 262  */
 263 cf_read_status_t cf_retap_packets(capture_file *cf);
 264
 265 /**
 266  * The time format has changed, rescan all packets.
 267  *
 268  * @param cf the capture file
 269  */
 270 void cf_change_time_formats(capture_file *cf);
 271
 272 /**
 273  * Print the capture file.
 274  *
 275  * @param cf the capture file
 276  * @param print_args the arguments what and how to print
 277  * @return one of cf_print_status_t
 278  */
 279 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
 280
 281 /**
 282  * Print (export) the capture file into PDML format.
 283  *
 284  * @param cf the capture file
 285  * @param print_args the arguments what and how to export
 286  * @return one of cf_print_status_t
 287  */
 288 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 289
 290 /**
 291  * Print (export) the capture file into PSML format.
 292  *
 293  * @param cf the capture file
 294  * @param print_args the arguments what and how to export
 295  * @return one of cf_print_status_t
 296  */
 297 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 298
 299 /**
 300  * Find Packet in protocol tree.
 301  *
 302  * @param cf the capture file
 303  * @param string the string to find
 304  * @return TRUE if a packet was found, FALSE otherwise
 305  */
 306 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
 307
 308 /**
 309  * Find Packet in summary line.
 310  *
 311  * @param cf the capture file
 312  * @param string the string to find
 313  * @return TRUE if a packet was found, FALSE otherwise
 314  */
 315 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
 316
 317 /**
 318  * Find Packet in packet data.
 319  *
 320  * @param cf the capture file
 321  * @param string the string to find
 322  * @param string_size the size of the string to find
 323  * @return TRUE if a packet was found, FALSE otherwise
 324  */
 325 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
 326                           size_t string_size);
 327
 328 /**
 329  * Find Packet by display filter.
 330  *
 331  * @param cf the capture file
 332  * @param sfcode the display filter to find a packet for
 333  * @return TRUE if a packet was found, FALSE otherwise
 334  */
 335 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
 336
 337 /**
 338  * GoTo Packet in first row.
 339  *
 340  * @param cf the capture file
 341  * @return TRUE if the first row exists, FALSE otherwise
 342  */
 343 gboolean cf_goto_top_frame(capture_file *cf);
 344
 345 /**
 346  * GoTo Packet in last row.
 347  *
 348  * @param cf the capture file
 349  * @return TRUE if last row exists, FALSE otherwise
 350  */
 351 gboolean cf_goto_bottom_frame(capture_file *cf);
 352
 353 /**
 354  * GoTo Packet with the given row.
 355  *
 356  * @param cf the capture file
 357  * @param row the row to go to
 358  * @return TRUE if this row exists, FALSE otherwise
 359  */
 360 gboolean cf_goto_frame(capture_file *cf, guint row);
 361
 362 /**
 363  * Go to frame specified by currently selected protocol tree field.
 364  * (Go To Corresponding Packet)
 365  * @todo this is ugly and should be improved!
 366  *
 367  * @param cf the capture file
 368  * @return TRUE if this packet exists, FALSE otherwise
 369  */
 370 gboolean cf_goto_framenum(capture_file *cf);
 371
 372 /**
 373  * Select the packet in the given row.
 374  *
 375  * @param cf the capture file
 376  * @param row the row to select
 377  */
 378 void cf_select_packet(capture_file *cf, int row);
 379
 380 /**
 381  * Unselect all packets, if any.
 382  *
 383  * @param cf the capture file
 384  * @param row the row to select
 385  */
 386 void cf_unselect_packet(capture_file *cf);
 387
 388 /**
 389  * Unselect all protocol tree fields, if any.
 390  *
 391  * @param cf the capture file
 392  * @param row the row to select
 393  */
 394 void cf_unselect_field(capture_file *cf);
 395
 396 /**
 397  * Mark a particular frame in a particular capture.
 398  *
 399  * @param cf the capture file
 400  * @param frame the frame to be marked
 401  */
 402 void cf_mark_frame(capture_file *cf, frame_data *frame);
 403
 404 /**
 405  * Unmark a particular frame in a particular capture.
 406  *
 407  * @param cf the capture file
 408  * @param frame the frame to be unmarked
 409  */
 410 void cf_unmark_frame(capture_file *cf, frame_data *frame);
 411
 412 /**
 413  * Convert error number and info to a complete message.
 414  *
 415  * @param err the error number
 416  * @param err_info the additional info about this error (e.g. filename)
 417  * @return statically allocated error message
 418  */
 419 char *cf_read_error_message(int err, const gchar *err_info);
 420
 421 /**
 422  * Merge two (or more) capture files into one.
 423  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
 424  *
 425  * @param out_filename pointer to output filename; if output filename is
 426  * NULL, a temporary file name is generated and *out_filename is set
 427  * to point to the generated file name
 428  * @param in_file_count the number of input files to merge
 429  * @param in_filnames array of input filenames
 430  * @param file_type the output filetype
 431  * @param do_append FALSE to merge chronologically, TRUE simply append
 432  * @return one of cf_status_t
 433  */
 434 cf_status_t
 435 cf_merge_files(char **out_filename, int in_file_count,
 436                char *const *in_filenames, int file_type, gboolean do_append);
 437
 438 #endif /* file.h */