Add a pointer to the start frame of each gop in the gog's tree
[obnox/wireshark/wip.git] / plugins / mate / mate.h
1 /* mate.h
2 * MATE -- Meta Analysis and Tracing Engine 
3 *
4 * Copyright 2004, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
5 *
6 * $Id$
7 *
8 * Ethereal - Network traffic analyzer
9 * By Gerald Combs <gerald@ethereal.com>
10 * Copyright 1998 Gerald Combs
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
16
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 * GNU General Public License for more details.
21
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 */
26
27
28 #ifndef __MATE_H_
29 #define __MATE_H_
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #ifndef ENABLE_STATIC
36 #include "plugins/plugin_api.h"
37 #include "moduleinfo.h"
38 #include <gmodule.h>
39 #else 
40 #include <glib.h>
41 #endif
42
43 #include <stdio.h>
44 #include <string.h>
45 #include <errno.h>
46
47 #include <epan/packet.h>
48 #include <epan/strutil.h>
49 #include <epan/prefs.h>
50 #include <epan/proto.h>
51 #include <epan/epan_dissect.h>
52 #include <epan/tap.h>
53 #include <epan/filesystem.h>
54 #include <epan/report_err.h>
55
56 #include "mate_util.h"
57 #include "plugins/plugin_api_defs.h"
58
59
60 /* defaults */
61
62 #define DEFAULT_GOG_EXPIRATION 2.0
63
64 #ifdef WIN32
65 #define DIR_SEP '\\'
66 #else
67 #define DIR_SEP '/'
68 #endif
69
70 #define DEFAULT_MATE_LIB_PATH "matelib"
71
72 #define MATE_ITEM_ID_SIZE 24
73
74 /* Config AVP Names */
75 #define KEYWORD_ACTION "Action"
76 #define KEYWORD_SETTINGS "Settings"
77 #define KEYWORD_INCLUDE "Include"
78 #define KEYWORD_TRANSFORM "Transform"
79 #define KEYWORD_PDU "PduDef"
80 #define KEYWORD_PDUCRITERIA "PduCriteria"
81 #define KEYWORD_PDUEXTRA "PduExtra"
82 #define KEYWORD_PDUTRANSFORM "PduTransform"
83 #define KEYWORD_GOP "GopDef"
84 #define KEYWORD_GOPSTART "GopStart"
85 #define KEYWORD_GOPSTOP "GopStop"
86 #define KEYWORD_GOPEXTRA "GopExtra"
87 #define KEYWORD_GOPTRANSFORM "GopTransform"
88 #define KEYWORD_GOGDEF "GogDef"
89 #define KEYWORD_GOGKEY "GogKey"
90 #define KEYWORD_GOGEXTRA "GogExtra"
91 #define KEYWORD_GOGTRANSFORM "GogTransform"
92 #define KEYWORD_NAME "Name"
93 #define KEYWORD_ON "On"
94 #define KEYWORD_FOR "For"
95 #define KEYWORD_FROM "From"
96 #define KEYWORD_TO "To"
97 #define KEYWORD_MATCH "Match"
98 #define KEYWORD_MODE "Mode"
99 #define KEYWORD_FILENAME "Filename"
100 #define KEYWORD_PROTO "Proto"
101 #define KEYWORD_METHOD "Method"
102 #define KEYWORD_TRANSPORT "Transport"
103 #define KEYWORD_STRICT "Strict"
104 #define KEYWORD_LOOSE "Loose"
105 #define KEYWORD_EVERY "Every"
106 #define KEYWORD_REPLACE "Replace"
107 #define KEYWORD_INSERT "Insert"
108 #define KEYWORD_MAP "Map"
109 #define KEYWORD_GOGEXPIRE "GogExpiration"
110 #define KEYWORD_GOPTREE "GopTree"
111 #define KEYWORD_DISCARDPDU "DiscardPduData"
112 #define KEYWORD_LIBPATH "ThingLibPath"
113 #define KEYWORD_SHOWPDUTREE "ShowPduTree"
114 #define KEYWORD_SHOWGOPTIMES "ShowGopTimes"
115 #define KEYWORD_STOP "Stop"
116 #define KEYWORD_DROPGOP "DiscardUnassignedGop"
117 #define KEYWORD_DROPPDU "DiscardUnassignedPdu"
118 #define KEYWORD_LIB "Lib"
119 #define KEYWORD_ACCEPT "Accept"
120 #define KEYWORD_REJECT "Reject"
121 #define KEYWORD_NOTREE "NoTree"
122 #define KEYWORD_PDUTREE "PduTree"
123 #define KEYWORD_FRAMETREE "FrameTree"
124 #define KEYWORD_GOPEXPIRATION "GopExpiration"
125 #define KEYWORD_GOPIDLETIMEOUT "GopIdleTimeout"
126 #define KEYWORD_GOPLIFETIME "GopLifetime"
127
128 #define KEYWORD_DEBUGFILENAME "Debug_File"
129 #define KEYWORD_DBG_GENERAL "Debug_General"
130 #define KEYWORD_DBG_CFG "Debug_Cfg"
131 #define KEYWORD_DBG_PDU "Debug_PDU"
132 #define KEYWORD_DBG_GOP "Debug_Gop"
133 #define KEYWORD_DBG_GOG "Debug_Gog"
134 #ifdef _AVP_DEBUGGING
135 #define KEYWORD_DBG_AVPLIB "Debug_AVP_Lib"
136 #define KEYWORD_DBG_AVP "Debug_AVP"
137 #define KEYWORD_DBG_AVP_OP "Debug_AVP_Op"
138 #define KEYWORD_DBG_AVPL "Debug_AVPL"
139 #define KEYWORD_DBG_AVPL_OP "Debug_AVPL_Op"
140 #endif
141
142 #define VALUE_TOO ((void*)1)
143
144 typedef enum _mate_item_type {
145         MATE_UNK_TYPE,
146         MATE_PDU_TYPE,
147         MATE_GOP_TYPE,
148         MATE_GOG_TYPE
149 } mate_item_type;
150
151 typedef struct _mate_cfg_item mate_cfg_pdu;
152 typedef struct _mate_cfg_item mate_cfg_gop;
153 typedef struct _mate_cfg_item mate_cfg_gog;
154
155 typedef struct _mate_item mate_item;
156 typedef struct _mate_item mate_pdu;
157 typedef struct _mate_item mate_gop;
158 typedef struct _mate_item mate_gog;
159
160 typedef struct _mate_cfg_item {
161         guint8* name;
162         mate_item_type type; 
163         GPtrArray* transforms; /* transformations to be applied */
164         AVPL* extra; /* attributes to be added */
165         guint last_id; /* keeps the last id given to an item of this kind */
166         int hfid;
167         GHashTable* my_hfids; /* for creating register info */
168         GHashTable* items; /* all the items of this type */
169         gint ett;
170         gint ett_attr;
171         gint ett_times;
172         gint ett_children;
173                 
174         /* pdu */
175         gboolean discard_pdu_attributes;
176         gboolean last_to_be_created;
177         int hfid_proto;
178         GPtrArray* hfid_ranges; /* hfids of candidate ranges from which to extract attributes */
179         GHashTable* hfids_attr; /* k=hfid v=avp_name */
180         gboolean drop_pdu;
181         avpl_match_mode criterium_match_mode;
182         AVPL* criterium; /* must match to be created */
183         int hfid_pdu_rel_time;
184         int hfid_pdu_time_in_gop;
185         
186         
187         /* common to gop and gog */
188         float expiration;
189         int hfid_start_time;
190         int hfid_stop_time;
191         int hfid_last_time;
192         
193         /* gop */
194         AVPL* start; /* start candidate avpl */
195         AVPL* stop;  /* stop candidate avpl */
196         AVPL* key; /* key candidate avpl */
197         guint8* show_pdu_tree;
198         gboolean show_times;
199         gboolean drop_gop; 
200         float idle_timeout;
201         float lifetime; 
202         int hfid_gop_pdu;
203         int hfid_gop_num_pdus;
204         
205         GHashTable* gop_index;
206         GHashTable* gog_index;
207         
208         /* gog */
209         gboolean gop_as_subtree;
210         LoAL* keys;
211         int hfid_gog_num_of_gops;
212         int hfid_gog_gop;
213         int hfid_gog_gopstart;
214         gint ett_gog_gop;
215         
216 } mate_cfg_item;
217
218 typedef struct _mate_config {
219         /* current defaults */
220         float gog_expiration; /* default expirations for gogs if undefined in gog */
221         gboolean discard_pdu_attributes; /* destroy the pdu's avpl once analyzed */
222         gboolean drop_pdu; /* destroy the pdu if not assign to a gop */
223         gboolean drop_gop; /* destroy the gop if not assign to a gog */
224         guint8* mate_lib_path; /* where to look for "Include" files first */
225         guint8* show_pdu_tree;
226         gboolean show_times;
227         gboolean last_to_be_created;
228         avpl_match_mode match_mode;
229         avpl_replace_mode replace_mode;
230         gboolean gop_as_subtree;
231         int hfid_mate;
232         
233         float gop_expiration;
234         float gop_idle_timeout;
235         float gop_lifetime;
236         
237         guint8* accept;
238         guint8* reject;
239         
240         guint8* no_tree;
241         guint8* frame_tree;
242         guint8* pdu_tree;
243         
244         /* what to dbgprint */
245         int dbg_lvl;    
246         int dbg_cfg_lvl;
247         int dbg_pdu_lvl;
248         int dbg_gop_lvl;
249         int dbg_gog_lvl;
250         
251         guint8* mate_config_file; /* name of the config file */
252         GString* mate_attrs_filter; /* "ip.addr || dns.id || ... " for the tap */
253         GString* mate_protos_filter; /* "dns || ftp || ..." for the tap */
254         FILE* dbg_facility; /* where to dump dbgprint output g_message if null */
255         guint8* tap_filter;
256                         
257         GHashTable* pducfgs; /* k=pducfg->name v=pducfg */
258         GHashTable* gopcfgs; /* k=gopcfg->name v=gopcfg */
259         GHashTable* gogcfgs; /* k=gogcfg->name v=gogcfg */
260         GHashTable* transfs; /* k=transform->name v=transform */
261         
262         GPtrArray* pducfglist; /* pducfgs in order of "execution" */
263         GHashTable* gops_by_pduname; /* k=pducfg->name v=gopcfg */
264         GHashTable* gogs_by_gopname; /* k=gopname v=loal where avpl->name == matchedgop->name */
265
266         GArray* hfrs;
267         gint ett_root;
268         GArray* ett;
269 } mate_config;
270
271 typedef struct _mate_runtime_data {
272         guint current_items; /* a count of items */
273         GMemChunk* mate_items;
274         float now;
275         guint highest_analyzed_frame;
276         
277         GHashTable* frames; /* k=frame.num v=pdus */
278         
279 } mate_runtime_data;
280
281 /* these are used to contain information regarding pdus, gops and gogs */
282 struct _mate_item {
283         /* all three of them */
284         guint32 id; /* 1:1 -> saving a g_malloc */
285         mate_cfg_item* cfg; /* the type of this item */
286
287         AVPL* avpl; /* the attributes of the pdu/gop/gog */
288                 
289         mate_item* next; /* in pdu: next in gop; in gop: next in gog; in gog this doesn't make any sense yet */
290         
291         float expiration; /* when will it expire after release (all gops releases if gog)? */
292         float idle_expiration; /* when will it expire if no new pdus are assigned to it */
293         
294         /* on gop and gog: */
295         float start_time; /* time of start */
296         float release_time; /* when this gop/gog was released */
297         float last_time; /* the rel_time at which the last pdu has been added (to gop or gog's gop) */
298         
299         /* union _payload { */
300                 /* struct _pdu { */
301                         guint32 frame; /* wich frame I belog to? */
302                         mate_gop* gop; /* the gop the pdu belongs to (if any) */
303                         gboolean first; /* is this the first pdu in this frame? */
304                         gboolean is_start; /* this is the start pdu for this gop */
305                         gboolean is_stop; /* this is the stop pdu for this gop */
306                         gboolean after_release; /* this pdu comes after the stop */
307                         float rel_time; /* time since start of capture  */
308                         float time_in_gop; /* time since gop start */
309                         mate_pdu* next_in_frame; /* points to the next pdu in this frame */
310                 /* } pdu; */
311                 
312                 /* struct _gop { */
313                         /* membership* gogs; */
314                         mate_gog* gog; /* the gog of a gop */
315                         mate_pdu* pdus; /* pdus that belong to a gop (NULL in gog) */
316                         gboolean released; /* has this gop been released? */
317                         int num_of_pdus; /* how many gops a gog has? */
318                         int num_of_after_release_pdus;  /* how many pdus have arrived since it's been released */
319                         guint8* gop_key; /* used by gop */
320                         mate_pdu* last_pdu; /* last pdu in pdu's list */
321                         float time_to_die;
322                         float time_to_timeout;
323                 /* } gop; */
324                 
325                 /* struct _gog { */
326                         /* membership* gops; */
327                         mate_gop* gops; /* gops that belong to a gog (NULL in gop) */
328                         int num_of_gops; /* how many gops a gog has? */
329                         int num_of_counting_gops;  /* how many of them count for gog release */
330                         int num_of_released_gops;  /* how many of them have already been released */
331                         guint last_n; /* the number of attributes the avpl had the last time we checked */
332                         GPtrArray* gog_keys; /* the keys under which this gog is stored in the gogs hash */
333                         mate_gop* last_gop; /* last gop in gop's list */
334                 /* } gog; */
335         /* } o; */
336 };
337
338 /* from mate_runtime.c */
339 extern void initialize_mate_runtime(void);
340 extern mate_pdu* mate_get_pdus(guint32 framenum);
341 extern void mate_analyze_frame(packet_info *pinfo, proto_tree* tree);
342
343 /* from mate_setup.c */
344 extern mate_config* mate_make_config(guint8* filename, int mate_hfid);
345 extern mate_config* mate_cfg(void);
346
347 #endif