epan/packet.h

   1 /* packet.h
   2  * Definitions for packet disassembly 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 __PACKET_H__
  26 #define __PACKET_H__
  27
  28 /*
  29  * If <inttypes.h> defines formats to be used to print 64-bit integers,
  30  * include it.
  31  */
  32 #ifdef INTTYPES_H_DEFINES_FORMATS
  33 #include <inttypes.h>
  34 #endif
  35
  36 #include "wiretap/wtap.h"
  37 #include "proto.h"
  38 #include "tvbuff.h"
  39 #include "pint.h"
  40 #include "to_str.h"
  41 #include "value_string.h"
  42 #include "column_info.h"
  43 #include "frame_data.h"
  44 #include "packet_info.h"
  45 #include "column-utils.h"
  46 #include "epan.h"
  47
  48 #define hi_nibble(b) (((b) & 0xf0) >> 4)
  49 #define lo_nibble(b) ((b) & 0x0f)
  50
  51 /* Useful when you have an array whose size you can tell at compile-time */
  52 #define array_length(x) (sizeof x / sizeof x[0])
  53
  54 /* Check whether the "len" bytes of data starting at "offset" is
  55  * entirely inside the captured data for this packet. */
  56 #define BYTES_ARE_IN_FRAME(offset, captured_len, len) \
  57         ((guint)(offset) + (guint)(len) > (guint)(offset) && \
  58          (guint)(offset) + (guint)(len) <= (guint)(captured_len))
  59
  60 /* To pass one of two strings, singular or plural */
  61 #define plurality(d,s,p) ((d) == 1 ? (s) : (p))
  62
  63 typedef struct _packet_counts {
  64   gint           sctp;
  65   gint           tcp;
  66   gint           udp;
  67   gint           icmp;
  68   gint           ospf;
  69   gint           gre;
  70   gint           netbios;
  71   gint           ipx;
  72   gint           vines;
  73   gint           other;
  74   gint           total;
  75   gint           arp;
  76 } packet_counts;
  77
  78 /** Number of packet counts. */
  79 #define PACKET_COUNTS_SIZE sizeof(packet_counts) / sizeof (gint)
  80
  81 /* Types of character encodings */
  82 typedef enum {
  83         CHAR_ASCII       = 0,   /* ASCII */
  84         CHAR_EBCDIC      = 1    /* EBCDIC */
  85 } char_enc;
  86
  87 /* Struct for boolean enumerations */
  88 typedef struct true_false_string {
  89         char    *true_string;
  90         char    *false_string;
  91 } true_false_string;
  92
  93 extern const true_false_string flags_set_truth;
  94
  95 extern void packet_init(void);
  96 extern void packet_cleanup(void);
  97
  98 /* Handle for dissectors you call directly or register with "dissector_add()".
  99    This handle is opaque outside of "packet.c". */
 100 struct dissector_handle;
 101 typedef struct dissector_handle *dissector_handle_t;
 102
 103 /* Hash table for matching port numbers and dissectors; this is opaque
 104    outside of "packet.c". */
 105 struct dissector_table;
 106 typedef struct dissector_table *dissector_table_t;
 107
 108 /*
 109  * Dissector that returns nothing.
 110  */
 111 typedef void (*dissector_t)(tvbuff_t *, packet_info *, proto_tree *);
 112
 113 /*
 114  * Dissector that returns:
 115  *
 116  *      the amount of data in the protocol's PDU, if it was able to
 117  *      dissect all the data;
 118  *
 119  *      0, if the tvbuff doesn't contain a PDU for that protocol;
 120  *
 121  *      the negative of the amount of additional data needed, if
 122  *      we need more data (e.g., from subsequent TCP segments) to
 123  *      dissect the entire PDU.
 124  */
 125 typedef int (*new_dissector_t)(tvbuff_t *, packet_info *, proto_tree *);
 126
 127 typedef void (*DATFunc) (gchar *table_name, ftenum_t selector_type,
 128     gpointer key, gpointer value, gpointer user_data);
 129 typedef void (*DATFunc_handle) (gchar *table_name, gpointer value,
 130     gpointer user_data);
 131 typedef void (*DATFunc_table) (gchar *table_name, gchar *ui_name,
 132     gpointer user_data);
 133
 134 /* Opaque structure - provides type checking but no access to components */
 135 typedef struct dtbl_entry dtbl_entry_t;
 136
 137 extern dissector_handle_t dtbl_entry_get_handle (dtbl_entry_t *dtbl_entry);
 138 extern dissector_handle_t dtbl_entry_get_initial_handle (dtbl_entry_t * entry);
 139 extern void dissector_table_foreach_changed (char *name, DATFunc func,
 140     gpointer user_data);
 141 extern void dissector_table_foreach (char *name, DATFunc func,
 142     gpointer user_data);
 143 extern void dissector_all_tables_foreach_changed (DATFunc func,
 144     gpointer user_data);
 145 extern void dissector_table_foreach_handle(char *name, DATFunc_handle func,
 146     gpointer user_data);
 147 extern void dissector_all_tables_foreach_table (DATFunc_table func,
 148     gpointer user_data);
 149
 150 /* a protocol uses the function to register a sub-dissector table */
 151 extern dissector_table_t register_dissector_table(const char *name,
 152     char *ui_name, ftenum_t type, int base);
 153
 154 /* Find a dissector table by table name. */
 155 extern dissector_table_t find_dissector_table(const char *name);
 156
 157 /* Get the UI name for a sub-dissector table, given its internal name */
 158 extern char *get_dissector_table_ui_name(const char *name);
 159
 160 /* Get the field type for values of the selector for a dissector table,
 161    given the table's internal name */
 162 extern ftenum_t get_dissector_table_selector_type(const char *name);
 163
 164 /* Get the base to use when displaying values of the selector for a
 165    sub-dissector table, given the table's internal name */
 166 extern int get_dissector_table_base(const char *name);
 167
 168 /* Add an entry to a uint dissector table. */
 169 extern void dissector_add(const char *abbrev, guint32 pattern,
 170     dissector_handle_t handle);
 171
 172 /* Delete the entry for a dissector in a uint dissector table
 173    with a particular pattern. */
 174 extern void dissector_delete(const char *name, guint32 pattern,
 175     dissector_handle_t handle);
 176
 177 /* Change the entry for a dissector in a uint dissector table
 178    with a particular pattern to use a new dissector handle. */
 179 extern void dissector_change(const char *abbrev, guint32 pattern,
 180     dissector_handle_t handle);
 181
 182 /* Reset an entry in a uint dissector table to its initial value. */
 183 extern void dissector_reset(const char *name, guint32 pattern);
 184
 185 /* Look for a given value in a given uint dissector table and, if found,
 186    call the dissector with the arguments supplied, and return TRUE,
 187    otherwise return FALSE. */
 188 extern gboolean dissector_try_port(dissector_table_t sub_dissectors,
 189     guint32 port, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
 190
 191 /* Look for a given value in a given uint dissector table and, if found,
 192    return the dissector handle for that value. */
 193 extern dissector_handle_t dissector_get_port_handle(
 194     dissector_table_t sub_dissectors, guint32 port);
 195
 196 /* Add an entry to a string dissector table. */
 197 extern void dissector_add_string(const char *name, gchar *pattern,
 198     dissector_handle_t handle);
 199
 200 /* Delete the entry for a dissector in a string dissector table
 201    with a particular pattern. */
 202 extern void dissector_delete_string(const char *name, const gchar *pattern,
 203         dissector_handle_t handle);
 204
 205 /* Change the entry for a dissector in a string dissector table
 206    with a particular pattern to use a new dissector handle. */
 207 extern void dissector_change_string(const char *name, gchar *pattern,
 208     dissector_handle_t handle);
 209
 210 /* Reset an entry in a string sub-dissector table to its initial value. */
 211 extern void dissector_reset_string(const char *name, const gchar *pattern);
 212
 213 /* Look for a given string in a given dissector table and, if found, call
 214    the dissector with the arguments supplied, and return TRUE, otherwise
 215    return FALSE. */
 216 extern gboolean dissector_try_string(dissector_table_t sub_dissectors,
 217     const gchar *string, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
 218
 219 /* Look for a given value in a given string dissector table and, if found,
 220    return the dissector handle for that value. */
 221 extern dissector_handle_t dissector_get_string_handle(
 222     dissector_table_t sub_dissectors, const gchar *string);
 223
 224 /* Add a handle to the list of handles that *could* be used with this
 225    table.  That list is used by code in the UI. */
 226 extern void dissector_add_handle(const char *name, dissector_handle_t handle);
 227
 228 /* List of "heuristic" dissectors (which get handed a packet, look at it,
 229    and either recognize it as being for their protocol, dissect it, and
 230    return TRUE, or don't recognize it and return FALSE) to be called
 231    by another dissector. */
 232 typedef GSList *heur_dissector_list_t;
 233
 234 /** A protocol uses this function to register a heuristic sub-dissector list.
 235  *  Call this in the parent dissectors proto_register function.
 236  *
 237  * @param name the name of this protocol
 238  * @param list the list of heuristic sub-dissectors to be registered
 239  */
 240 extern void register_heur_dissector_list(const char *name,
 241     heur_dissector_list_t *list);
 242
 243 /** Try all the dissectors in a given heuristic dissector list. This is done,
 244  *  until we find one that recognizes the protocol.
 245  *  Call this while the parent dissector running.
 246  *
 247  * @param sub_dissectors the sub-dissector list
 248  * @param tvb the tv_buff with the (remaining) packet data
 249  * @param pinfo the packet info of this packet (additional info)
 250  * @param tree the protocol tree to be build or NULL
 251  * @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
 252  */
 253 extern gboolean dissector_try_heuristic(heur_dissector_list_t sub_dissectors,
 254     tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
 255
 256 /** Type of a heuristic dissector, used in heur_dissector_add().
 257  *
 258  * @param tvb the tv_buff with the (remaining) packet data
 259  * @param pinfo the packet info of this packet (additional info)
 260  * @param tree the protocol tree to be build or NULL
 261  * @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
 262  */
 263 typedef gboolean (*heur_dissector_t)(tvbuff_t *tvb, packet_info *pinfo,
 264         proto_tree *tree);
 265
 266 /** Add a sub-dissector to a heuristic dissector list.
 267  *  Call this in the proto_handoff function of the sub-dissector.
 268  *
 269  * @param name the name of the "parent" protocol, e.g. "tcp"
 270  * @param dissector the sub-dissector to be registered
 271  * @param proto the protocol id of the sub-dissector
 272  */
 273 extern void heur_dissector_add(const char *name, heur_dissector_t dissector,
 274     int proto);
 275
 276 /* Register a dissector. */
 277 extern void register_dissector(const char *name, dissector_t dissector,
 278     int proto);
 279 extern void new_register_dissector(const char *name, new_dissector_t dissector,
 280     int proto);
 281
 282 /* Get the short name of the protocol for a dissector handle. */
 283 extern char *dissector_handle_get_short_name(dissector_handle_t handle);
 284
 285 /* Get the index of the protocol for a dissector handle. */
 286 extern int dissector_handle_get_protocol_index(dissector_handle_t handle);
 287
 288 /* Find a dissector by name. */
 289 extern dissector_handle_t find_dissector(const char *name);
 290
 291 /* Create an anonymous handle for a dissector. */
 292 extern dissector_handle_t create_dissector_handle(dissector_t dissector,
 293     int proto);
 294 extern dissector_handle_t new_create_dissector_handle(new_dissector_t dissector,
 295     int proto);
 296
 297 /* Call a dissector through a handle. */
 298 extern int call_dissector(dissector_handle_t handle, tvbuff_t *tvb,
 299     packet_info *pinfo, proto_tree *tree);
 300
 301 /* Do all one-time initialization. */
 302 extern void dissect_init(void);
 303
 304 extern void dissect_cleanup(void);
 305
 306 /*
 307  * Given a tvbuff, and a length from a packet header, adjust the length
 308  * of the tvbuff to reflect the specified length.
 309  */
 310 extern void set_actual_length(tvbuff_t *tvb, guint specified_len);
 311
 312 /* Allow protocols to register "init" routines, which are called before
 313    we make a pass through a capture file and dissect all its packets
 314    (e.g., when we read in a new capture file, or run a "filter packets"
 315    or "colorize packets" pass over the current capture file). */
 316 extern void register_init_routine(void (*func)(void));
 317
 318 /* Initialize all data structures used for dissection. */
 319 extern void init_dissection(void);
 320
 321 /* Allow protocols to register a "cleanup" routine to be
 322  * run after the initial sequential run through the packets.
 323  * Note that the file can still be open after this; this is not
 324  * the final cleanup. */
 325 extern void register_postseq_cleanup_routine(void (*func)(void));
 326
 327 /* Call all the registered "postseq_cleanup" routines. */
 328 extern void postseq_cleanup_all_protocols(void);
 329
 330 /* Allow dissectors to register a "final_registration" routine
 331  * that is run like the proto_register_XXX() routine, but the end
 332  * end of the epan_init() function; that is, *after* all other
 333  * subsystems, liked dfilters, have finished initializing. This is
 334  * useful for dissector registration routines which need to compile
 335  * display filters. dfilters can't initialize itself until all protocols
 336  * have registereed themselvs. */
 337 extern void
 338 register_final_registration_routine(void (*func)(void));
 339
 340 /* Call all the registered "final_registration" routines. */
 341 extern void
 342 final_registration_all_protocols(void);
 343
 344 /*
 345  * Add a new data source to the list of data sources for a frame, given
 346  * the tvbuff for the data source and its name.
 347  */
 348 extern void add_new_data_source(packet_info *pinfo, tvbuff_t *tvb,
 349     char *name);
 350
 351 /*
 352  * Free up a frame's list of data sources.
 353  */
 354 extern void free_data_sources(packet_info *pinfo);
 355
 356 /*
 357  * Dissectors should never modify the packet data.
 358  */
 359 extern void dissect_packet(epan_dissect_t *edt,
 360     union wtap_pseudo_header *pseudo_header, const guchar *pd,
 361     frame_data *fd, column_info *cinfo);
 362
 363 /* These functions are in packet-ethertype.c */
 364 extern void capture_ethertype(guint16 etype, const guchar *pd, int offset,
 365                 int len, packet_counts *ld);
 366 extern void ethertype(guint16 etype, tvbuff_t *tvb, int offset_after_ethertype,
 367                 packet_info *pinfo, proto_tree *tree, proto_tree *fh_tree,
 368                 int etype_id, int trailer_id, int fcs_len);
 369
 370 /*
 371  * Dump layer/selector/dissector records in a fashion similar to the
 372  * proto_registrar_dump_* routines.
 373  */
 374 extern void dissector_dump_decodes();
 375
 376 #endif /* packet.h */