conversation_table.h

Go to the documentation of this file.

/* conversation_table.h
 * GUI independent helper routines common to all conversations taps.
 * Refactored original conversations_table by Ronnie Sahlberg
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include "tap.h"
#include "conversation.h"
#include <epan/wmem_scopes.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef uint32_t conv_id_t;
#define CONV_ID_UNSET UINT32_MAX
 
typedef enum {
    CONV_FT_SRC_ADDRESS, 
    CONV_FT_DST_ADDRESS, 
    CONV_FT_ANY_ADDRESS, 
    CONV_FT_SRC_PORT,    
    CONV_FT_DST_PORT,    
    CONV_FT_ANY_PORT     
} conv_filter_type_e;
 
 
typedef enum {
    CONV_DIR_A_TO_FROM_B,   
    CONV_DIR_A_TO_B,        
    CONV_DIR_A_FROM_B,      
    CONV_DIR_A_TO_FROM_ANY, 
    CONV_DIR_A_TO_ANY,      
    CONV_DIR_A_FROM_ANY,    
    CONV_DIR_ANY_TO_FROM_B, 
    CONV_DIR_ANY_TO_B,      
    CONV_DIR_ANY_FROM_B     
} conv_direction_e;
 
typedef struct _conversation_hash_t {
    GHashTable  *hashtable;       
    GArray      *conv_array;      
    void        *user_data;       
    unsigned    flags;            
} conv_hash_t;
 
typedef struct _conversation_key_t {
    address   addr1;    
    address   addr2;    
    uint32_t  port1;    
    uint32_t  port2;    
    conv_id_t conv_id;  
} conv_key_t;
 
typedef struct {
    address  myaddress; 
    uint32_t port;      
} endpoint_key_t;
 
/*
 * For backwards source compatibility.
 * Yes, G_DEPRECATED_FOR() has to be at the beginning, so that this
 * works with MSVC.
 */
G_DEPRECATED_FOR(endpoint_key_t)
typedef endpoint_key_t host_key_t;
 
struct _conversation_item_t;
typedef const char* (*conv_get_filter_type)(struct _conversation_item_t* item, conv_filter_type_e filter);
 
typedef struct _ct_dissector_info {
    conv_get_filter_type get_filter_type; 
} ct_dissector_info_t;
 
struct _endpoint_item_t;
 
typedef const char* (*endpoint_get_filter_type)(struct _endpoint_item_t* item, conv_filter_type_e filter_type);
 
typedef struct _et_dissector_info {
    endpoint_get_filter_type get_filter_type; 
} et_dissector_info_t;
 
/* For backwards source compatibility */
G_DEPRECATED_FOR(et_dissector_info_t)
typedef et_dissector_info_t hostlist_dissector_info_t;
 
#define CONV_FILTER_INVALID "INVALID"
 
 
struct register_ct;
typedef void (*conv_gui_init_cb)(struct register_ct* ct, const char *filter);
 
typedef void (*endpoint_gui_init_cb)(struct register_ct* ct, const char *filter);
 
typedef struct register_ct register_ct_t;
 
typedef struct _conversation_extension_tcp_t {
    uint64_t            flows;          
} conv_extension_tcp_t;
 
typedef struct _conversation_item_t {
    ct_dissector_info_t *dissector_info; 
    address             src_address;    
    address             dst_address;    
    conversation_type   ctype;          
    uint32_t            src_port;       
    uint32_t            dst_port;       
    conv_id_t           conv_id;        
    uint64_t            rx_frames;      
    uint64_t            tx_frames;      
    uint64_t            rx_bytes;       
    uint64_t            tx_bytes;       
    uint64_t            rx_frames_total;      
    uint64_t            tx_frames_total;      
    uint64_t            rx_bytes_total;       
    uint64_t            tx_bytes_total;       
    nstime_t            start_time;     
    nstime_t            stop_time;      
    nstime_t            start_abs_time; 
    bool filtered;                  
    conv_extension_tcp_t ext_tcp;      
} conv_item_t;
 
typedef struct _endpoint_item_t {
    et_dissector_info_t *dissector_info; 
    address myaddress;      
    endpoint_type etype;    
    uint32_t port;           
    uint64_t rx_frames;      
    uint64_t tx_frames;      
    uint64_t rx_bytes;       
    uint64_t tx_bytes;       
    uint64_t rx_frames_total;      
    uint64_t tx_frames_total;      
    uint64_t rx_bytes_total;       
    uint64_t tx_bytes_total;       
    bool modified;      
    bool filtered;      
} endpoint_item_t;
 
/* For backwards source compatibility */
G_DEPRECATED_FOR(endpoint_item_t)
typedef endpoint_item_t hostlist_talker_t;
 
#define ENDPOINT_TAP_PREFIX     "endpoints"
 
extern void conversation_table_init(void);
 
WS_DLL_PUBLIC void register_conversation_table(const int proto_id, bool hide_ports, tap_packet_cb conv_packet_func, tap_packet_cb endpoint_packet_func);
 
WS_DLL_PUBLIC bool get_conversation_hide_ports(register_ct_t* ct);
 
WS_DLL_PUBLIC int get_conversation_proto_id(register_ct_t* ct);
 
WS_DLL_PUBLIC tap_packet_cb get_conversation_packet_func(register_ct_t* ct);
 
WS_DLL_PUBLIC tap_packet_cb get_endpoint_packet_func(register_ct_t* ct);
 
/* For backwards source and binary compatibility */
G_DEPRECATED_FOR(get_endpoint_packet_func)
 
 
WS_DLL_PUBLIC tap_packet_cb get_hostlist_packet_func(register_ct_t* ct);
 
 
WS_DLL_PUBLIC register_ct_t* get_conversation_by_proto_id(int proto_id);
 
WS_DLL_PUBLIC void conversation_table_set_gui_info(conv_gui_init_cb init_cb);
 
WS_DLL_PUBLIC void endpoint_table_set_gui_info(endpoint_gui_init_cb init_cb);
 
/* For backwards source and binary compatibility */
G_DEPRECATED_FOR(endpoint_table_set_gui_info)
WS_DLL_PUBLIC void hostlist_table_set_gui_info(endpoint_gui_init_cb init_cb);
 
WS_DLL_PUBLIC void conversation_table_iterate_tables(wmem_foreach_func func, void* user_data);
 
WS_DLL_PUBLIC unsigned conversation_table_get_num(void);
 
WS_DLL_PUBLIC void reset_conversation_table_data(conv_hash_t *ch);
 
WS_DLL_PUBLIC void reset_endpoint_table_data(conv_hash_t *ch);
 
/* For backwards source and binary compatibility */
G_DEPRECATED_FOR(reset_endpoint_table_data)
 
 
WS_DLL_PUBLIC void reset_hostlist_table_data(conv_hash_t *ch);
 
WS_DLL_PUBLIC void dissector_conversation_init(const char *opt_arg, void* userdata);
 
WS_DLL_PUBLIC void dissector_endpoint_init(const char *opt_arg, void* userdata);
 
/* For backwards source and binary compatibility */
G_DEPRECATED_FOR(dissector_endpoint_init)
WS_DLL_PUBLIC void dissector_hostlist_init(const char *opt_arg, void* userdata);
 
WS_DLL_PUBLIC char *get_conversation_address(wmem_allocator_t *allocator, address *addr, bool resolve_names);
 
WS_DLL_PUBLIC char *get_conversation_port(wmem_allocator_t *allocator, uint32_t port, conversation_type ctype, bool resolve_names);
 
WS_DLL_PUBLIC char *get_endpoint_port(wmem_allocator_t *allocator, endpoint_item_t *item, bool resolve_names);
 
WS_DLL_PUBLIC char *get_conversation_filter(conv_item_t *conv_item, conv_direction_e direction);
 
WS_DLL_PUBLIC char *get_endpoint_filter(endpoint_item_t *endpoint_item);
 
/* For backwards source and binary compatibility */
G_DEPRECATED_FOR(get_endpoint_filter)
 
 
WS_DLL_PUBLIC char *get_hostlist_filter(endpoint_item_t *endpoint_item);
 
WS_DLL_PUBLIC void add_conversation_table_data(conv_hash_t *ch, const address *src, const address *dst,
    uint32_t src_port, uint32_t dst_port, int num_frames, int num_bytes, nstime_t *ts, nstime_t *abs_ts,
    ct_dissector_info_t *ct_info, conversation_type ctype);
 
WS_DLL_PUBLIC conv_item_t *
add_conversation_table_data_with_conv_id(conv_hash_t *ch, const address *src, const address *dst, uint32_t src_port,
    uint32_t dst_port, conv_id_t conv_id, int num_frames, int num_bytes,
    nstime_t *ts, nstime_t *abs_ts, ct_dissector_info_t *ct_info,
    conversation_type ctype);
 
WS_DLL_PUBLIC void
add_conversation_table_data_extended(conv_hash_t *ch, const address *src, const address *dst, uint32_t src_port,
    uint32_t dst_port, conv_id_t conv_id, int num_frames, int num_bytes,
    nstime_t *ts, nstime_t *abs_ts, ct_dissector_info_t *ct_info,
    conversation_type ctype, uint32_t frameid, int (*proto_conv_cb)(conversation_t *));
 
WS_DLL_PUBLIC void
add_conversation_table_data_ipv4_subnet(conv_hash_t *ch, const address *src, const address *dst, uint32_t src_port,
    uint32_t dst_port, conv_id_t conv_id, int num_frames, int num_bytes,
    nstime_t *ts, nstime_t *abs_ts, ct_dissector_info_t *ct_info,
    conversation_type ctype);
 
WS_DLL_PUBLIC void add_endpoint_table_data(conv_hash_t *ch, const address *addr,
    uint32_t port, bool sender, int num_frames, int num_bytes, et_dissector_info_t *et_info, endpoint_type etype);
 
WS_DLL_PUBLIC void add_endpoint_table_data_ipv4_subnet(conv_hash_t *ch, const address *addr,
    uint32_t port, bool sender, int num_frames, int num_bytes, et_dissector_info_t *et_info, endpoint_type etype);
 
/* For backwards source and binary compatibility */
G_DEPRECATED_FOR(add_endpoint_table_data)
WS_DLL_PUBLIC void add_hostlist_table_data(conv_hash_t *ch, const address *addr,
    uint32_t port, bool sender, int num_frames, int num_bytes, et_dissector_info_t *et_info, endpoint_type etype);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
/*
 * Editor modelines
 *
 * Local Variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * ex: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */