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