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