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