Add tvb_ip_to_str and tvb_ip6_to_str to the Dev Guide
[obnox/wireshark/wip.git] / doc / README.developer
1 $Revision$
2 $Date$
3 $Author$
4 Tabsize: 4
5
6 This file is a HOWTO for Wireshark developers. It describes how to start coding
7 a Wireshark protocol dissector and the use of some of the important functions
8 and variables.
9
10 This file is compiled to give in depth information on Wireshark.
11 It is by no means all inclusive and complete. Please feel free to send
12 remarks and patches to the developer mailing list.
13
14 0. Prerequisites.
15
16 Before starting to develop a new dissector, a "running" Wireshark build
17 environment is required - there's no such thing as a standalone "dissector
18 build toolkit".
19
20 How to setup such an environment is platform dependent; detailed information
21 about these steps can be found in the "Developer's Guide" (available from:
22 http://www.wireshark.org) and in the INSTALL and README files of the sources
23 root dir.
24
25 0.1. General README files.
26
27 You'll find additional information in the following README files:
28
29 - README.capture        - the capture engine internals
30 - README.design         - Wireshark software design - incomplete
31 - README.developer      - this file
32 - README.display_filter - Display Filter Engine
33 - README.idl2wrs        - CORBA IDL converter
34 - README.packaging      - how to distribute a software package containing WS
35 - README.regression     - regression testing of WS and TS
36 - README.stats_tree     - a tree statistics counting specific packets
37 - README.tapping        - "tap" a dissector to get protocol specific events
38 - README.xml-output     - how to work with the PDML exported output
39 - wiretap/README.developer - how to add additional capture file types to
40   Wiretap
41
42 0.2. Dissector related README files.
43
44 You'll find additional dissector related information in the following README
45 files:
46
47 - README.binarytrees    - fast access to large data collections
48 - README.heuristic      - what are heuristic dissectors and how to write them
49 - README.malloc         - how to obtain "memory leak free" memory
50 - README.plugins        - how to "pluginize" a dissector
51 - README.python         - writing a dissector in PYTHON.
52 - README.request_response_tracking - how to track req./resp. times and such
53
54 0.3 Contributors
55
56 James Coe <jammer[AT]cin.net>
57 Gilbert Ramirez <gram[AT]alumni.rice.edu>
58 Jeff Foster <jfoste[AT]woodward.com>
59 Olivier Abad <oabad[AT]cybercable.fr>
60 Laurent Deniel <laurent.deniel[AT]free.fr>
61 Gerald Combs <gerald[AT]wireshark.org>
62 Guy Harris <guy[AT]alum.mit.edu>
63 Ulf Lamping <ulf.lamping[AT]web.de>
64
65 1. Setting up your protocol dissector code.
66
67 This section provides skeleton code for a protocol dissector. It also explains
68 the basic functions needed to enter values in the traffic summary columns,
69 add to the protocol tree, and work with registered header fields.
70
71 1.1 Code style.
72
73 1.1.1 Portability.
74
75 Wireshark runs on many platforms, and can be compiled with a number of
76 different compilers; here are some rules for writing code that will work
77 on multiple platforms.
78
79 Don't use C++-style comments (comments beginning with "//" and running
80 to the end of the line); Wireshark's dissectors are written in C, and
81 thus run through C rather than C++ compilers, and not all C compilers
82 support C++-style comments (GCC does, but IBM's C compiler for AIX, for
83 example, doesn't do so by default).
84
85 In general, don't use C99 features since some C compilers used to compile
86 Wireshark don't support C99 (E.G. Microsoft C).
87
88 Don't initialize variables in their declaration with non-constant
89 values. Not all compilers support this. E.g. don't use
90         guint32 i = somearray[2];
91 use
92         guint32 i;
93         i = somearray[2];
94 instead.
95
96 Don't use zero-length arrays; not all compilers support them.  If an
97 array would have no members, just leave it out.
98
99 Don't declare variables in the middle of executable code; not all C
100 compilers support that.  Variables should be declared outside a
101 function, or at the beginning of a function or compound statement.
102
103 Don't use anonymous unions; not all compilers support them.
104 Example:
105
106         typedef struct foo {
107           guint32 foo;
108           union {
109             guint32 foo_l;
110             guint16 foo_s;
111           } u;  /* have a name here */
112         } foo_t;
113
114 Don't use "uchar", "u_char", "ushort", "u_short", "uint", "u_int",
115 "ulong", "u_long" or "boolean"; they aren't defined on all platforms.
116 If you want an 8-bit unsigned quantity, use "guint8"; if you want an
117 8-bit character value with the 8th bit not interpreted as a sign bit,
118 use "guchar"; if you want a 16-bit unsigned quantity, use "guint16";
119 if you want a 32-bit unsigned quantity, use "guint32"; and if you want
120 an "int-sized" unsigned quantity, use "guint"; if you want a boolean,
121 use "gboolean".  Use "%d", "%u", "%x", and "%o" to print those types;
122 don't use "%ld", "%lu", "%lx", or "%lo", as longs are 64 bits long on
123 many platforms, but "guint32" is 32 bits long.
124
125 Don't use "long" to mean "signed 32-bit integer", and don't use
126 "unsigned long" to mean "unsigned 32-bit integer"; "long"s are 64 bits
127 long on many platforms.  Use "gint32" for signed 32-bit integers and use
128 "guint32" for unsigned 32-bit integers.
129
130 Don't use "long" to mean "signed 64-bit integer" and don't use "unsigned
131 long" to mean "unsigned 64-bit integer"; "long"s are 32 bits long on
132 many other platforms.  Don't use "long long" or "unsigned long long",
133 either, as not all platforms support them; use "gint64" or "guint64",
134 which will be defined as the appropriate types for 64-bit signed and
135 unsigned integers.
136
137 On LLP64 data model systems (notably 64-bit Windows), "int" and "long"
138 are 32 bits while "size_t" and "ptrdiff_t" are 64 bits. This means that
139 the following will generate a compiler warning:
140
141         int i;
142         i = strlen("hello, sailor");  /* Compiler warning */
143
144 Normally, you'd just make "i" a size_t. However, many GLib and Wireshark
145 functions won't accept a size_t on LLP64:
146
147         size_t i;
148         char greeting[] = "hello, sailor";
149         guint byte_after_greet;
150
151         i = strlen(greeting);
152         byte_after_greet = tvb_get_guint8(tvb, i); /* Compiler warning */
153
154 Try to use the appropriate data type when you can. When you can't, you
155 will have to cast to a compatible data type, e.g.
156
157         size_t i;
158         char greeting[] = "hello, sailor";
159         guint byte_after_greet;
160
161         i = strlen(greeting);
162         byte_after_greet = tvb_get_guint8(tvb, (gint) i); /* OK */
163
164 or
165
166         gint i;
167         char greeting[] = "hello, sailor";
168         guint byte_after_greet;
169
170         i = (gint) strlen(greeting);
171         byte_after_greet = tvb_get_guint8(tvb, i); /* OK */
172
173 See http://www.unix.org/version2/whatsnew/lp64_wp.html for more
174 information on the sizes of common types in different data models.
175
176 When printing or displaying the values of 64-bit integral data types,
177 don't use "%lld", "%llu", "%llx", or "%llo" - not all platforms
178 support "%ll" for printing 64-bit integral data types.  Instead, for
179 GLib routines, and routines that use them, such as all the routines in
180 Wireshark that take format arguments, use G_GINT64_MODIFIER, for example:
181
182     proto_tree_add_text(tree, tvb, offset, 8,
183                         "Sequence Number: %" G_GINT64_MODIFIER "u",
184                         sequence_number);
185
186 When specifying an integral constant that doesn't fit in 32 bits, don't
187 use "LL" at the end of the constant - not all compilers use "LL" for
188 that.  Instead, put the constant in a call to the "G_GINT64_CONSTANT()"
189 macro, e.g.
190
191         G_GINT64_CONSTANT(11644473600U)
192
193 rather than
194
195         11644473600ULL
196
197 Don't assume that you can scan through a va_list initialized by va_start
198 more than once without closing it with va_end and re-initializing it with
199 va_start.  This applies even if you're not scanning through it yourself,
200 but are calling a routine that scans through it, such as vfprintf() or
201 one of the routines in Wireshark that takes a format and a va_list as an
202 argument.  You must do
203
204         va_start(ap, format);
205         call_routine1(xxx, format, ap);
206         va_end(ap);
207         va_start(ap, format);
208         call_routine2(xxx, format, ap);
209         va_end(ap);
210
211 rather
212         va_start(ap, format);
213         call_routine1(xxx, format, ap);
214         call_routine2(xxx, format, ap);
215         va_end(ap);
216
217 Don't use a label without a statement following it.  For example,
218 something such as
219
220         if (...) {
221
222                 ...
223
224         done:
225         }
226
227 will not work with all compilers - you have to do
228
229         if (...) {
230
231                 ...
232
233         done:
234                 ;
235         }
236
237 with some statement, even if it's a null statement, after the label.
238
239 Don't use "bzero()", "bcopy()", or "bcmp()"; instead, use the ANSI C
240 routines
241
242         "memset()" (with zero as the second argument, so that it sets
243         all the bytes to zero);
244
245         "memcpy()" or "memmove()" (note that the first and second
246         arguments to "memcpy()" are in the reverse order to the
247         arguments to "bcopy()"; note also that "bcopy()" is typically
248         guaranteed to work on overlapping memory regions, while
249         "memcpy()" isn't, so if you may be copying from one region to a
250         region that overlaps it, use "memmove()", not "memcpy()" - but
251         "memcpy()" might be faster as a result of not guaranteeing
252         correct operation on overlapping memory regions);
253
254         and "memcmp()" (note that "memcmp()" returns 0, 1, or -1, doing
255         an ordered comparison, rather than just returning 0 for "equal"
256         and 1 for "not equal", as "bcmp()" does).
257
258 Not all platforms necessarily have "bzero()"/"bcopy()"/"bcmp()", and
259 those that do might not declare them in the header file on which they're
260 declared on your platform.
261
262 Don't use "index()" or "rindex()"; instead, use the ANSI C equivalents,
263 "strchr()" and "strrchr()".  Not all platforms necessarily have
264 "index()" or "rindex()", and those that do might not declare them in the
265 header file on which they're declared on your platform.
266
267 Don't fetch data from packets by getting a pointer to data in the packet
268 with "tvb_get_ptr()", casting that pointer to a pointer to a structure,
269 and dereferencing that pointer.  That pointer won't necessarily be aligned
270 on the proper boundary, which can cause crashes on some platforms (even
271 if it doesn't crash on an x86-based PC); furthermore, the data in a
272 packet is not necessarily in the byte order of the machine on which
273 Wireshark is running.  Use the tvbuff routines to extract individual
274 items from the packet, or use "proto_tree_add_item()" and let it extract
275 the items for you.
276
277 Don't use structures that overlay packet data, or into which you copy
278 packet data; the C programming language does not guarantee any
279 particular alignment of fields within a structure, and even the
280 extensions that try to guarantee that are compiler-specific and not
281 necessarily supported by all compilers used to build Wireshark.  Using
282 bitfields in those structures is even worse; the order of bitfields
283 is not guaranteed.
284
285 Don't use "ntohs()", "ntohl()", "htons()", or "htonl()"; the header
286 files required to define or declare them differ between platforms, and
287 you might be able to get away with not including the appropriate header
288 file on your platform but that might not work on other platforms.
289 Instead, use "g_ntohs()", "g_ntohl()", "g_htons()", and "g_htonl()";
290 those are declared by <glib.h>, and you'll need to include that anyway,
291 as Wireshark header files that all dissectors must include use stuff from
292 <glib.h>.
293
294 Don't fetch a little-endian value using "tvb_get_ntohs() or
295 "tvb_get_ntohl()" and then using "g_ntohs()", "g_htons()", "g_ntohl()",
296 or "g_htonl()" on the resulting value - the g_ routines in question
297 convert between network byte order (big-endian) and *host* byte order,
298 not *little-endian* byte order; not all machines on which Wireshark runs
299 are little-endian, even though PCs are.  Fetch those values using
300 "tvb_get_letohs()" and "tvb_get_letohl()".
301
302 Don't put a comma after the last element of an enum - some compilers may
303 either warn about it (producing extra noise) or refuse to accept it.
304
305 Don't include <unistd.h> without protecting it with
306
307         #ifdef HAVE_UNISTD_H
308
309                 ...
310
311         #endif
312
313 and, if you're including it to get routines such as "open()", "close()",
314 "read()", and "write()" declared, also include <io.h> if present:
315
316         #ifdef HAVE_IO_H
317         #include <io.h>
318         #endif
319
320 in order to declare the Windows C library routines "_open()",
321 "_close()", "_read()", and "_write()".  Your file must include <glib.h>
322 - which many of the Wireshark header files include, so you might not have
323 to include it explicitly - in order to get "open()", "close()",
324 "read()", "write()", etc. mapped to "_open()", "_close()", "_read()",
325 "_write()", etc..
326
327 Do not use "open()", "rename()", "mkdir()", "stat()", "unlink()", "remove()",
328 "fopen()", "freopen()" directly.  Instead use "ws_open()", "ws_rename()",
329 "ws_mkdir()", "ws_stat()", "ws_unlink()", "ws_remove()", "ws_fopen()",
330 "ws_freopen()": these wrapper functions change the path and file name from
331 UTF8 to UTF16 on Windows allowing the functions to work correctly when the
332 path or file name contain non-ASCII characters.
333
334 When opening a file with "ws_fopen()", "ws_freopen()", or "ws_fdopen()", if
335 the file contains ASCII text, use "r", "w", "a", and so on as the open mode
336 - but if it contains binary data, use "rb", "wb", and so on.  On
337 Windows, if a file is opened in a text mode, writing a byte with the
338 value of octal 12 (newline) to the file causes two bytes, one with the
339 value octal 15 (carriage return) and one with the value octal 12, to be
340 written to the file, and causes bytes with the value octal 15 to be
341 discarded when reading the file (to translate between C's UNIX-style
342 lines that end with newline and Windows' DEC-style lines that end with
343 carriage return/line feed).
344
345 In addition, that also means that when opening or creating a binary
346 file, you must use "ws_open()" (with O_CREAT and possibly O_TRUNC if the
347 file is to be created if it doesn't exist), and OR in the O_BINARY flag.
348 That flag is not present on most, if not all, UNIX systems, so you must
349 also do
350
351         #ifndef O_BINARY
352         #define O_BINARY        0
353         #endif
354
355 to properly define it for UNIX (it's not necessary on UNIX).
356
357 Don't use forward declarations of static arrays without a specified size
358 in a fashion such as this:
359
360         static const value_string foo_vals[];
361
362                 ...
363
364         static const value_string foo_vals[] = {
365                 { 0,            "Red" },
366                 { 1,            "Green" },
367                 { 2,            "Blue" },
368                 { 0,            NULL }
369         };
370
371 as some compilers will reject the first of those statements.  Instead,
372 initialize the array at the point at which it's first declared, so that
373 the size is known.
374
375 Don't put a comma after the last tuple of an initializer of an array.
376
377 For #define names and enum member names, prefix the names with a tag so
378 as to avoid collisions with other names - this might be more of an issue
379 on Windows, as it appears to #define names such as DELETE and
380 OPTIONAL.
381
382 Don't use the "numbered argument" feature that many UNIX printf's
383 implement, e.g.:
384
385         g_snprintf(add_string, 30, " - (%1$d) (0x%1$04x)", value);
386
387 as not all UNIX printf's implement it, and Windows printf doesn't appear
388 to implement it.  Use something like
389
390         g_snprintf(add_string, 30, " - (%d) (0x%04x)", value, value);
391
392 instead.
393
394 Don't use "variadic macros", such as
395
396         #define DBG(format, args...)    fprintf(stderr, format, ## args)
397
398 as not all C compilers support them.  Use macros that take a fixed
399 number of arguments, such as
400
401         #define DBG0(format)            fprintf(stderr, format)
402         #define DBG1(format, arg1)      fprintf(stderr, format, arg1)
403         #define DBG2(format, arg1, arg2) fprintf(stderr, format, arg1, arg2)
404
405                 ...
406
407 or something such as
408
409         #define DBG(args)               printf args
410
411 Don't use
412
413         case N ... M:
414
415 as that's not supported by all compilers.
416
417 snprintf() -> g_snprintf()
418 snprintf() is not available on all platforms, so it's a good idea to use the
419 g_snprintf() function declared by <glib.h> instead.
420
421 tmpnam() -> mkstemp()
422 tmpnam is insecure and should not be used any more. Wireshark brings its
423 own mkstemp implementation for use on platforms that lack mkstemp.
424 Note: mkstemp does not accept NULL as a parameter.
425
426 The pointer returned by a call to "tvb_get_ptr()" is not guaranteed to be
427 aligned on any particular byte boundary; this means that you cannot
428 safely cast it to any data type other than a pointer to "char",
429 "unsigned char", "guint8", or other one-byte data types.  You cannot,
430 for example, safely cast it to a pointer to a structure, and then access
431 the structure members directly; on some systems, unaligned accesses to
432 integral data types larger than 1 byte, and floating-point data types,
433 cause a trap, which will, at best, result in the OS slowly performing an
434 unaligned access for you, and will, on at least some platforms, cause
435 the program to be terminated.
436
437 Wireshark supports platforms with GLib 2.14[.x]/GTK+ 2.12[.x] or newer.
438 If a Glib/GTK+ mechanism is available only in Glib/GTK+ versions newer
439 than 2.14/2.12 then use "#if GLIB_CHECK_VERSION(...)" or "#if
440 GTK_CHECK_VERSION(...)" to conditionally compile code using that
441 mechanism.
442
443 When different code must be used on UN*X and Win32, use a #if or #ifdef
444 that tests _WIN32, not WIN32.  Try to write code portably whenever
445 possible, however; note that there are some routines in Wireshark with
446 platform-dependent implementations and platform-independent APIs, such
447 as the routines in epan/filesystem.c, allowing the code that calls it to
448 be written portably without #ifdefs.
449
450 1.1.2 String handling
451
452 Do not use functions such as strcat() or strcpy().
453 A lot of work has been done to remove the existing calls to these functions and
454 we do not want any new callers of these functions.
455
456 Instead use g_snprintf() since that function will if used correctly prevent
457 buffer overflows for large strings.
458
459 When using a buffer to create a string, do not use a buffer stored on the stack.
460 I.e. do not use a buffer declared as
461
462    char buffer[1024];
463
464 instead allocate a buffer dynamically using the string-specific or plain emem
465 routines (see README.malloc) such as
466
467    emem_strbuf_t *strbuf;
468    strbuf = ep_strbuf_new_label("");
469    ep_strbuf_append_printf(strbuf, ...
470
471 or
472
473    char *buffer=NULL;
474    ...
475    #define MAX_BUFFER 1024
476    buffer=ep_alloc(MAX_BUFFER);
477    buffer[0]='\0';
478    ...
479    g_snprintf(buffer, MAX_BUFFER, ...
480
481 This avoids the stack from being corrupted in case there is a bug in your code
482 that accidentally writes beyond the end of the buffer.
483
484
485 If you write a routine that will create and return a pointer to a filled in
486 string and if that buffer will not be further processed or appended to after
487 the routine returns (except being added to the proto tree),
488 do not preallocate the buffer to fill in and pass as a parameter instead
489 pass a pointer to a pointer to the function and return a pointer to an
490 emem allocated buffer that will be automatically freed. (see README.malloc)
491
492 I.e. do not write code such as
493   static void
494   foo_to_str(char *string, ... ){
495      <fill in string>
496   }
497   ...
498      char buffer[1024];
499      ...
500      foo_to_str(buffer, ...
501      proto_tree_add_text(... buffer ...
502
503 instead write the code as
504   static void
505   foo_to_str(char **buffer, ...
506     #define MAX_BUFFER x
507     *buffer=ep_alloc(MAX_BUFFER);
508     <fill in *buffer>
509   }
510   ...
511     char *buffer;
512     ...
513     foo_to_str(&buffer, ...
514     proto_tree_add_text(... *buffer ...
515
516 Use ep_ allocated buffers. They are very fast and nice. These buffers are all
517 automatically free()d when the dissection of the current packet ends so you
518 don't have to worry about free()ing them explicitly in order to not leak memory.
519 Please read README.malloc.
520
521 Don't use non-ASCII characters in source files; not all compiler
522 environments will be using the same encoding for non-ASCII characters,
523 and at least one compiler (Microsoft's Visual C) will, in environments
524 with double-byte character encodings, such as many Asian environments,
525 fail if it sees a byte sequence in a source file that doesn't correspond
526 to a valid character.  This causes source files using either an ISO
527 8859/n single-byte character encoding or UTF-8 to fail to compile.  Even
528 if the compiler doesn't fail, there is no guarantee that the compiler,
529 or a developer's text editor, will interpret the characters the way you
530 intend them to be interpreted.
531
532 1.1.3 Robustness.
533
534 Wireshark is not guaranteed to read only network traces that contain correctly-
535 formed packets. Wireshark is commonly used to track down networking
536 problems, and the problems might be due to a buggy protocol implementation
537 sending out bad packets.
538
539 Therefore, protocol dissectors not only have to be able to handle
540 correctly-formed packets without, for example, crashing or looping
541 infinitely, they also have to be able to handle *incorrectly*-formed
542 packets without crashing or looping infinitely.
543
544 Here are some suggestions for making dissectors more robust in the face
545 of incorrectly-formed packets:
546
547 Do *NOT* use "g_assert()" or "g_assert_not_reached()" in dissectors.
548 *NO* value in a packet's data should be considered "wrong" in the sense
549 that it's a problem with the dissector if found; if it cannot do
550 anything else with a particular value from a packet's data, the
551 dissector should put into the protocol tree an indication that the
552 value is invalid, and should return.  The "expert" mechanism should be
553 used for that purpose.
554
555 If there is a case where you are checking not for an invalid data item
556 in the packet, but for a bug in the dissector (for example, an
557 assumption being made at a particular point in the code about the
558 internal state of the dissector), use the DISSECTOR_ASSERT macro for
559 that purpose; this will put into the protocol tree an indication that
560 the dissector has a bug in it, and will not crash the application.
561
562 If you are allocating a chunk of memory to contain data from a packet,
563 or to contain information derived from data in a packet, and the size of
564 the chunk of memory is derived from a size field in the packet, make
565 sure all the data is present in the packet before allocating the buffer.
566 Doing so means that:
567
568         1) Wireshark won't leak that chunk of memory if an attempt to
569            fetch data not present in the packet throws an exception.
570
571 and
572
573         2) it won't crash trying to allocate an absurdly-large chunk of
574            memory if the size field has a bogus large value.
575
576 If you're fetching into such a chunk of memory a string from the buffer,
577 and the string has a specified size, you can use "tvb_get_*_string()",
578 which will check whether the entire string is present before allocating
579 a buffer for the string, and will also put a trailing '\0' at the end of
580 the buffer.
581
582 If you're fetching into such a chunk of memory a 2-byte Unicode string
583 from the buffer, and the string has a specified size, you can use
584 "tvb_get_ephemeral_faked_unicode()", which will check whether the entire
585 string is present before allocating a buffer for the string, and will also
586 put a trailing '\0' at the end of the buffer.  The resulting string will be
587 a sequence of single-byte characters; the only Unicode characters that
588 will be handled correctly are those in the ASCII range.  (Wireshark's
589 ability to handle non-ASCII strings is limited; it needs to be
590 improved.)
591
592 If you're fetching into such a chunk of memory a sequence of bytes from
593 the buffer, and the sequence has a specified size, you can use
594 "tvb_memdup()", which will check whether the entire sequence is present
595 before allocating a buffer for it.
596
597 Otherwise, you can check whether the data is present by using
598 "tvb_ensure_bytes_exist()" or by getting a pointer to the data by using
599 "tvb_get_ptr()", although note that there might be problems with using
600 the pointer from "tvb_get_ptr()" (see the item on this in the
601 Portability section above, and the next item below).
602
603 Note also that you should only fetch string data into a fixed-length
604 buffer if the code ensures that no more bytes than will fit into the
605 buffer are fetched ("the protocol ensures" isn't good enough, as
606 protocol specifications can't ensure only packets that conform to the
607 specification will be transmitted or that only packets for the protocol
608 in question will be interpreted as packets for that protocol by
609 Wireshark).  If there's no maximum length of string data to be fetched,
610 routines such as "tvb_get_*_string()" are safer, as they allocate a buffer
611 large enough to hold the string.  (Note that some variants of this call
612 require you to free the string once you're finished with it.)
613
614 If you have gotten a pointer using "tvb_get_ptr()", you must make sure
615 that you do not refer to any data past the length passed as the last
616 argument to "tvb_get_ptr()"; while the various "tvb_get" routines
617 perform bounds checking and throw an exception if you refer to data not
618 available in the tvbuff, direct references through a pointer gotten from
619 "tvb_get_ptr()" do not do any bounds checking.
620
621 If you have a loop that dissects a sequence of items, each of which has
622 a length field, with the offset in the tvbuff advanced by the length of
623 the item, then, if the length field is the total length of the item, and
624 thus can be zero, you *MUST* check for a zero-length item and abort the
625 loop if you see one.  Otherwise, a zero-length item could cause the
626 dissector to loop infinitely.  You should also check that the offset,
627 after having the length added to it, is greater than the offset before
628 the length was added to it, if the length field is greater than 24 bits
629 long, so that, if the length value is *very* large and adding it to the
630 offset causes an overflow, that overflow is detected.
631
632 If you have a
633
634         for (i = {start}; i < {end}; i++)
635
636 loop, make sure that the type of the loop index variable is large enough
637 to hold the maximum {end} value plus 1; otherwise, the loop index
638 variable can overflow before it ever reaches its maximum value.  In
639 particular, be very careful when using gint8, guint8, gint16, or guint16
640 variables as loop indices; you almost always want to use an "int"/"gint"
641 or "unsigned int"/"guint" as the loop index rather than a shorter type.
642
643 If you are fetching a length field from the buffer, corresponding to the
644 length of a portion of the packet, and subtracting from that length a
645 value corresponding to the length of, for example, a header in the
646 packet portion in question, *ALWAYS* check that the value of the length
647 field is greater than or equal to the length you're subtracting from it,
648 and report an error in the packet and stop dissecting the packet if it's
649 less than the length you're subtracting from it.  Otherwise, the
650 resulting length value will be negative, which will either cause errors
651 in the dissector or routines called by the dissector, or, if the value
652 is interpreted as an unsigned integer, will cause the value to be
653 interpreted as a very large positive value.
654
655 Any tvbuff offset that is added to as processing is done on a packet
656 should be stored in a 32-bit variable, such as an "int"; if you store it
657 in an 8-bit or 16-bit variable, you run the risk of the variable
658 overflowing.
659
660 sprintf() -> g_snprintf()
661 Prevent yourself from using the sprintf() function, as it does not test the
662 length of the given output buffer and might be writing into unintended memory
663 areas. This function is one of the main causes of security problems like buffer
664 exploits and many other bugs that are very hard to find. It's much better to
665 use the g_snprintf() function declared by <glib.h> instead.
666
667 You should test your dissector against incorrectly-formed packets.  This
668 can be done using the randpkt and editcap utilities that come with the
669 Wireshark distribution.  Testing using randpkt can be done by generating
670 output at the same layer as your protocol, and forcing Wireshark/TShark
671 to decode it as your protocol, e.g. if your protocol sits on top of UDP:
672
673     randpkt -c 50000 -t dns randpkt.pcap
674     tshark -nVr randpkt.pcap -d udp.port==53,<myproto>
675
676 Testing using editcap can be done using preexisting capture files and the
677 "-E" flag, which introduces errors in a capture file.  E.g.:
678
679     editcap -E 0.03 infile.pcap outfile.pcap
680     tshark -nVr outfile.pcap
681
682 The script fuzz-test.sh is available to help automate these tests.
683
684 1.1.4 Name convention.
685
686 Wireshark uses the underscore_convention rather than the InterCapConvention for
687 function names, so new code should probably use underscores rather than
688 intercaps for functions and variable names. This is especially important if you
689 are writing code that will be called from outside your code.  We are just
690 trying to keep things consistent for other developers.
691
692 1.1.5 White space convention.
693
694 Avoid using tab expansions different from 8 column widths, as not all
695 text editors in use by the developers support this. For a detailed
696 discussion of tabs, spaces, and indentation, see
697
698     http://www.jwz.org/doc/tabs-vs-spaces.html
699
700 When creating a new file, you are free to choose an indentation logic.
701 Most of the files in Wireshark tend to use 2-space or 4-space
702 indentation. You are encouraged to write a short comment on the
703 indentation logic at the beginning of this new file, especially if
704 you're using non-mod-8 tabs.  The tabs-vs-spaces document above provides
705 examples of Emacs and vi modelines for this purpose.
706
707 Please do not leave trailing whitespace (spaces/tabs) on lines.
708
709 When editing an existing file, try following the existing indentation
710 logic and even if it very tempting, never ever use a restyler/reindenter
711 utility on an existing file.  If you run across wildly varying
712 indentation styles within the same file, it might be helpful to send a
713 note to wireshark-dev for guidance.
714
715 1.1.6 Compiler warnings
716
717 You should write code that is free of compiler warnings. Such warnings will
718 often indicate questionable code and sometimes even real bugs, so it's best
719 to avoid warnings at all.
720
721 The compiler flags in the Makefiles are set to "treat warnings as errors",
722 so your code won't even compile when warnings occur.
723
724 1.2 Skeleton code.
725
726 Wireshark requires certain things when setting up a protocol dissector.
727 Below is skeleton code for a dissector that you can copy to a file and
728 fill in.  Your dissector should follow the naming convention of packet-
729 followed by the abbreviated name for the protocol.  It is recommended
730 that where possible you keep to the IANA abbreviated name for the
731 protocol, if there is one, or a commonly-used abbreviation for the
732 protocol, if any.
733
734 Usually, you will put your newly created dissector file into the directory
735 epan/dissectors, just like all the other packet-....c files already in there.
736
737 Also, please add your dissector file to the corresponding makefiles,
738 described in section "1.9 Editing Makefile.common and CMakeLists.txt
739 to add your dissector" below.
740
741 Dissectors that use the dissector registration to register with a lower level
742 dissector don't need to define a prototype in the .h file. For other
743 dissectors the main dissector routine should have a prototype in a header
744 file whose name is "packet-", followed by the abbreviated name for the
745 protocol, followed by ".h"; any dissector file that calls your dissector
746 should be changed to include that file.
747
748 You may not need to include all the headers listed in the skeleton
749 below, and you may need to include additional headers.
750
751 The stdio.h, stdlib.h and string.h header files should be included only as needed.
752
753
754 The "$Id$" in the comment will be updated by Subversion when the file is
755 checked in.
756
757 When creating a new file, it is fine to just write "$Id$" as Subversion will
758 automatically fill in the identifier at the time the file will be added to the
759 SVN repository (committed).
760
761 ------------------------------------Cut here------------------------------------
762 /* packet-PROTOABBREV.c
763  * Routines for PROTONAME dissection
764  * Copyright 201x, YOUR_NAME <YOUR_EMAIL_ADDRESS>
765  *
766  * $Id$
767  *
768  * Wireshark - Network traffic analyzer
769  * By Gerald Combs <gerald@wireshark.org>
770  * Copyright 1998 Gerald Combs
771  *
772  * Copied from WHATEVER_FILE_YOU_USED (where "WHATEVER_FILE_YOU_USED"
773  * is a dissector file; if you just copied this from README.developer,
774  * don't bother with the "Copied from" - you don't even need to put
775  * in a "Copied from" if you copied an existing dissector, especially
776  * if the bulk of the code in the new dissector is your code)
777  *
778  * This program is free software; you can redistribute it and/or modify
779  * it under the terms of the GNU General Public License as published by
780  * the Free Software Foundation; either version 2 of the License, or
781  * (at your option) any later version.
782  *
783  * This program is distributed in the hope that it will be useful,
784  * but WITHOUT ANY WARRANTY; without even the implied warranty of
785  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
786  * GNU General Public License for more details.
787  *
788  * You should have received a copy of the GNU General Public License along
789  * with this program; if not, write to the Free Software Foundation, Inc.,
790  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
791  */
792
793 #ifdef HAVE_CONFIG_H
794 # include "config.h"
795 #endif
796
797 #if 0
798 /* Include only as needed */
799 #include <stdio.h>
800 #include <stdlib.h>
801 #include <string.h>
802 #endif
803
804 #include <glib.h>
805
806 #include <epan/packet.h>
807 #include <epan/prefs.h>
808
809 /* IF PROTO exposes code to other dissectors, then it must be exported
810    in a header file. If not, a header file is not needed at all. */
811 #include "packet-PROTOABBREV.h"
812
813 /* Forward declaration we need below (if using proto_reg_handoff...
814    as a prefs callback)       */
815 void proto_reg_handoff_PROTOABBREV(void);
816
817 /* Initialize the protocol and registered fields */
818 static int proto_PROTOABBREV = -1;
819 static int hf_PROTOABBREV_FIELDABBREV = -1;
820
821 /* Global sample preference ("controls" display of numbers) */
822 static gboolean gPREF_HEX = FALSE;
823 /* Global sample port pref */
824 static guint gPORT_PREF = 1234;
825
826 /* Initialize the subtree pointers */
827 static gint ett_PROTOABBREV = -1;
828
829 /* Code to actually dissect the packets */
830 static int
831 dissect_PROTOABBREV(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
832 {
833
834 /* Set up structures needed to add the protocol subtree and manage it */
835         proto_item *ti;
836         proto_tree *PROTOABBREV_tree;
837
838 /*  First, if at all possible, do some heuristics to check if the packet cannot
839  *  possibly belong to your protocol.  This is especially important for
840  *  protocols directly on top of TCP or UDP where port collisions are
841  *  common place (e.g., even though your protocol uses a well known port,
842  *  someone else may set up, for example, a web server on that port which,
843  *  if someone analyzed that web server's traffic in Wireshark, would result
844  *  in Wireshark handing an HTTP packet to your dissector).  For example:
845  */
846         /* Check that there's enough data */
847         if (tvb_length(tvb) < /* your protocol's smallest packet size */)
848                 return 0;
849
850         /* Get some values from the packet header, probably using tvb_get_*() */
851         if ( /* these values are not possible in PROTONAME */ )
852                 /*  This packet does not appear to belong to PROTONAME.
853                  *  Return 0 to give another dissector a chance to dissect it.
854                  */
855                 return 0;
856
857 /* Make entries in Protocol column and Info column on summary display */
858         col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
859
860 /* This field shows up as the "Info" column in the display; you should use
861    it, if possible, to summarize what's in the packet, so that a user looking
862    at the list of packets can tell what type of packet it is. See section 1.5
863    for more information.
864
865    If you are setting the column to a constant string, use "col_set_str()",
866    as it's more efficient than the other "col_set_XXX()" calls.
867
868    If you're setting it to a string you've constructed, or will be
869    appending to the column later, use "col_add_str()".
870
871    "col_add_fstr()" can be used instead of "col_add_str()"; it takes
872    "printf()"-like arguments.  Don't use "col_add_fstr()" with a format
873    string of "%s" - just use "col_add_str()" or "col_set_str()", as it's
874    more efficient than "col_add_fstr()".
875
876    If you will be fetching any data from the packet before filling in
877    the Info column, clear that column first, in case the calls to fetch
878    data from the packet throw an exception because they're fetching data
879    past the end of the packet, so that the Info column doesn't have data
880    left over from the previous dissector; do
881
882         col_clear(pinfo->cinfo, COL_INFO);
883
884    */
885
886         col_set_str(pinfo->cinfo, COL_INFO, "XXX Request");
887
888 /* A protocol dissector may be called in 2 different ways - with, or
889    without a non-null "tree" argument.
890
891    If the proto_tree argument is null, Wireshark does not need to use
892    the protocol tree information from your dissector, and therefore is
893    passing the dissector a null "tree" argument so that it doesn't
894    need to do work necessary to build the protocol tree.
895
896    In the interest of speed, if "tree" is NULL, avoid building a
897    protocol tree and adding stuff to it, or even looking at any packet
898    data needed only if you're building the protocol tree, if possible.
899
900    Note, however, that you must fill in column information, create
901    conversations, reassemble packets, build any other persistent state
902    needed for dissection, and call subdissectors regardless of whether
903    "tree" is NULL or not.  This might be inconvenient to do without
904    doing most of the dissection work; the routines for adding items to
905    the protocol tree can be passed a null protocol tree pointer, in
906    which case they'll return a null item pointer, and
907    "proto_item_add_subtree()" returns a null tree pointer if passed a
908    null item pointer, so, if you're careful not to dereference any null
909    tree or item pointers, you can accomplish this by doing all the
910    dissection work.  This might not be as efficient as skipping that
911    work if you're not building a protocol tree, but if the code would
912    have a lot of tests whether "tree" is null if you skipped that work,
913    you might still be better off just doing all that work regardless of
914    whether "tree" is null or not.
915
916    Note also that there is no guarantee, the first time the dissector is
917    called, whether "tree" will be null or not; your dissector must work
918    correctly, building or updating whatever state information is
919    necessary, in either case. */
920         if (tree) {
921
922 /* NOTE: The offset and length values in the call to
923    "proto_tree_add_item()" define what data bytes to highlight in the hex
924    display window when the line in the protocol tree display
925    corresponding to that item is selected.
926
927    Supplying a length of -1 is the way to highlight all data from the
928    offset to the end of the packet. */
929
930 /* create display subtree for the protocol */
931                 ti = proto_tree_add_item(tree, proto_PROTOABBREV, tvb, 0, -1, ENC_NA);
932
933                 PROTOABBREV_tree = proto_item_add_subtree(ti, ett_PROTOABBREV);
934
935 /* add an item to the subtree, see section 1.6 for more information */
936                 proto_tree_add_item(PROTOABBREV_tree,
937                     hf_PROTOABBREV_FIELDABBREV, tvb, offset, len, ENC_xxx);
938
939
940 /* Continue adding tree items to process the packet here */
941
942
943         }
944
945 /* If this protocol has a sub-dissector call it here, see section 1.8 */
946
947 /* Return the amount of data this dissector was able to dissect */
948         return tvb_length(tvb);
949 }
950
951
952 /* Register the protocol with Wireshark */
953
954 /* this format is require because a script is used to build the C function
955    that calls all the protocol registration.
956 */
957
958 void
959 proto_register_PROTOABBREV(void)
960 {
961         module_t *PROTOABBREV_module;
962
963 /* Setup list of header fields  See Section 1.6.1 for details*/
964         static hf_register_info hf[] = {
965                 { &hf_PROTOABBREV_FIELDABBREV,
966                         { "FIELDNAME",           "PROTOABBREV.FIELDABBREV",
967                         FIELDTYPE, FIELDDISPLAY, FIELDCONVERT, BITMASK,
968                         "FIELDDESCR", HFILL }
969                 }
970         };
971
972 /* Setup protocol subtree array */
973         static gint *ett[] = {
974                 &ett_PROTOABBREV
975         };
976
977 /* Register the protocol name and description */
978         proto_PROTOABBREV = proto_register_protocol("PROTONAME",
979             "PROTOSHORTNAME", "PROTOABBREV");
980
981 /* Required function calls to register the header fields and subtrees used */
982         proto_register_field_array(proto_PROTOABBREV, hf, array_length(hf));
983         proto_register_subtree_array(ett, array_length(ett));
984
985 /* Register preferences module (See Section 2.6 for more on preferences) */
986 /* (Registration of a prefs callback is not required if there are no     */
987 /*  prefs-dependent registration functions (eg: a port pref).            */
988 /*  See proto_reg_handoff below.                                         */
989 /*  If a prefs callback is not needed, use NULL instead of               */
990 /*  proto_reg_handoff_PROTOABBREV in the following).                     */
991         PROTOABBREV_module = prefs_register_protocol(proto_PROTOABBREV,
992             proto_reg_handoff_PROTOABBREV);
993
994 /* Register preferences module under preferences subtree.
995    Use this function instead of prefs_register_protocol if you want to group
996    preferences of several protocols under one preferences subtree.
997    Argument subtree identifies grouping tree node name, several subnodes can be
998    specified using slash '/' (e.g. "OSI/X.500" - protocol preferences will be
999    accessible under Protocols->OSI->X.500-><PROTOSHORTNAME> preferences node.
1000 */
1001   PROTOABBREV_module = prefs_register_protocol_subtree(const char *subtree,
1002        proto_PROTOABBREV, proto_reg_handoff_PROTOABBREV);
1003
1004 /* Register a sample preference */
1005         prefs_register_bool_preference(PROTOABBREV_module, "show_hex",
1006              "Display numbers in Hex",
1007              "Enable to display numerical values in hexadecimal.",
1008              &gPREF_HEX);
1009
1010 /* Register a sample port preference   */
1011         prefs_register_uint_preference(PROTOABBREV_module, "tcp.port", "PROTOABBREV TCP Port",
1012              " PROTOABBREV TCP port if other than the default",
1013              10, &gPORT_PREF);
1014 }
1015
1016
1017 /* If this dissector uses sub-dissector registration add a registration routine.
1018    This exact format is required because a script is used to find these
1019    routines and create the code that calls these routines.
1020
1021    If this function is registered as a prefs callback (see prefs_register_protocol
1022    above) this function is also called by preferences whenever "Apply" is pressed;
1023    In that case, it should accommodate being called more than once.
1024
1025    This form of the reg_handoff function is used if if you perform
1026    registration functions which are dependent upon prefs. See below
1027    for a simpler form  which can be used if there are no
1028    prefs-dependent registration functions.
1029 */
1030 void
1031 proto_reg_handoff_PROTOABBREV(void)
1032 {
1033         static gboolean initialized = FALSE;
1034         static dissector_handle_t PROTOABBREV_handle;
1035         static int currentPort;
1036
1037         if (!initialized) {
1038
1039 /*  Use new_create_dissector_handle() to indicate that dissect_PROTOABBREV()
1040  *  returns the number of bytes it dissected (or 0 if it thinks the packet
1041  *  does not belong to PROTONAME).
1042  */
1043                 PROTOABBREV_handle = new_create_dissector_handle(dissect_PROTOABBREV,
1044                                                                  proto_PROTOABBREV);
1045                 initialized = TRUE;
1046         } else {
1047
1048                 /*
1049                   If you perform registration functions which are dependent upon
1050                   prefs the you should de-register everything which was associated
1051                   with the previous settings and re-register using the new prefs
1052                   settings here. In general this means you need to keep track of
1053                   the PROTOABBREV_handle and the value the preference had at the time
1054                   you registered.  The PROTOABBREV_handle value and the value of the
1055                   preference can be saved using local statics in this
1056                   function (proto_reg_handoff).
1057                 */
1058
1059                 dissector_delete_uint("tcp.port", currentPort, PROTOABBREV_handle);
1060         }
1061
1062         currentPort = gPORT_PREF;
1063
1064         dissector_add_uint("tcp.port", currentPort, PROTOABBREV_handle);
1065
1066 }
1067
1068 #if 0
1069 /* Simple form of proto_reg_handoff_PROTOABBREV which can be used if there are
1070    no prefs-dependent registration function calls.
1071  */
1072
1073 void
1074 proto_reg_handoff_PROTOABBREV(void)
1075 {
1076         dissector_handle_t PROTOABBREV_handle;
1077
1078 /*  Use new_create_dissector_handle() to indicate that dissect_PROTOABBREV()
1079  *  returns the number of bytes it dissected (or 0 if it thinks the packet
1080  *  does not belong to PROTONAME).
1081  */
1082         PROTOABBREV_handle = new_create_dissector_handle(dissect_PROTOABBREV,
1083                                                          proto_PROTOABBREV);
1084         dissector_add_uint("PARENT_SUBFIELD", ID_VALUE, PROTOABBREV_handle);
1085 }
1086 #endif
1087
1088
1089 /*
1090  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
1091  *
1092  * Local variables:
1093  * c-basic-offset: 4
1094  * tab-width: 8
1095  * indent-tabs-mode: nil
1096  * End:
1097  *
1098  * vi: set shiftwidth=4 tabstop=8 expandtab:
1099  * :indentSize=4:tabSize=8:noTabs=true:
1100  */
1101
1102
1103 ------------------------------------Cut here------------------------------------
1104
1105 1.3 Explanation of needed substitutions in code skeleton.
1106
1107 In the above code block the following strings should be substituted with
1108 your information.
1109
1110 YOUR_NAME       Your name, of course.  You do want credit, don't you?
1111                 It's the only payment you will receive....
1112 YOUR_EMAIL_ADDRESS      Keep those cards and letters coming.
1113 WHATEVER_FILE_YOU_USED  Add this line if you are using another file as a
1114                 starting point.
1115 PROTONAME       The name of the protocol; this is displayed in the
1116                 top-level protocol tree item for that protocol.
1117 PROTOSHORTNAME  An abbreviated name for the protocol; this is displayed
1118                 in the "Preferences" dialog box if your dissector has
1119                 any preferences, in the dialog box of enabled protocols,
1120                 and in the dialog box for filter fields when constructing
1121                 a filter expression.
1122 PROTOABBREV     A name for the protocol for use in filter expressions;
1123                 it shall contain only lower-case letters, digits, and
1124                 hyphens.
1125 FIELDNAME       The displayed name for the header field.
1126 FIELDABBREV     The abbreviated name for the header field. (NO SPACES)
1127 FIELDTYPE       FT_NONE, FT_BOOLEAN, FT_UINT8, FT_UINT16, FT_UINT24,
1128                 FT_UINT32, FT_UINT64, FT_INT8, FT_INT16, FT_INT24, FT_INT32,
1129                 FT_INT64, FT_FLOAT, FT_DOUBLE, FT_ABSOLUTE_TIME,
1130                 FT_RELATIVE_TIME, FT_STRING, FT_STRINGZ, FT_EUI64,
1131                 FT_UINT_STRING, FT_ETHER, FT_BYTES, FT_UINT_BYTES, FT_IPv4,
1132                 FT_IPv6, FT_IPXNET, FT_FRAMENUM, FT_PROTOCOL, FT_GUID, FT_OID
1133 FIELDDISPLAY    For FT_UINT{8,16,24,32,64} and FT_INT{8,16,24,32,64):
1134
1135                 BASE_DEC, BASE_HEX, BASE_OCT, BASE_DEC_HEX, BASE_HEX_DEC,
1136                 or BASE_CUSTOM, possibly ORed with BASE_RANGE_STRING
1137
1138                 For FT_ABSOLUTE_TIME:
1139
1140                 ABSOLUTE_TIME_LOCAL, ABSOLUTE_TIME_UTC, or
1141                 ABSOLUTE_TIME_DOY_UTC
1142
1143                 For FT_BOOLEAN if BITMASK is non-zero:
1144
1145                 Number of bits in the field containing the FT_BOOLEAN
1146                 bitfield
1147
1148                 For all other types:
1149
1150                 BASE_NONE
1151 FIELDCONVERT    VALS(x), RVALS(x), TFS(x), NULL
1152 BITMASK         Usually 0x0 unless using the TFS(x) field conversion.
1153 FIELDDESCR      A brief description of the field, or NULL. [Please do not use ""].
1154 PARENT_SUBFIELD Lower level protocol field used for lookup, i.e. "tcp.port"
1155 ID_VALUE        Lower level protocol field value that identifies this protocol
1156                 For example the TCP or UDP port number
1157
1158 If, for example, PROTONAME is "Internet Bogosity Discovery Protocol",
1159 PROTOSHORTNAME would be "IBDP", and PROTOABBREV would be "ibdp".  Try to
1160 conform with IANA names.
1161
1162 1.4 The dissector and the data it receives.
1163
1164
1165 1.4.1 Header file.
1166
1167 This is only needed if the dissector doesn't use self-registration to
1168 register itself with the lower level dissector, or if the protocol dissector
1169 wants/needs to expose code to other subdissectors.
1170
1171 The dissector must be declared exactly as follows in the file
1172 packet-PROTOABBREV.h:
1173
1174 int
1175 dissect_PROTOABBREV(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
1176
1177
1178 1.4.2 Extracting data from packets.
1179
1180 NOTE: See the file /epan/tvbuff.h for more details.
1181
1182 The "tvb" argument to a dissector points to a buffer containing the raw
1183 data to be analyzed by the dissector; for example, for a protocol
1184 running atop UDP, it contains the UDP payload (but not the UDP header,
1185 or any protocol headers above it).  A tvbuffer is an opaque data
1186 structure, the internal data structures are hidden and the data must be
1187 accessed via the tvbuffer accessors.
1188
1189 The accessors are:
1190
1191 Bit accessors for a maximum of 8-bits, 16-bits 32-bits and 64-bits:
1192
1193 guint8 tvb_get_bits8(tvbuff_t *tvb, gint bit_offset, gint no_of_bits);
1194 guint16 tvb_get_bits16(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
1195 guint32 tvb_get_bits32(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
1196 guint64 tvb_get_bits64(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
1197
1198 Single-byte accessor:
1199
1200 guint8  tvb_get_guint8(tvbuff_t*, gint offset);
1201
1202 Network-to-host-order accessors for 16-bit integers (guint16), 24-bit
1203 integers, 32-bit integers (guint32), 40-bit integers, 48-bit integers,
1204 56-bit integers and 64-bit integers (guint64):
1205
1206 guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
1207 guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
1208 guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
1209 guint64 tvb_get_ntoh40(tvbuff_t*, gint offset);
1210 guint64 tvb_get_ntoh48(tvbuff_t*, gint offset);
1211 guint64 tvb_get_ntoh56(tvbuff_t*, gint offset);
1212 guint64 tvb_get_ntoh64(tvbuff_t*, gint offset);
1213
1214 Network-to-host-order accessors for single-precision and
1215 double-precision IEEE floating-point numbers:
1216
1217 gfloat tvb_get_ntohieee_float(tvbuff_t*, gint offset);
1218 gdouble tvb_get_ntohieee_double(tvbuff_t*, gint offset);
1219
1220 Little-Endian-to-host-order accessors for 16-bit integers (guint16),
1221 24-bit integers, 32-bit integers (guint32), 40-bit integers, 48-bit
1222 integers, 56-bit integers, and 64-bit integers (guint64):
1223
1224 guint16 tvb_get_letohs(tvbuff_t*, gint offset);
1225 guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
1226 guint32 tvb_get_letohl(tvbuff_t*, gint offset);
1227 guint64 tvb_get_letoh40(tvbuff_t*, gint offset);
1228 guint64 tvb_get_letoh48(tvbuff_t*, gint offset);
1229 guint64 tvb_get_letoh56(tvbuff_t*, gint offset);
1230 guint64 tvb_get_letoh64(tvbuff_t*, gint offset);
1231
1232 Little-Endian-to-host-order accessors for single-precision and
1233 double-precision IEEE floating-point numbers:
1234
1235 gfloat tvb_get_letohieee_float(tvbuff_t*, gint offset);
1236 gdouble tvb_get_letohieee_double(tvbuff_t*, gint offset);
1237
1238 Accessors for IPv4 and IPv6 addresses:
1239
1240 guint32 tvb_get_ipv4(tvbuff_t*, gint offset);
1241 void tvb_get_ipv6(tvbuff_t*, gint offset, struct e_in6_addr *addr);
1242
1243 NOTE: IPv4 addresses are not to be converted to host byte order before
1244 being passed to "proto_tree_add_ipv4()".  You should use "tvb_get_ipv4()"
1245 to fetch them, not "tvb_get_ntohl()" *OR* "tvb_get_letohl()" - don't,
1246 for example, try to use "tvb_get_ntohl()", find that it gives you the
1247 wrong answer on the PC on which you're doing development, and try
1248 "tvb_get_letohl()" instead, as "tvb_get_letohl()" will give the wrong
1249 answer on big-endian machines.
1250
1251 gchar *tvb_ip_to_str(tvbuff_t *tvb, const gint offset)
1252 gchar *tvb_ip6_to_str(tvbuff_t *tvb, const gint offset)
1253
1254 Returns a null-terminated buffer containing a string with IPv4 or IPv6 Address 
1255 from the specified tvbuff, starting at the specified offset.
1256
1257 Accessors for GUID:
1258
1259 void tvb_get_ntohguid(tvbuff_t *, gint offset, e_guid_t *guid);
1260 void tvb_get_letohguid(tvbuff_t *, gint offset, e_guid_t *guid);
1261
1262 String accessors:
1263
1264 guint8 *tvb_get_string(tvbuff_t*, gint offset, gint length);
1265 gchar  *tvb_get_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
1266 guint8 *tvb_get_ephemeral_string(tvbuff_t*, gint offset, gint length);
1267 gchar  *tvb_get_ephemeral_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
1268 guint8 *tvb_get_seasonal_string(tvbuff_t*, gint offset, gint length);
1269
1270 Returns a null-terminated buffer containing data from the specified
1271 tvbuff, starting at the specified offset, and containing the specified
1272 length worth of characters (the length of the buffer will be length+1,
1273 as it includes a null character to terminate the string).
1274
1275 tvb_get_string() returns a buffer allocated by g_malloc() so you must
1276 g_free() it when you are finished with the string. Failure to g_free() this
1277 buffer will lead to memory leaks.
1278
1279 tvb_get_unicode_string() is a unicode (UTF-16) version of above.  This
1280 is intended for reading UTF-16 unicode strings out of a tvbuff and
1281 returning them as a UTF-8 string for use in Wireshark.  The offset and
1282 returned length pointer are in bytes, not UTF-16 characters.
1283
1284 tvb_get_ephemeral_string() returns a buffer allocated from a special heap
1285 with a lifetime until the next packet is dissected. You do not need to
1286 free() this buffer, it will happen automatically once the next packet is
1287 dissected.
1288
1289 tvb_get_ephemeral_unicode_string() is a unicode (UTF-16) version of above.
1290 This is intended for reading UTF-16 unicode strings out of a tvbuff and
1291 returning them as a UTF-8 string for use in Wireshark.  The offset and
1292 returned length pointer are in bytes, not UTF-16 characters.
1293
1294 tvb_get_seasonal_string() returns a buffer allocated from a special heap
1295 with a lifetime of the current capture session. You do not need to
1296 free() this buffer, it will happen automatically once the a new capture or
1297 file is opened.
1298
1299 guint8 *tvb_get_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1300 const guint8 *tvb_get_const stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1301 guint8 *tvb_get_ephemeral_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1302 gchar  *tvb_get_ephemeral_unicode_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp, const guint encoding);
1303 guint8 *tvb_get_seasonal_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1304
1305 Returns a null-terminated buffer containing data from the specified tvbuff,
1306 starting at the specified offset, and containing all characters from the
1307 tvbuff up to and including a terminating null character in the tvbuff.
1308 "*lengthp" will be set to the length of the string, including the terminating
1309 null.
1310
1311 tvb_get_stringz() returns a buffer allocated by g_malloc() so you must
1312 g_free() it when you are finished with the string. Failure to g_free() this
1313 buffer will lead to memory leaks.
1314
1315 tvb_get_const_stringz() returns a pointer to the (const) string in the tvbuff.
1316 You do not need to free() this buffer, it will happen automatically once the
1317 next packet is dissected.  This function is slightly more efficient than the
1318 others because it does not allocate memory and copy the string.
1319
1320 tvb_get_ephemeral_stringz() returns a buffer allocated from a special heap
1321 with a lifetime until the next packet is dissected. You do not need to
1322 free() this buffer, it will happen automatically once the next packet is
1323 dissected.
1324
1325 tvb_get_ephemeral_unicode_stringz() is a unicode (UTF-16) version of
1326 above.  This is intended for reading UTF-16 unicode strings out of a tvbuff
1327 and returning them as a UTF-8 string for use in Wireshark.  The offset and
1328 returned length pointer are in bytes, not UTF-16 characters.
1329
1330 tvb_get_seasonal_stringz() returns a buffer allocated from a special heap
1331 with a lifetime of the current capture session. You do not need to
1332 free() this buffer, it will happen automatically once the a new capture or
1333 file is opened.
1334
1335 tvb_fake_unicode() has been superseded by tvb_get_unicode_string(), which
1336 properly handles Unicode (UTF-16) strings by converting them to UTF-8.
1337
1338 tvb_get_ephemeral_faked_unicode() has been superseded by
1339 tvb_get_ephemeral_string(), which properly handles Unicode (UTF-16) strings by
1340 converting them to UTF-8.
1341
1342 Byte Array Accessors:
1343
1344 gchar *tvb_bytes_to_str(tvbuff_t *tvb, gint offset, gint len);
1345
1346 Formats a bunch of data from a tvbuff as bytes, returning a pointer
1347 to the string with the data formatted as two hex digits for each byte.
1348 The string pointed to is stored in an "ep_alloc'd" buffer which will be freed
1349 before the next frame is dissected. The formatted string will contain the hex digits
1350 for at most the first 16 bytes of the data. If len is greater than 16 bytes, a
1351 trailing "..." will be added to the string.
1352
1353 gchar *tvb_bytes_to_str_punct(tvbuff_t *tvb, gint offset, gint len, gchar punct);
1354
1355 This function is similar to tvb_bytes_to_str(...) except that 'punct' is inserted
1356 between the hex representation of each byte.
1357
1358 gchar *tvb_bcd_dig_to_ep_str(tvbuff_t *tvb, const gint offset, const gint len, dgt_set_t *dgt, gboolean skip_first);
1359
1360 Given a tvbuff, an offset into the tvbuff, and a length that starts
1361 at that offset (which may be -1 for "all the way to the end of the
1362 tvbuff"), fetch BCD encoded digits from a tvbuff starting from either
1363 the low or high half byte, formatting the digits according to an input digit set,
1364 if NUll a default digit set of 0-9 returning "?" for overdecadic digits will be used.
1365 A pointer to the EP allocated string will be returned.
1366 Note: a tvbuff content of 0xf is considered a 'filler' and will end the conversion.
1367
1368 Copying memory:
1369 guint8* tvb_memcpy(tvbuff_t*, guint8* target, gint offset, gint length);
1370
1371 Copies into the specified target the specified length's worth of data
1372 from the specified tvbuff, starting at the specified offset.
1373
1374 guint8* tvb_memdup(tvbuff_t*, gint offset, gint length);
1375 guint8* ep_tvb_memdup(tvbuff_t*, gint offset, gint length);
1376
1377 Returns a buffer, allocated with "g_malloc()", containing the specified
1378 length's worth of data from the specified tvbuff, starting at the
1379 specified offset. The ephemeral variant is freed automatically after the
1380 packet is dissected.
1381
1382 Pointer-retrieval:
1383 /* WARNING! This function is possibly expensive, temporarily allocating
1384  * another copy of the packet data. Furthermore, it's dangerous because once
1385  * this pointer is given to the user, there's no guarantee that the user will
1386  * honor the 'length' and not overstep the boundaries of the buffer.
1387  */
1388 guint8* tvb_get_ptr(tvbuff_t*, gint offset, gint length);
1389
1390 The reason that tvb_get_ptr() might have to allocate a copy of its data
1391 only occurs with TVBUFF_COMPOSITES, data that spans multiple tvbuffers.
1392 If the user requests a pointer to a range of bytes that span the member
1393 tvbuffs that make up the TVBUFF_COMPOSITE, the data will have to be
1394 copied to another memory region to assure that all the bytes are
1395 contiguous.
1396
1397
1398
1399 1.5 Functions to handle columns in the traffic summary window.
1400
1401 The topmost pane of the main window is a list of the packets in the
1402 capture, possibly filtered by a display filter.
1403
1404 Each line corresponds to a packet, and has one or more columns, as
1405 configured by the user.
1406
1407 Many of the columns are handled by code outside individual dissectors;
1408 most dissectors need only specify the value to put in the "Protocol" and
1409 "Info" columns.
1410
1411 Columns are specified by COL_ values; the COL_ value for the "Protocol"
1412 field, typically giving an abbreviated name for the protocol (but not
1413 the all-lower-case abbreviation used elsewhere) is COL_PROTOCOL, and the
1414 COL_ value for the "Info" field, giving a summary of the contents of the
1415 packet for that protocol, is COL_INFO.
1416
1417 The value for a column can be specified with one of several functions,
1418 all of which take the 'fd' argument to the dissector as their first
1419 argument, and the COL_ value for the column as their second argument.
1420
1421 1.5.1 The col_set_str function.
1422
1423 'col_set_str' takes a string as its third argument, and sets the value
1424 for the column to that value.  It assumes that the pointer passed to it
1425 points to a string constant or a static "const" array, not to a
1426 variable, as it doesn't copy the string, it merely saves the pointer
1427 value; the argument can itself be a variable, as long as it always
1428 points to a string constant or a static "const" array.
1429
1430 It is more efficient than 'col_add_str' or 'col_add_fstr'; however, if
1431 the dissector will be using 'col_append_str' or 'col_append_fstr" to
1432 append more information to the column, the string will have to be copied
1433 anyway, so it's best to use 'col_add_str' rather than 'col_set_str' in
1434 that case.
1435
1436 For example, to set the "Protocol" column
1437 to "PROTOABBREV":
1438
1439         col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
1440
1441
1442 1.5.2 The col_add_str function.
1443
1444 'col_add_str' takes a string as its third argument, and sets the value
1445 for the column to that value.  It takes the same arguments as
1446 'col_set_str', but copies the string, so that if the string is, for
1447 example, an automatic variable that won't remain in scope when the
1448 dissector returns, it's safe to use.
1449
1450
1451 1.5.3 The col_add_fstr function.
1452
1453 'col_add_fstr' takes a 'printf'-style format string as its third
1454 argument, and 'printf'-style arguments corresponding to '%' format
1455 items in that string as its subsequent arguments.  For example, to set
1456 the "Info" field to "<XXX> request, <N> bytes", where "reqtype" is a
1457 string containing the type of the request in the packet and "n" is an
1458 unsigned integer containing the number of bytes in the request:
1459
1460         col_add_fstr(pinfo->cinfo, COL_INFO, "%s request, %u bytes",
1461                      reqtype, n);
1462
1463 Don't use 'col_add_fstr' with a format argument of just "%s" -
1464 'col_add_str', or possibly even 'col_set_str' if the string that matches
1465 the "%s" is a static constant string, will do the same job more
1466 efficiently.
1467
1468
1469 1.5.4 The col_clear function.
1470
1471 If the Info column will be filled with information from the packet, that
1472 means that some data will be fetched from the packet before the Info
1473 column is filled in.  If the packet is so small that the data in
1474 question cannot be fetched, the routines to fetch the data will throw an
1475 exception (see the comment at the beginning about tvbuffers improving
1476 the handling of short packets - the tvbuffers keep track of how much
1477 data is in the packet, and throw an exception on an attempt to fetch
1478 data past the end of the packet, so that the dissector won't process
1479 bogus data), causing the Info column not to be filled in.
1480
1481 This means that the Info column will have data for the previous
1482 protocol, which would be confusing if, for example, the Protocol column
1483 had data for this protocol.
1484
1485 Therefore, before a dissector fetches any data whatsoever from the
1486 packet (unless it's a heuristic dissector fetching data to determine
1487 whether the packet is one that it should dissect, in which case it
1488 should check, before fetching the data, whether there's any data to
1489 fetch; if there isn't, it should return FALSE), it should set the
1490 Protocol column and the Info column.
1491
1492 If the Protocol column will ultimately be set to, for example, a value
1493 containing a protocol version number, with the version number being a
1494 field in the packet, the dissector should, before fetching the version
1495 number field or any other field from the packet, set it to a value
1496 without a version number, using 'col_set_str', and should later set it
1497 to a value with the version number after it's fetched the version
1498 number.
1499
1500 If the Info column will ultimately be set to a value containing
1501 information from the packet, the dissector should, before fetching any
1502 fields from the packet, clear the column using 'col_clear' (which is
1503 more efficient than clearing it by calling 'col_set_str' or
1504 'col_add_str' with a null string), and should later set it to the real
1505 string after it's fetched the data to use when doing that.
1506
1507
1508 1.5.5 The col_append_str function.
1509
1510 Sometimes the value of a column, especially the "Info" column, can't be
1511 conveniently constructed at a single point in the dissection process;
1512 for example, it might contain small bits of information from many of the
1513 fields in the packet.  'col_append_str' takes, as arguments, the same
1514 arguments as 'col_add_str', but the string is appended to the end of the
1515 current value for the column, rather than replacing the value for that
1516 column.  (Note that no blank separates the appended string from the
1517 string to which it is appended; if you want a blank there, you must add
1518 it yourself as part of the string being appended.)
1519
1520
1521 1.5.6 The col_append_fstr function.
1522
1523 'col_append_fstr' is to 'col_add_fstr' as 'col_append_str' is to
1524 'col_add_str' - it takes, as arguments, the same arguments as
1525 'col_add_fstr', but the formatted string is appended to the end of the
1526 current value for the column, rather than replacing the value for that
1527 column.
1528
1529 1.5.7 The col_append_sep_str and col_append_sep_fstr functions.
1530
1531 In specific situations the developer knows that a column's value will be
1532 created in a stepwise manner, where the appended values are listed. Both
1533 'col_append_sep_str' and 'col_append_sep_fstr' functions will add an item
1534 separator between two consecutive items, and will not add the separator at the
1535 beginning of the column. The remainder of the work both functions do is
1536 identical to what 'col_append_str' and 'col_append_fstr' do.
1537
1538 1.5.8 The col_set_fence and col_prepend_fence_fstr functions.
1539
1540 Sometimes a dissector may be called multiple times for different PDUs in the
1541 same frame (for example in the case of SCTP chunk bundling: several upper
1542 layer data packets may be contained in one SCTP packet).  If the upper layer
1543 dissector calls 'col_set_str()' or 'col_clear()' on the Info column when it
1544 begins dissecting each of those PDUs then when the frame is fully dissected
1545 the Info column would contain only the string from the last PDU in the frame.
1546 The 'col_set_fence' function erects a "fence" in the column that prevents
1547 subsequent 'col_...' calls from clearing the data currently in that column.
1548 For example, the SCTP dissector calls 'col_set_fence' on the Info column
1549 after it has called any subdissectors for that chunk so that subdissectors
1550 of any subsequent chunks may only append to the Info column.
1551 'col_prepend_fence_fstr' prepends data before a fence (moving it if
1552 necessary).  It will create a fence at the end of the prepended data if the
1553 fence does not already exist.
1554
1555
1556 1.5.9 The col_set_time function.
1557
1558 The 'col_set_time' function takes an nstime value as its third argument.
1559 This nstime value is a relative value and will be added as such to the
1560 column. The fourth argument is the filtername holding this value. This
1561 way, rightclicking on the column makes it possible to build a filter
1562 based on the time-value.
1563
1564 For example:
1565
1566         nstime_delta(&ts, &pinfo->fd->abs_ts, &tcpd->ts_first);
1567         col_set_time(pinfo->cinfo, COL_REL_CONV_TIME, &ts, "tcp.time_relative");
1568
1569
1570 1.6 Constructing the protocol tree.
1571
1572 The middle pane of the main window, and the topmost pane of a packet
1573 popup window, are constructed from the "protocol tree" for a packet.
1574
1575 The protocol tree, or proto_tree, is a GNode, the N-way tree structure
1576 available within GLIB. Of course the protocol dissectors don't care
1577 what a proto_tree really is; they just pass the proto_tree pointer as an
1578 argument to the routines which allow them to add items and new branches
1579 to the tree.
1580
1581 When a packet is selected in the packet-list pane, or a packet popup
1582 window is created, a new logical protocol tree (proto_tree) is created.
1583 The pointer to the proto_tree (in this case, 'protocol tree'), is passed
1584 to the top-level protocol dissector, and then to all subsequent protocol
1585 dissectors for that packet, and then the GUI tree is drawn via
1586 proto_tree_draw().
1587
1588 The logical proto_tree needs to know detailed information about the protocols
1589 and fields about which information will be collected from the dissection
1590 routines. By strictly defining (or "typing") the data that can be attached to a
1591 proto tree, searching and filtering becomes possible.  This means that for
1592 every protocol and field (which I also call "header fields", since they are
1593 fields in the protocol headers) which might be attached to a tree, some
1594 information is needed.
1595
1596 Every dissector routine will need to register its protocols and fields
1597 with the central protocol routines (in proto.c). At first I thought I
1598 might keep all the protocol and field information about all the
1599 dissectors in one file, but decentralization seemed like a better idea.
1600 That one file would have gotten very large; one small change would have
1601 required a re-compilation of the entire file. Also, by allowing
1602 registration of protocols and fields at run-time, loadable modules of
1603 protocol dissectors (perhaps even user-supplied) is feasible.
1604
1605 To do this, each protocol should have a register routine, which will be
1606 called when Wireshark starts.  The code to call the register routines is
1607 generated automatically; to arrange that a protocol's register routine
1608 be called at startup:
1609
1610         the file containing a dissector's "register" routine must be
1611         added to "DISSECTOR_SRC" in "epan/dissectors/Makefile.common"
1612         (and in "epan/CMakeLists.txt");
1613
1614         the "register" routine must have a name of the form
1615         "proto_register_XXX";
1616
1617         the "register" routine must take no argument, and return no
1618         value;
1619
1620         the "register" routine's name must appear in the source file
1621         either at the beginning of the line, or preceded only by "void "
1622         at the beginning of the line (that would typically be the
1623         definition) - other white space shouldn't cause a problem, e.g.:
1624
1625 void proto_register_XXX(void) {
1626
1627         ...
1628
1629 }
1630
1631 and
1632
1633 void
1634 proto_register_XXX( void )
1635 {
1636
1637         ...
1638
1639 }
1640
1641         and so on should work.
1642
1643 For every protocol or field that a dissector wants to register, a variable of
1644 type int needs to be used to keep track of the protocol. The IDs are
1645 needed for establishing parent/child relationships between protocols and
1646 fields, as well as associating data with a particular field so that it
1647 can be stored in the logical tree and displayed in the GUI protocol
1648 tree.
1649
1650 Some dissectors will need to create branches within their tree to help
1651 organize header fields. These branches should be registered as header
1652 fields. Only true protocols should be registered as protocols. This is
1653 so that a display filter user interface knows how to distinguish
1654 protocols from fields.
1655
1656 A protocol is registered with the name of the protocol and its
1657 abbreviation.
1658
1659 Here is how the frame "protocol" is registered.
1660
1661         int proto_frame;
1662
1663         proto_frame = proto_register_protocol (
1664                 /* name */            "Frame",
1665                 /* short name */      "Frame",
1666                 /* abbrev */          "frame" );
1667
1668 A header field is also registered with its name and abbreviation, but
1669 information about its data type is needed. It helps to look at
1670 the header_field_info struct to see what information is expected:
1671
1672 struct header_field_info {
1673         const char                      *name;
1674         const char                      *abbrev;
1675         enum ftenum                     type;
1676         int                             display;
1677         const void                      *strings;
1678         guint32                         bitmask;
1679         const char                      *blurb;
1680         .....
1681 };
1682
1683 name
1684 ----
1685 A string representing the name of the field. This is the name
1686 that will appear in the graphical protocol tree.  It must be a non-empty
1687 string.
1688
1689 abbrev
1690 ------
1691 A string with an abbreviation of the field. We concatenate the
1692 abbreviation of the parent protocol with an abbreviation for the field,
1693 using a period as a separator. For example, the "src" field in an IP packet
1694 would have "ip.src" as an abbreviation. It is acceptable to have
1695 multiple levels of periods if, for example, you have fields in your
1696 protocol that are then subdivided into subfields. For example, TRMAC
1697 has multiple error fields, so the abbreviations follow this pattern:
1698 "trmac.errors.iso", "trmac.errors.noniso", etc.
1699
1700 The abbreviation is the identifier used in a display filter.  If it is
1701 an empty string then the field will not be filterable.
1702
1703 type
1704 ----
1705 The type of value this field holds. The current field types are:
1706
1707         FT_NONE                 No field type. Used for fields that
1708                                 aren't given a value, and that can only
1709                                 be tested for presence or absence; a
1710                                 field that represents a data structure,
1711                                 with a subtree below it containing
1712                                 fields for the members of the structure,
1713                                 or that represents an array with a
1714                                 subtree below it containing fields for
1715                                 the members of the array, might be an
1716                                 FT_NONE field.
1717         FT_PROTOCOL             Used for protocols which will be placing
1718                                 themselves as top-level items in the
1719                                 "Packet Details" pane of the UI.
1720         FT_BOOLEAN              0 means "false", any other value means
1721                                 "true".
1722         FT_FRAMENUM             A frame number; if this is used, the "Go
1723                                 To Corresponding Frame" menu item can
1724                                 work on that field.
1725         FT_UINT8                An 8-bit unsigned integer.
1726         FT_UINT16               A 16-bit unsigned integer.
1727         FT_UINT24               A 24-bit unsigned integer.
1728         FT_UINT32               A 32-bit unsigned integer.
1729         FT_UINT64               A 64-bit unsigned integer.
1730         FT_INT8                 An 8-bit signed integer.
1731         FT_INT16                A 16-bit signed integer.
1732         FT_INT24                A 24-bit signed integer.
1733         FT_INT32                A 32-bit signed integer.
1734         FT_INT64                A 64-bit signed integer.
1735         FT_FLOAT                A single-precision floating point number.
1736         FT_DOUBLE               A double-precision floating point number.
1737         FT_ABSOLUTE_TIME        An absolute time from some fixed point in time,
1738                                 displayed as the date, followed by the time, as
1739                                 hours, minutes, and seconds with 9 digits after
1740                                 the decimal point.
1741         FT_RELATIVE_TIME        Seconds (4 bytes) and nanoseconds (4 bytes)
1742                                 of time relative to an arbitrary time.
1743                                 displayed as seconds and 9 digits
1744                                 after the decimal point.
1745         FT_STRING               A string of characters, not necessarily
1746                                 NULL-terminated, but possibly NULL-padded.
1747                                 This, and the other string-of-characters
1748                                 types, are to be used for text strings,
1749                                 not raw binary data.
1750         FT_STRINGZ              A NULL-terminated string of characters.
1751                                 The string length is normally the length
1752                                 given in the proto_tree_add_item() call.
1753                                 However if the length given in the call
1754                                 is -1, then the length used is that
1755                                 returned by calling tvb_strsize().
1756         FT_UINT_STRING          A counted string of characters, consisting
1757                                 of a count (represented as an integral value,
1758                                 of width given in the proto_tree_add_item()
1759                                 call) followed immediately by that number of
1760                                 characters.
1761         FT_ETHER                A six octet string displayed in
1762                                 Ethernet-address format.
1763         FT_BYTES                A string of bytes with arbitrary values;
1764                                 used for raw binary data.
1765         FT_UINT_BYTES           A counted string of bytes, consisting
1766                                 of a count (represented as an integral value,
1767                                 of width given in the proto_tree_add_item()
1768                                 call) followed immediately by that number of
1769                                 arbitrary values; used for raw binary data.
1770         FT_IPv4                 A version 4 IP address (4 bytes) displayed
1771                                 in dotted-quad IP address format (4
1772                                 decimal numbers separated by dots).
1773         FT_IPv6                 A version 6 IP address (16 bytes) displayed
1774                                 in standard IPv6 address format.
1775         FT_IPXNET               An IPX address displayed in hex as a 6-byte
1776                                 network number followed by a 6-byte station
1777                                 address.
1778         FT_GUID                 A Globally Unique Identifier
1779         FT_OID                  An ASN.1 Object Identifier
1780         FT_EUI64                A EUI-64 Address
1781
1782 Some of these field types are still not handled in the display filter
1783 routines, but the most common ones are. The FT_UINT* variables all
1784 represent unsigned integers, and the FT_INT* variables all represent
1785 signed integers; the number on the end represent how many bits are used
1786 to represent the number.
1787
1788 Some constraints are imposed on the header fields depending on the type
1789 (e.g.  FT_BYTES) of the field.  Fields of type FT_ABSOLUTE_TIME must use
1790 'ABSOLUTE_TIME_{LOCAL,UTC,DOY_UTC}, NULL, 0x0' as values for the
1791 'display, 'strings', and 'bitmask' fields, and all other non-integral
1792 types (i.e.. types that are _not_ FT_INT* and FT_UINT*) must use
1793 'BASE_NONE, NULL, 0x0' as values for the 'display', 'strings', 'bitmask'
1794 fields.  The reason is simply that the type itself implictly defines the
1795 nature of 'display', 'strings', 'bitmask'.
1796
1797 display
1798 -------
1799 The display field has a couple of overloaded uses. This is unfortunate,
1800 but since we're using C as an application programming language, this sometimes
1801 makes for cleaner programs. Right now I still think that overloading
1802 this variable was okay.
1803
1804 For integer fields (FT_UINT* and FT_INT*), this variable represents the
1805 base in which you would like the value displayed.  The acceptable bases
1806 are:
1807
1808         BASE_DEC,
1809         BASE_HEX,
1810         BASE_OCT,
1811         BASE_DEC_HEX,
1812         BASE_HEX_DEC,
1813         BASE_CUSTOM
1814
1815 BASE_DEC, BASE_HEX, and BASE_OCT are decimal, hexadecimal, and octal,
1816 respectively. BASE_DEC_HEX and BASE_HEX_DEC display value in two bases
1817 (the 1st representation followed by the 2nd in parenthesis).
1818
1819 BASE_CUSTOM allows one to specify a callback function pointer that will
1820 format the value. The function pointer of the same type as defined by
1821 custom_fmt_func_t in epan/proto.h, specifically:
1822
1823   void func(gchar *, guint32);
1824
1825 The first argument is a pointer to a buffer of the ITEM_LABEL_LENGTH size
1826 and the second argument is the value to be formatted.
1827
1828 For FT_BOOLEAN fields that are also bitfields (i.e. 'bitmask' is non-zero),
1829 'display' is used to tell the proto_tree how wide the parent bitfield is.
1830 With integers this is not needed since the type of integer itself
1831 (FT_UINT8, FT_UINT16, FT_UINT24, FT_UINT32, etc.) tells the proto_tree how
1832 wide the parent bitfield is.
1833
1834 For FT_ABSOLUTE_TIME fields, 'display' is used to indicate whether the
1835 time is to be displayed as a time in the time zone for the machine on
1836 which Wireshark/TShark is running or as UTC and, for UTC, whether the
1837 date should be displayed as "{monthname}, {month} {day_of_month},
1838 {year}" or as "{year/day_of_year}".
1839
1840 Additionally, BASE_NONE is used for 'display' as a NULL-value. That is, for
1841 non-integers other than FT_ABSOLUTE_TIME fields, and non-bitfield
1842 FT_BOOLEANs, you'll want to use BASE_NONE in the 'display' field.  You may
1843 not use BASE_NONE for integers.
1844
1845 It is possible that in the future we will record the endianness of
1846 integers. If so, it is likely that we'll use a bitmask on the display field
1847 so that integers would be represented as BEND|BASE_DEC or LEND|BASE_HEX.
1848 But that has not happened yet; note that there are protocols for which
1849 no endianness is specified, such as the X11 protocol and the DCE RPC
1850 protocol, so it would not be possible to record the endianness of all
1851 integral fields.
1852
1853 strings
1854 -------
1855 -- value_string
1856 Some integer fields, of type FT_UINT*, need labels to represent the true
1857 value of a field.  You could think of those fields as having an
1858 enumerated data type, rather than an integral data type.
1859
1860 A 'value_string' structure is a way to map values to strings.
1861
1862         typedef struct _value_string {
1863                 guint32  value;
1864                 gchar   *strptr;
1865         } value_string;
1866
1867 For fields of that type, you would declare an array of "value_string"s:
1868
1869         static const value_string valstringname[] = {
1870                 { INTVAL1, "Descriptive String 1" },
1871                 { INTVAL2, "Descriptive String 2" },
1872                 { 0,       NULL }
1873         };
1874
1875 (the last entry in the array must have a NULL 'strptr' value, to
1876 indicate the end of the array).  The 'strings' field would be set to
1877 'VALS(valstringname)'.
1878
1879 If the field has a numeric rather than an enumerated type, the 'strings'
1880 field would be set to NULL.
1881
1882 -- Extended value strings
1883 You can also use an extended version of the value_string for faster lookups.
1884 It requires a value_string as input.
1885 If all of a contiguous range of values from min to max are present in the array
1886 the value will be used as as a direct index into a value_string array.
1887
1888 If the values in the array are not contiguous (ie: there are "gaps"), but are
1889 in ascending order a binary search will be used.
1890
1891 Note: "gaps" in a value_string array can be filled with "empty" entries eg:
1892 {value, "Unknown"} so that direct access to the array is is possible.
1893
1894 The init macro (see below) will perform a check on the value string the first
1895 time it is used to determine which search algorithm fits and fall back to a
1896 linear search if the value_string does not meet the criteria above.
1897
1898 Use this macro to initialize the extended value_string at compile time:
1899
1900 static value_string_ext valstringname_ext = VALUE_STRING_EXT_INIT(valstringname);
1901
1902 Extended value strings can be created at run time by calling
1903    value_string_ext_new(<ptr to value_string array>,
1904                         <total number of entries in the value_string_array>, /* include {0, NULL} entry */
1905                         <value_string_name>);
1906
1907 For hf[] array FT_(U)INT* fields that need a 'valstringname_ext' struct, the
1908 'strings' field would be set to '&valstringname_ext)'. Furthermore, 'display'
1909 field must be ORed with 'BASE_EXT_STRING' (e.g. BASE_DEC|BASE_EXT_STRING).
1910
1911
1912 -- Ranges
1913 If the field has a numeric type that might logically fit in ranges of values
1914 one can use a range_string struct.
1915
1916 Thus a 'range_string' structure is a way to map ranges to strings.
1917
1918         typedef struct _range_string {
1919                 guint32        value_min;
1920                 guint32        value_max;
1921                 const gchar   *strptr;
1922         } range_string;
1923
1924 For fields of that type, you would declare an array of "range_string"s:
1925
1926         static const range_string rvalstringname[] = {
1927                 { INTVAL_MIN1, INTVALMAX1, "Descriptive String 1" },
1928                 { INTVAL_MIN2, INTVALMAX2, "Descriptive String 2" },
1929                 { 0,           0,          NULL                   }
1930         };
1931
1932 If INTVAL_MIN equals INTVAL_MAX for a given entry the range_string
1933 behavior collapses to the one of value_string.
1934 For FT_(U)INT* fields that need a 'range_string' struct, the 'strings' field
1935 would be set to 'RVALS(rvalstringname)'. Furthermore, 'display' field must be
1936 ORed with 'BASE_RANGE_STRING' (e.g. BASE_DEC|BASE_RANGE_STRING).
1937
1938 -- Booleans
1939 FT_BOOLEANs have a default map of 0 = "False", 1 (or anything else) = "True".
1940 Sometimes it is useful to change the labels for boolean values (e.g.,
1941 to "Yes"/"No", "Fast"/"Slow", etc.).  For these mappings, a struct called
1942 true_false_string is used.
1943
1944         typedef struct true_false_string {
1945                 char    *true_string;
1946                 char    *false_string;
1947         } true_false_string;
1948
1949 For Boolean fields for which "False" and "True" aren't the desired
1950 labels, you would declare a "true_false_string"s:
1951
1952         static const true_false_string boolstringname = {
1953                 "String for True",
1954                 "String for False"
1955         };
1956
1957 Its two fields are pointers to the string representing truth, and the
1958 string representing falsehood.  For FT_BOOLEAN fields that need a
1959 'true_false_string' struct, the 'strings' field would be set to
1960 'TFS(&boolstringname)'.
1961
1962 If the Boolean field is to be displayed as "False" or "True", the
1963 'strings' field would be set to NULL.
1964
1965 Wireshark predefines a whole range of ready made "true_false_string"s
1966 in tfs.h, included via packet.h.
1967
1968 bitmask
1969 -------
1970 If the field is a bitfield, then the bitmask is the mask which will
1971 leave only the bits needed to make the field when ANDed with a value.
1972 The proto_tree routines will calculate 'bitshift' automatically
1973 from 'bitmask', by finding the rightmost set bit in the bitmask.
1974 This shift is applied before applying string mapping functions or
1975 filtering.
1976 If the field is not a bitfield, then bitmask should be set to 0.
1977
1978 blurb
1979 -----
1980 This is a string giving a proper description of the field.  It should be
1981 at least one grammatically complete sentence, or NULL in which case the
1982 name field is used. (Please do not use "").
1983 It is meant to provide a more detailed description of the field than the
1984 name alone provides. This information will be used in the man page, and
1985 in a future GUI display-filter creation tool. We might also add tooltips
1986 to the labels in the GUI protocol tree, in which case the blurb would
1987 be used as the tooltip text.
1988
1989
1990 1.6.1 Field Registration.
1991
1992 Protocol registration is handled by creating an instance of the
1993 header_field_info struct (or an array of such structs), and
1994 calling the registration function along with the registration ID of
1995 the protocol that is the parent of the fields. Here is a complete example:
1996
1997         static int proto_eg = -1;
1998         static int hf_field_a = -1;
1999         static int hf_field_b = -1;
2000
2001         static hf_register_info hf[] = {
2002
2003                 { &hf_field_a,
2004                 { "Field A",    "proto.field_a", FT_UINT8, BASE_HEX, NULL,
2005                         0xf0, "Field A represents Apples", HFILL }},
2006
2007                 { &hf_field_b,
2008                 { "Field B",    "proto.field_b", FT_UINT16, BASE_DEC, VALS(vs),
2009                         0x0, "Field B represents Bananas", HFILL }}
2010         };
2011
2012         proto_eg = proto_register_protocol("Example Protocol",
2013             "PROTO", "proto");
2014         proto_register_field_array(proto_eg, hf, array_length(hf));
2015
2016 Be sure that your array of hf_register_info structs is declared 'static',
2017 since the proto_register_field_array() function does not create a copy
2018 of the information in the array... it uses that static copy of the
2019 information that the compiler created inside your array. Here's the
2020 layout of the hf_register_info struct:
2021
2022 typedef struct hf_register_info {
2023         int                     *p_id;  /* pointer to parent variable */
2024         header_field_info       hfinfo;
2025 } hf_register_info;
2026
2027 Also be sure to use the handy array_length() macro found in packet.h
2028 to have the compiler compute the array length for you at compile time.
2029
2030 If you don't have any fields to register, do *NOT* create a zero-length
2031 "hf" array; not all compilers used to compile Wireshark support them.
2032 Just omit the "hf" array, and the "proto_register_field_array()" call,
2033 entirely.
2034
2035 It is OK to have header fields with a different format be registered with
2036 the same abbreviation. For instance, the following is valid:
2037
2038         static hf_register_info hf[] = {
2039
2040                 { &hf_field_8bit, /* 8-bit version of proto.field */
2041                 { "Field (8 bit)", "proto.field", FT_UINT8, BASE_DEC, NULL,
2042                         0x00, "Field represents FOO", HFILL }},
2043
2044                 { &hf_field_32bit, /* 32-bit version of proto.field */
2045                 { "Field (32 bit)", "proto.field", FT_UINT32, BASE_DEC, NULL,
2046                         0x00, "Field represents FOO", HFILL }}
2047         };
2048
2049 This way a filter expression can match a header field, irrespective of the
2050 representation of it in the specific protocol context. This is interesting
2051 for protocols with variable-width header fields.
2052
2053 The HFILL macro at the end of the struct will set reasonable default values
2054 for internally used fields.
2055
2056 1.6.2 Adding Items and Values to the Protocol Tree.
2057
2058 A protocol item is added to an existing protocol tree with one of a
2059 handful of proto_XXX_DO_YYY() functions.
2060
2061 Remember that it only makes sense to add items to a protocol tree if its
2062 proto_tree pointer is not null. Should you add an item to a NULL tree, then
2063 the proto_XXX_DO_YYY() function will immediately return. The cost of this
2064 function call can be avoided by checking for the tree pointer.
2065
2066 Subtrees can be made with the proto_item_add_subtree() function:
2067
2068         item = proto_tree_add_item(....);
2069         new_tree = proto_item_add_subtree(item, tree_type);
2070
2071 This will add a subtree under the item in question; a subtree can be
2072 created under an item made by any of the "proto_tree_add_XXX" functions,
2073 so that the tree can be given an arbitrary depth.
2074
2075 Subtree types are integers, assigned by
2076 "proto_register_subtree_array()".  To register subtree types, pass an
2077 array of pointers to "gint" variables to hold the subtree type values to
2078 "proto_register_subtree_array()":
2079
2080         static gint ett_eg = -1;
2081         static gint ett_field_a = -1;
2082
2083         static gint *ett[] = {
2084                 &ett_eg,
2085                 &ett_field_a
2086         };
2087
2088         proto_register_subtree_array(ett, array_length(ett));
2089
2090 in your "register" routine, just as you register the protocol and the
2091 fields for that protocol.
2092
2093 The ett_ variables identify particular type of subtree so that if you expand
2094 one of them, Wireshark keeps track of that and, when you click on
2095 another packet, it automatically opens all subtrees of that type.
2096 If you close one of them, all subtrees of that type will be closed when
2097 you move to another packet.
2098
2099 There are several functions that the programmer can use to add either
2100 protocol or field labels to the proto_tree:
2101
2102         proto_item*
2103         proto_tree_add_item(tree, id, tvb, start, length, encoding);
2104
2105         proto_item*
2106         proto_tree_add_none_format(tree, id, tvb, start, length, format, ...);
2107
2108         proto_item*
2109         proto_tree_add_protocol_format(tree, id, tvb, start, length,
2110                 format, ...);
2111
2112         proto_item *
2113         proto_tree_add_bytes(tree, id, tvb, start, length, start_ptr);
2114
2115         proto_item *
2116         proto_tree_add_bytes_format(tree, id, tvb, start, length, start_ptr,
2117                 format, ...);
2118
2119         proto_item *
2120         proto_tree_add_bytes_format_value(tree, id, tvb, start, length,
2121                 start_ptr, format, ...);
2122
2123         proto_item *
2124         proto_tree_add_time(tree, id, tvb, start, length, value_ptr);
2125
2126         proto_item *
2127         proto_tree_add_time_format(tree, id, tvb, start, length, value_ptr,
2128                 format, ...);
2129
2130         proto_item *
2131         proto_tree_add_time_format_value(tree, id, tvb, start, length,
2132                 value_ptr, format, ...);
2133
2134         proto_item *
2135         proto_tree_add_ipxnet(tree, id, tvb, start, length, value);
2136
2137         proto_item *
2138         proto_tree_add_ipxnet_format(tree, id, tvb, start, length, value,
2139                 format, ...);
2140
2141         proto_item *
2142         proto_tree_add_ipxnet_format_value(tree, id, tvb, start, length,
2143                 value, format, ...);
2144
2145         proto_item *
2146         proto_tree_add_ipv4(tree, id, tvb, start, length, value);
2147
2148         proto_item *
2149         proto_tree_add_ipv4_format(tree, id, tvb, start, length, value,
2150                 format, ...);
2151
2152         proto_item *
2153         proto_tree_add_ipv4_format_value(tree, id, tvb, start, length,
2154                 value, format, ...);
2155
2156         proto_item *
2157         proto_tree_add_ipv6(tree, id, tvb, start, length, value_ptr);
2158
2159         proto_item *
2160         proto_tree_add_ipv6_format(tree, id, tvb, start, length, value_ptr,
2161                 format, ...);
2162
2163         proto_item *
2164         proto_tree_add_ipv6_format_value(tree, id, tvb, start, length,
2165                 value_ptr, format, ...);
2166
2167         proto_item *
2168         proto_tree_add_ether(tree, id, tvb, start, length, value_ptr);
2169
2170         proto_item *
2171         proto_tree_add_ether_format(tree, id, tvb, start, length, value_ptr,
2172                 format, ...);
2173
2174         proto_item *
2175         proto_tree_add_ether_format_value(tree, id, tvb, start, length,
2176                 value_ptr, format, ...);
2177
2178         proto_item *
2179         proto_tree_add_string(tree, id, tvb, start, length, value_ptr);
2180
2181         proto_item *
2182         proto_tree_add_string_format(tree, id, tvb, start, length, value_ptr,
2183                 format, ...);
2184
2185         proto_item *
2186         proto_tree_add_string_format_value(tree, id, tvb, start, length,
2187                 value_ptr, format, ...);
2188
2189         proto_item *
2190         proto_tree_add_boolean(tree, id, tvb, start, length, value);
2191
2192         proto_item *
2193         proto_tree_add_boolean_format(tree, id, tvb, start, length, value,
2194                 format, ...);
2195
2196         proto_item *
2197         proto_tree_add_boolean_format_value(tree, id, tvb, start, length,
2198                 value, format, ...);
2199
2200         proto_item *
2201         proto_tree_add_float(tree, id, tvb, start, length, value);
2202
2203         proto_item *
2204         proto_tree_add_float_format(tree, id, tvb, start, length, value,
2205                 format, ...);
2206
2207         proto_item *
2208         proto_tree_add_float_format_value(tree, id, tvb, start, length,
2209                 value, format, ...);
2210
2211         proto_item *
2212         proto_tree_add_double(tree, id, tvb, start, length, value);
2213
2214         proto_item *
2215         proto_tree_add_double_format(tree, id, tvb, start, length, value,
2216                 format, ...);
2217
2218         proto_item *
2219         proto_tree_add_double_format_value(tree, id, tvb, start, length,
2220                 value, format, ...);
2221
2222         proto_item *
2223         proto_tree_add_uint(tree, id, tvb, start, length, value);
2224
2225         proto_item *
2226         proto_tree_add_uint_format(tree, id, tvb, start, length, value,
2227                 format, ...);
2228
2229         proto_item *
2230         proto_tree_add_uint_format_value(tree, id, tvb, start, length,
2231                 value, format, ...);
2232
2233         proto_item *
2234         proto_tree_add_uint64(tree, id, tvb, start, length, value);
2235
2236         proto_item *
2237         proto_tree_add_uint64_format(tree, id, tvb, start, length, value,
2238                 format, ...);
2239
2240         proto_item *
2241         proto_tree_add_uint64_format_value(tree, id, tvb, start, length,
2242                 value, format, ...);
2243
2244         proto_item *
2245         proto_tree_add_int(tree, id, tvb, start, length, value);
2246
2247         proto_item *
2248         proto_tree_add_int_format(tree, id, tvb, start, length, value,
2249                 format, ...);
2250
2251         proto_item *
2252         proto_tree_add_int_format_value(tree, id, tvb, start, length,
2253                 value, format, ...);
2254
2255         proto_item *
2256         proto_tree_add_int64(tree, id, tvb, start, length, value);
2257
2258         proto_item *
2259         proto_tree_add_int64_format(tree, id, tvb, start, length, value,
2260                 format, ...);
2261
2262         proto_item *
2263         proto_tree_add_int64_format_value(tree, id, tvb, start, length,
2264                 value, format, ...);
2265
2266         proto_item*
2267         proto_tree_add_text(tree, tvb, start, length, format, ...);
2268
2269         proto_item*
2270         proto_tree_add_text_valist(tree, tvb, start, length, format, ap);
2271
2272         proto_item *
2273         proto_tree_add_guid(tree, id, tvb, start, length, value_ptr);
2274
2275         proto_item *
2276         proto_tree_add_guid_format(tree, id, tvb, start, length, value_ptr,
2277                 format, ...);
2278
2279         proto_item *
2280         proto_tree_add_guid_format_value(tree, id, tvb, start, length,
2281                 value_ptr, format, ...);
2282
2283         proto_item *
2284         proto_tree_add_oid(tree, id, tvb, start, length, value_ptr);
2285
2286         proto_item *
2287         proto_tree_add_oid_format(tree, id, tvb, start, length, value_ptr,
2288                 format, ...);
2289
2290         proto_item *
2291         proto_tree_add_eui64(tree, id, tvb, start, length, value);
2292
2293         proto_item *
2294         proto_tree_add_eui64_format(tree, id, tvb, start, length, value,
2295                 format, ...);
2296
2297         proto_item *
2298         proto_tree_add_eui64_format_value(tree, id, tvb, start, length,
2299                 value, format, ...);
2300
2301         proto_item *
2302         proto_tree_add_oid_format_value(tree, id, tvb, start, length,
2303                 value_ptr, format, ...);
2304
2305         proto_item*
2306         proto_tree_add_bits_item(tree, id, tvb, bit_offset, no_of_bits,
2307                 little_endian);
2308
2309         proto_item *
2310         proto_tree_add_bits_ret_val(tree, id, tvb, bit_offset, no_of_bits,
2311                 return_value, little_endian);
2312
2313         proto_item *
2314         proto_tree_add_bitmask(tree, tvb, start, header, ett, fields,
2315                 little_endian);
2316
2317         proto_item *
2318         proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
2319                 ett, fields, little_endian, flags);
2320
2321 The 'tree' argument is the tree to which the item is to be added.  The
2322 'tvb' argument is the tvbuff from which the item's value is being
2323 extracted; the 'start' argument is the offset from the beginning of that
2324 tvbuff of the item being added, and the 'length' argument is the length,
2325 in bytes, of the item, bit_offset is the offset in bits and no_of_bits
2326 is the length in bits.
2327
2328 The length of some items cannot be determined until the item has been
2329 dissected; to add such an item, add it with a length of -1, and, when the
2330 dissection is complete, set the length with 'proto_item_set_len()':
2331
2332         void
2333         proto_item_set_len(ti, length);
2334
2335 The "ti" argument is the value returned by the call that added the item
2336 to the tree, and the "length" argument is the length of the item.
2337
2338 proto_tree_add_item()
2339 ---------------------
2340 proto_tree_add_item is used when you wish to do no special formatting.
2341 The item added to the GUI tree will contain the name (as passed in the
2342 proto_register_*() function) and a value.  The value will be fetched
2343 from the tvbuff by proto_tree_add_item(), based on the type of the field
2344 and the encoding of the value as specified by the "encoding" argument.
2345
2346 For FT_NONE, FT_BYTES, FT_ETHER, FT_IPv6, FT_IPXNET, FT_OID fields,
2347 and 'protocol' fields the encoding is not relevant; the 'encoding'
2348 argument should be ENC_NA (Not Applicable).
2349
2350 For integral, floating-point, Boolean, FT_GUID, and FT_EUI64 fields,
2351 the encoding specifies the byte order of the value; the 'encoding'
2352 argument should be is ENC_LITTLE_ENDIAN if the value is little-endian
2353 and ENC_BIG_ENDIAN if it is big-endian.
2354
2355 For FT_IPv4 fields, the encoding also specifies the byte order of the
2356 value.  In almost all cases, the encoding is in network byte order,
2357 hence big-endian, but in at least one protocol dissected by Wireshark,
2358 at least one IPv4 address is byte-swapped, so it's in little-endian
2359 order.
2360
2361 For string fields, the encoding specifies the character set used for the
2362 string and the way individual code points in that character set are
2363 encoded.  For FT_UINT_STRING fields, the byte order of the count must be
2364 specified; when support for UTF-16 encoding is added, the byte order of
2365 the encoding will also have to be specified.  In other cases, ENC_NA
2366 should be used.  The character encodings that are currently
2367 supported are:
2368
2369         ENC_UTF_8 - UTF-8
2370         ENC_ASCII - ASCII (currently treated as UTF-8; in the future,
2371                 all bytes with the 8th bit set will be treated as
2372                 errors)
2373         ENC_EBCDIC - EBCDIC
2374
2375 Other encodings will be added in the future.
2376
2377 For FT_ABSOLUTE_TIME fields, the encoding specifies the form in which
2378 the time stamp is specified, as well as its byte order.  The time stamp
2379 encodings that are currently supported are:
2380
2381         ENC_TIME_TIMESPEC - seconds (4 bytes) and nanoseconds (4 bytes)
2382                 of time since January 1, 1970, midnight UTC.
2383
2384         ENC_TIME_NTP - an NTP timestamp, represented as a 64-bit
2385                 unsigned fixed-point number, in seconds relative to 0h
2386                 on 1 January 1900.  The integer part is in the first 32
2387                 bits and the fraction part in the last 32 bits.
2388
2389 For other types, there is no support for proto_tree_add_item().
2390
2391 Now that definitions of fields have detailed information about bitfield
2392 fields, you can use proto_tree_add_item() with no extra processing to
2393 add bitfield values to your tree.  Here's an example.  Take the Format
2394 Identifier (FID) field in the Transmission Header (TH) portion of the SNA
2395 protocol.  The FID is the high nibble of the first byte of the TH.  The
2396 FID would be registered like this:
2397
2398         name            = "Format Identifier"
2399         abbrev          = "sna.th.fid"
2400         type            = FT_UINT8
2401         display         = BASE_HEX
2402         strings         = sna_th_fid_vals
2403         bitmask         = 0xf0
2404
2405 The bitmask contains the value which would leave only the FID if bitwise-ANDed
2406 against the parent field, the first byte of the TH.
2407
2408 The code to add the FID to the tree would be;
2409
2410         proto_tree_add_item(bf_tree, hf_sna_th_fid, tvb, offset, 1,
2411             ENC_BIG_ENDIAN);
2412
2413 The definition of the field already has the information about bitmasking
2414 and bitshifting, so it does the work of masking and shifting for us!
2415 This also means that you no longer have to create value_string structs
2416 with the values bitshifted.  The value_string for FID looks like this,
2417 even though the FID value is actually contained in the high nibble.
2418 (You'd expect the values to be 0x0, 0x10, 0x20, etc.)
2419
2420 /* Format Identifier */
2421 static const value_string sna_th_fid_vals[] = {
2422         { 0x0,  "SNA device <--> Non-SNA Device" },
2423         { 0x1,  "Subarea Node <--> Subarea Node" },
2424         { 0x2,  "Subarea Node <--> PU2" },
2425         { 0x3,  "Subarea Node or SNA host <--> Subarea Node" },
2426         { 0x4,  "?" },
2427         { 0x5,  "?" },
2428         { 0xf,  "Adjacent Subarea Nodes" },
2429         { 0,    NULL }
2430 };
2431
2432 The final implication of this is that display filters work the way you'd
2433 naturally expect them to. You'd type "sna.th.fid == 0xf" to find Adjacent
2434 Subarea Nodes. The user does not have to shift the value of the FID to
2435 the high nibble of the byte ("sna.th.fid == 0xf0") as was necessary
2436 in the past.
2437
2438 proto_tree_add_protocol_format()
2439 --------------------------------
2440 proto_tree_add_protocol_format is used to add the top-level item for the
2441 protocol when the dissector routine wants complete control over how the
2442 field and value will be represented on the GUI tree.  The ID value for
2443 the protocol is passed in as the "id" argument; the rest of the
2444 arguments are a "printf"-style format and any arguments for that format.
2445 The caller must include the name of the protocol in the format; it is
2446 not added automatically as in proto_tree_add_item().
2447
2448 proto_tree_add_none_format()
2449 ----------------------------
2450 proto_tree_add_none_format is used to add an item of type FT_NONE.
2451 The caller must include the name of the field in the format; it is
2452 not added automatically as in proto_tree_add_item().
2453
2454 proto_tree_add_bytes()
2455 proto_tree_add_time()
2456 proto_tree_add_ipxnet()
2457 proto_tree_add_ipv4()
2458 proto_tree_add_ipv6()
2459 proto_tree_add_ether()
2460 proto_tree_add_string()
2461 proto_tree_add_boolean()
2462 proto_tree_add_float()
2463 proto_tree_add_double()
2464 proto_tree_add_uint()
2465 proto_tree_add_uint64()
2466 proto_tree_add_int()
2467 proto_tree_add_int64()
2468 proto_tree_add_guid()
2469 proto_tree_add_oid()
2470 proto_tree_add_eui64()
2471 ------------------------
2472 These routines are used to add items to the protocol tree if either:
2473
2474         the value of the item to be added isn't just extracted from the
2475         packet data, but is computed from data in the packet;
2476
2477         the value was fetched into a variable.
2478
2479 The 'value' argument has the value to be added to the tree.
2480
2481 NOTE: in all cases where the 'value' argument is a pointer, a copy is
2482 made of the object pointed to; if you have dynamically allocated a
2483 buffer for the object, that buffer will not be freed when the protocol
2484 tree is freed - you must free the buffer yourself when you don't need it
2485 any more.
2486
2487 For proto_tree_add_bytes(), the 'value_ptr' argument is a pointer to a
2488 sequence of bytes.
2489
2490 For proto_tree_add_bytes_format() and proto_tree_add_bytes_format_value(), the
2491 'value_ptr' argument is a pointer to a sequence of bytes or NULL if the bytes
2492 should be taken from the given TVB using the given offset and length.
2493
2494 For proto_tree_add_time(), the 'value_ptr' argument is a pointer to an
2495 "nstime_t", which is a structure containing the time to be added; it has
2496 'secs' and 'nsecs' members, giving the integral part and the fractional
2497 part of a time in units of seconds, with 'nsecs' being the number of
2498 nanoseconds.  For absolute times, "secs" is a UNIX-style seconds since
2499 January 1, 1970, 00:00:00 GMT value.
2500
2501 For proto_tree_add_ipxnet(), the 'value' argument is a 32-bit IPX
2502 network address.
2503
2504 For proto_tree_add_ipv4(), the 'value' argument is a 32-bit IPv4
2505 address, in network byte order.
2506
2507 For proto_tree_add_ipv6(), the 'value_ptr' argument is a pointer to a
2508 128-bit IPv6 address.
2509
2510 For proto_tree_add_ether(), the 'value_ptr' argument is a pointer to a
2511 48-bit MAC address.
2512
2513 For proto_tree_add_string(), the 'value_ptr' argument is a pointer to a
2514 text string.
2515
2516 For proto_tree_add_boolean(), the 'value' argument is a 32-bit integer.
2517 It is masked and shifted as defined by the field info after which zero
2518 means "false", and non-zero means "true".
2519
2520 For proto_tree_add_float(), the 'value' argument is a 'float' in the
2521 host's floating-point format.
2522
2523 For proto_tree_add_double(), the 'value' argument is a 'double' in the
2524 host's floating-point format.
2525
2526 For proto_tree_add_uint(), the 'value' argument is a 32-bit unsigned
2527 integer value, in host byte order.  (This routine cannot be used to add
2528 64-bit integers.)
2529
2530 For proto_tree_add_uint64(), the 'value' argument is a 64-bit unsigned
2531 integer value, in host byte order.
2532
2533 For proto_tree_add_int(), the 'value' argument is a 32-bit signed
2534 integer value, in host byte order.  (This routine cannot be used to add
2535 64-bit integers.)
2536
2537 For proto_tree_add_int64(), the 'value' argument is a 64-bit signed
2538 integer value, in host byte order.
2539
2540 For proto_tree_add_guid(), the 'value_ptr' argument is a pointer to an
2541 e_guid_t structure.
2542
2543 For proto_tree_add_oid(), the 'value_ptr' argument is a pointer to an
2544 ASN.1 Object Identifier.
2545
2546 For proto_tree_add_eui64(), the 'value' argument is a 64-bit integer
2547 value
2548
2549 proto_tree_add_bytes_format()
2550 proto_tree_add_time_format()
2551 proto_tree_add_ipxnet_format()
2552 proto_tree_add_ipv4_format()
2553 proto_tree_add_ipv6_format()
2554 proto_tree_add_ether_format()
2555 proto_tree_add_string_format()
2556 proto_tree_add_boolean_format()
2557 proto_tree_add_float_format()
2558 proto_tree_add_double_format()
2559 proto_tree_add_uint_format()
2560 proto_tree_add_uint64_format()
2561 proto_tree_add_int_format()
2562 proto_tree_add_int64_format()
2563 proto_tree_add_guid_format()
2564 proto_tree_add_oid_format()
2565 proto_tree_add_eui64_format()
2566 ----------------------------
2567 These routines are used to add items to the protocol tree when the
2568 dissector routine wants complete control over how the field and value
2569 will be represented on the GUI tree.  The argument giving the value is
2570 the same as the corresponding proto_tree_add_XXX() function; the rest of
2571 the arguments are a "printf"-style format and any arguments for that
2572 format.  The caller must include the name of the field in the format; it
2573 is not added automatically as in the proto_tree_add_XXX() functions.
2574
2575 proto_tree_add_bytes_format_value()
2576 proto_tree_add_time_format_value()
2577 proto_tree_add_ipxnet_format_value()
2578 proto_tree_add_ipv4_format_value()
2579 proto_tree_add_ipv6_format_value()
2580 proto_tree_add_ether_format_value()
2581 proto_tree_add_string_format_value()
2582 proto_tree_add_boolean_format_value()
2583 proto_tree_add_float_format_value()
2584 proto_tree_add_double_format_value()
2585 proto_tree_add_uint_format_value()
2586 proto_tree_add_uint64_format_value()
2587 proto_tree_add_int_format_value()
2588 proto_tree_add_int64_format_value()
2589 proto_tree_add_guid_format_value()
2590 proto_tree_add_oid_format_value()
2591 proto_tree_add_eui64_format_value()
2592 ------------------------------------
2593
2594 These routines are used to add items to the protocol tree when the
2595 dissector routine wants complete control over how the value will be
2596 represented on the GUI tree.  The argument giving the value is the same
2597 as the corresponding proto_tree_add_XXX() function; the rest of the
2598 arguments are a "printf"-style format and any arguments for that format.
2599 With these routines, unlike the proto_tree_add_XXX_format() routines,
2600 the name of the field is added automatically as in the
2601 proto_tree_add_XXX() functions; only the value is added with the format.
2602
2603 proto_tree_add_text()
2604 ---------------------
2605 proto_tree_add_text() is used to add a label to the GUI tree.  It will
2606 contain no value, so it is not searchable in the display filter process.
2607 This function was needed in the transition from the old-style proto_tree
2608 to this new-style proto_tree so that Wireshark would still decode all
2609 protocols w/o being able to filter on all protocols and fields.
2610 Otherwise we would have had to cripple Wireshark's functionality while we
2611 converted all the old-style proto_tree calls to the new-style proto_tree
2612 calls.  In other words, you should not use this in new code unless you've got
2613 a specific reason (see below).
2614
2615 This can also be used for items with subtrees, which may not have values
2616 themselves - the items in the subtree are the ones with values.
2617
2618 For a subtree, the label on the subtree might reflect some of the items
2619 in the subtree.  This means the label can't be set until at least some
2620 of the items in the subtree have been dissected.  To do this, use
2621 'proto_item_set_text()' or 'proto_item_append_text()':
2622
2623         void
2624         proto_item_set_text(proto_item *ti, ...);
2625
2626         void
2627         proto_item_append_text(proto_item *ti, ...);
2628
2629 'proto_item_set_text()' takes as an argument the value returned by
2630 'proto_tree_add_text()', a 'printf'-style format string, and a set of
2631 arguments corresponding to '%' format items in that string, and replaces
2632 the text for the item created by 'proto_tree_add_text()' with the result
2633 of applying the arguments to the format string.
2634
2635 'proto_item_append_text()' is similar, but it appends to the text for
2636 the item the result of applying the arguments to the format string.
2637
2638 For example, early in the dissection, one might do:
2639
2640         ti = proto_tree_add_text(tree, tvb, offset, length, <label>);
2641
2642 and later do
2643
2644         proto_item_set_text(ti, "%s: %s", type, value);
2645
2646 after the "type" and "value" fields have been extracted and dissected.
2647 <label> would be a label giving what information about the subtree is
2648 available without dissecting any of the data in the subtree.
2649
2650 Note that an exception might be thrown when trying to extract the values of
2651 the items used to set the label, if not all the bytes of the item are
2652 available.  Thus, one should create the item with text that is as
2653 meaningful as possible, and set it or append additional information to
2654 it as the values needed to supply that information are extracted.
2655
2656 proto_tree_add_text_valist()
2657 ----------------------------
2658 This is like proto_tree_add_text(), but takes, as the last argument, a
2659 'va_list'; it is used to allow routines that take a printf-like
2660 variable-length list of arguments to add a text item to the protocol
2661 tree.
2662
2663 proto_tree_add_bits_item()
2664 --------------------------
2665 Adds a number of bits to the protocol tree which does not have to be byte
2666 aligned. The offset and length is in bits.
2667 Output format:
2668
2669 ..10 1010 10.. .... "value" (formatted as FT_ indicates).
2670
2671 proto_tree_add_bits_ret_val()
2672 -----------------------------
2673 Works in the same way but also returns the value of the read bits.
2674
2675 proto_tree_add_bitmask() and proto_tree_add_bitmask_text()
2676 ----------------------------------------------------------
2677 This function provides an easy to use and convenient helper function
2678 to manage many types of common bitmasks that occur in protocols.
2679
2680 This function will dissect a 1/2/3/4 byte large bitmask into its individual
2681 fields.
2682 header is an integer type and must be of type FT_[U]INT{8|16|24|32} and
2683 represents the entire width of the bitmask.
2684
2685 'header' and 'ett' are the hf fields and ett field respectively to create an
2686 expansion that covers the 1-4 bytes of the bitmask.
2687
2688 'fields' is a NULL terminated array of pointers to hf fields representing
2689 the individual subfields of the bitmask. These fields must either be integers
2690 of the same byte width as 'header' or of the type FT_BOOLEAN.
2691 Each of the entries in 'fields' will be dissected as an item under the
2692 'header' expansion and also IF the field is a boolean and IF it is set to 1,
2693 then the name of that boolean field will be printed on the 'header' expansion
2694 line.  For integer type subfields that have a value_string defined, the
2695 matched string from that value_string will be printed on the expansion line
2696 as well.
2697
2698 Example: (from the SCSI dissector)
2699         static int hf_scsi_inq_peripheral        = -1;
2700         static int hf_scsi_inq_qualifier         = -1;
2701         static int hf_scsi_inq_devtype           = -1;
2702         ...
2703         static gint ett_scsi_inq_peripheral = -1;
2704         ...
2705         static const int *peripheral_fields[] = {
2706                 &hf_scsi_inq_qualifier,
2707                 &hf_scsi_inq_devtype,
2708                 NULL
2709         };
2710         ...
2711         /* Qualifier and DeviceType */
2712         proto_tree_add_bitmask(tree, tvb, offset, hf_scsi_inq_peripheral,
2713                 ett_scsi_inq_peripheral, peripheral_fields, FALSE);
2714         offset+=1;
2715         ...
2716         { &hf_scsi_inq_peripheral,
2717           {"Peripheral", "scsi.inquiry.preipheral", FT_UINT8, BASE_HEX,
2718            NULL, 0, NULL, HFILL}},
2719         { &hf_scsi_inq_qualifier,
2720           {"Qualifier", "scsi.inquiry.qualifier", FT_UINT8, BASE_HEX,
2721            VALS (scsi_qualifier_val), 0xE0, NULL, HFILL}},
2722         { &hf_scsi_inq_devtype,
2723           {"Device Type", "scsi.inquiry.devtype", FT_UINT8, BASE_HEX,
2724            VALS (scsi_devtype_val), SCSI_DEV_BITS, NULL, HFILL}},
2725         ...
2726
2727 Which provides very pretty dissection of this one byte bitmask.
2728
2729     Peripheral: 0x05, Qualifier: Device type is connected to logical unit, Device Type: CD-ROM
2730         000. .... = Qualifier: Device type is connected to logical unit (0x00)
2731         ...0 0101 = Device Type: CD-ROM (0x05)
2732
2733 The proto_tree_add_bitmask_text() function is an extended version of
2734 the proto_tree_add_bitmask() function. In addition, it allows to:
2735 - Provide a leading text (e.g. "Flags: ") that will appear before
2736   the comma-separated list of field values
2737 - Provide a fallback text (e.g. "None") that will be appended if
2738   no fields warranted a change to the top-level title.
2739 - Using flags, specify which fields will affect the top-level title.
2740
2741 There are the following flags defined:
2742
2743   BMT_NO_APPEND - the title is taken "as-is" from the 'name' argument.
2744   BMT_NO_INT - only boolean flags are added to the title.
2745   BMT_NO_FALSE - boolean flags are only added to the title if they are set.
2746   BMT_NO_TFS - only add flag name to the title, do not use true_false_string
2747
2748 The proto_tree_add_bitmask() behavior can be obtained by providing
2749 both 'name' and 'fallback' arguments as NULL, and a flags of
2750 (BMT_NO_FALSE|BMT_NO_TFS).
2751
2752 PROTO_ITEM_SET_GENERATED()
2753 --------------------------
2754 PROTO_ITEM_SET_GENERATED is used to mark fields as not being read from the
2755 captured data directly, but inferred from one or more values.
2756
2757 One of the primary uses of this is the presentation of verification of
2758 checksums. Every IP packet has a checksum line, which can present the result
2759 of the checksum verification, if enabled in the preferences. The result is
2760 presented as a subtree, where the result is enclosed in square brackets
2761 indicating a generated field.
2762
2763   Header checksum: 0x3d42 [correct]
2764     [Good: True]
2765     [Bad: False]
2766
2767 PROTO_ITEM_SET_HIDDEN()
2768 -----------------------
2769 PROTO_ITEM_SET_HIDDEN is used to hide fields, which have already been added
2770 to the tree, from being visible in the displayed tree.
2771
2772 NOTE that creating hidden fields is actually quite a bad idea from a UI design
2773 perspective because the user (someone who did not write nor has ever seen the
2774 code) has no way of knowing that hidden fields are there to be filtered on
2775 thus defeating the whole purpose of putting them there.  A Better Way might
2776 be to add the fields (that might otherwise be hidden) to a subtree where they
2777 won't be seen unless the user opens the subtree--but they can be found if the
2778 user wants.
2779
2780 One use for hidden fields (which would be better implemented using visible
2781 fields in a subtree) follows: The caller may want a value to be
2782 included in a tree so that the packet can be filtered on this field, but
2783 the representation of that field in the tree is not appropriate.  An
2784 example is the token-ring routing information field (RIF).  The best way
2785 to show the RIF in a GUI is by a sequence of ring and bridge numbers.
2786 Rings are 3-digit hex numbers, and bridges are single hex digits:
2787
2788         RIF: 001-A-013-9-C0F-B-555
2789
2790 In the case of RIF, the programmer should use a field with no value and
2791 use proto_tree_add_none_format() to build the above representation. The
2792 programmer can then add the ring and bridge values, one-by-one, with
2793 proto_tree_add_item() and hide them with PROTO_ITEM_SET_HIDDEN() so that the
2794 user can then filter on or search for a particular ring or bridge. Here's a
2795 skeleton of how the programmer might code this.
2796
2797         char *rif;
2798         rif = create_rif_string(...);
2799
2800         proto_tree_add_none_format(tree, hf_tr_rif_label, ..., "RIF: %s", rif);
2801
2802         for(i = 0; i < num_rings; i++) {
2803                 proto_item *pi;
2804
2805                 pi = proto_tree_add_item(tree, hf_tr_rif_ring, ...,
2806                     ENC_BIG_ENDIAN);
2807                 PROTO_ITEM_SET_HIDDEN(pi);
2808         }
2809         for(i = 0; i < num_rings - 1; i++) {
2810                 proto_item *pi;
2811
2812                 pi = proto_tree_add_item(tree, hf_tr_rif_bridge, ...,
2813                     ENC_BIG_ENDIAN);
2814                 PROTO_ITEM_SET_HIDDEN(pi);
2815         }
2816
2817 The logical tree has these items:
2818
2819         hf_tr_rif_label, text="RIF: 001-A-013-9-C0F-B-555", value = NONE
2820         hf_tr_rif_ring,  hidden, value=0x001
2821         hf_tr_rif_bridge, hidden, value=0xA
2822         hf_tr_rif_ring,  hidden, value=0x013
2823         hf_tr_rif_bridge, hidden, value=0x9
2824         hf_tr_rif_ring,  hidden, value=0xC0F
2825         hf_tr_rif_bridge, hidden, value=0xB
2826         hf_tr_rif_ring,  hidden, value=0x555
2827
2828 GUI or print code will not display the hidden fields, but a display
2829 filter or "packet grep" routine will still see the values. The possible
2830 filter is then possible:
2831
2832         tr.rif_ring eq 0x013
2833
2834 PROTO_ITEM_SET_URL
2835 ------------------
2836 PROTO_ITEM_SET_URL is used to mark fields as containing a URL. This can only
2837 be done with fields of type FT_STRING(Z). If these fields are presented they
2838 are underlined, as could be done in a browser. These fields are sensitive to
2839 clicks as well, launching the configured browser with this URL as parameter.
2840
2841 1.7 Utility routines.
2842
2843 1.7.1 match_strval, match_strval_ext, val_to_str and val_to_str_ext.
2844
2845 A dissector may need to convert a value to a string, using a
2846 'value_string' structure, by hand, rather than by declaring a field with
2847 an associated 'value_string' structure; this might be used, for example,
2848 to generate a COL_INFO line for a frame.
2849
2850 'match_strval()' will do that:
2851
2852         gchar*
2853         match_strval(guint32 val, const value_string *vs)
2854
2855 It will look up the value 'val' in the 'value_string' table pointed to
2856 by 'vs', and return either the corresponding string, or NULL if the
2857 value could not be found in the table.  Note that, unless 'val' is
2858 guaranteed to be a value in the 'value_string' table ("guaranteed" as in
2859 "the code has already checked that it's one of those values" or "the
2860 table handles all possible values of the size of 'val'", not "the
2861 protocol spec says it has to be" - protocol specs do not prevent invalid
2862 packets from being put onto a network or into a purported packet capture
2863 file), you must check whether 'match_strval()' returns NULL, and arrange
2864 that its return value not be dereferenced if it's NULL. 'val_to_str()'
2865 can be used to generate a string for values not found in the table:
2866
2867         gchar*
2868         val_to_str(guint32 val, const value_string *vs, const char *fmt)
2869
2870 If the value 'val' is found in the 'value_string' table pointed to by
2871 'vs', 'val_to_str' will return the corresponding string; otherwise, it
2872 will use 'fmt' as an 'sprintf'-style format, with 'val' as an argument,
2873 to generate a string, and will return a pointer to that string.
2874 You can use it in a call to generate a COL_INFO line for a frame such as
2875
2876         col_add_fstr(COL_INFO, ", %s", val_to_str(val, table, "Unknown %d"));
2877
2878 The match_strval_ext and val_to_str_ext functions are "extended" versions
2879 of match_strval and val_to_str. They should be used for large value-string
2880 arrays which contain many entries. They implement value to string conversions
2881 which will do either a direct access or a binary search of the
2882 value string array if possible. See "Extended Value Strings" under
2883 section  1.6 "Constructing the protocol tree" for more information.
2884
2885 See epan/value_string.h for detailed information on the various value_string
2886 functions.
2887
2888
2889 1.7.2 match_strrval and rval_to_str.
2890
2891 A dissector may need to convert a range of values to a string, using a
2892 'range_string' structure.
2893
2894 'match_strrval()' will do that:
2895
2896         gchar*
2897         match_strrval(guint32 val, const range_string *rs)
2898
2899 It will look up the value 'val' in the 'range_string' table pointed to
2900 by 'rs', and return either the corresponding string, or NULL if the
2901 value could not be found in the table. Please note that its base
2902 behavior is inherited from match_strval().
2903
2904 'rval_to_str()' can be used to generate a string for values not found in
2905 the table:
2906
2907         gchar*
2908         rval_to_str(guint32 val, const range_string *rs, const char *fmt)
2909
2910 If the value 'val' is found in the 'range_string' table pointed to by
2911 'rs', 'rval_to_str' will return the corresponding string; otherwise, it
2912 will use 'fmt' as an 'sprintf'-style format, with 'val' as an argument,
2913 to generate a string, and will return a pointer to that string. Please
2914 note that its base behavior is inherited from match_strval().
2915
2916 1.8 Calling Other Dissectors.
2917
2918 As each dissector completes its portion of the protocol analysis, it
2919 is expected to create a new tvbuff of type TVBUFF_SUBSET which
2920 contains the payload portion of the protocol (that is, the bytes
2921 that are relevant to the next dissector).
2922
2923 The syntax for creating a new TVBUFF_SUBSET is:
2924
2925 next_tvb = tvb_new_subset(tvb, offset, length, reported_length)
2926
2927 Where:
2928         tvb is the tvbuff that the dissector has been working on. It
2929         can be a tvbuff of any type.
2930
2931         next_tvb is the new TVBUFF_SUBSET.
2932
2933         offset is the byte offset of 'tvb' at which the new tvbuff
2934         should start.  The first byte is the 0th byte.
2935
2936         length is the number of bytes in the new TVBUFF_SUBSET. A length
2937         argument of -1 says to use as many bytes as are available in
2938         'tvb'.
2939
2940         reported_length is the number of bytes that the current protocol
2941         says should be in the payload. A reported_length of -1 says that
2942         the protocol doesn't say anything about the size of its payload.
2943
2944
2945 An example from packet-ipx.c -
2946
2947 void
2948 dissect_ipx(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
2949 {
2950         tvbuff_t        *next_tvb;
2951         int             reported_length, available_length;
2952
2953
2954         /* Make the next tvbuff */
2955
2956 /* IPX does have a length value in the header, so calculate report_length */
2957    Set this to -1 if there isn't any length information in the protocol
2958 */
2959         reported_length = ipx_length - IPX_HEADER_LEN;
2960
2961 /* Calculate the available data in the packet,
2962    set this to -1 to use all the data in the tv_buffer
2963 */
2964         available_length = tvb_length(tvb) - IPX_HEADER_LEN;
2965
2966 /* Create the tvbuffer for the next dissector */
2967         next_tvb = tvb_new_subset(tvb, IPX_HEADER_LEN,
2968                         MIN(available_length, reported_length),
2969                         reported_length);
2970
2971 /* call the next dissector */
2972         dissector_next( next_tvb, pinfo, tree);
2973
2974
2975 1.9 Editing Makefile.common and CMakeLists.txt to add your dissector.
2976
2977 To arrange that your dissector will be built as part of Wireshark, you
2978 must add the name of the source file for your dissector to the
2979 'DISSECTOR_SRC' macro in the 'Makefile.common' file in the 'epan/dissectors'
2980 directory.  (Note that this is for modern versions of UNIX, so there
2981 is no 14-character limitation on file names, and for modern versions of
2982 Windows, so there is no 8.3-character limitation on file names.)
2983
2984 If your dissector also has its own header file or files, you must add
2985 them to the 'DISSECTOR_INCLUDES' macro in the 'Makefile.common' file in
2986 the 'epan/dissectors' directory, so that it's included when release source
2987 tarballs are built (otherwise, the source in the release tarballs won't
2988 compile).
2989
2990 In addition to the above, you should add your dissector source file name
2991 to the DISSECTOR_SRC section of epan/CMakeLists.txt
2992
2993
2994 1.10 Using the SVN source code tree.
2995
2996   See <http://www.wireshark.org/develop.html>
2997
2998
2999 1.10a Using git with the SVN source code tree.
3000
3001   Install git and the git-svn package.
3002   Run "mkdir git; cd git; git svn clone <svn-url>", e.g. if you are using
3003   the anonymous svn tree, run
3004   "git svn clone http://anonsvn.wireshark.org/wireshark/trunk/"
3005
3006   After that, a typical workflow may look like this (from "man git-svn"):
3007
3008   # Clone a repo (like git clone):
3009           git svn clone http://svn.example.com/project/trunk
3010   # Enter the newly cloned directory:
3011           cd trunk
3012   # You should be on master branch, double-check with ┬┤git branch┬┤
3013           git branch
3014   # Do some work and commit locally to git:
3015           git commit ...
3016   # Something is committed to SVN, rebase your local changes against the
3017   # latest changes in SVN:
3018           git svn rebase
3019   # Now commit your changes (that were committed previously using git) to SVN
3020   # as well as automatically updating your working HEAD:
3021           git svn dcommit
3022   # Append svn:ignore settings to the default git exclude file:
3023           git svn show-ignore >> .git/info/exclude
3024
3025
3026 1.11 Submitting code for your new dissector.
3027
3028   - VERIFY that your dissector code does not use prohibited or deprecated APIs
3029     as follows:
3030     perl <wireshark_root>/tools/checkAPIs.pl <source-filename(s)>
3031
3032   - TEST YOUR DISSECTOR BEFORE SUBMITTING IT.
3033     Use fuzz-test.sh and/or randpkt against your dissector.  These are
3034     described at <http://wiki.wireshark.org/FuzzTesting>.
3035
3036   - Subscribe to <mailto:wireshark-dev[AT]wireshark.org> by sending an email to
3037     <mailto:wireshark-dev-request[AT]wireshark.org?body="help"> or visiting
3038     <http://www.wireshark.org/lists/>.
3039
3040   - 'svn add' all the files of your new dissector.
3041
3042   - 'svn diff' the workspace and save the result to a file.
3043
3044   - Edit the diff file - remove any changes unrelated to your new dissector,
3045     e.g. changes in config.nmake
3046
3047   - Submit a bug report to the Wireshark bug database, found at
3048     <http://bugs.wireshark.org>, qualified as an enhancement and attach your
3049     diff file there. Set the review request flag to '?' so it will pop up in
3050     the patch review list.
3051
3052   - Create a Wiki page on the protocol at <http://wiki.wireshark.org>.
3053     A template is provided so it is easy to setup in a consistent style.
3054       See: <http://wiki.wireshark.org/HowToEdit>
3055       and  <http://wiki.wireshark.org/ProtocolReference>
3056
3057   - If possible, add sample capture files to the sample captures page at
3058     <http://wiki.wireshark.org/SampleCaptures>.  These files are used by
3059     the automated build system for fuzz testing.
3060
3061   - If you find that you are contributing a lot to wireshark on an ongoing
3062     basis you can request to become a committer which will allow you to
3063     commit files to subversion directly.
3064
3065 2. Advanced dissector topics.
3066
3067 2.1 Introduction.
3068
3069 Some of the advanced features are being worked on constantly. When using them
3070 it is wise to check the relevant header and source files for additional details.
3071
3072 2.2 Following "conversations".
3073
3074 In wireshark a conversation is defined as a series of data packets between two
3075 address:port combinations.  A conversation is not sensitive to the direction of
3076 the packet.  The same conversation will be returned for a packet bound from
3077 ServerA:1000 to ClientA:2000 and the packet from ClientA:2000 to ServerA:1000.
3078
3079 2.2.1 Conversation Routines
3080
3081 There are six routines that you will use to work with a conversation:
3082 conversation_new, find_conversation, conversation_add_proto_data,
3083 conversation_get_proto_data, conversation_delete_proto_data,
3084 and conversation_set_dissector.
3085
3086
3087 2.2.1.1 The conversation_init function.
3088
3089 This is an internal routine for the conversation code.  As such you
3090 will not have to call this routine.  Just be aware that this routine is
3091 called at the start of each capture and before the packets are filtered
3092 with a display filter.  The routine will destroy all stored
3093 conversations.  This routine does NOT clean up any data pointers that are
3094 passed in the conversation_add_proto_data 'data' variable.  You are
3095 responsible for this clean up if you pass a malloc'ed pointer
3096 in this variable.
3097
3098 See item 2.2.1.5 for more information about use of the 'data' pointer.
3099
3100
3101 2.2.1.2 The conversation_new function.
3102
3103 This routine will create a new conversation based upon two address/port
3104 pairs.  If you want to associate with the conversation a pointer to a
3105 private data structure you must use the conversation_add_proto_data
3106 function.  The ptype variable is used to differentiate between
3107 conversations over different protocols, i.e. TCP and UDP.  The options
3108 variable is used to define a conversation that will accept any destination
3109 address and/or port.  Set options = 0 if the destination port and address
3110 are know when conversation_new is called.  See section 2.4 for more
3111 information on usage of the options parameter.
3112
3113 The conversation_new prototype:
3114         conversation_t *conversation_new(guint32 setup_frame, address *addr1,
3115             address *addr2, port_type ptype, guint32 port1, guint32 port2,
3116             guint options);
3117
3118 Where:
3119         guint32 setup_frame = The lowest numbered frame for this conversation
3120         address* addr1      = first data packet address
3121         address* addr2      = second data packet address
3122         port_type ptype     = port type, this is defined in packet.h
3123         guint32 port1       = first data packet port
3124         guint32 port2       = second data packet port
3125         guint options       = conversation options, NO_ADDR2 and/or NO_PORT2
3126
3127 setup_frame indicates the first frame for this conversation, and is used to
3128 distinguish multiple conversations with the same addr1/port1 and addr2/port2
3129 pair that occur within the same capture session.
3130
3131 "addr1" and "port1" are the first address/port pair; "addr2" and "port2"
3132 are the second address/port pair.  A conversation doesn't have source
3133 and destination address/port pairs - packets in a conversation go in
3134 both directions - so "addr1"/"port1" may be the source or destination
3135 address/port pair; "addr2"/"port2" would be the other pair.
3136
3137 If NO_ADDR2 is specified, the conversation is set up so that a
3138 conversation lookup will match only the "addr1" address; if NO_PORT2 is
3139 specified, the conversation is set up so that a conversation lookup will
3140 match only the "port1" port; if both are specified, i.e.
3141 NO_ADDR2|NO_PORT2, the conversation is set up so that the lookup will
3142 match only the "addr1"/"port1" address/port pair.  This can be used if a
3143 packet indicates that, later in the capture, a conversation will be
3144 created using certain addresses and ports, in the case where the packet
3145 doesn't specify the addresses and ports of both sides.
3146
3147 2.2.1.3 The find_conversation function.
3148
3149 Call this routine to look up a conversation.  If no conversation is found,
3150 the routine will return a NULL value.
3151
3152 The find_conversation prototype:
3153
3154         conversation_t *find_conversation(guint32 frame_num, address *addr_a,
3155             address *addr_b, port_type ptype, guint32 port_a, guint32 port_b,
3156             guint options);
3157
3158 Where:
3159         guint32 frame_num = a frame number to match
3160         address* addr_a = first address
3161         address* addr_b = second address
3162         port_type ptype = port type
3163         guint32 port_a  = first data packet port
3164         guint32 port_b  = second data packet port
3165         guint options   = conversation options, NO_ADDR_B and/or NO_PORT_B
3166
3167 frame_num is a frame number to match. The conversation returned is where
3168         (frame_num >= conversation->setup_frame
3169         && frame_num < conversation->next->setup_frame)
3170 Suppose there are a total of 3 conversations (A, B, and C) that match
3171 addr_a/port_a and addr_b/port_b, where the setup_frame used in
3172 conversation_new() for A, B and C are 10, 50, and 100 respectively. The
3173 frame_num passed in find_conversation is compared to the setup_frame of each
3174 conversation. So if (frame_num >= 10 && frame_num < 50), conversation A is
3175 returned. If (frame_num >= 50 && frame_num < 100), conversation B is returned.
3176 If (frame_num >= 100) conversation C is returned.
3177
3178 "addr_a" and "port_a" are the first address/port pair; "addr_b" and
3179 "port_b" are the second address/port pair.  Again, as a conversation
3180 doesn't have source and destination address/port pairs, so
3181 "addr_a"/"port_a" may be the source or destination address/port pair;
3182 "addr_b"/"port_b" would be the other pair.  The search will match the
3183 "a" address/port pair against both the "1" and "2" address/port pairs,
3184 and match the "b" address/port pair against both the "2" and "1"
3185 address/port pairs; you don't have to worry about which side the "a" or
3186 "b" pairs correspond to.
3187
3188 If the NO_ADDR_B flag was specified to "find_conversation()", the
3189 "addr_b" address will be treated as matching any "wildcarded" address;
3190 if the NO_PORT_B flag was specified, the "port_b" port will be treated
3191 as matching any "wildcarded" port.  If both flags are specified, i.e.
3192 NO_ADDR_B|NO_PORT_B, the "addr_b" address will be treated as matching
3193 any "wildcarded" address and the "port_b" port will be treated as
3194 matching any "wildcarded" port.
3195
3196
3197 2.2.1.4 The find_or_create_conversation function.
3198
3199 This convenience function will create find an existing conversation (by calling
3200 find_conversation()) and, if a conversation does not already exist, create a
3201 new conversation by calling conversation_new().
3202
3203 The find_or_create_conversation prototype:
3204
3205         extern conversation_t *find_or_create_conversation(packet_info *pinfo);
3206
3207 Where:
3208         packet_info *pinfo = the packet_info structure
3209
3210 The frame number and the addresses necessary for find_conversation() and
3211 conversation_new() are taken from the pinfo structure (as is commonly done)
3212 and no 'options' are used.
3213
3214
3215 2.2.1.5 The conversation_add_proto_data function.
3216
3217 Once you have created a conversation with conversation_new, you can
3218 associate data with it using this function.
3219
3220 The conversation_add_proto_data prototype:
3221
3222         void conversation_add_proto_data(conversation_t *conv, int proto,
3223                 void *proto_data);
3224
3225 Where:
3226         conversation_t *conv = the conversation in question
3227         int proto            = registered protocol number
3228         void *data           = dissector data structure
3229
3230 "conversation" is the value returned by conversation_new.  "proto" is a
3231 unique protocol number created with proto_register_protocol.  Protocols
3232 are typically registered in the proto_register_XXXX section of your
3233 dissector.  "data" is a pointer to the data you wish to associate with the
3234 conversation.  "data" usually points to "se_alloc'd" memory; the
3235 memory will be automatically freed each time a new dissection begins
3236 and thus need not be managed (freed) by the dissector.
3237 Using the protocol number allows several dissectors to
3238 associate data with a given conversation.
3239
3240
3241 2.2.1.6 The conversation_get_proto_data function.
3242
3243 After you have located a conversation with find_conversation, you can use
3244 this function to retrieve any data associated with it.
3245
3246 The conversation_get_proto_data prototype:
3247
3248         void *conversation_get_proto_data(conversation_t *conv, int proto);
3249
3250 Where:
3251         conversation_t *conv = the conversation in question
3252         int proto            = registered protocol number
3253
3254 "conversation" is the conversation created with conversation_new.  "proto"
3255 is a unique protocol number created with proto_register_protocol,
3256 typically in the proto_register_XXXX portion of a dissector.  The function
3257 returns a pointer to the data requested, or NULL if no data was found.
3258
3259
3260 2.2.1.7 The conversation_delete_proto_data function.
3261
3262 After you are finished with a conversation, you can remove your association
3263 with this function.  Please note that ONLY the conversation entry is
3264 removed.  If you have allocated any memory for your data (other than with se_alloc),
3265  you must free it as well.
3266
3267 The conversation_delete_proto_data prototype:
3268
3269         void conversation_delete_proto_data(conversation_t *conv, int proto);
3270
3271 Where:
3272         conversation_t *conv = the conversation in question
3273         int proto            = registered protocol number
3274
3275 "conversation" is the conversation created with conversation_new.  "proto"
3276 is a unique protocol number created with proto_register_protocol,
3277 typically in the proto_register_XXXX portion of a dissector.
3278
3279 2.2.1.8 The conversation_set_dissector function
3280
3281 This function sets the protocol dissector to be invoked whenever
3282 conversation parameters (addresses, port_types, ports, etc) are matched
3283 during the dissection of a packet.
3284
3285 The conversation_set_dissector prototype:
3286
3287         void conversation_set_dissector(conversation_t *conversation, const dissector_handle_t handle);
3288
3289 Where:
3290         conversation_t *conv = the conversation in question
3291         const dissector_handle_t handle = the dissector handle.
3292
3293
3294 2.2.2 Using timestamps relative to the conversation
3295
3296 There is a framework to calculate timestamps relative to the start of the
3297 conversation. First of all the timestamp of the first packet that has been
3298 seen in the conversation must be kept in the protocol data to be able
3299 to calculate the timestamp of the current packet relative to the start
3300 of the conversation. The timestamp of the last packet that was seen in the
3301 conversation should also be kept in the protocol data. This way the
3302 delta time between the current packet and the previous packet in the
3303 conversation can be calculated.
3304
3305 So add the following items to the struct that is used for the protocol data:
3306
3307   nstime_t      ts_first;
3308   nstime_t      ts_prev;
3309
3310 The ts_prev value should only be set during the first run through the
3311 packets (ie pinfo->fd->flags.visited is false).
3312
3313 Next step is to use the per-packet information (described in section 2.5)
3314 to keep the calculated delta timestamp, as it can only be calculated
3315 on the first run through the packets. This is because a packet can be
3316 selected in random order once the whole file has been read.
3317
3318 After calculating the conversation timestamps, it is time to put them in
3319 the appropriate columns with the function 'col_set_time' (described in
3320 section 1.5.9). There are two columns for conversation timestamps:
3321
3322 COL_REL_CONV_TIME,  /* Relative time to beginning of conversation */
3323 COL_DELTA_CONV_TIME,/* Delta time to last frame in conversation */
3324
3325 Last but not least, there MUST be a preference in each dissector that
3326 uses conversation timestamps that makes it possible to enable and
3327 disable the calculation of conversation timestamps. The main argument
3328 for this is that a higher level conversation is able to overwrite
3329 the values of lower level conversations in these two columns. Being
3330 able to actively select which protocols may overwrite the conversation
3331 timestamp columns gives the user the power to control these columns.
3332 (A second reason is that conversation timestamps use the p