2 * Definitions for packet disassembly structures and routines
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 #include "value_string.h"
31 #include "column-info.h"
32 #include "frame_data.h"
33 #include "packet_info.h"
34 #include "column-utils.h"
36 #include "ws_symbol_export.h"
41 #endif /* __cplusplus */
43 /** @defgroup packet General Packet Dissection
48 #define hi_nibble(b) (((b) & 0xf0) >> 4)
49 #define lo_nibble(b) ((b) & 0x0f)
51 /* Useful when you have an array whose size you can tell at compile-time */
52 #define array_length(x) (sizeof x / sizeof x[0])
54 /* Check whether the "len" bytes of data starting at "offset" is
55 * entirely inside the captured data for this packet. */
56 #define BYTES_ARE_IN_FRAME(offset, captured_len, len) \
57 ((guint)(offset) + (guint)(len) > (guint)(offset) && \
58 (guint)(offset) + (guint)(len) <= (guint)(captured_len))
60 /* To pass one of two strings, singular or plural */
61 #define plurality(d,s,p) ((d) == 1 ? (s) : (p))
63 typedef struct _packet_counts {
80 /** Number of packet counts. */
81 #define PACKET_COUNTS_SIZE sizeof(packet_counts) / sizeof (gint)
83 extern void packet_init(void);
84 extern void packet_cache_proto_handles(void);
85 extern void packet_cleanup(void);
87 /* Handle for dissectors you call directly or register with "dissector_add_uint()".
88 This handle is opaque outside of "packet.c". */
89 struct dissector_handle;
90 typedef struct dissector_handle *dissector_handle_t;
92 /* Hash table for matching unsigned integers, or strings, and dissectors;
93 this is opaque outside of "packet.c". */
94 struct dissector_table;
95 typedef struct dissector_table *dissector_table_t;
98 * Dissector that returns nothing.
100 typedef void (*dissector_t)(tvbuff_t *, packet_info *, proto_tree *);
103 * Dissector that returns:
105 * The amount of data in the protocol's PDU, if it was able to
106 * dissect all the data;
108 * 0, if the tvbuff doesn't contain a PDU for that protocol;
110 * The negative of the amount of additional data needed, if
111 * we need more data (e.g., from subsequent TCP segments) to
112 * dissect the entire PDU.
114 typedef int (*new_dissector_t)(tvbuff_t *, packet_info *, proto_tree *, void *);
116 /** Type of a heuristic dissector, used in heur_dissector_add().
118 * @param tvb the tvbuff with the (remaining) packet data
119 * @param pinfo the packet info of this packet (additional info)
120 * @param tree the protocol tree to be build or NULL
121 * @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
123 typedef gboolean (*heur_dissector_t)(tvbuff_t *tvb, packet_info *pinfo,
124 proto_tree *tree, void *);
126 typedef void (*DATFunc) (const gchar *table_name, ftenum_t selector_type,
127 gpointer key, gpointer value, gpointer user_data);
128 typedef void (*DATFunc_handle) (const gchar *table_name, gpointer value,
130 typedef void (*DATFunc_table) (const gchar *table_name, const gchar *ui_name,
133 typedef void (*DATFunc_heur_table) (const gchar *table_name,gpointer table,
136 /* Opaque structure - provides type checking but no access to components */
137 typedef struct dtbl_entry dtbl_entry_t;
139 WS_DLL_PUBLIC dissector_handle_t dtbl_entry_get_handle (dtbl_entry_t *dtbl_entry);
140 WS_DLL_PUBLIC dissector_handle_t dtbl_entry_get_initial_handle (dtbl_entry_t * entry);
142 /** Iterate over dissectors in a table with non-default "decode as" settings.
144 * Walk one dissector table calling a user supplied function only on
145 * any entry that has been changed from its original state.
147 * @param[in] table_name The name of the dissector table, e.g. "ip.proto".
148 * @param[in] func The function to call for each dissector.
149 * @param[in] user_data User data to pass to the function.
151 void dissector_table_foreach_changed (const char *table_name, DATFunc func,
154 /** Iterate over dissectors in a table.
156 * Walk one dissector table's hash table calling a user supplied function
159 * @param[in] table_name The name of the dissector table, e.g. "ip.proto".
160 * @param[in] func The function to call for each dissector.
161 * @param[in] user_data User data to pass to the function.
163 WS_DLL_PUBLIC void dissector_table_foreach (const char *table_name, DATFunc func,
166 /** Iterate over dissectors with non-default "decode as" settings.
168 * Walk all dissector tables calling a user supplied function only on
169 * any "decode as" entry that has been changed from its original state.
171 * @param[in] func The function to call for each dissector.
172 * @param[in] user_data User data to pass to the function.
174 WS_DLL_PUBLIC void dissector_all_tables_foreach_changed (DATFunc func,
177 /** Iterate over dissectors in a table by handle.
179 * Walk one dissector table's list of handles calling a user supplied
180 * function on each entry.
182 * @param[in] table_name The name of the dissector table, e.g. "ip.proto".
183 * @param[in] func The function to call for each dissector.
184 * @param[in] user_data User data to pass to the function.
186 WS_DLL_PUBLIC void dissector_table_foreach_handle(const char *table_name, DATFunc_handle func,
189 /** Iterate over dissectors in a table matching against a given function.
191 * Walk all dissector tables calling a user supplied function on each
193 * @param[in] func The function to call for each dissector.
194 * @param[in] user_data User data to pass to the function.
195 * @param[in] compare_key_func Hash table key comparison function. All entries
196 * are matched if NULL.
198 WS_DLL_PUBLIC void dissector_all_tables_foreach_table (DATFunc_table func,
199 gpointer user_data, GCompareFunc compare_key_func);
201 /* a protocol uses the function to register a sub-dissector table */
202 WS_DLL_PUBLIC dissector_table_t register_dissector_table(const char *name,
203 const char *ui_name, const ftenum_t type, const int base);
205 /* Find a dissector table by table name. */
206 WS_DLL_PUBLIC dissector_table_t find_dissector_table(const char *name);
208 /* Get the UI name for a sub-dissector table, given its internal name */
209 WS_DLL_PUBLIC const char *get_dissector_table_ui_name(const char *name);
211 /* Get the field type for values of the selector for a dissector table,
212 given the table's internal name */
213 WS_DLL_PUBLIC ftenum_t get_dissector_table_selector_type(const char *name);
215 /* Get the base to use when displaying values of the selector for a
216 sub-dissector table, given the table's internal name */
217 WS_DLL_PUBLIC int get_dissector_table_base(const char *name);
219 /* Add an entry to a uint dissector table. */
220 WS_DLL_PUBLIC void dissector_add_uint(const char *abbrev, const guint32 pattern,
221 dissector_handle_t handle);
223 /* Add an range of entries to a uint dissector table. */
224 WS_DLL_PUBLIC void dissector_add_uint_range(const char *abbrev, range_t *range,
225 dissector_handle_t handle);
227 /* Delete the entry for a dissector in a uint dissector table
228 with a particular pattern. */
229 WS_DLL_PUBLIC void dissector_delete_uint(const char *name, const guint32 pattern,
230 dissector_handle_t handle);
232 /* Delete an range of entries from a uint dissector table. */
233 WS_DLL_PUBLIC void dissector_delete_uint_range(const char *abbrev, range_t *range,
234 dissector_handle_t handle);
236 /* Delete all entries from a dissector table. */
237 WS_DLL_PUBLIC void dissector_delete_all(const char *name, dissector_handle_t handle);
239 /* Change the entry for a dissector in a uint dissector table
240 with a particular pattern to use a new dissector handle. */
241 WS_DLL_PUBLIC void dissector_change_uint(const char *abbrev, const guint32 pattern,
242 dissector_handle_t handle);
244 /* Reset an entry in a uint dissector table to its initial value. */
245 WS_DLL_PUBLIC void dissector_reset_uint(const char *name, const guint32 pattern);
247 /* Look for a given value in a given uint dissector table and, if found,
248 call the dissector with the arguments supplied, and return TRUE,
249 otherwise return FALSE. */
250 WS_DLL_PUBLIC gboolean dissector_try_uint(dissector_table_t sub_dissectors,
251 const guint32 uint_val, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
253 /* Look for a given value in a given uint dissector table and, if found,
254 call the dissector with the arguments supplied, and return TRUE,
255 otherwise return FALSE. */
256 WS_DLL_PUBLIC gboolean dissector_try_uint_new(dissector_table_t sub_dissectors,
257 const guint32 uint_val, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, const gboolean add_proto_name, void *data);
259 /* Look for a given value in a given uint dissector table and, if found,
260 return the dissector handle for that value. */
261 WS_DLL_PUBLIC dissector_handle_t dissector_get_uint_handle(
262 dissector_table_t const sub_dissectors, const guint32 uint_val);
264 /* Add an entry to a string dissector table. */
265 WS_DLL_PUBLIC void dissector_add_string(const char *name, const gchar *pattern,
266 dissector_handle_t handle);
268 /* Delete the entry for a dissector in a string dissector table
269 with a particular pattern. */
270 WS_DLL_PUBLIC void dissector_delete_string(const char *name, const gchar *pattern,
271 dissector_handle_t handle);
273 /* Change the entry for a dissector in a string dissector table
274 with a particular pattern to use a new dissector handle. */
275 WS_DLL_PUBLIC void dissector_change_string(const char *name, const gchar *pattern,
276 dissector_handle_t handle);
278 /* Reset an entry in a string sub-dissector table to its initial value. */
279 WS_DLL_PUBLIC void dissector_reset_string(const char *name, const gchar *pattern);
281 /* Look for a given string in a given dissector table and, if found, call
282 the dissector with the arguments supplied, and return TRUE, otherwise
284 WS_DLL_PUBLIC gboolean dissector_try_string(dissector_table_t sub_dissectors,
285 const gchar *string, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data);
287 /* Look for a given value in a given string dissector table and, if found,
288 return the dissector handle for that value. */
289 WS_DLL_PUBLIC dissector_handle_t dissector_get_string_handle(
290 dissector_table_t sub_dissectors, const gchar *string);
292 /* Add a handle to the list of handles that *could* be used with this
293 table. That list is used by code in the UI. */
294 WS_DLL_PUBLIC void dissector_add_handle(const char *name, dissector_handle_t handle);
296 /** Get the list of handles for a dissector table
298 WS_DLL_PUBLIC GSList *dissector_table_get_dissector_handles(dissector_table_t dissector_table);
300 /** Get a dissector table's type
302 WS_DLL_PUBLIC ftenum_t dissector_table_get_type(dissector_table_t dissector_table);
304 /* List of "heuristic" dissectors (which get handed a packet, look at it,
305 and either recognize it as being for their protocol, dissect it, and
306 return TRUE, or don't recognize it and return FALSE) to be called
307 by another dissector. */
308 typedef GSList *heur_dissector_list_t;
312 heur_dissector_t dissector;
313 protocol_t *protocol;
317 /** A protocol uses this function to register a heuristic sub-dissector list.
318 * Call this in the parent dissectors proto_register function.
320 * @param name the name of this protocol
321 * @param list the list of heuristic sub-dissectors to be registered
323 WS_DLL_PUBLIC void register_heur_dissector_list(const char *name,
324 heur_dissector_list_t *list);
326 WS_DLL_PUBLIC void dissector_all_heur_tables_foreach_table (DATFunc_heur_table func,
329 /** Try all the dissectors in a given heuristic dissector list. This is done,
330 * until we find one that recognizes the protocol.
331 * Call this while the parent dissector running.
333 * @param sub_dissectors the sub-dissector list
334 * @param tvb the tvbuff with the (remaining) packet data
335 * @param pinfo the packet info of this packet (additional info)
336 * @param tree the protocol tree to be build or NULL
337 * @param data parameter to pass to subdissector
338 * @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
340 WS_DLL_PUBLIC gboolean dissector_try_heuristic(heur_dissector_list_t sub_dissectors,
341 tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data);
343 /** Add a sub-dissector to a heuristic dissector list.
344 * Call this in the proto_handoff function of the sub-dissector.
346 * @param name the name of the "parent" protocol, e.g. "tcp"
347 * @param dissector the sub-dissector to be registered
348 * @param proto the protocol id of the sub-dissector
350 WS_DLL_PUBLIC void heur_dissector_add(const char *name, heur_dissector_t dissector,
353 /** Remove a sub-dissector from a heuristic dissector list.
354 * Call this in the prefs_reinit function of the sub-dissector.
356 * @param name the name of the "parent" protocol, e.g. "tcp"
357 * @param dissector the sub-dissector to be unregistered
358 * @param proto the protocol id of the sub-dissector
360 WS_DLL_PUBLIC void heur_dissector_delete(const char *name, heur_dissector_t dissector, const int proto);
362 /** Enable/Disable a sub-dissector in a heuristic dissector list
363 * Call this in the prefs_reinit function of the sub-dissector.
365 * @param name the name of the "parent" protocol, e.g. "tcp"
366 * @param dissector the sub-dissector to be disabled/enabled
367 * @param proto the protocol id of the sub-dissector
368 * @param enabled TRUE/FALSE to enable/disable the sub-dissector
370 extern void heur_dissector_set_enabled(const char *name, heur_dissector_t dissector, const int proto, const gboolean enabled);
372 /* Register a dissector. */
373 WS_DLL_PUBLIC dissector_handle_t register_dissector(const char *name, dissector_t dissector,
375 WS_DLL_PUBLIC dissector_handle_t new_register_dissector(const char *name, new_dissector_t dissector,
378 /* Get the long name of the protocol for a dissector handle. */
379 extern const char *dissector_handle_get_long_name(const dissector_handle_t handle);
381 /* Get the short name of the protocol for a dissector handle. */
382 WS_DLL_PUBLIC const char *dissector_handle_get_short_name(const dissector_handle_t handle);
384 /* Get the index of the protocol for a dissector handle. */
385 WS_DLL_PUBLIC int dissector_handle_get_protocol_index(const dissector_handle_t handle);
387 /* Find a dissector by name. */
388 WS_DLL_PUBLIC dissector_handle_t find_dissector(const char *name);
390 /* Get a dissector name from handle. */
391 WS_DLL_PUBLIC const char *dissector_handle_get_dissector_name(const dissector_handle_t handle);
393 /* Create an anonymous handle for a dissector. */
394 WS_DLL_PUBLIC dissector_handle_t create_dissector_handle(dissector_t dissector,
396 WS_DLL_PUBLIC dissector_handle_t new_create_dissector_handle(new_dissector_t dissector,
399 /* Call a dissector through a handle and if no dissector was found
400 * pass it over to the "data" dissector instead.
402 * @param handle The dissector to call.
403 * @param tvb The buffer to dissect.
404 * @param pinfo Packet Info.
405 * @param tree The protocol tree.
406 * @param data parameter to pass to dissector
407 * @return If the protocol for that handle isn't enabled call the data
408 * dissector. Otherwise, if the handle refers to a new-style
409 * dissector, call the dissector and return its return value, otherwise call
410 * it and return the length of the tvbuff pointed to by the argument.
412 WS_DLL_PUBLIC int call_dissector_with_data(dissector_handle_t handle, tvbuff_t *tvb,
413 packet_info *pinfo, proto_tree *tree, void *data);
414 WS_DLL_PUBLIC int call_dissector(dissector_handle_t handle, tvbuff_t *tvb,
415 packet_info *pinfo, proto_tree *tree);
417 /* Call a dissector through a handle but if no dissector was found
418 * just return 0 and do not call the "data" dissector instead.
420 * @param handle The dissector to call.
421 * @param tvb The buffer to dissect.
422 * @param pinfo Packet Info.
423 * @param tree The protocol tree.
424 * @param data parameter to pass to dissector
425 * @return If the protocol for that handle isn't enabled, return 0 without
426 * calling the dissector. Otherwise, if the handle refers to a new-style
427 * dissector, call the dissector and return its return value, otherwise call
428 * it and return the length of the tvbuff pointed to by the argument.
430 WS_DLL_PUBLIC int call_dissector_only(dissector_handle_t handle, tvbuff_t *tvb,
431 packet_info *pinfo, proto_tree *tree, void *data);
433 /* Do all one-time initialization. */
434 extern void dissect_init(void);
436 extern void dissect_cleanup(void);
439 * Given a tvbuff, and a length from a packet header, adjust the length
440 * of the tvbuff to reflect the specified length.
442 WS_DLL_PUBLIC void set_actual_length(tvbuff_t *tvb, const guint specified_len);
444 /* Allow protocols to register "init" routines, which are called before
445 we make a pass through a capture file and dissect all its packets
446 (e.g., when we read in a new capture file, or run a "filter packets"
447 or "colorize packets" pass over the current capture file). */
448 WS_DLL_PUBLIC void register_init_routine(void (*func)(void));
450 /* Initialize all data structures used for dissection. */
451 void init_dissection(void);
453 /* Free data structures allocated for dissection. */
454 void cleanup_dissection(void);
456 /* Allow protocols to register a "cleanup" routine to be
457 * run after the initial sequential run through the packets.
458 * Note that the file can still be open after this; this is not
459 * the final cleanup. */
460 WS_DLL_PUBLIC void register_postseq_cleanup_routine(void (*func)(void));
462 /* Call all the registered "postseq_cleanup" routines. */
463 WS_DLL_PUBLIC void postseq_cleanup_all_protocols(void);
465 /* Allow dissectors to register a "final_registration" routine
466 * that is run like the proto_register_XXX() routine, but the end
467 * end of the epan_init() function; that is, *after* all other
468 * subsystems, liked dfilters, have finished initializing. This is
469 * useful for dissector registration routines which need to compile
470 * display filters. dfilters can't initialize itself until all protocols
471 * have registereed themselvs. */
473 register_final_registration_routine(void (*func)(void));
475 /* Call all the registered "final_registration" routines. */
477 final_registration_all_protocols(void);
480 * Add a new data source to the list of data sources for a frame, given
481 * the tvbuff for the data source and its name.
483 WS_DLL_PUBLIC void add_new_data_source(packet_info *pinfo, tvbuff_t *tvb,
488 * Return the data source name, tvb.
491 WS_DLL_PUBLIC const char *get_data_source_name(const struct data_source *src);
492 WS_DLL_PUBLIC tvbuff_t *get_data_source_tvb(const struct data_source *src);
495 * Free up a frame's list of data sources.
497 extern void free_data_sources(packet_info *pinfo);
499 /* Mark another frame as depended upon by the current frame.
501 * This information is used to ensure that the dependend-upon frame is saved
502 * if the user does a File->Save-As of only the Displayed packets and the
503 * current frame passed the display filter.
505 WS_DLL_PUBLIC void mark_frame_as_depended_upon(packet_info *pinfo, guint32 frame_num);
508 * Dissectors should never modify the packet data.
510 extern void dissect_packet(struct epan_dissect *edt,
511 struct wtap_pkthdr *phdr, tvbuff_t *tvb,
512 frame_data *fd, column_info *cinfo);
514 /* These functions are in packet-ethertype.c */
515 extern void capture_ethertype(guint16 etype, const guchar *pd, int offset,
516 int len, packet_counts *ld);
517 /* Structure passed to the ethertype dissector */
518 typedef struct ethertype_data_s
521 int offset_after_ethertype;
529 * Dump layer/selector/dissector records in a fashion similar to the
530 * proto_registrar_dump_* routines.
532 WS_DLL_PUBLIC void dissector_dump_decodes(void);
535 * For each heuristic dissector table, dump list of dissectors (filter_names) for that table
537 WS_DLL_PUBLIC void dissector_dump_heur_decodes(void);
540 * post dissectors are to be called by packet-frame.c after every other
541 * dissector has been called.
543 WS_DLL_PUBLIC void register_postdissector(dissector_handle_t);
544 extern gboolean have_postdissector(void);
545 extern void call_all_postdissectors(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
551 #endif /* __cplusplus */
553 #endif /* packet.h */