$Revision$
$Date$
$Author$
+Tabsize: 4
This file is a HOWTO for Wireshark developers. It describes how to start coding
a Wireshark protocol dissector and the use of some of the important functions
environment is required - there's no such thing as a standalone "dissector
build toolkit".
-How to setup such an environment is platform dependent, detailed information
+How to setup such an environment is platform dependent; detailed information
about these steps can be found in the "Developer's Guide" (available from:
http://www.wireshark.org) and in the INSTALL and README files of the sources
root dir.
You'll find additional information in the following README files:
-- README.capture - the capture engine internals
-- README.design - Wireshark software design - incomplete
-- README.developer - this file
+- README.capture - the capture engine internals
+- README.design - Wireshark software design - incomplete
+- README.developer - this file
- README.display_filter - Display Filter Engine
-- README.idl2wrs - CORBA IDL converter
-- README.packaging - how to distribute a software package containing WS
-- README.regression - regression testing of WS and TS
-- README.stats_tree - a tree statistics counting specific packets
-- README.tapping - "tap" a dissector to get protocol specific events
-- README.xml-output - how to work with the PDML exported output
+- README.idl2wrs - CORBA IDL converter
+- README.packaging - how to distribute a software package containing WS
+- README.regression - regression testing of WS and TS
+- README.stats_tree - a tree statistics counting specific packets
+- README.tapping - "tap" a dissector to get protocol specific events
+- README.xml-output - how to work with the PDML exported output
- wiretap/README.developer - how to add additional capture file types to
Wiretap
You'll find additional dissector related information in the following README
files:
-- README.binarytrees - fast access to large data collections
-- README.malloc - how to obtain "memory leak free" memory
-- README.plugins - how to "pluginize" a dissector
+- README.binarytrees - fast access to large data collections
+- README.heuristic - what are heuristic dissectors and how to write them
+- README.malloc - how to obtain "memory leak free" memory
+- README.plugins - how to "pluginize" a dissector
+- README.python - writing a dissector in PYTHON.
- README.request_response_tracking - how to track req./resp. times and such
0.3 Contributors
support C++-style comments (GCC does, but IBM's C compiler for AIX, for
example, doesn't do so by default).
+In general, don't use C99 features since some C compilers used to compile
+Wireshark don't support C99 (E.G. Microsoft C).
+
Don't initialize variables in their declaration with non-constant
values. Not all compilers support this. E.g. don't use
guint32 i = somearray[2];
compilers support that. Variables should be declared outside a
function, or at the beginning of a function or compound statement.
-Don't use anonymous unions; not all compilers support it.
+Don't use anonymous unions; not all compilers support them.
Example:
-typedef struct foo {
- guint32 foo;
- union {
- guint32 foo_l;
- guint16 foo_s;
- } u; /* have a name here */
-} foo_t;
+
+ typedef struct foo {
+ guint32 foo;
+ union {
+ guint32 foo_l;
+ guint16 foo_s;
+ } u; /* have a name here */
+ } foo_t;
Don't use "uchar", "u_char", "ushort", "u_short", "uint", "u_int",
"ulong", "u_long" or "boolean"; they aren't defined on all platforms.
which will be defined as the appropriate types for 64-bit signed and
unsigned integers.
+On LLP64 data model systems (notably 64-bit Windows), "int" and "long"
+are 32 bits while "size_t" and "ptrdiff_t" are 64 bits. This means that
+the following will generate a compiler warning:
+
+ int i;
+ i = strlen("hello, sailor"); /* Compiler warning */
+
+Normally, you'd just make "i" a size_t. However, many GLib and Wireshark
+functions won't accept a size_t on LLP64:
+
+ size_t i;
+ char greeting[] = "hello, sailor";
+ guint byte_after_greet;
+
+ i = strlen(greeting);
+ byte_after_greet = tvb_get_guint8(tvb, i); /* Compiler warning */
+
+Try to use the appropriate data type when you can. When you can't, you
+will have to cast to a compatible data type, e.g.
+
+ size_t i;
+ char greeting[] = "hello, sailor";
+ guint byte_after_greet;
+
+ i = strlen(greeting);
+ byte_after_greet = tvb_get_guint8(tvb, (gint) i); /* OK */
+
+or
+
+ gint i;
+ char greeting[] = "hello, sailor";
+ guint byte_after_greet;
+
+ i = (gint) strlen(greeting);
+ byte_after_greet = tvb_get_guint8(tvb, i); /* OK */
+
+See http://www.unix.org/version2/whatsnew/lp64_wp.html for more
+information on the sizes of common types in different data models.
+
When printing or displaying the values of 64-bit integral data types,
don't use "%lld", "%llu", "%llx", or "%llo" - not all platforms
support "%ll" for printing 64-bit integral data types. Instead, for
"Sequence Number: %" G_GINT64_MODIFIER "u",
sequence_number);
-When using standard C routines, such as printf and scanf, use
-PRId64, PRIu64, PRIx64, PRIX64, and PRIo64, for example:
-
- printf("Sequence Number: %" PRIu64 "\n", sequence_number);
-
When specifying an integral constant that doesn't fit in 32 bits, don't
use "LL" at the end of the constant - not all compilers use "LL" for
that. Instead, put the constant in a call to the "G_GINT64_CONSTANT()"
11644473600ULL
+Don't assume that you can scan through a va_list initialized by va_start
+more than once without closing it with va_end and re-initalizing it with
+va_start. This applies even if you're not scanning through it yourself,
+but are calling a routine that scans through it, such as vfprintf() or
+one of the routines in Wireshark that takes a format and a va_list as an
+argument. You must do
+
+ va_start(ap, format);
+ call_routine1(xxx, format, ap);
+ va_end(ap);
+ va_start(ap, format);
+ call_routine2(xxx, format, ap);
+ va_end(ap);
+
+rather
+ va_start(ap, format);
+ call_routine1(xxx, format, ap);
+ call_routine2(xxx, format, ap);
+ va_end(ap);
+
Don't use a label without a statement following it. For example,
something such as
unaligned access for you, and will, on at least some platforms, cause
the program to be terminated.
-Wireshark supports platforms with GLib 2.4[.x]/GTK+ 2.4[.x] or newer.
-If a Glib/GTK+ mechanism is available only in Glib/GTK+ versions
-newer than 2.4/2.4 then use "#if GTK_CHECK_VERSION(...)" to conditionally
-compile code using that mechanism.
+Wireshark supports platforms with GLib 2.14[.x]/GTK+ 2.12[.x] or newer.
+If a Glib/GTK+ mechanism is available only in Glib/GTK+ versions newer
+than 2.14/2.12 then use "#if GLIB_CHECK_VERSION(...)" or "#if
+GTK_CHECK_VERSION(...)" to conditionally compile code using that
+mechanism.
When different code must be used on UN*X and Win32, use a #if or #ifdef
that tests _WIN32, not WIN32. Try to write code portably whenever
When using a buffer to create a string, do not use a buffer stored on the stack.
I.e. do not use a buffer declared as
+
char buffer[1024];
-instead allocate a buffer dynamically using the emem routines (see
-README.malloc) such as
+
+instead allocate a buffer dynamically using the string-specific or plain emem
+routines (see README.malloc) such as
+
+ emem_strbuf_t *strbuf;
+ strbuf = ep_strbuf_new_label("");
+ ep_strbuf_append_printf(strbuf, ...
+
+or
+
char *buffer=NULL;
...
#define MAX_BUFFER 1024
buffer=ep_alloc(MAX_BUFFER);
- buffer[0]=0;
+ buffer[0]='\0';
...
g_snprintf(buffer, MAX_BUFFER, ...
don't have to worry about free()ing them explicitly in order to not leak memory.
Please read README.malloc.
+Don't use non-ASCII characters in source files; not all compiler
+environments will be using the same encoding for non-ASCII characters,
+and at least one compiler (Microsoft's Visual C) will, in environments
+with double-byte character encodings, such as many Asian environments,
+fail if it sees a byte sequence in a source file that doesn't correspond
+to a valid character. This causes source files using either an ISO
+8859/n single-byte character encoding or UTF-8 to fail to compile. Even
+if the compiler doesn't fail, there is no guarantee that the compiler,
+or a developer's text editor, will interpret the characters the way you
+intend them to be interpreted.
+
1.1.3 Robustness.
Wireshark is not guaranteed to read only network traces that contain correctly-
that it's a problem with the dissector if found; if it cannot do
anything else with a particular value from a packet's data, the
dissector should put into the protocol tree an indication that the
-value is invalid, and should return. You can use the DISSECTOR_ASSERT
-macro for that purpose.
+value is invalid, and should return. The "expert" mechanism should be
+used for that purpose.
+
+If there is a case where you are checking not for an invalid data item
+in the packet, but for a bug in the dissector (for example, an
+assumption being made at a particular point in the code about the
+internal state of the dissector), use the DISSECTOR_ASSERT macro for
+that purpose; this will put into the protocol tree an indication that
+the dissector has a bug in it, and will not crash the application.
If you are allocating a chunk of memory to contain data from a packet,
or to contain information derived from data in a packet, and the size of
the chunk of memory is derived from a size field in the packet, make
sure all the data is present in the packet before allocating the buffer.
-Doing so means that
+Doing so means that:
1) Wireshark won't leak that chunk of memory if an attempt to
- fetch data not present in the packet throws an exception
+ fetch data not present in the packet throws an exception.
and
long, so that, if the length value is *very* large and adding it to the
offset causes an overflow, that overflow is detected.
+If you have a
+
+ for (i = {start}; i < {end}; i++)
+
+loop, make sure that the type of the loop index variable is large enough
+to hold the maximum {end} value plus 1; otherwise, the loop index
+variable can overflow before it ever reaches its maximum value. In
+particular, be very careful when using gint8, guint8, gint16, or guint16
+variables as loop indices; you almost always want to use an "int"/"gint"
+or "unsigned int"/"guint" as the loop index rather than a shorter type.
+
If you are fetching a length field from the buffer, corresponding to the
length of a portion of the packet, and subtracting from that length a
value corresponding to the length of, for example, a header in the
you're using non-mod-8 tabs. The tabs-vs-spaces document above provides
examples of Emacs and vi modelines for this purpose.
+Please do not leave trailing whitespace (spaces/tabs) on lines.
+
When editing an existing file, try following the existing indentation
logic and even if it very tempting, never ever use a restyler/reindenter
utility on an existing file. If you run across wildly varying
Usually, you will put your newly created dissector file into the directory
epan/dissectors, just like all the other packet-....c files already in there.
-Also, please add your dissector file to the corresponding makefile,
-described in section "1.9 Editing Makefile.common to add your dissector" below.
+Also, please add your dissector file to the corresponding makefiles,
+described in section "1.9 Editing Makefile.common and CMakeLists.txt
+to add your dissector" below.
Dissectors that use the dissector registration to register with a lower level
dissector don't need to define a prototype in the .h file. For other
should be changed to include that file.
You may not need to include all the headers listed in the skeleton
-below, and you may need to include additional headers. For example, the
-code inside
-
- #ifdef HAVE_LIBPCRE
-
- ...
+below, and you may need to include additional headers.
- #endif
+The stdio.h, stdlib.h and string.h header files should be included only as needed.
-is needed only if you are using a function from libpcre, e.g. the
-"pcre_compile()" function.
The "$Id$" in the comment will be updated by Subversion when the file is
checked in.
------------------------------------Cut here------------------------------------
/* packet-PROTOABBREV.c
* Routines for PROTONAME dissection
- * Copyright 200x, YOUR_NAME <YOUR_EMAIL_ADDRESS>
+ * Copyright 201x, YOUR_NAME <YOUR_EMAIL_ADDRESS>
*
* $Id$
*
* in a "Copied from" if you copied an existing dissector, especially
* if the bulk of the code in the new dissector is your code)
*
- * 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 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
+#if 0
+/* Include only as needed */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#endif
#include <glib.h>
in a header file. If not, a header file is not needed at all. */
#include "packet-PROTOABBREV.h"
-/* Forward declaration we need below */
+/* Forward declaration we need below (if using proto_reg_handoff...
+ as a prefs callback) */
void proto_reg_handoff_PROTOABBREV(void);
/* Initialize the protocol and registered fields */
/* Global sample preference ("controls" display of numbers) */
static gboolean gPREF_HEX = FALSE;
+/* Global sample port pref */
+static guint gPORT_PREF = 1234;
/* Initialize the subtree pointers */
static gint ett_PROTOABBREV = -1;
return 0;
/* Make entries in Protocol column and Info column on summary display */
- if (check_col(pinfo->cinfo, COL_PROTOCOL))
- col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
+ col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
/* This field shows up as the "Info" column in the display; you should use
it, if possible, to summarize what's in the packet, so that a user looking
at the list of packets can tell what type of packet it is. See section 1.5
for more information.
- Before changing the contents of a column you should make sure the column is
- active by calling "check_col(pinfo->cinfo, COL_*)". If it is not active
- don't bother setting it.
-
If you are setting the column to a constant string, use "col_set_str()",
as it's more efficient than the other "col_set_XXX()" calls.
past the end of the packet, so that the Info column doesn't have data
left over from the previous dissector; do
- if (check_col(pinfo->cinfo, COL_INFO))
- col_clear(pinfo->cinfo, COL_INFO);
+ col_clear(pinfo->cinfo, COL_INFO);
*/
- if (check_col(pinfo->cinfo, COL_INFO))
- col_set_str(pinfo->cinfo, COL_INFO, "XXX Request");
-
-/* A protocol dissector can be called in 2 different ways:
-
- (a) Operational dissection
+ col_set_str(pinfo->cinfo, COL_INFO, "XXX Request");
- In this mode, Wireshark is only interested in the way protocols
- interact, protocol conversations are created, packets are
- reassembled and handed over to higher-level protocol dissectors.
- In this mode Wireshark does not build a so-called "protocol
- tree".
+/* A protocol dissector may be called in 2 different ways - with, or
+ without a non-null "tree" argument.
- (b) Detailed dissection
-
- In this mode, Wireshark is also interested in all details of
- a given protocol, so a "protocol tree" is created.
-
- Wireshark distinguishes between the 2 modes with the proto_tree pointer:
- (a) <=> tree == NULL
- (b) <=> tree != NULL
+ If the proto_tree argument is null, Wireshark does not need to use
+ the protocol tree information from your dissector, and therefore is
+ passing the dissector a null "tree" argument so that it doesn't
+ need to do work necessary to build the protocol tree.
In the interest of speed, if "tree" is NULL, avoid building a
protocol tree and adding stuff to it, or even looking at any packet
work if you're not building a protocol tree, but if the code would
have a lot of tests whether "tree" is null if you skipped that work,
you might still be better off just doing all that work regardless of
- whether "tree" is null or not. */
+ whether "tree" is null or not.
+
+ Note also that there is no guarantee, the first time the dissector is
+ called, whether "tree" will be null or not; your dissector must work
+ correctly, building or updating whatever state information is
+ necessary, in either case. */
if (tree) {
/* NOTE: The offset and length values in the call to
offset to the end of the packet. */
/* create display subtree for the protocol */
- ti = proto_tree_add_item(tree, proto_PROTOABBREV, tvb, 0, -1, FALSE);
+ ti = proto_tree_add_item(tree, proto_PROTOABBREV, tvb, 0, -1, ENC_NA);
PROTOABBREV_tree = proto_item_add_subtree(ti, ett_PROTOABBREV);
/* add an item to the subtree, see section 1.6 for more information */
proto_tree_add_item(PROTOABBREV_tree,
- hf_PROTOABBREV_FIELDABBREV, tvb, offset, len, FALSE);
+ hf_PROTOABBREV_FIELDABBREV, tvb, offset, len, ENC_xxx);
/* Continue adding tree items to process the packet here */
static hf_register_info hf[] = {
{ &hf_PROTOABBREV_FIELDABBREV,
{ "FIELDNAME", "PROTOABBREV.FIELDABBREV",
- FIELDTYPE, FIELDBASE, FIELDCONVERT, BITMASK,
+ FIELDTYPE, FIELDDISPLAY, FIELDCONVERT, BITMASK,
"FIELDDESCR", HFILL }
}
};
proto_register_subtree_array(ett, array_length(ett));
/* Register preferences module (See Section 2.6 for more on preferences) */
+/* (Registration of a prefs callback is not required if there are no */
+/* prefs-dependent registration functions (eg: a port pref). */
+/* See proto_reg_handoff below. */
+/* If a prefs callback is not needed, use NULL instead of */
+/* proto_reg_handoff_PROTOABBREV in the following). */
PROTOABBREV_module = prefs_register_protocol(proto_PROTOABBREV,
proto_reg_handoff_PROTOABBREV);
+/* Register preferences module under preferences subtree.
+ Use this function instead of prefs_register_protocol if you want to group
+ preferences of several protocols under one preferences subtree.
+ Argument subtree identifies grouping tree node name, several subnodes can be
+ specified usign slash '/' (e.g. "OSI/X.500" - protocol preferences will be
+ accessible under Protocols->OSI->X.500-><PROTOSHORTNAME> preferences node.
+*/
+ PROTOABBREV_module = prefs_register_protocol_subtree(const char *subtree,
+ proto_PROTOABBREV, proto_reg_handoff_PROTOABBREV);
+
/* Register a sample preference */
prefs_register_bool_preference(PROTOABBREV_module, "show_hex",
"Display numbers in Hex",
"Enable to display numerical values in hexadecimal.",
&gPREF_HEX);
+
+/* Register a sample port preference */
+ prefs_register_uint_preference(PROTOABBREV_module, "tcp.port", "PROTOABBREV TCP Port",
+ " PROTOABBREV TCP port if other than the default",
+ 10, &gPORT_PREF);
}
This exact format is required because a script is used to find these
routines and create the code that calls these routines.
- This function is also called by preferences whenever "Apply" is pressed
- (see prefs_register_protocol above) so it should accommodate being called
- more than once.
+ If this function is registered as a prefs callback (see prefs_register_protocol
+ above) this function is also called by preferences whenever "Apply" is pressed;
+ In that case, it should accommodate being called more than once.
+
+ This form of the reg_handoff function is used if if you perform
+ registration functions which are dependent upon prefs. See below
+ for a simpler form which can be used if there are no
+ prefs-dependent registration functions.
*/
void
proto_reg_handoff_PROTOABBREV(void)
{
- static gboolean inited = FALSE;
-
- if (!inited) {
+ static gboolean initialized = FALSE;
+ static dissector_handle_t PROTOABBREV_handle;
+ static int currentPort;
- dissector_handle_t PROTOABBREV_handle;
+ if (!initialized) {
/* Use new_create_dissector_handle() to indicate that dissect_PROTOABBREV()
* returns the number of bytes it dissected (or 0 if it thinks the packet
* does not belong to PROTONAME).
*/
- PROTOABBREV_handle = new_create_dissector_handle(dissect_PROTOABBREV,
- proto_PROTOABBREV);
- dissector_add("PARENT_SUBFIELD", ID_VALUE, PROTOABBREV_handle);
-
- inited = TRUE;
+ PROTOABBREV_handle = new_create_dissector_handle(dissect_PROTOABBREV,
+ proto_PROTOABBREV);
+ initialized = TRUE;
+ } else {
+
+ /*
+ If you perform registration functions which are dependent upon
+ prefs the you should de-register everything which was associated
+ with the previous settings and re-register using the new prefs
+ settings here. In general this means you need to keep track of
+ the PROTOABBREV_handle and the value the preference had at the time
+ you registered. The PROTOABBREV_handle value and the value of the
+ preference can be saved using local statics in this
+ function (proto_reg_handoff).
+ */
+
+ dissector_delete_uint("tcp.port", currentPort, PROTOABBREV_handle);
}
- /*
- If you perform registration functions which are dependent upon
- prefs the you should de-register everything which was associated
- with the previous settings and re-register using the new prefs
- settings here. In general this means you need to keep track of what
- value the preference had at the time you registered using a local
- static in this function. ie.
+ currentPort = gPORT_PREF;
- static int currentPort = -1;
+ dissector_add_uint("tcp.port", currentPort, PROTOABBREV_handle);
- if (currentPort != -1) {
- dissector_delete("tcp.port", currentPort, PROTOABBREV_handle);
- }
+}
- currentPort = gPortPref;
+#if 0
+/* Simple form of proto_reg_handoff_PROTOABBREV which can be used if there are
+ no prefs-dependent registration function calls.
+ */
- dissector_add("tcp.port", currentPort, PROTOABBREV_handle);
+void
+proto_reg_handoff_PROTOABBREV(void)
+{
+ dissector_handle_t PROTOABBREV_handle;
- */
+/* Use new_create_dissector_handle() to indicate that dissect_PROTOABBREV()
+ * returns the number of bytes it dissected (or 0 if it thinks the packet
+ * does not belong to PROTONAME).
+ */
+ PROTOABBREV_handle = new_create_dissector_handle(dissect_PROTOABBREV,
+ proto_PROTOABBREV);
+ dissector_add_uint("PARENT_SUBFIELD", ID_VALUE, PROTOABBREV_handle);
}
+#endif
+
+
+/*
+ * Editor modelines - http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * vi: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */
+
------------------------------------Cut here------------------------------------
FIELDTYPE FT_NONE, FT_BOOLEAN, FT_UINT8, FT_UINT16, FT_UINT24,
FT_UINT32, FT_UINT64, FT_INT8, FT_INT16, FT_INT24, FT_INT32,
FT_INT64, FT_FLOAT, FT_DOUBLE, FT_ABSOLUTE_TIME,
- FT_RELATIVE_TIME, FT_STRING, FT_STRINGZ, FT_EBCDIC,
- FT_UINT_STRING, FT_ETHER, FT_BYTES, FT_IPv4, FT_IPv6, FT_IPXNET,
- FT_FRAMENUM, FT_PROTOCOL, FT_GUID, FT_OID
-FIELDBASE BASE_NONE, BASE_DEC, BASE_HEX, BASE_OCT, BASE_DEC_HEX,
- BASE_HEX_DEC, BASE_RANGE_STRING
+ FT_RELATIVE_TIME, FT_STRING, FT_STRINGZ, FT_EUI64,
+ FT_UINT_STRING, FT_ETHER, FT_BYTES, FT_UINT_BYTES, FT_IPv4,
+ FT_IPv6, FT_IPXNET, FT_FRAMENUM, FT_PROTOCOL, FT_GUID, FT_OID
+FIELDDISPLAY For FT_UINT{8,16,24,32,64} and FT_INT{8,16,24,32,64):
+
+ BASE_DEC, BASE_HEX, BASE_OCT, BASE_DEC_HEX, BASE_HEX_DEC,
+ or BASE_CUSTOM, possibly ORed with BASE_RANGE_STRING
+
+ For FT_ABSOLUTE_TIME:
+
+ ABSOLUTE_TIME_LOCAL, ABSOLUTE_TIME_UTC, or
+ ABSOLUTE_TIME_DOY_UTC
+
+ For FT_BOOLEAN if BITMASK is non-zero:
+
+ Number of bits in the field containing the FT_BOOLEAN
+ bitfield
+
+ For all other types:
+
+ BASE_NONE
FIELDCONVERT VALS(x), RVALS(x), TFS(x), NULL
BITMASK Usually 0x0 unless using the TFS(x) field conversion.
-FIELDDESCR A brief description of the field, or NULL.
+FIELDDESCR A brief description of the field, or NULL. [Please do not use ""].
PARENT_SUBFIELD Lower level protocol field used for lookup, i.e. "tcp.port"
ID_VALUE Lower level protocol field value that identifies this protocol
For example the TCP or UDP port number
The accessors are:
+Bit accessors for a maximum of 8-bits, 16-bits 32-bits and 64-bits:
+
+guint8 tvb_get_bits8(tvbuff_t *tvb, gint bit_offset, gint no_of_bits);
+guint16 tvb_get_bits16(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
+guint32 tvb_get_bits32(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
+guint64 tvb_get_bits64(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
+
Single-byte accessor:
guint8 tvb_get_guint8(tvbuff_t*, gint offset);
guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
+guint64 tvb_get_ntoh40(tvbuff_t*, gint offset);
+guint64 tvb_get_ntoh48(tvbuff_t*, gint offset);
+guint64 tvb_get_ntoh56(tvbuff_t*, gint offset);
guint64 tvb_get_ntoh64(tvbuff_t*, gint offset);
Network-to-host-order accessors for single-precision and
guint16 tvb_get_letohs(tvbuff_t*, gint offset);
guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
guint32 tvb_get_letohl(tvbuff_t*, gint offset);
+guint64 tvb_get_letoh40(tvbuff_t*, gint offset);
+guint64 tvb_get_letoh48(tvbuff_t*, gint offset);
+guint64 tvb_get_letoh56(tvbuff_t*, gint offset);
guint64 tvb_get_letoh64(tvbuff_t*, gint offset);
Little-Endian-to-host-order accessors for single-precision and
String accessors:
guint8 *tvb_get_string(tvbuff_t*, gint offset, gint length);
+gchar *tvb_get_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
guint8 *tvb_get_ephemeral_string(tvbuff_t*, gint offset, gint length);
+gchar *tvb_get_ephemeral_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
+guint8 *tvb_get_seasonal_string(tvbuff_t*, gint offset, gint length);
Returns a null-terminated buffer containing data from the specified
tvbuff, starting at the specified offset, and containing the specified
tvb_get_string() returns a buffer allocated by g_malloc() so you must
g_free() it when you are finished with the string. Failure to g_free() this
buffer will lead to memory leaks.
+
+tvb_get_unicode_string() is a unicode (UTF-16) version of above. This
+is intended for reading UTF-16 unicode strings out of a tvbuff and
+returning them as a UTF-8 string for use in Wireshark. The offset and
+returned length pointer are in bytes, not UTF-16 characters.
+
tvb_get_ephemeral_string() returns a buffer allocated from a special heap
with a lifetime until the next packet is dissected. You do not need to
free() this buffer, it will happen automatically once the next packet is
dissected.
+tvb_get_ephemeral_unicode_string() is a unicode (UTF-16) version of above.
+This is intended for reading UTF-16 unicode strings out of a tvbuff and
+returning them as a UTF-8 string for use in Wireshark. The offset and
+returned length pointer are in bytes, not UTF-16 characters.
+
+tvb_get_seasonal_string() returns a buffer allocated from a special heap
+with a lifetime of the current capture session. You do not need to
+free() this buffer, it will happen automatically once the a new capture or
+file is opened.
guint8 *tvb_get_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
+const guint8 *tvb_get_const stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
guint8 *tvb_get_ephemeral_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
+gchar *tvb_get_ephemeral_unicode_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp, const guint encoding);
+guint8 *tvb_get_seasonal_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
-Returns a null-terminated buffer, allocated with "g_malloc()",
-containing data from the specified tvbuff, starting at the
-specified offset, and containing all characters from the tvbuff up to
-and including a terminating null character in the tvbuff. "*lengthp"
-will be set to the length of the string, including the terminating null.
+Returns a null-terminated buffer containing data from the specified tvbuff,
+starting at the specified offset, and containing all characters from the
+tvbuff up to and including a terminating null character in the tvbuff.
+"*lengthp" will be set to the length of the string, including the terminating
+null.
tvb_get_stringz() returns a buffer allocated by g_malloc() so you must
g_free() it when you are finished with the string. Failure to g_free() this
buffer will lead to memory leaks.
+
+tvb_get_const_stringz() returns a pointer to the (const) string in the tvbuff.
+You do not need to free() this buffer, it will happen automatically once the
+next packet is dissected. This function is slightly more efficient than the
+others because it does not allocate memory and copy the string.
+
tvb_get_ephemeral_stringz() returns a buffer allocated from a special heap
with a lifetime until the next packet is dissected. You do not need to
free() this buffer, it will happen automatically once the next packet is
dissected.
+tvb_get_ephemeral_unicode_stringz() is a unicode (UTF-16) version of
+above. This is intended for reading UTF-16 unicode strings out of a tvbuff
+and returning them as a UTF-8 string for use in Wireshark. The offset and
+returned length pointer are in bytes, not UTF-16 characters.
-guint8 *tvb_fake_unicode(tvbuff_t*, gint offset, gint length);
-guint8 *tvb_get_ephemeral_faked_unicode(tvbuff_t*, gint offset, gint length);
+tvb_get_seasonal_stringz() returns a buffer allocated from a special heap
+with a lifetime of the current capture session. You do not need to
+free() this buffer, it will happen automatically once the a new capture or
+file is opened.
-Converts a 2-byte unicode string to an ASCII string.
-Returns a null-terminated buffer containing data from the specified
-tvbuff, starting at the specified offset, and containing the specified
-length worth of characters (the length of the buffer will be length+1,
-as it includes a null character to terminate the string).
+tvb_fake_unicode() has been superseded by tvb_get_unicode_string(), which
+properly handles Unicode (UTF-16) strings by converting them to UTF-8.
-tvb_fake_unicode() returns a buffer allocated by g_malloc() so you must
-g_free() it when you are finished with the string. Failure to g_free() this
-buffer will lead to memory leaks.
-tvb_get_ephemeral_faked_unicode() returns a buffer allocated from a special
-heap with a lifetime until the next packet is dissected. You do not need to
-free() this buffer, it will happen automatically once the next packet is
-dissected.
+tvb_get_ephemeral_faked_unicode() has been superseded by
+tvb_get_ephemeral_string(), which properly handles Unicode (UTF-16) strings by
+converting them to UTF-8.
+
+Byte Array Accessors:
+
+gchar *tvb_bytes_to_str(tvbuff_t *tvb, gint offset, gint len);
+
+Formats a bunch of data from a tvbuff as bytes, returning a pointer
+to the string with the data formatted as two hex digits for each byte.
+The string pointed to is stored in an "ep_alloc'd" buffer which will be freed
+before the next frame is dissected. The formatted string will contain the hex digits
+for at most the first 16 bytes of the data. If len is greater than 16 bytes, a
+trailing "..." will be added to the string.
+
+gchar *tvb_bytes_to_str_punct(tvbuff_t *tvb, gint offset, gint len, gchar punct);
+This function is similar to tvb_bytes_to_str(...) except that 'punct' is inserted
+between the hex representation of each byte.
+
+gchar *tvb_bcd_dig_to_ep_str(tvbuff_t *tvb, const gint offset, const gint len, dgt_set_t *dgt, gboolean skip_first);
+
+Given a tvbuff, an offset into the tvbuff, and a length that starts
+at that offset (which may be -1 for "all the way to the end of the
+tvbuff"), fetch BCD encoded digits from a tvbuff starting from either
+the low or high half byte, formating the digits according to an input digit set,
+if NUll a default digit set of 0-9 returning "?" for overdecadic digits will be used.
+A pointer to the EP allocated string will be returned.
+Note: a tvbuff content of 0xf is considered a 'filler' and will end the conversion.
Copying memory:
guint8* tvb_memcpy(tvbuff_t*, guint8* target, gint offset, gint length);
COL_ value for the "Info" field, giving a summary of the contents of the
packet for that protocol, is COL_INFO.
-A value for a column should only be added if the user specified that it
-be displayed; to check whether a given column is to be displayed, call
-'check_col' with the COL_ value for that field as an argument - it will
-return TRUE if the column is to be displayed and FALSE if it is not to
-be displayed.
-
The value for a column can be specified with one of several functions,
all of which take the 'fd' argument to the dissector as their first
argument, and the COL_ value for the column as their second argument.
For example, to set the "Protocol" column
to "PROTOABBREV":
- if (check_col(pinfo->cinfo, COL_PROTOCOL))
- col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
+ col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
1.5.2 The col_add_str function.
string containing the type of the request in the packet and "n" is an
unsigned integer containing the number of bytes in the request:
- if (check_col(pinfo->cinfo, COL_INFO))
- col_add_fstr(pinfo->cinfo, COL_INFO, "%s request, %u bytes",
- reqtype, n);
+ col_add_fstr(pinfo->cinfo, COL_INFO, "%s request, %u bytes",
+ reqtype, n);
Don't use 'col_add_fstr' with a format argument of just "%s" -
'col_add_str', or possibly even 'col_set_str' if the string that matches
after it has called any subdissectors for that chunk so that subdissectors
of any subsequent chunks may only append to the Info column.
'col_prepend_fence_fstr' prepends data before a fence (moving it if
-necessary). It will create a fence at the end of the prended data if the
+necessary). It will create a fence at the end of the prepended data if the
fence does not already exist.
For example:
-if (check_col(pinfo->cinfo, COL_REL_CONV_TIME)) {
- nstime_delta(&ts, &pinfo->fd->abs_ts, &tcpd->ts_first);
- col_set_time(pinfo->cinfo, COL_REL_CONV_TIME, &ts, "tcp.time_relative");
-}
+ nstime_delta(&ts, &pinfo->fd->abs_ts, &tcpd->ts_first);
+ col_set_time(pinfo->cinfo, COL_REL_CONV_TIME, &ts, "tcp.time_relative");
1.6 Constructing the protocol tree.
be called at startup:
the file containing a dissector's "register" routine must be
- added to "DISSECTOR_SRC" in "epan/dissectors/Makefile.common";
+ added to "DISSECTOR_SRC" in "epan/dissectors/Makefile.common"
+ (and in "epan/CMakeLists.txt");
the "register" routine must have a name of the form
"proto_register_XXX";
Here is how the frame "protocol" is registered.
- int proto_frame;
+ int proto_frame;
proto_frame = proto_register_protocol (
/* name */ "Frame",
subtree below it containing fields for
the members of the array, might be an
FT_NONE field.
- FT_PROTOCOL Used for protocols which will be placing
+ FT_PROTOCOL Used for protocols which will be placing
themselves as top-level items in the
- "Packet Details" pane of the UI.
+ "Packet Details" pane of the UI.
FT_BOOLEAN 0 means "false", any other value means
"true".
FT_FRAMENUM A frame number; if this is used, the "Go
FT_INT64 A 64-bit signed integer.
FT_FLOAT A single-precision floating point number.
FT_DOUBLE A double-precision floating point number.
- FT_ABSOLUTE_TIME Seconds (4 bytes) and nanoseconds (4 bytes)
- of time displayed as month name, month day,
- year, hours, minutes, and seconds with 9
- digits after the decimal point.
+ FT_ABSOLUTE_TIME An absolute time from some fixed point in time,
+ displayed as the date, followed by the time, as
+ hours, minutes, and seconds with 9 digits after
+ the decimal point.
FT_RELATIVE_TIME Seconds (4 bytes) and nanoseconds (4 bytes)
- of time displayed as seconds and 9 digits
+ of time relative to an arbitrary time.
+ displayed as seconds and 9 digits
after the decimal point.
FT_STRING A string of characters, not necessarily
NUL-terminated, but possibly NUL-padded.
types, are to be used for text strings,
not raw binary data.
FT_STRINGZ A NUL-terminated string of characters.
- FT_EBCDIC A string of characters, not necessarily
- NUL-terminated, but possibly NUL-padded.
- The data from the packet is converted from
- EBCDIC to ASCII before displaying to the user.
+ The string length is normally the length
+ given in the proto_tree_add_item() call.
+ However if the length given in the call
+ is -1, then the length used is that
+ returned by calling tvb_strsize().
FT_UINT_STRING A counted string of characters, consisting
- of a count (represented as an integral
- value) followed immediately by the
- specified number of characters.
+ of a count (represented as an integral value,
+ of width given in the proto_tree_add_item()
+ call) followed immediately by that number of
+ characters.
FT_ETHER A six octet string displayed in
Ethernet-address format.
FT_BYTES A string of bytes with arbitrary values;
used for raw binary data.
+ FT_UINT_BYTES A counted string of bytes, consisting
+ of a count (represented as an integral value,
+ of width given in the proto_tree_add_item()
+ call) followed immediately by that number of
+ arbitrary values; used for raw binary data.
FT_IPv4 A version 4 IP address (4 bytes) displayed
in dotted-quad IP address format (4
decimal numbers separated by dots).
address.
FT_GUID A Globally Unique Identifier
FT_OID An ASN.1 Object Identifier
+ FT_EUI64 A EUI-64 Address
Some of these field types are still not handled in the display filter
routines, but the most common ones are. The FT_UINT* variables all
signed integers; the number on the end represent how many bits are used
to represent the number.
+Some constraints are imposed on the header fields depending on the type
+(e.g. FT_BYTES) of the field. Fields of type FT_ABSOLUTE_TIME must use
+'ABSOLUTE_TIME_{LOCAL,UTC,DOY_UTC}, NULL, 0x0' as values for the
+'display, 'strings', and 'bitmask' fields, and all other non-integral
+types (i.e.. types that are _not_ FT_INT* and FT_UINT*) must use
+'BASE_NONE, NULL, 0x0' as values for the 'display', 'strings', 'bitmask'
+fields. The reason is simply that the type itself implictly defines the
+nature of 'display', 'strings', 'bitmask'.
+
display
-------
The display field has a couple of overloaded uses. This is unfortunate,
BASE_HEX,
BASE_OCT,
BASE_DEC_HEX,
- BASE_HEX_DEC
+ BASE_HEX_DEC,
+ BASE_CUSTOM
BASE_DEC, BASE_HEX, and BASE_OCT are decimal, hexadecimal, and octal,
respectively. BASE_DEC_HEX and BASE_HEX_DEC display value in two bases
(the 1st representation followed by the 2nd in parenthesis).
-For FT_BOOLEAN fields that are also bitfields, 'display' is used to tell
-the proto_tree how wide the parent bitfield is. With integers this is
-not needed since the type of integer itself (FT_UINT8, FT_UINT16,
-FT_UINT24, FT_UINT32, etc.) tells the proto_tree how wide the parent
-bitfield is.
+BASE_CUSTOM allows one to specify a callback function pointer that will
+format the value. The function pointer of the same type as defined by
+custom_fmt_func_t in epan/proto.h, specifically:
+
+ void func(gchar *, guint32);
+
+The first argument is a pointer to a buffer of the ITEM_LABEL_LENGTH size
+and the second argument is the value to be formatted.
+
+For FT_BOOLEAN fields that are also bitfields (i.e. 'bitmask' is non-zero),
+'display' is used to tell the proto_tree how wide the parent bitfield is.
+With integers this is not needed since the type of integer itself
+(FT_UINT8, FT_UINT16, FT_UINT24, FT_UINT32, etc.) tells the proto_tree how
+wide the parent bitfield is.
+
+For FT_ABSOLUTE_TIME fields, 'display' is used to indicate whether the
+time is to be displayed as a time in the time zone for the machine on
+which Wireshark/TShark is running or as UTC and, for UTC, whether the
+date should be displayed as "{monthname}, {month} {day_of_month},
+{year}" or as "{year/day_of_year}".
-Additionally, BASE_NONE is used for 'display' as a NULL-value. That is,
-for non-integers and non-bitfield FT_BOOLEANs, you'll want to use BASE_NONE
-in the 'display' field. You may not use BASE_NONE for integers.
+Additionally, BASE_NONE is used for 'display' as a NULL-value. That is, for
+non-integers other than FT_ABSOLUTE_TIME fields, and non-bitfield
+FT_BOOLEANs, you'll want to use BASE_NONE in the 'display' field. You may
+not use BASE_NONE for integers.
It is possible that in the future we will record the endianness of
integers. If so, it is likely that we'll use a bitmask on the display field
so that integers would be represented as BEND|BASE_DEC or LEND|BASE_HEX.
-But that has not happened yet.
+But that has not happened yet; note that there are protocols for which
+no endianness is specified, such as the X11 protocol and the DCE RPC
+protocol, so it would not be possible to record the endianness of all
+integral fields.
strings
-------
+-- value_string
Some integer fields, of type FT_UINT*, need labels to represent the true
value of a field. You could think of those fields as having an
enumerated data type, rather than an integral data type.
If the field has a numeric rather than an enumerated type, the 'strings'
field would be set to NULL.
+-- Extended value strings
+You can also use an extended version of the value_string for faster lookups.
+It requires a value_string as input.
+If all of a contiguous range of values from min to max are present in the array
+the value will be used as as a direct index into a value_string array.
+
+If the values in the array are not contiguous (ie: there are "gaps"), but are
+in assending order a binary search will be used.
+
+Note: "gaps" in a value_string array can be filled with "empty" entries eg:
+{value, "Unknown"} so that direct access to the array is is possible.
+
+The init macro (see below) will perform a check on the value string the first
+time it is used to determine which search algorithm fits and fall back to a
+linear search if the value_string does not meet the criteria above.
+
+Use this macro to initialise the extended value_string at comile time:
+
+static value_string_ext valstringname_ext = VALUE_STRING_EXT_INIT(valstringname);
+
+Extended value strings can be created at runtime by calling
+ value_string_ext_new(<ptr to value_string array>,
+ <total number of entries in the value_string_array>, /* include {0, NULL} entry */
+ <value_string_name>);
+
+For hf[] array FT_(U)INT* fields that need a 'valstringname_ext' struct, the
+'strings' field would be set to '&valstringname_ext)'. Furthermore, 'display'
+field must be ORed with 'BASE_EXT_STRING' (e.g. BASE_DEC|BASE_EXT_STRING).
+
+
+-- Ranges
If the field has a numeric type that might logically fit in ranges of values
one can use a range_string struct.
would be set to 'RVALS(rvalstringname)'. Furthermore, 'display' field must be
ORed with 'BASE_RANGE_STRING' (e.g. BASE_DEC|BASE_RANGE_STRING).
+-- Booleans
FT_BOOLEANs have a default map of 0 = "False", 1 (or anything else) = "True".
Sometimes it is useful to change the labels for boolean values (e.g.,
to "Yes"/"No", "Fast"/"Slow", etc.). For these mappings, a struct called
leave only the bits needed to make the field when ANDed with a value.
The proto_tree routines will calculate 'bitshift' automatically
from 'bitmask', by finding the rightmost set bit in the bitmask.
-This shift is applied before applying string mapping functions or
+This shift is applied before applying string mapping functions or
filtering.
If the field is not a bitfield, then bitmask should be set to 0.
-----
This is a string giving a proper description of the field. It should be
at least one grammatically complete sentence, or NULL in which case the
-name field is used.
+name field is used. (Please do not use "").
It is meant to provide a more detailed description of the field than the
name alone provides. This information will be used in the man page, and
in a future GUI display-filter creation tool. We might also add tooltips
in your "register" routine, just as you register the protocol and the
fields for that protocol.
+The ett_ variables identify particular type of subtree so that if you expand
+one of them, Wireshark keeps track of that and, when you click on
+another packet, it automatically opens all subtrees of that type.
+If you close one of them, all subtrees of that type will be closed when
+you move to another packet.
+
There are several functions that the programmer can use to add either
protocol or field labels to the proto_tree:
proto_item*
- proto_tree_add_item(tree, id, tvb, start, length, little_endian);
-
- proto_item*
- proto_tree_add_item_hidden(tree, id, tvb, start, length, little_endian);
+ proto_tree_add_item(tree, id, tvb, start, length, encoding);
proto_item*
proto_tree_add_none_format(tree, id, tvb, start, length, format, ...);
proto_item*
proto_tree_add_protocol_format(tree, id, tvb, start, length,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_bytes(tree, id, tvb, start, length, start_ptr);
- proto_item *
- proto_tree_add_bytes_hidden(tree, id, tvb, start, length, start_ptr);
-
proto_item *
proto_tree_add_bytes_format(tree, id, tvb, start, length, start_ptr,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_bytes_format_value(tree, id, tvb, start, length,
- start_ptr, format, ...);
+ start_ptr, format, ...);
proto_item *
proto_tree_add_time(tree, id, tvb, start, length, value_ptr);
- proto_item *
- proto_tree_add_time_hidden(tree, id, tvb, start, length, value_ptr);
-
proto_item *
proto_tree_add_time_format(tree, id, tvb, start, length, value_ptr,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_time_format_value(tree, id, tvb, start, length,
- value_ptr, format, ...);
+ value_ptr, format, ...);
proto_item *
proto_tree_add_ipxnet(tree, id, tvb, start, length, value);
- proto_item *
- proto_tree_add_ipxnet_hidden(tree, id, tvb, start, length, value);
-
proto_item *
proto_tree_add_ipxnet_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_ipxnet_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_ipv4(tree, id, tvb, start, length, value);
- proto_item *
- proto_tree_add_ipv4_hidden(tree, id, tvb, start, length, value);
-
proto_item *
proto_tree_add_ipv4_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_ipv4_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_ipv6(tree, id, tvb, start, length, value_ptr);
- proto_item *
- proto_tree_add_ipv6_hidden(tree, id, tvb, start, length, value_ptr);
-
proto_item *
proto_tree_add_ipv6_format(tree, id, tvb, start, length, value_ptr,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_ipv6_format_value(tree, id, tvb, start, length,
- value_ptr, format, ...);
+ value_ptr, format, ...);
proto_item *
proto_tree_add_ether(tree, id, tvb, start, length, value_ptr);
- proto_item *
- proto_tree_add_ether_hidden(tree, id, tvb, start, length, value_ptr);
-
proto_item *
proto_tree_add_ether_format(tree, id, tvb, start, length, value_ptr,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_ether_format_value(tree, id, tvb, start, length,
- value_ptr, format, ...);
+ value_ptr, format, ...);
proto_item *
proto_tree_add_string(tree, id, tvb, start, length, value_ptr);
- proto_item *
- proto_tree_add_string_hidden(tree, id, tvb, start, length, value_ptr);
-
proto_item *
proto_tree_add_string_format(tree, id, tvb, start, length, value_ptr,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_string_format_value(tree, id, tvb, start, length,
- value_ptr, format, ...);
+ value_ptr, format, ...);
proto_item *
proto_tree_add_boolean(tree, id, tvb, start, length, value);
- proto_item *
- proto_tree_add_boolean_hidden(tree, id, tvb, start, length, value);
-
proto_item *
proto_tree_add_boolean_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_boolean_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_float(tree, id, tvb, start, length, value);
- proto_item *
- proto_tree_add_float_hidden(tree, id, tvb, start, length, value);
-
proto_item *
proto_tree_add_float_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_float_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_double(tree, id, tvb, start, length, value);
- proto_item *
- proto_tree_add_double_hidden(tree, id, tvb, start, length, value);
-
proto_item *
proto_tree_add_double_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_double_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_uint(tree, id, tvb, start, length, value);
- proto_item *
- proto_tree_add_uint_hidden(tree, id, tvb, start, length, value);
-
proto_item *
proto_tree_add_uint_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_uint_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_uint64(tree, id, tvb, start, length, value);
proto_item *
proto_tree_add_uint64_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_uint64_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_int(tree, id, tvb, start, length, value);
- proto_item *
- proto_tree_add_int_hidden(tree, id, tvb, start, length, value);
-
proto_item *
proto_tree_add_int_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_int_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item *
proto_tree_add_int64(tree, id, tvb, start, length, value);
proto_item *
proto_tree_add_int64_format(tree, id, tvb, start, length, value,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_int64_format_value(tree, id, tvb, start, length,
- value, format, ...);
+ value, format, ...);
proto_item*
proto_tree_add_text(tree, tvb, start, length, format, ...);
proto_item *
proto_tree_add_guid(tree, id, tvb, start, length, value_ptr);
- proto_item *
- proto_tree_add_guid_hidden(tree, id, tvb, start, length, value_ptr);
-
proto_item *
proto_tree_add_guid_format(tree, id, tvb, start, length, value_ptr,
- format, ...);
+ format, ...);
proto_item *
proto_tree_add_guid_format_value(tree, id, tvb, start, length,
- value_ptr, format, ...);
+ value_ptr, format, ...);
proto_item *
proto_tree_add_oid(tree, id, tvb, start, length, value_ptr);
proto_item *
- proto_tree_add_oid_hidden(tree, id, tvb, start, length, value_ptr);
+ proto_tree_add_oid_format(tree, id, tvb, start, length, value_ptr,
+ format, ...);
proto_item *
- proto_tree_add_oid_format(tree, id, tvb, start, length, value_ptr,
- format, ...);
+ proto_tree_add_eui64(tree, id, tvb, start, length, value);
+
+ proto_item *
+ proto_tree_add_eui64_format(tree, id, tvb, start, length, value,
+ format, ...);
+
+ proto_item *
+ proto_tree_add_eui64_format_value(tree, id, tvb, start, length,
+ value, format, ...);
proto_item *
proto_tree_add_oid_format_value(tree, id, tvb, start, length,
- value_ptr, format, ...);
+ value_ptr, format, ...);
+
+ proto_item*
+ proto_tree_add_bits_item(tree, id, tvb, bit_offset, no_of_bits,
+ little_endian);
+
+ proto_item *
+ proto_tree_add_bits_ret_val(tree, id, tvb, bit_offset, no_of_bits,
+ return_value, little_endian);
+
+ proto_item *
+ proto_tree_add_bitmask(tree, tvb, start, header, ett, fields,
+ little_endian);
proto_item *
- proto_tree_add_bitmask(tree, tvb, start, header, ett, **fields,
- little_endian);
+ proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
+ ett, fields, little_endian, flags);
The 'tree' argument is the tree to which the item is to be added. The
'tvb' argument is the tvbuff from which the item's value is being
extracted; the 'start' argument is the offset from the beginning of that
tvbuff of the item being added, and the 'length' argument is the length,
-in bytes, of the item.
+in bytes, of the item, bit_offset is the offset in bits and no_of_bits
+is the length in bits.
The length of some items cannot be determined until the item has been
dissected; to add such an item, add it with a length of -1, and, when the
The item added to the GUI tree will contain the name (as passed in the
proto_register_*() function) and a value. The value will be fetched
from the tvbuff by proto_tree_add_item(), based on the type of the field
-and, for integral and Boolean fields, the byte order of the value; the
-byte order is specified by the 'little_endian' argument, which is TRUE
-if the value is little-endian and FALSE if it is big-endian.
+and the encoding of the value as specified by the "encoding" argument.
+
+For FT_NONE, FT_BYTES, FT_ETHER, FT_IPv6, FT_IPXNET, FT_OID fields,
+and 'protocol' fields the encoding is not relevant; the 'encoding'
+argument should be ENC_NA (Not Applicable).
+
+For integral, floating-point, Boolean, FT_GUID, and FT_EUI64 fields,
+the encoding specifies the byte order of the value; the 'encoding'
+argument should be is ENC_LITTLE_ENDIAN if the value is little-endian
+and ENC_BIG_ENDIAN if it is big-endian.
+
+For FT_IPv4 fields, the encoding also specifies the byte order of the
+value. In almost all cases, the encoding is in network byte order,
+hence big-endian, but in at least one protocol dissected by Wireshark,
+at least one IPv4 address is byte-swapped, so it's in little-endian
+order.
+
+For string fields, the encoding specifies the character set used for the
+string and the way individual code points in that character set are
+encoded. For FT_UINT_STRING fields, the byte order of the count must be
+specified; when support for UTF-16 encoding is added, the byte order of
+the encoding will also have to be specified. In other cases, ENC_NA
+should be used. The character encodings that are currently
+supported are:
+
+ ENC_UTF_8 - UTF-8
+ ENC_ASCII - ASCII (currently treated as UTF-8; in the future,
+ all bytes with the 8th bit set will be treated as
+ errors)
+ ENC_EBCDIC - EBCDIC
+
+Other encodings will be added in the future.
+
+For FT_ABSOLUTE_TIME fields, the encoding specifies the form in which
+the time stamp is specified, as well as its byte order. The time stamp
+encodings that are curretly supported are:
+
+ ENC_TIME_TIMESPEC - seconds (4 bytes) and nanoseconds (4 bytes)
+ of time since January 1, 1970, midnight UTC.
+
+ ENC_TIME_NTP - an NTP timestamp, represented as a 64-bit
+ unsigned fixed-point number, in seconds relative to 0h
+ on 1 January 1900. The integer part is in the first 32
+ bits and the fraction part in the last 32 bits.
+
+For other types, there is no support for proto_tree_add_item().
Now that definitions of fields have detailed information about bitfield
fields, you can use proto_tree_add_item() with no extra processing to
The code to add the FID to the tree would be;
- proto_tree_add_item(bf_tree, hf_sna_th_fid, tvb, offset, 1, TRUE);
+ proto_tree_add_item(bf_tree, hf_sna_th_fid, tvb, offset, 1,
+ ENC_BIG_ENDIAN);
The definition of the field already has the information about bitmasking
and bitshifting, so it does the work of masking and shifting for us!
{ 0x3, "Subarea Node or SNA host <--> Subarea Node" },
{ 0x4, "?" },
{ 0x5, "?" },
- { 0xf, "Adjaced Subarea Nodes" },
+ { 0xf, "Adjacent Subarea Nodes" },
{ 0, NULL }
};
the high nibble of the byte ("sna.th.fid == 0xf0") as was necessary
in the past.
-proto_tree_add_item_hidden()
-----------------------------
-proto_tree_add_item_hidden is used to add fields and values to a tree,
-but not show them on a GUI tree.
-
-NOTE that creating hidden fields is actually quite a bad idea from a UI design
-perspective because the user (someone who did not write nor has ever seen the
-code) has no way of knowing that hidden fields are there to be filtered on
-thus defeating the whole purpose of putting them there. A Better Way might
-be to add the fields (that might otherwise be hidden) to a subtree where they
-won't be seen unless the user opens the subtree--but they can be found if the
-user wants.
-
-NOTE, too, that all of the proto_tree_add_*_hidden() APIs are deprecated:
-instead of using them, add the item using proto_tree_add_item() and then
-make it hidden using PROTO_ITEM_SET_HIDDEN().
-
-One use for hidden fields (which would be better implemented using visible
-fields in a subtree) follows: The caller may want a value to be
-included in a tree so that the packet can be filtered on this field, but
-the representation of that field in the tree is not appropriate. An
-example is the token-ring routing information field (RIF). The best way
-to show the RIF in a GUI is by a sequence of ring and bridge numbers.
-Rings are 3-digit hex numbers, and bridges are single hex digits:
-
- RIF: 001-A-013-9-C0F-B-555
-
-In the case of RIF, the programmer should use a field with no value and
-use proto_tree_add_none_format() to build the above representation. The
-programmer can then add the ring and bridge values, one-by-one, with
-proto_tree_add_item_hidden() so that the user can then filter on or
-search for a particular ring or bridge. Here's a skeleton of how the
-programmer might code this.
-
- char *rif;
- rif = create_rif_string(...);
-
- proto_tree_add_none_format(tree, hf_tr_rif_label, ..., "RIF: %s", rif);
-
- for(i = 0; i < num_rings; i++) {
- proto_tree_add_item_hidden(tree, hf_tr_rif_ring, ..., FALSE);
- }
- for(i = 0; i < num_rings - 1; i++) {
- proto_tree_add_item_hidden(tree, hf_tr_rif_bridge, ..., FALSE);
- }
-
-The logical tree has these items:
-
- hf_tr_rif_label, text="RIF: 001-A-013-9-C0F-B-555", value = NONE
- hf_tr_rif_ring, hidden, value=0x001
- hf_tr_rif_bridge, hidden, value=0xA
- hf_tr_rif_ring, hidden, value=0x013
- hf_tr_rif_bridge, hidden, value=0x9
- hf_tr_rif_ring, hidden, value=0xC0F
- hf_tr_rif_bridge, hidden, value=0xB
- hf_tr_rif_ring, hidden, value=0x555
-
-GUI or print code will not display the hidden fields, but a display
-filter or "packet grep" routine will still see the values. The possible
-filter is then possible:
-
- tr.rif_ring eq 0x013
-
proto_tree_add_protocol_format()
--------------------------------
proto_tree_add_protocol_format is used to add the top-level item for the
proto_tree_add_int64()
proto_tree_add_guid()
proto_tree_add_oid()
+proto_tree_add_eui64()
------------------------
These routines are used to add items to the protocol tree if either:
For proto_tree_add_bytes(), the 'value_ptr' argument is a pointer to a
sequence of bytes.
+For proto_tree_add_bytes_format() and proto_tree_add_bytes_format_value(), the
+'value_ptr' argument is a pointer to a sequence of bytes or NULL if the bytes
+should be taken from the given TVB using the given offset and length.
+
For proto_tree_add_time(), the 'value_ptr' argument is a pointer to an
"nstime_t", which is a structure containing the time to be added; it has
'secs' and 'nsecs' members, giving the integral part and the fractional
For proto_tree_add_oid(), the 'value_ptr' argument is a pointer to an
ASN.1 Object Identifier.
-proto_tree_add_bytes_hidden()
-proto_tree_add_time_hidden()
-proto_tree_add_ipxnet_hidden()
-proto_tree_add_ipv4_hidden()
-proto_tree_add_ipv6_hidden()
-proto_tree_add_ether_hidden()
-proto_tree_add_string_hidden()
-proto_tree_add_boolean_hidden()
-proto_tree_add_float_hidden()
-proto_tree_add_double_hidden()
-proto_tree_add_uint_hidden()
-proto_tree_add_int_hidden()
-proto_tree_add_guid_hidden()
-proto_tree_add_oid_hidden()
-----------------------------
-These routines add fields and values to a tree, but don't show them in the GUI
-tree. They are used for the same reason that proto_tree_add_item_hidden() is
-used (and they should not be used for the same reasons).
+For proto_tree_add_eui64(), the 'value' argument is a 64-bit integer
+value
proto_tree_add_bytes_format()
proto_tree_add_time_format()
proto_tree_add_int64_format()
proto_tree_add_guid_format()
proto_tree_add_oid_format()
+proto_tree_add_eui64_format()
----------------------------
These routines are used to add items to the protocol tree when the
dissector routine wants complete control over how the field and value
proto_tree_add_int64_format_value()
proto_tree_add_guid_format_value()
proto_tree_add_oid_format_value()
+proto_tree_add_eui64_format_value()
------------------------------------
These routines are used to add items to the protocol tree when the
variable-length list of arguments to add a text item to the protocol
tree.
-proto_tree_add_bitmask()
-------------------------
+proto_tree_add_bits_item()
+--------------------------
+Adds a number of bits to the protocol tree which does not have to be byte
+aligned. The offset and length is in bits.
+Output format:
+
+..10 1010 10.. .... "value" (formatted as FT_ indicates).
+
+proto_tree_add_bits_ret_val()
+-----------------------------
+Works in the same way but also returns the value of the read bits.
+
+proto_tree_add_bitmask() and proto_tree_add_bitmask_text()
+----------------------------------------------------------
This function provides an easy to use and convenient helper function
to manage many types of common bitmasks that occur in protocols.
'header' and 'ett' are the hf fields and ett field respectively to create an
expansion that covers the 1-4 bytes of the bitmask.
-'**fields' is a NULL terminated a array of pointers to hf fields representing
+'fields' is a NULL terminated array of pointers to hf fields representing
the individual subfields of the bitmask. These fields must either be integers
of the same byte width as 'header' or of the type FT_BOOLEAN.
-Each of the entries in '**fields' will be dissected as an item under the
+Each of the entries in 'fields' will be dissected as an item under the
'header' expansion and also IF the field is a boolean and IF it is set to 1,
then the name of that boolean field will be printed on the 'header' expansion
line. For integer type subfields that have a value_string defined, the
-matched string from that value_string will be printed on the expansion line as well.
+matched string from that value_string will be printed on the expansion line
+as well.
-Example: (from the scsi dissector)
+Example: (from the SCSI dissector)
static int hf_scsi_inq_peripheral = -1;
static int hf_scsi_inq_qualifier = -1;
+ static int hf_scsi_inq_devtype = -1;
+ ...
static gint ett_scsi_inq_peripheral = -1;
...
static const int *peripheal_fields[] = {
};
...
/* Qualifier and DeviceType */
- proto_tree_add_bitmask(tree, tvb, offset, hf_scsi_inq_peripheral, ett_scsi_inq_peripheral, peripheal_fields, FALSE);
+ proto_tree_add_bitmask(tree, tvb, offset, hf_scsi_inq_peripheral,
+ ett_scsi_inq_peripheral, peripheal_fields, FALSE);
offset+=1;
...
{ &hf_scsi_inq_peripheral,
{ &hf_scsi_inq_qualifier,
{"Qualifier", "scsi.inquiry.qualifier", FT_UINT8, BASE_HEX,
VALS (scsi_qualifier_val), 0xE0, NULL, HFILL}},
+ { &hf_scsi_inq_devtype,
+ {"Device Type", "scsi.inquiry.devtype", FT_UINT8, BASE_HEX,
+ VALS (scsi_devtype_val), SCSI_DEV_BITS, NULL, HFILL}},
...
Which provides very pretty dissection of this one byte bitmask.
+ Peripheral: 0x05, Qualifier: Device type is connected to logical unit, Device Type: CD-ROM
+ 000. .... = Qualifier: Device type is connected to logical unit (0x00)
+ ...0 0101 = Device Type: CD-ROM (0x05)
+
+The proto_tree_add_bitmask_text() function is an extended version of
+the proto_tree_add_bitmask() function. In addition, it allows to:
+- Provide a leading text (e.g. "Flags: ") that will appear before
+ the comma-separated list of field values
+- Provide a fallback text (e.g. "None") that will be appended if
+ no fields warranted a change to the top-level title.
+- Using flags, specify which fields will affect the top-level title.
+
+There are the following flags defined:
+
+ BMT_NO_APPEND - the title is taken "as-is" from the 'name' argument.
+ BMT_NO_INT - only boolean flags are added to the title.
+ BMT_NO_FALSE - boolean flags are only added to the title if they are set.
+ BMT_NO_TFS - only add flag name to the title, do not use true_false_string
+
+The proto_tree_add_bitmask() behavior can be obtained by providing
+both 'name' and 'fallback' arguments as NULL, and a flags of
+(BMT_NO_FALSE|BMT_NO_TFS).
+
+PROTO_ITEM_SET_GENERATED()
+--------------------------
+PROTO_ITEM_SET_GENERATED is used to mark fields as not being read from the
+captured data directly, but inferred from one or more values.
+
+One of the primary uses of this is the presentation of verification of
+checksums. Every IP packet has a checksum line, which can present the result
+of the checksum verification, if enabled in the preferences. The result is
+presented as a subtree, where the result is enclosed in square brackets
+indicating a generated field.
+
+ Header checksum: 0x3d42 [correct]
+ [Good: True]
+ [Bad: False]
+
+PROTO_ITEM_SET_HIDDEN()
+-----------------------
+PROTO_ITEM_SET_HIDDEN is used to hide fields, which have already been added
+to the tree, from being visible in the displayed tree.
+
+NOTE that creating hidden fields is actually quite a bad idea from a UI design
+perspective because the user (someone who did not write nor has ever seen the
+code) has no way of knowing that hidden fields are there to be filtered on
+thus defeating the whole purpose of putting them there. A Better Way might
+be to add the fields (that might otherwise be hidden) to a subtree where they
+won't be seen unless the user opens the subtree--but they can be found if the
+user wants.
+
+One use for hidden fields (which would be better implemented using visible
+fields in a subtree) follows: The caller may want a value to be
+included in a tree so that the packet can be filtered on this field, but
+the representation of that field in the tree is not appropriate. An
+example is the token-ring routing information field (RIF). The best way
+to show the RIF in a GUI is by a sequence of ring and bridge numbers.
+Rings are 3-digit hex numbers, and bridges are single hex digits:
+
+ RIF: 001-A-013-9-C0F-B-555
+
+In the case of RIF, the programmer should use a field with no value and
+use proto_tree_add_none_format() to build the above representation. The
+programmer can then add the ring and bridge values, one-by-one, with
+proto_tree_add_item() and hide them with PROTO_ITEM_SET_HIDDEN() so that the
+user can then filter on or search for a particular ring or bridge. Here's a
+skeleton of how the programmer might code this.
+
+ char *rif;
+ rif = create_rif_string(...);
+
+ proto_tree_add_none_format(tree, hf_tr_rif_label, ..., "RIF: %s", rif);
+
+ for(i = 0; i < num_rings; i++) {
+ proto_item *pi;
+
+ pi = proto_tree_add_item(tree, hf_tr_rif_ring, ...,
+ ENC_BIG_ENDIAN);
+ PROTO_ITEM_SET_HIDDEN(pi);
+ }
+ for(i = 0; i < num_rings - 1; i++) {
+ proto_item *pi;
+
+ pi = proto_tree_add_item(tree, hf_tr_rif_bridge, ...,
+ ENC_BIG_ENDIAN);
+ PROTO_ITEM_SET_HIDDEN(pi);
+ }
+
+The logical tree has these items:
+
+ hf_tr_rif_label, text="RIF: 001-A-013-9-C0F-B-555", value = NONE
+ hf_tr_rif_ring, hidden, value=0x001
+ hf_tr_rif_bridge, hidden, value=0xA
+ hf_tr_rif_ring, hidden, value=0x013
+ hf_tr_rif_bridge, hidden, value=0x9
+ hf_tr_rif_ring, hidden, value=0xC0F
+ hf_tr_rif_bridge, hidden, value=0xB
+ hf_tr_rif_ring, hidden, value=0x555
+
+GUI or print code will not display the hidden fields, but a display
+filter or "packet grep" routine will still see the values. The possible
+filter is then possible:
+
+ tr.rif_ring eq 0x013
+
+PROTO_ITEM_SET_URL
+------------------
+PROTO_ITEM_SET_URL is used to mark fields as containing a URL. This can only
+be done with fields of type FT_STRING(Z). If these fields are presented they
+are underlined, as could be done in a browser. These fields are sensitive to
+clicks as well, launching the configured browser with this URL as parameter.
1.7 Utility routines.
-1.7.1 match_strval and val_to_str.
+1.7.1 match_strval, match_strval_ext, val_to_str and val_to_str_ext.
A dissector may need to convert a value to a string, using a
'value_string' structure, by hand, rather than by declaring a field with
col_add_fstr(COL_INFO, ", %s", val_to_str(val, table, "Unknown %d"));
+The match_strval_ext and val_to_str_ext functions are "extended" versions
+of match_strval and val_to_str. They should be used for large value-string
+arrays which contain many entries. They implement value to string conversions
+which will do either a direct access or a binary search of the
+value string array if possible. See "Extended Value Strings" under
+section 1.6 "Constructing the protocol tree" for more information.
+
+See epan/value_string.h for detailed information on the various value_string
+functions.
+
+
1.7.2 match_strrval and rval_to_str.
A dissector may need to convert a range of values to a string, using a
dissector_next( next_tvb, pinfo, tree);
-1.9 Editing Makefile.common to add your dissector.
+1.9 Editing Makefile.common and CMakeLists.txt to add your dissector.
To arrange that your dissector will be built as part of Wireshark, you
must add the name of the source file for your dissector to the
tarballs are built (otherwise, the source in the release tarballs won't
compile).
+In addition to the above, you should add your dissector source file name
+to the DISSECTOR_SRC section of epan/CMakeLists.txt
+
+
1.10 Using the SVN source code tree.
See <http://www.wireshark.org/develop.html>
+
+1.10a Using git with the SVN source code tree.
+
+ Install git and the git-svn package.
+ Run "mkdir git; cd git; git svn clone <svn-url>", e.g. if you are using
+ the anonymous svn tree, run
+ "git svn clone http://anonsvn.wireshark.org/wireshark/trunk/"
+
+ After that, a typical workflow may look like this (from "man git-svn"):
+
+ # Clone a repo (like git clone):
+ git svn clone http://svn.example.com/project/trunk
+ # Enter the newly cloned directory:
+ cd trunk
+ # You should be on master branch, double-check with ´git branch´
+ git branch
+ # Do some work and commit locally to git:
+ git commit ...
+ # Something is committed to SVN, rebase your local changes against the
+ # latest changes in SVN:
+ git svn rebase
+ # Now commit your changes (that were committed previously using git) to SVN
+ # as well as automatically updating your working HEAD:
+ git svn dcommit
+ # Append svn:ignore settings to the default git exclude file:
+ git svn show-ignore >> .git/info/exclude
+
+
1.11 Submitting code for your new dissector.
- VERIFY that your dissector code does not use prohibited or deprecated APIs
- Create a Wiki page on the protocol at <http://wiki.wireshark.org>.
A template is provided so it is easy to setup in a consistent style.
+ See: <http://wiki.wireshark.org/HowToEdit>
+ and <http://wiki.wireshark.org/ProtocolReference>
- If possible, add sample capture files to the sample captures page at
<http://wiki.wireshark.org/SampleCaptures>. These files are used by
the packet. The same conversation will be returned for a packet bound from
ServerA:1000 to ClientA:2000 and the packet from ClientA:2000 to ServerA:1000.
-There are five routines that you will use to work with a conversation:
+2.2.1 Conversation Routines
+
+There are six routines that you will use to work with a conversation:
conversation_new, find_conversation, conversation_add_proto_data,
-conversation_get_proto_data, and conversation_delete_proto_data.
+conversation_get_proto_data, conversation_delete_proto_data,
+and conversation_set_dissector.
-2.2.1 The conversation_init function.
+2.2.1.1 The conversation_init function.
This is an internal routine for the conversation code. As such you
will not have to call this routine. Just be aware that this routine is
called at the start of each capture and before the packets are filtered
with a display filter. The routine will destroy all stored
conversations. This routine does NOT clean up any data pointers that are
-passed in the conversation_new 'data' variable. You are responsible for
-this clean up if you pass a malloc'ed pointer in this variable.
+passed in the conversation_add_proto_data 'data' variable. You are
+responsible for this clean up if you pass a malloc'ed pointer
+in this variable.
-See item 2.2.8 for more information about the 'data' pointer.
+See item 2.2.1.5 for more information about use of the 'data' pointer.
-2.2.2 The conversation_new function.
+2.2.1.2 The conversation_new function.
This routine will create a new conversation based upon two address/port
pairs. If you want to associate with the conversation a pointer to a
created using certain addresses and ports, in the case where the packet
doesn't specify the addresses and ports of both sides.
-2.2.3 The find_conversation function.
+2.2.1.3 The find_conversation function.
Call this routine to look up a conversation. If no conversation is found,
the routine will return a NULL value.
matching any "wildcarded" port.
-2.2.4 The conversation_add_proto_data function.
+2.2.1.4 The find_or_create_conversation function.
+
+This convenience function will create find an existing conversation (by calling
+find_conversation()) and, if a conversation does not already exist, create a
+new conversation by calling conversation_new().
+
+The find_or_create_conversation prototype:
+
+ extern conversation_t *find_or_create_conversation(packet_info *pinfo);
+
+Where:
+ packet_info *pinfo = the packet_info structure
+
+The frame number and the addresses necessary for find_conversation() and
+conversation_new() are taken from the pinfo structure (as is commonly done)
+and no 'options' are used.
+
+
+2.2.1.5 The conversation_add_proto_data function.
Once you have created a conversation with conversation_new, you can
associate data with it using this function.
The conversation_add_proto_data prototype:
void conversation_add_proto_data(conversation_t *conv, int proto,
- void *proto_data);
+ void *proto_data);
Where:
conversation_t *conv = the conversation in question
unique protocol number created with proto_register_protocol. Protocols
are typically registered in the proto_register_XXXX section of your
dissector. "data" is a pointer to the data you wish to associate with the
-conversation. Using the protocol number allows several dissectors to
+conversation. "data" usually points to "se_alloc'd" memory; the
+memory will be automatically freed each time a new dissection begins
+and thus need not be managed (freed) by the dissector.
+Using the protocol number allows several dissectors to
associate data with a given conversation.
-2.2.5 The conversation_get_proto_data function.
+2.2.1.6 The conversation_get_proto_data function.
After you have located a conversation with find_conversation, you can use
this function to retrieve any data associated with it.
returns a pointer to the data requested, or NULL if no data was found.
-2.2.6 The conversation_delete_proto_data function.
+2.2.1.7 The conversation_delete_proto_data function.
After you are finished with a conversation, you can remove your association
with this function. Please note that ONLY the conversation entry is
-removed. If you have allocated any memory for your data, you must free it
-as well.
+removed. If you have allocated any memory for your data (other than with se_alloc),
+ you must free it as well.
The conversation_delete_proto_data prototype:
is a unique protocol number created with proto_register_protocol,
typically in the proto_register_XXXX portion of a dissector.
+2.2.1.8 The conversation_set_dissector function
+
+This function sets the protocol dissector to be invoked whenever
+conversation parameters (addresses, port_types, ports, etc) are matched
+during the dissection of a packet.
+
+The conversation_set_dissector prototype:
+
+ void conversation_set_dissector(conversation_t *conversation, const dissector_handle_t handle);
+
+Where:
+ conversation_t *conv = the conversation in question
+ const dissector_handle_t handle = the dissector handle.
+
-2.2.7 Using timestamps relative to the conversation
+2.2.2 Using timestamps relative to the conversation
There is a framework to calculate timestamps relative to the start of the
conversation. First of all the timestamp of the first packet that has been
The ts_prev value should only be set during the first run through the
packets (ie pinfo->fd->flags.visited is false).
-Next step is to use the per packet information (described in section 2.5)
+Next step is to use the per-packet information (described in section 2.5)
to keep the calculated delta timestamp, as it can only be calculated
on the first run through the packets. This is because a packet can be
selected in random order once the whole file has been read.
the values of lowel level conversations in these two columns. Being
able to actively select which protocols may overwrite the conversation
timestamp columns gives the user the power to control these columns.
-(A second reason is that conversation timestamps use the per packet
+(A second reason is that conversation timestamps use the per-packet
data structure which uses additional memory, which should be avoided
if these timestamps are not needed)
the tcp-dissector.
-2.2.8 The example conversation code with GMemChunk's.
+2.2.3 The example conversation code using se_alloc'd memory.
For a conversation between two IP addresses and ports you can use this as an
-example. This example uses the GMemChunk to allocate memory and stores the data
+example. This example uses se_alloc() to allocate memory and stores the data
pointer in the conversation 'data' variable.
-NOTE: Remember to register the init routine (my_dissector_init) in the
-protocol_register routine.
-
-
/************************ Global values ************************/
-/* the number of entries in the memory chunk array */
-#define my_init_count 10
-
/* define your structure here */
typedef struct {
} my_entry_t;
-/* the GMemChunk base structure */
-static GMemChunk *my_vals = NULL;
-
/* Registered protocol number */
static int my_proto = -1;
-
/********************* in the dissector routine *********************/
/* the local variables in the dissector */
/* new conversation create local data structure */
- data_ptr = g_mem_chunk_alloc(my_vals);
+ data_ptr = se_alloc(sizeof(my_entry_t));
/*** add your code here to setup the new data structure ***/
/* at this point the conversation data is ready */
-
-/******************* in the dissector init routine *******************/
-
-#define my_init_count 20
-
-static void
-my_dissector_init(void)
-{
-
- /* destroy memory chunks if needed */
-
- if (my_vals)
- g_mem_chunk_destroy(my_vals);
-
- /* now create memory chunks */
-
- my_vals = g_mem_chunk_new("my_proto_vals",
- sizeof(my_entry_t),
- my_init_count * sizeof(my_entry_t),
- G_ALLOC_AND_FREE);
-}
-
/***************** in the protocol register routine *****************/
-/* register re-init routine */
-
-register_init_routine(&my_dissector_init);
-
my_proto = proto_register_protocol("My Protocol", "My Protocol", "my_proto");
-2.2.9 An example conversation code that starts at a specific frame number.
+2.2.4 An example conversation code that starts at a specific frame number.
Sometimes a dissector has determined that a new conversation is needed that
starts at a specific frame number, when a capture session encompasses multiple
}
-2.2.10 The example conversation code using conversation index field.
+2.2.5 The example conversation code using conversation index field.
Sometimes the conversation isn't enough to define a unique data storage
value for the network traffic. For example if you are storing information
/* then used the conversation index, and request data to find data */
/* in the local hash table */
- conversation = find_conversation(pinfo->fd->num, &pinfo->src, &pinfo->dst,
- pinfo->ptype, pinfo->srcport, pinfo->destport, 0);
- if (conversation == NULL) {
- /* It's not part of any conversation - create a new one. */
- conversation = conversation_new(pinfo->fd->num, &pinfo->src,
- &pinfo->dst, pinfo->ptype, pinfo->srcport, pinfo->destport,
- NULL, 0);
- }
+ conversation = find_or_create_conversation(pinfo);
request_key.conversation = conversation->index;
request_key.service = pntohs(&rxh->serviceId);
opcode = 0;
if (!request_val && !reply)
{
- new_request_key = g_mem_chunk_alloc(afs_request_keys);
+ new_request_key = se_alloc(sizeof(struct afs_request_key));
*new_request_key = request_key;
- request_val = g_mem_chunk_alloc(afs_request_vals);
+ request_val = se_alloc(sizeof(struct afs_request_val));
request_val -> opcode = pntohl(&afsh->opcode);
opcode = request_val->opcode;
*/
conversation = find_conversation(pinfo->fd->num,
&pinfo->src, &pinfo->dst, protocol,
- src_port, dst_port, new_conv_info, 0);
+ src_port, dst_port, 0);
/* If there is no such conversation, or if there is one but for
someone else's protocol then we just create a new conversation
*/
if ( (conversation == NULL) ||
(conversation->dissector_handle != sub_dissector_handle) ) {
- new_conv_info = g_mem_chunk_alloc(new_conv_vals);
+ new_conv_info = se_alloc(sizeof(struct _new_conv_info));
new_conv_info->data1 = value1;
/* create the conversation for the dynamic port */
/* if conversation has a data field, create it and load structure */
- new_conv_info = g_mem_chunk_alloc(new_conv_vals);
+ new_conv_info = se_alloc(sizeof(struct _new_conv_info));
new_conv_info->data1 = value1;
/* create the conversation for the dynamic server address and port */
conversation_set_dissector(conversation, sub_dissector_handle);
}
-2.5 Per packet information.
+2.5 Per-packet information.
Information can be stored for each data packet that is processed by the
dissector. The information is added with the p_add_proto_data function and
Where:
fd - The fd pointer in the pinfo structure, pinfo->fd
proto - Protocol id returned by the proto_register_protocol call
- during initialization
+ during initialization
proto_data - pointer to the dissector data.
You must register the module with the preferences routine with -
-module_t *prefs_register_protocol(proto_id, void (*apply_cb)(void))
+ module_t *prefs_register_protocol(proto_id, void (*apply_cb)(void))
+ or
+ module_t *prefs_register_protocol_subtree(const char *subtree, int id,
+ void (*apply_cb)(void));
-Where: proto_id - the value returned by "proto_register_protocol()" when
- the protocol was registered
- apply_cb - Callback routine that is call when preferences are applied
+Where: proto_id - the value returned by "proto_register_protocol()" when
+ the protocol was registered.
+ apply_cb - Callback routine that is called when preferences are
+ applied. It may be NULL, which inhibits the callback.
+ subtree - grouping preferences tree node name (several protocols can
+ be grouped under one preferences subtree)
Then you can register the fields that can be configured by the user with these
routines -
"." between them, to construct a name that identifies
the field in the preference file; the name itself
should not include the protocol name, as the name in
- the preference file will already have it
+ the preference file will already have it. Make sure that
+ only lower-case ASCII letters, numbers, underscores and
+ dots appear in the preference name.
title - Field title in the preferences dialog
description - Comments added to the preference file above the
- preference value
+ preference value and shown as tooltip in the GUI, or NULL
var - pointer to the storage location that is updated when the
- field is changed in the preference dialog box
+ field is changed in the preference dialog box. Note that
+ with string preferences the given pointer is overwritten
+ with a pointer to a new copy of the string during the
+ preference registration. The passed-in string may be
+ freed, but you must keep another pointer to the string
+ in order to free it.
base - Base that the unsigned integer is expected to be in,
see strtoul(3).
enumvals - an array of enum_val_t structures. This must be
mdns_udp_handle = create_dissector_handle(dissect_mdns_udp,
proto_dns);
- dissector_add("udp.port", UDP_PORT_DNS, dns_udp_handle);
- dissector_add("tcp.port", TCP_PORT_DNS, dns_tcp_handle);
- dissector_add("udp.port", UDP_PORT_MDNS, mdns_udp_handle);
- dissector_add("tcp.port", TCP_PORT_MDNS, dns_tcp_handle);
+ dissector_add_uint("udp.port", UDP_PORT_DNS, dns_udp_handle);
+ dissector_add_uint("tcp.port", TCP_PORT_DNS, dns_tcp_handle);
+ dissector_add_uint("udp.port", UDP_PORT_MDNS, mdns_udp_handle);
+ dissector_add_uint("tcp.port", TCP_PORT_MDNS, dns_tcp_handle);
The dissect_dns_udp function does very little work and calls
dissect_dns_common, while dissect_dns_tcp calls tcp_dissect_pdus with a
static hf_register_info hf[] = {
{&hf_cstring,
{"C String", "c.string", FT_STRING, BASE_NONE, NULL, 0x0,
- "C String", HFILL}
+ NULL, HFILL}
}
};
/**
-* Dissect a buffer containing C strings.
+* Dissect a buffer containing ASCII C strings.
*
* @param tvb The buffer to dissect.
* @param pinfo Packet Info.
return;
}
- if (check_col(pinfo->cinfo, COL_INFO)) {
- col_set_str(pinfo->cinfo, COL_INFO, "C String");
- }
+ col_set_str(pinfo->cinfo, COL_INFO, "C String");
len += 1; /* Add one for the '\0' */
if (tree) {
- proto_tree_add_item(tree, hf_cstring, tvb, offset, len, FALSE);
+ proto_tree_add_item(tree, hf_cstring, tvb, offset, len,
+ ENC_ASCII|ENC_NA);
}
offset += (guint)len;
}
ptvcursor API.
proto_item*
-ptvcursor_add(ptvcursor_t* ptvc, int hf, gint length, gboolean endianness)
+ptvcursor_add(ptvcursor_t* ptvc, int hf, gint length, const guint encoding)
This will extract 'length' bytes from the tvbuff and place it in
the proto_tree as field 'hf', which is a registered header_field. The
pointer to the proto_item that is created is passed back to you. Internally,
the ptvcursor advances its cursor so the next call to ptvcursor_add
-starts where this call finished. The 'endianness' parameter matters for
-FT_UINT* and FT_INT* fields.
+starts where this call finished. The 'encoding' parameter is relevant for
+certain type of fields (See above under proto_tree_add_item()).
proto_item*
-ptvcursor_add_no_advance(ptvcursor_t* ptvc, int hf, gint length, gboolean endianness)
+ptvcursor_add_no_advance(ptvcursor_t* ptvc, int hf, gint length, const guint encoding)
Like ptvcursor_add, but does not advance the internal cursor.
void
proto_tree*
ptvcursor_add_with_subtree(ptvcursor_t* ptvc, int hfindex, gint length,
- gboolean little_endian, gint ett_subtree);
+ const guint encoding, gint ett_subtree);
Adds an item to the tree and creates a subtree.
If the length is unknown, length may be defined as SUBTREE_UNDEFINED_LENGTH.
In this case, at the next pop, the item length will be equal to the advancement
ptvcursor_set_subtree(ptvcursor_t* ptvc, proto_item* it, gint ett_subtree);
Creates a subtree and adds it to the cursor as the working tree but does
not save the old working tree.
+
git.samba.org / obnox / wireshark / wip.git / blobdiff