epan/conversation.h

   1 /* conversation.h
   2  * Routines for building lists of packets that are part of a "conversation"
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  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.
  14  *
  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.
  19  *
  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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __CONVERSATION_H__
  26 #define __CONVERSATION_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         guint32 index;                          /** unique ID for conversation */
  76         guint32 setup_frame;            /** frame number that setup this conversation */
  77         GSList *data_list;                      /** list of data associated with conversation */
  78         dissector_handle_t dissector_handle;
  79                                                                 /** handle for protocol dissector client associated with conversation */
  80         guint   options;                        /** wildcard flags */
  81         conversation_key *key_ptr;      /** pointer to the key for this conversation */
  82 } conversation_t;
  83
  84 /**
  85  * Destroy all existing conversations
  86  */
  87 extern void conversation_cleanup(void);
  88
  89 /**
  90  * Initialize some variables every time a file is loaded or re-loaded.
  91  * Create a new hash table for the conversations in the new file.
  92  */
  93 extern void conversation_init(void);
  94
  95 /*
  96  * Given two address/port pairs for a packet, create a new conversation
  97  * to contain packets between those address/port pairs.
  98  *
  99  * The options field is used to specify whether the address 2 value
 100  * and/or port 2 value are not given and any value is acceptable
 101  * when searching for this conversation.
 102  */
 103 extern conversation_t *conversation_new(const guint32 setup_frame, const address *addr1, const address *addr2,
 104     const port_type ptype, const guint32 port1, const guint32 port2, const guint options);
 105
 106 /**
 107  * Given two address/port pairs for a packet, search for a conversation
 108  * containing packets between those address/port pairs.  Returns NULL if
 109  * not found.
 110  *
 111  * We try to find the most exact match that we can, and then proceed to
 112  * try wildcard matches on the "addr_b" and/or "port_b" argument if a more
 113  * exact match failed.
 114  *
 115  * Either or both of the "addr_b" and "port_b" arguments may be specified as
 116  * a wildcard by setting the NO_ADDR_B or NO_PORT_B flags in the "options"
 117  * argument.  We do only wildcard matches on addresses and ports specified
 118  * as wildcards.
 119  *
 120  * I.e.:
 121  *
 122  *      if neither "addr_b" nor "port_b" were specified as wildcards, we
 123  *      do an exact match (addr_a/port_a and addr_b/port_b) and, if that
 124  *      succeeds, we return a pointer to the matched conversation;
 125  *
 126  *      otherwise, if "port_b" wasn't specified as a wildcard, we try to
 127  *      match any address 2 with the specified port 2 (addr_a/port_a and
 128  *      {any}/addr_b) and, if that succeeds, we return a pointer to the
 129  *      matched conversation;
 130  *
 131  *      otherwise, if "addr_b" wasn't specified as a wildcard, we try to
 132  *      match any port 2 with the specified address 2 (addr_a/port_a and
 133  *      addr_b/{any}) and, if that succeeds, we return a pointer to the
 134  *      matched conversation;
 135  *
 136  *      otherwise, we try to match any address 2 and any port 2
 137  *      (addr_a/port_a and {any}/{any}) and, if that succeeds, we return
 138  *      a pointer to the matched conversation;
 139  *
 140  *      otherwise, we found no matching conversation, and return NULL.
 141  */
 142 extern conversation_t *find_conversation(const guint32 frame_num, const address *addr_a, const address *addr_b,
 143     const port_type ptype, const guint32 port_a, const guint32 port_b, const guint options);
 144
 145 /**  A helper function that calls find_conversation() and, if a conversation is
 146  *  not found, calls conversation_new().
 147  *  The frame number and addresses are taken from pinfo.
 148  *  No options are used, though we could extend this API to include an options
 149  *  parameter.
 150  */
 151 extern conversation_t *find_or_create_conversation(packet_info *pinfo);
 152
 153 extern void conversation_add_proto_data(conversation_t *conv, const int proto,
 154     void *proto_data);
 155 extern void *conversation_get_proto_data(const conversation_t *conv, const int proto);
 156 extern void conversation_delete_proto_data(conversation_t *conv, const int proto);
 157
 158 extern void conversation_set_dissector(conversation_t *conversation,
 159     const dissector_handle_t handle);
 160 /**
 161  * Given two address/port pairs for a packet, search for a matching
 162  * conversation and, if found and it has a conversation dissector,
 163  * call that dissector and return TRUE, otherwise return FALSE.
 164  *
 165  * This helper uses call_dissector_only which will NOT call the default
 166  * "data" dissector if the packet was rejected.
 167  * Our caller is responsible to call the data dissector explicitely in case
 168  * this function returns FALSE.
 169  */
 170 extern gboolean
 171 try_conversation_dissector(const address *addr_a, const address *addr_b, const port_type ptype,
 172     const guint32 port_a, const guint32 port_b, tvbuff_t *tvb, packet_info *pinfo,
 173     proto_tree *tree);
 174
 175 /* These routines are used to set undefined values for a conversation */
 176
 177 extern void conversation_set_port2(conversation_t *conv, const guint32 port);
 178 extern void conversation_set_addr2(conversation_t *conv, const address *addr);
 179
 180 #ifdef __cplusplus
 181 }
 182 #endif /* __cplusplus */
 183
 184 #endif /* conversation.h */