gnunet-service-fs_pe.h File Reference

API to manage query plan. More...

#include "gnunet-service-fs.h"

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

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

Go to the source code of this file.

Functions
void	GSF_plan_add_ (struct GSF_ConnectedPeer *cp, struct GSF_PendingRequest *pr)
	Create a new query plan entry. More...
void	GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
	Notify the plan about a peer being no longer available; destroy all entries associated with this peer. More...
void	GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
	Notify the plan about a request being done; destroy all entries associated with this request. More...
int	GSF_request_plan_reference_get_last_transmission_ (struct GSF_PendingRequestPlanBijection *pr_head, struct GSF_ConnectedPeer *sender, struct GNUNET_TIME_Absolute *result)
	Get the last transmission attempt time for the request plan list referenced by 'rpr_head', that was sent to 'sender'. More...
void	GSF_plan_init (void)
	Initialize plan subsystem. More...
void	GSF_plan_done (void)
	Shutdown plan subsystem. More...

Detailed Description

API to manage query plan.

Author

Christian Grothoff

Definition in file gnunet-service-fs_pe.h.

Function Documentation

GSF_plan_add_()

void GSF_plan_add_	(	struct GSF_ConnectedPeer *	cp,
		struct GSF_PendingRequest *	pr
	)

Create a new query plan entry.

Parameters

cp	peer with the entry
pr	request with the entry

Definition at line 557 of file gnunet-service-fs_pe.c.

{
  const struct GNUNET_PeerIdentity *id;
  struct PeerPlan *pp;
  struct GSF_PendingRequestData *prd;
  struct GSF_RequestPlan *rp;
  struct GSF_PendingRequestPlanBijection *bi;
  struct MergeContext mpc;
 
  GNUNET_assert (GNUNET_YES ==
                 GSF_pending_request_test_active_ (pr));
  GNUNET_assert (NULL != cp);
  id = GSF_connected_peer_get_identity2_ (cp);
  pp = GNUNET_CONTAINER_multipeermap_get (plans, id);
  if (NULL == pp)
  {
    pp = GNUNET_new (struct PeerPlan);
    pp->plan_map = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
    pp->priority_heap =
      GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
    pp->delay_heap =
      GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
    pp->cp = cp;
    GNUNET_assert (GNUNET_OK ==
                   GNUNET_CONTAINER_multipeermap_put (plans,
                                                      id,
                                                      pp,
                                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
    pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission,
                                         pp);
  }
  mpc.merged = GNUNET_NO;
  mpc.pr = pr;
  prd = GSF_pending_request_get_data_ (pr);
  GNUNET_CONTAINER_multihashmap_get_multiple (pp->plan_map,
                                              &prd->query,
                                              &merge_pr,
                                              &mpc);
  if (GNUNET_NO != mpc.merged)
    return;
  plan_count++;
  GNUNET_STATISTICS_update (GSF_stats,
                            gettext_noop ("# query plan entries"),
                            1,
                            GNUNET_NO);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Planning transmission of query `%s' to peer `%s'\n",
              GNUNET_h2s (&prd->query),
              GNUNET_i2s (id));
  rp = GNUNET_new (struct GSF_RequestPlan);
  bi = GNUNET_new (struct GSF_PendingRequestPlanBijection);
  bi->rp = rp;
  bi->pr = pr;
  GNUNET_CONTAINER_MDLL_insert (PR,
                                prd->pr_head,
                                prd->pr_tail,
                                bi);
  GNUNET_CONTAINER_MDLL_insert (PE,
                                rp->pe_head,
                                rp->pe_tail,
                                bi);
  rp->pp = pp;
  GNUNET_assert (GNUNET_YES ==
                 GNUNET_CONTAINER_multihashmap_put (pp->plan_map,
                                                    get_rp_key (rp),
                                                    rp,
                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
  plan (pp,
        rp);
}

References PeerPlan::cp, PeerPlan::delay_heap, get_rp_key(), gettext_noop, GNUNET_assert, GNUNET_CONTAINER_heap_create(), GNUNET_CONTAINER_HEAP_ORDER_MAX, GNUNET_CONTAINER_HEAP_ORDER_MIN, GNUNET_CONTAINER_MDLL_insert, GNUNET_CONTAINER_multihashmap_create(), GNUNET_CONTAINER_multihashmap_get_multiple(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_CONTAINER_multipeermap_get(), GNUNET_CONTAINER_multipeermap_put(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_i2s(), GNUNET_log, GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_now(), GNUNET_STATISTICS_update(), GNUNET_YES, GSF_connected_peer_get_identity2_(), GSF_pending_request_get_data_(), GSF_pending_request_test_active_(), GSF_stats, id, merge_pr(), MergeContext::merged, plan(), plan_count, PeerPlan::plan_map, plans, GSF_PendingRequestPlanBijection::pr, MergeContext::pr, GSF_PendingRequestData::pr_head, GSF_PendingRequestData::pr_tail, PeerPlan::priority_heap, GSF_PendingRequestData::query, rp, GSF_PendingRequestPlanBijection::rp, schedule_peer_transmission(), and PeerPlan::task.

Referenced by consider_peer_for_forwarding(), and consider_request_for_forwarding().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_plan_notify_peer_disconnect_()

void GSF_plan_notify_peer_disconnect_

(

const struct GSF_ConnectedPeer *

cp

)

Notify the plan about a peer being no longer available; destroy all entries associated with this peer.

Parameters

cp	connected peer

Definition at line 637 of file gnunet-service-fs_pe.c.

{
  const struct GNUNET_PeerIdentity *id;
  struct PeerPlan *pp;
  struct GSF_RequestPlan *rp;
  struct GSF_PendingRequestData *prd;
  struct GSF_PendingRequestPlanBijection *bi;
 
  id = GSF_connected_peer_get_identity2_ (cp);
  pp = GNUNET_CONTAINER_multipeermap_get (plans, id);
  if (NULL == pp)
    return;                     /* nothing was ever planned for this peer */
  GNUNET_assert (GNUNET_YES ==
                 GNUNET_CONTAINER_multipeermap_remove (plans, id,
                                                       pp));
  if (NULL != pp->task)
  {
    GNUNET_SCHEDULER_cancel (pp->task);
    pp->task = NULL;
  }
  while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
  {
    GNUNET_break (GNUNET_YES ==
                  GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
                                                        get_rp_key (rp),
                                                        rp));
    while (NULL != (bi = rp->pe_head))
    {
      GNUNET_CONTAINER_MDLL_remove (PE,
                                    rp->pe_head,
                                    rp->pe_tail,
                                    bi);
      prd = GSF_pending_request_get_data_ (bi->pr);
      GNUNET_CONTAINER_MDLL_remove (PR,
                                    prd->pr_head,
                                    prd->pr_tail,
                                    bi);
      GNUNET_free (bi);
    }
    plan_count--;
    GNUNET_free (rp);
  }
  GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
  while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
  {
    GNUNET_break (GNUNET_YES ==
                  GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
                                                        get_rp_key (rp),
                                                        rp));
    while (NULL != (bi = rp->pe_head))
    {
      prd = GSF_pending_request_get_data_ (bi->pr);
      GNUNET_CONTAINER_MDLL_remove (PE,
                                    rp->pe_head,
                                    rp->pe_tail,
                                    bi);
      GNUNET_CONTAINER_MDLL_remove (PR,
                                    prd->pr_head,
                                    prd->pr_tail,
                                    bi);
      GNUNET_free (bi);
    }
    plan_count--;
    GNUNET_free (rp);
  }
  GNUNET_STATISTICS_set (GSF_stats,
                         gettext_noop ("# query plan entries"),
                         plan_count,
                         GNUNET_NO);
  GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
  GNUNET_CONTAINER_multihashmap_destroy (pp->plan_map);
  GNUNET_free (pp);
}

References PeerPlan::delay_heap, get_rp_key(), gettext_noop, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_heap_destroy(), GNUNET_CONTAINER_heap_remove_root(), GNUNET_CONTAINER_MDLL_remove, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_CONTAINER_multipeermap_get(), GNUNET_CONTAINER_multipeermap_remove(), GNUNET_free, GNUNET_NO, GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_set(), GNUNET_YES, GSF_connected_peer_get_identity2_(), GSF_pending_request_get_data_(), GSF_stats, id, plan_count, PeerPlan::plan_map, plans, GSF_PendingRequestPlanBijection::pr, GSF_PendingRequestData::pr_head, GSF_PendingRequestData::pr_tail, PeerPlan::priority_heap, rp, and PeerPlan::task.

Referenced by GSF_peer_disconnect_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_plan_notify_request_done_()

void GSF_plan_notify_request_done_

(

struct GSF_PendingRequest *

pr

)

Notify the plan about a request being done; destroy all entries associated with this request.

Parameters

pr	request that is done

Definition at line 754 of file gnunet-service-fs_pe.c.

{
  struct GSF_RequestPlan *rp;
  struct GSF_PendingRequestData *prd;
  struct GSF_PendingRequestPlanBijection *bi;
 
  prd = GSF_pending_request_get_data_ (pr);
  while (NULL != (bi = prd->pr_head))
  {
    rp = bi->rp;
    GNUNET_CONTAINER_MDLL_remove (PR,
                                  prd->pr_head,
                                  prd->pr_tail,
                                  bi);
    GNUNET_CONTAINER_MDLL_remove (PE,
                                  rp->pe_head,
                                  rp->pe_tail,
                                  bi);
    GNUNET_assert (bi->pr == pr);
    if (NULL == rp->pe_head)
    {
      GNUNET_CONTAINER_heap_remove_node (rp->hn);
      plan_count--;
      GNUNET_break (GNUNET_YES ==
                    GNUNET_CONTAINER_multihashmap_remove (rp->pp->plan_map,
                                                          &prd->query,
                                                          rp));
      GNUNET_free (rp);
    }
    GNUNET_free (bi);
  }
  GNUNET_STATISTICS_set (GSF_stats,
                         gettext_noop ("# query plan entries"),
                         plan_count,
                         GNUNET_NO);
}

References gettext_noop, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_heap_remove_node(), GNUNET_CONTAINER_MDLL_remove, GNUNET_CONTAINER_multihashmap_remove(), GNUNET_free, GNUNET_NO, GNUNET_STATISTICS_set(), GNUNET_YES, GSF_pending_request_get_data_(), GSF_stats, plan_count, GSF_PendingRequestPlanBijection::pr, GSF_PendingRequestData::pr_head, GSF_PendingRequestData::pr_tail, GSF_PendingRequestData::query, rp, and GSF_PendingRequestPlanBijection::rp.

Referenced by clean_request(), and GSF_pending_request_cancel_().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_request_plan_reference_get_last_transmission_()

int GSF_request_plan_reference_get_last_transmission_	(	struct GSF_PendingRequestPlanBijection *	pr_head,
		struct GSF_ConnectedPeer *	sender,
		struct GNUNET_TIME_Absolute *	result
	)

Get the last transmission attempt time for the request plan list referenced by 'rpr_head', that was sent to 'sender'.

Parameters

pr_head	request plan reference list to check.
sender	the peer that we've sent the request to.
result	the timestamp to fill.

Returns

GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.

Get the last transmission attempt time for the request plan list referenced by 'rpr_head', that was sent to 'sender'.

Parameters

pr_head	request plan reference list to check.
sender	the peer that we've sent the request to.
result	the timestamp to fill, set to GNUNET_TIME_UNIT_FOREVER_ABS if never transmitted

Returns

GNUNET_YES if result was changed, GNUNET_NO otherwise.

Definition at line 722 of file gnunet-service-fs_pe.c.

{
  struct GSF_PendingRequestPlanBijection *bi;
 
  for (bi = pr_head; NULL != bi; bi = bi->next_PR)
  {
    if (bi->rp->pp->cp == sender)
    {
      if (0 == bi->rp->last_transmission.abs_value_us)
        *result = GNUNET_TIME_UNIT_FOREVER_ABS;
      else
        *result = bi->rp->last_transmission;
      return GNUNET_YES;
    }
  }
  return GNUNET_NO;
}

References GNUNET_TIME_Absolute::abs_value_us, PeerPlan::cp, GNUNET_NO, GNUNET_TIME_UNIT_FOREVER_ABS, GNUNET_YES, GSF_RequestPlan::last_transmission, GSF_PendingRequestPlanBijection::next_PR, GSF_RequestPlan::pp, result, and GSF_PendingRequestPlanBijection::rp.

Referenced by process_reply().

Here is the caller graph for this function:

GSF_plan_init()

void GSF_plan_init

(

void

)

Initialize plan subsystem.

Definition at line 796 of file gnunet-service-fs_pe.c.

{
  plans = GNUNET_CONTAINER_multipeermap_create (256,
                                                GNUNET_YES);
}

References GNUNET_CONTAINER_multipeermap_create(), GNUNET_YES, and plans.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GSF_plan_done()

void GSF_plan_done

(

void

)

Shutdown plan subsystem.

Definition at line 807 of file gnunet-service-fs_pe.c.

{
  GNUNET_assert (0 == GNUNET_CONTAINER_multipeermap_size (plans));
  GNUNET_CONTAINER_multipeermap_destroy (plans);
}

References GNUNET_assert, GNUNET_CONTAINER_multipeermap_destroy(), GNUNET_CONTAINER_multipeermap_size(), and plans.

Referenced by shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function: