epan/conversation.h

   1 /* conversation.h
   2  * Routines for building lists of packets that are part of a "conversation"
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #ifndef __CONVERSATION_H__
  24 #define __CONVERSATION_H__
  25
  26 #include "ws_symbol_export.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 /**
  33  *@file
  34  */
  35 /*
  36  * Flags to pass to "conversation_new()" to indicate that the address 2
  37  * and/or port 2 values for the conversation should be wildcards.
  38  * The CONVERSATION_TEMPLATE option tells that any of the other supplied
  39  * port and / or address wildcards will be used to match an infinite number
  40  * of new connections to the conversation(s) that have the CONVERSATION_-
  41  * TEMPLATE flag set. Any conversation created without the CONVERSATION_-
  42  * TEMPLATE flag will be altered once the first connections (connection
  43  * oriented protocols only) to include the newly found information which
  44  * matched the wildcard options.
  45  */
  46 #define NO_ADDR2 0x01
  47 #define NO_PORT2 0x02
  48 #define NO_PORT2_FORCE 0x04
  49 #define CONVERSATION_TEMPLATE 0x08
  50
  51 /*
  52  * Flags to pass to "find_conversation()" to indicate that the address B
  53  * and/or port B search arguments are wildcards.
  54  */
  55 #define NO_ADDR_B 0x01
  56 #define NO_PORT_B 0x02
  57
  58 #include "packet.h"             /* for conversation dissector type */
  59
  60 /**
  61  * Data structure representing a conversation.
  62  */
  63 typedef struct conversation_key {
  64         struct conversation_key *next;
  65         address addr1;
  66         address addr2;
  67         port_type ptype;
  68         guint32 port1;
  69         guint32 port2;
  70 } conversation_key;
  71
  72 typedef struct conversation {
  73         struct conversation *next;      /** pointer to next conversation on hash chain */
  74         struct conversation *last;      /** pointer to the last conversation on hash chain */
  75         struct conversation *latest_found;
  76                                                                 /** pointer to the last conversation on hash chain */
  77         guint32 index;                          /** unique ID for conversation */
  78         guint32 setup_frame;            /** frame number that setup this conversation */
  79         /* Assume that setup_frame is also the lowest frame number for now. */
  80         guint32 last_frame;             /** highest frame number in this conversation */
  81         GSList *data_list;                      /** list of data associated with conversation */
  82         dissector_handle_t dissector_handle;
  83                                                                 /** handle for protocol dissector client associated with conversation */
  84         guint   options;                        /** wildcard flags */
  85         conversation_key *key_ptr;      /** pointer to the key for this conversation */
  86 } conversation_t;
  87
  88 /**
  89  * Destroy all existing conversations
  90  */
  91 extern void conversation_cleanup(void);
  92
  93 /**
  94  * Initialize some variables every time a file is loaded or re-loaded.
  95  * Create a new hash table for the conversations in the new file.
  96  */
  97 extern void conversation_init(void);
  98
  99 /*
 100  * Given two address/port pairs for a packet, create a new conversation
 101  * to contain packets between those address/port pairs.
 102  *
 103  * The options field is used to specify whether the address 2 value
 104  * and/or port 2 value are not given and any value is acceptable
 105  * when searching for this conversation.
 106  */
 107 WS_DLL_PUBLIC conversation_t *conversation_new(const guint32 setup_frame, const address *addr1, const address *addr2,
 108     const port_type ptype, const guint32 port1, const guint32 port2, const guint options);
 109
 110 /**
 111  * Given two address/port pairs for a packet, search for a conversation
 112  * containing packets between those address/port pairs.  Returns NULL if
 113  * not found.
 114  *
 115  * We try to find the most exact match that we can, and then proceed to
 116  * try wildcard matches on the "addr_b" and/or "port_b" argument if a more
 117  * exact match failed.
 118  *
 119  * Either or both of the "addr_b" and "port_b" arguments may be specified as
 120  * a wildcard by setting the NO_ADDR_B or NO_PORT_B flags in the "options"
 121  * argument.  We do only wildcard matches on addresses and ports specified
 122  * as wildcards.
 123  *
 124  * I.e.:
 125  *
 126  *      if neither "addr_b" nor "port_b" were specified as wildcards, we
 127  *      do an exact match (addr_a/port_a and addr_b/port_b) and, if that
 128  *      succeeds, we return a pointer to the matched conversation;
 129  *
 130  *      otherwise, if "port_b" wasn't specified as a wildcard, we try to
 131  *      match any address 2 with the specified port 2 (addr_a/port_a and
 132  *      {any}/addr_b) and, if that succeeds, we return a pointer to the
 133  *      matched conversation;
 134  *
 135  *      otherwise, if "addr_b" wasn't specified as a wildcard, we try to
 136  *      match any port 2 with the specified address 2 (addr_a/port_a and
 137  *      addr_b/{any}) and, if that succeeds, we return a pointer to the
 138  *      matched conversation;
 139  *
 140  *      otherwise, we try to match any address 2 and any port 2
 141  *      (addr_a/port_a and {any}/{any}) and, if that succeeds, we return
 142  *      a pointer to the matched conversation;
 143  *
 144  *      otherwise, we found no matching conversation, and return NULL.
 145  */
 146 WS_DLL_PUBLIC conversation_t *find_conversation(const guint32 frame_num, const address *addr_a, const address *addr_b,
 147     const port_type ptype, const guint32 port_a, const guint32 port_b, const guint options);
 148
 149 /**  A helper function that calls find_conversation() and, if a conversation is
 150  *  not found, calls conversation_new().
 151  *  The frame number and addresses are taken from pinfo.
 152  *  No options are used, though we could extend this API to include an options
 153  *  parameter.
 154  */
 155 WS_DLL_PUBLIC conversation_t *find_or_create_conversation(packet_info *pinfo);
 156
 157 WS_DLL_PUBLIC void conversation_add_proto_data(conversation_t *conv, const int proto,
 158     void *proto_data);
 159 WS_DLL_PUBLIC void *conversation_get_proto_data(const conversation_t *conv, const int proto);
 160 WS_DLL_PUBLIC void conversation_delete_proto_data(conversation_t *conv, const int proto);
 161
 162 WS_DLL_PUBLIC void conversation_set_dissector(conversation_t *conversation,
 163     const dissector_handle_t handle);
 164 /**
 165  * Given two address/port pairs for a packet, search for a matching
 166  * conversation and, if found and it has a conversation dissector,
 167  * call that dissector and return TRUE, otherwise return FALSE.
 168  *
 169  * This helper uses call_dissector_only which will NOT call the default
 170  * "data" dissector if the packet was rejected.
 171  * Our caller is responsible to call the data dissector explicitly in case
 172  * this function returns FALSE.
 173  */
 174 extern gboolean
 175 try_conversation_dissector(const address *addr_a, const address *addr_b, const port_type ptype,
 176     const guint32 port_a, const guint32 port_b, tvbuff_t *tvb, packet_info *pinfo,
 177     proto_tree *tree, void* data);
 178
 179 /* These routines are used to set undefined values for a conversation */
 180
 181 extern void conversation_set_port2(conversation_t *conv, const guint32 port);
 182 extern void conversation_set_addr2(conversation_t *conv, const address *addr);
 183
 184 WS_DLL_PUBLIC
 185 GHashTable *get_conversation_hashtable_exact(void);
 186
 187 WS_DLL_PUBLIC
 188 GHashTable *get_conversation_hashtable_no_addr2(void);
 189
 190 WS_DLL_PUBLIC
 191 GHashTable * get_conversation_hashtable_no_port2(void);
 192
 193 WS_DLL_PUBLIC
 194 GHashTable *get_conversation_hashtable_no_addr2_or_port2(void);
 195
 196
 197 #ifdef __cplusplus
 198 }
 199 #endif /* __cplusplus */
 200
 201 #endif /* conversation.h */