GNUnet  0.11.x
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
Scalar Product service

Data Structures

struct  GNUNET_SCALARPRODUCT_Element
 An element key-value pair for scalarproduct. More...
 

Macros

#define GCRYPT_NO_DEPRECATED
 
#define GNUNET_SCALARPRODUCT_VERSION   0x00000044
 Version of the scalarproduct API. More...
 

Typedefs

typedef void(* GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status, gcry_mpi_t result)
 Process a datum that was stored in the scalarproduct. More...
 

Enumerations

enum  GNUNET_SCALARPRODUCT_ResponseStatus {
  GNUNET_SCALARPRODUCT_STATUS_INIT = 0, GNUNET_SCALARPRODUCT_STATUS_ACTIVE = 1, GNUNET_SCALARPRODUCT_STATUS_SUCCESS, GNUNET_SCALARPRODUCT_STATUS_FAILURE,
  GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE, GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED
}
 Result status values for the computation. More...
 

Functions

struct GNUNET_SCALARPRODUCT_ComputationHandleGNUNET_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...
 
struct GNUNET_SCALARPRODUCT_ComputationHandleGNUNET_SCALARPRODUCT_accept_computation (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_HashCode *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...
 
void GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle *h)
 Cancel an ongoing computation or revoke our collaboration offer. More...
 

Variables

GNUNET_NETWORK_STRUCT_END typedef void(* GNUNET_SCALARPRODUCT_ContinuationWithStatus )(void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status)
 Continuation called to notify client about result of the operation. More...
 

Detailed Description

Macro Definition Documentation

◆ GCRYPT_NO_DEPRECATED

#define GCRYPT_NO_DEPRECATED

Definition at line 33 of file gnunet_scalarproduct_service.h.

◆ GNUNET_SCALARPRODUCT_VERSION

#define GNUNET_SCALARPRODUCT_VERSION   0x00000044

Version of the scalarproduct API.

Definition at line 46 of file gnunet_scalarproduct_service.h.

Typedef Documentation

◆ GNUNET_SCALARPRODUCT_DatumProcessor

typedef void(* GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status, gcry_mpi_t result)

Process a datum that was stored in the scalarproduct.

Parameters
clsclosure
statusStatus of the request
resultresult of the computation

Definition at line 133 of file gnunet_scalarproduct_service.h.

Enumeration Type Documentation

◆ GNUNET_SCALARPRODUCT_ResponseStatus

Result status values for the computation.

Enumerator
GNUNET_SCALARPRODUCT_STATUS_INIT 

Operation is still active (never returned, used internally).

GNUNET_SCALARPRODUCT_STATUS_ACTIVE 

Operation is still active (never returned, used internally).

GNUNET_SCALARPRODUCT_STATUS_SUCCESS 

The computation was successful.

GNUNET_SCALARPRODUCT_STATUS_FAILURE 

We encountered some error.

GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE 

We got an invalid response.

GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED 

We got disconnected from the SCALARPRODUCT service.

Definition at line 51 of file gnunet_scalarproduct_service.h.

52 {
57 
62 
67 
72 
77 
82 };
Operation is still active (never returned, used internally).
Operation is still active (never returned, used internally).
We got disconnected from the SCALARPRODUCT service.

Function Documentation

◆ GNUNET_SCALARPRODUCT_start_computation()

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.

Parameters
cfgthe gnunet configuration handle
session_keySession key should be unique to the requesting client
peerPeerID of the other peer
elementsArray of elements of the vector
element_countNumber of elements in the elements vector
contCallback function
cont_clsClosure for the cont callback function
Returns
a new handle for this computation
Parameters
cfgthe gnunet configuration handle
session_keySession key should be unique to the requesting client
peerPeerID of the other peer
elementsArray of elements of the vector
element_countNumber of elements in the elements vector
contCallback function
cont_clsClosure for cont
Returns
a new handle for this computation

Definition at line 384 of file scalarproduct_api.c.

References GNUNET_SCALARPRODUCT_ComputationHandle::cfg, check_unique(), GNUNET_SCALARPRODUCT_ComputationHandle::cont_cls, GNUNET_SCALARPRODUCT_ComputationHandle::cont_datum, AliceComputationMessage::element_count_contained, ComputationBobCryptodataMultipartMessage::element_count_contained, AliceComputationMessage::element_count_total, env, GNUNET_break, GNUNET_CLIENT_connect(), GNUNET_free, GNUNET_MAX_MESSAGE_SIZE, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_ALICE, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT, GNUNET_MIN, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_new, GNUNET_SYSERR, h, GNUNET_SCALARPRODUCT_ComputationHandle::key, GNUNET_SCALARPRODUCT_ComputationHandle::mq, mq_error_handler(), msg, AliceComputationMessage::peer, peer, process_result_message(), AliceComputationMessage::reserved, response, GNUNET_SCALARPRODUCT_ComputationHandle::response_proc, AliceComputationMessage::session_key, session_key, and size.

Referenced by run().

392 {
398  struct ClientResponseMessage,
399  h),
401  };
402  struct GNUNET_MQ_Envelope *env;
405  uint32_t size;
406  uint16_t possible;
407  uint16_t todo;
408  uint32_t element_count_transfered;
409 
410  if (GNUNET_SYSERR == check_unique (elements,
411  element_count))
412  return NULL;
413  h->mq = GNUNET_CLIENT_connect (cfg,
414  "scalarproduct-alice",
415  handlers,
417  h);
418  if (NULL == h->mq)
419  {
420  /* misconfigured scalarproduct service */
421  GNUNET_break (0);
422  GNUNET_free (h);
423  return NULL;
424  }
425  h->cont_datum = cont;
426  h->cont_cls = cont_cls;
428  h->cfg = cfg;
429  h->key = *session_key;
430 
431  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(struct
433  / sizeof(struct GNUNET_SCALARPRODUCT_Element);
434  todo = GNUNET_MIN (possible,
435  element_count);
436  size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
437  env = GNUNET_MQ_msg_extra (msg,
438  size,
440  msg->element_count_total = htonl (element_count);
441  msg->element_count_contained = htonl (todo);
442  msg->reserved = htonl (0);
443  msg->peer = *peer;
444  msg->session_key = *session_key;
445  GNUNET_memcpy (&msg[1],
446  elements,
447  size);
448  GNUNET_MQ_send (h->mq,
449  env);
450  element_count_transfered = todo;
451  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(*mmsg))
452  / sizeof(struct GNUNET_SCALARPRODUCT_Element);
453  while (element_count_transfered < element_count)
454  {
455  todo = GNUNET_MIN (possible,
456  element_count - element_count_transfered);
457  size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
458  env = GNUNET_MQ_msg_extra (mmsg,
459  size,
461  mmsg->element_count_contained = htonl (todo);
462  GNUNET_memcpy (&mmsg[1],
463  &elements[element_count_transfered],
464  size);
465  element_count_transfered += todo;
466  GNUNET_MQ_send (h->mq,
467  env);
468  }
469  return h;
470 }
A handle returned for each computation.
Message type passed from service client to finalize a session as requester or responder.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
#define GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_ALICE
Client -> Alice multipart.
struct GNUNET_HashCode key
The shared session key identifying this computation.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
struct GNUNET_MQ_Handle * GNUNET_CLIENT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *service_name, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *error_handler_cls)
Create a message queue to connect to a GNUnet service.
Definition: client.c:1063
GNUNET_SCALARPRODUCT_DatumProcessor cont_datum
Function to call after transmission of the request (Alice).
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...
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
uint32_t reserved
Always zero.
Definition: scalarproduct.h:66
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
Message type passed from client to service to initiate a request or responder role.
Definition: scalarproduct.h:45
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
struct GNUNET_HashCode session_key
the transaction/session key used to identify a session
Definition: scalarproduct.h:71
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct...
Definition: gnunet_mq_lib.h:52
static struct GNUNET_HashCode session_key
the session key identifying this computation
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
struct GNUNET_PeerIdentity peer
the identity of a remote peer we want to communicate with
Definition: scalarproduct.h:76
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MIN(a, b)
Definition: gnunet_common.h:93
uint32_t element_count_total
how many elements the vector in payload contains
Definition: scalarproduct.h:56
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...
Message handler for a specific message type.
#define GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE
Client -> Alice.
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
static unsigned int size
Size of the "table".
Definition: peer.c:67
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
uint32_t element_count_contained
contained elements the vector in payload contains
Definition: scalarproduct.h:61
static struct MHD_Response * response
Our canonical response.
uint32_t element_count_contained
contained elements the vector in payload contains
multipart messages following struct ComputationMessage
void * cont_cls
Closure for cont_status or cont_datum.
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:355
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
GNUNET_SCALARPRODUCT_ResponseMessageHandler response_proc
API internal callback for results and failures to be forwarded to the client.
struct GNUNET_MQ_Handle * mq
Current connection to the scalarproduct service.
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
static int check_unique(const struct GNUNET_SCALARPRODUCT_Element *elements, uint32_t element_count)
Check if the keys for all given elements are unique.
An element key-value pair for scalarproduct.
#define GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT
Alice/Bob -> Client Result.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SCALARPRODUCT_accept_computation()

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,.

Parameters
cfgthe gnunet configuration handle
session_keySession key unique to the requesting client
elementsArray of elements of the vector
element_countNumber of elements in the elements vector
contCallback function
cont_clsClosure for the cont callback function
Returns
a new handle for this computation
Parameters
cfgthe gnunet configuration handle
keySession key unique to the requesting client
elementsArray of elements of the vector
element_countNumber of elements in the elements vector
contCallback function
cont_clsClosure for cont
Returns
a new handle for this computation

Definition at line 225 of file scalarproduct_api.c.

References GNUNET_SCALARPRODUCT_ComputationHandle::cfg, check_unique(), GNUNET_SCALARPRODUCT_ComputationHandle::cont_cls, GNUNET_SCALARPRODUCT_ComputationHandle::cont_status, BobComputationMessage::element_count_contained, ComputationBobCryptodataMultipartMessage::element_count_contained, BobComputationMessage::element_count_total, env, GNUNET_break, GNUNET_CLIENT_connect(), GNUNET_free, GNUNET_MAX_MESSAGE_SIZE, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_BOB, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT, GNUNET_MIN, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_new, GNUNET_SYSERR, h, GNUNET_SCALARPRODUCT_ComputationHandle::key, GNUNET_SCALARPRODUCT_ComputationHandle::mq, mq_error_handler(), msg, process_status_message(), response, GNUNET_SCALARPRODUCT_ComputationHandle::response_proc, BobComputationMessage::session_key, session_key, and size.

Referenced by run().

232 {
238  struct ClientResponseMessage,
239  h),
241  };
242  struct GNUNET_MQ_Envelope *env;
243  struct BobComputationMessage *msg;
245  uint32_t size;
246  uint16_t possible;
247  uint16_t todo;
248  uint32_t element_count_transfered;
249 
250 
251  if (GNUNET_SYSERR == check_unique (elements,
252  element_count))
253  return NULL;
254  h->cont_status = cont;
255  h->cont_cls = cont_cls;
257  h->cfg = cfg;
258  h->key = *session_key;
259  h->mq = GNUNET_CLIENT_connect (cfg,
260  "scalarproduct-bob",
261  handlers,
263  h);
264  if (NULL == h->mq)
265  {
266  /* scalarproduct configuration error */
267  GNUNET_break (0);
268  GNUNET_free (h);
269  return NULL;
270  }
271  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(struct
273  / sizeof(struct GNUNET_SCALARPRODUCT_Element);
274  todo = GNUNET_MIN (possible,
275  element_count);
276  size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
277  env = GNUNET_MQ_msg_extra (msg,
278  size,
280  msg->element_count_total = htonl (element_count);
281  msg->element_count_contained = htonl (todo);
282  msg->session_key = *session_key;
283  GNUNET_memcpy (&msg[1],
284  elements,
285  size);
286  element_count_transfered = todo;
287  GNUNET_MQ_send (h->mq,
288  env);
289  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(*mmsg))
290  / sizeof(struct GNUNET_SCALARPRODUCT_Element);
291  while (element_count_transfered < element_count)
292  {
293  todo = GNUNET_MIN (possible,
294  element_count - element_count_transfered);
295  size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
296  env = GNUNET_MQ_msg_extra (mmsg,
297  size,
299  mmsg->element_count_contained = htonl (todo);
300  GNUNET_memcpy (&mmsg[1],
301  &elements[element_count_transfered],
302  size);
303  element_count_transfered += todo;
304  GNUNET_MQ_send (h->mq,
305  env);
306  }
307  return h;
308 }
A handle returned for each computation.
Message type passed from service client to finalize a session as requester or responder.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
struct GNUNET_HashCode key
The shared session key identifying this computation.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
struct GNUNET_MQ_Handle * GNUNET_CLIENT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *service_name, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *error_handler_cls)
Create a message queue to connect to a GNUnet service.
Definition: client.c:1063
uint32_t element_count_total
how many elements the vector in payload contains
Definition: scalarproduct.h:99
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB
Client -> Bob.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct...
Definition: gnunet_mq_lib.h:52
static struct GNUNET_HashCode session_key
the session key identifying this computation
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MIN(a, b)
Definition: gnunet_common.h:93
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.
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...
Message handler for a specific message type.
static unsigned int size
Size of the "table".
Definition: peer.c:67
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
GNUNET_SCALARPRODUCT_ContinuationWithStatus cont_status
Function to call after transmission of the request (Bob).
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
uint32_t element_count_contained
contained elements the vector in payload contains
#define GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_BOB
Client -> Bob multipart.
static struct MHD_Response * response
Our canonical response.
uint32_t element_count_contained
contained elements the vector in payload contains
multipart messages following struct ComputationMessage
Message type passed from client to service to initiate a request or responder role.
Definition: scalarproduct.h:88
void * cont_cls
Closure for cont_status or cont_datum.
struct GNUNET_HashCode session_key
the transaction/session key used to identify a session
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:355
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
GNUNET_SCALARPRODUCT_ResponseMessageHandler response_proc
API internal callback for results and failures to be forwarded to the client.
struct GNUNET_MQ_Handle * mq
Current connection to the scalarproduct service.
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
static int check_unique(const struct GNUNET_SCALARPRODUCT_Element *elements, uint32_t element_count)
Check if the keys for all given elements are unique.
An element key-value pair for scalarproduct.
#define GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT
Alice/Bob -> Client Result.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SCALARPRODUCT_cancel()

void GNUNET_SCALARPRODUCT_cancel ( struct GNUNET_SCALARPRODUCT_ComputationHandle h)

Cancel an ongoing computation or revoke our collaboration offer.

Closes the connection to the service

Parameters
hcomputation handle to terminate

Definition at line 480 of file scalarproduct_api.c.

References GNUNET_free, GNUNET_MQ_destroy(), and GNUNET_SCALARPRODUCT_ComputationHandle::mq.

Referenced by process_result_message(), process_status_message(), and shutdown_task().

481 {
482  if (NULL != h->mq)
483  {
484  GNUNET_MQ_destroy (h->mq);
485  h->mq = NULL;
486  }
487  GNUNET_free (h);
488 }
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:837
struct GNUNET_MQ_Handle * mq
Current connection to the scalarproduct service.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ GNUNET_SCALARPRODUCT_ContinuationWithStatus

GNUNET_NETWORK_STRUCT_END typedef void(* GNUNET_SCALARPRODUCT_ContinuationWithStatus) (void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status)

Continuation called to notify client about result of the operation.

Parameters
clsclosure
statusStatus of the request

Definition at line 120 of file gnunet_scalarproduct_service.h.