FD.io VPP
v17.04.2-2-ga8f93f8
Vector Packet Processing
Main Page
Related Pages
Data Structures
Source
Files
Symbols
plugin.h
Go to the documentation of this file.
1
/*
2
* plugin.h: plugin handling
3
*
4
* Copyright (c) 2011 Cisco and/or its affiliates.
5
* Licensed under the Apache License, Version 2.0 (the "License");
6
* you may not use this file except in compliance with the License.
7
* You may obtain a copy of the License at:
8
*
9
* http://www.apache.org/licenses/LICENSE-2.0
10
*
11
* Unless required by applicable law or agreed to in writing, software
12
* distributed under the License is distributed on an "AS IS" BASIS,
13
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
* See the License for the specific language governing permissions and
15
* limitations under the License.
16
*/
17
18
#ifndef __included_plugin_h__
19
#define __included_plugin_h__
20
21
#include <
vlib/vlib.h
>
22
#include <
vlib/unix/unix.h
>
23
#include <sys/types.h>
24
#include <sys/stat.h>
25
#include <unistd.h>
26
27
/*
28
* vlib plugin scheme
29
*
30
* Almost anything which can be made to work in a vlib unix
31
* application will also work in a vlib plugin.
32
*
33
* The elf-section magic which registers static objects
34
* works so long as plugins are preset when the vlib unix process
35
* starts. But wait: there's more...
36
*
37
* If an application calls vlib_load_new_plugins() -- possibly after
38
* changing vlib_plugin_main.plugin_path / vlib_plugin_main.plugin_name_filter,
39
* -- new plugins will be loaded. That, in turn, allows considerable
40
* flexibility in terms of adding feature code or fixing bugs without
41
* requiring the data-plane process to restart.
42
*
43
* When the plugin mechanism loads a plugin, it uses dlsym to locate
44
* and call the plugin's function vlib_plugin_register() if it exists.
45
* A plugin which expects to be loaded after the vlib application
46
* starts uses this callback to modify the application. If vlib_plugin_register
47
* returns non-zero, the plugin mechanism dlclose()'s the plugin.
48
*
49
* Applications control the plugin search path and name filter by
50
* declaring the variables vlib_plugin_path and vlib_plugin_name_filter.
51
* libvlib.la supplies weak references for these symbols which
52
* effectively disable the scheme. In order for the elf-section magic to
53
* work, static plugins must be loaded at the earliest possible moment.
54
*
55
* An application can change these parameters at any time and call
56
* vlib_load_new_plugins().
57
*/
58
59
/* *INDENT-OFF* */
60
typedef
CLIB_PACKED
(
struct
{
61
u8
default_disabled;
62
const
char
version[32];
63
const
char
version_required[32];
64
const
char
*early_init;
65
const
char
*description;
66
}) vlib_plugin_registration_t;
67
/* *INDENT-ON* */
68
69
typedef
struct
70
{
71
u8
*
name
;
72
u8
*
filename
;
73
struct
stat file_info;
74
void
*
handle
;
75
76
/* plugin registration */
77
vlib_plugin_registration_t *
reg
;
78
char
*
version
;
79
}
plugin_info_t
;
80
81
typedef
struct
82
{
83
char
*
name
;
84
u8
is_disabled
;
85
u8
is_enabled
;
86
u8
skip_version_check
;
87
}
plugin_config_t
;
88
89
typedef
struct
90
{
91
/* loaded plugin info */
92
plugin_info_t
*
plugin_info
;
93
uword
*
plugin_by_name_hash
;
94
95
/* path and name filter */
96
u8
*
plugin_path
;
97
u8
*
plugin_name_filter
;
98
99
/* plugin configs and hash by name */
100
plugin_config_t
*
configs
;
101
uword
*
config_index_by_name
;
102
103
/* usual */
104
vlib_main_t
*
vlib_main
;
105
}
plugin_main_t
;
106
107
extern
plugin_main_t
vlib_plugin_main
;
108
109
clib_error_t
*
vlib_plugin_config
(
vlib_main_t
*
vm
,
unformat_input_t
* input);
110
int
vlib_plugin_early_init
(
vlib_main_t
*
vm
);
111
int
vlib_load_new_plugins
(
plugin_main_t
* pm,
int
from_early_init);
112
void
*
vlib_get_plugin_symbol
(
char
*plugin_name,
char
*symbol_name);
113
114
#define VLIB_PLUGIN_REGISTER() \
115
vlib_plugin_registration_t vlib_plugin_registration \
116
__attribute__((__section__(".vlib_plugin_registration")))
117
118
#endif
/* __included_plugin_h__ */
119
120
/*
121
* fd.io coding-style-patch-verification: ON
122
*
123
* Local Variables:
124
* eval: (c-set-style "gnu")
125
* End:
126
*/
plugin_main_t::configs
plugin_config_t * configs
Definition:
plugin.h:100
plugin_config_t
Definition:
plugin.h:81
plugin_info_t::filename
u8 * filename
Definition:
plugin.h:72
plugin_main_t::plugin_path
u8 * plugin_path
Definition:
plugin.h:96
plugin_main_t::plugin_name_filter
u8 * plugin_name_filter
Definition:
plugin.h:97
plugin_config_t::name
char * name
Definition:
plugin.h:83
vlib_plugin_main
plugin_main_t vlib_plugin_main
Definition:
plugin.c:23
vlib_plugin_config
clib_error_t * vlib_plugin_config(vlib_main_t *vm, unformat_input_t *input)
Definition:
plugin.c:466
plugin_main_t::vlib_main
vlib_main_t * vlib_main
Definition:
plugin.h:104
plugin_info_t::reg
vlib_plugin_registration_t * reg
Definition:
plugin.h:77
plugin_config_t::is_disabled
u8 is_disabled
Definition:
plugin.h:84
vlib_plugin_early_init
int vlib_plugin_early_init(vlib_main_t *vm)
Definition:
plugin.c:353
plugin_info_t::name
u8 * name
Definition:
plugin.h:71
plugin_main_t::config_index_by_name
uword * config_index_by_name
Definition:
plugin.h:101
unix.h
plugin_info_t::version
char * version
Definition:
plugin.h:78
unformat_input_t
struct _unformat_input_t unformat_input_t
plugin_main_t
Definition:
plugin.h:89
vlib_load_new_plugins
int vlib_load_new_plugins(plugin_main_t *pm, int from_early_init)
Definition:
plugin.c:236
plugin_main_t::plugin_info
plugin_info_t * plugin_info
Definition:
plugin.h:92
vm
vlib_main_t * vm
Definition:
buffer.c:276
vlib.h
vlib_get_plugin_symbol
void * vlib_get_plugin_symbol(char *plugin_name, char *symbol_name)
Definition:
plugin.c:31
uword
u64 uword
Definition:
types.h:112
clib_error_t
Definition:
error.h:75
plugin_info_t::handle
void * handle
Definition:
plugin.h:74
plugin_config_t::is_enabled
u8 is_enabled
Definition:
plugin.h:85
plugin_info_t
Definition:
plugin.h:69
u8
unsigned char u8
Definition:
types.h:56
vlib_main_t
Definition:
main.h:59
CLIB_PACKED
typedef CLIB_PACKED(struct{u8 default_disabled;const char version[32];const char version_required[32];const char *early_init;const char *description;}) vlib_plugin_registration_t
plugin_config_t::skip_version_check
u8 skip_version_check
Definition:
plugin.h:86
plugin_main_t::plugin_by_name_hash
uword * plugin_by_name_hash
Definition:
plugin.h:93
src
vlib
unix
plugin.h
Generated on Sat Jul 1 2017 12:01:50 for FD.io VPP by
1.8.11