proper shutdown
[oweals/gnunet.git] / src / util / client.c
index 588957d85a9b230ea8d8c6def5c029d6efbc624f..7e688059044211cebf40dcea045f51534252b4a0 100644 (file)
@@ -43,7 +43,6 @@
  */
 #define MAX_ATTEMPTS 50
 
-
 /**
  * Handle for a transmission request.
  */
@@ -136,47 +135,6 @@ struct TransmitGetResponseContext
   void *rn_cls;
 };
 
-/**
- * Context for handling the shutdown of a service.
- */
-struct ShutdownContext
-{
-  /**
-   * Scheduler to be used to call continuation
-   */
-  struct GNUNET_SCHEDULER_Handle *sched;
-  /**
-   * Connection to the service that is being shutdown.
-   */
-  struct GNUNET_CLIENT_Connection *sock;
-
-  /**
-   * Time allowed for shutdown to happen.
-   */
-  struct GNUNET_TIME_Absolute timeout;
-
-  /**
-   * Task set up to cancel the shutdown request on timeout.
-   */
-  GNUNET_SCHEDULER_TaskIdentifier cancel_task;
-
-  /**
-   * Task to call once shutdown complete
-   */
-  GNUNET_CLIENT_ShutdownTask cont;
-
-  /**
-   * Closure for shutdown continuation
-   */
-  void *cont_cls;
-
-  /**
-   * We received a confirmation that the service will shut down.
-   */
-  int confirmed;
-
-};
-
 /**
  * Struct to refer to a GNUnet TCP connection.
  * This is more than just a socket because if the server
@@ -191,13 +149,9 @@ struct GNUNET_CLIENT_Connection
    */
   struct GNUNET_CONNECTION_Handle *sock;
 
-  /**
-   * Our scheduler.
-   */
-  struct GNUNET_SCHEDULER_Handle *sched;
-
   /**
    * Our configuration.
+   * FIXME: why do we DUP the configuration? Avoid this!
    */
   struct GNUNET_CONFIGURATION_Handle *cfg;
 
@@ -290,19 +244,58 @@ struct GNUNET_CLIENT_Connection
    * Are we ignoring shutdown signals?
    */
   int ignore_shutdown;
+  
+  /**
+   * How often have we tried to connect?
+   */
+  unsigned int attempts;
 
 };
 
 
+/**
+ * Try to connect to the service.
+ *
+ * @param service_name name of service to connect to
+ * @param cfg configuration to use
+ * @param attempt counter used to alternate between IP and UNIX domain sockets
+ * @return NULL on error
+ */
 static struct GNUNET_CONNECTION_Handle *
-do_connect (struct GNUNET_SCHEDULER_Handle *sched,
-            const char *service_name,
-            const struct GNUNET_CONFIGURATION_Handle *cfg)
+do_connect (const char *service_name,
+            const struct GNUNET_CONFIGURATION_Handle *cfg,
+           unsigned int attempt)
 {
   struct GNUNET_CONNECTION_Handle *sock;
   char *hostname;
+  char *unixpath;
   unsigned long long port;
 
+  sock = NULL;
+#if AF_UNIX
+  if (0 == (attempt % 2))
+    {
+      /* on even rounds, try UNIX */
+      if ((GNUNET_OK ==
+         GNUNET_CONFIGURATION_get_value_string (cfg,
+                                                service_name,
+                                                "UNIXPATH", &unixpath)) &&
+          (0 < strlen (unixpath))) /* We have a non-NULL unixpath, does that mean it's valid? */
+       {
+          sock = GNUNET_CONNECTION_create_from_connect_to_unixpath (cfg, unixpath);
+         if (sock != NULL)
+           {
+#if DEBUG_CLIENT
+              GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Connected to unixpath `%s'!\n", unixpath);
+#endif
+              GNUNET_free(unixpath);
+              return sock;
+           }
+       }
+      GNUNET_free_non_null (unixpath);
+    }
+#endif
+
   if ((GNUNET_OK !=
        GNUNET_CONFIGURATION_get_value_number (cfg,
                                               service_name,
@@ -315,8 +308,7 @@ do_connect (struct GNUNET_SCHEDULER_Handle *sched,
                                               "HOSTNAME", &hostname)))
     {
       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                  _
-                  ("Could not determine valid hostname and port for service `%s' from configuration.\n"),
+                  _("Could not determine valid hostname and port for service `%s' from configuration.\n"),
                   service_name);
       return NULL;
     }
@@ -328,11 +320,38 @@ do_connect (struct GNUNET_SCHEDULER_Handle *sched,
                   service_name);
       return NULL;
     }
-  sock = GNUNET_CONNECTION_create_from_connect (sched,
-                                                cfg,
+  if (port == 0)
+    {
+#if AF_UNIX
+      if (0 != (attempt % 2))
+       {
+         /* try UNIX */
+         if ((GNUNET_OK ==
+             GNUNET_CONFIGURATION_get_value_string (cfg,
+                                                    service_name,
+                                                    "UNIXPATH", &unixpath)) &&
+              (0 < strlen (unixpath)))
+           {
+             sock = GNUNET_CONNECTION_create_from_connect_to_unixpath (cfg,
+                                                                       unixpath);
+             GNUNET_free (unixpath);
+             if (sock != NULL)
+               return sock;            
+           }
+       }
+#endif
+#if DEBUG_CLIENT
+      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, 
+                 "Port is 0 for service `%s', UNIXPATH did not work, returning NULL!\n",
+                 service_name);
+#endif
+      GNUNET_free (hostname);
+      return NULL;
+    }
+
+  sock = GNUNET_CONNECTION_create_from_connect (cfg,
                                                 hostname,
-                                                port,
-                                                GNUNET_SERVER_MAX_MESSAGE_SIZE);
+                                                port);
   GNUNET_free (hostname);
   return sock;
 }
@@ -341,25 +360,24 @@ do_connect (struct GNUNET_SCHEDULER_Handle *sched,
 /**
  * Get a connection with a service.
  *
- * @param sched scheduler to use
  * @param service_name name of the service
  * @param cfg configuration to use
  * @return NULL on error (service unknown to configuration)
  */
 struct GNUNET_CLIENT_Connection *
-GNUNET_CLIENT_connect (struct GNUNET_SCHEDULER_Handle *sched,
-                       const char *service_name,
+GNUNET_CLIENT_connect (const char *service_name,
                        const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
   struct GNUNET_CLIENT_Connection *ret;
   struct GNUNET_CONNECTION_Handle *sock;
 
-  sock = do_connect (sched, service_name, cfg);
+  sock = do_connect (service_name,
+                    cfg, 0);
   if (sock == NULL)
     return NULL;
   ret = GNUNET_malloc (sizeof (struct GNUNET_CLIENT_Connection));
+  ret->attempts = 1;
   ret->sock = sock;
-  ret->sched = sched;
   ret->service_name = GNUNET_strdup (service_name);
   ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
   ret->back_off = GNUNET_TIME_UNIT_MILLISECONDS;
@@ -421,7 +439,7 @@ GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
     GNUNET_CLIENT_notify_transmit_ready_cancel (sock->th);
   if (sock->receive_task != GNUNET_SCHEDULER_NO_TASK)
     {
-      GNUNET_SCHEDULER_cancel (sock->sched, sock->receive_task);
+      GNUNET_SCHEDULER_cancel (sock->receive_task);
       sock->receive_task = GNUNET_SCHEDULER_NO_TASK;
     }
   GNUNET_array_grow (sock->received_buf, sock->received_size, 0);
@@ -473,6 +491,9 @@ receive_helper (void *cls,
   if ((available == 0) || (conn->sock == NULL) || (errCode != 0))
     {
       /* signal timeout! */
+#if DEBUG_CLIENT
+      GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "timeout in receive_helper, available %d, conn->sock %s, errCode %d\n", available, conn->sock == NULL ? "NULL" : "non-NULL", errCode);
+#endif
       if (NULL != (receive_handler = conn->receiver_handler))
         {
           receive_handler_cls = conn->receiver_handler_cls;
@@ -495,7 +516,7 @@ receive_helper (void *cls,
   check_complete (conn);
   /* check for timeout */
   remaining = GNUNET_TIME_absolute_get_remaining (conn->receive_timeout);
-  if (remaining.value == 0)
+  if (remaining.rel_value == 0)
     {
       /* signal timeout! */
       conn->receiver_handler (conn->receiver_handler_cls, NULL);
@@ -526,6 +547,12 @@ receive_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   char mbuf[msize];
   struct GNUNET_MessageHeader *msg = (struct GNUNET_MessageHeader *) mbuf;
 
+#if DEBUG_CLIENT
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+             "Received message of type %u and size %u\n",
+             ntohs (cmsg->type),
+             msize);
+#endif
   sock->receive_task = GNUNET_SCHEDULER_NO_TASK;
   GNUNET_assert (GNUNET_YES == sock->msg_complete);
   GNUNET_assert (sock->received_pos >= msize);
@@ -566,191 +593,30 @@ GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *sock,
   sock->receive_timeout = GNUNET_TIME_relative_to_absolute (timeout);
   if (GNUNET_YES == sock->msg_complete)
     {
-      sock->receive_task = GNUNET_SCHEDULER_add_after (sock->sched,
-                                                       GNUNET_SCHEDULER_NO_TASK,
+      sock->receive_task = GNUNET_SCHEDULER_add_after (GNUNET_SCHEDULER_NO_TASK,
                                                        &receive_task, sock);
     }
   else
     {
+      GNUNET_assert (sock->in_receive == GNUNET_NO);
       sock->in_receive = GNUNET_YES;
+#if DEBUG_CLIENT
+      GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "calling GNUNET_CONNECTION_receive\n");
+#endif
       GNUNET_CONNECTION_receive (sock->sock,
-                                 GNUNET_SERVER_MAX_MESSAGE_SIZE,
+                                 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
                                  timeout, &receive_helper, sock);
     }
 }
 
 
-/**
- * Handler receiving response to service shutdown requests.
- * First call with NULL: service misbehaving, or something.
- * First call with GNUNET_MESSAGE_TYPE_SHUTDOWN_ACK:
- *   - service will shutdown
- * First call with GNUNET_MESSAGE_TYPE_SHUTDOWN_REFUSE:
- *   - service will not be stopped!
- *
- * Second call with NULL:
- *   - service has now really shut down.
- *
- * @param cls closure
- * @param msg NULL, indicating socket closure.
- */
-static void
-service_shutdown_handler (void *cls, const struct GNUNET_MessageHeader *msg)
-{
-  struct ShutdownContext *shutdown_ctx = cls;
-
-  if ((msg == NULL) && (shutdown_ctx->confirmed != GNUNET_YES))   
-    {
-      /* Means the other side closed the connection and never confirmed a shutdown */
-      GNUNET_log(GNUNET_ERROR_TYPE_WARNING, 
-                "Service handle shutdown before ACK!\n");
-      if (shutdown_ctx->cont != NULL)
-        shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);      
-      GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
-      GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
-      GNUNET_free(shutdown_ctx);
-    }
-  else if ((msg == NULL) && (shutdown_ctx->confirmed == GNUNET_YES))
-    {
-      GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Service shutdown complete.\n");
-      if (shutdown_ctx->cont != NULL)
-        shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_NO);
-
-      GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
-      GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
-      GNUNET_free(shutdown_ctx);
-    }
-  else
-    {
-      GNUNET_assert(ntohs(msg->size) == sizeof(struct GNUNET_MessageHeader));
-
-      switch (ntohs(msg->type))
-      {
-      case GNUNET_MESSAGE_TYPE_SHUTDOWN_ACK:
-        GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
-                  "Received confirmation for service shutdown.\n");
-        shutdown_ctx->confirmed = GNUNET_YES;
-        GNUNET_CLIENT_receive (shutdown_ctx->sock, 
-                              &service_shutdown_handler, 
-                              shutdown_ctx, 
-                              GNUNET_TIME_UNIT_FOREVER_REL);
-        break;
-      case GNUNET_MESSAGE_TYPE_SHUTDOWN_REFUSE:
-      default: /* Fall through */
-        GNUNET_log(GNUNET_ERROR_TYPE_WARNING, 
-                  "Service shutdown refused!\n");
-        if (shutdown_ctx->cont != NULL)
-          shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_YES);
-
-        GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
-        GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
-        GNUNET_free(shutdown_ctx);
-        break;
-      }
-    }
-}
-
-/**
- * Shutting down took too long, cancel receive and return error.
- *
- * @param cls closure
- * @param tc context information (why was this task triggered now)
- */
-void service_shutdown_cancel (void *cls,
-                              const struct GNUNET_SCHEDULER_TaskContext * tc)
-{
-  struct ShutdownContext *shutdown_ctx = cls;
-  GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "service_shutdown_cancel called!\n");
-  shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
-  GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
-  GNUNET_free(shutdown_ctx);
-}
-
-
-/**
- * If possible, write a shutdown message to the target
- * buffer and destroy the client connection.
- *
- * @param cls the "struct GNUNET_CLIENT_Connection" to destroy
- * @param size number of bytes available in buf
- * @param buf NULL on error, otherwise target buffer
- * @return number of bytes written to buf
- */
-static size_t
-write_shutdown (void *cls, size_t size, void *buf)
-{
-  struct GNUNET_MessageHeader *msg;
-  struct ShutdownContext *shutdown_ctx = cls;
-
-  if (size < sizeof (struct GNUNET_MessageHeader))
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                  _("Failed to transmit shutdown request to client.\n"));
-      shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
-      GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
-      GNUNET_free(shutdown_ctx);
-      return 0;                 /* client disconnected */
-    }
-
-  GNUNET_CLIENT_receive (shutdown_ctx->sock,
-                        &service_shutdown_handler, shutdown_ctx, 
-                        GNUNET_TIME_UNIT_FOREVER_REL);
-  shutdown_ctx->cancel_task = GNUNET_SCHEDULER_add_delayed (shutdown_ctx->sched, 
-                                                           GNUNET_TIME_absolute_get_remaining(shutdown_ctx->timeout), 
-                                                           &service_shutdown_cancel, 
-                                                           shutdown_ctx);
-  msg = (struct GNUNET_MessageHeader *) buf;
-  msg->type = htons (GNUNET_MESSAGE_TYPE_SHUTDOWN);
-  msg->size = htons (sizeof (struct GNUNET_MessageHeader));
-  return sizeof (struct GNUNET_MessageHeader);
-}
-
-
-/**
- * Request that the service should shutdown.
- * Afterwards, the connection will automatically be
- * disconnected.  Hence the "sock" should not
- * be used by the caller after this call
- * (calling this function frees "sock" after a while).
- *
- * @param sched the scheduler to use for calling shutdown continuation
- * @param sock the socket connected to the service
- * @param timeout how long to wait before giving up on transmission
- * @param cont continuation to call once the service is really down
- * @param cont_cls closure for continuation
- *
- */
-void
-GNUNET_CLIENT_service_shutdown (struct GNUNET_SCHEDULER_Handle *sched,
-                                struct GNUNET_CLIENT_Connection *sock,
-                                struct GNUNET_TIME_Relative timeout,
-                                GNUNET_CLIENT_ShutdownTask cont,
-                                void *cont_cls)
-{
-  struct ShutdownContext *shutdown_ctx;
-  shutdown_ctx = GNUNET_malloc(sizeof(struct ShutdownContext));
-  shutdown_ctx->sched = sched;
-  shutdown_ctx->cont = cont;
-  shutdown_ctx->cont_cls = cont_cls;
-  shutdown_ctx->sock = sock;
-  shutdown_ctx->timeout = GNUNET_TIME_relative_to_absolute(timeout);
-  GNUNET_CONNECTION_notify_transmit_ready (sock->sock,
-                                           sizeof (struct
-                                                   GNUNET_MessageHeader),
-                                           timeout,
-                                           &write_shutdown, shutdown_ctx);
-}
-
-
 /**
  * Report service unavailable.
  */
 static void
-service_test_error (struct GNUNET_SCHEDULER_Handle *s,
-                    GNUNET_SCHEDULER_Task task, void *task_cls)
+service_test_error (GNUNET_SCHEDULER_Task task, void *task_cls)
 {
-  GNUNET_SCHEDULER_add_continuation (s,
-                                     task,
+  GNUNET_SCHEDULER_add_continuation (task,
                                      task_cls,
                                      GNUNET_SCHEDULER_REASON_TIMEOUT);
 }
@@ -775,14 +641,13 @@ confirm_handler (void *cls, const struct GNUNET_MessageHeader *msg)
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                   "Received confirmation that service is running.\n");
 #endif
-      GNUNET_SCHEDULER_add_continuation (conn->sched,
-                                         conn->test_cb,
+      GNUNET_SCHEDULER_add_continuation (conn->test_cb,
                                          conn->test_cb_cls,
                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
     }
   else
     {
-      service_test_error (conn->sched, conn->test_cb, conn->test_cb_cls);
+      service_test_error (conn->test_cb, conn->test_cb_cls);
     }
   GNUNET_CLIENT_disconnect (conn, GNUNET_NO);
 }
@@ -800,7 +665,7 @@ write_test (void *cls, size_t size, void *buf)
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                   _("Failure to transmit TEST request.\n"));
 #endif
-      service_test_error (conn->sched, conn->test_cb, conn->test_cb_cls);
+      service_test_error (conn->test_cb, conn->test_cb_cls);
       GNUNET_CLIENT_disconnect (conn, GNUNET_NO);
       return 0;                 /* client disconnected */
     }
@@ -822,7 +687,6 @@ write_test (void *cls, size_t size, void *buf)
 /**
  * Wait until the service is running.
  *
- * @param sched scheduler to use
  * @param service name of the service to wait for
  * @param cfg configuration to use
  * @param timeout how long to wait at most in ms
@@ -832,8 +696,7 @@ write_test (void *cls, size_t size, void *buf)
  * @param task_cls closure for task
  */
 void
-GNUNET_CLIENT_service_test (struct GNUNET_SCHEDULER_Handle *sched,
-                            const char *service,
+GNUNET_CLIENT_service_test (const char *service,
                             const struct GNUNET_CONFIGURATION_Handle *cfg,
                             struct GNUNET_TIME_Relative timeout,
                             GNUNET_SCHEDULER_Task task, void *task_cls)
@@ -844,14 +707,14 @@ GNUNET_CLIENT_service_test (struct GNUNET_SCHEDULER_Handle *sched,
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Testing if service `%s' is running.\n", service);
 #endif
-  conn = GNUNET_CLIENT_connect (sched, service, cfg);
+  conn = GNUNET_CLIENT_connect (service, cfg);
   if (conn == NULL)
     {
       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                   _
                   ("Could not connect to service `%s', must not be running.\n"),
                   service);
-      service_test_error (sched, task, task_cls);
+      service_test_error (task, task_cls);
       return;
     }
   conn->test_cb = task;
@@ -867,7 +730,7 @@ GNUNET_CLIENT_service_test (struct GNUNET_SCHEDULER_Handle *sched,
       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                   _("Failure to transmit request to service `%s'\n"),
                   service);
-      service_test_error (sched, task, task_cls);
+      service_test_error (task, task_cls);
       GNUNET_CLIENT_disconnect (conn, GNUNET_NO);
       return;
     }
@@ -948,11 +811,11 @@ client_notify (void *cls, size_t size, void *buf)
   if (buf == NULL)
     {
       delay = GNUNET_TIME_absolute_get_remaining (th->timeout);
-      delay.value /= 2;
-      if ( (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & GNUNET_SCHEDULER_get_reason (th->sock->sched))) ||
+      delay.rel_value /= 2;
+      if ( (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & GNUNET_SCHEDULER_get_reason ())) ||
           (GNUNET_YES != th->auto_retry) ||
           (0 == --th->attempts_left) || 
-          (delay.value < 1) )
+          (delay.rel_value < 1) )
         {
 #if DEBUG_CLIENT
           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
@@ -965,8 +828,9 @@ client_notify (void *cls, size_t size, void *buf)
         }
       /* auto-retry */
       GNUNET_CONNECTION_destroy (th->sock->sock, GNUNET_NO);
-      th->sock->sock = do_connect (th->sock->sched,
-                                   th->sock->service_name, th->sock->cfg);
+      th->sock->sock = do_connect (th->sock->service_name,
+                                  th->sock->cfg,
+                                  th->sock->attempts++);
       GNUNET_assert (NULL != th->sock->sock);
       GNUNET_CONNECTION_ignore_shutdown (th->sock->sock,
                                         th->sock->ignore_shutdown);
@@ -978,10 +842,9 @@ client_notify (void *cls, size_t size, void *buf)
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                   "Transmission failed %u times, trying again in %llums.\n",
                   MAX_ATTEMPTS - th->attempts_left,
-                  (unsigned long long) delay.value);
+                  (unsigned long long) delay.rel_value);
 #endif
-      th->reconnect_task = GNUNET_SCHEDULER_add_delayed (th->sock->sched,
-                                                         delay,
+      th->reconnect_task = GNUNET_SCHEDULER_add_delayed (delay,
                                                          &client_delayed_retry,
                                                          th);
       th->sock->th = th;
@@ -1060,12 +923,12 @@ GNUNET_CLIENT_notify_transmit_ready_cancel (struct
   if (th->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
     {
       GNUNET_break (NULL == th->th);
-      GNUNET_SCHEDULER_cancel (th->sock->sched, th->reconnect_task);
+      GNUNET_SCHEDULER_cancel (th->reconnect_task);
       th->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
     }
   else
     {
-      GNUNET_break (NULL != th->th);
+      GNUNET_assert (NULL != th->th);
       GNUNET_CONNECTION_notify_transmit_ready_cancel (th->th);
     }
   th->sock->th = NULL;