-lockmanager acquire retry
[oweals/gnunet.git] / src / lockmanager / lockmanager_api.c
index 6610644550974f243fbe3b8d640478e3377b71a6..2d2c75d509e02832e11b04870120487f70f3b643 100644 (file)
  * @author Sree Harsha Totakura
  */
 
+/**
+ * To be fixed:
+ *  Should the handle be freed when the connection to service is lost?
+ *  Should cancel_request have a call back (else simultaneous calls break)
+ */
+
 #include "platform.h"
 #include "gnunet_common.h"
 #include "gnunet_container_lib.h"
 
 #define TIMEOUT TIME_REL_MINS(3)
 
+
+/**
+ * The message queue
+ */
+struct MessageQueue
+{
+  /**
+   * The next pointer for doubly linked list
+   */
+  struct MessageQueue *next;
+
+  /**
+   * The prev pointer for doubly linked list
+   */
+  struct MessageQueue *prev;
+  
+  /**
+   * The LOCKMANAGER Message
+   */
+  struct GNUNET_LOCKMANAGER_Message *msg;
+};
+
+
 /**
  * Handler for the lockmanager service
  */
@@ -52,10 +81,30 @@ struct GNUNET_LOCKMANAGER_Handle
    */
   struct GNUNET_CLIENT_Connection *conn;
 
+  /**
+   * The transmit handle for transmissions using conn
+   */
+  struct GNUNET_CLIENT_TransmitHandle *transmit_handle;
+
   /**
    * Hashmap handle
    */
   struct GNUNET_CONTAINER_MultiHashMap *hashmap;
+
+  /**
+   * Double linked list head for message queue
+   */
+  struct MessageQueue *mq_head;
+
+  /**
+   * Double linked list tail for message queue
+   */
+  struct MessageQueue *mq_tail;
+
+  /**
+   * Are we currently handling replies?
+   */
+  int in_replies;
 };
 
 
@@ -79,11 +128,6 @@ struct GNUNET_LOCKMANAGER_LockingRequest
    */
   void *status_cb_cls;
 
-  /**
-   * The pending transmit handle for the ACQUIRE message
-   */
-  struct GNUNET_CLIENT_TransmitHandle *transmit_handle;
-
   /**
    * The locking domain of this request
    */
@@ -104,7 +148,7 @@ struct GNUNET_LOCKMANAGER_LockingRequest
 /**
  * Structure for matching a lock
  */
-struct LockMatch
+struct LockingRequestMatch
 {
   /**
    * The matched LockingRequest entry; Should be NULL if no entry is found
@@ -123,6 +167,112 @@ struct LockMatch
 };
 
 
+/**
+ * Handler for server replies
+ *
+ * @param cls the LOCKMANAGER_Handle
+ * @param msg received message, NULL on timeout or fatal error
+ */
+static void 
+handle_replies (void *cls,
+                const struct GNUNET_MessageHeader *msg);
+
+
+/**
+ * Transmit notify for sending message to server
+ *
+ * @param cls the lockmanager handle
+ * @param size number of bytes available in buf
+ * @param buf where the callee should write the message
+ * @return number of bytes written to buf
+ */
+static size_t 
+transmit_notify (void *cls, size_t size, void *buf)
+{
+  struct GNUNET_LOCKMANAGER_Handle *handle = cls;
+  struct MessageQueue *queue_entity;
+  uint16_t msg_size;
+
+  handle->transmit_handle = NULL;
+  queue_entity = handle->mq_head;
+  GNUNET_assert (NULL != queue_entity);
+  if ((0 == size) || (NULL == buf))
+  {
+    handle->transmit_handle =
+      GNUNET_CLIENT_notify_transmit_ready (handle->conn,
+                                           ntohs
+                                           (queue_entity->msg->header.size),
+                                           GNUNET_TIME_UNIT_FOREVER_REL,
+                                           GNUNET_YES,
+                                           &transmit_notify,
+                                           handle);
+    return 0;
+  } 
+  msg_size = ntohs (queue_entity->msg->header.size);
+  GNUNET_assert (size >= msg_size);
+  memcpy (buf, queue_entity->msg, msg_size);
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Message of size %u sent\n", msg_size);
+  GNUNET_free (queue_entity->msg);
+  GNUNET_CONTAINER_DLL_remove (handle->mq_head,
+                               handle->mq_tail,
+                               queue_entity);
+  GNUNET_free (queue_entity);
+  queue_entity = handle->mq_head;
+  if (NULL != queue_entity)
+  {
+    handle->transmit_handle =
+      GNUNET_CLIENT_notify_transmit_ready (handle->conn,
+                                           ntohs
+                                           (queue_entity->msg->header.size),
+                                           TIMEOUT,
+                                           GNUNET_YES,
+                                           &transmit_notify,
+                                           handle);
+  }
+  if (GNUNET_NO == handle->in_replies)
+  {
+    GNUNET_CLIENT_receive (handle->conn,
+                           &handle_replies,
+                           handle,
+                           GNUNET_TIME_UNIT_FOREVER_REL);
+    handle->in_replies = GNUNET_YES;
+  }
+  return msg_size;
+}
+
+
+/**
+ * Queues a message into handle's send message queue
+ *
+ * @param handle the lockmanager handle whose queue will be used
+ * @param msg the message to be queued
+ */
+static void
+queue_message (struct GNUNET_LOCKMANAGER_Handle *handle,
+               struct GNUNET_LOCKMANAGER_Message *msg)
+{
+  struct MessageQueue *queue_entity;
+
+  GNUNET_assert (NULL != msg);
+  queue_entity = GNUNET_malloc (sizeof (struct MessageQueue));
+  queue_entity->msg = msg;
+  GNUNET_CONTAINER_DLL_insert_tail (handle->mq_head,
+                                    handle->mq_tail,
+                                    queue_entity);
+  if (NULL == handle->transmit_handle)
+  {
+    handle->transmit_handle =
+      GNUNET_CLIENT_notify_transmit_ready (handle->conn,
+                                           ntohs (msg->header.size),
+                                           TIMEOUT,
+                                           GNUNET_YES,
+                                           &transmit_notify,
+                                           handle);
+  }
+}
+
+
 /**
  * Get the key for the given lock in the 'lock_map'.
  *
@@ -146,9 +296,9 @@ get_key (const char *domain_name,
 
 
 /**
- * Hashmap iterator for matching a lock
+ * Hashmap iterator for matching a LockingRequest
  *
- * @param cls the LockMatch structure
+ * @param cls the LockingRequestMatch structure
  * @param key current key code
  * @param value value in the hash map (struct GNUNET_LOCKMANAGER_LockingRequest)
  * @return GNUNET_YES if we should continue to
@@ -156,9 +306,9 @@ get_key (const char *domain_name,
  *         GNUNET_NO if not. 
  */
 static int
-match_iterator (void *cls, const GNUNET_HashCode *key, void *value)
+match_iterator (void *cls, const struct GNUNET_HashCode *key, void *value)
 {
-  struct LockMatch *match = cls;
+  struct LockingRequestMatch *match = cls;
   struct GNUNET_LOCKMANAGER_LockingRequest *lr = value;
 
   if ( (match->lock == lr->lock) && (0 == strcmp (match->domain, lr->domain)) )
@@ -186,7 +336,7 @@ hashmap_find_lockingrequest (const struct GNUNET_CONTAINER_MultiHashMap *map,
                              uint32_t lock)
 {
   struct GNUNET_HashCode hash;
-  struct LockMatch lock_match;
+  struct LockingRequestMatch lock_match;
 
   lock_match.matched_entry = NULL;
   lock_match.domain = domain;
@@ -214,7 +364,7 @@ call_status_cb_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   if (NULL != r->status_cb)
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Calling status change callback for lock: %d in domain: %s\n",
+         "Calling status change for SUCCESS on lock num: %d, domain: %s\n",
          r->lock, r->domain);
     r->status_cb (r->status_cb_cls,
                   r->domain,
@@ -224,6 +374,69 @@ call_status_cb_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 }
 
 
+/**
+ * Function to generate acquire message for a lock
+ *
+ * @param domain_name the domain name of the lock
+ * @param lock the lock number
+ * @return the generated GNUNET_LOCKMANAGER_Message
+ */
+static struct GNUNET_LOCKMANAGER_Message *
+generate_acquire_msg (const char *domain_name, uint32_t lock)
+{
+  struct GNUNET_LOCKMANAGER_Message *msg;
+  size_t domain_name_len;
+  uint16_t  msg_size;
+  
+  domain_name_len = strlen (domain_name) + 1;
+  msg_size = sizeof (struct GNUNET_LOCKMANAGER_Message) + domain_name_len;
+  msg = GNUNET_malloc (msg_size);
+  msg->header.type = htons (GNUNET_MESSAGE_TYPE_LOCKMANAGER_ACQUIRE);
+  msg->header.size = htons (msg_size);
+  msg->lock = htonl (lock);
+  memcpy (&msg[1], domain_name, domain_name_len);
+  return msg;
+}
+
+
+/**
+ * Iterator to call relase on locks
+ *
+ * @param cls the lockmanager handle
+ * @param key current key code
+ * @param value the Locking request
+ * @return GNUNET_YES if we should continue to
+ *         iterate,
+ *         GNUNET_NO if not.
+ */
+static int
+release_n_retry_iterator (void *cls,
+                          const struct GNUNET_HashCode * key,
+                          void *value)
+{
+  struct GNUNET_LOCKMANAGER_LockingRequest *r = value;
+  struct GNUNET_LOCKMANAGER_Handle *h = cls;
+  struct GNUNET_LOCKMANAGER_Message *msg;
+
+  msg = generate_acquire_msg (r->domain, r->lock);
+  queue_message (h, msg);
+  if (GNUNET_LOCKMANAGER_RELEASE == r->status)
+    return GNUNET_YES;
+  if (NULL != r->status_cb)
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Calling status change for RELEASE on lock num: %d, domain: %s\n",
+         r->lock, r->domain);
+    r->status = GNUNET_LOCKMANAGER_RELEASE;
+    r->status_cb (r->status_cb_cls,
+                  r->domain,
+                  r->lock,
+                  GNUNET_LOCKMANAGER_RELEASE);
+  }
+  return GNUNET_YES;
+}
+
+
 /**
  * Handler for server replies
  *
@@ -241,13 +454,23 @@ handle_replies (void *cls,
   struct GNUNET_HashCode hash;
   uint32_t lock;
   uint16_t msize;
-  
+
+  handle->in_replies = GNUNET_NO;
   if (NULL == msg)
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Lockmanager service not available or went down\n");
+         "Lockmanager service not available or went down\n");    
+    /* Should release all locks and retry to acquire them */
+    GNUNET_CONTAINER_multihashmap_iterate (handle->hashmap,
+                                           &release_n_retry_iterator,
+                                           handle);
     return;
   }
+  GNUNET_CLIENT_receive (handle->conn,
+                         &handle_replies,
+                         handle,
+                         GNUNET_TIME_UNIT_FOREVER_REL);
+  handle->in_replies = GNUNET_YES;
   if (GNUNET_MESSAGE_TYPE_LOCKMANAGER_SUCCESS != ntohs(msg->type))
   {
     GNUNET_break (0);
@@ -295,39 +518,10 @@ handle_replies (void *cls,
 }
 
 
-/**
- * Transmit notify for sending message to server
- *
- * @param cls the message to send
- * @param size number of bytes available in buf
- * @param buf where the callee should write the message
- * @return number of bytes written to buf
- */
-static size_t 
-transmit_notify (void *cls, size_t size, void *buf)
-{
-  struct GNUNET_LOCKMANAGER_Message *msg = cls;
-  uint16_t msg_size;
-
-  if ((0 == size) || (NULL == buf))
-  {
-    /* FIXME: Timed out -- requeue? */
-    return 0;
-  }
-  msg_size = ntohs (msg->header.size);
-  GNUNET_assert (size >= msg_size);
-  memcpy (buf, msg, msg_size);
-  GNUNET_free (msg);
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Message of size %u sent\n", msg_size);
-  return msg_size;
-}
-
-
 /**
  * Iterator to free hash map entries.
  *
- * @param cls NULL
+ * @param cls the lockmanger handle
  * @param key current key code
  * @param value the Locking request
  * @return GNUNET_YES if we should continue to
@@ -336,13 +530,18 @@ transmit_notify (void *cls, size_t size, void *buf)
  */
 static int
 free_iterator(void *cls,
-              const GNUNET_HashCode * key,
+              const struct GNUNET_HashCode * key,
               void *value)
 {
+  struct GNUNET_LOCKMANAGER_Handle *h = cls;
   struct GNUNET_LOCKMANAGER_LockingRequest *r = value;
 
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Clearing locking request\n");
+  GNUNET_assert (GNUNET_YES == 
+                 GNUNET_CONTAINER_multihashmap_remove (h->hashmap,
+                                                       key,
+                                                       value));
   GNUNET_free (r->domain);
   GNUNET_free (r);
   return GNUNET_YES;
@@ -381,7 +580,7 @@ GNUNET_LOCKMANAGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
                          &handle_replies,
                          h,
                          GNUNET_TIME_UNIT_FOREVER_REL);
-  
+  h->in_replies = GNUNET_YES;
   LOG (GNUNET_ERROR_TYPE_DEBUG, "%s() END\n", __func__);
   return h;
 }
@@ -395,8 +594,9 @@ GNUNET_LOCKMANAGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
 void
 GNUNET_LOCKMANAGER_disconnect (struct GNUNET_LOCKMANAGER_Handle *handle)
 {
+  struct MessageQueue *head;
+
   LOG (GNUNET_ERROR_TYPE_DEBUG, "%s()\n", __func__);
-  GNUNET_CLIENT_disconnect (handle->conn);
   if (0 != GNUNET_CONTAINER_multihashmap_size (handle->hashmap))
   {
     LOG (GNUNET_ERROR_TYPE_WARNING,
@@ -404,9 +604,25 @@ GNUNET_LOCKMANAGER_disconnect (struct GNUNET_LOCKMANAGER_Handle *handle)
          "calling %s\n", __func__);
     GNUNET_CONTAINER_multihashmap_iterate (handle->hashmap,
                                            &free_iterator,
-                                           NULL);
+                                           handle);
   }
   GNUNET_CONTAINER_multihashmap_destroy (handle->hashmap);
+  /* Clear the message queue */
+  if (NULL != handle->transmit_handle)
+  {
+    GNUNET_CLIENT_notify_transmit_ready_cancel (handle->transmit_handle);
+  }
+  head = handle->mq_head;
+  while (NULL != head)
+  {
+    GNUNET_CONTAINER_DLL_remove (handle->mq_head,
+                                 handle->mq_tail,
+                                 head);
+    GNUNET_free (head->msg);
+    GNUNET_free (head);
+    head = handle->mq_head;
+  }
+  GNUNET_CLIENT_disconnect (handle->conn);
   GNUNET_free (handle);
   LOG (GNUNET_ERROR_TYPE_DEBUG, "%s() END\n", __func__);
 }
@@ -446,7 +662,6 @@ GNUNET_LOCKMANAGER_acquire_lock (struct GNUNET_LOCKMANAGER_Handle *handle,
   struct GNUNET_LOCKMANAGER_LockingRequest *r;
   struct GNUNET_LOCKMANAGER_Message *msg;
   struct GNUNET_HashCode hash;
-  uint16_t msg_size;
   size_t domain_name_length;
   
   LOG (GNUNET_ERROR_TYPE_DEBUG, "%s()\n", __func__);
@@ -459,20 +674,9 @@ GNUNET_LOCKMANAGER_acquire_lock (struct GNUNET_LOCKMANAGER_Handle *handle,
   r->status_cb = status_cb;
   r->status_cb_cls = status_cb_cls;
   memcpy (r->domain, domain_name, domain_name_length);
-  msg_size = sizeof (struct GNUNET_LOCKMANAGER_Message) + domain_name_length;
-  msg = GNUNET_malloc (msg_size);
-  msg->header.type = htons (GNUNET_MESSAGE_TYPE_LOCKMANAGER_ACQUIRE);
-  msg->header.size = htons (msg_size);
-  msg->lock = htonl (lock);
-  memcpy (&msg[1], r->domain, domain_name_length);
+  msg = generate_acquire_msg (r->domain, r->lock);
   LOG (GNUNET_ERROR_TYPE_DEBUG, "Queueing ACQUIRE message\n");
-  r->transmit_handle =
-    GNUNET_CLIENT_notify_transmit_ready (r->handle->conn,
-                                         msg_size,
-                                         TIMEOUT,
-                                         GNUNET_YES,
-                                         &transmit_notify,
-                                         msg);
+  queue_message (handle, msg);
   get_key (r->domain, r->lock, &hash);
   GNUNET_CONTAINER_multihashmap_put (r->handle->hashmap,
                                      &hash,
@@ -486,8 +690,8 @@ GNUNET_LOCKMANAGER_acquire_lock (struct GNUNET_LOCKMANAGER_Handle *handle,
 
 /**
  * Function to cancel the locking request generated by
- * GNUNET_LOCKMANAGER_acquire_lock. If the lock is acquired us then the lock is
- * released. GNUNET_LOCKMANAGER_StatusCallback will not be called upon any
+ * GNUNET_LOCKMANAGER_acquire_lock. If the lock is acquired by us then the lock
+ * is released. GNUNET_LOCKMANAGER_StatusCallback will not be called upon any
  * status changes resulting due to this call.
  *
  * @param request the LockingRequest to cancel
@@ -513,12 +717,7 @@ GNUNET_LOCKMANAGER_cancel_request (struct GNUNET_LOCKMANAGER_LockingRequest
     msg->header.size = htons (msg_size);
     msg->lock = htonl (request->lock);
     memcpy (&msg[1], request->domain, domain_name_length);
-    GNUNET_CLIENT_notify_transmit_ready (request->handle->conn,
-                                         msg_size,
-                                         TIMEOUT, /* What if this fails */
-                                         GNUNET_NO,
-                                         &transmit_notify,
-                                         msg);
+    queue_message (request->handle, msg);
   }
   get_key (request->domain, request->lock, &hash);
   GNUNET_assert (GNUNET_YES ==