src/testbed/testbed_api_operations.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2012 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file testbed/testbed_api_operations.c
  23  * @brief functions to manage operation queues
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "testbed_api_operations.h"
  28
  29
  30 /**
  31  * An entry in the operation queue
  32  */
  33 struct QueueEntry
  34 {
  35   /**
  36    * The next DLL pointer
  37    */
  38   struct QueueEntry *next;
  39
  40   /**
  41    * The prev DLL pointer
  42    */
  43   struct QueueEntry *prev;
  44
  45   /**
  46    * The operation this entry holds
  47    */
  48   struct GNUNET_TESTBED_Operation *op;
  49 };
  50
  51
  52 /**
  53  * Queue of operations where we can only support a certain
  54  * number of concurrent operations of a particular type.
  55  */
  56 struct OperationQueue
  57 {
  58  /**
  59    * The head of the operation queue
  60    */
  61   struct QueueEntry *head;
  62
  63   /**
  64    * The tail of the operation queue
  65    */
  66   struct QueueEntry *tail;
  67
  68   /**
  69    * Number of operations that can be concurrently
  70    * active in this queue.
  71    */
  72   unsigned int active;
  73 };
  74
  75
  76 enum OperationState
  77   {
  78     /**
  79      * The operation is currently waiting for resources
  80      */
  81     OP_STATE_WAITING,
  82
  83     /**
  84      * The operation has started
  85      */
  86     OP_STATE_STARTED,
  87   };
  88
  89
  90
  91
  92 /**
  93  * Opaque handle to an abstract operation to be executed by the testing framework.
  94  */
  95 struct GNUNET_TESTBED_Operation
  96 {
  97   /**
  98    * Function to call when we have the resources to begin the operation.
  99    */
 100   OperationStart start;
 101
 102   /**
 103    * Function to call to clean up after the operation (which may or may
 104    * not have been started yet).
 105    */
 106   OperationRelease release;
 107
 108   /**
 109    * Closure for callbacks.
 110    */
 111   void *cb_cls;
 112
 113   /**
 114    * Array of operation queues this Operation belongs to.
 115    */
 116   struct OperationQueue **queues;
 117
 118   /**
 119    * The Operation ID
 120    */
 121   uint64_t id;
 122
 123   /**
 124    * The id of the task which calls OperationStart for this operation
 125    */
 126   GNUNET_SCHEDULER_TaskIdentifier start_task_id;
 127
 128   /**
 129    * Number of queues in the operation queues array
 130    */
 131   unsigned int nqueues;
 132
 133   /**
 134    * The state of the operation
 135    */
 136   enum OperationState state;
 137
 138   /**
 139    * The type of the operation
 140    */
 141   enum OperationType type;
 142
 143 };
 144
 145
 146 /**
 147  * Task for calling OperationStart on operation
 148  *
 149  * @param cls the Operation
 150  * @param tc the TaskContext from scheduler
 151  */
 152 static void
 153 call_start (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 154 {
 155   struct GNUNET_TESTBED_Operation *op = cls;
 156
 157   op->start_task_id = GNUNET_SCHEDULER_NO_TASK;
 158   op->state = OP_STATE_STARTED;
 159   if (NULL != op->start)
 160   {
 161     op->start (op->cb_cls);
 162   }
 163 }
 164
 165
 166 /**
 167  * Checks for the readiness of an operation and schedules a operation start task
 168  *
 169  * @param op the operation
 170  */
 171 static void
 172 check_readiness (struct GNUNET_TESTBED_Operation *op)
 173 {
 174   unsigned int i;
 175
 176   for (i = 0; i < op->nqueues; i++)
 177   {
 178     if (0 == op->queues[i]->active)
 179       return;
 180   }
 181   for (i = 0; i < op->nqueues; i++)
 182   {
 183     op->queues[i]->active--;
 184   }
 185   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == op->start_task_id);
 186   op->start_task_id = GNUNET_SCHEDULER_add_now (&call_start, op);
 187 }
 188
 189
 190 /**
 191  * Create an 'operation' to be performed.
 192  *
 193  * @param cls closure for the callbacks
 194  * @param start function to call to start the operation
 195  * @param release function to call to close down the operation
 196  * @param type the type of the operation
 197  * @return handle to the operation
 198  */
 199 struct GNUNET_TESTBED_Operation *
 200 GNUNET_TESTBED_operation_create_ (void *cls,
 201                                   OperationStart start,
 202                                   OperationRelease release,
 203                                   enum OperationType type)
 204 {
 205   struct GNUNET_TESTBED_Operation *op;
 206
 207   op = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Operation));
 208   op->start = start;
 209   op->release = release;
 210   op->cb_cls = cls;
 211   op->type = type;
 212   return op;
 213 }
 214
 215
 216 /**
 217  * Create an operation queue.
 218  *
 219  * @param max_active maximum number of operations in this
 220  *        queue that can be active in parallel at the same time
 221  * @return handle to the queue
 222  */
 223 struct OperationQueue *
 224 GNUNET_TESTBED_operation_queue_create_ (unsigned int max_active)
 225 {
 226   struct OperationQueue *queue;
 227
 228   queue = GNUNET_malloc (sizeof (struct OperationQueue));
 229   queue->active = max_active;
 230   return queue;
 231 }
 232
 233
 234 /**
 235  * Destroy an operation queue.  The queue MUST be empty
 236  * at this time.
 237  *
 238  * @param queue queue to destroy
 239  */
 240 void
 241 GNUNET_TESTBED_operation_queue_destroy_ (struct OperationQueue *queue)
 242 {
 243   GNUNET_assert (NULL == queue->head);
 244   GNUNET_assert (NULL == queue->tail);
 245   GNUNET_free (queue);
 246 }
 247
 248
 249 /**
 250  * Add an operation to a queue.  An operation can be in multiple
 251  * queues at once.  Once all queues permit the operation to become
 252  * active, the operation will be activated.  The actual activation
 253  * will occur in a separate task (thus allowing multiple queue
 254  * insertions to be made without having the first one instantly
 255  * trigger the operation if the first queue has sufficient
 256  * resources).
 257  *
 258  * @param queue queue to add the operation to
 259  * @param operation operation to add to the queue
 260  */
 261 void
 262 GNUNET_TESTBED_operation_queue_insert_ (struct OperationQueue *queue,
 263                                         struct GNUNET_TESTBED_Operation *operation)
 264 {
 265   struct QueueEntry *entry;
 266
 267   entry = GNUNET_malloc (sizeof (struct QueueEntry));
 268   entry->op = operation;
 269   GNUNET_CONTAINER_DLL_insert_tail (queue->head, queue->tail, entry);
 270   operation->queues =
 271     GNUNET_realloc (operation->queues,
 272                     sizeof (struct OperationQueue *) * (++operation->nqueues));
 273   operation->queues[operation->nqueues - 1] = queue;
 274   check_readiness (operation);
 275 }
 276
 277
 278 /**
 279  * Remove an operation from a queue.  This can be because the
 280  * oeration was active and has completed (and the resources have
 281  * been released), or because the operation was cancelled and
 282  * thus scheduling the operation is no longer required.
 283  *
 284  * @param queue queue to add the operation to
 285  * @param operation operation to add to the queue
 286  */
 287 void
 288 GNUNET_TESTBED_operation_queue_remove_ (struct OperationQueue *queue,
 289                                         struct GNUNET_TESTBED_Operation *operation)
 290 {
 291   struct QueueEntry *entry;
 292   struct QueueEntry *entry2;
 293
 294   for (entry = queue->head; NULL != entry; entry = entry->next)
 295     if (entry->op == operation)
 296       break;
 297   GNUNET_assert (NULL != entry);
 298   if (OP_STATE_STARTED == operation->state)
 299     queue->active++;
 300   entry2 = entry->next;
 301   GNUNET_CONTAINER_DLL_remove (queue->head, queue->tail, entry);
 302   GNUNET_free (entry);
 303   for (; NULL != entry2; entry2 = entry2->next)
 304     if (OP_STATE_STARTED != entry2->op->state)
 305       break;
 306   if (NULL == entry2)
 307     return;
 308   check_readiness (entry2->op);
 309 }
 310
 311
 312 /**
 313  * An operation is 'done' (was cancelled or finished); remove
 314  * it from the queues and release associated resources.
 315  *
 316  * @param operation operation that finished
 317  */
 318 void
 319 GNUNET_TESTBED_operation_release_ (struct GNUNET_TESTBED_Operation *operation)
 320 {
 321   unsigned int i;
 322
 323   if (GNUNET_SCHEDULER_NO_TASK != operation->start_task_id)
 324   {
 325     GNUNET_SCHEDULER_cancel (operation->start_task_id);
 326     operation->start_task_id = GNUNET_SCHEDULER_NO_TASK;
 327   }
 328   for (i = 0; i < operation->nqueues; i++)
 329     GNUNET_TESTBED_operation_queue_remove_ (operation->queues[i], operation);
 330   GNUNET_free (operation->queues);
 331   if (NULL != operation->release)
 332     operation->release (operation->cb_cls);
 333   GNUNET_free (operation);
 334 }
 335
 336
 337 /* end of testbed_api_operations.c */