Refactor RTD stats.

Very similar to the refactoring of SRT stats, it provides more commonality of the stats for all GUI interfaces.  Currently implemented for TShark and GTK.  Affected dissectors: MEGACO, MGCP, Radius

Change-Id: Icb73a7e603dc3502b39bf696227fcaae37d4ed21
Reviewed-on: https://code.wireshark.org/review/8998
Petri-Dish: Michael Mann <mmann78@netscape.net>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>

1 files changed, 205 insertions, 0 deletions

diff --git a/epan/rtd_table.c b/epan/rtd_table.c
new file mode 100644
index 0000000000..a74a32adb2
--- /dev/null
+++ b/epan/rtd_table.c
@@ -0,0 +1,205 @@
+/* rtd_table.c
+ * Helper routines common to all RTD taps.
+ * Based on srt_table.c
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include "packet_info.h"
+#include "proto.h"
+#include "rtd_table.h"
+
+struct register_rtd {
+    int proto_id;              /* protocol id (0-indexed) */
+    const char* tap_listen_str;      /* string used in register_tap_listener (NULL to use protocol name) */
+    tap_packet_cb rtd_func;    /* function to be called for new incoming packets for RTD */
+    guint num_tables;
+    guint num_timestats;
+    const value_string* vs_type;
+    rtd_filter_check_cb filter_check;
+};
+
+int get_rtd_proto_id(register_rtd_t* rtd)
+{
+    if (!rtd) {
+        return -1;
+    }
+    return rtd->proto_id;
+}
+
+const char* get_rtd_tap_listener_name(register_rtd_t* rtd)
+{
+    return rtd->tap_listen_str;
+}
+
+tap_packet_cb get_rtd_packet_func(register_rtd_t* rtd)
+{
+    return rtd->rtd_func;
+}
+
+const value_string* get_rtd_value_string(register_rtd_t* rtd)
+{
+    return rtd->vs_type;
+}
+
+static GSList *registered_rtd_tables = NULL;
+
+static gint
+insert_sorted_by_table_name(gconstpointer aparam, gconstpointer bparam)
+{
+    const register_rtd_t *a = (register_rtd_t *)aparam;
+    const register_rtd_t *b = (register_rtd_t *)bparam;
+
+    return g_ascii_strcasecmp(proto_get_protocol_short_name(find_protocol_by_id(a->proto_id)), proto_get_protocol_short_name(find_protocol_by_id(b->proto_id)));
+}
+
+void
+register_rtd_table(const int proto_id, const char* tap_listener, guint num_tables, guint num_timestats, const value_string* vs_type,
+                   tap_packet_cb rtd_packet_func, rtd_filter_check_cb filter_check_cb)
+{
+    register_rtd_t *table;
+    DISSECTOR_ASSERT(rtd_packet_func);
+
+    table = g_new(register_rtd_t,1);
+
+    table->proto_id      = proto_id;
+    if (tap_listener != NULL)
+        table->tap_listen_str = tap_listener;
+    else
+        table->tap_listen_str = proto_get_protocol_filter_name(proto_id);
+    table->rtd_func      = rtd_packet_func;
+    table->num_tables = num_tables;
+    table->num_timestats = num_timestats;
+    table->vs_type = vs_type;
+    table->filter_check = filter_check_cb;
+
+    registered_rtd_tables = g_slist_insert_sorted(registered_rtd_tables, table, insert_sorted_by_table_name);
+}
+
+void free_rtd_table(register_rtd_t* rtd _U_, rtd_stat_table* table, rtd_gui_free_cb gui_callback, void *callback_data)
+{
+    guint i;
+
+    for (i = 0; i < table->num_rtds; i++)
+    {
+        g_free(table->time_stats[i].rtd);
+    }
+    g_free(table->time_stats);
+
+    /* Give GUI the first crack at it before we clean up */
+    if (gui_callback)
+        gui_callback(table, callback_data);
+}
+
+void reset_rtd_table(rtd_stat_table* table, rtd_gui_reset_cb gui_callback, void *callback_data)
+{
+    guint i = 0;
+
+    for (i = 0; i < table->num_rtds; i++)
+        memset(table->time_stats[i].rtd, 0, sizeof(timestat_t)*table->time_stats[i].num_timestat);
+
+    /* Give GUI the first crack at it before we clean up */
+    if (gui_callback)
+        gui_callback(table, callback_data);
+
+}
+
+register_rtd_t* get_rtd_table_by_name(const char* name)
+{
+    guint i, size = g_slist_length(registered_rtd_tables);
+    register_rtd_t* rtd;
+    GSList   *slist;
+
+    for (i = 0; i < size; i++) {
+        slist = g_slist_nth(registered_rtd_tables, i);
+        rtd = (register_rtd_t*)slist->data;
+
+        if (strcmp(name, proto_get_protocol_filter_name(rtd->proto_id)) == 0)
+            return rtd;
+    }
+
+    return NULL;
+}
+
+gchar* rtd_table_get_tap_string(register_rtd_t* rtd)
+{
+    GString *cmd_str = g_string_new(proto_get_protocol_filter_name(rtd->proto_id));
+    g_string_append(cmd_str, ",rtd");
+    return g_string_free(cmd_str, FALSE);
+}
+
+void rtd_table_get_filter(register_rtd_t* rtd, const char *opt_arg, const char **filter, char** err)
+{
+    gchar* cmd_str = rtd_table_get_tap_string(rtd);
+    guint len = strlen(cmd_str);
+    *filter=NULL;
+    *err=NULL;
+
+    if (!strncmp(opt_arg, cmd_str, len))
+    {
+        if (opt_arg[len] == ',')
+        {
+           *filter = opt_arg + len+1;
+        }
+	}
+
+    if (rtd->filter_check)
+        rtd->filter_check(opt_arg, filter, err);
+
+    g_free(cmd_str);
+}
+
+void rtd_table_dissector_init(register_rtd_t* rtd, rtd_stat_table* table, rtd_gui_init_cb gui_callback, void *callback_data)
+{
+    guint i;
+
+    table->num_rtds = rtd->num_tables;
+    table->time_stats = g_new0(rtd_timestat, rtd->num_tables);
+
+    for (i = 0; i < table->num_rtds; i++)
+    {
+        table->time_stats[i].num_timestat = rtd->num_timestats;
+        table->time_stats[i].rtd = g_new0(timestat_t, rtd->num_timestats);
+    }
+
+    if (gui_callback)
+        gui_callback(table, callback_data);
+}
+
+void rtd_table_iterate_tables(GFunc func, gpointer user_data)
+{
+    g_slist_foreach(registered_rtd_tables, func, user_data);
+}
+
+/*
+ * 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:
+ */