A protocol tree will hold all necessary data to display the whole dissected packet.
Creating a protocol tree is done in a two stage process:
A static part at program startup, and a dynamic part when the dissection with the real packet data is done.<BR>
- The "static" information is provided by creating a hf_register_info hf[] array, and register it using the
+ The "static" information is provided by creating a hf_register_info hf[] array, and register it using the
proto_register_field_array() function. This is usually done at dissector registering.<BR>
- The "dynamic" information is added to the protocol tree by calling one of the proto_tree_add_...() functions,
+ The "dynamic" information is added to the protocol tree by calling one of the proto_tree_add_...() functions,
e.g. proto_tree_add_bytes().
*/
#include "nstime.h"
#include "tvbuff.h"
#include "ftypes/ftypes.h"
+#include "register.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
/** The header-field index for the special text pseudo-field. Exported by libwireshark.dll */
WS_VAR_IMPORT int hf_text_only;
/** Make a const true_false_string[] look like a _true_false_string pointer, used to set header_field_info.strings */
#define TFS(x) (const struct true_false_string*)(x)
+typedef void (*custom_fmt_func_t)(gchar *, guint32);
+
+/** Make a const range_string[] look like a _range_string pointer, used to set
+ * header_field_info.strings */
+#define RVALS(x) (const struct _range_string*)(x)
+
struct _protocol;
/** Structure for information about a protocol */
typedef struct _protocol protocol_t;
-
+
/** check protocol activation
* @todo this macro looks like a hack */
#define CHECK_DISPLAY_AS_X(x_handle,index, tvb, pinfo, tree) { \
__DISSECTOR_ASSERT (expression, __FILE__, __LINE__)))
#if 0
-/* win32: using a debug breakpoint (int 3) can be very handy while debugging,
+/* win32: using a debug breakpoint (int 3) can be very handy while debugging,
* as the assert handling of GTK/GLib is currently not very helpful */
#define DISSECTOR_ASSERT(expression) \
{ if(!(expression)) _asm { int 3}; }
ep_strdup_printf("%s:%u: failed assertion \"%s\"", \
file, lineno, __DISSECTOR_ASSERT_STRINGIFY(expression))))
+/* BASE_STRUCTURE_RESET constant is used in proto.c to reset the bits
+ * identifying special structures used in translation of value for display.
+ * Its value means that we may have at most 16 base_display_e values */
+#define BASE_STRUCTURE_RESET 0x0F
+/* Following constants have to be ORed with a base_display_e when dissector
+ * want to use specials MACROs (for the moment, only RVALS) for a
+ * header_field_info */
+#define BASE_RANGE_STRING 0x10
/** radix for decimal values, used in header_field_info.display */
typedef enum {
BASE_NONE, /**< none */
BASE_HEX, /**< hexadecimal */
BASE_OCT, /**< octal */
BASE_DEC_HEX, /**< decimal (hexadecimal) */
- BASE_HEX_DEC /**< hexadecimal (decimal) */
+ BASE_HEX_DEC, /**< hexadecimal (decimal) */
+ BASE_CUSTOM /**< call custom routine (in ->strings) to format */
} base_display_e;
+typedef enum {
+ HF_REF_TYPE_NONE, /**< Field is not referenced */
+ HF_REF_TYPE_INDIRECT, /**< Field is indirectly referenced (only applicable for FT_PROTOCOL) via. its child */
+ HF_REF_TYPE_DIRECT /**< Field is directly referenced */
+} hf_ref_type;
+
#define IS_BASE_DUAL(b) ((b)==BASE_DEC_HEX||(b)==BASE_HEX_DEC)
/** information describing a header field */
/** information describing a header field */
struct _header_field_info {
/* ---------- set by dissector --------- */
- const char *name; /**< full name of this field */
- const char *abbrev; /**< abbreviated name of this field */
- enum ftenum type; /**< field type, one of FT_ (from ftypes.h) */
- int display; /**< one of BASE_, or number of field bits for FT_BOOLEAN */
- const void *strings; /**< _value_string (or true_false_string for FT_BOOLEAN), typically converted by VALS() or TFS() If this is an FT_PROTOCOL then it points to the associated protocol_t structure*/
- guint32 bitmask; /**< FT_BOOLEAN only: bitmask of interesting bits */
- const char *blurb; /**< Brief description of field. */
+ const char *name; /**< full name of this field */
+ const char *abbrev; /**< abbreviated name of this field */
+ enum ftenum type; /**< field type, one of FT_ (from ftypes.h) */
+ int display; /**< one of BASE_, or number of field bits for FT_BOOLEAN */
+ const void *strings; /**< value_string, range_string or true_false_string,
+ typically converted by VALS(), RVALS() or TFS().
+ If this is an FT_PROTOCOL then it points to the
+ associated protocol_t structure */
+ guint32 bitmask; /**< bitmask of interesting bits */
+ const char *blurb; /**< Brief description of field */
/* ------- set by proto routines (prefilled by HFILL macro, see below) ------ */
- int id; /**< Field ID */
- int parent; /**< parent protocol tree */
- /* This field keeps track of whether a field is
- * referenced in any filter or not and if so how
- * many times. If a filter is being referenced the
- * refcount for the parent protocol is updated as well
- */
- int ref_count; /**< is this field referenced by a filter or not */
- int bitshift; /**< bits to shift (FT_BOOLEAN only) */
- header_field_info *same_name_next; /**< Link to next hfinfo with same abbrev*/
- header_field_info *same_name_prev; /**< Link to previous hfinfo with same abbrev*/
+ int id; /**< Field ID */
+ int parent; /**< parent protocol tree */
+ hf_ref_type ref_type; /**< is this field referenced by a filter */
+ int bitshift; /**< bits to shift */
+ header_field_info *same_name_next; /**< Link to next hfinfo with same abbrev */
+ header_field_info *same_name_prev; /**< Link to previous hfinfo with same abbrev */
};
/**
* _header_field_info. If new fields are added or removed, it should
* be changed as necessary.
*/
-#define HFILL 0, 0, 0, 0, NULL, NULL
+#define HFILL 0, 0, HF_REF_TYPE_NONE, 0, NULL, NULL
/** Used when registering many fields at once, using proto_register_field_array() */
typedef struct hf_register_info {
- int *p_id; /**< written to by register() function */
- header_field_info hfinfo; /**< the field info to be registered */
+ int *p_id; /**< written to by register() function */
+ header_field_info hfinfo; /**< the field info to be registered */
} hf_register_info;
/** Contains the field information for the proto_item. */
typedef struct field_info {
- header_field_info *hfinfo; /**< pointer to registered field information */
- gint start; /**< current start of data in field_info.ds_tvb */
- gint length; /**< current data length of item in field_info.ds_tvb */
- gint tree_type; /**< one of ETT_ or -1 */
- item_label_t *rep; /**< string for GUI tree */
- int flags; /**< bitfield like FI_GENERATED, ... */
- tvbuff_t *ds_tvb; /**< data source tvbuff */
- fvalue_t value;
+ header_field_info *hfinfo; /**< pointer to registered field information */
+ gint start; /**< current start of data in field_info.ds_tvb */
+ gint length; /**< current data length of item in field_info.ds_tvb */
+ gint appendix_start; /**< start of appendix data */
+ gint appendix_length; /**< length of appendix data */
+ gint tree_type; /**< one of ETT_ or -1 */
+ item_label_t *rep; /**< string for GUI tree */
+ guint32 flags; /**< bitfield like FI_GENERATED, ... */
+ tvbuff_t *ds_tvb; /**< data source tvbuff */
+ fvalue_t value;
} field_info;
-/** The protocol field should not be shown in the tree (it's used for filtering only),
+/*
+ * Flag fields. Do not assign values greater than 0x00000080 unless you
+ * shuffle the expert information upward; see below.
+ */
+
+/** The protocol field should not be shown in the tree (it's used for filtering only),
* used in field_info.flags. */
/* HIDING PROTOCOL FIELDS IS DEPRECATED, IT'S CONSIDERED TO BE BAD GUI DESIGN! */
-#define FI_HIDDEN 0x0001
+#define FI_HIDDEN 0x00000001
/** The protocol field should be displayed as "generated by Wireshark",
* used in field_info.flags. */
-#define FI_GENERATED 0x0002
-
+#define FI_GENERATED 0x00000002
+/** The protocol field is actually a URL */
+#define FI_URL 0x00000004
/** convenience macro to get field_info.flags */
-#define FI_GET_FLAG(fi, flag) (fi->flags & flag)
+#define FI_GET_FLAG(fi, flag) ((fi) ? (fi->flags & flag) : 0)
/** convenience macro to set field_info.flags */
-#define FI_SET_FLAG(fi, flag) (fi->flags = fi->flags | flag)
+#define FI_SET_FLAG(fi, flag) ((fi) ? (fi->flags = fi->flags | flag) : 0)
/** One of these exists for the entire protocol tree. Each proto_node
* in the protocol tree points to the same copy. */
typedef struct {
GHashTable *interesting_hfids;
gboolean visible;
+ gboolean fake_protocols;
+ gint count;
} tree_data_t;
/** Each proto_tree, proto_item is one of these. */
/** A protocol item element. */
typedef proto_node proto_item;
+/*
+ * Expert information.
+ * This is in the flags field; we allocate this from the top down,
+ * so as not to collide with FI_ flags, which are allocated from
+ * the bottom up.
+ */
+
/* expert severities */
-#define PI_SEVERITY_MASK 0x001C /* mask usually for internal use only! */
+#define PI_SEVERITY_MASK 0x00000E00 /* mask usually for internal use only! */
/** Usual workflow, e.g. TCP connection establishing */
-#define PI_CHAT 0x0004
+#define PI_CHAT 0x00000200
/** Notable messages, e.g. an application returned an "usual" error code like HTTP 404 */
-#define PI_NOTE 0x0008
+#define PI_NOTE 0x00000400
/** Warning, e.g. application returned an "unusual" error code */
-#define PI_WARN 0x000C
+#define PI_WARN 0x00000600
/** Serious problems, e.g. [Malformed Packet] */
-#define PI_ERROR 0x0010
+#define PI_ERROR 0x00000800
/* expert "event groups" */
-#define PI_GROUP_MASK 0xFF00 /* mask usually for internal use only! */
+#define PI_GROUP_MASK 0xFFFFF000 /* mask usually for internal use only! */
/** The protocol field has a bad checksum, usually PI_WARN */
-#define PI_CHECKSUM 0x0100
+#define PI_CHECKSUM 0x00001000
/** The protocol field indicates a sequence problem (e.g. TCP window is zero) */
-#define PI_SEQUENCE 0x0200
+#define PI_SEQUENCE 0x00002000
/** The protocol field indicates a bad application response code (e.g. HTTP 404), usually PI_NOTE */
-#define PI_RESPONSE_CODE 0x0400
+#define PI_RESPONSE_CODE 0x00004000
/** The protocol field indicates an application request (e.g. File Handle == xxxx), usually PI_CHAT */
-#define PI_REQUEST_CODE 0x0500
+#define PI_REQUEST_CODE 0x00005000
/** The data is undecoded, the protocol dissection is incomplete here, usually PI_WARN */
-#define PI_UNDECODED 0x0800
+#define PI_UNDECODED 0x00008000
/** The protocol field indicates a reassemble (e.g. DCE/RPC defragmentation), usually PI_CHAT (or PI_ERROR) */
-#define PI_REASSEMBLE 0x1000
+#define PI_REASSEMBLE 0x00010000
/** The packet data is malformed, the dissector has "given up", usually PI_ERROR */
-#define PI_MALFORMED 0x2000
+#define PI_MALFORMED 0x00020000
/** A generic debugging message (shouldn't remain in production code!), usually PI_ERROR */
-#define PI_DEBUG 0x4000
-/** The protocol field indicates a security probem (e.g. unsecure implementation) */
-/*#define PI_SECURITY 0x8000*/
+#define PI_DEBUG 0x00040000
+/* The protocol field indicates a security probem (e.g. unsecure implementation) */
+/*#define PI_SECURITY 0x00080000*/
/* add more, see http://wiki.wireshark.org/Development/ExpertInfo */
/** is this protocol field hidden from the protocol tree display (used for filtering only)? */
/* HIDING PROTOCOL FIELDS IS DEPRECATED, IT'S CONSIDERED TO BE BAD GUI DESIGN! */
#define PROTO_ITEM_IS_HIDDEN(proto_item) \
- ((proto_item) ? FI_GET_FLAG((proto_item)->finfo, FI_HIDDEN) : 0)
+ ((proto_item) ? FI_GET_FLAG(PITEM_FINFO(proto_item), FI_HIDDEN) : 0)
/** mark this protocol field to be hidden from the protocol tree display (used for filtering only) */
/* HIDING PROTOCOL FIELDS IS DEPRECATED, IT'S CONSIDERED TO BE BAD GUI DESIGN! */
#define PROTO_ITEM_SET_HIDDEN(proto_item) \
- ((proto_item) ? FI_SET_FLAG((proto_item)->finfo, FI_HIDDEN) : 0)
+ ((proto_item) ? FI_SET_FLAG(PITEM_FINFO(proto_item), FI_HIDDEN) : 0)
/** is this protocol field generated by Wireshark (and not read from the packet data)? */
#define PROTO_ITEM_IS_GENERATED(proto_item) \
- ((proto_item) ? FI_GET_FLAG((proto_item)->finfo, FI_GENERATED) : 0)
+ ((proto_item) ? FI_GET_FLAG(PITEM_FINFO(proto_item), FI_GENERATED) : 0)
/** mark this protocol field as generated by Wireshark (and not read from the packet data) */
#define PROTO_ITEM_SET_GENERATED(proto_item) \
- ((proto_item) ? FI_SET_FLAG((proto_item)->finfo, FI_GENERATED) : 0)
+ ((proto_item) ? FI_SET_FLAG(PITEM_FINFO(proto_item), FI_GENERATED) : 0)
+/** is this protocol field actually a URL? */
+#define PROTO_ITEM_IS_URL(proto_item) \
+ ((proto_item) ? FI_GET_FLAG(PITEM_FINFO(proto_item), FI_URL) : 0)
+/** mark this protocol field as a URL */
+#define PROTO_ITEM_SET_URL(proto_item) \
+ ((proto_item) ? FI_SET_FLAG(PITEM_FINFO(proto_item), FI_URL) : 0)
typedef void (*proto_tree_foreach_func)(proto_node *, gpointer);
+typedef gboolean (*proto_tree_traverse_func)(proto_node *, gpointer);
+extern gboolean proto_tree_traverse_post_order(proto_tree *tree,
+ proto_tree_traverse_func func, gpointer data);
extern void proto_tree_children_foreach(proto_tree *tree,
proto_tree_foreach_func func, gpointer data);
+/** Retrieve the field_info from a proto_node */
+#define PNODE_FINFO(proto_node) ((proto_node)->finfo)
+
/** Retrieve the field_info from a proto_item */
-#define PITEM_FINFO(proto_item) ((proto_item)->finfo)
+#define PITEM_FINFO(proto_item) PNODE_FINFO(proto_item)
+
+/** Retrieve the field_info from a proto_tree */
+#define PTREE_FINFO(proto_tree) PNODE_FINFO(proto_tree)
/** Retrieve the tree_data_t from a proto_tree */
#define PTREE_DATA(proto_tree) ((proto_tree)->tree_data)
-
-
/** Sets up memory used by proto routines. Called at program startup */
-extern void proto_init(const char *plugin_dir,
- void (register_all_protocols)(void), void (register_all_handoffs)(void));
+extern void proto_init(void (register_all_protocols_func)(register_cb cb, gpointer client_data),
+ void (register_all_handoffs_func)(register_cb cb, gpointer client_data),
+ register_cb cb, void *client_data);
+
/** Frees memory used by proto routines. Called at program shutdown */
extern void proto_cleanup(void);
/** This function takes a tree and a protocol id as parameter and
will return TRUE/FALSE for whether the protocol or any of the filterable
fields in the protocol is referenced by any fitlers.
- If this function returns FALSE then it is safe to skip any
- proto_tree_add_...() calls and just treat the call as if the
+ If this function returns FALSE then it is safe to skip any
+ proto_tree_add_...() calls and just treat the call as if the
dissector was called with tree==NULL.
If you reset the tree to NULL by this dissector returning FALSE,
- you will still need to call any subdissector with the original value of
+ you will still need to call any subdissector with the original value of
tree or filtering will break.
The purpose of this is to optimize wireshark for speed and make it
* in the item is relative to the beginning of the data source tvbuff,
* we need to pass in a tvbuff.
@param ti the item to set the length
- @param tvb end is relative to this tvbuff
+ @param tvb end is relative to this tvbuff
@param end this end offset is relative to the beginning of tvb
@todo make usage clearer, I don't understand it!
*/
@param severity of this info (e.g. PI_ERROR)
@return TRUE if value was written
*/
-extern gboolean proto_item_set_expert_flags(proto_item *ti, int group, int severity);
+extern gboolean proto_item_set_expert_flags(proto_item *ti, int group, guint severity);
By setting this correctly, the proto_tree creation is sped up by not
having to call g_vsnprintf and copy strings around.
@param tree the tree to be set
- @param visible ... or not */
-extern void
+ @param visible ... or not
+ @return the old value */
+extern gboolean
proto_tree_set_visible(proto_tree *tree, gboolean visible);
+/** Indicate whether we should fake protocols during dissection (default = TRUE)
+ @param tree the tree to be set
+ @param fake_protocols TRUE if we should fake protocols */
+extern void
+proto_tree_set_fake_protocols(proto_tree *tree, gboolean fake_protocols);
+
/** Mark a field/protocol ID as "interesting".
@param tree the tree to be set
@param hfid the interesting field id
@return parent item */
extern proto_item* proto_tree_get_parent(proto_tree *tree);
+/** Get the root tree from any subtree.
+ @param tree the tree to get the root from
+ @return root tree */
+extern proto_tree* proto_tree_get_root(proto_tree *tree);
+
/** Move an existing item behind another existing item.
@param tree the tree to which both items belong
@param fixed_item the item which keeps it's position
extern void proto_tree_move_item(proto_tree *tree, proto_item *fixed_item, proto_item *item_to_move);
+/** Set start and length of an appendix for a proto_tree.
+ @param tree the tree to set the appendix start and length
+ @param tvb the tv buffer of the current data
+ @param start the start offset of the appendix
+ @param length the length of the appendix */
+extern void proto_tree_set_appendix(proto_tree *tree, tvbuff_t *tvb, gint start, gint length);
+
/** Add an item to a proto_tree, using the text label registered to that item.
The item is extracted from the tvbuff handed to it.
proto_tree_add_item(proto_tree *tree, int hfindex, tvbuff_t *tvb,
gint start, gint length, gboolean little_endian);
-/** Add a hidden item to a proto_tree.
- @deprecated use proto_tree_add_item() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_item_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb,
- gint start, gint length, gboolean little_endian);
-
/** Add a text-only node to a proto_tree.
@param tree the tree to append this item to
@param tvb the tv buffer of the current data
proto_tree_add_bytes(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, const guint8* start_ptr);
-/** Add a hidden FT_BYTES to a proto_tree.
- @deprecated use proto_tree_add_bytes() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_bytes_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, const guint8* start_ptr);
-
/** Add a formatted FT_BYTES to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_time(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, nstime_t* value_ptr);
-/** Add a hidden FT_ABSOLUTE_TIME or FT_RELATIVE_TIME to a proto_tree.
- @deprecated use proto_tree_add_time() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_time_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, nstime_t* value_ptr);
-
/** Add a formatted FT_ABSOLUTE_TIME or FT_RELATIVE_TIME to a proto_tree, with
the format generating the string for the value and with the field name
being included automatically.
proto_tree_add_ipxnet(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, guint32 value);
-/** Add a hidden FT_IPXNET to a proto_tree.
- @deprecated use proto_tree_add_ipxnet() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_ipxnet_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, guint32 value);
-
/** Add a formatted FT_IPXNET to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_ipv4(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, guint32 value);
-/** Add a hidden FT_IPv4 to a proto_tree.
- @deprecated use proto_tree_add_ipv4() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_ipv4_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, guint32 value);
-
/** Add a formatted FT_IPv4 to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_ipv6(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, const guint8* value_ptr);
-/** Add a hidden FT_IPv6 to a proto_tree.
- @deprecated use proto_tree_add_ipv6() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_ipv6_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, const guint8* value_ptr);
-
/** Add a formatted FT_IPv6 to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_ether(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, const guint8* value);
-/** Add a hidden FT_ETHER to a proto_tree.
- @deprecated use proto_tree_add_ether() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_ether_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, const guint8* value);
-
/** Add a formatted FT_ETHER to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_guid(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, const e_guid_t *value_ptr);
-/** Add a hidden FT_GUID to a proto_tree.
- @deprecated use proto_tree_add_guid() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_guid_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, const e_guid_t *value_ptr);
-
/** Add a formatted FT_GUID to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_oid(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, const guint8* value_ptr);
-/** Add a hidden FT_OID to a proto_tree.
- @deprecated use proto_tree_add_oid() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_oid_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, const guint8* value_ptr);
-
/** Add a formatted FT_OID to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, const char* value);
-/** Add a hidden FT_STRING to a proto_tree.
- @deprecated use proto_tree_add_string() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_string_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, const char* value);
-
/** Add a formatted FT_STRING to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_boolean(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, guint32 value);
-/** Add a hidden FT_BOOLEAN to a proto_tree.
- @deprecated use proto_tree_add_boolean() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_boolean_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, guint32 value);
-
/** Add a formatted FT_BOOLEAN to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_float(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, float value);
-/** Add a hidden FT_FLOAT to a proto_tree.
- @deprecated use proto_tree_add_float() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_float_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, float value);
-
/** Add a formatted FT_FLOAT to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_double(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, double value);
-/** Add a hidden FT_DOUBLE to a proto_tree.
- @deprecated use proto_tree_add_double() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_double_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, double value);
-
/** Add a formatted FT_DOUBLE to a proto_tree, with the format generating
the string for the value and with the field name being included
automatically.
proto_tree_add_uint(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, guint32 value);
-/** Add a hidden FT_UINT8, FT_UINT16, FT_UINT24 or FT_UINT32 to a proto_tree.
- @deprecated use proto_tree_add_uint() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_uint_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, guint32 value);
-
/** Add a formatted FT_UINT8, FT_UINT16, FT_UINT24 or FT_UINT32 to a proto_tree,
with the format generating the string for the value and with the field
name being included automatically.
proto_tree_add_int(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
gint length, gint32 value);
-/** Add a hidden FT_INT8, FT_INT16, FT_INT24 or FT_INT32 to a proto_tree.
- @deprecated use proto_tree_add_int() and a subsequent call to PROTO_ITEM_SET_HIDDEN() instead */
-extern proto_item *
-proto_tree_add_int_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
- gint length, gint32 value);
-
/** Add a formatted FT_INT8, FT_INT16, FT_INT24 or FT_INT32 to a proto_tree,
with the format generating the string for the value and with the field
name being included automatically.
gint length, gint64 value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
/** Useful for quick debugging. Also sends string to STDOUT, so don't
- * leave call to this function in production code.
+ leave call to this function in production code.
@param tree the tree to append the text to
@param format printf like format string
@param ... printf like parameters
@return the newly created item */
extern proto_item *
-proto_tree_add_debug_text(proto_tree *tree, const char *format,
+proto_tree_add_debug_text(proto_tree *tree, const char *format,
...) GNUC_FORMAT_CHECK(printf,2,3);
IF you must use this function you MUST also disable the
TRY_TO_FAKE_THIS_ITEM() optimization for your dissector/function
using proto_item_append_string().
- Do that by faking that the tree is visible by setting :
- PTREE_DATA(tree)->visible=1; (see packet-wsp.c)
+ Do that by faking that the tree is visible by calling
+ proto_tree_set_visible(tree, TRUE) (see packet-wsp.c)
BEFORE you create the item you are later going to use
proto_item_append_string() on.
-
@param pi the item to append the string to
@param str the string to append */
extern void
/** Fill given label_str with string representation of field
@param fi the item to get the info from
- @param label_str the string to fill
+ @param label_str the string to fill
@todo think about changing the parameter profile */
extern void
proto_item_fill_label(field_info *fi, gchar *label_str);
/** Register a new protocol.
@param name the full name of the new protocol
@param short_name abbreviated name of the new protocol
- @param filter_name protocol name used for a display filter string
+ @param filter_name protocol name used for a display filter string
@return the new protocol handle */
extern int
proto_register_protocol(const char *name, const char *short_name, const char *filter_name);
+/** Mark protocol as private
+ @param proto_id the handle of the protocol */
+extern void
+proto_mark_private(int proto_id);
+
+/** Return if protocol is private
+ @param proto_id the handle of the protocol
+ @return TRUE if it is a private protocol, FALSE is not. */
+extern gboolean
+proto_is_private(int proto_id);
+
+/** This is the type of function can be registered to get called whenever
+ a given field was not found but a its prefix is matched
+ it can be used to procrastinate the hf array registration
+ @param match what's being matched */
+typedef void (*prefix_initializer_t)(const char* match);
+
+/** Register a new prefix for delayed initialization of field arrays
+@param prefix the prefix for the new protocol
+@param initializer function that will initialize the field array for the given prefix */
+extern void
+proto_register_prefix(const char *prefix, prefix_initializer_t initializer);
+
+/** Initialize every remaining uninitialized prefix. */
+extern void proto_initialize_all_prefixes(void);
+
/** Register a header_field array.
@param parent the protocol handle from proto_register_protocol()
@param hf the hf_register_info array
@return TRUE if it's a protocol, FALSE if it's not */
extern gboolean proto_registrar_is_protocol(int n);
-/* Get length of registered field according to field type.
+/** Get length of registered field according to field type.
@param n item # n (0-indexed)
- @return 0 means undeterminable at registration time, * -1 means unknown field */
+ @return 0 means undeterminable at registration time, -1 means unknown field */
extern gint proto_registrar_get_length(int n);
-/* Routines to use to iterate over the protocols and their fields;
+/** Routines to use to iterate over the protocols and their fields;
* they return the item number of the protocol in question or the
* appropriate hfinfo pointer, and keep state in "*cookie". */
extern int proto_get_first_protocol(void **cookie);
@return its short name. */
extern const char *proto_get_protocol_short_name(protocol_t *protocol);
+/** Get the protocol's long name, for the given protocol's "protocol_t".
+ @return its long name. */
+extern const char *proto_get_protocol_long_name(protocol_t *protocol);
+
/** Is protocol's decoding enabled ?
- @param protocol
+ @param protocol
@return TRUE if decoding is enabled, FALSE if not */
extern gboolean proto_is_protocol_enabled(protocol_t *protocol);
@param enabled enable / disable the protocol */
extern void proto_set_decoding(int proto_id, gboolean enabled);
+/** Enable all protocols */
+extern void proto_enable_all(void);
+
/** Disable disabling/enabling of protocol of the given item number.
@param proto_id protocol id (0-indexed) */
extern void proto_set_cant_toggle(int proto_id);
/** Checks for existence any protocol or field within a tree.
@param tree "Protocols" are assumed to be a child of the [empty] root node.
- @param id ???
+ @param id hfindex of protocol or field
@return TRUE = found, FALSE = not found
@todo add explanation of id parameter */
extern gboolean proto_check_for_protocol_or_field(proto_tree* tree, int id);
-/* Return GPtrArray* of field_info pointers for all hfindex that appear in
- * tree. Only works with primed trees, and is fast. */
+/** Return GPtrArray* of field_info pointers for all hfindex that appear in
+ tree. Only works with primed trees, and is fast.
+ @param tree tree of interest
+ @param hfindex primed hfindex
+ @return GPtrArry pointer */
extern GPtrArray* proto_get_finfo_ptr_array(proto_tree *tree, int hfindex);
-/* Return GPtrArray* of field_info pointers for all hfindex that appear in
- * tree. Works with any tree, primed or unprimed, and is slower than
- * proto_get_finfo_ptr_array because it has to search through the tree. */
+/** Return whether we're tracking any interesting fields.
+ Only works with primed trees, and is fast.
+ @param tree tree of interest
+ @return TRUE if we're tracking interesting fields */
+extern gboolean proto_tracking_interesting_fields(proto_tree *tree);
+
+/** Return GPtrArray* of field_info pointers for all hfindex that appear in
+ tree. Works with any tree, primed or unprimed, and is slower than
+ proto_get_finfo_ptr_array because it has to search through the tree.
+ @param tree tree of interest
+ @param hfidex index of field info of interest
+ @return GPtrArry pointer */
extern GPtrArray* proto_find_finfo(proto_tree *tree, int hfindex);
-/* Return GPtrArray* of field_info pointers containg all hfindexes that appear in
-* tree. */
+/** Return GPtrArray* of field_info pointers containg all hfindexes that appear
+ in tree.
+ @param tree tree of interest
+ @return GPtrArry pointer */
extern GPtrArray* proto_all_finfos(proto_tree *tree);
/** Dumps a glossary of the protocol registrations to STDOUT */
/** Points to the first element of an array of Booleans, indexed by
a subtree item type. That array element is TRUE if subtrees of
- an item of that type are to be expanded. With MSVC and a
+ an item of that type are to be expanded. With MSVC and a
libwireshark.dll, we need a special declaration. */
WS_VAR_IMPORT gboolean *tree_is_expanded;
-/** Number of elements in the tree_is_expanded array. With MSVC and a
+/** Number of elements in the tree_is_expanded array. With MSVC and a
* libwireshark.dll, we need a special declaration. */
WS_VAR_IMPORT int num_tree_types;
extern gboolean
proto_can_match_selected(field_info *finfo, epan_dissect_t *edt);
-/** Construct a display filter string.
+/** Construct a "match selected" display filter string.
@param finfo field_info
@param edt epan dissecting
@return the display filter string */
extern char*
-proto_construct_dfilter_string(field_info *finfo, epan_dissect_t *edt);
+proto_construct_match_selected_string(field_info *finfo, epan_dissect_t *edt);
/** Find field from offset in tvb.
- @param tree
+ @param tree tree of interest
@param offset offset in the tvb
@param tvb the tv buffer
@return the corresponding field_info */
extern field_info*
proto_find_field_from_offset(proto_tree *tree, guint offset, tvbuff_t *tvb);
+/** This function will dissect a sequence of bytes that describe a bitmask.
+ @param tree the tree to append this item to
+ @param tvb the tv buffer of the current data
+ @param offset start of data in tvb
+ @param hf_hdr an 8/16/24/32 bit integer that describes the bitmask to be dissected.
+ This field will form an expansion under which the individual fields of the
+ bitmask is dissected and displayed.
+ This field must be of the type FT_[U]INT{8|16|24|32}.
+ @param ett subtree index
+ @param fields an array of pointers to int that lists all the fields of the
+ bitmask. These fields can be either of the type FT_BOOLEAN for flags
+ or another integer of the same type/size as hf_hdr with a mask specified.
+ This array is terminated by a NULL entry.
+ FT_BOOLEAN bits that are set to 1 will have the name added to the expansion.
+ FT_integer fields that have a value_string attached will have the
+ matched string displayed on the expansion line.
+ @param little_endian big or little endian byte representation
+ @return the newly created item */
+extern proto_item *
+proto_tree_add_bitmask(proto_tree *tree, tvbuff_t *tvb, guint offset,
+ int hf_hdr, gint ett, const int **fields, gboolean little_endian);
+
+/** Add a text with a subtree of bitfields.
+ @param tree the tree to append this item to
+ @param tvb the tv buffer of the current data
+ @param offset start of data in tvb
+ @param name field name (NULL if bitfield contents should be used)
+ @param fallback field name if none of bitfields were usable
+ @param ett subtree index
+ @param fields NULL-terminated array of bitfield indexes
+ @param little_endian big or little endian byte representation
+ @return the newly created item */
+extern proto_item *
+proto_tree_add_bitmask_text(proto_tree *tree, tvbuff_t *tvb, guint offset, guint len,
+ const char *name, const char *fallback,
+ gint ett, const int **fields, gboolean little_endian, int flags);
+
+#define BMT_NO_APPEND 0x01 /**< Don't change the title at all */
+#define BMT_NO_INT 0x02 /**< Don't add integral (non-boolean) fields to title */
+#define BMT_NO_FALSE 0x04 /**< Don't add booleans unless they're TRUE */
+#define BMT_NO_TFS 0x08 /**< Don't use true_false_string while formatting booleans */
+
+/** Add bits to a proto_tree, using the text label registered to that item.
+ The item is extracted from the tvbuff handed to it.
+ @param tree the tree to append this item to
+ @param hfindex field index. Fields for use with this function should have bitmask==0.
+ @param tvb the tv buffer of the current data
+ @param bit_offset start of data in tvb expressed in bits
+ @param no_of_bits length of data in tvb expressed in bits
+ @param little_endian big or little endian byte representation
+ @return the newly created item */
+extern proto_item *
+proto_tree_add_bits_item(proto_tree *tree, int hf_index, tvbuff_t *tvb, gint bit_offset, gint no_of_bits, gboolean little_endian);
+
+/** Add bits to a proto_tree, using the text label registered to that item.
+ The item is extracted from the tvbuff handed to it.
+ @param tree the tree to append this item to
+ @param hfindex field index. Fields for use with this function should have bitmask==0.
+ @param tvb the tv buffer of the current data
+ @param bit_offset start of data in tvb expressed in bits
+ @param no_of_bits length of data in tvb expressed in bits
+ @param return_value if a pointer is passed here the value is returned.
+ @param little_endian big or little endian byte representation
+ @return the newly created item */
+extern proto_item *
+proto_tree_add_bits_ret_val(proto_tree *tree, int hf_index, tvbuff_t *tvb, gint bit_offset, gint no_of_bits, guint64 *return_value, gboolean little_endian);
+
+/** Check if given string is a valid field name
+ @param field_name the field name to check
+ @return 0 if valid, else first illegal character */
+extern guchar
+proto_check_field_name(const gchar *field_name);
+
+
+/** Check if given string is a valid field name
+ @param field_id the field id used for custom column
+ @param result the buffer to fill with the field string
+ @param expr the filter expression
+ @param aize the size of the string buffer */
+const gchar *
+proto_custom_set(proto_tree* tree, int field_id,
+ gchar *result,
+ gchar *expr, int size );
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
#endif /* proto.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff