* @brief API for the scalarproduct
* @author Christian Fuchs
* @author Gaurav Kukreja
- *
+ *
*/
#include "platform.h"
#include "gnunet_util_lib.h"
*** Datatype Declarations **********
**************************************************************/
+/**
+ * the abstraction function for our internal callback
+ */
+typedef void (*GNUNET_SCALARPRODUCT_ResponseMessageHandler) (void *cls,
+ const struct GNUNET_MessageHeader *msg,
+ enum GNUNET_SCALARPRODUCT_ResponseStatus status);
+
/**
* Entry in the request queue per client
*/
* This is a linked list.
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle *prev;
-
+
/**
* Our configuration.
*/
/**
* The shared session key identifying this computation
*/
- struct GNUNET_HashCode * key;
-
+ struct GNUNET_HashCode key;
+
/**
* Current transmit handle.
*/
*/
struct GNUNET_SCALARPRODUCT_client_request * msg;
+ /**
+ * The msg handler callback
+ */
union
{
- /**
- * Function to call after transmission of the request.
- */
- GNUNET_SCALARPRODUCT_ContinuationWithStatus cont_status;
-
- /**
- * Function to call after transmission of the request.
- */
- GNUNET_SCALARPRODUCT_DatumProcessor cont_datum;
+ /**
+ * Function to call after transmission of the request.
+ */
+ GNUNET_SCALARPRODUCT_ContinuationWithStatus cont_status;
+
+ /**
+ * Function to call after transmission of the request.
+ */
+ GNUNET_SCALARPRODUCT_DatumProcessor cont_datum;
};
/**
*** Function Declarations **********
**************************************************************/
-/**
- * Called when a response is received from the service. After basic check
- * handler in qe->response_proc is called. This functions handles the response
- * to the client which used the API.
- *
- * @param cls Pointer to the Master Context
- * @param msg Pointer to the data received in response
- */
-static void
-receive_cb (void *cls, const struct GNUNET_MessageHeader *msg);
-
-/**
- * Transmits the request to the VectorProduct Sevice
- *
- * @param cls Closure
- * @param size Size of the buffer
- * @param buf Pointer to the buffer
- *
- * @return Size of the message sent
- */
-static size_t transmit_request (void *cls, size_t size,
- void *buf);
+void
+GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle * h);
/**************************************************************
*** Static Function Declarations **********
**************************************************************/
+
/**
- * Handles the RESULT received in reply of prepare_response from the
- * service
- *
- * @param cls Handle to the Master Context
+ * Handles the STATUS received from the service for a response, does not contain a payload
+ *
+ * @param cls our Handle
* @param msg Pointer to the response received
+ * @param status the condition the request was terminated with (eg: disconnect)
*/
static void
process_status_message (void *cls,
/**
- * Handles the RESULT received in reply of prepare_response from the
- * service
- *
- * @param cls Handle to the Master Context
+ * Handles the RESULT received from the service for a request, should contain a result MPI value
+ *
+ * @param cls our Handle
* @param msg Pointer to the response received
+ * @param status the condition the request was terminated with (eg: disconnect)
*/
static void
process_result_message (void *cls,
const struct GNUNET_SCALARPRODUCT_client_response *message =
(const struct GNUNET_SCALARPRODUCT_client_response *) msg;
gcry_mpi_t result = NULL;
+ gcry_error_t rc;
- if (GNUNET_SCALARPRODUCT_Status_Success == status
- && qe->cont_datum != NULL)
+ if (GNUNET_SCALARPRODUCT_Status_Success == status)
{
- size_t product_len = ntohl(message->product_length);
- result = gcry_mpi_new(0);
-
+ size_t product_len = ntohl (message->product_length);
+ result = gcry_mpi_new (0);
+
if (0 < product_len)
{
gcry_mpi_t num;
size_t read = 0;
- if (0 != gcry_mpi_scan (&num, GCRYMPI_FMT_USG, &msg[1], product_len, &read)){
- LOG (GNUNET_ERROR_TYPE_ERROR, "Could not convert to mpi to value!\n");
- gcry_mpi_release(result);
+ if (0 != (rc = gcry_mpi_scan (&num, GCRYMPI_FMT_STD, &message[1], product_len, &read)))
+ {
+ LOG_GCRY(GNUNET_ERROR_TYPE_ERROR, "gcry_mpi_scan", rc);
+ gcry_mpi_release (result);
result = NULL;
status = GNUNET_SCALARPRODUCT_Status_InvalidResponse;
}
else
{
- if (message->range > 0)
- gcry_mpi_add(result, result, num);
- else
- gcry_mpi_sub(result, result, num);
- gcry_mpi_release(num);
+ if (0 < message->range)
+ gcry_mpi_add (result, result, num);
+ else if (0 > message->range)
+ gcry_mpi_sub (result, result, num);
+ gcry_mpi_release (num);
}
}
}
- qe->cont_datum (qe->cont_cls, status, result);
+ qe->cont_datum (qe->cont_cls, status, result);
}
/**
- * Called when a response is received from the service. After basic check
+ * Called when a response is received from the service. After basic check, the
* handler in qe->response_proc is called. This functions handles the response
* to the client which used the API.
- *
+ *
* @param cls Pointer to the Master Context
* @param msg Pointer to the data received in response
*/
LOG (GNUNET_ERROR_TYPE_WARNING, "Disconnected by Service.\n");
status = GNUNET_SCALARPRODUCT_Status_ServiceDisconnected;
}
- else if ( GNUNET_MESSAGE_TYPE_SCALARPRODUCT_SERVICE_TO_CLIENT != ntohs (msg->type))
+ else if (GNUNET_MESSAGE_TYPE_SCALARPRODUCT_SERVICE_TO_CLIENT != ntohs (msg->type))
{
LOG (GNUNET_ERROR_TYPE_WARNING, "Invalid message type received\n");
}
status = GNUNET_SCALARPRODUCT_Status_Success;
}
-
+
if (qe->cont_datum != NULL)
qe->response_proc (qe, msg, status);
+ GNUNET_CONTAINER_DLL_remove (head, tail, qe);
GNUNET_free (qe);
}
/**
- * Transmits the request to the VectorProduct Sevice
- *
+ * Transmits the request to the VectorProduct Service
+ *
* @param cls Closure
* @param size Size of the buffer
* @param buf Pointer to the buffer
- *
+ *
* @return Size of the message sent
*/
static size_t
void *buf)
{
struct GNUNET_SCALARPRODUCT_ComputationHandle *qe = cls;
-
+
if (NULL == buf)
{
LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to transmit request to SCALARPRODUCT.\n");
GNUNET_STATISTICS_update (qe->stats,
gettext_noop ("# transmission request failures"),
1, GNUNET_NO);
-
+
// notify caller about the error, done here.
if (qe->cont_datum != NULL)
qe->response_proc (qe, NULL, GNUNET_SCALARPRODUCT_Status_Failure);
- GNUNET_SCALARPRODUCT_cancel(cls);
+
+ GNUNET_SCALARPRODUCT_cancel (cls);
return 0;
}
memcpy (buf, qe->msg, size);
-
+
GNUNET_free (qe->msg);
qe->msg = NULL;
qe->th = NULL;
/**
- * Used by Bob's client to cooperate with Alice,
- *
- * @param h handle to the master context
- * @param key Session key - unique to the requesting client
+ * Used by Bob's client to cooperate with Alice,
+ *
+ * @param cfg the gnunet configuration handle
+ * @param key Session key unique to the requesting client
* @param elements Array of elements of the vector
* @param element_count Number of elements in the vector
* @param cont Callback function
* @param cont_cls Closure for the callback function
+ *
+ * @return a new handle for this computation
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle *
-GNUNET_SCALARPRODUCT_response (const struct GNUNET_CONFIGURATION_Handle *cfg,
+GNUNET_SCALARPRODUCT_response (const struct GNUNET_CONFIGURATION_Handle * cfg,
const struct GNUNET_HashCode * key,
const int32_t * elements,
uint32_t element_count,
GNUNET_SCALARPRODUCT_ContinuationWithStatus cont,
- void *cont_cls)
+ void * cont_cls)
{
struct GNUNET_SCALARPRODUCT_ComputationHandle *h;
struct GNUNET_SCALARPRODUCT_client_request *msg;
int32_t * vector;
uint16_t size;
uint64_t i;
-
- GNUNET_assert(key);
- GNUNET_assert(elements);
- GNUNET_assert(cont);
- GNUNET_assert(element_count > 1);
+
GNUNET_assert (GNUNET_SERVER_MAX_MESSAGE_SIZE >= sizeof (struct GNUNET_SCALARPRODUCT_client_request)
- + element_count * sizeof (int32_t));
+ + element_count * sizeof (int32_t));
h = GNUNET_new (struct GNUNET_SCALARPRODUCT_ComputationHandle);
h->client = GNUNET_CLIENT_connect ("scalarproduct", cfg);
if (!h->client)
{
LOG (GNUNET_ERROR_TYPE_ERROR,
_ ("Failed to connect to the scalarproduct service\n"));
- GNUNET_free(h);
+ GNUNET_free (h);
return NULL;
}
h->stats = GNUNET_STATISTICS_create ("scalarproduct-api", cfg);
- if (!h->th){
+ if (!h->stats)
+ {
LOG (GNUNET_ERROR_TYPE_ERROR,
- _("Failed to send a message to the statistics service\n"));
- GNUNET_CLIENT_disconnect(h->client);
- GNUNET_free(h);
+ _ ("Failed to send a message to the statistics service\n"));
+ GNUNET_CLIENT_disconnect (h->client);
+ GNUNET_free (h);
return NULL;
- }
-
+ }
+
size = sizeof (struct GNUNET_SCALARPRODUCT_client_request) + element_count * sizeof (int32_t);
-
+
h->cont_status = cont;
h->cont_cls = cont_cls;
- h->response_proc = &process_result_message;
+ h->response_proc = &process_status_message;
h->cfg = cfg;
- h->msg = GNUNET_malloc (size);
memcpy (&h->key, key, sizeof (struct GNUNET_HashCode));
-
- msg = (struct GNUNET_SCALARPRODUCT_client_request*) h->msg;
+
+ msg = (struct GNUNET_SCALARPRODUCT_client_request*) GNUNET_malloc (size);
+ h->msg = msg;
msg->header.size = htons (size);
- msg->header.type = htons (GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE);
+ msg->header.type = htons (GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB);
msg->element_count = htonl (element_count);
-
- vector = (int32_t*) &msg[1];
+
+ vector = (int32_t*) & msg[1];
// copy each element over to the message
for (i = 0; i < element_count; i++)
- vector[i] = htonl(elements[i]);
+ vector[i] = htonl (elements[i]);
memcpy (&msg->key, key, sizeof (struct GNUNET_HashCode));
-
+
h->th = GNUNET_CLIENT_notify_transmit_ready (h->client, size,
GNUNET_TIME_UNIT_FOREVER_REL,
GNUNET_YES, // retry is OK in the initial stage
{
LOG (GNUNET_ERROR_TYPE_ERROR,
_ ("Failed to send a message to the scalarproduct service\n"));
- GNUNET_STATISTICS_destroy(h->stats, GNUNET_YES);
- GNUNET_CLIENT_disconnect(h->client);
- GNUNET_free(h->msg);
- GNUNET_free(h);
+ GNUNET_STATISTICS_destroy (h->stats, GNUNET_YES);
+ GNUNET_CLIENT_disconnect (h->client);
+ GNUNET_free (h->msg);
+ GNUNET_free (h);
return NULL;
}
GNUNET_CONTAINER_DLL_insert (head, tail, h);
/**
* Request by Alice's client for computing a scalar product
- *
- * @param h handle to the master context
- * @param key Session key - unique to the requesting client
+ *
+ * @param cfg the gnunet configuration handle
+ * @param key Session key should be unique to the requesting client
* @param peer PeerID of the other peer
* @param elements Array of elements of the vector
* @param element_count Number of elements in the vector
* @param mask_bytes number of bytes in the mask
* @param cont Callback function
* @param cont_cls Closure for the callback function
+ *
+ * @return a new handle for this computation
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle *
-GNUNET_SCALARPRODUCT_request (const struct GNUNET_CONFIGURATION_Handle *cfg,
+GNUNET_SCALARPRODUCT_request (const struct GNUNET_CONFIGURATION_Handle * cfg,
const struct GNUNET_HashCode * key,
const struct GNUNET_PeerIdentity *peer,
const int32_t * elements,
const unsigned char * mask,
uint32_t mask_bytes,
GNUNET_SCALARPRODUCT_DatumProcessor cont,
- void *cont_cls)
+ void * cont_cls)
{
struct GNUNET_SCALARPRODUCT_ComputationHandle *h;
struct GNUNET_SCALARPRODUCT_client_request *msg;
int32_t * vector;
uint16_t size;
uint64_t i;
-
+
GNUNET_assert (GNUNET_SERVER_MAX_MESSAGE_SIZE >= sizeof (struct GNUNET_SCALARPRODUCT_client_request)
- + element_count * sizeof (int32_t)
- + mask_bytes);
-
+ +element_count * sizeof (int32_t)
+ + mask_bytes);
+
h = GNUNET_new (struct GNUNET_SCALARPRODUCT_ComputationHandle);
h->client = GNUNET_CLIENT_connect ("scalarproduct", cfg);
if (!h->client)
{
LOG (GNUNET_ERROR_TYPE_ERROR,
_ ("Failed to connect to the scalarproduct service\n"));
- GNUNET_free(h);
+ GNUNET_free (h);
return NULL;
}
h->stats = GNUNET_STATISTICS_create ("scalarproduct-api", cfg);
- if (!h->th){
+ if (!h->stats)
+ {
LOG (GNUNET_ERROR_TYPE_ERROR,
- _("Failed to send a message to the statistics service\n"));
- GNUNET_CLIENT_disconnect(h->client);
- GNUNET_free(h);
+ _ ("Failed to send a message to the statistics service\n"));
+ GNUNET_CLIENT_disconnect (h->client);
+ GNUNET_free (h);
return NULL;
- }
-
+ }
+
size = sizeof (struct GNUNET_SCALARPRODUCT_client_request) + element_count * sizeof (int32_t) + mask_bytes;
-
+
h->cont_datum = cont;
h->cont_cls = cont_cls;
- h->response_proc = &process_status_message;
+ h->response_proc = &process_result_message;
h->cfg = cfg;
- h->msg = GNUNET_malloc (size);
memcpy (&h->key, key, sizeof (struct GNUNET_HashCode));
-
- msg = (struct GNUNET_SCALARPRODUCT_client_request*) h->msg;
+
+ msg = (struct GNUNET_SCALARPRODUCT_client_request*) GNUNET_malloc (size);
+ h->msg = msg;
msg->header.size = htons (size);
msg->header.type = htons (GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE);
- msg->element_count = htons (element_count);
- msg->mask_length = htons (mask_bytes);
-
- vector = (int32_t*) &msg[1];
+ msg->element_count = htonl (element_count);
+ msg->mask_length = htonl (mask_bytes);
+
+ vector = (int32_t*) & msg[1];
// copy each element over to the message
for (i = 0; i < element_count; i++)
- vector[i] = htonl(elements[i]);
+ vector[i] = htonl (elements[i]);
memcpy (&msg->peer, peer, sizeof (struct GNUNET_PeerIdentity));
memcpy (&msg->key, key, sizeof (struct GNUNET_HashCode));
memcpy (&vector[element_count], mask, mask_bytes);
-
+
h->th = GNUNET_CLIENT_notify_transmit_ready (h->client, size,
GNUNET_TIME_UNIT_FOREVER_REL,
GNUNET_YES, // retry is OK in the initial stage
{
LOG (GNUNET_ERROR_TYPE_ERROR,
_ ("Failed to send a message to the scalarproduct service\n"));
- GNUNET_STATISTICS_destroy(h->stats, GNUNET_YES);
- GNUNET_CLIENT_disconnect(h->client);
- GNUNET_free(h->msg);
- GNUNET_free(h);
+ GNUNET_STATISTICS_destroy (h->stats, GNUNET_YES);
+ GNUNET_CLIENT_disconnect (h->client);
+ GNUNET_free (h->msg);
+ GNUNET_free (h);
return NULL;
}
GNUNET_CONTAINER_DLL_insert (head, tail, h);
return h;
}
+
/**
- * Disconnect from the scalarproduct service.
- *
- * @param h a computation handle to cancel
+ * Cancel an ongoing computation or revoke our collaboration offer.
+ * Closes the connection to the service
+ *
+ * @param h computation handle to terminate
*/
void
GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle * h)
if (qe == h)
{
GNUNET_CONTAINER_DLL_remove (head, tail, qe);
- LOG (GNUNET_ERROR_TYPE_INFO,
- "Disconnecting from VectorProduct\n");
- if (NULL == qe->th)
+ if (NULL != qe->th)
GNUNET_CLIENT_notify_transmit_ready_cancel (qe->th);
- GNUNET_CLIENT_disconnect (h->client);
- GNUNET_STATISTICS_destroy (h->stats, GNUNET_YES);
- GNUNET_free (qe->msg);
+ GNUNET_CLIENT_disconnect (qe->client);
+ GNUNET_STATISTICS_destroy (qe->stats, GNUNET_YES);
+ GNUNET_free_non_null (qe->msg);
GNUNET_free (qe);
break;
}
}
}
+/**
+ * Cancel ALL ongoing computation or revoke our collaboration offer.
+ * Closes ALL connections to the service
+ */
+void
+GNUNET_SCALARPRODUCT_disconnect ()
+{
+ struct GNUNET_SCALARPRODUCT_ComputationHandle * qe;
+
+ LOG (GNUNET_ERROR_TYPE_INFO, "Disconnecting from VectorProduct\n");
+ for (qe = head; head != NULL; qe = head)
+ {
+ GNUNET_CONTAINER_DLL_remove (head, tail, qe);
+ if (NULL != qe->th)
+ GNUNET_CLIENT_notify_transmit_ready_cancel (qe->th);
+ GNUNET_CLIENT_disconnect (qe->client);
+ GNUNET_STATISTICS_destroy (qe->stats, GNUNET_YES);
+ GNUNET_free_non_null (qe->msg);
+ GNUNET_free (qe);
+ }
+}
-/* end of ext_api.c */
+/* end of scalarproduct_api.c */