src/testbed/testbed_api_operations.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19  */
  20
  21 /**
  22  * @file testbed/testbed_api_operations.c
  23  * @brief functions to manage operation queues
  24  * @author Christian Grothoff
  25  * @author Sree Harsha Totakura
  26  */
  27
  28 #include "platform.h"
  29 #include "testbed_api_operations.h"
  30 #include "testbed_api_sd.h"
  31
  32 /**
  33  * The number of readings containing past operation's timing information that we
  34  * keep track of for adaptive queues
  35  */
  36 #define ADAPTIVE_QUEUE_DEFAULT_HISTORY 40
  37
  38 /**
  39  * The number of parallel opeartions we start with by default for adaptive
  40  * queues
  41  */
  42 #define ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE 4
  43
  44 /**
  45  * An entry in the operation queue
  46  */
  47 struct QueueEntry
  48 {
  49   /**
  50    * The next DLL pointer
  51    */
  52   struct QueueEntry *next;
  53
  54   /**
  55    * The prev DLL pointer
  56    */
  57   struct QueueEntry *prev;
  58
  59   /**
  60    * The operation this entry holds
  61    */
  62   struct GNUNET_TESTBED_Operation *op;
  63
  64   /**
  65    * How many units of resources does the operation need
  66    */
  67   unsigned int nres;
  68 };
  69
  70
  71 /**
  72  * Queue of operations where we can only support a certain
  73  * number of concurrent operations of a particular type.
  74  */
  75 struct OperationQueue;
  76
  77
  78 /**
  79  * A slot to record time taken by an operation
  80  */
  81 struct TimeSlot
  82 {
  83   /**
  84    * DLL next pointer
  85    */
  86   struct TimeSlot *next;
  87
  88   /**
  89    * DLL prev pointer
  90    */
  91   struct TimeSlot *prev;
  92
  93   /**
  94    * This operation queue to which this time slot belongs to
  95    */
  96   struct OperationQueue *queue;
  97
  98   /**
  99    * The operation to which this timeslot is currently allocated to
 100    */
 101   struct GNUNET_TESTBED_Operation *op;
 102
 103   /**
 104    * Accumulated time
 105    */
 106   struct GNUNET_TIME_Relative tsum;
 107
 108   /**
 109    * Number of timing values accumulated
 110    */
 111   unsigned int nvals;
 112 };
 113
 114
 115 /**
 116  * Context for operation queues of type OPERATION_QUEUE_TYPE_ADAPTIVE
 117  */
 118 struct FeedbackCtx
 119 {
 120   /**
 121    * Handle for calculating standard deviation
 122    */
 123   struct SDHandle *sd;
 124
 125   /**
 126    * Head for DLL of time slots which are free to be allocated to operations
 127    */
 128   struct TimeSlot *alloc_head;
 129
 130   /**
 131    * Tail for DLL of time slots which are free to be allocated to operations
 132    */
 133   struct TimeSlot *alloc_tail;
 134
 135   /**
 136    * Pointer to the chunk of time slots.  Free all time slots at a time using
 137    * this pointer.
 138    */
 139   struct TimeSlot *tslots_freeptr;
 140
 141   /**
 142    * Number of time slots filled so far
 143    */
 144   unsigned int tslots_filled;
 145
 146   /**
 147    * Bound on the maximum number of operations which can be active
 148    */
 149   unsigned int max_active_bound;
 150
 151   /**
 152    * Number of operations that have failed
 153    */
 154   unsigned int nfailed;
 155 };
 156
 157
 158 /**
 159  * Queue of operations where we can only support a certain
 160  * number of concurrent operations of a particular type.
 161  */
 162 struct OperationQueue
 163 {
 164   /**
 165    * DLL head for the wait queue.  Operations which are waiting for this
 166    * operation queue are put here
 167    */
 168   struct QueueEntry *wq_head;
 169
 170   /**
 171    * DLL tail for the wait queue.
 172    */
 173   struct QueueEntry *wq_tail;
 174
 175   /**
 176    * DLL head for the ready queue.  Operations which are in this operation queue
 177    * and are in ready state are put here
 178    */
 179   struct QueueEntry *rq_head;
 180
 181   /**
 182    * DLL tail for the ready queue
 183    */
 184   struct QueueEntry *rq_tail;
 185
 186   /**
 187    * DLL head for the active queue.  Operations which are in this operation
 188    * queue and are currently active are put here
 189    */
 190   struct QueueEntry *aq_head;
 191
 192   /**
 193    * DLL tail for the active queue.
 194    */
 195   struct QueueEntry *aq_tail;
 196
 197   /**
 198    * DLL head for the inactive queue.  Operations which are inactive and can be
 199    * evicted if the queues it holds are maxed out and another operation begins
 200    * to wait on them.
 201    */
 202   struct QueueEntry *nq_head;
 203
 204   /**
 205    * DLL tail for the inactive queue.
 206    */
 207   struct QueueEntry *nq_tail;
 208
 209   /**
 210    * Feedback context; only relevant for adaptive operation queues.  NULL for
 211    * fixed operation queues
 212    */
 213   struct FeedbackCtx *fctx;
 214
 215   /**
 216    * The type of this opeartion queue
 217    */
 218   enum OperationQueueType type;
 219
 220   /**
 221    * Number of operations that are currently active in this queue.
 222    */
 223   unsigned int active;
 224
 225   /**
 226    * Max number of operations which can be active at any time in this queue.
 227    * This value can be changed either by calling
 228    * GNUNET_TESTBED_operation_queue_reset_max_active_() or by the adaptive
 229    * algorithm if this operation queue is of type #OPERATION_QUEUE_TYPE_ADAPTIVE
 230    */
 231   unsigned int max_active;
 232
 233   /**
 234    * The number of resources occupied by failed operations in the current shot.
 235    * This is only relavant if the operation queue is of type
 236    * #OPERATION_QUEUE_TYPE_ADAPTIVE
 237    */
 238   unsigned int overload;
 239
 240   /**
 241    * Is this queue marked for expiry?
 242    */
 243   unsigned int expired;
 244 };
 245
 246
 247 /**
 248  * Operation state
 249  */
 250 enum OperationState
 251 {
 252   /**
 253    * The operation is just created and is in initial state
 254    */
 255   OP_STATE_INIT,
 256
 257   /**
 258    * The operation is currently waiting for resources
 259    */
 260   OP_STATE_WAITING,
 261
 262   /**
 263    * The operation is ready to be started
 264    */
 265   OP_STATE_READY,
 266
 267   /**
 268    * The operation has started and is active
 269    */
 270   OP_STATE_ACTIVE,
 271
 272   /**
 273    * The operation is inactive.  It still holds resources on the operation
 274    * queues.  However, this operation will be evicted when another operation
 275    * requires resources from the maxed out queues this operation is holding
 276    * resources from.
 277    */
 278   OP_STATE_INACTIVE
 279 };
 280
 281
 282 /**
 283  * An entry in the ready queue (implemented as DLL)
 284  */
 285 struct ReadyQueueEntry
 286 {
 287   /**
 288    * next ptr for DLL
 289    */
 290   struct ReadyQueueEntry *next;
 291
 292   /**
 293    * prev ptr for DLL
 294    */
 295   struct ReadyQueueEntry *prev;
 296
 297   /**
 298    * The operation associated with this entry
 299    */
 300   struct GNUNET_TESTBED_Operation *op;
 301 };
 302
 303
 304 /**
 305  * Opaque handle to an abstract operation to be executed by the testing framework.
 306  */
 307 struct GNUNET_TESTBED_Operation
 308 {
 309   /**
 310    * Function to call when we have the resources to begin the operation.
 311    */
 312   OperationStart start;
 313
 314   /**
 315    * Function to call to clean up after the operation (which may or may
 316    * not have been started yet).
 317    */
 318   OperationRelease release;
 319
 320   /**
 321    * Closure for callbacks.
 322    */
 323   void *cb_cls;
 324
 325   /**
 326    * Array of operation queues this Operation belongs to.
 327    */
 328   struct OperationQueue **queues;
 329
 330   /**
 331    * Array of operation queue entries corresponding to this operation in
 332    * operation queues for this operation
 333    */
 334   struct QueueEntry **qentries;
 335
 336   /**
 337    * Array of number of resources an operation need from each queue. The numbers
 338    * in this array should correspond to the queues array
 339    */
 340   unsigned int *nres;
 341
 342   /**
 343    * Entry corresponding to this operation in ready queue.  Will be NULL if the
 344    * operation is not marked as READY
 345    */
 346   struct ReadyQueueEntry *rq_entry;
 347
 348   /**
 349    * Head pointer for DLL of tslots allocated to this operation
 350    */
 351   struct TimeSlot *tslots_head;
 352
 353   /**
 354    * Tail pointer for DLL of tslots allocated to this operation
 355    */
 356   struct TimeSlot *tslots_tail;
 357
 358   /**
 359    * The time at which the operation is started
 360    */
 361   struct GNUNET_TIME_Absolute tstart;
 362
 363   /**
 364    * Number of queues in the operation queues array
 365    */
 366   unsigned int nqueues;
 367
 368   /**
 369    * The state of the operation
 370    */
 371   enum OperationState state;
 372
 373   /**
 374    * Is this a failed operation?
 375    */
 376   int failed;
 377
 378 };
 379
 380 /**
 381  * DLL head for the ready queue
 382  */
 383 static struct ReadyQueueEntry *rq_head;
 384
 385 /**
 386  * DLL tail for the ready queue
 387  */
 388 static struct ReadyQueueEntry *rq_tail;
 389
 390 /**
 391  * Array of operation queues which are to be destroyed
 392  */
 393 static struct OperationQueue **expired_opqs;
 394
 395 /**
 396  * Number of expired operation queues in the above array
 397  */
 398 static unsigned int n_expired_opqs;
 399
 400 /**
 401  * The id of the task to process the ready queue
 402  */
 403 struct GNUNET_SCHEDULER_Task *process_rq_task_id;
 404
 405
 406 /**
 407  * Assigns the given operation a time slot from the given operation queue
 408  *
 409  * @param op the operation
 410  * @param queue the operation queue
 411  * @return the timeslot
 412  */
 413 static void
 414 assign_timeslot (struct GNUNET_TESTBED_Operation *op,
 415                  struct OperationQueue *queue)
 416 {
 417   struct FeedbackCtx *fctx = queue->fctx;
 418   struct TimeSlot *tslot;
 419
 420   GNUNET_assert (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type);
 421   tslot = fctx->alloc_head;
 422   GNUNET_assert (NULL != tslot);
 423   GNUNET_CONTAINER_DLL_remove (fctx->alloc_head, fctx->alloc_tail, tslot);
 424   GNUNET_CONTAINER_DLL_insert_tail (op->tslots_head, op->tslots_tail, tslot);
 425   tslot->op = op;
 426 }
 427
 428
 429 /**
 430  * Removes a queue entry of an operation from one of the operation queues' lists
 431  * depending on the state of the operation
 432  *
 433  * @param op the operation whose entry has to be removed
 434  * @param index the index of the entry in the operation's array of queue entries
 435  */
 436 static void
 437 remove_queue_entry (struct GNUNET_TESTBED_Operation *op, unsigned int index)
 438 {
 439   struct OperationQueue *opq;
 440   struct QueueEntry *entry;
 441
 442   opq = op->queues[index];
 443   entry = op->qentries[index];
 444   switch (op->state)
 445   {
 446   case OP_STATE_INIT:
 447     GNUNET_assert (0);
 448     break;
 449   case OP_STATE_WAITING:
 450     GNUNET_CONTAINER_DLL_remove (opq->wq_head, opq->wq_tail, entry);
 451     break;
 452   case OP_STATE_READY:
 453     GNUNET_CONTAINER_DLL_remove (opq->rq_head, opq->rq_tail, entry);
 454     break;
 455   case OP_STATE_ACTIVE:
 456     GNUNET_CONTAINER_DLL_remove (opq->aq_head, opq->aq_tail, entry);
 457     break;
 458   case OP_STATE_INACTIVE:
 459     GNUNET_CONTAINER_DLL_remove (opq->nq_head, opq->nq_tail, entry);
 460     break;
 461   }
 462 }
 463
 464
 465 /**
 466  * Changes the state of the operation while moving its associated queue entries
 467  * in the operation's operation queues
 468  *
 469  * @param op the operation whose state has to be changed
 470  * @param state the state the operation should have.  It cannot be OP_STATE_INIT
 471  */
 472 static void
 473 change_state (struct GNUNET_TESTBED_Operation *op, enum OperationState state)
 474 {
 475   struct QueueEntry *entry;
 476   struct OperationQueue *opq;
 477   unsigned int cnt;
 478   unsigned int s;
 479
 480   GNUNET_assert (OP_STATE_INIT != state);
 481   GNUNET_assert (NULL != op->queues);
 482   GNUNET_assert (NULL != op->nres);
 483   GNUNET_assert ((OP_STATE_INIT == op->state) || (NULL != op->qentries));
 484   GNUNET_assert (op->state != state);
 485   for (cnt = 0; cnt < op->nqueues; cnt++)
 486   {
 487     if (OP_STATE_INIT == op->state)
 488     {
 489       entry = GNUNET_new (struct QueueEntry);
 490       entry->op = op;
 491       entry->nres = op->nres[cnt];
 492       s = cnt;
 493       GNUNET_array_append (op->qentries, s, entry);
 494     }
 495     else
 496     {
 497       entry = op->qentries[cnt];
 498       remove_queue_entry (op, cnt);
 499     }
 500     opq = op->queues[cnt];
 501     switch (state)
 502     {
 503     case OP_STATE_INIT:
 504       GNUNET_assert (0);
 505       break;
 506     case OP_STATE_WAITING:
 507       GNUNET_CONTAINER_DLL_insert_tail (opq->wq_head, opq->wq_tail, entry);
 508       break;
 509     case OP_STATE_READY:
 510       GNUNET_CONTAINER_DLL_insert_tail (opq->rq_head, opq->rq_tail, entry);
 511       break;
 512     case OP_STATE_ACTIVE:
 513       GNUNET_CONTAINER_DLL_insert_tail (opq->aq_head, opq->aq_tail, entry);
 514       break;
 515     case OP_STATE_INACTIVE:
 516       GNUNET_CONTAINER_DLL_insert_tail (opq->nq_head, opq->nq_tail, entry);
 517       break;
 518     }
 519   }
 520   op->state = state;
 521 }
 522
 523
 524 /**
 525  * Removes an operation from the ready queue.  Also stops the 'process_rq_task'
 526  * if the given operation is the last one in the queue.
 527  *
 528  * @param op the operation to be removed
 529  */
 530 static void
 531 rq_remove (struct GNUNET_TESTBED_Operation *op)
 532 {
 533   GNUNET_assert (NULL != op->rq_entry);
 534   GNUNET_CONTAINER_DLL_remove (rq_head, rq_tail, op->rq_entry);
 535   GNUNET_free (op->rq_entry);
 536   op->rq_entry = NULL;
 537   if ( (NULL == rq_head) && (NULL != process_rq_task_id) )
 538   {
 539     GNUNET_SCHEDULER_cancel (process_rq_task_id);
 540     process_rq_task_id = NULL;
 541   }
 542 }
 543
 544
 545 /**
 546  * Processes the ready queue by calling the operation start callback of the
 547  * operation at the head.  The operation is then removed from the queue.  The
 548  * task is scheduled to run again immediately until no more operations are in
 549  * the ready queue.
 550  *
 551  * @param cls NULL
 552  */
 553 static void
 554 process_rq_task (void *cls)
 555 {
 556   struct GNUNET_TESTBED_Operation *op;
 557   struct OperationQueue *queue;
 558   unsigned int cnt;
 559
 560   process_rq_task_id = NULL;
 561   GNUNET_assert (NULL != rq_head);
 562   GNUNET_assert (NULL != (op = rq_head->op));
 563   rq_remove (op);
 564   if (NULL != rq_head)
 565     process_rq_task_id = GNUNET_SCHEDULER_add_now (&process_rq_task, NULL);
 566   change_state (op, OP_STATE_ACTIVE);
 567   for (cnt = 0; cnt < op->nqueues; cnt++)
 568   {
 569     queue = op->queues[cnt];
 570     if (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type)
 571       assign_timeslot (op, queue);
 572   }
 573   op->tstart = GNUNET_TIME_absolute_get ();
 574   if (NULL != op->start)
 575     op->start (op->cb_cls);
 576 }
 577
 578
 579 /**
 580  * Adds the operation to the ready queue and starts the 'process_rq_task'
 581  *
 582  * @param op the operation to be queued
 583  */
 584 static void
 585 rq_add (struct GNUNET_TESTBED_Operation *op)
 586 {
 587   struct ReadyQueueEntry *rq_entry;
 588
 589   GNUNET_assert (NULL == op->rq_entry);
 590   rq_entry = GNUNET_new (struct ReadyQueueEntry);
 591   rq_entry->op = op;
 592   GNUNET_CONTAINER_DLL_insert_tail (rq_head, rq_tail, rq_entry);
 593   op->rq_entry = rq_entry;
 594   if (NULL == process_rq_task_id)
 595     process_rq_task_id = GNUNET_SCHEDULER_add_now (&process_rq_task, NULL);
 596 }
 597
 598
 599 /**
 600  * Checks if the given operation queue is empty or not
 601  *
 602  * @param opq the operation queue
 603  * @return GNUNET_YES if the given operation queue has no operations; GNUNET_NO
 604  *           otherwise
 605  */
 606 static int
 607 is_queue_empty (struct OperationQueue *opq)
 608 {
 609   if ( (NULL != opq->wq_head)
 610        || (NULL != opq->rq_head)
 611        || (NULL != opq->aq_head)
 612        || (NULL != opq->nq_head) )
 613     return GNUNET_NO;
 614   return GNUNET_YES;
 615 }
 616
 617
 618 /**
 619  * Checks if the given operation queue has enough resources to provide for the
 620  * operation of the given queue entry.  It also checks if any inactive
 621  * operations are to be released in order to accommodate the needed resources
 622  * and returns them as an array.
 623  *
 624  * @param opq the operation queue to check for resource accommodation
 625  * @param entry the operation queue entry whose operation's resources are to be
 626  *          accommodated
 627  * @param ops_ pointer to return the array of operations which are to be released
 628  *          in order to accommodate the new operation.  Can be NULL
 629  * @param n_ops_ the number of operations in ops_
 630  * @return GNUNET_YES if the given entry's operation can be accommodated in this
 631  *           queue. GNUNET_NO if it cannot be accommodated; ops_ and n_ops_ will
 632  *           be set to NULL and 0 respectively.
 633  */
 634 static int
 635 decide_capacity (struct OperationQueue *opq,
 636                  struct QueueEntry *entry,
 637                  struct GNUNET_TESTBED_Operation ***ops_,
 638                  unsigned int *n_ops_)
 639 {
 640   struct QueueEntry **evict_entries;
 641   struct GNUNET_TESTBED_Operation **ops;
 642   struct GNUNET_TESTBED_Operation *op;
 643   unsigned int n_ops;
 644   unsigned int n_evict_entries;
 645   unsigned int need;
 646   unsigned int max;
 647   int deficit;
 648   int rval;
 649
 650   GNUNET_assert (NULL != (op = entry->op));
 651   GNUNET_assert (0 < (need = entry->nres));
 652   ops = NULL;
 653   n_ops = 0;
 654   evict_entries = NULL;
 655   n_evict_entries = 0;
 656   rval = GNUNET_YES;
 657   if (OPERATION_QUEUE_TYPE_ADAPTIVE == opq->type)
 658   {
 659     GNUNET_assert (NULL != opq->fctx);
 660     GNUNET_assert (opq->max_active >= opq->overload);
 661     max = opq->max_active - opq->overload;
 662   }
 663   else
 664     max = opq->max_active;
 665   if (opq->active > max)
 666   {
 667     rval = GNUNET_NO;
 668     goto ret;
 669   }
 670   if ((opq->active + need) <= max)
 671     goto ret;
 672   deficit = need - (max - opq->active);
 673   for (entry = opq->nq_head;
 674        (0 < deficit) && (NULL != entry);
 675        entry = entry->next)
 676   {
 677     GNUNET_array_append (evict_entries, n_evict_entries, entry);
 678     deficit -= entry->nres;
 679   }
 680   if (0 < deficit)
 681   {
 682     rval = GNUNET_NO;
 683     goto ret;
 684   }
 685   for (n_ops = 0; n_ops < n_evict_entries;)
 686   {
 687     op = evict_entries[n_ops]->op;
 688     GNUNET_array_append (ops, n_ops, op); /* increments n-ops */
 689   }
 690
 691  ret:
 692   GNUNET_free_non_null (evict_entries);
 693   if (NULL != ops_)
 694     *ops_ = ops;
 695   else
 696     GNUNET_free (ops);
 697   if (NULL != n_ops_)
 698     *n_ops_ = n_ops;
 699   return rval;
 700 }
 701
 702
 703 /**
 704  * Merges an array of operations into another, eliminating duplicates.  No
 705  * ordering is guaranteed.
 706  *
 707  * @param old the array into which the merging is done.
 708  * @param n_old the number of operations in old array
 709  * @param new the array from which operations are to be merged
 710  * @param n_new the number of operations in new array
 711  */
 712 static void
 713 merge_ops (struct GNUNET_TESTBED_Operation ***old,
 714            unsigned int *n_old,
 715            struct GNUNET_TESTBED_Operation **new,
 716            unsigned int n_new)
 717 {
 718   struct GNUNET_TESTBED_Operation **cur;
 719   unsigned int i;
 720   unsigned int j;
 721   unsigned int n_cur;
 722
 723   GNUNET_assert (NULL != old);
 724   n_cur = *n_old;
 725   cur = *old;
 726   for (i = 0; i < n_new; i++)
 727   {
 728     for (j = 0; j < *n_old; j++)
 729     {
 730       if (new[i] == cur[j])
 731         break;
 732     }
 733     if (j < *n_old)
 734       continue;
 735     GNUNET_array_append (cur, n_cur, new[j]);
 736   }
 737   *old = cur;
 738   *n_old = n_cur;
 739 }
 740
 741
 742
 743 /**
 744  * Checks for the readiness of an operation and schedules a operation start task
 745  *
 746  * @param op the operation
 747  */
 748 static int
 749 check_readiness (struct GNUNET_TESTBED_Operation *op)
 750 {
 751   struct GNUNET_TESTBED_Operation **evict_ops;
 752   struct GNUNET_TESTBED_Operation **ops;
 753   unsigned int n_ops;
 754   unsigned int n_evict_ops;
 755   unsigned int i;
 756
 757   GNUNET_assert (NULL == op->rq_entry);
 758   GNUNET_assert (OP_STATE_WAITING == op->state);
 759   evict_ops = NULL;
 760   n_evict_ops = 0;
 761   for (i = 0; i < op->nqueues; i++)
 762   {
 763     ops = NULL;
 764     n_ops = 0;
 765     if (GNUNET_NO == decide_capacity (op->queues[i], op->qentries[i],
 766                                       &ops, &n_ops))
 767     {
 768       GNUNET_free_non_null (evict_ops);
 769       return GNUNET_NO;
 770     }
 771     if (NULL == ops)
 772       continue;
 773     merge_ops (&evict_ops, &n_evict_ops, ops, n_ops);
 774     GNUNET_free (ops);
 775   }
 776   if (NULL != evict_ops)
 777   {
 778     for (i = 0; i < n_evict_ops; i++)
 779       GNUNET_TESTBED_operation_release_ (evict_ops[i]);
 780     GNUNET_free (evict_ops);
 781     evict_ops = NULL;
 782     /* Evicting the operations should schedule this operation */
 783     GNUNET_assert (OP_STATE_READY == op->state);
 784     return GNUNET_YES;
 785   }
 786   for (i = 0; i < op->nqueues; i++)
 787     op->queues[i]->active += op->nres[i];
 788   change_state (op, OP_STATE_READY);
 789   rq_add (op);
 790   return GNUNET_YES;
 791 }
 792
 793
 794 /**
 795  * Defers a ready to be executed operation back to waiting
 796  *
 797  * @param op the operation to defer
 798  */
 799 static void
 800 defer (struct GNUNET_TESTBED_Operation *op)
 801 {
 802   unsigned int i;
 803
 804   GNUNET_assert (OP_STATE_READY == op->state);
 805   rq_remove (op);
 806   for (i = 0; i < op->nqueues; i++)
 807   {
 808     GNUNET_assert (op->queues[i]->active >= op->nres[i]);
 809     op->queues[i]->active -= op->nres[i];
 810   }
 811   change_state (op, OP_STATE_WAITING);
 812 }
 813
 814
 815 /**
 816  * Cleanups the array of timeslots of an operation queue.  For each time slot in
 817  * the array, if it is allocated to an operation, it will be deallocated from
 818  * the operation
 819  *
 820  * @param queue the operation queue
 821  */
 822 static void
 823 cleanup_tslots (struct OperationQueue *queue)
 824 {
 825   struct FeedbackCtx *fctx = queue->fctx;
 826   struct TimeSlot *tslot;
 827   struct GNUNET_TESTBED_Operation *op;
 828   unsigned int cnt;
 829
 830   GNUNET_assert (NULL != fctx);
 831   for (cnt = 0; cnt < queue->max_active; cnt++)
 832   {
 833     tslot = &fctx->tslots_freeptr[cnt];
 834     op = tslot->op;
 835     if (NULL == op)
 836       continue;
 837     GNUNET_CONTAINER_DLL_remove (op->tslots_head, op->tslots_tail, tslot);
 838   }
 839   GNUNET_free_non_null (fctx->tslots_freeptr);
 840   fctx->tslots_freeptr = NULL;
 841   fctx->alloc_head = NULL;
 842   fctx->alloc_tail = NULL;
 843   fctx->tslots_filled = 0;
 844 }
 845
 846
 847 /**
 848  * Cleansup the existing timing slots and sets new timing slots in the given
 849  * queue to accommodate given number of max active operations.
 850  *
 851  * @param queue the queue
 852  * @param n the number of maximum active operations.  If n is greater than the
 853  *   maximum limit set while creating the queue, then the minimum of these two
 854  *   will be selected as n
 855  */
 856 static void
 857 adaptive_queue_set_max_active (struct OperationQueue *queue, unsigned int n)
 858 {
 859   struct FeedbackCtx *fctx = queue->fctx;
 860   struct TimeSlot *tslot;
 861   unsigned int cnt;
 862
 863   cleanup_tslots (queue);
 864   n = GNUNET_MIN (n ,fctx->max_active_bound);
 865   fctx->tslots_freeptr = GNUNET_malloc (n * sizeof (struct TimeSlot));
 866   fctx->nfailed = 0;
 867   for (cnt = 0; cnt < n; cnt++)
 868   {
 869     tslot = &fctx->tslots_freeptr[cnt];
 870     tslot->queue = queue;
 871     GNUNET_CONTAINER_DLL_insert_tail (fctx->alloc_head, fctx->alloc_tail, tslot);
 872   }
 873   GNUNET_TESTBED_operation_queue_reset_max_active_ (queue, n);
 874 }
 875
 876
 877 /**
 878  * Adapts parallelism in an adaptive queue by using the statistical data from
 879  * the feedback context.
 880  *
 881  * @param queue the queue
 882  */
 883 static void
 884 adapt_parallelism (struct OperationQueue *queue)
 885 {
 886   struct GNUNET_TIME_Relative avg;
 887   struct FeedbackCtx *fctx;
 888   struct TimeSlot *tslot;
 889   int sd;
 890   unsigned int nvals;
 891   unsigned int cnt;
 892   unsigned int parallelism;
 893
 894   avg = GNUNET_TIME_UNIT_ZERO;
 895   nvals = 0;
 896   fctx = queue->fctx;
 897   for (cnt = 0; cnt < queue->max_active; cnt++)
 898   {
 899     tslot = &fctx->tslots_freeptr[cnt];
 900     avg = GNUNET_TIME_relative_add (avg, tslot->tsum);
 901     nvals += tslot->nvals;
 902   }
 903   GNUNET_assert (nvals >= queue->max_active);
 904   GNUNET_assert (fctx->nfailed <= nvals);
 905   nvals -= fctx->nfailed;
 906   if (0 == nvals)
 907   {
 908     if (1 == queue->max_active)
 909       adaptive_queue_set_max_active (queue, 1);
 910     else
 911       adaptive_queue_set_max_active (queue, queue->max_active / 2);
 912     return;
 913   }
 914   avg = GNUNET_TIME_relative_divide (avg, nvals);
 915   GNUNET_TESTBED_SD_add_data_ (fctx->sd, (unsigned int) avg.rel_value_us);
 916   if (GNUNET_SYSERR ==
 917       GNUNET_TESTBED_SD_deviation_factor_ (fctx->sd,
 918                                            (unsigned int) avg.rel_value_us,
 919                                            &sd))
 920   {
 921     adaptive_queue_set_max_active (queue, queue->max_active); /* no change */
 922     return;
 923   }
 924
 925   parallelism = 0;
 926   if (-1 == sd)
 927     parallelism = queue->max_active + 1;
 928   if (sd <= -2)
 929     parallelism = queue->max_active * 2;
 930   if (1 == sd)
 931     parallelism = queue->max_active - 1;
 932   if (2 <= sd)
 933     parallelism = queue->max_active / 2;
 934   parallelism = GNUNET_MAX (parallelism, ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE);
 935   adaptive_queue_set_max_active (queue, parallelism);
 936
 937 #if 0
 938   /* old algorithm */
 939   if (sd < 0)
 940     sd = 0;
 941   GNUNET_assert (0 <= sd);
 942   //GNUNET_TESTBED_SD_add_data_ (fctx->sd, (unsigned int) avg.rel_value_us);
 943   if (0 == sd)
 944   {
 945     adaptive_queue_set_max_active (queue, queue->max_active * 2);
 946     return;
 947   }
 948   if (1 == sd)
 949   {
 950     adaptive_queue_set_max_active (queue, queue->max_active + 1);
 951     return;
 952   }
 953   if (1 == queue->max_active)
 954   {
 955     adaptive_queue_set_max_active (queue, 1);
 956     return;
 957   }
 958   if (2 == sd)
 959   {
 960     adaptive_queue_set_max_active (queue, queue->max_active - 1);
 961     return;
 962   }
 963   adaptive_queue_set_max_active (queue, queue->max_active / 2);
 964 #endif
 965 }
 966
 967
 968 /**
 969  * update tslots with the operation's completion time.  Additionally, if
 970  * updating a timeslot makes all timeslots filled in an adaptive operation
 971  * queue, call adapt_parallelism() for that queue.
 972  *
 973  * @param op the operation
 974  */
 975 static void
 976 update_tslots (struct GNUNET_TESTBED_Operation *op)
 977 {
 978   struct OperationQueue *queue;
 979   struct GNUNET_TIME_Relative t;
 980   struct TimeSlot *tslot;
 981   struct FeedbackCtx *fctx;
 982   unsigned int i;
 983
 984   t = GNUNET_TIME_absolute_get_duration (op->tstart);
 985   while (NULL != (tslot = op->tslots_head)) /* update time slots */
 986   {
 987     queue = tslot->queue;
 988     fctx = queue->fctx;
 989     GNUNET_CONTAINER_DLL_remove (op->tslots_head, op->tslots_tail, tslot);
 990     tslot->op = NULL;
 991     GNUNET_CONTAINER_DLL_insert_tail (fctx->alloc_head, fctx->alloc_tail,
 992                                       tslot);
 993     if (op->failed)
 994     {
 995       fctx->nfailed++;
 996       for (i = 0; i < op->nqueues; i++)
 997         if (queue == op->queues[i])
 998             break;
 999       GNUNET_assert (i != op->nqueues);
1000       op->queues[i]->overload += op->nres[i];
1001     }
1002     tslot->tsum = GNUNET_TIME_relative_add (tslot->tsum, t);
1003     if (0 != tslot->nvals++)
1004       continue;
1005     fctx->tslots_filled++;
1006     if (queue->max_active == fctx->tslots_filled)
1007       adapt_parallelism (queue);
1008   }
1009 }
1010
1011
1012 /**
1013  * Create an 'operation' to be performed.
1014  *
1015  * @param cls closure for the callbacks
1016  * @param start function to call to start the operation
1017  * @param release function to call to close down the operation
1018  * @return handle to the operation
1019  */
1020 struct GNUNET_TESTBED_Operation *
1021 GNUNET_TESTBED_operation_create_ (void *cls, OperationStart start,
1022                                   OperationRelease release)
1023 {
1024   struct GNUNET_TESTBED_Operation *op;
1025
1026   op = GNUNET_new (struct GNUNET_TESTBED_Operation);
1027   op->start = start;
1028   op->state = OP_STATE_INIT;
1029   op->release = release;
1030   op->cb_cls = cls;
1031   return op;
1032 }
1033
1034
1035 /**
1036  * Create an operation queue.
1037  *
1038  * @param type the type of operation queue
1039  * @param max_active maximum number of operations in this
1040  *        queue that can be active in parallel at the same time
1041  * @return handle to the queue
1042  */
1043 struct OperationQueue *
1044 GNUNET_TESTBED_operation_queue_create_ (enum OperationQueueType type,
1045                                         unsigned int max_active)
1046 {
1047   struct OperationQueue *queue;
1048   struct FeedbackCtx *fctx;
1049
1050   queue = GNUNET_new (struct OperationQueue);
1051   queue->type = type;
1052   if (OPERATION_QUEUE_TYPE_FIXED == type)
1053   {
1054     queue->max_active = max_active;
1055   }
1056   else
1057   {
1058     fctx = GNUNET_new (struct FeedbackCtx);
1059     fctx->max_active_bound = max_active;
1060     fctx->sd = GNUNET_TESTBED_SD_init_ (ADAPTIVE_QUEUE_DEFAULT_HISTORY);
1061     queue->fctx = fctx;
1062     adaptive_queue_set_max_active (queue, ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE);
1063   }
1064   return queue;
1065 }
1066
1067
1068 /**
1069  * Cleanup the given operation queue.
1070  *
1071  * @param queue the operation queue to destroy
1072  */
1073 static void
1074 queue_destroy (struct OperationQueue *queue)
1075 {
1076   struct FeedbackCtx *fctx;
1077
1078   if (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type)
1079   {
1080     cleanup_tslots (queue);
1081     fctx = queue->fctx;
1082     GNUNET_TESTBED_SD_destroy_ (fctx->sd);
1083     GNUNET_free (fctx);
1084   }
1085   GNUNET_free (queue);
1086 }
1087
1088
1089 /**
1090  * Destroys an operation queue.  If the queue is still in use by operations it
1091  * is marked as expired and its resources are released in the destructor
1092  * GNUNET_TESTBED_operations_fini().
1093  *
1094  * @param queue queue to destroy
1095  */
1096 void
1097 GNUNET_TESTBED_operation_queue_destroy_ (struct OperationQueue *queue)
1098 {
1099   if (GNUNET_YES != is_queue_empty (queue))
1100   {
1101     GNUNET_assert (0 == queue->expired); /* Are you calling twice on same queue? */
1102     queue->expired = 1;
1103     GNUNET_array_append (expired_opqs, n_expired_opqs, queue);
1104     return;
1105   }
1106   queue_destroy (queue);
1107 }
1108
1109
1110 /**
1111  * Destroys the operation queue if it is empty.  If not empty return GNUNET_NO.
1112  *
1113  * @param queue the queue to destroy if empty
1114  * @return GNUNET_YES if the queue is destroyed.  GNUNET_NO if not (because it
1115  *           is not empty)
1116  */
1117 int
1118 GNUNET_TESTBED_operation_queue_destroy_empty_ (struct OperationQueue *queue)
1119 {
1120   if (GNUNET_NO == is_queue_empty (queue))
1121     return GNUNET_NO;
1122   GNUNET_TESTBED_operation_queue_destroy_ (queue);
1123   return GNUNET_YES;
1124 }
1125
1126
1127 /**
1128  * Rechecks if any of the operations in the given operation queue's waiting list
1129  * can be made active
1130  *
1131  * @param opq the operation queue
1132  */
1133 static void
1134 recheck_waiting (struct OperationQueue *opq)
1135 {
1136   struct QueueEntry *entry;
1137   struct QueueEntry *entry2;
1138
1139   entry = opq->wq_head;
1140   while (NULL != entry)
1141   {
1142     entry2 = entry->next;
1143     if (GNUNET_NO == check_readiness (entry->op))
1144       break;
1145     entry = entry2;
1146   }
1147 }
1148
1149
1150 /**
1151  * Function to reset the maximum number of operations in the given queue. If
1152  * max_active is lesser than the number of currently active operations, the
1153  * active operations are not stopped immediately.
1154  *
1155  * @param queue the operation queue which has to be modified
1156  * @param max_active the new maximum number of active operations
1157  */
1158 void
1159 GNUNET_TESTBED_operation_queue_reset_max_active_ (struct OperationQueue *queue,
1160                                                   unsigned int max_active)
1161 {
1162   struct QueueEntry *entry;
1163
1164   queue->max_active = max_active;
1165   queue->overload = 0;
1166   while ( (queue->active > queue->max_active)
1167           && (NULL != (entry = queue->rq_head)) )
1168     defer (entry->op);
1169   recheck_waiting (queue);
1170 }
1171
1172
1173 /**
1174  * Add an operation to a queue.  An operation can be in multiple queues at
1175  * once. Once the operation is inserted into all the queues
1176  * GNUNET_TESTBED_operation_begin_wait_() has to be called to actually start
1177  * waiting for the operation to become active.
1178  *
1179  * @param queue queue to add the operation to
1180  * @param op operation to add to the queue
1181  * @param nres the number of units of the resources of queue needed by the
1182  *          operation. Should be greater than 0.
1183  */
1184 void
1185 GNUNET_TESTBED_operation_queue_insert2_ (struct OperationQueue *queue,
1186                                          struct GNUNET_TESTBED_Operation *op,
1187                                          unsigned int nres)
1188 {
1189   unsigned int qsize;
1190
1191   GNUNET_assert (0 < nres);
1192   qsize = op->nqueues;
1193   GNUNET_array_append (op->queues, op->nqueues, queue);
1194   GNUNET_array_append (op->nres, qsize, nres);
1195   GNUNET_assert (qsize == op->nqueues);
1196 }
1197
1198
1199 /**
1200  * Add an operation to a queue.  An operation can be in multiple queues at
1201  * once. Once the operation is inserted into all the queues
1202  * GNUNET_TESTBED_operation_begin_wait_() has to be called to actually start
1203  * waiting for the operation to become active. The operation is assumed to take
1204  * 1 queue resource. Use GNUNET_TESTBED_operation_queue_insert2_() if it
1205  * requires more than 1
1206  *
1207  * @param queue queue to add the operation to
1208  * @param op operation to add to the queue
1209  */
1210 void
1211 GNUNET_TESTBED_operation_queue_insert_ (struct OperationQueue *queue,
1212                                         struct GNUNET_TESTBED_Operation *op)
1213 {
1214   return GNUNET_TESTBED_operation_queue_insert2_ (queue, op, 1);
1215 }
1216
1217
1218 /**
1219  * Marks the given operation as waiting on the queues.  Once all queues permit
1220  * the operation to become active, the operation will be activated.  The actual
1221  * activation will occur in a separate task (thus allowing multiple queue
1222  * insertions to be made without having the first one instantly trigger the
1223  * operation if the first queue has sufficient resources).
1224  *
1225  * @param op the operation to marks as waiting
1226  */
1227 void
1228 GNUNET_TESTBED_operation_begin_wait_ (struct GNUNET_TESTBED_Operation *op)
1229 {
1230   GNUNET_assert (NULL == op->rq_entry);
1231   change_state (op, OP_STATE_WAITING);
1232   (void) check_readiness (op);
1233 }
1234
1235
1236 /**
1237  * Marks an active operation as inactive - the operation will be kept in a
1238  * ready-to-be-released state and continues to hold resources until another
1239  * operation contents for them.
1240  *
1241  * @param op the operation to be marked as inactive.  The operation start
1242  *          callback should have been called before for this operation to mark
1243  *          it as inactive.
1244  */
1245 void
1246 GNUNET_TESTBED_operation_inactivate_ (struct GNUNET_TESTBED_Operation *op)
1247 {
1248   struct OperationQueue **queues;
1249   size_t ms;
1250   unsigned int nqueues;
1251   unsigned int i;
1252
1253   GNUNET_assert (OP_STATE_ACTIVE == op->state);
1254   change_state (op, OP_STATE_INACTIVE);
1255   nqueues = op->nqueues;
1256   ms = sizeof (struct OperationQueue *) * nqueues;
1257   queues = GNUNET_malloc (ms);
1258   /* Cloning is needed as the operation be released by waiting operations and
1259      hence its nqueues memory ptr will be freed */
1260   GNUNET_memcpy (queues, op->queues, ms);
1261   for (i = 0; i < nqueues; i++)
1262     recheck_waiting (queues[i]);
1263   GNUNET_free (queues);
1264 }
1265
1266
1267 /**
1268  * Marks and inactive operation as active.  This fuction should be called to
1269  * ensure that the oprelease callback will not be called until it is either
1270  * marked as inactive or released.
1271  *
1272  * @param op the operation to be marked as active
1273  */
1274 void
1275 GNUNET_TESTBED_operation_activate_ (struct GNUNET_TESTBED_Operation *op)
1276 {
1277
1278   GNUNET_assert (OP_STATE_INACTIVE == op->state);
1279   change_state (op, OP_STATE_ACTIVE);
1280 }
1281
1282
1283 /**
1284  * An operation is 'done' (was cancelled or finished); remove
1285  * it from the queues and release associated resources.
1286  *
1287  * @param op operation that finished
1288  */
1289 void
1290 GNUNET_TESTBED_operation_release_ (struct GNUNET_TESTBED_Operation *op)
1291 {
1292   struct QueueEntry *entry;
1293   struct OperationQueue *opq;
1294   unsigned int i;
1295
1296   if (OP_STATE_INIT == op->state)
1297   {
1298     GNUNET_free (op);
1299     return;
1300   }
1301   if (OP_STATE_READY == op->state)
1302     rq_remove (op);
1303   if (OP_STATE_INACTIVE == op->state) /* Activate the operation if inactive */
1304     GNUNET_TESTBED_operation_activate_ (op);
1305   if (OP_STATE_ACTIVE == op->state)
1306     update_tslots (op);
1307   GNUNET_assert (NULL != op->queues);
1308   GNUNET_assert (NULL != op->qentries);
1309   for (i = 0; i < op->nqueues; i++)
1310   {
1311     entry = op->qentries[i];
1312     remove_queue_entry (op, i);
1313     opq = op->queues[i];
1314     switch (op->state)
1315     {
1316     case OP_STATE_INIT:
1317     case OP_STATE_INACTIVE:
1318       GNUNET_assert (0);
1319       break;
1320     case OP_STATE_WAITING:
1321       break;
1322     case OP_STATE_ACTIVE:
1323     case OP_STATE_READY:
1324       GNUNET_assert (0 != opq->active);
1325       GNUNET_assert (opq->active >= entry->nres);
1326       opq->active -= entry->nres;
1327       recheck_waiting (opq);
1328       break;
1329     }
1330     GNUNET_free (entry);
1331   }
1332   GNUNET_free_non_null (op->qentries);
1333   GNUNET_free (op->queues);
1334   GNUNET_free (op->nres);
1335   if (NULL != op->release)
1336     op->release (op->cb_cls);
1337   GNUNET_free (op);
1338 }
1339
1340
1341 /**
1342  * Marks an operation as failed
1343  *
1344  * @param op the operation to be marked as failed
1345  */
1346 void
1347 GNUNET_TESTBED_operation_mark_failed (struct GNUNET_TESTBED_Operation *op)
1348 {
1349   op->failed = GNUNET_YES;
1350 }
1351
1352
1353 /**
1354  * Cleanup expired operation queues.  While doing so, also check for any
1355  * operations which are not completed and warn about them.
1356  */
1357 void __attribute__ ((destructor))
1358 GNUNET_TESTBED_operations_fini ()
1359 {
1360   struct OperationQueue *queue;
1361   unsigned int i;
1362   int warn = 0;
1363
1364   for (i=0; i < n_expired_opqs; i++)
1365   {
1366     queue = expired_opqs[i];
1367     if (GNUNET_NO == is_queue_empty (queue))
1368       warn = 1;
1369     queue_destroy (queue);
1370   }
1371   GNUNET_free_non_null (expired_opqs);
1372   n_expired_opqs = 0;
1373   if (warn)
1374     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1375                 "Be disciplined.  Some operations were not marked as done.\n");
1376
1377 }
1378 /* end of testbed_api_operations.c */