scalarproduct_api.c File Reference

API for the scalarproduct. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_scalarproduct_service.h"
#include "gnunet_protocols.h"
#include "scalarproduct.h"

Include dependency graph for scalarproduct_api.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_SCALARPRODUCT_ComputationHandle
	A handle returned for each computation. More...

Macros
#define	LOG(kind, ...)   GNUNET_log_from (kind, "scalarproduct-api", __VA_ARGS__)

Typedefs
typedef void(*	GNUNET_SCALARPRODUCT_ResponseMessageHandler) (struct GNUNET_SCALARPRODUCT_ComputationHandle *h, const struct ClientResponseMessage *msg, enum GNUNET_SCALARPRODUCT_ResponseStatus status)
	The abstraction function for our internal callback. More...

Functions
static int	check_response (void *cls, const struct ClientResponseMessage *message)
	Called when a response is received from the service. More...
static void	process_status_message (struct GNUNET_SCALARPRODUCT_ComputationHandle *h, const struct ClientResponseMessage *msg, enum GNUNET_SCALARPRODUCT_ResponseStatus status)
	Handles the STATUS received from the service for a response, does not contain a payload. More...
static void	handle_response (void *cls, const struct ClientResponseMessage *message)
	Called when a response is received from the service. More...
static int	check_unique (const struct GNUNET_SCALARPRODUCT_Element *elements, uint32_t element_count)
	Check if the keys for all given elements are unique. More...
static void	mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
	We encountered an error communicating with the set service while performing a set operation. More...
struct GNUNET_SCALARPRODUCT_ComputationHandle *	GNUNET_SCALARPRODUCT_accept_computation (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_HashCode *session_key, const struct GNUNET_SCALARPRODUCT_Element *elements, uint32_t element_count, GNUNET_SCALARPRODUCT_ContinuationWithStatus cont, void *cont_cls)
	Used by Bob's client to cooperate with Alice,. More...
static void	process_result_message (struct GNUNET_SCALARPRODUCT_ComputationHandle *h, const struct ClientResponseMessage *msg, enum GNUNET_SCALARPRODUCT_ResponseStatus status)
	Handles the RESULT received from the service for a request, should contain a result MPI value. More...
struct GNUNET_SCALARPRODUCT_ComputationHandle *	GNUNET_SCALARPRODUCT_start_computation (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_HashCode *session_key, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_SCALARPRODUCT_Element *elements, uint32_t element_count, GNUNET_SCALARPRODUCT_DatumProcessor cont, void *cont_cls)
	Request by Alice's client for computing a scalar product. More...
void	GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle *h)
	Cancel an ongoing computation or revoke our collaboration offer. More...

Detailed Description

API for the scalarproduct.

Author

Christian Fuchs

Gaurav Kukreja

Christian Grothoff

Definition in file scalarproduct_api.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "scalarproduct-api", __VA_ARGS__)

Definition at line 34 of file scalarproduct_api.c.

Typedef Documentation

GNUNET_SCALARPRODUCT_ResponseMessageHandler

typedef void(* GNUNET_SCALARPRODUCT_ResponseMessageHandler) (struct GNUNET_SCALARPRODUCT_ComputationHandle *h, const struct ClientResponseMessage *msg, enum GNUNET_SCALARPRODUCT_ResponseStatus status)

The abstraction function for our internal callback.

Parameters

h	computation handle
msg	response we got, NULL on errors
status	processing status code

Definition at line 44 of file scalarproduct_api.c.

Function Documentation

check_response()

static int check_response ( void *  cls, const struct ClientResponseMessage *  message  )

static

Called when a response is received from the service.

Perform basic check that the message is well-formed.

Parameters

cls	Pointer to the Master Context
message	Pointer to the data received in response

Returns

GNUNET_OK if message is well-formed

Definition at line 103 of file scalarproduct_api.c.

{
  if (ntohs (message->header.size) !=
      ntohl (message->product_length) + sizeof(struct ClientResponseMessage))
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, ClientResponseMessage::header, ClientResponseMessage::product_length, and GNUNET_MessageHeader::size.

process_status_message()

static void process_status_message ( struct GNUNET_SCALARPRODUCT_ComputationHandle *  h, const struct ClientResponseMessage *  msg, enum GNUNET_SCALARPRODUCT_ResponseStatus  status  )

static

Handles the STATUS received from the service for a response, does not contain a payload.

Called when we participate as "Bob" via GNUNET_SCALARPRODUCT_accept_computation().

Parameters

h	our Handle
msg	the response received
status	the condition the request was terminated with (eg: disconnect)

Definition at line 126 of file scalarproduct_api.c.

{
  if (NULL != h->cont_status)
    h->cont_status (h->cont_cls,
                    status);
  GNUNET_SCALARPRODUCT_cancel (h);
}

References GNUNET_SCALARPRODUCT_cancel(), h, and status.

Referenced by GNUNET_SCALARPRODUCT_accept_computation().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_response()

static void handle_response ( void *  cls, const struct ClientResponseMessage *  message  )

static

Called when a response is received from the service.

After basic check, the handler in h->response_proc is called. This functions handles the response to the client which used the API.

Parameters

cls	Pointer to the Master Context
message	Pointer to the data received in response

Definition at line 146 of file scalarproduct_api.c.

{
  struct GNUNET_SCALARPRODUCT_ComputationHandle *h = cls;
  enum GNUNET_SCALARPRODUCT_ResponseStatus status;
 
  status = ntohl (message->status);
  h->response_proc (h,
                    message,
                    status);
}

References h, status, and ClientResponseMessage::status.

check_unique()

static int check_unique ( const struct GNUNET_SCALARPRODUCT_Element *  elements, uint32_t  element_count  )

static

Check if the keys for all given elements are unique.

Parameters

elements	elements to check
element_count	size of the elements array

Returns

GNUNET_OK if all keys are unique

Definition at line 167 of file scalarproduct_api.c.

{
  struct GNUNET_CONTAINER_MultiHashMap *map;
  int ok;
 
  ok = GNUNET_OK;
  map = GNUNET_CONTAINER_multihashmap_create (2 * element_count,
                                              GNUNET_YES);
  for (uint32_t i = 0; i < element_count; i++)
    if (GNUNET_OK !=
        GNUNET_CONTAINER_multihashmap_put (map,
                                           &elements[i].key,
                                           map,
                                           GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  _ ("Keys given to SCALARPRODUCT not unique!\n"));
      ok = GNUNET_SYSERR;
    }
  GNUNET_CONTAINER_multihashmap_destroy (map);
  return ok;
}

References _, GNUNET_CONTAINER_multihashmap_create(), GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, key, and map.

Referenced by GNUNET_SCALARPRODUCT_accept_computation(), and GNUNET_SCALARPRODUCT_start_computation().

Here is the call graph for this function:

Here is the caller graph for this function:

mq_error_handler()

static void mq_error_handler ( void *  cls, enum GNUNET_MQ_Error  error  )

static

We encountered an error communicating with the set service while performing a set operation.

Report to the application.

Parameters

cls	the struct GNUNET_SCALARPRODUCT_ComputationHandle
error	error code

Definition at line 200 of file scalarproduct_api.c.

{
  struct GNUNET_SCALARPRODUCT_ComputationHandle *h = cls;
 
  LOG (GNUNET_ERROR_TYPE_INFO,
       "Disconnected from SCALARPRODUCT service.\n");
  h->response_proc (h,
                    NULL,
                    GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED);
}

References GNUNET_ERROR_TYPE_INFO, GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED, h, and LOG.

Referenced by GNUNET_SCALARPRODUCT_accept_computation(), and GNUNET_SCALARPRODUCT_start_computation().

Here is the caller graph for this function:

process_result_message()

static void process_result_message ( struct GNUNET_SCALARPRODUCT_ComputationHandle *  h, const struct ClientResponseMessage *  msg, enum GNUNET_SCALARPRODUCT_ResponseStatus  status  )

static

Handles the RESULT received from the service for a request, should contain a result MPI value.

Called when we participate as "Alice" via GNUNET_SCALARPRODUCT_start_computation().

Parameters

h	our Handle
msg	Pointer to the response received
status	the condition the request was terminated with (eg: disconnect)

Definition at line 310 of file scalarproduct_api.c.

{
  uint32_t product_len;
  gcry_mpi_t result = NULL;
  gcry_error_t rc;
  gcry_mpi_t num;
  size_t rsize;
 
  if (GNUNET_SCALARPRODUCT_STATUS_SUCCESS == status)
  {
    result = gcry_mpi_new (0);
 
    product_len = ntohl (msg->product_length);
    if (0 < product_len)
    {
      rsize = 0;
      if (0 != (rc = gcry_mpi_scan (&num, GCRYMPI_FMT_STD,
                                    &msg[1],
                                    product_len,
                                    &rsize)))
      {
        LOG_GCRY (GNUNET_ERROR_TYPE_ERROR,
                  "gcry_mpi_scan",
                  rc);
        gcry_mpi_release (result);
        result = NULL;
        status = GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE;
      }
      else
      {
        if (0 < (int32_t) ntohl (msg->range))
          gcry_mpi_add (result, result, num);
        else
          gcry_mpi_sub (result, result, num);
        gcry_mpi_release (num);
      }
    }
  }
  if (NULL != h->cont_datum)
    h->cont_datum (h->cont_cls,
                   status,
                   result);
  if (NULL != result)
    gcry_mpi_release (result);
  GNUNET_SCALARPRODUCT_cancel (h);
}

References GNUNET_ERROR_TYPE_ERROR, GNUNET_SCALARPRODUCT_cancel(), GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE, GNUNET_SCALARPRODUCT_STATUS_SUCCESS, h, LOG_GCRY, msg, result, and status.

Referenced by GNUNET_SCALARPRODUCT_start_computation().

Here is the call graph for this function:

Here is the caller graph for this function: