hello management implementation More...

#include "platform.h"
#include "gnunet_constants.h"
#include "gnunet_hello_lib.h"
#include "gnunet_peerinfo_service.h"
#include "gnunet_statistics_service.h"
#include "gnunet-service-transport_hello.h"
#include "gnunet-service-transport.h"
#include "gnunet-service-transport_plugins.h"

Include dependency graph for gnunet-service-transport_hello.c:

Data Structures
struct	OwnAddressList
	Entry in linked list of network addresses for ourselves. More...

struct	GeneratorContext
	Closure for address_generator(). More...

Macros
#define	HELLO_REFRESH_PERIOD
	How often do we refresh our HELLO (due to expiration concerns)? More...

Functions
static ssize_t	address_generator (void cls, size_t max, void buf)
	Add an address from the `struct OwnAddressList` to the buffer. More...

static void	refresh_hello_task (void *cls)
	Construct our HELLO message from all of the addresses of all of the transports. More...

static void	refresh_hello ()
	Schedule task to refresh hello (but only if such a task exists already, as otherwise the module might have been shutdown). More...

void	GST_hello_start (int friend_only, GST_HelloCallback cb, void *cb_cls)
	Initialize the HELLO module. More...

void	GST_hello_stop ()
	Shutdown the HELLO module. More...

const struct GNUNET_MessageHeader *	GST_hello_get ()
	Obtain this peers HELLO message. More...

void	GST_hello_modify_addresses (int addremove, const struct GNUNET_HELLO_Address *address)
	Add or remove an address from this peer's HELLO message. More...

int	GST_hello_test_address (const struct GNUNET_HELLO_Address address, struct GNUNET_CRYPTO_EddsaSignature sig, struct GNUNET_TIME_Absolute *sig_expiration)
	Test if a particular address is one of ours. More...

Variables
struct GNUNET_TIME_Relative	hello_expiration
	Hello address expiration. More...

static struct GNUNET_HELLO_Message *	our_hello
	Our HELLO message. More...

static GST_HelloCallback	hello_cb
	Function to call on HELLO changes. More...

static void *	hello_cb_cls
	Closure for hello_cb. More...

static struct OwnAddressList *	oal_head
	Head of my addresses. More...

static struct OwnAddressList *	oal_tail
	Tail of my addresses. More...

static int	friend_option
	Should we use a friend-only HELLO? More...

static struct GNUNET_SCHEDULER_Task *	hello_task
	Identifier of refresh_hello_task(). More...

Detailed Description

hello management implementation

Author: Christian Grothoff

Definition in file gnunet-service-transport_hello.c.

Macro Definition Documentation

◆ HELLO_REFRESH_PERIOD

#define HELLO_REFRESH_PERIOD

Value:

GNUNET_TIME_relative_multiply ( \

GNUNET_TIME_UNIT_HOURS, 6)

GNUNET_TIME_UNIT_HOURS

#define GNUNET_TIME_UNIT_HOURS

One hour.

Definition: gnunet_time_lib.h:160

GNUNET_TIME_relative_multiply

struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply(struct GNUNET_TIME_Relative rel, unsigned long long factor)

Multiply relative time by a given factor.

Definition: time.c:484

How often do we refresh our HELLO (due to expiration concerns)?

Definition at line 39 of file gnunet-service-transport_hello.c.

Function Documentation

◆ address_generator()

static ssize_t address_generator	(	void *	cls,
		size_t	max,
		void *	buf
	)

static

Add an address from the struct OwnAddressList to the buffer.

Parameters

cls	the `struct GeneratorContext`
max	maximum number of bytes left
buf	where to write the address

Returns: bytes written or GNUNET_SYSERR to signal the end of the iteration.

Definition at line 152 of file gnunet-service-transport_hello.c.

 {
   struct GeneratorContext *gc = cls;
   ssize_t ret;
  
   if (NULL == gc->addr_pos)
     return GNUNET_SYSERR; /* Done */
   ret = GNUNET_HELLO_add_address (gc->addr_pos->address,
                                   gc->expiration,
                                   buf,
                                   max);
   gc->addr_pos = gc->addr_pos->next;
   return ret;
 }

References GeneratorContext::addr_pos, OwnAddressList::address, buf, GeneratorContext::expiration, GNUNET_HELLO_add_address(), GNUNET_SYSERR, max, OwnAddressList::next, and ret.

Referenced by refresh_hello_task().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refresh_hello_task()

static void refresh_hello_task ( void * cls )

static

Construct our HELLO message from all of the addresses of all of the transports.

Parameters

cls unused

Definition at line 177 of file gnunet-service-transport_hello.c.

 {
   struct GeneratorContext gc;
  
   hello_task = NULL;
   gc.addr_pos = oal_head;
   gc.expiration = GNUNET_TIME_relative_to_absolute (hello_expiration);
  
   GNUNET_free (our_hello);
   our_hello = GNUNET_HELLO_create (&GST_my_identity.public_key,
                                    &address_generator,
                                    &gc,
                                    friend_option);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Refreshed my %s HELLO, new size is %d\n",
               (GNUNET_YES == friend_option) ? "friend-only" : "public",
               GNUNET_HELLO_size (our_hello));
   GNUNET_STATISTICS_update (GST_stats,
                             gettext_noop ("# refreshed my HELLO"),
                             1,
                             GNUNET_NO);
   if (NULL != hello_cb)
     hello_cb (hello_cb_cls,
               GST_hello_get ());
   GNUNET_PEERINFO_add_peer (GST_peerinfo,
                             our_hello,
                             NULL,
                             NULL);
   hello_task =
     GNUNET_SCHEDULER_add_delayed (HELLO_REFRESH_PERIOD,
                                   &refresh_hello_task,
                                   NULL);
 }

References GeneratorContext::addr_pos, address_generator(), GeneratorContext::expiration, friend_option, gettext_noop, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_HELLO_create(), GNUNET_HELLO_size(), GNUNET_log, GNUNET_NO, GNUNET_PEERINFO_add_peer(), GNUNET_SCHEDULER_add_delayed(), GNUNET_STATISTICS_update(), GNUNET_TIME_relative_to_absolute(), GNUNET_YES, GST_hello_get(), GST_my_identity, GST_peerinfo, GST_stats, hello_cb, hello_cb_cls, hello_expiration, HELLO_REFRESH_PERIOD, hello_task, oal_head, our_hello, and GNUNET_PeerIdentity::public_key.

Referenced by GST_hello_start(), and refresh_hello().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refresh_hello()

static void refresh_hello ( )

static

Schedule task to refresh hello (but only if such a task exists already, as otherwise the module might have been shutdown).

Definition at line 218 of file gnunet-service-transport_hello.c.

 {
   if (NULL != hello_task)
   {
     GNUNET_SCHEDULER_cancel (hello_task);
     hello_task = GNUNET_SCHEDULER_add_now (&refresh_hello_task,
                                            NULL);
   }
 }

References GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), hello_task, and refresh_hello_task().

Referenced by GST_hello_modify_addresses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GST_hello_start()

void GST_hello_start	(	int	friend_only,
		GST_HelloCallback	cb,
		void *	cb_cls
	)

Initialize the HELLO module.

Parameters

friend_only	use a friend only hello
cb	function to call whenever our HELLO changes
cb_cls	closure for cb

Definition at line 237 of file gnunet-service-transport_hello.c.

 {
   hello_cb = cb;
   hello_cb_cls = cb_cls;
   friend_option = friend_only;
   refresh_hello_task (NULL);
 }

References friend_option, hello_cb, hello_cb_cls, and refresh_hello_task().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GST_hello_stop()

void GST_hello_stop ( void )

Shutdown the HELLO module.

Definition at line 252 of file gnunet-service-transport_hello.c.

 {
   hello_cb = NULL;
   hello_cb_cls = NULL;
   if (NULL != hello_task)
   {
     GNUNET_SCHEDULER_cancel (hello_task);
     hello_task = NULL;
   }
   if (NULL != our_hello)
   {
     GNUNET_free (our_hello);
     our_hello = NULL;
   }
 }

References GNUNET_free, GNUNET_SCHEDULER_cancel(), hello_cb, hello_cb_cls, hello_task, and our_hello.

Referenced by shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GST_hello_get()

const struct GNUNET_MessageHeader* GST_hello_get ( void )

Obtain this peers HELLO message.

Returns: our HELLO message

Definition at line 275 of file gnunet-service-transport_hello.c.

 {
   return (const struct GNUNET_MessageHeader *) our_hello;
 }

References our_hello.

Referenced by GST_plugins_load(), handle_client_start(), refresh_hello_task(), and transmit_ping_if_allowed().

Here is the caller graph for this function:

◆ GST_hello_modify_addresses()

void GST_hello_modify_addresses	(	int	addremove,
		const struct GNUNET_HELLO_Address *	address
	)

Add or remove an address from this peer's HELLO message.

Parameters

addremove	GNUNET_YES to add, GNUNET_NO to remove
address	address to add or remove

Definition at line 288 of file gnunet-service-transport_hello.c.

 {
   struct OwnAddressList *al;
  
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               (GNUNET_YES == addremove)
               ? "Adding `%s' to the set of our addresses\n"
               : "Removing `%s' from the set of our addresses\n",
               GST_plugins_a2s (address));
   GNUNET_assert (NULL != address);
   for (al = oal_head; al != NULL; al = al->next)
     if (0 == GNUNET_HELLO_address_cmp (address, al->address))
       break;
   if (GNUNET_NO == addremove)
   {
     if (NULL == al)
     {
       /* address to be removed not found!? */
       GNUNET_break (0);
       return;
     }
     al->rc--;
     if (0 != al->rc)
       return;   /* RC not yet zero */
     GNUNET_CONTAINER_DLL_remove (oal_head,
                                  oal_tail,
                                  al);
     GNUNET_HELLO_address_free (al->address);
     GNUNET_free (al);
     refresh_hello ();
     return;
   }
   if (NULL != al)
   {
     /* address added twice or more */
     al->rc++;
     return;
   }
   al = GNUNET_new (struct OwnAddressList);
   al->rc = 1;
   GNUNET_CONTAINER_DLL_insert (oal_head,
                                oal_tail,
                                al);
   al->address = GNUNET_HELLO_address_copy (address);
   refresh_hello ();
 }

References address, OwnAddressList::address, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_HELLO_address_cmp(), GNUNET_HELLO_address_copy(), GNUNET_HELLO_address_free, GNUNET_log, GNUNET_new, GNUNET_NO, GNUNET_YES, GST_plugins_a2s(), OwnAddressList::next, oal_head, oal_tail, OwnAddressList::rc, and refresh_hello().

Referenced by plugin_env_address_change_notification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GST_hello_test_address()

int GST_hello_test_address	(	const struct GNUNET_HELLO_Address *	address,
		struct GNUNET_CRYPTO_EddsaSignature **	sig,
		struct GNUNET_TIME_Absolute **	sig_expiration
	)

Test if a particular address is one of ours.

Parameters

address	the address to test
sig	location where to cache PONG signatures for this address [set]
sig_expiration	how long until the current 'sig' expires? (ZERO if sig was never created) [set]

Returns: GNUNET_YES if this is one of our addresses, GNUNET_NO if not

Definition at line 338 of file gnunet-service-transport_hello.c.

 {
   struct OwnAddressList *al;
  
   for (al = oal_head; al != NULL; al = al->next)
     if (0 == GNUNET_HELLO_address_cmp (address,
                                        al->address))
     {
       *sig = &al->pong_signature;
       *sig_expiration = &al->pong_sig_expires;
       return GNUNET_YES;
     }
   *sig = NULL;
   *sig_expiration = NULL;
   return GNUNET_NO;
 }