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