GNUnet  0.10.x
gnunet-service-transport_plugins.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2010-2014 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
26 #include "platform.h"
31 
35 struct TransportPlugin {
39  struct TransportPlugin *next;
40 
44  struct TransportPlugin *prev;
45 
51 
55  char *short_name;
56 
60  char *lib_name;
61 
67 };
68 
73 
78 
79 
88 static void
90  const struct GNUNET_HELLO_Address *address,
91  uint32_t distance)
92 {
94  distance);
95 }
96 
97 
107 static enum GNUNET_NetworkType
109  const struct sockaddr *addr,
110  size_t addrlen)
111 {
112  if (NULL == GST_is)
113  {
114  GNUNET_break(0);
115  return GNUNET_NT_UNSPECIFIED;
116  }
118  addr,
119  addrlen);
120 }
121 
122 
135 void
138  GNUNET_TRANSPORT_SessionStart session_start_cb,
139  GNUNET_TRANSPORT_SessionEnd session_end_cb)
140 {
141  struct TransportPlugin *plug;
142  struct TransportPlugin *next;
143  unsigned long long tneigh;
144  char *libname;
145  char *plugs;
146  char *pos;
147  int fail;
148 
149  if (GNUNET_OK !=
151  "TRANSPORT",
152  "NEIGHBOUR_LIMIT",
153  &tneigh))
154  {
156  _("Transport service is lacking NEIGHBOUR_LIMIT option.\n"));
157  return;
158  }
159  if (GNUNET_OK !=
161  "TRANSPORT",
162  "PLUGINS",
163  &plugs))
164  return;
166  _("Starting transport plugins `%s'\n"),
167  plugs);
168  for (pos = strtok(plugs, " "); pos != NULL; pos = strtok(NULL, " "))
169  {
171  _("Loading `%s' transport plugin\n"),
172  pos);
173  GNUNET_asprintf(&libname,
174  "libgnunet_plugin_transport_%s",
175  pos);
176  plug = GNUNET_new(struct TransportPlugin);
177  plug->short_name = GNUNET_strdup(pos);
178  plug->lib_name = libname;
179  plug->env.cfg = GST_cfg;
182  plug->env.cls = plug->short_name;
183  plug->env.receive = recv_cb;
184  plug->env.notify_address = address_cb;
185  plug->env.session_start = session_start_cb;
186  plug->env.session_end = session_end_cb;
189  plug->env.max_connections = tneigh;
190  plug->env.stats = GST_stats;
191  GNUNET_CONTAINER_DLL_insert(plugins_head,
192  plugins_tail,
193  plug);
194  }
195  GNUNET_free(plugs);
196  next = plugins_head;
197  while (NULL != next)
198  {
199  plug = next;
200  next = plug->next;
201  plug->api = GNUNET_PLUGIN_load(plug->lib_name,
202  &plug->env);
203  if (NULL == plug->api)
204  {
206  _("Failed to load transport plugin for `%s'\n"),
207  plug->lib_name);
208  GNUNET_CONTAINER_DLL_remove(plugins_head,
209  plugins_tail,
210  plug);
211  GNUNET_free(plug->short_name);
212  GNUNET_free(plug->lib_name);
213  GNUNET_free(plug);
214  continue;
215  }
216  fail = GNUNET_NO;
217  if (NULL == plug->api->address_pretty_printer)
218  {
219  fail = GNUNET_YES;
221  _("Missing function `%s' in transport plugin for `%s'\n"),
222  "address_pretty_printer",
223  plug->lib_name);
224  }
225  if (NULL == plug->api->address_to_string)
226  {
227  fail = GNUNET_YES;
229  _("Missing function `%s' in transport plugin for `%s'\n"),
230  "address_to_string",
231  plug->lib_name);
232  }
233  if (NULL == plug->api->string_to_address)
234  {
235  fail = GNUNET_YES;
237  _("Missing function `%s' in transport plugin for `%s'\n"),
238  "string_to_address",
239  plug->lib_name);
240  }
241  if (NULL == plug->api->check_address)
242  {
243  fail = GNUNET_YES;
245  _("Missing function `%s' in transport plugin for `%s'\n"),
246  "check_address",
247  plug->lib_name);
248  }
249  if (NULL == plug->api->get_session)
250  {
251  fail = GNUNET_YES;
253  _("Missing function `%s' in transport plugin for `%s'\n"),
254  "get_session",
255  plug->lib_name);
256  }
257  if (NULL == plug->api->get_network)
258  {
259  fail = GNUNET_YES;
261  _("Missing function `%s' in transport plugin for `%s'\n"),
262  "get_network",
263  plug->lib_name);
264  }
265  if (NULL == plug->api->send)
266  {
267  fail = GNUNET_YES;
269  _("Missing function `%s' in transport plugin for `%s'\n"),
270  "send",
271  plug->lib_name);
272  }
273  if (NULL == plug->api->disconnect_peer)
274  {
275  fail = GNUNET_YES;
277  _("Missing function `%s' in transport plugin for `%s'\n"),
278  "disconnect_peer",
279  plug->lib_name);
280  }
281  if (NULL == plug->api->disconnect_session)
282  {
283  fail = GNUNET_YES;
285  _("Missing function `%s' in transport plugin for `%s'\n"),
286  "disconnect_session",
287  plug->lib_name);
288  }
289  if (NULL == plug->api->query_keepalive_factor)
290  {
291  fail = GNUNET_YES;
293  _("Missing function `%s' in transport plugin for `%s'\n"),
294  "query_keepalive_factor",
295  plug->lib_name);
296  }
297  if (NULL == plug->api->update_session_timeout)
298  {
299  fail = GNUNET_YES;
301  _("Missing function `%s' in transport plugin for `%s'\n"),
302  "update_session_timeout",
303  plug->lib_name);
304  }
305  if (GNUNET_YES == fail)
306  {
308  _("Did not load plugin `%s' due to missing functions\n"),
309  plug->lib_name);
310  GNUNET_break(NULL == GNUNET_PLUGIN_unload(plug->lib_name, plug->api));
311  GNUNET_CONTAINER_DLL_remove(plugins_head,
312  plugins_tail,
313  plug);
314  GNUNET_free(plug->short_name);
315  GNUNET_free(plug->lib_name);
316  GNUNET_free(plug);
317  }
318  }
319 }
320 
321 
325 void
327 {
328  struct TransportPlugin *plug;
329 
330  while (NULL != (plug = plugins_head))
331  {
332  GNUNET_break(NULL == GNUNET_PLUGIN_unload(plug->lib_name, plug->api));
333  GNUNET_free(plug->lib_name);
334  GNUNET_free(plug->short_name);
335  GNUNET_CONTAINER_DLL_remove(plugins_head, plugins_tail, plug);
336  GNUNET_free(plug);
337  }
338 }
339 
340 
348 GST_plugins_find(const char *name)
349 {
350  struct TransportPlugin *pos;
351 
352  for (pos = plugins_head; NULL != pos; pos = pos->next)
353  if (0 == strcmp(name, pos->short_name))
354  break;
355  if (NULL == pos)
356  return NULL;
357  return pos->api;
358 }
359 
360 
373 {
374  struct TransportPlugin *pos;
375  char *stripped = GNUNET_strdup(name);
376  char *sep = strchr(stripped, '_');
377 
378  if (NULL != sep)
379  sep[0] = '\0';
380  for (pos = plugins_head; NULL != pos; pos = pos->next)
381  if (pos->short_name == strstr(pos->short_name, stripped))
382  break;
383  GNUNET_free(stripped);
384  if (NULL == pos)
385  return NULL;
386  return pos->api;
387 }
388 
389 
397 const char *
399 {
401  static char unable_to_show[1024];
402  static const char *s;
403 
404  if (NULL == address)
405  return "<NULL>";
406  if (0 == address->address_length)
407  return TRANSPORT_SESSION_INBOUND_STRING; /* Addresse with length 0 are inbound, address->address itself may be NULL */
409  if (NULL == api)
410  {
412  "Failed to find transport plugin `%s'\n",
413  address->transport_name);
414  return "<plugin unknown>";
415  }
416  if (0 == address->address_length)
417  {
418  GNUNET_snprintf(unable_to_show,
419  sizeof(unable_to_show),
420  "<unable to stringify %u-byte long address of %s transport>",
421  (unsigned int)address->address_length,
422  address->transport_name);
423  return unable_to_show;
424  }
425  return(NULL != (s = api->address_to_string(NULL,
426  address->address,
427  address->address_length))
428  ? s
429  : "<invalid>");
430 }
431 
432 
439 void
441  void *cb_cls)
442 {
443  struct TransportPlugin *pos;
444 
445  for (pos = plugins_head; NULL != pos; pos = pos->next)
446  if (NULL == pos->api->setup_monitor)
447  GNUNET_break(0);
448  else
449  pos->api->setup_monitor(pos->api->cls,
450  cb,
451  cb_cls);
452 }
453 
454 
455 /* end of file gnunet-service-transport_plugins.c */
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
static struct GNUNET_PeerIdentity GST_my_identity
Our public key.
size_t address_length
Number of bytes in address.
void(* GNUNET_TRANSPORT_SessionEnd)(void *cls, const struct GNUNET_HELLO_Address *address, struct GNUNET_ATS_Session *session)
Function that will be called whenever the plugin internally cleans up a session pointer and hence the...
enum GNUNET_NetworkType GNUNET_NT_scanner_get_type(struct GNUNET_NT_InterfaceScanner *is, const struct sockaddr *addr, socklen_t addrlen)
Returns where the address is located: loopback, LAN or WAN.
Definition: nt.c:306
char * short_name
Short name for the plugin (i.e.
GNUNET_TRANSPORT_CreateSession get_session
Function that will be called tell the plugin to create a session object.
struct TransportPlugin * prev
This is a doubly-linked list.
GNUNET_TRANSPORT_AddressToString address_to_string
Function that will be called to convert a binary address to a string (numeric conversion only)...
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
const void * address
Binary representation of the address (plugin-specific).
void(* GNUNET_TRANSPORT_AddressNotification)(void *cls, int add_remove, const struct GNUNET_HELLO_Address *address)
Function that will be called for each address the transport is aware that it might be reachable under...
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
void GST_plugins_monitor_subscribe(GNUNET_TRANSPORT_SessionInfoCallback cb, void *cb_cls)
Register callback with all plugins to monitor their status.
GNUNET_TRANSPORT_SessionStart session_start
Function called by the plugin when a new (incoming) session was created not explicitly created using ...
struct TransportPlugin * next
This is a doubly-linked list.
int GNUNET_snprintf(char *buf, size_t size, const char *format,...)
Like snprintf, just aborts if the buffer is of insufficient size.
void GST_plugins_load(GNUNET_TRANSPORT_PluginReceiveCallback recv_cb, GNUNET_TRANSPORT_AddressNotification address_cb, GNUNET_TRANSPORT_SessionStart session_start_cb, GNUNET_TRANSPORT_SessionEnd session_end_cb)
Load and initialize all plugins.
void GST_ats_update_distance(const struct GNUNET_HELLO_Address *address, uint32_t distance)
Notify ATS about DV distance change to an address.
GNUNET_TRANSPORT_TransmitFunction send
Function that the transport service will use to transmit data to another peer.
GNUNET_TRANSPORT_DisconnectPeerFunction disconnect_peer
Function that can be used to force the plugin to disconnect from the given peer and cancel all previo...
GNUNET_TRANSPORT_AddressToType get_address_type
Function that will be called to figure if an address is an loopback, LAN, WAN etc.
GNUNET_TRANSPORT_DisconnectSessionFunction disconnect_session
Function that can be used to force the plugin to disconnect from the given peer and cancel all previo...
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
GNUNET_TRANSPORT_SessionMonitorSetup setup_monitor
Function to monitor the sessions managed by the plugin.
const struct GNUNET_PeerIdentity * my_identity
Identity of this peer.
interfacing between transport and ATS service
#define TRANSPORT_SESSION_INBOUND_STRING
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static enum GNUNET_NetworkType plugin_env_address_to_type(void *cls, const struct sockaddr *addr, size_t addrlen)
Function that will be called to figure if an address is an loopback, LAN, WAN etc.
struct GNUNET_TRANSPORT_PluginFunctions * GST_plugins_printer_find(const char *name)
Obtain the plugin API based on a the stripped plugin name after the underscore.
uint32_t max_connections
What is the maximum number of connections that this transport should allow? Transports that do not ha...
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static void plugin_env_update_distance(void *cls, const struct GNUNET_HELLO_Address *address, uint32_t distance)
Function that will be called to update metrics for an address.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
void * GNUNET_PLUGIN_unload(const char *library_name, void *arg)
Unload plugin (runs the "done" callback and returns whatever "done" returned).
Definition: plugin.c:255
static void address_cb(void *cls, void **app_ctx, int add_remove, enum GNUNET_NAT_AddressClass ac, const struct sockaddr *addr, socklen_t addrlen)
Signature of the callback passed to GNUNET_NAT_register() for a function to call whenever our set of ...
Definition: gnunet-nat.c:122
GNUNET_TRANSPORT_SessionEnd session_end
Function that must be called by the plugin when a non-NULL session handle stops being valid (is destr...
GNUNET_TRANSPORT_PluginReceiveCallback receive
Function that should be called by the transport plugin whenever a message is received.
GNUNET_TRANSPORT_UpdateSessionTimeout update_session_timeout
Function that will be called whenever the transport service wants to notify the plugin that a session...
struct GNUNET_NT_InterfaceScanner * GST_is
Interface scanner determines our LAN address range(s).
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
static struct GNUNET_STATISTICS_Handle * GST_stats
Statistics handle.
void * cls
Closure for the various callbacks.
void * cls
Closure for all of the callbacks.
static struct TransportPlugin * plugins_head
Head of DLL of all loaded plugins.
GNUNET_TRANSPORT_GetHelloCallback get_our_hello
Function that returns our HELLO.
GNUNET_TRANSPORT_StringToAddress string_to_address
Function that will be called to convert a string address to binary (numeric conversion only)...
struct GNUNET_TRANSPORT_PluginEnvironment env
Environment this transport service is using for this plugin.
The transport service will pass a pointer to a struct of this type as the first and only argument to ...
GNUNET_TRANSPORT_GetNetworkType get_network
Function to obtain the network type for a session.
struct GNUNET_TIME_Relative(* GNUNET_TRANSPORT_PluginReceiveCallback)(void *cls, const struct GNUNET_HELLO_Address *address, struct GNUNET_ATS_Session *session, const struct GNUNET_MessageHeader *message)
Function called by the transport for each received message.
const char * transport_name
Name of the transport plugin enabling the communication using this address.
static struct TransportPlugin * plugins_tail
Head of DLL of all loaded plugins.
void(* GNUNET_TRANSPORT_SessionInfoCallback)(void *cls, struct GNUNET_ATS_Session *session, const struct GNUNET_TRANSPORT_SessionInfo *info)
Function called by the plugin with information about the current sessions managed by the plugin (for ...
const char * GST_plugins_a2s(const struct GNUNET_HELLO_Address *address)
Convert a given address to a human-readable format.
struct GNUNET_TRANSPORT_PluginFunctions * GST_plugins_find(const char *name)
Obtain the plugin API based on a plugin name.
int GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
const char * name
char * lib_name
Name of the library (i.e.
GNUNET_TRANSPORT_UpdateAddressDistance update_address_distance
Function that will be called by DV to update distance for an address.
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
const struct GNUNET_MessageHeader * GST_hello_get()
Obtain this peers HELLO message.
GNUNET_TRANSPORT_QueryKeepaliveFactorFunction query_keepalive_factor
Function that is used to query keepalive factor.
Entry in doubly-linked list of all of our plugins.
struct GNUNET_TRANSPORT_PluginFunctions * api
API of the transport as returned by the plugin&#39;s initialization function.
void GST_plugins_unload()
Unload all plugins.
An address for communicating with a peer.
struct GNUNET_STATISTICS_Handle * stats
Handle for reporting statistics.
#define GNUNET_log(kind,...)
GNUNET_TRANSPORT_AddressNotification notify_address
Function that must be called by each plugin to notify the transport service about the addresses under...
GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer
Function to pretty-print addresses.
#define GNUNET_YES
Definition: gnunet_common.h:77
static const struct GNUNET_CONFIGURATION_Handle * GST_cfg
Configuration handle.
void * GNUNET_PLUGIN_load(const char *library_name, void *arg)
Setup plugin (runs the "init" callback and returns whatever "init" returned).
Definition: plugin.c:206
void(* GNUNET_TRANSPORT_SessionStart)(void *cls, const struct GNUNET_HELLO_Address *address, struct GNUNET_ATS_Session *session, enum GNUNET_NetworkType net)
Plugin tells transport service about a new inbound session.
GNUNET_TRANSPORT_CheckAddress check_address
Function that will be called to check if a binary address for this plugin is well-formed and correspo...
static char * address
GNS address for this phone.
#define GNUNET_free(ptr)
Wrapper around free.
Category of last resort.
Definition: gnunet_nt_lib.h:39