From Harald Welte:
[obnox/wireshark/wip.git] / epan / reassemble.h
index 7375f55416121f270c4d312255426e70f96aba97..8d8f7cff7b4e54e5fab7d1415688791857aa2ba5 100644 (file)
@@ -26,6 +26,9 @@
  * the flags field of fd_head !!!
  */
 
+#ifndef REASSEMBLE_H
+#define REASSEMBLE_H
+
 /* only in fd_head: packet is defragmented */
 #define FD_DEFRAGMENTED                0x0001
 
@@ -41,7 +44,7 @@
 /* fragment contains data past the end of the datagram */
 #define FD_TOOLONGFRAGMENT     0x0010
 
-/* fragment data not alloced, fd->data pointing to fd_head->data+fd->offset */
+/* fragment data not alloc'ed, fd->data pointing to fd_head->data+fd->offset */
 #define FD_NOT_MALLOCED         0x0020
 
 /* this flag is used to request fragment_add to continue the reassembly process */
@@ -58,7 +61,7 @@
  */
 #define FD_DATA_NOT_PRESENT    0x0200
 
-/* This flag is set in the to denote that datalen has ben set to a valid value.
+/* This flag is set in (only) fd_head to denote that datalen has been set to a valid value.
  * It's implied by FD_DEFRAGMENTED (we must know the total length of the
  * datagram if we have defragmented it...)
  */
@@ -99,7 +102,6 @@ typedef struct _fragment_data {
 /* a function for copying hash keys */
 typedef void *(*fragment_key_copier)(const void *key);
 
-
 /*
  * Initialize a fragment table.
  */
@@ -111,11 +113,6 @@ extern void dcerpc_fragment_table_init(GHashTable **fragment_table);
  */
 extern void reassembled_table_init(GHashTable **reassembled_table);
 
-/*
- * Free up all space allocated for fragment keys and data.
- */
-void reassemble_init(void);
-
 /*
  * This function adds a new fragment to the fragment hash table.
  * If this is the first fragment seen for this datagram, a new entry
@@ -127,17 +124,25 @@ void reassemble_init(void);
  * Returns a pointer to the head of the fragment data list if we have all the
  * fragments, NULL otherwise.
  */
-extern fragment_data *fragment_add(tvbuff_t *tvb, int offset, packet_info *pinfo,
-    guint32 id, GHashTable *fragment_table, guint32 frag_offset,
-    guint32 frag_data_len, gboolean more_frags);
-extern fragment_data *fragment_add_multiple_ok(tvbuff_t *tvb, int offset,
-    packet_info *pinfo, guint32 id, GHashTable *fragment_table,
-    guint32 frag_offset, guint32 frag_data_len, gboolean more_frags);
-
-extern fragment_data *fragment_add_check(tvbuff_t *tvb, int offset,
-    packet_info *pinfo, guint32 id, GHashTable *fragment_table,
-    GHashTable *reassembled_table, guint32 frag_offset,
-    guint32 frag_data_len, gboolean more_frags);
+extern fragment_data *fragment_add(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
+    const guint32 id, GHashTable *fragment_table, const guint32 frag_offset,
+    guint32 const frag_data_len, const gboolean more_frags);
+extern fragment_data *fragment_add_multiple_ok(tvbuff_t *tvb, const int offset,
+    const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
+    const guint32 frag_offset, const guint32 frag_data_len, const gboolean more_frags);
+
+/*
+ * This routine extends fragment_add to use a "reassembled_table".
+ *
+ * If, after processing this fragment, we have all the fragments, they
+ * remove that from the fragment hash table if necessary and add it
+ * to the table of reassembled fragments, and return a pointer to the
+ * head of the fragment list.
+ */
+extern fragment_data *fragment_add_check(tvbuff_t *tvb, const int offset,
+    const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
+    GHashTable *reassembled_table, const guint32 frag_offset,
+    const guint32 frag_data_len, const gboolean more_frags);
 
 /* same as fragment_add() but this one assumes frag_number is a block
    sequence number. note that frag_number is 0 for the first fragment. */
@@ -173,24 +178,24 @@ extern fragment_data *fragment_add_check(tvbuff_t *tvb, int offset,
  * inserting a new entry to the hash.
  */
 extern fragment_data *
-fragment_add_seq_key(tvbuff_t *tvb, int offset, packet_info *pinfo,
+fragment_add_seq_key(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
                      void *key, fragment_key_copier key_copier,
                      GHashTable *fragment_table, guint32 frag_number,
-                     guint32 frag_data_len, gboolean more_frags,
-                     guint32 flags);
+                     const guint32 frag_data_len, const gboolean more_frags,
+                     const guint32 flags);
 
-/* a wrapper for fragment_add_seq_key - uses a key of source, dest and frame number */
-extern fragment_data *fragment_add_seq(tvbuff_t *tvb, int offset, packet_info *pinfo,
-    guint32 id, GHashTable *fragment_table, guint32 frag_number,
-    guint32 frag_data_len, gboolean more_frags);
+/* a wrapper for fragment_add_seq_key - uses a key of source, dest and id */
+extern fragment_data *fragment_add_seq(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
+    const guint32 id, GHashTable *fragment_table, const guint32 frag_number,
+    const guint32 frag_data_len, const gboolean more_frags);
 
-/* another wrapper for fragment_add_seq_key - uses a key of source, dest, frame
- * number and act_id */
+/* another wrapper for fragment_add_seq_key - uses a key of source, dest, id
+ * and act_id */
 extern fragment_data *
-fragment_add_dcerpc_dg(tvbuff_t *tvb, int offset, packet_info *pinfo, guint32 id,
+fragment_add_dcerpc_dg(tvbuff_t *tvb, const int offset, const packet_info *pinfo, const guint32 id,
        void *act_id,
-       GHashTable *fragment_table, guint32 frag_number,
-       guint32 frag_data_len, gboolean more_frags);
+       GHashTable *fragment_table, const guint32 frag_number,
+       const guint32 frag_data_len, const gboolean more_frags);
 
 /*
  * These routines extend fragment_add_seq_key to use a "reassembled_table".
@@ -201,24 +206,32 @@ fragment_add_dcerpc_dg(tvbuff_t *tvb, int offset, packet_info *pinfo, guint32 id
  * head of the fragment list.
  */
 extern fragment_data *
-fragment_add_seq_check(tvbuff_t *tvb, int offset, packet_info *pinfo,
-            guint32 id, GHashTable *fragment_table,
-            GHashTable *reassembled_table, guint32 frag_number,
-            guint32 frag_data_len, gboolean more_frags);
+fragment_add_seq_check(tvbuff_t *tvb, const int offset,
+                      const packet_info *pinfo, const guint32 id,
+                      GHashTable *fragment_table,
+                      GHashTable *reassembled_table, const guint32 frag_number,
+                      const guint32 frag_data_len, const gboolean more_frags);
 
 extern fragment_data *
-fragment_add_seq_802_11(tvbuff_t *tvb, int offset, packet_info *pinfo,
-            guint32 id, GHashTable *fragment_table,
-            GHashTable *reassembled_table, guint32 frag_number,
-            guint32 frag_data_len, gboolean more_frags);
+fragment_add_seq_802_11(tvbuff_t *tvb, const int offset,
+                       const packet_info *pinfo, const guint32 id,
+                       GHashTable *fragment_table,
+                       GHashTable *reassembled_table,
+                       const guint32 frag_number, const guint32 frag_data_len,
+                       const gboolean more_frags);
 
 extern fragment_data *
-fragment_add_seq_next(tvbuff_t *tvb, int offset, packet_info *pinfo, guint32 id,
-            GHashTable *fragment_table, GHashTable *reassembled_table,
-            guint32 frag_data_len, gboolean more_frags);
+fragment_add_seq_next(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
+                     const guint32 id, GHashTable *fragment_table,
+                     GHashTable *reassembled_table,
+                     const guint32 frag_data_len, const gboolean more_frags);
+
+extern void
+fragment_start_seq_check(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
+                        const guint32 tot_len);
 
 extern fragment_data *
-fragment_end_seq_next(packet_info *pinfo, guint32 id, GHashTable *fragment_table,
+fragment_end_seq_next(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
                      GHashTable *reassembled_table);
 /* to specify how much to reassemble, for fragmentation where last fragment can not be
  * identified by flags or such.
@@ -228,12 +241,12 @@ fragment_end_seq_next(packet_info *pinfo, guint32 id, GHashTable *fragment_table
  *
  */
 extern void
-fragment_set_tot_len(packet_info *pinfo, guint32 id, GHashTable *fragment_table,
-                    guint32 tot_len);
+fragment_set_tot_len(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
+                    const guint32 tot_len);
 
 /* to resad whatever totlen previously set */
 extern guint32
-fragment_get_tot_len(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
+fragment_get_tot_len(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 
 /*
  * This function will set the partial reassembly flag(FD_PARTIAL_REASSEMBLY) for a fh.
@@ -244,21 +257,21 @@ fragment_get_tot_len(packet_info *pinfo, guint32 id, GHashTable *fragment_table)
  * and if FD_DEFRAGMENTED is set, the reassembly process will be continued.
  */
 extern void
-fragment_set_partial_reassembly(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
+fragment_set_partial_reassembly(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 
 /* This function is used to check if there is partial or completed reassembly state
  * matching this packet. I.e. Are there reassembly going on or not for this packet?
  */
 extern fragment_data *
-fragment_get(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
+fragment_get(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 
 /* The same for the reassemble table */
 /* id *must* be the frame number for this to work! */
 extern fragment_data *
-fragment_get_reassembled(packet_info *pinfo, guint32 id, GHashTable *reassembled_table);
+fragment_get_reassembled(const guint32 id, GHashTable *reassembled_table);
 
 extern fragment_data *
-fragment_get_reassembled_id(packet_info *pinfo, guint32 id, GHashTable *reassembled_table);
+fragment_get_reassembled_id(const packet_info *pinfo, const guint32 id, GHashTable *reassembled_table);
 
 /* This will free up all resources and delete reassembly state for this PDU.
  * Except if the PDU is completely reassembled, then it would NOT deallocate the
@@ -269,7 +282,7 @@ fragment_get_reassembled_id(packet_info *pinfo, guint32 id, GHashTable *reassemb
  * g_free() that buffer.
  */
 extern unsigned char *
-fragment_delete(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
+fragment_delete(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 
 /* hf_fragment, hf_fragment_error, and hf_reassembled_in should be
    FT_FRAMENUM, the others should be FT_BOOLEAN
@@ -285,13 +298,15 @@ typedef struct _fragment_items {
        int     *hf_fragment_multiple_tails;
        int     *hf_fragment_too_long_fragment;
        int     *hf_fragment_error;
+       int     *hf_fragment_count;
        int     *hf_reassembled_in;
+       int     *hf_reassembled_length;
 
        const char      *tag;
 } fragment_items;
 
 extern tvbuff_t *
-process_reassembled_data(tvbuff_t *tvb, int offset, packet_info *pinfo,
+process_reassembled_data(tvbuff_t *tvb, const int offset, packet_info *pinfo,
     const char *name, fragment_data *fd_head, const fragment_items *fit,
     gboolean *update_col_infop, proto_tree *tree);
 
@@ -302,3 +317,5 @@ show_fragment_tree(fragment_data *ipfd_head, const fragment_items *fit,
 extern gboolean
 show_fragment_seq_tree(fragment_data *ipfd_head, const fragment_items *fit,
     proto_tree *tree, packet_info *pinfo, tvbuff_t *tvb, proto_item **fi);
+
+#endif