- merge with master
[oweals/gnunet.git] / src / gns / gns_api.c
index 0963bdc5a86991cd35e7f5531d20ba1a8a9ce259..84c4ae189f3ee760450062b39309285fbfc67be4 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009-2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009-2013, 2016 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 /**
  * @file gns/gns_api.c
@@ -46,67 +46,37 @@ struct GNUNET_GNS_LookupRequest
    * DLL
    */
   struct GNUNET_GNS_LookupRequest *next;
-  
+
   /**
    * DLL
    */
   struct GNUNET_GNS_LookupRequest *prev;
-  
+
   /**
-   * handle to gns 
+   * handle to gns
    */
   struct GNUNET_GNS_Handle *gns_handle;
-  
+
   /**
-   * processor to call on lookup result 
+   * processor to call on lookup result
    */
   GNUNET_GNS_LookupResultProcessor lookup_proc;
 
   /**
-   * processor closure 
+   * @e lookup_proc closure
    */
   void *proc_cls;
-  /**
-   * request id 
-   */
-  uint32_t r_id;
-};
-
-
-/**
- * Entry in our list of messages to be (re-)transmitted.
- */
-struct PendingMessage
-{
-  /**
-   * This is a doubly-linked list.
-   */
-  struct PendingMessage *prev;
-
-  /**
-   * This is a doubly-linked list.
-   */
-  struct PendingMessage *next;
 
   /**
-   * Size of the message.
+   * Envelope with the message for this queue entry.
    */
-  size_t size;
+  struct GNUNET_MQ_Envelope *env;
 
   /**
    * request id
    */
   uint32_t r_id;
 
-  /**
-   * This message has been transmitted.  GNUNET_NO if the message is
-   * in the "pending" DLL, GNUNET_YES if it has been transmitted to
-   * the service via the current client connection.
-   */
-  int transmitted;
-
 };
 
 
@@ -122,40 +92,25 @@ struct GNUNET_GNS_Handle
   const struct GNUNET_CONFIGURATION_Handle *cfg;
 
   /**
-   * Socket (if available).
+   * Connection to service (if available).
    */
-  struct GNUNET_CLIENT_Connection *client;
+  struct GNUNET_MQ_Handle *mq;
 
   /**
-   * Currently pending transmission request (or NULL).
-   */
-  struct GNUNET_CLIENT_TransmitHandle *th;
-  
-  /**
-   * Head of linked list of shorten messages we would like to transmit.
-   */
-  struct PendingMessage *pending_head;
-
-  /**
-   * Tail of linked list of shorten messages we would like to transmit.
-   */
-  struct PendingMessage *pending_tail;
-  
-  /**
-   * Head of linked list of lookup messages we would like to transmit.
+   * Head of linked list of active lookup requests.
    */
   struct GNUNET_GNS_LookupRequest *lookup_head;
 
   /**
-   * Tail of linked list of lookup messages we would like to transmit.
+   * Tail of linked list of active lookup requests.
    */
   struct GNUNET_GNS_LookupRequest *lookup_tail;
 
   /**
    * Reconnect task
    */
-  GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
-  
+  struct GNUNET_SCHEDULER_Task *reconnect_task;
+
   /**
    * How long do we wait until we try to reconnect?
    */
@@ -165,52 +120,30 @@ struct GNUNET_GNS_Handle
    * Request Id generator.  Incremented by one for each request.
    */
   uint32_t r_id_gen;
-  
-  /**
-   * Did we start our receive loop yet?
-   */
-  int in_receive;
 
 };
 
 
-/**
- * Try to send messages from list of messages to send
- * @param handle GNS_Handle
- */
-static void
-process_pending_messages (struct GNUNET_GNS_Handle *handle);
-
-
 /**
  * Reconnect to GNS service.
  *
  * @param handle the handle to the GNS service
  */
 static void
-reconnect (struct GNUNET_GNS_Handle *handle)
-{
-  GNUNET_assert (NULL == handle->client);
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Trying to connect to GNS\n");
-  handle->client = GNUNET_CLIENT_connect ("gns", handle->cfg);
-  GNUNET_assert (NULL != handle->client);
-  process_pending_messages (handle);
-}
+reconnect (struct GNUNET_GNS_Handle *handle);
 
 
 /**
  * Reconnect to GNS
  *
  * @param cls the handle
- * @param tc task context
  */
 static void
-reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+reconnect_task (void *cls)
 {
   struct GNUNET_GNS_Handle *handle = cls;
 
-  handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+  handle->reconnect_task = NULL;
   reconnect (handle);
 }
 
@@ -223,228 +156,142 @@ reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 static void
 force_reconnect (struct GNUNET_GNS_Handle *handle)
 {
-  struct GNUNET_GNS_LookupRequest *lh;
-  struct PendingMessage *p;
-
-  GNUNET_CLIENT_disconnect (handle->client);
-  handle->client = NULL;
-  handle->in_receive = GNUNET_NO;
-  for (lh = handle->lookup_head; NULL != lh; lh = lh->next)
-  {
-    p = (struct PendingMessage *) &lh[1];
-    if (GNUNET_NO == p->transmitted)
-      continue;
-    p->transmitted = GNUNET_NO;
-    GNUNET_CONTAINER_DLL_insert (handle->pending_head,
-                                handle->pending_tail,
-                                p);  
-  }
-  handle->reconnect_backoff = GNUNET_TIME_STD_BACKOFF (handle->reconnect_backoff);
-  handle->reconnect_task = GNUNET_SCHEDULER_add_delayed (handle->reconnect_backoff,
-                                                    &reconnect_task,
-                                                    handle);
+  GNUNET_MQ_destroy (handle->mq);
+  handle->mq = NULL;
+  handle->reconnect_backoff
+    = GNUNET_TIME_STD_BACKOFF (handle->reconnect_backoff);
+  handle->reconnect_task
+    = GNUNET_SCHEDULER_add_delayed (handle->reconnect_backoff,
+                                   &reconnect_task,
+                                   handle);
 }
 
 
 /**
- * Transmit the next pending message, called by notify_transmit_ready
+ * 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.
  *
- * @param cls the closure
- * @param size size of pending data
- * @param buf buffer with pending data
- * @return size data transmitted
- */
-static size_t
-transmit_pending (void *cls, size_t size, void *buf);
-
-
-/**
- * Handler for messages received from the GNS service
- *
- * @param cls the 'struct GNUNET_GNS_Handle'
- * @param msg the incoming message
+ * @param cls closure with the `struct GNUNET_GNS_Handle *`
+ * @param error error code
  */
 static void
-process_message (void *cls, const struct GNUNET_MessageHeader *msg);
-
-
-/**
- * Try to send messages from list of messages to send
- *
- * @param handle the GNS handle
- */
-static void
-process_pending_messages (struct GNUNET_GNS_Handle *handle)
+mq_error_handler (void *cls,
+                  enum GNUNET_MQ_Error error)
 {
-  struct PendingMessage *p = handle->pending_head;
-
-  if (NULL == handle->client)
-    return; /* wait for reconnect */ 
-  if (NULL != handle->th)
-    return; /* transmission request already pending */ 
+  struct GNUNET_GNS_Handle *handle = cls;
 
-  while ((NULL != p) && (p->transmitted == GNUNET_YES))
-    p = p->next;
-  if (NULL == p)
-    return; /* no messages pending */
-  
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Trying to transmit %u bytes\n", 
-       (unsigned int) p->size);
-  handle->th =
-    GNUNET_CLIENT_notify_transmit_ready (handle->client,
-                                         p->size,
-                                         GNUNET_TIME_UNIT_FOREVER_REL,
-                                         GNUNET_NO, &transmit_pending,
-                                         handle);
-  GNUNET_break (NULL != handle->th);
+  LOG (GNUNET_ERROR_TYPE_WARNING,
+       "Problem with message queue. error: %i\n",
+       error);
+  force_reconnect (handle);
 }
 
 
 /**
- * Transmit the next pending message, called by notify_transmit_ready
+ * Check validity of message received from the GNS service
  *
- * @param cls the closure
- * @param size size of pending data
- * @param buf buffer with pending data
- * @return size data transmitted
+ * @param cls the `struct GNUNET_GNS_Handle *`
+ * @param loookup_msg the incoming message
  */
-static size_t
-transmit_pending (void *cls, size_t size, void *buf)
+static int
+check_result (void *cls,
+              const struct LookupResultMessage *lookup_msg)
 {
-  struct GNUNET_GNS_Handle *handle = cls;
-  char *cbuf = buf;
-  struct PendingMessage *p;
-  size_t tsize;
-
-  handle->th = NULL;
-  if ((0 == size) || (NULL == buf))
-  {
-    LOG (GNUNET_ERROR_TYPE_DEBUG,
-        "Transmission to GNS service failed!\n");
-    force_reconnect (handle);
-    return 0;
-  }  
-  if (NULL == (p = handle->pending_head))
-    return 0;
-
-  tsize = 0;
-  while ((NULL != (p = handle->pending_head)) && (p->size <= size))
+  size_t mlen = ntohs (lookup_msg->header.size) - sizeof (*lookup_msg);
+  uint32_t rd_count = ntohl (lookup_msg->rd_count);
+  struct GNUNET_GNSRECORD_Data rd[rd_count];
+
+  if (GNUNET_SYSERR ==
+      GNUNET_GNSRECORD_records_deserialize (mlen,
+                                            (const char*) &lookup_msg[1],
+                                            rd_count,
+                                            rd))
   {
-    memcpy (&cbuf[tsize], &p[1], p->size);
-    tsize += p->size;
-    size -= p->size;
-    p->transmitted = GNUNET_YES;
-    GNUNET_CONTAINER_DLL_remove (handle->pending_head,
-                                handle->pending_tail,
-                                p);
-    if (GNUNET_YES != handle->in_receive)
-    {
-      GNUNET_CLIENT_receive (handle->client, &process_message, handle,
-                             GNUNET_TIME_UNIT_FOREVER_REL);
-      handle->in_receive = GNUNET_YES;
-    }
+    GNUNET_break (0);
+    return GNUNET_SYSERR;
   }
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Sending %u bytes\n",
-       (unsigned int) tsize);
-  process_pending_messages (handle);
-  return tsize;
+  return GNUNET_OK;
 }
 
 
 /**
- * Process a given reply to the lookup request
+ * Handler for messages received from the GNS service
  *
- * @param qe a queue entry
- * @param msg the lookup message received
+ * @param cls the `struct GNUNET_GNS_Handle *`
+ * @param loookup_msg the incoming message
  */
 static void
-process_lookup_reply (struct GNUNET_GNS_LookupRequest *qe,
-                      const struct GNUNET_GNS_ClientLookupResultMessage *msg)
+handle_result (void *cls,
+               const struct LookupResultMessage *lookup_msg)
 {
-  struct GNUNET_GNS_Handle *handle = qe->gns_handle;
-  struct PendingMessage *p = (struct PendingMessage *) &qe[1];
-  uint32_t rd_count = ntohl (msg->rd_count);
-  struct GNUNET_NAMESTORE_RecordData rd[rd_count];
-  size_t mlen;
+  struct GNUNET_GNS_Handle *handle = cls;
+  size_t mlen = ntohs (lookup_msg->header.size) - sizeof (*lookup_msg);
+  uint32_t rd_count = ntohl (lookup_msg->rd_count);
+  struct GNUNET_GNSRECORD_Data rd[rd_count];
+  uint32_t r_id = ntohl (lookup_msg->id);
+  struct GNUNET_GNS_LookupRequest *lr;
+  GNUNET_GNS_LookupResultProcessor proc;
+  void *proc_cls;
 
-  if (GNUNET_YES != p->transmitted)
-  {
-    /* service send reply to query we never managed to send!? */
-    GNUNET_break (0);
-    force_reconnect (handle);
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Received lookup reply from GNS service (%u records)\n",
+       (unsigned int) rd_count);
+  for (lr = handle->lookup_head; NULL != lr; lr = lr->next)
+    if (lr->r_id == r_id)
+      break;
+  if (NULL == lr)
     return;
-  }
-  mlen = ntohs (msg->header.size);
-  mlen -= sizeof (struct GNUNET_GNS_ClientLookupResultMessage);
-  if (GNUNET_SYSERR == GNUNET_NAMESTORE_records_deserialize (mlen,
-                                                             (const char*) &msg[1],
-                                                             rd_count,
-                                                             rd))
-  {
-    LOG (GNUNET_ERROR_TYPE_ERROR,
-        _("Failed to serialize lookup reply from GNS service!\n"));
-    qe->lookup_proc (qe->proc_cls, 0, NULL);
-  }
-  else
-  { 
-    LOG (GNUNET_ERROR_TYPE_DEBUG,
-        "Received lookup reply from GNS service (%u records)\n",
-        (unsigned int) rd_count);
-    qe->lookup_proc (qe->proc_cls, rd_count, rd);
-  }
-  GNUNET_CONTAINER_DLL_remove (handle->lookup_head, handle->lookup_tail, qe);
-  GNUNET_free (qe);
+  proc = lr->lookup_proc;
+  proc_cls = lr->proc_cls;
+  
+  GNUNET_assert (GNUNET_OK ==
+                 GNUNET_GNSRECORD_records_deserialize (mlen,
+                                                       (const char*) &lookup_msg[1],
+                                                       rd_count,
+                                                       rd));
+  proc (proc_cls,
+        rd_count,
+        rd);
+  GNUNET_CONTAINER_DLL_remove (handle->lookup_head,
+                               handle->lookup_tail,
+                               lr);
+  if (NULL != lr->env)
+    GNUNET_MQ_discard (lr->env);
+  GNUNET_free (lr);
 }
 
 
 /**
- * Handler for messages received from the GNS service
+ * Reconnect to GNS service.
  *
- * @param cls the 'struct GNUNET_GNS_Handle'
- * @param msg the incoming message
+ * @param handle the handle to the GNS service
  */
 static void
-process_message (void *cls, const struct GNUNET_MessageHeader *msg)
+reconnect (struct GNUNET_GNS_Handle *handle)
 {
-  struct GNUNET_GNS_Handle *handle = cls;
-  struct GNUNET_GNS_LookupRequest *lr;
-  const struct GNUNET_GNS_ClientLookupResultMessage *lookup_msg;
-  uint32_t r_id;
-  
-  if (NULL == msg)
-  {
-    force_reconnect (handle);
-    return;
-  }
-  switch (ntohs (msg->type))
-  {
-  case GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT:
-    LOG (GNUNET_ERROR_TYPE_DEBUG,
-        "Got LOOKUP_RESULT msg\n");
-    if (ntohs (msg->size) < sizeof (struct GNUNET_GNS_ClientLookupResultMessage))
-    {
-      GNUNET_break (0);
-      force_reconnect (handle);
-      return;
-    }
-    lookup_msg = (const struct GNUNET_GNS_ClientLookupResultMessage *) msg;
-    r_id = ntohl (lookup_msg->id);   
-    for (lr = handle->lookup_head; NULL != lr; lr = lr->next)    
-      if (lr->r_id == r_id)
-      {
-       process_lookup_reply(lr, lookup_msg);    
-       break;
-      }
-    break;
-  default:
-    GNUNET_break (0);
-    force_reconnect (handle);
+  struct GNUNET_MQ_MessageHandler handlers[] = {
+    GNUNET_MQ_hd_var_size (result,
+                           GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT,
+                           struct LookupResultMessage,
+                           handle),
+    GNUNET_MQ_handler_end ()
+  };
+  struct GNUNET_GNS_LookupRequest *lh;
+
+  GNUNET_assert (NULL == handle->mq);
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Trying to connect to GNS\n");
+  handle->mq = GNUNET_CLIENT_connect (handle->cfg,
+                                      "gns",
+                                      handlers,
+                                      &mq_error_handler,
+                                      handle);
+  if (NULL == handle->mq)
     return;
-  }
-  GNUNET_CLIENT_receive (handle->client, &process_message, handle,
-                        GNUNET_TIME_UNIT_FOREVER_REL);
+  for (lh = handle->lookup_head; NULL != lh; lh = lh->next)
+    GNUNET_MQ_send_copy (handle->mq,
+                         lh->env);
 }
 
 
@@ -462,6 +309,11 @@ GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
   handle = GNUNET_new (struct GNUNET_GNS_Handle);
   handle->cfg = cfg;
   reconnect (handle);
+  if (NULL == handle->mq)
+  {
+    GNUNET_free (handle);
+    return NULL;
+  }
   return handle;
 }
 
@@ -474,11 +326,15 @@ GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
 void
 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle)
 {
-  GNUNET_CLIENT_disconnect (handle->client);
-  if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
+  if (NULL != handle->mq)
+  {
+    GNUNET_MQ_destroy (handle->mq);
+    handle->mq = NULL;
+  }
+  if (NULL != handle->reconnect_task)
   {
     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
-    handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+    handle->reconnect_task = NULL;
   }
   GNUNET_assert (NULL == handle->lookup_head);
   GNUNET_free (handle);
@@ -493,16 +349,12 @@ GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle)
 void
 GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr)
 {
-  struct PendingMessage *p = (struct PendingMessage*) &lr[1];
-
-  GNUNET_assert (NULL != lr->gns_handle); 
-  if (GNUNET_NO == p->transmitted)
-    GNUNET_CONTAINER_DLL_remove (lr->gns_handle->pending_head,
-                                 lr->gns_handle->pending_tail,
-                                 p);
-  GNUNET_CONTAINER_DLL_remove (lr->gns_handle->lookup_head,
-                               lr->gns_handle->lookup_tail,
+  struct GNUNET_GNS_Handle *handle = lr->gns_handle;
+
+  GNUNET_CONTAINER_DLL_remove (handle->lookup_head,
+                               handle->lookup_tail,
                                lr);
+  GNUNET_MQ_discard (lr->env);
   GNUNET_free (lr);
 }
 
@@ -514,74 +366,61 @@ GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr)
  * @param name the name to look up
  * @param zone the zone to start the resolution in
  * @param type the record type to look up
- * @param only_cached #GNUNET_YES to only check locally (not in the DHT)
- * @param shorten_zone_key the private key of the shorten zone (can be NULL)
+ * @param options local options for the lookup
  * @param proc processor to call on result
- * @param proc_cls closure for processor
+ * @param proc_cls closure for @a proc
  * @return handle to the get request
  */
 struct GNUNET_GNS_LookupRequest*
 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
-                  const char *name,
-                  const struct GNUNET_CRYPTO_EccPublicSignKey *zone,
-                  int type,
-                  int only_cached,
-                  const struct GNUNET_CRYPTO_EccPrivateKey *shorten_zone_key,
-                  GNUNET_GNS_LookupResultProcessor proc,
-                  void *proc_cls)
+                   const char *name,
+                   const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
+                   uint32_t type,
+                   enum GNUNET_GNS_LocalOptions options,
+                   GNUNET_GNS_LookupResultProcessor proc,
+                   void *proc_cls)
 {
   /* IPC to shorten gns names, return shorten_handle */
-  struct GNUNET_GNS_ClientLookupMessage *lookup_msg;
+  struct LookupMessage *lookup_msg;
   struct GNUNET_GNS_LookupRequest *lr;
-  size_t msize;
-  struct PendingMessage *pending;
+  size_t nlen;
 
   if (NULL == name)
   {
     GNUNET_break (0);
     return NULL;
-  } 
+  }
   LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Trying to lookup `%s' in GNS\n", 
+       "Trying to lookup `%s' in GNS\n",
        name);
-  msize = sizeof (struct GNUNET_GNS_ClientLookupMessage)
-    + strlen (name) + 1;
-  if (msize > UINT16_MAX)
+  nlen = strlen (name) + 1;
+  if (nlen >= GNUNET_MAX_MESSAGE_SIZE - sizeof (*lr))
   {
     GNUNET_break (0);
     return NULL;
   }
-  lr = GNUNET_malloc (sizeof (struct GNUNET_GNS_LookupRequest) +
-                     sizeof (struct PendingMessage) + msize);
+  lr = GNUNET_new (struct GNUNET_GNS_LookupRequest);
   lr->gns_handle = handle;
   lr->lookup_proc = proc;
   lr->proc_cls = proc_cls;
   lr->r_id = handle->r_id_gen++;
-  pending = (struct PendingMessage *)&lr[1];
-  pending->size = msize;
-  pending->r_id = lr->r_id;
-  GNUNET_CONTAINER_DLL_insert_tail (handle->lookup_head,
-                                    handle->lookup_tail, lr);
-
-  lookup_msg = (struct GNUNET_GNS_ClientLookupMessage *) &pending[1];
-  lookup_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_LOOKUP);
-  lookup_msg->header.size = htons (msize);
+  lr->env = GNUNET_MQ_msg_extra (lookup_msg,
+                                 nlen,
+                                 GNUNET_MESSAGE_TYPE_GNS_LOOKUP);
   lookup_msg->id = htonl (lr->r_id);
-  lookup_msg->only_cached = htonl (only_cached);
+  lookup_msg->options = htons ((uint16_t) options);
   lookup_msg->zone = *zone;
   lookup_msg->type = htonl (type);
-  if (NULL != shorten_zone_key)
-  {
-    lookup_msg->have_key = htons (GNUNET_YES);
-    lookup_msg->shorten_key = *shorten_zone_key;
-  }
-  memcpy (&lookup_msg[1], name, strlen (name) + 1);
-  GNUNET_CONTAINER_DLL_insert_tail (handle->pending_head,
-                                   handle->pending_tail,
-                                   pending);
-  process_pending_messages (handle);
+  GNUNET_memcpy (&lookup_msg[1],
+                 name,
+                 nlen);
+  GNUNET_CONTAINER_DLL_insert (handle->lookup_head,
+                               handle->lookup_tail,
+                               lr);
+  if (NULL != handle->mq)
+    GNUNET_MQ_send_copy (handle->mq,
+                         lr->env);
   return lr;
 }
 
-
 /* end of gns_api.c */