Forget to commit some files
[oweals/gnunet.git] / src / testbed / test_testbed_api_operations.c
index 45f2db1033da8f398f69498e007f47edebc33f99..73f3b7c3625b2c7f52d7f4a295d82d8cec71925d 100644 (file)
@@ -1,6 +1,6 @@
 /*
       This file is part of GNUnet
-      (C) 2008--2012 Christian Grothoff (and other contributing authors)
+      Copyright (C) 2008--2013 Christian Grothoff (and other contributing authors)
 
       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.
  */
 
 /**
   GNUNET_log (kind, __VA_ARGS__)
 
 /**
- * Queue A
+ * Delay to start step task
+ */
+#define STEP_DELAY                                                      \
+  GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
+
+/**
+ * Queue A. Initially the max active is set to 2 and then reduced to 0 - this
+ * should block op2 even after op1 has finished. Later the max active is set to
+ * 2 and this should start op2
  */
 struct OperationQueue *q1;
 
 /**
- * Queue B
+ * Queue B. Max active set to 2 is not changed throughout the test
  */
 struct OperationQueue *q2;
 
@@ -54,6 +62,61 @@ struct GNUNET_TESTBED_Operation *op1;
  */
 struct GNUNET_TESTBED_Operation *op2;
 
+/**
+ * This operation should go into both queues and should consume 2 units of
+ * resources on both queues. Since op2 needs a resource from both queues and is
+ * queues before this operation, it will be blocked until op2 is released even
+ * though q1 has enough free resources
+ */
+struct GNUNET_TESTBED_Operation *op3;
+
+/**
+ * Just like op3, this operation also consumes 2 units of resources on both
+ * queues. Since this is queued after op3 and both queues are at max active
+ * 2. This will be blocked until op3 is done.
+ */
+struct GNUNET_TESTBED_Operation *op4;
+
+/**
+ * This operation is started after op4 is released and should consume only 1
+ * resource on queue q1. It should be started along with op6 and op7
+ */
+struct GNUNET_TESTBED_Operation *op5;
+
+/**
+ * This operation is started after op4 is released and should consume only 1
+ * resource on q2. It should be started along with op5 and op7
+ */
+struct GNUNET_TESTBED_Operation *op6;
+
+/**
+ * This operation is started after op4 is released and should consume 1 resource
+ * on both queues q1 and q1. It should be started along with op5 and op6.  It is
+ * then inactivated when op6 is released.  op8's start should release this
+ * operation implicitly.
+ */
+struct GNUNET_TESTBED_Operation *op7;
+
+/**
+ * This operation is started after op6 is finished in step task.  It consumes 2
+ * resources on both queues q1 and q2.  This operation should evict op7.  After
+ * starting, it should be made inactive, active and inactive again in the step task.
+ */
+struct GNUNET_TESTBED_Operation *op8;
+
+/**
+ * This opration is started after activating op8.  It should consume a resource
+ * on queues q1 and q2.  It should not be started until op8 is again made
+ * inactive at which point it should be released.  It can be released as soon as
+ * it begins.
+ */
+struct GNUNET_TESTBED_Operation *op9;
+
+/**
+ * The delay task identifier
+ */
+struct GNUNET_SCHEDULER_Task * step_task;
+
 
 /**
  * Enumeration of test stages
@@ -75,6 +138,12 @@ enum Test
      */
   TEST_OP1_RELEASED,
 
+  /**
+   * Temporary pause where no operations should start as we set max active in q1
+   * to 0 in stage TEST_OP1_STARTED
+   */
+  TEST_PAUSE,
+
     /**
      * op2 has started
      */
@@ -83,7 +152,82 @@ enum Test
     /**
      * op2 released
      */
-  TEST_OP2_RELEASED
+  TEST_OP2_RELEASED,
+
+  /**
+   * op3 has started
+   */
+  TEST_OP3_STARTED,
+
+  /**
+   * op3 has finished
+   */
+  TEST_OP3_RELEASED,
+
+  /**
+   * op4 has started
+   */
+  TEST_OP4_STARTED,
+
+  /**
+   * op4 has released
+   */
+  TEST_OP4_RELEASED,
+
+  /**
+   * op5, op6, op7 started
+   */
+  TEST_OP5_6_7_STARTED,
+
+  /**
+   * op5 has released
+   */
+  TEST_OP5_RELEASED,
+
+  /**
+   * op6 has released
+   */
+  TEST_OP6_RELEASED,
+
+  /**
+   * op8 has began waiting
+   */
+  TEST_OP8_WAITING,
+
+  /**
+   * op7 has released
+   */
+  TEST_OP7_RELEASED,
+
+  /**
+   * op8 has started
+   */
+  TEST_OP8_STARTED,
+
+  /**
+   * op8 is inactive
+   */
+  TEST_OP8_INACTIVE_1,
+
+  /**
+   * op8 is active
+   */
+  TEST_OP8_ACTIVE,
+
+  /**
+   * op8 has been released
+   */
+  TEST_OP8_RELEASED,
+
+  /**
+   * op9 has started
+   */
+  TEST_OP9_STARTED,
+
+  /**
+   * op9 has been released
+   */
+  TEST_OP9_RELEASED
 };
 
 /**
@@ -92,6 +236,28 @@ enum Test
 enum Test result;
 
 
+/**
+ * Function to call to start an operation once all
+ * queues the operation is part of declare that the
+ * operation can be activated.
+ */
+static void
+start_cb (void *cls);
+
+
+/**
+ * Function to cancel an operation (release all associated resources).  This can
+ * be because of a call to "GNUNET_TESTBED_operation_cancel" (before the
+ * operation generated an event) or AFTER the operation generated an event due
+ * to a call to "GNUNET_TESTBED_operation_done".  Thus it is not guaranteed that
+ * a callback to the 'OperationStart' preceeds the call to 'OperationRelease'.
+ * Implementations of this function are expected to clean up whatever state is
+ * in 'cls' and release all resources associated with the operation.
+ */
+static void
+release_cb (void *cls);
+
+
 /**
  * Task to simulate artificial delay and change the test stage
  *
@@ -101,14 +267,64 @@ enum Test result;
 static void
 step (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
+  GNUNET_assert (NULL != step_task);
+  step_task = NULL;
   switch (result)
   {
   case TEST_OP1_STARTED:
     GNUNET_TESTBED_operation_release_ (op1);
+    GNUNET_TESTBED_operation_queue_reset_max_active_ (q1, 0);
+    op3 = GNUNET_TESTBED_operation_create_ (&op3, &start_cb, &release_cb);
+    GNUNET_TESTBED_operation_queue_insert2_ (q1, op3, 2);
+    GNUNET_TESTBED_operation_queue_insert2_ (q2, op3, 2);
+    GNUNET_TESTBED_operation_begin_wait_ (op3);
+    op4 = GNUNET_TESTBED_operation_create_ (&op4, &start_cb, &release_cb);
+    GNUNET_TESTBED_operation_queue_insert2_ (q1, op4, 2);
+    GNUNET_TESTBED_operation_queue_insert2_ (q2, op4, 2);
+    GNUNET_TESTBED_operation_begin_wait_ (op4);
+    break;
+  case TEST_OP1_RELEASED:
+    result = TEST_PAUSE;
+    GNUNET_TESTBED_operation_queue_reset_max_active_ (q1, 2);
     break;
   case TEST_OP2_STARTED:
     GNUNET_TESTBED_operation_release_ (op2);
     break;
+  case TEST_OP3_STARTED:
+    GNUNET_TESTBED_operation_release_ (op3);
+    break;
+  case TEST_OP4_STARTED:
+    GNUNET_TESTBED_operation_release_ (op4);
+    break;
+  case TEST_OP6_RELEASED:
+    op8 = GNUNET_TESTBED_operation_create_ (&op8, &start_cb, &release_cb);
+    GNUNET_TESTBED_operation_queue_insert2_ (q1, op8, 2);
+    GNUNET_TESTBED_operation_queue_insert2_ (q2, op8, 2);
+    result = TEST_OP8_WAITING;
+    GNUNET_TESTBED_operation_begin_wait_ (op8);
+    break;
+  case TEST_OP8_STARTED:
+    GNUNET_TESTBED_operation_inactivate_ (op8);
+    result = TEST_OP8_INACTIVE_1;
+    step_task = GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
+    break;
+  case TEST_OP8_INACTIVE_1:
+    GNUNET_TESTBED_operation_activate_ (op8);
+    result = TEST_OP8_ACTIVE;
+    op9 = GNUNET_TESTBED_operation_create_ (&op9, &start_cb, &release_cb);
+    GNUNET_TESTBED_operation_queue_insert2_ (q1, op9, 1);
+    GNUNET_TESTBED_operation_queue_insert2_ (q2, op9, 1);
+    GNUNET_TESTBED_operation_begin_wait_ (op9);
+    step_task = GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
+    break;
+  case TEST_OP8_ACTIVE:
+    GNUNET_TESTBED_operation_inactivate_ (op8);
+    /* op8 should be released by now due to above call */
+    GNUNET_assert (TEST_OP8_RELEASED == result);
+    break;
+  case TEST_OP9_STARTED:
+    GNUNET_TESTBED_operation_release_ (op9);
+    break;
   default:
     GNUNET_assert (0);
   }
@@ -128,12 +344,53 @@ start_cb (void *cls)
   case TEST_INIT:
     GNUNET_assert (&op1 == cls);
     result = TEST_OP1_STARTED;
-    GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &step, NULL);
+    GNUNET_assert (NULL == step_task);
+    step_task =
+        GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
     break;
-  case TEST_OP1_RELEASED:
+  case TEST_PAUSE:
     GNUNET_assert (&op2 == cls);
     result = TEST_OP2_STARTED;
-    GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &step, NULL);
+    GNUNET_assert (NULL == step_task);
+    step_task =
+        GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
+    break;
+  case TEST_OP2_RELEASED:
+    GNUNET_assert (&op3 == cls);
+    result = TEST_OP3_STARTED;
+    GNUNET_assert (NULL == step_task);
+    step_task =
+        GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
+    break;
+  case TEST_OP3_RELEASED:
+    GNUNET_assert (&op4 == cls);
+    result = TEST_OP4_STARTED;
+    GNUNET_assert (NULL == step_task);
+    step_task =
+        GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
+    break;
+  case TEST_OP4_RELEASED:
+  {
+    static int nops;
+
+    nops++;
+    if (nops == 3)
+    {
+      result = TEST_OP5_6_7_STARTED;
+      GNUNET_TESTBED_operation_release_ (op5);
+      op5 = NULL;
+    }
+  }
+    break;
+  case TEST_OP7_RELEASED:
+    GNUNET_assert (&op8 == cls);
+    result = TEST_OP8_STARTED;
+    step_task = GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
+    break;
+  case TEST_OP8_RELEASED:
+    GNUNET_assert (&op9 == cls);
+    result = TEST_OP9_STARTED;
+    step_task = GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
     break;
   default:
     GNUNET_assert (0);
@@ -142,15 +399,13 @@ start_cb (void *cls)
 
 
 /**
- * Function to call to cancel an operation (release all associated
- * resources).  This can be because of a call to
- * "GNUNET_TESTBED_operation_cancel" (before the operation generated
- * an event) or AFTER the operation generated an event due to a call
- * to "GNUNET_TESTBED_operation_done".  Thus it is not guaranteed that
- * a callback to the 'OperationStart' preceeds the call to
- * 'OperationRelease'.  Implementations of this function are expected
- * to clean up whatever state is in 'cls' and release all resources
- * associated with the operation.
+ * Function to cancel an operation (release all associated resources).  This can
+ * be because of a call to "GNUNET_TESTBED_operation_cancel" (before the
+ * operation generated an event) or AFTER the operation generated an event due
+ * to a call to "GNUNET_TESTBED_operation_done".  Thus it is not guaranteed that
+ * a callback to the 'OperationStart' preceeds the call to 'OperationRelease'.
+ * Implementations of this function are expected to clean up whatever state is
+ * in 'cls' and release all resources associated with the operation.
  */
 static void
 release_cb (void *cls)
@@ -160,12 +415,62 @@ release_cb (void *cls)
   case TEST_OP1_STARTED:
     GNUNET_assert (&op1 == cls);
     result = TEST_OP1_RELEASED;
+    op1 = NULL;
+    step_task =
+        GNUNET_SCHEDULER_add_delayed (STEP_DELAY, &step, NULL);
     break;
   case TEST_OP2_STARTED:
     GNUNET_assert (&op2 == cls);
     result = TEST_OP2_RELEASED;
+    GNUNET_assert (NULL == step_task);
+    break;
+  case TEST_OP3_STARTED:
+    GNUNET_assert (&op3 == cls);
+    result = TEST_OP3_RELEASED;
+    GNUNET_assert (NULL == step_task);
+    break;
+  case TEST_OP4_STARTED:
+    GNUNET_assert (&op4 == cls);
+    result = TEST_OP4_RELEASED;
+    GNUNET_assert (NULL == step_task);
+    op5 = GNUNET_TESTBED_operation_create_ (&op5, &start_cb, &release_cb);
+    GNUNET_TESTBED_operation_queue_insert2_ (q1, op5, 1);
+    GNUNET_TESTBED_operation_begin_wait_ (op5);
+    op6 = GNUNET_TESTBED_operation_create_ (&op6, &start_cb, &release_cb);
+    GNUNET_TESTBED_operation_queue_insert2_ (q2, op6, 1);
+    GNUNET_TESTBED_operation_begin_wait_ (op6);
+    op7 = GNUNET_TESTBED_operation_create_ (&op7, &start_cb, &release_cb);
+    GNUNET_TESTBED_operation_queue_insert2_ (q1, op7, 1);
+    GNUNET_TESTBED_operation_queue_insert2_ (q2, op7, 1);
+    GNUNET_TESTBED_operation_begin_wait_ (op7);
+    break;
+  case TEST_OP5_6_7_STARTED:
+    result = TEST_OP5_RELEASED;
+    op5 = NULL;
+    GNUNET_TESTBED_operation_release_ (op6);
+    break;
+  case TEST_OP5_RELEASED:
+    op6 = NULL;
+    result = TEST_OP6_RELEASED;
+    GNUNET_TESTBED_operation_inactivate_ (op7);
+    step_task = GNUNET_SCHEDULER_add_now (&step, NULL);
+    break;
+  case TEST_OP8_WAITING:
+    GNUNET_assert (&op7 == cls);
+    op7 = NULL;
+    result = TEST_OP7_RELEASED;
+    break;
+  case TEST_OP8_ACTIVE:
+    result = TEST_OP8_RELEASED;
+    op8 = NULL;
+    break;
+  case TEST_OP9_STARTED:
+    GNUNET_assert (&op9 == cls);
+    result = TEST_OP9_RELEASED;
     GNUNET_TESTBED_operation_queue_destroy_ (q1);
     GNUNET_TESTBED_operation_queue_destroy_ (q2);
+    q1 = NULL;
+    q2 = NULL;
     break;
   default:
     GNUNET_assert (0);
@@ -185,9 +490,9 @@ static void
 run (void *cls, char *const *args, const char *cfgfile,
      const struct GNUNET_CONFIGURATION_Handle *config)
 {
-  q1 = GNUNET_TESTBED_operation_queue_create_ (1);
+  q1 = GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED, 1);
   GNUNET_assert (NULL != q1);
-  q2 = GNUNET_TESTBED_operation_queue_create_ (2);
+  q2 = GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED, 2);
   GNUNET_assert (NULL != q2);
   op1 = GNUNET_TESTBED_operation_create_ (&op1, start_cb, release_cb);
   GNUNET_assert (NULL != op1);
@@ -201,6 +506,7 @@ run (void *cls, char *const *args, const char *cfgfile,
   result = TEST_INIT;
 }
 
+
 /**
  * Main function
  */
@@ -217,10 +523,17 @@ main (int argc, char **argv)
       GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
                           "test_testbed_api_operations", "nohelp", options,
                           &run, NULL);
-  if ((GNUNET_OK != ret) || (TEST_OP2_RELEASED != result))
+  if ((GNUNET_OK != ret) || (TEST_OP9_RELEASED != result))
     return 1;
   op1 = NULL;
   op2 = NULL;
+  op3 = NULL;
+  op4 = NULL;
+  op5 = NULL;
+  op6 = NULL;
+  op7 = NULL;
+  op8 = NULL;
+  op9 = NULL;
   q1 = NULL;
   q2 = NULL;
   return 0;