2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
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.
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.
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.
22 * @file testbed/testbed_api_operations.c
23 * @brief functions to manage operation queues
24 * @author Christian Grothoff
25 * @author Sree Harsha Totakura
29 #include "testbed_api_operations.h"
30 #include "testbed_api_sd.h"
33 * The number of readings containing past operation's timing information that we
34 * keep track of for adaptive queues
36 #define ADAPTIVE_QUEUE_DEFAULT_HISTORY 40
39 * The number of parallel opeartions we start with by default for adaptive
42 #define ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE 4
45 * An entry in the operation queue
50 * The next DLL pointer
52 struct QueueEntry *next;
55 * The prev DLL pointer
57 struct QueueEntry *prev;
60 * The operation this entry holds
62 struct GNUNET_TESTBED_Operation *op;
65 * How many units of resources does the operation need
72 * Queue of operations where we can only support a certain
73 * number of concurrent operations of a particular type.
75 struct OperationQueue;
79 * A slot to record time taken by an operation
86 struct TimeSlot *next;
91 struct TimeSlot *prev;
94 * This operation queue to which this time slot belongs to
96 struct OperationQueue *queue;
99 * The operation to which this timeslot is currently allocated to
101 struct GNUNET_TESTBED_Operation *op;
106 struct GNUNET_TIME_Relative tsum;
109 * Number of timing values accumulated
116 * Context for operation queues of type OPERATION_QUEUE_TYPE_ADAPTIVE
121 * Handle for calculating standard deviation
126 * Head for DLL of time slots which are free to be allocated to operations
128 struct TimeSlot *alloc_head;
131 * Tail for DLL of time slots which are free to be allocated to operations
133 struct TimeSlot *alloc_tail;
136 * Pointer to the chunk of time slots. Free all time slots at a time using
139 struct TimeSlot *tslots_freeptr;
142 * Number of time slots filled so far
144 unsigned int tslots_filled;
147 * Bound on the maximum number of operations which can be active
149 unsigned int max_active_bound;
152 * Number of operations that have failed
154 unsigned int nfailed;
159 * Queue of operations where we can only support a certain
160 * number of concurrent operations of a particular type.
162 struct OperationQueue
165 * DLL head for the wait queue. Operations which are waiting for this
166 * operation queue are put here
168 struct QueueEntry *wq_head;
171 * DLL tail for the wait queue.
173 struct QueueEntry *wq_tail;
176 * DLL head for the ready queue. Operations which are in this operation queue
177 * and are in ready state are put here
179 struct QueueEntry *rq_head;
182 * DLL tail for the ready queue
184 struct QueueEntry *rq_tail;
187 * DLL head for the active queue. Operations which are in this operation
188 * queue and are currently active are put here
190 struct QueueEntry *aq_head;
193 * DLL tail for the active queue.
195 struct QueueEntry *aq_tail;
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
202 struct QueueEntry *nq_head;
205 * DLL tail for the inactive queue.
207 struct QueueEntry *nq_tail;
210 * Feedback context; only relevant for adaptive operation queues. NULL for
211 * fixed operation queues
213 struct FeedbackCtx *fctx;
216 * The type of this opeartion queue
218 enum OperationQueueType type;
221 * Number of operations that are currently active in this queue.
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
231 unsigned int max_active;
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
238 unsigned int overload;
241 * Is this queue marked for expiry?
243 unsigned int expired;
253 * The operation is just created and is in initial state
258 * The operation is currently waiting for resources
263 * The operation is ready to be started
268 * The operation has started and is active
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
283 * An entry in the ready queue (implemented as DLL)
285 struct ReadyQueueEntry
290 struct ReadyQueueEntry *next;
295 struct ReadyQueueEntry *prev;
298 * The operation associated with this entry
300 struct GNUNET_TESTBED_Operation *op;
305 * Opaque handle to an abstract operation to be executed by the testing framework.
307 struct GNUNET_TESTBED_Operation
310 * Function to call when we have the resources to begin the operation.
312 OperationStart start;
315 * Function to call to clean up after the operation (which may or may
316 * not have been started yet).
318 OperationRelease release;
321 * Closure for callbacks.
326 * Array of operation queues this Operation belongs to.
328 struct OperationQueue **queues;
331 * Array of operation queue entries corresponding to this operation in
332 * operation queues for this operation
334 struct QueueEntry **qentries;
337 * Array of number of resources an operation need from each queue. The numbers
338 * in this array should correspond to the queues array
343 * Entry corresponding to this operation in ready queue. Will be NULL if the
344 * operation is not marked as READY
346 struct ReadyQueueEntry *rq_entry;
349 * Head pointer for DLL of tslots allocated to this operation
351 struct TimeSlot *tslots_head;
354 * Tail pointer for DLL of tslots allocated to this operation
356 struct TimeSlot *tslots_tail;
359 * The time at which the operation is started
361 struct GNUNET_TIME_Absolute tstart;
364 * Number of queues in the operation queues array
366 unsigned int nqueues;
369 * The state of the operation
371 enum OperationState state;
374 * Is this a failed operation?
381 * DLL head for the ready queue
383 static struct ReadyQueueEntry *rq_head;
386 * DLL tail for the ready queue
388 static struct ReadyQueueEntry *rq_tail;
391 * Array of operation queues which are to be destroyed
393 static struct OperationQueue **expired_opqs;
396 * Number of expired operation queues in the above array
398 static unsigned int n_expired_opqs;
401 * The id of the task to process the ready queue
403 struct GNUNET_SCHEDULER_Task * process_rq_task_id;
407 * Assigns the given operation a time slot from the given operation queue
409 * @param op the operation
410 * @param queue the operation queue
411 * @return the timeslot
414 assign_timeslot (struct GNUNET_TESTBED_Operation *op,
415 struct OperationQueue *queue)
417 struct FeedbackCtx *fctx = queue->fctx;
418 struct TimeSlot *tslot;
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);
430 * Removes a queue entry of an operation from one of the operation queues' lists
431 * depending on the state of the operation
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
437 remove_queue_entry (struct GNUNET_TESTBED_Operation *op, unsigned int index)
439 struct OperationQueue *opq;
440 struct QueueEntry *entry;
442 opq = op->queues[index];
443 entry = op->qentries[index];
449 case OP_STATE_WAITING:
450 GNUNET_CONTAINER_DLL_remove (opq->wq_head, opq->wq_tail, entry);
453 GNUNET_CONTAINER_DLL_remove (opq->rq_head, opq->rq_tail, entry);
455 case OP_STATE_ACTIVE:
456 GNUNET_CONTAINER_DLL_remove (opq->aq_head, opq->aq_tail, entry);
458 case OP_STATE_INACTIVE:
459 GNUNET_CONTAINER_DLL_remove (opq->nq_head, opq->nq_tail, entry);
466 * Changes the state of the operation while moving its associated queue entries
467 * in the operation's operation queues
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
473 change_state (struct GNUNET_TESTBED_Operation *op, enum OperationState state)
475 struct QueueEntry *entry;
476 struct OperationQueue *opq;
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++)
487 if (OP_STATE_INIT == op->state)
489 entry = GNUNET_new (struct QueueEntry);
491 entry->nres = op->nres[cnt];
493 GNUNET_array_append (op->qentries, s, entry);
497 entry = op->qentries[cnt];
498 remove_queue_entry (op, cnt);
500 opq = op->queues[cnt];
506 case OP_STATE_WAITING:
507 GNUNET_CONTAINER_DLL_insert_tail (opq->wq_head, opq->wq_tail, entry);
510 GNUNET_CONTAINER_DLL_insert_tail (opq->rq_head, opq->rq_tail, entry);
512 case OP_STATE_ACTIVE:
513 GNUNET_CONTAINER_DLL_insert_tail (opq->aq_head, opq->aq_tail, entry);
515 case OP_STATE_INACTIVE:
516 GNUNET_CONTAINER_DLL_insert_tail (opq->nq_head, opq->nq_tail, entry);
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.
528 * @param op the operation to be removed
531 rq_remove (struct GNUNET_TESTBED_Operation *op)
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);
537 if ( (NULL == rq_head) && (NULL != process_rq_task_id) )
539 GNUNET_SCHEDULER_cancel (process_rq_task_id);
540 process_rq_task_id = NULL;
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
554 process_rq_task (void *cls)
556 struct GNUNET_TESTBED_Operation *op;
557 struct OperationQueue *queue;
560 process_rq_task_id = NULL;
561 GNUNET_assert (NULL != rq_head);
562 GNUNET_assert (NULL != (op = rq_head->op));
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++)
569 queue = op->queues[cnt];
570 if (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type)
571 assign_timeslot (op, queue);
573 op->tstart = GNUNET_TIME_absolute_get ();
574 if (NULL != op->start)
575 op->start (op->cb_cls);
580 * Adds the operation to the ready queue and starts the 'process_rq_task'
582 * @param op the operation to be queued
585 rq_add (struct GNUNET_TESTBED_Operation *op)
587 struct ReadyQueueEntry *rq_entry;
589 GNUNET_assert (NULL == op->rq_entry);
590 rq_entry = GNUNET_new (struct ReadyQueueEntry);
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);
600 * Checks if the given operation queue is empty or not
602 * @param opq the operation queue
603 * @return GNUNET_YES if the given operation queue has no operations; GNUNET_NO
607 is_queue_empty (struct OperationQueue *opq)
609 if ( (NULL != opq->wq_head)
610 || (NULL != opq->rq_head)
611 || (NULL != opq->aq_head)
612 || (NULL != opq->nq_head) )
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.
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
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.
635 decide_capacity (struct OperationQueue *opq,
636 struct QueueEntry *entry,
637 struct GNUNET_TESTBED_Operation ***ops_,
638 unsigned int *n_ops_)
640 struct QueueEntry **evict_entries;
641 struct GNUNET_TESTBED_Operation **ops;
642 struct GNUNET_TESTBED_Operation *op;
644 unsigned int n_evict_entries;
650 GNUNET_assert (NULL != (op = entry->op));
651 GNUNET_assert (0 < (need = entry->nres));
654 evict_entries = NULL;
657 if (OPERATION_QUEUE_TYPE_ADAPTIVE == opq->type)
659 GNUNET_assert (NULL != opq->fctx);
660 GNUNET_assert (opq->max_active >= opq->overload);
661 max = opq->max_active - opq->overload;
664 max = opq->max_active;
665 if (opq->active > max)
670 if ((opq->active + need) <= max)
672 deficit = need - (max - opq->active);
673 for (entry = opq->nq_head;
674 (0 < deficit) && (NULL != entry);
677 GNUNET_array_append (evict_entries, n_evict_entries, entry);
678 deficit -= entry->nres;
685 for (n_ops = 0; n_ops < n_evict_entries;)
687 op = evict_entries[n_ops]->op;
688 GNUNET_array_append (ops, n_ops, op); /* increments n-ops */
692 GNUNET_free_non_null (evict_entries);
704 * Merges an array of operations into another, eliminating duplicates. No
705 * ordering is guaranteed.
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
713 merge_ops (struct GNUNET_TESTBED_Operation ***old,
715 struct GNUNET_TESTBED_Operation **new,
718 struct GNUNET_TESTBED_Operation **cur;
723 GNUNET_assert (NULL != old);
726 for (i = 0; i < n_new; i++)
728 for (j = 0; j < *n_old; j++)
730 if (new[i] == cur[j])
735 GNUNET_array_append (cur, n_cur, new[j]);
744 * Checks for the readiness of an operation and schedules a operation start task
746 * @param op the operation
749 check_readiness (struct GNUNET_TESTBED_Operation *op)
751 struct GNUNET_TESTBED_Operation **evict_ops;
752 struct GNUNET_TESTBED_Operation **ops;
754 unsigned int n_evict_ops;
757 GNUNET_assert (NULL == op->rq_entry);
758 GNUNET_assert (OP_STATE_WAITING == op->state);
761 for (i = 0; i < op->nqueues; i++)
765 if (GNUNET_NO == decide_capacity (op->queues[i], op->qentries[i],
768 GNUNET_free_non_null (evict_ops);
773 merge_ops (&evict_ops, &n_evict_ops, ops, n_ops);
776 if (NULL != evict_ops)
778 for (i = 0; i < n_evict_ops; i++)
779 GNUNET_TESTBED_operation_release_ (evict_ops[i]);
780 GNUNET_free (evict_ops);
782 /* Evicting the operations should schedule this operation */
783 GNUNET_assert (OP_STATE_READY == op->state);
786 for (i = 0; i < op->nqueues; i++)
787 op->queues[i]->active += op->nres[i];
788 change_state (op, OP_STATE_READY);
795 * Defers a ready to be executed operation back to waiting
797 * @param op the operation to defer
800 defer (struct GNUNET_TESTBED_Operation *op)
804 GNUNET_assert (OP_STATE_READY == op->state);
806 for (i = 0; i < op->nqueues; i++)
808 GNUNET_assert (op->queues[i]->active >= op->nres[i]);
809 op->queues[i]->active -= op->nres[i];
811 change_state (op, OP_STATE_WAITING);
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
820 * @param queue the operation queue
823 cleanup_tslots (struct OperationQueue *queue)
825 struct FeedbackCtx *fctx = queue->fctx;
826 struct TimeSlot *tslot;
827 struct GNUNET_TESTBED_Operation *op;
830 GNUNET_assert (NULL != fctx);
831 for (cnt = 0; cnt < queue->max_active; cnt++)
833 tslot = &fctx->tslots_freeptr[cnt];
837 GNUNET_CONTAINER_DLL_remove (op->tslots_head, op->tslots_tail, tslot);
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;
848 * Cleansup the existing timing slots and sets new timing slots in the given
849 * queue to accommodate given number of max active operations.
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
857 adaptive_queue_set_max_active (struct OperationQueue *queue, unsigned int n)
859 struct FeedbackCtx *fctx = queue->fctx;
860 struct TimeSlot *tslot;
863 cleanup_tslots (queue);
864 n = GNUNET_MIN (n ,fctx->max_active_bound);
865 fctx->tslots_freeptr = GNUNET_malloc (n * sizeof (struct TimeSlot));
867 for (cnt = 0; cnt < n; cnt++)
869 tslot = &fctx->tslots_freeptr[cnt];
870 tslot->queue = queue;
871 GNUNET_CONTAINER_DLL_insert_tail (fctx->alloc_head, fctx->alloc_tail, tslot);
873 GNUNET_TESTBED_operation_queue_reset_max_active_ (queue, n);
878 * Adapts parallelism in an adaptive queue by using the statistical data from
879 * the feedback context.
881 * @param queue the queue
884 adapt_parallelism (struct OperationQueue *queue)
886 struct GNUNET_TIME_Relative avg;
887 struct FeedbackCtx *fctx;
888 struct TimeSlot *tslot;
892 unsigned int parallelism;
894 avg = GNUNET_TIME_UNIT_ZERO;
897 for (cnt = 0; cnt < queue->max_active; cnt++)
899 tslot = &fctx->tslots_freeptr[cnt];
900 avg = GNUNET_TIME_relative_add (avg, tslot->tsum);
901 nvals += tslot->nvals;
903 GNUNET_assert (nvals >= queue->max_active);
904 GNUNET_assert (fctx->nfailed <= nvals);
905 nvals -= fctx->nfailed;
908 if (1 == queue->max_active)
909 adaptive_queue_set_max_active (queue, 1);
911 adaptive_queue_set_max_active (queue, queue->max_active / 2);
914 avg = GNUNET_TIME_relative_divide (avg, nvals);
915 GNUNET_TESTBED_SD_add_data_ (fctx->sd, (unsigned int) avg.rel_value_us);
917 GNUNET_TESTBED_SD_deviation_factor_ (fctx->sd,
918 (unsigned int) avg.rel_value_us,
921 adaptive_queue_set_max_active (queue, queue->max_active); /* no change */
927 parallelism = queue->max_active + 1;
929 parallelism = queue->max_active * 2;
931 parallelism = queue->max_active - 1;
933 parallelism = queue->max_active / 2;
934 parallelism = GNUNET_MAX (parallelism, ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE);
935 adaptive_queue_set_max_active (queue, parallelism);
941 GNUNET_assert (0 <= sd);
942 //GNUNET_TESTBED_SD_add_data_ (fctx->sd, (unsigned int) avg.rel_value_us);
945 adaptive_queue_set_max_active (queue, queue->max_active * 2);
950 adaptive_queue_set_max_active (queue, queue->max_active + 1);
953 if (1 == queue->max_active)
955 adaptive_queue_set_max_active (queue, 1);
960 adaptive_queue_set_max_active (queue, queue->max_active - 1);
963 adaptive_queue_set_max_active (queue, queue->max_active / 2);
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.
973 * @param op the operation
976 update_tslots (struct GNUNET_TESTBED_Operation *op)
978 struct OperationQueue *queue;
979 struct GNUNET_TIME_Relative t;
980 struct TimeSlot *tslot;
981 struct FeedbackCtx *fctx;
984 t = GNUNET_TIME_absolute_get_duration (op->tstart);
985 while (NULL != (tslot = op->tslots_head)) /* update time slots */
987 queue = tslot->queue;
989 GNUNET_CONTAINER_DLL_remove (op->tslots_head, op->tslots_tail, tslot);
991 GNUNET_CONTAINER_DLL_insert_tail (fctx->alloc_head, fctx->alloc_tail,
996 for (i = 0; i < op->nqueues; i++)
997 if (queue == op->queues[i])
999 GNUNET_assert (i != op->nqueues);
1000 op->queues[i]->overload += op->nres[i];
1002 tslot->tsum = GNUNET_TIME_relative_add (tslot->tsum, t);
1003 if (0 != tslot->nvals++)
1005 fctx->tslots_filled++;
1006 if (queue->max_active == fctx->tslots_filled)
1007 adapt_parallelism (queue);
1013 * Create an 'operation' to be performed.
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
1020 struct GNUNET_TESTBED_Operation *
1021 GNUNET_TESTBED_operation_create_ (void *cls, OperationStart start,
1022 OperationRelease release)
1024 struct GNUNET_TESTBED_Operation *op;
1026 op = GNUNET_new (struct GNUNET_TESTBED_Operation);
1028 op->state = OP_STATE_INIT;
1029 op->release = release;
1036 * Create an operation queue.
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
1043 struct OperationQueue *
1044 GNUNET_TESTBED_operation_queue_create_ (enum OperationQueueType type,
1045 unsigned int max_active)
1047 struct OperationQueue *queue;
1048 struct FeedbackCtx *fctx;
1050 queue = GNUNET_new (struct OperationQueue);
1052 if (OPERATION_QUEUE_TYPE_FIXED == type)
1054 queue->max_active = max_active;
1058 fctx = GNUNET_new (struct FeedbackCtx);
1059 fctx->max_active_bound = max_active;
1060 fctx->sd = GNUNET_TESTBED_SD_init_ (ADAPTIVE_QUEUE_DEFAULT_HISTORY);
1062 adaptive_queue_set_max_active (queue, ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE);
1069 * Cleanup the given operation queue.
1071 * @param queue the operation queue to destroy
1074 queue_destroy (struct OperationQueue *queue)
1076 struct FeedbackCtx *fctx;
1078 if (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type)
1080 cleanup_tslots (queue);
1082 GNUNET_TESTBED_SD_destroy_ (fctx->sd);
1085 GNUNET_free (queue);
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().
1094 * @param queue queue to destroy
1097 GNUNET_TESTBED_operation_queue_destroy_ (struct OperationQueue *queue)
1099 if (GNUNET_YES != is_queue_empty (queue))
1101 GNUNET_assert (0 == queue->expired); /* Are you calling twice on same queue? */
1103 GNUNET_array_append (expired_opqs, n_expired_opqs, queue);
1106 queue_destroy (queue);
1111 * Destroys the operation queue if it is empty. If not empty return GNUNET_NO.
1113 * @param queue the queue to destroy if empty
1114 * @return GNUNET_YES if the queue is destroyed. GNUNET_NO if not (because it
1118 GNUNET_TESTBED_operation_queue_destroy_empty_ (struct OperationQueue *queue)
1120 if (GNUNET_NO == is_queue_empty (queue))
1122 GNUNET_TESTBED_operation_queue_destroy_ (queue);
1128 * Rechecks if any of the operations in the given operation queue's waiting list
1129 * can be made active
1131 * @param opq the operation queue
1134 recheck_waiting (struct OperationQueue *opq)
1136 struct QueueEntry *entry;
1137 struct QueueEntry *entry2;
1139 entry = opq->wq_head;
1140 while (NULL != entry)
1142 entry2 = entry->next;
1143 if (GNUNET_NO == check_readiness (entry->op))
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.
1155 * @param queue the operation queue which has to be modified
1156 * @param max_active the new maximum number of active operations
1159 GNUNET_TESTBED_operation_queue_reset_max_active_ (struct OperationQueue *queue,
1160 unsigned int max_active)
1162 struct QueueEntry *entry;
1164 queue->max_active = max_active;
1165 queue->overload = 0;
1166 while ( (queue->active > queue->max_active)
1167 && (NULL != (entry = queue->rq_head)) )
1169 recheck_waiting (queue);
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.
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.
1185 GNUNET_TESTBED_operation_queue_insert2_ (struct OperationQueue *queue,
1186 struct GNUNET_TESTBED_Operation *op,
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);
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
1207 * @param queue queue to add the operation to
1208 * @param op operation to add to the queue
1211 GNUNET_TESTBED_operation_queue_insert_ (struct OperationQueue *queue,
1212 struct GNUNET_TESTBED_Operation *op)
1214 return GNUNET_TESTBED_operation_queue_insert2_ (queue, op, 1);
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).
1225 * @param op the operation to marks as waiting
1228 GNUNET_TESTBED_operation_begin_wait_ (struct GNUNET_TESTBED_Operation *op)
1230 GNUNET_assert (NULL == op->rq_entry);
1231 change_state (op, OP_STATE_WAITING);
1232 (void) check_readiness (op);
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.
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
1246 GNUNET_TESTBED_operation_inactivate_ (struct GNUNET_TESTBED_Operation *op)
1248 struct OperationQueue **queues;
1250 unsigned int nqueues;
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_assert (NULL != (queues = memcpy (queues, op->queues, ms)));
1261 for (i = 0; i < nqueues; i++)
1262 recheck_waiting (queues[i]);
1263 GNUNET_free (queues);
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.
1272 * @param op the operation to be marked as active
1275 GNUNET_TESTBED_operation_activate_ (struct GNUNET_TESTBED_Operation *op)
1278 GNUNET_assert (OP_STATE_INACTIVE == op->state);
1279 change_state (op, OP_STATE_ACTIVE);
1284 * An operation is 'done' (was cancelled or finished); remove
1285 * it from the queues and release associated resources.
1287 * @param op operation that finished
1290 GNUNET_TESTBED_operation_release_ (struct GNUNET_TESTBED_Operation *op)
1292 struct QueueEntry *entry;
1293 struct OperationQueue *opq;
1296 if (OP_STATE_INIT == op->state)
1301 if (OP_STATE_READY == op->state)
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)
1307 GNUNET_assert (NULL != op->queues);
1308 GNUNET_assert (NULL != op->qentries);
1309 for (i = 0; i < op->nqueues; i++)
1311 entry = op->qentries[i];
1312 remove_queue_entry (op, i);
1313 opq = op->queues[i];
1317 case OP_STATE_INACTIVE:
1320 case OP_STATE_WAITING:
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);
1330 GNUNET_free (entry);
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);
1342 * Marks an operation as failed
1344 * @param op the operation to be marked as failed
1347 GNUNET_TESTBED_operation_mark_failed (struct GNUNET_TESTBED_Operation *op)
1349 op->failed = GNUNET_YES;
1354 * Cleanup expired operation queues. While doing so, also check for any
1355 * operations which are not completed and warn about them.
1357 void __attribute__ ((destructor))
1358 GNUNET_TESTBED_operations_fini ()
1360 struct OperationQueue *queue;
1364 for (i=0; i < n_expired_opqs; i++)
1366 queue = expired_opqs[i];
1367 if (GNUNET_NO == is_queue_empty (queue))
1369 queue_destroy (queue);
1371 GNUNET_free_non_null (expired_opqs);
1374 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1375 "Be disciplined. Some operations were not marked as done.\n");
1378 /* end of testbed_api_operations.c */