2 This file is part of GNUnet
3 (C) 2008--2013 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, 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;
248 * The operation is just created and is in initial state
253 * The operation is currently waiting for resources
258 * The operation is ready to be started
263 * The operation has started and is active
268 * The operation is inactive. It still holds resources on the operation
269 * queues. However, this operation will be evicted when another operation
270 * requires resources from the maxed out queues this operation is holding
278 * An entry in the ready queue (implemented as DLL)
280 struct ReadyQueueEntry
285 struct ReadyQueueEntry *next;
290 struct ReadyQueueEntry *prev;
293 * The operation associated with this entry
295 struct GNUNET_TESTBED_Operation *op;
300 * Opaque handle to an abstract operation to be executed by the testing framework.
302 struct GNUNET_TESTBED_Operation
305 * Function to call when we have the resources to begin the operation.
307 OperationStart start;
310 * Function to call to clean up after the operation (which may or may
311 * not have been started yet).
313 OperationRelease release;
316 * Closure for callbacks.
321 * Array of operation queues this Operation belongs to.
323 struct OperationQueue **queues;
326 * Array of operation queue entries corresponding to this operation in
327 * operation queues for this operation
329 struct QueueEntry **qentries;
332 * Array of number of resources an operation need from each queue. The numbers
333 * in this array should correspond to the queues array
338 * Entry corresponding to this operation in ready queue. Will be NULL if the
339 * operation is not marked as READY
341 struct ReadyQueueEntry *rq_entry;
344 * Head pointer for DLL of tslots allocated to this operation
346 struct TimeSlot *tslots_head;
349 * Tail pointer for DLL of tslots allocated to this operation
351 struct TimeSlot *tslots_tail;
354 * The time at which the operation is started
356 struct GNUNET_TIME_Absolute tstart;
359 * Number of queues in the operation queues array
361 unsigned int nqueues;
364 * The state of the operation
366 enum OperationState state;
369 * Is this a failed operation?
376 * DLL head for the ready queue
378 struct ReadyQueueEntry *rq_head;
381 * DLL tail for the ready queue
383 struct ReadyQueueEntry *rq_tail;
386 * The id of the task to process the ready queue
388 GNUNET_SCHEDULER_TaskIdentifier process_rq_task_id;
392 * Assigns the given operation a time slot from the given operation queue
394 * @param op the operation
395 * @param queue the operation queue
396 * @return the timeslot
399 assign_timeslot (struct GNUNET_TESTBED_Operation *op,
400 struct OperationQueue *queue)
402 struct FeedbackCtx *fctx = queue->fctx;
403 struct TimeSlot *tslot;
405 GNUNET_assert (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type);
406 tslot = fctx->alloc_head;
407 GNUNET_assert (NULL != tslot);
408 GNUNET_CONTAINER_DLL_remove (fctx->alloc_head, fctx->alloc_tail, tslot);
409 GNUNET_CONTAINER_DLL_insert_tail (op->tslots_head, op->tslots_tail, tslot);
415 * Removes a queue entry of an operation from one of the operation queues' lists
416 * depending on the state of the operation
418 * @param op the operation whose entry has to be removed
419 * @param index the index of the entry in the operation's array of queue entries
422 remove_queue_entry (struct GNUNET_TESTBED_Operation *op, unsigned int index)
424 struct OperationQueue *opq;
425 struct QueueEntry *entry;
427 opq = op->queues[index];
428 entry = op->qentries[index];
434 case OP_STATE_WAITING:
435 GNUNET_CONTAINER_DLL_remove (opq->wq_head, opq->wq_tail, entry);
438 GNUNET_CONTAINER_DLL_remove (opq->rq_head, opq->rq_tail, entry);
440 case OP_STATE_ACTIVE:
441 GNUNET_CONTAINER_DLL_remove (opq->aq_head, opq->aq_tail, entry);
443 case OP_STATE_INACTIVE:
444 GNUNET_CONTAINER_DLL_remove (opq->nq_head, opq->nq_tail, entry);
451 * Changes the state of the operation while moving its associated queue entries
452 * in the operation's operation queues
454 * @param op the operation whose state has to be changed
455 * @param state the state the operation should have. It cannot be OP_STATE_INIT
458 change_state (struct GNUNET_TESTBED_Operation *op, enum OperationState state)
460 struct QueueEntry *entry;
461 struct OperationQueue *opq;
465 GNUNET_assert (OP_STATE_INIT != state);
466 GNUNET_assert (NULL != op->queues);
467 GNUNET_assert (NULL != op->nres);
468 GNUNET_assert ((OP_STATE_INIT == op->state) || (NULL != op->qentries));
469 GNUNET_assert (op->state != state);
470 for (cnt = 0; cnt < op->nqueues; cnt++)
472 if (OP_STATE_INIT == op->state)
474 entry = GNUNET_new (struct QueueEntry);
476 entry->nres = op->nres[cnt];
478 GNUNET_array_append (op->qentries, s, entry);
482 entry = op->qentries[cnt];
483 remove_queue_entry (op, cnt);
485 opq = op->queues[cnt];
491 case OP_STATE_WAITING:
492 GNUNET_CONTAINER_DLL_insert_tail (opq->wq_head, opq->wq_tail, entry);
495 GNUNET_CONTAINER_DLL_insert_tail (opq->rq_head, opq->rq_tail, entry);
497 case OP_STATE_ACTIVE:
498 GNUNET_CONTAINER_DLL_insert_tail (opq->aq_head, opq->aq_tail, entry);
500 case OP_STATE_INACTIVE:
501 GNUNET_CONTAINER_DLL_insert_tail (opq->nq_head, opq->nq_tail, entry);
510 * Removes an operation from the ready queue. Also stops the 'process_rq_task'
511 * if the given operation is the last one in the queue.
513 * @param op the operation to be removed
516 rq_remove (struct GNUNET_TESTBED_Operation *op)
518 GNUNET_assert (NULL != op->rq_entry);
519 GNUNET_CONTAINER_DLL_remove (rq_head, rq_tail, op->rq_entry);
520 GNUNET_free (op->rq_entry);
522 if ( (NULL == rq_head) && (GNUNET_SCHEDULER_NO_TASK != process_rq_task_id) )
524 GNUNET_SCHEDULER_cancel (process_rq_task_id);
525 process_rq_task_id = GNUNET_SCHEDULER_NO_TASK;
531 * Processes the ready queue by calling the operation start callback of the
532 * operation at the head. The operation is then removed from the queue. The
533 * task is scheduled to run again immediately until no more operations are in
537 * @param tc scheduler task context. Not used.
540 process_rq_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
542 struct GNUNET_TESTBED_Operation *op;
543 struct OperationQueue *queue;
546 process_rq_task_id = GNUNET_SCHEDULER_NO_TASK;
547 GNUNET_assert (NULL != rq_head);
548 GNUNET_assert (NULL != (op = rq_head->op));
551 process_rq_task_id = GNUNET_SCHEDULER_add_now (&process_rq_task, NULL);
552 change_state (op, OP_STATE_ACTIVE);
553 for (cnt = 0; cnt < op->nqueues; cnt++)
555 queue = op->queues[cnt];
556 if (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type)
557 assign_timeslot (op, queue);
559 op->tstart = GNUNET_TIME_absolute_get ();
560 if (NULL != op->start)
561 op->start (op->cb_cls);
566 * Adds the operation to the ready queue and starts the 'process_rq_task'
568 * @param op the operation to be queued
571 rq_add (struct GNUNET_TESTBED_Operation *op)
573 struct ReadyQueueEntry *rq_entry;
575 GNUNET_assert (NULL == op->rq_entry);
576 rq_entry = GNUNET_new (struct ReadyQueueEntry);
578 GNUNET_CONTAINER_DLL_insert_tail (rq_head, rq_tail, rq_entry);
579 op->rq_entry = rq_entry;
580 if (GNUNET_SCHEDULER_NO_TASK == process_rq_task_id)
581 process_rq_task_id = GNUNET_SCHEDULER_add_now (&process_rq_task, NULL);
586 * Checks if the given operation queue is empty or not
588 * @param opq the operation queue
589 * @return GNUNET_YES if the given operation queue has no operations; GNUNET_NO
593 is_queue_empty (struct OperationQueue *opq)
595 if ( (NULL != opq->wq_head)
596 || (NULL != opq->rq_head)
597 || (NULL != opq->aq_head)
598 || (NULL != opq->nq_head) )
605 * Checks if the given operation queue has enough resources to provide for the
606 * operation of the given queue entry. It also checks if any inactive
607 * operations are to be released in order to accommodate the needed resources
608 * and returns them as an array.
610 * @param opq the operation queue to check for resource accommodation
611 * @param entry the operation queue entry whose operation's resources are to be
613 * @param ops_ pointer to return the array of operations which are to be released
614 * in order to accommodate the new operation. Can be NULL
615 * @param n_ops_ the number of operations in ops_
616 * @return GNUNET_YES if the given entry's operation can be accommodated in this
617 * queue. GNUNET_NO if it cannot be accommodated; ops_ and n_ops_ will
618 * be set to NULL and 0 respectively.
621 decide_capacity (struct OperationQueue *opq,
622 struct QueueEntry *entry,
623 struct GNUNET_TESTBED_Operation ***ops_,
624 unsigned int *n_ops_)
626 struct QueueEntry **evict_entries;
627 struct GNUNET_TESTBED_Operation **ops;
628 struct GNUNET_TESTBED_Operation *op;
630 unsigned int n_evict_entries;
636 GNUNET_assert (NULL != (op = entry->op));
637 GNUNET_assert (0 < (need = entry->nres));
640 evict_entries = NULL;
643 if (OPERATION_QUEUE_TYPE_ADAPTIVE == opq->type)
645 GNUNET_assert (NULL != opq->fctx);
646 GNUNET_assert (opq->max_active >= opq->overload);
647 max = opq->max_active - opq->overload;
650 max = opq->max_active;
651 if (opq->active > max)
656 if ((opq->active + need) <= max)
658 deficit = need - (max - opq->active);
659 for (entry = opq->nq_head;
660 (0 < deficit) && (NULL != entry);
663 GNUNET_array_append (evict_entries, n_evict_entries, entry);
664 deficit -= entry->nres;
671 for (n_ops = 0; n_ops < n_evict_entries;)
673 op = evict_entries[n_ops]->op;
674 GNUNET_array_append (ops, n_ops, op); /* increments n-ops */
678 GNUNET_free_non_null (evict_entries);
690 * Merges an array of operations into another, eliminating duplicates. No
691 * ordering is guaranteed.
693 * @param old the array into which the merging is done.
694 * @param n_old the number of operations in old array
695 * @param new the array from which operations are to be merged
696 * @param n_new the number of operations in new array
699 merge_ops (struct GNUNET_TESTBED_Operation ***old,
701 struct GNUNET_TESTBED_Operation **new,
704 struct GNUNET_TESTBED_Operation **cur;
709 GNUNET_assert (NULL != old);
712 for (i = 0; i < n_new; i++)
714 for (j = 0; j < *n_old; j++)
716 if (new[i] == cur[j])
721 GNUNET_array_append (cur, n_cur, new[j]);
730 * Checks for the readiness of an operation and schedules a operation start task
732 * @param op the operation
735 check_readiness (struct GNUNET_TESTBED_Operation *op)
737 struct GNUNET_TESTBED_Operation **evict_ops;
738 struct GNUNET_TESTBED_Operation **ops;
740 unsigned int n_evict_ops;
743 GNUNET_assert (NULL == op->rq_entry);
744 GNUNET_assert (OP_STATE_WAITING == op->state);
747 for (i = 0; i < op->nqueues; i++)
751 if (GNUNET_NO == decide_capacity (op->queues[i], op->qentries[i],
754 GNUNET_free_non_null (evict_ops);
759 merge_ops (&evict_ops, &n_evict_ops, ops, n_ops);
762 if (NULL != evict_ops)
764 for (i = 0; i < n_evict_ops; i++)
765 GNUNET_TESTBED_operation_release_ (evict_ops[i]);
766 GNUNET_free (evict_ops);
768 /* Evicting the operations should schedule this operation */
769 GNUNET_assert (OP_STATE_READY == op->state);
772 for (i = 0; i < op->nqueues; i++)
773 op->queues[i]->active += op->nres[i];
774 change_state (op, OP_STATE_READY);
781 * Defers a ready to be executed operation back to waiting
783 * @param op the operation to defer
786 defer (struct GNUNET_TESTBED_Operation *op)
790 GNUNET_assert (OP_STATE_READY == op->state);
792 for (i = 0; i < op->nqueues; i++)
794 GNUNET_assert (op->queues[i]->active >= op->nres[i]);
795 op->queues[i]->active -= op->nres[i];
797 change_state (op, OP_STATE_WAITING);
802 * Cleanups the array of timeslots of an operation queue. For each time slot in
803 * the array, if it is allocated to an operation, it will be deallocated from
806 * @param queue the operation queue
809 cleanup_tslots (struct OperationQueue *queue)
811 struct FeedbackCtx *fctx = queue->fctx;
812 struct TimeSlot *tslot;
813 struct GNUNET_TESTBED_Operation *op;
816 GNUNET_assert (NULL != fctx);
817 for (cnt = 0; cnt < queue->max_active; cnt++)
819 tslot = &fctx->tslots_freeptr[cnt];
823 GNUNET_CONTAINER_DLL_remove (op->tslots_head, op->tslots_tail, tslot);
825 GNUNET_free_non_null (fctx->tslots_freeptr);
826 fctx->tslots_freeptr = NULL;
827 fctx->alloc_head = NULL;
828 fctx->alloc_tail = NULL;
829 fctx->tslots_filled = 0;
834 * Cleansup the existing timing slots and sets new timing slots in the given
835 * queue to accommodate given number of max active operations.
837 * @param queue the queue
838 * @param n the number of maximum active operations. If n is greater than the
839 * maximum limit set while creating the queue, then the minimum of these two
840 * will be selected as n
843 adaptive_queue_set_max_active (struct OperationQueue *queue, unsigned int n)
845 struct FeedbackCtx *fctx = queue->fctx;
846 struct TimeSlot *tslot;
849 cleanup_tslots (queue);
850 n = GNUNET_MIN (n ,fctx->max_active_bound);
851 fctx->tslots_freeptr = GNUNET_malloc (n * sizeof (struct TimeSlot));
853 FPRINTF (stderr, "Parallelism: %u\n", n);
854 for (cnt = 0; cnt < n; cnt++)
856 tslot = &fctx->tslots_freeptr[cnt];
857 tslot->queue = queue;
858 GNUNET_CONTAINER_DLL_insert_tail (fctx->alloc_head, fctx->alloc_tail, tslot);
860 GNUNET_TESTBED_operation_queue_reset_max_active_ (queue, n);
865 * Adapts parallelism in an adaptive queue by using the statistical data from
866 * the feedback context.
868 * @param queue the queue
871 adapt_parallelism (struct OperationQueue *queue)
873 struct GNUNET_TIME_Relative avg;
874 struct FeedbackCtx *fctx;
875 struct TimeSlot *tslot;
879 unsigned int parallelism;
881 avg = GNUNET_TIME_UNIT_ZERO;
884 for (cnt = 0; cnt < queue->max_active; cnt++)
886 tslot = &fctx->tslots_freeptr[cnt];
887 avg = GNUNET_TIME_relative_add (avg, tslot->tsum);
888 nvals += tslot->nvals;
890 GNUNET_assert (nvals >= queue->max_active);
891 GNUNET_assert (fctx->nfailed <= nvals);
892 nvals -= fctx->nfailed;
895 if (1 == queue->max_active)
896 adaptive_queue_set_max_active (queue, 1);
898 adaptive_queue_set_max_active (queue, queue->max_active / 2);
901 avg = GNUNET_TIME_relative_divide (avg, nvals);
902 GNUNET_TESTBED_SD_add_data_ (fctx->sd, (unsigned int) avg.rel_value_us);
904 GNUNET_TESTBED_SD_deviation_factor_ (fctx->sd,
905 (unsigned int) avg.rel_value_us,
908 adaptive_queue_set_max_active (queue, queue->max_active); /* no change */
914 parallelism = queue->max_active + 1;
916 parallelism = queue->max_active * 2;
918 parallelism = queue->max_active - 1;
920 parallelism = queue->max_active / 2;
921 parallelism = GNUNET_MAX (parallelism, ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE);
922 adaptive_queue_set_max_active (queue, parallelism);
928 GNUNET_assert (0 <= sd);
929 //GNUNET_TESTBED_SD_add_data_ (fctx->sd, (unsigned int) avg.rel_value_us);
932 adaptive_queue_set_max_active (queue, queue->max_active * 2);
937 adaptive_queue_set_max_active (queue, queue->max_active + 1);
940 if (1 == queue->max_active)
942 adaptive_queue_set_max_active (queue, 1);
947 adaptive_queue_set_max_active (queue, queue->max_active - 1);
950 adaptive_queue_set_max_active (queue, queue->max_active / 2);
956 * update tslots with the operation's completion time. Additionally, if
957 * updating a timeslot makes all timeslots filled in an adaptive operation
958 * queue, call adapt_parallelism() for that queue.
960 * @param op the operation
963 update_tslots (struct GNUNET_TESTBED_Operation *op)
965 struct OperationQueue *queue;
966 struct GNUNET_TIME_Relative t;
967 struct TimeSlot *tslot;
968 struct FeedbackCtx *fctx;
971 t = GNUNET_TIME_absolute_get_duration (op->tstart);
972 while (NULL != (tslot = op->tslots_head)) /* update time slots */
974 queue = tslot->queue;
976 GNUNET_CONTAINER_DLL_remove (op->tslots_head, op->tslots_tail, tslot);
978 GNUNET_CONTAINER_DLL_insert_tail (fctx->alloc_head, fctx->alloc_tail,
983 for (i = 0; i < op->nqueues; i++)
984 if (queue == op->queues[i])
986 GNUNET_assert (i != op->nqueues);
987 op->queues[i]->overload += op->nres[i];
989 tslot->tsum = GNUNET_TIME_relative_add (tslot->tsum, t);
990 if (0 != tslot->nvals++)
992 fctx->tslots_filled++;
993 if (queue->max_active == fctx->tslots_filled)
994 adapt_parallelism (queue);
1000 * Create an 'operation' to be performed.
1002 * @param cls closure for the callbacks
1003 * @param start function to call to start the operation
1004 * @param release function to call to close down the operation
1005 * @return handle to the operation
1007 struct GNUNET_TESTBED_Operation *
1008 GNUNET_TESTBED_operation_create_ (void *cls, OperationStart start,
1009 OperationRelease release)
1011 struct GNUNET_TESTBED_Operation *op;
1013 op = GNUNET_new (struct GNUNET_TESTBED_Operation);
1015 op->state = OP_STATE_INIT;
1016 op->release = release;
1023 * Create an operation queue.
1025 * @param type the type of operation queue
1026 * @param max_active maximum number of operations in this
1027 * queue that can be active in parallel at the same time
1028 * @return handle to the queue
1030 struct OperationQueue *
1031 GNUNET_TESTBED_operation_queue_create_ (enum OperationQueueType type,
1032 unsigned int max_active)
1034 struct OperationQueue *queue;
1035 struct FeedbackCtx *fctx;
1037 queue = GNUNET_new (struct OperationQueue);
1039 if (OPERATION_QUEUE_TYPE_FIXED == type)
1041 queue->max_active = max_active;
1045 fctx = GNUNET_new (struct FeedbackCtx);
1046 fctx->max_active_bound = max_active;
1047 fctx->sd = GNUNET_TESTBED_SD_init_ (ADAPTIVE_QUEUE_DEFAULT_HISTORY);
1049 adaptive_queue_set_max_active (queue, ADAPTIVE_QUEUE_DEFAULT_MAX_ACTIVE);
1056 * Destroy an operation queue. The queue MUST be empty
1059 * @param queue queue to destroy
1062 GNUNET_TESTBED_operation_queue_destroy_ (struct OperationQueue *queue)
1064 struct FeedbackCtx *fctx;
1066 GNUNET_break (GNUNET_YES == is_queue_empty (queue));
1067 if (OPERATION_QUEUE_TYPE_ADAPTIVE == queue->type)
1069 cleanup_tslots (queue);
1071 GNUNET_TESTBED_SD_destroy_ (fctx->sd);
1074 GNUNET_free (queue);
1079 * Destroys the operation queue if it is empty. If not empty return GNUNET_NO.
1081 * @param queue the queue to destroy if empty
1082 * @return GNUNET_YES if the queue is destroyed. GNUNET_NO if not (because it
1086 GNUNET_TESTBED_operation_queue_destroy_empty_ (struct OperationQueue *queue)
1088 if (GNUNET_NO == is_queue_empty (queue))
1090 GNUNET_TESTBED_operation_queue_destroy_ (queue);
1096 * Rechecks if any of the operations in the given operation queue's waiting list
1097 * can be made active
1099 * @param opq the operation queue
1102 recheck_waiting (struct OperationQueue *opq)
1104 struct QueueEntry *entry;
1105 struct QueueEntry *entry2;
1107 entry = opq->wq_head;
1108 while (NULL != entry)
1110 entry2 = entry->next;
1111 if (GNUNET_NO == check_readiness (entry->op))
1119 * Function to reset the maximum number of operations in the given queue. If
1120 * max_active is lesser than the number of currently active operations, the
1121 * active operations are not stopped immediately.
1123 * @param queue the operation queue which has to be modified
1124 * @param max_active the new maximum number of active operations
1127 GNUNET_TESTBED_operation_queue_reset_max_active_ (struct OperationQueue *queue,
1128 unsigned int max_active)
1130 struct QueueEntry *entry;
1132 queue->max_active = max_active;
1133 queue->overload = 0;
1134 while ( (queue->active > queue->max_active)
1135 && (NULL != (entry = queue->rq_head)) )
1137 recheck_waiting (queue);
1142 * Add an operation to a queue. An operation can be in multiple queues at
1143 * once. Once the operation is inserted into all the queues
1144 * GNUNET_TESTBED_operation_begin_wait_() has to be called to actually start
1145 * waiting for the operation to become active.
1147 * @param queue queue to add the operation to
1148 * @param op operation to add to the queue
1149 * @param nres the number of units of the resources of queue needed by the
1150 * operation. Should be greater than 0.
1153 GNUNET_TESTBED_operation_queue_insert2_ (struct OperationQueue *queue,
1154 struct GNUNET_TESTBED_Operation *op,
1159 GNUNET_assert (0 < nres);
1160 qsize = op->nqueues;
1161 GNUNET_array_append (op->queues, op->nqueues, queue);
1162 GNUNET_array_append (op->nres, qsize, nres);
1163 GNUNET_assert (qsize == op->nqueues);
1168 * Add an operation to a queue. An operation can be in multiple queues at
1169 * once. Once the operation is inserted into all the queues
1170 * GNUNET_TESTBED_operation_begin_wait_() has to be called to actually start
1171 * waiting for the operation to become active. The operation is assumed to take
1172 * 1 queue resource. Use GNUNET_TESTBED_operation_queue_insert2_() if it
1173 * requires more than 1
1175 * @param queue queue to add the operation to
1176 * @param op operation to add to the queue
1179 GNUNET_TESTBED_operation_queue_insert_ (struct OperationQueue *queue,
1180 struct GNUNET_TESTBED_Operation *op)
1182 return GNUNET_TESTBED_operation_queue_insert2_ (queue, op, 1);
1187 * Marks the given operation as waiting on the queues. Once all queues permit
1188 * the operation to become active, the operation will be activated. The actual
1189 * activation will occur in a separate task (thus allowing multiple queue
1190 * insertions to be made without having the first one instantly trigger the
1191 * operation if the first queue has sufficient resources).
1193 * @param op the operation to marks as waiting
1196 GNUNET_TESTBED_operation_begin_wait_ (struct GNUNET_TESTBED_Operation *op)
1198 GNUNET_assert (NULL == op->rq_entry);
1199 change_state (op, OP_STATE_WAITING);
1200 (void) check_readiness (op);
1205 * Marks an active operation as inactive - the operation will be kept in a
1206 * ready-to-be-released state and continues to hold resources until another
1207 * operation contents for them.
1209 * @param op the operation to be marked as inactive. The operation start
1210 * callback should have been called before for this operation to mark
1214 GNUNET_TESTBED_operation_inactivate_ (struct GNUNET_TESTBED_Operation *op)
1216 struct OperationQueue **queues;
1218 unsigned int nqueues;
1221 GNUNET_assert (OP_STATE_ACTIVE == op->state);
1222 change_state (op, OP_STATE_INACTIVE);
1223 nqueues = op->nqueues;
1224 ms = sizeof (struct OperationQueue *) * nqueues;
1225 queues = GNUNET_malloc (ms);
1226 /* Cloning is needed as the operation be released by waiting operations and
1227 hence its nqueues memory ptr will be freed */
1228 GNUNET_assert (NULL != (queues = memcpy (queues, op->queues, ms)));
1229 for (i = 0; i < nqueues; i++)
1230 recheck_waiting (queues[i]);
1231 GNUNET_free (queues);
1236 * Marks and inactive operation as active. This fuction should be called to
1237 * ensure that the oprelease callback will not be called until it is either
1238 * marked as inactive or released.
1240 * @param op the operation to be marked as active
1243 GNUNET_TESTBED_operation_activate_ (struct GNUNET_TESTBED_Operation *op)
1246 GNUNET_assert (OP_STATE_INACTIVE == op->state);
1247 change_state (op, OP_STATE_ACTIVE);
1252 * An operation is 'done' (was cancelled or finished); remove
1253 * it from the queues and release associated resources.
1255 * @param op operation that finished
1258 GNUNET_TESTBED_operation_release_ (struct GNUNET_TESTBED_Operation *op)
1260 struct QueueEntry *entry;
1261 struct OperationQueue *opq;
1264 if (OP_STATE_INIT == op->state)
1269 if (OP_STATE_READY == op->state)
1271 if (OP_STATE_INACTIVE == op->state) /* Activate the operation if inactive */
1272 GNUNET_TESTBED_operation_activate_ (op);
1273 if (OP_STATE_ACTIVE == op->state)
1275 GNUNET_assert (NULL != op->queues);
1276 GNUNET_assert (NULL != op->qentries);
1277 for (i = 0; i < op->nqueues; i++)
1279 entry = op->qentries[i];
1280 remove_queue_entry (op, i);
1281 opq = op->queues[i];
1285 case OP_STATE_INACTIVE:
1288 case OP_STATE_WAITING:
1290 case OP_STATE_ACTIVE:
1291 case OP_STATE_READY:
1292 GNUNET_assert (0 != opq->active);
1293 GNUNET_assert (opq->active >= entry->nres);
1294 opq->active -= entry->nres;
1295 recheck_waiting (opq);
1298 GNUNET_free (entry);
1300 GNUNET_free_non_null (op->qentries);
1301 GNUNET_free (op->queues);
1302 GNUNET_free (op->nres);
1303 if (NULL != op->release)
1304 op->release (op->cb_cls);
1310 * Marks an operation as failed
1312 * @param op the operation to be marked as failed
1315 GNUNET_TESTBED_operation_mark_failed (struct GNUNET_TESTBED_Operation *op)
1317 op->failed = GNUNET_YES;
1321 /* end of testbed_api_operations.c */