Fix a spelling mistake. Wrap a few long lines.
[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-initalizing 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 usign 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), and 64-bit integers (guint64):
1204
1205 guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
1206 guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
1207 guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
1208 guint64 tvb_get_ntoh40(tvbuff_t*, gint offset);
1209 guint64 tvb_get_ntoh48(tvbuff_t*, gint offset);
1210 guint64 tvb_get_ntoh56(tvbuff_t*, gint offset);
1211 guint64 tvb_get_ntoh64(tvbuff_t*, gint offset);
1212
1213 Network-to-host-order accessors for single-precision and
1214 double-precision IEEE floating-point numbers:
1215
1216 gfloat tvb_get_ntohieee_float(tvbuff_t*, gint offset);
1217 gdouble tvb_get_ntohieee_double(tvbuff_t*, gint offset);
1218
1219 Little-Endian-to-host-order accessors for 16-bit integers (guint16),
1220 24-bit integers, 32-bit integers (guint32), and 64-bit integers
1221 (guint64):
1222
1223 guint16 tvb_get_letohs(tvbuff_t*, gint offset);
1224 guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
1225 guint32 tvb_get_letohl(tvbuff_t*, gint offset);
1226 guint64 tvb_get_letoh40(tvbuff_t*, gint offset);
1227 guint64 tvb_get_letoh48(tvbuff_t*, gint offset);
1228 guint64 tvb_get_letoh56(tvbuff_t*, gint offset);
1229 guint64 tvb_get_letoh64(tvbuff_t*, gint offset);
1230
1231 Little-Endian-to-host-order accessors for single-precision and
1232 double-precision IEEE floating-point numbers:
1233
1234 gfloat tvb_get_letohieee_float(tvbuff_t*, gint offset);
1235 gdouble tvb_get_letohieee_double(tvbuff_t*, gint offset);
1236
1237 Accessors for IPv4 and IPv6 addresses:
1238
1239 guint32 tvb_get_ipv4(tvbuff_t*, gint offset);
1240 void tvb_get_ipv6(tvbuff_t*, gint offset, struct e_in6_addr *addr);
1241
1242 NOTE: IPv4 addresses are not to be converted to host byte order before
1243 being passed to "proto_tree_add_ipv4()".  You should use "tvb_get_ipv4()"
1244 to fetch them, not "tvb_get_ntohl()" *OR* "tvb_get_letohl()" - don't,
1245 for example, try to use "tvb_get_ntohl()", find that it gives you the
1246 wrong answer on the PC on which you're doing development, and try
1247 "tvb_get_letohl()" instead, as "tvb_get_letohl()" will give the wrong
1248 answer on big-endian machines.
1249
1250 Accessors for GUID:
1251
1252 void tvb_get_ntohguid(tvbuff_t *, gint offset, e_guid_t *guid);
1253 void tvb_get_letohguid(tvbuff_t *, gint offset, e_guid_t *guid);
1254
1255 String accessors:
1256
1257 guint8 *tvb_get_string(tvbuff_t*, gint offset, gint length);
1258 gchar  *tvb_get_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
1259 guint8 *tvb_get_ephemeral_string(tvbuff_t*, gint offset, gint length);
1260 gchar  *tvb_get_ephemeral_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
1261 guint8 *tvb_get_seasonal_string(tvbuff_t*, gint offset, gint length);
1262
1263 Returns a null-terminated buffer containing data from the specified
1264 tvbuff, starting at the specified offset, and containing the specified
1265 length worth of characters (the length of the buffer will be length+1,
1266 as it includes a null character to terminate the string).
1267
1268 tvb_get_string() returns a buffer allocated by g_malloc() so you must
1269 g_free() it when you are finished with the string. Failure to g_free() this
1270 buffer will lead to memory leaks.
1271
1272 tvb_get_unicode_string() is a unicode (UTF-16) version of above.  This
1273 is intended for reading UTF-16 unicode strings out of a tvbuff and
1274 returning them as a UTF-8 string for use in Wireshark.  The offset and
1275 returned length pointer are in bytes, not UTF-16 characters.
1276
1277 tvb_get_ephemeral_string() returns a buffer allocated from a special heap
1278 with a lifetime until the next packet is dissected. You do not need to
1279 free() this buffer, it will happen automatically once the next packet is
1280 dissected.
1281
1282 tvb_get_ephemeral_unicode_string() is a unicode (UTF-16) version of above.
1283 This is intended for reading UTF-16 unicode strings out of a tvbuff and
1284 returning them as a UTF-8 string for use in Wireshark.  The offset and
1285 returned length pointer are in bytes, not UTF-16 characters.
1286
1287 tvb_get_seasonal_string() returns a buffer allocated from a special heap
1288 with a lifetime of the current capture session. You do not need to
1289 free() this buffer, it will happen automatically once the a new capture or
1290 file is opened.
1291
1292 guint8 *tvb_get_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1293 const guint8 *tvb_get_const stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1294 guint8 *tvb_get_ephemeral_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1295 gchar  *tvb_get_ephemeral_unicode_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp, const guint encoding);
1296 guint8 *tvb_get_seasonal_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1297
1298 Returns a null-terminated buffer containing data from the specified tvbuff,
1299 starting at the specified offset, and containing all characters from the
1300 tvbuff up to and including a terminating null character in the tvbuff.
1301 "*lengthp" will be set to the length of the string, including the terminating
1302 null.
1303
1304 tvb_get_stringz() returns a buffer allocated by g_malloc() so you must
1305 g_free() it when you are finished with the string. Failure to g_free() this
1306 buffer will lead to memory leaks.
1307
1308 tvb_get_const_stringz() returns a pointer to the (const) string in the tvbuff.
1309 You do not need to free() this buffer, it will happen automatically once the
1310 next packet is dissected.  This function is slightly more efficient than the
1311 others because it does not allocate memory and copy the string.
1312
1313 tvb_get_ephemeral_stringz() returns a buffer allocated from a special heap
1314 with a lifetime until the next packet is dissected. You do not need to
1315 free() this buffer, it will happen automatically once the next packet is
1316 dissected.
1317
1318 tvb_get_ephemeral_unicode_stringz() is a unicode (UTF-16) version of
1319 above.  This is intended for reading UTF-16 unicode strings out of a tvbuff
1320 and returning them as a UTF-8 string for use in Wireshark.  The offset and
1321 returned length pointer are in bytes, not UTF-16 characters.
1322
1323 tvb_get_seasonal_stringz() returns a buffer allocated from a special heap
1324 with a lifetime of the current capture session. You do not need to
1325 free() this buffer, it will happen automatically once the a new capture or
1326 file is opened.
1327
1328 tvb_fake_unicode() has been superseded by tvb_get_unicode_string(), which
1329 properly handles Unicode (UTF-16) strings by converting them to UTF-8.
1330
1331 tvb_get_ephemeral_faked_unicode() has been superseded by
1332 tvb_get_ephemeral_string(), which properly handles Unicode (UTF-16) strings by
1333 converting them to UTF-8.
1334
1335 Byte Array Accessors:
1336
1337 gchar *tvb_bytes_to_str(tvbuff_t *tvb, gint offset, gint len);
1338
1339 Formats a bunch of data from a tvbuff as bytes, returning a pointer
1340 to the string with the data formatted as two hex digits for each byte.
1341 The string pointed to is stored in an "ep_alloc'd" buffer which will be freed
1342 before the next frame is dissected. The formatted string will contain the hex digits
1343 for at most the first 16 bytes of the data. If len is greater than 16 bytes, a
1344 trailing "..." will be added to the string.
1345
1346 gchar *tvb_bytes_to_str_punct(tvbuff_t *tvb, gint offset, gint len, gchar punct);
1347
1348 This function is similar to tvb_bytes_to_str(...) except that 'punct' is inserted
1349 between the hex representation of each byte.
1350
1351 gchar *tvb_bcd_dig_to_ep_str(tvbuff_t *tvb, const gint offset, const gint len, dgt_set_t *dgt, gboolean skip_first);
1352
1353 Given a tvbuff, an offset into the tvbuff, and a length that starts
1354 at that offset (which may be -1 for "all the way to the end of the
1355 tvbuff"), fetch BCD encoded digits from a tvbuff starting from either
1356 the low or high half byte, formating the digits according to an input digit set,
1357 if NUll a default digit set of 0-9 returning "?" for overdecadic digits will be used.
1358 A pointer to the EP allocated string will be returned.
1359 Note: a tvbuff content of 0xf is considered a 'filler' and will end the conversion.
1360
1361 Copying memory:
1362 guint8* tvb_memcpy(tvbuff_t*, guint8* target, gint offset, gint length);
1363
1364 Copies into the specified target the specified length's worth of data
1365 from the specified tvbuff, starting at the specified offset.
1366
1367 guint8* tvb_memdup(tvbuff_t*, gint offset, gint length);
1368 guint8* ep_tvb_memdup(tvbuff_t*, gint offset, gint length);
1369
1370 Returns a buffer, allocated with "g_malloc()", containing the specified
1371 length's worth of data from the specified tvbuff, starting at the
1372 specified offset. The ephemeral variant is freed automatically after the
1373 packet is dissected.
1374
1375 Pointer-retrieval:
1376 /* WARNING! This function is possibly expensive, temporarily allocating
1377  * another copy of the packet data. Furthermore, it's dangerous because once
1378  * this pointer is given to the user, there's no guarantee that the user will
1379  * honor the 'length' and not overstep the boundaries of the buffer.
1380  */
1381 guint8* tvb_get_ptr(tvbuff_t*, gint offset, gint length);
1382
1383 The reason that tvb_get_ptr() might have to allocate a copy of its data
1384 only occurs with TVBUFF_COMPOSITES, data that spans multiple tvbuffers.
1385 If the user requests a pointer to a range of bytes that span the member
1386 tvbuffs that make up the TVBUFF_COMPOSITE, the data will have to be
1387 copied to another memory region to assure that all the bytes are
1388 contiguous.
1389
1390
1391
1392 1.5 Functions to handle columns in the traffic summary window.
1393
1394 The topmost pane of the main window is a list of the packets in the
1395 capture, possibly filtered by a display filter.
1396
1397 Each line corresponds to a packet, and has one or more columns, as
1398 configured by the user.
1399
1400 Many of the columns are handled by code outside individual dissectors;
1401 most dissectors need only specify the value to put in the "Protocol" and
1402 "Info" columns.
1403
1404 Columns are specified by COL_ values; the COL_ value for the "Protocol"
1405 field, typically giving an abbreviated name for the protocol (but not
1406 the all-lower-case abbreviation used elsewhere) is COL_PROTOCOL, and the
1407 COL_ value for the "Info" field, giving a summary of the contents of the
1408 packet for that protocol, is COL_INFO.
1409
1410 The value for a column can be specified with one of several functions,
1411 all of which take the 'fd' argument to the dissector as their first
1412 argument, and the COL_ value for the column as their second argument.
1413
1414 1.5.1 The col_set_str function.
1415
1416 'col_set_str' takes a string as its third argument, and sets the value
1417 for the column to that value.  It assumes that the pointer passed to it
1418 points to a string constant or a static "const" array, not to a
1419 variable, as it doesn't copy the string, it merely saves the pointer
1420 value; the argument can itself be a variable, as long as it always
1421 points to a string constant or a static "const" array.
1422
1423 It is more efficient than 'col_add_str' or 'col_add_fstr'; however, if
1424 the dissector will be using 'col_append_str' or 'col_append_fstr" to
1425 append more information to the column, the string will have to be copied
1426 anyway, so it's best to use 'col_add_str' rather than 'col_set_str' in
1427 that case.
1428
1429 For example, to set the "Protocol" column
1430 to "PROTOABBREV":
1431
1432         col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
1433
1434
1435 1.5.2 The col_add_str function.
1436
1437 'col_add_str' takes a string as its third argument, and sets the value
1438 for the column to that value.  It takes the same arguments as
1439 'col_set_str', but copies the string, so that if the string is, for
1440 example, an automatic variable that won't remain in scope when the
1441 dissector returns, it's safe to use.
1442
1443
1444 1.5.3 The col_add_fstr function.
1445
1446 'col_add_fstr' takes a 'printf'-style format string as its third
1447 argument, and 'printf'-style arguments corresponding to '%' format
1448 items in that string as its subsequent arguments.  For example, to set
1449 the "Info" field to "<XXX> request, <N> bytes", where "reqtype" is a
1450 string containing the type of the request in the packet and "n" is an
1451 unsigned integer containing the number of bytes in the request:
1452
1453         col_add_fstr(pinfo->cinfo, COL_INFO, "%s request, %u bytes",
1454                      reqtype, n);
1455
1456 Don't use 'col_add_fstr' with a format argument of just "%s" -
1457 'col_add_str', or possibly even 'col_set_str' if the string that matches
1458 the "%s" is a static constant string, will do the same job more
1459 efficiently.
1460
1461
1462 1.5.4 The col_clear function.
1463
1464 If the Info column will be filled with information from the packet, that
1465 means that some data will be fetched from the packet before the Info
1466 column is filled in.  If the packet is so small that the data in
1467 question cannot be fetched, the routines to fetch the data will throw an
1468 exception (see the comment at the beginning about tvbuffers improving
1469 the handling of short packets - the tvbuffers keep track of how much
1470 data is in the packet, and throw an exception on an attempt to fetch
1471 data past the end of the packet, so that the dissector won't process
1472 bogus data), causing the Info column not to be filled in.
1473
1474 This means that the Info column will have data for the previous
1475 protocol, which would be confusing if, for example, the Protocol column
1476 had data for this protocol.
1477
1478 Therefore, before a dissector fetches any data whatsoever from the
1479 packet (unless it's a heuristic dissector fetching data to determine
1480 whether the packet is one that it should dissect, in which case it
1481 should check, before fetching the data, whether there's any data to
1482 fetch; if there isn't, it should return FALSE), it should set the
1483 Protocol column and the Info column.
1484
1485 If the Protocol column will ultimately be set to, for example, a value
1486 containing a protocol version number, with the version number being a
1487 field in the packet, the dissector should, before fetching the version
1488 number field or any other field from the packet, set it to a value
1489 without a version number, using 'col_set_str', and should later set it
1490 to a value with the version number after it's fetched the version
1491 number.
1492
1493 If the Info column will ultimately be set to a value containing
1494 information from the packet, the dissector should, before fetching any
1495 fields from the packet, clear the column using 'col_clear' (which is
1496 more efficient than clearing it by calling 'col_set_str' or
1497 'col_add_str' with a null string), and should later set it to the real
1498 string after it's fetched the data to use when doing that.
1499
1500
1501 1.5.5 The col_append_str function.
1502
1503 Sometimes the value of a column, especially the "Info" column, can't be
1504 conveniently constructed at a single point in the dissection process;
1505 for example, it might contain small bits of information from many of the
1506 fields in the packet.  'col_append_str' takes, as arguments, the same
1507 arguments as 'col_add_str', but the string is appended to the end of the
1508 current value for the column, rather than replacing the value for that
1509 column.  (Note that no blank separates the appended string from the
1510 string to which it is appended; if you want a blank there, you must add
1511 it yourself as part of the string being appended.)
1512
1513
1514 1.5.6 The col_append_fstr function.
1515
1516 'col_append_fstr' is to 'col_add_fstr' as 'col_append_str' is to
1517 'col_add_str' - it takes, as arguments, the same arguments as
1518 'col_add_fstr', but the formatted string is appended to the end of the
1519 current value for the column, rather than replacing the value for that
1520 column.
1521
1522 1.5.7 The col_append_sep_str and col_append_sep_fstr functions.
1523
1524 In specific situations the developer knows that a column's value will be
1525 created in a stepwise manner, where the appended values are listed. Both
1526 'col_append_sep_str' and 'col_append_sep_fstr' functions will add an item
1527 separator between two consecutive items, and will not add the separator at the
1528 beginning of the column. The remainder of the work both functions do is
1529 identical to what 'col_append_str' and 'col_append_fstr' do.
1530
1531 1.5.8 The col_set_fence and col_prepend_fence_fstr functions.
1532
1533 Sometimes a dissector may be called multiple times for different PDUs in the
1534 same frame (for example in the case of SCTP chunk bundling: several upper
1535 layer data packets may be contained in one SCTP packet).  If the upper layer
1536 dissector calls 'col_set_str()' or 'col_clear()' on the Info column when it
1537 begins dissecting each of those PDUs then when the frame is fully dissected
1538 the Info column would contain only the string from the last PDU in the frame.
1539 The 'col_set_fence' function erects a "fence" in the column that prevents
1540 subsequent 'col_...' calls from clearing the data currently in that column.
1541 For example, the SCTP dissector calls 'col_set_fence' on the Info column
1542 after it has called any subdissectors for that chunk so that subdissectors
1543 of any subsequent chunks may only append to the Info column.
1544 'col_prepend_fence_fstr' prepends data before a fence (moving it if
1545 necessary).  It will create a fence at the end of the prepended data if the
1546 fence does not already exist.
1547
1548
1549 1.5.9 The col_set_time function.
1550
1551 The 'col_set_time' function takes an nstime value as its third argument.
1552 This nstime value is a relative value and will be added as such to the
1553 column. The fourth argument is the filtername holding this value. This
1554 way, rightclicking on the column makes it possible to build a filter
1555 based on the time-value.
1556
1557 For example:
1558
1559         nstime_delta(&ts, &pinfo->fd->abs_ts, &tcpd->ts_first);
1560         col_set_time(pinfo->cinfo, COL_REL_CONV_TIME, &ts, "tcp.time_relative");
1561
1562
1563 1.6 Constructing the protocol tree.
1564
1565 The middle pane of the main window, and the topmost pane of a packet
1566 popup window, are constructed from the "protocol tree" for a packet.
1567
1568 The protocol tree, or proto_tree, is a GNode, the N-way tree structure
1569 available within GLIB. Of course the protocol dissectors don't care
1570 what a proto_tree really is; they just pass the proto_tree pointer as an
1571 argument to the routines which allow them to add items and new branches
1572 to the tree.
1573
1574 When a packet is selected in the packet-list pane, or a packet popup
1575 window is created, a new logical protocol tree (proto_tree) is created.
1576 The pointer to the proto_tree (in this case, 'protocol tree'), is passed
1577 to the top-level protocol dissector, and then to all subsequent protocol
1578 dissectors for that packet, and then the GUI tree is drawn via
1579 proto_tree_draw().
1580
1581 The logical proto_tree needs to know detailed information about the protocols
1582 and fields about which information will be collected from the dissection
1583 routines. By strictly defining (or "typing") the data that can be attached to a
1584 proto tree, searching and filtering becomes possible.  This means that for
1585 every protocol and field (which I also call "header fields", since they are
1586 fields in the protocol headers) which might be attached to a tree, some
1587 information is needed.
1588
1589 Every dissector routine will need to register its protocols and fields
1590 with the central protocol routines (in proto.c). At first I thought I
1591 might keep all the protocol and field information about all the
1592 dissectors in one file, but decentralization seemed like a better idea.
1593 That one file would have gotten very large; one small change would have
1594 required a re-compilation of the entire file. Also, by allowing
1595 registration of protocols and fields at run-time, loadable modules of
1596 protocol dissectors (perhaps even user-supplied) is feasible.
1597
1598 To do this, each protocol should have a register routine, which will be
1599 called when Wireshark starts.  The code to call the register routines is
1600 generated automatically; to arrange that a protocol's register routine
1601 be called at startup:
1602
1603         the file containing a dissector's "register" routine must be
1604         added to "DISSECTOR_SRC" in "epan/dissectors/Makefile.common"
1605         (and in "epan/CMakeLists.txt");
1606
1607         the "register" routine must have a name of the form
1608         "proto_register_XXX";
1609
1610         the "register" routine must take no argument, and return no
1611         value;
1612
1613         the "register" routine's name must appear in the source file
1614         either at the beginning of the line, or preceded only by "void "
1615         at the beginning of the line (that would typically be the
1616         definition) - other white space shouldn't cause a problem, e.g.:
1617
1618 void proto_register_XXX(void) {
1619
1620         ...
1621
1622 }
1623
1624 and
1625
1626 void
1627 proto_register_XXX( void )
1628 {
1629
1630         ...
1631
1632 }
1633
1634         and so on should work.
1635
1636 For every protocol or field that a dissector wants to register, a variable of
1637 type int needs to be used to keep track of the protocol. The IDs are
1638 needed for establishing parent/child relationships between protocols and
1639 fields, as well as associating data with a particular field so that it
1640 can be stored in the logical tree and displayed in the GUI protocol
1641 tree.
1642
1643 Some dissectors will need to create branches within their tree to help
1644 organize header fields. These branches should be registered as header
1645 fields. Only true protocols should be registered as protocols. This is
1646 so that a display filter user interface knows how to distinguish
1647 protocols from fields.
1648
1649 A protocol is registered with the name of the protocol and its
1650 abbreviation.
1651
1652 Here is how the frame "protocol" is registered.
1653
1654         int proto_frame;
1655
1656         proto_frame = proto_register_protocol (
1657                 /* name */            "Frame",
1658                 /* short name */      "Frame",
1659                 /* abbrev */          "frame" );
1660
1661 A header field is also registered with its name and abbreviation, but
1662 information about its data type is needed. It helps to look at
1663 the header_field_info struct to see what information is expected:
1664
1665 struct header_field_info {
1666         const char                      *name;
1667         const char                      *abbrev;
1668         enum ftenum                     type;
1669         int                             display;
1670         const void                      *strings;
1671         guint32                         bitmask;
1672         const char                      *blurb;
1673         .....
1674 };
1675
1676 name
1677 ----
1678 A string representing the name of the field. This is the name
1679 that will appear in the graphical protocol tree.  It must be a non-empty
1680 string.
1681
1682 abbrev
1683 ------
1684 A string with an abbreviation of the field. We concatenate the
1685 abbreviation of the parent protocol with an abbreviation for the field,
1686 using a period as a separator. For example, the "src" field in an IP packet
1687 would have "ip.src" as an abbreviation. It is acceptable to have
1688 multiple levels of periods if, for example, you have fields in your
1689 protocol that are then subdivided into subfields. For example, TRMAC
1690 has multiple error fields, so the abbreviations follow this pattern:
1691 "trmac.errors.iso", "trmac.errors.noniso", etc.
1692
1693 The abbreviation is the identifier used in a display filter.  If it is
1694 an empty string then the field will not be filterable.
1695
1696 type
1697 ----
1698 The type of value this field holds. The current field types are:
1699
1700         FT_NONE                 No field type. Used for fields that
1701                                 aren't given a value, and that can only
1702                                 be tested for presence or absence; a
1703                                 field that represents a data structure,
1704                                 with a subtree below it containing
1705                                 fields for the members of the structure,
1706                                 or that represents an array with a
1707                                 subtree below it containing fields for
1708                                 the members of the array, might be an
1709                                 FT_NONE field.
1710         FT_PROTOCOL             Used for protocols which will be placing
1711                                 themselves as top-level items in the
1712                                 "Packet Details" pane of the UI.
1713         FT_BOOLEAN              0 means "false", any other value means
1714                                 "true".
1715         FT_FRAMENUM             A frame number; if this is used, the "Go
1716                                 To Corresponding Frame" menu item can
1717                                 work on that field.
1718         FT_UINT8                An 8-bit unsigned integer.
1719         FT_UINT16               A 16-bit unsigned integer.
1720         FT_UINT24               A 24-bit unsigned integer.
1721         FT_UINT32               A 32-bit unsigned integer.
1722         FT_UINT64               A 64-bit unsigned integer.
1723         FT_INT8                 An 8-bit signed integer.
1724         FT_INT16                A 16-bit signed integer.
1725         FT_INT24                A 24-bit signed integer.
1726         FT_INT32                A 32-bit signed integer.
1727         FT_INT64                A 64-bit signed integer.
1728         FT_FLOAT                A single-precision floating point number.
1729         FT_DOUBLE               A double-precision floating point number.
1730         FT_ABSOLUTE_TIME        An absolute time from some fixed point in time,
1731                                 displayed as the date, followed by the time, as
1732                                 hours, minutes, and seconds with 9 digits after
1733                                 the decimal point.
1734         FT_RELATIVE_TIME        Seconds (4 bytes) and nanoseconds (4 bytes)
1735                                 of time relative to an arbitrary time.
1736                                 displayed as seconds and 9 digits
1737                                 after the decimal point.
1738         FT_STRING               A string of characters, not necessarily
1739                                 NUL-terminated, but possibly NUL-padded.
1740                                 This, and the other string-of-characters
1741                                 types, are to be used for text strings,
1742                                 not raw binary data.
1743         FT_STRINGZ              A NUL-terminated string of characters.
1744                                 The string length is normally the length
1745                                 given in the proto_tree_add_item() call.
1746                                 However if the length given in the call
1747                                 is -1, then the length used is that
1748                                 returned by calling tvb_strsize().
1749         FT_UINT_STRING          A counted string of characters, consisting
1750                                 of a count (represented as an integral value,
1751                                 of width given in the proto_tree_add_item()
1752                                 call) followed immediately by that number of
1753                                 characters.
1754         FT_ETHER                A six octet string displayed in
1755                                 Ethernet-address format.
1756         FT_BYTES                A string of bytes with arbitrary values;
1757                                 used for raw binary data.
1758         FT_UINT_BYTES           A counted string of bytes, consisting
1759                                 of a count (represented as an integral value,
1760                                 of width given in the proto_tree_add_item()
1761                                 call) followed immediately by that number of
1762                                 arbitrary values; used for raw binary data.
1763         FT_IPv4                 A version 4 IP address (4 bytes) displayed
1764                                 in dotted-quad IP address format (4
1765                                 decimal numbers separated by dots).
1766         FT_IPv6                 A version 6 IP address (16 bytes) displayed
1767                                 in standard IPv6 address format.
1768         FT_IPXNET               An IPX address displayed in hex as a 6-byte
1769                                 network number followed by a 6-byte station
1770                                 address.
1771         FT_GUID                 A Globally Unique Identifier
1772         FT_OID                  An ASN.1 Object Identifier
1773         FT_EUI64                A EUI-64 Address
1774
1775 Some of these field types are still not handled in the display filter
1776 routines, but the most common ones are. The FT_UINT* variables all
1777 represent unsigned integers, and the FT_INT* variables all represent
1778 signed integers; the number on the end represent how many bits are used
1779 to represent the number.
1780
1781 Some constraints are imposed on the header fields depending on the type
1782 (e.g.  FT_BYTES) of the field.  Fields of type FT_ABSOLUTE_TIME must use
1783 'ABSOLUTE_TIME_{LOCAL,UTC,DOY_UTC}, NULL, 0x0' as values for the
1784 'display, 'strings', and 'bitmask' fields, and all other non-integral
1785 types (i.e.. types that are _not_ FT_INT* and FT_UINT*) must use
1786 'BASE_NONE, NULL, 0x0' as values for the 'display', 'strings', 'bitmask'
1787 fields.  The reason is simply that the type itself implictly defines the
1788 nature of 'display', 'strings', 'bitmask'.
1789
1790 display
1791 -------
1792 The display field has a couple of overloaded uses. This is unfortunate,
1793 but since we're using C as an application programming language, this sometimes
1794 makes for cleaner programs. Right now I still think that overloading
1795 this variable was okay.
1796
1797 For integer fields (FT_UINT* and FT_INT*), this variable represents the
1798 base in which you would like the value displayed.  The acceptable bases
1799 are:
1800
1801         BASE_DEC,
1802         BASE_HEX,
1803         BASE_OCT,
1804         BASE_DEC_HEX,
1805         BASE_HEX_DEC,
1806         BASE_CUSTOM
1807
1808 BASE_DEC, BASE_HEX, and BASE_OCT are decimal, hexadecimal, and octal,
1809 respectively. BASE_DEC_HEX and BASE_HEX_DEC display value in two bases
1810 (the 1st representation followed by the 2nd in parenthesis).
1811
1812 BASE_CUSTOM allows one to specify a callback function pointer that will
1813 format the value. The function pointer of the same type as defined by
1814 custom_fmt_func_t in epan/proto.h, specifically:
1815
1816   void func(gchar *, guint32);
1817
1818 The first argument is a pointer to a buffer of the ITEM_LABEL_LENGTH size
1819 and the second argument is the value to be formatted.
1820
1821 For FT_BOOLEAN fields that are also bitfields (i.e. 'bitmask' is non-zero),
1822 'display' is used to tell the proto_tree how wide the parent bitfield is.
1823 With integers this is not needed since the type of integer itself
1824 (FT_UINT8, FT_UINT16, FT_UINT24, FT_UINT32, etc.) tells the proto_tree how
1825 wide the parent bitfield is.
1826
1827 For FT_ABSOLUTE_TIME fields, 'display' is used to indicate whether the
1828 time is to be displayed as a time in the time zone for the machine on
1829 which Wireshark/TShark is running or as UTC and, for UTC, whether the
1830 date should be displayed as "{monthname}, {month} {day_of_month},
1831 {year}" or as "{year/day_of_year}".
1832
1833 Additionally, BASE_NONE is used for 'display' as a NULL-value. That is, for
1834 non-integers other than FT_ABSOLUTE_TIME fields, and non-bitfield
1835 FT_BOOLEANs, you'll want to use BASE_NONE in the 'display' field.  You may
1836 not use BASE_NONE for integers.
1837
1838 It is possible that in the future we will record the endianness of
1839 integers. If so, it is likely that we'll use a bitmask on the display field
1840 so that integers would be represented as BEND|BASE_DEC or LEND|BASE_HEX.
1841 But that has not happened yet; note that there are protocols for which
1842 no endianness is specified, such as the X11 protocol and the DCE RPC
1843 protocol, so it would not be possible to record the endianness of all
1844 integral fields.
1845
1846 strings
1847 -------
1848 -- value_string
1849 Some integer fields, of type FT_UINT*, need labels to represent the true
1850 value of a field.  You could think of those fields as having an
1851 enumerated data type, rather than an integral data type.
1852
1853 A 'value_string' structure is a way to map values to strings.
1854
1855         typedef struct _value_string {
1856                 guint32  value;
1857                 gchar   *strptr;
1858         } value_string;
1859
1860 For fields of that type, you would declare an array of "value_string"s:
1861
1862         static const value_string valstringname[] = {
1863                 { INTVAL1, "Descriptive String 1" },
1864                 { INTVAL2, "Descriptive String 2" },
1865                 { 0,       NULL }
1866         };
1867
1868 (the last entry in the array must have a NULL 'strptr' value, to
1869 indicate the end of the array).  The 'strings' field would be set to
1870 'VALS(valstringname)'.
1871
1872 If the field has a numeric rather than an enumerated type, the 'strings'
1873 field would be set to NULL.
1874
1875 -- Extended value strings
1876 You can also use an extended version of the value_string for faster lookups.
1877 It requires a value_string as input.
1878 If all of a contiguous range of values from min to max are present in the array
1879 the value will be used as as a direct index into a value_string array.
1880
1881 If the values in the array are not contiguous (ie: there are "gaps"), but are
1882 in assending order a binary search will be used.
1883
1884 Note: "gaps" in a value_string array can be filled with "empty" entries eg:
1885 {value, "Unknown"} so that direct access to the array is is possible.
1886
1887 The init macro (see below) will perform a check on the value string the first
1888 time it is used to determine which search algorithm fits and fall back to a
1889 linear search if the value_string does not meet the criteria above.
1890
1891 Use this macro to initialise the extended value_string at comile time:
1892
1893 static value_string_ext valstringname_ext = VALUE_STRING_EXT_INIT(valstringname);
1894
1895 Extended value strings can be created at runtime by calling
1896    value_string_ext_new(<ptr to value_string array>,
1897                         <total number of entries in the value_string_array>, /* include {0, NULL} entry */
1898                         <value_string_name>);
1899
1900 For hf[] array FT_(U)INT* fields that need a 'valstringname_ext' struct, the
1901 'strings' field would be set to '&valstringname_ext)'. Furthermore, 'display'
1902 field must be ORed with 'BASE_EXT_STRING' (e.g. BASE_DEC|BASE_EXT_STRING).
1903
1904
1905 -- Ranges
1906 If the field has a numeric type that might logically fit in ranges of values
1907 one can use a range_string struct.
1908
1909 Thus a 'range_string' structure is a way to map ranges to strings.
1910
1911         typedef struct _range_string {
1912                 guint32        value_min;
1913                 guint32        value_max;
1914                 const gchar   *strptr;
1915         } range_string;
1916
1917 For fields of that type, you would declare an array of "range_string"s:
1918
1919         static const range_string rvalstringname[] = {
1920                 { INTVAL_MIN1, INTVALMAX1, "Descriptive String 1" },
1921                 { INTVAL_MIN2, INTVALMAX2, "Descriptive String 2" },
1922                 { 0,           0,          NULL                   }
1923         };
1924
1925 If INTVAL_MIN equals INTVAL_MAX for a given entry the range_string
1926 behavior collapses to the one of value_string.
1927 For FT_(U)INT* fields that need a 'range_string' struct, the 'strings' field
1928 would be set to 'RVALS(rvalstringname)'. Furthermore, 'display' field must be
1929 ORed with 'BASE_RANGE_STRING' (e.g. BASE_DEC|BASE_RANGE_STRING).
1930
1931 -- Booleans
1932 FT_BOOLEANs have a default map of 0 = "False", 1 (or anything else) = "True".
1933 Sometimes it is useful to change the labels for boolean values (e.g.,
1934 to "Yes"/"No", "Fast"/"Slow", etc.).  For these mappings, a struct called
1935 true_false_string is used.
1936
1937         typedef struct true_false_string {
1938                 char    *true_string;
1939                 char    *false_string;
1940         } true_false_string;
1941
1942 For Boolean fields for which "False" and "True" aren't the desired
1943 labels, you would declare a "true_false_string"s:
1944
1945         static const true_false_string boolstringname = {
1946                 "String for True",
1947                 "String for False"
1948         };
1949
1950 Its two fields are pointers to the string representing truth, and the
1951 string representing falsehood.  For FT_BOOLEAN fields that need a
1952 'true_false_string' struct, the 'strings' field would be set to
1953 'TFS(&boolstringname)'.
1954
1955 If the Boolean field is to be displayed as "False" or "True", the
1956 'strings' field would be set to NULL.
1957
1958 Wireshark predefines a whole range of ready made "true_false_string"s
1959 in tfs.h, included via packet.h.
1960
1961 bitmask
1962 -------
1963 If the field is a bitfield, then the bitmask is the mask which will
1964 leave only the bits needed to make the field when ANDed with a value.
1965 The proto_tree routines will calculate 'bitshift' automatically
1966 from 'bitmask', by finding the rightmost set bit in the bitmask.
1967 This shift is applied before applying string mapping functions or
1968 filtering.
1969 If the field is not a bitfield, then bitmask should be set to 0.
1970
1971 blurb
1972 -----
1973 This is a string giving a proper description of the field.  It should be
1974 at least one grammatically complete sentence, or NULL in which case the
1975 name field is used. (Please do not use "").
1976 It is meant to provide a more detailed description of the field than the
1977 name alone provides. This information will be used in the man page, and
1978 in a future GUI display-filter creation tool. We might also add tooltips
1979 to the labels in the GUI protocol tree, in which case the blurb would
1980 be used as the tooltip text.
1981
1982
1983 1.6.1 Field Registration.
1984
1985 Protocol registration is handled by creating an instance of the
1986 header_field_info struct (or an array of such structs), and
1987 calling the registration function along with the registration ID of
1988 the protocol that is the parent of the fields. Here is a complete example:
1989
1990         static int proto_eg = -1;
1991         static int hf_field_a = -1;
1992         static int hf_field_b = -1;
1993
1994         static hf_register_info hf[] = {
1995
1996                 { &hf_field_a,
1997                 { "Field A",    "proto.field_a", FT_UINT8, BASE_HEX, NULL,
1998                         0xf0, "Field A represents Apples", HFILL }},
1999
2000                 { &hf_field_b,
2001                 { "Field B",    "proto.field_b", FT_UINT16, BASE_DEC, VALS(vs),
2002                         0x0, "Field B represents Bananas", HFILL }}
2003         };
2004
2005         proto_eg = proto_register_protocol("Example Protocol",
2006             "PROTO", "proto");
2007         proto_register_field_array(proto_eg, hf, array_length(hf));
2008
2009 Be sure that your array of hf_register_info structs is declared 'static',
2010 since the proto_register_field_array() function does not create a copy
2011 of the information in the array... it uses that static copy of the
2012 information that the compiler created inside your array. Here's the
2013 layout of the hf_register_info struct:
2014
2015 typedef struct hf_register_info {
2016         int                     *p_id;  /* pointer to parent variable */
2017         header_field_info       hfinfo;
2018 } hf_register_info;
2019
2020 Also be sure to use the handy array_length() macro found in packet.h
2021 to have the compiler compute the array length for you at compile time.
2022
2023 If you don't have any fields to register, do *NOT* create a zero-length
2024 "hf" array; not all compilers used to compile Wireshark support them.
2025 Just omit the "hf" array, and the "proto_register_field_array()" call,
2026 entirely.
2027
2028 It is OK to have header fields with a different format be registered with
2029 the same abbreviation. For instance, the following is valid:
2030
2031         static hf_register_info hf[] = {
2032
2033                 { &hf_field_8bit, /* 8-bit version of proto.field */
2034                 { "Field (8 bit)", "proto.field", FT_UINT8, BASE_DEC, NULL,
2035                         0x00, "Field represents FOO", HFILL }},
2036
2037                 { &hf_field_32bit, /* 32-bit version of proto.field */
2038                 { "Field (32 bit)", "proto.field", FT_UINT32, BASE_DEC, NULL,
2039                         0x00, "Field represents FOO", HFILL }}
2040         };
2041
2042 This way a filter expression can match a header field, irrespective of the
2043 representation of it in the specific protocol context. This is interesting
2044 for protocols with variable-width header fields.
2045
2046 The HFILL macro at the end of the struct will set reasonable default values
2047 for internally used fields.
2048
2049 1.6.2 Adding Items and Values to the Protocol Tree.
2050
2051 A protocol item is added to an existing protocol tree with one of a
2052 handful of proto_XXX_DO_YYY() functions.
2053
2054 Remember that it only makes sense to add items to a protocol tree if its
2055 proto_tree pointer is not null. Should you add an item to a NULL tree, then
2056 the proto_XXX_DO_YYY() function will immediately return. The cost of this
2057 function call can be avoided by checking for the tree pointer.
2058
2059 Subtrees can be made with the proto_item_add_subtree() function:
2060
2061         item = proto_tree_add_item(....);
2062         new_tree = proto_item_add_subtree(item, tree_type);
2063
2064 This will add a subtree under the item in question; a subtree can be
2065 created under an item made by any of the "proto_tree_add_XXX" functions,
2066 so that the tree can be given an arbitrary depth.
2067
2068 Subtree types are integers, assigned by
2069 "proto_register_subtree_array()".  To register subtree types, pass an
2070 array of pointers to "gint" variables to hold the subtree type values to
2071 "proto_register_subtree_array()":
2072
2073         static gint ett_eg = -1;
2074         static gint ett_field_a = -1;
2075
2076         static gint *ett[] = {
2077                 &ett_eg,
2078                 &ett_field_a
2079         };
2080
2081         proto_register_subtree_array(ett, array_length(ett));
2082
2083 in your "register" routine, just as you register the protocol and the
2084 fields for that protocol.
2085
2086 The ett_ variables identify particular type of subtree so that if you expand
2087 one of them, Wireshark keeps track of that and, when you click on
2088 another packet, it automatically opens all subtrees of that type.
2089 If you close one of them, all subtrees of that type will be closed when
2090 you move to another packet.
2091
2092 There are several functions that the programmer can use to add either
2093 protocol or field labels to the proto_tree:
2094
2095         proto_item*
2096         proto_tree_add_item(tree, id, tvb, start, length, encoding);
2097
2098         proto_item*
2099         proto_tree_add_none_format(tree, id, tvb, start, length, format, ...);
2100
2101         proto_item*
2102         proto_tree_add_protocol_format(tree, id, tvb, start, length,
2103                 format, ...);
2104
2105         proto_item *
2106         proto_tree_add_bytes(tree, id, tvb, start, length, start_ptr);
2107
2108         proto_item *
2109         proto_tree_add_bytes_format(tree, id, tvb, start, length, start_ptr,
2110                 format, ...);
2111
2112         proto_item *
2113         proto_tree_add_bytes_format_value(tree, id, tvb, start, length,
2114                 start_ptr, format, ...);
2115
2116         proto_item *
2117         proto_tree_add_time(tree, id, tvb, start, length, value_ptr);
2118
2119         proto_item *
2120         proto_tree_add_time_format(tree, id, tvb, start, length, value_ptr,
2121                 format, ...);
2122
2123         proto_item *
2124         proto_tree_add_time_format_value(tree, id, tvb, start, length,
2125                 value_ptr, format, ...);
2126
2127         proto_item *
2128         proto_tree_add_ipxnet(tree, id, tvb, start, length, value);
2129
2130         proto_item *
2131         proto_tree_add_ipxnet_format(tree, id, tvb, start, length, value,
2132                 format, ...);
2133
2134         proto_item *
2135         proto_tree_add_ipxnet_format_value(tree, id, tvb, start, length,
2136                 value, format, ...);
2137
2138         proto_item *
2139         proto_tree_add_ipv4(tree, id, tvb, start, length, value);
2140
2141         proto_item *
2142         proto_tree_add_ipv4_format(tree, id, tvb, start, length, value,
2143                 format, ...);
2144
2145         proto_item *
2146         proto_tree_add_ipv4_format_value(tree, id, tvb, start, length,
2147                 value, format, ...);
2148
2149         proto_item *
2150         proto_tree_add_ipv6(tree, id, tvb, start, length, value_ptr);
2151
2152         proto_item *
2153         proto_tree_add_ipv6_format(tree, id, tvb, start, length, value_ptr,
2154                 format, ...);
2155
2156         proto_item *
2157         proto_tree_add_ipv6_format_value(tree, id, tvb, start, length,
2158                 value_ptr, format, ...);
2159
2160         proto_item *
2161         proto_tree_add_ether(tree, id, tvb, start, length, value_ptr);
2162
2163         proto_item *
2164         proto_tree_add_ether_format(tree, id, tvb, start, length, value_ptr,
2165                 format, ...);
2166
2167         proto_item *
2168         proto_tree_add_ether_format_value(tree, id, tvb, start, length,
2169                 value_ptr, format, ...);
2170
2171         proto_item *
2172         proto_tree_add_string(tree, id, tvb, start, length, value_ptr);
2173
2174         proto_item *
2175         proto_tree_add_string_format(tree, id, tvb, start, length, value_ptr,
2176                 format, ...);
2177
2178         proto_item *
2179         proto_tree_add_string_format_value(tree, id, tvb, start, length,
2180                 value_ptr, format, ...);
2181
2182         proto_item *
2183         proto_tree_add_boolean(tree, id, tvb, start, length, value);
2184
2185         proto_item *
2186         proto_tree_add_boolean_format(tree, id, tvb, start, length, value,
2187                 format, ...);
2188
2189         proto_item *
2190         proto_tree_add_boolean_format_value(tree, id, tvb, start, length,
2191                 value, format, ...);
2192
2193         proto_item *
2194         proto_tree_add_float(tree, id, tvb, start, length, value);
2195
2196         proto_item *
2197         proto_tree_add_float_format(tree, id, tvb, start, length, value,
2198                 format, ...);
2199
2200         proto_item *
2201         proto_tree_add_float_format_value(tree, id, tvb, start, length,
2202                 value, format, ...);
2203
2204         proto_item *
2205         proto_tree_add_double(tree, id, tvb, start, length, value);
2206
2207         proto_item *
2208         proto_tree_add_double_format(tree, id, tvb, start, length, value,
2209                 format, ...);
2210
2211         proto_item *
2212         proto_tree_add_double_format_value(tree, id, tvb, start, length,
2213                 value, format, ...);
2214
2215         proto_item *
2216         proto_tree_add_uint(tree, id, tvb, start, length, value);
2217
2218         proto_item *
2219         proto_tree_add_uint_format(tree, id, tvb, start, length, value,
2220                 format, ...);
2221
2222         proto_item *
2223         proto_tree_add_uint_format_value(tree, id, tvb, start, length,
2224                 value, format, ...);
2225
2226         proto_item *
2227         proto_tree_add_uint64(tree, id, tvb, start, length, value);
2228
2229         proto_item *
2230         proto_tree_add_uint64_format(tree, id, tvb, start, length, value,
2231                 format, ...);
2232
2233         proto_item *
2234         proto_tree_add_uint64_format_value(tree, id, tvb, start, length,
2235                 value, format, ...);
2236
2237         proto_item *
2238         proto_tree_add_int(tree, id, tvb, start, length, value);
2239
2240         proto_item *
2241         proto_tree_add_int_format(tree, id, tvb, start, length, value,
2242                 format, ...);
2243
2244         proto_item *
2245         proto_tree_add_int_format_value(tree, id, tvb, start, length,
2246                 value, format, ...);
2247
2248         proto_item *
2249         proto_tree_add_int64(tree, id, tvb, start, length, value);
2250
2251         proto_item *
2252         proto_tree_add_int64_format(tree, id, tvb, start, length, value,
2253                 format, ...);
2254
2255         proto_item *
2256         proto_tree_add_int64_format_value(tree, id, tvb, start, length,
2257                 value, format, ...);
2258
2259         proto_item*
2260         proto_tree_add_text(tree, tvb, start, length, format, ...);
2261
2262         proto_item*
2263         proto_tree_add_text_valist(tree, tvb, start, length, format, ap);
2264
2265         proto_item *
2266         proto_tree_add_guid(tree, id, tvb, start, length, value_ptr);
2267
2268         proto_item *
2269         proto_tree_add_guid_format(tree, id, tvb, start, length, value_ptr,
2270                 format, ...);
2271
2272         proto_item *
2273         proto_tree_add_guid_format_value(tree, id, tvb, start, length,
2274                 value_ptr, format, ...);
2275
2276         proto_item *
2277         proto_tree_add_oid(tree, id, tvb, start, length, value_ptr);
2278
2279         proto_item *
2280         proto_tree_add_oid_format(tree, id, tvb, start, length, value_ptr,
2281                 format, ...);
2282
2283         proto_item *
2284         proto_tree_add_eui64(tree, id, tvb, start, length, value);
2285
2286         proto_item *
2287         proto_tree_add_eui64_format(tree, id, tvb, start, length, value,
2288                 format, ...);
2289
2290         proto_item *
2291         proto_tree_add_eui64_format_value(tree, id, tvb, start, length,
2292                 value, format, ...);
2293
2294         proto_item *
2295         proto_tree_add_oid_format_value(tree, id, tvb, start, length,
2296                 value_ptr, format, ...);
2297
2298         proto_item*
2299         proto_tree_add_bits_item(tree, id, tvb, bit_offset, no_of_bits,
2300                 little_endian);
2301
2302         proto_item *
2303         proto_tree_add_bits_ret_val(tree, id, tvb, bit_offset, no_of_bits,
2304                 return_value, little_endian);
2305
2306         proto_item *
2307         proto_tree_add_bitmask(tree, tvb, start, header, ett, fields,
2308                 little_endian);
2309
2310         proto_item *
2311         proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
2312                 ett, fields, little_endian, flags);
2313
2314 The 'tree' argument is the tree to which the item is to be added.  The
2315 'tvb' argument is the tvbuff from which the item's value is being
2316 extracted; the 'start' argument is the offset from the beginning of that
2317 tvbuff of the item being added, and the 'length' argument is the length,
2318 in bytes, of the item, bit_offset is the offset in bits and no_of_bits
2319 is the length in bits.
2320
2321 The length of some items cannot be determined until the item has been
2322 dissected; to add such an item, add it with a length of -1, and, when the
2323 dissection is complete, set the length with 'proto_item_set_len()':
2324
2325         void
2326         proto_item_set_len(ti, length);
2327
2328 The "ti" argument is the value returned by the call that added the item
2329 to the tree, and the "length" argument is the length of the item.
2330
2331 proto_tree_add_item()
2332 ---------------------
2333 proto_tree_add_item is used when you wish to do no special formatting.
2334 The item added to the GUI tree will contain the name (as passed in the
2335 proto_register_*() function) and a value.  The value will be fetched
2336 from the tvbuff by proto_tree_add_item(), based on the type of the field
2337 and the encoding of the value as specified by the "encoding" argument.
2338
2339 For FT_NONE, FT_BYTES, FT_ETHER, FT_IPv6, FT_IPXNET, FT_OID fields,
2340 and 'protocol' fields the encoding is not relevant; the 'encoding'
2341 argument should be ENC_NA (Not Applicable).
2342
2343 For integral, floating-point, Boolean, FT_GUID, and FT_EUI64 fields,
2344 the encoding specifies the byte order of the value; the 'encoding'
2345 argument should be is ENC_LITTLE_ENDIAN if the value is little-endian
2346 and ENC_BIG_ENDIAN if it is big-endian.
2347
2348 For FT_IPv4 fields, the encoding also specifies the byte order of the
2349 value.  In almost all cases, the encoding is in network byte order,
2350 hence big-endian, but in at least one protocol dissected by Wireshark,
2351 at least one IPv4 address is byte-swapped, so it's in little-endian
2352 order.
2353
2354 For string fields, the encoding specifies the character set used for the
2355 string and the way individual code points in that character set are
2356 encoded.  For FT_UINT_STRING fields, the byte order of the count must be
2357 specified; when support for UTF-16 encoding is added, the byte order of
2358 the encoding will also have to be specified.  In other cases, ENC_NA
2359 should be used.  The character encodings that are currently
2360 supported are:
2361
2362         ENC_UTF_8 - UTF-8
2363         ENC_ASCII - ASCII (currently treated as UTF-8; in the future,
2364                 all bytes with the 8th bit set will be treated as
2365                 errors)
2366         ENC_EBCDIC - EBCDIC
2367
2368 Other encodings will be added in the future.
2369
2370 For FT_ABSOLUTE_TIME fields, the encoding specifies the form in which
2371 the time stamp is specified, as well as its byte order.  The time stamp
2372 encodings that are curretly supported are:
2373
2374         ENC_TIME_TIMESPEC - seconds (4 bytes) and nanoseconds (4 bytes)
2375                 of time since January 1, 1970, midnight UTC.
2376
2377         ENC_TIME_NTP - an NTP timestamp, represented as a 64-bit
2378                 unsigned fixed-point number, in seconds relative to 0h
2379                 on 1 January 1900.  The integer part is in the first 32
2380                 bits and the fraction part in the last 32 bits.
2381
2382 For other types, there is no support for proto_tree_add_item().
2383
2384 Now that definitions of fields have detailed information about bitfield
2385 fields, you can use proto_tree_add_item() with no extra processing to
2386 add bitfield values to your tree.  Here's an example.  Take the Format
2387 Identifier (FID) field in the Transmission Header (TH) portion of the SNA
2388 protocol.  The FID is the high nibble of the first byte of the TH.  The
2389 FID would be registered like this:
2390
2391         name            = "Format Identifier"
2392         abbrev          = "sna.th.fid"
2393         type            = FT_UINT8
2394         display         = BASE_HEX
2395         strings         = sna_th_fid_vals
2396         bitmask         = 0xf0
2397
2398 The bitmask contains the value which would leave only the FID if bitwise-ANDed
2399 against the parent field, the first byte of the TH.
2400
2401 The code to add the FID to the tree would be;
2402
2403         proto_tree_add_item(bf_tree, hf_sna_th_fid, tvb, offset, 1,
2404             ENC_BIG_ENDIAN);
2405
2406 The definition of the field already has the information about bitmasking
2407 and bitshifting, so it does the work of masking and shifting for us!
2408 This also means that you no longer have to create value_string structs
2409 with the values bitshifted.  The value_string for FID looks like this,
2410 even though the FID value is actually contained in the high nibble.
2411 (You'd expect the values to be 0x0, 0x10, 0x20, etc.)
2412
2413 /* Format Identifier */
2414 static const value_string sna_th_fid_vals[] = {
2415         { 0x0,  "SNA device <--> Non-SNA Device" },
2416         { 0x1,  "Subarea Node <--> Subarea Node" },
2417         { 0x2,  "Subarea Node <--> PU2" },
2418         { 0x3,  "Subarea Node or SNA host <--> Subarea Node" },
2419         { 0x4,  "?" },
2420         { 0x5,  "?" },
2421         { 0xf,  "Adjacent Subarea Nodes" },
2422         { 0,    NULL }
2423 };
2424
2425 The final implication of this is that display filters work the way you'd
2426 naturally expect them to. You'd type "sna.th.fid == 0xf" to find Adjacent
2427 Subarea Nodes. The user does not have to shift the value of the FID to
2428 the high nibble of the byte ("sna.th.fid == 0xf0") as was necessary
2429 in the past.
2430
2431 proto_tree_add_protocol_format()
2432 --------------------------------
2433 proto_tree_add_protocol_format is used to add the top-level item for the
2434 protocol when the dissector routine wants complete control over how the
2435 field and value will be represented on the GUI tree.  The ID value for
2436 the protocol is passed in as the "id" argument; the rest of the
2437 arguments are a "printf"-style format and any arguments for that format.
2438 The caller must include the name of the protocol in the format; it is
2439 not added automatically as in proto_tree_add_item().
2440
2441 proto_tree_add_none_format()
2442 ----------------------------
2443 proto_tree_add_none_format is used to add an item of type FT_NONE.
2444 The caller must include the name of the field in the format; it is
2445 not added automatically as in proto_tree_add_item().
2446
2447 proto_tree_add_bytes()
2448 proto_tree_add_time()
2449 proto_tree_add_ipxnet()
2450 proto_tree_add_ipv4()
2451 proto_tree_add_ipv6()
2452 proto_tree_add_ether()
2453 proto_tree_add_string()
2454 proto_tree_add_boolean()
2455 proto_tree_add_float()
2456 proto_tree_add_double()
2457 proto_tree_add_uint()
2458 proto_tree_add_uint64()
2459 proto_tree_add_int()
2460 proto_tree_add_int64()
2461 proto_tree_add_guid()
2462 proto_tree_add_oid()
2463 proto_tree_add_eui64()
2464 ------------------------
2465 These routines are used to add items to the protocol tree if either:
2466
2467         the value of the item to be added isn't just extracted from the
2468         packet data, but is computed from data in the packet;
2469
2470         the value was fetched into a variable.
2471
2472 The 'value' argument has the value to be added to the tree.
2473
2474 NOTE: in all cases where the 'value' argument is a pointer, a copy is
2475 made of the object pointed to; if you have dynamically allocated a
2476 buffer for the object, that buffer will not be freed when the protocol
2477 tree is freed - you must free the buffer yourself when you don't need it
2478 any more.
2479
2480 For proto_tree_add_bytes(), the 'value_ptr' argument is a pointer to a
2481 sequence of bytes.
2482
2483 For proto_tree_add_bytes_format() and proto_tree_add_bytes_format_value(), the
2484 'value_ptr' argument is a pointer to a sequence of bytes or NULL if the bytes
2485 should be taken from the given TVB using the given offset and length.
2486
2487 For proto_tree_add_time(), the 'value_ptr' argument is a pointer to an
2488 "nstime_t", which is a structure containing the time to be added; it has
2489 'secs' and 'nsecs' members, giving the integral part and the fractional
2490 part of a time in units of seconds, with 'nsecs' being the number of
2491 nanoseconds.  For absolute times, "secs" is a UNIX-style seconds since
2492 January 1, 1970, 00:00:00 GMT value.
2493
2494 For proto_tree_add_ipxnet(), the 'value' argument is a 32-bit IPX
2495 network address.
2496
2497 For proto_tree_add_ipv4(), the 'value' argument is a 32-bit IPv4
2498 address, in network byte order.
2499
2500 For proto_tree_add_ipv6(), the 'value_ptr' argument is a pointer to a
2501 128-bit IPv6 address.
2502
2503 For proto_tree_add_ether(), the 'value_ptr' argument is a pointer to a
2504 48-bit MAC address.
2505
2506 For proto_tree_add_string(), the 'value_ptr' argument is a pointer to a
2507 text string.
2508
2509 For proto_tree_add_boolean(), the 'value' argument is a 32-bit integer.
2510 It is masked and shifted as defined by the field info after which zero
2511 means "false", and non-zero means "true".
2512
2513 For proto_tree_add_float(), the 'value' argument is a 'float' in the
2514 host's floating-point format.
2515
2516 For proto_tree_add_double(), the 'value' argument is a 'double' in the
2517 host's floating-point format.
2518
2519 For proto_tree_add_uint(), the 'value' argument is a 32-bit unsigned
2520 integer value, in host byte order.  (This routine cannot be used to add
2521 64-bit integers.)
2522
2523 For proto_tree_add_uint64(), the 'value' argument is a 64-bit unsigned
2524 integer value, in host byte order.
2525
2526 For proto_tree_add_int(), the 'value' argument is a 32-bit signed
2527 integer value, in host byte order.  (This routine cannot be used to add
2528 64-bit integers.)
2529
2530 For proto_tree_add_int64(), the 'value' argument is a 64-bit signed
2531 integer value, in host byte order.
2532
2533 For proto_tree_add_guid(), the 'value_ptr' argument is a pointer to an
2534 e_guid_t structure.
2535
2536 For proto_tree_add_oid(), the 'value_ptr' argument is a pointer to an
2537 ASN.1 Object Identifier.
2538
2539 For proto_tree_add_eui64(), the 'value' argument is a 64-bit integer
2540 value
2541
2542 proto_tree_add_bytes_format()
2543 proto_tree_add_time_format()
2544 proto_tree_add_ipxnet_format()
2545 proto_tree_add_ipv4_format()
2546 proto_tree_add_ipv6_format()
2547 proto_tree_add_ether_format()
2548 proto_tree_add_string_format()
2549 proto_tree_add_boolean_format()
2550 proto_tree_add_float_format()
2551 proto_tree_add_double_format()
2552 proto_tree_add_uint_format()
2553 proto_tree_add_uint64_format()
2554 proto_tree_add_int_format()
2555 proto_tree_add_int64_format()
2556 proto_tree_add_guid_format()
2557 proto_tree_add_oid_format()
2558 proto_tree_add_eui64_format()
2559 ----------------------------
2560 These routines are used to add items to the protocol tree when the
2561 dissector routine wants complete control over how the field and value
2562 will be represented on the GUI tree.  The argument giving the value is
2563 the same as the corresponding proto_tree_add_XXX() function; the rest of
2564 the arguments are a "printf"-style format and any arguments for that
2565 format.  The caller must include the name of the field in the format; it
2566 is not added automatically as in the proto_tree_add_XXX() functions.
2567
2568 proto_tree_add_bytes_format_value()
2569 proto_tree_add_time_format_value()
2570 proto_tree_add_ipxnet_format_value()
2571 proto_tree_add_ipv4_format_value()
2572 proto_tree_add_ipv6_format_value()
2573 proto_tree_add_ether_format_value()
2574 proto_tree_add_string_format_value()
2575 proto_tree_add_boolean_format_value()
2576 proto_tree_add_float_format_value()
2577 proto_tree_add_double_format_value()
2578 proto_tree_add_uint_format_value()
2579 proto_tree_add_uint64_format_value()
2580 proto_tree_add_int_format_value()
2581 proto_tree_add_int64_format_value()
2582 proto_tree_add_guid_format_value()
2583 proto_tree_add_oid_format_value()
2584 proto_tree_add_eui64_format_value()
2585 ------------------------------------
2586
2587 These routines are used to add items to the protocol tree when the
2588 dissector routine wants complete control over how the value will be
2589 represented on the GUI tree.  The argument giving the value is the same
2590 as the corresponding proto_tree_add_XXX() function; the rest of the
2591 arguments are a "printf"-style format and any arguments for that format.
2592 With these routines, unlike the proto_tree_add_XXX_format() routines,
2593 the name of the field is added automatically as in the
2594 proto_tree_add_XXX() functions; only the value is added with the format.
2595
2596 proto_tree_add_text()
2597 ---------------------
2598 proto_tree_add_text() is used to add a label to the GUI tree.  It will
2599 contain no value, so it is not searchable in the display filter process.
2600 This function was needed in the transition from the old-style proto_tree
2601 to this new-style proto_tree so that Wireshark would still decode all
2602 protocols w/o being able to filter on all protocols and fields.
2603 Otherwise we would have had to cripple Wireshark's functionality while we
2604 converted all the old-style proto_tree calls to the new-style proto_tree
2605 calls.  In other words, you should not use this in new code unless you've got
2606 a specific reason (see below).
2607
2608 This can also be used for items with subtrees, which may not have values
2609 themselves - the items in the subtree are the ones with values.
2610
2611 For a subtree, the label on the subtree might reflect some of the items
2612 in the subtree.  This means the label can't be set until at least some
2613 of the items in the subtree have been dissected.  To do this, use
2614 'proto_item_set_text()' or 'proto_item_append_text()':
2615
2616         void
2617         proto_item_set_text(proto_item *ti, ...);
2618
2619         void
2620         proto_item_append_text(proto_item *ti, ...);
2621
2622 'proto_item_set_text()' takes as an argument the value returned by
2623 'proto_tree_add_text()', a 'printf'-style format string, and a set of
2624 arguments corresponding to '%' format items in that string, and replaces
2625 the text for the item created by 'proto_tree_add_text()' with the result
2626 of applying the arguments to the format string.
2627
2628 'proto_item_append_text()' is similar, but it appends to the text for
2629 the item the result of applying the arguments to the format string.
2630
2631 For example, early in the dissection, one might do:
2632
2633         ti = proto_tree_add_text(tree, tvb, offset, length, <label>);
2634
2635 and later do
2636
2637         proto_item_set_text(ti, "%s: %s", type, value);
2638
2639 after the "type" and "value" fields have been extracted and dissected.
2640 <label> would be a label giving what information about the subtree is
2641 available without dissecting any of the data in the subtree.
2642
2643 Note that an exception might be thrown when trying to extract the values of
2644 the items used to set the label, if not all the bytes of the item are
2645 available.  Thus, one should create the item with text that is as
2646 meaningful as possible, and set it or append additional information to
2647 it as the values needed to supply that information are extracted.
2648
2649 proto_tree_add_text_valist()
2650 ----------------------------
2651 This is like proto_tree_add_text(), but takes, as the last argument, a
2652 'va_list'; it is used to allow routines that take a printf-like
2653 variable-length list of arguments to add a text item to the protocol
2654 tree.
2655
2656 proto_tree_add_bits_item()
2657 --------------------------
2658 Adds a number of bits to the protocol tree which does not have to be byte
2659 aligned. The offset and length is in bits.
2660 Output format:
2661
2662 ..10 1010 10.. .... "value" (formatted as FT_ indicates).
2663
2664 proto_tree_add_bits_ret_val()
2665 -----------------------------
2666 Works in the same way but also returns the value of the read bits.
2667
2668 proto_tree_add_bitmask() and proto_tree_add_bitmask_text()
2669 ----------------------------------------------------------
2670 This function provides an easy to use and convenient helper function
2671 to manage many types of common bitmasks that occur in protocols.
2672
2673 This function will dissect a 1/2/3/4 byte large bitmask into its individual
2674 fields.
2675 header is an integer type and must be of type FT_[U]INT{8|16|24|32} and
2676 represents the entire width of the bitmask.
2677
2678 'header' and 'ett' are the hf fields and ett field respectively to create an
2679 expansion that covers the 1-4 bytes of the bitmask.
2680
2681 'fields' is a NULL terminated array of pointers to hf fields representing
2682 the individual subfields of the bitmask. These fields must either be integers
2683 of the same byte width as 'header' or of the type FT_BOOLEAN.
2684 Each of the entries in 'fields' will be dissected as an item under the
2685 'header' expansion and also IF the field is a boolean and IF it is set to 1,
2686 then the name of that boolean field will be printed on the 'header' expansion
2687 line.  For integer type subfields that have a value_string defined, the
2688 matched string from that value_string will be printed on the expansion line
2689 as well.
2690
2691 Example: (from the SCSI dissector)
2692         static int hf_scsi_inq_peripheral        = -1;
2693         static int hf_scsi_inq_qualifier         = -1;
2694         static int hf_scsi_inq_devtype           = -1;
2695         ...
2696         static gint ett_scsi_inq_peripheral = -1;
2697         ...
2698         static const int *peripheal_fields[] = {
2699                 &hf_scsi_inq_qualifier,
2700                 &hf_scsi_inq_devtype,
2701                 NULL
2702         };
2703         ...
2704         /* Qualifier and DeviceType */
2705         proto_tree_add_bitmask(tree, tvb, offset, hf_scsi_inq_peripheral,
2706                 ett_scsi_inq_peripheral, peripheal_fields, FALSE);
2707         offset+=1;
2708         ...
2709         { &hf_scsi_inq_peripheral,
2710           {"Peripheral", "scsi.inquiry.preipheral", FT_UINT8, BASE_HEX,
2711            NULL, 0, NULL, HFILL}},
2712         { &hf_scsi_inq_qualifier,
2713           {"Qualifier", "scsi.inquiry.qualifier", FT_UINT8, BASE_HEX,
2714            VALS (scsi_qualifier_val), 0xE0, NULL, HFILL}},
2715         { &hf_scsi_inq_devtype,
2716           {"Device Type", "scsi.inquiry.devtype", FT_UINT8, BASE_HEX,
2717            VALS (scsi_devtype_val), SCSI_DEV_BITS, NULL, HFILL}},
2718         ...
2719
2720 Which provides very pretty dissection of this one byte bitmask.
2721
2722     Peripheral: 0x05, Qualifier: Device type is connected to logical unit, Device Type: CD-ROM
2723         000. .... = Qualifier: Device type is connected to logical unit (0x00)
2724         ...0 0101 = Device Type: CD-ROM (0x05)
2725
2726 The proto_tree_add_bitmask_text() function is an extended version of
2727 the proto_tree_add_bitmask() function. In addition, it allows to:
2728 - Provide a leading text (e.g. "Flags: ") that will appear before
2729   the comma-separated list of field values
2730 - Provide a fallback text (e.g. "None") that will be appended if
2731   no fields warranted a change to the top-level title.
2732 - Using flags, specify which fields will affect the top-level title.
2733
2734 There are the following flags defined:
2735
2736   BMT_NO_APPEND - the title is taken "as-is" from the 'name' argument.
2737   BMT_NO_INT - only boolean flags are added to the title.
2738   BMT_NO_FALSE - boolean flags are only added to the title if they are set.
2739   BMT_NO_TFS - only add flag name to the title, do not use true_false_string
2740
2741 The proto_tree_add_bitmask() behavior can be obtained by providing
2742 both 'name' and 'fallback' arguments as NULL, and a flags of
2743 (BMT_NO_FALSE|BMT_NO_TFS).
2744
2745 PROTO_ITEM_SET_GENERATED()
2746 --------------------------
2747 PROTO_ITEM_SET_GENERATED is used to mark fields as not being read from the
2748 captured data directly, but inferred from one or more values.
2749
2750 One of the primary uses of this is the presentation of verification of
2751 checksums. Every IP packet has a checksum line, which can present the result
2752 of the checksum verification, if enabled in the preferences. The result is
2753 presented as a subtree, where the result is enclosed in square brackets
2754 indicating a generated field.
2755
2756   Header checksum: 0x3d42 [correct]
2757     [Good: True]
2758     [Bad: False]
2759
2760 PROTO_ITEM_SET_HIDDEN()
2761 -----------------------
2762 PROTO_ITEM_SET_HIDDEN is used to hide fields, which have already been added
2763 to the tree, from being visible in the displayed tree.
2764
2765 NOTE that creating hidden fields is actually quite a bad idea from a UI design
2766 perspective because the user (someone who did not write nor has ever seen the
2767 code) has no way of knowing that hidden fields are there to be filtered on
2768 thus defeating the whole purpose of putting them there.  A Better Way might
2769 be to add the fields (that might otherwise be hidden) to a subtree where they
2770 won't be seen unless the user opens the subtree--but they can be found if the
2771 user wants.
2772
2773 One use for hidden fields (which would be better implemented using visible
2774 fields in a subtree) follows: The caller may want a value to be
2775 included in a tree so that the packet can be filtered on this field, but
2776 the representation of that field in the tree is not appropriate.  An
2777 example is the token-ring routing information field (RIF).  The best way
2778 to show the RIF in a GUI is by a sequence of ring and bridge numbers.
2779 Rings are 3-digit hex numbers, and bridges are single hex digits:
2780
2781         RIF: 001-A-013-9-C0F-B-555
2782
2783 In the case of RIF, the programmer should use a field with no value and
2784 use proto_tree_add_none_format() to build the above representation. The
2785 programmer can then add the ring and bridge values, one-by-one, with
2786 proto_tree_add_item() and hide them with PROTO_ITEM_SET_HIDDEN() so that the
2787 user can then filter on or search for a particular ring or bridge. Here's a
2788 skeleton of how the programmer might code this.
2789
2790         char *rif;
2791         rif = create_rif_string(...);
2792
2793         proto_tree_add_none_format(tree, hf_tr_rif_label, ..., "RIF: %s", rif);
2794
2795         for(i = 0; i < num_rings; i++) {
2796                 proto_item *pi;
2797
2798                 pi = proto_tree_add_item(tree, hf_tr_rif_ring, ...,
2799                     ENC_BIG_ENDIAN);
2800                 PROTO_ITEM_SET_HIDDEN(pi);
2801         }
2802         for(i = 0; i < num_rings - 1; i++) {
2803                 proto_item *pi;
2804
2805                 pi = proto_tree_add_item(tree, hf_tr_rif_bridge, ...,
2806                     ENC_BIG_ENDIAN);
2807                 PROTO_ITEM_SET_HIDDEN(pi);
2808         }
2809
2810 The logical tree has these items:
2811
2812         hf_tr_rif_label, text="RIF: 001-A-013-9-C0F-B-555", value = NONE
2813         hf_tr_rif_ring,  hidden, value=0x001
2814         hf_tr_rif_bridge, hidden, value=0xA
2815         hf_tr_rif_ring,  hidden, value=0x013
2816         hf_tr_rif_bridge, hidden, value=0x9
2817         hf_tr_rif_ring,  hidden, value=0xC0F
2818         hf_tr_rif_bridge, hidden, value=0xB
2819         hf_tr_rif_ring,  hidden, value=0x555
2820
2821 GUI or print code will not display the hidden fields, but a display
2822 filter or "packet grep" routine will still see the values. The possible
2823 filter is then possible:
2824
2825         tr.rif_ring eq 0x013
2826
2827 PROTO_ITEM_SET_URL
2828 ------------------
2829 PROTO_ITEM_SET_URL is used to mark fields as containing a URL. This can only
2830 be done with fields of type FT_STRING(Z). If these fields are presented they
2831 are underlined, as could be done in a browser. These fields are sensitive to
2832 clicks as well, launching the configured browser with this URL as parameter.
2833
2834 1.7 Utility routines.
2835
2836 1.7.1 match_strval, match_strval_ext, val_to_str and val_to_str_ext.
2837
2838 A dissector may need to convert a value to a string, using a
2839 'value_string' structure, by hand, rather than by declaring a field with
2840 an associated 'value_string' structure; this might be used, for example,
2841 to generate a COL_INFO line for a frame.
2842
2843 'match_strval()' will do that:
2844
2845         gchar*
2846         match_strval(guint32 val, const value_string *vs)
2847
2848 It will look up the value 'val' in the 'value_string' table pointed to
2849 by 'vs', and return either the corresponding string, or NULL if the
2850 value could not be found in the table.  Note that, unless 'val' is
2851 guaranteed to be a value in the 'value_string' table ("guaranteed" as in
2852 "the code has already checked that it's one of those values" or "the
2853 table handles all possible values of the size of 'val'", not "the
2854 protocol spec says it has to be" - protocol specs do not prevent invalid
2855 packets from being put onto a network or into a purported packet capture
2856 file), you must check whether 'match_strval()' returns NULL, and arrange
2857 that its return value not be dereferenced if it's NULL. 'val_to_str()'
2858 can be used to generate a string for values not found in the table:
2859
2860         gchar*
2861         val_to_str(guint32 val, const value_string *vs, const char *fmt)
2862
2863 If the value 'val' is found in the 'value_string' table pointed to by
2864 'vs', 'val_to_str' will return the corresponding string; otherwise, it
2865 will use 'fmt' as an 'sprintf'-style format, with 'val' as an argument,
2866 to generate a string, and will return a pointer to that string.
2867 You can use it in a call to generate a COL_INFO line for a frame such as
2868
2869         col_add_fstr(COL_INFO, ", %s", val_to_str(val, table, "Unknown %d"));
2870
2871 The match_strval_ext and val_to_str_ext functions are "extended" versions
2872 of match_strval and val_to_str. They should be used for large value-string
2873 arrays which contain many entries. They implement value to string conversions
2874 which will do either a direct access or a binary search of the
2875 value string array if possible. See "Extended Value Strings" under
2876 section  1.6 "Constructing the protocol tree" for more information.
2877
2878 See epan/value_string.h for detailed information on the various value_string
2879 functions.
2880
2881
2882 1.7.2 match_strrval and rval_to_str.
2883
2884 A dissector may need to convert a range of values to a string, using a
2885 'range_string' structure.
2886
2887 'match_strrval()' will do that:
2888
2889         gchar*
2890         match_strrval(guint32 val, const range_string *rs)
2891
2892 It will look up the value 'val' in the 'range_string' table pointed to
2893 by 'rs', and return either the corresponding string, or NULL if the
2894 value could not be found in the table. Please note that its base
2895 behavior is inherited from match_strval().
2896
2897 'rval_to_str()' can be used to generate a string for values not found in
2898 the table:
2899
2900         gchar*
2901         rval_to_str(guint32 val, const range_string *rs, const char *fmt)
2902
2903 If the value 'val' is found in the 'range_string' table pointed to by
2904 'rs', 'rval_to_str' will return the corresponding string; otherwise, it
2905 will use 'fmt' as an 'sprintf'-style format, with 'val' as an argument,
2906 to generate a string, and will return a pointer to that string. Please
2907 note that its base behavior is inherited from match_strval().
2908
2909 1.8 Calling Other Dissectors.
2910
2911 As each dissector completes its portion of the protocol analysis, it
2912 is expected to create a new tvbuff of type TVBUFF_SUBSET which
2913 contains the payload portion of the protocol (that is, the bytes
2914 that are relevant to the next dissector).
2915
2916 The syntax for creating a new TVBUFF_SUBSET is:
2917
2918 next_tvb = tvb_new_subset(tvb, offset, length, reported_length)
2919
2920 Where:
2921         tvb is the tvbuff that the dissector has been working on. It
2922         can be a tvbuff of any type.
2923
2924         next_tvb is the new TVBUFF_SUBSET.
2925
2926         offset is the byte offset of 'tvb' at which the new tvbuff
2927         should start.  The first byte is the 0th byte.
2928
2929         length is the number of bytes in the new TVBUFF_SUBSET. A length
2930         argument of -1 says to use as many bytes as are available in
2931         'tvb'.
2932
2933         reported_length is the number of bytes that the current protocol
2934         says should be in the payload. A reported_length of -1 says that
2935         the protocol doesn't say anything about the size of its payload.
2936
2937
2938 An example from packet-ipx.c -
2939
2940 void
2941 dissect_ipx(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
2942 {
2943         tvbuff_t        *next_tvb;
2944         int             reported_length, available_length;
2945
2946
2947         /* Make the next tvbuff */
2948
2949 /* IPX does have a length value in the header, so calculate report_length */
2950    Set this to -1 if there isn't any length information in the protocol
2951 */
2952         reported_length = ipx_length - IPX_HEADER_LEN;
2953
2954 /* Calculate the available data in the packet,
2955    set this to -1 to use all the data in the tv_buffer
2956 */
2957         available_length = tvb_length(tvb) - IPX_HEADER_LEN;
2958
2959 /* Create the tvbuffer for the next dissector */
2960         next_tvb = tvb_new_subset(tvb, IPX_HEADER_LEN,
2961                         MIN(available_length, reported_length),
2962                         reported_length);
2963
2964 /* call the next dissector */
2965         dissector_next( next_tvb, pinfo, tree);
2966
2967
2968 1.9 Editing Makefile.common and CMakeLists.txt to add your dissector.
2969
2970 To arrange that your dissector will be built as part of Wireshark, you
2971 must add the name of the source file for your dissector to the
2972 'DISSECTOR_SRC' macro in the 'Makefile.common' file in the 'epan/dissectors'
2973 directory.  (Note that this is for modern versions of UNIX, so there
2974 is no 14-character limitation on file names, and for modern versions of
2975 Windows, so there is no 8.3-character limitation on file names.)
2976
2977 If your dissector also has its own header file or files, you must add
2978 them to the 'DISSECTOR_INCLUDES' macro in the 'Makefile.common' file in
2979 the 'epan/dissectors' directory, so that it's included when release source
2980 tarballs are built (otherwise, the source in the release tarballs won't
2981 compile).
2982
2983 In addition to the above, you should add your dissector source file name
2984 to the DISSECTOR_SRC section of epan/CMakeLists.txt
2985
2986
2987 1.10 Using the SVN source code tree.
2988
2989   See <http://www.wireshark.org/develop.html>
2990
2991
2992 1.10a Using git with the SVN source code tree.
2993
2994   Install git and the git-svn package.
2995   Run "mkdir git; cd git; git svn clone <svn-url>", e.g. if you are using
2996   the anonymous svn tree, run
2997   "git svn clone http://anonsvn.wireshark.org/wireshark/trunk/"
2998
2999   After that, a typical workflow may look like this (from "man git-svn"):
3000
3001   # Clone a repo (like git clone):
3002           git svn clone http://svn.example.com/project/trunk
3003   # Enter the newly cloned directory:
3004           cd trunk
3005   # You should be on master branch, double-check with ┬┤git branch┬┤
3006           git branch
3007   # Do some work and commit locally to git:
3008           git commit ...
3009   # Something is committed to SVN, rebase your local changes against the
3010   # latest changes in SVN:
3011           git svn rebase
3012   # Now commit your changes (that were committed previously using git) to SVN
3013   # as well as automatically updating your working HEAD:
3014           git svn dcommit
3015   # Append svn:ignore settings to the default git exclude file:
3016           git svn show-ignore >> .git/info/exclude
3017
3018
3019 1.11 Submitting code for your new dissector.
3020
3021   - VERIFY that your dissector code does not use prohibited or deprecated APIs
3022     as follows:
3023     perl <wireshark_root>/tools/checkAPIs.pl <source-filename(s)>
3024
3025   - TEST YOUR DISSECTOR BEFORE SUBMITTING IT.
3026     Use fuzz-test.sh and/or randpkt against your dissector.  These are
3027     described at <http://wiki.wireshark.org/FuzzTesting>.
3028
3029   - Subscribe to <mailto:wireshark-dev[AT]wireshark.org> by sending an email to
3030     <mailto:wireshark-dev-request[AT]wireshark.org?body="help"> or visiting
3031     <http://www.wireshark.org/lists/>.
3032
3033   - 'svn add' all the files of your new dissector.
3034
3035   - 'svn diff' the workspace and save the result to a file.
3036
3037   - Edit the diff file - remove any changes unrelated to your new dissector,
3038     e.g. changes in config.nmake
3039
3040   - Submit a bug report to the Wireshark bug database, found at
3041     <http://bugs.wireshark.org>, qualified as an enhancement and attach your
3042     diff file there. Set the review request flag to '?' so it will pop up in
3043     the patch review list.
3044
3045   - Create a Wiki page on the protocol at <http://wiki.wireshark.org>.
3046     A template is provided so it is easy to setup in a consistent style.
3047       See: <http://wiki.wireshark.org/HowToEdit>
3048       and  <http://wiki.wireshark.org/ProtocolReference>
3049
3050   - If possible, add sample capture files to the sample captures page at
3051     <http://wiki.wireshark.org/SampleCaptures>.  These files are used by
3052     the automated build system for fuzz testing.
3053
3054   - If you find that you are contributing a lot to wireshark on an ongoing
3055     basis you can request to become a committer which will allow you to
3056     commit files to subversion directly.
3057
3058 2. Advanced dissector topics.
3059
3060 2.1 Introduction.
3061
3062 Some of the advanced features are being worked on constantly. When using them
3063 it is wise to check the relevant header and source files for additional details.
3064
3065 2.2 Following "conversations".
3066
3067 In wireshark a conversation is defined as a series of data packets between two
3068 address:port combinations.  A conversation is not sensitive to the direction of
3069 the packet.  The same conversation will be returned for a packet bound from
3070 ServerA:1000 to ClientA:2000 and the packet from ClientA:2000 to ServerA:1000.
3071
3072 2.2.1 Conversation Routines
3073
3074 There are six routines that you will use to work with a conversation:
3075 conversation_new, find_conversation, conversation_add_proto_data,
3076 conversation_get_proto_data, conversation_delete_proto_data,
3077 and conversation_set_dissector.
3078
3079
3080 2.2.1.1 The conversation_init function.
3081
3082 This is an internal routine for the conversation code.  As such you
3083 will not have to call this routine.  Just be aware that this routine is
3084 called at the start of each capture and before the packets are filtered
3085 with a display filter.  The routine will destroy all stored
3086 conversations.  This routine does NOT clean up any data pointers that are
3087 passed in the conversation_add_proto_data 'data' variable.  You are
3088 responsible for this clean up if you pass a malloc'ed pointer
3089 in this variable.
3090
3091 See item 2.2.1.5 for more information about use of the 'data' pointer.
3092
3093
3094 2.2.1.2 The conversation_new function.
3095
3096 This routine will create a new conversation based upon two address/port
3097 pairs.  If you want to associate with the conversation a pointer to a
3098 private data structure you must use the conversation_add_proto_data
3099 function.  The ptype variable is used to differentiate between
3100 conversations over different protocols, i.e. TCP and UDP.  The options
3101 variable is used to define a conversation that will accept any destination
3102 address and/or port.  Set options = 0 if the destination port and address
3103 are know when conversation_new is called.  See section 2.4 for more
3104 information on usage of the options parameter.
3105
3106 The conversation_new prototype:
3107         conversation_t *conversation_new(guint32 setup_frame, address *addr1,
3108             address *addr2, port_type ptype, guint32 port1, guint32 port2,
3109             guint options);
3110
3111 Where:
3112         guint32 setup_frame = The lowest numbered frame for this conversation
3113         address* addr1      = first data packet address
3114         address* addr2      = second data packet address
3115         port_type ptype     = port type, this is defined in packet.h
3116         guint32 port1       = first data packet port
3117         guint32 port2       = second data packet port
3118         guint options       = conversation options, NO_ADDR2 and/or NO_PORT2
3119
3120 setup_frame indicates the first frame for this conversation, and is used to
3121 distinguish multiple conversations with the same addr1/port1 and addr2/port2
3122 pair that occur within the same capture session.
3123
3124 "addr1" and "port1" are the first address/port pair; "addr2" and "port2"
3125 are the second address/port pair.  A conversation doesn't have source
3126 and destination address/port pairs - packets in a conversation go in
3127 both directions - so "addr1"/"port1" may be the source or destination
3128 address/port pair; "addr2"/"port2" would be the other pair.
3129
3130 If NO_ADDR2 is specified, the conversation is set up so that a
3131 conversation lookup will match only the "addr1" address; if NO_PORT2 is
3132 specified, the conversation is set up so that a conversation lookup will
3133 match only the "port1" port; if both are specified, i.e.
3134 NO_ADDR2|NO_PORT2, the conversation is set up so that the lookup will
3135 match only the "addr1"/"port1" address/port pair.  This can be used if a
3136 packet indicates that, later in the capture, a conversation will be
3137 created using certain addresses and ports, in the case where the packet
3138 doesn't specify the addresses and ports of both sides.
3139
3140 2.2.1.3 The find_conversation function.
3141
3142 Call this routine to look up a conversation.  If no conversation is found,
3143 the routine will return a NULL value.
3144
3145 The find_conversation prototype:
3146
3147         conversation_t *find_conversation(guint32 frame_num, address *addr_a,
3148             address *addr_b, port_type ptype, guint32 port_a, guint32 port_b,
3149             guint options);
3150
3151 Where:
3152         guint32 frame_num = a frame number to match
3153         address* addr_a = first address
3154         address* addr_b = second address
3155         port_type ptype = port type
3156         guint32 port_a  = first data packet port
3157         guint32 port_b  = second data packet port
3158         guint options   = conversation options, NO_ADDR_B and/or NO_PORT_B
3159
3160 frame_num is a frame number to match. The conversation returned is where
3161         (frame_num >= conversation->setup_frame
3162         && frame_num < conversation->next->setup_frame)
3163 Suppose there are a total of 3 conversations (A, B, and C) that match
3164 addr_a/port_a and addr_b/port_b, where the setup_frame used in
3165 conversation_new() for A, B and C are 10, 50, and 100 respectively. The
3166 frame_num passed in find_conversation is compared to the setup_frame of each
3167 conversation. So if (frame_num >= 10 && frame_num < 50), conversation A is
3168 returned. If (frame_num >= 50 && frame_num < 100), conversation B is returned.
3169 If (frame_num >= 100) conversation C is returned.
3170
3171 "addr_a" and "port_a" are the first address/port pair; "addr_b" and
3172 "port_b" are the second address/port pair.  Again, as a conversation
3173 doesn't have source and destination address/port pairs, so
3174 "addr_a"/"port_a" may be the source or destination address/port pair;
3175 "addr_b"/"port_b" would be the other pair.  The search will match the
3176 "a" address/port pair against both the "1" and "2" address/port pairs,
3177 and match the "b" address/port pair against both the "2" and "1"
3178 address/port pairs; you don't have to worry about which side the "a" or
3179 "b" pairs correspond to.
3180
3181 If the NO_ADDR_B flag was specified to "find_conversation()", the
3182 "addr_b" address will be treated as matching any "wildcarded" address;
3183 if the NO_PORT_B flag was specified, the "port_b" port will be treated
3184 as matching any "wildcarded" port.  If both flags are specified, i.e.
3185 NO_ADDR_B|NO_PORT_B, the "addr_b" address will be treated as matching
3186 any "wildcarded" address and the "port_b" port will be treated as
3187 matching any "wildcarded" port.
3188
3189
3190 2.2.1.4 The find_or_create_conversation function.
3191
3192 This convenience function will create find an existing conversation (by calling
3193 find_conversation()) and, if a conversation does not already exist, create a
3194 new conversation by calling conversation_new().
3195
3196 The find_or_create_conversation prototype:
3197
3198         extern conversation_t *find_or_create_conversation(packet_info *pinfo);
3199
3200 Where:
3201         packet_info *pinfo = the packet_info structure
3202
3203 The frame number and the addresses necessary for find_conversation() and
3204 conversation_new() are taken from the pinfo structure (as is commonly done)
3205 and no 'options' are used.
3206
3207
3208 2.2.1.5 The conversation_add_proto_data function.
3209
3210 Once you have created a conversation with conversation_new, you can
3211 associate data with it using this function.
3212
3213 The conversation_add_proto_data prototype:
3214
3215         void conversation_add_proto_data(conversation_t *conv, int proto,
3216                 void *proto_data);
3217
3218 Where:
3219         conversation_t *conv = the conversation in question
3220         int proto            = registered protocol number
3221         void *data           = dissector data structure
3222
3223 "conversation" is the value returned by conversation_new.  "proto" is a
3224 unique protocol number created with proto_register_protocol.  Protocols
3225 are typically registered in the proto_register_XXXX section of your
3226 dissector.  "data" is a pointer to the data you wish to associate with the
3227 conversation.  "data" usually points to "se_alloc'd" memory; the
3228 memory will be automatically freed each time a new dissection begins
3229 and thus need not be managed (freed) by the dissector.
3230 Using the protocol number allows several dissectors to
3231 associate data with a given conversation.
3232
3233
3234 2.2.1.6 The conversation_get_proto_data function.
3235
3236 After you have located a conversation with find_conversation, you can use
3237 this function to retrieve any data associated with it.
3238
3239 The conversation_get_proto_data prototype:
3240
3241         void *conversation_get_proto_data(conversation_t *conv, int proto);
3242
3243 Where:
3244         conversation_t *conv = the conversation in question
3245         int proto            = registered protocol number
3246
3247 "conversation" is the conversation created with conversation_new.  "proto"
3248 is a unique protocol number created with proto_register_protocol,
3249 typically in the proto_register_XXXX portion of a dissector.  The function
3250 returns a pointer to the data requested, or NULL if no data was found.
3251
3252
3253 2.2.1.7 The conversation_delete_proto_data function.
3254
3255 After you are finished with a conversation, you can remove your association
3256 with this function.  Please note that ONLY the conversation entry is
3257 removed.  If you have allocated any memory for your data (other than with se_alloc),
3258  you must free it as well.
3259
3260 The conversation_delete_proto_data prototype:
3261
3262         void conversation_delete_proto_data(conversation_t *conv, int proto);
3263
3264 Where:
3265         conversation_t *conv = the conversation in question
3266         int proto            = registered protocol number
3267
3268 "conversation" is the conversation created with conversation_new.  "proto"
3269 is a unique protocol number created with proto_register_protocol,
3270 typically in the proto_register_XXXX portion of a dissector.
3271
3272 2.2.1.8 The conversation_set_dissector function
3273
3274 This function sets the protocol dissector to be invoked whenever
3275 conversation parameters (addresses, port_types, ports, etc) are matched
3276 during the dissection of a packet.
3277
3278 The conversation_set_dissector prototype:
3279
3280         void conversation_set_dissector(conversation_t *conversation, const dissector_handle_t handle);
3281
3282 Where:
3283         conversation_t *conv = the conversation in question
3284         const dissector_handle_t handle = the dissector handle.
3285
3286
3287 2.2.2 Using timestamps relative to the conversation
3288
3289 There is a framework to calculate timestamps relative to the start of the
3290 conversation. First of all the timestamp of the first packet that has been
3291 seen in the conversation must be kept in the protocol data to be able
3292 to calculate the timestamp of the current packet relative to the start
3293 of the conversation. The timestamp of the last packet that was seen in the
3294 conversation should also be kept in the protocol data. This way the
3295 delta time between the current packet and the previous packet in the
3296 conversation can be calculated.
3297
3298 So add the following items to the struct that is used for the protocol data:
3299
3300   nstime_t      ts_first;
3301   nstime_t      ts_prev;
3302
3303 The ts_prev value should only be set during the first run through the
3304 packets (ie pinfo->fd->flags.visited is false).
3305
3306 Next step is to use the per-packet information (described in section 2.5)
3307 to keep the calculated delta timestamp, as it can only be calculated
3308 on the first run through the packets. This is because a packet can be
3309 selected in random order once the whole file has been read.
3310
3311 After calculating the conversation timestamps, it is time to put them in
3312 the appropriate columns with the function 'col_set_time' (described in
3313 section 1.5.9). There are two columns for conversation timestamps:
3314
3315 COL_REL_CONV_TIME,  /* Relative time to beginning of conversation */
3316 COL_DELTA_CONV_TIME,/* Delta time to last frame in conversation */
3317
3318 Last but not least, there MUST be a preference in each dissector that
3319 uses conversation timestamps that makes it possible to enable and
3320 disable the calculation of conversation timestamps. The main argument
3321 for this is that a higher level conversation is able to overwrite
3322 the values of lowel level conversations in these two columns. Being
3323 able to actively select which protocols may overwrite the conversation
3324 timestamp columns gives the user the power to control these columns.
3325 (A second reason is that conversation timestamps use the per-packet
3326 data structure which uses additional memory, which should be avoided
3327 if these timestamps are not needed)
3328
3329 Have a look at the differences to packet-tcp.[ch] in SVN 22966 and
3330 SVN 23058 to see the implementation of conversation timestamps for
3331 the tcp-dissector.
3332