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