#include "gnunet_common.h"
#include "gnunet_time_lib.h"
#include "gnunet_util_lib.h"
#include "gnunet_messenger_service.h"

Include dependency graph for messenger_api_epoch_membership.h:

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

Data Structures
struct	GNUNET_MESSENGER_EpochMembership

Typedefs
typedef enum GNUNET_GenericReturnValue(*	GNUNET_MESSENGER_MembershipCallback) (void cls, const struct GNUNET_MESSENGER_Contact member)

Functions
struct GNUNET_MESSENGER_EpochMembership *	create_epoch_membership (uint32_t size)
	Creates and allocates a new membership for subgroups of an epoch with specified size. More...

void	destroy_epoch_membership (struct GNUNET_MESSENGER_EpochMembership *membership)
	Destroys and frees resources of a given membership. More...

uint32_t	get_epoch_membership_size (const struct GNUNET_MESSENGER_EpochMembership *membership)
	Returns the size of a given epoch membership. More...

uint32_t	get_epoch_membership_count (const struct GNUNET_MESSENGER_EpochMembership *membership)
	Returns the current amount of individual members inside a given epoch membership. More...

enum GNUNET_GenericReturnValue	is_epoch_membership_completed (const struct GNUNET_MESSENGER_EpochMembership *membership)
	Returns whether a given epoch membership is complete, meaning that all of its intended members have provided an own announcement to it. More...

enum GNUNET_GenericReturnValue	is_epoch_membership_member (const struct GNUNET_MESSENGER_EpochMembership membership, const struct GNUNET_MESSENGER_Contact contact)
	Returns whether a specific contact is announced member of a given epoch membership. More...

enum GNUNET_GenericReturnValue	get_epoch_membership_member_hash (const struct GNUNET_MESSENGER_EpochMembership membership, struct GNUNET_HashCode hash, enum GNUNET_GenericReturnValue other)
	Provides an announcement hash of a member from a given epoch membership. More...

uint32_t	get_epoch_membership_member_position (const struct GNUNET_MESSENGER_EpochMembership *membership)
	Returns the index position of the client inside a given epoch in relation to its list of members. More...

enum GNUNET_GenericReturnValue	confirm_epoch_membership_announcment (struct GNUNET_MESSENGER_EpochMembership membership, const struct GNUNET_HashCode hash, const struct GNUNET_MESSENGER_Message message, struct GNUNET_MESSENGER_Contact contact, enum GNUNET_GenericReturnValue sent)
	Adds an announcement message with its hash to a given epoch membership as confirmation for a specific contact. More...

enum GNUNET_GenericReturnValue	revoke_epoch_membership_announcement (struct GNUNET_MESSENGER_EpochMembership membership, const struct GNUNET_HashCode hash, struct GNUNET_MESSENGER_Contact *contact)
	Drops an announcement message with a provided hash from a given epoch membership to revoke the confirmed membership of a specific contact. More...

int	iterate_epoch_membership_members (const struct GNUNET_MESSENGER_EpochMembership membership, GNUNET_MESSENGER_MembershipCallback callback, void cls)
	Iterate through all confirmed members of a given epoch membership and pass them through a provided callback with a custom closure. More...

Typedef Documentation

◆ GNUNET_MESSENGER_MembershipCallback

typedef enum GNUNET_GenericReturnValue(* GNUNET_MESSENGER_MembershipCallback) (void *cls, const struct GNUNET_MESSENGER_Contact *member)

Definition at line 1 of file messenger_api_epoch_membership.h.

Function Documentation

◆ create_epoch_membership()

struct GNUNET_MESSENGER_EpochMembership * create_epoch_membership ( uint32_t size )

Creates and allocates a new membership for subgroups of an epoch with specified size.

Parameters

[in] size Maximum size or 0

Returns: New membership

Definition at line 31 of file messenger_api_epoch_membership.c.

{
  struct GNUNET_MESSENGER_EpochMembership *membership;
 
  membership = GNUNET_new (struct GNUNET_MESSENGER_EpochMembership);
 
  if (! membership)
    return NULL;
 
  membership->size = size;
  membership->count = 0;
  membership->members = GNUNET_CONTAINER_multihashmap_create (size? size : 1,
                                                              GNUNET_NO);
 
  memset (&(membership->announcement), 0, sizeof (membership->announcement));
 
  return membership;
}

References GNUNET_MESSENGER_EpochMembership::announcement, GNUNET_MESSENGER_EpochMembership::count, GNUNET_CONTAINER_multihashmap_create(), GNUNET_new, GNUNET_NO, GNUNET_MESSENGER_EpochMembership::members, size, and GNUNET_MESSENGER_EpochMembership::size.

Referenced by create_epoch_announcement(), and create_epoch_group().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ destroy_epoch_membership()

void destroy_epoch_membership ( struct GNUNET_MESSENGER_EpochMembership * membership )

Destroys and frees resources of a given membership.

Parameters

[in,out] membership Membership

Definition at line 52 of file messenger_api_epoch_membership.c.

{
  GNUNET_assert (membership);
 
  GNUNET_CONTAINER_multihashmap_destroy (membership->members);
 
  GNUNET_free (membership);
}

References GNUNET_assert, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_free, and GNUNET_MESSENGER_EpochMembership::members.

Referenced by destroy_epoch_announcement(), and destroy_epoch_group().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_epoch_membership_size()

uint32_t get_epoch_membership_size ( const struct GNUNET_MESSENGER_EpochMembership * membership )

Returns the size of a given epoch membership.

Parameters

[in] membership Membership

Returns: Maximum size of membership or 0

Definition at line 63 of file messenger_api_epoch_membership.c.

{
  GNUNET_assert (membership);
 
  return membership->size;
}

References GNUNET_assert, and GNUNET_MESSENGER_EpochMembership::size.

Referenced by is_epoch_membership_completed().

Here is the caller graph for this function:

◆ get_epoch_membership_count()

uint32_t get_epoch_membership_count ( const struct GNUNET_MESSENGER_EpochMembership * membership )

Returns the current amount of individual members inside a given epoch membership.

Parameters

[in] membership Membership

Returns: Amount of members

Definition at line 73 of file messenger_api_epoch_membership.c.

{
  GNUNET_assert (membership);
 
  return membership->count;
}

References GNUNET_MESSENGER_EpochMembership::count, and GNUNET_assert.

Referenced by get_epoch_announcement_members_count(), get_epoch_group_members_count(), get_epoch_membership_member_position(), get_epoch_position_factor(), and is_epoch_membership_completed().

Here is the caller graph for this function:

◆ is_epoch_membership_completed()

enum GNUNET_GenericReturnValue is_epoch_membership_completed ( const struct GNUNET_MESSENGER_EpochMembership * membership )

Returns whether a given epoch membership is complete, meaning that all of its intended members have provided an own announcement to it.

Parameters

[in] membership Membership

Returns: GNUNET_YES if membership is complete, otherwise GNUNET_NO

Definition at line 83 of file messenger_api_epoch_membership.c.

{
  uint32_t size;
 
  GNUNET_assert (membership);
 
  size = get_epoch_membership_size (membership);
 
  if (! size)
    return GNUNET_NO;
 
  if (get_epoch_membership_count (membership) >= size)
    return GNUNET_YES;
  else
    return GNUNET_NO;
}

References get_epoch_membership_count(), get_epoch_membership_size(), GNUNET_assert, GNUNET_NO, GNUNET_YES, and size.

Referenced by is_epoch_announcement_completed(), and is_epoch_group_completed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_epoch_membership_member()

enum GNUNET_GenericReturnValue is_epoch_membership_member	(	const struct GNUNET_MESSENGER_EpochMembership *	membership,
		const struct GNUNET_MESSENGER_Contact *	contact
	)

Returns whether a specific contact is announced member of a given epoch membership.

Parameters

[in]	membership	Membership
[in]	contact	Contact

Returns: GNUNET_YES if the contact is a member, otherwise GNUNET_NO

Definition at line 124 of file messenger_api_epoch_membership.c.

{
  const struct GNUNET_MESSENGER_Contact *search;
 
  GNUNET_assert (membership);
 
  if (! contact)
    return GNUNET_CONTAINER_multihashmap_contains (membership->members, &(
                                                     membership->announcement));
 
  search = contact;
 
  GNUNET_CONTAINER_multihashmap_iterate (membership->members,
                                         it_search_epoch_member,
                                         &search);
 
  return search == contact? GNUNET_NO : GNUNET_YES;
}

References GNUNET_MESSENGER_EpochMembership::announcement, GNUNET_assert, GNUNET_CONTAINER_multihashmap_contains(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_NO, GNUNET_YES, it_search_epoch_member(), and GNUNET_MESSENGER_EpochMembership::members.

Referenced by get_epoch_membership_member_hash(), get_epoch_membership_member_position(), is_epoch_announcement_announced(), is_epoch_announcement_member(), is_epoch_group_announced(), and is_epoch_group_member().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_epoch_membership_member_hash()

enum GNUNET_GenericReturnValue get_epoch_membership_member_hash	(	const struct GNUNET_MESSENGER_EpochMembership *	membership,
		struct GNUNET_HashCode *	hash,
		enum GNUNET_GenericReturnValue	other
	)

Provides an announcement hash of a member from a given epoch membership.

Depending on a flag it provides some hash of another member or the clients own announcement.

Parameters

[in]	membership	Membership
[out]	hash	Hash of announcement
[in]	other	Other flag

Returns: GNUNET_OK on success, otherwise GNUNET_SYSERR

Definition at line 147 of file messenger_api_epoch_membership.c.

{
  struct GNUNET_CONTAINER_MultiHashMapIterator *iterator;
  enum GNUNET_GenericReturnValue result;
 
  GNUNET_assert ((membership) && (hash));
 
  if (GNUNET_NO == other)
  {
    if (GNUNET_YES != is_epoch_membership_member (membership, NULL))
      return GNUNET_SYSERR;
 
    GNUNET_memcpy (hash, &(membership->announcement), sizeof (membership->
                                                              announcement));
    return GNUNET_OK;
  }
 
  iterator = GNUNET_CONTAINER_multihashmap_iterator_create (
    membership->members);
 
  if (! iterator)
    return GNUNET_SYSERR;
 
  result = GNUNET_SYSERR;
  while (GNUNET_YES == GNUNET_CONTAINER_multihashmap_iterator_next (iterator,
                                                                    hash, NULL))
  {
    if (0 != GNUNET_CRYPTO_hash_cmp (hash, &(membership->announcement)))
    {
      result = GNUNET_OK;
      break;
    }
  }
 
  GNUNET_CONTAINER_multihashmap_iterator_destroy (iterator);
  return result;
}

References GNUNET_MESSENGER_EpochMembership::announcement, GNUNET_assert, GNUNET_CONTAINER_multihashmap_iterator_create(), GNUNET_CONTAINER_multihashmap_iterator_destroy(), GNUNET_CONTAINER_multihashmap_iterator_next(), GNUNET_CRYPTO_hash_cmp(), GNUNET_memcpy, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, is_epoch_membership_member(), GNUNET_MESSENGER_EpochMembership::members, and result.

Referenced by get_epoch_announcement_member_hash(), and get_epoch_group_member_hash().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_epoch_membership_member_position()

uint32_t get_epoch_membership_member_position ( const struct GNUNET_MESSENGER_EpochMembership * membership )

Returns the index position of the client inside a given epoch in relation to its list of members.

Every member of an epoch gets a unique position that depends on the hash of their announcement message.

Parameters

[in] membership Membership

Returns: Member position

Definition at line 190 of file messenger_api_epoch_membership.c.

{
  struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
  struct GNUNET_HashCode hash;
  uint32_t position;
 
  GNUNET_assert (membership);
 
  position = get_epoch_membership_count (membership);
 
  if (GNUNET_YES != is_epoch_membership_member (membership, NULL))
    return position;
 
  iter = GNUNET_CONTAINER_multihashmap_iterator_create (membership->members);
 
  if (! iter)
    return position;
 
  position = 0;
 
  while (GNUNET_YES == GNUNET_CONTAINER_multihashmap_iterator_next (iter, &hash,
                                                                    NULL))
    if (0 < GNUNET_CRYPTO_hash_cmp (&(membership->announcement), &hash))
      position++;
 
  GNUNET_CONTAINER_multihashmap_iterator_destroy (iter);
  return position;
}

References GNUNET_MESSENGER_EpochMembership::announcement, get_epoch_membership_count(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_iterator_create(), GNUNET_CONTAINER_multihashmap_iterator_destroy(), GNUNET_CONTAINER_multihashmap_iterator_next(), GNUNET_CRYPTO_hash_cmp(), GNUNET_YES, is_epoch_membership_member(), and GNUNET_MESSENGER_EpochMembership::members.

Referenced by get_epoch_group_member_position().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirm_epoch_membership_announcment()

enum GNUNET_GenericReturnValue confirm_epoch_membership_announcment	(	struct GNUNET_MESSENGER_EpochMembership *	membership,
		const struct GNUNET_HashCode *	hash,
		const struct GNUNET_MESSENGER_Message *	message,
		struct GNUNET_MESSENGER_Contact *	contact,
		enum GNUNET_GenericReturnValue	sent
	)

Adds an announcement message with its hash to a given epoch membership as confirmation for a specific contact.

An additional flag specifies whether the message has been sent by the client or not.

Parameters

[in,out]	membership	Membership
[in]	hash	Hash of message
[in]	message	Message
[in,out]	contact	Contact
[in]	sent	Sent flag

Returns: GNUNET_YES on success, GNUNET_SYSERR on internal failure, otherwise GNUNET_NO

Definition at line 263 of file messenger_api_epoch_membership.c.

{
  struct GNUNET_MESSENGER_EpochMemberConfirmation confirmation;
 
  GNUNET_assert (
    (membership) &&
    (hash) &&
    (message) &&
    (GNUNET_MESSENGER_KIND_ANNOUNCEMENT == message->header.kind) &&
    (contact));
 
  if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_contains (membership->members,
                                                            hash))
    return GNUNET_NO;
 
  confirmation.members = membership->members;
  confirmation.hash = hash;
  confirmation.contact = contact;
 
  GNUNET_CONTAINER_multihashmap_iterate (membership->members,
                                         it_update_epoch_member,
                                         &confirmation);
 
  if ((confirmation.hash) &&
      (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (
         confirmation.members, confirmation.hash,
         confirmation.contact,
         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST)))
    return GNUNET_SYSERR;
 
  if (GNUNET_YES == sent)
    GNUNET_memcpy (&(membership->announcement), hash,
                   sizeof (membership->announcement));
 
  membership->count++;
  return GNUNET_YES;
}

References GNUNET_MESSENGER_EpochMembership::announcement, GNUNET_MESSENGER_EpochMemberConfirmation::contact, GNUNET_MESSENGER_EpochMembership::count, GNUNET_assert, GNUNET_CONTAINER_multihashmap_contains(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_memcpy, GNUNET_MESSENGER_KIND_ANNOUNCEMENT, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, GNUNET_MESSENGER_EpochMemberConfirmation::hash, GNUNET_MESSENGER_Message::header, it_update_epoch_member(), GNUNET_MESSENGER_MessageHeader::kind, GNUNET_MESSENGER_EpochMemberConfirmation::members, and GNUNET_MESSENGER_EpochMembership::members.

Referenced by confirm_epoch_announcement_member(), and confirm_epoch_group_member().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ revoke_epoch_membership_announcement()

enum GNUNET_GenericReturnValue revoke_epoch_membership_announcement	(	struct GNUNET_MESSENGER_EpochMembership *	membership,
		const struct GNUNET_HashCode *	hash,
		struct GNUNET_MESSENGER_Contact *	contact
	)

Drops an announcement message with a provided hash from a given epoch membership to revoke the confirmed membership of a specific contact.

Parameters

[in,out]	membership	Membership
[in]	hash	Hash of message
[in,out]	contact	Contact

Returns: GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 309 of file messenger_api_epoch_membership.c.

{
  GNUNET_assert ((membership) && (hash) && (contact));
 
  if (! membership->count)
    return GNUNET_NO;
 
  if (GNUNET_YES != GNUNET_CONTAINER_multihashmap_contains (membership->members,
                                                            hash))
    return GNUNET_NO;
 
  if (GNUNET_YES != GNUNET_CONTAINER_multihashmap_remove (membership->members,
                                                          hash, contact))
    return GNUNET_NO;
 
  if (0 == GNUNET_memcmp (hash, &(membership->announcement)))
    memset (&(membership->announcement), 0, sizeof (membership->announcement));
 
  membership->count--;
  return GNUNET_YES;
}

References GNUNET_MESSENGER_EpochMembership::announcement, GNUNET_MESSENGER_EpochMemberConfirmation::contact, GNUNET_MESSENGER_EpochMembership::count, GNUNET_assert, GNUNET_CONTAINER_multihashmap_contains(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_memcmp, GNUNET_NO, GNUNET_YES, GNUNET_MESSENGER_EpochMemberConfirmation::hash, and GNUNET_MESSENGER_EpochMembership::members.

Referenced by revoke_epoch_announcement_member().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ iterate_epoch_membership_members()

int iterate_epoch_membership_members	(	const struct GNUNET_MESSENGER_EpochMembership *	membership,
		GNUNET_MESSENGER_MembershipCallback	callback,
		void *	cls
	)

Iterate through all confirmed members of a given epoch membership and pass them through a provided callback with a custom closure.

Parameters

[in]	membership	Membership
[in]	callback	Iteration callback or NULL
[in]	cls	Closure or NULL

Returns: Amount of iterations

Definition at line 362 of file messenger_api_epoch_membership.c.

{
  struct GNUNET_MESSENGER_EpochMemberIteration iteration;
 
  GNUNET_assert (membership);
 
  iteration.callback = callback;
  iteration.cls = cls;
 
  return GNUNET_CONTAINER_multihashmap_iterate (membership->members,
                                                it_iterate_epoch_member,
                                                &iteration);
}

References GNUNET_MESSENGER_EpochMemberIteration::callback, GNUNET_MESSENGER_EpochMemberIteration::cls, GNUNET_assert, GNUNET_CONTAINER_multihashmap_iterate(), it_iterate_epoch_member(), and GNUNET_MESSENGER_EpochMembership::members.

Referenced by is_epoch_group_compatible(), is_epoch_group_missing_announcement(), and is_epoch_group_subgroup_of().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Typedefs

Functions

Typedef Documentation

◆ GNUNET_MESSENGER_MembershipCallback

Function Documentation

◆ create_epoch_membership()

◆ destroy_epoch_membership()

◆ get_epoch_membership_size()

◆ get_epoch_membership_count()

◆ is_epoch_membership_completed()

◆ is_epoch_membership_member()

◆ get_epoch_membership_member_hash()

◆ get_epoch_membership_member_position()

◆ confirm_epoch_membership_announcment()

◆ revoke_epoch_membership_announcement()

◆ iterate_epoch_membership_members()