gnunet-service-rps_view.c File Reference

wrapper around the "local view" More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet-service-rps_view.h"
#include <inttypes.h>

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

Go to the source code of this file.

Data Structures
struct	View

Functions
struct View *	View_create (uint32_t len)
	Create an empty view.
void	View_change_len (struct View *view, uint32_t len)
	Change length of view.
const struct GNUNET_PeerIdentity *	View_get_as_array (const struct View *view)
	Get the view as an array.
unsigned int	View_size (const struct View *view)
	Get the size of the view.
int	View_put (struct View *view, const struct GNUNET_PeerIdentity *peer)
	Insert peer into the view.
int	View_contains_peer (const struct View *view, const struct GNUNET_PeerIdentity *peer)
	Check whether view contains a peer.
int	View_remove_peer (struct View *view, const struct GNUNET_PeerIdentity *peer)
	Remove peer from view.
const struct GNUNET_PeerIdentity *	View_get_peer_by_index (const struct View *view, uint32_t index)
	Get a peer by index.
void	View_clear (struct View *view)
	Clear the view.
void	View_destroy (struct View *view)
	Destroy view.

Detailed Description

wrapper around the "local view"

Author

Julius Bünger

Definition in file gnunet-service-rps_view.c.

Function Documentation

View_create()

struct View * View_create

(

uint32_t

len

)

Create an empty view.

Parameters

len	the maximum length for the view

Returns

The newly created view

Definition at line 57 of file gnunet-service-rps_view.c.

{
  struct View *view;
 
  view = GNUNET_new (struct View);
  view->length = len;
  view->array = GNUNET_new_array (len, struct GNUNET_PeerIdentity);
  view->mpm =
    GNUNET_CONTAINER_multipeermap_create (len, GNUNET_NO);  /* might even be
                                                           * set to _YES */
  return view;
}

References View::array, GNUNET_CONTAINER_multipeermap_create(), GNUNET_new, GNUNET_new_array, GNUNET_NO, View::length, and View::mpm.

Referenced by new_sub().

Here is the call graph for this function:

Here is the caller graph for this function:

View_change_len()

void View_change_len	(	struct View *	view,
		uint32_t	len
	)

Change length of view.

If size is decreased, peers with higher indices are removed.

Parameters

view	The view that is changed
len	the (maximum) length for the view

Definition at line 80 of file gnunet-service-rps_view.c.

{
  uint32_t i;
  uint32_t *index;
 
  if (GNUNET_CONTAINER_multipeermap_size (view->mpm) < len)
  {   /* Simply shrink */
      /* We might simply clear and free the left over space */
    GNUNET_array_grow (view->array, view->length, len);
  }
  else /* We have to remove elements */
  {
    /* TODO find a way to preserve indices */
    for (i = 0; i < len; i++)
    {
      index = GNUNET_CONTAINER_multipeermap_get (view->mpm, &view->array[i]);
      GNUNET_assert (NULL != index);
      GNUNET_free (index);
    }
    GNUNET_array_grow (view->array, view->length, len);
    GNUNET_CONTAINER_multipeermap_destroy (view->mpm);
    view->mpm = GNUNET_CONTAINER_multipeermap_create (len, GNUNET_NO);
    for (i = 0; i < len; i++)
    {
      index = GNUNET_new (uint32_t);
      *index = i;
      GNUNET_CONTAINER_multipeermap_put (view->mpm, &view->array[i], index,
                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
    }
  }
  GNUNET_assert (view->length == len);
}

References View::array, GNUNET_array_grow, GNUNET_assert, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_CONTAINER_multipeermap_create(), GNUNET_CONTAINER_multipeermap_destroy(), GNUNET_CONTAINER_multipeermap_get(), GNUNET_CONTAINER_multipeermap_put(), GNUNET_CONTAINER_multipeermap_size(), GNUNET_free, GNUNET_new, GNUNET_NO, View::length, and View::mpm.

Referenced by adapt_sizes().

Here is the call graph for this function:

Here is the caller graph for this function:

View_get_as_array()

const struct GNUNET_PeerIdentity * View_get_as_array

(

const struct View *

view

)

Get the view as an array.

Parameters

view	The view of which the array representation is of interest

Returns

the view in array representation

Definition at line 122 of file gnunet-service-rps_view.c.

{
  return view->array;
}

References View::array.

Referenced by clients_notify_view_update(), do_round(), handle_peer_pull_request(), and send_view().

Here is the caller graph for this function:

View_size()

unsigned int View_size

(

const struct View *

view

)

Get the size of the view.

Parameters

view	The view of which the size should be returned

Returns

current number of actually contained peers

Definition at line 135 of file gnunet-service-rps_view.c.

{
  return GNUNET_CONTAINER_multipeermap_size (view->mpm);
}

References GNUNET_CONTAINER_multipeermap_size(), and View::mpm.

Referenced by clients_notify_view_update(), do_round(), handle_peer_pull_request(), insert_in_view(), send_view(), View_clear(), View_put(), and View_remove_peer().

Here is the call graph for this function:

Here is the caller graph for this function:

View_put()

int View_put	(	struct View *	view,
		const struct GNUNET_PeerIdentity *	peer
	)

Insert peer into the view.

Parameters

view	The view to put the peer into
peer	the peer to insert

Returns

GNUNET_OK if peer was actually inserted GNUNET_NO if peer was not inserted

Definition at line 151 of file gnunet-service-rps_view.c.

{
  uint32_t *index;
 
  if ((view->length <= View_size (view)) ||  /* If array is 'full' */
      (GNUNET_YES == View_contains_peer (view, peer)))
  {
    return GNUNET_NO;
  }
  else
  {
    index = GNUNET_new (uint32_t);
    *index = (uint32_t) View_size (view);
    view->array[*index] = *peer;
    GNUNET_CONTAINER_multipeermap_put (view->mpm, peer, index,
                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
    return GNUNET_OK;
  }
}

References View::array, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_CONTAINER_multipeermap_put(), GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_YES, View::length, View::mpm, View_contains_peer(), and View_size().

Referenced by insert_in_view().

Here is the call graph for this function:

Here is the caller graph for this function:

View_contains_peer()

int View_contains_peer	(	const struct View *	view,
		const struct GNUNET_PeerIdentity *	peer
	)

Check whether view contains a peer.

Parameters

view	The which is checked for a peer
peer	the peer to check for

Returns

GNUNET_OK if view contains peer GNUNET_NO otherwise

Definition at line 183 of file gnunet-service-rps_view.c.

{
  return GNUNET_CONTAINER_multipeermap_contains (view->mpm, peer);
}

References GNUNET_CONTAINER_multipeermap_contains(), and View::mpm.

Referenced by check_sending_channel_needed(), clean_peer(), View_put(), and View_remove_peer().

Here is the call graph for this function:

Here is the caller graph for this function:

View_remove_peer()

int View_remove_peer	(	struct View *	view,
		const struct GNUNET_PeerIdentity *	peer
	)

Remove peer from view.

Parameters

view	The view of which to remove the peer
peer	the peer to remove

Returns

GNUNET_OK if view contained peer and removed it successfully GNUNET_NO if view does not contain peer

Definition at line 200 of file gnunet-service-rps_view.c.

{
  uint32_t *index;
  uint32_t *swap_index;
  uint32_t last_index;
 
  if (GNUNET_NO == View_contains_peer (view, peer))
  {
    return GNUNET_NO;
  }
  index = GNUNET_CONTAINER_multipeermap_get (view->mpm, peer);
  GNUNET_assert (NULL != index);
  last_index = View_size (view) - 1;
  if (*index < last_index)
  {   /* Fill the 'gap' in the array with the last peer */
    view->array[*index] = view->array[last_index];
    GNUNET_assert (GNUNET_YES == View_contains_peer (view,
                                                     &view->array[last_index]));
    swap_index = GNUNET_CONTAINER_multipeermap_get (view->mpm,
                                                    &view->array[last_index]);
    GNUNET_assert (NULL != swap_index);
    *swap_index = *index;
    GNUNET_free (index);
  }
  GNUNET_CONTAINER_multipeermap_remove_all (view->mpm, peer);
  return GNUNET_OK;
}

References View::array, GNUNET_assert, GNUNET_CONTAINER_multipeermap_get(), GNUNET_CONTAINER_multipeermap_remove_all(), GNUNET_free, GNUNET_NO, GNUNET_OK, GNUNET_YES, View::mpm, View_contains_peer(), and View_size().

Referenced by remove_peer().

Here is the call graph for this function:

Here is the caller graph for this function:

View_get_peer_by_index()

const struct GNUNET_PeerIdentity * View_get_peer_by_index	(	const struct View *	view,
		uint32_t	index
	)

Get a peer by index.

Parameters

view	the view of which to get the peer
index	the index of the peer to get

Returns

peer to the corresponding index. NULL if this index is not known

Definition at line 240 of file gnunet-service-rps_view.c.

{
  if (index < GNUNET_CONTAINER_multipeermap_size (view->mpm))
  {
    return &view->array[index];
  }
  else
  {
    return NULL;
  }
}

References View::array, GNUNET_CONTAINER_multipeermap_size(), and View::mpm.

Here is the call graph for this function:

View_clear()

void View_clear

(

struct View *

view

)

Clear the view.

Parameters

view	The view to clear

Definition at line 260 of file gnunet-service-rps_view.c.

{
  for (uint32_t i = 0; 0 < View_size (view); i++)
  {   /* Need to free indices stored at peers */
    uint32_t *index;
 
    GNUNET_assert (GNUNET_YES ==
                   GNUNET_CONTAINER_multipeermap_contains (view->mpm,
                                                           &view->array[i]));
    index = GNUNET_CONTAINER_multipeermap_get (view->mpm, &view->array[i]);
    GNUNET_assert (NULL != index);
    GNUNET_free (index);
    GNUNET_CONTAINER_multipeermap_remove_all (view->mpm, &view->array[i]);
  }
  GNUNET_assert (0 == View_size (view));
}

References View::array, GNUNET_assert, GNUNET_CONTAINER_multipeermap_contains(), GNUNET_CONTAINER_multipeermap_get(), GNUNET_CONTAINER_multipeermap_remove_all(), GNUNET_free, GNUNET_YES, View::mpm, and View_size().

Referenced by do_round(), and View_destroy().

Here is the call graph for this function:

Here is the caller graph for this function:

View_destroy()

void View_destroy

(

struct View *

view

)

Destroy view.

Parameters

view	the view to destroy

Definition at line 284 of file gnunet-service-rps_view.c.

{
  View_clear (view);
  GNUNET_free (view->array);
  view->array = NULL;
  GNUNET_CONTAINER_multipeermap_destroy (view->mpm);
  GNUNET_free (view);
}

References View::array, GNUNET_CONTAINER_multipeermap_destroy(), GNUNET_free, View::mpm, and View_clear().

Referenced by destroy_sub().

Here is the call graph for this function:

Here is the caller graph for this function: