text: /* conversation.h
   * Routines for building lists of packets that are part of a "conversation"
   *
   * Wireshark - Network traffic analyzer
   * By Gerald Combs <gerald@wireshark.org>
   * Copyright 1998 Gerald Combs
   *
   * SPDX-License-Identifier: GPL-2.0-or-later
   */
  
  #ifndef __CONVERSATION_H__
  #define __CONVERSATION_H__
  
  #include "ws_symbol_export.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif /* __cplusplus */
  
  /**
   *@file
   */
  /*
   * Flags to pass to "conversation_new()" to indicate that the address 2
   * and/or port 2 values for the conversation should be wildcards.
   * The CONVERSATION_TEMPLATE option tells that any of the other supplied
   * port and / or address wildcards will be used to match an infinite number
   * of new connections to the conversation(s) that have the CONVERSATION_-
   * TEMPLATE flag set. Any conversation created without the CONVERSATION_-
   * TEMPLATE flag will be altered once the first connections (connection
   * oriented protocols only) to include the newly found information which
   * matched the wildcard options.
   */
  #define NO_ADDR2 0x01
  #define NO_PORT2 0x02
  #define NO_PORT2_FORCE 0x04
  #define CONVERSATION_TEMPLATE 0x08
  
  /*
   * Flags to pass to "find_conversation()" to indicate that the address B
   * and/or port B search arguments are wildcards.
   */
  #define NO_ADDR_B 0x01
  #define NO_PORT_B 0x02
  
  /* Flags to handle endpoints */
  #define USE_LAST_ENDPOINT 0x08      /* Use last endpoint created, regardless of type */
  
  #include "packet.h"		/* for conversation dissector type */
  
  /* Types of port numbers Wireshark knows about. */
  typedef enum {
  	ENDPOINT_NONE,			/* no endpoint */
  	ENDPOINT_SCTP,			/* SCTP */
  	ENDPOINT_TCP,			/* TCP */
  	ENDPOINT_UDP,			/* UDP */
  	ENDPOINT_DCCP,			/* DCCP */
  	ENDPOINT_IPX,			/* IPX sockets */
  	ENDPOINT_NCP,			/* NCP connection */
  	ENDPOINT_EXCHG,			/* Fibre Channel exchange */
  	ENDPOINT_DDP,			/* DDP AppleTalk connection */
  	ENDPOINT_SBCCS,			/* FICON */
  	ENDPOINT_IDP,			/* XNS IDP sockets */
  	ENDPOINT_TIPC,			/* TIPC PORT */
  	ENDPOINT_USB,			/* USB endpoint 0xffff means the host */
  	ENDPOINT_I2C,
  	ENDPOINT_IBQP,			/* Infiniband QP number */
  	ENDPOINT_BLUETOOTH,
  	ENDPOINT_TDMOP,
  	ENDPOINT_DVBCI,
  	ENDPOINT_ISO14443,
  	ENDPOINT_ISDN,			/* ISDN channel number */
  	ENDPOINT_H223,			/* H.223 logical channel number */
  	ENDPOINT_X25,			/* X.25 logical channel number */
  	ENDPOINT_IAX2,			/* IAX2 call id */
  	ENDPOINT_DLCI,			/* Frame Relay DLCI */
  	ENDPOINT_ISUP,			/* ISDN User Part CIC */
  	ENDPOINT_BICC,			/* BICC Circuit identifier */
  	ENDPOINT_GSMTAP,
  	ENDPOINT_IUUP
  } endpoint_type;
  
  /**
   * Data structure representing a conversation.
   */
  struct conversation_key;
  typedef struct conversation_key* conversation_key_t;
  
  typedef struct conversation {
  	struct conversation *next;	/** pointer to next conversation on hash chain */
  	struct conversation *last;	/** pointer to the last conversation on hash chain */
  	struct conversation *latest_found;
  								/** pointer to the last conversation on hash chain */
  	guint32	conv_index;				/** unique ID for conversation */
  	guint32 setup_frame;		/** frame number that setup this conversation */
  	/* Assume that setup_frame is also the lowest frame number for now. */
  	guint32 last_frame;		/** highest frame number in this conversation */
  	wmem_tree_t *data_list;			/** list of data associated with conversation */
  	wmem_tree_t *dissector_tree;
  								/** tree containing protocol dissector client associated with conversation */
  	guint	options;			/** wildcard flags */
  	conversation_key_t key_ptr;	/** pointer to the key for this conversation */
  } conversation_t;
  
  
  struct endpoint;
  typedef struct endpoint* endpoint_t;
  
  WS_DLL_PUBLIC address* conversation_key_addr1(const conversation_key_t key);
  WS_DLL_PUBLIC address* conversation_key_addr2(const conversation_key_t key);
  WS_DLL_PUBLIC guint32 conversation_key_port1(const conversation_key_t key);
  WS_DLL_PUBLIC guint32 conversation_key_port2(const conversation_key_t key);
  
  /**
   * Create a new hash tables for conversations.
   */
  extern void conversation_init(void);
  
  /**
   * Initialize some variables every time a file is loaded or re-loaded.
   */
  extern void conversation_epan_reset(void);
  
  /*
   * Given two address/port pairs for a packet, create a new conversation
   * to contain packets between those address/port pairs.
   *
   * The options field is used to specify whether the address 2 value
   * and/or port 2 value are not given and any value is acceptable
   * when searching for this conversation.
   */
  WS_DLL_PUBLIC conversation_t *conversation_new(const guint32 setup_frame, const address *addr1, const address *addr2,
      const endpoint_type etype, const guint32 port1, const guint32 port2, const guint options);
  
  WS_DLL_PUBLIC conversation_t *conversation_new_by_id(const guint32 setup_frame, const endpoint_type etype, const guint32 id, const guint options);
  
  /**
   * Given two address/port pairs for a packet, search for a conversation
   * containing packets between those address/port pairs.  Returns NULL if
   * not found.
   *
   * We try to find the most exact match that we can, and then proceed to
   * try wildcard matches on the "addr_b" and/or "port_b" argument if a more
   * exact match failed.
   *
   * Either or both of the "addr_b" and "port_b" arguments may be specified as
   * a wildcard by setting the NO_ADDR_B or NO_PORT_B flags in the "options"
   * argument.  We do only wildcard matches on addresses and ports specified
   * as wildcards.
   *
   * I.e.:
   *
   *	if neither "addr_b" nor "port_b" were specified as wildcards, we
   *	do an exact match (addr_a/port_a and addr_b/port_b) and, if that
   *	succeeds, we return a pointer to the matched conversation;
   *
   *	otherwise, if "port_b" wasn't specified as a wildcard, we try to
   *	match any address 2 with the specified port 2 (addr_a/port_a and
   *	{any}/addr_b) and, if that succeeds, we return a pointer to the
   *	matched conversation;
   *
   *	otherwise, if "addr_b" wasn't specified as a wildcard, we try to
   *	match any port 2 with the specified address 2 (addr_a/port_a and
   *	addr_b/{any}) and, if that succeeds, we return a pointer to the
   *	matched conversation;
   *
   *	otherwise, we try to match any address 2 and any port 2
   *	(addr_a/port_a and {any}/{any}) and, if that succeeds, we return
   *	a pointer to the matched conversation;
   *
   *	otherwise, we found no matching conversation, and return NULL.
   */
  WS_DLL_PUBLIC conversation_t *find_conversation(const guint32 frame_num, const address *addr_a, const address *addr_b,
      const endpoint_type etype, const guint32 port_a, const guint32 port_b, const guint options);
  
  WS_DLL_PUBLIC conversation_t *find_conversation_by_id(const guint32 frame, const endpoint_type etype, const guint32 id, const guint options);
  
  /**  A helper function that calls find_conversation() using data from pinfo
   *  The frame number and addresses are taken from pinfo.
   */
  WS_DLL_PUBLIC conversation_t *find_conversation_pinfo(packet_info *pinfo, const guint options);
  
  /**  A helper function that calls find_conversation() and, if a conversation is
   *  not found, calls conversation_new().
   *  The frame number and addresses are taken from pinfo.
   *  No options are used, though we could extend this API to include an options
   *  parameter.
   */
  WS_DLL_PUBLIC conversation_t *find_or_create_conversation(packet_info *pinfo);
  
  /**  A helper function that calls find_conversation_by_id() and, if a
   *  conversation is not found, calls conversation_new_by_id().
   *  The frame number is taken from pinfo.
   */
  WS_DLL_PUBLIC conversation_t *find_or_create_conversation_by_id(packet_info *pinfo, const endpoint_type etype, const guint32 id);
  
  WS_DLL_PUBLIC void conversation_add_proto_data(conversation_t *conv, const int proto,
      void *proto_data);
  WS_DLL_PUBLIC void *conversation_get_proto_data(const conversation_t *conv, const int proto);
  WS_DLL_PUBLIC void conversation_delete_proto_data(conversation_t *conv, const int proto);
  
  WS_DLL_PUBLIC void conversation_set_dissector(conversation_t *conversation,
      const dissector_handle_t handle);
  
  WS_DLL_PUBLIC void conversation_set_dissector_from_frame_number(conversation_t *conversation,
      const guint32 starting_frame_num, const dissector_handle_t handle);
  
  WS_DLL_PUBLIC dissector_handle_t conversation_get_dissector(conversation_t *conversation,
      const guint32 frame_num);
  
  WS_DLL_PUBLIC void conversation_create_endpoint(struct _packet_info *pinfo, address* addr1, address* addr2,
      endpoint_type etype, guint32 port1, guint32	port2, const guint options);
  
  WS_DLL_PUBLIC void conversation_create_endpoint_by_id(struct _packet_info *pinfo,
      endpoint_type etype, guint32 id, const guint options);
  
  WS_DLL_PUBLIC guint32 conversation_get_endpoint_by_id(struct _packet_info *pinfo,
      endpoint_type etype, const guint options);
  
  /**
   * Given two address/port pairs for a packet, search for a matching
   * conversation and, if found and it has a conversation dissector,
   * call that dissector and return TRUE, otherwise return FALSE.
   *
   * This helper uses call_dissector_only which will NOT call the default
   * "data" dissector if the packet was rejected.
   * Our caller is responsible to call the data dissector explicitly in case
   * this function returns FALSE.
   */
  WS_DLL_PUBLIC gboolean
  try_conversation_dissector(const address *addr_a, const address *addr_b, const endpoint_type etype,
      const guint32 port_a, const guint32 port_b, tvbuff_t *tvb, packet_info *pinfo,
      proto_tree *tree, void* data, const guint options);
  
  WS_DLL_PUBLIC gboolean
  try_conversation_dissector_by_id(const endpoint_type etype, const guint32 id, tvbuff_t *tvb,
      packet_info *pinfo, proto_tree *tree, void* data);
  
  /* These routines are used to set undefined values for a conversation */
  
  WS_DLL_PUBLIC
  void conversation_set_port2(conversation_t *conv, const guint32 port);
  WS_DLL_PUBLIC
  void conversation_set_addr2(conversation_t *conv, const address *addr);
  
  WS_DLL_PUBLIC
  wmem_map_t *get_conversation_hashtable_exact(void);
  
  WS_DLL_PUBLIC
  wmem_map_t *get_conversation_hashtable_no_addr2(void);
  
  WS_DLL_PUBLIC
  wmem_map_t * get_conversation_hashtable_no_port2(void);
  
  WS_DLL_PUBLIC
  wmem_map_t *get_conversation_hashtable_no_addr2_or_port2(void);
  
  /* Temporary function to handle port_type to endpoint_type conversion
     For now it's a 1-1 mapping, but the intention is to remove
     many of the port_type instances in favor of endpoint_type
  */
  WS_DLL_PUBLIC
  endpoint_type conversation_pt_to_endpoint_type(port_type pt);
  
  WS_DLL_PUBLIC guint
  conversation_hash_exact(gconstpointer v);
  
  /* Provide a wmem_alloced (NULL scope) hash string using HTML tags */
  WS_DLL_PUBLIC gchar*
  conversation_get_html_hash(const conversation_key_t key);
  
  #ifdef __cplusplus
  }
  #endif /* __cplusplus */
  
  #endif /* conversation.h */
  