/* packet.h
* Definitions for packet disassembly structures and routines
*
- * $Id: packet.h,v 1.22 2001/02/27 07:28:48 guy Exp $
+ * $Id$
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- *
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
+ *
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
-
#ifndef __PACKET_H__
#define __PACKET_H__
#include "proto.h"
#include "tvbuff.h"
#include "pint.h"
+#include "to_str.h"
+#include "value_string.h"
+#include "column_info.h"
+#include "frame_data.h"
+#include "packet_info.h"
+#include "column-utils.h"
+#include "epan.h"
+#include "tfs.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
#define hi_nibble(b) (((b) & 0xf0) >> 4)
#define lo_nibble(b) ((b) & 0x0f)
/* Useful when you have an array whose size you can tell at compile-time */
#define array_length(x) (sizeof x / sizeof x[0])
-/* Useful when highlighting regions inside a dissect_*() function. With this
- * macro, you can highlight from an arbitrary offset to the end of the
- * packet (which may come before the end of the frame).
- * See old_dissect_data() for an example.
- */
-#define END_OF_FRAME (pi.captured_len - offset)
-
/* Check whether the "len" bytes of data starting at "offset" is
* entirely inside the captured data for this packet. */
-#define BYTES_ARE_IN_FRAME(offset, len) ((offset) + (len) <= pi.captured_len)
+#define BYTES_ARE_IN_FRAME(offset, captured_len, len) \
+ ((guint)(offset) + (guint)(len) > (guint)(offset) && \
+ (guint)(offset) + (guint)(len) <= (guint)(captured_len))
-/* Check whether there's any data at all starting at "offset". */
-#define IS_DATA_IN_FRAME(offset) ((offset) < pi.captured_len)
-
/* To pass one of two strings, singular or plural */
#define plurality(d,s,p) ((d) == 1 ? (s) : (p))
-typedef struct _column_info {
- gint num_cols; /* Number of columns */
- gint *col_fmt; /* Format of column */
- gboolean **fmt_matx; /* Specifies which formats apply to a column */
- gint *col_width; /* Column widths to use during a "-S" capture */
- gchar **col_title; /* Column titles */
- gchar **col_data; /* Column data */
- gchar **col_buf; /* Buffer into which to copy data for column */
- gboolean writable; /* Are we stil writing to the columns? */
-} column_info;
-
-#define COL_MAX_LEN 256
-#define COL_MAX_INFO_LEN 4096
-
-/* Allocate all the data structures for constructing column data, given
- the number of columns. */
-void col_init(column_info *, gint);
-
typedef struct _packet_counts {
gint sctp;
gint tcp;
gint vines;
gint other;
gint total;
+ gint arp;
+ gint i2c_event;
+ gint i2c_data;
} packet_counts;
+/** Number of packet counts. */
+#define PACKET_COUNTS_SIZE sizeof(packet_counts) / sizeof (gint)
+
/* Types of character encodings */
typedef enum {
- CHAR_ASCII = 0, /* ASCII */
- CHAR_EBCDIC = 1 /* EBCDIC */
-} char_enc;
-
-/* XXX - some of this stuff is used only while a packet is being dissected;
- should we keep that stuff in the "packet_info" structure, instead, to
- save memory? */
-typedef struct _frame_data {
- struct _frame_data *next; /* Next element in list */
- struct _frame_data *prev; /* Previous element in list */
- GSList *pfd; /* Per frame proto data */
- guint32 num; /* Frame number */
- guint32 pkt_len; /* Packet length */
- guint32 cap_len; /* Amount actually captured */
- gint32 rel_secs; /* Relative seconds (yes, it can be negative) */
- gint32 rel_usecs; /* Relative microseconds (yes, it can be negative) */
- guint32 abs_secs; /* Absolute seconds */
- guint32 abs_usecs; /* Absolute microseconds */
- gint32 del_secs; /* Delta seconds (yes, it can be negative) */
- gint32 del_usecs; /* Delta microseconds (yes, it can be negative) */
- long file_off; /* File offset */
- column_info *cinfo; /* Column formatting information */
- int lnk_t; /* Per-packet encapsulation/data-link type */
- struct {
- unsigned int passed_dfilter : 1; /* 1 = display, 0 = no display */
- unsigned int encoding : 2; /* Character encoding (ASCII, EBCDIC...) */
- unsigned int visited : 1; /* Has this packet been visited yet? 1=Yes,0=No*/
- unsigned int marked : 1; /* 1 = marked by user, 0 = normal */
- } flags;
-} frame_data;
-
-/* Types of addresses Ethereal knows about. */
-typedef enum {
- AT_NONE, /* no link-layer address */
- AT_ETHER, /* MAC (Ethernet, 802.x, FDDI) address */
- AT_IPv4, /* IPv4 */
- AT_IPv6, /* IPv6 */
- AT_IPX, /* IPX */
- AT_SNA, /* SNA */
- AT_ATALK, /* Appletalk DDP */
- AT_VINES /* Banyan Vines */
-} address_type;
-
-typedef struct _address {
- address_type type; /* type of address */
- int len; /* length of address, in bytes */
- const guint8 *data; /* bytes that constitute address */
-} address;
-
-#define SET_ADDRESS(addr, addr_type, addr_len, addr_data) { \
- (addr)->type = (addr_type); \
- (addr)->len = (addr_len); \
- (addr)->data = (addr_data); \
- }
-
-/* Types of port numbers Ethereal knows about. */
-typedef enum {
- PT_NONE, /* no port number */
- PT_SCTP, /* SCTP */
- PT_TCP, /* TCP */
- PT_UDP, /* UDP */
- PT_NCP /* NCP connection */
-} port_type;
-
-#define P2P_DIR_UNKNOWN -1
-#define P2P_DIR_SENT 0
-#define P2P_DIR_RECV 1
-
-typedef struct _packet_info {
- const char *current_proto; /* name of protocol currently being dissected */
- frame_data *fd;
- tvbuff_t *compat_top_tvb; /* only needed while converting Ethereal to use tvbuffs */
- union wtap_pseudo_header *pseudo_header;
- int len;
- int captured_len;
- address dl_src; /* link-layer source address */
- address dl_dst; /* link-layer destination address */
- address net_src; /* network-layer source address */
- address net_dst; /* network-layer destination address */
- address src; /* source address (net if present, DL otherwise )*/
- address dst; /* destination address (net if present, DL otherwise )*/
- guint32 ethertype; /* Ethernet Type Code, if this is an Ethernet packet */
- guint32 ipproto; /* IP protocol, if this is an IP packet */
- guint32 ipxptype; /* IPX packet type, if this is an IPX packet */
- gboolean fragmented; /* TRUE if the protocol is only a fragment */
- port_type ptype; /* type of the following two port numbers */
- guint32 srcport; /* source port */
- guint32 destport; /* destination port */
- guint32 match_port;
- int iplen;
- int iphdrlen;
- int p2p_dir;
-} packet_info;
-
-extern packet_info pi;
-
-/* Struct for the match_strval function */
-
-typedef struct _value_string {
- guint32 value;
- gchar *strptr;
-} value_string;
-
-/* Struct for boolean enumerations */
-typedef struct true_false_string {
- char *true_string;
- char *false_string;
-} true_false_string;
-
-void packet_init(void);
-void packet_cleanup(void);
-
-/* Hash table for matching port numbers and dissectors */
-typedef GHashTable* dissector_table_t;
-
-/* types for sub-dissector lookup */
-typedef void (*old_dissector_t)(const u_char *, int, frame_data *, proto_tree *);
+ PACKET_CHAR_ENC_CHAR_ASCII = 0, /* ASCII */
+ PACKET_CHAR_ENC_CHAR_EBCDIC = 1 /* EBCDIC */
+} packet_char_enc;
+
+extern void packet_init(void);
+extern void packet_cleanup(void);
+
+/* Handle for dissectors you call directly or register with "dissector_add_uint()".
+ This handle is opaque outside of "packet.c". */
+struct dissector_handle;
+typedef struct dissector_handle *dissector_handle_t;
+
+/* Hash table for matching unsigned integers, or strings, and dissectors;
+ this is opaque outside of "packet.c". */
+struct dissector_table;
+typedef struct dissector_table *dissector_table_t;
+
+/*
+ * Dissector that returns nothing.
+ */
typedef void (*dissector_t)(tvbuff_t *, packet_info *, proto_tree *);
-typedef void (*DATFunc) (gchar *table_name, gpointer key, gpointer value, gpointer user_data);
+/*
+ * Dissector that returns:
+ *
+ * The amount of data in the protocol's PDU, if it was able to
+ * dissect all the data;
+ *
+ * 0, if the tvbuff doesn't contain a PDU for that protocol;
+ *
+ * The negative of the amount of additional data needed, if
+ * we need more data (e.g., from subsequent TCP segments) to
+ * dissect the entire PDU.
+ */
+typedef int (*new_dissector_t)(tvbuff_t *, packet_info *, proto_tree *);
+
+/** Type of a heuristic dissector, used in heur_dissector_add().
+ *
+ * @param tvb the tv_buff with the (remaining) packet data
+ * @param pinfo the packet info of this packet (additional info)
+ * @param tree the protocol tree to be build or NULL
+ * @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
+ */
+typedef gboolean (*heur_dissector_t)(tvbuff_t *tvb, packet_info *pinfo,
+ proto_tree *tree);
+
+typedef void (*DATFunc) (const gchar *table_name, ftenum_t selector_type,
+ gpointer key, gpointer value, gpointer user_data);
+typedef void (*DATFunc_handle) (const gchar *table_name, gpointer value,
+ gpointer user_data);
+typedef void (*DATFunc_table) (const gchar *table_name, const gchar *ui_name,
+ gpointer user_data);
+
+typedef void (*DATFunc_heur_table) (const gchar *table_name,gpointer table,
+ gpointer user_data);
/* Opaque structure - provides type checking but no access to components */
typedef struct dtbl_entry dtbl_entry_t;
-gboolean dissector_get_old_flag (dtbl_entry_t *entry);
-gint dissector_get_proto (dtbl_entry_t * entry);
-gint dissector_get_initial_proto (dtbl_entry_t * entry);
-void dissector_table_foreach_changed (char *name, DATFunc func, gpointer user_data);
-void dissector_table_foreach (char *name, DATFunc func, gpointer user_data);
-void dissector_all_tables_foreach_changed (DATFunc func, gpointer user_data);
+extern dissector_handle_t dtbl_entry_get_handle (dtbl_entry_t *dtbl_entry);
+extern dissector_handle_t dtbl_entry_get_initial_handle (dtbl_entry_t * entry);
+extern void dissector_table_foreach_changed (const char *name, DATFunc func,
+ gpointer user_data);
+extern void dissector_table_foreach (const char *name, DATFunc func,
+ gpointer user_data);
+extern void dissector_all_tables_foreach_changed (DATFunc func,
+ gpointer user_data);
+extern void dissector_table_foreach_handle(const char *name, DATFunc_handle func,
+ gpointer user_data);
+extern void dissector_all_tables_foreach_table (DATFunc_table func,
+ gpointer user_data);
/* a protocol uses the function to register a sub-dissector table */
-dissector_table_t register_dissector_table(const char *name);
-
-/* Add a sub-dissector to a dissector table. Called by the protocol routine */
-/* that wants to register a sub-dissector. */
-void old_dissector_add(const char *abbrev, guint32 pattern,
- old_dissector_t dissector, int proto);
-void dissector_add(const char *abbrev, guint32 pattern,
- dissector_t dissector, int proto);
-
-/* Add a sub-dissector to a dissector table. Called by the protocol routine */
-/* that wants to de-register a sub-dissector. */
-void old_dissector_delete(const char *name, guint32 pattern, old_dissector_t dissector);
-void dissector_delete(const char *name, guint32 pattern, dissector_t dissector);
-
-/* Reset a dissector in a sub-dissector table to its initial value. */
-void dissector_change(const char *abbrev, guint32 pattern,
- dissector_t dissector, gboolean old, int proto);
-void dissector_reset(const char *name, guint32 pattern);
-
-/* Look for a given port in a given dissector table and, if found, call
+extern dissector_table_t register_dissector_table(const char *name,
+ const char *ui_name, const ftenum_t type, const int base);
+
+/* Find a dissector table by table name. */
+extern dissector_table_t find_dissector_table(const char *name);
+
+/* Get the UI name for a sub-dissector table, given its internal name */
+extern const char *get_dissector_table_ui_name(const char *name);
+
+/* Get the field type for values of the selector for a dissector table,
+ given the table's internal name */
+extern ftenum_t get_dissector_table_selector_type(const char *name);
+
+/* Get the base to use when displaying values of the selector for a
+ sub-dissector table, given the table's internal name */
+extern int get_dissector_table_base(const char *name);
+
+/* Add an entry to a uint dissector table. */
+extern void dissector_add_uint(const char *abbrev, const guint32 pattern,
+ dissector_handle_t handle);
+
+/* For old code that hasn't yet been changed. */
+#define dissector_add(abbrev, pattern, handle) \
+ dissector_add_uint(abbrev, pattern, handle)
+
+/* Delete the entry for a dissector in a uint dissector table
+ with a particular pattern. */
+extern void dissector_delete_uint(const char *name, const guint32 pattern,
+ dissector_handle_t handle);
+
+/* For old code that hasn't yet been changed. */
+#define dissector_delete(name, pattern, handle) \
+ dissector_delete_uint(name, pattern, handle)
+
+/* Change the entry for a dissector in a uint dissector table
+ with a particular pattern to use a new dissector handle. */
+extern void dissector_change_uint(const char *abbrev, const guint32 pattern,
+ dissector_handle_t handle);
+
+/* For old code that hasn't yet been changed. */
+#define dissector_change(abbrev, pattern, handle) \
+ dissector_change_uint(abbrev, pattern, handle)
+
+/* Reset an entry in a uint dissector table to its initial value. */
+extern void dissector_reset_uint(const char *name, const guint32 pattern);
+
+/* For old code that hasn't yet been changed. */
+#define dissector_reset(name, pattern) \
+ dissector_reset_uint(name, pattern)
+
+/* Look for a given value in a given uint dissector table and, if found,
+ call the dissector with the arguments supplied, and return TRUE,
+ otherwise return FALSE. */
+extern gboolean dissector_try_uint(dissector_table_t sub_dissectors,
+ const guint32 uint_val, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+
+/* For old code that hasn't yet been changed. */
+#define dissector_try_port(sub_dissectors, uint_val, tvb, pinfo, tree) \
+ dissector_try_uint(sub_dissectors, uint_val, tvb, pinfo, tree)
+
+/* Look for a given value in a given uint dissector table and, if found,
+ call the dissector with the arguments supplied, and return TRUE,
+ otherwise return FALSE. */
+extern gboolean dissector_try_uint_new(dissector_table_t sub_dissectors,
+ const guint32 uint_val, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, const gboolean add_proto_name);
+
+/* For old code that hasn't yet been changed. */
+#define dissector_try_port_new(sub_dissectors, uint_val, tvb, pinfo, tree, add_proto_name) \
+ dissector_try_uint_new(sub_dissectors, uint_val, tvb, pinfo, tree, add_proto_name)
+
+/* Look for a given value in a given uint dissector table and, if found,
+ return the dissector handle for that value. */
+extern dissector_handle_t dissector_get_uint_handle(
+ dissector_table_t const sub_dissectors, const guint32 uint_val);
+
+/* For old code that hasn't yet been changed. */
+#define dissector_get_port_handle(sub_dissectors, uint_val) \
+ dissector_get_uint_handle(sub_dissectors, uint_val)
+
+/* Add an entry to a string dissector table. */
+extern void dissector_add_string(const char *name, const gchar *pattern,
+ dissector_handle_t handle);
+
+/* Delete the entry for a dissector in a string dissector table
+ with a particular pattern. */
+extern void dissector_delete_string(const char *name, const gchar *pattern,
+ dissector_handle_t handle);
+
+/* Change the entry for a dissector in a string dissector table
+ with a particular pattern to use a new dissector handle. */
+extern void dissector_change_string(const char *name, const gchar *pattern,
+ dissector_handle_t handle);
+
+/* Reset an entry in a string sub-dissector table to its initial value. */
+extern void dissector_reset_string(const char *name, const gchar *pattern);
+
+/* Look for a given string in a given dissector table and, if found, call
the dissector with the arguments supplied, and return TRUE, otherwise
return FALSE. */
-gboolean old_dissector_try_port(dissector_table_t sub_dissectors, guint32 port,
- const u_char *pd, int offset, frame_data *fd, proto_tree *tree);
-gboolean dissector_try_port(dissector_table_t sub_dissectors, guint32 port,
- tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+extern gboolean dissector_try_string(dissector_table_t sub_dissectors,
+ const gchar *string, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+
+/* Look for a given value in a given string dissector table and, if found,
+ return the dissector handle for that value. */
+extern dissector_handle_t dissector_get_string_handle(
+ dissector_table_t sub_dissectors, const gchar *string);
+
+/* Add a handle to the list of handles that *could* be used with this
+ table. That list is used by code in the UI. */
+extern void dissector_add_handle(const char *name, dissector_handle_t handle);
/* List of "heuristic" dissectors (which get handed a packet, look at it,
and either recognize it as being for their protocol, dissect it, and
by another dissector. */
typedef GSList *heur_dissector_list_t;
-/* Type of a heuristic dissector */
-typedef gboolean (*old_heur_dissector_t)(const u_char *, int, frame_data *,
- proto_tree *);
-typedef gboolean (*heur_dissector_t)(tvbuff_t *, packet_info *,
- proto_tree *);
-
-/* A protocol uses this function to register a heuristic dissector list */
-void register_heur_dissector_list(const char *name, heur_dissector_list_t *list);
-
-/* Add a sub-dissector to a heuristic dissector list. Called by the
- protocol routine that wants to register a sub-dissector. */
-void old_heur_dissector_add(const char *name, old_heur_dissector_t dissector,
- int proto);
-void heur_dissector_add(const char *name, heur_dissector_t dissector,
- int proto);
-
-/* Try all the dissectors in a given heuristic dissector list until
- we find one that recognizes the protocol, in which case we return
- TRUE, or we run out of dissectors, in which case we return FALSE. */
-gboolean dissector_try_heuristic(heur_dissector_list_t sub_dissectors,
- tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
-/* List of "conversation" dissectors (they're not heuristic, but are
- assigned to a conversation if some other dissector sees some traffic
- saying "traffic between these hosts on these ports will be of type
- XXX", e.g. RTSP traffic doing so).
-
- These lists are for use by the UI, which, for a given conversation,
- would offer a list of dissectors that could be used with it; this
- would include dissectors on the conversation dissector list for
- the transport-layer protocol for the conversation, as well as
- dissectors for any port-based lists for that protocol (as a conversation
- between two ports, both of which have dissectors associated with them,
- might have been given to the wrong one of those dissectors). */
-typedef GSList *conv_dissector_list_t;
-
-/* A protocol uses this function to register a conversation dissector list */
-void register_conv_dissector_list(const char *name, conv_dissector_list_t *list);
-
-/* Add a sub-dissector to a conversation dissector list. Called by the
- protocol routine that wants to register a sub-dissector. */
-void old_conv_dissector_add(const char *name, old_dissector_t dissector,
- int proto);
-void conv_dissector_add(const char *name, dissector_t dissector,
- int proto);
+typedef struct {
+ heur_dissector_t dissector;
+ protocol_t *protocol;
+ gboolean enabled;
+} heur_dtbl_entry_t;
-/* Opaque structure - provides type checking but no access to components */
-typedef struct conv_dtbl_entry conv_dtbl_entry_t;
+/** A protocol uses this function to register a heuristic sub-dissector list.
+ * Call this in the parent dissectors proto_register function.
+ *
+ * @param name the name of this protocol
+ * @param list the list of heuristic sub-dissectors to be registered
+ */
+extern void register_heur_dissector_list(const char *name,
+ heur_dissector_list_t *list);
-gboolean conv_dissector_get_old_flag (conv_dtbl_entry_t *entry);
-gint conv_dissector_get_proto (conv_dtbl_entry_t * entry);
-void dissector_conv_foreach(char *name, DATFunc func, gpointer user_data);
-void dissector_all_conv_foreach(DATFunc func, gpointer user_data);
+extern void dissector_all_heur_tables_foreach_table (DATFunc_heur_table func,
+ gpointer user_data);
-/* Handle for dissectors you call directly.
- This handle is opaque outside of "packet.c". */
-struct dissector_handle;
-typedef struct dissector_handle *dissector_handle_t;
+/** Try all the dissectors in a given heuristic dissector list. This is done,
+ * until we find one that recognizes the protocol.
+ * Call this while the parent dissector running.
+ *
+ * @param sub_dissectors the sub-dissector list
+ * @param tvb the tv_buff with the (remaining) packet data
+ * @param pinfo the packet info of this packet (additional info)
+ * @param tree the protocol tree to be build or NULL
+ * @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
+ */
+extern gboolean dissector_try_heuristic(heur_dissector_list_t sub_dissectors,
+ tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+
+/** Add a sub-dissector to a heuristic dissector list.
+ * Call this in the proto_handoff function of the sub-dissector.
+ *
+ * @param name the name of the "parent" protocol, e.g. "tcp"
+ * @param dissector the sub-dissector to be registered
+ * @param proto the protocol id of the sub-dissector
+ */
+extern void heur_dissector_add(const char *name, heur_dissector_t dissector,
+ const int proto);
+
+/** Remove a sub-dissector from a heuristic dissector list.
+ * Call this in the prefs_reinit function of the sub-dissector.
+ *
+ * @param name the name of the "parent" protocol, e.g. "tcp"
+ * @param dissector the sub-dissector to be unregistered
+ * @param proto the protocol id of the sub-dissector
+ */
+extern void heur_dissector_delete(const char *name, heur_dissector_t dissector, const int proto);
+
+/** Enable/Disable a sub-dissector in a heuristic dissector list
+ * Call this in the prefs_reinit function of the sub-dissector.
+ *
+ * @param name the name of the "parent" protocol, e.g. "tcp"
+ * @param dissector the sub-dissector to be disabled/enabled
+ * @param proto the protocol id of the sub-dissector
+ * @param TRUE/FALSE to enable/disable the sub-dissector
+ */
+extern void heur_dissector_set_enabled(const char *name, heur_dissector_t dissector, const int proto, const gboolean enabled);
/* Register a dissector. */
-void register_dissector(const char *name, dissector_t dissector, int proto);
+extern void register_dissector(const char *name, dissector_t dissector,
+ const int proto);
+extern void new_register_dissector(const char *name, new_dissector_t dissector,
+ const int proto);
+
+/* Get the long name of the protocol for a dissector handle. */
+extern const char *dissector_handle_get_long_name(const dissector_handle_t handle);
+
+/* Get the short name of the protocol for a dissector handle. */
+extern const char *dissector_handle_get_short_name(const dissector_handle_t handle);
+
+/* Get the index of the protocol for a dissector handle. */
+extern int dissector_handle_get_protocol_index(const dissector_handle_t handle);
/* Find a dissector by name. */
-dissector_handle_t find_dissector(const char *name);
+extern dissector_handle_t find_dissector(const char *name);
+
+/* Create an anonymous handle for a dissector. */
+extern dissector_handle_t create_dissector_handle(dissector_t dissector,
+ const int proto);
+extern dissector_handle_t new_create_dissector_handle(new_dissector_t dissector,
+ const int proto);
-/* Call a dissector through a handle. */
-void call_dissector(dissector_handle_t handle, tvbuff_t *tvb,
+/* Call a dissector through a handle and if no dissector was found
+ * pass if over to the "data" dissector instead.
+ *
+ * @param handle The dissector to call.
+ * @param tvb The buffer to dissect.
+ * @param pinfo Packet Info.
+ * @param tree The protocol tree.
+ * @return If the protocol for that handle isn't enabled call the data
+ * dissector. Otherwise, if the handle refers to a new-style
+ * dissector, call the dissector and return its return value, otherwise call
+ * it and return the length of the tvbuff pointed to by the argument.
+ */
+extern int call_dissector(dissector_handle_t handle, tvbuff_t *tvb,
packet_info *pinfo, proto_tree *tree);
-/* Utility routines used by packet*.c */
-gchar* ether_to_str(const guint8 *);
-gchar* ether_to_str_punct(const guint8 *, char);
-gchar* ip_to_str(const guint8 *);
-void ip_to_str_buf(const guint8 *, gchar *);
-struct e_in6_addr;
-gchar* ip6_to_str(struct e_in6_addr *);
-gchar* ipx_addr_to_str(guint32, const guint8 *);
-gchar* abs_time_to_str(struct timeval*);
-gchar* rel_time_to_str(struct timeval*);
-gchar* time_secs_to_str(guint32);
-gchar* val_to_str(guint32, const value_string *, const char *);
-gchar* match_strval(guint32, const value_string*);
-char * decode_bitfield_value(char *buf, guint32 val, guint32 mask, int width);
-const char *decode_boolean_bitfield(guint32 val, guint32 mask, int width,
- const char *truedesc, const char *falsedesc);
-const char *decode_enumerated_bitfield(guint32 val, guint32 mask, int width,
- const value_string *tab, const char *fmt);
-const char *decode_numeric_bitfield(guint32 val, guint32 mask, int width,
- const char *fmt);
-
-void col_set_writable(frame_data *fd, gboolean writable);
-gint check_col(frame_data *, gint);
-void col_clear(frame_data *, gint);
-void col_set_str(frame_data *, gint, gchar *);
-#if __GNUC__ == 2
-void col_add_fstr(frame_data *, gint, gchar *, ...)
- __attribute__((format (printf, 3, 4)));
-void col_append_fstr(frame_data *, gint, gchar *, ...)
- __attribute__((format (printf, 3, 4)));
-#else
-void col_add_fstr(frame_data *, gint, gchar *, ...);
-void col_append_fstr(frame_data *, gint, gchar *, ...);
-#endif
-void col_add_str(frame_data *, gint, const gchar *);
-void col_append_str(frame_data *, gint, gchar *);
-void col_set_cls_time(frame_data *, int);
-void fill_in_columns(frame_data *);
-
-void p_add_proto_data(frame_data *, int, void *);
-void *p_get_proto_data(frame_data *, int);
-
-void blank_packetinfo(void);
+/* Call a dissector through a handle but if no dissector was found
+ * just return 0 and do not call the "data" dissector instead.
+ *
+ * @param handle The dissector to call.
+ * @param tvb The buffer to dissect.
+ * @param pinfo Packet Info.
+ * @param tree The protocol tree.
+ * @return If the protocol for that handle isn't enabled, return 0 without
+ * calling the dissector. Otherwise, if the handle refers to a new-style
+ * dissector, call the dissector and return its return value, otherwise call
+ * it and return the length of the tvbuff pointed to by the argument.
+ */
+extern int call_dissector_only(dissector_handle_t handle, tvbuff_t *tvb,
+ packet_info *pinfo, proto_tree *tree);
/* Do all one-time initialization. */
-void dissect_init(void);
+extern void dissect_init(void);
-void dissect_cleanup(void);
+extern void dissect_cleanup(void);
+
+/*
+ * Given a tvbuff, and a length from a packet header, adjust the length
+ * of the tvbuff to reflect the specified length.
+ */
+extern void set_actual_length(tvbuff_t *tvb, const guint specified_len);
/* Allow protocols to register "init" routines, which are called before
we make a pass through a capture file and dissect all its packets
(e.g., when we read in a new capture file, or run a "filter packets"
or "colorize packets" pass over the current capture file). */
-void register_init_routine(void (*func)(void));
+extern void register_init_routine(void (*func)(void));
+
+/* Initialize all data structures used for dissection. */
+extern void init_dissection(void);
-/* Call all the registered "init" routines. */
-void init_all_protocols(void);
+/* Free data structures allocated for dissection. */
+extern void cleanup_dissection(void);
+
+/* Allow protocols to register a "cleanup" routine to be
+ * run after the initial sequential run through the packets.
+ * Note that the file can still be open after this; this is not
+ * the final cleanup. */
+extern void register_postseq_cleanup_routine(void (*func)(void));
+
+/* Call all the registered "postseq_cleanup" routines. */
+extern void postseq_cleanup_all_protocols(void);
+
+/* Allow dissectors to register a "final_registration" routine
+ * that is run like the proto_register_XXX() routine, but the end
+ * end of the epan_init() function; that is, *after* all other
+ * subsystems, liked dfilters, have finished initializing. This is
+ * useful for dissector registration routines which need to compile
+ * display filters. dfilters can't initialize itself until all protocols
+ * have registereed themselvs. */
+extern void
+register_final_registration_routine(void (*func)(void));
+
+/* Call all the registered "final_registration" routines. */
+extern void
+final_registration_all_protocols(void);
/*
- * Dissectors should never modify the packet data.
+ * Add a new data source to the list of data sources for a frame, given
+ * the tvbuff for the data source and its name.
*/
-void dissect_packet(tvbuff_t **p_tvb, union wtap_pseudo_header *pseudo_header,
- const u_char *pd, frame_data *fd, proto_tree *tree);
-void old_dissect_data(const u_char *, int, frame_data *, proto_tree *);
-void dissect_data(tvbuff_t *tvb, int, packet_info *pinfo, proto_tree *tree);
+extern void add_new_data_source(packet_info *pinfo, tvbuff_t *tvb,
+ const char *name);
+/*
+ * Return the data source name.
+ */
+extern const char* get_data_source_name(data_source *src);
+
+/*
+ * Free up a frame's list of data sources.
+ */
+extern void free_data_sources(packet_info *pinfo);
+
+/*
+ * Dissectors should never modify the packet data.
+ */
+extern void dissect_packet(epan_dissect_t *edt,
+ union wtap_pseudo_header *pseudo_header, const guchar *pd,
+ frame_data *fd, column_info *cinfo);
/* These functions are in packet-ethertype.c */
-void capture_ethertype(guint16 etype, int offset,
- const u_char *pd, packet_counts *ld);
-void ethertype(guint16 etype, tvbuff_t *tvb, int offset_after_ethertype,
+extern void capture_ethertype(guint16 etype, const guchar *pd, int offset,
+ int len, packet_counts *ld);
+extern void ethertype(guint16 etype, tvbuff_t *tvb, int offset_after_ethertype,
packet_info *pinfo, proto_tree *tree, proto_tree *fh_tree,
- int etype_id, int trailer_id);
-extern const value_string etype_vals[];
+ int etype_id, int trailer_id, int fcs_len);
+
+/*
+ * Dump layer/selector/dissector records in a fashion similar to the
+ * proto_registrar_dump_* routines.
+ */
+extern void dissector_dump_decodes(void);
-/* ipproto.c */
-extern const char *ipprotostr(int proto);
+/*
+ * For each heuristic dissector table, dump list of dissectors (filter_names) for that table
+ */
+extern void dissector_dump_heur_decodes(void);
/*
- * All of the possible columns in summary listing.
- *
- * NOTE: The SRC and DST entries MUST remain in this order, or else you
- * need to fix the offset #defines before get_column_format!
+ * post dissectors are to be called by packet-frame.c after every other
+ * dissector has been called.
*/
-enum {
- COL_NUMBER, /* Packet list item number */
- COL_CLS_TIME, /* Command line-specified time (default relative) */
- COL_REL_TIME, /* Relative time */
- COL_ABS_TIME, /* Absolute time */
- COL_ABS_DATE_TIME, /* Absolute date and time */
- COL_DELTA_TIME, /* Delta time */
- COL_DEF_SRC, /* Source address */
- COL_RES_SRC, /* Resolved source */
- COL_UNRES_SRC, /* Unresolved source */
- COL_DEF_DL_SRC, /* Data link layer source address */
- COL_RES_DL_SRC, /* Resolved DL source */
- COL_UNRES_DL_SRC, /* Unresolved DL source */
- COL_DEF_NET_SRC, /* Network layer source address */
- COL_RES_NET_SRC, /* Resolved net source */
- COL_UNRES_NET_SRC, /* Unresolved net source */
- COL_DEF_DST, /* Destination address */
- COL_RES_DST, /* Resolved dest */
- COL_UNRES_DST, /* Unresolved dest */
- COL_DEF_DL_DST, /* Data link layer dest address */
- COL_RES_DL_DST, /* Resolved DL dest */
- COL_UNRES_DL_DST, /* Unresolved DL dest */
- COL_DEF_NET_DST, /* Network layer dest address */
- COL_RES_NET_DST, /* Resolved net dest */
- COL_UNRES_NET_DST, /* Unresolved net dest */
- COL_DEF_SRC_PORT, /* Source port */
- COL_RES_SRC_PORT, /* Resolved source port */
- COL_UNRES_SRC_PORT, /* Unresolved source port */
- COL_DEF_DST_PORT, /* Destination port */
- COL_RES_DST_PORT, /* Resolved dest port */
- COL_UNRES_DST_PORT, /* Unresolved dest port */
- COL_PROTOCOL, /* Protocol */
- COL_INFO, /* Description */
- COL_PACKET_LENGTH, /* Packet length in bytes */
- NUM_COL_FMTS /* Should always be last */
-};
+extern void register_postdissector(dissector_handle_t);
+extern gboolean have_postdissector(void);
+extern void call_all_postdissectors(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
#endif /* packet.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff