fdafef1c47f8412bc14cfc25fb6fed357cd0d163
[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.4[.x]/GTK+ 2.4[.x] or newer.
438 If a Glib/GTK+ mechanism is available only in Glib/GTK+ versions
439 newer than 2.4/2.4 then use "#if GTK_CHECK_VERSION(...)" to conditionally
440 compile code using that mechanism.
441
442 When different code must be used on UN*X and Win32, use a #if or #ifdef
443 that tests _WIN32, not WIN32.  Try to write code portably whenever
444 possible, however; note that there are some routines in Wireshark with
445 platform-dependent implementations and platform-independent APIs, such
446 as the routines in epan/filesystem.c, allowing the code that calls it to
447 be written portably without #ifdefs.
448
449 1.1.2 String handling
450
451 Do not use functions such as strcat() or strcpy().
452 A lot of work has been done to remove the existing calls to these functions and
453 we do not want any new callers of these functions.
454
455 Instead use g_snprintf() since that function will if used correctly prevent
456 buffer overflows for large strings.
457
458 When using a buffer to create a string, do not use a buffer stored on the stack.
459 I.e. do not use a buffer declared as
460
461    char buffer[1024];
462
463 instead allocate a buffer dynamically using the string-specific or plain emem
464 routines (see README.malloc) such as
465
466    emem_strbuf_t *strbuf;
467    strbuf = ep_strbuf_new_label("");
468    ep_strbuf_append_printf(strbuf, ...
469
470 or
471
472    char *buffer=NULL;
473    ...
474    #define MAX_BUFFER 1024
475    buffer=ep_alloc(MAX_BUFFER);
476    buffer[0]='\0';
477    ...
478    g_snprintf(buffer, MAX_BUFFER, ...
479
480 This avoids the stack from being corrupted in case there is a bug in your code
481 that accidentally writes beyond the end of the buffer.
482
483
484 If you write a routine that will create and return a pointer to a filled in
485 string and if that buffer will not be further processed or appended to after
486 the routine returns (except being added to the proto tree),
487 do not preallocate the buffer to fill in and pass as a parameter instead
488 pass a pointer to a pointer to the function and return a pointer to an
489 emem allocated buffer that will be automatically freed. (see README.malloc)
490
491 I.e. do not write code such as
492   static void
493   foo_to_str(char *string, ... ){
494      <fill in string>
495   }
496   ...
497      char buffer[1024];
498      ...
499      foo_to_str(buffer, ...
500      proto_tree_add_text(... buffer ...
501
502 instead write the code as
503   static void
504   foo_to_str(char **buffer, ...
505     #define MAX_BUFFER x
506     *buffer=ep_alloc(MAX_BUFFER);
507     <fill in *buffer>
508   }
509   ...
510     char *buffer;
511     ...
512     foo_to_str(&buffer, ...
513     proto_tree_add_text(... *buffer ...
514
515 Use ep_ allocated buffers. They are very fast and nice. These buffers are all
516 automatically free()d when the dissection of the current packet ends so you
517 don't have to worry about free()ing them explicitly in order to not leak memory.
518 Please read README.malloc.
519
520 Don't use non-ASCII characters in source files; not all compiler
521 environments will be using the same encoding for non-ASCII characters,
522 and at least one compiler (Microsoft's Visual C) will, in environments
523 with double-byte character encodings, such as many Asian environments,
524 fail if it sees a byte sequence in a source file that doesn't correspond
525 to a valid character.  This causes source files using either an ISO
526 8859/n single-byte character encoding or UTF-8 to fail to compile.  Even
527 if the compiler doesn't fail, there is no guarantee that the compiler,
528 or a developer's text editor, will interpret the characters the way you
529 intend them to be interpreted.
530
531 1.1.3 Robustness.
532
533 Wireshark is not guaranteed to read only network traces that contain correctly-
534 formed packets. Wireshark is commonly used to track down networking
535 problems, and the problems might be due to a buggy protocol implementation
536 sending out bad packets.
537
538 Therefore, protocol dissectors not only have to be able to handle
539 correctly-formed packets without, for example, crashing or looping
540 infinitely, they also have to be able to handle *incorrectly*-formed
541 packets without crashing or looping infinitely.
542
543 Here are some suggestions for making dissectors more robust in the face
544 of incorrectly-formed packets:
545
546 Do *NOT* use "g_assert()" or "g_assert_not_reached()" in dissectors.
547 *NO* value in a packet's data should be considered "wrong" in the sense
548 that it's a problem with the dissector if found; if it cannot do
549 anything else with a particular value from a packet's data, the
550 dissector should put into the protocol tree an indication that the
551 value is invalid, and should return.  The "expert" mechanism should be
552 used for that purpose.
553
554 If there is a case where you are checking not for an invalid data item
555 in the packet, but for a bug in the dissector (for example, an
556 assumption being made at a particular point in the code about the
557 internal state of the dissector), use the DISSECTOR_ASSERT macro for
558 that purpose; this will put into the protocol tree an indication that
559 the dissector has a bug in it, and will not crash the application.
560
561 If you are allocating a chunk of memory to contain data from a packet,
562 or to contain information derived from data in a packet, and the size of
563 the chunk of memory is derived from a size field in the packet, make
564 sure all the data is present in the packet before allocating the buffer.
565 Doing so means that:
566
567         1) Wireshark won't leak that chunk of memory if an attempt to
568            fetch data not present in the packet throws an exception.
569
570 and
571
572         2) it won't crash trying to allocate an absurdly-large chunk of
573            memory if the size field has a bogus large value.
574
575 If you're fetching into such a chunk of memory a string from the buffer,
576 and the string has a specified size, you can use "tvb_get_*_string()",
577 which will check whether the entire string is present before allocating
578 a buffer for the string, and will also put a trailing '\0' at the end of
579 the buffer.
580
581 If you're fetching into such a chunk of memory a 2-byte Unicode string
582 from the buffer, and the string has a specified size, you can use
583 "tvb_get_ephemeral_faked_unicode()", which will check whether the entire
584 string is present before allocating a buffer for the string, and will also
585 put a trailing '\0' at the end of the buffer.  The resulting string will be
586 a sequence of single-byte characters; the only Unicode characters that
587 will be handled correctly are those in the ASCII range.  (Wireshark's
588 ability to handle non-ASCII strings is limited; it needs to be
589 improved.)
590
591 If you're fetching into such a chunk of memory a sequence of bytes from
592 the buffer, and the sequence has a specified size, you can use
593 "tvb_memdup()", which will check whether the entire sequence is present
594 before allocating a buffer for it.
595
596 Otherwise, you can check whether the data is present by using
597 "tvb_ensure_bytes_exist()" or by getting a pointer to the data by using
598 "tvb_get_ptr()", although note that there might be problems with using
599 the pointer from "tvb_get_ptr()" (see the item on this in the
600 Portability section above, and the next item below).
601
602 Note also that you should only fetch string data into a fixed-length
603 buffer if the code ensures that no more bytes than will fit into the
604 buffer are fetched ("the protocol ensures" isn't good enough, as
605 protocol specifications can't ensure only packets that conform to the
606 specification will be transmitted or that only packets for the protocol
607 in question will be interpreted as packets for that protocol by
608 Wireshark).  If there's no maximum length of string data to be fetched,
609 routines such as "tvb_get_*_string()" are safer, as they allocate a buffer
610 large enough to hold the string.  (Note that some variants of this call
611 require you to free the string once you're finished with it.)
612
613 If you have gotten a pointer using "tvb_get_ptr()", you must make sure
614 that you do not refer to any data past the length passed as the last
615 argument to "tvb_get_ptr()"; while the various "tvb_get" routines
616 perform bounds checking and throw an exception if you refer to data not
617 available in the tvbuff, direct references through a pointer gotten from
618 "tvb_get_ptr()" do not do any bounds checking.
619
620 If you have a loop that dissects a sequence of items, each of which has
621 a length field, with the offset in the tvbuff advanced by the length of
622 the item, then, if the length field is the total length of the item, and
623 thus can be zero, you *MUST* check for a zero-length item and abort the
624 loop if you see one.  Otherwise, a zero-length item could cause the
625 dissector to loop infinitely.  You should also check that the offset,
626 after having the length added to it, is greater than the offset before
627 the length was added to it, if the length field is greater than 24 bits
628 long, so that, if the length value is *very* large and adding it to the
629 offset causes an overflow, that overflow is detected.
630
631 If you have a
632
633         for (i = {start}; i < {end}; i++)
634
635 loop, make sure that the type of the loop index variable is large enough
636 to hold the maximum {end} value plus 1; otherwise, the loop index
637 variable can overflow before it ever reaches its maximum value.  In
638 particular, be very careful when using gint8, guint8, gint16, or guint16
639 variables as loop indices; you almost always want to use an "int"/"gint"
640 or "unsigned int"/"guint" as the loop index rather than a shorter type.
641
642 If you are fetching a length field from the buffer, corresponding to the
643 length of a portion of the packet, and subtracting from that length a
644 value corresponding to the length of, for example, a header in the
645 packet portion in question, *ALWAYS* check that the value of the length
646 field is greater than or equal to the length you're subtracting from it,
647 and report an error in the packet and stop dissecting the packet if it's
648 less than the length you're subtracting from it.  Otherwise, the
649 resulting length value will be negative, which will either cause errors
650 in the dissector or routines called by the dissector, or, if the value
651 is interpreted as an unsigned integer, will cause the value to be
652 interpreted as a very large positive value.
653
654 Any tvbuff offset that is added to as processing is done on a packet
655 should be stored in a 32-bit variable, such as an "int"; if you store it
656 in an 8-bit or 16-bit variable, you run the risk of the variable
657 overflowing.
658
659 sprintf() -> g_snprintf()
660 Prevent yourself from using the sprintf() function, as it does not test the
661 length of the given output buffer and might be writing into unintended memory
662 areas. This function is one of the main causes of security problems like buffer
663 exploits and many other bugs that are very hard to find. It's much better to
664 use the g_snprintf() function declared by <glib.h> instead.
665
666 You should test your dissector against incorrectly-formed packets.  This
667 can be done using the randpkt and editcap utilities that come with the
668 Wireshark distribution.  Testing using randpkt can be done by generating
669 output at the same layer as your protocol, and forcing Wireshark/TShark
670 to decode it as your protocol, e.g. if your protocol sits on top of UDP:
671
672     randpkt -c 50000 -t dns randpkt.pcap
673     tshark -nVr randpkt.pcap -d udp.port==53,<myproto>
674
675 Testing using editcap can be done using preexisting capture files and the
676 "-E" flag, which introduces errors in a capture file.  E.g.:
677
678     editcap -E 0.03 infile.pcap outfile.pcap
679     tshark -nVr outfile.pcap
680
681 The script fuzz-test.sh is available to help automate these tests.
682
683 1.1.4 Name convention.
684
685 Wireshark uses the underscore_convention rather than the InterCapConvention for
686 function names, so new code should probably use underscores rather than
687 intercaps for functions and variable names. This is especially important if you
688 are writing code that will be called from outside your code.  We are just
689 trying to keep things consistent for other developers.
690
691 1.1.5 White space convention.
692
693 Avoid using tab expansions different from 8 column widths, as not all
694 text editors in use by the developers support this. For a detailed
695 discussion of tabs, spaces, and indentation, see
696
697     http://www.jwz.org/doc/tabs-vs-spaces.html
698
699 When creating a new file, you are free to choose an indentation logic.
700 Most of the files in Wireshark tend to use 2-space or 4-space
701 indentation. You are encouraged to write a short comment on the
702 indentation logic at the beginning of this new file, especially if
703 you're using non-mod-8 tabs.  The tabs-vs-spaces document above provides
704 examples of Emacs and vi modelines for this purpose.
705
706 When editing an existing file, try following the existing indentation
707 logic and even if it very tempting, never ever use a restyler/reindenter
708 utility on an existing file.  If you run across wildly varying
709 indentation styles within the same file, it might be helpful to send a
710 note to wireshark-dev for guidance.
711
712 1.1.6 Compiler warnings
713
714 You should write code that is free of compiler warnings. Such warnings will
715 often indicate questionable code and sometimes even real bugs, so it's best
716 to avoid warnings at all.
717
718 The compiler flags in the Makefiles are set to "treat warnings as errors",
719 so your code won't even compile when warnings occur.
720
721 1.2 Skeleton code.
722
723 Wireshark requires certain things when setting up a protocol dissector.
724 Below is skeleton code for a dissector that you can copy to a file and
725 fill in.  Your dissector should follow the naming convention of packet-
726 followed by the abbreviated name for the protocol.  It is recommended
727 that where possible you keep to the IANA abbreviated name for the
728 protocol, if there is one, or a commonly-used abbreviation for the
729 protocol, if any.
730
731 Usually, you will put your newly created dissector file into the directory
732 epan/dissectors, just like all the other packet-....c files already in there.
733
734 Also, please add your dissector file to the corresponding makefiles,
735 described in section "1.9 Editing Makefile.common and CMakeLists.txt
736 to add your dissector" below.
737
738 Dissectors that use the dissector registration to register with a lower level
739 dissector don't need to define a prototype in the .h file. For other
740 dissectors the main dissector routine should have a prototype in a header
741 file whose name is "packet-", followed by the abbreviated name for the
742 protocol, followed by ".h"; any dissector file that calls your dissector
743 should be changed to include that file.
744
745 You may not need to include all the headers listed in the skeleton
746 below, and you may need to include additional headers.  For example, the
747 code inside
748
749         #ifdef HAVE_LIBPCRE
750
751                 ...
752
753         #endif
754
755 is needed only if you are using a function from libpcre, e.g. the
756 "pcre_compile()" function.
757
758 The stdio.h, stdlib.h and string.h header files should be included only as needed.
759
760
761 The "$Id$" in the comment will be updated by Subversion when the file is
762 checked in.
763
764 When creating a new file, it is fine to just write "$Id$" as Subversion will
765 automatically fill in the identifier at the time the file will be added to the
766 SVN repository (committed).
767
768 ------------------------------------Cut here------------------------------------
769 /* packet-PROTOABBREV.c
770  * Routines for PROTONAME dissection
771  * Copyright 201x, YOUR_NAME <YOUR_EMAIL_ADDRESS>
772  *
773  * $Id$
774  *
775  * Wireshark - Network traffic analyzer
776  * By Gerald Combs <gerald@wireshark.org>
777  * Copyright 1998 Gerald Combs
778  *
779  * Copied from WHATEVER_FILE_YOU_USED (where "WHATEVER_FILE_YOU_USED"
780  * is a dissector file; if you just copied this from README.developer,
781  * don't bother with the "Copied from" - you don't even need to put
782  * in a "Copied from" if you copied an existing dissector, especially
783  * if the bulk of the code in the new dissector is your code)
784  *
785  * This program is free software; you can redistribute it and/or modify
786  * it under the terms of the GNU General Public License as published by
787  * the Free Software Foundation; either version 2 of the License, or
788  * (at your option) any later version.
789  *
790  * This program is distributed in the hope that it will be useful,
791  * but WITHOUT ANY WARRANTY; without even the implied warranty of
792  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
793  * GNU General Public License for more details.
794  *
795  * You should have received a copy of the GNU General Public License along
796  * with this program; if not, write to the Free Software Foundation, Inc.,
797  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
798  */
799
800 #ifdef HAVE_CONFIG_H
801 # include "config.h"
802 #endif
803
804 #if 0
805 /* Include only as needed */
806 #include <stdio.h>
807 #include <stdlib.h>
808 #include <string.h>
809 #endif
810
811 #include <glib.h>
812
813 #include <epan/packet.h>
814 #include <epan/prefs.h>
815
816 /* IF PROTO exposes code to other dissectors, then it must be exported
817    in a header file. If not, a header file is not needed at all. */
818 #include "packet-PROTOABBREV.h"
819
820 /* Forward declaration we need below (if using proto_reg_handoff...
821    as a prefs callback)       */
822 void proto_reg_handoff_PROTOABBREV(void);
823
824 /* Initialize the protocol and registered fields */
825 static int proto_PROTOABBREV = -1;
826 static int hf_PROTOABBREV_FIELDABBREV = -1;
827
828 /* Global sample preference ("controls" display of numbers) */
829 static gboolean gPREF_HEX = FALSE;
830 /* Global sample port pref */
831 static guint gPORT_PREF = 1234;
832
833 /* Initialize the subtree pointers */
834 static gint ett_PROTOABBREV = -1;
835
836 /* Code to actually dissect the packets */
837 static int
838 dissect_PROTOABBREV(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
839 {
840
841 /* Set up structures needed to add the protocol subtree and manage it */
842         proto_item *ti;
843         proto_tree *PROTOABBREV_tree;
844
845 /*  First, if at all possible, do some heuristics to check if the packet cannot
846  *  possibly belong to your protocol.  This is especially important for
847  *  protocols directly on top of TCP or UDP where port collisions are
848  *  common place (e.g., even though your protocol uses a well known port,
849  *  someone else may set up, for example, a web server on that port which,
850  *  if someone analyzed that web server's traffic in Wireshark, would result
851  *  in Wireshark handing an HTTP packet to your dissector).  For example:
852  */
853         /* Check that there's enough data */
854         if (tvb_length(tvb) < /* your protocol's smallest packet size */)
855                 return 0;
856
857         /* Get some values from the packet header, probably using tvb_get_*() */
858         if ( /* these values are not possible in PROTONAME */ )
859                 /*  This packet does not appear to belong to PROTONAME.
860                  *  Return 0 to give another dissector a chance to dissect it.
861                  */
862                 return 0;
863
864 /* Make entries in Protocol column and Info column on summary display */
865         col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
866
867 /* This field shows up as the "Info" column in the display; you should use
868    it, if possible, to summarize what's in the packet, so that a user looking
869    at the list of packets can tell what type of packet it is. See section 1.5
870    for more information.
871
872    If you are setting the column to a constant string, use "col_set_str()",
873    as it's more efficient than the other "col_set_XXX()" calls.
874
875    If you're setting it to a string you've constructed, or will be
876    appending to the column later, use "col_add_str()".
877
878    "col_add_fstr()" can be used instead of "col_add_str()"; it takes
879    "printf()"-like arguments.  Don't use "col_add_fstr()" with a format
880    string of "%s" - just use "col_add_str()" or "col_set_str()", as it's
881    more efficient than "col_add_fstr()".
882
883    If you will be fetching any data from the packet before filling in
884    the Info column, clear that column first, in case the calls to fetch
885    data from the packet throw an exception because they're fetching data
886    past the end of the packet, so that the Info column doesn't have data
887    left over from the previous dissector; do
888
889         col_clear(pinfo->cinfo, COL_INFO);
890
891    */
892
893         col_set_str(pinfo->cinfo, COL_INFO, "XXX Request");
894
895 /* A protocol dissector may be called in 2 different ways - with, or
896    without a non-null "tree" argument.
897
898    If the proto_tree argument is null, Wireshark does not need to use
899    the protocol tree information from your dissector, and therefore is
900    passing the dissector a null "tree" argument so that it doesn't
901    need to do work necessary to build the protocol tree.
902
903    In the interest of speed, if "tree" is NULL, avoid building a
904    protocol tree and adding stuff to it, or even looking at any packet
905    data needed only if you're building the protocol tree, if possible.
906
907    Note, however, that you must fill in column information, create
908    conversations, reassemble packets, build any other persistent state
909    needed for dissection, and call subdissectors regardless of whether
910    "tree" is NULL or not.  This might be inconvenient to do without
911    doing most of the dissection work; the routines for adding items to
912    the protocol tree can be passed a null protocol tree pointer, in
913    which case they'll return a null item pointer, and
914    "proto_item_add_subtree()" returns a null tree pointer if passed a
915    null item pointer, so, if you're careful not to dereference any null
916    tree or item pointers, you can accomplish this by doing all the
917    dissection work.  This might not be as efficient as skipping that
918    work if you're not building a protocol tree, but if the code would
919    have a lot of tests whether "tree" is null if you skipped that work,
920    you might still be better off just doing all that work regardless of
921    whether "tree" is null or not.
922
923    Note also that there is no guarantee, the first time the dissector is
924    called, whether "tree" will be null or not; your dissector must work
925    correctly, building or updating whatever state information is
926    necessary, in either case. */
927         if (tree) {
928
929 /* NOTE: The offset and length values in the call to
930    "proto_tree_add_item()" define what data bytes to highlight in the hex
931    display window when the line in the protocol tree display
932    corresponding to that item is selected.
933
934    Supplying a length of -1 is the way to highlight all data from the
935    offset to the end of the packet. */
936
937 /* create display subtree for the protocol */
938                 ti = proto_tree_add_item(tree, proto_PROTOABBREV, tvb, 0, -1, ENC_NA);
939
940                 PROTOABBREV_tree = proto_item_add_subtree(ti, ett_PROTOABBREV);
941
942 /* add an item to the subtree, see section 1.6 for more information */
943                 proto_tree_add_item(PROTOABBREV_tree,
944                     hf_PROTOABBREV_FIELDABBREV, tvb, offset, len, ENC_xxx);
945
946
947 /* Continue adding tree items to process the packet here */
948
949
950         }
951
952 /* If this protocol has a sub-dissector call it here, see section 1.8 */
953
954 /* Return the amount of data this dissector was able to dissect */
955         return tvb_length(tvb);
956 }
957
958
959 /* Register the protocol with Wireshark */
960
961 /* this format is require because a script is used to build the C function
962    that calls all the protocol registration.
963 */
964
965 void
966 proto_register_PROTOABBREV(void)
967 {
968         module_t *PROTOABBREV_module;
969
970 /* Setup list of header fields  See Section 1.6.1 for details*/
971         static hf_register_info hf[] = {
972                 { &hf_PROTOABBREV_FIELDABBREV,
973                         { "FIELDNAME",           "PROTOABBREV.FIELDABBREV",
974                         FIELDTYPE, FIELDDISPLAY, FIELDCONVERT, BITMASK,
975                         "FIELDDESCR", HFILL }
976                 }
977         };
978
979 /* Setup protocol subtree array */
980         static gint *ett[] = {
981                 &ett_PROTOABBREV
982         };
983
984 /* Register the protocol name and description */
985         proto_PROTOABBREV = proto_register_protocol("PROTONAME",
986             "PROTOSHORTNAME", "PROTOABBREV");
987
988 /* Required function calls to register the header fields and subtrees used */
989         proto_register_field_array(proto_PROTOABBREV, hf, array_length(hf));
990         proto_register_subtree_array(ett, array_length(ett));
991
992 /* Register preferences module (See Section 2.6 for more on preferences) */
993 /* (Registration of a prefs callback is not required if there are no     */
994 /*  prefs-dependent registration functions (eg: a port pref).            */
995 /*  See proto_reg_handoff below.                                         */
996 /*  If a prefs callback is not needed, use NULL instead of               */
997 /*  proto_reg_handoff_PROTOABBREV in the following).                     */
998         PROTOABBREV_module = prefs_register_protocol(proto_PROTOABBREV,
999             proto_reg_handoff_PROTOABBREV);
1000
1001 /* Register preferences module under preferences subtree.
1002    Use this function instead of prefs_register_protocol if you want to group
1003    preferences of several protocols under one preferences subtree.
1004    Argument subtree identifies grouping tree node name, several subnodes can be
1005    specified usign slash '/' (e.g. "OSI/X.500" - protocol preferences will be
1006    accessible under Protocols->OSI->X.500-><PROTOSHORTNAME> preferences node.
1007 */
1008   PROTOABBREV_module = prefs_register_protocol_subtree(const char *subtree,
1009        proto_PROTOABBREV, proto_reg_handoff_PROTOABBREV);
1010
1011 /* Register a sample preference */
1012         prefs_register_bool_preference(PROTOABBREV_module, "show_hex",
1013              "Display numbers in Hex",
1014              "Enable to display numerical values in hexadecimal.",
1015              &gPREF_HEX);
1016
1017 /* Register a sample port preference   */
1018         prefs_register_uint_preference(PROTOABBREV_module, "tcp.port", "PROTOABBREV TCP Port",
1019              " PROTOABBREV TCP port if other than the default",
1020              10, &gPORT_PREF);
1021 }
1022
1023
1024 /* If this dissector uses sub-dissector registration add a registration routine.
1025    This exact format is required because a script is used to find these
1026    routines and create the code that calls these routines.
1027
1028    If this function is registered as a prefs callback (see prefs_register_protocol
1029    above) this function is also called by preferences whenever "Apply" is pressed;
1030    In that case, it should accommodate being called more than once.
1031
1032    This form of the reg_handoff function is used if if you perform
1033    registration functions which are dependent upon prefs. See below
1034    for a simpler form  which can be used if there are no
1035    prefs-dependent registration functions.
1036 */
1037 void
1038 proto_reg_handoff_PROTOABBREV(void)
1039 {
1040         static gboolean initialized = FALSE;
1041         static dissector_handle_t PROTOABBREV_handle;
1042         static int currentPort;
1043
1044         if (!initialized) {
1045
1046 /*  Use new_create_dissector_handle() to indicate that dissect_PROTOABBREV()
1047  *  returns the number of bytes it dissected (or 0 if it thinks the packet
1048  *  does not belong to PROTONAME).
1049  */
1050                 PROTOABBREV_handle = new_create_dissector_handle(dissect_PROTOABBREV,
1051                                                                  proto_PROTOABBREV);
1052                 initialized = TRUE;
1053         } else {
1054
1055                 /*
1056                   If you perform registration functions which are dependent upon
1057                   prefs the you should de-register everything which was associated
1058                   with the previous settings and re-register using the new prefs
1059                   settings here. In general this means you need to keep track of
1060                   the PROTOABBREV_handle and the value the preference had at the time
1061                   you registered.  The PROTOABBREV_handle value and the value of the
1062                   preference can be saved using local statics in this
1063                   function (proto_reg_handoff).
1064                 */
1065
1066                 dissector_delete_uint("tcp.port", currentPort, PROTOABBREV_handle);
1067         }
1068
1069         currentPort = gPORT_PREF;
1070
1071         dissector_add_uint("tcp.port", currentPort, PROTOABBREV_handle);
1072
1073 }
1074
1075 #if 0
1076 /* Simple form of proto_reg_handoff_PROTOABBREV which can be used if there are
1077    no prefs-dependent registration function calls.
1078  */
1079
1080 void
1081 proto_reg_handoff_PROTOABBREV(void)
1082 {
1083         dissector_handle_t PROTOABBREV_handle;
1084
1085 /*  Use new_create_dissector_handle() to indicate that dissect_PROTOABBREV()
1086  *  returns the number of bytes it dissected (or 0 if it thinks the packet
1087  *  does not belong to PROTONAME).
1088  */
1089         PROTOABBREV_handle = new_create_dissector_handle(dissect_PROTOABBREV,
1090                                                          proto_PROTOABBREV);
1091         dissector_add_uint("PARENT_SUBFIELD", ID_VALUE, PROTOABBREV_handle);
1092 }
1093 #endif
1094
1095
1096 ------------------------------------Cut here------------------------------------
1097
1098 1.3 Explanation of needed substitutions in code skeleton.
1099
1100 In the above code block the following strings should be substituted with
1101 your information.
1102
1103 YOUR_NAME       Your name, of course.  You do want credit, don't you?
1104                 It's the only payment you will receive....
1105 YOUR_EMAIL_ADDRESS      Keep those cards and letters coming.
1106 WHATEVER_FILE_YOU_USED  Add this line if you are using another file as a
1107                 starting point.
1108 PROTONAME       The name of the protocol; this is displayed in the
1109                 top-level protocol tree item for that protocol.
1110 PROTOSHORTNAME  An abbreviated name for the protocol; this is displayed
1111                 in the "Preferences" dialog box if your dissector has
1112                 any preferences, in the dialog box of enabled protocols,
1113                 and in the dialog box for filter fields when constructing
1114                 a filter expression.
1115 PROTOABBREV     A name for the protocol for use in filter expressions;
1116                 it shall contain only lower-case letters, digits, and
1117                 hyphens.
1118 FIELDNAME       The displayed name for the header field.
1119 FIELDABBREV     The abbreviated name for the header field. (NO SPACES)
1120 FIELDTYPE       FT_NONE, FT_BOOLEAN, FT_UINT8, FT_UINT16, FT_UINT24,
1121                 FT_UINT32, FT_UINT64, FT_INT8, FT_INT16, FT_INT24, FT_INT32,
1122                 FT_INT64, FT_FLOAT, FT_DOUBLE, FT_ABSOLUTE_TIME,
1123                 FT_RELATIVE_TIME, FT_STRING, FT_STRINGZ, FT_EBCDIC,
1124                 FT_UINT_STRING, FT_ETHER, FT_BYTES, FT_UINT_BYTES, FT_IPv4,
1125                 FT_IPv6, FT_IPXNET, FT_FRAMENUM, FT_PROTOCOL, FT_GUID, FT_OID
1126 FIELDDISPLAY    For FT_UINT{8,16,24,32,64} and FT_INT{8,16,24,32,64):
1127
1128                 BASE_DEC, BASE_HEX, BASE_OCT, BASE_DEC_HEX, BASE_HEX_DEC,
1129                 or BASE_CUSTOM, possibly ORed with BASE_RANGE_STRING
1130
1131                 For FT_ABSOLUTE_TIME:
1132
1133                 ABSOLUTE_TIME_LOCAL, ABSOLUTE_TIME_UTC, or
1134                 ABSOLUTE_TIME_DOY_UTC
1135
1136                 For FT_BOOLEAN if BITMASK is non-zero:
1137
1138                 Number of bits in the field containing the FT_BOOLEAN
1139                 bitfield
1140
1141                 For all other types:
1142
1143                 BASE_NONE
1144 FIELDCONVERT    VALS(x), RVALS(x), TFS(x), NULL
1145 BITMASK         Usually 0x0 unless using the TFS(x) field conversion.
1146 FIELDDESCR      A brief description of the field, or NULL. [Please do not use ""].
1147 PARENT_SUBFIELD Lower level protocol field used for lookup, i.e. "tcp.port"
1148 ID_VALUE        Lower level protocol field value that identifies this protocol
1149                 For example the TCP or UDP port number
1150
1151 If, for example, PROTONAME is "Internet Bogosity Discovery Protocol",
1152 PROTOSHORTNAME would be "IBDP", and PROTOABBREV would be "ibdp".  Try to
1153 conform with IANA names.
1154
1155 1.4 The dissector and the data it receives.
1156
1157
1158 1.4.1 Header file.
1159
1160 This is only needed if the dissector doesn't use self-registration to
1161 register itself with the lower level dissector, or if the protocol dissector
1162 wants/needs to expose code to other subdissectors.
1163
1164 The dissector must be declared exactly as follows in the file
1165 packet-PROTOABBREV.h:
1166
1167 int
1168 dissect_PROTOABBREV(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
1169
1170
1171 1.4.2 Extracting data from packets.
1172
1173 NOTE: See the file /epan/tvbuff.h for more details.
1174
1175 The "tvb" argument to a dissector points to a buffer containing the raw
1176 data to be analyzed by the dissector; for example, for a protocol
1177 running atop UDP, it contains the UDP payload (but not the UDP header,
1178 or any protocol headers above it).  A tvbuffer is an opaque data
1179 structure, the internal data structures are hidden and the data must be
1180 accessed via the tvbuffer accessors.
1181
1182 The accessors are:
1183
1184 Bit accessors for a maximum of 8-bits, 16-bits 32-bits and 64-bits:
1185
1186 guint8 tvb_get_bits8(tvbuff_t *tvb, gint bit_offset, gint no_of_bits);
1187 guint16 tvb_get_bits16(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
1188 guint32 tvb_get_bits32(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
1189 guint64 tvb_get_bits64(tvbuff_t *tvb, gint bit_offset, gint no_of_bits,gboolean little_endian);
1190
1191 Single-byte accessor:
1192
1193 guint8  tvb_get_guint8(tvbuff_t*, gint offset);
1194
1195 Network-to-host-order accessors for 16-bit integers (guint16), 24-bit
1196 integers, 32-bit integers (guint32), and 64-bit integers (guint64):
1197
1198 guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
1199 guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
1200 guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
1201 guint64 tvb_get_ntoh40(tvbuff_t*, gint offset);
1202 guint64 tvb_get_ntoh48(tvbuff_t*, gint offset);
1203 guint64 tvb_get_ntoh56(tvbuff_t*, gint offset);
1204 guint64 tvb_get_ntoh64(tvbuff_t*, gint offset);
1205
1206 Network-to-host-order accessors for single-precision and
1207 double-precision IEEE floating-point numbers:
1208
1209 gfloat tvb_get_ntohieee_float(tvbuff_t*, gint offset);
1210 gdouble tvb_get_ntohieee_double(tvbuff_t*, gint offset);
1211
1212 Little-Endian-to-host-order accessors for 16-bit integers (guint16),
1213 24-bit integers, 32-bit integers (guint32), and 64-bit integers
1214 (guint64):
1215
1216 guint16 tvb_get_letohs(tvbuff_t*, gint offset);
1217 guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
1218 guint32 tvb_get_letohl(tvbuff_t*, gint offset);
1219 guint64 tvb_get_letoh40(tvbuff_t*, gint offset);
1220 guint64 tvb_get_letoh48(tvbuff_t*, gint offset);
1221 guint64 tvb_get_letoh56(tvbuff_t*, gint offset);
1222 guint64 tvb_get_letoh64(tvbuff_t*, gint offset);
1223
1224 Little-Endian-to-host-order accessors for single-precision and
1225 double-precision IEEE floating-point numbers:
1226
1227 gfloat tvb_get_letohieee_float(tvbuff_t*, gint offset);
1228 gdouble tvb_get_letohieee_double(tvbuff_t*, gint offset);
1229
1230 Accessors for IPv4 and IPv6 addresses:
1231
1232 guint32 tvb_get_ipv4(tvbuff_t*, gint offset);
1233 void tvb_get_ipv6(tvbuff_t*, gint offset, struct e_in6_addr *addr);
1234
1235 NOTE: IPv4 addresses are not to be converted to host byte order before
1236 being passed to "proto_tree_add_ipv4()".  You should use "tvb_get_ipv4()"
1237 to fetch them, not "tvb_get_ntohl()" *OR* "tvb_get_letohl()" - don't,
1238 for example, try to use "tvb_get_ntohl()", find that it gives you the
1239 wrong answer on the PC on which you're doing development, and try
1240 "tvb_get_letohl()" instead, as "tvb_get_letohl()" will give the wrong
1241 answer on big-endian machines.
1242
1243 Accessors for GUID:
1244
1245 void tvb_get_ntohguid(tvbuff_t *, gint offset, e_guid_t *guid);
1246 void tvb_get_letohguid(tvbuff_t *, gint offset, e_guid_t *guid);
1247
1248 String accessors:
1249
1250 guint8 *tvb_get_string(tvbuff_t*, gint offset, gint length);
1251 gchar  *tvb_get_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
1252 guint8 *tvb_get_ephemeral_string(tvbuff_t*, gint offset, gint length);
1253 gchar  *tvb_get_ephemeral_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
1254 guint8 *tvb_get_seasonal_string(tvbuff_t*, gint offset, gint length);
1255
1256 Returns a null-terminated buffer containing data from the specified
1257 tvbuff, starting at the specified offset, and containing the specified
1258 length worth of characters (the length of the buffer will be length+1,
1259 as it includes a null character to terminate the string).
1260
1261 tvb_get_string() returns a buffer allocated by g_malloc() so you must
1262 g_free() it when you are finished with the string. Failure to g_free() this
1263 buffer will lead to memory leaks.
1264
1265 tvb_get_unicode_string() is a unicode (UTF-16) version of above.  This
1266 is intended for reading UTF-16 unicode strings out of a tvbuff and
1267 returning them as a UTF-8 string for use in Wireshark.  The offset and
1268 returned length pointer are in bytes, not UTF-16 characters.
1269
1270 tvb_get_ephemeral_string() returns a buffer allocated from a special heap
1271 with a lifetime until the next packet is dissected. You do not need to
1272 free() this buffer, it will happen automatically once the next packet is
1273 dissected.
1274
1275 tvb_get_ephemeral_unicode_string() is a unicode (UTF-16) version of above.
1276 This is intended for reading UTF-16 unicode strings out of a tvbuff and
1277 returning them as a UTF-8 string for use in Wireshark.  The offset and
1278 returned length pointer are in bytes, not UTF-16 characters.
1279
1280 tvb_get_seasonal_string() returns a buffer allocated from a special heap
1281 with a lifetime of the current capture session. You do not need to
1282 free() this buffer, it will happen automatically once the a new capture or
1283 file is opened.
1284
1285 guint8 *tvb_get_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1286 const guint8 *tvb_get_const stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1287 guint8 *tvb_get_ephemeral_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1288 gchar  *tvb_get_ephemeral_unicode_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp, const guint encoding);
1289 guint8 *tvb_get_seasonal_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
1290
1291 Returns a null-terminated buffer containing data from the specified tvbuff,
1292 starting at the specified offset, and containing all characters from the
1293 tvbuff up to and including a terminating null character in the tvbuff.
1294 "*lengthp" will be set to the length of the string, including the terminating
1295 null.
1296
1297 tvb_get_stringz() returns a buffer allocated by g_malloc() so you must
1298 g_free() it when you are finished with the string. Failure to g_free() this
1299 buffer will lead to memory leaks.
1300
1301 tvb_get_const_stringz() returns a pointer to the (const) string in the tvbuff.
1302 You do not need to free() this buffer, it will happen automatically once the
1303 next packet is dissected.  This function is slightly more efficient than the
1304 others because it does not allocate memory and copy the string.
1305
1306 tvb_get_ephemeral_stringz() returns a buffer allocated from a special heap
1307 with a lifetime until the next packet is dissected. You do not need to
1308 free() this buffer, it will happen automatically once the next packet is
1309 dissected.
1310
1311 tvb_get_ephemeral_unicode_stringz() is a unicode (UTF-16) version of
1312 above.  This is intended for reading UTF-16 unicode strings out of a tvbuff
1313 and returning them as a UTF-8 string for use in Wireshark.  The offset and
1314 returned length pointer are in bytes, not UTF-16 characters.
1315
1316 tvb_get_seasonal_stringz() returns a buffer allocated from a special heap
1317 with a lifetime of the current capture session. You do not need to
1318 free() this buffer, it will happen automatically once the a new capture or
1319 file is opened.
1320
1321 tvb_fake_unicode() has been superceded by tvb_get_unicode_string(), which
1322 properly handles Unicode (UTF-16) strings by converting them to UTF-8.
1323
1324 tvb_get_ephemeral_faked_unicode() has been superceded by tvb_get_ephemeral_string(), which properly handles Unicode (UTF-16) strings by converting them
1325 to UTF-8.
1326
1327 Byte Array Accessors:
1328
1329 gchar *tvb_bytes_to_str(tvbuff_t *tvb, gint offset, gint len);
1330
1331 Formats a bunch of data from a tvbuff as bytes, returning a pointer
1332 to the string with the data formatted as two hex digits for each byte.
1333 The string pointed to is stored in an "ep_alloc'd" buffer which will be freed
1334 before the next frame is dissected. The formatted string will contain the hex digits
1335 for at most the first 16 bytes of the data. If len is greater than 16 bytes, a
1336 trailing "..." will be added to the string.
1337
1338 gchar *tvb_bytes_to_str_punct(tvbuff_t *tvb, gint offset, gint len, gchar punct);
1339
1340 This function is similar to tvb_bytes_to_str(...) except that 'punct' is inserted
1341 between the hex representation of each byte.
1342
1343 gchar *tvb_bcd_dig_to_ep_str(tvbuff_t *tvb, const gint offset, const gint len, dgt_set_t *dgt, gboolean skip_first);
1344
1345 Given a tvbuff, an offset into the tvbuff, and a length that starts
1346 at that offset (which may be -1 for "all the way to the end of the
1347 tvbuff"), fetch BCD encoded digits from a tvbuff starting from either
1348 the low or high half byte, formating the digits according to an input digit set,
1349 if NUll a default digit set of 0-9 returning "?" for overdecadic digits will be used.
1350 A pointer to the EP allocated string will be returned.
1351 Note: a tvbuff content of 0xf is considered a 'filler' and will end the conversion.
1352
1353 Copying memory:
1354 guint8* tvb_memcpy(tvbuff_t*, guint8* target, gint offset, gint length);
1355
1356 Copies into the specified target the specified length's worth of data
1357 from the specified tvbuff, starting at the specified offset.
1358
1359 guint8* tvb_memdup(tvbuff_t*, gint offset, gint length);
1360 guint8* ep_tvb_memdup(tvbuff_t*, gint offset, gint length);
1361
1362 Returns a buffer, allocated with "g_malloc()", containing the specified
1363 length's worth of data from the specified tvbuff, starting at the
1364 specified offset. The ephemeral variant is freed automatically after the
1365 packet is dissected.
1366
1367 Pointer-retrieval:
1368 /* WARNING! This function is possibly expensive, temporarily allocating
1369  * another copy of the packet data. Furthermore, it's dangerous because once
1370  * this pointer is given to the user, there's no guarantee that the user will
1371  * honor the 'length' and not overstep the boundaries of the buffer.
1372  */
1373 guint8* tvb_get_ptr(tvbuff_t*, gint offset, gint length);
1374
1375 The reason that tvb_get_ptr() might have to allocate a copy of its data
1376 only occurs with TVBUFF_COMPOSITES, data that spans multiple tvbuffers.
1377 If the user requests a pointer to a range of bytes that span the member
1378 tvbuffs that make up the TVBUFF_COMPOSITE, the data will have to be
1379 copied to another memory region to assure that all the bytes are
1380 contiguous.
1381
1382
1383
1384 1.5 Functions to handle columns in the traffic summary window.
1385
1386 The topmost pane of the main window is a list of the packets in the
1387 capture, possibly filtered by a display filter.
1388
1389 Each line corresponds to a packet, and has one or more columns, as
1390 configured by the user.
1391
1392 Many of the columns are handled by code outside individual dissectors;
1393 most dissectors need only specify the value to put in the "Protocol" and
1394 "Info" columns.
1395
1396 Columns are specified by COL_ values; the COL_ value for the "Protocol"
1397 field, typically giving an abbreviated name for the protocol (but not
1398 the all-lower-case abbreviation used elsewhere) is COL_PROTOCOL, and the
1399 COL_ value for the "Info" field, giving a summary of the contents of the
1400 packet for that protocol, is COL_INFO.
1401
1402 The value for a column can be specified with one of several functions,
1403 all of which take the 'fd' argument to the dissector as their first
1404 argument, and the COL_ value for the column as their second argument.
1405
1406 1.5.1 The col_set_str function.
1407
1408 'col_set_str' takes a string as its third argument, and sets the value
1409 for the column to that value.  It assumes that the pointer passed to it
1410 points to a string constant or a static "const" array, not to a
1411 variable, as it doesn't copy the string, it merely saves the pointer
1412 value; the argument can itself be a variable, as long as it always
1413 points to a string constant or a static "const" array.
1414
1415 It is more efficient than 'col_add_str' or 'col_add_fstr'; however, if
1416 the dissector will be using 'col_append_str' or 'col_append_fstr" to
1417 append more information to the column, the string will have to be copied
1418 anyway, so it's best to use 'col_add_str' rather than 'col_set_str' in
1419 that case.
1420
1421 For example, to set the "Protocol" column
1422 to "PROTOABBREV":
1423
1424         col_set_str(pinfo->cinfo, COL_PROTOCOL, "PROTOABBREV");
1425
1426
1427 1.5.2 The col_add_str function.
1428
1429 'col_add_str' takes a string as its third argument, and sets the value
1430 for the column to that value.  It takes the same arguments as
1431 'col_set_str', but copies the string, so that if the string is, for
1432 example, an automatic variable that won't remain in scope when the
1433 dissector returns, it's safe to use.
1434
1435
1436 1.5.3 The col_add_fstr function.
1437
1438 'col_add_fstr' takes a 'printf'-style format string as its third
1439 argument, and 'printf'-style arguments corresponding to '%' format
1440 items in that string as its subsequent arguments.  For example, to set
1441 the "Info" field to "<XXX> request, <N> bytes", where "reqtype" is a
1442 string containing the type of the request in the packet and "n" is an
1443 unsigned integer containing the number of bytes in the request:
1444
1445         col_add_fstr(pinfo->cinfo, COL_INFO, "%s request, %u bytes",
1446                      reqtype, n);
1447
1448 Don't use 'col_add_fstr' with a format argument of just "%s" -
1449 'col_add_str', or possibly even 'col_set_str' if the string that matches
1450 the "%s" is a static constant string, will do the same job more
1451 efficiently.
1452
1453
1454 1.5.4 The col_clear function.
1455
1456 If the Info column will be filled with information from the packet, that
1457 means that some data will be fetched from the packet before the Info
1458 column is filled in.  If the packet is so small that the data in
1459 question cannot be fetched, the routines to fetch the data will throw an
1460 exception (see the comment at the beginning about tvbuffers improving
1461 the handling of short packets - the tvbuffers keep track of how much
1462 data is in the packet, and throw an exception on an attempt to fetch
1463 data past the end of the packet, so that the dissector won't process
1464 bogus data), causing the Info column not to be filled in.
1465
1466 This means that the Info column will have data for the previous
1467 protocol, which would be confusing if, for example, the Protocol column
1468 had data for this protocol.
1469
1470 Therefore, before a dissector fetches any data whatsoever from the
1471 packet (unless it's a heuristic dissector fetching data to determine
1472 whether the packet is one that it should dissect, in which case it
1473 should check, before fetching the data, whether there's any data to
1474 fetch; if there isn't, it should return FALSE), it should set the
1475 Protocol column and the Info column.
1476
1477 If the Protocol column will ultimately be set to, for example, a value
1478 containing a protocol version number, with the version number being a
1479 field in the packet, the dissector should, before fetching the version
1480 number field or any other field from the packet, set it to a value
1481 without a version number, using 'col_set_str', and should later set it
1482 to a value with the version number after it's fetched the version
1483 number.
1484
1485 If the Info column will ultimately be set to a value containing
1486 information from the packet, the dissector should, before fetching any
1487 fields from the packet, clear the column using 'col_clear' (which is
1488 more efficient than clearing it by calling 'col_set_str' or
1489 'col_add_str' with a null string), and should later set it to the real
1490 string after it's fetched the data to use when doing that.
1491
1492
1493 1.5.5 The col_append_str function.
1494
1495 Sometimes the value of a column, especially the "Info" column, can't be
1496 conveniently constructed at a single point in the dissection process;
1497 for example, it might contain small bits of information from many of the
1498 fields in the packet.  'col_append_str' takes, as arguments, the same
1499 arguments as 'col_add_str', but the string is appended to the end of the
1500 current value for the column, rather than replacing the value for that
1501 column.  (Note that no blank separates the appended string from the
1502 string to which it is appended; if you want a blank there, you must add
1503 it yourself as part of the string being appended.)
1504
1505
1506 1.5.6 The col_append_fstr function.
1507
1508 'col_append_fstr' is to 'col_add_fstr' as 'col_append_str' is to
1509 'col_add_str' - it takes, as arguments, the same arguments as
1510 'col_add_fstr', but the formatted string is appended to the end of the
1511 current value for the column, rather than replacing the value for that
1512 column.
1513
1514 1.5.7 The col_append_sep_str and col_append_sep_fstr functions.
1515
1516 In specific situations the developer knows that a column's value will be
1517 created in a stepwise manner, where the appended values are listed. Both
1518 'col_append_sep_str' and 'col_append_sep_fstr' functions will add an item
1519 separator between two consecutive items, and will not add the separator at the
1520 beginning of the column. The remainder of the work both functions do is
1521 identical to what 'col_append_str' and 'col_append_fstr' do.
1522
1523 1.5.8 The col_set_fence and col_prepend_fence_fstr functions.
1524
1525 Sometimes a dissector may be called multiple times for different PDUs in the
1526 same frame (for example in the case of SCTP chunk bundling: several upper
1527 layer data packets may be contained in one SCTP packet).  If the upper layer
1528 dissector calls 'col_set_str()' or 'col_clear()' on the Info column when it
1529 begins dissecting each of those PDUs then when the frame is fully dissected
1530 the Info column would contain only the string from the last PDU in the frame.
1531 The 'col_set_fence' function erects a "fence" in the column that prevents
1532 subsequent 'col_...' calls from clearing the data currently in that column.
1533 For example, the SCTP dissector calls 'col_set_fence' on the Info column
1534 after it has called any subdissectors for that chunk so that subdissectors
1535 of any subsequent chunks may only append to the Info column.
1536 'col_prepend_fence_fstr' prepends data before a fence (moving it if
1537 necessary).  It will create a fence at the end of the prepended data if the
1538 fence does not already exist.
1539
1540
1541 1.5.9 The col_set_time function.
1542
1543 The 'col_set_time' function takes an nstime value as its third argument.
1544 This nstime value is a relative value and will be added as such to the
1545 column. The fourth argument is the filtername holding this value. This
1546 way, rightclicking on the column makes it possible to build a filter
1547 based on the time-value.
1548
1549 For example:
1550
1551         nstime_delta(&ts, &pinfo->fd->abs_ts, &tcpd->ts_first);
1552         col_set_time(pinfo->cinfo, COL_REL_CONV_TIME, &ts, "tcp.time_relative");
1553
1554
1555 1.6 Constructing the protocol tree.
1556
1557 The middle pane of the main window, and the topmost pane of a packet
1558 popup window, are constructed from the "protocol tree" for a packet.
1559
1560 The protocol tree, or proto_tree, is a GNode, the N-way tree structure
1561 available within GLIB. Of course the protocol dissectors don't care
1562 what a proto_tree really is; they just pass the proto_tree pointer as an
1563 argument to the routines which allow them to add items and new branches
1564 to the tree.
1565
1566 When a packet is selected in the packet-list pane, or a packet popup
1567 window is created, a new logical protocol tree (proto_tree) is created.
1568 The pointer to the proto_tree (in this case, 'protocol tree'), is passed
1569 to the top-level protocol dissector, and then to all subsequent protocol
1570 dissectors for that packet, and then the GUI tree is drawn via
1571 proto_tree_draw().
1572
1573 The logical proto_tree needs to know detailed information about the protocols
1574 and fields about which information will be collected from the dissection
1575 routines. By strictly defining (or "typing") the data that can be attached to a
1576 proto tree, searching and filtering becomes possible.  This means that for
1577 every protocol and field (which I also call "header fields", since they are
1578 fields in the protocol headers) which might be attached to a tree, some
1579 information is needed.
1580
1581 Every dissector routine will need to register its protocols and fields
1582 with the central protocol routines (in proto.c). At first I thought I
1583 might keep all the protocol and field information about all the
1584 dissectors in one file, but decentralization seemed like a better idea.
1585 That one file would have gotten very large; one small change would have
1586 required a re-compilation of the entire file. Also, by allowing
1587 registration of protocols and fields at run-time, loadable modules of
1588 protocol dissectors (perhaps even user-supplied) is feasible.
1589
1590 To do this, each protocol should have a register routine, which will be
1591 called when Wireshark starts.  The code to call the register routines is
1592 generated automatically; to arrange that a protocol's register routine
1593 be called at startup:
1594
1595         the file containing a dissector's "register" routine must be
1596         added to "DISSECTOR_SRC" in "epan/dissectors/Makefile.common"
1597         (and in "epan/CMakeLists.txt");
1598
1599         the "register" routine must have a name of the form
1600         "proto_register_XXX";
1601
1602         the "register" routine must take no argument, and return no
1603         value;
1604
1605         the "register" routine's name must appear in the source file
1606         either at the beginning of the line, or preceded only by "void "
1607         at the beginning of the line (that would typically be the
1608         definition) - other white space shouldn't cause a problem, e.g.:
1609
1610 void proto_register_XXX(void) {
1611
1612         ...
1613
1614 }
1615
1616 and
1617
1618 void
1619 proto_register_XXX( void )
1620 {
1621
1622         ...
1623
1624 }
1625
1626         and so on should work.
1627
1628 For every protocol or field that a dissector wants to register, a variable of
1629 type int needs to be used to keep track of the protocol. The IDs are
1630 needed for establishing parent/child relationships between protocols and
1631 fields, as well as associating data with a particular field so that it
1632 can be stored in the logical tree and displayed in the GUI protocol
1633 tree.
1634
1635 Some dissectors will need to create branches within their tree to help
1636 organize header fields. These branches should be registered as header
1637 fields. Only true protocols should be registered as protocols. This is
1638 so that a display filter user interface knows how to distinguish
1639 protocols from fields.
1640
1641 A protocol is registered with the name of the protocol and its
1642 abbreviation.
1643
1644 Here is how the frame "protocol" is registered.
1645
1646         int proto_frame;
1647
1648         proto_frame = proto_register_protocol (
1649                 /* name */            "Frame",
1650                 /* short name */      "Frame",
1651                 /* abbrev */          "frame" );
1652
1653 A header field is also registered with its name and abbreviation, but
1654 information about its data type is needed. It helps to look at
1655 the header_field_info struct to see what information is expected:
1656
1657 struct header_field_info {
1658         const char                      *name;
1659         const char                      *abbrev;
1660         enum ftenum                     type;
1661         int                             display;
1662         const void                      *strings;
1663         guint32                         bitmask;
1664         const char                      *blurb;
1665         .....
1666 };
1667
1668 name
1669 ----
1670 A string representing the name of the field. This is the name
1671 that will appear in the graphical protocol tree.  It must be a non-empty
1672 string.
1673
1674 abbrev
1675 ------
1676 A string with an abbreviation of the field. We concatenate the
1677 abbreviation of the parent protocol with an abbreviation for the field,
1678 using a period as a separator. For example, the "src" field in an IP packet
1679 would have "ip.src" as an abbreviation. It is acceptable to have
1680 multiple levels of periods if, for example, you have fields in your
1681 protocol that are then subdivided into subfields. For example, TRMAC
1682 has multiple error fields, so the abbreviations follow this pattern:
1683 "trmac.errors.iso", "trmac.errors.noniso", etc.
1684
1685 The abbreviation is the identifier used in a display filter.  If it is
1686 an empty string then the field will not be filterable.
1687
1688 type
1689 ----
1690 The type of value this field holds. The current field types are:
1691
1692         FT_NONE                 No field type. Used for fields that
1693                                 aren't given a value, and that can only
1694                                 be tested for presence or absence; a
1695                                 field that represents a data structure,
1696                                 with a subtree below it containing
1697                                 fields for the members of the structure,
1698                                 or that represents an array with a
1699                                 subtree below it containing fields for
1700                                 the members of the array, might be an
1701                                 FT_NONE field.
1702         FT_PROTOCOL             Used for protocols which will be placing
1703                                 themselves as top-level items in the
1704                                 "Packet Details" pane of the UI.
1705         FT_BOOLEAN              0 means "false", any other value means
1706                                 "true".
1707         FT_FRAMENUM             A frame number; if this is used, the "Go
1708                                 To Corresponding Frame" menu item can
1709                                 work on that field.
1710         FT_UINT8                An 8-bit unsigned integer.
1711         FT_UINT16               A 16-bit unsigned integer.
1712         FT_UINT24               A 24-bit unsigned integer.
1713         FT_UINT32               A 32-bit unsigned integer.
1714         FT_UINT64               A 64-bit unsigned integer.
1715         FT_INT8                 An 8-bit signed integer.
1716         FT_INT16                A 16-bit signed integer.
1717         FT_INT24                A 24-bit signed integer.
1718         FT_INT32                A 32-bit signed integer.
1719         FT_INT64                A 64-bit signed integer.
1720         FT_FLOAT                A single-precision floating point number.
1721         FT_DOUBLE               A double-precision floating point number.
1722         FT_ABSOLUTE_TIME        Seconds (4 bytes) and nanoseconds (4 bytes)
1723                                 of time since January 1, 1970, midnight
1724                                 UTC, displayed as the date, followed by
1725                                 the time, as hours, minutes, and seconds
1726                                 with 9 digits after the decimal point.
1727         FT_RELATIVE_TIME        Seconds (4 bytes) and nanoseconds (4 bytes)
1728                                 of time relative to an arbitrary time.
1729                                 displayed as seconds and 9 digits
1730                                 after the decimal point.
1731         FT_STRING               A string of characters, not necessarily
1732                                 NUL-terminated, but possibly NUL-padded.
1733                                 This, and the other string-of-characters
1734                                 types, are to be used for text strings,
1735                                 not raw binary data.
1736         FT_STRINGZ              A NUL-terminated string of characters.
1737         FT_EBCDIC               A string of characters, not necessarily
1738                                 NUL-terminated, but possibly NUL-padded.
1739                                 The data from the packet is converted from
1740                                 EBCDIC to ASCII before displaying to the user.
1741         FT_UINT_STRING          A counted string of characters, consisting
1742                                 of a count (represented as an integral value,
1743                                 of width given in the proto_tree_add_item()
1744                                 call) followed immediately by that number of
1745                                 characters.
1746         FT_ETHER                A six octet string displayed in
1747                                 Ethernet-address format.
1748         FT_BYTES                A string of bytes with arbitrary values;
1749                                 used for raw binary data.
1750         FT_UINT_BYTES           A counted string of bytes, consisting
1751                                 of a count (represented as an integral value,
1752                                 of width given in the proto_tree_add_item()
1753                                 call) followed immediately by that number of
1754                                 arbitrary values; used for raw binary data.
1755         FT_IPv4                 A version 4 IP address (4 bytes) displayed
1756                                 in dotted-quad IP address format (4
1757                                 decimal numbers separated by dots).
1758         FT_IPv6                 A version 6 IP address (16 bytes) displayed
1759                                 in standard IPv6 address format.
1760         FT_IPXNET               An IPX address displayed in hex as a 6-byte
1761                                 network number followed by a 6-byte station
1762                                 address.
1763         FT_GUID                 A Globally Unique Identifier
1764         FT_OID                  An ASN.1 Object Identifier
1765
1766 Some of these field types are still not handled in the display filter
1767 routines, but the most common ones are. The FT_UINT* variables all
1768 represent unsigned integers, and the FT_INT* variables all represent
1769 signed integers; the number on the end represent how many bits are used
1770 to represent the number.
1771
1772 Some constraints are imposed on the header fields depending on the type
1773 (e.g.  FT_BYTES) of the field.  Fields of type FT_ABSOLUTE_TIME must use
1774 'ABSOLUTE_TIME_{LOCAL,UTC,DOY_UTC}, NULL, 0x0' as values for the
1775 'display, 'strings', and 'bitmask' fields, and all other non-integral
1776 types (i.e.. types that are _not_ FT_INT* and FT_UINT*) must use
1777 'BASE_NONE, NULL, 0x0' as values for the 'display', 'strings', 'bitmask'
1778 fields.  The reason is simply that the type itself implictly defines the
1779 nature of 'display', 'strings', 'bitmask'.
1780
1781 display
1782 -------
1783 The display field has a couple of overloaded uses. This is unfortunate,
1784 but since we're using C as an application programming language, this sometimes
1785 makes for cleaner programs. Right now I still think that overloading
1786 this variable was okay.
1787
1788 For integer fields (FT_UINT* and FT_INT*), this variable represents the
1789 base in which you would like the value displayed.  The acceptable bases
1790 are:
1791
1792         BASE_DEC,
1793         BASE_HEX,
1794         BASE_OCT,
1795         BASE_DEC_HEX,
1796         BASE_HEX_DEC,
1797         BASE_CUSTOM
1798
1799 BASE_DEC, BASE_HEX, and BASE_OCT are decimal, hexadecimal, and octal,
1800 respectively. BASE_DEC_HEX and BASE_HEX_DEC display value in two bases
1801 (the 1st representation followed by the 2nd in parenthesis).
1802
1803 BASE_CUSTOM allows one to specify a callback function pointer that will
1804 format the value. The function pointer of the same type as defined by
1805 custom_fmt_func_t in epan/proto.h, specifically:
1806
1807   void func(gchar *, guint32);
1808
1809 The first argument is a pointer to a buffer of the ITEM_LABEL_LENGTH size
1810 and the second argument is the value to be formatted.
1811
1812 For FT_BOOLEAN fields that are also bitfields (i.e. 'bitmask' is non-zero),
1813 'display' is used to tell the proto_tree how wide the parent bitfield is.
1814 With integers this is not needed since the type of integer itself
1815 (FT_UINT8, FT_UINT16, FT_UINT24, FT_UINT32, etc.) tells the proto_tree how
1816 wide the parent bitfield is.
1817
1818 For FT_ABSOLUTE_TIME fields, 'display' is used to indicate whether the
1819 time is to be displayed as a time in the time zone for the machine on
1820 which Wireshark/TShark is running or as UTC and, for UTC, whether the
1821 date should be displayed as "{monthname}, {month} {day_of_month},
1822 {year}" or as "{year/day_of_year}".
1823
1824 Additionally, BASE_NONE is used for 'display' as a NULL-value. That is, for
1825 non-integers other than FT_ABSOLUTE_TIME fields, and non-bitfield
1826 FT_BOOLEANs, you'll want to use BASE_NONE in the 'display' field.  You may
1827 not use BASE_NONE for integers.
1828
1829 It is possible that in the future we will record the endianness of
1830 integers. If so, it is likely that we'll use a bitmask on the display field
1831 so that integers would be represented as BEND|BASE_DEC or LEND|BASE_HEX.
1832 But that has not happened yet; note that there are protocols for which
1833 no endianness is specified, such as the X11 protocol and the DCE RPC
1834 protocol, so it would not be possible to record the endianness of all
1835 integral fields.
1836
1837 strings
1838 -------
1839 -- value_string
1840 Some integer fields, of type FT_UINT*, need labels to represent the true
1841 value of a field.  You could think of those fields as having an
1842 enumerated data type, rather than an integral data type.
1843
1844 A 'value_string' structure is a way to map values to strings.
1845
1846         typedef struct _value_string {
1847                 guint32  value;
1848                 gchar   *strptr;
1849         } value_string;
1850
1851 For fields of that type, you would declare an array of "value_string"s:
1852
1853         static const value_string valstringname[] = {
1854                 { INTVAL1, "Descriptive String 1" },
1855                 { INTVAL2, "Descriptive String 2" },
1856                 { 0,       NULL }
1857         };
1858
1859 (the last entry in the array must have a NULL 'strptr' value, to
1860 indicate the end of the array).  The 'strings' field would be set to
1861 'VALS(valstringname)'.
1862
1863 If the field has a numeric rather than an enumerated type, the 'strings'
1864 field would be set to NULL.
1865
1866 -- Extended value strings
1867 You can also use an extended version of the value_string for faster lookups.
1868 It requires a value_string as input.
1869 If all of a contiguous range of values from min to max are present in the array
1870 the value will be used as as a direct index into a value_string array.
1871
1872 If the values in the array are not contiguous (ie: there are "gaps"), but are in assending order
1873 a binary search will be used.
1874
1875 Note: "gaps" in a value_string array can be filled with "empty" entries eg: {value, "Unknown"} so that
1876 direct access to the array is is possible.
1877
1878 The init macro (see below) will perform a check on the value string
1879 the first time it is used to determine which search algorithm fits and fall back to a linear search
1880 if the value_string does not meet the criteria above.
1881
1882 Use this macro to initialise the extended value_string at comile time:
1883
1884 static value_string_ext valstringname_ext = VALUE_STRING_EXT_INIT(valstringname);
1885
1886 Extended value strings can be created at runtime by calling
1887    value_string_ext_new(<ptr to value_string array>,
1888                         <total number of entries in the value_string_array>, /* include {0, NULL} entry */
1889                         <value_string_name>);
1890
1891 For hf[] array FT_(U)INT* fields that need a 'valstringname_ext' struct, the 'strings' field
1892 would be set to '&valstringname_ext)'. Furthermore, 'display' field must be
1893 ORed with 'BASE_EXT_STRING' (e.g. BASE_DEC|BASE_EXT_STRING).
1894
1895
1896 -- Ranges
1897 If the field has a numeric type that might logically fit in ranges of values
1898 one can use a range_string struct.
1899
1900 Thus a 'range_string' structure is a way to map ranges to strings.
1901
1902         typedef struct _range_string {
1903                 guint32        value_min;
1904                 guint32        value_max;
1905                 const gchar   *strptr;
1906         } range_string;
1907
1908 For fields of that type, you would declare an array of "range_string"s:
1909
1910         static const range_string rvalstringname[] = {
1911                 { INTVAL_MIN1, INTVALMAX1, "Descriptive String 1" },
1912                 { INTVAL_MIN2, INTVALMAX2, "Descriptive String 2" },
1913                 { 0,           0,          NULL                   }
1914         };
1915
1916 If INTVAL_MIN equals INTVAL_MAX for a given entry the range_string
1917 behavior collapses to the one of value_string.
1918 For FT_(U)INT* fields that need a 'range_string' struct, the 'strings' field
1919 would be set to 'RVALS(rvalstringname)'. Furthermore, 'display' field must be
1920 ORed with 'BASE_RANGE_STRING' (e.g. BASE_DEC|BASE_RANGE_STRING).
1921
1922 -- Booleans
1923 FT_BOOLEANs have a default map of 0 = "False", 1 (or anything else) = "True".
1924 Sometimes it is useful to change the labels for boolean values (e.g.,
1925 to "Yes"/"No", "Fast"/"Slow", etc.).  For these mappings, a struct called
1926 true_false_string is used.
1927
1928         typedef struct true_false_string {
1929                 char    *true_string;
1930                 char    *false_string;
1931         } true_false_string;
1932
1933 For Boolean fields for which "False" and "True" aren't the desired
1934 labels, you would declare a "true_false_string"s:
1935
1936         static const true_false_string boolstringname = {
1937                 "String for True",
1938                 "String for False"
1939         };
1940
1941 Its two fields are pointers to the string representing truth, and the
1942 string representing falsehood.  For FT_BOOLEAN fields that need a
1943 'true_false_string' struct, the 'strings' field would be set to
1944 'TFS(&boolstringname)'.
1945
1946 If the Boolean field is to be displayed as "False" or "True", the
1947 'strings' field would be set to NULL.
1948
1949 Wireshark predefines a whole range of ready made "true_false_string"s
1950 in tfs.h, included via packet.h.
1951
1952 bitmask
1953 -------
1954 If the field is a bitfield, then the bitmask is the mask which will
1955 leave only the bits needed to make the field when ANDed with a value.
1956 The proto_tree routines will calculate 'bitshift' automatically
1957 from 'bitmask', by finding the rightmost set bit in the bitmask.
1958 This shift is applied before applying string mapping functions or
1959 filtering.
1960 If the field is not a bitfield, then bitmask should be set to 0.
1961
1962 blurb
1963 -----
1964 This is a string giving a proper description of the field.  It should be
1965 at least one grammatically complete sentence, or NULL in which case the
1966 name field is used. (Please do not use "").
1967 It is meant to provide a more detailed description of the field than the
1968 name alone provides. This information will be used in the man page, and
1969 in a future GUI display-filter creation tool. We might also add tooltips
1970 to the labels in the GUI protocol tree, in which case the blurb would
1971 be used as the tooltip text.
1972
1973
1974 1.6.1 Field Registration.
1975
1976 Protocol registration is handled by creating an instance of the
1977 header_field_info struct (or an array of such structs), and
1978 calling the registration function along with the registration ID of
1979 the protocol that is the parent of the fields. Here is a complete example:
1980
1981         static int proto_eg = -1;
1982         static int hf_field_a = -1;
1983         static int hf_field_b = -1;
1984
1985         static hf_register_info hf[] = {
1986
1987                 { &hf_field_a,
1988                 { "Field A",    "proto.field_a", FT_UINT8, BASE_HEX, NULL,
1989                         0xf0, "Field A represents Apples", HFILL }},
1990
1991                 { &hf_field_b,
1992                 { "Field B",    "proto.field_b", FT_UINT16, BASE_DEC, VALS(vs),
1993                         0x0, "Field B represents Bananas", HFILL }}
1994         };
1995
1996         proto_eg = proto_register_protocol("Example Protocol",
1997             "PROTO", "proto");
1998         proto_register_field_array(proto_eg, hf, array_length(hf));
1999
2000 Be sure that your array of hf_register_info structs is declared 'static',
2001 since the proto_register_field_array() function does not create a copy
2002 of the information in the array... it uses that static copy of the
2003 information that the compiler created inside your array. Here's the
2004 layout of the hf_register_info struct:
2005
2006 typedef struct hf_register_info {
2007         int                     *p_id;  /* pointer to parent variable */
2008         header_field_info       hfinfo;
2009 } hf_register_info;
2010
2011 Also be sure to use the handy array_length() macro found in packet.h
2012 to have the compiler compute the array length for you at compile time.
2013
2014 If you don't have any fields to register, do *NOT* create a zero-length
2015 "hf" array; not all compilers used to compile Wireshark support them.
2016 Just omit the "hf" array, and the "proto_register_field_array()" call,
2017 entirely.
2018
2019 It is OK to have header fields with a different format be registered with
2020 the same abbreviation. For instance, the following is valid:
2021
2022         static hf_register_info hf[] = {
2023
2024                 { &hf_field_8bit, /* 8-bit version of proto.field */
2025                 { "Field (8 bit)", "proto.field", FT_UINT8, BASE_DEC, NULL,
2026                         0x00, "Field represents FOO", HFILL }},
2027
2028                 { &hf_field_32bit, /* 32-bit version of proto.field */
2029                 { "Field (32 bit)", "proto.field", FT_UINT32, BASE_DEC, NULL,
2030                         0x00, "Field represents FOO", HFILL }}
2031         };
2032
2033 This way a filter expression can match a header field, irrespective of the
2034 representation of it in the specific protocol context. This is interesting
2035 for protocols with variable-width header fields.
2036
2037 The HFILL macro at the end of the struct will set reasonable default values
2038 for internally used fields.
2039
2040 1.6.2 Adding Items and Values to the Protocol Tree.
2041
2042 A protocol item is added to an existing protocol tree with one of a
2043 handful of proto_XXX_DO_YYY() functions.
2044
2045 Remember that it only makes sense to add items to a protocol tree if its
2046 proto_tree pointer is not null. Should you add an item to a NULL tree, then
2047 the proto_XXX_DO_YYY() function will immediately return. The cost of this
2048 function call can be avoided by checking for the tree pointer.
2049
2050 Subtrees can be made with the proto_item_add_subtree() function:
2051
2052         item = proto_tree_add_item(....);
2053         new_tree = proto_item_add_subtree(item, tree_type);
2054
2055 This will add a subtree under the item in question; a subtree can be
2056 created under an item made by any of the "proto_tree_add_XXX" functions,
2057 so that the tree can be given an arbitrary depth.
2058
2059 Subtree types are integers, assigned by
2060 "proto_register_subtree_array()".  To register subtree types, pass an
2061 array of pointers to "gint" variables to hold the subtree type values to
2062 "proto_register_subtree_array()":
2063
2064         static gint ett_eg = -1;
2065         static gint ett_field_a = -1;
2066
2067         static gint *ett[] = {
2068                 &ett_eg,
2069                 &ett_field_a
2070         };
2071
2072         proto_register_subtree_array(ett, array_length(ett));
2073
2074 in your "register" routine, just as you register the protocol and the
2075 fields for that protocol.
2076
2077 The ett_ variables identify particular type of subtree so that if you expand
2078 one of them, Wireshark keeps track of that and, when you click on
2079 another packet, it automatically opens all subtrees of that type.
2080 If you close one of them, all subtrees of that type will be closed when
2081 you move to another packet.
2082
2083 There are several functions that the programmer can use to add either
2084 protocol or field labels to the proto_tree:
2085
2086         proto_item*
2087         proto_tree_add_item(tree, id, tvb, start, length, encoding);
2088
2089         proto_item*
2090         proto_tree_add_none_format(tree, id, tvb, start, length, format, ...);
2091
2092         proto_item*
2093         proto_tree_add_protocol_format(tree, id, tvb, start, length,
2094                 format, ...);
2095
2096         proto_item *
2097         proto_tree_add_bytes(tree, id, tvb, start, length, start_ptr);
2098
2099         proto_item *
2100         proto_tree_add_bytes_format(tree, id, tvb, start, length, start_ptr,
2101                 format, ...);
2102
2103         proto_item *
2104         proto_tree_add_bytes_format_value(tree, id, tvb, start, length,
2105                 start_ptr, format, ...);
2106
2107         proto_item *
2108         proto_tree_add_time(tree, id, tvb, start, length, value_ptr);
2109
2110         proto_item *
2111         proto_tree_add_time_format(tree, id, tvb, start, length, value_ptr,
2112                 format, ...);
2113
2114         proto_item *
2115         proto_tree_add_time_format_value(tree, id, tvb, start, length,
2116                 value_ptr, format, ...);
2117
2118         proto_item *
2119         proto_tree_add_ipxnet(tree, id, tvb, start, length, value);
2120
2121         proto_item *
2122         proto_tree_add_ipxnet_format(tree, id, tvb, start, length, value,
2123                 format, ...);
2124
2125         proto_item *
2126         proto_tree_add_ipxnet_format_value(tree, id, tvb, start, length,
2127                 value, format, ...);
2128
2129         proto_item *
2130         proto_tree_add_ipv4(tree, id, tvb, start, length, value);
2131
2132         proto_item *
2133         proto_tree_add_ipv4_format(tree, id, tvb, start, length, value,
2134                 format, ...);
2135
2136         proto_item *
2137         proto_tree_add_ipv4_format_value(tree, id, tvb, start, length,
2138                 value, format, ...);
2139
2140         proto_item *
2141         proto_tree_add_ipv6(tree, id, tvb, start, length, value_ptr);
2142
2143         proto_item *
2144         proto_tree_add_ipv6_format(tree, id, tvb, start, length, value_ptr,
2145                 format, ...);
2146
2147         proto_item *
2148         proto_tree_add_ipv6_format_value(tree, id, tvb, start, length,
2149                 value_ptr, format, ...);
2150
2151         proto_item *
2152         proto_tree_add_ether(tree, id, tvb, start, length, value_ptr);
2153
2154         proto_item *
2155         proto_tree_add_ether_format(tree, id, tvb, start, length, value_ptr,
2156                 format, ...);
2157
2158         proto_item *
2159         proto_tree_add_ether_format_value(tree, id, tvb, start, length,
2160                 value_ptr, format, ...);
2161
2162         proto_item *
2163         proto_tree_add_string(tree, id, tvb, start, length, value_ptr);
2164
2165         proto_item *
2166         proto_tree_add_string_format(tree, id, tvb, start, length, value_ptr,
2167                 format, ...);
2168
2169         proto_item *
2170         proto_tree_add_string_format_value(tree, id, tvb, start, length,
2171                 value_ptr, format, ...);
2172
2173         proto_item *
2174         proto_tree_add_boolean(tree, id, tvb, start, length, value);
2175
2176         proto_item *
2177         proto_tree_add_boolean_format(tree, id, tvb, start, length, value,
2178                 format, ...);
2179
2180         proto_item *
2181         proto_tree_add_boolean_format_value(tree, id, tvb, start, length,
2182                 value, format, ...);
2183
2184         proto_item *
2185         proto_tree_add_float(tree, id, tvb, start, length, value);
2186
2187         proto_item *
2188         proto_tree_add_float_format(tree, id, tvb, start, length, value,
2189                 format, ...);
2190
2191         proto_item *
2192         proto_tree_add_float_format_value(tree, id, tvb, start, length,
2193                 value, format, ...);
2194
2195         proto_item *
2196         proto_tree_add_double(tree, id, tvb, start, length, value);
2197
2198         proto_item *
2199         proto_tree_add_double_format(tree, id, tvb, start, length, value,
2200                 format, ...);
2201
2202         proto_item *
2203         proto_tree_add_double_format_value(tree, id, tvb, start, length,
2204                 value, format, ...);
2205
2206         proto_item *
2207         proto_tree_add_uint(tree, id, tvb, start, length, value);
2208
2209         proto_item *
2210         proto_tree_add_uint_format(tree, id, tvb, start, length, value,
2211                 format, ...);
2212
2213         proto_item *
2214         proto_tree_add_uint_format_value(tree, id, tvb, start, length,
2215                 value, format, ...);
2216
2217         proto_item *
2218         proto_tree_add_uint64(tree, id, tvb, start, length, value);
2219
2220         proto_item *
2221         proto_tree_add_uint64_format(tree, id, tvb, start, length, value,
2222                 format, ...);
2223
2224         proto_item *
2225         proto_tree_add_uint64_format_value(tree, id, tvb, start, length,
2226                 value, format, ...);
2227
2228         proto_item *
2229         proto_tree_add_int(tree, id, tvb, start, length, value);
2230
2231         proto_item *
2232         proto_tree_add_int_format(tree, id, tvb, start, length, value,
2233                 format, ...);
2234
2235         proto_item *
2236         proto_tree_add_int_format_value(tree, id, tvb, start, length,
2237                 value, format, ...);
2238
2239         proto_item *
2240         proto_tree_add_int64(tree, id, tvb, start, length, value);
2241
2242         proto_item *
2243         proto_tree_add_int64_format(tree, id, tvb, start, length, value,
2244                 format, ...);
2245
2246         proto_item *
2247         proto_tree_add_int64_format_value(tree, id, tvb, start, length,
2248                 value, format, ...);
2249
2250         proto_item*
2251         proto_tree_add_text(tree, tvb, start, length, format, ...);
2252
2253         proto_item*
2254         proto_tree_add_text_valist(tree, tvb, start, length, format, ap);
2255
2256         proto_item *
2257         proto_tree_add_guid(tree, id, tvb, start, length, value_ptr);
2258
2259         proto_item *
2260         proto_tree_add_guid_format(tree, id, tvb, start, length, value_ptr,
2261                 format, ...);
2262
2263         proto_item *
2264         proto_tree_add_guid_format_value(tree, id, tvb, start, length,
2265                 value_ptr, format, ...);
2266
2267         proto_item *
2268         proto_tree_add_oid(tree, id, tvb, start, length, value_ptr);
2269
2270         proto_item *
2271         proto_tree_add_oid_format(tree, id, tvb, start, length, value_ptr,
2272                 format, ...);
2273
2274         proto_item *
2275         proto_tree_add_oid_format_value(tree, id, tvb, start, length,
2276                 value_ptr, format, ...);
2277
2278         proto_item*
2279         proto_tree_add_bits_item(tree, id, tvb, bit_offset, no_of_bits,
2280                 little_endian);
2281
2282         proto_item *
2283         proto_tree_add_bits_ret_val(tree, id, tvb, bit_offset, no_of_bits,
2284                 return_value, little_endian);
2285
2286         proto_item *
2287         proto_tree_add_bitmask(tree, tvb, start, header, ett, fields,
2288                 little_endian);
2289
2290         proto_item *
2291         proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
2292                 ett, fields, little_endian, flags);
2293
2294 The 'tree' argument is the tree to which the item is to be added.  The
2295 'tvb' argument is the tvbuff from which the item's value is being
2296 extracted; the 'start' argument is the offset from the beginning of that
2297 tvbuff of the item being added, and the 'length' argument is the length,
2298 in bytes, of the item, bit_offset is the offset in bits and no_of_bits
2299 is the length in bits.
2300
2301 The length of some items cannot be determined until the item has been
2302 dissected; to add such an item, add it with a length of -1, and, when the
2303 dissection is complete, set the length with 'proto_item_set_len()':
2304
2305         void
2306         proto_item_set_len(ti, length);
2307
2308 The "ti" argument is the value returned by the call that added the item
2309 to the tree, and the "length" argument is the length of the item.
2310
2311 proto_tree_add_item()
2312 ---------------------
2313 proto_tree_add_item is used when you wish to do no special formatting.
2314 The item added to the GUI tree will contain the name (as passed in the
2315 proto_register_*() function) and a value.  The value will be fetched
2316 from the tvbuff by proto_tree_add_item(), based on the type of the field
2317 and, for integral and Boolean fields, the byte order of the value; the
2318 byte order, for items for which that's relevant, is specified by the
2319 'encoding' argument, which is ENC_LITTLE_ENDIAN if the value is
2320 little-endian and ENC_BIG_ENDIAN if it is big-endian.  If the byte order
2321 is not relevant, use ENC_NA (Not Applicable).  In the future, other
2322 elements of the encoding, such as the character encoding for
2323 character strings, might be supported.
2324
2325 Now that definitions of fields have detailed information about bitfield
2326 fields, you can use proto_tree_add_item() with no extra processing to
2327 add bitfield values to your tree.  Here's an example.  Take the Format
2328 Identifier (FID) field in the Transmission Header (TH) portion of the SNA
2329 protocol.  The FID is the high nibble of the first byte of the TH.  The
2330 FID would be registered like this:
2331
2332         name            = "Format Identifier"
2333         abbrev          = "sna.th.fid"
2334         type            = FT_UINT8
2335         display         = BASE_HEX
2336         strings         = sna_th_fid_vals
2337         bitmask         = 0xf0
2338
2339 The bitmask contains the value which would leave only the FID if bitwise-ANDed
2340 against the parent field, the first byte of the TH.
2341
2342 The code to add the FID to the tree would be;
2343
2344         proto_tree_add_item(bf_tree, hf_sna_th_fid, tvb, offset, 1,
2345             ENC_BIG_ENDIAN);
2346
2347 The definition of the field already has the information about bitmasking
2348 and bitshifting, so it does the work of masking and shifting for us!
2349 This also means that you no longer have to create value_string structs
2350 with the values bitshifted.  The value_string for FID looks like this,
2351 even though the FID value is actually contained in the high nibble.
2352 (You'd expect the values to be 0x0, 0x10, 0x20, etc.)
2353
2354 /* Format Identifier */
2355 static const value_string sna_th_fid_vals[] = {
2356         { 0x0,  "SNA device <--> Non-SNA Device" },
2357         { 0x1,  "Subarea Node <--> Subarea Node" },
2358         { 0x2,  "Subarea Node <--> PU2" },
2359         { 0x3,  "Subarea Node or SNA host <--> Subarea Node" },
2360         { 0x4,  "?" },
2361         { 0x5,  "?" },
2362         { 0xf,  "Adjacent Subarea Nodes" },
2363         { 0,    NULL }
2364 };
2365
2366 The final implication of this is that display filters work the way you'd
2367 naturally expect them to. You'd type "sna.th.fid == 0xf" to find Adjacent
2368 Subarea Nodes. The user does not have to shift the value of the FID to
2369 the high nibble of the byte ("sna.th.fid == 0xf0") as was necessary
2370 in the past.
2371
2372 proto_tree_add_protocol_format()
2373 --------------------------------
2374 proto_tree_add_protocol_format is used to add the top-level item for the
2375 protocol when the dissector routine wants complete control over how the
2376 field and value will be represented on the GUI tree.  The ID value for
2377 the protocol is passed in as the "id" argument; the rest of the
2378 arguments are a "printf"-style format and any arguments for that format.
2379 The caller must include the name of the protocol in the format; it is
2380 not added automatically as in proto_tree_add_item().
2381
2382 proto_tree_add_none_format()
2383 ----------------------------
2384 proto_tree_add_none_format is used to add an item of type FT_NONE.
2385 The caller must include the name of the field in the format; it is
2386 not added automatically as in proto_tree_add_item().
2387
2388 proto_tree_add_bytes()
2389 proto_tree_add_time()
2390 proto_tree_add_ipxnet()
2391 proto_tree_add_ipv4()
2392 proto_tree_add_ipv6()
2393 proto_tree_add_ether()
2394 proto_tree_add_string()
2395 proto_tree_add_boolean()
2396 proto_tree_add_float()
2397 proto_tree_add_double()
2398 proto_tree_add_uint()
2399 proto_tree_add_uint64()
2400 proto_tree_add_int()
2401 proto_tree_add_int64()
2402 proto_tree_add_guid()
2403 proto_tree_add_oid()
2404 ------------------------
2405 These routines are used to add items to the protocol tree if either:
2406
2407         the value of the item to be added isn't just extracted from the
2408         packet data, but is computed from data in the packet;
2409
2410         the value was fetched into a variable.
2411
2412 The 'value' argument has the value to be added to the tree.
2413
2414 NOTE: in all cases where the 'value' argument is a pointer, a copy is
2415 made of the object pointed to; if you have dynamically allocated a
2416 buffer for the object, that buffer will not be freed when the protocol
2417 tree is freed - you must free the buffer yourself when you don't need it
2418 any more.
2419
2420 For proto_tree_add_bytes(), the 'value_ptr' argument is a pointer to a
2421 sequence of bytes.
2422
2423 For proto_tree_add_time(), the 'value_ptr' argument is a pointer to an
2424 "nstime_t", which is a structure containing the time to be added; it has
2425 'secs' and 'nsecs' members, giving the integral part and the fractional
2426 part of a time in units of seconds, with 'nsecs' being the number of
2427 nanoseconds.  For absolute times, "secs" is a UNIX-style seconds since
2428 January 1, 1970, 00:00:00 GMT value.
2429
2430 For proto_tree_add_ipxnet(), the 'value' argument is a 32-bit IPX
2431 network address.
2432
2433 For proto_tree_add_ipv4(), the 'value' argument is a 32-bit IPv4
2434 address, in network byte order.
2435
2436 For proto_tree_add_ipv6(), the 'value_ptr' argument is a pointer to a
2437 128-bit IPv6 address.
2438
2439 For proto_tree_add_ether(), the 'value_ptr' argument is a pointer to a
2440 48-bit MAC address.
2441
2442 For proto_tree_add_string(), the 'value_ptr' argument is a pointer to a
2443 text string.
2444
2445 For proto_tree_add_boolean(), the 'value' argument is a 32-bit integer.
2446 It is masked and shifted as defined by the field info after which zero
2447 means "false", and non-zero means "true".
2448
2449 For proto_tree_add_float(), the 'value' argument is a 'float' in the
2450 host's floating-point format.
2451
2452 For proto_tree_add_double(), the 'value' argument is a 'double' in the
2453 host's floating-point format.
2454
2455 For proto_tree_add_uint(), the 'value' argument is a 32-bit unsigned
2456 integer value, in host byte order.  (This routine cannot be used to add
2457 64-bit integers.)
2458
2459 For proto_tree_add_uint64(), the 'value' argument is a 64-bit unsigned
2460 integer value, in host byte order.
2461
2462 For proto_tree_add_int(), the 'value' argument is a 32-bit signed
2463 integer value, in host byte order.  (This routine cannot be used to add
2464 64-bit integers.)
2465
2466 For proto_tree_add_int64(), the 'value' argument is a 64-bit signed
2467 integer value, in host byte order.
2468
2469 For proto_tree_add_guid(), the 'value_ptr' argument is a pointer to an
2470 e_guid_t structure.
2471
2472 For proto_tree_add_oid(), the 'value_ptr' argument is a pointer to an
2473 ASN.1 Object Identifier.
2474
2475 proto_tree_add_bytes_format()
2476 proto_tree_add_time_format()
2477 proto_tree_add_ipxnet_format()
2478 proto_tree_add_ipv4_format()
2479 proto_tree_add_ipv6_format()
2480 proto_tree_add_ether_format()
2481 proto_tree_add_string_format()
2482 proto_tree_add_boolean_format()
2483 proto_tree_add_float_format()
2484 proto_tree_add_double_format()
2485 proto_tree_add_uint_format()
2486 proto_tree_add_uint64_format()
2487 proto_tree_add_int_format()
2488 proto_tree_add_int64_format()
2489 proto_tree_add_guid_format()
2490 proto_tree_add_oid_format()
2491 ----------------------------
2492 These routines are used to add items to the protocol tree when the
2493 dissector routine wants complete control over how the field and value
2494 will be represented on the GUI tree.  The argument giving the value is
2495 the same as the corresponding proto_tree_add_XXX() function; the rest of
2496 the arguments are a "printf"-style format and any arguments for that
2497 format.  The caller must include the name of the field in the format; it
2498 is not added automatically as in the proto_tree_add_XXX() functions.
2499
2500 proto_tree_add_bytes_format_value()
2501 proto_tree_add_time_format_value()
2502 proto_tree_add_ipxnet_format_value()
2503 proto_tree_add_ipv4_format_value()
2504 proto_tree_add_ipv6_format_value()
2505 proto_tree_add_ether_format_value()
2506 proto_tree_add_string_format_value()
2507 proto_tree_add_boolean_format_value()
2508 proto_tree_add_float_format_value()
2509 proto_tree_add_double_format_value()
2510 proto_tree_add_uint_format_value()
2511 proto_tree_add_uint64_format_value()
2512 proto_tree_add_int_format_value()
2513 proto_tree_add_int64_format_value()
2514 proto_tree_add_guid_format_value()
2515 proto_tree_add_oid_format_value()
2516 ------------------------------------
2517
2518 These routines are used to add items to the protocol tree when the
2519 dissector routine wants complete control over how the value will be
2520 represented on the GUI tree.  The argument giving the value is the same
2521 as the corresponding proto_tree_add_XXX() function; the rest of the
2522 arguments are a "printf"-style format and any arguments for that format.
2523 With these routines, unlike the proto_tree_add_XXX_format() routines,
2524 the name of the field is added automatically as in the
2525 proto_tree_add_XXX() functions; only the value is added with the format.
2526
2527 proto_tree_add_text()
2528 ---------------------
2529 proto_tree_add_text() is used to add a label to the GUI tree.  It will
2530 contain no value, so it is not searchable in the display filter process.
2531 This function was needed in the transition from the old-style proto_tree
2532 to this new-style proto_tree so that Wireshark would still decode all
2533 protocols w/o being able to filter on all protocols and fields.
2534 Otherwise we would have had to cripple Wireshark's functionality while we
2535 converted all the old-style proto_tree calls to the new-style proto_tree
2536 calls.  In other words, you should not use this in new code unless you've got
2537 a specific reason (see below).
2538
2539 This can also be used for items with subtrees, which may not have values
2540 themselves - the items in the subtree are the ones with values.
2541
2542 For a subtree, the label on the subtree might reflect some of the items
2543 in the subtree.  This means the label can't be set until at least some
2544 of the items in the subtree have been dissected.  To do this, use
2545 'proto_item_set_text()' or 'proto_item_append_text()':
2546
2547         void
2548         proto_item_set_text(proto_item *ti, ...);
2549
2550         void
2551         proto_item_append_text(proto_item *ti, ...);
2552
2553 'proto_item_set_text()' takes as an argument the value returned by
2554 'proto_tree_add_text()', a 'printf'-style format string, and a set of
2555 arguments corresponding to '%' format items in that string, and replaces
2556 the text for the item created by 'proto_tree_add_text()' with the result
2557 of applying the arguments to the format string.
2558
2559 'proto_item_append_text()' is similar, but it appends to the text for
2560 the item the result of applying the arguments to the format string.
2561
2562 For example, early in the dissection, one might do:
2563
2564         ti = proto_tree_add_text(tree, tvb, offset, length, <label>);
2565
2566 and later do
2567
2568         proto_item_set_text(ti, "%s: %s", type, value);
2569
2570 after the "type" and "value" fields have been extracted and dissected.
2571 <label> would be a label giving what information about the subtree is
2572 available without dissecting any of the data in the subtree.
2573
2574 Note that an exception might be thrown when trying to extract the values of
2575 the items used to set the label, if not all the bytes of the item are
2576 available.  Thus, one should create the item with text that is as
2577 meaningful as possible, and set it or append additional information to
2578 it as the values needed to supply that information are extracted.
2579
2580 proto_tree_add_text_valist()
2581 ----------------------------
2582 This is like proto_tree_add_text(), but takes, as the last argument, a
2583 'va_list'; it is used to allow routines that take a printf-like
2584 variable-length list of arguments to add a text item to the protocol
2585 tree.
2586
2587 proto_tree_add_bits_item()
2588 --------------------------
2589 Adds a number of bits to the protocol tree which does not have to be byte
2590 aligned. The offset and length is in bits.
2591 Output format:
2592
2593 ..10 1010 10.. .... "value" (formatted as FT_ indicates).
2594
2595 proto_tree_add_bits_ret_val()
2596 -----------------------------
2597 Works in the same way but also returns the value of the read bits.
2598
2599 proto_tree_add_bitmask() and proto_tree_add_bitmask_text()
2600 ----------------------------------------------------------
2601 This function provides an easy to use and convenient helper function
2602 to manage many types of common bitmasks that occur in protocols.
2603
2604 This function will dissect a 1/2/3/4 byte large bitmask into its individual
2605 fields.
2606 header is an integer type and must be of type FT_[U]INT{8|16|24|32} and
2607 represents the entire width of the bitmask.
2608
2609 'header' and 'ett' are the hf fields and ett field respectively to create an
2610 expansion that covers the 1-4 bytes of the bitmask.
2611
2612 'fields' is a NULL terminated array of pointers to hf fields representing
2613 the individual subfields of the bitmask. These fields must either be integers
2614 of the same byte width as 'header' or of the type FT_BOOLEAN.
2615 Each of the entries in 'fields' will be dissected as an item under the
2616 'header' expansion and also IF the field is a boolean and IF it is set to 1,
2617 then the name of that boolean field will be printed on the 'header' expansion
2618 line.  For integer type subfields that have a value_string defined, the
2619 matched string from that value_string will be printed on the expansion line
2620 as well.
2621
2622 Example: (from the SCSI dissector)
2623         static int hf_scsi_inq_peripheral        = -1;
2624         static int hf_scsi_inq_qualifier         = -1;
2625         static int hf_scsi_inq_devtype           = -1;
2626         ...
2627         static gint ett_scsi_inq_peripheral = -1;
2628         ...
2629         static const int *peripheal_fields[] = {
2630                 &hf_scsi_inq_qualifier,
2631                 &hf_scsi_inq_devtype,
2632                 NULL
2633         };
2634         ...
2635         /* Qualifier and DeviceType */
2636         proto_tree_add_bitmask(tree, tvb, offset, hf_scsi_inq_peripheral,
2637                 ett_scsi_inq_peripheral, peripheal_fields, FALSE);
2638         offset+=1;
2639         ...
2640         { &hf_scsi_inq_peripheral,
2641           {"Peripheral", "scsi.inquiry.preipheral", FT_UINT8, BASE_HEX,
2642            NULL, 0, NULL, HFILL}},
2643         { &hf_scsi_inq_qualifier,
2644           {"Qualifier", "scsi.inquiry.qualifier", FT_UINT8, BASE_HEX,
2645            VALS (scsi_qualifier_val), 0xE0, NULL, HFILL}},
2646         { &hf_scsi_inq_devtype,
2647           {"Device Type", "scsi.inquiry.devtype", FT_UINT8, BASE_HEX,
2648            VALS (scsi_devtype_val), SCSI_DEV_BITS, NULL, HFILL}},
2649         ...
2650
2651 Which provides very pretty dissection of this one byte bitmask.
2652
2653     Peripheral: 0x05, Qualifier: Device type is connected to logical unit, Device Type: CD-ROM
2654         000. .... = Qualifier: Device type is connected to logical unit (0x00)
2655         ...0 0101 = Device Type: CD-ROM (0x05)
2656
2657 The proto_tree_add_bitmask_text() function is an extended version of
2658 the proto_tree_add_bitmask() function. In addition, it allows to:
2659 - Provide a leading text (e.g. "Flags: ") that will appear before
2660   the comma-separated list of field values
2661 - Provide a fallback text (e.g. "None") that will be appended if
2662   no fields warranted a change to the top-level title.
2663 - Using flags, specify which fields will affect the top-level title.
2664
2665 There are the following flags defined:
2666
2667   BMT_NO_APPEND - the title is taken "as-is" from the 'name' argument.
2668   BMT_NO_INT - only boolean flags are added to the title.
2669   BMT_NO_FALSE - boolean flags are only added to the title if they are set.
2670   BMT_NO_TFS - only add flag name to the title, do not use true_false_string
2671
2672 The proto_tree_add_bitmask() behavior can be obtained by providing
2673 both 'name' and 'fallback' arguments as NULL, and a flags of
2674 (BMT_NO_FALSE|BMT_NO_TFS).
2675
2676 PROTO_ITEM_SET_GENERATED()
2677 --------------------------
2678 PROTO_ITEM_SET_GENERATED is used to mark fields as not being read from the
2679 captured data directly, but inferred from one or more values.
2680
2681 One of the primary uses of this is the presentation of verification of
2682 checksums. Every IP packet has a checksum line, which can present the result
2683 of the checksum verification, if enabled in the preferences. The result is
2684 presented as a subtree, where the result is enclosed in square brackets
2685 indicating a generated field.
2686
2687   Header checksum: 0x3d42 [correct]
2688     [Good: True]
2689     [Bad: False]
2690
2691 PROTO_ITEM_SET_HIDDEN()
2692 -----------------------
2693 PROTO_ITEM_SET_HIDDEN is used to hide fields, which have already been added
2694 to the tree, from being visible in the displayed tree.
2695
2696 NOTE that creating hidden fields is actually quite a bad idea from a UI design
2697 perspective because the user (someone who did not write nor has ever seen the
2698 code) has no way of knowing that hidden fields are there to be filtered on
2699 thus defeating the whole purpose of putting them there.  A Better Way might
2700 be to add the fields (that might otherwise be hidden) to a subtree where they
2701 won't be seen unless the user opens the subtree--but they can be found if the
2702 user wants.
2703
2704 One use for hidden fields (which would be better implemented using visible
2705 fields in a subtree) follows: The caller may want a value to be
2706 included in a tree so that the packet can be filtered on this field, but
2707 the representation of that field in the tree is not appropriate.  An
2708 example is the token-ring routing information field (RIF).  The best way
2709 to show the RIF in a GUI is by a sequence of ring and bridge numbers.
2710 Rings are 3-digit hex numbers, and bridges are single hex digits:
2711
2712         RIF: 001-A-013-9-C0F-B-555
2713
2714 In the case of RIF, the programmer should use a field with no value and
2715 use proto_tree_add_none_format() to build the above representation. The
2716 programmer can then add the ring and bridge values, one-by-one, with
2717 proto_tree_add_item() and hide them with PROTO_ITEM_SET_HIDDEN() so that the
2718 user can then filter on or search for a particular ring or bridge. Here's a
2719 skeleton of how the programmer might code this.
2720
2721         char *rif;
2722         rif = create_rif_string(...);
2723
2724         proto_tree_add_none_format(tree, hf_tr_rif_label, ..., "RIF: %s", rif);
2725
2726         for(i = 0; i < num_rings; i++) {
2727                 proto_item *pi;
2728
2729                 pi = proto_tree_add_item(tree, hf_tr_rif_ring, ...,
2730                     ENC_BIG_ENDIAN);
2731                 PROTO_ITEM_SET_HIDDEN(pi);
2732         }
2733         for(i = 0; i < num_rings - 1; i++) {
2734                 proto_item *pi;
2735
2736                 pi = proto_tree_add_item(tree, hf_tr_rif_bridge, ...,
2737                     ENC_BIG_ENDIAN);
2738                 PROTO_ITEM_SET_HIDDEN(pi);
2739         }
2740
2741 The logical tree has these items:
2742
2743         hf_tr_rif_label, text="RIF: 001-A-013-9-C0F-B-555", value = NONE
2744         hf_tr_rif_ring,  hidden, value=0x001
2745         hf_tr_rif_bridge, hidden, value=0xA
2746         hf_tr_rif_ring,  hidden, value=0x013
2747         hf_tr_rif_bridge, hidden, value=0x9
2748         hf_tr_rif_ring,  hidden, value=0xC0F
2749         hf_tr_rif_bridge, hidden, value=0xB
2750         hf_tr_rif_ring,  hidden, value=0x555
2751
2752 GUI or print code will not display the hidden fields, but a display
2753 filter or "packet grep" routine will still see the values. The possible
2754 filter is then possible:
2755
2756         tr.rif_ring eq 0x013
2757
2758 PROTO_ITEM_SET_URL
2759 ------------------
2760 PROTO_ITEM_SET_URL is used to mark fields as containing a URL. This can only
2761 be done with fields of type FT_STRING(Z). If these fields are presented they
2762 are underlined, as could be done in a browser. These fields are sensitive to
2763 clicks as well, launching the configured browser with this URL as parameter.
2764
2765 1.7 Utility routines.
2766
2767 1.7.1 match_strval, match_strval_ext, val_to_str and val_to_str_ext.
2768
2769 A dissector may need to convert a value to a string, using a
2770 'value_string' structure, by hand, rather than by declaring a field with
2771 an associated 'value_string' structure; this might be used, for example,
2772 to generate a COL_INFO line for a frame.
2773
2774 'match_strval()' will do that:
2775
2776         gchar*
2777         match_strval(guint32 val, const value_string *vs)
2778
2779 It will look up the value 'val' in the 'value_string' table pointed to
2780 by 'vs', and return either the corresponding string, or NULL if the
2781 value could not be found in the table.  Note that, unless 'val' is
2782 guaranteed to be a value in the 'value_string' table ("guaranteed" as in
2783 "the code has already checked that it's one of those values" or "the
2784 table handles all possible values of the size of 'val'", not "the
2785 protocol spec says it has to be" - protocol specs do not prevent invalid
2786 packets from being put onto a network or into a purported packet capture
2787 file), you must check whether 'match_strval()' returns NULL, and arrange
2788 that its return value not be dereferenced if it's NULL. 'val_to_str()'
2789 can be used to generate a string for values not found in the table:
2790
2791         gchar*
2792         val_to_str(guint32 val, const value_string *vs, const char *fmt)
2793
2794 If the value 'val' is found in the 'value_string' table pointed to by
2795 'vs', 'val_to_str' will return the corresponding string; otherwise, it
2796 will use 'fmt' as an 'sprintf'-style format, with 'val' as an argument,
2797 to generate a string, and will return a pointer to that string.
2798 You can use it in a call to generate a COL_INFO line for a frame such as
2799
2800         col_add_fstr(COL_INFO, ", %s", val_to_str(val, table, "Unknown %d"));
2801
2802 The match_strval_ext and val_to_str_ext functions are "extended" versions
2803 of match_strval and val_to_str. They should be used for large value-string
2804 arrays which contain many entries. They implement value to string conversions
2805 which will do either a direct access or a binary search of the
2806 value string array if possible. See "Extended Value Strings" under
2807 section  1.6 "Constructing the protocol tree" for more information.
2808
2809 See epan/value_string.h for detailed information on the various value_string
2810 functions.
2811
2812
2813 1.7.2 match_strrval and rval_to_str.
2814
2815 A dissector may need to convert a range of values to a string, using a
2816 'range_string' structure.
2817
2818 'match_strrval()' will do that:
2819
2820         gchar*
2821         match_strrval(guint32 val, const range_string *rs)
2822
2823 It will look up the value 'val' in the 'range_string' table pointed to
2824 by 'rs', and return either the corresponding string, or NULL if the
2825 value could not be found in the table. Please note that its base
2826 behavior is inherited from match_strval().
2827
2828 'rval_to_str()' can be used to generate a string for values not found in
2829 the table:
2830
2831         gchar*
2832         rval_to_str(guint32 val, const range_string *rs, const char *fmt)
2833
2834 If the value 'val' is found in the 'range_string' table pointed to by
2835 'rs', 'rval_to_str' will return the corresponding string; otherwise, it
2836 will use 'fmt' as an 'sprintf'-style format, with 'val' as an argument,
2837 to generate a string, and will return a pointer to that string. Please
2838 note that its base behavior is inherited from match_strval().
2839
2840 1.8 Calling Other Dissectors.
2841
2842 As each dissector completes its portion of the protocol analysis, it
2843 is expected to create a new tvbuff of type TVBUFF_SUBSET which
2844 contains the payload portion of the protocol (that is, the bytes
2845 that are relevant to the next dissector).
2846
2847 The syntax for creating a new TVBUFF_SUBSET is:
2848
2849 next_tvb = tvb_new_subset(tvb, offset, length, reported_length)
2850
2851 Where:
2852         tvb is the tvbuff that the dissector has been working on. It
2853         can be a tvbuff of any type.
2854
2855         next_tvb is the new TVBUFF_SUBSET.
2856
2857         offset is the byte offset of 'tvb' at which the new tvbuff
2858         should start.  The first byte is the 0th byte.
2859
2860         length is the number of bytes in the new TVBUFF_SUBSET. A length
2861         argument of -1 says to use as many bytes as are available in
2862         'tvb'.
2863
2864         reported_length is the number of bytes that the current protocol
2865         says should be in the payload. A reported_length of -1 says that
2866         the protocol doesn't say anything about the size of its payload.
2867
2868
2869 An example from packet-ipx.c -
2870
2871 void
2872 dissect_ipx(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
2873 {
2874         tvbuff_t        *next_tvb;
2875         int             reported_length, available_length;
2876
2877
2878         /* Make the next tvbuff */
2879
2880 /* IPX does have a length value in the header, so calculate report_length */
2881    Set this to -1 if there isn't any length information in the protocol
2882 */
2883         reported_length = ipx_length - IPX_HEADER_LEN;
2884
2885 /* Calculate the available data in the packet,
2886    set this to -1 to use all the data in the tv_buffer
2887 */
2888         available_length = tvb_length(tvb) - IPX_HEADER_LEN;
2889
2890 /* Create the tvbuffer for the next dissector */
2891         next_tvb = tvb_new_subset(tvb, IPX_HEADER_LEN,
2892                         MIN(available_length, reported_length),
2893                         reported_length);
2894
2895 /* call the next dissector */
2896         dissector_next( next_tvb, pinfo, tree);
2897
2898
2899 1.9 Editing Makefile.common and CMakeLists.txt to add your dissector.
2900
2901 To arrange that your dissector will be built as part of Wireshark, you
2902 must add the name of the source file for your dissector to the
2903 'DISSECTOR_SRC' macro in the 'Makefile.common' file in the 'epan/dissectors'
2904 directory.  (Note that this is for modern versions of UNIX, so there
2905 is no 14-character limitation on file names, and for modern versions of
2906 Windows, so there is no 8.3-character limitation on file names.)
2907
2908 If your dissector also has its own header file or files, you must add
2909 them to the 'DISSECTOR_INCLUDES' macro in the 'Makefile.common' file in
2910 the 'epan/dissectors' directory, so that it's included when release source
2911 tarballs are built (otherwise, the source in the release tarballs won't
2912 compile).
2913
2914 In addition to the above, you should add your dissector source file name
2915 to the DISSECTOR_SRC section of epan/CMakeLists.txt
2916
2917
2918 1.10 Using the SVN source code tree.
2919
2920   See <http://www.wireshark.org/develop.html>
2921
2922 1.11 Submitting code for your new dissector.
2923
2924   - VERIFY that your dissector code does not use prohibited or deprecated APIs
2925     as follows:
2926     perl <wireshark_root>/tools/checkAPIs.pl <source-filename(s)>
2927
2928   - TEST YOUR DISSECTOR BEFORE SUBMITTING IT.
2929     Use fuzz-test.sh and/or randpkt against your dissector.  These are
2930     described at <http://wiki.wireshark.org/FuzzTesting>.
2931
2932   - Subscribe to <mailto:wireshark-dev[AT]wireshark.org> by sending an email to
2933     <mailto:wireshark-dev-request[AT]wireshark.org?body="help"> or visiting
2934     <http://www.wireshark.org/lists/>.
2935
2936   - 'svn add' all the files of your new dissector.
2937
2938   - 'svn diff' the workspace and save the result to a file.
2939
2940   - Edit the diff file - remove any changes unrelated to your new dissector,
2941     e.g. changes in config.nmake
2942
2943   - Submit a bug report to the Wireshark bug database, found at
2944     <http://bugs.wireshark.org>, qualified as an enhancement and attach your
2945     diff file there. Set the review request flag to '?' so it will pop up in
2946     the patch review list.
2947
2948   - Create a Wiki page on the protocol at <http://wiki.wireshark.org>.
2949     A template is provided so it is easy to setup in a consistent style.
2950       See: <http://wiki.wireshark.org/HowToEdit>
2951       and  <http://wiki.wireshark.org/ProtocolReference>
2952
2953   - If possible, add sample capture files to the sample captures page at
2954     <http://wiki.wireshark.org/SampleCaptures>.  These files are used by
2955     the automated build system for fuzz testing.
2956
2957   - If you find that you are contributing a lot to wireshark on an ongoing
2958     basis you can request to become a committer which will allow you to
2959     commit files to subversion directly.
2960
2961 2. Advanced dissector topics.
2962
2963 2.1 Introduction.
2964
2965 Some of the advanced features are being worked on constantly. When using them
2966 it is wise to check the relevant header and source files for additional details.
2967
2968 2.2 Following "conversations".
2969
2970 In wireshark a conversation is defined as a series of data packets between two
2971 address:port combinations.  A conversation is not sensitive to the direction of
2972 the packet.  The same conversation will be returned for a packet bound from
2973 ServerA:1000 to ClientA:2000 and the packet from ClientA:2000 to ServerA:1000.
2974
2975 2.2.1 Conversation Routines
2976
2977 There are six routines that you will use to work with a conversation:
2978 conversation_new, find_conversation, conversation_add_proto_data,
2979 conversation_get_proto_data, conversation_delete_proto_data,
2980 and conversation_set_dissector.
2981
2982
2983 2.2.1.1 The conversation_init function.
2984
2985 This is an internal routine for the conversation code.  As such you
2986 will not have to call this routine.  Just be aware that this routine is
2987 called at the start of each capture and before the packets are filtered
2988 with a display filter.  The routine will destroy all stored
2989 conversations.  This routine does NOT clean up any data pointers that are
2990 passed in the conversation_add_proto_data 'data' variable.  You are
2991 responsible for this clean up if you pass a malloc'ed pointer
2992 in this variable.
2993
2994 See item 2.2.1.5 for more information about use of the 'data' pointer.
2995
2996
2997 2.2.1.2 The conversation_new function.
2998
2999 This routine will create a new conversation based upon two address/port
3000 pairs.  If you want to associate with the conversation a pointer to a
3001 private data structure you must use the conversation_add_proto_data
3002 function.  The ptype variable is used to differentiate between
3003 conversations over different protocols, i.e. TCP and UDP.  The options
3004 variable is used to define a conversation that will accept any destination
3005 address and/or port.  Set options = 0 if the destination port and address
3006 are know when conversation_new is called.  See section 2.4 for more
3007 information on usage of the options parameter.
3008
3009 The conversation_new prototype:
3010         conversation_t *conversation_new(guint32 setup_frame, address *addr1,
3011             address *addr2, port_type ptype, guint32 port1, guint32 port2,
3012             guint options);
3013
3014 Where:
3015         guint32 setup_frame = The lowest numbered frame for this conversation
3016         address* addr1      = first data packet address
3017         address* addr2      = second data packet address
3018         port_type ptype     = port type, this is defined in packet.h
3019         guint32 port1       = first data packet port
3020         guint32 port2       = second data packet port
3021         guint options       = conversation options, NO_ADDR2 and/or NO_PORT2
3022
3023 setup_frame indicates the first frame for this conversation, and is used to
3024 distinguish multiple conversations with the same addr1/port1 and addr2/port2
3025 pair that occur within the same capture session.
3026
3027 "addr1" and "port1" are the first address/port pair; "addr2" and "port2"
3028 are the second address/port pair.  A conversation doesn't have source
3029 and destination address/port pairs - packets in a conversation go in
3030 both directions - so "addr1"/"port1" may be the source or destination
3031 address/port pair; "addr2"/"port2" would be the other pair.
3032
3033 If NO_ADDR2 is specified, the conversation is set up so that a
3034 conversation lookup will match only the "addr1" address; if NO_PORT2 is
3035 specified, the conversation is set up so that a conversation lookup will
3036 match only the "port1" port; if both are specified, i.e.
3037 NO_ADDR2|NO_PORT2, the conversation is set up so that the lookup will
3038 match only the "addr1"/"port1" address/port pair.  This can be used if a
3039 packet indicates that, later in the capture, a conversation will be
3040 created using certain addresses and ports, in the case where the packet
3041 doesn't specify the addresses and ports of both sides.
3042
3043 2.2.1.3 The find_conversation function.
3044
3045 Call this routine to look up a conversation.  If no conversation is found,
3046 the routine will return a NULL value.
3047
3048 The find_conversation prototype:
3049
3050         conversation_t *find_conversation(guint32 frame_num, address *addr_a,
3051             address *addr_b, port_type ptype, guint32 port_a, guint32 port_b,
3052             guint options);
3053
3054 Where:
3055         guint32 frame_num = a frame number to match
3056         address* addr_a = first address
3057         address* addr_b = second address
3058         port_type ptype = port type
3059         guint32 port_a  = first data packet port
3060         guint32 port_b  = second data packet port
3061         guint options   = conversation options, NO_ADDR_B and/or NO_PORT_B
3062
3063 frame_num is a frame number to match. The conversation returned is where
3064         (frame_num >= conversation->setup_frame
3065         && frame_num < conversation->next->setup_frame)
3066 Suppose there are a total of 3 conversations (A, B, and C) that match
3067 addr_a/port_a and addr_b/port_b, where the setup_frame used in
3068 conversation_new() for A, B and C are 10, 50, and 100 respectively. The
3069 frame_num passed in find_conversation is compared to the setup_frame of each
3070 conversation. So if (frame_num >= 10 && frame_num < 50), conversation A is
3071 returned. If (frame_num >= 50 && frame_num < 100), conversation B is returned.
3072 If (frame_num >= 100) conversation C is returned.
3073
3074 "addr_a" and "port_a" are the first address/port pair; "addr_b" and
3075 "port_b" are the second address/port pair.  Again, as a conversation
3076 doesn't have source and destination address/port pairs, so
3077 "addr_a"/"port_a" may be the source or destination address/port pair;
3078 "addr_b"/"port_b" would be the other pair.  The search will match the
3079 "a" address/port pair against both the "1" and "2" address/port pairs,
3080 and match the "b" address/port pair against both the "2" and "1"
3081 address/port pairs; you don't have to worry about which side the "a" or
3082 "b" pairs correspond to.
3083
3084 If the NO_ADDR_B flag was specified to "find_conversation()", the
3085 "addr_b" address will be treated as matching any "wildcarded" address;
3086 if the NO_PORT_B flag was specified, the "port_b" port will be treated
3087 as matching any "wildcarded" port.  If both flags are specified, i.e.
3088 NO_ADDR_B|NO_PORT_B, the "addr_b" address will be treated as matching
3089 any "wildcarded" address and the "port_b" port will be treated as
3090 matching any "wildcarded" port.
3091
3092
3093 2.2.1.4 The find_or_create_conversation function.
3094
3095 This convenience function will create find an existing conversation (by calling
3096 find_conversation()) and, if a conversation does not already exist, create a
3097 new conversation by calling conversation_new().
3098
3099 The find_or_create_conversation prototype:
3100
3101         extern conversation_t *find_or_create_conversation(packet_info *pinfo);
3102
3103 Where:
3104         packet_info *pinfo = the packet_info structure
3105
3106 The frame number and the addresses necessary for find_conversation() and
3107 conversation_new() are taken from the pinfo structure (as is commonly done)
3108 and no 'options' are used.
3109
3110
3111 2.2.1.5 The conversation_add_proto_data function.
3112
3113 Once you have created a conversation with conversation_new, you can
3114 associate data with it using this function.
3115
3116 The conversation_add_proto_data prototype:
3117
3118         void conversation_add_proto_data(conversation_t *conv, int proto,
3119                 void *proto_data);
3120
3121 Where:
3122         conversation_t *conv = the conversation in question
3123         int proto            = registered protocol number
3124         void *data           = dissector data structure
3125
3126 "conversation" is the value returned by conversation_new.  "proto" is a
3127 unique protocol number created with proto_register_protocol.  Protocols
3128 are typically registered in the proto_register_XXXX section of your
3129 dissector.  "data" is a pointer to the data you wish to associate with the
3130 conversation.  "data" usually points to "se_alloc'd" memory; the
3131 memory will be automatically freed each time a new dissection begins
3132 and thus need not be managed (freed) by the dissector.
3133 Using the protocol number allows several dissectors to
3134 associate data with a given conversation.
3135
3136
3137 2.2.1.6 The conversation_get_proto_data function.
3138
3139 After you have located a conversation with find_conversation, you can use
3140 this function to retrieve any data associated with it.
3141
3142 The conversation_get_proto_data prototype:
3143
3144         void *conversation_get_proto_data(conversation_t *conv, int proto);
3145
3146 Where:
3147         conversation_t *conv = the conversation in question
3148         int proto            = registered protocol number
3149
3150 "conversation" is the conversation created with conversation_new.  "proto"
3151 is a unique protocol number created with proto_register_protocol,
3152 typically in the proto_register_XXXX portion of a dissector.  The function
3153 returns a pointer to the data requested, or NULL if no data was found.
3154
3155
3156 2.2.1.7 The conversation_delete_proto_data function.
3157
3158 After you are finished with a conversation, you can remove your association
3159 with this function.  Please note that ONLY the conversation entry is
3160 removed.  If you have allocated any memory for your data (other than with se_alloc),
3161  you must free it as well.
3162
3163 The conversation_delete_proto_data prototype:
3164
3165         void conversation_delete_proto_data(conversation_t *conv, int proto);
3166
3167 Where:
3168         conversation_t *conv = the conversation in question
3169         int proto            = registered protocol number
3170
3171 "conversation" is the conversation created with conversation_new.  "proto"
3172 is a unique protocol number created with proto_register_protocol,
3173 typically in the proto_register_XXXX portion of a dissector.
3174
3175 2.2.1.8 The conversation_set_dissector function
3176
3177 This function sets the protocol dissector to be invoked whenever
3178 conversation parameters (addresses, port_types, ports, etc) are matched
3179 during the dissection of a packet.
3180
3181 The conversation_set_dissector prototype:
3182
3183         void conversation_set_dissector(conversation_t *conversation, const dissector_handle_t handle);
3184
3185 Where:
3186         conversation_t *conv = the conversation in question
3187         const dissector_handle_t handle = the dissector handle.
3188
3189
3190 2.2.2 Using timestamps relative to the conversation
3191
3192 There is a framework to calculate timestamps relative to the start of the
3193 conversation. First of all the timestamp of the first packet that has been
3194 seen in the conversation must be kept in the protocol data to be able
3195 to calculate the timestamp of the current packet relative to the start
3196 of the conversation. The timestamp of the last packet that was seen in the
3197 conversation should also be kept in the protocol data. This way the
3198 delta time between the current packet and the previous packet in the
3199 conversation can be calculated.
3200
3201 So add the following items to the struct that is used for the protocol data:
3202
3203   nstime_t      ts_first;
3204   nstime_t      ts_prev;
3205
3206 The ts_prev value should only be set during the first run through the
3207 packets (ie pinfo->fd->flags.visited is false).
3208
3209 Next step is to use the per-packet information (described in section 2.5)
3210 to keep the calculated delta timestamp, as it can only be calculated
3211 on the first run through the packets. This is because a packet can be
3212 selected in random order once the whole file has been read.
3213
3214 After calculating the conversation timestamps, it is time to put them in
3215 the appropriate columns with the function 'col_set_time' (described in
3216 section 1.5.9). There are two columns for conversation timestamps:
3217
3218 COL_REL_CONV_TIME,  /* Relative time to beginning of conversation */
3219 COL_DELTA_CONV_TIME,/* Delta time to last frame in conversation */
3220
3221 Last but not least, there MUST be a preference in each dissector that
3222 uses conversation timestamps that makes it possible to enable and
3223 disable the calculation of conversation timestamps. The main argument
3224 for this is that a higher level conversation is able to overwrite
3225 the values of lowel level conversations in these two columns. Being
3226 able to actively select which protocols may overwrite the conversation
3227 timestamp columns gives the user the power to control these columns.
3228 (A second reason is that conversation timestamps use the per-packet
3229 data structure which uses additional memory, which should be avoided
3230 if these timestamps are not needed)
3231
3232 Have a look at the differences to packet-tcp.[ch] in SVN 22966 and
3233 SVN 23058 to see the implementation of conversation timestamps for
3234 the tcp-dissector.
3235
3236
3237 2.2.3 The example conversation code using se_alloc'd memory.
3238
3239 For a conversation between two IP addresses and ports you can use this as an
3240 example.  This example uses se_alloc() to allocate memory and stores the data
3241 pointer in the conversation 'data' variable.
3242
3243 /************************ Global values ************************/
3244
3245 /* define your structure here */
3246 typedef struct {
3247
3248 } my_entry_t;
3249
3250 /* Registered protocol number */
3251 static int my_proto = -1;
3252
3253 /********************* in the dissector routine *********************/
3254
3255 /* the local variables in the dissector */
3256
3257 conversation_t *conversation;
3258 my_entry_t *data_ptr;
3259
3260
3261 /* look up the conversation */
3262
3263 conversation = find_conversation(pinfo->fd->num, &pinfo->src, &pinfo->dst,
3264         pinfo->ptype, pinfo->srcport, pinfo->destport, 0);
3265
3266 /* if conversation found get the data pointer that you stored */
3267 if (conversation)
3268     data_ptr = (my_entry_t*)conversation_get_proto_data(conversation, my_proto);
3269 else {
3270
3271     /* new conversation create local data structure */
3272
3273     data_ptr = se_alloc(sizeof(my_entry_t));
3274
3275     /*** add your code here to setup the new data structure ***/
3276
3277     /* create the conversation with your data pointer  */
3278
3279     conversation = conversation_new(pinfo->fd->num,  &pinfo->src, &pinfo->dst, pinfo->ptype,
3280             pinfo->srcport, pinfo->destport, 0);
3281     conversation_add_proto_data(conversation, my_proto, (void *)data_ptr);
3282 }
3283
3284 /* at this point the conversation data is ready */
3285
3286 /***************** in the protocol register routine *****************/
3287
3288 my_proto = proto_register_protocol("My Protocol", "My Protocol", "my_proto");
3289
3290
3291 2.2.4 An example conversation code that starts at a specific frame number.
3292
3293 Sometimes a dissector has determined that a new conversation is needed that
3294 starts at a specific frame number, when a capture session encompasses multiple
3295 conversation that reuse the same src/dest ip/port pairs. You can use the
3296 conversation->setup_frame returned by find_conversation with
3297 pinfo->fd->num to determine whether or not there already exists a conversation
3298 that starts at the specific frame number.
3299
3300 /* in the dissector routine */
3301
3302         conversation = find_conversation(pinfo->fd->num, &pinfo->src, &pinfo->dst,
3303             pinfo->ptype, pinfo->srcport, pinfo->destport, 0);
3304         if (conversation == NULL || (conversation->setup_frame != pinfo->fd->num)) {
3305                 /* It's not part of any conversation or the returned
3306                  * conversation->setup_frame doesn't match the current frame
3307                  * create a new one.
3308                  */
3309                 conversation = conversation_new(pinfo->fd->num, &pinfo->src,
3310                     &pinfo->dst, pinfo->ptype, pinfo->srcport, pinfo->destport,
3311                     NULL, 0);
3312         }
3313
3314
3315 2.2.5 The example conversation code using conversation index field.
3316
3317 Sometimes the conversation isn't enough to define a unique data storage
3318 value for the network traffic.  For example if you are storing information
3319 about requests carried in a conversation, the request may have an
3320 identifier that is used to  define the request. In this case the
3321 conversation and the identifier are required to find the data storage
3322 pointer.  You can use the conversation data structure index value to
3323 uniquely define the conversation.
3324
3325 See packet-afs.c for an example of how to use the conversation index.  In
3326 this dissector multiple requests are sent in the same conversation.  To store
3327 information for each request the dissector has an internal hash table based
3328 upon the conversation index and values inside the request packets.
3329
3330
3331         /* in the dissector routine */
3332
3333         /* to find a request value, first lookup conversation to get index */
3334         /* then used the conversation index, and request data to find data */
3335         /* in the local hash table */
3336
3337         conversation = find_or_create_conversation(pinfo);
3338
3339         request_key.conversation = conversation->index;
3340         request_key.service = pntohs(&rxh->serviceId);
3341         request_key.callnumber = pntohl(&rxh->callNumber);
3342
3343         request_val = (struct afs_request_val *)g_hash_table_lookup(
3344                 afs_request_hash, &request_key);
3345
3346         /* only allocate a new hash element when it's a request */
3347         opcode = 0;
3348         if (!request_val && !reply)
3349         {
3350                 new_request_key = se_alloc(sizeof(struct afs_request_key));
3351                 *new_request_key = request_key;
3352
3353                 request_val = se_alloc(sizeof(struct afs_request_val));
3354                 request_val -> opcode = pntohl(&afsh->opcode);
3355                 opcode = request_val->opcode;
3356
3357                 g_hash_table_insert(afs_request_hash, new_request_key,
3358                         request_val);
3359         }
3360
3361
3362
3363 2.3 Dynamic conversation dissector registration.
3364
3365
3366 NOTE:   This sections assumes that all information is available to
3367         create a complete conversation, source port/address and
3368         destination port/address.  If either the destination port or
3369         address is know, see section 2.4 Dynamic server port dissector
3370         registration.
3371
3372 For protocols that negotiate a secondary port connection, for example
3373 packet-msproxy.c, a conversation can install a dissector to handle
3374 the secondary protocol dissection.  After the conversation is created
3375 for the negotiated ports use the conversation_set_dissector to define
3376 the dissection routine.
3377 Before we create these conversations or assign a dissector to them we should
3378 first check that the conversation does not already exist and if it exists
3379 whether it is registered to our protocol or not.
3380 We should do this because it is uncommon but it does happen that multiple
3381 different protocols can use the same socketpair during different stages of
3382 an application cycle. By keeping track of the frame number a conversation
3383 was started in wireshark can still tell these different protocols apart.
3384
3385 The second argument to conversation_set_dissector is a dissector handle,
3386 which is created with a call to create_dissector_handle or
3387 register_dissector.
3388
3389 create_dissector_handle takes as arguments a pointer to the dissector
3390 function and a protocol ID as returned by proto_register_protocol;
3391 register_dissector takes as arguments a string giving a name for the
3392 dissector, a pointer to the dissector function, and a protocol ID.
3393
3394 The protocol ID is the ID for the protocol dissected by the function.
3395 The function will not be called if the protocol has been disabled by the
3396 user; instead, the data for the protocol will be dissected as raw data.
3397
3398 An example -
3399
3400 /* the handle for the dynamic dissector *
3401 static dissector_handle_t sub_dissector_handle;
3402
3403 /* prototype for the dynamic dissector */
3404 static void sub_dissector(tvbuff_t *tvb, packet_info *pinfo,
3405                 proto_tree *tree);
3406
3407 /* in the main protocol dissector, where the next dissector is setup */
3408
3409 /* if conversation has a data field, create it and load structure */
3410
3411 /* First check if a conversation already exists for this
3412         socketpair
3413 */
3414         conversation = find_conversation(pinfo->fd->num,
3415                                 &pinfo->src, &pinfo->dst, protocol,
3416                                 src_port, dst_port,  0);
3417
3418 /* If there is no such conversation, or if there is one but for
3419    someone else's protocol then we just create a new conversation
3420    and assign our protocol to it.
3421 */
3422         if ( (conversation == NULL) ||
3423              (conversation->dissector_handle != sub_dissector_handle) ) {
3424             new_conv_info = se_alloc(sizeof(struct _new_conv_info));
3425             new_conv_info->data1 = value1;
3426
3427 /* create the conversation for the dynamic port */
3428             conversation = conversation_new(pinfo->fd->num,
3429                 &pinfo->src, &pinfo->dst, protocol,
3430                 src_port, dst_port, new_conv_info, 0);
3431
3432 /* set the dissector for the new conversation */
3433             conversation_set_dissector(conversation, sub_dissector_handle);
3434         }
3435                 ...
3436
3437 void
3438 proto_register_PROTOABBREV(void)
3439 {
3440         ...
3441
3442         sub_dissector_handle = create_dissector_handle(sub_dissector,
3443             proto);
3444
3445         ...
3446 }
3447
3448 2.4 Dynamic server port dissector registration.
3449
3450 NOTE: While this example used both NO_ADDR2 and NO_PORT2 to create a
3451 conversation with only one port and address set, this isn't a
3452 requirement.  Either the second port or the second address can be set
3453 when the conversation is created.
3454
3455 For protocols that define a server address and port for a secondary
3456 protocol, a conversation can be used to link a protocol dissector to
3457 the server port and address.  The key is to create the new
3458 conversation with the second address and port set to the "accept
3459 any" values.
3460
3461 Some server applications can use the same port for different protocols during
3462 different stages of a transaction. For example it might initially use SNMP
3463 to perform some discovery and later switch to use TFTP using the same port.
3464 In order to handle this properly we must first check whether such a
3465 conversation already exists or not and if it exists we also check whether the
3466 registered dissector_handle for that conversation is "our" dissector or not.
3467 If not we create a new conversation on top of the previous one and set this new
3468 conversation to use our protocol.
3469 Since wireshark keeps track of the frame number where a conversation started
3470 wireshark will still be able to keep the packets apart even though they do use
3471 the same socketpair.
3472                 (See packet-tftp.c and packet-snmp.c for examples of this)
3473
3474 There are two support routines that will allow the second port and/or
3475 address to be set later.
3476
3477 conversation_set_port2( conversation_t *conv, guint32 port);
3478 conversation_set_addr2( conversation_t *conv, address addr);
3479
3480 These routines will change the second address or port for the
3481 conversation.  So, the server port conversation will be converted into a
3482 more complete conversation definition.  Don't use these routines if you
3483 want to create a conversation between the server and client and retain the
3484 server port definition, you must create a new conversation.
3485
3486
3487 An example -
3488
3489 /* the handle for the dynamic dissector *
3490 static dissector_handle_t sub_dissector_handle;
3491
3492         ...
3493
3494 /* in the main protocol dissector, where the next dissector is setup */
3495
3496 /* if conversation has a data field, create it and load structure */
3497
3498         new_conv_info = se_alloc(sizeof(struct _new_conv_info));
3499         new_conv_info->data1 = value1;
3500
3501 /* create the conversation for the dynamic server address and port      */
3502 /* NOTE: The second address and port values don't matter because the    */
3503 /* NO_ADDR2 and NO_PORT2 options are set.                               */
3504
3505 /* First check if a conversation already exists for this
3506         IP/protocol/port
3507 */
3508         conversation = find_conversation(pinfo->fd->num,
3509                                 &server_src_addr, 0, protocol,
3510                                 server_src_port, 0, NO_ADDR2 | NO_PORT_B);
3511 /* If there is no such conversation, or if there is one but for
3512    someone else's protocol then we just create a new conversation
3513    and assign our protocol to it.
3514 */
3515         if ( (conversation == NULL) ||
3516              (conversation->dissector_handle != sub_dissector_handle) ) {
3517             conversation = conversation_new(pinfo->fd->num,
3518             &server_src_addr, 0, protocol,
3519             server_src_port, 0, new_conv_info, NO_ADDR2 | NO_PORT2);
3520
3521 /* set the dissector for the new conversation */
3522             conversation_set_dissector(conversation, sub_dissector_handle);
3523         }
3524
3525 2.5 Per-packet information.
3526
3527 Information can be stored for each data packet that is processed by the
3528 dissector.  The information is added with the p_add_proto_data function and
3529 retrieved with the p_get_proto_data function.  The data pointers passed into
3530 the p_add_proto_data are not managed by the proto_data routines. If you use
3531 malloc or any other dynamic memory allocation scheme, you must release the
3532 data when it isn't required.
3533
3534 void
3535 p_add_proto_data(frame_data *fd, int proto, void *proto_data)
3536 void *
3537 p_get_proto_data(frame_data *fd, int proto)
3538
3539 Where:
3540         fd         - The fd pointer in the pinfo structure, pinfo->fd
3541         proto      - Protocol id returned by the proto_register_protocol call
3542                      during initialization
3543         proto_data - pointer to the dissector data.
3544
3545
3546 2.6 User Preferences.
3547
3548 If the dissector has user options, there is support for adding these preferences
3549 to a configuration dialog.
3550
3551 You must register the module with the preferences routine with -
3552
3553        module_t *prefs_register_protocol(proto_id, void (*apply_cb)(void))
3554        or
3555        module_t *prefs_register_protocol_subtree(const char *subtree, int id,
3556               void (*apply_cb)(void));
3557
3558
3559 Where: proto_id   - the value returned by "proto_register_protocol()" when
3560                     the protocol was registered.
3561        apply_cb   - Callback routine that is called when preferences are
3562                     applied. It may be NULL, which inhibits the callback.
3563        subtree    - grouping preferences tree node name (several protocols can
3564                     be grouped under one preferences subtree)
3565
3566 Then you can register the fields that can be configured by the user with these
3567 routines -
3568
3569         /* Register a preference with an unsigned integral value. */
3570         void prefs_register_uint_preference(module_t *module, const char *name,
3571             const char *title, const char *description, guint base, guint *var);
3572
3573         /* Register a preference with an Boolean value. */
3574         void prefs_register_bool_preference(module_t *module, const char *name,
3575             const char *title, const char *description, gboolean *var);
3576
3577         /* Register a preference with an enumerated value. */
3578         void prefs_register_enum_preference(module_t *module, const char *name,
3579             const char *title, const char *description, gint *var,
3580             const enum_val_t *enumvals, gboolean radio_buttons)
3581
3582         /* Register a preference with a character-string value. */
3583         void prefs_register_string_preference(module_t *module, const char *name,
3584             const char *title, const char *description, char **var)
3585
3586         /* Register a preference with a range of unsigned integers (e.g.,
3587          * "1-20,30-40").
3588          */
3589         void prefs_register_range_preference(module_t *module, const char *name,
3590             const char *title, const char *description, range_t *var,
3591             guint32 max_value)
3592
3593 Where: module - Returned by the prefs_register_protocol routine
3594          name     - This is appended to the name of the protocol, with a
3595                     "." between them, to construct a name that identifies
3596                     the field in the preference file; the name itself
3597                     should not include the protocol name, as the name in
3598                     the preference file will already have it
3599          title    - Field title in the preferences dialog
3600          description - Comments added to the preference file above the
3601                        preference value and shown as tooltip in the GUI, or NULL
3602          var      - pointer to the storage location that is updated when the
3603                     field is changed in the preference dialog box.  Note that
3604                     with string preferences the given pointer is overwritten
3605                     with a pointer to a new copy of the string during the
3606                     preference registration.  The passed-in string may be
3607                     freed, but you must keep another pointer to the string
3608                     in order to free it.
3609          base     - Base that the unsigned integer is expected to be in,
3610                     see strtoul(3).
3611          enumvals - an array of enum_val_t structures.  This must be
3612                     NULL-terminated; the members of that structure are:
3613
3614                         a short name, to be used with the "-o" flag - it
3615                         should not contain spaces or upper-case letters,
3616                         so that it's easier to put in a command line;
3617
3618                         a description, which is used in the GUI (and
3619                         which, for compatibility reasons, is currently
3620                         what's written to the preferences file) - it can
3621                         contain spaces, capital letters, punctuation,
3622                         etc.;
3623
3624                         the numerical value corresponding to that name
3625                         and description
3626          radio_buttons - TRUE if the field is to be displayed in the
3627                          preferences dialog as a set of radio buttons,
3628                          FALSE if it is to be displayed as an option
3629                          menu
3630          max_value - The maximum allowed value for a range (0 is the minimum).
3631
3632 An example from packet-beep.c -
3633
3634   proto_beep = proto_register_protocol("Blocks Extensible Exchange Protocol",
3635                                        "BEEP", "beep");
3636
3637         ...
3638
3639   /* Register our configuration options for BEEP, particularly our port */
3640
3641   beep_module = prefs_register_protocol(proto_beep, proto_reg_handoff_beep);
3642
3643   prefs_register_uint_preference(beep_module, "tcp.port", "BEEP TCP Port",
3644                                  "Set the port for BEEP messages (if other"
3645                                  " than the default of 10288)",
3646                                  10, &global_beep_tcp_port);
3647
3648   prefs_register_bool_preference(beep_module, "strict_header_terminator",
3649                                  "BEEP Header Requires CRLF",
3650                                  "Specifies that BEEP requires CRLF as a "
3651                                  "terminator, and not just CR or LF",
3652                                  &global_beep_strict_term);
3653
3654 This will create preferences "beep.tcp.port" and
3655 "beep.strict_header_terminator", the first of which is an unsigned
3656 integer and the second of which is a Boolean.
3657
3658 Note that a warning will pop up if you've saved such preference to the
3659 preference file and you subsequently take the code out. The way to make
3660 a preference obsolete is to register it as such:
3661
3662 /* Register a preference that used to be supported but no longer is. */
3663         void prefs_register_obsolete_preference(module_t *module,
3664             const char *name);
3665
3666 2.7 Reassembly/desegmentation for protocols running atop TCP.
3667
3668 There are two main ways of reassembling a Protocol Data Unit (PDU) which
3669 spans across multiple TCP segments.  The first approach is simpler, but
3670 assumes you are running atop of TCP when this occurs (but your dissector
3671 might run atop of UDP, too, for example), and that your PDUs consist of a
3672 fixed amount of data that includes enough information to determine the PDU
3673 length, possibly followed by additional data.  The second method is more
3674 generic but requires more code and is less efficient.
3675
3676 2.7.1 Using tcp_dissect_pdus().
3677
3678 For the first method, you register two different dissection methods, one
3679 for the TCP case, and one for the other cases.  It is a good idea to
3680 also have a dissect_PROTO_common function which will parse the generic
3681 content that you can find in all PDUs which is called from
3682 dissect_PROTO_tcp when the reassembly is complete and from
3683 dissect_PROTO_udp (or dissect_PROTO_other).
3684
3685 To register the distinct dissector functions, consider the following
3686 example, stolen from packet-dns.c:
3687
3688         dissector_handle_t dns_udp_handle;
3689         dissector_handle_t dns_tcp_handle;
3690         dissector_handle_t mdns_udp_handle;
3691
3692         dns_udp_handle = create_dissector_handle(dissect_dns_udp,
3693             proto_dns);
3694         dns_tcp_handle = create_dissector_handle(dissect_dns_tcp,
3695             proto_dns);
3696         mdns_udp_handle = create_dissector_handle(dissect_mdns_udp,
3697             proto_dns);
3698
3699         dissector_add_uint("udp.port", UDP_PORT_DNS, dns_udp_handle);
3700         dissector_add_uint("tcp.port", TCP_PORT_DNS, dns_tcp_handle);
3701         dissector_add_uint("udp.port", UDP_PORT_MDNS, mdns_udp_handle);
3702         dissector_add_uint("tcp.port", TCP_PORT_MDNS, dns_tcp_handle);
3703
3704 The dissect_dns_udp function does very little work and calls
3705 dissect_dns_common, while dissect_dns_tcp calls tcp_dissect_pdus with a
3706 reference to a callback which will be called with reassembled data:
3707
3708         static void
3709         dissect_dns_tcp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
3710         {
3711                 tcp_dissect_pdus(tvb, pinfo, tree, dns_desegment, 2,
3712                     get_dns_pdu_len, dissect_dns_tcp_pdu);
3713         }
3714
3715 (The dissect_dns_tcp_pdu function acts similarly to dissect_dns_udp.)
3716 The arguments to tcp_dissect_pdus are:
3717
3718         the tvbuff pointer, packet_info pointer, and proto_tree pointer
3719         passed to the dissector;
3720
3721         a gboolean flag indicating whether desegmentation is enabled for
3722         your protocol;
3723
3724         the number of bytes of PDU data required to determine the length
3725         of the PDU;
3726
3727         a routine that takes as arguments a packet_info pointer, a tvbuff
3728         pointer and an offset value representing the offset into the tvbuff
3729         at which a PDU begins and should return - *without* throwing an
3730         exception (it is guaranteed that the number of bytes specified by the
3731         previous argument to tcp_dissect_pdus is available, but more data
3732         might not be available, so don't refer to any data past that) - the
3733         total length of the PDU, in bytes;
3734
3735         a routine that's passed a tvbuff pointer, packet_info pointer,
3736         and proto_tree pointer, with the tvbuff containing a
3737         possibly-reassembled PDU, and that should dissect that PDU.
3738
3739 2.7.2 Modifying the pinfo struct.
3740
3741 The second reassembly mode is preferred when the dissector cannot determine
3742 how many bytes it will need to read in order to determine the size of a PDU.
3743 It may also be useful if your dissector needs to support reassembly from
3744 protocols other than TCP.
3745
3746 Your dissect_PROTO will initially be passed a tvbuff containing the payload of
3747 the first packet. It should dissect as much data as it can, noting that it may
3748 contain more than one complete PDU. If the end of the provided tvbuff coincides
3749 with the end of a PDU then all is well and your dissector can just return as
3750 normal. (If it is a new-style dissector, it should return the number of bytes
3751 successfully processed.)
3752
3753 If the dissector discovers that the end of the tvbuff does /not/ coincide with
3754 the end of a PDU, (ie, there is half of a PDU at the end of the tvbuff), it can
3755 indicate this to the parent dissector, by updating the pinfo struct. The
3756 desegment_offset field is the offset in the tvbuff at which the dissector will
3757 continue processing when next called.  The desegment_len field should contain
3758 the estimated number of additional bytes required for completing the PDU.  Next
3759 time your dissect_PROTO is called, it will be passed a tvbuff composed of the
3760 end of the data from the previous tvbuff together with desegment_len more bytes.
3761
3762 If the dissector cannot tell how many more bytes it will need, it should set
3763 desegment_len=DESEGMENT_ONE_MORE_SEGMENT; it will then be called again as soon
3764 as any more data becomes available. Dissectors should set the desegment_len to a
3765 reasonable value when possible rather than always setting
3766 DESEGMENT_ONE_MORE_SEGMENT as it will generally be more efficient. Also, you
3767 *must not* set desegment_len=1 in this case, in the hope that you can change
3768 your mind later: once you return a positive value from desegment_len, your PDU
3769 boundary is set in stone.
3770
3771 static hf_register_info hf[] = {
3772     {&hf_cstring,
3773      {"C String", "c.string", FT_STRING, BASE_NONE, NULL, 0x0,
3774       NULL, HFILL}
3775      }
3776    };
3777
3778 /**
3779 *   Dissect a buffer containing C strings.
3780 *
3781 *   @param  tvb     The buffer to dissect.
3782 *   @param  pinfo   Packet Info.
3783 *   @param  tree    The protocol tree.
3784 **/
3785 static void dissect_cstr(tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree)
3786 {
3787     guint offset = 0;
3788     while(offset < tvb_reported_length(tvb)) {
3789         gint available = tvb_reported_length_remaining(tvb, offset);
3790         gint len = tvb_strnlen(tvb, offset, available);
3791
3792         if( -1 == len ) {
3793             /* we ran out of data: ask for more */
3794             pinfo->desegment_offset = offset;
3795             pinfo->desegment_len = DESEGMENT_ONE_MORE_SEGMENT;
3796             return;
3797         }
3798
3799         col_set_str(pinfo->cinfo, COL_INFO, "C String");
3800
3801         len += 1; /* Add one for the '\0' */
3802
3803         if (tree) {
3804             proto_tree_add_item(tree, hf_cstring, tvb, offset, len,
3805                                 ENC_NA);
3806         }
3807         offset += (guint)len;
3808     }
3809
3810     /* if we get here, then the end of the tvb coincided with the end of a
3811        string. Happy days. */
3812 }
3813
3814 This simple dissector will repeatedly return DESEGMENT_ONE_MORE_SEGMENT
3815 requesting more data until the tvbuff contains a complete C string. The C string
3816 will then be added to the protocol tree. Note that there may be more
3817 than one complete C string in the tvbuff, so the dissection is done in a
3818 loop.
3819
3820 2.8 ptvcursors.
3821
3822 The ptvcursor API allows a simpler approach to writing dissectors for
3823 simple protocols. The ptvcursor API works best for protocols whose fields
3824 are static and whose format does not depend on the value of other fields.
3825 However, even if only a portion of your protocol is statically defined,
3826 then that portion could make use of ptvcursors.
3827
3828 The ptvcursor API lets you extract data from a tvbuff, and add it to a
3829 protocol tree in one step. It also keeps track of the position in the
3830 tvbuff so that you can extract data again without having to compute any
3831 offsets --- hence the "cursor" name of the API.
3832
3833 The three steps for a simple protocol are:
3834     1. Create a new ptvcursor with ptvcursor_new()
3835     2. Add fields with multiple calls of ptvcursor_add()
3836     3. Delete the ptvcursor with ptvcursor_free()
3837
3838 ptvcursor offers the possibility to add subtrees in the tree as well. It can be
3839 done in very simple steps :
3840     1. Create a new subtree with ptvcursor_push_subtree(). The old subtree is
3841        pushed in a stack and the new subtree will be used by ptvcursor.
3842     2. Add fields with multiple calls of ptvcursor_add(). The fields will be
3843        added in the new subtree created at the previous step.
3844     3. Pop the previous subtree with ptvcursor_pop_subtree(). The previous
3845        subtree is again used by ptvcursor.
3846 Note that at the end of the parsing of a packet you must have popped each
3847 subtree you pushed. If it's not the case, the dissector will generate an error.
3848
3849 To use the ptvcursor API, include the "ptvcursor.h" file. The PGM dissector
3850 is an example of how to use it. You don't need to look at it as a guide;
3851 instead, the API description here should be good enough.
3852
3853 2.8.1 ptvcursor API.
3854
3855 ptvcursor_t*
3856 ptvcursor_new(proto_tree* tree, tvbuff_t* tvb, gint offset)
3857     This creates a new ptvcursor_t object for iterating over a tvbuff.
3858 You must call this and use this ptvcursor_t object so you can use the
3859 ptvcursor API.
3860
3861 proto_item*
3862 ptvcursor_add(ptvcursor_t* ptvc, int hf, gint length, gboolean endianness)