use c99
[oweals/gnunet.git] / src / arm / arm_api.c
index 7e6ce1870cc17c0768bf14effa294ff51df850e9..5fb2a811a9cefde27bbb4f361b7d2c4a0bd2e933 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009, 2010, 2012, 2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009, 2010, 2012, 2013 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.
 */
 
 /**
@@ -91,7 +91,7 @@ struct GNUNET_ARM_Handle
   /**
    * ID of the reconnect task (if any).
    */
-  GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
+  struct GNUNET_SCHEDULER_Task *reconnect_task;
 
   /**
    * Current delay we use for re-trying to connect to core.
@@ -109,7 +109,7 @@ struct GNUNET_ARM_Handle
   unsigned char currently_down;
 
   /**
-   * GNUNET_YES if we're running a service test.
+   * #GNUNET_YES if we're running a service test.
    */
   unsigned char service_test_is_active;
 };
@@ -154,7 +154,7 @@ struct ARMControlMessage
   GNUNET_ARM_ServiceListCallback list_cont;
 
   /**
-   * Closure for 'result_cont' or 'list_cont'.
+   * Closure for @e result_cont' or @e list_cont'.
    */
   void *cont_cls;
 
@@ -166,7 +166,7 @@ struct ARMControlMessage
   /**
    * Task to run when request times out.
    */
-  GNUNET_SCHEDULER_TaskIdentifier timeout_task_id;
+  struct GNUNET_SCHEDULER_Task * timeout_task_id;
 
   /**
    * Flags for passing std descriptors to ARM (when starting ARM).
@@ -184,7 +184,7 @@ struct ARMControlMessage
  * Connect to arm.
  *
  * @param h arm handle
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
  */
 static int
 reconnect_arm (struct GNUNET_ARM_Handle *h);
@@ -205,14 +205,13 @@ trigger_next_request (struct GNUNET_ARM_Handle *h, int ignore_currently_down);
  * Task scheduled to try to re-connect to arm.
  *
  * @param cls the 'struct GNUNET_ARM_Handle'
- * @param tc task context
  */
 static void
-reconnect_arm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+reconnect_arm_task (void *cls)
 {
   struct GNUNET_ARM_Handle *h = cls;
 
-  h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+  h->reconnect_task = NULL;
   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to ARM service after delay\n");
   reconnect_arm (h);
 }
@@ -240,9 +239,11 @@ reconnect_arm_later (struct GNUNET_ARM_Handle *h)
     h->client = NULL;
   }
   h->currently_down = GNUNET_YES;
-  GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task);
+  GNUNET_assert (NULL == h->reconnect_task);
   h->reconnect_task =
-      GNUNET_SCHEDULER_add_delayed (h->retry_backoff, &reconnect_arm_task, h);
+      GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
+                                   &reconnect_arm_task,
+                                   h);
   /* Don't clear pending messages on disconnection, deliver them later
   clear_pending_messages (h, GNUNET_ARM_REQUEST_DISCONNECTED);
   GNUNET_assert (NULL == h->control_pending_head);
@@ -308,11 +309,12 @@ arm_termination_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 /**
  * Handler for ARM replies.
  *
- * @param cls our "struct GNUNET_ARM_Handle"
+ * @param cls our `struct GNUNET_ARM_Handle`
  * @param msg the message received from the arm service
  */
 static void
-client_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
+client_notify_handler (void *cls,
+                       const struct GNUNET_MessageHeader *msg)
 {
   struct GNUNET_ARM_Handle *h = cls;
   const struct GNUNET_ARM_Message *arm_msg;
@@ -353,7 +355,9 @@ client_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
   cm = find_cm_by_id (h, id);
   if (NULL == cm)
   {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "Message with unknown id %llu\n", id);
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Message with unknown id %llu\n",
+         id);
     return;
   }
   fail = GNUNET_NO;
@@ -405,7 +409,7 @@ client_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
     fail = GNUNET_YES;
     break;
   }
-  GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != cm->timeout_task_id);
+  GNUNET_assert (NULL != cm->timeout_task_id);
   GNUNET_SCHEDULER_cancel (cm->timeout_task_id);
   GNUNET_CONTAINER_DLL_remove (h->control_sent_head,
                                h->control_sent_tail, cm);
@@ -460,7 +464,7 @@ client_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
     if (NULL != cm->list_cont)
         cm->list_cont (cm->cont_cls, GNUNET_ARM_REQUEST_SENT_OK, rcount,
                        list);
-    GNUNET_free (list);
+    GNUNET_free_non_null (list);
     break;
   }
   GNUNET_free (cm->msg);
@@ -471,10 +475,10 @@ client_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 /**
  * Transmit the next message to the arm service.
  *
- * @param cls closure with the 'struct GNUNET_ARM_Handle'
- * @param size number of bytes available in buf
+ * @param cls closure with the `struct GNUNET_ARM_Handle`
+ * @param size number of bytes available in @a buf
  * @param buf where the callee should write the message
- * @return number of bytes written to buf
+ * @return number of bytes written to @a buf
  */
 static size_t
 transmit_arm_message (void *cls, size_t size, void *buf)
@@ -488,9 +492,9 @@ transmit_arm_message (void *cls, size_t size, void *buf)
 
   notify_connection = GNUNET_NO;
   LOG (GNUNET_ERROR_TYPE_DEBUG,
-      "transmit_arm_message is running with %p buffer of size %lu. ARM is known to be %s\n",
-      buf, size, h->currently_down ? "unconnected" : "connected");
-  GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task);
+       "transmit_arm_message is running with %p buffer of size %lu. ARM is known to be %s\n",
+       buf, size, h->currently_down ? "unconnected" : "connected");
+  GNUNET_assert (NULL == h->reconnect_task);
   h->cth = NULL;
   if ((GNUNET_YES == h->currently_down) && (NULL != buf))
   {
@@ -509,7 +513,8 @@ transmit_arm_message (void *cls, size_t size, void *buf)
   }
   if (NULL == (cm = h->control_pending_head))
   {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "Queue is empty, not sending anything\n");
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Queue is empty, not sending anything\n");
     msize = 0;
     goto end;
   }
@@ -632,14 +637,15 @@ reconnect_arm (struct GNUNET_ARM_Handle *h)
  */
 struct GNUNET_ARM_Handle *
 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                    GNUNET_ARM_ConnectionStatusCallback conn_status, void *cls)
+                    GNUNET_ARM_ConnectionStatusCallback conn_status,
+                   void *cls)
 {
   struct GNUNET_ARM_Handle *h;
 
-  h = GNUNET_malloc (sizeof (struct GNUNET_ARM_Handle));
+  h = GNUNET_new (struct GNUNET_ARM_Handle);
   h->cfg = GNUNET_CONFIGURATION_dup (cfg);
   h->currently_down = GNUNET_YES;
-  h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+  h->reconnect_task = NULL;
   h->conn_status = conn_status;
   h->conn_status_cls = cls;
   if (GNUNET_OK != reconnect_arm (h))
@@ -676,7 +682,7 @@ GNUNET_ARM_disconnect_and_free (struct GNUNET_ARM_Handle *h)
     else
       GNUNET_CONTAINER_DLL_remove (h->control_sent_head,
                                    h->control_sent_tail, cm);
-    GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != cm->timeout_task_id);
+    GNUNET_assert (NULL != cm->timeout_task_id);
     GNUNET_SCHEDULER_cancel (cm->timeout_task_id);
     if (NULL != cm->result_cont)
       cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_DISCONNECTED,
@@ -690,10 +696,10 @@ GNUNET_ARM_disconnect_and_free (struct GNUNET_ARM_Handle *h)
     GNUNET_CLIENT_disconnect (h->client);
     h->client = NULL;
   }
-  if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
+  if (NULL != h->reconnect_task)
   {
     GNUNET_SCHEDULER_cancel (h->reconnect_task);
-    h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+    h->reconnect_task = NULL;
   }
   if (GNUNET_NO == h->service_test_is_active)
   {
@@ -707,10 +713,9 @@ GNUNET_ARM_disconnect_and_free (struct GNUNET_ARM_Handle *h)
  * Message timed out. Remove it from the queue.
  *
  * @param cls the message (struct ARMControlMessage *)
- * @param tc task context
  */
 static void
-control_message_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+control_message_timeout (void *cls)
 {
   struct ARMControlMessage *cm = cls;
   struct GNUNET_ARM_Message *arm_msg;
@@ -744,7 +749,7 @@ control_message_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *t
  * it is not, start the ARM process.
  *
  * @param cls the context for the request that we will report on (struct ARMControlMessage *)
- * @param result GNUNET_YES if ARM is running
+ * @param result #GNUNET_YES if ARM is running
  */
 static void
 arm_service_report (void *cls,
@@ -798,10 +803,15 @@ arm_service_report (void *cls,
   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
       cm->h->cfg, "arm", "OPTIONS", &lopostfix))
     lopostfix = GNUNET_strdup ("");
-  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
-      cm->h->cfg, "arm", "BINARY", &cbinary))
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_string (cm->h->cfg,
+                                             "arm",
+                                             "BINARY",
+                                             &cbinary))
   {
-    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING, "arm", "BINARY");
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
+                               "arm",
+                               "BINARY");
     if (cm->result_cont)
       cm->result_cont (cm->cont_cls,
                       GNUNET_ARM_REQUEST_SENT_OK, "arm",
@@ -811,20 +821,28 @@ arm_service_report (void *cls,
     GNUNET_free (lopostfix);
     return;
   }
-  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (
-      cm->h->cfg, "arm", "CONFIG", &config))
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_filename (cm->h->cfg,
+                                               "arm", "CONFIG",
+                                               &config))
     config = NULL;
   binary = GNUNET_OS_get_libexec_binary_path (cbinary);
   GNUNET_asprintf (&quotedbinary,
                   "\"%s\"",
                   binary);
   GNUNET_free (cbinary);
-  if ((GNUNET_YES == GNUNET_CONFIGURATION_have_value (
-          cm->h->cfg, "TESTING", "WEAKRANDOM")) &&
-      (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno (
-          cm->h->cfg, "TESTING", "WEAKRANDOM")) &&
-      (GNUNET_NO == GNUNET_CONFIGURATION_have_value (
-          cm->h->cfg, "TESTING", "HOSTFILE")))
+  if ( (GNUNET_YES ==
+        GNUNET_CONFIGURATION_have_value (cm->h->cfg,
+                                         "TESTING",
+                                         "WEAKRANDOM")) &&
+       (GNUNET_YES ==
+        GNUNET_CONFIGURATION_get_value_yesno (cm->h->cfg,
+                                              "TESTING",
+                                              "WEAKRANDOM")) &&
+       (GNUNET_NO ==
+        GNUNET_CONFIGURATION_have_value (cm->h->cfg,
+                                         "TESTING",
+                                         "HOSTFILE")))
   {
     /* Means we are ONLY running locally */
     /* we're clearly running a test, don't daemonize */
@@ -835,7 +853,7 @@ arm_service_report (void *cls,
                                         lopostfix, NULL);
     else
       proc = GNUNET_OS_start_process_s (GNUNET_NO, cm->std_inheritance,
-                              NULL, loprefix, quotedbinary, "-c", config,
+                                        NULL, loprefix, quotedbinary, "-c", config,
                                         /* no daemonization! */
                                         lopostfix, NULL);
   }
@@ -859,14 +877,16 @@ arm_service_report (void *cls,
   if (NULL == proc)
   {
     if (cm->result_cont)
-      cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_SENT_OK, "arm",
-          GNUNET_ARM_RESULT_START_FAILED);
+      cm->result_cont (cm->cont_cls,
+                       GNUNET_ARM_REQUEST_SENT_OK, "arm",
+                       GNUNET_ARM_RESULT_START_FAILED);
     GNUNET_free (cm);
     return;
   }
   if (cm->result_cont)
-    cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_SENT_OK, "arm",
-        GNUNET_ARM_RESULT_STARTING);
+    cm->result_cont (cm->cont_cls,
+                     GNUNET_ARM_REQUEST_SENT_OK, "arm",
+                     GNUNET_ARM_RESULT_STARTING);
   GNUNET_OS_process_destroy (proc);
   h = cm->h;
   GNUNET_free (cm);
@@ -925,7 +945,8 @@ change_service (struct GNUNET_ARM_Handle *h, const char *service_name,
                                     h->control_pending_tail, cm);
   cm->timeout_task_id =
       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
-                                    (cm->timeout), &control_message_timeout, cm);
+                                    (cm->timeout),
+                                   &control_message_timeout, cm);
   trigger_next_request (h, GNUNET_NO);
 }
 
@@ -964,9 +985,13 @@ GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
      */
     if (GNUNET_NO == h->currently_down)
     {
-      LOG (GNUNET_ERROR_TYPE_DEBUG, "ARM is already running\n");
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "ARM is already running\n");
       if (NULL != cont)
-        cont (cont_cls, GNUNET_ARM_REQUEST_SENT_OK, "arm", GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
+        cont (cont_cls,
+              GNUNET_ARM_REQUEST_SENT_OK,
+              "arm",
+              GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
     }
     else if (GNUNET_NO == h->service_test_is_active)
     {
@@ -980,10 +1005,10 @@ GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
         GNUNET_CLIENT_disconnect (h->client);
         h->client = NULL;
       }
-      if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
+      if (NULL != h->reconnect_task)
       {
         GNUNET_SCHEDULER_cancel (h->reconnect_task);
-        h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+        h->reconnect_task = NULL;
       }
 
       LOG (GNUNET_ERROR_TYPE_DEBUG,
@@ -998,7 +1023,10 @@ GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
       cm->std_inheritance = std_inheritance;
       memcpy (&cm[1], service_name, slen);
       h->service_test_is_active = GNUNET_YES;
-      GNUNET_CLIENT_service_test ("arm", h->cfg, timeout, &arm_service_report,
+      GNUNET_CLIENT_service_test ("arm",
+                                  h->cfg,
+                                  timeout,
+                                  &arm_service_report,
                                  cm);
     }
     else
@@ -1006,7 +1034,8 @@ GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
       /* Service test is already running - tell user to chill out and try
        * again later.
        */
-      LOG (GNUNET_ERROR_TYPE_DEBUG, "Service test is already in progress, we're busy\n");
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "Service test is already in progress, we're busy\n");
       if (NULL != cont)
         cont (cont_cls, GNUNET_ARM_REQUEST_BUSY, NULL, 0);
     }
@@ -1022,7 +1051,7 @@ GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
  * Stopping arm itself will not invalidate its handle, and
  * ARM API will try to restore connection to the ARM service,
  * even if ARM connection was lost because you asked for ARM to be stopped.
- * Call GNUNET_ARM_disconnect_and_free () to free the handle and prevent
+ * Call #GNUNET_ARM_disconnect_and_free() to free the handle and prevent
  * further connection attempts.
  *
  * @param h handle to ARM
@@ -1067,7 +1096,7 @@ GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Requesting LIST from ARM service with timeout: %s\n",
        GNUNET_STRINGS_relative_time_to_string (timeout, GNUNET_YES));
-  cm = GNUNET_malloc (sizeof (struct ARMControlMessage));
+  cm = GNUNET_new (struct ARMControlMessage);
   cm->h = h;
   cm->list_cont = cont;
   cm->cont_cls = cont_cls;
@@ -1081,7 +1110,8 @@ GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
                                     h->control_pending_tail, cm);
   cm->timeout_task_id =
       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
-                                    (cm->timeout), &control_message_timeout, cm);
+                                    (cm->timeout),
+                                   &control_message_timeout, cm);
   trigger_next_request (h, GNUNET_NO);
 }