task.c 20.3 KB
Newer Older
Bob Halley's avatar
base  
Bob Halley committed
1

Bob Halley's avatar
Bob Halley committed
2 3
#include "attribute.h"

Bob Halley's avatar
base  
Bob Halley committed
4 5
#include <isc/assertions.h>

Bob Halley's avatar
Bob Halley committed
6
#include <isc/thread.h>
7 8
#include <isc/mutex.h>
#include <isc/condition.h>
Bob Halley's avatar
Bob Halley committed
9
#include <isc/unexpect.h>
Bob Halley's avatar
Bob Halley committed
10
#include <isc/task.h>
Bob Halley's avatar
base  
Bob Halley committed
11

Bob Halley's avatar
Bob Halley committed
12 13 14 15

/***
 *** General Macros.
 ***/
Bob Halley's avatar
base  
Bob Halley committed
16

Bob Halley's avatar
update  
Bob Halley committed
17
/*
Bob Halley's avatar
Bob Halley committed
18
 * We use macros instead of calling the routines directly because
Bob Halley's avatar
update  
Bob Halley committed
19 20 21 22
 * the capital letters make the locking stand out.
 *
 * We INSIST that they succeed since there's no way for us to continue
 * if they fail.
Bob Halley's avatar
update  
Bob Halley committed
23
 */
Bob Halley's avatar
Bob Halley committed
24 25 26 27 28 29 30

#define LOCK(lp) \
	INSIST(isc_mutex_lock((lp)) == ISC_R_SUCCESS);
#define UNLOCK(lp) \
	INSIST(isc_mutex_unlock((lp)) == ISC_R_SUCCESS);
#define BROADCAST(cvp) \
	INSIST(isc_condition_broadcast((cvp)) == ISC_R_SUCCESS);
31 32
#define SIGNAL(cvp) \
	INSIST(isc_condition_signal((cvp)) == ISC_R_SUCCESS);
Bob Halley's avatar
Bob Halley committed
33 34 35 36 37
#define WAIT(cvp, lp) \
	INSIST(isc_condition_wait((cvp), (lp)) == ISC_R_SUCCESS);
#define WAITUNTIL(cvp, lp, tp, bp) \
	INSIST(isc_condition_waituntil((cvp), (lp), (tp), (bp)) == \
	ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
38

Bob Halley's avatar
Bob Halley committed
39
#ifdef ISC_TASK_TRACE
Bob Halley's avatar
Bob Halley committed
40
#define XTRACE(m)		printf("%s task %p thread %p\n", (m), \
Bob Halley's avatar
Bob Halley committed
41
				       task, isc_thread_self())
Bob Halley's avatar
Bob Halley committed
42 43 44
#else
#define XTRACE(m)
#endif
Bob Halley's avatar
base  
Bob Halley committed
45

Bob Halley's avatar
Bob Halley committed
46 47

/***
Bob Halley's avatar
Bob Halley committed
48
 *** Types.
Bob Halley's avatar
Bob Halley committed
49 50
 ***/

Bob Halley's avatar
Bob Halley committed
51 52 53 54 55 56 57 58 59
typedef enum {
	task_state_idle, task_state_ready, task_state_running,
	task_state_shutdown
} task_state_t;

#define TASK_MAGIC			0x5441534BU	/* TASK. */
#define VALID_TASK(t)			((t) != NULL && \
					 (t)->magic == TASK_MAGIC)

Bob Halley's avatar
Bob Halley committed
60
struct isc_task {
Bob Halley's avatar
Bob Halley committed
61 62
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
63
	isc_taskmgr_t			manager;
Bob Halley's avatar
Bob Halley committed
64
	isc_mutex_t			lock;
Bob Halley's avatar
Bob Halley committed
65 66 67
	/* Locked by task lock. */
	task_state_t			state;
	unsigned int			references;
Bob Halley's avatar
Bob Halley committed
68
	isc_eventlist_t			events;
Bob Halley's avatar
Bob Halley committed
69
	unsigned int			quantum;
Bob Halley's avatar
Bob Halley committed
70
	isc_boolean_t			enqueue_allowed;
Bob Halley's avatar
Bob Halley committed
71
	isc_event_t			shutdown_event;
Bob Halley's avatar
Bob Halley committed
72
	/* Locked by task manager lock. */
Bob Halley's avatar
Bob Halley committed
73 74
	LINK(struct isc_task)		link;
	LINK(struct isc_task)		ready_link;
Bob Halley's avatar
Bob Halley committed
75 76 77 78 79 80
};

#define TASK_MANAGER_MAGIC		0x54534B4DU	/* TSKM. */
#define VALID_MANAGER(m)		((m) != NULL && \
					 (m)->magic == TASK_MANAGER_MAGIC)

Bob Halley's avatar
Bob Halley committed
81
struct isc_taskmgr {
Bob Halley's avatar
Bob Halley committed
82 83
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
84
	isc_memctx_t			mctx;
Bob Halley's avatar
Bob Halley committed
85
	isc_mutex_t			lock;
Bob Halley's avatar
Bob Halley committed
86 87
	/* Locked by task manager lock. */
	unsigned int			default_quantum;
Bob Halley's avatar
Bob Halley committed
88 89
	LIST(struct isc_task)		tasks;
	LIST(struct isc_task)		ready_tasks;
Bob Halley's avatar
Bob Halley committed
90
	isc_condition_t			work_available;
Bob Halley's avatar
Bob Halley committed
91
	isc_boolean_t			exiting;
Bob Halley's avatar
Bob Halley committed
92
	unsigned int			workers;
Bob Halley's avatar
Bob Halley committed
93
	isc_condition_t			no_workers;
Bob Halley's avatar
Bob Halley committed
94
};
Bob Halley's avatar
Bob Halley committed
95

Bob Halley's avatar
Bob Halley committed
96 97
#define DEFAULT_DEFAULT_QUANTUM		5
#define FINISHED(m)			((m)->exiting && EMPTY((m)->tasks))
Bob Halley's avatar
Bob Halley committed
98

Bob Halley's avatar
update  
Bob Halley committed
99 100 101 102 103

/***
 *** Events.
 ***/

Bob Halley's avatar
Bob Halley committed
104
static inline isc_event_t
Bob Halley's avatar
Bob Halley committed
105
event_allocate(isc_memctx_t mctx, void *sender, isc_eventtype_t type,
Bob Halley's avatar
Bob Halley committed
106
	       isc_taskaction_t action, void *arg, size_t size)
Bob Halley's avatar
update  
Bob Halley committed
107
{
Bob Halley's avatar
Bob Halley committed
108
	isc_event_t event;
Bob Halley's avatar
update  
Bob Halley committed
109

Bob Halley's avatar
Bob Halley committed
110
	event = isc_mem_get(mctx, size);
Bob Halley's avatar
update  
Bob Halley committed
111 112 113 114
	if (event == NULL)
		return (NULL);
	event->mctx = mctx;
	event->size = size;
Bob Halley's avatar
Bob Halley committed
115
	event->sender = sender;
Bob Halley's avatar
update  
Bob Halley committed
116 117 118 119 120 121 122
	event->type = type;
	event->action = action;
	event->arg = arg;

	return (event);
}

Bob Halley's avatar
Bob Halley committed
123
isc_event_t
Bob Halley's avatar
Bob Halley committed
124 125
isc_event_allocate(isc_memctx_t mctx, void *sender, isc_eventtype_t type,
		   isc_taskaction_t action, void *arg, size_t size)
Bob Halley's avatar
update  
Bob Halley committed
126
{
Bob Halley's avatar
Bob Halley committed
127
	if (size < sizeof (struct isc_event))
Bob Halley's avatar
update  
Bob Halley committed
128 129 130 131 132 133
		return (NULL);
	if (type < 0)
		return (NULL);
	if (action == NULL)
		return (NULL);

Bob Halley's avatar
Bob Halley committed
134
	return (event_allocate(mctx, sender, type, action, arg, size));
Bob Halley's avatar
update  
Bob Halley committed
135 136 137
}

void
Bob Halley's avatar
Bob Halley committed
138 139
isc_event_free(isc_event_t *eventp) {
	isc_event_t event;
Bob Halley's avatar
update  
Bob Halley committed
140 141 142 143 144
	
	REQUIRE(eventp != NULL);
	event = *eventp;
	REQUIRE(event != NULL);

Bob Halley's avatar
Bob Halley committed
145
	isc_mem_put(event->mctx, event, event->size);
Bob Halley's avatar
update  
Bob Halley committed
146 147 148 149

	*eventp = NULL;
}

Bob Halley's avatar
base  
Bob Halley committed
150 151 152 153 154
/***
 *** Tasks.
 ***/

static void
Bob Halley's avatar
Bob Halley committed
155 156
task_free(isc_task_t task) {
	isc_taskmgr_t manager = task->manager;
Bob Halley's avatar
base  
Bob Halley committed
157

Bob Halley's avatar
Bob Halley committed
158
	XTRACE("free task");
Bob Halley's avatar
base  
Bob Halley committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172
	REQUIRE(EMPTY(task->events));

	LOCK(&manager->lock);
	UNLINK(manager->tasks, task, link);
	if (FINISHED(manager)) {
		/*
		 * All tasks have completed and the
		 * task manager is exiting.  Wake up
		 * any idle worker threads so they
		 * can exit.
		 */
		BROADCAST(&manager->work_available);
	}
	UNLOCK(&manager->lock);
Bob Halley's avatar
Bob Halley committed
173
	(void)isc_mutex_destroy(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
174
	if (task->shutdown_event != NULL)
Bob Halley's avatar
Bob Halley committed
175
		isc_event_free(&task->shutdown_event);
Bob Halley's avatar
base  
Bob Halley committed
176
	task->magic = 0;
Bob Halley's avatar
Bob Halley committed
177
	isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
178 179
}

Bob Halley's avatar
Bob Halley committed
180
isc_result_t
Bob Halley's avatar
Bob Halley committed
181 182
isc_task_create(isc_taskmgr_t manager, isc_taskaction_t shutdown_action,
		void *shutdown_arg, unsigned int quantum, isc_task_t *taskp)
Bob Halley's avatar
Bob Halley committed
183
{
Bob Halley's avatar
Bob Halley committed
184
	isc_task_t task;
Bob Halley's avatar
base  
Bob Halley committed
185 186 187 188

	REQUIRE(VALID_MANAGER(manager));
	REQUIRE(taskp != NULL && *taskp == NULL);

Bob Halley's avatar
Bob Halley committed
189
	task = isc_mem_get(manager->mctx, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
190
	if (task == NULL)
Bob Halley's avatar
Bob Halley committed
191
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
192 193 194

	task->magic = TASK_MAGIC;
	task->manager = manager;
Bob Halley's avatar
Bob Halley committed
195
	if (isc_mutex_init(&task->lock) != ISC_R_SUCCESS) {
Bob Halley's avatar
Bob Halley committed
196
		isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
Bob Halley committed
197 198 199
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_mutex_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
200
	}
Bob Halley's avatar
base  
Bob Halley committed
201 202 203 204
	task->state = task_state_idle;
	task->references = 1;
	INIT_LIST(task->events);
	task->quantum = quantum;
Bob Halley's avatar
Bob Halley committed
205
	task->enqueue_allowed = ISC_TRUE;
Bob Halley's avatar
update  
Bob Halley committed
206
	task->shutdown_event = event_allocate(manager->mctx,
Bob Halley's avatar
Bob Halley committed
207
					      NULL,
Bob Halley's avatar
Bob Halley committed
208
					      ISC_TASKEVENT_SHUTDOWN,
Bob Halley's avatar
update  
Bob Halley committed
209 210 211 212
					      shutdown_action,
					      shutdown_arg,
					      sizeof *task->shutdown_event);
	if (task->shutdown_event == NULL) {
Bob Halley's avatar
Bob Halley committed
213
		(void)isc_mutex_destroy(&task->lock);
Bob Halley's avatar
Bob Halley committed
214
		isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
Bob Halley committed
215
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
update  
Bob Halley committed
216
	}
Bob Halley's avatar
base  
Bob Halley committed
217 218 219 220 221 222 223 224 225 226 227
	INIT_LINK(task, link);
	INIT_LINK(task, ready_link);

	LOCK(&manager->lock);
	if (task->quantum == 0)
		task->quantum = manager->default_quantum;
	APPEND(manager->tasks, task, link);
	UNLOCK(&manager->lock);

	*taskp = task;

Bob Halley's avatar
Bob Halley committed
228
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
229 230
}

Bob Halley's avatar
update  
Bob Halley committed
231
void
Bob Halley's avatar
Bob Halley committed
232
isc_task_attach(isc_task_t task, isc_task_t *taskp) {
Bob Halley's avatar
base  
Bob Halley committed
233 234 235 236 237 238 239 240 241 242 243

	REQUIRE(VALID_TASK(task));
	REQUIRE(taskp != NULL && *taskp == NULL);

	LOCK(&task->lock);
	task->references++;
	UNLOCK(&task->lock);

	*taskp = task;
}

Bob Halley's avatar
Bob Halley committed
244
void
Bob Halley's avatar
Bob Halley committed
245
isc_task_detach(isc_task_t *taskp) {
Bob Halley's avatar
Bob Halley committed
246
	isc_boolean_t free_task = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
247
	isc_task_t task;
Bob Halley's avatar
base  
Bob Halley committed
248

Bob Halley's avatar
Bob Halley committed
249
	XTRACE("isc_task_detach");
Bob Halley's avatar
base  
Bob Halley committed
250 251 252 253 254 255 256 257

	REQUIRE(taskp != NULL);
	task = *taskp;
	REQUIRE(VALID_TASK(task));

	LOCK(&task->lock);
	REQUIRE(task->references > 0);
	task->references--;
258
	if (task->state == task_state_shutdown && task->references == 0)
Bob Halley's avatar
Bob Halley committed
259
		free_task = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
260 261 262 263 264 265 266 267
	UNLOCK(&task->lock);

	if (free_task)
		task_free(task);

	*taskp = NULL;
}

Bob Halley's avatar
Bob Halley committed
268
void
Bob Halley's avatar
Bob Halley committed
269
isc_task_send(isc_task_t task, isc_event_t *eventp) {
Bob Halley's avatar
Bob Halley committed
270 271
	isc_boolean_t was_idle = ISC_FALSE;
	isc_boolean_t discard = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
272
	isc_event_t event;
Bob Halley's avatar
base  
Bob Halley committed
273 274

	REQUIRE(VALID_TASK(task));
Bob Halley's avatar
update  
Bob Halley committed
275 276
	REQUIRE(eventp != NULL);
	event = *eventp;
Bob Halley's avatar
base  
Bob Halley committed
277
	REQUIRE(event != NULL);
Bob Halley's avatar
Bob Halley committed
278 279
	REQUIRE(event->sender != NULL);
	REQUIRE(event->type > 0);
Bob Halley's avatar
base  
Bob Halley committed
280

Bob Halley's avatar
Bob Halley committed
281
	XTRACE("sending");
Bob Halley's avatar
base  
Bob Halley committed
282 283 284 285 286 287
	/*
	 * We're trying hard to hold locks for as short a time as possible.
	 * We're also trying to hold as few locks as possible.  This is why
	 * some processing is deferred until after a lock is released.
	 */
	LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
288
	if (task->enqueue_allowed) {
Bob Halley's avatar
base  
Bob Halley committed
289
		if (task->state == task_state_idle) {
Bob Halley's avatar
Bob Halley committed
290
			was_idle = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
291 292 293 294 295 296 297
			INSIST(EMPTY(task->events));
			task->state = task_state_ready;
		}
		INSIST(task->state == task_state_ready ||
		       task->state == task_state_running);
		ENQUEUE(task->events, event, link);
	} else
Bob Halley's avatar
Bob Halley committed
298
		discard = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
299 300 301
	UNLOCK(&task->lock);

	if (discard) {
Bob Halley's avatar
Bob Halley committed
302
		isc_event_free(&event);
Bob Halley's avatar
update  
Bob Halley committed
303
		*eventp = NULL;
Bob Halley's avatar
Bob Halley committed
304
		return;
Bob Halley's avatar
base  
Bob Halley committed
305 306 307
	}

	if (was_idle) {
Bob Halley's avatar
Bob Halley committed
308
		isc_taskmgr_t manager;
Bob Halley's avatar
base  
Bob Halley committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332

		/*
		 * We need to add this task to the ready queue.
		 *
		 * We've waited until now to do it, rather than doing it
		 * while holding the task lock, because we don't want to
		 * block while holding the task lock.
		 *
		 * We've changed the state to ready, so no one else will
		 * be trying to add this task to the ready queue.  It
		 * thus doesn't matter if more events have been added to
		 * the queue after we gave up the task lock.
		 *
		 * Shutting down a task requires posting a shutdown event
		 * to the task's queue and then executing it, so there's
		 * no way the task can disappear.  A task is always on the
		 * task manager's 'tasks' list, so the task manager can
		 * always post a shutdown event to all tasks if it is
		 * requested to shutdown.
		 */
		manager = task->manager;
		INSIST(VALID_MANAGER(manager));
		LOCK(&manager->lock);
		ENQUEUE(manager->ready_tasks, task, ready_link);
333
		SIGNAL(&manager->work_available);
Bob Halley's avatar
base  
Bob Halley committed
334 335 336
		UNLOCK(&manager->lock);
	}

Bob Halley's avatar
update  
Bob Halley committed
337 338
	*eventp = NULL;

Bob Halley's avatar
Bob Halley committed
339
	XTRACE("sent");
Bob Halley's avatar
base  
Bob Halley committed
340 341
}

Bob Halley's avatar
Bob Halley committed
342
void
Bob Halley's avatar
Bob Halley committed
343 344 345
isc_task_purge(isc_task_t task, void *sender, isc_eventtype_t type) {
	isc_event_t event, next_event;
	isc_eventlist_t purgeable;
Bob Halley's avatar
Bob Halley committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

	REQUIRE(VALID_TASK(task));
	REQUIRE(type >= 0);

	/*
	 * Purge events matching 'sender' and 'type'.  sender == NULL means
	 * "any sender".  type == NULL means any type.  Task manager events
	 * cannot be purged.
	 */

	INIT_LIST(purgeable);

	LOCK(&task->lock);
	for (event = HEAD(task->events);
	     event != NULL;
	     event = next_event) {
		next_event = NEXT(event, link);
		if ((sender == NULL || event->sender == sender) &&
		    ((type == 0 && event->type > 0) || event->type == type)) {
			DEQUEUE(task->events, event, link);
			ENQUEUE(purgeable, event, link);
		}
	}
	UNLOCK(&task->lock);

	for (event = HEAD(purgeable);
	     event != NULL;
	     event = next_event) {
		next_event = NEXT(event, link);
Bob Halley's avatar
Bob Halley committed
375
		isc_event_free(&event);
Bob Halley's avatar
Bob Halley committed
376 377 378
	}
}

Bob Halley's avatar
Bob Halley committed
379
void
Bob Halley's avatar
Bob Halley committed
380
isc_task_shutdown(isc_task_t task) {
Bob Halley's avatar
Bob Halley committed
381 382
	isc_boolean_t was_idle = ISC_FALSE;
	isc_boolean_t discard = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
383 384 385 386

	REQUIRE(VALID_TASK(task));

	/*
Bob Halley's avatar
Bob Halley committed
387
	 * This routine is very similar to isc_task_send_event() above.
Bob Halley's avatar
base  
Bob Halley committed
388 389 390
	 */

	LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
391
	if (task->enqueue_allowed) {
Bob Halley's avatar
base  
Bob Halley committed
392
		if (task->state == task_state_idle) {
Bob Halley's avatar
Bob Halley committed
393
			was_idle = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
394 395 396 397 398
			INSIST(EMPTY(task->events));
			task->state = task_state_ready;
		}
		INSIST(task->state == task_state_ready ||
		       task->state == task_state_running);
Bob Halley's avatar
update  
Bob Halley committed
399 400 401
		INSIST(task->shutdown_event != NULL);
		ENQUEUE(task->events, task->shutdown_event, link);
		task->shutdown_event = NULL;
Bob Halley's avatar
Bob Halley committed
402
		task->enqueue_allowed = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
403
	} else
Bob Halley's avatar
Bob Halley committed
404
		discard = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
405 406
	UNLOCK(&task->lock);

Bob Halley's avatar
Bob Halley committed
407
	if (discard)
Bob Halley's avatar
Bob Halley committed
408
		return;
Bob Halley's avatar
base  
Bob Halley committed
409 410

	if (was_idle) {
Bob Halley's avatar
Bob Halley committed
411
		isc_taskmgr_t manager;
Bob Halley's avatar
base  
Bob Halley committed
412 413 414 415 416

		manager = task->manager;
		INSIST(VALID_MANAGER(manager));
		LOCK(&manager->lock);
		ENQUEUE(manager->ready_tasks, task, ready_link);
417
		SIGNAL(&manager->work_available);
Bob Halley's avatar
base  
Bob Halley committed
418 419
		UNLOCK(&manager->lock);
	}
Bob Halley's avatar
Bob Halley committed
420
}
Bob Halley's avatar
base  
Bob Halley committed
421

Bob Halley's avatar
Bob Halley committed
422
void
Bob Halley's avatar
Bob Halley committed
423
isc_task_destroy(isc_task_t *taskp) {
Bob Halley's avatar
Bob Halley committed
424 425 426

	REQUIRE(taskp != NULL);

Bob Halley's avatar
Bob Halley committed
427 428
	isc_task_shutdown(*taskp);
	isc_task_detach(taskp);
Bob Halley's avatar
base  
Bob Halley committed
429 430 431
}


Bob Halley's avatar
Bob Halley committed
432

Bob Halley's avatar
base  
Bob Halley committed
433 434 435 436 437
/***
 *** Task Manager.
 ***/

static
Bob Halley's avatar
Bob Halley committed
438 439 440
void *run(void *uap) {
	isc_taskmgr_t manager = uap;
	isc_task_t task;
Bob Halley's avatar
Bob Halley committed
441
	isc_boolean_t no_workers = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
442

Bob Halley's avatar
Bob Halley committed
443
	XTRACE("start");
Bob Halley's avatar
base  
Bob Halley committed
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500

	REQUIRE(VALID_MANAGER(manager));

	/*
	 * Again we're trying to hold the lock for as short a time as possible
	 * and to do as little locking and unlocking as possible.
	 * 
	 * In both while loops, the appropriate lock must be held before the
	 * while body starts.  Code which acquired the lock at the top of
	 * the loop would be more readable, but would result in a lot of
	 * extra locking.  Compare:
	 *
	 * Straightforward:
	 *
	 *	LOCK();
	 *	...
	 *	UNLOCK();
	 *	while (expression) {
	 *		LOCK();
	 *		...
	 *		UNLOCK();
	 *
	 *	       	Unlocked part here...
	 *
	 *		LOCK();
	 *		...
	 *		UNLOCK();
	 *	}
	 *
	 * Note how if the loop continues we unlock and then immediately lock.
	 * For N iterations of the loop, this code does 2N+1 locks and 2N+1
	 * unlocks.  Also note that the lock is not held when the while
	 * condition is tested, which may or may not be important, depending
	 * on the expression.
	 * 
	 * As written:
	 *
	 *	LOCK();
	 *	while (expression) {
	 *		...
	 *		UNLOCK();
	 *
	 *	       	Unlocked part here...
	 *
	 *		LOCK();
	 *		...
	 *	}
	 *	UNLOCK();
	 *
	 * For N iterations of the loop, this code does N+1 locks and N+1
	 * unlocks.  The while expression is always protected by the lock.
	 */

	LOCK(&manager->lock);
	while (!FINISHED(manager)) {
		/*
		 * For reasons similar to those given in the comment in
Bob Halley's avatar
Bob Halley committed
501
		 * isc_task_send_event() above, it is safe for us to dequeue
Bob Halley's avatar
base  
Bob Halley committed
502 503 504 505 506
		 * the task while only holding the manager lock, and then
		 * change the task to running state while only holding the
		 * task lock.
		 */
		while (EMPTY(manager->ready_tasks) && !FINISHED(manager)) {
Bob Halley's avatar
Bob Halley committed
507
			XTRACE("wait");
Bob Halley's avatar
base  
Bob Halley committed
508
			WAIT(&manager->work_available, &manager->lock);
Bob Halley's avatar
Bob Halley committed
509
			XTRACE("awake");
Bob Halley's avatar
base  
Bob Halley committed
510
		}
Bob Halley's avatar
Bob Halley committed
511
		XTRACE("working");
Bob Halley's avatar
base  
Bob Halley committed
512 513 514
		
		task = HEAD(manager->ready_tasks);
		if (task != NULL) {
Bob Halley's avatar
Bob Halley committed
515
			unsigned int dispatch_count = 0;
Bob Halley's avatar
Bob Halley committed
516 517 518 519 520
			isc_boolean_t done = ISC_FALSE;
			isc_boolean_t requeue = ISC_FALSE;
			isc_boolean_t wants_shutdown;
			isc_boolean_t is_shutdown;
			isc_boolean_t free_task = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
521 522
			isc_event_t event;
			isc_eventlist_t remaining_events;
Bob Halley's avatar
Bob Halley committed
523
			isc_boolean_t discard_remaining = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
524 525 526 527 528 529 530 531 532 533 534 535

			INSIST(VALID_TASK(task));

			/*
			 * Note we only unlock the manager lock if we actually
			 * have a task to do.  We must reacquire the manager 
			 * lock before exiting the 'if (task != NULL)' block.
			 */
			DEQUEUE(manager->ready_tasks, task, ready_link);
			UNLOCK(&manager->lock);

			LOCK(&task->lock);
Bob Halley's avatar
Bob Halley committed
536 537 538 539 540 541 542 543
			INSIST(task->state == task_state_ready);
			if (EMPTY(task->events)) {
				/*
				 * The task became runnable, but all events
				 * in the run queue were subsequently purged.
				 * Put the task to sleep.
				 */
				task->state = task_state_idle;
Bob Halley's avatar
Bob Halley committed
544
				done = ISC_TRUE;
Bob Halley's avatar
Bob Halley committed
545 546 547
				XTRACE("ready but empty");
			} else
				task->state = task_state_running;
Bob Halley's avatar
base  
Bob Halley committed
548
			while (!done) {
Bob Halley's avatar
update  
Bob Halley committed
549 550 551
				INSIST(!EMPTY(task->events));
				event = HEAD(task->events);
				DEQUEUE(task->events, event, link);
Bob Halley's avatar
base  
Bob Halley committed
552 553
				UNLOCK(&task->lock);

Bob Halley's avatar
Bob Halley committed
554
				if (event->type == ISC_TASKEVENT_SHUTDOWN)
Bob Halley's avatar
Bob Halley committed
555
					is_shutdown = ISC_TRUE;
Bob Halley's avatar
update  
Bob Halley committed
556
				else
Bob Halley's avatar
Bob Halley committed
557
					is_shutdown = ISC_FALSE;
Bob Halley's avatar
update  
Bob Halley committed
558

Bob Halley's avatar
base  
Bob Halley committed
559 560 561
				/*
				 * Execute the event action.
				 */
Bob Halley's avatar
Bob Halley committed
562
				XTRACE("execute action");
Bob Halley's avatar
update  
Bob Halley committed
563 564 565
				if (event->action != NULL)
					wants_shutdown =
						(event->action)(task, event);
Bob Halley's avatar
base  
Bob Halley committed
566
				else
Bob Halley's avatar
Bob Halley committed
567
					wants_shutdown = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
568
				dispatch_count++;
Bob Halley's avatar
update  
Bob Halley committed
569
				
Bob Halley's avatar
Bob Halley committed
570
				isc_event_free(&event);
Bob Halley's avatar
base  
Bob Halley committed
571 572

				LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
573
				if (wants_shutdown || is_shutdown) {
Bob Halley's avatar
Bob Halley committed
574
					/*
Bob Halley's avatar
update  
Bob Halley committed
575 576 577 578
					 * The event action has either
					 * requested shutdown, or the event
					 * we just executed was the shutdown
					 * event.
Bob Halley's avatar
Bob Halley committed
579 580 581 582 583 584 585 586
					 *
					 * Since no more events can be
					 * delivered to the task, we purge
					 * any remaining events (but defer
					 * freeing them until we've released
					 * the lock).
					 */
					XTRACE("wants shutdown");
Bob Halley's avatar
base  
Bob Halley committed
587 588 589 590
					if (!EMPTY(task->events)) {
						remaining_events =
							task->events;
						INIT_LIST(task->events);
Bob Halley's avatar
Bob Halley committed
591
						discard_remaining = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
592 593
					}
					if (task->references == 0)
Bob Halley's avatar
Bob Halley committed
594
						free_task = ISC_TRUE;
Bob Halley's avatar
Bob Halley committed
595
					task->state = task_state_shutdown;
Bob Halley's avatar
Bob Halley committed
596 597
					task->enqueue_allowed = ISC_FALSE;
					done = ISC_TRUE;
Bob Halley's avatar
update  
Bob Halley committed
598
				} else if (EMPTY(task->events)) {
Bob Halley's avatar
Bob Halley committed
599 600 601
					/*
					 * Nothing else to do for this task.
					 * Put it to sleep.
Bob Halley's avatar
Bob Halley committed
602 603 604
					 *
					 * XXX detect tasks with 0 references
					 * and do something about them.
Bob Halley's avatar
Bob Halley committed
605
					 */
Bob Halley's avatar
Bob Halley committed
606
					XTRACE("empty");
Bob Halley's avatar
base  
Bob Halley committed
607
					task->state = task_state_idle;
Bob Halley's avatar
Bob Halley committed
608
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
609 610 611 612 613 614 615 616 617 618 619
				} else if (dispatch_count >= task->quantum) {
					/*
					 * Our quantum has expired, but
					 * there is more work to be done.
					 * We'll requeue it to the ready
					 * queue later.
					 *
					 * We don't check quantum until
					 * dispatching at least one event,
					 * so the minimum quantum is one.
					 */
Bob Halley's avatar
Bob Halley committed
620
					XTRACE("quantum");
Bob Halley's avatar
base  
Bob Halley committed
621
					task->state = task_state_ready;
Bob Halley's avatar
Bob Halley committed
622 623
					requeue = ISC_TRUE;
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
624 625 626 627 628
				}
			}
			UNLOCK(&task->lock);

			if (discard_remaining) {
Bob Halley's avatar
Bob Halley committed
629
				isc_event_t next_event;
Bob Halley's avatar
base  
Bob Halley committed
630 631 632 633 634

				for (event = HEAD(remaining_events);
				     event != NULL;
				     event = next_event) {
					next_event = NEXT(event, link);
Bob Halley's avatar
Bob Halley committed
635
					isc_event_free(&event);
Bob Halley's avatar
base  
Bob Halley committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
				}
			}

			if (free_task)
				task_free(task);

			LOCK(&manager->lock);
			if (requeue) {
				/*
				 * We know we're awake, so we don't have
				 * to wakeup any sleeping threads if the
				 * ready queue is empty before we requeue.
				 *
				 * A possible optimization if the queue is
				 * empty is to 'goto' the 'if (task != NULL)'
				 * block, avoiding the ENQUEUE of the task
				 * and the subsequent immediate DEQUEUE
				 * (since it is the only executable task).
				 * We don't do this because then we'd be
				 * skipping the exit_requested check.  The
				 * cost of ENQUEUE is low anyway, especially
				 * when you consider that we'd have to do
				 * an extra EMPTY check to see if we could
				 * do the optimization.  If the ready queue
				 * were usually nonempty, the 'optimization'
				 * might even hurt rather than help.
				 */
				ENQUEUE(manager->ready_tasks, task,
					ready_link);
			}
		}
	}
	INSIST(manager->workers > 0);
	manager->workers--;
	if (manager->workers == 0)
Bob Halley's avatar
Bob Halley committed
671
		no_workers = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
672 673 674 675 676
	UNLOCK(&manager->lock);

	if (no_workers)
		BROADCAST(&manager->no_workers);

Bob Halley's avatar
Bob Halley committed
677
	XTRACE("exit");
Bob Halley's avatar
base  
Bob Halley committed
678 679 680 681 682

	return (NULL);	
}

static void
Bob Halley's avatar
Bob Halley committed
683
manager_free(isc_taskmgr_t manager) {
Bob Halley's avatar
Bob Halley committed
684 685 686
	(void)isc_condition_destroy(&manager->work_available);
	(void)isc_condition_destroy(&manager->no_workers);
	(void)isc_mutex_destroy(&manager->lock);
Bob Halley's avatar
base  
Bob Halley committed
687
	manager->magic = 0;
Bob Halley's avatar
Bob Halley committed
688
	isc_mem_put(manager->mctx, manager, sizeof *manager);
Bob Halley's avatar
base  
Bob Halley committed
689 690
}

Bob Halley's avatar
Bob Halley committed
691
isc_result_t
Bob Halley's avatar
Bob Halley committed
692 693
isc_taskmgr_create(isc_memctx_t mctx, unsigned int workers, 
		   unsigned int default_quantum, isc_taskmgr_t *managerp)
Bob Halley's avatar
Bob Halley committed
694 695
{
	unsigned int i, started = 0;
Bob Halley's avatar
Bob Halley committed
696
	isc_taskmgr_t manager;
Bob Halley's avatar
Bob Halley committed
697 698 699
	isc_thread_t thread;

	REQUIRE(workers > 0);
Bob Halley's avatar
base  
Bob Halley committed
700

Bob Halley's avatar
Bob Halley committed
701
	manager = isc_mem_get(mctx, sizeof *manager);
Bob Halley's avatar
base  
Bob Halley committed
702
	if (manager == NULL)
Bob Halley's avatar
Bob Halley committed
703
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
704 705
	manager->magic = TASK_MANAGER_MAGIC;
	manager->mctx = mctx;
Bob Halley's avatar
Bob Halley committed
706
	if (isc_mutex_init(&manager->lock) != ISC_R_SUCCESS) {
Bob Halley's avatar
Bob Halley committed
707
		isc_mem_put(mctx, manager, sizeof *manager);
Bob Halley's avatar
Bob Halley committed
708 709 710
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_mutex_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
711
	}
Bob Halley's avatar
base  
Bob Halley committed
712 713 714 715 716
	if (default_quantum == 0)
		default_quantum = DEFAULT_DEFAULT_QUANTUM;
	manager->default_quantum = default_quantum;
	INIT_LIST(manager->tasks);
	INIT_LIST(manager->ready_tasks);
Bob Halley's avatar
Bob Halley committed
717 718
	if (isc_condition_init(&manager->work_available) != ISC_R_SUCCESS) {
		(void)isc_mutex_destroy(&manager->lock);
Bob Halley's avatar
Bob Halley committed
719
		isc_mem_put(mctx, manager, sizeof *manager);
Bob Halley's avatar
Bob Halley committed
720 721 722
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_condition_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
723
	}
Bob Halley's avatar
Bob Halley committed
724
	manager->exiting = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
725
	manager->workers = 0;
Bob Halley's avatar
Bob Halley committed
726 727 728
	if (isc_condition_init(&manager->no_workers) != ISC_R_SUCCESS) {
		(void)isc_condition_destroy(&manager->work_available);
		(void)isc_mutex_destroy(&manager->lock);
Bob Halley's avatar
Bob Halley committed
729
		isc_mem_put(mctx, manager, sizeof *manager);
Bob Halley's avatar
Bob Halley committed
730 731 732
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_condition_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
733
	}
Bob Halley's avatar
base  
Bob Halley committed
734 735 736 737 738 739

	LOCK(&manager->lock);
	/*
	 * Start workers.
	 */
	for (i = 0; i < workers; i++) {
Bob Halley's avatar
Bob Halley committed
740 741
		if (isc_thread_create(run, manager, &thread) ==
		    ISC_R_SUCCESS) {
Bob Halley's avatar
base  
Bob Halley committed
742 743
			manager->workers++;
			started++;
Bob Halley's avatar
Bob Halley committed
744
			(void)isc_thread_detach(thread);
Bob Halley's avatar
base  
Bob Halley committed
745 746 747 748 749 750
		}
	}
	UNLOCK(&manager->lock);

	if (started == 0) {
		manager_free(manager);
Bob Halley's avatar
Bob Halley committed
751
		return (ISC_R_NOTHREADS);
Bob Halley's avatar
base  
Bob Halley committed
752 753 754 755
	}		

	*managerp = manager;

Bob Halley's avatar
Bob Halley committed
756
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
757 758
}

Bob Halley's avatar
update  
Bob Halley committed
759
void
Bob Halley's avatar
Bob Halley committed
760 761 762
isc_taskmgr_destroy(isc_taskmgr_t *managerp) {
	isc_taskmgr_t manager;
	isc_task_t task;
Bob Halley's avatar
base  
Bob Halley committed
763 764 765 766 767

	REQUIRE(managerp != NULL);
	manager = *managerp;
	REQUIRE(VALID_MANAGER(manager));

Bob Halley's avatar
Bob Halley committed
768
	XTRACE("isc_taskmgr_destroy");
Bob Halley's avatar
base  
Bob Halley committed
769 770 771 772
	/*
	 * Only one non-worker thread may ever call this routine.
	 * If a worker thread wants to initiate shutdown of the
	 * task manager, it should ask some non-worker thread to call
Bob Halley's avatar
Bob Halley committed
773
	 * isc_taskmgr_destroy(), e.g. by signalling a condition variable
Bob Halley's avatar
base  
Bob Halley committed
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
	 * that the startup thread is sleeping on.
	 */

	/*
	 * Unlike elsewhere, we're going to hold this lock a long time.
	 * We need to do so, because otherwise the list of tasks could
	 * change while we were traversing it.
	 *
	 * This is also the only function where we will hold both the
	 * task manager lock and a task lock at the same time.
	 */

	LOCK(&manager->lock);

	/*
	 * Make sure we only get called once.
	 */
	INSIST(!manager->exiting);
Bob Halley's avatar
Bob Halley committed
792
	manager->exiting = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
793 794

	/*
Bob Halley's avatar
update  
Bob Halley committed
795 796
	 * Post the shutdown event to every task (if it hasn't already been
	 * posted).
Bob Halley's avatar
base  
Bob Halley committed
797 798 799 800 801
	 */
	for (task = HEAD(manager->tasks);
	     task != NULL;
	     task = NEXT(task, link)) {
		LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
802 803 804 805 806 807 808 809 810 811 812
		if (task->enqueue_allowed) {
			INSIST(task->shutdown_event != NULL);
			ENQUEUE(task->events, task->shutdown_event, link);
			task->shutdown_event = NULL;
			if (task->state == task_state_idle) {
				task->state = task_state_ready;
				ENQUEUE(manager->ready_tasks, task,
					ready_link);
			}
			INSIST(task->state == task_state_ready ||
			       task->state == task_state_running);
Bob Halley's avatar
Bob Halley committed
813
			task->enqueue_allowed = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
814 815 816 817 818 819 820 821 822 823 824 825 826
		}
		UNLOCK(&task->lock);
	}

	/*
	 * Wake up any sleeping workers.  This ensures we get work done if
	 * there's work left to do, and if there are already no tasks left
	 * it will cause the workers to see manager->exiting.
	 */
	BROADCAST(&manager->work_available);

	/*
	 * Wait for all the worker threads to exit.
Bob Halley's avatar
update  
Bob Halley committed
827 828 829 830 831 832
	 *
	 * XXX  This will become a timed wait.  If all the workers haven't
	 *      died after we've waited the specified interval, we will
	 *	kill the worker threads.  Should we join with the worker
	 *      threads after killing them or just leave them detached and
	 *      hope they go away?
Bob Halley's avatar
base  
Bob Halley committed
833 834 835 836 837 838 839 840 841 842
	 */
	while (manager->workers > 0)
		WAIT(&manager->no_workers, &manager->lock);

	UNLOCK(&manager->lock);

	manager_free(manager);

	*managerp = NULL;
}