Wireshark 4.5.0
The Wireshark network protocol analyzer
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
proto.h
Go to the documentation of this file.
1/* proto.h
2 * Definitions for protocol display
3 *
4 * Wireshark - Network traffic analyzer
5 * By Gerald Combs <gerald@wireshark.org>
6 * Copyright 1998 Gerald Combs
7 *
8 * SPDX-License-Identifier: GPL-2.0-or-later
9 */
10
11
23#ifndef __PROTO_H__
24#define __PROTO_H__
25
26#include "wsutil/nstime.h"
27#include "tvbuff.h"
28#include "value_string.h"
29#include "packet_info.h"
30#include "ftypes/ftypes.h"
31#include "register.h"
32#include "ws_symbol_export.h"
33#include "ws_attributes.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif /* __cplusplus */
38
48WS_DLL_PUBLIC int hf_text_only;
49
51#define ITEM_LABEL_LENGTH 240
52
53#define ITEM_LABEL_UNKNOWN_STR "Unknown"
54
55struct expert_field;
56
57/* Type-check that 'x' is compatible with 'type', should give compiler warnings otherwise. */
58#define cast_same(type, x) (0 ? (type)0 : (x))
59
61#define VALS(x) (cast_same(const struct _value_string*, (x)))
62
64#define VALS64(x) (cast_same(const struct _val64_string*, (x)))
65
67#define VALS_EXT_PTR(x) (cast_same(value_string_ext*, (x)))
68
70#define TIME_VALS(x) (cast_same(const struct _time_value_string*, (x)))
71
73#define TFS(x) (cast_same(const struct true_false_string*, (x)))
74
76#define UNS(x) (cast_same(const struct unit_name_string*, (x)))
77
78typedef void (*custom_fmt_func_t)(char *, uint32_t);
79
80typedef void (*custom_fmt_func_64_t)(char *, uint64_t);
81
82typedef void (*custom_fmt_func_double_t)(char *, double);
83
91#define CF_FUNC(x) ((const void *) (size_t) (x))
92
95#define RVALS(x) (cast_same(const struct _range_string*, (x)))
96
98#define FRAMENUM_TYPE(x) GINT_TO_POINTER(x)
99
100struct _protocol;
101
103typedef struct _protocol protocol_t;
104
115WS_DLL_PUBLIC WS_NORETURN
116void proto_report_dissector_bug(const char *format, ...)
117 G_GNUC_PRINTF(1, 2);
118
119#define REPORT_DISSECTOR_BUG(...) \
120 proto_report_dissector_bug(__VA_ARGS__)
121
125#ifdef _MSC_VER
126/* XXX - Is there a way to say "quit checking at this point"? */
127#define __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(expression) \
128 ; __analysis_assume(expression);
129#else
130#define __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(expression)
131#endif
132
144#define __DISSECTOR_ASSERT_STRINGIFY(s) # s
145
146#define __DISSECTOR_ASSERT(expression, file, lineno) \
147 (REPORT_DISSECTOR_BUG("%s:%u: failed assertion \"%s\"", \
148 file, lineno, __DISSECTOR_ASSERT_STRINGIFY(expression)))
149
150#define __DISSECTOR_ASSERT_HINT(expression, file, lineno, hint) \
151 (REPORT_DISSECTOR_BUG("%s:%u: failed assertion \"%s\" (%s)", \
152 file, lineno, __DISSECTOR_ASSERT_STRINGIFY(expression), hint))
153
154#define DISSECTOR_ASSERT(expression) \
155 ((void) ((expression) ? (void)0 : \
156 __DISSECTOR_ASSERT (expression, __FILE__, __LINE__))) \
157 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(expression)
158
166#define DISSECTOR_ASSERT_HINT(expression, hint) \
167 ((void) ((expression) ? (void)0 : \
168 __DISSECTOR_ASSERT_HINT (expression, __FILE__, __LINE__, hint))) \
169 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(expression)
170
171#if 0
172/* win32: using a debug breakpoint (int 3) can be very handy while debugging,
173 * as the assert handling of GTK/GLib is currently not very helpful */
174#define DISSECTOR_ASSERT(expression) \
175{ if(!(expression)) _asm { int 3}; }
176#endif
177
186#define DISSECTOR_ASSERT_NOT_REACHED() \
187 (REPORT_DISSECTOR_BUG("%s:%u: failed assertion \"DISSECTOR_ASSERT_NOT_REACHED\"", \
188 __FILE__, __LINE__))
189
209#define __DISSECTOR_ASSERT_CMPINT(a, op, b, type, fmt) \
210 (REPORT_DISSECTOR_BUG("%s:%u: failed assertion " #a " " #op " " #b " (" fmt " " #op " " fmt ")", \
211 __FILE__, __LINE__, (type)a, (type)b))
212
213#define DISSECTOR_ASSERT_CMPINT(a, op, b) \
214 ((void) ((a op b) ? (void)0 : \
215 __DISSECTOR_ASSERT_CMPINT (a, op, b, int64_t, "%" PRId64))) \
216 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(a op b)
217
223#define DISSECTOR_ASSERT_CMPUINT(a, op, b) \
224 ((void) ((a op b) ? (void)0 : \
225 __DISSECTOR_ASSERT_CMPINT (a, op, b, uint64_t, "%" PRIu64))) \
226 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(a op b)
227
231#define DISSECTOR_ASSERT_CMPUINTHEX(a, op, b) \
232 ((void) ((a op b) ? (void)0 : \
233 __DISSECTOR_ASSERT_CMPINT (a, op, b, uint64_t, "0x%" PRIX64))) \
234 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(a op b)
235
236/*
237 * This is similar to DISSECTOR_ASSERT(hfinfo->type == type) except that
238 * it will report the name of the field with the wrong type as well as
239 * the type.
240 *
241 * @param hfinfo The hfinfo for the field being tested
242 * @param type The type it's expected to have
243 */
244#define __DISSECTOR_ASSERT_FIELD_TYPE(hfinfo, t) \
245 (REPORT_DISSECTOR_BUG("%s:%u: field %s is not of type "#t, \
246 __FILE__, __LINE__, (hfinfo)->abbrev))
247
248#define DISSECTOR_ASSERT_FIELD_TYPE(hfinfo, t) \
249 ((void) (((hfinfo)->type == t) ? (void)0 : \
250 __DISSECTOR_ASSERT_FIELD_TYPE ((hfinfo), t))) \
251 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT((hfinfo)->type == t)
252
253#define DISSECTOR_ASSERT_FIELD_TYPE_IS_INTEGRAL(hfinfo) \
254 ((void) ((FT_IS_INTEGER((hfinfo)->type)) ? (void)0 : \
255 REPORT_DISSECTOR_BUG("%s:%u: field %s is not of type FT_CHAR or an FT_{U}INTn type", \
256 __FILE__, __LINE__, (hfinfo)->abbrev))) \
257 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(FT_IS_INTEGER((hfinfo)->type))
258
259#define __DISSECTOR_ASSERT_FIELD_TYPE_IS_STRING(hfinfo) \
260 (REPORT_DISSECTOR_BUG("%s:%u: field %s is not of type FT_STRING, FT_STRINGZ, FT_STRINGZPAD, FT_STRINGZTRUNC, or FT_UINT_STRING", \
261 __FILE__, __LINE__, (hfinfo)->abbrev))
262
263#define DISSECTOR_ASSERT_FIELD_TYPE_IS_STRING(hfinfo) \
264 ((void) (FT_IS_STRING((hfinfo)->type) ? (void)0 : \
265 __DISSECTOR_ASSERT_FIELD_TYPE_IS_STRING ((hfinfo)))) \
266 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT(FT_IS_STRING((hfinfo)->type))
267
268#define __DISSECTOR_ASSERT_FIELD_TYPE_IS_TIME(hfinfo) \
269 (REPORT_DISSECTOR_BUG("%s:%u: field %s is not of type FT_ABSOLUTE_TIME or FT_RELATIVE_TIME", \
270 __FILE__, __LINE__, (hfinfo)->abbrev))
271
272#define DISSECTOR_ASSERT_FIELD_TYPE_IS_TIME(hfinfo) \
273 ((void) (((hfinfo)->type == FT_ABSOLUTE_TIME || \
274 (hfinfo)->type == FT_RELATIVE_TIME) ? (void)0 : \
275 __DISSECTOR_ASSERT_FIELD_TYPE_IS_TIME ((hfinfo)))) \
276 __DISSECTOR_ASSERT_STATIC_ANALYSIS_HINT((hfinfo)->type == FT_ABSOLUTE_TIME || \
277 (hfinfo)->type == FT_RELATIVE_TIME)
278
279/*
280 * Encoding flags that apply to multiple data types.
281 */
282/*
283 * The encoding of a field of a particular type may involve more
284 * than just whether it's big-endian or little-endian and its size.
285 *
286 * For integral values, that's it, as 99.9999999999999% of the machines
287 * out there are 2's complement binary machines with 8-bit bytes,
288 * so the protocols out there expect that and, for example, any Unisys
289 * 2200 series machines out there just have to translate between 2's
290 * complement and 1's complement (and nobody's put any IBM 709x's on
291 * any networks lately :-)).
292 *
293 * However:
294 *
295 * for floating-point numbers, in addition to IEEE decimal
296 * floating-point, there's also IBM System/3x0 and PDP-11/VAX
297 * floating-point - most protocols use IEEE binary, but DCE RPC
298 * can use other formats if that's what the sending host uses;
299 *
300 * for character strings, there are various character encodings
301 * (various ISO 646 sets, ISO 8859/x, various other national
302 * standards, various DOS and Windows encodings, various Mac
303 * encodings, UTF-8, UTF-16, other extensions to ASCII, EBCDIC,
304 * etc.);
305 *
306 * for absolute times, there's UNIX time_t, UNIX time_t followed
307 * by 32-bit microseconds, UNIX time_t followed by 32-bit
308 * nanoseconds, DOS date/time, Windows FILETIME, NTP time, etc..
309 *
310 * We might also, in the future, want to allow a field specifier to
311 * indicate the encoding of the field, or at least its default
312 * encoding, as most fields in most protocols always use the
313 * same encoding (although that's not true of all fields, so we
314 * still need to be able to specify that at run time).
315 *
316 * So, for now, we define ENC_BIG_ENDIAN and ENC_LITTLE_ENDIAN as
317 * bit flags, to be combined, in the future, with other information
318 * to specify the encoding in the last argument to
319 * proto_tree_add_item(), and possibly to specify in a field
320 * definition (e.g., ORed in with the type value).
321 *
322 * Currently, proto_tree_add_item() treats its last argument as a
323 * Boolean - if it's zero, the field is big-endian, and if it's non-zero,
324 * the field is little-endian - and other code in epan/proto.c does
325 * the same. We therefore define ENC_BIG_ENDIAN as 0x00000000 and
326 * ENC_LITTLE_ENDIAN as 0x80000000 - we're using the high-order bit
327 * so that we could put a field type and/or a value such as a character
328 * encoding in the lower bits.
329 */
330#define ENC_BIG_ENDIAN 0x00000000
331#define ENC_LITTLE_ENDIAN 0x80000000
332
333#if G_BYTE_ORDER == G_LITTLE_ENDIAN
334 #define ENC_HOST_ENDIAN ENC_LITTLE_ENDIAN
335 #define ENC_ANTI_HOST_ENDIAN ENC_BIG_ENDIAN
336#else
337 #define ENC_HOST_ENDIAN ENC_BIG_ENDIAN
338 #define ENC_ANTI_HOST_ENDIAN ENC_LITTLE_ENDIAN
339#endif
340
341/*
342 * For protocols (FT_PROTOCOL), aggregate items with subtrees (FT_NONE),
343 * opaque byte-array fields (FT_BYTES), and other fields where there
344 * is no choice of encoding (either because it's "just a bucket
345 * of bytes" or because the encoding is completely fixed), we
346 * have ENC_NA (for "Not Applicable").
347 */
348#define ENC_NA 0x00000000
349
350/*
351 * Encoding for character strings - and for character-encoded values
352 * for non-string types.
353 *
354 * Historically, the only place the representation mattered for strings
355 * was with FT_UINT_STRINGs, where we had false for the string length
356 * being big-endian and true for it being little-endian.
357 *
358 * We now have encoding values for the character encoding. The encoding
359 * values are encoded in all but the top bit (which is the byte-order
360 * bit, required for FT_UINT_STRING and for UCS-2 and UTF-16 strings)
361 * and the bottom bit (which we ignore for now so that programs that
362 * pass true for the encoding just do ASCII).
363 *
364 * For ENC_ASCII, we map ASCII characters with the high bit set to the UTF-8
365 * REPLACEMENT CHARACTER, and do the same for ENC_UTF_8 with invalid UTF-8
366 * sequences. We should also map 0x00 to that as well - null-terminated and
367 * null-padded strings never have NULs in them, but counted strings might.
368 * Either that, or strings should be counted, not null-terminated. Note
369 * that conversion of ASCII and UTF-8 can change the length of the string,
370 * as with any other encoding, due to REPLACEMENT CHARACTERs.
371 *
372 * For display, perhaps we should also map control characters to the
373 * Unicode glyphs showing the name of the control character in small
374 * caps, diagonally. (Unfortunately, those only exist for C0, not C1.)
375 *
376 * *DO NOT* add anything to this set that is not a character encoding!
377 */
378#define ENC_CHARENCODING_MASK 0x0000FFFE /* mask out byte-order bits and other bits used with string encodings */
379#define ENC_ASCII 0x00000000
380#define ENC_ISO_646_IRV ENC_ASCII /* ISO 646 International Reference Version = ASCII */
381#define ENC_UTF_8 0x00000002
382#define ENC_UTF_16 0x00000004
383#define ENC_UCS_2 0x00000006
384#define ENC_UCS_4 0x00000008
385#define ENC_ISO_8859_1 0x0000000A
386#define ENC_ISO_8859_2 0x0000000C
387#define ENC_ISO_8859_3 0x0000000E
388#define ENC_ISO_8859_4 0x00000010
389#define ENC_ISO_8859_5 0x00000012
390#define ENC_ISO_8859_6 0x00000014
391#define ENC_ISO_8859_7 0x00000016
392#define ENC_ISO_8859_8 0x00000018
393#define ENC_ISO_8859_9 0x0000001A
394#define ENC_ISO_8859_10 0x0000001C
395#define ENC_ISO_8859_11 0x0000001E
396/* #define ENC_ISO_8859_12 0x00000020 ISO 8859-12 was abandoned */
397#define ENC_ISO_8859_13 0x00000022
398#define ENC_ISO_8859_14 0x00000024
399#define ENC_ISO_8859_15 0x00000026
400#define ENC_ISO_8859_16 0x00000028
401#define ENC_WINDOWS_1250 0x0000002A
402#define ENC_3GPP_TS_23_038_7BITS_PACKED 0x0000002C
403#define ENC_3GPP_TS_23_038_7BITS ENC_3GPP_TS_23_038_7BITS_PACKED
404#define ENC_EBCDIC 0x0000002E
405#define ENC_MAC_ROMAN 0x00000030
406#define ENC_CP437 0x00000032
407#define ENC_ASCII_7BITS 0x00000034
408#define ENC_T61 0x00000036
409#define ENC_EBCDIC_CP037 0x00000038
410#define ENC_WINDOWS_1252 0x0000003A
411#define ENC_WINDOWS_1251 0x0000003C
412#define ENC_CP855 0x0000003E
413#define ENC_CP866 0x00000040
414#define ENC_ISO_646_BASIC 0x00000042
415#define ENC_BCD_DIGITS_0_9 0x00000044 /* Packed BCD, digits 0-9 */
416#define ENC_KEYPAD_ABC_TBCD 0x00000046 /* Keypad-with-a/b/c "telephony BCD" = 0-9, *, #, a, b, c */
417#define ENC_KEYPAD_BC_TBCD 0x00000048 /* Keypad-with-B/C "telephony BCD" = 0-9, B, C, *, # */
418#define ENC_3GPP_TS_23_038_7BITS_UNPACKED 0x0000004C
419#define ENC_ETSI_TS_102_221_ANNEX_A 0x0000004E /* ETSI TS 102 221 Annex A */
420#define ENC_GB18030 0x00000050
421#define ENC_EUC_KR 0x00000052
422#define ENC_APN_STR 0x00000054 /* The encoding the APN/DNN field follows 3GPP TS 23.003 [2] clause 9.1.*/
423#define ENC_DECT_STANDARD_8BITS 0x00000056 /* DECT standard character set as defined in ETSI EN 300 175-5 Annex D */
424#define ENC_DECT_STANDARD_4BITS_TBCD 0x00000058 /* DECT standard 4bits character set as defined in ETSI EN 300 175-5 Annex D (BCD with 0xb = SPACE)*/
425#define ENC_EBCDIC_CP500 0x00000060
426/*
427 * TODO:
428 *
429 * packet-bacapp.c refers to two currently unsupported character sets (where
430 * we just use ASCII currently):
431 *
432 * "IBM MS DBCS" - At the very least could be any IBM/MS Double Byte
433 * Character Set for CJK (4 major ones), but also could just be any non
434 * Unicode and non ISO-8859-1 code page. This would be supported via the
435 * various code pages.
436 * JIS C 6226 / JIS X 0206 - Does this refer to ISO-2022-JP, SHIFT-JIS, or
437 * EUC-JP, which are all encoding schemes that support the JIS X 0206
438 * character set?
439 *
440 * As those are added, change code such as the code in packet-bacapp.c
441 * to use them.
442 *
443 * There's also some other code (e.g., packet-smpp.c) that just ignores
444 * strings if it determines that they are in an unsupported encoding, such
445 * as various encodings of Japanese mentioned above, for example.
446 *
447 */
448
449/*
450 * This is a modifier for FT_UINT_STRING and FT_UINT_BYTES values;
451 * it indicates that the length field should be interpreted as per
452 * sections 2.5.2.11 Octet String through 2.5.2.14 Long Character
453 * String of the ZigBee Cluster Library Specification, where if all
454 * bits are set in the length field, the string has an invalid value,
455 * and the number of octets in the value is 0.
456 */
457#define ENC_ZIGBEE 0x40000000
458
459/*
460 * This is a modifier for ENC_UTF_16, ENC_UCS_2, and ENC_UCS_4
461 * indicating that if the first two (or four, for UCS-4) octets
462 * are a big-endian or little-endian BOM, use that to determine
463 * the serialization order and ignore the ENC_LITTLE_ENDIAN or
464 * ENC_BIG_ENDIAN flag. This can't collide with ENC_ZIGBEE because
465 * it could be used simultaneously.
466 */
467#define ENC_BOM 0x20000000
468
469/*
470 * For cases where either native type or string encodings could both be
471 * valid arguments, we need something to distinguish which one is being
472 * passed as the argument, because ENC_BIG_ENDIAN and ENC_ASCII are both
473 * 0x00000000. So we use ENC_STR_NUM or ENC_STR_HEX bit-or'ed with
474 * ENC_ASCII and its ilk.
475 *
476 * XXX - ENC_STR_NUM is not yet supported by any code in Wireshark,
477 * and these are only used for byte arrays. Presumably they could
478 * also be used for integral values in the future.
479 */
480/* this is for strings as numbers "12345" */
481#define ENC_STR_NUM 0x01000000
482/* this is for strings as hex "1a2b3c" */
483#define ENC_STR_HEX 0x02000000
484/* a convenience macro for either of the above */
485#define ENC_STRING 0x03000000
486/* Kept around for compatibility for Lua scripts; code should use ENC_CHARENCODING_MASK */
487#define ENC_STR_MASK 0x0000FFFE
488
489/*
490 * For cases where the number is allowed to have a leading '+'/'-'
491 * this can't collide with ENC_SEP_* because they can be used simultaneously
492 *
493 * XXX - this is not used anywhere in Wireshark's code, dating back to
494 * at least Wireshark 2.6 and continuing to the current version.
495 * Perhaps the intent was to use it in the future, but 1) I'm not sure
496 * why it would be combined with ENC_SEP_, as byte arrays have no sign
497 * but integral values do, and 2) if we were to support string encodings
498 * for integral types, presumably whether it's signed (FT_INTn) or
499 * unsigned (FT_UINTn) would suffice to indicate whether the value
500 * can be signed or not.
501 */
502#define ENC_NUM_PREF 0x00200000
503
504/*
505 * Encodings for byte arrays.
506 *
507 * For cases where the byte array is encoded as a string composed of
508 * pairs of hex digits, possibly with a separator character between
509 * the pairs. That's specified by the encoding having ENC_STR_HEX,
510 * plus one of these values, set.
511 *
512 * See hex_str_to_bytes_encoding() in epan/strutil.h for details.
513 */
514#define ENC_SEP_NONE 0x00010000
515#define ENC_SEP_COLON 0x00020000
516#define ENC_SEP_DASH 0x00040000
517#define ENC_SEP_DOT 0x00080000
518#define ENC_SEP_SPACE 0x00100000
519/* a convenience macro for the above */
520#define ENC_SEP_MASK 0x001F0000
521
522/* Encodings for BCD strings
523 * Depending if the BCD string has even or odd number of digits
524 * we may need to strip of the last digit/High nibble
525 */
526#define ENC_BCD_ODD_NUM_DIG 0x00010000
527#define ENC_BCD_SKIP_FIRST 0x00020000
528
529/*
530 * Encodings for time values.
531 *
532 * Historically FT_TIMEs were only timespecs; the only question was whether
533 * they were stored in big- or little-endian format.
534 *
535 * For backwards compatibility, we interpret an encoding of 1 as meaning
536 * "little-endian timespec", so that passing true is interpreted as that.
537 *
538 * We now support:
539 *
540 * ENC_TIME_SECS_NSECS - 8, 12, or 16 bytes. For 8 bytes, the first 4
541 * bytes are seconds and the next 4 bytes are nanoseconds; for 12 bytes,
542 * the first 8 bytes are seconds and the next 4 bytes are nanoseconds;
543 * for 16 bytes, the first 8 bytes are seconds and the next 8 bytes are
544 * nanoseconds. If the time is absolute, the seconds are seconds since
545 * the UN*X epoch (1970-01-01 00:00:00 UTC). (I.e., a UN*X struct
546 * timespec with a 4-byte or 8-byte time_t or a structure with an
547 * 8-byte time_t and an 8-byte nanoseconds field.)
548 *
549 * ENC_TIME_NTP - 8 bytes; the first 4 bytes are seconds since the NTP
550 * epoch (1900-01-01 00:00:00 GMT) and the next 4 bytes are 1/2^32's of
551 * a second since that second. (I.e., a 64-bit count of 1/2^32's of a
552 * second since the NTP epoch, with the upper 32 bits first and the
553 * lower 32 bits second, even when little-endian.) A value of 0 is a
554 * special case representing unknown or unsynchronized time. Per the
555 * suggestion in RFC 4330, if bit 0 is not set then the time is assumed
556 * to be in NTP Era 1, beginning on 2036-02-07 06:28:16 UTC. (I.e., the
557 * time displayed will be between 1968-01-20 03:14:08 UTC and
558 * 2104-02-26 09:42:24 UTC.) The 16 byte NTP date format and the 4 byte
559 * NTP short relative time format are not supported.
560 * Encodings that store only the seconds since the NTP epoch without
561 * fractional seconds should use ENC_TIME_SECS_NTP, described below.
562 *
563 * ENC_TIME_TOD - 8 bytes, as a count of microseconds since the System/3x0
564 * and z/Architecture epoch (1900-01-01 00:00:00 GMT).
565 *
566 * ENC_TIME_RTPS - 8 bytes; the first 4 bytes are seconds since the UN*X
567 * epoch and the next 4 bytes are 1/2^32's of a second since that
568 * second. (I.e., it's the offspring of a mating between UN*X time and
569 * NTP time). It's used by the Object Management Group's Real-Time
570 * Publish-Subscribe Wire Protocol for the Data Distribution Service.
571 *
572 * ENC_TIME_SECS_USECS - 8 bytes; the first 4 bytes are seconds and the
573 * next 4 bytes are microseconds. If the time is absolute, the seconds
574 * are seconds since the UN*X epoch. (I.e., a UN*X struct timeval with
575 * a 4-byte time_t.)
576 *
577 * ENC_TIME_SECS - 4 to 8 bytes, representing a value in seconds.
578 * If the time is absolute, it's seconds since the UN*X epoch.
579 *
580 * ENC_TIME_MSECS - 6 to 8 bytes, representing a value in milliseconds.
581 * If the time is absolute, it's milliseconds since the UN*X epoch.
582 *
583 * ENC_TIME_USECS - 8 bytes, representing a value in microseconds.
584 * If the time is absolute, it's microseconds since the UN*X epoch.
585 *
586 * ENC_TIME_NSECS - 8 bytes, representing a value in nanoseconds.
587 * If the time is absolute, it's nanoseconds since the UN*X epoch.
588 *
589 * ENC_TIME_SECS_NTP - 4 bytes, representing a count of seconds since
590 * the NTP epoch. As with ENC_TIME_NTP, times are assumed to be in
591 * the upper half of NTP Era 0 or the lower half of NTP Era 1.
592 *
593 * ENC_TIME_RFC_3971 - 8 bytes, representing a count of 1/64ths of a
594 * second since the UN*X epoch; see section 5.3.1 "Timestamp Option"
595 * in RFC 3971.
596 *
597 * ENC_TIME_MSEC_NTP - 6-8 bytes, representing a count of milliseconds since
598 * the NTP epoch. Similar to ENC_TIME_NTP, times before the midpoint of
599 * NTP Era 0 (1968-01-20) are assumed to represent the corresponding
600 * time in NTP Era 1 instead.
601 *
602 * ENC_TIME_MIP6 - 8 bytes; the first 48 bits are seconds since the UN*X epoch
603 * and the remaining 16 bits indicate the number of 1/65536's of a second
604 * since that second.
605 *
606 * ENC_TIME_MP4_FILE_SECS - 4-8 bytes, representing a count of seconds since
607 * January 1, 1904, 00:00:00 UTC.
608 *
609 * ENC_TIME_ZBEE_ZCL - 4-8 bytes, representing a count of seconds since
610 * January 1, 2000, 00:00:00 UTC.
611 */
612#define ENC_TIME_SECS_NSECS 0x00000000
613#define ENC_TIME_TIMESPEC 0x00000000 /* for backwards source compatibility */
614#define ENC_TIME_NTP 0x00000002
615#define ENC_TIME_TOD 0x00000004
616#define ENC_TIME_RTPS 0x00000008
617#define ENC_TIME_NTP_BASE_ZERO 0x00000008 /* for backwards source compatibility */
618#define ENC_TIME_SECS_USECS 0x00000010
619#define ENC_TIME_TIMEVAL 0x00000010 /* for backwards source compatibility */
620#define ENC_TIME_SECS 0x00000012
621#define ENC_TIME_MSECS 0x00000014
622#define ENC_TIME_SECS_NTP 0x00000018
623#define ENC_TIME_RFC_3971 0x00000020
624#define ENC_TIME_MSEC_NTP 0x00000022
625#define ENC_TIME_MIP6 0x00000024
626#define ENC_TIME_MP4_FILE_SECS 0x00000026
627#define ENC_TIME_CLASSIC_MAC_OS_SECS 0x00000026 /* for backwards source compatibility */
628#define ENC_TIME_NSECS 0x00000028
629#define ENC_TIME_USECS 0x00000030
630#define ENC_TIME_ZBEE_ZCL 0x00000032
631
632/*
633 * For cases where a string encoding contains a timestamp, use one
634 * of these (but only one). These values can collide with the ENC_SEP_
635 * values used when a string encoding contains a byte array, because
636 * you can't do both at the same time. They must not, however,
637 * overlap with the character encoding values.
638 */
639#define ENC_ISO_8601_DATE 0x00010000
640#define ENC_ISO_8601_TIME 0x00020000
641#define ENC_ISO_8601_DATE_TIME 0x00030000
642#define ENC_IMF_DATE_TIME 0x00040000 /* Internet Message Format - RFCs 822, 1123, 2822, 5322 */
643#define ENC_RFC_822 0x00040000 /* backwards compatibility */
644#define ENC_RFC_1123 0x00040000 /* backwards source compatibility - not binary */
645#define ENC_ISO_8601_DATE_TIME_BASIC 0x00100000
646/* a convenience macro for the above - for internal use only */
647#define ENC_STR_TIME_MASK 0x001F0000
648
649/*
650 * Encodings for variable-length integral types.
651 */
652
653/* Use varint format as described in Protobuf protocol
654 * https://developers.google.cn/protocol-buffers/docs/encoding
655 */
656#define ENC_VARINT_PROTOBUF 0x00000002
657/*
658 * Decodes a variable-length integer used in QUIC protocol
659 * See https://tools.ietf.org/html/draft-ietf-quic-transport-08#section-8.1
660 */
661#define ENC_VARINT_QUIC 0x00000004
662 /*
663 * Use "zig-zag" varint format as described in Protobuf protocol
664 * See https://developers.google.com/protocol-buffers/docs/encoding?csw=1#types
665 */
666#define ENC_VARINT_ZIGZAG 0x00000008
667/*
668 * Decodes a variable-length integer used in DTN protocols
669 * See https://www.rfc-editor.org/rfc/rfc6256.html
670 */
671#define ENC_VARINT_SDNV 0x00000010
672
673#define ENC_VARINT_MASK (ENC_VARINT_PROTOBUF|ENC_VARINT_QUIC|ENC_VARINT_ZIGZAG|ENC_VARINT_SDNV)
674
675/* Values for header_field_info.display */
676
677/* For integral types, the display format is a BASE_* field_display_e value
678 * possibly ORed with BASE_*_STRING */
679
681#define FIELD_DISPLAY_E_MASK 0xFF
682
723
724#define FIELD_DISPLAY(d) ((d) & FIELD_DISPLAY_E_MASK)
725
726#define FIELD_DISPLAY_IS_ABSOLUTE_TIME(d) \
727 (FIELD_DISPLAY(d) >= ABSOLUTE_TIME_LOCAL && FIELD_DISPLAY(d) <= ABSOLUTE_TIME_UNIX)
728
729/* Following constants have to be ORed with a field_display_e when dissector
730 * want to use specials value-string MACROs for a header_field_info */
731#define BASE_RANGE_STRING 0x00000100
732#define BASE_EXT_STRING 0x00000200
733#define BASE_VAL64_STRING 0x00000400
734
735#define BASE_ALLOW_ZERO 0x00000800
737#define BASE_UNIT_STRING 0x00001000
739#define BASE_NO_DISPLAY_VALUE 0x00002000
742#define BASE_PROTOCOL_INFO 0x00004000
744#define BASE_SPECIAL_VALS 0x00008000
746#define BASE_SHOW_ASCII_PRINTABLE 0x00010000
748#define BASE_SHOW_UTF_8_PRINTABLE 0x00020000
751#define IS_BASE_DUAL(b) ((b)==BASE_DEC_HEX||(b)==BASE_HEX_DEC)
752
754#define IS_BASE_PORT(b) (((b)==BASE_PT_UDP||(b)==BASE_PT_TCP||(b)==BASE_PT_DCCP||(b)==BASE_PT_SCTP))
755
762
765
768 /* ---------- set by dissector --------- */
769 const char *name;
770 const char *abbrev;
771 enum ftenum type;
773 const void *strings;
777 uint64_t bitmask;
778 const char *blurb;
780 /* ------- set by proto routines (prefilled by HFILL macro, see below) ------ */
781 int id;
782 int parent;
786};
787
793#define HFILL -1, 0, HF_REF_TYPE_NONE, -1, NULL
794
795#define HFILL_INIT(hf) \
796 (hf).hfinfo.id = -1; \
797 (hf).hfinfo.parent = 0; \
798 (hf).hfinfo.ref_type = HF_REF_TYPE_NONE; \
799 (hf).hfinfo.same_name_prev_id = -1; \
800 (hf).hfinfo.same_name_next = NULL;
801
807
809typedef struct _item_label_t {
810 char representation[ITEM_LABEL_LENGTH];
811 size_t value_pos;
812 size_t value_len;
814
830
831
832/*
833 * This structure describes one segment of a split-bits item
834 * crumb_bit_offset is the bit offset in the input tvb of the first (most significant) bit of this crumb
835 * crumb_bit_length is the number of contiguous bits of this crumb.
836 * The first element of an array of bits_specs describes the most significant crumb of the output value.
837 * The second element of an array of bits_specs describes the next-most significant crumb of the output value, etc.
838 * The array is terminated by a sentinel entry with crumb_bit_length of 0.
839*/
840typedef struct
841{
842 unsigned crumb_bit_offset;
843 uint8_t crumb_bit_length;
845
846/*
847 * Flag fields. Do not assign values greater than 0x000FFFFF unless you
848 * shuffle the expert information upward; see below.
849 */
850
856#define FI_HIDDEN 0x00000001
859#define FI_GENERATED 0x00000002
861#define FI_URL 0x00000004
862
864#define FI_LITTLE_ENDIAN 0x00000008
866#define FI_BIG_ENDIAN 0x00000010
868#define FI_BITS_OFFSET(n) (((n) & 63) << 5)
870/* if 0, it means that field takes fi->length * 8 */
871#define FI_BITS_SIZE(n) (((n) & 63) << 12)
873#define FI_VARINT 0x00040000
874
876#define FI_GET_FLAG(fi, flag) ((fi) ? ((fi)->flags & (flag)) : 0)
878#define FI_SET_FLAG(fi, flag) \
879 do { \
880 if (fi) \
881 (fi)->flags = (fi)->flags | (flag); \
882 } while(0)
884#define FI_RESET_FLAG(fi, flag) \
885 do { \
886 if (fi) \
887 (fi)->flags = (fi)->flags & ~(flag); \
888 } while(0)
889
890#define FI_GET_BITS_OFFSET(fi) (FI_GET_FLAG(fi, FI_BITS_OFFSET(63)) >> 5)
891#define FI_GET_BITS_SIZE(fi) (FI_GET_FLAG(fi, FI_BITS_SIZE(63)) >> 12)
892
895typedef struct {
896 GHashTable *interesting_hfids;
897 bool visible;
898 bool fake_protocols;
899 unsigned count;
900 struct _packet_info *pinfo;
901 int max_start;
902 unsigned start_idle_count;
904
906typedef struct _proto_node {
907 struct _proto_node *first_child;
908 struct _proto_node *last_child;
909 struct _proto_node *next;
910 struct _proto_node *parent;
911 const header_field_info *hfinfo;
912 field_info *finfo;
913 tree_data_t *tree_data;
915
920
921/*
922 * Expert information.
923 * This is in the flags field; we allocate this from the top down,
924 * so as not to collide with FI_ flags, which are allocated from
925 * the bottom up.
926 */
927
928/* expert severities */
929#define PI_SEVERITY_MASK 0x00F00000
931#define PI_COMMENT 0x00100000
933#define PI_CHAT 0x00200000
935#define PI_NOTE 0x00400000
937#define PI_WARN 0x00600000
939#define PI_ERROR 0x00800000
940
941/* expert "event groups" */
942#define PI_GROUP_MASK 0xFF000000
944#define PI_CHECKSUM 0x01000000
946#define PI_SEQUENCE 0x02000000
948#define PI_RESPONSE_CODE 0x03000000
950#define PI_REQUEST_CODE 0x04000000
952#define PI_UNDECODED 0x05000000
954#define PI_REASSEMBLE 0x06000000
956#define PI_MALFORMED 0x07000000
958#define PI_DEBUG 0x08000000
960#define PI_PROTOCOL 0x09000000
962#define PI_SECURITY 0x0a000000
964#define PI_COMMENTS_GROUP 0x0b000000
966#define PI_DECRYPTION 0x0c000000
968#define PI_ASSUMPTION 0x0d000000
970#define PI_DEPRECATED 0x0e000000
972#define PI_RECEIVE 0x0f000000
974#define PI_INTERFACE 0x10000000
976#define PI_DISSECTOR_BUG 0x11000000
977
978/*
979 * add more, see WSDG: 9.3. How to add an expert item:
980 * https://www.wireshark.org/docs/wsdg_html/#ChDissectExpertInfo
981 */
982
984#define PNODE_FINFO(proto_node) ((proto_node)->finfo)
985
987#define PITEM_FINFO(proto_item) PNODE_FINFO(proto_item)
988
990#define PTREE_FINFO(proto_tree) PNODE_FINFO(proto_tree)
991
993#define PNODE_HFINFO(proto_node) ((proto_node)->hfinfo)
994
996#define PITEM_HFINFO(proto_item) PNODE_HFINFO(proto_item)
997
999#define PTREE_HFINFO(proto_tree) PNODE_HFINFO(proto_tree)
1000
1002#define PTREE_DATA(proto_tree) ((proto_tree)->tree_data)
1003
1005#define PNODE_POOL(proto_node) ((proto_node)->tree_data->pinfo->pool)
1006
1012static inline bool proto_item_is_hidden(const proto_item *ti) {
1013 if (ti && PITEM_FINFO(ti)) {
1014 return FI_GET_FLAG(PITEM_FINFO(ti), FI_HIDDEN);
1015 }
1016 /* XXX - Is a NULL item hidden? */
1017 return true;
1018}
1019#define PROTO_ITEM_IS_HIDDEN(ti) proto_item_is_hidden((ti))
1020
1025static inline void proto_item_set_hidden(proto_item *ti) {
1026 if (ti) {
1028 }
1029}
1030#define PROTO_ITEM_SET_HIDDEN(ti) proto_item_set_hidden((ti))
1031
1035static inline void proto_item_set_visible(proto_item *ti) {
1036 if (ti) {
1038 }
1039}
1040#define PROTO_ITEM_SET_VISIBLE(ti) proto_item_set_visible((ti))
1041
1046static inline bool proto_item_is_generated(const proto_item *ti)
1047{
1048 if (ti) {
1050 }
1051 return false;
1052}
1053#define PROTO_ITEM_IS_GENERATED(ti) proto_item_is_generated((ti))
1054
1058static inline void proto_item_set_generated(proto_item *ti) {
1059 if (ti) {
1061 }
1062}
1063#define PROTO_ITEM_SET_GENERATED(ti) proto_item_set_generated((ti))
1064
1070static inline bool proto_item_is_url(const proto_item *ti)
1071{
1072 if (ti) {
1073 return FI_GET_FLAG(PITEM_FINFO(ti), FI_URL);
1074 }
1075 return false;
1076}
1077#define PROTO_ITEM_IS_URL(ti) proto_item_is_url((ti))
1078
1082static inline void proto_item_set_url(proto_item *ti) {
1083 if (ti) {
1085 }
1086}
1087#define PROTO_ITEM_SET_URL(ti) proto_item_set_url((ti))
1088
1089typedef void (*proto_tree_foreach_func)(proto_node *, void *);
1090typedef bool (*proto_tree_traverse_func)(proto_node *, void *);
1091
1092WS_DLL_PUBLIC void proto_tree_children_foreach(proto_tree *tree,
1093 proto_tree_foreach_func func, void *data);
1094
1095typedef struct {
1096 void (*register_protoinfo)(void); /* routine to call to register protocol information */
1097 void (*register_handoff)(void); /* routine to call to register dissector handoff */
1098} proto_plugin;
1099
1101WS_DLL_PUBLIC void proto_register_plugin(const proto_plugin *plugin);
1102
1104void proto_init(GSList *register_all_plugin_protocols_list,
1105 GSList *register_all_plugin_handoffs_list, register_cb cb, void *client_data);
1106
1108extern void proto_cleanup(void);
1109
1123WS_DLL_PUBLIC bool proto_field_is_referenced(proto_tree *tree, int proto_id);
1124
1129WS_DLL_PUBLIC proto_tree* proto_item_add_subtree(proto_item *pi, const int idx) G_GNUC_WARN_UNUSED_RESULT;
1130
1134WS_DLL_PUBLIC proto_tree* proto_item_get_subtree(proto_item *pi);
1135
1139WS_DLL_PUBLIC proto_item* proto_item_get_parent(const proto_item *pi);
1140
1145WS_DLL_PUBLIC proto_item* proto_item_get_parent_nth(proto_item *pi, int gen);
1146
1151WS_DLL_PUBLIC void proto_item_set_text(proto_item *pi, const char *format, ...)
1152 G_GNUC_PRINTF(2,3);
1153
1158WS_DLL_PUBLIC void proto_item_append_text(proto_item *pi, const char *format, ...)
1159 G_GNUC_PRINTF(2,3);
1160
1165WS_DLL_PUBLIC void proto_item_prepend_text(proto_item *pi, const char *format, ...)
1166 G_GNUC_PRINTF(2,3);
1167
1171WS_DLL_PUBLIC void proto_item_set_len(proto_item *pi, const int length);
1172
1191WS_DLL_PUBLIC void proto_item_set_end(proto_item *pi, tvbuff_t *tvb, int end);
1192
1197WS_DLL_PUBLIC int proto_item_get_len(const proto_item *pi);
1198
1204WS_DLL_PUBLIC void proto_item_set_bits_offset_len(proto_item *ti, int bits_offset, int bits_len);
1205
1218WS_DLL_PUBLIC char *proto_item_get_display_repr(wmem_allocator_t *scope, proto_item *pi);
1219
1222extern proto_tree* proto_tree_create_root(struct _packet_info *pinfo);
1223
1224void proto_tree_reset(proto_tree *tree);
1225
1228WS_DLL_PUBLIC void proto_tree_free(proto_tree *tree);
1229
1237WS_DLL_PUBLIC bool
1238proto_tree_set_visible(proto_tree *tree, bool visible);
1239
1243extern void
1244proto_tree_set_fake_protocols(proto_tree *tree, bool fake_protocols);
1245
1252extern void
1254
1260extern void
1262
1266WS_DLL_PUBLIC proto_item* proto_tree_get_parent(proto_tree *tree);
1267
1272
1276WS_DLL_PUBLIC proto_tree* proto_tree_get_root(proto_tree *tree);
1277
1282WS_DLL_PUBLIC void proto_tree_move_item(proto_tree *tree, proto_item *fixed_item, proto_item *item_to_move);
1283
1284
1290WS_DLL_PUBLIC void proto_tree_set_appendix(proto_tree *tree, tvbuff_t *tvb, int start, const int length);
1291
1292
1302WS_DLL_PUBLIC proto_item *
1304 const int start, int length, const unsigned encoding);
1305
1306WS_DLL_PUBLIC proto_item *
1307proto_tree_add_item(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1308 const int start, int length, const unsigned encoding);
1309
1322WS_DLL_PUBLIC proto_item *
1324 const int start, int length, const unsigned encoding, int *lenretval);
1325
1326WS_DLL_PUBLIC proto_item *
1327proto_tree_add_item_ret_length(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1328 const int start, int length, const unsigned encoding, int *lenretval);
1329
1361WS_DLL_PUBLIC proto_item *
1362proto_tree_add_item_ret_int(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1363 const int start, int length, const unsigned encoding, int32_t *retval);
1364
1365WS_DLL_PUBLIC proto_item *
1366proto_tree_add_item_ret_int64(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1367 const int start, int length, const unsigned encoding, int64_t *retval);
1368
1369WS_DLL_PUBLIC proto_item *
1370proto_tree_add_item_ret_uint(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1371 const int start, int length, const unsigned encoding, uint32_t *retval);
1372
1373WS_DLL_PUBLIC proto_item *
1374proto_tree_add_item_ret_uint64(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1375 const int start, int length, const unsigned encoding, uint64_t *retval);
1376
1377WS_DLL_PUBLIC proto_item *
1378proto_tree_add_item_ret_varint(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1379 const int start, int length, const unsigned encoding, uint64_t *retval, int *lenretval);
1380
1381WS_DLL_PUBLIC proto_item *
1382proto_tree_add_item_ret_boolean(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1383 const int start, int length, const unsigned encoding, bool *retval);
1384
1385WS_DLL_PUBLIC proto_item *
1386proto_tree_add_item_ret_ipv4(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1387 const int start, int length, const unsigned encoding, ws_in4_addr *retval);
1388
1403WS_DLL_PUBLIC proto_item *
1404proto_tree_add_item_ret_ipv6(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1405 const int start, int length, const unsigned encoding, ws_in6_addr *retval);
1406
1421WS_DLL_PUBLIC proto_item *
1422proto_tree_add_item_ret_ether(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1423 const int start, int length, const unsigned encoding, uint8_t *retval);
1424
1438WS_DLL_PUBLIC proto_item *
1439proto_tree_add_item_ret_float(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1440 const int start, int length,
1441 const unsigned encoding, float *retval);
1442
1456WS_DLL_PUBLIC proto_item *
1457proto_tree_add_item_ret_double(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1458 const int start, int length,
1459 const unsigned encoding, double *retval);
1460
1490WS_DLL_PUBLIC proto_item *
1492 tvbuff_t *tvb, const int start, int length, const unsigned encoding,
1493 wmem_allocator_t *scope, const uint8_t **retval, int *lenretval);
1494
1522WS_DLL_PUBLIC proto_item *
1523proto_tree_add_item_ret_string(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1524 const int start, int length, const unsigned encoding,
1525 wmem_allocator_t *scope, const uint8_t **retval);
1526
1547WS_DLL_PUBLIC proto_item *
1549 tvbuff_t *tvb,
1550 const int start, int length, const unsigned encoding,
1551 wmem_allocator_t *scope, char **retval, int *lenretval);
1552
1570WS_DLL_PUBLIC proto_item *
1572 tvbuff_t *tvb,
1573 const int start, int length, const unsigned encoding,
1574 wmem_allocator_t *scope, char **retval);
1575
1591WS_DLL_PUBLIC proto_item *
1593 tvbuff_t *tvb,
1594 const int start, int length, const unsigned encoding,
1595 wmem_allocator_t *scope, char **retval);
1596
1605proto_item *
1606proto_tree_add_text_internal(proto_tree *tree, tvbuff_t *tvb, int start, int length, const char *format,
1607 ...) G_GNUC_PRINTF(5,6);
1608
1617proto_item *
1619 int length, const char *format, va_list ap) G_GNUC_PRINTF(5, 0);
1620
1630WS_DLL_PUBLIC proto_tree *
1631proto_tree_add_subtree(proto_tree *tree, tvbuff_t *tvb, int start, int length, int idx,
1632 proto_item **tree_item, const char *text);
1633
1644WS_DLL_PUBLIC proto_tree *
1645proto_tree_add_subtree_format(proto_tree *tree, tvbuff_t *tvb, int start, int length, int idx,
1646 proto_item **tree_item, const char *format, ...) G_GNUC_PRINTF(7,8);
1647
1649proto_item *
1650proto_tree_add_format_text(proto_tree *tree, tvbuff_t *tvb, int start, int length);
1651
1653proto_item *
1654proto_tree_add_format_wsp_text(proto_tree *tree, tvbuff_t *tvb, int start, int length);
1655
1665WS_DLL_PUBLIC proto_item *
1666proto_tree_add_none_format(proto_tree *tree, const int hfindex, tvbuff_t *tvb, const int start,
1667 int length, const char *format, ...) G_GNUC_PRINTF(6,7);
1668
1678WS_DLL_PUBLIC proto_item *
1679proto_tree_add_protocol_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1680 int length, const char *format, ...) G_GNUC_PRINTF(6,7);
1681
1690WS_DLL_PUBLIC proto_item *
1691proto_tree_add_bytes(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1692 int length, const uint8_t* start_ptr);
1693
1704WS_DLL_PUBLIC proto_item *
1705proto_tree_add_bytes_with_length(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1706 int length, const uint8_t *start_ptr, int ptr_length);
1707
1741WS_DLL_PUBLIC proto_item *
1742proto_tree_add_bytes_item(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1743 const int start, int length, const unsigned encoding,
1744 GByteArray *retval, int *endoff, int *err);
1745
1758WS_DLL_PUBLIC proto_item *
1760 int start, int length, const uint8_t* start_ptr, const char *format,
1761 ...) G_GNUC_PRINTF(7,8);
1762
1774WS_DLL_PUBLIC proto_item *
1775proto_tree_add_bytes_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1776 int length, const uint8_t* start_ptr, const char *format, ...) G_GNUC_PRINTF(7,8);
1777
1786WS_DLL_PUBLIC proto_item *
1787proto_tree_add_time(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1788 int length, const nstime_t* value_ptr);
1789
1820WS_DLL_PUBLIC proto_item *
1821proto_tree_add_time_item(proto_tree *tree, int hfindex, tvbuff_t *tvb,
1822 const int start, int length, const unsigned encoding,
1823 nstime_t *retval, int *endoff, int *err);
1824
1825
1838WS_DLL_PUBLIC proto_item *
1840 int start, int length, nstime_t* value_ptr, const char *format, ...)
1841 G_GNUC_PRINTF(7,8);
1842
1855WS_DLL_PUBLIC proto_item *
1856proto_tree_add_time_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1857 int length, nstime_t* value_ptr, const char *format, ...) G_GNUC_PRINTF(7,8);
1858
1867WS_DLL_PUBLIC proto_item *
1868proto_tree_add_ipxnet(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1869 int length, uint32_t value);
1870
1883WS_DLL_PUBLIC proto_item *
1885 int start, int length, uint32_t value, const char *format, ...)
1886 G_GNUC_PRINTF(7,8);
1887
1899WS_DLL_PUBLIC proto_item *
1900proto_tree_add_ipxnet_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1901 int length, uint32_t value, const char *format, ...) G_GNUC_PRINTF(7,8);
1902
1911WS_DLL_PUBLIC proto_item *
1912proto_tree_add_ipv4(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1913 int length, ws_in4_addr value);
1914
1927WS_DLL_PUBLIC proto_item *
1929 int start, int length, ws_in4_addr value, const char *format, ...)
1930 G_GNUC_PRINTF(7,8);
1931
1943WS_DLL_PUBLIC proto_item *
1944proto_tree_add_ipv4_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1945 int length, ws_in4_addr value, const char *format, ...) G_GNUC_PRINTF(7,8);
1946
1955WS_DLL_PUBLIC proto_item *
1956proto_tree_add_ipv6(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1957 int length, const ws_in6_addr *value_ptr);
1958
1971WS_DLL_PUBLIC proto_item *
1973 int start, int length, const ws_in6_addr *value_ptr, const char *format,
1974 ...) G_GNUC_PRINTF(7,8);
1975
1987WS_DLL_PUBLIC proto_item *
1988proto_tree_add_ipv6_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
1989 int length, const ws_in6_addr *value_ptr, const char *format, ...) G_GNUC_PRINTF(7,8);
1990
1999WS_DLL_PUBLIC proto_item *
2000proto_tree_add_ether(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2001 int length, const uint8_t* value);
2002
2015WS_DLL_PUBLIC proto_item *
2017 int start, int length, const uint8_t* value, const char *format, ...)
2018 G_GNUC_PRINTF(7,8);
2019
2031WS_DLL_PUBLIC proto_item *
2032proto_tree_add_ether_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2033 int length, const uint8_t* value, const char *format, ...) G_GNUC_PRINTF(7,8);
2034
2043WS_DLL_PUBLIC proto_item *
2044proto_tree_add_guid(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2045 int length, const e_guid_t *value_ptr);
2046
2059WS_DLL_PUBLIC proto_item *
2061 int start, int length, const e_guid_t *value_ptr, const char *format,
2062 ...) G_GNUC_PRINTF(7,8);
2063
2075WS_DLL_PUBLIC proto_item *
2076proto_tree_add_guid_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2077 int length, const e_guid_t *value_ptr, const char *format, ...) G_GNUC_PRINTF(7,8);
2078
2087WS_DLL_PUBLIC proto_item *
2088proto_tree_add_oid(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2089 int length, const uint8_t* value_ptr);
2090
2103WS_DLL_PUBLIC proto_item *
2105 int start, int length, const uint8_t* value_ptr, const char *format,
2106 ...) G_GNUC_PRINTF(7,8);
2107
2119WS_DLL_PUBLIC proto_item *
2120proto_tree_add_oid_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2121 int length, const uint8_t* value_ptr, const char *format, ...) G_GNUC_PRINTF(7,8);
2122
2142WS_DLL_PUBLIC proto_item *
2143proto_tree_add_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2144 int length, const char* value);
2145
2158WS_DLL_PUBLIC proto_item *
2160 int start, int length, const char* value, const char *format, ...)
2161 G_GNUC_PRINTF(7,8);
2162
2175WS_DLL_PUBLIC proto_item *
2176proto_tree_add_string_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2177 int length, const char* value, const char *format, ...) G_GNUC_PRINTF(7,8);
2178
2187WS_DLL_PUBLIC proto_item *
2188proto_tree_add_boolean(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2189 int length, uint64_t value);
2190
2203WS_DLL_PUBLIC proto_item *
2205 tvbuff_t *tvb, int start, int length, uint64_t value,
2206 const char *format, ...) G_GNUC_PRINTF(7,8);
2207
2219WS_DLL_PUBLIC proto_item *
2220proto_tree_add_boolean_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2221 int length, uint64_t value, const char *format, ...) G_GNUC_PRINTF(7,8);
2222
2231WS_DLL_PUBLIC proto_item *
2232proto_tree_add_float(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2233 int length, float value);
2234
2247WS_DLL_PUBLIC proto_item *
2249 int start, int length, float value, const char *format, ...)
2250 G_GNUC_PRINTF(7,8);
2251
2263WS_DLL_PUBLIC proto_item *
2264proto_tree_add_float_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2265 int length, float value, const char *format, ...) G_GNUC_PRINTF(7,8);
2266
2275WS_DLL_PUBLIC proto_item *
2276proto_tree_add_double(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2277 int length, double value);
2278
2291WS_DLL_PUBLIC proto_item *
2293 int start, int length, double value, const char *format, ...)
2294 G_GNUC_PRINTF(7,8);
2295
2307WS_DLL_PUBLIC proto_item *
2308proto_tree_add_double_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2309 int length, double value, const char *format, ...) G_GNUC_PRINTF(7,8);
2310
2319WS_DLL_PUBLIC proto_item *
2320proto_tree_add_uint(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2321 int length, uint32_t value);
2322
2335WS_DLL_PUBLIC proto_item *
2337 int start, int length, uint32_t value, const char *format, ...)
2338 G_GNUC_PRINTF(7,8);
2339
2352WS_DLL_PUBLIC proto_item *
2353proto_tree_add_uint_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2354 int length, uint32_t value, const char *format, ...) G_GNUC_PRINTF(7,8);
2355
2364WS_DLL_PUBLIC proto_item *
2365proto_tree_add_uint64(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2366 int length, uint64_t value);
2367
2380WS_DLL_PUBLIC proto_item *
2382 int start, int length, uint64_t value, const char *format, ...)
2383 G_GNUC_PRINTF(7,8);
2384
2396WS_DLL_PUBLIC proto_item *
2397proto_tree_add_uint64_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2398 int length, uint64_t value, const char *format, ...) G_GNUC_PRINTF(7,8);
2399
2408WS_DLL_PUBLIC proto_item *
2409proto_tree_add_int(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2410 int length, int32_t value);
2411
2424WS_DLL_PUBLIC proto_item *
2426 int start, int length, int32_t value, const char *format, ...)
2427 G_GNUC_PRINTF(7,8);
2428
2441WS_DLL_PUBLIC proto_item *
2442proto_tree_add_int_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2443 int length, int32_t value, const char *format, ...) G_GNUC_PRINTF(7,8);
2444
2453WS_DLL_PUBLIC proto_item *
2454proto_tree_add_int64(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2455 int length, int64_t value);
2456
2469WS_DLL_PUBLIC proto_item *
2471 int start, int length, int64_t value, const char *format, ...)
2472 G_GNUC_PRINTF(7,8);
2473
2485WS_DLL_PUBLIC proto_item *
2486proto_tree_add_int64_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2487 int length, int64_t value, const char *format, ...) G_GNUC_PRINTF(7,8);
2488
2497WS_DLL_PUBLIC proto_item *
2498proto_tree_add_eui64(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2499 int length, const uint64_t value);
2500
2513WS_DLL_PUBLIC proto_item *
2515 int start, int length, const uint64_t value, const char *format, ...)
2516 G_GNUC_PRINTF(7,8);
2517
2529WS_DLL_PUBLIC proto_item *
2530proto_tree_add_eui64_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start,
2531 int length, const uint64_t value, const char *format, ...) G_GNUC_PRINTF(7,8);
2532
2534typedef struct _mac_hf_list_t {
2535 int *hf_addr; // FT_ETHER, BASE_NONE
2536 int *hf_addr_resolved; // FT_STRING, BASE_NONE
2537 int *hf_oui; // FT_UINT24, BASE_OUI
2538 int *hf_oui_resolved; // FT_STRING, BASE_NONE
2539 int *hf_lg; // FT_BOOLEAN, 24 bits, mask 0x020000
2540 int *hf_ig; // FT_BOOLEAN, 24 bits, mask 0x010000
2542
2552WS_DLL_PUBLIC proto_item *
2553proto_tree_add_mac48_detail(const mac_hf_list_t *list_specific,
2554 const mac_hf_list_t *list_generic,
2555 int idx, tvbuff_t *tvb, proto_tree *tree, int offset);
2556
2563WS_DLL_PUBLIC proto_item *
2564proto_tree_add_debug_text(proto_tree *tree, const char *format,
2565 ...) G_GNUC_PRINTF(2,3);
2566
2572WS_DLL_PUBLIC void
2573proto_item_fill_label(const field_info *finfo, char *label_str, size_t *value_offset);
2574
2582WS_DLL_PUBLIC int
2583proto_item_fill_display_label(const field_info *fi, char *display_label_str, const int label_str_size);
2584
2590WS_DLL_PUBLIC int
2591proto_register_protocol(const char *name, const char *short_name, const char *filter_name);
2592
2607WS_DLL_PUBLIC int
2608proto_register_protocol_in_name_only(const char *name, const char *short_name, const char *filter_name,
2609 int parent_proto, enum ftenum field_type);
2610
2616bool
2617proto_deregister_protocol(const char *short_name);
2618
2623WS_DLL_PUBLIC void
2624proto_register_alias(const int proto_id, const char *alias_name);
2625
2630typedef void (*prefix_initializer_t)(const char* match);
2631
2639WS_DLL_PUBLIC void
2640proto_register_prefix(const char *prefix, prefix_initializer_t initializer);
2641
2643WS_DLL_PUBLIC void proto_initialize_all_prefixes(void);
2644
2649WS_DLL_PUBLIC void
2650proto_register_field_array(const int parent, hf_register_info *hf, const int num_records);
2651
2655WS_DLL_PUBLIC void
2656proto_deregister_field (const int parent, int hf_id);
2657
2660WS_DLL_PUBLIC void
2661proto_add_deregistered_data (void *data);
2662
2667WS_DLL_PUBLIC void
2668proto_deregister_all_fields_with_prefix(const int parent, const gchar *prefix);
2669
2673void
2674proto_add_deregistered_slice (size_t block_size, void *mem_block);
2675
2680WS_DLL_PUBLIC void
2681proto_free_field_strings (ftenum_t field_type, unsigned int field_display, const void *field_strings);
2682
2689WS_DLL_PUBLIC void
2691
2695WS_DLL_PUBLIC void
2696proto_register_subtree_array(int * const *indices, const int num_indices);
2697
2701WS_DLL_PUBLIC const char* proto_registrar_get_name(const int n);
2702
2706WS_DLL_PUBLIC const char* proto_registrar_get_abbrev(const int n);
2707
2711WS_DLL_PUBLIC header_field_info* proto_registrar_get_nth(unsigned hfindex);
2712
2716WS_DLL_PUBLIC header_field_info* proto_registrar_get_byname(const char *field_name);
2717
2721WS_DLL_PUBLIC header_field_info* proto_registrar_get_byalias(const char *alias_name);
2722
2726WS_DLL_PUBLIC int proto_registrar_get_id_byname(const char *field_name);
2727
2731WS_DLL_PUBLIC enum ftenum proto_registrar_get_ftype(const int n);
2732
2736WS_DLL_PUBLIC int proto_registrar_get_parent(const int n);
2737
2741WS_DLL_PUBLIC bool proto_registrar_is_protocol(const int n);
2742
2746extern int proto_registrar_get_length(const int n);
2747
2748
2752WS_DLL_PUBLIC int proto_get_first_protocol(void **cookie);
2753WS_DLL_PUBLIC int proto_get_data_protocol(void *cookie);
2754WS_DLL_PUBLIC int proto_get_next_protocol(void **cookie);
2755WS_DLL_PUBLIC header_field_info *proto_get_first_protocol_field(const int proto_id, void **cookie);
2756WS_DLL_PUBLIC header_field_info *proto_get_next_protocol_field(const int proto_id, void **cookie);
2757
2761WS_DLL_PUBLIC bool proto_name_already_registered(const char *name);
2762
2766WS_DLL_PUBLIC int proto_get_id_by_filter_name(const char* filter_name);
2767
2771WS_DLL_PUBLIC int proto_get_id_by_short_name(const char* short_name);
2772
2776WS_DLL_PUBLIC bool proto_can_toggle_protocol(const int proto_id);
2777
2780WS_DLL_PUBLIC protocol_t *find_protocol_by_id(const int proto_id);
2781
2785WS_DLL_PUBLIC const char *proto_get_protocol_name(const int proto_id);
2786
2789WS_DLL_PUBLIC int proto_get_id(const protocol_t *protocol);
2790
2793WS_DLL_PUBLIC const char *proto_get_protocol_short_name(const protocol_t *protocol);
2794
2797WS_DLL_PUBLIC const char *proto_get_protocol_long_name(const protocol_t *protocol);
2798
2801WS_DLL_PUBLIC bool proto_is_protocol_enabled(const protocol_t *protocol);
2802
2805WS_DLL_PUBLIC bool proto_is_protocol_enabled_by_default(const protocol_t *protocol);
2806
2809WS_DLL_PUBLIC bool proto_is_pino(const protocol_t *protocol);
2810
2814WS_DLL_PUBLIC const char *proto_get_protocol_filter_name(const int proto_id);
2815
2821extern void proto_add_heuristic_dissector(protocol_t *protocol, const char *short_name);
2822
2828WS_DLL_PUBLIC void proto_heuristic_dissector_foreach(const protocol_t *protocol, GFunc func,
2829 void *user_data);
2830
2848WS_DLL_PUBLIC void proto_get_frame_protocols(const wmem_list_t *layers,
2849 bool *is_ip, bool *is_tcp, bool *is_udp, bool *is_sctp,
2850 bool *is_tls, bool *is_rtp, bool *is_lte_rlc);
2851
2857WS_DLL_PUBLIC bool proto_is_frame_protocol(const wmem_list_t *layers, const char* proto_name);
2858
2863WS_DLL_PUBLIC char * proto_list_layers(const packet_info *pinfo);
2864
2872WS_DLL_PUBLIC uint8_t proto_get_layer_num(const packet_info *pinfo, const int proto_id);
2873
2876WS_DLL_PUBLIC void proto_disable_by_default(const int proto_id);
2877
2881WS_DLL_PUBLIC void proto_set_decoding(const int proto_id, const bool enabled);
2882
2884WS_DLL_PUBLIC void proto_disable_all(void);
2885
2887WS_DLL_PUBLIC void proto_reenable_all(void);
2888
2891WS_DLL_PUBLIC void proto_set_cant_toggle(const int proto_id);
2892
2898extern bool proto_check_for_protocol_or_field(const proto_tree* tree, const int id);
2899
2908WS_DLL_PUBLIC GPtrArray* proto_get_finfo_ptr_array(const proto_tree *tree, const int hfindex);
2909
2914WS_DLL_PUBLIC bool proto_tracking_interesting_fields(const proto_tree *tree);
2915
2925WS_DLL_PUBLIC GPtrArray* proto_find_finfo(proto_tree *tree, const int hfindex);
2926
2936WS_DLL_PUBLIC GPtrArray* proto_find_first_finfo(proto_tree *tree, const int hfindex);
2937
2945WS_DLL_PUBLIC GPtrArray* proto_all_finfos(proto_tree *tree);
2946
2948WS_DLL_PUBLIC void proto_registrar_dump_protocols(void);
2949
2951WS_DLL_PUBLIC void proto_registrar_dump_values(void);
2952
2954WS_DLL_PUBLIC void proto_registrar_dump_elastic(const char* filter);
2955
2958WS_DLL_PUBLIC bool proto_registrar_dump_fieldcount(void);
2959
2961WS_DLL_PUBLIC void proto_registrar_dump_fields(void);
2962
2964WS_DLL_PUBLIC bool proto_registrar_dump_field_completions(const char *prefix);
2965
2967WS_DLL_PUBLIC void proto_registrar_dump_ftypes(void);
2968
2972WS_DLL_PUBLIC const char* proto_field_display_to_string(int field_display);
2973
2976WS_DLL_PUBLIC int num_tree_types;
2977
2979WS_DLL_PUBLIC bool tree_expanded(int tree_type);
2980
2982WS_DLL_PUBLIC void tree_expanded_set(int tree_type, bool value);
2983
2984WS_DLL_PUBLIC int
2985hfinfo_bitshift(const header_field_info *hfinfo);
2986
2987struct epan_dissect;
2988
2993WS_DLL_PUBLIC bool
2994proto_can_match_selected(const field_info *finfo, struct epan_dissect *edt);
2995
3000WS_DLL_PUBLIC char*
3002
3008WS_DLL_PUBLIC field_info*
3009proto_find_field_from_offset(proto_tree *tree, unsigned offset, tvbuff_t *tvb);
3010
3015WS_DLL_PUBLIC char*
3016proto_find_undecoded_data(proto_tree *tree, unsigned length);
3017
3037WS_DLL_PUBLIC proto_item *
3038proto_tree_add_bitmask(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3039 const int hf_hdr, const int ett, int * const *fields, const unsigned encoding);
3040
3063WS_DLL_PUBLIC proto_item *
3064proto_tree_add_bitmask_ret_uint64(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3065 const int hf_hdr, const int ett, int * const *fields,
3066 const unsigned encoding, uint64_t *retval);
3067
3091WS_DLL_PUBLIC proto_item *
3092proto_tree_add_bitmask_with_flags(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3093 const int hf_hdr, const int ett, int * const *fields, const unsigned encoding, const int flags);
3094
3121WS_DLL_PUBLIC proto_item *
3122proto_tree_add_bitmask_with_flags_ret_uint64(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3123 const int hf_hdr, const int ett, int * const *fields,
3124 const unsigned encoding, const int flags, uint64_t *retval);
3125
3145WS_DLL_PUBLIC proto_item *
3146proto_tree_add_bitmask_value(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3147 const int hf_hdr, const int ett, int * const *fields, const uint64_t value);
3148
3172WS_DLL_PUBLIC proto_item *
3173proto_tree_add_bitmask_value_with_flags(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3174 const int hf_hdr, const int ett, int * const *fields, const uint64_t value, const int flags);
3175
3190WS_DLL_PUBLIC void
3191proto_tree_add_bitmask_list(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3192 const int len, int * const *fields, const unsigned encoding);
3193
3209WS_DLL_PUBLIC void
3210proto_tree_add_bitmask_list_ret_uint64(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3211 const int len, int * const *fields, const unsigned encoding, uint64_t *retval);
3212
3227WS_DLL_PUBLIC void
3228proto_tree_add_bitmask_list_value(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3229 const int len, int * const *fields, const uint64_t value);
3230
3231
3253WS_DLL_PUBLIC proto_item *
3254proto_tree_add_bitmask_len(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const unsigned len,
3255 const int hf_hdr, const int ett, int * const *fields, struct expert_field* exp, const unsigned encoding);
3256
3269WS_DLL_PUBLIC proto_item *
3270proto_tree_add_bitmask_text(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const unsigned len,
3271 const char *name, const char *fallback,
3272 const int ett, int * const *fields, const unsigned encoding, const int flags);
3273
3274#define BMT_NO_FLAGS 0x00
3275#define BMT_NO_APPEND 0x01
3276#define BMT_NO_INT 0x02
3277#define BMT_NO_FALSE 0x04
3278#define BMT_NO_TFS 0x08
3289WS_DLL_PUBLIC proto_item *
3290proto_tree_add_bits_item(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset,
3291 const int no_of_bits, const unsigned encoding);
3292
3308WS_DLL_PUBLIC proto_item *
3309proto_tree_add_split_bits_item_ret_val(proto_tree *tree, const int hf_index, tvbuff_t *tvb,
3310 const unsigned bit_offset, const crumb_spec_t *crumb_spec, uint64_t *return_value);
3311
3325void
3326proto_tree_add_split_bits_crumb(proto_tree *tree, const int hf_index, tvbuff_t *tvb,
3327 const unsigned bit_offset, const crumb_spec_t *crumb_spec, uint16_t crumb_index);
3328
3339WS_DLL_PUBLIC proto_item *
3340proto_tree_add_bits_ret_val(proto_tree *tree, const int hf_index, tvbuff_t *tvb,
3341 const unsigned bit_offset, const int no_of_bits, uint64_t *return_value, const unsigned encoding);
3342
3355WS_DLL_PUBLIC proto_item *
3357 const unsigned bit_offset, const int no_of_bits, uint32_t value, const unsigned encoding,
3358 const char *format, ...)
3359 G_GNUC_PRINTF(8,9);
3360
3373WS_DLL_PUBLIC proto_item *
3375 const unsigned bit_offset, const int no_of_bits, uint64_t value, const unsigned encoding,
3376 const char *format, ...)
3377 G_GNUC_PRINTF(8,9);
3378
3392proto_item *
3394 const unsigned bit_offset, const int no_of_bits, uint64_t value, const unsigned encoding,
3395 const char *format, ...)
3396 G_GNUC_PRINTF(8,9);
3397
3411proto_item *
3413 const unsigned bit_offset, const int no_of_bits, int32_t value, const unsigned encoding,
3414 const char *format, ...)
3415 G_GNUC_PRINTF(8,9);
3416
3430proto_item *
3432 const unsigned bit_offset, const int no_of_bits, int64_t value, const unsigned encoding,
3433 const char *format, ...)
3434 G_GNUC_PRINTF(8,9);
3435
3449proto_item *
3451 const unsigned bit_offset, const int no_of_bits, float value, const unsigned encoding,
3452 const char *format, ...)
3453 G_GNUC_PRINTF(8,9);
3454
3455
3464WS_DLL_PUBLIC proto_item *
3466 const unsigned bit_offset, const int no_of_chars);
3467
3475WS_DLL_PUBLIC proto_item *
3476proto_tree_add_ascii_7bits_item(proto_tree *tree, const int hfindex, tvbuff_t *tvb,
3477 const unsigned bit_offset, const int no_of_chars);
3478
3496WS_DLL_PUBLIC proto_item *
3497proto_tree_add_checksum(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3498 const int hf_checksum, const int hf_checksum_status, struct expert_field* bad_checksum_expert,
3499 packet_info *pinfo, uint32_t computed_checksum, const unsigned encoding, const unsigned flags);
3500
3518WS_DLL_PUBLIC proto_item*
3519proto_tree_add_checksum_bytes(proto_tree *tree, tvbuff_t *tvb, const unsigned offset,
3520 const int hf_checksum, const int hf_checksum_status, struct expert_field* bad_checksum_expert,
3521 packet_info *pinfo, const uint8_t *computed_checksum, size_t checksum_len, const unsigned flags);
3522
3523typedef enum
3524{
3525 PROTO_CHECKSUM_E_BAD = 0,
3526 PROTO_CHECKSUM_E_GOOD,
3527 PROTO_CHECKSUM_E_UNVERIFIED,
3528 PROTO_CHECKSUM_E_NOT_PRESENT,
3529 PROTO_CHECKSUM_E_ILLEGAL
3530} proto_checksum_enum_e;
3531
3532#define PROTO_CHECKSUM_NO_FLAGS 0x00
3533#define PROTO_CHECKSUM_VERIFY 0x01
3534#define PROTO_CHECKSUM_GENERATED 0x02
3535#define PROTO_CHECKSUM_IN_CKSUM 0x04
3536#define PROTO_CHECKSUM_ZERO 0x08
3537#define PROTO_CHECKSUM_NOT_PRESENT 0x10
3539WS_DLL_PUBLIC const value_string proto_checksum_vals[];
3540
3544WS_DLL_PUBLIC unsigned char
3545proto_check_field_name(const char *field_name);
3546
3551WS_DLL_PUBLIC unsigned char
3552proto_check_field_name_lower(const char *field_name);
3553
3554
3563const char *
3564proto_custom_set(proto_tree* tree, GSList *field_id,
3565 int occurrence,
3566 bool display_details,
3567 char *result,
3568 char *expr, const int size );
3569
3575char *
3576proto_custom_get_filter(struct epan_dissect *edt, GSList *field_id, int occurrence);
3577
3580const char *
3581hfinfo_char_value_format_display(int display, char buf[7], uint32_t value);
3582
3583#ifdef __cplusplus
3584}
3585#endif /* __cplusplus */
3586
3587#endif /* proto.h */
3588
3589/*
3590 * Editor modelines - https://www.wireshark.org/tools/modelines.html
3591 *
3592 * Local variables:
3593 * c-basic-offset: 4
3594 * tab-width: 8
3595 * indent-tabs-mode: nil
3596 * End:
3597 *
3598 * vi: set shiftwidth=4 tabstop=8 expandtab:
3599 * :indentSize=4:tabSize=8:noTabs=true:
3600 */
WS_DLL_PUBLIC bool proto_registrar_dump_fieldcount(void)
Definition proto.c:11888
WS_DLL_PUBLIC unsigned char proto_check_field_name_lower(const char *field_name)
Definition proto.c:14168
WS_DLL_PUBLIC int hf_text_only
Definition proto.h:48
WS_DLL_PUBLIC void proto_tree_add_bitmask_list_ret_uint64(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int len, int *const *fields, const unsigned encoding, uint64_t *retval)
Definition proto.c:13071
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_eui64(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint64_t value)
Definition proto.c:6178
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask_value(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_hdr, const int ett, int *const *fields, const uint64_t value)
Definition proto.c:13021
#define ITEM_LABEL_LENGTH
Definition proto.h:51
WS_DLL_PUBLIC proto_item * proto_tree_add_string_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const char *value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC const char * proto_get_protocol_name(const int proto_id)
Definition proto.c:8529
WS_DLL_PUBLIC void proto_get_frame_protocols(const wmem_list_t *layers, bool *is_ip, bool *is_tcp, bool *is_udp, bool *is_sctp, bool *is_tls, bool *is_rtp, bool *is_lte_rlc)
Definition proto.c:8590
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_oid_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *value_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC bool proto_is_protocol_enabled(const protocol_t *protocol)
Definition proto.c:8698
struct _item_label_t item_label_t
WS_DLL_PUBLIC proto_item * proto_tree_add_int_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, int32_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ether_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ipv4_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, ws_in4_addr value, const char *format,...) G_GNUC_PRINTF(7
proto_item * proto_tree_add_format_wsp_text(proto_tree *tree, tvbuff_t *tvb, int start, int length)
Definition proto.c:1538
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_eui64_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint64_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item * proto_tree_add_time_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, nstime_t *value_ptr, const char *format,...) G_GNUC_PRINTF(7
#define FI_URL
Definition proto.h:861
WS_DLL_PUBLIC bool proto_field_is_referenced(proto_tree *tree, int proto_id)
Definition proto.c:910
WS_DLL_PUBLIC void proto_register_subtree_array(int *const *indices, const int num_indices)
Definition proto.c:9863
WS_DLL_PUBLIC proto_item * proto_tree_add_bits_item(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, const unsigned encoding)
Definition proto.c:13184
WS_DLL_PUBLIC bool tree_expanded(int tree_type)
Definition proto.c:14174
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item proto_item proto_item proto_item proto_item * proto_tree_add_float_bits_format_value(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, float value, const unsigned encoding, const char *format,...) G_GNUC_PRINTF(8
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_bytes(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *start_ptr)
Definition proto.c:4732
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_int(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, int32_t *retval)
Definition proto.c:3225
WS_DLL_PUBLIC proto_item * proto_tree_add_bytes_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *start_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item * proto_tree_add_bits_ret_val(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, uint64_t *return_value, const unsigned encoding)
Definition proto.c:13569
WS_DLL_PUBLIC proto_item * proto_tree_add_item_new_ret_length(proto_tree *tree, header_field_info *hfinfo, tvbuff_t *tvb, const int start, int length, const unsigned encoding, int *lenretval)
Definition proto.c:4359
WS_DLL_PUBLIC proto_item * proto_tree_add_split_bits_item_ret_val(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const crumb_spec_t *crumb_spec, uint64_t *return_value)
Definition proto.c:13361
WS_DLL_PUBLIC char * proto_list_layers(const packet_info *pinfo)
Definition proto.c:8655
WS_DLL_PUBLIC void proto_deregister_field(const int parent, int hf_id)
Definition proto.c:8862
void proto_tree_prime_with_hfid(proto_tree *tree, const int hfid)
void proto_add_deregistered_slice(size_t block_size, void *mem_block)
Definition proto.c:8925
WS_DLL_PUBLIC int proto_item_get_len(const proto_item *pi)
Definition proto.c:7895
WS_DLL_PUBLIC int proto_get_id_by_short_name(const char *short_name)
Definition proto.c:8515
WS_DLL_PUBLIC proto_item * proto_tree_add_checksum(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_checksum, const int hf_checksum_status, struct expert_field *bad_checksum_expert, packet_info *pinfo, uint32_t computed_checksum, const unsigned encoding, const unsigned flags)
Definition proto.c:13964
WS_DLL_PUBLIC void proto_tree_add_bitmask_list_value(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int len, int *const *fields, const uint64_t value)
Definition proto.c:13087
WS_DLL_PUBLIC proto_item * proto_tree_add_boolean_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint64_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_oid(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *value_ptr)
Definition proto.c:5223
WS_DLL_PUBLIC bool proto_is_pino(const protocol_t *protocol)
Definition proto.c:8691
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_uint(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint32_t value)
Definition proto.c:5803
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_bytes_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *start_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_int_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, int32_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const char *value)
Definition proto.c:5326
WS_DLL_PUBLIC proto_item * proto_tree_add_bytes_item(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, GByteArray *retval, int *endoff, int *err)
Definition proto.c:4427
int proto_registrar_get_length(const int n)
Definition proto.c:11351
WS_DLL_PUBLIC const char * proto_registrar_get_name(const int n)
Definition proto.c:11302
WS_DLL_PUBLIC void proto_registrar_dump_elastic(const char *filter)
Definition proto.c:12007
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_float_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, float value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC void proto_item_fill_label(const field_info *finfo, char *label_str, size_t *value_offset)
Definition proto.c:10013
WS_DLL_PUBLIC void proto_set_decoding(const int proto_id, const bool enabled)
Definition proto.c:8748
WS_DLL_PUBLIC bool proto_name_already_registered(const char *name)
Definition proto.c:8491
WS_DLL_PUBLIC void proto_register_field_array(const int parent, hf_register_info *hf, const int num_records)
Definition proto.c:8828
WS_DLL_PUBLIC GPtrArray * proto_find_first_finfo(proto_tree *tree, const int hfindex)
Definition proto.c:11470
WS_DLL_PUBLIC const char * proto_get_protocol_filter_name(const int proto_id)
Definition proto.c:8557
hf_ref_type
Definition proto.h:756
WS_DLL_PUBLIC void WS_DLL_PUBLIC void proto_item_append_text(proto_item *pi, const char *format,...) G_GNUC_PRINTF(2
WS_DLL_PUBLIC proto_item * proto_tree_add_float_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, float value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_double_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, double value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC const char * proto_get_protocol_long_name(const protocol_t *protocol)
Definition proto.c:8549
WS_DLL_PUBLIC proto_item * proto_tree_add_ether_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC enum ftenum proto_registrar_get_ftype(const int n)
Definition proto.c:11320
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_guid_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const e_guid_t *value_ptr, const char *format,...) G_GNUC_PRINTF(7
#define FI_RESET_FLAG(fi, flag)
Definition proto.h:884
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_string_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const char *value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC void proto_initialize_all_prefixes(void)
Definition proto.c:1009
WS_DLL_PUBLIC proto_item * proto_item_get_parent(const proto_item *pi)
Definition proto.c:8057
WS_DLL_PUBLIC int proto_registrar_get_id_byname(const char *field_name)
Definition proto.c:1093
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_display_string_and_length(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, wmem_allocator_t *scope, char **retval, int *lenretval)
Definition proto.c:4112
WS_DLL_PUBLIC header_field_info * proto_registrar_get_byalias(const char *alias_name)
Definition proto.c:1062
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_float(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, float *retval)
Parse a float from the buffer and add it to the tree, returning the item added and the parsed value v...
Definition proto.c:3822
WS_DLL_PUBLIC GPtrArray * proto_all_finfos(proto_tree *tree)
Definition proto.c:11500
WS_DLL_PUBLIC void proto_tree_set_appendix(proto_tree *tree, tvbuff_t *tvb, int start, const int length)
Definition proto.c:8154
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_float(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, float value)
Definition proto.c:5673
WS_DLL_PUBLIC void proto_heuristic_dissector_foreach(const protocol_t *protocol, GFunc func, void *user_data)
Definition proto.c:8581
WS_DLL_PUBLIC proto_item * proto_tree_add_ipxnet_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint32_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_tree * proto_tree_get_parent_tree(proto_tree *tree)
Definition proto.c:8084
WS_DLL_PUBLIC int proto_register_protocol_in_name_only(const char *name, const char *short_name, const char *filter_name, int parent_proto, enum ftenum field_type)
Definition proto.c:8289
struct _proto_node proto_node
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_time_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, nstime_t *value_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC char * proto_construct_match_selected_string(const field_info *finfo, struct epan_dissect *edt)
Definition proto.c:12534
WS_DLL_PUBLIC const char * proto_get_protocol_short_name(const protocol_t *protocol)
Definition proto.c:8541
WS_DLL_PUBLIC char * proto_find_undecoded_data(proto_tree *tree, unsigned length)
Definition proto.c:11586
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_int64(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, int64_t value)
Definition proto.c:6083
WS_DLL_PUBLIC int proto_item_fill_display_label(const field_info *fi, char *display_label_str, const int label_str_size)
Definition proto.c:7017
WS_DLL_PUBLIC bool proto_is_protocol_enabled_by_default(const protocol_t *protocol)
Definition proto.c:8712
WS_DLL_PUBLIC field_info * proto_find_field_from_offset(proto_tree *tree, unsigned offset, tvbuff_t *tvb)
Definition proto.c:11547
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ipxnet_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint32_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC void proto_registrar_dump_values(void)
Definition proto.c:11673
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_guid(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const e_guid_t *value_ptr)
Definition proto.c:5146
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask_len(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const unsigned len, const int hf_hdr, const int ett, int *const *fields, struct expert_field *exp, const unsigned encoding)
Definition proto.c:13109
WS_DLL_PUBLIC void tree_expanded_set(int tree_type, bool value)
Definition proto.c:14184
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_double(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, double *retval)
Parse a double from the buffer and add it to the tree, returning the item added and the parsed value ...
Definition proto.c:3861
WS_DLL_PUBLIC void proto_item_set_bits_offset_len(proto_item *ti, int bits_offset, int bits_len)
Definition proto.c:7906
proto_item proto_item WS_DLL_PUBLIC proto_tree * proto_tree_add_subtree(proto_tree *tree, tvbuff_t *tvb, int start, int length, int idx, proto_item **tree_item, const char *text)
Definition proto.c:1468
#define FI_GET_FLAG(fi, flag)
Definition proto.h:876
void proto_tree_add_split_bits_crumb(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const crumb_spec_t *crumb_spec, uint16_t crumb_index)
Definition proto.c:13539
WS_DLL_PUBLIC uint8_t proto_get_layer_num(const packet_info *pinfo, const int proto_id)
Definition proto.c:8678
proto_node proto_item
Definition proto.h:919
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item struct _mac_hf_list_t mac_hf_list_t
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ipxnet(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint32_t value)
Definition proto.c:4923
WS_DLL_PUBLIC proto_item * proto_tree_add_oid_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *value_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC int proto_registrar_get_parent(const int n)
Definition proto.c:11329
WS_DLL_PUBLIC proto_item * proto_tree_add_uint64_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint64_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_tree * proto_item_add_subtree(proto_item *pi, const int idx) G_GNUC_WARN_UNUSED_RESULT
Definition proto.c:8027
proto_item * proto_tree_add_text_internal(proto_tree *tree, tvbuff_t *tvb, int start, int length, const char *format,...) G_GNUC_PRINTF(5
WS_DLL_PUBLIC proto_item * proto_tree_add_double_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, double value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item proto_item proto_item * proto_tree_add_int_bits_format_value(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, int32_t value, const unsigned encoding, const char *format,...) G_GNUC_PRINTF(8
WS_DLL_PUBLIC proto_item * proto_tree_add_uint_bits_format_value(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, uint32_t value, const unsigned encoding, const char *format,...) G_GNUC_PRINTF(8
WS_DLL_PUBLIC proto_item * proto_tree_add_mac48_detail(const mac_hf_list_t *list_specific, const mac_hf_list_t *list_generic, int idx, tvbuff_t *tvb, proto_tree *tree, int offset)
Definition proto.c:6255
WS_DLL_PUBLIC header_field_info * proto_registrar_get_nth(unsigned hfindex)
Definition proto.c:934
#define FI_HIDDEN
Definition proto.h:856
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_ether(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, uint8_t *retval)
Parse an ethernet address from the buffer and add it to the tree, writing the value to the pointer sp...
Definition proto.c:3992
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ipv4(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, ws_in4_addr value)
Definition proto.c:4988
WS_DLL_PUBLIC proto_item * proto_item_get_parent_nth(proto_item *pi, int gen)
Definition proto.c:8064
WS_DLL_PUBLIC unsigned char proto_check_field_name(const char *field_name)
Definition proto.c:14162
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_double(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, double value)
Definition proto.c:5738
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ipv6(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const ws_in6_addr *value_ptr)
Definition proto.c:5055
WS_DLL_PUBLIC proto_item * proto_tree_add_uint_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint32_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC GPtrArray * proto_get_finfo_ptr_array(const proto_tree *tree, const int hfindex)
Definition proto.c:11380
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item proto_item proto_item proto_item proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ts_23_038_7bits_packed_item(proto_tree *tree, const int hfindex, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_chars)
Definition proto.c:13898
void proto_tree_set_fake_protocols(proto_tree *tree, bool fake_protocols)
Definition proto.c:896
void proto_tree_prime_with_hfid_print(proto_tree *tree, const int hfid)
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask_with_flags_ret_uint64(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_hdr, const int ett, int *const *fields, const unsigned encoding, const int flags, uint64_t *retval)
Definition proto.c:12961
bool proto_deregister_protocol(const char *short_name)
Definition proto.c:8348
WS_DLL_PUBLIC proto_item * proto_tree_add_guid_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const e_guid_t *value_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC bool proto_is_frame_protocol(const wmem_list_t *layers, const char *proto_name)
Definition proto.c:8630
WS_DLL_PUBLIC void proto_add_deregistered_data(void *data)
Definition proto.c:8919
field_display_e
Definition proto.h:683
WS_DLL_PUBLIC const char * proto_registrar_get_abbrev(const int n)
Definition proto.c:11311
void(* prefix_initializer_t)(const char *match)
Definition proto.h:2630
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item proto_item proto_item proto_item * proto_tree_add_int64_bits_format_value(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, int64_t value, const unsigned encoding, const char *format,...) G_GNUC_PRINTF(8
proto_item proto_item * proto_tree_add_text_valist_internal(proto_tree *tree, tvbuff_t *tvb, int start, int length, const char *format, va_list ap) G_GNUC_PRINTF(5
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item proto_item * proto_tree_add_boolean_bits_format_value(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, uint64_t value, const unsigned encoding, const char *format,...) G_GNUC_PRINTF(8
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_int(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, int32_t value)
Definition proto.c:5988
WS_DLL_PUBLIC bool proto_tree_set_visible(proto_tree *tree, bool visible)
Definition proto.c:886
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_int64_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, int64_t value, const char *format,...) G_GNUC_PRINTF(7
void proto_cleanup(void)
Definition proto.c:738
WS_DLL_PUBLIC proto_item * proto_tree_add_time_item(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, nstime_t *retval, int *endoff, int *err)
Definition proto.c:4566
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ipv6_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const ws_in6_addr *value_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC WS_NORETURN void proto_report_dissector_bug(const char *format,...) G_GNUC_PRINTF(1
WS_DLL_PUBLIC int proto_get_id_by_filter_name(const char *filter_name)
Definition proto.c:8501
void proto_add_heuristic_dissector(protocol_t *protocol, const char *short_name)
Definition proto.c:8567
WS_DLL_PUBLIC proto_tree * proto_item_get_subtree(proto_item *pi)
Definition proto.c:8045
WS_DLL_PUBLIC void proto_tree_free(proto_tree *tree)
Definition proto.c:860
WS_DLL_PUBLIC void proto_registrar_dump_fields(void)
Definition proto.c:12167
WS_DLL_PUBLIC int proto_get_first_protocol(void **cookie)
Definition proto.c:8408
WS_DLL_PUBLIC void WS_DLL_PUBLIC void WS_DLL_PUBLIC void WS_DLL_PUBLIC void proto_item_set_len(proto_item *pi, const int length)
Definition proto.c:7853
WS_DLL_PUBLIC proto_item * proto_tree_add_none_format(proto_tree *tree, const int hfindex, tvbuff_t *tvb, const int start, int length, const char *format,...) G_GNUC_PRINTF(6
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_hdr, const int ett, int *const *fields, const unsigned encoding)
Definition proto.c:12949
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask_value_with_flags(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_hdr, const int ett, int *const *fields, const uint64_t value, const int flags)
Definition proto.c:13030
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_time_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, wmem_allocator_t *scope, char **retval)
Definition proto.c:4240
WS_DLL_PUBLIC void proto_tree_move_item(proto_tree *tree, proto_item *fixed_item, proto_item *item_to_move)
Definition proto.c:8107
WS_DLL_PUBLIC proto_item * proto_tree_add_ascii_7bits_item(proto_tree *tree, const int hfindex, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_chars)
Definition proto.c:13926
proto_node proto_tree
Definition proto.h:917
WS_DLL_PUBLIC char * proto_item_get_display_repr(wmem_allocator_t *scope, proto_item *pi)
Definition proto.c:7915
WS_DLL_PUBLIC bool proto_can_match_selected(const field_info *finfo, struct epan_dissect *edt)
Definition proto.c:12522
WS_DLL_PUBLIC GPtrArray * proto_find_finfo(proto_tree *tree, const int hfindex)
Definition proto.c:11451
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_uint64_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint64_t value, const char *format,...) G_GNUC_PRINTF(7
proto_tree * proto_tree_create_root(struct _packet_info *pinfo)
Definition proto.c:7929
WS_DLL_PUBLIC void proto_disable_by_default(const int proto_id)
Definition proto.c:8736
WS_DLL_PUBLIC void proto_item_set_text(proto_item *pi, const char *format,...) G_GNUC_PRINTF(2
WS_DLL_PUBLIC proto_item * proto_tree_add_debug_text(proto_tree *tree, const char *format,...) G_GNUC_PRINTF(2
WS_DLL_PUBLIC proto_item * proto_tree_add_bytes_with_length(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *start_ptr, int ptr_length)
Definition proto.c:4757
WS_DLL_PUBLIC void WS_DLL_PUBLIC void WS_DLL_PUBLIC void proto_item_prepend_text(proto_item *pi, const char *format,...) G_GNUC_PRINTF(2
WS_DLL_PUBLIC proto_item * proto_tree_add_item_new(proto_tree *tree, header_field_info *hfinfo, tvbuff_t *tvb, const int start, int length, const unsigned encoding)
Definition proto.c:4324
WS_DLL_PUBLIC proto_item * proto_tree_add_int64_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, int64_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC void proto_tree_add_bitmask_list(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int len, int *const *fields, const unsigned encoding)
Definition proto.c:13058
WS_DLL_PUBLIC proto_item * proto_tree_get_parent(proto_tree *tree)
Definition proto.c:8077
WS_DLL_PUBLIC void proto_register_plugin(const proto_plugin *plugin)
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_string_and_length(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, wmem_allocator_t *scope, const uint8_t **retval, int *lenretval)
Definition proto.c:4031
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_boolean_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint64_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_display_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, wmem_allocator_t *scope, char **retval)
Definition proto.c:4228
WS_DLL_PUBLIC proto_tree * proto_tree_add_subtree_format(proto_tree *tree, tvbuff_t *tvb, int start, int length, int idx, proto_item **tree_item, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC void proto_set_cant_toggle(const int proto_id)
Definition proto.c:8807
WS_DLL_PUBLIC bool proto_tracking_interesting_fields(const proto_tree *tree)
Definition proto.c:11393
WS_DLL_PUBLIC void proto_register_prefix(const char *prefix, prefix_initializer_t initializer)
Definition proto.c:992
WS_DLL_PUBLIC int proto_register_protocol(const char *name, const char *short_name, const char *filter_name)
Definition proto.c:8219
WS_DLL_PUBLIC void proto_registrar_dump_protocols(void)
Definition proto.c:11610
WS_DLL_PUBLIC proto_item * proto_tree_add_checksum_bytes(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_checksum, const int hf_checksum_status, struct expert_field *bad_checksum_expert, packet_info *pinfo, const uint8_t *computed_checksum, size_t checksum_len, const unsigned flags)
Definition proto.c:14069
const char * proto_custom_set(proto_tree *tree, GSList *field_id, int occurrence, bool display_details, char *result, char *expr, const int size)
Definition proto.c:7300
bool proto_check_for_protocol_or_field(const proto_tree *tree, const int id)
Definition proto.c:11362
WS_DLL_PUBLIC proto_item * proto_tree_add_ipv6_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const ws_in6_addr *value_ptr, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_time(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const nstime_t *value_ptr)
Definition proto.c:4856
char * proto_custom_get_filter(struct epan_dissect *edt, GSList *field_id, int occurrence)
Definition proto.c:7536
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_protocol_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const char *format,...) G_GNUC_PRINTF(6
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask_with_flags(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_hdr, const int ett, int *const *fields, const unsigned encoding, const int flags)
Definition proto.c:12996
WS_DLL_PUBLIC proto_tree proto_item * proto_tree_add_format_text(proto_tree *tree, tvbuff_t *tvb, int start, int length)
Definition proto.c:1519
WS_DLL_PUBLIC proto_tree * proto_tree_get_root(proto_tree *tree)
Definition proto.c:8097
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_uint_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint32_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_uint64_bits_format_value(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const unsigned bit_offset, const int no_of_bits, uint64_t value, const unsigned encoding, const char *format,...) G_GNUC_PRINTF(8
WS_DLL_PUBLIC bool proto_registrar_dump_field_completions(const char *prefix)
Definition proto.c:12278
WS_DLL_PUBLIC bool proto_can_toggle_protocol(const int proto_id)
Definition proto.c:8723
void proto_init(GSList *register_all_plugin_protocols_list, GSList *register_all_plugin_handoffs_list, register_cb cb, void *client_data)
Definition proto.c:560
WS_DLL_PUBLIC void proto_registrar_dump_ftypes(void)
Definition proto.c:12343
WS_DLL_PUBLIC proto_item * proto_tree_add_ipv4_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, ws_in4_addr value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC protocol_t * find_protocol_by_id(const int proto_id)
Definition proto.c:8470
WS_DLL_PUBLIC void proto_reenable_all(void)
Definition proto.c:8789
WS_DLL_PUBLIC bool proto_registrar_is_protocol(const int n)
Definition proto.c:11338
WS_DLL_PUBLIC void proto_disable_all(void)
Definition proto.c:8759
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_uint64(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint64_t value)
Definition proto.c:5896
WS_DLL_PUBLIC header_field_info * proto_registrar_get_byname(const char *field_name)
Definition proto.c:1020
WS_DLL_PUBLIC int num_tree_types
Definition proto.h:2976
#define PITEM_FINFO(proto_item)
Definition proto.h:987
WS_DLL_PUBLIC const char * proto_field_display_to_string(int field_display)
Definition proto.c:9130
WS_DLL_PUBLIC void proto_free_deregistered_fields(void)
Definition proto.c:9081
#define FI_GENERATED
Definition proto.h:859
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_boolean(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, uint64_t value)
Definition proto.c:5512
#define FI_SET_FLAG(fi, flag)
Definition proto.h:878
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_ipv6(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, ws_in6_addr *retval)
Parse an ipv6 address from the buffer and add it to the tree, writing the value to the pointer specif...
Definition proto.c:3953
WS_DLL_PUBLIC proto_item * proto_tree_add_item_ret_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, const int start, int length, const unsigned encoding, wmem_allocator_t *scope, const uint8_t **retval)
Definition proto.c:4102
WS_DLL_PUBLIC int proto_get_id(const protocol_t *protocol)
Definition proto.c:8485
WS_DLL_PUBLIC proto_item * proto_tree_add_eui64_format_value(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint64_t value, const char *format,...) G_GNUC_PRINTF(7
WS_DLL_PUBLIC void proto_register_alias(const int proto_id, const char *alias_name)
Definition proto.c:8390
WS_DLL_PUBLIC void proto_deregister_all_fields_with_prefix(const int parent, const gchar *prefix)
Definition proto.c:8893
WS_DLL_PUBLIC void proto_free_field_strings(ftenum_t field_type, unsigned int field_display, const void *field_strings)
Definition proto.c:8935
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask_text(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const unsigned len, const char *name, const char *fallback, const int ett, int *const *fields, const unsigned encoding, const int flags)
Definition proto.c:13161
WS_DLL_PUBLIC void proto_item_set_end(proto_item *pi, tvbuff_t *tvb, int end)
Definition proto.c:7875
WS_DLL_PUBLIC proto_item * proto_tree_add_bitmask_ret_uint64(proto_tree *tree, tvbuff_t *tvb, const unsigned offset, const int hf_hdr, const int ett, int *const *fields, const unsigned encoding, uint64_t *retval)
Definition proto.c:12923
WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item WS_DLL_PUBLIC proto_item * proto_tree_add_ether(proto_tree *tree, int hfindex, tvbuff_t *tvb, int start, int length, const uint8_t *value)
Definition proto.c:5441
@ HF_REF_TYPE_INDIRECT
Definition proto.h:758
@ HF_REF_TYPE_NONE
Definition proto.h:757
@ HF_REF_TYPE_DIRECT
Definition proto.h:759
@ HF_REF_TYPE_PRINT
Definition proto.h:760
@ ABSOLUTE_TIME_DOY_UTC
Definition proto.h:716
@ BASE_PT_UDP
Definition proto.h:705
@ BASE_HEX_DEC
Definition proto.h:691
@ BASE_HEX
Definition proto.h:688
@ ABSOLUTE_TIME_NTP_UTC
Definition proto.h:717
@ BASE_EXP
Definition proto.h:693
@ ABSOLUTE_TIME_UTC
Definition proto.h:715
@ BASE_DEC
Definition proto.h:687
@ ABSOLUTE_TIME_UNIX
Definition proto.h:718
@ BASE_PT_TCP
Definition proto.h:706
@ BASE_DEC_HEX
Definition proto.h:690
@ BASE_OUI
Definition proto.h:711
@ SEP_COLON
Definition proto.h:698
@ BASE_PT_SCTP
Definition proto.h:708
@ BASE_NETMASK
Definition proto.h:702
@ ABSOLUTE_TIME_LOCAL
Definition proto.h:714
@ BASE_PT_DCCP
Definition proto.h:707
@ BASE_STR_WSP
Definition proto.h:721
@ BASE_NONE
Definition proto.h:684
@ SEP_DOT
Definition proto.h:696
@ SEP_DASH
Definition proto.h:697
@ SEP_SPACE
Definition proto.h:699
@ BASE_OCT
Definition proto.h:689
@ BASE_CUSTOM
Definition proto.h:692
Definition guid-utils.h:23
Definition ftypes-int.h:17
Definition proto.h:767
uint64_t bitmask
Definition proto.h:777
int same_name_prev_id
Definition proto.h:784
int display
Definition proto.h:772
const void * strings
Definition proto.h:773
const char * name
Definition proto.h:769
hf_ref_type ref_type
Definition proto.h:783
int parent
Definition proto.h:782
enum ftenum type
Definition proto.h:771
const char * abbrev
Definition proto.h:770
const char * blurb
Definition proto.h:778
int id
Definition proto.h:781
header_field_info * same_name_next
Definition proto.h:785
Definition proto.h:809
size_t value_pos
Definition proto.h:811
size_t value_len
Definition proto.h:812
Definition proto.h:2534
Definition packet_info.h:43
Definition plugins.c:29
Definition proto.h:906
Definition proto.c:377
Definition value_string.h:27
Definition wmem_allocator.h:27
Definition wmem_list.c:23
Definition proto.h:841
Definition inet_addr.h:21
Definition epan_dissect.h:28
Definition expert.h:39
Definition proto.h:816
tvbuff_t * ds_tvb
Definition proto.h:825
int proto_layer_num
Definition proto.h:828
int length
Definition proto.h:819
int total_layer_num
Definition proto.h:827
int appendix_start
Definition proto.h:820
uint32_t flags
Definition proto.h:823
const header_field_info * hfinfo
Definition proto.h:817
item_label_t * rep
Definition proto.h:824
int start
Definition proto.h:818
int appendix_length
Definition proto.h:821
int tree_type
Definition proto.h:822
Definition proto.h:803
int * p_id
Definition proto.h:804
header_field_info hfinfo
Definition proto.h:805
Definition nstime.h:26
Definition proto.h:1095
Definition proto.h:895
Definition tvbuff-int.h:35