/*
* Copyright (c) 2015 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* plugin.c: plugin handling
*/
#include <vat/vat.h>
#include <vat/plugin.h>
#include <dlfcn.h>
#include <dirent.h>
plugin_main_t vat_plugin_main;
static int
load_one_plugin (plugin_main_t * pm, plugin_info_t * pi)
{
void *handle, *register_handle;
clib_error_t *(*fp) (vat_main_t *);
clib_error_t *error;
handle = dlopen ((char *) pi->name, RTLD_LAZY);
/*
* Note: this can happen if the plugin has an undefined symbol reference,
* so print a warning. Otherwise, the poor slob won't know what happened.
* Ask me how I know that...
*/
if (handle == 0)
{
clib_warning ("%s", dlerror ());
return 0;
}
pi->handle = handle;
register_handle = dlsym (pi->handle, "vat_plugin_register");
if (register_handle == 0)
{
clib_warning ("%s: symbol vat_plugin_register not found", pi->name);
dlclose (handle);
return 0;
}
fp = register_handle;
error = (*fp) (pm->vat_main);
if (error)
{
clib_error_report (error);
dlclose (handle);
return 1;
}
clib_warning ("Loaded plugin: %s", pi->name);
return 0;
}
static u8 **
split_plugin_path (plugin_main_t * pm)
{
int i;
u8 **rv = 0;
u8 *path = pm->plugin_path;
u8 *this = 0;
for (i = 0; i < vec_len (pm->plugin_path); i++)
{
if (path[i] != ':')
{
vec_add1 (this, path[i]);
continue;
}
vec_add1 (this, 0);
vec_add1 (rv, this);
this = 0;
}
if (this)
{
vec_add1 (this, 0);
vec_add1 (rv, this);
}
return rv;
}
int
vat_load_new_plugins (plugin_main_t * pm)
{
DIR *dp;
struct dirent *entry;
struct stat statb;
uword *p;
plugin_info_t *pi;
u8 **plugin_path;
int i;
plugin_path = split_plugin_path (pm);
for (i = 0; i < vec_len (plugin_path); i++)
{
dp = opendir ((char *) plugin_path[i]);
if (dp == 0)
continue;
while ((entry = readdir (dp)))
{
u8 *plugin_name;
if (pm->plugin_name_filter)
{
int j;
for (j = 0; j < vec_len (pm->plugin_name_filter); j++)
if (entry->d_name[j] != pm->plugin_name_filter[j])
goto next;
}
plugin_name = format (0, "%s/%s%c", plugin_path[i],
entry->d_name, 0);
/* unreadable */
if (stat ((char *) plugin_name, &statb) < 0)
{
ignore:
vec_free (plugin_name);
continue;
}
/* a dir or other things which aren't plugins */
if (!S_ISREG (statb.st_mode))
goto ignore;
p = hash_get_mem (pm->plugin_by_name_hash, plugin_name);
if (p == 0)
{
vec_add2 (pm->plugin_info, pi, 1);
pi->name = plugin_name;
pi->file_info = statb;
if (load_one_plugin (pm, pi))
{
vec_free (plugin_name);
_vec_len (pm->plugin_info) = vec_len (pm->plugin_info) - 1;
continue;
}
clib_memset (pi, 0, sizeof (*pi));
hash_set_mem (pm->plugin_by_name_hash, plugin_name,
pi - pm->plugin_info);
}
next:
;
}
closedir (dp);
vec_free (plugin_path[i]);
}
vec_free (plugin_path);
return 0;
}
#define QUOTE_(x) #x
#define QUOTE(x) QUOTE_(x)
/*
* Load plugins from /usr/lib/vpp_api_test_plugins by default
*/
char *vat_plugin_path = "/usr/lib/vpp_api_test_plugins";
char *vat_plugin_name_filter = 0;
int
vat_plugin_init (vat_main_t * vam)
{
plugin_main_t *pm = &vat_plugin_main;
pm->plugin_path = format (0, "%s%c", vat_plugin_path, 0);
if (vat_plugin_name_filter)
pm->plugin_name_filter = format (0, "%s%c", vat_plugin_name_filter, 0);
pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
pm->vat_main = vam;
return vat_load_new_plugins (pm);
}
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
xt, to match reply w/ request
@param listener_handle - tells client which listener this pertains to
@param handle - unique session identifier
@param rx_fifo_address - rx (vpp -> vpp-client) fifo address
@param tx_fifo_address - tx (vpp-client -> vpp) fifo address
@param vpp_event_queue_address - vpp's event queue address or client's
event queue for cut through
@param server_event_queue_address - server's event queue address for
cut through sessions
@param port - remote port
@param is_ip4 - 1 if the ip is ip4
@param ip - remote ip
*/
define accept_session {
u32 client_index;
u32 context;
u64 listener_handle;
u64 handle;
u64 server_rx_fifo;
u64 server_tx_fifo;
u64 vpp_event_queue_address;
u64 server_event_queue_address;
u16 port;
u8 is_ip4;
u8 ip[16];
};
/** \brief client->vpp, reply to an accept message
*** Will be DEPRECATED. Use message queue instead. ***
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param session_index - session index from accept_session / connect_reply
@param session_thread_index - thread index from accept_session /
connect_reply
*/
define accept_session_reply {
u32 context;
i32 retval;
u64 handle;
};
/** \brief bidirectional disconnect API
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param handle - session handle obtained from accept/connect
*/
define disconnect_session {
u32 client_index;
u32 context;
u64 handle;
};
/** \brief bidirectional disconnect reply API
*** Will be DEPRECATED. Use message queue instead. ***
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param handle - session handle
*/
define disconnect_session_reply {
u32 context;
i32 retval;
u64 handle;
};
/** \brief vpp->client reset session API
*** Will be DEPRECATED. Use message queue instead. ***
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param handle - session handle obtained via accept/connects
*/
define reset_session {
u32 client_index;
u32 context;
u64 handle;
};
/** \brief client->vpp reset session reply
*** Will be DEPRECATED. Use message queue instead. ***
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param handle - session handle obtained via accept/connect
*/
define reset_session_reply {
u32 context;
i32 retval;
u64 handle;
};
/** \brief Bind to an ip:port pair for a given transport protocol
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param wrk_index - index of worker requesting the bind
@param vrf - bind namespace
@param is_ip4 - flag that is 1 if ip address family is IPv4
@param ip - ip address
@param port - port
@param proto - protocol 0 - TCP 1 - UDP
@param options - socket options, fifo sizes, etc.
*/
define bind_sock {
u32 client_index;
u32 context;
u32 wrk_index;
u32 vrf;
u8 is_ip4;
u8 ip[16];
u16 port;
u8 proto;
u64 options[16];
};
/** \brief Unbind
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param wrk_index - index of worker requesting the bind
@param handle - bind handle obtained from bind reply
*/
autoreply define unbind_sock {
u32 client_index;
u32 context;
u32 wrk_index;
u64 handle;
};
/** \brief Connect to a remote peer
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param wrk_index - worker that requests the connect
@param client_queue_address - client's API queue address. Non-zero when
used to perform redirects
@param options - socket options, fifo sizes, etc. when doing redirects
@param vrf - connection namespace
@param is_ip4 - flag that is 1 if ip address family is IPv4
@param ip - ip address
@param port - port
@param proto - protocol 0 - TCP 1 - UDP
@param hostname-len - length of hostname
@param hostname - destination's hostname. If present, used by protocols
like tls.
*/
autoreply define connect_sock {
u32 client_index;
u32 context;
u32 wrk_index;
u64 client_queue_address;
u64 options[16];
u32 vrf;
u8 is_ip4;
u8 ip[16];
u16 port;
u8 proto;
u8 hostname_len;
u8 hostname[hostname_len];
};
/** \brief Bind reply
*** Will be DEPRECATED. Use message queue instead. ***
@param context - sender context, to match reply w/ request
@param handle - bind handle
@param retval - return code for the request
@param lcl_is_ip4 - local ip address type
@param lcl_ip6 - local ip address
@param lcl_port - local port
@param rx_fifo - rx fifo address if allocated (connectionless)
@param tx_fifo - tx fifo address if allocated (connectionless)
@param vpp_evt_q - vpp event queue address (connectionless)
@param segment_name_length - length of segment name
@param segment_name - name of segment client needs to attach to
*/
define bind_sock_reply {
u32 context;
u64 handle;
i32 retval;
u8 lcl_is_ip4;
u8 lcl_ip[16];
u16 lcl_port;
u64 rx_fifo;
u64 tx_fifo;
u64 vpp_evt_q;
u32 segment_size;
u8 segment_name_length;
u8 segment_name[128];
};
/* Dummy connect message -- needed to satisfy api generators
*
* NEVER USED, doxygen tags elided on purpose.
*/
define connect_session {
u32 client_index;
u32 context;
};
/** \brief vpp/server->client, connect reply -- used for all connect_* messages
*** Will be DEPRECATED. Use message queue instead. ***
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param handle - connection handle
@param server_rx_fifo - rx (vpp -> vpp-client) fifo address
@param server_tx_fifo - tx (vpp-client -> vpp) fifo address
@param vpp_event_queue_address - vpp's event queue address
@param client_event_queue_address - client's event queue address
@param segment_size - size of segment to be attached. Only for redirects.
@param segment_name_length - non-zero if the client needs to attach to
the fifo segment
@param segment_name - set if the client needs to attach to the segment
@param lcl_ip - local ip for connection
@param is_ip4 - flag to indicate if ip is v4 or v6
@param lcl_port - local port
*/
define connect_session_reply {
u32 context;
i32 retval;
u64 handle;
u64 server_rx_fifo;
u64 server_tx_fifo;
u64 vpp_event_queue_address;
u64 client_event_queue_address;
u32 segment_size;
u8 segment_name_length;
u8 segment_name[128];
u8 lcl_ip[16];
u8 is_ip4;
u16 lcl_port;
};
/** \brief ask app to add a new cut-through registration
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param evt_q_address - address of the mq in ssvm segment
@param peer_evt_q_address - address of peer's mq in ssvm segment
@param wrk_index - index of worker to receive the registration
@param n_fds - number of fds exchanged
@param fd_flags - flag indicating the fds that will be exchanged over
api socket
*/
autoreply define app_cut_through_registration_add
{
u32 client_index;
u32 context;
u64 evt_q_address;
u64 peer_evt_q_address;
u32 wrk_index;
u8 n_fds;
u8 fd_flags;
};
/** \brief add/del application worker
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param app_index - application index
@param wrk_index - worker index, if a delete
@param is_add - set if an add
*/
define app_worker_add_del
{
u32 client_index;
u32 context;
u32 app_index;
u32 wrk_index;
u8 is_add;
};
/** \brief Reply for app worker add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param wrk_index - worker index, if add
@param app_event_queue_address - vpp event queue address of new worker
@param n_fds - number of fds exchanged
@param fd_flags - set of flags that indicate which fds are to be expected
over the socket (set only if socket transport available)
@param segment_name_length - length of segment name
@param segment_name - name of segment client needs to attach to
@param segment_handle - handle for segment
*/
define app_worker_add_del_reply
{
u32 context;
i32 retval;
u32 wrk_index;
u64 app_event_queue_address;
u8 n_fds;
u8 fd_flags;
u8 segment_name_length;
u8 segment_name[128];
u64 segment_handle;
u8 is_add;
};
/** \brief enable/disable session layer
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param is_enable - disable session layer if 0, enable otherwise
*/
autoreply define session_enable_disable {
u32 client_index;
u32 context;
u8 is_enable;
};
/** \brief add/del application namespace
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param secret - secret shared between app and vpp
@param sw_if_index - local interface that "supports" namespace. Set to
~0 if no preference
@param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
if sw_if_index set.
@param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
if sw_if_index set.
@param namespace_id_len - length of namespace id lower
@param namespace_id - namespace id
*/
define app_namespace_add_del {
u32 client_index;
u32 context;
u64 secret;
u32 sw_if_index;
u32 ip4_fib_id;
u32 ip6_fib_id;
u8 namespace_id_len;
u8 namespace_id[64];
};
/** \brief Reply for app namespace add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param appns_index - app namespace index
*/
define app_namespace_add_del_reply
{
u32 context;
i32 retval;
u32 appns_index;
};
/** \brief add/del session rule
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
@param transport_proto - transport protocol (0 - tcp 1 - udp)
@param is_ip4 - flag to indicate if ip addresses are ip4 or 6
@param lcl_ip - local ip
@param lcl_plen - local prefix length
@param rmt_ip - remote ip
@param rmt_ple - remote prefix length
@param lcl_port - local port
@param rmt_port - remote port
@param action_index - the only action defined now is forward to
application with index action_index
@param is_add - flag to indicate if add or del
@param appns_index - application namespace where rule is to be applied
to
@param scope - flag that indicates scope of the rule: global or local.
If 0, default is global, 1 is global 2 is local, 3 is
both
*/
autoreply define session_rule_add_del {
u32 client_index;
u32 context;
u8 transport_proto;
u8 is_ip4;
u8 lcl_ip[16];
u8 lcl_plen;
u8 rmt_ip[16];
u8 rmt_plen;
u16 lcl_port;
u16 rmt_port;
u32 action_index;
u8 is_add;
u32 appns_index;
u8 scope;
u8 tag[64];
};
/** \brief Dump session rules
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define session_rules_dump
{
u32 client_index;
u32 context;
};
/** \brief Session rules details
@param context - sender context, to match reply w/ request
@param transport_proto - transport protocol (0 - tcp 1 - udp)
@param is_ip4 - flag to indicate if ip addresses are ip4 or 6
@param lcl_ip - local ip
@param lcl_plen - local prefix length
@param rmt_ip - remote ip
@param rmt_ple - remote prefix length
@param lcl_port - local port
@param rmt_port - remote port
@param action_index - the only action defined now is forward to
application with index action_index
@param appns_index - application namespace where rule is to be applied
to
@param scope - flag that indicates scope of the rule: global or local.
If 0, default is global, 1 is global 2 is local, 3 is
both
*/
define session_rules_details
{
u32 context;
u8 transport_proto;
u8 is_ip4;
u8 lcl_ip[16];
u8 lcl_plen;
u8 rmt_ip[16];
u8 rmt_plen;
u16 lcl_port;
u16 rmt_port;
u32 action_index;
u32 appns_index;
u8 scope;
u8 tag[64];
};
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/