forked from osmocom/wireshark
![Michael Mann](/assets/img/avatar_default.png)
From Robert G. Jakabosky From me: cleanup so that it applies to trunk. svn path=/trunk/; revision=52798
470 lines
14 KiB
C
470 lines
14 KiB
C
/*
|
|
* wslua.h
|
|
*
|
|
* Wireshark's interface to the Lua Programming Language
|
|
*
|
|
* (c) 2006, Luis E. Garcia Ontanon <luis@ontanon.org>
|
|
* (c) 2007, Tamas Regos <tamas.regos@ericsson.com>
|
|
* (c) 2008, Balint Reczey <balint.reczey@ericsson.com>
|
|
*
|
|
* $Id$
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef _PACKET_LUA_H
|
|
#define _PACKET_LUA_H
|
|
|
|
#include <glib.h>
|
|
#include <errno.h>
|
|
#include <string.h>
|
|
#include <ctype.h>
|
|
#include <lua.h>
|
|
#include <lualib.h>
|
|
#include <lauxlib.h>
|
|
|
|
#include <wiretap/wtap.h>
|
|
|
|
#include <wsutil/report_err.h>
|
|
#include <wsutil/nstime.h>
|
|
|
|
#include <epan/packet.h>
|
|
#include <epan/strutil.h>
|
|
#include <epan/prefs.h>
|
|
#include <epan/proto.h>
|
|
#include <epan/epan_dissect.h>
|
|
#include <epan/tap.h>
|
|
#include <epan/filesystem.h>
|
|
#include <epan/funnel.h>
|
|
#include <epan/tvbparse.h>
|
|
#include <epan/epan.h>
|
|
|
|
#include "declare_wslua.h"
|
|
|
|
/** @file
|
|
* @ingroup wslua_group
|
|
*/
|
|
|
|
#define WSLUA_INIT_ROUTINES "init_routines"
|
|
#define WSLUA_PREFS_CHANGED "prefs_changed"
|
|
#define LOG_DOMAIN_LUA "wslua"
|
|
|
|
struct _wslua_tvb {
|
|
tvbuff_t* ws_tvb;
|
|
gboolean expired;
|
|
gboolean need_free;
|
|
};
|
|
|
|
struct _wslua_pinfo {
|
|
packet_info* ws_pinfo;
|
|
gboolean expired;
|
|
};
|
|
|
|
struct _wslua_tvbrange {
|
|
struct _wslua_tvb* tvb;
|
|
int offset;
|
|
int len;
|
|
};
|
|
|
|
struct _wslua_tw {
|
|
funnel_text_window_t* ws_tw;
|
|
gboolean expired;
|
|
};
|
|
|
|
typedef struct _wslua_field_t {
|
|
int hfid;
|
|
int ett;
|
|
char* name;
|
|
char* abbr;
|
|
char* blob;
|
|
enum ftenum type;
|
|
unsigned base;
|
|
const void* vs;
|
|
guint32 mask;
|
|
} wslua_field_t;
|
|
|
|
/**
|
|
* PREF_OBSOLETE is used for preferences that a module used to support
|
|
* but no longer supports; we give different error messages for them.
|
|
*/
|
|
typedef enum {
|
|
PREF_UINT,
|
|
PREF_BOOL,
|
|
PREF_ENUM,
|
|
PREF_STRING,
|
|
PREF_RANGE,
|
|
PREF_STATIC_TEXT,
|
|
PREF_OBSOLETE
|
|
} pref_type_t;
|
|
|
|
typedef struct _wslua_pref_t {
|
|
gchar* name;
|
|
gchar* label;
|
|
gchar* desc;
|
|
pref_type_t type;
|
|
union {
|
|
gboolean b;
|
|
guint u;
|
|
const gchar* s;
|
|
gint e;
|
|
range_t *r;
|
|
void* p;
|
|
} value;
|
|
union {
|
|
guint32 max_value; /**< maximum value of a range */
|
|
struct {
|
|
const enum_val_t *enumvals; /**< list of name & values */
|
|
gboolean radio_buttons; /**< TRUE if it should be shown as
|
|
radio buttons rather than as an
|
|
option menu or combo box in
|
|
the preferences tab */
|
|
} enum_info; /**< for PREF_ENUM */
|
|
} info; /**< display/text file information */
|
|
|
|
struct _wslua_pref_t* next;
|
|
struct _wslua_proto_t* proto;
|
|
} wslua_pref_t;
|
|
|
|
typedef struct _wslua_proto_t {
|
|
gchar* name;
|
|
gchar* desc;
|
|
int hfid;
|
|
int ett;
|
|
wslua_pref_t prefs;
|
|
int fields;
|
|
module_t *prefs_module;
|
|
dissector_handle_t handle;
|
|
gboolean is_postdissector;
|
|
} wslua_proto_t;
|
|
|
|
struct _wslua_distbl_t {
|
|
dissector_table_t table;
|
|
const gchar* name;
|
|
};
|
|
|
|
struct _wslua_col_info {
|
|
column_info* cinfo;
|
|
gint col;
|
|
gboolean expired;
|
|
};
|
|
|
|
struct _wslua_cols {
|
|
column_info* cinfo;
|
|
gboolean expired;
|
|
};
|
|
|
|
struct _wslua_private_table {
|
|
GHashTable *table;
|
|
gboolean is_allocated;
|
|
gboolean expired;
|
|
};
|
|
|
|
struct _wslua_treeitem {
|
|
proto_item* item;
|
|
proto_tree* tree;
|
|
gboolean expired;
|
|
};
|
|
|
|
typedef void (*tap_extractor_t)(lua_State*,const void*);
|
|
|
|
struct _wslua_tap {
|
|
gchar* name;
|
|
gchar* filter;
|
|
tap_extractor_t extractor;
|
|
lua_State* L;
|
|
int packet_ref;
|
|
int draw_ref;
|
|
int init_ref;
|
|
};
|
|
|
|
# define DIRECTORY_T GDir
|
|
# define FILE_T gchar
|
|
# define OPENDIR_OP(name) g_dir_open(name, 0, dir->dummy)
|
|
# define DIRGETNEXT_OP(dir) g_dir_read_name(dir)
|
|
# define GETFNAME_OP(file) (file);
|
|
# define CLOSEDIR_OP(dir) g_dir_close(dir)
|
|
|
|
struct _wslua_dir {
|
|
DIRECTORY_T* dir;
|
|
char* ext;
|
|
GError** dummy;
|
|
};
|
|
|
|
struct _wslua_progdlg {
|
|
funnel_progress_window_t* pw;
|
|
char* title;
|
|
char* task;
|
|
gboolean stopped;
|
|
};
|
|
|
|
typedef struct { const char* name; tap_extractor_t extractor; } tappable_t;
|
|
|
|
typedef struct {const gchar* str; enum ftenum id; } wslua_ft_types_t;
|
|
|
|
typedef wslua_pref_t* Pref;
|
|
typedef wslua_pref_t* Prefs;
|
|
typedef struct _wslua_field_t* ProtoField;
|
|
typedef struct _wslua_proto_t* Proto;
|
|
typedef struct _wslua_distbl_t* DissectorTable;
|
|
typedef dissector_handle_t Dissector;
|
|
typedef GByteArray* ByteArray;
|
|
typedef struct _wslua_tvb* Tvb;
|
|
typedef struct _wslua_tvbrange* TvbRange;
|
|
typedef struct _wslua_col_info* Column;
|
|
typedef struct _wslua_cols* Columns;
|
|
typedef struct _wslua_pinfo* Pinfo;
|
|
typedef struct _wslua_treeitem* TreeItem;
|
|
typedef address* Address;
|
|
typedef nstime_t* NSTime;
|
|
typedef gint64* Int64;
|
|
typedef guint64* UInt64;
|
|
typedef header_field_info** Field;
|
|
typedef field_info* FieldInfo;
|
|
typedef struct _wslua_tap* Listener;
|
|
typedef struct _wslua_tw* TextWindow;
|
|
typedef struct _wslua_progdlg* ProgDlg;
|
|
typedef wtap_dumper* Dumper;
|
|
typedef struct lua_pseudo_header* PseudoHeader;
|
|
typedef tvbparse_t* Parser;
|
|
typedef tvbparse_wanted_t* Rule;
|
|
typedef tvbparse_elem_t* Node;
|
|
typedef tvbparse_action_t* Shortcut;
|
|
typedef struct _wslua_main* WireShark;
|
|
typedef struct _wslua_dir* Dir;
|
|
typedef struct _wslua_private_table* PrivateTable;
|
|
|
|
/*
|
|
* toXxx(L,idx) gets a Xxx from an index (Lua Error if fails)
|
|
* checkXxx(L,idx) gets a Xxx from an index after calling check_code (No Lua Error if it fails)
|
|
* pushXxx(L,xxx) pushes an Xxx into the stack
|
|
* isXxx(L,idx) tests whether we have an Xxx at idx
|
|
* shiftXxx(L,idx) removes and returns an Xxx from idx only if it has a type of Xxx, returns NULL otherwise
|
|
* WSLUA_CLASS_DEFINE must be used with a trailing ';'
|
|
* (a dummy typedef is used to be syntactically correct)
|
|
*/
|
|
#define WSLUA_CLASS_DEFINE(C,check_code,push_code) \
|
|
C to##C(lua_State* L, int idx) { \
|
|
C* v = (C*)lua_touserdata (L, idx); \
|
|
if (!v) luaL_error(L, "bad argument %d (%s expected, got %s)", idx, #C, lua_typename(L, lua_type(L, idx))); \
|
|
return v ? *v : NULL; \
|
|
} \
|
|
C check##C(lua_State* L, int idx) { \
|
|
C* p; \
|
|
luaL_checktype(L,idx,LUA_TUSERDATA); \
|
|
p = (C*)luaL_checkudata(L, idx, #C); \
|
|
check_code; \
|
|
return p ? *p : NULL; \
|
|
} \
|
|
C* push##C(lua_State* L, C v) { \
|
|
C* p; \
|
|
luaL_checkstack(L,2,"Unable to grow stack\n"); \
|
|
p = (C*)lua_newuserdata(L,sizeof(C)); *p = v; \
|
|
luaL_getmetatable(L, #C); lua_setmetatable(L, -2); \
|
|
push_code; \
|
|
return p; \
|
|
}\
|
|
gboolean is##C(lua_State* L,int i) { \
|
|
void *p; \
|
|
if(!lua_isuserdata(L,i)) return FALSE; \
|
|
p = lua_touserdata(L, i); \
|
|
lua_getfield(L, LUA_REGISTRYINDEX, #C); \
|
|
if (p == NULL || !lua_getmetatable(L, i) || !lua_rawequal(L, -1, -2)) p=NULL; \
|
|
lua_pop(L, 2); \
|
|
return p ? TRUE : FALSE; \
|
|
} \
|
|
C shift##C(lua_State* L,int i) { \
|
|
C* p; \
|
|
if(!lua_isuserdata(L,i)) return NULL; \
|
|
p = (C*)lua_touserdata(L, i); \
|
|
lua_getfield(L, LUA_REGISTRYINDEX, #C); \
|
|
if (p == NULL || !lua_getmetatable(L, i) || !lua_rawequal(L, -1, -2)) p=NULL; \
|
|
lua_pop(L, 2); \
|
|
if (p) { lua_remove(L,i); return *p; }\
|
|
else return NULL;\
|
|
} \
|
|
typedef int dummy##C
|
|
|
|
#ifdef HAVE_LUA
|
|
|
|
#define WSLUA_REGISTER_CLASS(C) { \
|
|
/* check for existing class table in global */ \
|
|
lua_getglobal (L, #C); \
|
|
if (!lua_isnil (L, -1)) { \
|
|
fprintf(stderr, "ERROR: Attempt to register class '%s' which already exists in global Lua table\n", #C); \
|
|
exit(1); \
|
|
} \
|
|
lua_pop (L, 1); \
|
|
/* create new class method table and 'register' the class methods into it */ \
|
|
lua_newtable (L); \
|
|
wslua_setfuncs (L, C ## _methods, 0); \
|
|
/* add a method-table field named '__typeof' = the class name, this is used by the typeof() Lua func */ \
|
|
lua_pushstring(L, #C); \
|
|
lua_setfield(L, -2, "__typeof"); \
|
|
/* create a new metatable and register metamethods into it */ \
|
|
luaL_newmetatable (L, #C); \
|
|
wslua_setfuncs (L, C ## _meta, 0); \
|
|
/* add the '__gc' metamethod with a C-function named Class__gc */ \
|
|
/* this will force ALL wslua classes to have a Class__gc function defined, which is good */ \
|
|
lua_pushcfunction(L, C ## __gc); \
|
|
lua_setfield(L, -2, "__gc"); \
|
|
/* push a copy of the class methods table, and set it to be the metatable's __index field */ \
|
|
lua_pushvalue (L, -2); \
|
|
lua_setfield (L, -2, "__index"); \
|
|
/* push a copy of the class methods table, and set it to be the metatable's __metatable field, to hide metatable */ \
|
|
lua_pushvalue (L, -2); \
|
|
lua_setfield (L, -2, "__metatable"); \
|
|
/* pop the metatable */ \
|
|
lua_pop (L, 1); \
|
|
/* set the class methods table as the global class table */ \
|
|
lua_setglobal (L, #C); \
|
|
}
|
|
|
|
#define WSLUA_REGISTER_META(C) { \
|
|
/* check for existing metatable in registry */ \
|
|
luaL_getmetatable(L, #C); \
|
|
if (!lua_isnil (L, -1)) { \
|
|
fprintf(stderr, "ERROR: Attempt to register metatable '%s' which already exists in Lua registry\n", #C); \
|
|
exit(1); \
|
|
} \
|
|
lua_pop (L, 1); \
|
|
/* create a new metatable and register metamethods into it */ \
|
|
luaL_newmetatable (L, #C); \
|
|
wslua_setfuncs (L, C ## _meta, 0); \
|
|
/* add a metatable field named '__typeof' = the class name, this is used by the typeof() Lua func */ \
|
|
lua_pushstring(L, #C); \
|
|
lua_setfield(L, -2, "__typeof"); \
|
|
/* add the '__gc' metamethod with a C-function named Class__gc */ \
|
|
/* this will force ALL wslua classes to have a Class__gc function defined, which is good */ \
|
|
lua_pushcfunction(L, C ## __gc); \
|
|
lua_setfield(L, -2, "__gc"); \
|
|
/* pop the metatable */ \
|
|
lua_pop(L, 1); \
|
|
}
|
|
|
|
#define WSLUA_INIT(L) \
|
|
luaL_openlibs(L); \
|
|
wslua_register_classes(L); \
|
|
wslua_register_functions(L);
|
|
|
|
#endif
|
|
|
|
#define WSLUA_FUNCTION extern int
|
|
|
|
#define WSLUA_REGISTER_FUNCTION(name) { lua_pushcfunction(L, wslua_## name); lua_setglobal(L, #name); }
|
|
|
|
#define WSLUA_REGISTER extern int
|
|
|
|
#define WSLUA_METHOD static int
|
|
#define WSLUA_CONSTRUCTOR static int
|
|
#define WSLUA_ATTR_SET static int
|
|
#define WSLUA_ATTR_GET static int
|
|
#define WSLUA_METAMETHOD static int
|
|
|
|
#define WSLUA_METHODS static const luaL_Reg
|
|
#define WSLUA_META static const luaL_Reg
|
|
#define WSLUA_CLASS_FNREG(class,name) { #name, class##_##name }
|
|
#define WSLUA_CLASS_FNREG_ALIAS(class,aliasname,name) { #aliasname, class##_##name }
|
|
|
|
#define WSLUA_ERROR(name,error) { luaL_error(L, ep_strdup_printf("%s%s", #name ": " ,error) ); return 0; }
|
|
#define WSLUA_ARG_ERROR(name,attr,error) { luaL_argerror(L,WSLUA_ARG_ ## name ## _ ## attr, #name ": " error); return 0; }
|
|
#define WSLUA_OPTARG_ERROR(name,attr,error) { luaL_argerror(L,WSLUA_OPTARG_##name##_ ##attr, #name ": " error); return 0; }
|
|
|
|
#define WSLUA_REG_GLOBAL_BOOL(L,n,v) { lua_pushboolean(L,v); lua_setglobal(L,n); }
|
|
#define WSLUA_REG_GLOBAL_STRING(L,n,v) { lua_pushstring(L,v); lua_setglobal(L,n); }
|
|
#define WSLUA_REG_GLOBAL_NUMBER(L,n,v) { lua_pushnumber(L,v); lua_setglobal(L,n); }
|
|
|
|
#define WSLUA_RETURN(i) return (i);
|
|
|
|
#define WSLUA_API extern
|
|
|
|
#define NOP
|
|
#define FAIL_ON_NULL(s) if (! *p) luaL_argerror(L,idx,s)
|
|
|
|
/* Clears or marks references that connects Lua to Wireshark structures */
|
|
#define CLEAR_OUTSTANDING(C, marker, marker_val) void clear_outstanding_##C(void) { \
|
|
while (outstanding_##C->len) { \
|
|
C p = (C)g_ptr_array_remove_index_fast(outstanding_##C,0); \
|
|
if (p) { \
|
|
if (p->marker != marker_val) \
|
|
p->marker = marker_val; \
|
|
else \
|
|
g_free(p); \
|
|
} \
|
|
} \
|
|
}
|
|
|
|
#define WSLUA_CLASS_DECLARE(C) \
|
|
extern C to##C(lua_State* L, int idx); \
|
|
extern C check##C(lua_State* L, int idx); \
|
|
extern C* push##C(lua_State* L, C v); \
|
|
extern int C##_register(lua_State* L); \
|
|
extern gboolean is##C(lua_State* L,int i); \
|
|
extern C shift##C(lua_State* L,int i)
|
|
|
|
extern packet_info* lua_pinfo;
|
|
extern TreeItem lua_tree;
|
|
extern tvbuff_t* lua_tvb;
|
|
extern dissector_handle_t lua_data_handle;
|
|
extern gboolean lua_initialized;
|
|
extern int lua_dissectors_table_ref;
|
|
|
|
WSLUA_DECLARE_CLASSES()
|
|
WSLUA_DECLARE_FUNCTIONS()
|
|
|
|
extern lua_State* wslua_state(void);
|
|
|
|
extern gboolean wslua_optbool(lua_State* L, int n, gboolean def);
|
|
extern const gchar* lua_shiftstring(lua_State* L,int idx);
|
|
extern void wslua_setfuncs(lua_State *L, const luaL_Reg *l, int nup);
|
|
extern int dissect_lua(tvbuff_t* tvb, packet_info* pinfo, proto_tree* tree, void* data);
|
|
extern void wslua_prefs_changed(void);
|
|
extern void proto_register_lua(void);
|
|
extern GString* lua_register_all_taps(void);
|
|
extern void wslua_prime_dfilter(epan_dissect_t *edt);
|
|
extern void lua_prime_all_fields(proto_tree* tree);
|
|
|
|
extern int Proto_commit(lua_State* L);
|
|
|
|
extern Tvb* push_Tvb(lua_State* L, tvbuff_t* tvb);
|
|
extern void clear_outstanding_Tvb(void);
|
|
extern void clear_outstanding_TvbRange(void);
|
|
|
|
extern Pinfo* push_Pinfo(lua_State* L, packet_info* p);
|
|
extern void clear_outstanding_Pinfo(void);
|
|
extern void clear_outstanding_Column(void);
|
|
extern void clear_outstanding_Columns(void);
|
|
extern void clear_outstanding_PrivateTable(void);
|
|
|
|
extern TreeItem* push_TreeItem(lua_State* L, TreeItem ti);
|
|
extern void clear_outstanding_TreeItem(void);
|
|
|
|
extern void wslua_print_stack(char* s, lua_State* L);
|
|
|
|
extern int wslua_init(register_cb cb, gpointer client_data);
|
|
extern int wslua_cleanup(void);
|
|
|
|
extern tap_extractor_t wslua_get_tap_extractor(const gchar* name);
|
|
extern int wslua_set_tap_enums(lua_State* L);
|
|
|
|
extern int luaopen_bit(lua_State *L);
|
|
|
|
extern int wslua_is_field_available(lua_State* L, const char* field_abbr);
|
|
|
|
#endif
|