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