gnunet-service-ats_plugins.h File Reference

ats service plugin management More...

#include "gnunet-service-ats_addresses.h"

Include dependency graph for gnunet-service-ats_plugins.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	GAS_plugin_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Initialize address subsystem. More...
void	GAS_plugin_done (void)
	Shutdown address subsystem. More...
void	GAS_plugin_notify_preference_changed (const struct GNUNET_PeerIdentity *peer, enum GNUNET_ATS_PreferenceKind kind, double pref_rel)
	The preference changed for a peer, update solver. More...
void	GAS_plugin_notify_property_changed (struct ATS_Address *address)
	The relative value for a property changed. More...
void	GAS_plugin_new_address (struct ATS_Address *new_address)
	Tell the solver that the given address can now be used for talking to the respective peer. More...
void	GAS_plugin_delete_address (struct ATS_Address *address)
	Tell the solver that the given address is no longer valid can cannot be used any longer. More...
void	GAS_plugin_notify_feedback (struct GNUNET_SERVICE_Client *application, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_TIME_Relative scope, enum GNUNET_ATS_PreferenceKind kind, float score_abs)
	Tell the solver that the given client has expressed its appreciation for the past performance of a given connection. More...
void	GAS_plugin_solver_lock (void)
	Stop instant solving, there are many state updates happening in bulk right now. More...
void	GAS_plugin_solver_unlock (void)
	Resume instant solving, we are done with the bulk state updates. More...
void	GAS_plugin_request_connect_start (const struct GNUNET_PeerIdentity *pid)
	Notify the plugin that a request to connect to a particular peer was given to us. More...
void	GAS_plugin_request_connect_stop (const struct GNUNET_PeerIdentity *pid)
	Notify the plugin that a request to connect to a particular peer was dropped. More...

Detailed Description

ats service plugin management

Author

Matthias Wachs

Christian Grothoff

Definition in file gnunet-service-ats_plugins.h.

Function Documentation

GAS_plugin_init()

int GAS_plugin_init

(

const struct GNUNET_CONFIGURATION_Handle *

cfg

)

Initialize address subsystem.

The addresses subsystem manages the addresses known and current performance information. It has a solver component responsible for the resource allocation. It tells the solver about changes and receives updates when the solver changes the resource allocation.

Parameters

cfg	configuration to use

Returns

GNUNET_OK on success, GNUNET_SYSERR on error (failed to load solver plugin)

Definition at line 424 of file gnunet-service-ats_plugins.c.

{
  char *mode_str;
 
  /* Figure out configured solution method */
  if (GNUNET_SYSERR ==
      GNUNET_CONFIGURATION_get_value_string (cfg,
                                             "ats",
                                             "MODE",
                                             &mode_str))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "No resource assignment method configured, using proportional approach\n");
    mode_str = GNUNET_strdup ("proportional");
  }
  env.cls = NULL;
  env.info_cb = &solver_info_cb;
  env.bandwidth_changed_cb = &bandwidth_changed_cb;
  env.get_preferences = &GAS_preference_get_by_peer;
  env.get_connectivity = &GAS_connectivity_has_peer;
  env.cfg = cfg;
  env.stats = GSA_stats;
  env.addresses = GSA_addresses;
  env.network_count = GNUNET_NT_COUNT;
  load_quotas (cfg,
               env.out_quota,
               env.in_quota,
               GNUNET_NT_COUNT);
  GNUNET_asprintf (&plugin,
                   "libgnunet_plugin_ats_%s",
                   mode_str);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Initializing solver `%s'\n",
              mode_str);
  GNUNET_free (mode_str);
  if (NULL == (sf = GNUNET_PLUGIN_load (plugin, &env)))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _ ("Failed to initialize solver `%s'!\n"),
                plugin);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References _, GNUNET_ATS_PluginEnvironment::addresses, bandwidth_changed_cb(), GNUNET_ATS_PluginEnvironment::bandwidth_changed_cb, cfg, GNUNET_ATS_PluginEnvironment::cfg, GNUNET_ATS_PluginEnvironment::cls, env, GAS_connectivity_has_peer(), GAS_preference_get_by_peer(), GNUNET_ATS_PluginEnvironment::get_connectivity, GNUNET_ATS_PluginEnvironment::get_preferences, GNUNET_asprintf(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_NT_COUNT, GNUNET_OK, GNUNET_PLUGIN_load(), GNUNET_strdup, GNUNET_SYSERR, GSA_addresses, GSA_stats, GNUNET_ATS_PluginEnvironment::in_quota, GNUNET_ATS_PluginEnvironment::info_cb, load_quotas(), GNUNET_ATS_PluginEnvironment::network_count, GNUNET_ATS_PluginEnvironment::out_quota, plugin, sf, solver_info_cb(), and GNUNET_ATS_PluginEnvironment::stats.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_plugin_done()

void GAS_plugin_done

(

void

)

Shutdown address subsystem.

Definition at line 474 of file gnunet-service-ats_plugins.c.

{
  GNUNET_PLUGIN_unload (plugin,
                        sf);
  sf = NULL;
  GNUNET_free (plugin);
  plugin = NULL;
}

References GNUNET_free, GNUNET_PLUGIN_unload(), plugin, and sf.

Referenced by cleanup_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_plugin_notify_preference_changed()

void GAS_plugin_notify_preference_changed	(	const struct GNUNET_PeerIdentity *	peer,
		enum GNUNET_ATS_PreferenceKind	kind,
		double	pref_rel
	)

The preference changed for a peer, update solver.

Parameters

peer	the peer
kind	the ATS kind
pref_rel	the new relative preference value

Definition at line 62 of file gnunet-service-ats_plugins.c.

{
  sf->s_pref (sf->cls,
              peer,
              kind,
              pref_rel);
}

References GNUNET_ATS_SolverFunctions::cls, peer, GNUNET_ATS_SolverFunctions::s_pref, and sf.

Referenced by update_relative_values_for_peer().

Here is the caller graph for this function:

GAS_plugin_notify_property_changed()

void GAS_plugin_notify_property_changed

(

struct ATS_Address *

address

)

The relative value for a property changed.

Parameters

address

The peer for which a property changed.

Definition at line 74 of file gnunet-service-ats_plugins.c.

{
  sf->s_address_update_property (sf->cls,
                                 address);
}

References address, GNUNET_ATS_SolverFunctions::cls, GNUNET_ATS_SolverFunctions::s_address_update_property, and sf.

Referenced by notify_change().

Here is the caller graph for this function:

GAS_plugin_new_address()

void GAS_plugin_new_address

(

struct ATS_Address *

new_address

)

Tell the solver that the given address can now be used for talking to the respective peer.

Parameters

new_address

the new address

Definition at line 485 of file gnunet-service-ats_plugins.c.

{
  sf->s_add (sf->cls,
             new_address,
             new_address->properties.scope); /* FIXME: remove 3rd arg here! */
}

References GNUNET_ATS_SolverFunctions::cls, ATS_Address::properties, GNUNET_ATS_SolverFunctions::s_add, GNUNET_ATS_Properties::scope, and sf.

Referenced by GAS_addresses_add().

Here is the caller graph for this function:

GAS_plugin_delete_address()

void GAS_plugin_delete_address

(

struct ATS_Address *

address

)

Tell the solver that the given address is no longer valid can cannot be used any longer.

Parameters

address

address that was deleted

Definition at line 500 of file gnunet-service-ats_plugins.c.

{
  sf->s_del (sf->cls,
             address);
}

References address, GNUNET_ATS_SolverFunctions::cls, GNUNET_ATS_SolverFunctions::s_del, and sf.

Referenced by free_address().

Here is the caller graph for this function:

GAS_plugin_notify_feedback()

void GAS_plugin_notify_feedback	(	struct GNUNET_SERVICE_Client *	application,
		const struct GNUNET_PeerIdentity *	peer,
		const struct GNUNET_TIME_Relative	scope,
		enum GNUNET_ATS_PreferenceKind	kind,
		float	score_abs
	)

Tell the solver that the given client has expressed its appreciation for the past performance of a given connection.

Parameters

application	client providing the feedback
peer	peer the feedback is about
scope	timeframe the feedback applies to
kind	performance property the feedback relates to
score_abs	degree of the appreciation

Definition at line 518 of file gnunet-service-ats_plugins.c.

{
  sf->s_feedback (sf->cls,
                  application,
                  peer,
                  scope,
                  kind,
                  score_abs);
}

References GNUNET_ATS_SolverFunctions::cls, peer, GNUNET_ATS_SolverFunctions::s_feedback, scope, and sf.

Referenced by handle_feedback().

Here is the caller graph for this function:

GAS_plugin_solver_lock()

void GAS_plugin_solver_lock

(

void

)

Stop instant solving, there are many state updates happening in bulk right now.

Definition at line 538 of file gnunet-service-ats_plugins.c.

{
  sf->s_bulk_start (sf->cls);
}

References GNUNET_ATS_SolverFunctions::cls, GNUNET_ATS_SolverFunctions::s_bulk_start, and sf.

Referenced by GAS_addresses_add(), GAS_addresses_destroy_all(), GAS_addresses_done(), GAS_connectivity_done(), GAS_handle_preference_change(), GAS_normalization_update_property(), and preference_aging().

Here is the caller graph for this function:

GAS_plugin_solver_unlock()

void GAS_plugin_solver_unlock

(

void

)

Resume instant solving, we are done with the bulk state updates.

Definition at line 548 of file gnunet-service-ats_plugins.c.

{
  sf->s_bulk_stop (sf->cls);
}

References GNUNET_ATS_SolverFunctions::cls, GNUNET_ATS_SolverFunctions::s_bulk_stop, and sf.

Referenced by GAS_addresses_add(), GAS_addresses_destroy_all(), GAS_addresses_done(), GAS_connectivity_done(), GAS_handle_preference_change(), GAS_normalization_update_property(), and preference_aging().

Here is the caller graph for this function:

GAS_plugin_request_connect_start()

void GAS_plugin_request_connect_start

(

const struct GNUNET_PeerIdentity *

pid

)

Notify the plugin that a request to connect to a particular peer was given to us.

Parameters

pid	identity of peer we now care about

Definition at line 561 of file gnunet-service-ats_plugins.c.

{
  sf->s_get (sf->cls,
             pid);
}

References GNUNET_ATS_SolverFunctions::cls, pid, GNUNET_ATS_SolverFunctions::s_get, and sf.

Referenced by GAS_handle_request_address().

Here is the caller graph for this function:

GAS_plugin_request_connect_stop()

void GAS_plugin_request_connect_stop

(

const struct GNUNET_PeerIdentity *

pid

)

Notify the plugin that a request to connect to a particular peer was dropped.

Parameters

pid	identity of peer we care now less about

Definition at line 575 of file gnunet-service-ats_plugins.c.

{
  sf->s_get_stop (sf->cls,
                  pid);
}

References GNUNET_ATS_SolverFunctions::cls, pid, GNUNET_ATS_SolverFunctions::s_get_stop, and sf.

Referenced by free_matching_requests().

Here is the caller graph for this function: