/usr/include/libprelude/prelude-plugin.h is in libprelude-dev 4.1.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | /*****
*
* Copyright (C) 2001-2017 CS-SI. All Rights Reserved.
* Author: Yoann Vandoorselaere <yoann.v@prelude-ids.com>
*
* This file is part of the Prelude library.
*
* 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, 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 _LIBPRELUDE_PLUGIN_H
#define _LIBPRELUDE_PLUGIN_H
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include "prelude-list.h"
#include "prelude-option.h"
#ifdef __cplusplus
extern "C" {
#endif
#define PRELUDE_PLUGIN_API_VERSION 1
typedef struct prelude_plugin_entry prelude_plugin_entry_t;
typedef struct prelude_plugin_instance prelude_plugin_instance_t;
#define PRELUDE_PLUGIN_GENERIC \
prelude_plugin_entry_t *_pe; \
char *name; \
void (*destroy)(prelude_plugin_instance_t *pi, prelude_string_t *err)
typedef struct {
PRELUDE_PLUGIN_GENERIC;
} prelude_plugin_generic_t;
/*
* Hack for plugin preloading,
* without having the end program depend on ltdl.
*/
#ifdef PRELUDE_APPLICATION_USE_LIBTOOL2
# define lt_preloaded_symbols lt__PROGRAM__LTX_preloaded_symbols
#endif
/*
* LT_DLSYM_CONST has been defined during the libtool 2.2.10 -> 2.4
* transition. Use it to guess whether lt_preloaded_symbols is already
* defined by ltdl.h as a different kind of symbol.
*
* We use void * so that application requiring plugin preloading doesn't
* depend on libltdl headers and lib. In case the application doesn't
* use libltdl, plugin preloading can still be used throught libprelude
* preloading function.
*/
#ifndef LT_DLSYM_CONST
extern const void *lt_preloaded_symbols[];
#endif
#define PRELUDE_PLUGIN_SET_PRELOADED_SYMBOLS() \
prelude_plugin_set_preloaded_symbols(lt_preloaded_symbols)
#define PRELUDE_PLUGIN_OPTION_DECLARE_STRING_CB(prefix, type, name) \
static int prefix ## _set_ ## name(prelude_option_t *opt, const char *optarg, prelude_string_t *err, void *context) \
{ \
char *dup = NULL; \
type *ptr = prelude_plugin_instance_get_plugin_data(context); \
\
if ( optarg ) { \
dup = strdup(optarg); \
if ( ! dup ) \
return prelude_error_from_errno(errno); \
} \
\
if ( ptr->name ) \
free(ptr->name); \
\
ptr->name = dup; \
\
return 0; \
} \
\
\
static int prefix ## _get_ ## name(prelude_option_t *opt, prelude_string_t *out, void *context) \
{ \
type *ptr = prelude_plugin_instance_get_plugin_data(context); \
if ( ptr->name ) \
prelude_string_cat(out, ptr->name); \
\
return 0; \
}
/*
*
*/
#define prelude_plugin_get_name(p) (p)->name
#define prelude_plugin_set_name(p, str) (p)->name = (str)
#define prelude_plugin_set_destroy_func(p, func) (p)->destroy = func
/*
* Plugin need to call this function in order to get registered.
*/
void prelude_plugin_entry_set_plugin(prelude_plugin_entry_t *pe, prelude_plugin_generic_t *pl);
int prelude_plugin_set_activation_option(prelude_plugin_entry_t *pe, prelude_option_t *opt,
int (*commit)(prelude_plugin_instance_t *pi, prelude_string_t *err));
int prelude_plugin_instance_subscribe(prelude_plugin_instance_t *pi);
int prelude_plugin_instance_unsubscribe(prelude_plugin_instance_t *pi);
int prelude_plugin_new_instance(prelude_plugin_instance_t **pi,
prelude_plugin_generic_t *plugin, const char *name, void *data);
/*
*
*/
prelude_plugin_generic_t *prelude_plugin_search_by_name(prelude_list_t *head, const char *name);
prelude_plugin_instance_t *prelude_plugin_search_instance_by_name(prelude_list_t *head,
const char *pname, const char *iname);
void prelude_plugin_instance_set_data(prelude_plugin_instance_t *pi, void *data);
void *prelude_plugin_instance_get_data(prelude_plugin_instance_t *pi);
void prelude_plugin_instance_set_plugin_data(prelude_plugin_instance_t *pi, void *data);
void *prelude_plugin_instance_get_plugin_data(prelude_plugin_instance_t *pi);
const char *prelude_plugin_instance_get_name(prelude_plugin_instance_t *pi);
prelude_plugin_generic_t *prelude_plugin_instance_get_plugin(prelude_plugin_instance_t *pi);
/*
* Load all plugins in directory 'dirname'.
* The CB arguments will be called for each plugin that register
* (using the plugin_register function), then the application will
* have the ability to use plugin_register_for_use to tell it want
* to use this plugin.
*/
int prelude_plugin_load_from_dir(prelude_list_t *head,
const char *dirname, const char *symbol, void *ptr,
int (*subscribe)(prelude_plugin_instance_t *p),
void (*unsubscribe)(prelude_plugin_instance_t *pi));
/*
* Call this if you want to use this plugin.
*/
int prelude_plugin_instance_add(prelude_plugin_instance_t *pi, prelude_list_t *h);
void prelude_plugin_instance_del(prelude_plugin_instance_t *pi);
void prelude_plugin_instance_compute_time(prelude_plugin_instance_t *pi,
struct timeval *start, struct timeval *end);
int prelude_plugin_instance_call_commit_func(prelude_plugin_instance_t *pi, prelude_string_t *err);
prelude_bool_t prelude_plugin_instance_has_commit_func(prelude_plugin_instance_t *pi);
void prelude_plugin_set_preloaded_symbols(void *symlist);
prelude_plugin_generic_t *prelude_plugin_get_next(prelude_list_t *head, prelude_list_t **iter);
void prelude_plugin_unload(prelude_plugin_generic_t *plugin);
/*
*
*/
#define prelude_plugin_compute_stats(pi, func) do { \
struct timeval start, end; \
gettimeofday(&start, NULL); \
(func); \
gettimeofday(&end, NULL); \
prelude_plugin_instance_compute_time(&start, &end); \
} while(0)
/*
* Macro used to start a plugin.
*/
#define prelude_plugin_run(pi, type, member, ...) \
(((type *)prelude_plugin_instance_get_plugin(pi))->member(__VA_ARGS__))
#ifdef __cplusplus
}
#endif
#endif /* _LIBPRELUDE_PLUGIN_H */
|