2 This file is part of GNUnet
3 (C) 2008--2012 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
27 #include "testbed_api_operations.h"
31 * An entry in the operation queue
36 * The next DLL pointer
38 struct QueueEntry *next;
41 * The prev DLL pointer
43 struct QueueEntry *prev;
46 * The operation this entry holds
48 struct GNUNET_TESTBED_Operation *op;
53 * Queue of operations where we can only support a certain
54 * number of concurrent operations of a particular type.
59 * The head of the operation queue
61 struct QueueEntry *head;
64 * The tail of the operation queue
66 struct QueueEntry *tail;
69 * Number of operations that can be concurrently
70 * active in this queue.
82 * The operation is currently waiting for resources
87 * The operation has started
94 * Opaque handle to an abstract operation to be executed by the testing framework.
96 struct GNUNET_TESTBED_Operation
99 * Function to call when we have the resources to begin the operation.
101 OperationStart start;
104 * Function to call to clean up after the operation (which may or may
105 * not have been started yet).
107 OperationRelease release;
110 * Closure for callbacks.
115 * Array of operation queues this Operation belongs to.
117 struct OperationQueue **queues;
120 * The id of the task which calls OperationStart for this operation
122 GNUNET_SCHEDULER_TaskIdentifier start_task_id;
125 * Number of queues in the operation queues array
127 unsigned int nqueues;
130 * The state of the operation
132 enum OperationState state;
138 * Task for calling OperationStart on operation
140 * @param cls the Operation
141 * @param tc the TaskContext from scheduler
144 call_start (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
146 struct GNUNET_TESTBED_Operation *op = cls;
148 op->start_task_id = GNUNET_SCHEDULER_NO_TASK;
149 op->state = OP_STATE_STARTED;
150 if (NULL != op->start)
152 op->start (op->cb_cls);
158 * Checks for the readiness of an operation and schedules a operation start task
160 * @param op the operation
163 check_readiness (struct GNUNET_TESTBED_Operation *op)
167 if (GNUNET_SCHEDULER_NO_TASK != op->start_task_id)
169 for (i = 0; i < op->nqueues; i++)
171 if (0 == op->queues[i]->active)
174 for (i = 0; i < op->nqueues; i++)
176 op->queues[i]->active--;
178 op->start_task_id = GNUNET_SCHEDULER_add_now (&call_start, op);
183 * Create an 'operation' to be performed.
185 * @param cls closure for the callbacks
186 * @param start function to call to start the operation
187 * @param release function to call to close down the operation
188 * @return handle to the operation
190 struct GNUNET_TESTBED_Operation *
191 GNUNET_TESTBED_operation_create_ (void *cls, OperationStart start,
192 OperationRelease release)
194 struct GNUNET_TESTBED_Operation *op;
196 op = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Operation));
198 op->release = release;
200 op->start_task_id = GNUNET_SCHEDULER_NO_TASK;
206 * Create an operation queue.
208 * @param max_active maximum number of operations in this
209 * queue that can be active in parallel at the same time
210 * @return handle to the queue
212 struct OperationQueue *
213 GNUNET_TESTBED_operation_queue_create_ (unsigned int max_active)
215 struct OperationQueue *queue;
217 queue = GNUNET_malloc (sizeof (struct OperationQueue));
218 queue->active = max_active;
224 * Destroy an operation queue. The queue MUST be empty
227 * @param queue queue to destroy
230 GNUNET_TESTBED_operation_queue_destroy_ (struct OperationQueue *queue)
232 GNUNET_break (NULL == queue->head);
233 GNUNET_break (NULL == queue->tail);
239 * Add an operation to a queue. An operation can be in multiple
240 * queues at once. Once all queues permit the operation to become
241 * active, the operation will be activated. The actual activation
242 * will occur in a separate task (thus allowing multiple queue
243 * insertions to be made without having the first one instantly
244 * trigger the operation if the first queue has sufficient
247 * @param queue queue to add the operation to
248 * @param operation operation to add to the queue
251 GNUNET_TESTBED_operation_queue_insert_ (struct OperationQueue *queue,
252 struct GNUNET_TESTBED_Operation
255 struct QueueEntry *entry;
257 entry = GNUNET_malloc (sizeof (struct QueueEntry));
258 entry->op = operation;
259 GNUNET_CONTAINER_DLL_insert_tail (queue->head, queue->tail, entry);
261 GNUNET_realloc (operation->queues,
262 sizeof (struct OperationQueue *) *
263 (++operation->nqueues));
264 operation->queues[operation->nqueues - 1] = queue;
265 check_readiness (operation);
270 * Remove an operation from a queue. This can be because the
271 * oeration was active and has completed (and the resources have
272 * been released), or because the operation was cancelled and
273 * thus scheduling the operation is no longer required.
275 * @param queue queue to add the operation to
276 * @param operation operation to add to the queue
279 GNUNET_TESTBED_operation_queue_remove_ (struct OperationQueue *queue,
280 struct GNUNET_TESTBED_Operation
283 struct QueueEntry *entry;
284 struct QueueEntry *entry2;
286 for (entry = queue->head; NULL != entry; entry = entry->next)
287 if (entry->op == operation)
289 GNUNET_assert (NULL != entry);
290 if (OP_STATE_STARTED == operation->state)
292 entry2 = entry->next;
293 GNUNET_CONTAINER_DLL_remove (queue->head, queue->tail, entry);
295 for (; NULL != entry2; entry2 = entry2->next)
296 if (OP_STATE_STARTED != entry2->op->state)
300 check_readiness (entry2->op);
305 * An operation is 'done' (was cancelled or finished); remove
306 * it from the queues and release associated resources.
308 * @param operation operation that finished
311 GNUNET_TESTBED_operation_release_ (struct GNUNET_TESTBED_Operation *operation)
315 if (GNUNET_SCHEDULER_NO_TASK != operation->start_task_id)
317 GNUNET_SCHEDULER_cancel (operation->start_task_id);
318 operation->start_task_id = GNUNET_SCHEDULER_NO_TASK;
320 for (i = 0; i < operation->nqueues; i++)
321 GNUNET_TESTBED_operation_queue_remove_ (operation->queues[i], operation);
322 GNUNET_free (operation->queues);
323 if (NULL != operation->release)
324 operation->release (operation->cb_cls);
325 GNUNET_free (operation);
329 /* end of testbed_api_operations.c */