4 * $Id: plugins.c,v 1.40 2001/11/04 22:14:42 guy Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
8 * Copyright 1999 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
47 #ifdef HAVE_SYS_STAT_H
51 #ifdef HAVE_SYS_TYPES_H
52 #include <sys/types.h>
59 #include "filesystem.h"
63 #ifdef PLUGINS_NEED_ADDRESS_TABLE
64 #include "conversation.h"
65 #include "packet-giop.h"
66 #include "plugins/plugin_table.h"
67 static plugin_address_table_t patable;
70 /* linked list of all plugins */
74 static gchar std_plug_dir[] = "/usr/lib/ethereal/plugins/" VERSION;
75 static gchar local_plug_dir[] = "/usr/local/lib/ethereal/plugins/" VERSION;
77 static gchar *user_plug_dir = NULL;
79 #define PLUGINS_DIR_NAME "plugins"
82 * add a new plugin to the list
85 * - ENOMEM : memory allocation problem
86 * - EEXIST : the same plugin (i.e. name/version) was already registered.
89 add_plugin(void *handle, gchar *name, gchar *version,
90 void (*reg_handoff)(void))
92 plugin *new_plug, *pt_plug;
94 pt_plug = plugin_list;
95 if (!pt_plug) /* the list is empty */
97 new_plug = (plugin *)g_malloc(sizeof(plugin));
98 if (new_plug == NULL) return ENOMEM;
99 plugin_list = new_plug;
105 /* check if the same name/version is already registered */
106 if (!strcmp(pt_plug->name, name) &&
107 !strcmp(pt_plug->version, version))
112 /* we found the last plugin in the list */
113 if (pt_plug->next == NULL) break;
115 pt_plug = pt_plug->next;
117 new_plug = (plugin *)g_malloc(sizeof(plugin));
118 if (new_plug == NULL) return ENOMEM;
119 pt_plug->next = new_plug;
122 new_plug->handle = handle;
123 new_plug->name = name;
124 new_plug->version = version;
125 new_plug->reg_handoff = reg_handoff;
126 new_plug->next = NULL;
131 * XXX - when we remove support for old-style plugins (which we should
132 * probably do eventually, as all plugins should be written as new-style
133 * ones), we may want to have "init_plugins()" merely save a pointer
134 * to the plugin's "init" routine, just as we save a pointer to its
135 * "reg_handoff" routine, and have a "register_all_plugins()" routine
136 * to go through the list of plugins and call all of them.
138 * Then we'd have "epan_init()", or perhaps even something higher up
139 * in the call tree, call "init_plugins()", and have "proto_init()"
140 * call "register_all_plugins()" right after calling "register_all_protocols()";
141 * this might be a bit cleaner.
144 plugins_scan_dir(const char *dirname)
146 #define FILENAME_LEN 1024
147 gchar *hack_path; /* pathname used to construct lt_lib_ext */
148 gchar *lt_lib_ext; /* extension for loadable modules */
149 DIR *dir; /* scanned directory */
150 struct dirent *file; /* current file */
151 gchar filename[FILENAME_LEN]; /* current file name */
152 GModule *handle; /* handle returned by dlopen */
155 void (*init)(void *);
156 void (*reg_handoff)(void);
161 * We find the extension used on this platform for loadable modules
162 * by the sneaky hack of calling "g_module_build_path" to build
163 * the pathname for a module with an empty directory name and
164 * empty module name, and then search for the last "." and use
165 * everything from the last "." on.
167 * GLib 2.0 will probably define G_MODULE_SUFFIX as the extension
168 * to use, but that's not checked into the GLib CVS tree yet,
169 * and we can't use it on systems that don't have GLib 2.0.
171 hack_path = g_module_build_path("", "");
172 lt_lib_ext = strrchr(hack_path, '.');
173 if (lt_lib_ext == NULL)
176 * Does this mean there *is* no extension? Assume so.
178 * XXX - the code below assumes that all loadable modules have
184 if ((dir = opendir(dirname)) != NULL)
186 while ((file = readdir(dir)) != NULL)
188 /* don't try to open "." and ".." */
189 if (!(strcmp(file->d_name, "..") &&
190 strcmp(file->d_name, "."))) continue;
192 /* skip anything but files with lt_lib_ext */
193 dot = strrchr(file->d_name, '.');
194 if (dot == NULL || strcmp(dot, lt_lib_ext) != 0) continue;
196 snprintf(filename, FILENAME_LEN, "%s" G_DIR_SEPARATOR_S "%s",
197 dirname, file->d_name);
198 if ((handle = g_module_open(filename, 0)) == NULL) continue;
199 name = (gchar *)file->d_name;
200 if (g_module_symbol(handle, "version", (gpointer*)&version) == FALSE)
202 g_warning("The plugin %s has no version symbol", name);
203 g_module_close(handle);
208 * Old-style dissectors don't have a "plugin_reg_handoff()"
209 * routine; we no longer support them.
211 * New-style dissectors have one, because, otherwise, there's
212 * no way for them to arrange that they ever be called.
214 if (g_module_symbol(handle, "plugin_reg_handoff",
215 (gpointer*)®_handoff))
218 * We require it to have a "plugin_init()" routine.
220 if (!g_module_symbol(handle, "plugin_init", (gpointer*)&init))
222 g_warning("The plugin %s has a plugin_reg_handoff symbol but no plugin_init routine", name);
223 g_module_close(handle);
228 * We have a "plugin_reg_handoff()" routine, so we don't
229 * need the protocol, filter string, or dissector pointer.
231 if ((cr = add_plugin(handle, g_strdup(file->d_name), version,
235 fprintf(stderr, "The plugin %s, version %s\n"
236 "was found in multiple directories\n", name, version);
238 fprintf(stderr, "Memory allocation problem\n"
239 "when processing plugin %s, version %s\n",
241 g_module_close(handle);
246 * Call its init routine.
248 #ifdef PLUGINS_NEED_ADDRESS_TABLE
257 * This is an old-style dissector; warn that it won't
258 * be used, as those aren't supported.
261 "The plugin %s, version %s is an old-style plugin;\n"
262 "Those are no longer supported.\n", name, version);
274 init_plugins(const char *plugin_dir)
277 const char *datafile_dir;
278 char *install_plugin_dir;
280 struct stat std_dir_stat, local_dir_stat, plugin_dir_stat;
283 if (plugin_list == NULL) /* ensure init_plugins is only run once */
285 #ifdef PLUGINS_NEED_ADDRESS_TABLE
286 /* Intialize address table */
289 patable.p_check_col = check_col;
290 patable.p_col_clear = col_clear;
291 patable.p_col_add_fstr = col_add_fstr;
292 patable.p_col_append_fstr = col_append_fstr;
293 patable.p_col_add_str = col_add_str;
294 patable.p_col_append_str = col_append_str;
295 patable.p_col_set_str = col_set_str;
297 patable.p_register_init_routine = register_init_routine;
298 patable.p_conv_dissector_add = conv_dissector_add;
299 patable.p_conversation_new = conversation_new;
300 patable.p_find_conversation = find_conversation;
301 patable.p_match_strval = match_strval;
302 patable.p_val_to_str = val_to_str;
304 patable.p_proto_register_protocol = proto_register_protocol;
305 patable.p_proto_register_field_array = proto_register_field_array;
306 patable.p_proto_register_subtree_array = proto_register_subtree_array;
308 patable.p_dissector_add = dissector_add;
309 patable.p_dissector_delete = dissector_delete;
311 patable.p_heur_dissector_add = heur_dissector_add;
313 patable.p_register_dissector = register_dissector;
314 patable.p_find_dissector = find_dissector;
315 patable.p_call_dissector = call_dissector;
317 patable.p_dissect_data = dissect_data;
319 patable.p_proto_is_protocol_enabled = proto_is_protocol_enabled;
321 patable.p_proto_item_get_len = proto_item_get_len;
322 patable.p_proto_item_set_len = proto_item_set_len;
323 patable.p_proto_item_set_text = proto_item_set_text;
324 patable.p_proto_item_append_text = proto_item_append_text;
325 patable.p_proto_item_add_subtree = proto_item_add_subtree;
326 patable.p_proto_tree_add_item = proto_tree_add_item;
327 patable.p_proto_tree_add_item_hidden = proto_tree_add_item_hidden;
328 patable.p_proto_tree_add_protocol_format = proto_tree_add_protocol_format;
329 patable.p_proto_tree_add_bytes = proto_tree_add_bytes;
330 patable.p_proto_tree_add_bytes_hidden = proto_tree_add_bytes_hidden;
331 patable.p_proto_tree_add_bytes_format = proto_tree_add_bytes_format;
332 patable.p_proto_tree_add_time = proto_tree_add_time;
333 patable.p_proto_tree_add_time_hidden = proto_tree_add_time_hidden;
334 patable.p_proto_tree_add_time_format = proto_tree_add_time_format;
335 patable.p_proto_tree_add_ipxnet = proto_tree_add_ipxnet;
336 patable.p_proto_tree_add_ipxnet_hidden = proto_tree_add_ipxnet_hidden;
337 patable.p_proto_tree_add_ipxnet_format = proto_tree_add_ipxnet_format;
338 patable.p_proto_tree_add_ipv4 = proto_tree_add_ipv4;
339 patable.p_proto_tree_add_ipv4_hidden = proto_tree_add_ipv4_hidden;
340 patable.p_proto_tree_add_ipv4_format = proto_tree_add_ipv4_format;
341 patable.p_proto_tree_add_ipv6 = proto_tree_add_ipv6;
342 patable.p_proto_tree_add_ipv6_hidden = proto_tree_add_ipv6_hidden;
343 patable.p_proto_tree_add_ipv6_format = proto_tree_add_ipv6_format;
344 patable.p_proto_tree_add_ether = proto_tree_add_ether;
345 patable.p_proto_tree_add_ether_hidden = proto_tree_add_ether_hidden;
346 patable.p_proto_tree_add_ether_format = proto_tree_add_ether_format;
347 patable.p_proto_tree_add_string = proto_tree_add_string;
348 patable.p_proto_tree_add_string_hidden = proto_tree_add_string_hidden;
349 patable.p_proto_tree_add_string_format = proto_tree_add_string_format;
350 patable.p_proto_tree_add_boolean = proto_tree_add_boolean;
351 patable.p_proto_tree_add_boolean_hidden = proto_tree_add_boolean_hidden;
352 patable.p_proto_tree_add_boolean_format = proto_tree_add_boolean_format;
353 patable.p_proto_tree_add_double = proto_tree_add_double;
354 patable.p_proto_tree_add_double_hidden = proto_tree_add_double_hidden;
355 patable.p_proto_tree_add_double_format = proto_tree_add_double_format;
356 patable.p_proto_tree_add_uint = proto_tree_add_uint;
357 patable.p_proto_tree_add_uint_hidden = proto_tree_add_uint_hidden;
358 patable.p_proto_tree_add_uint_format = proto_tree_add_uint_format;
359 patable.p_proto_tree_add_int = proto_tree_add_int;
360 patable.p_proto_tree_add_int_hidden = proto_tree_add_int_hidden;
361 patable.p_proto_tree_add_int_format = proto_tree_add_int_format;
362 patable.p_proto_tree_add_text = proto_tree_add_text;
364 patable.p_tvb_new_subset = tvb_new_subset;
366 patable.p_tvb_length = tvb_length;
367 patable.p_tvb_length_remaining = tvb_length_remaining;
368 patable.p_tvb_bytes_exist = tvb_bytes_exist;
369 patable.p_tvb_offset_exists = tvb_offset_exists;
370 patable.p_tvb_reported_length = tvb_reported_length;
371 patable.p_tvb_reported_length_remaining = tvb_reported_length_remaining;
373 patable.p_tvb_get_guint8 = tvb_get_guint8;
375 patable.p_tvb_get_ntohs = tvb_get_ntohs;
376 patable.p_tvb_get_ntoh24 = tvb_get_ntoh24;
377 patable.p_tvb_get_ntohl = tvb_get_ntohl;
379 patable.p_tvb_get_letohs = tvb_get_letohs;
380 patable.p_tvb_get_letoh24 = tvb_get_letoh24;
381 patable.p_tvb_get_letohl = tvb_get_letohl;
383 patable.p_tvb_memcpy = tvb_memcpy;
384 patable.p_tvb_memdup = tvb_memdup;
386 patable.p_tvb_get_ptr = tvb_get_ptr;
388 patable.p_tvb_find_guint8 = tvb_find_guint8;
389 patable.p_tvb_pbrk_guint8 = tvb_pbrk_guint8;
391 patable.p_tvb_strnlen = tvb_strnlen;
393 patable.p_tvb_format_text = tvb_format_text;
395 patable.p_tvb_get_nstringz = tvb_get_nstringz;
396 patable.p_tvb_get_nstringz0 = tvb_get_nstringz0;
398 patable.p_tvb_find_line_end = tvb_find_line_end;
399 patable.p_tvb_find_line_end_unquoted = tvb_find_line_end_unquoted;
401 patable.p_tvb_strneql = tvb_strneql;
402 patable.p_tvb_strncaseeql = tvb_strncaseeql;
404 patable.p_tvb_bytes_to_str = tvb_bytes_to_str;
406 patable.p_prefs_register_protocol = prefs_register_protocol;
407 patable.p_prefs_register_uint_preference = prefs_register_uint_preference;
408 patable.p_prefs_register_bool_preference = prefs_register_bool_preference;
409 patable.p_prefs_register_enum_preference = prefs_register_enum_preference;
410 patable.p_prefs_register_string_preference = prefs_register_string_preference;
412 patable.p_register_giop_user = register_giop_user;
413 patable.p_is_big_endian = is_big_endian;
414 patable.p_get_CDR_string = get_CDR_string;
415 patable.p_get_CDR_ulong = get_CDR_ulong;
416 patable.p_get_CDR_enum = get_CDR_enum;
417 patable.p_get_CDR_object = get_CDR_object;
418 patable.p_get_CDR_boolean = get_CDR_boolean;
423 * On Windows, the data file directory is the installation
424 * directory; the plugins are stored under it.
426 * Assume we're running the installed version of Ethereal;
427 * on Windows, the data file directory is the directory
428 * in which the Ethereal binary resides.
430 datafile_dir = get_datafile_dir();
431 install_plugin_dir = g_malloc(strlen(datafile_dir) + strlen("plugins") +
432 strlen(VERSION) + 3);
433 sprintf(install_plugin_dir, "%s\\plugins\\%s", datafile_dir, VERSION);
436 * Make sure that pathname refers to a directory.
438 if (test_for_directory(install_plugin_dir) != EISDIR) {
440 * Either it doesn't refer to a directory or it
441 * refers to something that doesn't exist.
443 * Assume that means we're running, for example,
444 * a version of Ethereal we've built in a source
445 * directory, and fall back on the default
446 * installation directory, so you can put the plugins
447 * somewhere so they can be used with this version
450 * XXX - should we, instead, have the Windows build
451 * procedure create a subdirectory of the "plugins"
452 * source directory, and copy the plugin DLLs there,
453 * so that you use the plugins from the build tree?
456 g_strdup("C:\\Program Files\\Ethereal\\plugins\\" VERSION);
460 * Scan that directory.
462 plugins_scan_dir(install_plugin_dir);
463 g_free(install_plugin_dir);
466 * XXX - why not just scan "plugin_dir"? That's where we
467 * installed the plugins; if Ethereal isn't installed under
468 * "/usr" or "/usr/local", why should we search for its plugins
471 plugins_scan_dir(std_plug_dir);
472 plugins_scan_dir(local_plug_dir);
473 if ((strcmp(std_plug_dir, plugin_dir) != 0) &&
474 (strcmp(local_plug_dir, plugin_dir) != 0))
476 if (stat(plugin_dir, &plugin_dir_stat) == 0)
478 /* check if plugin_dir is really different from std_dir and
479 * local_dir if they exist ! */
480 if (stat(std_plug_dir, &std_dir_stat) == 0)
482 if (stat(local_plug_dir, &local_dir_stat) == 0)
484 if ((plugin_dir_stat.st_dev != std_dir_stat.st_dev ||
485 plugin_dir_stat.st_ino != std_dir_stat.st_ino) &&
486 (plugin_dir_stat.st_dev != local_dir_stat.st_dev ||
487 plugin_dir_stat.st_ino != local_dir_stat.st_ino))
488 plugins_scan_dir(plugin_dir);
492 if ((plugin_dir_stat.st_dev != std_dir_stat.st_dev ||
493 plugin_dir_stat.st_ino != std_dir_stat.st_ino))
494 plugins_scan_dir(plugin_dir);
497 else if (stat(local_plug_dir, &local_dir_stat) == 0)
499 if ((plugin_dir_stat.st_dev != local_dir_stat.st_dev ||
500 plugin_dir_stat.st_ino != local_dir_stat.st_ino))
501 plugins_scan_dir(plugin_dir);
503 else plugins_scan_dir(plugin_dir);
508 user_plug_dir = get_persconffile_path(PLUGINS_DIR_NAME, FALSE);
509 plugins_scan_dir(user_plug_dir);
514 register_all_plugin_handoffs(void)
519 * For all new-style plugins, call the register-handoff routine.
520 * This is called from "proto_init()"; it must be called after
521 * "register_all_protocols()" and "init_plugins()" are called,
522 * in case one plugin registers itself either with a built-in
523 * dissector or with another plugin; we must first register all
524 * dissectors, whether built-in or plugin, so their dissector tables
525 * are initialized, and only then register all handoffs.
527 * We treat those protocols as always being enabled; they should
528 * use the standard mechanism for enabling/disabling protocols, not
529 * the plugin-specific mechanism.
531 for (pt_plug = plugin_list; pt_plug != NULL; pt_plug = pt_plug->next)
532 (pt_plug->reg_handoff)();