file.h

   1 /* file.h
   2  * Definitions for file structures and routines
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   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_closing,
  60     cf_cb_file_closed,
  61     cf_cb_file_read_started,
  62     cf_cb_file_read_finished,
  63     cf_cb_packet_selected,
  64     cf_cb_packet_unselected,
  65     cf_cb_field_unselected,
  66     cf_cb_file_save_started,
  67     cf_cb_file_save_finished,
  68     cf_cb_file_save_reload_finished,
  69     cf_cb_file_save_failed
  70 } cf_cbs;
  71
  72 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
  73
  74 extern void
  75 cf_callback_add(cf_callback_t func, gpointer user_data);
  76
  77 extern void
  78 cf_callback_remove(cf_callback_t func);
  79
  80 /**
  81  * Open a capture file.
  82  *
  83  * @param cf the capture file to be opened
  84  * @param fname the filename to be opened
  85  * @param is_tempfile is this a temporary file?
  86  * @return one of cf_status_t
  87  */
  88 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
  89
  90 /**
  91  * Close a capture file.
  92  *
  93  * @param cf the capture file to be closed
  94  */
  95 void cf_close(capture_file *cf);
  96
  97 /**
  98  * Reload a capture file.
  99  *
 100  * @param cf the capture file to be reloaded
 101  */
 102 void cf_reload(capture_file *cf);
 103
 104 /**
 105  * Read all packets of a capture file into the internal structures.
 106  *
 107  * @param cf the capture file to be read
 108  * @param from_save reread asked from cf_save
 109  * @return one of cf_read_status_t
 110  */
 111 cf_read_status_t cf_read(capture_file *cf, gboolean from_save);
 112
 113 gboolean cf_read_frame_r(capture_file *cf, frame_data *fdata,
 114         union wtap_pseudo_header *pseudo_header, guint8 *pd,
 115         int *err, gchar **err_info);
 116
 117 gboolean cf_read_frame(capture_file *cf, frame_data *fdata,
 118         int *err, gchar **err_info);
 119
 120 /**
 121  * Start reading from the end of a capture file.
 122  * This is used in "Update list of packets in Real-Time".
 123  *
 124  * @param cf the capture file to be read from
 125  * @param fname the filename to be read from
 126  * @param is_tempfile is this a temporary file?
 127  * @param err the error code, if an error had occured
 128  * @return one of cf_status_t
 129  */
 130 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 131
 132 /**
 133  * Read packets from the "end" of a capture file.
 134  *
 135  * @param cf the capture file to be read from
 136  * @param to_read the number of packets to read
 137  * @param err the error code, if an error had occured
 138  * @return one of cf_read_status_t
 139  */
 140 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
 141
 142 /**
 143  * Finish reading from "end" of a capture file.
 144  *
 145  * @param cf the capture file to be read from
 146  * @param err the error code, if an error had occured
 147  * @return one of cf_read_status_t
 148  */
 149 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
 150
 151 /**
 152  * Determine whether this capture file (or a range of it) can be saved
 153  * (except by copying the raw file data).
 154  *
 155  * @param cf the capture file to check
 156  * @return TRUE if it can be saved, FALSE if it can't
 157  */
 158 gboolean cf_can_save_as(capture_file *cf);
 159
 160 /**
 161  * Save a capture file (or a range of it).
 162  *
 163  * @param cf the capture file to save to
 164  * @param fname the filename to save to
 165  * @param range the range of packets to save
 166  * @param save_format the format of the file to save (libpcap, ...)
 167  * @param compressed whether to gzip compress the file
 168  * @return one of cf_status_t
 169  */
 170 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed);
 171
 172 /**
 173  * Get a displayable name of the capture file.
 174  *
 175  * @param cf the capture file
 176  * @return the displayable name (don't have to be g_free'd)
 177  */
 178 const gchar *cf_get_display_name(capture_file *cf);
 179
 180 /**
 181  * Set the source of the capture data for temporary files, e.g.
 182  * "Interface eth0" or "Pipe from Pong"
 183  *
 184  * @param cf the capture file
 185  * @param source the source description. this will be copied internally.
 186  */
 187 void cf_set_tempfile_source(capture_file *cf, gchar *source);
 188
 189 /**
 190  * Get the source of the capture data for temporary files. Guaranteed to
 191  * return a non-null value. The returned value should not be freed.
 192  *
 193  * @param cf the capture file
 194  * @param source the source description. this will be copied internally.
 195  */
 196 const gchar *cf_get_tempfile_source(capture_file *cf);
 197
 198 /**
 199  * Get the number of packets in the capture file.
 200  *
 201  * @param cf the capture file
 202  * @return the number of packets in the capture file
 203  */
 204 int cf_get_packet_count(capture_file *cf);
 205
 206 /**
 207  * Set the number of packets in the capture file.
 208  *
 209  * @param cf the capture file
 210  * @param the number of packets in the capture file
 211  */
 212 void cf_set_packet_count(capture_file *cf, int packet_count);
 213
 214 /**
 215  * Is this capture file a temporary file?
 216  *
 217  * @param cf the capture file
 218  * @return TRUE if it's a temporary file, FALSE otherwise
 219  */
 220 gboolean cf_is_tempfile(capture_file *cf);
 221
 222 /**
 223  * Set flag, that this file is a tempfile.
 224  */
 225 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
 226
 227 /**
 228  * Set flag, if the number of packet drops while capturing are known or not.
 229  *
 230  * @param cf the capture file
 231  * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
 232  */
 233 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
 234
 235 /**
 236  * Set the number of packet drops while capturing.
 237  *
 238  * @param cf the capture file
 239  * @param drops the number of packet drops occured while capturing
 240  */
 241 void cf_set_drops(capture_file *cf, guint32 drops);
 242
 243 /**
 244  * Get flag state, if the number of packet drops while capturing are known or not.
 245  *
 246  * @param cf the capture file
 247  * @return TRUE if the number of packet drops are known, FALSE otherwise
 248  */
 249 gboolean cf_get_drops_known(capture_file *cf);
 250
 251 /**
 252  * Get the number of packet drops while capturing.
 253  *
 254  * @param cf the capture file
 255  * @return the number of packet drops occured while capturing
 256  */
 257 guint32 cf_get_drops(capture_file *cf);
 258
 259 /**
 260  * Set the read filter.
 261  * @todo this shouldn't be required, remove it somehow
 262  *
 263  * @param cf the capture file
 264  * @param rfcode the readfilter
 265  */
 266 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 267
 268 /**
 269  * "Display Filter" packets in the capture file.
 270  *
 271  * @param cf the capture file
 272  * @param dfilter the display filter
 273  * @param force TRUE if do in any case, FALSE only if dfilter changed
 274  * @return one of cf_status_t
 275  */
 276 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
 277
 278 /**
 279  * At least one "Refence Time" flag has changed, rescan all packets.
 280  *
 281  * @param cf the capture file
 282  */
 283 void cf_reftime_packets(capture_file *cf);
 284
 285 /**
 286  * Return the time it took to load the file
 287  */
 288 gulong cf_get_computed_elapsed(void);
 289
 290 /**
 291  * The coloring rules have changed, redo coloring
 292  *
 293  * @param cf the capture file
 294  */
 295 void cf_colorize_packets(capture_file *cf);
 296
 297 /**
 298  * "Something" has changed, rescan all packets.
 299  *
 300  * @param cf the capture file
 301  */
 302 void cf_redissect_packets(capture_file *cf);
 303
 304 /**
 305  * Rescan all packets and just run taps - don't reconstruct the display.
 306  *
 307  * @param cf the capture file
 308  * @return one of cf_read_status_t
 309  */
 310 cf_read_status_t cf_retap_packets(capture_file *cf);
 311
 312 /**
 313  * The time format has changed, rescan all packets.
 314  *
 315  * @param cf the capture file
 316  */
 317 void cf_change_time_formats(capture_file *cf);
 318
 319 /**
 320  * Adjust timestamp precision if auto is selected.
 321  *
 322  * @param cf the capture file
 323  */
 324 void cf_timestamp_auto_precision(capture_file *cf);
 325
 326 /**
 327  * Print the capture file.
 328  *
 329  * @param cf the capture file
 330  * @param print_args the arguments what and how to print
 331  * @return one of cf_print_status_t
 332  */
 333 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
 334
 335 /**
 336  * Print (export) the capture file into PDML format.
 337  *
 338  * @param cf the capture file
 339  * @param print_args the arguments what and how to export
 340  * @return one of cf_print_status_t
 341  */
 342 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 343
 344 /**
 345  * Print (export) the capture file into PSML format.
 346  *
 347  * @param cf the capture file
 348  * @param print_args the arguments what and how to export
 349  * @return one of cf_print_status_t
 350  */
 351 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 352
 353 /**
 354  * Print (export) the capture file into CSV format.
 355  *
 356  * @param cf the capture file
 357  * @param print_args the arguments what and how to export
 358  * @return one of cf_print_status_t
 359  */
 360 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
 361
 362 /**
 363  * Print (export) the capture file into C Arrays format.
 364  *
 365  * @param cf the capture file
 366  * @param print_args the arguments what and how to export
 367  * @return one of cf_print_status_t
 368  */
 369 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
 370
 371 /**
 372  * Find Packet in protocol tree.
 373  *
 374  * @param cf the capture file
 375  * @param string the string to find
 376  * @return TRUE if a packet was found, FALSE otherwise
 377  */
 378 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
 379
 380 /**
 381  * Find Packet in summary line.
 382  *
 383  * @param cf the capture file
 384  * @param string the string to find
 385  * @return TRUE if a packet was found, FALSE otherwise
 386  */
 387 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
 388
 389 /**
 390  * Find Packet in packet data.
 391  *
 392  * @param cf the capture file
 393  * @param string the string to find
 394  * @param string_size the size of the string to find
 395  * @return TRUE if a packet was found, FALSE otherwise
 396  */
 397 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
 398                           size_t string_size);
 399
 400 /**
 401  * Find Packet by display filter.
 402  *
 403  * @param cf the capture file
 404  * @param sfcode the display filter to find a packet for
 405  * @return TRUE if a packet was found, FALSE otherwise
 406  */
 407 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
 408
 409 /**
 410  * GoTo Packet in first row.
 411  *
 412  * @param cf the capture file
 413  * @return TRUE if the first row exists, FALSE otherwise
 414  */
 415 gboolean cf_goto_top_frame(capture_file *cf);
 416
 417 /**
 418  * GoTo Packet in last row.
 419  *
 420  * @param cf the capture file
 421  * @return TRUE if last row exists, FALSE otherwise
 422  */
 423 gboolean cf_goto_bottom_frame(capture_file *cf);
 424
 425 /**
 426  * GoTo Packet with the given row.
 427  *
 428  * @param cf the capture file
 429  * @param row the row to go to
 430  * @return TRUE if this row exists, FALSE otherwise
 431  */
 432 gboolean cf_goto_frame(capture_file *cf, guint row);
 433
 434 /**
 435  * Go to frame specified by currently selected protocol tree field.
 436  * (Go To Corresponding Packet)
 437  * @todo this is ugly and should be improved!
 438  *
 439  * @param cf the capture file
 440  * @return TRUE if this packet exists, FALSE otherwise
 441  */
 442 gboolean cf_goto_framenum(capture_file *cf);
 443
 444 /**
 445  * Select the packet in the given row.
 446  *
 447  * @param cf the capture file
 448  * @param row the row to select
 449  */
 450 void cf_select_packet(capture_file *cf, int row);
 451
 452 /**
 453  * Unselect all packets, if any.
 454  *
 455  * @param cf the capture file
 456  * @param row the row to select
 457  */
 458 void cf_unselect_packet(capture_file *cf);
 459
 460 /**
 461  * Unselect all protocol tree fields, if any.
 462  *
 463  * @param cf the capture file
 464  * @param row the row to select
 465  */
 466 void cf_unselect_field(capture_file *cf);
 467
 468 /**
 469  * Mark a particular frame in a particular capture.
 470  *
 471  * @param cf the capture file
 472  * @param frame the frame to be marked
 473  */
 474 void cf_mark_frame(capture_file *cf, frame_data *frame);
 475
 476 /**
 477  * Unmark a particular frame in a particular capture.
 478  *
 479  * @param cf the capture file
 480  * @param frame the frame to be unmarked
 481  */
 482 void cf_unmark_frame(capture_file *cf, frame_data *frame);
 483
 484 /**
 485  * Ignore a particular frame in a particular capture.
 486  *
 487  * @param cf the capture file
 488  * @param frame the frame to be ignored
 489  */
 490 void cf_ignore_frame(capture_file *cf, frame_data *frame);
 491
 492 /**
 493  * Unignore a particular frame in a particular capture.
 494  *
 495  * @param cf the capture file
 496  * @param frame the frame to be unignored
 497  */
 498 void cf_unignore_frame(capture_file *cf, frame_data *frame);
 499
 500 /**
 501  * Convert error number and info to a complete message.
 502  *
 503  * @param err the error number
 504  * @param err_info a string with additional details about this error
 505  * @return statically allocated error message
 506  */
 507 char *cf_read_error_message(int err, gchar *err_info);
 508
 509 /**
 510  * Merge two (or more) capture files into one.
 511  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
 512  *
 513  * @param out_filename pointer to output filename; if output filename is
 514  * NULL, a temporary file name is generated and *out_filename is set
 515  * to point to the generated file name
 516  * @param in_file_count the number of input files to merge
 517  * @param in_filnames array of input filenames
 518  * @param file_type the output filetype
 519  * @param do_append FALSE to merge chronologically, TRUE simply append
 520  * @return one of cf_status_t
 521  */
 522 cf_status_t
 523 cf_merge_files(char **out_filename, int in_file_count,
 524                char *const *in_filenames, int file_type, gboolean do_append);
 525
 526 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
 527 void read_keytab_file(const char *);
 528 #endif
 529
 530 #endif /* file.h */