GNUnet  0.11.x
Data Structures | Macros | Functions
namestore_api.c File Reference

API to access the NAMESTORE service. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet_constants.h"
#include "gnunet_dnsparser_lib.h"
#include "gnunet_arm_service.h"
#include "gnunet_signatures.h"
#include "gnunet_gns_service.h"
#include "gnunet_namestore_service.h"
#include "namestore.h"
Include dependency graph for namestore_api.c:

Go to the source code of this file.

Data Structures

struct  GNUNET_NAMESTORE_QueueEntry
 An QueueEntry used to store information for a pending NAMESTORE record operation. More...
 
struct  GNUNET_NAMESTORE_ZoneIterator
 Handle for a zone iterator operation. More...
 
struct  GNUNET_NAMESTORE_Handle
 Connection to the NAMESTORE service. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "namestore-api", __VA_ARGS__)
 
#define NAMESTORE_DELAY_TOLERANCE   GNUNET_TIME_UNIT_MINUTES
 We grant the namestore up to 1 minute of latency, if it is slower than that, store queries will fail. More...
 

Functions

static void force_reconnect (struct GNUNET_NAMESTORE_Handle *h)
 Disconnect from service and then reconnect. More...
 
static struct GNUNET_NAMESTORE_QueueEntryfind_qe (struct GNUNET_NAMESTORE_Handle *h, uint32_t rid)
 Find the queue entry that matches the rid. More...
 
static struct GNUNET_NAMESTORE_ZoneIteratorfind_zi (struct GNUNET_NAMESTORE_Handle *h, uint32_t rid)
 Find the zone iteration entry that matches the rid. More...
 
static void free_qe (struct GNUNET_NAMESTORE_QueueEntry *qe)
 Free qe. More...
 
static void free_ze (struct GNUNET_NAMESTORE_ZoneIterator *ze)
 Free ze. More...
 
static int check_rd (size_t rd_len, const void *rd_buf, unsigned int rd_count)
 Check that rd_buf of length rd_len contains rd_count records. More...
 
static void handle_record_store_response (void *cls, const struct RecordStoreResponseMessage *msg)
 Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE. More...
 
static int check_lookup_result (void *cls, const struct LabelLookupResponseMessage *msg)
 Check validity of an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE. More...
 
static void handle_lookup_result (void *cls, const struct LabelLookupResponseMessage *msg)
 Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE. More...
 
static int check_record_result (void *cls, const struct RecordResultMessage *msg)
 Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT. More...
 
static void handle_record_result (void *cls, const struct RecordResultMessage *msg)
 Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT. More...
 
static void handle_record_result_end (void *cls, const struct GNUNET_NAMESTORE_Header *msg)
 Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT_END. More...
 
static int check_zone_to_name_response (void *cls, const struct ZoneToNameResponseMessage *msg)
 Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE. More...
 
static void handle_zone_to_name_response (void *cls, const struct ZoneToNameResponseMessage *msg)
 Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE. More...
 
static void mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
 Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue. More...
 
static void reconnect (struct GNUNET_NAMESTORE_Handle *h)
 Reconnect to namestore service. More...
 
static void reconnect_task (void *cls)
 Re-establish the connection to the service. More...
 
static uint32_t get_op_id (struct GNUNET_NAMESTORE_Handle *h)
 Get a fresh operation id to distinguish between namestore requests. More...
 
struct GNUNET_NAMESTORE_HandleGNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
 Initialize the connection with the NAMESTORE service. More...
 
void GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h)
 Disconnect from the namestore service (and free associated resources). More...
 
static void warn_delay (void *cls)
 Task launched to warn the user that the namestore is excessively slow and that a query was thus dropped. More...
 
struct GNUNET_NAMESTORE_QueueEntryGNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h, const struct GNUNET_IDENTITY_PrivateKey *pkey, const char *label, unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd, GNUNET_NAMESTORE_ContinuationWithStatus cont, void *cont_cls)
 Store an item in the namestore. More...
 
struct GNUNET_NAMESTORE_QueueEntryGNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h, const struct GNUNET_IDENTITY_PrivateKey *pkey, const char *label, GNUNET_SCHEDULER_TaskCallback error_cb, void *error_cb_cls, GNUNET_NAMESTORE_RecordMonitor rm, void *rm_cls)
 Lookup an item in the namestore. More...
 
struct GNUNET_NAMESTORE_QueueEntryGNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, const struct GNUNET_IDENTITY_PrivateKey *zone, const struct GNUNET_IDENTITY_PublicKey *value_zone, GNUNET_SCHEDULER_TaskCallback error_cb, void *error_cb_cls, GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls)
 Look for an existing PKEY delegation record for a given public key. More...
 
struct GNUNET_NAMESTORE_ZoneIteratorGNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h, const struct GNUNET_IDENTITY_PrivateKey *zone, GNUNET_SCHEDULER_TaskCallback error_cb, void *error_cb_cls, GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls, GNUNET_SCHEDULER_TaskCallback finish_cb, void *finish_cb_cls)
 Starts a new zone iteration (used to periodically PUT all of our records into our DHT). More...
 
void GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it, uint64_t limit)
 Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start for the next record. More...
 
void GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it)
 Stops iteration and releases the namestore handle for further calls. More...
 
void GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe)
 Cancel a namestore operation. More...
 

Detailed Description

API to access the NAMESTORE service.

Author
Martin Schanzenbach
Matthias Wachs
Christian Grothoff

Definition in file namestore_api.c.

Macro Definition Documentation

◆ LOG

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

Definition at line 41 of file namestore_api.c.

◆ NAMESTORE_DELAY_TOLERANCE

#define NAMESTORE_DELAY_TOLERANCE   GNUNET_TIME_UNIT_MINUTES

We grant the namestore up to 1 minute of latency, if it is slower than that, store queries will fail.

Definition at line 47 of file namestore_api.c.

Function Documentation

◆ force_reconnect()

static void force_reconnect ( struct GNUNET_NAMESTORE_Handle h)
static

Disconnect from service and then reconnect.

Parameters
hour handle

Definition at line 842 of file namestore_api.c.

843 {
846 
848  h->mq = NULL;
849  while (NULL != (ze = h->z_head))
850  {
851  if (NULL != ze->error_cb)
852  ze->error_cb (ze->error_cb_cls);
853  free_ze (ze);
854  }
855  while (NULL != (qe = h->op_head))
856  {
857  if (NULL != qe->error_cb)
858  qe->error_cb (qe->error_cb_cls);
859  if (NULL != qe->cont)
860  qe->cont (qe->cont_cls,
862  "failure in communication with namestore service");
863  free_qe (qe);
864  }
865 
866  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Reconnecting to namestore\n");
867  h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
868  h->reconnect_task =
869  GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect_task, h);
870 }
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
static struct GNUNET_DATASTORE_QueueEntry * qe
Current operation.
#define GNUNET_log(kind,...)
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
@ GNUNET_ERROR_TYPE_DEBUG
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:837
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1269
#define GNUNET_TIME_STD_BACKOFF(r)
Perform our standard exponential back-off calculation, starting at 1 ms and then going by a factor of...
static void free_qe(struct GNUNET_NAMESTORE_QueueEntry *qe)
Free qe.
static void free_ze(struct GNUNET_NAMESTORE_ZoneIterator *ze)
Free ze.
static void reconnect_task(void *cls)
Re-establish the connection to the service.
struct GNUNET_MQ_Handle * mq
Our connection to the ARM service.
Definition: arm_api.c:107
struct GNUNET_SCHEDULER_Task * reconnect_task
ID of the reconnect task (if any).
Definition: arm_api.c:147
GNUNET_DATASTORE_ContinuationWithStatus cont
Function to call after transmission of the request.
void * cont_cls
Closure for cont.
An QueueEntry used to store information for a pending NAMESTORE record operation.
Definition: namestore_api.c:54
Handle for a zone iterator operation.
void * error_cb_cls
Closure for error_cb.
GNUNET_SCHEDULER_TaskCallback error_cb
Function to call on errors.

References GNUNET_DATASTORE_QueueEntry::cont, GNUNET_DATASTORE_QueueEntry::cont_cls, GNUNET_NAMESTORE_ZoneIterator::error_cb, GNUNET_NAMESTORE_ZoneIterator::error_cb_cls, free_qe(), free_ze(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SYSERR, GNUNET_TIME_STD_BACKOFF, h, GNUNET_ARM_Handle::mq, qe, GNUNET_ARM_Handle::reconnect_task, and reconnect_task().

Referenced by handle_record_result(), handle_record_result_end(), handle_zone_to_name_response(), and mq_error_handler().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ find_qe()

static struct GNUNET_NAMESTORE_QueueEntry* find_qe ( struct GNUNET_NAMESTORE_Handle h,
uint32_t  rid 
)
static

Find the queue entry that matches the rid.

Parameters
hnamestore handle
ridid to look up
Returns
NULL if rid was not found

Definition at line 260 of file namestore_api.c.

261 {
263 
264  for (qe = h->op_head; qe != NULL; qe = qe->next)
265  if (qe->op_id == rid)
266  return qe;
267  return NULL;
268 }
struct GNUNET_DATASTORE_QueueEntry * next
This is a linked list.

References h, GNUNET_DATASTORE_QueueEntry::next, and qe.

Referenced by handle_lookup_result(), handle_record_result(), handle_record_result_end(), handle_record_store_response(), and handle_zone_to_name_response().

Here is the caller graph for this function:

◆ find_zi()

static struct GNUNET_NAMESTORE_ZoneIterator* find_zi ( struct GNUNET_NAMESTORE_Handle h,
uint32_t  rid 
)
static

Find the zone iteration entry that matches the rid.

Parameters
hnamestore handle
ridid to look up
Returns
NULL if rid was not found

Definition at line 279 of file namestore_api.c.

280 {
282 
283  for (ze = h->z_head; ze != NULL; ze = ze->next)
284  if (ze->op_id == rid)
285  return ze;
286  return NULL;
287 }
struct GNUNET_NAMESTORE_ZoneIterator * next
Kept in a DLL.
uint32_t op_id
The operation id this zone iteration operation has.

References h, GNUNET_NAMESTORE_ZoneIterator::next, and GNUNET_NAMESTORE_ZoneIterator::op_id.

Referenced by handle_record_result(), and handle_record_result_end().

Here is the caller graph for this function:

◆ free_qe()

static void free_qe ( struct GNUNET_NAMESTORE_QueueEntry qe)
static

Free qe.

Parameters
qeentry to free

Definition at line 296 of file namestore_api.c.

297 {
298  struct GNUNET_NAMESTORE_Handle *h = qe->h;
299 
300  GNUNET_CONTAINER_DLL_remove (h->op_head, h->op_tail, qe);
301  if (NULL != qe->env)
303  if (NULL != qe->timeout_task)
304  GNUNET_SCHEDULER_cancel (qe->timeout_task);
305  GNUNET_free (qe);
306 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_MQ_discard(struct GNUNET_MQ_Envelope *mqm)
Discard the message queue message, free all allocated resources.
Definition: mq.c:323
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:972
struct GNUNET_DATASTORE_Handle * h
Handle to the master context.
struct GNUNET_MQ_Envelope * env
Envelope of the request to transmit, NULL after transmission.
Connection to the NAMESTORE service.

References GNUNET_DATASTORE_QueueEntry::env, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_discard(), GNUNET_SCHEDULER_cancel(), h, GNUNET_DATASTORE_QueueEntry::h, and qe.

Referenced by force_reconnect(), GNUNET_NAMESTORE_cancel(), handle_lookup_result(), handle_record_result(), handle_record_store_response(), and handle_zone_to_name_response().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ free_ze()

static void free_ze ( struct GNUNET_NAMESTORE_ZoneIterator ze)
static

Free ze.

Parameters
zeentry to free

Definition at line 315 of file namestore_api.c.

316 {
317  struct GNUNET_NAMESTORE_Handle *h = ze->h;
318 
319  GNUNET_CONTAINER_DLL_remove (h->z_head, h->z_tail, ze);
320  if (NULL != ze->env)
321  GNUNET_MQ_discard (ze->env);
322  GNUNET_free (ze);
323 }
struct GNUNET_NAMESTORE_Handle * h
Main handle to access the namestore.
struct GNUNET_MQ_Envelope * env
Envelope of the message to send to the service, if not yet sent.

References GNUNET_NAMESTORE_ZoneIterator::env, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_discard(), h, and GNUNET_NAMESTORE_ZoneIterator::h.

Referenced by force_reconnect(), GNUNET_NAMESTORE_zone_iteration_stop(), and handle_record_result_end().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_rd()

static int check_rd ( size_t  rd_len,
const void *  rd_buf,
unsigned int  rd_count 
)
static

Check that rd_buf of length rd_len contains rd_count records.

Parameters
rd_lenlength of rd_buf
rd_bufbuffer with serialized records
rd_countnumber of records expected
Returns
GNUNET_OK if rd_buf is well-formed

Definition at line 336 of file namestore_api.c.

337 {
338  struct GNUNET_GNSRECORD_Data rd[rd_count];
339 
340  if (GNUNET_OK !=
341  GNUNET_GNSRECORD_records_deserialize (rd_len, rd_buf, rd_count, rd))
342  {
343  GNUNET_break (0);
344  return GNUNET_SYSERR;
345  }
346  return GNUNET_OK;
347 }
@ GNUNET_OK
Definition: gnunet_common.h:95
int GNUNET_GNSRECORD_records_deserialize(size_t len, const char *src, unsigned int rd_count, struct GNUNET_GNSRECORD_Data *dest)
Deserialize the given records to the given destination.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.

References GNUNET_break, GNUNET_GNSRECORD_records_deserialize(), GNUNET_OK, and GNUNET_SYSERR.

Referenced by check_lookup_result(), check_record_result(), and check_zone_to_name_response().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handle_record_store_response()

static void handle_record_store_response ( void *  cls,
const struct RecordStoreResponseMessage msg 
)
static

Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE.

Parameters
cls
msgthe message we received

Definition at line 358 of file namestore_api.c.

360 {
361  struct GNUNET_NAMESTORE_Handle *h = cls;
363  int res;
364  const char *emsg;
365 
366  qe = find_qe (h, ntohl (msg->gns_header.r_id));
367  res = ntohl (msg->op_result);
369  "Received RECORD_STORE_RESPONSE with result %d\n",
370  res);
371  /* TODO: add actual error message from namestore to response... */
372  if (GNUNET_SYSERR == res)
373  emsg = _ ("Namestore failed to store record\n");
374  else
375  emsg = NULL;
376  if (NULL == qe)
377  return;
378  if (NULL != qe->cont)
379  qe->cont (qe->cont_cls, res, emsg);
380  free_qe (qe);
381 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static int res
static struct GNUNET_NAMESTORE_QueueEntry * find_qe(struct GNUNET_NAMESTORE_Handle *h, uint32_t rid)
Find the queue entry that matches the rid.
#define LOG(kind,...)
Definition: namestore_api.c:41
#define _(String)
GNU gettext support macro.
Definition: platform.h:177

References _, GNUNET_DATASTORE_QueueEntry::cont, GNUNET_DATASTORE_QueueEntry::cont_cls, find_qe(), free_qe(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_SYSERR, h, LOG, msg, qe, and res.

Here is the call graph for this function:

◆ check_lookup_result()

static int check_lookup_result ( void *  cls,
const struct LabelLookupResponseMessage msg 
)
static

Check validity of an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE.

Parameters
cls
msgthe message we received
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 393 of file namestore_api.c.

394 {
395  const char *name;
396  size_t exp_msg_len;
397  size_t msg_len;
398  size_t name_len;
399  size_t rd_len;
400 
401  (void) cls;
402  rd_len = ntohs (msg->rd_len);
403  msg_len = ntohs (msg->gns_header.header.size);
404  name_len = ntohs (msg->name_len);
405  exp_msg_len = sizeof(*msg) + name_len + rd_len;
406  if (msg_len != exp_msg_len)
407  {
408  GNUNET_break (0);
409  return GNUNET_SYSERR;
410  }
411  name = (const char *) &msg[1];
412  if ((name_len > 0) && ('\0' != name[name_len - 1]))
413  {
414  GNUNET_break (0);
415  return GNUNET_SYSERR;
416  }
417  if (GNUNET_NO == ntohs (msg->found))
418  {
419  if (0 != ntohs (msg->rd_count))
420  {
421  GNUNET_break (0);
422  return GNUNET_SYSERR;
423  }
424  return GNUNET_OK;
425  }
426  return check_rd (rd_len, &name[name_len], ntohs (msg->rd_count));
427 }
@ GNUNET_NO
Definition: gnunet_common.h:94
static int check_rd(size_t rd_len, const void *rd_buf, unsigned int rd_count)
Check that rd_buf of length rd_len contains rd_count records.
const char * name
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.

References check_rd(), GNUNET_break, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, msg, name, and GNUNET_MessageHeader::size.

Here is the call graph for this function:

◆ handle_lookup_result()

static void handle_lookup_result ( void *  cls,
const struct LabelLookupResponseMessage msg 
)
static

Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE.

Parameters
cls
msgthe message we received

Definition at line 438 of file namestore_api.c.

439 {
440  struct GNUNET_NAMESTORE_Handle *h = cls;
442  const char *name;
443  const char *rd_tmp;
444  size_t name_len;
445  size_t rd_len;
446  unsigned int rd_count;
447 
448  LOG (GNUNET_ERROR_TYPE_DEBUG, "Received RECORD_LOOKUP_RESULT\n");
449  qe = find_qe (h, ntohl (msg->gns_header.r_id));
450  if (NULL == qe)
451  return;
452  rd_len = ntohs (msg->rd_len);
453  rd_count = ntohs (msg->rd_count);
454  name_len = ntohs (msg->name_len);
455  name = (const char *) &msg[1];
456  if (GNUNET_NO == ntohs (msg->found))
457  {
458  /* label was not in namestore */
459  if (NULL != qe->proc)
460  qe->proc (qe->proc_cls, &msg->private_key, name, 0, NULL);
461  free_qe (qe);
462  return;
463  }
464 
465  rd_tmp = &name[name_len];
466  {
467  struct GNUNET_GNSRECORD_Data rd[rd_count];
468 
469  GNUNET_assert (
470  GNUNET_OK ==
471  GNUNET_GNSRECORD_records_deserialize (rd_len, rd_tmp, rd_count, rd));
472  if (0 == name_len)
473  name = NULL;
474  if (NULL != qe->proc)
475  qe->proc (qe->proc_cls,
476  &msg->private_key,
477  name,
478  rd_count,
479  (rd_count > 0) ? rd : NULL);
480  }
481  free_qe (qe);
482 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.

References find_qe(), free_qe(), GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_GNSRECORD_records_deserialize(), GNUNET_NO, GNUNET_OK, h, LOG, msg, name, and qe.

Here is the call graph for this function:

◆ check_record_result()

static int check_record_result ( void *  cls,
const struct RecordResultMessage msg 
)
static

Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT.

Parameters
cls
msgthe message we received
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 494 of file namestore_api.c.

495 {
496  static struct GNUNET_IDENTITY_PrivateKey priv_dummy;
497  const char *name;
498  size_t msg_len;
499  size_t name_len;
500  size_t rd_len;
501 
502  (void) cls;
503  rd_len = ntohs (msg->rd_len);
504  msg_len = ntohs (msg->gns_header.header.size);
505  name_len = ntohs (msg->name_len);
506  if (0 != ntohs (msg->reserved))
507  {
508  GNUNET_break (0);
509  return GNUNET_SYSERR;
510  }
511  if (msg_len != sizeof(struct RecordResultMessage) + name_len + rd_len)
512  {
513  GNUNET_break (0);
514  return GNUNET_SYSERR;
515  }
516  name = (const char *) &msg[1];
517  if ((0 == name_len) || ('\0' != name[name_len - 1]))
518  {
519  GNUNET_break (0);
520  return GNUNET_SYSERR;
521  }
522  if (0 == GNUNET_memcmp (&msg->private_key, &priv_dummy))
523  {
524  GNUNET_break (0);
525  return GNUNET_SYSERR;
526  }
527  return check_rd (rd_len, &name[name_len], ntohs (msg->rd_count));
528 }
#define GNUNET_memcmp(a, b)
Compare memory in a and b, where both must be of the same pointer type.
A private key for an identity as per LSD0001.
Record is returned from the namestore (as authority).
Definition: namestore.h:257

References check_rd(), GNUNET_break, GNUNET_memcmp, GNUNET_SYSERR, msg, name, and GNUNET_MessageHeader::size.

Here is the call graph for this function:

◆ handle_record_result()

static void handle_record_result ( void *  cls,
const struct RecordResultMessage msg 
)
static

Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT.

Parameters
cls
msgthe message we received

Definition at line 539 of file namestore_api.c.

540 {
541  struct GNUNET_NAMESTORE_Handle *h = cls;
544  const char *name;
545  const char *rd_tmp;
546  size_t name_len;
547  size_t rd_len;
548  unsigned int rd_count;
549 
550  LOG (GNUNET_ERROR_TYPE_DEBUG, "Received RECORD_RESULT\n");
551  rd_len = ntohs (msg->rd_len);
552  rd_count = ntohs (msg->rd_count);
553  name_len = ntohs (msg->name_len);
554  ze = find_zi (h, ntohl (msg->gns_header.r_id));
555  qe = find_qe (h, ntohl (msg->gns_header.r_id));
556  if ((NULL == ze) && (NULL == qe))
557  return; /* rid not found */
558  if ((NULL != ze) && (NULL != qe))
559  {
560  GNUNET_break (0); /* rid ambiguous */
561  force_reconnect (h);
562  return;
563  }
564  name = (const char *) &msg[1];
565  rd_tmp = &name[name_len];
566  {
567  struct GNUNET_GNSRECORD_Data rd[rd_count];
568 
569  GNUNET_assert (
570  GNUNET_OK ==
571  GNUNET_GNSRECORD_records_deserialize (rd_len, rd_tmp, rd_count, rd));
572  if (0 == name_len)
573  name = NULL;
574  if (NULL != qe)
575  {
576  if (NULL != qe->proc)
577  qe->proc (qe->proc_cls,
578  &msg->private_key,
579  name,
580  rd_count,
581  (rd_count > 0) ? rd : NULL);
582  free_qe (qe);
583  return;
584  }
585  if (NULL != ze)
586  {
587  if (NULL != ze->proc)
588  ze->proc (ze->proc_cls, &msg->private_key, name, rd_count, rd);
589  return;
590  }
591  }
592  GNUNET_assert (0);
593 }
static void force_reconnect(struct GNUNET_NAMESTORE_Handle *h)
Disconnect from service and then reconnect.
static struct GNUNET_NAMESTORE_ZoneIterator * find_zi(struct GNUNET_NAMESTORE_Handle *h, uint32_t rid)
Find the zone iteration entry that matches the rid.
void * proc_cls
Closure for proc.
GNUNET_NAMESTORE_RecordMonitor proc
The continuation to call with the results.

References find_qe(), find_zi(), force_reconnect(), free_qe(), GNUNET_assert, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_GNSRECORD_records_deserialize(), GNUNET_OK, h, LOG, msg, name, GNUNET_NAMESTORE_ZoneIterator::proc, GNUNET_NAMESTORE_ZoneIterator::proc_cls, and qe.

Here is the call graph for this function:

◆ handle_record_result_end()

static void handle_record_result_end ( void *  cls,
const struct GNUNET_NAMESTORE_Header msg 
)
static

Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT_END.

Parameters
cls
msgthe message we received

Definition at line 604 of file namestore_api.c.

605 {
606  struct GNUNET_NAMESTORE_Handle *h = cls;
609 
610  LOG (GNUNET_ERROR_TYPE_DEBUG, "Received RECORD_RESULT_END\n");
611  ze = find_zi (h, ntohl (msg->r_id));
612  qe = find_qe (h, ntohl (msg->r_id));
613  if ((NULL == ze) && (NULL == qe))
614  return; /* rid not found */
615  if ((NULL != ze) && (NULL != qe))
616  {
617  GNUNET_break (0); /* rid ambiguous */
618  force_reconnect (h);
619  return;
620  }
621  LOG (GNUNET_ERROR_TYPE_DEBUG, "Zone iteration completed!\n");
622  if (NULL == ze)
623  {
624  GNUNET_break (0);
625  force_reconnect (h);
626  return;
627  }
628  if (NULL != ze->finish_cb)
629  ze->finish_cb (ze->finish_cb_cls);
630  free_ze (ze);
631 }
void * finish_cb_cls
Closure for error_cb.
GNUNET_SCHEDULER_TaskCallback finish_cb
Function to call on completion.

References find_qe(), find_zi(), GNUNET_NAMESTORE_ZoneIterator::finish_cb, GNUNET_NAMESTORE_ZoneIterator::finish_cb_cls, force_reconnect(), free_ze(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, h, LOG, msg, and qe.

Here is the call graph for this function:

◆ check_zone_to_name_response()

static int check_zone_to_name_response ( void *  cls,
const struct ZoneToNameResponseMessage msg 
)
static

Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE.

Parameters
qethe respective entry in the message queue
msgthe message we received
Returns
GNUNET_OK on success, GNUNET_SYSERR if message malformed

Definition at line 643 of file namestore_api.c.

645 {
646  size_t name_len;
647  size_t rd_ser_len;
648  const char *name_tmp;
649 
650  (void) cls;
651  if (GNUNET_OK != ntohs (msg->res))
652  return GNUNET_OK;
653  name_len = ntohs (msg->name_len);
654  rd_ser_len = ntohs (msg->rd_len);
655  if (ntohs (msg->gns_header.header.size) !=
656  sizeof(struct ZoneToNameResponseMessage) + name_len + rd_ser_len)
657  {
658  GNUNET_break (0);
659  return GNUNET_SYSERR;
660  }
661  name_tmp = (const char *) &msg[1];
662  if ((name_len > 0) && ('\0' != name_tmp[name_len - 1]))
663  {
664  GNUNET_break (0);
665  return GNUNET_SYSERR;
666  }
667  return check_rd (rd_ser_len, &name_tmp[name_len], ntohs (msg->rd_count));
668 }
Respone for zone to name lookup.
Definition: namestore.h:214

References check_rd(), GNUNET_break, GNUNET_OK, GNUNET_SYSERR, msg, and GNUNET_MessageHeader::size.

Here is the call graph for this function:

◆ handle_zone_to_name_response()

static void handle_zone_to_name_response ( void *  cls,
const struct ZoneToNameResponseMessage msg 
)
static

Handle an incoming message of type GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE.

Parameters
cls
msgthe message we received

Definition at line 679 of file namestore_api.c.

681 {
682  struct GNUNET_NAMESTORE_Handle *h = cls;
684  int res;
685  size_t name_len;
686  size_t rd_ser_len;
687  unsigned int rd_count;
688  const char *name_tmp;
689  const char *rd_tmp;
690 
691  LOG (GNUNET_ERROR_TYPE_DEBUG, "Received ZONE_TO_NAME_RESPONSE\n");
692  qe = find_qe (h, ntohl (msg->gns_header.r_id));
693  if (NULL == qe)
694  {
696  "Response queue already gone...\n");
697  return;
698  }
699  res = ntohs (msg->res);
700  switch (res)
701  {
702  case GNUNET_SYSERR:
704  "An error occurred during zone to name operation\n");
705  break;
706 
707  case GNUNET_NO:
709  "Namestore has no result for zone to name mapping \n");
710  if (NULL != qe->proc)
711  qe->proc (qe->proc_cls, &msg->zone, NULL, 0, NULL);
712  free_qe (qe);
713  return;
714 
715  case GNUNET_YES:
717  "Namestore has result for zone to name mapping \n");
718  name_len = ntohs (msg->name_len);
719  rd_count = ntohs (msg->rd_count);
720  rd_ser_len = ntohs (msg->rd_len);
721  name_tmp = (const char *) &msg[1];
722  rd_tmp = &name_tmp[name_len];
723  {
724  struct GNUNET_GNSRECORD_Data rd[rd_count];
725 
728  rd_tmp,
729  rd_count,
730  rd));
731  /* normal end, call continuation with result */
732  if (NULL != qe->proc)
733  qe->proc (qe->proc_cls, &msg->zone, name_tmp, rd_count, rd);
734  /* return is important here: break would call continuation with error! */
735  free_qe (qe);
736  return;
737  }
738 
739  default:
740  GNUNET_break (0);
741  force_reconnect (h);
742  return;
743  }
744  /* error case, call continuation with error */
745  if (NULL != qe->error_cb)
746  qe->error_cb (qe->error_cb_cls);
747  free_qe (qe);
748 }
@ GNUNET_YES
Definition: gnunet_common.h:97
@ GNUNET_ERROR_TYPE_WARNING

References find_qe(), force_reconnect(), free_qe(), GNUNET_assert, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_GNSRECORD_records_deserialize(), GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, h, LOG, msg, qe, and res.

Here is the call graph for this function:

◆ mq_error_handler()

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

Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.

Not every message queue implementation supports an error handler.

Parameters
clsclosure with the struct GNUNET_NAMESTORE_Handle *
errorerror code

Definition at line 760 of file namestore_api.c.

761 {
762  struct GNUNET_NAMESTORE_Handle *h = cls;
763 
764  (void) error;
765  force_reconnect (h);
766 }

References force_reconnect(), and h.

Referenced by reconnect().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reconnect()

static void reconnect ( struct GNUNET_NAMESTORE_Handle h)
static

Reconnect to namestore service.

Parameters
hthe handle to the NAMESTORE service

Definition at line 775 of file namestore_api.c.

776 {
778  { GNUNET_MQ_hd_fixed_size (record_store_response,
781  h),
782  GNUNET_MQ_hd_var_size (zone_to_name_response,
785  h),
786  GNUNET_MQ_hd_var_size (record_result,
788  struct RecordResultMessage,
789  h),
790  GNUNET_MQ_hd_fixed_size (record_result_end,
793  h),
794  GNUNET_MQ_hd_var_size (lookup_result,
797  h),
801 
802  GNUNET_assert (NULL == h->mq);
803  h->mq =
805  if (NULL == h->mq)
806  return;
807  /* re-transmit pending requests that waited for a reconnect... */
808  for (it = h->z_head; NULL != it; it = it->next)
809  {
810  GNUNET_MQ_send (h->mq, it->env);
811  it->env = NULL;
812  }
813  for (qe = h->op_head; NULL != qe; qe = qe->next)
814  {
815  GNUNET_MQ_send (h->mq, qe->env);
816  qe->env = NULL;
817  }
818 }
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
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:1064
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
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MQ_hd_fixed_size(name, code, str, ctx)
#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT_END
Service to client: end of list of results.
#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
Service to client: here is a (plaintext) record you requested.
#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
Service to client: result of zone-to-name lookup.
#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE
Service to client: result of store operation.
#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE
Service to client: lookup label.
static void mq_error_handler(void *cls, enum GNUNET_MQ_Error error)
Generic error handler, called with the appropriate error code and the same closure specified at the c...
const struct GNUNET_CONFIGURATION_Handle * cfg
The configuration that we are using.
Definition: arm_api.c:112
Message handler for a specific message type.
Generic namestore message with op id.
Definition: namestore.h:41
Response to a record storage request.
Definition: namestore.h:106

References GNUNET_ARM_Handle::cfg, GNUNET_DATASTORE_QueueEntry::env, GNUNET_NAMESTORE_ZoneIterator::env, GNUNET_assert, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE, GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT, GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT_END, GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE, GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_MQ_send(), h, handlers, GNUNET_ARM_Handle::mq, mq_error_handler(), GNUNET_DATASTORE_QueueEntry::next, GNUNET_NAMESTORE_ZoneIterator::next, and qe.

Referenced by GNUNET_NAMESTORE_connect(), and reconnect_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reconnect_task()

static void reconnect_task ( void *  cls)
static

Re-establish the connection to the service.

Parameters
clshandle to use to re-connect.

Definition at line 827 of file namestore_api.c.

828 {
829  struct GNUNET_NAMESTORE_Handle *h = cls;
830 
831  h->reconnect_task = NULL;
832  reconnect (h);
833 }
static void reconnect(struct GNUNET_NAMESTORE_Handle *h)
Reconnect to namestore service.

References h, reconnect(), and GNUNET_ARM_Handle::reconnect_task.

Referenced by force_reconnect().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_op_id()

static uint32_t get_op_id ( struct GNUNET_NAMESTORE_Handle h)
static

Get a fresh operation id to distinguish between namestore requests.

Parameters
hthe namestore handle
Returns
next operation id to use

Definition at line 880 of file namestore_api.c.

881 {
882  return h->last_op_id_used++;
883 }

References h.

Referenced by GNUNET_NAMESTORE_records_lookup(), GNUNET_NAMESTORE_records_store(), GNUNET_NAMESTORE_zone_iteration_start(), and GNUNET_NAMESTORE_zone_to_name().

Here is the caller graph for this function:

◆ warn_delay()

static void warn_delay ( void *  cls)
static

Task launched to warn the user that the namestore is excessively slow and that a query was thus dropped.

Parameters
clsa struct GNUNET_NAMESTORE_QueueEntry *

Definition at line 955 of file namestore_api.c.

956 {
957  struct GNUNET_NAMESTORE_QueueEntry *qe = cls;
958 
959  qe->timeout_task = NULL;
961  "Did not receive response from namestore after %s!\n",
963  GNUNET_YES));
964  if (NULL != qe->cont)
965  {
966  qe->cont (qe->cont_cls, GNUNET_SYSERR, "timeout");
967  qe->cont = NULL;
968  }
970 }
void GNUNET_NAMESTORE_cancel(struct GNUNET_NAMESTORE_QueueEntry *qe)
Cancel a namestore operation.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:557
#define NAMESTORE_DELAY_TOLERANCE
We grant the namestore up to 1 minute of latency, if it is slower than that, store queries will fail.
Definition: namestore_api.c:47

References GNUNET_DATASTORE_QueueEntry::cont, GNUNET_DATASTORE_QueueEntry::cont_cls, GNUNET_ERROR_TYPE_WARNING, GNUNET_NAMESTORE_cancel(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_SYSERR, GNUNET_YES, LOG, NAMESTORE_DELAY_TOLERANCE, and qe.

Referenced by GNUNET_NAMESTORE_records_store().

Here is the call graph for this function:
Here is the caller graph for this function: