summaryrefslogtreecommitdiffstats
path: root/epan/tvbuff-int.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 20:34:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 20:34:10 +0000
commite4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc (patch)
tree68cb5ef9081156392f1dd62a00c6ccc1451b93df /epan/tvbuff-int.h
parentInitial commit. (diff)
downloadwireshark-e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc.tar.xz
wireshark-e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc.zip
Adding upstream version 4.2.2.upstream/4.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'epan/tvbuff-int.h')
-rw-r--r--epan/tvbuff-int.h98
1 files changed, 98 insertions, 0 deletions
diff --git a/epan/tvbuff-int.h b/epan/tvbuff-int.h
new file mode 100644
index 00000000..49b65f2d
--- /dev/null
+++ b/epan/tvbuff-int.h
@@ -0,0 +1,98 @@
+/** @file
+ *
+ * Structures that most TVB users should not be accessing directly.
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef __TVBUFF_INT_H__
+#define __TVBUFF_INT_H__
+
+struct tvbuff;
+
+struct tvb_ops {
+ gsize tvb_size;
+ void (*tvb_free)(struct tvbuff *tvb);
+ guint (*tvb_offset)(const struct tvbuff *tvb, guint counter);
+ const guint8 *(*tvb_get_ptr)(struct tvbuff *tvb, guint abs_offset, guint abs_length);
+ void *(*tvb_memcpy)(struct tvbuff *tvb, void *target, guint offset, guint length);
+
+ gint (*tvb_find_guint8)(tvbuff_t *tvb, guint abs_offset, guint limit, guint8 needle);
+ gint (*tvb_ws_mempbrk_pattern_guint8)(tvbuff_t *tvb, guint abs_offset, guint limit, const ws_mempbrk_pattern* pattern, guchar *found_needle);
+
+ tvbuff_t *(*tvb_clone)(tvbuff_t *tvb, guint abs_offset, guint abs_length);
+};
+
+/*
+ * Tvbuff flags.
+ */
+#define TVBUFF_FRAGMENT 0x00000001 /* this is a fragment */
+
+struct tvbuff {
+ /* Doubly linked list pointers */
+ tvbuff_t *next;
+
+ /* Record-keeping */
+ const struct tvb_ops *ops;
+ gboolean initialized;
+ guint flags;
+ struct tvbuff *ds_tvb; /**< data source top-level tvbuff */
+
+ /** Pointer to the data for this tvbuff.
+ * It might be null, which either means that 1) it's a
+ * zero-length tvbuff or 2) the tvbuff was lazily
+ * constructed, so that we don't allocate a buffer of
+ * backing data and fill it in unless we need that
+ * data, e.g. when tvb_get_ptr() is called.
+ */
+ const guint8 *real_data;
+
+ /** Amount of data that's available from the capture
+ * file. This is the length of virtual buffer (and/or
+ * real_data). It may be less than the reported
+ * length if this is from a packet that was cut short
+ * by the capture process.
+ *
+ * This must never be > reported_length or contained_length. */
+ guint length;
+
+ /** Amount of data that was reported as being in
+ * the packet or other data that this represents.
+ * As indicated above, it may be greater than the
+ * amount of data that's available. */
+ guint reported_length;
+
+ /** If this was extracted from a parent tvbuff,
+ * this is the amount of extracted data that
+ * was reported as being in the parent tvbuff;
+ * if this represents a blob of data in that
+ * tvbuff that has a length specified by data
+ * in that tvbuff, it might be greater than
+ * the amount of data that was actually there
+ * to extract, so it could be greater than
+ * reported_length.
+ *
+ * If this wasn't extracted from a parent tvbuff,
+ * this is the same as reported_length.
+ *
+ * This must never be > reported_length. */
+ guint contained_length;
+
+ /* Offset from beginning of first "real" tvbuff. */
+ gint raw_offset;
+};
+
+WS_DLL_PUBLIC tvbuff_t *tvb_new(const struct tvb_ops *ops);
+
+tvbuff_t *tvb_new_proxy(tvbuff_t *backing);
+
+void tvb_add_to_chain(tvbuff_t *parent, tvbuff_t *child);
+
+guint tvb_offset_from_real_beginning_counter(const tvbuff_t *tvb, const guint counter);
+
+void tvb_check_offset_length(const tvbuff_t *tvb, const gint offset, gint const length_val, guint *offset_ptr, guint *length_ptr);
+#endif